fdx-api-sdk-ruby 1.0.0

data/lib/fdx_api/models/payment_method_entity2.rb

@@ -0,0 +1,149 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Payment method details
+  class PaymentMethodEntity2 < 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.
+      PaymentMethodEntity2.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
+
+    # Validates an instance of the object from a given value.
+    # @param [PaymentMethodEntity2 | 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} 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

data/lib/fdx_api/models/payment_method_id.rb

@@ -0,0 +1,96 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # FI's unique identifier for the method of payment
+  class PaymentMethodId < 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
+
+    # 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
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        payment_method_id
+        external_local_instrument1_code
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(payment_method_id: SKIP,
+                   external_local_instrument1_code: 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
+      @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
+
+      # 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.
+      PaymentMethodId.new(payment_method_id: payment_method_id,
+                          external_local_instrument1_code: external_local_instrument1_code,
+                          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}, 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},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/payment_method_system_code.rb

@@ -0,0 +1,90 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Unique identifier code of the external clearing system. Aligned with ISO
+  # 20022 pacs.008 group level
+  class PaymentMethodSystemCode < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # 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
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['external_clearing_system_identification1_code'] =
+        'externalClearingSystemIdentification1Code'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        external_clearing_system_identification1_code
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(external_clearing_system_identification1_code: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      unless external_clearing_system_identification1_code == SKIP
+        @external_clearing_system_identification1_code =
+          external_clearing_system_identification1_code
+      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.
+      external_clearing_system_identification1_code =
+        hash.key?('externalClearingSystemIdentification1Code') ? hash['externalClearingSystemIdentification1Code'] : 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.
+      PaymentMethodSystemCode.new(external_clearing_system_identification1_code: external_clearing_system_identification1_code,
+                                  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} external_clearing_system_identification1_code:"\
+      " #{@external_clearing_system_identification1_code}, 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} external_clearing_system_identification1_code:"\
+      " #{@external_clearing_system_identification1_code.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/payment_method_system_proprietary.rb

@@ -0,0 +1,85 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Proprietary identifier of the external clearing system when the payment rail
+  # is not part of the ISO 20022 scope
+  class PaymentMethodSystemProprietary < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # 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['external_clearing_system_identification1_proprietary'] =
+        'externalClearingSystemIdentification1Proprietary'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        external_clearing_system_identification1_proprietary
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(external_clearing_system_identification1_proprietary: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      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.
+      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.
+      PaymentMethodSystemProprietary.new(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} 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} external_clearing_system_identification1_proprietary:"\
+      " #{@external_clearing_system_identification1_proprietary.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/payment_network_identifier_type.rb

@@ -0,0 +1,23 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Suggested values for Payment Initiation Identifier Type
+  class PaymentNetworkIdentifierType
+    PAYMENT_NETWORK_IDENTIFIER_TYPE = [
+      # TODO: Write general description for ACCOUNT_NUMBER
+      ACCOUNT_NUMBER = 'ACCOUNT_NUMBER'.freeze,
+
+      # TODO: Write general description for TOKENIZED_ACCOUNT_NUMBER
+      TOKENIZED_ACCOUNT_NUMBER = 'TOKENIZED_ACCOUNT_NUMBER'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/payment_network_identifier_type1.rb

@@ -0,0 +1,23 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Type of identifier
+  class PaymentNetworkIdentifierType1
+    PAYMENT_NETWORK_IDENTIFIER_TYPE1 = [
+      # TODO: Write general description for ACCOUNT_NUMBER
+      ACCOUNT_NUMBER = 'ACCOUNT_NUMBER'.freeze,
+
+      # TODO: Write general description for TOKENIZED_ACCOUNT_NUMBER
+      TOKENIZED_ACCOUNT_NUMBER = 'TOKENIZED_ACCOUNT_NUMBER'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/payment_network_identifier_type3.rb

@@ -0,0 +1,23 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Type of identifier, ACCOUNT_NUMBER or TOKENIZED_ACCOUNT_NUMBER
+  class PaymentNetworkIdentifierType3
+    PAYMENT_NETWORK_IDENTIFIER_TYPE3 = [
+      # TODO: Write general description for ACCOUNT_NUMBER
+      ACCOUNT_NUMBER = 'ACCOUNT_NUMBER'.freeze,
+
+      # TODO: Write general description for TOKENIZED_ACCOUNT_NUMBER
+      TOKENIZED_ACCOUNT_NUMBER = 'TOKENIZED_ACCOUNT_NUMBER'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/payment_network_supported_by_account.rb

@@ -0,0 +1,161 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # This provides details required to execute a transaction against the account
+  # within the payment network
+  class PaymentNetworkSupportedByAccount < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Bank identifier used by the payment network. Typically the 9-digit routing
+    # transit number (RTN) associated with the account number at a US
+    # institution, or the 3-digit Institution (FID) and 5-digit Transit numbers
+    # for Canadian institutions, including leading zeroes
+    # @return [String]
+    attr_accessor :bank_id
+
+    # The number used to identify the account within the payment network. If
+    # identifierType is ACCOUNT_NUMBER, this is the account number; if
+    # identifierType is TOKENIZED_ACCOUNT_NUMBER, this is a tokenized account
+    # number
+    # @return [String]
+    attr_accessor :identifier
+
+    # Type of identifier, ACCOUNT_NUMBER or TOKENIZED_ACCOUNT_NUMBER
+    # @return [PaymentNetworkIdentifierType3]
+    attr_accessor :identifier_type
+
+    # Type of Canadian or U.S. payment network, CA_ACSS, CA_LVTS, US_ACH,
+    # US_CHIPS, US_FEDWIRE, US_RTP
+    # @return [PaymentNetworkType2]
+    attr_accessor :type
+
+    # Can transfer funds to the account using this information
+    # @return [TrueClass | FalseClass]
+    attr_accessor :transfer_in
+
+    # Can transfer funds from the account using this information
+    # @return [TrueClass | FalseClass]
+    attr_accessor :transfer_out
+
+    # Can receive Request for Payments
+    # @return [TrueClass | FalseClass]
+    attr_accessor :supports_request_for_payment
+
+    # The amount limits for transfers
+    # @return [IncomingAndOutgoingTransferLimits2]
+    attr_accessor :transfer_limits
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['bank_id'] = 'bankId'
+      @_hash['identifier'] = 'identifier'
+      @_hash['identifier_type'] = 'identifierType'
+      @_hash['type'] = 'type'
+      @_hash['transfer_in'] = 'transferIn'
+      @_hash['transfer_out'] = 'transferOut'
+      @_hash['supports_request_for_payment'] = 'supportsRequestForPayment'
+      @_hash['transfer_limits'] = 'transferLimits'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        bank_id
+        identifier
+        identifier_type
+        type
+        transfer_in
+        transfer_out
+        supports_request_for_payment
+        transfer_limits
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(bank_id: SKIP, identifier: SKIP, identifier_type: SKIP,
+                   type: SKIP, transfer_in: SKIP, transfer_out: SKIP,
+                   supports_request_for_payment: SKIP, transfer_limits: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @bank_id = bank_id unless bank_id == SKIP
+      @identifier = identifier unless identifier == SKIP
+      @identifier_type = identifier_type unless identifier_type == SKIP
+      @type = type unless type == SKIP
+      @transfer_in = transfer_in unless transfer_in == SKIP
+      @transfer_out = transfer_out unless transfer_out == SKIP
+      unless supports_request_for_payment == SKIP
+        @supports_request_for_payment =
+          supports_request_for_payment
+      end
+      @transfer_limits = transfer_limits unless transfer_limits == 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.
+      bank_id = hash.key?('bankId') ? hash['bankId'] : SKIP
+      identifier = hash.key?('identifier') ? hash['identifier'] : SKIP
+      identifier_type =
+        hash.key?('identifierType') ? hash['identifierType'] : SKIP
+      type = hash.key?('type') ? hash['type'] : SKIP
+      transfer_in = hash.key?('transferIn') ? hash['transferIn'] : SKIP
+      transfer_out = hash.key?('transferOut') ? hash['transferOut'] : SKIP
+      supports_request_for_payment =
+        hash.key?('supportsRequestForPayment') ? hash['supportsRequestForPayment'] : SKIP
+      transfer_limits = IncomingAndOutgoingTransferLimits2.from_hash(hash['transferLimits']) if
+        hash['transferLimits']
+
+      # 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.
+      PaymentNetworkSupportedByAccount.new(bank_id: bank_id,
+                                           identifier: identifier,
+                                           identifier_type: identifier_type,
+                                           type: type,
+                                           transfer_in: transfer_in,
+                                           transfer_out: transfer_out,
+                                           supports_request_for_payment: supports_request_for_payment,
+                                           transfer_limits: transfer_limits,
+                                           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} bank_id: #{@bank_id}, identifier: #{@identifier}, identifier_type:"\
+      " #{@identifier_type}, type: #{@type}, transfer_in: #{@transfer_in}, transfer_out:"\
+      " #{@transfer_out}, supports_request_for_payment: #{@supports_request_for_payment},"\
+      " transfer_limits: #{@transfer_limits}, 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} bank_id: #{@bank_id.inspect}, identifier: #{@identifier.inspect},"\
+      " identifier_type: #{@identifier_type.inspect}, type: #{@type.inspect}, transfer_in:"\
+      " #{@transfer_in.inspect}, transfer_out: #{@transfer_out.inspect},"\
+      " supports_request_for_payment: #{@supports_request_for_payment.inspect}, transfer_limits:"\
+      " #{@transfer_limits.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end