doorflow 1.0.0 → 1.1.0

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

@@ -0,0 +1,347 @@
+=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.24.0
+
+=end
+
+require 'date'
+require 'time'
+
+module DoorFlow
+  class CardTemplateInputCardTemplate < ApiModelBase
+    # Client-generated UUID (required for creation)
+    attr_accessor :uuid
+
+    # Template display name (required for creation)
+    attr_accessor :name
+
+    # ID of the template type. Prefer template_type_code for portability across environments
+    attr_accessor :template_type_id
+
+    # Code of the template type (e.g. ISO_CARD_STANDARD). Resolved server-side; takes precedence over template_type_id if both are given
+    attr_accessor :template_type_code
+
+    attr_accessor :card_type
+
+    attr_accessor :double_sided
+
+    attr_accessor :orientation_front
+
+    attr_accessor :orientation_back
+
+    attr_accessor :default_template
+
+    # Free-form JSONB objects representing layout elements. Replaces the entire array on update
+    attr_accessor :template_objects
+
+    # Who can edit this template
+    attr_accessor :editable_by
+
+    # Reassign ownership. Allowed for the current owner or any admin in the account. The new owner must be an admin in the same account. Ignored on create (owner is set server-side from the authenticated user). 
+    attr_accessor :owner_id
+
+    # Soft-delete timestamp. PATCH only. Setting a non-null value soft-deletes the template; setting null restores it. The deleted_by_id field is set server-side. For permanent deletion, use DELETE /card_templates/{id}. 
+    attr_accessor :deleted_at
+
+    # Idempotency key for this change request
+    attr_accessor :change_request_id
+
+    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
+      {
+        :'uuid' => :'uuid',
+        :'name' => :'name',
+        :'template_type_id' => :'template_type_id',
+        :'template_type_code' => :'template_type_code',
+        :'card_type' => :'card_type',
+        :'double_sided' => :'double_sided',
+        :'orientation_front' => :'orientation_front',
+        :'orientation_back' => :'orientation_back',
+        :'default_template' => :'default_template',
+        :'template_objects' => :'template_objects',
+        :'editable_by' => :'editable_by',
+        :'owner_id' => :'owner_id',
+        :'deleted_at' => :'deleted_at',
+        :'change_request_id' => :'change_request_id'
+      }
+    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
+      {
+        :'uuid' => :'String',
+        :'name' => :'String',
+        :'template_type_id' => :'Integer',
+        :'template_type_code' => :'String',
+        :'card_type' => :'String',
+        :'double_sided' => :'Boolean',
+        :'orientation_front' => :'String',
+        :'orientation_back' => :'String',
+        :'default_template' => :'Boolean',
+        :'template_objects' => :'Array<Object>',
+        :'editable_by' => :'String',
+        :'owner_id' => :'Integer',
+        :'deleted_at' => :'Time',
+        :'change_request_id' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'owner_id',
+        :'deleted_at',
+      ])
+    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::CardTemplateInputCardTemplate` 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::CardTemplateInputCardTemplate`. 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?(:'uuid')
+        self.uuid = attributes[:'uuid']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'template_type_id')
+        self.template_type_id = attributes[:'template_type_id']
+      end
+
+      if attributes.key?(:'template_type_code')
+        self.template_type_code = attributes[:'template_type_code']
+      end
+
+      if attributes.key?(:'card_type')
+        self.card_type = attributes[:'card_type']
+      end
+
+      if attributes.key?(:'double_sided')
+        self.double_sided = attributes[:'double_sided']
+      end
+
+      if attributes.key?(:'orientation_front')
+        self.orientation_front = attributes[:'orientation_front']
+      end
+
+      if attributes.key?(:'orientation_back')
+        self.orientation_back = attributes[:'orientation_back']
+      end
+
+      if attributes.key?(:'default_template')
+        self.default_template = attributes[:'default_template']
+      end
+
+      if attributes.key?(:'template_objects')
+        if (value = attributes[:'template_objects']).is_a?(Array)
+          self.template_objects = value
+        end
+      end
+
+      if attributes.key?(:'editable_by')
+        self.editable_by = attributes[:'editable_by']
+      end
+
+      if attributes.key?(:'owner_id')
+        self.owner_id = attributes[:'owner_id']
+      end
+
+      if attributes.key?(:'deleted_at')
+        self.deleted_at = attributes[:'deleted_at']
+      end
+
+      if attributes.key?(:'change_request_id')
+        self.change_request_id = attributes[:'change_request_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'
+      card_type_validator = EnumAttributeValidator.new('String', ["standard", "signature_stripe"])
+      return false unless card_type_validator.valid?(@card_type)
+      orientation_front_validator = EnumAttributeValidator.new('String', ["P", "L"])
+      return false unless orientation_front_validator.valid?(@orientation_front)
+      orientation_back_validator = EnumAttributeValidator.new('String', ["P", "L"])
+      return false unless orientation_back_validator.valid?(@orientation_back)
+      editable_by_validator = EnumAttributeValidator.new('String', ["owner_only", "any_admin"])
+      return false unless editable_by_validator.valid?(@editable_by)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] card_type Object to be assigned
+    def card_type=(card_type)
+      validator = EnumAttributeValidator.new('String', ["standard", "signature_stripe"])
+      unless validator.valid?(card_type)
+        fail ArgumentError, "invalid value for \"card_type\", must be one of #{validator.allowable_values}."
+      end
+      @card_type = card_type
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] orientation_front Object to be assigned
+    def orientation_front=(orientation_front)
+      validator = EnumAttributeValidator.new('String', ["P", "L"])
+      unless validator.valid?(orientation_front)
+        fail ArgumentError, "invalid value for \"orientation_front\", must be one of #{validator.allowable_values}."
+      end
+      @orientation_front = orientation_front
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] orientation_back Object to be assigned
+    def orientation_back=(orientation_back)
+      validator = EnumAttributeValidator.new('String', ["P", "L"])
+      unless validator.valid?(orientation_back)
+        fail ArgumentError, "invalid value for \"orientation_back\", must be one of #{validator.allowable_values}."
+      end
+      @orientation_back = orientation_back
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] editable_by Object to be assigned
+    def editable_by=(editable_by)
+      validator = EnumAttributeValidator.new('String', ["owner_only", "any_admin"])
+      unless validator.valid?(editable_by)
+        fail ArgumentError, "invalid value for \"editable_by\", must be one of #{validator.allowable_values}."
+      end
+      @editable_by = editable_by
+    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 &&
+          uuid == o.uuid &&
+          name == o.name &&
+          template_type_id == o.template_type_id &&
+          template_type_code == o.template_type_code &&
+          card_type == o.card_type &&
+          double_sided == o.double_sided &&
+          orientation_front == o.orientation_front &&
+          orientation_back == o.orientation_back &&
+          default_template == o.default_template &&
+          template_objects == o.template_objects &&
+          editable_by == o.editable_by &&
+          owner_id == o.owner_id &&
+          deleted_at == o.deleted_at &&
+          change_request_id == o.change_request_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
+      [uuid, name, template_type_id, template_type_code, card_type, double_sided, orientation_front, orientation_back, default_template, template_objects, editable_by, owner_id, deleted_at, change_request_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

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

@@ -0,0 +1,321 @@
+=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.24.0
+
+=end
+
+require 'date'
+require 'time'
+
+module DoorFlow
+  class CardTemplateType < ApiModelBase
+    # Unique identifier for this type
+    attr_accessor :code
+
+    # Display name
+    attr_accessor :name
+
+    # Physical page size category
+    attr_accessor :page_size
+
+    # Physical width in millimetres
+    attr_accessor :width_mm
+
+    # Physical height in millimetres
+    attr_accessor :height_mm
+
+    # Default orientation: P = Portrait, L = Landscape
+    attr_accessor :orientation_default
+
+    # URL to a preview image, or null if not set
+    attr_accessor :preview_image_url
+
+    # Non-printable zone definitions
+    attr_accessor :non_printable_zones
+
+    # When the record was created
+    attr_accessor :created_at
+
+    # When the record was last updated
+    attr_accessor :updated_at
+
+    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
+      {
+        :'code' => :'code',
+        :'name' => :'name',
+        :'page_size' => :'page_size',
+        :'width_mm' => :'width_mm',
+        :'height_mm' => :'height_mm',
+        :'orientation_default' => :'orientation_default',
+        :'preview_image_url' => :'preview_image_url',
+        :'non_printable_zones' => :'non_printable_zones',
+        :'created_at' => :'created_at',
+        :'updated_at' => :'updated_at'
+      }
+    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
+      {
+        :'code' => :'String',
+        :'name' => :'String',
+        :'page_size' => :'String',
+        :'width_mm' => :'Float',
+        :'height_mm' => :'Float',
+        :'orientation_default' => :'String',
+        :'preview_image_url' => :'String',
+        :'non_printable_zones' => :'Array<CardTemplateTypeNonPrintableZonesInner>',
+        :'created_at' => :'Time',
+        :'updated_at' => :'Time'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'preview_image_url',
+      ])
+    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::CardTemplateType` 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::CardTemplateType`. 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?(:'code')
+        self.code = attributes[:'code']
+      else
+        self.code = nil
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      else
+        self.name = nil
+      end
+
+      if attributes.key?(:'page_size')
+        self.page_size = attributes[:'page_size']
+      end
+
+      if attributes.key?(:'width_mm')
+        self.width_mm = attributes[:'width_mm']
+      end
+
+      if attributes.key?(:'height_mm')
+        self.height_mm = attributes[:'height_mm']
+      end
+
+      if attributes.key?(:'orientation_default')
+        self.orientation_default = attributes[:'orientation_default']
+      end
+
+      if attributes.key?(:'preview_image_url')
+        self.preview_image_url = attributes[:'preview_image_url']
+      end
+
+      if attributes.key?(:'non_printable_zones')
+        if (value = attributes[:'non_printable_zones']).is_a?(Array)
+          self.non_printable_zones = value
+        end
+      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
+    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 @code.nil?
+        invalid_properties.push('invalid value for "code", code cannot be nil.')
+      end
+
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name 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 @code.nil?
+      return false if @name.nil?
+      page_size_validator = EnumAttributeValidator.new('String', ["ISO_CARD", "A4", "A5", "LETTER"])
+      return false unless page_size_validator.valid?(@page_size)
+      orientation_default_validator = EnumAttributeValidator.new('String', ["P", "L"])
+      return false unless orientation_default_validator.valid?(@orientation_default)
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] code Value to be assigned
+    def code=(code)
+      if code.nil?
+        fail ArgumentError, 'code cannot be nil'
+      end
+
+      @code = code
+    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 checking allowed values (enum).
+    # @param [Object] page_size Object to be assigned
+    def page_size=(page_size)
+      validator = EnumAttributeValidator.new('String', ["ISO_CARD", "A4", "A5", "LETTER"])
+      unless validator.valid?(page_size)
+        fail ArgumentError, "invalid value for \"page_size\", must be one of #{validator.allowable_values}."
+      end
+      @page_size = page_size
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] orientation_default Object to be assigned
+    def orientation_default=(orientation_default)
+      validator = EnumAttributeValidator.new('String', ["P", "L"])
+      unless validator.valid?(orientation_default)
+        fail ArgumentError, "invalid value for \"orientation_default\", must be one of #{validator.allowable_values}."
+      end
+      @orientation_default = orientation_default
+    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 &&
+          code == o.code &&
+          name == o.name &&
+          page_size == o.page_size &&
+          width_mm == o.width_mm &&
+          height_mm == o.height_mm &&
+          orientation_default == o.orientation_default &&
+          preview_image_url == o.preview_image_url &&
+          non_printable_zones == o.non_printable_zones &&
+          created_at == o.created_at &&
+          updated_at == o.updated_at
+    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
+      [code, name, page_size, width_mm, height_mm, orientation_default, preview_image_url, non_printable_zones, created_at, updated_at].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