From 9d55806db24cfa1ab524d0f06468609d1f305a0a Mon Sep 17 00:00:00 2001 From: activitysmith-bot Date: Tue, 10 Mar 2026 18:46:03 +0000 Subject: [PATCH] chore: regenerate SDK --- generated/apis/LiveActivitiesApi.ts | 12 ++++++------ generated/models/index.ts | 24 ++++++++++++------------ 2 files changed, 18 insertions(+), 18 deletions(-) diff --git a/generated/apis/LiveActivitiesApi.ts b/generated/apis/LiveActivitiesApi.ts index 5092c7a..9faeebc 100644 --- a/generated/apis/LiveActivitiesApi.ts +++ b/generated/apis/LiveActivitiesApi.ts @@ -45,7 +45,7 @@ export interface UpdateLiveActivityRequest { export class LiveActivitiesApi extends runtime.BaseAPI { /** - * 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. * End a Live Activity */ async endLiveActivityRaw(requestParameters: EndLiveActivityRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise> { @@ -82,7 +82,7 @@ export class LiveActivitiesApi extends runtime.BaseAPI { } /** - * 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. * End a Live Activity */ async endLiveActivity(requestParameters: EndLiveActivityRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise { @@ -91,7 +91,7 @@ export class LiveActivitiesApi extends runtime.BaseAPI { } /** - * 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. * Start a Live Activity */ async startLiveActivityRaw(requestParameters: StartLiveActivityRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise> { @@ -128,7 +128,7 @@ export class LiveActivitiesApi extends runtime.BaseAPI { } /** - * 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. * Start a Live Activity */ async startLiveActivity(requestParameters: StartLiveActivityRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise { @@ -137,7 +137,7 @@ export class LiveActivitiesApi extends runtime.BaseAPI { } /** - * 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. * Update a Live Activity */ async updateLiveActivityRaw(requestParameters: UpdateLiveActivityRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise> { @@ -174,7 +174,7 @@ export class LiveActivitiesApi extends runtime.BaseAPI { } /** - * 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. * Update a Live Activity */ async updateLiveActivity(requestParameters: UpdateLiveActivityRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise { diff --git a/generated/models/index.ts b/generated/models/index.ts index c0509ea..cfc974d 100644 --- a/generated/models/index.ts +++ b/generated/models/index.ts @@ -55,7 +55,7 @@ export interface ChannelTarget { channels: Array; } /** - * 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. * @export * @interface ContentStateEnd */ @@ -74,7 +74,7 @@ export interface ContentStateEnd { */ subtitle?: string; /** - * 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. * @type {number} * @memberof ContentStateEnd */ @@ -172,7 +172,7 @@ export const ContentStateEndStepColorEnum = { export type ContentStateEndStepColorEnum = typeof ContentStateEndStepColorEnum[keyof typeof ContentStateEndStepColorEnum]; /** - * 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. * @export * @interface ContentStateStart */ @@ -191,7 +191,7 @@ export interface ContentStateStart { */ subtitle?: string; /** - * 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. * @type {number} * @memberof ContentStateStart */ @@ -283,7 +283,7 @@ export const ContentStateStartStepColorEnum = { export type ContentStateStartStepColorEnum = typeof ContentStateStartStepColorEnum[keyof typeof ContentStateStartStepColorEnum]; /** - * 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. * @export * @interface ContentStateUpdate */ @@ -302,7 +302,7 @@ export interface ContentStateUpdate { */ subtitle?: string; /** - * 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. * @type {number} * @memberof ContentStateUpdate */ @@ -414,7 +414,7 @@ export interface ForbiddenError { message: string; } /** - * + * End an existing Live Activity by activity_id. * @export * @interface LiveActivityEndRequest */ @@ -434,7 +434,7 @@ export interface LiveActivityEndRequest { content_state: ContentStateEnd; } /** - * + * Returned after a Live Activity end event is sent or queued. * @export * @interface LiveActivityEndResponse */ @@ -504,7 +504,7 @@ export interface LiveActivityLimitError { active: number; } /** - * + * Start a new Live Activity. The response includes activity_id for later update and end calls. * @export * @interface LiveActivityStartRequest */ @@ -530,7 +530,7 @@ export interface LiveActivityStartRequest { target?: ChannelTarget; } /** - * + * Returned after a Live Activity starts. Save activity_id and use it for all later updates and for the final end call. * @export * @interface LiveActivityStartResponse */ @@ -574,7 +574,7 @@ export interface LiveActivityStartResponse { timestamp: string; } /** - * + * Update an existing Live Activity by activity_id. * @export * @interface LiveActivityUpdateRequest */ @@ -594,7 +594,7 @@ export interface LiveActivityUpdateRequest { content_state: ContentStateUpdate; } /** - * + * Returned after a Live Activity update is sent or queued. * @export * @interface LiveActivityUpdateResponse */