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 



669
670
671
 
# File 'lib/phraseapp-ruby.rb', line 669

def category=(val)
  super(val)
end

#include_untranslated_keys=(val) ⇒ Object 



673
674
675
676
677
678
679
680
681
 
# File 'lib/phraseapp-ruby.rb', line 673

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 



683
684
685
686
687
688
689
690
691
 
# File 'lib/phraseapp-ruby.rb', line 683

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 



693
694
695
 
# File 'lib/phraseapp-ruby.rb', line 693

def lsp=(val)
  super(val)
end

#message=(val) ⇒ Object 



697
698
699
 
# File 'lib/phraseapp-ruby.rb', line 697

def message=(val)
  super(val)
end

#priority=(val) ⇒ Object 



701
702
703
704
705
706
707
708
709
 
# File 'lib/phraseapp-ruby.rb', line 701

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 



711
712
713
714
715
716
717
718
719
 
# File 'lib/phraseapp-ruby.rb', line 711

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 



721
722
723
 
# File 'lib/phraseapp-ruby.rb', line 721

def source_locale_id=(val)
  super(val)
end

#styleguide_id=(val) ⇒ Object 



725
726
727
 
# File 'lib/phraseapp-ruby.rb', line 725

def styleguide_id=(val)
  super(val)
end

#tag=(val) ⇒ Object 



729
730
731
 
# File 'lib/phraseapp-ruby.rb', line 729

def tag=(val)
  super(val)
end

#target_locale_ids=(val) ⇒ Object 



733
734
735
 
# File 'lib/phraseapp-ruby.rb', line 733

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

#translation_type=(val) ⇒ Object 



737
738
739
 
# File 'lib/phraseapp-ruby.rb', line 737

def translation_type=(val)
  super(val)
end

#unverify_translations_upon_delivery=(val) ⇒ Object 



741
742
743
744
745
746
747
748
749
 
# File 'lib/phraseapp-ruby.rb', line 741

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 



751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
 
# File 'lib/phraseapp-ruby.rb', line 751

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