Class: PhraseApp::RequestParams::StyleguideParams

Inherits:

OpenStruct

• Object
• OpenStruct
• PhraseApp::RequestParams::StyleguideParams

Defined in:

lib/phraseapp-ruby.rb

Overview

StyleguideParams

Parameters:

audience

Audience description

business

Description of the business

company_branding

Company branding to remain consistent.

formatting

Formatting requirements and character limitations.

glossary_terms

List of terms and/or phrases that need to be translated consistently.

grammar_consistency

Formal or informal pronouns, consistent conjugation, grammatical gender

grammatical_person

Can be one of: not_specified, first_person_singular, second_person_singular, third_person_singular_masculine, third_person_singular_feminine, third_person_singular_neuter, first_person_plural, second_person_plural, third_person_plural.

literal_translation

Can be one of: Cultural/Conversational, Literal, Neutral.

overall_tone

Tone requirement descriptions

samples

Provide links to sample product pages, FAQ pages, etc. to give the translator a point of reference. You can also provide past translations. Even snippets or short paragraphs are helpful for maintaining consistency.

target_audience

Can be one of: not_specified, children, teenager, young_adults, adults, old_adults.

title

Style guide title

vocabulary_type

Can be one of: not_specified, popular, technical, fictional.

Instance Method Summary

• #audience=(val) ⇒ Object
• #business=(val) ⇒ Object
• #company_branding=(val) ⇒ Object
• #formatting=(val) ⇒ Object
• #glossary_terms=(val) ⇒ Object
• #grammar_consistency=(val) ⇒ Object
• #grammatical_person=(val) ⇒ Object
• #literal_translation=(val) ⇒ Object
• #overall_tone=(val) ⇒ Object
• #samples=(val) ⇒ Object
• #target_audience=(val) ⇒ Object
• #title=(val) ⇒ Object
• #validate ⇒ Object
• #vocabulary_type=(val) ⇒ Object

Instance Method Details

#audience=(val) ⇒ Object

# File 'lib/phraseapp-ruby.rb', line 983

def audience=(val)
  super(val)
end

#business=(val) ⇒ Object

# File 'lib/phraseapp-ruby.rb', line 987

def business=(val)
  super(val)
end

#company_branding=(val) ⇒ Object

# File 'lib/phraseapp-ruby.rb', line 991

def company_branding=(val)
  super(val)
end

#formatting=(val) ⇒ Object

# File 'lib/phraseapp-ruby.rb', line 995

def formatting=(val)
  super(val)
end

#glossary_terms=(val) ⇒ Object

# File 'lib/phraseapp-ruby.rb', line 999

def glossary_terms=(val)
  super(val)
end

#grammar_consistency=(val) ⇒ Object

# File 'lib/phraseapp-ruby.rb', line 1003

def grammar_consistency=(val)
  super(val)
end

#grammatical_person=(val) ⇒ Object

# File 'lib/phraseapp-ruby.rb', line 1007

def grammatical_person=(val)
  super(val)
end

#literal_translation=(val) ⇒ Object

# File 'lib/phraseapp-ruby.rb', line 1011

def literal_translation=(val)
  super(val)
end

#overall_tone=(val) ⇒ Object

# File 'lib/phraseapp-ruby.rb', line 1015

def overall_tone=(val)
  super(val)
end

#samples=(val) ⇒ Object

# File 'lib/phraseapp-ruby.rb', line 1019

def samples=(val)
  super(val)
end

#target_audience=(val) ⇒ Object

# File 'lib/phraseapp-ruby.rb', line 1023

def target_audience=(val)
  super(val)
end

#title=(val) ⇒ Object

# File 'lib/phraseapp-ruby.rb', line 1027

def title=(val)
  super(val)
end

#validate ⇒ Object

# File 'lib/phraseapp-ruby.rb', line 1035

def validate
  
  if title == nil || title == "" 
    raise PhraseApp::ParamsHelpers::ParamsValidationError.new("Required parameter \"title\" of \"StyleguideParams\" not set")
  end
end

#vocabulary_type=(val) ⇒ Object

# File 'lib/phraseapp-ruby.rb', line 1031

def vocabulary_type=(val)
  super(val)
end