trinsic_api 3.0.2.pre.preview → 3.1.0.pre.preview1

data/lib/trinsic_api/models/singpass_personal_catalog.rb

@@ -0,0 +1,403 @@
+=begin
+#Trinsic API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: v1
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.21.0
+
+=end
+
+require 'date'
+require 'time'
+
+module TrinsicApi
+  # MyInfo Personal catalog.
+  class SingpassPersonalCatalog < ApiModelBase
+    # The Unique Identifier Number (UINFIN) for the user.              The number can be either a National Registration Identity Card or a Foreign Identification Number (NRIC/FIN). Follows the format @xxxxxxx#: - @ is the status of the holder.     - Singapore citizens and permanent residents born before 1 January 2000 are assigned the letter \"S\".     - Singapore citizens and permanent residents born on or after 1 January 2000 are assigned the letter \"T\".     - Foreigners issued with long-term passes before 1 January 2000 are assigned the letter \"F\".     - Foreigners issued with long-term passes from 1 January 2000 to 31 December 2021 are assigned the letter \"G\".     - Foreigners issued with long-term passes on or after 1 January 2022 are assigned the letter \"M\". - xxxxxxx is seven digit serial number. - # is the checksum letter.
+    attr_accessor :identity_number
+
+    # The partial National Registration Identity Card or Foreign Identification Number (NRIC/FIN) shown by Singpass.              The value hides all but the last three digits and checksum.
+    attr_accessor :partial_identity_number
+
+    # The name of verified individual composed of all the possible names.              The name is assembled in the following format (where applicable): 1. Principal Name (The first name section) 2. Hanyu Pinyin Name 3. Alias Name 4. Hanyu Pinyin Alias Name 5. Married Name (optional): Available only for females, prefixed with \"MRS\"
+    attr_accessor :name
+
+    # The individual's alternate legally recognized name.
+    attr_accessor :alias_name
+
+    # The individual's Hanyu Pinyin name.
+    attr_accessor :hanyu_pinyin_name
+
+    # The individual's Hanyu Pinyin alias name.
+    attr_accessor :hanyu_pinyin_alias_name
+
+    # The individual's married name.              This appears when Singpass has a legally recognized married surname on file.
+    attr_accessor :married_name
+
+    # The user's email address.
+    attr_accessor :email
+
+    # The user's mobile number, split into prefix, area code, and subscriber number.
+    attr_accessor :mobile_number
+
+    # The user's dialect.
+    attr_accessor :dialect
+
+    # The user's date of birth.
+    attr_accessor :date_of_birth
+
+    # The user's residential status.              Possible values (code description): - A Alien - C Citizen - P PR - U Unknown - N NOT APPLICABLE
+    attr_accessor :residential_status
+
+    # The user's nationality in IS0-2 country code format.
+    attr_accessor :nationality
+
+    # The user's birth country in IS0-2 country code format.
+    attr_accessor :birth_country
+
+    # The user's passport number.
+    attr_accessor :passport_number
+
+    # The user's passport expiry date.
+    attr_accessor :passport_expiry_date
+
+    # The Pass type of the individual.              Possible values: (code description)              - RPass Work Permit - SPass S Pass - P1Pass Employment Pass - P2Pass Employment Pass - QPass Employment Pass - PEP Personalised Employment Pass - WHP Work Holiday Pass - TEP Training Employment Pass - Entre EntrePass - OVE Overseas Networks & Expertise Pass - DP Dependent Pass - LTVP Long-Term Visit Pass - LOC Letter of Consent - MWP Miscellaneous Work Pass - STP Student's Pass - LTVP+ Long-Term Visit Pass Plus - IEO Immigration Exemption Order              Note that this only applies to a FIN holder.
+    attr_accessor :pass_type
+
+    # Pass status.              Possible values: - Live - Approved (Interim status in which the FIN holder has yet to receive the pass)              Note that this only applies to a FIN holder.
+    attr_accessor :pass_status
+
+    # Pass expiration date.              Note that this only applies to a FIN holder.
+    attr_accessor :pass_expiry_date
+
+    # The user's employment sector.
+    attr_accessor :employment_sector
+
+    # The user's registered address.
+    attr_accessor :registered_address
+
+    # Housing and Development Board (HBD) flat type code and description.              This value will be null if not HBD Possible values (code description): - 111 1-ROOM FLAT (HDB) - 112 2-ROOM FLAT (HDB) - 113 3-ROOM FLAT (HDB) - 114 4-ROOM FLAT (HDB) - 115 5-ROOM FLAT (HDB) - 116 EXECUTIVE FLAT (HDB) - 118 STUDIO APARTMENT (HDB)
+    attr_accessor :house_developmenet_board_type
+
+    # The user's housing type.              Possible values (code description): - 121 DETACHED HOUSE - 122 SEMI-DETACHED HOUSE - 123 TERRACE HOUSE - 131 CONDOMINIUM - 132 EXECUTIVE CONDOMINIUM - 139 APARTMENT
+    attr_accessor :housing_type
+
+    # Sex of the individual.              Possible values: - Female - Male - Unknown
+    attr_accessor :sex
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'identity_number' => :'identityNumber',
+        :'partial_identity_number' => :'partialIdentityNumber',
+        :'name' => :'name',
+        :'alias_name' => :'aliasName',
+        :'hanyu_pinyin_name' => :'hanyuPinyinName',
+        :'hanyu_pinyin_alias_name' => :'hanyuPinyinAliasName',
+        :'married_name' => :'marriedName',
+        :'email' => :'email',
+        :'mobile_number' => :'mobileNumber',
+        :'dialect' => :'dialect',
+        :'date_of_birth' => :'dateOfBirth',
+        :'residential_status' => :'residentialStatus',
+        :'nationality' => :'nationality',
+        :'birth_country' => :'birthCountry',
+        :'passport_number' => :'passportNumber',
+        :'passport_expiry_date' => :'passportExpiryDate',
+        :'pass_type' => :'passType',
+        :'pass_status' => :'passStatus',
+        :'pass_expiry_date' => :'passExpiryDate',
+        :'employment_sector' => :'employmentSector',
+        :'registered_address' => :'registeredAddress',
+        :'house_developmenet_board_type' => :'houseDevelopmenetBoardType',
+        :'housing_type' => :'housingType',
+        :'sex' => :'sex'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'identity_number' => :'String',
+        :'partial_identity_number' => :'String',
+        :'name' => :'String',
+        :'alias_name' => :'String',
+        :'hanyu_pinyin_name' => :'String',
+        :'hanyu_pinyin_alias_name' => :'String',
+        :'married_name' => :'String',
+        :'email' => :'String',
+        :'mobile_number' => :'SingpassPhoneNumber',
+        :'dialect' => :'SingpassMyInfoDescription',
+        :'date_of_birth' => :'Date',
+        :'residential_status' => :'SingpassMyInfoDescription',
+        :'nationality' => :'String',
+        :'birth_country' => :'String',
+        :'passport_number' => :'String',
+        :'passport_expiry_date' => :'Date',
+        :'pass_type' => :'SingpassMyInfoDescription',
+        :'pass_status' => :'String',
+        :'pass_expiry_date' => :'Date',
+        :'employment_sector' => :'String',
+        :'registered_address' => :'SingpassMyInfoRegisteredAddressOutput',
+        :'house_developmenet_board_type' => :'SingpassMyInfoDescription',
+        :'housing_type' => :'SingpassMyInfoDescription',
+        :'sex' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'identity_number',
+        :'partial_identity_number',
+        :'name',
+        :'alias_name',
+        :'hanyu_pinyin_name',
+        :'hanyu_pinyin_alias_name',
+        :'married_name',
+        :'email',
+        :'mobile_number',
+        :'dialect',
+        :'date_of_birth',
+        :'residential_status',
+        :'nationality',
+        :'birth_country',
+        :'passport_number',
+        :'passport_expiry_date',
+        :'pass_type',
+        :'pass_status',
+        :'pass_expiry_date',
+        :'employment_sector',
+        :'registered_address',
+        :'house_developmenet_board_type',
+        :'housing_type',
+        :'sex'
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `TrinsicApi::SingpassPersonalCatalog` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `TrinsicApi::SingpassPersonalCatalog`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'identity_number')
+        self.identity_number = attributes[:'identity_number']
+      end
+
+      if attributes.key?(:'partial_identity_number')
+        self.partial_identity_number = attributes[:'partial_identity_number']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'alias_name')
+        self.alias_name = attributes[:'alias_name']
+      end
+
+      if attributes.key?(:'hanyu_pinyin_name')
+        self.hanyu_pinyin_name = attributes[:'hanyu_pinyin_name']
+      end
+
+      if attributes.key?(:'hanyu_pinyin_alias_name')
+        self.hanyu_pinyin_alias_name = attributes[:'hanyu_pinyin_alias_name']
+      end
+
+      if attributes.key?(:'married_name')
+        self.married_name = attributes[:'married_name']
+      end
+
+      if attributes.key?(:'email')
+        self.email = attributes[:'email']
+      end
+
+      if attributes.key?(:'mobile_number')
+        self.mobile_number = attributes[:'mobile_number']
+      end
+
+      if attributes.key?(:'dialect')
+        self.dialect = attributes[:'dialect']
+      end
+
+      if attributes.key?(:'date_of_birth')
+        self.date_of_birth = attributes[:'date_of_birth']
+      end
+
+      if attributes.key?(:'residential_status')
+        self.residential_status = attributes[:'residential_status']
+      end
+
+      if attributes.key?(:'nationality')
+        self.nationality = attributes[:'nationality']
+      end
+
+      if attributes.key?(:'birth_country')
+        self.birth_country = attributes[:'birth_country']
+      end
+
+      if attributes.key?(:'passport_number')
+        self.passport_number = attributes[:'passport_number']
+      end
+
+      if attributes.key?(:'passport_expiry_date')
+        self.passport_expiry_date = attributes[:'passport_expiry_date']
+      end
+
+      if attributes.key?(:'pass_type')
+        self.pass_type = attributes[:'pass_type']
+      end
+
+      if attributes.key?(:'pass_status')
+        self.pass_status = attributes[:'pass_status']
+      end
+
+      if attributes.key?(:'pass_expiry_date')
+        self.pass_expiry_date = attributes[:'pass_expiry_date']
+      end
+
+      if attributes.key?(:'employment_sector')
+        self.employment_sector = attributes[:'employment_sector']
+      end
+
+      if attributes.key?(:'registered_address')
+        self.registered_address = attributes[:'registered_address']
+      end
+
+      if attributes.key?(:'house_developmenet_board_type')
+        self.house_developmenet_board_type = attributes[:'house_developmenet_board_type']
+      end
+
+      if attributes.key?(:'housing_type')
+        self.housing_type = attributes[:'housing_type']
+      end
+
+      if attributes.key?(:'sex')
+        self.sex = attributes[:'sex']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          identity_number == o.identity_number &&
+          partial_identity_number == o.partial_identity_number &&
+          name == o.name &&
+          alias_name == o.alias_name &&
+          hanyu_pinyin_name == o.hanyu_pinyin_name &&
+          hanyu_pinyin_alias_name == o.hanyu_pinyin_alias_name &&
+          married_name == o.married_name &&
+          email == o.email &&
+          mobile_number == o.mobile_number &&
+          dialect == o.dialect &&
+          date_of_birth == o.date_of_birth &&
+          residential_status == o.residential_status &&
+          nationality == o.nationality &&
+          birth_country == o.birth_country &&
+          passport_number == o.passport_number &&
+          passport_expiry_date == o.passport_expiry_date &&
+          pass_type == o.pass_type &&
+          pass_status == o.pass_status &&
+          pass_expiry_date == o.pass_expiry_date &&
+          employment_sector == o.employment_sector &&
+          registered_address == o.registered_address &&
+          house_developmenet_board_type == o.house_developmenet_board_type &&
+          housing_type == o.housing_type &&
+          sex == o.sex
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [identity_number, partial_identity_number, name, alias_name, hanyu_pinyin_name, hanyu_pinyin_alias_name, married_name, email, mobile_number, dialect, date_of_birth, residential_status, nationality, birth_country, passport_number, passport_expiry_date, pass_type, pass_status, pass_expiry_date, employment_sector, registered_address, house_developmenet_board_type, housing_type, sex].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+  end
+
+end

data/lib/trinsic_api/models/singpass_phone_number.rb

@@ -0,0 +1,172 @@
+=begin
+#Trinsic API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: v1
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.21.0
+
+=end
+
+require 'date'
+require 'time'
+
+module TrinsicApi
+  # The structured MyInfo mobile number payload.
+  class SingpassPhoneNumber < ApiModelBase
+    # The phone number prefix.
+    attr_accessor :prefix
+
+    # The phone number area code.
+    attr_accessor :area_code
+
+    # The phone number's subscriber number.
+    attr_accessor :number
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'prefix' => :'prefix',
+        :'area_code' => :'areaCode',
+        :'number' => :'number'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'prefix' => :'String',
+        :'area_code' => :'String',
+        :'number' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'prefix',
+        :'area_code',
+        :'number'
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `TrinsicApi::SingpassPhoneNumber` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `TrinsicApi::SingpassPhoneNumber`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'prefix')
+        self.prefix = attributes[:'prefix']
+      end
+
+      if attributes.key?(:'area_code')
+        self.area_code = attributes[:'area_code']
+      end
+
+      if attributes.key?(:'number')
+        self.number = attributes[:'number']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          prefix == o.prefix &&
+          area_code == o.area_code &&
+          number == o.number
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [prefix, area_code, number].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+  end
+
+end

data/lib/trinsic_api/models/smart_id_input.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v1
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.13.0
+Generator version: 7.21.0
 
 =end
 
@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module TrinsicApi
-  class SmartIdInput
+  class SmartIdInput < ApiModelBase
     # The user's Smart ID ETSI number or document number.
     attr_accessor :smart_id_number
 
@@ -128,61 +128,6 @@ module TrinsicApi
       new(transformed_hash)
     end
 
-    # Deserializes the data based on type
-    # @param string type Data type
-    # @param string value Value to be deserialized
-    # @return [Object] Deserialized data
-    def self._deserialize(type, value)
-      case type.to_sym
-      when :Time
-        Time.parse(value)
-      when :Date
-        Date.parse(value)
-      when :String
-        value.to_s
-      when :Integer
-        value.to_i
-      when :Float
-        value.to_f
-      when :Boolean
-        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
-          true
-        else
-          false
-        end
-      when :Object
-        # generic object (usually a Hash), return directly
-        value
-      when /\AArray<(?<inner_type>.+)>\z/
-        inner_type = Regexp.last_match[:inner_type]
-        value.map { |v| _deserialize(inner_type, v) }
-      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
-        k_type = Regexp.last_match[:k_type]
-        v_type = Regexp.last_match[:v_type]
-        {}.tap do |hash|
-          value.each do |k, v|
-            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
-          end
-        end
-      else # model
-        # models (e.g. Pet) or oneOf
-        klass = TrinsicApi.const_get(type)
-        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
-      end
-    end
-
-    # Returns the string representation of the object
-    # @return [String] String presentation of the object
-    def to_s
-      to_hash.to_s
-    end
-
-    # to_body is an alias to to_hash (backward compatibility)
-    # @return [Hash] Returns the object in the form of hash
-    def to_body
-      to_hash
-    end
-
     # Returns the object in the form of hash
     # @return [Hash] Returns the object in the form of hash
     def to_hash
@@ -199,24 +144,6 @@ module TrinsicApi
       hash
     end
 
-    # Outputs non-array value in the form of hash
-    # For object, use to_hash. Otherwise, just return the value
-    # @param [Object] value Any valid value
-    # @return [Hash] Returns the value in the form of hash
-    def _to_hash(value)
-      if value.is_a?(Array)
-        value.compact.map { |v| _to_hash(v) }
-      elsif value.is_a?(Hash)
-        {}.tap do |hash|
-          value.each { |k, v| hash[k] = _to_hash(v) }
-        end
-      elsif value.respond_to? :to_hash
-        value.to_hash
-      else
-        value
-      end
-    end
-
   end
 
 end