Skip to content
Merged
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
2 changes: 1 addition & 1 deletion activitysmith_openapi/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
""" # noqa: E501


__version__ = "1.4.2"
__version__ = "1.5.0"

# import apis into sdk package
from activitysmith_openapi.api.live_activities_api import LiveActivitiesApi
Expand Down
2 changes: 1 addition & 1 deletion activitysmith_openapi/api_client.py
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ def __init__(
self.default_headers[header_name] = header_value
self.cookie = cookie
# Set default User-Agent.
self.user_agent = 'OpenAPI-Generator/1.4.2/python'
self.user_agent = 'OpenAPI-Generator/1.5.0/python'
self.client_side_validation = configuration.client_side_validation

def __enter__(self):
Expand Down
2 changes: 1 addition & 1 deletion activitysmith_openapi/configuration.py
Original file line number Diff line number Diff line change
Expand Up @@ -393,7 +393,7 @@ def to_debug_report(self):
"OS: {env}\n"\
"Python Version: {pyversion}\n"\
"Version of the API: 1.0.0\n"\
"SDK Package Version: 1.4.2".\
"SDK Package Version: 1.5.0".\
format(env=sys.platform, pyversion=sys.version)

def get_host_settings(self):
Expand Down
30 changes: 15 additions & 15 deletions activitysmith_openapi/docs/ContentStateEnd.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,21 @@ End payload requires title. For segmented_progress include current_step and opti

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**title** | **str** | |
**subtitle** | **str** | | [optional]
**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]
**current_step** | **int** | Current step. Use for type=segmented_progress. | [optional]
**percentage** | **float** | Progress percentage (0–100). Use for type=progress. Takes precedence over value/upper_limit if both are provided. | [optional]
**value** | **float** | Current progress value. Use with upper_limit for type=progress. | [optional]
**upper_limit** | **float** | Maximum progress value. Use with value for type=progress. | [optional]
**metrics** | [**List[ActivityMetric]**](ActivityMetric.md) | Use for type=metrics or type=stats. | [optional]
**message** | **str** | Alert message. Use for type=alert. | [optional]
**icon** | [**LiveActivityAlertIcon**](LiveActivityAlertIcon.md) | Optional SF Symbol icon for type=alert. | [optional]
**badge** | [**LiveActivityAlertBadge**](LiveActivityAlertBadge.md) | Optional badge for type=alert. | [optional]
**type** | **str** | Optional. When omitted, the API uses the existing Live Activity type. | [optional]
**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]
**step_color** | **str** | Optional. Overrides color for the current step. Only applies to type=segmented_progress. | [optional]
**step_colors** | **List[str]** | Optional. Colors for completed steps. When used with segmented_progress, the array length should match current_step. | [optional]
**title** | **str** | |
**subtitle** | **str** | | [optional]
**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]
**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]
**percentage** | **float** | Progress percentage (0–100). Use for type=progress. Takes precedence over value/upper_limit if both are provided. | [optional]
**value** | **float** | Current progress value. Use with upper_limit for type=progress. | [optional]
**upper_limit** | **float** | Maximum progress value. Use with value for type=progress. | [optional]
**metrics** | [**List[ActivityMetric]**](ActivityMetric.md) | Use for type=metrics or type=stats. | [optional]
**message** | **str** | Alert message. Use for type=alert. | [optional]
**icon** | [**LiveActivityAlertIcon**](LiveActivityAlertIcon.md) | Optional SF Symbol icon for type=alert. | [optional]
**badge** | [**LiveActivityAlertBadge**](LiveActivityAlertBadge.md) | Optional badge for type=alert. | [optional]
**type** | **str** | Optional. When omitted, the API uses the existing Live Activity type. | [optional]
**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]
**step_color** | **str** | Optional. Overrides color for the current step. Only applies to type=segmented_progress. | [optional]
**step_colors** | **List[str]** | Optional. Colors for completed steps. When used with segmented_progress, the array length should match current_step. | [optional]
**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]

## Example
Expand Down
30 changes: 15 additions & 15 deletions activitysmith_openapi/docs/ContentStateStart.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,21 @@ Start payload requires title and type. For segmented_progress include number_of_

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**title** | **str** | |
**subtitle** | **str** | | [optional]
**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]
**current_step** | **int** | Current step. Use for type=segmented_progress. | [optional]
**percentage** | **float** | Progress percentage (0–100). Use for type=progress. Takes precedence over value/upper_limit if both are provided. | [optional]
**value** | **float** | Current progress value. Use with upper_limit for type=progress. | [optional]
**upper_limit** | **float** | Maximum progress value. Use with value for type=progress. | [optional]
**metrics** | [**List[ActivityMetric]**](ActivityMetric.md) | Use for type=metrics or type=stats. | [optional]
**message** | **str** | Required for type=alert. | [optional]
**icon** | [**LiveActivityAlertIcon**](LiveActivityAlertIcon.md) | Optional SF Symbol icon for type=alert. | [optional]
**badge** | [**LiveActivityAlertBadge**](LiveActivityAlertBadge.md) | Optional badge for type=alert. | [optional]
**type** | **str** | |
**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]
**step_color** | **str** | Optional. Overrides color for the current step. Only applies to type=segmented_progress. | [optional]
**step_colors** | **List[str]** | Optional. Colors for completed steps. When used with segmented_progress, the array length should match current_step. | [optional]
**title** | **str** | |
**subtitle** | **str** | | [optional]
**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]
**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]
**percentage** | **float** | Progress percentage (0–100). Use for type=progress. Takes precedence over value/upper_limit if both are provided. | [optional]
**value** | **float** | Current progress value. Use with upper_limit for type=progress. | [optional]
**upper_limit** | **float** | Maximum progress value. Use with value for type=progress. | [optional]
**metrics** | [**List[ActivityMetric]**](ActivityMetric.md) | Use for type=metrics or type=stats. | [optional]
**message** | **str** | Required for type=alert. | [optional]
**icon** | [**LiveActivityAlertIcon**](LiveActivityAlertIcon.md) | Optional SF Symbol icon for type=alert. | [optional]
**badge** | [**LiveActivityAlertBadge**](LiveActivityAlertBadge.md) | Optional badge for type=alert. | [optional]
**type** | **str** | |
**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]
**step_color** | **str** | Optional. Overrides color for the current step. Only applies to type=segmented_progress. | [optional]
**step_colors** | **List[str]** | Optional. Colors for completed steps. When used with segmented_progress, the array length should match current_step. | [optional]

## Example

Expand Down
30 changes: 15 additions & 15 deletions activitysmith_openapi/docs/ContentStateUpdate.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,21 @@ Update payload requires title. For segmented_progress include current_step and o

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**title** | **str** | |
**subtitle** | **str** | | [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]
**current_step** | **int** | Current step. Use for type=segmented_progress. | [optional]
**percentage** | **float** | Progress percentage (0–100). Use for type=progress. Takes precedence over value/upper_limit if both are provided. | [optional]
**value** | **float** | Current progress value. Use with upper_limit for type=progress. | [optional]
**upper_limit** | **float** | Maximum progress value. Use with value for type=progress. | [optional]
**metrics** | [**List[ActivityMetric]**](ActivityMetric.md) | Use for type=metrics or type=stats. | [optional]
**message** | **str** | Alert message. Use for type=alert. | [optional]
**icon** | [**LiveActivityAlertIcon**](LiveActivityAlertIcon.md) | Optional SF Symbol icon for type=alert. | [optional]
**badge** | [**LiveActivityAlertBadge**](LiveActivityAlertBadge.md) | Optional badge for type=alert. | [optional]
**type** | **str** | Optional. When omitted, the API uses the existing Live Activity type. | [optional]
**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]
**step_color** | **str** | Optional. Overrides color for the current step. Only applies to type=segmented_progress. | [optional]
**step_colors** | **List[str]** | Optional. Colors for completed steps. When used with segmented_progress, the array length should match current_step. | [optional]
**title** | **str** | |
**subtitle** | **str** | | [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]
**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]
**percentage** | **float** | Progress percentage (0–100). Use for type=progress. Takes precedence over value/upper_limit if both are provided. | [optional]
**value** | **float** | Current progress value. Use with upper_limit for type=progress. | [optional]
**upper_limit** | **float** | Maximum progress value. Use with value for type=progress. | [optional]
**metrics** | [**List[ActivityMetric]**](ActivityMetric.md) | Use for type=metrics or type=stats. | [optional]
**message** | **str** | Alert message. Use for type=alert. | [optional]
**icon** | [**LiveActivityAlertIcon**](LiveActivityAlertIcon.md) | Optional SF Symbol icon for type=alert. | [optional]
**badge** | [**LiveActivityAlertBadge**](LiveActivityAlertBadge.md) | Optional badge for type=alert. | [optional]
**type** | **str** | Optional. When omitted, the API uses the existing Live Activity type. | [optional]
**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]
**step_color** | **str** | Optional. Overrides color for the current step. Only applies to type=segmented_progress. | [optional]
**step_colors** | **List[str]** | Optional. Colors for completed steps. When used with segmented_progress, the array length should match current_step. | [optional]

## Example

Expand Down
34 changes: 17 additions & 17 deletions activitysmith_openapi/docs/StreamContentState.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,23 +6,23 @@ Current state for a managed Live Activity stream. Include type on the first PUT,

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**title** | **str** | |
**subtitle** | **str** | | [optional]
**number_of_steps** | **int** | Use for segmented_progress. | [optional]
**current_step** | **int** | Use for segmented_progress. | [optional]
**percentage** | **float** | Use for progress. Takes precedence over value/upper_limit if both are provided. | [optional]
**value** | **float** | Current progress value. Use with upper_limit for progress. | [optional]
**upper_limit** | **float** | Maximum progress value. Use with value for progress. | [optional]
**type** | **str** | Required on the first PUT or whenever the stream cannot infer the current activity type. | [optional]
**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]
**step_color** | **str** | Optional. Overrides color for the current step. Only applies to segmented_progress. | [optional]
**step_colors** | **List[str]** | Optional. Colors for completed steps. When used with segmented_progress, the array length should match current_step. | [optional]
**metrics** | [**List[ActivityMetric]**](ActivityMetric.md) | Use for metrics and stats activities. | [optional]
**message** | **str** | Required for type=alert. | [optional]
**icon** | [**LiveActivityAlertIcon**](LiveActivityAlertIcon.md) | Optional SF Symbol icon for type=alert. | [optional]
**badge** | [**LiveActivityAlertBadge**](LiveActivityAlertBadge.md) | Optional badge for type=alert. | [optional]
**auto_dismiss_seconds** | **int** | Optional. Seconds before the ended Live Activity is dismissed. | [optional]
**auto_dismiss_minutes** | **int** | Optional. Minutes before the ended Live Activity is dismissed. | [optional]
**title** | **str** | |
**subtitle** | **str** | | [optional]
**number_of_steps** | **int** | Use for segmented_progress. | [optional]
**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]
**percentage** | **float** | Use for progress. Takes precedence over value/upper_limit if both are provided. | [optional]
**value** | **float** | Current progress value. Use with upper_limit for progress. | [optional]
**upper_limit** | **float** | Maximum progress value. Use with value for progress. | [optional]
**type** | **str** | Required on the first PUT or whenever the stream cannot infer the current activity type. | [optional]
**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]
**step_color** | **str** | Optional. Overrides color for the current step. Only applies to segmented_progress. | [optional]
**step_colors** | **List[str]** | Optional. Colors for completed steps. When used with segmented_progress, the array length should match current_step. | [optional]
**metrics** | [**List[ActivityMetric]**](ActivityMetric.md) | Use for metrics and stats activities. | [optional]
**message** | **str** | Required for type=alert. | [optional]
**icon** | [**LiveActivityAlertIcon**](LiveActivityAlertIcon.md) | Optional SF Symbol icon for type=alert. | [optional]
**badge** | [**LiveActivityAlertBadge**](LiveActivityAlertBadge.md) | Optional badge for type=alert. | [optional]
**auto_dismiss_seconds** | **int** | Optional. Seconds before the ended Live Activity is dismissed. | [optional]
**auto_dismiss_minutes** | **int** | Optional. Minutes before the ended Live Activity is dismissed. | [optional]

## Example

Expand Down
2 changes: 1 addition & 1 deletion activitysmith_openapi/models/content_state_end.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ class ContentStateEnd(BaseModel):
title: StrictStr
subtitle: Optional[StrictStr] = None
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.")
current_step: Optional[Annotated[int, Field(strict=True, ge=1)]] = Field(default=None, description="Current step. Use for type=segmented_progress.")
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.")
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.")
value: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Current progress value. Use with upper_limit for type=progress.")
upper_limit: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Maximum progress value. Use with value for type=progress.")
Expand Down
2 changes: 1 addition & 1 deletion activitysmith_openapi/models/content_state_start.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ class ContentStateStart(BaseModel):
title: StrictStr
subtitle: Optional[StrictStr] = None
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.")
current_step: Optional[Annotated[int, Field(strict=True, ge=1)]] = Field(default=None, description="Current step. Use for type=segmented_progress.")
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.")
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.")
value: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Current progress value. Use with upper_limit for type=progress.")
upper_limit: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Maximum progress value. Use with value for type=progress.")
Expand Down
Loading