@whop/sdk 0.0.26 → 0.0.28

package/resources/forum-posts.d.mts

@@ -5,7 +5,9 @@ import { CursorPage, type CursorPageParams, PagePromise } from "../core/paginati
 import { RequestOptions } from "../internal/request-options.mjs";
 export declare class ForumPosts extends APIResource {
     /**
-     * Create a new forum post
+     * Create a new forum post or comment within an experience. Supports text content,
+     * attachments, polls, paywalling, and pinning. Pass experience_id 'public' with a
+     * company_id to post to a company's public forum.
      *
      * Required permissions:
      *
@@ -20,7 +22,7 @@ export declare class ForumPosts extends APIResource {
      */
     create(body: ForumPostCreateParams, options?: RequestOptions): APIPromise<Shared.ForumPost>;
     /**
-     * Retrieves a forum post by ID
+     * Retrieves the details of an existing forum post.
      *
      * Required permissions:
      *
@@ -33,7 +35,8 @@ export declare class ForumPosts extends APIResource {
      */
     retrieve(id: string, options?: RequestOptions): APIPromise<Shared.ForumPost>;
     /**
-     * Update an existing forum post
+     * Edit the content, attachments, pinned status, or visibility of an existing forum
+     * post or comment.
      *
      * @example
      * ```ts
@@ -42,7 +45,8 @@ export declare class ForumPosts extends APIResource {
      */
     update(id: string, body?: ForumPostUpdateParams | null | undefined, options?: RequestOptions): APIPromise<Shared.ForumPost>;
     /**
-     * Lists forum posts
+     * Returns a paginated list of forum posts within a specific experience, with
+     * optional filtering by parent post or pinned status.
      *
      * Required permissions:
      *
@@ -66,109 +70,122 @@ export type ForumPostListResponsesCursorPage = CursorPage<ForumPostListResponse>
  */
 export type ForumPostVisibilityType = 'members_only' | 'globally_visible';
 /**
- * Represents a post in forum
+ * A post or comment in a forum feed, supporting rich text, attachments, polls, and
+ * reactions.
  */
 export interface ForumPostListResponse {
     /**
-     * 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 amount of comments on this post
+     * The total number of direct comments on this post.
      */
     comment_count: number;
     /**
-     * The content of the forum post in Markdown format
+     * The body of the forum post in Markdown format. Null if the post is paywalled and
+     * the current user does not have access.
      */
     content: string | null;
     /**
-     * The timestamp when the post was created
+     * The time this post was created, as a Unix timestamp.
      */
     created_at: string;
     /**
-     * Whether the forum post has been edited
+     * Whether this post has been edited after its initial creation.
      */
     is_edited: boolean;
     /**
-     * Whether this forum post is pinned
+     * Whether this post is pinned to the top of the forum feed.
      */
     is_pinned: boolean;
     /**
-     * Whether the user that sent the post is an admin of the company
+     * Whether the author of this post is an admin of the company that owns the forum.
      */
     is_poster_admin: boolean;
     /**
-     * The number of likes this post has received
+     * The total number of like reactions this post has received.
      */
     like_count: number | null;
     /**
-     * The ID of the parent forum post, if applicable
+     * The unique identifier of the parent post. Null if this is a top-level post.
      */
     parent_id: string | null;
     /**
-     * The title of the forum post
+     * The headline of the forum post. Null if the post has no title.
      */
     title: string | null;
     /**
-     * The timestamp when the post was last updated
+     * The time this post was last updated, as a Unix timestamp.
      */
     updated_at: string;
     /**
-     * The user who created this forum post
+     * The user who authored this forum post.
      */
     user: ForumPostListResponse.User;
     /**
-     * The number of times this message has been viewed
+     * The total number of times this post has been viewed by users.
      */
     view_count: number | null;
 }
 export declare namespace ForumPostListResponse {
     /**
-     * The user who created this forum post
+     * The user who authored this forum post.
      */
     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;
     }
 }
 export interface ForumPostCreateParams {
     /**
-     * The experience to create this post in
+     * The unique identifier of the experience to create this post in. For example,
+     * 'exp_xxxxx'. Pass 'public' along with company_id to automatically use the
+     * company's public forum.
      */
     experience_id: string;
     /**
-     * The attachments for this post
+     * A list of file attachments to include with the post, such as images or videos.
      */
     attachments?: Array<ForumPostCreateParams.Attachment> | null;
     /**
-     * This is the main body of the post in Markdown format. Hidden if paywalled and
-     * user hasn't purchased access to it.
+     * The unique identifier of the company whose public forum to post in. Required
+     * when experience_id is 'public'. For example, 'biz_xxxxx'.
+     */
+    company_id?: string | null;
+    /**
+     * The main body of the post in Markdown format. For example, 'Check out this
+     * **update**'. Hidden if the post is paywalled and the viewer has not purchased
+     * access.
      */
     content?: string | null;
     /**
-     * This is used to determine if the post should be sent as a 'mention' notification
-     * to all of the users who are in the experience. This means that anyone with
-     * 'mentions' enabled will receive a notification about this post.
+     * Whether to send this post as a mention notification to all users in the
+     * experience who have mentions enabled.
      */
     is_mention?: boolean | null;
     /**
-     * The ID of the parent post. Set it to the ID of the post you want to comment on
-     * or don't include it if its a top level post.
+     * The unique identifier of the parent post to comment on. Omit this field to
+     * create a top-level post.
      */
     parent_id?: string | null;
     /**
-     * The amount to paywall this post by. A paywalled post requires the user to
-     * purchase it in order to view its content.
+     * The price to unlock this post in the specified paywall currency. For example,
+     * 5.00 for $5.00. When set, users must purchase access to view the post content.
      */
     paywall_amount?: number | null;
     /**
@@ -176,15 +193,16 @@ export interface ForumPostCreateParams {
      */
     paywall_currency?: Shared.Currency | null;
     /**
-     * Whether the post should be pinned
+     * Whether this post should be pinned to the top of the forum.
      */
     pinned?: boolean | null;
     /**
-     * The poll for this post
+     * A poll to attach to this post, allowing members to vote on options.
      */
     poll?: ForumPostCreateParams.Poll | null;
     /**
-     * The title of the post. Only visible if paywalled.
+     * The title of the post, displayed prominently at the top. Required for paywalled
+     * posts as it remains visible to non-purchasers.
      */
     title?: string | null;
     /**
@@ -203,7 +221,7 @@ export declare namespace ForumPostCreateParams {
         id: string;
     }
     /**
-     * The poll for this post
+     * A poll to attach to this post, allowing members to vote on options.
      */
     interface Poll {
         /**
@@ -229,20 +247,23 @@ export declare namespace ForumPostCreateParams {
 }
 export interface ForumPostUpdateParams {
     /**
-     * The attachments for this post
+     * A replacement list of file attachments for this post, such as images or videos.
      */
     attachments?: Array<ForumPostUpdateParams.Attachment> | null;
     /**
-     * This is the main body of the post in Markdown format. Hidden if paywalled and
-     * user hasn't purchased access to it.
+     * The updated body of the post in Markdown format. For example, 'Check out this
+     * **update**'. Hidden if the post is paywalled and the viewer has not purchased
+     * access.
      */
     content?: string | null;
     /**
-     * Whether the post is pinned. You can only pin a top level posts (not comments).
+     * Whether this post should be pinned to the top of the forum. Only top-level posts
+     * can be pinned, not comments.
      */
     is_pinned?: boolean | null;
     /**
-     * The title of the post. Only visible if paywalled.
+     * The updated title of the post, displayed prominently at the top. Required for
+     * paywalled posts as it remains visible to non-purchasers.
      */
     title?: string | null;
     /**
@@ -263,7 +284,7 @@ export declare namespace ForumPostUpdateParams {
 }
 export interface ForumPostListParams extends CursorPageParams {
     /**
-     * The ID of the experience to list forum posts for
+     * The unique identifier of the experience to list forum posts for.
      */
     experience_id: string;
     /**
@@ -279,11 +300,13 @@ export interface ForumPostListParams extends CursorPageParams {
      */
     last?: number | null;
     /**
-     * The ID of the parent post to list forum post comments for
+     * The unique identifier of a parent post to list comments for. When set, returns
+     * replies to that post.
      */
     parent_id?: string | null;
     /**
-     * Set to true to only return pinned posts
+     * Whether to filter for only pinned posts. Set to true to return only pinned
+     * posts.
      */
     pinned?: boolean | null;
 }

package/resources/forum-posts.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"forum-posts.d.mts","sourceRoot":"","sources":["../src/resources/forum-posts.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,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAAI,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,SAAS,CAAC;IAI3F;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,SAAS,CAAC;IAI5E;;;;;;;OAOG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC,SAAS,CAAC;IAI/B;;;;;;;;;;;;;;;;OAgBG;IACH,IAAI,CACF,KAAK,EAAE,mBAAmB,EAC1B,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,gCAAgC,EAAE,qBAAqB,CAAC;CAGxE;AAED,MAAM,MAAM,gCAAgC,GAAG,UAAU,CAAC,qBAAqB,CAAC,CAAC;AAEjF;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,cAAc,GAAG,kBAAkB,CAAC;AAE1E;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;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,eAAe,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,qBAAqB,CAAC,IAAI,CAAC;IAEjC;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;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,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,qBAAqB,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC;IAE7D;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;;;OAIG;IACH,UAAU,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE5B;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC;IAE1C;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,IAAI,CAAC,EAAE,qBAAqB,CAAC,IAAI,GAAG,IAAI,CAAC;IAEzC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,UAAU,CAAC,EAAE,uBAAuB,GAAG,IAAI,CAAC;CAC7C;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;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,qBAAqB;IACpC;;OAEG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,qBAAqB,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC;IAE7D;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,UAAU,CAAC,EAAE,uBAAuB,GAAG,IAAI,CAAC;CAC7C;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED,MAAM,WAAW,mBAAoB,SAAQ,gBAAgB;IAC3D;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CACzB;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}
+{"version":3,"file":"forum-posts.d.mts","sourceRoot":"","sources":["../src/resources/forum-posts.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,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,IAAI,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,SAAS,CAAC;IAI3F;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,SAAS,CAAC;IAI5E;;;;;;;;OAQG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC,SAAS,CAAC;IAI/B;;;;;;;;;;;;;;;;;OAiBG;IACH,IAAI,CACF,KAAK,EAAE,mBAAmB,EAC1B,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,gCAAgC,EAAE,qBAAqB,CAAC;CAGxE;AAED,MAAM,MAAM,gCAAgC,GAAG,UAAU,CAAC,qBAAqB,CAAC,CAAC;AAEjF;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,cAAc,GAAG,kBAAkB,CAAC;AAE1E;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC;;;;;;OAMG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;;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,eAAe,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,qBAAqB,CAAC,IAAI,CAAC;IAEjC;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;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,MAAM,WAAW,qBAAqB;IACpC;;;;OAIG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,qBAAqB,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC;IAE7D;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE5B;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC;IAE1C;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,IAAI,CAAC,EAAE,qBAAqB,CAAC,IAAI,GAAG,IAAI,CAAC;IAEzC;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,UAAU,CAAC,EAAE,uBAAuB,GAAG,IAAI,CAAC;CAC7C;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;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,qBAAqB;IACpC;;OAEG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,qBAAqB,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC;IAE7D;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE3B;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,UAAU,CAAC,EAAE,uBAAuB,GAAG,IAAI,CAAC;CAC7C;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED,MAAM,WAAW,mBAAoB,SAAQ,gBAAgB;IAC3D;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CACzB;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}

package/resources/forum-posts.d.ts

@@ -5,7 +5,9 @@ import { CursorPage, type CursorPageParams, PagePromise } from "../core/paginati
 import { RequestOptions } from "../internal/request-options.js";
 export declare class ForumPosts extends APIResource {
     /**
-     * Create a new forum post
+     * Create a new forum post or comment within an experience. Supports text content,
+     * attachments, polls, paywalling, and pinning. Pass experience_id 'public' with a
+     * company_id to post to a company's public forum.
      *
      * Required permissions:
      *
@@ -20,7 +22,7 @@ export declare class ForumPosts extends APIResource {
      */
     create(body: ForumPostCreateParams, options?: RequestOptions): APIPromise<Shared.ForumPost>;
     /**
-     * Retrieves a forum post by ID
+     * Retrieves the details of an existing forum post.
      *
      * Required permissions:
      *
@@ -33,7 +35,8 @@ export declare class ForumPosts extends APIResource {
      */
     retrieve(id: string, options?: RequestOptions): APIPromise<Shared.ForumPost>;
     /**
-     * Update an existing forum post
+     * Edit the content, attachments, pinned status, or visibility of an existing forum
+     * post or comment.
      *
      * @example
      * ```ts
@@ -42,7 +45,8 @@ export declare class ForumPosts extends APIResource {
      */
     update(id: string, body?: ForumPostUpdateParams | null | undefined, options?: RequestOptions): APIPromise<Shared.ForumPost>;
     /**
-     * Lists forum posts
+     * Returns a paginated list of forum posts within a specific experience, with
+     * optional filtering by parent post or pinned status.
      *
      * Required permissions:
      *
@@ -66,109 +70,122 @@ export type ForumPostListResponsesCursorPage = CursorPage<ForumPostListResponse>
  */
 export type ForumPostVisibilityType = 'members_only' | 'globally_visible';
 /**
- * Represents a post in forum
+ * A post or comment in a forum feed, supporting rich text, attachments, polls, and
+ * reactions.
  */
 export interface ForumPostListResponse {
     /**
-     * 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 amount of comments on this post
+     * The total number of direct comments on this post.
      */
     comment_count: number;
     /**
-     * The content of the forum post in Markdown format
+     * The body of the forum post in Markdown format. Null if the post is paywalled and
+     * the current user does not have access.
      */
     content: string | null;
     /**
-     * The timestamp when the post was created
+     * The time this post was created, as a Unix timestamp.
      */
     created_at: string;
     /**
-     * Whether the forum post has been edited
+     * Whether this post has been edited after its initial creation.
      */
     is_edited: boolean;
     /**
-     * Whether this forum post is pinned
+     * Whether this post is pinned to the top of the forum feed.
      */
     is_pinned: boolean;
     /**
-     * Whether the user that sent the post is an admin of the company
+     * Whether the author of this post is an admin of the company that owns the forum.
      */
     is_poster_admin: boolean;
     /**
-     * The number of likes this post has received
+     * The total number of like reactions this post has received.
      */
     like_count: number | null;
     /**
-     * The ID of the parent forum post, if applicable
+     * The unique identifier of the parent post. Null if this is a top-level post.
      */
     parent_id: string | null;
     /**
-     * The title of the forum post
+     * The headline of the forum post. Null if the post has no title.
      */
     title: string | null;
     /**
-     * The timestamp when the post was last updated
+     * The time this post was last updated, as a Unix timestamp.
      */
     updated_at: string;
     /**
-     * The user who created this forum post
+     * The user who authored this forum post.
      */
     user: ForumPostListResponse.User;
     /**
-     * The number of times this message has been viewed
+     * The total number of times this post has been viewed by users.
      */
     view_count: number | null;
 }
 export declare namespace ForumPostListResponse {
     /**
-     * The user who created this forum post
+     * The user who authored this forum post.
      */
     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;
     }
 }
 export interface ForumPostCreateParams {
     /**
-     * The experience to create this post in
+     * The unique identifier of the experience to create this post in. For example,
+     * 'exp_xxxxx'. Pass 'public' along with company_id to automatically use the
+     * company's public forum.
      */
     experience_id: string;
     /**
-     * The attachments for this post
+     * A list of file attachments to include with the post, such as images or videos.
      */
     attachments?: Array<ForumPostCreateParams.Attachment> | null;
     /**
-     * This is the main body of the post in Markdown format. Hidden if paywalled and
-     * user hasn't purchased access to it.
+     * The unique identifier of the company whose public forum to post in. Required
+     * when experience_id is 'public'. For example, 'biz_xxxxx'.
+     */
+    company_id?: string | null;
+    /**
+     * The main body of the post in Markdown format. For example, 'Check out this
+     * **update**'. Hidden if the post is paywalled and the viewer has not purchased
+     * access.
      */
     content?: string | null;
     /**
-     * This is used to determine if the post should be sent as a 'mention' notification
-     * to all of the users who are in the experience. This means that anyone with
-     * 'mentions' enabled will receive a notification about this post.
+     * Whether to send this post as a mention notification to all users in the
+     * experience who have mentions enabled.
      */
     is_mention?: boolean | null;
     /**
-     * The ID of the parent post. Set it to the ID of the post you want to comment on
-     * or don't include it if its a top level post.
+     * The unique identifier of the parent post to comment on. Omit this field to
+     * create a top-level post.
      */
     parent_id?: string | null;
     /**
-     * The amount to paywall this post by. A paywalled post requires the user to
-     * purchase it in order to view its content.
+     * The price to unlock this post in the specified paywall currency. For example,
+     * 5.00 for $5.00. When set, users must purchase access to view the post content.
      */
     paywall_amount?: number | null;
     /**
@@ -176,15 +193,16 @@ export interface ForumPostCreateParams {
      */
     paywall_currency?: Shared.Currency | null;
     /**
-     * Whether the post should be pinned
+     * Whether this post should be pinned to the top of the forum.
      */
     pinned?: boolean | null;
     /**
-     * The poll for this post
+     * A poll to attach to this post, allowing members to vote on options.
      */
     poll?: ForumPostCreateParams.Poll | null;
     /**
-     * The title of the post. Only visible if paywalled.
+     * The title of the post, displayed prominently at the top. Required for paywalled
+     * posts as it remains visible to non-purchasers.
      */
     title?: string | null;
     /**
@@ -203,7 +221,7 @@ export declare namespace ForumPostCreateParams {
         id: string;
     }
     /**
-     * The poll for this post
+     * A poll to attach to this post, allowing members to vote on options.
      */
     interface Poll {
         /**
@@ -229,20 +247,23 @@ export declare namespace ForumPostCreateParams {
 }
 export interface ForumPostUpdateParams {
     /**
-     * The attachments for this post
+     * A replacement list of file attachments for this post, such as images or videos.
      */
     attachments?: Array<ForumPostUpdateParams.Attachment> | null;
     /**
-     * This is the main body of the post in Markdown format. Hidden if paywalled and
-     * user hasn't purchased access to it.
+     * The updated body of the post in Markdown format. For example, 'Check out this
+     * **update**'. Hidden if the post is paywalled and the viewer has not purchased
+     * access.
      */
     content?: string | null;
     /**
-     * Whether the post is pinned. You can only pin a top level posts (not comments).
+     * Whether this post should be pinned to the top of the forum. Only top-level posts
+     * can be pinned, not comments.
      */
     is_pinned?: boolean | null;
     /**
-     * The title of the post. Only visible if paywalled.
+     * The updated title of the post, displayed prominently at the top. Required for
+     * paywalled posts as it remains visible to non-purchasers.
      */
     title?: string | null;
     /**
@@ -263,7 +284,7 @@ export declare namespace ForumPostUpdateParams {
 }
 export interface ForumPostListParams extends CursorPageParams {
     /**
-     * The ID of the experience to list forum posts for
+     * The unique identifier of the experience to list forum posts for.
      */
     experience_id: string;
     /**
@@ -279,11 +300,13 @@ export interface ForumPostListParams extends CursorPageParams {
      */
     last?: number | null;
     /**
-     * The ID of the parent post to list forum post comments for
+     * The unique identifier of a parent post to list comments for. When set, returns
+     * replies to that post.
      */
     parent_id?: string | null;
     /**
-     * Set to true to only return pinned posts
+     * Whether to filter for only pinned posts. Set to true to return only pinned
+     * posts.
      */
     pinned?: boolean | null;
 }

package/resources/forum-posts.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"forum-posts.d.ts","sourceRoot":"","sources":["../src/resources/forum-posts.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,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAAI,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,SAAS,CAAC;IAI3F;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,SAAS,CAAC;IAI5E;;;;;;;OAOG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC,SAAS,CAAC;IAI/B;;;;;;;;;;;;;;;;OAgBG;IACH,IAAI,CACF,KAAK,EAAE,mBAAmB,EAC1B,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,gCAAgC,EAAE,qBAAqB,CAAC;CAGxE;AAED,MAAM,MAAM,gCAAgC,GAAG,UAAU,CAAC,qBAAqB,CAAC,CAAC;AAEjF;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,cAAc,GAAG,kBAAkB,CAAC;AAE1E;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;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,eAAe,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,qBAAqB,CAAC,IAAI,CAAC;IAEjC;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;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,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,qBAAqB,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC;IAE7D;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;;;OAIG;IACH,UAAU,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE5B;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC;IAE1C;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,IAAI,CAAC,EAAE,qBAAqB,CAAC,IAAI,GAAG,IAAI,CAAC;IAEzC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,UAAU,CAAC,EAAE,uBAAuB,GAAG,IAAI,CAAC;CAC7C;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;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,qBAAqB;IACpC;;OAEG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,qBAAqB,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC;IAE7D;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,UAAU,CAAC,EAAE,uBAAuB,GAAG,IAAI,CAAC;CAC7C;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED,MAAM,WAAW,mBAAoB,SAAQ,gBAAgB;IAC3D;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CACzB;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}
+{"version":3,"file":"forum-posts.d.ts","sourceRoot":"","sources":["../src/resources/forum-posts.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,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,IAAI,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,SAAS,CAAC;IAI3F;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,SAAS,CAAC;IAI5E;;;;;;;;OAQG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC,SAAS,CAAC;IAI/B;;;;;;;;;;;;;;;;;OAiBG;IACH,IAAI,CACF,KAAK,EAAE,mBAAmB,EAC1B,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,gCAAgC,EAAE,qBAAqB,CAAC;CAGxE;AAED,MAAM,MAAM,gCAAgC,GAAG,UAAU,CAAC,qBAAqB,CAAC,CAAC;AAEjF;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,cAAc,GAAG,kBAAkB,CAAC;AAE1E;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC;;;;;;OAMG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;;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,eAAe,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,qBAAqB,CAAC,IAAI,CAAC;IAEjC;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;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,MAAM,WAAW,qBAAqB;IACpC;;;;OAIG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,qBAAqB,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC;IAE7D;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE5B;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC;IAE1C;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,IAAI,CAAC,EAAE,qBAAqB,CAAC,IAAI,GAAG,IAAI,CAAC;IAEzC;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,UAAU,CAAC,EAAE,uBAAuB,GAAG,IAAI,CAAC;CAC7C;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;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,qBAAqB;IACpC;;OAEG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,qBAAqB,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC;IAE7D;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE3B;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,UAAU,CAAC,EAAE,uBAAuB,GAAG,IAAI,CAAC;CAC7C;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED,MAAM,WAAW,mBAAoB,SAAQ,gBAAgB;IAC3D;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CACzB;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}

package/resources/forum-posts.js

@@ -7,7 +7,9 @@ const pagination_1 = require("../core/pagination.js");
 const path_1 = require("../internal/utils/path.js");
 class ForumPosts extends resource_1.APIResource {
     /**
-     * Create a new forum post
+     * Create a new forum post or comment within an experience. Supports text content,
+     * attachments, polls, paywalling, and pinning. Pass experience_id 'public' with a
+     * company_id to post to a company's public forum.
      *
      * Required permissions:
      *
@@ -24,7 +26,7 @@ class ForumPosts extends resource_1.APIResource {
         return this._client.post('/forum_posts', { body, ...options });
     }
     /**
-     * Retrieves a forum post by ID
+     * Retrieves the details of an existing forum post.
      *
      * Required permissions:
      *
@@ -39,7 +41,8 @@ class ForumPosts extends resource_1.APIResource {
         return this._client.get((0, path_1.path) `/forum_posts/${id}`, options);
     }
     /**
-     * Update an existing forum post
+     * Edit the content, attachments, pinned status, or visibility of an existing forum
+     * post or comment.
      *
      * @example
      * ```ts
@@ -50,7 +53,8 @@ class ForumPosts extends resource_1.APIResource {
         return this._client.patch((0, path_1.path) `/forum_posts/${id}`, { body, ...options });
     }
     /**
-     * Lists forum posts
+     * Returns a paginated list of forum posts within a specific experience, with
+     * optional filtering by parent post or pinned status.
      *
      * Required permissions:
      *

package/resources/forum-posts.js.map

@@ -1 +1 @@
-{"version":3,"file":"forum-posts.js","sourceRoot":"","sources":["../src/resources/forum-posts.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,sDAAoF;AAEpF,oDAA8C;AAE9C,MAAa,UAAW,SAAQ,sBAAW;IACzC;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAA2B,EAAE,OAAwB;QAC1D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,gBAAgB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CACJ,EAAU,EACV,OAAiD,EAAE,EACnD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,gBAAgB,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,IAAI,CACF,KAA0B,EAC1B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,cAAc,EAAE,CAAA,uBAAiC,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3G,CAAC;CACF;AA1ED,gCA0EC"}
+{"version":3,"file":"forum-posts.js","sourceRoot":"","sources":["../src/resources/forum-posts.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,sDAAoF;AAEpF,oDAA8C;AAE9C,MAAa,UAAW,SAAQ,sBAAW;IACzC;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,IAA2B,EAAE,OAAwB;QAC1D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,gBAAgB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CACJ,EAAU,EACV,OAAiD,EAAE,EACnD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,gBAAgB,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,IAAI,CACF,KAA0B,EAC1B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,cAAc,EAAE,CAAA,uBAAiC,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3G,CAAC;CACF;AA9ED,gCA8EC"}