fdx-apimatic-sdk 0.0.1

data/lib/fdx_v660_api/models/industry_classification_system.rb

@@ -0,0 +1,67 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # The Industry Classification System containing the industry code for
+  # customer.   | Value | Description |   |-----|-----|   | BCLASS | [Bloomberg
+  # Classification
+  # System](https://www.bloomberg.com/professional/product/reference-data/) |
+  # | BICS | [Bloomberg Industry Classification
+  # System](https://www.bloomberg.com/professional/product/reference-data/) |
+  # | GICS | [Global Industry Classification
+  # System](https://www.msci.com/our-solutions/indexes/gics) |   | MOODYS |
+  # Moody's Industry Classification |   | NAICS | [North American Industry
+  # Classification System](https://www.naics.com) |   | OTHER | Any other set of
+  # industry classification codes |   | SIC | [Standard Industry Classification
+  # system](https://www.osha.gov/pls/imis/sicsearch.html) |
+  class IndustryClassificationSystem
+    INDUSTRY_CLASSIFICATION_SYSTEM = [
+      # TODO: Write general description for BCLASS
+      BCLASS = 'BCLASS'.freeze,
+
+      # TODO: Write general description for BICS
+      BICS = 'BICS'.freeze,
+
+      # TODO: Write general description for GICS
+      GICS = 'GICS'.freeze,
+
+      # TODO: Write general description for MOODYS
+      MOODYS = 'MOODYS'.freeze,
+
+      # TODO: Write general description for NAICS
+      NAICS = 'NAICS'.freeze,
+
+      # TODO: Write general description for OTHER
+      OTHER = 'OTHER'.freeze,
+
+      # TODO: Write general description for SIC
+      SIC = 'SIC'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = BCLASS)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'bclass' then BCLASS
+      when 'bics' then BICS
+      when 'gics' then GICS
+      when 'moodys' then MOODYS
+      when 'naics' then NAICS
+      when 'other' then OTHER
+      when 'sic' then SIC
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fdx_v660_api/models/industry_classification_system2.rb

@@ -0,0 +1,56 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Code type
+  class IndustryClassificationSystem2
+    INDUSTRY_CLASSIFICATION_SYSTEM2 = [
+      # TODO: Write general description for BCLASS
+      BCLASS = 'BCLASS'.freeze,
+
+      # TODO: Write general description for BICS
+      BICS = 'BICS'.freeze,
+
+      # TODO: Write general description for GICS
+      GICS = 'GICS'.freeze,
+
+      # TODO: Write general description for MOODYS
+      MOODYS = 'MOODYS'.freeze,
+
+      # TODO: Write general description for NAICS
+      NAICS = 'NAICS'.freeze,
+
+      # TODO: Write general description for OTHER
+      OTHER = 'OTHER'.freeze,
+
+      # TODO: Write general description for SIC
+      SIC = 'SIC'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = BCLASS)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'bclass' then BCLASS
+      when 'bics' then BICS
+      when 'gics' then GICS
+      when 'moodys' then MOODYS
+      when 'naics' then NAICS
+      when 'other' then OTHER
+      when 'sic' then SIC
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fdx_v660_api/models/industry_code.rb

@@ -0,0 +1,95 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Industry code and type
+  class IndustryCode < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Code type
+    # @return [IndustryClassificationSystem2]
+    attr_accessor :type
+
+    # Code value
+    # @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.
+      IndustryCode.new(type: type,
+                       code: code,
+                       additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [IndustryCode | 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_v660_api/models/insurance_account_entity.rb

@@ -0,0 +1,391 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+require_relative 'account_entity'
+
+module FdxV660Api
+  # An insurance account type and properties such as category, premium, and
+  # payment term information
+  class InsuranceAccountEntity < AccountEntity
+    # The periodic (usually monthly) interest rate earned on account cash
+    # balances
+    # @return [InterestRateEntity3]
+    attr_accessor :earned_interest
+
+    # The amount of the user's premium
+    # @return [Float]
+    attr_accessor :policy_premium
+
+    # The payment term for the premium
+    # @return [PolicyPremiumTermType2]
+    attr_accessor :policy_premium_term
+
+    # The premium start date
+    # @return [Date]
+    attr_accessor :policy_start_date
+
+    # The status of an insurance policy account
+    # @return [PolicyStatus2]
+    attr_accessor :policy_status
+
+    # The premium end date
+    # @return [Date]
+    attr_accessor :policy_end_date
+
+    # Total amount of money the user is insured for
+    # @return [Float]
+    attr_accessor :policy_coverage_amount
+
+    # Transactions on the insurance account. Deprecated in release V6.3.1 and
+    # will be removed in next major release. Transactions are returned in the
+    # `searchForAccountTransactions` operation response.
+    # @return [Array[InsuranceTransactionEntity]]
+    attr_accessor :transactions
+
+    # Payments due on the insurance account
+    # @return [Array[BillEntity]]
+    attr_accessor :bills
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['earned_interest'] = 'earnedInterest'
+      @_hash['policy_premium'] = 'policyPremium'
+      @_hash['policy_premium_term'] = 'policyPremiumTerm'
+      @_hash['policy_start_date'] = 'policyStartDate'
+      @_hash['policy_status'] = 'policyStatus'
+      @_hash['policy_end_date'] = 'policyEndDate'
+      @_hash['policy_coverage_amount'] = 'policyCoverageAmount'
+      @_hash['transactions'] = 'transactions'
+      @_hash['bills'] = 'bills'
+      @_hash = super().merge(@_hash)
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      _arr = %w[
+        earned_interest
+        policy_premium
+        policy_premium_term
+        policy_start_date
+        policy_status
+        policy_end_date
+        policy_coverage_amount
+        transactions
+        bills
+      ]
+      (_arr << super()).flatten!
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      _arr = []
+      (_arr << super()).flatten!
+    end
+
+    def initialize(earned_interest: SKIP, policy_premium: SKIP,
+                   policy_premium_term: SKIP, policy_start_date: SKIP,
+                   policy_status: SKIP, policy_end_date: SKIP,
+                   policy_coverage_amount: SKIP, transactions: SKIP,
+                   bills: SKIP, line_of_business: SKIP,
+                   line_of_business_type: SKIP, routing_transit_number: SKIP,
+                   balance_type: SKIP, contact: SKIP, interest_rate: SKIP,
+                   interest_rate_type: SKIP, interest_rate_as_of: SKIP,
+                   prior_interest_rate: SKIP, interest_rate_index: SKIP,
+                   early_penalty_flag: SKIP, transfer_in: SKIP,
+                   transfer_out: SKIP, bill_pay_status: SKIP, micr_number: SKIP,
+                   last_activity_date: SKIP, reward_program_id: SKIP,
+                   reward_balances: SKIP, transactions_included: SKIP,
+                   bank_institution_id: SKIP, bank_transit_id: SKIP,
+                   account_category: 'Insurance Account entity',
+                   account_id: SKIP, parent_account_id: SKIP, error: SKIP,
+                   account_type: SKIP, domicile: SKIP, account_number: SKIP,
+                   account_number_display: SKIP, product_id: SKIP,
+                   product_name: SKIP, nickname: SKIP, status: SKIP,
+                   description: SKIP, account_open_date: SKIP,
+                   account_close_date: SKIP, currency: SKIP,
+                   data_clusters: SKIP, transfer_out_use_cases: SKIP,
+                   fi_attributes: SKIP, links: SKIP, additional_properties: nil)
+      @earned_interest = earned_interest unless earned_interest == SKIP
+      @policy_premium = policy_premium unless policy_premium == SKIP
+      @policy_premium_term = policy_premium_term unless policy_premium_term == SKIP
+      @policy_start_date = policy_start_date unless policy_start_date == SKIP
+      @policy_status = policy_status unless policy_status == SKIP
+      @policy_end_date = policy_end_date unless policy_end_date == SKIP
+      @policy_coverage_amount = policy_coverage_amount unless policy_coverage_amount == SKIP
+      @transactions = transactions unless transactions == SKIP
+      @bills = bills unless bills == SKIP
+      @additional_properties = additional_properties
+
+      # Call the constructor of the base class
+      super(line_of_business: line_of_business,
+            line_of_business_type: line_of_business_type,
+            routing_transit_number: routing_transit_number,
+            balance_type: balance_type,
+            contact: contact,
+            interest_rate: interest_rate,
+            interest_rate_type: interest_rate_type,
+            interest_rate_as_of: interest_rate_as_of,
+            prior_interest_rate: prior_interest_rate,
+            interest_rate_index: interest_rate_index,
+            early_penalty_flag: early_penalty_flag,
+            transfer_in: transfer_in,
+            transfer_out: transfer_out,
+            bill_pay_status: bill_pay_status,
+            micr_number: micr_number,
+            last_activity_date: last_activity_date,
+            reward_program_id: reward_program_id,
+            reward_balances: reward_balances,
+            transactions_included: transactions_included,
+            bank_institution_id: bank_institution_id,
+            bank_transit_id: bank_transit_id,
+            account_category: account_category,
+            account_id: account_id,
+            parent_account_id: parent_account_id,
+            error: error,
+            account_type: account_type,
+            domicile: domicile,
+            account_number: account_number,
+            account_number_display: account_number_display,
+            product_id: product_id,
+            product_name: product_name,
+            nickname: nickname,
+            status: status,
+            description: description,
+            account_open_date: account_open_date,
+            account_close_date: account_close_date,
+            currency: currency,
+            data_clusters: data_clusters,
+            transfer_out_use_cases: transfer_out_use_cases,
+            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.
+      earned_interest = InterestRateEntity3.from_hash(hash['earnedInterest']) if
+        hash['earnedInterest']
+      policy_premium = hash.key?('policyPremium') ? hash['policyPremium'] : SKIP
+      policy_premium_term =
+        hash.key?('policyPremiumTerm') ? hash['policyPremiumTerm'] : SKIP
+      policy_start_date =
+        hash.key?('policyStartDate') ? hash['policyStartDate'] : SKIP
+      policy_status = hash.key?('policyStatus') ? hash['policyStatus'] : SKIP
+      policy_end_date =
+        hash.key?('policyEndDate') ? hash['policyEndDate'] : SKIP
+      policy_coverage_amount =
+        hash.key?('policyCoverageAmount') ? hash['policyCoverageAmount'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      transactions = nil
+      unless hash['transactions'].nil?
+        transactions = []
+        hash['transactions'].each do |structure|
+          transactions << (InsuranceTransactionEntity.from_hash(structure) if structure)
+        end
+      end
+
+      transactions = SKIP unless hash.key?('transactions')
+      # Parameter is an array, so we need to iterate through it
+      bills = nil
+      unless hash['bills'].nil?
+        bills = []
+        hash['bills'].each do |structure|
+          bills << (BillEntity.from_hash(structure) if structure)
+        end
+      end
+
+      bills = SKIP unless hash.key?('bills')
+      line_of_business =
+        hash.key?('lineOfBusiness') ? hash['lineOfBusiness'] : SKIP
+      line_of_business_type =
+        hash.key?('lineOfBusinessType') ? hash['lineOfBusinessType'] : SKIP
+      routing_transit_number =
+        hash.key?('routingTransitNumber') ? hash['routingTransitNumber'] : SKIP
+      balance_type = hash.key?('balanceType') ? hash['balanceType'] : SKIP
+      contact = AccountContactEntity.from_hash(hash['contact']) if hash['contact']
+      interest_rate = hash.key?('interestRate') ? hash['interestRate'] : SKIP
+      interest_rate_type =
+        hash.key?('interestRateType') ? hash['interestRateType'] : SKIP
+      interest_rate_as_of = if hash.key?('interestRateAsOf')
+                              (DateTimeHelper.from_rfc3339(hash['interestRateAsOf']) if hash['interestRateAsOf'])
+                            else
+                              SKIP
+                            end
+      prior_interest_rate =
+        hash.key?('priorInterestRate') ? hash['priorInterestRate'] : SKIP
+      interest_rate_index =
+        hash.key?('interestRateIndex') ? hash['interestRateIndex'] : SKIP
+      early_penalty_flag =
+        hash.key?('earlyPenaltyFlag') ? hash['earlyPenaltyFlag'] : SKIP
+      transfer_in = hash.key?('transferIn') ? hash['transferIn'] : SKIP
+      transfer_out = hash.key?('transferOut') ? hash['transferOut'] : SKIP
+      bill_pay_status =
+        hash.key?('billPayStatus') ? hash['billPayStatus'] : SKIP
+      micr_number = hash.key?('micrNumber') ? hash['micrNumber'] : SKIP
+      last_activity_date =
+        hash.key?('lastActivityDate') ? hash['lastActivityDate'] : SKIP
+      reward_program_id =
+        hash.key?('rewardProgramId') ? hash['rewardProgramId'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      reward_balances = nil
+      unless hash['rewardBalances'].nil?
+        reward_balances = []
+        hash['rewardBalances'].each do |structure|
+          reward_balances << (RewardBalanceEntity.from_hash(structure) if structure)
+        end
+      end
+
+      reward_balances = SKIP unless hash.key?('rewardBalances')
+      transactions_included =
+        hash.key?('transactionsIncluded') ? hash['transactionsIncluded'] : SKIP
+      bank_institution_id =
+        hash.key?('bankInstitutionId') ? hash['bankInstitutionId'] : SKIP
+      bank_transit_id =
+        hash.key?('bankTransitId') ? hash['bankTransitId'] : SKIP
+      account_category = hash['accountCategory'] ||= 'Insurance Account entity'
+      account_id = hash.key?('accountId') ? hash['accountId'] : SKIP
+      parent_account_id =
+        hash.key?('parentAccountId') ? hash['parentAccountId'] : SKIP
+      error = Error3.from_hash(hash['error']) if hash['error']
+      account_type = hash.key?('accountType') ? hash['accountType'] : SKIP
+      domicile = DomicileEntity3.from_hash(hash['domicile']) if hash['domicile']
+      account_number = hash.key?('accountNumber') ? hash['accountNumber'] : SKIP
+      account_number_display =
+        hash.key?('accountNumberDisplay') ? hash['accountNumberDisplay'] : SKIP
+      product_id = hash.key?('productId') ? hash['productId'] : 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']
+      data_clusters = hash.key?('dataClusters') ? hash['dataClusters'] : SKIP
+      transfer_out_use_cases =
+        hash.key?('transferOutUseCases') ? hash['transferOutUseCases'] : 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')
+      # 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.
+      InsuranceAccountEntity.new(earned_interest: earned_interest,
+                                 policy_premium: policy_premium,
+                                 policy_premium_term: policy_premium_term,
+                                 policy_start_date: policy_start_date,
+                                 policy_status: policy_status,
+                                 policy_end_date: policy_end_date,
+                                 policy_coverage_amount: policy_coverage_amount,
+                                 transactions: transactions,
+                                 bills: bills,
+                                 line_of_business: line_of_business,
+                                 line_of_business_type: line_of_business_type,
+                                 routing_transit_number: routing_transit_number,
+                                 balance_type: balance_type,
+                                 contact: contact,
+                                 interest_rate: interest_rate,
+                                 interest_rate_type: interest_rate_type,
+                                 interest_rate_as_of: interest_rate_as_of,
+                                 prior_interest_rate: prior_interest_rate,
+                                 interest_rate_index: interest_rate_index,
+                                 early_penalty_flag: early_penalty_flag,
+                                 transfer_in: transfer_in,
+                                 transfer_out: transfer_out,
+                                 bill_pay_status: bill_pay_status,
+                                 micr_number: micr_number,
+                                 last_activity_date: last_activity_date,
+                                 reward_program_id: reward_program_id,
+                                 reward_balances: reward_balances,
+                                 transactions_included: transactions_included,
+                                 bank_institution_id: bank_institution_id,
+                                 bank_transit_id: bank_transit_id,
+                                 account_category: account_category,
+                                 account_id: account_id,
+                                 parent_account_id: parent_account_id,
+                                 error: error,
+                                 account_type: account_type,
+                                 domicile: domicile,
+                                 account_number: account_number,
+                                 account_number_display: account_number_display,
+                                 product_id: product_id,
+                                 product_name: product_name,
+                                 nickname: nickname,
+                                 status: status,
+                                 description: description,
+                                 account_open_date: account_open_date,
+                                 account_close_date: account_close_date,
+                                 currency: currency,
+                                 data_clusters: data_clusters,
+                                 transfer_out_use_cases: transfer_out_use_cases,
+                                 fi_attributes: fi_attributes,
+                                 links: links,
+                                 additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [InsuranceAccountEntity | 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}, earned_interest: #{@earned_interest}, policy_premium:"\
+      " #{@policy_premium}, policy_premium_term: #{@policy_premium_term}, policy_start_date:"\
+      " #{@policy_start_date}, policy_status: #{@policy_status}, policy_end_date:"\
+      " #{@policy_end_date}, policy_coverage_amount: #{@policy_coverage_amount}, transactions:"\
+      " #{@transactions}, bills: #{@bills}>"
+    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}, earned_interest: #{@earned_interest.inspect},"\
+      " policy_premium: #{@policy_premium.inspect}, policy_premium_term:"\
+      " #{@policy_premium_term.inspect}, policy_start_date: #{@policy_start_date.inspect},"\
+      " policy_status: #{@policy_status.inspect}, policy_end_date: #{@policy_end_date.inspect},"\
+      " policy_coverage_amount: #{@policy_coverage_amount.inspect}, transactions:"\
+      " #{@transactions.inspect}, bills: #{@bills.inspect}>"
+    end
+  end
+end