@knocklabs/node 0.6.19 → 1.1.0

package/resources/users/feeds.js

@@ -0,0 +1,43 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Feeds = void 0;
+const resource_1 = require("../../core/resource.js");
+const pagination_1 = require("../../core/pagination.js");
+const path_1 = require("../../internal/utils/path.js");
+class Feeds extends resource_1.APIResource {
+    /**
+     * Returns the feed settings for a user.
+     *
+     * @example
+     * ```ts
+     * const response = await client.users.feeds.getSettings(
+     *   'user_id',
+     *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     * );
+     * ```
+     */
+    getSettings(userID, id, options) {
+        return this._client.get((0, path_1.path) `/v1/users/${userID}/feeds/${id}/settings`, options);
+    }
+    /**
+     * Returns a paginated list of feed items for a user, including metadata about the
+     * feed.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const feedListItemsResponse of client.users.feeds.listItems(
+     *   'user_id',
+     *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     * )) {
+     *   // ...
+     * }
+     * ```
+     */
+    listItems(userID, id, query = {}, options) {
+        return this._client.getAPIList((0, path_1.path) `/v1/users/${userID}/feeds/${id}`, (pagination_1.EntriesCursor), { query, ...options });
+    }
+}
+exports.Feeds = Feeds;
+//# sourceMappingURL=feeds.js.map

package/resources/users/feeds.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"feeds.js","sourceRoot":"","sources":["../../src/resources/users/feeds.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAIlD,yDAA6F;AAE7F,uDAAiD;AAEjD,MAAa,KAAM,SAAQ,sBAAW;IACpC;;;;;;;;;;OAUG;IACH,WAAW,CAAC,MAAc,EAAE,EAAU,EAAE,OAAwB;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,aAAa,MAAM,UAAU,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC;IACnF,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,SAAS,CACP,MAAc,EACd,EAAU,EACV,QAAgD,EAAE,EAClD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAA,WAAI,EAAA,aAAa,MAAM,UAAU,EAAE,EAAE,EACrC,CAAA,0BAAoC,CAAA,EACpC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;CACF;AA3CD,sBA2CC"}

package/resources/users/feeds.mjs

@@ -0,0 +1,39 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../core/resource.mjs";
+import { EntriesCursor } from "../../core/pagination.mjs";
+import { path } from "../../internal/utils/path.mjs";
+export class Feeds extends APIResource {
+    /**
+     * Returns the feed settings for a user.
+     *
+     * @example
+     * ```ts
+     * const response = await client.users.feeds.getSettings(
+     *   'user_id',
+     *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     * );
+     * ```
+     */
+    getSettings(userID, id, options) {
+        return this._client.get(path `/v1/users/${userID}/feeds/${id}/settings`, options);
+    }
+    /**
+     * Returns a paginated list of feed items for a user, including metadata about the
+     * feed.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const feedListItemsResponse of client.users.feeds.listItems(
+     *   'user_id',
+     *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     * )) {
+     *   // ...
+     * }
+     * ```
+     */
+    listItems(userID, id, query = {}, options) {
+        return this._client.getAPIList(path `/v1/users/${userID}/feeds/${id}`, (EntriesCursor), { query, ...options });
+    }
+}
+//# sourceMappingURL=feeds.mjs.map

package/resources/users/feeds.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"feeds.mjs","sourceRoot":"","sources":["../../src/resources/users/feeds.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAIf,EAAE,aAAa,EAAyC;OAExD,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;OAUG;IACH,WAAW,CAAC,MAAc,EAAE,EAAU,EAAE,OAAwB;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,MAAM,UAAU,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC;IACnF,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,SAAS,CACP,MAAc,EACd,EAAU,EACV,QAAgD,EAAE,EAClD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAI,CAAA,aAAa,MAAM,UAAU,EAAE,EAAE,EACrC,CAAA,aAAoC,CAAA,EACpC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;CACF"}

package/resources/users/guides.d.mts

@@ -0,0 +1,293 @@
+import { APIResource } from "../../core/resource.mjs";
+import { APIPromise } from "../../core/api-promise.mjs";
+import { RequestOptions } from "../../internal/request-options.mjs";
+export declare class Guides extends APIResource {
+    /**
+     * Returns a list of eligible in-app guides for a specific user and channel.
+     *
+     * @example
+     * ```ts
+     * const response = await client.users.guides.getChannel(
+     *   'user_id',
+     *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     * );
+     * ```
+     */
+    getChannel(userID: string, channelID: string, query?: GuideGetChannelParams | null | undefined, options?: RequestOptions): APIPromise<GuideGetChannelResponse>;
+    /**
+     * Records that a guide has been archived by a user, triggering any associated
+     * archived events.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.users.guides.markMessageAsArchived(
+     *     'user_id',
+     *     'message_id',
+     *     {
+     *       channel_id: '123e4567-e89b-12d3-a456-426614174000',
+     *       guide_id: '7e9dc78c-b3b1-4127-a54e-71f1899b831a',
+     *       guide_key: 'tour_notification',
+     *       guide_step_ref: 'lab_tours',
+     *     },
+     *   );
+     * ```
+     */
+    markMessageAsArchived(userID: string, messageID: string, body: GuideMarkMessageAsArchivedParams, options?: RequestOptions): APIPromise<GuideMarkMessageAsArchivedResponse>;
+    /**
+     * Records that a user has interacted with a guide, triggering any associated
+     * interacted events.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.users.guides.markMessageAsInteracted(
+     *     'user_id',
+     *     'message_id',
+     *     {
+     *       channel_id: '123e4567-e89b-12d3-a456-426614174000',
+     *       guide_id: '7e9dc78c-b3b1-4127-a54e-71f1899b831a',
+     *       guide_key: 'tour_notification',
+     *       guide_step_ref: 'lab_tours',
+     *     },
+     *   );
+     * ```
+     */
+    markMessageAsInteracted(userID: string, messageID: string, body: GuideMarkMessageAsInteractedParams, options?: RequestOptions): APIPromise<GuideMarkMessageAsInteractedResponse>;
+    /**
+     * Records that a guide has been seen by a user, triggering any associated seen
+     * events.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.users.guides.markMessageAsSeen(
+     *     'user_id',
+     *     'message_id',
+     *     {
+     *       channel_id: '123e4567-e89b-12d3-a456-426614174000',
+     *       guide_id: '7e9dc78c-b3b1-4127-a54e-71f1899b831a',
+     *       guide_key: 'tour_notification',
+     *       guide_step_ref: 'lab_tours',
+     *       content: {
+     *         body: "Limited spots available for today's behind-the-scenes DNA extraction demonstration.",
+     *         title: 'DNA Lab Tour Available',
+     *       },
+     *       data: {
+     *         next_time: '14:30',
+     *         spots_left: 8,
+     *         tour_id: 'dna_lab_tour',
+     *       },
+     *       metadata: {
+     *         cta: 'Reserve Spot',
+     *         theme: 'amber',
+     *         type: 'banner',
+     *       },
+     *       tenant: 'ingen_isla_nublar',
+     *     },
+     *   );
+     * ```
+     */
+    markMessageAsSeen(userID: string, messageID: string, body: GuideMarkMessageAsSeenParams, options?: RequestOptions): APIPromise<GuideMarkMessageAsSeenResponse>;
+}
+/**
+ * A response for a list of guides.
+ */
+export interface GuideGetChannelResponse {
+    /**
+     * A list of guides.
+     */
+    guides: Array<GuideGetChannelResponse.Guide>;
+    /**
+     * The recipient of the guide.
+     */
+    recipient?: GuideGetChannelResponse.Recipient | null;
+}
+export declare namespace GuideGetChannelResponse {
+    interface Guide {
+        /**
+         * The unique identifier for the guide.
+         */
+        id?: string;
+        /**
+         * The content of the guide.
+         */
+        content?: string;
+        /**
+         * The metadata of the guide.
+         */
+        metadata?: Record<string, unknown>;
+        /**
+         * The title of the guide.
+         */
+        title?: string;
+    }
+    /**
+     * The recipient of the guide.
+     */
+    interface Recipient {
+        /**
+         * Unique identifier for the recipient.
+         */
+        id?: string;
+    }
+}
+/**
+ * A response for a guide action.
+ */
+export interface GuideMarkMessageAsArchivedResponse {
+    /**
+     * The status of a guide's action.
+     */
+    status: string;
+}
+/**
+ * A response for a guide action.
+ */
+export interface GuideMarkMessageAsInteractedResponse {
+    /**
+     * The status of a guide's action.
+     */
+    status: string;
+}
+/**
+ * A response for a guide action.
+ */
+export interface GuideMarkMessageAsSeenResponse {
+    /**
+     * The status of a guide's action.
+     */
+    status: string;
+}
+export interface GuideGetChannelParams {
+    /**
+     * The data (JSON encoded object) to use for targeting and rendering guides.
+     */
+    data?: string;
+    /**
+     * The tenant ID to use for targeting and rendering guides.
+     */
+    tenant?: string;
+    /**
+     * The type of guides to filter by.
+     */
+    type?: string;
+}
+export interface GuideMarkMessageAsArchivedParams {
+    /**
+     * The unique identifier for the channel.
+     */
+    channel_id: string;
+    /**
+     * The unique identifier for the guide.
+     */
+    guide_id: string;
+    /**
+     * The key of the guide.
+     */
+    guide_key: string;
+    /**
+     * The step reference of the guide.
+     */
+    guide_step_ref: string;
+    /**
+     * The content of the guide.
+     */
+    content?: Record<string, unknown>;
+    /**
+     * The data of the guide.
+     */
+    data?: Record<string, unknown>;
+    /**
+     * Whether the guide is final.
+     */
+    is_final?: boolean;
+    /**
+     * The metadata of the guide.
+     */
+    metadata?: Record<string, unknown>;
+    /**
+     * The tenant ID of the guide.
+     */
+    tenant?: string | null;
+}
+export interface GuideMarkMessageAsInteractedParams {
+    /**
+     * The unique identifier for the channel.
+     */
+    channel_id: string;
+    /**
+     * The unique identifier for the guide.
+     */
+    guide_id: string;
+    /**
+     * The key of the guide.
+     */
+    guide_key: string;
+    /**
+     * The step reference of the guide.
+     */
+    guide_step_ref: string;
+    /**
+     * The content of the guide.
+     */
+    content?: Record<string, unknown>;
+    /**
+     * The data of the guide.
+     */
+    data?: Record<string, unknown>;
+    /**
+     * Whether the guide is final.
+     */
+    is_final?: boolean;
+    /**
+     * The metadata of the guide.
+     */
+    metadata?: Record<string, unknown>;
+    /**
+     * The tenant ID of the guide.
+     */
+    tenant?: string | null;
+}
+export interface GuideMarkMessageAsSeenParams {
+    /**
+     * The unique identifier for the channel.
+     */
+    channel_id: string;
+    /**
+     * The unique identifier for the guide.
+     */
+    guide_id: string;
+    /**
+     * The key of the guide.
+     */
+    guide_key: string;
+    /**
+     * The step reference of the guide.
+     */
+    guide_step_ref: string;
+    /**
+     * The content of the guide.
+     */
+    content?: Record<string, unknown>;
+    /**
+     * The data of the guide.
+     */
+    data?: Record<string, unknown>;
+    /**
+     * Whether the guide is final.
+     */
+    is_final?: boolean;
+    /**
+     * The metadata of the guide.
+     */
+    metadata?: Record<string, unknown>;
+    /**
+     * The tenant ID of the guide.
+     */
+    tenant?: string | null;
+}
+export declare namespace Guides {
+    export { type GuideGetChannelResponse as GuideGetChannelResponse, type GuideMarkMessageAsArchivedResponse as GuideMarkMessageAsArchivedResponse, type GuideMarkMessageAsInteractedResponse as GuideMarkMessageAsInteractedResponse, type GuideMarkMessageAsSeenResponse as GuideMarkMessageAsSeenResponse, type GuideGetChannelParams as GuideGetChannelParams, type GuideMarkMessageAsArchivedParams as GuideMarkMessageAsArchivedParams, type GuideMarkMessageAsInteractedParams as GuideMarkMessageAsInteractedParams, type GuideMarkMessageAsSeenParams as GuideMarkMessageAsSeenParams, };
+}
+//# sourceMappingURL=guides.d.mts.map

package/resources/users/guides.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"guides.d.mts","sourceRoot":"","sources":["../../src/resources/users/guides.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;OAUG;IACH,UAAU,CACR,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC;IAItC;;;;;;;;;;;;;;;;;;OAkBG;IACH,qBAAqB,CACnB,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,gCAAgC,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,kCAAkC,CAAC;IAOjD;;;;;;;;;;;;;;;;;;OAkBG;IACH,uBAAuB,CACrB,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,kCAAkC,EACxC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oCAAoC,CAAC;IAOnD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,iBAAiB,CACf,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,4BAA4B,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,8BAA8B,CAAC;CAM9C;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,uBAAuB,CAAC,KAAK,CAAC,CAAC;IAE7C;;OAEG;IACH,SAAS,CAAC,EAAE,uBAAuB,CAAC,SAAS,GAAG,IAAI,CAAC;CACtD;AAED,yBAAiB,uBAAuB,CAAC;IACvC,UAAiB,KAAK;QACpB;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAEnC;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;IAED;;OAEG;IACH,UAAiB,SAAS;QACxB;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;KACb;CACF;AAED;;GAEG;AACH,MAAM,WAAW,kCAAkC;IACjD;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,oCAAoC;IACnD;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,gCAAgC;IAC/C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAElC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAE/B;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEnC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,MAAM,WAAW,kCAAkC;IACjD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAElC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAE/B;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEnC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAElC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAE/B;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEnC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;CACH"}

package/resources/users/guides.d.ts

@@ -0,0 +1,293 @@
+import { APIResource } from "../../core/resource.js";
+import { APIPromise } from "../../core/api-promise.js";
+import { RequestOptions } from "../../internal/request-options.js";
+export declare class Guides extends APIResource {
+    /**
+     * Returns a list of eligible in-app guides for a specific user and channel.
+     *
+     * @example
+     * ```ts
+     * const response = await client.users.guides.getChannel(
+     *   'user_id',
+     *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     * );
+     * ```
+     */
+    getChannel(userID: string, channelID: string, query?: GuideGetChannelParams | null | undefined, options?: RequestOptions): APIPromise<GuideGetChannelResponse>;
+    /**
+     * Records that a guide has been archived by a user, triggering any associated
+     * archived events.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.users.guides.markMessageAsArchived(
+     *     'user_id',
+     *     'message_id',
+     *     {
+     *       channel_id: '123e4567-e89b-12d3-a456-426614174000',
+     *       guide_id: '7e9dc78c-b3b1-4127-a54e-71f1899b831a',
+     *       guide_key: 'tour_notification',
+     *       guide_step_ref: 'lab_tours',
+     *     },
+     *   );
+     * ```
+     */
+    markMessageAsArchived(userID: string, messageID: string, body: GuideMarkMessageAsArchivedParams, options?: RequestOptions): APIPromise<GuideMarkMessageAsArchivedResponse>;
+    /**
+     * Records that a user has interacted with a guide, triggering any associated
+     * interacted events.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.users.guides.markMessageAsInteracted(
+     *     'user_id',
+     *     'message_id',
+     *     {
+     *       channel_id: '123e4567-e89b-12d3-a456-426614174000',
+     *       guide_id: '7e9dc78c-b3b1-4127-a54e-71f1899b831a',
+     *       guide_key: 'tour_notification',
+     *       guide_step_ref: 'lab_tours',
+     *     },
+     *   );
+     * ```
+     */
+    markMessageAsInteracted(userID: string, messageID: string, body: GuideMarkMessageAsInteractedParams, options?: RequestOptions): APIPromise<GuideMarkMessageAsInteractedResponse>;
+    /**
+     * Records that a guide has been seen by a user, triggering any associated seen
+     * events.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.users.guides.markMessageAsSeen(
+     *     'user_id',
+     *     'message_id',
+     *     {
+     *       channel_id: '123e4567-e89b-12d3-a456-426614174000',
+     *       guide_id: '7e9dc78c-b3b1-4127-a54e-71f1899b831a',
+     *       guide_key: 'tour_notification',
+     *       guide_step_ref: 'lab_tours',
+     *       content: {
+     *         body: "Limited spots available for today's behind-the-scenes DNA extraction demonstration.",
+     *         title: 'DNA Lab Tour Available',
+     *       },
+     *       data: {
+     *         next_time: '14:30',
+     *         spots_left: 8,
+     *         tour_id: 'dna_lab_tour',
+     *       },
+     *       metadata: {
+     *         cta: 'Reserve Spot',
+     *         theme: 'amber',
+     *         type: 'banner',
+     *       },
+     *       tenant: 'ingen_isla_nublar',
+     *     },
+     *   );
+     * ```
+     */
+    markMessageAsSeen(userID: string, messageID: string, body: GuideMarkMessageAsSeenParams, options?: RequestOptions): APIPromise<GuideMarkMessageAsSeenResponse>;
+}
+/**
+ * A response for a list of guides.
+ */
+export interface GuideGetChannelResponse {
+    /**
+     * A list of guides.
+     */
+    guides: Array<GuideGetChannelResponse.Guide>;
+    /**
+     * The recipient of the guide.
+     */
+    recipient?: GuideGetChannelResponse.Recipient | null;
+}
+export declare namespace GuideGetChannelResponse {
+    interface Guide {
+        /**
+         * The unique identifier for the guide.
+         */
+        id?: string;
+        /**
+         * The content of the guide.
+         */
+        content?: string;
+        /**
+         * The metadata of the guide.
+         */
+        metadata?: Record<string, unknown>;
+        /**
+         * The title of the guide.
+         */
+        title?: string;
+    }
+    /**
+     * The recipient of the guide.
+     */
+    interface Recipient {
+        /**
+         * Unique identifier for the recipient.
+         */
+        id?: string;
+    }
+}
+/**
+ * A response for a guide action.
+ */
+export interface GuideMarkMessageAsArchivedResponse {
+    /**
+     * The status of a guide's action.
+     */
+    status: string;
+}
+/**
+ * A response for a guide action.
+ */
+export interface GuideMarkMessageAsInteractedResponse {
+    /**
+     * The status of a guide's action.
+     */
+    status: string;
+}
+/**
+ * A response for a guide action.
+ */
+export interface GuideMarkMessageAsSeenResponse {
+    /**
+     * The status of a guide's action.
+     */
+    status: string;
+}
+export interface GuideGetChannelParams {
+    /**
+     * The data (JSON encoded object) to use for targeting and rendering guides.
+     */
+    data?: string;
+    /**
+     * The tenant ID to use for targeting and rendering guides.
+     */
+    tenant?: string;
+    /**
+     * The type of guides to filter by.
+     */
+    type?: string;
+}
+export interface GuideMarkMessageAsArchivedParams {
+    /**
+     * The unique identifier for the channel.
+     */
+    channel_id: string;
+    /**
+     * The unique identifier for the guide.
+     */
+    guide_id: string;
+    /**
+     * The key of the guide.
+     */
+    guide_key: string;
+    /**
+     * The step reference of the guide.
+     */
+    guide_step_ref: string;
+    /**
+     * The content of the guide.
+     */
+    content?: Record<string, unknown>;
+    /**
+     * The data of the guide.
+     */
+    data?: Record<string, unknown>;
+    /**
+     * Whether the guide is final.
+     */
+    is_final?: boolean;
+    /**
+     * The metadata of the guide.
+     */
+    metadata?: Record<string, unknown>;
+    /**
+     * The tenant ID of the guide.
+     */
+    tenant?: string | null;
+}
+export interface GuideMarkMessageAsInteractedParams {
+    /**
+     * The unique identifier for the channel.
+     */
+    channel_id: string;
+    /**
+     * The unique identifier for the guide.
+     */
+    guide_id: string;
+    /**
+     * The key of the guide.
+     */
+    guide_key: string;
+    /**
+     * The step reference of the guide.
+     */
+    guide_step_ref: string;
+    /**
+     * The content of the guide.
+     */
+    content?: Record<string, unknown>;
+    /**
+     * The data of the guide.
+     */
+    data?: Record<string, unknown>;
+    /**
+     * Whether the guide is final.
+     */
+    is_final?: boolean;
+    /**
+     * The metadata of the guide.
+     */
+    metadata?: Record<string, unknown>;
+    /**
+     * The tenant ID of the guide.
+     */
+    tenant?: string | null;
+}
+export interface GuideMarkMessageAsSeenParams {
+    /**
+     * The unique identifier for the channel.
+     */
+    channel_id: string;
+    /**
+     * The unique identifier for the guide.
+     */
+    guide_id: string;
+    /**
+     * The key of the guide.
+     */
+    guide_key: string;
+    /**
+     * The step reference of the guide.
+     */
+    guide_step_ref: string;
+    /**
+     * The content of the guide.
+     */
+    content?: Record<string, unknown>;
+    /**
+     * The data of the guide.
+     */
+    data?: Record<string, unknown>;
+    /**
+     * Whether the guide is final.
+     */
+    is_final?: boolean;
+    /**
+     * The metadata of the guide.
+     */
+    metadata?: Record<string, unknown>;
+    /**
+     * The tenant ID of the guide.
+     */
+    tenant?: string | null;
+}
+export declare namespace Guides {
+    export { type GuideGetChannelResponse as GuideGetChannelResponse, type GuideMarkMessageAsArchivedResponse as GuideMarkMessageAsArchivedResponse, type GuideMarkMessageAsInteractedResponse as GuideMarkMessageAsInteractedResponse, type GuideMarkMessageAsSeenResponse as GuideMarkMessageAsSeenResponse, type GuideGetChannelParams as GuideGetChannelParams, type GuideMarkMessageAsArchivedParams as GuideMarkMessageAsArchivedParams, type GuideMarkMessageAsInteractedParams as GuideMarkMessageAsInteractedParams, type GuideMarkMessageAsSeenParams as GuideMarkMessageAsSeenParams, };
+}
+//# sourceMappingURL=guides.d.ts.map

package/resources/users/guides.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"guides.d.ts","sourceRoot":"","sources":["../../src/resources/users/guides.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;OAUG;IACH,UAAU,CACR,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC;IAItC;;;;;;;;;;;;;;;;;;OAkBG;IACH,qBAAqB,CACnB,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,gCAAgC,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,kCAAkC,CAAC;IAOjD;;;;;;;;;;;;;;;;;;OAkBG;IACH,uBAAuB,CACrB,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,kCAAkC,EACxC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oCAAoC,CAAC;IAOnD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,iBAAiB,CACf,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,4BAA4B,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,8BAA8B,CAAC;CAM9C;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,uBAAuB,CAAC,KAAK,CAAC,CAAC;IAE7C;;OAEG;IACH,SAAS,CAAC,EAAE,uBAAuB,CAAC,SAAS,GAAG,IAAI,CAAC;CACtD;AAED,yBAAiB,uBAAuB,CAAC;IACvC,UAAiB,KAAK;QACpB;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAEnC;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;IAED;;OAEG;IACH,UAAiB,SAAS;QACxB;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;KACb;CACF;AAED;;GAEG;AACH,MAAM,WAAW,kCAAkC;IACjD;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,oCAAoC;IACnD;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,gCAAgC;IAC/C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAElC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAE/B;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEnC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,MAAM,WAAW,kCAAkC;IACjD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAElC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAE/B;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEnC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAElC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAE/B;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEnC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;CACH"}