diff --git a/generated/activitysmith_openapi/api/live_activities_api.rb b/generated/activitysmith_openapi/api/live_activities_api.rb index 0661b38..214cf1f 100644 --- a/generated/activitysmith_openapi/api/live_activities_api.rb +++ b/generated/activitysmith_openapi/api/live_activities_api.rb @@ -20,7 +20,7 @@ def initialize(api_client = ApiClient.default) @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 @@ def end_live_activity(live_activity_end_request, opts = {}) 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 @@ def end_live_activity_with_http_info(live_activity_end_request, opts = {}) 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 @@ def start_live_activity(live_activity_start_request, opts = {}) 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 @@ def start_live_activity_with_http_info(live_activity_start_request, opts = {}) 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 @@ def update_live_activity(live_activity_update_request, opts = {}) 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 diff --git a/generated/activitysmith_openapi/models/content_state_end.rb b/generated/activitysmith_openapi/models/content_state_end.rb index d3420ef..23de9dc 100644 --- a/generated/activitysmith_openapi/models/content_state_end.rb +++ b/generated/activitysmith_openapi/models/content_state_end.rb @@ -14,13 +14,13 @@ 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. Type is optional when ending an existing activity. + # 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. + # 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. diff --git a/generated/activitysmith_openapi/models/content_state_start.rb b/generated/activitysmith_openapi/models/content_state_start.rb index 6423b5f..88b3daf 100644 --- a/generated/activitysmith_openapi/models/content_state_start.rb +++ b/generated/activitysmith_openapi/models/content_state_start.rb @@ -14,13 +14,13 @@ 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. + # 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. + # 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. diff --git a/generated/activitysmith_openapi/models/content_state_update.rb b/generated/activitysmith_openapi/models/content_state_update.rb index bcf3081..8c83307 100644 --- a/generated/activitysmith_openapi/models/content_state_update.rb +++ b/generated/activitysmith_openapi/models/content_state_update.rb @@ -14,13 +14,13 @@ 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. Type is optional when updating an existing activity. + # 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. + # 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. diff --git a/generated/activitysmith_openapi/models/live_activity_end_request.rb b/generated/activitysmith_openapi/models/live_activity_end_request.rb index f448596..de9cf25 100644 --- a/generated/activitysmith_openapi/models/live_activity_end_request.rb +++ b/generated/activitysmith_openapi/models/live_activity_end_request.rb @@ -14,6 +14,7 @@ require 'time' module OpenapiClient + # End an existing Live Activity by activity_id. class LiveActivityEndRequest attr_accessor :activity_id diff --git a/generated/activitysmith_openapi/models/live_activity_end_response.rb b/generated/activitysmith_openapi/models/live_activity_end_response.rb index 6661b52..13d41d3 100644 --- a/generated/activitysmith_openapi/models/live_activity_end_response.rb +++ b/generated/activitysmith_openapi/models/live_activity_end_response.rb @@ -14,6 +14,7 @@ require 'time' module OpenapiClient + # Returned after a Live Activity end event is sent or queued. class LiveActivityEndResponse attr_accessor :success diff --git a/generated/activitysmith_openapi/models/live_activity_start_request.rb b/generated/activitysmith_openapi/models/live_activity_start_request.rb index 347aacf..c315d29 100644 --- a/generated/activitysmith_openapi/models/live_activity_start_request.rb +++ b/generated/activitysmith_openapi/models/live_activity_start_request.rb @@ -14,6 +14,7 @@ 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 diff --git a/generated/activitysmith_openapi/models/live_activity_start_response.rb b/generated/activitysmith_openapi/models/live_activity_start_response.rb index ac71346..cbb3288 100644 --- a/generated/activitysmith_openapi/models/live_activity_start_response.rb +++ b/generated/activitysmith_openapi/models/live_activity_start_response.rb @@ -14,6 +14,7 @@ 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 diff --git a/generated/activitysmith_openapi/models/live_activity_update_request.rb b/generated/activitysmith_openapi/models/live_activity_update_request.rb index faf3102..d42ee37 100644 --- a/generated/activitysmith_openapi/models/live_activity_update_request.rb +++ b/generated/activitysmith_openapi/models/live_activity_update_request.rb @@ -14,6 +14,7 @@ require 'time' module OpenapiClient + # Update an existing Live Activity by activity_id. class LiveActivityUpdateRequest attr_accessor :activity_id diff --git a/generated/activitysmith_openapi/models/live_activity_update_response.rb b/generated/activitysmith_openapi/models/live_activity_update_response.rb index 6d4f2fb..a3d6303 100644 --- a/generated/activitysmith_openapi/models/live_activity_update_response.rb +++ b/generated/activitysmith_openapi/models/live_activity_update_response.rb @@ -14,6 +14,7 @@ require 'time' module OpenapiClient + # Returned after a Live Activity update is sent or queued. class LiveActivityUpdateResponse attr_accessor :success