apimatic-ak-sdk 0.0.1

data/lib/akoya/models/deposit_transaction.rb

@@ -0,0 +1,369 @@
+# akoya
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module Akoya
+  # Deposit transaction
+  class DepositTransaction < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Corresponds to AccountId in Account
+    # @return [String]
+    attr_accessor :account_id
+
+    # The amount of money in the account currency.
+    # If balanceType is `ASSET`:
+    #   1. If `debitCreditMemo` = `DEBIT`, sign is "+" or not present
+    #   2. If `CREDIT`, sign is "-"
+    # If balanceType is `LIABILITY`:
+    #   1. If `debitCreditMemo` = `DEBIT`, sign is "-"
+    #   2. If `CREDIT`, sign is "+" or not present
+    # @return [Float]
+    attr_accessor :amount
+
+    # Transaction category, preferably MCC or SIC.
+    # @return [String]
+    attr_accessor :category
+
+    # Akoya will ensure that this is correctly populated with one of DEBIT or
+    # CREDIT and matches the sign of the status field.
+    # @return [DebitCreditMemo]
+    attr_accessor :debit_credit_memo
+
+    # The description of the transaction
+    # @return [String]
+    attr_accessor :description
+
+    # Array of image identifiers (unique to transaction) used to retrieve images
+    # of check or transaction receipt.
+    # @return [Array[String]]
+    attr_accessor :image_ids
+
+    # Array of FI-specific attributes
+    # @return [Array[FiAttributeEntity]]
+    attr_accessor :fi_attributes
+
+    # The amount of money in the foreign currency
+    # @return [Float]
+    attr_accessor :foreign_amount
+
+    # The ISO 4217 code of the foreign currency
+    # @return [String]
+    attr_accessor :foreign_currency
+
+    # Breakdown of the transaction details
+    # @return [Array[LineItem]]
+    attr_accessor :line_item
+
+    # Links (unique to this Transaction) used to retrieve images of checks or
+    # transaction receipts, or invoke other APIs
+    # @return [Array[HateoasLink]]
+    attr_accessor :links
+
+    # Secondary transaction description
+    # @return [String]
+    attr_accessor :memo
+
+    # 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
+
+    # A tracking reference identifier
+    # @return [String]
+    attr_accessor :reference
+
+    # Akoya ensures that this field is populated for all transactions which are
+    # reversals, otherwise it is null. Either way it is always present.
+    # 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
+
+    # AUTHORIZATION, MEMO, PENDING, or POSTED
+    # @return [StatusDepositTransaction]
+    attr_accessor :status
+
+    # Transaction category detail
+    # @return [String]
+    attr_accessor :sub_category
+
+    # Long term persistent identity of the transaction (unique to account). 
+    # Transaction IDs should: 
+    #   
+    #   1. be the same for pending and posted 
+    #   2. be different for reversed transactions 
+    #   3. `referenceTransactionId` should be present for reversed transactions'
+    # @return [String]
+    attr_accessor :transaction_id
+
+    # The date and time that the transaction was added to the server backend
+    # systems.
+    # Akoya ensures that this field is populated for all transactions to which
+    # it applies, otherwise it is null. Either way it is always present.
+    # @return [DateTime]
+    attr_accessor :transaction_timestamp
+
+    # Payee name
+    # @return [String]
+    attr_accessor :payee
+
+    # Check Number
+    # @return [Integer]
+    attr_accessor :check_number
+
+    # DepositTransaction Type
+    # @return [TransactionType]
+    attr_accessor :transaction_type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_id'] = 'accountId'
+      @_hash['amount'] = 'amount'
+      @_hash['category'] = 'category'
+      @_hash['debit_credit_memo'] = 'debitCreditMemo'
+      @_hash['description'] = 'description'
+      @_hash['image_ids'] = 'imageIds'
+      @_hash['fi_attributes'] = 'fiAttributes'
+      @_hash['foreign_amount'] = 'foreignAmount'
+      @_hash['foreign_currency'] = 'foreignCurrency'
+      @_hash['line_item'] = 'lineItem'
+      @_hash['links'] = 'links'
+      @_hash['memo'] = 'memo'
+      @_hash['posted_timestamp'] = 'postedTimestamp'
+      @_hash['reference'] = 'reference'
+      @_hash['reference_transaction_id'] = 'referenceTransactionId'
+      @_hash['status'] = 'status'
+      @_hash['sub_category'] = 'subCategory'
+      @_hash['transaction_id'] = 'transactionId'
+      @_hash['transaction_timestamp'] = 'transactionTimestamp'
+      @_hash['payee'] = 'payee'
+      @_hash['check_number'] = 'checkNumber'
+      @_hash['transaction_type'] = 'transactionType'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_id
+        amount
+        category
+        debit_credit_memo
+        description
+        image_ids
+        fi_attributes
+        foreign_amount
+        foreign_currency
+        line_item
+        links
+        memo
+        posted_timestamp
+        reference
+        reference_transaction_id
+        status
+        sub_category
+        transaction_id
+        transaction_timestamp
+        payee
+        check_number
+        transaction_type
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_id: SKIP, amount: SKIP, category: SKIP,
+                   debit_credit_memo: SKIP, description: SKIP, image_ids: SKIP,
+                   fi_attributes: SKIP, foreign_amount: SKIP,
+                   foreign_currency: SKIP, line_item: SKIP, links: SKIP,
+                   memo: SKIP, posted_timestamp: SKIP, reference: SKIP,
+                   reference_transaction_id: SKIP, status: SKIP,
+                   sub_category: SKIP, transaction_id: SKIP,
+                   transaction_timestamp: SKIP, payee: SKIP, check_number: SKIP,
+                   transaction_type: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @account_id = account_id unless account_id == SKIP
+      @amount = amount unless amount == SKIP
+      @category = category unless category == SKIP
+      @debit_credit_memo = debit_credit_memo unless debit_credit_memo == SKIP
+      @description = description unless description == SKIP
+      @image_ids = image_ids unless image_ids == SKIP
+      @fi_attributes = fi_attributes unless fi_attributes == SKIP
+      @foreign_amount = foreign_amount unless foreign_amount == SKIP
+      @foreign_currency = foreign_currency unless foreign_currency == SKIP
+      @line_item = line_item unless line_item == SKIP
+      @links = links unless links == SKIP
+      @memo = memo unless memo == SKIP
+      @posted_timestamp = posted_timestamp unless posted_timestamp == SKIP
+      @reference = reference unless reference == SKIP
+      @reference_transaction_id = reference_transaction_id unless reference_transaction_id == SKIP
+      @status = status unless status == SKIP
+      @sub_category = sub_category unless sub_category == SKIP
+      @transaction_id = transaction_id unless transaction_id == SKIP
+      @transaction_timestamp = transaction_timestamp unless transaction_timestamp == SKIP
+      @payee = payee unless payee == SKIP
+      @check_number = check_number unless check_number == SKIP
+      @transaction_type = transaction_type unless transaction_type == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      account_id = hash.key?('accountId') ? hash['accountId'] : SKIP
+      amount = hash.key?('amount') ? hash['amount'] : SKIP
+      category = hash.key?('category') ? hash['category'] : SKIP
+      debit_credit_memo =
+        hash.key?('debitCreditMemo') ? hash['debitCreditMemo'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      image_ids = hash.key?('imageIds') ? hash['imageIds'] : SKIP
+      # 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')
+      foreign_amount = hash.key?('foreignAmount') ? hash['foreignAmount'] : SKIP
+      foreign_currency =
+        hash.key?('foreignCurrency') ? hash['foreignCurrency'] : 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 << (LineItem.from_hash(structure) if structure)
+        end
+      end
+
+      line_item = SKIP unless hash.key?('lineItem')
+      # 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')
+      memo = hash.key?('memo') ? hash['memo'] : SKIP
+      posted_timestamp = if hash.key?('postedTimestamp')
+                           (DateTimeHelper.from_rfc3339(hash['postedTimestamp']) if hash['postedTimestamp'])
+                         else
+                           SKIP
+                         end
+      reference = hash.key?('reference') ? hash['reference'] : SKIP
+      reference_transaction_id =
+        hash.key?('referenceTransactionId') ? hash['referenceTransactionId'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      sub_category = hash.key?('subCategory') ? hash['subCategory'] : SKIP
+      transaction_id = hash.key?('transactionId') ? hash['transactionId'] : SKIP
+      transaction_timestamp = if hash.key?('transactionTimestamp')
+                                (DateTimeHelper.from_rfc3339(hash['transactionTimestamp']) if hash['transactionTimestamp'])
+                              else
+                                SKIP
+                              end
+      payee = hash.key?('payee') ? hash['payee'] : SKIP
+      check_number = hash.key?('checkNumber') ? hash['checkNumber'] : SKIP
+      transaction_type =
+        hash.key?('transactionType') ? hash['transactionType'] : 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.
+      DepositTransaction.new(account_id: account_id,
+                             amount: amount,
+                             category: category,
+                             debit_credit_memo: debit_credit_memo,
+                             description: description,
+                             image_ids: image_ids,
+                             fi_attributes: fi_attributes,
+                             foreign_amount: foreign_amount,
+                             foreign_currency: foreign_currency,
+                             line_item: line_item,
+                             links: links,
+                             memo: memo,
+                             posted_timestamp: posted_timestamp,
+                             reference: reference,
+                             reference_transaction_id: reference_transaction_id,
+                             status: status,
+                             sub_category: sub_category,
+                             transaction_id: transaction_id,
+                             transaction_timestamp: transaction_timestamp,
+                             payee: payee,
+                             check_number: check_number,
+                             transaction_type: transaction_type,
+                             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
+
+    # Validates an instance of the object from a given value.
+    # @param [DepositTransaction | 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} account_id: #{@account_id}, amount: #{@amount}, category: #{@category},"\
+      " debit_credit_memo: #{@debit_credit_memo}, description: #{@description}, image_ids:"\
+      " #{@image_ids}, fi_attributes: #{@fi_attributes}, foreign_amount: #{@foreign_amount},"\
+      " foreign_currency: #{@foreign_currency}, line_item: #{@line_item}, links: #{@links}, memo:"\
+      " #{@memo}, posted_timestamp: #{@posted_timestamp}, reference: #{@reference},"\
+      " reference_transaction_id: #{@reference_transaction_id}, status: #{@status}, sub_category:"\
+      " #{@sub_category}, transaction_id: #{@transaction_id}, transaction_timestamp:"\
+      " #{@transaction_timestamp}, payee: #{@payee}, check_number: #{@check_number},"\
+      " transaction_type: #{@transaction_type}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} account_id: #{@account_id.inspect}, amount: #{@amount.inspect}, category:"\
+      " #{@category.inspect}, debit_credit_memo: #{@debit_credit_memo.inspect}, description:"\
+      " #{@description.inspect}, image_ids: #{@image_ids.inspect}, fi_attributes:"\
+      " #{@fi_attributes.inspect}, foreign_amount: #{@foreign_amount.inspect}, foreign_currency:"\
+      " #{@foreign_currency.inspect}, line_item: #{@line_item.inspect}, links: #{@links.inspect},"\
+      " memo: #{@memo.inspect}, posted_timestamp: #{@posted_timestamp.inspect}, reference:"\
+      " #{@reference.inspect}, reference_transaction_id: #{@reference_transaction_id.inspect},"\
+      " status: #{@status.inspect}, sub_category: #{@sub_category.inspect}, transaction_id:"\
+      " #{@transaction_id.inspect}, transaction_timestamp: #{@transaction_timestamp.inspect},"\
+      " payee: #{@payee.inspect}, check_number: #{@check_number.inspect}, transaction_type:"\
+      " #{@transaction_type.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/akoya/models/deposit_transaction_details.rb

@@ -0,0 +1,87 @@
+# akoya
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Akoya
+  # DepositTransactionDetails Model.
+  class DepositTransactionDetails < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Deposit transaction
+    # @return [DepositTransaction]
+    attr_accessor :deposit_transaction
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['deposit_transaction'] = 'depositTransaction'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        deposit_transaction
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(deposit_transaction: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @deposit_transaction = deposit_transaction unless deposit_transaction == 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.
+      deposit_transaction = DepositTransaction.from_hash(hash['depositTransaction']) if
+        hash['depositTransaction']
+
+      # 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.
+      DepositTransactionDetails.new(deposit_transaction: deposit_transaction,
+                                    additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [DepositTransactionDetails | 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} deposit_transaction: #{@deposit_transaction}, 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} deposit_transaction: #{@deposit_transaction.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/akoya/models/domicile.rb

@@ -0,0 +1,85 @@
+# akoya
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Akoya
+  # The country and region of the business customer's location
+  class Domicile < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :region
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :country
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['region'] = 'region'
+      @_hash['country'] = 'country'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        region
+        country
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(region: SKIP, country: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @region = region unless region == SKIP
+      @country = country unless country == 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.
+      region = hash.key?('region') ? hash['region'] : SKIP
+      country = hash.key?('country') ? hash['country'] : 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.
+      Domicile.new(region: region,
+                   country: country,
+                   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} region: #{@region}, country: #{@country}, 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} region: #{@region.inspect}, country: #{@country.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end