class PhraseApp::RequestParams::TranslationOrderParams

TranslationOrderParams

Parameters:

branch

specify the branch to use

category

Category to use (required for orders processed by TextMaster).

include_untranslated_keys

Order translations for keys with untranslated content in the selected target locales.

include_unverified_translations

Order translations for keys with unverified content in the selected target locales.

lsp

Name of the LSP that should process this order. Can be one of gengo, textmaster.

message

Message that is displayed to the translators for description.

priority

Indicates whether the priority option should be ordered which decreases turnaround time by 30%. Available only for orders processed by TextMaster.

quality

Extra proofreading option to ensure consistency in vocabulary and style. Only available for orders processed by TextMaster.

source_locale_id

Source locale for the order. Can be the name or public id of the source locale. Preferred is the public id.

styleguide_id

Style guide for translators to be sent with the order.

tag

Tag you want to order translations for.

target_locale_ids

List of target locales you want the source content translate to. Can be the name or public id of the target locales. Preferred is the public id.

translation_type

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)

unverify_translations_upon_delivery

Unverify translations upon delivery.

Public Instance Methods

branch=(val) click to toggle source
Calls superclass method
# File lib/phraseapp-ruby.rb, line 1143
def branch=(val)
  super(val)
end
category=(val) click to toggle source
Calls superclass method
# File lib/phraseapp-ruby.rb, line 1147
def category=(val)
  super(val)
end
include_untranslated_keys=(val) click to toggle source
Calls superclass method
# File lib/phraseapp-ruby.rb, line 1151
def include_untranslated_keys=(val)
  if val.is_a?(TrueClass)
    super(true)
  elsif val.is_a?(FalseClass)
    return
  else
    PhraseApp::ParamsHelpers::ParamsValidationError.new("invalid value #{val}")
  end
end
include_unverified_translations=(val) click to toggle source
Calls superclass method
# File lib/phraseapp-ruby.rb, line 1161
def include_unverified_translations=(val)
  if val.is_a?(TrueClass)
    super(true)
  elsif val.is_a?(FalseClass)
    return
  else
    PhraseApp::ParamsHelpers::ParamsValidationError.new("invalid value #{val}")
  end
end
lsp=(val) click to toggle source
Calls superclass method
# File lib/phraseapp-ruby.rb, line 1171
def lsp=(val)
  super(val)
end
message=(val) click to toggle source
Calls superclass method
# File lib/phraseapp-ruby.rb, line 1175
def message=(val)
  super(val)
end
priority=(val) click to toggle source
Calls superclass method
# File lib/phraseapp-ruby.rb, line 1179
def priority=(val)
  if val.is_a?(TrueClass)
    super(true)
  elsif val.is_a?(FalseClass)
    return
  else
    PhraseApp::ParamsHelpers::ParamsValidationError.new("invalid value #{val}")
  end
end
quality=(val) click to toggle source
Calls superclass method
# File lib/phraseapp-ruby.rb, line 1189
def quality=(val)
  if val.is_a?(TrueClass)
    super(true)
  elsif val.is_a?(FalseClass)
    return
  else
    PhraseApp::ParamsHelpers::ParamsValidationError.new("invalid value #{val}")
  end
end
source_locale_id=(val) click to toggle source
Calls superclass method
# File lib/phraseapp-ruby.rb, line 1199
def source_locale_id=(val)
  super(val)
end
styleguide_id=(val) click to toggle source
Calls superclass method
# File lib/phraseapp-ruby.rb, line 1203
def styleguide_id=(val)
  super(val)
end
tag=(val) click to toggle source
Calls superclass method
# File lib/phraseapp-ruby.rb, line 1207
def tag=(val)
  super(val)
end
target_locale_ids=(val) click to toggle source
Calls superclass method
# File lib/phraseapp-ruby.rb, line 1211
def target_locale_ids=(val)
  super(val.split(','))
end
translation_type=(val) click to toggle source
Calls superclass method
# File lib/phraseapp-ruby.rb, line 1215
def translation_type=(val)
  super(val)
end
unverify_translations_upon_delivery=(val) click to toggle source
Calls superclass method
# File lib/phraseapp-ruby.rb, line 1219
def unverify_translations_upon_delivery=(val)
  if val.is_a?(TrueClass)
    super(true)
  elsif val.is_a?(FalseClass)
    return
  else
    PhraseApp::ParamsHelpers::ParamsValidationError.new("invalid value #{val}")
  end
end
validate() click to toggle source
# File lib/phraseapp-ruby.rb, line 1229
def validate
  
  if category == nil || category == "" 
    raise PhraseApp::ParamsHelpers::ParamsValidationError.new("Required parameter \"category\" of \"TranslationOrderParams\" not set")
  end
  if lsp == nil || lsp == "" 
    raise PhraseApp::ParamsHelpers::ParamsValidationError.new("Required parameter \"lsp\" of \"TranslationOrderParams\" not set")
  end
  if source_locale_id == nil
    raise PhraseApp::ParamsHelpers::ParamsValidationError.new("Required parameter \"source_locale_id\" of \"TranslationOrderParams\" not set")
  end
  if target_locale_ids == nil
    raise PhraseApp::ParamsHelpers::ParamsValidationError.new("Required parameter \"target_locale_ids\" of \"TranslationOrderParams\" not set")
  end
  if translation_type == nil || translation_type == "" 
    raise PhraseApp::ParamsHelpers::ParamsValidationError.new("Required parameter \"translation_type\" of \"TranslationOrderParams\" not set")
  end
end