activitysmith 1.3.1 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72834442fc339c835883f57e5911a1df7b5b425ca72e9378c8bf4875b19d26ec
-  data.tar.gz: 6ed94939eb8886ac94102e3ca7dc70efa39c02432a8f945d7da793fa5920a67e
+  metadata.gz: c57318695ada7f8c3d33082a4a60616ddbc0616919f66cd8d9f8bf752b393f4b
+  data.tar.gz: b16241c1481014632938a841c71c483dc2fa70a22ede37668e1851ae367732de
 SHA512:
-  metadata.gz: 58df6742bc1758e8a1faba533f7a0f94f959c4e87e308d6306319026c5a37be285de28693bff0804fac2713e1aec8f9f81ae4ddf0561f07edd35e01557549863
-  data.tar.gz: 04ac9df1919119396b7b4e014f0d0cf99e6ccb4000d10c166a68ce184d68e3ddaeb12a1444f6ac6ee7c9811db9ac5e74899f9a50051f5324de23d6a592b2bf4a
+  metadata.gz: 2cb2947432a4e3b44523632d5b49443e8703c097365be08e087d69f3745457240d940f0eb9a91261b43a7a16d15cf31532bd03203e27bda0c79ea6ce5cec1379
+  data.tar.gz: 726fe1d3ecf9edaad5d428ea24ba0c41a5174cd2d51232605fe89343c2f750c5732e36c39b40a6e49b79a49da353229d2bfa0f3644fb2840180341dded57ae86

data/README.md

@@ -18,6 +18,8 @@ See [API reference](https://activitysmith.com/docs/api-reference/introduction).
   - [Start & Update Live Activity](#start--update-live-activity)
   - [End Live Activity](#end-live-activity)
   - [Live Activity Action](#live-activity-action)
+  - [Icons and Badges](#icons-and-badges)
+  - [Live Activity Colors](#live-activity-colors)
 - [Channels](#channels)
 - [Widgets](#widgets)
 
@@ -120,12 +122,13 @@ activitysmith.notifications.send(
 
 ## Live Activities
 
-There are four types of Live Activities:
+There are five types of Live Activities:
 
 - `stats`: best for showing business numbers side by side, such as revenue, sales, new users, conversion, refunds, or any other value you want visible at a glance
 - `metrics`: best for live percentage values that change often, like server CPU, memory usage, disk usage, or error rate
 - `segmented_progress`: best for anything that moves through clear stages, like deployments, onboarding flows, backups, ETL pipelines, migrations, and AI agent runs
 - `progress`: best for tracking real-time progress with percentage, like tasks, backups, migrations, syncs, or uploads
+- `alert`: best for status updates, such as feature adoption, reactivation, onboarding blockers, incidents, escalations, and other operational states
 
 ### Start & Update Live Activity
 
@@ -238,6 +241,31 @@ activitysmith.live_activities.stream(
 )
 ```
 
+#### Alert
+
+<p align="center">
+  <img
+    src="https://cdn.activitysmith.com/features/alert-live-activity.png"
+    alt="Alert Live Activity stream example"
+    width="680"
+  />
+</p>
+
+```ruby
+activitysmith.live_activities.stream(
+  "customer-ops",
+  {
+    content_state: ActivitySmith::LiveActivities.content_state(
+      title: "Reactivation",
+      message: "Lumen came back after 2 weeks",
+      type: ActivitySmith::LiveActivities::TYPE_ALERT,
+      icon: ActivitySmith::LiveActivities.alert_icon("cloud.sun", color: "yellow"),
+      badge: ActivitySmith::LiveActivities.alert_badge("Customer", color: "magenta")
+    )
+  }
+)
+```
+
 ### End Live Activity
 
 Call `end_stream(...)` with the same `stream_key` to dismiss the Live Activity. You can include final values before it is removed. By default, iOS removes the Live Activity after two minutes. Set `auto_dismiss_minutes` to choose a different dismissal time, including `0` for immediate dismissal.
@@ -263,6 +291,7 @@ activitysmith.live_activities.end_stream(
 ### Live Activity Action
 
 Live Activities can include one optional action button. Use it to open a URL from the Live Activity or trigger a backend webhook.
+For Alert Live Activities, set `color` in `content_state` to tint the action button. Icon and badge colors only affect the icon and badge.
 
 <p align="center">
   <img
@@ -323,6 +352,79 @@ activitysmith.live_activities.stream(
 )
 ```
 
+### Icons and Badges
+
+Add more context to Live Activities with icons and badges.
+
+#### Icon
+
+Supported Live Activity types: `stats`, `metrics`, `progress`, `segmented_progress`, and `alert`.
+
+<p align="center">
+  <img
+    src="https://cdn.activitysmith.com/features/metrics-live-activity-with-icon.png"
+    alt="Metrics Live Activity with an SF Symbol icon on the iPhone Lock Screen"
+    width="680"
+  />
+</p>
+
+```ruby
+activitysmith.live_activities.stream(
+  "prod-web-1",
+  {
+    content_state: ActivitySmith::LiveActivities.content_state(
+      title: "Server Health",
+      subtitle: "prod-web-1",
+      type: "metrics",
+      icon: ActivitySmith::LiveActivities.alert_icon("server.rack", color: "blue"),
+      metrics: [
+        { label: "CPU", value: 18, unit: "%" },
+        { label: "MEM", value: 42, unit: "%" }
+      ]
+    )
+  }
+)
+```
+
+The `icon` symbol value is an Apple SF Symbol name. Browse the catalog with one of these tools:
+
+- [ActivitySmith app](https://apps.apple.com/us/app/activitysmith/id6752254835) - Open Settings -> SF Symbols to browse 45 hand-picked icons ready to use
+- [SF Symbols](https://developer.apple.com/sf-symbols/) - Apple's official macOS app
+- [Interactful](https://apps.apple.com/app/interactful/id1528095640) - free third-party iOS app listing all SF Symbols under Foundations -> Iconography
+
+#### Badge
+
+Badges are supported by `alert`, `progress`, and `segmented_progress` Live Activities.
+
+<p align="center">
+  <img
+    src="https://cdn.activitysmith.com/features/progress-live-activity-with-badge.png"
+    alt="Progress Live Activity with a badge on the iPhone Lock Screen"
+    width="680"
+  />
+</p>
+
+```ruby
+activitysmith.live_activities.stream(
+  "nightly-database-backup",
+  {
+    content_state: ActivitySmith::LiveActivities.content_state(
+      title: "Nightly Database Backup",
+      subtitle: "verify restore",
+      type: "progress",
+      badge: ActivitySmith::LiveActivities.alert_badge("S3", color: "cyan"),
+      percentage: 62
+    )
+  }
+)
+```
+
+### Live Activity Colors
+
+Choose from these colors for the Live Activity accent, including progress bars and action buttons, or apply them to an individual icon or badge:
+
+`lime`, `green`, `cyan`, `blue`, `purple`, `magenta`, `red`, `orange`, `yellow`, `gray`
+
 ## Channels
 
 Channels are used to target specific team members or devices. Can be used for both push notifications and live activities.

data/generated/activitysmith_openapi/api/live_activities_api.rb

@@ -20,7 +20,7 @@ module OpenapiClient
       @api_client = api_client
     end
     # End a Live Activity (legacy manual lifecycle)
-    # Legacy manual lifecycle endpoint. For new integrations, use DELETE /live-activity/stream/{stream_key} to end a managed Live Activity stream. This endpoint remains supported for existing integrations and advanced lifecycle control. Ends a Live Activity and archives its lifecycle. Supports segmented_progress, progress, metrics, and stats activity types. For segmented_progress activities, you can send the latest number_of_steps here if the workflow changed after start.
+    # Legacy manual lifecycle endpoint. For new integrations, use DELETE /live-activity/stream/{stream_key} to end a managed Live Activity stream. This endpoint remains supported for existing integrations and advanced lifecycle control. Ends a Live Activity and archives its lifecycle. Supports segmented_progress, progress, metrics, stats, and alert activity types. For segmented_progress activities, you can send the latest number_of_steps here if the workflow changed after start.
     # @param live_activity_end_request [LiveActivityEndRequest] 
     # @param [Hash] opts the optional parameters
     # @return [LiveActivityEndResponse]
@@ -30,7 +30,7 @@ module OpenapiClient
     end
 
     # End a Live Activity (legacy manual lifecycle)
-    # Legacy manual lifecycle endpoint. For new integrations, use DELETE /live-activity/stream/{stream_key} to end a managed Live Activity stream. This endpoint remains supported for existing integrations and advanced lifecycle control. Ends a Live Activity and archives its lifecycle. Supports segmented_progress, progress, metrics, and stats activity types. For segmented_progress activities, you can send the latest number_of_steps here if the workflow changed after start.
+    # Legacy manual lifecycle endpoint. For new integrations, use DELETE /live-activity/stream/{stream_key} to end a managed Live Activity stream. This endpoint remains supported for existing integrations and advanced lifecycle control. Ends a Live Activity and archives its lifecycle. Supports segmented_progress, progress, metrics, stats, and alert activity types. For segmented_progress activities, you can send the latest number_of_steps here if the workflow changed after start.
     # @param live_activity_end_request [LiveActivityEndRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(LiveActivityEndResponse, Integer, Hash)>] LiveActivityEndResponse data, response status code and response headers
@@ -250,7 +250,7 @@ module OpenapiClient
     end
 
     # Start a Live Activity (legacy manual lifecycle)
-    # Legacy manual lifecycle endpoint. For new integrations, use PUT /live-activity/stream/{stream_key} so ActivitySmith can manage start, update, rotation, and end state for you. This endpoint remains supported for existing integrations and advanced lifecycle control. Starts a Live Activity on devices matched by API key scope and optional target channels. Supports segmented_progress, progress, metrics, and stats activity types. For segmented_progress activities, number_of_steps can be changed later during update or end calls if the workflow changes.
+    # Legacy manual lifecycle endpoint. For new integrations, use PUT /live-activity/stream/{stream_key} so ActivitySmith can manage start, update, rotation, and end state for you. This endpoint remains supported for existing integrations and advanced lifecycle control. Starts a Live Activity on devices matched by API key scope and optional target channels. Supports segmented_progress, progress, metrics, stats, and alert activity types. For segmented_progress activities, number_of_steps can be changed later during update or end calls if the workflow changes.
     # @param live_activity_start_request [LiveActivityStartRequest] 
     # @param [Hash] opts the optional parameters
     # @return [LiveActivityStartResponse]
@@ -260,7 +260,7 @@ module OpenapiClient
     end
 
     # Start a Live Activity (legacy manual lifecycle)
-    # Legacy manual lifecycle endpoint. For new integrations, use PUT /live-activity/stream/{stream_key} so ActivitySmith can manage start, update, rotation, and end state for you. This endpoint remains supported for existing integrations and advanced lifecycle control. Starts a Live Activity on devices matched by API key scope and optional target channels. Supports segmented_progress, progress, metrics, and stats activity types. For segmented_progress activities, number_of_steps can be changed later during update or end calls if the workflow changes.
+    # Legacy manual lifecycle endpoint. For new integrations, use PUT /live-activity/stream/{stream_key} so ActivitySmith can manage start, update, rotation, and end state for you. This endpoint remains supported for existing integrations and advanced lifecycle control. Starts a Live Activity on devices matched by API key scope and optional target channels. Supports segmented_progress, progress, metrics, stats, and alert activity types. For segmented_progress activities, number_of_steps can be changed later during update or end calls if the workflow changes.
     # @param live_activity_start_request [LiveActivityStartRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(LiveActivityStartResponse, Integer, Hash)>] LiveActivityStartResponse data, response status code and response headers
@@ -318,7 +318,7 @@ module OpenapiClient
     end
 
     # Update a Live Activity (legacy manual lifecycle)
-    # Legacy manual lifecycle endpoint. For new integrations, use PUT /live-activity/stream/{stream_key} so ActivitySmith can manage start, update, rotation, and end state for you. This endpoint remains supported for existing integrations and advanced lifecycle control. Updates an existing Live Activity. If the per-activity token is not registered yet, the update is queued. Supports segmented_progress, progress, metrics, and stats activity types. For segmented_progress activities, you can increase or decrease number_of_steps here as the workflow changes.
+    # Legacy manual lifecycle endpoint. For new integrations, use PUT /live-activity/stream/{stream_key} so ActivitySmith can manage start, update, rotation, and end state for you. This endpoint remains supported for existing integrations and advanced lifecycle control. Updates an existing Live Activity. If the per-activity token is not registered yet, the update is queued. Supports segmented_progress, progress, metrics, stats, and alert activity types. For segmented_progress activities, you can increase or decrease number_of_steps here as the workflow changes.
     # @param live_activity_update_request [LiveActivityUpdateRequest] 
     # @param [Hash] opts the optional parameters
     # @return [LiveActivityUpdateResponse]
@@ -328,7 +328,7 @@ module OpenapiClient
     end
 
     # Update a Live Activity (legacy manual lifecycle)
-    # Legacy manual lifecycle endpoint. For new integrations, use PUT /live-activity/stream/{stream_key} so ActivitySmith can manage start, update, rotation, and end state for you. This endpoint remains supported for existing integrations and advanced lifecycle control. Updates an existing Live Activity. If the per-activity token is not registered yet, the update is queued. Supports segmented_progress, progress, metrics, and stats activity types. For segmented_progress activities, you can increase or decrease number_of_steps here as the workflow changes.
+    # Legacy manual lifecycle endpoint. For new integrations, use PUT /live-activity/stream/{stream_key} so ActivitySmith can manage start, update, rotation, and end state for you. This endpoint remains supported for existing integrations and advanced lifecycle control. Updates an existing Live Activity. If the per-activity token is not registered yet, the update is queued. Supports segmented_progress, progress, metrics, stats, and alert activity types. For segmented_progress activities, you can increase or decrease number_of_steps here as the workflow changes.
     # @param live_activity_update_request [LiveActivityUpdateRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(LiveActivityUpdateResponse, Integer, Hash)>] LiveActivityUpdateResponse data, response status code and response headers

data/generated/activitysmith_openapi/models/activity_metric.rb

@@ -140,7 +140,7 @@ module OpenapiClient
       return false if @label.nil?
       return false if @label.to_s.length < 1
       return false if @value.nil?
-      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)
       true
     end
@@ -162,7 +162,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

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. For metrics and stats include a non-empty metrics array. 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 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 ending an existing activity. You can send an updated number_of_steps here if the workflow changed after start.
   class ContentStateEnd
     attr_accessor :title
 
@@ -23,7 +23,7 @@ module OpenapiClient
     # Total number of steps. Use for type=segmented_progress. Optional on end, and safe to change if the final workflow used more or fewer steps than originally planned.
     attr_accessor :number_of_steps
 
-    # Current step. Use for type=segmented_progress.
+    # Current completed step count. Use for type=segmented_progress. 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.
@@ -86,6 +95,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',
@@ -110,6 +122,9 @@ module OpenapiClient
         :'value' => :'Float',
         :'upper_limit' => :'Float',
         :'metrics' => :'Array<ActivityMetric>',
+        :'message' => :'String',
+        :'icon' => :'LiveActivityAlertIcon',
+        :'badge' => :'LiveActivityAlertBadge',
         :'type' => :'String',
         :'color' => :'String',
         :'step_color' => :'String',
@@ -175,14 +190,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')
@@ -215,8 +240,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
@@ -235,6 +260,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
+
       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
@@ -248,16 +277,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)
       return false if !@auto_dismiss_minutes.nil? && @auto_dismiss_minutes < 0
       true
@@ -284,8 +314,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
@@ -327,10 +357,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
@@ -340,7 +384,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
@@ -350,7 +394,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
@@ -384,6 +428,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 &&
@@ -400,7 +447,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, auto_dismiss_minutes].hash
+      [title, subtitle, number_of_steps, current_step, percentage, value, upper_limit, metrics, message, icon, badge, 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 metrics and stats include a non-empty metrics array. 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 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. For segmented_progress, number_of_steps is not locked and can be changed in later update or end calls.
   class ContentStateStart
     attr_accessor :title
 
@@ -23,7 +23,7 @@ module OpenapiClient
     # Total number of steps. Use for type=segmented_progress. This value can be increased or decreased later when updating or ending the same activity.
     attr_accessor :number_of_steps
 
-    # Current step. Use for type=segmented_progress.
+    # Current completed step count. Use for type=segmented_progress. Set 0 when the activity has started but no segment is complete yet. Must be less than or equal to number_of_steps.
     attr_accessor :current_step
 
     # Progress percentage (0–100). Use for type=progress. Takes precedence over value/upper_limit if both are provided.
@@ -38,9 +38,18 @@ module OpenapiClient
     # Use for type=metrics or type=stats.
     attr_accessor :metrics
 
+    # Required 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
+
     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.
@@ -82,6 +91,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',
@@ -105,6 +117,9 @@ module OpenapiClient
         :'value' => :'Float',
         :'upper_limit' => :'Float',
         :'metrics' => :'Array<ActivityMetric>',
+        :'message' => :'String',
+        :'icon' => :'LiveActivityAlertIcon',
+        :'badge' => :'LiveActivityAlertBadge',
         :'type' => :'String',
         :'color' => :'String',
         :'step_color' => :'String',
@@ -169,6 +184,18 @@ 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']
       else
@@ -177,8 +204,6 @@ module OpenapiClient
 
       if attributes.key?(:'color')
         self.color = attributes[:'color']
-      else
-        self.color = 'blue'
       end
 
       if attributes.key?(:'step_color')
@@ -205,8 +230,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
@@ -225,6 +250,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
+
       if @type.nil?
         invalid_properties.push('invalid value for "type", type cannot be nil.')
       end
@@ -238,17 +267,18 @@ 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
+      return false if !@message.nil? && @message.to_s.length < 1
       return false if @type.nil?
-      type_validator = EnumAttributeValidator.new('String', ["segmented_progress", "progress", "metrics", "stats"])
+      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
@@ -274,8 +304,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
@@ -317,10 +347,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
@@ -330,7 +374,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
@@ -340,7 +384,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
@@ -360,6 +404,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 &&
@@ -375,7 +422,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