fdx-api-sdk-ruby 1.0.0

data/lib/fdx_api/models/transaction_reward_entity2.rb

@@ -0,0 +1,107 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Rewards earned with this transaction
+  class TransactionRewardEntity2 < 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.
+      TransactionRewardEntity2.new(category_id: category_id,
+                                   accrued: accrued,
+                                   adjusted: adjusted,
+                                   additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [TransactionRewardEntity2 | 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} 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

data/lib/fdx_api/models/transaction_status.rb

@@ -0,0 +1,29 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # The status of a transaction
+  class TransactionStatus
+    TRANSACTION_STATUS = [
+      # TODO: Write general description for AUTHORIZATION
+      AUTHORIZATION = 'AUTHORIZATION'.freeze,
+
+      # TODO: Write general description for MEMO
+      MEMO = 'MEMO'.freeze,
+
+      # TODO: Write general description for PENDING
+      PENDING = 'PENDING'.freeze,
+
+      # TODO: Write general description for POSTED
+      POSTED = 'POSTED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/transaction_status2.rb

@@ -0,0 +1,29 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # PENDING, MEMO, POSTED, AUTHORIZATION
+  class TransactionStatus2
+    TRANSACTION_STATUS2 = [
+      # TODO: Write general description for AUTHORIZATION
+      AUTHORIZATION = 'AUTHORIZATION'.freeze,
+
+      # TODO: Write general description for MEMO
+      MEMO = 'MEMO'.freeze,
+
+      # TODO: Write general description for PENDING
+      PENDING = 'PENDING'.freeze,
+
+      # TODO: Write general description for POSTED
+      POSTED = 'POSTED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/transactions_entity.rb

@@ -0,0 +1,109 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Optionally paginated array of transactions
+  class TransactionsEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Offset IDs for navigating result sets
+    # @return [PageMetadata]
+    attr_accessor :page
+
+    # Resource URLs for navigating result sets
+    # @return [PageMetadataLinks]
+    attr_accessor :links
+
+    # An array of transactions with entity type dependent on the account type
+    # (commercial, deposit, insurance, investment, line of credit, loan or
+    # digital wallet)
+    # @return [Array[Object]]
+    attr_accessor :transactions
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['page'] = 'page'
+      @_hash['links'] = 'links'
+      @_hash['transactions'] = 'transactions'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        page
+        links
+        transactions
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(page: SKIP, links: SKIP, transactions: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @page = page unless page == SKIP
+      @links = links unless links == SKIP
+      @transactions = transactions unless transactions == 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.
+      page = PageMetadata.from_hash(hash['page']) if hash['page']
+      links = PageMetadataLinks.from_hash(hash['links']) if hash['links']
+      transactions = hash.key?('transactions') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:TransactionsEntityTransactions), hash['transactions']
+      ) : 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.
+      TransactionsEntity.new(page: page,
+                             links: links,
+                             transactions: transactions,
+                             additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [TransactionsEntity | 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} page: #{@page}, links: #{@links}, transactions: #{@transactions},"\
+      " 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} page: #{@page.inspect}, links: #{@links.inspect}, transactions:"\
+      " #{@transactions.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/transfer_entity.rb

@@ -0,0 +1,169 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module FdxApi
+  # A single transfer of money. Refer to Transfers for a list of multiple
+  # transfers.
+  class TransferEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Client generated, long-term persistent identity of the transfer action.
+    # This ID should be maintained and returned by institution
+    # @return [String]
+    attr_accessor :transfer_id
+
+    # Long-term persistent identity of the source account
+    # @return [String]
+    attr_accessor :from_account_id
+
+    # Long-term persistent identity of the destination account
+    # @return [String]
+    attr_accessor :to_account_id
+
+    # Positive amount of money to be transferred
+    # @return [Float]
+    attr_accessor :amount
+
+    # User-entered reason for transfer
+    # @return [String]
+    attr_accessor :memo
+
+    # Payment details
+    # @return [PaymentDetailsEntity]
+    attr_accessor :payment_details
+
+    # Long-term persistent identifier for transfer attempt
+    # @return [String]
+    attr_accessor :reference_id
+
+    # CANCELLED, FAILED, NOFUNDS, PROCESSED, PROCESSING, SCHEDULED
+    # @return [PaymentStatus1]
+    attr_accessor :status
+
+    # Date of transfer attempt
+    # @return [DateTime]
+    attr_accessor :transfer_time
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['transfer_id'] = 'transferId'
+      @_hash['from_account_id'] = 'fromAccountId'
+      @_hash['to_account_id'] = 'toAccountId'
+      @_hash['amount'] = 'amount'
+      @_hash['memo'] = 'memo'
+      @_hash['payment_details'] = 'paymentDetails'
+      @_hash['reference_id'] = 'referenceId'
+      @_hash['status'] = 'status'
+      @_hash['transfer_time'] = 'transferTime'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        transfer_id
+        from_account_id
+        to_account_id
+        amount
+        memo
+        payment_details
+        reference_id
+        status
+        transfer_time
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(transfer_id: SKIP, from_account_id: SKIP,
+                   to_account_id: SKIP, amount: SKIP, memo: SKIP,
+                   payment_details: SKIP, reference_id: SKIP, status: SKIP,
+                   transfer_time: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @transfer_id = transfer_id unless transfer_id == SKIP
+      @from_account_id = from_account_id unless from_account_id == SKIP
+      @to_account_id = to_account_id unless to_account_id == SKIP
+      @amount = amount unless amount == SKIP
+      @memo = memo unless memo == SKIP
+      @payment_details = payment_details unless payment_details == SKIP
+      @reference_id = reference_id unless reference_id == SKIP
+      @status = status unless status == SKIP
+      @transfer_time = transfer_time unless transfer_time == 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.
+      transfer_id = hash.key?('transferId') ? hash['transferId'] : SKIP
+      from_account_id =
+        hash.key?('fromAccountId') ? hash['fromAccountId'] : SKIP
+      to_account_id = hash.key?('toAccountId') ? hash['toAccountId'] : SKIP
+      amount = hash.key?('amount') ? hash['amount'] : SKIP
+      memo = hash.key?('memo') ? hash['memo'] : SKIP
+      payment_details = PaymentDetailsEntity.from_hash(hash['paymentDetails']) if
+        hash['paymentDetails']
+      reference_id = hash.key?('referenceId') ? hash['referenceId'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      transfer_time = if hash.key?('transferTime')
+                        (DateTimeHelper.from_rfc3339(hash['transferTime']) if hash['transferTime'])
+                      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.
+      TransferEntity.new(transfer_id: transfer_id,
+                         from_account_id: from_account_id,
+                         to_account_id: to_account_id,
+                         amount: amount,
+                         memo: memo,
+                         payment_details: payment_details,
+                         reference_id: reference_id,
+                         status: status,
+                         transfer_time: transfer_time,
+                         additional_properties: additional_properties)
+    end
+
+    def to_custom_transfer_time
+      DateTimeHelper.to_rfc3339(transfer_time)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} transfer_id: #{@transfer_id}, from_account_id: #{@from_account_id},"\
+      " to_account_id: #{@to_account_id}, amount: #{@amount}, memo: #{@memo}, payment_details:"\
+      " #{@payment_details}, reference_id: #{@reference_id}, status: #{@status}, transfer_time:"\
+      " #{@transfer_time}, 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} transfer_id: #{@transfer_id.inspect}, from_account_id:"\
+      " #{@from_account_id.inspect}, to_account_id: #{@to_account_id.inspect}, amount:"\
+      " #{@amount.inspect}, memo: #{@memo.inspect}, payment_details: #{@payment_details.inspect},"\
+      " reference_id: #{@reference_id.inspect}, status: #{@status.inspect}, transfer_time:"\
+      " #{@transfer_time.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/transfer_for_create_entity.rb

@@ -0,0 +1,129 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Used to request a transfer
+  class TransferForCreateEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Client generated, long-term persistent identity of the transfer action.
+    # This ID should be maintained and returned by institution
+    # @return [String]
+    attr_accessor :transfer_id
+
+    # Long-term persistent identity of the source account
+    # @return [String]
+    attr_accessor :from_account_id
+
+    # Long-term persistent identity of the destination account
+    # @return [String]
+    attr_accessor :to_account_id
+
+    # Positive amount of money to be transferred
+    # @return [Float]
+    attr_accessor :amount
+
+    # User-entered reason for transfer
+    # @return [String]
+    attr_accessor :memo
+
+    # 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['transfer_id'] = 'transferId'
+      @_hash['from_account_id'] = 'fromAccountId'
+      @_hash['to_account_id'] = 'toAccountId'
+      @_hash['amount'] = 'amount'
+      @_hash['memo'] = 'memo'
+      @_hash['payment_details'] = 'paymentDetails'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        transfer_id
+        from_account_id
+        to_account_id
+        amount
+        memo
+        payment_details
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(transfer_id: SKIP, from_account_id: SKIP,
+                   to_account_id: SKIP, amount: SKIP, memo: SKIP,
+                   payment_details: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @transfer_id = transfer_id unless transfer_id == SKIP
+      @from_account_id = from_account_id unless from_account_id == SKIP
+      @to_account_id = to_account_id unless to_account_id == SKIP
+      @amount = amount unless amount == SKIP
+      @memo = memo unless memo == SKIP
+      @payment_details = payment_details unless payment_details == 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.
+      transfer_id = hash.key?('transferId') ? hash['transferId'] : SKIP
+      from_account_id =
+        hash.key?('fromAccountId') ? hash['fromAccountId'] : SKIP
+      to_account_id = hash.key?('toAccountId') ? hash['toAccountId'] : SKIP
+      amount = hash.key?('amount') ? hash['amount'] : SKIP
+      memo = hash.key?('memo') ? hash['memo'] : SKIP
+      payment_details = PaymentDetailsEntity.from_hash(hash['paymentDetails']) if
+        hash['paymentDetails']
+
+      # 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.
+      TransferForCreateEntity.new(transfer_id: transfer_id,
+                                  from_account_id: from_account_id,
+                                  to_account_id: to_account_id,
+                                  amount: amount,
+                                  memo: memo,
+                                  payment_details: payment_details,
+                                  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} transfer_id: #{@transfer_id}, from_account_id: #{@from_account_id},"\
+      " to_account_id: #{@to_account_id}, amount: #{@amount}, memo: #{@memo}, payment_details:"\
+      " #{@payment_details}, 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} transfer_id: #{@transfer_id.inspect}, from_account_id:"\
+      " #{@from_account_id.inspect}, to_account_id: #{@to_account_id.inspect}, amount:"\
+      " #{@amount.inspect}, memo: #{@memo.inspect}, payment_details: #{@payment_details.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end