@knocklabs/node 1.0.0 → 1.1.0

package/resources/messages/batch.d.mts

@@ -6,10 +6,27 @@ export declare class Batch extends APIResource {
     /**
      * Marks the given messages as archived. Archived messages are hidden from the
      * default message list in the feed but can still be accessed and unarchived later.
+     *
+     * @example
+     * ```ts
+     * const messages = await client.messages.batch.archive({
+     *   message_ids: [
+     *     '2w3YUpTTOxuDvZFji8OMsKrG176',
+     *     '2w3YVRbPXMIh8Zq6oBFcVDA5xes',
+     *   ],
+     * });
+     * ```
      */
     archive(body: BatchArchiveParams, options?: RequestOptions): APIPromise<BatchArchiveResponse>;
     /**
      * Get the contents of multiple messages in a single request.
+     *
+     * @example
+     * ```ts
+     * const response = await client.messages.batch.getContent({
+     *   message_ids: ['string'],
+     * });
+     * ```
      */
     getContent(query: BatchGetContentParams, options?: RequestOptions): APIPromise<BatchGetContentResponse>;
     /**
@@ -18,35 +35,94 @@ export declare class Batch extends APIResource {
      * interaction. 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 messages =
+     *   await client.messages.batch.markAsInteracted({
+     *     message_ids: ['1jNaXzB2RZX3LY8wVQnfCKyPnv7'],
+     *     metadata: { key: 'value' },
+     *   });
+     * ```
      */
     markAsInteracted(body: BatchMarkAsInteractedParams, options?: RequestOptions): APIPromise<BatchMarkAsInteractedResponse>;
     /**
      * Marks the given messages as `read`. Read more about message engagement statuses
      * [here](/send-notifications/message-statuses#engagement-status).
+     *
+     * @example
+     * ```ts
+     * const messages = await client.messages.batch.markAsRead({
+     *   message_ids: [
+     *     '2w3YUpTTOxuDvZFji8OMsKrG176',
+     *     '2w3YVRbPXMIh8Zq6oBFcVDA5xes',
+     *   ],
+     * });
+     * ```
      */
     markAsRead(body: BatchMarkAsReadParams, options?: RequestOptions): APIPromise<BatchMarkAsReadResponse>;
     /**
      * Marks the given messages 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 messages = await client.messages.batch.markAsSeen({
+     *   message_ids: [
+     *     '2w3YUpTTOxuDvZFji8OMsKrG176',
+     *     '2w3YVRbPXMIh8Zq6oBFcVDA5xes',
+     *   ],
+     * });
+     * ```
      */
     markAsSeen(body: BatchMarkAsSeenParams, options?: RequestOptions): APIPromise<BatchMarkAsSeenResponse>;
     /**
      * Marks the given messages as `unread`. This reverses the `read` state. Read more
      * about message engagement statuses
      * [here](/send-notifications/message-statuses#engagement-status).
+     *
+     * @example
+     * ```ts
+     * const messages = await client.messages.batch.markAsUnread({
+     *   message_ids: [
+     *     '2w3YUpTTOxuDvZFji8OMsKrG176',
+     *     '2w3YVRbPXMIh8Zq6oBFcVDA5xes',
+     *   ],
+     * });
+     * ```
      */
     markAsUnread(body: BatchMarkAsUnreadParams, options?: RequestOptions): APIPromise<BatchMarkAsUnreadResponse>;
     /**
      * Marks the given messages as `unseen`. This reverses the `seen` state. Read more
      * about message engagement statuses
      * [here](/send-notifications/message-statuses#engagement-status).
+     *
+     * @example
+     * ```ts
+     * const messages = await client.messages.batch.markAsUnseen({
+     *   message_ids: [
+     *     '2w3YUpTTOxuDvZFji8OMsKrG176',
+     *     '2w3YVRbPXMIh8Zq6oBFcVDA5xes',
+     *   ],
+     * });
+     * ```
      */
     markAsUnseen(body: BatchMarkAsUnseenParams, options?: RequestOptions): APIPromise<BatchMarkAsUnseenResponse>;
     /**
      * Marks the given messages as unarchived. This reverses the `archived` state.
      * Archived messages are hidden from the default message list in the feed but can
      * still be accessed and unarchived later.
+     *
+     * @example
+     * ```ts
+     * const messages = await client.messages.batch.unarchive({
+     *   message_ids: [
+     *     '2w3YUpTTOxuDvZFji8OMsKrG176',
+     *     '2w3YVRbPXMIh8Zq6oBFcVDA5xes',
+     *   ],
+     * });
+     * ```
      */
     unarchive(body: BatchUnarchiveParams, options?: RequestOptions): APIPromise<BatchUnarchiveResponse>;
 }

package/resources/messages/batch.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"batch.d.mts","sourceRoot":"","sources":["../../src/resources/messages/batch.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,WAAW;OAChB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;OAGG;IACH,OAAO,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,oBAAoB,CAAC;IAI7F;;OAEG;IACH,UAAU,CAAC,KAAK,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAIvG;;;;;;OAMG;IACH,gBAAgB,CACd,IAAI,EAAE,2BAA2B,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,6BAA6B,CAAC;IAI5C;;;OAGG;IACH,UAAU,CAAC,IAAI,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAItG;;;;OAIG;IACH,UAAU,CAAC,IAAI,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAItG;;;;OAIG;IACH,YAAY,CACV,IAAI,EAAE,uBAAuB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;IAIxC;;;;OAIG;IACH,YAAY,CACV,IAAI,EAAE,uBAAuB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;IAIxC;;;;OAIG;IACH,SAAS,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;CAGpG;AAED;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;AAE9D;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,KAAK,CAAC,uBAAuB,CAAC,2BAA2B,CAAC,CAAC;AAEjG,yBAAiB,uBAAuB,CAAC;IACvC;;OAEG;IACH,UAAiB,2BAA2B;QAC1C;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,IAAI,EACA,2BAA2B,CAAC,mBAAmB,GAC/C,2BAA2B,CAAC,iBAAiB,GAC7C,2BAA2B,CAAC,kBAAkB,GAC9C,2BAA2B,CAAC,kBAAkB,GAC9C,2BAA2B,CAAC,uBAAuB,CAAC;QAExD;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;KACpB;IAED,UAAiB,2BAA2B,CAAC;QAC3C;;WAEG;QACH,UAAiB,mBAAmB;YAClC;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,SAAS,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,YAAY,EAAE,MAAM,CAAC;YAErB;;eAEG;YACH,SAAS,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEpB;;eAEG;YACH,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEnB;;eAEG;YACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SAC1B;QAED;;WAEG;QACH,UAAiB,iBAAiB;YAChC;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;SACZ;QAED;;WAEG;QACH,UAAiB,kBAAkB;YACjC;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;SACvC;QAED;;WAEG;QACH,UAAiB,kBAAkB;YACjC;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;YAEpC;;eAEG;YACH,QAAQ,EAAE,kBAAkB,CAAC,QAAQ,CAAC;YAEtC;;eAEG;YACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;SAC3C;QAED,UAAiB,kBAAkB,CAAC;YAClC;;eAEG;YACH,UAAiB,QAAQ;gBACvB;;mBAEG;gBACH,MAAM,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC;gBAEtC;;mBAEG;gBACH,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;gBAE9C;;mBAEG;gBACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;aACzB;YAED,UAAiB,QAAQ,CAAC;gBACxB;;mBAEG;gBACH,UAAiB,KAAK;oBACpB;;uBAEG;oBACH,OAAO,EAAE,MAAM,CAAC;oBAEhB;;uBAEG;oBACH,IAAI,EAAE,MAAM,CAAC;oBAEb;;uBAEG;oBACH,IAAI,EAAE,MAAM,GAAG,UAAU,CAAC;iBAC3B;aACF;SACF;QAED;;WAEG;QACH,UAAiB,uBAAuB;YACtC;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;eAEG;YACH,MAAM,EAAE,KAAK,CACT,uBAAuB,CAAC,4BAA4B,GACpD,uBAAuB,CAAC,8BAA8B,CACzD,CAAC;SACH;QAED,UAAiB,uBAAuB,CAAC;YACvC;;eAEG;YACH,UAAiB,4BAA4B;gBAC3C;;mBAEG;gBACH,OAAO,EAAE,MAAM,CAAC;gBAEhB;;mBAEG;gBACH,IAAI,EAAE,MAAM,CAAC;gBAEb;;mBAEG;gBACH,QAAQ,EAAE,MAAM,CAAC;gBAEjB;;mBAEG;gBACH,IAAI,EAAE,UAAU,GAAG,MAAM,CAAC;aAC3B;YAED;;eAEG;YACH,UAAiB,8BAA8B;gBAC7C;;mBAEG;gBACH,OAAO,EAAE,KAAK,CAAC,8BAA8B,CAAC,MAAM,CAAC,CAAC;gBAEtD;;mBAEG;gBACH,IAAI,EAAE,MAAM,CAAC;gBAEb;;mBAEG;gBACH,IAAI,EAAE,YAAY,CAAC;aACpB;YAED,UAAiB,8BAA8B,CAAC;gBAC9C;;mBAEG;gBACH,UAAiB,MAAM;oBACrB;;uBAEG;oBACH,MAAM,EAAE,MAAM,CAAC;oBAEf;;uBAEG;oBACH,KAAK,EAAE,MAAM,CAAC;oBAEd;;uBAEG;oBACH,IAAI,EAAE,MAAM,CAAC;iBACd;aACF;SACF;KACF;CACF;AAED;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;AAEvE;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;AAEjE;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;AAEjE;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;AAEnE;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;AAEnE;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;AAEhE,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC5B;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC5B;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE3B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;CAC3C;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC5B;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC5B;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC5B;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC5B;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC5B;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}
+{"version":3,"file":"batch.d.mts","sourceRoot":"","sources":["../../src/resources/messages/batch.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,WAAW;OAChB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;;;;OAaG;IACH,OAAO,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,oBAAoB,CAAC;IAI7F;;;;;;;;;OASG;IACH,UAAU,CAAC,KAAK,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAIvG;;;;;;;;;;;;;;;OAeG;IACH,gBAAgB,CACd,IAAI,EAAE,2BAA2B,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,6BAA6B,CAAC;IAI5C;;;;;;;;;;;;;OAaG;IACH,UAAU,CAAC,IAAI,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAItG;;;;;;;;;;;;;;OAcG;IACH,UAAU,CAAC,IAAI,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAItG;;;;;;;;;;;;;;OAcG;IACH,YAAY,CACV,IAAI,EAAE,uBAAuB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;IAIxC;;;;;;;;;;;;;;OAcG;IACH,YAAY,CACV,IAAI,EAAE,uBAAuB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;IAIxC;;;;;;;;;;;;;;OAcG;IACH,SAAS,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;CAGpG;AAED;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;AAE9D;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,KAAK,CAAC,uBAAuB,CAAC,2BAA2B,CAAC,CAAC;AAEjG,yBAAiB,uBAAuB,CAAC;IACvC;;OAEG;IACH,UAAiB,2BAA2B;QAC1C;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,IAAI,EACA,2BAA2B,CAAC,mBAAmB,GAC/C,2BAA2B,CAAC,iBAAiB,GAC7C,2BAA2B,CAAC,kBAAkB,GAC9C,2BAA2B,CAAC,kBAAkB,GAC9C,2BAA2B,CAAC,uBAAuB,CAAC;QAExD;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;KACpB;IAED,UAAiB,2BAA2B,CAAC;QAC3C;;WAEG;QACH,UAAiB,mBAAmB;YAClC;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,SAAS,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,YAAY,EAAE,MAAM,CAAC;YAErB;;eAEG;YACH,SAAS,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEpB;;eAEG;YACH,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEnB;;eAEG;YACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SAC1B;QAED;;WAEG;QACH,UAAiB,iBAAiB;YAChC;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;SACZ;QAED;;WAEG;QACH,UAAiB,kBAAkB;YACjC;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;SACvC;QAED;;WAEG;QACH,UAAiB,kBAAkB;YACjC;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;YAEpC;;eAEG;YACH,QAAQ,EAAE,kBAAkB,CAAC,QAAQ,CAAC;YAEtC;;eAEG;YACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;SAC3C;QAED,UAAiB,kBAAkB,CAAC;YAClC;;eAEG;YACH,UAAiB,QAAQ;gBACvB;;mBAEG;gBACH,MAAM,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC;gBAEtC;;mBAEG;gBACH,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;gBAE9C;;mBAEG;gBACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;aACzB;YAED,UAAiB,QAAQ,CAAC;gBACxB;;mBAEG;gBACH,UAAiB,KAAK;oBACpB;;uBAEG;oBACH,OAAO,EAAE,MAAM,CAAC;oBAEhB;;uBAEG;oBACH,IAAI,EAAE,MAAM,CAAC;oBAEb;;uBAEG;oBACH,IAAI,EAAE,MAAM,GAAG,UAAU,CAAC;iBAC3B;aACF;SACF;QAED;;WAEG;QACH,UAAiB,uBAAuB;YACtC;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;eAEG;YACH,MAAM,EAAE,KAAK,CACT,uBAAuB,CAAC,4BAA4B,GACpD,uBAAuB,CAAC,8BAA8B,CACzD,CAAC;SACH;QAED,UAAiB,uBAAuB,CAAC;YACvC;;eAEG;YACH,UAAiB,4BAA4B;gBAC3C;;mBAEG;gBACH,OAAO,EAAE,MAAM,CAAC;gBAEhB;;mBAEG;gBACH,IAAI,EAAE,MAAM,CAAC;gBAEb;;mBAEG;gBACH,QAAQ,EAAE,MAAM,CAAC;gBAEjB;;mBAEG;gBACH,IAAI,EAAE,UAAU,GAAG,MAAM,CAAC;aAC3B;YAED;;eAEG;YACH,UAAiB,8BAA8B;gBAC7C;;mBAEG;gBACH,OAAO,EAAE,KAAK,CAAC,8BAA8B,CAAC,MAAM,CAAC,CAAC;gBAEtD;;mBAEG;gBACH,IAAI,EAAE,MAAM,CAAC;gBAEb;;mBAEG;gBACH,IAAI,EAAE,YAAY,CAAC;aACpB;YAED,UAAiB,8BAA8B,CAAC;gBAC9C;;mBAEG;gBACH,UAAiB,MAAM;oBACrB;;uBAEG;oBACH,MAAM,EAAE,MAAM,CAAC;oBAEf;;uBAEG;oBACH,KAAK,EAAE,MAAM,CAAC;oBAEd;;uBAEG;oBACH,IAAI,EAAE,MAAM,CAAC;iBACd;aACF;SACF;KACF;CACF;AAED;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;AAEvE;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;AAEjE;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;AAEjE;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;AAEnE;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;AAEnE;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;AAEhE,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC5B;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC5B;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE3B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;CAC3C;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC5B;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC5B;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC5B;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC5B;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC5B;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}

package/resources/messages/batch.d.ts

@@ -6,10 +6,27 @@ export declare class Batch extends APIResource {
     /**
      * Marks the given messages as archived. Archived messages are hidden from the
      * default message list in the feed but can still be accessed and unarchived later.
+     *
+     * @example
+     * ```ts
+     * const messages = await client.messages.batch.archive({
+     *   message_ids: [
+     *     '2w3YUpTTOxuDvZFji8OMsKrG176',
+     *     '2w3YVRbPXMIh8Zq6oBFcVDA5xes',
+     *   ],
+     * });
+     * ```
      */
     archive(body: BatchArchiveParams, options?: RequestOptions): APIPromise<BatchArchiveResponse>;
     /**
      * Get the contents of multiple messages in a single request.
+     *
+     * @example
+     * ```ts
+     * const response = await client.messages.batch.getContent({
+     *   message_ids: ['string'],
+     * });
+     * ```
      */
     getContent(query: BatchGetContentParams, options?: RequestOptions): APIPromise<BatchGetContentResponse>;
     /**
@@ -18,35 +35,94 @@ export declare class Batch extends APIResource {
      * interaction. 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 messages =
+     *   await client.messages.batch.markAsInteracted({
+     *     message_ids: ['1jNaXzB2RZX3LY8wVQnfCKyPnv7'],
+     *     metadata: { key: 'value' },
+     *   });
+     * ```
      */
     markAsInteracted(body: BatchMarkAsInteractedParams, options?: RequestOptions): APIPromise<BatchMarkAsInteractedResponse>;
     /**
      * Marks the given messages as `read`. Read more about message engagement statuses
      * [here](/send-notifications/message-statuses#engagement-status).
+     *
+     * @example
+     * ```ts
+     * const messages = await client.messages.batch.markAsRead({
+     *   message_ids: [
+     *     '2w3YUpTTOxuDvZFji8OMsKrG176',
+     *     '2w3YVRbPXMIh8Zq6oBFcVDA5xes',
+     *   ],
+     * });
+     * ```
      */
     markAsRead(body: BatchMarkAsReadParams, options?: RequestOptions): APIPromise<BatchMarkAsReadResponse>;
     /**
      * Marks the given messages 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 messages = await client.messages.batch.markAsSeen({
+     *   message_ids: [
+     *     '2w3YUpTTOxuDvZFji8OMsKrG176',
+     *     '2w3YVRbPXMIh8Zq6oBFcVDA5xes',
+     *   ],
+     * });
+     * ```
      */
     markAsSeen(body: BatchMarkAsSeenParams, options?: RequestOptions): APIPromise<BatchMarkAsSeenResponse>;
     /**
      * Marks the given messages as `unread`. This reverses the `read` state. Read more
      * about message engagement statuses
      * [here](/send-notifications/message-statuses#engagement-status).
+     *
+     * @example
+     * ```ts
+     * const messages = await client.messages.batch.markAsUnread({
+     *   message_ids: [
+     *     '2w3YUpTTOxuDvZFji8OMsKrG176',
+     *     '2w3YVRbPXMIh8Zq6oBFcVDA5xes',
+     *   ],
+     * });
+     * ```
      */
     markAsUnread(body: BatchMarkAsUnreadParams, options?: RequestOptions): APIPromise<BatchMarkAsUnreadResponse>;
     /**
      * Marks the given messages as `unseen`. This reverses the `seen` state. Read more
      * about message engagement statuses
      * [here](/send-notifications/message-statuses#engagement-status).
+     *
+     * @example
+     * ```ts
+     * const messages = await client.messages.batch.markAsUnseen({
+     *   message_ids: [
+     *     '2w3YUpTTOxuDvZFji8OMsKrG176',
+     *     '2w3YVRbPXMIh8Zq6oBFcVDA5xes',
+     *   ],
+     * });
+     * ```
      */
     markAsUnseen(body: BatchMarkAsUnseenParams, options?: RequestOptions): APIPromise<BatchMarkAsUnseenResponse>;
     /**
      * Marks the given messages as unarchived. This reverses the `archived` state.
      * Archived messages are hidden from the default message list in the feed but can
      * still be accessed and unarchived later.
+     *
+     * @example
+     * ```ts
+     * const messages = await client.messages.batch.unarchive({
+     *   message_ids: [
+     *     '2w3YUpTTOxuDvZFji8OMsKrG176',
+     *     '2w3YVRbPXMIh8Zq6oBFcVDA5xes',
+     *   ],
+     * });
+     * ```
      */
     unarchive(body: BatchUnarchiveParams, options?: RequestOptions): APIPromise<BatchUnarchiveResponse>;
 }

package/resources/messages/batch.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"batch.d.ts","sourceRoot":"","sources":["../../src/resources/messages/batch.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,WAAW;OAChB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;OAGG;IACH,OAAO,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,oBAAoB,CAAC;IAI7F;;OAEG;IACH,UAAU,CAAC,KAAK,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAIvG;;;;;;OAMG;IACH,gBAAgB,CACd,IAAI,EAAE,2BAA2B,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,6BAA6B,CAAC;IAI5C;;;OAGG;IACH,UAAU,CAAC,IAAI,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAItG;;;;OAIG;IACH,UAAU,CAAC,IAAI,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAItG;;;;OAIG;IACH,YAAY,CACV,IAAI,EAAE,uBAAuB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;IAIxC;;;;OAIG;IACH,YAAY,CACV,IAAI,EAAE,uBAAuB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;IAIxC;;;;OAIG;IACH,SAAS,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;CAGpG;AAED;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;AAE9D;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,KAAK,CAAC,uBAAuB,CAAC,2BAA2B,CAAC,CAAC;AAEjG,yBAAiB,uBAAuB,CAAC;IACvC;;OAEG;IACH,UAAiB,2BAA2B;QAC1C;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,IAAI,EACA,2BAA2B,CAAC,mBAAmB,GAC/C,2BAA2B,CAAC,iBAAiB,GAC7C,2BAA2B,CAAC,kBAAkB,GAC9C,2BAA2B,CAAC,kBAAkB,GAC9C,2BAA2B,CAAC,uBAAuB,CAAC;QAExD;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;KACpB;IAED,UAAiB,2BAA2B,CAAC;QAC3C;;WAEG;QACH,UAAiB,mBAAmB;YAClC;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,SAAS,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,YAAY,EAAE,MAAM,CAAC;YAErB;;eAEG;YACH,SAAS,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEpB;;eAEG;YACH,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEnB;;eAEG;YACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SAC1B;QAED;;WAEG;QACH,UAAiB,iBAAiB;YAChC;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;SACZ;QAED;;WAEG;QACH,UAAiB,kBAAkB;YACjC;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;SACvC;QAED;;WAEG;QACH,UAAiB,kBAAkB;YACjC;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;YAEpC;;eAEG;YACH,QAAQ,EAAE,kBAAkB,CAAC,QAAQ,CAAC;YAEtC;;eAEG;YACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;SAC3C;QAED,UAAiB,kBAAkB,CAAC;YAClC;;eAEG;YACH,UAAiB,QAAQ;gBACvB;;mBAEG;gBACH,MAAM,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC;gBAEtC;;mBAEG;gBACH,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;gBAE9C;;mBAEG;gBACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;aACzB;YAED,UAAiB,QAAQ,CAAC;gBACxB;;mBAEG;gBACH,UAAiB,KAAK;oBACpB;;uBAEG;oBACH,OAAO,EAAE,MAAM,CAAC;oBAEhB;;uBAEG;oBACH,IAAI,EAAE,MAAM,CAAC;oBAEb;;uBAEG;oBACH,IAAI,EAAE,MAAM,GAAG,UAAU,CAAC;iBAC3B;aACF;SACF;QAED;;WAEG;QACH,UAAiB,uBAAuB;YACtC;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;eAEG;YACH,MAAM,EAAE,KAAK,CACT,uBAAuB,CAAC,4BAA4B,GACpD,uBAAuB,CAAC,8BAA8B,CACzD,CAAC;SACH;QAED,UAAiB,uBAAuB,CAAC;YACvC;;eAEG;YACH,UAAiB,4BAA4B;gBAC3C;;mBAEG;gBACH,OAAO,EAAE,MAAM,CAAC;gBAEhB;;mBAEG;gBACH,IAAI,EAAE,MAAM,CAAC;gBAEb;;mBAEG;gBACH,QAAQ,EAAE,MAAM,CAAC;gBAEjB;;mBAEG;gBACH,IAAI,EAAE,UAAU,GAAG,MAAM,CAAC;aAC3B;YAED;;eAEG;YACH,UAAiB,8BAA8B;gBAC7C;;mBAEG;gBACH,OAAO,EAAE,KAAK,CAAC,8BAA8B,CAAC,MAAM,CAAC,CAAC;gBAEtD;;mBAEG;gBACH,IAAI,EAAE,MAAM,CAAC;gBAEb;;mBAEG;gBACH,IAAI,EAAE,YAAY,CAAC;aACpB;YAED,UAAiB,8BAA8B,CAAC;gBAC9C;;mBAEG;gBACH,UAAiB,MAAM;oBACrB;;uBAEG;oBACH,MAAM,EAAE,MAAM,CAAC;oBAEf;;uBAEG;oBACH,KAAK,EAAE,MAAM,CAAC;oBAEd;;uBAEG;oBACH,IAAI,EAAE,MAAM,CAAC;iBACd;aACF;SACF;KACF;CACF;AAED;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;AAEvE;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;AAEjE;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;AAEjE;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;AAEnE;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;AAEnE;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;AAEhE,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC5B;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC5B;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE3B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;CAC3C;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC5B;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC5B;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC5B;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC5B;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC5B;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}
+{"version":3,"file":"batch.d.ts","sourceRoot":"","sources":["../../src/resources/messages/batch.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,WAAW;OAChB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;;;;OAaG;IACH,OAAO,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,oBAAoB,CAAC;IAI7F;;;;;;;;;OASG;IACH,UAAU,CAAC,KAAK,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAIvG;;;;;;;;;;;;;;;OAeG;IACH,gBAAgB,CACd,IAAI,EAAE,2BAA2B,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,6BAA6B,CAAC;IAI5C;;;;;;;;;;;;;OAaG;IACH,UAAU,CAAC,IAAI,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAItG;;;;;;;;;;;;;;OAcG;IACH,UAAU,CAAC,IAAI,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAItG;;;;;;;;;;;;;;OAcG;IACH,YAAY,CACV,IAAI,EAAE,uBAAuB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;IAIxC;;;;;;;;;;;;;;OAcG;IACH,YAAY,CACV,IAAI,EAAE,uBAAuB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;IAIxC;;;;;;;;;;;;;;OAcG;IACH,SAAS,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;CAGpG;AAED;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;AAE9D;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,KAAK,CAAC,uBAAuB,CAAC,2BAA2B,CAAC,CAAC;AAEjG,yBAAiB,uBAAuB,CAAC;IACvC;;OAEG;IACH,UAAiB,2BAA2B;QAC1C;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,IAAI,EACA,2BAA2B,CAAC,mBAAmB,GAC/C,2BAA2B,CAAC,iBAAiB,GAC7C,2BAA2B,CAAC,kBAAkB,GAC9C,2BAA2B,CAAC,kBAAkB,GAC9C,2BAA2B,CAAC,uBAAuB,CAAC;QAExD;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;KACpB;IAED,UAAiB,2BAA2B,CAAC;QAC3C;;WAEG;QACH,UAAiB,mBAAmB;YAClC;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,SAAS,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,YAAY,EAAE,MAAM,CAAC;YAErB;;eAEG;YACH,SAAS,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEpB;;eAEG;YACH,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEnB;;eAEG;YACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SAC1B;QAED;;WAEG;QACH,UAAiB,iBAAiB;YAChC;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;SACZ;QAED;;WAEG;QACH,UAAiB,kBAAkB;YACjC;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;SACvC;QAED;;WAEG;QACH,UAAiB,kBAAkB;YACjC;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;YAEpC;;eAEG;YACH,QAAQ,EAAE,kBAAkB,CAAC,QAAQ,CAAC;YAEtC;;eAEG;YACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;SAC3C;QAED,UAAiB,kBAAkB,CAAC;YAClC;;eAEG;YACH,UAAiB,QAAQ;gBACvB;;mBAEG;gBACH,MAAM,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC;gBAEtC;;mBAEG;gBACH,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;gBAE9C;;mBAEG;gBACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;aACzB;YAED,UAAiB,QAAQ,CAAC;gBACxB;;mBAEG;gBACH,UAAiB,KAAK;oBACpB;;uBAEG;oBACH,OAAO,EAAE,MAAM,CAAC;oBAEhB;;uBAEG;oBACH,IAAI,EAAE,MAAM,CAAC;oBAEb;;uBAEG;oBACH,IAAI,EAAE,MAAM,GAAG,UAAU,CAAC;iBAC3B;aACF;SACF;QAED;;WAEG;QACH,UAAiB,uBAAuB;YACtC;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;eAEG;YACH,MAAM,EAAE,KAAK,CACT,uBAAuB,CAAC,4BAA4B,GACpD,uBAAuB,CAAC,8BAA8B,CACzD,CAAC;SACH;QAED,UAAiB,uBAAuB,CAAC;YACvC;;eAEG;YACH,UAAiB,4BAA4B;gBAC3C;;mBAEG;gBACH,OAAO,EAAE,MAAM,CAAC;gBAEhB;;mBAEG;gBACH,IAAI,EAAE,MAAM,CAAC;gBAEb;;mBAEG;gBACH,QAAQ,EAAE,MAAM,CAAC;gBAEjB;;mBAEG;gBACH,IAAI,EAAE,UAAU,GAAG,MAAM,CAAC;aAC3B;YAED;;eAEG;YACH,UAAiB,8BAA8B;gBAC7C;;mBAEG;gBACH,OAAO,EAAE,KAAK,CAAC,8BAA8B,CAAC,MAAM,CAAC,CAAC;gBAEtD;;mBAEG;gBACH,IAAI,EAAE,MAAM,CAAC;gBAEb;;mBAEG;gBACH,IAAI,EAAE,YAAY,CAAC;aACpB;YAED,UAAiB,8BAA8B,CAAC;gBAC9C;;mBAEG;gBACH,UAAiB,MAAM;oBACrB;;uBAEG;oBACH,MAAM,EAAE,MAAM,CAAC;oBAEf;;uBAEG;oBACH,KAAK,EAAE,MAAM,CAAC;oBAEd;;uBAEG;oBACH,IAAI,EAAE,MAAM,CAAC;iBACd;aACF;SACF;KACF;CACF;AAED;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;AAEvE;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;AAEjE;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;AAEjE;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;AAEnE;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;AAEnE;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;AAEhE,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC5B;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC5B;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE3B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;CAC3C;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC5B;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC5B;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC5B;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC5B;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC5B;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}

package/resources/messages/batch.js

@@ -7,12 +7,29 @@ class Batch extends resource_1.APIResource {
     /**
      * Marks the given messages as archived. Archived messages are hidden from the
      * default message list in the feed but can still be accessed and unarchived later.
+     *
+     * @example
+     * ```ts
+     * const messages = await client.messages.batch.archive({
+     *   message_ids: [
+     *     '2w3YUpTTOxuDvZFji8OMsKrG176',
+     *     '2w3YVRbPXMIh8Zq6oBFcVDA5xes',
+     *   ],
+     * });
+     * ```
      */
     archive(body, options) {
         return this._client.post('/v1/messages/batch/archived', { body, ...options });
     }
     /**
      * Get the contents of multiple messages in a single request.
+     *
+     * @example
+     * ```ts
+     * const response = await client.messages.batch.getContent({
+     *   message_ids: ['string'],
+     * });
+     * ```
      */
     getContent(query, options) {
         return this._client.get('/v1/messages/batch/content', { query, ...options });
@@ -23,6 +40,15 @@ class Batch extends resource_1.APIResource {
      * interaction. 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 messages =
+     *   await client.messages.batch.markAsInteracted({
+     *     message_ids: ['1jNaXzB2RZX3LY8wVQnfCKyPnv7'],
+     *     metadata: { key: 'value' },
+     *   });
+     * ```
      */
     markAsInteracted(body, options) {
         return this._client.post('/v1/messages/batch/interacted', { body, ...options });
@@ -30,6 +56,16 @@ class Batch extends resource_1.APIResource {
     /**
      * Marks the given messages as `read`. Read more about message engagement statuses
      * [here](/send-notifications/message-statuses#engagement-status).
+     *
+     * @example
+     * ```ts
+     * const messages = await client.messages.batch.markAsRead({
+     *   message_ids: [
+     *     '2w3YUpTTOxuDvZFji8OMsKrG176',
+     *     '2w3YVRbPXMIh8Zq6oBFcVDA5xes',
+     *   ],
+     * });
+     * ```
      */
     markAsRead(body, options) {
         return this._client.post('/v1/messages/batch/read', { body, ...options });
@@ -38,6 +74,16 @@ class Batch extends resource_1.APIResource {
      * Marks the given messages 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 messages = await client.messages.batch.markAsSeen({
+     *   message_ids: [
+     *     '2w3YUpTTOxuDvZFji8OMsKrG176',
+     *     '2w3YVRbPXMIh8Zq6oBFcVDA5xes',
+     *   ],
+     * });
+     * ```
      */
     markAsSeen(body, options) {
         return this._client.post('/v1/messages/batch/seen', { body, ...options });
@@ -46,6 +92,16 @@ class Batch extends resource_1.APIResource {
      * Marks the given messages as `unread`. This reverses the `read` state. Read more
      * about message engagement statuses
      * [here](/send-notifications/message-statuses#engagement-status).
+     *
+     * @example
+     * ```ts
+     * const messages = await client.messages.batch.markAsUnread({
+     *   message_ids: [
+     *     '2w3YUpTTOxuDvZFji8OMsKrG176',
+     *     '2w3YVRbPXMIh8Zq6oBFcVDA5xes',
+     *   ],
+     * });
+     * ```
      */
     markAsUnread(body, options) {
         return this._client.post('/v1/messages/batch/unread', { body, ...options });
@@ -54,6 +110,16 @@ class Batch extends resource_1.APIResource {
      * Marks the given messages as `unseen`. This reverses the `seen` state. Read more
      * about message engagement statuses
      * [here](/send-notifications/message-statuses#engagement-status).
+     *
+     * @example
+     * ```ts
+     * const messages = await client.messages.batch.markAsUnseen({
+     *   message_ids: [
+     *     '2w3YUpTTOxuDvZFji8OMsKrG176',
+     *     '2w3YVRbPXMIh8Zq6oBFcVDA5xes',
+     *   ],
+     * });
+     * ```
      */
     markAsUnseen(body, options) {
         return this._client.post('/v1/messages/batch/unseen', { body, ...options });
@@ -62,6 +128,16 @@ class Batch extends resource_1.APIResource {
      * Marks the given messages as unarchived. This reverses the `archived` state.
      * Archived messages are hidden from the default message list in the feed but can
      * still be accessed and unarchived later.
+     *
+     * @example
+     * ```ts
+     * const messages = await client.messages.batch.unarchive({
+     *   message_ids: [
+     *     '2w3YUpTTOxuDvZFji8OMsKrG176',
+     *     '2w3YVRbPXMIh8Zq6oBFcVDA5xes',
+     *   ],
+     * });
+     * ```
      */
     unarchive(body, options) {
         return this._client.post('/v1/messages/batch/unarchived', { body, ...options });

package/resources/messages/batch.js.map

@@ -1 +1 @@
-{"version":3,"file":"batch.js","sourceRoot":"","sources":["../../src/resources/messages/batch.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAKlD,MAAa,KAAM,SAAQ,sBAAW;IACpC;;;OAGG;IACH,OAAO,CAAC,IAAwB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,6BAA6B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;OAEG;IACH,UAAU,CAAC,KAA4B,EAAE,OAAwB;QAC/D,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,4BAA4B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;IAED;;;;;;OAMG;IACH,gBAAgB,CACd,IAAiC,EACjC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,+BAA+B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;IAED;;;OAGG;IACH,UAAU,CAAC,IAA2B,EAAE,OAAwB;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yBAAyB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;;;OAIG;IACH,UAAU,CAAC,IAA2B,EAAE,OAAwB;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yBAAyB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;;;OAIG;IACH,YAAY,CACV,IAA6B,EAC7B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,2BAA2B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9E,CAAC;IAED;;;;OAIG;IACH,YAAY,CACV,IAA6B,EAC7B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,2BAA2B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9E,CAAC;IAED;;;;OAIG;IACH,SAAS,CAAC,IAA0B,EAAE,OAAwB;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,+BAA+B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;CACF;AA/ED,sBA+EC"}
+{"version":3,"file":"batch.js","sourceRoot":"","sources":["../../src/resources/messages/batch.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAKlD,MAAa,KAAM,SAAQ,sBAAW;IACpC;;;;;;;;;;;;;OAaG;IACH,OAAO,CAAC,IAAwB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,6BAA6B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;;;;OASG;IACH,UAAU,CAAC,KAA4B,EAAE,OAAwB;QAC/D,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,4BAA4B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,gBAAgB,CACd,IAAiC,EACjC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,+BAA+B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,UAAU,CAAC,IAA2B,EAAE,OAAwB;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yBAAyB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,UAAU,CAAC,IAA2B,EAAE,OAAwB;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yBAAyB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,YAAY,CACV,IAA6B,EAC7B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,2BAA2B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9E,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,YAAY,CACV,IAA6B,EAC7B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,2BAA2B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9E,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,SAAS,CAAC,IAA0B,EAAE,OAAwB;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,+BAA+B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;CACF;AA3JD,sBA2JC"}

package/resources/messages/batch.mjs

@@ -4,12 +4,29 @@ export class Batch extends APIResource {
     /**
      * Marks the given messages as archived. Archived messages are hidden from the
      * default message list in the feed but can still be accessed and unarchived later.
+     *
+     * @example
+     * ```ts
+     * const messages = await client.messages.batch.archive({
+     *   message_ids: [
+     *     '2w3YUpTTOxuDvZFji8OMsKrG176',
+     *     '2w3YVRbPXMIh8Zq6oBFcVDA5xes',
+     *   ],
+     * });
+     * ```
      */
     archive(body, options) {
         return this._client.post('/v1/messages/batch/archived', { body, ...options });
     }
     /**
      * Get the contents of multiple messages in a single request.
+     *
+     * @example
+     * ```ts
+     * const response = await client.messages.batch.getContent({
+     *   message_ids: ['string'],
+     * });
+     * ```
      */
     getContent(query, options) {
         return this._client.get('/v1/messages/batch/content', { query, ...options });
@@ -20,6 +37,15 @@ export class Batch extends APIResource {
      * interaction. 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 messages =
+     *   await client.messages.batch.markAsInteracted({
+     *     message_ids: ['1jNaXzB2RZX3LY8wVQnfCKyPnv7'],
+     *     metadata: { key: 'value' },
+     *   });
+     * ```
      */
     markAsInteracted(body, options) {
         return this._client.post('/v1/messages/batch/interacted', { body, ...options });
@@ -27,6 +53,16 @@ export class Batch extends APIResource {
     /**
      * Marks the given messages as `read`. Read more about message engagement statuses
      * [here](/send-notifications/message-statuses#engagement-status).
+     *
+     * @example
+     * ```ts
+     * const messages = await client.messages.batch.markAsRead({
+     *   message_ids: [
+     *     '2w3YUpTTOxuDvZFji8OMsKrG176',
+     *     '2w3YVRbPXMIh8Zq6oBFcVDA5xes',
+     *   ],
+     * });
+     * ```
      */
     markAsRead(body, options) {
         return this._client.post('/v1/messages/batch/read', { body, ...options });
@@ -35,6 +71,16 @@ export class Batch extends APIResource {
      * Marks the given messages 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 messages = await client.messages.batch.markAsSeen({
+     *   message_ids: [
+     *     '2w3YUpTTOxuDvZFji8OMsKrG176',
+     *     '2w3YVRbPXMIh8Zq6oBFcVDA5xes',
+     *   ],
+     * });
+     * ```
      */
     markAsSeen(body, options) {
         return this._client.post('/v1/messages/batch/seen', { body, ...options });
@@ -43,6 +89,16 @@ export class Batch extends APIResource {
      * Marks the given messages as `unread`. This reverses the `read` state. Read more
      * about message engagement statuses
      * [here](/send-notifications/message-statuses#engagement-status).
+     *
+     * @example
+     * ```ts
+     * const messages = await client.messages.batch.markAsUnread({
+     *   message_ids: [
+     *     '2w3YUpTTOxuDvZFji8OMsKrG176',
+     *     '2w3YVRbPXMIh8Zq6oBFcVDA5xes',
+     *   ],
+     * });
+     * ```
      */
     markAsUnread(body, options) {
         return this._client.post('/v1/messages/batch/unread', { body, ...options });
@@ -51,6 +107,16 @@ export class Batch extends APIResource {
      * Marks the given messages as `unseen`. This reverses the `seen` state. Read more
      * about message engagement statuses
      * [here](/send-notifications/message-statuses#engagement-status).
+     *
+     * @example
+     * ```ts
+     * const messages = await client.messages.batch.markAsUnseen({
+     *   message_ids: [
+     *     '2w3YUpTTOxuDvZFji8OMsKrG176',
+     *     '2w3YVRbPXMIh8Zq6oBFcVDA5xes',
+     *   ],
+     * });
+     * ```
      */
     markAsUnseen(body, options) {
         return this._client.post('/v1/messages/batch/unseen', { body, ...options });
@@ -59,6 +125,16 @@ export class Batch extends APIResource {
      * Marks the given messages as unarchived. This reverses the `archived` state.
      * Archived messages are hidden from the default message list in the feed but can
      * still be accessed and unarchived later.
+     *
+     * @example
+     * ```ts
+     * const messages = await client.messages.batch.unarchive({
+     *   message_ids: [
+     *     '2w3YUpTTOxuDvZFji8OMsKrG176',
+     *     '2w3YVRbPXMIh8Zq6oBFcVDA5xes',
+     *   ],
+     * });
+     * ```
      */
     unarchive(body, options) {
         return this._client.post('/v1/messages/batch/unarchived', { body, ...options });

package/resources/messages/batch.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"batch.mjs","sourceRoot":"","sources":["../../src/resources/messages/batch.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAKtB,MAAM,OAAO,KAAM,SAAQ,WAAW;IACpC;;;OAGG;IACH,OAAO,CAAC,IAAwB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,6BAA6B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;OAEG;IACH,UAAU,CAAC,KAA4B,EAAE,OAAwB;QAC/D,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,4BAA4B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;IAED;;;;;;OAMG;IACH,gBAAgB,CACd,IAAiC,EACjC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,+BAA+B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;IAED;;;OAGG;IACH,UAAU,CAAC,IAA2B,EAAE,OAAwB;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yBAAyB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;;;OAIG;IACH,UAAU,CAAC,IAA2B,EAAE,OAAwB;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yBAAyB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;;;OAIG;IACH,YAAY,CACV,IAA6B,EAC7B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,2BAA2B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9E,CAAC;IAED;;;;OAIG;IACH,YAAY,CACV,IAA6B,EAC7B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,2BAA2B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9E,CAAC;IAED;;;;OAIG;IACH,SAAS,CAAC,IAA0B,EAAE,OAAwB;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,+BAA+B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;CACF"}
+{"version":3,"file":"batch.mjs","sourceRoot":"","sources":["../../src/resources/messages/batch.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAKtB,MAAM,OAAO,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;;;;OAaG;IACH,OAAO,CAAC,IAAwB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,6BAA6B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;;;;OASG;IACH,UAAU,CAAC,KAA4B,EAAE,OAAwB;QAC/D,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,4BAA4B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,gBAAgB,CACd,IAAiC,EACjC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,+BAA+B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,UAAU,CAAC,IAA2B,EAAE,OAAwB;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yBAAyB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,UAAU,CAAC,IAA2B,EAAE,OAAwB;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yBAAyB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,YAAY,CACV,IAA6B,EAC7B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,2BAA2B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9E,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,YAAY,CACV,IAA6B,EAC7B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,2BAA2B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9E,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,SAAS,CAAC,IAA0B,EAAE,OAAwB;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,+BAA+B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;CACF"}