phrase 2.8.2 → 2.8.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (178) hide show
  1. checksums.yaml +4 -4
  2. data/LICENSE +1 -1
  3. data/README.md +15 -12
  4. data/docs/AccountsApi.md +2 -2
  5. data/docs/AuthorizationsApi.md +2 -2
  6. data/docs/BitbucketSyncApi.md +2 -2
  7. data/docs/BlacklistedKeysApi.md +2 -2
  8. data/docs/BranchesApi.md +5 -5
  9. data/docs/CommentsApi.md +2 -2
  10. data/docs/DistributionsApi.md +2 -2
  11. data/docs/DocumentsApi.md +2 -2
  12. data/docs/GitHubSyncApi.md +2 -2
  13. data/docs/GitLabSyncApi.md +4 -4
  14. data/docs/GlossariesApi.md +2 -2
  15. data/docs/GlossaryTermsApi.md +2 -2
  16. data/docs/InvitationsApi.md +2 -2
  17. data/docs/JobCommentsApi.md +6 -6
  18. data/docs/JobLocale.md +3 -1
  19. data/docs/JobLocaleUpdateParameters.md +5 -1
  20. data/docs/JobLocalesApi.md +2 -2
  21. data/docs/JobLocalesCreateParameters.md +6 -2
  22. data/docs/JobTemplateDetails.md +35 -0
  23. data/docs/JobTemplateDetails1.md +21 -0
  24. data/docs/JobTemplateLocaleUpdateParameters.md +6 -2
  25. data/docs/{JobTemplateLocale.md → JobTemplateLocales.md} +6 -4
  26. data/docs/JobTemplateLocalesApi.md +10 -10
  27. data/docs/JobTemplateLocalesCreateParameters.md +5 -1
  28. data/docs/JobTemplatesApi.md +41 -41
  29. data/docs/JobsApi.md +4 -4
  30. data/docs/KeysApi.md +4 -4
  31. data/docs/KeysSearchParameters.md +1 -1
  32. data/docs/LocaleTeamPreview.md +21 -0
  33. data/docs/{JobTemplateUserPreview.md → LocaleUserPreview.md} +2 -2
  34. data/docs/LocalesApi.md +12 -8
  35. data/docs/MembersApi.md +2 -2
  36. data/docs/NotificationGroupDetail.md +1 -1
  37. data/docs/NotificationGroupsApi.md +6 -6
  38. data/docs/NotificationsApi.md +8 -6
  39. data/docs/OrdersApi.md +2 -2
  40. data/docs/Project.md +2 -0
  41. data/docs/ProjectCreateParameters.md +5 -1
  42. data/docs/ProjectDetails.md +2 -0
  43. data/docs/ProjectUpdateParameters.md +5 -1
  44. data/docs/ProjectsApi.md +2 -2
  45. data/docs/ReleasesApi.md +2 -2
  46. data/docs/ScreenshotMarkersApi.md +2 -2
  47. data/docs/ScreenshotsApi.md +2 -2
  48. data/docs/SearchApi.md +1 -1
  49. data/docs/SpacesApi.md +4 -4
  50. data/docs/StyleGuidesApi.md +2 -2
  51. data/docs/TagsApi.md +2 -2
  52. data/docs/TeamsApi.md +2 -2
  53. data/docs/TranslationsApi.md +31 -27
  54. data/docs/TranslationsExcludeParameters.md +1 -1
  55. data/docs/TranslationsIncludeParameters.md +1 -1
  56. data/docs/TranslationsReviewParameters.md +1 -1
  57. data/docs/TranslationsSearchParameters.md +1 -1
  58. data/docs/TranslationsUnverifyParameters.md +1 -1
  59. data/docs/TranslationsVerifyParameters.md +1 -1
  60. data/docs/UploadsApi.md +5 -5
  61. data/docs/VariablesApi.md +2 -2
  62. data/docs/VersionsHistoryApi.md +2 -2
  63. data/docs/WebhooksApi.md +2 -2
  64. data/lib/phrase/api/accounts_api.rb +2 -2
  65. data/lib/phrase/api/authorizations_api.rb +2 -2
  66. data/lib/phrase/api/bitbucket_sync_api.rb +4 -4
  67. data/lib/phrase/api/blacklisted_keys_api.rb +2 -2
  68. data/lib/phrase/api/branches_api.rb +8 -8
  69. data/lib/phrase/api/comments_api.rb +2 -2
  70. data/lib/phrase/api/distributions_api.rb +2 -2
  71. data/lib/phrase/api/documents_api.rb +2 -2
  72. data/lib/phrase/api/git_hub_sync_api.rb +4 -4
  73. data/lib/phrase/api/git_lab_sync_api.rb +6 -6
  74. data/lib/phrase/api/glossaries_api.rb +2 -2
  75. data/lib/phrase/api/glossary_terms_api.rb +2 -2
  76. data/lib/phrase/api/invitations_api.rb +2 -2
  77. data/lib/phrase/api/job_comments_api.rb +9 -9
  78. data/lib/phrase/api/job_locales_api.rb +2 -2
  79. data/lib/phrase/api/job_template_locales_api.rb +14 -14
  80. data/lib/phrase/api/job_templates_api.rb +72 -72
  81. data/lib/phrase/api/jobs_api.rb +4 -4
  82. data/lib/phrase/api/keys_api.rb +4 -4
  83. data/lib/phrase/api/locales_api.rb +14 -8
  84. data/lib/phrase/api/members_api.rb +2 -2
  85. data/lib/phrase/api/notification_groups_api.rb +8 -8
  86. data/lib/phrase/api/notifications_api.rb +11 -8
  87. data/lib/phrase/api/orders_api.rb +2 -2
  88. data/lib/phrase/api/projects_api.rb +2 -2
  89. data/lib/phrase/api/releases_api.rb +2 -2
  90. data/lib/phrase/api/screenshot_markers_api.rb +2 -2
  91. data/lib/phrase/api/screenshots_api.rb +2 -2
  92. data/lib/phrase/api/search_api.rb +2 -2
  93. data/lib/phrase/api/spaces_api.rb +4 -4
  94. data/lib/phrase/api/style_guides_api.rb +2 -2
  95. data/lib/phrase/api/tags_api.rb +2 -2
  96. data/lib/phrase/api/teams_api.rb +2 -2
  97. data/lib/phrase/api/translations_api.rb +28 -22
  98. data/lib/phrase/api/uploads_api.rb +4 -4
  99. data/lib/phrase/api/variables_api.rb +2 -2
  100. data/lib/phrase/api/versions_history_api.rb +2 -2
  101. data/lib/phrase/api/webhooks_api.rb +2 -2
  102. data/lib/phrase/models/job_locale.rb +13 -2
  103. data/lib/phrase/models/job_locale_update_parameters.rb +28 -4
  104. data/lib/phrase/models/job_locales_create_parameters.rb +33 -4
  105. data/lib/phrase/models/job_template_details.rb +285 -0
  106. data/lib/phrase/models/job_template_details1.rb +214 -0
  107. data/lib/phrase/models/job_template_locale_update_parameters.rb +28 -9
  108. data/lib/phrase/models/{job_template_locale.rb → job_template_locales.rb} +18 -7
  109. data/lib/phrase/models/job_template_locales_create_parameters.rb +28 -4
  110. data/lib/phrase/models/keys_search_parameters.rb +1 -1
  111. data/lib/phrase/models/locale_team_preview.rb +212 -0
  112. data/lib/phrase/models/{job_template_user_preview.rb → locale_user_preview.rb} +3 -3
  113. data/lib/phrase/models/notification_group_detail.rb +1 -1
  114. data/lib/phrase/models/project.rb +10 -1
  115. data/lib/phrase/models/project_create_parameters.rb +22 -2
  116. data/lib/phrase/models/project_details.rb +10 -1
  117. data/lib/phrase/models/project_update_parameters.rb +22 -2
  118. data/lib/phrase/models/translations_exclude_parameters.rb +1 -1
  119. data/lib/phrase/models/translations_include_parameters.rb +1 -1
  120. data/lib/phrase/models/translations_review_parameters.rb +1 -1
  121. data/lib/phrase/models/translations_search_parameters.rb +1 -1
  122. data/lib/phrase/models/translations_unverify_parameters.rb +1 -1
  123. data/lib/phrase/models/translations_verify_parameters.rb +1 -1
  124. data/lib/phrase/version.rb +1 -1
  125. data/lib/phrase.rb +5 -2
  126. data/spec/api/accounts_api_spec.rb +1 -1
  127. data/spec/api/authorizations_api_spec.rb +1 -1
  128. data/spec/api/bitbucket_sync_api_spec.rb +2 -2
  129. data/spec/api/blacklisted_keys_api_spec.rb +1 -1
  130. data/spec/api/branches_api_spec.rb +4 -4
  131. data/spec/api/comments_api_spec.rb +1 -1
  132. data/spec/api/distributions_api_spec.rb +1 -1
  133. data/spec/api/documents_api_spec.rb +1 -1
  134. data/spec/api/git_hub_sync_api_spec.rb +2 -2
  135. data/spec/api/git_lab_sync_api_spec.rb +3 -3
  136. data/spec/api/glossaries_api_spec.rb +1 -1
  137. data/spec/api/glossary_terms_api_spec.rb +1 -1
  138. data/spec/api/invitations_api_spec.rb +1 -1
  139. data/spec/api/job_comments_api_spec.rb +3 -3
  140. data/spec/api/job_locales_api_spec.rb +1 -1
  141. data/spec/api/job_template_locales_api_spec.rb +5 -5
  142. data/spec/api/job_templates_api_spec.rb +18 -18
  143. data/spec/api/jobs_api_spec.rb +2 -2
  144. data/spec/api/keys_api_spec.rb +2 -2
  145. data/spec/api/locales_api_spec.rb +6 -4
  146. data/spec/api/members_api_spec.rb +1 -1
  147. data/spec/api/notification_groups_api_spec.rb +3 -3
  148. data/spec/api/notifications_api_spec.rb +4 -3
  149. data/spec/api/orders_api_spec.rb +1 -1
  150. data/spec/api/projects_api_spec.rb +1 -1
  151. data/spec/api/releases_api_spec.rb +1 -1
  152. data/spec/api/screenshot_markers_api_spec.rb +1 -1
  153. data/spec/api/screenshots_api_spec.rb +1 -1
  154. data/spec/api/search_api_spec.rb +1 -1
  155. data/spec/api/spaces_api_spec.rb +2 -2
  156. data/spec/api/style_guides_api_spec.rb +1 -1
  157. data/spec/api/tags_api_spec.rb +1 -1
  158. data/spec/api/teams_api_spec.rb +1 -1
  159. data/spec/api/translations_api_spec.rb +13 -11
  160. data/spec/api/uploads_api_spec.rb +2 -2
  161. data/spec/api/variables_api_spec.rb +1 -1
  162. data/spec/api/versions_history_api_spec.rb +1 -1
  163. data/spec/api/webhooks_api_spec.rb +1 -1
  164. data/spec/models/job_locale_spec.rb +6 -0
  165. data/spec/models/job_locale_update_parameters_spec.rb +12 -0
  166. data/spec/models/job_locales_create_parameters_spec.rb +12 -0
  167. data/spec/models/job_template_details1_spec.rb +41 -0
  168. data/spec/models/job_template_details_spec.rb +83 -0
  169. data/spec/models/job_template_locale_update_parameters_spec.rb +12 -0
  170. data/spec/models/job_template_locales_create_parameters_spec.rb +12 -0
  171. data/spec/models/{job_template_locale_spec.rb → job_template_locales_spec.rb} +12 -6
  172. data/spec/models/locale_team_preview_spec.rb +41 -0
  173. data/spec/models/{job_template_user_preview_spec.rb → locale_user_preview_spec.rb} +6 -6
  174. data/spec/models/project_create_parameters_spec.rb +12 -0
  175. data/spec/models/project_details_spec.rb +6 -0
  176. data/spec/models/project_spec.rb +6 -0
  177. data/spec/models/project_update_parameters_spec.rb +12 -0
  178. metadata +237 -225
@@ -94,7 +94,7 @@ module Phrase
94
94
  # @param [Hash] opts the optional parameters
95
95
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
96
96
  # @option opts [String] :branch specify the branch to use
97
- # @return [Object]
97
+ # @return [JobTemplateLocales]
98
98
  def job_template_locale_show(project_id, job_template_id, job_template_locale_id, opts = {})
99
99
  data, _status_code, _headers = job_template_locale_show_with_http_info(project_id, job_template_id, job_template_locale_id, opts)
100
100
  data
@@ -108,7 +108,7 @@ module Phrase
108
108
  # @param [Hash] opts the optional parameters
109
109
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
110
110
  # @option opts [String] :branch specify the branch to use
111
- # @return [Array<(Response<(Object)>, Integer, Hash)>] Response<(Object)> data, response status code and response headers
111
+ # @return [Array<(Response<(JobTemplateLocales)>, Integer, Hash)>] Response<(JobTemplateLocales)> data, response status code and response headers
112
112
  def job_template_locale_show_with_http_info(project_id, job_template_id, job_template_locale_id, opts = {})
113
113
  if @api_client.config.debugging
114
114
  @api_client.config.logger.debug 'Calling API: JobTemplateLocalesApi.job_template_locale_show ...'
@@ -145,7 +145,7 @@ module Phrase
145
145
  post_body = opts[:body]
146
146
 
147
147
  # return_type
148
- return_type = opts[:return_type] || 'Object'
148
+ return_type = opts[:return_type] || 'JobTemplateLocales'
149
149
 
150
150
  # auth_names
151
151
  auth_names = opts[:auth_names] || ['Basic', 'Token']
@@ -175,7 +175,7 @@ module Phrase
175
175
  # @param job_template_locale_update_parameters [JobTemplateLocaleUpdateParameters]
176
176
  # @param [Hash] opts the optional parameters
177
177
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
178
- # @return [Object]
178
+ # @return [JobTemplateLocales]
179
179
  def job_template_locale_update(project_id, job_template_id, job_template_locale_id, job_template_locale_update_parameters, opts = {})
180
180
  data, _status_code, _headers = job_template_locale_update_with_http_info(project_id, job_template_id, job_template_locale_id, job_template_locale_update_parameters, opts)
181
181
  data
@@ -189,7 +189,7 @@ module Phrase
189
189
  # @param job_template_locale_update_parameters [JobTemplateLocaleUpdateParameters]
190
190
  # @param [Hash] opts the optional parameters
191
191
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
192
- # @return [Array<(Response<(Object)>, Integer, Hash)>] Response<(Object)> data, response status code and response headers
192
+ # @return [Array<(Response<(JobTemplateLocales)>, Integer, Hash)>] Response<(JobTemplateLocales)> data, response status code and response headers
193
193
  def job_template_locale_update_with_http_info(project_id, job_template_id, job_template_locale_id, job_template_locale_update_parameters, opts = {})
194
194
  if @api_client.config.debugging
195
195
  @api_client.config.logger.debug 'Calling API: JobTemplateLocalesApi.job_template_locale_update ...'
@@ -231,7 +231,7 @@ module Phrase
231
231
  post_body = opts[:body] || @api_client.object_to_http_body(job_template_locale_update_parameters)
232
232
 
233
233
  # return_type
234
- return_type = opts[:return_type] || 'Object'
234
+ return_type = opts[:return_type] || 'JobTemplateLocales'
235
235
 
236
236
  # auth_names
237
237
  auth_names = opts[:auth_names] || ['Basic', 'Token']
@@ -260,7 +260,7 @@ module Phrase
260
260
  # @param job_template_locales_create_parameters [JobTemplateLocalesCreateParameters]
261
261
  # @param [Hash] opts the optional parameters
262
262
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
263
- # @return [JobTemplateLocale]
263
+ # @return [JobTemplateLocales]
264
264
  def job_template_locales_create(project_id, job_template_id, job_template_locales_create_parameters, opts = {})
265
265
  data, _status_code, _headers = job_template_locales_create_with_http_info(project_id, job_template_id, job_template_locales_create_parameters, opts)
266
266
  data
@@ -273,7 +273,7 @@ module Phrase
273
273
  # @param job_template_locales_create_parameters [JobTemplateLocalesCreateParameters]
274
274
  # @param [Hash] opts the optional parameters
275
275
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
276
- # @return [Array<(Response<(JobTemplateLocale)>, Integer, Hash)>] Response<(JobTemplateLocale)> data, response status code and response headers
276
+ # @return [Array<(Response<(JobTemplateLocales)>, Integer, Hash)>] Response<(JobTemplateLocales)> data, response status code and response headers
277
277
  def job_template_locales_create_with_http_info(project_id, job_template_id, job_template_locales_create_parameters, opts = {})
278
278
  if @api_client.config.debugging
279
279
  @api_client.config.logger.debug 'Calling API: JobTemplateLocalesApi.job_template_locales_create ...'
@@ -311,7 +311,7 @@ module Phrase
311
311
  post_body = opts[:body] || @api_client.object_to_http_body(job_template_locales_create_parameters)
312
312
 
313
313
  # return_type
314
- return_type = opts[:return_type] || 'JobTemplateLocale'
314
+ return_type = opts[:return_type] || 'JobTemplateLocales'
315
315
 
316
316
  # auth_names
317
317
  auth_names = opts[:auth_names] || ['Basic', 'Token']
@@ -340,9 +340,9 @@ module Phrase
340
340
  # @param [Hash] opts the optional parameters
341
341
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
342
342
  # @option opts [Integer] :page Page number
343
- # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 25 by default
343
+ # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
344
344
  # @option opts [String] :branch specify the branch to use
345
- # @return [Array<Object>]
345
+ # @return [Array<JobTemplateLocales>]
346
346
  def job_template_locales_list(project_id, job_template_id, opts = {})
347
347
  data, _status_code, _headers = job_template_locales_list_with_http_info(project_id, job_template_id, opts)
348
348
  data
@@ -355,9 +355,9 @@ module Phrase
355
355
  # @param [Hash] opts the optional parameters
356
356
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
357
357
  # @option opts [Integer] :page Page number
358
- # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 25 by default
358
+ # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
359
359
  # @option opts [String] :branch specify the branch to use
360
- # @return [Array<(Response<(Array<Object>)>, Integer, Hash)>] Response<(Array<Object>)> data, response status code and response headers
360
+ # @return [Array<(Response<(Array<JobTemplateLocales>)>, Integer, Hash)>] Response<(Array<JobTemplateLocales>)> data, response status code and response headers
361
361
  def job_template_locales_list_with_http_info(project_id, job_template_id, opts = {})
362
362
  if @api_client.config.debugging
363
363
  @api_client.config.logger.debug 'Calling API: JobTemplateLocalesApi.job_template_locales_list ...'
@@ -392,7 +392,7 @@ module Phrase
392
392
  post_body = opts[:body]
393
393
 
394
394
  # return_type
395
- return_type = opts[:return_type] || 'Array<Object>'
395
+ return_type = opts[:return_type] || 'Array<JobTemplateLocales>'
396
396
 
397
397
  # auth_names
398
398
  auth_names = opts[:auth_names] || ['Basic', 'Token']
@@ -13,7 +13,7 @@ module Phrase
13
13
  # @param job_template_create_parameters [JobTemplateCreateParameters]
14
14
  # @param [Hash] opts the optional parameters
15
15
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
16
- # @return [Object]
16
+ # @return [JobTemplateDetails]
17
17
  def job_template_create(project_id, job_template_create_parameters, opts = {})
18
18
  data, _status_code, _headers = job_template_create_with_http_info(project_id, job_template_create_parameters, opts)
19
19
  data
@@ -25,7 +25,7 @@ module Phrase
25
25
  # @param job_template_create_parameters [JobTemplateCreateParameters]
26
26
  # @param [Hash] opts the optional parameters
27
27
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
28
- # @return [Array<(Response<(Object)>, Integer, Hash)>] Response<(Object)> data, response status code and response headers
28
+ # @return [Array<(Response<(JobTemplateDetails)>, Integer, Hash)>] Response<(JobTemplateDetails)> data, response status code and response headers
29
29
  def job_template_create_with_http_info(project_id, job_template_create_parameters, opts = {})
30
30
  if @api_client.config.debugging
31
31
  @api_client.config.logger.debug 'Calling API: JobTemplatesApi.job_template_create ...'
@@ -59,7 +59,7 @@ module Phrase
59
59
  post_body = opts[:body] || @api_client.object_to_http_body(job_template_create_parameters)
60
60
 
61
61
  # return_type
62
- return_type = opts[:return_type] || 'Object'
62
+ return_type = opts[:return_type] || 'JobTemplateDetails'
63
63
 
64
64
  # auth_names
65
65
  auth_names = opts[:auth_names] || ['Basic', 'Token']
@@ -154,60 +154,65 @@ module Phrase
154
154
  return response, status_code, headers
155
155
  end
156
156
 
157
- # Get a single job template
158
- # Get details on a single job template for a given project.
157
+ # Update a job template
158
+ # Update an existing job template.
159
159
  # @param project_id [String] Project ID
160
160
  # @param id [String] ID
161
+ # @param job_template_update_parameters [JobTemplateUpdateParameters]
161
162
  # @param [Hash] opts the optional parameters
162
163
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
163
- # @option opts [String] :branch specify the branch to use
164
- # @return [Object]
165
- def job_template_show(project_id, id, opts = {})
166
- data, _status_code, _headers = job_template_show_with_http_info(project_id, id, opts)
164
+ # @return [JobTemplateDetails]
165
+ def job_template_update(project_id, id, job_template_update_parameters, opts = {})
166
+ data, _status_code, _headers = job_template_update_with_http_info(project_id, id, job_template_update_parameters, opts)
167
167
  data
168
168
  end
169
169
 
170
- # Get a single job template
171
- # Get details on a single job template for a given project.
170
+ # Update a job template
171
+ # Update an existing job template.
172
172
  # @param project_id [String] Project ID
173
173
  # @param id [String] ID
174
+ # @param job_template_update_parameters [JobTemplateUpdateParameters]
174
175
  # @param [Hash] opts the optional parameters
175
176
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
176
- # @option opts [String] :branch specify the branch to use
177
- # @return [Array<(Response<(Object)>, Integer, Hash)>] Response<(Object)> data, response status code and response headers
178
- def job_template_show_with_http_info(project_id, id, opts = {})
177
+ # @return [Array<(Response<(JobTemplateDetails)>, Integer, Hash)>] Response<(JobTemplateDetails)> data, response status code and response headers
178
+ def job_template_update_with_http_info(project_id, id, job_template_update_parameters, opts = {})
179
179
  if @api_client.config.debugging
180
- @api_client.config.logger.debug 'Calling API: JobTemplatesApi.job_template_show ...'
180
+ @api_client.config.logger.debug 'Calling API: JobTemplatesApi.job_template_update ...'
181
181
  end
182
182
  # verify the required parameter 'project_id' is set
183
183
  if @api_client.config.client_side_validation && project_id.nil?
184
- fail ArgumentError, "Missing the required parameter 'project_id' when calling JobTemplatesApi.job_template_show"
184
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling JobTemplatesApi.job_template_update"
185
185
  end
186
186
  # verify the required parameter 'id' is set
187
187
  if @api_client.config.client_side_validation && id.nil?
188
- fail ArgumentError, "Missing the required parameter 'id' when calling JobTemplatesApi.job_template_show"
188
+ fail ArgumentError, "Missing the required parameter 'id' when calling JobTemplatesApi.job_template_update"
189
+ end
190
+ # verify the required parameter 'job_template_update_parameters' is set
191
+ if @api_client.config.client_side_validation && job_template_update_parameters.nil?
192
+ fail ArgumentError, "Missing the required parameter 'job_template_update_parameters' when calling JobTemplatesApi.job_template_update"
189
193
  end
190
194
  # resource path
191
195
  local_var_path = '/projects/{project_id}/job_templates/{id}'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
192
196
 
193
197
  # query parameters
194
198
  query_params = opts[:query_params] || {}
195
- query_params[:'branch'] = opts[:'branch'] if !opts[:'branch'].nil?
196
199
 
197
200
  # header parameters
198
201
  header_params = opts[:header_params] || {}
199
202
  # HTTP header 'Accept' (if needed)
200
203
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
204
+ # HTTP header 'Content-Type'
205
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
201
206
  header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
202
207
 
203
208
  # form parameters
204
209
  form_params = opts[:form_params] || {}
205
210
 
206
211
  # http body (model)
207
- post_body = opts[:body]
212
+ post_body = opts[:body] || @api_client.object_to_http_body(job_template_update_parameters)
208
213
 
209
214
  # return_type
210
- return_type = opts[:return_type] || 'Object'
215
+ return_type = opts[:return_type] || 'JobTemplateDetails'
211
216
 
212
217
  # auth_names
213
218
  auth_names = opts[:auth_names] || ['Basic', 'Token']
@@ -221,73 +226,68 @@ module Phrase
221
226
  :return_type => return_type
222
227
  )
223
228
 
224
- data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
229
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
225
230
  if @api_client.config.debugging
226
- @api_client.config.logger.debug "API called: JobTemplatesApi#job_template_show\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
231
+ @api_client.config.logger.debug "API called: JobTemplatesApi#job_template_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
227
232
  end
228
233
  response = ::Phrase::Response.new(data, headers)
229
234
  return response, status_code, headers
230
235
  end
231
236
 
232
- # Update a job template
233
- # Update an existing job template.
237
+ # List job templates
238
+ # List all job templates for the given project.
234
239
  # @param project_id [String] Project ID
235
- # @param id [String] ID
236
- # @param job_template_update_parameters [JobTemplateUpdateParameters]
237
240
  # @param [Hash] opts the optional parameters
238
241
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
239
- # @return [Object]
240
- def job_template_update(project_id, id, job_template_update_parameters, opts = {})
241
- data, _status_code, _headers = job_template_update_with_http_info(project_id, id, job_template_update_parameters, opts)
242
+ # @option opts [Integer] :page Page number
243
+ # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
244
+ # @option opts [String] :branch specify the branch to use
245
+ # @return [Array<JobTemplate>]
246
+ def job_templates_list(project_id, opts = {})
247
+ data, _status_code, _headers = job_templates_list_with_http_info(project_id, opts)
242
248
  data
243
249
  end
244
250
 
245
- # Update a job template
246
- # Update an existing job template.
251
+ # List job templates
252
+ # List all job templates for the given project.
247
253
  # @param project_id [String] Project ID
248
- # @param id [String] ID
249
- # @param job_template_update_parameters [JobTemplateUpdateParameters]
250
254
  # @param [Hash] opts the optional parameters
251
255
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
252
- # @return [Array<(Response<(Object)>, Integer, Hash)>] Response<(Object)> data, response status code and response headers
253
- def job_template_update_with_http_info(project_id, id, job_template_update_parameters, opts = {})
256
+ # @option opts [Integer] :page Page number
257
+ # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
258
+ # @option opts [String] :branch specify the branch to use
259
+ # @return [Array<(Response<(Array<JobTemplate>)>, Integer, Hash)>] Response<(Array<JobTemplate>)> data, response status code and response headers
260
+ def job_templates_list_with_http_info(project_id, opts = {})
254
261
  if @api_client.config.debugging
255
- @api_client.config.logger.debug 'Calling API: JobTemplatesApi.job_template_update ...'
262
+ @api_client.config.logger.debug 'Calling API: JobTemplatesApi.job_templates_list ...'
256
263
  end
257
264
  # verify the required parameter 'project_id' is set
258
265
  if @api_client.config.client_side_validation && project_id.nil?
259
- fail ArgumentError, "Missing the required parameter 'project_id' when calling JobTemplatesApi.job_template_update"
260
- end
261
- # verify the required parameter 'id' is set
262
- if @api_client.config.client_side_validation && id.nil?
263
- fail ArgumentError, "Missing the required parameter 'id' when calling JobTemplatesApi.job_template_update"
264
- end
265
- # verify the required parameter 'job_template_update_parameters' is set
266
- if @api_client.config.client_side_validation && job_template_update_parameters.nil?
267
- fail ArgumentError, "Missing the required parameter 'job_template_update_parameters' when calling JobTemplatesApi.job_template_update"
266
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling JobTemplatesApi.job_templates_list"
268
267
  end
269
268
  # resource path
270
- local_var_path = '/projects/{project_id}/job_templates/{id}'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
269
+ local_var_path = '/projects/{project_id}/job_templates'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s))
271
270
 
272
271
  # query parameters
273
272
  query_params = opts[:query_params] || {}
273
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
274
+ query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
275
+ query_params[:'branch'] = opts[:'branch'] if !opts[:'branch'].nil?
274
276
 
275
277
  # header parameters
276
278
  header_params = opts[:header_params] || {}
277
279
  # HTTP header 'Accept' (if needed)
278
280
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
279
- # HTTP header 'Content-Type'
280
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
281
281
  header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
282
282
 
283
283
  # form parameters
284
284
  form_params = opts[:form_params] || {}
285
285
 
286
286
  # http body (model)
287
- post_body = opts[:body] || @api_client.object_to_http_body(job_template_update_parameters)
287
+ post_body = opts[:body]
288
288
 
289
289
  # return_type
290
- return_type = opts[:return_type] || 'Object'
290
+ return_type = opts[:return_type] || 'Array<JobTemplate>'
291
291
 
292
292
  # auth_names
293
293
  auth_names = opts[:auth_names] || ['Basic', 'Token']
@@ -301,52 +301,52 @@ module Phrase
301
301
  :return_type => return_type
302
302
  )
303
303
 
304
- data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
304
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
305
305
  if @api_client.config.debugging
306
- @api_client.config.logger.debug "API called: JobTemplatesApi#job_template_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
306
+ @api_client.config.logger.debug "API called: JobTemplatesApi#job_templates_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
307
307
  end
308
308
  response = ::Phrase::Response.new(data, headers)
309
309
  return response, status_code, headers
310
310
  end
311
311
 
312
- # List job templates
313
- # List all job templates for the given project.
312
+ # Get a single job template
313
+ # Get details on a single job template for a given project.
314
314
  # @param project_id [String] Project ID
315
+ # @param id [String] ID
315
316
  # @param [Hash] opts the optional parameters
316
317
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
317
- # @option opts [Integer] :page Page number
318
- # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 25 by default
319
318
  # @option opts [String] :branch specify the branch to use
320
- # @return [Array<JobTemplate>]
321
- def job_templates_list(project_id, opts = {})
322
- data, _status_code, _headers = job_templates_list_with_http_info(project_id, opts)
319
+ # @return [JobTemplateDetails]
320
+ def job_templates_show(project_id, id, opts = {})
321
+ data, _status_code, _headers = job_templates_show_with_http_info(project_id, id, opts)
323
322
  data
324
323
  end
325
324
 
326
- # List job templates
327
- # List all job templates for the given project.
325
+ # Get a single job template
326
+ # Get details on a single job template for a given project.
328
327
  # @param project_id [String] Project ID
328
+ # @param id [String] ID
329
329
  # @param [Hash] opts the optional parameters
330
330
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
331
- # @option opts [Integer] :page Page number
332
- # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 25 by default
333
331
  # @option opts [String] :branch specify the branch to use
334
- # @return [Array<(Response<(Array<JobTemplate>)>, Integer, Hash)>] Response<(Array<JobTemplate>)> data, response status code and response headers
335
- def job_templates_list_with_http_info(project_id, opts = {})
332
+ # @return [Array<(Response<(JobTemplateDetails)>, Integer, Hash)>] Response<(JobTemplateDetails)> data, response status code and response headers
333
+ def job_templates_show_with_http_info(project_id, id, opts = {})
336
334
  if @api_client.config.debugging
337
- @api_client.config.logger.debug 'Calling API: JobTemplatesApi.job_templates_list ...'
335
+ @api_client.config.logger.debug 'Calling API: JobTemplatesApi.job_templates_show ...'
338
336
  end
339
337
  # verify the required parameter 'project_id' is set
340
338
  if @api_client.config.client_side_validation && project_id.nil?
341
- fail ArgumentError, "Missing the required parameter 'project_id' when calling JobTemplatesApi.job_templates_list"
339
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling JobTemplatesApi.job_templates_show"
340
+ end
341
+ # verify the required parameter 'id' is set
342
+ if @api_client.config.client_side_validation && id.nil?
343
+ fail ArgumentError, "Missing the required parameter 'id' when calling JobTemplatesApi.job_templates_show"
342
344
  end
343
345
  # resource path
344
- local_var_path = '/projects/{project_id}/job_templates'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s))
346
+ local_var_path = '/projects/{project_id}/job_templates/{id}'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
345
347
 
346
348
  # query parameters
347
349
  query_params = opts[:query_params] || {}
348
- query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
349
- query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
350
350
  query_params[:'branch'] = opts[:'branch'] if !opts[:'branch'].nil?
351
351
 
352
352
  # header parameters
@@ -362,7 +362,7 @@ module Phrase
362
362
  post_body = opts[:body]
363
363
 
364
364
  # return_type
365
- return_type = opts[:return_type] || 'Array<JobTemplate>'
365
+ return_type = opts[:return_type] || 'JobTemplateDetails'
366
366
 
367
367
  # auth_names
368
368
  auth_names = opts[:auth_names] || ['Basic', 'Token']
@@ -378,7 +378,7 @@ module Phrase
378
378
 
379
379
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
380
380
  if @api_client.config.debugging
381
- @api_client.config.logger.debug "API called: JobTemplatesApi#job_templates_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
381
+ @api_client.config.logger.debug "API called: JobTemplatesApi#job_templates_show\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
382
382
  end
383
383
  response = ::Phrase::Response.new(data, headers)
384
384
  return response, status_code, headers
@@ -857,7 +857,7 @@ module Phrase
857
857
  # @param [Hash] opts the optional parameters
858
858
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
859
859
  # @option opts [Integer] :page Page number
860
- # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 25 by default
860
+ # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
861
861
  # @option opts [String] :owned_by filter by user owning job
862
862
  # @option opts [String] :assigned_to filter by user assigned to job
863
863
  # @option opts [String] :state filter by state of job Valid states are &lt;code&gt;draft&lt;/code&gt;, &lt;code&gt;in_progress&lt;/code&gt;, &lt;code&gt;completed&lt;/code&gt;
@@ -873,7 +873,7 @@ module Phrase
873
873
  # @param [Hash] opts the optional parameters
874
874
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
875
875
  # @option opts [Integer] :page Page number
876
- # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 25 by default
876
+ # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
877
877
  # @option opts [String] :owned_by filter by user owning job
878
878
  # @option opts [String] :assigned_to filter by user assigned to job
879
879
  # @option opts [String] :state filter by state of job Valid states are &lt;code&gt;draft&lt;/code&gt;, &lt;code&gt;in_progress&lt;/code&gt;, &lt;code&gt;completed&lt;/code&gt;
@@ -938,7 +938,7 @@ module Phrase
938
938
  # @param [Hash] opts the optional parameters
939
939
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
940
940
  # @option opts [Integer] :page Page number
941
- # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 25 by default
941
+ # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
942
942
  # @option opts [String] :branch specify the branch to use
943
943
  # @option opts [String] :owned_by filter by user owning job
944
944
  # @option opts [String] :assigned_to filter by user assigned to job
@@ -955,7 +955,7 @@ module Phrase
955
955
  # @param [Hash] opts the optional parameters
956
956
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
957
957
  # @option opts [Integer] :page Page number
958
- # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 25 by default
958
+ # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
959
959
  # @option opts [String] :branch specify the branch to use
960
960
  # @option opts [String] :owned_by filter by user owning job
961
961
  # @option opts [String] :assigned_to filter by user assigned to job
@@ -538,7 +538,7 @@ module Phrase
538
538
  # @param [Hash] opts the optional parameters
539
539
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
540
540
  # @option opts [Integer] :page Page number
541
- # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 25 by default
541
+ # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
542
542
  # @option opts [String] :branch specify the branch to use
543
543
  # @option opts [String] :sort Sort by field. Can be one of: name, created_at, updated_at.
544
544
  # @option opts [String] :order Order direction. Can be one of: asc, desc.
@@ -556,7 +556,7 @@ module Phrase
556
556
  # @param [Hash] opts the optional parameters
557
557
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
558
558
  # @option opts [Integer] :page Page number
559
- # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 25 by default
559
+ # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
560
560
  # @option opts [String] :branch specify the branch to use
561
561
  # @option opts [String] :sort Sort by field. Can be one of: name, created_at, updated_at.
562
562
  # @option opts [String] :order Order direction. Can be one of: asc, desc.
@@ -626,7 +626,7 @@ module Phrase
626
626
  # @param [Hash] opts the optional parameters
627
627
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
628
628
  # @option opts [Integer] :page Page number
629
- # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 25 by default
629
+ # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
630
630
  # @return [Array<TranslationKey>]
631
631
  def keys_search(project_id, keys_search_parameters, opts = {})
632
632
  data, _status_code, _headers = keys_search_with_http_info(project_id, keys_search_parameters, opts)
@@ -640,7 +640,7 @@ module Phrase
640
640
  # @param [Hash] opts the optional parameters
641
641
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
642
642
  # @option opts [Integer] :page Page number
643
- # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 25 by default
643
+ # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
644
644
  # @return [Array<(Response<(Array<TranslationKey>)>, Integer, Hash)>] Response<(Array<TranslationKey>)> data, response status code and response headers
645
645
  def keys_search_with_http_info(project_id, keys_search_parameters, opts = {})
646
646
  if @api_client.config.debugging
@@ -13,7 +13,7 @@ module Phrase
13
13
  # @param [Hash] opts the optional parameters
14
14
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
15
15
  # @option opts [Integer] :page Page number
16
- # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 25 by default
16
+ # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
17
17
  # @return [Array<LocalePreview1>]
18
18
  def account_locales(id, opts = {})
19
19
  data, _status_code, _headers = account_locales_with_http_info(id, opts)
@@ -26,7 +26,7 @@ module Phrase
26
26
  # @param [Hash] opts the optional parameters
27
27
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
28
28
  # @option opts [Integer] :page Page number
29
- # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 25 by default
29
+ # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
30
30
  # @return [Array<(Response<(Array<LocalePreview1>)>, Integer, Hash)>] Response<(Array<LocalePreview1>)> data, response status code and response headers
31
31
  def account_locales_with_http_info(id, opts = {})
32
32
  if @api_client.config.debugging
@@ -232,8 +232,10 @@ module Phrase
232
232
  # @param id [String] ID
233
233
  # @param [Hash] opts the optional parameters
234
234
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
235
+ # @option opts [String] :if_modified_since 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)
236
+ # @option opts [String] :if_none_match 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)
235
237
  # @option opts [String] :branch specify the branch to use
236
- # @option opts [String] :file_format 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.
238
+ # @option opts [String] :file_format 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.
237
239
  # @option opts [String] :tags Limit results to keys tagged with a list of comma separated tag names.
238
240
  # @option opts [String] :tag Limit download to tagged keys. This parameter is deprecated. Please use the \&quot;tags\&quot; parameter instead
239
241
  # @option opts [Boolean] :include_empty_translations Indicates whether keys without translations should be included in the output as well.
@@ -241,7 +243,7 @@ module Phrase
241
243
  # @option opts [Boolean] :include_translated_keys Include translated keys in the locale file. Use in combination with include_empty_translations to obtain only untranslated keys.
242
244
  # @option opts [Boolean] :keep_notranslate_tags Indicates whether [NOTRANSLATE] tags should be kept.
243
245
  # @option opts [Boolean] :convert_emoji 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.
244
- # @option opts [Object] :format_options 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;
246
+ # @option opts [Object] :format_options 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;
245
247
  # @option opts [String] :encoding 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;.
246
248
  # @option opts [Boolean] :skip_unverified_translations 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;.
247
249
  # @option opts [Boolean] :include_unverified_translations if set to false unverified translations are excluded
@@ -260,8 +262,10 @@ module Phrase
260
262
  # @param id [String] ID
261
263
  # @param [Hash] opts the optional parameters
262
264
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
265
+ # @option opts [String] :if_modified_since 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)
266
+ # @option opts [String] :if_none_match 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)
263
267
  # @option opts [String] :branch specify the branch to use
264
- # @option opts [String] :file_format 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.
268
+ # @option opts [String] :file_format 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.
265
269
  # @option opts [String] :tags Limit results to keys tagged with a list of comma separated tag names.
266
270
  # @option opts [String] :tag Limit download to tagged keys. This parameter is deprecated. Please use the \&quot;tags\&quot; parameter instead
267
271
  # @option opts [Boolean] :include_empty_translations Indicates whether keys without translations should be included in the output as well.
@@ -269,7 +273,7 @@ module Phrase
269
273
  # @option opts [Boolean] :include_translated_keys Include translated keys in the locale file. Use in combination with include_empty_translations to obtain only untranslated keys.
270
274
  # @option opts [Boolean] :keep_notranslate_tags Indicates whether [NOTRANSLATE] tags should be kept.
271
275
  # @option opts [Boolean] :convert_emoji 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.
272
- # @option opts [Object] :format_options 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;
276
+ # @option opts [Object] :format_options 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;
273
277
  # @option opts [String] :encoding 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;.
274
278
  # @option opts [Boolean] :skip_unverified_translations 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;.
275
279
  # @option opts [Boolean] :include_unverified_translations if set to false unverified translations are excluded
@@ -316,6 +320,8 @@ module Phrase
316
320
  # HTTP header 'Accept' (if needed)
317
321
  header_params['Accept'] = @api_client.select_header_accept(['*'])
318
322
  header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
323
+ header_params[:'If-Modified-Since'] = opts[:'if_modified_since'] if !opts[:'if_modified_since'].nil?
324
+ header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].nil?
319
325
 
320
326
  # form parameters
321
327
  form_params = opts[:form_params] || {}
@@ -507,7 +513,7 @@ module Phrase
507
513
  # @param [Hash] opts the optional parameters
508
514
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
509
515
  # @option opts [Integer] :page Page number
510
- # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 25 by default
516
+ # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
511
517
  # @option opts [String] :sort_by Sort locales. Valid options are \&quot;name_asc\&quot;, \&quot;name_desc\&quot;, \&quot;default_asc\&quot;, \&quot;default_desc\&quot;.
512
518
  # @option opts [String] :branch specify the branch to use
513
519
  # @return [Array<Locale>]
@@ -522,7 +528,7 @@ module Phrase
522
528
  # @param [Hash] opts the optional parameters
523
529
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
524
530
  # @option opts [Integer] :page Page number
525
- # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 25 by default
531
+ # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
526
532
  # @option opts [String] :sort_by Sort locales. Valid options are \&quot;name_asc\&quot;, \&quot;name_desc\&quot;, \&quot;default_asc\&quot;, \&quot;default_desc\&quot;.
527
533
  # @option opts [String] :branch specify the branch to use
528
534
  # @return [Array<(Response<(Array<Locale>)>, Integer, Hash)>] Response<(Array<Locale>)> data, response status code and response headers
@@ -315,7 +315,7 @@ module Phrase
315
315
  # @param [Hash] opts the optional parameters
316
316
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
317
317
  # @option opts [Integer] :page Page number
318
- # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 25 by default
318
+ # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
319
319
  # @return [Array<Member>]
320
320
  def members_list(account_id, opts = {})
321
321
  data, _status_code, _headers = members_list_with_http_info(account_id, opts)
@@ -328,7 +328,7 @@ module Phrase
328
328
  # @param [Hash] opts the optional parameters
329
329
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
330
330
  # @option opts [Integer] :page Page number
331
- # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 25 by default
331
+ # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
332
332
  # @return [Array<(Response<(Array<Member>)>, Integer, Hash)>] Response<(Array<Member>)> data, response status code and response headers
333
333
  def members_list_with_http_info(account_id, opts = {})
334
334
  if @api_client.config.debugging