activitysmith 0.1.2 → 0.1.3

package/README.md

@@ -40,6 +40,7 @@ const activitysmith = new ActivitySmith({
 const response = await activitysmith.notifications.send({
   title: "Build Failed",
   message: "CI pipeline failed on main branch",
+  channels: ["devs", "ops"], // Optional
 });
 
 console.log(response.success);
@@ -58,6 +59,7 @@ const start = await activitysmith.liveActivities.start({
     type: "segmented_progress",
     color: "yellow",
   },
+  channels: ["devs", "ops"], // Optional
 });
 
 const activityId = start.activity_id;

package/dist/generated/apis/LiveActivitiesApi.d.ts

@@ -35,12 +35,12 @@ export declare class LiveActivitiesApi extends runtime.BaseAPI {
      */
     endLiveActivity(requestParameters: EndLiveActivityRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<LiveActivityEndResponse>;
     /**
-     * Starts a Live Activity on all registered devices and returns an activity_id.
+     * Starts a Live Activity on devices matched by API key scope and optional target channels.
      * Start a Live Activity
      */
     startLiveActivityRaw(requestParameters: StartLiveActivityRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<LiveActivityStartResponse>>;
     /**
-     * Starts a Live Activity on all registered devices and returns an activity_id.
+     * Starts a Live Activity on devices matched by API key scope and optional target channels.
      * Start a Live Activity
      */
     startLiveActivity(requestParameters: StartLiveActivityRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<LiveActivityStartResponse>;

package/dist/generated/apis/LiveActivitiesApi.js

@@ -55,7 +55,7 @@ class LiveActivitiesApi extends runtime.BaseAPI {
         return await response.value();
     }
     /**
-     * Starts a Live Activity on all registered devices and returns an activity_id.
+     * Starts a Live Activity on devices matched by API key scope and optional target channels.
      * Start a Live Activity
      */
     async startLiveActivityRaw(requestParameters, initOverrides) {
@@ -82,7 +82,7 @@ class LiveActivitiesApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response);
     }
     /**
-     * Starts a Live Activity on all registered devices and returns an activity_id.
+     * Starts a Live Activity on devices matched by API key scope and optional target channels.
      * Start a Live Activity
      */
     async startLiveActivity(requestParameters, initOverrides) {

package/dist/generated/apis/PushNotificationsApi.d.ts

@@ -19,12 +19,12 @@ export interface SendPushNotificationRequest {
  */
 export declare class PushNotificationsApi extends runtime.BaseAPI {
     /**
-     * Sends a push notification to every paired device in your account.
+     * Sends a push notification to devices matched by API key scope and optional target channels.
      * Send a push notification
      */
     sendPushNotificationRaw(requestParameters: SendPushNotificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PushNotificationResponse>>;
     /**
-     * Sends a push notification to every paired device in your account.
+     * Sends a push notification to devices matched by API key scope and optional target channels.
      * Send a push notification
      */
     sendPushNotification(requestParameters: SendPushNotificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PushNotificationResponse>;

package/dist/generated/apis/PushNotificationsApi.js

@@ -20,7 +20,7 @@ const runtime = require("../runtime");
  */
 class PushNotificationsApi extends runtime.BaseAPI {
     /**
-     * Sends a push notification to every paired device in your account.
+     * Sends a push notification to devices matched by API key scope and optional target channels.
      * Send a push notification
      */
     async sendPushNotificationRaw(requestParameters, initOverrides) {
@@ -47,7 +47,7 @@ class PushNotificationsApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response);
     }
     /**
-     * Sends a push notification to every paired device in your account.
+     * Sends a push notification to devices matched by API key scope and optional target channels.
      * Send a push notification
      */
     async sendPushNotification(requestParameters, initOverrides) {

package/dist/generated/models/index.d.ts

@@ -1,9 +1,64 @@
+/**
+ *
+ * @export
+ * @interface AlertPayload
+ */
+export interface AlertPayload {
+    [key: string]: any | any;
+    /**
+     *
+     * @type {string}
+     * @memberof AlertPayload
+     */
+    title?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof AlertPayload
+     */
+    body?: string;
+}
+/**
+ *
+ * @export
+ * @interface BadRequestError
+ */
+export interface BadRequestError {
+    [key: string]: any | any;
+    /**
+     *
+     * @type {string}
+     * @memberof BadRequestError
+     */
+    error: string;
+    /**
+     *
+     * @type {string}
+     * @memberof BadRequestError
+     */
+    message: string;
+}
+/**
+ *
+ * @export
+ * @interface ChannelTarget
+ */
+export interface ChannelTarget {
+    [key: string]: any | any;
+    /**
+     * Channel slugs. When omitted, API key scope determines recipients.
+     * @type {Array<string>}
+     * @memberof ChannelTarget
+     */
+    channels: Array<string>;
+}
 /**
  * End payload. Required fields are title and current_step. number_of_steps is optional.
  * @export
  * @interface ContentStateEnd
  */
 export interface ContentStateEnd {
+    [key: string]: any | any;
     /**
      *
      * @type {string}
@@ -83,6 +138,7 @@ export type ContentStateEndStepColorEnum = typeof ContentStateEndStepColorEnum[k
  * @interface ContentStateStart
  */
 export interface ContentStateStart {
+    [key: string]: any | any;
     /**
      *
      * @type {string}
@@ -169,6 +225,7 @@ export type ContentStateStartStepColorEnum = typeof ContentStateStartStepColorEn
  * @interface ContentStateUpdate
  */
 export interface ContentStateUpdate {
+    [key: string]: any | any;
     /**
      *
      * @type {string}
@@ -236,12 +293,33 @@ export declare const ContentStateUpdateStepColorEnum: {
     readonly Yellow: "yellow";
 };
 export type ContentStateUpdateStepColorEnum = typeof ContentStateUpdateStepColorEnum[keyof typeof ContentStateUpdateStepColorEnum];
+/**
+ *
+ * @export
+ * @interface ForbiddenError
+ */
+export interface ForbiddenError {
+    [key: string]: any | any;
+    /**
+     *
+     * @type {string}
+     * @memberof ForbiddenError
+     */
+    error: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ForbiddenError
+     */
+    message: string;
+}
 /**
  *
  * @export
  * @interface LiveActivityEndRequest
  */
 export interface LiveActivityEndRequest {
+    [key: string]: any | any;
     /**
      *
      * @type {string}
@@ -261,6 +339,7 @@ export interface LiveActivityEndRequest {
  * @interface LiveActivityEndResponse
  */
 export interface LiveActivityEndResponse {
+    [key: string]: any | any;
     /**
      *
      * @type {boolean}
@@ -298,6 +377,7 @@ export interface LiveActivityEndResponse {
  * @interface LiveActivityLimitError
  */
 export interface LiveActivityLimitError {
+    [key: string]: any | any;
     /**
      *
      * @type {string}
@@ -329,12 +409,25 @@ export interface LiveActivityLimitError {
  * @interface LiveActivityStartRequest
  */
 export interface LiveActivityStartRequest {
+    [key: string]: any | any;
     /**
      *
      * @type {ContentStateStart}
      * @memberof LiveActivityStartRequest
      */
     content_state: ContentStateStart;
+    /**
+     *
+     * @type {AlertPayload}
+     * @memberof LiveActivityStartRequest
+     */
+    alert?: AlertPayload;
+    /**
+     *
+     * @type {ChannelTarget}
+     * @memberof LiveActivityStartRequest
+     */
+    target?: ChannelTarget;
 }
 /**
  *
@@ -342,6 +435,7 @@ export interface LiveActivityStartRequest {
  * @interface LiveActivityStartResponse
  */
 export interface LiveActivityStartResponse {
+    [key: string]: any | any;
     /**
      *
      * @type {boolean}
@@ -366,6 +460,12 @@ export interface LiveActivityStartResponse {
      * @memberof LiveActivityStartResponse
      */
     activity_id: string;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof LiveActivityStartResponse
+     */
+    effective_channel_slugs?: Array<string>;
     /**
      *
      * @type {string}
@@ -379,6 +479,7 @@ export interface LiveActivityStartResponse {
  * @interface LiveActivityUpdateRequest
  */
 export interface LiveActivityUpdateRequest {
+    [key: string]: any | any;
     /**
      *
      * @type {string}
@@ -398,6 +499,7 @@ export interface LiveActivityUpdateRequest {
  * @interface LiveActivityUpdateResponse
  */
 export interface LiveActivityUpdateResponse {
+    [key: string]: any | any;
     /**
      *
      * @type {boolean}
@@ -429,12 +531,39 @@ export interface LiveActivityUpdateResponse {
      */
     timestamp: string;
 }
+/**
+ *
+ * @export
+ * @interface NoRecipientsError
+ */
+export interface NoRecipientsError {
+    [key: string]: any | any;
+    /**
+     *
+     * @type {string}
+     * @memberof NoRecipientsError
+     */
+    error: string;
+    /**
+     *
+     * @type {string}
+     * @memberof NoRecipientsError
+     */
+    message: string;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof NoRecipientsError
+     */
+    effective_channel_slugs?: Array<string>;
+}
 /**
  *
  * @export
  * @interface PushNotificationRequest
  */
 export interface PushNotificationRequest {
+    [key: string]: any | any;
     /**
      *
      * @type {string}
@@ -453,6 +582,32 @@ export interface PushNotificationRequest {
      * @memberof PushNotificationRequest
      */
     subtitle?: string;
+    /**
+     *
+     * @type {{ [key: string]: any; }}
+     * @memberof PushNotificationRequest
+     */
+    payload?: {
+        [key: string]: any;
+    };
+    /**
+     *
+     * @type {number}
+     * @memberof PushNotificationRequest
+     */
+    badge?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof PushNotificationRequest
+     */
+    sound?: string;
+    /**
+     *
+     * @type {ChannelTarget}
+     * @memberof PushNotificationRequest
+     */
+    target?: ChannelTarget;
 }
 /**
  *
@@ -460,6 +615,7 @@ export interface PushNotificationRequest {
  * @interface PushNotificationResponse
  */
 export interface PushNotificationResponse {
+    [key: string]: any | any;
     /**
      *
      * @type {boolean}
@@ -478,6 +634,12 @@ export interface PushNotificationResponse {
      * @memberof PushNotificationResponse
      */
     users_notified?: number;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof PushNotificationResponse
+     */
+    effective_channel_slugs?: Array<string>;
     /**
      *
      * @type {string}
@@ -491,6 +653,7 @@ export interface PushNotificationResponse {
  * @interface RateLimitError
  */
 export interface RateLimitError {
+    [key: string]: any | any;
     /**
      *
      * @type {string}

package/dist/src/ActivitySmith.d.ts

@@ -8,17 +8,23 @@ type StartRequestBody = Parameters<LiveActivitiesApi["startLiveActivity"]>[0]["l
 type UpdateRequestBody = Parameters<LiveActivitiesApi["updateLiveActivity"]>[0]["liveActivityUpdateRequest"];
 type EndRequestBody = Parameters<LiveActivitiesApi["endLiveActivity"]>[0]["liveActivityEndRequest"];
 type LiveInitOverrides = Parameters<LiveActivitiesApi["startLiveActivity"]>[1];
+type PushSendRequest = PushRequestBody & {
+    channels?: string[];
+};
+type LiveStartSendRequest = StartRequestBody & {
+    channels?: string[];
+};
 export declare class NotificationsResource {
     private readonly api;
     constructor(api: PushNotificationsApi);
-    send(request: PushRequestBody, initOverrides?: SendInitOverrides): Promise<import("../generated/models").PushNotificationResponse>;
+    send(request: PushSendRequest, initOverrides?: SendInitOverrides): Promise<import("../generated/models").PushNotificationResponse>;
     sendPushNotification(...args: Parameters<PushNotificationsApi["sendPushNotification"]>): Promise<import("../generated/models").PushNotificationResponse>;
     sendPushNotificationRaw(...args: Parameters<PushNotificationsApi["sendPushNotificationRaw"]>): Promise<import("../generated/runtime").ApiResponse<import("../generated/models").PushNotificationResponse>>;
 }
 export declare class LiveActivitiesResource {
     private readonly api;
     constructor(api: LiveActivitiesApi);
-    start(request: StartRequestBody, initOverrides?: LiveInitOverrides): Promise<import("../generated/models").LiveActivityStartResponse>;
+    start(request: LiveStartSendRequest, initOverrides?: LiveInitOverrides): Promise<import("../generated/models").LiveActivityStartResponse>;
     update(request: UpdateRequestBody, initOverrides?: LiveInitOverrides): Promise<import("../generated/models").LiveActivityUpdateResponse>;
     end(request: EndRequestBody, initOverrides?: LiveInitOverrides): Promise<import("../generated/models").LiveActivityEndResponse>;
     startLiveActivity(...args: Parameters<LiveActivitiesApi["startLiveActivity"]>): Promise<import("../generated/models").LiveActivityStartResponse>;

package/dist/src/ActivitySmith.js

@@ -2,12 +2,24 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ActivitySmith = exports.LiveActivitiesResource = exports.NotificationsResource = void 0;
 const index_1 = require("../generated/index");
+function withTargetChannels(request) {
+    const channels = request.channels;
+    if (!channels || channels.length === 0 || request.target) {
+        const { channels: _ignored, ...rest } = request;
+        return rest;
+    }
+    const { channels: _ignored, ...rest } = request;
+    return {
+        ...rest,
+        target: { channels },
+    };
+}
 class NotificationsResource {
     constructor(api) {
         this.api = api;
     }
     send(request, initOverrides) {
-        return this.api.sendPushNotification({ pushNotificationRequest: request }, initOverrides);
+        return this.api.sendPushNotification({ pushNotificationRequest: withTargetChannels(request) }, initOverrides);
     }
     // Backward-compatible alias.
     sendPushNotification(...args) {
@@ -23,7 +35,7 @@ class LiveActivitiesResource {
         this.api = api;
     }
     start(request, initOverrides) {
-        return this.api.startLiveActivity({ liveActivityStartRequest: request }, initOverrides);
+        return this.api.startLiveActivity({ liveActivityStartRequest: withTargetChannels(request) }, initOverrides);
     }
     update(request, initOverrides) {
         return this.api.updateLiveActivity({ liveActivityUpdateRequest: request }, initOverrides);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "activitysmith",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "description": "Official ActivitySmith Node.js SDK",
   "keywords": [
     "activitysmith",

package/dist/generated/apis/NotificationsApi.d.ts

@@ -1,31 +0,0 @@
-/**
- * ActivitySmith API
- * Send push notifications and Live Activities to your own devices via a single API key.
- *
- * The version of the OpenAPI document: 1.0.0
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-import * as runtime from '../runtime';
-import type { PushNotificationRequest, PushNotificationResponse } from '../models/index';
-export interface SendPushNotificationRequest {
-    pushNotificationRequest: PushNotificationRequest;
-}
-/**
- *
- */
-export declare class NotificationsApi extends runtime.BaseAPI {
-    /**
-     * Sends a push notification to every paired device in your account.
-     * Send a push notification
-     */
-    sendPushNotificationRaw(requestParameters: SendPushNotificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PushNotificationResponse>>;
-    /**
-     * Sends a push notification to every paired device in your account.
-     * Send a push notification
-     */
-    sendPushNotification(requestParameters: SendPushNotificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PushNotificationResponse>;
-}

package/dist/generated/apis/NotificationsApi.js

@@ -1,59 +0,0 @@
-"use strict";
-/* tslint:disable */
-/* eslint-disable */
-/**
- * ActivitySmith API
- * Send push notifications and Live Activities to your own devices via a single API key.
- *
- * The version of the OpenAPI document: 1.0.0
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.NotificationsApi = void 0;
-const runtime = require("../runtime");
-const index_1 = require("../models/index");
-/**
- *
- */
-class NotificationsApi extends runtime.BaseAPI {
-    /**
-     * Sends a push notification to every paired device in your account.
-     * Send a push notification
-     */
-    async sendPushNotificationRaw(requestParameters, initOverrides) {
-        if (requestParameters['pushNotificationRequest'] == null) {
-            throw new runtime.RequiredError('pushNotificationRequest', 'Required parameter "pushNotificationRequest" was null or undefined when calling sendPushNotification().');
-        }
-        const queryParameters = {};
-        const headerParameters = {};
-        headerParameters['Content-Type'] = 'application/json';
-        if (this.configuration && this.configuration.accessToken) {
-            const token = this.configuration.accessToken;
-            const tokenString = await token("bearerAuth", []);
-            if (tokenString) {
-                headerParameters["Authorization"] = `Bearer ${tokenString}`;
-            }
-        }
-        const response = await this.request({
-            path: `/push-notification`,
-            method: 'POST',
-            headers: headerParameters,
-            query: queryParameters,
-            body: (0, index_1.PushNotificationRequestToJSON)(requestParameters['pushNotificationRequest']),
-        }, initOverrides);
-        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.PushNotificationResponseFromJSON)(jsonValue));
-    }
-    /**
-     * Sends a push notification to every paired device in your account.
-     * Send a push notification
-     */
-    async sendPushNotification(requestParameters, initOverrides) {
-        const response = await this.sendPushNotificationRaw(requestParameters, initOverrides);
-        return await response.value();
-    }
-}
-exports.NotificationsApi = NotificationsApi;

package/dist/generated/models/ContentStateEnd.d.ts

@@ -1,97 +0,0 @@
-/**
- * ActivitySmith API
- * Send push notifications and Live Activities to your own devices via a single API key.
- *
- * The version of the OpenAPI document: 1.0.0
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-/**
- * End payload. Required fields are title and current_step. number_of_steps is optional.
- * @export
- * @interface ContentStateEnd
- */
-export interface ContentStateEnd {
-    /**
-     *
-     * @type {string}
-     * @memberof ContentStateEnd
-     */
-    title: string;
-    /**
-     *
-     * @type {string}
-     * @memberof ContentStateEnd
-     */
-    subtitle?: string;
-    /**
-     *
-     * @type {number}
-     * @memberof ContentStateEnd
-     */
-    numberOfSteps?: number;
-    /**
-     *
-     * @type {number}
-     * @memberof ContentStateEnd
-     */
-    currentStep: number;
-    /**
-     * Optional. Accent color for the Live Activity. Defaults to blue.
-     * @type {string}
-     * @memberof ContentStateEnd
-     */
-    color?: ContentStateEndColorEnum;
-    /**
-     * Optional. Overrides color for the current step.
-     * @type {string}
-     * @memberof ContentStateEnd
-     */
-    stepColor?: ContentStateEndStepColorEnum;
-    /**
-     * 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.
-     * @type {number}
-     * @memberof ContentStateEnd
-     */
-    autoDismissMinutes?: number;
-}
-/**
- * @export
- */
-export declare const ContentStateEndColorEnum: {
-    readonly Lime: "lime";
-    readonly Green: "green";
-    readonly Cyan: "cyan";
-    readonly Blue: "blue";
-    readonly Purple: "purple";
-    readonly Magenta: "magenta";
-    readonly Red: "red";
-    readonly Orange: "orange";
-    readonly Yellow: "yellow";
-};
-export type ContentStateEndColorEnum = typeof ContentStateEndColorEnum[keyof typeof ContentStateEndColorEnum];
-/**
- * @export
- */
-export declare const ContentStateEndStepColorEnum: {
-    readonly Lime: "lime";
-    readonly Green: "green";
-    readonly Cyan: "cyan";
-    readonly Blue: "blue";
-    readonly Purple: "purple";
-    readonly Magenta: "magenta";
-    readonly Red: "red";
-    readonly Orange: "orange";
-    readonly Yellow: "yellow";
-};
-export type ContentStateEndStepColorEnum = typeof ContentStateEndStepColorEnum[keyof typeof ContentStateEndStepColorEnum];
-/**
- * Check if a given object implements the ContentStateEnd interface.
- */
-export declare function instanceOfContentStateEnd(value: object): value is ContentStateEnd;
-export declare function ContentStateEndFromJSON(json: any): ContentStateEnd;
-export declare function ContentStateEndFromJSONTyped(json: any, ignoreDiscriminator: boolean): ContentStateEnd;
-export declare function ContentStateEndToJSON(value?: ContentStateEnd | null): any;