activitysmith 1.0.0 → 1.1.0

data/generated/activitysmith_openapi/models/activity_metric.rb

@@ -0,0 +1,293 @@
+=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
+  class ActivityMetric
+    attr_accessor :label
+
+    attr_accessor :value
+
+    attr_accessor :unit
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'label' => :'label',
+        :'value' => :'value',
+        :'unit' => :'unit'
+      }
+    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
+      {
+        :'label' => :'String',
+        :'value' => :'Float',
+        :'unit' => :'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::ActivityMetric` 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::ActivityMetric`. 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?(:'label')
+        self.label = attributes[:'label']
+      else
+        self.label = nil
+      end
+
+      if attributes.key?(:'value')
+        self.value = attributes[:'value']
+      else
+        self.value = nil
+      end
+
+      if attributes.key?(:'unit')
+        self.unit = attributes[:'unit']
+      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 @label.nil?
+        invalid_properties.push('invalid value for "label", label cannot be nil.')
+      end
+
+      if @label.to_s.length < 1
+        invalid_properties.push('invalid value for "label", the character length must be great than or equal to 1.')
+      end
+
+      if @value.nil?
+        invalid_properties.push('invalid value for "value", value cannot be nil.')
+      end
+
+      if @value > 100
+        invalid_properties.push('invalid value for "value", must be smaller than or equal to 100.')
+      end
+
+      if @value < 0
+        invalid_properties.push('invalid value for "value", must be greater than or equal to 0.')
+      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 @label.nil?
+      return false if @label.to_s.length < 1
+      return false if @value.nil?
+      return false if @value > 100
+      return false if @value < 0
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] label Value to be assigned
+    def label=(label)
+      if label.nil?
+        fail ArgumentError, 'label cannot be nil'
+      end
+
+      if label.to_s.length < 1
+        fail ArgumentError, 'invalid value for "label", the character length must be great than or equal to 1.'
+      end
+
+      @label = label
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] value Value to be assigned
+    def value=(value)
+      if value.nil?
+        fail ArgumentError, 'value cannot be nil'
+      end
+
+      if value > 100
+        fail ArgumentError, 'invalid value for "value", must be smaller than or equal to 100.'
+      end
+
+      if value < 0
+        fail ArgumentError, 'invalid value for "value", must be greater than or equal to 0.'
+      end
+
+      @value = value
+    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 &&
+          label == o.label &&
+          value == o.value &&
+          unit == o.unit
+    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
+      [label, value, unit].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

data/generated/activitysmith_openapi/models/content_state_end.rb

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module OpenapiClient
-  # End payload requires title. For segmented_progress include current_step and optionally number_of_steps. For progress include percentage or value with upper_limit. Type is optional when ending an existing activity. You can send an updated number_of_steps here if the workflow changed after start.
+  # End payload requires title. For segmented_progress include current_step and optionally number_of_steps. For progress include percentage or value with upper_limit. For metrics include a non-empty metrics array. Legacy counter/timer/countdown types also use current_step and number_of_steps. Type is optional when ending an existing activity. You can send an updated number_of_steps here if the workflow changed after start.
   class ContentStateEnd
     attr_accessor :title
 
@@ -35,6 +35,9 @@ module OpenapiClient
     # Maximum progress value. Use with value for type=progress.
     attr_accessor :upper_limit
 
+    # Use for type=metrics.
+    attr_accessor :metrics
+
     # Optional. When omitted, the API uses the existing Live Activity type.
     attr_accessor :type
 
@@ -44,6 +47,9 @@ module OpenapiClient
     # Optional. Overrides color for the current step. Only applies to type=segmented_progress.
     attr_accessor :step_color
 
+    # Optional. Colors for completed steps. When used with segmented_progress, the array length should match current_step.
+    attr_accessor :step_colors
+
     # Optional. Minutes before the ended Live Activity is dismissed. Default 3. Set 0 for immediate dismissal. iOS will dismiss ended Live Activities after ~4 hours max.
     attr_accessor :auto_dismiss_minutes
 
@@ -79,9 +85,11 @@ module OpenapiClient
         :'percentage' => :'percentage',
         :'value' => :'value',
         :'upper_limit' => :'upper_limit',
+        :'metrics' => :'metrics',
         :'type' => :'type',
         :'color' => :'color',
         :'step_color' => :'step_color',
+        :'step_colors' => :'step_colors',
         :'auto_dismiss_minutes' => :'auto_dismiss_minutes'
       }
     end
@@ -101,9 +109,11 @@ module OpenapiClient
         :'percentage' => :'Float',
         :'value' => :'Float',
         :'upper_limit' => :'Float',
+        :'metrics' => :'Array<ActivityMetric>',
         :'type' => :'String',
         :'color' => :'String',
         :'step_color' => :'String',
+        :'step_colors' => :'Array<String>',
         :'auto_dismiss_minutes' => :'Integer'
       }
     end
@@ -159,6 +169,12 @@ module OpenapiClient
         self.upper_limit = attributes[:'upper_limit']
       end
 
+      if attributes.key?(:'metrics')
+        if (value = attributes[:'metrics']).is_a?(Array)
+          self.metrics = value
+        end
+      end
+
       if attributes.key?(:'type')
         self.type = attributes[:'type']
       end
@@ -173,6 +189,12 @@ module OpenapiClient
         self.step_color = attributes[:'step_color']
       end
 
+      if attributes.key?(:'step_colors')
+        if (value = attributes[:'step_colors']).is_a?(Array)
+          self.step_colors = value
+        end
+      end
+
       if attributes.key?(:'auto_dismiss_minutes')
         self.auto_dismiss_minutes = attributes[:'auto_dismiss_minutes']
       else
@@ -205,6 +227,10 @@ module OpenapiClient
         invalid_properties.push('invalid value for "percentage", must be greater than or equal to 0.')
       end
 
+      if !@metrics.nil? && @metrics.length < 1
+        invalid_properties.push('invalid value for "metrics", number of items must be greater than or equal to 1.')
+      end
+
       if !@auto_dismiss_minutes.nil? && @auto_dismiss_minutes < 0
         invalid_properties.push('invalid value for "auto_dismiss_minutes", must be greater than or equal to 0.')
       end
@@ -221,7 +247,8 @@ module OpenapiClient
       return false if !@current_step.nil? && @current_step < 1
       return false if !@percentage.nil? && @percentage > 100
       return false if !@percentage.nil? && @percentage < 0
-      type_validator = EnumAttributeValidator.new('String', ["segmented_progress", "progress"])
+      return false if !@metrics.nil? && @metrics.length < 1
+      type_validator = EnumAttributeValidator.new('String', ["segmented_progress", "progress", "metrics", "counter", "timer", "countdown"])
       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)
@@ -277,10 +304,24 @@ module OpenapiClient
       @percentage = percentage
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] metrics Value to be assigned
+    def metrics=(metrics)
+      if metrics.nil?
+        fail ArgumentError, 'metrics cannot be nil'
+      end
+
+      if metrics.length < 1
+        fail ArgumentError, 'invalid value for "metrics", number of items must be greater than or equal to 1.'
+      end
+
+      @metrics = metrics
+    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", "progress"])
+      validator = EnumAttributeValidator.new('String', ["segmented_progress", "progress", "metrics", "counter", "timer", "countdown"])
       unless validator.valid?(type)
         fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
       end
@@ -333,9 +374,11 @@ module OpenapiClient
           percentage == o.percentage &&
           value == o.value &&
           upper_limit == o.upper_limit &&
+          metrics == o.metrics &&
           type == o.type &&
           color == o.color &&
           step_color == o.step_color &&
+          step_colors == o.step_colors &&
           auto_dismiss_minutes == o.auto_dismiss_minutes
     end
 
@@ -348,7 +391,7 @@ module OpenapiClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [title, subtitle, number_of_steps, current_step, percentage, value, upper_limit, type, color, step_color, auto_dismiss_minutes].hash
+      [title, subtitle, number_of_steps, current_step, percentage, value, upper_limit, metrics, type, color, step_color, step_colors, auto_dismiss_minutes].hash
     end
 
     # Builds the object from hash

data/generated/activitysmith_openapi/models/content_state_start.rb

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module OpenapiClient
-  # Start payload requires title and type. For segmented_progress include number_of_steps and current_step. For progress include percentage or value with upper_limit. For segmented_progress, number_of_steps is not locked and can be changed in later update or end calls.
+  # Start payload requires title and type. For segmented_progress include number_of_steps and current_step. For progress include percentage or value with upper_limit. For metrics include a non-empty metrics array. Legacy counter/timer/countdown types also use current_step and number_of_steps. For segmented_progress, number_of_steps is not locked and can be changed in later update or end calls.
   class ContentStateStart
     attr_accessor :title
 
@@ -35,6 +35,9 @@ module OpenapiClient
     # Maximum progress value. Use with value for type=progress.
     attr_accessor :upper_limit
 
+    # Use for type=metrics.
+    attr_accessor :metrics
+
     attr_accessor :type
 
     # Optional. Accent color for the Live Activity. Defaults to blue.
@@ -43,6 +46,9 @@ module OpenapiClient
     # Optional. Overrides color for the current step. Only applies to type=segmented_progress.
     attr_accessor :step_color
 
+    # Optional. Colors for completed steps. When used with segmented_progress, the array length should match current_step.
+    attr_accessor :step_colors
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -75,9 +81,11 @@ module OpenapiClient
         :'percentage' => :'percentage',
         :'value' => :'value',
         :'upper_limit' => :'upper_limit',
+        :'metrics' => :'metrics',
         :'type' => :'type',
         :'color' => :'color',
-        :'step_color' => :'step_color'
+        :'step_color' => :'step_color',
+        :'step_colors' => :'step_colors'
       }
     end
 
@@ -96,9 +104,11 @@ module OpenapiClient
         :'percentage' => :'Float',
         :'value' => :'Float',
         :'upper_limit' => :'Float',
+        :'metrics' => :'Array<ActivityMetric>',
         :'type' => :'String',
         :'color' => :'String',
-        :'step_color' => :'String'
+        :'step_color' => :'String',
+        :'step_colors' => :'Array<String>'
       }
     end
 
@@ -153,6 +163,12 @@ module OpenapiClient
         self.upper_limit = attributes[:'upper_limit']
       end
 
+      if attributes.key?(:'metrics')
+        if (value = attributes[:'metrics']).is_a?(Array)
+          self.metrics = value
+        end
+      end
+
       if attributes.key?(:'type')
         self.type = attributes[:'type']
       else
@@ -168,6 +184,12 @@ module OpenapiClient
       if attributes.key?(:'step_color')
         self.step_color = attributes[:'step_color']
       end
+
+      if attributes.key?(:'step_colors')
+        if (value = attributes[:'step_colors']).is_a?(Array)
+          self.step_colors = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -195,6 +217,10 @@ module OpenapiClient
         invalid_properties.push('invalid value for "percentage", must be greater than or equal to 0.')
       end
 
+      if !@metrics.nil? && @metrics.length < 1
+        invalid_properties.push('invalid value for "metrics", number of items must be greater than or equal to 1.')
+      end
+
       if @type.nil?
         invalid_properties.push('invalid value for "type", type cannot be nil.')
       end
@@ -211,8 +237,9 @@ module OpenapiClient
       return false if !@current_step.nil? && @current_step < 1
       return false if !@percentage.nil? && @percentage > 100
       return false if !@percentage.nil? && @percentage < 0
+      return false if !@metrics.nil? && @metrics.length < 1
       return false if @type.nil?
-      type_validator = EnumAttributeValidator.new('String', ["segmented_progress", "progress"])
+      type_validator = EnumAttributeValidator.new('String', ["segmented_progress", "progress", "metrics", "counter", "timer", "countdown"])
       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)
@@ -267,10 +294,24 @@ module OpenapiClient
       @percentage = percentage
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] metrics Value to be assigned
+    def metrics=(metrics)
+      if metrics.nil?
+        fail ArgumentError, 'metrics cannot be nil'
+      end
+
+      if metrics.length < 1
+        fail ArgumentError, 'invalid value for "metrics", number of items must be greater than or equal to 1.'
+      end
+
+      @metrics = metrics
+    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", "progress"])
+      validator = EnumAttributeValidator.new('String', ["segmented_progress", "progress", "metrics", "counter", "timer", "countdown"])
       unless validator.valid?(type)
         fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
       end
@@ -309,9 +350,11 @@ module OpenapiClient
           percentage == o.percentage &&
           value == o.value &&
           upper_limit == o.upper_limit &&
+          metrics == o.metrics &&
           type == o.type &&
           color == o.color &&
-          step_color == o.step_color
+          step_color == o.step_color &&
+          step_colors == o.step_colors
     end
 
     # @see the `==` method
@@ -323,7 +366,7 @@ module OpenapiClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [title, subtitle, number_of_steps, current_step, percentage, value, upper_limit, type, color, step_color].hash
+      [title, subtitle, number_of_steps, current_step, percentage, value, upper_limit, metrics, type, color, step_color, step_colors].hash
     end
 
     # Builds the object from hash