@knocklabs/node 0.4.16 → 0.4.17

package/dist/package.json

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

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

@@ -28,11 +28,11 @@ declare type PageInfo = {
     after: string;
     page_size: number;
 };
-export interface PaginatedFeedResponse<T> {
+export interface PaginatedEntriesResponse<T> {
     entries: T[];
     page_info: PageInfo;
 }
-export interface PaginatedResponse<T> {
+export interface PaginatedItemsResponse<T> {
     items: T[];
     page_info: PageInfo;
 }

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

@@ -1,15 +1,15 @@
-import { PaginatedResponse, PaginationOptions } from "../../common/interfaces";
+import { PaginatedItemsResponse, PaginationOptions } from "../../common/interfaces";
 import { Message, MessageContent, MessageEvent, ListMessageActivitiesOptions, ListMessagesOptions, MessageEngagementStatus } from "./interfaces";
 import { Activity } from "../activities/interfaces";
 import { Knock } from "../../knock";
 export declare class Messages {
     readonly knock: Knock;
     constructor(knock: Knock);
-    list(filteringOptions?: ListMessagesOptions): Promise<PaginatedResponse<Message>>;
+    list(filteringOptions?: ListMessagesOptions): Promise<PaginatedItemsResponse<Message>>;
     get(messageId: string): Promise<Message>;
     getContent(messageId: string): Promise<MessageContent>;
-    getEvents(messageId: string, paginationOptions?: PaginationOptions): Promise<PaginatedResponse<MessageEvent>>;
-    getActivities(messageId: string, filteringOptions?: ListMessageActivitiesOptions): Promise<PaginatedResponse<Activity>>;
+    getEvents(messageId: string, paginationOptions?: PaginationOptions): Promise<PaginatedItemsResponse<MessageEvent>>;
+    getActivities(messageId: string, filteringOptions?: ListMessageActivitiesOptions): Promise<PaginatedItemsResponse<Activity>>;
     setStatus(messageId: string, status: MessageEngagementStatus): Promise<Message>;
     deleteStatus(messageId: string, status: MessageEngagementStatus): Promise<Message>;
     batchSetStatus(messageIds: string[], status: MessageEngagementStatus | "unseen" | "unread" | "unarchived"): Promise<Message[]>;

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

@@ -1,4 +1,4 @@
-import { ChannelData, CommonMetadata, SetChannelDataProperties, PaginatedResponse, ChannelType } from "../../common/interfaces";
+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 { BulkOperation } from "../bulk_operations/interfaces";
@@ -9,14 +9,14 @@ 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>>>;
+    list<T = CommonMetadata>(collection: string, filteringOptions?: ListObjectOptions): Promise<PaginatedEntriesResponse<Object<T>>>;
     bulkSet(collection: string, objects: BulkSetObjectOption[]): Promise<BulkOperation>;
     delete(collection: string, id: string): Promise<null>;
     bulkDelete(collection: string, objectIds: string[]): 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>;
-    getMessages(collection: string, objectId: string, filteringOptions?: ListMessagesOptions): Promise<PaginatedResponse<Message>>;
+    getMessages(collection: string, objectId: string, filteringOptions?: ListMessagesOptions): Promise<PaginatedItemsResponse<Message>>;
     getAllPreferences(collection: string, objectId: string): Promise<PreferenceSet[]>;
     /**
      * @deprecated Use `objects.getPreferences` instead
@@ -30,7 +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>>;
+    listSubscriptions(collection: string, objectId: string, options?: ListObjectSubscriptionsOptions): Promise<PaginatedEntriesResponse<ObjectSubscription>>;
     addSubscriptions(collection: string, objectId: string, properties?: AddObjectSubscriptionProperties): Promise<ObjectSubscription[]>;
     deleteSubscriptions(collection: string, objectId: string, properties?: DeleteObjectSubscriptionProperties): Promise<ObjectSubscription[]>;
 }

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

@@ -1,10 +1,10 @@
-import { CommonMetadata, PaginatedResponse } from "../../common/interfaces";
+import { CommonMetadata, PaginatedEntriesResponse } from "../../common/interfaces";
 import { Knock } from "../../knock";
 import { Tenant, SetTenant, ListTenantsOptions } from "./interfaces";
 export declare class Tenants {
     readonly knock: Knock;
     constructor(knock: Knock);
-    list(filteringOptions?: ListTenantsOptions): Promise<PaginatedResponse<Tenant>>;
+    list(filteringOptions?: ListTenantsOptions): Promise<PaginatedEntriesResponse<Tenant>>;
     get<T = CommonMetadata>(id: string): Promise<Tenant<T>>;
     set<T = CommonMetadata>(id: string, tenantData: SetTenant): Promise<Tenant<T>>;
     delete(id: string): Promise<null>;

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

@@ -1,4 +1,4 @@
-import { ChannelData, ChannelType, CommonMetadata, PaginatedFeedResponse, PaginatedResponse } from "../../common/interfaces";
+import { ChannelData, ChannelType, CommonMetadata, PaginatedItemsResponse, PaginatedEntriesResponse } from "../../common/interfaces";
 import { BulkOperation } from "../bulk_operations/interfaces";
 import { ChannelTypePreferences, PreferenceOptions, PreferenceSet, SetPreferencesProperties, WorkflowPreferences, WorkflowPreferenceSetting } from "../preferences/interfaces";
 import { ListMessagesOptions, Message } from "../messages/interfaces";
@@ -10,11 +10,11 @@ export declare class Users {
     identify(userId: string, properties?: IdentifyProperties): Promise<User>;
     bulkIdentify(users: BulkIdentifyUser[]): Promise<BulkOperation>;
     get(userId: string): Promise<User>;
-    list(filteringOptions?: ListUserOptions): Promise<PaginatedResponse<User>>;
+    list(filteringOptions?: ListUserOptions): Promise<PaginatedEntriesResponse<User>>;
     delete(userId: string): Promise<null>;
     bulkDelete(userIds: string[]): Promise<BulkOperation>;
     merge(toUserId: string, fromUserId: string): Promise<User>;
-    getFeed(userId: string, channelId: string, feedOptions?: UserFeedOptions): Promise<PaginatedFeedResponse<any>>;
+    getFeed(userId: string, channelId: string, feedOptions?: UserFeedOptions): Promise<PaginatedEntriesResponse<any>>;
     getAllPreferences(userId: string): Promise<any>;
     /**
      * @deprecated Use `users.getPreferences` instead
@@ -32,5 +32,5 @@ export declare class Users {
     getChannelData<T = CommonMetadata>(userId: string, channelId: string): Promise<ChannelData<T>>;
     setChannelData<T = CommonMetadata>(userId: string, channelId: string, channelData: Record<string, any>): Promise<ChannelData<T>>;
     unsetChannelData(userId: string, channelId: string): Promise<any>;
-    getMessages(userId: string, filteringOptions?: ListMessagesOptions): Promise<PaginatedResponse<Message>>;
+    getMessages(userId: string, filteringOptions?: ListMessagesOptions): Promise<PaginatedItemsResponse<Message>>;
 }

package/package.json

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