Class: KatapultAPI::CoreApi

Inherits:
Object
  • Object
show all
Defined in:
lib/katapult-ruby/api/core_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CoreApi

Returns a new instance of CoreApi.



19
20
21
# File 'lib/katapult-ruby/api/core_api.rb', line 19

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

Instance Attribute Details

#api_clientObject

Returns the value of attribute api_client.



17
18
19
# File 'lib/katapult-ruby/api/core_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#delete_address_list(opts = {}) ⇒ DeleteAddressList200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



25
26
27
28
# File 'lib/katapult-ruby/api/core_api.rb', line 25

def delete_address_list(opts = {})
  data, _status_code, _headers = delete_address_list_with_http_info(opts)
  data
end

#delete_address_list_entry(opts = {}) ⇒ DeleteAddressListEntry200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



85
86
87
88
# File 'lib/katapult-ruby/api/core_api.rb', line 85

def delete_address_list_entry(opts = {})
  data, _status_code, _headers = delete_address_list_entry_with_http_info(opts)
  data
end

#delete_address_list_entry_with_http_info(opts = {}) ⇒ Array<(DeleteAddressListEntry200Response, Integer, Hash)>

Returns DeleteAddressListEntry200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
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
# File 'lib/katapult-ruby/api/core_api.rb', line 93

def delete_address_list_entry_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.delete_address_list_entry ...'
  end
  # resource path
  local_var_path = '/address_list_entries/:address_list_entry'

  # 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(opts[:'delete_address_list_entry_request'])

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

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

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

#delete_address_list_with_http_info(opts = {}) ⇒ Array<(DeleteAddressList200Response, Integer, Hash)>

Returns DeleteAddressList200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



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
# File 'lib/katapult-ruby/api/core_api.rb', line 33

def delete_address_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.delete_address_list ...'
  end
  # resource path
  local_var_path = '/address_lists/:address_list'

  # 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(opts[:'delete_address_list_request'])

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

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

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

#delete_disk_backup_policy(opts = {}) ⇒ DeleteDiskBackupPolicy200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



145
146
147
148
# File 'lib/katapult-ruby/api/core_api.rb', line 145

def delete_disk_backup_policy(opts = {})
  data, _status_code, _headers = delete_disk_backup_policy_with_http_info(opts)
  data
end

#delete_disk_backup_policy_schedule(opts = {}) ⇒ DeleteDiskBackupPolicySchedule200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



205
206
207
208
# File 'lib/katapult-ruby/api/core_api.rb', line 205

def delete_disk_backup_policy_schedule(opts = {})
  data, _status_code, _headers = delete_disk_backup_policy_schedule_with_http_info(opts)
  data
end

#delete_disk_backup_policy_schedule_with_http_info(opts = {}) ⇒ Array<(DeleteDiskBackupPolicySchedule200Response, Integer, Hash)>

Returns DeleteDiskBackupPolicySchedule200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



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
260
# File 'lib/katapult-ruby/api/core_api.rb', line 213

def delete_disk_backup_policy_schedule_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.delete_disk_backup_policy_schedule ...'
  end
  # resource path
  local_var_path = '/disk_backup_policies/:disk_backup_policy/schedule'

  # 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(opts[:'delete_disk_backup_policy_schedule_request'])

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

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

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

#delete_disk_backup_policy_with_http_info(opts = {}) ⇒ Array<(DeleteDiskBackupPolicy200Response, Integer, Hash)>

Returns DeleteDiskBackupPolicy200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



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
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
# File 'lib/katapult-ruby/api/core_api.rb', line 153

def delete_disk_backup_policy_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.delete_disk_backup_policy ...'
  end
  # resource path
  local_var_path = '/disk_backup_policies/:disk_backup_policy'

  # 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(opts[:'delete_disk_backup_policy_request'])

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

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

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

#delete_dns_record(opts = {}) ⇒ DeleteDnsZone200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



265
266
267
268
# File 'lib/katapult-ruby/api/core_api.rb', line 265

def delete_dns_record(opts = {})
  data, _status_code, _headers = delete_dns_record_with_http_info(opts)
  data
end

#delete_dns_record_with_http_info(opts = {}) ⇒ Array<(DeleteDnsZone200Response, Integer, Hash)>

Returns DeleteDnsZone200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(DeleteDnsZone200Response, Integer, Hash)>)

    DeleteDnsZone200Response data, response status code and response headers



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
315
316
317
318
319
320
# File 'lib/katapult-ruby/api/core_api.rb', line 273

def delete_dns_record_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.delete_dns_record ...'
  end
  # resource path
  local_var_path = '/dns_records/:dns_record'

  # 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(opts[:'delete_dns_record_request'])

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

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

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

#delete_dns_zone(opts = {}) ⇒ DeleteDnsZone200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



325
326
327
328
# File 'lib/katapult-ruby/api/core_api.rb', line 325

def delete_dns_zone(opts = {})
  data, _status_code, _headers = delete_dns_zone_with_http_info(opts)
  data
end

#delete_dns_zone_with_http_info(opts = {}) ⇒ Array<(DeleteDnsZone200Response, Integer, Hash)>

Returns DeleteDnsZone200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(DeleteDnsZone200Response, Integer, Hash)>)

    DeleteDnsZone200Response data, response status code and response headers



333
334
335
336
337
338
339
340
341
342
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
# File 'lib/katapult-ruby/api/core_api.rb', line 333

def delete_dns_zone_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.delete_dns_zone ...'
  end
  # resource path
  local_var_path = '/dns_zones/:dns_zone'

  # 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(opts[:'delete_dns_zone_request'])

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

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

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

#delete_file_storage_volume(opts = {}) ⇒ DeleteFileStorageVolume200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



385
386
387
388
# File 'lib/katapult-ruby/api/core_api.rb', line 385

def delete_file_storage_volume(opts = {})
  data, _status_code, _headers = delete_file_storage_volume_with_http_info(opts)
  data
end

#delete_file_storage_volume_with_http_info(opts = {}) ⇒ Array<(DeleteFileStorageVolume200Response, Integer, Hash)>

Returns DeleteFileStorageVolume200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



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
427
428
429
430
431
432
433
434
435
436
437
438
439
440
# File 'lib/katapult-ruby/api/core_api.rb', line 393

def delete_file_storage_volume_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.delete_file_storage_volume ...'
  end
  # resource path
  local_var_path = '/file_storage_volumes/:file_storage_volume'

  # 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(opts[:'delete_file_storage_volume_request'])

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

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

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

#delete_ip_address(opts = {}) ⇒ Object

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Object)


445
446
447
448
# File 'lib/katapult-ruby/api/core_api.rb', line 445

def delete_ip_address(opts = {})
  data, _status_code, _headers = delete_ip_address_with_http_info(opts)
  data
end

#delete_ip_address_with_http_info(opts = {}) ⇒ Array<(Object, Integer, Hash)>

Returns Object data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Object, Integer, Hash)>)

    Object data, response status code and response headers



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
# File 'lib/katapult-ruby/api/core_api.rb', line 453

def delete_ip_address_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.delete_ip_address ...'
  end
  # resource path
  local_var_path = '/ip_addresses/:ip_address'

  # 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(opts[:'delete_ip_address_request'])

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

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

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

#delete_load_balancer(opts = {}) ⇒ DeleteLoadBalancer200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



505
506
507
508
# File 'lib/katapult-ruby/api/core_api.rb', line 505

def delete_load_balancer(opts = {})
  data, _status_code, _headers = delete_load_balancer_with_http_info(opts)
  data
end

#delete_load_balancer_with_http_info(opts = {}) ⇒ Array<(DeleteLoadBalancer200Response, Integer, Hash)>

Returns DeleteLoadBalancer200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



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
553
554
555
556
557
558
559
560
# File 'lib/katapult-ruby/api/core_api.rb', line 513

def delete_load_balancer_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.delete_load_balancer ...'
  end
  # resource path
  local_var_path = '/load_balancers/:load_balancer'

  # 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(opts[:'delete_load_balancer_request'])

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

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

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

#delete_load_balancers_rules_load_balancer_rule(opts = {}) ⇒ DeleteLoadBalancersRulesLoadBalancerRule200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



565
566
567
568
# File 'lib/katapult-ruby/api/core_api.rb', line 565

def delete_load_balancers_rules_load_balancer_rule(opts = {})
  data, _status_code, _headers = delete_load_balancers_rules_load_balancer_rule_with_http_info(opts)
  data
end

#delete_load_balancers_rules_load_balancer_rule_with_http_info(opts = {}) ⇒ Array<(DeleteLoadBalancersRulesLoadBalancerRule200Response, Integer, Hash)>

Returns DeleteLoadBalancersRulesLoadBalancerRule200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
# File 'lib/katapult-ruby/api/core_api.rb', line 573

def delete_load_balancers_rules_load_balancer_rule_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.delete_load_balancers_rules_load_balancer_rule ...'
  end
  # resource path
  local_var_path = '/load_balancers/rules/:load_balancer_rule'

  # 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(opts[:'delete_load_balancers_rules_load_balancer_rule_request'])

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

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

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

#delete_security_group(opts = {}) ⇒ DeleteSecurityGroup200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



625
626
627
628
# File 'lib/katapult-ruby/api/core_api.rb', line 625

def delete_security_group(opts = {})
  data, _status_code, _headers = delete_security_group_with_http_info(opts)
  data
end

#delete_security_group_with_http_info(opts = {}) ⇒ Array<(DeleteSecurityGroup200Response, Integer, Hash)>

Returns DeleteSecurityGroup200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



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
674
675
676
677
678
679
680
# File 'lib/katapult-ruby/api/core_api.rb', line 633

def delete_security_group_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.delete_security_group ...'
  end
  # resource path
  local_var_path = '/security_groups/:security_group'

  # 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(opts[:'delete_security_group_request'])

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

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

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

#delete_security_groups_rules_security_group_rule(opts = {}) ⇒ DeleteSecurityGroupsRulesSecurityGroupRule200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



685
686
687
688
# File 'lib/katapult-ruby/api/core_api.rb', line 685

def delete_security_groups_rules_security_group_rule(opts = {})
  data, _status_code, _headers = delete_security_groups_rules_security_group_rule_with_http_info(opts)
  data
end

#delete_security_groups_rules_security_group_rule_with_http_info(opts = {}) ⇒ Array<(DeleteSecurityGroupsRulesSecurityGroupRule200Response, Integer, Hash)>

Returns DeleteSecurityGroupsRulesSecurityGroupRule200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
# File 'lib/katapult-ruby/api/core_api.rb', line 693

def delete_security_groups_rules_security_group_rule_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.delete_security_groups_rules_security_group_rule ...'
  end
  # resource path
  local_var_path = '/security_groups/rules/:security_group_rule'

  # 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(opts[:'delete_security_groups_rules_security_group_rule_request'])

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

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

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

#delete_ssh_key(opts = {}) ⇒ PostOrganizationSshKeys201Response

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



745
746
747
748
# File 'lib/katapult-ruby/api/core_api.rb', line 745

def delete_ssh_key(opts = {})
  data, _status_code, _headers = delete_ssh_key_with_http_info(opts)
  data
end

#delete_ssh_key_with_http_info(opts = {}) ⇒ Array<(PostOrganizationSshKeys201Response, Integer, Hash)>

Returns PostOrganizationSshKeys201Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
# File 'lib/katapult-ruby/api/core_api.rb', line 753

def delete_ssh_key_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.delete_ssh_key ...'
  end
  # resource path
  local_var_path = '/ssh_keys/:ssh_key'

  # 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(opts[:'delete_ssh_key_request'])

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

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

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

#delete_tag(opts = {}) ⇒ DeleteTag200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



805
806
807
808
# File 'lib/katapult-ruby/api/core_api.rb', line 805

def delete_tag(opts = {})
  data, _status_code, _headers = delete_tag_with_http_info(opts)
  data
end

#delete_tag_with_http_info(opts = {}) ⇒ Array<(DeleteTag200Response, Integer, Hash)>

Returns DeleteTag200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(DeleteTag200Response, Integer, Hash)>)

    DeleteTag200Response data, response status code and response headers



813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
# File 'lib/katapult-ruby/api/core_api.rb', line 813

def delete_tag_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.delete_tag ...'
  end
  # resource path
  local_var_path = '/tags/:tag'

  # 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(opts[:'delete_tag_request'])

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

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

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

#delete_trash_object(opts = {}) ⇒ PutVirtualMachinePackage200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



865
866
867
868
# File 'lib/katapult-ruby/api/core_api.rb', line 865

def delete_trash_object(opts = {})
  data, _status_code, _headers = delete_trash_object_with_http_info(opts)
  data
end

#delete_trash_object_with_http_info(opts = {}) ⇒ Array<(PutVirtualMachinePackage200Response, Integer, Hash)>

Returns PutVirtualMachinePackage200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
# File 'lib/katapult-ruby/api/core_api.rb', line 873

def delete_trash_object_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.delete_trash_object ...'
  end
  # resource path
  local_var_path = '/trash_objects/:trash_object'

  # 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(opts[:'delete_trash_object_request'])

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

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

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

#delete_virtual_machine(opts = {}) ⇒ DeleteVirtualMachine200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



925
926
927
928
# File 'lib/katapult-ruby/api/core_api.rb', line 925

def delete_virtual_machine(opts = {})
  data, _status_code, _headers = delete_virtual_machine_with_http_info(opts)
  data
end

#delete_virtual_machine_group(opts = {}) ⇒ DeleteVirtualMachineGroup200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



985
986
987
988
# File 'lib/katapult-ruby/api/core_api.rb', line 985

def delete_virtual_machine_group(opts = {})
  data, _status_code, _headers = delete_virtual_machine_group_with_http_info(opts)
  data
end

#delete_virtual_machine_group_with_http_info(opts = {}) ⇒ Array<(DeleteVirtualMachineGroup200Response, Integer, Hash)>

Returns DeleteVirtualMachineGroup200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
# File 'lib/katapult-ruby/api/core_api.rb', line 993

def delete_virtual_machine_group_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.delete_virtual_machine_group ...'
  end
  # resource path
  local_var_path = '/virtual_machine_groups/:virtual_machine_group'

  # 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(opts[:'delete_virtual_machine_group_request'])

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

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

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

#delete_virtual_machine_with_http_info(opts = {}) ⇒ Array<(DeleteVirtualMachine200Response, Integer, Hash)>

Returns DeleteVirtualMachine200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
# File 'lib/katapult-ruby/api/core_api.rb', line 933

def delete_virtual_machine_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.delete_virtual_machine ...'
  end
  # resource path
  local_var_path = '/virtual_machines/:virtual_machine'

  # 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(opts[:'delete_virtual_machine_request'])

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

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

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

#get_address_list(opts = {}) ⇒ PostOrganizationAddressLists201Response

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :address_list_id (String)

    The address list to return. All &#39;address_list[]&#39; params are mutually exclusive, only one can be provided.

Returns:



1045
1046
1047
1048
# File 'lib/katapult-ruby/api/core_api.rb', line 1045

def get_address_list(opts = {})
  data, _status_code, _headers = get_address_list_with_http_info(opts)
  data
end

#get_address_list_entries(opts = {}) ⇒ GetAddressListEntries200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :address_list_id (String)

    The address list for which the entries should be returned. All &#39;address_list[]&#39; params are mutually exclusive, only one can be provided.

  • :page (Integer)
  • :per_page (Integer)

Returns:



1103
1104
1105
1106
# File 'lib/katapult-ruby/api/core_api.rb', line 1103

def get_address_list_entries(opts = {})
  data, _status_code, _headers = get_address_list_entries_with_http_info(opts)
  data
end

#get_address_list_entries_with_http_info(opts = {}) ⇒ Array<(GetAddressListEntries200Response, Integer, Hash)>

Returns GetAddressListEntries200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :address_list_id (String)

    The address list for which the entries should be returned. All &#39;address_list[]&#39; params are mutually exclusive, only one can be provided.

  • :page (Integer)
  • :per_page (Integer)

Returns:



1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
# File 'lib/katapult-ruby/api/core_api.rb', line 1113

def get_address_list_entries_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_address_list_entries ...'
  end
  # resource path
  local_var_path = '/address_lists/:address_list/entries'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'address_list[id]'] = opts[:'address_list_id'] if !opts[:'address_list_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].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] || 'GetAddressListEntries200Response'

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

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

#get_address_list_entry(opts = {}) ⇒ PostAddressListEntries201Response

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :address_list_entry_id (String)

    The address list entry to return. All &#39;address_list_entry[]&#39; params are mutually exclusive, only one can be provided.

Returns:



1163
1164
1165
1166
# File 'lib/katapult-ruby/api/core_api.rb', line 1163

def get_address_list_entry(opts = {})
  data, _status_code, _headers = get_address_list_entry_with_http_info(opts)
  data
end

#get_address_list_entry_with_http_info(opts = {}) ⇒ Array<(PostAddressListEntries201Response, Integer, Hash)>

Returns PostAddressListEntries201Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :address_list_entry_id (String)

    The address list entry to return. All &#39;address_list_entry[]&#39; params are mutually exclusive, only one can be provided.

Returns:



1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
# File 'lib/katapult-ruby/api/core_api.rb', line 1171

def get_address_list_entry_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_address_list_entry ...'
  end
  # resource path
  local_var_path = '/address_list_entries/:address_list_entry'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'address_list_entry[id]'] = opts[:'address_list_entry_id'] if !opts[:'address_list_entry_id'].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] || 'PostAddressListEntries201Response'

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

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

#get_address_list_with_http_info(opts = {}) ⇒ Array<(PostOrganizationAddressLists201Response, Integer, Hash)>

Returns PostOrganizationAddressLists201Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :address_list_id (String)

    The address list to return. All &#39;address_list[]&#39; params are mutually exclusive, only one can be provided.

Returns:



1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
# File 'lib/katapult-ruby/api/core_api.rb', line 1053

def get_address_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_address_list ...'
  end
  # resource path
  local_var_path = '/address_lists/:address_list'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'address_list[id]'] = opts[:'address_list_id'] if !opts[:'address_list_id'].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] || 'PostOrganizationAddressLists201Response'

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

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

#get_address_lists(opts = {}) ⇒ GetAddressLists200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer)
  • :per_page (Integer)

Returns:



1220
1221
1222
1223
# File 'lib/katapult-ruby/api/core_api.rb', line 1220

def get_address_lists(opts = {})
  data, _status_code, _headers = get_address_lists_with_http_info(opts)
  data
end

#get_address_lists_with_http_info(opts = {}) ⇒ Array<(GetAddressLists200Response, Integer, Hash)>

Returns GetAddressLists200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer)
  • :per_page (Integer)

Returns:

  • (Array<(GetAddressLists200Response, Integer, Hash)>)

    GetAddressLists200Response data, response status code and response headers



1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
# File 'lib/katapult-ruby/api/core_api.rb', line 1229

def get_address_lists_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_address_lists ...'
  end
  # resource path
  local_var_path = '/address_lists'

  # 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?

  # 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] || 'GetAddressLists200Response'

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

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

#get_certificate(opts = {}) ⇒ GetCertificate200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :certificate_id (String)

    All &#39;certificate[]&#39; params are mutually exclusive, only one can be provided.

Returns:



1278
1279
1280
1281
# File 'lib/katapult-ruby/api/core_api.rb', line 1278

def get_certificate(opts = {})
  data, _status_code, _headers = get_certificate_with_http_info(opts)
  data
end

#get_certificate_with_http_info(opts = {}) ⇒ Array<(GetCertificate200Response, Integer, Hash)>

Returns GetCertificate200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :certificate_id (String)

    All &#39;certificate[]&#39; params are mutually exclusive, only one can be provided.

Returns:

  • (Array<(GetCertificate200Response, Integer, Hash)>)

    GetCertificate200Response data, response status code and response headers



1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
# File 'lib/katapult-ruby/api/core_api.rb', line 1286

def get_certificate_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_certificate ...'
  end
  # resource path
  local_var_path = '/certificates/:certificate'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'certificate[id]'] = opts[:'certificate_id'] if !opts[:'certificate_id'].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] || 'GetCertificate200Response'

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

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

#get_countries(opts = {}) ⇒ GetCountries200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer)
  • :per_page (Integer)

Returns:



1335
1336
1337
1338
# File 'lib/katapult-ruby/api/core_api.rb', line 1335

def get_countries(opts = {})
  data, _status_code, _headers = get_countries_with_http_info(opts)
  data
end

#get_countries_with_http_info(opts = {}) ⇒ Array<(GetCountries200Response, Integer, Hash)>

Returns GetCountries200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer)
  • :per_page (Integer)

Returns:

  • (Array<(GetCountries200Response, Integer, Hash)>)

    GetCountries200Response data, response status code and response headers



1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
# File 'lib/katapult-ruby/api/core_api.rb', line 1344

def get_countries_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_countries ...'
  end
  # resource path
  local_var_path = '/countries'

  # 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?

  # 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] || 'GetCountries200Response'

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

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

#get_country(opts = {}) ⇒ GetCountry200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :country_id (String)

    The country to return. All &#39;country[]&#39; params are mutually exclusive, only one can be provided.

  • :country_iso_code2 (String)

    The country to return. All &#39;country[]&#39; params are mutually exclusive, only one can be provided.

  • :country_iso_code3 (String)

    The country to return. All &#39;country[]&#39; params are mutually exclusive, only one can be provided.

Returns:



1395
1396
1397
1398
# File 'lib/katapult-ruby/api/core_api.rb', line 1395

def get_country(opts = {})
  data, _status_code, _headers = get_country_with_http_info(opts)
  data
end

#get_country_country_states(opts = {}) ⇒ GetCountryCountryStates200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :country_id (String)

    The country to return states for. All &#39;country[]&#39; params are mutually exclusive, only one can be provided.

  • :country_iso_code2 (String)

    The country to return states for. All &#39;country[]&#39; params are mutually exclusive, only one can be provided.

  • :country_iso_code3 (String)

    The country to return states for. All &#39;country[]&#39; params are mutually exclusive, only one can be provided.

  • :page (Integer)
  • :per_page (Integer)

Returns:



1459
1460
1461
1462
# File 'lib/katapult-ruby/api/core_api.rb', line 1459

def get_country_country_states(opts = {})
  data, _status_code, _headers = get_country_country_states_with_http_info(opts)
  data
end

#get_country_country_states_with_http_info(opts = {}) ⇒ Array<(GetCountryCountryStates200Response, Integer, Hash)>

Returns GetCountryCountryStates200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :country_id (String)

    The country to return states for. All &#39;country[]&#39; params are mutually exclusive, only one can be provided.

  • :country_iso_code2 (String)

    The country to return states for. All &#39;country[]&#39; params are mutually exclusive, only one can be provided.

  • :country_iso_code3 (String)

    The country to return states for. All &#39;country[]&#39; params are mutually exclusive, only one can be provided.

  • :page (Integer)
  • :per_page (Integer)

Returns:



1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
# File 'lib/katapult-ruby/api/core_api.rb', line 1471

def get_country_country_states_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_country_country_states ...'
  end
  # resource path
  local_var_path = '/countries/:country/country_states'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'country[id]'] = opts[:'country_id'] if !opts[:'country_id'].nil?
  query_params[:'country[iso_code2]'] = opts[:'country_iso_code2'] if !opts[:'country_iso_code2'].nil?
  query_params[:'country[iso_code3]'] = opts[:'country_iso_code3'] if !opts[:'country_iso_code3'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].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] || 'GetCountryCountryStates200Response'

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

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

#get_country_state(opts = {}) ⇒ GetCountryState200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :country_state_id (String)

    The country state to return. All &#39;country_state[]&#39; params are mutually exclusive, only one can be provided.

Returns:



1523
1524
1525
1526
# File 'lib/katapult-ruby/api/core_api.rb', line 1523

def get_country_state(opts = {})
  data, _status_code, _headers = get_country_state_with_http_info(opts)
  data
end

#get_country_state_with_http_info(opts = {}) ⇒ Array<(GetCountryState200Response, Integer, Hash)>

Returns GetCountryState200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :country_state_id (String)

    The country state to return. All &#39;country_state[]&#39; params are mutually exclusive, only one can be provided.

Returns:

  • (Array<(GetCountryState200Response, Integer, Hash)>)

    GetCountryState200Response data, response status code and response headers



1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
# File 'lib/katapult-ruby/api/core_api.rb', line 1531

def get_country_state_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_country_state ...'
  end
  # resource path
  local_var_path = '/country_states/:country_state'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'country_state[id]'] = opts[:'country_state_id'] if !opts[:'country_state_id'].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] || 'GetCountryState200Response'

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

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

#get_country_with_http_info(opts = {}) ⇒ Array<(GetCountry200Response, Integer, Hash)>

Returns GetCountry200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :country_id (String)

    The country to return. All &#39;country[]&#39; params are mutually exclusive, only one can be provided.

  • :country_iso_code2 (String)

    The country to return. All &#39;country[]&#39; params are mutually exclusive, only one can be provided.

  • :country_iso_code3 (String)

    The country to return. All &#39;country[]&#39; params are mutually exclusive, only one can be provided.

Returns:

  • (Array<(GetCountry200Response, Integer, Hash)>)

    GetCountry200Response data, response status code and response headers



1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
# File 'lib/katapult-ruby/api/core_api.rb', line 1405

def get_country_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_country ...'
  end
  # resource path
  local_var_path = '/countries/:country'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'country[id]'] = opts[:'country_id'] if !opts[:'country_id'].nil?
  query_params[:'country[iso_code2]'] = opts[:'country_iso_code2'] if !opts[:'country_iso_code2'].nil?
  query_params[:'country[iso_code3]'] = opts[:'country_iso_code3'] if !opts[:'country_iso_code3'].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] || 'GetCountry200Response'

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

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

#get_currencies(opts = {}) ⇒ GetCurrencies200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer)
  • :per_page (Integer)

Returns:



1580
1581
1582
1583
# File 'lib/katapult-ruby/api/core_api.rb', line 1580

def get_currencies(opts = {})
  data, _status_code, _headers = get_currencies_with_http_info(opts)
  data
end

#get_currencies_with_http_info(opts = {}) ⇒ Array<(GetCurrencies200Response, Integer, Hash)>

Returns GetCurrencies200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer)
  • :per_page (Integer)

Returns:

  • (Array<(GetCurrencies200Response, Integer, Hash)>)

    GetCurrencies200Response data, response status code and response headers



1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
# File 'lib/katapult-ruby/api/core_api.rb', line 1589

def get_currencies_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_currencies ...'
  end
  # resource path
  local_var_path = '/currencies'

  # 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?

  # 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] || 'GetCurrencies200Response'

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

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

#get_currency(opts = {}) ⇒ GetCurrency200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :currency_id (String)

    The currency to return. All &#39;currency[]&#39; params are mutually exclusive, only one can be provided.

  • :currency_iso_code (String)

    The currency to return. All &#39;currency[]&#39; params are mutually exclusive, only one can be provided.

Returns:



1639
1640
1641
1642
# File 'lib/katapult-ruby/api/core_api.rb', line 1639

def get_currency(opts = {})
  data, _status_code, _headers = get_currency_with_http_info(opts)
  data
end

#get_currency_with_http_info(opts = {}) ⇒ Array<(GetCurrency200Response, Integer, Hash)>

Returns GetCurrency200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :currency_id (String)

    The currency to return. All &#39;currency[]&#39; params are mutually exclusive, only one can be provided.

  • :currency_iso_code (String)

    The currency to return. All &#39;currency[]&#39; params are mutually exclusive, only one can be provided.

Returns:

  • (Array<(GetCurrency200Response, Integer, Hash)>)

    GetCurrency200Response data, response status code and response headers



1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
# File 'lib/katapult-ruby/api/core_api.rb', line 1648

def get_currency_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_currency ...'
  end
  # resource path
  local_var_path = '/currencies/:currency'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'currency[id]'] = opts[:'currency_id'] if !opts[:'currency_id'].nil?
  query_params[:'currency[iso_code]'] = opts[:'currency_iso_code'] if !opts[:'currency_iso_code'].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] || 'GetCurrency200Response'

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

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

#get_data_center(opts = {}) ⇒ GetDataCenter200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :data_center_id (String)

    All &#39;data_center[]&#39; params are mutually exclusive, only one can be provided.

  • :data_center_permalink (String)

    All &#39;data_center[]&#39; params are mutually exclusive, only one can be provided.

Returns:



1698
1699
1700
1701
# File 'lib/katapult-ruby/api/core_api.rb', line 1698

def get_data_center(opts = {})
  data, _status_code, _headers = get_data_center_with_http_info(opts)
  data
end

#get_data_center_default_network(opts = {}) ⇒ GetDataCenterDefaultNetwork200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :data_center_id (String)

    All &#39;data_center[]&#39; params are mutually exclusive, only one can be provided.

  • :data_center_permalink (String)

    All &#39;data_center[]&#39; params are mutually exclusive, only one can be provided.

Returns:



1757
1758
1759
1760
# File 'lib/katapult-ruby/api/core_api.rb', line 1757

def get_data_center_default_network(opts = {})
  data, _status_code, _headers = get_data_center_default_network_with_http_info(opts)
  data
end

#get_data_center_default_network_with_http_info(opts = {}) ⇒ Array<(GetDataCenterDefaultNetwork200Response, Integer, Hash)>

Returns GetDataCenterDefaultNetwork200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :data_center_id (String)

    All &#39;data_center[]&#39; params are mutually exclusive, only one can be provided.

  • :data_center_permalink (String)

    All &#39;data_center[]&#39; params are mutually exclusive, only one can be provided.

Returns:



1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
# File 'lib/katapult-ruby/api/core_api.rb', line 1766

def get_data_center_default_network_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_data_center_default_network ...'
  end
  # resource path
  local_var_path = '/data_centers/:data_center/default_network'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'data_center[id]'] = opts[:'data_center_id'] if !opts[:'data_center_id'].nil?
  query_params[:'data_center[permalink]'] = opts[:'data_center_permalink'] if !opts[:'data_center_permalink'].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] || 'GetDataCenterDefaultNetwork200Response'

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

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

#get_data_center_gpu_types(opts = {}) ⇒ GetDataCenterGpuTypes200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :data_center_id (String)

    The data center to list GPU types for. All &#39;data_center[]&#39; params are mutually exclusive, only one can be provided.

  • :data_center_permalink (String)

    The data center to list GPU types for. All &#39;data_center[]&#39; params are mutually exclusive, only one can be provided.

  • :page (Integer)
  • :per_page (Integer)

Returns:



1818
1819
1820
1821
# File 'lib/katapult-ruby/api/core_api.rb', line 1818

def get_data_center_gpu_types(opts = {})
  data, _status_code, _headers = get_data_center_gpu_types_with_http_info(opts)
  data
end

#get_data_center_gpu_types_with_http_info(opts = {}) ⇒ Array<(GetDataCenterGpuTypes200Response, Integer, Hash)>

Returns GetDataCenterGpuTypes200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :data_center_id (String)

    The data center to list GPU types for. All &#39;data_center[]&#39; params are mutually exclusive, only one can be provided.

  • :data_center_permalink (String)

    The data center to list GPU types for. All &#39;data_center[]&#39; params are mutually exclusive, only one can be provided.

  • :page (Integer)
  • :per_page (Integer)

Returns:



1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
# File 'lib/katapult-ruby/api/core_api.rb', line 1829

def get_data_center_gpu_types_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_data_center_gpu_types ...'
  end
  # resource path
  local_var_path = '/data_centers/:data_center/gpu_types'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'data_center[id]'] = opts[:'data_center_id'] if !opts[:'data_center_id'].nil?
  query_params[:'data_center[permalink]'] = opts[:'data_center_permalink'] if !opts[:'data_center_permalink'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].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] || 'GetDataCenterGpuTypes200Response'

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

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

#get_data_center_with_http_info(opts = {}) ⇒ Array<(GetDataCenter200Response, Integer, Hash)>

Returns GetDataCenter200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :data_center_id (String)

    All &#39;data_center[]&#39; params are mutually exclusive, only one can be provided.

  • :data_center_permalink (String)

    All &#39;data_center[]&#39; params are mutually exclusive, only one can be provided.

Returns:

  • (Array<(GetDataCenter200Response, Integer, Hash)>)

    GetDataCenter200Response data, response status code and response headers



1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
# File 'lib/katapult-ruby/api/core_api.rb', line 1707

def get_data_center_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_data_center ...'
  end
  # resource path
  local_var_path = '/data_centers/:data_center'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'data_center[id]'] = opts[:'data_center_id'] if !opts[:'data_center_id'].nil?
  query_params[:'data_center[permalink]'] = opts[:'data_center_permalink'] if !opts[:'data_center_permalink'].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] || 'GetDataCenter200Response'

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

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

#get_data_centers(opts = {}) ⇒ GetDataCenters200Response

Parameters:

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

    the optional parameters

Returns:



1879
1880
1881
1882
# File 'lib/katapult-ruby/api/core_api.rb', line 1879

def get_data_centers(opts = {})
  data, _status_code, _headers = get_data_centers_with_http_info(opts)
  data
end

#get_data_centers_with_http_info(opts = {}) ⇒ Array<(GetDataCenters200Response, Integer, Hash)>

Returns GetDataCenters200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(GetDataCenters200Response, Integer, Hash)>)

    GetDataCenters200Response data, response status code and response headers



1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
# File 'lib/katapult-ruby/api/core_api.rb', line 1886

def get_data_centers_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_data_centers ...'
  end
  # resource path
  local_var_path = '/data_centers'

  # 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] || 'GetDataCenters200Response'

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

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

#get_disk(opts = {}) ⇒ GetDisk200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :disk_id (String)

    The disk to return. All &#39;disk[]&#39; params are mutually exclusive, only one can be provided.

Returns:



1933
1934
1935
1936
# File 'lib/katapult-ruby/api/core_api.rb', line 1933

def get_disk(opts = {})
  data, _status_code, _headers = get_disk_with_http_info(opts)
  data
end

#get_disk_backup_policy(opts = {}) ⇒ GetDiskBackupPolicy200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :disk_backup_policy_id (String)

    The disk backup policy to get information for. All &#39;disk_backup_policy[]&#39; params are mutually exclusive, only one can be provided.

Returns:



1989
1990
1991
1992
# File 'lib/katapult-ruby/api/core_api.rb', line 1989

def get_disk_backup_policy(opts = {})
  data, _status_code, _headers = get_disk_backup_policy_with_http_info(opts)
  data
end

#get_disk_backup_policy_with_http_info(opts = {}) ⇒ Array<(GetDiskBackupPolicy200Response, Integer, Hash)>

Returns GetDiskBackupPolicy200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :disk_backup_policy_id (String)

    The disk backup policy to get information for. All &#39;disk_backup_policy[]&#39; params are mutually exclusive, only one can be provided.

Returns:



1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
# File 'lib/katapult-ruby/api/core_api.rb', line 1997

def get_disk_backup_policy_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_disk_backup_policy ...'
  end
  # resource path
  local_var_path = '/disk_backup_policies/:disk_backup_policy'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'disk_backup_policy[id]'] = opts[:'disk_backup_policy_id'] if !opts[:'disk_backup_policy_id'].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] || 'GetDiskBackupPolicy200Response'

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

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

#get_disk_disk_backup_policies(opts = {}) ⇒ GetDiskDiskBackupPolicies200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :disk_id (String)

    The disk to return disk backup policies for. All &#39;disk[]&#39; params are mutually exclusive, only one can be provided.

  • :page (Integer)
  • :per_page (Integer)

Returns:



2047
2048
2049
2050
# File 'lib/katapult-ruby/api/core_api.rb', line 2047

def get_disk_disk_backup_policies(opts = {})
  data, _status_code, _headers = get_disk_disk_backup_policies_with_http_info(opts)
  data
end

#get_disk_disk_backup_policies_with_http_info(opts = {}) ⇒ Array<(GetDiskDiskBackupPolicies200Response, Integer, Hash)>

Returns GetDiskDiskBackupPolicies200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :disk_id (String)

    The disk to return disk backup policies for. All &#39;disk[]&#39; params are mutually exclusive, only one can be provided.

  • :page (Integer)
  • :per_page (Integer)

Returns:



2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
# File 'lib/katapult-ruby/api/core_api.rb', line 2057

def get_disk_disk_backup_policies_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_disk_disk_backup_policies ...'
  end
  # resource path
  local_var_path = '/disks/:disk/disk_backup_policies'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'disk[id]'] = opts[:'disk_id'] if !opts[:'disk_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].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] || 'GetDiskDiskBackupPolicies200Response'

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

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

#get_disk_template(opts = {}) ⇒ GetDiskTemplate200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :disk_template_id (String)

    The disk template to return. All &#39;disk_template[]&#39; params are mutually exclusive, only one can be provided.

  • :disk_template_permalink (String)

    The disk template to return. All &#39;disk_template[]&#39; params are mutually exclusive, only one can be provided.

Returns:



2108
2109
2110
2111
# File 'lib/katapult-ruby/api/core_api.rb', line 2108

def get_disk_template(opts = {})
  data, _status_code, _headers = get_disk_template_with_http_info(opts)
  data
end

#get_disk_template_version(opts = {}) ⇒ GetDiskTemplateVersion200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :disk_template_version_id (String)

    The disk template version to return. All &#39;disk_template_version[]&#39; params are mutually exclusive, only one can be provided.

Returns:



2166
2167
2168
2169
# File 'lib/katapult-ruby/api/core_api.rb', line 2166

def get_disk_template_version(opts = {})
  data, _status_code, _headers = get_disk_template_version_with_http_info(opts)
  data
end

#get_disk_template_version_spec(opts = {}) ⇒ GetDiskTemplateVersionSpec200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :disk_template_version_id (String)

    The disk template version to return. All &#39;disk_template_version[]&#39; params are mutually exclusive, only one can be provided.

Returns:



2222
2223
2224
2225
# File 'lib/katapult-ruby/api/core_api.rb', line 2222

def get_disk_template_version_spec(opts = {})
  data, _status_code, _headers = get_disk_template_version_spec_with_http_info(opts)
  data
end

#get_disk_template_version_spec_with_http_info(opts = {}) ⇒ Array<(GetDiskTemplateVersionSpec200Response, Integer, Hash)>

Returns GetDiskTemplateVersionSpec200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :disk_template_version_id (String)

    The disk template version to return. All &#39;disk_template_version[]&#39; params are mutually exclusive, only one can be provided.

Returns:



2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
# File 'lib/katapult-ruby/api/core_api.rb', line 2230

def get_disk_template_version_spec_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_disk_template_version_spec ...'
  end
  # resource path
  local_var_path = '/disk_template_versions/:disk_template_version/spec'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'disk_template_version[id]'] = opts[:'disk_template_version_id'] if !opts[:'disk_template_version_id'].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] || 'GetDiskTemplateVersionSpec200Response'

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

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

#get_disk_template_version_with_http_info(opts = {}) ⇒ Array<(GetDiskTemplateVersion200Response, Integer, Hash)>

Returns GetDiskTemplateVersion200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :disk_template_version_id (String)

    The disk template version to return. All &#39;disk_template_version[]&#39; params are mutually exclusive, only one can be provided.

Returns:



2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
# File 'lib/katapult-ruby/api/core_api.rb', line 2174

def get_disk_template_version_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_disk_template_version ...'
  end
  # resource path
  local_var_path = '/disk_template_versions/:disk_template_version'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'disk_template_version[id]'] = opts[:'disk_template_version_id'] if !opts[:'disk_template_version_id'].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] || 'GetDiskTemplateVersion200Response'

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

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

#get_disk_template_versions(opts = {}) ⇒ GetDiskTemplateVersions200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :disk_template_id (String)

    The disk template to return the versions for. All &#39;disk_template[]&#39; params are mutually exclusive, only one can be provided.

  • :disk_template_permalink (String)

    The disk template to return the versions for. All &#39;disk_template[]&#39; params are mutually exclusive, only one can be provided.

  • :page (Integer)
  • :per_page (Integer)

Returns:



2281
2282
2283
2284
# File 'lib/katapult-ruby/api/core_api.rb', line 2281

def get_disk_template_versions(opts = {})
  data, _status_code, _headers = get_disk_template_versions_with_http_info(opts)
  data
end

#get_disk_template_versions_with_http_info(opts = {}) ⇒ Array<(GetDiskTemplateVersions200Response, Integer, Hash)>

Returns GetDiskTemplateVersions200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :disk_template_id (String)

    The disk template to return the versions for. All &#39;disk_template[]&#39; params are mutually exclusive, only one can be provided.

  • :disk_template_permalink (String)

    The disk template to return the versions for. All &#39;disk_template[]&#39; params are mutually exclusive, only one can be provided.

  • :page (Integer)
  • :per_page (Integer)

Returns:



2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
# File 'lib/katapult-ruby/api/core_api.rb', line 2292

def get_disk_template_versions_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_disk_template_versions ...'
  end
  # resource path
  local_var_path = '/disk_templates/:disk_template/versions'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'disk_template[id]'] = opts[:'disk_template_id'] if !opts[:'disk_template_id'].nil?
  query_params[:'disk_template[permalink]'] = opts[:'disk_template_permalink'] if !opts[:'disk_template_permalink'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].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] || 'GetDiskTemplateVersions200Response'

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

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

#get_disk_template_with_http_info(opts = {}) ⇒ Array<(GetDiskTemplate200Response, Integer, Hash)>

Returns GetDiskTemplate200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :disk_template_id (String)

    The disk template to return. All &#39;disk_template[]&#39; params are mutually exclusive, only one can be provided.

  • :disk_template_permalink (String)

    The disk template to return. All &#39;disk_template[]&#39; params are mutually exclusive, only one can be provided.

Returns:

  • (Array<(GetDiskTemplate200Response, Integer, Hash)>)

    GetDiskTemplate200Response data, response status code and response headers



2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
# File 'lib/katapult-ruby/api/core_api.rb', line 2117

def get_disk_template_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_disk_template ...'
  end
  # resource path
  local_var_path = '/disk_templates/:disk_template'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'disk_template[id]'] = opts[:'disk_template_id'] if !opts[:'disk_template_id'].nil?
  query_params[:'disk_template[permalink]'] = opts[:'disk_template_permalink'] if !opts[:'disk_template_permalink'].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] || 'GetDiskTemplate200Response'

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

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

#get_disk_with_http_info(opts = {}) ⇒ Array<(GetDisk200Response, Integer, Hash)>

Returns GetDisk200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :disk_id (String)

    The disk to return. All &#39;disk[]&#39; params are mutually exclusive, only one can be provided.

Returns:

  • (Array<(GetDisk200Response, Integer, Hash)>)

    GetDisk200Response data, response status code and response headers



1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
# File 'lib/katapult-ruby/api/core_api.rb', line 1941

def get_disk_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_disk ...'
  end
  # resource path
  local_var_path = '/disks/:disk'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'disk[id]'] = opts[:'disk_id'] if !opts[:'disk_id'].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] || 'GetDisk200Response'

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

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

#get_dns_record(opts = {}) ⇒ GetDnsRecord200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :dns_record_id (String)

    All &#39;dns_record[]&#39; params are mutually exclusive, only one can be provided.

Returns:



2343
2344
2345
2346
# File 'lib/katapult-ruby/api/core_api.rb', line 2343

def get_dns_record(opts = {})
  data, _status_code, _headers = get_dns_record_with_http_info(opts)
  data
end

#get_dns_record_with_http_info(opts = {}) ⇒ Array<(GetDnsRecord200Response, Integer, Hash)>

Returns GetDnsRecord200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :dns_record_id (String)

    All &#39;dns_record[]&#39; params are mutually exclusive, only one can be provided.

Returns:

  • (Array<(GetDnsRecord200Response, Integer, Hash)>)

    GetDnsRecord200Response data, response status code and response headers



2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
# File 'lib/katapult-ruby/api/core_api.rb', line 2351

def get_dns_record_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_dns_record ...'
  end
  # resource path
  local_var_path = '/dns_records/:dns_record'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'dns_record[id]'] = opts[:'dns_record_id'] if !opts[:'dns_record_id'].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] || 'GetDnsRecord200Response'

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

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

#get_dns_zone(opts = {}) ⇒ GetDnsZone200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :dns_zone_id (String)

    All &#39;dns_zone[]&#39; params are mutually exclusive, only one can be provided.

  • :dns_zone_name (String)

    All &#39;dns_zone[]&#39; params are mutually exclusive, only one can be provided.

Returns:



2400
2401
2402
2403
# File 'lib/katapult-ruby/api/core_api.rb', line 2400

def get_dns_zone(opts = {})
  data, _status_code, _headers = get_dns_zone_with_http_info(opts)
  data
end

#get_dns_zone_records(opts = {}) ⇒ GetDnsZoneRecords200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :dns_zone_id (String)

    All &#39;dns_zone[]&#39; params are mutually exclusive, only one can be provided.

  • :dns_zone_name (String)

    All &#39;dns_zone[]&#39; params are mutually exclusive, only one can be provided.

Returns:



2459
2460
2461
2462
# File 'lib/katapult-ruby/api/core_api.rb', line 2459

def get_dns_zone_records(opts = {})
  data, _status_code, _headers = get_dns_zone_records_with_http_info(opts)
  data
end

#get_dns_zone_records_with_http_info(opts = {}) ⇒ Array<(GetDnsZoneRecords200Response, Integer, Hash)>

Returns GetDnsZoneRecords200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :dns_zone_id (String)

    All &#39;dns_zone[]&#39; params are mutually exclusive, only one can be provided.

  • :dns_zone_name (String)

    All &#39;dns_zone[]&#39; params are mutually exclusive, only one can be provided.

Returns:



2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
# File 'lib/katapult-ruby/api/core_api.rb', line 2468

def get_dns_zone_records_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_dns_zone_records ...'
  end
  # resource path
  local_var_path = '/dns_zones/:dns_zone/records'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'dns_zone[id]'] = opts[:'dns_zone_id'] if !opts[:'dns_zone_id'].nil?
  query_params[:'dns_zone[name]'] = opts[:'dns_zone_name'] if !opts[:'dns_zone_name'].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] || 'GetDnsZoneRecords200Response'

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

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

#get_dns_zone_with_http_info(opts = {}) ⇒ Array<(GetDnsZone200Response, Integer, Hash)>

Returns GetDnsZone200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :dns_zone_id (String)

    All &#39;dns_zone[]&#39; params are mutually exclusive, only one can be provided.

  • :dns_zone_name (String)

    All &#39;dns_zone[]&#39; params are mutually exclusive, only one can be provided.

Returns:

  • (Array<(GetDnsZone200Response, Integer, Hash)>)

    GetDnsZone200Response data, response status code and response headers



2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
# File 'lib/katapult-ruby/api/core_api.rb', line 2409

def get_dns_zone_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_dns_zone ...'
  end
  # resource path
  local_var_path = '/dns_zones/:dns_zone'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'dns_zone[id]'] = opts[:'dns_zone_id'] if !opts[:'dns_zone_id'].nil?
  query_params[:'dns_zone[name]'] = opts[:'dns_zone_name'] if !opts[:'dns_zone_name'].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] || 'GetDnsZone200Response'

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

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

#get_file_storage_volume(opts = {}) ⇒ GetFileStorageVolume200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :file_storage_volume_id (String)

    The file storage volume to return. All &#39;file_storage_volume[]&#39; params are mutually exclusive, only one can be provided.

Returns:



2517
2518
2519
2520
# File 'lib/katapult-ruby/api/core_api.rb', line 2517

def get_file_storage_volume(opts = {})
  data, _status_code, _headers = get_file_storage_volume_with_http_info(opts)
  data
end

#get_file_storage_volume_with_http_info(opts = {}) ⇒ Array<(GetFileStorageVolume200Response, Integer, Hash)>

Returns GetFileStorageVolume200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :file_storage_volume_id (String)

    The file storage volume to return. All &#39;file_storage_volume[]&#39; params are mutually exclusive, only one can be provided.

Returns:



2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
# File 'lib/katapult-ruby/api/core_api.rb', line 2525

def get_file_storage_volume_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_file_storage_volume ...'
  end
  # resource path
  local_var_path = '/file_storage_volumes/:file_storage_volume'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'file_storage_volume[id]'] = opts[:'file_storage_volume_id'] if !opts[:'file_storage_volume_id'].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] || 'GetFileStorageVolume200Response'

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

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

#get_gpu_type(opts = {}) ⇒ GetGpuType200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :gpu_type_id (String)

    All &#39;gpu_type[]&#39; params are mutually exclusive, only one can be provided.

  • :gpu_type_permalink (String)

    All &#39;gpu_type[]&#39; params are mutually exclusive, only one can be provided.

Returns:



2574
2575
2576
2577
# File 'lib/katapult-ruby/api/core_api.rb', line 2574

def get_gpu_type(opts = {})
  data, _status_code, _headers = get_gpu_type_with_http_info(opts)
  data
end

#get_gpu_type_with_http_info(opts = {}) ⇒ Array<(GetGpuType200Response, Integer, Hash)>

Returns GetGpuType200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :gpu_type_id (String)

    All &#39;gpu_type[]&#39; params are mutually exclusive, only one can be provided.

  • :gpu_type_permalink (String)

    All &#39;gpu_type[]&#39; params are mutually exclusive, only one can be provided.

Returns:

  • (Array<(GetGpuType200Response, Integer, Hash)>)

    GetGpuType200Response data, response status code and response headers



2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
# File 'lib/katapult-ruby/api/core_api.rb', line 2583

def get_gpu_type_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_gpu_type ...'
  end
  # resource path
  local_var_path = '/gpu_types/:gpu_type'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'gpu_type[id]'] = opts[:'gpu_type_id'] if !opts[:'gpu_type_id'].nil?
  query_params[:'gpu_type[permalink]'] = opts[:'gpu_type_permalink'] if !opts[:'gpu_type_permalink'].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] || 'GetGpuType200Response'

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

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

#get_gpu_types(opts = {}) ⇒ GetGpuTypes200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer)
  • :per_page (Integer)

Returns:



2633
2634
2635
2636
# File 'lib/katapult-ruby/api/core_api.rb', line 2633

def get_gpu_types(opts = {})
  data, _status_code, _headers = get_gpu_types_with_http_info(opts)
  data
end

#get_gpu_types_with_http_info(opts = {}) ⇒ Array<(GetGpuTypes200Response, Integer, Hash)>

Returns GetGpuTypes200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer)
  • :per_page (Integer)

Returns:

  • (Array<(GetGpuTypes200Response, Integer, Hash)>)

    GetGpuTypes200Response data, response status code and response headers



2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
# File 'lib/katapult-ruby/api/core_api.rb', line 2642

def get_gpu_types_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_gpu_types ...'
  end
  # resource path
  local_var_path = '/gpu_types'

  # 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?

  # 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] || 'GetGpuTypes200Response'

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

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

#get_ip_address(opts = {}) ⇒ GetIpAddress200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ip_address_id (String)

    The IP address to find. All &#39;ip_address[]&#39; params are mutually exclusive, only one can be provided.

  • :ip_address_address (String)

    The IP address to find. All &#39;ip_address[]&#39; params are mutually exclusive, only one can be provided.

Returns:



2692
2693
2694
2695
# File 'lib/katapult-ruby/api/core_api.rb', line 2692

def get_ip_address(opts = {})
  data, _status_code, _headers = get_ip_address_with_http_info(opts)
  data
end

#get_ip_address_with_http_info(opts = {}) ⇒ Array<(GetIpAddress200Response, Integer, Hash)>

Returns GetIpAddress200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ip_address_id (String)

    The IP address to find. All &#39;ip_address[]&#39; params are mutually exclusive, only one can be provided.

  • :ip_address_address (String)

    The IP address to find. All &#39;ip_address[]&#39; params are mutually exclusive, only one can be provided.

Returns:

  • (Array<(GetIpAddress200Response, Integer, Hash)>)

    GetIpAddress200Response data, response status code and response headers



2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
# File 'lib/katapult-ruby/api/core_api.rb', line 2701

def get_ip_address_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_ip_address ...'
  end
  # resource path
  local_var_path = '/ip_addresses/:ip_address'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'ip_address[id]'] = opts[:'ip_address_id'] if !opts[:'ip_address_id'].nil?
  query_params[:'ip_address[address]'] = opts[:'ip_address_address'] if !opts[:'ip_address_address'].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] || 'GetIpAddress200Response'

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

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

#get_load_balancer(opts = {}) ⇒ GetLoadBalancer200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :load_balancer_id (String)

    The load balancer to return the details for. All &#39;load_balancer[]&#39; params are mutually exclusive, only one can be provided.

  • :load_balancer_api_reference (String)

    The load balancer to return the details for. All &#39;load_balancer[]&#39; params are mutually exclusive, only one can be provided.

Returns:



2751
2752
2753
2754
# File 'lib/katapult-ruby/api/core_api.rb', line 2751

def get_load_balancer(opts = {})
  data, _status_code, _headers = get_load_balancer_with_http_info(opts)
  data
end

#get_load_balancer_rules(opts = {}) ⇒ GetLoadBalancerRules200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :load_balancer_id (String)

    The load balancer to return all load rules for. All &#39;load_balancer[]&#39; params are mutually exclusive, only one can be provided.

  • :load_balancer_api_reference (String)

    The load balancer to return all load rules for. All &#39;load_balancer[]&#39; params are mutually exclusive, only one can be provided.

  • :page (Integer)
  • :per_page (Integer)

Returns:



2812
2813
2814
2815
# File 'lib/katapult-ruby/api/core_api.rb', line 2812

def get_load_balancer_rules(opts = {})
  data, _status_code, _headers = get_load_balancer_rules_with_http_info(opts)
  data
end

#get_load_balancer_rules_with_http_info(opts = {}) ⇒ Array<(GetLoadBalancerRules200Response, Integer, Hash)>

Returns GetLoadBalancerRules200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :load_balancer_id (String)

    The load balancer to return all load rules for. All &#39;load_balancer[]&#39; params are mutually exclusive, only one can be provided.

  • :load_balancer_api_reference (String)

    The load balancer to return all load rules for. All &#39;load_balancer[]&#39; params are mutually exclusive, only one can be provided.

  • :page (Integer)
  • :per_page (Integer)

Returns:



2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
# File 'lib/katapult-ruby/api/core_api.rb', line 2823

def get_load_balancer_rules_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_load_balancer_rules ...'
  end
  # resource path
  local_var_path = '/load_balancers/:load_balancer/rules'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'load_balancer[id]'] = opts[:'load_balancer_id'] if !opts[:'load_balancer_id'].nil?
  query_params[:'load_balancer[api_reference]'] = opts[:'load_balancer_api_reference'] if !opts[:'load_balancer_api_reference'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].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] || 'GetLoadBalancerRules200Response'

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

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

#get_load_balancer_with_http_info(opts = {}) ⇒ Array<(GetLoadBalancer200Response, Integer, Hash)>

Returns GetLoadBalancer200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :load_balancer_id (String)

    The load balancer to return the details for. All &#39;load_balancer[]&#39; params are mutually exclusive, only one can be provided.

  • :load_balancer_api_reference (String)

    The load balancer to return the details for. All &#39;load_balancer[]&#39; params are mutually exclusive, only one can be provided.

Returns:

  • (Array<(GetLoadBalancer200Response, Integer, Hash)>)

    GetLoadBalancer200Response data, response status code and response headers



2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
# File 'lib/katapult-ruby/api/core_api.rb', line 2760

def get_load_balancer_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_load_balancer ...'
  end
  # resource path
  local_var_path = '/load_balancers/:load_balancer'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'load_balancer[id]'] = opts[:'load_balancer_id'] if !opts[:'load_balancer_id'].nil?
  query_params[:'load_balancer[api_reference]'] = opts[:'load_balancer_api_reference'] if !opts[:'load_balancer_api_reference'].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] || 'GetLoadBalancer200Response'

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

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

#get_load_balancers_rules_load_balancer_rule(opts = {}) ⇒ GetLoadBalancersRulesLoadBalancerRule200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :load_balancer_rule_id (String)

    The load balancer rule to return the details for. All &#39;load_balancer_rule[]&#39; params are mutually exclusive, only one can be provided.

Returns:



2874
2875
2876
2877
# File 'lib/katapult-ruby/api/core_api.rb', line 2874

def get_load_balancers_rules_load_balancer_rule(opts = {})
  data, _status_code, _headers = get_load_balancers_rules_load_balancer_rule_with_http_info(opts)
  data
end

#get_load_balancers_rules_load_balancer_rule_with_http_info(opts = {}) ⇒ Array<(GetLoadBalancersRulesLoadBalancerRule200Response, Integer, Hash)>

Returns GetLoadBalancersRulesLoadBalancerRule200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :load_balancer_rule_id (String)

    The load balancer rule to return the details for. All &#39;load_balancer_rule[]&#39; params are mutually exclusive, only one can be provided.

Returns:



2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
# File 'lib/katapult-ruby/api/core_api.rb', line 2882

def get_load_balancers_rules_load_balancer_rule_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_load_balancers_rules_load_balancer_rule ...'
  end
  # resource path
  local_var_path = '/load_balancers/rules/:load_balancer_rule'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'load_balancer_rule[id]'] = opts[:'load_balancer_rule_id'] if !opts[:'load_balancer_rule_id'].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] || 'GetLoadBalancersRulesLoadBalancerRule200Response'

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

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

#get_network(opts = {}) ⇒ GetNetwork200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :network_id (String)

    The network to return. All &#39;network[]&#39; params are mutually exclusive, only one can be provided.

  • :network_permalink (String)

    The network to return. All &#39;network[]&#39; params are mutually exclusive, only one can be provided.

Returns:



2931
2932
2933
2934
# File 'lib/katapult-ruby/api/core_api.rb', line 2931

def get_network(opts = {})
  data, _status_code, _headers = get_network_with_http_info(opts)
  data
end

#get_network_with_http_info(opts = {}) ⇒ Array<(GetNetwork200Response, Integer, Hash)>

Returns GetNetwork200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :network_id (String)

    The network to return. All &#39;network[]&#39; params are mutually exclusive, only one can be provided.

  • :network_permalink (String)

    The network to return. All &#39;network[]&#39; params are mutually exclusive, only one can be provided.

Returns:

  • (Array<(GetNetwork200Response, Integer, Hash)>)

    GetNetwork200Response data, response status code and response headers



2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
# File 'lib/katapult-ruby/api/core_api.rb', line 2940

def get_network_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_network ...'
  end
  # resource path
  local_var_path = '/networks/:network'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'network[id]'] = opts[:'network_id'] if !opts[:'network_id'].nil?
  query_params[:'network[permalink]'] = opts[:'network_permalink'] if !opts[:'network_permalink'].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] || 'GetNetwork200Response'

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

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

#get_operating_system(opts = {}) ⇒ GetOperatingSystem200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :operating_system_id (String)

    The operating system to return. All &#39;operating_system[]&#39; params are mutually exclusive, only one can be provided.

Returns:



2989
2990
2991
2992
# File 'lib/katapult-ruby/api/core_api.rb', line 2989

def get_operating_system(opts = {})
  data, _status_code, _headers = get_operating_system_with_http_info(opts)
  data
end

#get_operating_system_with_http_info(opts = {}) ⇒ Array<(GetOperatingSystem200Response, Integer, Hash)>

Returns GetOperatingSystem200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :operating_system_id (String)

    The operating system to return. All &#39;operating_system[]&#39; params are mutually exclusive, only one can be provided.

Returns:



2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
# File 'lib/katapult-ruby/api/core_api.rb', line 2997

def get_operating_system_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_operating_system ...'
  end
  # resource path
  local_var_path = '/operating_systems/:operating_system'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'operating_system[id]'] = opts[:'operating_system_id'] if !opts[:'operating_system_id'].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] || 'GetOperatingSystem200Response'

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

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

#get_operating_systems(opts = {}) ⇒ GetOperatingSystems200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer)
  • :per_page (Integer)

Returns:



3046
3047
3048
3049
# File 'lib/katapult-ruby/api/core_api.rb', line 3046

def get_operating_systems(opts = {})
  data, _status_code, _headers = get_operating_systems_with_http_info(opts)
  data
end

#get_operating_systems_with_http_info(opts = {}) ⇒ Array<(GetOperatingSystems200Response, Integer, Hash)>

Returns GetOperatingSystems200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer)
  • :per_page (Integer)

Returns:



3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
# File 'lib/katapult-ruby/api/core_api.rb', line 3055

def get_operating_systems_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_operating_systems ...'
  end
  # resource path
  local_var_path = '/operating_systems'

  # 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?

  # 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] || 'GetOperatingSystems200Response'

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

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

#get_organization(opts = {}) ⇒ GetOrganization200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :organization_id (String)

    All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :organization_sub_domain (String)

    All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

Returns:



3105
3106
3107
3108
# File 'lib/katapult-ruby/api/core_api.rb', line 3105

def get_organization(opts = {})
  data, _status_code, _headers = get_organization_with_http_info(opts)
  data
end

#get_organization_address_lists(opts = {}) ⇒ GetOrganizationAddressLists200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :organization_id (String)

    The organization for which the address lists should be returned. All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :organization_sub_domain (String)

    The organization for which the address lists should be returned. All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :page (Integer)
  • :per_page (Integer)

Returns:



3166
3167
3168
3169
# File 'lib/katapult-ruby/api/core_api.rb', line 3166

def get_organization_address_lists(opts = {})
  data, _status_code, _headers = get_organization_address_lists_with_http_info(opts)
  data
end

#get_organization_address_lists_with_http_info(opts = {}) ⇒ Array<(GetOrganizationAddressLists200Response, Integer, Hash)>

Returns GetOrganizationAddressLists200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :organization_id (String)

    The organization for which the address lists should be returned. All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :organization_sub_domain (String)

    The organization for which the address lists should be returned. All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :page (Integer)
  • :per_page (Integer)

Returns:



3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
# File 'lib/katapult-ruby/api/core_api.rb', line 3177

def get_organization_address_lists_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_organization_address_lists ...'
  end
  # resource path
  local_var_path = '/organizations/:organization/address_lists'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'organization[id]'] = opts[:'organization_id'] if !opts[:'organization_id'].nil?
  query_params[:'organization[sub_domain]'] = opts[:'organization_sub_domain'] if !opts[:'organization_sub_domain'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].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] || 'GetOrganizationAddressLists200Response'

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

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

#get_organization_available_networks(opts = {}) ⇒ GetOrganizationAvailableNetworks200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :organization_id (String)

    All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :organization_sub_domain (String)

    All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

Returns:



3229
3230
3231
3232
# File 'lib/katapult-ruby/api/core_api.rb', line 3229

def get_organization_available_networks(opts = {})
  data, _status_code, _headers = get_organization_available_networks_with_http_info(opts)
  data
end

#get_organization_available_networks_with_http_info(opts = {}) ⇒ Array<(GetOrganizationAvailableNetworks200Response, Integer, Hash)>

Returns GetOrganizationAvailableNetworks200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :organization_id (String)

    All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :organization_sub_domain (String)

    All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

Returns:



3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
# File 'lib/katapult-ruby/api/core_api.rb', line 3238

def get_organization_available_networks_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_organization_available_networks ...'
  end
  # resource path
  local_var_path = '/organizations/:organization/available_networks'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'organization[id]'] = opts[:'organization_id'] if !opts[:'organization_id'].nil?
  query_params[:'organization[sub_domain]'] = opts[:'organization_sub_domain'] if !opts[:'organization_sub_domain'].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] || 'GetOrganizationAvailableNetworks200Response'

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

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

#get_organization_certificates(opts = {}) ⇒ GetOrganizationCertificates200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :organization_id (String)

    All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :organization_sub_domain (String)

    All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :page (Integer)
  • :per_page (Integer)

Returns:



3290
3291
3292
3293
# File 'lib/katapult-ruby/api/core_api.rb', line 3290

def get_organization_certificates(opts = {})
  data, _status_code, _headers = get_organization_certificates_with_http_info(opts)
  data
end

#get_organization_certificates_with_http_info(opts = {}) ⇒ Array<(GetOrganizationCertificates200Response, Integer, Hash)>

Returns GetOrganizationCertificates200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :organization_id (String)

    All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :organization_sub_domain (String)

    All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :page (Integer)
  • :per_page (Integer)

Returns:



3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
# File 'lib/katapult-ruby/api/core_api.rb', line 3301

def get_organization_certificates_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_organization_certificates ...'
  end
  # resource path
  local_var_path = '/organizations/:organization/certificates'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'organization[id]'] = opts[:'organization_id'] if !opts[:'organization_id'].nil?
  query_params[:'organization[sub_domain]'] = opts[:'organization_sub_domain'] if !opts[:'organization_sub_domain'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].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] || 'GetOrganizationCertificates200Response'

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

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

#get_organization_disk_backup_policies(opts = {}) ⇒ GetOrganizationDiskBackupPolicies200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :organization_id (String)

    The organization to return disk backup policies for. All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :organization_sub_domain (String)

    The organization to return disk backup policies for. All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :page (Integer)
  • :per_page (Integer)

Returns:



3355
3356
3357
3358
# File 'lib/katapult-ruby/api/core_api.rb', line 3355

def get_organization_disk_backup_policies(opts = {})
  data, _status_code, _headers = get_organization_disk_backup_policies_with_http_info(opts)
  data
end

#get_organization_disk_backup_policies_with_http_info(opts = {}) ⇒ Array<(GetOrganizationDiskBackupPolicies200Response, Integer, Hash)>

Returns GetOrganizationDiskBackupPolicies200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :organization_id (String)

    The organization to return disk backup policies for. All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :organization_sub_domain (String)

    The organization to return disk backup policies for. All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :page (Integer)
  • :per_page (Integer)

Returns:



3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
# File 'lib/katapult-ruby/api/core_api.rb', line 3366

def get_organization_disk_backup_policies_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_organization_disk_backup_policies ...'
  end
  # resource path
  local_var_path = '/organizations/:organization/disk_backup_policies'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'organization[id]'] = opts[:'organization_id'] if !opts[:'organization_id'].nil?
  query_params[:'organization[sub_domain]'] = opts[:'organization_sub_domain'] if !opts[:'organization_sub_domain'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].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] || 'GetOrganizationDiskBackupPolicies200Response'

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

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

#get_organization_disk_templates(opts = {}) ⇒ GetOrganizationDiskTemplates200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :organization_id (String)

    The organization to find disk templates for. All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :organization_sub_domain (String)

    The organization to find disk templates for. All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :include_universal (Boolean)

    Whether or not to include universal templates

  • :operating_system_id (String)

    An operating system to use to filter disk templates. All &#39;operating_system[]&#39; params are mutually exclusive, only one can be provided.

  • :page (Integer)
  • :per_page (Integer)

Returns:



3422
3423
3424
3425
# File 'lib/katapult-ruby/api/core_api.rb', line 3422

def get_organization_disk_templates(opts = {})
  data, _status_code, _headers = get_organization_disk_templates_with_http_info(opts)
  data
end

#get_organization_disk_templates_with_http_info(opts = {}) ⇒ Array<(GetOrganizationDiskTemplates200Response, Integer, Hash)>

Returns GetOrganizationDiskTemplates200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :organization_id (String)

    The organization to find disk templates for. All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :organization_sub_domain (String)

    The organization to find disk templates for. All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :include_universal (Boolean)

    Whether or not to include universal templates

  • :operating_system_id (String)

    An operating system to use to filter disk templates. All &#39;operating_system[]&#39; params are mutually exclusive, only one can be provided.

  • :page (Integer)
  • :per_page (Integer)

Returns:



3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
# File 'lib/katapult-ruby/api/core_api.rb', line 3435

def get_organization_disk_templates_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_organization_disk_templates ...'
  end
  # resource path
  local_var_path = '/organizations/:organization/disk_templates'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'organization[id]'] = opts[:'organization_id'] if !opts[:'organization_id'].nil?
  query_params[:'organization[sub_domain]'] = opts[:'organization_sub_domain'] if !opts[:'organization_sub_domain'].nil?
  query_params[:'include_universal'] = opts[:'include_universal'] if !opts[:'include_universal'].nil?
  query_params[:'operating_system[id]'] = opts[:'operating_system_id'] if !opts[:'operating_system_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].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] || 'GetOrganizationDiskTemplates200Response'

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

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

#get_organization_disks(opts = {}) ⇒ GetOrganizationDisks200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :organization_id (String)

    The organization to find disks for. All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :organization_sub_domain (String)

    The organization to find disks for. All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :page (Integer)
  • :per_page (Integer)

Returns:



3491
3492
3493
3494
# File 'lib/katapult-ruby/api/core_api.rb', line 3491

def get_organization_disks(opts = {})
  data, _status_code, _headers = get_organization_disks_with_http_info(opts)
  data
end

#get_organization_disks_with_http_info(opts = {}) ⇒ Array<(GetOrganizationDisks200Response, Integer, Hash)>

Returns GetOrganizationDisks200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :organization_id (String)

    The organization to find disks for. All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :organization_sub_domain (String)

    The organization to find disks for. All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :page (Integer)
  • :per_page (Integer)

Returns:



3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
# File 'lib/katapult-ruby/api/core_api.rb', line 3502

def get_organization_disks_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_organization_disks ...'
  end
  # resource path
  local_var_path = '/organizations/:organization/disks'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'organization[id]'] = opts[:'organization_id'] if !opts[:'organization_id'].nil?
  query_params[:'organization[sub_domain]'] = opts[:'organization_sub_domain'] if !opts[:'organization_sub_domain'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].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] || 'GetOrganizationDisks200Response'

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

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

#get_organization_dns_zones(opts = {}) ⇒ GetOrganizationDnsZones200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :organization_id (String)

    All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :organization_sub_domain (String)

    All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :page (Integer)
  • :per_page (Integer)

Returns:



3556
3557
3558
3559
# File 'lib/katapult-ruby/api/core_api.rb', line 3556

def get_organization_dns_zones(opts = {})
  data, _status_code, _headers = get_organization_dns_zones_with_http_info(opts)
  data
end

#get_organization_dns_zones_nameservers(opts = {}) ⇒ GetOrganizationDnsZonesNameservers200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :organization_id (String)

    All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :organization_sub_domain (String)

    All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

Returns:



3619
3620
3621
3622
# File 'lib/katapult-ruby/api/core_api.rb', line 3619

def get_organization_dns_zones_nameservers(opts = {})
  data, _status_code, _headers = get_organization_dns_zones_nameservers_with_http_info(opts)
  data
end

#get_organization_dns_zones_nameservers_with_http_info(opts = {}) ⇒ Array<(GetOrganizationDnsZonesNameservers200Response, Integer, Hash)>

Returns GetOrganizationDnsZonesNameservers200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :organization_id (String)

    All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :organization_sub_domain (String)

    All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

Returns:



3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
# File 'lib/katapult-ruby/api/core_api.rb', line 3628

def get_organization_dns_zones_nameservers_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_organization_dns_zones_nameservers ...'
  end
  # resource path
  local_var_path = '/organizations/:organization/dns_zones/nameservers'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'organization[id]'] = opts[:'organization_id'] if !opts[:'organization_id'].nil?
  query_params[:'organization[sub_domain]'] = opts[:'organization_sub_domain'] if !opts[:'organization_sub_domain'].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] || 'GetOrganizationDnsZonesNameservers200Response'

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

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

#get_organization_dns_zones_with_http_info(opts = {}) ⇒ Array<(GetOrganizationDnsZones200Response, Integer, Hash)>

Returns GetOrganizationDnsZones200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :organization_id (String)

    All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :organization_sub_domain (String)

    All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :page (Integer)
  • :per_page (Integer)

Returns:



3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
# File 'lib/katapult-ruby/api/core_api.rb', line 3567

def get_organization_dns_zones_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_organization_dns_zones ...'
  end
  # resource path
  local_var_path = '/organizations/:organization/dns_zones'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'organization[id]'] = opts[:'organization_id'] if !opts[:'organization_id'].nil?
  query_params[:'organization[sub_domain]'] = opts[:'organization_sub_domain'] if !opts[:'organization_sub_domain'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].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] || 'GetOrganizationDnsZones200Response'

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

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

#get_organization_file_storage_volumes(opts = {}) ⇒ GetOrganizationFileStorageVolumes200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :organization_id (String)

    The organization to return all file storage volumes for. All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :organization_sub_domain (String)

    The organization to return all file storage volumes for. All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :page (Integer)
  • :per_page (Integer)

Returns:



3680
3681
3682
3683
# File 'lib/katapult-ruby/api/core_api.rb', line 3680

def get_organization_file_storage_volumes(opts = {})
  data, _status_code, _headers = get_organization_file_storage_volumes_with_http_info(opts)
  data
end

#get_organization_file_storage_volumes_with_http_info(opts = {}) ⇒ Array<(GetOrganizationFileStorageVolumes200Response, Integer, Hash)>

Returns GetOrganizationFileStorageVolumes200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :organization_id (String)

    The organization to return all file storage volumes for. All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :organization_sub_domain (String)

    The organization to return all file storage volumes for. All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :page (Integer)
  • :per_page (Integer)

Returns:



3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
# File 'lib/katapult-ruby/api/core_api.rb', line 3691

def get_organization_file_storage_volumes_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_organization_file_storage_volumes ...'
  end
  # resource path
  local_var_path = '/organizations/:organization/file_storage_volumes'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'organization[id]'] = opts[:'organization_id'] if !opts[:'organization_id'].nil?
  query_params[:'organization[sub_domain]'] = opts[:'organization_sub_domain'] if !opts[:'organization_sub_domain'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].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] || 'GetOrganizationFileStorageVolumes200Response'

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

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

#get_organization_ip_addresses(opts = {}) ⇒ GetOrganizationIpAddresses200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :organization_id (String)

    The organization to use when looking up IP addresses. All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :organization_sub_domain (String)

    The organization to use when looking up IP addresses. All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :allocated (Boolean)

    If true, only return allocated IP addresss. If false, only return unallocated IP addresses.

  • :page (Integer)
  • :per_page (Integer)

Returns:



3746
3747
3748
3749
# File 'lib/katapult-ruby/api/core_api.rb', line 3746

def get_organization_ip_addresses(opts = {})
  data, _status_code, _headers = get_organization_ip_addresses_with_http_info(opts)
  data
end

#get_organization_ip_addresses_with_http_info(opts = {}) ⇒ Array<(GetOrganizationIpAddresses200Response, Integer, Hash)>

Returns GetOrganizationIpAddresses200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :organization_id (String)

    The organization to use when looking up IP addresses. All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :organization_sub_domain (String)

    The organization to use when looking up IP addresses. All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :allocated (Boolean)

    If true, only return allocated IP addresss. If false, only return unallocated IP addresses.

  • :page (Integer)
  • :per_page (Integer)

Returns:



3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
# File 'lib/katapult-ruby/api/core_api.rb', line 3758

def get_organization_ip_addresses_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_organization_ip_addresses ...'
  end
  # resource path
  local_var_path = '/organizations/:organization/ip_addresses'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'organization[id]'] = opts[:'organization_id'] if !opts[:'organization_id'].nil?
  query_params[:'organization[sub_domain]'] = opts[:'organization_sub_domain'] if !opts[:'organization_sub_domain'].nil?
  query_params[:'allocated'] = opts[:'allocated'] if !opts[:'allocated'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].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] || 'GetOrganizationIpAddresses200Response'

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

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

#get_organization_load_balancers(opts = {}) ⇒ GetOrganizationLoadBalancers200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :organization_id (String)

    The organization to return all load balancers for. All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :organization_sub_domain (String)

    The organization to return all load balancers for. All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :page (Integer)
  • :per_page (Integer)

Returns:



3813
3814
3815
3816
# File 'lib/katapult-ruby/api/core_api.rb', line 3813

def get_organization_load_balancers(opts = {})
  data, _status_code, _headers = get_organization_load_balancers_with_http_info(opts)
  data
end

#get_organization_load_balancers_with_http_info(opts = {}) ⇒ Array<(GetOrganizationLoadBalancers200Response, Integer, Hash)>

Returns GetOrganizationLoadBalancers200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :organization_id (String)

    The organization to return all load balancers for. All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :organization_sub_domain (String)

    The organization to return all load balancers for. All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :page (Integer)
  • :per_page (Integer)

Returns:



3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
# File 'lib/katapult-ruby/api/core_api.rb', line 3824

def get_organization_load_balancers_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_organization_load_balancers ...'
  end
  # resource path
  local_var_path = '/organizations/:organization/load_balancers'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'organization[id]'] = opts[:'organization_id'] if !opts[:'organization_id'].nil?
  query_params[:'organization[sub_domain]'] = opts[:'organization_sub_domain'] if !opts[:'organization_sub_domain'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].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] || 'GetOrganizationLoadBalancers200Response'

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

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

#get_organization_managed(opts = {}) ⇒ GetOrganizationManaged200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :organization_id (String)

    All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :organization_sub_domain (String)

    All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :page (Integer)
  • :per_page (Integer)

Returns:



3878
3879
3880
3881
# File 'lib/katapult-ruby/api/core_api.rb', line 3878

def get_organization_managed(opts = {})
  data, _status_code, _headers = get_organization_managed_with_http_info(opts)
  data
end

#get_organization_managed_with_http_info(opts = {}) ⇒ Array<(GetOrganizationManaged200Response, Integer, Hash)>

Returns GetOrganizationManaged200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :organization_id (String)

    All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :organization_sub_domain (String)

    All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :page (Integer)
  • :per_page (Integer)

Returns:



3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
# File 'lib/katapult-ruby/api/core_api.rb', line 3889

def get_organization_managed_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_organization_managed ...'
  end
  # resource path
  local_var_path = '/organizations/:organization/managed'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'organization[id]'] = opts[:'organization_id'] if !opts[:'organization_id'].nil?
  query_params[:'organization[sub_domain]'] = opts[:'organization_sub_domain'] if !opts[:'organization_sub_domain'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].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] || 'GetOrganizationManaged200Response'

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

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

#get_organization_network_speed_profiles(opts = {}) ⇒ GetOrganizationNetworkSpeedProfiles200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :organization_id (String)

    The organization to use when looking up network speed profiles. All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :organization_sub_domain (String)

    The organization to use when looking up network speed profiles. All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :page (Integer)
  • :per_page (Integer)

Returns:



3943
3944
3945
3946
# File 'lib/katapult-ruby/api/core_api.rb', line 3943

def get_organization_network_speed_profiles(opts = {})
  data, _status_code, _headers = get_organization_network_speed_profiles_with_http_info(opts)
  data
end

#get_organization_network_speed_profiles_with_http_info(opts = {}) ⇒ Array<(GetOrganizationNetworkSpeedProfiles200Response, Integer, Hash)>

Returns GetOrganizationNetworkSpeedProfiles200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :organization_id (String)

    The organization to use when looking up network speed profiles. All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :organization_sub_domain (String)

    The organization to use when looking up network speed profiles. All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :page (Integer)
  • :per_page (Integer)

Returns:



3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
# File 'lib/katapult-ruby/api/core_api.rb', line 3954

def get_organization_network_speed_profiles_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_organization_network_speed_profiles ...'
  end
  # resource path
  local_var_path = '/organizations/:organization/network_speed_profiles'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'organization[id]'] = opts[:'organization_id'] if !opts[:'organization_id'].nil?
  query_params[:'organization[sub_domain]'] = opts[:'organization_sub_domain'] if !opts[:'organization_sub_domain'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].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] || 'GetOrganizationNetworkSpeedProfiles200Response'

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

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

#get_organization_policy_limits(opts = {}) ⇒ GetOrganizationPolicyLimits200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :organization_id (String)

    All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :organization_sub_domain (String)

    All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

Returns:



4006
4007
4008
4009
# File 'lib/katapult-ruby/api/core_api.rb', line 4006

def get_organization_policy_limits(opts = {})
  data, _status_code, _headers = get_organization_policy_limits_with_http_info(opts)
  data
end

#get_organization_policy_limits_with_http_info(opts = {}) ⇒ Array<(GetOrganizationPolicyLimits200Response, Integer, Hash)>

Returns GetOrganizationPolicyLimits200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :organization_id (String)

    All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :organization_sub_domain (String)

    All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

Returns:



4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
# File 'lib/katapult-ruby/api/core_api.rb', line 4015

def get_organization_policy_limits_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_organization_policy_limits ...'
  end
  # resource path
  local_var_path = '/organizations/:organization/policy_limits'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'organization[id]'] = opts[:'organization_id'] if !opts[:'organization_id'].nil?
  query_params[:'organization[sub_domain]'] = opts[:'organization_sub_domain'] if !opts[:'organization_sub_domain'].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] || 'GetOrganizationPolicyLimits200Response'

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

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

#get_organization_security_groups(opts = {}) ⇒ GetOrganizationSecurityGroups200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :organization_id (String)

    The organization to return all security groups for. All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :organization_sub_domain (String)

    The organization to return all security groups for. All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :page (Integer)
  • :per_page (Integer)

Returns:



4067
4068
4069
4070
# File 'lib/katapult-ruby/api/core_api.rb', line 4067

def get_organization_security_groups(opts = {})
  data, _status_code, _headers = get_organization_security_groups_with_http_info(opts)
  data
end

#get_organization_security_groups_with_http_info(opts = {}) ⇒ Array<(GetOrganizationSecurityGroups200Response, Integer, Hash)>

Returns GetOrganizationSecurityGroups200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :organization_id (String)

    The organization to return all security groups for. All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :organization_sub_domain (String)

    The organization to return all security groups for. All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :page (Integer)
  • :per_page (Integer)

Returns:



4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
# File 'lib/katapult-ruby/api/core_api.rb', line 4078

def get_organization_security_groups_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_organization_security_groups ...'
  end
  # resource path
  local_var_path = '/organizations/:organization/security_groups'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'organization[id]'] = opts[:'organization_id'] if !opts[:'organization_id'].nil?
  query_params[:'organization[sub_domain]'] = opts[:'organization_sub_domain'] if !opts[:'organization_sub_domain'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].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] || 'GetOrganizationSecurityGroups200Response'

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

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

#get_organization_ssh_keys(opts = {}) ⇒ GetOrganizationSshKeys200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :organization_id (String)

    The organization to list SSH keys for. All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :organization_sub_domain (String)

    The organization to list SSH keys for. All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :page (Integer)
  • :per_page (Integer)

Returns:



4132
4133
4134
4135
# File 'lib/katapult-ruby/api/core_api.rb', line 4132

def get_organization_ssh_keys(opts = {})
  data, _status_code, _headers = get_organization_ssh_keys_with_http_info(opts)
  data
end

#get_organization_ssh_keys_with_http_info(opts = {}) ⇒ Array<(GetOrganizationSshKeys200Response, Integer, Hash)>

Returns GetOrganizationSshKeys200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :organization_id (String)

    The organization to list SSH keys for. All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :organization_sub_domain (String)

    The organization to list SSH keys for. All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :page (Integer)
  • :per_page (Integer)

Returns:



4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
# File 'lib/katapult-ruby/api/core_api.rb', line 4143

def get_organization_ssh_keys_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_organization_ssh_keys ...'
  end
  # resource path
  local_var_path = '/organizations/:organization/ssh_keys'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'organization[id]'] = opts[:'organization_id'] if !opts[:'organization_id'].nil?
  query_params[:'organization[sub_domain]'] = opts[:'organization_sub_domain'] if !opts[:'organization_sub_domain'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].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] || 'GetOrganizationSshKeys200Response'

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

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

#get_organization_tags(opts = {}) ⇒ GetOrganizationTags200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :organization_id (String)

    The organization to list the tags for. All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :organization_sub_domain (String)

    The organization to list the tags for. All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :page (Integer)
  • :per_page (Integer)

Returns:



4197
4198
4199
4200
# File 'lib/katapult-ruby/api/core_api.rb', line 4197

def get_organization_tags(opts = {})
  data, _status_code, _headers = get_organization_tags_with_http_info(opts)
  data
end

#get_organization_tags_with_http_info(opts = {}) ⇒ Array<(GetOrganizationTags200Response, Integer, Hash)>

Returns GetOrganizationTags200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :organization_id (String)

    The organization to list the tags for. All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :organization_sub_domain (String)

    The organization to list the tags for. All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :page (Integer)
  • :per_page (Integer)

Returns:



4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
# File 'lib/katapult-ruby/api/core_api.rb', line 4208

def get_organization_tags_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_organization_tags ...'
  end
  # resource path
  local_var_path = '/organizations/:organization/tags'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'organization[id]'] = opts[:'organization_id'] if !opts[:'organization_id'].nil?
  query_params[:'organization[sub_domain]'] = opts[:'organization_sub_domain'] if !opts[:'organization_sub_domain'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].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] || 'GetOrganizationTags200Response'

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

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

#get_organization_trash_objects(opts = {}) ⇒ GetOrganizationTrashObjects200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :organization_id (String)

    The organization to find all trash objects for. All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :organization_sub_domain (String)

    The organization to find all trash objects for. All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :page (Integer)
  • :per_page (Integer)

Returns:



4262
4263
4264
4265
# File 'lib/katapult-ruby/api/core_api.rb', line 4262

def get_organization_trash_objects(opts = {})
  data, _status_code, _headers = get_organization_trash_objects_with_http_info(opts)
  data
end

#get_organization_trash_objects_with_http_info(opts = {}) ⇒ Array<(GetOrganizationTrashObjects200Response, Integer, Hash)>

Returns GetOrganizationTrashObjects200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :organization_id (String)

    The organization to find all trash objects for. All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :organization_sub_domain (String)

    The organization to find all trash objects for. All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :page (Integer)
  • :per_page (Integer)

Returns:



4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
# File 'lib/katapult-ruby/api/core_api.rb', line 4273

def get_organization_trash_objects_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_organization_trash_objects ...'
  end
  # resource path
  local_var_path = '/organizations/:organization/trash_objects'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'organization[id]'] = opts[:'organization_id'] if !opts[:'organization_id'].nil?
  query_params[:'organization[sub_domain]'] = opts[:'organization_sub_domain'] if !opts[:'organization_sub_domain'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].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] || 'GetOrganizationTrashObjects200Response'

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

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

#get_organization_users_with_access(opts = {}) ⇒ GetOrganizationUsersWithAccess200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :organization_id (String)

    All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :organization_sub_domain (String)

    All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :page (Integer)
  • :per_page (Integer)

Returns:



4327
4328
4329
4330
# File 'lib/katapult-ruby/api/core_api.rb', line 4327

def get_organization_users_with_access(opts = {})
  data, _status_code, _headers = get_organization_users_with_access_with_http_info(opts)
  data
end

#get_organization_users_with_access_with_http_info(opts = {}) ⇒ Array<(GetOrganizationUsersWithAccess200Response, Integer, Hash)>

Returns GetOrganizationUsersWithAccess200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :organization_id (String)

    All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :organization_sub_domain (String)

    All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :page (Integer)
  • :per_page (Integer)

Returns:



4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
# File 'lib/katapult-ruby/api/core_api.rb', line 4338

def get_organization_users_with_access_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_organization_users_with_access ...'
  end
  # resource path
  local_var_path = '/organizations/:organization/users_with_access'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'organization[id]'] = opts[:'organization_id'] if !opts[:'organization_id'].nil?
  query_params[:'organization[sub_domain]'] = opts[:'organization_sub_domain'] if !opts[:'organization_sub_domain'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].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] || 'GetOrganizationUsersWithAccess200Response'

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

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

#get_organization_virtual_machine_groups(opts = {}) ⇒ GetOrganizationVirtualMachineGroups200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :organization_id (String)

    The organization to return groups for. All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :organization_sub_domain (String)

    The organization to return groups for. All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

Returns:



4390
4391
4392
4393
# File 'lib/katapult-ruby/api/core_api.rb', line 4390

def get_organization_virtual_machine_groups(opts = {})
  data, _status_code, _headers = get_organization_virtual_machine_groups_with_http_info(opts)
  data
end

#get_organization_virtual_machine_groups_with_http_info(opts = {}) ⇒ Array<(GetOrganizationVirtualMachineGroups200Response, Integer, Hash)>

Returns GetOrganizationVirtualMachineGroups200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :organization_id (String)

    The organization to return groups for. All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :organization_sub_domain (String)

    The organization to return groups for. All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

Returns:



4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
# File 'lib/katapult-ruby/api/core_api.rb', line 4399

def get_organization_virtual_machine_groups_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_organization_virtual_machine_groups ...'
  end
  # resource path
  local_var_path = '/organizations/:organization/virtual_machine_groups'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'organization[id]'] = opts[:'organization_id'] if !opts[:'organization_id'].nil?
  query_params[:'organization[sub_domain]'] = opts[:'organization_sub_domain'] if !opts[:'organization_sub_domain'].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] || 'GetOrganizationVirtualMachineGroups200Response'

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

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

#get_organization_virtual_machines(opts = {}) ⇒ GetOrganizationVirtualMachines200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :organization_id (String)

    All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :organization_sub_domain (String)

    All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :page (Integer)
  • :per_page (Integer)

Returns:



4451
4452
4453
4454
# File 'lib/katapult-ruby/api/core_api.rb', line 4451

def get_organization_virtual_machines(opts = {})
  data, _status_code, _headers = get_organization_virtual_machines_with_http_info(opts)
  data
end

#get_organization_virtual_machines_with_http_info(opts = {}) ⇒ Array<(GetOrganizationVirtualMachines200Response, Integer, Hash)>

Returns GetOrganizationVirtualMachines200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :organization_id (String)

    All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :organization_sub_domain (String)

    All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :page (Integer)
  • :per_page (Integer)

Returns:



4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
# File 'lib/katapult-ruby/api/core_api.rb', line 4462

def get_organization_virtual_machines_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_organization_virtual_machines ...'
  end
  # resource path
  local_var_path = '/organizations/:organization/virtual_machines'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'organization[id]'] = opts[:'organization_id'] if !opts[:'organization_id'].nil?
  query_params[:'organization[sub_domain]'] = opts[:'organization_sub_domain'] if !opts[:'organization_sub_domain'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].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] || 'GetOrganizationVirtualMachines200Response'

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

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

#get_organization_with_http_info(opts = {}) ⇒ Array<(GetOrganization200Response, Integer, Hash)>

Returns GetOrganization200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :organization_id (String)

    All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :organization_sub_domain (String)

    All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

Returns:

  • (Array<(GetOrganization200Response, Integer, Hash)>)

    GetOrganization200Response data, response status code and response headers



3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
# File 'lib/katapult-ruby/api/core_api.rb', line 3114

def get_organization_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_organization ...'
  end
  # resource path
  local_var_path = '/organizations/:organization'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'organization[id]'] = opts[:'organization_id'] if !opts[:'organization_id'].nil?
  query_params[:'organization[sub_domain]'] = opts[:'organization_sub_domain'] if !opts[:'organization_sub_domain'].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] || 'GetOrganization200Response'

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

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

#get_organizations(opts = {}) ⇒ GetOrganizations200Response

Parameters:

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

    the optional parameters

Returns:



4512
4513
4514
4515
# File 'lib/katapult-ruby/api/core_api.rb', line 4512

def get_organizations(opts = {})
  data, _status_code, _headers = get_organizations_with_http_info(opts)
  data
end

#get_organizations_with_http_info(opts = {}) ⇒ Array<(GetOrganizations200Response, Integer, Hash)>

Returns GetOrganizations200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(GetOrganizations200Response, Integer, Hash)>)

    GetOrganizations200Response data, response status code and response headers



4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
# File 'lib/katapult-ruby/api/core_api.rb', line 4519

def get_organizations_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_organizations ...'
  end
  # resource path
  local_var_path = '/organizations'

  # 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] || 'GetOrganizations200Response'

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

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

#get_security_group(opts = {}) ⇒ GetSecurityGroup200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :security_group_id (String)

    The security group to return the details for. All &#39;security_group[]&#39; params are mutually exclusive, only one can be provided.

Returns:



4566
4567
4568
4569
# File 'lib/katapult-ruby/api/core_api.rb', line 4566

def get_security_group(opts = {})
  data, _status_code, _headers = get_security_group_with_http_info(opts)
  data
end

#get_security_group_rules(opts = {}) ⇒ GetSecurityGroupRules200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :security_group_id (String)

    The security group to return all load rules for. All &#39;security_group[]&#39; params are mutually exclusive, only one can be provided.

  • :page (Integer)
  • :per_page (Integer)

Returns:



4624
4625
4626
4627
# File 'lib/katapult-ruby/api/core_api.rb', line 4624

def get_security_group_rules(opts = {})
  data, _status_code, _headers = get_security_group_rules_with_http_info(opts)
  data
end

#get_security_group_rules_with_http_info(opts = {}) ⇒ Array<(GetSecurityGroupRules200Response, Integer, Hash)>

Returns GetSecurityGroupRules200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :security_group_id (String)

    The security group to return all load rules for. All &#39;security_group[]&#39; params are mutually exclusive, only one can be provided.

  • :page (Integer)
  • :per_page (Integer)

Returns:



4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
# File 'lib/katapult-ruby/api/core_api.rb', line 4634

def get_security_group_rules_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_security_group_rules ...'
  end
  # resource path
  local_var_path = '/security_groups/:security_group/rules'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'security_group[id]'] = opts[:'security_group_id'] if !opts[:'security_group_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].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] || 'GetSecurityGroupRules200Response'

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

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

#get_security_group_with_http_info(opts = {}) ⇒ Array<(GetSecurityGroup200Response, Integer, Hash)>

Returns GetSecurityGroup200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :security_group_id (String)

    The security group to return the details for. All &#39;security_group[]&#39; params are mutually exclusive, only one can be provided.

Returns:

  • (Array<(GetSecurityGroup200Response, Integer, Hash)>)

    GetSecurityGroup200Response data, response status code and response headers



4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
# File 'lib/katapult-ruby/api/core_api.rb', line 4574

def get_security_group_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_security_group ...'
  end
  # resource path
  local_var_path = '/security_groups/:security_group'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'security_group[id]'] = opts[:'security_group_id'] if !opts[:'security_group_id'].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] || 'GetSecurityGroup200Response'

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

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

#get_security_groups_rules_security_group_rule(opts = {}) ⇒ GetSecurityGroupsRulesSecurityGroupRule200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :security_group_rule_id (String)

    The security group rule to return the details for. All &#39;security_group_rule[]&#39; params are mutually exclusive, only one can be provided.

Returns:



4684
4685
4686
4687
# File 'lib/katapult-ruby/api/core_api.rb', line 4684

def get_security_groups_rules_security_group_rule(opts = {})
  data, _status_code, _headers = get_security_groups_rules_security_group_rule_with_http_info(opts)
  data
end

#get_security_groups_rules_security_group_rule_with_http_info(opts = {}) ⇒ Array<(GetSecurityGroupsRulesSecurityGroupRule200Response, Integer, Hash)>

Returns GetSecurityGroupsRulesSecurityGroupRule200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :security_group_rule_id (String)

    The security group rule to return the details for. All &#39;security_group_rule[]&#39; params are mutually exclusive, only one can be provided.

Returns:



4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
# File 'lib/katapult-ruby/api/core_api.rb', line 4692

def get_security_groups_rules_security_group_rule_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_security_groups_rules_security_group_rule ...'
  end
  # resource path
  local_var_path = '/security_groups/rules/:security_group_rule'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'security_group_rule[id]'] = opts[:'security_group_rule_id'] if !opts[:'security_group_rule_id'].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] || 'GetSecurityGroupsRulesSecurityGroupRule200Response'

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

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

#get_tag(opts = {}) ⇒ GetTag200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :tag_id (String)

    The tag to load the details for. All &#39;tag[]&#39; params are mutually exclusive, only one can be provided.

Returns:



4740
4741
4742
4743
# File 'lib/katapult-ruby/api/core_api.rb', line 4740

def get_tag(opts = {})
  data, _status_code, _headers = get_tag_with_http_info(opts)
  data
end

#get_tag_with_http_info(opts = {}) ⇒ Array<(GetTag200Response, Integer, Hash)>

Returns GetTag200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :tag_id (String)

    The tag to load the details for. All &#39;tag[]&#39; params are mutually exclusive, only one can be provided.

Returns:

  • (Array<(GetTag200Response, Integer, Hash)>)

    GetTag200Response data, response status code and response headers



4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
# File 'lib/katapult-ruby/api/core_api.rb', line 4748

def get_tag_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_tag ...'
  end
  # resource path
  local_var_path = '/tags/:tag'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'tag[id]'] = opts[:'tag_id'] if !opts[:'tag_id'].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] || 'GetTag200Response'

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

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

#get_task(opts = {}) ⇒ PutVirtualMachinePackage200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :task_id (String)

    All &#39;task[]&#39; params are mutually exclusive, only one can be provided.

Returns:



4796
4797
4798
4799
# File 'lib/katapult-ruby/api/core_api.rb', line 4796

def get_task(opts = {})
  data, _status_code, _headers = get_task_with_http_info(opts)
  data
end

#get_task_with_http_info(opts = {}) ⇒ Array<(PutVirtualMachinePackage200Response, Integer, Hash)>

Returns PutVirtualMachinePackage200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :task_id (String)

    All &#39;task[]&#39; params are mutually exclusive, only one can be provided.

Returns:



4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
# File 'lib/katapult-ruby/api/core_api.rb', line 4804

def get_task_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_task ...'
  end
  # resource path
  local_var_path = '/tasks/:task'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'task[id]'] = opts[:'task_id'] if !opts[:'task_id'].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] || 'PutVirtualMachinePackage200Response'

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

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

#get_trash_object(opts = {}) ⇒ GetTrashObject200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :trash_object_id (String)

    The trash object to find. All &#39;trash_object[]&#39; params are mutually exclusive, only one can be provided.

  • :trash_object_object_id (String)

    The trash object to find. All &#39;trash_object[]&#39; params are mutually exclusive, only one can be provided.

Returns:



4853
4854
4855
4856
# File 'lib/katapult-ruby/api/core_api.rb', line 4853

def get_trash_object(opts = {})
  data, _status_code, _headers = get_trash_object_with_http_info(opts)
  data
end

#get_trash_object_with_http_info(opts = {}) ⇒ Array<(GetTrashObject200Response, Integer, Hash)>

Returns GetTrashObject200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :trash_object_id (String)

    The trash object to find. All &#39;trash_object[]&#39; params are mutually exclusive, only one can be provided.

  • :trash_object_object_id (String)

    The trash object to find. All &#39;trash_object[]&#39; params are mutually exclusive, only one can be provided.

Returns:

  • (Array<(GetTrashObject200Response, Integer, Hash)>)

    GetTrashObject200Response data, response status code and response headers



4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
# File 'lib/katapult-ruby/api/core_api.rb', line 4862

def get_trash_object_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_trash_object ...'
  end
  # resource path
  local_var_path = '/trash_objects/:trash_object'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'trash_object[id]'] = opts[:'trash_object_id'] if !opts[:'trash_object_id'].nil?
  query_params[:'trash_object[object_id]'] = opts[:'trash_object_object_id'] if !opts[:'trash_object_object_id'].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] || 'GetTrashObject200Response'

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

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

#get_users_current(opts = {}) ⇒ GetUsersCurrent200Response

Parameters:

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

    the optional parameters

Returns:



4910
4911
4912
4913
# File 'lib/katapult-ruby/api/core_api.rb', line 4910

def get_users_current(opts = {})
  data, _status_code, _headers = get_users_current_with_http_info(opts)
  data
end

#get_users_current_with_http_info(opts = {}) ⇒ Array<(GetUsersCurrent200Response, Integer, Hash)>

Returns GetUsersCurrent200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(GetUsersCurrent200Response, Integer, Hash)>)

    GetUsersCurrent200Response data, response status code and response headers



4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
# File 'lib/katapult-ruby/api/core_api.rb', line 4917

def get_users_current_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_users_current ...'
  end
  # resource path
  local_var_path = '/users/current'

  # 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] || 'GetUsersCurrent200Response'

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

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

#get_virtual_machine(opts = {}) ⇒ GetVirtualMachine200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :virtual_machine_id (String)

    All &#39;virtual_machine[]&#39; params are mutually exclusive, only one can be provided.

  • :virtual_machine_fqdn (String)

    All &#39;virtual_machine[]&#39; params are mutually exclusive, only one can be provided.

Returns:



4965
4966
4967
4968
# File 'lib/katapult-ruby/api/core_api.rb', line 4965

def get_virtual_machine(opts = {})
  data, _status_code, _headers = get_virtual_machine_with_http_info(opts)
  data
end

#get_virtual_machine_authorized_keys(opts = {}) ⇒ String

Parameters:

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

    the optional parameters

Returns:

  • (String)


5022
5023
5024
5025
# File 'lib/katapult-ruby/api/core_api.rb', line 5022

def get_virtual_machine_authorized_keys(opts = {})
  data, _status_code, _headers = get_virtual_machine_authorized_keys_with_http_info(opts)
  data
end

#get_virtual_machine_authorized_keys_with_http_info(opts = {}) ⇒ Array<(String, Integer, Hash)>

Returns String data, response status code and response headers.

Parameters:

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
# File 'lib/katapult-ruby/api/core_api.rb', line 5029

def get_virtual_machine_authorized_keys_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_virtual_machine_authorized_keys ...'
  end
  # resource path
  local_var_path = '/virtual_machine/authorized_keys'

  # 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(['text/plain', '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] || 'String'

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

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

#get_virtual_machine_disk_backup_policies(opts = {}) ⇒ GetVirtualMachineDiskBackupPolicies200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :virtual_machine_id (String)

    The virtual machine to return disk backup policies for. All &#39;virtual_machine[]&#39; params are mutually exclusive, only one can be provided.

  • :virtual_machine_fqdn (String)

    The virtual machine to return disk backup policies for. All &#39;virtual_machine[]&#39; params are mutually exclusive, only one can be provided.

  • :include_disks (Boolean)

    If true, the returned list will include backup policies owned by disks assigned to this virtual machine in addition to those that belong to the whole virtual machine

  • :page (Integer)
  • :per_page (Integer)

Returns:



5080
5081
5082
5083
# File 'lib/katapult-ruby/api/core_api.rb', line 5080

def get_virtual_machine_disk_backup_policies(opts = {})
  data, _status_code, _headers = get_virtual_machine_disk_backup_policies_with_http_info(opts)
  data
end

#get_virtual_machine_disk_backup_policies_with_http_info(opts = {}) ⇒ Array<(GetVirtualMachineDiskBackupPolicies200Response, Integer, Hash)>

Returns GetVirtualMachineDiskBackupPolicies200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :virtual_machine_id (String)

    The virtual machine to return disk backup policies for. All &#39;virtual_machine[]&#39; params are mutually exclusive, only one can be provided.

  • :virtual_machine_fqdn (String)

    The virtual machine to return disk backup policies for. All &#39;virtual_machine[]&#39; params are mutually exclusive, only one can be provided.

  • :include_disks (Boolean)

    If true, the returned list will include backup policies owned by disks assigned to this virtual machine in addition to those that belong to the whole virtual machine

  • :page (Integer)
  • :per_page (Integer)

Returns:



5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
# File 'lib/katapult-ruby/api/core_api.rb', line 5092

def get_virtual_machine_disk_backup_policies_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_virtual_machine_disk_backup_policies ...'
  end
  # resource path
  local_var_path = '/virtual_machines/:virtual_machine/disk_backup_policies'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'virtual_machine[id]'] = opts[:'virtual_machine_id'] if !opts[:'virtual_machine_id'].nil?
  query_params[:'virtual_machine[fqdn]'] = opts[:'virtual_machine_fqdn'] if !opts[:'virtual_machine_fqdn'].nil?
  query_params[:'include_disks'] = opts[:'include_disks'] if !opts[:'include_disks'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].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] || 'GetVirtualMachineDiskBackupPolicies200Response'

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

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

#get_virtual_machine_disks(opts = {}) ⇒ GetVirtualMachineDisks200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :virtual_machine_id (String)

    The virtual machine to find disks for. All &#39;virtual_machine[]&#39; params are mutually exclusive, only one can be provided.

  • :virtual_machine_fqdn (String)

    The virtual machine to find disks for. All &#39;virtual_machine[]&#39; params are mutually exclusive, only one can be provided.

  • :page (Integer)
  • :per_page (Integer)

Returns:



5147
5148
5149
5150
# File 'lib/katapult-ruby/api/core_api.rb', line 5147

def get_virtual_machine_disks(opts = {})
  data, _status_code, _headers = get_virtual_machine_disks_with_http_info(opts)
  data
end

#get_virtual_machine_disks_with_http_info(opts = {}) ⇒ Array<(GetVirtualMachineDisks200Response, Integer, Hash)>

Returns GetVirtualMachineDisks200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :virtual_machine_id (String)

    The virtual machine to find disks for. All &#39;virtual_machine[]&#39; params are mutually exclusive, only one can be provided.

  • :virtual_machine_fqdn (String)

    The virtual machine to find disks for. All &#39;virtual_machine[]&#39; params are mutually exclusive, only one can be provided.

  • :page (Integer)
  • :per_page (Integer)

Returns:



5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
# File 'lib/katapult-ruby/api/core_api.rb', line 5158

def get_virtual_machine_disks_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_virtual_machine_disks ...'
  end
  # resource path
  local_var_path = '/virtual_machines/:virtual_machine/disks'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'virtual_machine[id]'] = opts[:'virtual_machine_id'] if !opts[:'virtual_machine_id'].nil?
  query_params[:'virtual_machine[fqdn]'] = opts[:'virtual_machine_fqdn'] if !opts[:'virtual_machine_fqdn'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].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] || 'GetVirtualMachineDisks200Response'

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

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

#get_virtual_machine_group(opts = {}) ⇒ GetVirtualMachineGroup200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :virtual_machine_group_id (String)

    The virtual machine group to retrieve. All &#39;virtual_machine_group[]&#39; params are mutually exclusive, only one can be provided.

Returns:



5209
5210
5211
5212
# File 'lib/katapult-ruby/api/core_api.rb', line 5209

def get_virtual_machine_group(opts = {})
  data, _status_code, _headers = get_virtual_machine_group_with_http_info(opts)
  data
end

#get_virtual_machine_group_with_http_info(opts = {}) ⇒ Array<(GetVirtualMachineGroup200Response, Integer, Hash)>

Returns GetVirtualMachineGroup200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :virtual_machine_group_id (String)

    The virtual machine group to retrieve. All &#39;virtual_machine_group[]&#39; params are mutually exclusive, only one can be provided.

Returns:



5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
# File 'lib/katapult-ruby/api/core_api.rb', line 5217

def get_virtual_machine_group_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_virtual_machine_group ...'
  end
  # resource path
  local_var_path = '/virtual_machine_groups/:virtual_machine_group'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'virtual_machine_group[id]'] = opts[:'virtual_machine_group_id'] if !opts[:'virtual_machine_group_id'].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] || 'GetVirtualMachineGroup200Response'

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

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

#get_virtual_machine_network_interface(opts = {}) ⇒ GetVirtualMachineNetworkInterface200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :virtual_machine_id (String)

    The virtual machine to find the network interface for. All &#39;virtual_machine[]&#39; params are mutually exclusive, only one can be provided.

  • :virtual_machine_fqdn (String)

    The virtual machine to find the network interface for. All &#39;virtual_machine[]&#39; params are mutually exclusive, only one can be provided.

  • :network_id (String)

    The network to find the network interface for. All &#39;network[]&#39; params are mutually exclusive, only one can be provided.

  • :network_permalink (String)

    The network to find the network interface for. All &#39;network[]&#39; params are mutually exclusive, only one can be provided.

Returns:



5268
5269
5270
5271
# File 'lib/katapult-ruby/api/core_api.rb', line 5268

def get_virtual_machine_network_interface(opts = {})
  data, _status_code, _headers = get_virtual_machine_network_interface_with_http_info(opts)
  data
end

#get_virtual_machine_network_interface_available_ips_address_version(address_version, opts = {}) ⇒ GetVirtualMachineNetworkInterfaceAvailableIpsAddressVersion200Response

Parameters:

  • address_version (IPAddressVersionEnum)

    The IP address version to return results for

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

    the optional parameters

Options Hash (opts):

  • :virtual_machine_network_interface_id (String)

    The network interface to get IP addresses for. All &#39;virtual_machine_network_interface[]&#39; params are mutually exclusive, only one can be provided.

Returns:



5331
5332
5333
5334
# File 'lib/katapult-ruby/api/core_api.rb', line 5331

def get_virtual_machine_network_interface_available_ips_address_version(address_version, opts = {})
  data, _status_code, _headers = get_virtual_machine_network_interface_available_ips_address_version_with_http_info(address_version, opts)
  data
end

#get_virtual_machine_network_interface_available_ips_address_version_with_http_info(address_version, opts = {}) ⇒ Array<(GetVirtualMachineNetworkInterfaceAvailableIpsAddressVersion200Response, Integer, Hash)>

Returns GetVirtualMachineNetworkInterfaceAvailableIpsAddressVersion200Response data, response status code and response headers.

Parameters:

  • address_version (IPAddressVersionEnum)

    The IP address version to return results for

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

    the optional parameters

Options Hash (opts):

  • :virtual_machine_network_interface_id (String)

    The network interface to get IP addresses for. All &#39;virtual_machine_network_interface[]&#39; params are mutually exclusive, only one can be provided.

Returns:



5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
# File 'lib/katapult-ruby/api/core_api.rb', line 5340

def get_virtual_machine_network_interface_available_ips_address_version_with_http_info(address_version, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_virtual_machine_network_interface_available_ips_address_version ...'
  end
  # verify the required parameter 'address_version' is set
  if @api_client.config.client_side_validation && address_version.nil?
    fail ArgumentError, "Missing the required parameter 'address_version' when calling CoreApi.get_virtual_machine_network_interface_available_ips_address_version"
  end
  # resource path
  local_var_path = '/virtual_machine_network_interfaces/:virtual_machine_network_interface/available_ips/:address_version'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'address_version'] = address_version
  query_params[:'virtual_machine_network_interface[id]'] = opts[:'virtual_machine_network_interface_id'] if !opts[:'virtual_machine_network_interface_id'].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] || 'GetVirtualMachineNetworkInterfaceAvailableIpsAddressVersion200Response'

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

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

#get_virtual_machine_network_interface_with_http_info(opts = {}) ⇒ Array<(GetVirtualMachineNetworkInterface200Response, Integer, Hash)>

Returns GetVirtualMachineNetworkInterface200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :virtual_machine_id (String)

    The virtual machine to find the network interface for. All &#39;virtual_machine[]&#39; params are mutually exclusive, only one can be provided.

  • :virtual_machine_fqdn (String)

    The virtual machine to find the network interface for. All &#39;virtual_machine[]&#39; params are mutually exclusive, only one can be provided.

  • :network_id (String)

    The network to find the network interface for. All &#39;network[]&#39; params are mutually exclusive, only one can be provided.

  • :network_permalink (String)

    The network to find the network interface for. All &#39;network[]&#39; params are mutually exclusive, only one can be provided.

Returns:



5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
# File 'lib/katapult-ruby/api/core_api.rb', line 5279

def get_virtual_machine_network_interface_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_virtual_machine_network_interface ...'
  end
  # resource path
  local_var_path = '/virtual_machines/:virtual_machine/networks/:network/interface'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'virtual_machine[id]'] = opts[:'virtual_machine_id'] if !opts[:'virtual_machine_id'].nil?
  query_params[:'virtual_machine[fqdn]'] = opts[:'virtual_machine_fqdn'] if !opts[:'virtual_machine_fqdn'].nil?
  query_params[:'network[id]'] = opts[:'network_id'] if !opts[:'network_id'].nil?
  query_params[:'network[permalink]'] = opts[:'network_permalink'] if !opts[:'network_permalink'].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] || 'GetVirtualMachineNetworkInterface200Response'

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

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

#get_virtual_machine_network_interfaces(opts = {}) ⇒ GetVirtualMachineNetworkInterfaces200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :virtual_machine_id (String)

    The virtual machine to show network interfaces for. All &#39;virtual_machine[]&#39; params are mutually exclusive, only one can be provided.

  • :virtual_machine_fqdn (String)

    The virtual machine to show network interfaces for. All &#39;virtual_machine[]&#39; params are mutually exclusive, only one can be provided.

  • :page (Integer)
  • :per_page (Integer)

Returns:



5396
5397
5398
5399
# File 'lib/katapult-ruby/api/core_api.rb', line 5396

def get_virtual_machine_network_interfaces(opts = {})
  data, _status_code, _headers = get_virtual_machine_network_interfaces_with_http_info(opts)
  data
end

#get_virtual_machine_network_interfaces_with_http_info(opts = {}) ⇒ Array<(GetVirtualMachineNetworkInterfaces200Response, Integer, Hash)>

Returns GetVirtualMachineNetworkInterfaces200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :virtual_machine_id (String)

    The virtual machine to show network interfaces for. All &#39;virtual_machine[]&#39; params are mutually exclusive, only one can be provided.

  • :virtual_machine_fqdn (String)

    The virtual machine to show network interfaces for. All &#39;virtual_machine[]&#39; params are mutually exclusive, only one can be provided.

  • :page (Integer)
  • :per_page (Integer)

Returns:



5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
# File 'lib/katapult-ruby/api/core_api.rb', line 5407

def get_virtual_machine_network_interfaces_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_virtual_machine_network_interfaces ...'
  end
  # resource path
  local_var_path = '/virtual_machines/:virtual_machine/network_interfaces'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'virtual_machine[id]'] = opts[:'virtual_machine_id'] if !opts[:'virtual_machine_id'].nil?
  query_params[:'virtual_machine[fqdn]'] = opts[:'virtual_machine_fqdn'] if !opts[:'virtual_machine_fqdn'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].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] || 'GetVirtualMachineNetworkInterfaces200Response'

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

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

#get_virtual_machine_package(opts = {}) ⇒ GetVirtualMachinePackage200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :virtual_machine_package_id (String)

    All &#39;virtual_machine_package[]&#39; params are mutually exclusive, only one can be provided.

  • :virtual_machine_package_permalink (String)

    All &#39;virtual_machine_package[]&#39; params are mutually exclusive, only one can be provided.

Returns:



5459
5460
5461
5462
# File 'lib/katapult-ruby/api/core_api.rb', line 5459

def get_virtual_machine_package(opts = {})
  data, _status_code, _headers = get_virtual_machine_package_with_http_info(opts)
  data
end

#get_virtual_machine_package_with_http_info(opts = {}) ⇒ Array<(GetVirtualMachinePackage200Response, Integer, Hash)>

Returns GetVirtualMachinePackage200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :virtual_machine_package_id (String)

    All &#39;virtual_machine_package[]&#39; params are mutually exclusive, only one can be provided.

  • :virtual_machine_package_permalink (String)

    All &#39;virtual_machine_package[]&#39; params are mutually exclusive, only one can be provided.

Returns:



5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
# File 'lib/katapult-ruby/api/core_api.rb', line 5468

def get_virtual_machine_package_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_virtual_machine_package ...'
  end
  # resource path
  local_var_path = '/virtual_machine_packages/:virtual_machine_package'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'virtual_machine_package[id]'] = opts[:'virtual_machine_package_id'] if !opts[:'virtual_machine_package_id'].nil?
  query_params[:'virtual_machine_package[permalink]'] = opts[:'virtual_machine_package_permalink'] if !opts[:'virtual_machine_package_permalink'].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] || 'GetVirtualMachinePackage200Response'

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

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

#get_virtual_machine_packages(opts = {}) ⇒ GetVirtualMachinePackages200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :organization_id (String)

    Provide an organization to only show packages available to the given organization (otherwise only public packages will be displayed). All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :organization_sub_domain (String)

    Provide an organization to only show packages available to the given organization (otherwise only public packages will be displayed). All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :page (Integer)
  • :per_page (Integer)

Returns:



5520
5521
5522
5523
# File 'lib/katapult-ruby/api/core_api.rb', line 5520

def get_virtual_machine_packages(opts = {})
  data, _status_code, _headers = get_virtual_machine_packages_with_http_info(opts)
  data
end

#get_virtual_machine_packages_with_http_info(opts = {}) ⇒ Array<(GetVirtualMachinePackages200Response, Integer, Hash)>

Returns GetVirtualMachinePackages200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :organization_id (String)

    Provide an organization to only show packages available to the given organization (otherwise only public packages will be displayed). All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :organization_sub_domain (String)

    Provide an organization to only show packages available to the given organization (otherwise only public packages will be displayed). All &#39;organization[]&#39; params are mutually exclusive, only one can be provided.

  • :page (Integer)
  • :per_page (Integer)

Returns:



5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
# File 'lib/katapult-ruby/api/core_api.rb', line 5531

def get_virtual_machine_packages_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_virtual_machine_packages ...'
  end
  # resource path
  local_var_path = '/virtual_machine_packages'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'organization[id]'] = opts[:'organization_id'] if !opts[:'organization_id'].nil?
  query_params[:'organization[sub_domain]'] = opts[:'organization_sub_domain'] if !opts[:'organization_sub_domain'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].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] || 'GetVirtualMachinePackages200Response'

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

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

#get_virtual_machine_with_http_info(opts = {}) ⇒ Array<(GetVirtualMachine200Response, Integer, Hash)>

Returns GetVirtualMachine200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :virtual_machine_id (String)

    All &#39;virtual_machine[]&#39; params are mutually exclusive, only one can be provided.

  • :virtual_machine_fqdn (String)

    All &#39;virtual_machine[]&#39; params are mutually exclusive, only one can be provided.

Returns:



4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
# File 'lib/katapult-ruby/api/core_api.rb', line 4974

def get_virtual_machine_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_virtual_machine ...'
  end
  # resource path
  local_var_path = '/virtual_machines/:virtual_machine'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'virtual_machine[id]'] = opts[:'virtual_machine_id'] if !opts[:'virtual_machine_id'].nil?
  query_params[:'virtual_machine[fqdn]'] = opts[:'virtual_machine_fqdn'] if !opts[:'virtual_machine_fqdn'].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] || 'GetVirtualMachine200Response'

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

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

#get_virtual_machines_builds_virtual_machine_build(opts = {}) ⇒ GetVirtualMachinesBuildsVirtualMachineBuild200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :virtual_machine_build_id (String)

    All &#39;virtual_machine_build[]&#39; params are mutually exclusive, only one can be provided.

Returns:



5582
5583
5584
5585
# File 'lib/katapult-ruby/api/core_api.rb', line 5582

def get_virtual_machines_builds_virtual_machine_build(opts = {})
  data, _status_code, _headers = get_virtual_machines_builds_virtual_machine_build_with_http_info(opts)
  data
end

#get_virtual_machines_builds_virtual_machine_build_with_http_info(opts = {}) ⇒ Array<(GetVirtualMachinesBuildsVirtualMachineBuild200Response, Integer, Hash)>

Returns GetVirtualMachinesBuildsVirtualMachineBuild200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :virtual_machine_build_id (String)

    All &#39;virtual_machine_build[]&#39; params are mutually exclusive, only one can be provided.

Returns:



5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
# File 'lib/katapult-ruby/api/core_api.rb', line 5590

def get_virtual_machines_builds_virtual_machine_build_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_virtual_machines_builds_virtual_machine_build ...'
  end
  # resource path
  local_var_path = '/virtual_machines/builds/:virtual_machine_build'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'virtual_machine_build[id]'] = opts[:'virtual_machine_build_id'] if !opts[:'virtual_machine_build_id'].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] || 'GetVirtualMachinesBuildsVirtualMachineBuild200Response'

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

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

#get_vmnivmni(opts = {}) ⇒ GetVMNIVMNI200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :virtual_machine_network_interface_id (String)

    The network interface to show the information for. All &#39;virtual_machine_network_interface[]&#39; params are mutually exclusive, only one can be provided.

Returns:



5638
5639
5640
5641
# File 'lib/katapult-ruby/api/core_api.rb', line 5638

def get_vmnivmni(opts = {})
  data, _status_code, _headers = get_vmnivmni_with_http_info(opts)
  data
end

#get_vmnivmni_with_http_info(opts = {}) ⇒ Array<(GetVMNIVMNI200Response, Integer, Hash)>

Returns GetVMNIVMNI200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :virtual_machine_network_interface_id (String)

    The network interface to show the information for. All &#39;virtual_machine_network_interface[]&#39; params are mutually exclusive, only one can be provided.

Returns:

  • (Array<(GetVMNIVMNI200Response, Integer, Hash)>)

    GetVMNIVMNI200Response data, response status code and response headers



5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
# File 'lib/katapult-ruby/api/core_api.rb', line 5646

def get_vmnivmni_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_vmnivmni ...'
  end
  # resource path
  local_var_path = '/virtual_machine_network_interfaces/:virtual_machine_network_interface'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'virtual_machine_network_interface[id]'] = opts[:'virtual_machine_network_interface_id'] if !opts[:'virtual_machine_network_interface_id'].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] || 'GetVMNIVMNI200Response'

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

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

#get_zone(opts = {}) ⇒ GetZone200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :zone_id (String)

    The zone to find. All &#39;zone[]&#39; params are mutually exclusive, only one can be provided.

  • :zone_permalink (String)

    The zone to find. All &#39;zone[]&#39; params are mutually exclusive, only one can be provided.

Returns:



5695
5696
5697
5698
# File 'lib/katapult-ruby/api/core_api.rb', line 5695

def get_zone(opts = {})
  data, _status_code, _headers = get_zone_with_http_info(opts)
  data
end

#get_zone_with_http_info(opts = {}) ⇒ Array<(GetZone200Response, Integer, Hash)>

Returns GetZone200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :zone_id (String)

    The zone to find. All &#39;zone[]&#39; params are mutually exclusive, only one can be provided.

  • :zone_permalink (String)

    The zone to find. All &#39;zone[]&#39; params are mutually exclusive, only one can be provided.

Returns:

  • (Array<(GetZone200Response, Integer, Hash)>)

    GetZone200Response data, response status code and response headers



5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
# File 'lib/katapult-ruby/api/core_api.rb', line 5704

def get_zone_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_zone ...'
  end
  # resource path
  local_var_path = '/zones/:zone'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'zone[id]'] = opts[:'zone_id'] if !opts[:'zone_id'].nil?
  query_params[:'zone[permalink]'] = opts[:'zone_permalink'] if !opts[:'zone_permalink'].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] || 'GetZone200Response'

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

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

#get_zones(opts = {}) ⇒ GetZones200Response

Parameters:

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

    the optional parameters

Returns:



5752
5753
5754
5755
# File 'lib/katapult-ruby/api/core_api.rb', line 5752

def get_zones(opts = {})
  data, _status_code, _headers = get_zones_with_http_info(opts)
  data
end

#get_zones_with_http_info(opts = {}) ⇒ Array<(GetZones200Response, Integer, Hash)>

Returns GetZones200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(GetZones200Response, Integer, Hash)>)

    GetZones200Response data, response status code and response headers



5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
# File 'lib/katapult-ruby/api/core_api.rb', line 5759

def get_zones_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.get_zones ...'
  end
  # resource path
  local_var_path = '/zones'

  # 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] || 'GetZones200Response'

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

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

#patch_address_list(opts = {}) ⇒ PostOrganizationAddressLists201Response

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



5806
5807
5808
5809
# File 'lib/katapult-ruby/api/core_api.rb', line 5806

def patch_address_list(opts = {})
  data, _status_code, _headers = patch_address_list_with_http_info(opts)
  data
end

#patch_address_list_entry(opts = {}) ⇒ PostAddressListEntries201Response

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



5866
5867
5868
5869
# File 'lib/katapult-ruby/api/core_api.rb', line 5866

def patch_address_list_entry(opts = {})
  data, _status_code, _headers = patch_address_list_entry_with_http_info(opts)
  data
end

#patch_address_list_entry_with_http_info(opts = {}) ⇒ Array<(PostAddressListEntries201Response, Integer, Hash)>

Returns PostAddressListEntries201Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
# File 'lib/katapult-ruby/api/core_api.rb', line 5874

def patch_address_list_entry_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.patch_address_list_entry ...'
  end
  # resource path
  local_var_path = '/address_list_entries/:address_list_entry'

  # 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(opts[:'patch_address_list_entry_request'])

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

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

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

#patch_address_list_with_http_info(opts = {}) ⇒ Array<(PostOrganizationAddressLists201Response, Integer, Hash)>

Returns PostOrganizationAddressLists201Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
# File 'lib/katapult-ruby/api/core_api.rb', line 5814

def patch_address_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.patch_address_list ...'
  end
  # resource path
  local_var_path = '/address_lists/:address_list'

  # 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(opts[:'patch_address_list_request'])

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

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

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

#patch_disk_backup_policy(opts = {}) ⇒ PatchDiskBackupPolicy200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



5926
5927
5928
5929
# File 'lib/katapult-ruby/api/core_api.rb', line 5926

def patch_disk_backup_policy(opts = {})
  data, _status_code, _headers = patch_disk_backup_policy_with_http_info(opts)
  data
end

#patch_disk_backup_policy_with_http_info(opts = {}) ⇒ Array<(PatchDiskBackupPolicy200Response, Integer, Hash)>

Returns PatchDiskBackupPolicy200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
# File 'lib/katapult-ruby/api/core_api.rb', line 5934

def patch_disk_backup_policy_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.patch_disk_backup_policy ...'
  end
  # resource path
  local_var_path = '/disk_backup_policies/:disk_backup_policy'

  # 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(opts[:'patch_disk_backup_policy_request'])

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

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

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

#patch_dns_record(opts = {}) ⇒ PatchDnsRecord200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



5986
5987
5988
5989
# File 'lib/katapult-ruby/api/core_api.rb', line 5986

def patch_dns_record(opts = {})
  data, _status_code, _headers = patch_dns_record_with_http_info(opts)
  data
end

#patch_dns_record_with_http_info(opts = {}) ⇒ Array<(PatchDnsRecord200Response, Integer, Hash)>

Returns PatchDnsRecord200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(PatchDnsRecord200Response, Integer, Hash)>)

    PatchDnsRecord200Response data, response status code and response headers



5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
# File 'lib/katapult-ruby/api/core_api.rb', line 5994

def patch_dns_record_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.patch_dns_record ...'
  end
  # resource path
  local_var_path = '/dns_records/:dns_record'

  # 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(opts[:'patch_dns_record_request'])

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

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

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

#patch_dns_zone(opts = {}) ⇒ GetDnsZone200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



6046
6047
6048
6049
# File 'lib/katapult-ruby/api/core_api.rb', line 6046

def patch_dns_zone(opts = {})
  data, _status_code, _headers = patch_dns_zone_with_http_info(opts)
  data
end

#patch_dns_zone_with_http_info(opts = {}) ⇒ Array<(GetDnsZone200Response, Integer, Hash)>

Returns GetDnsZone200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(GetDnsZone200Response, Integer, Hash)>)

    GetDnsZone200Response data, response status code and response headers



6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
# File 'lib/katapult-ruby/api/core_api.rb', line 6054

def patch_dns_zone_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.patch_dns_zone ...'
  end
  # resource path
  local_var_path = '/dns_zones/:dns_zone'

  # 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(opts[:'patch_dns_zone_request'])

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

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

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

#patch_file_storage_volume(opts = {}) ⇒ PatchFileStorageVolume200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



6106
6107
6108
6109
# File 'lib/katapult-ruby/api/core_api.rb', line 6106

def patch_file_storage_volume(opts = {})
  data, _status_code, _headers = patch_file_storage_volume_with_http_info(opts)
  data
end

#patch_file_storage_volume_with_http_info(opts = {}) ⇒ Array<(PatchFileStorageVolume200Response, Integer, Hash)>

Returns PatchFileStorageVolume200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
# File 'lib/katapult-ruby/api/core_api.rb', line 6114

def patch_file_storage_volume_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.patch_file_storage_volume ...'
  end
  # resource path
  local_var_path = '/file_storage_volumes/:file_storage_volume'

  # 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(opts[:'patch_file_storage_volume_request'])

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

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

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

#patch_ip_address(opts = {}) ⇒ PatchIpAddress200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



6166
6167
6168
6169
# File 'lib/katapult-ruby/api/core_api.rb', line 6166

def patch_ip_address(opts = {})
  data, _status_code, _headers = patch_ip_address_with_http_info(opts)
  data
end

#patch_ip_address_with_http_info(opts = {}) ⇒ Array<(PatchIpAddress200Response, Integer, Hash)>

Returns PatchIpAddress200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(PatchIpAddress200Response, Integer, Hash)>)

    PatchIpAddress200Response data, response status code and response headers



6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
# File 'lib/katapult-ruby/api/core_api.rb', line 6174

def patch_ip_address_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.patch_ip_address ...'
  end
  # resource path
  local_var_path = '/ip_addresses/:ip_address'

  # 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(opts[:'patch_ip_address_request'])

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

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

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

#patch_load_balancer(opts = {}) ⇒ PatchLoadBalancer200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



6226
6227
6228
6229
# File 'lib/katapult-ruby/api/core_api.rb', line 6226

def patch_load_balancer(opts = {})
  data, _status_code, _headers = patch_load_balancer_with_http_info(opts)
  data
end

#patch_load_balancer_with_http_info(opts = {}) ⇒ Array<(PatchLoadBalancer200Response, Integer, Hash)>

Returns PatchLoadBalancer200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
# File 'lib/katapult-ruby/api/core_api.rb', line 6234

def patch_load_balancer_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.patch_load_balancer ...'
  end
  # resource path
  local_var_path = '/load_balancers/:load_balancer'

  # 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(opts[:'patch_load_balancer_request'])

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

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

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

#patch_load_balancers_rules_load_balancer_rule(opts = {}) ⇒ PatchLoadBalancersRulesLoadBalancerRule200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



6286
6287
6288
6289
# File 'lib/katapult-ruby/api/core_api.rb', line 6286

def patch_load_balancers_rules_load_balancer_rule(opts = {})
  data, _status_code, _headers = patch_load_balancers_rules_load_balancer_rule_with_http_info(opts)
  data
end

#patch_load_balancers_rules_load_balancer_rule_with_http_info(opts = {}) ⇒ Array<(PatchLoadBalancersRulesLoadBalancerRule200Response, Integer, Hash)>

Returns PatchLoadBalancersRulesLoadBalancerRule200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
# File 'lib/katapult-ruby/api/core_api.rb', line 6294

def patch_load_balancers_rules_load_balancer_rule_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.patch_load_balancers_rules_load_balancer_rule ...'
  end
  # resource path
  local_var_path = '/load_balancers/rules/:load_balancer_rule'

  # 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(opts[:'patch_load_balancers_rules_load_balancer_rule_request'])

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

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

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

#patch_security_group(opts = {}) ⇒ PatchSecurityGroup200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



6346
6347
6348
6349
# File 'lib/katapult-ruby/api/core_api.rb', line 6346

def patch_security_group(opts = {})
  data, _status_code, _headers = patch_security_group_with_http_info(opts)
  data
end

#patch_security_group_with_http_info(opts = {}) ⇒ Array<(PatchSecurityGroup200Response, Integer, Hash)>

Returns PatchSecurityGroup200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
# File 'lib/katapult-ruby/api/core_api.rb', line 6354

def patch_security_group_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.patch_security_group ...'
  end
  # resource path
  local_var_path = '/security_groups/:security_group'

  # 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(opts[:'patch_security_group_request'])

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

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

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

#patch_security_groups_rules_security_group_rule(opts = {}) ⇒ PatchSecurityGroupsRulesSecurityGroupRule200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



6406
6407
6408
6409
# File 'lib/katapult-ruby/api/core_api.rb', line 6406

def patch_security_groups_rules_security_group_rule(opts = {})
  data, _status_code, _headers = patch_security_groups_rules_security_group_rule_with_http_info(opts)
  data
end

#patch_security_groups_rules_security_group_rule_with_http_info(opts = {}) ⇒ Array<(PatchSecurityGroupsRulesSecurityGroupRule200Response, Integer, Hash)>

Returns PatchSecurityGroupsRulesSecurityGroupRule200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
# File 'lib/katapult-ruby/api/core_api.rb', line 6414

def patch_security_groups_rules_security_group_rule_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.patch_security_groups_rules_security_group_rule ...'
  end
  # resource path
  local_var_path = '/security_groups/rules/:security_group_rule'

  # 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(opts[:'patch_security_groups_rules_security_group_rule_request'])

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

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

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

#patch_tag(opts = {}) ⇒ PatchTag200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



6466
6467
6468
6469
# File 'lib/katapult-ruby/api/core_api.rb', line 6466

def patch_tag(opts = {})
  data, _status_code, _headers = patch_tag_with_http_info(opts)
  data
end

#patch_tag_with_http_info(opts = {}) ⇒ Array<(PatchTag200Response, Integer, Hash)>

Returns PatchTag200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(PatchTag200Response, Integer, Hash)>)

    PatchTag200Response data, response status code and response headers



6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
6485
6486
6487
6488
6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
# File 'lib/katapult-ruby/api/core_api.rb', line 6474

def patch_tag_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.patch_tag ...'
  end
  # resource path
  local_var_path = '/tags/:tag'

  # 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(opts[:'patch_tag_request'])

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

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

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

#patch_virtual_machine(opts = {}) ⇒ PatchVirtualMachine200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



6526
6527
6528
6529
# File 'lib/katapult-ruby/api/core_api.rb', line 6526

def patch_virtual_machine(opts = {})
  data, _status_code, _headers = patch_virtual_machine_with_http_info(opts)
  data
end

#patch_virtual_machine_group(opts = {}) ⇒ PatchVirtualMachineGroup200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



6586
6587
6588
6589
# File 'lib/katapult-ruby/api/core_api.rb', line 6586

def patch_virtual_machine_group(opts = {})
  data, _status_code, _headers = patch_virtual_machine_group_with_http_info(opts)
  data
end

#patch_virtual_machine_group_with_http_info(opts = {}) ⇒ Array<(PatchVirtualMachineGroup200Response, Integer, Hash)>

Returns PatchVirtualMachineGroup200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
6613
6614
6615
6616
6617
6618
6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
# File 'lib/katapult-ruby/api/core_api.rb', line 6594

def patch_virtual_machine_group_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.patch_virtual_machine_group ...'
  end
  # resource path
  local_var_path = '/virtual_machine_groups/:virtual_machine_group'

  # 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(opts[:'patch_virtual_machine_group_request'])

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

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

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

#patch_virtual_machine_network_interface_update_speed_profile(opts = {}) ⇒ PatchVirtualMachineNetworkInterfaceUpdateSpeedProfile200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



6646
6647
6648
6649
# File 'lib/katapult-ruby/api/core_api.rb', line 6646

def patch_virtual_machine_network_interface_update_speed_profile(opts = {})
  data, _status_code, _headers = patch_virtual_machine_network_interface_update_speed_profile_with_http_info(opts)
  data
end

#patch_virtual_machine_network_interface_update_speed_profile_with_http_info(opts = {}) ⇒ Array<(PatchVirtualMachineNetworkInterfaceUpdateSpeedProfile200Response, Integer, Hash)>

Returns PatchVirtualMachineNetworkInterfaceUpdateSpeedProfile200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
6695
6696
6697
6698
6699
6700
6701
# File 'lib/katapult-ruby/api/core_api.rb', line 6654

def patch_virtual_machine_network_interface_update_speed_profile_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.patch_virtual_machine_network_interface_update_speed_profile ...'
  end
  # resource path
  local_var_path = '/virtual_machine_network_interfaces/:virtual_machine_network_interface/update_speed_profile'

  # 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(opts[:'patch_virtual_machine_network_interface_update_speed_profile_request'])

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

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

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

#patch_virtual_machine_with_http_info(opts = {}) ⇒ Array<(PatchVirtualMachine200Response, Integer, Hash)>

Returns PatchVirtualMachine200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



6534
6535
6536
6537
6538
6539
6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
# File 'lib/katapult-ruby/api/core_api.rb', line 6534

def patch_virtual_machine_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.patch_virtual_machine ...'
  end
  # resource path
  local_var_path = '/virtual_machines/:virtual_machine'

  # 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(opts[:'patch_virtual_machine_request'])

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

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

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

#post_address_list_entries(opts = {}) ⇒ PostAddressListEntries201Response

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



6706
6707
6708
6709
# File 'lib/katapult-ruby/api/core_api.rb', line 6706

def post_address_list_entries(opts = {})
  data, _status_code, _headers = post_address_list_entries_with_http_info(opts)
  data
end

#post_address_list_entries_with_http_info(opts = {}) ⇒ Array<(PostAddressListEntries201Response, Integer, Hash)>

Returns PostAddressListEntries201Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
6727
6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
6740
6741
6742
6743
6744
6745
6746
6747
6748
6749
6750
6751
6752
6753
6754
6755
6756
6757
6758
6759
6760
6761
# File 'lib/katapult-ruby/api/core_api.rb', line 6714

def post_address_list_entries_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.post_address_list_entries ...'
  end
  # resource path
  local_var_path = '/address_lists/:address_list/entries'

  # 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(opts[:'post_address_list_entries_request'])

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

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

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

#post_disk_disk_backup_policies(opts = {}) ⇒ PostDiskDiskBackupPolicies200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



6766
6767
6768
6769
# File 'lib/katapult-ruby/api/core_api.rb', line 6766

def post_disk_disk_backup_policies(opts = {})
  data, _status_code, _headers = post_disk_disk_backup_policies_with_http_info(opts)
  data
end

#post_disk_disk_backup_policies_with_http_info(opts = {}) ⇒ Array<(PostDiskDiskBackupPolicies200Response, Integer, Hash)>

Returns PostDiskDiskBackupPolicies200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
6786
6787
6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
6798
6799
6800
6801
6802
6803
6804
6805
6806
6807
6808
6809
6810
6811
6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
# File 'lib/katapult-ruby/api/core_api.rb', line 6774

def post_disk_disk_backup_policies_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.post_disk_disk_backup_policies ...'
  end
  # resource path
  local_var_path = '/disks/:disk/disk_backup_policies'

  # 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(opts[:'post_disk_disk_backup_policies_request'])

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

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

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

#post_dns_zone_records(opts = {}) ⇒ PostDnsZoneRecords200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



6826
6827
6828
6829
# File 'lib/katapult-ruby/api/core_api.rb', line 6826

def post_dns_zone_records(opts = {})
  data, _status_code, _headers = post_dns_zone_records_with_http_info(opts)
  data
end

#post_dns_zone_records_with_http_info(opts = {}) ⇒ Array<(PostDnsZoneRecords200Response, Integer, Hash)>

Returns PostDnsZoneRecords200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
6846
6847
6848
6849
6850
6851
6852
6853
6854
6855
6856
6857
6858
6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
# File 'lib/katapult-ruby/api/core_api.rb', line 6834

def post_dns_zone_records_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.post_dns_zone_records ...'
  end
  # resource path
  local_var_path = '/dns_zones/:dns_zone/records'

  # 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(opts[:'post_dns_zone_records_request'])

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

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

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

#post_dns_zone_verify(opts = {}) ⇒ GetDnsZone200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



6886
6887
6888
6889
# File 'lib/katapult-ruby/api/core_api.rb', line 6886

def post_dns_zone_verify(opts = {})
  data, _status_code, _headers = post_dns_zone_verify_with_http_info(opts)
  data
end

#post_dns_zone_verify_with_http_info(opts = {}) ⇒ Array<(GetDnsZone200Response, Integer, Hash)>

Returns GetDnsZone200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(GetDnsZone200Response, Integer, Hash)>)

    GetDnsZone200Response data, response status code and response headers



6894
6895
6896
6897
6898
6899
6900
6901
6902
6903
6904
6905
6906
6907
6908
6909
6910
6911
6912
6913
6914
6915
6916
6917
6918
6919
6920
6921
6922
6923
6924
6925
6926
6927
6928
6929
6930
6931
6932
6933
6934
6935
6936
6937
6938
6939
6940
6941
# File 'lib/katapult-ruby/api/core_api.rb', line 6894

def post_dns_zone_verify_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.post_dns_zone_verify ...'
  end
  # resource path
  local_var_path = '/dns_zones/:dns_zone/verify'

  # 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(opts[:'delete_dns_zone_request'])

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

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

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

#post_invalidate_linked_web_session(opts = {}) ⇒ PostInvalidateLinkedWebSession200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (Object)

Returns:



6946
6947
6948
6949
# File 'lib/katapult-ruby/api/core_api.rb', line 6946

def post_invalidate_linked_web_session(opts = {})
  data, _status_code, _headers = post_invalidate_linked_web_session_with_http_info(opts)
  data
end

#post_invalidate_linked_web_session_with_http_info(opts = {}) ⇒ Array<(PostInvalidateLinkedWebSession200Response, Integer, Hash)>

Returns PostInvalidateLinkedWebSession200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (Object)

Returns:



6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
# File 'lib/katapult-ruby/api/core_api.rb', line 6954

def post_invalidate_linked_web_session_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.post_invalidate_linked_web_session ...'
  end
  # resource path
  local_var_path = '/invalidate_linked_web_session'

  # 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(opts[:'body'])

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

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

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

#post_ip_address_unallocate(opts = {}) ⇒ Object

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Object)


7006
7007
7008
7009
# File 'lib/katapult-ruby/api/core_api.rb', line 7006

def post_ip_address_unallocate(opts = {})
  data, _status_code, _headers = post_ip_address_unallocate_with_http_info(opts)
  data
end

#post_ip_address_unallocate_with_http_info(opts = {}) ⇒ Array<(Object, Integer, Hash)>

Returns Object data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Object, Integer, Hash)>)

    Object data, response status code and response headers



7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
7033
7034
7035
7036
7037
7038
7039
7040
7041
7042
7043
7044
7045
7046
7047
7048
7049
7050
7051
7052
7053
7054
7055
7056
7057
7058
7059
7060
7061
# File 'lib/katapult-ruby/api/core_api.rb', line 7014

def post_ip_address_unallocate_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.post_ip_address_unallocate ...'
  end
  # resource path
  local_var_path = '/ip_addresses/:ip_address/unallocate'

  # 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(opts[:'delete_ip_address_request'])

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

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

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

#post_load_balancer_rules(opts = {}) ⇒ PostLoadBalancerRules200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



7066
7067
7068
7069
# File 'lib/katapult-ruby/api/core_api.rb', line 7066

def post_load_balancer_rules(opts = {})
  data, _status_code, _headers = post_load_balancer_rules_with_http_info(opts)
  data
end

#post_load_balancer_rules_with_http_info(opts = {}) ⇒ Array<(PostLoadBalancerRules200Response, Integer, Hash)>

Returns PostLoadBalancerRules200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



7074
7075
7076
7077
7078
7079
7080
7081
7082
7083
7084
7085
7086
7087
7088
7089
7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
7100
7101
7102
7103
7104
7105
7106
7107
7108
7109
7110
7111
7112
7113
7114
7115
7116
7117
7118
7119
7120
7121
# File 'lib/katapult-ruby/api/core_api.rb', line 7074

def post_load_balancer_rules_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.post_load_balancer_rules ...'
  end
  # resource path
  local_var_path = '/load_balancers/:load_balancer/rules'

  # 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(opts[:'post_load_balancer_rules_request'])

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

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

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

#post_organization_address_lists(opts = {}) ⇒ PostOrganizationAddressLists201Response

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



7126
7127
7128
7129
# File 'lib/katapult-ruby/api/core_api.rb', line 7126

def post_organization_address_lists(opts = {})
  data, _status_code, _headers = post_organization_address_lists_with_http_info(opts)
  data
end

#post_organization_address_lists_with_http_info(opts = {}) ⇒ Array<(PostOrganizationAddressLists201Response, Integer, Hash)>

Returns PostOrganizationAddressLists201Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



7134
7135
7136
7137
7138
7139
7140
7141
7142
7143
7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
7161
7162
7163
7164
7165
7166
7167
7168
7169
7170
7171
7172
7173
7174
7175
7176
7177
7178
7179
7180
7181
# File 'lib/katapult-ruby/api/core_api.rb', line 7134

def post_organization_address_lists_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.post_organization_address_lists ...'
  end
  # resource path
  local_var_path = '/organizations/:organization/address_lists'

  # 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(opts[:'post_organization_address_lists_request'])

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

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

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

#post_organization_dns_zones(opts = {}) ⇒ PostOrganizationDnsZones201Response

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



7186
7187
7188
7189
# File 'lib/katapult-ruby/api/core_api.rb', line 7186

def post_organization_dns_zones(opts = {})
  data, _status_code, _headers = post_organization_dns_zones_with_http_info(opts)
  data
end

#post_organization_dns_zones_with_http_info(opts = {}) ⇒ Array<(PostOrganizationDnsZones201Response, Integer, Hash)>

Returns PostOrganizationDnsZones201Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



7194
7195
7196
7197
7198
7199
7200
7201
7202
7203
7204
7205
7206
7207
7208
7209
7210
7211
7212
7213
7214
7215
7216
7217
7218
7219
7220
7221
7222
7223
7224
7225
7226
7227
7228
7229
7230
7231
7232
7233
7234
7235
7236
7237
7238
7239
7240
7241
# File 'lib/katapult-ruby/api/core_api.rb', line 7194

def post_organization_dns_zones_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.post_organization_dns_zones ...'
  end
  # resource path
  local_var_path = '/organizations/:organization/dns_zones'

  # 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(opts[:'post_organization_dns_zones_request'])

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

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

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

#post_organization_file_storage_volumes(opts = {}) ⇒ PostOrganizationFileStorageVolumes201Response

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



7246
7247
7248
7249
# File 'lib/katapult-ruby/api/core_api.rb', line 7246

def post_organization_file_storage_volumes(opts = {})
  data, _status_code, _headers = post_organization_file_storage_volumes_with_http_info(opts)
  data
end

#post_organization_file_storage_volumes_with_http_info(opts = {}) ⇒ Array<(PostOrganizationFileStorageVolumes201Response, Integer, Hash)>

Returns PostOrganizationFileStorageVolumes201Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



7254
7255
7256
7257
7258
7259
7260
7261
7262
7263
7264
7265
7266
7267
7268
7269
7270
7271
7272
7273
7274
7275
7276
7277
7278
7279
7280
7281
7282
7283
7284
7285
7286
7287
7288
7289
7290
7291
7292
7293
7294
7295
7296
7297
7298
7299
7300
7301
# File 'lib/katapult-ruby/api/core_api.rb', line 7254

def post_organization_file_storage_volumes_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.post_organization_file_storage_volumes ...'
  end
  # resource path
  local_var_path = '/organizations/:organization/file_storage_volumes'

  # 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(opts[:'post_organization_file_storage_volumes_request'])

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

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

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

#post_organization_ip_addresses(opts = {}) ⇒ PostVirtualMachineAllocateIp200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



7306
7307
7308
7309
# File 'lib/katapult-ruby/api/core_api.rb', line 7306

def post_organization_ip_addresses(opts = {})
  data, _status_code, _headers = post_organization_ip_addresses_with_http_info(opts)
  data
end

#post_organization_ip_addresses_with_http_info(opts = {}) ⇒ Array<(PostVirtualMachineAllocateIp200Response, Integer, Hash)>

Returns PostVirtualMachineAllocateIp200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
7328
7329
7330
7331
7332
7333
7334
7335
7336
7337
7338
7339
7340
7341
7342
7343
7344
7345
7346
7347
7348
7349
7350
7351
7352
7353
7354
7355
7356
7357
7358
7359
7360
7361
# File 'lib/katapult-ruby/api/core_api.rb', line 7314

def post_organization_ip_addresses_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.post_organization_ip_addresses ...'
  end
  # resource path
  local_var_path = '/organizations/:organization/ip_addresses'

  # 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(opts[:'post_organization_ip_addresses_request'])

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

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

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

#post_organization_load_balancers(opts = {}) ⇒ PostOrganizationLoadBalancers201Response

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



7366
7367
7368
7369
# File 'lib/katapult-ruby/api/core_api.rb', line 7366

def post_organization_load_balancers(opts = {})
  data, _status_code, _headers = post_organization_load_balancers_with_http_info(opts)
  data
end

#post_organization_load_balancers_with_http_info(opts = {}) ⇒ Array<(PostOrganizationLoadBalancers201Response, Integer, Hash)>

Returns PostOrganizationLoadBalancers201Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



7374
7375
7376
7377
7378
7379
7380
7381
7382
7383
7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
7396
7397
7398
7399
7400
7401
7402
7403
7404
7405
7406
7407
7408
7409
7410
7411
7412
7413
7414
7415
7416
7417
7418
7419
7420
7421
# File 'lib/katapult-ruby/api/core_api.rb', line 7374

def post_organization_load_balancers_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.post_organization_load_balancers ...'
  end
  # resource path
  local_var_path = '/organizations/:organization/load_balancers'

  # 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(opts[:'post_organization_load_balancers_request'])

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

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

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

#post_organization_managed(opts = {}) ⇒ GetOrganization200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



7426
7427
7428
7429
# File 'lib/katapult-ruby/api/core_api.rb', line 7426

def post_organization_managed(opts = {})
  data, _status_code, _headers = post_organization_managed_with_http_info(opts)
  data
end

#post_organization_managed_with_http_info(opts = {}) ⇒ Array<(GetOrganization200Response, Integer, Hash)>

Returns GetOrganization200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(GetOrganization200Response, Integer, Hash)>)

    GetOrganization200Response data, response status code and response headers



7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
7475
7476
7477
7478
7479
7480
7481
# File 'lib/katapult-ruby/api/core_api.rb', line 7434

def post_organization_managed_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.post_organization_managed ...'
  end
  # resource path
  local_var_path = '/organizations/:organization/managed'

  # 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(opts[:'post_organization_managed_request'])

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

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

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

#post_organization_security_groups(opts = {}) ⇒ PostOrganizationSecurityGroups200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



7486
7487
7488
7489
# File 'lib/katapult-ruby/api/core_api.rb', line 7486

def post_organization_security_groups(opts = {})
  data, _status_code, _headers = post_organization_security_groups_with_http_info(opts)
  data
end

#post_organization_security_groups_with_http_info(opts = {}) ⇒ Array<(PostOrganizationSecurityGroups200Response, Integer, Hash)>

Returns PostOrganizationSecurityGroups200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



7494
7495
7496
7497
7498
7499
7500
7501
7502
7503
7504
7505
7506
7507
7508
7509
7510
7511
7512
7513
7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
7536
7537
7538
7539
7540
7541
# File 'lib/katapult-ruby/api/core_api.rb', line 7494

def post_organization_security_groups_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.post_organization_security_groups ...'
  end
  # resource path
  local_var_path = '/organizations/:organization/security_groups'

  # 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(opts[:'post_organization_security_groups_request'])

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

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

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

#post_organization_ssh_keys(opts = {}) ⇒ PostOrganizationSshKeys201Response

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



7546
7547
7548
7549
# File 'lib/katapult-ruby/api/core_api.rb', line 7546

def post_organization_ssh_keys(opts = {})
  data, _status_code, _headers = post_organization_ssh_keys_with_http_info(opts)
  data
end

#post_organization_ssh_keys_with_http_info(opts = {}) ⇒ Array<(PostOrganizationSshKeys201Response, Integer, Hash)>

Returns PostOrganizationSshKeys201Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



7554
7555
7556
7557
7558
7559
7560
7561
7562
7563
7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
7585
7586
7587
7588
7589
7590
7591
7592
7593
7594
7595
7596
7597
7598
7599
7600
7601
# File 'lib/katapult-ruby/api/core_api.rb', line 7554

def post_organization_ssh_keys_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.post_organization_ssh_keys ...'
  end
  # resource path
  local_var_path = '/organizations/:organization/ssh_keys'

  # 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(opts[:'post_organization_ssh_keys_request'])

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

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

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

#post_organization_tags(opts = {}) ⇒ PostOrganizationTags200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



7606
7607
7608
7609
# File 'lib/katapult-ruby/api/core_api.rb', line 7606

def post_organization_tags(opts = {})
  data, _status_code, _headers = post_organization_tags_with_http_info(opts)
  data
end

#post_organization_tags_with_http_info(opts = {}) ⇒ Array<(PostOrganizationTags200Response, Integer, Hash)>

Returns PostOrganizationTags200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



7614
7615
7616
7617
7618
7619
7620
7621
7622
7623
7624
7625
7626
7627
7628
7629
7630
7631
7632
7633
7634
7635
7636
7637
7638
7639
7640
7641
7642
7643
7644
7645
7646
7647
7648
7649
7650
7651
7652
7653
7654
7655
7656
7657
7658
7659
7660
7661
# File 'lib/katapult-ruby/api/core_api.rb', line 7614

def post_organization_tags_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.post_organization_tags ...'
  end
  # resource path
  local_var_path = '/organizations/:organization/tags'

  # 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(opts[:'post_organization_tags_request'])

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

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

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

#post_organization_trash_objects_purge_all(opts = {}) ⇒ PutVirtualMachinePackage200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



7666
7667
7668
7669
# File 'lib/katapult-ruby/api/core_api.rb', line 7666

def post_organization_trash_objects_purge_all(opts = {})
  data, _status_code, _headers = post_organization_trash_objects_purge_all_with_http_info(opts)
  data
end

#post_organization_trash_objects_purge_all_with_http_info(opts = {}) ⇒ Array<(PutVirtualMachinePackage200Response, Integer, Hash)>

Returns PutVirtualMachinePackage200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
7690
7691
7692
7693
7694
7695
7696
7697
7698
7699
7700
7701
7702
7703
7704
7705
7706
7707
7708
7709
7710
7711
7712
7713
7714
7715
7716
7717
7718
7719
7720
7721
# File 'lib/katapult-ruby/api/core_api.rb', line 7674

def post_organization_trash_objects_purge_all_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.post_organization_trash_objects_purge_all ...'
  end
  # resource path
  local_var_path = '/organizations/:organization/trash_objects/purge_all'

  # 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(opts[:'post_organization_trash_objects_purge_all_request'])

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

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

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

#post_organization_virtual_machine_groups(opts = {}) ⇒ PostOrganizationVirtualMachineGroups200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



7726
7727
7728
7729
# File 'lib/katapult-ruby/api/core_api.rb', line 7726

def post_organization_virtual_machine_groups(opts = {})
  data, _status_code, _headers = post_organization_virtual_machine_groups_with_http_info(opts)
  data
end

#post_organization_virtual_machine_groups_with_http_info(opts = {}) ⇒ Array<(PostOrganizationVirtualMachineGroups200Response, Integer, Hash)>

Returns PostOrganizationVirtualMachineGroups200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



7734
7735
7736
7737
7738
7739
7740
7741
7742
7743
7744
7745
7746
7747
7748
7749
7750
7751
7752
7753
7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
7764
7765
7766
7767
7768
7769
7770
7771
7772
7773
7774
7775
7776
7777
7778
7779
7780
7781
# File 'lib/katapult-ruby/api/core_api.rb', line 7734

def post_organization_virtual_machine_groups_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.post_organization_virtual_machine_groups ...'
  end
  # resource path
  local_var_path = '/organizations/:organization/virtual_machine_groups'

  # 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(opts[:'post_organization_virtual_machine_groups_request'])

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

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

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

#post_organization_virtual_machines_build(opts = {}) ⇒ PostOrganizationVirtualMachinesBuild201Response

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



7786
7787
7788
7789
# File 'lib/katapult-ruby/api/core_api.rb', line 7786

def post_organization_virtual_machines_build(opts = {})
  data, _status_code, _headers = post_organization_virtual_machines_build_with_http_info(opts)
  data
end

#post_organization_virtual_machines_build_from_spec(opts = {}) ⇒ PostOrganizationVirtualMachinesBuildFromSpec201Response

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



7846
7847
7848
7849
# File 'lib/katapult-ruby/api/core_api.rb', line 7846

def post_organization_virtual_machines_build_from_spec(opts = {})
  data, _status_code, _headers = post_organization_virtual_machines_build_from_spec_with_http_info(opts)
  data
end

#post_organization_virtual_machines_build_from_spec_with_http_info(opts = {}) ⇒ Array<(PostOrganizationVirtualMachinesBuildFromSpec201Response, Integer, Hash)>

Returns PostOrganizationVirtualMachinesBuildFromSpec201Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



7854
7855
7856
7857
7858
7859
7860
7861
7862
7863
7864
7865
7866
7867
7868
7869
7870
7871
7872
7873
7874
7875
7876
7877
7878
7879
7880
7881
7882
7883
7884
7885
7886
7887
7888
7889
7890
7891
7892
7893
7894
7895
7896
7897
7898
7899
7900
7901
# File 'lib/katapult-ruby/api/core_api.rb', line 7854

def post_organization_virtual_machines_build_from_spec_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.post_organization_virtual_machines_build_from_spec ...'
  end
  # resource path
  local_var_path = '/organizations/:organization/virtual_machines/build_from_spec'

  # 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(opts[:'post_organization_virtual_machines_build_from_spec_request'])

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

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

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

#post_organization_virtual_machines_build_with_http_info(opts = {}) ⇒ Array<(PostOrganizationVirtualMachinesBuild201Response, Integer, Hash)>

Returns PostOrganizationVirtualMachinesBuild201Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



7794
7795
7796
7797
7798
7799
7800
7801
7802
7803
7804
7805
7806
7807
7808
7809
7810
7811
7812
7813
7814
7815
7816
7817
7818
7819
7820
7821
7822
7823
7824
7825
7826
7827
7828
7829
7830
7831
7832
7833
7834
7835
7836
7837
7838
7839
7840
7841
# File 'lib/katapult-ruby/api/core_api.rb', line 7794

def post_organization_virtual_machines_build_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.post_organization_virtual_machines_build ...'
  end
  # resource path
  local_var_path = '/organizations/:organization/virtual_machines/build'

  # 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(opts[:'post_organization_virtual_machines_build_request'])

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

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

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

#post_security_group_rules(opts = {}) ⇒ PostSecurityGroupRules200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



7906
7907
7908
7909
# File 'lib/katapult-ruby/api/core_api.rb', line 7906

def post_security_group_rules(opts = {})
  data, _status_code, _headers = post_security_group_rules_with_http_info(opts)
  data
end

#post_security_group_rules_with_http_info(opts = {}) ⇒ Array<(PostSecurityGroupRules200Response, Integer, Hash)>

Returns PostSecurityGroupRules200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



7914
7915
7916
7917
7918
7919
7920
7921
7922
7923
7924
7925
7926
7927
7928
7929
7930
7931
7932
7933
7934
7935
7936
7937
7938
7939
7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
# File 'lib/katapult-ruby/api/core_api.rb', line 7914

def post_security_group_rules_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.post_security_group_rules ...'
  end
  # resource path
  local_var_path = '/security_groups/:security_group/rules'

  # 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(opts[:'post_security_group_rules_request'])

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

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

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

#post_trash_object_restore(opts = {}) ⇒ GetTrashObject200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



7966
7967
7968
7969
# File 'lib/katapult-ruby/api/core_api.rb', line 7966

def post_trash_object_restore(opts = {})
  data, _status_code, _headers = post_trash_object_restore_with_http_info(opts)
  data
end

#post_trash_object_restore_with_http_info(opts = {}) ⇒ Array<(GetTrashObject200Response, Integer, Hash)>

Returns GetTrashObject200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(GetTrashObject200Response, Integer, Hash)>)

    GetTrashObject200Response data, response status code and response headers



7974
7975
7976
7977
7978
7979
7980
7981
7982
7983
7984
7985
7986
7987
7988
7989
7990
7991
7992
7993
7994
7995
7996
7997
7998
7999
8000
8001
8002
8003
8004
8005
8006
8007
8008
8009
8010
8011
8012
8013
8014
8015
8016
8017
8018
8019
8020
8021
# File 'lib/katapult-ruby/api/core_api.rb', line 7974

def post_trash_object_restore_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.post_trash_object_restore ...'
  end
  # resource path
  local_var_path = '/trash_objects/:trash_object/restore'

  # 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(opts[:'delete_trash_object_request'])

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

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

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

#post_virtual_machine_allocate_ip(opts = {}) ⇒ PostVirtualMachineAllocateIp200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



8026
8027
8028
8029
# File 'lib/katapult-ruby/api/core_api.rb', line 8026

def post_virtual_machine_allocate_ip(opts = {})
  data, _status_code, _headers = post_virtual_machine_allocate_ip_with_http_info(opts)
  data
end

#post_virtual_machine_allocate_ip_with_http_info(opts = {}) ⇒ Array<(PostVirtualMachineAllocateIp200Response, Integer, Hash)>

Returns PostVirtualMachineAllocateIp200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



8034
8035
8036
8037
8038
8039
8040
8041
8042
8043
8044
8045
8046
8047
8048
8049
8050
8051
8052
8053
8054
8055
8056
8057
8058
8059
8060
8061
8062
8063
8064
8065
8066
8067
8068
8069
8070
8071
8072
8073
8074
8075
8076
8077
8078
8079
8080
8081
# File 'lib/katapult-ruby/api/core_api.rb', line 8034

def post_virtual_machine_allocate_ip_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.post_virtual_machine_allocate_ip ...'
  end
  # resource path
  local_var_path = '/virtual_machines/:virtual_machine/allocate_ip'

  # 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(opts[:'post_virtual_machine_allocate_ip_request'])

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

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

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

#post_virtual_machine_console_sessions(opts = {}) ⇒ PostVirtualMachineConsoleSessions201Response

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



8086
8087
8088
8089
# File 'lib/katapult-ruby/api/core_api.rb', line 8086

def post_virtual_machine_console_sessions(opts = {})
  data, _status_code, _headers = post_virtual_machine_console_sessions_with_http_info(opts)
  data
end

#post_virtual_machine_console_sessions_with_http_info(opts = {}) ⇒ Array<(PostVirtualMachineConsoleSessions201Response, Integer, Hash)>

Returns PostVirtualMachineConsoleSessions201Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



8094
8095
8096
8097
8098
8099
8100
8101
8102
8103
8104
8105
8106
8107
8108
8109
8110
8111
8112
8113
8114
8115
8116
8117
8118
8119
8120
8121
8122
8123
8124
8125
8126
8127
8128
8129
8130
8131
8132
8133
8134
8135
8136
8137
8138
8139
8140
8141
# File 'lib/katapult-ruby/api/core_api.rb', line 8094

def post_virtual_machine_console_sessions_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.post_virtual_machine_console_sessions ...'
  end
  # resource path
  local_var_path = '/virtual_machines/:virtual_machine/console_sessions'

  # 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(opts[:'post_virtual_machine_start_request'])

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

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

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

#post_virtual_machine_disk_backup_policies(opts = {}) ⇒ PostVirtualMachineDiskBackupPolicies200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



8146
8147
8148
8149
# File 'lib/katapult-ruby/api/core_api.rb', line 8146

def post_virtual_machine_disk_backup_policies(opts = {})
  data, _status_code, _headers = post_virtual_machine_disk_backup_policies_with_http_info(opts)
  data
end

#post_virtual_machine_disk_backup_policies_with_http_info(opts = {}) ⇒ Array<(PostVirtualMachineDiskBackupPolicies200Response, Integer, Hash)>

Returns PostVirtualMachineDiskBackupPolicies200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



8154
8155
8156
8157
8158
8159
8160
8161
8162
8163
8164
8165
8166
8167
8168
8169
8170
8171
8172
8173
8174
8175
8176
8177
8178
8179
8180
8181
8182
8183
8184
8185
8186
8187
8188
8189
8190
8191
8192
8193
8194
8195
8196
8197
8198
8199
8200
8201
# File 'lib/katapult-ruby/api/core_api.rb', line 8154

def post_virtual_machine_disk_backup_policies_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.post_virtual_machine_disk_backup_policies ...'
  end
  # resource path
  local_var_path = '/virtual_machines/:virtual_machine/disk_backup_policies'

  # 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(opts[:'post_virtual_machine_disk_backup_policies_request'])

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

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

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

#post_virtual_machine_network_interface_allocate_ip(opts = {}) ⇒ PostVirtualMachineNetworkInterfaceAllocateIp200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



8206
8207
8208
8209
# File 'lib/katapult-ruby/api/core_api.rb', line 8206

def post_virtual_machine_network_interface_allocate_ip(opts = {})
  data, _status_code, _headers = post_virtual_machine_network_interface_allocate_ip_with_http_info(opts)
  data
end

#post_virtual_machine_network_interface_allocate_ip_with_http_info(opts = {}) ⇒ Array<(PostVirtualMachineNetworkInterfaceAllocateIp200Response, Integer, Hash)>

Returns PostVirtualMachineNetworkInterfaceAllocateIp200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



8214
8215
8216
8217
8218
8219
8220
8221
8222
8223
8224
8225
8226
8227
8228
8229
8230
8231
8232
8233
8234
8235
8236
8237
8238
8239
8240
8241
8242
8243
8244
8245
8246
8247
8248
8249
8250
8251
8252
8253
8254
8255
8256
8257
8258
8259
8260
8261
# File 'lib/katapult-ruby/api/core_api.rb', line 8214

def post_virtual_machine_network_interface_allocate_ip_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.post_virtual_machine_network_interface_allocate_ip ...'
  end
  # resource path
  local_var_path = '/virtual_machine_network_interfaces/:virtual_machine_network_interface/allocate_ip'

  # 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(opts[:'post_virtual_machine_network_interface_allocate_ip_request'])

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

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

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

#post_virtual_machine_network_interface_allocate_new_ip(opts = {}) ⇒ PostVirtualMachineAllocateIp200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



8266
8267
8268
8269
# File 'lib/katapult-ruby/api/core_api.rb', line 8266

def post_virtual_machine_network_interface_allocate_new_ip(opts = {})
  data, _status_code, _headers = post_virtual_machine_network_interface_allocate_new_ip_with_http_info(opts)
  data
end

#post_virtual_machine_network_interface_allocate_new_ip_with_http_info(opts = {}) ⇒ Array<(PostVirtualMachineAllocateIp200Response, Integer, Hash)>

Returns PostVirtualMachineAllocateIp200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



8274
8275
8276
8277
8278
8279
8280
8281
8282
8283
8284
8285
8286
8287
8288
8289
8290
8291
8292
8293
8294
8295
8296
8297
8298
8299
8300
8301
8302
8303
8304
8305
8306
8307
8308
8309
8310
8311
8312
8313
8314
8315
8316
8317
8318
8319
8320
8321
# File 'lib/katapult-ruby/api/core_api.rb', line 8274

def post_virtual_machine_network_interface_allocate_new_ip_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.post_virtual_machine_network_interface_allocate_new_ip ...'
  end
  # resource path
  local_var_path = '/virtual_machine_network_interfaces/:virtual_machine_network_interface/allocate_new_ip'

  # 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(opts[:'post_virtual_machine_network_interface_allocate_new_ip_request'])

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

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

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

#post_virtual_machine_reset(opts = {}) ⇒ PostVirtualMachineReset200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



8326
8327
8328
8329
# File 'lib/katapult-ruby/api/core_api.rb', line 8326

def post_virtual_machine_reset(opts = {})
  data, _status_code, _headers = post_virtual_machine_reset_with_http_info(opts)
  data
end

#post_virtual_machine_reset_with_http_info(opts = {}) ⇒ Array<(PostVirtualMachineReset200Response, Integer, Hash)>

Returns PostVirtualMachineReset200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



8334
8335
8336
8337
8338
8339
8340
8341
8342
8343
8344
8345
8346
8347
8348
8349
8350
8351
8352
8353
8354
8355
8356
8357
8358
8359
8360
8361
8362
8363
8364
8365
8366
8367
8368
8369
8370
8371
8372
8373
8374
8375
8376
8377
8378
8379
8380
8381
# File 'lib/katapult-ruby/api/core_api.rb', line 8334

def post_virtual_machine_reset_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.post_virtual_machine_reset ...'
  end
  # resource path
  local_var_path = '/virtual_machines/:virtual_machine/reset'

  # 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(opts[:'post_virtual_machine_start_request'])

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

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

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

#post_virtual_machine_shutdown(opts = {}) ⇒ PostVirtualMachineShutdown200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



8386
8387
8388
8389
# File 'lib/katapult-ruby/api/core_api.rb', line 8386

def post_virtual_machine_shutdown(opts = {})
  data, _status_code, _headers = post_virtual_machine_shutdown_with_http_info(opts)
  data
end

#post_virtual_machine_shutdown_with_http_info(opts = {}) ⇒ Array<(PostVirtualMachineShutdown200Response, Integer, Hash)>

Returns PostVirtualMachineShutdown200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



8394
8395
8396
8397
8398
8399
8400
8401
8402
8403
8404
8405
8406
8407
8408
8409
8410
8411
8412
8413
8414
8415
8416
8417
8418
8419
8420
8421
8422
8423
8424
8425
8426
8427
8428
8429
8430
8431
8432
8433
8434
8435
8436
8437
8438
8439
8440
8441
# File 'lib/katapult-ruby/api/core_api.rb', line 8394

def post_virtual_machine_shutdown_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.post_virtual_machine_shutdown ...'
  end
  # resource path
  local_var_path = '/virtual_machines/:virtual_machine/shutdown'

  # 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(opts[:'post_virtual_machine_start_request'])

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

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

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

#post_virtual_machine_start(opts = {}) ⇒ PostVirtualMachineStart200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



8446
8447
8448
8449
# File 'lib/katapult-ruby/api/core_api.rb', line 8446

def post_virtual_machine_start(opts = {})
  data, _status_code, _headers = post_virtual_machine_start_with_http_info(opts)
  data
end

#post_virtual_machine_start_with_http_info(opts = {}) ⇒ Array<(PostVirtualMachineStart200Response, Integer, Hash)>

Returns PostVirtualMachineStart200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



8454
8455
8456
8457
8458
8459
8460
8461
8462
8463
8464
8465
8466
8467
8468
8469
8470
8471
8472
8473
8474
8475
8476
8477
8478
8479
8480
8481
8482
8483
8484
8485
8486
8487
8488
8489
8490
8491
8492
8493
8494
8495
8496
8497
8498
8499
8500
8501
# File 'lib/katapult-ruby/api/core_api.rb', line 8454

def post_virtual_machine_start_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.post_virtual_machine_start ...'
  end
  # resource path
  local_var_path = '/virtual_machines/:virtual_machine/start'

  # 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(opts[:'post_virtual_machine_start_request'])

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

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

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

#post_virtual_machine_stop(opts = {}) ⇒ PostVirtualMachineStop200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



8506
8507
8508
8509
# File 'lib/katapult-ruby/api/core_api.rb', line 8506

def post_virtual_machine_stop(opts = {})
  data, _status_code, _headers = post_virtual_machine_stop_with_http_info(opts)
  data
end

#post_virtual_machine_stop_with_http_info(opts = {}) ⇒ Array<(PostVirtualMachineStop200Response, Integer, Hash)>

Returns PostVirtualMachineStop200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



8514
8515
8516
8517
8518
8519
8520
8521
8522
8523
8524
8525
8526
8527
8528
8529
8530
8531
8532
8533
8534
8535
8536
8537
8538
8539
8540
8541
8542
8543
8544
8545
8546
8547
8548
8549
8550
8551
8552
8553
8554
8555
8556
8557
8558
8559
8560
8561
# File 'lib/katapult-ruby/api/core_api.rb', line 8514

def post_virtual_machine_stop_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.post_virtual_machine_stop ...'
  end
  # resource path
  local_var_path = '/virtual_machines/:virtual_machine/stop'

  # 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(opts[:'post_virtual_machine_start_request'])

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

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

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

#put_virtual_machine_flexible_resources(opts = {}) ⇒ PutVirtualMachinePackage200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



8566
8567
8568
8569
# File 'lib/katapult-ruby/api/core_api.rb', line 8566

def put_virtual_machine_flexible_resources(opts = {})
  data, _status_code, _headers = put_virtual_machine_flexible_resources_with_http_info(opts)
  data
end

#put_virtual_machine_flexible_resources_with_http_info(opts = {}) ⇒ Array<(PutVirtualMachinePackage200Response, Integer, Hash)>

Returns PutVirtualMachinePackage200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
8604
8605
8606
8607
8608
8609
8610
8611
8612
8613
8614
8615
8616
8617
8618
8619
8620
8621
# File 'lib/katapult-ruby/api/core_api.rb', line 8574

def put_virtual_machine_flexible_resources_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.put_virtual_machine_flexible_resources ...'
  end
  # resource path
  local_var_path = '/virtual_machines/:virtual_machine/flexible_resources'

  # 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(opts[:'put_virtual_machine_flexible_resources_request'])

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

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

  new_options = opts.merge(
    :operation => :"CoreApi.put_virtual_machine_flexible_resources",
    :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(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CoreApi#put_virtual_machine_flexible_resources\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_virtual_machine_package(opts = {}) ⇒ PutVirtualMachinePackage200Response

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



8626
8627
8628
8629
# File 'lib/katapult-ruby/api/core_api.rb', line 8626

def put_virtual_machine_package(opts = {})
  data, _status_code, _headers = put_virtual_machine_package_with_http_info(opts)
  data
end

#put_virtual_machine_package_with_http_info(opts = {}) ⇒ Array<(PutVirtualMachinePackage200Response, Integer, Hash)>

Returns PutVirtualMachinePackage200Response data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



8634
8635
8636
8637
8638
8639
8640
8641
8642
8643
8644
8645
8646
8647
8648
8649
8650
8651
8652
8653
8654
8655
8656
8657
8658
8659
8660
8661
8662
8663
8664
8665
8666
8667
8668
8669
8670
8671
8672
8673
8674
8675
8676
8677
8678
8679
8680
8681
# File 'lib/katapult-ruby/api/core_api.rb', line 8634

def put_virtual_machine_package_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CoreApi.put_virtual_machine_package ...'
  end
  # resource path
  local_var_path = '/virtual_machines/:virtual_machine/package'

  # 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(opts[:'put_virtual_machine_package_request'])

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

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

  new_options = opts.merge(
    :operation => :"CoreApi.put_virtual_machine_package",
    :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(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CoreApi#put_virtual_machine_package\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end