fdx-api-sdk-ruby 1.0.0

data/lib/fdx_api/models/planned_availability_entity.rb

@@ -0,0 +1,122 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module FdxApi
+  # 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_api/models/policy_premium_term_type.rb

@@ -0,0 +1,23 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # 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
+  end
+end

data/lib/fdx_api/models/policy_premium_term_type2.rb

@@ -0,0 +1,23 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # 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
+  end
+end

data/lib/fdx_api/models/policy_product_type.rb

@@ -0,0 +1,26 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # 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
+  end
+end

data/lib/fdx_api/models/policy_product_type2.rb

@@ -0,0 +1,23 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # 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
+  end
+end

data/lib/fdx_api/models/policy_status.rb

@@ -0,0 +1,52 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # 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
+  end
+end

data/lib/fdx_api/models/policy_status2.rb

@@ -0,0 +1,41 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # 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
+  end
+end

data/lib/fdx_api/models/portion_entity.rb

@@ -0,0 +1,95 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # An asset allocation with class and percentage
+  class PortionEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The asset class for this allocation
+    # @return [AssetClass2]
+    attr_accessor :asset_class
+
+    # The percentage of this allocation
+    # @return [Float]
+    attr_accessor :percent
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['asset_class'] = 'assetClass'
+      @_hash['percent'] = 'percent'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        asset_class
+        percent
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(asset_class: SKIP, percent: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @asset_class = asset_class unless asset_class == SKIP
+      @percent = percent unless percent == 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.
+      asset_class = hash.key?('assetClass') ? hash['assetClass'] : SKIP
+      percent = hash.key?('percent') ? hash['percent'] : 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.
+      PortionEntity.new(asset_class: asset_class,
+                        percent: percent,
+                        additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [PortionEntity | 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} asset_class: #{@asset_class}, percent: #{@percent}, 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_class: #{@asset_class.inspect}, percent: #{@percent.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/position_type.rb

@@ -0,0 +1,23 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # The type of an investment position
+  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
+  end
+end

data/lib/fdx_api/models/position_type1.rb

@@ -0,0 +1,23 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # LONG, SHORT
+  class PositionType1
+    POSITION_TYPE1 = [
+      # 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
+  end
+end

data/lib/fdx_api/models/proprietary_account_id_scheme_entity.rb

@@ -0,0 +1,88 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Proprietary account identification scheme, as per ISO 20022 v1.
+  class ProprietaryAccountIdSchemeEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # This property is related to the name of the identification scheme,
+    # in the proprietary system, as per ISO 20022 v1.
+    # @return [String]
+    attr_accessor :proprietary_name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['proprietary_name'] = 'proprietaryName'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        proprietary_name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(proprietary_name: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @proprietary_name = proprietary_name unless proprietary_name == 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.
+      proprietary_name =
+        hash.key?('proprietaryName') ? hash['proprietaryName'] : 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.
+      ProprietaryAccountIdSchemeEntity.new(proprietary_name: proprietary_name,
+                                           additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [ProprietaryAccountIdSchemeEntity | 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} proprietary_name: #{@proprietary_name}, 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} proprietary_name: #{@proprietary_name.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/proprietary_financial_institution_id_scheme_entity.rb

@@ -0,0 +1,86 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Proprietary financial institution identification scheme, as per ISO 20022
+  # v1.
+  class ProprietaryFinancialInstitutionIdSchemeEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # This property is related to the name of the identification scheme,
+    # in the proprietary system, as per ISO 20022 v1
+    # @return [String]
+    attr_accessor :name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @name = name unless name == 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.
+      name = hash.key?('name') ? hash['name'] : 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.
+      ProprietaryFinancialInstitutionIdSchemeEntity.new(name: name,
+                                                        additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [ProprietaryFinancialInstitutionIdSchemeEntity | 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} name: #{@name}, 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} name: #{@name.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end