activitysmith 0.1.1

data/generated/activitysmith_openapi/models/content_state_start.rb

@@ -0,0 +1,397 @@
+=begin
+#ActivitySmith API
+
+#Send push notifications and Live Activities to your own devices via a single API key.
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.7.0
+
+=end
+
+require 'date'
+require 'time'
+
+module OpenapiClient
+  # Start payload requires title, number_of_steps, current_step, and type.
+  class ContentStateStart
+    attr_accessor :title
+
+    attr_accessor :subtitle
+
+    attr_accessor :number_of_steps
+
+    attr_accessor :current_step
+
+    attr_accessor :type
+
+    # Optional. Accent color for the Live Activity. Defaults to blue.
+    attr_accessor :color
+
+    # Optional. Overrides color for the current step.
+    attr_accessor :step_color
+
+    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
+      {
+        :'title' => :'title',
+        :'subtitle' => :'subtitle',
+        :'number_of_steps' => :'number_of_steps',
+        :'current_step' => :'current_step',
+        :'type' => :'type',
+        :'color' => :'color',
+        :'step_color' => :'step_color'
+      }
+    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
+      {
+        :'title' => :'String',
+        :'subtitle' => :'String',
+        :'number_of_steps' => :'Integer',
+        :'current_step' => :'Integer',
+        :'type' => :'String',
+        :'color' => :'String',
+        :'step_color' => :'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 `OpenapiClient::ContentStateStart` 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 `OpenapiClient::ContentStateStart`. 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?(:'title')
+        self.title = attributes[:'title']
+      else
+        self.title = nil
+      end
+
+      if attributes.key?(:'subtitle')
+        self.subtitle = attributes[:'subtitle']
+      end
+
+      if attributes.key?(:'number_of_steps')
+        self.number_of_steps = attributes[:'number_of_steps']
+      else
+        self.number_of_steps = nil
+      end
+
+      if attributes.key?(:'current_step')
+        self.current_step = attributes[:'current_step']
+      else
+        self.current_step = nil
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      else
+        self.type = nil
+      end
+
+      if attributes.key?(:'color')
+        self.color = attributes[:'color']
+      else
+        self.color = 'blue'
+      end
+
+      if attributes.key?(:'step_color')
+        self.step_color = attributes[:'step_color']
+      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 @title.nil?
+        invalid_properties.push('invalid value for "title", title cannot be nil.')
+      end
+
+      if @number_of_steps.nil?
+        invalid_properties.push('invalid value for "number_of_steps", number_of_steps cannot be nil.')
+      end
+
+      if @number_of_steps < 1
+        invalid_properties.push('invalid value for "number_of_steps", must be greater than or equal to 1.')
+      end
+
+      if @current_step.nil?
+        invalid_properties.push('invalid value for "current_step", current_step cannot be nil.')
+      end
+
+      if @current_step < 1
+        invalid_properties.push('invalid value for "current_step", must be greater than or equal to 1.')
+      end
+
+      if @type.nil?
+        invalid_properties.push('invalid value for "type", type 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 @title.nil?
+      return false if @number_of_steps.nil?
+      return false if @number_of_steps < 1
+      return false if @current_step.nil?
+      return false if @current_step < 1
+      return false if @type.nil?
+      type_validator = EnumAttributeValidator.new('String', ["segmented_progress"])
+      return false unless type_validator.valid?(@type)
+      color_validator = EnumAttributeValidator.new('String', ["lime", "green", "cyan", "blue", "purple", "magenta", "red", "orange", "yellow"])
+      return false unless color_validator.valid?(@color)
+      step_color_validator = EnumAttributeValidator.new('String', ["lime", "green", "cyan", "blue", "purple", "magenta", "red", "orange", "yellow"])
+      return false unless step_color_validator.valid?(@step_color)
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] number_of_steps Value to be assigned
+    def number_of_steps=(number_of_steps)
+      if number_of_steps.nil?
+        fail ArgumentError, 'number_of_steps cannot be nil'
+      end
+
+      if number_of_steps < 1
+        fail ArgumentError, 'invalid value for "number_of_steps", must be greater than or equal to 1.'
+      end
+
+      @number_of_steps = number_of_steps
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] current_step Value to be assigned
+    def current_step=(current_step)
+      if current_step.nil?
+        fail ArgumentError, 'current_step cannot be nil'
+      end
+
+      if current_step < 1
+        fail ArgumentError, 'invalid value for "current_step", must be greater than or equal to 1.'
+      end
+
+      @current_step = current_step
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] type Object to be assigned
+    def type=(type)
+      validator = EnumAttributeValidator.new('String', ["segmented_progress"])
+      unless validator.valid?(type)
+        fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
+      end
+      @type = type
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] color Object to be assigned
+    def color=(color)
+      validator = EnumAttributeValidator.new('String', ["lime", "green", "cyan", "blue", "purple", "magenta", "red", "orange", "yellow"])
+      unless validator.valid?(color)
+        fail ArgumentError, "invalid value for \"color\", must be one of #{validator.allowable_values}."
+      end
+      @color = color
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] step_color Object to be assigned
+    def step_color=(step_color)
+      validator = EnumAttributeValidator.new('String', ["lime", "green", "cyan", "blue", "purple", "magenta", "red", "orange", "yellow"])
+      unless validator.valid?(step_color)
+        fail ArgumentError, "invalid value for \"step_color\", must be one of #{validator.allowable_values}."
+      end
+      @step_color = step_color
+    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 &&
+          title == o.title &&
+          subtitle == o.subtitle &&
+          number_of_steps == o.number_of_steps &&
+          current_step == o.current_step &&
+          type == o.type &&
+          color == o.color &&
+          step_color == o.step_color
+    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
+      [title, subtitle, number_of_steps, current_step, type, color, step_color].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 = OpenapiClient.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