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

#create_allowlist_identifier(opts = {}) ⇒ AllowlistIdentifier

Add identifier to the allow-list Create an identifier allowed to sign up to an instance

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



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

def create_allowlist_identifier(opts = {})
  data, _status_code, _headers = create_allowlist_identifier_with_http_info(opts)
  data
end

#create_allowlist_identifier_with_http_info(opts = {}) ⇒ Array<(AllowlistIdentifier, Integer, Hash)>

Add identifier to the allow-list Create an identifier allowed to sign up to an instance POST

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

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

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

#create_blocklist_identifier(opts = {}) ⇒ BlocklistIdentifier

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

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



94
95
96
97
 
# File 'lib/clerk-http-client/api/allow_list_block_list_api.rb', line 94

def create_blocklist_identifier(opts = {})
  data, _status_code, _headers = create_blocklist_identifier_with_http_info(opts)
  data
end

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

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

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    BlocklistIdentifier data, response status code and response headers



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
144
145
146
147
148
149
150
151
152
 
# File 'lib/clerk-http-client/api/allow_list_block_list_api.rb', line 105

def create_blocklist_identifier_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AllowListBlockListApi.create_blocklist_identifier ...'
  end
  # resource path
  local_var_path = '/blocklist_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(opts[:'create_blocklist_identifier_request'])

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

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

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

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

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

Parameters:

  • identifier_id (String) —

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

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

    the optional parameters

Returns:



160
161
162
163
 
# File 'lib/clerk-http-client/api/allow_list_block_list_api.rb', line 160

def delete_allowlist_identifier(identifier_id, opts = {})
  data, _status_code, _headers = delete_allowlist_identifier_with_http_info(identifier_id, opts)
  data
end

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

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

Parameters:

  • identifier_id (String) —

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

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

    the optional parameters

Returns:

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

    DeletedObject data, response status code and response headers



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
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/clerk-http-client/api/allow_list_block_list_api.rb', line 171

def delete_allowlist_identifier_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

#delete_blocklist_identifier(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:



225
226
227
228
 
# File 'lib/clerk-http-client/api/allow_list_block_list_api.rb', line 225

def delete_blocklist_identifier(identifier_id, opts = {})
  data, _status_code, _headers = delete_blocklist_identifier_with_http_info(identifier_id, opts)
  data
end

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



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

def delete_blocklist_identifier_with_http_info(identifier_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AllowListBlockListApi.delete_blocklist_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_blocklist_identifier"
  end
  # resource path
  local_var_path = '/blocklist_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_blocklist_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_blocklist_identifier\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_allowlist_identifiers(opts = {}) ⇒ Array<AllowlistIdentifier>

List all identifiers on the allow-list Get a list of all identifiers allowed to sign up to an instance

Parameters:

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

    the optional parameters

Returns:



289
290
291
292
 
# File 'lib/clerk-http-client/api/allow_list_block_list_api.rb', line 289

def list_allowlist_identifiers(opts = {})
  data, _status_code, _headers = list_allowlist_identifiers_with_http_info(opts)
  data
end

#list_allowlist_identifiers_with_http_info(opts = {}) ⇒ Array<(Array<AllowlistIdentifier>, Integer, Hash)>

List all identifiers on the allow-list Get a list of all identifiers allowed to sign up to an instance GET array

Parameters:

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

    the optional parameters

Returns:

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

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



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

def list_allowlist_identifiers_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

#list_blocklist_identifiers(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:



348
349
350
351
 
# File 'lib/clerk-http-client/api/allow_list_block_list_api.rb', line 348

def list_blocklist_identifiers(opts = {})
  data, _status_code, _headers = list_blocklist_identifiers_with_http_info(opts)
  data
end

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



358
359
360
361
362
363
364
365
366
367
368
369
370
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
 
# File 'lib/clerk-http-client/api/allow_list_block_list_api.rb', line 358

def list_blocklist_identifiers_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AllowListBlockListApi.list_blocklist_identifiers ...'
  end
  # resource path
  local_var_path = '/blocklist_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] || 'BlocklistIdentifiers'

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

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