@knocklabs/node 1.0.0 → 1.2.0

package/resources/messages/messages.js

@@ -1,34 +1,10 @@
 "use strict";
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Messages = void 0;
+const tslib_1 = require("../../internal/tslib.js");
 const resource_1 = require("../../core/resource.js");
-const ActivitiesAPI = __importStar(require("./activities.js"));
-const activities_1 = require("./activities.js");
-const BatchAPI = __importStar(require("./batch.js"));
+const BatchAPI = tslib_1.__importStar(require("./batch.js"));
 const batch_1 = require("./batch.js");
 const pagination_1 = require("../../core/pagination.js");
 const path_1 = require("../../internal/utils/path.js");
@@ -36,10 +12,17 @@ class Messages extends resource_1.APIResource {
     constructor() {
         super(...arguments);
         this.batch = new BatchAPI.Batch(this._client);
-        this.activities = new ActivitiesAPI.Activities(this._client);
     }
     /**
      * Returns a paginated list of messages for the current environment.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const message of client.messages.list()) {
+     *   // ...
+     * }
+     * ```
      */
     list(query = {}, options) {
         return this._client.getAPIList('/v1/messages', (pagination_1.EntriesCursor), { query, ...options });
@@ -47,12 +30,26 @@ class Messages extends resource_1.APIResource {
     /**
      * Archives a message for the user. Archived messages are hidden from the default
      * message list in the feed but can still be accessed and unarchived later.
+     *
+     * @example
+     * ```ts
+     * const message = await client.messages.archive(
+     *   '1jNaXzB2RZX3LY8wVQnfCKyPnv7',
+     * );
+     * ```
      */
     archive(messageID, options) {
         return this._client.put((0, path_1.path) `/v1/messages/${messageID}/archived`, options);
     }
     /**
      * Retrieves a specific message by its ID.
+     *
+     * @example
+     * ```ts
+     * const message = await client.messages.get(
+     *   '1jNaXzB2RZX3LY8wVQnfCKyPnv7',
+     * );
+     * ```
      */
     get(messageID, options) {
         return this._client.get((0, path_1.path) `/v1/messages/${messageID}`, options);
@@ -60,12 +57,29 @@ class Messages extends resource_1.APIResource {
     /**
      * Returns the fully rendered contents of a message, where the response depends on
      * which channel the message was sent through.
+     *
+     * @example
+     * ```ts
+     * const response = await client.messages.getContent(
+     *   'message_id',
+     * );
+     * ```
      */
     getContent(messageID, options) {
         return this._client.get((0, path_1.path) `/v1/messages/${messageID}/content`, options);
     }
     /**
      * Returns a paginated list of activities for the specified message.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const activity of client.messages.listActivities(
+     *   'message_id',
+     * )) {
+     *   // ...
+     * }
+     * ```
      */
     listActivities(messageID, query = {}, options) {
         return this._client.getAPIList((0, path_1.path) `/v1/messages/${messageID}/activities`, (pagination_1.ItemsCursor), {
@@ -75,12 +89,32 @@ class Messages extends resource_1.APIResource {
     }
     /**
      * Returns a paginated list of delivery logs for the specified message.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const messageDeliveryLog of client.messages.listDeliveryLogs(
+     *   'message_id',
+     * )) {
+     *   // ...
+     * }
+     * ```
      */
     listDeliveryLogs(messageID, query = {}, options) {
         return this._client.getAPIList((0, path_1.path) `/v1/messages/${messageID}/delivery_logs`, (pagination_1.EntriesCursor), { query, ...options });
     }
     /**
      * Returns a paginated list of events for the specified message.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const messageEvent of client.messages.listEvents(
+     *   'message_id',
+     * )) {
+     *   // ...
+     * }
+     * ```
      */
     listEvents(messageID, query = {}, options) {
         return this._client.getAPIList((0, path_1.path) `/v1/messages/${messageID}/events`, (pagination_1.EntriesCursor), {
@@ -94,6 +128,13 @@ class Messages extends resource_1.APIResource {
      * Cannot include more than 5 key-value pairs, must not contain nested data. Read
      * more about message engagement statuses
      * [here](/send-notifications/message-statuses#engagement-status).
+     *
+     * @example
+     * ```ts
+     * const message = await client.messages.markAsInteracted(
+     *   '1jNaXzB2RZX3LY8wVQnfCKyPnv7',
+     * );
+     * ```
      */
     markAsInteracted(messageID, body = {}, options) {
         return this._client.put((0, path_1.path) `/v1/messages/${messageID}/interacted`, { body, ...options });
@@ -102,6 +143,13 @@ class Messages extends resource_1.APIResource {
      * Marks a message as `read`. This indicates that the user has read the message
      * content. Read more about message engagement statuses
      * [here](/send-notifications/message-statuses#engagement-status).
+     *
+     * @example
+     * ```ts
+     * const message = await client.messages.markAsRead(
+     *   '1jNaXzB2RZX3LY8wVQnfCKyPnv7',
+     * );
+     * ```
      */
     markAsRead(messageID, options) {
         return this._client.put((0, path_1.path) `/v1/messages/${messageID}/read`, options);
@@ -110,6 +158,13 @@ class Messages extends resource_1.APIResource {
      * Marks a message as `seen`. This indicates that the user has viewed the message
      * in their feed or inbox. Read more about message engagement statuses
      * [here](/send-notifications/message-statuses#engagement-status).
+     *
+     * @example
+     * ```ts
+     * const message = await client.messages.markAsSeen(
+     *   '1jNaXzB2RZX3LY8wVQnfCKyPnv7',
+     * );
+     * ```
      */
     markAsSeen(messageID, options) {
         return this._client.put((0, path_1.path) `/v1/messages/${messageID}/seen`, options);
@@ -118,6 +173,13 @@ class Messages extends resource_1.APIResource {
      * Marks a message as `unread`. This reverses the `read` state. Read more about
      * message engagement statuses
      * [here](/send-notifications/message-statuses#engagement-status).
+     *
+     * @example
+     * ```ts
+     * const message = await client.messages.markAsUnread(
+     *   '1jNaXzB2RZX3LY8wVQnfCKyPnv7',
+     * );
+     * ```
      */
     markAsUnread(messageID, options) {
         return this._client.delete((0, path_1.path) `/v1/messages/${messageID}/read`, options);
@@ -126,6 +188,13 @@ class Messages extends resource_1.APIResource {
      * Marks a message as `unseen`. This reverses the `seen` state. Read more about
      * message engagement statuses
      * [here](/send-notifications/message-statuses#engagement-status).
+     *
+     * @example
+     * ```ts
+     * const message = await client.messages.markAsUnseen(
+     *   '1jNaXzB2RZX3LY8wVQnfCKyPnv7',
+     * );
+     * ```
      */
     markAsUnseen(messageID, options) {
         return this._client.delete((0, path_1.path) `/v1/messages/${messageID}/seen`, options);
@@ -133,6 +202,13 @@ class Messages extends resource_1.APIResource {
     /**
      * Removes a message from the archived state, making it visible in the default
      * message list in the feed again.
+     *
+     * @example
+     * ```ts
+     * const message = await client.messages.unarchive(
+     *   '1jNaXzB2RZX3LY8wVQnfCKyPnv7',
+     * );
+     * ```
      */
     unarchive(messageID, options) {
         return this._client.delete((0, path_1.path) `/v1/messages/${messageID}/archived`, options);
@@ -140,5 +216,4 @@ class Messages extends resource_1.APIResource {
 }
 exports.Messages = Messages;
 Messages.Batch = batch_1.Batch;
-Messages.Activities = activities_1.Activities;
 //# sourceMappingURL=messages.js.map

package/resources/messages/messages.js.map

@@ -1 +1 @@
-{"version":3,"file":"messages.js","sourceRoot":"","sources":["../../src/resources/messages/messages.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;;;;;;;;;;;;;;;;;;;;;AAEtF,qDAAkD;AAClD,+DAA8C;AAC9C,gDAA8D;AAC9D,qDAAoC;AACpC,sCAkBiB;AAGjB,yDAM+B;AAE/B,uDAAiD;AAEjD,MAAa,QAAS,SAAQ,sBAAW;IAAzC;;QACE,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzD,eAAU,GAA6B,IAAI,aAAa,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAwIpF,CAAC;IAtIC;;OAEG;IACH,IAAI,CACF,QAA8C,EAAE,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,cAAc,EAAE,CAAA,0BAAsB,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChG,CAAC;IAED;;;OAGG;IACH,OAAO,CAAC,SAAiB,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,gBAAgB,SAAS,WAAW,EAAE,OAAO,CAAC,CAAC;IAC7E,CAAC;IAED;;OAEG;IACH,GAAG,CAAC,SAAiB,EAAE,OAAwB;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,gBAAgB,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;IAED;;;OAGG;IACH,UAAU,CAAC,SAAiB,EAAE,OAAwB;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,gBAAgB,SAAS,UAAU,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;IAED;;OAEG;IACH,cAAc,CACZ,SAAiB,EACjB,QAAwD,EAAE,EAC1D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAA,WAAI,EAAA,gBAAgB,SAAS,aAAa,EAAE,CAAA,wBAAqB,CAAA,EAAE;YAChG,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,gBAAgB,CACd,SAAiB,EACjB,QAA0D,EAAE,EAC5D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAA,WAAI,EAAA,gBAAgB,SAAS,gBAAgB,EAC7C,CAAA,0BAAiC,CAAA,EACjC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,UAAU,CACR,SAAiB,EACjB,QAAoD,EAAE,EACtD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAA,WAAI,EAAA,gBAAgB,SAAS,SAAS,EAAE,CAAA,0BAA2B,CAAA,EAAE;YAClG,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,gBAAgB,CACd,SAAiB,EACjB,OAAyD,EAAE,EAC3D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,gBAAgB,SAAS,aAAa,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5F,CAAC;IAED;;;;OAIG;IACH,UAAU,CAAC,SAAiB,EAAE,OAAwB;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,gBAAgB,SAAS,OAAO,EAAE,OAAO,CAAC,CAAC;IACzE,CAAC;IAED;;;;OAIG;IACH,UAAU,CAAC,SAAiB,EAAE,OAAwB;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,gBAAgB,SAAS,OAAO,EAAE,OAAO,CAAC,CAAC;IACzE,CAAC;IAED;;;;OAIG;IACH,YAAY,CAAC,SAAiB,EAAE,OAAwB;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,gBAAgB,SAAS,OAAO,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;IAED;;;;OAIG;IACH,YAAY,CAAC,SAAiB,EAAE,OAAwB;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,gBAAgB,SAAS,OAAO,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;IAED;;;OAGG;IACH,SAAS,CAAC,SAAiB,EAAE,OAAwB;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,gBAAgB,SAAS,WAAW,EAAE,OAAO,CAAC,CAAC;IAChF,CAAC;CACF;AA1ID,4BA0IC;AAguBD,QAAQ,CAAC,KAAK,GAAG,aAAK,CAAC;AACvB,QAAQ,CAAC,UAAU,GAAG,uBAAU,CAAC"}
+{"version":3,"file":"messages.js","sourceRoot":"","sources":["../../src/resources/messages/messages.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAClD,6DAAoC;AACpC,sCAkBiB;AAGjB,yDAM+B;AAE/B,uDAAiD;AAEjD,MAAa,QAAS,SAAQ,sBAAW;IAAzC;;QACE,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA6O3D,CAAC;IA3OC;;;;;;;;;;OAUG;IACH,IAAI,CACF,QAA8C,EAAE,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,cAAc,EAAE,CAAA,0BAAsB,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChG,CAAC;IAED;;;;;;;;;;OAUG;IACH,OAAO,CAAC,SAAiB,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,gBAAgB,SAAS,WAAW,EAAE,OAAO,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;;;OASG;IACH,GAAG,CAAC,SAAiB,EAAE,OAAwB;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,gBAAgB,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;;;;OAUG;IACH,UAAU,CAAC,SAAiB,EAAE,OAAwB;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,gBAAgB,SAAS,UAAU,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,cAAc,CACZ,SAAiB,EACjB,QAAwD,EAAE,EAC1D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAA,WAAI,EAAA,gBAAgB,SAAS,aAAa,EAAE,CAAA,wBAAqB,CAAA,EAAE;YAChG,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,gBAAgB,CACd,SAAiB,EACjB,QAA0D,EAAE,EAC5D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAA,WAAI,EAAA,gBAAgB,SAAS,gBAAgB,EAC7C,CAAA,0BAAiC,CAAA,EACjC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,UAAU,CACR,SAAiB,EACjB,QAAoD,EAAE,EACtD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAA,WAAI,EAAA,gBAAgB,SAAS,SAAS,EAAE,CAAA,0BAA2B,CAAA,EAAE;YAClG,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,gBAAgB,CACd,SAAiB,EACjB,OAAyD,EAAE,EAC3D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,gBAAgB,SAAS,aAAa,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5F,CAAC;IAED;;;;;;;;;;;OAWG;IACH,UAAU,CAAC,SAAiB,EAAE,OAAwB;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,gBAAgB,SAAS,OAAO,EAAE,OAAO,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,UAAU,CAAC,SAAiB,EAAE,OAAwB;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,gBAAgB,SAAS,OAAO,EAAE,OAAO,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,YAAY,CAAC,SAAiB,EAAE,OAAwB;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,gBAAgB,SAAS,OAAO,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;;;;OAWG;IACH,YAAY,CAAC,SAAiB,EAAE,OAAwB;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,gBAAgB,SAAS,OAAO,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;;;OAUG;IACH,SAAS,CAAC,SAAiB,EAAE,OAAwB;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,gBAAgB,SAAS,WAAW,EAAE,OAAO,CAAC,CAAC;IAChF,CAAC;CACF;AA9OD,4BA8OC;AAguBD,QAAQ,CAAC,KAAK,GAAG,aAAK,CAAC"}

package/resources/messages/messages.mjs

@@ -1,7 +1,5 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 import { APIResource } from "../../core/resource.mjs";
-import * as ActivitiesAPI from "./activities.mjs";
-import { Activities } from "./activities.mjs";
 import * as BatchAPI from "./batch.mjs";
 import { Batch, } from "./batch.mjs";
 import { EntriesCursor, ItemsCursor, } from "../../core/pagination.mjs";
@@ -10,10 +8,17 @@ export class Messages extends APIResource {
     constructor() {
         super(...arguments);
         this.batch = new BatchAPI.Batch(this._client);
-        this.activities = new ActivitiesAPI.Activities(this._client);
     }
     /**
      * Returns a paginated list of messages for the current environment.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const message of client.messages.list()) {
+     *   // ...
+     * }
+     * ```
      */
     list(query = {}, options) {
         return this._client.getAPIList('/v1/messages', (EntriesCursor), { query, ...options });
@@ -21,12 +26,26 @@ export class Messages extends APIResource {
     /**
      * Archives a message for the user. Archived messages are hidden from the default
      * message list in the feed but can still be accessed and unarchived later.
+     *
+     * @example
+     * ```ts
+     * const message = await client.messages.archive(
+     *   '1jNaXzB2RZX3LY8wVQnfCKyPnv7',
+     * );
+     * ```
      */
     archive(messageID, options) {
         return this._client.put(path `/v1/messages/${messageID}/archived`, options);
     }
     /**
      * Retrieves a specific message by its ID.
+     *
+     * @example
+     * ```ts
+     * const message = await client.messages.get(
+     *   '1jNaXzB2RZX3LY8wVQnfCKyPnv7',
+     * );
+     * ```
      */
     get(messageID, options) {
         return this._client.get(path `/v1/messages/${messageID}`, options);
@@ -34,12 +53,29 @@ export class Messages extends APIResource {
     /**
      * Returns the fully rendered contents of a message, where the response depends on
      * which channel the message was sent through.
+     *
+     * @example
+     * ```ts
+     * const response = await client.messages.getContent(
+     *   'message_id',
+     * );
+     * ```
      */
     getContent(messageID, options) {
         return this._client.get(path `/v1/messages/${messageID}/content`, options);
     }
     /**
      * Returns a paginated list of activities for the specified message.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const activity of client.messages.listActivities(
+     *   'message_id',
+     * )) {
+     *   // ...
+     * }
+     * ```
      */
     listActivities(messageID, query = {}, options) {
         return this._client.getAPIList(path `/v1/messages/${messageID}/activities`, (ItemsCursor), {
@@ -49,12 +85,32 @@ export class Messages extends APIResource {
     }
     /**
      * Returns a paginated list of delivery logs for the specified message.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const messageDeliveryLog of client.messages.listDeliveryLogs(
+     *   'message_id',
+     * )) {
+     *   // ...
+     * }
+     * ```
      */
     listDeliveryLogs(messageID, query = {}, options) {
         return this._client.getAPIList(path `/v1/messages/${messageID}/delivery_logs`, (EntriesCursor), { query, ...options });
     }
     /**
      * Returns a paginated list of events for the specified message.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const messageEvent of client.messages.listEvents(
+     *   'message_id',
+     * )) {
+     *   // ...
+     * }
+     * ```
      */
     listEvents(messageID, query = {}, options) {
         return this._client.getAPIList(path `/v1/messages/${messageID}/events`, (EntriesCursor), {
@@ -68,6 +124,13 @@ export class Messages extends APIResource {
      * Cannot include more than 5 key-value pairs, must not contain nested data. Read
      * more about message engagement statuses
      * [here](/send-notifications/message-statuses#engagement-status).
+     *
+     * @example
+     * ```ts
+     * const message = await client.messages.markAsInteracted(
+     *   '1jNaXzB2RZX3LY8wVQnfCKyPnv7',
+     * );
+     * ```
      */
     markAsInteracted(messageID, body = {}, options) {
         return this._client.put(path `/v1/messages/${messageID}/interacted`, { body, ...options });
@@ -76,6 +139,13 @@ export class Messages extends APIResource {
      * Marks a message as `read`. This indicates that the user has read the message
      * content. Read more about message engagement statuses
      * [here](/send-notifications/message-statuses#engagement-status).
+     *
+     * @example
+     * ```ts
+     * const message = await client.messages.markAsRead(
+     *   '1jNaXzB2RZX3LY8wVQnfCKyPnv7',
+     * );
+     * ```
      */
     markAsRead(messageID, options) {
         return this._client.put(path `/v1/messages/${messageID}/read`, options);
@@ -84,6 +154,13 @@ export class Messages extends APIResource {
      * Marks a message as `seen`. This indicates that the user has viewed the message
      * in their feed or inbox. Read more about message engagement statuses
      * [here](/send-notifications/message-statuses#engagement-status).
+     *
+     * @example
+     * ```ts
+     * const message = await client.messages.markAsSeen(
+     *   '1jNaXzB2RZX3LY8wVQnfCKyPnv7',
+     * );
+     * ```
      */
     markAsSeen(messageID, options) {
         return this._client.put(path `/v1/messages/${messageID}/seen`, options);
@@ -92,6 +169,13 @@ export class Messages extends APIResource {
      * Marks a message as `unread`. This reverses the `read` state. Read more about
      * message engagement statuses
      * [here](/send-notifications/message-statuses#engagement-status).
+     *
+     * @example
+     * ```ts
+     * const message = await client.messages.markAsUnread(
+     *   '1jNaXzB2RZX3LY8wVQnfCKyPnv7',
+     * );
+     * ```
      */
     markAsUnread(messageID, options) {
         return this._client.delete(path `/v1/messages/${messageID}/read`, options);
@@ -100,6 +184,13 @@ export class Messages extends APIResource {
      * Marks a message as `unseen`. This reverses the `seen` state. Read more about
      * message engagement statuses
      * [here](/send-notifications/message-statuses#engagement-status).
+     *
+     * @example
+     * ```ts
+     * const message = await client.messages.markAsUnseen(
+     *   '1jNaXzB2RZX3LY8wVQnfCKyPnv7',
+     * );
+     * ```
      */
     markAsUnseen(messageID, options) {
         return this._client.delete(path `/v1/messages/${messageID}/seen`, options);
@@ -107,11 +198,17 @@ export class Messages extends APIResource {
     /**
      * Removes a message from the archived state, making it visible in the default
      * message list in the feed again.
+     *
+     * @example
+     * ```ts
+     * const message = await client.messages.unarchive(
+     *   '1jNaXzB2RZX3LY8wVQnfCKyPnv7',
+     * );
+     * ```
      */
     unarchive(messageID, options) {
         return this._client.delete(path `/v1/messages/${messageID}/archived`, options);
     }
 }
 Messages.Batch = Batch;
-Messages.Activities = Activities;
 //# sourceMappingURL=messages.mjs.map

package/resources/messages/messages.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"messages.mjs","sourceRoot":"","sources":["../../src/resources/messages/messages.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,KAAK,aAAa;OAClB,EAAE,UAAU,EAAsB;OAClC,KAAK,QAAQ;OACb,EACL,KAAK,GAiBN;OAGM,EACL,aAAa,EAEb,WAAW,GAGZ;OAEM,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,QAAS,SAAQ,WAAW;IAAzC;;QACE,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzD,eAAU,GAA6B,IAAI,aAAa,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAwIpF,CAAC;IAtIC;;OAEG;IACH,IAAI,CACF,QAA8C,EAAE,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,cAAc,EAAE,CAAA,aAAsB,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChG,CAAC;IAED;;;OAGG;IACH,OAAO,CAAC,SAAiB,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,gBAAgB,SAAS,WAAW,EAAE,OAAO,CAAC,CAAC;IAC7E,CAAC;IAED;;OAEG;IACH,GAAG,CAAC,SAAiB,EAAE,OAAwB;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,gBAAgB,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;IAED;;;OAGG;IACH,UAAU,CAAC,SAAiB,EAAE,OAAwB;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,gBAAgB,SAAS,UAAU,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;IAED;;OAEG;IACH,cAAc,CACZ,SAAiB,EACjB,QAAwD,EAAE,EAC1D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAA,gBAAgB,SAAS,aAAa,EAAE,CAAA,WAAqB,CAAA,EAAE;YAChG,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,gBAAgB,CACd,SAAiB,EACjB,QAA0D,EAAE,EAC5D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAI,CAAA,gBAAgB,SAAS,gBAAgB,EAC7C,CAAA,aAAiC,CAAA,EACjC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,UAAU,CACR,SAAiB,EACjB,QAAoD,EAAE,EACtD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAA,gBAAgB,SAAS,SAAS,EAAE,CAAA,aAA2B,CAAA,EAAE;YAClG,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,gBAAgB,CACd,SAAiB,EACjB,OAAyD,EAAE,EAC3D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,gBAAgB,SAAS,aAAa,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5F,CAAC;IAED;;;;OAIG;IACH,UAAU,CAAC,SAAiB,EAAE,OAAwB;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,gBAAgB,SAAS,OAAO,EAAE,OAAO,CAAC,CAAC;IACzE,CAAC;IAED;;;;OAIG;IACH,UAAU,CAAC,SAAiB,EAAE,OAAwB;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,gBAAgB,SAAS,OAAO,EAAE,OAAO,CAAC,CAAC;IACzE,CAAC;IAED;;;;OAIG;IACH,YAAY,CAAC,SAAiB,EAAE,OAAwB;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,gBAAgB,SAAS,OAAO,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;IAED;;;;OAIG;IACH,YAAY,CAAC,SAAiB,EAAE,OAAwB;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,gBAAgB,SAAS,OAAO,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;IAED;;;OAGG;IACH,SAAS,CAAC,SAAiB,EAAE,OAAwB;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,gBAAgB,SAAS,WAAW,EAAE,OAAO,CAAC,CAAC;IAChF,CAAC;CACF;AAguBD,QAAQ,CAAC,KAAK,GAAG,KAAK,CAAC;AACvB,QAAQ,CAAC,UAAU,GAAG,UAAU,CAAC"}
+{"version":3,"file":"messages.mjs","sourceRoot":"","sources":["../../src/resources/messages/messages.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,KAAK,QAAQ;OACb,EACL,KAAK,GAiBN;OAGM,EACL,aAAa,EAEb,WAAW,GAGZ;OAEM,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,QAAS,SAAQ,WAAW;IAAzC;;QACE,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA6O3D,CAAC;IA3OC;;;;;;;;;;OAUG;IACH,IAAI,CACF,QAA8C,EAAE,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,cAAc,EAAE,CAAA,aAAsB,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChG,CAAC;IAED;;;;;;;;;;OAUG;IACH,OAAO,CAAC,SAAiB,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,gBAAgB,SAAS,WAAW,EAAE,OAAO,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;;;OASG;IACH,GAAG,CAAC,SAAiB,EAAE,OAAwB;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,gBAAgB,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;;;;OAUG;IACH,UAAU,CAAC,SAAiB,EAAE,OAAwB;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,gBAAgB,SAAS,UAAU,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,cAAc,CACZ,SAAiB,EACjB,QAAwD,EAAE,EAC1D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAA,gBAAgB,SAAS,aAAa,EAAE,CAAA,WAAqB,CAAA,EAAE;YAChG,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,gBAAgB,CACd,SAAiB,EACjB,QAA0D,EAAE,EAC5D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAI,CAAA,gBAAgB,SAAS,gBAAgB,EAC7C,CAAA,aAAiC,CAAA,EACjC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,UAAU,CACR,SAAiB,EACjB,QAAoD,EAAE,EACtD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAA,gBAAgB,SAAS,SAAS,EAAE,CAAA,aAA2B,CAAA,EAAE;YAClG,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,gBAAgB,CACd,SAAiB,EACjB,OAAyD,EAAE,EAC3D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,gBAAgB,SAAS,aAAa,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5F,CAAC;IAED;;;;;;;;;;;OAWG;IACH,UAAU,CAAC,SAAiB,EAAE,OAAwB;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,gBAAgB,SAAS,OAAO,EAAE,OAAO,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,UAAU,CAAC,SAAiB,EAAE,OAAwB;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,gBAAgB,SAAS,OAAO,EAAE,OAAO,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,YAAY,CAAC,SAAiB,EAAE,OAAwB;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,gBAAgB,SAAS,OAAO,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;;;;OAWG;IACH,YAAY,CAAC,SAAiB,EAAE,OAAwB;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,gBAAgB,SAAS,OAAO,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;;;OAUG;IACH,SAAS,CAAC,SAAiB,EAAE,OAAwB;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,gBAAgB,SAAS,WAAW,EAAE,OAAO,CAAC,CAAC;IAChF,CAAC;CACF;AAguBD,QAAQ,CAAC,KAAK,GAAG,KAAK,CAAC"}

package/resources/messages.js

@@ -1,19 +1,6 @@
 "use strict";
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./messages/index.js"), exports);
+const tslib_1 = require("../internal/tslib.js");
+tslib_1.__exportStar(require("./messages/index.js"), exports);
 //# sourceMappingURL=messages.js.map

package/resources/messages.js.map

@@ -1 +1 @@
-{"version":3,"file":"messages.js","sourceRoot":"","sources":["../src/resources/messages.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;;;;;;;;;;;AAEtF,sDAAiC"}
+{"version":3,"file":"messages.js","sourceRoot":"","sources":["../src/resources/messages.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,8DAAiC"}

package/resources/objects/bulk.d.mts

@@ -7,6 +7,14 @@ import { RequestOptions } from "../../internal/request-options.mjs";
 export declare class Bulk extends APIResource {
     /**
      * Bulk deletes objects from the specified collection.
+     *
+     * @example
+     * ```ts
+     * const bulkOperation = await client.objects.bulk.delete(
+     *   'collection',
+     *   { object_ids: ['obj_123', 'obj_456', 'obj_789'] },
+     * );
+     * ```
      */
     delete(collection: string, body: BulkDeleteParams, options?: RequestOptions): APIPromise<BulkOperationsAPI.BulkOperation>;
     /**
@@ -15,10 +23,51 @@ export declare class Bulk extends APIResource {
      * also handles
      * [inline identifications](/managing-recipients/identifying-recipients#inline-identifying-recipients)
      * for the `recipient` field.
+     *
+     * @example
+     * ```ts
+     * const bulkOperation =
+     *   await client.objects.bulk.addSubscriptions('projects', {
+     *     subscriptions: [
+     *       {
+     *         id: 'project-1',
+     *         properties: null,
+     *         recipients: [{ id: 'user_1' }],
+     *       },
+     *     ],
+     *   });
+     * ```
      */
     addSubscriptions(collection: string, body: BulkAddSubscriptionsParams, options?: RequestOptions): APIPromise<BulkOperationsAPI.BulkOperation>;
     /**
      * Bulk sets up to 1,000 objects at a time in the specified collection.
+     *
+     * @example
+     * ```ts
+     * const bulkOperation = await client.objects.bulk.set(
+     *   'collection',
+     *   {
+     *     objects: [
+     *       {
+     *         collection: 'projects',
+     *         id: 'project_1',
+     *         name: {
+     *           '0': 'M',
+     *           '1': 'y',
+     *           '2': ' ',
+     *           '3': 'p',
+     *           '4': 'r',
+     *           '5': 'o',
+     *           '6': 'j',
+     *           '7': 'e',
+     *           '8': 'c',
+     *           '9': 't',
+     *         },
+     *       },
+     *     ],
+     *   },
+     * );
+     * ```
      */
     set(collection: string, body: BulkSetParams, options?: RequestOptions): APIPromise<BulkOperationsAPI.BulkOperation>;
 }

package/resources/objects/bulk.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"bulk.d.mts","sourceRoot":"","sources":["../../src/resources/objects/bulk.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,iBAAiB;OACtB,KAAK,UAAU;OACf,KAAK,aAAa;OAClB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,IAAK,SAAQ,WAAW;IACnC;;OAEG;IACH,MAAM,CACJ,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,gBAAgB,EACtB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC,aAAa,CAAC;IAI9C;;;;;;OAMG;IACH,gBAAgB,CACd,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,0BAA0B,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC,aAAa,CAAC;IAI9C;;OAEG;IACH,GAAG,CACD,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,aAAa,EACnB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC,aAAa,CAAC;CAG/C;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC3B;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,aAAa,EAAE,KAAK,CAAC,0BAA0B,CAAC,YAAY,CAAC,CAAC;CAC/D;AAED,yBAAiB,0BAA0B,CAAC;IAC1C,UAAiB,YAAY;QAC3B;;;WAGG;QACH,UAAU,EAAE,KAAK,CAAC,aAAa,CAAC,gBAAgB,CAAC,CAAC;QAElD;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;KAC7C;CACF;AAED,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,UAAU,CAAC,mBAAmB,CAAC,CAAC;CAChD;AAED,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EACL,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,aAAa,IAAI,aAAa,GACpC,CAAC;CACH"}
+{"version":3,"file":"bulk.d.mts","sourceRoot":"","sources":["../../src/resources/objects/bulk.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,iBAAiB;OACtB,KAAK,UAAU;OACf,KAAK,aAAa;OAClB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,IAAK,SAAQ,WAAW;IACnC;;;;;;;;;;OAUG;IACH,MAAM,CACJ,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,gBAAgB,EACtB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC,aAAa,CAAC;IAI9C;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,gBAAgB,CACd,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,0BAA0B,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC,aAAa,CAAC;IAI9C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,GAAG,CACD,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,aAAa,EACnB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC,aAAa,CAAC;CAG/C;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC3B;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,aAAa,EAAE,KAAK,CAAC,0BAA0B,CAAC,YAAY,CAAC,CAAC;CAC/D;AAED,yBAAiB,0BAA0B,CAAC;IAC1C,UAAiB,YAAY;QAC3B;;;WAGG;QACH,UAAU,EAAE,KAAK,CAAC,aAAa,CAAC,gBAAgB,CAAC,CAAC;QAElD;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;KAC7C;CACF;AAED,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,UAAU,CAAC,mBAAmB,CAAC,CAAC;CAChD;AAED,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EACL,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,aAAa,IAAI,aAAa,GACpC,CAAC;CACH"}

package/resources/objects/bulk.d.ts

@@ -7,6 +7,14 @@ import { RequestOptions } from "../../internal/request-options.js";
 export declare class Bulk extends APIResource {
     /**
      * Bulk deletes objects from the specified collection.
+     *
+     * @example
+     * ```ts
+     * const bulkOperation = await client.objects.bulk.delete(
+     *   'collection',
+     *   { object_ids: ['obj_123', 'obj_456', 'obj_789'] },
+     * );
+     * ```
      */
     delete(collection: string, body: BulkDeleteParams, options?: RequestOptions): APIPromise<BulkOperationsAPI.BulkOperation>;
     /**
@@ -15,10 +23,51 @@ export declare class Bulk extends APIResource {
      * also handles
      * [inline identifications](/managing-recipients/identifying-recipients#inline-identifying-recipients)
      * for the `recipient` field.
+     *
+     * @example
+     * ```ts
+     * const bulkOperation =
+     *   await client.objects.bulk.addSubscriptions('projects', {
+     *     subscriptions: [
+     *       {
+     *         id: 'project-1',
+     *         properties: null,
+     *         recipients: [{ id: 'user_1' }],
+     *       },
+     *     ],
+     *   });
+     * ```
      */
     addSubscriptions(collection: string, body: BulkAddSubscriptionsParams, options?: RequestOptions): APIPromise<BulkOperationsAPI.BulkOperation>;
     /**
      * Bulk sets up to 1,000 objects at a time in the specified collection.
+     *
+     * @example
+     * ```ts
+     * const bulkOperation = await client.objects.bulk.set(
+     *   'collection',
+     *   {
+     *     objects: [
+     *       {
+     *         collection: 'projects',
+     *         id: 'project_1',
+     *         name: {
+     *           '0': 'M',
+     *           '1': 'y',
+     *           '2': ' ',
+     *           '3': 'p',
+     *           '4': 'r',
+     *           '5': 'o',
+     *           '6': 'j',
+     *           '7': 'e',
+     *           '8': 'c',
+     *           '9': 't',
+     *         },
+     *       },
+     *     ],
+     *   },
+     * );
+     * ```
      */
     set(collection: string, body: BulkSetParams, options?: RequestOptions): APIPromise<BulkOperationsAPI.BulkOperation>;
 }

package/resources/objects/bulk.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"bulk.d.ts","sourceRoot":"","sources":["../../src/resources/objects/bulk.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,iBAAiB;OACtB,KAAK,UAAU;OACf,KAAK,aAAa;OAClB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,IAAK,SAAQ,WAAW;IACnC;;OAEG;IACH,MAAM,CACJ,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,gBAAgB,EACtB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC,aAAa,CAAC;IAI9C;;;;;;OAMG;IACH,gBAAgB,CACd,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,0BAA0B,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC,aAAa,CAAC;IAI9C;;OAEG;IACH,GAAG,CACD,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,aAAa,EACnB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC,aAAa,CAAC;CAG/C;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC3B;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,aAAa,EAAE,KAAK,CAAC,0BAA0B,CAAC,YAAY,CAAC,CAAC;CAC/D;AAED,yBAAiB,0BAA0B,CAAC;IAC1C,UAAiB,YAAY;QAC3B;;;WAGG;QACH,UAAU,EAAE,KAAK,CAAC,aAAa,CAAC,gBAAgB,CAAC,CAAC;QAElD;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;KAC7C;CACF;AAED,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,UAAU,CAAC,mBAAmB,CAAC,CAAC;CAChD;AAED,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EACL,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,aAAa,IAAI,aAAa,GACpC,CAAC;CACH"}
+{"version":3,"file":"bulk.d.ts","sourceRoot":"","sources":["../../src/resources/objects/bulk.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,iBAAiB;OACtB,KAAK,UAAU;OACf,KAAK,aAAa;OAClB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,IAAK,SAAQ,WAAW;IACnC;;;;;;;;;;OAUG;IACH,MAAM,CACJ,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,gBAAgB,EACtB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC,aAAa,CAAC;IAI9C;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,gBAAgB,CACd,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,0BAA0B,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC,aAAa,CAAC;IAI9C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,GAAG,CACD,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,aAAa,EACnB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC,aAAa,CAAC;CAG/C;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC3B;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,aAAa,EAAE,KAAK,CAAC,0BAA0B,CAAC,YAAY,CAAC,CAAC;CAC/D;AAED,yBAAiB,0BAA0B,CAAC;IAC1C,UAAiB,YAAY;QAC3B;;;WAGG;QACH,UAAU,EAAE,KAAK,CAAC,aAAa,CAAC,gBAAgB,CAAC,CAAC;QAElD;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;KAC7C;CACF;AAED,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,UAAU,CAAC,mBAAmB,CAAC,CAAC;CAChD;AAED,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EACL,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,aAAa,IAAI,aAAa,GACpC,CAAC;CACH"}