Class: KoronaCloudClient::ImagesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/korona-cloud-client/api/images_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ImagesApi

Returns a new instance of ImagesApi.



19
20
21
 
# File 'lib/korona-cloud-client/api/images_api.rb', line 19

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/korona-cloud-client/api/images_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#add_images(korona_account_id, image, opts = {}) ⇒ Array<AddOrUpdateResult>

adds new images

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • image (Array<Image>) —

    list of properties of new images

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

    the optional parameters

Options Hash (opts):

  • :upsert (Boolean) —

    when set to true, updates the object instead of generating a already-exists-error; deprecated, use writeMode ADD_OR_UPDATE instead

  • :processing (Boolean) —

    whether PRINTER images should be processed with Dithering

  • :write_mode (String) —

    DEFAULT &#x3D; insert; ADD_OR_UPDATE &#x3D; insert or update, overwrite all non-null fields; ADD_OR_REPLACE &#x3D; insert or update, overwrite all fields

Returns:



30
31
32
33
 
# File 'lib/korona-cloud-client/api/images_api.rb', line 30

def add_images(, image, opts = {})
  data, _status_code, _headers = add_images_with_http_info(, image, opts)
  data
end

#add_images_with_http_info(korona_account_id, image, opts = {}) ⇒ Array<(Array<AddOrUpdateResult>, Integer, Hash)>

adds new images

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • image (Array<Image>) —

    list of properties of new images

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

    the optional parameters

Options Hash (opts):

  • :upsert (Boolean) —

    when set to true, updates the object instead of generating a already-exists-error; deprecated, use writeMode ADD_OR_UPDATE instead

  • :processing (Boolean) —

    whether PRINTER images should be processed with Dithering

  • :write_mode (String) —

    DEFAULT &#x3D; insert; ADD_OR_UPDATE &#x3D; insert or update, overwrite all non-null fields; ADD_OR_REPLACE &#x3D; insert or update, overwrite all fields

Returns:

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

    Array<AddOrUpdateResult> data, response status code and response headers



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
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/korona-cloud-client/api/images_api.rb', line 43

def add_images_with_http_info(, image, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ImagesApi.add_images ...'
  end
  # verify the required parameter 'korona_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling ImagesApi.add_images"
  end
  # verify the required parameter 'image' is set
  if @api_client.config.client_side_validation && image.nil?
    fail ArgumentError, "Missing the required parameter 'image' when calling ImagesApi.add_images"
  end
  allowable_values = ["DEFAULT", "ADD_OR_UPDATE", "ADD_OR_REPLACE"]
  if @api_client.config.client_side_validation && opts[:'write_mode'] && !allowable_values.include?(opts[:'write_mode'])
    fail ArgumentError, "invalid value for \"write_mode\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/images'.sub('{' + 'koronaAccountId' + '}', CGI.escape(.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'upsert'] = opts[:'upsert'] if !opts[:'upsert'].nil?
  query_params[:'processing'] = opts[:'processing'] if !opts[:'processing'].nil?
  query_params[:'writeMode'] = opts[:'write_mode'] if !opts[:'write_mode'].nil?

  # 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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"ImagesApi.add_images",
    :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: ImagesApi#add_images\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_image(korona_account_id, image_id, opts = {}) ⇒ nil

deletes the single image

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • image_id (String) —

    id of the related object (important: id should match the uuid-format)

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

    the optional parameters

Returns:

  • (nil) 


112
113
114
115
 
# File 'lib/korona-cloud-client/api/images_api.rb', line 112

def delete_image(, image_id, opts = {})
  delete_image_with_http_info(, image_id, opts)
  nil
end

#delete_image_with_http_info(korona_account_id, image_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

deletes the single image

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • image_id (String) —

    id of the related object (important: id should match the uuid-format)

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
 
# File 'lib/korona-cloud-client/api/images_api.rb', line 122

def delete_image_with_http_info(, image_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ImagesApi.delete_image ...'
  end
  # verify the required parameter 'korona_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling ImagesApi.delete_image"
  end
  # verify the required parameter 'image_id' is set
  if @api_client.config.client_side_validation && image_id.nil?
    fail ArgumentError, "Missing the required parameter 'image_id' when calling ImagesApi.delete_image"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/images/{imageId}'.sub('{' + 'koronaAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'imageId' + '}', CGI.escape(image_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'])

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

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

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"ImagesApi.delete_image",
    :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: ImagesApi#delete_image\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_images(korona_account_id, image, opts = {}) ⇒ Array<AddOrUpdateResult>

deletes a batch of images

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • image (Array<Image>) —

    array of existing images (id or number required)

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

    the optional parameters

Returns:



179
180
181
182
 
# File 'lib/korona-cloud-client/api/images_api.rb', line 179

def delete_images(, image, opts = {})
  data, _status_code, _headers = delete_images_with_http_info(, image, opts)
  data
end

#delete_images_with_http_info(korona_account_id, image, opts = {}) ⇒ Array<(Array<AddOrUpdateResult>, Integer, Hash)>

deletes a batch of images

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • image (Array<Image>) —

    array of existing images (id or number required)

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

    the optional parameters

Returns:

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

    Array<AddOrUpdateResult> data, response status code and response headers



189
190
191
192
193
194
195
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
 
# File 'lib/korona-cloud-client/api/images_api.rb', line 189

def delete_images_with_http_info(, image, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ImagesApi.delete_images ...'
  end
  # verify the required parameter 'korona_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling ImagesApi.delete_images"
  end
  # verify the required parameter 'image' is set
  if @api_client.config.client_side_validation && image.nil?
    fail ArgumentError, "Missing the required parameter 'image' when calling ImagesApi.delete_images"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/images'.sub('{' + 'koronaAccountId' + '}', CGI.escape(.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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"ImagesApi.delete_images",
    :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: ImagesApi#delete_images\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_image(korona_account_id, image_id, opts = {}) ⇒ String

displays the image or returns properties as JSON

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • image_id (String) —

    id of the related object (important: id should match the uuid-format)

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

    the optional parameters

Options Hash (opts):

  • :accept (String) —

    the accepted content type for the response

Returns:

  • (String) 


252
253
254
255
 
# File 'lib/korona-cloud-client/api/images_api.rb', line 252

def get_image(, image_id, opts = {})
  data, _status_code, _headers = get_image_with_http_info(, image_id, opts)
  data
end

#get_image_with_http_info(korona_account_id, image_id, opts = {}) ⇒ Array<(String, Integer, Hash)>

displays the image or returns properties as JSON

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • image_id (String) —

    id of the related object (important: id should match the uuid-format)

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

    the optional parameters

Options Hash (opts):

  • :accept (String) —

    the accepted content type for the response

Returns:

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

    String data, response status code and response headers



263
264
265
266
267
268
269
270
271
272
273
274
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
 
# File 'lib/korona-cloud-client/api/images_api.rb', line 263

def get_image_with_http_info(, image_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ImagesApi.get_image ...'
  end
  # verify the required parameter 'korona_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling ImagesApi.get_image"
  end
  # verify the required parameter 'image_id' is set
  if @api_client.config.client_side_validation && image_id.nil?
    fail ArgumentError, "Missing the required parameter 'image_id' when calling ImagesApi.get_image"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/images/{imageId}'.sub('{' + 'koronaAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'imageId' + '}', CGI.escape(image_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', 'image/png', 'image/jpg'])
  header_params[:'accept'] = opts[:'accept'] if !opts[:'accept'].nil?

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'String'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"ImagesApi.get_image",
    :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: ImagesApi#get_image\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_images(korona_account_id, opts = {}) ⇒ ResultListImage

returns a list of image properties

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    number of the page to fetch

  • :size (Integer) —

    amount of objects to return per page

  • :sort (String) —

    attribute to sort by (multiple separated by comma; max. 5)

  • :revision (Integer) —

    last revision number, objects with a greater revision than this will be returned

  • :include_deleted (Boolean) —

    indicates deleted objects should be loaded or not (default: false)

  • :number (String) —

    number of the related object

  • :export_image_data (Boolean) —

    export image data

Returns:



327
328
329
330
 
# File 'lib/korona-cloud-client/api/images_api.rb', line 327

def get_images(, opts = {})
  data, _status_code, _headers = get_images_with_http_info(, opts)
  data
end

#get_images_with_http_info(korona_account_id, opts = {}) ⇒ Array<(ResultListImage, Integer, Hash)>

returns a list of image properties

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    number of the page to fetch

  • :size (Integer) —

    amount of objects to return per page

  • :sort (String) —

    attribute to sort by (multiple separated by comma; max. 5)

  • :revision (Integer) —

    last revision number, objects with a greater revision than this will be returned

  • :include_deleted (Boolean) —

    indicates deleted objects should be loaded or not (default: false)

  • :number (String) —

    number of the related object

  • :export_image_data (Boolean) —

    export image data

Returns:

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

    ResultListImage data, response status code and response headers



343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
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
 
# File 'lib/korona-cloud-client/api/images_api.rb', line 343

def get_images_with_http_info(, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ImagesApi.get_images ...'
  end
  # verify the required parameter 'korona_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling ImagesApi.get_images"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/images'.sub('{' + 'koronaAccountId' + '}', CGI.escape(.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'revision'] = opts[:'revision'] if !opts[:'revision'].nil?
  query_params[:'includeDeleted'] = opts[:'include_deleted'] if !opts[:'include_deleted'].nil?
  query_params[:'number'] = opts[:'number'] if !opts[:'number'].nil?
  query_params[:'exportImageData'] = opts[:'export_image_data'] if !opts[:'export_image_data'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'ResultListImage'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"ImagesApi.get_images",
    :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: ImagesApi#get_images\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_image(korona_account_id, image_id, image, opts = {}) ⇒ nil

updates a single image

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • image_id (String) —

    id of the related object (important: id should match the uuid-format)

  • image (Image) —

    the properties to update the image

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

    the optional parameters

Options Hash (opts):

  • :processing (Boolean) —

    whether PRINTER images should be processed with Dithering

Returns:

  • (nil) 


405
406
407
408
 
# File 'lib/korona-cloud-client/api/images_api.rb', line 405

def update_image(, image_id, image, opts = {})
  update_image_with_http_info(, image_id, image, opts)
  nil
end

#update_image_with_http_info(korona_account_id, image_id, image, opts = {}) ⇒ Array<(nil, Integer, Hash)>

updates a single image

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • image_id (String) —

    id of the related object (important: id should match the uuid-format)

  • image (Image) —

    the properties to update the image

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

    the optional parameters

Options Hash (opts):

  • :processing (Boolean) —

    whether PRINTER images should be processed with Dithering

Returns:

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

    nil, response status code and response headers



417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
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
 
# File 'lib/korona-cloud-client/api/images_api.rb', line 417

def update_image_with_http_info(, image_id, image, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ImagesApi.update_image ...'
  end
  # verify the required parameter 'korona_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling ImagesApi.update_image"
  end
  # verify the required parameter 'image_id' is set
  if @api_client.config.client_side_validation && image_id.nil?
    fail ArgumentError, "Missing the required parameter 'image_id' when calling ImagesApi.update_image"
  end
  # verify the required parameter 'image' is set
  if @api_client.config.client_side_validation && image.nil?
    fail ArgumentError, "Missing the required parameter 'image' when calling ImagesApi.update_image"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/images/{imageId}'.sub('{' + 'koronaAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'imageId' + '}', CGI.escape(image_id.to_s))

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

  # 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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"ImagesApi.update_image",
    :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: ImagesApi#update_image\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_images(korona_account_id, image, opts = {}) ⇒ Array<AddOrUpdateResult>

updates an array of existing images

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • image (Array<Image>) —

    an array of existing images

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

    the optional parameters

Options Hash (opts):

  • :processing (Boolean) —

    whether PRINTER images should be processed with Dithering

Returns:



485
486
487
488
 
# File 'lib/korona-cloud-client/api/images_api.rb', line 485

def update_images(, image, opts = {})
  data, _status_code, _headers = update_images_with_http_info(, image, opts)
  data
end

#update_images_with_http_info(korona_account_id, image, opts = {}) ⇒ Array<(Array<AddOrUpdateResult>, Integer, Hash)>

updates an array of existing images

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • image (Array<Image>) —

    an array of existing images

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

    the optional parameters

Options Hash (opts):

  • :processing (Boolean) —

    whether PRINTER images should be processed with Dithering

Returns:

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

    Array<AddOrUpdateResult> data, response status code and response headers



496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
 
# File 'lib/korona-cloud-client/api/images_api.rb', line 496

def update_images_with_http_info(, image, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ImagesApi.update_images ...'
  end
  # verify the required parameter 'korona_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling ImagesApi.update_images"
  end
  # verify the required parameter 'image' is set
  if @api_client.config.client_side_validation && image.nil?
    fail ArgumentError, "Missing the required parameter 'image' when calling ImagesApi.update_images"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/images'.sub('{' + 'koronaAccountId' + '}', CGI.escape(.to_s))

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

  # 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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"ImagesApi.update_images",
    :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: ImagesApi#update_images\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end