trinsic_api 3.2.1 → 3.3.0.pre.alpha2

data/lib/trinsic_api/models/saudi_arabia_nafath_address.rb

@@ -0,0 +1,325 @@
+=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 SaudiArabiaNafathAddress < ApiModelBase
+    # Building number.
+    attr_accessor :building_number
+
+    # Street name in the session locale.              Arabic when the session locale is ar, and English when it is en. streetSecondary is the other language.
+    attr_accessor :street
+
+    # District or neighborhood in the session locale.              Arabic when the session locale is ar, and English when it is en. districtSecondary is the other language.
+    attr_accessor :district
+
+    # City in the session locale.              Arabic when the session locale is ar, and English when it is en. citySecondary is the other language.
+    attr_accessor :city
+
+    # Postal code.
+    attr_accessor :postal_code
+
+    # Additional number, used alongside the district to locate buildings within the Saudi addressing system.
+    attr_accessor :additional_number
+
+    # Apartment or unit number.
+    attr_accessor :unit_number
+
+    # Geographic coordinates of the registered address.              Format: Two space-separated decimal numbers, longitude then latitude.
+    attr_accessor :location_coordinates
+
+    # Whether this address is the individual's primary registered address.
+    attr_accessor :is_primary_address
+
+    # Region name in the session locale.              Arabic when the session locale is ar, and English when it is en. regionNameSecondary is the other language.
+    attr_accessor :region_name
+
+    # Region name in the other language from regionName.              English when the session locale is ar, and Arabic when it is en.
+    attr_accessor :region_name_secondary
+
+    # City name in the other language from city.              English when the session locale is ar, and Arabic when it is en.
+    attr_accessor :city_secondary
+
+    # Street name in the other language from street.              English when the session locale is ar, and Arabic when it is en.
+    attr_accessor :street_secondary
+
+    # District name in the other language from district.              English when the session locale is ar, and Arabic when it is en.
+    attr_accessor :district_secondary
+
+    # City identifier.
+    attr_accessor :city_id
+
+    # Region identifier.
+    attr_accessor :region_id
+
+    # District identifier.
+    attr_accessor :district_id
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'building_number' => :'buildingNumber',
+        :'street' => :'street',
+        :'district' => :'district',
+        :'city' => :'city',
+        :'postal_code' => :'postalCode',
+        :'additional_number' => :'additionalNumber',
+        :'unit_number' => :'unitNumber',
+        :'location_coordinates' => :'locationCoordinates',
+        :'is_primary_address' => :'isPrimaryAddress',
+        :'region_name' => :'regionName',
+        :'region_name_secondary' => :'regionNameSecondary',
+        :'city_secondary' => :'citySecondary',
+        :'street_secondary' => :'streetSecondary',
+        :'district_secondary' => :'districtSecondary',
+        :'city_id' => :'cityId',
+        :'region_id' => :'regionId',
+        :'district_id' => :'districtId'
+      }
+    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
+      {
+        :'building_number' => :'String',
+        :'street' => :'String',
+        :'district' => :'String',
+        :'city' => :'String',
+        :'postal_code' => :'String',
+        :'additional_number' => :'String',
+        :'unit_number' => :'String',
+        :'location_coordinates' => :'String',
+        :'is_primary_address' => :'Boolean',
+        :'region_name' => :'String',
+        :'region_name_secondary' => :'String',
+        :'city_secondary' => :'String',
+        :'street_secondary' => :'String',
+        :'district_secondary' => :'String',
+        :'city_id' => :'String',
+        :'region_id' => :'String',
+        :'district_id' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'building_number',
+        :'street',
+        :'district',
+        :'city',
+        :'postal_code',
+        :'additional_number',
+        :'unit_number',
+        :'location_coordinates',
+        :'is_primary_address',
+        :'region_name',
+        :'region_name_secondary',
+        :'city_secondary',
+        :'street_secondary',
+        :'district_secondary',
+        :'city_id',
+        :'region_id',
+        :'district_id'
+      ])
+    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::SaudiArabiaNafathAddress` 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::SaudiArabiaNafathAddress`. 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?(:'building_number')
+        self.building_number = attributes[:'building_number']
+      end
+
+      if attributes.key?(:'street')
+        self.street = attributes[:'street']
+      end
+
+      if attributes.key?(:'district')
+        self.district = attributes[:'district']
+      end
+
+      if attributes.key?(:'city')
+        self.city = attributes[:'city']
+      end
+
+      if attributes.key?(:'postal_code')
+        self.postal_code = attributes[:'postal_code']
+      end
+
+      if attributes.key?(:'additional_number')
+        self.additional_number = attributes[:'additional_number']
+      end
+
+      if attributes.key?(:'unit_number')
+        self.unit_number = attributes[:'unit_number']
+      end
+
+      if attributes.key?(:'location_coordinates')
+        self.location_coordinates = attributes[:'location_coordinates']
+      end
+
+      if attributes.key?(:'is_primary_address')
+        self.is_primary_address = attributes[:'is_primary_address']
+      end
+
+      if attributes.key?(:'region_name')
+        self.region_name = attributes[:'region_name']
+      end
+
+      if attributes.key?(:'region_name_secondary')
+        self.region_name_secondary = attributes[:'region_name_secondary']
+      end
+
+      if attributes.key?(:'city_secondary')
+        self.city_secondary = attributes[:'city_secondary']
+      end
+
+      if attributes.key?(:'street_secondary')
+        self.street_secondary = attributes[:'street_secondary']
+      end
+
+      if attributes.key?(:'district_secondary')
+        self.district_secondary = attributes[:'district_secondary']
+      end
+
+      if attributes.key?(:'city_id')
+        self.city_id = attributes[:'city_id']
+      end
+
+      if attributes.key?(:'region_id')
+        self.region_id = attributes[:'region_id']
+      end
+
+      if attributes.key?(:'district_id')
+        self.district_id = attributes[:'district_id']
+      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 &&
+          building_number == o.building_number &&
+          street == o.street &&
+          district == o.district &&
+          city == o.city &&
+          postal_code == o.postal_code &&
+          additional_number == o.additional_number &&
+          unit_number == o.unit_number &&
+          location_coordinates == o.location_coordinates &&
+          is_primary_address == o.is_primary_address &&
+          region_name == o.region_name &&
+          region_name_secondary == o.region_name_secondary &&
+          city_secondary == o.city_secondary &&
+          street_secondary == o.street_secondary &&
+          district_secondary == o.district_secondary &&
+          city_id == o.city_id &&
+          region_id == o.region_id &&
+          district_id == o.district_id
+    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
+      [building_number, street, district, city, postal_code, additional_number, unit_number, location_coordinates, is_primary_address, region_name, region_name_secondary, city_secondary, street_secondary, district_secondary, city_id, region_id, district_id].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