apimatic-ak-sdk 0.0.1

data/lib/akoya/models/payment_frequency_annuity_balances.rb

@@ -0,0 +1,44 @@
+# akoya
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Akoya
+  # PaymentFrequency_Annuity balances.
+  class PaymentFrequencyAnnuityBalances
+    PAYMENT_FREQUENCY_ANNUITY_BALANCES = [
+      # TODO: Write general description for ANNUALLY
+      ANNUALLY = 'ANNUALLY'.freeze,
+
+      # TODO: Write general description for QUARTERLY
+      QUARTERLY = 'QUARTERLY'.freeze,
+
+      # TODO: Write general description for MONTHLY
+      MONTHLY = 'MONTHLY'.freeze,
+
+      # TODO: Write general description for WEEKLY
+      WEEKLY = 'WEEKLY'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = ANNUALLY)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'annually' then ANNUALLY
+      when 'quarterly' then QUARTERLY
+      when 'monthly' then MONTHLY
+      when 'weekly' then WEEKLY
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/akoya/models/payment_network_supported_by_account.rb

@@ -0,0 +1,129 @@
+# akoya
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Akoya
+  # This provides details required to execute a transaction against the account
+  # within the payment network
+  class PaymentNetworkSupportedByAccount < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Bank identifier used by the payment network ie. Routing Number
+    # @return [String]
+    attr_accessor :bank_id
+
+    # The number used to identify the account within the payment network. If
+    # identifierType is ACCOUNT_NUMBER, this is the account number.
+    # @return [String]
+    attr_accessor :identifier
+
+    # Type of identifier
+    # @return [String]
+    attr_accessor :identifier_type
+
+    # Type of payment network
+    # @return [String]
+    attr_accessor :type
+
+    # Can transfer funds to the account using this information
+    # @return [TrueClass | FalseClass]
+    attr_accessor :transfer_in
+
+    # Can transfer funds from the account using this information
+    # @return [TrueClass | FalseClass]
+    attr_accessor :transfer_out
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['bank_id'] = 'bankId'
+      @_hash['identifier'] = 'identifier'
+      @_hash['identifier_type'] = 'identifierType'
+      @_hash['type'] = 'type'
+      @_hash['transfer_in'] = 'transferIn'
+      @_hash['transfer_out'] = 'transferOut'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        bank_id
+        identifier
+        identifier_type
+        type
+        transfer_in
+        transfer_out
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(bank_id: SKIP, identifier: SKIP, identifier_type: SKIP,
+                   type: SKIP, transfer_in: SKIP, transfer_out: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @bank_id = bank_id unless bank_id == SKIP
+      @identifier = identifier unless identifier == SKIP
+      @identifier_type = identifier_type unless identifier_type == SKIP
+      @type = type unless type == SKIP
+      @transfer_in = transfer_in unless transfer_in == SKIP
+      @transfer_out = transfer_out unless transfer_out == 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.
+      bank_id = hash.key?('bankId') ? hash['bankId'] : SKIP
+      identifier = hash.key?('identifier') ? hash['identifier'] : SKIP
+      identifier_type =
+        hash.key?('identifierType') ? hash['identifierType'] : SKIP
+      type = hash.key?('type') ? hash['type'] : SKIP
+      transfer_in = hash.key?('transferIn') ? hash['transferIn'] : SKIP
+      transfer_out = hash.key?('transferOut') ? hash['transferOut'] : 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.
+      PaymentNetworkSupportedByAccount.new(bank_id: bank_id,
+                                           identifier: identifier,
+                                           identifier_type: identifier_type,
+                                           type: type,
+                                           transfer_in: transfer_in,
+                                           transfer_out: transfer_out,
+                                           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} bank_id: #{@bank_id}, identifier: #{@identifier}, identifier_type:"\
+      " #{@identifier_type}, type: #{@type}, transfer_in: #{@transfer_in}, transfer_out:"\
+      " #{@transfer_out}, 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} bank_id: #{@bank_id.inspect}, identifier: #{@identifier.inspect},"\
+      " identifier_type: #{@identifier_type.inspect}, type: #{@type.inspect}, transfer_in:"\
+      " #{@transfer_in.inspect}, transfer_out: #{@transfer_out.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/akoya/models/pension_source_entity.rb

@@ -0,0 +1,143 @@
+# akoya
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module Akoya
+  # Information about a pension source.
+  class PensionSourceEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Name of the Source
+    # @return [String]
+    attr_accessor :display_name
+
+    # Benefit Amount
+    # @return [Float]
+    attr_accessor :amount
+
+    # Form of payment
+    # @return [String]
+    attr_accessor :payment_option
+
+    # Date benefit was calculated
+    # @return [DateTime]
+    attr_accessor :as_of_date
+
+    # Date benefit was calculated
+    # @return [Frequency]
+    attr_accessor :frequency
+
+    # Assumed retirement date ‐ As of date amount is payable
+    # @return [DateTime]
+    attr_accessor :start_date
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['display_name'] = 'displayName'
+      @_hash['amount'] = 'amount'
+      @_hash['payment_option'] = 'paymentOption'
+      @_hash['as_of_date'] = 'asOfDate'
+      @_hash['frequency'] = 'frequency'
+      @_hash['start_date'] = 'startDate'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        display_name
+        amount
+        payment_option
+        as_of_date
+        frequency
+        start_date
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(display_name: SKIP, amount: SKIP, payment_option: SKIP,
+                   as_of_date: SKIP, frequency: SKIP, start_date: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @display_name = display_name unless display_name == SKIP
+      @amount = amount unless amount == SKIP
+      @payment_option = payment_option unless payment_option == SKIP
+      @as_of_date = as_of_date unless as_of_date == SKIP
+      @frequency = frequency unless frequency == SKIP
+      @start_date = start_date unless start_date == 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.
+      display_name = hash.key?('displayName') ? hash['displayName'] : SKIP
+      amount = hash.key?('amount') ? hash['amount'] : SKIP
+      payment_option = hash.key?('paymentOption') ? hash['paymentOption'] : SKIP
+      as_of_date = if hash.key?('asOfDate')
+                     (DateTimeHelper.from_rfc3339(hash['asOfDate']) if hash['asOfDate'])
+                   else
+                     SKIP
+                   end
+      frequency = hash.key?('frequency') ? hash['frequency'] : SKIP
+      start_date = if hash.key?('startDate')
+                     (DateTimeHelper.from_rfc3339(hash['startDate']) if hash['startDate'])
+                   else
+                     SKIP
+                   end
+
+      # 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.
+      PensionSourceEntity.new(display_name: display_name,
+                              amount: amount,
+                              payment_option: payment_option,
+                              as_of_date: as_of_date,
+                              frequency: frequency,
+                              start_date: start_date,
+                              additional_properties: additional_properties)
+    end
+
+    def to_custom_as_of_date
+      DateTimeHelper.to_rfc3339(as_of_date)
+    end
+
+    def to_custom_start_date
+      DateTimeHelper.to_rfc3339(start_date)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} display_name: #{@display_name}, amount: #{@amount}, payment_option:"\
+      " #{@payment_option}, as_of_date: #{@as_of_date}, frequency: #{@frequency}, start_date:"\
+      " #{@start_date}, 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} display_name: #{@display_name.inspect}, amount: #{@amount.inspect},"\
+      " payment_option: #{@payment_option.inspect}, as_of_date: #{@as_of_date.inspect}, frequency:"\
+      " #{@frequency.inspect}, start_date: #{@start_date.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/akoya/models/period_certain_guarantee.rb

@@ -0,0 +1,48 @@
+# akoya
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Akoya
+  # PeriodCertainGuarantee.
+  class PeriodCertainGuarantee
+    PERIOD_CERTAIN_GUARANTEE = [
+      # TODO: Write general description for ENUM_NO_PERIOD_CERTAIN
+      ENUM_NO_PERIOD_CERTAIN = 'NO PERIOD CERTAIN'.freeze,
+
+      # TODO: Write general description for ENUM_5YEAR
+      ENUM_5YEAR = '5-YEAR'.freeze,
+
+      # TODO: Write general description for ENUM_10YEAR
+      ENUM_10YEAR = '10-YEAR'.freeze,
+
+      # TODO: Write general description for ENUM_20YEAR
+      ENUM_20YEAR = '20-YEAR'.freeze,
+
+      # TODO: Write general description for ENUM_30YEAR
+      ENUM_30YEAR = '30-YEAR'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = ENUM_NO_PERIOD_CERTAIN)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'enum_no_period_certain' then ENUM_NO_PERIOD_CERTAIN
+      when 'enum_5year' then ENUM_5YEAR
+      when 'enum_10year' then ENUM_10YEAR
+      when 'enum_20year' then ENUM_20YEAR
+      when 'enum_30year' then ENUM_30YEAR
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/akoya/models/policy_premium_term.rb

@@ -0,0 +1,36 @@
+# akoya
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Akoya
+  # he payment term for the premium. MONTHLY or ANNUAL.
+  class PolicyPremiumTerm
+    POLICY_PREMIUM_TERM = [
+      # TODO: Write general description for MONTHLY
+      MONTHLY = 'MONTHLY'.freeze,
+
+      # TODO: Write general description for ANNUAL
+      ANNUAL = 'ANNUAL'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = MONTHLY)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'monthly' then MONTHLY
+      when 'annual' then ANNUAL
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/akoya/models/position_type.rb

@@ -0,0 +1,36 @@
+# akoya
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Akoya
+  # PositionType.
+  class PositionType
+    POSITION_TYPE = [
+      # TODO: Write general description for LONG
+      LONG = 'LONG'.freeze,
+
+      # TODO: Write general description for SHORT
+      SHORT = 'SHORT'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = LONG)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'long' then LONG
+      when 'short' then SHORT
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/akoya/models/postion_type.rb

@@ -0,0 +1,36 @@
+# akoya
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Akoya
+  # LONG, SHORT.
+  class PostionType
+    POSTION_TYPE = [
+      # TODO: Write general description for LONG
+      LONG = 'LONG'.freeze,
+
+      # TODO: Write general description for SHORT
+      SHORT = 'SHORT'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = LONG)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'long' then LONG
+      when 'short' then SHORT
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/akoya/models/prev.rb

@@ -0,0 +1,84 @@
+# akoya
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Akoya
+  # Prev Model.
+  class Prev < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :href
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['href'] = 'href'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        href
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(href: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @href = href unless href == 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.
+      href = hash.key?('href') ? hash['href'] : 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.
+      Prev.new(href: href,
+               additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Prev | 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} href: #{@href}, 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} href: #{@href.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/akoya/models/refresh_tokens.rb

@@ -0,0 +1,103 @@
+# akoya
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Akoya
+  # Once the ID Token expires, you will need to call the token endpoint to
+  # obtain a new set of tokens. The refresh token expiration is set by the data
+  # provider.
+  class RefreshTokens < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Set to `refresh_token` to indicate a new id token will be returned
+    # @return [String]
+    attr_accessor :grant_type
+
+    # The refresh token
+    # @return [String]
+    attr_accessor :refresh_token
+
+    # Your app's client ID from Akoya
+    # @return [String]
+    attr_accessor :client_id
+
+    # Your app's Client secret
+    # @return [String]
+    attr_accessor :client_secret
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['grant_type'] = 'grant_type'
+      @_hash['refresh_token'] = 'refresh_token'
+      @_hash['client_id'] = 'client_id'
+      @_hash['client_secret'] = 'client_secret'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(grant_type: 'refresh_token', refresh_token:, client_id:,
+                   client_secret:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @grant_type = grant_type
+      @refresh_token = refresh_token
+      @client_id = client_id
+      @client_secret = client_secret
+      @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.
+      grant_type = hash['grant_type'] ||= 'refresh_token'
+      refresh_token = hash.key?('refresh_token') ? hash['refresh_token'] : nil
+      client_id = hash.key?('client_id') ? hash['client_id'] : nil
+      client_secret = hash.key?('client_secret') ? hash['client_secret'] : nil
+
+      # 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.
+      RefreshTokens.new(grant_type: grant_type,
+                        refresh_token: refresh_token,
+                        client_id: client_id,
+                        client_secret: client_secret,
+                        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} grant_type: #{@grant_type}, refresh_token: #{@refresh_token}, client_id:"\
+      " #{@client_id}, client_secret: #{@client_secret}, 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} grant_type: #{@grant_type.inspect}, refresh_token:"\
+      " #{@refresh_token.inspect}, client_id: #{@client_id.inspect}, client_secret:"\
+      " #{@client_secret.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/akoya/models/secured.rb

@@ -0,0 +1,36 @@
+# akoya
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Akoya
+  # How the option is secured
+  class Secured
+    SECURED = [
+      # TODO: Write general description for COVERED
+      COVERED = 'COVERED'.freeze,
+
+      # TODO: Write general description for NAKED
+      NAKED = 'NAKED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = COVERED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'covered' then COVERED
+      when 'naked' then NAKED
+      else
+        default_value
+      end
+    end
+  end
+end