transferzero-sdk 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce4d174d504a7f40b7ea78d1df4987c995bd7ea6de24575b869d83e80d86e472
-  data.tar.gz: 7cd4f75a922371b0f9482adacb232ca99e7f1bbbbd58fc04c98396ba89b40fff
+  metadata.gz: 501bc663322a04ddda61c7d4567a826e068a459920730d2d0b10591376949c70
+  data.tar.gz: 0bc7115b3aefaa82d95309ab9ae3ffc82ed9ca7f8d40e6b764967790e9e74f5a
 SHA512:
-  metadata.gz: b110e12f269a31bdc8e415281ba33bcda5305fed54b953d205837ad3394bd705638c62a59b2e46d1bf1953f2d5a9872e8d2d34a3fbb18d1a44d7e48d87d35f2e
-  data.tar.gz: 122534c37ebeb9816a95978c8ef8c5dd76ee11511ee608dd1d4aca72797bec91aefda7f08051b42245eb10132828a2f9428506f5fff5188378c8b6cadb1d28d6
+  metadata.gz: 0e9c4f9d601c8e7d7429075cc9632cbf93b65752353cf6476cf63f855b5ba50850a5c50f254d66b410a090d3496fb9c5c6cf28444d4d77ccbaafe0f5890eefba
+  data.tar.gz: '09c080ee1b6656b6be9927abea4c49516310f70356f5fead6c647635757a1831bfbaf7ba53cecd10db7171ac824040d4969ccdbfdf40504151ddf6af30082a40'

data/README.md

@@ -7,15 +7,15 @@ Reference documentation for the TransferZero API V1
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 1.0
-- Package version: 1.4.0
+- Package version: 1.5.0
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 
 For more information, please visit:
 
-* [API Documentation](https://github.com/transferzero/api-documentation)
-  * [Onboarding guide](https://github.com/transferzero/api-documentation/blob/master/quick-integration.md)
-  * [Transaction flow](https://github.com/transferzero/api-documentation/blob/master/transaction-flow.md)
-  * [Additional features](https://github.com/transferzero/api-documentation/blob/master/additional-features.md)
+* [API Documentation](https://docs.transferzero.com)
+  * [Onboarding guide](https://docs.transferzero.com/docs/quick-integration/)
+  * [Transaction flow](https://docs.transferzero.com/docs/transaction-flow/)
+  * [Additional features](https://docs.transferzero.com/docs/additional-features/)
 * [API Specification](https://api.transferzero.com/documentation)
 
 ## Installation
@@ -31,15 +31,15 @@ gem build transferzero-sdk.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./transferzero-sdk-1.4.0.gem
+gem install ./transferzero-sdk-1.5.0.gem
 ```
-(for development, run `gem install --dev ./transferzero-sdk-1.4.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./transferzero-sdk-1.5.0.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'transferzero-sdk', '~> 1.4.0'
+    gem 'transferzero-sdk', '~> 1.5.0'
 
 ### Install from Git
 
@@ -115,6 +115,7 @@ Class | Method | HTTP request | Description
 *TransferZero::CurrencyInfoApi* | [**info_currencies**](docs/CurrencyInfoApi.md#info_currencies) | **GET** /info/currencies | Getting a list of possible requested currencies
 *TransferZero::CurrencyInfoApi* | [**info_currencies_in**](docs/CurrencyInfoApi.md#info_currencies_in) | **GET** /info/currencies/in | Getting a list of possible input currencies
 *TransferZero::CurrencyInfoApi* | [**info_currencies_out**](docs/CurrencyInfoApi.md#info_currencies_out) | **GET** /info/currencies/out | Getting a list of possible output currencies
+*TransferZero::DocumentsApi* | [**delete_document**](docs/DocumentsApi.md#delete_document) | **DELETE** /documents/{Document ID} | Deleting a document
 *TransferZero::DocumentsApi* | [**get_document**](docs/DocumentsApi.md#get_document) | **GET** /documents/{Document ID} | Fetching a document
 *TransferZero::DocumentsApi* | [**get_documents**](docs/DocumentsApi.md#get_documents) | **GET** /documents | Getting a list of documents
 *TransferZero::DocumentsApi* | [**post_documents**](docs/DocumentsApi.md#post_documents) | **POST** /documents | Creating a document
@@ -165,11 +166,9 @@ Class | Method | HTTP request | Description
  - [TransferZero::ApiLogResponse](docs/ApiLogResponse.md)
  - [TransferZero::Currency](docs/Currency.md)
  - [TransferZero::CurrencyExchange](docs/CurrencyExchange.md)
- - [TransferZero::CurrencyExchangeAllOf](docs/CurrencyExchangeAllOf.md)
  - [TransferZero::CurrencyExchangeListResponse](docs/CurrencyExchangeListResponse.md)
  - [TransferZero::CurrencyListResponse](docs/CurrencyListResponse.md)
  - [TransferZero::CurrencyOpposite](docs/CurrencyOpposite.md)
- - [TransferZero::CurrencyOppositeAllOf](docs/CurrencyOppositeAllOf.md)
  - [TransferZero::Debit](docs/Debit.md)
  - [TransferZero::DebitListRequest](docs/DebitListRequest.md)
  - [TransferZero::DebitListResponse](docs/DebitListResponse.md)
@@ -181,7 +180,6 @@ Class | Method | HTTP request | Description
  - [TransferZero::DocumentRequest](docs/DocumentRequest.md)
  - [TransferZero::DocumentResponse](docs/DocumentResponse.md)
  - [TransferZero::DocumentWebhook](docs/DocumentWebhook.md)
- - [TransferZero::DocumentWebhookAllOf](docs/DocumentWebhookAllOf.md)
  - [TransferZero::ErrorStatus](docs/ErrorStatus.md)
  - [TransferZero::FieldDescription](docs/FieldDescription.md)
  - [TransferZero::FieldSelectValidation](docs/FieldSelectValidation.md)
@@ -214,14 +212,12 @@ Class | Method | HTTP request | Description
  - [TransferZero::PayoutMethodRequest](docs/PayoutMethodRequest.md)
  - [TransferZero::PayoutMethodResponse](docs/PayoutMethodResponse.md)
  - [TransferZero::PayoutMethodWebhook](docs/PayoutMethodWebhook.md)
- - [TransferZero::PayoutMethodWebhookAllOf](docs/PayoutMethodWebhookAllOf.md)
  - [TransferZero::Recipient](docs/Recipient.md)
  - [TransferZero::RecipientListResponse](docs/RecipientListResponse.md)
  - [TransferZero::RecipientRequest](docs/RecipientRequest.md)
  - [TransferZero::RecipientResponse](docs/RecipientResponse.md)
  - [TransferZero::RecipientState](docs/RecipientState.md)
  - [TransferZero::RecipientWebhook](docs/RecipientWebhook.md)
- - [TransferZero::RecipientWebhookAllOf](docs/RecipientWebhookAllOf.md)
  - [TransferZero::Sender](docs/Sender.md)
  - [TransferZero::SenderListResponse](docs/SenderListResponse.md)
  - [TransferZero::SenderRequest](docs/SenderRequest.md)
@@ -230,7 +226,6 @@ Class | Method | HTTP request | Description
  - [TransferZero::SenderResponseMeta](docs/SenderResponseMeta.md)
  - [TransferZero::SenderState](docs/SenderState.md)
  - [TransferZero::SenderWebhook](docs/SenderWebhook.md)
- - [TransferZero::SenderWebhookAllOf](docs/SenderWebhookAllOf.md)
  - [TransferZero::Transaction](docs/Transaction.md)
  - [TransferZero::TransactionListResponse](docs/TransactionListResponse.md)
  - [TransferZero::TransactionRequest](docs/TransactionRequest.md)
@@ -240,7 +235,6 @@ Class | Method | HTTP request | Description
  - [TransferZero::TransactionState](docs/TransactionState.md)
  - [TransferZero::TransactionTraits](docs/TransactionTraits.md)
  - [TransferZero::TransactionWebhook](docs/TransactionWebhook.md)
- - [TransferZero::TransactionWebhookAllOf](docs/TransactionWebhookAllOf.md)
  - [TransferZero::ValidationErrorDescription](docs/ValidationErrorDescription.md)
  - [TransferZero::Webhook](docs/Webhook.md)
  - [TransferZero::WebhookDefinition](docs/WebhookDefinition.md)

data/docs/Document.md

@@ -4,6 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**sender_id** | **String** |  | [optional] 
 **upload** | **String** | Base64 encoded data uri of an image/pdf file or a fully qualified url | 
 **upload_file_name** | **String** | Name of the upload | 
 **metadata** | [**Object**](.md) | Metadata of document | [optional] 
@@ -11,6 +12,7 @@ Name | Type | Description | Notes
 **upload_file_size** | **Integer** |  | [optional] 
 **category** | **String** | uncategorised | [optional] 
 **side** | **String** | The side of the KYC ID. One of 'front' or 'back' | [optional] 
+**document_type** | **String** | This is a brief description of the document type | [optional] 
 **issuing_country** | **String** | Issuing country of ID in 2-character alpha ISO 3166-2 country format | [optional] 
 **id** | **String** |  | [optional] 
 **errors** | **Hash<String, Array<ValidationErrorDescription>>** | The fields that have some problems and don't pass validation | [optional] 
@@ -20,13 +22,15 @@ Name | Type | Description | Notes
 ```ruby
 require 'TransferZero'
 
-instance = TransferZero::Document.new(upload: data:image/png;base64,iVBORw0KGg...lFTkSuQmCC,
+instance = TransferZero::Document.new(sender_id: ebe9bc0b-f2f6-4ce8-802a-8b79912d041e,
+                                 upload: data:image/png;base64,iVBORw0KGg...lFTkSuQmCC,
                                  upload_file_name: example.png,
                                  metadata: {},
                                  upload_content_type: image/png,
                                  upload_file_size: 30255,
                                  category: null,
                                  side: null,
+                                 document_type: certificate_of_business_name_registration,
                                  issuing_country: NG,
                                  id: ebe9bc0b-f2f6-4ce8-802a-8b79912d041e,
                                  errors: {"phone_number":[{"error":"invalid"}],"documents":[{"error":"blank"}]})

data/docs/DocumentsApi.md

@@ -4,13 +4,79 @@ All URIs are relative to *https://api-sandbox.transferzero.com/v1*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
+[**delete_document**](DocumentsApi.md#delete_document) | **DELETE** /documents/{Document ID} | Deleting a document
 [**get_document**](DocumentsApi.md#get_document) | **GET** /documents/{Document ID} | Fetching a document
 [**get_documents**](DocumentsApi.md#get_documents) | **GET** /documents | Getting a list of documents
 [**post_documents**](DocumentsApi.md#post_documents) | **POST** /documents | Creating a document
 
 
+# **delete_document**
+> DocumentResponse delete_document(document_idopts)
+
+Deleting a document
+
+Deletes a single document by the Document ID
+
+### Example
+```ruby
+# load the gem
+require 'transferzero-sdk'
+
+api_instance = TransferZero::DocumentsApi.new
+
+opts = { 
+  sender_id: 'sender_id_example' # String | Allows filtering results by `sender_id`.  Example: `/v1/transactions?sender_id=b41d3cb7-6c54-4245-85fc-8e30690eb0f7`
+}
+
+begin
+  #Deleting a document
+  result = api_instance.delete_document(document_idopts)
+  p result
+rescue TransferZero::ApiError => e
+  if e.validation_error
+    puts "WARN: Validation error occured when calling the endpoint"
+    result = e.response_object("DocumentResponse")
+    p result
+  else
+    puts "Exception when calling DocumentsApi->delete_document: #{e}"
+  end
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **document_id** | [**String**](.md)| ID of the document to delete.  Example: `/v1/document/bf9ff782-e182-45ac-abea-5bce83ad6670` | 
+ **sender_id** | **String**| Allows filtering results by `sender_id`.  Example: `/v1/transactions?sender_id=b41d3cb7-6c54-4245-85fc-8e30690eb0f7` | [optional] 
+
+### Return type
+
+[**DocumentResponse**](DocumentResponse.md)
+
+### Authorization
+
+You can set the API Key and Secret on the TransferZero object when setting it up:
+
+```ruby
+
+TransferZero.configure do |config|
+  config.api_key = '<key'
+  config.api_secret = '<secret>'
+  config.host = 'https://api-sandbox.transferzero.com/v1'
+end
+
+```
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
 # **get_document**
-> DocumentResponse get_document(document_id)
+> DocumentResponse get_document(document_idopts)
 
 Fetching a document
 
@@ -23,10 +89,13 @@ require 'transferzero-sdk'
 
 api_instance = TransferZero::DocumentsApi.new
 
+opts = { 
+  sender_id: 'sender_id_example' # String | Allows filtering results by `sender_id`.  Example: `/v1/transactions?sender_id=b41d3cb7-6c54-4245-85fc-8e30690eb0f7`
+}
 
 begin
   #Fetching a document
-  result = api_instance.get_document(document_id)
+  result = api_instance.get_document(document_idopts)
   p result
 rescue TransferZero::ApiError => e
   if e.validation_error
@@ -44,6 +113,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **document_id** | [**String**](.md)| ID of the document to get.  Example: &#x60;/v1/documents/bf9ff782-e182-45ac-abea-5bce83ad6670&#x60; | 
+ **sender_id** | **String**| Allows filtering results by &#x60;sender_id&#x60;.  Example: &#x60;/v1/transactions?sender_id&#x3D;b41d3cb7-6c54-4245-85fc-8e30690eb0f7&#x60; | [optional] 
 
 ### Return type
 
@@ -87,6 +157,7 @@ api_instance = TransferZero::DocumentsApi.new
 opts = { 
   page: 1 # Integer | The page number to request (defaults to 1)
   per: 10 # Integer | The number of results to load per page (defaults to 10)
+  sender_id: 'sender_id_example' # String | Allows filtering results by `sender_id`.  Example: `/v1/transactions?sender_id=b41d3cb7-6c54-4245-85fc-8e30690eb0f7`
 }
 
 begin
@@ -110,6 +181,7 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **page** | **Integer**| The page number to request (defaults to 1) | [optional] 
  **per** | **Integer**| The number of results to load per page (defaults to 10) | [optional] 
+ **sender_id** | **String**| Allows filtering results by &#x60;sender_id&#x60;.  Example: &#x60;/v1/transactions?sender_id&#x3D;b41d3cb7-6c54-4245-85fc-8e30690eb0f7&#x60; | [optional] 
 
 ### Return type
 

data/docs/PayinMethod.md

@@ -4,11 +4,11 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**type** | **String** | Describes how the payment should be requested from the user.  Possible values: - `NGN::Bank`: NGN card collection requests - `GHS::Mobile`: GHS mobile collections - `TZS::Mobile`: TZS mobile collections - `UGX::Mobile`: UGX mobile collections  | [optional] 
+**type** | **String** | Describes how the payment should be requested from the user.  Possible values: - `NGN::Bank`: NGN bank and card collection requests - `NGN::Mobile`: NGN mobile collections - `GHS::Mobile`: GHS mobile collections - `TZS::Mobile`: TZS mobile collections - `UGX::Mobile`: UGX mobile collections - `EUR::Bank`: EUR IBAN collections - `GBP::Bank`: GBP IBAN collections  | [optional] 
 **in_details** | [**PayinMethodDetails**](PayinMethodDetails.md) |  | [optional] 
-**out_details** | [**Object**](.md) | This will contain the description on where to pay the funds. Please see the [Collections from Senders](https://github.com/transferzero/api-documentation/blob/master/additional-features.md#collections-from-senders) in the API documentation on what to expect here. | [optional] 
-**instructions** | [**Object**](.md) | This will contain the instructions on how to pay the funds. Please see the [Collections from Senders](https://github.com/transferzero/api-documentation/blob/master/additional-features.md#collections-from-senders) in the API documentation on what to expect here. | [optional] 
-**provider** | **String** | Describes which provider to use for collection. Please see the [Collections from Senders](https://github.com/transferzero/api-documentation/blob/master/additional-features.md#collections-from-senders) in the API documentation on the valid values | [optional] 
+**out_details** | [**Object**](.md) | This will contain the description on where to pay the funds. Please see the [Collections Details](https://docs.transferzero.com/docs/collection-details) in the API documentation on what to expect here. | [optional] 
+**instructions** | [**Object**](.md) | This will contain the instructions on how to pay the funds. Please see the [Collections Details](https://docs.transferzero.com/docs/collection-details) in the API documentation on what to expect here. | [optional] 
+**provider** | **String** | Describes which provider to use for collection. Please see the [Collections Details](https://docs.transferzero.com/docs/collection-details) in the API documentation on the valid values | [optional] 
 
 ## Code Sample
 

data/docs/PayinMethodDetails.md

@@ -4,7 +4,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**redirect_url** | **String** | This is where the user should be redirected back when the payment has been finished | 
+**payment_method** | **String** | The payment method which the user will use to make the payments. Options are `bank`, `card` or you can leave empty to support both. | [optional] 
+**redirect_url** | **String** | This is where the user should be redirected back when the payment has been finished | [optional] 
 **phone_number** | **String** | The phone number where the funds should be collected from | 
 **send_instructions** | **Boolean** | States whether to send out the instructions to the phone number on how to pay the funds or not. This shuold always be set to true, otherwise the sender might not receive a prompt for payment. | [optional] 
 
@@ -13,7 +14,8 @@ Name | Type | Description | Notes
 ```ruby
 require 'TransferZero'
 
-instance = TransferZero::PayinMethodDetails.new(redirect_url: null,
+instance = TransferZero::PayinMethodDetails.new(payment_method: null,
+                                 redirect_url: null,
                                  phone_number: +2569999999,
                                  send_instructions: true)
 ```

data/docs/PayinMethodDetailsNGNBank.md

@@ -4,14 +4,16 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**redirect_url** | **String** | This is where the user should be redirected back when the payment has been finished | 
+**payment_method** | **String** | The payment method which the user will use to make the payments. Options are `bank`, `card` or you can leave empty to support both. | [optional] 
+**redirect_url** | **String** | This is where the user should be redirected back when the payment has been finished | [optional] 
 
 ## Code Sample
 
 ```ruby
 require 'TransferZero'
 
-instance = TransferZero::PayinMethodDetailsNGNBank.new(redirect_url: null)
+instance = TransferZero::PayinMethodDetailsNGNBank.new(payment_method: null,
+                                 redirect_url: null)
 ```
 
 

data/docs/PayoutMethod.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**type** | **String** | Contains the currency to send the money to, and the type of the money movement  Commonly used payout types are:  - `NGN::Bank` - for Nigerian bank account payments. - `NGN::Mobile` - for Nigerian mobile money payments. - `GHS::Bank` - for Ghanaian bank account payments. - `GHS::Mobile` - for Ghanaian mobile money payments. - `UGX::Mobile` - for Ugandan mobile money payments. - `TZS::Mobile` - for Tanzanian mobile money payments. - `XOF::Mobile` - for Senegalese mobile money payments. - `XOF::Bank` - for Senegalese bank account payments. *** Currently in Beta phase *** - `XOF::Cash` - for Senegalese cash remittance payments. - `MAD::Cash` - for Moroccan cash remittance payments. - `EUR::Bank` - for IBAN bank transfers in EUR. - `GBP::Bank` - for IBAN bank transfers in GBP.  You can also send funds to the internal balance using `CCY::Balance`, where `CCY` is the appropriate currency. See [Collection from senders](https://github.com/transferzero/api-documentation/blob/master/additional-features.md#collections-from-senders) for more info on how to collect money into internal balance  | [optional] 
+**type** | **String** | Contains the currency to send the money to, and the type of the money movement  Commonly used payout types are:  - `NGN::Bank` - for Nigerian bank account payments. - `NGN::Mobile` - for Nigerian mobile money payments. - `GHS::Bank` - for Ghanaian bank account payments. - `GHS::Mobile` - for Ghanaian mobile money payments. - `UGX::Mobile` - for Ugandan mobile money payments. - `TZS::Mobile` - for Tanzanian mobile money payments. - `XOF::Mobile` - for Senegalese mobile money payments. - `XOF::Bank` - for Senegalese bank account payments. *** Currently in Beta phase *** - `XOF::Cash` - for Senegalese cash remittance payments. - `MAD::Cash` - for Moroccan cash remittance payments. - `EUR::Bank` - for IBAN bank transfers in EUR. - `GBP::Bank` - for IBAN bank transfers in GBP.  You can also send funds to the internal balance using `CCY::Balance`, where `CCY` is the appropriate currency. See [Collection from senders](https://docs.transferzero.com/docs/additional-features/#collections-from-senders) for more info on how to collect money into internal balance  | [optional] 
 **details** | [**PayoutMethodDetails**](PayoutMethodDetails.md) |  | [optional] 
 **metadata** | [**Object**](.md) | Metadata of payout method. You can store any kind of information in this field. | [optional] 
 **id** | **String** |  | [optional] 

data/docs/RecipientsApi.md

@@ -91,7 +91,7 @@ opts = {
   created_at_to: 'created_at_to_example' # String | End date to filter recipients by created_at range Allows filtering results by the specified `created_at` timeframe.  Example: `/v1/recipients?created_at_from=2018-06-06&created_at_to=2018-06-08`
   amount_from: 'amount_from_example' # String | Minimum amount to filter recipients by amount range.  Allows filtering results by the specified `amount` range. When using this filter, the `currency` should also be specified.  Example: `/v1/recipients?currency=NGN&amount_from=83.76672339&amount_to=83.76672339`
   amount_to: 'amount_to_example' # String | Max amount to filter recipients by amount range.  Allows filtering results by the specified `amount` range. When using this filter, the `currency` should also be specified.  Example: `/v1/recipients?currency=NGN&amount_from=83.76672339&amount_to=83.76672339`
-  state: ['state_example'] # Array<String> | Allows filtering results by `state` of recipient. See [API Documentation - Recipient state](https://github.com/transferzero/api-documentation/blob/master/transaction-flow.md#state-1) for possible states.  Example: `/v1/recipients?state[]=error&state[]=initial`
+  state: ['state_example'] # Array<String> | Allows filtering results by `state` of recipient. See [API Documentation - Recipient state](https://docs.transferzero.com/docs/transaction-flow/#state) for possible states.  Example: `/v1/recipients?state[]=error&state[]=initial`
   currency: ['currency_example'] # Array<String> | Allows filtering results by `input_currency`.  Additionally required when filtering by an amount range Example: `/v1/recipients?currency[]=KES&currency[]=NGN`
 }
 
@@ -120,7 +120,7 @@ Name | Type | Description  | Notes
  **created_at_to** | **String**| End date to filter recipients by created_at range Allows filtering results by the specified &#x60;created_at&#x60; timeframe.  Example: &#x60;/v1/recipients?created_at_from&#x3D;2018-06-06&amp;created_at_to&#x3D;2018-06-08&#x60; | [optional] 
  **amount_from** | **String**| Minimum amount to filter recipients by amount range.  Allows filtering results by the specified &#x60;amount&#x60; range. When using this filter, the &#x60;currency&#x60; should also be specified.  Example: &#x60;/v1/recipients?currency&#x3D;NGN&amp;amount_from&#x3D;83.76672339&amp;amount_to&#x3D;83.76672339&#x60; | [optional] 
  **amount_to** | **String**| Max amount to filter recipients by amount range.  Allows filtering results by the specified &#x60;amount&#x60; range. When using this filter, the &#x60;currency&#x60; should also be specified.  Example: &#x60;/v1/recipients?currency&#x3D;NGN&amp;amount_from&#x3D;83.76672339&amp;amount_to&#x3D;83.76672339&#x60; | [optional] 
- **state** | [**Array&lt;String&gt;**](String.md)| Allows filtering results by &#x60;state&#x60; of recipient. See [API Documentation - Recipient state](https://github.com/transferzero/api-documentation/blob/master/transaction-flow.md#state-1) for possible states.  Example: &#x60;/v1/recipients?state[]&#x3D;error&amp;state[]&#x3D;initial&#x60; | [optional] 
+ **state** | [**Array&lt;String&gt;**](String.md)| Allows filtering results by &#x60;state&#x60; of recipient. See [API Documentation - Recipient state](https://docs.transferzero.com/docs/transaction-flow/#state) for possible states.  Example: &#x60;/v1/recipients?state[]&#x3D;error&amp;state[]&#x3D;initial&#x60; | [optional] 
  **currency** | [**Array&lt;String&gt;**](String.md)| Allows filtering results by &#x60;input_currency&#x60;.  Additionally required when filtering by an amount range Example: &#x60;/v1/recipients?currency[]&#x3D;KES&amp;currency[]&#x3D;NGN&#x60; | [optional] 
 
 ### Return type

data/docs/Transaction.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **input_currency** | **String** | The input currency describes what currency the transaction will be paid in (3-character alpha ISO 4217 currency format). For example if you wish to create an EUR to NGN transaction then input currency should be set to EUR. | 
-**payin_methods** | [**Array<PayinMethod>**](PayinMethod.md) | Allows setting alternative collections, where funding the transaction is done through alternative means and not via account balance.  For more information please see [Collections from senders](https://github.com/transferzero/api-documentation/blob/master/additional-features.md#collections-from-senders) in the API documentation | [optional] 
+**payin_methods** | [**Array<PayinMethod>**](PayinMethod.md) | Allows setting alternative collections, where funding the transaction is done through alternative means and not via account balance.  For more information please see [Collections from senders](https://docs.transferzero.com/docs/additional-features/#collections-from-senders) in the API documentation | [optional] 
 **metadata** | [**Object**](.md) | Additional metadata to store on the transaction. If you widh to store your local transaction ID, you should add it here inside a `sendRef` field, and we will return this value back to you in the daily transaction reports. | [optional] 
 **sender** | [**Sender**](Sender.md) |  | 
 **recipients** | [**Array<Recipient>**](Recipient.md) | The details of where the payment should go. although transactions can support paying out multiple recipients, usually one is provided.  | 

data/docs/TransactionTraits.md

@@ -4,8 +4,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**auto_refund** | **Boolean** | Enables or disables the auto refund functionality. Please see [Auto cancellation and refund of transactions](https://github.com/transferzero/api-documentation/blob/master/additional-features.md#auto-cancellation-and-refund-of-transactions) for more details | [optional] 
-**account_validation** | **Boolean** | Enabled or disables the name validation functionality. Please see [Name validation in transactions](https://github.com/transferzero/api-documentation/blob/master/additional-features.md#name-validation-in-transactions) for more details | [optional] 
+**auto_refund** | **Boolean** | Enables or disables the auto refund functionality. Please see [Auto cancellation and refund of transactions](https://docs.transferzero.com/docs/additional-features/#auto-cancellation-and-refund-of-transactions) for more details | [optional] 
+**account_validation** | **Boolean** | Enabled or disables the name validation functionality. Please see [Name validation in transactions](https://docs.transferzero.com/docs/additional-features/#name-validation-in-transactions) for more details | [optional] 
 
 ## Code Sample
 

data/example/client.rb

@@ -15,7 +15,7 @@ credentials = {
     host: "https://api-sandbox.transferzero.com/v1"
 }
 
-# Please see our documentation at https://github.com/transferzero/api-documentation
+# Please see our documentation at https://docs.transferzero.com
 # and the API specification at http://api.transferzero.com/documentation/
 # for more information.
 
@@ -39,7 +39,7 @@ class Client
   end
 
   def account_validation_example
-    # See https://github.com/transferzero/api-documentation/blob/master/additional-features.md#bank-account-name-enquiry
+    # See https://docs.transferzero.com/docs/additional-features/#bank-account-name-enquiry
     # for more information on how this feature can be used
     begin
       request = TransferZero::AccountValidationRequest.new
@@ -63,7 +63,7 @@ class Client
   end
 
   def create_sender_example
-    # For more details on senders please check https://github.com/transferzero/api-documentation/blob/master/transaction-flow.md#sender
+    # For more details on senders please check https://docs.transferzero.com/docs/transaction-flow/#sender
     begin
       api = TransferZero::SendersApi.new
       sender = TransferZero::Sender.new
@@ -98,7 +98,7 @@ class Client
   end
 
   def get_sender_by_external_id_example
-    # Find more details on external IDs at https://github.com/transferzero/api-documentation/blob/master/transaction-flow.md#external-id
+    # Find more details on external IDs at https://docs.transferzero.com/docs/transaction-flow/#external-id
     begin
       opts = { external_id: 'SENDER-2b59def0' }
       sender = TransferZero::SendersApi.new
@@ -113,7 +113,7 @@ class Client
   end
 
   def update_sender_example
-    # For more details on senders please check https://github.com/transferzero/api-documentation/blob/master/transaction-flow.md#sender
+    # For more details on senders please check https://docs.transferzero.com/docs/transaction-flow/#sender
     begin
       api = TransferZero::SendersApi.new
       sender = TransferZero::Sender.new
@@ -135,15 +135,15 @@ class Client
     begin
       api = TransferZero::TransactionsApi.new
       transaction = TransferZero::Transaction.new
-      # Please check our documentation at https://github.com/transferzero/api-documentation/blob/master/transaction-flow.md
+      # Please check our documentation at https://docs.transferzero.com/docs/transaction-flow/
       # for details on how transactions work.
 
       sender = TransferZero::Sender.new
       # When adding a sender to transaction, please use either an id or external_id. Providing both will result in a validation error.
-      # Please see our documentation at https://github.com/transferzero/api-documentation/blob/master/transaction-flow.md#sender
+      # Please see our documentation at https://docs.transferzero.com/docs/transaction-flow/#sender
       sender.id = 'ec33484c-4456-4625-a823-9704a3a54e68'
 
-      # You can find the various payout options at https://github.com/transferzero/api-documentation/blob/master/transaction-flow.md#payout-details
+      # You can find the various payout options at https://docs.transferzero.com/docs/transaction-flow/#payout-details
       ngn_bank_details = TransferZero::PayoutMethodDetails.new
       ngn_bank_details.bank_account = '123456789'
       ngn_bank_details.bank_account_type = TransferZero::PayoutMethodBankAccountTypeEnum::N20
@@ -155,17 +155,17 @@ class Client
       payout_method.type = 'NGN::Bank'
       payout_method.details = ngn_bank_details
 
-      # Please see https://github.com/transferzero/api-documentation/blob/master/transaction-flow.md#requested-amount-and-currency
+      # Please see https://docs.transferzero.com/docs/transaction-flow/#requested-amount-and-currency
       # on what the request amount and currencies do
       recipient = TransferZero::Recipient.new
       recipient.requested_amount = 10000
       recipient.requested_currency = 'NGN'
       recipient.payout_method = payout_method
 
-      # Similarly you can check https://github.com/transferzero/api-documentation/blob/master/transaction-flow.md#requested-amount-and-currency
+      # Similarly you can check https://docs.transferzero.com/docs/transaction-flow/#requested-amount-and-currency
       # on details about the input currency parameter
 
-      # Find more details on external IDs at https://github.com/transferzero/api-documentation/blob/master/transaction-flow.md#external-id
+      # Find more details on external IDs at https://docs.transferzero.com/docs/transaction-flow/#external-id
       transaction.external_id = 'TRANSACTION-1f834add' # Optional field for customer's ID
       transaction.input_currency = 'GBP'
       transaction.sender = sender
@@ -188,7 +188,7 @@ class Client
   end
 
   def get_transaction_by_external_id_example
-    # Please see https://github.com/transferzero/api-documentation/blob/master/transaction-flow.md#external-id
+    # Please see https://docs.transferzero.com/docs/transaction-flow/#external-id
     # for more details on external IDs
     begin
       opts = { external_id: 'TRANSACTION-1f834add' }
@@ -208,7 +208,7 @@ class Client
     if transaction_id.nil?
       puts "Transaction with ID #{transaction_id} does not exist"
     else
-      # Please see https://github.com/transferzero/api-documentation/blob/master/transaction-flow.md#funding-transactions
+      # Please see https://docs.transferzero.com/docs/transaction-flow/#funding-transactions
       # on details about funding transactions
       debit = TransferZero::Debit.new
       debit.currency = 'GBP'
@@ -235,7 +235,7 @@ class Client
   end
 
   def webhook_parse_example
-    # Please see https://github.com/transferzero/api-documentation#webhooks
+    # Please see https://docs.transferzero.com#webhooks
     # for more details about how webhooks / callbacks work from our system
     headers = {
       "Authorization-Nonce": "<authorization-nonce>",