@knocklabs/client 0.10.13 → 0.11.0-rc-1.0

package/src/clients/in-app-messages/types.ts

@@ -0,0 +1,77 @@
+import { GenericData, PageInfo, Tenant } from "@knocklabs/types";
+
+import { NetworkStatus } from "../../networkStatus";
+import { NotificationSource } from "../messages/interfaces";
+
+export interface InAppMessage<
+  TContent extends GenericData = GenericData,
+  TData extends GenericData = GenericData,
+  TTenantProperties = GenericData,
+> {
+  __cursor: string;
+  id: string;
+  message_type: string;
+  schema_variant: string;
+  schema_version: string;
+  content: TContent;
+  data: TData | null;
+  inserted_at: string;
+  updated_at: string;
+  seen_at: string | null;
+  read_at: string | null;
+  interacted_at: string | null;
+  archived_at: string | null;
+  link_clicked_at: string | null;
+  source: NotificationSource;
+  tenant: Tenant<TTenantProperties>;
+}
+
+export interface InAppMessagesResponse<
+  TContent extends GenericData = GenericData,
+  TData extends GenericData = GenericData,
+> {
+  entries: InAppMessage<TContent, TData>[];
+  pageInfo: PageInfo;
+}
+
+export interface InAppMessagesQueryInfo {
+  networkStatus: NetworkStatus;
+  loading: boolean;
+  data?: {
+    messageIds: string[];
+    pageInfo: PageInfo;
+  };
+}
+
+export interface InAppMessagesStoreState {
+  messages: Record<string, InAppMessage>;
+  queries: Record<string, InAppMessagesQueryInfo>;
+}
+
+export type InAppMessageEngagementStatus =
+  | "read"
+  | "unread"
+  | "seen"
+  | "unseen"
+  | "link_clicked"
+  | "link_unclicked"
+  | "interacted"
+  | "uninteracted";
+
+export interface InAppMessagesClientOptions {
+  order?: "asc" | "desc";
+  before?: string;
+  after?: string;
+  page_size?: number;
+  engagement_status?: InAppMessageEngagementStatus[];
+  // Optionally scope all requests to a particular tenant or tenants
+  tenant_id?: string | string[];
+  // Optionally scope to notifications from the given workflow or workflows
+  workflow_key?: string | string[];
+  // Optionally scope to notifications with any of the categories provided
+  workflow_categories?: string[];
+  // Optionally scope to a given archived status (defaults to `exclude`)
+  archived?: "include" | "exclude" | "only";
+  // Optionally scope all notifications that contain this argument as part of their trigger payload
+  trigger_data?: GenericData;
+}

package/src/clients/preferences/interfaces.ts

@@ -1,7 +1,7 @@
 import { ChannelType } from "@knocklabs/types";
 
 export type ChannelTypePreferences = {
-  [K in ChannelType]?: boolean;
+  [_K in ChannelType]?: boolean;
 };
 
 export type WorkflowPreferenceSetting =

package/src/clients/users/index.ts

@@ -3,6 +3,7 @@ import { GenericData } from "@knocklabs/types";
 import { ApiResponse } from "../../api";
 import { ChannelData, User } from "../../interfaces";
 import Knock from "../../knock";
+import { InAppMessagesResponse } from "../in-app-messages";
 import {
   GetPreferencesOptions,
   PreferenceOptions,
@@ -10,7 +11,11 @@ import {
   SetPreferencesProperties,
 } from "../preferences/interfaces";
 
-import { GetChannelDataInput, SetChannelDataInput } from "./interfaces";
+import {
+  GetChannelDataInput,
+  GetInAppMessagesInput,
+  SetChannelDataInput,
+} from "./interfaces";
 
 const DEFAULT_PREFERENCE_SET_ID = "default";
 
@@ -100,6 +105,19 @@ class UserClient {
     return this.handleResponse<ChannelData<T>>(result);
   }
 
+  async getInAppMessages<
+    TContent extends GenericData = GenericData,
+    TData extends GenericData = GenericData,
+  >({ channelId, messageType, params }: GetInAppMessagesInput) {
+    const result = await this.instance.client().makeRequest({
+      method: "GET",
+      url: `/v1/users/${this.instance.userId}/in-app-messages/${channelId}/${messageType}`,
+      params,
+    });
+
+    return this.handleResponse<InAppMessagesResponse<TContent, TData>>(result);
+  }
+
   private handleResponse<T>(response: ApiResponse) {
     if (response.statusCode === "error") {
       throw new Error(response.error || response.body);

package/src/clients/users/interfaces.ts

@@ -1,5 +1,7 @@
 import { GenericData } from "@knocklabs/types";
 
+import { InAppMessagesClientOptions } from "../in-app-messages/types";
+
 export interface SetChannelDataInput {
   channelId: string;
   channelData: GenericData;
@@ -8,3 +10,11 @@ export interface SetChannelDataInput {
 export interface GetChannelDataInput {
   channelId: string;
 }
+
+export interface GetInAppMessagesInput {
+  channelId: string;
+  messageType: string;
+  params: Omit<InAppMessagesClientOptions, "trigger_data"> & {
+    trigger_data: string;
+  };
+}

package/src/index.ts

@@ -12,6 +12,7 @@ export * from "./clients/slack/interfaces";
 export * from "./clients/users";
 export * from "./clients/users/interfaces";
 export * from "./clients/messages";
+export * from "./clients/in-app-messages";
 export * from "./clients/messages/interfaces";
 export * from "./networkStatus";