Class: Phrase::JobLocalesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/phrase/api/job_locales_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ JobLocalesApi

Returns a new instance of JobLocalesApi.



7
8
9
 
# File 'lib/phrase/api/job_locales_api.rb', line 7

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



5
6
7
 
# File 'lib/phrase/api/job_locales_api.rb', line 5

def api_client
  @api_client
end

Instance Method Details

#job_locale_complete(project_id, job_id, id, job_locale_complete_parameters, opts = {}) ⇒ JobLocale

Complete a job locale Mark a job locale as completed.

Parameters:

  • project_id (String) —

    Project ID

  • job_id (String) —

    Job ID

  • id (String) —

    ID

  • job_locale_complete_parameters (JobLocaleCompleteParameters)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

Returns:



19
20
21
22
 
# File 'lib/phrase/api/job_locales_api.rb', line 19

def job_locale_complete(project_id, job_id, id, job_locale_complete_parameters, opts = {})
  data, _status_code, _headers = job_locale_complete_with_http_info(project_id, job_id, id, job_locale_complete_parameters, opts)
  data
end

#job_locale_complete_review(project_id, job_id, id, job_locale_complete_review_parameters, opts = {}) ⇒ JobLocale

Review a job locale Mark job locale as reviewed.

Parameters:

  • project_id (String) —

    Project ID

  • job_id (String) —

    Job ID

  • id (String) —

    ID

  • job_locale_complete_review_parameters (JobLocaleCompleteReviewParameters)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

Returns:



105
106
107
108
 
# File 'lib/phrase/api/job_locales_api.rb', line 105

def job_locale_complete_review(project_id, job_id, id, job_locale_complete_review_parameters, opts = {})
  data, _status_code, _headers = job_locale_complete_review_with_http_info(project_id, job_id, id, job_locale_complete_review_parameters, opts)
  data
end

#job_locale_complete_review_with_http_info(project_id, job_id, id, job_locale_complete_review_parameters, opts = {}) ⇒ Array<(Response<(JobLocale)>, Integer, Hash)>

Review a job locale Mark job locale as reviewed.

Parameters:

  • project_id (String) —

    Project ID

  • job_id (String) —

    Job ID

  • id (String) —

    ID

  • job_locale_complete_review_parameters (JobLocaleCompleteReviewParameters)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

Returns:

  • (Array<(Response<(JobLocale)>, Integer, Hash)>) —

    Response<(JobLocale)> data, response status code and response headers



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/phrase/api/job_locales_api.rb', line 119

def job_locale_complete_review_with_http_info(project_id, job_id, id, job_locale_complete_review_parameters, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: JobLocalesApi.job_locale_complete_review ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling JobLocalesApi.job_locale_complete_review"
  end
  # verify the required parameter 'job_id' is set
  if @api_client.config.client_side_validation && job_id.nil?
    fail ArgumentError, "Missing the required parameter 'job_id' when calling JobLocalesApi.job_locale_complete_review"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling JobLocalesApi.job_locale_complete_review"
  end
  # verify the required parameter 'job_locale_complete_review_parameters' is set
  if @api_client.config.client_side_validation && job_locale_complete_review_parameters.nil?
    fail ArgumentError, "Missing the required parameter 'job_locale_complete_review_parameters' when calling JobLocalesApi.job_locale_complete_review"
  end
  # resource path
  local_var_path = '/projects/{project_id}/jobs/{job_id}/locales/{id}/complete_review'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'job_id' + '}', CGI.escape(job_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(job_locale_complete_review_parameters) 

  # return_type
  return_type = opts[:return_type] || 'JobLocale' 

  # auth_names
  auth_names = opts[:auth_names] || ['Basic', 'Token']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: JobLocalesApi#job_locale_complete_review\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  response = ::Phrase::Response.new(data, headers)
  return response, status_code, headers
end

#job_locale_complete_with_http_info(project_id, job_id, id, job_locale_complete_parameters, opts = {}) ⇒ Array<(Response<(JobLocale)>, Integer, Hash)>

Complete a job locale Mark a job locale as completed.

Parameters:

  • project_id (String) —

    Project ID

  • job_id (String) —

    Job ID

  • id (String) —

    ID

  • job_locale_complete_parameters (JobLocaleCompleteParameters)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

Returns:

  • (Array<(Response<(JobLocale)>, Integer, Hash)>) —

    Response<(JobLocale)> data, response status code and response headers



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/phrase/api/job_locales_api.rb', line 33

def job_locale_complete_with_http_info(project_id, job_id, id, job_locale_complete_parameters, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: JobLocalesApi.job_locale_complete ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling JobLocalesApi.job_locale_complete"
  end
  # verify the required parameter 'job_id' is set
  if @api_client.config.client_side_validation && job_id.nil?
    fail ArgumentError, "Missing the required parameter 'job_id' when calling JobLocalesApi.job_locale_complete"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling JobLocalesApi.job_locale_complete"
  end
  # verify the required parameter 'job_locale_complete_parameters' is set
  if @api_client.config.client_side_validation && job_locale_complete_parameters.nil?
    fail ArgumentError, "Missing the required parameter 'job_locale_complete_parameters' when calling JobLocalesApi.job_locale_complete"
  end
  # resource path
  local_var_path = '/projects/{project_id}/jobs/{job_id}/locales/{id}/complete'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'job_id' + '}', CGI.escape(job_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(job_locale_complete_parameters) 

  # return_type
  return_type = opts[:return_type] || 'JobLocale' 

  # auth_names
  auth_names = opts[:auth_names] || ['Basic', 'Token']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: JobLocalesApi#job_locale_complete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  response = ::Phrase::Response.new(data, headers)
  return response, status_code, headers
end

#job_locale_delete(project_id, job_id, id, opts = {}) ⇒ nil

Remove a target locale from a job Removes a target locale from a job.

Parameters:

  • project_id (String) —

    Project ID

  • job_id (String) —

    Job ID

  • id (String) —

    ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

  • :branch (String) —

    specify the branch to use

Returns:

  • (nil) 


191
192
193
194
 
# File 'lib/phrase/api/job_locales_api.rb', line 191

def job_locale_delete(project_id, job_id, id, opts = {})
  data, _status_code, _headers = job_locale_delete_with_http_info(project_id, job_id, id, opts)
  data
end

#job_locale_delete_with_http_info(project_id, job_id, id, opts = {}) ⇒ Array<(Response, Integer, Hash)>

Remove a target locale from a job Removes a target locale from a job.

Parameters:

  • project_id (String) —

    Project ID

  • job_id (String) —

    Job ID

  • id (String) —

    ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

  • :branch (String) —

    specify the branch to use

Returns:

  • (Array<(Response, Integer, Hash)>) —

    Response<(nil, response status code and response headers



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/phrase/api/job_locales_api.rb', line 205

def job_locale_delete_with_http_info(project_id, job_id, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: JobLocalesApi.job_locale_delete ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling JobLocalesApi.job_locale_delete"
  end
  # verify the required parameter 'job_id' is set
  if @api_client.config.client_side_validation && job_id.nil?
    fail ArgumentError, "Missing the required parameter 'job_id' when calling JobLocalesApi.job_locale_delete"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling JobLocalesApi.job_locale_delete"
  end
  # resource path
  local_var_path = '/projects/{project_id}/jobs/{job_id}/locales/{id}'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'job_id' + '}', CGI.escape(job_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'branch'] = opts[:'branch'] if !opts[:'branch'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['Basic', 'Token']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: JobLocalesApi#job_locale_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  response = ::Phrase::Response.new(data, headers)
  return response, status_code, headers
end

#job_locale_reopen(project_id, job_id, id, job_locale_reopen_parameters, opts = {}) ⇒ JobLocale

Reopen a job locale Mark a job locale as uncompleted.

Parameters:

  • project_id (String) —

    Project ID

  • job_id (String) —

    Job ID

  • id (String) —

    ID

  • job_locale_reopen_parameters (JobLocaleReopenParameters)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

Returns:



270
271
272
273
 
# File 'lib/phrase/api/job_locales_api.rb', line 270

def job_locale_reopen(project_id, job_id, id, job_locale_reopen_parameters, opts = {})
  data, _status_code, _headers = job_locale_reopen_with_http_info(project_id, job_id, id, job_locale_reopen_parameters, opts)
  data
end

#job_locale_reopen_with_http_info(project_id, job_id, id, job_locale_reopen_parameters, opts = {}) ⇒ Array<(Response<(JobLocale)>, Integer, Hash)>

Reopen a job locale Mark a job locale as uncompleted.

Parameters:

  • project_id (String) —

    Project ID

  • job_id (String) —

    Job ID

  • id (String) —

    ID

  • job_locale_reopen_parameters (JobLocaleReopenParameters)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

Returns:

  • (Array<(Response<(JobLocale)>, Integer, Hash)>) —

    Response<(JobLocale)> data, response status code and response headers



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/phrase/api/job_locales_api.rb', line 284

def job_locale_reopen_with_http_info(project_id, job_id, id, job_locale_reopen_parameters, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: JobLocalesApi.job_locale_reopen ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling JobLocalesApi.job_locale_reopen"
  end
  # verify the required parameter 'job_id' is set
  if @api_client.config.client_side_validation && job_id.nil?
    fail ArgumentError, "Missing the required parameter 'job_id' when calling JobLocalesApi.job_locale_reopen"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling JobLocalesApi.job_locale_reopen"
  end
  # verify the required parameter 'job_locale_reopen_parameters' is set
  if @api_client.config.client_side_validation && job_locale_reopen_parameters.nil?
    fail ArgumentError, "Missing the required parameter 'job_locale_reopen_parameters' when calling JobLocalesApi.job_locale_reopen"
  end
  # resource path
  local_var_path = '/projects/{project_id}/jobs/{job_id}/locales/{id}/reopen'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'job_id' + '}', CGI.escape(job_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(job_locale_reopen_parameters) 

  # return_type
  return_type = opts[:return_type] || 'JobLocale' 

  # auth_names
  auth_names = opts[:auth_names] || ['Basic', 'Token']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: JobLocalesApi#job_locale_reopen\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  response = ::Phrase::Response.new(data, headers)
  return response, status_code, headers
end

#job_locale_show(project_id, job_id, id, opts = {}) ⇒ JobLocale

Show single job target locale Get a single target locale for a given job.

Parameters:

  • project_id (String) —

    Project ID

  • job_id (String) —

    Job ID

  • id (String) —

    ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

  • :branch (String) —

    specify the branch to use

Returns:



356
357
358
359
 
# File 'lib/phrase/api/job_locales_api.rb', line 356

def job_locale_show(project_id, job_id, id, opts = {})
  data, _status_code, _headers = job_locale_show_with_http_info(project_id, job_id, id, opts)
  data
end

#job_locale_show_with_http_info(project_id, job_id, id, opts = {}) ⇒ Array<(Response<(JobLocale)>, Integer, Hash)>

Show single job target locale Get a single target locale for a given job.

Parameters:

  • project_id (String) —

    Project ID

  • job_id (String) —

    Job ID

  • id (String) —

    ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

  • :branch (String) —

    specify the branch to use

Returns:

  • (Array<(Response<(JobLocale)>, Integer, Hash)>) —

    Response<(JobLocale)> data, response status code and response headers



370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
 
# File 'lib/phrase/api/job_locales_api.rb', line 370

def job_locale_show_with_http_info(project_id, job_id, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: JobLocalesApi.job_locale_show ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling JobLocalesApi.job_locale_show"
  end
  # verify the required parameter 'job_id' is set
  if @api_client.config.client_side_validation && job_id.nil?
    fail ArgumentError, "Missing the required parameter 'job_id' when calling JobLocalesApi.job_locale_show"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling JobLocalesApi.job_locale_show"
  end
  # resource path
  local_var_path = '/projects/{project_id}/jobs/{job_id}/locales/{id}'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'job_id' + '}', CGI.escape(job_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'branch'] = opts[:'branch'] if !opts[:'branch'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'JobLocale' 

  # auth_names
  auth_names = opts[:auth_names] || ['Basic', 'Token']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: JobLocalesApi#job_locale_show\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  response = ::Phrase::Response.new(data, headers)
  return response, status_code, headers
end

#job_locale_update(project_id, job_id, id, job_locale_update_parameters, opts = {}) ⇒ JobLocale

Update a job target locale Update an existing job target locale.

Parameters:

  • project_id (String) —

    Project ID

  • job_id (String) —

    Job ID

  • id (String) —

    ID

  • job_locale_update_parameters (JobLocaleUpdateParameters)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

Returns:



437
438
439
440
 
# File 'lib/phrase/api/job_locales_api.rb', line 437

def job_locale_update(project_id, job_id, id, job_locale_update_parameters, opts = {})
  data, _status_code, _headers = job_locale_update_with_http_info(project_id, job_id, id, job_locale_update_parameters, opts)
  data
end

#job_locale_update_with_http_info(project_id, job_id, id, job_locale_update_parameters, opts = {}) ⇒ Array<(Response<(JobLocale)>, Integer, Hash)>

Update a job target locale Update an existing job target locale.

Parameters:

  • project_id (String) —

    Project ID

  • job_id (String) —

    Job ID

  • id (String) —

    ID

  • job_locale_update_parameters (JobLocaleUpdateParameters)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

Returns:

  • (Array<(Response<(JobLocale)>, Integer, Hash)>) —

    Response<(JobLocale)> data, response status code and response headers



451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
 
# File 'lib/phrase/api/job_locales_api.rb', line 451

def job_locale_update_with_http_info(project_id, job_id, id, job_locale_update_parameters, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: JobLocalesApi.job_locale_update ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling JobLocalesApi.job_locale_update"
  end
  # verify the required parameter 'job_id' is set
  if @api_client.config.client_side_validation && job_id.nil?
    fail ArgumentError, "Missing the required parameter 'job_id' when calling JobLocalesApi.job_locale_update"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling JobLocalesApi.job_locale_update"
  end
  # verify the required parameter 'job_locale_update_parameters' is set
  if @api_client.config.client_side_validation && job_locale_update_parameters.nil?
    fail ArgumentError, "Missing the required parameter 'job_locale_update_parameters' when calling JobLocalesApi.job_locale_update"
  end
  # resource path
  local_var_path = '/projects/{project_id}/jobs/{job_id}/locales/{id}'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'job_id' + '}', CGI.escape(job_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(job_locale_update_parameters) 

  # return_type
  return_type = opts[:return_type] || 'JobLocale' 

  # auth_names
  auth_names = opts[:auth_names] || ['Basic', 'Token']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: JobLocalesApi#job_locale_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  response = ::Phrase::Response.new(data, headers)
  return response, status_code, headers
end

#job_locales_create(project_id, job_id, job_locales_create_parameters, opts = {}) ⇒ JobLocale

Add a target locale to a job Adds a target locale to a job.

Parameters:

  • project_id (String) —

    Project ID

  • job_id (String) —

    Job ID

  • job_locales_create_parameters (JobLocalesCreateParameters)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

Returns:



522
523
524
525
 
# File 'lib/phrase/api/job_locales_api.rb', line 522

def job_locales_create(project_id, job_id, job_locales_create_parameters, opts = {})
  data, _status_code, _headers = job_locales_create_with_http_info(project_id, job_id, job_locales_create_parameters, opts)
  data
end

#job_locales_create_with_http_info(project_id, job_id, job_locales_create_parameters, opts = {}) ⇒ Array<(Response<(JobLocale)>, Integer, Hash)>

Add a target locale to a job Adds a target locale to a job.

Parameters:

  • project_id (String) —

    Project ID

  • job_id (String) —

    Job ID

  • job_locales_create_parameters (JobLocalesCreateParameters)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

Returns:

  • (Array<(Response<(JobLocale)>, Integer, Hash)>) —

    Response<(JobLocale)> data, response status code and response headers



535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
 
# File 'lib/phrase/api/job_locales_api.rb', line 535

def job_locales_create_with_http_info(project_id, job_id, job_locales_create_parameters, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: JobLocalesApi.job_locales_create ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling JobLocalesApi.job_locales_create"
  end
  # verify the required parameter 'job_id' is set
  if @api_client.config.client_side_validation && job_id.nil?
    fail ArgumentError, "Missing the required parameter 'job_id' when calling JobLocalesApi.job_locales_create"
  end
  # verify the required parameter 'job_locales_create_parameters' is set
  if @api_client.config.client_side_validation && job_locales_create_parameters.nil?
    fail ArgumentError, "Missing the required parameter 'job_locales_create_parameters' when calling JobLocalesApi.job_locales_create"
  end
  # resource path
  local_var_path = '/projects/{project_id}/jobs/{job_id}/locales'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'job_id' + '}', CGI.escape(job_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(job_locales_create_parameters) 

  # return_type
  return_type = opts[:return_type] || 'JobLocale' 

  # auth_names
  auth_names = opts[:auth_names] || ['Basic', 'Token']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: JobLocalesApi#job_locales_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  response = ::Phrase::Response.new(data, headers)
  return response, status_code, headers
end

#job_locales_list(project_id, job_id, opts = {}) ⇒ Array<JobLocale>

List job target locales List all target locales for a given job.

Parameters:

  • project_id (String) —

    Project ID

  • job_id (String) —

    Job ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

  • :page (Integer) —

    Page number

  • :per_page (Integer) —

    Limit on the number of objects to be returned, between 1 and 100. 25 by default

  • :branch (String) —

    specify the branch to use

Returns:



604
605
606
607
 
# File 'lib/phrase/api/job_locales_api.rb', line 604

def job_locales_list(project_id, job_id, opts = {})
  data, _status_code, _headers = job_locales_list_with_http_info(project_id, job_id, opts)
  data
end

#job_locales_list_with_http_info(project_id, job_id, opts = {}) ⇒ Array<(Response<(Array<JobLocale>)>, Integer, Hash)>

List job target locales List all target locales for a given job.

Parameters:

  • project_id (String) —

    Project ID

  • job_id (String) —

    Job ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

  • :page (Integer) —

    Page number

  • :per_page (Integer) —

    Limit on the number of objects to be returned, between 1 and 100. 25 by default

  • :branch (String) —

    specify the branch to use

Returns:

  • (Array<(Response<(Array<JobLocale>)>, Integer, Hash)>) —

    Response<(Array<JobLocale>)> data, response status code and response headers



619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
 
# File 'lib/phrase/api/job_locales_api.rb', line 619

def job_locales_list_with_http_info(project_id, job_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: JobLocalesApi.job_locales_list ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling JobLocalesApi.job_locales_list"
  end
  # verify the required parameter 'job_id' is set
  if @api_client.config.client_side_validation && job_id.nil?
    fail ArgumentError, "Missing the required parameter 'job_id' when calling JobLocalesApi.job_locales_list"
  end
  # resource path
  local_var_path = '/projects/{project_id}/jobs/{job_id}/locales'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'job_id' + '}', CGI.escape(job_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
  query_params[:'branch'] = opts[:'branch'] if !opts[:'branch'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Array<JobLocale>' 

  # auth_names
  auth_names = opts[:auth_names] || ['Basic', 'Token']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: JobLocalesApi#job_locales_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  response = ::Phrase::Response.new(data, headers)
  return response, status_code, headers
end