trinsic_api 3.2.1 → 3.3.0.pre.alpha2

data/lib/trinsic_api/models/saudi_arabia_nafath_citizen_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 SaudiArabiaNafathCitizenAttributes < 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
+
+    # Father's given name in Arabic. Same script as arabicFirstName.
+    attr_accessor :arabic_father_name
+
+    # Grandfather's given name in Arabic. Same script as arabicFirstName.
+    attr_accessor :arabic_grand_father_name
+
+    # Family name in Arabic. Same script as arabicFirstName.
+    attr_accessor :arabic_family_name
+
+    # Given name in English.              Nafath always returns this in English, including when the session locale is Arabic.
+    attr_accessor :romanized_first_name
+
+    # Father's given name in English. Same script as romanizedFirstName.
+    attr_accessor :romanized_second_name
+
+    # Grandfather's given name in English. Same script as romanizedFirstName.
+    attr_accessor :romanized_third_name
+
+    # Family name in English. Same script as romanizedFirstName.
+    attr_accessor :romanized_last_name
+
+    # Date of birth in the Hijri (Umm al-Qura) calendar, in YYYY-MM-DD format.
+    attr_accessor :date_of_birth_hijri
+
+    # Date the national ID card was issued in the Gregorian calendar.
+    attr_accessor :id_issue_date_gregorian
+
+    # Date the national ID card was issued in the Hijri calendar, in YYYY-MM-DD format.
+    attr_accessor :id_issue_date_hijri
+
+    # Date the national ID card expires in the Gregorian calendar.
+    attr_accessor :id_expiry_date_gregorian
+
+    # Date the national ID card expires in the Hijri calendar, in YYYY-MM-DD format.
+    attr_accessor :id_expiry_date_hijri
+
+    # Version number printed on the national ID card.              Represents the generation of national ID card this document was issued in.
+    attr_accessor :id_version_number
+
+    # City or office where the national ID card was issued, in Arabic.              The session locale does not change it.
+    attr_accessor :id_issue_place
+
+    # 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 description in Arabic, from the Nafath socialStatusDesc attribute.              The session locale does not change it. socialStatusCode is the separate numeric code.
+    attr_accessor :social_status
+
+    # Number of current dependents.
+    attr_accessor :dependent_count
+
+    # Place of birth in Arabic.              The session locale does not change it.
+    attr_accessor :place_of_birth
+
+    # Most recent travel exit date in the Gregorian calendar.
+    attr_accessor :last_travel_exit_date_gregorian
+
+    # Most recent travel exit date in the Hijri calendar, in YYYY-MM-DD format.
+    attr_accessor :last_travel_exit_date_hijri
+
+    # Most recent travel entry date in the Gregorian calendar.
+    attr_accessor :last_travel_entry_date_gregorian
+
+    # Most recent travel entry date in the Hijri calendar, in YYYY-MM-DD format.
+    attr_accessor :last_travel_entry_date_hijri
+
+    # True when the citizen is a minor.
+    attr_accessor :is_minor
+
+    # Head of household information, intended for minor citizen workflows such as guardian consent for opening a bank account.              The sandbox also returns it for adults, so it is included whenever present.
+    attr_accessor :head_of_household
+
+    # Registered Saudi national addresses, as structured fields.              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 because Nafath only ever returns Saudi national addresses.              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_father_name' => :'arabicFatherName',
+        :'arabic_grand_father_name' => :'arabicGrandFatherName',
+        :'arabic_family_name' => :'arabicFamilyName',
+        :'romanized_first_name' => :'romanizedFirstName',
+        :'romanized_second_name' => :'romanizedSecondName',
+        :'romanized_third_name' => :'romanizedThirdName',
+        :'romanized_last_name' => :'romanizedLastName',
+        :'date_of_birth_hijri' => :'dateOfBirthHijri',
+        :'id_issue_date_gregorian' => :'idIssueDateGregorian',
+        :'id_issue_date_hijri' => :'idIssueDateHijri',
+        :'id_expiry_date_gregorian' => :'idExpiryDateGregorian',
+        :'id_expiry_date_hijri' => :'idExpiryDateHijri',
+        :'id_version_number' => :'idVersionNumber',
+        :'id_issue_place' => :'idIssuePlace',
+        :'social_status_code' => :'socialStatusCode',
+        :'social_status' => :'socialStatus',
+        :'dependent_count' => :'dependentCount',
+        :'place_of_birth' => :'placeOfBirth',
+        :'last_travel_exit_date_gregorian' => :'lastTravelExitDateGregorian',
+        :'last_travel_exit_date_hijri' => :'lastTravelExitDateHijri',
+        :'last_travel_entry_date_gregorian' => :'lastTravelEntryDateGregorian',
+        :'last_travel_entry_date_hijri' => :'lastTravelEntryDateHijri',
+        :'is_minor' => :'isMinor',
+        :'head_of_household' => :'headOfHousehold',
+        :'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_father_name' => :'String',
+        :'arabic_grand_father_name' => :'String',
+        :'arabic_family_name' => :'String',
+        :'romanized_first_name' => :'String',
+        :'romanized_second_name' => :'String',
+        :'romanized_third_name' => :'String',
+        :'romanized_last_name' => :'String',
+        :'date_of_birth_hijri' => :'String',
+        :'id_issue_date_gregorian' => :'Date',
+        :'id_issue_date_hijri' => :'String',
+        :'id_expiry_date_gregorian' => :'Date',
+        :'id_expiry_date_hijri' => :'String',
+        :'id_version_number' => :'String',
+        :'id_issue_place' => :'String',
+        :'social_status_code' => :'String',
+        :'social_status' => :'String',
+        :'dependent_count' => :'Integer',
+        :'place_of_birth' => :'String',
+        :'last_travel_exit_date_gregorian' => :'Date',
+        :'last_travel_exit_date_hijri' => :'String',
+        :'last_travel_entry_date_gregorian' => :'Date',
+        :'last_travel_entry_date_hijri' => :'String',
+        :'is_minor' => :'Boolean',
+        :'head_of_household' => :'SaudiArabiaNafathHeadOfHousehold',
+        :'national_addresses' => :'Array<SaudiArabiaNafathAddress>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'arabic_first_name',
+        :'arabic_father_name',
+        :'arabic_grand_father_name',
+        :'arabic_family_name',
+        :'romanized_first_name',
+        :'romanized_second_name',
+        :'romanized_third_name',
+        :'romanized_last_name',
+        :'date_of_birth_hijri',
+        :'id_issue_date_gregorian',
+        :'id_issue_date_hijri',
+        :'id_expiry_date_gregorian',
+        :'id_expiry_date_hijri',
+        :'id_version_number',
+        :'id_issue_place',
+        :'social_status_code',
+        :'social_status',
+        :'dependent_count',
+        :'place_of_birth',
+        :'last_travel_exit_date_gregorian',
+        :'last_travel_exit_date_hijri',
+        :'last_travel_entry_date_gregorian',
+        :'last_travel_entry_date_hijri',
+        :'is_minor',
+        :'head_of_household',
+        :'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::SaudiArabiaNafathCitizenAttributes` 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::SaudiArabiaNafathCitizenAttributes`. 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_father_name')
+        self.arabic_father_name = attributes[:'arabic_father_name']
+      end
+
+      if attributes.key?(:'arabic_grand_father_name')
+        self.arabic_grand_father_name = attributes[:'arabic_grand_father_name']
+      end
+
+      if attributes.key?(:'arabic_family_name')
+        self.arabic_family_name = attributes[:'arabic_family_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?(:'date_of_birth_hijri')
+        self.date_of_birth_hijri = attributes[:'date_of_birth_hijri']
+      end
+
+      if attributes.key?(:'id_issue_date_gregorian')
+        self.id_issue_date_gregorian = attributes[:'id_issue_date_gregorian']
+      end
+
+      if attributes.key?(:'id_issue_date_hijri')
+        self.id_issue_date_hijri = attributes[:'id_issue_date_hijri']
+      end
+
+      if attributes.key?(:'id_expiry_date_gregorian')
+        self.id_expiry_date_gregorian = attributes[:'id_expiry_date_gregorian']
+      end
+
+      if attributes.key?(:'id_expiry_date_hijri')
+        self.id_expiry_date_hijri = attributes[:'id_expiry_date_hijri']
+      end
+
+      if attributes.key?(:'id_version_number')
+        self.id_version_number = attributes[:'id_version_number']
+      end
+
+      if attributes.key?(:'id_issue_place')
+        self.id_issue_place = attributes[:'id_issue_place']
+      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?(:'dependent_count')
+        self.dependent_count = attributes[:'dependent_count']
+      end
+
+      if attributes.key?(:'place_of_birth')
+        self.place_of_birth = attributes[:'place_of_birth']
+      end
+
+      if attributes.key?(:'last_travel_exit_date_gregorian')
+        self.last_travel_exit_date_gregorian = attributes[:'last_travel_exit_date_gregorian']
+      end
+
+      if attributes.key?(:'last_travel_exit_date_hijri')
+        self.last_travel_exit_date_hijri = attributes[:'last_travel_exit_date_hijri']
+      end
+
+      if attributes.key?(:'last_travel_entry_date_gregorian')
+        self.last_travel_entry_date_gregorian = attributes[:'last_travel_entry_date_gregorian']
+      end
+
+      if attributes.key?(:'last_travel_entry_date_hijri')
+        self.last_travel_entry_date_hijri = attributes[:'last_travel_entry_date_hijri']
+      end
+
+      if attributes.key?(:'is_minor')
+        self.is_minor = attributes[:'is_minor']
+      end
+
+      if attributes.key?(:'head_of_household')
+        self.head_of_household = attributes[:'head_of_household']
+      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_father_name == o.arabic_father_name &&
+          arabic_grand_father_name == o.arabic_grand_father_name &&
+          arabic_family_name == o.arabic_family_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 &&
+          date_of_birth_hijri == o.date_of_birth_hijri &&
+          id_issue_date_gregorian == o.id_issue_date_gregorian &&
+          id_issue_date_hijri == o.id_issue_date_hijri &&
+          id_expiry_date_gregorian == o.id_expiry_date_gregorian &&
+          id_expiry_date_hijri == o.id_expiry_date_hijri &&
+          id_version_number == o.id_version_number &&
+          id_issue_place == o.id_issue_place &&
+          social_status_code == o.social_status_code &&
+          social_status == o.social_status &&
+          dependent_count == o.dependent_count &&
+          place_of_birth == o.place_of_birth &&
+          last_travel_exit_date_gregorian == o.last_travel_exit_date_gregorian &&
+          last_travel_exit_date_hijri == o.last_travel_exit_date_hijri &&
+          last_travel_entry_date_gregorian == o.last_travel_entry_date_gregorian &&
+          last_travel_entry_date_hijri == o.last_travel_entry_date_hijri &&
+          is_minor == o.is_minor &&
+          head_of_household == o.head_of_household &&
+          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_father_name, arabic_grand_father_name, arabic_family_name, romanized_first_name, romanized_second_name, romanized_third_name, romanized_last_name, date_of_birth_hijri, id_issue_date_gregorian, id_issue_date_hijri, id_expiry_date_gregorian, id_expiry_date_hijri, id_version_number, id_issue_place, social_status_code, social_status, dependent_count, place_of_birth, last_travel_exit_date_gregorian, last_travel_exit_date_hijri, last_travel_entry_date_gregorian, last_travel_entry_date_hijri, is_minor, head_of_household, 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

data/lib/trinsic_api/models/saudi_arabia_nafath_head_of_household.rb

@@ -0,0 +1,193 @@
+=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 SaudiArabiaNafathHeadOfHousehold < ApiModelBase
+    # Head of household national identity number.
+    attr_accessor :national_identity_number
+
+    # Head of household given name in Arabic.
+    attr_accessor :arabic_first_name
+
+    # Head of household father name in Arabic.
+    attr_accessor :arabic_father_name
+
+    # Head of household grandfather name in Arabic.
+    attr_accessor :arabic_grand_father_name
+
+    # Head of household family name in Arabic.
+    attr_accessor :arabic_family_name
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'national_identity_number' => :'nationalIdentityNumber',
+        :'arabic_first_name' => :'arabicFirstName',
+        :'arabic_father_name' => :'arabicFatherName',
+        :'arabic_grand_father_name' => :'arabicGrandFatherName',
+        :'arabic_family_name' => :'arabicFamilyName'
+      }
+    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',
+        :'arabic_first_name' => :'String',
+        :'arabic_father_name' => :'String',
+        :'arabic_grand_father_name' => :'String',
+        :'arabic_family_name' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'national_identity_number',
+        :'arabic_first_name',
+        :'arabic_father_name',
+        :'arabic_grand_father_name',
+        :'arabic_family_name'
+      ])
+    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::SaudiArabiaNafathHeadOfHousehold` 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::SaudiArabiaNafathHeadOfHousehold`. 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?(:'arabic_first_name')
+        self.arabic_first_name = attributes[:'arabic_first_name']
+      end
+
+      if attributes.key?(:'arabic_father_name')
+        self.arabic_father_name = attributes[:'arabic_father_name']
+      end
+
+      if attributes.key?(:'arabic_grand_father_name')
+        self.arabic_grand_father_name = attributes[:'arabic_grand_father_name']
+      end
+
+      if attributes.key?(:'arabic_family_name')
+        self.arabic_family_name = attributes[:'arabic_family_name']
+      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 &&
+          arabic_first_name == o.arabic_first_name &&
+          arabic_father_name == o.arabic_father_name &&
+          arabic_grand_father_name == o.arabic_grand_father_name &&
+          arabic_family_name == o.arabic_family_name
+    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, arabic_first_name, arabic_father_name, arabic_grand_father_name, arabic_family_name].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