fdx-api-sdk-ruby 1.0.0

data/lib/fdx_api/models/loan_transaction_entity.rb

@@ -0,0 +1,212 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+require_relative 'transaction'
+
+module FdxApi
+  # A transaction on a loan account
+  class LoanTransactionEntity < Transaction
+    # PAYMENT, FEE, ADJUSTMENT, INTEREST
+    # @return [LoanTransactionType2]
+    attr_accessor :transaction_type
+
+    # Breakdown of payment details
+    # @return [PaymentDetailsEntity]
+    attr_accessor :payment_details
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['transaction_type'] = 'transactionType'
+      @_hash['payment_details'] = 'paymentDetails'
+      @_hash = super().merge(@_hash)
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      _arr = %w[
+        transaction_type
+        payment_details
+      ]
+      (_arr << super()).flatten!
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      _arr = []
+      (_arr << super()).flatten!
+    end
+
+    def initialize(transaction_type: SKIP, payment_details: SKIP,
+                   account_category: 'Loan Transaction entity',
+                   account_id: SKIP, transaction_id: SKIP,
+                   reference_transaction_id: SKIP, posted_timestamp: SKIP,
+                   transaction_timestamp: SKIP, description: SKIP, memo: SKIP,
+                   debit_credit_memo: SKIP, category: SKIP, sub_category: SKIP,
+                   reference: SKIP, status: SKIP, amount: SKIP,
+                   foreign_amount: SKIP, foreign_currency: SKIP,
+                   image_ids: SKIP, line_item: SKIP, reward: SKIP,
+                   fi_attributes: SKIP, links: SKIP, additional_properties: nil)
+      @transaction_type = transaction_type unless transaction_type == SKIP
+      @payment_details = payment_details unless payment_details == SKIP
+      @additional_properties = additional_properties
+
+      # Call the constructor of the base class
+      super(account_category: account_category,
+            account_id: account_id,
+            transaction_id: transaction_id,
+            reference_transaction_id: reference_transaction_id,
+            posted_timestamp: posted_timestamp,
+            transaction_timestamp: transaction_timestamp,
+            description: description,
+            memo: memo,
+            debit_credit_memo: debit_credit_memo,
+            category: category,
+            sub_category: sub_category,
+            reference: reference,
+            status: status,
+            amount: amount,
+            foreign_amount: foreign_amount,
+            foreign_currency: foreign_currency,
+            image_ids: image_ids,
+            line_item: line_item,
+            reward: reward,
+            fi_attributes: fi_attributes,
+            links: links,
+            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.
+      transaction_type =
+        hash.key?('transactionType') ? hash['transactionType'] : SKIP
+      payment_details = PaymentDetailsEntity.from_hash(hash['paymentDetails']) if
+        hash['paymentDetails']
+      account_category = hash['accountCategory'] ||= 'Loan Transaction entity'
+      account_id = hash.key?('accountId') ? hash['accountId'] : SKIP
+      transaction_id = hash.key?('transactionId') ? hash['transactionId'] : SKIP
+      reference_transaction_id =
+        hash.key?('referenceTransactionId') ? hash['referenceTransactionId'] : SKIP
+      posted_timestamp = if hash.key?('postedTimestamp')
+                           (DateTimeHelper.from_rfc3339(hash['postedTimestamp']) if hash['postedTimestamp'])
+                         else
+                           SKIP
+                         end
+      transaction_timestamp = if hash.key?('transactionTimestamp')
+                                (DateTimeHelper.from_rfc3339(hash['transactionTimestamp']) if hash['transactionTimestamp'])
+                              else
+                                SKIP
+                              end
+      description = hash.key?('description') ? hash['description'] : SKIP
+      memo = hash.key?('memo') ? hash['memo'] : SKIP
+      debit_credit_memo =
+        hash.key?('debitCreditMemo') ? hash['debitCreditMemo'] : SKIP
+      category = hash.key?('category') ? hash['category'] : SKIP
+      sub_category = hash.key?('subCategory') ? hash['subCategory'] : SKIP
+      reference = hash.key?('reference') ? hash['reference'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      amount = hash.key?('amount') ? hash['amount'] : SKIP
+      foreign_amount = hash.key?('foreignAmount') ? hash['foreignAmount'] : SKIP
+      foreign_currency =
+        hash.key?('foreignCurrency') ? hash['foreignCurrency'] : SKIP
+      image_ids = hash.key?('imageIds') ? hash['imageIds'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      line_item = nil
+      unless hash['lineItem'].nil?
+        line_item = []
+        hash['lineItem'].each do |structure|
+          line_item << (LineItemEntity.from_hash(structure) if structure)
+        end
+      end
+
+      line_item = SKIP unless hash.key?('lineItem')
+      reward = TransactionRewardEntity2.from_hash(hash['reward']) if hash['reward']
+      # 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')
+      # Parameter is an array, so we need to iterate through it
+      links = nil
+      unless hash['links'].nil?
+        links = []
+        hash['links'].each do |structure|
+          links << (HateoasLink.from_hash(structure) if structure)
+        end
+      end
+
+      links = SKIP unless hash.key?('links')
+
+      # 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.
+      LoanTransactionEntity.new(transaction_type: transaction_type,
+                                payment_details: payment_details,
+                                account_category: account_category,
+                                account_id: account_id,
+                                transaction_id: transaction_id,
+                                reference_transaction_id: reference_transaction_id,
+                                posted_timestamp: posted_timestamp,
+                                transaction_timestamp: transaction_timestamp,
+                                description: description,
+                                memo: memo,
+                                debit_credit_memo: debit_credit_memo,
+                                category: category,
+                                sub_category: sub_category,
+                                reference: reference,
+                                status: status,
+                                amount: amount,
+                                foreign_amount: foreign_amount,
+                                foreign_currency: foreign_currency,
+                                image_ids: image_ids,
+                                line_item: line_item,
+                                reward: reward,
+                                fi_attributes: fi_attributes,
+                                links: links,
+                                additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [LoanTransactionEntity | 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
+      super_string = super().sub(/^<[^ ]+ /, '').sub(/>$/, '')
+      "<#{class_name} #{super_string}, transaction_type: #{@transaction_type}, payment_details:"\
+      " #{@payment_details}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      super_string = super().inspect.sub(/^<[^ ]+ /, '').sub(/>$/, '')
+      "<#{class_name} #{super_string}, transaction_type: #{@transaction_type.inspect},"\
+      " payment_details: #{@payment_details.inspect}>"
+    end
+  end
+end

data/lib/fdx_api/models/loan_transaction_type.rb

@@ -0,0 +1,49 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Defines the type of a loan transaction:   * `ADJUSTMENT`: Adjustment or
+  # correction   * `DOUBLE_UP_PAYMENT`: Additional payment beyond the required
+  # payment to reduce the principal   * `FEE`: Fee charge. For example, a late
+  # payment fee   * `INTEREST`: Interest charge   * `LUMP_SUM_PAYMENT`: A single
+  # payment of money, as opposed to a series of payments made over time   *
+  # `PAYMENT`: Required payment that satisfies the minimum payment (e.g.
+  # principal + interest for mortgages)   * `PAYOFF`: Payment that satisfies the
+  # terms of the mortgage loan and completely pays off the debt   *
+  # `SKIP_PAYMENT`: Payment that satisfies deferral of a required payment
+  class LoanTransactionType
+    LOAN_TRANSACTION_TYPE = [
+      # TODO: Write general description for ADJUSTMENT
+      ADJUSTMENT = 'ADJUSTMENT'.freeze,
+
+      # TODO: Write general description for DOUBLE_UP_PAYMENT
+      DOUBLE_UP_PAYMENT = 'DOUBLE_UP_PAYMENT'.freeze,
+
+      # TODO: Write general description for FEE
+      FEE = 'FEE'.freeze,
+
+      # TODO: Write general description for INTEREST
+      INTEREST = 'INTEREST'.freeze,
+
+      # TODO: Write general description for LUMP_SUM_PAYMENT
+      LUMP_SUM_PAYMENT = 'LUMP_SUM_PAYMENT'.freeze,
+
+      # TODO: Write general description for PAYMENT
+      PAYMENT = 'PAYMENT'.freeze,
+
+      # TODO: Write general description for PAYOFF
+      PAYOFF = 'PAYOFF'.freeze,
+
+      # TODO: Write general description for SKIP_PAYMENT
+      SKIP_PAYMENT = 'SKIP_PAYMENT'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/loan_transaction_type2.rb

@@ -0,0 +1,41 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # PAYMENT, FEE, ADJUSTMENT, INTEREST
+  class LoanTransactionType2
+    LOAN_TRANSACTION_TYPE2 = [
+      # TODO: Write general description for ADJUSTMENT
+      ADJUSTMENT = 'ADJUSTMENT'.freeze,
+
+      # TODO: Write general description for DOUBLE_UP_PAYMENT
+      DOUBLE_UP_PAYMENT = 'DOUBLE_UP_PAYMENT'.freeze,
+
+      # TODO: Write general description for FEE
+      FEE = 'FEE'.freeze,
+
+      # TODO: Write general description for INTEREST
+      INTEREST = 'INTEREST'.freeze,
+
+      # TODO: Write general description for LUMP_SUM_PAYMENT
+      LUMP_SUM_PAYMENT = 'LUMP_SUM_PAYMENT'.freeze,
+
+      # TODO: Write general description for PAYMENT
+      PAYMENT = 'PAYMENT'.freeze,
+
+      # TODO: Write general description for PAYOFF
+      PAYOFF = 'PAYOFF'.freeze,
+
+      # TODO: Write general description for SKIP_PAYMENT
+      SKIP_PAYMENT = 'SKIP_PAYMENT'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/local_tax_withholding.rb

@@ -0,0 +1,96 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Income in a locality and its tax withholding
+  class LocalTaxWithholding < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Amount of local income tax withheld
+    # @return [Float]
+    attr_accessor :tax_withheld
+
+    # Locality name
+    # @return [String]
+    attr_accessor :locality_name
+
+    # Income amount for local tax purposes
+    # @return [Float]
+    attr_accessor :income
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['tax_withheld'] = 'taxWithheld'
+      @_hash['locality_name'] = 'localityName'
+      @_hash['income'] = 'income'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        tax_withheld
+        locality_name
+        income
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(tax_withheld: SKIP, locality_name: SKIP, income: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @tax_withheld = tax_withheld unless tax_withheld == SKIP
+      @locality_name = locality_name unless locality_name == SKIP
+      @income = income unless income == 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.
+      tax_withheld = hash.key?('taxWithheld') ? hash['taxWithheld'] : SKIP
+      locality_name = hash.key?('localityName') ? hash['localityName'] : SKIP
+      income = hash.key?('income') ? hash['income'] : 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.
+      LocalTaxWithholding.new(tax_withheld: tax_withheld,
+                              locality_name: locality_name,
+                              income: income,
+                              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} tax_withheld: #{@tax_withheld}, locality_name: #{@locality_name}, income:"\
+      " #{@income}, 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} tax_withheld: #{@tax_withheld.inspect}, locality_name:"\
+      " #{@locality_name.inspect}, income: #{@income.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/local_tax_withholding1.rb

@@ -0,0 +1,96 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Amount of local income tax withheld, if any
+  class LocalTaxWithholding1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Amount of local income tax withheld
+    # @return [Float]
+    attr_accessor :tax_withheld
+
+    # Locality name
+    # @return [String]
+    attr_accessor :locality_name
+
+    # Income amount for local tax purposes
+    # @return [Float]
+    attr_accessor :income
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['tax_withheld'] = 'taxWithheld'
+      @_hash['locality_name'] = 'localityName'
+      @_hash['income'] = 'income'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        tax_withheld
+        locality_name
+        income
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(tax_withheld: SKIP, locality_name: SKIP, income: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @tax_withheld = tax_withheld unless tax_withheld == SKIP
+      @locality_name = locality_name unless locality_name == SKIP
+      @income = income unless income == 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.
+      tax_withheld = hash.key?('taxWithheld') ? hash['taxWithheld'] : SKIP
+      locality_name = hash.key?('localityName') ? hash['localityName'] : SKIP
+      income = hash.key?('income') ? hash['income'] : 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.
+      LocalTaxWithholding1.new(tax_withheld: tax_withheld,
+                               locality_name: locality_name,
+                               income: income,
+                               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} tax_withheld: #{@tax_withheld}, locality_name: #{@locality_name}, income:"\
+      " #{@income}, 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} tax_withheld: #{@tax_withheld.inspect}, locality_name:"\
+      " #{@locality_name.inspect}, income: #{@income.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/merchant_entity.rb

@@ -0,0 +1,159 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module FdxApi
+  # Business or person to whom bill payments can be sent for products or
+  # services
+  class MerchantEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # User defined name for the merchant. Used by the customer to identify the
+    # merchant. Not used by the system to process payments
+    # @return [String]
+    attr_accessor :display_name
+
+    # Name of the merchant used to execute the payment
+    # @return [CustomerNameEntity]
+    attr_accessor :name
+
+    # Address of the merchant used to execute the payment
+    # @return [DeliveryAddress1]
+    attr_accessor :address
+
+    # Phone number of the merchant used to execute the payment
+    # @return [TelephoneNumber]
+    attr_accessor :phone
+
+    # Account identifier(s) the customer has with the merchant
+    # @return [Array[String]]
+    attr_accessor :merchant_account_ids
+
+    # Persistent unique identifier for a merchant payee
+    # @return [String]
+    attr_accessor :payee_id
+
+    # Defines the Merchant's lifecycle
+    # @return [PartyStatus3]
+    attr_accessor :status
+
+    # Describes when the entity will be automatically deleted. The entity will
+    # not go into the "DELETED" state. If this value is null or not provided,
+    # the entity will not expire automatically
+    # @return [DateTime]
+    attr_accessor :expires_timestamp
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['display_name'] = 'displayName'
+      @_hash['name'] = 'name'
+      @_hash['address'] = 'address'
+      @_hash['phone'] = 'phone'
+      @_hash['merchant_account_ids'] = 'merchantAccountIds'
+      @_hash['payee_id'] = 'payeeId'
+      @_hash['status'] = 'status'
+      @_hash['expires_timestamp'] = 'expiresTimestamp'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        display_name
+        name
+        address
+        phone
+        merchant_account_ids
+        payee_id
+        expires_timestamp
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(status:, display_name: SKIP, name: SKIP, address: SKIP,
+                   phone: SKIP, merchant_account_ids: SKIP, payee_id: SKIP,
+                   expires_timestamp: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @display_name = display_name unless display_name == SKIP
+      @name = name unless name == SKIP
+      @address = address unless address == SKIP
+      @phone = phone unless phone == SKIP
+      @merchant_account_ids = merchant_account_ids unless merchant_account_ids == SKIP
+      @payee_id = payee_id unless payee_id == SKIP
+      @status = status
+      @expires_timestamp = expires_timestamp unless expires_timestamp == 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'] : nil
+      display_name = hash.key?('displayName') ? hash['displayName'] : SKIP
+      name = CustomerNameEntity.from_hash(hash['name']) if hash['name']
+      address = DeliveryAddress1.from_hash(hash['address']) if hash['address']
+      phone = TelephoneNumber.from_hash(hash['phone']) if hash['phone']
+      merchant_account_ids =
+        hash.key?('merchantAccountIds') ? hash['merchantAccountIds'] : SKIP
+      payee_id = hash.key?('payeeId') ? hash['payeeId'] : SKIP
+      expires_timestamp = if hash.key?('expiresTimestamp')
+                            (DateTimeHelper.from_rfc3339(hash['expiresTimestamp']) if hash['expiresTimestamp'])
+                          else
+                            SKIP
+                          end
+
+      # 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.
+      MerchantEntity.new(status: status,
+                         display_name: display_name,
+                         name: name,
+                         address: address,
+                         phone: phone,
+                         merchant_account_ids: merchant_account_ids,
+                         payee_id: payee_id,
+                         expires_timestamp: expires_timestamp,
+                         additional_properties: additional_properties)
+    end
+
+    def to_custom_expires_timestamp
+      DateTimeHelper.to_rfc3339(expires_timestamp)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} display_name: #{@display_name}, name: #{@name}, address: #{@address},"\
+      " phone: #{@phone}, merchant_account_ids: #{@merchant_account_ids}, payee_id: #{@payee_id},"\
+      " status: #{@status}, expires_timestamp: #{@expires_timestamp}, 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} display_name: #{@display_name.inspect}, name: #{@name.inspect}, address:"\
+      " #{@address.inspect}, phone: #{@phone.inspect}, merchant_account_ids:"\
+      " #{@merchant_account_ids.inspect}, payee_id: #{@payee_id.inspect}, status:"\
+      " #{@status.inspect}, expires_timestamp: #{@expires_timestamp.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end