Class: CryptoApis::InformativeApi

Inherits:
Object
  • Object
show all
Defined in:
lib/crypto_apis/api/informative_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ InformativeApi

Returns a new instance of InformativeApi.



19
20
21
 
# File 'lib/crypto_apis/api/informative_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/crypto_apis/api/informative_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_transaction_request_details(transaction_request_id, opts = {}) ⇒ GetTransactionRequestDetailsR

Get Transaction Request Details Through this endpoint customers can obtain details on transaction request. noteThis regards **transaction requests**, which is not to be confused with transactions. Transaction requests may not be approved due to any reason, hence a transaction may not occur./note

Parameters:

  • transaction_request_id (String) —

    Represents the unique ID of the transaction request.

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

    the optional parameters

Options Hash (opts):

  • :context (String) —

    In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.

Returns:



28
29
30
31
 
# File 'lib/crypto_apis/api/informative_api.rb', line 28

def get_transaction_request_details(transaction_request_id, opts = {})
  data, _status_code, _headers = get_transaction_request_details_with_http_info(transaction_request_id, opts)
  data
end

#get_transaction_request_details_with_http_info(transaction_request_id, opts = {}) ⇒ Array<(GetTransactionRequestDetailsR, Integer, Hash)>

Get Transaction Request Details Through this endpoint customers can obtain details on transaction request. noteThis regards **transaction requests**, which is not to be confused with transactions. Transaction requests may not be approved due to any reason, hence a transaction may not occur./note

Parameters:

  • transaction_request_id (String) —

    Represents the unique ID of the transaction request.

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

    the optional parameters

Options Hash (opts):

  • :context (String) —

    In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. &#x60;context&#x60; is specified by the user.

Returns:



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
 
# File 'lib/crypto_apis/api/informative_api.rb', line 39

def get_transaction_request_details_with_http_info(transaction_request_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InformativeApi.get_transaction_request_details ...'
  end
  # verify the required parameter 'transaction_request_id' is set
  if @api_client.config.client_side_validation && transaction_request_id.nil?
    fail ArgumentError, "Missing the required parameter 'transaction_request_id' when calling InformativeApi.get_transaction_request_details"
  end
  # resource path
  local_var_path = '/wallet-as-a-service/transactionRequests/{transactionRequestId}'.sub('{' + 'transactionRequestId' + '}', CGI.escape(transaction_request_id.to_s))

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

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

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

#get_wallet_asset_details(blockchain, network, wallet_id, opts = {}) ⇒ GetWalletAssetDetailsR

Get Wallet Asset Details Through this endpoint customers can obtain details on all assets (coins, fungible tokens, non-fungible tokens) for the entire Wallet.

Parameters:

  • blockchain (String) —

    Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.

  • network (String) —

    Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - &quot;mainnet&quot; is the live network with actual data while networks like &quot;testnet&quot;, &quot;ropsten&quot; are test networks.

  • wallet_id (String) —

    Defines the unique ID of the Wallet.

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

    the optional parameters

Options Hash (opts):

  • :context (String) —

    In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. &#x60;context&#x60; is specified by the user.

Returns:



96
97
98
99
 
# File 'lib/crypto_apis/api/informative_api.rb', line 96

def get_wallet_asset_details(blockchain, network, wallet_id, opts = {})
  data, _status_code, _headers = get_wallet_asset_details_with_http_info(blockchain, network, wallet_id, opts)
  data
end

#get_wallet_asset_details_with_http_info(blockchain, network, wallet_id, opts = {}) ⇒ Array<(GetWalletAssetDetailsR, Integer, Hash)>

Get Wallet Asset Details Through this endpoint customers can obtain details on all assets (coins, fungible tokens, non-fungible tokens) for the entire Wallet.

Parameters:

  • blockchain (String) —

    Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.

  • network (String) —

    Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - &quot;mainnet&quot; is the live network with actual data while networks like &quot;testnet&quot;, &quot;ropsten&quot; are test networks.

  • wallet_id (String) —

    Defines the unique ID of the Wallet.

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

    the optional parameters

Options Hash (opts):

  • :context (String) —

    In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. &#x60;context&#x60; is specified by the user.

Returns:

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

    GetWalletAssetDetailsR 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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/crypto_apis/api/informative_api.rb', line 109

def get_wallet_asset_details_with_http_info(blockchain, network, wallet_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InformativeApi.get_wallet_asset_details ...'
  end
  # verify the required parameter 'blockchain' is set
  if @api_client.config.client_side_validation && blockchain.nil?
    fail ArgumentError, "Missing the required parameter 'blockchain' when calling InformativeApi.get_wallet_asset_details"
  end
  # verify enum value
  allowable_values = ["bitcoin", "bitcoin-cash", "litecoin", "dogecoin", "dash", "ethereum", "ethereum-classic", "xrp", "zcash", "binance-smart-chain", "tron", "polygon"]
  if @api_client.config.client_side_validation && !allowable_values.include?(blockchain)
    fail ArgumentError, "invalid value for \"blockchain\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'network' is set
  if @api_client.config.client_side_validation && network.nil?
    fail ArgumentError, "Missing the required parameter 'network' when calling InformativeApi.get_wallet_asset_details"
  end
  # verify enum value
  allowable_values = ["mainnet", "testnet", "mordor", "nile", "goerli", "mumbai"]
  if @api_client.config.client_side_validation && !allowable_values.include?(network)
    fail ArgumentError, "invalid value for \"network\", must be one of #{allowable_values}"
  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 InformativeApi.get_wallet_asset_details"
  end
  # resource path
  local_var_path = '/wallet-as-a-service/wallets/{walletId}/{blockchain}/{network}'.sub('{' + 'blockchain' + '}', CGI.escape(blockchain.to_s)).sub('{' + 'network' + '}', CGI.escape(network.to_s)).sub('{' + 'walletId' + '}', CGI.escape(wallet_id.to_s))

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

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

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

#get_wallet_transaction_details_by_transaction_id(blockchain, network, transaction_id, opts = {}) ⇒ GetWalletTransactionDetailsByTransactionIDR

Get Wallet Transaction Details By Transaction ID Through this endpoint users can obtain Wallet transaction information by providing a ‘transactionId`. Customers can receive information only for a transaction that has been made from their own wallet.

Parameters:

  • blockchain (String) —

    Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.

  • network (String) —

    Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - &quot;mainnet&quot; is the live network with actual data while networks like &quot;testnet&quot;, &quot;ropsten&quot; are test networks.

  • transaction_id (String) —

    Represents the unique identifier of a transaction, i.e. it could be &#x60;transactionId&#x60; in UTXO-based protocols like Bitcoin, and transaction &#x60;hash&#x60; in Ethereum blockchain.

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

    the optional parameters

Options Hash (opts):

  • :context (String) —

    In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. &#x60;context&#x60; is specified by the user.

Returns:



184
185
186
187
 
# File 'lib/crypto_apis/api/informative_api.rb', line 184

def get_wallet_transaction_details_by_transaction_id(blockchain, network, transaction_id, opts = {})
  data, _status_code, _headers = get_wallet_transaction_details_by_transaction_id_with_http_info(blockchain, network, transaction_id, opts)
  data
end

#get_wallet_transaction_details_by_transaction_id_with_http_info(blockchain, network, transaction_id, opts = {}) ⇒ Array<(GetWalletTransactionDetailsByTransactionIDR, Integer, Hash)>

Get Wallet Transaction Details By Transaction ID Through this endpoint users can obtain Wallet transaction information by providing a &#x60;transactionId&#x60;. Customers can receive information only for a transaction that has been made from their own wallet.

Parameters:

  • blockchain (String) —

    Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.

  • network (String) —

    Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - &quot;mainnet&quot; is the live network with actual data while networks like &quot;testnet&quot;, &quot;ropsten&quot; are test networks.

  • transaction_id (String) —

    Represents the unique identifier of a transaction, i.e. it could be &#x60;transactionId&#x60; in UTXO-based protocols like Bitcoin, and transaction &#x60;hash&#x60; in Ethereum blockchain.

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

    the optional parameters

Options Hash (opts):

  • :context (String) —

    In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. &#x60;context&#x60; is specified by the user.

Returns:



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
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/crypto_apis/api/informative_api.rb', line 197

def get_wallet_transaction_details_by_transaction_id_with_http_info(blockchain, network, transaction_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InformativeApi.get_wallet_transaction_details_by_transaction_id ...'
  end
  # verify the required parameter 'blockchain' is set
  if @api_client.config.client_side_validation && blockchain.nil?
    fail ArgumentError, "Missing the required parameter 'blockchain' when calling InformativeApi.get_wallet_transaction_details_by_transaction_id"
  end
  # verify enum value
  allowable_values = ["bitcoin", "ethereum", "litecoin", "bitcoin-cash", "ethereum-classic", "dogecoin", "dash", "zcash", "binance-smart-chain", "tron", "polygon"]
  if @api_client.config.client_side_validation && !allowable_values.include?(blockchain)
    fail ArgumentError, "invalid value for \"blockchain\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'network' is set
  if @api_client.config.client_side_validation && network.nil?
    fail ArgumentError, "Missing the required parameter 'network' when calling InformativeApi.get_wallet_transaction_details_by_transaction_id"
  end
  # verify enum value
  allowable_values = ["mainnet", "testnet", "mordor", "nile", "goerli"]
  if @api_client.config.client_side_validation && !allowable_values.include?(network)
    fail ArgumentError, "invalid value for \"network\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'transaction_id' is set
  if @api_client.config.client_side_validation && transaction_id.nil?
    fail ArgumentError, "Missing the required parameter 'transaction_id' when calling InformativeApi.get_wallet_transaction_details_by_transaction_id"
  end
  # resource path
  local_var_path = '/wallet-as-a-service/wallets/{blockchain}/{network}/transactions/{transactionId}'.sub('{' + 'blockchain' + '}', CGI.escape(blockchain.to_s)).sub('{' + 'network' + '}', CGI.escape(network.to_s)).sub('{' + 'transactionId' + '}', CGI.escape(transaction_id.to_s))

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

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

  new_options = opts.merge(
    :operation => :"InformativeApi.get_wallet_transaction_details_by_transaction_id",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InformativeApi#get_wallet_transaction_details_by_transaction_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_all_assets_by_wallet_id(wallet_id, opts = {}) ⇒ ListAllAssetsByWalletIDR

List All Assets By Wallet ID Through this endpoint customers can obtain information about available assets in one of their wallets, regardless of the blockchain protocol or network, by providing walletId.

Parameters:

  • wallet_id (String) —

    Defines the unique ID of the Wallet.

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

    the optional parameters

Options Hash (opts):

  • :context (String) —

    In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. &#x60;context&#x60; is specified by the user.

Returns:



270
271
272
273
 
# File 'lib/crypto_apis/api/informative_api.rb', line 270

def list_all_assets_by_wallet_id(wallet_id, opts = {})
  data, _status_code, _headers = list_all_assets_by_wallet_id_with_http_info(wallet_id, opts)
  data
end

#list_all_assets_by_wallet_id_with_http_info(wallet_id, opts = {}) ⇒ Array<(ListAllAssetsByWalletIDR, Integer, Hash)>

List All Assets By Wallet ID Through this endpoint customers can obtain information about available assets in one of their wallets, regardless of the blockchain protocol or network, by providing walletId.

Parameters:

  • wallet_id (String) —

    Defines the unique ID of the Wallet.

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

    the optional parameters

Options Hash (opts):

  • :context (String) —

    In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. &#x60;context&#x60; is specified by the user.

Returns:

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

    ListAllAssetsByWalletIDR data, response status code and response headers



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
 
# File 'lib/crypto_apis/api/informative_api.rb', line 281

def list_all_assets_by_wallet_id_with_http_info(wallet_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InformativeApi.list_all_assets_by_wallet_id ...'
  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 InformativeApi.list_all_assets_by_wallet_id"
  end
  # resource path
  local_var_path = '/wallet-as-a-service/wallets/{walletId}/assets'.sub('{' + 'walletId' + '}', CGI.escape(wallet_id.to_s))

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

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

  new_options = opts.merge(
    :operation => :"InformativeApi.list_all_assets_by_wallet_id",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InformativeApi#list_all_assets_by_wallet_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_all_assets_from_all_wallets(opts = {}) ⇒ ListAllAssetsFromAllWalletsR

List All Assets From All Wallets Through this endpoint customers can obtain information about available assets in all of their wallets, regardless of the blockchain protocol or network.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :context (String) —

    In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. &#x60;context&#x60; is specified by the user.

  • :limit (Integer) —

    Defines how many items should be returned in the response per page basis. (default to 50)

  • :offset (Integer) —

    The starting index of the response items, i.e. where the response should start listing the returned items. (default to 0)

Returns:



337
338
339
340
 
# File 'lib/crypto_apis/api/informative_api.rb', line 337

def list_all_assets_from_all_wallets(opts = {})
  data, _status_code, _headers = list_all_assets_from_all_wallets_with_http_info(opts)
  data
end

#list_all_assets_from_all_wallets_with_http_info(opts = {}) ⇒ Array<(ListAllAssetsFromAllWalletsR, Integer, Hash)>

List All Assets From All Wallets Through this endpoint customers can obtain information about available assets in all of their wallets, regardless of the blockchain protocol or network.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :context (String) —

    In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. &#x60;context&#x60; is specified by the user.

  • :limit (Integer) —

    Defines how many items should be returned in the response per page basis. (default to 50)

  • :offset (Integer) —

    The starting index of the response items, i.e. where the response should start listing the returned items. (default to 0)

Returns:



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
384
385
386
387
388
389
390
391
392
393
394
 
# File 'lib/crypto_apis/api/informative_api.rb', line 349

def list_all_assets_from_all_wallets_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InformativeApi.list_all_assets_from_all_wallets ...'
  end
  # resource path
  local_var_path = '/wallet-as-a-service/wallets/all-assets'

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

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

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

#list_deposit_addresses(blockchain, network, wallet_id, opts = {}) ⇒ ListDepositAddressesR

List Deposit Addresses Through this endpoint customers can pull a list of Deposit/Receiving Addresses they have already generated. notePlease note that listing data from the same type will apply pagination on the results./note

Parameters:

  • blockchain (String) —

    Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.

  • network (String) —

    Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - &quot;mainnet&quot; is the live network with actual data while networks like &quot;testnet&quot;, &quot;ropsten&quot; are test networks.

  • wallet_id (String) —

    Represents the unique ID of the specific Wallet.

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

    the optional parameters

Options Hash (opts):

  • :context (String) —

    In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. &#x60;context&#x60; is specified by the user.

Returns:



404
405
406
407
 
# File 'lib/crypto_apis/api/informative_api.rb', line 404

def list_deposit_addresses(blockchain, network, wallet_id, opts = {})
  data, _status_code, _headers = list_deposit_addresses_with_http_info(blockchain, network, wallet_id, opts)
  data
end

#list_deposit_addresses_with_http_info(blockchain, network, wallet_id, opts = {}) ⇒ Array<(ListDepositAddressesR, Integer, Hash)>

List Deposit Addresses Through this endpoint customers can pull a list of Deposit/Receiving Addresses they have already generated. notePlease note that listing data from the same type will apply pagination on the results./note

Parameters:

  • blockchain (String) —

    Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.

  • network (String) —

    Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - &quot;mainnet&quot; is the live network with actual data while networks like &quot;testnet&quot;, &quot;ropsten&quot; are test networks.

  • wallet_id (String) —

    Represents the unique ID of the specific Wallet.

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

    the optional parameters

Options Hash (opts):

  • :context (String) —

    In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. &#x60;context&#x60; is specified by the user.

Returns:

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

    ListDepositAddressesR data, response status code and response headers



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
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
 
# File 'lib/crypto_apis/api/informative_api.rb', line 417

def list_deposit_addresses_with_http_info(blockchain, network, wallet_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InformativeApi.list_deposit_addresses ...'
  end
  # verify the required parameter 'blockchain' is set
  if @api_client.config.client_side_validation && blockchain.nil?
    fail ArgumentError, "Missing the required parameter 'blockchain' when calling InformativeApi.list_deposit_addresses"
  end
  # verify enum value
  allowable_values = ["bitcoin", "bitcoin-cash", "litecoin", "dogecoin", "dash", "ethereum", "ethereum-classic", "xrp", "zcash", "binance-smart-chain", "tron", "polygon"]
  if @api_client.config.client_side_validation && !allowable_values.include?(blockchain)
    fail ArgumentError, "invalid value for \"blockchain\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'network' is set
  if @api_client.config.client_side_validation && network.nil?
    fail ArgumentError, "Missing the required parameter 'network' when calling InformativeApi.list_deposit_addresses"
  end
  # verify enum value
  allowable_values = ["mainnet", "testnet", "mordor", "nile", "goerli", "mumbai"]
  if @api_client.config.client_side_validation && !allowable_values.include?(network)
    fail ArgumentError, "invalid value for \"network\", must be one of #{allowable_values}"
  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 InformativeApi.list_deposit_addresses"
  end
  # resource path
  local_var_path = '/wallet-as-a-service/wallets/{walletId}/{blockchain}/{network}/addresses'.sub('{' + 'blockchain' + '}', CGI.escape(blockchain.to_s)).sub('{' + 'network' + '}', CGI.escape(network.to_s)).sub('{' + 'walletId' + '}', CGI.escape(wallet_id.to_s))

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

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

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

#list_supported_tokens(blockchain, network, opts = {}) ⇒ ListSupportedTokensR

List Supported Tokens Through this endpoint customers can obtain information on multiple tokens at once.

Parameters:

  • blockchain (String) —

    Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.

  • network (String) —

    Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - &quot;mainnet&quot; is the live network with actual data while networks like &quot;testnet&quot;, &quot;ropsten&quot; are test networks.

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

    the optional parameters

Options Hash (opts):

  • :context (String) —

    In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. &#x60;context&#x60; is specified by the user.

  • :limit (Integer) —

    Defines how many items should be returned in the response per page basis. (default to 50)

  • :offset (Integer) —

    The starting index of the response items, i.e. where the response should start listing the returned items. (default to 0)

Returns:



493
494
495
496
 
# File 'lib/crypto_apis/api/informative_api.rb', line 493

def list_supported_tokens(blockchain, network, opts = {})
  data, _status_code, _headers = list_supported_tokens_with_http_info(blockchain, network, opts)
  data
end

#list_supported_tokens_with_http_info(blockchain, network, opts = {}) ⇒ Array<(ListSupportedTokensR, Integer, Hash)>

List Supported Tokens Through this endpoint customers can obtain information on multiple tokens at once.

Parameters:

  • blockchain (String) —

    Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.

  • network (String) —

    Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - &quot;mainnet&quot; is the live network with actual data while networks like &quot;testnet&quot;, &quot;ropsten&quot; are test networks.

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

    the optional parameters

Options Hash (opts):

  • :context (String) —

    In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. &#x60;context&#x60; is specified by the user.

  • :limit (Integer) —

    Defines how many items should be returned in the response per page basis. (default to 50)

  • :offset (Integer) —

    The starting index of the response items, i.e. where the response should start listing the returned items. (default to 0)

Returns:

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

    ListSupportedTokensR data, response status code and response headers



507
508
509
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
563
564
565
566
567
568
569
570
 
# File 'lib/crypto_apis/api/informative_api.rb', line 507

def list_supported_tokens_with_http_info(blockchain, network, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InformativeApi.list_supported_tokens ...'
  end
  # verify the required parameter 'blockchain' is set
  if @api_client.config.client_side_validation && blockchain.nil?
    fail ArgumentError, "Missing the required parameter 'blockchain' when calling InformativeApi.list_supported_tokens"
  end
  # verify enum value
  allowable_values = ["ethereum", "ethereum-classic", "binance-smart-chain", "tron", "polygon"]
  if @api_client.config.client_side_validation && !allowable_values.include?(blockchain)
    fail ArgumentError, "invalid value for \"blockchain\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'network' is set
  if @api_client.config.client_side_validation && network.nil?
    fail ArgumentError, "Missing the required parameter 'network' when calling InformativeApi.list_supported_tokens"
  end
  # verify enum value
  allowable_values = ["mainnet", "testnet", "mordor", "nile", "goerli", "mumbai"]
  if @api_client.config.client_side_validation && !allowable_values.include?(network)
    fail ArgumentError, "invalid value for \"network\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/wallet-as-a-service/info/{blockchain}/{network}/supported-tokens'.sub('{' + 'blockchain' + '}', CGI.escape(blockchain.to_s)).sub('{' + 'network' + '}', CGI.escape(network.to_s))

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

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

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

#list_wallet_transactions(blockchain, network, wallet_id, opts = {}) ⇒ ListWalletTransactionsR

List Wallet Transactions Through this endpoint customers can list Transactions from and to their Wallet. The data returned will include ‘transactionId`, `direction` of the transaction - incoming or outgoing, `amount` and more.

Parameters:

  • blockchain (String) —

    Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.

  • network (String) —

    Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - &quot;mainnet&quot; is the live network with actual data while networks like &quot;testnet&quot;, &quot;ropsten&quot; are test networks.

  • wallet_id (String) —

    Represents the unique ID of the specific Wallet.

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

    the optional parameters

Options Hash (opts):

  • :context (String) —

    In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. &#x60;context&#x60; is specified by the user.

  • :limit (Integer) —

    Defines how many items should be returned in the response per page basis. (default to 50)

  • :offset (Integer) —

    The starting index of the response items, i.e. where the response should start listing the returned items. (default to 0)

Returns:



582
583
584
585
 
# File 'lib/crypto_apis/api/informative_api.rb', line 582

def list_wallet_transactions(blockchain, network, wallet_id, opts = {})
  data, _status_code, _headers = list_wallet_transactions_with_http_info(blockchain, network, wallet_id, opts)
  data
end

#list_wallet_transactions_with_http_info(blockchain, network, wallet_id, opts = {}) ⇒ Array<(ListWalletTransactionsR, Integer, Hash)>

List Wallet Transactions Through this endpoint customers can list Transactions from and to their Wallet. The data returned will include &#x60;transactionId&#x60;, &#x60;direction&#x60; of the transaction - incoming or outgoing, &#x60;amount&#x60; and more.

Parameters:

  • blockchain (String) —

    Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.

  • network (String) —

    Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - &quot;mainnet&quot; is the live network with actual data while networks like &quot;testnet&quot;, &quot;ropsten&quot; are test networks.

  • wallet_id (String) —

    Represents the unique ID of the specific Wallet.

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

    the optional parameters

Options Hash (opts):

  • :context (String) —

    In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. &#x60;context&#x60; is specified by the user.

  • :limit (Integer) —

    Defines how many items should be returned in the response per page basis. (default to 50)

  • :offset (Integer) —

    The starting index of the response items, i.e. where the response should start listing the returned items. (default to 0)

Returns:

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

    ListWalletTransactionsR data, response status code and response headers



597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
 
# File 'lib/crypto_apis/api/informative_api.rb', line 597

def list_wallet_transactions_with_http_info(blockchain, network, wallet_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InformativeApi.list_wallet_transactions ...'
  end
  # verify the required parameter 'blockchain' is set
  if @api_client.config.client_side_validation && blockchain.nil?
    fail ArgumentError, "Missing the required parameter 'blockchain' when calling InformativeApi.list_wallet_transactions"
  end
  # verify enum value
  allowable_values = ["bitcoin", "bitcoin-cash", "litecoin", "dogecoin", "dash", "ethereum", "ethereum-classic", "xrp", "zcash", "binance-smart-chain", "tron", "polygon"]
  if @api_client.config.client_side_validation && !allowable_values.include?(blockchain)
    fail ArgumentError, "invalid value for \"blockchain\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'network' is set
  if @api_client.config.client_side_validation && network.nil?
    fail ArgumentError, "Missing the required parameter 'network' when calling InformativeApi.list_wallet_transactions"
  end
  # verify enum value
  allowable_values = ["mainnet", "testnet", "mordor", "nile", "goerli", "mumbai"]
  if @api_client.config.client_side_validation && !allowable_values.include?(network)
    fail ArgumentError, "invalid value for \"network\", must be one of #{allowable_values}"
  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 InformativeApi.list_wallet_transactions"
  end
  # resource path
  local_var_path = '/wallet-as-a-service/wallets/{walletId}/{blockchain}/{network}/transactions'.sub('{' + 'blockchain' + '}', CGI.escape(blockchain.to_s)).sub('{' + 'network' + '}', CGI.escape(network.to_s)).sub('{' + 'walletId' + '}', CGI.escape(wallet_id.to_s))

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

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

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