activitysmith 1.2.1 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d995d89c48fd76a480d106695dfef4c3c85bf2ed9d8613f1ba0c132367a35bc1
-  data.tar.gz: 026f8d00b5b30e26b0dcaca41143f3a644fa801462c5d05949ab28f4f6195738
+  metadata.gz: 72834442fc339c835883f57e5911a1df7b5b425ca72e9378c8bf4875b19d26ec
+  data.tar.gz: 6ed94939eb8886ac94102e3ca7dc70efa39c02432a8f945d7da793fa5920a67e
 SHA512:
-  metadata.gz: a1fcac1bec72a9993314cc2eee1ae4ab5a9e0c7c8941a78978214efc88be481dca1d3caec09f95b3be9d337f3cdfe11e2c4a3080b331071330eaba45b7e306ce
-  data.tar.gz: ba2a9963e7c8d8b324d0a9e70a6d39cc4405ab66331a3cac32c355ad88614593f5e886568c7c0bc0ee44a0177709f81c84956fe77671f835c2edff034e94aae9
+  metadata.gz: 58df6742bc1758e8a1faba533f7a0f94f959c4e87e308d6306319026c5a37be285de28693bff0804fac2713e1aec8f9f81ae4ddf0561f07edd35e01557549863
+  data.tar.gz: 04ac9df1919119396b7b4e014f0d0cf99e6ccb4000d10c166a68ce184d68e3ddaeb12a1444f6ac6ee7c9811db9ac5e74899f9a50051f5324de23d6a592b2bf4a

data/README.md

@@ -15,11 +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)
-  - [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)
@@ -123,46 +120,60 @@ 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 three types of Live Activities:
+There are four types of Live Activities:
 
-- `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
+- `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
 
-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.
+### Start & Update Live Activity
 
-This is ideal if you want minimal complexity, perfect for automated workflows
-like cron jobs.
+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.
 
-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.
+#### Stats
 
-In the following sections, we'll break down how to implement each method so you
-can choose what fits your use case best.
-
-### Simple: Let ActivitySmith manage the Live Activity for you
+<p align="center">
+  <img
+    src="https://cdn.activitysmith.com/features/stats-live-activity.png"
+    alt="Stats Live Activity stream example"
+    width="680"
+  />
+</p>
 
-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.
+```ruby
+activitysmith.live_activities.stream(
+  "sales-hourly",
+  {
+    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" }
+      ]
+    }
+  }
+)
+```
 
 #### 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: {
@@ -178,10 +189,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
@@ -202,7 +217,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
@@ -219,114 +238,14 @@ activitysmith.live_activities.stream(
 )
 ```
 
-Call `stream(...)` again with the same `stream_key` whenever the state changes.
-
-#### End a stream
+### End Live Activity
 
-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.
+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
 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.
-
-### Metrics Type
-
-Use `metrics` when you want to keep a small set of live stats visible, such as
-server health, queue pressure, or database load.
-
-#### Start
-
-<p align="center">
-  <img src="https://cdn.activitysmith.com/features/metrics-live-activity-start.png" alt="Metrics start example" width="680" />
-</p>
-
-```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(
-  {
-    activity_id: activity_id,
     content_state: {
       title: "Server Health",
       subtitle: "prod-web-1",
@@ -341,155 +260,23 @@ 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.
 
 <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",
@@ -507,23 +294,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, and metrics 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, and stats 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, and metrics 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, and stats 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, and metrics 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, and stats 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, and metrics 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, and stats 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, and metrics 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, and stats 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, and metrics 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, and stats 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

@@ -21,12 +21,38 @@ module OpenapiClient
 
     attr_accessor :unit
 
+    # Optional per-metric accent color for metrics and stats activities.
+    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
       {
         :'label' => :'label',
         :'value' => :'value',
-        :'unit' => :'unit'
+        :'unit' => :'unit',
+        :'color' => :'color'
       }
     end
 
@@ -39,8 +65,9 @@ module OpenapiClient
     def self.openapi_types
       {
         :'label' => :'String',
-        :'value' => :'Float',
-        :'unit' => :'String'
+        :'value' => :'ActivityMetricValue',
+        :'unit' => :'String',
+        :'color' => :'String'
       }
     end
 
@@ -80,6 +107,10 @@ module OpenapiClient
       if attributes.key?(:'unit')
         self.unit = attributes[:'unit']
       end
+
+      if attributes.key?(:'color')
+        self.color = attributes[:'color']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -99,14 +130,6 @@ module OpenapiClient
         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
 
@@ -117,8 +140,8 @@ module OpenapiClient
       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
+      color_validator = EnumAttributeValidator.new('String', ["lime", "green", "cyan", "blue", "purple", "magenta", "red", "orange", "yellow"])
+      return false unless color_validator.valid?(@color)
       true
     end
 
@@ -136,22 +159,14 @@ module OpenapiClient
       @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'
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] color Object to be assigned
+    def color=(color)
+      validator = EnumAttributeValidator.new('String', ["lime", "green", "cyan", "blue", "purple", "magenta", "red", "orange", "yellow"])
+      unless validator.valid?(color)
+        fail ArgumentError, "invalid value for \"color\", must be one of #{validator.allowable_values}."
       end
-
-      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
+      @color = color
     end
 
     # Checks equality by comparing each attribute.
@@ -161,7 +176,8 @@ module OpenapiClient
       self.class == o.class &&
           label == o.label &&
           value == o.value &&
-          unit == o.unit
+          unit == o.unit &&
+          color == o.color
     end
 
     # @see the `==` method
@@ -173,7 +189,7 @@ module OpenapiClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [label, value, unit].hash
+      [label, value, unit, color].hash
     end
 
     # Builds the object from hash

data/generated/activitysmith_openapi/models/activity_metric_value.rb

@@ -0,0 +1,105 @@
+=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
+  module ActivityMetricValue
+    class << self
+      # List of class defined in oneOf (OpenAPI v3)
+      def openapi_one_of
+        [
+          :'Float',
+          :'String'
+        ]
+      end
+
+      # Builds the object
+      # @param [Mixed] Data to be matched against the list of oneOf items
+      # @return [Object] Returns the model or the data itself
+      def build(data)
+        # Go through the list of oneOf items and attempt to identify the appropriate one.
+        # Note:
+        # - We do not attempt to check whether exactly one item matches.
+        # - No advanced validation of types in some cases (e.g. "x: { type: string }" will happily match { x: 123 })
+        #   due to the way the deserialization is made in the base_object template (it just casts without verifying).
+        # - TODO: scalar values are de facto behaving as if they were nullable.
+        # - TODO: logging when debugging is set.
+        openapi_one_of.each do |klass|
+          begin
+            next if klass == :AnyType # "nullable: true"
+            typed_data = find_and_cast_into_type(klass, data)
+            return typed_data if typed_data
+          rescue # rescue all errors so we keep iterating even if the current item lookup raises
+          end
+        end
+
+        openapi_one_of.include?(:AnyType) ? data : nil
+      end
+
+      private
+
+      SchemaMismatchError = Class.new(StandardError)
+
+      # Note: 'File' is missing here because in the regular case we get the data _after_ a call to JSON.parse.
+      def find_and_cast_into_type(klass, data)
+        return if data.nil?
+
+        case klass.to_s
+        when 'Boolean'
+          return data if data.instance_of?(TrueClass) || data.instance_of?(FalseClass)
+        when 'Float'
+          return data if data.instance_of?(Float)
+        when 'Integer'
+          return data if data.instance_of?(Integer)
+        when 'Time'
+          return Time.parse(data)
+        when 'Date'
+          return Date.parse(data)
+        when 'String'
+          return data if data.instance_of?(String)
+        when 'Object' # "type: object"
+          return data if data.instance_of?(Hash)
+        when /\AArray<(?<sub_type>.+)>\z/ # "type: array"
+          if data.instance_of?(Array)
+            sub_type = Regexp.last_match[:sub_type]
+            return data.map { |item| find_and_cast_into_type(sub_type, item) }
+          end
+        when /\AHash<String, (?<sub_type>.+)>\z/ # "type: object" with "additionalProperties: { ... }"
+          if data.instance_of?(Hash) && data.keys.all? { |k| k.instance_of?(Symbol) || k.instance_of?(String) }
+            sub_type = Regexp.last_match[:sub_type]
+            return data.each_with_object({}) { |(k, v), hsh| hsh[k] = find_and_cast_into_type(sub_type, v) }
+          end
+        else # model
+          const = OpenapiClient.const_get(klass)
+          if const
+            if const.respond_to?(:openapi_one_of) # nested oneOf model
+              model = const.build(data)
+              return model if model
+            else
+              # raise if data contains keys that are not known to the model
+              raise if const.respond_to?(:acceptable_attributes) && !(data.keys - const.acceptable_attributes).empty?
+              model = const.build_from_hash(data)
+              return model if model
+            end
+          end
+        end
+
+        raise # if no match by now, raise
+      rescue
+        raise SchemaMismatchError, "#{data} doesn't match the #{klass} type"
+      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. For metrics 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. 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,7 +35,7 @@ module OpenapiClient
     # Maximum progress value. Use with value for type=progress.
     attr_accessor :upper_limit
 
-    # Use for type=metrics.
+    # Use for type=metrics or type=stats.
     attr_accessor :metrics
 
     # Optional. When omitted, the API uses the existing Live Activity type.
@@ -227,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 > 8
+        invalid_properties.push('invalid value for "metrics", number of items must be less than or equal to 8.')
+      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
@@ -247,8 +251,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 > 8
       return false if !@metrics.nil? && @metrics.length < 1
-      type_validator = EnumAttributeValidator.new('String', ["segmented_progress", "progress", "metrics"])
+      type_validator = EnumAttributeValidator.new('String', ["segmented_progress", "progress", "metrics", "stats"])
       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)
@@ -311,6 +316,10 @@ module OpenapiClient
         fail ArgumentError, 'metrics cannot be nil'
       end
 
+      if metrics.length > 8
+        fail ArgumentError, 'invalid value for "metrics", number of items must be less than or equal to 8.'
+      end
+
       if metrics.length < 1
         fail ArgumentError, 'invalid value for "metrics", number of items must be greater than or equal to 1.'
       end
@@ -321,7 +330,7 @@ module OpenapiClient
     # 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"])
+      validator = EnumAttributeValidator.new('String', ["segmented_progress", "progress", "metrics", "stats"])
       unless validator.valid?(type)
         fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
       end

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 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 segmented_progress, number_of_steps is not locked and can be changed in later update or end calls.
   class ContentStateStart
     attr_accessor :title
 
@@ -35,7 +35,7 @@ module OpenapiClient
     # Maximum progress value. Use with value for type=progress.
     attr_accessor :upper_limit
 
-    # Use for type=metrics.
+    # Use for type=metrics or type=stats.
     attr_accessor :metrics
 
     attr_accessor :type
@@ -217,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 > 8
+        invalid_properties.push('invalid value for "metrics", number of items must be less than or equal to 8.')
+      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
@@ -237,9 +241,10 @@ 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 > 8
       return false if !@metrics.nil? && @metrics.length < 1
       return false if @type.nil?
-      type_validator = EnumAttributeValidator.new('String', ["segmented_progress", "progress", "metrics"])
+      type_validator = EnumAttributeValidator.new('String', ["segmented_progress", "progress", "metrics", "stats"])
       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)
@@ -301,6 +306,10 @@ module OpenapiClient
         fail ArgumentError, 'metrics cannot be nil'
       end
 
+      if metrics.length > 8
+        fail ArgumentError, 'invalid value for "metrics", number of items must be less than or equal to 8.'
+      end
+
       if metrics.length < 1
         fail ArgumentError, 'invalid value for "metrics", number of items must be greater than or equal to 1.'
       end
@@ -311,7 +320,7 @@ module OpenapiClient
     # 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"])
+      validator = EnumAttributeValidator.new('String', ["segmented_progress", "progress", "metrics", "stats"])
       unless validator.valid?(type)
         fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
       end

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 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. Type is optional when updating an existing activity. You can increase or decrease number_of_steps during updates.
   class ContentStateUpdate
     attr_accessor :title
 
@@ -35,7 +35,7 @@ module OpenapiClient
     # Maximum progress value. Use with value for type=progress.
     attr_accessor :upper_limit
 
-    # Use for type=metrics.
+    # Use for type=metrics or type=stats.
     attr_accessor :metrics
 
     # Optional. When omitted, the API uses the existing Live Activity type.
@@ -216,6 +216,10 @@ module OpenapiClient
         invalid_properties.push('invalid value for "percentage", must be greater than or equal to 0.')
       end
 
+      if !@metrics.nil? && @metrics.length > 8
+        invalid_properties.push('invalid value for "metrics", number of items must be less than or equal to 8.')
+      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
@@ -232,8 +236,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 > 8
       return false if !@metrics.nil? && @metrics.length < 1
-      type_validator = EnumAttributeValidator.new('String', ["segmented_progress", "progress", "metrics"])
+      type_validator = EnumAttributeValidator.new('String', ["segmented_progress", "progress", "metrics", "stats"])
       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)
@@ -295,6 +300,10 @@ module OpenapiClient
         fail ArgumentError, 'metrics cannot be nil'
       end
 
+      if metrics.length > 8
+        fail ArgumentError, 'invalid value for "metrics", number of items must be less than or equal to 8.'
+      end
+
       if metrics.length < 1
         fail ArgumentError, 'invalid value for "metrics", number of items must be greater than or equal to 1.'
       end
@@ -305,7 +314,7 @@ module OpenapiClient
     # 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"])
+      validator = EnumAttributeValidator.new('String', ["segmented_progress", "progress", "metrics", "stats"])
       unless validator.valid?(type)
         fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
       end

data/generated/activitysmith_openapi/models/stream_content_state.rb

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module OpenapiClient
-  # Current state for a managed Live Activity stream. Include type on the first PUT, and whenever the stream may need to start a fresh activity. Supports segmented_progress, progress, and metrics types.
+  # Current state for a managed Live Activity stream. Include type on the first PUT, and whenever the stream may need to start a fresh activity. Supports segmented_progress, progress, metrics, and stats types.
   class StreamContentState
     attr_accessor :title
 
@@ -47,7 +47,7 @@ module OpenapiClient
     # Optional. Colors for completed steps. When used with segmented_progress, the array length should match current_step.
     attr_accessor :step_colors
 
-    # Use for metrics activities.
+    # Use for metrics and stats activities.
     attr_accessor :metrics
 
     # Optional. Seconds before the ended Live Activity is dismissed.
@@ -234,6 +234,10 @@ module OpenapiClient
         invalid_properties.push('invalid value for "percentage", must be greater than or equal to 0.')
       end
 
+      if !@metrics.nil? && @metrics.length > 8
+        invalid_properties.push('invalid value for "metrics", number of items must be less than or equal to 8.')
+      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
@@ -258,12 +262,13 @@ 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", "metrics"])
+      type_validator = EnumAttributeValidator.new('String', ["segmented_progress", "progress", "metrics", "stats"])
       return false unless type_validator.valid?(@type)
       color_validator = EnumAttributeValidator.new('String', ["lime", "green", "cyan", "blue", "purple", "magenta", "red", "orange", "yellow"])
       return false unless color_validator.valid?(@color)
       step_color_validator = EnumAttributeValidator.new('String', ["lime", "green", "cyan", "blue", "purple", "magenta", "red", "orange", "yellow"])
       return false unless step_color_validator.valid?(@step_color)
+      return false if !@metrics.nil? && @metrics.length > 8
       return false if !@metrics.nil? && @metrics.length < 1
       return false if !@auto_dismiss_seconds.nil? && @auto_dismiss_seconds < 0
       return false if !@auto_dismiss_minutes.nil? && @auto_dismiss_minutes < 0
@@ -319,7 +324,7 @@ module OpenapiClient
     # 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"])
+      validator = EnumAttributeValidator.new('String', ["segmented_progress", "progress", "metrics", "stats"])
       unless validator.valid?(type)
         fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
       end
@@ -353,6 +358,10 @@ module OpenapiClient
         fail ArgumentError, 'metrics cannot be nil'
       end
 
+      if metrics.length > 8
+        fail ArgumentError, 'invalid value for "metrics", number of items must be less than or equal to 8.'
+      end
+
       if metrics.length < 1
         fail ArgumentError, 'invalid value for "metrics", number of items must be greater than or equal to 1.'
       end

data/generated/activitysmith_openapi/version.rb

@@ -11,5 +11,5 @@ Generator version: 7.7.0
 =end
 
 module OpenapiClient
-  VERSION = '1.2.1'
+  VERSION = '1.3.1'
 end

data/generated/activitysmith_openapi.rb

@@ -18,6 +18,7 @@ require 'activitysmith_openapi/configuration'
 
 # Models
 require 'activitysmith_openapi/models/activity_metric'
+require 'activitysmith_openapi/models/activity_metric_value'
 require 'activitysmith_openapi/models/alert_payload'
 require 'activitysmith_openapi/models/bad_request_error'
 require 'activitysmith_openapi/models/channel_target'

data/lib/activitysmith/live_activities.rb

@@ -2,6 +2,11 @@
 
 module ActivitySmith
   class LiveActivities
+    TYPE_SEGMENTED_PROGRESS = "segmented_progress"
+    TYPE_PROGRESS = "progress"
+    TYPE_METRICS = "metrics"
+    TYPE_STATS = "stats"
+
     def initialize(api)
       @api = api
     end

data/lib/activitysmith/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActivitySmith
-  VERSION = "1.2.1"
+  VERSION = "1.3.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activitysmith
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.1
 platform: ruby
 authors:
 - ActivitySmith
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-05-03 00:00:00.000000000 Z
+date: 2026-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -83,6 +83,7 @@ files:
 - generated/activitysmith_openapi/api_error.rb
 - generated/activitysmith_openapi/configuration.rb
 - generated/activitysmith_openapi/models/activity_metric.rb
+- generated/activitysmith_openapi/models/activity_metric_value.rb
 - generated/activitysmith_openapi/models/alert_payload.rb
 - generated/activitysmith_openapi/models/bad_request_error.rb
 - generated/activitysmith_openapi/models/channel_target.rb