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

#broadcast_external_transfer(network_id, address_id, transfer_id, broadcast_external_transfer_request, opts = {}) ⇒ Transfer

Broadcast an external address’ transfer Broadcast an external address’s transfer with a signed payload

Parameters:

  • network_id (String) —

    The ID of the network the address belongs to

  • address_id (String) —

    The ID of the address the transfer belongs to

  • transfer_id (String) —

    The ID of the transfer to broadcast

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

    the optional parameters

Returns:



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

def broadcast_external_transfer(network_id, address_id, transfer_id, broadcast_external_transfer_request, opts = {})
  data, _status_code, _headers = broadcast_external_transfer_with_http_info(network_id, address_id, transfer_id, broadcast_external_transfer_request, opts)
  data
end

#broadcast_external_transfer_with_http_info(network_id, address_id, transfer_id, broadcast_external_transfer_request, opts = {}) ⇒ Array<(Transfer, Integer, Hash)>

Broadcast an external address&#39; transfer Broadcast an external address&#39;s transfer with a signed payload

Parameters:

  • network_id (String) —

    The ID of the network the address belongs to

  • address_id (String) —

    The ID of the address the transfer belongs to

  • transfer_id (String) —

    The ID of the transfer to broadcast

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

    the optional parameters

Returns:

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

    Transfer data, response status code and response headers



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
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/coinbase/client/api/external_addresses_api.rb', line 43

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

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

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

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

#create_external_transfer(network_id, address_id, create_external_transfer_request, opts = {}) ⇒ Transfer

Create a new transfer Create a new transfer between addresses.

Parameters:

  • network_id (String) —

    The ID of the network the address is on

  • address_id (String) —

    The ID of the address to transfer from

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

    the optional parameters

Returns:



115
116
117
118
 
# File 'lib/coinbase/client/api/external_addresses_api.rb', line 115

def create_external_transfer(network_id, address_id, create_external_transfer_request, opts = {})
  data, _status_code, _headers = create_external_transfer_with_http_info(network_id, address_id, create_external_transfer_request, opts)
  data
end

#create_external_transfer_with_http_info(network_id, address_id, create_external_transfer_request, opts = {}) ⇒ Array<(Transfer, Integer, Hash)>

Create a new transfer Create a new transfer between addresses.

Parameters:

  • network_id (String) —

    The ID of the network the address is on

  • address_id (String) —

    The ID of the address to transfer from

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

    the optional parameters

Returns:

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

    Transfer data, response status code and response headers



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
181
182
183
184
185
186
 
# File 'lib/coinbase/client/api/external_addresses_api.rb', line 127

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

  # 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(create_external_transfer_request)

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

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

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

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



195
196
197
198
 
# File 'lib/coinbase/client/api/external_addresses_api.rb', line 195

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



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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['apiKey', 'session']

  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

#get_external_transfer(network_id, address_id, transfer_id, opts = {}) ⇒ Transfer

Get a external address’ transfer Get an external address’ transfer by ID

Parameters:

  • network_id (String) —

    The ID of the network the address is on

  • address_id (String) —

    The ID of the address the transfer belongs to

  • transfer_id (String) —

    The ID of the transfer to fetch

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

    the optional parameters

Returns:



270
271
272
273
 
# File 'lib/coinbase/client/api/external_addresses_api.rb', line 270

def get_external_transfer(network_id, address_id, transfer_id, opts = {})
  data, _status_code, _headers = get_external_transfer_with_http_info(network_id, address_id, transfer_id, opts)
  data
end

#get_external_transfer_with_http_info(network_id, address_id, transfer_id, opts = {}) ⇒ Array<(Transfer, Integer, Hash)>

Get a external address&#39; transfer Get an external address&#39; transfer by ID

Parameters:

  • network_id (String) —

    The ID of the network the address is on

  • address_id (String) —

    The ID of the address the transfer belongs to

  • transfer_id (String) —

    The ID of the transfer to fetch

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

    the optional parameters

Returns:

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

    Transfer data, response status code and response headers



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

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

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

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

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

Get the status of a faucet transaction Get the status of a faucet transaction

Parameters:

  • network_id (String) —

    The ID of the blockchain network

  • address_id (String) —

    The ID of the address to fetch the faucet transaction for

  • tx_hash (String) —

    The hash of the faucet transaction

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

    the optional parameters

Returns:



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

def get_faucet_transaction(network_id, address_id, tx_hash, opts = {})
  data, _status_code, _headers = get_faucet_transaction_with_http_info(network_id, address_id, tx_hash, opts)
  data
end

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

Get the status of a faucet transaction Get the status of a faucet transaction

Parameters:

  • network_id (String) —

    The ID of the blockchain network

  • address_id (String) —

    The ID of the address to fetch the faucet transaction for

  • tx_hash (String) —

    The hash of the faucet transaction

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

    the optional parameters

Returns:

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

    FaucetTransaction data, response status code and response headers



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
408
409
410
411
 
# File 'lib/coinbase/client/api/external_addresses_api.rb', line 357

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['apiKey', 'session']

  new_options = opts.merge(
    :operation => :"ExternalAddressesApi.get_faucet_transaction",
    :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_faucet_transaction\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:



420
421
422
423
 
# File 'lib/coinbase/client/api/external_addresses_api.rb', line 420

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



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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['apiKey', 'session']

  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.

  • :skip_wait (Boolean) —

    Whether to skip waiting for the transaction to be mined. This will become the default behavior in the future.

Returns:



497
498
499
500
 
# File 'lib/coinbase/client/api/external_addresses_api.rb', line 497

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.

  • :skip_wait (Boolean) —

    Whether to skip waiting for the transaction to be mined. This will become the default behavior in the future.

Returns:

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

    FaucetTransaction data, response status code and response headers



510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
 
# File 'lib/coinbase/client/api/external_addresses_api.rb', line 510

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?
  query_params[:'skip_wait'] = opts[:'skip_wait'] if !opts[:'skip_wait'].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] || 'FaucetTransaction'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['apiKey', 'session']

  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