Skip to content

Update Node SDK #57

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 Node SDK #57

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: 2 additions & 1 deletion generated/apis/AppIconBadgesApi.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,13 @@

import * as runtime from '../runtime';
import type {
AppIconBadgeCountUpdateError,
AppIconBadgeCountUpdateRequest,
AppIconBadgeCountUpdateResponse,
BadRequestError,
ForbiddenError,
NoRecipientsError,
RateLimitError,
UpdateAppIconBadgeCount422Response,
} from '../models/index';

export interface UpdateAppIconBadgeCountRequest {
Expand Down
179 changes: 172 additions & 7 deletions generated/models/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,79 @@ export interface AlertPayload {
*/
body?: string;
}
/**
*
* @export
* @interface AppIconBadgeCountUpdateError
*/
export interface AppIconBadgeCountUpdateError {
/**
*
* @type {string}
* @memberof AppIconBadgeCountUpdateError
*/
error: string;
/**
*
* @type {string}
* @memberof AppIconBadgeCountUpdateError
*/
code: AppIconBadgeCountUpdateErrorCodeEnum;
/**
*
* @type {string}
* @memberof AppIconBadgeCountUpdateError
*/
message: string;
/**
*
* @type {number}
* @memberof AppIconBadgeCountUpdateError
*/
badge: number;
/**
*
* @type {number}
* @memberof AppIconBadgeCountUpdateError
*/
devices_targeted?: number;
/**
*
* @type {number}
* @memberof AppIconBadgeCountUpdateError
*/
devices_updated: number;
/**
*
* @type {number}
* @memberof AppIconBadgeCountUpdateError
*/
users_updated?: number;
/**
* Deprecated compatibility alias for devices_updated.
* @type {number}
* @memberof AppIconBadgeCountUpdateError
* @deprecated
*/
devices_notified?: number;
/**
*
* @type {Array<string>}
* @memberof AppIconBadgeCountUpdateError
*/
effective_channel_slugs?: Array<string>;
}


/**
* @export
*/
export const AppIconBadgeCountUpdateErrorCodeEnum = {
DeviceDisconnected: 'badge_device_disconnected',
UpdateFailed: 'badge_update_failed'
} as const;
export type AppIconBadgeCountUpdateErrorCodeEnum = typeof AppIconBadgeCountUpdateErrorCodeEnum[keyof typeof AppIconBadgeCountUpdateErrorCodeEnum];

/**
*
* @export
Expand Down Expand Up @@ -113,17 +186,31 @@ export interface AppIconBadgeCountUpdateResponse {
*/
badge: number;
/**
*
* Number of devices whose App Icon Badge Count was updated.
* @type {number}
* @memberof AppIconBadgeCountUpdateResponse
*/
devices_notified: number;
devices_updated: number;
/**
*
* Number of account users with at least one updated device.
* @type {number}
* @memberof AppIconBadgeCountUpdateResponse
*/
users_notified: number;
users_updated: number;
/**
* Deprecated compatibility alias for devices_updated.
* @type {number}
* @memberof AppIconBadgeCountUpdateResponse
* @deprecated
*/
devices_notified?: number;
/**
* Deprecated compatibility alias for users_updated.
* @type {number}
* @memberof AppIconBadgeCountUpdateResponse
* @deprecated
*/
users_notified?: number;
/**
*
* @type {Array<string>}
Expand Down Expand Up @@ -849,12 +936,24 @@ export type LiveActivityColor = typeof LiveActivityColor[keyof typeof LiveActivi
* @interface LiveActivityEndRequest
*/
export interface LiveActivityEndRequest {
/**
* 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.
* @type {{ [key: string]: MetadataValue; }}
* @memberof LiveActivityEndRequest
*/
metadata?: { [key: string]: MetadataValue; };
/**
*
* @type {string}
* @memberof LiveActivityEndRequest
*/
activity_id: string;
/**
* Tags for notification history. Omit to keep existing Tags, supply an array to replace them, or send an empty array to clear them.
* @type {Array<string>}
* @memberof LiveActivityEndRequest
*/
tags?: Array<string>;
/**
*
* @type {ContentStateEnd}
Expand Down Expand Up @@ -936,18 +1035,36 @@ export interface LiveActivityLimitError {
*/
limit: number;
/**
* Current number of active Live Activities.
* Highest number of active Live Activities among the targeted devices.
* @type {number}
* @memberof LiveActivityLimitError
*/
active: number;
/**
* Number of targeted devices that have reached the enforced iOS Live Activity concurrency threshold. Included only when targeted devices have mixed capacity.
* @type {number}
* @memberof LiveActivityLimitError
*/
blocked_devices?: number;
/**
* Total number of targeted devices. Included only when targeted devices have mixed capacity.
* @type {number}
* @memberof LiveActivityLimitError
*/
targeted_devices?: number;
}
/**
* Start a new Live Activity. The response includes activity_id for later update and end calls.
* @export
* @interface LiveActivityStartRequest
*/
export interface LiveActivityStartRequest {
/**
* 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.
* @type {{ [key: string]: MetadataValue; }}
* @memberof LiveActivityStartRequest
*/
metadata?: { [key: string]: MetadataValue; };
/**
*
* @type {ContentStateStart}
Expand Down Expand Up @@ -1040,6 +1157,18 @@ export interface LiveActivityStartResponse {
* @interface LiveActivityStreamDeleteRequest
*/
export interface LiveActivityStreamDeleteRequest {
/**
* 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.
* @type {{ [key: string]: MetadataValue; }}
* @memberof LiveActivityStreamDeleteRequest
*/
metadata?: { [key: string]: MetadataValue; };
/**
* Optional tags to organize and filter notification history.
* @type {Array<string>}
* @memberof LiveActivityStreamDeleteRequest
*/
tags?: Array<string>;
/**
*
* @type {StreamContentState}
Expand Down Expand Up @@ -1217,6 +1346,12 @@ export type LiveActivityStreamPutResponseOperationEnum = typeof LiveActivityStre
* @interface LiveActivityStreamRequest
*/
export interface LiveActivityStreamRequest {
/**
* 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.
* @type {{ [key: string]: MetadataValue; }}
* @memberof LiveActivityStreamRequest
*/
metadata?: { [key: string]: MetadataValue; };
/**
*
* @type {StreamContentState}
Expand Down Expand Up @@ -1266,12 +1401,24 @@ export interface LiveActivityStreamRequest {
* @interface LiveActivityUpdateRequest
*/
export interface LiveActivityUpdateRequest {
/**
* 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.
* @type {{ [key: string]: MetadataValue; }}
* @memberof LiveActivityUpdateRequest
*/
metadata?: { [key: string]: MetadataValue; };
/**
*
* @type {string}
* @memberof LiveActivityUpdateRequest
*/
activity_id: string;
/**
* Tags for notification history. Omit to keep existing Tags, supply an array to replace them, or send an empty array to clear them.
* @type {Array<string>}
* @memberof LiveActivityUpdateRequest
*/
tags?: Array<string>;
/**
*
* @type {ContentStateUpdate}
Expand Down Expand Up @@ -1339,6 +1486,12 @@ export const LiveActivityWebhookMethod = {
} as const;
export type LiveActivityWebhookMethod = typeof LiveActivityWebhookMethod[keyof typeof LiveActivityWebhookMethod];

/**
* @type MetadataValue
*
* @export
*/
export type MetadataValue = boolean | number | string;
/**
*
* @export
Expand Down Expand Up @@ -1460,7 +1613,7 @@ export interface PushNotificationAction {
*/
type: PushNotificationActionType;
/**
* 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.
* 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.
* @type {string}
* @memberof PushNotificationAction
*/
Expand Down Expand Up @@ -1496,6 +1649,12 @@ export type PushNotificationActionType = typeof PushNotificationActionType[keyof
*/
export interface PushNotificationRequest {
[key: string]: any | any;
/**
* 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.
* @type {{ [key: string]: MetadataValue; }}
* @memberof PushNotificationRequest
*/
metadata?: { [key: string]: MetadataValue; };
/**
*
* @type {string}
Expand All @@ -1521,7 +1680,7 @@ export interface PushNotificationRequest {
*/
media?: string;
/**
* 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 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.
* @type {string}
* @memberof PushNotificationRequest
*/
Expand Down Expand Up @@ -1835,3 +1994,9 @@ export const StreamContentStateStepColorsEnum = {
} as const;
export type StreamContentStateStepColorsEnum = typeof StreamContentStateStepColorsEnum[keyof typeof StreamContentStateStepColorsEnum];

/**
* @type UpdateAppIconBadgeCount422Response
*
* @export
*/
export type UpdateAppIconBadgeCount422Response = AppIconBadgeCountUpdateError | NoRecipientsError;
6 changes: 6 additions & 0 deletions generated/openapi-source.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"repository": "ActivitySmithHQ/activitysmith-backend",
"commit": "49ad7b083b50f53bc3d81edb77ca6597845160a2",
"path": "openapi.json",
"sha256": "b7e33cd485df8ddc5d7fb7b57b61106fd6f8ff3ffa7cc7bef4ac1ccbbb0cede7"
}