fdx-apimatic-sdk 0.0.1

data/lib/fdx_v660_api/models/remittance.rb

@@ -0,0 +1,175 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Remittance details for a transaction
+  class Remittance < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # An ID for the payment from the external payment rail. For SWIFT wires this
+    # will be Unique End-to-End Transaction Reference (UETR)
+    # @return [String]
+    attr_accessor :payment_id
+
+    # The payment rail of the transaction, such as `SWIFT_WIRE`
+    # @return [PaymentNetworkType1]
+    attr_accessor :type
+
+    # Date that the payment is executed
+    # @return [Date]
+    attr_accessor :value_date
+
+    # Status of the transaction from the payment rail, including one of
+    # `IN_PROGRESS`, `FAILED`, `CANCELLED`, `REJECTED` or `COMPLETED`
+    # @return [RemittanceStatus2]
+    attr_accessor :payment_status
+
+    # Exchange rate used to convert the instructed amount, if the source
+    # currency is different from the received currency
+    # @return [Float]
+    attr_accessor :exchange_rate
+
+    # The ISO 4217 code of the currency of the source account
+    # @return [Iso4217CurrencyCode2]
+    attr_accessor :source_currency
+
+    # Identification of the debtor party to the transaction for the funds
+    # source, can include `accountNumber` which is sensitive data and should be
+    # encrypted
+    # @return [RemittanceParty3]
+    attr_accessor :debtor
+
+    # Identification of the creditor party to the transaction for the funds
+    # received, can include `accountNumber` which is sensitive data and should
+    # be encrypted
+    # @return [RemittanceParty1]
+    attr_accessor :creditor
+
+    # Array of additional remittance attributes. This can include SWIFT tags
+    # such as '20', '70', '71A', '72' and etc, or similar custom fields from
+    # other rails
+    # @return [Array[FiAttributeEntity]]
+    attr_accessor :fi_attributes
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['payment_id'] = 'paymentId'
+      @_hash['type'] = 'type'
+      @_hash['value_date'] = 'valueDate'
+      @_hash['payment_status'] = 'paymentStatus'
+      @_hash['exchange_rate'] = 'exchangeRate'
+      @_hash['source_currency'] = 'sourceCurrency'
+      @_hash['debtor'] = 'debtor'
+      @_hash['creditor'] = 'creditor'
+      @_hash['fi_attributes'] = 'fiAttributes'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        payment_id
+        type
+        value_date
+        payment_status
+        exchange_rate
+        source_currency
+        debtor
+        creditor
+        fi_attributes
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(payment_id: SKIP, type: SKIP, value_date: SKIP,
+                   payment_status: SKIP, exchange_rate: SKIP,
+                   source_currency: SKIP, debtor: SKIP, creditor: SKIP,
+                   fi_attributes: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @payment_id = payment_id unless payment_id == SKIP
+      @type = type unless type == SKIP
+      @value_date = value_date unless value_date == SKIP
+      @payment_status = payment_status unless payment_status == SKIP
+      @exchange_rate = exchange_rate unless exchange_rate == SKIP
+      @source_currency = source_currency unless source_currency == SKIP
+      @debtor = debtor unless debtor == SKIP
+      @creditor = creditor unless creditor == SKIP
+      @fi_attributes = fi_attributes unless fi_attributes == 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_id = hash.key?('paymentId') ? hash['paymentId'] : SKIP
+      type = hash.key?('type') ? hash['type'] : SKIP
+      value_date = hash.key?('valueDate') ? hash['valueDate'] : SKIP
+      payment_status = hash.key?('paymentStatus') ? hash['paymentStatus'] : SKIP
+      exchange_rate = hash.key?('exchangeRate') ? hash['exchangeRate'] : SKIP
+      source_currency =
+        hash.key?('sourceCurrency') ? hash['sourceCurrency'] : SKIP
+      debtor = RemittanceParty3.from_hash(hash['debtor']) if hash['debtor']
+      creditor = RemittanceParty1.from_hash(hash['creditor']) if hash['creditor']
+      # Parameter is an array, so we need to iterate through it
+      fi_attributes = nil
+      unless hash['fiAttributes'].nil?
+        fi_attributes = []
+        hash['fiAttributes'].each do |structure|
+          fi_attributes << (FiAttributeEntity.from_hash(structure) if structure)
+        end
+      end
+
+      fi_attributes = SKIP unless hash.key?('fiAttributes')
+
+      # 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.
+      Remittance.new(payment_id: payment_id,
+                     type: type,
+                     value_date: value_date,
+                     payment_status: payment_status,
+                     exchange_rate: exchange_rate,
+                     source_currency: source_currency,
+                     debtor: debtor,
+                     creditor: creditor,
+                     fi_attributes: fi_attributes,
+                     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_id: #{@payment_id}, type: #{@type}, value_date: #{@value_date},"\
+      " payment_status: #{@payment_status}, exchange_rate: #{@exchange_rate}, source_currency:"\
+      " #{@source_currency}, debtor: #{@debtor}, creditor: #{@creditor}, fi_attributes:"\
+      " #{@fi_attributes}, 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_id: #{@payment_id.inspect}, type: #{@type.inspect}, value_date:"\
+      " #{@value_date.inspect}, payment_status: #{@payment_status.inspect}, exchange_rate:"\
+      " #{@exchange_rate.inspect}, source_currency: #{@source_currency.inspect}, debtor:"\
+      " #{@debtor.inspect}, creditor: #{@creditor.inspect}, fi_attributes:"\
+      " #{@fi_attributes.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/remittance2.rb

@@ -0,0 +1,185 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Remittance details for the transaction
+  class Remittance2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # An ID for the payment from the external payment rail. For SWIFT wires this
+    # will be Unique End-to-End Transaction Reference (UETR)
+    # @return [String]
+    attr_accessor :payment_id
+
+    # The payment rail of the transaction, such as `SWIFT_WIRE`
+    # @return [PaymentNetworkType1]
+    attr_accessor :type
+
+    # Date that the payment is executed
+    # @return [Date]
+    attr_accessor :value_date
+
+    # Status of the transaction from the payment rail, including one of
+    # `IN_PROGRESS`, `FAILED`, `CANCELLED`, `REJECTED` or `COMPLETED`
+    # @return [RemittanceStatus2]
+    attr_accessor :payment_status
+
+    # Exchange rate used to convert the instructed amount, if the source
+    # currency is different from the received currency
+    # @return [Float]
+    attr_accessor :exchange_rate
+
+    # The ISO 4217 code of the currency of the source account
+    # @return [Iso4217CurrencyCode2]
+    attr_accessor :source_currency
+
+    # Identification of the debtor party to the transaction for the funds
+    # source, can include `accountNumber` which is sensitive data and should be
+    # encrypted
+    # @return [RemittanceParty3]
+    attr_accessor :debtor
+
+    # Identification of the creditor party to the transaction for the funds
+    # received, can include `accountNumber` which is sensitive data and should
+    # be encrypted
+    # @return [RemittanceParty1]
+    attr_accessor :creditor
+
+    # Array of additional remittance attributes. This can include SWIFT tags
+    # such as '20', '70', '71A', '72' and etc, or similar custom fields from
+    # other rails
+    # @return [Array[FiAttributeEntity]]
+    attr_accessor :fi_attributes
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['payment_id'] = 'paymentId'
+      @_hash['type'] = 'type'
+      @_hash['value_date'] = 'valueDate'
+      @_hash['payment_status'] = 'paymentStatus'
+      @_hash['exchange_rate'] = 'exchangeRate'
+      @_hash['source_currency'] = 'sourceCurrency'
+      @_hash['debtor'] = 'debtor'
+      @_hash['creditor'] = 'creditor'
+      @_hash['fi_attributes'] = 'fiAttributes'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        payment_id
+        type
+        value_date
+        payment_status
+        exchange_rate
+        source_currency
+        debtor
+        creditor
+        fi_attributes
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(payment_id: SKIP, type: SKIP, value_date: SKIP,
+                   payment_status: SKIP, exchange_rate: SKIP,
+                   source_currency: SKIP, debtor: SKIP, creditor: SKIP,
+                   fi_attributes: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @payment_id = payment_id unless payment_id == SKIP
+      @type = type unless type == SKIP
+      @value_date = value_date unless value_date == SKIP
+      @payment_status = payment_status unless payment_status == SKIP
+      @exchange_rate = exchange_rate unless exchange_rate == SKIP
+      @source_currency = source_currency unless source_currency == SKIP
+      @debtor = debtor unless debtor == SKIP
+      @creditor = creditor unless creditor == SKIP
+      @fi_attributes = fi_attributes unless fi_attributes == 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_id = hash.key?('paymentId') ? hash['paymentId'] : SKIP
+      type = hash.key?('type') ? hash['type'] : SKIP
+      value_date = hash.key?('valueDate') ? hash['valueDate'] : SKIP
+      payment_status = hash.key?('paymentStatus') ? hash['paymentStatus'] : SKIP
+      exchange_rate = hash.key?('exchangeRate') ? hash['exchangeRate'] : SKIP
+      source_currency =
+        hash.key?('sourceCurrency') ? hash['sourceCurrency'] : SKIP
+      debtor = RemittanceParty3.from_hash(hash['debtor']) if hash['debtor']
+      creditor = RemittanceParty1.from_hash(hash['creditor']) if hash['creditor']
+      # Parameter is an array, so we need to iterate through it
+      fi_attributes = nil
+      unless hash['fiAttributes'].nil?
+        fi_attributes = []
+        hash['fiAttributes'].each do |structure|
+          fi_attributes << (FiAttributeEntity.from_hash(structure) if structure)
+        end
+      end
+
+      fi_attributes = SKIP unless hash.key?('fiAttributes')
+
+      # 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.
+      Remittance2.new(payment_id: payment_id,
+                      type: type,
+                      value_date: value_date,
+                      payment_status: payment_status,
+                      exchange_rate: exchange_rate,
+                      source_currency: source_currency,
+                      debtor: debtor,
+                      creditor: creditor,
+                      fi_attributes: fi_attributes,
+                      additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Remittance2 | 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_id: #{@payment_id}, type: #{@type}, value_date: #{@value_date},"\
+      " payment_status: #{@payment_status}, exchange_rate: #{@exchange_rate}, source_currency:"\
+      " #{@source_currency}, debtor: #{@debtor}, creditor: #{@creditor}, fi_attributes:"\
+      " #{@fi_attributes}, 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_id: #{@payment_id.inspect}, type: #{@type.inspect}, value_date:"\
+      " #{@value_date.inspect}, payment_status: #{@payment_status.inspect}, exchange_rate:"\
+      " #{@exchange_rate.inspect}, source_currency: #{@source_currency.inspect}, debtor:"\
+      " #{@debtor.inspect}, creditor: #{@creditor.inspect}, fi_attributes:"\
+      " #{@fi_attributes.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/remittance_party.rb

@@ -0,0 +1,87 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Identification of a party to the transaction
+  class RemittanceParty < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Company or individual name of the remittance debtor or creditor
+    # @return [String]
+    attr_accessor :name
+
+    # Full account number for the source or recipient account of the remittance
+    # debit or credit. If not masked this is sensitive data which should be
+    # encrypted in the response
+    # @return [String]
+    attr_accessor :account_number
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['account_number'] = 'accountNumber'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        account_number
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name: SKIP, account_number: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @name = name unless name == SKIP
+      @account_number = account_number unless account_number == 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.
+      name = hash.key?('name') ? hash['name'] : SKIP
+      account_number = hash.key?('accountNumber') ? hash['accountNumber'] : 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.
+      RemittanceParty.new(name: name,
+                          account_number: account_number,
+                          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} name: #{@name}, account_number: #{@account_number}, 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} name: #{@name.inspect}, account_number: #{@account_number.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/remittance_party1.rb

@@ -0,0 +1,99 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Identification of the creditor party to the transaction for the funds
+  # received, can include `accountNumber` which is sensitive data and should be
+  # encrypted
+  class RemittanceParty1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Company or individual name of the remittance debtor or creditor
+    # @return [String]
+    attr_accessor :name
+
+    # Full account number for the source or recipient account of the remittance
+    # debit or credit. If not masked this is sensitive data which should be
+    # encrypted in the response
+    # @return [String]
+    attr_accessor :account_number
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['account_number'] = 'accountNumber'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        account_number
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name: SKIP, account_number: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @name = name unless name == SKIP
+      @account_number = account_number unless account_number == 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.
+      name = hash.key?('name') ? hash['name'] : SKIP
+      account_number = hash.key?('accountNumber') ? hash['accountNumber'] : 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.
+      RemittanceParty1.new(name: name,
+                           account_number: account_number,
+                           additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [RemittanceParty1 | 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} name: #{@name}, account_number: #{@account_number}, 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} name: #{@name.inspect}, account_number: #{@account_number.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/remittance_party3.rb

@@ -0,0 +1,98 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Identification of the debtor party to the transaction for the funds source,
+  # can include `accountNumber` which is sensitive data and should be encrypted
+  class RemittanceParty3 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Company or individual name of the remittance debtor or creditor
+    # @return [String]
+    attr_accessor :name
+
+    # Full account number for the source or recipient account of the remittance
+    # debit or credit. If not masked this is sensitive data which should be
+    # encrypted in the response
+    # @return [String]
+    attr_accessor :account_number
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['account_number'] = 'accountNumber'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        account_number
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name: SKIP, account_number: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @name = name unless name == SKIP
+      @account_number = account_number unless account_number == 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.
+      name = hash.key?('name') ? hash['name'] : SKIP
+      account_number = hash.key?('accountNumber') ? hash['accountNumber'] : 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.
+      RemittanceParty3.new(name: name,
+                           account_number: account_number,
+                           additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [RemittanceParty3 | 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} name: #{@name}, account_number: #{@account_number}, 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} name: #{@name.inspect}, account_number: #{@account_number.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/remittance_status.rb

@@ -0,0 +1,48 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Status of the transaction from the payment rail
+  class RemittanceStatus
+    REMITTANCE_STATUS = [
+      # TODO: Write general description for CANCELLED
+      CANCELLED = 'CANCELLED'.freeze,
+
+      # TODO: Write general description for COMPLETED
+      COMPLETED = 'COMPLETED'.freeze,
+
+      # TODO: Write general description for FAILED
+      FAILED = 'FAILED'.freeze,
+
+      # TODO: Write general description for IN_PROGRESS
+      IN_PROGRESS = 'IN_PROGRESS'.freeze,
+
+      # TODO: Write general description for REJECTED
+      REJECTED = 'REJECTED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = CANCELLED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'cancelled' then CANCELLED
+      when 'completed' then COMPLETED
+      when 'failed' then FAILED
+      when 'in_progress' then IN_PROGRESS
+      when 'rejected' then REJECTED
+      else
+        default_value
+      end
+    end
+  end
+end