activitysmith 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d97dda055e4f02cb5a23a068d6cf926aa298df90d535ed90b04f04a054274d5
-  data.tar.gz: 1f7207214477f6dad9a1421b57664f644d181234e061e554531f461f5cfd9ad7
+  metadata.gz: 34f1236d70e7c0a571966c66fee6c6c336a4bb21c7dd139640e87c9221eee214
+  data.tar.gz: dc381048f626f8bee8d38309f802665f1b500d5867d762cc03d1d33285e5b18e
 SHA512:
-  metadata.gz: 4b458cd36f4170e00116fe5e443a4e4590ea9c1d1d9b493d49daced2b3bf41b70ed0a6e9d5a2fc5e0a625e07fdfb7b61ac84125d099f5abba024fa0f60678ce1
-  data.tar.gz: a544c93e039ed071d9f0627d406f6577ca63ed03db7d160f719e0b37a66ec725b15a8696cefa8ef971ed51aea66cdb18fb3e9e022b8eda98dda939f9c510248a
+  metadata.gz: 81ba38f68b643bd772b070cb1fe41a1508be65fee8a333dc2ab9612d3b1086862aa832523c2386b62c7704debf148df1a572ee8928e3c790c6c856dbf8c5a707
+  data.tar.gz: 5e4ff4d86a8ab98de278ebf84e6356b66592b14086cc0bcc324c0d7c08b1f5144264d9f152f7efa9175b45f26991cc4993e7cb6ddd70cf883e1122aaf7263f50

data/README.md

@@ -15,12 +15,8 @@ See [API reference](https://activitysmith.com/docs/api-reference/introduction).
   - [Rich Push Notifications with Media](#rich-push-notifications-with-media)
   - [Actionable Push Notifications](#actionable-push-notifications)
 - [Live Activities](#live-activities)
-  - [Simple: Let ActivitySmith manage the Live Activity for you](#simple-let-activitysmith-manage-the-live-activity-for-you)
-  - [Advanced: Full lifecycle control](#advanced-full-lifecycle-control)
-  - [Stats Type](#stats-type)
-  - [Metrics Type](#metrics-type)
-  - [Segmented Progress Type](#segmented-progress-type)
-  - [Progress Type](#progress-type)
+  - [Start & Update Live Activity](#start--update-live-activity)
+  - [End Live Activity](#end-live-activity)
   - [Live Activity Action](#live-activity-action)
 - [Channels](#channels)
 - [Widgets](#widgets)
@@ -124,47 +120,30 @@ activitysmith.notifications.send(
 
 ## Live Activities
 
-<p align="center">
-  <img src="https://cdn.activitysmith.com/features/metrics-live-activity-action.png" alt="Metrics Live Activity screenshot" width="680" />
-</p>
-
-There are four types of Live Activities:
-
-- `stats`: best for compact business or product stats like revenue, orders, conversion, and average order value
-- `metrics`: best for live operational stats like server CPU and memory, queue depth, or replica lag
-- `segmented_progress`: best for step-based workflows like deployments, backups, and ETL pipelines
-- `progress`: best for continuous jobs like uploads, reindexes, and long-running migrations tracked as a percentage
-
-When working with Live Activities via our API, you have two approaches tailored
-to different needs. First, the stateless mode is the simplest path - one API
-call can initiate or update an activity, and another ends it - no state
-tracking on your side.
-
-This is ideal if you want minimal complexity, perfect for automated workflows
-like cron jobs.
-
-In contrast, if you need precise lifecycle control, the classic approach offers
-distinct calls for start, updates, and end, giving you full control over the
-activity's state.
+There are five types of Live Activities:
 
-In the following sections, we'll break down how to implement each method so you
-can choose what fits your use case best.
+- `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
 
-### Simple: Let ActivitySmith manage the Live Activity for you
+### Start & Update Live Activity
 
-Use a stable `stream_key` to identify the system or workflow you are tracking,
-such as a server, deployment, build pipeline, cron job, or charging session.
-This is especially useful for cron jobs and other scheduled tasks where you do
-not want to store `activity_id` between runs.
+Use a stable `stream_key` to identify the metric, job, deployment, or system you want to keep visible. The first `stream(...)` call starts the Live Activity. Later calls with the same `stream_key` update it.
 
 #### Stats
 
 <p align="center">
-  <img src="https://cdn.activitysmith.com/features/stats-live-activity.png" alt="Stats stream example" width="680" />
+  <img
+    src="https://cdn.activitysmith.com/features/stats-live-activity.png"
+    alt="Stats Live Activity stream example"
+    width="680"
+  />
 </p>
 
 ```ruby
-status = activitysmith.live_activities.stream(
+activitysmith.live_activities.stream(
   "sales-hourly",
   {
     content_state: {
@@ -187,11 +166,15 @@ status = activitysmith.live_activities.stream(
 #### Metrics
 
 <p align="center">
-  <img src="https://cdn.activitysmith.com/features/metrics-live-activity-start.png" alt="Metrics stream example" width="680" />
+  <img
+    src="https://cdn.activitysmith.com/features/metrics-live-activity-start.png"
+    alt="Metrics Live Activity stream example"
+    width="680"
+  />
 </p>
 
 ```ruby
-status = activitysmith.live_activities.stream(
+activitysmith.live_activities.stream(
   "prod-web-1",
   {
     content_state: {
@@ -207,10 +190,14 @@ status = activitysmith.live_activities.stream(
 )
 ```
 
-#### Segmented progress
+#### Segmented Progress
 
 <p align="center">
-  <img src="https://cdn.activitysmith.com/features/update-live-activity.png" alt="Segmented progress stream example" width="680" />
+  <img
+    src="https://cdn.activitysmith.com/features/update-live-activity.png"
+    alt="Segmented Progress Live Activity stream example"
+    width="680"
+  />
 </p>
 
 ```ruby
@@ -231,7 +218,11 @@ activitysmith.live_activities.stream(
 #### Progress
 
 <p align="center">
-  <img src="https://cdn.activitysmith.com/features/progress-live-activity.png" alt="Progress stream example" width="680" />
+  <img
+    src="https://cdn.activitysmith.com/features/progress-live-activity.png"
+    alt="Progress Live Activity stream example"
+    width="680"
+  />
 </p>
 
 ```ruby
@@ -248,197 +239,47 @@ activitysmith.live_activities.stream(
 )
 ```
 
-Call `stream(...)` again with the same `stream_key` whenever the state changes.
-
-#### End a stream
-
-Use this when the tracked process is finished and you no longer want the Live
-Activity on devices. `content_state` is optional here; include it if you want
-to end the stream with a final state.
-
-```ruby
-activitysmith.live_activities.end_stream(
-  "prod-web-1",
-  {
-    content_state: {
-      title: "Server Health",
-      subtitle: "prod-web-1",
-      type: "metrics",
-      metrics: [
-        { label: "CPU", value: 7, unit: "%" },
-        { label: "MEM", value: 38, unit: "%" }
-      ]
-    }
-  }
-)
-```
-
-If you later send another `stream(...)` request with the same `stream_key`,
-ActivitySmith starts a new Live Activity for that stream again.
-
-Stream responses include an `operation` field:
-
-- `started`: ActivitySmith started a new Live Activity for this `stream_key`
-- `updated`: ActivitySmith updated the current Live Activity
-- `rotated`: ActivitySmith ended the previous Live Activity and started a new one
-- `noop`: the incoming state matched the current state, so no update was sent
-- `paused`: the stream is paused, so no Live Activity was started or updated
-- `ended`: returned by `end_stream(...)` after the stream is ended
-
-### Advanced: Full lifecycle control
-
-Use these methods when you want to manage the Live Activity lifecycle yourself:
-
-1. Call `activitysmith.live_activities.start(...)`.
-2. Save the returned `activity_id`.
-3. Call `activitysmith.live_activities.update(...)` as progress changes.
-4. Call `activitysmith.live_activities.end(...)` when the work is finished.
-
-### Stats Type
-
-Keep your key numbers on your Lock Screen. `stats` fits 1 to 8 labeled values,
-such as revenue, orders, conversion, uptime, or any other business metric you
-want visible at a glance. Each metric can use a formatted string or number as
-its `value`. Add `color` to a metric to show an accent dot next to its label;
-omit `color` to show the label without a dot.
-
-#### Start
+#### Alert
 
 <p align="center">
-  <img src="https://cdn.activitysmith.com/features/stats-live-activity.png" alt="Stats Live Activity with sales revenue, orders, conversion, and average order value" width="680" />
+  <img
+    src="https://cdn.activitysmith.com/features/alert-live-activity.png"
+    alt="Alert Live Activity stream example"
+    width="680"
+  />
 </p>
 
 ```ruby
-start = activitysmith.live_activities.start(
-  {
-    content_state: {
-      title: "Sales",
-      subtitle: "last hour",
-      type: "stats",
-      metrics: [
-        { label: "Revenue", value: "$2430", color: "blue" },
-        { label: "Orders", value: "37", color: "green" },
-        { label: "Conversion", value: "4.8%", color: "magenta" },
-        { label: "Avg Order", value: "$65.68", color: "yellow" },
-        { label: "Refunds", value: "$84", color: "red" },
-        { label: "New Buyers", value: "18", color: "cyan" }
-      ]
-    }
-  }
-)
-
-activity_id = start.activity_id
-```
-
-#### Update
-
-```ruby
-activitysmith.live_activities.update(
+activitysmith.live_activities.stream(
+  "customer-ops",
   {
-    activity_id: activity_id,
-    content_state: {
-      title: "Sales",
-      subtitle: "last hour",
-      type: "stats",
-      metrics: [
-        { label: "Revenue", value: "$3180", color: "blue" },
-        { label: "Orders", value: "51", color: "green" },
-        { label: "Conversion", value: "5.2%", color: "magenta" },
-        { label: "Avg Order", value: "$62.35", color: "yellow" },
-        { label: "Refunds", value: "$126", color: "red" },
-        { label: "New Buyers", value: "24", color: "cyan" }
-      ]
-    }
+    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
-
-```ruby
-activitysmith.live_activities.end(
-  {
-    activity_id: activity_id,
-    content_state: {
-      title: "Sales",
-      subtitle: "last hour",
-      type: "stats",
-      metrics: [
-        { label: "Revenue", value: "$3460", color: "blue" },
-        { label: "Orders", value: "58", color: "green" },
-        { label: "Conversion", value: "5.4%", color: "magenta" },
-        { label: "Avg Order", value: "$59.66", color: "yellow" },
-        { label: "Refunds", value: "$92", color: "red" },
-        { label: "New Buyers", value: "31", color: "cyan" }
-      ],
-      auto_dismiss_minutes: 2
-    }
-  }
-)
-```
+The `icon` symbol value is an Apple SF Symbol name. Browse the catalog with one of these tools:
 
-### Metrics Type
+- [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
 
-Use `metrics` when you want to keep a small set of live stats visible, such as
-server health, queue pressure, or database load.
+`icon` and `badge` are optional. If you omit either one, that element is not shown in the Live Activity.
 
-#### Start
+### End Live Activity
 
-<p align="center">
-  <img src="https://cdn.activitysmith.com/features/metrics-live-activity-start.png" alt="Metrics start example" width="680" />
-</p>
+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.
 
 ```ruby
-start = activitysmith.live_activities.start(
-  {
-    content_state: {
-      title: "Server Health",
-      subtitle: "prod-web-1",
-      type: "metrics",
-      metrics: [
-        { label: "CPU", value: 9, unit: "%" },
-        { label: "MEM", value: 45, unit: "%" }
-      ]
-    }
-  }
-)
-
-activity_id = start.activity_id
-```
-
-#### Update
-
-<p align="center">
-  <img src="https://cdn.activitysmith.com/features/metrics-live-activity-update.png" alt="Metrics update example" width="680" />
-</p>
-
-```ruby
-activitysmith.live_activities.update(
-  {
-    activity_id: activity_id,
-    content_state: {
-      title: "Server Health",
-      subtitle: "prod-web-1",
-      type: "metrics",
-      metrics: [
-        { label: "CPU", value: 76, unit: "%" },
-        { label: "MEM", value: 52, unit: "%" }
-      ]
-    }
-  }
-)
-```
-
-#### End
-
-<p align="center">
-  <img src="https://cdn.activitysmith.com/features/metrics-live-activity-end.png" alt="Metrics end example" width="680" />
-</p>
-
-```ruby
-activitysmith.live_activities.end(
+activitysmith.live_activities.end_stream(
+  "prod-web-1",
   {
-    activity_id: activity_id,
     content_state: {
       title: "Server Health",
       subtitle: "prod-web-1",
@@ -453,155 +294,24 @@ activitysmith.live_activities.end(
 )
 ```
 
-### Segmented Progress Type
-
-Use `segmented_progress` for jobs and workflows that move through clear steps or
-phases. It fits jobs like backups, deployments, ETL pipelines, and checklists.
-`number_of_steps` is dynamic, so you can increase or decrease it later if the
-workflow changes.
-
-#### Start
-
-<p align="center">
-  <img src="https://cdn.activitysmith.com/features/start-live-activity.png" alt="Segmented progress start example" width="680" />
-</p>
-
-```ruby
-start = activitysmith.live_activities.start(
-  {
-    content_state: {
-      title: "Nightly database backup",
-      subtitle: "create snapshot",
-      number_of_steps: 3,
-      current_step: 1,
-      type: "segmented_progress",
-      color: "yellow"
-    }
-  }
-)
-
-activity_id = start.activity_id
-```
-
-#### Update
-
-<p align="center">
-  <img src="https://cdn.activitysmith.com/features/update-live-activity.png" alt="Segmented progress update example" width="680" />
-</p>
-
-```ruby
-activitysmith.live_activities.update(
-  {
-    activity_id: activity_id,
-    content_state: {
-      title: "Nightly database backup",
-      subtitle: "upload archive",
-      number_of_steps: 3,
-      current_step: 2
-    }
-  }
-)
-```
-
-#### End
-
-<p align="center">
-  <img src="https://cdn.activitysmith.com/features/end-live-activity.png" alt="Segmented progress end example" width="680" />
-</p>
-
-```ruby
-activitysmith.live_activities.end(
-  {
-    activity_id: activity_id,
-    content_state: {
-      title: "Nightly database backup",
-      subtitle: "verify restore",
-      number_of_steps: 3,
-      current_step: 3,
-      auto_dismiss_minutes: 2
-    }
-  }
-)
-```
-
-### Progress Type
-
-Use `progress` when the state is naturally continuous. It fits charging,
-downloads, sync jobs, uploads, timers, and any flow where a percentage or
-numeric range is the clearest signal.
-
-#### Start
-
-<p align="center">
-  <img src="https://cdn.activitysmith.com/features/progress-live-activity-start.png" alt="Progress start example" width="680" />
-</p>
-
-```ruby
-start = activitysmith.live_activities.start(
-  {
-    content_state: {
-      title: "EV Charging",
-      subtitle: "Added 30 mi range",
-      type: "progress",
-      percentage: 15
-    }
-  }
-)
-
-activity_id = start.activity_id
-```
-
-#### Update
-
-<p align="center">
-  <img src="https://cdn.activitysmith.com/features/progress-live-activity-update.png" alt="Progress update example" width="680" />
-</p>
-
-```ruby
-activitysmith.live_activities.update(
-  {
-    activity_id: activity_id,
-    content_state: {
-      title: "EV Charging",
-      subtitle: "Added 120 mi range",
-      percentage: 60
-    }
-  }
-)
-```
-
-#### End
-
-<p align="center">
-  <img src="https://cdn.activitysmith.com/features/progress-live-activity-end.png" alt="Progress end example" width="680" />
-</p>
-
-```ruby
-activitysmith.live_activities.end(
-  {
-    activity_id: activity_id,
-    content_state: {
-      title: "EV Charging",
-      subtitle: "Added 200 mi range",
-      percentage: 100,
-      auto_dismiss_minutes: 2
-    }
-  }
-)
-```
-
 ### Live Activity Action
 
-Just like Actionable Push Notifications, Live Activities can have a button that opens provided URL in a browser or triggers a webhook. Webhooks are executed by the ActivitySmith backend.
+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 src="https://cdn.activitysmith.com/features/metrics-live-activity-action.png" alt="Metrics Live Activity with action" width="680" />
+  <img
+    src="https://cdn.activitysmith.com/features/live-activity-with-action.png?v=20260319-1"
+    alt="Live Activity with action button"
+    width="680"
+  />
 </p>
 
 #### Open URL action
 
 ```ruby
-start = activitysmith.live_activities.start(
+activitysmith.live_activities.stream(
+  "prod-web-1",
   {
     content_state: {
       title: "Server Health",
@@ -619,23 +329,18 @@ start = activitysmith.live_activities.start(
     }
   }
 )
-
-activity_id = start.activity_id
 ```
 
 #### Webhook action
 
-<p align="center">
-  <img src="https://cdn.activitysmith.com/features/live-activity-with-action.png?v=20260319-1" alt="Live Activity with action" width="680" />
-</p>
-
 ```ruby
-activitysmith.live_activities.update(
+activitysmith.live_activities.stream(
+  "search-reindex",
   {
-    activity_id: activity_id,
     content_state: {
       title: "Reindexing product search",
       subtitle: "Shard 7 of 12",
+      type: "segmented_progress",
       number_of_steps: 12,
       current_step: 7
     },

data/generated/activitysmith_openapi/api/live_activities_api.rb

@@ -19,8 +19,8 @@ module OpenapiClient
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # End a Live Activity
-    # 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.
+    # 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, 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]
@@ -29,8 +29,8 @@ module OpenapiClient
       data
     end
 
-    # End a Live Activity
-    # 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.
+    # 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, 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
@@ -166,8 +166,8 @@ module OpenapiClient
       return data, status_code, headers
     end
 
-    # Send a stream update
-    # Use this endpoint when you want the easiest, stateless way to trigger Live Activities. You do not need to store activity_id or manage the Live Activity lifecycle yourself. Send the latest state for a stable stream_key and ActivitySmith will handle the rest for you: if there is no Live Activity yet, it starts one; if there is already one for this stream, it updates it. If you need direct lifecycle control, use /live-activity/start, /live-activity/update, and /live-activity/end instead.
+    # Start a new Live Activity or update an existing one
+    # Use a stable stream_key for each ongoing thing you want to show as a Live Activity. Send the latest content_state whenever it changes, and ActivitySmith will keep the Live Activity in sync.
     # @param stream_key [String] Stable identifier for one ongoing thing. Allowed characters: letters, numbers, underscores, and hyphens.
     # @param live_activity_stream_request [LiveActivityStreamRequest] 
     # @param [Hash] opts the optional parameters
@@ -177,8 +177,8 @@ module OpenapiClient
       data
     end
 
-    # Send a stream update
-    # Use this endpoint when you want the easiest, stateless way to trigger Live Activities. You do not need to store activity_id or manage the Live Activity lifecycle yourself. Send the latest state for a stable stream_key and ActivitySmith will handle the rest for you: if there is no Live Activity yet, it starts one; if there is already one for this stream, it updates it. If you need direct lifecycle control, use /live-activity/start, /live-activity/update, and /live-activity/end instead.
+    # Start a new Live Activity or update an existing one
+    # Use a stable stream_key for each ongoing thing you want to show as a Live Activity. Send the latest content_state whenever it changes, and ActivitySmith will keep the Live Activity in sync.
     # @param stream_key [String] Stable identifier for one ongoing thing. Allowed characters: letters, numbers, underscores, and hyphens.
     # @param live_activity_stream_request [LiveActivityStreamRequest] 
     # @param [Hash] opts the optional parameters
@@ -249,8 +249,8 @@ module OpenapiClient
       return data, status_code, headers
     end
 
-    # Start a Live Activity
-    # 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.
+    # 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, 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]
@@ -259,8 +259,8 @@ module OpenapiClient
       data
     end
 
-    # Start a Live Activity
-    # 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.
+    # 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, 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
@@ -317,8 +317,8 @@ module OpenapiClient
       return data, status_code, headers
     end
 
-    # Update a Live Activity
-    # 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.
+    # 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, 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]
@@ -327,8 +327,8 @@ module OpenapiClient
       data
     end
 
-    # Update a Live Activity
-    # 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.
+    # 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, 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