fdx-api-sdk-ruby 1.0.0

data/lib/fdx_api/models/timeframe_based_limits_for_a_payment_network5.rb

@@ -0,0 +1,138 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module FdxApi
+  # The transfer limits for the current day
+  class TimeframeBasedLimitsForAPaymentNetwork5 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Date/time at which this timeframe will reset next
+    # @return [DateTime]
+    attr_accessor :resets_on
+
+    # Maximum limit of funds that can be transferred to/from the account in this
+    # timeframe
+    # @return [Float]
+    attr_accessor :transfer_max_amount
+
+    # Remaining value of the maximum limit of funds that can be transferred
+    # to/from the account in this timeframe
+    # @return [Float]
+    attr_accessor :transfer_remaining_amount
+
+    # Maximum number of transfers that can be made in this direction for this
+    # timeframe
+    # @return [Integer]
+    attr_accessor :max_occurrence
+
+    # Remaining number of transfers that can be made in this direction for this
+    # timeframe
+    # @return [Integer]
+    attr_accessor :remaining_occurrence
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['resets_on'] = 'resetsOn'
+      @_hash['transfer_max_amount'] = 'transferMaxAmount'
+      @_hash['transfer_remaining_amount'] = 'transferRemainingAmount'
+      @_hash['max_occurrence'] = 'maxOccurrence'
+      @_hash['remaining_occurrence'] = 'remainingOccurrence'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        resets_on
+        transfer_max_amount
+        transfer_remaining_amount
+        max_occurrence
+        remaining_occurrence
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(resets_on: SKIP, transfer_max_amount: SKIP,
+                   transfer_remaining_amount: SKIP, max_occurrence: SKIP,
+                   remaining_occurrence: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @resets_on = resets_on unless resets_on == SKIP
+      @transfer_max_amount = transfer_max_amount unless transfer_max_amount == SKIP
+      unless transfer_remaining_amount == SKIP
+        @transfer_remaining_amount =
+          transfer_remaining_amount
+      end
+      @max_occurrence = max_occurrence unless max_occurrence == SKIP
+      @remaining_occurrence = remaining_occurrence unless remaining_occurrence == 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.
+      resets_on = if hash.key?('resetsOn')
+                    (DateTimeHelper.from_rfc3339(hash['resetsOn']) if hash['resetsOn'])
+                  else
+                    SKIP
+                  end
+      transfer_max_amount =
+        hash.key?('transferMaxAmount') ? hash['transferMaxAmount'] : SKIP
+      transfer_remaining_amount =
+        hash.key?('transferRemainingAmount') ? hash['transferRemainingAmount'] : SKIP
+      max_occurrence = hash.key?('maxOccurrence') ? hash['maxOccurrence'] : SKIP
+      remaining_occurrence =
+        hash.key?('remainingOccurrence') ? hash['remainingOccurrence'] : 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.
+      TimeframeBasedLimitsForAPaymentNetwork5.new(resets_on: resets_on,
+                                                  transfer_max_amount: transfer_max_amount,
+                                                  transfer_remaining_amount: transfer_remaining_amount,
+                                                  max_occurrence: max_occurrence,
+                                                  remaining_occurrence: remaining_occurrence,
+                                                  additional_properties: additional_properties)
+    end
+
+    def to_custom_resets_on
+      DateTimeHelper.to_rfc3339(resets_on)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} resets_on: #{@resets_on}, transfer_max_amount: #{@transfer_max_amount},"\
+      " transfer_remaining_amount: #{@transfer_remaining_amount}, max_occurrence:"\
+      " #{@max_occurrence}, remaining_occurrence: #{@remaining_occurrence}, 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} resets_on: #{@resets_on.inspect}, transfer_max_amount:"\
+      " #{@transfer_max_amount.inspect}, transfer_remaining_amount:"\
+      " #{@transfer_remaining_amount.inspect}, max_occurrence: #{@max_occurrence.inspect},"\
+      " remaining_occurrence: #{@remaining_occurrence.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/transaction.rb

@@ -0,0 +1,357 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module FdxApi
+  # Base entity for financial transactions
+  class Transaction < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :account_category
+
+    # Corresponds to AccountId in Account
+    # @return [String]
+    attr_accessor :account_id
+
+    # Long term persistent identity of the transaction (unique to account)
+    # @return [String]
+    attr_accessor :transaction_id
+
+    # For reverse postings, the identity of the transaction being reversed. For
+    # the correction transaction, the identity of the reversing post. For credit
+    # card posting transactions, the identity of the authorization transaction
+    # @return [String]
+    attr_accessor :reference_transaction_id
+
+    # The date and time that the transaction was posted to the account. If not
+    # provided then TransactionTimestamp can be used as PostedTimeStamp
+    # @return [DateTime]
+    attr_accessor :posted_timestamp
+
+    # The date and time that the transaction was added to the server backend
+    # systems
+    # @return [DateTime]
+    attr_accessor :transaction_timestamp
+
+    # The description of the transaction, such as information about a merchant's
+    # name or place of business in a manner that is user friendly and accessible
+    # to the customer
+    # @return [String]
+    attr_accessor :description
+
+    # Secondary transaction description
+    # @return [String]
+    attr_accessor :memo
+
+    # DEBIT, CREDIT, MEMO
+    # @return [DebitCreditMemo2]
+    attr_accessor :debit_credit_memo
+
+    # Transaction category, preferably MCC or SIC.
+    # @return [String]
+    attr_accessor :category
+
+    # Transaction category detail specifying the standard of the transaction
+    # category. For example, "MCC"
+    # @return [String]
+    attr_accessor :sub_category
+
+    # A tracking reference identifier
+    # @return [String]
+    attr_accessor :reference
+
+    # PENDING, MEMO, POSTED, AUTHORIZATION
+    # @return [TransactionStatus2]
+    attr_accessor :status
+
+    # The amount of money in the account currency
+    # @return [Float]
+    attr_accessor :amount
+
+    # The amount of money in the foreign currency
+    # @return [Float]
+    attr_accessor :foreign_amount
+
+    # The ISO 4217 code of the foreign currency
+    # @return [Iso4217CurrencyCode2]
+    attr_accessor :foreign_currency
+
+    # Array of Image Identifiers (unique to this transaction) used to retrieve
+    # Images of check or transaction receipt
+    # @return [Array[String]]
+    attr_accessor :image_ids
+
+    # Breakdown of the transaction details
+    # @return [Array[LineItemEntity]]
+    attr_accessor :line_item
+
+    # Rewards earned with this transaction
+    # @return [TransactionRewardEntity2]
+    attr_accessor :reward
+
+    # Array of FI-specific attributes
+    # @return [Array[FiAttributeEntity]]
+    attr_accessor :fi_attributes
+
+    # Links (unique to this transaction) used to retrieve images of checks or
+    # transaction receipts
+    # @return [Array[HateoasLink]]
+    attr_accessor :links
+
+    # Discriminators mapping.
+    def self.discriminators
+      if @_discriminators.nil?
+        @_discriminators = {}
+        @_discriminators['Commercial Transaction entity'] = CommercialTransactionEntity
+        @_discriminators['Deposit Transaction entity'] = DepositTransactionEntity
+        @_discriminators['Digital Wallet Transaction entity'] = DigitalWalletTransactionEntity
+        @_discriminators['Insurance Transaction entity'] = InsuranceTransactionEntity
+        @_discriminators['Investment Transaction entity'] = InvestmentTransactionEntity
+        @_discriminators['Line of Credit Transaction entity'] = LineOfCreditTransactionEntity
+        @_discriminators['Loan Transaction entity'] = LoanTransactionEntity
+      end
+      @_discriminators
+    end
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_category'] = 'accountCategory'
+      @_hash['account_id'] = 'accountId'
+      @_hash['transaction_id'] = 'transactionId'
+      @_hash['reference_transaction_id'] = 'referenceTransactionId'
+      @_hash['posted_timestamp'] = 'postedTimestamp'
+      @_hash['transaction_timestamp'] = 'transactionTimestamp'
+      @_hash['description'] = 'description'
+      @_hash['memo'] = 'memo'
+      @_hash['debit_credit_memo'] = 'debitCreditMemo'
+      @_hash['category'] = 'category'
+      @_hash['sub_category'] = 'subCategory'
+      @_hash['reference'] = 'reference'
+      @_hash['status'] = 'status'
+      @_hash['amount'] = 'amount'
+      @_hash['foreign_amount'] = 'foreignAmount'
+      @_hash['foreign_currency'] = 'foreignCurrency'
+      @_hash['image_ids'] = 'imageIds'
+      @_hash['line_item'] = 'lineItem'
+      @_hash['reward'] = 'reward'
+      @_hash['fi_attributes'] = 'fiAttributes'
+      @_hash['links'] = 'links'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_category
+        account_id
+        transaction_id
+        reference_transaction_id
+        posted_timestamp
+        transaction_timestamp
+        description
+        memo
+        debit_credit_memo
+        category
+        sub_category
+        reference
+        status
+        amount
+        foreign_amount
+        foreign_currency
+        image_ids
+        line_item
+        reward
+        fi_attributes
+        links
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_category: 'Transaction', 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)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @account_category = account_category unless account_category == SKIP
+      @account_id = account_id unless account_id == SKIP
+      @transaction_id = transaction_id unless transaction_id == SKIP
+      @reference_transaction_id = reference_transaction_id unless reference_transaction_id == SKIP
+      @posted_timestamp = posted_timestamp unless posted_timestamp == SKIP
+      @transaction_timestamp = transaction_timestamp unless transaction_timestamp == SKIP
+      @description = description unless description == SKIP
+      @memo = memo unless memo == SKIP
+      @debit_credit_memo = debit_credit_memo unless debit_credit_memo == SKIP
+      @category = category unless category == SKIP
+      @sub_category = sub_category unless sub_category == SKIP
+      @reference = reference unless reference == SKIP
+      @status = status unless status == SKIP
+      @amount = amount unless amount == SKIP
+      @foreign_amount = foreign_amount unless foreign_amount == SKIP
+      @foreign_currency = foreign_currency unless foreign_currency == SKIP
+      @image_ids = image_ids unless image_ids == SKIP
+      @line_item = line_item unless line_item == SKIP
+      @reward = reward unless reward == SKIP
+      @fi_attributes = fi_attributes unless fi_attributes == SKIP
+      @links = links unless links == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Delegate unboxing to another function if a discriminator
+      # value for a child class is present.
+      unboxer = discriminators[hash['accountCategory']]
+      return unboxer.send(:from_hash, hash) if unboxer
+
+      # Extract variables from the hash.
+      account_category = hash['accountCategory'] ||= 'Transaction'
+      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.
+      Transaction.new(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
+
+    def to_custom_posted_timestamp
+      DateTimeHelper.to_rfc3339(posted_timestamp)
+    end
+
+    def to_custom_transaction_timestamp
+      DateTimeHelper.to_rfc3339(transaction_timestamp)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} 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
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} account_category: #{@account_category.inspect}, account_id:"\
+      " #{@account_id.inspect}, transaction_id: #{@transaction_id.inspect},"\
+      " reference_transaction_id: #{@reference_transaction_id.inspect}, posted_timestamp:"\
+      " #{@posted_timestamp.inspect}, transaction_timestamp: #{@transaction_timestamp.inspect},"\
+      " description: #{@description.inspect}, memo: #{@memo.inspect}, debit_credit_memo:"\
+      " #{@debit_credit_memo.inspect}, category: #{@category.inspect}, sub_category:"\
+      " #{@sub_category.inspect}, reference: #{@reference.inspect}, status: #{@status.inspect},"\
+      " amount: #{@amount.inspect}, foreign_amount: #{@foreign_amount.inspect}, foreign_currency:"\
+      " #{@foreign_currency.inspect}, image_ids: #{@image_ids.inspect}, line_item:"\
+      " #{@line_item.inspect}, reward: #{@reward.inspect}, fi_attributes:"\
+      " #{@fi_attributes.inspect}, links: #{@links.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/transaction_reason.rb

@@ -0,0 +1,26 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # The reason for an investment transaction
+  class TransactionReason
+    TRANSACTION_REASON = [
+      # TODO: Write general description for CALL
+      CALL = 'CALL'.freeze,
+
+      # TODO: Write general description for MATURITY
+      MATURITY = 'MATURITY'.freeze,
+
+      # TODO: Write general description for SELL
+      SELL = 'SELL'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/transaction_reason2.rb

@@ -0,0 +1,27 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Reason for this transaction; CALL (the debt was called), SELL (the debt was
+  # sold), MATURITY (the debt reached maturity)
+  class TransactionReason2
+    TRANSACTION_REASON2 = [
+      # TODO: Write general description for CALL
+      CALL = 'CALL'.freeze,
+
+      # TODO: Write general description for MATURITY
+      MATURITY = 'MATURITY'.freeze,
+
+      # TODO: Write general description for SELL
+      SELL = 'SELL'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/transaction_reward_entity.rb

@@ -0,0 +1,97 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Rewards earned on a transaction
+  class TransactionRewardEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Long term persistent identity of the reward category. This ID is mapped to
+    # a category definition returned by calling the getRewardProgramCategories
+    # operation
+    # @return [String]
+    attr_accessor :category_id
+
+    # Reward units accrued on this transaction
+    # @return [Float]
+    attr_accessor :accrued
+
+    # Reward units adjusted on this transaction
+    # @return [Float]
+    attr_accessor :adjusted
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['category_id'] = 'categoryId'
+      @_hash['accrued'] = 'accrued'
+      @_hash['adjusted'] = 'adjusted'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        category_id
+        accrued
+        adjusted
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(category_id: SKIP, accrued: SKIP, adjusted: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @category_id = category_id unless category_id == SKIP
+      @accrued = accrued unless accrued == SKIP
+      @adjusted = adjusted unless adjusted == 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.
+      category_id = hash.key?('categoryId') ? hash['categoryId'] : SKIP
+      accrued = hash.key?('accrued') ? hash['accrued'] : SKIP
+      adjusted = hash.key?('adjusted') ? hash['adjusted'] : 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.
+      TransactionRewardEntity.new(category_id: category_id,
+                                  accrued: accrued,
+                                  adjusted: adjusted,
+                                  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} category_id: #{@category_id}, accrued: #{@accrued}, adjusted: #{@adjusted},"\
+      " 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} category_id: #{@category_id.inspect}, accrued: #{@accrued.inspect},"\
+      " adjusted: #{@adjusted.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end