Class: Ionoscloud::IPBlocksApi

Inherits:
Object
  • Object
show all
Defined in:
lib/ionoscloud/api/ip_blocks_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ IPBlocksApi

Returns a new instance of IPBlocksApi.



19
20
21
 
# File 'lib/ionoscloud/api/ip_blocks_api.rb', line 19

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/ionoscloud/api/ip_blocks_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#ipblocks_delete(ipblock_id, opts = {}) ⇒ Object

Delete IP Block Removes the specific IP Block

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :pretty (Boolean) —

    Controls whether response is pretty-printed (with indentation and new lines) (default to true)

  • :depth (Integer) —

    Controls the details depth of response objects. Eg. GET /datacenters/ - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=… and so on (default to 0)

  • :x_contract_number (Integer) —

    Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Returns:

  • (Object) 


30
31
32
33
 
# File 'lib/ionoscloud/api/ip_blocks_api.rb', line 30

def ipblocks_delete(ipblock_id, opts = {})
  data, _status_code, _headers = ipblocks_delete_with_http_info(ipblock_id, opts)
  data
end

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

Delete IP Block Removes the specific IP Block

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :pretty (Boolean) —

    Controls whether response is pretty-printed (with indentation and new lines)

  • :depth (Integer) —

    Controls the details depth of response objects. Eg. GET /datacenters/ - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;… and so on

  • :x_contract_number (Integer) —

    Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Returns:

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

    Object data, response status code and response headers



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/ionoscloud/api/ip_blocks_api.rb', line 43

def ipblocks_delete_with_http_info(ipblock_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IPBlocksApi.ipblocks_delete ...'
  end
  # verify the required parameter 'ipblock_id' is set
  if @api_client.config.client_side_validation && ipblock_id.nil?
    fail ArgumentError, "Missing the required parameter 'ipblock_id' when calling IPBlocksApi.ipblocks_delete"
  end
  if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] > 10
    fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling IPBlocksApi.ipblocks_delete, must be smaller than or equal to 10.'
  end

  if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] < 0
    fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling IPBlocksApi.ipblocks_delete, must be greater than or equal to 0.'
  end

  # resource path
  local_var_path = '/ipblocks/{ipblockId}'.sub('{' + 'ipblockId' + '}', CGI.escape(ipblock_id.to_s))

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

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

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

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

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

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

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

#ipblocks_find_by_id(ipblock_id, opts = {}) ⇒ IpBlock

Retrieve an IP Block Retrieves the attributes of a given IP Block.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :pretty (Boolean) —

    Controls whether response is pretty-printed (with indentation and new lines) (default to true)

  • :depth (Integer) —

    Controls the details depth of response objects. Eg. GET /datacenters/ - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;… and so on (default to 0)

  • :x_contract_number (Integer) —

    Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Returns:



110
111
112
113
 
# File 'lib/ionoscloud/api/ip_blocks_api.rb', line 110

def ipblocks_find_by_id(ipblock_id, opts = {})
  data, _status_code, _headers = ipblocks_find_by_id_with_http_info(ipblock_id, opts)
  data
end

#ipblocks_find_by_id_with_http_info(ipblock_id, opts = {}) ⇒ Array<(IpBlock, Integer, Hash)>

Retrieve an IP Block Retrieves the attributes of a given IP Block.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :pretty (Boolean) —

    Controls whether response is pretty-printed (with indentation and new lines)

  • :depth (Integer) —

    Controls the details depth of response objects. Eg. GET /datacenters/ - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;… and so on

  • :x_contract_number (Integer) —

    Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Returns:

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

    IpBlock data, response status code and response headers



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

def ipblocks_find_by_id_with_http_info(ipblock_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IPBlocksApi.ipblocks_find_by_id ...'
  end
  # verify the required parameter 'ipblock_id' is set
  if @api_client.config.client_side_validation && ipblock_id.nil?
    fail ArgumentError, "Missing the required parameter 'ipblock_id' when calling IPBlocksApi.ipblocks_find_by_id"
  end
  if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] > 10
    fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling IPBlocksApi.ipblocks_find_by_id, must be smaller than or equal to 10.'
  end

  if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] < 0
    fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling IPBlocksApi.ipblocks_find_by_id, must be greater than or equal to 0.'
  end

  # resource path
  local_var_path = '/ipblocks/{ipblockId}'.sub('{' + 'ipblockId' + '}', CGI.escape(ipblock_id.to_s))

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

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

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

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

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

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

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

#ipblocks_get(opts = {}) ⇒ IpBlocks

List IP Blocks Retrieve a list of all reserved IP Blocks

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :pretty (Boolean) —

    Controls whether response is pretty-printed (with indentation and new lines) (default to true)

  • :depth (Integer) —

    Controls the details depth of response objects. Eg. GET /datacenters/ - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;… and so on (default to 0)

  • :x_contract_number (Integer) —

    Users having more than 1 contract need to provide contract number, against which all API requests should be executed

  • :offset (Integer) —

    the first element (of the total list of elements) to include in the response (use together with &lt;code&gt;limit&lt;/code&gt; for pagination) (default to 0)

  • :limit (Integer) —

    the maximum number of elements to return (use together with offset for pagination) (default to 100)

Returns:



191
192
193
194
 
# File 'lib/ionoscloud/api/ip_blocks_api.rb', line 191

def ipblocks_get(opts = {})
  data, _status_code, _headers = ipblocks_get_with_http_info(opts)
  data
end

#ipblocks_get_with_http_info(opts = {}) ⇒ Array<(IpBlocks, Integer, Hash)>

List IP Blocks Retrieve a list of all reserved IP Blocks

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :pretty (Boolean) —

    Controls whether response is pretty-printed (with indentation and new lines)

  • :depth (Integer) —

    Controls the details depth of response objects. Eg. GET /datacenters/ - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;… and so on

  • :x_contract_number (Integer) —

    Users having more than 1 contract need to provide contract number, against which all API requests should be executed

  • :offset (Integer) —

    the first element (of the total list of elements) to include in the response (use together with &lt;code&gt;limit&lt;/code&gt; for pagination)

  • :limit (Integer) —

    the maximum number of elements to return (use together with offset for pagination)

Returns:

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

    IpBlocks data, response status code and response headers



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/ionoscloud/api/ip_blocks_api.rb', line 205

def ipblocks_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IPBlocksApi.ipblocks_get ...'
  end
  if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] > 10
    fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling IPBlocksApi.ipblocks_get, must be smaller than or equal to 10.'
  end

  if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] < 0
    fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling IPBlocksApi.ipblocks_get, must be greater than or equal to 0.'
  end

  if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] < 0
    fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling IPBlocksApi.ipblocks_get, must be greater than or equal to 0.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling IPBlocksApi.ipblocks_get, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling IPBlocksApi.ipblocks_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/ipblocks'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pretty'] = opts[:'pretty'] if !opts[:'pretty'].nil?
  query_params[:'depth'] = opts[:'depth'] if !opts[:'depth'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

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

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

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

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

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

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

#ipblocks_patch(ipblock_id, ipblock, opts = {}) ⇒ IpBlock

Partially modify IP Block You can use update attributes of a resource

Parameters:

  • ipblock_id (String)
  • ipblock (IpBlockProperties) —

    IP Block to be modified

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

    the optional parameters

Options Hash (opts):

  • :pretty (Boolean) —

    Controls whether response is pretty-printed (with indentation and new lines) (default to true)

  • :depth (Integer) —

    Controls the details depth of response objects. Eg. GET /datacenters/ - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;… and so on (default to 0)

  • :x_contract_number (Integer) —

    Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Returns:



283
284
285
286
 
# File 'lib/ionoscloud/api/ip_blocks_api.rb', line 283

def ipblocks_patch(ipblock_id, ipblock, opts = {})
  data, _status_code, _headers = ipblocks_patch_with_http_info(ipblock_id, ipblock, opts)
  data
end

#ipblocks_patch_with_http_info(ipblock_id, ipblock, opts = {}) ⇒ Array<(IpBlock, Integer, Hash)>

Partially modify IP Block You can use update attributes of a resource

Parameters:

  • ipblock_id (String)
  • ipblock (IpBlockProperties) —

    IP Block to be modified

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

    the optional parameters

Options Hash (opts):

  • :pretty (Boolean) —

    Controls whether response is pretty-printed (with indentation and new lines)

  • :depth (Integer) —

    Controls the details depth of response objects. Eg. GET /datacenters/ - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;… and so on

  • :x_contract_number (Integer) —

    Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Returns:

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

    IpBlock data, response status code and response headers



297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/ionoscloud/api/ip_blocks_api.rb', line 297

def ipblocks_patch_with_http_info(ipblock_id, ipblock, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IPBlocksApi.ipblocks_patch ...'
  end
  # verify the required parameter 'ipblock_id' is set
  if @api_client.config.client_side_validation && ipblock_id.nil?
    fail ArgumentError, "Missing the required parameter 'ipblock_id' when calling IPBlocksApi.ipblocks_patch"
  end
  # verify the required parameter 'ipblock' is set
  if @api_client.config.client_side_validation && ipblock.nil?
    fail ArgumentError, "Missing the required parameter 'ipblock' when calling IPBlocksApi.ipblocks_patch"
  end
  if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] > 10
    fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling IPBlocksApi.ipblocks_patch, must be smaller than or equal to 10.'
  end

  if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] < 0
    fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling IPBlocksApi.ipblocks_patch, must be greater than or equal to 0.'
  end

  # resource path
  local_var_path = '/ipblocks/{ipblockId}'.sub('{' + 'ipblockId' + '}', CGI.escape(ipblock_id.to_s))

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

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

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

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

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

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

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

#ipblocks_post(ipblock, opts = {}) ⇒ IpBlock

Reserve IP Block This will reserve a new IP Block

Parameters:

  • ipblock (IpBlock) —

    IP Block to be reserved

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

    the optional parameters

Options Hash (opts):

  • :pretty (Boolean) —

    Controls whether response is pretty-printed (with indentation and new lines) (default to true)

  • :depth (Integer) —

    Controls the details depth of response objects. Eg. GET /datacenters/ - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;… and so on (default to 0)

  • :x_contract_number (Integer) —

    Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Returns:



370
371
372
373
 
# File 'lib/ionoscloud/api/ip_blocks_api.rb', line 370

def ipblocks_post(ipblock, opts = {})
  data, _status_code, _headers = ipblocks_post_with_http_info(ipblock, opts)
  data
end

#ipblocks_post_with_http_info(ipblock, opts = {}) ⇒ Array<(IpBlock, Integer, Hash)>

Reserve IP Block This will reserve a new IP Block

Parameters:

  • ipblock (IpBlock) —

    IP Block to be reserved

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

    the optional parameters

Options Hash (opts):

  • :pretty (Boolean) —

    Controls whether response is pretty-printed (with indentation and new lines)

  • :depth (Integer) —

    Controls the details depth of response objects. Eg. GET /datacenters/ - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;… and so on

  • :x_contract_number (Integer) —

    Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Returns:

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

    IpBlock data, response status code and response headers



383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
 
# File 'lib/ionoscloud/api/ip_blocks_api.rb', line 383

def ipblocks_post_with_http_info(ipblock, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IPBlocksApi.ipblocks_post ...'
  end
  # verify the required parameter 'ipblock' is set
  if @api_client.config.client_side_validation && ipblock.nil?
    fail ArgumentError, "Missing the required parameter 'ipblock' when calling IPBlocksApi.ipblocks_post"
  end
  if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] > 10
    fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling IPBlocksApi.ipblocks_post, must be smaller than or equal to 10.'
  end

  if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] < 0
    fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling IPBlocksApi.ipblocks_post, must be greater than or equal to 0.'
  end

  # resource path
  local_var_path = '/ipblocks'

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

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

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

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

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

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

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

#ipblocks_put(ipblock_id, ipblock, opts = {}) ⇒ IpBlock

Modify IP Block You can use update attributes of a resource

Parameters:

  • ipblock_id (String)
  • ipblock (IpBlock) —

    IP Block to be modified

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

    the optional parameters

Options Hash (opts):

  • :pretty (Boolean) —

    Controls whether response is pretty-printed (with indentation and new lines) (default to true)

  • :depth (Integer) —

    Controls the details depth of response objects. Eg. GET /datacenters/ - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;… and so on (default to 0)

  • :x_contract_number (Integer) —

    Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Returns:



453
454
455
456
 
# File 'lib/ionoscloud/api/ip_blocks_api.rb', line 453

def ipblocks_put(ipblock_id, ipblock, opts = {})
  data, _status_code, _headers = ipblocks_put_with_http_info(ipblock_id, ipblock, opts)
  data
end

#ipblocks_put_with_http_info(ipblock_id, ipblock, opts = {}) ⇒ Array<(IpBlock, Integer, Hash)>

Modify IP Block You can use update attributes of a resource

Parameters:

  • ipblock_id (String)
  • ipblock (IpBlock) —

    IP Block to be modified

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

    the optional parameters

Options Hash (opts):

  • :pretty (Boolean) —

    Controls whether response is pretty-printed (with indentation and new lines)

  • :depth (Integer) —

    Controls the details depth of response objects. Eg. GET /datacenters/ - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;… and so on

  • :x_contract_number (Integer) —

    Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Returns:

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

    IpBlock data, response status code and response headers



467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
 
# File 'lib/ionoscloud/api/ip_blocks_api.rb', line 467

def ipblocks_put_with_http_info(ipblock_id, ipblock, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IPBlocksApi.ipblocks_put ...'
  end
  # verify the required parameter 'ipblock_id' is set
  if @api_client.config.client_side_validation && ipblock_id.nil?
    fail ArgumentError, "Missing the required parameter 'ipblock_id' when calling IPBlocksApi.ipblocks_put"
  end
  # verify the required parameter 'ipblock' is set
  if @api_client.config.client_side_validation && ipblock.nil?
    fail ArgumentError, "Missing the required parameter 'ipblock' when calling IPBlocksApi.ipblocks_put"
  end
  if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] > 10
    fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling IPBlocksApi.ipblocks_put, must be smaller than or equal to 10.'
  end

  if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] < 0
    fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling IPBlocksApi.ipblocks_put, must be greater than or equal to 0.'
  end

  # resource path
  local_var_path = '/ipblocks/{ipblockId}'.sub('{' + 'ipblockId' + '}', CGI.escape(ipblock_id.to_s))

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

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

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

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

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

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

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