Class: Coinbase::Client::ExternalAddressesApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ExternalAddressesApi

Returns a new instance of ExternalAddressesApi.



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

def api_client
  @api_client
end

Instance Method Details

#get_external_address_balance(network_id, address_id, asset_id, opts = {}) ⇒ Balance

Get the balance of an asset in an external address Get the balance of an asset in an external address

Parameters:

  • network_id (String) —

    The ID of the blockchain network

  • address_id (String) —

    The ID of the address to fetch the balance for

  • asset_id (String) —

    The ID of the asset to fetch the balance for

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

    the optional parameters

Returns:



29
30
31
32
 
# File 'lib/coinbase/client/api/external_addresses_api.rb', line 29

def get_external_address_balance(network_id, address_id, asset_id, opts = {})
  data, _status_code, _headers = get_external_address_balance_with_http_info(network_id, address_id, asset_id, opts)
  data
end

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

Get the balance of an asset in an external address Get the balance of an asset in an external address

Parameters:

  • network_id (String) —

    The ID of the blockchain network

  • address_id (String) —

    The ID of the address to fetch the balance for

  • asset_id (String) —

    The ID 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



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
91
92
93
94
95
 
# File 'lib/coinbase/client/api/external_addresses_api.rb', line 41

def get_external_address_balance_with_http_info(network_id, address_id, asset_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ExternalAddressesApi.get_external_address_balance ...'
  end
  # verify the required parameter 'network_id' is set
  if @api_client.config.client_side_validation && network_id.nil?
    fail ArgumentError, "Missing the required parameter 'network_id' when calling ExternalAddressesApi.get_external_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 ExternalAddressesApi.get_external_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 ExternalAddressesApi.get_external_address_balance"
  end
  # resource path
  local_var_path = '/v1/networks/{network_id}/addresses/{address_id}/balances/{asset_id}'.sub('{' + 'network_id' + '}', CGI.escape(network_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 => :"ExternalAddressesApi.get_external_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: ExternalAddressesApi#get_external_address_balance\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_address_historical_balance(network_id, address_id, asset_id, opts = {}) ⇒ AddressHistoricalBalanceList

Get address balance history for asset List the historical balance of an asset in a specific address.

Parameters:

  • network_id (String) —

    The ID of the blockchain network

  • address_id (String) —

    The ID of the address to fetch the historical balance for.

  • asset_id (String) —

    The symbol of the asset to fetch the historical balance for.

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



106
107
108
109
 
# File 'lib/coinbase/client/api/external_addresses_api.rb', line 106

def list_address_historical_balance(network_id, address_id, asset_id, opts = {})
  data, _status_code, _headers = list_address_historical_balance_with_http_info(network_id, address_id, asset_id, opts)
  data
end

#list_address_historical_balance_with_http_info(network_id, address_id, asset_id, opts = {}) ⇒ Array<(AddressHistoricalBalanceList, Integer, Hash)>

Get address balance history for asset List the historical balance of an asset in a specific address.

Parameters:

  • network_id (String) —

    The ID of the blockchain network

  • address_id (String) —

    The ID of the address to fetch the historical balance for.

  • asset_id (String) —

    The symbol of the asset to fetch the historical balance for.

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



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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/coinbase/client/api/external_addresses_api.rb', line 120

def list_address_historical_balance_with_http_info(network_id, address_id, asset_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ExternalAddressesApi.list_address_historical_balance ...'
  end
  # verify the required parameter 'network_id' is set
  if @api_client.config.client_side_validation && network_id.nil?
    fail ArgumentError, "Missing the required parameter 'network_id' when calling ExternalAddressesApi.list_address_historical_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 ExternalAddressesApi.list_address_historical_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 ExternalAddressesApi.list_address_historical_balance"
  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 ExternalAddressesApi.list_address_historical_balance, the character length must be smaller than or equal to 5000.'
  end

  # resource path
  local_var_path = '/v1/networks/{network_id}/addresses/{address_id}/balance_history/{asset_id}'.sub('{' + 'network_id' + '}', CGI.escape(network_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] || {}
  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] || 'AddressHistoricalBalanceList'

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

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

#list_address_transactions(network_id, address_id, opts = {}) ⇒ AddressTransactionList

List transactions for an address. List all transactions that interact with the address.

Parameters:

  • network_id (String) —

    The ID of the blockchain network

  • address_id (String) —

    The ID of the address to fetch the transactions for.

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



190
191
192
193
 
# File 'lib/coinbase/client/api/external_addresses_api.rb', line 190

def list_address_transactions(network_id, address_id, opts = {})
  data, _status_code, _headers = list_address_transactions_with_http_info(network_id, address_id, opts)
  data
end

#list_address_transactions_with_http_info(network_id, address_id, opts = {}) ⇒ Array<(AddressTransactionList, Integer, Hash)>

List transactions for an address. List all transactions that interact with the address.

Parameters:

  • network_id (String) —

    The ID of the blockchain network

  • address_id (String) —

    The ID of the address to fetch the transactions for.

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

    AddressTransactionList data, response status code and response headers



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

def list_address_transactions_with_http_info(network_id, address_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ExternalAddressesApi.list_address_transactions ...'
  end
  # verify the required parameter 'network_id' is set
  if @api_client.config.client_side_validation && network_id.nil?
    fail ArgumentError, "Missing the required parameter 'network_id' when calling ExternalAddressesApi.list_address_transactions"
  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 ExternalAddressesApi.list_address_transactions"
  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 ExternalAddressesApi.list_address_transactions, the character length must be smaller than or equal to 5000.'
  end

  # resource path
  local_var_path = '/v1/networks/{network_id}/addresses/{address_id}/transactions'.sub('{' + 'network_id' + '}', CGI.escape(network_id.to_s)).sub('{' + 'address_id' + '}', CGI.escape(address_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] || 'AddressTransactionList'

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

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

#list_external_address_balances(network_id, address_id, opts = {}) ⇒ AddressBalanceList

Get the balances of an external address List all of the balances of an external address

Parameters:

  • network_id (String) —

    The ID of the blockchain network

  • address_id (String) —

    The ID of the address to fetch the balance for

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



268
269
270
271
 
# File 'lib/coinbase/client/api/external_addresses_api.rb', line 268

def list_external_address_balances(network_id, address_id, opts = {})
  data, _status_code, _headers = list_external_address_balances_with_http_info(network_id, address_id, opts)
  data
end

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

Get the balances of an external address List all of the balances of an external address

Parameters:

  • network_id (String) —

    The ID of the blockchain network

  • address_id (String) —

    The ID of the address to fetch the balance for

  • 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



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
322
323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/coinbase/client/api/external_addresses_api.rb', line 280

def list_external_address_balances_with_http_info(network_id, address_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ExternalAddressesApi.list_external_address_balances ...'
  end
  # verify the required parameter 'network_id' is set
  if @api_client.config.client_side_validation && network_id.nil?
    fail ArgumentError, "Missing the required parameter 'network_id' when calling ExternalAddressesApi.list_external_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 ExternalAddressesApi.list_external_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 ExternalAddressesApi.list_external_address_balances, the character length must be smaller than or equal to 5000.'
  end

  # resource path
  local_var_path = '/v1/networks/{network_id}/addresses/{address_id}/balances'.sub('{' + 'network_id' + '}', CGI.escape(network_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 => :"ExternalAddressesApi.list_external_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: ExternalAddressesApi#list_external_address_balances\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#request_external_faucet_funds(network_id, address_id, opts = {}) ⇒ FaucetTransaction

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

Parameters:

  • network_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

Options Hash (opts):

  • :asset_id (String) —

    The ID of the asset to transfer from the faucet.

Returns:



344
345
346
347
 
# File 'lib/coinbase/client/api/external_addresses_api.rb', line 344

def request_external_faucet_funds(network_id, address_id, opts = {})
  data, _status_code, _headers = request_external_faucet_funds_with_http_info(network_id, address_id, opts)
  data
end

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

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

Parameters:

  • network_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

Options Hash (opts):

  • :asset_id (String) —

    The ID of the asset to transfer from the faucet.

Returns:

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

    FaucetTransaction data, response status code and response headers



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
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
 
# File 'lib/coinbase/client/api/external_addresses_api.rb', line 356

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

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

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

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

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