Class: PhraseApp::RequestParams::TranslationOrderParams

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

Overview

TranslationOrderParams

Parameters:

category

Category to use (required for orders processed by TextMaster). <a href=“#categories”>Category List</a>

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

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

#category=(val) ⇒ Object 



592
593
594
 
# File 'lib/phraseapp-ruby.rb', line 592

def category=(val)
  self.category = val
end

#include_untranslated_keys=(val) ⇒ Object 



596
597
598
599
600
601
602
603
604
 
# File 'lib/phraseapp-ruby.rb', line 596

def include_untranslated_keys=(val)
  if val == "true"
    self.include_untranslated_keys = true
  elsif val == "false" #ignore
    self.include_untranslated_keys = b
  else
    PhraseApp::ParamsHelpers::ParamsValidationError.new("invalid value #{val}")
  end
end

#include_unverified_translations=(val) ⇒ Object 



606
607
608
609
610
611
612
613
614
 
# File 'lib/phraseapp-ruby.rb', line 606

def include_unverified_translations=(val)
  if val == "true"
    self.include_unverified_translations = true
  elsif val == "false" #ignore
    self.include_unverified_translations = b
  else
    PhraseApp::ParamsHelpers::ParamsValidationError.new("invalid value #{val}")
  end
end

#lsp=(val) ⇒ Object 



616
617
618
 
# File 'lib/phraseapp-ruby.rb', line 616

def lsp=(val)
  self.lsp = val
end

#message=(val) ⇒ Object 



620
621
622
 
# File 'lib/phraseapp-ruby.rb', line 620

def message=(val)
  self.message = val
end

#priority=(val) ⇒ Object 



624
625
626
627
628
629
630
631
632
 
# File 'lib/phraseapp-ruby.rb', line 624

def priority=(val)
  if val == "true"
    self.priority = true
  elsif val == "false" #ignore
    self.priority = b
  else
    PhraseApp::ParamsHelpers::ParamsValidationError.new("invalid value #{val}")
  end
end

#quality=(val) ⇒ Object 



634
635
636
637
638
639
640
641
642
 
# File 'lib/phraseapp-ruby.rb', line 634

def quality=(val)
  if val == "true"
    self.quality = true
  elsif val == "false" #ignore
    self.quality = b
  else
    PhraseApp::ParamsHelpers::ParamsValidationError.new("invalid value #{val}")
  end
end

#source_locale_id=(val) ⇒ Object 



644
645
646
 
# File 'lib/phraseapp-ruby.rb', line 644

def source_locale_id=(val)
  self.source_locale_id = val
end

#styleguide_id=(val) ⇒ Object 



648
649
650
 
# File 'lib/phraseapp-ruby.rb', line 648

def styleguide_id=(val)
  self.styleguide_id = val
end

#tag=(val) ⇒ Object 



652
653
654
 
# File 'lib/phraseapp-ruby.rb', line 652

def tag=(val)
  self.tag = val
end

#target_locale_ids=(val) ⇒ Object 



656
657
658
 
# File 'lib/phraseapp-ruby.rb', line 656

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

#translation_type=(val) ⇒ Object 



660
661
662
 
# File 'lib/phraseapp-ruby.rb', line 660

def translation_type=(val)
  self.translation_type = val
end

#unverify_translations_upon_delivery=(val) ⇒ Object 



664
665
666
667
668
669
670
671
672
 
# File 'lib/phraseapp-ruby.rb', line 664

def unverify_translations_upon_delivery=(val)
  if val == "true"
    self.unverify_translations_upon_delivery = true
  elsif val == "false" #ignore
    self.unverify_translations_upon_delivery = b
  else
    PhraseApp::ParamsHelpers::ParamsValidationError.new("invalid value #{val}")
  end
end

#validate ⇒ Object 



674
675
676
677
678
679
680
681
682
683
684
685
686
 
# File 'lib/phraseapp-ruby.rb', line 674

def validate
  if self.category == nil || self.category == "" 
    raise PhraseApp::ParamsHelpers::ParamsValidationError.new("Required parameter \"category\" of \"TranslationOrderParams\" not set")
  endif self.lsp == nil || self.lsp == "" 
    raise PhraseApp::ParamsHelpers::ParamsValidationError.new("Required parameter \"lsp\" of \"TranslationOrderParams\" not set")
  endif self.source_locale_id == nil
    raise PhraseApp::ParamsHelpers::ParamsValidationError.new("Required parameter \"source_locale_id\" of \"TranslationOrderParams\" not set")
  endif self.target_locale_ids == nil
    raise PhraseApp::ParamsHelpers::ParamsValidationError.new("Required parameter \"target_locale_ids\" of \"TranslationOrderParams\" not set")
  endif self.translation_type == nil || self.translation_type == "" 
    raise PhraseApp::ParamsHelpers::ParamsValidationError.new("Required parameter \"translation_type\" of \"TranslationOrderParams\" not set")
  end
end