fdx-apimatic-sdk 0.0.1

data/lib/fdx_v660_api/models/payment_method_system_proprietary.rb

@@ -0,0 +1,85 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # 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_v660_api/models/payment_network_identifier_type.rb

@@ -0,0 +1,47 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Enumerated values for type of account `identifier` used on a payment
+  # network.   | Value | Description |   |-------|-------------|   |
+  # ACCOUNT_NUMBER | The 'real' account number, which is sensitive data and
+  # should only be exchanged if encrypted |   | IBAN | International Bank
+  # Account Number used with BIC (aka SWIFT code), also sensitive data and
+  # should only be exchanged if encrypted |   | TOKENIZED_ACCOUNT_NUMBER | A
+  # token representation of an account number which Provider or Token Issuer can
+  # use to identify the real account |
+  class PaymentNetworkIdentifierType
+    PAYMENT_NETWORK_IDENTIFIER_TYPE = [
+      # TODO: Write general description for ACCOUNT_NUMBER
+      ACCOUNT_NUMBER = 'ACCOUNT_NUMBER'.freeze,
+
+      # TODO: Write general description for IBAN
+      IBAN = 'IBAN'.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
+
+    def self.from_value(value, default_value = ACCOUNT_NUMBER)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'account_number' then ACCOUNT_NUMBER
+      when 'iban' then IBAN
+      when 'tokenized_account_number' then TOKENIZED_ACCOUNT_NUMBER
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fdx_v660_api/models/payment_network_identifier_type1.rb

@@ -0,0 +1,40 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # 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 IBAN
+      IBAN = 'IBAN'.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
+
+    def self.from_value(value, default_value = ACCOUNT_NUMBER)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'account_number' then ACCOUNT_NUMBER
+      when 'iban' then IBAN
+      when 'tokenized_account_number' then TOKENIZED_ACCOUNT_NUMBER
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fdx_v660_api/models/payment_network_identifier_type3.rb

@@ -0,0 +1,41 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # The type of account `identifier` e.g. `ACCOUNT_NUMBER`, `IBAN`, 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 IBAN
+      IBAN = 'IBAN'.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
+
+    def self.from_value(value, default_value = ACCOUNT_NUMBER)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'account_number' then ACCOUNT_NUMBER
+      when 'iban' then IBAN
+      when 'tokenized_account_number' then TOKENIZED_ACCOUNT_NUMBER
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fdx_v660_api/models/payment_network_lifecycle_event_entity.rb

@@ -0,0 +1,140 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module FdxV660Api
+  # Details of a lifecycle change on a payment network pair of `bankId` and
+  # account `identifier` identified by the `paymentNetworkId` on a single
+  # account and payment network type
+  class PaymentNetworkLifecycleEventEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The status after the event or change requested, one of `ACTIVE`,
+    # `SUSPENDED`, `EXPIRED` or `REVOKED`, depending on entity type
+    # @return [EventStatus2]
+    attr_accessor :status
+
+    # The reason for the revocation or status change, one of `BUSINESS_RULE`,
+    # `SECURITY_EVENT`, `USER_ACTION` or `OTHER`
+    # @return [UpdateReason2]
+    attr_accessor :reason
+
+    # Additional information or description of an `OTHER` reason
+    # @return [String]
+    attr_accessor :other_reason
+
+    # The party initiating the revocation or status change
+    # @return [PartyType4]
+    attr_accessor :initiator
+
+    # When the lifecycle event occurred
+    # @return [DateTime]
+    attr_accessor :updated_time
+
+    # The payment network type for this event on this `paymentNetworkId`
+    # @return [PaymentNetworkType2]
+    attr_accessor :payment_network_type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['status'] = 'status'
+      @_hash['reason'] = 'reason'
+      @_hash['other_reason'] = 'otherReason'
+      @_hash['initiator'] = 'initiator'
+      @_hash['updated_time'] = 'updatedTime'
+      @_hash['payment_network_type'] = 'paymentNetworkType'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        status
+        reason
+        other_reason
+        initiator
+        updated_time
+        payment_network_type
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(status: SKIP, reason: SKIP, other_reason: SKIP,
+                   initiator: SKIP, updated_time: SKIP,
+                   payment_network_type: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @status = status unless status == SKIP
+      @reason = reason unless reason == SKIP
+      @other_reason = other_reason unless other_reason == SKIP
+      @initiator = initiator unless initiator == SKIP
+      @updated_time = updated_time unless updated_time == SKIP
+      @payment_network_type = payment_network_type unless payment_network_type == 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.
+      status = hash.key?('status') ? hash['status'] : SKIP
+      reason = hash.key?('reason') ? hash['reason'] : SKIP
+      other_reason = hash.key?('otherReason') ? hash['otherReason'] : SKIP
+      initiator = hash.key?('initiator') ? hash['initiator'] : SKIP
+      updated_time = if hash.key?('updatedTime')
+                       (DateTimeHelper.from_rfc3339(hash['updatedTime']) if hash['updatedTime'])
+                     else
+                       SKIP
+                     end
+      payment_network_type =
+        hash.key?('paymentNetworkType') ? hash['paymentNetworkType'] : 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.
+      PaymentNetworkLifecycleEventEntity.new(status: status,
+                                             reason: reason,
+                                             other_reason: other_reason,
+                                             initiator: initiator,
+                                             updated_time: updated_time,
+                                             payment_network_type: payment_network_type,
+                                             additional_properties: additional_properties)
+    end
+
+    def to_custom_updated_time
+      DateTimeHelper.to_rfc3339(updated_time)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} status: #{@status}, reason: #{@reason}, other_reason: #{@other_reason},"\
+      " initiator: #{@initiator}, updated_time: #{@updated_time}, payment_network_type:"\
+      " #{@payment_network_type}, 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} status: #{@status.inspect}, reason: #{@reason.inspect}, other_reason:"\
+      " #{@other_reason.inspect}, initiator: #{@initiator.inspect}, updated_time:"\
+      " #{@updated_time.inspect}, payment_network_type: #{@payment_network_type.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/payment_network_lifecycle_events_entity.rb

@@ -0,0 +1,85 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # List of lifecycle change events on a payment network pair of `bankId` and
+  # account `identifier` identified by the `paymentNetworkId`
+  class PaymentNetworkLifecycleEventsEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The list of payment network lifecycle events such as revocation requests
+    # @return [Array[PaymentNetworkLifecycleEventEntity]]
+    attr_accessor :events
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['events'] = 'events'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        events
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(events: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @events = events unless events == 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.
+      # Parameter is an array, so we need to iterate through it
+      events = nil
+      unless hash['events'].nil?
+        events = []
+        hash['events'].each do |structure|
+          events << (PaymentNetworkLifecycleEventEntity.from_hash(structure) if structure)
+        end
+      end
+
+      events = SKIP unless hash.key?('events')
+
+      # 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.
+      PaymentNetworkLifecycleEventsEntity.new(events: events,
+                                              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} events: #{@events}, 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} events: #{@events.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/payment_network_type.rb

@@ -0,0 +1,80 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Suggested values for Payment Network Type.   | Value | Description |
+  # |-----|-----|   | CA_ACSS | Automated Clearing Settlement System includes
+  # paper checks, electronic payments and Canada's version of ACH |   | CA_LVTS
+  # | Large-Value Transfer System |   | SWIFT_WIRE | SWIFT system for wire
+  # transfers (Society for Worldwide Interbank Financial Telecommunication) |
+  # | US_ACH | Automated Clearing House |   | US_CHECK | Paper check (or their
+  # electronic images) processing |   | US_CHIPS | Clearing House Interbank
+  # Payments System |   | US_FEDNOW | Federal Reserve Instant Payment System
+  # 'FedNow' |   | US_FEDWIRE | Fedwire Funds Service |   | US_RTP | US Real
+  # Time Payments System, supporting RTP and using field
+  # `supportsRequestForPayment` to indicate RFP support (or not) |   |
+  # US_RTP_RFP | US Real Time Payments System, supporting both RTP and Request
+  # For Payments (RFP) |
+  class PaymentNetworkType
+    PAYMENT_NETWORK_TYPE = [
+      # TODO: Write general description for CA_ACSS
+      CA_ACSS = 'CA_ACSS'.freeze,
+
+      # TODO: Write general description for CA_LVTS
+      CA_LVTS = 'CA_LVTS'.freeze,
+
+      # TODO: Write general description for SWIFT_WIRE
+      SWIFT_WIRE = 'SWIFT_WIRE'.freeze,
+
+      # TODO: Write general description for US_ACH
+      US_ACH = 'US_ACH'.freeze,
+
+      # TODO: Write general description for US_CHECK
+      US_CHECK = 'US_CHECK'.freeze,
+
+      # TODO: Write general description for US_CHIPS
+      US_CHIPS = 'US_CHIPS'.freeze,
+
+      # TODO: Write general description for US_FEDNOW
+      US_FEDNOW = 'US_FEDNOW'.freeze,
+
+      # TODO: Write general description for US_FEDWIRE
+      US_FEDWIRE = 'US_FEDWIRE'.freeze,
+
+      # TODO: Write general description for US_RTP
+      US_RTP = 'US_RTP'.freeze,
+
+      # TODO: Write general description for US_RTP_RFP
+      US_RTP_RFP = 'US_RTP_RFP'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = CA_ACSS)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'ca_acss' then CA_ACSS
+      when 'ca_lvts' then CA_LVTS
+      when 'swift_wire' then SWIFT_WIRE
+      when 'us_ach' then US_ACH
+      when 'us_check' then US_CHECK
+      when 'us_chips' then US_CHIPS
+      when 'us_fednow' then US_FEDNOW
+      when 'us_fedwire' then US_FEDWIRE
+      when 'us_rtp' then US_RTP
+      when 'us_rtp_rfp' then US_RTP_RFP
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fdx_v660_api/models/payment_network_type1.rb

@@ -0,0 +1,68 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # The payment rail of the transaction, such as `SWIFT_WIRE`
+  class PaymentNetworkType1
+    PAYMENT_NETWORK_TYPE1 = [
+      # TODO: Write general description for CA_ACSS
+      CA_ACSS = 'CA_ACSS'.freeze,
+
+      # TODO: Write general description for CA_LVTS
+      CA_LVTS = 'CA_LVTS'.freeze,
+
+      # TODO: Write general description for SWIFT_WIRE
+      SWIFT_WIRE = 'SWIFT_WIRE'.freeze,
+
+      # TODO: Write general description for US_ACH
+      US_ACH = 'US_ACH'.freeze,
+
+      # TODO: Write general description for US_CHECK
+      US_CHECK = 'US_CHECK'.freeze,
+
+      # TODO: Write general description for US_CHIPS
+      US_CHIPS = 'US_CHIPS'.freeze,
+
+      # TODO: Write general description for US_FEDNOW
+      US_FEDNOW = 'US_FEDNOW'.freeze,
+
+      # TODO: Write general description for US_FEDWIRE
+      US_FEDWIRE = 'US_FEDWIRE'.freeze,
+
+      # TODO: Write general description for US_RTP
+      US_RTP = 'US_RTP'.freeze,
+
+      # TODO: Write general description for US_RTP_RFP
+      US_RTP_RFP = 'US_RTP_RFP'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = CA_ACSS)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'ca_acss' then CA_ACSS
+      when 'ca_lvts' then CA_LVTS
+      when 'swift_wire' then SWIFT_WIRE
+      when 'us_ach' then US_ACH
+      when 'us_check' then US_CHECK
+      when 'us_chips' then US_CHIPS
+      when 'us_fednow' then US_FEDNOW
+      when 'us_fedwire' then US_FEDWIRE
+      when 'us_rtp' then US_RTP
+      when 'us_rtp_rfp' then US_RTP_RFP
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fdx_v660_api/models/payment_network_type2.rb

@@ -0,0 +1,68 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # The payment network type for this event on this `paymentNetworkId`
+  class PaymentNetworkType2
+    PAYMENT_NETWORK_TYPE2 = [
+      # TODO: Write general description for CA_ACSS
+      CA_ACSS = 'CA_ACSS'.freeze,
+
+      # TODO: Write general description for CA_LVTS
+      CA_LVTS = 'CA_LVTS'.freeze,
+
+      # TODO: Write general description for SWIFT_WIRE
+      SWIFT_WIRE = 'SWIFT_WIRE'.freeze,
+
+      # TODO: Write general description for US_ACH
+      US_ACH = 'US_ACH'.freeze,
+
+      # TODO: Write general description for US_CHECK
+      US_CHECK = 'US_CHECK'.freeze,
+
+      # TODO: Write general description for US_CHIPS
+      US_CHIPS = 'US_CHIPS'.freeze,
+
+      # TODO: Write general description for US_FEDNOW
+      US_FEDNOW = 'US_FEDNOW'.freeze,
+
+      # TODO: Write general description for US_FEDWIRE
+      US_FEDWIRE = 'US_FEDWIRE'.freeze,
+
+      # TODO: Write general description for US_RTP
+      US_RTP = 'US_RTP'.freeze,
+
+      # TODO: Write general description for US_RTP_RFP
+      US_RTP_RFP = 'US_RTP_RFP'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = CA_ACSS)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'ca_acss' then CA_ACSS
+      when 'ca_lvts' then CA_LVTS
+      when 'swift_wire' then SWIFT_WIRE
+      when 'us_ach' then US_ACH
+      when 'us_check' then US_CHECK
+      when 'us_chips' then US_CHIPS
+      when 'us_fednow' then US_FEDNOW
+      when 'us_fedwire' then US_FEDWIRE
+      when 'us_rtp' then US_RTP
+      when 'us_rtp_rfp' then US_RTP_RFP
+      else
+        default_value
+      end
+    end
+  end
+end