trinsic_api 3.2.0 → 3.3.0.pre.alpha2

data/lib/trinsic_api/models/saudi_arabia_nafath_provider_output.rb

@@ -0,0 +1,260 @@
+=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 `saudi-arabia-nafath` Provider which do not directly map to the normalized IdentityData model.
+  class SaudiArabiaNafathProviderOutput < ApiModelBase
+    # Saudi Arabia national identity number used to authenticate the individual with Nafath.              Nafath supports three user types and the leading digit of this number identifies which one signed in: - 1: Saudi citizen national ID, issued by Civil Affairs (Al-Ahwal al-Madaniyya) under   the Ministry of Interior. - 2: Resident (Iqama or muqeem) number on the residence permit, issued by the General   Directorate of Passports (Al-Jawazat) under the Ministry of Interior. - 3 through 6: Visitor identity number (Hawiyyat Za'ir) for foreign nationals admitted on   short-term visas, including tourist, business, family visit, and Umrah visas.              Format: - Exactly ten decimal digits. - First digit is the user type as listed above. - Digits two through nine are assigned serially and have no semantic meaning. - For citizen and resident numbers, the tenth digit is a check digit derived from the   first nine digits with a modulus-ten style algorithm. No check digit is documented for   visitor numbers, and the Nafath sandbox's visitor numbers do not follow it.              Nafath returns no identifier for visitors, so for them this is the number the user submitted.
+    attr_accessor :national_identity_number
+
+    # Nafath user type derived from the leading digit of nationalIdentityNumber. The matching attributes object carries the fields Nafath defines only for that user type.              Possible values: - Citizen: Saudi citizen national ID (1-series). See citizenSpecificAttributes. - Resident: legally resident foreign national, Iqama (2-series). See   residentSpecificAttributes. - Visitor: visitor identity (3 through 6-series). See visitorSpecificAttributes.
+    attr_accessor :user_type
+
+    # Sex as returned by Nafath, normalized to the platform sex code.              Possible values: - Male - Female
+    attr_accessor :sex
+
+    # Nationality as an ISO 3166-1 alpha-2 country code.              Not every nationality passed by back Nafath corresponds to an ISO 3166-1 alpha-2 code, for example code 335 (Tribes Emigrated) or 336 (Turkestan). In these cases, this field is null. See nationalityCode for the raw nationality code.
+    attr_accessor :nationality
+
+    # Nationality code as returned by Nafath under nationalityCode.              This is the Saudi government's three-digit nationality code, grouped by region: - 1xx Arab states - 2xx North Africa - 3xx Asia, Middle East, and Oceania - 4xx Sub-Saharan Africa - 5xx Europe - 6xx Americas - 7xx Oceania              It is not an ISO 3166 numeric code. For example, 504 is Ireland according to Nafath but Morocco in ISO 3166.              See https://docs.trinsic.id/docs/saudi-arabia-nafath for a full list.
+    attr_accessor :nationality_code
+
+    # Date of birth in the Gregorian calendar.
+    attr_accessor :date_of_birth_gregorian
+
+    # Occupation code reported by Nafath.              Known values: - O: Other - G: Government
+    attr_accessor :occupation_code
+
+    # Passport number reported by Nafath.
+    attr_accessor :passport_number
+
+    # Attributes Nafath defines only for Saudi citizens.              Present only when userType is Citizen.
+    attr_accessor :citizen_specific_attributes
+
+    # Attributes Nafath defines only for residents holding an Iqama.              Present only when userType is Resident.
+    attr_accessor :resident_specific_attributes
+
+    # Attributes Nafath defines only for visitors on short-term visas.              Present only when userType is Visitor.
+    attr_accessor :visitor_specific_attributes
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'national_identity_number' => :'nationalIdentityNumber',
+        :'user_type' => :'userType',
+        :'sex' => :'sex',
+        :'nationality' => :'nationality',
+        :'nationality_code' => :'nationalityCode',
+        :'date_of_birth_gregorian' => :'dateOfBirthGregorian',
+        :'occupation_code' => :'occupationCode',
+        :'passport_number' => :'passportNumber',
+        :'citizen_specific_attributes' => :'citizenSpecificAttributes',
+        :'resident_specific_attributes' => :'residentSpecificAttributes',
+        :'visitor_specific_attributes' => :'visitorSpecificAttributes'
+      }
+    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_identity_number' => :'String',
+        :'user_type' => :'String',
+        :'sex' => :'String',
+        :'nationality' => :'String',
+        :'nationality_code' => :'String',
+        :'date_of_birth_gregorian' => :'Date',
+        :'occupation_code' => :'String',
+        :'passport_number' => :'String',
+        :'citizen_specific_attributes' => :'SaudiArabiaNafathCitizenAttributes',
+        :'resident_specific_attributes' => :'SaudiArabiaNafathResidentAttributes',
+        :'visitor_specific_attributes' => :'SaudiArabiaNafathVisitorAttributes'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'national_identity_number',
+        :'user_type',
+        :'sex',
+        :'nationality',
+        :'nationality_code',
+        :'date_of_birth_gregorian',
+        :'occupation_code',
+        :'passport_number',
+        :'citizen_specific_attributes',
+        :'resident_specific_attributes',
+        :'visitor_specific_attributes'
+      ])
+    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::SaudiArabiaNafathProviderOutput` 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::SaudiArabiaNafathProviderOutput`. 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_identity_number')
+        self.national_identity_number = attributes[:'national_identity_number']
+      end
+
+      if attributes.key?(:'user_type')
+        self.user_type = attributes[:'user_type']
+      end
+
+      if attributes.key?(:'sex')
+        self.sex = attributes[:'sex']
+      end
+
+      if attributes.key?(:'nationality')
+        self.nationality = attributes[:'nationality']
+      end
+
+      if attributes.key?(:'nationality_code')
+        self.nationality_code = attributes[:'nationality_code']
+      end
+
+      if attributes.key?(:'date_of_birth_gregorian')
+        self.date_of_birth_gregorian = attributes[:'date_of_birth_gregorian']
+      end
+
+      if attributes.key?(:'occupation_code')
+        self.occupation_code = attributes[:'occupation_code']
+      end
+
+      if attributes.key?(:'passport_number')
+        self.passport_number = attributes[:'passport_number']
+      end
+
+      if attributes.key?(:'citizen_specific_attributes')
+        self.citizen_specific_attributes = attributes[:'citizen_specific_attributes']
+      end
+
+      if attributes.key?(:'resident_specific_attributes')
+        self.resident_specific_attributes = attributes[:'resident_specific_attributes']
+      end
+
+      if attributes.key?(:'visitor_specific_attributes')
+        self.visitor_specific_attributes = attributes[:'visitor_specific_attributes']
+      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 &&
+          national_identity_number == o.national_identity_number &&
+          user_type == o.user_type &&
+          sex == o.sex &&
+          nationality == o.nationality &&
+          nationality_code == o.nationality_code &&
+          date_of_birth_gregorian == o.date_of_birth_gregorian &&
+          occupation_code == o.occupation_code &&
+          passport_number == o.passport_number &&
+          citizen_specific_attributes == o.citizen_specific_attributes &&
+          resident_specific_attributes == o.resident_specific_attributes &&
+          visitor_specific_attributes == o.visitor_specific_attributes
+    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_identity_number, user_type, sex, nationality, nationality_code, date_of_birth_gregorian, occupation_code, passport_number, citizen_specific_attributes, resident_specific_attributes, visitor_specific_attributes].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/saudi_arabia_nafath_resident_attributes.rb

@@ -0,0 +1,426 @@
+=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
+  class SaudiArabiaNafathResidentAttributes < ApiModelBase
+    # Given name in Arabic.              Nafath always returns this in Arabic. romanizedFirstName is the English form, and the session locale does not change either name.
+    attr_accessor :arabic_first_name
+
+    # Second name in Arabic. Same script as arabicFirstName.
+    attr_accessor :arabic_second_name
+
+    # Third name in Arabic. Same script as arabicFirstName.
+    attr_accessor :arabic_third_name
+
+    # Last name in Arabic. Same script as arabicFirstName.
+    attr_accessor :arabic_last_name
+
+    # Given name in English.              Nafath always returns this in English, including when the session locale is Arabic.
+    attr_accessor :romanized_first_name
+
+    # Second name in English. Same script as romanizedFirstName.
+    attr_accessor :romanized_second_name
+
+    # Third name in English. Same script as romanizedFirstName.
+    attr_accessor :romanized_third_name
+
+    # Last name in English. Same script as romanizedFirstName.
+    attr_accessor :romanized_last_name
+
+    # English nationality name.
+    attr_accessor :nationality_description
+
+    # Date of birth in the Hijri (Umm al-Qura) calendar, in YYYY-MM-DD format.
+    attr_accessor :date_of_birth_hijri
+
+    # Date the Iqama was issued in the Gregorian calendar.
+    attr_accessor :iqama_issue_date_gregorian
+
+    # Date the Iqama was issued in the Hijri calendar, in YYYY-MM-DD format.
+    attr_accessor :iqama_issue_date_hijri
+
+    # Date the Iqama expires in the Gregorian calendar.
+    attr_accessor :iqama_expiry_date_gregorian
+
+    # Date the Iqama expires in the Hijri calendar, in YYYY-MM-DD format.
+    attr_accessor :iqama_expiry_date_hijri
+
+    # Version number printed on the Iqama.              Represents the Iqama permit generation version.
+    attr_accessor :iqama_version_number
+
+    # Name of the city or office that issued the Iqama, in Arabic.              The session locale does not change it.
+    attr_accessor :iqama_issue_place
+
+    # Code for the office that issued the Iqama.
+    attr_accessor :iqama_issue_place_code
+
+    # Free-text occupation description.
+    attr_accessor :occupation_description
+
+    # Social-status (marital-status) code, from the Nafath socialStatusCode attribute. The numeric code is not unique on its own. The same code maps to different states depending on the value of the top-level sex field.              Code by sex: - 0, M: Single - 1, F: Single - 1, M: One wife - 2, F: Married - 2, M: Two wives - 3, F: Divorced - 3, M: Three wives - 4, F: Widow - 4, M: Four wives - 5, F: Pending divorced              Combinations not listed are not defined by Nafath.
+    attr_accessor :social_status_code
+
+    # Social status in uppercase English, for example MARRIED, from the Nafath socialStatus attribute.              Possible English values include: Single, Married, Divorced, Widow, Pending Divorced, One Wife, Two Wives, Three Wives, Four Wives.
+    attr_accessor :social_status
+
+    # Place of birth name.
+    attr_accessor :place_of_birth
+
+    # Code for the place of birth.
+    attr_accessor :place_of_birth_code
+
+    # Name of the entity sponsoring the Iqama, typically an employer.
+    attr_accessor :sponsor_name
+
+    # Legal status.
+    attr_accessor :legal_status
+
+    # Whether the resident is currently inside or outside Saudi Arabia based on their last recorded travel event.              Possible values include: - IN: most recent travel event was an entry into Saudi Arabia. - OUT: most recent travel event was an exit from Saudi Arabia.
+    attr_accessor :in_out_indicator
+
+    # Registered Saudi national addresses.              Saudi Post (SPL) documents how to enter a national address on checkout and international forms: Line 1 is building number, unit number, and street name. Line 2 is the additional number and district. Then city and postal code. The country is always Saudi Arabia.              https://splonline.com.sa/en/door-step/
+    attr_accessor :national_addresses
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'arabic_first_name' => :'arabicFirstName',
+        :'arabic_second_name' => :'arabicSecondName',
+        :'arabic_third_name' => :'arabicThirdName',
+        :'arabic_last_name' => :'arabicLastName',
+        :'romanized_first_name' => :'romanizedFirstName',
+        :'romanized_second_name' => :'romanizedSecondName',
+        :'romanized_third_name' => :'romanizedThirdName',
+        :'romanized_last_name' => :'romanizedLastName',
+        :'nationality_description' => :'nationalityDescription',
+        :'date_of_birth_hijri' => :'dateOfBirthHijri',
+        :'iqama_issue_date_gregorian' => :'iqamaIssueDateGregorian',
+        :'iqama_issue_date_hijri' => :'iqamaIssueDateHijri',
+        :'iqama_expiry_date_gregorian' => :'iqamaExpiryDateGregorian',
+        :'iqama_expiry_date_hijri' => :'iqamaExpiryDateHijri',
+        :'iqama_version_number' => :'iqamaVersionNumber',
+        :'iqama_issue_place' => :'iqamaIssuePlace',
+        :'iqama_issue_place_code' => :'iqamaIssuePlaceCode',
+        :'occupation_description' => :'occupationDescription',
+        :'social_status_code' => :'socialStatusCode',
+        :'social_status' => :'socialStatus',
+        :'place_of_birth' => :'placeOfBirth',
+        :'place_of_birth_code' => :'placeOfBirthCode',
+        :'sponsor_name' => :'sponsorName',
+        :'legal_status' => :'legalStatus',
+        :'in_out_indicator' => :'inOutIndicator',
+        :'national_addresses' => :'nationalAddresses'
+      }
+    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
+      {
+        :'arabic_first_name' => :'String',
+        :'arabic_second_name' => :'String',
+        :'arabic_third_name' => :'String',
+        :'arabic_last_name' => :'String',
+        :'romanized_first_name' => :'String',
+        :'romanized_second_name' => :'String',
+        :'romanized_third_name' => :'String',
+        :'romanized_last_name' => :'String',
+        :'nationality_description' => :'String',
+        :'date_of_birth_hijri' => :'String',
+        :'iqama_issue_date_gregorian' => :'Date',
+        :'iqama_issue_date_hijri' => :'String',
+        :'iqama_expiry_date_gregorian' => :'Date',
+        :'iqama_expiry_date_hijri' => :'String',
+        :'iqama_version_number' => :'String',
+        :'iqama_issue_place' => :'String',
+        :'iqama_issue_place_code' => :'String',
+        :'occupation_description' => :'String',
+        :'social_status_code' => :'String',
+        :'social_status' => :'String',
+        :'place_of_birth' => :'String',
+        :'place_of_birth_code' => :'String',
+        :'sponsor_name' => :'String',
+        :'legal_status' => :'String',
+        :'in_out_indicator' => :'String',
+        :'national_addresses' => :'Array<SaudiArabiaNafathAddress>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'arabic_first_name',
+        :'arabic_second_name',
+        :'arabic_third_name',
+        :'arabic_last_name',
+        :'romanized_first_name',
+        :'romanized_second_name',
+        :'romanized_third_name',
+        :'romanized_last_name',
+        :'nationality_description',
+        :'date_of_birth_hijri',
+        :'iqama_issue_date_gregorian',
+        :'iqama_issue_date_hijri',
+        :'iqama_expiry_date_gregorian',
+        :'iqama_expiry_date_hijri',
+        :'iqama_version_number',
+        :'iqama_issue_place',
+        :'iqama_issue_place_code',
+        :'occupation_description',
+        :'social_status_code',
+        :'social_status',
+        :'place_of_birth',
+        :'place_of_birth_code',
+        :'sponsor_name',
+        :'legal_status',
+        :'in_out_indicator',
+        :'national_addresses'
+      ])
+    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::SaudiArabiaNafathResidentAttributes` 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::SaudiArabiaNafathResidentAttributes`. 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?(:'arabic_first_name')
+        self.arabic_first_name = attributes[:'arabic_first_name']
+      end
+
+      if attributes.key?(:'arabic_second_name')
+        self.arabic_second_name = attributes[:'arabic_second_name']
+      end
+
+      if attributes.key?(:'arabic_third_name')
+        self.arabic_third_name = attributes[:'arabic_third_name']
+      end
+
+      if attributes.key?(:'arabic_last_name')
+        self.arabic_last_name = attributes[:'arabic_last_name']
+      end
+
+      if attributes.key?(:'romanized_first_name')
+        self.romanized_first_name = attributes[:'romanized_first_name']
+      end
+
+      if attributes.key?(:'romanized_second_name')
+        self.romanized_second_name = attributes[:'romanized_second_name']
+      end
+
+      if attributes.key?(:'romanized_third_name')
+        self.romanized_third_name = attributes[:'romanized_third_name']
+      end
+
+      if attributes.key?(:'romanized_last_name')
+        self.romanized_last_name = attributes[:'romanized_last_name']
+      end
+
+      if attributes.key?(:'nationality_description')
+        self.nationality_description = attributes[:'nationality_description']
+      end
+
+      if attributes.key?(:'date_of_birth_hijri')
+        self.date_of_birth_hijri = attributes[:'date_of_birth_hijri']
+      end
+
+      if attributes.key?(:'iqama_issue_date_gregorian')
+        self.iqama_issue_date_gregorian = attributes[:'iqama_issue_date_gregorian']
+      end
+
+      if attributes.key?(:'iqama_issue_date_hijri')
+        self.iqama_issue_date_hijri = attributes[:'iqama_issue_date_hijri']
+      end
+
+      if attributes.key?(:'iqama_expiry_date_gregorian')
+        self.iqama_expiry_date_gregorian = attributes[:'iqama_expiry_date_gregorian']
+      end
+
+      if attributes.key?(:'iqama_expiry_date_hijri')
+        self.iqama_expiry_date_hijri = attributes[:'iqama_expiry_date_hijri']
+      end
+
+      if attributes.key?(:'iqama_version_number')
+        self.iqama_version_number = attributes[:'iqama_version_number']
+      end
+
+      if attributes.key?(:'iqama_issue_place')
+        self.iqama_issue_place = attributes[:'iqama_issue_place']
+      end
+
+      if attributes.key?(:'iqama_issue_place_code')
+        self.iqama_issue_place_code = attributes[:'iqama_issue_place_code']
+      end
+
+      if attributes.key?(:'occupation_description')
+        self.occupation_description = attributes[:'occupation_description']
+      end
+
+      if attributes.key?(:'social_status_code')
+        self.social_status_code = attributes[:'social_status_code']
+      end
+
+      if attributes.key?(:'social_status')
+        self.social_status = attributes[:'social_status']
+      end
+
+      if attributes.key?(:'place_of_birth')
+        self.place_of_birth = attributes[:'place_of_birth']
+      end
+
+      if attributes.key?(:'place_of_birth_code')
+        self.place_of_birth_code = attributes[:'place_of_birth_code']
+      end
+
+      if attributes.key?(:'sponsor_name')
+        self.sponsor_name = attributes[:'sponsor_name']
+      end
+
+      if attributes.key?(:'legal_status')
+        self.legal_status = attributes[:'legal_status']
+      end
+
+      if attributes.key?(:'in_out_indicator')
+        self.in_out_indicator = attributes[:'in_out_indicator']
+      end
+
+      if attributes.key?(:'national_addresses')
+        if (value = attributes[:'national_addresses']).is_a?(Array)
+          self.national_addresses = value
+        end
+      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 &&
+          arabic_first_name == o.arabic_first_name &&
+          arabic_second_name == o.arabic_second_name &&
+          arabic_third_name == o.arabic_third_name &&
+          arabic_last_name == o.arabic_last_name &&
+          romanized_first_name == o.romanized_first_name &&
+          romanized_second_name == o.romanized_second_name &&
+          romanized_third_name == o.romanized_third_name &&
+          romanized_last_name == o.romanized_last_name &&
+          nationality_description == o.nationality_description &&
+          date_of_birth_hijri == o.date_of_birth_hijri &&
+          iqama_issue_date_gregorian == o.iqama_issue_date_gregorian &&
+          iqama_issue_date_hijri == o.iqama_issue_date_hijri &&
+          iqama_expiry_date_gregorian == o.iqama_expiry_date_gregorian &&
+          iqama_expiry_date_hijri == o.iqama_expiry_date_hijri &&
+          iqama_version_number == o.iqama_version_number &&
+          iqama_issue_place == o.iqama_issue_place &&
+          iqama_issue_place_code == o.iqama_issue_place_code &&
+          occupation_description == o.occupation_description &&
+          social_status_code == o.social_status_code &&
+          social_status == o.social_status &&
+          place_of_birth == o.place_of_birth &&
+          place_of_birth_code == o.place_of_birth_code &&
+          sponsor_name == o.sponsor_name &&
+          legal_status == o.legal_status &&
+          in_out_indicator == o.in_out_indicator &&
+          national_addresses == o.national_addresses
+    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
+      [arabic_first_name, arabic_second_name, arabic_third_name, arabic_last_name, romanized_first_name, romanized_second_name, romanized_third_name, romanized_last_name, nationality_description, date_of_birth_hijri, iqama_issue_date_gregorian, iqama_issue_date_hijri, iqama_expiry_date_gregorian, iqama_expiry_date_hijri, iqama_version_number, iqama_issue_place, iqama_issue_place_code, occupation_description, social_status_code, social_status, place_of_birth, place_of_birth_code, sponsor_name, legal_status, in_out_indicator, national_addresses].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