@whop/sdk 0.0.27 → 0.0.28

package/src/resources/leads.ts

@@ -8,7 +8,8 @@ import { path } from '../internal/utils/path';
 
 export class Leads extends APIResource {
   /**
-   * Creates a new lead
+   * Record a new lead for a company, capturing a potential customer's interest in a
+   * specific product.
    *
    * Required permissions:
    *
@@ -29,7 +30,7 @@ export class Leads extends APIResource {
   }
 
   /**
-   * Retrieves a lead by ID
+   * Retrieves the details of an existing lead.
    *
    * Required permissions:
    *
@@ -50,7 +51,7 @@ export class Leads extends APIResource {
   }
 
   /**
-   * Updates a lead
+   * Update the metadata or referrer information on an existing lead record.
    *
    * Required permissions:
    *
@@ -75,7 +76,8 @@ export class Leads extends APIResource {
   }
 
   /**
-   * Lists leads for a company
+   * Returns a paginated list of leads for a company, with optional filtering by
+   * product and creation date.
    *
    * Required permissions:
    *
@@ -105,7 +107,8 @@ export class Leads extends APIResource {
 export type LeadListResponsesCursorPage = CursorPage<LeadListResponse>;
 
 /**
- * An object representing a lead (someone who is interested in a whop).
+ * A prospective customer who has expressed interest in a company or product but
+ * has not yet purchased.
  */
 export interface Lead {
   /**
@@ -119,22 +122,25 @@ export interface Lead {
   created_at: string;
 
   /**
-   * The converted member, if any.
+   * The company member record if this lead has converted into a paying customer.
+   * Null if the lead has not converted.
    */
   member: Lead.Member | null;
 
   /**
-   * Custom metadata for the lead.
+   * Custom key-value pairs attached to this lead. Null if no metadata was provided.
    */
   metadata: { [key: string]: unknown } | null;
 
   /**
-   * The access pass the lead is interested in, if available.
+   * The product the lead expressed interest in. Null if the lead is not associated
+   * with a specific product.
    */
   product: Lead.Product | null;
 
   /**
-   * The referrer URL that brought this lead.
+   * The URL of the page that referred this lead to the company. Null if no referrer
+   * was captured.
    */
   referrer: string | null;
 
@@ -144,14 +150,15 @@ export interface Lead {
   updated_at: string;
 
   /**
-   * The user who is the lead.
+   * The user account associated with this lead.
    */
   user: Lead.User;
 }
 
 export namespace Lead {
   /**
-   * The converted member, if any.
+   * The company member record if this lead has converted into a paying customer.
+   * Null if the lead has not converted.
    */
   export interface Member {
     /**
@@ -161,7 +168,8 @@ export namespace Lead {
   }
 
   /**
-   * The access pass the lead is interested in, if available.
+   * The product the lead expressed interest in. Null if the lead is not associated
+   * with a specific product.
    */
   export interface Product {
     /**
@@ -170,13 +178,14 @@ export namespace Lead {
     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 is the lead.
+   * The user account associated with this lead.
    */
   export interface User {
     /**
@@ -185,24 +194,26 @@ export namespace Lead {
     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;
   }
 }
 
 /**
- * An object representing a lead (someone who is interested in a whop).
+ * A prospective customer who has expressed interest in a company or product but
+ * has not yet purchased.
  */
 export interface LeadListResponse {
   /**
@@ -216,22 +227,25 @@ export interface LeadListResponse {
   created_at: string;
 
   /**
-   * The converted member, if any.
+   * The company member record if this lead has converted into a paying customer.
+   * Null if the lead has not converted.
    */
   member: LeadListResponse.Member | null;
 
   /**
-   * Custom metadata for the lead.
+   * Custom key-value pairs attached to this lead. Null if no metadata was provided.
    */
   metadata: { [key: string]: unknown } | null;
 
   /**
-   * The access pass the lead is interested in, if available.
+   * The product the lead expressed interest in. Null if the lead is not associated
+   * with a specific product.
    */
   product: LeadListResponse.Product | null;
 
   /**
-   * The referrer URL that brought this lead.
+   * The URL of the page that referred this lead to the company. Null if no referrer
+   * was captured.
    */
   referrer: string | null;
 
@@ -241,14 +255,15 @@ export interface LeadListResponse {
   updated_at: string;
 
   /**
-   * The user who is the lead.
+   * The user account associated with this lead.
    */
   user: LeadListResponse.User;
 }
 
 export namespace LeadListResponse {
   /**
-   * The converted member, if any.
+   * The company member record if this lead has converted into a paying customer.
+   * Null if the lead has not converted.
    */
   export interface Member {
     /**
@@ -258,7 +273,8 @@ export namespace LeadListResponse {
   }
 
   /**
-   * The access pass the lead is interested in, if available.
+   * The product the lead expressed interest in. Null if the lead is not associated
+   * with a specific product.
    */
   export interface Product {
     /**
@@ -267,13 +283,14 @@ export namespace LeadListResponse {
     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 is the lead.
+   * The user account associated with this lead.
    */
   export interface User {
     /**
@@ -282,17 +299,18 @@ export namespace LeadListResponse {
     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;
   }
@@ -300,47 +318,51 @@ export namespace LeadListResponse {
 
 export interface LeadCreateParams {
   /**
-   * The ID of the company to create a lead for.
+   * The unique identifier of the company to create the lead for, starting with
+   * 'biz\_'.
    */
   company_id: string;
 
   /**
-   * Custom metadata for the lead.
+   * A JSON object of custom metadata to attach to the lead for tracking purposes.
    */
   metadata?: { [key: string]: unknown } | null;
 
   /**
-   * The ID of the product the lead is interested in.
+   * The unique identifier of the product the lead is interested in, starting with
+   * 'prod\_'.
    */
   product_id?: string | null;
 
   /**
-   * The url referrer of the lead, if any.
+   * The referral URL that brought the lead to the company, such as
+   * 'https://example.com/landing'.
    */
   referrer?: string | null;
 
   /**
-   * The ID of the user to create a lead for. If the request is made by a user, that
-   * user will be used.
+   * The unique identifier of the user to record as the lead. If authenticated as a
+   * user, that user is used automatically.
    */
   user_id?: string | null;
 }
 
 export interface LeadUpdateParams {
   /**
-   * Custom metadata for the lead.
+   * A JSON object of custom metadata to set on the lead, replacing any existing
+   * metadata.
    */
   metadata?: { [key: string]: unknown } | null;
 
   /**
-   * The url referrer of the lead.
+   * The updated referral URL for the lead, such as 'https://example.com/landing'.
    */
   referrer?: string | null;
 }
 
 export interface LeadListParams extends CursorPageParams {
   /**
-   * The ID of the company to list leads for
+   * The unique identifier of the company to list leads for.
    */
   company_id: string;
 
@@ -350,12 +372,12 @@ export interface LeadListParams extends CursorPageParams {
   before?: string | null;
 
   /**
-   * The minimum creation date to filter by
+   * Only return leads created after this timestamp.
    */
   created_after?: string | null;
 
   /**
-   * The maximum creation date to filter by
+   * Only return leads created before this timestamp.
    */
   created_before?: string | null;
 
@@ -370,7 +392,7 @@ export interface LeadListParams extends CursorPageParams {
   last?: number | null;
 
   /**
-   * The product IDs to filter the leads by
+   * Filter leads to only those associated with these specific product identifiers.
    */
   product_ids?: Array<string> | null;
 }

package/src/resources/ledger-accounts.ts

@@ -9,7 +9,7 @@ import { path } from '../internal/utils/path';
 
 export class LedgerAccounts extends APIResource {
   /**
-   * Retrieves a ledger account by its ID, company ID or user ID
+   * Retrieves the details of an existing ledger account.
    *
    * Required permissions:
    *
@@ -22,7 +22,8 @@ export class LedgerAccounts extends APIResource {
 }
 
 /**
- * Represents a LedgerAccount.
+ * A ledger account represents a financial account on Whop that can hold many
+ * balances.
  */
 export interface LedgerAccountRetrieveResponse {
   /**
@@ -98,7 +99,7 @@ export namespace LedgerAccountRetrieveResponse {
     id: string;
 
     /**
-     * The name of the user from their Whop account.
+     * The user's display name shown on their public profile.
      */
     name: string | null;
 
@@ -108,7 +109,7 @@ export namespace LedgerAccountRetrieveResponse {
     typename: 'User';
 
     /**
-     * The username of the user from their Whop account.
+     * The user's unique username shown on their public profile.
      */
     username: string;
   }
@@ -124,12 +125,12 @@ export namespace LedgerAccountRetrieveResponse {
     id: string;
 
     /**
-     * The slug/route of the company on the Whop site.
+     * The URL slug for the company's store page (e.g., 'pickaxe' in whop.com/pickaxe).
      */
     route: string;
 
     /**
-     * The title of the company.
+     * The display name of the company shown to customers.
      */
     title: string;
 
@@ -256,12 +257,13 @@ export namespace LedgerAccountRetrieveResponse {
       last_error_code: VerificationsAPI.VerificationErrorCode | null;
 
       /**
-       * The last error reason that occurred during the verification.
+       * A human-readable explanation of the most recent verification error. Null if no
+       * error has occurred.
        */
       last_error_reason: string | null;
 
       /**
-       * The status of the verification.
+       * The current status of this verification session.
        */
       status: VerificationsAPI.VerificationStatus;
     }

package/src/resources/members.ts

@@ -9,7 +9,7 @@ import { path } from '../internal/utils/path';
 
 export class Members extends APIResource {
   /**
-   * Retrieves a member of a company by ID
+   * Retrieves the details of an existing member.
    *
    * Required permissions:
    *
@@ -22,7 +22,8 @@ export class Members extends APIResource {
   }
 
   /**
-   * List the members of a company
+   * Returns a paginated list of members for a company, with extensive filtering by
+   * product, plan, status, access level, and more.
    *
    * Required permissions:
    *
@@ -41,9 +42,8 @@ export class Members extends APIResource {
 export type MemberListResponsesCursorPage = CursorPage<MemberListResponse>;
 
 /**
- * An object representing a connection between a creator and a user/company_buyer.
- * This type should only be made visible to the user/company_buyer who is a part of
- * the connection.
+ * A member represents a user's relationship with a company on Whop, including
+ * their access level, status, and spending history.
  */
 export interface MemberRetrieveResponse {
   /**
@@ -163,9 +163,8 @@ export namespace MemberRetrieveResponse {
 }
 
 /**
- * An object representing a connection between a creator and a user/company_buyer.
- * This type should only be made visible to the user/company_buyer who is a part of
- * the connection.
+ * A member represents a user's relationship with a company on Whop, including
+ * their access level, status, and spending history.
  */
 export interface MemberListResponse {
   /**
@@ -271,17 +270,17 @@ export interface MemberListParams extends CursorPageParams {
   before?: string | null;
 
   /**
-   * The ID of the company to list members for
+   * The unique identifier of the company to list members for.
    */
   company_id?: string | null;
 
   /**
-   * The minimum creation date to filter by
+   * Only return members created after this timestamp.
    */
   created_after?: string | null;
 
   /**
-   * The maximum creation date to filter by
+   * Only return members created before this timestamp.
    */
   created_before?: string | null;
 
@@ -301,7 +300,7 @@ export interface MemberListParams extends CursorPageParams {
   last?: number | null;
 
   /**
-   * The most recent actions to filter the members by
+   * Filter members by their most recent activity type.
    */
   most_recent_actions?: Array<Shared.MemberMostRecentActions> | null;
 
@@ -311,33 +310,33 @@ export interface MemberListParams extends CursorPageParams {
   order?: 'id' | 'usd_total_spent' | 'created_at' | 'joined_at' | 'most_recent_action' | null;
 
   /**
-   * The plan IDs to filter the members by
+   * Filter members to only those subscribed to these specific plans.
    */
   plan_ids?: Array<string> | null;
 
   /**
-   * The product IDs to filter the members by
+   * Filter members to only those belonging to these specific products.
    */
   product_ids?: Array<string> | null;
 
   /**
-   * The promo code IDs to filter the members by
+   * Filter members to only those who used these specific promo codes.
    */
   promo_code_ids?: Array<string> | null;
 
   /**
-   * The name, username, or email to filter the members by. The email filter will
-   * only apply if the current actor has the `member:email:read` permission.
+   * Search members by name, username, or email. Email filtering requires the
+   * member:email:read permission.
    */
   query?: string | null;
 
   /**
-   * The statuses to filter the members by
+   * Filter members by their current subscription status.
    */
   statuses?: Array<Shared.MemberStatuses> | null;
 
   /**
-   * The user IDs to filter the members by
+   * Filter members to only those matching these specific user identifiers.
    */
   user_ids?: Array<string> | null;
 }