Skip to content

ProjectUpdateParameters.md

Latest commit

 

History

History
79 lines (72 loc) · 7.6 KB

ProjectUpdateParameters.md

File metadata and controls

79 lines (72 loc) · 7.6 KB

Phrase::ProjectUpdateParameters

Properties

Name Type Description Notes
account_id String (Optional) ID of an account the requesting user belongs to. Used only to disambiguate the request context; the project itself cannot be moved between accounts through this endpoint. [optional]
name String (Optional) Name of the project [optional]
point_of_contact String (Optional) User ID of the point of contact for the project. Pass `null` to unset. [optional]
main_format String (Optional) Main file format specified by its API Extension name. Used for locale downloads if no format is specified. For API Extension names of available file formats see Format Guide or our Formats API Endpoint. [optional]
media String (Optional) Main technology stack used in the project. It affects for example the suggested placeholder style. Predefined values include: `Ruby`, `JavaScript`, `AngularJS`, `React`, `iOS`, `Android`, `Python`, `PHP`, `Java`, `Go`, `Windows Phone`, `Rails`, `Node.js`, `.NET`, `Django`, `Symfony`, `Yii Framework`, `Zend Framework`, `Apple App Store Description`, `Google Play Description`, but it can also take any other value. [optional]
shares_translation_memory Boolean (Optional) Indicates whether the project should share the account's translation memory [optional]
project_image File (Optional) Image to identify the project [optional]
remove_project_image Boolean (Optional) Indicates whether the project image should be deleted. [optional]
workflow String (Optional) Review Workflow. "simple" / "review". Read more [optional]
machine_translation_enabled Boolean (Optional) Enable machine translation support in the project. Required for Pre-Translation [optional]
enable_branching Boolean (Optional) Enable branching in the project [optional]
protect_master_branch Boolean (Optional) Protect the master branch in project where branching is enabled [optional]
enable_all_data_type_translation_keys_for_translators Boolean (Optional) Otherwise, translators are not allowed to edit translations other than strings [optional]
enable_icu_message_format Boolean (Optional) We can validate and highlight your ICU messages. Read more [optional]
zero_plural_form_enabled Boolean (Optional) Displays the input fields for the 'ZERO' plural form for every key as well although only some languages require the 'ZERO' explicitly. [optional]
autotranslate_enabled Boolean (Optional) Autopilot, requires machine_translation_enabled. Read more [optional]
autotranslate_check_new_translation_keys Boolean (Optional) Requires autotranslate_enabled to be true [optional]
autotranslate_check_new_uploads Boolean (Optional) Requires autotranslate_enabled to be true [optional]
autotranslate_check_new_locales Boolean (Optional) Requires autotranslate_enabled to be true [optional]
autotranslate_mark_as_unverified Boolean (Optional) Requires autotranslate_enabled to be true [optional]
autotranslate_use_machine_translation Boolean (Optional) Requires autotranslate_enabled to be true [optional]
autotranslate_use_translation_memory Boolean (Optional) Requires autotranslate_enabled to be true [optional]
autotranslate_overwrite_unverified_translations Boolean (Optional) Requires autotranslate_enabled to be true [optional]
default_encoding String (Optional) Sets the default encoding for Uploads. If you leave it empty, we will try to guess it automatically for you when you Upload a file. You can still override this value by setting the `file_encoding` parameter for Uploads. [optional]
placeholder_styles Array<String> (Optional) List of placeholder styles enabled for the project. [optional]
autocomplete_job_enabled Boolean (Optional) Enable autocomplete-job behavior so that newly created keys and locales are automatically added to in-progress jobs. [optional]
job_locking_enabled Boolean (Optional) When enabled, translations are locked once a job moves into review. [optional]
smart_suggest_enabled Boolean (Optional) Enable Smart Suggest for the project. [optional]
smart_suggest_use_glossary Boolean (Optional) Allow Smart Suggest to source suggestions from the project glossary. [optional]
smart_suggest_use_machine_translation Boolean (Optional) Allow Smart Suggest to source suggestions from machine translation. [optional]
translation_keys_sort_collation String (Optional) Collation used when sorting translation keys alphabetically. [optional]
cldr_version String (Optional) CLDR plural-rule version used by the project. [optional]

Code Sample

require 'Phrase'

instance = Phrase::ProjectUpdateParameters.new(account_id: abcd1234,
                                 name: My Android Project,
                                 point_of_contact: abcd1234,
                                 main_format: yml,
                                 media: Python,
                                 shares_translation_memory: true,
                                 project_image: [B@26e66e13,
                                 remove_project_image: false,
                                 workflow: review,
                                 machine_translation_enabled: true,
                                 enable_branching: true,
                                 protect_master_branch: true,
                                 enable_all_data_type_translation_keys_for_translators: true,
                                 enable_icu_message_format: true,
                                 zero_plural_form_enabled: true,
                                 autotranslate_enabled: true,
                                 autotranslate_check_new_translation_keys: true,
                                 autotranslate_check_new_uploads: true,
                                 autotranslate_check_new_locales: true,
                                 autotranslate_mark_as_unverified: true,
                                 autotranslate_use_machine_translation: true,
                                 autotranslate_use_translation_memory: true,
                                 autotranslate_overwrite_unverified_translations: true,
                                 default_encoding: UTF-8,
                                 placeholder_styles: [&quot;angular&quot;,&quot;iOS&quot;],
                                 autocomplete_job_enabled: false,
                                 job_locking_enabled: false,
                                 smart_suggest_enabled: true,
                                 smart_suggest_use_glossary: true,
                                 smart_suggest_use_machine_translation: true,
                                 translation_keys_sort_collation: unicode_ci,
                                 cldr_version: legacy)