apimatic-ak-sdk 0.0.1

data/lib/akoya/models/loan_balances.rb

@@ -0,0 +1,556 @@
+# akoya
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module Akoya
+  # Data elements included with balances specific to loan accounts
+  class LoanBalances < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Long-term persistent identity of the account. Not an account number. This
+    # identity must be unique to the owning institution.
+    # @return [String]
+    attr_accessor :account_id
+
+    # The type of an account. For instance, CHECKING, SAVINGS, 401K, etc.
+    # @return [String]
+    attr_accessor :account_type
+
+    # Account display number for the end user’s handle at owning institution.
+    # This is to be displayed by the Interface Provider.
+    # @return [String]
+    attr_accessor :account_number_display
+
+    # Indicates the currency code used by the account. May also include currency
+    # rate.
+    # @return [CurrencyEntity]
+    attr_accessor :currency
+
+    # Indicates the currency code used by the account. May also include currency
+    # rate.
+    # @return [String]
+    attr_accessor :description
+
+    # Present if an error was encountered while retrieving this account
+    # @return [ErrorEntityLoanBalances]
+    attr_accessor :error
+
+    # Present if an error was encountered while retrieving this account
+    # @return [Array[FiAttributeEntity]]
+    attr_accessor :fi_attributes
+
+    # Name given by the user. Used in UIs to assist in account selection
+    # @return [String]
+    attr_accessor :nickname
+
+    # Marketed product name for this account.  Used in UIs to assist in account
+    # selection
+    # @return [String]
+    attr_accessor :product_name
+
+    # The status of an account.
+    # @return [Status]
+    attr_accessor :status
+
+    # The line of business, such as consumer, consumer joint, small business,
+    # corporate, etc.
+    # @return [String]
+    attr_accessor :line_of_business
+
+    # ASSET (positive transaction amount increases balance), LIABILITY (positive
+    # transaction amount decreases balance)
+    # @return [BalanceType]
+    attr_accessor :balance_type
+
+    # Interest Rate of Account
+    # @return [Float]
+    attr_accessor :interest_rate
+
+    # The type of interest rate. FIXED or VARIABLE.
+    # @return [InterestRateType]
+    attr_accessor :interest_rate_type
+
+    # Date of account’s interest rate
+    # @return [DateTime]
+    attr_accessor :interest_rate_as_of
+
+    # Date that last transaction occurred on account
+    # @return [DateTime]
+    attr_accessor :last_activity_date
+
+    # MICR Number. (Magnetic Ink Character Recognition)
+    # @return [String]
+    attr_accessor :micr_number
+
+    # Long-term persistent identity of the parent account. This is used to group
+    # accounts.
+    # @return [String]
+    attr_accessor :parent_account_id
+
+    # Previous Interest Rate of Account
+    # @return [Float]
+    attr_accessor :prior_interest_rate
+
+    # Account is eligible for incoming transfers
+    # @return [TrueClass | FalseClass]
+    attr_accessor :transfer_in
+
+    # Account is eligible for outgoing transfers
+    # @return [TrueClass | FalseClass]
+    attr_accessor :transfer_out
+
+    # Account is eligible for outgoing transfers
+    # @return [CompoundingPeriod]
+    attr_accessor :compounding_period
+
+    # Term of loan in months
+    # @return [Integer]
+    attr_accessor :loan_term
+
+    # Maturity date is required for CDs
+    # @return [DateTime]
+    attr_accessor :maturity_date
+
+    # Loan origination date
+    # @return [DateTime]
+    attr_accessor :originating_date
+
+    # Loan origination date
+    # @return [PaymentFrequency]
+    attr_accessor :payment_frequency
+
+    # Total number of payments
+    # @return [Integer]
+    attr_accessor :total_number_of_payments
+
+    # As-of date of balances
+    # @return [DateTime]
+    attr_accessor :balance_as_of
+
+    # Escrow balance of loan
+    # @return [Float]
+    attr_accessor :escrow_balance
+
+    # Interest paid year to date
+    # @return [Float]
+    attr_accessor :interest_paid_year_to_date
+
+    # Last payment amount
+    # @return [Float]
+    attr_accessor :last_payment_amount
+
+    # Last payment date
+    # @return [DateTime]
+    attr_accessor :last_payment_date
+
+    # Amount of next payment
+    # @return [Float]
+    attr_accessor :next_payment_amount
+
+    # Date of next payment
+    # @return [DateTime]
+    attr_accessor :next_payment_date
+
+    # Original principal of loan
+    # @return [Float]
+    attr_accessor :original_principal
+
+    # Payoff amount
+    # @return [Float]
+    attr_accessor :pay_off_amount
+
+    # Principal balance of loan
+    # @return [Float]
+    attr_accessor :principal_balance
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_id'] = 'accountId'
+      @_hash['account_type'] = 'accountType'
+      @_hash['account_number_display'] = 'accountNumberDisplay'
+      @_hash['currency'] = 'currency'
+      @_hash['description'] = 'description'
+      @_hash['error'] = 'error'
+      @_hash['fi_attributes'] = 'fiAttributes'
+      @_hash['nickname'] = 'nickname'
+      @_hash['product_name'] = 'productName'
+      @_hash['status'] = 'status'
+      @_hash['line_of_business'] = 'lineOfBusiness'
+      @_hash['balance_type'] = 'balanceType'
+      @_hash['interest_rate'] = 'interestRate'
+      @_hash['interest_rate_type'] = 'interestRateType'
+      @_hash['interest_rate_as_of'] = 'interestRateAsOf'
+      @_hash['last_activity_date'] = 'lastActivityDate'
+      @_hash['micr_number'] = 'micrNumber'
+      @_hash['parent_account_id'] = 'parentAccountId'
+      @_hash['prior_interest_rate'] = 'priorInterestRate'
+      @_hash['transfer_in'] = 'transferIn'
+      @_hash['transfer_out'] = 'transferOut'
+      @_hash['compounding_period'] = 'compoundingPeriod'
+      @_hash['loan_term'] = 'loanTerm'
+      @_hash['maturity_date'] = 'maturityDate'
+      @_hash['originating_date'] = 'originatingDate'
+      @_hash['payment_frequency'] = 'paymentFrequency'
+      @_hash['total_number_of_payments'] = 'totalNumberOfPayments'
+      @_hash['balance_as_of'] = 'balanceAsOf'
+      @_hash['escrow_balance'] = 'escrowBalance'
+      @_hash['interest_paid_year_to_date'] = 'interestPaidYearToDate'
+      @_hash['last_payment_amount'] = 'lastPaymentAmount'
+      @_hash['last_payment_date'] = 'lastPaymentDate'
+      @_hash['next_payment_amount'] = 'nextPaymentAmount'
+      @_hash['next_payment_date'] = 'nextPaymentDate'
+      @_hash['original_principal'] = 'originalPrincipal'
+      @_hash['pay_off_amount'] = 'payOffAmount'
+      @_hash['principal_balance'] = 'principalBalance'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_type
+        account_number_display
+        currency
+        description
+        error
+        fi_attributes
+        nickname
+        product_name
+        status
+        line_of_business
+        balance_type
+        interest_rate
+        interest_rate_type
+        interest_rate_as_of
+        last_activity_date
+        micr_number
+        parent_account_id
+        prior_interest_rate
+        transfer_in
+        transfer_out
+        compounding_period
+        loan_term
+        maturity_date
+        originating_date
+        payment_frequency
+        total_number_of_payments
+        balance_as_of
+        escrow_balance
+        interest_paid_year_to_date
+        last_payment_amount
+        last_payment_date
+        next_payment_amount
+        next_payment_date
+        original_principal
+        pay_off_amount
+        principal_balance
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_id:, account_type: SKIP,
+                   account_number_display: SKIP, currency: SKIP,
+                   description: SKIP, error: SKIP, fi_attributes: SKIP,
+                   nickname: SKIP, product_name: SKIP, status: SKIP,
+                   line_of_business: SKIP, balance_type: SKIP,
+                   interest_rate: SKIP, interest_rate_type: SKIP,
+                   interest_rate_as_of: SKIP, last_activity_date: SKIP,
+                   micr_number: SKIP, parent_account_id: SKIP,
+                   prior_interest_rate: SKIP, transfer_in: SKIP,
+                   transfer_out: SKIP, compounding_period: SKIP,
+                   loan_term: SKIP, maturity_date: SKIP, originating_date: SKIP,
+                   payment_frequency: SKIP, total_number_of_payments: SKIP,
+                   balance_as_of: SKIP, escrow_balance: SKIP,
+                   interest_paid_year_to_date: SKIP, last_payment_amount: SKIP,
+                   last_payment_date: SKIP, next_payment_amount: SKIP,
+                   next_payment_date: SKIP, original_principal: SKIP,
+                   pay_off_amount: SKIP, principal_balance: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @account_id = account_id
+      @account_type = account_type unless account_type == SKIP
+      @account_number_display = account_number_display unless account_number_display == SKIP
+      @currency = currency unless currency == SKIP
+      @description = description unless description == SKIP
+      @error = error unless error == SKIP
+      @fi_attributes = fi_attributes unless fi_attributes == SKIP
+      @nickname = nickname unless nickname == SKIP
+      @product_name = product_name unless product_name == SKIP
+      @status = status unless status == SKIP
+      @line_of_business = line_of_business unless line_of_business == SKIP
+      @balance_type = balance_type unless balance_type == SKIP
+      @interest_rate = interest_rate unless interest_rate == SKIP
+      @interest_rate_type = interest_rate_type unless interest_rate_type == SKIP
+      @interest_rate_as_of = interest_rate_as_of unless interest_rate_as_of == SKIP
+      @last_activity_date = last_activity_date unless last_activity_date == SKIP
+      @micr_number = micr_number unless micr_number == SKIP
+      @parent_account_id = parent_account_id unless parent_account_id == SKIP
+      @prior_interest_rate = prior_interest_rate unless prior_interest_rate == SKIP
+      @transfer_in = transfer_in unless transfer_in == SKIP
+      @transfer_out = transfer_out unless transfer_out == SKIP
+      @compounding_period = compounding_period unless compounding_period == SKIP
+      @loan_term = loan_term unless loan_term == SKIP
+      @maturity_date = maturity_date unless maturity_date == SKIP
+      @originating_date = originating_date unless originating_date == SKIP
+      @payment_frequency = payment_frequency unless payment_frequency == SKIP
+      @total_number_of_payments = total_number_of_payments unless total_number_of_payments == SKIP
+      @balance_as_of = balance_as_of unless balance_as_of == SKIP
+      @escrow_balance = escrow_balance unless escrow_balance == SKIP
+      unless interest_paid_year_to_date == SKIP
+        @interest_paid_year_to_date =
+          interest_paid_year_to_date
+      end
+      @last_payment_amount = last_payment_amount unless last_payment_amount == SKIP
+      @last_payment_date = last_payment_date unless last_payment_date == SKIP
+      @next_payment_amount = next_payment_amount unless next_payment_amount == SKIP
+      @next_payment_date = next_payment_date unless next_payment_date == SKIP
+      @original_principal = original_principal unless original_principal == SKIP
+      @pay_off_amount = pay_off_amount unless pay_off_amount == SKIP
+      @principal_balance = principal_balance unless principal_balance == 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'] : nil
+      account_type = hash.key?('accountType') ? hash['accountType'] : SKIP
+      account_number_display =
+        hash.key?('accountNumberDisplay') ? hash['accountNumberDisplay'] : SKIP
+      currency = CurrencyEntity.from_hash(hash['currency']) if hash['currency']
+      description = hash.key?('description') ? hash['description'] : SKIP
+      error = ErrorEntityLoanBalances.from_hash(hash['error']) if hash['error']
+      # 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')
+      nickname = hash.key?('nickname') ? hash['nickname'] : SKIP
+      product_name = hash.key?('productName') ? hash['productName'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      line_of_business =
+        hash.key?('lineOfBusiness') ? hash['lineOfBusiness'] : SKIP
+      balance_type = hash.key?('balanceType') ? hash['balanceType'] : SKIP
+      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
+      last_activity_date = if hash.key?('lastActivityDate')
+                             (DateTimeHelper.from_rfc3339(hash['lastActivityDate']) if hash['lastActivityDate'])
+                           else
+                             SKIP
+                           end
+      micr_number = hash.key?('micrNumber') ? hash['micrNumber'] : SKIP
+      parent_account_id =
+        hash.key?('parentAccountId') ? hash['parentAccountId'] : SKIP
+      prior_interest_rate =
+        hash.key?('priorInterestRate') ? hash['priorInterestRate'] : SKIP
+      transfer_in = hash.key?('transferIn') ? hash['transferIn'] : SKIP
+      transfer_out = hash.key?('transferOut') ? hash['transferOut'] : SKIP
+      compounding_period =
+        hash.key?('compoundingPeriod') ? hash['compoundingPeriod'] : SKIP
+      loan_term = hash.key?('loanTerm') ? hash['loanTerm'] : SKIP
+      maturity_date = if hash.key?('maturityDate')
+                        (DateTimeHelper.from_rfc3339(hash['maturityDate']) if hash['maturityDate'])
+                      else
+                        SKIP
+                      end
+      originating_date = if hash.key?('originatingDate')
+                           (DateTimeHelper.from_rfc3339(hash['originatingDate']) if hash['originatingDate'])
+                         else
+                           SKIP
+                         end
+      payment_frequency =
+        hash.key?('paymentFrequency') ? hash['paymentFrequency'] : SKIP
+      total_number_of_payments =
+        hash.key?('totalNumberOfPayments') ? hash['totalNumberOfPayments'] : SKIP
+      balance_as_of = if hash.key?('balanceAsOf')
+                        (DateTimeHelper.from_rfc3339(hash['balanceAsOf']) if hash['balanceAsOf'])
+                      else
+                        SKIP
+                      end
+      escrow_balance = hash.key?('escrowBalance') ? hash['escrowBalance'] : SKIP
+      interest_paid_year_to_date =
+        hash.key?('interestPaidYearToDate') ? hash['interestPaidYearToDate'] : SKIP
+      last_payment_amount =
+        hash.key?('lastPaymentAmount') ? hash['lastPaymentAmount'] : SKIP
+      last_payment_date = if hash.key?('lastPaymentDate')
+                            (DateTimeHelper.from_rfc3339(hash['lastPaymentDate']) if hash['lastPaymentDate'])
+                          else
+                            SKIP
+                          end
+      next_payment_amount =
+        hash.key?('nextPaymentAmount') ? hash['nextPaymentAmount'] : SKIP
+      next_payment_date = if hash.key?('nextPaymentDate')
+                            (DateTimeHelper.from_rfc3339(hash['nextPaymentDate']) if hash['nextPaymentDate'])
+                          else
+                            SKIP
+                          end
+      original_principal =
+        hash.key?('originalPrincipal') ? hash['originalPrincipal'] : SKIP
+      pay_off_amount = hash.key?('payOffAmount') ? hash['payOffAmount'] : SKIP
+      principal_balance =
+        hash.key?('principalBalance') ? hash['principalBalance'] : 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.
+      LoanBalances.new(account_id: account_id,
+                       account_type: account_type,
+                       account_number_display: account_number_display,
+                       currency: currency,
+                       description: description,
+                       error: error,
+                       fi_attributes: fi_attributes,
+                       nickname: nickname,
+                       product_name: product_name,
+                       status: status,
+                       line_of_business: line_of_business,
+                       balance_type: balance_type,
+                       interest_rate: interest_rate,
+                       interest_rate_type: interest_rate_type,
+                       interest_rate_as_of: interest_rate_as_of,
+                       last_activity_date: last_activity_date,
+                       micr_number: micr_number,
+                       parent_account_id: parent_account_id,
+                       prior_interest_rate: prior_interest_rate,
+                       transfer_in: transfer_in,
+                       transfer_out: transfer_out,
+                       compounding_period: compounding_period,
+                       loan_term: loan_term,
+                       maturity_date: maturity_date,
+                       originating_date: originating_date,
+                       payment_frequency: payment_frequency,
+                       total_number_of_payments: total_number_of_payments,
+                       balance_as_of: balance_as_of,
+                       escrow_balance: escrow_balance,
+                       interest_paid_year_to_date: interest_paid_year_to_date,
+                       last_payment_amount: last_payment_amount,
+                       last_payment_date: last_payment_date,
+                       next_payment_amount: next_payment_amount,
+                       next_payment_date: next_payment_date,
+                       original_principal: original_principal,
+                       pay_off_amount: pay_off_amount,
+                       principal_balance: principal_balance,
+                       additional_properties: additional_properties)
+    end
+
+    def to_custom_interest_rate_as_of
+      DateTimeHelper.to_rfc3339(interest_rate_as_of)
+    end
+
+    def to_custom_last_activity_date
+      DateTimeHelper.to_rfc3339(last_activity_date)
+    end
+
+    def to_custom_maturity_date
+      DateTimeHelper.to_rfc3339(maturity_date)
+    end
+
+    def to_custom_originating_date
+      DateTimeHelper.to_rfc3339(originating_date)
+    end
+
+    def to_custom_balance_as_of
+      DateTimeHelper.to_rfc3339(balance_as_of)
+    end
+
+    def to_custom_last_payment_date
+      DateTimeHelper.to_rfc3339(last_payment_date)
+    end
+
+    def to_custom_next_payment_date
+      DateTimeHelper.to_rfc3339(next_payment_date)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [LoanBalances | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.account_id,
+                                     ->(val) { val.instance_of? String })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['accountId'],
+                            ->(val) { val.instance_of? String })
+    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}, account_type: #{@account_type},"\
+      " account_number_display: #{@account_number_display}, currency: #{@currency}, description:"\
+      " #{@description}, error: #{@error}, fi_attributes: #{@fi_attributes}, nickname:"\
+      " #{@nickname}, product_name: #{@product_name}, status: #{@status}, line_of_business:"\
+      " #{@line_of_business}, balance_type: #{@balance_type}, interest_rate: #{@interest_rate},"\
+      " interest_rate_type: #{@interest_rate_type}, interest_rate_as_of: #{@interest_rate_as_of},"\
+      " last_activity_date: #{@last_activity_date}, micr_number: #{@micr_number},"\
+      " parent_account_id: #{@parent_account_id}, prior_interest_rate: #{@prior_interest_rate},"\
+      " transfer_in: #{@transfer_in}, transfer_out: #{@transfer_out}, compounding_period:"\
+      " #{@compounding_period}, loan_term: #{@loan_term}, maturity_date: #{@maturity_date},"\
+      " originating_date: #{@originating_date}, payment_frequency: #{@payment_frequency},"\
+      " total_number_of_payments: #{@total_number_of_payments}, balance_as_of: #{@balance_as_of},"\
+      " escrow_balance: #{@escrow_balance}, interest_paid_year_to_date:"\
+      " #{@interest_paid_year_to_date}, last_payment_amount: #{@last_payment_amount},"\
+      " last_payment_date: #{@last_payment_date}, next_payment_amount: #{@next_payment_amount},"\
+      " next_payment_date: #{@next_payment_date}, original_principal: #{@original_principal},"\
+      " pay_off_amount: #{@pay_off_amount}, principal_balance: #{@principal_balance},"\
+      " 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}, account_type: #{@account_type.inspect},"\
+      " account_number_display: #{@account_number_display.inspect}, currency:"\
+      " #{@currency.inspect}, description: #{@description.inspect}, error: #{@error.inspect},"\
+      " fi_attributes: #{@fi_attributes.inspect}, nickname: #{@nickname.inspect}, product_name:"\
+      " #{@product_name.inspect}, status: #{@status.inspect}, line_of_business:"\
+      " #{@line_of_business.inspect}, balance_type: #{@balance_type.inspect}, interest_rate:"\
+      " #{@interest_rate.inspect}, interest_rate_type: #{@interest_rate_type.inspect},"\
+      " interest_rate_as_of: #{@interest_rate_as_of.inspect}, last_activity_date:"\
+      " #{@last_activity_date.inspect}, micr_number: #{@micr_number.inspect}, parent_account_id:"\
+      " #{@parent_account_id.inspect}, prior_interest_rate: #{@prior_interest_rate.inspect},"\
+      " transfer_in: #{@transfer_in.inspect}, transfer_out: #{@transfer_out.inspect},"\
+      " compounding_period: #{@compounding_period.inspect}, loan_term: #{@loan_term.inspect},"\
+      " maturity_date: #{@maturity_date.inspect}, originating_date: #{@originating_date.inspect},"\
+      " payment_frequency: #{@payment_frequency.inspect}, total_number_of_payments:"\
+      " #{@total_number_of_payments.inspect}, balance_as_of: #{@balance_as_of.inspect},"\
+      " escrow_balance: #{@escrow_balance.inspect}, interest_paid_year_to_date:"\
+      " #{@interest_paid_year_to_date.inspect}, last_payment_amount:"\
+      " #{@last_payment_amount.inspect}, last_payment_date: #{@last_payment_date.inspect},"\
+      " next_payment_amount: #{@next_payment_amount.inspect}, next_payment_date:"\
+      " #{@next_payment_date.inspect}, original_principal: #{@original_principal.inspect},"\
+      " pay_off_amount: #{@pay_off_amount.inspect}, principal_balance:"\
+      " #{@principal_balance.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/akoya/models/loan_payment_frequency.rb

@@ -0,0 +1,68 @@
+# akoya
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Akoya
+  # LoanPaymentFrequency.
+  class LoanPaymentFrequency
+    LOAN_PAYMENT_FREQUENCY = [
+      # TODO: Write general description for WEEKLY
+      WEEKLY = 'WEEKLY'.freeze,
+
+      # TODO: Write general description for BIWEEKLY
+      BIWEEKLY = 'BIWEEKLY'.freeze,
+
+      # TODO: Write general description for TWICEMONTHLY
+      TWICEMONTHLY = 'TWICEMONTHLY'.freeze,
+
+      # TODO: Write general description for MONTHLY
+      MONTHLY = 'MONTHLY'.freeze,
+
+      # TODO: Write general description for FOURWEEKS
+      FOURWEEKS = 'FOURWEEKS'.freeze,
+
+      # TODO: Write general description for BIMONTHLY
+      BIMONTHLY = 'BIMONTHLY'.freeze,
+
+      # TODO: Write general description for QUARTERLY
+      QUARTERLY = 'QUARTERLY'.freeze,
+
+      # TODO: Write general description for SEMIANNUALLY
+      SEMIANNUALLY = 'SEMIANNUALLY'.freeze,
+
+      # TODO: Write general description for ANNUALLY
+      ANNUALLY = 'ANNUALLY'.freeze,
+
+      # TODO: Write general description for OTHER
+      OTHER = 'OTHER'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = WEEKLY)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'weekly' then WEEKLY
+      when 'biweekly' then BIWEEKLY
+      when 'twicemonthly' then TWICEMONTHLY
+      when 'monthly' then MONTHLY
+      when 'fourweeks' then FOURWEEKS
+      when 'bimonthly' then BIMONTHLY
+      when 'quarterly' then QUARTERLY
+      when 'semiannually' then SEMIANNUALLY
+      when 'annually' then ANNUALLY
+      when 'other' then OTHER
+      else
+        default_value
+      end
+    end
+  end
+end