Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ export interface UpdateLiveActivityRequest {
export class LiveActivitiesApi extends runtime.BaseAPI {

/**
* 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.
* Ends a Live Activity and archives its lifecycle. Supports segmented_progress, progress, metrics, and stats activity types. 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 @@ -98,7 +98,7 @@ export class LiveActivitiesApi extends runtime.BaseAPI {
}

/**
* 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.
* Ends a Live Activity and archives its lifecycle. Supports segmented_progress, progress, metrics, and stats activity types. 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 Down Expand Up @@ -206,7 +206,7 @@ export class LiveActivitiesApi extends runtime.BaseAPI {
}

/**
* 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.
* Starts a Live Activity on devices matched by API key scope and optional target channels. Supports segmented_progress, progress, metrics, and stats activity types. 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 @@ -243,7 +243,7 @@ export class LiveActivitiesApi extends runtime.BaseAPI {
}

/**
* 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.
* Starts a Live Activity on devices matched by API key scope and optional target channels. Supports segmented_progress, progress, metrics, and stats activity types. 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 @@ -252,7 +252,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. 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.
* Updates an existing Live Activity. If the per-activity token is not registered yet, the update is queued. Supports segmented_progress, progress, metrics, and stats activity types. 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 @@ -289,7 +289,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. 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.
* Updates an existing Live Activity. If the per-activity token is not registered yet, the update is queued. Supports segmented_progress, progress, metrics, and stats activity types. 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
34 changes: 16 additions & 18 deletions generated/models/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,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. For metrics include a non-empty metrics array. Type is optional when ending an existing activity. You can send an updated number_of_steps here if the workflow changed after start.
* End payload requires title. For segmented_progress include current_step and optionally number_of_steps. For progress include percentage or value with upper_limit. For metrics and stats include a non-empty metrics array. 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 Down Expand Up @@ -130,7 +130,7 @@ export interface ContentStateEnd {
*/
upper_limit?: number;
/**
* Use for type=metrics.
* Use for type=metrics or type=stats.
* @type {Array<ActivityMetric>}
* @memberof ContentStateEnd
*/
Expand Down Expand Up @@ -174,7 +174,8 @@ export interface ContentStateEnd {
export const ContentStateEndTypeEnum = {
SegmentedProgress: 'segmented_progress',
Progress: 'progress',
Metrics: 'metrics'
Metrics: 'metrics',
Stats: 'stats'
} as const;
export type ContentStateEndTypeEnum = typeof ContentStateEndTypeEnum[keyof typeof ContentStateEndTypeEnum];

Expand Down Expand Up @@ -227,7 +228,7 @@ export const ContentStateEndStepColorsEnum = {
export type ContentStateEndStepColorsEnum = typeof ContentStateEndStepColorsEnum[keyof typeof ContentStateEndStepColorsEnum];

/**
* 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 metrics include a non-empty metrics array. For segmented_progress, number_of_steps is not locked and can be changed in later update or end calls.
* 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 metrics and stats include a non-empty metrics array. For segmented_progress, number_of_steps is not locked and can be changed in later update or end calls.
* @export
* @interface ContentStateStart
*/
Expand Down Expand Up @@ -276,7 +277,7 @@ export interface ContentStateStart {
*/
upper_limit?: number;
/**
* Use for type=metrics.
* Use for type=metrics or type=stats.
* @type {Array<ActivityMetric>}
* @memberof ContentStateStart
*/
Expand Down Expand Up @@ -314,7 +315,8 @@ export interface ContentStateStart {
export const ContentStateStartTypeEnum = {
SegmentedProgress: 'segmented_progress',
Progress: 'progress',
Metrics: 'metrics'
Metrics: 'metrics',
Stats: 'stats'
} as const;
export type ContentStateStartTypeEnum = typeof ContentStateStartTypeEnum[keyof typeof ContentStateStartTypeEnum];

Expand Down Expand Up @@ -367,7 +369,7 @@ export const ContentStateStartStepColorsEnum = {
export type ContentStateStartStepColorsEnum = typeof ContentStateStartStepColorsEnum[keyof typeof ContentStateStartStepColorsEnum];

/**
* Update payload requires title. For segmented_progress include current_step and optionally number_of_steps. For progress include percentage or value with upper_limit. For metrics include a non-empty metrics array. Type is optional when updating an existing activity. You can increase or decrease number_of_steps during updates.
* Update payload requires title. For segmented_progress include current_step and optionally number_of_steps. For progress include percentage or value with upper_limit. For metrics and stats include a non-empty metrics array. Type is optional when updating an existing activity. You can increase or decrease number_of_steps during updates.
* @export
* @interface ContentStateUpdate
*/
Expand Down Expand Up @@ -416,7 +418,7 @@ export interface ContentStateUpdate {
*/
upper_limit?: number;
/**
* Use for type=metrics.
* Use for type=metrics or type=stats.
* @type {Array<ActivityMetric>}
* @memberof ContentStateUpdate
*/
Expand Down Expand Up @@ -454,7 +456,8 @@ export interface ContentStateUpdate {
export const ContentStateUpdateTypeEnum = {
SegmentedProgress: 'segmented_progress',
Progress: 'progress',
Metrics: 'metrics'
Metrics: 'metrics',
Stats: 'stats'
} as const;
export type ContentStateUpdateTypeEnum = typeof ContentStateUpdateTypeEnum[keyof typeof ContentStateUpdateTypeEnum];

Expand Down Expand Up @@ -1061,12 +1064,6 @@ export interface MetricValueUpdateRequest {
* @memberof MetricValueUpdateRequest
*/
value: MetricValueUpdateRequestValue;
/**
* Optional ISO timestamp for when the metric value was measured. Defaults to the server receive time.
* @type {string}
* @memberof MetricValueUpdateRequest
*/
timestamp?: string;
}
/**
* @type MetricValueUpdateRequestValue
Expand Down Expand Up @@ -1327,7 +1324,7 @@ export interface RateLimitError {
*/
export type SendPushNotification429Response = LiveActivityLimitError | RateLimitError;
/**
* Current state for a managed Live Activity stream. Include type on the first PUT, and whenever the stream may need to start a fresh activity. Supports segmented_progress, progress, and metrics types.
* Current state for a managed Live Activity stream. Include type on the first PUT, and whenever the stream may need to start a fresh activity. Supports segmented_progress, progress, metrics, and stats types.
* @export
* @interface StreamContentState
*/
Expand Down Expand Up @@ -1400,7 +1397,7 @@ export interface StreamContentState {
*/
step_colors?: Array<StreamContentStateStepColorsEnum>;
/**
* Use for metrics activities.
* Use for metrics and stats activities.
* @type {Array<ActivityMetric>}
* @memberof StreamContentState
*/
Expand All @@ -1426,7 +1423,8 @@ export interface StreamContentState {
export const StreamContentStateTypeEnum = {
SegmentedProgress: 'segmented_progress',
Progress: 'progress',
Metrics: 'metrics'
Metrics: 'metrics',
Stats: 'stats'
} as const;
export type StreamContentStateTypeEnum = typeof StreamContentStateTypeEnum[keyof typeof StreamContentStateTypeEnum];

Expand Down