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

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

#category=(val) ⇒ Object 



622
623
624
 
# File 'lib/phraseapp-ruby.rb', line 622

def category=(val)
  super(val)
end

#include_untranslated_keys=(val) ⇒ Object 



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

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 



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

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 



646
647
648
 
# File 'lib/phraseapp-ruby.rb', line 646

def lsp=(val)
  super(val)
end

#message=(val) ⇒ Object 



650
651
652
 
# File 'lib/phraseapp-ruby.rb', line 650

def message=(val)
  super(val)
end

#priority=(val) ⇒ Object 



654
655
656
657
658
659
660
661
662
 
# File 'lib/phraseapp-ruby.rb', line 654

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 



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

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 



674
675
676
 
# File 'lib/phraseapp-ruby.rb', line 674

def source_locale_id=(val)
  super(val)
end

#styleguide_id=(val) ⇒ Object 



678
679
680
 
# File 'lib/phraseapp-ruby.rb', line 678

def styleguide_id=(val)
  super(val)
end

#tag=(val) ⇒ Object 



682
683
684
 
# File 'lib/phraseapp-ruby.rb', line 682

def tag=(val)
  super(val)
end

#target_locale_ids=(val) ⇒ Object 



686
687
688
 
# File 'lib/phraseapp-ruby.rb', line 686

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

#translation_type=(val) ⇒ Object 



690
691
692
 
# File 'lib/phraseapp-ruby.rb', line 690

def translation_type=(val)
  super(val)
end

#unverify_translations_upon_delivery=(val) ⇒ Object 



694
695
696
697
698
699
700
701
702
 
# File 'lib/phraseapp-ruby.rb', line 694

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 



704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
 
# File 'lib/phraseapp-ruby.rb', line 704

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