Class: VeniceClient::APIKeysApi

Inherits:
Object
  • Object
show all
Defined in:
lib/venice_client/api/api_keys_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ APIKeysApi

Returns a new instance of APIKeysApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_api_key(opts = {}) ⇒ CreateApiKey200Response

/api/v1/api_keys Create a new API key.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



27
28
29
30
 
# File 'lib/venice_client/api/api_keys_api.rb', line 27

def create_api_key(opts = {})
  data, _status_code, _headers = create_api_key_with_http_info(opts)
  data
end

#create_api_key_with_http_info(opts = {}) ⇒ Array<(CreateApiKey200Response, Integer, Hash)>

/api/v1/api_keys Create a new API key.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    CreateApiKey200Response data, response status code and response headers



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
81
82
83
84
 
# File 'lib/venice_client/api/api_keys_api.rb', line 37

def create_api_key_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: APIKeysApi.create_api_key ...'
  end
  # resource path
  local_var_path = '/api_keys'

  # 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_api_key_request'])

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

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

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

#delete_api_key(opts = {}) ⇒ DeleteApiKey200Response

/api/v1/api_keys Delete an API key.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :id (String) —

    The ID of the API key to delete

Returns:



91
92
93
94
 
# File 'lib/venice_client/api/api_keys_api.rb', line 91

def delete_api_key(opts = {})
  data, _status_code, _headers = delete_api_key_with_http_info(opts)
  data
end

#delete_api_key_with_http_info(opts = {}) ⇒ Array<(DeleteApiKey200Response, Integer, Hash)>

/api/v1/api_keys Delete an API key.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :id (String) —

    The ID of the API key to delete

Returns:

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

    DeleteApiKey200Response data, response status code and response headers



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
144
 
# File 'lib/venice_client/api/api_keys_api.rb', line 101

def delete_api_key_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: APIKeysApi.delete_api_key ...'
  end
  # resource path
  local_var_path = '/api_keys'

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

  # 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] || 'DeleteApiKey200Response'

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

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

#get_api_key_by_id(id, opts = {}) ⇒ GetApiKeyById200Response

Get API key details by ID Return details about a specific API key, including rate limits and balance data.

Parameters:

  • id (String) —

    The ID of the API key to retrieve

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

    the optional parameters

Returns:



151
152
153
154
 
# File 'lib/venice_client/api/api_keys_api.rb', line 151

def get_api_key_by_id(id, opts = {})
  data, _status_code, _headers = get_api_key_by_id_with_http_info(id, opts)
  data
end

#get_api_key_by_id_with_http_info(id, opts = {}) ⇒ Array<(GetApiKeyById200Response, Integer, Hash)>

Get API key details by ID Return details about a specific API key, including rate limits and balance data.

Parameters:

  • id (String) —

    The ID of the API key to retrieve

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

    the optional parameters

Returns:

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

    GetApiKeyById200Response data, response status code and response headers



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
207
 
# File 'lib/venice_client/api/api_keys_api.rb', line 161

def get_api_key_by_id_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: APIKeysApi.get_api_key_by_id ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling APIKeysApi.get_api_key_by_id"
  end
  # resource path
  local_var_path = '/api_keys/{id}'.sub('{' + 'id' + '}', CGI.escape(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] || 'GetApiKeyById200Response'

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

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

#get_api_key_generate_web3_key(opts = {}) ⇒ GetApiKeyGenerateWeb3Key200Response

/api/v1/api_keys/generate_web3_key Returns the token required to generate an API key via a wallet.

Parameters:

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

    the optional parameters

Returns:



213
214
215
216
 
# File 'lib/venice_client/api/api_keys_api.rb', line 213

def get_api_key_generate_web3_key(opts = {})
  data, _status_code, _headers = get_api_key_generate_web3_key_with_http_info(opts)
  data
end

#get_api_key_generate_web3_key_with_http_info(opts = {}) ⇒ Array<(GetApiKeyGenerateWeb3Key200Response, Integer, Hash)>

/api/v1/api_keys/generate_web3_key Returns the token required to generate an API key via a wallet.

Parameters:

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

    the optional parameters

Returns:



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
 
# File 'lib/venice_client/api/api_keys_api.rb', line 222

def get_api_key_generate_web3_key_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: APIKeysApi.get_api_key_generate_web3_key ...'
  end
  # resource path
  local_var_path = '/api_keys/generate_web3_key'

  # 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] || 'GetApiKeyGenerateWeb3Key200Response'

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

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

#get_api_key_rate_limit_logs(opts = {}) ⇒ GetApiKeyRateLimitLogs200Response

/api/v1/api_keys/rate_limits/log Returns the last 50 rate limits that the account exceeded.

Parameters:

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

    the optional parameters

Returns:



270
271
272
273
 
# File 'lib/venice_client/api/api_keys_api.rb', line 270

def get_api_key_rate_limit_logs(opts = {})
  data, _status_code, _headers = get_api_key_rate_limit_logs_with_http_info(opts)
  data
end

#get_api_key_rate_limit_logs_with_http_info(opts = {}) ⇒ Array<(GetApiKeyRateLimitLogs200Response, Integer, Hash)>

/api/v1/api_keys/rate_limits/log Returns the last 50 rate limits that the account exceeded.

Parameters:

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

    the optional parameters

Returns:



279
280
281
282
283
284
285
286
287
288
289
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
 
# File 'lib/venice_client/api/api_keys_api.rb', line 279

def get_api_key_rate_limit_logs_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: APIKeysApi.get_api_key_rate_limit_logs ...'
  end
  # resource path
  local_var_path = '/api_keys/rate_limits/log'

  # 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] || 'GetApiKeyRateLimitLogs200Response'

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

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

#get_api_key_rate_limits(opts = {}) ⇒ GetApiKeyRateLimits200Response

/api/v1/api_keys/rate_limits Return details about user balances and rate limits.

Parameters:

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

    the optional parameters

Returns:



327
328
329
330
 
# File 'lib/venice_client/api/api_keys_api.rb', line 327

def get_api_key_rate_limits(opts = {})
  data, _status_code, _headers = get_api_key_rate_limits_with_http_info(opts)
  data
end

#get_api_key_rate_limits_with_http_info(opts = {}) ⇒ Array<(GetApiKeyRateLimits200Response, Integer, Hash)>

/api/v1/api_keys/rate_limits Return details about user balances and rate limits.

Parameters:

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

    the optional parameters

Returns:



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
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/venice_client/api/api_keys_api.rb', line 336

def get_api_key_rate_limits_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: APIKeysApi.get_api_key_rate_limits ...'
  end
  # resource path
  local_var_path = '/api_keys/rate_limits'

  # 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] || 'GetApiKeyRateLimits200Response'

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

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

#get_api_keys(opts = {}) ⇒ GetApiKeys200Response

/api/v1/api_keys Return a list of API keys.

Parameters:

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

    the optional parameters

Returns:



384
385
386
387
 
# File 'lib/venice_client/api/api_keys_api.rb', line 384

def get_api_keys(opts = {})
  data, _status_code, _headers = get_api_keys_with_http_info(opts)
  data
end

#get_api_keys_with_http_info(opts = {}) ⇒ Array<(GetApiKeys200Response, Integer, Hash)>

/api/v1/api_keys Return a list of API keys.

Parameters:

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

    the optional parameters

Returns:

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

    GetApiKeys200Response data, response status code and response headers



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
 
# File 'lib/venice_client/api/api_keys_api.rb', line 393

def get_api_keys_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: APIKeysApi.get_api_keys ...'
  end
  # resource path
  local_var_path = '/api_keys'

  # 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] || 'GetApiKeys200Response'

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

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

#post_api_key_generate_web3_key(opts = {}) ⇒ CreateApiKey200Response

/api/v1/api_keys/generate_web3_key Authenticates a wallet holding sVVV and creates an API key.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



442
443
444
445
 
# File 'lib/venice_client/api/api_keys_api.rb', line 442

def post_api_key_generate_web3_key(opts = {})
  data, _status_code, _headers = post_api_key_generate_web3_key_with_http_info(opts)
  data
end

#post_api_key_generate_web3_key_with_http_info(opts = {}) ⇒ Array<(CreateApiKey200Response, Integer, Hash)>

/api/v1/api_keys/generate_web3_key Authenticates a wallet holding sVVV and creates an API key.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    CreateApiKey200Response data, response status code and response headers



452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
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
 
# File 'lib/venice_client/api/api_keys_api.rb', line 452

def post_api_key_generate_web3_key_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: APIKeysApi.post_api_key_generate_web3_key ...'
  end
  # resource path
  local_var_path = '/api_keys/generate_web3_key'

  # 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[:'post_api_key_generate_web3_key_request'])

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

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

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