activitysmith 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d2f19ff232a66a24046463a9e5c902981f4f6372c5f5b159c5c4dbd34599bfc3
-  data.tar.gz: 770153b7ebc383f129c2c19247e452bce49786171d1e32a02b919e49648cee43
+  metadata.gz: 7049fc74d1e6413d076f29460c876e25eed8288a443f083d4f67286098efcb72
+  data.tar.gz: 6240b7a43f373237b794dcbf04654211b5a1c97f3796b949f16bdf9a8a17d92b
 SHA512:
-  metadata.gz: ec35e8a04066ec01d2b17aafd100f9ee82107a1645149999c2095f8565e8e92a16fbcb05fae09330aa199912093c8ff982278660a538c074a4c15c61f3803b55
-  data.tar.gz: acdfddcc23f59dba508b71e4711a59d6084b37c74eb0303e386502ab50518b25f460671128a2ac0842c723ba095759ee21a2043392ad75689e999f376a5aaa40
+  metadata.gz: d033284e3d2e932d928096037880a61a34650e233578244cc70819b4d8bf04a019dc67b74c42d693a372978a2bf1e7882bb674aa8c6e4830b722642246dc8fbd
+  data.tar.gz: be32ed8bc216d5710ab192b542df9e3f8ac4528e476acdccfb35502997cc561d14a603e839f5529e47b1b32a0273fd46f92ca468f2c1330b9f3acc95f2306ecc

data/README.md

@@ -6,6 +6,24 @@ The ActivitySmith Ruby SDK provides convenient access to the ActivitySmith API f
 
 See [API reference](https://activitysmith.com/docs/api-reference/introduction).
 
+## Table of Contents
+
+- [Installation](#installation)
+- [Setup](#setup)
+- [Push Notifications](#push-notifications)
+  - [Send a Push Notification](#send-a-push-notification)
+  - [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)
+  - [Live Activity Action](#live-activity-action)
+- [Channels](#channels)
+- [Widgets](#widgets)
+
 ## Installation
 
 ```sh
@@ -105,25 +123,228 @@ activitysmith.notifications.send(
 
 ## Live Activities
 
-Live Activities come in two UI types, but the lifecycle stays the same:
-start the activity, keep the returned `activity_id`, update it as state
-changes, then end it when the work is done.
+<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:
+
+- `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.
+
+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
+
+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.
+
+#### Metrics
+
+<p align="center">
+  <img src="https://cdn.activitysmith.com/features/metrics-live-activity-start.png" alt="Metrics stream example" width="680" />
+</p>
+
+```ruby
+status = activitysmith.live_activities.stream(
+  "prod-web-1",
+  {
+    content_state: {
+      title: "Server Health",
+      subtitle: "prod-web-1",
+      type: "metrics",
+      metrics: [
+        { label: "CPU", value: 9, unit: "%" },
+        { label: "MEM", value: 45, unit: "%" }
+      ]
+    }
+  }
+)
+```
 
-- `segmented_progress`: best for jobs tracked in steps
-- `progress`: best for jobs tracked as a percentage or numeric range
+#### Segmented progress
 
-### Shared flow
+<p align="center">
+  <img src="https://cdn.activitysmith.com/features/update-live-activity.png" alt="Segmented progress stream example" width="680" />
+</p>
+
+```ruby
+activitysmith.live_activities.stream(
+  "nightly-backup",
+  {
+    content_state: {
+      title: "Nightly Backup",
+      subtitle: "upload archive",
+      type: "segmented_progress",
+      number_of_steps: 3,
+      current_step: 2
+    }
+  }
+)
+```
+
+#### Progress
+
+<p align="center">
+  <img src="https://cdn.activitysmith.com/features/progress-live-activity.png" alt="Progress stream example" width="680" />
+</p>
+
+```ruby
+activitysmith.live_activities.stream(
+  "search-reindex",
+  {
+    content_state: {
+      title: "Search Reindex",
+      subtitle: "catalog-v2",
+      type: "progress",
+      percentage: 42
+    }
+  }
+)
+```
+
+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.
 
+### 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",
+      type: "metrics",
+      metrics: [
+        { label: "CPU", value: 7, unit: "%" },
+        { label: "MEM", value: 38, unit: "%" }
+      ],
+      auto_dismiss_minutes: 2
+    }
+  }
+)
+```
+
 ### Segmented Progress Type
 
-Use `segmented_progress` when progress is easier to follow as steps instead of a
-raw percentage. It fits jobs like backups, deployments, ETL pipelines, and
-checklists where "step 2 of 3" is more useful than "67%".
+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.
 
@@ -143,8 +364,7 @@ start = activitysmith.live_activities.start(
       current_step: 1,
       type: "segmented_progress",
       color: "yellow"
-    },
-    channels: ["devs", "ops"] # Optional
+    }
   }
 )
 
@@ -164,7 +384,7 @@ activitysmith.live_activities.update(
     content_state: {
       title: "Nightly database backup",
       subtitle: "upload archive",
-      number_of_steps: 4,
+      number_of_steps: 3,
       current_step: 2
     }
   }
@@ -184,8 +404,8 @@ activitysmith.live_activities.end(
     content_state: {
       title: "Nightly database backup",
       subtitle: "verify restore",
-      number_of_steps: 4,
-      current_step: 4,
+      number_of_steps: 3,
+      current_step: 3,
       auto_dismiss_minutes: 2
     }
   }
@@ -211,8 +431,7 @@ start = activitysmith.live_activities.start(
       title: "EV Charging",
       subtitle: "Added 30 mi range",
       type: "progress",
-      percentage: 15,
-      color: "lime"
+      percentage: 15
     }
   }
 )
@@ -264,7 +483,7 @@ activitysmith.live_activities.end(
 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.
 
 <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" />
+  <img src="https://cdn.activitysmith.com/features/metrics-live-activity-action.png" alt="Metrics Live Activity with action" width="680" />
 </p>
 
 #### Open URL action
@@ -273,16 +492,18 @@ Just like Actionable Push Notifications, Live Activities can have a button that
 start = activitysmith.live_activities.start(
   {
     content_state: {
-      title: "Deploying payments-api",
-      subtitle: "Running database migrations",
-      number_of_steps: 5,
-      current_step: 3,
-      type: "segmented_progress"
+      title: "Server Health",
+      subtitle: "prod-web-1",
+      type: "metrics",
+      metrics: [
+        { label: "CPU", value: 76, unit: "%" },
+        { label: "MEM", value: 52, unit: "%" }
+      ]
     },
     action: {
-      title: "Open Workflow",
+      title: "Open Dashboard",
       type: "open_url",
-      url: "https://github.com/acme/payments-api/actions/runs/1234567890"
+      url: "https://ops.example.com/servers/prod-web-1"
     }
   }
 )
@@ -292,6 +513,10 @@ 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(
   {
@@ -330,6 +555,28 @@ activitysmith.notifications.send(
 )
 ```
 
+## Widgets
+
+<p align="center">
+  <img src="https://cdn.activitysmith.com/features/lock-screen-widgets.png" alt="Lock screen widgets" width="680" />
+</p>
+
+ActivitySmith lets you display any value on your Lock Screen with widgets - SaaS metrics, revenue, signups, uptime, habits, or anything else you want to track. Create a metric in the web app, then update the metric value using our API, add a widget to your lock screen and it will fetch the latest update automatically.
+
+<p align="center">
+  <img src="https://cdn.activitysmith.com/features/create-widget-metric.png" alt="Create widget metric" width="680" />
+</p>
+
+```ruby
+activitysmith.metrics.update("deploy.success_rate", 99.9)
+```
+
+String metric values work too.
+
+```ruby
+activitysmith.metrics.update("prod.status", "healthy")
+```
+
 ## Error Handling
 
 ```ruby

data/generated/activitysmith_openapi/api/live_activities_api.rb

@@ -20,7 +20,7 @@ module OpenapiClient
       @api_client = api_client
     end
     # End a Live Activity
-    # Ends a Live Activity and archives its lifecycle. For segmented_progress activities, you can send the latest number_of_steps here if the workflow changed after start.
+    # 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.
     # @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
-    # Ends a Live Activity and archives its lifecycle. For segmented_progress activities, you can send the latest number_of_steps here if the workflow changed after start.
+    # 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.
     # @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
@@ -87,8 +87,170 @@ module OpenapiClient
       return data, status_code, headers
     end
 
+    # End a stream
+    # Use this endpoint when the process you are tracking is finished and you no longer want the Live Activity on your devices. ActivitySmith ends the current Live Activity for this stream and dismisses it from devices. If you need direct lifecycle control, use /live-activity/start, /live-activity/update, and /live-activity/end instead.
+    # @param stream_key [String] Stable identifier for one ongoing thing. Allowed characters: letters, numbers, underscores, and hyphens.
+    # @param [Hash] opts the optional parameters
+    # @option opts [LiveActivityStreamDeleteRequest] :live_activity_stream_delete_request 
+    # @return [LiveActivityStreamDeleteResponse]
+    def end_live_activity_stream(stream_key, opts = {})
+      data, _status_code, _headers = end_live_activity_stream_with_http_info(stream_key, opts)
+      data
+    end
+
+    # End a stream
+    # Use this endpoint when the process you are tracking is finished and you no longer want the Live Activity on your devices. ActivitySmith ends the current Live Activity for this stream and dismisses it from devices. If you need direct lifecycle control, use /live-activity/start, /live-activity/update, and /live-activity/end instead.
+    # @param stream_key [String] Stable identifier for one ongoing thing. Allowed characters: letters, numbers, underscores, and hyphens.
+    # @param [Hash] opts the optional parameters
+    # @option opts [LiveActivityStreamDeleteRequest] :live_activity_stream_delete_request 
+    # @return [Array<(LiveActivityStreamDeleteResponse, Integer, Hash)>] LiveActivityStreamDeleteResponse data, response status code and response headers
+    def end_live_activity_stream_with_http_info(stream_key, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: LiveActivitiesApi.end_live_activity_stream ...'
+      end
+      # verify the required parameter 'stream_key' is set
+      if @api_client.config.client_side_validation && stream_key.nil?
+        fail ArgumentError, "Missing the required parameter 'stream_key' when calling LiveActivitiesApi.end_live_activity_stream"
+      end
+      if @api_client.config.client_side_validation && stream_key.to_s.length > 255
+        fail ArgumentError, 'invalid value for "stream_key" when calling LiveActivitiesApi.end_live_activity_stream, the character length must be smaller than or equal to 255.'
+      end
+
+      pattern = Regexp.new(/^[A-Za-z0-9_-]+$/)
+      if @api_client.config.client_side_validation && stream_key !~ pattern
+        fail ArgumentError, "invalid value for 'stream_key' when calling LiveActivitiesApi.end_live_activity_stream, must conform to the pattern #{pattern}."
+      end
+
+      # resource path
+      local_var_path = '/live-activity/stream/{stream_key}'.sub('{' + 'stream_key' + '}', CGI.escape(stream_key.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'live_activity_stream_delete_request'])
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'LiveActivityStreamDeleteResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"LiveActivitiesApi.end_live_activity_stream",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: LiveActivitiesApi#end_live_activity_stream\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      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.
+    # @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
+    # @return [LiveActivityStreamPutResponse]
+    def reconcile_live_activity_stream(stream_key, live_activity_stream_request, opts = {})
+      data, _status_code, _headers = reconcile_live_activity_stream_with_http_info(stream_key, live_activity_stream_request, opts)
+      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.
+    # @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
+    # @return [Array<(LiveActivityStreamPutResponse, Integer, Hash)>] LiveActivityStreamPutResponse data, response status code and response headers
+    def reconcile_live_activity_stream_with_http_info(stream_key, live_activity_stream_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: LiveActivitiesApi.reconcile_live_activity_stream ...'
+      end
+      # verify the required parameter 'stream_key' is set
+      if @api_client.config.client_side_validation && stream_key.nil?
+        fail ArgumentError, "Missing the required parameter 'stream_key' when calling LiveActivitiesApi.reconcile_live_activity_stream"
+      end
+      if @api_client.config.client_side_validation && stream_key.to_s.length > 255
+        fail ArgumentError, 'invalid value for "stream_key" when calling LiveActivitiesApi.reconcile_live_activity_stream, the character length must be smaller than or equal to 255.'
+      end
+
+      pattern = Regexp.new(/^[A-Za-z0-9_-]+$/)
+      if @api_client.config.client_side_validation && stream_key !~ pattern
+        fail ArgumentError, "invalid value for 'stream_key' when calling LiveActivitiesApi.reconcile_live_activity_stream, must conform to the pattern #{pattern}."
+      end
+
+      # verify the required parameter 'live_activity_stream_request' is set
+      if @api_client.config.client_side_validation && live_activity_stream_request.nil?
+        fail ArgumentError, "Missing the required parameter 'live_activity_stream_request' when calling LiveActivitiesApi.reconcile_live_activity_stream"
+      end
+      # resource path
+      local_var_path = '/live-activity/stream/{stream_key}'.sub('{' + 'stream_key' + '}', CGI.escape(stream_key.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(live_activity_stream_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'LiveActivityStreamPutResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"LiveActivitiesApi.reconcile_live_activity_stream",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: LiveActivitiesApi#reconcile_live_activity_stream\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      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. For segmented_progress activities, number_of_steps can be changed later during update or end calls if the workflow changes.
+    # 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.
     # @param live_activity_start_request [LiveActivityStartRequest] 
     # @param [Hash] opts the optional parameters
     # @return [LiveActivityStartResponse]
@@ -98,7 +260,7 @@ module OpenapiClient
     end
 
     # Start a Live Activity
-    # Starts a Live Activity on devices matched by API key scope and optional target channels. For segmented_progress activities, number_of_steps can be changed later during update or end calls if the workflow changes.
+    # 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.
     # @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
@@ -156,7 +318,7 @@ module OpenapiClient
     end
 
     # Update a Live Activity
-    # Updates an existing Live Activity. If the per-activity token is not registered yet, the update is queued. For segmented_progress activities, you can increase or decrease number_of_steps here as the workflow changes.
+    # 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.
     # @param live_activity_update_request [LiveActivityUpdateRequest] 
     # @param [Hash] opts the optional parameters
     # @return [LiveActivityUpdateResponse]
@@ -166,7 +328,7 @@ module OpenapiClient
     end
 
     # Update a Live Activity
-    # Updates an existing Live Activity. If the per-activity token is not registered yet, the update is queued. For segmented_progress activities, you can increase or decrease number_of_steps here as the workflow changes.
+    # 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.
     # @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