@whop/sdk 0.0.26 → 0.0.28

package/resources/messages.d.mts

@@ -5,7 +5,8 @@ import { CursorPage, type CursorPageParams, PagePromise } from "../core/paginati
 import { RequestOptions } from "../internal/request-options.mjs";
 export declare class Messages extends APIResource {
     /**
-     * Creates a new message
+     * Send a new message in an experience chat, DM, or group chat channel. Supports
+     * text content, attachments, polls, and replies.
      *
      * Required permissions:
      *
@@ -13,7 +14,7 @@ export declare class Messages extends APIResource {
      */
     create(body: MessageCreateParams, options?: RequestOptions): APIPromise<Shared.Message>;
     /**
-     * Retrieves a message
+     * Retrieves the details of an existing message.
      *
      * Required permissions:
      *
@@ -21,11 +22,13 @@ export declare class Messages extends APIResource {
      */
     retrieve(id: string, options?: RequestOptions): APIPromise<Shared.Message>;
     /**
-     * Updates an existing message
+     * Edit the content, attachments, or pinned status of an existing message in an
+     * experience chat, DM, or group chat channel.
      */
     update(id: string, body?: MessageUpdateParams | null | undefined, options?: RequestOptions): APIPromise<Shared.Message>;
     /**
-     * Lists messages inside a channel
+     * Returns a paginated list of messages within a specific experience chat, DM, or
+     * group chat channel, sorted by creation time.
      *
      * Required permissions:
      *
@@ -33,7 +36,8 @@ export declare class Messages extends APIResource {
      */
     list(query: MessageListParams, options?: RequestOptions): PagePromise<MessageListResponsesCursorPage, MessageListResponse>;
     /**
-     * Deletes a message
+     * Permanently delete a message from an experience chat, DM, or group chat channel.
+     * Only the message author or a channel admin can delete a message.
      *
      * Required permissions:
      *
@@ -43,65 +47,74 @@ export declare class Messages extends APIResource {
 }
 export type MessageListResponsesCursorPage = CursorPage<MessageListResponse>;
 /**
- * Represents a message in a DM channel
+ * A message sent within an experience chat, direct message, or group chat.
  */
 export interface MessageListResponse {
     /**
-     * The unique identifier of the resource.
+     * Represents a unique identifier that is Base64 obfuscated. It is often used to
+     * refetch an object or as key for a cache. The ID type appears in a JSON response
+     * as a String; however, it is not intended to be human-readable. When expected as
+     * an input type, any string (such as `"VXNlci0xMA=="`) or integer (such as `4`)
+     * input value will be accepted as an ID.
      */
     id: string;
     /**
-     * The content of the message in Markdown format
+     * The message content formatted as Markdown. Null if the message has no text
+     * content.
      */
     content: string | null;
     /**
-     * The timestamp when the post was created
+     * The timestamp when this message was originally created.
      */
     created_at: string;
     /**
-     * Whether the message has been edited
+     * Whether the message content has been edited after it was originally sent.
      */
     is_edited: boolean;
     /**
-     * Whether this message is pinned
+     * Whether this message is pinned to the top of the channel for easy access.
      */
     is_pinned: boolean;
     /**
-     * The type of post
+     * The classification of this message: regular, system, or automated.
      */
     message_type: Shared.DmsPostTypes;
     /**
-     * The poll for this message
+     * A poll attached to this message. Null if the message does not contain a poll.
      */
     poll: MessageListResponse.Poll | null;
     /**
-     * The reaction counts for this message
+     * Aggregated reaction counts on this message, filtered to a specific reaction
+     * type.
      */
     poll_votes: Array<MessageListResponse.PollVote>;
     /**
-     * The reaction counts for this message
+     * Aggregated reaction counts on this message, filtered to a specific reaction
+     * type.
      */
     reaction_counts: Array<MessageListResponse.ReactionCount>;
     /**
-     * The ID of the message this is replying to, if applicable
+     * The unique identifier of the message this post is replying to. Null if this is
+     * not a reply.
      */
     replying_to_message_id: string | null;
     /**
-     * The timestamp when the post was last updated
+     * The timestamp when this message was last modified.
      */
     updated_at: string;
     /**
-     * The user who sent this message
+     * The user who authored this message.
      */
     user: MessageListResponse.User;
     /**
-     * The number of times this message has been viewed
+     * The number of unique views this message has received. Null if view tracking is
+     * not enabled for this channel.
      */
     view_count: number | null;
 }
 export declare namespace MessageListResponse {
     /**
-     * The poll for this message
+     * A poll attached to this message. Null if the message does not contain a poll.
      */
     interface Poll {
         /**
@@ -115,7 +128,7 @@ export declare namespace MessageListResponse {
          */
         interface Option {
             /**
-             * The ID of the poll option
+             * The unique identifier for the poll option.
              */
             id: string;
             /**
@@ -151,19 +164,19 @@ export declare namespace MessageListResponse {
         emoji: string | null;
     }
     /**
-     * The user who sent this message
+     * The user who authored this message.
      */
     interface User {
         /**
-         * The internal ID of the user.
+         * The unique identifier for the user.
          */
         id: string;
         /**
-         * The name of the user from their Whop account.
+         * The user's display name shown on their public profile.
          */
         name: string | null;
         /**
-         * The username of the user from their Whop account.
+         * The user's unique username shown on their public profile.
          */
         username: string;
     }
@@ -174,23 +187,26 @@ export declare namespace MessageListResponse {
 export type MessageDeleteResponse = boolean;
 export interface MessageCreateParams {
     /**
-     * The ID of the channel or experience to send to.
+     * The unique identifier of the channel or experience to send the message in. For
+     * example, 'exp_xxxxx' or 'feed_xxxxx'.
      */
     channel_id: string;
     /**
-     * The content of the message in Markdown format.
+     * The body of the message in Markdown format. For example, 'Hello **world**'.
      */
     content: string;
     /**
-     * The attachments for this message, such as videos or images.
+     * A list of file attachments to include with the message, such as images or
+     * videos.
      */
     attachments?: Array<MessageCreateParams.Attachment> | null;
     /**
-     * The poll for this message
+     * A poll to attach to this message, allowing recipients to vote on options.
      */
     poll?: MessageCreateParams.Poll | null;
     /**
-     * The ID of the message this is replying to, if applicable.
+     * The unique identifier of the message this is replying to, creating a threaded
+     * reply.
      */
     replying_to_message_id?: string | null;
 }
@@ -205,7 +221,7 @@ export declare namespace MessageCreateParams {
         id: string;
     }
     /**
-     * The poll for this message
+     * A poll to attach to this message, allowing recipients to vote on options.
      */
     interface Poll {
         /**
@@ -231,15 +247,17 @@ export declare namespace MessageCreateParams {
 }
 export interface MessageUpdateParams {
     /**
-     * The attachments for this message
+     * A replacement list of file attachments for this message, such as images or
+     * videos.
      */
     attachments?: Array<MessageUpdateParams.Attachment> | null;
     /**
-     * The content of the message in Markdown format
+     * The updated body of the message in Markdown format. For example, 'Hello
+     * **world**'.
      */
     content?: string | null;
     /**
-     * Whether this message is pinned
+     * Whether this message should be pinned to the top of the channel.
      */
     is_pinned?: boolean | null;
 }
@@ -256,7 +274,7 @@ export declare namespace MessageUpdateParams {
 }
 export interface MessageListParams extends CursorPageParams {
     /**
-     * The ID of the channel or the experience ID to list messages for
+     * The unique identifier of the channel or experience to list messages for.
      */
     channel_id: string;
     /**

package/resources/messages.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"messages.d.mts","sourceRoot":"","sources":["../src/resources/messages.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;OAMG;IACH,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC;IAIvF;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC;IAI1E;;OAEG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC;IAI7B;;;;;;OAMG;IACH,IAAI,CACF,KAAK,EAAE,iBAAiB,EACxB,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,8BAA8B,EAAE,mBAAmB,CAAC;IAInE;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;CAGhF;AAED,MAAM,MAAM,8BAA8B,GAAG,UAAU,CAAC,mBAAmB,CAAC,CAAC;AAE7E;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC,YAAY,CAAC;IAElC;;OAEG;IACH,IAAI,EAAE,mBAAmB,CAAC,IAAI,GAAG,IAAI,CAAC;IAEtC;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC;IAEhD;;OAEG;IACH,eAAe,EAAE,KAAK,CAAC,mBAAmB,CAAC,aAAa,CAAC,CAAC;IAE1D;;OAEG;IACH,sBAAsB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,mBAAmB,CAAC,IAAI,CAAC;IAE/B;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;KACpC;IAED,UAAiB,IAAI,CAAC;QACpB;;WAEG;QACH,UAAiB,MAAM;YACrB;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;SACd;KACF;IAED;;OAEG;IACH,UAAiB,QAAQ;QACvB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;KAC1B;IAED;;OAEG;IACH,UAAiB,aAAa;QAC5B;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;KACtB;IAED;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;KAClB;CACF;AAED;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,OAAO,CAAC;AAE5C,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC;IAE3D;;OAEG;IACH,IAAI,CAAC,EAAE,mBAAmB,CAAC,IAAI,GAAG,IAAI,CAAC;IAEvC;;OAEG;IACH,sBAAsB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxC;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;IAED;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;KAC7B;IAED,UAAiB,IAAI,CAAC;QACpB;;WAEG;QACH,UAAiB,MAAM;YACrB;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;SACd;KACF;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC;IAE3D;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CAC5B;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED,MAAM,WAAW,iBAAkB,SAAQ,gBAAgB;IACzD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}
+{"version":3,"file":"messages.d.mts","sourceRoot":"","sources":["../src/resources/messages.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;OAOG;IACH,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC;IAIvF;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC;IAI1E;;;OAGG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC;IAI7B;;;;;;;OAOG;IACH,IAAI,CACF,KAAK,EAAE,iBAAiB,EACxB,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,8BAA8B,EAAE,mBAAmB,CAAC;IAInE;;;;;;;OAOG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;CAGhF;AAED,MAAM,MAAM,8BAA8B,GAAG,UAAU,CAAC,mBAAmB,CAAC,CAAC;AAE7E;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;;;;OAMG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC,YAAY,CAAC;IAElC;;OAEG;IACH,IAAI,EAAE,mBAAmB,CAAC,IAAI,GAAG,IAAI,CAAC;IAEtC;;;OAGG;IACH,UAAU,EAAE,KAAK,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC;IAEhD;;;OAGG;IACH,eAAe,EAAE,KAAK,CAAC,mBAAmB,CAAC,aAAa,CAAC,CAAC;IAE1D;;;OAGG;IACH,sBAAsB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,mBAAmB,CAAC,IAAI,CAAC;IAE/B;;;OAGG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;KACpC;IAED,UAAiB,IAAI,CAAC;QACpB;;WAEG;QACH,UAAiB,MAAM;YACrB;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;SACd;KACF;IAED;;OAEG;IACH,UAAiB,QAAQ;QACvB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;KAC1B;IAED;;OAEG;IACH,UAAiB,aAAa;QAC5B;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;KACtB;IAED;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;KAClB;CACF;AAED;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,OAAO,CAAC;AAE5C,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC;IAE3D;;OAEG;IACH,IAAI,CAAC,EAAE,mBAAmB,CAAC,IAAI,GAAG,IAAI,CAAC;IAEvC;;;OAGG;IACH,sBAAsB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxC;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;IAED;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;KAC7B;IAED,UAAiB,IAAI,CAAC;QACpB;;WAEG;QACH,UAAiB,MAAM;YACrB;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;SACd;KACF;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC;IAE3D;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CAC5B;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED,MAAM,WAAW,iBAAkB,SAAQ,gBAAgB;IACzD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}

package/resources/messages.d.ts

@@ -5,7 +5,8 @@ import { CursorPage, type CursorPageParams, PagePromise } from "../core/paginati
 import { RequestOptions } from "../internal/request-options.js";
 export declare class Messages extends APIResource {
     /**
-     * Creates a new message
+     * Send a new message in an experience chat, DM, or group chat channel. Supports
+     * text content, attachments, polls, and replies.
      *
      * Required permissions:
      *
@@ -13,7 +14,7 @@ export declare class Messages extends APIResource {
      */
     create(body: MessageCreateParams, options?: RequestOptions): APIPromise<Shared.Message>;
     /**
-     * Retrieves a message
+     * Retrieves the details of an existing message.
      *
      * Required permissions:
      *
@@ -21,11 +22,13 @@ export declare class Messages extends APIResource {
      */
     retrieve(id: string, options?: RequestOptions): APIPromise<Shared.Message>;
     /**
-     * Updates an existing message
+     * Edit the content, attachments, or pinned status of an existing message in an
+     * experience chat, DM, or group chat channel.
      */
     update(id: string, body?: MessageUpdateParams | null | undefined, options?: RequestOptions): APIPromise<Shared.Message>;
     /**
-     * Lists messages inside a channel
+     * Returns a paginated list of messages within a specific experience chat, DM, or
+     * group chat channel, sorted by creation time.
      *
      * Required permissions:
      *
@@ -33,7 +36,8 @@ export declare class Messages extends APIResource {
      */
     list(query: MessageListParams, options?: RequestOptions): PagePromise<MessageListResponsesCursorPage, MessageListResponse>;
     /**
-     * Deletes a message
+     * Permanently delete a message from an experience chat, DM, or group chat channel.
+     * Only the message author or a channel admin can delete a message.
      *
      * Required permissions:
      *
@@ -43,65 +47,74 @@ export declare class Messages extends APIResource {
 }
 export type MessageListResponsesCursorPage = CursorPage<MessageListResponse>;
 /**
- * Represents a message in a DM channel
+ * A message sent within an experience chat, direct message, or group chat.
  */
 export interface MessageListResponse {
     /**
-     * The unique identifier of the resource.
+     * Represents a unique identifier that is Base64 obfuscated. It is often used to
+     * refetch an object or as key for a cache. The ID type appears in a JSON response
+     * as a String; however, it is not intended to be human-readable. When expected as
+     * an input type, any string (such as `"VXNlci0xMA=="`) or integer (such as `4`)
+     * input value will be accepted as an ID.
      */
     id: string;
     /**
-     * The content of the message in Markdown format
+     * The message content formatted as Markdown. Null if the message has no text
+     * content.
      */
     content: string | null;
     /**
-     * The timestamp when the post was created
+     * The timestamp when this message was originally created.
      */
     created_at: string;
     /**
-     * Whether the message has been edited
+     * Whether the message content has been edited after it was originally sent.
      */
     is_edited: boolean;
     /**
-     * Whether this message is pinned
+     * Whether this message is pinned to the top of the channel for easy access.
      */
     is_pinned: boolean;
     /**
-     * The type of post
+     * The classification of this message: regular, system, or automated.
      */
     message_type: Shared.DmsPostTypes;
     /**
-     * The poll for this message
+     * A poll attached to this message. Null if the message does not contain a poll.
      */
     poll: MessageListResponse.Poll | null;
     /**
-     * The reaction counts for this message
+     * Aggregated reaction counts on this message, filtered to a specific reaction
+     * type.
      */
     poll_votes: Array<MessageListResponse.PollVote>;
     /**
-     * The reaction counts for this message
+     * Aggregated reaction counts on this message, filtered to a specific reaction
+     * type.
      */
     reaction_counts: Array<MessageListResponse.ReactionCount>;
     /**
-     * The ID of the message this is replying to, if applicable
+     * The unique identifier of the message this post is replying to. Null if this is
+     * not a reply.
      */
     replying_to_message_id: string | null;
     /**
-     * The timestamp when the post was last updated
+     * The timestamp when this message was last modified.
      */
     updated_at: string;
     /**
-     * The user who sent this message
+     * The user who authored this message.
      */
     user: MessageListResponse.User;
     /**
-     * The number of times this message has been viewed
+     * The number of unique views this message has received. Null if view tracking is
+     * not enabled for this channel.
      */
     view_count: number | null;
 }
 export declare namespace MessageListResponse {
     /**
-     * The poll for this message
+     * A poll attached to this message. Null if the message does not contain a poll.
      */
     interface Poll {
         /**
@@ -115,7 +128,7 @@ export declare namespace MessageListResponse {
          */
         interface Option {
             /**
-             * The ID of the poll option
+             * The unique identifier for the poll option.
              */
             id: string;
             /**
@@ -151,19 +164,19 @@ export declare namespace MessageListResponse {
         emoji: string | null;
     }
     /**
-     * The user who sent this message
+     * The user who authored this message.
      */
     interface User {
         /**
-         * The internal ID of the user.
+         * The unique identifier for the user.
          */
         id: string;
         /**
-         * The name of the user from their Whop account.
+         * The user's display name shown on their public profile.
          */
         name: string | null;
         /**
-         * The username of the user from their Whop account.
+         * The user's unique username shown on their public profile.
          */
         username: string;
     }
@@ -174,23 +187,26 @@ export declare namespace MessageListResponse {
 export type MessageDeleteResponse = boolean;
 export interface MessageCreateParams {
     /**
-     * The ID of the channel or experience to send to.
+     * The unique identifier of the channel or experience to send the message in. For
+     * example, 'exp_xxxxx' or 'feed_xxxxx'.
      */
     channel_id: string;
     /**
-     * The content of the message in Markdown format.
+     * The body of the message in Markdown format. For example, 'Hello **world**'.
      */
     content: string;
     /**
-     * The attachments for this message, such as videos or images.
+     * A list of file attachments to include with the message, such as images or
+     * videos.
      */
     attachments?: Array<MessageCreateParams.Attachment> | null;
     /**
-     * The poll for this message
+     * A poll to attach to this message, allowing recipients to vote on options.
      */
     poll?: MessageCreateParams.Poll | null;
     /**
-     * The ID of the message this is replying to, if applicable.
+     * The unique identifier of the message this is replying to, creating a threaded
+     * reply.
      */
     replying_to_message_id?: string | null;
 }
@@ -205,7 +221,7 @@ export declare namespace MessageCreateParams {
         id: string;
     }
     /**
-     * The poll for this message
+     * A poll to attach to this message, allowing recipients to vote on options.
      */
     interface Poll {
         /**
@@ -231,15 +247,17 @@ export declare namespace MessageCreateParams {
 }
 export interface MessageUpdateParams {
     /**
-     * The attachments for this message
+     * A replacement list of file attachments for this message, such as images or
+     * videos.
      */
     attachments?: Array<MessageUpdateParams.Attachment> | null;
     /**
-     * The content of the message in Markdown format
+     * The updated body of the message in Markdown format. For example, 'Hello
+     * **world**'.
      */
     content?: string | null;
     /**
-     * Whether this message is pinned
+     * Whether this message should be pinned to the top of the channel.
      */
     is_pinned?: boolean | null;
 }
@@ -256,7 +274,7 @@ export declare namespace MessageUpdateParams {
 }
 export interface MessageListParams extends CursorPageParams {
     /**
-     * The ID of the channel or the experience ID to list messages for
+     * The unique identifier of the channel or experience to list messages for.
      */
     channel_id: string;
     /**

package/resources/messages.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"messages.d.ts","sourceRoot":"","sources":["../src/resources/messages.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;OAMG;IACH,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC;IAIvF;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC;IAI1E;;OAEG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC;IAI7B;;;;;;OAMG;IACH,IAAI,CACF,KAAK,EAAE,iBAAiB,EACxB,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,8BAA8B,EAAE,mBAAmB,CAAC;IAInE;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;CAGhF;AAED,MAAM,MAAM,8BAA8B,GAAG,UAAU,CAAC,mBAAmB,CAAC,CAAC;AAE7E;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC,YAAY,CAAC;IAElC;;OAEG;IACH,IAAI,EAAE,mBAAmB,CAAC,IAAI,GAAG,IAAI,CAAC;IAEtC;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC;IAEhD;;OAEG;IACH,eAAe,EAAE,KAAK,CAAC,mBAAmB,CAAC,aAAa,CAAC,CAAC;IAE1D;;OAEG;IACH,sBAAsB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,mBAAmB,CAAC,IAAI,CAAC;IAE/B;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;KACpC;IAED,UAAiB,IAAI,CAAC;QACpB;;WAEG;QACH,UAAiB,MAAM;YACrB;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;SACd;KACF;IAED;;OAEG;IACH,UAAiB,QAAQ;QACvB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;KAC1B;IAED;;OAEG;IACH,UAAiB,aAAa;QAC5B;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;KACtB;IAED;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;KAClB;CACF;AAED;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,OAAO,CAAC;AAE5C,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC;IAE3D;;OAEG;IACH,IAAI,CAAC,EAAE,mBAAmB,CAAC,IAAI,GAAG,IAAI,CAAC;IAEvC;;OAEG;IACH,sBAAsB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxC;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;IAED;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;KAC7B;IAED,UAAiB,IAAI,CAAC;QACpB;;WAEG;QACH,UAAiB,MAAM;YACrB;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;SACd;KACF;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC;IAE3D;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CAC5B;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED,MAAM,WAAW,iBAAkB,SAAQ,gBAAgB;IACzD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}
+{"version":3,"file":"messages.d.ts","sourceRoot":"","sources":["../src/resources/messages.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;OAOG;IACH,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC;IAIvF;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC;IAI1E;;;OAGG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC;IAI7B;;;;;;;OAOG;IACH,IAAI,CACF,KAAK,EAAE,iBAAiB,EACxB,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,8BAA8B,EAAE,mBAAmB,CAAC;IAInE;;;;;;;OAOG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;CAGhF;AAED,MAAM,MAAM,8BAA8B,GAAG,UAAU,CAAC,mBAAmB,CAAC,CAAC;AAE7E;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;;;;OAMG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC,YAAY,CAAC;IAElC;;OAEG;IACH,IAAI,EAAE,mBAAmB,CAAC,IAAI,GAAG,IAAI,CAAC;IAEtC;;;OAGG;IACH,UAAU,EAAE,KAAK,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC;IAEhD;;;OAGG;IACH,eAAe,EAAE,KAAK,CAAC,mBAAmB,CAAC,aAAa,CAAC,CAAC;IAE1D;;;OAGG;IACH,sBAAsB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,mBAAmB,CAAC,IAAI,CAAC;IAE/B;;;OAGG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;KACpC;IAED,UAAiB,IAAI,CAAC;QACpB;;WAEG;QACH,UAAiB,MAAM;YACrB;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;SACd;KACF;IAED;;OAEG;IACH,UAAiB,QAAQ;QACvB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;KAC1B;IAED;;OAEG;IACH,UAAiB,aAAa;QAC5B;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;KACtB;IAED;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;KAClB;CACF;AAED;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,OAAO,CAAC;AAE5C,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC;IAE3D;;OAEG;IACH,IAAI,CAAC,EAAE,mBAAmB,CAAC,IAAI,GAAG,IAAI,CAAC;IAEvC;;;OAGG;IACH,sBAAsB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxC;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;IAED;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;KAC7B;IAED,UAAiB,IAAI,CAAC;QACpB;;WAEG;QACH,UAAiB,MAAM;YACrB;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;SACd;KACF;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC;IAE3D;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CAC5B;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED,MAAM,WAAW,iBAAkB,SAAQ,gBAAgB;IACzD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}

package/resources/messages.js

@@ -7,7 +7,8 @@ const pagination_1 = require("../core/pagination.js");
 const path_1 = require("../internal/utils/path.js");
 class Messages extends resource_1.APIResource {
     /**
-     * Creates a new message
+     * Send a new message in an experience chat, DM, or group chat channel. Supports
+     * text content, attachments, polls, and replies.
      *
      * Required permissions:
      *
@@ -17,7 +18,7 @@ class Messages extends resource_1.APIResource {
         return this._client.post('/messages', { body, ...options });
     }
     /**
-     * Retrieves a message
+     * Retrieves the details of an existing message.
      *
      * Required permissions:
      *
@@ -27,13 +28,15 @@ class Messages extends resource_1.APIResource {
         return this._client.get((0, path_1.path) `/messages/${id}`, options);
     }
     /**
-     * Updates an existing message
+     * Edit the content, attachments, or pinned status of an existing message in an
+     * experience chat, DM, or group chat channel.
      */
     update(id, body = {}, options) {
         return this._client.patch((0, path_1.path) `/messages/${id}`, { body, ...options });
     }
     /**
-     * Lists messages inside a channel
+     * Returns a paginated list of messages within a specific experience chat, DM, or
+     * group chat channel, sorted by creation time.
      *
      * Required permissions:
      *
@@ -43,7 +46,8 @@ class Messages extends resource_1.APIResource {
         return this._client.getAPIList('/messages', (pagination_1.CursorPage), { query, ...options });
     }
     /**
-     * Deletes a message
+     * Permanently delete a message from an experience chat, DM, or group chat channel.
+     * Only the message author or a channel admin can delete a message.
      *
      * Required permissions:
      *

package/resources/messages.js.map

@@ -1 +1 @@
-{"version":3,"file":"messages.js","sourceRoot":"","sources":["../src/resources/messages.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,sDAAoF;AAEpF,oDAA8C;AAE9C,MAAa,QAAS,SAAQ,sBAAW;IACvC;;;;;;OAMG;IACH,MAAM,CAAC,IAAyB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;OAMG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,aAAa,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED;;OAEG;IACH,MAAM,CACJ,EAAU,EACV,OAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,aAAa,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;OAMG;IACH,IAAI,CACF,KAAwB,EACxB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,WAAW,EAAE,CAAA,uBAA+B,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtG,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,aAAa,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;CACF;AA1DD,4BA0DC"}
+{"version":3,"file":"messages.js","sourceRoot":"","sources":["../src/resources/messages.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,sDAAoF;AAEpF,oDAA8C;AAE9C,MAAa,QAAS,SAAQ,sBAAW;IACvC;;;;;;;OAOG;IACH,MAAM,CAAC,IAAyB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;OAMG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,aAAa,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED;;;OAGG;IACH,MAAM,CACJ,EAAU,EACV,OAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,aAAa,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CACF,KAAwB,EACxB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,WAAW,EAAE,CAAA,uBAA+B,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtG,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,aAAa,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;CACF;AA9DD,4BA8DC"}

package/resources/messages.mjs

@@ -4,7 +4,8 @@ import { CursorPage } from "../core/pagination.mjs";
 import { path } from "../internal/utils/path.mjs";
 export class Messages extends APIResource {
     /**
-     * Creates a new message
+     * Send a new message in an experience chat, DM, or group chat channel. Supports
+     * text content, attachments, polls, and replies.
      *
      * Required permissions:
      *
@@ -14,7 +15,7 @@ export class Messages extends APIResource {
         return this._client.post('/messages', { body, ...options });
     }
     /**
-     * Retrieves a message
+     * Retrieves the details of an existing message.
      *
      * Required permissions:
      *
@@ -24,13 +25,15 @@ export class Messages extends APIResource {
         return this._client.get(path `/messages/${id}`, options);
     }
     /**
-     * Updates an existing message
+     * Edit the content, attachments, or pinned status of an existing message in an
+     * experience chat, DM, or group chat channel.
      */
     update(id, body = {}, options) {
         return this._client.patch(path `/messages/${id}`, { body, ...options });
     }
     /**
-     * Lists messages inside a channel
+     * Returns a paginated list of messages within a specific experience chat, DM, or
+     * group chat channel, sorted by creation time.
      *
      * Required permissions:
      *
@@ -40,7 +43,8 @@ export class Messages extends APIResource {
         return this._client.getAPIList('/messages', (CursorPage), { query, ...options });
     }
     /**
-     * Deletes a message
+     * Permanently delete a message from an experience chat, DM, or group chat channel.
+     * Only the message author or a channel admin can delete a message.
      *
      * Required permissions:
      *

package/resources/messages.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"messages.mjs","sourceRoot":"","sources":["../src/resources/messages.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,UAAU,EAAsC;OAElD,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC;;;;;;OAMG;IACH,MAAM,CAAC,IAAyB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;OAMG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED;;OAEG;IACH,MAAM,CACJ,EAAU,EACV,OAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,aAAa,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;OAMG;IACH,IAAI,CACF,KAAwB,EACxB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,WAAW,EAAE,CAAA,UAA+B,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtG,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,aAAa,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;CACF"}
+{"version":3,"file":"messages.mjs","sourceRoot":"","sources":["../src/resources/messages.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,UAAU,EAAsC;OAElD,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC;;;;;;;OAOG;IACH,MAAM,CAAC,IAAyB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;OAMG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED;;;OAGG;IACH,MAAM,CACJ,EAAU,EACV,OAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,aAAa,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CACF,KAAwB,EACxB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,WAAW,EAAE,CAAA,UAA+B,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtG,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,aAAa,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;CACF"}