doorflow 1.0.0 → 1.1.0

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

@@ -0,0 +1,475 @@
+=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 CardTemplate < ApiModelBase
+    # Server-assigned identifier
+    attr_accessor :id
+
+    # Client-generated UUID (RFC 4122)
+    attr_accessor :uuid
+
+    # Template display name, unique per account
+    attr_accessor :name
+
+    # References a template type code
+    attr_accessor :template_type_code
+
+    # Card finish/format
+    attr_accessor :card_type
+
+    # Whether the card has a reverse side
+    attr_accessor :double_sided
+
+    # P = Portrait, L = Landscape
+    attr_accessor :orientation_front
+
+    # P = Portrait, L = Landscape
+    attr_accessor :orientation_back
+
+    # Whether this is the account default template
+    attr_accessor :default_template
+
+    # URL to the front background image, or null if not set
+    attr_accessor :background_image_front_url
+
+    # URL to the back background image, or null if not set
+    attr_accessor :background_image_back_url
+
+    # Free-form JSONB objects representing layout elements on this template
+    attr_accessor :template_objects
+
+    # ID of the user who owns this template, or null if unowned. Set server-side on create. May be reassigned via PATCH by the current owner or by any admin in the account; the new value must be the ID of an admin in the same account. 
+    attr_accessor :owner_id
+
+    # Who can edit this template
+    attr_accessor :editable_by
+
+    # Soft-delete timestamp. Null for live templates. Writable via PATCH: sending a non-null value soft-deletes the template; sending null restores it. Soft-deleted templates are excluded from index by default (see include_deleted). 
+    attr_accessor :deleted_at
+
+    # ID of the user who soft-deleted this template, set server-side from the authenticated user when deleted_at is written. Cleared when deleted_at is cleared. 
+    attr_accessor :deleted_by_id
+
+    # Files linked to this template (images, fonts, etc.)
+    attr_accessor :linked_files
+
+    # ISO 8601 UTC timestamp.
+    attr_accessor :created_at
+
+    # ISO 8601 UTC timestamp.
+    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
+      {
+        :'id' => :'id',
+        :'uuid' => :'uuid',
+        :'name' => :'name',
+        :'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',
+        :'background_image_front_url' => :'background_image_front_url',
+        :'background_image_back_url' => :'background_image_back_url',
+        :'template_objects' => :'template_objects',
+        :'owner_id' => :'owner_id',
+        :'editable_by' => :'editable_by',
+        :'deleted_at' => :'deleted_at',
+        :'deleted_by_id' => :'deleted_by_id',
+        :'linked_files' => :'linked_files',
+        :'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
+      {
+        :'id' => :'Integer',
+        :'uuid' => :'String',
+        :'name' => :'String',
+        :'template_type_code' => :'String',
+        :'card_type' => :'String',
+        :'double_sided' => :'Boolean',
+        :'orientation_front' => :'String',
+        :'orientation_back' => :'String',
+        :'default_template' => :'Boolean',
+        :'background_image_front_url' => :'String',
+        :'background_image_back_url' => :'String',
+        :'template_objects' => :'Array<Object>',
+        :'owner_id' => :'Integer',
+        :'editable_by' => :'String',
+        :'deleted_at' => :'Time',
+        :'deleted_by_id' => :'Integer',
+        :'linked_files' => :'Array<LinkedFile>',
+        :'created_at' => :'Time',
+        :'updated_at' => :'Time'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'background_image_front_url',
+        :'background_image_back_url',
+        :'owner_id',
+        :'deleted_at',
+        :'deleted_by_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 `DoorFlow::CardTemplate` 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::CardTemplate`. 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?(:'uuid')
+        self.uuid = attributes[:'uuid']
+      else
+        self.uuid = nil
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      else
+        self.name = nil
+      end
+
+      if attributes.key?(:'template_type_code')
+        self.template_type_code = attributes[:'template_type_code']
+      else
+        self.template_type_code = nil
+      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?(:'background_image_front_url')
+        self.background_image_front_url = attributes[:'background_image_front_url']
+      end
+
+      if attributes.key?(:'background_image_back_url')
+        self.background_image_back_url = attributes[:'background_image_back_url']
+      end
+
+      if attributes.key?(:'template_objects')
+        if (value = attributes[:'template_objects']).is_a?(Array)
+          self.template_objects = value
+        end
+      end
+
+      if attributes.key?(:'owner_id')
+        self.owner_id = attributes[:'owner_id']
+      end
+
+      if attributes.key?(:'editable_by')
+        self.editable_by = attributes[:'editable_by']
+      end
+
+      if attributes.key?(:'deleted_at')
+        self.deleted_at = attributes[:'deleted_at']
+      end
+
+      if attributes.key?(:'deleted_by_id')
+        self.deleted_by_id = attributes[:'deleted_by_id']
+      end
+
+      if attributes.key?(:'linked_files')
+        if (value = attributes[:'linked_files']).is_a?(Array)
+          self.linked_files = 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 @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @uuid.nil?
+        invalid_properties.push('invalid value for "uuid", uuid cannot be nil.')
+      end
+
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @template_type_code.nil?
+        invalid_properties.push('invalid value for "template_type_code", template_type_code 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 @uuid.nil?
+      return false if @name.nil?
+      return false if @template_type_code.nil?
+      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 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] uuid Value to be assigned
+    def uuid=(uuid)
+      if uuid.nil?
+        fail ArgumentError, 'uuid cannot be nil'
+      end
+
+      @uuid = uuid
+    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] template_type_code Value to be assigned
+    def template_type_code=(template_type_code)
+      if template_type_code.nil?
+        fail ArgumentError, 'template_type_code cannot be nil'
+      end
+
+      @template_type_code = template_type_code
+    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 &&
+          id == o.id &&
+          uuid == o.uuid &&
+          name == o.name &&
+          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 &&
+          background_image_front_url == o.background_image_front_url &&
+          background_image_back_url == o.background_image_back_url &&
+          template_objects == o.template_objects &&
+          owner_id == o.owner_id &&
+          editable_by == o.editable_by &&
+          deleted_at == o.deleted_at &&
+          deleted_by_id == o.deleted_by_id &&
+          linked_files == o.linked_files &&
+          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
+      [id, uuid, name, template_type_code, card_type, double_sided, orientation_front, orientation_back, default_template, background_image_front_url, background_image_back_url, template_objects, owner_id, editable_by, deleted_at, deleted_by_id, linked_files, 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

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

@@ -0,0 +1,147 @@
+=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 CardTemplateInput < ApiModelBase
+    attr_accessor :card_template
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'card_template' => :'card_template'
+      }
+    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
+      {
+        :'card_template' => :'CardTemplateInputCardTemplate'
+      }
+    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::CardTemplateInput` 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::CardTemplateInput`. 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?(:'card_template')
+        self.card_template = attributes[:'card_template']
+      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 &&
+          card_template == o.card_template
+    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
+      [card_template].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