crypto_apis 1.0.0

data/docs/RequestLimitReached.md

@@ -0,0 +1,24 @@
+# CryptoApis::RequestLimitReached
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **api_version** | **String** | Specifies the version of the API that incorporates this endpoint. |  |
+| **request_id** | **String** | Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request. |  |
+| **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. | [optional] |
+| **error** | [**RequestLimitReachedError**](RequestLimitReachedError.md) |  |  |
+
+## Example
+
+```ruby
+require 'crypto_apis'
+
+instance = CryptoApis::RequestLimitReached.new(
+  api_version: 2.0,
+  request_id: 601c1710034ed6d407996b30,
+  context: You can add any text here,
+  error: null
+)
+```
+

data/docs/RequestLimitReachedError.md

@@ -0,0 +1,22 @@
+# CryptoApis::RequestLimitReachedError
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** | Specifies an error code, e.g. error 404. |  |
+| **message** | **String** | Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”. |  |
+| **details** | [**Array<BannedIpAddressErrorDetails>**](BannedIpAddressErrorDetails.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'crypto_apis'
+
+instance = CryptoApis::RequestLimitReachedError.new(
+  code: request_limit_reached,
+  message: The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.,
+  details: null
+)
+```
+

data/docs/ResourceNotFound.md

@@ -0,0 +1,24 @@
+# CryptoApis::ResourceNotFound
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **api_version** | **String** | Specifies the version of the API that incorporates this endpoint. |  |
+| **request_id** | **String** | Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request. |  |
+| **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. | [optional] |
+| **error** | [**ResourceNotFoundError**](ResourceNotFoundError.md) |  |  |
+
+## Example
+
+```ruby
+require 'crypto_apis'
+
+instance = CryptoApis::ResourceNotFound.new(
+  api_version: 2.0,
+  request_id: 601c1710034ed6d407996b30,
+  context: You can add any text here,
+  error: null
+)
+```
+

data/docs/ResourceNotFoundError.md

@@ -0,0 +1,22 @@
+# CryptoApis::ResourceNotFoundError
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** | Specifies an error code, e.g. error 404. |  |
+| **message** | **String** | Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”. |  |
+| **details** | [**Array<BannedIpAddressErrorDetails>**](BannedIpAddressErrorDetails.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'crypto_apis'
+
+instance = CryptoApis::ResourceNotFoundError.new(
+  code: resource_not_found,
+  message: Resource not found,
+  details: null
+)
+```
+

data/docs/SyncHDWalletXPubYPubZPubR.md

@@ -0,0 +1,24 @@
+# CryptoApis::SyncHDWalletXPubYPubZPubR
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **api_version** | **String** | Specifies the version of the API that incorporates this endpoint. |  |
+| **request_id** | **String** | Defines the ID of the request. The `requestId` is generated by Crypto APIs and it's unique for every request. |  |
+| **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. | [optional] |
+| **data** | [**SyncHDWalletXPubYPubZPubRData**](SyncHDWalletXPubYPubZPubRData.md) |  |  |
+
+## Example
+
+```ruby
+require 'crypto_apis'
+
+instance = CryptoApis::SyncHDWalletXPubYPubZPubR.new(
+  api_version: 2.0,
+  request_id: 601c1710034ed6d407996b30,
+  context: You can add any text here,
+  data: null
+)
+```
+

data/docs/SyncHDWalletXPubYPubZPubRB.md

@@ -0,0 +1,20 @@
+# CryptoApis::SyncHDWalletXPubYPubZPubRB
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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. | [optional] |
+| **data** | [**SyncHDWalletXPubYPubZPubRBData**](SyncHDWalletXPubYPubZPubRBData.md) |  |  |
+
+## Example
+
+```ruby
+require 'crypto_apis'
+
+instance = CryptoApis::SyncHDWalletXPubYPubZPubRB.new(
+  context: null,
+  data: null
+)
+```
+

data/docs/SyncHDWalletXPubYPubZPubRBData.md

@@ -0,0 +1,18 @@
+# CryptoApis::SyncHDWalletXPubYPubZPubRBData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **item** | [**SyncHDWalletXPubYPubZPubRBDataItem**](SyncHDWalletXPubYPubZPubRBDataItem.md) |  |  |
+
+## Example
+
+```ruby
+require 'crypto_apis'
+
+instance = CryptoApis::SyncHDWalletXPubYPubZPubRBData.new(
+  item: null
+)
+```
+

data/docs/SyncHDWalletXPubYPubZPubRBDataItem.md

@@ -0,0 +1,18 @@
+# CryptoApis::SyncHDWalletXPubYPubZPubRBDataItem
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **extended_public_key** | **String** | Defines the account extended publicly known key which is used to derive all child public keys. |  |
+
+## Example
+
+```ruby
+require 'crypto_apis'
+
+instance = CryptoApis::SyncHDWalletXPubYPubZPubRBDataItem.new(
+  extended_public_key: upub5Ei6bRNneqozk6smK7dvtXHC5PjUyEL4ynCfMKvjznLcXi9DQaikETzQjHvJC43XexMvQs64jxB1njMjCHpRZ4xQWAmv3ge9cVtjfsHmbvQ
+)
+```
+

data/docs/SyncHDWalletXPubYPubZPubRData.md

@@ -0,0 +1,18 @@
+# CryptoApis::SyncHDWalletXPubYPubZPubRData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **item** | [**SyncHDWalletXPubYPubZPubRI**](SyncHDWalletXPubYPubZPubRI.md) |  |  |
+
+## Example
+
+```ruby
+require 'crypto_apis'
+
+instance = CryptoApis::SyncHDWalletXPubYPubZPubRData.new(
+  item: null
+)
+```
+

data/docs/SyncHDWalletXPubYPubZPubRI.md

@@ -0,0 +1,18 @@
+# CryptoApis::SyncHDWalletXPubYPubZPubRI
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **extended_public_key** | **String** | Defines the account extended publicly known key which is used to derive all child public keys. |  |
+
+## Example
+
+```ruby
+require 'crypto_apis'
+
+instance = CryptoApis::SyncHDWalletXPubYPubZPubRI.new(
+  extended_public_key: upub5Ei6bRNneqozk6smK7dvtXHC5PjUyEL4ynCfMKvjznLcXi9DQaikETzQjHvJC43XexMvQs64jxB1njMjCHpRZ4xQWAmv3ge9cVtjfsHmbvQ
+)
+```
+

data/docs/TokensApi.md

@@ -0,0 +1,259 @@
+# CryptoApis::TokensApi
+
+All URIs are relative to *https://rest.cryptoapis.io/v2*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**list_tokens_by_address**](TokensApi.md#list_tokens_by_address) | **GET** /blockchain-data/{blockchain}/{network}/addresses/{address}/tokens | List Tokens By Address |
+| [**list_tokens_transfers_by_address**](TokensApi.md#list_tokens_transfers_by_address) | **GET** /blockchain-data/{blockchain}/{network}/addresses/{address}/tokens-transfers | List Tokens Transfers By Address |
+| [**list_tokens_transfers_by_transaction_hash**](TokensApi.md#list_tokens_transfers_by_transaction_hash) | **GET** /blockchain-data/{blockchain}/{network}/transactions/{transactionHash}/tokens-transfers | List Tokens Transfers By Transaction Hash |
+
+
+## list_tokens_by_address
+
+> <ListTokensByAddressR> list_tokens_by_address(blockchain, network, address, opts)
+
+List Tokens By Address
+
+Through this endpoint customers can obtain token data by providing an attribute - `address`.  The information that can be returned can include the contract address, the token symbol, type and balance.
+
+### Examples
+
+```ruby
+require 'time'
+require 'crypto_apis'
+# setup authorization
+CryptoApis.configure do |config|
+  # Configure API key authorization: ApiKey
+  config.api_key['ApiKey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['ApiKey'] = 'Bearer'
+end
+
+api_instance = CryptoApis::TokensApi.new
+blockchain = 'ethereum' # String | Represents the specific blockchain protocol name, e.g. Ethereum, Ethereum Classic, etc.
+network = 'mainnet' # 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. - \"mainnet\" is the live network with actual data while networks like \"ropsten\", \"rinkeby\" are test networks.
+address = '0x033ef6db9fbd0ee60e2931906b987fe0280471a0' # String | Represents the public address, which is a compressed and shortened form of a public key.
+opts = {
+  context: 'context_example', # 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.
+  limit: 50, # Integer | Defines how many items should be returned in the response per page basis.
+  offset: 10 # Integer | The starting index of the response items, i.e. where the response should start listing the returned items.
+}
+
+begin
+  # List Tokens By Address
+  result = api_instance.list_tokens_by_address(blockchain, network, address, opts)
+  p result
+rescue CryptoApis::ApiError => e
+  puts "Error when calling TokensApi->list_tokens_by_address: #{e}"
+end
+```
+
+#### Using the list_tokens_by_address_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListTokensByAddressR>, Integer, Hash)> list_tokens_by_address_with_http_info(blockchain, network, address, opts)
+
+```ruby
+begin
+  # List Tokens By Address
+  data, status_code, headers = api_instance.list_tokens_by_address_with_http_info(blockchain, network, address, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListTokensByAddressR>
+rescue CryptoApis::ApiError => e
+  puts "Error when calling TokensApi->list_tokens_by_address_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **blockchain** | **String** | Represents the specific blockchain protocol name, e.g. Ethereum, Ethereum Classic, 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;ropsten\&quot;, \&quot;rinkeby\&quot; are test networks. |  |
+| **address** | **String** | Represents the public address, which is a compressed and shortened form of a public key. |  |
+| **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. | [optional] |
+| **limit** | **Integer** | Defines how many items should be returned in the response per page basis. | [optional][default to 50] |
+| **offset** | **Integer** | The starting index of the response items, i.e. where the response should start listing the returned items. | [optional][default to 0] |
+
+### Return type
+
+[**ListTokensByAddressR**](ListTokensByAddressR.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_tokens_transfers_by_address
+
+> <ListTokensTransfersByAddressR> list_tokens_transfers_by_address(blockchain, network, address, opts)
+
+List Tokens Transfers By Address
+
+Through this endpoint customers can obtain a list with token transfers by the `address` attribute. Token transfers may include information such as addresses of the sender and recipient, token name, token symbol, etc.    {note}This refers only to transfers done for **tokens** not coins.{/note}
+
+### Examples
+
+```ruby
+require 'time'
+require 'crypto_apis'
+# setup authorization
+CryptoApis.configure do |config|
+  # Configure API key authorization: ApiKey
+  config.api_key['ApiKey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['ApiKey'] = 'Bearer'
+end
+
+api_instance = CryptoApis::TokensApi.new
+blockchain = 'ethereum' # String | Represents the specific blockchain protocol name, e.g. Ethereum, Ethereum Classic, etc.
+network = 'mainnet' # 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. - \"mainnet\" is the live network with actual data while networks like \"ropsten\", \"rinkeby\" are test networks.
+address = '0x033ef6db9fbd0ee60e2931906b987fe0280471a0' # String | Represents the public address, which is a compressed and shortened form of a public key.
+opts = {
+  context: 'context_example', # 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.
+  limit: 50, # Integer | Defines how many items should be returned in the response per page basis.
+  offset: 10 # Integer | The starting index of the response items, i.e. where the response should start listing the returned items.
+}
+
+begin
+  # List Tokens Transfers By Address
+  result = api_instance.list_tokens_transfers_by_address(blockchain, network, address, opts)
+  p result
+rescue CryptoApis::ApiError => e
+  puts "Error when calling TokensApi->list_tokens_transfers_by_address: #{e}"
+end
+```
+
+#### Using the list_tokens_transfers_by_address_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListTokensTransfersByAddressR>, Integer, Hash)> list_tokens_transfers_by_address_with_http_info(blockchain, network, address, opts)
+
+```ruby
+begin
+  # List Tokens Transfers By Address
+  data, status_code, headers = api_instance.list_tokens_transfers_by_address_with_http_info(blockchain, network, address, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListTokensTransfersByAddressR>
+rescue CryptoApis::ApiError => e
+  puts "Error when calling TokensApi->list_tokens_transfers_by_address_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **blockchain** | **String** | Represents the specific blockchain protocol name, e.g. Ethereum, Ethereum Classic, 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;ropsten\&quot;, \&quot;rinkeby\&quot; are test networks. |  |
+| **address** | **String** | Represents the public address, which is a compressed and shortened form of a public key. |  |
+| **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. | [optional] |
+| **limit** | **Integer** | Defines how many items should be returned in the response per page basis. | [optional][default to 50] |
+| **offset** | **Integer** | The starting index of the response items, i.e. where the response should start listing the returned items. | [optional][default to 0] |
+
+### Return type
+
+[**ListTokensTransfersByAddressR**](ListTokensTransfersByAddressR.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_tokens_transfers_by_transaction_hash
+
+> <ListTokensTransfersByTransactionHashR> list_tokens_transfers_by_transaction_hash(blockchain, network, transaction_hash, opts)
+
+List Tokens Transfers By Transaction Hash
+
+Through this endpoint customers can obtain a list with token transfers by the `transactionHash` attribute. Token transfers may include information such as addresses of the sender and recipient, token name, token symbol, etc.    {note}This refers only to transfers done for **tokens** not coins.{/note}
+
+### Examples
+
+```ruby
+require 'time'
+require 'crypto_apis'
+# setup authorization
+CryptoApis.configure do |config|
+  # Configure API key authorization: ApiKey
+  config.api_key['ApiKey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['ApiKey'] = 'Bearer'
+end
+
+api_instance = CryptoApis::TokensApi.new
+blockchain = 'ethereum' # String | Represents the specific blockchain protocol name, e.g. Ethereum, Ethereum Classic, etc.
+network = 'mainnet' # 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. - \"mainnet\" is the live network with actual data while networks like \"ropsten\", \"rinkeby\" are test networks.
+transaction_hash = '0xbe38781783b1b9d480219255ff98e20335a39e13979a66112efa33f05fde0a33' # String | Represents the hash of the transaction, which is its unique identifier. It represents a cryptographic digital fingerprint made by hashing the block header twice through the SHA256 algorithm.
+opts = {
+  context: 'context_example', # 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.
+  limit: 50, # Integer | Defines how many items should be returned in the response per page basis.
+  offset: 10 # Integer | The starting index of the response items, i.e. where the response should start listing the returned items.
+}
+
+begin
+  # List Tokens Transfers By Transaction Hash
+  result = api_instance.list_tokens_transfers_by_transaction_hash(blockchain, network, transaction_hash, opts)
+  p result
+rescue CryptoApis::ApiError => e
+  puts "Error when calling TokensApi->list_tokens_transfers_by_transaction_hash: #{e}"
+end
+```
+
+#### Using the list_tokens_transfers_by_transaction_hash_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListTokensTransfersByTransactionHashR>, Integer, Hash)> list_tokens_transfers_by_transaction_hash_with_http_info(blockchain, network, transaction_hash, opts)
+
+```ruby
+begin
+  # List Tokens Transfers By Transaction Hash
+  data, status_code, headers = api_instance.list_tokens_transfers_by_transaction_hash_with_http_info(blockchain, network, transaction_hash, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListTokensTransfersByTransactionHashR>
+rescue CryptoApis::ApiError => e
+  puts "Error when calling TokensApi->list_tokens_transfers_by_transaction_hash_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **blockchain** | **String** | Represents the specific blockchain protocol name, e.g. Ethereum, Ethereum Classic, 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;ropsten\&quot;, \&quot;rinkeby\&quot; are test networks. |  |
+| **transaction_hash** | **String** | Represents the hash of the transaction, which is its unique identifier. It represents a cryptographic digital fingerprint made by hashing the block header twice through the SHA256 algorithm. |  |
+| **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. | [optional] |
+| **limit** | **Integer** | Defines how many items should be returned in the response per page basis. | [optional][default to 50] |
+| **offset** | **Integer** | The starting index of the response items, i.e. where the response should start listing the returned items. | [optional][default to 0] |
+
+### Return type
+
+[**ListTokensTransfersByTransactionHashR**](ListTokensTransfersByTransactionHashR.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+