@knocklabs/node 0.4.22 → 0.4.24

package/dist/package.json

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

package/dist/src/common/interfaces.d.ts

@@ -18,7 +18,7 @@ export interface UnprocessableEntityError {
     type: string;
     field: string;
 }
-export declare type ChannelType = "email" | "in_app_feed" | "sms" | "push" | "chat";
+export declare type ChannelType = "email" | "in_app_feed" | "sms" | "push" | "chat" | "http";
 export declare type CommonMetadata = Record<string, any>;
 export interface ChannelData<T = CommonMetadata> {
     channel_id: string;

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

@@ -1,6 +1,6 @@
 import { ChannelData, CommonMetadata, SetChannelDataProperties, PaginatedEntriesResponse, ChannelType, PaginatedItemsResponse } from "../../common/interfaces";
 import { Knock } from "../../knock";
-import { AddObjectSubscriptionProperties, BulkSetObjectOption, DeleteObjectSubscriptionProperties, ListObjectOptions, ListObjectSubscriptionsOptions, Object, ObjectSubscription, SetObjectProperties } from "./interfaces";
+import { AddObjectSubscriptionProperties, BulkAddSubscriptionsOption, BulkSetObjectOption, DeleteObjectSubscriptionProperties, ListObjectOptions, ListObjectSubscriptionsOptions, Object, ObjectSubscription, SetObjectProperties } from "./interfaces";
 import { BulkOperation } from "../bulk_operations/interfaces";
 import { ListMessagesOptions, Message } from "../messages/interfaces";
 import { ListSchedulesProps, Schedule } from "../workflows/interfaces";
@@ -14,6 +14,7 @@ export declare class Objects {
     bulkSet(collection: string, objects: BulkSetObjectOption[]): Promise<BulkOperation>;
     delete(collection: string, id: string): Promise<null>;
     bulkDelete(collection: string, objectIds: string[]): Promise<BulkOperation>;
+    bulkAddSubscriptions<T = CommonMetadata>(collection: string, subscriptions: BulkAddSubscriptionsOption<T>[]): Promise<BulkOperation>;
     getChannelData<T = CommonMetadata>(collection: string, id: string, channelId: string): Promise<ChannelData<T>>;
     setChannelData<T = CommonMetadata>(collection: string, id: string, channelId: string, channelData: SetChannelDataProperties): Promise<ChannelData<T>>;
     unsetChannelData(collection: string, id: string, channelId: string): Promise<any>;

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

@@ -33,6 +33,7 @@ class Objects {
             return data;
         });
     }
+    // Bulk ops
     bulkSet(collection, objects) {
         return __awaiter(this, void 0, void 0, function* () {
             const attrs = { objects };
@@ -55,6 +56,13 @@ class Objects {
             return data;
         });
     }
+    bulkAddSubscriptions(collection, subscriptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const attrs = { subscriptions };
+            const { data } = yield this.knock.post(`/v1/objects/${collection}/bulk/subscriptions/add`, attrs);
+            return data;
+        });
+    }
     // Channel data
     getChannelData(collection, id, channelId) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -171,7 +179,7 @@ class Objects {
     }
     getSubscriptions(collection, objectId, options = {}) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { data } = yield this.knock.get(`/v1/objects/${collection}/${objectId}/subscriptions`, Object.assign(Object.assign({}, options), { mode: "recipient" }));
+            const { data, } = yield this.knock.get(`/v1/objects/${collection}/${objectId}/subscriptions`, Object.assign(Object.assign({}, options), { mode: "recipient" }));
             return data;
         });
     }

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

@@ -1,5 +1,5 @@
 import { CommonMetadata, PaginationOptions } from "../../common/interfaces";
-import { User } from "../users/interfaces";
+import { User, IdentifyProperties as IdentifyUserProperties } from "../users/interfaces";
 import { Recipient, RecipientWithUpsert } from "../workflows/interfaces";
 export interface ObjectRef {
     collection: string;
@@ -21,6 +21,11 @@ export interface BulkSetObjectOption {
     name?: string;
     [key: string]: any;
 }
+export interface BulkAddSubscriptionsOption<T = CommonMetadata> {
+    id: string;
+    properties?: T;
+    recipients: (IdentifyUserProperties | SetObjectProperties | string)[];
+}
 export interface ListObjectOptions extends PaginationOptions {
     object_id?: string;
     name?: string;

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

@@ -4,7 +4,8 @@ import { ChannelTypePreferences, PreferenceOptions, PreferenceSet, SetPreference
 import { ListMessagesOptions, Message } from "../messages/interfaces";
 import { ListSchedulesProps, Schedule } from "../workflows/interfaces";
 import { Knock } from "../../knock";
-import { BulkIdentifyUser, IdentifyProperties, ListUserOptions, User, UserFeedOptions } from "./interfaces";
+import { BulkIdentifyUser, IdentifyProperties, ListSubscriptionsOptions, ListUserOptions, User, UserFeedOptions } from "./interfaces";
+import { ObjectSubscription } from "../objects/interfaces";
 export declare class Users {
     readonly knock: Knock;
     constructor(knock: Knock);
@@ -35,5 +36,5 @@ export declare class Users {
     unsetChannelData(userId: string, channelId: string): Promise<any>;
     getMessages(userId: string, filteringOptions?: ListMessagesOptions): Promise<PaginatedItemsResponse<Message>>;
     getSchedules(userId: string, filteringOptions?: ListSchedulesProps): Promise<PaginatedEntriesResponse<Schedule>>;
-    getSubscriptions(userId: string, filteringOptions?: ListSchedulesProps): Promise<PaginatedEntriesResponse<Schedule>>;
+    getSubscriptions(userId: string, filteringOptions?: ListSubscriptionsOptions): Promise<PaginatedEntriesResponse<ObjectSubscription>>;
 }

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

@@ -30,3 +30,5 @@ export interface ListUserOptions extends PaginationOptions {
     email?: string;
     user_id?: string;
 }
+export interface ListSubscriptionsOptions extends PaginationOptions {
+}

package/package.json

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