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

Returns a new instance of 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.

Parameters:

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

    the optional parameters

Returns:



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

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.

Parameters:

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

    the optional parameters

Returns:

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

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



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

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] || {}

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

Parameters:

  • ip_block_id (String) —

    The IP Block identifier.

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

    the optional parameters

Returns:



84
85
86
87
 
# File 'lib/pnap_ip_api/api/ip_blocks_api.rb', line 84

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.

Parameters:

  • ip_block_id (String) —

    The IP Block identifier.

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

    the optional parameters

Returns:

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

    DeleteIpBlockResult data, response status code and response headers



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

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.

Parameters:

  • ip_block_id (String) —

    The IP Block identifier.

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

    the optional parameters

Returns:



147
148
149
150
 
# File 'lib/pnap_ip_api/api/ip_blocks_api.rb', line 147

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.

Parameters:

  • ip_block_id (String) —

    The IP Block identifier.

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

    the optional parameters

Returns:

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

    IpBlock data, response status code and response headers



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

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, opts = {}) ⇒ IpBlock

Update IP block. Update IP Block's details.

Parameters:

  • ip_block_id (String) —

    The IP Block identifier.

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

    the optional parameters

Options Hash (opts):

Returns:



211
212
213
214
 
# File 'lib/pnap_ip_api/api/ip_blocks_api.rb', line 211

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

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

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

Parameters:

  • ip_block_id (String) —

    The IP Block identifier.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    IpBlock data, response status code and response headers



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

def ip_blocks_ip_block_id_patch_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_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
  # 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(opts[:'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_post(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.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



280
281
282
283
 
# File 'lib/pnap_ip_api/api/ip_blocks_api.rb', line 280

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

#ip_blocks_post_with_http_info(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.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    IpBlock data, response status code and response headers



290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/pnap_ip_api/api/ip_blocks_api.rb', line 290

def ip_blocks_post_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: 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(opts[:'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