transferzero-sdk 1.37.3 → 1.37.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5fb87b24b8a7d091333fef22151dd9074d30175b4541daec2a9445890aa6f8f7
-  data.tar.gz: 50598dbcf998aa3e2a4bfd62916e39b71cebf1d97e13772f7323b3cf175f9353
+  metadata.gz: ed72b9320b1de46c51f07501731dec006607d453c539a8d9dc37c21d719016b0
+  data.tar.gz: 7fc11d2c96e8b9697352b827b83c460c0cdbbad13eb0803354715f075be7a63c
 SHA512:
-  metadata.gz: 512655aa70d98a2b08cd17cd908dda64af040ef194b11f6a65516f96a870095d5fdf1bfd41f870a6b76662792d03a88ba54b87a6d5514c5dec0de4f5d7a1dd90
-  data.tar.gz: a756008a7a0d8cbad169df5477d0e0d67f12e2ffee2c830ef3f2869e246ddec8a2307e811c7717cbb7830a3a6bcb0add69877bda70b5ad4a5ac4b8fb068e74cf
+  metadata.gz: ab416c5db52b52ef4f9f29bf034f8f35404457309910083b631a4fb6afbb888f04a6c11789c452f9b7384705d65db49032d2116c25a301b80c85f177a3535480
+  data.tar.gz: c92635d6382fd87c264a8135a45dae55891e7ef3d79893397eaf16757ba4e02b4abf4b6d6a422a2916ff7a5164890807b09287551056e01914308bd6d5dc050d

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    transferzero-sdk (1.37.3)
+    transferzero-sdk (1.37.5)
       activesupport (>= 4)
       faraday (~> 1.0, >= 1.0.1)
       json (>= 1.4)
@@ -10,7 +10,7 @@ GEM
   remote: https://rubygems.org/
   specs:
     ZenTest (4.12.2)
-    activesupport (8.1.2)
+    activesupport (8.1.3)
       base64
       bigdecimal
       concurrent-ruby (~> 1.0, >= 1.3.1)
@@ -24,7 +24,7 @@ GEM
       tzinfo (~> 2.0, >= 2.0.5)
       uri (>= 0.13.1)
     base64 (0.3.0)
-    bigdecimal (4.0.1)
+    bigdecimal (4.1.2)
     byebug (13.0.0)
       reline (>= 0.6.0)
     coderay (1.1.3)
@@ -32,7 +32,7 @@ GEM
     connection_pool (3.0.2)
     diff-lcs (1.6.2)
     drb (2.2.3)
-    faraday (1.10.4)
+    faraday (1.10.5)
       faraday-em_http (~> 1.0)
       faraday-em_synchrony (~> 1.0)
       faraday-excon (~> 1.1)
@@ -54,14 +54,15 @@ GEM
     faraday-net_http_persistent (1.2.0)
     faraday-patron (1.0.0)
     faraday-rack (1.0.0)
-    faraday-retry (1.0.3)
+    faraday-retry (1.0.4)
     i18n (1.14.8)
       concurrent-ruby (~> 1.0)
     io-console (0.8.2)
-    json (2.18.1)
+    json (2.19.5)
     logger (1.7.0)
     method_source (1.1.0)
-    minitest (6.0.1)
+    minitest (6.0.6)
+      drb (~> 2.0)
       prism (~> 1.5)
     multipart-post (2.4.1)
     prism (1.9.0)
@@ -84,7 +85,7 @@ GEM
     rspec-expectations (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.7)
+    rspec-mocks (3.13.8)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.7)

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.37.3
+- Package version: 1.37.5
 - 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.37.3.gem
+gem install ./transferzero-sdk-1.37.5.gem
 ```
-(for development, run `gem install --dev ./transferzero-sdk-1.37.3.gem` to install the development dependencies)
+(for development, run `gem install --dev ./transferzero-sdk-1.37.5.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.37.3'
+    gem 'transferzero-sdk', '~> 1.37.5'
 
 ### Install from Git
 
@@ -113,6 +113,7 @@ 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::DlocalBalanceApi* | [**get_balance**](docs/DlocalBalanceApi.md#get_balance) | **GET** /dlocal/balance | Get dlocal balances
 *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
@@ -176,6 +177,8 @@ Class | Method | HTTP request | Description
  - [TransferZero::DebitListResponse](docs/DebitListResponse.md)
  - [TransferZero::DebitRequest](docs/DebitRequest.md)
  - [TransferZero::DebitRequestWrapper](docs/DebitRequestWrapper.md)
+ - [TransferZero::DlocalBalance](docs/DlocalBalance.md)
+ - [TransferZero::DlocalBalanceResponse](docs/DlocalBalanceResponse.md)
  - [TransferZero::Document](docs/Document.md)
  - [TransferZero::DocumentListResponse](docs/DocumentListResponse.md)
  - [TransferZero::DocumentRequest](docs/DocumentRequest.md)

data/docs/DlocalBalance.md

@@ -0,0 +1,23 @@
+# TransferZero::DlocalBalance
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**currency** | **String** | The currency of this balance | [optional] 
+**available_balance** | **Float** | The available balance for the given currency | [optional] 
+**previous_day_closing_balance** | **Float** | The balance at end of previous day | [optional] 
+**current_balance_date** | **String** | Current date | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::DlocalBalance.new(currency: USD,
+                                 available_balance: 1000,
+                                 previous_day_closing_balance: 1000,
+                                 current_balance_date: 2026-02-24)
+```
+
+

data/docs/DlocalBalanceApi.md

@@ -0,0 +1,66 @@
+# TransferZero::DlocalBalanceApi
+
+All URIs are relative to *https://api-sandbox.transferzero.com/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_balance**](DlocalBalanceApi.md#get_balance) | **GET** /dlocal/balance | Get dlocal balances
+
+
+# **get_balance**
+> DlocalBalanceResponse get_balance
+
+Get dlocal balances
+
+This endpoint retrieves dlocal account balances
+
+### Example
+```ruby
+# load the gem
+require 'transferzero-sdk'
+
+api_instance = TransferZero::DlocalBalanceApi.new
+
+begin
+  #Get dlocal balances
+  result = api_instance.get_balance
+  p result
+rescue TransferZero::ApiError => e
+  if e.validation_error
+    puts "WARN: Validation error occured when calling the endpoint"
+    result = e.response_object("DlocalBalanceResponse")
+    p result
+  else
+    puts "Exception when calling DlocalBalanceApi->get_balance: #{e}"
+  end
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**DlocalBalanceResponse**](DlocalBalanceResponse.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/DlocalBalanceResponse.md

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

data/docs/Recipient.md

@@ -28,6 +28,7 @@ Name | Type | Description | Notes
 **id** | **String** |  | [optional] 
 **type** | **String** | Type of recipient to create - either person or business (defaults to person)  | [optional] 
 **errors** | **Hash<String, Array<ValidationErrorDescription>>** | The fields that have some problems and don't pass validation | [optional] 
+**mandate_id** | **String** | The ID of the mandate that is related to this recipient. This field is present when a ZAR bank mandate signing is required or has been completed. | [optional] 
 
 ## Code Sample
 
@@ -57,7 +58,8 @@ instance = TransferZero::Recipient.new(requested_amount: 750.0,
                                  output_currency: NGN,
                                  id: 97e79719-06e4-4794-aeeb-d2d9415d983a,
                                  type: person,
-                                 errors: {"phone_number":[{"error":"invalid"}],"documents":[{"error":"blank"}]})
+                                 errors: {"phone_number":[{"error":"invalid"}],"documents":[{"error":"blank"}]},
+                                 mandate_id: 97e79719-06e4-4794-aeeb-d2d9415d983a)
 ```
 
 

data/lib/transferzero-sdk/api/dlocal_balance_api.rb

@@ -0,0 +1,71 @@
+=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 'uri'
+
+module TransferZero
+  class DlocalBalanceApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+
+    # Get dlocal balances
+    # This endpoint retrieves dlocal account balances
+    # @param [Hash] opts the optional parameters
+    # @return [DlocalBalanceResponse]
+    def get_balance(opts = {})
+      data, _status_code, _headers = get_balance_with_http_info(opts)
+      data
+    end
+
+    # Get dlocal balances
+    # This endpoint retrieves dlocal account balances
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(DlocalBalanceResponse, Fixnum, Hash)>] DlocalBalanceResponse data, response status code and response headers
+    def get_balance_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DlocalBalanceApi.get_balance ...'
+      end
+      # resource path
+      local_var_path = '/dlocal/balance'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['AuthorizationKey', 'AuthorizationNonce', 'AuthorizationSecret', 'AuthorizationSignature']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'DlocalBalanceResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DlocalBalanceApi#get_balance\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

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.37.3"
+      @user_agent = "TransferZero-SDK/Ruby/1.37.5"
       @default_headers = {
         'Content-Type' => 'application/json',
         'User-Agent' => @user_agent

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

@@ -0,0 +1,233 @@
+=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 DlocalBalance
+  # The currency of this balance
+  attr_accessor :currency
+
+  # The available balance for the given currency
+  attr_accessor :available_balance
+
+  # The balance at end of previous day
+  attr_accessor :previous_day_closing_balance
+
+  # Current date
+  attr_accessor :current_balance_date
+
+  # Attribute mapping from ruby-style variable name to JSON key.
+  def self.attribute_map
+    {
+      :'currency' => :'currency',
+      :'available_balance' => :'available_balance',
+      :'previous_day_closing_balance' => :'previous_day_closing_balance',
+      :'current_balance_date' => :'current_balance_date'
+    }
+  end
+
+  # Attribute type mapping.
+  def self.openapi_types
+    {
+      :'currency' => :'String',
+      :'available_balance' => :'Float',
+      :'previous_day_closing_balance' => :'Float',
+      :'current_balance_date' => :'String'
+    }
+  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::DlocalBalance` 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::DlocalBalance`. 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?(:'currency')
+      self.currency = attributes[:'currency']
+    end
+
+    if attributes.key?(:'available_balance')
+      self.available_balance = attributes[:'available_balance']
+    end
+
+    if attributes.key?(:'previous_day_closing_balance')
+      self.previous_day_closing_balance = attributes[:'previous_day_closing_balance']
+    end
+
+    if attributes.key?(:'current_balance_date')
+      self.current_balance_date = attributes[:'current_balance_date']
+    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 &&
+        currency == o.currency &&
+        available_balance == o.available_balance &&
+        previous_day_closing_balance == o.previous_day_closing_balance &&
+        current_balance_date == o.current_balance_date
+  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
+    [currency, available_balance, previous_day_closing_balance, current_balance_date].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