@whop/sdk 0.0.27 → 0.0.28

package/resources/leads.d.mts

@@ -4,7 +4,8 @@ import { CursorPage, type CursorPageParams, PagePromise } from "../core/paginati
 import { RequestOptions } from "../internal/request-options.mjs";
 export declare 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:
      *
@@ -22,7 +23,7 @@ export declare class Leads extends APIResource {
      */
     create(body: LeadCreateParams, options?: RequestOptions): APIPromise<Lead>;
     /**
-     * Retrieves a lead by ID
+     * Retrieves the details of an existing lead.
      *
      * Required permissions:
      *
@@ -40,7 +41,7 @@ export declare class Leads extends APIResource {
      */
     retrieve(id: string, options?: RequestOptions): APIPromise<Lead>;
     /**
-     * Updates a lead
+     * Update the metadata or referrer information on an existing lead record.
      *
      * Required permissions:
      *
@@ -58,7 +59,8 @@ export declare class Leads extends APIResource {
      */
     update(id: string, body?: LeadUpdateParams | null | undefined, options?: RequestOptions): APIPromise<Lead>;
     /**
-     * Lists leads for a company
+     * Returns a paginated list of leads for a company, with optional filtering by
+     * product and creation date.
      *
      * Required permissions:
      *
@@ -81,7 +83,8 @@ export declare 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 {
     /**
@@ -93,21 +96,24 @@ 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;
     /**
@@ -115,13 +121,14 @@ export interface Lead {
      */
     updated_at: string;
     /**
-     * The user who is the lead.
+     * The user account associated with this lead.
      */
     user: Lead.User;
 }
 export declare 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.
      */
     interface Member {
         /**
@@ -130,7 +137,8 @@ export declare namespace Lead {
         id: string;
     }
     /**
-     * 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.
      */
     interface Product {
         /**
@@ -138,12 +146,13 @@ export declare 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.
      */
     interface User {
         /**
@@ -151,21 +160,23 @@ export declare 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 {
     /**
@@ -177,21 +188,24 @@ 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;
     /**
@@ -199,13 +213,14 @@ export interface LeadListResponse {
      */
     updated_at: string;
     /**
-     * The user who is the lead.
+     * The user account associated with this lead.
      */
     user: LeadListResponse.User;
 }
 export declare 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.
      */
     interface Member {
         /**
@@ -214,7 +229,8 @@ export declare namespace LeadListResponse {
         id: string;
     }
     /**
-     * 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.
      */
     interface Product {
         /**
@@ -222,12 +238,13 @@ export declare 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.
      */
     interface User {
         /**
@@ -235,59 +252,64 @@ export declare 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;
     }
 }
 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;
     /**
@@ -295,11 +317,11 @@ 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;
     /**
@@ -311,7 +333,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/resources/leads.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"leads.d.mts","sourceRoot":"","sources":["../src/resources/leads.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAI1E;;;;;;;;;;;;;;;;OAgBG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAIhE;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,IAAI,CAAC;IAInB;;;;;;;;;;;;;;;;;;;OAmBG;IACH,IAAI,CACF,KAAK,EAAE,cAAc,EACrB,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,2BAA2B,EAAE,gBAAgB,CAAC;CAG9D;AAED,MAAM,MAAM,2BAA2B,GAAG,UAAU,CAAC,gBAAgB,CAAC,CAAC;AAEvE;;GAEG;AACH,MAAM,WAAW,IAAI;IACnB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,OAAO,EAAE,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC;CACjB;AAED,yBAAiB,IAAI,CAAC;IACpB;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;IAED;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;IAED;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;KAClB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,gBAAgB,CAAC,MAAM,GAAG,IAAI,CAAC;IAEvC;;OAEG;IACH,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,OAAO,EAAE,gBAAgB,CAAC,OAAO,GAAG,IAAI,CAAC;IAEzC;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,gBAAgB,CAAC,IAAI,CAAC;CAC7B;AAED,yBAAiB,gBAAgB,CAAC;IAChC;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;IAED;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;IAED;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;KAClB;CACF;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAE7C;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAE7C;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,MAAM,WAAW,cAAe,SAAQ,gBAAgB;IACtD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;CACpC;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,IAAI,IAAI,IAAI,EACjB,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,cAAc,IAAI,cAAc,GACtC,CAAC;CACH"}
+{"version":3,"file":"leads.d.mts","sourceRoot":"","sources":["../src/resources/leads.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CAAC,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAI1E;;;;;;;;;;;;;;;;OAgBG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAIhE;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,IAAI,CAAC;IAInB;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,IAAI,CACF,KAAK,EAAE,cAAc,EACrB,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,2BAA2B,EAAE,gBAAgB,CAAC;CAG9D;AAED,MAAM,MAAM,2BAA2B,GAAG,UAAU,CAAC,gBAAgB,CAAC,CAAC;AAEvE;;;GAGG;AACH,MAAM,WAAW,IAAI;IACnB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,MAAM,EAAE,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAE5C;;;OAGG;IACH,OAAO,EAAE,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;IAE7B;;;OAGG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC;CACjB;AAED,yBAAiB,IAAI,CAAC;IACpB;;;OAGG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;IAED;;;OAGG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;;WAGG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;IAED;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;;WAGG;QACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;KAClB;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,MAAM,EAAE,gBAAgB,CAAC,MAAM,GAAG,IAAI,CAAC;IAEvC;;OAEG;IACH,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAE5C;;;OAGG;IACH,OAAO,EAAE,gBAAgB,CAAC,OAAO,GAAG,IAAI,CAAC;IAEzC;;;OAGG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,gBAAgB,CAAC,IAAI,CAAC;CAC7B;AAED,yBAAiB,gBAAgB,CAAC;IAChC;;;OAGG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;IAED;;;OAGG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;;WAGG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;IAED;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;;WAGG;QACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;KAClB;CACF;AAED,MAAM,WAAW,gBAAgB;IAC/B;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAE7C;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,MAAM,WAAW,gBAAgB;IAC/B;;;OAGG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAE7C;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,MAAM,WAAW,cAAe,SAAQ,gBAAgB;IACtD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;CACpC;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,IAAI,IAAI,IAAI,EACjB,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,cAAc,IAAI,cAAc,GACtC,CAAC;CACH"}

package/resources/leads.d.ts

@@ -4,7 +4,8 @@ import { CursorPage, type CursorPageParams, PagePromise } from "../core/paginati
 import { RequestOptions } from "../internal/request-options.js";
 export declare 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:
      *
@@ -22,7 +23,7 @@ export declare class Leads extends APIResource {
      */
     create(body: LeadCreateParams, options?: RequestOptions): APIPromise<Lead>;
     /**
-     * Retrieves a lead by ID
+     * Retrieves the details of an existing lead.
      *
      * Required permissions:
      *
@@ -40,7 +41,7 @@ export declare class Leads extends APIResource {
      */
     retrieve(id: string, options?: RequestOptions): APIPromise<Lead>;
     /**
-     * Updates a lead
+     * Update the metadata or referrer information on an existing lead record.
      *
      * Required permissions:
      *
@@ -58,7 +59,8 @@ export declare class Leads extends APIResource {
      */
     update(id: string, body?: LeadUpdateParams | null | undefined, options?: RequestOptions): APIPromise<Lead>;
     /**
-     * Lists leads for a company
+     * Returns a paginated list of leads for a company, with optional filtering by
+     * product and creation date.
      *
      * Required permissions:
      *
@@ -81,7 +83,8 @@ export declare 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 {
     /**
@@ -93,21 +96,24 @@ 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;
     /**
@@ -115,13 +121,14 @@ export interface Lead {
      */
     updated_at: string;
     /**
-     * The user who is the lead.
+     * The user account associated with this lead.
      */
     user: Lead.User;
 }
 export declare 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.
      */
     interface Member {
         /**
@@ -130,7 +137,8 @@ export declare namespace Lead {
         id: string;
     }
     /**
-     * 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.
      */
     interface Product {
         /**
@@ -138,12 +146,13 @@ export declare 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.
      */
     interface User {
         /**
@@ -151,21 +160,23 @@ export declare 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 {
     /**
@@ -177,21 +188,24 @@ 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;
     /**
@@ -199,13 +213,14 @@ export interface LeadListResponse {
      */
     updated_at: string;
     /**
-     * The user who is the lead.
+     * The user account associated with this lead.
      */
     user: LeadListResponse.User;
 }
 export declare 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.
      */
     interface Member {
         /**
@@ -214,7 +229,8 @@ export declare namespace LeadListResponse {
         id: string;
     }
     /**
-     * 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.
      */
     interface Product {
         /**
@@ -222,12 +238,13 @@ export declare 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.
      */
     interface User {
         /**
@@ -235,59 +252,64 @@ export declare 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;
     }
 }
 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;
     /**
@@ -295,11 +317,11 @@ 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;
     /**
@@ -311,7 +333,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;
 }