@whop/sdk 0.0.26 → 0.0.28

package/src/resources/memberships.ts

@@ -9,7 +9,7 @@ import { path } from '../internal/utils/path';
 
 export class Memberships extends APIResource {
   /**
-   * Retrieves a membership by ID or license key
+   * Retrieves the details of an existing membership.
    *
    * Required permissions:
    *
@@ -21,7 +21,7 @@ export class Memberships extends APIResource {
   }
 
   /**
-   * Update a membership
+   * Update a membership's metadata or other mutable properties.
    *
    * Required permissions:
    *
@@ -38,7 +38,8 @@ export class Memberships extends APIResource {
   }
 
   /**
-   * Lists memberships
+   * Returns a paginated list of memberships, with optional filtering by product,
+   * plan, status, and user.
    *
    * Required permissions:
    *
@@ -53,8 +54,8 @@ export class Memberships extends APIResource {
   }
 
   /**
-   * Cancels a membership either immediately or at the end of the current billing
-   * period
+   * Cancel a membership either immediately or at the end of the current billing
+   * period. Immediate cancellation revokes access right away.
    *
    * Required permissions:
    *
@@ -71,7 +72,8 @@ export class Memberships extends APIResource {
   }
 
   /**
-   * Pauses a membership's payments
+   * Pause a membership's recurring payments. The customer retains access but will
+   * not be charged until the membership is resumed.
    *
    * Required permissions:
    *
@@ -88,7 +90,8 @@ export class Memberships extends APIResource {
   }
 
   /**
-   * Resumes a membership's payments
+   * Resume a previously paused membership's recurring payments. Billing resumes on
+   * the next cycle.
    *
    * Required permissions:
    *
@@ -101,7 +104,8 @@ export class Memberships extends APIResource {
   }
 
   /**
-   * Uncancels a membership that was scheduled to cancel at period end
+   * Reverse a pending cancellation for a membership that was scheduled to cancel at
+   * period end.
    *
    * Required permissions:
    *
@@ -130,18 +134,18 @@ export type CancelOptions =
   | 'testing';
 
 /**
- * A membership represents a purchase between a User and a Company for a specific
- * Product.
+ * A membership represents an active relationship between a user and a product. It
+ * tracks the user's access, billing status, and renewal schedule.
  */
 export interface MembershipListResponse {
   /**
-   * The ID of the membership
+   * The unique identifier for the membership.
    */
   id: string;
 
   /**
-   * Whether this Membership is set to cancel at the end of the current billing
-   * cycle. Only applies for memberships that have a renewal plan.
+   * Whether this membership is set to cancel at the end of the current billing
+   * cycle. Only applies to memberships with a recurring plan.
    */
   cancel_at_period_end: boolean;
 
@@ -152,22 +156,24 @@ export interface MembershipListResponse {
   cancel_option: CancelOptions | null;
 
   /**
-   * The epoch timestamp of when the customer initiated a cancellation.
+   * The time the customer initiated cancellation of this membership. As a Unix
+   * timestamp. Null if the membership has not been canceled.
    */
   canceled_at: string | null;
 
   /**
-   * The reason that the member canceled the membership (filled out by the member).
+   * Free-text explanation provided by the customer when canceling. Null if the
+   * customer did not provide a reason.
    */
   cancellation_reason: string | null;
 
   /**
-   * The Company this Membership belongs to.
+   * The company this membership belongs to.
    */
   company: MembershipListResponse.Company;
 
   /**
-   * The timestamp, in seconds, that this Membership was created at.
+   * The datetime the membership was created.
    */
   created_at: string;
 
@@ -177,156 +183,172 @@ export interface MembershipListResponse {
   currency: Shared.Currency | null;
 
   /**
-   * The license key for this Membership. This is only present if the membership
-   * grants access to an instance of the Whop Software app.
+   * The time the user first joined the company associated with this membership. As a
+   * Unix timestamp. Null if the member record does not exist.
+   */
+  joined_at: string | null;
+
+  /**
+   * The software license key associated with this membership. Only present if the
+   * product includes a Whop Software Licensing experience. Null otherwise.
    */
   license_key: string | null;
 
   /**
-   * The URL for the customer to manage their membership.
+   * The URL where the customer can view and manage this membership, including
+   * cancellation and plan changes. Null if no member record exists.
    */
   manage_url: string | null;
 
   /**
-   * The Member that this Membership belongs to.
+   * The member record linking the user to the company for this membership. Null if
+   * the member record has not been created yet.
    */
   member: MembershipListResponse.Member | null;
 
   /**
-   * A JSON object used to store software licensing information. Ex. HWID
+   * Custom key-value pairs for the membership (commonly used for software licensing,
+   * e.g., HWID). Max 50 keys, 500 chars per key, 5000 chars per value.
    */
   metadata: { [key: string]: unknown };
 
   /**
-   * Whether the membership's payments are currently paused.
+   * Whether recurring payment collection for this membership is temporarily paused
+   * by the company.
    */
   payment_collection_paused: boolean;
 
   /**
-   * The Plan this Membership is for.
+   * The plan the customer purchased to create this membership.
    */
   plan: MembershipListResponse.Plan;
 
   /**
-   * The Product this Membership grants access to.
+   * The product this membership grants access to.
    */
   product: MembershipListResponse.Product;
 
   /**
-   * The Promo Code that is currently applied to this Membership.
+   * The promotional code currently applied to this membership's billing. Null if no
+   * promo code is active.
    */
   promo_code: MembershipListResponse.PromoCode | null;
 
   /**
-   * The timestamp in seconds at which the current billing cycle for this
-   * subscription ends. Only applies for memberships that have a renewal plan.
+   * The end of the current billing period for this recurring membership. As a Unix
+   * timestamp. Null if the membership is not recurring.
    */
   renewal_period_end: string | null;
 
   /**
-   * The timestamp in seconds at which the current billing cycle for this
-   * subscription start. Only applies for memberships that have a renewal plan.
+   * The start of the current billing period for this recurring membership. As a Unix
+   * timestamp. Null if the membership is not recurring.
    */
   renewal_period_start: string | null;
 
   /**
-   * The status of the membership.
+   * The current lifecycle status of the membership (e.g., active, trialing,
+   * past_due, canceled, expired, completed).
    */
   status: Shared.MembershipStatus;
 
   /**
-   * A timestamp of when the membership was last updated
+   * The datetime the membership was last updated.
    */
   updated_at: string;
 
   /**
-   * The user this membership belongs to
+   * The user who owns this membership. Null if the user account has been deleted.
    */
   user: MembershipListResponse.User | null;
 }
 
 export namespace MembershipListResponse {
   /**
-   * The Company this Membership belongs to.
+   * The company this membership belongs to.
    */
   export interface Company {
     /**
-     * The ID (tag) of the company.
+     * The unique identifier for the company.
      */
     id: string;
 
     /**
-     * The title of the company.
+     * The display name of the company shown to customers.
      */
     title: string;
   }
 
   /**
-   * The Member that this Membership belongs to.
+   * The member record linking the user to the company for this membership. Null if
+   * the member record has not been created yet.
    */
   export interface Member {
     /**
-     * The ID of the member
+     * The unique identifier for the member.
      */
     id: string;
   }
 
   /**
-   * The Plan this Membership is for.
+   * The plan the customer purchased to create this membership.
    */
   export interface Plan {
     /**
-     * The internal ID of the plan.
+     * The unique identifier for the plan.
      */
     id: string;
   }
 
   /**
-   * The Product this Membership grants access to.
+   * The product this membership grants access to.
    */
   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 Promo Code that is currently applied to this Membership.
+   * The promotional code currently applied to this membership's billing. Null if no
+   * promo code is active.
    */
   export interface PromoCode {
     /**
-     * The ID of the promo.
+     * The unique identifier for the promo code.
      */
     id: string;
   }
 
   /**
-   * The user this membership belongs to
+   * The user who owns this membership. Null if the user account has been deleted.
    */
   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;
   }
@@ -334,7 +356,8 @@ export namespace MembershipListResponse {
 
 export interface MembershipUpdateParams {
   /**
-   * The metadata to update the membership with.
+   * A JSON object of key-value pairs to store on the membership. Replaces any
+   * existing metadata.
    */
   metadata?: { [key: string]: unknown } | null;
 }
@@ -346,22 +369,23 @@ export interface MembershipListParams extends CursorPageParams {
   before?: string | null;
 
   /**
-   * The cancel options to filter the memberships by
+   * Filter to only memberships matching these cancellation reasons.
    */
   cancel_options?: Array<CancelOptions> | null;
 
   /**
-   * The ID of the company to list memberships for
+   * The unique identifier of the company to list memberships for. Required when
+   * using an API key.
    */
   company_id?: string | null;
 
   /**
-   * The minimum creation date to filter by
+   * Only return memberships created after this timestamp.
    */
   created_after?: string | null;
 
   /**
-   * The maximum creation date to filter by
+   * Only return memberships created before this timestamp.
    */
   created_before?: string | null;
 
@@ -386,27 +410,27 @@ export interface MembershipListParams extends CursorPageParams {
   order?: 'id' | 'created_at' | 'status' | 'canceled_at' | 'date_joined' | 'total_spend' | null;
 
   /**
-   * The plan IDs to filter the memberships by
+   * Filter to only memberships belonging to these plan identifiers.
    */
   plan_ids?: Array<string> | null;
 
   /**
-   * The product IDs to filter the memberships by
+   * Filter to only memberships belonging to these product identifiers.
    */
   product_ids?: Array<string> | null;
 
   /**
-   * The promo code IDs to filter the memberships by
+   * Filter to only memberships that used these promo code identifiers.
    */
   promo_code_ids?: Array<string> | null;
 
   /**
-   * The membership status to filter the memberships by
+   * Filter to only memberships matching these statuses.
    */
   statuses?: Array<Shared.MembershipStatus> | null;
 
   /**
-   * Only return memberships from these whop user ids
+   * Filter to only memberships belonging to these user identifiers.
    */
   user_ids?: Array<string> | null;
 }
@@ -420,8 +444,8 @@ export interface MembershipCancelParams {
 
 export interface MembershipPauseParams {
   /**
-   * Whether to void past_due payments associated with the membership to prevent
-   * future payment attempts.
+   * Whether to void any outstanding past-due payments on this membership, preventing
+   * future collection attempts.
    */
   void_payments?: boolean | null;
 }

package/src/resources/messages.ts

@@ -9,7 +9,8 @@ import { path } from '../internal/utils/path';
 
 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:
    *
@@ -20,7 +21,7 @@ export class Messages extends APIResource {
   }
 
   /**
-   * Retrieves a message
+   * Retrieves the details of an existing message.
    *
    * Required permissions:
    *
@@ -31,7 +32,8 @@ export class Messages extends APIResource {
   }
 
   /**
-   * 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,
@@ -42,7 +44,8 @@ export class Messages extends APIResource {
   }
 
   /**
-   * 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:
    *
@@ -56,7 +59,8 @@ export class Messages extends APIResource {
   }
 
   /**
-   * 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:
    *
@@ -70,78 +74,87 @@ export 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 namespace MessageListResponse {
   /**
-   * The poll for this message
+   * A poll attached to this message. Null if the message does not contain a poll.
    */
   export interface Poll {
     /**
@@ -156,7 +169,7 @@ export namespace MessageListResponse {
      */
     export interface Option {
       /**
-       * The ID of the poll option
+       * The unique identifier for the poll option.
        */
       id: string;
 
@@ -198,21 +211,21 @@ export namespace MessageListResponse {
   }
 
   /**
-   * The user who sent this message
+   * The user who authored this message.
    */
   export 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;
   }
@@ -225,27 +238,30 @@ 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;
 }
@@ -262,7 +278,7 @@ export namespace MessageCreateParams {
   }
 
   /**
-   * The poll for this message
+   * A poll to attach to this message, allowing recipients to vote on options.
    */
   export interface Poll {
     /**
@@ -291,17 +307,19 @@ export 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;
 }
@@ -320,7 +338,7 @@ export 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;