transferzero-sdk 1.5.0 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 501bc663322a04ddda61c7d4567a826e068a459920730d2d0b10591376949c70
-  data.tar.gz: 0bc7115b3aefaa82d95309ab9ae3ffc82ed9ca7f8d40e6b764967790e9e74f5a
+  metadata.gz: 65abf7df38463761e657c72743e2d3906ca55b9933ecb0fec06e0213bc965efe
+  data.tar.gz: 71e6bfa8a8ec907e24f2abec488fea17a54512b7d74bd4aac6e10af62d5f985c
 SHA512:
-  metadata.gz: 0e9c4f9d601c8e7d7429075cc9632cbf93b65752353cf6476cf63f855b5ba50850a5c50f254d66b410a090d3496fb9c5c6cf28444d4d77ccbaafe0f5890eefba
-  data.tar.gz: '09c080ee1b6656b6be9927abea4c49516310f70356f5fead6c647635757a1831bfbaf7ba53cecd10db7171ac824040d4969ccdbfdf40504151ddf6af30082a40'
+  metadata.gz: 1d14e138f2cfb1ebebdc156ca10c845f8586ec1784b5b80beef15fe8a7e0b9921dc0b46fcf3072e201e01bd6a1f82d9bfc1a329c82847cd86f3c2c90002d5c94
+  data.tar.gz: a06e60260498ef33c734de0023286ed7363a2c0af064526aef9f92fdfaf83b2bd0c11ed3186e47c572f83675e0d1a8bc5b645e1b4601f22dfe565a890b034a6d

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.5.0
+- Package version: 1.9.0
 - 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.5.0.gem
+gem install ./transferzero-sdk-1.9.0.gem
 ```
-(for development, run `gem install --dev ./transferzero-sdk-1.5.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./transferzero-sdk-1.9.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.5.0'
+    gem 'transferzero-sdk', '~> 1.9.0'
 
 ### Install from Git
 
@@ -115,7 +115,6 @@ 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
@@ -188,6 +187,7 @@ Class | Method | HTTP request | Description
  - [TransferZero::PaginationMeta](docs/PaginationMeta.md)
  - [TransferZero::PayinMethod](docs/PayinMethod.md)
  - [TransferZero::PayinMethodDetails](docs/PayinMethodDetails.md)
+ - [TransferZero::PayinMethodDetailsBTC](docs/PayinMethodDetailsBTC.md)
  - [TransferZero::PayinMethodDetailsMobile](docs/PayinMethodDetailsMobile.md)
  - [TransferZero::PayinMethodDetailsNGNBank](docs/PayinMethodDetailsNGNBank.md)
  - [TransferZero::PayinMethodRequest](docs/PayinMethodRequest.md)
@@ -197,7 +197,9 @@ Class | Method | HTTP request | Description
  - [TransferZero::PayoutMethod](docs/PayoutMethod.md)
  - [TransferZero::PayoutMethodBankAccountTypeEnum](docs/PayoutMethodBankAccountTypeEnum.md)
  - [TransferZero::PayoutMethodDetails](docs/PayoutMethodDetails.md)
+ - [TransferZero::PayoutMethodDetailsBTC](docs/PayoutMethodDetailsBTC.md)
  - [TransferZero::PayoutMethodDetailsBalance](docs/PayoutMethodDetailsBalance.md)
+ - [TransferZero::PayoutMethodDetailsGBPBank](docs/PayoutMethodDetailsGBPBank.md)
  - [TransferZero::PayoutMethodDetailsGHSBank](docs/PayoutMethodDetailsGHSBank.md)
  - [TransferZero::PayoutMethodDetailsIBAN](docs/PayoutMethodDetailsIBAN.md)
  - [TransferZero::PayoutMethodDetailsMADCash](docs/PayoutMethodDetailsMADCash.md)
@@ -205,6 +207,7 @@ Class | Method | HTTP request | Description
  - [TransferZero::PayoutMethodDetailsNGNBank](docs/PayoutMethodDetailsNGNBank.md)
  - [TransferZero::PayoutMethodDetailsXOFBank](docs/PayoutMethodDetailsXOFBank.md)
  - [TransferZero::PayoutMethodDetailsXOFMobile](docs/PayoutMethodDetailsXOFMobile.md)
+ - [TransferZero::PayoutMethodDetailsZARBank](docs/PayoutMethodDetailsZARBank.md)
  - [TransferZero::PayoutMethodGenderEnum](docs/PayoutMethodGenderEnum.md)
  - [TransferZero::PayoutMethodIdentityCardTypeEnum](docs/PayoutMethodIdentityCardTypeEnum.md)
  - [TransferZero::PayoutMethodListResponse](docs/PayoutMethodListResponse.md)
@@ -212,6 +215,7 @@ Class | Method | HTTP request | Description
  - [TransferZero::PayoutMethodRequest](docs/PayoutMethodRequest.md)
  - [TransferZero::PayoutMethodResponse](docs/PayoutMethodResponse.md)
  - [TransferZero::PayoutMethodWebhook](docs/PayoutMethodWebhook.md)
+ - [TransferZero::PoliticallyExposedPerson](docs/PoliticallyExposedPerson.md)
  - [TransferZero::Recipient](docs/Recipient.md)
  - [TransferZero::RecipientListResponse](docs/RecipientListResponse.md)
  - [TransferZero::RecipientRequest](docs/RecipientRequest.md)

data/docs/Currency.md

@@ -12,7 +12,6 @@ Name | Type | Description | Notes
 **primary** | **Boolean** | Is this a primary currency? | [optional] 
 **min** | **String** | The minimum amount allowed in a transaction | [optional] 
 **max** | **String** | The maximum amount allowed in a transaction | [optional] 
-**margin** | **String** | The margin set for transactions in this currency | [optional] 
 **usd_equivalent** | **String** | The equivalent of the currency to 1 USD | [optional] 
 
 ## Code Sample
@@ -28,7 +27,6 @@ instance = TransferZero::Currency.new(code: NGN,
                                  primary: true,
                                  min: 100,
                                  max: 50000000,
-                                 margin: null,
                                  usd_equivalent: null)
 ```
 

data/docs/CurrencyExchange.md

@@ -12,7 +12,6 @@ Name | Type | Description | Notes
 **primary** | **Boolean** | Is this a primary currency? | [optional] 
 **min** | **String** | The minimum amount allowed in a transaction | [optional] 
 **max** | **String** | The maximum amount allowed in a transaction | [optional] 
-**margin** | **String** | The margin set for transactions in this currency | [optional] 
 **usd_equivalent** | **String** | The equivalent of the currency to 1 USD | [optional] 
 **opposites** | [**Array<CurrencyOpposite>**](CurrencyOpposite.md) | Lists the currencies where you can exchange from this one | [optional] 
 
@@ -29,7 +28,6 @@ instance = TransferZero::CurrencyExchange.new(code: NGN,
                                  primary: true,
                                  min: 100,
                                  max: 50000000,
-                                 margin: null,
                                  usd_equivalent: null,
                                  opposites: null)
 ```

data/docs/CurrencyOpposite.md

@@ -12,10 +12,10 @@ Name | Type | Description | Notes
 **primary** | **Boolean** | Is this a primary currency? | [optional] 
 **min** | **String** | The minimum amount allowed in a transaction | [optional] 
 **max** | **String** | The maximum amount allowed in a transaction | [optional] 
-**margin** | **String** | The margin set for transactions in this currency | [optional] 
 **usd_equivalent** | **String** | The equivalent of the currency to 1 USD | [optional] 
 **rate** | **Float** | The rate of this particular currency with the base one | [optional] 
 **mtm_rate** | **Float** | Mark to market rate of this particular currency against the base one with the margin factored in | [optional] 
+**margin** | **String** | The margin set for transactions of this particular currency with the base one | [optional] 
 
 ## Code Sample
 
@@ -30,10 +30,10 @@ instance = TransferZero::CurrencyOpposite.new(code: NGN,
                                  primary: true,
                                  min: 100,
                                  max: 50000000,
-                                 margin: null,
                                  usd_equivalent: null,
                                  rate: null,
-                                 mtm_rate: null)
+                                 mtm_rate: null,
+                                 margin: null)
 ```
 
 

data/docs/Document.md

@@ -4,8 +4,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**sender_id** | **String** |  | [optional] 
 **upload** | **String** | Base64 encoded data uri of an image/pdf file or a fully qualified url | 
+**url** | **String** | URL of the document location | [optional] 
 **upload_file_name** | **String** | Name of the upload | 
 **metadata** | [**Object**](.md) | Metadata of document | [optional] 
 **upload_content_type** | **String** |  | [optional] 
@@ -22,8 +22,8 @@ Name | Type | Description | Notes
 ```ruby
 require 'TransferZero'
 
-instance = TransferZero::Document.new(sender_id: ebe9bc0b-f2f6-4ce8-802a-8b79912d041e,
-                                 upload: data:image/png;base64,iVBORw0KGg...lFTkSuQmCC,
+instance = TransferZero::Document.new(upload: data:image/png;base64,iVBORw0KGg...lFTkSuQmCC,
+                                 url: https://bitpesa-documents.amazonaws.com/document.pdf,
                                  upload_file_name: example.png,
                                  metadata: {},
                                  upload_content_type: image/png,

data/docs/DocumentsApi.md

@@ -4,79 +4,13 @@ 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_idopts)
+> DocumentResponse get_document(document_id)
 
 Fetching a document
 
@@ -89,13 +23,10 @@ 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_idopts)
+  result = api_instance.get_document(document_id)
   p result
 rescue TransferZero::ApiError => e
   if e.validation_error
@@ -113,7 +44,6 @@ 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
 
@@ -157,7 +87,6 @@ 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
@@ -181,7 +110,6 @@ 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/PayinMethodDetails.md

@@ -8,6 +8,7 @@ Name | Type | Description | Notes
 **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] 
+**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
 
@@ -17,7 +18,8 @@ require 'TransferZero'
 instance = TransferZero::PayinMethodDetails.new(payment_method: null,
                                  redirect_url: null,
                                  phone_number: +2569999999,
-                                 send_instructions: true)
+                                 send_instructions: true,
+                                 refund_address: null)
 ```
 
 

data/docs/PayinMethodDetailsBTC.md

@@ -0,0 +1,17 @@
+# TransferZero::PayinMethodDetailsBTC
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::PayinMethodDetailsBTC.new(refund_address: 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://docs.transferzero.com/docs/additional-features/#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. - `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 and FP accounts transfers in GBP. - `ZAR::Bank` - for South Africa bank account payments.  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/PayoutMethodDetails.md

@@ -14,6 +14,7 @@ Name | Type | Description | Notes
 **iban** | **String** |  | 
 **bank_name** | **String** |  | 
 **bank_country** | **String** |  | 
+**sort_code** | **String** |  | [optional] 
 **bic** | **String** |  | [optional] 
 **sender_identity_card_type** | [**PayoutMethodIdentityCardTypeEnum**](PayoutMethodIdentityCardTypeEnum.md) |  | 
 **sender_identity_card_id** | **String** |  | 
@@ -24,6 +25,13 @@ Name | Type | Description | Notes
 **identity_card_type** | [**PayoutMethodIdentityCardTypeEnum**](PayoutMethodIdentityCardTypeEnum.md) |  | [optional] 
 **identity_card_id** | **String** |  | [optional] 
 **reference** | **String** |  | [optional] 
+**name** | **String** |  | 
+**address** | **String** |  | 
+**street** | **String** |  | 
+**postal_code** | **String** |  | 
+**city** | **String** |  | 
+**email** | **String** |  | [optional] 
+**transfer_reason_code** | **String** |  | [optional] 
 
 ## Code Sample
 
@@ -40,6 +48,7 @@ instance = TransferZero::PayoutMethodDetails.new(first_name: null,
                                  iban: null,
                                  bank_name: null,
                                  bank_country: null,
+                                 sort_code: null,
                                  bic: null,
                                  sender_identity_card_type: null,
                                  sender_identity_card_id: null,
@@ -49,7 +58,14 @@ instance = TransferZero::PayoutMethodDetails.new(first_name: null,
                                  reason: null,
                                  identity_card_type: null,
                                  identity_card_id: null,
-                                 reference: null)
+                                 reference: null,
+                                 name: null,
+                                 address: null,
+                                 street: null,
+                                 postal_code: null,
+                                 city: null,
+                                 email: null,
+                                 transfer_reason_code: null)
 ```
 
 

data/docs/PayoutMethodDetailsBTC.md

@@ -0,0 +1,23 @@
+# TransferZero::PayoutMethodDetailsBTC
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**first_name** | **String** |  | 
+**last_name** | **String** |  | 
+**name** | **String** |  | 
+**address** | **String** |  | 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::PayoutMethodDetailsBTC.new(first_name: null,
+                                 last_name: null,
+                                 name: null,
+                                 address: null)
+```
+
+

data/docs/PayoutMethodDetailsGBPBank.md

@@ -0,0 +1,29 @@
+# TransferZero::PayoutMethodDetailsGBPBank
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**first_name** | **String** |  | 
+**last_name** | **String** |  | 
+**bank_name** | **String** |  | [optional] 
+**bank_account** | **String** |  | [optional] 
+**sort_code** | **String** |  | [optional] 
+**iban** | **String** |  | [optional] 
+**bic** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::PayoutMethodDetailsGBPBank.new(first_name: null,
+                                 last_name: null,
+                                 bank_name: null,
+                                 bank_account: null,
+                                 sort_code: null,
+                                 iban: null,
+                                 bic: null)
+```
+
+

data/docs/PayoutMethodDetailsIBAN.md

@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **first_name** | **String** |  | 
 **last_name** | **String** |  | 
-**bank_name** | **String** |  | 
+**bank_name** | **String** |  | [optional] 
 **iban** | **String** |  | 
 **bic** | **String** |  | [optional] 
 

data/docs/PayoutMethodDetailsMobile.md

@@ -7,6 +7,7 @@ Name | Type | Description | Notes
 **first_name** | **String** |  | 
 **last_name** | **String** |  | 
 **phone_number** | **String** |  | 
+**mobile_provider** | [**PayoutMethodMobileProviderEnum**](PayoutMethodMobileProviderEnum.md) |  | [optional] 
 
 ## Code Sample
 
@@ -15,7 +16,8 @@ require 'TransferZero'
 
 instance = TransferZero::PayoutMethodDetailsMobile.new(first_name: null,
                                  last_name: null,
-                                 phone_number: null)
+                                 phone_number: null,
+                                 mobile_provider: null)
 ```