transferzero-sdk 1.3.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec7ad9295e642f964d1fd79f4dc572929b15e8a09611c5b3b427ca018c45cd38
-  data.tar.gz: ce7e8272987b6b48cf9374784cfec071df90f71b2db7daccb1526d90179f46c2
+  metadata.gz: c274d3c1799100cc96b0948c818a02e02ade91172cd7b4525c75a9242852d687
+  data.tar.gz: 7746ed2b6081cf788d8a3894ba3f0ccb4b4bfde981ecc9bfeecc8e11f229cc19
 SHA512:
-  metadata.gz: 20e6b03b1ed61397bed75c3a7de9a887fb3dc9a40a594c8ba22bad1a9c6728ac68abfb0e12eccb6b09089047a44e859b212a4dbf8e477d4ab33180cc4e7578a6
-  data.tar.gz: 27a877b021b92d6e45eec0bb90ac34ed37a7bbae0a08d19d984108bd60163a6fc39ed1cff9daf524cb096af6789334e52717f4f6b0d743ebaba2633a943105cd
+  metadata.gz: 7506bb914ebae11b793ac2d3a3e57b08c40d8559bf8d51a49cce4b9a281766a29b92a85be9edf8b1fbad2ff5e62e9e9ae2dde355587d9b4d1a4e1d43017dc417
+  data.tar.gz: 85e630486a5f4aa75d1b19de7ba6f57555ddc56947a6a6f178d11a157aee16138b3967df352b91a6d67b6d4fbc7cbd4d499a04221cd00d16145e47569dc629e2

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.3.0
+- Package version: 1.8.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,21 +31,21 @@ gem build transferzero-sdk.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./transferzero-sdk-1.3.0.gem
+gem install ./transferzero-sdk-1.8.0.gem
 ```
-(for development, run `gem install --dev ./transferzero-sdk-1.3.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./transferzero-sdk-1.8.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.3.0'
+    gem 'transferzero-sdk', '~> 1.8.0'
 
 ### Install from Git
 
-If the Ruby gem is hosted at a git repository: https://github.com/transferzero/transferzero-ruby-sdk, then add the following in the Gemfile:
+If the Ruby gem is hosted at a git repository: https://github.com/transferzero/transferzero-sdk-ruby, then add the following in the Gemfile:
 
-    gem 'transferzero-sdk', :git => 'https://github.com/transferzero/transferzero-ruby-sdk.git'
+    gem 'transferzero-sdk', :git => 'https://github.com/transferzero/transferzero-sdk-ruby.git'
 
 ### Include the Ruby code directly
 
@@ -109,12 +109,13 @@ Class | Method | HTTP request | Description
 *TransferZero::AccountDebitsApi* | [**get_accounts_debit**](docs/AccountDebitsApi.md#get_accounts_debit) | **GET** /accounts/debits/{Account Debit ID} | Fetching an account debit
 *TransferZero::AccountDebitsApi* | [**get_accounts_debits**](docs/AccountDebitsApi.md#get_accounts_debits) | **GET** /accounts/debits | Listing Accounts debits
 *TransferZero::AccountDebitsApi* | [**post_accounts_debits**](docs/AccountDebitsApi.md#post_accounts_debits) | **POST** /accounts/debits | Creating an account debit
-*TransferZero::AccountValidationApi* | [**post_account_validations**](docs/AccountValidationApi.md#post_account_validations) | **POST** /account_validations | Validates the existence of a bank account
+*TransferZero::AccountValidationApi* | [**post_account_validations**](docs/AccountValidationApi.md#post_account_validations) | **POST** /account_validations | Validates the existence of a bank account or a mobile phone number
 *TransferZero::AccountsApi* | [**get_account**](docs/AccountsApi.md#get_account) | **GET** /accounts/{Currency} | Fetches account balance for specified currrency
 *TransferZero::AccountsApi* | [**get_accounts**](docs/AccountsApi.md#get_accounts) | **GET** /accounts | Fetches account balances for all currencies
 *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
@@ -136,6 +137,7 @@ Class | Method | HTTP request | Description
 *TransferZero::SendersApi* | [**patch_sender**](docs/SendersApi.md#patch_sender) | **PATCH** /senders/{Sender ID} | Updating a sender
 *TransferZero::SendersApi* | [**post_senders**](docs/SendersApi.md#post_senders) | **POST** /senders | Creating a sender
 *TransferZero::TransactionsApi* | [**calculate_transactions**](docs/TransactionsApi.md#calculate_transactions) | **POST** /transactions/calculate | Calculates transaction amounts for a transaction payload
+*TransferZero::TransactionsApi* | [**create_and_fund_transaction**](docs/TransactionsApi.md#create_and_fund_transaction) | **POST** /transactions/create_and_fund | Creates a new transaction and funds it from account balance
 *TransferZero::TransactionsApi* | [**get_transaction**](docs/TransactionsApi.md#get_transaction) | **GET** /transactions/{Transaction ID} | Fetch a single transaction
 *TransferZero::TransactionsApi* | [**get_transactions**](docs/TransactionsApi.md#get_transactions) | **GET** /transactions | Get a list of transactions
 *TransferZero::TransactionsApi* | [**payin_transaction**](docs/TransactionsApi.md#payin_transaction) | **POST** /transactions/{Transaction ID}/payin | Creates a fake payin for transaction
@@ -164,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)
@@ -180,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)
@@ -204,6 +203,7 @@ Class | Method | HTTP request | Description
  - [TransferZero::PayoutMethodDetailsMADCash](docs/PayoutMethodDetailsMADCash.md)
  - [TransferZero::PayoutMethodDetailsMobile](docs/PayoutMethodDetailsMobile.md)
  - [TransferZero::PayoutMethodDetailsNGNBank](docs/PayoutMethodDetailsNGNBank.md)
+ - [TransferZero::PayoutMethodDetailsXOFBank](docs/PayoutMethodDetailsXOFBank.md)
  - [TransferZero::PayoutMethodDetailsXOFMobile](docs/PayoutMethodDetailsXOFMobile.md)
  - [TransferZero::PayoutMethodGenderEnum](docs/PayoutMethodGenderEnum.md)
  - [TransferZero::PayoutMethodIdentityCardTypeEnum](docs/PayoutMethodIdentityCardTypeEnum.md)
@@ -212,14 +212,13 @@ 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::PoliticallyExposedPerson](docs/PoliticallyExposedPerson.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)
@@ -228,7 +227,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)
@@ -238,7 +236,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/AccountMeta.md

@@ -11,7 +11,7 @@ Name | Type | Description | Notes
 ```ruby
 require 'TransferZero'
 
-instance = TransferZero::AccountMeta.new(negative_balance: false)
+instance = TransferZero::AccountMeta.new(negative_balance: null)
 ```
 
 

data/docs/AccountValidationApi.md

@@ -4,15 +4,15 @@ All URIs are relative to *https://api-sandbox.transferzero.com/v1*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**post_account_validations**](AccountValidationApi.md#post_account_validations) | **POST** /account_validations | Validates the existence of a bank account
+[**post_account_validations**](AccountValidationApi.md#post_account_validations) | **POST** /account_validations | Validates the existence of a bank account or a mobile phone number
 
 
 # **post_account_validations**
 > AccountValidationResponse post_account_validations(account_validation_request)
 
-Validates the existence of a bank account
+Validates the existence of a bank account or a mobile phone number
 
-Validates the existence of a bank account and returns the associated customer name
+Validates the existence of a bank account or mobile phone number and returns the associated customer name
 
 ### Example
 ```ruby
@@ -23,7 +23,7 @@ api_instance = TransferZero::AccountValidationApi.new
 
 
 begin
-  #Validates the existence of a bank account
+  #Validates the existence of a bank account or a mobile phone number
   result = api_instance.post_account_validations(account_validation_request)
   p result
 rescue TransferZero::ApiError => e

data/docs/AccountValidationRequest.md

@@ -4,11 +4,12 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**bank_account** | **String** | Account Number to query | 
-**bank_code** | **String** | Bank Code to query - same codes are used as for creating the transactions | 
-**country** | **String** | Country of account in 2-character alpha ISO 3166-2 country format (only NG is currently supported) | 
+**bank_account** | **String** | Account Number to query | [optional] 
+**bank_code** | **String** | Bank Code to query - same codes are used as for creating the transactions | [optional] 
+**phone_number** | **String** | Phone number to query | [optional] 
+**country** | **String** | Country of account in 2-character alpha ISO 3166-2 country format | 
 **currency** | **String** | The currency the bank account is in | 
-**method** | **String** | The method of the payment. Currently only bank is supported | 
+**method** | **String** | The method of the payment. Currently bank and mobile are supported | 
 
 ## Code Sample
 
@@ -17,6 +18,7 @@ require 'TransferZero'
 
 instance = TransferZero::AccountValidationRequest.new(bank_account: null,
                                  bank_code: null,
+                                 phone_number: +233000000000,
                                  country: null,
                                  currency: null,
                                  method: null)

data/docs/Currency.md

@@ -25,7 +25,7 @@ instance = TransferZero::Currency.new(code: NGN,
                                  symbol: ₦,
                                  decimals: 2,
                                  subunit_to_unit: 100,
-                                 primary: true,
+                                 primary: null,
                                  min: 100,
                                  max: 50000000,
                                  margin: null,

data/docs/CurrencyExchange.md

@@ -26,7 +26,7 @@ instance = TransferZero::CurrencyExchange.new(code: NGN,
                                  symbol: ₦,
                                  decimals: 2,
                                  subunit_to_unit: 100,
-                                 primary: true,
+                                 primary: null,
                                  min: 100,
                                  max: 50000000,
                                  margin: null,

data/docs/CurrencyOpposite.md

@@ -27,7 +27,7 @@ instance = TransferZero::CurrencyOpposite.new(code: NGN,
                                  symbol: ₦,
                                  decimals: 2,
                                  subunit_to_unit: 100,
-                                 primary: true,
+                                 primary: null,
                                  min: 100,
                                  max: 50000000,
                                  margin: null,

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/FieldSelectValidation.md

@@ -13,7 +13,7 @@ Name | Type | Description | Notes
 require 'TransferZero'
 
 instance = TransferZero::FieldSelectValidation.new(_in: {"20":"Current","10":"Savings"},
-                                 allow_blank: false)
+                                 allow_blank: null)
 ```
 
 

data/docs/FieldValidation.md

@@ -13,7 +13,7 @@ Name | Type | Description | Notes
 ```ruby
 require 'TransferZero'
 
-instance = TransferZero::FieldValidation.new(presence: true,
+instance = TransferZero::FieldValidation.new(presence: null,
                                  inclusion: null,
                                  format: {"with":"(?-mix:\\A\\d+\\z)"})
 ```

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,9 +14,10 @@ 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)
+                                 send_instructions: null)
 ```
 
 

data/docs/PayinMethodDetailsMobile.md

@@ -13,7 +13,7 @@ Name | Type | Description | Notes
 require 'TransferZero'
 
 instance = TransferZero::PayinMethodDetailsMobile.new(phone_number: +2569999999,
-                                 send_instructions: true)
+                                 send_instructions: null)
 ```