cybrid_api_bank_ruby 0.27.0 → 0.37.25

data/docs/{TradingConfigurationListBankModel.md → FeeConfigurationListBankModel.md}

@@ -1,4 +1,4 @@
-# CybridApiBank::TradingConfigurationListBankModel
+# CybridApiBank::FeeConfigurationListBankModel
 
 ## Properties
 
@@ -7,14 +7,14 @@
 | **total** | **Integer** | The total number of records available. | [optional] |
 | **page** | **Integer** | The page index to retrieve. | [optional] |
 | **per_page** | **Integer** | The number of entities per page to return. | [optional] |
-| **objects** | [**Array<TradingConfigurationBankModel>**](TradingConfigurationBankModel.md) |  | [optional] |
+| **objects** | [**Array<FeeConfigurationBankModel>**](FeeConfigurationBankModel.md) |  | [optional] |
 
 ## Example
 
 ```ruby
 require 'cybrid_api_bank_ruby'
 
-instance = CybridApiBank::TradingConfigurationListBankModel.new(
+instance = CybridApiBank::FeeConfigurationListBankModel.new(
   total: null,
   page: null,
   per_page: null,

data/docs/FeeConfigurationsBankApi.md

@@ -0,0 +1,230 @@
+# CybridApiBank::FeeConfigurationsBankApi
+
+All URIs are relative to *https://bank.demo.cybrid.app*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_fee_configuration**](FeeConfigurationsBankApi.md#create_fee_configuration) | **POST** /api/fee_configurations | Create Fee Configuration |
+| [**get_fee_configuration**](FeeConfigurationsBankApi.md#get_fee_configuration) | **GET** /api/fee_configurations/{fee_configuration_guid} | Get Fee Configuration |
+| [**list_fee_configurations**](FeeConfigurationsBankApi.md#list_fee_configurations) | **GET** /api/fee_configurations | List Fee Configurations |
+
+
+## create_fee_configuration
+
+> <FeeConfigurationBankModel> create_fee_configuration(post_fee_configuration_bank_model)
+
+Create Fee Configuration
+
+Creates a fee configuration.  Required scope: **banks:write**
+
+### Examples
+
+```ruby
+require 'time'
+require 'cybrid_api_bank_ruby'
+# setup authorization
+CybridApiBank.configure do |config|
+  # Configure Bearer authorization (JWT): BearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = CybridApiBank::FeeConfigurationsBankApi.new
+post_fee_configuration_bank_model = CybridApiBank::PostFeeConfigurationBankModel.new({product_type: 'trading', asset: 'asset_example', fees: [CybridApiBank::PostFeeBankModel.new({type: 'spread'})]}) # PostFeeConfigurationBankModel | 
+
+begin
+  # Create Fee Configuration
+  result = api_instance.create_fee_configuration(post_fee_configuration_bank_model)
+  p result
+rescue CybridApiBank::ApiError => e
+  puts "Error when calling FeeConfigurationsBankApi->create_fee_configuration: #{e}"
+end
+```
+
+#### Using the create_fee_configuration_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<FeeConfigurationBankModel>, Integer, Hash)> create_fee_configuration_with_http_info(post_fee_configuration_bank_model)
+
+```ruby
+begin
+  # Create Fee Configuration
+  data, status_code, headers = api_instance.create_fee_configuration_with_http_info(post_fee_configuration_bank_model)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <FeeConfigurationBankModel>
+rescue CybridApiBank::ApiError => e
+  puts "Error when calling FeeConfigurationsBankApi->create_fee_configuration_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **post_fee_configuration_bank_model** | [**PostFeeConfigurationBankModel**](PostFeeConfigurationBankModel.md) |  |  |
+
+### Return type
+
+[**FeeConfigurationBankModel**](FeeConfigurationBankModel.md)
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth), [oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## get_fee_configuration
+
+> <FeeConfigurationBankModel> get_fee_configuration(fee_configuration_guid)
+
+Get Fee Configuration
+
+Retrieves a fee configuration.  Required scope: **banks:read**
+
+### Examples
+
+```ruby
+require 'time'
+require 'cybrid_api_bank_ruby'
+# setup authorization
+CybridApiBank.configure do |config|
+  # Configure Bearer authorization (JWT): BearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = CybridApiBank::FeeConfigurationsBankApi.new
+fee_configuration_guid = 'fee_configuration_guid_example' # String | Identifier for the fee configuration.
+
+begin
+  # Get Fee Configuration
+  result = api_instance.get_fee_configuration(fee_configuration_guid)
+  p result
+rescue CybridApiBank::ApiError => e
+  puts "Error when calling FeeConfigurationsBankApi->get_fee_configuration: #{e}"
+end
+```
+
+#### Using the get_fee_configuration_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<FeeConfigurationBankModel>, Integer, Hash)> get_fee_configuration_with_http_info(fee_configuration_guid)
+
+```ruby
+begin
+  # Get Fee Configuration
+  data, status_code, headers = api_instance.get_fee_configuration_with_http_info(fee_configuration_guid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <FeeConfigurationBankModel>
+rescue CybridApiBank::ApiError => e
+  puts "Error when calling FeeConfigurationsBankApi->get_fee_configuration_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **fee_configuration_guid** | **String** | Identifier for the fee configuration. |  |
+
+### Return type
+
+[**FeeConfigurationBankModel**](FeeConfigurationBankModel.md)
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth), [oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_fee_configurations
+
+> <FeeConfigurationListBankModel> list_fee_configurations(opts)
+
+List Fee Configurations
+
+Retrieves a listing of fee configurations for a bank.  Required scope: **banks:read**
+
+### Examples
+
+```ruby
+require 'time'
+require 'cybrid_api_bank_ruby'
+# setup authorization
+CybridApiBank.configure do |config|
+  # Configure Bearer authorization (JWT): BearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+
+  # Configure OAuth2 access token for authorization: oauth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = CybridApiBank::FeeConfigurationsBankApi.new
+opts = {
+  page: 56, # Integer | 
+  per_page: 56 # Integer | 
+}
+
+begin
+  # List Fee Configurations
+  result = api_instance.list_fee_configurations(opts)
+  p result
+rescue CybridApiBank::ApiError => e
+  puts "Error when calling FeeConfigurationsBankApi->list_fee_configurations: #{e}"
+end
+```
+
+#### Using the list_fee_configurations_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<FeeConfigurationListBankModel>, Integer, Hash)> list_fee_configurations_with_http_info(opts)
+
+```ruby
+begin
+  # List Fee Configurations
+  data, status_code, headers = api_instance.list_fee_configurations_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <FeeConfigurationListBankModel>
+rescue CybridApiBank::ApiError => e
+  puts "Error when calling FeeConfigurationsBankApi->list_fee_configurations_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **page** | **Integer** |  | [optional] |
+| **per_page** | **Integer** |  | [optional] |
+
+### Return type
+
+[**FeeConfigurationListBankModel**](FeeConfigurationListBankModel.md)
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth), [oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/IdentityRecordsBankApi.md

@@ -15,7 +15,7 @@ All URIs are relative to *https://bank.demo.cybrid.app*
 
 Create Identity Record
 
-Creates an identity record.  ## Identity Records  Identity Records verify an individual for inclusion on the platform. This know-your-customer (KYC) process is a requirement for individuals to be able to transact. At present, we offer support for Attestation Identity Records.  Once an Identity Record has been submitted, it will be reviewed by our system and transit through a lifecycle before ultimately being `verified` or `failed`. If an Identity Record is ends up `failed`, contextual information as to the reason may be provided on the resource and additional attempts can be made.  ## Attestation Identity Records  An Attestation Identity Record is a confirmation of fact that the Organization has completed their own KYC process and can vouch for its correctness.  Prior to uploading `verified` attestation identity records, an Organization must register their signing public key with their Bank through the create Verification Key API.  To create an attestation identity record, a signed JWT is required as proof that the Customer's identity has been verified by the Organization. When creating the JWT, the Organization must use the RS512 signing algorithm.  The JWT must contain the following headers:  - **alg**: The RS512 algorithm value, e.g., 'RS512'. - **kid**: Set to the guid of the verification key that has been registered for the Bank  The JWT must contain the following claims:  - **iss**: Set to http://api.cybrid.app/banks/{bank_guid} - **aud**: Set to http://api.cybrid.app - **sub**: Set to http://api.cybrid.app/customers/{customer_guid} - **iat**: Set to the time at which the JWT was issued - **exp**: Set to the time after which the JWT expires - **jti**: Set to a unique identifier for the JWT  Example code (python) for generating an Attestation Identity Record JWT token:  ```python # Assumes an RSA private key has been generated (`private_key`), a Verification Key has been created and a `verification_key_guid` is available. # # `customer_guid` should be set to the guid assigned to a Customer that has been created. # `bank_guid` should be set to the guid of your bank #  import uuid  from datetime import datetime, timezone, timedelta from jwcrypto import jwt, jwk from cryptography.hazmat.primitives import serialization from cryptography.hazmat.primitives.serialization import load_pem_private_key  algorithm = 'RS512' issued_at = datetime.now(timezone.utc) expired_at = issued_at + timedelta(days=365)  with open(\"verification_key.pem\", 'rb') as pem_in:   pem_lines = pem_in.read()  private_key = load_pem_private_key(pem_lines, None)  ### DISCLAIMER:- Since NO ENCRYPTION is used in the key storage/formatting. Please DO NOT use this code in production environment. signing_key = jwk.JWK.from_pem(     private_key.private_bytes(         encoding=serialization.Encoding.PEM,         format=serialization.PrivateFormat.PKCS8,         encryption_algorithm=serialization.NoEncryption()     ) ) signing_key.update({\"kid\": verification_key_guid})  attestation_jwt = jwt.JWT(     header={         \"alg\": algorithm,         \"kid\": verification_key_guid     },     claims={         \"iss\": f\"http://api.cybrid.app/banks/{bank_guid}\",         \"aud\": \"http://api.cybrid.app\",         \"sub\": f\"http://api.cybrid.app/customers/{customer_guid}\",         \"iat\": int(issued_at.timestamp()),         \"exp\": int(expired_at.timestamp()),         \"jti\": str(uuid.uuid4())     },     key=signing_key,     algs=[algorithm] ) attestation_jwt.make_signed_token(signing_key)  token = attestation_jwt.serialize(compact=True) print(\"Token is : \", token) ```  ## Attestation State  | State | Description | |-------|-------------| | storing | The Platform is storing the attestation in our private store | | pending | The Platform is verifying the attestation's JWT | | verified | The Platform has verified the attestation and the customer is able to transact | | failed | The Platform was not able to verify the attestation and the customer is not able to transact |    Required scope: **customers:write**
+Creates an identity record.  ## Identity Records  Identity Records verify an individual for inclusion on the platform. This know-your-customer (KYC) process is a requirement for individuals to be able to transact. At present, we offer support for Attestation Identity Records.  Once an Identity Record has been submitted, it will be reviewed by our system and transit through a lifecycle before ultimately being `verified` or `failed`. If an Identity Record is ends up `failed`, contextual information as to the reason may be provided on the resource and additional attempts can be made.  ## Attestation Identity Records  An Attestation Identity Record is a confirmation of fact that the Organization has completed their own KYC process and can vouch for its correctness.  Prior to uploading `verified` attestation identity records, an Organization must register their signing public key with their Bank through the create Verification Key API.  To create an attestation identity record, a signed JWT is required as proof that the Customer's identity has been verified by the Organization. When creating the JWT, the Organization must use the RS512 signing algorithm.  The JWT must contain the following headers:  - **alg**: The RS512 algorithm value, e.g., 'RS512'. - **kid**: Set to the guid of the verification key that has been registered for the Bank  The JWT must contain the following claims:  - **iss**: Set to http://api.cybrid.app/banks/{bank_guid} - **aud**: Set to http://api.cybrid.app - **sub**: Set to http://api.cybrid.app/customers/{customer_guid} - **iat**: Set to the time at which the JWT was issued - **exp**: Set to the time after which the JWT expires - **jti**: Set to a unique identifier for the JWT  Example code (python) for generating an Attestation Identity Record JWT token:  ```python # Assumes an RSA private key has been generated (`private_key`), a Verification Key has been created and a `verification_key_guid` is available. # # `customer_guid` should be set to the guid assigned to a Customer that has been created. # `bank_guid` should be set to the guid of your bank #  import uuid  from datetime import datetime, timezone, timedelta from jwcrypto import jwt, jwk from cryptography.hazmat.primitives import serialization from cryptography.hazmat.primitives.serialization import load_pem_private_key  algorithm = 'RS512' issued_at = datetime.now(timezone.utc) expired_at = issued_at + timedelta(days=365)  with open(\"verification_key.pem\", 'rb') as pem_in:   pem_lines = pem_in.read()  private_key = load_pem_private_key(pem_lines, None)  ### DISCLAIMER:- Since NO ENCRYPTION is used in the key storage/formatting. Please DO NOT use this code in production environment. signing_key = jwk.JWK.from_pem(     private_key.private_bytes(         encoding=serialization.Encoding.PEM,         format=serialization.PrivateFormat.PKCS8,         encryption_algorithm=serialization.NoEncryption()     ) ) signing_key.update({\"kid\": verification_key_guid})  attestation_jwt = jwt.JWT(     header={         \"alg\": algorithm,         \"kid\": verification_key_guid     },     claims={         \"iss\": f\"http://api.cybrid.app/banks/{bank_guid}\",         \"aud\": \"http://api.cybrid.app\",         \"sub\": f\"http://api.cybrid.app/customers/{customer_guid}\",         \"iat\": int(issued_at.timestamp()),         \"exp\": int(expired_at.timestamp()),         \"jti\": str(uuid.uuid4())     },     key=signing_key,     algs=[algorithm] ) attestation_jwt.make_signed_token(signing_key)  token = attestation_jwt.serialize(compact=True) print(\"Token is : \", token) ```  ## Default Attestation Signing Key  The Cybrid Sandbox environment comes provisioned with a default signing key that can be used to perform identity record attestation. The default identity signing key provides a convenient starting point for testing Sandbox flows that require identity attestation, such as executing trades.  The signing key can be loaded directly into a client application by passing its PEM encoded value as an environment variable.  ``` -----BEGIN PRIVATE KEY----- MIIEvwIBADANBgkqhkiG9w0BAQEFAASCBKkwggSlAgEAAoIBAQDZ75nSfJy/eeuj 4f7EK7i+n4FUDE8BsD/acCdk9Pn56suuDc3SFcMoyjBIoDLZkbRsVfmBEcPDNJOp GNqzoaXa7qe7Yw0qpK9MbNbAYxiyAfxwVHM+ZpwP6M/r3LmsCRFXgNdCjfOzok7u V59hDjfHMMQm/M9ztGVhaJpgozY/7DKk+R6qY/DEBs63eXwfcHE0u0NbS8Y9Qp+6 7cB2f1iuy++5Uut1vx4qdgZ4UFMkwIdTWl/e6LDcdXhk3///T5WOnDlI+S4rhGUO xsAOfOa+T9uqYBr2hbQR9emTEYmwF1lgZ7VU4S9sSjAMKpB/TVlVVOsNhdNSGg6f 6hu7fuadAgMBAAECggEBAMUJL1VyfHVRUY5VoPTTYrBVnaPTjQrFwrVHeRZ5thgS BBxVNqSeMFgMlSLUU6UJasoX4QCkgw1V17qmUfTeTQlnhBaTMzA+vI6oSHCgJ4+o 5AbbE2Zzdt2ba4Cfiu7TM+6c+gGePZtHP32Vku84340jtfRZ1WWSz6YF4K1GYqHe y7I4POotHu2WcSTXYKs2zTu5KAO7gvx7yITVytaiUGUHk9FNyZPDIh0u7e9CAEti BangdYTfvbXAIx9lrg3XQ4gtFXTd0aY/3R9K3SE+s5iWh/SabjV4U7x+MuHZS5kv 8rcLCPQ5kUgiF4bQMy7QznUuNso65SbRJKHaU8UAuIECgYEA7+bNdz/uiN/JxUJY 3xwjD+CG4vXOyEmCioBjllYBeXQyB/VrsdzVrdF2JiECnStPRH6/6nd7/wUcLORv NyrQqnCa5/O8Kv9Z3t4TmxYf+ECIgx+gazehQHptUkr8QWtxceorUC9pu4cUJ8z3 nQLCggHYQ3g7xj73LLZ+5QQBC8kCgYEA6I91Dgs+HZWDMMcGbKV2cMkXK8BTOgZZ 6B6i6flO4tf9U2CPBZsjYLBN5EEuxxy9Yl7rlV7CxAhnnjdIKk2jQbzTPI0qmJfp 397rvdR8bur1OkALj2Tb39fz8z1Qy7AcN8siqXuortZZ5OI9XRWgnG/3B4gUFOnW 4Mr0dhfaxjUCgYEAmVcricehjneMnrtz1thDSQi47yUzES57dE/wV82Nj7ZHrHKg bcW8ByhVnrWG2DMwrZVe0l2hMjZv9fnlZJvHWMo1GYHfipRBO4UzfvO7Z5DIMRfs D9w1A+O9MNahOqeUkb2eBdjoemcy6OXId+Gltje7phSaEHN6xme34GaYzJECgYBP eRbLYdQsT/exJ5JudmzvRgkBDoxie+EljbKmumfW5XDQmWLGy6lfVWCI7C2MJaoi f8WKGgP88dJXIxUqP7XWtSyKuMMhumhV9Nwi1wZe8TQ0X8aTjigFassXCJEfymMa PfTubi/K771wlk/aC5YDX8/PZxVVwEOKNlEsOiKtMQKBgQDqRv5AUHhabqcMfbs7 DTeo/fS/eXJv8MN+CUU2RSrNUKjEdHT2R5KP550TyXr1JXLKpEEZu8wvvaQDV4Dw p0Eij6bKsh03X38NR+C5SxonXPosdvoiXR8uUgya2f/aJYV+aWZ9euFgYZAXf/0Q MnWdKylfZlV50XP2KFn07wPs7w== -----END PRIVATE KEY----- ```  A corresponding public verification key can be retrieved from the Cybrid Banks API using the `/api/bank_verification_keys` endpoint. Performing a `get` request to this endpoint returns the available Verification Key records, the first of which is the provisioned default. The endpoint can be hit directly or by using the Cybrid Banks API client:  ```python ... api_client = cybrid_api_bank.ApiClient(configuration) api_instance = verification_keys_bank_api.VerificationKeysBankApi(api_client) verification_keys = api_instance.list_verification_keys() verification_key = verification_keys.objects[0] ```  Once available to the application, the signing key and Verification Key record can be used in conjunction to create the attestation JWT. The Verification Key's GUID is passed as the JWT's `kid` while the signing key is used to sign the JWT.  ## Attestation State  | State | Description | |-------|-------------| | storing | The Platform is storing the attestation in our private store | | pending | The Platform is verifying the attestation's JWT | | verified | The Platform has verified the attestation and the customer is able to transact | | failed | The Platform was not able to verify the attestation and the customer is not able to transact |    Required scope: **customers:write**
 
 ### Examples
 
@@ -214,8 +214,8 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **customer_guid** | **String** | Comma separated customer identifier to list identity records for. | [optional] |
-| **page** | **Integer** |  | [optional][default to 0] |
-| **per_page** | **Integer** |  | [optional][default to 10] |
+| **page** | **Integer** |  | [optional] |
+| **per_page** | **Integer** |  | [optional] |
 
 ### Return type
 

data/docs/PatchBankBankModel.md

@@ -0,0 +1,22 @@
+# CybridApiBank::PatchBankBankModel
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The bank's name. | [optional] |
+| **supported_trading_symbols** | **Array<String>** | The bank's list of supported trading symbols. | [optional] |
+| **supported_savings_configuration** | **Hash<String, Array<String>>** | The bank's list of supported savings asset by provider. | [optional] |
+
+## Example
+
+```ruby
+require 'cybrid_api_bank_ruby'
+
+instance = CybridApiBank::PatchBankBankModel.new(
+  name: null,
+  supported_trading_symbols: null,
+  supported_savings_configuration: null
+)
+```
+

data/docs/PostAccountBankModel.md

@@ -5,6 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **type** | **String** | The account type. |  |
+| **provider** | **String** | The account provider, if applicable. | [optional] |
 | **customer_guid** | **String** | The customer identifier associated with the account. |  |
 | **asset** | **String** | The asset code. |  |
 | **name** | **String** | The name of the account. |  |
@@ -16,6 +17,7 @@ require 'cybrid_api_bank_ruby'
 
 instance = CybridApiBank::PostAccountBankModel.new(
   type: null,
+  provider: null,
   customer_guid: null,
   asset: null,
   name: null

data/docs/PostBankBankModel.md

@@ -6,7 +6,8 @@
 | ---- | ---- | ----------- | ----- |
 | **name** | **String** | The bank's name. |  |
 | **type** | **String** | The bank's type. At present, only **sandbox** is supported. |  |
-| **supported_fiat_assets** | **Array<String>** | The bank's list of supported fiat assets. |  |
+| **supported_trading_symbols** | **Array<String>** | The bank's list of supported trading symbols. |  |
+| **supported_savings_configuration** | **Hash<String, Array<String>>** | The bank's list of supported savings asset by provider. | [optional] |
 | **features** | **Array<String>** | The bank's enabled features. At present, both **attestation_identity_records** and **backstopped_funding_source** must be set. |  |
 
 ## Example
@@ -17,7 +18,8 @@ require 'cybrid_api_bank_ruby'
 instance = CybridApiBank::PostBankBankModel.new(
   name: null,
   type: null,
-  supported_fiat_assets: null,
+  supported_trading_symbols: null,
+  supported_savings_configuration: null,
   features: null
 )
 ```

data/docs/PostFeeConfigurationBankModel.md

@@ -0,0 +1,24 @@
+# CybridApiBank::PostFeeConfigurationBankModel
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **product_type** | **String** | The type of product being configured. |  |
+| **asset** | **String** | The asset code. |  |
+| **fees** | [**Array<PostFeeBankModel>**](PostFeeBankModel.md) | The fees associated with the configuration |  |
+| **product_provider** | **String** | The provider for the product being configured. | [optional] |
+
+## Example
+
+```ruby
+require 'cybrid_api_bank_ruby'
+
+instance = CybridApiBank::PostFeeConfigurationBankModel.new(
+  product_type: null,
+  asset: null,
+  fees: null,
+  product_provider: null
+)
+```
+

data/docs/PostQuoteBankModel.md

@@ -4,11 +4,14 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
+| **product_type** | **String** | The type of product the quote is for. | [optional][default to 'trading'] |
 | **customer_guid** | **String** | The unique identifier for the customer. |  |
-| **symbol** | **String** | Symbol the quote is being requested for. Format is \"asset-counter_asset\" in uppercase. See the Symbols API for a complete list of cryptocurrencies supported. |  |
-| **side** | **String** | The direction of the quote: either 'buy' or 'sell'. |  |
-| **receive_amount** | **Integer** | The amount to be received in base units of the currency: currency is \"asset\" for buy and \"counter_asset\" for sell. | [optional] |
-| **deliver_amount** | **Integer** | The amount to be delivered in base units of the currency: currency is \"counter_asset\" for buy and \"asset\" for sell. | [optional] |
+| **symbol** | **String** | Symbol the quote is being requested for. Format is \"asset-counter_asset\" in uppercase. See the Symbols API for a complete list of cryptocurrencies supported. | [optional] |
+| **asset** | **String** | The asset code the quote was requested for. Populated for savings quotes. | [optional] |
+| **side** | **String** | The direction of the quote: either 'buy' or 'sell' for trade quotes; 'deposit' or 'withdrawal' for savings quotes. |  |
+| **receive_amount** | **Integer** | The amount to be received in base units of the currency: currency is \"asset\" for buy and \"counter_asset\" for sell for trade quotes and currency is always \"asset\" for savings quotes. | [optional] |
+| **deliver_amount** | **Integer** | The amount to be delivered in base units of the currency: currency is \"counter_asset\" for buy and \"asset\" for sell for trade quotes and currency is always \"asset\" for savings quotes. | [optional] |
+| **product_provider** | **String** | The provider for the product being quoted. Populated for savings quotes. | [optional] |
 
 ## Example
 
@@ -16,11 +19,14 @@
 require 'cybrid_api_bank_ruby'
 
 instance = CybridApiBank::PostQuoteBankModel.new(
+  product_type: null,
   customer_guid: null,
   symbol: null,
+  asset: null,
   side: null,
   receive_amount: null,
-  deliver_amount: null
+  deliver_amount: null,
+  product_provider: null
 )
 ```
 

data/docs/PostRewardBankModel.md

@@ -0,0 +1,24 @@
+# CybridApiBank::PostRewardBankModel
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **customer_guid** | **String** | The unique identifier for the customer. |  |
+| **symbol** | **String** | Symbol the quote is being requested for. Format is \"asset-counter_asset\" in uppercase. See the Symbols API for a complete list of cryptocurrencies supported. |  |
+| **receive_amount** | **Integer** | The amount to be received in base units of the currency: currency is \"asset\" for buy and \"counter_asset\" for sell. | [optional] |
+| **deliver_amount** | **Integer** | The amount to be delivered in base units of the currency: currency is \"counter_asset\" for buy and \"asset\" for sell. | [optional] |
+
+## Example
+
+```ruby
+require 'cybrid_api_bank_ruby'
+
+instance = CybridApiBank::PostRewardBankModel.new(
+  customer_guid: null,
+  symbol: null,
+  receive_amount: null,
+  deliver_amount: null
+)
+```
+

data/docs/QuoteBankModel.md

@@ -5,14 +5,17 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **guid** | **String** | Auto-generated unique identifier for the quote. | [optional] |
+| **product_type** | **String** | The type of product the quote is for. | [optional] |
 | **customer_guid** | **String** | The unique identifier for the customer. | [optional] |
-| **symbol** | **String** | Symbol the quote is being requested for. Format is \"asset-counter_asset\" in uppercase. | [optional] |
-| **side** | **String** | The direction of the quote: either 'buy' or 'sell'. | [optional] |
-| **receive_amount** | **Integer** | The amount to be received in base units of the currency: currency is \"asset\" for buy and \"counter_asset\" for sell. | [optional] |
-| **deliver_amount** | **Integer** | The amount to be delivered in base units of the currency: currency is \"counter_asset\" for buy and \"asset\" for sell. | [optional] |
-| **fee** | **Integer** | The fee associated with the trade. Denominated in \"counter_asset\" base units | [optional] |
+| **symbol** | **String** | Symbol the quote was requested for. Format is \"asset-counter_asset\" in uppercase. Populated for trade quotes. | [optional] |
+| **asset** | **String** | The asset code the quote was requested for. Populated for savings quotes. | [optional] |
+| **side** | **String** | The direction of the quote: either 'buy' or 'sell' for trade quotes; 'deposit' or 'withdrawal' for savings quotes. | [optional] |
+| **receive_amount** | **Integer** | The amount to be received in base units of the currency: currency is \"asset\" for buy and \"counter_asset\" for sell for trade quotes and currency is always \"asset\" for savings quotes. | [optional] |
+| **deliver_amount** | **Integer** | The amount to be delivered in base units of the currency: currency is \"counter_asset\" for buy and \"asset\" for sell for trade quotes and currency is always \"asset\" for savings quotes. | [optional] |
+| **fee** | **Integer** | The fee associated with the trade. Denominated in \"counter_asset\" base units for trade quotes and \"asset\" for savings quotes. | [optional] |
 | **issued_at** | **Time** | ISO8601 datetime the quote was created at. | [optional] |
-| **expires_at** | **Time** | ISO8601 datetime the quote is expiring at. | [optional] |
+| **expires_at** | **Time** | ISO8601 datetime the quote is expiring at. Populated for trading quotes. | [optional] |
+| **product_provider** | **String** | The provider for the product being quoted. Populated for savings quotes. | [optional] |
 
 ## Example
 
@@ -21,14 +24,17 @@ require 'cybrid_api_bank_ruby'
 
 instance = CybridApiBank::QuoteBankModel.new(
   guid: null,
+  product_type: null,
   customer_guid: null,
   symbol: null,
+  asset: null,
   side: null,
   receive_amount: null,
   deliver_amount: null,
   fee: null,
   issued_at: null,
-  expires_at: null
+  expires_at: null,
+  product_provider: null
 )
 ```
 

data/docs/QuotesBankApi.md

@@ -32,7 +32,7 @@ CybridApiBank.configure do |config|
 end
 
 api_instance = CybridApiBank::QuotesBankApi.new
-post_quote_bank_model = CybridApiBank::PostQuoteBankModel.new({customer_guid: 'customer_guid_example', symbol: 'symbol_example', side: 'buy'}) # PostQuoteBankModel | 
+post_quote_bank_model = CybridApiBank::PostQuoteBankModel.new({customer_guid: 'customer_guid_example', side: 'buy'}) # PostQuoteBankModel | 
 
 begin
   # Create Quote
@@ -215,8 +215,8 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **page** | **Integer** |  | [optional][default to 0] |
-| **per_page** | **Integer** |  | [optional][default to 10] |
+| **page** | **Integer** |  | [optional] |
+| **per_page** | **Integer** |  | [optional] |
 | **guid** | **String** | Comma separated quote_guids to list quotes for. | [optional] |
 | **bank_guid** | **String** | Comma separated bank_guids to list quotes for. | [optional] |
 | **customer_guid** | **String** | Comma separated customer_guids to list quotes for. | [optional] |

data/docs/RewardBankModel.md

@@ -0,0 +1,36 @@
+# CybridApiBank::RewardBankModel
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **guid** | **String** | Auto-generated unique identifier for the reward. | [optional] |
+| **customer_guid** | **String** | The associated customer's identifier. | [optional] |
+| **quote_guid** | **String** | The associated quote's identifier. | [optional] |
+| **trade_guid** | **String** | The associated trade's identifier. | [optional] |
+| **symbol** | **String** | The trade symbol the pricing is related to. Format is asset-counter_asset, e.g., BTC-USD. | [optional] |
+| **state** | **String** | The trade's state | [optional] |
+| **receive_amount** | **Integer** | The amount to be received in base units of the currency: currency is \"asset\" for buy and \"counter_asset\" for sell. | [optional] |
+| **deliver_amount** | **Integer** | The amount to be delivered in base units of the currency: currency is \"counter_asset\" for buy and \"asset\" for sell. | [optional] |
+| **fee** | **Integer** | The fee associated with the trade. Denominated in \"counter_asset\" base units | [optional] |
+| **created_at** | **Time** | ISO8601 datetime the bank was created at. | [optional] |
+
+## Example
+
+```ruby
+require 'cybrid_api_bank_ruby'
+
+instance = CybridApiBank::RewardBankModel.new(
+  guid: null,
+  customer_guid: null,
+  quote_guid: null,
+  trade_guid: null,
+  symbol: null,
+  state: null,
+  receive_amount: null,
+  deliver_amount: null,
+  fee: null,
+  created_at: null
+)
+```
+

data/docs/{ExchangeListBankModel.md → RewardListBankModel.md}

@@ -1,4 +1,4 @@
-# CybridApiBank::ExchangeListBankModel
+# CybridApiBank::RewardListBankModel
 
 ## Properties
 
@@ -7,14 +7,14 @@
 | **total** | **Integer** | The total number of records available. |  |
 | **page** | **Integer** | The page index to retrieve. |  |
 | **per_page** | **Integer** | The number of entities per page to return. |  |
-| **objects** | [**Array<ExchangeBankModel>**](ExchangeBankModel.md) | Array of exchange entities |  |
+| **objects** | [**Array<RewardBankModel>**](RewardBankModel.md) | Array of reward entities |  |
 
 ## Example
 
 ```ruby
 require 'cybrid_api_bank_ruby'
 
-instance = CybridApiBank::ExchangeListBankModel.new(
+instance = CybridApiBank::RewardListBankModel.new(
   total: null,
   page: null,
   per_page: null,