@whop/sdk 0.0.26 → 0.0.28

package/src/resources/dm-channels.ts

@@ -8,7 +8,8 @@ import { path } from '../internal/utils/path';
 
 export class DmChannels extends APIResource {
   /**
-   * Creates a DM channel
+   * Create a new DM channel between two or more users, optionally scoped to a
+   * specific company. Returns the existing channel if one already exists.
    *
    * @example
    * ```ts
@@ -22,7 +23,7 @@ export class DmChannels extends APIResource {
   }
 
   /**
-   * Retrieves a DM channel
+   * Retrieves the details of an existing DM channel.
    *
    * Required permissions:
    *
@@ -38,7 +39,8 @@ export class DmChannels extends APIResource {
   }
 
   /**
-   * Updates a DM channel
+   * Update the settings of an existing DM channel, such as its display name. Only an
+   * admin of the channel can perform this action.
    *
    * Required permissions:
    *
@@ -58,7 +60,8 @@ export class DmChannels extends APIResource {
   }
 
   /**
-   * Lists DM channels for the current user
+   * Returns a paginated list of DM channels for the currently authenticated user,
+   * sorted by most recently active.
    *
    * Required permissions:
    *
@@ -80,7 +83,8 @@ export class DmChannels extends APIResource {
   }
 
   /**
-   * Deletes a DM channel
+   * Permanently delete a DM channel and all of its messages. Only an admin of the
+   * channel can perform this action.
    *
    * Required permissions:
    *
@@ -99,7 +103,8 @@ export class DmChannels extends APIResource {
 export type DmChannelListResponsesCursorPage = CursorPage<DmChannelListResponse>;
 
 /**
- * Represents a DM channel
+ * A messaging channel that can be a one-on-one DM, group chat, company support
+ * conversation, or platform-level direct message.
  */
 export interface DmChannel {
   /**
@@ -113,18 +118,21 @@ export interface DmChannel {
   created_at: string;
 
   /**
-   * When the last message was sent
+   * The timestamp when the most recent message was sent in this channel. Null if no
+   * messages have been sent.
    */
   last_message_at: string | null;
 
   /**
-   * The custom name of the DM channel, if any
+   * A custom display name assigned to this channel by the user. Null if no custom
+   * name has been set.
    */
   name: string | null;
 }
 
 /**
- * Represents a DM channel
+ * A messaging channel that can be a one-on-one DM, group chat, company support
+ * conversation, or platform-level direct message.
  */
 export interface DmChannelListResponse {
   /**
@@ -138,12 +146,14 @@ export interface DmChannelListResponse {
   created_at: string;
 
   /**
-   * When the last message was sent
+   * The timestamp when the most recent message was sent in this channel. Null if no
+   * messages have been sent.
    */
   last_message_at: string | null;
 
   /**
-   * The custom name of the DM channel, if any
+   * A custom display name assigned to this channel by the user. Null if no custom
+   * name has been set.
    */
   name: string | null;
 }
@@ -155,24 +165,26 @@ export type DmChannelDeleteResponse = boolean;
 
 export interface DmChannelCreateParams {
   /**
-   * The user ids to create a DM with. Can be email, username or user_id (tag)
+   * The list of user identifiers to include in the DM channel. Each entry can be an
+   * email, username, or user ID (e.g. 'user_xxxxx').
    */
   with_user_ids: Array<string>;
 
   /**
-   * The ID of the company to scope this DM channel to.
+   * The unique identifier of the company to scope this DM channel to. When set, the
+   * channel is visible only within that company context.
    */
   company_id?: string | null;
 
   /**
-   * The custom name for the DM channel
+   * A custom display name for the DM channel. For example, 'Project Discussion'.
    */
   custom_name?: string | null;
 }
 
 export interface DmChannelUpdateParams {
   /**
-   * The custom name for the DM channel
+   * A new custom display name for the DM channel. For example, 'Project Discussion'.
    */
   custom_name?: string | null;
 }
@@ -184,7 +196,8 @@ export interface DmChannelListParams extends CursorPageParams {
   before?: string | null;
 
   /**
-   * Filter DM channels scoped to a specific company
+   * The unique identifier of a company to filter DM channels by. Only returns
+   * channels scoped to this company.
    */
   company_id?: string | null;
 

package/src/resources/dm-members.ts

@@ -8,7 +8,8 @@ import { path } from '../internal/utils/path';
 
 export class DmMembers extends APIResource {
   /**
-   * Adds a user to a DM channel
+   * Add a new user to an existing DM channel. Only an admin of the channel can add
+   * members.
    *
    * Required permissions:
    *
@@ -27,7 +28,7 @@ export class DmMembers extends APIResource {
   }
 
   /**
-   * Retrieves a DM channel member
+   * Retrieves the details of an existing DM member.
    *
    * Required permissions:
    *
@@ -43,7 +44,8 @@ export class DmMembers extends APIResource {
   }
 
   /**
-   * Updates a DM channel member's settings
+   * Update a DM channel member's settings, such as their notification preferences or
+   * membership status.
    *
    * Required permissions:
    *
@@ -63,7 +65,8 @@ export class DmMembers extends APIResource {
   }
 
   /**
-   * Lists members of a DM channel
+   * Returns a paginated list of members in a specific DM channel, sorted by the date
+   * they were added.
    *
    * Required permissions:
    *
@@ -87,7 +90,8 @@ export class DmMembers extends APIResource {
   }
 
   /**
-   * Removes a user from a DM channel
+   * Remove a user from a DM channel. An admin can remove any member, and a member
+   * can remove themselves.
    *
    * Required permissions:
    *
@@ -116,7 +120,8 @@ export type DmFeedMemberNotificationPreferences = 'all' | 'mentions' | 'none';
 export type DmFeedMemberStatuses = 'requested' | 'accepted' | 'hidden' | 'closed' | 'archived';
 
 /**
- * Represents a member of a DM channel
+ * A user's membership record in a messaging channel, including notification
+ * preferences and read state.
  */
 export interface DmMember {
   /**
@@ -125,34 +130,36 @@ export interface DmMember {
   id: string;
 
   /**
-   * The ID of the DM channel
+   * The unique identifier of the messaging channel this membership belongs to.
    */
   channel_id: string;
 
   /**
-   * Timestamp when the member last viewed the channel (in milliseconds since Unix
-   * epoch)
+   * The timestamp when this member last viewed the channel, as a Unix timestamp in
+   * milliseconds. Null if the member has never viewed the channel.
    */
   last_viewed_at: string | null;
 
   /**
-   * The notification preference for this member (all, mentions, none)
+   * The notification level for this channel: all, mentions, or none.
    */
   notification_preference: DmFeedMemberNotificationPreferences;
 
   /**
-   * The status of the membership (requested, accepted, rejected)
+   * The current state of this membership: requested, accepted, hidden, closed, or
+   * archived.
    */
   status: DmFeedMemberStatuses;
 
   /**
-   * The ID of the user who is a member of the channel
+   * The unique identifier of the user who holds this channel membership.
    */
   user_id: string;
 }
 
 /**
- * Represents a member of a DM channel
+ * A user's membership record in a messaging channel, including notification
+ * preferences and read state.
  */
 export interface DmMemberListResponse {
   /**
@@ -161,23 +168,24 @@ export interface DmMemberListResponse {
   id: string;
 
   /**
-   * The ID of the DM channel
+   * The unique identifier of the messaging channel this membership belongs to.
    */
   channel_id: string;
 
   /**
-   * Timestamp when the member last viewed the channel (in milliseconds since Unix
-   * epoch)
+   * The timestamp when this member last viewed the channel, as a Unix timestamp in
+   * milliseconds. Null if the member has never viewed the channel.
    */
   last_viewed_at: string | null;
 
   /**
-   * The status of the membership (requested, accepted, rejected)
+   * The current state of this membership: requested, accepted, hidden, closed, or
+   * archived.
    */
   status: DmFeedMemberStatuses;
 
   /**
-   * The ID of the user who is a member of the channel
+   * The unique identifier of the user who holds this channel membership.
    */
   user_id: string;
 }
@@ -189,12 +197,13 @@ export type DmMemberDeleteResponse = boolean;
 
 export interface DmMemberCreateParams {
   /**
-   * The ID of the DM channel to add the member to
+   * The unique identifier of the DM channel to add the new member to.
    */
   channel_id: string;
 
   /**
-   * The ID of the user to add to the channel
+   * The unique identifier of the user to add to the DM channel. For example,
+   * 'user_xxxxx'.
    */
   user_id: string;
 }
@@ -213,7 +222,7 @@ export interface DmMemberUpdateParams {
 
 export interface DmMemberListParams extends CursorPageParams {
   /**
-   * The ID of the DM channel to list members for
+   * The unique identifier of the DM channel to list members for.
    */
   channel_id: string;
 

package/src/resources/entries.ts

@@ -9,7 +9,7 @@ import { path } from '../internal/utils/path';
 
 export class Entries extends APIResource {
   /**
-   * Retrieves an entry by ID
+   * Retrieves the details of an existing waitlist entry.
    *
    * Required permissions:
    *
@@ -21,7 +21,8 @@ export class Entries extends APIResource {
   }
 
   /**
-   * Lists entries for a company
+   * Returns a paginated list of waitlist entries for a company, with optional
+   * filtering by product, plan, status, and creation date.
    *
    * Required permissions:
    *
@@ -36,7 +37,8 @@ export class Entries extends APIResource {
   }
 
   /**
-   * Approve an entry
+   * Approve a pending waitlist entry, triggering the checkout process to grant the
+   * user access to the plan.
    *
    * Required permissions:
    *
@@ -47,7 +49,8 @@ export class Entries extends APIResource {
   }
 
   /**
-   * Deny an entry
+   * Deny a pending waitlist entry, preventing the user from gaining access to the
+   * plan.
    *
    * Required permissions:
    *
@@ -63,87 +66,92 @@ export class Entries extends APIResource {
 export type EntryListResponsesCursorPage = CursorPage<EntryListResponse>;
 
 /**
- * An object representing an entry in a waitlist.
+ * An entry represents a user's signup for a waitlisted plan.
  */
 export interface EntryListResponse {
   /**
-   * The internal ID of the entry.
+   * The unique identifier for the entry.
    */
   id: string;
 
   /**
-   * When the entry was created.
+   * The datetime the entry was created.
    */
   created_at: string | null;
 
   /**
-   * The waitlist plan the entry if for.
+   * The waitlisted plan that this entry is a signup for.
    */
   plan: EntryListResponse.Plan | null;
 
   /**
-   * The product tied to this entry, if there is one.
+   * The product associated with this entry's waitlisted plan. Null if the plan is
+   * not tied to a product.
    */
   product: EntryListResponse.Product | null;
 
   /**
-   * The status of the entry.
+   * The current status of the waitlist entry (e.g., drafted, pending, approved,
+   * denied).
    */
   status: Shared.EntryStatus;
 
   /**
-   * The user who created the entry.
+   * The user who submitted this waitlist entry.
    */
   user: EntryListResponse.User;
 }
 
 export namespace EntryListResponse {
   /**
-   * The waitlist plan the entry if for.
+   * The waitlisted plan that this entry is a signup for.
    */
   export interface Plan {
     /**
-     * The internal ID of the plan.
+     * The unique identifier for the plan.
      */
     id: string;
   }
 
   /**
-   * The product tied to this entry, if there is one.
+   * The product associated with this entry's waitlisted plan. Null if the plan is
+   * not tied to a product.
    */
   export interface Product {
     /**
-     * The internal ID of the public product.
+     * The unique identifier for the product.
      */
     id: string;
 
     /**
-     * The title of the product. Use for Whop 4.0.
+     * The display name of the product shown to customers on the product page and in
+     * search results.
      */
     title: string;
   }
 
   /**
-   * The user who created the entry.
+   * The user who submitted this waitlist entry.
    */
   export interface User {
     /**
-     * The internal ID of the user.
+     * The unique identifier for the user.
      */
     id: string;
 
     /**
-     * The email of the user
+     * The user's email address. Requires the member:email:read permission to access.
+     * Null if not authorized.
      */
     email: string | null;
 
     /**
-     * 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;
   }
@@ -161,7 +169,7 @@ export interface EntryApproveResponse {
 
 export interface EntryListParams extends CursorPageParams {
   /**
-   * The ID of the company
+   * The unique identifier of the company to list waitlist entries for.
    */
   company_id: string;
 
@@ -171,12 +179,12 @@ export interface EntryListParams extends CursorPageParams {
   before?: string | null;
 
   /**
-   * The minimum creation date to filter by
+   * Only return entries created after this timestamp.
    */
   created_after?: string | null;
 
   /**
-   * The maximum creation date to filter by
+   * Only return entries created before this timestamp.
    */
   created_before?: string | null;
 
@@ -201,17 +209,17 @@ export interface EntryListParams extends CursorPageParams {
   order?: 'id' | 'created_at' | null;
 
   /**
-   * The plan IDs to filter the entries by
+   * Filter entries to only those for specific plans.
    */
   plan_ids?: Array<string> | null;
 
   /**
-   * The product IDs to filter the entries by
+   * Filter entries to only those for specific products.
    */
   product_ids?: Array<string> | null;
 
   /**
-   * The statuses to filter the entries by
+   * Filter entries by their current status.
    */
   statuses?: Array<Shared.EntryStatus> | null;
 }