activitysmith 0.1.5 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d8716c7c9794439454c8ed5a182522c0a0eb32449d198dadea37652609f4469
-  data.tar.gz: 6b84b2f13f5930404ea1fdf8fa8adc73082aa9b3b6d2564dd119819e5f0c0c3d
+  metadata.gz: 6be18d3495ded4e85d34cb9dfa10b9108f9dbd5e35ace8bd6303867fb6b31172
+  data.tar.gz: 64b2d345bf824795d5b809d0ce5e9e40ee239d7f86878c20213704892f95db4e
 SHA512:
-  metadata.gz: cad0ad010c8285ef38626df955773b4988a307736e95f399473a2d516ff39ecfce39849e81817a5e5ebfcd5150b668fbd3489869a6dbec7ffb5ae34190c1b5ea
-  data.tar.gz: 0d502d03eb228e205234bec172022c65e87ba6375072152baef435eed94091a05382d7c0eb479315214685ebb6d768c64ce843dfe8194f33fcf7ec7f9164a288
+  metadata.gz: 72f3a210715d8e9e660142c12ba0b5ae1d99bcd87fd49196c1aa8a6f4732b6aa83fd4408b11afc5816ef3e214804dfded8ba7dd23eb1ded669f805e1067df442
+  data.tar.gz: a022698cba1e043612fb3490fe3fc8805c20ef61dd8104137d74b3f8a0b36b9e378522ce76e5b4123a520a29ce2f1359f3fad6238758a701e7e672bca508ce8f

data/README.md

@@ -40,10 +40,34 @@ puts response.success
 puts response.devices_notified
 ```
 
-### Start a Live Activity
+## 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.
+
+- `segmented_progress`: best for jobs tracked in steps
+- `progress`: best for jobs tracked as a percentage or numeric range
+
+### Shared flow
+
+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.
+
+### 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%".
+`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="Start live activity example" width="680" />
+  <img src="https://cdn.activitysmith.com/features/start-live-activity.png" alt="Segmented progress start example" width="680" />
 </p>
 
 ```ruby
@@ -64,10 +88,10 @@ start = activitysmith.live_activities.start(
 activity_id = start.activity_id
 ```
 
-### Update a Live Activity
+#### Update
 
 <p align="center">
-  <img src="https://cdn.activitysmith.com/features/update-live-activity.png" alt="Update live activity example" width="680" />
+  <img src="https://cdn.activitysmith.com/features/update-live-activity.png" alt="Segmented progress update example" width="680" />
 </p>
 
 ```ruby
@@ -77,6 +101,7 @@ update = activitysmith.live_activities.update(
     content_state: {
       title: "Nightly database backup",
       subtitle: "upload archive",
+      number_of_steps: 4,
       current_step: 2
     }
   }
@@ -85,10 +110,10 @@ update = activitysmith.live_activities.update(
 puts update.devices_notified
 ```
 
-### End a Live Activity
+#### End
 
 <p align="center">
-  <img src="https://cdn.activitysmith.com/features/end-live-activity.png" alt="End live activity example" width="680" />
+  <img src="https://cdn.activitysmith.com/features/end-live-activity.png" alt="Segmented progress end example" width="680" />
 </p>
 
 ```ruby
@@ -98,7 +123,8 @@ finish = activitysmith.live_activities.end(
     content_state: {
       title: "Nightly database backup",
       subtitle: "verify restore",
-      current_step: 3,
+      number_of_steps: 4,
+      current_step: 4,
       auto_dismiss_minutes: 2
     }
   }
@@ -107,6 +133,73 @@ finish = activitysmith.live_activities.end(
 puts finish.success
 ```
 
+### 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,
+      color: "lime"
+    }
+  }
+)
+
+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
+    }
+  }
+)
+```
+
 ## Channels
 
 Channels are used to target specific team members or devices. Can be used for both push notifications and live activities.
@@ -121,6 +214,36 @@ response = activitysmith.notifications.send(
 )
 ```
 
+## Rich Push Notifications with Media
+
+<p align="center">
+  <img src="https://cdn.activitysmith.com/features/rich-push-notification-with-image.png" alt="Rich push notification with image" width="680" />
+</p>
+
+```ruby
+response = activitysmith.notifications.send(
+  {
+    title: "Homepage ready",
+    message: "Your agent finished the redesign.",
+    media: "https://cdn.example.com/output/homepage-v2.png",
+    redirection: "https://github.com/acme/web/pull/482"
+  }
+)
+```
+
+Send images, videos, or audio with your push notifications, press and hold to preview media directly from the notification, then tap through to open the linked content.
+
+<p align="center">
+  <img src="https://cdn.activitysmith.com/features/rich-push-notification-with-audio.png" alt="Rich push notification with audio" width="680" />
+</p>
+
+What will work:
+
+- direct image URL: `.jpg`, `.png`, `.gif`, etc.
+- direct audio file URL: `.mp3`, `.m4a`, etc.
+- direct video file URL: `.mp4`, `.mov`, etc.
+- URL that responds with a proper media `Content-Type`, even if the path has no extension
+
 ## Push Notification Redirection and Actions
 
 Push notification redirection and actions are optional and can be used to redirect the user to a specific URL when they tap the notification or to trigger a specific action when they long-press the notification.

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.
+    # 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.
     # @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.
+    # 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.
     # @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
@@ -88,7 +88,7 @@ module OpenapiClient
     end
 
     # Start a Live Activity
-    # Starts a Live Activity on devices matched by API key scope and optional target channels.
+    # 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.
     # @param live_activity_start_request [LiveActivityStartRequest] 
     # @param [Hash] opts the optional parameters
     # @return [LiveActivityStartResponse]
@@ -98,7 +98,7 @@ module OpenapiClient
     end
 
     # Start a Live Activity
-    # Starts a Live Activity on devices matched by API key scope and optional target channels.
+    # 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.
     # @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 +156,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.
+    # 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.
     # @param live_activity_update_request [LiveActivityUpdateRequest] 
     # @param [Hash] opts the optional parameters
     # @return [LiveActivityUpdateResponse]
@@ -166,7 +166,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.
+    # 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.
     # @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/api/push_notifications_api.rb

@@ -20,7 +20,7 @@ module OpenapiClient
       @api_client = api_client
     end
     # Send a push notification
-    # Sends a push notification to devices matched by API key scope and optional target channels. Supports optional redirection URL (tap) and up to 4 interactive actions (long-press on iOS).
+    # Sends a push notification to devices matched by API key scope and optional target channels. Supports optional redirection URL, optional media preview or playback when the notification is expanded, and up to 4 interactive actions. `media` cannot be combined with `actions`.
     # @param push_notification_request [PushNotificationRequest] 
     # @param [Hash] opts the optional parameters
     # @return [PushNotificationResponse]
@@ -30,7 +30,7 @@ module OpenapiClient
     end
 
     # Send a push notification
-    # Sends a push notification to devices matched by API key scope and optional target channels. Supports optional redirection URL (tap) and up to 4 interactive actions (long-press on iOS).
+    # Sends a push notification to devices matched by API key scope and optional target channels. Supports optional redirection URL, optional media preview or playback when the notification is expanded, and up to 4 interactive actions. `media` cannot be combined with `actions`.
     # @param push_notification_request [PushNotificationRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(PushNotificationResponse, Integer, Hash)>] PushNotificationResponse data, response status code and response headers

data/generated/activitysmith_openapi/models/content_state_end.rb

@@ -14,20 +14,34 @@ require 'date'
 require 'time'
 
 module OpenapiClient
-  # End payload. Required fields are title and current_step. number_of_steps is optional.
+  # End payload requires title. For segmented_progress include current_step and optionally number_of_steps. For progress include percentage or value with upper_limit. 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
 
     attr_accessor :subtitle
 
+    # Total number of steps. Use for type=segmented_progress. Optional on end, and safe to change if the final workflow used more or fewer steps than originally planned.
     attr_accessor :number_of_steps
 
+    # Current step. Use for type=segmented_progress.
     attr_accessor :current_step
 
+    # Progress percentage (0–100). Use for type=progress. Takes precedence over value/upper_limit if both are provided.
+    attr_accessor :percentage
+
+    # Current progress value. Use with upper_limit for type=progress.
+    attr_accessor :value
+
+    # Maximum progress value. Use with value for type=progress.
+    attr_accessor :upper_limit
+
+    # Optional. When omitted, the API uses the existing Live Activity type.
+    attr_accessor :type
+
     # Optional. Accent color for the Live Activity. Defaults to blue.
     attr_accessor :color
 
-    # Optional. Overrides color for the current step.
+    # Optional. Overrides color for the current step. Only applies to type=segmented_progress.
     attr_accessor :step_color
 
     # Optional. Minutes before the ended Live Activity is dismissed. Default 3. Set 0 for immediate dismissal. iOS will dismiss ended Live Activities after ~4 hours max.
@@ -62,6 +76,10 @@ module OpenapiClient
         :'subtitle' => :'subtitle',
         :'number_of_steps' => :'number_of_steps',
         :'current_step' => :'current_step',
+        :'percentage' => :'percentage',
+        :'value' => :'value',
+        :'upper_limit' => :'upper_limit',
+        :'type' => :'type',
         :'color' => :'color',
         :'step_color' => :'step_color',
         :'auto_dismiss_minutes' => :'auto_dismiss_minutes'
@@ -80,6 +98,10 @@ module OpenapiClient
         :'subtitle' => :'String',
         :'number_of_steps' => :'Integer',
         :'current_step' => :'Integer',
+        :'percentage' => :'Float',
+        :'value' => :'Float',
+        :'upper_limit' => :'Float',
+        :'type' => :'String',
         :'color' => :'String',
         :'step_color' => :'String',
         :'auto_dismiss_minutes' => :'Integer'
@@ -123,8 +145,22 @@ module OpenapiClient
 
       if attributes.key?(:'current_step')
         self.current_step = attributes[:'current_step']
-      else
-        self.current_step = nil
+      end
+
+      if attributes.key?(:'percentage')
+        self.percentage = attributes[:'percentage']
+      end
+
+      if attributes.key?(:'value')
+        self.value = attributes[:'value']
+      end
+
+      if attributes.key?(:'upper_limit')
+        self.upper_limit = attributes[:'upper_limit']
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
       end
 
       if attributes.key?(:'color')
@@ -157,12 +193,16 @@ module OpenapiClient
         invalid_properties.push('invalid value for "number_of_steps", must be greater than or equal to 1.')
       end
 
-      if @current_step.nil?
-        invalid_properties.push('invalid value for "current_step", current_step cannot be nil.')
+      if !@current_step.nil? && @current_step < 1
+        invalid_properties.push('invalid value for "current_step", must be greater than or equal to 1.')
       end
 
-      if @current_step < 1
-        invalid_properties.push('invalid value for "current_step", must be greater than or equal to 1.')
+      if !@percentage.nil? && @percentage > 100
+        invalid_properties.push('invalid value for "percentage", must be smaller than or equal to 100.')
+      end
+
+      if !@percentage.nil? && @percentage < 0
+        invalid_properties.push('invalid value for "percentage", must be greater than or equal to 0.')
       end
 
       if !@auto_dismiss_minutes.nil? && @auto_dismiss_minutes < 0
@@ -178,8 +218,11 @@ module OpenapiClient
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @title.nil?
       return false if !@number_of_steps.nil? && @number_of_steps < 1
-      return false if @current_step.nil?
-      return false if @current_step < 1
+      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"])
+      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"])
@@ -216,6 +259,34 @@ module OpenapiClient
       @current_step = current_step
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] percentage Value to be assigned
+    def percentage=(percentage)
+      if percentage.nil?
+        fail ArgumentError, 'percentage cannot be nil'
+      end
+
+      if percentage > 100
+        fail ArgumentError, 'invalid value for "percentage", must be smaller than or equal to 100.'
+      end
+
+      if percentage < 0
+        fail ArgumentError, 'invalid value for "percentage", must be greater than or equal to 0.'
+      end
+
+      @percentage = percentage
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] type Object to be assigned
+    def type=(type)
+      validator = EnumAttributeValidator.new('String', ["segmented_progress", "progress"])
+      unless validator.valid?(type)
+        fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
+      end
+      @type = type
+    end
+
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] color Object to be assigned
     def color=(color)
@@ -259,6 +330,10 @@ module OpenapiClient
           subtitle == o.subtitle &&
           number_of_steps == o.number_of_steps &&
           current_step == o.current_step &&
+          percentage == o.percentage &&
+          value == o.value &&
+          upper_limit == o.upper_limit &&
+          type == o.type &&
           color == o.color &&
           step_color == o.step_color &&
           auto_dismiss_minutes == o.auto_dismiss_minutes
@@ -273,7 +348,7 @@ module OpenapiClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [title, subtitle, number_of_steps, current_step, color, step_color, auto_dismiss_minutes].hash
+      [title, subtitle, number_of_steps, current_step, percentage, value, upper_limit, type, color, step_color, auto_dismiss_minutes].hash
     end
 
     # Builds the object from hash

data/generated/activitysmith_openapi/models/content_state_start.rb

@@ -14,22 +14,33 @@ require 'date'
 require 'time'
 
 module OpenapiClient
-  # Start payload requires title, number_of_steps, current_step, and type.
+  # 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 segmented_progress, number_of_steps is not locked and can be changed in later update or end calls.
   class ContentStateStart
     attr_accessor :title
 
     attr_accessor :subtitle
 
+    # Total number of steps. Use for type=segmented_progress. This value can be increased or decreased later when updating or ending the same activity.
     attr_accessor :number_of_steps
 
+    # Current step. Use for type=segmented_progress.
     attr_accessor :current_step
 
+    # Progress percentage (0–100). Use for type=progress. Takes precedence over value/upper_limit if both are provided.
+    attr_accessor :percentage
+
+    # Current progress value. Use with upper_limit for type=progress.
+    attr_accessor :value
+
+    # Maximum progress value. Use with value for type=progress.
+    attr_accessor :upper_limit
+
     attr_accessor :type
 
     # Optional. Accent color for the Live Activity. Defaults to blue.
     attr_accessor :color
 
-    # Optional. Overrides color for the current step.
+    # Optional. Overrides color for the current step. Only applies to type=segmented_progress.
     attr_accessor :step_color
 
     class EnumAttributeValidator
@@ -61,6 +72,9 @@ module OpenapiClient
         :'subtitle' => :'subtitle',
         :'number_of_steps' => :'number_of_steps',
         :'current_step' => :'current_step',
+        :'percentage' => :'percentage',
+        :'value' => :'value',
+        :'upper_limit' => :'upper_limit',
         :'type' => :'type',
         :'color' => :'color',
         :'step_color' => :'step_color'
@@ -79,6 +93,9 @@ module OpenapiClient
         :'subtitle' => :'String',
         :'number_of_steps' => :'Integer',
         :'current_step' => :'Integer',
+        :'percentage' => :'Float',
+        :'value' => :'Float',
+        :'upper_limit' => :'Float',
         :'type' => :'String',
         :'color' => :'String',
         :'step_color' => :'String'
@@ -118,14 +135,22 @@ module OpenapiClient
 
       if attributes.key?(:'number_of_steps')
         self.number_of_steps = attributes[:'number_of_steps']
-      else
-        self.number_of_steps = nil
       end
 
       if attributes.key?(:'current_step')
         self.current_step = attributes[:'current_step']
-      else
-        self.current_step = nil
+      end
+
+      if attributes.key?(:'percentage')
+        self.percentage = attributes[:'percentage']
+      end
+
+      if attributes.key?(:'value')
+        self.value = attributes[:'value']
+      end
+
+      if attributes.key?(:'upper_limit')
+        self.upper_limit = attributes[:'upper_limit']
       end
 
       if attributes.key?(:'type')
@@ -154,20 +179,20 @@ module OpenapiClient
         invalid_properties.push('invalid value for "title", title cannot be nil.')
       end
 
-      if @number_of_steps.nil?
-        invalid_properties.push('invalid value for "number_of_steps", number_of_steps cannot be nil.')
+      if !@number_of_steps.nil? && @number_of_steps < 1
+        invalid_properties.push('invalid value for "number_of_steps", must be greater than or equal to 1.')
       end
 
-      if @number_of_steps < 1
-        invalid_properties.push('invalid value for "number_of_steps", must be greater than or equal to 1.')
+      if !@current_step.nil? && @current_step < 1
+        invalid_properties.push('invalid value for "current_step", must be greater than or equal to 1.')
       end
 
-      if @current_step.nil?
-        invalid_properties.push('invalid value for "current_step", current_step cannot be nil.')
+      if !@percentage.nil? && @percentage > 100
+        invalid_properties.push('invalid value for "percentage", must be smaller than or equal to 100.')
       end
 
-      if @current_step < 1
-        invalid_properties.push('invalid value for "current_step", must be greater than or equal to 1.')
+      if !@percentage.nil? && @percentage < 0
+        invalid_properties.push('invalid value for "percentage", must be greater than or equal to 0.')
       end
 
       if @type.nil?
@@ -182,12 +207,12 @@ module OpenapiClient
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @title.nil?
-      return false if @number_of_steps.nil?
-      return false if @number_of_steps < 1
-      return false if @current_step.nil?
-      return false if @current_step < 1
+      return false if !@number_of_steps.nil? && @number_of_steps < 1
+      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 @type.nil?
-      type_validator = EnumAttributeValidator.new('String', ["segmented_progress"])
+      type_validator = EnumAttributeValidator.new('String', ["segmented_progress", "progress"])
       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)
@@ -224,10 +249,28 @@ module OpenapiClient
       @current_step = current_step
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] percentage Value to be assigned
+    def percentage=(percentage)
+      if percentage.nil?
+        fail ArgumentError, 'percentage cannot be nil'
+      end
+
+      if percentage > 100
+        fail ArgumentError, 'invalid value for "percentage", must be smaller than or equal to 100.'
+      end
+
+      if percentage < 0
+        fail ArgumentError, 'invalid value for "percentage", must be greater than or equal to 0.'
+      end
+
+      @percentage = percentage
+    end
+
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] type Object to be assigned
     def type=(type)
-      validator = EnumAttributeValidator.new('String', ["segmented_progress"])
+      validator = EnumAttributeValidator.new('String', ["segmented_progress", "progress"])
       unless validator.valid?(type)
         fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
       end
@@ -263,6 +306,9 @@ module OpenapiClient
           subtitle == o.subtitle &&
           number_of_steps == o.number_of_steps &&
           current_step == o.current_step &&
+          percentage == o.percentage &&
+          value == o.value &&
+          upper_limit == o.upper_limit &&
           type == o.type &&
           color == o.color &&
           step_color == o.step_color
@@ -277,7 +323,7 @@ module OpenapiClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [title, subtitle, number_of_steps, current_step, type, color, step_color].hash
+      [title, subtitle, number_of_steps, current_step, percentage, value, upper_limit, type, color, step_color].hash
     end
 
     # Builds the object from hash

data/generated/activitysmith_openapi/models/content_state_update.rb

@@ -14,20 +14,34 @@ require 'date'
 require 'time'
 
 module OpenapiClient
-  # Update payload. Required fields are title and current_step. number_of_steps is optional.
+  # Update payload requires title. For segmented_progress include current_step and optionally number_of_steps. For progress include percentage or value with upper_limit. Type is optional when updating an existing activity. You can increase or decrease number_of_steps during updates.
   class ContentStateUpdate
     attr_accessor :title
 
     attr_accessor :subtitle
 
+    # Total number of steps. Use for type=segmented_progress. Optional on update, and safe to change if the workflow gains or loses steps.
     attr_accessor :number_of_steps
 
+    # Current step. Use for type=segmented_progress.
     attr_accessor :current_step
 
+    # Progress percentage (0–100). Use for type=progress. Takes precedence over value/upper_limit if both are provided.
+    attr_accessor :percentage
+
+    # Current progress value. Use with upper_limit for type=progress.
+    attr_accessor :value
+
+    # Maximum progress value. Use with value for type=progress.
+    attr_accessor :upper_limit
+
+    # Optional. When omitted, the API uses the existing Live Activity type.
+    attr_accessor :type
+
     # Optional. Accent color for the Live Activity. Defaults to blue.
     attr_accessor :color
 
-    # Optional. Overrides color for the current step.
+    # Optional. Overrides color for the current step. Only applies to type=segmented_progress.
     attr_accessor :step_color
 
     class EnumAttributeValidator
@@ -59,6 +73,10 @@ module OpenapiClient
         :'subtitle' => :'subtitle',
         :'number_of_steps' => :'number_of_steps',
         :'current_step' => :'current_step',
+        :'percentage' => :'percentage',
+        :'value' => :'value',
+        :'upper_limit' => :'upper_limit',
+        :'type' => :'type',
         :'color' => :'color',
         :'step_color' => :'step_color'
       }
@@ -76,6 +94,10 @@ module OpenapiClient
         :'subtitle' => :'String',
         :'number_of_steps' => :'Integer',
         :'current_step' => :'Integer',
+        :'percentage' => :'Float',
+        :'value' => :'Float',
+        :'upper_limit' => :'Float',
+        :'type' => :'String',
         :'color' => :'String',
         :'step_color' => :'String'
       }
@@ -118,8 +140,22 @@ module OpenapiClient
 
       if attributes.key?(:'current_step')
         self.current_step = attributes[:'current_step']
-      else
-        self.current_step = nil
+      end
+
+      if attributes.key?(:'percentage')
+        self.percentage = attributes[:'percentage']
+      end
+
+      if attributes.key?(:'value')
+        self.value = attributes[:'value']
+      end
+
+      if attributes.key?(:'upper_limit')
+        self.upper_limit = attributes[:'upper_limit']
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
       end
 
       if attributes.key?(:'color')
@@ -146,12 +182,16 @@ module OpenapiClient
         invalid_properties.push('invalid value for "number_of_steps", must be greater than or equal to 1.')
       end
 
-      if @current_step.nil?
-        invalid_properties.push('invalid value for "current_step", current_step cannot be nil.')
+      if !@current_step.nil? && @current_step < 1
+        invalid_properties.push('invalid value for "current_step", must be greater than or equal to 1.')
       end
 
-      if @current_step < 1
-        invalid_properties.push('invalid value for "current_step", must be greater than or equal to 1.')
+      if !@percentage.nil? && @percentage > 100
+        invalid_properties.push('invalid value for "percentage", must be smaller than or equal to 100.')
+      end
+
+      if !@percentage.nil? && @percentage < 0
+        invalid_properties.push('invalid value for "percentage", must be greater than or equal to 0.')
       end
 
       invalid_properties
@@ -163,8 +203,11 @@ module OpenapiClient
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @title.nil?
       return false if !@number_of_steps.nil? && @number_of_steps < 1
-      return false if @current_step.nil?
-      return false if @current_step < 1
+      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"])
+      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"])
@@ -200,6 +243,34 @@ module OpenapiClient
       @current_step = current_step
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] percentage Value to be assigned
+    def percentage=(percentage)
+      if percentage.nil?
+        fail ArgumentError, 'percentage cannot be nil'
+      end
+
+      if percentage > 100
+        fail ArgumentError, 'invalid value for "percentage", must be smaller than or equal to 100.'
+      end
+
+      if percentage < 0
+        fail ArgumentError, 'invalid value for "percentage", must be greater than or equal to 0.'
+      end
+
+      @percentage = percentage
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] type Object to be assigned
+    def type=(type)
+      validator = EnumAttributeValidator.new('String', ["segmented_progress", "progress"])
+      unless validator.valid?(type)
+        fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
+      end
+      @type = type
+    end
+
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] color Object to be assigned
     def color=(color)
@@ -229,6 +300,10 @@ module OpenapiClient
           subtitle == o.subtitle &&
           number_of_steps == o.number_of_steps &&
           current_step == o.current_step &&
+          percentage == o.percentage &&
+          value == o.value &&
+          upper_limit == o.upper_limit &&
+          type == o.type &&
           color == o.color &&
           step_color == o.step_color
     end
@@ -242,7 +317,7 @@ module OpenapiClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [title, subtitle, number_of_steps, current_step, color, step_color].hash
+      [title, subtitle, number_of_steps, current_step, percentage, value, upper_limit, type, color, step_color].hash
     end
 
     # Builds the object from hash

data/generated/activitysmith_openapi/models/live_activity_end_request.rb

@@ -14,6 +14,7 @@ require 'date'
 require 'time'
 
 module OpenapiClient
+  # End an existing Live Activity by activity_id.
   class LiveActivityEndRequest
     attr_accessor :activity_id
 

data/generated/activitysmith_openapi/models/live_activity_end_response.rb

@@ -14,6 +14,7 @@ require 'date'
 require 'time'
 
 module OpenapiClient
+  # Returned after a Live Activity end event is sent or queued.
   class LiveActivityEndResponse
     attr_accessor :success
 

data/generated/activitysmith_openapi/models/live_activity_start_request.rb

@@ -14,6 +14,7 @@ require 'date'
 require 'time'
 
 module OpenapiClient
+  # Start a new Live Activity. The response includes activity_id for later update and end calls.
   class LiveActivityStartRequest
     attr_accessor :content_state
 

data/generated/activitysmith_openapi/models/live_activity_start_response.rb

@@ -14,6 +14,7 @@ require 'date'
 require 'time'
 
 module OpenapiClient
+  # Returned after a Live Activity starts. Save activity_id and use it for all later updates and for the final end call.
   class LiveActivityStartResponse
     attr_accessor :success
 

data/generated/activitysmith_openapi/models/live_activity_update_request.rb

@@ -14,6 +14,7 @@ require 'date'
 require 'time'
 
 module OpenapiClient
+  # Update an existing Live Activity by activity_id.
   class LiveActivityUpdateRequest
     attr_accessor :activity_id
 

data/generated/activitysmith_openapi/models/live_activity_update_response.rb

@@ -14,6 +14,7 @@ require 'date'
 require 'time'
 
 module OpenapiClient
+  # Returned after a Live Activity update is sent or queued.
   class LiveActivityUpdateResponse
     attr_accessor :success
 

data/generated/activitysmith_openapi/models/push_notification_request.rb

@@ -21,10 +21,13 @@ module OpenapiClient
 
     attr_accessor :subtitle
 
-    # Optional HTTPS URL opened when user taps the notification body.
+    # Optional HTTPS URL for an image, audio file, or video that users can preview or play when they expand the notification. If `redirection` is omitted, tapping the notification opens this URL. Cannot be combined with `actions`.
+    attr_accessor :media
+
+    # Optional HTTPS URL opened when user taps the notification body. Overrides the default tap target from `media` when both are provided.
     attr_accessor :redirection
 
-    # Optional interactive actions shown on iOS long-press.
+    # Optional interactive actions shown when users expand the notification. Cannot be combined with `media`.
     attr_accessor :actions
 
     attr_accessor :payload
@@ -41,6 +44,7 @@ module OpenapiClient
         :'title' => :'title',
         :'message' => :'message',
         :'subtitle' => :'subtitle',
+        :'media' => :'media',
         :'redirection' => :'redirection',
         :'actions' => :'actions',
         :'payload' => :'payload',
@@ -61,6 +65,7 @@ module OpenapiClient
         :'title' => :'String',
         :'message' => :'String',
         :'subtitle' => :'String',
+        :'media' => :'String',
         :'redirection' => :'String',
         :'actions' => :'Array<PushNotificationAction>',
         :'payload' => :'Hash<String, Object>',
@@ -105,6 +110,10 @@ module OpenapiClient
         self.subtitle = attributes[:'subtitle']
       end
 
+      if attributes.key?(:'media')
+        self.media = attributes[:'media']
+      end
+
       if attributes.key?(:'redirection')
         self.redirection = attributes[:'redirection']
       end
@@ -143,6 +152,11 @@ module OpenapiClient
         invalid_properties.push('invalid value for "title", title cannot be nil.')
       end
 
+      pattern = Regexp.new(/^https:\/\//)
+      if !@media.nil? && @media !~ pattern
+        invalid_properties.push("invalid value for \"media\", must conform to the pattern #{pattern}.")
+      end
+
       pattern = Regexp.new(/^https:\/\//)
       if !@redirection.nil? && @redirection !~ pattern
         invalid_properties.push("invalid value for \"redirection\", must conform to the pattern #{pattern}.")
@@ -160,11 +174,27 @@ module OpenapiClient
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @title.nil?
+      return false if !@media.nil? && @media !~ Regexp.new(/^https:\/\//)
       return false if !@redirection.nil? && @redirection !~ Regexp.new(/^https:\/\//)
       return false if !@actions.nil? && @actions.length > 4
       true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] media Value to be assigned
+    def media=(media)
+      if media.nil?
+        fail ArgumentError, 'media cannot be nil'
+      end
+
+      pattern = Regexp.new(/^https:\/\//)
+      if media !~ pattern
+        fail ArgumentError, "invalid value for \"media\", must conform to the pattern #{pattern}."
+      end
+
+      @media = media
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] redirection Value to be assigned
     def redirection=(redirection)
@@ -202,6 +232,7 @@ module OpenapiClient
           title == o.title &&
           message == o.message &&
           subtitle == o.subtitle &&
+          media == o.media &&
           redirection == o.redirection &&
           actions == o.actions &&
           payload == o.payload &&
@@ -219,7 +250,7 @@ module OpenapiClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [title, message, subtitle, redirection, actions, payload, badge, sound, target].hash
+      [title, message, subtitle, media, redirection, actions, payload, badge, sound, target].hash
     end
 
     # Builds the object from hash

data/generated/activitysmith_openapi/version.rb

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

data/lib/activitysmith/client.rb

@@ -11,6 +11,7 @@ module ActivitySmith
 
       config = OpenapiClient::Configuration.new
       config.access_token = api_key
+      config.user_agent = VersionedUserAgent.value if config.respond_to?(:user_agent=)
 
       api_client = OpenapiClient::ApiClient.new(config)
       @notifications = Notifications.new(OpenapiClient::PushNotificationsApi.new(api_client))

data/lib/activitysmith/notifications.rb

@@ -7,12 +7,16 @@ module ActivitySmith
     end
 
     def send(request, opts = {})
-      @api.send_push_notification(normalize_channels_target(request), opts)
+      normalized = normalize_channels_target(request)
+      assert_valid_media_actions!(normalized)
+      @api.send_push_notification(normalized, opts)
     end
 
     # Backward-compatible alias.
     def send_push_notification(push_notification_request, opts = {})
-      @api.send_push_notification(normalize_channels_target(push_notification_request), opts)
+      normalized = normalize_channels_target(push_notification_request)
+      assert_valid_media_actions!(normalized)
+      @api.send_push_notification(normalized, opts)
     end
 
     def method_missing(name, *args, &block)
@@ -49,5 +53,29 @@ module ActivitySmith
         []
       end
     end
+
+    def assert_valid_media_actions!(request)
+      media = request_value(request, :media)
+      actions = request_value(request, :actions)
+      has_media = media.is_a?(String) ? !media.strip.empty? : !media.nil?
+      has_actions = actions.respond_to?(:empty?) ? !actions.empty? : !actions.nil?
+
+      return unless has_media && has_actions
+
+      raise ArgumentError, "ActivitySmith: media cannot be combined with actions"
+    end
+
+    def request_value(request, key)
+      if request.is_a?(Hash)
+        return request[key] if request.key?(key)
+        return request[key.to_s] if request.key?(key.to_s)
+
+        return nil
+      end
+
+      return request.public_send(key) if request.respond_to?(key)
+
+      nil
+    end
   end
 end

data/lib/activitysmith/version.rb

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

data/lib/activitysmith/versioned_user_agent.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module ActivitySmith
+  module VersionedUserAgent
+    def self.value
+      "activitysmith-ruby/#{ActivitySmith::VERSION}"
+    end
+  end
+end

data/lib/activitysmith.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "activitysmith/version"
+require_relative "activitysmith/versioned_user_agent"
 require_relative "activitysmith/notifications"
 require_relative "activitysmith/live_activities"
 require_relative "activitysmith/client"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activitysmith
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.7
 platform: ruby
 authors:
 - ActivitySmith
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-02-26 00:00:00.000000000 Z
+date: 2026-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -109,6 +109,7 @@ files:
 - lib/activitysmith/live_activities.rb
 - lib/activitysmith/notifications.rb
 - lib/activitysmith/version.rb
+- lib/activitysmith/versioned_user_agent.rb
 homepage: https://activitysmith.com/docs/sdks/ruby
 licenses:
 - MIT