doorflow 1.0.0

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

@@ -0,0 +1,413 @@
+=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 PersonInput < ApiModelBase
+    # First name (required for creation)
+    attr_accessor :first_name
+
+    # Last name (required for creation)
+    attr_accessor :last_name
+
+    # Salutation or title
+    attr_accessor :salutation
+
+    # Job title
+    attr_accessor :job_title
+
+    # Email address (must be unique within account if provided)
+    attr_accessor :email
+
+    # Department name
+    attr_accessor :department
+
+    # Whether the person is 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
+
+    # Base64-encoded image data for person's photo
+    attr_accessor :image_base64
+
+    # Remote URL to fetch person's photo from (set to empty string to delete image)
+    attr_accessor :image_remote_url
+
+    # Telephone number
+    attr_accessor :telephone
+
+    # Mobile number (E.164 format if passport enabled)
+    attr_accessor :mobile
+
+    # Additional notes
+    attr_accessor :notes
+
+    # Barcode identifier
+    attr_accessor :barcode
+
+    # External system identifier
+    attr_accessor :system_id
+
+    # Organisation ID
+    attr_accessor :organisation_id
+
+    # 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
+
+    # Array of group IDs to assign this person to
+    attr_accessor :group_ids
+
+    # Array of role IDs to assign to this person (requires permission)
+    attr_accessor :role_ids
+
+    # Mark person as deleted (used internally)
+    attr_accessor :deleted
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'first_name' => :'first_name',
+        :'last_name' => :'last_name',
+        :'salutation' => :'salutation',
+        :'job_title' => :'job_title',
+        :'email' => :'email',
+        :'department' => :'department',
+        :'enabled' => :'enabled',
+        :'valid_from' => :'valid_from',
+        :'valid_to' => :'valid_to',
+        :'image_base64' => :'image_base64',
+        :'image_remote_url' => :'image_remote_url',
+        :'telephone' => :'telephone',
+        :'mobile' => :'mobile',
+        :'notes' => :'notes',
+        :'barcode' => :'barcode',
+        :'system_id' => :'system_id',
+        :'organisation_id' => :'organisation_id',
+        :'custom_1' => :'custom_1',
+        :'custom_2' => :'custom_2',
+        :'custom_3' => :'custom_3',
+        :'custom_4' => :'custom_4',
+        :'custom_5' => :'custom_5',
+        :'group_ids' => :'group_ids',
+        :'role_ids' => :'role_ids',
+        :'deleted' => :'deleted'
+      }
+    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
+      {
+        :'first_name' => :'String',
+        :'last_name' => :'String',
+        :'salutation' => :'String',
+        :'job_title' => :'String',
+        :'email' => :'String',
+        :'department' => :'String',
+        :'enabled' => :'Boolean',
+        :'valid_from' => :'Time',
+        :'valid_to' => :'Time',
+        :'image_base64' => :'String',
+        :'image_remote_url' => :'String',
+        :'telephone' => :'String',
+        :'mobile' => :'String',
+        :'notes' => :'String',
+        :'barcode' => :'String',
+        :'system_id' => :'String',
+        :'organisation_id' => :'Integer',
+        :'custom_1' => :'String',
+        :'custom_2' => :'String',
+        :'custom_3' => :'String',
+        :'custom_4' => :'String',
+        :'custom_5' => :'String',
+        :'group_ids' => :'Array<Integer>',
+        :'role_ids' => :'Array<Integer>',
+        :'deleted' => :'Boolean'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'salutation',
+        :'job_title',
+        :'email',
+        :'department',
+        :'valid_from',
+        :'valid_to',
+        :'image_base64',
+        :'image_remote_url',
+        :'telephone',
+        :'mobile',
+        :'notes',
+        :'barcode',
+        :'system_id',
+        :'organisation_id',
+        :'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::PersonInput` 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::PersonInput`. 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?(:'first_name')
+        self.first_name = attributes[:'first_name']
+      end
+
+      if attributes.key?(:'last_name')
+        self.last_name = attributes[:'last_name']
+      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?(:'department')
+        self.department = attributes[:'department']
+      end
+
+      if attributes.key?(:'enabled')
+        self.enabled = attributes[:'enabled']
+      else
+        self.enabled = true
+      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_base64')
+        self.image_base64 = attributes[:'image_base64']
+      end
+
+      if attributes.key?(:'image_remote_url')
+        self.image_remote_url = attributes[:'image_remote_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?(:'system_id')
+        self.system_id = attributes[:'system_id']
+      end
+
+      if attributes.key?(:'organisation_id')
+        self.organisation_id = attributes[:'organisation_id']
+      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?(:'group_ids')
+        if (value = attributes[:'group_ids']).is_a?(Array)
+          self.group_ids = value
+        end
+      end
+
+      if attributes.key?(:'role_ids')
+        if (value = attributes[:'role_ids']).is_a?(Array)
+          self.role_ids = value
+        end
+      end
+
+      if attributes.key?(:'deleted')
+        self.deleted = attributes[:'deleted']
+      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 &&
+          first_name == o.first_name &&
+          last_name == o.last_name &&
+          salutation == o.salutation &&
+          job_title == o.job_title &&
+          email == o.email &&
+          department == o.department &&
+          enabled == o.enabled &&
+          valid_from == o.valid_from &&
+          valid_to == o.valid_to &&
+          image_base64 == o.image_base64 &&
+          image_remote_url == o.image_remote_url &&
+          telephone == o.telephone &&
+          mobile == o.mobile &&
+          notes == o.notes &&
+          barcode == o.barcode &&
+          system_id == o.system_id &&
+          organisation_id == o.organisation_id &&
+          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 &&
+          group_ids == o.group_ids &&
+          role_ids == o.role_ids &&
+          deleted == o.deleted
+    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
+      [first_name, last_name, salutation, job_title, email, department, enabled, valid_from, valid_to, image_base64, image_remote_url, telephone, mobile, notes, barcode, system_id, organisation_id, custom_1, custom_2, custom_3, custom_4, custom_5, group_ids, role_ids, deleted].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