@whop/sdk 0.0.27 → 0.0.28

package/src/resources/forum-posts.ts

@@ -9,7 +9,9 @@ import { path } from '../internal/utils/path';
 
 export 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:
    *
@@ -27,7 +29,7 @@ export class ForumPosts extends APIResource {
   }
 
   /**
-   * Retrieves a forum post by ID
+   * Retrieves the details of an existing forum post.
    *
    * Required permissions:
    *
@@ -43,7 +45,8 @@ export class ForumPosts extends APIResource {
   }
 
   /**
-   * Update an existing forum post
+   * Edit the content, attachments, pinned status, or visibility of an existing forum
+   * post or comment.
    *
    * @example
    * ```ts
@@ -59,7 +62,8 @@ export class ForumPosts extends APIResource {
   }
 
   /**
-   * 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:
    *
@@ -91,7 +95,8 @@ 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 {
   /**
@@ -104,69 +109,70 @@ export interface ForumPostListResponse {
   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 namespace ForumPostListResponse {
   /**
-   * The user who created this forum post
+   * The user who authored this forum post.
    */
   export interface User {
     /**
@@ -175,12 +181,12 @@ export namespace ForumPostListResponse {
     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;
   }
@@ -188,37 +194,45 @@ export namespace ForumPostListResponse {
 
 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 price in paywall_currency to unlock this post (e.g., 5.00 for $5.00). If
-   * set, users must purchase access to view the post 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;
 
@@ -228,17 +242,18 @@ 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;
 
@@ -260,7 +275,7 @@ export namespace ForumPostCreateParams {
   }
 
   /**
-   * The poll for this post
+   * A poll to attach to this post, allowing members to vote on options.
    */
   export interface Poll {
     /**
@@ -289,23 +304,26 @@ export 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;
 
@@ -329,7 +347,7 @@ export 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;
 
@@ -349,12 +367,14 @@ 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/src/resources/forums.ts

@@ -9,7 +9,7 @@ import { path } from '../internal/utils/path';
 
 export class Forums extends APIResource {
   /**
-   * Retrieves a forum
+   * Retrieves the details of an existing forum.
    *
    * Required permissions:
    *
@@ -20,7 +20,8 @@ export class Forums extends APIResource {
   }
 
   /**
-   * Updates a forum
+   * Update moderation and notification settings for a forum, such as who can post,
+   * who can comment, and email notification preferences.
    *
    * Required permissions:
    *
@@ -35,7 +36,8 @@ export class Forums extends APIResource {
   }
 
   /**
-   * Lists forums inside a company
+   * Returns a paginated list of forums within a specific company, with optional
+   * filtering by product.
    *
    * Required permissions:
    *
@@ -52,7 +54,8 @@ export class Forums extends APIResource {
 export type ForumListResponsesCursorPage = CursorPage<ForumListResponse>;
 
 /**
- * Represents a forum feed
+ * A discussion forum where members can create posts, comment, and react, belonging
+ * to an experience.
  */
 export interface ForumListResponse {
   /**
@@ -61,29 +64,32 @@ export interface ForumListResponse {
   id: string;
 
   /**
-   * The email notification preference for this forum
+   * The email notification setting that controls which posts trigger email alerts.
+   * One of: all_admin_posts, only_weekly_summary, none.
    */
   email_notification_preference: Shared.EmailNotificationPreferences;
 
   /**
-   * The experience for this forum
+   * The parent experience that this forum belongs to.
    */
   experience: ForumListResponse.Experience;
 
   /**
-   * Who can comment on this forum
+   * The permission level controlling who can comment on posts. One of: everyone,
+   * admins.
    */
   who_can_comment: Shared.WhoCanCommentTypes;
 
   /**
-   * Who can post on this forum
+   * The permission level controlling who can create new posts. One of: everyone,
+   * admins.
    */
   who_can_post: Shared.WhoCanPostTypes;
 }
 
 export namespace ForumListResponse {
   /**
-   * The experience for this forum
+   * The parent experience that this forum belongs to.
    */
   export interface Experience {
     /**
@@ -92,7 +98,8 @@ export namespace ForumListResponse {
     id: string;
 
     /**
-     * The written name of the description.
+     * The display name of this experience shown to users in the product navigation.
+     * Maximum 255 characters.
      */
     name: string;
   }
@@ -117,7 +124,7 @@ export interface ForumUpdateParams {
 
 export interface ForumListParams extends CursorPageParams {
   /**
-   * The ID of the company to list forums for
+   * The unique identifier of the company to list forums for.
    */
   company_id: string;
 
@@ -137,7 +144,8 @@ export interface ForumListParams extends CursorPageParams {
   last?: number | null;
 
   /**
-   * If provided, only forums connected to this product are returned
+   * The unique identifier of a product to filter by. When set, only forums connected
+   * to this product are returned.
    */
   product_id?: string | null;
 }

package/src/resources/index.ts

@@ -61,8 +61,8 @@ export {
 } from './companies';
 export {
   CompanyTokenTransactions,
-  type BotTokenTransactionTypes,
   type CompanyTokenTransaction,
+  type CompanyTokenTransactionType,
   type CompanyTokenTransactionListResponse,
   type CompanyTokenTransactionCreateParams,
   type CompanyTokenTransactionListParams,
@@ -290,6 +290,7 @@ export {
 } from './plans';
 export {
   Products,
+  type IndustryGroups,
   type ProductDeleteResponse,
   type ProductCreateParams,
   type ProductUpdateParams,