fdx-apimatic-sdk 0.0.1

data/lib/fdx_v660_api/models/annuity_security_entity.rb

@@ -0,0 +1,234 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require_relative 'security_entity'
+
+module FdxV660Api
+  # An Annuity held on an investment account
+  class AnnuitySecurityEntity < SecurityEntity
+    # The periodic (usually monthly) interest rate earned on the account
+    # @return [InterestRateEntity10]
+    attr_accessor :earned_interest
+
+    # 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['earned_interest'] = 'earnedInterest'
+      @_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[
+        earned_interest
+        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(earned_interest: SKIP, 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,
+                   security_category: 'Annuity Security entity',
+                   fi_attributes: SKIP, additional_properties: nil)
+      @earned_interest = earned_interest unless earned_interest == SKIP
+      @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(security_category: security_category,
+            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.
+      earned_interest = InterestRateEntity10.from_hash(hash['earnedInterest']) if
+        hash['earnedInterest']
+      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
+      security_category = hash['securityCategory'] ||= 'Annuity Security entity'
+      # 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.
+      AnnuitySecurityEntity.new(earned_interest: earned_interest,
+                                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,
+                                security_category: security_category,
+                                fi_attributes: fi_attributes,
+                                additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [AnnuitySecurityEntity | 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}, 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}, earned_interest: #{@earned_interest.inspect}, 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

data/lib/fdx_v660_api/models/asset_class.rb

@@ -0,0 +1,56 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # The class of an investment asset
+  class AssetClass
+    ASSET_CLASS = [
+      # TODO: Write general description for DOMESTICBOND
+      DOMESTICBOND = 'DOMESTICBOND'.freeze,
+
+      # TODO: Write general description for INTLBOND
+      INTLBOND = 'INTLBOND'.freeze,
+
+      # TODO: Write general description for INTLSTOCK
+      INTLSTOCK = 'INTLSTOCK'.freeze,
+
+      # TODO: Write general description for LARGESTOCK
+      LARGESTOCK = 'LARGESTOCK'.freeze,
+
+      # TODO: Write general description for MONEYMARKET
+      MONEYMARKET = 'MONEYMARKET'.freeze,
+
+      # TODO: Write general description for OTHER
+      OTHER = 'OTHER'.freeze,
+
+      # TODO: Write general description for SMALLSTOCK
+      SMALLSTOCK = 'SMALLSTOCK'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = DOMESTICBOND)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'domesticbond' then DOMESTICBOND
+      when 'intlbond' then INTLBOND
+      when 'intlstock' then INTLSTOCK
+      when 'largestock' then LARGESTOCK
+      when 'moneymarket' then MONEYMARKET
+      when 'other' then OTHER
+      when 'smallstock' then SMALLSTOCK
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fdx_v660_api/models/asset_class2.rb

@@ -0,0 +1,56 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # The asset class for this allocation
+  class AssetClass2
+    ASSET_CLASS2 = [
+      # TODO: Write general description for DOMESTICBOND
+      DOMESTICBOND = 'DOMESTICBOND'.freeze,
+
+      # TODO: Write general description for INTLBOND
+      INTLBOND = 'INTLBOND'.freeze,
+
+      # TODO: Write general description for INTLSTOCK
+      INTLSTOCK = 'INTLSTOCK'.freeze,
+
+      # TODO: Write general description for LARGESTOCK
+      LARGESTOCK = 'LARGESTOCK'.freeze,
+
+      # TODO: Write general description for MONEYMARKET
+      MONEYMARKET = 'MONEYMARKET'.freeze,
+
+      # TODO: Write general description for OTHER
+      OTHER = 'OTHER'.freeze,
+
+      # TODO: Write general description for SMALLSTOCK
+      SMALLSTOCK = 'SMALLSTOCK'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = DOMESTICBOND)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'domesticbond' then DOMESTICBOND
+      when 'intlbond' then INTLBOND
+      when 'intlstock' then INTLSTOCK
+      when 'largestock' then LARGESTOCK
+      when 'moneymarket' then MONEYMARKET
+      when 'other' then OTHER
+      when 'smallstock' then SMALLSTOCK
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fdx_v660_api/models/asset_transfer_network.rb

@@ -0,0 +1,134 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Information required to facilitate asset transfer from this account
+  class AssetTransferNetwork < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The number used to identify the account within the asset transfer network.
+    # If identifierType is ACCOUNT_NUMBER, this is the account number; if
+    # identifierType is TOKENIZED_ACCOUNT_NUMBER, this is a tokenized account
+    # number
+    # @return [String]
+    attr_accessor :identifier
+
+    # Type of identifier
+    # @return [PaymentNetworkIdentifierType1]
+    attr_accessor :identifier_type
+
+    # The name of the institution holding the account
+    # @return [String]
+    attr_accessor :institution_name
+
+    # Institution identifier used by the asset transfer network ie. the
+    # Depository Trust and Clearing Corporation code for the institution holding
+    # the account
+    # @return [String]
+    attr_accessor :institution_id
+
+    # Type of asset transfer
+    # @return [AssetTransferType2]
+    attr_accessor :type
+
+    # Whether this account has joint owners
+    # @return [TrueClass | FalseClass]
+    attr_accessor :joint_account
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['identifier'] = 'identifier'
+      @_hash['identifier_type'] = 'identifierType'
+      @_hash['institution_name'] = 'institutionName'
+      @_hash['institution_id'] = 'institutionId'
+      @_hash['type'] = 'type'
+      @_hash['joint_account'] = 'jointAccount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        identifier
+        identifier_type
+        institution_name
+        institution_id
+        type
+        joint_account
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(identifier: SKIP, identifier_type: SKIP,
+                   institution_name: SKIP, institution_id: SKIP, type: SKIP,
+                   joint_account: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @identifier = identifier unless identifier == SKIP
+      @identifier_type = identifier_type unless identifier_type == SKIP
+      @institution_name = institution_name unless institution_name == SKIP
+      @institution_id = institution_id unless institution_id == SKIP
+      @type = type unless type == SKIP
+      @joint_account = joint_account unless joint_account == 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.
+      identifier = hash.key?('identifier') ? hash['identifier'] : SKIP
+      identifier_type =
+        hash.key?('identifierType') ? hash['identifierType'] : SKIP
+      institution_name =
+        hash.key?('institutionName') ? hash['institutionName'] : SKIP
+      institution_id = hash.key?('institutionId') ? hash['institutionId'] : SKIP
+      type = hash.key?('type') ? hash['type'] : SKIP
+      joint_account = hash.key?('jointAccount') ? hash['jointAccount'] : 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.
+      AssetTransferNetwork.new(identifier: identifier,
+                               identifier_type: identifier_type,
+                               institution_name: institution_name,
+                               institution_id: institution_id,
+                               type: type,
+                               joint_account: joint_account,
+                               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} identifier: #{@identifier}, identifier_type: #{@identifier_type},"\
+      " institution_name: #{@institution_name}, institution_id: #{@institution_id}, type:"\
+      " #{@type}, joint_account: #{@joint_account}, 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} identifier: #{@identifier.inspect}, identifier_type:"\
+      " #{@identifier_type.inspect}, institution_name: #{@institution_name.inspect},"\
+      " institution_id: #{@institution_id.inspect}, type: #{@type.inspect}, joint_account:"\
+      " #{@joint_account.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/asset_transfer_network_list.rb

@@ -0,0 +1,85 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # An array of asset transfer network details for this account
+  class AssetTransferNetworkList < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Array of asset transfer networks
+    # @return [Array[AssetTransferNetwork]]
+    attr_accessor :asset_transfer_networks
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['asset_transfer_networks'] = 'assetTransferNetworks'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        asset_transfer_networks
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(asset_transfer_networks: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @asset_transfer_networks = asset_transfer_networks unless asset_transfer_networks == 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.
+      # Parameter is an array, so we need to iterate through it
+      asset_transfer_networks = nil
+      unless hash['assetTransferNetworks'].nil?
+        asset_transfer_networks = []
+        hash['assetTransferNetworks'].each do |structure|
+          asset_transfer_networks << (AssetTransferNetwork.from_hash(structure) if structure)
+        end
+      end
+
+      asset_transfer_networks = SKIP unless hash.key?('assetTransferNetworks')
+
+      # 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.
+      AssetTransferNetworkList.new(asset_transfer_networks: asset_transfer_networks,
+                                   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} asset_transfer_networks: #{@asset_transfer_networks},"\
+      " 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} asset_transfer_networks: #{@asset_transfer_networks.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/asset_transfer_network_list1.rb

@@ -0,0 +1,86 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # AssetTransferNetworkList array as a JSON response if not encrypted, or as
+  # the JSON payload which is encrypted for an application/jwt response
+  class AssetTransferNetworkList1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Array of asset transfer networks
+    # @return [Array[AssetTransferNetwork]]
+    attr_accessor :asset_transfer_networks
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['asset_transfer_networks'] = 'assetTransferNetworks'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        asset_transfer_networks
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(asset_transfer_networks: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @asset_transfer_networks = asset_transfer_networks unless asset_transfer_networks == 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.
+      # Parameter is an array, so we need to iterate through it
+      asset_transfer_networks = nil
+      unless hash['assetTransferNetworks'].nil?
+        asset_transfer_networks = []
+        hash['assetTransferNetworks'].each do |structure|
+          asset_transfer_networks << (AssetTransferNetwork.from_hash(structure) if structure)
+        end
+      end
+
+      asset_transfer_networks = SKIP unless hash.key?('assetTransferNetworks')
+
+      # 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.
+      AssetTransferNetworkList1.new(asset_transfer_networks: asset_transfer_networks,
+                                    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} asset_transfer_networks: #{@asset_transfer_networks},"\
+      " 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} asset_transfer_networks: #{@asset_transfer_networks.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/asset_transfer_type.rb

@@ -0,0 +1,40 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # The possible values for type of asset transfer
+  class AssetTransferType
+    ASSET_TRANSFER_TYPE = [
+      # TODO: Write general description for CA_ATON
+      CA_ATON = 'CA_ATON'.freeze,
+
+      # TODO: Write general description for US_ACATS
+      US_ACATS = 'US_ACATS'.freeze,
+
+      # TODO: Write general description for US_DTC
+      US_DTC = 'US_DTC'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = CA_ATON)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'ca_aton' then CA_ATON
+      when 'us_acats' then US_ACATS
+      when 'us_dtc' then US_DTC
+      else
+        default_value
+      end
+    end
+  end
+end