You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
**number_of_steps** | **int** | 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. | [optional]
12
-
**current_step** | **int** | Current step. Use for type=segmented_progress. | [optional]
13
-
**percentage** | **float** | Progress percentage (0–100). Use for type=progress. Takes precedence over value/upper_limit if both are provided. | [optional]
14
-
**value** | **float** | Current progress value. Use with upper_limit for type=progress. | [optional]
15
-
**upper_limit** | **float** | Maximum progress value. Use with value for type=progress. | [optional]
16
-
**metrics** | [**List[ActivityMetric]**](ActivityMetric.md) | Use for type=metrics or type=stats. | [optional]
17
-
**message** | **str** | Alert message. Use for type=alert. | [optional]
18
-
**icon** | [**LiveActivityAlertIcon**](LiveActivityAlertIcon.md) | Optional SF Symbol icon for type=alert. | [optional]
19
-
**badge** | [**LiveActivityAlertBadge**](LiveActivityAlertBadge.md) | Optional badge for type=alert. | [optional]
20
-
**type** | **str** | Optional. When omitted, the API uses the existing Live Activity type. | [optional]
21
-
**color** | **str** | Optional. Accent color for progress, segmented_progress, and metrics Live Activities. For Alert Live Activities, this tints the action button when action is included. | [optional]
22
-
**step_color** | **str** | Optional. Overrides color for the current step. Only applies to type=segmented_progress. | [optional]
23
-
**step_colors** | **List[str]** | Optional. Colors for completed steps. When used with segmented_progress, the array length should match current_step. | [optional]
9
+
**title** | **str** | |
10
+
**subtitle** | **str** | | [optional]
11
+
**number_of_steps** | **int** | 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. | [optional]
12
+
**current_step** | **int** | Current completed step count. Use for type=segmented_progress. Must be less than or equal to number_of_steps when number_of_steps is provided. | [optional]
13
+
**percentage** | **float** | Progress percentage (0–100). Use for type=progress. Takes precedence over value/upper_limit if both are provided. | [optional]
14
+
**value** | **float** | Current progress value. Use with upper_limit for type=progress. | [optional]
15
+
**upper_limit** | **float** | Maximum progress value. Use with value for type=progress. | [optional]
16
+
**metrics** | [**List[ActivityMetric]**](ActivityMetric.md) | Use for type=metrics or type=stats. | [optional]
17
+
**message** | **str** | Alert message. Use for type=alert. | [optional]
18
+
**icon** | [**LiveActivityAlertIcon**](LiveActivityAlertIcon.md) | Optional SF Symbol icon for type=alert. | [optional]
19
+
**badge** | [**LiveActivityAlertBadge**](LiveActivityAlertBadge.md) | Optional badge for type=alert. | [optional]
20
+
**type** | **str** | Optional. When omitted, the API uses the existing Live Activity type. | [optional]
21
+
**color** | **str** | Optional. Accent color for progress, segmented_progress, and metrics Live Activities. For Alert Live Activities, this tints the action button when action is included. | [optional]
22
+
**step_color** | **str** | Optional. Overrides color for the current step. Only applies to type=segmented_progress. | [optional]
23
+
**step_colors** | **List[str]** | Optional. Colors for completed steps. When used with segmented_progress, the array length should match current_step. | [optional]
24
24
**auto_dismiss_minutes** | **int** | 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. | [optional][default to 3]
**number_of_steps** | **int** | Total number of steps. Use for type=segmented_progress. This value can be increased or decreased later when updating or ending the same activity. | [optional]
12
-
**current_step** | **int** | Current step. Use for type=segmented_progress. | [optional]
13
-
**percentage** | **float** | Progress percentage (0–100). Use for type=progress. Takes precedence over value/upper_limit if both are provided. | [optional]
14
-
**value** | **float** | Current progress value. Use with upper_limit for type=progress. | [optional]
15
-
**upper_limit** | **float** | Maximum progress value. Use with value for type=progress. | [optional]
16
-
**metrics** | [**List[ActivityMetric]**](ActivityMetric.md) | Use for type=metrics or type=stats. | [optional]
17
-
**message** | **str** | Required for type=alert. | [optional]
18
-
**icon** | [**LiveActivityAlertIcon**](LiveActivityAlertIcon.md) | Optional SF Symbol icon for type=alert. | [optional]
19
-
**badge** | [**LiveActivityAlertBadge**](LiveActivityAlertBadge.md) | Optional badge for type=alert. | [optional]
20
-
**type** | **str** | |
21
-
**color** | **str** | Optional. Accent color for progress, segmented_progress, and metrics Live Activities. For Alert Live Activities, this tints the action button when action is included. | [optional]
22
-
**step_color** | **str** | Optional. Overrides color for the current step. Only applies to type=segmented_progress. | [optional]
23
-
**step_colors** | **List[str]** | Optional. Colors for completed steps. When used with segmented_progress, the array length should match current_step. | [optional]
9
+
**title** | **str** | |
10
+
**subtitle** | **str** | | [optional]
11
+
**number_of_steps** | **int** | Total number of steps. Use for type=segmented_progress. This value can be increased or decreased later when updating or ending the same activity. | [optional]
12
+
**current_step** | **int** | Current completed step count. Use for type=segmented_progress. Set 0 when the activity has started but no segment is complete yet. Must be less than or equal to number_of_steps. | [optional]
13
+
**percentage** | **float** | Progress percentage (0–100). Use for type=progress. Takes precedence over value/upper_limit if both are provided. | [optional]
14
+
**value** | **float** | Current progress value. Use with upper_limit for type=progress. | [optional]
15
+
**upper_limit** | **float** | Maximum progress value. Use with value for type=progress. | [optional]
16
+
**metrics** | [**List[ActivityMetric]**](ActivityMetric.md) | Use for type=metrics or type=stats. | [optional]
17
+
**message** | **str** | Required for type=alert. | [optional]
18
+
**icon** | [**LiveActivityAlertIcon**](LiveActivityAlertIcon.md) | Optional SF Symbol icon for type=alert. | [optional]
19
+
**badge** | [**LiveActivityAlertBadge**](LiveActivityAlertBadge.md) | Optional badge for type=alert. | [optional]
20
+
**type** | **str** | |
21
+
**color** | **str** | Optional. Accent color for progress, segmented_progress, and metrics Live Activities. For Alert Live Activities, this tints the action button when action is included. | [optional]
22
+
**step_color** | **str** | Optional. Overrides color for the current step. Only applies to type=segmented_progress. | [optional]
23
+
**step_colors** | **List[str]** | Optional. Colors for completed steps. When used with segmented_progress, the array length should match current_step. | [optional]
**number_of_steps** | **int** | Total number of steps. Use for type=segmented_progress. Optional on update, and safe to change if the workflow gains or loses steps. | [optional]
12
-
**current_step** | **int** | Current step. Use for type=segmented_progress. | [optional]
13
-
**percentage** | **float** | Progress percentage (0–100). Use for type=progress. Takes precedence over value/upper_limit if both are provided. | [optional]
14
-
**value** | **float** | Current progress value. Use with upper_limit for type=progress. | [optional]
15
-
**upper_limit** | **float** | Maximum progress value. Use with value for type=progress. | [optional]
16
-
**metrics** | [**List[ActivityMetric]**](ActivityMetric.md) | Use for type=metrics or type=stats. | [optional]
17
-
**message** | **str** | Alert message. Use for type=alert. | [optional]
18
-
**icon** | [**LiveActivityAlertIcon**](LiveActivityAlertIcon.md) | Optional SF Symbol icon for type=alert. | [optional]
19
-
**badge** | [**LiveActivityAlertBadge**](LiveActivityAlertBadge.md) | Optional badge for type=alert. | [optional]
20
-
**type** | **str** | Optional. When omitted, the API uses the existing Live Activity type. | [optional]
21
-
**color** | **str** | Optional. Accent color for progress, segmented_progress, and metrics Live Activities. For Alert Live Activities, this tints the action button when action is included. | [optional]
22
-
**step_color** | **str** | Optional. Overrides color for the current step. Only applies to type=segmented_progress. | [optional]
23
-
**step_colors** | **List[str]** | Optional. Colors for completed steps. When used with segmented_progress, the array length should match current_step. | [optional]
9
+
**title** | **str** | |
10
+
**subtitle** | **str** | | [optional]
11
+
**number_of_steps** | **int** | Total number of steps. Use for type=segmented_progress. Optional on update, and safe to change if the workflow gains or loses steps. | [optional]
12
+
**current_step** | **int** | Current completed step count. Use for type=segmented_progress. Set 0 when no segment is complete yet. Must be less than or equal to number_of_steps when number_of_steps is provided. | [optional]
13
+
**percentage** | **float** | Progress percentage (0–100). Use for type=progress. Takes precedence over value/upper_limit if both are provided. | [optional]
14
+
**value** | **float** | Current progress value. Use with upper_limit for type=progress. | [optional]
15
+
**upper_limit** | **float** | Maximum progress value. Use with value for type=progress. | [optional]
16
+
**metrics** | [**List[ActivityMetric]**](ActivityMetric.md) | Use for type=metrics or type=stats. | [optional]
17
+
**message** | **str** | Alert message. Use for type=alert. | [optional]
18
+
**icon** | [**LiveActivityAlertIcon**](LiveActivityAlertIcon.md) | Optional SF Symbol icon for type=alert. | [optional]
19
+
**badge** | [**LiveActivityAlertBadge**](LiveActivityAlertBadge.md) | Optional badge for type=alert. | [optional]
20
+
**type** | **str** | Optional. When omitted, the API uses the existing Live Activity type. | [optional]
21
+
**color** | **str** | Optional. Accent color for progress, segmented_progress, and metrics Live Activities. For Alert Live Activities, this tints the action button when action is included. | [optional]
22
+
**step_color** | **str** | Optional. Overrides color for the current step. Only applies to type=segmented_progress. | [optional]
23
+
**step_colors** | **List[str]** | Optional. Colors for completed steps. When used with segmented_progress, the array length should match current_step. | [optional]
**number_of_steps** | **int** | Use for segmented_progress. | [optional]
12
-
**current_step** | **int** | Use for segmented_progress. | [optional]
13
-
**percentage** | **float** | Use for progress. Takes precedence over value/upper_limit if both are provided. | [optional]
14
-
**value** | **float** | Current progress value. Use with upper_limit for progress. | [optional]
15
-
**upper_limit** | **float** | Maximum progress value. Use with value for progress. | [optional]
16
-
**type** | **str** | Required on the first PUT or whenever the stream cannot infer the current activity type. | [optional]
17
-
**color** | **str** | Optional. Accent color for progress, segmented_progress, and metrics Live Activities. For Alert Live Activities, this tints the action button when action is included. | [optional]
18
-
**step_color** | **str** | Optional. Overrides color for the current step. Only applies to segmented_progress. | [optional]
19
-
**step_colors** | **List[str]** | Optional. Colors for completed steps. When used with segmented_progress, the array length should match current_step. | [optional]
20
-
**metrics** | [**List[ActivityMetric]**](ActivityMetric.md) | Use for metrics and stats activities. | [optional]
21
-
**message** | **str** | Required for type=alert. | [optional]
22
-
**icon** | [**LiveActivityAlertIcon**](LiveActivityAlertIcon.md) | Optional SF Symbol icon for type=alert. | [optional]
23
-
**badge** | [**LiveActivityAlertBadge**](LiveActivityAlertBadge.md) | Optional badge for type=alert. | [optional]
24
-
**auto_dismiss_seconds** | **int** | Optional. Seconds before the ended Live Activity is dismissed. | [optional]
25
-
**auto_dismiss_minutes** | **int** | Optional. Minutes before the ended Live Activity is dismissed. | [optional]
9
+
**title** | **str** | |
10
+
**subtitle** | **str** | | [optional]
11
+
**number_of_steps** | **int** | Use for segmented_progress. | [optional]
12
+
**current_step** | **int** | Use for segmented_progress. Set 0 when no segment is complete yet. Must be less than or equal to number_of_steps when number_of_steps is provided. | [optional]
13
+
**percentage** | **float** | Use for progress. Takes precedence over value/upper_limit if both are provided. | [optional]
14
+
**value** | **float** | Current progress value. Use with upper_limit for progress. | [optional]
15
+
**upper_limit** | **float** | Maximum progress value. Use with value for progress. | [optional]
16
+
**type** | **str** | Required on the first PUT or whenever the stream cannot infer the current activity type. | [optional]
17
+
**color** | **str** | Optional. Accent color for progress, segmented_progress, and metrics Live Activities. For Alert Live Activities, this tints the action button when action is included. | [optional]
18
+
**step_color** | **str** | Optional. Overrides color for the current step. Only applies to segmented_progress. | [optional]
19
+
**step_colors** | **List[str]** | Optional. Colors for completed steps. When used with segmented_progress, the array length should match current_step. | [optional]
20
+
**metrics** | [**List[ActivityMetric]**](ActivityMetric.md) | Use for metrics and stats activities. | [optional]
21
+
**message** | **str** | Required for type=alert. | [optional]
22
+
**icon** | [**LiveActivityAlertIcon**](LiveActivityAlertIcon.md) | Optional SF Symbol icon for type=alert. | [optional]
23
+
**badge** | [**LiveActivityAlertBadge**](LiveActivityAlertBadge.md) | Optional badge for type=alert. | [optional]
24
+
**auto_dismiss_seconds** | **int** | Optional. Seconds before the ended Live Activity is dismissed. | [optional]
25
+
**auto_dismiss_minutes** | **int** | Optional. Minutes before the ended Live Activity is dismissed. | [optional]
Copy file name to clipboardExpand all lines: activitysmith_openapi/models/content_state_end.py
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -33,7 +33,7 @@ class ContentStateEnd(BaseModel):
33
33
title: StrictStr
34
34
subtitle: Optional[StrictStr] =None
35
35
number_of_steps: Optional[Annotated[int, Field(strict=True, ge=1)]] =Field(default=None, description="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.")
36
-
current_step: Optional[Annotated[int, Field(strict=True, ge=1)]] =Field(default=None, description="Current step. Use for type=segmented_progress.")
36
+
current_step: Optional[Annotated[int, Field(strict=True, ge=0)]] =Field(default=None, description="Current completed step count. Use for type=segmented_progress. Must be less than or equal to number_of_steps when number_of_steps is provided.")
37
37
percentage: Optional[Union[Annotated[float, Field(le=100, strict=True, ge=0)], Annotated[int, Field(le=100, strict=True, ge=0)]]] =Field(default=None, description="Progress percentage (0–100). Use for type=progress. Takes precedence over value/upper_limit if both are provided.")
38
38
value: Optional[Union[StrictFloat, StrictInt]] =Field(default=None, description="Current progress value. Use with upper_limit for type=progress.")
39
39
upper_limit: Optional[Union[StrictFloat, StrictInt]] =Field(default=None, description="Maximum progress value. Use with value for type=progress.")
Copy file name to clipboardExpand all lines: activitysmith_openapi/models/content_state_start.py
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -33,7 +33,7 @@ class ContentStateStart(BaseModel):
33
33
title: StrictStr
34
34
subtitle: Optional[StrictStr] =None
35
35
number_of_steps: Optional[Annotated[int, Field(strict=True, ge=1)]] =Field(default=None, description="Total number of steps. Use for type=segmented_progress. This value can be increased or decreased later when updating or ending the same activity.")
36
-
current_step: Optional[Annotated[int, Field(strict=True, ge=1)]] =Field(default=None, description="Current step. Use for type=segmented_progress.")
36
+
current_step: Optional[Annotated[int, Field(strict=True, ge=0)]] =Field(default=None, description="Current completed step count. Use for type=segmented_progress. Set 0 when the activity has started but no segment is complete yet. Must be less than or equal to number_of_steps.")
37
37
percentage: Optional[Union[Annotated[float, Field(le=100, strict=True, ge=0)], Annotated[int, Field(le=100, strict=True, ge=0)]]] =Field(default=None, description="Progress percentage (0–100). Use for type=progress. Takes precedence over value/upper_limit if both are provided.")
38
38
value: Optional[Union[StrictFloat, StrictInt]] =Field(default=None, description="Current progress value. Use with upper_limit for type=progress.")
39
39
upper_limit: Optional[Union[StrictFloat, StrictInt]] =Field(default=None, description="Maximum progress value. Use with value for type=progress.")
0 commit comments