api-sdk-rb 1.11.66 → 1.11.133

data/lib/api-sdk-rb/models/workflow.rb

@@ -0,0 +1,509 @@
+=begin
+#Widgetic API Gateway
+
+#API documentation for the Widgetic API Gateway
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.9.0
+
+=end
+
+require 'date'
+require 'time'
+
+module ApiSdkRb
+  # A workflow as the list shows it (without its graph).
+  class Workflow
+    attr_accessor :id
+
+    attr_accessor :name
+
+    # The customer of a partner (a managed user) this workflow was made for, or null when it is its workspace's own. A customer's editor session lists and opens only the workflows filed under that customer; the partner's own account sees every customer's and tells them apart by this. It is set when the workflow is made and never changes. 
+    attr_accessor :managed_user_id
+
+    attr_accessor :status
+
+    # Rises by one with every save. A save, a publish, a discard and a restore each name the revision they started from.
+    attr_accessor :revision
+
+    # Whether the draft differs from the live version.
+    attr_accessor :unpublished_changes
+
+    attr_accessor :composition_ids
+
+    attr_accessor :block_count
+
+    # The zone date and time triggers are read in (stored as UTC).
+    attr_accessor :timezone
+
+    # Visitors who started the workflow, over its whole life.
+    attr_accessor :runs_count
+
+    attr_accessor :live_version_id
+
+    attr_accessor :created_at
+
+    attr_accessor :updated_at
+
+    attr_accessor :first_published_at
+
+    attr_accessor :last_published_at
+
+    attr_accessor :paused_at
+
+    attr_accessor :archived_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',
+        :'name' => :'name',
+        :'managed_user_id' => :'managedUserId',
+        :'status' => :'status',
+        :'revision' => :'revision',
+        :'unpublished_changes' => :'unpublishedChanges',
+        :'composition_ids' => :'compositionIds',
+        :'block_count' => :'blockCount',
+        :'timezone' => :'timezone',
+        :'runs_count' => :'runsCount',
+        :'live_version_id' => :'liveVersionId',
+        :'created_at' => :'createdAt',
+        :'updated_at' => :'updatedAt',
+        :'first_published_at' => :'firstPublishedAt',
+        :'last_published_at' => :'lastPublishedAt',
+        :'paused_at' => :'pausedAt',
+        :'archived_at' => :'archivedAt'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'id' => :'String',
+        :'name' => :'String',
+        :'managed_user_id' => :'String',
+        :'status' => :'WorkflowStatus',
+        :'revision' => :'Integer',
+        :'unpublished_changes' => :'Boolean',
+        :'composition_ids' => :'Array<String>',
+        :'block_count' => :'Integer',
+        :'timezone' => :'String',
+        :'runs_count' => :'Integer',
+        :'live_version_id' => :'String',
+        :'created_at' => :'Time',
+        :'updated_at' => :'Time',
+        :'first_published_at' => :'Time',
+        :'last_published_at' => :'Time',
+        :'paused_at' => :'Time',
+        :'archived_at' => :'Time'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'managed_user_id',
+        :'live_version_id',
+        :'first_published_at',
+        :'last_published_at',
+        :'paused_at',
+        :'archived_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 `ApiSdkRb::Workflow` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `ApiSdkRb::Workflow`. Please check the name to make sure it's valid. List of attributes: " + self.class.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?(:'managed_user_id')
+        self.managed_user_id = attributes[:'managed_user_id']
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      else
+        self.status = nil
+      end
+
+      if attributes.key?(:'revision')
+        self.revision = attributes[:'revision']
+      else
+        self.revision = nil
+      end
+
+      if attributes.key?(:'unpublished_changes')
+        self.unpublished_changes = attributes[:'unpublished_changes']
+      else
+        self.unpublished_changes = nil
+      end
+
+      if attributes.key?(:'composition_ids')
+        if (value = attributes[:'composition_ids']).is_a?(Array)
+          self.composition_ids = value
+        end
+      else
+        self.composition_ids = nil
+      end
+
+      if attributes.key?(:'block_count')
+        self.block_count = attributes[:'block_count']
+      else
+        self.block_count = nil
+      end
+
+      if attributes.key?(:'timezone')
+        self.timezone = attributes[:'timezone']
+      else
+        self.timezone = nil
+      end
+
+      if attributes.key?(:'runs_count')
+        self.runs_count = attributes[:'runs_count']
+      else
+        self.runs_count = nil
+      end
+
+      if attributes.key?(:'live_version_id')
+        self.live_version_id = attributes[:'live_version_id']
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      else
+        self.created_at = nil
+      end
+
+      if attributes.key?(:'updated_at')
+        self.updated_at = attributes[:'updated_at']
+      else
+        self.updated_at = nil
+      end
+
+      if attributes.key?(:'first_published_at')
+        self.first_published_at = attributes[:'first_published_at']
+      end
+
+      if attributes.key?(:'last_published_at')
+        self.last_published_at = attributes[:'last_published_at']
+      end
+
+      if attributes.key?(:'paused_at')
+        self.paused_at = attributes[:'paused_at']
+      end
+
+      if attributes.key?(:'archived_at')
+        self.archived_at = attributes[:'archived_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 @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @name.to_s.length > 120
+        invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 120.')
+      end
+
+      if @status.nil?
+        invalid_properties.push('invalid value for "status", status cannot be nil.')
+      end
+
+      if @revision.nil?
+        invalid_properties.push('invalid value for "revision", revision cannot be nil.')
+      end
+
+      if @revision < 1
+        invalid_properties.push('invalid value for "revision", must be greater than or equal to 1.')
+      end
+
+      if @unpublished_changes.nil?
+        invalid_properties.push('invalid value for "unpublished_changes", unpublished_changes cannot be nil.')
+      end
+
+      if @composition_ids.nil?
+        invalid_properties.push('invalid value for "composition_ids", composition_ids cannot be nil.')
+      end
+
+      if @block_count.nil?
+        invalid_properties.push('invalid value for "block_count", block_count cannot be nil.')
+      end
+
+      if @timezone.nil?
+        invalid_properties.push('invalid value for "timezone", timezone cannot be nil.')
+      end
+
+      if @runs_count.nil?
+        invalid_properties.push('invalid value for "runs_count", runs_count cannot be nil.')
+      end
+
+      if @created_at.nil?
+        invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
+      end
+
+      if @updated_at.nil?
+        invalid_properties.push('invalid value for "updated_at", updated_at 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 @name.to_s.length > 120
+      return false if @status.nil?
+      return false if @revision.nil?
+      return false if @revision < 1
+      return false if @unpublished_changes.nil?
+      return false if @composition_ids.nil?
+      return false if @block_count.nil?
+      return false if @timezone.nil?
+      return false if @runs_count.nil?
+      return false if @created_at.nil?
+      return false if @updated_at.nil?
+      true
+    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
+
+      if name.to_s.length > 120
+        fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 120.'
+      end
+
+      @name = name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] revision Value to be assigned
+    def revision=(revision)
+      if revision.nil?
+        fail ArgumentError, 'revision cannot be nil'
+      end
+
+      if revision < 1
+        fail ArgumentError, 'invalid value for "revision", must be greater than or equal to 1.'
+      end
+
+      @revision = revision
+    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 &&
+          managed_user_id == o.managed_user_id &&
+          status == o.status &&
+          revision == o.revision &&
+          unpublished_changes == o.unpublished_changes &&
+          composition_ids == o.composition_ids &&
+          block_count == o.block_count &&
+          timezone == o.timezone &&
+          runs_count == o.runs_count &&
+          live_version_id == o.live_version_id &&
+          created_at == o.created_at &&
+          updated_at == o.updated_at &&
+          first_published_at == o.first_published_at &&
+          last_published_at == o.last_published_at &&
+          paused_at == o.paused_at &&
+          archived_at == o.archived_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, name, managed_user_id, status, revision, unpublished_changes, composition_ids, block_count, timezone, runs_count, live_version_id, created_at, updated_at, first_published_at, last_published_at, paused_at, archived_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
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = ApiSdkRb.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_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
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end