Class: Phrase::JobAnnotationsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ JobAnnotationsApi

Returns a new instance of JobAnnotationsApi.



7
8
9
 
# File 'lib/phrase/api/job_annotations_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_annotations_api.rb', line 5

def api_client
  @api_client
end

Instance Method Details

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

Delete a job annotation Delete an annotation for a job.

Parameters:

  • project_id (String) —

    Project ID

  • job_id (String) —

    Job ID

  • id (String) —

    Name of the annotation to delete.

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

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

  • :branch (String) —

    Branch to use

Returns:

  • (nil) 


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

def job_annotation_delete(project_id, job_id, id, opts = {})
  data, _status_code, _headers = job_annotation_delete_with_http_info(project_id, job_id, id, opts)
  data
end

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

Delete a job annotation Delete an annotation for a job.

Parameters:

  • project_id (String) —

    Project ID

  • job_id (String) —

    Job ID

  • id (String) —

    Name of the annotation to delete.

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

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

  • :branch (String) —

    Branch to use

Returns:

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

    Response<(nil, 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
 
# File 'lib/phrase/api/job_annotations_api.rb', line 33

def job_annotation_delete_with_http_info(project_id, job_id, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: JobAnnotationsApi.job_annotation_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 JobAnnotationsApi.job_annotation_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 JobAnnotationsApi.job_annotation_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 JobAnnotationsApi.job_annotation_delete"
  end
  # resource path
  local_var_path = '/projects/{project_id}/jobs/{job_id}/annotations/{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: JobAnnotationsApi#job_annotation_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  response = ::Phrase::Response.new(data, headers)
  return response, status_code, headers
end

#job_annotation_update(project_id, job_id, id, job_annotation_update_parameters, opts = {}) ⇒ JobAnnotation

Create/Update a job annotation Create or update an annotation for a job. If the annotation already exists, it will be updated; otherwise, a new annotation will be created.

Parameters:

  • project_id (String) —

    Project ID

  • job_id (String) —

    Job ID

  • id (String) —

    Name of the annotation to set or update.

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

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

Returns:



98
99
100
101
 
# File 'lib/phrase/api/job_annotations_api.rb', line 98

def job_annotation_update(project_id, job_id, id, job_annotation_update_parameters, opts = {})
  data, _status_code, _headers = job_annotation_update_with_http_info(project_id, job_id, id, job_annotation_update_parameters, opts)
  data
end

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

Create/Update a job annotation Create or update an annotation for a job. If the annotation already exists, it will be updated; otherwise, a new annotation will be created.

Parameters:

  • project_id (String) —

    Project ID

  • job_id (String) —

    Job ID

  • id (String) —

    Name of the annotation to set or update.

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

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

Returns:

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

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



112
113
114
115
116
117
118
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
 
# File 'lib/phrase/api/job_annotations_api.rb', line 112

def job_annotation_update_with_http_info(project_id, job_id, id, job_annotation_update_parameters, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: JobAnnotationsApi.job_annotation_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 JobAnnotationsApi.job_annotation_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 JobAnnotationsApi.job_annotation_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 JobAnnotationsApi.job_annotation_update"
  end
  # verify the required parameter 'job_annotation_update_parameters' is set
  if @api_client.config.client_side_validation && job_annotation_update_parameters.nil?
    fail ArgumentError, "Missing the required parameter 'job_annotation_update_parameters' when calling JobAnnotationsApi.job_annotation_update"
  end
  # resource path
  local_var_path = '/projects/{project_id}/jobs/{job_id}/annotations/{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_annotation_update_parameters) 

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

  # 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: JobAnnotationsApi#job_annotation_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  response = ::Phrase::Response.new(data, headers)
  return response, status_code, headers
end

#job_annotations_list(project_id, job_id, opts = {}) ⇒ Array<JobAnnotation>

List job annotations Retrieve a list of annotations for a 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)

  • :branch (String) —

    Branch to use

Returns:



183
184
185
186
 
# File 'lib/phrase/api/job_annotations_api.rb', line 183

def job_annotations_list(project_id, job_id, opts = {})
  data, _status_code, _headers = job_annotations_list_with_http_info(project_id, job_id, opts)
  data
end

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

List job annotations Retrieve a list of annotations for a 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)

  • :branch (String) —

    Branch to use

Returns:

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

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



196
197
198
199
200
201
202
203
204
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
 
# File 'lib/phrase/api/job_annotations_api.rb', line 196

def job_annotations_list_with_http_info(project_id, job_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: JobAnnotationsApi.job_annotations_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 JobAnnotationsApi.job_annotations_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 JobAnnotationsApi.job_annotations_list"
  end
  # resource path
  local_var_path = '/projects/{project_id}/jobs/{job_id}/annotations'.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[:'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<JobAnnotation>' 

  # 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: JobAnnotationsApi#job_annotations_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  response = ::Phrase::Response.new(data, headers)
  return response, status_code, headers
end

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

Delete a job locale annotation Delete an annotation for a job locale.

Parameters:

  • project_id (String) —

    Project ID

  • job_id (String) —

    Job ID

  • job_locale_id (String) —

    Job Locale ID

  • id (String) —

    Name of the annotation to delete.

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

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

  • :branch (String) —

    Branch to use

Returns:

  • (nil) 


260
261
262
263
 
# File 'lib/phrase/api/job_annotations_api.rb', line 260

def job_locale_annotation_delete(project_id, job_id, job_locale_id, id, opts = {})
  data, _status_code, _headers = job_locale_annotation_delete_with_http_info(project_id, job_id, job_locale_id, id, opts)
  data
end

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

Delete a job locale annotation Delete an annotation for a job locale.

Parameters:

  • project_id (String) —

    Project ID

  • job_id (String) —

    Job ID

  • job_locale_id (String) —

    Job Locale ID

  • id (String) —

    Name of the annotation to delete.

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

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

  • :branch (String) —

    Branch to use

Returns:

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

    Response<(nil, response status code and response headers



275
276
277
278
279
280
281
282
283
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
 
# File 'lib/phrase/api/job_annotations_api.rb', line 275

def job_locale_annotation_delete_with_http_info(project_id, job_id, job_locale_id, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: JobAnnotationsApi.job_locale_annotation_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 JobAnnotationsApi.job_locale_annotation_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 JobAnnotationsApi.job_locale_annotation_delete"
  end
  # verify the required parameter 'job_locale_id' is set
  if @api_client.config.client_side_validation && job_locale_id.nil?
    fail ArgumentError, "Missing the required parameter 'job_locale_id' when calling JobAnnotationsApi.job_locale_annotation_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 JobAnnotationsApi.job_locale_annotation_delete"
  end
  # resource path
  local_var_path = '/projects/{project_id}/jobs/{job_id}/locales/{job_locale_id}/annotations/{id}'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'job_id' + '}', CGI.escape(job_id.to_s)).sub('{' + 'job_locale_id' + '}', CGI.escape(job_locale_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: JobAnnotationsApi#job_locale_annotation_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_annotation_update(project_id, job_id, job_locale_id, id, job_annotation_update_parameters, opts = {}) ⇒ JobAnnotation

Create/Update a job locale annotation Create or update an annotation for a job locale. If the annotation already exists, it will be updated; otherwise, a new annotation will be created.

Parameters:

  • project_id (String) —

    Project ID

  • job_id (String) —

    Job ID

  • job_locale_id (String) —

    Job Locale ID

  • id (String) —

    Name of the annotation to set or update.

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

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

Returns:



345
346
347
348
 
# File 'lib/phrase/api/job_annotations_api.rb', line 345

def job_locale_annotation_update(project_id, job_id, job_locale_id, id, job_annotation_update_parameters, opts = {})
  data, _status_code, _headers = job_locale_annotation_update_with_http_info(project_id, job_id, job_locale_id, id, job_annotation_update_parameters, opts)
  data
end

#job_locale_annotation_update_with_http_info(project_id, job_id, job_locale_id, id, job_annotation_update_parameters, opts = {}) ⇒ Array<(Response<(JobAnnotation)>, Integer, Hash)>

Create/Update a job locale annotation Create or update an annotation for a job locale. If the annotation already exists, it will be updated; otherwise, a new annotation will be created.

Parameters:

  • project_id (String) —

    Project ID

  • job_id (String) —

    Job ID

  • job_locale_id (String) —

    Job Locale ID

  • id (String) —

    Name of the annotation to set or update.

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

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

Returns:

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

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



360
361
362
363
364
365
366
367
368
369
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
 
# File 'lib/phrase/api/job_annotations_api.rb', line 360

def job_locale_annotation_update_with_http_info(project_id, job_id, job_locale_id, id, job_annotation_update_parameters, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: JobAnnotationsApi.job_locale_annotation_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 JobAnnotationsApi.job_locale_annotation_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 JobAnnotationsApi.job_locale_annotation_update"
  end
  # verify the required parameter 'job_locale_id' is set
  if @api_client.config.client_side_validation && job_locale_id.nil?
    fail ArgumentError, "Missing the required parameter 'job_locale_id' when calling JobAnnotationsApi.job_locale_annotation_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 JobAnnotationsApi.job_locale_annotation_update"
  end
  # verify the required parameter 'job_annotation_update_parameters' is set
  if @api_client.config.client_side_validation && job_annotation_update_parameters.nil?
    fail ArgumentError, "Missing the required parameter 'job_annotation_update_parameters' when calling JobAnnotationsApi.job_locale_annotation_update"
  end
  # resource path
  local_var_path = '/projects/{project_id}/jobs/{job_id}/locales/{job_locale_id}/annotations/{id}'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'job_id' + '}', CGI.escape(job_id.to_s)).sub('{' + 'job_locale_id' + '}', CGI.escape(job_locale_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_annotation_update_parameters) 

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

  # 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: JobAnnotationsApi#job_locale_annotation_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  response = ::Phrase::Response.new(data, headers)
  return response, status_code, headers
end

#job_locale_annotations_list(project_id, job_id, job_locale_id, opts = {}) ⇒ Array<JobAnnotation>

List job locale annotations Retrieve a list of annotations for a job locale.

Parameters:

  • project_id (String) —

    Project ID

  • job_id (String) —

    Job ID

  • job_locale_id (String) —

    Job Locale ID

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

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

  • :branch (String) —

    Branch to use

Returns:



436
437
438
439
 
# File 'lib/phrase/api/job_annotations_api.rb', line 436

def job_locale_annotations_list(project_id, job_id, job_locale_id, opts = {})
  data, _status_code, _headers = job_locale_annotations_list_with_http_info(project_id, job_id, job_locale_id, opts)
  data
end

#job_locale_annotations_list_with_http_info(project_id, job_id, job_locale_id, opts = {}) ⇒ Array<(Response<(Array<JobAnnotation>)>, Integer, Hash)>

List job locale annotations Retrieve a list of annotations for a job locale.

Parameters:

  • project_id (String) —

    Project ID

  • job_id (String) —

    Job ID

  • job_locale_id (String) —

    Job Locale ID

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

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

  • :branch (String) —

    Branch to use

Returns:

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

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



450
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
 
# File 'lib/phrase/api/job_annotations_api.rb', line 450

def job_locale_annotations_list_with_http_info(project_id, job_id, job_locale_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: JobAnnotationsApi.job_locale_annotations_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 JobAnnotationsApi.job_locale_annotations_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 JobAnnotationsApi.job_locale_annotations_list"
  end
  # verify the required parameter 'job_locale_id' is set
  if @api_client.config.client_side_validation && job_locale_id.nil?
    fail ArgumentError, "Missing the required parameter 'job_locale_id' when calling JobAnnotationsApi.job_locale_annotations_list"
  end
  # resource path
  local_var_path = '/projects/{project_id}/jobs/{job_id}/locales/{job_locale_id}/annotations'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'job_id' + '}', CGI.escape(job_id.to_s)).sub('{' + 'job_locale_id' + '}', CGI.escape(job_locale_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] || 'Array<JobAnnotation>' 

  # 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: JobAnnotationsApi#job_locale_annotations_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  response = ::Phrase::Response.new(data, headers)
  return response, status_code, headers
end