transferzero-sdk 1.0.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae2ba119df28634848d972de738481bc9a301176fae48ec8ee0880f8199e75f0
-  data.tar.gz: c38547763f4bd7789bb32fbbfe7ecb3b1b938efb8beedf24b946c418928858fc
+  metadata.gz: ec7ad9295e642f964d1fd79f4dc572929b15e8a09611c5b3b427ca018c45cd38
+  data.tar.gz: ce7e8272987b6b48cf9374784cfec071df90f71b2db7daccb1526d90179f46c2
 SHA512:
-  metadata.gz: 88e9b869de1c7c30b7883ee07ae3d428fdec4769102a6ba0188bc3a2a474ce267319c1583781444aa8b0469b0947e7c1231de66b4b957a1a6a792b33a6b03076
-  data.tar.gz: 7e88fcf87bdd03e57b3fcb8187b9df4686ee89b09daf443820179e01ae78e303065188d9780ab133b3642036b65b7afe077e1167e9bc7d015fed5f16da8dab76
+  metadata.gz: 20e6b03b1ed61397bed75c3a7de9a887fb3dc9a40a594c8ba22bad1a9c6728ac68abfb0e12eccb6b09089047a44e859b212a4dbf8e477d4ab33180cc4e7578a6
+  data.tar.gz: 27a877b021b92d6e45eec0bb90ac34ed37a7bbae0a08d19d984108bd60163a6fc39ed1cff9daf524cb096af6789334e52717f4f6b0d743ebaba2633a943105cd

data/Gemfile.lock

@@ -0,0 +1,93 @@
+PATH
+  remote: .
+  specs:
+    transferzero-sdk (1.2.0)
+      activesupport (~> 5)
+      json (~> 2.1, >= 2.1.0)
+      typhoeus (~> 1.0, >= 1.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ZenTest (4.11.2)
+    activesupport (5.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    addressable (2.6.0)
+      public_suffix (>= 2.0.2, < 4.0)
+    autotest (4.4.6)
+      ZenTest (>= 4.4.1)
+    autotest-fsevent (0.2.14)
+      sys-uname
+    autotest-growl (0.2.16)
+    autotest-rails-pure (4.1.2)
+    byebug (11.0.1)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.5)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    ethon (0.12.0)
+      ffi (>= 1.3.0)
+    ffi (1.11.1)
+    hashdiff (1.0.0)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    json (2.2.0)
+    method_source (0.9.2)
+    minitest (5.11.3)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.7.0)
+      byebug (~> 11.0)
+      pry (~> 0.10)
+    public_suffix (3.1.1)
+    rake (12.0.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    safe_yaml (1.0.5)
+    sys-uname (1.0.4)
+      ffi (>= 1.0.0)
+    thread_safe (0.3.6)
+    typhoeus (1.3.1)
+      ethon (>= 0.9.0)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    vcr (3.0.3)
+    webmock (1.24.6)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+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
+   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.0.0
+- Package version: 1.3.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.0.0.gem
+gem install ./transferzero-sdk-1.3.0.gem
 ```
-(for development, run `gem install --dev ./transferzero-sdk-1.0.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./transferzero-sdk-1.3.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.0.0'
+    gem 'transferzero-sdk', '~> 1.3.0'
 
 ### Install from Git
 
@@ -164,9 +164,11 @@ 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)
@@ -178,6 +180,7 @@ 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)
@@ -209,12 +212,14 @@ Class | Method | HTTP request | Description
  - [TransferZero::PayoutMethodRequest](docs/PayoutMethodRequest.md)
  - [TransferZero::PayoutMethodResponse](docs/PayoutMethodResponse.md)
  - [TransferZero::PayoutMethodWebhook](docs/PayoutMethodWebhook.md)
+ - [TransferZero::PayoutMethodWebhookAllOf](docs/PayoutMethodWebhookAllOf.md)
  - [TransferZero::Recipient](docs/Recipient.md)
  - [TransferZero::RecipientListResponse](docs/RecipientListResponse.md)
  - [TransferZero::RecipientRequest](docs/RecipientRequest.md)
  - [TransferZero::RecipientResponse](docs/RecipientResponse.md)
  - [TransferZero::RecipientState](docs/RecipientState.md)
  - [TransferZero::RecipientWebhook](docs/RecipientWebhook.md)
+ - [TransferZero::RecipientWebhookAllOf](docs/RecipientWebhookAllOf.md)
  - [TransferZero::Sender](docs/Sender.md)
  - [TransferZero::SenderListResponse](docs/SenderListResponse.md)
  - [TransferZero::SenderRequest](docs/SenderRequest.md)
@@ -223,6 +228,7 @@ 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)
@@ -232,6 +238,7 @@ 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: null)
+instance = TransferZero::AccountMeta.new(negative_balance: false)
 ```
 
 

data/docs/Currency.md

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

data/docs/CurrencyExchangeAllOf.md

@@ -0,0 +1,17 @@
+# TransferZero::CurrencyExchangeAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**opposites** | [**Array<CurrencyOpposite>**](CurrencyOpposite.md) | Lists the currencies where you can exchange from this one | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::CurrencyExchangeAllOf.new(opposites: null)
+```
+
+

data/docs/CurrencyInfoApi.md

@@ -67,7 +67,7 @@ end
 
 
 # **info_currencies_in**
-> CurrencyExchangeListResponse info_currencies_in
+> CurrencyExchangeListResponse info_currencies_in(opts)
 
 Getting a list of possible input currencies
 
@@ -80,9 +80,13 @@ require 'transferzero-sdk'
 
 api_instance = TransferZero::CurrencyInfoApi.new
 
+opts = { 
+  sender_id: 'sender_id_example' # String | Allows the scoping of the results by `sender_id` (optional).  Example: `/v1/info/currencies/in?sender_id=26ec8517-2f0d-48c0-b74f-0bccb9ab3a87`
+}
+
 begin
   #Getting a list of possible input currencies
-  result = api_instance.info_currencies_in
+  result = api_instance.info_currencies_in(opts)
   p result
 rescue TransferZero::ApiError => e
   if e.validation_error
@@ -96,7 +100,10 @@ end
 ```
 
 ### Parameters
-This endpoint does not need any parameter.
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **sender_id** | [**String**](.md)| Allows the scoping of the results by `sender_id` (optional).  Example: `/v1/info/currencies/in?sender_id=26ec8517-2f0d-48c0-b74f-0bccb9ab3a87` | [optional] 
 
 ### Return type
 
@@ -124,7 +131,7 @@ end
 
 
 # **info_currencies_out**
-> CurrencyExchangeListResponse info_currencies_out
+> CurrencyExchangeListResponse info_currencies_out(opts)
 
 Getting a list of possible output currencies
 
@@ -137,9 +144,13 @@ require 'transferzero-sdk'
 
 api_instance = TransferZero::CurrencyInfoApi.new
 
+opts = { 
+  sender_id: 'sender_id_example' # String | Allows the scoping of the results by `sender_id` (optional).  Example: `/v1/info/currencies/out?sender_id=26ec8517-2f0d-48c0-b74f-0bccb9ab3a87`
+}
+
 begin
   #Getting a list of possible output currencies
-  result = api_instance.info_currencies_out
+  result = api_instance.info_currencies_out(opts)
   p result
 rescue TransferZero::ApiError => e
   if e.validation_error
@@ -153,7 +164,10 @@ end
 ```
 
 ### Parameters
-This endpoint does not need any parameter.
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **sender_id** | [**String**](.md)| Allows the scoping of the results by `sender_id` (optional).  Example: `/v1/info/currencies/out?sender_id=26ec8517-2f0d-48c0-b74f-0bccb9ab3a87` | [optional] 
 
 ### Return type
 

data/docs/CurrencyOpposite.md

@@ -15,6 +15,7 @@ Name | Type | Description | Notes
 **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] 
 
 ## Code Sample
 
@@ -26,12 +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)
+                                 rate: null,
+                                 mtm_rate: null)
 ```
 
 

data/docs/CurrencyOppositeAllOf.md

@@ -0,0 +1,19 @@
+# TransferZero::CurrencyOppositeAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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] 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::CurrencyOppositeAllOf.new(rate: null,
+                                 mtm_rate: null)
+```
+
+

data/docs/Debit.md

@@ -4,8 +4,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**amount** | **Float** | The amount to be debited from your account.  The “amount” parameter is optional - - if included, it must equal the amount required to fund the transaction. - if omitted, it will default to the amount required to fund the transaction.  | [optional] 
-**currency** | **String** | The currency of the amount in 3-character alpha ISO 4217 currency format | 
+**amount** | **Float** | The amount to be debited from your account.  The \"amount\" parameter is optional - - if included, it must equal the amount required to fund the transaction. - if omitted, it will default to the amount required to fund the transaction.  | [optional] 
+**currency** | **String** | The currency of the amount in 3-character alpha ISO 4217 currency format.  The \"currency\" parameter is optional - if omitted, it will default to the payin currency of the transaction. - it can be added in as an additional check to ensure that the expected currency is used. (an error will be given back if it does not match up with the payin currency of the transaction)  | [optional] 
 **to_type** | **String** | Describes what the debit is funding | 
 **to_id** | **String** | The ID of the resource the debit is funding | 
 **metadata** | [**Object**](.md) | Metadata of account debit | [optional] 

data/docs/DocumentWebhookAllOf.md

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

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: null)
+                                 allow_blank: false)
 ```
 
 

data/docs/FieldValidation.md

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

data/docs/PayinMethodDetails.md

@@ -15,7 +15,7 @@ require 'TransferZero'
 
 instance = TransferZero::PayinMethodDetails.new(redirect_url: null,
                                  phone_number: +2569999999,
-                                 send_instructions: null)
+                                 send_instructions: true)
 ```
 
 

data/docs/PayinMethodDetailsMobile.md

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

data/docs/PaymentMethod.md

@@ -18,9 +18,9 @@ require 'TransferZero'
 
 instance = TransferZero::PaymentMethod.new(type: NGN::Bank,
                                  provider: Interswitch,
-                                 otc_permitted: null,
+                                 otc_permitted: false,
                                  details: ["email","first_name","last_name","address"],
-                                 default: null,
+                                 default: false,
                                  fields: {"email":{"type":"input","validations":{"inclusion":{"in":{"NI":"National Id","PP":"Passport"},"allow_blank":true}}}})
 ```
 

data/docs/PaymentMethodOpposite.md

@@ -19,9 +19,9 @@ require 'TransferZero'
 
 instance = TransferZero::PaymentMethodOpposite.new(type: NGN::Bank,
                                  provider: Interswitch,
-                                 otc_permitted: null,
+                                 otc_permitted: false,
                                  details: ["email","first_name","last_name","address"],
-                                 default: null,
+                                 default: false,
                                  fields: {"email":{"type":"input","validations":{"inclusion":{"in":{"NI":"National Id","PP":"Passport"},"allow_blank":true}}}},
                                  opposites: 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. - `MAD::Cash` - for Moroccan cash remittance payments. - `EUR::Bank` - for IBAN bank transfers in EUR. - `GBP::Bank` - for IBAN bank transfers in GBP.  You can also send funds to the internal balance using `CCY::Balance`, where `CCY` is the appropriate currency. See [Collection from senders](https://github.com/transferzero/api-documentation/blob/master/additional-features.md#collections-from-senders) for more info on how to collect money into internal balance  | [optional] 
+**type** | **String** | Contains the currency to send the money to, and the type of the money movement  Commonly used payout types are:  - `NGN::Bank` - for Nigerian bank account payments. - `NGN::Mobile` - for Nigerian mobile money payments. - `GHS::Bank` - for Ghanaian bank account payments. - `GHS::Mobile` - for Ghanaian mobile money payments. - `UGX::Mobile` - for Ugandan mobile money payments. - `TZS::Mobile` - for Tanzanian mobile money payments. - `XOF::Mobile` - for Senegalese mobile money payments. - `XOF::Cash` - for Senegalese cash remittance payments. - `MAD::Cash` - for Moroccan cash remittance payments. - `EUR::Bank` - for IBAN bank transfers in EUR. - `GBP::Bank` - for IBAN bank transfers in GBP.  You can also send funds to the internal balance using `CCY::Balance`, where `CCY` is the appropriate currency. See [Collection from senders](https://github.com/transferzero/api-documentation/blob/master/additional-features.md#collections-from-senders) for more info on how to collect money into internal balance  | [optional] 
 **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]