@knocklabs/node 0.6.19 → 1.1.0

package/resources/users/guides.js

@@ -0,0 +1,114 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Guides = void 0;
+const resource_1 = require("../../core/resource.js");
+const path_1 = require("../../internal/utils/path.js");
+class Guides extends resource_1.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, channelID, query = {}, options) {
+        return this._client.get((0, path_1.path) `/v1/users/${userID}/guides/${channelID}`, { query, ...options });
+    }
+    /**
+     * 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, messageID, body, options) {
+        return this._client.put((0, path_1.path) `/v1/users/${userID}/guides/messages/${messageID}/archived`, {
+            body,
+            ...options,
+        });
+    }
+    /**
+     * 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, messageID, body, options) {
+        return this._client.put((0, path_1.path) `/v1/users/${userID}/guides/messages/${messageID}/interacted`, {
+            body,
+            ...options,
+        });
+    }
+    /**
+     * 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, messageID, body, options) {
+        return this._client.put((0, path_1.path) `/v1/users/${userID}/guides/messages/${messageID}/seen`, {
+            body,
+            ...options,
+        });
+    }
+}
+exports.Guides = Guides;
+//# sourceMappingURL=guides.js.map

package/resources/users/guides.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"guides.js","sourceRoot":"","sources":["../../src/resources/users/guides.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAGlD,uDAAiD;AAEjD,MAAa,MAAO,SAAQ,sBAAW;IACrC;;;;;;;;;;OAUG;IACH,UAAU,CACR,MAAc,EACd,SAAiB,EACjB,QAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,aAAa,MAAM,WAAW,SAAS,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChG,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,qBAAqB,CACnB,MAAc,EACd,SAAiB,EACjB,IAAsC,EACtC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,aAAa,MAAM,oBAAoB,SAAS,WAAW,EAAE;YACvF,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,uBAAuB,CACrB,MAAc,EACd,SAAiB,EACjB,IAAwC,EACxC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,aAAa,MAAM,oBAAoB,SAAS,aAAa,EAAE;YACzF,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,iBAAiB,CACf,MAAc,EACd,SAAiB,EACjB,IAAkC,EAClC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,aAAa,MAAM,oBAAoB,SAAS,OAAO,EAAE;YACnF,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AAhID,wBAgIC"}

package/resources/users/guides.mjs

@@ -0,0 +1,110 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../core/resource.mjs";
+import { path } from "../../internal/utils/path.mjs";
+export 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, channelID, query = {}, options) {
+        return this._client.get(path `/v1/users/${userID}/guides/${channelID}`, { query, ...options });
+    }
+    /**
+     * 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, messageID, body, options) {
+        return this._client.put(path `/v1/users/${userID}/guides/messages/${messageID}/archived`, {
+            body,
+            ...options,
+        });
+    }
+    /**
+     * 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, messageID, body, options) {
+        return this._client.put(path `/v1/users/${userID}/guides/messages/${messageID}/interacted`, {
+            body,
+            ...options,
+        });
+    }
+    /**
+     * 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, messageID, body, options) {
+        return this._client.put(path `/v1/users/${userID}/guides/messages/${messageID}/seen`, {
+            body,
+            ...options,
+        });
+    }
+}
+//# sourceMappingURL=guides.mjs.map

package/resources/users/guides.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"guides.mjs","sourceRoot":"","sources":["../../src/resources/users/guides.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;OAUG;IACH,UAAU,CACR,MAAc,EACd,SAAiB,EACjB,QAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,MAAM,WAAW,SAAS,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChG,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,qBAAqB,CACnB,MAAc,EACd,SAAiB,EACjB,IAAsC,EACtC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,MAAM,oBAAoB,SAAS,WAAW,EAAE;YACvF,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,uBAAuB,CACrB,MAAc,EACd,SAAiB,EACjB,IAAwC,EACxC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,MAAM,oBAAoB,SAAS,aAAa,EAAE;YACzF,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,iBAAiB,CACf,MAAc,EACd,SAAiB,EACjB,IAAkC,EAClC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,MAAM,oBAAoB,SAAS,OAAO,EAAE;YACnF,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF"}

package/resources/users/index.d.mts

@@ -0,0 +1,5 @@
+export { Bulk, type BulkDeleteParams, type BulkIdentifyParams, type BulkSetPreferencesParams } from "./bulk.mjs";
+export { Feeds, type FeedGetSettingsResponse, type FeedListItemsResponse, type FeedListItemsParams, type FeedListItemsResponsesEntriesCursor, } from "./feeds.mjs";
+export { Guides, type GuideGetChannelResponse, type GuideMarkMessageAsArchivedResponse, type GuideMarkMessageAsInteractedResponse, type GuideMarkMessageAsSeenResponse, type GuideGetChannelParams, type GuideMarkMessageAsArchivedParams, type GuideMarkMessageAsInteractedParams, type GuideMarkMessageAsSeenParams, } from "./guides.mjs";
+export { Users, type IdentifyUserRequest, type InlineIdentifyUserRequest, type User, type UserDeleteResponse, type UserListPreferencesResponse, type UserUnsetChannelDataResponse, type UserUpdateParams, type UserListParams, type UserGetPreferencesParams, type UserListMessagesParams, type UserListSchedulesParams, type UserListSubscriptionsParams, type UserMergeParams, type UserSetChannelDataParams, type UserSetPreferencesParams, type UsersEntriesCursor, } from "./users.mjs";
+//# sourceMappingURL=index.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/resources/users/index.ts"],"names":[],"mappings":"OAEO,EAAE,IAAI,EAAE,KAAK,gBAAgB,EAAE,KAAK,kBAAkB,EAAE,KAAK,wBAAwB,EAAE;OACvF,EACL,KAAK,EACL,KAAK,uBAAuB,EAC5B,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,mCAAmC,GACzC;OACM,EACL,MAAM,EACN,KAAK,uBAAuB,EAC5B,KAAK,kCAAkC,EACvC,KAAK,oCAAoC,EACzC,KAAK,8BAA8B,EACnC,KAAK,qBAAqB,EAC1B,KAAK,gCAAgC,EACrC,KAAK,kCAAkC,EACvC,KAAK,4BAA4B,GAClC;OACM,EACL,KAAK,EACL,KAAK,mBAAmB,EACxB,KAAK,yBAAyB,EAC9B,KAAK,IAAI,EACT,KAAK,kBAAkB,EACvB,KAAK,2BAA2B,EAChC,KAAK,4BAA4B,EACjC,KAAK,gBAAgB,EACrB,KAAK,cAAc,EACnB,KAAK,wBAAwB,EAC7B,KAAK,sBAAsB,EAC3B,KAAK,uBAAuB,EAC5B,KAAK,2BAA2B,EAChC,KAAK,eAAe,EACpB,KAAK,wBAAwB,EAC7B,KAAK,wBAAwB,EAC7B,KAAK,kBAAkB,GACxB"}

package/resources/users/index.d.ts

@@ -0,0 +1,5 @@
+export { Bulk, type BulkDeleteParams, type BulkIdentifyParams, type BulkSetPreferencesParams } from "./bulk.js";
+export { Feeds, type FeedGetSettingsResponse, type FeedListItemsResponse, type FeedListItemsParams, type FeedListItemsResponsesEntriesCursor, } from "./feeds.js";
+export { Guides, type GuideGetChannelResponse, type GuideMarkMessageAsArchivedResponse, type GuideMarkMessageAsInteractedResponse, type GuideMarkMessageAsSeenResponse, type GuideGetChannelParams, type GuideMarkMessageAsArchivedParams, type GuideMarkMessageAsInteractedParams, type GuideMarkMessageAsSeenParams, } from "./guides.js";
+export { Users, type IdentifyUserRequest, type InlineIdentifyUserRequest, type User, type UserDeleteResponse, type UserListPreferencesResponse, type UserUnsetChannelDataResponse, type UserUpdateParams, type UserListParams, type UserGetPreferencesParams, type UserListMessagesParams, type UserListSchedulesParams, type UserListSubscriptionsParams, type UserMergeParams, type UserSetChannelDataParams, type UserSetPreferencesParams, type UsersEntriesCursor, } from "./users.js";
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/resources/users/index.ts"],"names":[],"mappings":"OAEO,EAAE,IAAI,EAAE,KAAK,gBAAgB,EAAE,KAAK,kBAAkB,EAAE,KAAK,wBAAwB,EAAE;OACvF,EACL,KAAK,EACL,KAAK,uBAAuB,EAC5B,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,mCAAmC,GACzC;OACM,EACL,MAAM,EACN,KAAK,uBAAuB,EAC5B,KAAK,kCAAkC,EACvC,KAAK,oCAAoC,EACzC,KAAK,8BAA8B,EACnC,KAAK,qBAAqB,EAC1B,KAAK,gCAAgC,EACrC,KAAK,kCAAkC,EACvC,KAAK,4BAA4B,GAClC;OACM,EACL,KAAK,EACL,KAAK,mBAAmB,EACxB,KAAK,yBAAyB,EAC9B,KAAK,IAAI,EACT,KAAK,kBAAkB,EACvB,KAAK,2BAA2B,EAChC,KAAK,4BAA4B,EACjC,KAAK,gBAAgB,EACrB,KAAK,cAAc,EACnB,KAAK,wBAAwB,EAC7B,KAAK,sBAAsB,EAC3B,KAAK,uBAAuB,EAC5B,KAAK,2BAA2B,EAChC,KAAK,eAAe,EACpB,KAAK,wBAAwB,EAC7B,KAAK,wBAAwB,EAC7B,KAAK,kBAAkB,GACxB"}

package/resources/users/index.js

@@ -0,0 +1,13 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Users = exports.Guides = exports.Feeds = exports.Bulk = void 0;
+var bulk_1 = require("./bulk.js");
+Object.defineProperty(exports, "Bulk", { enumerable: true, get: function () { return bulk_1.Bulk; } });
+var feeds_1 = require("./feeds.js");
+Object.defineProperty(exports, "Feeds", { enumerable: true, get: function () { return feeds_1.Feeds; } });
+var guides_1 = require("./guides.js");
+Object.defineProperty(exports, "Guides", { enumerable: true, get: function () { return guides_1.Guides; } });
+var users_1 = require("./users.js");
+Object.defineProperty(exports, "Users", { enumerable: true, get: function () { return users_1.Users; } });
+//# sourceMappingURL=index.js.map

package/resources/users/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/resources/users/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kCAA6G;AAApG,4FAAA,IAAI,OAAA;AACb,oCAMiB;AALf,8FAAA,KAAK,OAAA;AAMP,sCAUkB;AAThB,gGAAA,MAAM,OAAA;AAUR,oCAkBiB;AAjBf,8FAAA,KAAK,OAAA"}

package/resources/users/index.mjs

@@ -0,0 +1,6 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+export { Bulk } from "./bulk.mjs";
+export { Feeds, } from "./feeds.mjs";
+export { Guides, } from "./guides.mjs";
+export { Users, } from "./users.mjs";
+//# sourceMappingURL=index.mjs.map

package/resources/users/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/resources/users/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,IAAI,EAAiF;OACvF,EACL,KAAK,GAKN;OACM,EACL,MAAM,GASP;OACM,EACL,KAAK,GAiBN"}