Class: IpApi::IPBlocksApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ IPBlocksApi 



19
20
21
 
# File 'lib/pnap_ip_api/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/pnap_ip_api/api/ip_blocks_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#ip_blocks_get(opts = {}) ⇒ Array<IpBlock>

List IP Blocks. List all IP Blocks.

Options Hash (opts):

  • :tag (Array<String>) —

    List of tags, in the form tagName.tagValue, to filter by.



27
28
29
30
 
# File 'lib/pnap_ip_api/api/ip_blocks_api.rb', line 27

def ip_blocks_get(opts = {})
  data, _status_code, _headers = ip_blocks_get_with_http_info(opts)
  data
end

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

List IP Blocks. List all IP Blocks.

Options Hash (opts):

  • :tag (Array<String>) —

    List of tags, in the form tagName.tagValue, to filter by.



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/pnap_ip_api/api/ip_blocks_api.rb', line 37

def ip_blocks_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IPBlocksApi.ip_blocks_get ...'
  end
  # resource path
  local_var_path = '/ip-blocks'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'tag'] = @api_client.build_collection_param(opts[:'tag'], :multi) if !opts[:'tag'].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] || 'Array<IpBlock>'

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

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

#ip_blocks_ip_block_id_delete(ip_block_id, opts = {}) ⇒ DeleteIpBlockResult

Delete IP Block. Delete an IP Block. An IP Block can only be deleted if not assigned to any resource.



87
88
89
90
 
# File 'lib/pnap_ip_api/api/ip_blocks_api.rb', line 87

def ip_blocks_ip_block_id_delete(ip_block_id, opts = {})
  data, _status_code, _headers = ip_blocks_ip_block_id_delete_with_http_info(ip_block_id, opts)
  data
end

#ip_blocks_ip_block_id_delete_with_http_info(ip_block_id, opts = {}) ⇒ Array<(DeleteIpBlockResult, Integer, Hash)>

Delete IP Block. Delete an IP Block. An IP Block can only be deleted if not assigned to any resource.



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
141
142
143
 
# File 'lib/pnap_ip_api/api/ip_blocks_api.rb', line 97

def ip_blocks_ip_block_id_delete_with_http_info(ip_block_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IPBlocksApi.ip_blocks_ip_block_id_delete ...'
  end
  # verify the required parameter 'ip_block_id' is set
  if @api_client.config.client_side_validation && ip_block_id.nil?
    fail ArgumentError, "Missing the required parameter 'ip_block_id' when calling IPBlocksApi.ip_blocks_ip_block_id_delete"
  end
  # resource path
  local_var_path = '/ip-blocks/{ipBlockId}'.sub('{' + 'ipBlockId' + '}', CGI.escape(ip_block_id.to_s))

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

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

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

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

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

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

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

#ip_blocks_ip_block_id_get(ip_block_id, opts = {}) ⇒ IpBlock

Get IP Block. Get IP Block.



150
151
152
153
 
# File 'lib/pnap_ip_api/api/ip_blocks_api.rb', line 150

def ip_blocks_ip_block_id_get(ip_block_id, opts = {})
  data, _status_code, _headers = ip_blocks_ip_block_id_get_with_http_info(ip_block_id, opts)
  data
end

#ip_blocks_ip_block_id_get_with_http_info(ip_block_id, opts = {}) ⇒ Array<(IpBlock, Integer, Hash)>

Get IP Block. Get IP Block.



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
201
202
203
204
205
206
 
# File 'lib/pnap_ip_api/api/ip_blocks_api.rb', line 160

def ip_blocks_ip_block_id_get_with_http_info(ip_block_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IPBlocksApi.ip_blocks_ip_block_id_get ...'
  end
  # verify the required parameter 'ip_block_id' is set
  if @api_client.config.client_side_validation && ip_block_id.nil?
    fail ArgumentError, "Missing the required parameter 'ip_block_id' when calling IPBlocksApi.ip_blocks_ip_block_id_get"
  end
  # resource path
  local_var_path = '/ip-blocks/{ipBlockId}'.sub('{' + 'ipBlockId' + '}', CGI.escape(ip_block_id.to_s))

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

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

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

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

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

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

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

#ip_blocks_ip_block_id_patch(ip_block_id, ip_block_patch, opts = {}) ⇒ IpBlock

Update IP block. Update IP Block’s details.



214
215
216
217
 
# File 'lib/pnap_ip_api/api/ip_blocks_api.rb', line 214

def ip_blocks_ip_block_id_patch(ip_block_id, ip_block_patch, opts = {})
  data, _status_code, _headers = ip_blocks_ip_block_id_patch_with_http_info(ip_block_id, ip_block_patch, opts)
  data
end

#ip_blocks_ip_block_id_patch_with_http_info(ip_block_id, ip_block_patch, opts = {}) ⇒ Array<(IpBlock, Integer, Hash)>

Update IP block. Update IP Block&#39;s details.



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
273
274
275
276
277
278
279
280
 
# File 'lib/pnap_ip_api/api/ip_blocks_api.rb', line 225

def ip_blocks_ip_block_id_patch_with_http_info(ip_block_id, ip_block_patch, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IPBlocksApi.ip_blocks_ip_block_id_patch ...'
  end
  # verify the required parameter 'ip_block_id' is set
  if @api_client.config.client_side_validation && ip_block_id.nil?
    fail ArgumentError, "Missing the required parameter 'ip_block_id' when calling IPBlocksApi.ip_blocks_ip_block_id_patch"
  end
  # verify the required parameter 'ip_block_patch' is set
  if @api_client.config.client_side_validation && ip_block_patch.nil?
    fail ArgumentError, "Missing the required parameter 'ip_block_patch' when calling IPBlocksApi.ip_blocks_ip_block_id_patch"
  end
  # resource path
  local_var_path = '/ip-blocks/{ipBlockId}'.sub('{' + 'ipBlockId' + '}', CGI.escape(ip_block_id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  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(ip_block_patch)

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

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

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

#ip_blocks_ip_block_id_tags_put(ip_block_id, tag_assignment_request, opts = {}) ⇒ IpBlock

Overwrite tags assigned for IP Block. Overwrites tags assigned for IP Block and unassigns any tags not part of the request.



288
289
290
291
 
# File 'lib/pnap_ip_api/api/ip_blocks_api.rb', line 288

def ip_blocks_ip_block_id_tags_put(ip_block_id, tag_assignment_request, opts = {})
  data, _status_code, _headers = ip_blocks_ip_block_id_tags_put_with_http_info(ip_block_id, tag_assignment_request, opts)
  data
end

#ip_blocks_ip_block_id_tags_put_with_http_info(ip_block_id, tag_assignment_request, opts = {}) ⇒ Array<(IpBlock, Integer, Hash)>

Overwrite tags assigned for IP Block. Overwrites tags assigned for IP Block and unassigns any tags not part of the request.



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
 
# File 'lib/pnap_ip_api/api/ip_blocks_api.rb', line 299

def ip_blocks_ip_block_id_tags_put_with_http_info(ip_block_id, tag_assignment_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IPBlocksApi.ip_blocks_ip_block_id_tags_put ...'
  end
  # verify the required parameter 'ip_block_id' is set
  if @api_client.config.client_side_validation && ip_block_id.nil?
    fail ArgumentError, "Missing the required parameter 'ip_block_id' when calling IPBlocksApi.ip_blocks_ip_block_id_tags_put"
  end
  # verify the required parameter 'tag_assignment_request' is set
  if @api_client.config.client_side_validation && tag_assignment_request.nil?
    fail ArgumentError, "Missing the required parameter 'tag_assignment_request' when calling IPBlocksApi.ip_blocks_ip_block_id_tags_put"
  end
  # resource path
  local_var_path = '/ip-blocks/{ipBlockId}/tags'.sub('{' + 'ipBlockId' + '}', CGI.escape(ip_block_id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  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(tag_assignment_request)

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

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

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

#ip_blocks_post(ip_block_create, opts = {}) ⇒ IpBlock

Create an IP Block. Request an IP Block. An IP Block is a set of contiguous IPs that can be assigned to other resources such as servers.



361
362
363
364
 
# File 'lib/pnap_ip_api/api/ip_blocks_api.rb', line 361

def ip_blocks_post(ip_block_create, opts = {})
  data, _status_code, _headers = ip_blocks_post_with_http_info(ip_block_create, opts)
  data
end

#ip_blocks_post_with_http_info(ip_block_create, opts = {}) ⇒ Array<(IpBlock, Integer, Hash)>

Create an IP Block. Request an IP Block. An IP Block is a set of contiguous IPs that can be assigned to other resources such as servers.



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

def ip_blocks_post_with_http_info(ip_block_create, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IPBlocksApi.ip_blocks_post ...'
  end
  # verify the required parameter 'ip_block_create' is set
  if @api_client.config.client_side_validation && ip_block_create.nil?
    fail ArgumentError, "Missing the required parameter 'ip_block_create' when calling IPBlocksApi.ip_blocks_post"
  end
  # resource path
  local_var_path = '/ip-blocks'

  # 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(ip_block_create)

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

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

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