Class: Coinbase::Client::AddressesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/coinbase/client/api/addresses_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AddressesApi

Returns a new instance of AddressesApi.



19
20
21
 
# File 'lib/coinbase/client/api/addresses_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/coinbase/client/api/addresses_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_address(wallet_id, opts = {}) ⇒ Address

Create a new address Create a new address scoped to the wallet.

Parameters:

  • wallet_id (String) —

    The ID of the wallet to create the address in.

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

    the optional parameters

Options Hash (opts):

Returns:



28
29
30
31
 
# File 'lib/coinbase/client/api/addresses_api.rb', line 28

def create_address(wallet_id, opts = {})
  data, _status_code, _headers = create_address_with_http_info(wallet_id, opts)
  data
end

#create_address_with_http_info(wallet_id, opts = {}) ⇒ Array<(Address, Integer, Hash)>

Create a new address Create a new address scoped to the wallet.

Parameters:

  • wallet_id (String) —

    The ID of the wallet to create the address in.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Address 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/coinbase/client/api/addresses_api.rb', line 39

def create_address_with_http_info(wallet_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AddressesApi.create_address ...'
  end
  # verify the required parameter 'wallet_id' is set
  if @api_client.config.client_side_validation && wallet_id.nil?
    fail ArgumentError, "Missing the required parameter 'wallet_id' when calling AddressesApi.create_address"
  end
  # resource path
  local_var_path = '/v1/wallets/{wallet_id}/addresses'.sub('{' + 'wallet_id' + '}', CGI.escape(wallet_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[:'create_address_request'])

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

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

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

#get_address(wallet_id, address_id, opts = {}) ⇒ Address

Get address by onchain address Get address

Parameters:

  • wallet_id (String) —

    The ID of the wallet the address belongs to.

  • address_id (String) —

    The onchain address of the address that is being fetched.

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

    the optional parameters

Returns:



98
99
100
101
 
# File 'lib/coinbase/client/api/addresses_api.rb', line 98

def get_address(wallet_id, address_id, opts = {})
  data, _status_code, _headers = get_address_with_http_info(wallet_id, address_id, opts)
  data
end

#get_address_balance(wallet_id, address_id, asset_id, opts = {}) ⇒ Balance

Get address balance for asset Get address balance

Parameters:

  • wallet_id (String) —

    The ID of the wallet to fetch the balance for

  • address_id (String) —

    The onchain address of the address that is being fetched.

  • asset_id (String) —

    The symbol of the asset to fetch the balance for

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

    the optional parameters

Returns:



168
169
170
171
 
# File 'lib/coinbase/client/api/addresses_api.rb', line 168

def get_address_balance(wallet_id, address_id, asset_id, opts = {})
  data, _status_code, _headers = get_address_balance_with_http_info(wallet_id, address_id, asset_id, opts)
  data
end

#get_address_balance_with_http_info(wallet_id, address_id, asset_id, opts = {}) ⇒ Array<(Balance, Integer, Hash)>

Get address balance for asset Get address balance

Parameters:

  • wallet_id (String) —

    The ID of the wallet to fetch the balance for

  • address_id (String) —

    The onchain address of the address that is being fetched.

  • asset_id (String) —

    The symbol of the asset to fetch the balance for

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

    the optional parameters

Returns:

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

    Balance data, response status code and response headers



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
226
227
228
229
230
231
232
233
234
 
# File 'lib/coinbase/client/api/addresses_api.rb', line 180

def get_address_balance_with_http_info(wallet_id, address_id, asset_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AddressesApi.get_address_balance ...'
  end
  # verify the required parameter 'wallet_id' is set
  if @api_client.config.client_side_validation && wallet_id.nil?
    fail ArgumentError, "Missing the required parameter 'wallet_id' when calling AddressesApi.get_address_balance"
  end
  # verify the required parameter 'address_id' is set
  if @api_client.config.client_side_validation && address_id.nil?
    fail ArgumentError, "Missing the required parameter 'address_id' when calling AddressesApi.get_address_balance"
  end
  # verify the required parameter 'asset_id' is set
  if @api_client.config.client_side_validation && asset_id.nil?
    fail ArgumentError, "Missing the required parameter 'asset_id' when calling AddressesApi.get_address_balance"
  end
  # resource path
  local_var_path = '/v1/wallets/{wallet_id}/addresses/{address_id}/balances/{asset_id}'.sub('{' + 'wallet_id' + '}', CGI.escape(wallet_id.to_s)).sub('{' + 'address_id' + '}', CGI.escape(address_id.to_s)).sub('{' + 'asset_id' + '}', CGI.escape(asset_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] || 'Balance'

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

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

#get_address_with_http_info(wallet_id, address_id, opts = {}) ⇒ Array<(Address, Integer, Hash)>

Get address by onchain address Get address

Parameters:

  • wallet_id (String) —

    The ID of the wallet the address belongs to.

  • address_id (String) —

    The onchain address of the address that is being fetched.

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

    the optional parameters

Returns:

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

    Address data, response status code and response headers



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
153
154
155
156
157
158
159
 
# File 'lib/coinbase/client/api/addresses_api.rb', line 109

def get_address_with_http_info(wallet_id, address_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AddressesApi.get_address ...'
  end
  # verify the required parameter 'wallet_id' is set
  if @api_client.config.client_side_validation && wallet_id.nil?
    fail ArgumentError, "Missing the required parameter 'wallet_id' when calling AddressesApi.get_address"
  end
  # verify the required parameter 'address_id' is set
  if @api_client.config.client_side_validation && address_id.nil?
    fail ArgumentError, "Missing the required parameter 'address_id' when calling AddressesApi.get_address"
  end
  # resource path
  local_var_path = '/v1/wallets/{wallet_id}/addresses/{address_id}'.sub('{' + 'wallet_id' + '}', CGI.escape(wallet_id.to_s)).sub('{' + 'address_id' + '}', CGI.escape(address_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] || 'Address'

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

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

#list_address_balances(wallet_id, address_id, opts = {}) ⇒ AddressBalanceList

Get all balances for address Get address balances

Parameters:

  • wallet_id (String) —

    The ID of the wallet to fetch the balances for

  • address_id (String) —

    The onchain address of the address that is being fetched.

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

    the optional parameters

Options Hash (opts):

  • :page (String) —

    A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.

Returns:



243
244
245
246
 
# File 'lib/coinbase/client/api/addresses_api.rb', line 243

def list_address_balances(wallet_id, address_id, opts = {})
  data, _status_code, _headers = list_address_balances_with_http_info(wallet_id, address_id, opts)
  data
end

#list_address_balances_with_http_info(wallet_id, address_id, opts = {}) ⇒ Array<(AddressBalanceList, Integer, Hash)>

Get all balances for address Get address balances

Parameters:

  • wallet_id (String) —

    The ID of the wallet to fetch the balances for

  • address_id (String) —

    The onchain address of the address that is being fetched.

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

    the optional parameters

Options Hash (opts):

  • :page (String) —

    A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.

Returns:

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

    AddressBalanceList data, response status code and response headers



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
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
 
# File 'lib/coinbase/client/api/addresses_api.rb', line 255

def list_address_balances_with_http_info(wallet_id, address_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AddressesApi.list_address_balances ...'
  end
  # verify the required parameter 'wallet_id' is set
  if @api_client.config.client_side_validation && wallet_id.nil?
    fail ArgumentError, "Missing the required parameter 'wallet_id' when calling AddressesApi.list_address_balances"
  end
  # verify the required parameter 'address_id' is set
  if @api_client.config.client_side_validation && address_id.nil?
    fail ArgumentError, "Missing the required parameter 'address_id' when calling AddressesApi.list_address_balances"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'].to_s.length > 5000
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling AddressesApi.list_address_balances, the character length must be smaller than or equal to 5000.'
  end

  # resource path
  local_var_path = '/v1/wallets/{wallet_id}/addresses/{address_id}/balances'.sub('{' + 'wallet_id' + '}', CGI.escape(wallet_id.to_s)).sub('{' + 'address_id' + '}', CGI.escape(address_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].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[:debug_body]

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

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

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

#list_addresses(wallet_id, opts = {}) ⇒ AddressList

List addresses in a wallet. List addresses in the wallet.

Parameters:

  • wallet_id (String) —

    The ID of the wallet whose addresses to fetch

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

  • :page (String) —

    A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.

Returns:



319
320
321
322
 
# File 'lib/coinbase/client/api/addresses_api.rb', line 319

def list_addresses(wallet_id, opts = {})
  data, _status_code, _headers = list_addresses_with_http_info(wallet_id, opts)
  data
end

#list_addresses_with_http_info(wallet_id, opts = {}) ⇒ Array<(AddressList, Integer, Hash)>

List addresses in a wallet. List addresses in the wallet.

Parameters:

  • wallet_id (String) —

    The ID of the wallet whose addresses to fetch

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

  • :page (String) —

    A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.

Returns:

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

    AddressList data, response status code and response headers



331
332
333
334
335
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
379
380
381
382
383
 
# File 'lib/coinbase/client/api/addresses_api.rb', line 331

def list_addresses_with_http_info(wallet_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AddressesApi.list_addresses ...'
  end
  # verify the required parameter 'wallet_id' is set
  if @api_client.config.client_side_validation && wallet_id.nil?
    fail ArgumentError, "Missing the required parameter 'wallet_id' when calling AddressesApi.list_addresses"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'].to_s.length > 5000
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling AddressesApi.list_addresses, the character length must be smaller than or equal to 5000.'
  end

  # resource path
  local_var_path = '/v1/wallets/{wallet_id}/addresses'.sub('{' + 'wallet_id' + '}', CGI.escape(wallet_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].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[:debug_body]

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

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

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

#request_faucet_funds(wallet_id, address_id, opts = {}) ⇒ FaucetTransaction

Request faucet funds for onchain address. Request faucet funds to be sent to onchain address.

Parameters:

  • wallet_id (String) —

    The ID of the wallet the address belongs to.

  • address_id (String) —

    The onchain address of the address that is being fetched.

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

    the optional parameters

Returns:



391
392
393
394
 
# File 'lib/coinbase/client/api/addresses_api.rb', line 391

def request_faucet_funds(wallet_id, address_id, opts = {})
  data, _status_code, _headers = request_faucet_funds_with_http_info(wallet_id, address_id, opts)
  data
end

#request_faucet_funds_with_http_info(wallet_id, address_id, opts = {}) ⇒ Array<(FaucetTransaction, Integer, Hash)>

Request faucet funds for onchain address. Request faucet funds to be sent to onchain address.

Parameters:

  • wallet_id (String) —

    The ID of the wallet the address belongs to.

  • address_id (String) —

    The onchain address of the address that is being fetched.

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

    the optional parameters

Returns:

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

    FaucetTransaction data, response status code and response headers



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
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
 
# File 'lib/coinbase/client/api/addresses_api.rb', line 402

def request_faucet_funds_with_http_info(wallet_id, address_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AddressesApi.request_faucet_funds ...'
  end
  # verify the required parameter 'wallet_id' is set
  if @api_client.config.client_side_validation && wallet_id.nil?
    fail ArgumentError, "Missing the required parameter 'wallet_id' when calling AddressesApi.request_faucet_funds"
  end
  # verify the required parameter 'address_id' is set
  if @api_client.config.client_side_validation && address_id.nil?
    fail ArgumentError, "Missing the required parameter 'address_id' when calling AddressesApi.request_faucet_funds"
  end
  # resource path
  local_var_path = '/v1/wallets/{wallet_id}/addresses/{address_id}/faucet'.sub('{' + 'wallet_id' + '}', CGI.escape(wallet_id.to_s)).sub('{' + 'address_id' + '}', CGI.escape(address_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] || 'FaucetTransaction'

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

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