Class: PhraseApp::RequestParams::TranslationOrderParams

Inherits:
OpenStruct
  • Object
show all
Defined in:
lib/phraseapp-ruby.rb

Overview

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.

Instance Method Summary collapse

Instance Method Details

#branch=(val) ⇒ Object 



1143
1144
1145
 
# File 'lib/phraseapp-ruby.rb', line 1143

def branch=(val)
  super(val)
end

#category=(val) ⇒ Object 



1147
1148
1149
 
# File 'lib/phraseapp-ruby.rb', line 1147

def category=(val)
  super(val)
end

#include_untranslated_keys=(val) ⇒ Object 



1151
1152
1153
1154
1155
1156
1157
1158
1159
 
# 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) ⇒ Object 



1161
1162
1163
1164
1165
1166
1167
1168
1169
 
# 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) ⇒ Object 



1171
1172
1173
 
# File 'lib/phraseapp-ruby.rb', line 1171

def lsp=(val)
  super(val)
end

#message=(val) ⇒ Object 



1175
1176
1177
 
# File 'lib/phraseapp-ruby.rb', line 1175

def message=(val)
  super(val)
end

#priority=(val) ⇒ Object 



1179
1180
1181
1182
1183
1184
1185
1186
1187
 
# 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) ⇒ Object 



1189
1190
1191
1192
1193
1194
1195
1196
1197
 
# 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) ⇒ Object 



1199
1200
1201
 
# File 'lib/phraseapp-ruby.rb', line 1199

def source_locale_id=(val)
  super(val)
end

#styleguide_id=(val) ⇒ Object 



1203
1204
1205
 
# File 'lib/phraseapp-ruby.rb', line 1203

def styleguide_id=(val)
  super(val)
end

#tag=(val) ⇒ Object 



1207
1208
1209
 
# File 'lib/phraseapp-ruby.rb', line 1207

def tag=(val)
  super(val)
end

#target_locale_ids=(val) ⇒ Object 



1211
1212
1213
 
# File 'lib/phraseapp-ruby.rb', line 1211

def target_locale_ids=(val)
  super(val.split(','))
end

#translation_type=(val) ⇒ Object 



1215
1216
1217
 
# File 'lib/phraseapp-ruby.rb', line 1215

def translation_type=(val)
  super(val)
end

#unverify_translations_upon_delivery=(val) ⇒ Object 



1219
1220
1221
1222
1223
1224
1225
1226
1227
 
# 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 ⇒ Object 



1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
 
# 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