fdx-api-sdk-ruby 1.0.0

data/lib/fdx_api/models/commercial_code_entity.rb

@@ -0,0 +1,91 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # The code for a specific treasury management defined field. The [X9 BTRS/BTR3
+  # standard](https://x9.org/standards/btrs/) (formerly named BAI2) for
+  # corporate and treasury data elements is proposed to provide the basis of (or
+  # starting point for) representing summary, account, and transaction codes for
+  # the Corp/Treasury Entity, subject to any necessary modifications useful to
+  # the members of the FDX consortium and users of the API specification
+  class CommercialCodeEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The source of Treasury Management account definition; one of BAI, BTRS,
+    # ISO, SWIFT
+    # @return [TreasuryManagementType]
+    attr_accessor :type
+
+    # The code of the Treasury Management defined field
+    # @return [String]
+    attr_accessor :code
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['code'] = 'code'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        type
+        code
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(type: SKIP, code: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @type = type unless type == SKIP
+      @code = code unless code == 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
+      code = hash.key?('code') ? hash['code'] : 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.
+      CommercialCodeEntity.new(type: type,
+                               code: code,
+                               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} type: #{@type}, code: #{@code}, 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}, code: #{@code.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/commercial_code_entity1.rb

@@ -0,0 +1,96 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # The code for a specific treasury management defined field
+  class CommercialCodeEntity1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The source of Treasury Management account definition; one of BAI, BTRS,
+    # ISO, SWIFT
+    # @return [TreasuryManagementType]
+    attr_accessor :type
+
+    # The code of the Treasury Management defined field
+    # @return [String]
+    attr_accessor :code
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['code'] = 'code'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        type
+        code
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(type: SKIP, code: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @type = type unless type == SKIP
+      @code = code unless code == 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
+      code = hash.key?('code') ? hash['code'] : 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.
+      CommercialCodeEntity1.new(type: type,
+                                code: code,
+                                additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CommercialCodeEntity1 | 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}, code: #{@code}, 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}, code: #{@code.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/commercial_transaction_entity.rb

@@ -0,0 +1,286 @@
+# 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 commercial account type
+  class CommercialTransactionEntity < Transaction
+    # Immediate available balance
+    # @return [Float]
+    attr_accessor :immediate_available_balance
+
+    # Next day available balance
+    # @return [Float]
+    attr_accessor :next_day_available_balance
+
+    # Two days plus available balance
+    # @return [Float]
+    attr_accessor :two_days_plus_available_balance
+
+    # Reference bank id
+    # @return [String]
+    attr_accessor :reference_bank_id
+
+    # Reference branch id
+    # @return [String]
+    attr_accessor :reference_branch_id
+
+    # Reference customer id
+    # @return [String]
+    attr_accessor :reference_customer_id
+
+    # The code for a specific treasury management defined field
+    # @return [CommercialCodeEntity1]
+    attr_accessor :commercial_code
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['immediate_available_balance'] = 'immediateAvailableBalance'
+      @_hash['next_day_available_balance'] = 'nextDayAvailableBalance'
+      @_hash['two_days_plus_available_balance'] =
+        'twoDaysPlusAvailableBalance'
+      @_hash['reference_bank_id'] = 'referenceBankId'
+      @_hash['reference_branch_id'] = 'referenceBranchId'
+      @_hash['reference_customer_id'] = 'referenceCustomerId'
+      @_hash['commercial_code'] = 'commercialCode'
+      @_hash = super().merge(@_hash)
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      _arr = %w[
+        immediate_available_balance
+        next_day_available_balance
+        two_days_plus_available_balance
+        reference_bank_id
+        reference_branch_id
+        reference_customer_id
+        commercial_code
+      ]
+      (_arr << super()).flatten!
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      _arr = []
+      (_arr << super()).flatten!
+    end
+
+    def initialize(immediate_available_balance: SKIP,
+                   next_day_available_balance: SKIP,
+                   two_days_plus_available_balance: SKIP,
+                   reference_bank_id: SKIP, reference_branch_id: SKIP,
+                   reference_customer_id: SKIP, commercial_code: SKIP,
+                   account_category: 'Commercial 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)
+      unless immediate_available_balance == SKIP
+        @immediate_available_balance =
+          immediate_available_balance
+      end
+      unless next_day_available_balance == SKIP
+        @next_day_available_balance =
+          next_day_available_balance
+      end
+      unless two_days_plus_available_balance == SKIP
+        @two_days_plus_available_balance =
+          two_days_plus_available_balance
+      end
+      @reference_bank_id = reference_bank_id unless reference_bank_id == SKIP
+      @reference_branch_id = reference_branch_id unless reference_branch_id == SKIP
+      @reference_customer_id = reference_customer_id unless reference_customer_id == SKIP
+      @commercial_code = commercial_code unless commercial_code == 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.
+      immediate_available_balance =
+        hash.key?('immediateAvailableBalance') ? hash['immediateAvailableBalance'] : SKIP
+      next_day_available_balance =
+        hash.key?('nextDayAvailableBalance') ? hash['nextDayAvailableBalance'] : SKIP
+      two_days_plus_available_balance =
+        hash.key?('twoDaysPlusAvailableBalance') ? hash['twoDaysPlusAvailableBalance'] : SKIP
+      reference_bank_id =
+        hash.key?('referenceBankId') ? hash['referenceBankId'] : SKIP
+      reference_branch_id =
+        hash.key?('referenceBranchId') ? hash['referenceBranchId'] : SKIP
+      reference_customer_id =
+        hash.key?('referenceCustomerId') ? hash['referenceCustomerId'] : SKIP
+      commercial_code = CommercialCodeEntity1.from_hash(hash['commercialCode']) if
+        hash['commercialCode']
+      account_category =
+        hash['accountCategory'] ||= 'Commercial 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.
+      CommercialTransactionEntity.new(immediate_available_balance: immediate_available_balance,
+                                      next_day_available_balance: next_day_available_balance,
+                                      two_days_plus_available_balance: two_days_plus_available_balance,
+                                      reference_bank_id: reference_bank_id,
+                                      reference_branch_id: reference_branch_id,
+                                      reference_customer_id: reference_customer_id,
+                                      commercial_code: commercial_code,
+                                      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 [CommercialTransactionEntity | 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}, immediate_available_balance:"\
+      " #{@immediate_available_balance}, next_day_available_balance:"\
+      " #{@next_day_available_balance}, two_days_plus_available_balance:"\
+      " #{@two_days_plus_available_balance}, reference_bank_id: #{@reference_bank_id},"\
+      " reference_branch_id: #{@reference_branch_id}, reference_customer_id:"\
+      " #{@reference_customer_id}, commercial_code: #{@commercial_code}>"
+    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}, immediate_available_balance:"\
+      " #{@immediate_available_balance.inspect}, next_day_available_balance:"\
+      " #{@next_day_available_balance.inspect}, two_days_plus_available_balance:"\
+      " #{@two_days_plus_available_balance.inspect}, reference_bank_id:"\
+      " #{@reference_bank_id.inspect}, reference_branch_id: #{@reference_branch_id.inspect},"\
+      " reference_customer_id: #{@reference_customer_id.inspect}, commercial_code:"\
+      " #{@commercial_code.inspect}>"
+    end
+  end
+end

data/lib/fdx_api/models/compounding_period.rb

@@ -0,0 +1,38 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Interest compounding Period
+  class CompoundingPeriod
+    COMPOUNDING_PERIOD = [
+      # TODO: Write general description for ANNUALLY
+      ANNUALLY = 'ANNUALLY'.freeze,
+
+      # TODO: Write general description for BIWEEKLY
+      BIWEEKLY = 'BIWEEKLY'.freeze,
+
+      # TODO: Write general description for DAILY
+      DAILY = 'DAILY'.freeze,
+
+      # TODO: Write general description for MONTHLY
+      MONTHLY = 'MONTHLY'.freeze,
+
+      # TODO: Write general description for SEMIANNUALLY
+      SEMIANNUALLY = 'SEMIANNUALLY'.freeze,
+
+      # TODO: Write general description for SEMIMONTHLY
+      SEMIMONTHLY = 'SEMIMONTHLY'.freeze,
+
+      # TODO: Write general description for WEEKLY
+      WEEKLY = 'WEEKLY'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/compounding_period2.rb

@@ -0,0 +1,38 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # DAILY, WEEKLY, BIWEEKLY, SEMIMONTHLY, MONTHLY, SEMIANNUALLY, ANNUALLY
+  class CompoundingPeriod2
+    COMPOUNDING_PERIOD2 = [
+      # TODO: Write general description for ANNUALLY
+      ANNUALLY = 'ANNUALLY'.freeze,
+
+      # TODO: Write general description for BIWEEKLY
+      BIWEEKLY = 'BIWEEKLY'.freeze,
+
+      # TODO: Write general description for DAILY
+      DAILY = 'DAILY'.freeze,
+
+      # TODO: Write general description for MONTHLY
+      MONTHLY = 'MONTHLY'.freeze,
+
+      # TODO: Write general description for SEMIANNUALLY
+      SEMIANNUALLY = 'SEMIANNUALLY'.freeze,
+
+      # TODO: Write general description for SEMIMONTHLY
+      SEMIMONTHLY = 'SEMIMONTHLY'.freeze,
+
+      # TODO: Write general description for WEEKLY
+      WEEKLY = 'WEEKLY'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/consent_duration_type.rb

@@ -0,0 +1,26 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # The type of duration of the consent
+  class ConsentDurationType
+    CONSENT_DURATION_TYPE = [
+      # TODO: Write general description for ONE_TIME
+      ONE_TIME = 'ONE_TIME'.freeze,
+
+      # TODO: Write general description for PERSISTENT
+      PERSISTENT = 'PERSISTENT'.freeze,
+
+      # TODO: Write general description for TIME_BOUND
+      TIME_BOUND = 'TIME_BOUND'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end