@knocklabs/node 0.4.14 → 0.4.15

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@knocklabs/node",
-    "version": "0.4.14",
+    "version": "0.4.15",
     "description": "Library for interacting with the Knock API",
     "homepage": "https://github.com/knocklabs/knock-node",
     "author": "@knocklabs",

package/dist/src/resources/objects/index.d.ts

@@ -1,6 +1,6 @@
 import { ChannelData, CommonMetadata, SetChannelDataProperties, PaginatedResponse, ChannelType } from "../../common/interfaces";
 import { Knock } from "../../knock";
-import { BulkSetObjectOption, ListObjectOptions, Object, SetObjectProperties } from "./interfaces";
+import { AddObjectSubscriptionProperties, BulkSetObjectOption, DeleteObjectSubscriptionProperties, ListObjectOptions, ListObjectSubscriptionsOptions, Object, ObjectSubscription, SetObjectProperties } from "./interfaces";
 import { BulkOperation } from "../bulk_operations/interfaces";
 import { ListMessagesOptions, Message } from "../messages/interfaces";
 import { ChannelTypePreferences, PreferenceOptions, PreferenceSet, SetPreferencesProperties, WorkflowPreferences, WorkflowPreferenceSetting } from "../preferences/interfaces";
@@ -30,4 +30,7 @@ export declare class Objects {
     setWorkflowPreferences(collection: string, objectId: string, workflowKey: string, setting: WorkflowPreferenceSetting, options?: PreferenceOptions): Promise<PreferenceSet>;
     setCategoriesPreferences(collection: string, objectId: string, categoryPreferences: WorkflowPreferences, options?: PreferenceOptions): Promise<PreferenceSet>;
     setCategoryPreferences(collection: string, objectId: string, categoryKey: string, setting: WorkflowPreferenceSetting, options?: PreferenceOptions): Promise<PreferenceSet>;
+    listSubscriptions(collection: string, objectId: string, options?: ListObjectSubscriptionsOptions): Promise<PaginatedResponse<ObjectSubscription>>;
+    addSubscriptions(collection: string, objectId: string, properties?: AddObjectSubscriptionProperties): Promise<ObjectSubscription[]>;
+    deleteSubscriptions(collection: string, objectId: string, properties?: DeleteObjectSubscriptionProperties): Promise<ObjectSubscription[]>;
 }

package/dist/src/resources/objects/index.js

@@ -160,5 +160,26 @@ class Objects {
             return data;
         });
     }
+    //
+    // Subscriptions
+    //
+    listSubscriptions(collection, objectId, options = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data } = yield this.knock.get(`/v1/objects/${collection}/${objectId}/subscriptions`, options);
+            return data;
+        });
+    }
+    addSubscriptions(collection, objectId, properties = { recipients: [] }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data } = yield this.knock.post(`/v1/objects/${collection}/${objectId}/subscriptions`, properties);
+            return data;
+        });
+    }
+    deleteSubscriptions(collection, objectId, properties = { recipients: [] }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data } = yield this.knock.delete(`/v1/objects/${collection}/${objectId}/subscriptions`, properties);
+            return data;
+        });
+    }
 }
 exports.Objects = Objects;

package/dist/src/resources/objects/interfaces.d.ts

@@ -1,4 +1,6 @@
 import { CommonMetadata, PaginationOptions } from "../../common/interfaces";
+import { User } from "../users/interfaces";
+import { Recipient, RecipientWithUpsert } from "../workflows/interfaces";
 export interface ObjectRef {
     collection: string;
     id: string;
@@ -23,3 +25,18 @@ export interface ListObjectOptions extends PaginationOptions {
     object_id?: string;
     name?: string;
 }
+export interface ListObjectSubscriptionsOptions extends PaginationOptions {
+}
+export interface ObjectSubscription<T = CommonMetadata> {
+    recipient: User | Object;
+    properties: T;
+    inserted_at: string;
+    updated_at: string;
+}
+export interface AddObjectSubscriptionProperties {
+    recipients: (Recipient | RecipientWithUpsert)[];
+    properties?: CommonMetadata;
+}
+export interface DeleteObjectSubscriptionProperties {
+    recipients: Recipient[];
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knocklabs/node",
-  "version": "0.4.14",
+  "version": "0.4.15",
   "description": "Library for interacting with the Knock API",
   "homepage": "https://github.com/knocklabs/knock-node",
   "author": "@knocklabs",