transferzero-sdk 1.37.6 → 1.37.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3e00d6dbf0674d41081f8f7e3e980e1f9245ae246b3cf0aeec9ed5c3590e3b79
-  data.tar.gz: 42a2a021c4ebeb796eeb0bc558930792fea07072e927661d3da6f8975196db43
+  metadata.gz: 6da945181c803c526929be5ba8cb46489c65282f6ac3bd00d45ad1672104b07b
+  data.tar.gz: f2d4060b0cb95f5a95a63b8804bd6806ba3f5de439d67efb1323d5e41ca07f62
 SHA512:
-  metadata.gz: 4cb98b73c7883f8cb3a63bdce3ffed988f9b12f0f22cf0d8f2d947f61ef156735010c7780efbed39272374fa1eeb00ac6e48cd1911ce9b9b690fc5ef8aadacd4
-  data.tar.gz: c9e94f681e474e1bf2d736e3cacfb773765361ce3d250d5e09ff68342ff36831c33589edcde9439ff32502c755b0ff1fca0100a311915d2f49c1ac1f846f7ec4
+  metadata.gz: fe9d981fd680dfb26d0ba335858c7f08ed28d0363dc54f76304d357da20ed2d8121432b58dfba98fe054b069ab9c5aae192fc8406a11c6e8cd48cd1aaeb7eb35
+  data.tar.gz: f0827b0fe10394b37bfc7be2bb1db8adb572d5489c78691c120021674b8172ef8845868c3b2f67b2383fe35289cbf1b69ccf206227d2546478820f47ec94a1bc

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    transferzero-sdk (1.37.6)
+    transferzero-sdk (1.37.7)
       activesupport (>= 4)
       faraday (~> 1.0, >= 1.0.1)
       json (>= 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.37.6
+- Package version: 1.37.7
 - 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.6.gem
+gem install ./transferzero-sdk-1.37.7.gem
 ```
-(for development, run `gem install --dev ./transferzero-sdk-1.37.6.gem` to install the development dependencies)
+(for development, run `gem install --dev ./transferzero-sdk-1.37.7.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.6'
+    gem 'transferzero-sdk', '~> 1.37.7'
 
 ### Install from Git
 
@@ -119,6 +119,7 @@ Class | Method | HTTP request | Description
 *TransferZero::DocumentsApi* | [**post_documents**](docs/DocumentsApi.md#post_documents) | **POST** /documents | Creating a document
 *TransferZero::LogsApi* | [**get_webhook_log**](docs/LogsApi.md#get_webhook_log) | **GET** /logs/{Webhook Log ID} | Fetch an individual webhook log
 *TransferZero::LogsApi* | [**get_webhook_logs**](docs/LogsApi.md#get_webhook_logs) | **GET** /logs/webhooks | Fetch a list of webhook logs
+*TransferZero::MandatesApi* | [**get_mandate**](docs/MandatesApi.md#get_mandate) | **GET** /mandates/{Mandate ID} | Fetch a single mandate
 *TransferZero::PayinMethodsApi* | [**delete_payin_method**](docs/PayinMethodsApi.md#delete_payin_method) | **DELETE** /payin_methods/{PayinMethod ID} | Deleting a payin method
 *TransferZero::PayinMethodsApi* | [**get_payin_method**](docs/PayinMethodsApi.md#get_payin_method) | **GET** /payin_methods/{PayinMethod ID} | Fetching a payin method
 *TransferZero::PayinMethodsApi* | [**patch_payin_method**](docs/PayinMethodsApi.md#patch_payin_method) | **PATCH** /payin_methods/{PayinMethod ID} | Updating a payin method
@@ -188,6 +189,8 @@ Class | Method | HTTP request | Description
  - [TransferZero::FieldDescription](docs/FieldDescription.md)
  - [TransferZero::FieldSelectValidation](docs/FieldSelectValidation.md)
  - [TransferZero::FieldValidation](docs/FieldValidation.md)
+ - [TransferZero::Mandate](docs/Mandate.md)
+ - [TransferZero::MandateResponse](docs/MandateResponse.md)
  - [TransferZero::Pagination](docs/Pagination.md)
  - [TransferZero::PaginationMeta](docs/PaginationMeta.md)
  - [TransferZero::PayinMethod](docs/PayinMethod.md)

data/docs/Mandate.md

@@ -0,0 +1,29 @@
+# TransferZero::Mandate
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | ID of the mandate | [optional] 
+**status** | **String** | Current state of the mandate.  - `pending` — created, awaiting signing flow - `notified` — recipient has been notified to sign - `signed` — recipient signed; mandate is active - `failed` — signing flow failed (e.g. AVS/CDV rejection) - `bypassed` — administratively bypassed for an inward AZA payment | [optional] 
+**type_id** | **Integer** | Numeric beneficiary type identifier. Identifies whether the mandate was issued for a natural person, sole proprietor, partnership, company, etc. | [optional] 
+**reference** | **String** | Human-readable reference assigned to the mandate at creation. | [optional] 
+**signed_at** | **DateTime** | Timestamp when the mandate transitioned to `signed`. `null` for mandates that are pending, notified, failed, or bypassed. | [optional] 
+**created_at** | **DateTime** | Timestamp when the mandate was created. | [optional] 
+**updated_at** | **DateTime** | Timestamp when the mandate was last updated. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::Mandate.new(id: bf9ff782-e182-45ac-abea-5bce83ad6670,
+                                 status: signed,
+                                 type_id: 1,
+                                 reference: 74a07630,
+                                 signed_at: null,
+                                 created_at: null,
+                                 updated_at: null)
+```
+
+

data/docs/MandateResponse.md

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

data/docs/MandatesApi.md

@@ -0,0 +1,70 @@
+# TransferZero::MandatesApi
+
+All URIs are relative to *https://api-sandbox.transferzero.com/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_mandate**](MandatesApi.md#get_mandate) | **GET** /mandates/{Mandate ID} | Fetch a single mandate
+
+
+# **get_mandate**
+> MandateResponse get_mandate(mandate_id)
+
+Fetch a single mandate
+
+Finds and returns a Mandate created within the current calendar year, where the mandate is linked to a Recipient owned by the authenticated API key.  Returns 404 if the mandate is not owned by the API key or was not issued in the current calendar year — mandates are only valid for the year in which they were issued.
+
+### Example
+```ruby
+# load the gem
+require 'transferzero-sdk'
+
+api_instance = TransferZero::MandatesApi.new
+
+
+begin
+  #Fetch a single mandate
+  result = api_instance.get_mandate(mandate_id)
+  p result
+rescue TransferZero::ApiError => e
+  if e.validation_error
+    puts "WARN: Validation error occured when calling the endpoint"
+    result = e.response_object("MandateResponse")
+    p result
+  else
+    puts "Exception when calling MandatesApi->get_mandate: #{e}"
+  end
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **mandate_id** | [**String**](.md)| ID of the mandate.  Example: `/v1/mandates/bf9ff782-e182-45ac-abea-5bce83ad6670` | 
+
+### Return type
+
+[**MandateResponse**](MandateResponse.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/lib/transferzero-sdk/api/mandates_api.rb

@@ -0,0 +1,77 @@
+=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 MandatesApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+
+    # Fetch a single mandate
+    # Finds and returns a Mandate created within the current calendar year, where the mandate is linked to a Recipient owned by the authenticated API key.  Returns 404 if the mandate is not owned by the API key or was not issued in the current calendar year — mandates are only valid for the year in which they were issued.
+    # @param mandate_id ID of the mandate.  Example: `/v1/mandates/bf9ff782-e182-45ac-abea-5bce83ad6670`
+    # @param [Hash] opts the optional parameters
+    # @return [MandateResponse]
+    def get_mandate(mandate_id, opts = {})
+      data, _status_code, _headers = get_mandate_with_http_info(mandate_id, opts)
+      data
+    end
+
+    # Fetch a single mandate
+    # Finds and returns a Mandate created within the current calendar year, where the mandate is linked to a Recipient owned by the authenticated API key.  Returns 404 if the mandate is not owned by the API key or was not issued in the current calendar year — mandates are only valid for the year in which they were issued.
+    # @param mandate_id ID of the mandate.  Example: `/v1/mandates/bf9ff782-e182-45ac-abea-5bce83ad6670`
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(MandateResponse, Fixnum, Hash)>] MandateResponse data, response status code and response headers
+    def get_mandate_with_http_info(mandate_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MandatesApi.get_mandate ...'
+      end
+      # verify the required parameter 'mandate_id' is set
+      if @api_client.config.client_side_validation && mandate_id.nil?
+        fail ArgumentError, "Missing the required parameter 'mandate_id' when calling MandatesApi.get_mandate"
+      end
+      # resource path
+      local_var_path = '/mandates/{Mandate ID}'.sub('{' + 'Mandate ID' + '}', mandate_id.to_s)
+
+      # 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 => 'MandateResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: MandatesApi#get_mandate\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.6"
+      @user_agent = "TransferZero-SDK/Ruby/1.37.7"
       @default_headers = {
         'Content-Type' => 'application/json',
         'User-Agent' => @user_agent

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

@@ -0,0 +1,298 @@
+=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
+# A Mandate authorises payouts to a Recipient. Mandates are issued per calendar year and must be in a `signed` (or `bypassed`) state before the linked Recipient can receive a payout.
+class Mandate
+  # ID of the mandate
+  attr_accessor :id
+
+  # Current state of the mandate.  - `pending` — created, awaiting signing flow - `notified` — recipient has been notified to sign - `signed` — recipient signed; mandate is active - `failed` — signing flow failed (e.g. AVS/CDV rejection) - `bypassed` — administratively bypassed for an inward AZA payment
+  attr_accessor :status
+
+  # Numeric beneficiary type identifier. Identifies whether the mandate was issued for a natural person, sole proprietor, partnership, company, etc.
+  attr_accessor :type_id
+
+  # Human-readable reference assigned to the mandate at creation.
+  attr_accessor :reference
+
+  # Timestamp when the mandate transitioned to `signed`. `null` for mandates that are pending, notified, failed, or bypassed.
+  attr_accessor :signed_at
+
+  # Timestamp when the mandate was created.
+  attr_accessor :created_at
+
+  # Timestamp when the mandate was last updated.
+  attr_accessor :updated_at
+
+  class EnumAttributeValidator
+    attr_reader :datatype
+    attr_reader :allowable_values
+
+    def initialize(datatype, allowable_values)
+      @allowable_values = allowable_values.map do |value|
+        case datatype.to_s
+        when /Integer/i
+          value.to_i
+        when /Float/i
+          value.to_f
+        else
+          value
+        end
+      end
+    end
+
+    def valid?(value)
+      !value || allowable_values.include?(value)
+    end
+  end
+
+  # Attribute mapping from ruby-style variable name to JSON key.
+  def self.attribute_map
+    {
+      :'id' => :'id',
+      :'status' => :'status',
+      :'type_id' => :'type_id',
+      :'reference' => :'reference',
+      :'signed_at' => :'signed_at',
+      :'created_at' => :'created_at',
+      :'updated_at' => :'updated_at'
+    }
+  end
+
+  # Attribute type mapping.
+  def self.openapi_types
+    {
+      :'id' => :'String',
+      :'status' => :'String',
+      :'type_id' => :'Integer',
+      :'reference' => :'String',
+      :'signed_at' => :'DateTime',
+      :'created_at' => :'DateTime',
+      :'updated_at' => :'DateTime'
+    }
+  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::Mandate` 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::Mandate`. 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?(:'id')
+      self.id = attributes[:'id']
+    end
+
+    if attributes.key?(:'status')
+      self.status = attributes[:'status']
+    end
+
+    if attributes.key?(:'type_id')
+      self.type_id = attributes[:'type_id']
+    end
+
+    if attributes.key?(:'reference')
+      self.reference = attributes[:'reference']
+    end
+
+    if attributes.key?(:'signed_at')
+      self.signed_at = attributes[:'signed_at']
+    end
+
+    if attributes.key?(:'created_at')
+      self.created_at = attributes[:'created_at']
+    end
+
+    if attributes.key?(:'updated_at')
+      self.updated_at = attributes[:'updated_at']
+    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?
+    status_validator = EnumAttributeValidator.new('String', ["pending", "notified", "signed", "failed", "bypassed"])
+    return false unless status_validator.valid?(@status)
+    true
+  end
+
+  # Custom attribute writer method checking allowed values (enum).
+  # @param [Object] status Object to be assigned
+  def status=(status)
+    validator = EnumAttributeValidator.new('String', ["pending", "notified", "signed", "failed", "bypassed"])
+    unless validator.valid?(status) || status.empty?
+      fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
+    end
+    @status = status
+  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 &&
+        id == o.id &&
+        status == o.status &&
+        type_id == o.type_id &&
+        reference == o.reference &&
+        signed_at == o.signed_at &&
+        created_at == o.created_at &&
+        updated_at == o.updated_at
+  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
+    [id, status, type_id, reference, signed_at, created_at, updated_at].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

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

@@ -0,0 +1,202 @@
+=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 MandateResponse
+  attr_accessor :object
+
+  # Attribute mapping from ruby-style variable name to JSON key.
+  def self.attribute_map
+    {
+      :'object' => :'object'
+    }
+  end
+
+  # Attribute type mapping.
+  def self.openapi_types
+    {
+      :'object' => :'Mandate'
+    }
+  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::MandateResponse` 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::MandateResponse`. 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?(:'object')
+      self.object = attributes[:'object']
+    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 &&
+        object == o.object
+  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
+    [object].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

data/lib/transferzero-sdk/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 4.0.0-beta3
 =end
 
 module TransferZero
-  VERSION = '1.37.6'
+  VERSION = '1.37.7'
 end

data/lib/transferzero-sdk.rb

@@ -49,6 +49,8 @@ require 'transferzero-sdk/models/error_status'
 require 'transferzero-sdk/models/field_description'
 require 'transferzero-sdk/models/field_select_validation'
 require 'transferzero-sdk/models/field_validation'
+require 'transferzero-sdk/models/mandate'
+require 'transferzero-sdk/models/mandate_response'
 require 'transferzero-sdk/models/pagination'
 require 'transferzero-sdk/models/pagination_meta'
 require 'transferzero-sdk/models/payin_method'
@@ -158,6 +160,7 @@ require 'transferzero-sdk/api/currency_info_api'
 require 'transferzero-sdk/api/dlocal_balance_api'
 require 'transferzero-sdk/api/documents_api'
 require 'transferzero-sdk/api/logs_api'
+require 'transferzero-sdk/api/mandates_api'
 require 'transferzero-sdk/api/payin_methods_api'
 require 'transferzero-sdk/api/payment_methods_api'
 require 'transferzero-sdk/api/payout_methods_api'

data/spec/api/mandates_api_spec.rb

@@ -0,0 +1,47 @@
+=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 'spec_helper'
+require 'json'
+
+# Unit tests for TransferZero::MandatesApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'MandatesApi' do
+  before do
+    # run before each test
+    @api_instance = TransferZero::MandatesApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of MandatesApi' do
+    it 'should create an instance of MandatesApi' do
+      expect(@api_instance).to be_instance_of(TransferZero::MandatesApi)
+    end
+  end
+
+  # unit tests for get_mandate
+  # Fetch a single mandate
+  # Finds and returns a Mandate created within the current calendar year, where the mandate is linked to a Recipient owned by the authenticated API key.  Returns 404 if the mandate is not owned by the API key or was not issued in the current calendar year — mandates are only valid for the year in which they were issued.
+  # @param mandate_id ID of the mandate.  Example: `/v1/mandates/bf9ff782-e182-45ac-abea-5bce83ad6670`
+  # @param [Hash] opts the optional parameters
+  # @return [MandateResponse]
+  describe 'get_mandate test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/models/mandate_response_spec.rb

@@ -0,0 +1,41 @@
+=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 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for TransferZero::MandateResponse
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'MandateResponse' do
+  before do
+    # run before each test
+    @instance = TransferZero::MandateResponse.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of MandateResponse' do
+    it 'should create an instance of MandateResponse' do
+      expect(@instance).to be_instance_of(TransferZero::MandateResponse)
+    end
+  end
+  describe 'test attribute "object"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/models/mandate_spec.rb

@@ -0,0 +1,81 @@
+=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 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for TransferZero::Mandate
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'Mandate' do
+  before do
+    # run before each test
+    @instance = TransferZero::Mandate.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of Mandate' do
+    it 'should create an instance of Mandate' do
+      expect(@instance).to be_instance_of(TransferZero::Mandate)
+    end
+  end
+  describe 'test attribute "id"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "status"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+      # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["pending", "notified", "signed", "failed", "bypassed"])
+      # validator.allowable_values.each do |value|
+      #   expect { @instance.status = value }.not_to raise_error
+      # end
+    end
+  end
+
+  describe 'test attribute "type_id"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "reference"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "signed_at"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "created_at"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "updated_at"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: transferzero-sdk
 version: !ruby/object:Gem::Version
-  version: 1.37.6
+  version: 1.37.7
 platform: ruby
 authors:
 - TransferZero
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-05-11 00:00:00.000000000 Z
+date: 2026-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -134,6 +134,9 @@ files:
 - docs/FieldSelectValidation.md
 - docs/FieldValidation.md
 - docs/LogsApi.md
+- docs/Mandate.md
+- docs/MandateResponse.md
+- docs/MandatesApi.md
 - docs/Pagination.md
 - docs/PaginationMeta.md
 - docs/PayinMethod.md
@@ -258,6 +261,7 @@ files:
 - lib/transferzero-sdk/api/dlocal_balance_api.rb
 - lib/transferzero-sdk/api/documents_api.rb
 - lib/transferzero-sdk/api/logs_api.rb
+- lib/transferzero-sdk/api/mandates_api.rb
 - lib/transferzero-sdk/api/payin_methods_api.rb
 - lib/transferzero-sdk/api/payment_methods_api.rb
 - lib/transferzero-sdk/api/payout_methods_api.rb
@@ -304,6 +308,8 @@ files:
 - lib/transferzero-sdk/models/field_description.rb
 - lib/transferzero-sdk/models/field_select_validation.rb
 - lib/transferzero-sdk/models/field_validation.rb
+- lib/transferzero-sdk/models/mandate.rb
+- lib/transferzero-sdk/models/mandate_response.rb
 - lib/transferzero-sdk/models/pagination.rb
 - lib/transferzero-sdk/models/pagination_meta.rb
 - lib/transferzero-sdk/models/payin_method.rb
@@ -419,6 +425,7 @@ files:
 - spec/api/dlocal_balance_api_spec.rb
 - spec/api/documents_api_spec.rb
 - spec/api/logs_api_spec.rb
+- spec/api/mandates_api_spec.rb
 - spec/api/payin_methods_api_spec.rb
 - spec/api/payment_methods_api_spec.rb
 - spec/api/payout_methods_api_spec.rb
@@ -463,6 +470,8 @@ files:
 - spec/models/field_description_spec.rb
 - spec/models/field_select_validation_spec.rb
 - spec/models/field_validation_spec.rb
+- spec/models/mandate_response_spec.rb
+- spec/models/mandate_spec.rb
 - spec/models/pagination_meta_spec.rb
 - spec/models/pagination_spec.rb
 - spec/models/payin_method_details_btc_spec.rb
@@ -603,6 +612,7 @@ test_files:
 - spec/api/dlocal_balance_api_spec.rb
 - spec/api/payment_methods_api_spec.rb
 - spec/api/transactions_api_spec.rb
+- spec/api/mandates_api_spec.rb
 - spec/api/recipients_api_spec.rb
 - spec/api/logs_api_spec.rb
 - spec/api/documents_api_spec.rb
@@ -635,6 +645,7 @@ test_files:
 - spec/models/sender_request_spec.rb
 - spec/models/sender_webhook_spec.rb
 - spec/models/webhook_log_metadata_request_spec.rb
+- spec/models/mandate_spec.rb
 - spec/models/currency_exchange_list_response_spec.rb
 - spec/models/field_validation_spec.rb
 - spec/models/account_response_spec.rb
@@ -656,6 +667,7 @@ test_files:
 - spec/models/transaction_response_existing_spec.rb
 - spec/models/recipient_state_reason_details_spec.rb
 - spec/models/currency_opposite_all_of_spec.rb
+- spec/models/mandate_response_spec.rb
 - spec/models/proof_of_payment_spec.rb
 - spec/models/payin_method_state_spec.rb
 - spec/models/payout_method_details_iban_spec.rb