crypto_apis 1.1.0 → 1.2.0

data/docs/BroadcastTransactionSuccessDataItem.md

@@ -0,0 +1,22 @@
+# CryptoApis::BroadcastTransactionSuccessDataItem
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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. - \"mainnet\" is the live network with actual data while networks like \"testnet\", \"ropsten\", \"rinkeby\" are test networks. |  |
+| **transaction_id** | **String** | Defines the unique ID of the specific transaction, i.e. its identification number. |  |
+
+## Example
+
+```ruby
+require 'crypto_apis'
+
+instance = CryptoApis::BroadcastTransactionSuccessDataItem.new(
+  blockchain: Bitcoin/Ethereum (whichever applicable),
+  network: Testnet/Mainnet (whichever applicable),
+  transaction_id: 347d96855d41b77f1e23048fff11c18e9fe699ee69b0b402338f34189734e0a2
+)
+```
+

data/docs/CreateCoinsTransactionRequestFromAddressRBDataItem.md

@@ -5,8 +5,10 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **amount** | **String** | Represents the specific amount of the transaction. |  |
+| **callback_secret_key** | **String** | Represents the Secret Key value provided by the customer. This field is used for security purposes during the callback notification, in order to prove the sender of the callback as Crypto APIs. | [optional] |
+| **callback_url** | **String** | Verified URL for sending callbacks | [optional] |
 | **fee_priority** | **String** | Represents the fee priority of the automation, whether it is \"slow\", \"standard\" or \"fast\". |  |
-| **to_address** | **String** | Defines the specific recipient address for the transaction. |  |
+| **recipient_address** | **String** | Defines the specific recipient address for the transaction. |  |
 
 ## Example
 
@@ -15,8 +17,10 @@ require 'crypto_apis'
 
 instance = CryptoApis::CreateCoinsTransactionRequestFromAddressRBDataItem.new(
   amount: 0.2,
+  callback_secret_key: yourSecretString,
+  callback_url: https://example.com,
   fee_priority: slow,
-  to_address: 0xc065b539490f81b6c297c37b1925c3be2f190732
+  recipient_address: 0xc065b539490f81b6c297c37b1925c3be2f190732
 )
 ```
 

data/docs/CreateCoinsTransactionRequestFromAddressRI.md

@@ -4,6 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
+| **callback_secret_key** | **String** | Represents the Secret Key value provided by the customer. This field is used for security purposes during the callback notification, in order to prove the sender of the callback as Crypto APIs. | [optional] |
+| **callback_url** | **String** | Verified URL for sending callbacks | [optional] |
 | **fee_priority** | **String** | Represents the fee priority of the automation, whether it is \"slow\", \"standard\" or \"fast\". |  |
 | **recipients** | [**Array<CreateCoinsTransactionRequestFromAddressRIRecipients>**](CreateCoinsTransactionRequestFromAddressRIRecipients.md) | Defines the destination for the transaction, i.e. the recipient(s). |  |
 | **senders** | [**CreateCoinsTransactionRequestFromAddressRISenders**](CreateCoinsTransactionRequestFromAddressRISenders.md) |  |  |
@@ -15,6 +17,8 @@
 require 'crypto_apis'
 
 instance = CryptoApis::CreateCoinsTransactionRequestFromAddressRI.new(
+  callback_secret_key: yourSecretString,
+  callback_url: https://example.com,
   fee_priority: standard,
   recipients: null,
   senders: null,

data/docs/CreateCoinsTransactionRequestFromWalletRBDataItem.md

@@ -4,8 +4,10 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **destinations** | [**Array<CreateCoinsTransactionRequestFromWalletRBDataItemDestinations>**](CreateCoinsTransactionRequestFromWalletRBDataItemDestinations.md) | Defines the destination of the transaction, whether it is incoming or outgoing. |  |
+| **callback_secret_key** | **String** | Represents the Secret Key value provided by the customer. This field is used for security purposes during the callback notification, in order to prove the sender of the callback as Crypto APIs. | [optional] |
+| **callback_url** | **String** | Verified URL for sending callbacks | [optional] |
 | **fee_priority** | **String** | Represents the fee priority of the automation, whether it is \"slow\", \"standard\" or \"fast\". |  |
+| **recipients** | [**Array<CreateCoinsTransactionRequestFromWalletRBDataItemRecipients>**](CreateCoinsTransactionRequestFromWalletRBDataItemRecipients.md) | Defines the destination of the transaction, whether it is incoming or outgoing. |  |
 
 ## Example
 
@@ -13,8 +15,10 @@
 require 'crypto_apis'
 
 instance = CryptoApis::CreateCoinsTransactionRequestFromWalletRBDataItem.new(
-  destinations: null,
-  fee_priority: standard
+  callback_secret_key: yourSecretKey,
+  callback_url: https://example.com,
+  fee_priority: standard,
+  recipients: null
 )
 ```
 

data/docs/{CreateCoinsTransactionRequestFromWalletRBDataItemDestinations.md → CreateCoinsTransactionRequestFromWalletRBDataItemRecipients.md}

@@ -1,10 +1,10 @@
-# CryptoApis::CreateCoinsTransactionRequestFromWalletRBDataItemDestinations
+# CryptoApis::CreateCoinsTransactionRequestFromWalletRBDataItemRecipients
 
 ## Properties
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **address** | **String** | Defines the specific destination address. |  |
+| **address** | **String** | Defines the specific recipient/destination address. |  |
 | **amount** | **String** | Represents the specific amount of the transaction's destination. |  |
 
 ## Example
@@ -12,7 +12,7 @@
 ```ruby
 require 'crypto_apis'
 
-instance = CryptoApis::CreateCoinsTransactionRequestFromWalletRBDataItemDestinations.new(
+instance = CryptoApis::CreateCoinsTransactionRequestFromWalletRBDataItemRecipients.new(
   address: 0x6f61e3c2fbb8c8be698bd0907ba6c04b62800fe5,
   amount: 0.125
 )

data/docs/CreateCoinsTransactionRequestFromWalletRI.md

@@ -4,6 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
+| **callback_secret_key** | **String** | Represents the Secret Key value provided by the customer. This field is used for security purposes during the callback notification, in order to prove the sender of the callback as Crypto APIs. | [optional] |
+| **callback_url** | **String** | Verified URL for sending callbacks | [optional] |
 | **fee_priority** | **String** | Represents the fee priority of the automation, whether it is \"slow\", \"standard\" or \"fast\". |  |
 | **recipients** | [**Array<CreateCoinsTransactionRequestFromWalletRIRecipients>**](CreateCoinsTransactionRequestFromWalletRIRecipients.md) | Defines the destination of the transaction, whether it is incoming or outgoing. |  |
 | **total_transaction_amount** | **String** | Represents the specific amount of the transaction. |  |
@@ -15,6 +17,8 @@
 require 'crypto_apis'
 
 instance = CryptoApis::CreateCoinsTransactionRequestFromWalletRI.new(
+  callback_secret_key: yourSecretKey,
+  callback_url: https://example.com,
   fee_priority: standard,
   recipients: null,
   total_transaction_amount: 0.001,

data/docs/CreateTokensTransactionRequestFromAddressRBDataItem.md

@@ -5,8 +5,10 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **amount** | **String** | Represents the specific amount of the transaction. |  |
+| **callback_secret_key** | **String** | Represents the Secret Key value provided by the customer. This field is used for security purposes during the callback notification, in order to prove the sender of the callback as Crypto APIs. | [optional] |
+| **callback_url** | **String** | Verified URL for sending callbacks | [optional] |
 | **fee_priority** | **String** | Represents the fee priority of the automation, whether it is \"slow\", \"standard\" or \"fast\". |  |
-| **to_address** | **String** | Defines the specific recipient address for the transaction. |  |
+| **recipient_address** | **String** | Defines the specific recipient address for the transaction. |  |
 | **token_identifier** | **String** | Defines the specific token identifier. For Bitcoin-based transactions it should be the `propertyId` and for Ethereum-based transactions - the `contract`. |  |
 
 ## Example
@@ -16,8 +18,10 @@ require 'crypto_apis'
 
 instance = CryptoApis::CreateTokensTransactionRequestFromAddressRBDataItem.new(
   amount: 0.2,
+  callback_secret_key: yourSecretString,
+  callback_url: https://example.com,
   fee_priority: standard,
-  to_address: 0xc065b539490f81b6c297c37b1925c3be2f190732,
+  recipient_address: 0xc065b539490f81b6c297c37b1925c3be2f190732,
   token_identifier: 1
 )
 ```

data/docs/CreateTokensTransactionRequestFromAddressRI.md

@@ -4,6 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
+| **callback_secret_key** | **String** | Represents the Secret Key value provided by the customer. This field is used for security purposes during the callback notification, in order to prove the sender of the callback as Crypto APIs. |  |
+| **callback_url** | **String** | Verified URL for sending callbacks |  |
 | **fee_priority** | **String** | Represents the fee priority of the automation, whether it is \"slow\", \"standard\" or \"fast\". |  |
 | **recipients** | [**Array<CreateTokensTransactionRequestFromAddressRIRecipients>**](CreateTokensTransactionRequestFromAddressRIRecipients.md) | Defines the destination for the transaction, i.e. the recipient(s). |  |
 | **senders** | [**CreateTokensTransactionRequestFromAddressRISenders**](CreateTokensTransactionRequestFromAddressRISenders.md) |  |  |
@@ -15,6 +17,8 @@
 require 'crypto_apis'
 
 instance = CryptoApis::CreateTokensTransactionRequestFromAddressRI.new(
+  callback_secret_key: yourSecretString,
+  callback_url: https://example.com,
   fee_priority: fast,
   recipients: 0x1316bea88fb7cd4ccc4a57e2f9f4f43d1a86ee59,
   senders: null,

data/docs/FeaturesApi.md

@@ -0,0 +1,167 @@
+# CryptoApis::FeaturesApi
+
+All URIs are relative to *https://rest.cryptoapis.io/v2*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**broadcast_locally_signed_transaction**](FeaturesApi.md#broadcast_locally_signed_transaction) | **POST** /blockchain-tools/{blockchain}/{network}/transactions/broadcast | Broadcast Locally Signed Transaction |
+| [**validate_address**](FeaturesApi.md#validate_address) | **POST** /blockchain-tools/{blockchain}/{network}/addresses/validate | Validate Address |
+
+
+## broadcast_locally_signed_transaction
+
+> <BroadcastLocallySignedTransactionR> broadcast_locally_signed_transaction(blockchain, network, opts)
+
+Broadcast Locally Signed Transaction
+
+Through this endpoint customers can broadcast transactions that have been already signed locally. Instead of using a node for broadcasting a signed transaction users can use this endpoint. We then keep the user posted about the status by sending you a callback with a success or failure status.
+
+### 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::FeaturesApi.new
+blockchain = 'bitcoin' # String | Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, 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 \"testnet\", \"ropsten\", \"rinkeby\" are test networks.
+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.
+  broadcast_locally_signed_transaction_rb: CryptoApis::BroadcastLocallySignedTransactionRB.new({data: CryptoApis::BroadcastLocallySignedTransactionRBData.new({item: CryptoApis::BroadcastLocallySignedTransactionRBDataItem.new({callback_url: 'https://example.com', signed_transaction_hex: '0xf86a22827d00831e8480941b85a43e2e7f52e766ddfdfa2b901c42cb1201be8801b27f33b807c0008029a084ccbf02b27e0842fb1eda7a187a5589c3759be0e969e0ca989dc469a5e5e394a02e111e1156b197f1de4c1d9ba4af26e50665ea6d617d05b3e4047da12b915e69'})})}) # BroadcastLocallySignedTransactionRB | 
+}
+
+begin
+  # Broadcast Locally Signed Transaction
+  result = api_instance.broadcast_locally_signed_transaction(blockchain, network, opts)
+  p result
+rescue CryptoApis::ApiError => e
+  puts "Error when calling FeaturesApi->broadcast_locally_signed_transaction: #{e}"
+end
+```
+
+#### Using the broadcast_locally_signed_transaction_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<BroadcastLocallySignedTransactionR>, Integer, Hash)> broadcast_locally_signed_transaction_with_http_info(blockchain, network, opts)
+
+```ruby
+begin
+  # Broadcast Locally Signed Transaction
+  data, status_code, headers = api_instance.broadcast_locally_signed_transaction_with_http_info(blockchain, network, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <BroadcastLocallySignedTransactionR>
+rescue CryptoApis::ApiError => e
+  puts "Error when calling FeaturesApi->broadcast_locally_signed_transaction_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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;, \&quot;rinkeby\&quot; are test networks. |  |
+| **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] |
+| **broadcast_locally_signed_transaction_rb** | [**BroadcastLocallySignedTransactionRB**](BroadcastLocallySignedTransactionRB.md) |  | [optional] |
+
+### Return type
+
+[**BroadcastLocallySignedTransactionR**](BroadcastLocallySignedTransactionR.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## validate_address
+
+> <ValidateAddressR> validate_address(blockchain, network, opts)
+
+Validate Address
+
+This endpoint checks user public addresses whether they are valid or not.
+
+### 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::FeaturesApi.new
+blockchain = 'bitcoin' # String | Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, 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 \"testnet\", \"ropsten\", \"rinkeby\" are test networks.
+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.
+  validate_address_rb: CryptoApis::ValidateAddressRB.new({data: CryptoApis::ValidateAddressRBData.new({item: CryptoApis::ValidateAddressRBDataItem.new({address: 'mho4jHBcrNCncKt38trJahXakuaBnS7LK5'})})}) # ValidateAddressRB | 
+}
+
+begin
+  # Validate Address
+  result = api_instance.validate_address(blockchain, network, opts)
+  p result
+rescue CryptoApis::ApiError => e
+  puts "Error when calling FeaturesApi->validate_address: #{e}"
+end
+```
+
+#### Using the validate_address_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ValidateAddressR>, Integer, Hash)> validate_address_with_http_info(blockchain, network, opts)
+
+```ruby
+begin
+  # Validate Address
+  data, status_code, headers = api_instance.validate_address_with_http_info(blockchain, network, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ValidateAddressR>
+rescue CryptoApis::ApiError => e
+  puts "Error when calling FeaturesApi->validate_address_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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;, \&quot;rinkeby\&quot; are test networks. |  |
+| **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] |
+| **validate_address_rb** | [**ValidateAddressRB**](ValidateAddressRB.md) |  | [optional] |
+
+### Return type
+
+[**ValidateAddressR**](ValidateAddressR.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/{ListReceivingAddressesR.md → GenerateDepositAddressR.md}

@@ -1,4 +1,4 @@
-# CryptoApis::ListReceivingAddressesR
+# CryptoApis::GenerateDepositAddressR
 
 ## Properties
 
@@ -7,14 +7,14 @@
 | **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** | [**ListReceivingAddressesRData**](ListReceivingAddressesRData.md) |  |  |
+| **data** | [**GenerateDepositAddressRData**](GenerateDepositAddressRData.md) |  |  |
 
 ## Example
 
 ```ruby
 require 'crypto_apis'
 
-instance = CryptoApis::ListReceivingAddressesR.new(
+instance = CryptoApis::GenerateDepositAddressR.new(
   api_version: 2.0,
   request_id: 601c1710034ed6d407996b30,
   context: You can add any text here,

data/docs/{GenerateReceivingAddressRB.md → GenerateDepositAddressRB.md}

@@ -1,18 +1,18 @@
-# CryptoApis::GenerateReceivingAddressRB
+# CryptoApis::GenerateDepositAddressRB
 
 ## 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** | [**GenerateReceivingAddressRBData**](GenerateReceivingAddressRBData.md) |  |  |
+| **data** | [**GenerateDepositAddressRBData**](GenerateDepositAddressRBData.md) |  |  |
 
 ## Example
 
 ```ruby
 require 'crypto_apis'
 
-instance = CryptoApis::GenerateReceivingAddressRB.new(
+instance = CryptoApis::GenerateDepositAddressRB.new(
   context: null,
   data: null
 )

data/docs/GenerateDepositAddressRBData.md

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

data/docs/{GenerateReceivingAddressRBDataItem.md → GenerateDepositAddressRBDataItem.md}

@@ -1,4 +1,4 @@
-# CryptoApis::GenerateReceivingAddressRBDataItem
+# CryptoApis::GenerateDepositAddressRBDataItem
 
 ## Properties
 
@@ -11,7 +11,7 @@
 ```ruby
 require 'crypto_apis'
 
-instance = CryptoApis::GenerateReceivingAddressRBDataItem.new(
+instance = CryptoApis::GenerateDepositAddressRBDataItem.new(
   label: yourLabelStringHere
 )
 ```

data/docs/GenerateDepositAddressRData.md

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

data/docs/{GenerateReceivingAddressRI.md → GenerateDepositAddressRI.md}

@@ -1,4 +1,4 @@
-# CryptoApis::GenerateReceivingAddressRI
+# CryptoApis::GenerateDepositAddressRI
 
 ## Properties
 
@@ -13,7 +13,7 @@
 ```ruby
 require 'crypto_apis'
 
-instance = CryptoApis::GenerateReceivingAddressRI.new(
+instance = CryptoApis::GenerateDepositAddressRI.new(
   address: 0xe2b5f5e885a268e4b6faae53f99a663f3bb3e036,
   created_timestamp: 1624028267,
   label: yourLabelStringHere