phrase 2.8.3 → 2.9.0

data/docs/JobTemplatesApi.md

@@ -6,15 +6,15 @@ Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**job_template_create**](JobTemplatesApi.md#job_template_create) | **POST** /projects/{project_id}/job_templates | Create a job template
 [**job_template_delete**](JobTemplatesApi.md#job_template_delete) | **DELETE** /projects/{project_id}/job_templates/{id} | Delete a job template
-[**job_template_show**](JobTemplatesApi.md#job_template_show) | **GET** /projects/{project_id}/job_templates/{id} | Get a single job template
 [**job_template_update**](JobTemplatesApi.md#job_template_update) | **PATCH** /projects/{project_id}/job_templates/{id} | Update a job template
 [**job_templates_list**](JobTemplatesApi.md#job_templates_list) | **GET** /projects/{project_id}/job_templates | List job templates
+[**job_templates_show**](JobTemplatesApi.md#job_templates_show) | **GET** /projects/{project_id}/job_templates/{id} | Get a single job template
 
 
 
 ## job_template_create
 
-> Object job_template_create(project_id, job_template_create_parameters, opts)
+> JobTemplateDetails job_template_create(project_id, job_template_create_parameters, opts)
 
 Create a job template
 
@@ -63,7 +63,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-Response<(**Object**)>
+Response<([**JobTemplateDetails**](JobTemplateDetails.md))>
 
 ### Authorization
 
@@ -139,13 +139,13 @@ Response<(nil (empty response body))>
 - **Accept**: Not defined
 
 
-## job_template_show
+## job_template_update
 
-> Object job_template_show(project_id, id, opts)
+> JobTemplateDetails job_template_update(project_id, id, job_template_update_parameters, opts)
 
-Get a single job template
+Update a job template
 
-Get details on a single job template for a given project.
+Update an existing job template.
 
 ### Example
 
@@ -166,17 +166,17 @@ end
 api_instance = Phrase::JobTemplatesApi.new
 project_id = 'project_id_example' # String | Project ID
 id = 'id_example' # String | ID
+job_template_update_parameters = Phrase::JobTemplateUpdateParameters.new # JobTemplateUpdateParameters | 
 opts = {
-  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
-  branch: 'my-feature-branch' # String | specify the branch to use
+  x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
 }
 
 begin
-  #Get a single job template
-  result = api_instance.job_template_show(project_id, id, opts)
+  #Update a job template
+  result = api_instance.job_template_update(project_id, id, job_template_update_parameters, opts)
   pp result
 rescue Phrase::ApiError => e
-  puts "Exception when calling JobTemplatesApi->job_template_show: #{e}"
+  puts "Exception when calling JobTemplatesApi->job_template_update: #{e}"
 end
 ```
 
@@ -187,12 +187,12 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **project_id** | **String**| Project ID | 
  **id** | **String**| ID | 
+ **job_template_update_parameters** | [**JobTemplateUpdateParameters**](JobTemplateUpdateParameters.md)|  | 
  **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
- **branch** | **String**| specify the branch to use | [optional] 
 
 ### Return type
 
-Response<(**Object**)>
+Response<([**JobTemplateDetails**](JobTemplateDetails.md))>
 
 ### Authorization
 
@@ -200,17 +200,17 @@ Response<(**Object**)>
 
 ### HTTP request headers
 
-- **Content-Type**: Not defined
+- **Content-Type**: application/json
 - **Accept**: application/json
 
 
-## job_template_update
+## job_templates_list
 
-> Object job_template_update(project_id, id, job_template_update_parameters, opts)
+> Array&lt;JobTemplate&gt; job_templates_list(project_id, opts)
 
-Update a job template
+List job templates
 
-Update an existing job template.
+List all job templates for the given project.
 
 ### Example
 
@@ -230,18 +230,19 @@ end
 
 api_instance = Phrase::JobTemplatesApi.new
 project_id = 'project_id_example' # String | Project ID
-id = 'id_example' # String | ID
-job_template_update_parameters = Phrase::JobTemplateUpdateParameters.new # JobTemplateUpdateParameters | 
 opts = {
-  x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
+  page: 1, # Integer | Page number
+  per_page: 25, # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
+  branch: 'my-feature-branch' # String | specify the branch to use
 }
 
 begin
-  #Update a job template
-  result = api_instance.job_template_update(project_id, id, job_template_update_parameters, opts)
+  #List job templates
+  result = api_instance.job_templates_list(project_id, opts)
   pp result
 rescue Phrase::ApiError => e
-  puts "Exception when calling JobTemplatesApi->job_template_update: #{e}"
+  puts "Exception when calling JobTemplatesApi->job_templates_list: #{e}"
 end
 ```
 
@@ -251,13 +252,14 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **project_id** | **String**| Project ID | 
- **id** | **String**| ID | 
- **job_template_update_parameters** | [**JobTemplateUpdateParameters**](JobTemplateUpdateParameters.md)|  | 
  **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+ **page** | **Integer**| Page number | [optional] 
+ **per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional] 
+ **branch** | **String**| specify the branch to use | [optional] 
 
 ### Return type
 
-Response<(**Object**)>
+Response<([**Array&lt;JobTemplate&gt;**](JobTemplate.md))>
 
 ### Authorization
 
@@ -265,17 +267,17 @@ Response<(**Object**)>
 
 ### HTTP request headers
 
-- **Content-Type**: application/json
+- **Content-Type**: Not defined
 - **Accept**: application/json
 
 
-## job_templates_list
+## job_templates_show
 
-> Array&lt;JobTemplate&gt; job_templates_list(project_id, opts)
+> JobTemplateDetails job_templates_show(project_id, id, opts)
 
-List job templates
+Get a single job template
 
-List all job templates for the given project.
+Get details on a single job template for a given project.
 
 ### Example
 
@@ -295,19 +297,18 @@ end
 
 api_instance = Phrase::JobTemplatesApi.new
 project_id = 'project_id_example' # String | Project ID
+id = 'id_example' # String | ID
 opts = {
   x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
-  page: 1, # Integer | Page number
-  per_page: 25, # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
   branch: 'my-feature-branch' # String | specify the branch to use
 }
 
 begin
-  #List job templates
-  result = api_instance.job_templates_list(project_id, opts)
+  #Get a single job template
+  result = api_instance.job_templates_show(project_id, id, opts)
   pp result
 rescue Phrase::ApiError => e
-  puts "Exception when calling JobTemplatesApi->job_templates_list: #{e}"
+  puts "Exception when calling JobTemplatesApi->job_templates_show: #{e}"
 end
 ```
 
@@ -317,14 +318,13 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **project_id** | **String**| Project ID | 
+ **id** | **String**| ID | 
  **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
- **page** | **Integer**| Page number | [optional] 
- **per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional] 
  **branch** | **String**| specify the branch to use | [optional] 
 
 ### Return type
 
-Response<([**Array&lt;JobTemplate&gt;**](JobTemplate.md))>
+Response<([**JobTemplateDetails**](JobTemplateDetails.md))>
 
 ### Authorization
 

data/docs/KeysSearchParameters.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **branch** | **String** | specify the branch to use | [optional] 
 **sort** | **String** | Sort by field. Can be one of: name, created_at, updated_at. | [optional] 
 **order** | **String** | Order direction. Can be one of: asc, desc. | [optional] 
-**q** | **String** | Specify a query to do broad search for keys by name (including wildcards).<br><br> The following qualifiers are also supported in the search term:<br> <ul>   <li><code>ids:key_id,...</code> for queries on a comma-separated list of ids</li>   <li><code>name:key_name</code> for text queries on exact key names - spaces, commas, and colons  need to be escaped with double backslashes</li>   <li><code>tags:tag_name</code> to filter for keys with certain tags</li>   <li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li>   <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li>   <li><code>unmentioned_in_upload:upload_id</code> to filter keys unmentioned within upload</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>.  | [optional] 
+**q** | **String** | Specify a query to do broad search for keys by name (including wildcards).<br><br> The following qualifiers are also supported in the search term:<br> <ul>   <li><code>ids:key_id,...</code> for queries on a comma-separated list of ids</li>   <li><code>name:key_name</code> for text queries on exact key names - spaces, commas, and colons  need to be escaped with double backslashes</li>   <li><code>tags:tag_name</code> to filter for keys with certain tags</li>   <li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li>   <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li>   <li><code>unmentioned_in_upload:upload_id</code> to filter keys unmentioned within upload</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>. Please note: If <code>tags</code> are added to filter the search, the search will be limited to a maximum of 65,536 tagged keys.  | [optional] 
 **locale_id** | **String** | Locale used to determine the translation state of a key when filtering for untranslated or translated keys. | [optional] 
 
 ## Code Sample

data/docs/LocaleTeamPreview.md

@@ -0,0 +1,21 @@
+# Phrase::LocaleTeamPreview
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+**role** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::LocaleTeamPreview.new(id: null,
+                                 name: null,
+                                 role: null)
+```
+
+

data/docs/{JobTemplateUserPreview.md → LocaleUserPreview.md}

@@ -1,4 +1,4 @@
-# Phrase::JobTemplateUserPreview
+# Phrase::LocaleUserPreview
 
 ## Properties
 
@@ -14,7 +14,7 @@ Name | Type | Description | Notes
 ```ruby
 require 'Phrase'
 
-instance = Phrase::JobTemplateUserPreview.new(id: null,
+instance = Phrase::LocaleUserPreview.new(id: null,
                                  username: null,
                                  name: null,
                                  role: null)

data/docs/LocalesApi.md

@@ -235,8 +235,10 @@ project_id = 'project_id_example' # String | Project ID
 id = 'id_example' # String | ID
 opts = {
   x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
+  if_modified_since: 'if_modified_since_example', # String | Last modified condition, see <a href=\"#overview--conditional-get-requests--http-caching\">Conditional GET requests / HTTP Caching</a> (optional)
+  if_none_match: 'if_none_match_example', # String | ETag condition, see <a href=\"#overview--conditional-get-requests--http-caching\">Conditional GET requests / HTTP Caching</a> (optional)
   branch: 'my-feature-branch', # String | specify the branch to use
-  file_format: 'yml', # String | File format name. See the <a href=\"https://support.phrase.com/hc/en-us/articles/5784070560412\">format guide</a> for all supported file formats.
+  file_format: 'yml', # String | File format name. See the <a href=\"https://support.phrase.com/hc/en-us/sections/6111343326364\">format guide</a> for all supported file formats.
   tags: 'feature1,feature2', # String | Limit results to keys tagged with a list of comma separated tag names.
   tag: 'feature', # String | Limit download to tagged keys. This parameter is deprecated. Please use the \"tags\" parameter instead
   include_empty_translations: true, # Boolean | Indicates whether keys without translations should be included in the output as well.
@@ -244,7 +246,7 @@ opts = {
   include_translated_keys: true, # Boolean | Include translated keys in the locale file. Use in combination with include_empty_translations to obtain only untranslated keys.
   keep_notranslate_tags: true, # Boolean | Indicates whether [NOTRANSLATE] tags should be kept.
   convert_emoji: true, # Boolean | This option is obsolete. Projects that were created on or after Nov 29th 2019 or that did not contain emoji by then will not require this flag any longer since emoji are now supported natively.
-  format_options: nil, # Object | Additional formatting and render options. See the <a href=\"https://support.phrase.com/hc/en-us/articles/5784070560412\">format guide</a> for a list of options available for each format. Specify format options like this: <code>...&format_options[foo]=bar</code>
+  format_options: nil, # Object | Additional formatting and render options. See the <a href=\"https://support.phrase.com/hc/en-us/sections/6111343326364\">format guide</a> for a list of options available for each format. Specify format options like this: <code>...&format_options[foo]=bar</code>
   encoding: 'encoding_example', # String | Enforces a specific encoding on the file contents. Valid options are \"UTF-8\", \"UTF-16\" and \"ISO-8859-1\".
   skip_unverified_translations: true, # Boolean | Indicates whether the locale file should skip all unverified translations. This parameter is deprecated and should be replaced with <code>include_unverified_translations</code>.
   include_unverified_translations: true, # Boolean | if set to false unverified translations are excluded
@@ -270,8 +272,10 @@ Name | Type | Description  | Notes
  **project_id** | **String**| Project ID | 
  **id** | **String**| ID | 
  **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+ **if_modified_since** | **String**| Last modified condition, see &lt;a href&#x3D;\&quot;#overview--conditional-get-requests--http-caching\&quot;&gt;Conditional GET requests / HTTP Caching&lt;/a&gt; (optional) | [optional] 
+ **if_none_match** | **String**| ETag condition, see &lt;a href&#x3D;\&quot;#overview--conditional-get-requests--http-caching\&quot;&gt;Conditional GET requests / HTTP Caching&lt;/a&gt; (optional) | [optional] 
  **branch** | **String**| specify the branch to use | [optional] 
- **file_format** | **String**| File format name. See the &lt;a href&#x3D;\&quot;https://support.phrase.com/hc/en-us/articles/5784070560412\&quot;&gt;format guide&lt;/a&gt; for all supported file formats. | [optional] 
+ **file_format** | **String**| File format name. See the &lt;a href&#x3D;\&quot;https://support.phrase.com/hc/en-us/sections/6111343326364\&quot;&gt;format guide&lt;/a&gt; for all supported file formats. | [optional] 
  **tags** | **String**| Limit results to keys tagged with a list of comma separated tag names. | [optional] 
  **tag** | **String**| Limit download to tagged keys. This parameter is deprecated. Please use the \&quot;tags\&quot; parameter instead | [optional] 
  **include_empty_translations** | **Boolean**| Indicates whether keys without translations should be included in the output as well. | [optional] 
@@ -279,7 +283,7 @@ Name | Type | Description  | Notes
  **include_translated_keys** | **Boolean**| Include translated keys in the locale file. Use in combination with include_empty_translations to obtain only untranslated keys. | [optional] 
  **keep_notranslate_tags** | **Boolean**| Indicates whether [NOTRANSLATE] tags should be kept. | [optional] 
  **convert_emoji** | **Boolean**| This option is obsolete. Projects that were created on or after Nov 29th 2019 or that did not contain emoji by then will not require this flag any longer since emoji are now supported natively. | [optional] 
- **format_options** | [**Object**](.md)| Additional formatting and render options. See the &lt;a href&#x3D;\&quot;https://support.phrase.com/hc/en-us/articles/5784070560412\&quot;&gt;format guide&lt;/a&gt; for a list of options available for each format. Specify format options like this: &lt;code&gt;...&amp;format_options[foo]&#x3D;bar&lt;/code&gt; | [optional] 
+ **format_options** | [**Object**](.md)| Additional formatting and render options. See the &lt;a href&#x3D;\&quot;https://support.phrase.com/hc/en-us/sections/6111343326364\&quot;&gt;format guide&lt;/a&gt; for a list of options available for each format. Specify format options like this: &lt;code&gt;...&amp;format_options[foo]&#x3D;bar&lt;/code&gt; | [optional] 
  **encoding** | **String**| Enforces a specific encoding on the file contents. Valid options are \&quot;UTF-8\&quot;, \&quot;UTF-16\&quot; and \&quot;ISO-8859-1\&quot;. | [optional] 
  **skip_unverified_translations** | **Boolean**| Indicates whether the locale file should skip all unverified translations. This parameter is deprecated and should be replaced with &lt;code&gt;include_unverified_translations&lt;/code&gt;. | [optional] 
  **include_unverified_translations** | **Boolean**| if set to false unverified translations are excluded | [optional] 

data/docs/NotificationGroupDetail.md

@@ -9,7 +9,7 @@ Name | Type | Description | Notes
 **created_at** | **DateTime** |  | [optional] 
 **updated_at** | **DateTime** |  | [optional] 
 **notifications_count** | **Integer** |  | [optional] 
-**latest_notification** | **Object** |  | [optional] 
+**latest_notification** | [**Notification**](Notification.md) |  | [optional] 
 
 ## Code Sample
 

data/docs/NotificationGroupsApi.md

@@ -12,7 +12,7 @@ Method | HTTP request | Description
 
 ## notification_groups_list
 
-> Array<Object> notification_groups_list(opts)
+> Array<NotificationGroupDetail> notification_groups_list(opts)
 
 List notification groups
 
@@ -61,7 +61,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-Response<(**Array&lt;Object&gt;**)>
+Response<([**Array&lt;NotificationGroupDetail&gt;**](NotificationGroupDetail.md))>
 
 ### Authorization
 
@@ -75,7 +75,7 @@ Response<(**Array&lt;Object&gt;**)>
 
 ## notification_groups_mark_all_as_read
 
-> Array&lt;Object&gt; notification_groups_mark_all_as_read(opts)
+> Array&lt;NotificationGroupDetail&gt; notification_groups_mark_all_as_read(opts)
 
 Mark all notification groups as read
 
@@ -120,7 +120,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-Response<(**Array&lt;Object&gt;**)>
+Response<([**Array&lt;NotificationGroupDetail&gt;**](NotificationGroupDetail.md))>
 
 ### Authorization
 

data/docs/NotificationsApi.md

@@ -12,7 +12,7 @@ Method | HTTP request | Description
 
 ## notifications_list
 
-> Array<Object> notifications_list(opts)
+> Array<Notification> notifications_list(opts)
 
 List notifications
 
@@ -63,7 +63,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-Response<(**Array&lt;Object&gt;**)>
+Response<([**Array&lt;Notification&gt;**](Notification.md))>
 
 ### Authorization
 
@@ -77,7 +77,7 @@ Response<(**Array&lt;Object&gt;**)>
 
 ## notifications_mark_all_as_read
 
-> Array&lt;Object&gt; notifications_mark_all_as_read(opts)
+> Array&lt;Notification&gt; notifications_mark_all_as_read(opts)
 
 Mark all notifications as read
 
@@ -122,7 +122,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-Response<(**Array&lt;Object&gt;**)>
+Response<([**Array&lt;Notification&gt;**](Notification.md))>
 
 ### Authorization
 

data/docs/OrganizationJobTemplate.md

@@ -0,0 +1,25 @@
+# Phrase::OrganizationJobTemplate
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+**briefing** | **String** |  | [optional] 
+**created_at** | **DateTime** |  | [optional] 
+**updated_at** | **DateTime** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::OrganizationJobTemplate.new(id: null,
+                                 name: null,
+                                 briefing: null,
+                                 created_at: null,
+                                 updated_at: null)
+```
+
+

data/docs/OrganizationJobTemplateCreateParameters.md

@@ -0,0 +1,19 @@
+# Phrase::OrganizationJobTemplateCreateParameters
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Job template name | 
+**briefing** | **String** | Briefing for the translators | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::OrganizationJobTemplateCreateParameters.new(name: template,
+                                 briefing: text)
+```
+
+

data/docs/OrganizationJobTemplateDetails.md

@@ -0,0 +1,31 @@
+# Phrase::OrganizationJobTemplateDetails
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+**briefing** | **String** |  | [optional] 
+**created_at** | **DateTime** |  | [optional] 
+**updated_at** | **DateTime** |  | [optional] 
+**owner** | [**UserPreview**](UserPreview.md) |  | [optional] 
+**creator** | [**UserPreview**](UserPreview.md) |  | [optional] 
+**locales** | [**Array<LocalePreview>**](LocalePreview.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::OrganizationJobTemplateDetails.new(id: null,
+                                 name: null,
+                                 briefing: null,
+                                 created_at: null,
+                                 updated_at: null,
+                                 owner: null,
+                                 creator: null,
+                                 locales: null)
+```
+
+

data/docs/OrganizationJobTemplateLocaleUpdateParameters.md

@@ -0,0 +1,27 @@
+# Phrase::OrganizationJobTemplateLocaleUpdateParameters
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**locale_name** | **String** | locale name | [optional] 
+**locale_code** | **String** | locale code | [optional] 
+**user_ids** | **Array<String>** | Array of user ids to be assigned to the job template locale | [optional] 
+**reviewer_ids** | **Array<String>** | Array of reviewer ids to be assigned to the job template locale | [optional] 
+**translator_team_ids** | **Array<String>** | Array of team ids to be assigned to the job locale as translators | [optional] 
+**reviewer_team_ids** | **Array<String>** | Array of team ids to be assigned to the job locale as reviewers | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::OrganizationJobTemplateLocaleUpdateParameters.new(locale_name: de-1,
+                                 locale_code: de-DE,
+                                 user_ids: ["abcd1234cdef1234abcd1234cdef1234"],
+                                 reviewer_ids: ["abcd1234cdef1234abcd1234cdef1234"],
+                                 translator_team_ids: ["abcd1234cdef1234abcd1234cdef1234"],
+                                 reviewer_team_ids: ["abcd1234cdef1234abcd1234cdef1234"])
+```
+
+