doorflow 1.0.0

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

@@ -0,0 +1,498 @@
+=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 Channel < ApiModelBase
+    # Unique identifier for the channel
+    attr_accessor :id
+
+    # Name of the channel/door controller
+    attr_accessor :name
+
+    # MAC address of the controller (format aa:bb:cc:dd:ee:ff)
+    attr_accessor :mac_address
+
+    # Current connection status of the channel
+    attr_accessor :status
+
+    # Unit number for multi-channel controllers
+    attr_accessor :unit
+
+    # Controller model number
+    attr_accessor :model
+
+    # Full descriptive model name
+    attr_accessor :model_long
+
+    # Serial number of the controller
+    attr_accessor :serial_number
+
+    # Card format configuration
+    attr_accessor :card_format
+
+    # PIN format configuration
+    attr_accessor :pin_format
+
+    # Freescale firmware version
+    attr_accessor :freescale_version
+
+    # PIC firmware version
+    attr_accessor :pic_version
+
+    # Reader device class identifier
+    attr_accessor :reader_device_class_name
+
+    # ID of the site this channel belongs to
+    attr_accessor :site_id
+
+    # Timestamp of last update
+    attr_accessor :updated_at
+
+    # Timestamp of creation
+    attr_accessor :created_at
+
+    attr_accessor :sync
+
+    attr_accessor :lockdown
+
+    attr_accessor :mode
+
+    attr_accessor :auto_unlock
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'name' => :'name',
+        :'mac_address' => :'mac_address',
+        :'status' => :'status',
+        :'unit' => :'unit',
+        :'model' => :'model',
+        :'model_long' => :'model_long',
+        :'serial_number' => :'serial_number',
+        :'card_format' => :'card_format',
+        :'pin_format' => :'pin_format',
+        :'freescale_version' => :'freescale_version',
+        :'pic_version' => :'pic_version',
+        :'reader_device_class_name' => :'reader_device_class_name',
+        :'site_id' => :'site_id',
+        :'updated_at' => :'updated_at',
+        :'created_at' => :'created_at',
+        :'sync' => :'sync',
+        :'lockdown' => :'lockdown',
+        :'mode' => :'mode',
+        :'auto_unlock' => :'auto_unlock'
+      }
+    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',
+        :'name' => :'String',
+        :'mac_address' => :'String',
+        :'status' => :'String',
+        :'unit' => :'Integer',
+        :'model' => :'String',
+        :'model_long' => :'String',
+        :'serial_number' => :'String',
+        :'card_format' => :'String',
+        :'pin_format' => :'String',
+        :'freescale_version' => :'String',
+        :'pic_version' => :'String',
+        :'reader_device_class_name' => :'String',
+        :'site_id' => :'Integer',
+        :'updated_at' => :'Time',
+        :'created_at' => :'Time',
+        :'sync' => :'ChannelSync',
+        :'lockdown' => :'ChannelLockdown',
+        :'mode' => :'ChannelMode',
+        :'auto_unlock' => :'ChannelAutoUnlock'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'model',
+        :'serial_number',
+        :'card_format',
+        :'pin_format',
+        :'freescale_version',
+        :'pic_version',
+        :'reader_device_class_name',
+        :'site_id',
+        :'lockdown',
+        :'auto_unlock'
+      ])
+    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::Channel` 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::Channel`. 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?(:'name')
+        self.name = attributes[:'name']
+      else
+        self.name = nil
+      end
+
+      if attributes.key?(:'mac_address')
+        self.mac_address = attributes[:'mac_address']
+      else
+        self.mac_address = nil
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      else
+        self.status = nil
+      end
+
+      if attributes.key?(:'unit')
+        self.unit = attributes[:'unit']
+      else
+        self.unit = nil
+      end
+
+      if attributes.key?(:'model')
+        self.model = attributes[:'model']
+      end
+
+      if attributes.key?(:'model_long')
+        self.model_long = attributes[:'model_long']
+      end
+
+      if attributes.key?(:'serial_number')
+        self.serial_number = attributes[:'serial_number']
+      end
+
+      if attributes.key?(:'card_format')
+        self.card_format = attributes[:'card_format']
+      end
+
+      if attributes.key?(:'pin_format')
+        self.pin_format = attributes[:'pin_format']
+      end
+
+      if attributes.key?(:'freescale_version')
+        self.freescale_version = attributes[:'freescale_version']
+      end
+
+      if attributes.key?(:'pic_version')
+        self.pic_version = attributes[:'pic_version']
+      end
+
+      if attributes.key?(:'reader_device_class_name')
+        self.reader_device_class_name = attributes[:'reader_device_class_name']
+      end
+
+      if attributes.key?(:'site_id')
+        self.site_id = attributes[:'site_id']
+      end
+
+      if attributes.key?(:'updated_at')
+        self.updated_at = attributes[:'updated_at']
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      end
+
+      if attributes.key?(:'sync')
+        self.sync = attributes[:'sync']
+      else
+        self.sync = nil
+      end
+
+      if attributes.key?(:'lockdown')
+        self.lockdown = attributes[:'lockdown']
+      end
+
+      if attributes.key?(:'mode')
+        self.mode = attributes[:'mode']
+      else
+        self.mode = nil
+      end
+
+      if attributes.key?(:'auto_unlock')
+        self.auto_unlock = attributes[:'auto_unlock']
+      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 @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @mac_address.nil?
+        invalid_properties.push('invalid value for "mac_address", mac_address cannot be nil.')
+      end
+
+      pattern = Regexp.new(/^([0-9a-fA-F]{2}:){5}[0-9a-fA-F]{2}$/)
+      if @mac_address !~ pattern
+        invalid_properties.push("invalid value for \"mac_address\", must conform to the pattern #{pattern}.")
+      end
+
+      if @status.nil?
+        invalid_properties.push('invalid value for "status", status cannot be nil.')
+      end
+
+      if @unit.nil?
+        invalid_properties.push('invalid value for "unit", unit cannot be nil.')
+      end
+
+      if @sync.nil?
+        invalid_properties.push('invalid value for "sync", sync cannot be nil.')
+      end
+
+      if @mode.nil?
+        invalid_properties.push('invalid value for "mode", mode cannot be nil.')
+      end
+
+      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 @name.nil?
+      return false if @mac_address.nil?
+      return false if @mac_address !~ Regexp.new(/^([0-9a-fA-F]{2}:){5}[0-9a-fA-F]{2}$/)
+      return false if @status.nil?
+      status_validator = EnumAttributeValidator.new('String', ["online", "offline", "pending_encryption"])
+      return false unless status_validator.valid?(@status)
+      return false if @unit.nil?
+      return false if @sync.nil?
+      return false if @mode.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] name Value to be assigned
+    def name=(name)
+      if name.nil?
+        fail ArgumentError, 'name cannot be nil'
+      end
+
+      @name = name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] mac_address Value to be assigned
+    def mac_address=(mac_address)
+      if mac_address.nil?
+        fail ArgumentError, 'mac_address cannot be nil'
+      end
+
+      pattern = Regexp.new(/^([0-9a-fA-F]{2}:){5}[0-9a-fA-F]{2}$/)
+      if mac_address !~ pattern
+        fail ArgumentError, "invalid value for \"mac_address\", must conform to the pattern #{pattern}."
+      end
+
+      @mac_address = mac_address
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] status Object to be assigned
+    def status=(status)
+      validator = EnumAttributeValidator.new('String', ["online", "offline", "pending_encryption"])
+      unless validator.valid?(status)
+        fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
+      end
+      @status = status
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] unit Value to be assigned
+    def unit=(unit)
+      if unit.nil?
+        fail ArgumentError, 'unit cannot be nil'
+      end
+
+      @unit = unit
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] sync Value to be assigned
+    def sync=(sync)
+      if sync.nil?
+        fail ArgumentError, 'sync cannot be nil'
+      end
+
+      @sync = sync
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] mode Value to be assigned
+    def mode=(mode)
+      if mode.nil?
+        fail ArgumentError, 'mode cannot be nil'
+      end
+
+      @mode = mode
+    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 &&
+          name == o.name &&
+          mac_address == o.mac_address &&
+          status == o.status &&
+          unit == o.unit &&
+          model == o.model &&
+          model_long == o.model_long &&
+          serial_number == o.serial_number &&
+          card_format == o.card_format &&
+          pin_format == o.pin_format &&
+          freescale_version == o.freescale_version &&
+          pic_version == o.pic_version &&
+          reader_device_class_name == o.reader_device_class_name &&
+          site_id == o.site_id &&
+          updated_at == o.updated_at &&
+          created_at == o.created_at &&
+          sync == o.sync &&
+          lockdown == o.lockdown &&
+          mode == o.mode &&
+          auto_unlock == o.auto_unlock
+    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, name, mac_address, status, unit, model, model_long, serial_number, card_format, pin_format, freescale_version, pic_version, reader_device_class_name, site_id, updated_at, created_at, sync, lockdown, mode, auto_unlock].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/doorflow-api/models/channel_auto_unlock.rb

@@ -0,0 +1,159 @@
+=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
+  # Auto-unlock shift configuration (null if not configured)
+  class ChannelAutoUnlock < ApiModelBase
+    # Shift ID
+    attr_accessor :id
+
+    # Shift name
+    attr_accessor :name
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'name' => :'name'
+      }
+    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',
+        :'name' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    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::ChannelAutoUnlock` 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::ChannelAutoUnlock`. 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']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'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 &&
+          id == o.id &&
+          name == o.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
+      [id, 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