fdx-apimatic-sdk 0.0.1

data/lib/fdx_v660_api/models/period_certain_type2.rb

@@ -0,0 +1,49 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # The number of modal periods comprising the duration of the certain period of
+  # an annuity payout
+  class PeriodCertainType2
+    PERIOD_CERTAIN_TYPE2 = [
+      # TODO: Write general description for ENUM_5_YEAR
+      ENUM_5_YEAR = '5_YEAR'.freeze,
+
+      # TODO: Write general description for ENUM_10_YEAR
+      ENUM_10_YEAR = '10_YEAR'.freeze,
+
+      # TODO: Write general description for ENUM_20_YEAR
+      ENUM_20_YEAR = '20_YEAR'.freeze,
+
+      # TODO: Write general description for ENUM_30_YEAR
+      ENUM_30_YEAR = '30_YEAR'.freeze,
+
+      # TODO: Write general description for NONE
+      NONE = 'NONE'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = ENUM_5_YEAR)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'enum_5_year' then ENUM_5_YEAR
+      when 'enum_10_year' then ENUM_10_YEAR
+      when 'enum_20_year' then ENUM_20_YEAR
+      when 'enum_30_year' then ENUM_30_YEAR
+      when 'none' then NONE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fdx_v660_api/models/person_entity.rb

@@ -0,0 +1,156 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Represents a person
+  class PersonEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Array of the contact email addresses
+    # @return [Array[String]]
+    attr_accessor :emails
+
+    # Array of the contact physical addresses
+    # @return [Array[DeliveryAddress]]
+    attr_accessor :addresses
+
+    # Array of the contact telephone numbers, with extension if any
+    # @return [Array[TelephoneNumberPlusExtension]]
+    attr_accessor :telephones
+
+    # The person's date of birth
+    # @return [Date]
+    attr_accessor :date_of_birth
+
+    # Country specific Tax Id associated with this customer. Masked as last
+    # four, e.g. xxx-xx-0123, or passed in encrypted payload. (SIN or NAS in
+    # Canada, SSN or TIN in US, etc.)
+    # @return [String]
+    attr_accessor :tax_id
+
+    # Country originating the Customer's taxId element
+    # @return [Iso3166CountryCode2]
+    attr_accessor :tax_id_country
+
+    # A federal (such as passport) or state (such as driver's license) issued
+    # identifier
+    # @return [String]
+    attr_accessor :government_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['emails'] = 'emails'
+      @_hash['addresses'] = 'addresses'
+      @_hash['telephones'] = 'telephones'
+      @_hash['date_of_birth'] = 'dateOfBirth'
+      @_hash['tax_id'] = 'taxId'
+      @_hash['tax_id_country'] = 'taxIdCountry'
+      @_hash['government_id'] = 'governmentId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        emails
+        addresses
+        telephones
+        date_of_birth
+        tax_id
+        tax_id_country
+        government_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(emails: SKIP, addresses: SKIP, telephones: SKIP,
+                   date_of_birth: SKIP, tax_id: SKIP, tax_id_country: SKIP,
+                   government_id: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @emails = emails unless emails == SKIP
+      @addresses = addresses unless addresses == SKIP
+      @telephones = telephones unless telephones == SKIP
+      @date_of_birth = date_of_birth unless date_of_birth == SKIP
+      @tax_id = tax_id unless tax_id == SKIP
+      @tax_id_country = tax_id_country unless tax_id_country == SKIP
+      @government_id = government_id unless government_id == 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.
+      emails = hash.key?('emails') ? hash['emails'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      addresses = nil
+      unless hash['addresses'].nil?
+        addresses = []
+        hash['addresses'].each do |structure|
+          addresses << (DeliveryAddress.from_hash(structure) if structure)
+        end
+      end
+
+      addresses = SKIP unless hash.key?('addresses')
+      # Parameter is an array, so we need to iterate through it
+      telephones = nil
+      unless hash['telephones'].nil?
+        telephones = []
+        hash['telephones'].each do |structure|
+          telephones << (TelephoneNumberPlusExtension.from_hash(structure) if structure)
+        end
+      end
+
+      telephones = SKIP unless hash.key?('telephones')
+      date_of_birth = hash.key?('dateOfBirth') ? hash['dateOfBirth'] : SKIP
+      tax_id = hash.key?('taxId') ? hash['taxId'] : SKIP
+      tax_id_country = hash.key?('taxIdCountry') ? hash['taxIdCountry'] : SKIP
+      government_id = hash.key?('governmentId') ? hash['governmentId'] : 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.
+      PersonEntity.new(emails: emails,
+                       addresses: addresses,
+                       telephones: telephones,
+                       date_of_birth: date_of_birth,
+                       tax_id: tax_id,
+                       tax_id_country: tax_id_country,
+                       government_id: government_id,
+                       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} emails: #{@emails}, addresses: #{@addresses}, telephones: #{@telephones},"\
+      " date_of_birth: #{@date_of_birth}, tax_id: #{@tax_id}, tax_id_country: #{@tax_id_country},"\
+      " government_id: #{@government_id}, 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} emails: #{@emails.inspect}, addresses: #{@addresses.inspect}, telephones:"\
+      " #{@telephones.inspect}, date_of_birth: #{@date_of_birth.inspect}, tax_id:"\
+      " #{@tax_id.inspect}, tax_id_country: #{@tax_id_country.inspect}, government_id:"\
+      " #{@government_id.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/planned_availability_entity.rb

@@ -0,0 +1,122 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module FdxV660Api
+  # Provider's plan for API availability
+  class PlannedAvailabilityEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # API availability status for this time period
+    # @return [AvailabilityStatus1]
+    attr_accessor :status
+
+    # Description of API availability status
+    # @return [String]
+    attr_accessor :description
+
+    # Start time for this status period
+    # @return [DateTime]
+    attr_accessor :start_time
+
+    # End time for this status period
+    # @return [DateTime]
+    attr_accessor :end_time
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['status'] = 'status'
+      @_hash['description'] = 'description'
+      @_hash['start_time'] = 'startTime'
+      @_hash['end_time'] = 'endTime'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        status
+        description
+        start_time
+        end_time
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(status: SKIP, description: SKIP, start_time: SKIP,
+                   end_time: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @status = status unless status == SKIP
+      @description = description unless description == SKIP
+      @start_time = start_time unless start_time == SKIP
+      @end_time = end_time unless end_time == 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.
+      status = hash.key?('status') ? hash['status'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      start_time = if hash.key?('startTime')
+                     (DateTimeHelper.from_rfc3339(hash['startTime']) if hash['startTime'])
+                   else
+                     SKIP
+                   end
+      end_time = if hash.key?('endTime')
+                   (DateTimeHelper.from_rfc3339(hash['endTime']) if hash['endTime'])
+                 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.
+      PlannedAvailabilityEntity.new(status: status,
+                                    description: description,
+                                    start_time: start_time,
+                                    end_time: end_time,
+                                    additional_properties: additional_properties)
+    end
+
+    def to_custom_start_time
+      DateTimeHelper.to_rfc3339(start_time)
+    end
+
+    def to_custom_end_time
+      DateTimeHelper.to_rfc3339(end_time)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} status: #{@status}, description: #{@description}, start_time:"\
+      " #{@start_time}, end_time: #{@end_time}, 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} status: #{@status.inspect}, description: #{@description.inspect},"\
+      " start_time: #{@start_time.inspect}, end_time: #{@end_time.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/policy_premium_term_type.rb

@@ -0,0 +1,36 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Payment terms for insurance premiums
+  class PolicyPremiumTermType
+    POLICY_PREMIUM_TERM_TYPE = [
+      # TODO: Write general description for ANNUAL
+      ANNUAL = 'ANNUAL'.freeze,
+
+      # TODO: Write general description for MONTHLY
+      MONTHLY = 'MONTHLY'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = ANNUAL)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'annual' then ANNUAL
+      when 'monthly' then MONTHLY
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fdx_v660_api/models/policy_premium_term_type2.rb

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

data/lib/fdx_v660_api/models/policy_product_type.rb

@@ -0,0 +1,39 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Distinguishes options in annuity payouts; values are defined by the carrier.
+  #   | Value | Description |   |-----|-----|   | FIXED | Payout is based on a
+  # guaranteed rate of return by the carrier |   | VARIABLE | Payout is based on
+  # the variable performance of the investments the buyer chooses |
+  class PolicyProductType
+    POLICY_PRODUCT_TYPE = [
+      # TODO: Write general description for FIXED
+      FIXED = 'FIXED'.freeze,
+
+      # TODO: Write general description for VARIABLE
+      VARIABLE = 'VARIABLE'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = FIXED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'fixed' then FIXED
+      when 'variable' then VARIABLE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fdx_v660_api/models/policy_product_type2.rb

@@ -0,0 +1,36 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # The type of annuity product, e.g. Fixed or Variable
+  class PolicyProductType2
+    POLICY_PRODUCT_TYPE2 = [
+      # TODO: Write general description for FIXED
+      FIXED = 'FIXED'.freeze,
+
+      # TODO: Write general description for VARIABLE
+      VARIABLE = 'VARIABLE'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = FIXED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'fixed' then FIXED
+      when 'variable' then VARIABLE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fdx_v660_api/models/policy_status.rb

@@ -0,0 +1,71 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # The status of an insurance policy account.   | Value | Description |
+  # |-----|-----|   | ACTIVE | At least one component of the insurance policy is
+  # in force |   | DEATH_CLAIM_PAID | Benefits for a death claim have been
+  # settled with the insured |   | DEATH_CLAIM_PENDING | A death claim has been
+  # submitted but not yet settled |   | EXPIRED | Nonpayment of premium has
+  # exhausted the policy's Grace Period |   | GRACE_PERIOD | A premium is due
+  # but before lapse in coverage begins |   | LAPSE_PENDING | After the Grace
+  # Period has been exhausted but before final expiration; during Lapse Pending,
+  # policy reinstatement may still be possible |   | TERMINATED | Either the
+  # insurance company or the insured cancel the coverage of a cancellable
+  # insurance policy |   | WAIVER | A premium payment is waived under certain
+  # conditions due to a payer benefit clause |
+  class PolicyStatus
+    POLICY_STATUS = [
+      # TODO: Write general description for ACTIVE
+      ACTIVE = 'ACTIVE'.freeze,
+
+      # TODO: Write general description for DEATH_CLAIM_PAID
+      DEATH_CLAIM_PAID = 'DEATH_CLAIM_PAID'.freeze,
+
+      # TODO: Write general description for DEATH_CLAIM_PENDING
+      DEATH_CLAIM_PENDING = 'DEATH_CLAIM_PENDING'.freeze,
+
+      # TODO: Write general description for EXPIRED
+      EXPIRED = 'EXPIRED'.freeze,
+
+      # TODO: Write general description for GRACE_PERIOD
+      GRACE_PERIOD = 'GRACE_PERIOD'.freeze,
+
+      # TODO: Write general description for LAPSE_PENDING
+      LAPSE_PENDING = 'LAPSE_PENDING'.freeze,
+
+      # TODO: Write general description for TERMINATED
+      TERMINATED = 'TERMINATED'.freeze,
+
+      # TODO: Write general description for WAIVER
+      WAIVER = 'WAIVER'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = ACTIVE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'active' then ACTIVE
+      when 'death_claim_paid' then DEATH_CLAIM_PAID
+      when 'death_claim_pending' then DEATH_CLAIM_PENDING
+      when 'expired' then EXPIRED
+      when 'grace_period' then GRACE_PERIOD
+      when 'lapse_pending' then LAPSE_PENDING
+      when 'terminated' then TERMINATED
+      when 'waiver' then WAIVER
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fdx_v660_api/models/policy_status2.rb

@@ -0,0 +1,60 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # The status of an insurance policy account
+  class PolicyStatus2
+    POLICY_STATUS2 = [
+      # TODO: Write general description for ACTIVE
+      ACTIVE = 'ACTIVE'.freeze,
+
+      # TODO: Write general description for DEATH_CLAIM_PAID
+      DEATH_CLAIM_PAID = 'DEATH_CLAIM_PAID'.freeze,
+
+      # TODO: Write general description for DEATH_CLAIM_PENDING
+      DEATH_CLAIM_PENDING = 'DEATH_CLAIM_PENDING'.freeze,
+
+      # TODO: Write general description for EXPIRED
+      EXPIRED = 'EXPIRED'.freeze,
+
+      # TODO: Write general description for GRACE_PERIOD
+      GRACE_PERIOD = 'GRACE_PERIOD'.freeze,
+
+      # TODO: Write general description for LAPSE_PENDING
+      LAPSE_PENDING = 'LAPSE_PENDING'.freeze,
+
+      # TODO: Write general description for TERMINATED
+      TERMINATED = 'TERMINATED'.freeze,
+
+      # TODO: Write general description for WAIVER
+      WAIVER = 'WAIVER'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = ACTIVE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'active' then ACTIVE
+      when 'death_claim_paid' then DEATH_CLAIM_PAID
+      when 'death_claim_pending' then DEATH_CLAIM_PENDING
+      when 'expired' then EXPIRED
+      when 'grace_period' then GRACE_PERIOD
+      when 'lapse_pending' then LAPSE_PENDING
+      when 'terminated' then TERMINATED
+      when 'waiver' then WAIVER
+      else
+        default_value
+      end
+    end
+  end
+end