fdx-api-sdk-ruby 1.0.0

data/lib/fdx_api/models/account_bill_pay_status.rb

@@ -0,0 +1,32 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Indicates bill pay capabilities for an account.   * `ACTIVE`: Can be used
+  # for bill payment   * `AVAILABLE`: Account can be requested for bill payment
+  #  * `NOT_AVAILABLE`: Account cannot participate in bill payment   *
+  # `PENDING`: Account requested for bill payment, but not available yet
+  class AccountBillPayStatus
+    ACCOUNT_BILL_PAY_STATUS = [
+      # TODO: Write general description for ACTIVE
+      ACTIVE = 'ACTIVE'.freeze,
+
+      # TODO: Write general description for AVAILABLE
+      AVAILABLE = 'AVAILABLE'.freeze,
+
+      # TODO: Write general description for NOT_AVAILABLE
+      NOT_AVAILABLE = 'NOT_AVAILABLE'.freeze,
+
+      # TODO: Write general description for PENDING
+      PENDING = 'PENDING'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/account_bill_pay_status2.rb

@@ -0,0 +1,29 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Defines account's ability to participate in bill payments
+  class AccountBillPayStatus2
+    ACCOUNT_BILL_PAY_STATUS2 = [
+      # TODO: Write general description for ACTIVE
+      ACTIVE = 'ACTIVE'.freeze,
+
+      # TODO: Write general description for AVAILABLE
+      AVAILABLE = 'AVAILABLE'.freeze,
+
+      # TODO: Write general description for NOT_AVAILABLE
+      NOT_AVAILABLE = 'NOT_AVAILABLE'.freeze,
+
+      # TODO: Write general description for PENDING
+      PENDING = 'PENDING'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/account_category_type.rb

@@ -0,0 +1,41 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # The category of account
+  class AccountCategoryType
+    ACCOUNT_CATEGORY_TYPE = [
+      # TODO: Write general description for ANNUITY_ACCOUNT
+      ANNUITY_ACCOUNT = 'ANNUITY_ACCOUNT'.freeze,
+
+      # TODO: Write general description for COMMERCIAL_ACCOUNT
+      COMMERCIAL_ACCOUNT = 'COMMERCIAL_ACCOUNT'.freeze,
+
+      # TODO: Write general description for DEPOSIT_ACCOUNT
+      DEPOSIT_ACCOUNT = 'DEPOSIT_ACCOUNT'.freeze,
+
+      # TODO: Write general description for DIGITAL_WALLET
+      DIGITAL_WALLET = 'DIGITAL_WALLET'.freeze,
+
+      # TODO: Write general description for INSURANCE_ACCOUNT
+      INSURANCE_ACCOUNT = 'INSURANCE_ACCOUNT'.freeze,
+
+      # TODO: Write general description for INVESTMENT_ACCOUNT
+      INVESTMENT_ACCOUNT = 'INVESTMENT_ACCOUNT'.freeze,
+
+      # TODO: Write general description for LOAN_ACCOUNT
+      LOAN_ACCOUNT = 'LOAN_ACCOUNT'.freeze,
+
+      # TODO: Write general description for LOC_ACCOUNT
+      LOC_ACCOUNT = 'LOC_ACCOUNT'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/account_contact_entity.rb

@@ -0,0 +1,132 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Contact information for the account
+  class AccountContactEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Array of the contact email addresses
+    # @return [Array[String]]
+    attr_accessor :emails
+
+    # Array of the contact physical addresses
+    # @return [Array[DeliveryAddress]]
+    attr_accessor :addresses
+
+    # Array of the contact telephone numbers
+    # @return [Array[TelephoneNumber]]
+    attr_accessor :telephones
+
+    # Owners of the account
+    # @return [Array[AccountHolderEntity]]
+    attr_accessor :holders
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['emails'] = 'emails'
+      @_hash['addresses'] = 'addresses'
+      @_hash['telephones'] = 'telephones'
+      @_hash['holders'] = 'holders'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        emails
+        addresses
+        telephones
+        holders
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(emails: SKIP, addresses: SKIP, telephones: SKIP,
+                   holders: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @emails = emails unless emails == SKIP
+      @addresses = addresses unless addresses == SKIP
+      @telephones = telephones unless telephones == SKIP
+      @holders = holders unless holders == 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.
+      emails = hash.key?('emails') ? hash['emails'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      addresses = nil
+      unless hash['addresses'].nil?
+        addresses = []
+        hash['addresses'].each do |structure|
+          addresses << (DeliveryAddress.from_hash(structure) if structure)
+        end
+      end
+
+      addresses = SKIP unless hash.key?('addresses')
+      # Parameter is an array, so we need to iterate through it
+      telephones = nil
+      unless hash['telephones'].nil?
+        telephones = []
+        hash['telephones'].each do |structure|
+          telephones << (TelephoneNumber.from_hash(structure) if structure)
+        end
+      end
+
+      telephones = SKIP unless hash.key?('telephones')
+      # Parameter is an array, so we need to iterate through it
+      holders = nil
+      unless hash['holders'].nil?
+        holders = []
+        hash['holders'].each do |structure|
+          holders << (AccountHolderEntity.from_hash(structure) if structure)
+        end
+      end
+
+      holders = SKIP unless hash.key?('holders')
+
+      # 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.
+      AccountContactEntity.new(emails: emails,
+                               addresses: addresses,
+                               telephones: telephones,
+                               holders: holders,
+                               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} emails: #{@emails}, addresses: #{@addresses}, telephones: #{@telephones},"\
+      " holders: #{@holders}, 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} emails: #{@emails.inspect}, addresses: #{@addresses.inspect}, telephones:"\
+      " #{@telephones.inspect}, holders: #{@holders.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/account_contact_entity2.rb

@@ -0,0 +1,142 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Contact information associated with this account
+  class AccountContactEntity2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Array of the contact email addresses
+    # @return [Array[String]]
+    attr_accessor :emails
+
+    # Array of the contact physical addresses
+    # @return [Array[DeliveryAddress]]
+    attr_accessor :addresses
+
+    # Array of the contact telephone numbers
+    # @return [Array[TelephoneNumber]]
+    attr_accessor :telephones
+
+    # Owners of the account
+    # @return [Array[AccountHolderEntity]]
+    attr_accessor :holders
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['emails'] = 'emails'
+      @_hash['addresses'] = 'addresses'
+      @_hash['telephones'] = 'telephones'
+      @_hash['holders'] = 'holders'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        emails
+        addresses
+        telephones
+        holders
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(emails: SKIP, addresses: SKIP, telephones: SKIP,
+                   holders: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @emails = emails unless emails == SKIP
+      @addresses = addresses unless addresses == SKIP
+      @telephones = telephones unless telephones == SKIP
+      @holders = holders unless holders == 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.
+      emails = hash.key?('emails') ? hash['emails'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      addresses = nil
+      unless hash['addresses'].nil?
+        addresses = []
+        hash['addresses'].each do |structure|
+          addresses << (DeliveryAddress.from_hash(structure) if structure)
+        end
+      end
+
+      addresses = SKIP unless hash.key?('addresses')
+      # Parameter is an array, so we need to iterate through it
+      telephones = nil
+      unless hash['telephones'].nil?
+        telephones = []
+        hash['telephones'].each do |structure|
+          telephones << (TelephoneNumber.from_hash(structure) if structure)
+        end
+      end
+
+      telephones = SKIP unless hash.key?('telephones')
+      # Parameter is an array, so we need to iterate through it
+      holders = nil
+      unless hash['holders'].nil?
+        holders = []
+        hash['holders'].each do |structure|
+          holders << (AccountHolderEntity.from_hash(structure) if structure)
+        end
+      end
+
+      holders = SKIP unless hash.key?('holders')
+
+      # 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.
+      AccountContactEntity2.new(emails: emails,
+                                addresses: addresses,
+                                telephones: telephones,
+                                holders: holders,
+                                additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [AccountContactEntity2 | 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} emails: #{@emails}, addresses: #{@addresses}, telephones: #{@telephones},"\
+      " holders: #{@holders}, 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} emails: #{@emails.inspect}, addresses: #{@addresses.inspect}, telephones:"\
+      " #{@telephones.inspect}, holders: #{@holders.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/account_descriptor_entity.rb

@@ -0,0 +1,253 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # This descriptor provides minimal information about the account for use in
+  # lightweight arrays
+  class AccountDescriptorEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :account_category
+
+    # Long-term persistent identity of the account, though not an account
+    # number. This identity must be unique to the owning institution
+    # @return [String]
+    attr_accessor :account_id
+
+    # Present if an error was encountered while retrieving this account
+    # @return [Error1]
+    attr_accessor :error
+
+    # Account type
+    # @return [AccountType]
+    attr_accessor :account_type
+
+    # Full account number for the end user for this account at the owning
+    # institution. If not masked this is sensitive data which should only be
+    # exchanged if encrypted. For detailed information on implementing
+    # encryption see "Part 4 End to End Encryption" of the FDX API Security
+    # Model document in the Security section of the latest FDX Release download
+    # @return [String]
+    attr_accessor :account_number
+
+    # Account display number for the end user's handle at the owning
+    # institution. This is to be displayed by the Interface Provider
+    # @return [String]
+    attr_accessor :account_number_display
+
+    # Marketed product name for this account. Used in UIs to assist in account
+    # selection
+    # @return [String]
+    attr_accessor :product_name
+
+    # Name given by the user. Used in UIs to assist in account selection
+    # @return [String]
+    attr_accessor :nickname
+
+    # Account status. Suggested values are: OPEN, CLOSED, PENDINGOPEN,
+    # PENDINGCLOSE, PAID, DELINQUENT, NEGATIVECURRENTBALANCE, RESTRICTED
+    # @return [AccountStatus2]
+    attr_accessor :status
+
+    # Description of account
+    # @return [String]
+    attr_accessor :description
+
+    # Account opening date
+    # @return [Date]
+    attr_accessor :account_open_date
+
+    # Account closing date
+    # @return [Date]
+    attr_accessor :account_close_date
+
+    # Account currency
+    # @return [CurrencyEntity4]
+    attr_accessor :currency
+
+    # Array of Financial institution-specific attributes
+    # @return [Array[FiAttributeEntity]]
+    attr_accessor :fi_attributes
+
+    # Discriminators mapping.
+    def self.discriminators
+      if @_discriminators.nil?
+        @_discriminators = {}
+        @_discriminators['Account entity'] = AccountEntity
+        @_discriminators['Annuity Account entity'] = AnnuityAccountEntity
+        @_discriminators['Commercial Account entity'] = CommercialAccountEntity
+        @_discriminators['Deposit Account entity'] = DepositAccountEntity
+        @_discriminators['Digital Wallet account entity'] = DigitalWalletAccountEntity
+        @_discriminators['Insurance Account entity'] = InsuranceAccountEntity
+        @_discriminators['Investment Account entity'] = InvestmentAccountEntity
+        @_discriminators['Line of Credit Account entity'] = LineOfCreditAccountEntity
+        @_discriminators['Loan Account entity'] = LoanAccountEntity
+      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['error'] = 'error'
+      @_hash['account_type'] = 'accountType'
+      @_hash['account_number'] = 'accountNumber'
+      @_hash['account_number_display'] = 'accountNumberDisplay'
+      @_hash['product_name'] = 'productName'
+      @_hash['nickname'] = 'nickname'
+      @_hash['status'] = 'status'
+      @_hash['description'] = 'description'
+      @_hash['account_open_date'] = 'accountOpenDate'
+      @_hash['account_close_date'] = 'accountCloseDate'
+      @_hash['currency'] = 'currency'
+      @_hash['fi_attributes'] = 'fiAttributes'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_category
+        account_id
+        error
+        account_type
+        account_number
+        account_number_display
+        product_name
+        nickname
+        status
+        description
+        account_open_date
+        account_close_date
+        currency
+        fi_attributes
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_category: 'Account Descriptor entity',
+                   account_id: SKIP, error: SKIP, account_type: SKIP,
+                   account_number: SKIP, account_number_display: SKIP,
+                   product_name: SKIP, nickname: SKIP, status: SKIP,
+                   description: SKIP, account_open_date: SKIP,
+                   account_close_date: SKIP, currency: SKIP,
+                   fi_attributes: 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
+      @error = error unless error == SKIP
+      @account_type = account_type unless account_type == SKIP
+      @account_number = account_number unless account_number == SKIP
+      @account_number_display = account_number_display unless account_number_display == SKIP
+      @product_name = product_name unless product_name == SKIP
+      @nickname = nickname unless nickname == SKIP
+      @status = status unless status == SKIP
+      @description = description unless description == SKIP
+      @account_open_date = account_open_date unless account_open_date == SKIP
+      @account_close_date = account_close_date unless account_close_date == SKIP
+      @currency = currency unless currency == SKIP
+      @fi_attributes = fi_attributes unless fi_attributes == 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'] ||= 'Account Descriptor entity'
+      account_id = hash.key?('accountId') ? hash['accountId'] : SKIP
+      error = Error1.from_hash(hash['error']) if hash['error']
+      account_type = hash.key?('accountType') ? hash['accountType'] : SKIP
+      account_number = hash.key?('accountNumber') ? hash['accountNumber'] : SKIP
+      account_number_display =
+        hash.key?('accountNumberDisplay') ? hash['accountNumberDisplay'] : SKIP
+      product_name = hash.key?('productName') ? hash['productName'] : SKIP
+      nickname = hash.key?('nickname') ? hash['nickname'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      account_open_date =
+        hash.key?('accountOpenDate') ? hash['accountOpenDate'] : SKIP
+      account_close_date =
+        hash.key?('accountCloseDate') ? hash['accountCloseDate'] : SKIP
+      currency = CurrencyEntity4.from_hash(hash['currency']) if hash['currency']
+      # 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')
+
+      # 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.
+      AccountDescriptorEntity.new(account_category: account_category,
+                                  account_id: account_id,
+                                  error: error,
+                                  account_type: account_type,
+                                  account_number: account_number,
+                                  account_number_display: account_number_display,
+                                  product_name: product_name,
+                                  nickname: nickname,
+                                  status: status,
+                                  description: description,
+                                  account_open_date: account_open_date,
+                                  account_close_date: account_close_date,
+                                  currency: currency,
+                                  fi_attributes: fi_attributes,
+                                  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} account_category: #{@account_category}, account_id: #{@account_id}, error:"\
+      " #{@error}, account_type: #{@account_type}, account_number: #{@account_number},"\
+      " account_number_display: #{@account_number_display}, product_name: #{@product_name},"\
+      " nickname: #{@nickname}, status: #{@status}, description: #{@description},"\
+      " account_open_date: #{@account_open_date}, account_close_date: #{@account_close_date},"\
+      " currency: #{@currency}, fi_attributes: #{@fi_attributes}, 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}, error: #{@error.inspect}, account_type: #{@account_type.inspect},"\
+      " account_number: #{@account_number.inspect}, account_number_display:"\
+      " #{@account_number_display.inspect}, product_name: #{@product_name.inspect}, nickname:"\
+      " #{@nickname.inspect}, status: #{@status.inspect}, description: #{@description.inspect},"\
+      " account_open_date: #{@account_open_date.inspect}, account_close_date:"\
+      " #{@account_close_date.inspect}, currency: #{@currency.inspect}, fi_attributes:"\
+      " #{@fi_attributes.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end