activitysmith 1.3.1 → 1.6.0

data/generated/activitysmith_openapi/models/content_state_update.rb

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module OpenapiClient
-  # Update 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 and stats include a non-empty metrics array. Type is optional when updating an existing activity. You can increase or decrease number_of_steps during updates.
+  # Update 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 and stats include a non-empty metrics array. For alert include message. Optional icon is supported by all Live Activity types. Optional badge is supported by alert, progress, and segmented_progress. Type is optional when updating an existing activity. You can increase or decrease number_of_steps during updates.
   class ContentStateUpdate
     attr_accessor :title
 
@@ -23,7 +23,7 @@ module OpenapiClient
     # Total number of steps. Use for type=segmented_progress. Optional on update, and safe to change if the workflow gains or loses steps.
     attr_accessor :number_of_steps
 
-    # Current step. Use for type=segmented_progress.
+    # Current completed step count. Use for type=segmented_progress. Set 0 when no segment is complete yet. Must be less than or equal to number_of_steps when number_of_steps is provided.
     attr_accessor :current_step
 
     # Progress percentage (0–100). Use for type=progress. Takes precedence over value/upper_limit if both are provided.
@@ -38,10 +38,19 @@ module OpenapiClient
     # Use for type=metrics or type=stats.
     attr_accessor :metrics
 
+    # Alert message. Use for type=alert.
+    attr_accessor :message
+
+    # Optional SF Symbol icon. Supported by alert, progress, segmented_progress, metrics, and stats.
+    attr_accessor :icon
+
+    # Optional badge. Supported by alert, progress, and segmented_progress.
+    attr_accessor :badge
+
     # Optional. When omitted, the API uses the existing Live Activity type.
     attr_accessor :type
 
-    # Optional. Accent color for the Live Activity. Defaults to blue.
+    # Optional. Accent color for progress, segmented_progress, and metrics Live Activities. For Alert Live Activities, this tints the action button when action is included.
     attr_accessor :color
 
     # Optional. Overrides color for the current step. Only applies to type=segmented_progress.
@@ -83,6 +92,9 @@ module OpenapiClient
         :'value' => :'value',
         :'upper_limit' => :'upper_limit',
         :'metrics' => :'metrics',
+        :'message' => :'message',
+        :'icon' => :'icon',
+        :'badge' => :'badge',
         :'type' => :'type',
         :'color' => :'color',
         :'step_color' => :'step_color',
@@ -106,6 +118,9 @@ module OpenapiClient
         :'value' => :'Float',
         :'upper_limit' => :'Float',
         :'metrics' => :'Array<ActivityMetric>',
+        :'message' => :'String',
+        :'icon' => :'LiveActivityAlertIcon',
+        :'badge' => :'LiveActivityAlertBadge',
         :'type' => :'String',
         :'color' => :'String',
         :'step_color' => :'String',
@@ -170,14 +185,24 @@ module OpenapiClient
         end
       end
 
+      if attributes.key?(:'message')
+        self.message = attributes[:'message']
+      end
+
+      if attributes.key?(:'icon')
+        self.icon = attributes[:'icon']
+      end
+
+      if attributes.key?(:'badge')
+        self.badge = attributes[:'badge']
+      end
+
       if attributes.key?(:'type')
         self.type = attributes[:'type']
       end
 
       if attributes.key?(:'color')
         self.color = attributes[:'color']
-      else
-        self.color = 'blue'
       end
 
       if attributes.key?(:'step_color')
@@ -204,8 +229,8 @@ module OpenapiClient
         invalid_properties.push('invalid value for "number_of_steps", must be greater than or equal to 1.')
       end
 
-      if !@current_step.nil? && @current_step < 1
-        invalid_properties.push('invalid value for "current_step", must be greater than or equal to 1.')
+      if !@current_step.nil? && @current_step < 0
+        invalid_properties.push('invalid value for "current_step", must be greater than or equal to 0.')
       end
 
       if !@percentage.nil? && @percentage > 100
@@ -224,6 +249,10 @@ module OpenapiClient
         invalid_properties.push('invalid value for "metrics", number of items must be greater than or equal to 1.')
       end
 
+      if !@message.nil? && @message.to_s.length < 1
+        invalid_properties.push('invalid value for "message", the character length must be great than or equal to 1.')
+      end
+
       invalid_properties
     end
 
@@ -233,16 +262,17 @@ module OpenapiClient
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @title.nil?
       return false if !@number_of_steps.nil? && @number_of_steps < 1
-      return false if !@current_step.nil? && @current_step < 1
+      return false if !@current_step.nil? && @current_step < 0
       return false if !@percentage.nil? && @percentage > 100
       return false if !@percentage.nil? && @percentage < 0
       return false if !@metrics.nil? && @metrics.length > 8
       return false if !@metrics.nil? && @metrics.length < 1
-      type_validator = EnumAttributeValidator.new('String', ["segmented_progress", "progress", "metrics", "stats"])
+      return false if !@message.nil? && @message.to_s.length < 1
+      type_validator = EnumAttributeValidator.new('String', ["segmented_progress", "progress", "metrics", "stats", "alert"])
       return false unless type_validator.valid?(@type)
-      color_validator = EnumAttributeValidator.new('String', ["lime", "green", "cyan", "blue", "purple", "magenta", "red", "orange", "yellow"])
+      color_validator = EnumAttributeValidator.new('String', ["lime", "green", "cyan", "blue", "purple", "magenta", "red", "orange", "yellow", "gray"])
       return false unless color_validator.valid?(@color)
-      step_color_validator = EnumAttributeValidator.new('String', ["lime", "green", "cyan", "blue", "purple", "magenta", "red", "orange", "yellow"])
+      step_color_validator = EnumAttributeValidator.new('String', ["lime", "green", "cyan", "blue", "purple", "magenta", "red", "orange", "yellow", "gray"])
       return false unless step_color_validator.valid?(@step_color)
       true
     end
@@ -268,8 +298,8 @@ module OpenapiClient
         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.'
+      if current_step < 0
+        fail ArgumentError, 'invalid value for "current_step", must be greater than or equal to 0.'
       end
 
       @current_step = current_step
@@ -311,10 +341,24 @@ module OpenapiClient
       @metrics = metrics
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] message Value to be assigned
+    def message=(message)
+      if message.nil?
+        fail ArgumentError, 'message cannot be nil'
+      end
+
+      if message.to_s.length < 1
+        fail ArgumentError, 'invalid value for "message", the character length must be great than or equal to 1.'
+      end
+
+      @message = message
+    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", "metrics", "stats"])
+      validator = EnumAttributeValidator.new('String', ["segmented_progress", "progress", "metrics", "stats", "alert"])
       unless validator.valid?(type)
         fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
       end
@@ -324,7 +368,7 @@ module OpenapiClient
     # 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"])
+      validator = EnumAttributeValidator.new('String', ["lime", "green", "cyan", "blue", "purple", "magenta", "red", "orange", "yellow", "gray"])
       unless validator.valid?(color)
         fail ArgumentError, "invalid value for \"color\", must be one of #{validator.allowable_values}."
       end
@@ -334,7 +378,7 @@ module OpenapiClient
     # 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"])
+      validator = EnumAttributeValidator.new('String', ["lime", "green", "cyan", "blue", "purple", "magenta", "red", "orange", "yellow", "gray"])
       unless validator.valid?(step_color)
         fail ArgumentError, "invalid value for \"step_color\", must be one of #{validator.allowable_values}."
       end
@@ -354,6 +398,9 @@ module OpenapiClient
           value == o.value &&
           upper_limit == o.upper_limit &&
           metrics == o.metrics &&
+          message == o.message &&
+          icon == o.icon &&
+          badge == o.badge &&
           type == o.type &&
           color == o.color &&
           step_color == o.step_color &&
@@ -369,7 +416,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, metrics, type, color, step_color, step_colors].hash
+      [title, subtitle, number_of_steps, current_step, percentage, value, upper_limit, metrics, message, icon, badge, type, color, step_color, step_colors].hash
     end
 
     # Builds the object from hash

data/generated/activitysmith_openapi/models/live_activity_action.rb

@@ -21,7 +21,7 @@ module OpenapiClient
 
     attr_accessor :type
 
-    # HTTPS URL. For open_url it is opened in browser. For webhook it is called by ActivitySmith backend.
+    # Action URL. For open_url, use an HTTPS or shortcuts:// URL. For webhook, use an HTTPS URL called by the ActivitySmith backend.
     attr_accessor :url
 
     # Webhook HTTP method. Used only when type=webhook.
@@ -30,28 +30,6 @@ module OpenapiClient
     # Optional webhook payload body. Used only when type=webhook.
     attr_accessor :body
 
-    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
       {
@@ -117,6 +95,7 @@ module OpenapiClient
       else
         self.url = nil
       end
+      validate_action_url!
 
       if attributes.key?(:'method')
         self.method = attributes[:'method']
@@ -131,6 +110,16 @@ module OpenapiClient
       end
     end
 
+    def validate_action_url!
+      return if @url.nil? || @type.nil?
+      if @type == LiveActivityActionType::OPEN_URL && @url !~ /\A(https|shortcuts):\/\//
+        fail ArgumentError, 'invalid value for "url", open_url must use https or shortcuts.'
+      end
+      if @type == LiveActivityActionType::WEBHOOK && @url !~ /\Ahttps:\/\//
+        fail ArgumentError, 'invalid value for "url", webhook must use https.'
+      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
@@ -147,10 +136,11 @@ module OpenapiClient
       if @url.nil?
         invalid_properties.push('invalid value for "url", url cannot be nil.')
       end
-
-      pattern = Regexp.new(/^https:\/\//)
-      if @url !~ pattern
-        invalid_properties.push("invalid value for \"url\", must conform to the pattern #{pattern}.")
+      if !@url.nil? && @type == LiveActivityActionType::OPEN_URL && @url !~ /\A(https|shortcuts):\/\//
+        invalid_properties.push('invalid value for "url", open_url must use https or shortcuts.')
+      end
+      if !@url.nil? && @type == LiveActivityActionType::WEBHOOK && @url !~ /\Ahttps:\/\//
+        invalid_properties.push('invalid value for "url", webhook must use https.')
       end
 
       invalid_properties
@@ -163,25 +153,11 @@ module OpenapiClient
       return false if @title.nil?
       return false if @type.nil?
       return false if @url.nil?
-      return false if @url !~ Regexp.new(/^https:\/\//)
+      return false if !@url.nil? && @type == LiveActivityActionType::OPEN_URL && @url !~ /\A(https|shortcuts):\/\//
+      return false if !@url.nil? && @type == LiveActivityActionType::WEBHOOK && @url !~ /\Ahttps:\/\//
       true
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] url Value to be assigned
-    def url=(url)
-      if url.nil?
-        fail ArgumentError, 'url cannot be nil'
-      end
-
-      pattern = Regexp.new(/^https:\/\//)
-      if url !~ pattern
-        fail ArgumentError, "invalid value for \"url\", must conform to the pattern #{pattern}."
-      end
-
-      @url = url
-    end
-
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)

data/generated/activitysmith_openapi/models/live_activity_alert_badge.rb

@@ -0,0 +1,273 @@
+=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
+  # Optional badge for Live Activities.
+  class LiveActivityAlertBadge
+    attr_accessor :title
+
+    # Optional badge color.
+    attr_accessor :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',
+        :'color' => :'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',
+        :'color' => :'LiveActivityColor'
+      }
+    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::LiveActivityAlertBadge` 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::LiveActivityAlertBadge`. 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?(:'color')
+        self.color = attributes[:'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 @title.to_s.length < 1
+        invalid_properties.push('invalid value for "title", the character length must be great than or equal to 1.')
+      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 @title.to_s.length < 1
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] title Value to be assigned
+    def title=(title)
+      if title.nil?
+        fail ArgumentError, 'title cannot be nil'
+      end
+
+      if title.to_s.length < 1
+        fail ArgumentError, 'invalid value for "title", the character length must be great than or equal to 1.'
+      end
+
+      @title = title
+    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 &&
+          color == o.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, 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