transferzero-sdk 1.8.0 → 1.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c274d3c1799100cc96b0948c818a02e02ade91172cd7b4525c75a9242852d687
-  data.tar.gz: 7746ed2b6081cf788d8a3894ba3f0ccb4b4bfde981ecc9bfeecc8e11f229cc19
+  metadata.gz: 8243fc779fa0e32c85ae76a72f7ae931b1ada6c2e0521175390f751c4d490d57
+  data.tar.gz: 744f9b8ff5334986682842f1342e7f097c5c98704e6ff39980cc11a0c04e11b2
 SHA512:
-  metadata.gz: 7506bb914ebae11b793ac2d3a3e57b08c40d8559bf8d51a49cce4b9a281766a29b92a85be9edf8b1fbad2ff5e62e9e9ae2dde355587d9b4d1a4e1d43017dc417
-  data.tar.gz: 85e630486a5f4aa75d1b19de7ba6f57555ddc56947a6a6f178d11a157aee16138b3967df352b91a6d67b6d4fbc7cbd4d499a04221cd00d16145e47569dc629e2
+  metadata.gz: c2f49836c10fb0f61a6d3959632b8297ec62e28fec15be4e9c729425e8a4cab13b3a3c36654b5ba77c2b1872c745fc0bee4d4b31bb18a4998644cc81c1af1ee9
+  data.tar.gz: 15aeffc40d082ba65714136ec4f6c8da7b1856d1eb5c08d7fa1e58db230c67615402cff03126fefd7b5d948e758825d05c183a9cb3518601250b5cc7844f721f

data/Gemfile.lock

@@ -0,0 +1,93 @@
+PATH
+  remote: .
+  specs:
+    transferzero-sdk (1.9.0)
+      activesupport (>= 4)
+      json (>= 1.4)
+      typhoeus (~> 1.0, >= 1.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ZenTest (4.12.0)
+    activesupport (6.0.3.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    addressable (2.7.0)
+      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.7)
+    crack (0.4.4)
+    diff-lcs (1.4.4)
+    ethon (0.12.0)
+      ffi (>= 1.3.0)
+    ffi (1.13.1)
+    hashdiff (1.0.1)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    json (2.3.1)
+    method_source (1.0.0)
+    minitest (5.14.2)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
+    public_suffix (4.0.6)
+    rake (12.0.0)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+    sys-uname (1.2.2)
+      ffi (~> 1.1)
+    thread_safe (0.3.6)
+    typhoeus (1.4.0)
+      ethon (>= 0.9.0)
+    tzinfo (1.2.8)
+      thread_safe (~> 0.1)
+    vcr (3.0.3)
+    webmock (1.24.6)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  ruby
+
+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
+  rake (~> 12.0.0)
+  rspec (~> 3.6, >= 3.6.0)
+  transferzero-sdk!
+  vcr (~> 3.0, >= 3.0.1)
+  webmock (~> 1.24, >= 1.24.3)
+
+BUNDLED WITH
+   2.1.4

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.8.0
+- Package version: 1.12.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.8.0.gem
+gem install ./transferzero-sdk-1.12.0.gem
 ```
-(for development, run `gem install --dev ./transferzero-sdk-1.8.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./transferzero-sdk-1.12.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.8.0'
+    gem 'transferzero-sdk', '~> 1.12.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
@@ -131,6 +130,7 @@ Class | Method | HTTP request | Description
 *TransferZero::RecipientsApi* | [**delete_recipient**](docs/RecipientsApi.md#delete_recipient) | **DELETE** /recipients/{Recipient ID} | Cancelling a recipient
 *TransferZero::RecipientsApi* | [**get_recipients**](docs/RecipientsApi.md#get_recipients) | **GET** /recipients | Getting a list of recipients with filtering
 *TransferZero::RecipientsApi* | [**patch_recipient**](docs/RecipientsApi.md#patch_recipient) | **PATCH** /recipients/{Recipient ID} | Updating a recipient
+*TransferZero::RecipientsApi* | [**proof_of_payments**](docs/RecipientsApi.md#proof_of_payments) | **GET** /recipients/{Recipient ID}/proof_of_payments | Returns list of proof of payments
 *TransferZero::SendersApi* | [**delete_sender**](docs/SendersApi.md#delete_sender) | **DELETE** /senders/{Sender ID} | Deleting a sender
 *TransferZero::SendersApi* | [**get_sender**](docs/SendersApi.md#get_sender) | **GET** /senders/{Sender ID} | Fetching a sender
 *TransferZero::SendersApi* | [**get_senders**](docs/SendersApi.md#get_senders) | **GET** /senders | Listing senders
@@ -188,6 +188,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)
@@ -196,15 +197,21 @@ Class | Method | HTTP request | Description
  - [TransferZero::PaymentMethodOpposite](docs/PaymentMethodOpposite.md)
  - [TransferZero::PayoutMethod](docs/PayoutMethod.md)
  - [TransferZero::PayoutMethodBankAccountTypeEnum](docs/PayoutMethodBankAccountTypeEnum.md)
+ - [TransferZero::PayoutMethodCashProviderEnum](docs/PayoutMethodCashProviderEnum.md)
+ - [TransferZero::PayoutMethodCountryEnum](docs/PayoutMethodCountryEnum.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)
  - [TransferZero::PayoutMethodDetailsMobile](docs/PayoutMethodDetailsMobile.md)
  - [TransferZero::PayoutMethodDetailsNGNBank](docs/PayoutMethodDetailsNGNBank.md)
  - [TransferZero::PayoutMethodDetailsXOFBank](docs/PayoutMethodDetailsXOFBank.md)
+ - [TransferZero::PayoutMethodDetailsXOFCash](docs/PayoutMethodDetailsXOFCash.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)
@@ -213,11 +220,14 @@ Class | Method | HTTP request | Description
  - [TransferZero::PayoutMethodResponse](docs/PayoutMethodResponse.md)
  - [TransferZero::PayoutMethodWebhook](docs/PayoutMethodWebhook.md)
  - [TransferZero::PoliticallyExposedPerson](docs/PoliticallyExposedPerson.md)
+ - [TransferZero::ProofOfPayment](docs/ProofOfPayment.md)
+ - [TransferZero::ProofOfPaymentListResponse](docs/ProofOfPaymentListResponse.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::RecipientStateReasonDetails](docs/RecipientStateReasonDetails.md)
  - [TransferZero::RecipientWebhook](docs/RecipientWebhook.md)
  - [TransferZero::Sender](docs/Sender.md)
  - [TransferZero::SenderListResponse](docs/SenderListResponse.md)

data/docs/AccountMeta.md

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

data/docs/AccountValidationRequest.md

@@ -7,6 +7,7 @@ Name | Type | Description | Notes
 **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] 
+**mobile_provider** | [**PayoutMethodMobileProviderEnum**](PayoutMethodMobileProviderEnum.md) |  | [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 bank and mobile are supported | 
@@ -19,6 +20,7 @@ require 'TransferZero'
 instance = TransferZero::AccountValidationRequest.new(bank_account: null,
                                  bank_code: null,
                                  phone_number: +233000000000,
+                                 mobile_provider: null,
                                  country: null,
                                  currency: null,
                                  method: null)

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
@@ -25,10 +24,9 @@ instance = TransferZero::Currency.new(code: NGN,
                                  symbol: ₦,
                                  decimals: 2,
                                  subunit_to_unit: 100,
-                                 primary: null,
+                                 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] 
 
@@ -26,10 +25,9 @@ instance = TransferZero::CurrencyExchange.new(code: NGN,
                                  symbol: ₦,
                                  decimals: 2,
                                  subunit_to_unit: 100,
-                                 primary: null,
+                                 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
 
@@ -27,13 +27,13 @@ instance = TransferZero::CurrencyOpposite.new(code: NGN,
                                  symbol: ₦,
                                  decimals: 2,
                                  subunit_to_unit: 100,
-                                 primary: null,
+                                 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] 
@@ -15,6 +15,8 @@ Name | Type | Description | Notes
 **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] 
+**document_id** | **String** | Document ID issued by government | [optional] 
+**expiry_date** | **Date** | Document expiry date issued by government | [optional] 
 **errors** | **Hash<String, Array<ValidationErrorDescription>>** | The fields that have some problems and don't pass validation | [optional] 
 
 ## Code Sample
@@ -22,8 +24,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,
@@ -33,6 +35,8 @@ instance = TransferZero::Document.new(sender_id: ebe9bc0b-f2f6-4ce8-802a-8b79912
                                  document_type: certificate_of_business_name_registration,
                                  issuing_country: NG,
                                  id: ebe9bc0b-f2f6-4ce8-802a-8b79912d041e,
+                                 document_id: XYZ12345,
+                                 expiry_date: null,
                                  errors: {"phone_number":[{"error":"invalid"}],"documents":[{"error":"blank"}]})
 ```
 

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