@knocklabs/client 0.13.0 → 0.14.0

package/src/clients/users/index.ts

@@ -3,6 +3,10 @@ import { GenericData } from "@knocklabs/types";
 import { ApiResponse } from "../../api";
 import { ChannelData, User } from "../../interfaces";
 import Knock from "../../knock";
+import {
+  GuideEngagementEventBaseParams,
+  guidesApiRootPath,
+} from "../guide/client";
 import {
   GetPreferencesOptions,
   PreferenceOptions,
@@ -112,6 +116,29 @@ class UserClient {
     return this.handleResponse<ChannelData<T>>(result);
   }
 
+  async getGuides<P, R>(channelId: string, params: P) {
+    const result = await this.instance.client().makeRequest({
+      method: "GET",
+      url: `${guidesApiRootPath(this.instance.userId)}/${channelId}`,
+      params,
+    });
+
+    return this.handleResponse<R>(result);
+  }
+
+  async markGuideStepAs<P extends GuideEngagementEventBaseParams, R>(
+    status: "seen" | "interacted" | "archived",
+    params: P,
+  ) {
+    const result = await this.instance.client().makeRequest({
+      method: "PUT",
+      url: `${guidesApiRootPath(this.instance.userId)}/messages/${params.message_id}/${status}`,
+      data: params,
+    });
+
+    return this.handleResponse<R>(result);
+  }
+
   private handleResponse<T>(response: ApiResponse) {
     if (response.statusCode === "error") {
       throw new Error(response.error || response.body);

package/src/index.ts

@@ -2,6 +2,7 @@ import FeedClient, { Feed } from "./clients/feed";
 import Knock from "./knock";
 
 export * from "./interfaces";
+export * from "./clients/guide";
 export * from "./clients/feed/types";
 export * from "./clients/feed/interfaces";
 export * from "./clients/objects";