transferzero-sdk 1.18.0 → 1.19.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 474d2e8b413915921b190203849a12f46f3c9cc295868549fa26fb289195f14d
-  data.tar.gz: bebd2cd67ffd96cf63dcc64dea2554ab8127b77878d3cb6e7ba6077b20f1d8a1
+  metadata.gz: '0812c5257c325705bfa9e2432f72cf21ca96f5d24069586b24671e5194a1c250'
+  data.tar.gz: d18bed4cc5d05afe7307b2bb200d36399cd16ec835e00c7ece7d0c8845449ab3
 SHA512:
-  metadata.gz: cfe419596593cb1151d38376202a2acc60e041c69f32d66df49fccd00fc5ce2aee0110edbd4660f60806504db1e96013e1d42fbd802cd1c4794e462777a27e54
-  data.tar.gz: f97e85c959a7e03d3c8e98ba259111654b3aa344b1d2ad6c4c47b6657e920277dfb0eaa077826b7de34d185112aad51aa5ba2ce13990255ec65e846ea618f4d8
+  metadata.gz: e64cc5a2e82023fd5dc29010c7b89df1beeac80cd0375f426389619c775b654b4d0db9e23595dbf7a6fe790c30da94dea11a6f48f098abbbbb120753214e0d97
+  data.tar.gz: a171d6704db8e11b503df0ec67409eafcddff3140bf2b455aa2f0718b61732d6405da0e16503c9c62e3b2229f99e70a8ba02f4839264228a3bc150fc3be035aa

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    transferzero-sdk (1.16.0)
+    transferzero-sdk (1.11.0)
       activesupport (>= 4)
       json (>= 1.4)
       typhoeus (~> 1.0, >= 1.0.1)
@@ -10,7 +10,7 @@ GEM
   remote: https://rubygems.org/
   specs:
     ZenTest (4.12.0)
-    activesupport (6.1.4.1)
+    activesupport (6.1.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -20,23 +20,24 @@ GEM
       public_suffix (>= 2.0.2, < 5.0)
     autotest (4.4.6)
       ZenTest (>= 4.4.1)
+    autotest-fsevent (0.2.17)
+      sys-uname
     autotest-growl (0.2.16)
     autotest-rails-pure (4.1.2)
     byebug (11.1.3)
     coderay (1.1.3)
-    concurrent-ruby (1.1.9)
-    crack (0.4.5)
-      rexml
+    concurrent-ruby (1.1.8)
+    crack (0.4.4)
     diff-lcs (1.4.4)
-    ethon (0.14.0)
-      ffi (>= 1.15.0)
-    ffi (1.15.4)
+    ethon (0.12.0)
+      ffi (>= 1.3.0)
+    ffi (1.13.1)
     hashdiff (1.0.1)
-    i18n (1.8.10)
+    i18n (1.8.9)
       concurrent-ruby (~> 1.0)
     json (2.5.1)
     method_source (1.0.0)
-    minitest (5.14.4)
+    minitest (5.14.3)
     pry (0.13.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
@@ -45,20 +46,21 @@ GEM
       pry (~> 0.13.0)
     public_suffix (4.0.6)
     rake (12.0.0)
-    rexml (3.2.4)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
       rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
+    rspec-core (3.10.0)
       rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
+    rspec-expectations (3.10.0)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.1)
+    rspec-mocks (3.10.0)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
-    rspec-support (3.10.1)
+    rspec-support (3.10.0)
+    sys-uname (1.2.2)
+      ffi (~> 1.1)
     typhoeus (1.4.0)
       ethon (>= 0.9.0)
     tzinfo (2.0.4)
@@ -76,6 +78,7 @@ PLATFORMS
 DEPENDENCIES
   ZenTest (~> 4.11, >= 4.11.2)
   autotest (~> 4.4, >= 4.4.6)
+  autotest-fsevent (~> 0.2, >= 0.2.12)
   autotest-growl (~> 0.2, >= 0.2.16)
   autotest-rails-pure (~> 4.1, >= 4.1.2)
   pry-byebug
@@ -86,4 +89,4 @@ DEPENDENCIES
   webmock (~> 1.24, >= 1.24.3)
 
 BUNDLED WITH
-   2.1.4
+   1.17.3

data/README.md

@@ -7,7 +7,7 @@ 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.18.0
+- Package version: 1.19.2
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 
 For more information, please visit:
@@ -31,15 +31,15 @@ gem build transferzero-sdk.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./transferzero-sdk-1.18.0.gem
+gem install ./transferzero-sdk-1.19.2.gem
 ```
-(for development, run `gem install --dev ./transferzero-sdk-1.18.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./transferzero-sdk-1.19.2.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.18.0'
+    gem 'transferzero-sdk', '~> 1.19.2'
 
 ### Install from Git
 
@@ -120,6 +120,10 @@ Class | Method | HTTP request | Description
 *TransferZero::DocumentsApi* | [**post_documents**](docs/DocumentsApi.md#post_documents) | **POST** /documents | Creating a document
 *TransferZero::LogsApi* | [**get_webhook_log**](docs/LogsApi.md#get_webhook_log) | **GET** /logs/{Webhook Log ID} | Fetch an individual webhook log
 *TransferZero::LogsApi* | [**get_webhook_logs**](docs/LogsApi.md#get_webhook_logs) | **GET** /logs/webhooks | Fetch a list of webhook logs
+*TransferZero::PayinMethodsApi* | [**delete_payin_method**](docs/PayinMethodsApi.md#delete_payin_method) | **DELETE** /payin_methods/{PayinMethod ID} | Deleting a payin method
+*TransferZero::PayinMethodsApi* | [**get_payin_method**](docs/PayinMethodsApi.md#get_payin_method) | **GET** /payin_methods/{PayinMethod ID} | Fetching a payin method
+*TransferZero::PayinMethodsApi* | [**patch_payin_method**](docs/PayinMethodsApi.md#patch_payin_method) | **PATCH** /payin_methods/{PayinMethod ID} | Updating a payin method
+*TransferZero::PayinMethodsApi* | [**retry_payin_method**](docs/PayinMethodsApi.md#retry_payin_method) | **POST** /payin_methods/{PayinMethod ID}/retry | Retries PayinMethod
 *TransferZero::PaymentMethodsApi* | [**payment_methods_in**](docs/PaymentMethodsApi.md#payment_methods_in) | **GET** /info/payment_methods/in | This method returns possible payin methods.
 *TransferZero::PaymentMethodsApi* | [**payment_methods_out**](docs/PaymentMethodsApi.md#payment_methods_out) | **GET** /info/payment_methods/out | This method returns possible payout methods.
 *TransferZero::PayoutMethodsApi* | [**delete_payout_method**](docs/PayoutMethodsApi.md#delete_payout_method) | **DELETE** /payout_methods/{Payout Method ID} | Deleting a payout method
@@ -192,6 +196,9 @@ Class | Method | HTTP request | Description
  - [TransferZero::PayinMethodDetailsMobile](docs/PayinMethodDetailsMobile.md)
  - [TransferZero::PayinMethodDetailsNGNBank](docs/PayinMethodDetailsNGNBank.md)
  - [TransferZero::PayinMethodRequest](docs/PayinMethodRequest.md)
+ - [TransferZero::PayinMethodResponse](docs/PayinMethodResponse.md)
+ - [TransferZero::PayinMethodState](docs/PayinMethodState.md)
+ - [TransferZero::PayinMethodUxFlow](docs/PayinMethodUxFlow.md)
  - [TransferZero::PaymentMethod](docs/PaymentMethod.md)
  - [TransferZero::PaymentMethodListResponse](docs/PaymentMethodListResponse.md)
  - [TransferZero::PaymentMethodOpposite](docs/PaymentMethodOpposite.md)
@@ -247,6 +254,7 @@ Class | Method | HTTP request | Description
  - [TransferZero::SenderResponseMeta](docs/SenderResponseMeta.md)
  - [TransferZero::SenderState](docs/SenderState.md)
  - [TransferZero::SenderWebhook](docs/SenderWebhook.md)
+ - [TransferZero::StateReasonDetails](docs/StateReasonDetails.md)
  - [TransferZero::Transaction](docs/Transaction.md)
  - [TransferZero::TransactionListResponse](docs/TransactionListResponse.md)
  - [TransferZero::TransactionRequest](docs/TransactionRequest.md)

data/docs/Document.md

@@ -17,6 +17,7 @@ Name | Type | Description | Notes
 **id** | **String** |  | [optional] 
 **document_id** | **String** | Document ID issued by government | [optional] 
 **expiry_date** | **Date** | Document expiry date issued by government | [optional] 
+**source** | **String** | Determines the document's source. Default value \"Manual\" | [optional] 
 **errors** | **Hash<String, Array<ValidationErrorDescription>>** | The fields that have some problems and don't pass validation | [optional] 
 
 ## Code Sample
@@ -37,6 +38,7 @@ instance = TransferZero::Document.new(upload: data:image/png;base64,iVBORw0KGg..
                                  id: ebe9bc0b-f2f6-4ce8-802a-8b79912d041e,
                                  document_id: XYZ12345,
                                  expiry_date: null,
+                                 source: Manual,
                                  errors: {"phone_number":[{"error":"invalid"}],"documents":[{"error":"blank"}]})
 ```
 

data/docs/PayinMethod.md

@@ -4,22 +4,30 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**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] 
+**type** | **String** | Describes how the payment should be requested from the sender.  Possible values: - `GHS::Mobile`: GHS mobile collections - `UGX::Mobile`: UGX mobile collections - `EUR::Bank`: EUR IBAN collections - `GBP::Bank`: GBP IBAN collections  | [optional] 
+**ux_flow** | [**PayinMethodUxFlow**](PayinMethodUxFlow.md) |  | [optional] 
 **in_details** | [**PayinMethodDetails**](PayinMethodDetails.md) |  | [optional] 
+**id** | **String** |  | [optional] 
+**state** | [**PayinMethodState**](PayinMethodState.md) |  | [optional] 
+**state_reason_details** | [**StateReasonDetails**](StateReasonDetails.md) |  | [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] 
+**errors** | **Hash<String, Array<ValidationErrorDescription>>** | The fields that have some problems and don't pass validation | [optional] 
 
 ## Code Sample
 
 ```ruby
 require 'TransferZero'
 
-instance = TransferZero::PayinMethod.new(type: NGN::Bank,
+instance = TransferZero::PayinMethod.new(type: GHS::Mobile,
+                                 ux_flow: null,
                                  in_details: null,
+                                 id: 97e79719-06e4-4794-aeeb-d2d9415d983a,
+                                 state: null,
+                                 state_reason_details: null,
                                  out_details: null,
                                  instructions: null,
-                                 provider: null)
+                                 errors: {"phone_number":[{"error":"invalid"}],"documents":[{"error":"blank"}]})
 ```
 
 

data/docs/PayinMethodDetails.md

@@ -4,10 +4,11 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**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] 
+**payment_method** | **String** | The payment method which the sender 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 sender should be redirected back when the payment has been finished | [optional] 
+**phone_number** | **String** | The phone number where the funds should be collected from | [optional] 
+**mobile_provider** | [**PayoutMethodMobileProviderEnum**](PayoutMethodMobileProviderEnum.md) |  | [optional] 
+**otp** | **String** | The OTP that the sender received in otp verified ussd popup ux flow. | [optional] 
 **refund_address** | **String** | Please make sure the refund_address is a valid BTC address belonging to the sender, as that is going to be used in case the transaction has to be refunded. | [optional] 
 
 ## Code Sample
@@ -18,7 +19,8 @@ require 'TransferZero'
 instance = TransferZero::PayinMethodDetails.new(payment_method: null,
                                  redirect_url: null,
                                  phone_number: +2569999999,
-                                 send_instructions: true,
+                                 mobile_provider: null,
+                                 otp: null,
                                  refund_address: null)
 ```
 

data/docs/PayinMethodDetailsMobile.md

@@ -4,8 +4,9 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**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] 
+**phone_number** | **String** | The phone number where the funds should be collected from | [optional] 
+**mobile_provider** | [**PayoutMethodMobileProviderEnum**](PayoutMethodMobileProviderEnum.md) |  | [optional] 
+**otp** | **String** | The OTP that the sender received in otp verified ussd popup ux flow. | [optional] 
 
 ## Code Sample
 
@@ -13,7 +14,8 @@ Name | Type | Description | Notes
 require 'TransferZero'
 
 instance = TransferZero::PayinMethodDetailsMobile.new(phone_number: +2569999999,
-                                 send_instructions: true)
+                                 mobile_provider: null,
+                                 otp: null)
 ```
 
 

data/docs/PayinMethodDetailsNGNBank.md

@@ -4,8 +4,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**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] 
+**payment_method** | **String** | The payment method which the sender 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 sender should be redirected back when the payment has been finished | [optional] 
 
 ## Code Sample
 

data/docs/PayinMethodResponse.md

@@ -0,0 +1,17 @@
+# TransferZero::PayinMethodResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**object** | [**PayinMethod**](PayinMethod.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::PayinMethodResponse.new(object: null)
+```
+
+

data/docs/PayinMethodState.md

@@ -0,0 +1,16 @@
+# TransferZero::PayinMethodState
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::PayinMethodState.new()
+```
+
+

data/docs/PayinMethodUxFlow.md

@@ -0,0 +1,16 @@
+# TransferZero::PayinMethodUxFlow
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::PayinMethodUxFlow.new()
+```
+
+

data/docs/PayinMethodsApi.md

@@ -0,0 +1,257 @@
+# TransferZero::PayinMethodsApi
+
+All URIs are relative to *https://api-sandbox.transferzero.com/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**delete_payin_method**](PayinMethodsApi.md#delete_payin_method) | **DELETE** /payin_methods/{PayinMethod ID} | Deleting a payin method
+[**get_payin_method**](PayinMethodsApi.md#get_payin_method) | **GET** /payin_methods/{PayinMethod ID} | Fetching a payin method
+[**patch_payin_method**](PayinMethodsApi.md#patch_payin_method) | **PATCH** /payin_methods/{PayinMethod ID} | Updating a payin method
+[**retry_payin_method**](PayinMethodsApi.md#retry_payin_method) | **POST** /payin_methods/{PayinMethod ID}/retry | Retries PayinMethod
+
+
+# **delete_payin_method**
+> PayinMethodResponse delete_payin_method(payin_method_id)
+
+Deleting a payin method
+
+Initiates a cancellation request for the specified payin method
+
+### Example
+```ruby
+# load the gem
+require 'transferzero-sdk'
+
+api_instance = TransferZero::PayinMethodsApi.new
+
+
+begin
+  #Deleting a payin method
+  result = api_instance.delete_payin_method(payin_method_id)
+  p result
+rescue TransferZero::ApiError => e
+  if e.validation_error
+    puts "WARN: Validation error occured when calling the endpoint"
+    result = e.response_object("PayinMethodResponse")
+    p result
+  else
+    puts "Exception when calling PayinMethodsApi->delete_payin_method: #{e}"
+  end
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **payin_method_id** | [**String**](.md)| ID of the payin method to delete.  Example: `/v1/payin_methods/bf9ff782-e182-45ac-abea-5bce83ad6670` | 
+
+### Return type
+
+[**PayinMethodResponse**](PayinMethodResponse.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_payin_method**
+> PayinMethodResponse get_payin_method(payin_method_id)
+
+Fetching a payin method
+
+Show a payin method by id
+
+### Example
+```ruby
+# load the gem
+require 'transferzero-sdk'
+
+api_instance = TransferZero::PayinMethodsApi.new
+
+
+begin
+  #Fetching a payin method
+  result = api_instance.get_payin_method(payin_method_id)
+  p result
+rescue TransferZero::ApiError => e
+  if e.validation_error
+    puts "WARN: Validation error occured when calling the endpoint"
+    result = e.response_object("PayinMethodResponse")
+    p result
+  else
+    puts "Exception when calling PayinMethodsApi->get_payin_method: #{e}"
+  end
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **payin_method_id** | [**String**](.md)| ID of the payin method to get.  Example: &#x60;/v1/payin_methods/bf9ff782-e182-45ac-abea-5bce83ad6670&#x60; | 
+
+### Return type
+
+[**PayinMethodResponse**](PayinMethodResponse.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
+
+
+
+# **patch_payin_method**
+> PayinMethodResponse patch_payin_method(payin_method_idpayin_method)
+
+Updating a payin method
+
+Updates the payin method specified in the URL path.
+
+### Example
+```ruby
+# load the gem
+require 'transferzero-sdk'
+
+api_instance = TransferZero::PayinMethodsApi.new
+
+
+begin
+  #Updating a payin method
+  result = api_instance.patch_payin_method(payin_method_idpayin_method)
+  p result
+rescue TransferZero::ApiError => e
+  if e.validation_error
+    puts "WARN: Validation error occured when calling the endpoint"
+    result = e.response_object("PayinMethodResponse")
+    p result
+  else
+    puts "Exception when calling PayinMethodsApi->patch_payin_method: #{e}"
+  end
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **payin_method_id** | [**String**](.md)| ID of the payin method to get.  Example: &#x60;/v1/payin_methods/bf9ff782-e182-45ac-abea-5bce83ad6670&#x60; | 
+ **payin_method** | [**PayinMethod**](PayinMethod.md)|  | 
+
+### Return type
+
+[**PayinMethodResponse**](PayinMethodResponse.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**: application/json
+ - **Accept**: application/json
+
+
+
+# **retry_payin_method**
+> PayinMethodResponse retry_payin_method(payin_method_id)
+
+Retries PayinMethod
+
+Retries the collection process for the payin method.  Please note only payin methods in `error` state can be retried.
+
+### Example
+```ruby
+# load the gem
+require 'transferzero-sdk'
+
+api_instance = TransferZero::PayinMethodsApi.new
+
+
+begin
+  #Retries PayinMethod
+  result = api_instance.retry_payin_method(payin_method_id)
+  p result
+rescue TransferZero::ApiError => e
+  if e.validation_error
+    puts "WARN: Validation error occured when calling the endpoint"
+    result = e.response_object("PayinMethodResponse")
+    p result
+  else
+    puts "Exception when calling PayinMethodsApi->retry_payin_method: #{e}"
+  end
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **payin_method_id** | [**String**](.md)| ID of the payin method whose collection process should be retried  Example: &#x60;/v1/payin_methods/9d4d7b73-a94c-4979-ab57-09074fd55d33/retry&#x60; | 
+
+### Return type
+
+[**PayinMethodResponse**](PayinMethodResponse.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
+
+
+

data/docs/PayoutMethodDetails.md

@@ -16,7 +16,7 @@ Name | Type | Description | Notes
 **iban** | **String** |  | 
 **bank_name** | **String** |  | 
 **bank_country** | **String** |  | [optional] 
-**cash_provider** | [**PayoutMethodCashProviderEnum**](PayoutMethodCashProviderEnum.md) |  | [optional] 
+**cash_provider** | [**PayoutMethodCashProviderEnum**](PayoutMethodCashProviderEnum.md) |  | 
 **sort_code** | **String** |  | [optional] 
 **bic** | **String** |  | [optional] 
 **sender_identity_card_type** | [**PayoutMethodIdentityCardTypeEnum**](PayoutMethodIdentityCardTypeEnum.md) |  | 

data/docs/PayoutMethodDetailsXOFCash.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **first_name** | **String** |  | 
 **last_name** | **String** |  | 
 **phone_number** | **String** |  | 
-**cash_provider** | [**PayoutMethodCashProviderEnum**](PayoutMethodCashProviderEnum.md) |  | [optional] 
+**cash_provider** | [**PayoutMethodCashProviderEnum**](PayoutMethodCashProviderEnum.md) |  | 
 **country** | [**PayoutMethodCountryEnum**](PayoutMethodCountryEnum.md) |  | [optional] 
 
 ## Code Sample

data/docs/RecipientStateReasonDetails.md

@@ -4,8 +4,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**code** | **String** | Status code of failed transaction | [optional] 
-**category** | **String** | Main category of error, it could be paid, unknown, pickupable, temporary_error, recipient_error, sender_error | [optional] 
+**code** | **String** | Status code of transaction | [optional] 
+**category** | **String** | Main category of status code, it could be paid, unknown, pickupable, temporary_error, recipient_error, sender_error, sender_action_required | [optional] 
 **messages** | **Array<String>** | Tiered messages | [optional] 
 **description** | **String** | Public, human readable, detailed error message | [optional] 
 
@@ -17,7 +17,7 @@ require 'TransferZero'
 instance = TransferZero::RecipientStateReasonDetails.new(code: 311,
                                  category: temporary_error,
                                  messages: ["Temporary error","Switch Error","Issuer/Switch inoperative"],
-                                 description: The central switch is not accepting transfers at the moment. We will retry the transaction. You can also edit or cancel this transaction.)
+                                 description: The central switch is not accepting transactions at the moment. We will retry the transaction)
 ```
 
 

data/docs/Sender.md

@@ -41,6 +41,7 @@ Name | Type | Description | Notes
 **contact_person_email** | **String** | The contact's email address (used only with a Business sender) | [optional] 
 **trading_country** | **String** | The Business trading country (used only with a Business sender) | [optional] 
 **trading_address** | **String** | The Business trading address (used only with a Business sender) | [optional] 
+**trading_name** | **String** | The Business trading name (used only with a Business sender) | [optional] 
 **number_monthly_transactions** | **String** | The estimated number of monthly transactions (used only with a Business sender) | [optional] 
 **amount_monthly_transactions** | **String** | The estimated amount for all transactions each month in USD (used only with a Business sender) | [optional] 
 **documents** | [**Array<Document>**](Document.md) | Needed for KYC checks. Required to approve the sender unless KYC is waived for your account. Please send us an empty list of documents: `\"documents\": [ ]` in the request if KYC has been waived.  If the documents already exist, please send the Document ID eg. ```JSON \"documents\": [   {     \"id\": \"b6648ba3-1c7b-4f59-8580-684899c84a07\"   } ] ``` | 
@@ -97,6 +98,7 @@ instance = TransferZero::Sender.new(id: bf9ff782-e182-45ac-abea-5bce83ad6670,
                                  contact_person_email: null,
                                  trading_country: null,
                                  trading_address: null,
+                                 trading_name: null,
                                  number_monthly_transactions: null,
                                  amount_monthly_transactions: null,
                                  documents: [{"id":"b6648ba3-1c7b-4f59-8580-684899c84a07"}],

data/docs/StateReasonDetails.md

@@ -0,0 +1,23 @@
+# TransferZero::StateReasonDetails
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **String** | Status code of transaction | [optional] 
+**category** | **String** | Main category of status code, it could be paid, unknown, pickupable, temporary_error, recipient_error, sender_error, sender_action_required | [optional] 
+**messages** | **Array<String>** | Tiered messages | [optional] 
+**description** | **String** | Public, human readable, detailed error message | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::StateReasonDetails.new(code: 311,
+                                 category: temporary_error,
+                                 messages: ["Temporary error","Switch Error","Issuer/Switch inoperative"],
+                                 description: The central switch is not accepting transactions at the moment. We will retry the transaction)
+```
+
+