Skip to content

Latest commit

 

History

History
61 lines (54 loc) · 5.77 KB

ProjectCreateParameters.md

File metadata and controls

61 lines (54 loc) · 5.77 KB
Raw

Phrase::ProjectCreateParameters

Properties

Name Type Description Notes
name String Name of the project
main_format String 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 <a href=&quot;https://support.phrase.com/hc/en-us/sections/6111343326364\&quot;&gt;Format Guide</a> or our <a href=&quot;#formats&quot;>Formats API Endpoint</a>. [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 Indicates whether the project should share the account's translation memory [optional]
project_image File Image to identify the project [optional]
remove_project_image Boolean Indicates whether the project image should be deleted. [optional]
account_id String Account ID to specify the actual account the project should be created in. Required if the requesting user is a member of multiple accounts. [optional]
point_of_contact String (Optional) User ID of the point of contact for the project. [optional]
source_project_id String When a source project ID is given, a clone of that project will be created, including all locales, keys and translations as well as the main project settings if they are not defined otherwise through the params. [optional]
workflow String (Optional) Review Workflow. &quot;simple&quot; / &quot;review&quot;. <a href=&quot;https://support.phrase.com/hc/en-us/articles/5784094755484\&quot;&gt;Read more</a> [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. <a href=&quot;https://support.phrase.com/hc/en-us/articles/5822319545116\&quot;&gt;Read more</a> [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. <a href=&quot;https://support.phrase.com/hc/en-us/articles/5822187934364\&quot;&gt;Read more</a> [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]

Code Sample

require 'Phrase'

instance = Phrase::ProjectCreateParameters.new(name: My Android Project,
                                 main_format: yml,
                                 media: Python,
                                 shares_translation_memory: true,
                                 project_image: [B@2bd89b8e,
                                 remove_project_image: null,
                                 account_id: abcd1234,
                                 point_of_contact: abcd1234,
                                 source_project_id: abcd1234,
                                 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)