phrase 4.28.0 → 4.30.0

data/docs/JobPreview.md

@@ -11,11 +11,11 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Phrase'
+require 'phrase'
 
-instance = Phrase::JobPreview.new(id: null,
-                                 name: null,
-                                 state: null)
+instance = Phrase::JobPreview.new(id: nil,
+                                 name: nil,
+                                 state: nil)
 ```
 
 

data/docs/JobReopenParameters.md

@@ -9,9 +9,9 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Phrase'
+require 'phrase'
 
-instance = Phrase::JobReopenParameters.new(branch: my-feature-branch)
+instance = Phrase::JobReopenParameters.new(branch: 'my-feature-branch')
 ```
 
 

data/docs/JobStartParameters.md

@@ -9,9 +9,9 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Phrase'
+require 'phrase'
 
-instance = Phrase::JobStartParameters.new(branch: my-feature-branch)
+instance = Phrase::JobStartParameters.new(branch: 'my-feature-branch')
 ```
 
 

data/docs/JobTemplate.md

@@ -16,16 +16,16 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Phrase'
+require 'phrase'
 
-instance = Phrase::JobTemplate.new(id: null,
-                                 name: null,
-                                 briefing: null,
-                                 project: null,
-                                 branch: null,
-                                 autotranslate_enabled: null,
-                                 created_at: null,
-                                 updated_at: null)
+instance = Phrase::JobTemplate.new(id: nil,
+                                 name: nil,
+                                 briefing: nil,
+                                 project: nil,
+                                 branch: nil,
+                                 autotranslate_enabled: nil,
+                                 created_at: nil,
+                                 updated_at: nil)
 ```
 
 

data/docs/JobTemplateCreateParameters.md

@@ -9,17 +9,19 @@ Name | Type | Description | Notes
 **briefing** | **String** | Briefing for the translators | [optional] 
 **autotranslate** | **Boolean** | Automatically translate the job using machine translation. | [optional] 
 **source_locale_id** | **String** | The API id of the source language. This locale will be set as source locale for the job template. If not provided, the project default locale will be used. | [optional] 
+**owner_id** | **String** | Code of the account member to set as the job template owner. The referenced user must also be a member of the project; passing the code of an account member who is not a project member returns a 404. When omitted or blank, no owner is pre-set; the user who creates a job from this template is assigned as owner at job-creation time.  | [optional] 
 
 ## Code Sample
 
 ```ruby
-require 'Phrase'
+require 'phrase'
 
-instance = Phrase::JobTemplateCreateParameters.new(branch: my-feature-branch,
-                                 name: template,
-                                 briefing: text,
+instance = Phrase::JobTemplateCreateParameters.new(branch: 'my-feature-branch',
+                                 name: 'template',
+                                 briefing: 'text',
                                  autotranslate: true,
-                                 source_locale_id: abcd1234cdef1234abcd1234cdef1234)
+                                 source_locale_id: 'abcd1234cdef1234abcd1234cdef1234',
+                                 owner_id: nil)
 ```
 
 

data/docs/JobTemplateDetails.md

@@ -19,19 +19,19 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Phrase'
+require 'phrase'
 
-instance = Phrase::JobTemplateDetails.new(id: null,
-                                 name: null,
-                                 briefing: null,
-                                 project: null,
-                                 branch: null,
-                                 autotranslate_enabled: null,
-                                 created_at: null,
-                                 updated_at: null,
-                                 owner: null,
-                                 creator: null,
-                                 locales: null)
+instance = Phrase::JobTemplateDetails.new(id: nil,
+                                 name: nil,
+                                 briefing: nil,
+                                 project: nil,
+                                 branch: nil,
+                                 autotranslate_enabled: nil,
+                                 created_at: nil,
+                                 updated_at: nil,
+                                 owner: nil,
+                                 creator: nil,
+                                 locales: nil)
 ```
 
 

data/docs/JobTemplateLocaleUpdateParameters.md

@@ -14,14 +14,14 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Phrase'
+require 'phrase'
 
-instance = Phrase::JobTemplateLocaleUpdateParameters.new(branch: my-feature-branch,
-                                 locale_id: abcd1234cdef1234abcd1234cdef1234,
-                                 user_ids: ["abcd1234cdef1234abcd1234cdef1234"],
-                                 reviewer_ids: ["abcd1234cdef1234abcd1234cdef1234"],
-                                 translator_team_ids: ["abcd1234cdef1234abcd1234cdef1234"],
-                                 reviewer_team_ids: ["abcd1234cdef1234abcd1234cdef1234"])
+instance = Phrase::JobTemplateLocaleUpdateParameters.new(branch: 'my-feature-branch',
+                                 locale_id: 'abcd1234cdef1234abcd1234cdef1234',
+                                 user_ids: ["abcd1234cdef1234abcd1234cdef1234"],
+                                 reviewer_ids: ["abcd1234cdef1234abcd1234cdef1234"],
+                                 translator_team_ids: ["abcd1234cdef1234abcd1234cdef1234"],
+                                 reviewer_team_ids: ["abcd1234cdef1234abcd1234cdef1234"])
 ```
 
 

data/docs/JobTemplateLocales.md

@@ -13,13 +13,13 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Phrase'
+require 'phrase'
 
-instance = Phrase::JobTemplateLocales.new(id: null,
-                                 job_template: null,
-                                 locale: null,
-                                 users: null,
-                                 teams: null)
+instance = Phrase::JobTemplateLocales.new(id: nil,
+                                 job_template: nil,
+                                 locale: nil,
+                                 users: nil,
+                                 teams: nil)
 ```
 
 

data/docs/JobTemplateLocalesCreateParameters.md

@@ -14,14 +14,14 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Phrase'
+require 'phrase'
 
-instance = Phrase::JobTemplateLocalesCreateParameters.new(branch: my-feature-branch,
-                                 locale_id: abcd1234cdef1234abcd1234cdef1234,
-                                 user_ids: ["abcd1234cdef1234abcd1234cdef1234"],
-                                 reviewer_ids: ["abcd1234cdef1234abcd1234cdef1234"],
-                                 translator_team_ids: ["abcd1234cdef1234abcd1234cdef1234"],
-                                 reviewer_team_ids: ["abcd1234cdef1234abcd1234cdef1234"])
+instance = Phrase::JobTemplateLocalesCreateParameters.new(branch: 'my-feature-branch',
+                                 locale_id: 'abcd1234cdef1234abcd1234cdef1234',
+                                 user_ids: ["abcd1234cdef1234abcd1234cdef1234"],
+                                 reviewer_ids: ["abcd1234cdef1234abcd1234cdef1234"],
+                                 translator_team_ids: ["abcd1234cdef1234abcd1234cdef1234"],
+                                 reviewer_team_ids: ["abcd1234cdef1234abcd1234cdef1234"])
 ```
 
 

data/docs/JobTemplatePreview.md

@@ -10,10 +10,10 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Phrase'
+require 'phrase'
 
-instance = Phrase::JobTemplatePreview.new(id: null,
-                                 name: null)
+instance = Phrase::JobTemplatePreview.new(id: nil,
+                                 name: nil)
 ```
 
 

data/docs/JobTemplateUpdateParameters.md

@@ -9,17 +9,19 @@ Name | Type | Description | Notes
 **briefing** | **String** | Briefing for the translators | [optional] 
 **autotranslate** | **Boolean** | Automatically translate the job using machine translation. | [optional] 
 **source_locale_id** | **String** | The API id of the source language. This locale will be set as source locale for the job template. If not provided, the project default locale will be used. | [optional] 
+**owner_id** | **String** | Code of the account member to set as the job template owner. The referenced user must also be a member of the project; passing the code of an account member who is not a project member returns a 404. Pass an empty string to clear a previously set owner; when blank, jobs created from this template will default to assigning the job creator as owner.  | [optional] 
 
 ## Code Sample
 
 ```ruby
-require 'Phrase'
+require 'phrase'
 
-instance = Phrase::JobTemplateUpdateParameters.new(branch: my-feature-branch,
-                                 name: template,
-                                 briefing: text,
+instance = Phrase::JobTemplateUpdateParameters.new(branch: 'my-feature-branch',
+                                 name: 'template',
+                                 briefing: 'text',
                                  autotranslate: true,
-                                 source_locale_id: abcd1234cdef1234abcd1234cdef1234)
+                                 source_locale_id: 'abcd1234cdef1234abcd1234cdef1234',
+                                 owner_id: nil)
 ```
 
 

data/docs/JobUpdateParameters.md

@@ -15,14 +15,14 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Phrase'
+require 'phrase'
 
-instance = Phrase::JobUpdateParameters.new(branch: my-feature-branch,
-                                 name: de,
-                                 briefing: de-DE,
-                                 due_date: null,
-                                 ticket_url: https://example.atlassian.net/browse/FOO,
-                                 target_locale_ids: ["abcd1234cdef1234abcd1234cdef1234"],
+instance = Phrase::JobUpdateParameters.new(branch: 'my-feature-branch',
+                                 name: 'de',
+                                 briefing: 'de-DE',
+                                 due_date: nil,
+                                 ticket_url: 'https://example.atlassian.net/browse/FOO',
+                                 target_locale_ids: ["abcd1234cdef1234abcd1234cdef1234"],
                                  autotranslate: true)
 ```
 

data/docs/KeyCreateParameters.md

@@ -29,29 +29,29 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Phrase'
+require 'phrase'
 
-instance = Phrase::KeyCreateParameters.new(branch: my-feature-branch,
-                                 name: home.index.headline,
-                                 description: Some description worth knowing...,
-                                 plural: null,
-                                 use_ordinal_rules: null,
-                                 name_plural: home.index.headlines,
-                                 data_type: number,
-                                 tags: awesome-feature,needs-proofreading,
+instance = Phrase::KeyCreateParameters.new(branch: 'my-feature-branch',
+                                 name: 'home.index.headline',
+                                 description: 'Some description worth knowing...',
+                                 plural: nil,
+                                 use_ordinal_rules: nil,
+                                 name_plural: 'home.index.headlines',
+                                 data_type: 'number',
+                                 tags: 'awesome-feature,needs-proofreading',
                                  max_characters_allowed: 140,
-                                 screenshot: [B@4393cb22,
-                                 remove_screenshot: null,
-                                 unformatted: null,
-                                 default_translation_content: Default translation content,
-                                 autotranslate: null,
-                                 xml_space_preserve: null,
-                                 original_file: null,
-                                 localized_format_string: null,
-                                 localized_format_key: null,
-                                 custom_metadata: {"fruit":"Apple","vegetable":"Tomato"},
-                                 excluded_in_locales: ["de","fr"],
-                                 format_value_type: string)
+                                 screenshot: File.new('/path/to/file'),
+                                 remove_screenshot: nil,
+                                 unformatted: nil,
+                                 default_translation_content: 'Default translation content',
+                                 autotranslate: nil,
+                                 xml_space_preserve: nil,
+                                 original_file: nil,
+                                 localized_format_string: nil,
+                                 localized_format_key: nil,
+                                 custom_metadata: {"fruit":"Apple","vegetable":"Tomato"},
+                                 excluded_in_locales: ["de","fr"],
+                                 format_value_type: 'string')
 ```
 
 

data/docs/KeyFormatAnnotationsList200ResponseInner.md

@@ -10,10 +10,10 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Phrase'
+require 'phrase'
 
-instance = Phrase::KeyFormatAnnotationsList200ResponseInner.new(file_format: xliff_2,
-                                 original_representation: <note category="meaning">header</note>)
+instance = Phrase::KeyFormatAnnotationsList200ResponseInner.new(file_format: 'xliff_2',
+                                 original_representation: '<note category="meaning">header</note>')
 ```
 
 

data/docs/KeyLink.md

@@ -15,15 +15,15 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Phrase'
+require 'phrase'
 
-instance = Phrase::KeyLink.new(created_at: null,
-                                 updated_at: null,
-                                 created_by: null,
-                                 updated_by: null,
-                                 account: null,
-                                 parent: null,
-                                 children: null)
+instance = Phrase::KeyLink.new(created_at: nil,
+                                 updated_at: nil,
+                                 created_by: nil,
+                                 updated_by: nil,
+                                 account: nil,
+                                 parent: nil,
+                                 children: nil)
 ```
 
 

data/docs/KeyLinksBatchDestroyParameters.md

@@ -11,11 +11,11 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Phrase'
+require 'phrase'
 
-instance = Phrase::KeyLinksBatchDestroyParameters.new(child_key_ids: ["feature.subtitle","nav.home"],
-                                 unlink_parent: null,
-                                 strategy: null)
+instance = Phrase::KeyLinksBatchDestroyParameters.new(child_key_ids: ["feature.subtitle","nav.home"],
+                                 unlink_parent: nil,
+                                 strategy: nil)
 ```
 
 

data/docs/KeyLinksCreateParameters.md

@@ -9,9 +9,9 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Phrase'
+require 'phrase'
 
-instance = Phrase::KeyLinksCreateParameters.new(child_key_ids: ["ijkl9012mnop3456ijkl9012mnop3456","abcd1234efgh5678abcd1234efgh5678"])
+instance = Phrase::KeyLinksCreateParameters.new(child_key_ids: ["ijkl9012mnop3456ijkl9012mnop3456","abcd1234efgh5678abcd1234efgh5678"])
 ```
 
 

data/docs/KeyPreview.md

@@ -12,12 +12,12 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Phrase'
+require 'phrase'
 
-instance = Phrase::KeyPreview.new(id: null,
-                                 name: null,
-                                 plural: null,
-                                 use_ordinal_rules: null)
+instance = Phrase::KeyPreview.new(id: nil,
+                                 name: nil,
+                                 plural: nil,
+                                 use_ordinal_rules: nil)
 ```
 
 

data/docs/KeyUpdateParameters.md

@@ -27,27 +27,27 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Phrase'
+require 'phrase'
 
-instance = Phrase::KeyUpdateParameters.new(branch: my-feature-branch,
-                                 name: home.index.headline,
-                                 description: Some description worth knowing...,
-                                 plural: null,
-                                 use_ordinal_rules: null,
-                                 name_plural: home.index.headlines,
-                                 data_type: number,
-                                 tags: awesome-feature,needs-proofreading,
+instance = Phrase::KeyUpdateParameters.new(branch: 'my-feature-branch',
+                                 name: 'home.index.headline',
+                                 description: 'Some description worth knowing...',
+                                 plural: nil,
+                                 use_ordinal_rules: nil,
+                                 name_plural: 'home.index.headlines',
+                                 data_type: 'number',
+                                 tags: 'awesome-feature,needs-proofreading',
                                  max_characters_allowed: 140,
-                                 screenshot: [B@3b1bf4bf,
-                                 remove_screenshot: null,
-                                 unformatted: null,
-                                 xml_space_preserve: null,
-                                 original_file: null,
-                                 localized_format_string: null,
-                                 localized_format_key: null,
-                                 custom_metadata: {"fruit":"Apple","vegetable":"Tomato"},
-                                 excluded_in_locales: ["de","fr"],
-                                 format_value_type: string)
+                                 screenshot: File.new('/path/to/file'),
+                                 remove_screenshot: nil,
+                                 unformatted: nil,
+                                 xml_space_preserve: nil,
+                                 original_file: nil,
+                                 localized_format_string: nil,
+                                 localized_format_key: nil,
+                                 custom_metadata: {"fruit":"Apple","vegetable":"Tomato"},
+                                 excluded_in_locales: ["de","fr"],
+                                 format_value_type: 'string')
 ```
 
 

data/docs/KeysExcludeParameters.md

@@ -12,12 +12,12 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Phrase'
+require 'phrase'
 
-instance = Phrase::KeysExcludeParameters.new(branch: my-feature-branch,
-                                 q: mykey* translated:true,
-                                 target_locale_id: abcd1234abcd1234abcd1234abcd1234,
-                                 tags: landing-page,release-1.2)
+instance = Phrase::KeysExcludeParameters.new(branch: 'my-feature-branch',
+                                 q: 'mykey* translated:true',
+                                 target_locale_id: 'abcd1234abcd1234abcd1234abcd1234',
+                                 tags: 'landing-page,release-1.2')
 ```
 
 

data/docs/KeysIncludeParameters.md

@@ -12,12 +12,12 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Phrase'
+require 'phrase'
 
-instance = Phrase::KeysIncludeParameters.new(branch: my-feature-branch,
-                                 q: mykey* translated:true,
-                                 target_locale_id: abcd1234abcd1234abcd1234abcd1234,
-                                 tags: landing-page,release-1.2)
+instance = Phrase::KeysIncludeParameters.new(branch: 'my-feature-branch',
+                                 q: 'mykey* translated:true',
+                                 target_locale_id: 'abcd1234abcd1234abcd1234abcd1234',
+                                 tags: 'landing-page,release-1.2')
 ```
 
 

data/docs/KeysSearchParameters.md

@@ -13,13 +13,13 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Phrase'
+require 'phrase'
 
-instance = Phrase::KeysSearchParameters.new(branch: my-feature-branch,
-                                 sort: updated_at,
-                                 order: desc,
-                                 q: mykey* translated:true,
-                                 locale_id: abcd1234abcd1234abcd1234abcd1234)
+instance = Phrase::KeysSearchParameters.new(branch: 'my-feature-branch',
+                                 sort: 'updated_at',
+                                 order: 'desc',
+                                 q: 'mykey* translated:true',
+                                 locale_id: 'abcd1234abcd1234abcd1234abcd1234')
 ```
 
 

data/docs/KeysTagParameters.md

@@ -12,12 +12,12 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Phrase'
+require 'phrase'
 
-instance = Phrase::KeysTagParameters.new(branch: my-feature-branch,
-                                 q: mykey* translated:true,
-                                 locale_id: abcd1234abcd1234abcd1234abcd1234,
-                                 tags: landing-page,release-1.2)
+instance = Phrase::KeysTagParameters.new(branch: 'my-feature-branch',
+                                 q: 'mykey* translated:true',
+                                 locale_id: 'abcd1234abcd1234abcd1234abcd1234',
+                                 tags: 'landing-page,release-1.2')
 ```
 
 

data/docs/KeysUntagParameters.md

@@ -12,12 +12,12 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Phrase'
+require 'phrase'
 
-instance = Phrase::KeysUntagParameters.new(branch: my-feature-branch,
-                                 q: mykey* translated:true,
-                                 locale_id: abcd1234abcd1234abcd1234abcd1234,
-                                 tags: landing-page,release-1.2)
+instance = Phrase::KeysUntagParameters.new(branch: 'my-feature-branch',
+                                 q: 'mykey* translated:true',
+                                 locale_id: 'abcd1234abcd1234abcd1234abcd1234',
+                                 tags: 'landing-page,release-1.2')
 ```
 
 

data/docs/Locale.md

@@ -24,24 +24,24 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Phrase'
+require 'phrase'
 
-instance = Phrase::Locale.new(id: null,
-                                 name: null,
-                                 code: null,
-                                 default: null,
-                                 main: null,
-                                 rtl: null,
-                                 plural_forms: null,
-                                 ordinal_plural_forms: null,
-                                 source_locale: null,
-                                 fallback_locale: null,
-                                 language_ai_profile: null,
-                                 unverify_new_translations: null,
-                                 unverify_updated_translations: null,
-                                 unverify_on_source_changes: null,
-                                 created_at: null,
-                                 updated_at: null)
+instance = Phrase::Locale.new(id: nil,
+                                 name: nil,
+                                 code: nil,
+                                 default: nil,
+                                 main: nil,
+                                 rtl: nil,
+                                 plural_forms: nil,
+                                 ordinal_plural_forms: nil,
+                                 source_locale: nil,
+                                 fallback_locale: nil,
+                                 language_ai_profile: nil,
+                                 unverify_new_translations: nil,
+                                 unverify_updated_translations: nil,
+                                 unverify_on_source_changes: nil,
+                                 created_at: nil,
+                                 updated_at: nil)
 ```