@knocklabs/node 0.4.11 → 0.4.13

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@knocklabs/node",
-    "version": "0.4.11",
+    "version": "0.4.13",
     "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, Object, SetObjectProperties } from "./interfaces";
+import { BulkSetObjectOption, ListObjectOptions, Object, 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";
@@ -9,6 +9,7 @@ export declare class Objects {
     constructor(knock: Knock);
     get<T = CommonMetadata>(collection: string, id: string): Promise<Object<T>>;
     set<T = CommonMetadata>(collection: string, id: string, properties: SetObjectProperties): Promise<Object<T>>;
+    list<T = CommonMetadata>(collection: string, filteringOptions?: ListObjectOptions): Promise<PaginatedResponse<Object<T>>>;
     bulkSet(collection: string, objects: BulkSetObjectOption[]): Promise<BulkOperation>;
     delete(collection: string, id: string): Promise<null>;
     bulkDelete(collection: string, objectIds: string[]): Promise<BulkOperation>;

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

@@ -27,6 +27,12 @@ class Objects {
             return data;
         });
     }
+    list(collection, filteringOptions = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data } = yield this.knock.get(`/v1/objects/${collection}`, filteringOptions);
+            return data;
+        });
+    }
     bulkSet(collection, objects) {
         return __awaiter(this, void 0, void 0, function* () {
             const attrs = { objects };

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

@@ -1,4 +1,4 @@
-import { CommonMetadata } from "../../common/interfaces";
+import { CommonMetadata, PaginationOptions } from "../../common/interfaces";
 export interface ObjectRef {
     collection: string;
     id: string;
@@ -19,3 +19,7 @@ export interface BulkSetObjectOption {
     name?: string;
     [key: string]: any;
 }
+export interface ListObjectOptions extends PaginationOptions {
+    object_id?: string;
+    name?: string;
+}

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

@@ -3,13 +3,14 @@ import { BulkOperation } from "../bulk_operations/interfaces";
 import { ChannelTypePreferences, PreferenceOptions, PreferenceSet, SetPreferencesProperties, WorkflowPreferences, WorkflowPreferenceSetting } from "../preferences/interfaces";
 import { ListMessagesOptions, Message } from "../messages/interfaces";
 import { Knock } from "../../knock";
-import { BulkIdentifyUser, IdentifyProperties, User, UserFeedOptions } from "./interfaces";
+import { BulkIdentifyUser, IdentifyProperties, ListUserOptions, User, UserFeedOptions } from "./interfaces";
 export declare class Users {
     readonly knock: Knock;
     constructor(knock: Knock);
     identify(userId: string, properties?: IdentifyProperties): Promise<User>;
     bulkIdentify(users: BulkIdentifyUser[]): Promise<BulkOperation>;
     get(userId: string): Promise<User>;
+    list(filteringOptions?: ListUserOptions): Promise<PaginatedResponse<User>>;
     delete(userId: string): Promise<null>;
     bulkDelete(userIds: string[]): Promise<BulkOperation>;
     merge(toUserId: string, fromUserId: string): Promise<User>;

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

@@ -43,6 +43,12 @@ class Users {
             return data;
         });
     }
+    list(filteringOptions = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data } = yield this.knock.get(`/v1/users`, filteringOptions);
+            return data;
+        });
+    }
     delete(userId) {
         return __awaiter(this, void 0, void 0, function* () {
             if (!userId) {

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

@@ -20,5 +20,12 @@ export interface BulkIdentifyUser extends IdentifyProperties {
 export interface UserFeedOptions extends PaginationOptions {
     source?: string;
     tenant?: string;
+    has_tenant?: boolean;
+    archived?: "include" | "exclude" | "only";
     status?: "unread" | "unseen" | "all";
 }
+export interface ListUserOptions extends PaginationOptions {
+    name?: string;
+    email?: string;
+    user_id?: string;
+}

package/package.json

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