Class: ClerkHttpClient::AllowListBlockListApi

Inherits:
Object
  • Object
show all
Defined in:
lib/clerk-http-client/api/allow_list_block_list_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AllowListBlockListApi

Returns a new instance of AllowListBlockListApi.



19
20
21
 
# File 'lib/clerk-http-client/api/allow_list_block_list_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/clerk-http-client/api/allow_list_block_list_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#all(opts = {}) ⇒ BlocklistIdentifiers

List all identifiers on the block-list Get a list of all identifiers which are not allowed to access an instance

Parameters:

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

    the optional parameters

Returns:



297
298
299
300
 
# File 'lib/clerk-http-client/api/allow_list_block_list_api.rb', line 297

def all(opts = {})
  data, _status_code, _headers = all_with_http_info(opts)
  data
end

#all_with_http_info(opts = {}) ⇒ Array<(BlocklistIdentifiers, Integer, Hash)>

List all identifiers on the block-list Get a list of all identifiers which are not allowed to access an instance GET

Parameters:

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

    the optional parameters

Returns:

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

    BlocklistIdentifiers data, response status code and response headers



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
 
# File 'lib/clerk-http-client/api/allow_list_block_list_api.rb', line 307

def all_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AllowListBlockListApi.list_allowlist_identifiers ...'
  end
  # resource path
  local_var_path = '/allowlist_identifiers'

  # 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']) unless header_params['Accept']

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

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

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

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

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

#create(create_blocklist_identifier_request, opts = {}) ⇒ BlocklistIdentifier

Add identifier to the block-list Create an identifier that is blocked from accessing an instance

Parameters:

Returns:



28
29
30
31
 
# File 'lib/clerk-http-client/api/allow_list_block_list_api.rb', line 28

def create(create_allowlist_identifier_request, opts = {})
  data, _status_code, _headers = create_with_http_info(create_allowlist_identifier_request, opts)
  data
end

#create_with_http_info(create_blocklist_identifier_request, opts = {}) ⇒ Array<(BlocklistIdentifier, Integer, Hash)>

Add identifier to the block-list Create an identifier that is blocked from accessing an instance POST

Parameters:

Returns:

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

    BlocklistIdentifier data, response status code and response headers



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
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/clerk-http-client/api/allow_list_block_list_api.rb', line 39

def create_with_http_info(create_allowlist_identifier_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AllowListBlockListApi.create_allowlist_identifier ...'
  end
  # verify the required parameter 'create_allowlist_identifier_request' is set
  if @api_client.config.client_side_validation && create_allowlist_identifier_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_allowlist_identifier_request' when calling AllowListBlockListApi.create_allowlist_identifier"
  end
  # resource path
  local_var_path = '/allowlist_identifiers'

  # 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']) unless header_params['Accept']
  # 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(create_allowlist_identifier_request)

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

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

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

#delete(identifier_id, opts = {}) ⇒ DeletedObject

Delete identifier from block-list Delete an identifier from the instance block-list

Parameters:

  • identifier_id (String) —

    The ID of the identifier to delete from the block-list

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

    the optional parameters

Returns:



168
169
170
171
 
# File 'lib/clerk-http-client/api/allow_list_block_list_api.rb', line 168

def delete(identifier_id, opts = {})
  data, _status_code, _headers = delete_with_http_info(identifier_id, opts)
  data
end

#delete_with_http_info(identifier_id, opts = {}) ⇒ Array<(DeletedObject, Integer, Hash)>

Delete identifier from block-list Delete an identifier from the instance block-list DELETE

Parameters:

  • identifier_id (String) —

    The ID of the identifier to delete from the block-list

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

    the optional parameters

Returns:

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

    DeletedObject data, response status code and response headers



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
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/clerk-http-client/api/allow_list_block_list_api.rb', line 179

def delete_with_http_info(identifier_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AllowListBlockListApi.delete_allowlist_identifier ...'
  end
  # verify the required parameter 'identifier_id' is set
  if @api_client.config.client_side_validation && identifier_id.nil?
    fail ArgumentError, "Missing the required parameter 'identifier_id' when calling AllowListBlockListApi.delete_allowlist_identifier"
  end
  # resource path
  local_var_path = '/allowlist_identifiers/{identifier_id}'.sub('{' + 'identifier_id' + '}', CGI.escape(identifier_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']) unless header_params['Accept']

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

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

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

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

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