fdx-api-sdk-ruby 1.0.0

data/lib/fdx_api/models/address.rb

@@ -0,0 +1,151 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # U.S. domestic address or a foreign address with country other than 'US'
+  class Address < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Address line 1
+    # @return [String]
+    attr_accessor :line1
+
+    # Address line 2
+    # @return [String]
+    attr_accessor :line2
+
+    # Address line 3
+    # @return [String]
+    attr_accessor :line3
+
+    # City
+    # @return [String]
+    attr_accessor :city
+
+    # State, Province, Territory, Canton or Prefecture. From [Universal Postal
+    # Union](https://www.upu.int/en/Postal-Solutions/Programmes-Services/Address
+    # ing-Solutions#addressing-s42-standard) as of 2-26-2020, [S42 International
+    # Address
+    # Standards](https://www.upu.int/UPU/media/upu/documents/PostCode/S42_Intern
+    # ational-Addressing-Standards.pdf). For U.S. addresses can be 2-character
+    # code from '#/components/schemas/StateCode'
+    # @return [String]
+    attr_accessor :region
+
+    # Postal code
+    # @return [String]
+    attr_accessor :postal_code
+
+    # Country code
+    # @return [Iso3166CountryCode]
+    attr_accessor :country
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['line1'] = 'line1'
+      @_hash['line2'] = 'line2'
+      @_hash['line3'] = 'line3'
+      @_hash['city'] = 'city'
+      @_hash['region'] = 'region'
+      @_hash['postal_code'] = 'postalCode'
+      @_hash['country'] = 'country'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        line1
+        line2
+        line3
+        city
+        region
+        postal_code
+        country
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(line1: SKIP, line2: SKIP, line3: SKIP, city: SKIP,
+                   region: SKIP, postal_code: SKIP, country: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @line1 = line1 unless line1 == SKIP
+      @line2 = line2 unless line2 == SKIP
+      @line3 = line3 unless line3 == SKIP
+      @city = city unless city == SKIP
+      @region = region unless region == SKIP
+      @postal_code = postal_code unless postal_code == 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.
+      line1 = hash.key?('line1') ? hash['line1'] : SKIP
+      line2 = hash.key?('line2') ? hash['line2'] : SKIP
+      line3 = hash.key?('line3') ? hash['line3'] : SKIP
+      city = hash.key?('city') ? hash['city'] : SKIP
+      region = hash.key?('region') ? hash['region'] : SKIP
+      postal_code = hash.key?('postalCode') ? hash['postalCode'] : 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.
+      Address.new(line1: line1,
+                  line2: line2,
+                  line3: line3,
+                  city: city,
+                  region: region,
+                  postal_code: postal_code,
+                  country: country,
+                  additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Address | 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} line1: #{@line1}, line2: #{@line2}, line3: #{@line3}, city: #{@city},"\
+      " region: #{@region}, postal_code: #{@postal_code}, 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} line1: #{@line1.inspect}, line2: #{@line2.inspect}, line3:"\
+      " #{@line3.inspect}, city: #{@city.inspect}, region: #{@region.inspect}, postal_code:"\
+      " #{@postal_code.inspect}, country: #{@country.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/an_array_of_statements.rb

@@ -0,0 +1,105 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # A paginated array of account statements
+  class AnArrayOfStatements < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Offset IDs for navigating result sets
+    # @return [PageMetadata]
+    attr_accessor :page
+
+    # Resource URLs for navigating result sets
+    # @return [PageMetadataLinks]
+    attr_accessor :links
+
+    # An array of Statement, each with its HATEOAS link to retrieve the account
+    # statement
+    # @return [Array[StatementEntity]]
+    attr_accessor :statements
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['page'] = 'page'
+      @_hash['links'] = 'links'
+      @_hash['statements'] = 'statements'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        page
+        links
+        statements
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(page: SKIP, links: SKIP, statements: 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
+      @statements = statements unless statements == 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 = PageMetadataLinks.from_hash(hash['links']) if hash['links']
+      # Parameter is an array, so we need to iterate through it
+      statements = nil
+      unless hash['statements'].nil?
+        statements = []
+        hash['statements'].each do |structure|
+          statements << (StatementEntity.from_hash(structure) if structure)
+        end
+      end
+
+      statements = SKIP unless hash.key?('statements')
+
+      # 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.
+      AnArrayOfStatements.new(page: page,
+                              links: links,
+                              statements: statements,
+                              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}, statements: #{@statements},"\
+      " 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}, statements:"\
+      " #{@statements.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/annuity_account_entity.rb

@@ -0,0 +1,347 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+require_relative 'account_entity'
+
+module FdxApi
+  # An annuity account type
+  class AnnuityAccountEntity < AccountEntity
+    # Indicates type of payout such as immediate or deferred
+    # @return [PayoutType2]
+    attr_accessor :payout_type
+
+    # The type of annuity product, e.g. Fixed or Variable
+    # @return [PolicyProductType2]
+    attr_accessor :policy_product_type
+
+    # Amount paid out, based on mode frequency
+    # @return [Float]
+    attr_accessor :payout_amount
+
+    # Frequency of annuity payments
+    # @return [PayoutMode2]
+    attr_accessor :payout_mode
+
+    # Date the payout starts
+    # @return [Date]
+    attr_accessor :payout_start_date
+
+    # Date the payout ends
+    # @return [Date]
+    attr_accessor :payout_end_date
+
+    # Total number of payouts
+    # @return [Integer]
+    attr_accessor :number_modal_payouts
+
+    # Cash surrender value (net) available if contract is surrendered
+    # @return [Float]
+    attr_accessor :surrender_value
+
+    # Percentage of the accumulated value to be paid to the payee each year;
+    # used exclusive of payoutChangeAmount
+    # @return [Float]
+    attr_accessor :payout_change_percentage
+
+    # Incremental modal amount (positive or negative) by which the payout amount
+    # will be changed; used exclusive of payoutPercentage
+    # @return [Float]
+    attr_accessor :payout_change_amount
+
+    # The number of modal periods comprising the duration of the certain period
+    # of an annuity payout
+    # @return [PeriodCertainType2]
+    attr_accessor :period_certain_type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['payout_type'] = 'payoutType'
+      @_hash['policy_product_type'] = 'policyProductType'
+      @_hash['payout_amount'] = 'payoutAmount'
+      @_hash['payout_mode'] = 'payoutMode'
+      @_hash['payout_start_date'] = 'payoutStartDate'
+      @_hash['payout_end_date'] = 'payoutEndDate'
+      @_hash['number_modal_payouts'] = 'numberModalPayouts'
+      @_hash['surrender_value'] = 'surrenderValue'
+      @_hash['payout_change_percentage'] = 'payoutChangePercentage'
+      @_hash['payout_change_amount'] = 'payoutChangeAmount'
+      @_hash['period_certain_type'] = 'periodCertainType'
+      @_hash = super().merge(@_hash)
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      _arr = %w[
+        payout_type
+        policy_product_type
+        payout_amount
+        payout_mode
+        payout_start_date
+        payout_end_date
+        number_modal_payouts
+        surrender_value
+        payout_change_percentage
+        payout_change_amount
+        period_certain_type
+      ]
+      (_arr << super()).flatten!
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      _arr = []
+      (_arr << super()).flatten!
+    end
+
+    def initialize(payout_type: SKIP, policy_product_type: SKIP,
+                   payout_amount: SKIP, payout_mode: SKIP,
+                   payout_start_date: SKIP, payout_end_date: SKIP,
+                   number_modal_payouts: SKIP, surrender_value: SKIP,
+                   payout_change_percentage: SKIP, payout_change_amount: SKIP,
+                   period_certain_type: SKIP, parent_account_id: SKIP,
+                   line_of_business: 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,
+                   transactions_included: SKIP, domicile: SKIP,
+                   account_category: 'Annuity Account 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)
+      @payout_type = payout_type unless payout_type == SKIP
+      @policy_product_type = policy_product_type unless policy_product_type == SKIP
+      @payout_amount = payout_amount unless payout_amount == SKIP
+      @payout_mode = payout_mode unless payout_mode == SKIP
+      @payout_start_date = payout_start_date unless payout_start_date == SKIP
+      @payout_end_date = payout_end_date unless payout_end_date == SKIP
+      @number_modal_payouts = number_modal_payouts unless number_modal_payouts == SKIP
+      @surrender_value = surrender_value unless surrender_value == SKIP
+      @payout_change_percentage = payout_change_percentage unless payout_change_percentage == SKIP
+      @payout_change_amount = payout_change_amount unless payout_change_amount == SKIP
+      @period_certain_type = period_certain_type unless period_certain_type == SKIP
+      @additional_properties = additional_properties
+
+      # Call the constructor of the base class
+      super(parent_account_id: parent_account_id,
+            line_of_business: line_of_business,
+            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,
+            transactions_included: transactions_included,
+            domicile: domicile,
+            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
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      payout_type = hash.key?('payoutType') ? hash['payoutType'] : SKIP
+      policy_product_type =
+        hash.key?('policyProductType') ? hash['policyProductType'] : SKIP
+      payout_amount = hash.key?('payoutAmount') ? hash['payoutAmount'] : SKIP
+      payout_mode = hash.key?('payoutMode') ? hash['payoutMode'] : SKIP
+      payout_start_date =
+        hash.key?('payoutStartDate') ? hash['payoutStartDate'] : SKIP
+      payout_end_date =
+        hash.key?('payoutEndDate') ? hash['payoutEndDate'] : SKIP
+      number_modal_payouts =
+        hash.key?('numberModalPayouts') ? hash['numberModalPayouts'] : SKIP
+      surrender_value =
+        hash.key?('surrenderValue') ? hash['surrenderValue'] : SKIP
+      payout_change_percentage =
+        hash.key?('payoutChangePercentage') ? hash['payoutChangePercentage'] : SKIP
+      payout_change_amount =
+        hash.key?('payoutChangeAmount') ? hash['payoutChangeAmount'] : SKIP
+      period_certain_type =
+        hash.key?('periodCertainType') ? hash['periodCertainType'] : SKIP
+      parent_account_id =
+        hash.key?('parentAccountId') ? hash['parentAccountId'] : SKIP
+      line_of_business =
+        hash.key?('lineOfBusiness') ? hash['lineOfBusiness'] : SKIP
+      routing_transit_number =
+        hash.key?('routingTransitNumber') ? hash['routingTransitNumber'] : SKIP
+      balance_type = hash.key?('balanceType') ? hash['balanceType'] : SKIP
+      contact = AccountContactEntity2.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
+      transactions_included =
+        hash.key?('transactionsIncluded') ? hash['transactionsIncluded'] : SKIP
+      domicile = DomicileEntity1.from_hash(hash['domicile']) if hash['domicile']
+      account_category = hash['accountCategory'] ||= 'Annuity Account 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.
+      AnnuityAccountEntity.new(payout_type: payout_type,
+                               policy_product_type: policy_product_type,
+                               payout_amount: payout_amount,
+                               payout_mode: payout_mode,
+                               payout_start_date: payout_start_date,
+                               payout_end_date: payout_end_date,
+                               number_modal_payouts: number_modal_payouts,
+                               surrender_value: surrender_value,
+                               payout_change_percentage: payout_change_percentage,
+                               payout_change_amount: payout_change_amount,
+                               period_certain_type: period_certain_type,
+                               parent_account_id: parent_account_id,
+                               line_of_business: line_of_business,
+                               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,
+                               transactions_included: transactions_included,
+                               domicile: domicile,
+                               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
+
+    # Validates an instance of the object from a given value.
+    # @param [AnnuityAccountEntity | 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}, payout_type: #{@payout_type}, policy_product_type:"\
+      " #{@policy_product_type}, payout_amount: #{@payout_amount}, payout_mode: #{@payout_mode},"\
+      " payout_start_date: #{@payout_start_date}, payout_end_date: #{@payout_end_date},"\
+      " number_modal_payouts: #{@number_modal_payouts}, surrender_value: #{@surrender_value},"\
+      " payout_change_percentage: #{@payout_change_percentage}, payout_change_amount:"\
+      " #{@payout_change_amount}, period_certain_type: #{@period_certain_type}>"
+    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}, payout_type: #{@payout_type.inspect}, policy_product_type:"\
+      " #{@policy_product_type.inspect}, payout_amount: #{@payout_amount.inspect}, payout_mode:"\
+      " #{@payout_mode.inspect}, payout_start_date: #{@payout_start_date.inspect},"\
+      " payout_end_date: #{@payout_end_date.inspect}, number_modal_payouts:"\
+      " #{@number_modal_payouts.inspect}, surrender_value: #{@surrender_value.inspect},"\
+      " payout_change_percentage: #{@payout_change_percentage.inspect}, payout_change_amount:"\
+      " #{@payout_change_amount.inspect}, period_certain_type: #{@period_certain_type.inspect}>"
+    end
+  end
+end