Skip to content

Update Python SDK #56

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
activitysmith-sdk-bot wants to merge 1 commit into from
Closed

Update Python SDK #56

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 3 additions & 0 deletions activitysmith_openapi/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@
from activitysmith_openapi.models.activity_metric import ActivityMetric
from activitysmith_openapi.models.activity_metric_value import ActivityMetricValue
from activitysmith_openapi.models.alert_payload import AlertPayload
from activitysmith_openapi.models.app_icon_badge_count_update_error import AppIconBadgeCountUpdateError
from activitysmith_openapi.models.app_icon_badge_count_update_request import AppIconBadgeCountUpdateRequest
from activitysmith_openapi.models.app_icon_badge_count_update_response import AppIconBadgeCountUpdateResponse
from activitysmith_openapi.models.bad_request_error import BadRequestError
Expand All @@ -62,6 +63,7 @@
from activitysmith_openapi.models.live_activity_update_request import LiveActivityUpdateRequest
from activitysmith_openapi.models.live_activity_update_response import LiveActivityUpdateResponse
from activitysmith_openapi.models.live_activity_webhook_method import LiveActivityWebhookMethod
from activitysmith_openapi.models.metadata_value import MetadataValue
from activitysmith_openapi.models.metric_error import MetricError
from activitysmith_openapi.models.metric_value_update_request import MetricValueUpdateRequest
from activitysmith_openapi.models.metric_value_update_request_value import MetricValueUpdateRequestValue
Expand All @@ -76,3 +78,4 @@
from activitysmith_openapi.models.rate_limit_error import RateLimitError
from activitysmith_openapi.models.send_push_notification429_response import SendPushNotification429Response
from activitysmith_openapi.models.stream_content_state import StreamContentState
from activitysmith_openapi.models.update_app_icon_badge_count422_response import UpdateAppIconBadgeCount422Response
9 changes: 6 additions & 3 deletions activitysmith_openapi/api/app_icon_badges_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,8 @@ def update_app_icon_badge_count(
'200': "AppIconBadgeCountUpdateResponse",
'400': "BadRequestError",
'403': "ForbiddenError",
'404': "NoRecipientsError",
'422': "UpdateAppIconBadgeCount422Response",
'502': "AppIconBadgeCountUpdateError",
'429': "RateLimitError",
}
response_data = self.api_client.call_api(
Expand Down Expand Up @@ -165,7 +166,8 @@ def update_app_icon_badge_count_with_http_info(
'200': "AppIconBadgeCountUpdateResponse",
'400': "BadRequestError",
'403': "ForbiddenError",
'404': "NoRecipientsError",
'422': "UpdateAppIconBadgeCount422Response",
'502': "AppIconBadgeCountUpdateError",
'429': "RateLimitError",
}
response_data = self.api_client.call_api(
Expand Down Expand Up @@ -236,7 +238,8 @@ def update_app_icon_badge_count_without_preload_content(
'200': "AppIconBadgeCountUpdateResponse",
'400': "BadRequestError",
'403': "ForbiddenError",
'404': "NoRecipientsError",
'422': "UpdateAppIconBadgeCount422Response",
'502': "AppIconBadgeCountUpdateError",
'429': "RateLimitError",
}
response_data = self.api_client.call_api(
Expand Down
7 changes: 7 additions & 0 deletions activitysmith_openapi/configuration.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -382,6 +382,13 @@ def auth_settings(self):
'key': 'Authorization',
'value': 'Bearer ' + self.access_token
}
if self.access_token is not None:
auth['mcpOAuth'] = {
'type': 'oauth2',
'in': 'header',
'key': 'Authorization',
'value': 'Bearer ' + self.access_token
}
return auth

def to_debug_report(self):
Expand Down
37 changes: 37 additions & 0 deletions activitysmith_openapi/docs/AppIconBadgeCountUpdateError.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# AppIconBadgeCountUpdateError


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**error** | **str** | |
**code** | **str** | |
**message** | **str** | |
**badge** | **int** | |
**devices_targeted** | **int** | | [optional]
**devices_updated** | **int** | |
**users_updated** | **int** | | [optional]
**devices_notified** | **int** | Deprecated compatibility alias for devices_updated. | [optional]
**effective_channel_slugs** | **List[str]** | | [optional]

## Example

```python
from activitysmith_openapi.models.app_icon_badge_count_update_error import AppIconBadgeCountUpdateError

# TODO update the JSON string below
json = "{}"
# create an instance of AppIconBadgeCountUpdateError from a JSON string
app_icon_badge_count_update_error_instance = AppIconBadgeCountUpdateError.from_json(json)
# print the JSON string representation of the object
print(AppIconBadgeCountUpdateError.to_json())

# convert the object into a dict
app_icon_badge_count_update_error_dict = app_icon_badge_count_update_error_instance.to_dict()
# create an instance of AppIconBadgeCountUpdateError from a dict
app_icon_badge_count_update_error_from_dict = AppIconBadgeCountUpdateError.from_dict(app_icon_badge_count_update_error_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


6 changes: 4 additions & 2 deletions activitysmith_openapi/docs/AppIconBadgeCountUpdateResponse.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,10 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**success** | **bool** | |
**badge** | **int** | |
**devices_notified** | **int** | |
**users_notified** | **int** | |
**devices_updated** | **int** | Number of devices whose App Icon Badge Count 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]
**effective_channel_slugs** | **List[str]** | |
**timestamp** | **datetime** | |

Expand Down
3 changes: 2 additions & 1 deletion activitysmith_openapi/docs/AppIconBadgesApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,8 @@ Name | Type | Description | Notes
**200** | App Icon Badge Count updated | - |
**400** | Bad request | - |
**403** | Forbidden | - |
**404** | No recipients found for effective channel target | - |
**422** | No matching devices found, or a targeted device needs to reconnect | - |
**502** | App Icon Badge Count could not be updated | - |
**429** | Rate limit exceeded | - |

[[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)
Expand Down
2 changes: 2 additions & 0 deletions activitysmith_openapi/docs/LiveActivityEndRequest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@ End an existing Live Activity by activity_id.

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**metadata** | [**Dict[str, MetadataValue]**](MetadataValue.md) | Additional information shown in notification and Live Activity details in ActivitySmith. Not displayed in the Push Notification or Live Activity on the device. Values must be strings, finite numbers, or booleans. At most 50 entries and 16 KB of serialized UTF-8 JSON. Omit on updates to preserve existing Metadata; send {} to clear it. | [optional]
**activity_id** | **str** | |
**tags** | **List[str]** | Tags for notification history. Omit to keep existing Tags, supply an array to replace them, or send an empty array to clear them. | [optional]
**content_state** | [**ContentStateEnd**](ContentStateEnd.md) | |
**action** | [**LiveActivityAction**](LiveActivityAction.md) | | [optional]
**secondary_action** | [**LiveActivityAction**](LiveActivityAction.md) | Optional secondary action button. Supported for alert, progress, and segmented_progress Live Activities. Uses the same open_url, shortcuts://, and webhook shapes as action. | [optional]
Expand Down
4 changes: 3 additions & 1 deletion activitysmith_openapi/docs/LiveActivityLimitError.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@ Name | Type | Description | Notes
**error** | **str** | |
**message** | **str** | |
**limit** | **int** | |
**active** | **int** | Current number of active Live Activities. |
**active** | **int** | Highest number of active Live Activities among the targeted devices. |
**blocked_devices** | **int** | Number of targeted devices that have reached the enforced iOS Live Activity concurrency threshold. Included only when targeted devices have mixed capacity. | [optional]
**targeted_devices** | **int** | Total number of targeted devices. Included only when targeted devices have mixed capacity. | [optional]

## Example

Expand Down
1 change: 1 addition & 0 deletions activitysmith_openapi/docs/LiveActivityStartRequest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ Start a new Live Activity. The response includes activity_id for later update an

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**metadata** | [**Dict[str, MetadataValue]**](MetadataValue.md) | Additional information shown in notification and Live Activity details in ActivitySmith. Not displayed in the Push Notification or Live Activity on the device. Values must be strings, finite numbers, or booleans. At most 50 entries and 16 KB of serialized UTF-8 JSON. Omit on updates to preserve existing Metadata; send {} to clear it. | [optional]
**content_state** | [**ContentStateStart**](ContentStateStart.md) | |
**action** | [**LiveActivityAction**](LiveActivityAction.md) | | [optional]
**secondary_action** | [**LiveActivityAction**](LiveActivityAction.md) | Optional secondary action button. Supported for alert, progress, and segmented_progress Live Activities. Uses the same open_url, shortcuts://, and webhook shapes as action. | [optional]
Expand Down
2 changes: 2 additions & 0 deletions activitysmith_openapi/docs/LiveActivityStreamDeleteRequest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ Optional payload for ending a managed stream. When omitted, ActivitySmith ends t

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**metadata** | [**Dict[str, MetadataValue]**](MetadataValue.md) | Additional information shown in notification and Live Activity details in ActivitySmith. Not displayed in the Push Notification or Live Activity on the device. Values must be strings, finite numbers, or booleans. At most 50 entries and 16 KB of serialized UTF-8 JSON. Omit on updates to preserve existing Metadata; send {} to clear it. | [optional]
**tags** | **List[str]** | Optional tags to organize and filter notification history. | [optional]
**content_state** | [**StreamContentState**](StreamContentState.md) | | [optional]
**action** | [**LiveActivityAction**](LiveActivityAction.md) | | [optional]
**secondary_action** | [**LiveActivityAction**](LiveActivityAction.md) | Optional secondary action button. Supported for alert, progress, and segmented_progress Live Activities. Uses the same open_url, shortcuts://, and webhook shapes as action. | [optional]
Expand Down
1 change: 1 addition & 0 deletions activitysmith_openapi/docs/LiveActivityStreamRequest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ Send the latest state for a managed Live Activity stream. channels is the stream

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**metadata** | [**Dict[str, MetadataValue]**](MetadataValue.md) | Additional information shown in notification and Live Activity details in ActivitySmith. Not displayed in the Push Notification or Live Activity on the device. Values must be strings, finite numbers, or booleans. At most 50 entries and 16 KB of serialized UTF-8 JSON. Omit on updates to preserve existing Metadata; send {} to clear it. | [optional]
**content_state** | [**StreamContentState**](StreamContentState.md) | |
**action** | [**LiveActivityAction**](LiveActivityAction.md) | | [optional]
**secondary_action** | [**LiveActivityAction**](LiveActivityAction.md) | Optional secondary action button. Supported for alert, progress, and segmented_progress Live Activities. Uses the same open_url, shortcuts://, and webhook shapes as action. | [optional]
Expand Down
2 changes: 2 additions & 0 deletions activitysmith_openapi/docs/LiveActivityUpdateRequest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@ Update an existing Live Activity by activity_id.

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**metadata** | [**Dict[str, MetadataValue]**](MetadataValue.md) | Additional information shown in notification and Live Activity details in ActivitySmith. Not displayed in the Push Notification or Live Activity on the device. Values must be strings, finite numbers, or booleans. At most 50 entries and 16 KB of serialized UTF-8 JSON. Omit on updates to preserve existing Metadata; send {} to clear it. | [optional]
**activity_id** | **str** | |
**tags** | **List[str]** | Tags for notification history. Omit to keep existing Tags, supply an array to replace them, or send an empty array to clear them. | [optional]
**content_state** | [**ContentStateUpdate**](ContentStateUpdate.md) | |
**action** | [**LiveActivityAction**](LiveActivityAction.md) | | [optional]
**secondary_action** | [**LiveActivityAction**](LiveActivityAction.md) | Optional secondary action button. Supported for alert, progress, and segmented_progress Live Activities. Uses the same open_url, shortcuts://, and webhook shapes as action. | [optional]
Expand Down
28 changes: 28 additions & 0 deletions activitysmith_openapi/docs/MetadataValue.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# MetadataValue


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------

## Example

```python
from activitysmith_openapi.models.metadata_value import MetadataValue

# TODO update the JSON string below
json = "{}"
# create an instance of MetadataValue from a JSON string
metadata_value_instance = MetadataValue.from_json(json)
# print the JSON string representation of the object
print(MetadataValue.to_json())

# convert the object into a dict
metadata_value_dict = metadata_value_instance.to_dict()
# create an instance of MetadataValue from a dict
metadata_value_from_dict = MetadataValue.from_dict(metadata_value_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


2 changes: 1 addition & 1 deletion activitysmith_openapi/docs/PushNotificationAction.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**title** | **str** | Button title displayed in iOS expanded notification UI. |
**type** | [**PushNotificationActionType**](PushNotificationActionType.md) | |
**url** | **str** | Action URL. For open_url, use an HTTP or HTTPS URL or a shortcuts://run-shortcut?name=... URL that runs a specific iPhone Shortcut. For webhook, use an HTTPS URL called by the ActivitySmith backend. |
**url** | **str** | Action URL. For open_url, use HTTP, HTTPS, Shortcuts, or an installed app’s custom URL scheme, such as spotify:// or spotify:track:123. Custom app schemes require iOS 1.13.4 build 2 or later; no web fallback is provided. Internal and executable schemes are blocked. For webhook, use an HTTPS URL called by the ActivitySmith backend. |
**method** | [**PushNotificationWebhookMethod**](PushNotificationWebhookMethod.md) | Webhook HTTP method. Used only when type=webhook. | [optional] [default to PushNotificationWebhookMethod.POST]
**body** | **object** | Optional webhook payload body. Used only when type=webhook. | [optional]

Expand Down
3 changes: 2 additions & 1 deletion activitysmith_openapi/docs/PushNotificationRequest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,12 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**metadata** | [**Dict[str, MetadataValue]**](MetadataValue.md) | Additional information shown in notification and Live Activity details in ActivitySmith. Not displayed in the Push Notification or Live Activity on the device. Values must be strings, finite numbers, or booleans. At most 50 entries and 16 KB of serialized UTF-8 JSON. Omit on updates to preserve existing Metadata; send {} to clear it. | [optional]
**title** | **str** | |
**message** | **str** | | [optional]
**subtitle** | **str** | | [optional]
**media** | **str** | Optional HTTPS URL for an image, audio file, or video that users can preview or play when they expand the notification. If `redirection` is omitted, tapping the notification opens this URL. Cannot be combined with `actions`. | [optional]
**redirection** | **str** | Optional HTTP URL, HTTPS URL, or shortcuts://run-shortcut?name=... URL opened when the user taps the notification body. Use shortcuts://run-shortcut?name=... to run a specific iPhone Shortcut that already exists on the user's device. Overrides the default tap target from `media` when both are provided. | [optional]
**redirection** | **str** | Optional HTTP, HTTPS, Shortcuts, or installed app URL opened when the user taps the notification body. Custom schemes such as spotify:// and spotify:track:123 require iOS 1.13.4 build 2 or later and an installed handler; no web fallback is provided. Internal and executable schemes are blocked. Overrides the default tap target from media. | [optional]
**actions** | [**List[PushNotificationAction]**](PushNotificationAction.md) | Optional interactive actions shown when users expand the notification. Cannot be combined with `media`. | [optional]
**payload** | **object** | | [optional]
**badge** | **int** | | [optional]
Expand Down
4 changes: 3 additions & 1 deletion activitysmith_openapi/docs/SendPushNotification429Response.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@ Name | Type | Description | Notes
**error** | **str** | |
**message** | **str** | |
**limit** | **int** | |
**active** | **int** | Current number of active Live Activities. |
**active** | **int** | Highest number of active Live Activities among the targeted devices. |
**blocked_devices** | **int** | Number of targeted devices that have reached the enforced iOS Live Activity concurrency threshold. Included only when targeted devices have mixed capacity. | [optional]
**targeted_devices** | **int** | Total number of targeted devices. Included only when targeted devices have mixed capacity. | [optional]

## Example

Expand Down
37 changes: 37 additions & 0 deletions activitysmith_openapi/docs/UpdateAppIconBadgeCount422Response.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# UpdateAppIconBadgeCount422Response


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**error** | **str** | |
**message** | **str** | |
**effective_channel_slugs** | **List[str]** | | [optional]
**code** | **str** | |
**badge** | **int** | |
**devices_targeted** | **int** | | [optional]
**devices_updated** | **int** | |
**users_updated** | **int** | | [optional]
**devices_notified** | **int** | Deprecated compatibility alias for devices_updated. | [optional]

## Example

```python
from activitysmith_openapi.models.update_app_icon_badge_count422_response import UpdateAppIconBadgeCount422Response

# TODO update the JSON string below
json = "{}"
# create an instance of UpdateAppIconBadgeCount422Response from a JSON string
update_app_icon_badge_count422_response_instance = UpdateAppIconBadgeCount422Response.from_json(json)
# print the JSON string representation of the object
print(UpdateAppIconBadgeCount422Response.to_json())

# convert the object into a dict
update_app_icon_badge_count422_response_dict = update_app_icon_badge_count422_response_instance.to_dict()
# create an instance of UpdateAppIconBadgeCount422Response from a dict
update_app_icon_badge_count422_response_from_dict = UpdateAppIconBadgeCount422Response.from_dict(update_app_icon_badge_count422_response_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


Loading