class PhraseApp::RequestParams::UploadParams

UploadParams

Parameters:

autotranslate

If set, translations for the uploaded language will be fetched automatically.

branch

specify the branch to use

convert_emoji

Indicates whether the file contains Emoji symbols that should be converted. <a href=“Working”>help.phraseapp.com/manage-translations-and-languages/work-with-emojis/working-with-emojis“>Working with Emojis</a>.

file

File to be imported

file_encoding

Enforces a specific encoding on the file contents. Valid options are “UTF-8”, “UTF-16” and “ISO-8859-1”.

file_format

File format. Auto-detected when possible and not specified.

format_options

Additional options available for specific formats. See our format guide for complete list.

locale_id

Locale of the file's content. Can be the name or public id of the locale. Preferred is the public id.

locale_mapping

Optional, format specific mapping between locale names and the columns the translations to those locales are contained in.

mark_reviewed

Indicated whether the imported translations should be marked as reviewed. This setting is available if the review workflow (currently beta) is enabled for the project.

skip_unverification

Indicates whether the upload should unverify updated translations.

skip_upload_tags

Indicates whether the upload should not create upload tags.

tags

List of tags separated by comma to be associated with the new keys contained in the upload.

update_descriptions

Existing key descriptions will be updated with the file content. Empty descriptions overwrite existing descriptions.

update_translations

Indicates whether existing translations should be updated with the file content.

Public Instance Methods

autotranslate=(val) click to toggle source
Calls superclass method
# File lib/phraseapp-ruby.rb, line 1648
def autotranslate=(val)
  if val.is_a?(TrueClass)
    super(true)
  elsif val.is_a?(FalseClass)
    return
  else
    PhraseApp::ParamsHelpers::ParamsValidationError.new("invalid value #{val}")
  end
end
branch=(val) click to toggle source
Calls superclass method
# File lib/phraseapp-ruby.rb, line 1658
def branch=(val)
  super(val)
end
convert_emoji=(val) click to toggle source
Calls superclass method
# File lib/phraseapp-ruby.rb, line 1662
def convert_emoji=(val)
  if val.is_a?(TrueClass)
    super(true)
  elsif val.is_a?(FalseClass)
    return
  else
    PhraseApp::ParamsHelpers::ParamsValidationError.new("invalid value #{val}")
  end
end
file=(val) click to toggle source
Calls superclass method
# File lib/phraseapp-ruby.rb, line 1672
def file=(val)
  super(val)
end
file_encoding=(val) click to toggle source
Calls superclass method
# File lib/phraseapp-ruby.rb, line 1676
def file_encoding=(val)
  super(val)
end
file_format=(val) click to toggle source
Calls superclass method
# File lib/phraseapp-ruby.rb, line 1680
def file_format=(val)
  super(val)
end
format_options=(val) click to toggle source
Calls superclass method
# File lib/phraseapp-ruby.rb, line 1684
def format_options=(val)
  super(JSON.load(val))
end
locale_id=(val) click to toggle source
Calls superclass method
# File lib/phraseapp-ruby.rb, line 1688
def locale_id=(val)
  super(val)
end
locale_mapping=(val) click to toggle source
Calls superclass method
# File lib/phraseapp-ruby.rb, line 1692
def locale_mapping=(val)
  super(JSON.load(val))
end
mark_reviewed=(val) click to toggle source
Calls superclass method
# File lib/phraseapp-ruby.rb, line 1696
def mark_reviewed=(val)
  if val.is_a?(TrueClass)
    super(true)
  elsif val.is_a?(FalseClass)
    return
  else
    PhraseApp::ParamsHelpers::ParamsValidationError.new("invalid value #{val}")
  end
end
skip_unverification=(val) click to toggle source
Calls superclass method
# File lib/phraseapp-ruby.rb, line 1706
def skip_unverification=(val)
  if val.is_a?(TrueClass)
    super(true)
  elsif val.is_a?(FalseClass)
    return
  else
    PhraseApp::ParamsHelpers::ParamsValidationError.new("invalid value #{val}")
  end
end
skip_upload_tags=(val) click to toggle source
Calls superclass method
# File lib/phraseapp-ruby.rb, line 1716
def skip_upload_tags=(val)
  if val.is_a?(TrueClass)
    super(true)
  elsif val.is_a?(FalseClass)
    return
  else
    PhraseApp::ParamsHelpers::ParamsValidationError.new("invalid value #{val}")
  end
end
tags=(val) click to toggle source
Calls superclass method
# File lib/phraseapp-ruby.rb, line 1726
def tags=(val)
  super(val)
end
update_descriptions=(val) click to toggle source
Calls superclass method
# File lib/phraseapp-ruby.rb, line 1730
def update_descriptions=(val)
  if val.is_a?(TrueClass)
    super(true)
  elsif val.is_a?(FalseClass)
    return
  else
    PhraseApp::ParamsHelpers::ParamsValidationError.new("invalid value #{val}")
  end
end
update_translations=(val) click to toggle source
Calls superclass method
# File lib/phraseapp-ruby.rb, line 1740
def update_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
validate() click to toggle source
# File lib/phraseapp-ruby.rb, line 1750
def validate
  
  if file == nil
    raise PhraseApp::ParamsHelpers::ParamsValidationError.new("Required parameter \"file\" of \"UploadParams\" not set")
  end
end