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.



16
17
18
 
# File 'lib/venice_client/api/api_keys_api.rb', line 16

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



14
15
16
 
# File 'lib/venice_client/api/api_keys_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#create_api_key(opts = {}) ⇒ InlineResponse2008

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

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



24
25
26
27
 
# File 'lib/venice_client/api/api_keys_api.rb', line 24

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<(InlineResponse2008, Integer, Hash)>

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

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    InlineResponse2008 data, response status code and response headers



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

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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(opts[:'body']) 

  return_type = opts[:return_type] || 'InlineResponse2008' 

  auth_names = opts[:auth_names] || ['BearerAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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 = {}) ⇒ InlineResponse2009

/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:



78
79
80
81
 
# File 'lib/venice_client/api/api_keys_api.rb', line 78

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<(InlineResponse2009, 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<(InlineResponse2009, Integer, Hash)>) —

    InlineResponse2009 data, response status code and response headers



88
89
90
91
92
93
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
 
# File 'lib/venice_client/api/api_keys_api.rb', line 88

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

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

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

  return_type = opts[:return_type] || 'InlineResponse2009' 

  auth_names = opts[:auth_names] || ['BearerAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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_generate_web3_key(opts = {}) ⇒ InlineResponse20012

/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:



130
131
132
133
 
# File 'lib/venice_client/api/api_keys_api.rb', line 130

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<(InlineResponse20012, 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:

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

    InlineResponse20012 data, response status code and response headers



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/venice_client/api/api_keys_api.rb', line 139

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

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

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

  return_type = opts[:return_type] || 'InlineResponse20012' 

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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 = {}) ⇒ InlineResponse20011

/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:



180
181
182
183
 
# File 'lib/venice_client/api/api_keys_api.rb', line 180

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<(InlineResponse20011, 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:

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

    InlineResponse20011 data, response status code and response headers



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/venice_client/api/api_keys_api.rb', line 189

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

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

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

  return_type = opts[:return_type] || 'InlineResponse20011' 

  auth_names = opts[:auth_names] || ['BearerAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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 = {}) ⇒ InlineResponse20010

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

Parameters:

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

    the optional parameters

Returns:



230
231
232
233
 
# File 'lib/venice_client/api/api_keys_api.rb', line 230

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<(InlineResponse20010, 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:

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

    InlineResponse20010 data, response status code and response headers



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

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

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

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

  return_type = opts[:return_type] || 'InlineResponse20010' 

  auth_names = opts[:auth_names] || ['BearerAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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 = {}) ⇒ InlineResponse2007

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

Parameters:

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

    the optional parameters

Returns:



280
281
282
283
 
# File 'lib/venice_client/api/api_keys_api.rb', line 280

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<(InlineResponse2007, Integer, Hash)>

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

Parameters:

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

    the optional parameters

Returns:

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

    InlineResponse2007 data, response status code and response headers



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
322
323
324
325
 
# File 'lib/venice_client/api/api_keys_api.rb', line 289

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

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

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

  return_type = opts[:return_type] || 'InlineResponse2007' 

  auth_names = opts[:auth_names] || ['BearerAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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 = {}) ⇒ InlineResponse2008

/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:



331
332
333
334
 
# File 'lib/venice_client/api/api_keys_api.rb', line 331

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<(InlineResponse2008, 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<(InlineResponse2008, Integer, Hash)>) —

    InlineResponse2008 data, response status code and response headers



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

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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(opts[:'body']) 

  return_type = opts[:return_type] || 'InlineResponse2008' 

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  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