fdx-api-sdk-ruby 1.0.0

data/lib/fdx_api/models/payment_initiation_party_name_entity3.rb

@@ -0,0 +1,97 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Details of the name
+  class PaymentInitiationPartyNameEntity3 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Alias name
+    # @return [String]
+    attr_accessor :alias_name
+
+    # Details of the name
+    # @return [Object]
+    attr_accessor :detail
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['alias_name'] = 'aliasName'
+      @_hash['detail'] = 'detail'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        alias_name
+        detail
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(alias_name: SKIP, detail: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @alias_name = alias_name unless alias_name == SKIP
+      @detail = detail unless detail == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      alias_name = hash.key?('aliasName') ? hash['aliasName'] : SKIP
+      detail = hash.key?('detail') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:PaymentInitiationPartyNameEntity3Detail), hash['detail']
+      ) : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      PaymentInitiationPartyNameEntity3.new(alias_name: alias_name,
+                                            detail: detail,
+                                            additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [PaymentInitiationPartyNameEntity3 | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} alias_name: #{@alias_name}, detail: #{@detail}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} alias_name: #{@alias_name.inspect}, detail: #{@detail.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/payment_initiation_party_summary_entity.rb

@@ -0,0 +1,90 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Summary of a payment initiation party
+  class PaymentInitiationPartySummaryEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique identifier of a payment initiation party
+    # @return [String]
+    attr_accessor :payment_initiation_party_id
+
+    # Details of the name
+    # @return [PaymentInitiationPartyNameEntity3]
+    attr_accessor :name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['payment_initiation_party_id'] = 'paymentInitiationPartyId'
+      @_hash['name'] = 'name'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        payment_initiation_party_id
+        name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(payment_initiation_party_id: SKIP, name: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      unless payment_initiation_party_id == SKIP
+        @payment_initiation_party_id =
+          payment_initiation_party_id
+      end
+      @name = name unless name == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      payment_initiation_party_id =
+        hash.key?('paymentInitiationPartyId') ? hash['paymentInitiationPartyId'] : SKIP
+      name = PaymentInitiationPartyNameEntity3.from_hash(hash['name']) if hash['name']
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      PaymentInitiationPartySummaryEntity.new(payment_initiation_party_id: payment_initiation_party_id,
+                                              name: name,
+                                              additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} payment_initiation_party_id: #{@payment_initiation_party_id}, name:"\
+      " #{@name}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} payment_initiation_party_id: #{@payment_initiation_party_id.inspect}, name:"\
+      " #{@name.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/payment_initiation_party_to_payment_method_entity.rb

@@ -0,0 +1,130 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Registration between a payment initiation party and a Payment Method
+  class PaymentInitiationPartyToPaymentMethodEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Registration ID
+    # @return [String]
+    attr_accessor :registration_id
+
+    # Payment method details
+    # @return [PaymentMethodEntity2]
+    attr_accessor :payment_method
+
+    # Account details
+    # @return [Object]
+    attr_accessor :account
+
+    # Address associated with the payment method registration of a payment
+    # initiation party
+    # @return [Array[PaymentDeliveryAddressEntity]]
+    attr_accessor :locations
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['registration_id'] = 'registrationId'
+      @_hash['payment_method'] = 'paymentMethod'
+      @_hash['account'] = 'account'
+      @_hash['locations'] = 'locations'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        registration_id
+        payment_method
+        account
+        locations
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(registration_id: SKIP, payment_method: SKIP, account: SKIP,
+                   locations: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @registration_id = registration_id unless registration_id == SKIP
+      @payment_method = payment_method unless payment_method == SKIP
+      @account = account unless account == SKIP
+      @locations = locations unless locations == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      registration_id =
+        hash.key?('registrationId') ? hash['registrationId'] : SKIP
+      payment_method = PaymentMethodEntity2.from_hash(hash['paymentMethod']) if
+        hash['paymentMethod']
+      account = hash.key?('account') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:PaymentInitiationPartyToPaymentMethodEntityAccount), hash['account']
+      ) : SKIP
+      # Parameter is an array, so we need to iterate through it
+      locations = nil
+      unless hash['locations'].nil?
+        locations = []
+        hash['locations'].each do |structure|
+          locations << (PaymentDeliveryAddressEntity.from_hash(structure) if structure)
+        end
+      end
+
+      locations = SKIP unless hash.key?('locations')
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      PaymentInitiationPartyToPaymentMethodEntity.new(registration_id: registration_id,
+                                                      payment_method: payment_method,
+                                                      account: account,
+                                                      locations: locations,
+                                                      additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [PaymentInitiationPartyToPaymentMethodEntity | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} registration_id: #{@registration_id}, payment_method: #{@payment_method},"\
+      " account: #{@account}, locations: #{@locations}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} registration_id: #{@registration_id.inspect}, payment_method:"\
+      " #{@payment_method.inspect}, account: #{@account.inspect}, locations:"\
+      " #{@locations.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/payment_method_credit_account_entity.rb

@@ -0,0 +1,111 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # A payment initiation party's payment method that credits an account
+  class PaymentMethodCreditAccountEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique identifier of the registration of the destination account to the
+    # payment method associated with a particular payment initiation party
+    # @return [String]
+    attr_accessor :account_registration_id
+
+    # Direct deposit details
+    # @return [DirectDepositEntity]
+    attr_accessor :direct_deposit
+
+    # Destination account details
+    # @return [PaymentGenericAccountEntity1]
+    attr_accessor :destination_account
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_registration_id'] = 'accountRegistrationId'
+      @_hash['direct_deposit'] = 'directDeposit'
+      @_hash['destination_account'] = 'destinationAccount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_registration_id
+        direct_deposit
+        destination_account
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_registration_id: SKIP, direct_deposit: SKIP,
+                   destination_account: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @account_registration_id = account_registration_id unless account_registration_id == SKIP
+      @direct_deposit = direct_deposit unless direct_deposit == SKIP
+      @destination_account = destination_account unless destination_account == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      account_registration_id =
+        hash.key?('accountRegistrationId') ? hash['accountRegistrationId'] : SKIP
+      direct_deposit = DirectDepositEntity.from_hash(hash['directDeposit']) if
+        hash['directDeposit']
+      destination_account = PaymentGenericAccountEntity1.from_hash(hash['destinationAccount']) if
+        hash['destinationAccount']
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      PaymentMethodCreditAccountEntity.new(account_registration_id: account_registration_id,
+                                           direct_deposit: direct_deposit,
+                                           destination_account: destination_account,
+                                           additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [PaymentMethodCreditAccountEntity | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} account_registration_id: #{@account_registration_id}, direct_deposit:"\
+      " #{@direct_deposit}, destination_account: #{@destination_account}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} account_registration_id: #{@account_registration_id.inspect},"\
+      " direct_deposit: #{@direct_deposit.inspect}, destination_account:"\
+      " #{@destination_account.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/payment_method_debit_account_entity.rb

@@ -0,0 +1,100 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # A payment initiation party's payment method that debits an account
+  class PaymentMethodDebitAccountEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique identifier of the registration of the sending account to the
+    # payment method associated with a particular payment initiation party
+    # @return [String]
+    attr_accessor :account_registration_id
+
+    # Sending account details
+    # @return [PaymentGenericAccountEntity2]
+    attr_accessor :sending_account
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_registration_id'] = 'accountRegistrationId'
+      @_hash['sending_account'] = 'sendingAccount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_registration_id
+        sending_account
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_registration_id: SKIP, sending_account: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @account_registration_id = account_registration_id unless account_registration_id == SKIP
+      @sending_account = sending_account unless sending_account == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      account_registration_id =
+        hash.key?('accountRegistrationId') ? hash['accountRegistrationId'] : SKIP
+      sending_account = PaymentGenericAccountEntity2.from_hash(hash['sendingAccount']) if
+        hash['sendingAccount']
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      PaymentMethodDebitAccountEntity.new(account_registration_id: account_registration_id,
+                                          sending_account: sending_account,
+                                          additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [PaymentMethodDebitAccountEntity | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} account_registration_id: #{@account_registration_id}, sending_account:"\
+      " #{@sending_account}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} account_registration_id: #{@account_registration_id.inspect},"\
+      " sending_account: #{@sending_account.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/payment_method_entity.rb

@@ -0,0 +1,139 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # A method of payment, also known as a payment type or payment rail
+  class PaymentMethodEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique identifier of the payment method
+    # @return [String]
+    attr_accessor :payment_method_id
+
+    # Unique identifier code of the payment method rail as documented
+    # internally to the FI. This is aligned with ISO 20022 pain.001,
+    # transaction level
+    # @return [String]
+    attr_accessor :external_local_instrument1_code
+
+    # Unique identifier code of the external clearing system.
+    # This is aligned with ISO 20022 pacs.008 group level. It can be
+    # used to send the payment rail for the payment. ISO has already
+    # listed codes in the fields which indicates the payment rail like
+    # "ACH" for ACH, "ACS" for EFT Payments, "LVT" for Canada LVTS,
+    # "LYX" for Lynx Canada, etc.
+    # @return [String]
+    attr_accessor :external_clearing_system_identification1_code
+
+    # For few examples where the payment rail is not part of the ISO 20022 scope
+    # @return [String]
+    attr_accessor :external_clearing_system_identification1_proprietary
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['payment_method_id'] = 'paymentMethodId'
+      @_hash['external_local_instrument1_code'] =
+        'externalLocalInstrument1Code'
+      @_hash['external_clearing_system_identification1_code'] =
+        'externalClearingSystemIdentification1Code'
+      @_hash['external_clearing_system_identification1_proprietary'] =
+        'externalClearingSystemIdentification1Proprietary'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        payment_method_id
+        external_local_instrument1_code
+        external_clearing_system_identification1_code
+        external_clearing_system_identification1_proprietary
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(payment_method_id: SKIP,
+                   external_local_instrument1_code: SKIP,
+                   external_clearing_system_identification1_code: SKIP,
+                   external_clearing_system_identification1_proprietary: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @payment_method_id = payment_method_id unless payment_method_id == SKIP
+      unless external_local_instrument1_code == SKIP
+        @external_local_instrument1_code =
+          external_local_instrument1_code
+      end
+      unless external_clearing_system_identification1_code == SKIP
+        @external_clearing_system_identification1_code =
+          external_clearing_system_identification1_code
+      end
+      unless external_clearing_system_identification1_proprietary == SKIP
+        @external_clearing_system_identification1_proprietary =
+          external_clearing_system_identification1_proprietary
+      end
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      payment_method_id =
+        hash.key?('paymentMethodId') ? hash['paymentMethodId'] : SKIP
+      external_local_instrument1_code =
+        hash.key?('externalLocalInstrument1Code') ? hash['externalLocalInstrument1Code'] : SKIP
+      external_clearing_system_identification1_code =
+        hash.key?('externalClearingSystemIdentification1Code') ? hash['externalClearingSystemIdentification1Code'] : SKIP
+      external_clearing_system_identification1_proprietary =
+        hash.key?('externalClearingSystemIdentification1Proprietary') ? hash['externalClearingSystemIdentification1Proprietary'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      PaymentMethodEntity.new(payment_method_id: payment_method_id,
+                              external_local_instrument1_code: external_local_instrument1_code,
+                              external_clearing_system_identification1_code: external_clearing_system_identification1_code,
+                              external_clearing_system_identification1_proprietary: external_clearing_system_identification1_proprietary,
+                              additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} payment_method_id: #{@payment_method_id}, external_local_instrument1_code:"\
+      " #{@external_local_instrument1_code}, external_clearing_system_identification1_code:"\
+      " #{@external_clearing_system_identification1_code},"\
+      ' external_clearing_system_identification1_proprietary:'\
+      " #{@external_clearing_system_identification1_proprietary}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} payment_method_id: #{@payment_method_id.inspect},"\
+      " external_local_instrument1_code: #{@external_local_instrument1_code.inspect},"\
+      ' external_clearing_system_identification1_code:'\
+      " #{@external_clearing_system_identification1_code.inspect},"\
+      ' external_clearing_system_identification1_proprietary:'\
+      " #{@external_clearing_system_identification1_proprietary.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end