phrase 2.8.3 → 2.8.7

Sign up to get free protection for your applications and to get access to all the features.
Files changed (103) hide show
  1. checksums.yaml +4 -4
  2. data/LICENSE +1 -1
  3. data/README.md +15 -12
  4. data/docs/BitbucketSyncApi.md +2 -2
  5. data/docs/BranchesApi.md +3 -3
  6. data/docs/GitHubSyncApi.md +2 -2
  7. data/docs/GitLabSyncApi.md +2 -2
  8. data/docs/JobCommentsApi.md +6 -6
  9. data/docs/JobLocale.md +3 -1
  10. data/docs/JobLocaleUpdateParameters.md +5 -1
  11. data/docs/JobLocalesCreateParameters.md +6 -2
  12. data/docs/JobTemplateDetails.md +35 -0
  13. data/docs/JobTemplateDetails1.md +21 -0
  14. data/docs/JobTemplateLocaleUpdateParameters.md +6 -2
  15. data/docs/{JobTemplateLocale.md → JobTemplateLocales.md} +6 -4
  16. data/docs/JobTemplateLocalesApi.md +8 -8
  17. data/docs/JobTemplateLocalesCreateParameters.md +5 -1
  18. data/docs/JobTemplatesApi.md +41 -41
  19. data/docs/KeysSearchParameters.md +1 -1
  20. data/docs/LocaleTeamPreview.md +21 -0
  21. data/docs/{JobTemplateUserPreview.md → LocaleUserPreview.md} +2 -2
  22. data/docs/LocalesApi.md +8 -4
  23. data/docs/NotificationGroupDetail.md +1 -1
  24. data/docs/NotificationGroupsApi.md +4 -4
  25. data/docs/NotificationsApi.md +4 -4
  26. data/docs/Project.md +2 -0
  27. data/docs/ProjectCreateParameters.md +5 -1
  28. data/docs/ProjectDetails.md +2 -0
  29. data/docs/ProjectUpdateParameters.md +5 -1
  30. data/docs/SearchApi.md +1 -1
  31. data/docs/TranslationsApi.md +23 -19
  32. data/docs/TranslationsExcludeParameters.md +1 -1
  33. data/docs/TranslationsIncludeParameters.md +1 -1
  34. data/docs/TranslationsReviewParameters.md +1 -1
  35. data/docs/TranslationsSearchParameters.md +1 -1
  36. data/docs/TranslationsUnverifyParameters.md +1 -1
  37. data/docs/TranslationsVerifyParameters.md +1 -1
  38. data/docs/UploadsApi.md +3 -3
  39. data/lib/phrase/api/bitbucket_sync_api.rb +4 -4
  40. data/lib/phrase/api/branches_api.rb +6 -6
  41. data/lib/phrase/api/git_hub_sync_api.rb +4 -4
  42. data/lib/phrase/api/git_lab_sync_api.rb +4 -4
  43. data/lib/phrase/api/job_comments_api.rb +9 -9
  44. data/lib/phrase/api/job_template_locales_api.rb +12 -12
  45. data/lib/phrase/api/job_templates_api.rb +72 -72
  46. data/lib/phrase/api/locales_api.rb +10 -4
  47. data/lib/phrase/api/notification_groups_api.rb +6 -6
  48. data/lib/phrase/api/notifications_api.rb +6 -6
  49. data/lib/phrase/api/search_api.rb +2 -2
  50. data/lib/phrase/api/translations_api.rb +20 -14
  51. data/lib/phrase/api/uploads_api.rb +2 -2
  52. data/lib/phrase/models/job_locale.rb +13 -2
  53. data/lib/phrase/models/job_locale_update_parameters.rb +28 -4
  54. data/lib/phrase/models/job_locales_create_parameters.rb +33 -4
  55. data/lib/phrase/models/job_template_details.rb +285 -0
  56. data/lib/phrase/models/job_template_details1.rb +214 -0
  57. data/lib/phrase/models/job_template_locale_update_parameters.rb +28 -9
  58. data/lib/phrase/models/{job_template_locale.rb → job_template_locales.rb} +18 -7
  59. data/lib/phrase/models/job_template_locales_create_parameters.rb +28 -4
  60. data/lib/phrase/models/keys_search_parameters.rb +1 -1
  61. data/lib/phrase/models/locale_team_preview.rb +212 -0
  62. data/lib/phrase/models/{job_template_user_preview.rb → locale_user_preview.rb} +3 -3
  63. data/lib/phrase/models/notification_group_detail.rb +1 -1
  64. data/lib/phrase/models/project.rb +10 -1
  65. data/lib/phrase/models/project_create_parameters.rb +22 -2
  66. data/lib/phrase/models/project_details.rb +10 -1
  67. data/lib/phrase/models/project_update_parameters.rb +22 -2
  68. data/lib/phrase/models/translations_exclude_parameters.rb +1 -1
  69. data/lib/phrase/models/translations_include_parameters.rb +1 -1
  70. data/lib/phrase/models/translations_review_parameters.rb +1 -1
  71. data/lib/phrase/models/translations_search_parameters.rb +1 -1
  72. data/lib/phrase/models/translations_unverify_parameters.rb +1 -1
  73. data/lib/phrase/models/translations_verify_parameters.rb +1 -1
  74. data/lib/phrase/version.rb +1 -1
  75. data/lib/phrase.rb +5 -2
  76. data/spec/api/bitbucket_sync_api_spec.rb +2 -2
  77. data/spec/api/branches_api_spec.rb +3 -3
  78. data/spec/api/git_hub_sync_api_spec.rb +2 -2
  79. data/spec/api/git_lab_sync_api_spec.rb +2 -2
  80. data/spec/api/job_comments_api_spec.rb +3 -3
  81. data/spec/api/job_template_locales_api_spec.rb +4 -4
  82. data/spec/api/job_templates_api_spec.rb +17 -17
  83. data/spec/api/locales_api_spec.rb +4 -2
  84. data/spec/api/notification_groups_api_spec.rb +2 -2
  85. data/spec/api/notifications_api_spec.rb +2 -2
  86. data/spec/api/search_api_spec.rb +1 -1
  87. data/spec/api/translations_api_spec.rb +9 -7
  88. data/spec/api/uploads_api_spec.rb +1 -1
  89. data/spec/models/job_locale_spec.rb +6 -0
  90. data/spec/models/job_locale_update_parameters_spec.rb +12 -0
  91. data/spec/models/job_locales_create_parameters_spec.rb +12 -0
  92. data/spec/models/job_template_details1_spec.rb +41 -0
  93. data/spec/models/job_template_details_spec.rb +83 -0
  94. data/spec/models/job_template_locale_update_parameters_spec.rb +12 -0
  95. data/spec/models/job_template_locales_create_parameters_spec.rb +12 -0
  96. data/spec/models/{job_template_locale_spec.rb → job_template_locales_spec.rb} +12 -6
  97. data/spec/models/locale_team_preview_spec.rb +41 -0
  98. data/spec/models/{job_template_user_preview_spec.rb → locale_user_preview_spec.rb} +6 -6
  99. data/spec/models/project_create_parameters_spec.rb +12 -0
  100. data/spec/models/project_details_spec.rb +6 -0
  101. data/spec/models/project_spec.rb +6 -0
  102. data/spec/models/project_update_parameters_spec.rb +12 -0
  103. metadata +237 -225
@@ -6,15 +6,15 @@ Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
7
  [**job_template_create**](JobTemplatesApi.md#job_template_create) | **POST** /projects/{project_id}/job_templates | Create a job template
8
8
  [**job_template_delete**](JobTemplatesApi.md#job_template_delete) | **DELETE** /projects/{project_id}/job_templates/{id} | Delete a job template
9
- [**job_template_show**](JobTemplatesApi.md#job_template_show) | **GET** /projects/{project_id}/job_templates/{id} | Get a single job template
10
9
  [**job_template_update**](JobTemplatesApi.md#job_template_update) | **PATCH** /projects/{project_id}/job_templates/{id} | Update a job template
11
10
  [**job_templates_list**](JobTemplatesApi.md#job_templates_list) | **GET** /projects/{project_id}/job_templates | List job templates
11
+ [**job_templates_show**](JobTemplatesApi.md#job_templates_show) | **GET** /projects/{project_id}/job_templates/{id} | Get a single job template
12
12
 
13
13
 
14
14
 
15
15
  ## job_template_create
16
16
 
17
- > Object job_template_create(project_id, job_template_create_parameters, opts)
17
+ > JobTemplateDetails job_template_create(project_id, job_template_create_parameters, opts)
18
18
 
19
19
  Create a job template
20
20
 
@@ -63,7 +63,7 @@ Name | Type | Description | Notes
63
63
 
64
64
  ### Return type
65
65
 
66
- Response<(**Object**)>
66
+ Response<([**JobTemplateDetails**](JobTemplateDetails.md))>
67
67
 
68
68
  ### Authorization
69
69
 
@@ -139,13 +139,13 @@ Response<(nil (empty response body))>
139
139
  - **Accept**: Not defined
140
140
 
141
141
 
142
- ## job_template_show
142
+ ## job_template_update
143
143
 
144
- > Object job_template_show(project_id, id, opts)
144
+ > JobTemplateDetails job_template_update(project_id, id, job_template_update_parameters, opts)
145
145
 
146
- Get a single job template
146
+ Update a job template
147
147
 
148
- Get details on a single job template for a given project.
148
+ Update an existing job template.
149
149
 
150
150
  ### Example
151
151
 
@@ -166,17 +166,17 @@ end
166
166
  api_instance = Phrase::JobTemplatesApi.new
167
167
  project_id = 'project_id_example' # String | Project ID
168
168
  id = 'id_example' # String | ID
169
+ job_template_update_parameters = Phrase::JobTemplateUpdateParameters.new # JobTemplateUpdateParameters |
169
170
  opts = {
170
- x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
171
- branch: 'my-feature-branch' # String | specify the branch to use
171
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
172
172
  }
173
173
 
174
174
  begin
175
- #Get a single job template
176
- result = api_instance.job_template_show(project_id, id, opts)
175
+ #Update a job template
176
+ result = api_instance.job_template_update(project_id, id, job_template_update_parameters, opts)
177
177
  pp result
178
178
  rescue Phrase::ApiError => e
179
- puts "Exception when calling JobTemplatesApi->job_template_show: #{e}"
179
+ puts "Exception when calling JobTemplatesApi->job_template_update: #{e}"
180
180
  end
181
181
  ```
182
182
 
@@ -187,12 +187,12 @@ Name | Type | Description | Notes
187
187
  ------------- | ------------- | ------------- | -------------
188
188
  **project_id** | **String**| Project ID |
189
189
  **id** | **String**| ID |
190
+ **job_template_update_parameters** | [**JobTemplateUpdateParameters**](JobTemplateUpdateParameters.md)| |
190
191
  **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
191
- **branch** | **String**| specify the branch to use | [optional]
192
192
 
193
193
  ### Return type
194
194
 
195
- Response<(**Object**)>
195
+ Response<([**JobTemplateDetails**](JobTemplateDetails.md))>
196
196
 
197
197
  ### Authorization
198
198
 
@@ -200,17 +200,17 @@ Response<(**Object**)>
200
200
 
201
201
  ### HTTP request headers
202
202
 
203
- - **Content-Type**: Not defined
203
+ - **Content-Type**: application/json
204
204
  - **Accept**: application/json
205
205
 
206
206
 
207
- ## job_template_update
207
+ ## job_templates_list
208
208
 
209
- > Object job_template_update(project_id, id, job_template_update_parameters, opts)
209
+ > Array&lt;JobTemplate&gt; job_templates_list(project_id, opts)
210
210
 
211
- Update a job template
211
+ List job templates
212
212
 
213
- Update an existing job template.
213
+ List all job templates for the given project.
214
214
 
215
215
  ### Example
216
216
 
@@ -230,18 +230,19 @@ end
230
230
 
231
231
  api_instance = Phrase::JobTemplatesApi.new
232
232
  project_id = 'project_id_example' # String | Project ID
233
- id = 'id_example' # String | ID
234
- job_template_update_parameters = Phrase::JobTemplateUpdateParameters.new # JobTemplateUpdateParameters |
235
233
  opts = {
236
- x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
234
+ x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
235
+ page: 1, # Integer | Page number
236
+ per_page: 25, # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
237
+ branch: 'my-feature-branch' # String | specify the branch to use
237
238
  }
238
239
 
239
240
  begin
240
- #Update a job template
241
- result = api_instance.job_template_update(project_id, id, job_template_update_parameters, opts)
241
+ #List job templates
242
+ result = api_instance.job_templates_list(project_id, opts)
242
243
  pp result
243
244
  rescue Phrase::ApiError => e
244
- puts "Exception when calling JobTemplatesApi->job_template_update: #{e}"
245
+ puts "Exception when calling JobTemplatesApi->job_templates_list: #{e}"
245
246
  end
246
247
  ```
247
248
 
@@ -251,13 +252,14 @@ end
251
252
  Name | Type | Description | Notes
252
253
  ------------- | ------------- | ------------- | -------------
253
254
  **project_id** | **String**| Project ID |
254
- **id** | **String**| ID |
255
- **job_template_update_parameters** | [**JobTemplateUpdateParameters**](JobTemplateUpdateParameters.md)| |
256
255
  **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
256
+ **page** | **Integer**| Page number | [optional]
257
+ **per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional]
258
+ **branch** | **String**| specify the branch to use | [optional]
257
259
 
258
260
  ### Return type
259
261
 
260
- Response<(**Object**)>
262
+ Response<([**Array&lt;JobTemplate&gt;**](JobTemplate.md))>
261
263
 
262
264
  ### Authorization
263
265
 
@@ -265,17 +267,17 @@ Response<(**Object**)>
265
267
 
266
268
  ### HTTP request headers
267
269
 
268
- - **Content-Type**: application/json
270
+ - **Content-Type**: Not defined
269
271
  - **Accept**: application/json
270
272
 
271
273
 
272
- ## job_templates_list
274
+ ## job_templates_show
273
275
 
274
- > Array&lt;JobTemplate&gt; job_templates_list(project_id, opts)
276
+ > JobTemplateDetails job_templates_show(project_id, id, opts)
275
277
 
276
- List job templates
278
+ Get a single job template
277
279
 
278
- List all job templates for the given project.
280
+ Get details on a single job template for a given project.
279
281
 
280
282
  ### Example
281
283
 
@@ -295,19 +297,18 @@ end
295
297
 
296
298
  api_instance = Phrase::JobTemplatesApi.new
297
299
  project_id = 'project_id_example' # String | Project ID
300
+ id = 'id_example' # String | ID
298
301
  opts = {
299
302
  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
300
- page: 1, # Integer | Page number
301
- per_page: 25, # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
302
303
  branch: 'my-feature-branch' # String | specify the branch to use
303
304
  }
304
305
 
305
306
  begin
306
- #List job templates
307
- result = api_instance.job_templates_list(project_id, opts)
307
+ #Get a single job template
308
+ result = api_instance.job_templates_show(project_id, id, opts)
308
309
  pp result
309
310
  rescue Phrase::ApiError => e
310
- puts "Exception when calling JobTemplatesApi->job_templates_list: #{e}"
311
+ puts "Exception when calling JobTemplatesApi->job_templates_show: #{e}"
311
312
  end
312
313
  ```
313
314
 
@@ -317,14 +318,13 @@ end
317
318
  Name | Type | Description | Notes
318
319
  ------------- | ------------- | ------------- | -------------
319
320
  **project_id** | **String**| Project ID |
321
+ **id** | **String**| ID |
320
322
  **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
321
- **page** | **Integer**| Page number | [optional]
322
- **per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional]
323
323
  **branch** | **String**| specify the branch to use | [optional]
324
324
 
325
325
  ### Return type
326
326
 
327
- Response<([**Array&lt;JobTemplate&gt;**](JobTemplate.md))>
327
+ Response<([**JobTemplateDetails**](JobTemplateDetails.md))>
328
328
 
329
329
  ### Authorization
330
330
 
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
7
7
  **branch** | **String** | specify the branch to use | [optional]
8
8
  **sort** | **String** | Sort by field. Can be one of: name, created_at, updated_at. | [optional]
9
9
  **order** | **String** | Order direction. Can be one of: asc, desc. | [optional]
10
- **q** | **String** | Specify a query to do broad search for keys by name (including wildcards).&lt;br&gt;&lt;br&gt; The following qualifiers are also supported in the search term:&lt;br&gt; &lt;ul&gt; &lt;li&gt;&lt;code&gt;ids:key_id,...&lt;/code&gt; for queries on a comma-separated list of ids&lt;/li&gt; &lt;li&gt;&lt;code&gt;name:key_name&lt;/code&gt; for text queries on exact key names - spaces, commas, and colons need to be escaped with double backslashes&lt;/li&gt; &lt;li&gt;&lt;code&gt;tags:tag_name&lt;/code&gt; to filter for keys with certain tags&lt;/li&gt; &lt;li&gt;&lt;code&gt;translated:{true|false}&lt;/code&gt; for translation status (also requires &lt;code&gt;locale_id&lt;/code&gt; to be specified)&lt;/li&gt; &lt;li&gt;&lt;code&gt;updated_at:{&gt;&#x3D;|&lt;&#x3D;}2013-02-21T00:00:00Z&lt;/code&gt; for date range queries&lt;/li&gt; &lt;li&gt;&lt;code&gt;unmentioned_in_upload:upload_id&lt;/code&gt; to filter keys unmentioned within upload&lt;/li&gt; &lt;/ul&gt; Find more examples &lt;a href&#x3D;\&quot;#overview--usage-examples\&quot;&gt;here&lt;/a&gt;. | [optional]
10
+ **q** | **String** | Specify a query to do broad search for keys by name (including wildcards).&lt;br&gt;&lt;br&gt; The following qualifiers are also supported in the search term:&lt;br&gt; &lt;ul&gt; &lt;li&gt;&lt;code&gt;ids:key_id,...&lt;/code&gt; for queries on a comma-separated list of ids&lt;/li&gt; &lt;li&gt;&lt;code&gt;name:key_name&lt;/code&gt; for text queries on exact key names - spaces, commas, and colons need to be escaped with double backslashes&lt;/li&gt; &lt;li&gt;&lt;code&gt;tags:tag_name&lt;/code&gt; to filter for keys with certain tags&lt;/li&gt; &lt;li&gt;&lt;code&gt;translated:{true|false}&lt;/code&gt; for translation status (also requires &lt;code&gt;locale_id&lt;/code&gt; to be specified)&lt;/li&gt; &lt;li&gt;&lt;code&gt;updated_at:{&gt;&#x3D;|&lt;&#x3D;}2013-02-21T00:00:00Z&lt;/code&gt; for date range queries&lt;/li&gt; &lt;li&gt;&lt;code&gt;unmentioned_in_upload:upload_id&lt;/code&gt; to filter keys unmentioned within upload&lt;/li&gt; &lt;/ul&gt; Find more examples &lt;a href&#x3D;\&quot;#overview--usage-examples\&quot;&gt;here&lt;/a&gt;. Please note: If &lt;code&gt;tags&lt;/code&gt; are added to filter the search, the search will be limited to a maximum of 65,536 tagged keys. | [optional]
11
11
  **locale_id** | **String** | Locale used to determine the translation state of a key when filtering for untranslated or translated keys. | [optional]
12
12
 
13
13
  ## Code Sample
@@ -0,0 +1,21 @@
1
+ # Phrase::LocaleTeamPreview
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **id** | **String** | | [optional]
8
+ **name** | **String** | | [optional]
9
+ **role** | **String** | | [optional]
10
+
11
+ ## Code Sample
12
+
13
+ ```ruby
14
+ require 'Phrase'
15
+
16
+ instance = Phrase::LocaleTeamPreview.new(id: null,
17
+ name: null,
18
+ role: null)
19
+ ```
20
+
21
+
@@ -1,4 +1,4 @@
1
- # Phrase::JobTemplateUserPreview
1
+ # Phrase::LocaleUserPreview
2
2
 
3
3
  ## Properties
4
4
 
@@ -14,7 +14,7 @@ Name | Type | Description | Notes
14
14
  ```ruby
15
15
  require 'Phrase'
16
16
 
17
- instance = Phrase::JobTemplateUserPreview.new(id: null,
17
+ instance = Phrase::LocaleUserPreview.new(id: null,
18
18
  username: null,
19
19
  name: null,
20
20
  role: null)
data/docs/LocalesApi.md CHANGED
@@ -235,8 +235,10 @@ project_id = 'project_id_example' # String | Project ID
235
235
  id = 'id_example' # String | ID
236
236
  opts = {
237
237
  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
238
+ 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)
239
+ 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)
238
240
  branch: 'my-feature-branch', # String | specify the branch to use
239
- 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.
241
+ 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.
240
242
  tags: 'feature1,feature2', # String | Limit results to keys tagged with a list of comma separated tag names.
241
243
  tag: 'feature', # String | Limit download to tagged keys. This parameter is deprecated. Please use the \"tags\" parameter instead
242
244
  include_empty_translations: true, # Boolean | Indicates whether keys without translations should be included in the output as well.
@@ -244,7 +246,7 @@ opts = {
244
246
  include_translated_keys: true, # Boolean | Include translated keys in the locale file. Use in combination with include_empty_translations to obtain only untranslated keys.
245
247
  keep_notranslate_tags: true, # Boolean | Indicates whether [NOTRANSLATE] tags should be kept.
246
248
  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.
247
- 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>
249
+ 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>
248
250
  encoding: 'encoding_example', # String | Enforces a specific encoding on the file contents. Valid options are \"UTF-8\", \"UTF-16\" and \"ISO-8859-1\".
249
251
  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>.
250
252
  include_unverified_translations: true, # Boolean | if set to false unverified translations are excluded
@@ -270,8 +272,10 @@ Name | Type | Description | Notes
270
272
  **project_id** | **String**| Project ID |
271
273
  **id** | **String**| ID |
272
274
  **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
275
+ **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]
276
+ **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]
273
277
  **branch** | **String**| specify the branch to use | [optional]
274
- **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]
278
+ **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]
275
279
  **tags** | **String**| Limit results to keys tagged with a list of comma separated tag names. | [optional]
276
280
  **tag** | **String**| Limit download to tagged keys. This parameter is deprecated. Please use the \&quot;tags\&quot; parameter instead | [optional]
277
281
  **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
279
283
  **include_translated_keys** | **Boolean**| Include translated keys in the locale file. Use in combination with include_empty_translations to obtain only untranslated keys. | [optional]
280
284
  **keep_notranslate_tags** | **Boolean**| Indicates whether [NOTRANSLATE] tags should be kept. | [optional]
281
285
  **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]
282
- **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]
286
+ **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]
283
287
  **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]
284
288
  **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]
285
289
  **include_unverified_translations** | **Boolean**| if set to false unverified translations are excluded | [optional]
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
9
9
  **created_at** | **DateTime** | | [optional]
10
10
  **updated_at** | **DateTime** | | [optional]
11
11
  **notifications_count** | **Integer** | | [optional]
12
- **latest_notification** | **Object** | | [optional]
12
+ **latest_notification** | [**Notification**](Notification.md) | | [optional]
13
13
 
14
14
  ## Code Sample
15
15
 
@@ -12,7 +12,7 @@ Method | HTTP request | Description
12
12
 
13
13
  ## notification_groups_list
14
14
 
15
- > Array&lt;Object&gt; notification_groups_list(opts)
15
+ > Array&lt;NotificationGroupDetail&gt; notification_groups_list(opts)
16
16
 
17
17
  List notification groups
18
18
 
@@ -61,7 +61,7 @@ Name | Type | Description | Notes
61
61
 
62
62
  ### Return type
63
63
 
64
- Response<(**Array&lt;Object&gt;**)>
64
+ Response<([**Array&lt;NotificationGroupDetail&gt;**](NotificationGroupDetail.md))>
65
65
 
66
66
  ### Authorization
67
67
 
@@ -75,7 +75,7 @@ Response<(**Array&lt;Object&gt;**)>
75
75
 
76
76
  ## notification_groups_mark_all_as_read
77
77
 
78
- > Array&lt;Object&gt; notification_groups_mark_all_as_read(opts)
78
+ > Array&lt;NotificationGroupDetail&gt; notification_groups_mark_all_as_read(opts)
79
79
 
80
80
  Mark all notification groups as read
81
81
 
@@ -120,7 +120,7 @@ Name | Type | Description | Notes
120
120
 
121
121
  ### Return type
122
122
 
123
- Response<(**Array&lt;Object&gt;**)>
123
+ Response<([**Array&lt;NotificationGroupDetail&gt;**](NotificationGroupDetail.md))>
124
124
 
125
125
  ### Authorization
126
126
 
@@ -12,7 +12,7 @@ Method | HTTP request | Description
12
12
 
13
13
  ## notifications_list
14
14
 
15
- > Array&lt;Object&gt; notifications_list(opts)
15
+ > Array&lt;Notification&gt; notifications_list(opts)
16
16
 
17
17
  List notifications
18
18
 
@@ -63,7 +63,7 @@ Name | Type | Description | Notes
63
63
 
64
64
  ### Return type
65
65
 
66
- Response<(**Array&lt;Object&gt;**)>
66
+ Response<([**Array&lt;Notification&gt;**](Notification.md))>
67
67
 
68
68
  ### Authorization
69
69
 
@@ -77,7 +77,7 @@ Response<(**Array&lt;Object&gt;**)>
77
77
 
78
78
  ## notifications_mark_all_as_read
79
79
 
80
- > Array&lt;Object&gt; notifications_mark_all_as_read(opts)
80
+ > Array&lt;Notification&gt; notifications_mark_all_as_read(opts)
81
81
 
82
82
  Mark all notifications as read
83
83
 
@@ -122,7 +122,7 @@ Name | Type | Description | Notes
122
122
 
123
123
  ### Return type
124
124
 
125
- Response<(**Array&lt;Object&gt;**)>
125
+ Response<([**Array&lt;Notification&gt;**](Notification.md))>
126
126
 
127
127
  ### Authorization
128
128
 
data/docs/Project.md CHANGED
@@ -9,6 +9,7 @@ Name | Type | Description | Notes
9
9
  **slug** | **String** | | [optional]
10
10
  **main_format** | **String** | | [optional]
11
11
  **project_image_url** | **String** | | [optional]
12
+ **media** | **String** | | [optional]
12
13
  **account** | [**Account**](Account.md) | | [optional]
13
14
  **space** | [**Space1**](Space1.md) | | [optional]
14
15
  **point_of_contact** | [**UserPreview**](UserPreview.md) | | [optional]
@@ -25,6 +26,7 @@ instance = Phrase::Project.new(id: null,
25
26
  slug: null,
26
27
  main_format: null,
27
28
  project_image_url: null,
29
+ media: null,
28
30
  account: null,
29
31
  space: null,
30
32
  point_of_contact: null,
@@ -5,11 +5,13 @@
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **name** | **String** | Name of the project | [optional]
8
- **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 &lt;a href&#x3D;\&quot;https://support.phrase.com/hc/en-us/articles/5784070560412\&quot;&gt;Format Guide&lt;/a&gt; or our &lt;a href&#x3D;\&quot;#formats\&quot;&gt;Formats API Endpoint&lt;/a&gt;. | [optional]
8
+ **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 &lt;a href&#x3D;\&quot;https://support.phrase.com/hc/en-us/sections/6111343326364\&quot;&gt;Format Guide&lt;/a&gt; or our &lt;a href&#x3D;\&quot;#formats\&quot;&gt;Formats API Endpoint&lt;/a&gt;. | [optional]
9
+ **media** | **String** | (Optional) Main technology stack used in the project. It affects for example the suggested placeholder style. Predefined values include: &#x60;Ruby&#x60;, &#x60;JavaScript&#x60;, &#x60;AngularJS&#x60;, &#x60;React&#x60;, &#x60;iOS&#x60;, &#x60;Android&#x60;, &#x60;Python&#x60;, &#x60;PHP&#x60;, &#x60;Java&#x60;, &#x60;Go&#x60;, &#x60;Windows Phone&#x60;, &#x60;Rails&#x60;, &#x60;Node.js&#x60;, &#x60;.NET&#x60;, &#x60;Django&#x60;, &#x60;Symfony&#x60;, &#x60;Yii Framework&#x60;, &#x60;Zend Framework&#x60;, &#x60;Apple App Store Description&#x60;, &#x60;Google Play Description&#x60;, but it can also take any other value. | [optional]
9
10
  **shares_translation_memory** | **Boolean** | Indicates whether the project should share the account&#39;s translation memory | [optional]
10
11
  **project_image** | **File** | Image to identify the project | [optional]
11
12
  **remove_project_image** | **Boolean** | Indicates whether the project image should be deleted. | [optional]
12
13
  **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]
14
+ **point_of_contact** | **String** | (Optional) User ID of the point of contact for the project. | [optional]
13
15
  **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]
14
16
  **workflow** | **String** | (Optional) Review Workflow. \&quot;simple\&quot; / \&quot;review\&quot;. &lt;a href&#x3D;\&quot;https://support.phrase.com/hc/en-us/articles/5784094755484\&quot;&gt;Read more&lt;/a&gt; | [optional]
15
17
  **machine_translation_enabled** | **Boolean** | (Optional) Enable machine translation support in the project. Required for Autopilot and Smart Suggest | [optional]
@@ -36,10 +38,12 @@ require 'Phrase'
36
38
 
37
39
  instance = Phrase::ProjectCreateParameters.new(name: My Android Project,
38
40
  main_format: yml,
41
+ media: Python,
39
42
  shares_translation_memory: true,
40
43
  project_image: null,
41
44
  remove_project_image: null,
42
45
  account_id: abcd1234,
46
+ point_of_contact: abcd1234,
43
47
  source_project_id: abcd1234,
44
48
  workflow: review,
45
49
  machine_translation_enabled: true,
@@ -9,6 +9,7 @@ Name | Type | Description | Notes
9
9
  **slug** | **String** | | [optional]
10
10
  **main_format** | **String** | | [optional]
11
11
  **project_image_url** | **String** | | [optional]
12
+ **media** | **String** | | [optional]
12
13
  **account** | [**Account**](Account.md) | | [optional]
13
14
  **space** | [**Space1**](Space1.md) | | [optional]
14
15
  **point_of_contact** | [**UserPreview**](UserPreview.md) | | [optional]
@@ -26,6 +27,7 @@ instance = Phrase::ProjectDetails.new(id: null,
26
27
  slug: null,
27
28
  main_format: null,
28
29
  project_image_url: null,
30
+ media: null,
29
31
  account: null,
30
32
  space: null,
31
33
  point_of_contact: null,
@@ -6,7 +6,9 @@ Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **account_id** | **String** | Required if the requesting user is a member of multiple accounts. Account ID to specify the actual account the project should be created in. | [optional]
8
8
  **name** | **String** | (Optional) Name of the project | [optional]
9
- **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 &lt;a href&#x3D;\&quot;https://support.phrase.com/hc/en-us/articles/5784070560412\&quot;&gt;Format Guide&lt;/a&gt; or our &lt;a href&#x3D;\&quot;#formats\&quot;&gt;Formats API Endpoint&lt;/a&gt;. | [optional]
9
+ **point_of_contact** | **String** | (Optional) User ID of the point of contact for the project. Pass &#x60;null&#x60; to unset. | [optional]
10
+ **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 &lt;a href&#x3D;\&quot;https://support.phrase.com/hc/en-us/sections/6111343326364\&quot;&gt;Format Guide&lt;/a&gt; or our &lt;a href&#x3D;\&quot;#formats\&quot;&gt;Formats API Endpoint&lt;/a&gt;. | [optional]
11
+ **media** | **String** | (Optional) Main technology stack used in the project. It affects for example the suggested placeholder style. Predefined values include: &#x60;Ruby&#x60;, &#x60;JavaScript&#x60;, &#x60;AngularJS&#x60;, &#x60;React&#x60;, &#x60;iOS&#x60;, &#x60;Android&#x60;, &#x60;Python&#x60;, &#x60;PHP&#x60;, &#x60;Java&#x60;, &#x60;Go&#x60;, &#x60;Windows Phone&#x60;, &#x60;Rails&#x60;, &#x60;Node.js&#x60;, &#x60;.NET&#x60;, &#x60;Django&#x60;, &#x60;Symfony&#x60;, &#x60;Yii Framework&#x60;, &#x60;Zend Framework&#x60;, &#x60;Apple App Store Description&#x60;, &#x60;Google Play Description&#x60;, but it can also take any other value. | [optional]
10
12
  **shares_translation_memory** | **Boolean** | (Optional) Indicates whether the project should share the account&#39;s translation memory | [optional]
11
13
  **project_image** | **File** | (Optional) Image to identify the project | [optional]
12
14
  **remove_project_image** | **Boolean** | (Optional) Indicates whether the project image should be deleted. | [optional]
@@ -35,7 +37,9 @@ require 'Phrase'
35
37
 
36
38
  instance = Phrase::ProjectUpdateParameters.new(account_id: abcd1234,
37
39
  name: My Android Project,
40
+ point_of_contact: abcd1234,
38
41
  main_format: yml,
42
+ media: Python,
39
43
  shares_translation_memory: true,
40
44
  project_image: null,
41
45
  remove_project_image: false,
data/docs/SearchApi.md CHANGED
@@ -14,7 +14,7 @@ Method | HTTP request | Description
14
14
 
15
15
  Search across projects
16
16
 
17
- Search for keys and translations in all account projects
17
+ Search for keys and translations in all account projects <br><br><i>Note: Search is limited to 10000 results and may not include recently updated data depending on the project sizes.</i>
18
18
 
19
19
  ### Example
20
20