transferzero-sdk 1.16.1 → 1.19.1

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

@@ -0,0 +1,235 @@
+=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 StateReasonDetails
+  # Status code of transaction
+  attr_accessor :code
+
+  # Main category of status code, it could be paid, unknown, pickupable, temporary_error, recipient_error, sender_error, sender_action_required
+  attr_accessor :category
+
+  # Tiered messages
+  attr_accessor :messages
+
+  # Public, human readable, detailed error message
+  attr_accessor :description
+
+  # Attribute mapping from ruby-style variable name to JSON key.
+  def self.attribute_map
+    {
+      :'code' => :'code',
+      :'category' => :'category',
+      :'messages' => :'messages',
+      :'description' => :'description'
+    }
+  end
+
+  # Attribute type mapping.
+  def self.openapi_types
+    {
+      :'code' => :'String',
+      :'category' => :'String',
+      :'messages' => :'Array<String>',
+      :'description' => :'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::StateReasonDetails` 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::StateReasonDetails`. 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?(:'code')
+      self.code = attributes[:'code']
+    end
+
+    if attributes.key?(:'category')
+      self.category = attributes[:'category']
+    end
+
+    if attributes.key?(:'messages')
+      if (value = attributes[:'messages']).is_a?(Array)
+        self.messages = value
+      end
+    end
+
+    if attributes.key?(:'description')
+      self.description = attributes[:'description']
+    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 &&
+        code == o.code &&
+        category == o.category &&
+        messages == o.messages &&
+        description == o.description
+  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
+    [code, category, messages, description].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.16.1'
+  VERSION = '1.19.1'
 end

data/lib/transferzero-sdk.rb

@@ -56,6 +56,9 @@ require 'transferzero-sdk/models/payin_method_details_btc'
 require 'transferzero-sdk/models/payin_method_details_mobile'
 require 'transferzero-sdk/models/payin_method_details_ngn_bank'
 require 'transferzero-sdk/models/payin_method_request'
+require 'transferzero-sdk/models/payin_method_response'
+require 'transferzero-sdk/models/payin_method_state'
+require 'transferzero-sdk/models/payin_method_ux_flow'
 require 'transferzero-sdk/models/payment_method'
 require 'transferzero-sdk/models/payment_method_list_response'
 require 'transferzero-sdk/models/payment_method_opposite'
@@ -69,6 +72,7 @@ require 'transferzero-sdk/models/payout_method_details_balance'
 require 'transferzero-sdk/models/payout_method_details_gbp_bank'
 require 'transferzero-sdk/models/payout_method_details_ghs_bank'
 require 'transferzero-sdk/models/payout_method_details_ghs_cash'
+require 'transferzero-sdk/models/payout_method_details_gnf_mobile'
 require 'transferzero-sdk/models/payout_method_details_iban'
 require 'transferzero-sdk/models/payout_method_details_kes_bank'
 require 'transferzero-sdk/models/payout_method_details_kes_mobile'
@@ -77,6 +81,7 @@ require 'transferzero-sdk/models/payout_method_details_mobile'
 require 'transferzero-sdk/models/payout_method_details_ngn_bank'
 require 'transferzero-sdk/models/payout_method_details_usd_bank'
 require 'transferzero-sdk/models/payout_method_details_usd_cash'
+require 'transferzero-sdk/models/payout_method_details_xaf_mobile'
 require 'transferzero-sdk/models/payout_method_details_xof_bank'
 require 'transferzero-sdk/models/payout_method_details_xof_cash'
 require 'transferzero-sdk/models/payout_method_details_xof_mobile'
@@ -89,6 +94,7 @@ require 'transferzero-sdk/models/payout_method_mobile_provider_enum'
 require 'transferzero-sdk/models/payout_method_nature_of_business_enum'
 require 'transferzero-sdk/models/payout_method_request'
 require 'transferzero-sdk/models/payout_method_response'
+require 'transferzero-sdk/models/payout_method_transfer_reason_enum'
 require 'transferzero-sdk/models/payout_method_webhook'
 require 'transferzero-sdk/models/politically_exposed_person'
 require 'transferzero-sdk/models/proof_of_payment'
@@ -108,6 +114,7 @@ require 'transferzero-sdk/models/sender_response_existing'
 require 'transferzero-sdk/models/sender_response_meta'
 require 'transferzero-sdk/models/sender_state'
 require 'transferzero-sdk/models/sender_webhook'
+require 'transferzero-sdk/models/state_reason_details'
 require 'transferzero-sdk/models/transaction'
 require 'transferzero-sdk/models/transaction_list_response'
 require 'transferzero-sdk/models/transaction_request'
@@ -139,6 +146,7 @@ require 'transferzero-sdk/api/accounts_api'
 require 'transferzero-sdk/api/currency_info_api'
 require 'transferzero-sdk/api/documents_api'
 require 'transferzero-sdk/api/logs_api'
+require 'transferzero-sdk/api/payin_methods_api'
 require 'transferzero-sdk/api/payment_methods_api'
 require 'transferzero-sdk/api/payout_methods_api'
 require 'transferzero-sdk/api/recipients_api'

data/spec/api/payin_methods_api_spec.rb

@@ -0,0 +1,84 @@
+=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::PayinMethodsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'PayinMethodsApi' do
+  before do
+    # run before each test
+    @api_instance = TransferZero::PayinMethodsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of PayinMethodsApi' do
+    it 'should create an instance of PayinMethodsApi' do
+      expect(@api_instance).to be_instance_of(TransferZero::PayinMethodsApi)
+    end
+  end
+
+  # unit tests for delete_payin_method
+  # Deleting a payin method
+  # Initiates a cancellation request for the specified payin method
+  # @param payin_method_id ID of the payin method to delete.  Example: `/v1/payin_methods/bf9ff782-e182-45ac-abea-5bce83ad6670`
+  # @param [Hash] opts the optional parameters
+  # @return [PayinMethodResponse]
+  describe 'delete_payin_method test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_payin_method
+  # Fetching a payin method
+  # Show a payin method by id
+  # @param payin_method_id ID of the payin method to get.  Example: `/v1/payin_methods/bf9ff782-e182-45ac-abea-5bce83ad6670`
+  # @param [Hash] opts the optional parameters
+  # @return [PayinMethodResponse]
+  describe 'get_payin_method test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for patch_payin_method
+  # Updating a payin method
+  # Updates the payin method specified in the URL path.
+  # @param payin_method_id ID of the payin method to get.  Example: `/v1/payin_methods/bf9ff782-e182-45ac-abea-5bce83ad6670`
+  # @param payin_method 
+  # @param [Hash] opts the optional parameters
+  # @return [PayinMethodResponse]
+  describe 'patch_payin_method test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for retry_payin_method
+  # Retries PayinMethod
+  # Retries the collection process for the payin method.  Please note only payin methods in `error` state can be retried.
+  # @param payin_method_id ID of the payin method whose collection process should be retried  Example: `/v1/payin_methods/9d4d7b73-a94c-4979-ab57-09074fd55d33/retry`
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'retry_payin_method 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/payin_method_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::PayinMethodResponse
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'PayinMethodResponse' do
+  before do
+    # run before each test
+    @instance = TransferZero::PayinMethodResponse.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of PayinMethodResponse' do
+    it 'should create an instance of PayinMethodResponse' do
+      expect(@instance).to be_instance_of(TransferZero::PayinMethodResponse)
+    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/payin_method_state_spec.rb

@@ -0,0 +1,35 @@
+=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::PayinMethodState
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'PayinMethodState' do
+  before do
+    # run before each test
+    @instance = TransferZero::PayinMethodState.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of PayinMethodState' do
+    it 'should create an instance of PayinMethodState' do
+      expect(@instance).to be_instance_of(TransferZero::PayinMethodState)
+    end
+  end
+end

data/spec/models/payin_method_ux_flow_spec.rb

@@ -0,0 +1,35 @@
+=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::PayinMethodUxFlow
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'PayinMethodUxFlow' do
+  before do
+    # run before each test
+    @instance = TransferZero::PayinMethodUxFlow.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of PayinMethodUxFlow' do
+    it 'should create an instance of PayinMethodUxFlow' do
+      expect(@instance).to be_instance_of(TransferZero::PayinMethodUxFlow)
+    end
+  end
+end

data/spec/models/payout_method_details_gnf_mobile_spec.rb

@@ -0,0 +1,59 @@
+=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::PayoutMethodDetailsGNFMobile
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'PayoutMethodDetailsGNFMobile' do
+  before do
+    # run before each test
+    @instance = TransferZero::PayoutMethodDetailsGNFMobile.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of PayoutMethodDetailsGNFMobile' do
+    it 'should create an instance of PayoutMethodDetailsGNFMobile' do
+      expect(@instance).to be_instance_of(TransferZero::PayoutMethodDetailsGNFMobile)
+    end
+  end
+  describe 'test attribute "first_name"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "last_name"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "phone_number"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "mobile_provider"' 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/payout_method_details_xaf_mobile_spec.rb

@@ -0,0 +1,65 @@
+=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::PayoutMethodDetailsXAFMobile
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'PayoutMethodDetailsXAFMobile' do
+  before do
+    # run before each test
+    @instance = TransferZero::PayoutMethodDetailsXAFMobile.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of PayoutMethodDetailsXAFMobile' do
+    it 'should create an instance of PayoutMethodDetailsXAFMobile' do
+      expect(@instance).to be_instance_of(TransferZero::PayoutMethodDetailsXAFMobile)
+    end
+  end
+  describe 'test attribute "first_name"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "last_name"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "phone_number"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "mobile_provider"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "country"' 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/payout_method_transfer_reason_enum_spec.rb

@@ -0,0 +1,35 @@
+=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::PayoutMethodTransferReasonEnum
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'PayoutMethodTransferReasonEnum' do
+  before do
+    # run before each test
+    @instance = TransferZero::PayoutMethodTransferReasonEnum.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of PayoutMethodTransferReasonEnum' do
+    it 'should create an instance of PayoutMethodTransferReasonEnum' do
+      expect(@instance).to be_instance_of(TransferZero::PayoutMethodTransferReasonEnum)
+    end
+  end
+end