Skip to content

OrderCreateParameters.md

Latest commit

 

History

History
45 lines (38 loc) · 3.19 KB

OrderCreateParameters.md

File metadata and controls

45 lines (38 loc) · 3.19 KB
Raw

Phrase::OrderCreateParameters

Properties

Name Type Description Notes
branch String specify the branch to use [optional]
name String the name of the order, default name is: Translation order from 'current datetime'
lsp String Name of the LSP that should process this order. Can be one of gengo, textmaster.
source_locale_id String Source locale for the order. Can be the name or id of the source locale. Preferred is id. [optional]
target_locale_ids Array<String> List of target locales you want the source content translate to. Can be the name or id of the target locales. Preferred is id. [optional]
translation_type String Name of the quality level, availability depends on the LSP. Can be one of: standard, pro (for orders processed by Gengo) and one of regular, premium, enterprise (for orders processed by TextMaster) [optional]
tag String Tag you want to order translations for. [optional]
message String Message that is displayed to the translators for description. [optional]
styleguide_id String Style guide for translators to be sent with the order. [optional]
unverify_translations_upon_delivery Boolean Unverify translations upon delivery. [optional]
include_untranslated_keys Boolean Order translations for keys with untranslated content in the selected target locales. [optional]
include_unverified_translations Boolean Order translations for keys with unverified content in the selected target locales. [optional]
category String Category to use (required for orders processed by TextMaster). [optional]
quality Boolean Extra proofreading option to ensure consistency in vocabulary and style. Only available for orders processed by TextMaster. [optional]
priority Boolean Indicates whether the priority option should be ordered which decreases turnaround time by 30%. Available only for orders processed by TextMaster. [optional]

Code Sample

require 'phrase'

instance = Phrase::OrderCreateParameters.new(branch: 'my-feature-branch',
                                 name: 'Welcome message translations',
                                 lsp: 'textmaster',
                                 source_locale_id: 'abcd1234abcd1234abcd1234abcd1234',
                                 target_locale_ids: ["1234abcd1234abcd1234abcd1234abcd","abcd1234abcd1234abcd1234abcd1234"],
                                 translation_type: 'premium',
                                 tag: 'my-awesome-feature',
                                 message: 'Please make everything sound really nice :)',
                                 styleguide_id: '1234abcd1234abcd1234abcd1234abcd',
                                 unverify_translations_upon_delivery: nil,
                                 include_untranslated_keys: nil,
                                 include_unverified_translations: nil,
                                 category: 'C021',
                                 quality: nil,
                                 priority: nil)