diff --git a/activitysmith_openapi/api/app_icon_badges_api.py b/activitysmith_openapi/api/app_icon_badges_api.py index 0053614..29e0388 100644 --- a/activitysmith_openapi/api/app_icon_badges_api.py +++ b/activitysmith_openapi/api/app_icon_badges_api.py @@ -54,9 +54,9 @@ def update_app_icon_badge_count( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> AppIconBadgeCountUpdateResponse: - """Set App Icon Badge Count + """Set App Icon Badge - Shows a number on the ActivitySmith app icon. + Shows a number on the ActivitySmith app icon. Requires Push Notifications enabled for ActivitySmith on the device. :param app_icon_badge_count_update_request: (required) :type app_icon_badge_count_update_request: AppIconBadgeCountUpdateRequest @@ -127,9 +127,9 @@ def update_app_icon_badge_count_with_http_info( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> ApiResponse[AppIconBadgeCountUpdateResponse]: - """Set App Icon Badge Count + """Set App Icon Badge - Shows a number on the ActivitySmith app icon. + Shows a number on the ActivitySmith app icon. Requires Push Notifications enabled for ActivitySmith on the device. :param app_icon_badge_count_update_request: (required) :type app_icon_badge_count_update_request: AppIconBadgeCountUpdateRequest @@ -200,9 +200,9 @@ def update_app_icon_badge_count_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Set App Icon Badge Count + """Set App Icon Badge - Shows a number on the ActivitySmith app icon. + Shows a number on the ActivitySmith app icon. Requires Push Notifications enabled for ActivitySmith on the device. :param app_icon_badge_count_update_request: (required) :type app_icon_badge_count_update_request: AppIconBadgeCountUpdateRequest diff --git a/activitysmith_openapi/docs/AppIconBadgeCountUpdateResponse.md b/activitysmith_openapi/docs/AppIconBadgeCountUpdateResponse.md index a3139d8..369817a 100644 --- a/activitysmith_openapi/docs/AppIconBadgeCountUpdateResponse.md +++ b/activitysmith_openapi/docs/AppIconBadgeCountUpdateResponse.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **success** | **bool** | | **badge** | **int** | | -**devices_updated** | **int** | Number of devices whose App Icon Badge Count was updated. | +**devices_updated** | **int** | Number of devices whose App Icon Badge was updated. | **users_updated** | **int** | Number of account users with at least one updated device. | **devices_notified** | **int** | Deprecated compatibility alias for devices_updated. | [optional] **users_notified** | **int** | Deprecated compatibility alias for users_updated. | [optional] diff --git a/activitysmith_openapi/docs/AppIconBadgesApi.md b/activitysmith_openapi/docs/AppIconBadgesApi.md index 0241b41..8b10987 100644 --- a/activitysmith_openapi/docs/AppIconBadgesApi.md +++ b/activitysmith_openapi/docs/AppIconBadgesApi.md @@ -4,15 +4,15 @@ All URIs are relative to *https://activitysmith.com/api* Method | HTTP request | Description ------------- | ------------- | ------------- -[**update_app_icon_badge_count**](AppIconBadgesApi.md#update_app_icon_badge_count) | **POST** /badge | Set App Icon Badge Count +[**update_app_icon_badge_count**](AppIconBadgesApi.md#update_app_icon_badge_count) | **POST** /badge | Set App Icon Badge # **update_app_icon_badge_count** > AppIconBadgeCountUpdateResponse update_app_icon_badge_count(app_icon_badge_count_update_request) -Set App Icon Badge Count +Set App Icon Badge -Shows a number on the ActivitySmith app icon. +Shows a number on the ActivitySmith app icon. Requires Push Notifications enabled for ActivitySmith on the device. ### Example @@ -48,7 +48,7 @@ with activitysmith_openapi.ApiClient(configuration) as api_client: app_icon_badge_count_update_request = {"badge":8333} # AppIconBadgeCountUpdateRequest | try: - # Set App Icon Badge Count + # Set App Icon Badge api_response = api_instance.update_app_icon_badge_count(app_icon_badge_count_update_request) print("The response of AppIconBadgesApi->update_app_icon_badge_count:\n") pprint(api_response) @@ -82,13 +82,13 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | App Icon Badge Count updated | * RateLimit - Current request quotas using IETF draft-8 structured fields. Each named policy includes r (remaining requests) and t (seconds until reset). Multiple policies may apply.
* RateLimit-Policy - Each named policy includes q (request quota) and w (window in seconds). Each feature has an independent IP limit of 600 requests per 60 seconds. Independent account limits per 60 seconds are: Push Notifications 60, badges 60, Live Activities 300, and metric updates 300.
| +**200** | App Icon Badge updated | * RateLimit - Current request quotas using IETF draft-8 structured fields. Each named policy includes r (remaining requests) and t (seconds until reset). Multiple policies may apply.
* RateLimit-Policy - Each named policy includes q (request quota) and w (window in seconds). Each feature has an independent IP limit of 600 requests per 60 seconds. Independent account limits per 60 seconds are: Push Notifications 60, badges 60, Live Activities 300, and metric updates 300.
| **400** | Bad request | * RateLimit - Current request quotas using IETF draft-8 structured fields. Each named policy includes r (remaining requests) and t (seconds until reset). Multiple policies may apply.
* RateLimit-Policy - Each named policy includes q (request quota) and w (window in seconds). Each feature has an independent IP limit of 600 requests per 60 seconds. Independent account limits per 60 seconds are: Push Notifications 60, badges 60, Live Activities 300, and metric updates 300.
| **402** | Billing access required | - | **403** | Forbidden | * RateLimit - Current request quotas using IETF draft-8 structured fields. Each named policy includes r (remaining requests) and t (seconds until reset). Multiple policies may apply.
* RateLimit-Policy - Each named policy includes q (request quota) and w (window in seconds). Each feature has an independent IP limit of 600 requests per 60 seconds. Independent account limits per 60 seconds are: Push Notifications 60, badges 60, Live Activities 300, and metric updates 300.
| **422** | No matching devices found, or a targeted device needs to reconnect | * RateLimit - Current request quotas using IETF draft-8 structured fields. Each named policy includes r (remaining requests) and t (seconds until reset). Multiple policies may apply.
* RateLimit-Policy - Each named policy includes q (request quota) and w (window in seconds). Each feature has an independent IP limit of 600 requests per 60 seconds. Independent account limits per 60 seconds are: Push Notifications 60, badges 60, Live Activities 300, and metric updates 300.
| **429** | Rate limit exceeded | * RateLimit - Current request quotas using IETF draft-8 structured fields. Each named policy includes r (remaining requests) and t (seconds until reset). Multiple policies may apply.
* RateLimit-Policy - Each named policy includes q (request quota) and w (window in seconds). Each feature has an independent IP limit of 600 requests per 60 seconds. Independent account limits per 60 seconds are: Push Notifications 60, badges 60, Live Activities 300, and metric updates 300.
* Retry-After - Seconds to wait before retrying after a request-rate 429. Live Activity capacity errors are separate and require freeing device capacity; they do not provide a timed retry guarantee.
| -**502** | App Icon Badge Count could not be updated | * RateLimit - Current request quotas using IETF draft-8 structured fields. Each named policy includes r (remaining requests) and t (seconds until reset). Multiple policies may apply.
* RateLimit-Policy - Each named policy includes q (request quota) and w (window in seconds). Each feature has an independent IP limit of 600 requests per 60 seconds. Independent account limits per 60 seconds are: Push Notifications 60, badges 60, Live Activities 300, and metric updates 300.
| +**502** | App Icon Badge could not be updated | * RateLimit - Current request quotas using IETF draft-8 structured fields. Each named policy includes r (remaining requests) and t (seconds until reset). Multiple policies may apply.
* RateLimit-Policy - Each named policy includes q (request quota) and w (window in seconds). Each feature has an independent IP limit of 600 requests per 60 seconds. Independent account limits per 60 seconds are: Push Notifications 60, badges 60, Live Activities 300, and metric updates 300.
| [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) diff --git a/activitysmith_openapi/models/app_icon_badge_count_update_response.py b/activitysmith_openapi/models/app_icon_badge_count_update_response.py index a8bd224..fcaaa96 100644 --- a/activitysmith_openapi/models/app_icon_badge_count_update_response.py +++ b/activitysmith_openapi/models/app_icon_badge_count_update_response.py @@ -30,7 +30,7 @@ class AppIconBadgeCountUpdateResponse(BaseModel): """ # noqa: E501 success: StrictBool badge: Annotated[int, Field(le=2147483647, strict=True, ge=0)] - devices_updated: StrictInt = Field(description="Number of devices whose App Icon Badge Count was updated.") + devices_updated: StrictInt = Field(description="Number of devices whose App Icon Badge was updated.") users_updated: StrictInt = Field(description="Number of account users with at least one updated device.") devices_notified: Optional[StrictInt] = Field(default=None, description="Deprecated compatibility alias for devices_updated.") users_notified: Optional[StrictInt] = Field(default=None, description="Deprecated compatibility alias for users_updated.") diff --git a/activitysmith_openapi/openapi-source.json b/activitysmith_openapi/openapi-source.json index 8c9c874..e4190d0 100644 --- a/activitysmith_openapi/openapi-source.json +++ b/activitysmith_openapi/openapi-source.json @@ -1,6 +1,6 @@ { "repository": "ActivitySmithHQ/activitysmith-backend", - "commit": "ab7064d65ad2097e3b57dc435c10b4f80a0ee27e", + "commit": "33de968fe69bea49e842a19beab6998c1b2687c8", "path": "openapi.json", - "sha256": "f0548e423e06f90169dae8d935b08f78291e9dbf95d4ae591e6d10d8eb269448" + "sha256": "318843c369154cc3151a4035044e49a23b7dde774d5870f77598feec36c0ac6d" } diff --git a/activitysmith_openapi/test/test_app_icon_badges_api.py b/activitysmith_openapi/test/test_app_icon_badges_api.py index c8b2855..e048933 100644 --- a/activitysmith_openapi/test/test_app_icon_badges_api.py +++ b/activitysmith_openapi/test/test_app_icon_badges_api.py @@ -29,7 +29,7 @@ def tearDown(self) -> None: def test_update_app_icon_badge_count(self) -> None: """Test case for update_app_icon_badge_count - Set App Icon Badge Count + Set App Icon Badge """ pass