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
@@ -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']
@@ -342,7 +342,7 @@ module Phrase
342
342
  # @option opts [Integer] :page Page number
343
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
@@ -357,7 +357,7 @@ module Phrase
357
357
  # @option opts [Integer] :page Page number
358
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 Limit on the number of objects to be returned, between 1 and 100. 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 Limit on the number of objects to be returned, between 1 and 100. 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
@@ -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] || {}
@@ -13,7 +13,7 @@ module Phrase
13
13
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
14
14
  # @option opts [Integer] :page Page number
15
15
  # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
16
- # @return [Array<Object>]
16
+ # @return [Array<NotificationGroupDetail>]
17
17
  def notification_groups_list(opts = {})
18
18
  data, _status_code, _headers = notification_groups_list_with_http_info(opts)
19
19
  data
@@ -25,7 +25,7 @@ module Phrase
25
25
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
26
26
  # @option opts [Integer] :page Page number
27
27
  # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
28
- # @return [Array<(Response<(Array<Object>)>, Integer, Hash)>] Response<(Array<Object>)> data, response status code and response headers
28
+ # @return [Array<(Response<(Array<NotificationGroupDetail>)>, Integer, Hash)>] Response<(Array<NotificationGroupDetail>)> data, response status code and response headers
29
29
  def notification_groups_list_with_http_info(opts = {})
30
30
  if @api_client.config.debugging
31
31
  @api_client.config.logger.debug 'Calling API: NotificationGroupsApi.notification_groups_list ...'
@@ -51,7 +51,7 @@ module Phrase
51
51
  post_body = opts[:body]
52
52
 
53
53
  # return_type
54
- return_type = opts[:return_type] || 'Array<Object>'
54
+ return_type = opts[:return_type] || 'Array<NotificationGroupDetail>'
55
55
 
56
56
  # auth_names
57
57
  auth_names = opts[:auth_names] || ['Basic', 'Token']
@@ -77,7 +77,7 @@ module Phrase
77
77
  # Mark all notification groups of the current user as read
78
78
  # @param [Hash] opts the optional parameters
79
79
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
80
- # @return [Array<Object>]
80
+ # @return [Array<NotificationGroupDetail>]
81
81
  def notification_groups_mark_all_as_read(opts = {})
82
82
  data, _status_code, _headers = notification_groups_mark_all_as_read_with_http_info(opts)
83
83
  data
@@ -87,7 +87,7 @@ module Phrase
87
87
  # Mark all notification groups of the current user as read
88
88
  # @param [Hash] opts the optional parameters
89
89
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
90
- # @return [Array<(Response<(Array<Object>)>, Integer, Hash)>] Response<(Array<Object>)> data, response status code and response headers
90
+ # @return [Array<(Response<(Array<NotificationGroupDetail>)>, Integer, Hash)>] Response<(Array<NotificationGroupDetail>)> data, response status code and response headers
91
91
  def notification_groups_mark_all_as_read_with_http_info(opts = {})
92
92
  if @api_client.config.debugging
93
93
  @api_client.config.logger.debug 'Calling API: NotificationGroupsApi.notification_groups_mark_all_as_read ...'
@@ -111,7 +111,7 @@ module Phrase
111
111
  post_body = opts[:body]
112
112
 
113
113
  # return_type
114
- return_type = opts[:return_type] || 'Array<Object>'
114
+ return_type = opts[:return_type] || 'Array<NotificationGroupDetail>'
115
115
 
116
116
  # auth_names
117
117
  auth_names = opts[:auth_names] || ['Basic', 'Token']
@@ -14,7 +14,7 @@ module Phrase
14
14
  # @option opts [Integer] :page Page number
15
15
  # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
16
16
  # @option opts [Boolean] :unseen Include only unseen notifications
17
- # @return [Array<Object>]
17
+ # @return [Array<Notification>]
18
18
  def notifications_list(opts = {})
19
19
  data, _status_code, _headers = notifications_list_with_http_info(opts)
20
20
  data
@@ -27,7 +27,7 @@ module Phrase
27
27
  # @option opts [Integer] :page Page number
28
28
  # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
29
29
  # @option opts [Boolean] :unseen Include only unseen notifications
30
- # @return [Array<(Response<(Array<Object>)>, Integer, Hash)>] Response<(Array<Object>)> data, response status code and response headers
30
+ # @return [Array<(Response<(Array<Notification>)>, Integer, Hash)>] Response<(Array<Notification>)> data, response status code and response headers
31
31
  def notifications_list_with_http_info(opts = {})
32
32
  if @api_client.config.debugging
33
33
  @api_client.config.logger.debug 'Calling API: NotificationsApi.notifications_list ...'
@@ -54,7 +54,7 @@ module Phrase
54
54
  post_body = opts[:body]
55
55
 
56
56
  # return_type
57
- return_type = opts[:return_type] || 'Array<Object>'
57
+ return_type = opts[:return_type] || 'Array<Notification>'
58
58
 
59
59
  # auth_names
60
60
  auth_names = opts[:auth_names] || ['Basic', 'Token']
@@ -80,7 +80,7 @@ module Phrase
80
80
  # Mark all notifications of the current user as read
81
81
  # @param [Hash] opts the optional parameters
82
82
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
83
- # @return [Array<Object>]
83
+ # @return [Array<Notification>]
84
84
  def notifications_mark_all_as_read(opts = {})
85
85
  data, _status_code, _headers = notifications_mark_all_as_read_with_http_info(opts)
86
86
  data
@@ -90,7 +90,7 @@ module Phrase
90
90
  # Mark all notifications of the current user as read
91
91
  # @param [Hash] opts the optional parameters
92
92
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
93
- # @return [Array<(Response<(Array<Object>)>, Integer, Hash)>] Response<(Array<Object>)> data, response status code and response headers
93
+ # @return [Array<(Response<(Array<Notification>)>, Integer, Hash)>] Response<(Array<Notification>)> data, response status code and response headers
94
94
  def notifications_mark_all_as_read_with_http_info(opts = {})
95
95
  if @api_client.config.debugging
96
96
  @api_client.config.logger.debug 'Calling API: NotificationsApi.notifications_mark_all_as_read ...'
@@ -114,7 +114,7 @@ module Phrase
114
114
  post_body = opts[:body]
115
115
 
116
116
  # return_type
117
- return_type = opts[:return_type] || 'Array<Object>'
117
+ return_type = opts[:return_type] || 'Array<Notification>'
118
118
 
119
119
  # auth_names
120
120
  auth_names = opts[:auth_names] || ['Basic', 'Token']
@@ -8,7 +8,7 @@ module Phrase
8
8
  @api_client = api_client
9
9
  end
10
10
  # Search across projects
11
- # Search for keys and translations in all account projects
11
+ # 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>
12
12
  # @param account_id [String] Account ID
13
13
  # @param search_in_account_parameters [SearchInAccountParameters]
14
14
  # @param [Hash] opts the optional parameters
@@ -20,7 +20,7 @@ module Phrase
20
20
  end
21
21
 
22
22
  # Search across projects
23
- # Search for keys and translations in all account projects
23
+ # Search for keys and translations in all account projects &lt;br&gt;&lt;br&gt;&lt;i&gt;Note: Search is limited to 10000 results and may not include recently updated data depending on the project sizes.&lt;/i&gt;
24
24
  # @param account_id [String] Account ID
25
25
  # @param search_in_account_parameters [SearchInAccountParameters]
26
26
  # @param [Hash] opts the optional parameters