fdx-apimatic-sdk 0.0.1

data/lib/fdx_v660_api/models/balance_transfer_or_cash_advance.rb

@@ -0,0 +1,120 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # A single balance transfer or cash advance category on the account and its
+  # associated annual percentage rate (APR) and fee
+  class BalanceTransferOrCashAdvance < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The type of transfer or advance, `BALANCE_TRANSFER`, `CASH_ADVANCE`,
+    # `DIRECT_DEPOSIT_CASH_ADVANCE`, `CHECK_CASH_ADVANCE`, `OTC_CASH_ADVANCE`
+    # @return [BalanceTransferAndCashAdvanceType2]
+    attr_accessor :type
+
+    # The annual percentage rate (APR) charged for this type of transfer or
+    # advance
+    # @return [Float]
+    attr_accessor :apr
+
+    # The minimum fee charged for this type of transfer or advance. The value is
+    # zero if not charged on this type
+    # @return [Float]
+    attr_accessor :fee
+
+    # The fee charged as a percentage of the transfer or advance. If percentage
+    # result is smaller than `fee`, the `fee` amount is charged
+    # @return [Float]
+    attr_accessor :fee_percentage
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['apr'] = 'apr'
+      @_hash['fee'] = 'fee'
+      @_hash['fee_percentage'] = 'feePercentage'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        type
+        apr
+        fee
+        fee_percentage
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(type: SKIP, apr: SKIP, fee: 0, fee_percentage: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @type = type unless type == SKIP
+      @apr = apr unless apr == SKIP
+      @fee = fee unless fee == SKIP
+      @fee_percentage = fee_percentage unless fee_percentage == 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.
+      type = hash.key?('type') ? hash['type'] : SKIP
+      apr = hash.key?('apr') ? hash['apr'] : SKIP
+      fee = hash['fee'] ||= 0
+      fee_percentage = hash.key?('feePercentage') ? hash['feePercentage'] : 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.
+      BalanceTransferOrCashAdvance.new(type: type,
+                                       apr: apr,
+                                       fee: fee,
+                                       fee_percentage: fee_percentage,
+                                       additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [BalanceTransferOrCashAdvance | 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} type: #{@type}, apr: #{@apr}, fee: #{@fee}, fee_percentage:"\
+      " #{@fee_percentage}, 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} type: #{@type.inspect}, apr: #{@apr.inspect}, fee: #{@fee.inspect},"\
+      " fee_percentage: #{@fee_percentage.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/balance_type.rb

@@ -0,0 +1,38 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Type of balance for the account.   * `ASSET`: Positive transaction amount
+  # increases balance   * `LIABILITY`: Positive transaction amount decreases
+  # balance
+  class BalanceType
+    BALANCE_TYPE = [
+      # TODO: Write general description for ASSET
+      ASSET = 'ASSET'.freeze,
+
+      # TODO: Write general description for LIABILITY
+      LIABILITY = 'LIABILITY'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = ASSET)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'asset' then ASSET
+      when 'liability' then LIABILITY
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fdx_v660_api/models/balance_type2.rb

@@ -0,0 +1,37 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # ASSET (positive transaction amount increases balance), LIABILITY (positive
+  # transaction amount decreases balance)
+  class BalanceType2
+    BALANCE_TYPE2 = [
+      # TODO: Write general description for ASSET
+      ASSET = 'ASSET'.freeze,
+
+      # TODO: Write general description for LIABILITY
+      LIABILITY = 'LIABILITY'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = ASSET)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'asset' then ASSET
+      when 'liability' then LIABILITY
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fdx_v660_api/models/bank_id_type.rb

@@ -0,0 +1,49 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Enumerated values for type of `bankId`, or routing number. `bankId` and
+  # `bankIdType` can both be omitted if not needed, such as for IBAN transfers
+  # or Canadian institutions   | Value | Description |   |-------|-------------|
+  #   | BIC | Bank Identifier Code, also known as SWIFT code. Typically 8 or 11
+  # characters long and includes information like the bank, country, and
+  # location |   | CA_ROUTING_NUMBER | The Canadian 3-digit Institution ID (FID)
+  # and 5-digit Transit numbers in bankInstitutionId and bankTransitId,
+  # including leading zeroes |   | US_ABA_NUMBER | The typically 9-digit routing
+  # transit number (RTN) associated with the account number at a US institution
+  # |
+  class BankIdType
+    BANK_ID_TYPE = [
+      # TODO: Write general description for BIC
+      BIC = 'BIC'.freeze,
+
+      # TODO: Write general description for CA_ROUTING_NUMBER
+      CA_ROUTING_NUMBER = 'CA_ROUTING_NUMBER'.freeze,
+
+      # TODO: Write general description for US_ABA_NUMBER
+      US_ABA_NUMBER = 'US_ABA_NUMBER'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = BIC)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'bic' then BIC
+      when 'ca_routing_number' then CA_ROUTING_NUMBER
+      when 'us_aba_number' then US_ABA_NUMBER
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fdx_v660_api/models/bank_id_type2.rb

@@ -0,0 +1,42 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # If not specified, bankId should be interpreted as ABA for US accounts and be
+  # omitted for Canadian accounts (which use bankInstitutionId and
+  # bankTransitId)
+  class BankIdType2
+    BANK_ID_TYPE2 = [
+      # TODO: Write general description for BIC
+      BIC = 'BIC'.freeze,
+
+      # TODO: Write general description for CA_ROUTING_NUMBER
+      CA_ROUTING_NUMBER = 'CA_ROUTING_NUMBER'.freeze,
+
+      # TODO: Write general description for US_ABA_NUMBER
+      US_ABA_NUMBER = 'US_ABA_NUMBER'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = BIC)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'bic' then BIC
+      when 'ca_routing_number' then CA_ROUTING_NUMBER
+      when 'us_aba_number' then US_ABA_NUMBER
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fdx_v660_api/models/base_deposit_account_terms_and_conditions.rb

@@ -0,0 +1,160 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Base type for initial and current terms and conditions for deposit accounts
+  class BaseDepositAccountTermsAndConditions < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique ID of the marketed product for which these are the Terms and
+    # Conditions
+    # @return [String]
+    attr_accessor :product_id
+
+    # Static public-facing URIs which return initial or latest account terms and
+    # conditions as PDF files or web content
+    # @return [Array[TermsAndConditionsUriEntity]]
+    attr_accessor :uris
+
+    # The PDFs or JSON data elements for the terms and conditions for the
+    # account's reward program (and reward categories, if any)
+    # @return [RewardsTermsAndConditionsEntity2]
+    attr_accessor :rewards_terms_and_conditions
+
+    # The specific Account types which have Deposit Terms and Conditions
+    # @return [AccountCategoryDepositType2]
+    attr_accessor :account_category
+
+    # The initial Terms and Conditions for this deposit account
+    # @return [DepositAccountTermsAndConditionsEntity3]
+    attr_accessor :initial
+
+    # Any data elements which have been updated since original Terms and
+    # Conditions
+    # @return [DepositAccountTermsAndConditionsEntity1]
+    attr_accessor :current
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['product_id'] = 'productId'
+      @_hash['uris'] = 'uris'
+      @_hash['rewards_terms_and_conditions'] = 'rewardsTermsAndConditions'
+      @_hash['account_category'] = 'accountCategory'
+      @_hash['initial'] = 'initial'
+      @_hash['current'] = 'current'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        product_id
+        uris
+        rewards_terms_and_conditions
+        initial
+        current
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_category:, product_id: SKIP, uris: SKIP,
+                   rewards_terms_and_conditions: SKIP, initial: SKIP,
+                   current: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @product_id = product_id unless product_id == SKIP
+      @uris = uris unless uris == SKIP
+      unless rewards_terms_and_conditions == SKIP
+        @rewards_terms_and_conditions =
+          rewards_terms_and_conditions
+      end
+      @account_category = account_category
+      @initial = initial unless initial == SKIP
+      @current = current unless current == 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_category =
+        hash.key?('accountCategory') ? hash['accountCategory'] : nil
+      product_id = hash.key?('productId') ? hash['productId'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      uris = nil
+      unless hash['uris'].nil?
+        uris = []
+        hash['uris'].each do |structure|
+          uris << (TermsAndConditionsUriEntity.from_hash(structure) if structure)
+        end
+      end
+
+      uris = SKIP unless hash.key?('uris')
+      if hash['rewardsTermsAndConditions']
+        rewards_terms_and_conditions = RewardsTermsAndConditionsEntity2.from_hash(hash['rewardsTermsAndConditions'])
+      end
+      initial = DepositAccountTermsAndConditionsEntity3.from_hash(hash['initial']) if
+        hash['initial']
+      current = DepositAccountTermsAndConditionsEntity1.from_hash(hash['current']) if
+        hash['current']
+
+      # 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.
+      BaseDepositAccountTermsAndConditions.new(account_category: account_category,
+                                               product_id: product_id,
+                                               uris: uris,
+                                               rewards_terms_and_conditions: rewards_terms_and_conditions,
+                                               initial: initial,
+                                               current: current,
+                                               additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [BaseDepositAccountTermsAndConditions | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.account_category,
+                                     ->(val) { AccountCategoryDepositType2.validate(val) })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['accountCategory'],
+                            ->(val) { AccountCategoryDepositType2.validate(val) })
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} product_id: #{@product_id}, uris: #{@uris}, rewards_terms_and_conditions:"\
+      " #{@rewards_terms_and_conditions}, account_category: #{@account_category}, initial:"\
+      " #{@initial}, current: #{@current}, 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} product_id: #{@product_id.inspect}, uris: #{@uris.inspect},"\
+      " rewards_terms_and_conditions: #{@rewards_terms_and_conditions.inspect}, account_category:"\
+      " #{@account_category.inspect}, initial: #{@initial.inspect}, current: #{@current.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/base_line_of_credit_account_terms_and_conditions.rb

@@ -0,0 +1,161 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Base type for initial and current terms and conditions for line of credit
+  # account
+  class BaseLineOfCreditAccountTermsAndConditions < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique ID of the marketed product for which these are the Terms and
+    # Conditions
+    # @return [String]
+    attr_accessor :product_id
+
+    # Static public-facing URIs which return initial or latest account terms and
+    # conditions as PDF files or web content
+    # @return [Array[TermsAndConditionsUriEntity]]
+    attr_accessor :uris
+
+    # The PDFs or JSON data elements for the terms and conditions for the
+    # account's reward program (and reward categories, if any)
+    # @return [RewardsTermsAndConditionsEntity2]
+    attr_accessor :rewards_terms_and_conditions
+
+    # The specific Account types which have Loan or LOC Terms and Conditions
+    # @return [AccountCategoryLineOfCreditType2]
+    attr_accessor :account_category
+
+    # The initial Terms and Conditions for this loan or LOC account
+    # @return [LineOfCreditAccountTermsAndConditionsEntity3]
+    attr_accessor :initial
+
+    # Any data elements which have been updated since original Terms and
+    # Conditions
+    # @return [LineOfCreditAccountTermsAndConditionsEntity1]
+    attr_accessor :current
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['product_id'] = 'productId'
+      @_hash['uris'] = 'uris'
+      @_hash['rewards_terms_and_conditions'] = 'rewardsTermsAndConditions'
+      @_hash['account_category'] = 'accountCategory'
+      @_hash['initial'] = 'initial'
+      @_hash['current'] = 'current'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        product_id
+        uris
+        rewards_terms_and_conditions
+        initial
+        current
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_category:, product_id: SKIP, uris: SKIP,
+                   rewards_terms_and_conditions: SKIP, initial: SKIP,
+                   current: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @product_id = product_id unless product_id == SKIP
+      @uris = uris unless uris == SKIP
+      unless rewards_terms_and_conditions == SKIP
+        @rewards_terms_and_conditions =
+          rewards_terms_and_conditions
+      end
+      @account_category = account_category
+      @initial = initial unless initial == SKIP
+      @current = current unless current == 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_category =
+        hash.key?('accountCategory') ? hash['accountCategory'] : nil
+      product_id = hash.key?('productId') ? hash['productId'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      uris = nil
+      unless hash['uris'].nil?
+        uris = []
+        hash['uris'].each do |structure|
+          uris << (TermsAndConditionsUriEntity.from_hash(structure) if structure)
+        end
+      end
+
+      uris = SKIP unless hash.key?('uris')
+      if hash['rewardsTermsAndConditions']
+        rewards_terms_and_conditions = RewardsTermsAndConditionsEntity2.from_hash(hash['rewardsTermsAndConditions'])
+      end
+      initial = LineOfCreditAccountTermsAndConditionsEntity3.from_hash(hash['initial']) if
+        hash['initial']
+      current = LineOfCreditAccountTermsAndConditionsEntity1.from_hash(hash['current']) if
+        hash['current']
+
+      # 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.
+      BaseLineOfCreditAccountTermsAndConditions.new(account_category: account_category,
+                                                    product_id: product_id,
+                                                    uris: uris,
+                                                    rewards_terms_and_conditions: rewards_terms_and_conditions,
+                                                    initial: initial,
+                                                    current: current,
+                                                    additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [BaseLineOfCreditAccountTermsAndConditions | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.account_category,
+                                     ->(val) { AccountCategoryLineOfCreditType2.validate(val) })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['accountCategory'],
+                            ->(val) { AccountCategoryLineOfCreditType2.validate(val) })
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} product_id: #{@product_id}, uris: #{@uris}, rewards_terms_and_conditions:"\
+      " #{@rewards_terms_and_conditions}, account_category: #{@account_category}, initial:"\
+      " #{@initial}, current: #{@current}, 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} product_id: #{@product_id.inspect}, uris: #{@uris.inspect},"\
+      " rewards_terms_and_conditions: #{@rewards_terms_and_conditions.inspect}, account_category:"\
+      " #{@account_category.inspect}, initial: #{@initial.inspect}, current: #{@current.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end