Skip to content

Regenerate from OpenAPI 07738bae16fdfab301fe4a997cc1023f262e42eb #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bardonadam merged 1 commit into from
Mar 10, 2026
+18 −18
Merged

Regenerate from OpenAPI 07738bae16fdfab301fe4a997cc1023f262e42eb #23

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions generated/apis/LiveActivitiesApi.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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<runtime.ApiResponse<LiveActivityEndResponse>> {
Expand Down Expand Up @@ -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<LiveActivityEndResponse> {
Expand All @@ -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<runtime.ApiResponse<LiveActivityStartResponse>> {
Expand Down Expand Up @@ -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<LiveActivityStartResponse> {
Expand All @@ -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<runtime.ApiResponse<LiveActivityUpdateResponse>> {
Expand Down Expand Up @@ -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<LiveActivityUpdateResponse> {
Expand Down
24 changes: 12 additions & 12 deletions generated/models/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ export interface ChannelTarget {
channels: Array<string>;
}
/**
* 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
*/
Expand All @@ -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
*/
Expand Down Expand Up @@ -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
*/
Expand All @@ -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
*/
Expand Down Expand Up @@ -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
*/
Expand All @@ -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
*/
Expand Down Expand Up @@ -414,7 +414,7 @@ export interface ForbiddenError {
message: string;
}
/**
*
* End an existing Live Activity by activity_id.
* @export
* @interface LiveActivityEndRequest
*/
Expand All @@ -434,7 +434,7 @@ export interface LiveActivityEndRequest {
content_state: ContentStateEnd;
}
/**
*
* Returned after a Live Activity end event is sent or queued.
* @export
* @interface LiveActivityEndResponse
*/
Expand Down Expand Up @@ -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
*/
Expand All @@ -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
*/
Expand Down Expand Up @@ -574,7 +574,7 @@ export interface LiveActivityStartResponse {
timestamp: string;
}
/**
*
* Update an existing Live Activity by activity_id.
* @export
* @interface LiveActivityUpdateRequest
*/
Expand All @@ -594,7 +594,7 @@ export interface LiveActivityUpdateRequest {
content_state: ContentStateUpdate;
}
/**
*
* Returned after a Live Activity update is sent or queued.
* @export
* @interface LiveActivityUpdateResponse
*/
Expand Down
Loading