From 612051a7c0cf9e3ce69b8c6138375475e5915a12 Mon Sep 17 00:00:00 2001 From: activitysmith-bot Date: Thu, 14 May 2026 09:23:29 +0000 Subject: [PATCH] chore: regenerate SDK --- .../api/live_activities_api.py | 48 +++++++++---------- .../docs/LiveActivitiesApi.md | 32 ++++++------- .../test/test_live_activities_api.py | 8 ++-- 3 files changed, 44 insertions(+), 44 deletions(-) diff --git a/activitysmith_openapi/api/live_activities_api.py b/activitysmith_openapi/api/live_activities_api.py index 8e51373..20a2a2f 100644 --- a/activitysmith_openapi/api/live_activities_api.py +++ b/activitysmith_openapi/api/live_activities_api.py @@ -65,9 +65,9 @@ def end_live_activity( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> LiveActivityEndResponse: - """End a Live Activity + """End a Live Activity (legacy manual lifecycle) - 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. + Legacy manual lifecycle endpoint. For new integrations, use DELETE /live-activity/stream/{stream_key} to end a managed Live Activity stream. This endpoint remains supported for existing integrations and advanced lifecycle control. 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. :param live_activity_end_request: (required) :type live_activity_end_request: LiveActivityEndRequest @@ -134,9 +134,9 @@ def end_live_activity_with_http_info( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> ApiResponse[LiveActivityEndResponse]: - """End a Live Activity + """End a Live Activity (legacy manual lifecycle) - 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. + Legacy manual lifecycle endpoint. For new integrations, use DELETE /live-activity/stream/{stream_key} to end a managed Live Activity stream. This endpoint remains supported for existing integrations and advanced lifecycle control. 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. :param live_activity_end_request: (required) :type live_activity_end_request: LiveActivityEndRequest @@ -203,9 +203,9 @@ def end_live_activity_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """End a Live Activity + """End a Live Activity (legacy manual lifecycle) - 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. + Legacy manual lifecycle endpoint. For new integrations, use DELETE /live-activity/stream/{stream_key} to end a managed Live Activity stream. This endpoint remains supported for existing integrations and advanced lifecycle control. 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. :param live_activity_end_request: (required) :type live_activity_end_request: LiveActivityEndRequest @@ -640,9 +640,9 @@ def reconcile_live_activity_stream( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> LiveActivityStreamPutResponse: - """Send a stream update + """Start a new Live Activity or update an existing one - Use this endpoint when you want the easiest, stateless way to trigger Live Activities. You do not need to store activity_id or manage the Live Activity lifecycle yourself. Send the latest state for a stable stream_key and ActivitySmith will handle the rest for you: if there is no Live Activity yet, it starts one; if there is already one for this stream, it updates it. If you need direct lifecycle control, use /live-activity/start, /live-activity/update, and /live-activity/end instead. + Use a stable stream_key for each ongoing thing you want to show as a Live Activity. Send the latest content_state whenever it changes, and ActivitySmith will keep the Live Activity in sync. :param stream_key: Stable identifier for one ongoing thing. Allowed characters: letters, numbers, underscores, and hyphens. (required) :type stream_key: str @@ -715,9 +715,9 @@ def reconcile_live_activity_stream_with_http_info( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> ApiResponse[LiveActivityStreamPutResponse]: - """Send a stream update + """Start a new Live Activity or update an existing one - Use this endpoint when you want the easiest, stateless way to trigger Live Activities. You do not need to store activity_id or manage the Live Activity lifecycle yourself. Send the latest state for a stable stream_key and ActivitySmith will handle the rest for you: if there is no Live Activity yet, it starts one; if there is already one for this stream, it updates it. If you need direct lifecycle control, use /live-activity/start, /live-activity/update, and /live-activity/end instead. + Use a stable stream_key for each ongoing thing you want to show as a Live Activity. Send the latest content_state whenever it changes, and ActivitySmith will keep the Live Activity in sync. :param stream_key: Stable identifier for one ongoing thing. Allowed characters: letters, numbers, underscores, and hyphens. (required) :type stream_key: str @@ -790,9 +790,9 @@ def reconcile_live_activity_stream_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Send a stream update + """Start a new Live Activity or update an existing one - Use this endpoint when you want the easiest, stateless way to trigger Live Activities. You do not need to store activity_id or manage the Live Activity lifecycle yourself. Send the latest state for a stable stream_key and ActivitySmith will handle the rest for you: if there is no Live Activity yet, it starts one; if there is already one for this stream, it updates it. If you need direct lifecycle control, use /live-activity/start, /live-activity/update, and /live-activity/end instead. + Use a stable stream_key for each ongoing thing you want to show as a Live Activity. Send the latest content_state whenever it changes, and ActivitySmith will keep the Live Activity in sync. :param stream_key: Stable identifier for one ongoing thing. Allowed characters: letters, numbers, underscores, and hyphens. (required) :type stream_key: str @@ -938,9 +938,9 @@ def start_live_activity( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> LiveActivityStartResponse: - """Start a Live Activity + """Start a Live Activity (legacy manual lifecycle) - 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. + Legacy manual lifecycle endpoint. For new integrations, use PUT /live-activity/stream/{stream_key} so ActivitySmith can manage start, update, rotation, and end state for you. This endpoint remains supported for existing integrations and advanced lifecycle control. 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. :param live_activity_start_request: (required) :type live_activity_start_request: LiveActivityStartRequest @@ -1009,9 +1009,9 @@ def start_live_activity_with_http_info( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> ApiResponse[LiveActivityStartResponse]: - """Start a Live Activity + """Start a Live Activity (legacy manual lifecycle) - 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. + Legacy manual lifecycle endpoint. For new integrations, use PUT /live-activity/stream/{stream_key} so ActivitySmith can manage start, update, rotation, and end state for you. This endpoint remains supported for existing integrations and advanced lifecycle control. 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. :param live_activity_start_request: (required) :type live_activity_start_request: LiveActivityStartRequest @@ -1080,9 +1080,9 @@ def start_live_activity_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Start a Live Activity + """Start a Live Activity (legacy manual lifecycle) - 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. + Legacy manual lifecycle endpoint. For new integrations, use PUT /live-activity/stream/{stream_key} so ActivitySmith can manage start, update, rotation, and end state for you. This endpoint remains supported for existing integrations and advanced lifecycle control. 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. :param live_activity_start_request: (required) :type live_activity_start_request: LiveActivityStartRequest @@ -1222,9 +1222,9 @@ def update_live_activity( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> LiveActivityUpdateResponse: - """Update a Live Activity + """Update a Live Activity (legacy manual lifecycle) - 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. + Legacy manual lifecycle endpoint. For new integrations, use PUT /live-activity/stream/{stream_key} so ActivitySmith can manage start, update, rotation, and end state for you. This endpoint remains supported for existing integrations and advanced lifecycle control. 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. :param live_activity_update_request: (required) :type live_activity_update_request: LiveActivityUpdateRequest @@ -1291,9 +1291,9 @@ def update_live_activity_with_http_info( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> ApiResponse[LiveActivityUpdateResponse]: - """Update a Live Activity + """Update a Live Activity (legacy manual lifecycle) - 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. + Legacy manual lifecycle endpoint. For new integrations, use PUT /live-activity/stream/{stream_key} so ActivitySmith can manage start, update, rotation, and end state for you. This endpoint remains supported for existing integrations and advanced lifecycle control. 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. :param live_activity_update_request: (required) :type live_activity_update_request: LiveActivityUpdateRequest @@ -1360,9 +1360,9 @@ def update_live_activity_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Update a Live Activity + """Update a Live Activity (legacy manual lifecycle) - 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. + Legacy manual lifecycle endpoint. For new integrations, use PUT /live-activity/stream/{stream_key} so ActivitySmith can manage start, update, rotation, and end state for you. This endpoint remains supported for existing integrations and advanced lifecycle control. 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. :param live_activity_update_request: (required) :type live_activity_update_request: LiveActivityUpdateRequest diff --git a/activitysmith_openapi/docs/LiveActivitiesApi.md b/activitysmith_openapi/docs/LiveActivitiesApi.md index 423e2a2..dfa668e 100644 --- a/activitysmith_openapi/docs/LiveActivitiesApi.md +++ b/activitysmith_openapi/docs/LiveActivitiesApi.md @@ -4,19 +4,19 @@ All URIs are relative to *https://activitysmith.com/api* Method | HTTP request | Description ------------- | ------------- | ------------- -[**end_live_activity**](LiveActivitiesApi.md#end_live_activity) | **POST** /live-activity/end | End a Live Activity +[**end_live_activity**](LiveActivitiesApi.md#end_live_activity) | **POST** /live-activity/end | End a Live Activity (legacy manual lifecycle) [**end_live_activity_stream**](LiveActivitiesApi.md#end_live_activity_stream) | **DELETE** /live-activity/stream/{stream_key} | End a stream -[**reconcile_live_activity_stream**](LiveActivitiesApi.md#reconcile_live_activity_stream) | **PUT** /live-activity/stream/{stream_key} | Send a stream update -[**start_live_activity**](LiveActivitiesApi.md#start_live_activity) | **POST** /live-activity/start | Start a Live Activity -[**update_live_activity**](LiveActivitiesApi.md#update_live_activity) | **POST** /live-activity/update | Update a Live Activity +[**reconcile_live_activity_stream**](LiveActivitiesApi.md#reconcile_live_activity_stream) | **PUT** /live-activity/stream/{stream_key} | Start a new Live Activity or update an existing one +[**start_live_activity**](LiveActivitiesApi.md#start_live_activity) | **POST** /live-activity/start | Start a Live Activity (legacy manual lifecycle) +[**update_live_activity**](LiveActivitiesApi.md#update_live_activity) | **POST** /live-activity/update | Update a Live Activity (legacy manual lifecycle) # **end_live_activity** > LiveActivityEndResponse end_live_activity(live_activity_end_request) -End a Live Activity +End a Live Activity (legacy manual lifecycle) -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. +Legacy manual lifecycle endpoint. For new integrations, use DELETE /live-activity/stream/{stream_key} to end a managed Live Activity stream. This endpoint remains supported for existing integrations and advanced lifecycle control. 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. ### Example @@ -52,7 +52,7 @@ with activitysmith_openapi.ApiClient(configuration) as api_client: live_activity_end_request = {"activity_id":"pLAr-Hnq9ZFW4sxlk43Lhbuok4GLh7UW","content_state":{"title":"Nightly database backup","subtitle":"verify restore","number_of_steps":3,"current_step":3,"auto_dismiss_minutes":2}} # LiveActivityEndRequest | try: - # End a Live Activity + # End a Live Activity (legacy manual lifecycle) api_response = api_instance.end_live_activity(live_activity_end_request) print("The response of LiveActivitiesApi->end_live_activity:\n") pprint(api_response) @@ -179,9 +179,9 @@ Name | Type | Description | Notes # **reconcile_live_activity_stream** > LiveActivityStreamPutResponse reconcile_live_activity_stream(stream_key, live_activity_stream_request) -Send a stream update +Start a new Live Activity or update an existing one -Use this endpoint when you want the easiest, stateless way to trigger Live Activities. You do not need to store activity_id or manage the Live Activity lifecycle yourself. Send the latest state for a stable stream_key and ActivitySmith will handle the rest for you: if there is no Live Activity yet, it starts one; if there is already one for this stream, it updates it. If you need direct lifecycle control, use /live-activity/start, /live-activity/update, and /live-activity/end instead. +Use a stable stream_key for each ongoing thing you want to show as a Live Activity. Send the latest content_state whenever it changes, and ActivitySmith will keep the Live Activity in sync. ### Example @@ -218,7 +218,7 @@ with activitysmith_openapi.ApiClient(configuration) as api_client: live_activity_stream_request = {"content_state":{"title":"Server Health","subtitle":"prod-web-1","type":"metrics","metrics":[{"label":"CPU","value":27,"unit":"%"},{"label":"MEM","value":64,"unit":"%"}]}} # LiveActivityStreamRequest | try: - # Send a stream update + # Start a new Live Activity or update an existing one api_response = api_instance.reconcile_live_activity_stream(stream_key, live_activity_stream_request) print("The response of LiveActivitiesApi->reconcile_live_activity_stream:\n") pprint(api_response) @@ -264,9 +264,9 @@ Name | Type | Description | Notes # **start_live_activity** > LiveActivityStartResponse start_live_activity(live_activity_start_request) -Start a Live Activity +Start a Live Activity (legacy manual lifecycle) -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. +Legacy manual lifecycle endpoint. For new integrations, use PUT /live-activity/stream/{stream_key} so ActivitySmith can manage start, update, rotation, and end state for you. This endpoint remains supported for existing integrations and advanced lifecycle control. 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. ### Example @@ -302,7 +302,7 @@ with activitysmith_openapi.ApiClient(configuration) as api_client: live_activity_start_request = {"content_state":{"title":"Nightly database backup","subtitle":"create snapshot","number_of_steps":3,"current_step":1,"type":"segmented_progress","color":"yellow"}} # LiveActivityStartRequest | try: - # Start a Live Activity + # Start a Live Activity (legacy manual lifecycle) api_response = api_instance.start_live_activity(live_activity_start_request) print("The response of LiveActivitiesApi->start_live_activity:\n") pprint(api_response) @@ -347,9 +347,9 @@ Name | Type | Description | Notes # **update_live_activity** > LiveActivityUpdateResponse update_live_activity(live_activity_update_request) -Update a Live Activity +Update a Live Activity (legacy manual lifecycle) -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. +Legacy manual lifecycle endpoint. For new integrations, use PUT /live-activity/stream/{stream_key} so ActivitySmith can manage start, update, rotation, and end state for you. This endpoint remains supported for existing integrations and advanced lifecycle control. 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. ### Example @@ -385,7 +385,7 @@ with activitysmith_openapi.ApiClient(configuration) as api_client: live_activity_update_request = {"activity_id":"pLAr-Hnq9ZFW4sxlk43Lhbuok4GLh7UW","content_state":{"title":"Nightly database backup","subtitle":"upload archive","number_of_steps":3,"current_step":2}} # LiveActivityUpdateRequest | try: - # Update a Live Activity + # Update a Live Activity (legacy manual lifecycle) api_response = api_instance.update_live_activity(live_activity_update_request) print("The response of LiveActivitiesApi->update_live_activity:\n") pprint(api_response) diff --git a/activitysmith_openapi/test/test_live_activities_api.py b/activitysmith_openapi/test/test_live_activities_api.py index 92272dc..9999d52 100644 --- a/activitysmith_openapi/test/test_live_activities_api.py +++ b/activitysmith_openapi/test/test_live_activities_api.py @@ -29,7 +29,7 @@ def tearDown(self) -> None: def test_end_live_activity(self) -> None: """Test case for end_live_activity - End a Live Activity + End a Live Activity (legacy manual lifecycle) """ pass @@ -43,21 +43,21 @@ def test_end_live_activity_stream(self) -> None: def test_reconcile_live_activity_stream(self) -> None: """Test case for reconcile_live_activity_stream - Send a stream update + Start a new Live Activity or update an existing one """ pass def test_start_live_activity(self) -> None: """Test case for start_live_activity - Start a Live Activity + Start a Live Activity (legacy manual lifecycle) """ pass def test_update_live_activity(self) -> None: """Test case for update_live_activity - Update a Live Activity + Update a Live Activity (legacy manual lifecycle) """ pass