trinsic_api 3.1.0.pre.preview1 → 3.2.0

data/lib/trinsic_api/models/indonesia_dukcapil_match_provider_output.rb

@@ -0,0 +1,404 @@
+=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
+  # Exposed properties for the `indonesia-dukcapil-match` Provider which do not directly map to the normalized IdentityData model.
+  class IndonesiaDukcapilMatchProviderOutput < ApiModelBase
+    # NIK submitted for this Dukcapil match and the assessment result returned for that value.
+    attr_accessor :national_id_number
+
+    # Full name submitted for this Dukcapil match and the assessment result returned for that value.
+    attr_accessor :full_name
+
+    # Date of birth submitted for this Dukcapil match and the assessment result returned for that value.
+    attr_accessor :date_of_birth
+
+    # Two-digit Indonesian government administrative region code for the province, extracted from digits 1-2 of the submitted NIK number.              Source system: Kode Wilayah Administrasi Pemerintahan, maintained by Indonesia's Ministry of Home Affairs. The first digit indicates the island group: 1-2 Sumatra, 3-4 Java, 5 Bali and Nusa Tenggara, 6 Kalimantan, 7 Sulawesi, 8 Maluku, and 9 Papua. The second digit follows the province creation order.
+    attr_accessor :province_code
+
+    # Four-digit Indonesian government administrative region code for the regency or city, extracted from digits 1-4 of the submitted NIK number.              Source system: Kode Wilayah Administrasi Pemerintahan, maintained by Indonesia's Ministry of Home Affairs. Format: two-digit province code followed by a two-digit regency or city sequence; suffixes 01-69 identify regencies and suffixes 71-99 identify cities. The NIK stores this value without dot separators.
+    attr_accessor :regency_or_city_code
+
+    # Six-digit Indonesian government administrative region code for the district (kecamatan), extracted from digits 1-6 of the submitted NIK number.              Source system: Kode Wilayah Administrasi Pemerintahan, maintained by Indonesia's Ministry of Home Affairs. Format: two-digit province code, two-digit regency or city code, and two-digit district sequence. The NIK stores this value without dot separators.
+    attr_accessor :district_code
+
+    # Sex extracted from the birth-day portion of the submitted NIK number.              Known values: - Male: The encoded day value is 40 or lower. - Female: The encoded day value is greater than 40.
+    attr_accessor :sex_national_id_number
+
+    # Four-digit issuance serial number extracted from digits 13-16 of the submitted NIK number.
+    attr_accessor :serial_number
+
+    # The phone number submitted for this verification, if provided.              Format: international E.164 phone number.
+    attr_accessor :phone_number
+
+    # The consent timestamp submitted for this verification.
+    attr_accessor :consent_given_at
+
+    # The email address submitted for this verification, if provided.
+    attr_accessor :email
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'national_id_number' => :'nationalIdNumber',
+        :'full_name' => :'fullName',
+        :'date_of_birth' => :'dateOfBirth',
+        :'province_code' => :'provinceCode',
+        :'regency_or_city_code' => :'regencyOrCityCode',
+        :'district_code' => :'districtCode',
+        :'sex_national_id_number' => :'sexNationalIdNumber',
+        :'serial_number' => :'serialNumber',
+        :'phone_number' => :'phoneNumber',
+        :'consent_given_at' => :'consentGivenAt',
+        :'email' => :'email'
+      }
+    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
+      {
+        :'national_id_number' => :'IndonesiaDukcapilMatchNationalIdNumberField',
+        :'full_name' => :'IndonesiaDukcapilMatchFullNameField',
+        :'date_of_birth' => :'IndonesiaDukcapilMatchDateOfBirthField',
+        :'province_code' => :'String',
+        :'regency_or_city_code' => :'String',
+        :'district_code' => :'String',
+        :'sex_national_id_number' => :'String',
+        :'serial_number' => :'String',
+        :'phone_number' => :'String',
+        :'consent_given_at' => :'Time',
+        :'email' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'phone_number',
+        :'email'
+      ])
+    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::IndonesiaDukcapilMatchProviderOutput` 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::IndonesiaDukcapilMatchProviderOutput`. 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?(:'national_id_number')
+        self.national_id_number = attributes[:'national_id_number']
+      else
+        self.national_id_number = nil
+      end
+
+      if attributes.key?(:'full_name')
+        self.full_name = attributes[:'full_name']
+      else
+        self.full_name = nil
+      end
+
+      if attributes.key?(:'date_of_birth')
+        self.date_of_birth = attributes[:'date_of_birth']
+      else
+        self.date_of_birth = nil
+      end
+
+      if attributes.key?(:'province_code')
+        self.province_code = attributes[:'province_code']
+      else
+        self.province_code = nil
+      end
+
+      if attributes.key?(:'regency_or_city_code')
+        self.regency_or_city_code = attributes[:'regency_or_city_code']
+      else
+        self.regency_or_city_code = nil
+      end
+
+      if attributes.key?(:'district_code')
+        self.district_code = attributes[:'district_code']
+      else
+        self.district_code = nil
+      end
+
+      if attributes.key?(:'sex_national_id_number')
+        self.sex_national_id_number = attributes[:'sex_national_id_number']
+      else
+        self.sex_national_id_number = nil
+      end
+
+      if attributes.key?(:'serial_number')
+        self.serial_number = attributes[:'serial_number']
+      else
+        self.serial_number = nil
+      end
+
+      if attributes.key?(:'phone_number')
+        self.phone_number = attributes[:'phone_number']
+      end
+
+      if attributes.key?(:'consent_given_at')
+        self.consent_given_at = attributes[:'consent_given_at']
+      else
+        self.consent_given_at = nil
+      end
+
+      if attributes.key?(:'email')
+        self.email = attributes[:'email']
+      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
+      if @national_id_number.nil?
+        invalid_properties.push('invalid value for "national_id_number", national_id_number cannot be nil.')
+      end
+
+      if @full_name.nil?
+        invalid_properties.push('invalid value for "full_name", full_name cannot be nil.')
+      end
+
+      if @date_of_birth.nil?
+        invalid_properties.push('invalid value for "date_of_birth", date_of_birth cannot be nil.')
+      end
+
+      if @province_code.nil?
+        invalid_properties.push('invalid value for "province_code", province_code cannot be nil.')
+      end
+
+      if @regency_or_city_code.nil?
+        invalid_properties.push('invalid value for "regency_or_city_code", regency_or_city_code cannot be nil.')
+      end
+
+      if @district_code.nil?
+        invalid_properties.push('invalid value for "district_code", district_code cannot be nil.')
+      end
+
+      if @sex_national_id_number.nil?
+        invalid_properties.push('invalid value for "sex_national_id_number", sex_national_id_number cannot be nil.')
+      end
+
+      if @serial_number.nil?
+        invalid_properties.push('invalid value for "serial_number", serial_number cannot be nil.')
+      end
+
+      if @consent_given_at.nil?
+        invalid_properties.push('invalid value for "consent_given_at", consent_given_at cannot be nil.')
+      end
+
+      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'
+      return false if @national_id_number.nil?
+      return false if @full_name.nil?
+      return false if @date_of_birth.nil?
+      return false if @province_code.nil?
+      return false if @regency_or_city_code.nil?
+      return false if @district_code.nil?
+      return false if @sex_national_id_number.nil?
+      return false if @serial_number.nil?
+      return false if @consent_given_at.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] national_id_number Value to be assigned
+    def national_id_number=(national_id_number)
+      if national_id_number.nil?
+        fail ArgumentError, 'national_id_number cannot be nil'
+      end
+
+      @national_id_number = national_id_number
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] full_name Value to be assigned
+    def full_name=(full_name)
+      if full_name.nil?
+        fail ArgumentError, 'full_name cannot be nil'
+      end
+
+      @full_name = full_name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] date_of_birth Value to be assigned
+    def date_of_birth=(date_of_birth)
+      if date_of_birth.nil?
+        fail ArgumentError, 'date_of_birth cannot be nil'
+      end
+
+      @date_of_birth = date_of_birth
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] province_code Value to be assigned
+    def province_code=(province_code)
+      if province_code.nil?
+        fail ArgumentError, 'province_code cannot be nil'
+      end
+
+      @province_code = province_code
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] regency_or_city_code Value to be assigned
+    def regency_or_city_code=(regency_or_city_code)
+      if regency_or_city_code.nil?
+        fail ArgumentError, 'regency_or_city_code cannot be nil'
+      end
+
+      @regency_or_city_code = regency_or_city_code
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] district_code Value to be assigned
+    def district_code=(district_code)
+      if district_code.nil?
+        fail ArgumentError, 'district_code cannot be nil'
+      end
+
+      @district_code = district_code
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] sex_national_id_number Value to be assigned
+    def sex_national_id_number=(sex_national_id_number)
+      if sex_national_id_number.nil?
+        fail ArgumentError, 'sex_national_id_number cannot be nil'
+      end
+
+      @sex_national_id_number = sex_national_id_number
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] serial_number Value to be assigned
+    def serial_number=(serial_number)
+      if serial_number.nil?
+        fail ArgumentError, 'serial_number cannot be nil'
+      end
+
+      @serial_number = serial_number
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] consent_given_at Value to be assigned
+    def consent_given_at=(consent_given_at)
+      if consent_given_at.nil?
+        fail ArgumentError, 'consent_given_at cannot be nil'
+      end
+
+      @consent_given_at = consent_given_at
+    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 &&
+          national_id_number == o.national_id_number &&
+          full_name == o.full_name &&
+          date_of_birth == o.date_of_birth &&
+          province_code == o.province_code &&
+          regency_or_city_code == o.regency_or_city_code &&
+          district_code == o.district_code &&
+          sex_national_id_number == o.sex_national_id_number &&
+          serial_number == o.serial_number &&
+          phone_number == o.phone_number &&
+          consent_given_at == o.consent_given_at &&
+          email == o.email
+    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
+      [national_id_number, full_name, date_of_birth, province_code, regency_or_city_code, district_code, sex_national_id_number, serial_number, phone_number, consent_given_at, email].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/indonesia_nik_match.rb

@@ -0,0 +1,238 @@
+=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
+  # Exposed properties for the `indonesia-nik-lookup` Provider which do not directly map to the normalized IdentityData model.
+  class IndonesiaNikMatch < ApiModelBase
+    # Full name match result from Indonesia NIK verification.
+    attr_accessor :full_name
+
+    # Date of birth match result from Indonesia NIK verification.
+    attr_accessor :date_of_birth
+
+    # NIK number match result from Indonesia NIK verification.              NIK stands for Nomor Induk Kependudukan. It is Indonesia's unique population identity number, issued by Indonesia's population administration and civil registration authority (Dukcapil) under the Ministry of Home Affairs. A NIK has 16 digits: - Digits 1-2 are the province code. - Digits 3-4 are the regency or city code within that province. - Digits 5-6 are the district code within that regency or city. - Digits 7-12 encode date of birth as DDMMYY. For female NIK holders, the day is increased by 40. - Digits 13-16 are an issuance serial number.
+    attr_accessor :national_id_number
+
+    # Two-digit province code extracted from digits 1-2 of the NIK number.
+    attr_accessor :province_code
+
+    # Four-digit regency or city code extracted from digits 1-4 of the NIK number, including the province code prefix.
+    attr_accessor :regency_or_city_code
+
+    # Six-digit district code extracted from digits 1-6 of the NIK number, including province and regency/city code prefixes.
+    attr_accessor :district_code
+
+    # Date of birth extracted from digits 7-12 of the NIK number.              The NIK encodes date of birth as DDMMYY. For female NIK holders, the encoded day is increased by 40 before being stored in the NIK number.
+    attr_accessor :date_of_birth_national_id_number
+
+    # Sex extracted from the birth-day portion of the NIK number.              The encoded day value is increased by 40 for female NIK holders.
+    attr_accessor :sex_national_id_number
+
+    # Four-digit issuance serial number extracted from digits 13-16 of the NIK number.
+    attr_accessor :serial_number
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'full_name' => :'fullName',
+        :'date_of_birth' => :'dateOfBirth',
+        :'national_id_number' => :'nationalIdNumber',
+        :'province_code' => :'provinceCode',
+        :'regency_or_city_code' => :'regencyOrCityCode',
+        :'district_code' => :'districtCode',
+        :'date_of_birth_national_id_number' => :'dateOfBirthNationalIdNumber',
+        :'sex_national_id_number' => :'sexNationalIdNumber',
+        :'serial_number' => :'serialNumber'
+      }
+    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
+      {
+        :'full_name' => :'IndonesiaNikMatchField',
+        :'date_of_birth' => :'IndonesiaNikMatchField',
+        :'national_id_number' => :'IndonesiaNikMatchField',
+        :'province_code' => :'String',
+        :'regency_or_city_code' => :'String',
+        :'district_code' => :'String',
+        :'date_of_birth_national_id_number' => :'Date',
+        :'sex_national_id_number' => :'String',
+        :'serial_number' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'full_name',
+        :'date_of_birth',
+        :'national_id_number',
+        :'province_code',
+        :'regency_or_city_code',
+        :'district_code',
+        :'date_of_birth_national_id_number',
+        :'sex_national_id_number',
+        :'serial_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::IndonesiaNikMatch` 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::IndonesiaNikMatch`. 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?(:'full_name')
+        self.full_name = attributes[:'full_name']
+      end
+
+      if attributes.key?(:'date_of_birth')
+        self.date_of_birth = attributes[:'date_of_birth']
+      end
+
+      if attributes.key?(:'national_id_number')
+        self.national_id_number = attributes[:'national_id_number']
+      end
+
+      if attributes.key?(:'province_code')
+        self.province_code = attributes[:'province_code']
+      end
+
+      if attributes.key?(:'regency_or_city_code')
+        self.regency_or_city_code = attributes[:'regency_or_city_code']
+      end
+
+      if attributes.key?(:'district_code')
+        self.district_code = attributes[:'district_code']
+      end
+
+      if attributes.key?(:'date_of_birth_national_id_number')
+        self.date_of_birth_national_id_number = attributes[:'date_of_birth_national_id_number']
+      end
+
+      if attributes.key?(:'sex_national_id_number')
+        self.sex_national_id_number = attributes[:'sex_national_id_number']
+      end
+
+      if attributes.key?(:'serial_number')
+        self.serial_number = attributes[:'serial_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 &&
+          full_name == o.full_name &&
+          date_of_birth == o.date_of_birth &&
+          national_id_number == o.national_id_number &&
+          province_code == o.province_code &&
+          regency_or_city_code == o.regency_or_city_code &&
+          district_code == o.district_code &&
+          date_of_birth_national_id_number == o.date_of_birth_national_id_number &&
+          sex_national_id_number == o.sex_national_id_number &&
+          serial_number == o.serial_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
+      [full_name, date_of_birth, national_id_number, province_code, regency_or_city_code, district_code, date_of_birth_national_id_number, sex_national_id_number, serial_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