fdx-api-sdk-ruby 1.0.0

data/lib/fdx_api/models/customer_name_entity1.rb

@@ -0,0 +1,134 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # The name of an individual in their role as a customer
+  class CustomerNameEntity1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # First name
+    # @return [String]
+    attr_accessor :first
+
+    # Middle initial
+    # @return [String]
+    attr_accessor :middle
+
+    # Last name
+    # @return [String]
+    attr_accessor :last
+
+    # Generational or academic suffix
+    # @return [String]
+    attr_accessor :suffix
+
+    # Name prefix, e.g. Mr.
+    # @return [String]
+    attr_accessor :prefix
+
+    # Company name
+    # @return [String]
+    attr_accessor :company
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['first'] = 'first'
+      @_hash['middle'] = 'middle'
+      @_hash['last'] = 'last'
+      @_hash['suffix'] = 'suffix'
+      @_hash['prefix'] = 'prefix'
+      @_hash['company'] = 'company'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        first
+        middle
+        last
+        suffix
+        prefix
+        company
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(first: SKIP, middle: SKIP, last: SKIP, suffix: SKIP,
+                   prefix: SKIP, company: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @first = first unless first == SKIP
+      @middle = middle unless middle == SKIP
+      @last = last unless last == SKIP
+      @suffix = suffix unless suffix == SKIP
+      @prefix = prefix unless prefix == SKIP
+      @company = company unless company == 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.
+      first = hash.key?('first') ? hash['first'] : SKIP
+      middle = hash.key?('middle') ? hash['middle'] : SKIP
+      last = hash.key?('last') ? hash['last'] : SKIP
+      suffix = hash.key?('suffix') ? hash['suffix'] : SKIP
+      prefix = hash.key?('prefix') ? hash['prefix'] : SKIP
+      company = hash.key?('company') ? hash['company'] : 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.
+      CustomerNameEntity1.new(first: first,
+                              middle: middle,
+                              last: last,
+                              suffix: suffix,
+                              prefix: prefix,
+                              company: company,
+                              additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CustomerNameEntity1 | 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} first: #{@first}, middle: #{@middle}, last: #{@last}, suffix: #{@suffix},"\
+      " prefix: #{@prefix}, company: #{@company}, 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} first: #{@first.inspect}, middle: #{@middle.inspect}, last:"\
+      " #{@last.inspect}, suffix: #{@suffix.inspect}, prefix: #{@prefix.inspect}, company:"\
+      " #{@company.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/customer_to_account_relationship_entity.rb

@@ -0,0 +1,114 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Describes an account related to a customer
+  class CustomerToAccountRelationshipEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Account ID of the related account
+    # @return [String]
+    attr_accessor :account_id
+
+    # Links to the account, or to invoke other APIs
+    # @return [Array[HateoasLink]]
+    attr_accessor :links
+
+    # Type of relationship to the account
+    # @return [AccountHolderRelationship]
+    attr_accessor :relationship
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_id'] = 'accountId'
+      @_hash['links'] = 'links'
+      @_hash['relationship'] = 'relationship'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_id
+        links
+        relationship
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_id: SKIP, links: SKIP, relationship: 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
+      @links = links unless links == SKIP
+      @relationship = relationship unless relationship == 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
+      # 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')
+      relationship = hash.key?('relationship') ? hash['relationship'] : 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.
+      CustomerToAccountRelationshipEntity.new(account_id: account_id,
+                                              links: links,
+                                              relationship: relationship,
+                                              additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CustomerToAccountRelationshipEntity | 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}, links: #{@links}, relationship:"\
+      " #{@relationship}, 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}, links: #{@links.inspect}, relationship:"\
+      " #{@relationship.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/customers_entity.rb

@@ -0,0 +1,104 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # List of customers
+  class CustomersEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Information required to paginate results
+    # @return [PageMetadata]
+    attr_accessor :page
+
+    # Links used to paginate results
+    # @return [PageMetadataLinks1]
+    attr_accessor :links
+
+    # Array of customers
+    # @return [Array[CustomerEntity]]
+    attr_accessor :customers
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['page'] = 'page'
+      @_hash['links'] = 'links'
+      @_hash['customers'] = 'customers'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        page
+        links
+        customers
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(page: SKIP, links: SKIP, customers: 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
+      @customers = customers unless customers == 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 = PageMetadataLinks1.from_hash(hash['links']) if hash['links']
+      # Parameter is an array, so we need to iterate through it
+      customers = nil
+      unless hash['customers'].nil?
+        customers = []
+        hash['customers'].each do |structure|
+          customers << (CustomerEntity.from_hash(structure) if structure)
+        end
+      end
+
+      customers = SKIP unless hash.key?('customers')
+
+      # 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.
+      CustomersEntity.new(page: page,
+                          links: links,
+                          customers: customers,
+                          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} page: #{@page}, links: #{@links}, customers: #{@customers},"\
+      " 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}, customers:"\
+      " #{@customers.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/data_cluster.rb

@@ -0,0 +1,63 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Name of permissioned Data Cluster. For Data Cluster definitions refer to the
+  # Consent Components > Data Clusters section of the User Experience Guidelines
+  # document included in the FDX API. `ACCOUNT_PAYMENTS` is deprecated and
+  # replaced with `PAYMENT_SUPPORT` in FDX release V6.1.0, `ACCOUNT_PAYMENTS`
+  # will be removed with V7 release
+  class DataCluster
+    DATA_CLUSTER = [
+      # TODO: Write general description for ACCOUNT_BASIC
+      ACCOUNT_BASIC = 'ACCOUNT_BASIC'.freeze,
+
+      # TODO: Write general description for ACCOUNT_DETAILED
+      ACCOUNT_DETAILED = 'ACCOUNT_DETAILED'.freeze,
+
+      # TODO: Write general description for ACCOUNT_PAYMENTS
+      ACCOUNT_PAYMENTS = 'ACCOUNT_PAYMENTS'.freeze,
+
+      # TODO: Write general description for BILLS
+      BILLS = 'BILLS'.freeze,
+
+      # TODO: Write general description for CUSTOMER_CONTACT
+      CUSTOMER_CONTACT = 'CUSTOMER_CONTACT'.freeze,
+
+      # TODO: Write general description for CUSTOMER_PERSONAL
+      CUSTOMER_PERSONAL = 'CUSTOMER_PERSONAL'.freeze,
+
+      # TODO: Write general description for IMAGES
+      IMAGES = 'IMAGES'.freeze,
+
+      # TODO: Write general description for INVESTMENTS
+      INVESTMENTS = 'INVESTMENTS'.freeze,
+
+      # TODO: Write general description for NOTIFICATIONS
+      NOTIFICATIONS = 'NOTIFICATIONS'.freeze,
+
+      # TODO: Write general description for PAYMENT_SUPPORT
+      PAYMENT_SUPPORT = 'PAYMENT_SUPPORT'.freeze,
+
+      # TODO: Write general description for REWARDS
+      REWARDS = 'REWARDS'.freeze,
+
+      # TODO: Write general description for STATEMENTS
+      STATEMENTS = 'STATEMENTS'.freeze,
+
+      # TODO: Write general description for TAX
+      TAX = 'TAX'.freeze,
+
+      # TODO: Write general description for TRANSACTIONS
+      TRANSACTIONS = 'TRANSACTIONS'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/date_and_amount.rb

@@ -0,0 +1,95 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Date, description, and amount. When used in 1098-Q, description is optional
+  class DateAndAmount < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Date of amount. When used in 1098-Q, date of last payment in month
+    # @return [Date]
+    attr_accessor :date
+
+    # Description of amount. When used in 1098-Q, may use MonthAbbreviation
+    # @return [String]
+    attr_accessor :description
+
+    # Amount of payment or receipt. When used in 1098-Q, monthly total
+    # @return [Float]
+    attr_accessor :amount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['date'] = 'date'
+      @_hash['description'] = 'description'
+      @_hash['amount'] = 'amount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        date
+        description
+        amount
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(date: SKIP, description: SKIP, amount: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @date = date unless date == SKIP
+      @description = description unless description == SKIP
+      @amount = amount unless amount == 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.
+      date = hash.key?('date') ? hash['date'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      amount = hash.key?('amount') ? hash['amount'] : 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.
+      DateAndAmount.new(date: date,
+                        description: description,
+                        amount: amount,
+                        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} date: #{@date}, description: #{@description}, amount: #{@amount},"\
+      " 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} date: #{@date.inspect}, description: #{@description.inspect}, amount:"\
+      " #{@amount.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/debit_credit_memo.rb

@@ -0,0 +1,26 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # The posting type of a transaction
+  class DebitCreditMemo
+    DEBIT_CREDIT_MEMO = [
+      # TODO: Write general description for CREDIT
+      CREDIT = 'CREDIT'.freeze,
+
+      # TODO: Write general description for DEBIT
+      DEBIT = 'DEBIT'.freeze,
+
+      # TODO: Write general description for MEMO
+      MEMO = 'MEMO'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/debit_credit_memo2.rb

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

data/lib/fdx_api/models/debt_class.rb

@@ -0,0 +1,29 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # The classification of a debt instrument
+  class DebtClass
+    DEBT_CLASS = [
+      # TODO: Write general description for CORPORATE
+      CORPORATE = 'CORPORATE'.freeze,
+
+      # TODO: Write general description for MUNICIPAL
+      MUNICIPAL = 'MUNICIPAL'.freeze,
+
+      # TODO: Write general description for OTHER
+      OTHER = 'OTHER'.freeze,
+
+      # TODO: Write general description for TREASURY
+      TREASURY = 'TREASURY'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/debt_class2.rb

@@ -0,0 +1,29 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Classification of debt. One of TREASURY, MUNICIPAL, CORPORATE, OTHER
+  class DebtClass2
+    DEBT_CLASS2 = [
+      # TODO: Write general description for CORPORATE
+      CORPORATE = 'CORPORATE'.freeze,
+
+      # TODO: Write general description for MUNICIPAL
+      MUNICIPAL = 'MUNICIPAL'.freeze,
+
+      # TODO: Write general description for OTHER
+      OTHER = 'OTHER'.freeze,
+
+      # TODO: Write general description for TREASURY
+      TREASURY = 'TREASURY'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end