transferzero-sdk 1.26.1 → 1.27.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5be47f1d203fb10177014dc2010918003221e523276a3699e1e9d59b5ebcd217
-  data.tar.gz: b8db60c105a52f30acf04920d5f9b319da98c6c07ded7fbeb6836a9ced3db936
+  metadata.gz: c026380fbb068eaa6f2fd8cd7d7a4e344703941f4a598a941335a36a876c889c
+  data.tar.gz: ec9ebe1444472809fd67eebc74f11f0af6ccbf49f91d5d6873ab0f3bc0c7f0ee
 SHA512:
-  metadata.gz: 6f8686dd0191dc016cafc9c142881b320107afcd71b9b7ce9d9120a057a467b5d7f4901f80ee5a27d25740eb4c90ad11e2d6faed2ab54043dabe0065e596890f
-  data.tar.gz: b03d7cbc46e6e983071d1d8a5a1f169493d93b5afca5d2e5cbf2a9ef048d5e41fcdbdfb7ba0bcc91d7373687dd8edbf7998abbfdf9b5d5171e6f797de44be69d
+  metadata.gz: a4f21641dd931824a9a421f9868913cd39c21adc6e1edd6090fe35d63efcc8a3f4b52e4830e661dbf0fae7fc10c8da24d08409b67182bbb0364eb2533c3ac7f9
+  data.tar.gz: d00429c962bb5287f416f3e8652d5da454bd67a1e04be944fc7b6b311dbac9987c7903258094b0a1eb95cc7d2969a6d22a12aeac3796f0d3fdab0d69bdf7a44c

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.26.1
+- Package version: 1.27.3
 - 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.26.1.gem
+gem install ./transferzero-sdk-1.27.3.gem
 ```
-(for development, run `gem install --dev ./transferzero-sdk-1.26.1.gem` to install the development dependencies)
+(for development, run `gem install --dev ./transferzero-sdk-1.27.3.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.26.1'
+    gem 'transferzero-sdk', '~> 1.27.3'
 
 ### Install from Git
 
@@ -224,6 +224,7 @@ Class | Method | HTTP request | Description
  - [TransferZero::PayoutMethodDetailsMobile](docs/PayoutMethodDetailsMobile.md)
  - [TransferZero::PayoutMethodDetailsNGNBank](docs/PayoutMethodDetailsNGNBank.md)
  - [TransferZero::PayoutMethodDetailsNZDBank](docs/PayoutMethodDetailsNZDBank.md)
+ - [TransferZero::PayoutMethodDetailsUGXBank](docs/PayoutMethodDetailsUGXBank.md)
  - [TransferZero::PayoutMethodDetailsUSDBank](docs/PayoutMethodDetailsUSDBank.md)
  - [TransferZero::PayoutMethodDetailsUSDCash](docs/PayoutMethodDetailsUSDCash.md)
  - [TransferZero::PayoutMethodDetailsXAFBank](docs/PayoutMethodDetailsXAFBank.md)

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

@@ -0,0 +1,21 @@
+# 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] 
+**margin** | **String** | The margin set for transactions of this particular currency with the base one | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::CurrencyOppositeAllOf.new(rate: null,
+                                 mtm_rate: null,
+                                 margin: null)
+```
+
+

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

@@ -0,0 +1,17 @@
+# TransferZero::PaymentMethodOppositeAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**opposites** | [**Array<PaymentMethod>**](PaymentMethod.md) | List of all providers that can be used in conjunction with the main provider | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::PaymentMethodOppositeAllOf.new(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. - `GHS::Bank` - for Ghanaian bank account payments. - `GHS::Mobile` - for Ghanaian mobile money payments. - `GHS::Cash` - for Ghanaian cash remittance payments. - `UGX::Mobile` - for Ugandan mobile money payments. - `XOF::Mobile` - for mobile money payments to West-Africa. - `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. - `USD::Bank` - for USD account payments. *** Currently Nigeria & United States only and in Beta phase *** - `USD::Cash` - for USD cash remittance payments. *** Currently Nigeria only and in Beta phase *** - `KES::Bank` - for Kenyan bank account payments. - `KES::Mobile` - for Kenyan mobile money payments. - `XAF::Mobile` - for mobile money payments to Cameroon. - `XAF::Bank` - for Cameroon bank account payments.. - `GNF::Mobile` - for mobile money payments to Guinea. - `BRL::Bank` - for Brazilian bank account payments. - `NZD::Bank` - for New Zealand bank account payments. - `INR::Bank` - for Indian bank account payments. - `BWP::Bank` - for Botswana bank account payments. - `ZMW::Bank` - for Zambian bank account payments. - `CAD::Bank` - for Canadian 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] 
+**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. - `GHS::Bank` - for Ghanaian bank account payments. - `GHS::Mobile` - for Ghanaian mobile money payments. - `GHS::Cash` - for Ghanaian cash remittance payments. - `UGX::Mobile` - for Ugandan mobile money payments. - `XOF::Mobile` - for mobile money payments to West-Africa. - `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. - `USD::Bank` - for USD account payments. *** Currently Nigeria & United States only and in Beta phase *** - `USD::Cash` - for USD cash remittance payments. *** Currently Nigeria only and in Beta phase *** - `KES::Bank` - for Kenyan bank account payments. - `KES::Mobile` - for Kenyan mobile money payments. - `XAF::Mobile` - for mobile money payments to Cameroon. - `XAF::Bank` - for Cameroon bank account payments.. - `GNF::Mobile` - for mobile money payments to Guinea. - `BRL::Bank` - for Brazilian bank account payments. - `NZD::Bank` - for New Zealand bank account payments. - `INR::Bank` - for Indian bank account payments. - `BWP::Bank` - for Botswana bank account payments. - `ZMW::Bank` - for Zambian bank account payments. - `CAD::Bank` - for Canadian bank account payments. - `UGX::Bank` - for Ugandan 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

@@ -12,7 +12,7 @@ Name | Type | Description | Notes
 **phone_number** | **String** |  | 
 **mobile_provider** | [**PayoutMethodMobileProviderEnum**](PayoutMethodMobileProviderEnum.md) |  | 
 **country** | [**PayoutMethodCountryEnum**](PayoutMethodCountryEnum.md) |  | 
-**transfer_reason** | [**PayoutMethodTransferReasonEnum**](PayoutMethodTransferReasonEnum.md) |  | 
+**transfer_reason** | **String** |  | 
 **iban** | **String** |  | 
 **bank_name** | **String** |  | 
 **bank_country** | **String** |  | [optional] 

data/docs/PayoutMethodDetailsUGXBank.md

@@ -0,0 +1,33 @@
+# TransferZero::PayoutMethodDetailsUGXBank
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**first_name** | **String** |  | 
+**last_name** | **String** |  | 
+**street** | **String** |  | 
+**city** | **String** |  | 
+**postal_code** | **String** |  | 
+**identity_card_id** | **String** |  | 
+**bank_account** | **String** |  | 
+**branch_code** | **String** |  | 
+**transfer_reason** | **String** |  | 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::PayoutMethodDetailsUGXBank.new(first_name: null,
+                                 last_name: null,
+                                 street: null,
+                                 city: null,
+                                 postal_code: null,
+                                 identity_card_id: null,
+                                 bank_account: null,
+                                 branch_code: null,
+                                 transfer_reason: null)
+```
+
+

data/docs/PayoutMethodWebhookAllOf.md

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

data/docs/RecipientWebhookAllOf.md

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

data/docs/SenderWebhookAllOf.md

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

data/docs/TransactionWebhookAllOf.md

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

data/lib/transferzero-sdk/api_client.rb

@@ -36,7 +36,7 @@ module TransferZero
     # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
     def initialize(config = Configuration.default)
       @config = config
-      @user_agent = "TransferZero-SDK/Ruby/1.26.1"
+      @user_agent = "TransferZero-SDK/Ruby/1.27.3"
       @default_headers = {
         'Content-Type' => 'application/json',
         'User-Agent' => @user_agent

data/lib/transferzero-sdk/models/currency_exchange_all_of.rb

@@ -0,0 +1,205 @@
+=begin
+#TransferZero API
+
+#Reference documentation for the TransferZero API V1
+
+OpenAPI spec version: 1.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.0.0-beta3
+
+=end
+
+require 'date'
+
+module TransferZero
+class CurrencyExchangeAllOf
+  # Lists the currencies where you can exchange from this one
+  attr_accessor :opposites
+
+  # Attribute mapping from ruby-style variable name to JSON key.
+  def self.attribute_map
+    {
+      :'opposites' => :'opposites'
+    }
+  end
+
+  # Attribute type mapping.
+  def self.openapi_types
+    {
+      :'opposites' => :'Array<CurrencyOpposite>'
+    }
+  end
+
+  # Initializes the object
+  # @param [Hash] attributes Model attributes in the form of hash
+  def initialize(attributes = {})
+    if (!attributes.is_a?(Hash))
+      fail ArgumentError, "The input argument (attributes) must be a hash in `TransferZero::CurrencyExchangeAllOf` initialize method"
+    end
+
+    # check to see if the attribute exists and convert string to symbol for hash key
+    attributes = attributes.each_with_object({}) { |(k, v), h|
+      if (!self.class.attribute_map.key?(k.to_sym))
+        fail ArgumentError, "`#{k}` is not a valid attribute in `TransferZero::CurrencyExchangeAllOf`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+      end
+      h[k.to_sym] = v
+    }
+
+    if attributes.key?(:'opposites')
+      if (value = attributes[:'opposites']).is_a?(Array)
+        self.opposites = value
+      end
+    end
+  end
+
+  # Show invalid properties with the reasons. Usually used together with valid?
+  # @return Array for valid properties with the reasons
+  def list_invalid_properties
+    invalid_properties = Array.new
+    invalid_properties
+  end
+
+  # Check to see if the all the properties in the model are valid
+  # @return true if the model is valid
+  def valid?
+    true
+  end
+
+  # Checks equality by comparing each attribute.
+  # @param [Object] Object to be compared
+  def ==(o)
+    return true if self.equal?(o)
+    self.class == o.class &&
+        opposites == o.opposites
+  end
+
+  # @see the `==` method
+  # @param [Object] Object to be compared
+  def eql?(o)
+    self == o
+  end
+
+  # Calculates hash code according to all attributes.
+  # @return [Integer] Hash code
+  def hash
+    [opposites].hash
+  end
+
+require 'active_support/core_ext/hash'
+require 'active_support/hash_with_indifferent_access.rb'
+# Builds the object from hash
+# @param [Hash] attributes Model attributes in the form of hash
+# @return [Object] Returns the model itself
+def build_from_hash(attributes)
+  return nil unless attributes.is_a?(Hash)
+  self.class.openapi_types.each_pair do |key, type|
+    if type =~ /\AArray<(.*)>/i
+      # check to ensure the input is an array given that the the attribute
+      # is documented as an array but the input is not
+      if attributes[self.class.attribute_map[key]].is_a?(Array)
+        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+      end
+    elsif !attributes[self.class.attribute_map[key]].nil?
+      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+    end # or else data not found in attributes(hash), not an issue as the data can be optional
+  end
+
+  self
+end
+
+# Deserializes the data based on type
+# @param string type Data type
+# @param string value Value to be deserialized
+# @return [Object] Deserialized data
+def _deserialize(type, value)
+  case type.to_sym
+  when :DateTime
+    DateTime.parse(value)
+  when :Date
+    Date.parse(value)
+  when :String
+    value.to_s
+  when :Integer
+    value.to_i
+  when :Float
+    value.to_f
+  when :Boolean
+    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+      true
+    else
+      false
+    end
+  when :Object
+    # generic object (usually a Hash), return directly
+    value
+  when /\AArray<(?<inner_type>.+)>\z/
+    inner_type = Regexp.last_match[:inner_type]
+    value.map { |v| _deserialize(inner_type, v) }
+  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+    k_type = Regexp.last_match[:k_type]
+    v_type = Regexp.last_match[:v_type]
+    {}.tap do |hash|
+      value.each do |k, v|
+        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+      end
+    end
+  else # model
+    temp_model = TransferZero.const_get(type).new
+    temp_model.build_from_hash(value)
+  end
+end
+
+# Returns the string representation of the object
+# @return [String] String presentation of the object
+def to_s
+  to_hash.to_s
+end
+
+# to_body is an alias to to_hash (backward compatibility)
+# @return [Hash] Returns the object in the form of hash
+def to_body
+  to_hash
+end
+
+# Returns the object in the form of hash
+# @return [Hash] Returns the object in the form of hash
+def to_hash
+  hash = {}
+  self.class.attribute_map.each_pair do |attr, param|
+    value = self.send(attr)
+    next if value.nil?
+    hash[param] = _to_hash(value)
+  end
+  ::ActiveSupport::HashWithIndifferentAccess.new(hash)
+end
+
+def [](key)
+  to_hash[key]
+end
+
+def dig(*args)
+  to_hash.dig(*args)
+end
+
+# Outputs non-array value in the form of hash
+# For object, use to_hash. Otherwise, just return the value
+# @param [Object] value Any valid value
+# @return [Hash] Returns the value in the form of hash
+def _to_hash(value)
+  if value.is_a?(Array)
+    value.compact.map { |v| _to_hash(v) }
+  elsif value.is_a?(Hash)
+    {}.tap do |hash|
+      value.each { |k, v| hash[k] = _to_hash(v) }
+    end
+  elsif value.respond_to? :to_hash
+    value.to_hash
+  else
+    value
+  end
+end
+
+end
+
+end