doorflow 1.0.0

data/lib/doorflow-api/models/person.rb

@@ -0,0 +1,511 @@
+=begin
+#DoorFlow API
+
+#Access control and door management API for DoorFlow
+
+The version of the OpenAPI document: 3.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.18.0-SNAPSHOT
+
+=end
+
+require 'date'
+require 'time'
+
+module DoorFlow
+  class Person < ApiModelBase
+    # Unique identifier for the person
+    attr_accessor :id
+
+    # First name (required)
+    attr_accessor :first_name
+
+    # Last name (required)
+    attr_accessor :last_name
+
+    # Salutation or title (Mr., Ms., Dr., etc.)
+    attr_accessor :salutation
+
+    # Job title
+    attr_accessor :job_title
+
+    # Email address (must be unique within account if provided)
+    attr_accessor :email
+
+    # Organisation ID
+    attr_accessor :organisation_id
+
+    # External system identifier
+    attr_accessor :system_id
+
+    # Department name
+    attr_accessor :department
+
+    # Whether the person is currently enabled for access
+    attr_accessor :enabled
+
+    # Access valid from this date/time
+    attr_accessor :valid_from
+
+    # Access valid until this date/time
+    attr_accessor :valid_to
+
+    # URL to person's full-size photo
+    attr_accessor :image_url
+
+    # URL to person's thumbnail photo
+    attr_accessor :image_thumbnail_url
+
+    # Telephone number
+    attr_accessor :telephone
+
+    # Mobile number (E.164 format required if passport enabled)
+    attr_accessor :mobile
+
+    # Additional notes
+    attr_accessor :notes
+
+    # Barcode identifier
+    attr_accessor :barcode
+
+    # Custom field 1
+    attr_accessor :custom_1
+
+    # Custom field 2
+    attr_accessor :custom_2
+
+    # Custom field 3
+    attr_accessor :custom_3
+
+    # Custom field 4
+    attr_accessor :custom_4
+
+    # Custom field 5
+    attr_accessor :custom_5
+
+    # Timestamp of creation
+    attr_accessor :created_at
+
+    # Timestamp of last update
+    attr_accessor :updated_at
+
+    # Array of group IDs this person belongs to
+    attr_accessor :groups
+
+    # Array of role IDs assigned to this person
+    attr_accessor :roles
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'first_name' => :'first_name',
+        :'last_name' => :'last_name',
+        :'salutation' => :'salutation',
+        :'job_title' => :'job_title',
+        :'email' => :'email',
+        :'organisation_id' => :'organisation_id',
+        :'system_id' => :'system_id',
+        :'department' => :'department',
+        :'enabled' => :'enabled',
+        :'valid_from' => :'valid_from',
+        :'valid_to' => :'valid_to',
+        :'image_url' => :'image_url',
+        :'image_thumbnail_url' => :'image_thumbnail_url',
+        :'telephone' => :'telephone',
+        :'mobile' => :'mobile',
+        :'notes' => :'notes',
+        :'barcode' => :'barcode',
+        :'custom_1' => :'custom_1',
+        :'custom_2' => :'custom_2',
+        :'custom_3' => :'custom_3',
+        :'custom_4' => :'custom_4',
+        :'custom_5' => :'custom_5',
+        :'created_at' => :'created_at',
+        :'updated_at' => :'updated_at',
+        :'groups' => :'groups',
+        :'roles' => :'roles'
+      }
+    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
+      {
+        :'id' => :'Integer',
+        :'first_name' => :'String',
+        :'last_name' => :'String',
+        :'salutation' => :'String',
+        :'job_title' => :'String',
+        :'email' => :'String',
+        :'organisation_id' => :'Integer',
+        :'system_id' => :'String',
+        :'department' => :'String',
+        :'enabled' => :'Boolean',
+        :'valid_from' => :'Time',
+        :'valid_to' => :'Time',
+        :'image_url' => :'String',
+        :'image_thumbnail_url' => :'String',
+        :'telephone' => :'String',
+        :'mobile' => :'String',
+        :'notes' => :'String',
+        :'barcode' => :'String',
+        :'custom_1' => :'String',
+        :'custom_2' => :'String',
+        :'custom_3' => :'String',
+        :'custom_4' => :'String',
+        :'custom_5' => :'String',
+        :'created_at' => :'Time',
+        :'updated_at' => :'Time',
+        :'groups' => :'Array<Integer>',
+        :'roles' => :'Array<Integer>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'salutation',
+        :'job_title',
+        :'email',
+        :'organisation_id',
+        :'system_id',
+        :'department',
+        :'valid_from',
+        :'valid_to',
+        :'image_url',
+        :'image_thumbnail_url',
+        :'telephone',
+        :'mobile',
+        :'notes',
+        :'barcode',
+        :'custom_1',
+        :'custom_2',
+        :'custom_3',
+        :'custom_4',
+        :'custom_5',
+      ])
+    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 `DoorFlow::Person` 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 `DoorFlow::Person`. 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?(:'id')
+        self.id = attributes[:'id']
+      else
+        self.id = nil
+      end
+
+      if attributes.key?(:'first_name')
+        self.first_name = attributes[:'first_name']
+      else
+        self.first_name = nil
+      end
+
+      if attributes.key?(:'last_name')
+        self.last_name = attributes[:'last_name']
+      else
+        self.last_name = nil
+      end
+
+      if attributes.key?(:'salutation')
+        self.salutation = attributes[:'salutation']
+      end
+
+      if attributes.key?(:'job_title')
+        self.job_title = attributes[:'job_title']
+      end
+
+      if attributes.key?(:'email')
+        self.email = attributes[:'email']
+      end
+
+      if attributes.key?(:'organisation_id')
+        self.organisation_id = attributes[:'organisation_id']
+      end
+
+      if attributes.key?(:'system_id')
+        self.system_id = attributes[:'system_id']
+      end
+
+      if attributes.key?(:'department')
+        self.department = attributes[:'department']
+      end
+
+      if attributes.key?(:'enabled')
+        self.enabled = attributes[:'enabled']
+      else
+        self.enabled = nil
+      end
+
+      if attributes.key?(:'valid_from')
+        self.valid_from = attributes[:'valid_from']
+      end
+
+      if attributes.key?(:'valid_to')
+        self.valid_to = attributes[:'valid_to']
+      end
+
+      if attributes.key?(:'image_url')
+        self.image_url = attributes[:'image_url']
+      end
+
+      if attributes.key?(:'image_thumbnail_url')
+        self.image_thumbnail_url = attributes[:'image_thumbnail_url']
+      end
+
+      if attributes.key?(:'telephone')
+        self.telephone = attributes[:'telephone']
+      end
+
+      if attributes.key?(:'mobile')
+        self.mobile = attributes[:'mobile']
+      end
+
+      if attributes.key?(:'notes')
+        self.notes = attributes[:'notes']
+      end
+
+      if attributes.key?(:'barcode')
+        self.barcode = attributes[:'barcode']
+      end
+
+      if attributes.key?(:'custom_1')
+        self.custom_1 = attributes[:'custom_1']
+      end
+
+      if attributes.key?(:'custom_2')
+        self.custom_2 = attributes[:'custom_2']
+      end
+
+      if attributes.key?(:'custom_3')
+        self.custom_3 = attributes[:'custom_3']
+      end
+
+      if attributes.key?(:'custom_4')
+        self.custom_4 = attributes[:'custom_4']
+      end
+
+      if attributes.key?(:'custom_5')
+        self.custom_5 = attributes[:'custom_5']
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      end
+
+      if attributes.key?(:'updated_at')
+        self.updated_at = attributes[:'updated_at']
+      end
+
+      if attributes.key?(:'groups')
+        if (value = attributes[:'groups']).is_a?(Array)
+          self.groups = value
+        end
+      else
+        self.groups = nil
+      end
+
+      if attributes.key?(:'roles')
+        if (value = attributes[:'roles']).is_a?(Array)
+          self.roles = value
+        end
+      else
+        self.roles = nil
+      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 @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @first_name.nil?
+        invalid_properties.push('invalid value for "first_name", first_name cannot be nil.')
+      end
+
+      if @last_name.nil?
+        invalid_properties.push('invalid value for "last_name", last_name cannot be nil.')
+      end
+
+      # enabled, groups, and roles can be nil in API responses
+      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 @id.nil?
+      return false if @first_name.nil?
+      return false if @last_name.nil?
+      # enabled, groups, and roles can be nil
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] id Value to be assigned
+    def id=(id)
+      if id.nil?
+        fail ArgumentError, 'id cannot be nil'
+      end
+
+      @id = id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] first_name Value to be assigned
+    def first_name=(first_name)
+      if first_name.nil?
+        fail ArgumentError, 'first_name cannot be nil'
+      end
+
+      @first_name = first_name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] last_name Value to be assigned
+    def last_name=(last_name)
+      if last_name.nil?
+        fail ArgumentError, 'last_name cannot be nil'
+      end
+
+      @last_name = last_name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] enabled Value to be assigned
+    def enabled=(enabled)
+      # Allow nil - API may return people without enabled field set
+      @enabled = enabled
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] groups Value to be assigned
+    def groups=(groups)
+      # Allow nil - API may return people without groups
+      @groups = groups || []
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] roles Value to be assigned
+    def roles=(roles)
+      # Allow nil - API may return people without roles
+      @roles = roles || []
+    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 &&
+          id == o.id &&
+          first_name == o.first_name &&
+          last_name == o.last_name &&
+          salutation == o.salutation &&
+          job_title == o.job_title &&
+          email == o.email &&
+          organisation_id == o.organisation_id &&
+          system_id == o.system_id &&
+          department == o.department &&
+          enabled == o.enabled &&
+          valid_from == o.valid_from &&
+          valid_to == o.valid_to &&
+          image_url == o.image_url &&
+          image_thumbnail_url == o.image_thumbnail_url &&
+          telephone == o.telephone &&
+          mobile == o.mobile &&
+          notes == o.notes &&
+          barcode == o.barcode &&
+          custom_1 == o.custom_1 &&
+          custom_2 == o.custom_2 &&
+          custom_3 == o.custom_3 &&
+          custom_4 == o.custom_4 &&
+          custom_5 == o.custom_5 &&
+          created_at == o.created_at &&
+          updated_at == o.updated_at &&
+          groups == o.groups &&
+          roles == o.roles
+    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
+      [id, first_name, last_name, salutation, job_title, email, organisation_id, system_id, department, enabled, valid_from, valid_to, image_url, image_thumbnail_url, telephone, mobile, notes, barcode, custom_1, custom_2, custom_3, custom_4, custom_5, created_at, updated_at, groups, roles].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