@knocklabs/client 0.9.4 → 0.10.0

package/src/clients/messages/index.ts

@@ -0,0 +1,90 @@
+import { ApiResponse } from "../../api";
+import { BulkOperation } from "../../interfaces";
+import Knock from "../../knock";
+
+import {
+  BulkUpdateMessagesInChannelProperties,
+  Message,
+  MessageEngagementStatus,
+} from "./interfaces";
+
+class MessageClient {
+  private knock: Knock;
+
+  constructor(knock: Knock) {
+    this.knock = knock;
+  }
+
+  async get(messageId: string): Promise<Message> {
+    const result = await this.knock.client().makeRequest({
+      method: "GET",
+      url: `/v1/messages/${messageId}`,
+    });
+
+    return this.handleResponse<Message>(result);
+  }
+
+  async updateStatus(
+    messageId: string,
+    status: MessageEngagementStatus,
+  ): Promise<Message> {
+    const result = await this.knock.client().makeRequest({
+      method: "PUT",
+      url: `/v1/messages/${messageId}/${status}`,
+    });
+
+    return this.handleResponse<Message>(result);
+  }
+
+  async removeStatus(
+    messageId: string,
+    status: Exclude<MessageEngagementStatus, "interacted">,
+  ): Promise<Message> {
+    const result = await this.knock.client().makeRequest({
+      method: "DELETE",
+      url: `/v1/messages/${messageId}/${status}`,
+    });
+
+    return this.handleResponse<Message>(result);
+  }
+
+  async batchUpdateStatuses(
+    messageIds: string[],
+    status: MessageEngagementStatus | "unseen" | "unread" | "unarchived",
+  ): Promise<Message[]> {
+    const result = await this.knock.client().makeRequest({
+      method: "POST",
+      url: `/v1/messages/batch/${status}`,
+      data: { message_ids: messageIds },
+    });
+
+    return this.handleResponse<Message[]>(result);
+  }
+
+  async bulkUpdateAllStatusesInChannel({
+    channelId,
+    status,
+    options,
+  }: BulkUpdateMessagesInChannelProperties): Promise<BulkOperation> {
+    const result = await this.knock.client().makeRequest({
+      method: "POST",
+      url: `/v1/channels/${channelId}/messages/bulk/${status}`,
+      data: options,
+    });
+
+    return this.handleResponse<BulkOperation>(result);
+  }
+
+  private handleResponse<T = any>(response: ApiResponse) {
+    if (response.statusCode === "error") {
+      if (response.error?.response?.status < 500) {
+        return response.error || response.body;
+      }
+      throw new Error(response.error || response.body);
+    }
+
+    return response.body as T;
+  }
+}
+
+export default MessageClient;

package/src/clients/messages/interfaces.ts

@@ -0,0 +1,53 @@
+import { RecipientRef } from "../..";
+
+export type MessageDeliveryStatus =
+  | "queued"
+  | "sent"
+  | "delivered"
+  | "delivery_attempted"
+  | "undelivered"
+  | "not_sent";
+
+export interface NotificationSource {
+  key: string;
+  version_id: string;
+  categories: string[];
+}
+
+export type MessageEngagementStatus =
+  | "seen"
+  | "read"
+  | "interacted"
+  | "archived";
+
+export interface Message<T = any> {
+  id: string;
+  channel_id: string;
+  recipient: RecipientRef;
+  actors: RecipientRef[];
+  inserted_at: string;
+  updated_at: string;
+  read_at: string | null;
+  seen_at: string | null;
+  archived_at: string | null;
+  tenant: string | null;
+  status: MessageDeliveryStatus;
+  engagement_statuses: MessageEngagementStatus[];
+  source: NotificationSource;
+  data: T | null;
+  metadata: {
+    external_id?: string;
+  };
+}
+
+export type BulkUpdateMessagesInChannelProperties = {
+  channelId: string;
+  status: "seen" | "read" | "archive";
+  options: {
+    user_ids?: string[];
+    engagement_status?: "seen" | "read" | "unseen" | "unread";
+    archived?: "exclude" | "include" | "only";
+    has_tenant?: boolean;
+    tenants?: string[];
+  };
+};

package/src/index.ts

@@ -10,6 +10,9 @@ export * from "./clients/preferences/interfaces";
 export * from "./clients/slack";
 export * from "./clients/slack/interfaces";
 export * from "./clients/users";
+export * from "./clients/users/interfaces";
+export * from "./clients/messages";
+export * from "./clients/messages/interfaces";
 export * from "./networkStatus";
 
 export default Knock;

package/src/interfaces.ts

@@ -27,6 +27,8 @@ export interface User extends GenericData {
 
 export type Recipient = User | KnockObject;
 
+export type RecipientRef = string | { collection: string; id: string };
+
 export interface Activity<T = GenericData> {
   id: string;
   inserted_at: string;
@@ -50,3 +52,16 @@ export interface AuthenticateOptions {
   onUserTokenExpiring?: UserTokenExpiringCallback;
   timeBeforeExpirationInMs?: number;
 }
+
+export interface BulkOperation {
+  id: string;
+  name: string;
+  status: "queued" | "processing" | "completed" | "failed";
+  processed_rows: number;
+  estimated_total_rows: number;
+  started_at?: string;
+  completed_at?: string;
+  failed_at?: string;
+  inserted_at: string;
+  updated_at: string;
+}

package/src/knock.ts

@@ -2,6 +2,7 @@ import { jwtDecode } from "jwt-decode";
 
 import ApiClient from "./api";
 import FeedClient from "./clients/feed";
+import MessageClient from "./clients/messages";
 import ObjectClient from "./clients/objects";
 import Preferences from "./clients/preferences";
 import SlackClient from "./clients/slack";
@@ -27,6 +28,7 @@ class Knock {
   readonly preferences = new Preferences(this);
   readonly slack = new SlackClient(this);
   readonly user = new UserClient(this);
+  readonly messages = new MessageClient(this);
 
   constructor(
     readonly apiKey: string,