@whop/sdk 0.0.21 → 0.0.22

package/resources/leads.d.mts

@@ -0,0 +1,489 @@
+import { APIResource } from "../core/resource.mjs";
+import { APIPromise } from "../core/api-promise.mjs";
+import { CursorPage, type CursorPageParams, PagePromise } from "../core/pagination.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+export declare class Leads extends APIResource {
+    /**
+     * Creates a new lead
+     *
+     * Required permissions:
+     *
+     * - `lead:manage`
+     * - `member:email:read`
+     * - `access_pass:basic:read`
+     * - `member:basic:read`
+     *
+     * @example
+     * ```ts
+     * const lead = await client.leads.create({
+     *   company_id: 'biz_xxxxxxxxxxxxxx',
+     * });
+     * ```
+     */
+    create(body: LeadCreateParams, options?: RequestOptions): APIPromise<LeadCreateResponse>;
+    /**
+     * Retrieves a lead by ID
+     *
+     * Required permissions:
+     *
+     * - `lead:basic:read`
+     * - `member:email:read`
+     * - `access_pass:basic:read`
+     * - `member:basic:read`
+     *
+     * @example
+     * ```ts
+     * const lead = await client.leads.retrieve(
+     *   'lead_xxxxxxxxxxxxx',
+     * );
+     * ```
+     */
+    retrieve(id: string, options?: RequestOptions): APIPromise<LeadRetrieveResponse>;
+    /**
+     * Updates a lead
+     *
+     * Required permissions:
+     *
+     * - `lead:manage`
+     * - `member:email:read`
+     * - `access_pass:basic:read`
+     * - `member:basic:read`
+     *
+     * @example
+     * ```ts
+     * const lead = await client.leads.update(
+     *   'lead_xxxxxxxxxxxxx',
+     * );
+     * ```
+     */
+    update(id: string, body?: LeadUpdateParams | null | undefined, options?: RequestOptions): APIPromise<LeadUpdateResponse>;
+    /**
+     * Lists leads for a company
+     *
+     * Required permissions:
+     *
+     * - `lead:basic:read`
+     * - `member:email:read`
+     * - `access_pass:basic:read`
+     * - `member:basic:read`
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const leadListResponse of client.leads.list({
+     *   company_id: 'biz_xxxxxxxxxxxxxx',
+     * })) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(query: LeadListParams, options?: RequestOptions): PagePromise<LeadListResponsesCursorPage, LeadListResponse>;
+}
+export type LeadListResponsesCursorPage = CursorPage<LeadListResponse>;
+/**
+ * An object representing a lead (someone who is interested in a whop).
+ */
+export interface LeadCreateResponse {
+    /**
+     * The ID of the lead.
+     */
+    id: string;
+    /**
+     * The timestamp of when the lead was created.
+     */
+    created_at: string;
+    /**
+     * The converted member, if any.
+     */
+    member: LeadCreateResponse.Member | null;
+    /**
+     * Custom metadata for the lead.
+     */
+    metadata: {
+        [key: string]: unknown;
+    } | null;
+    /**
+     * The access pass the lead is interested in, if available.
+     */
+    product: LeadCreateResponse.Product | null;
+    /**
+     * The referrer URL that brought this lead.
+     */
+    referrer: string | null;
+    /**
+     * The timestamp of when the lead was last updated.
+     */
+    updated_at: string;
+    /**
+     * The user who is the lead.
+     */
+    user: LeadCreateResponse.User;
+}
+export declare namespace LeadCreateResponse {
+    /**
+     * The converted member, if any.
+     */
+    interface Member {
+        /**
+         * The ID of the member
+         */
+        id: string;
+    }
+    /**
+     * The access pass the lead is interested in, if available.
+     */
+    interface Product {
+        /**
+         * The internal ID of the public product.
+         */
+        id: string;
+        /**
+         * The title of the product. Use for Whop 4.0.
+         */
+        title: string;
+    }
+    /**
+     * The user who is the lead.
+     */
+    interface User {
+        /**
+         * The internal ID of the user.
+         */
+        id: string;
+        /**
+         * The email of the user
+         */
+        email: string | null;
+        /**
+         * The name of the user from their Whop account.
+         */
+        name: string | null;
+        /**
+         * The username of the user from their Whop account.
+         */
+        username: string;
+    }
+}
+/**
+ * An object representing a lead (someone who is interested in a whop).
+ */
+export interface LeadRetrieveResponse {
+    /**
+     * The ID of the lead.
+     */
+    id: string;
+    /**
+     * The timestamp of when the lead was created.
+     */
+    created_at: string;
+    /**
+     * The converted member, if any.
+     */
+    member: LeadRetrieveResponse.Member | null;
+    /**
+     * Custom metadata for the lead.
+     */
+    metadata: {
+        [key: string]: unknown;
+    } | null;
+    /**
+     * The access pass the lead is interested in, if available.
+     */
+    product: LeadRetrieveResponse.Product | null;
+    /**
+     * The referrer URL that brought this lead.
+     */
+    referrer: string | null;
+    /**
+     * The timestamp of when the lead was last updated.
+     */
+    updated_at: string;
+    /**
+     * The user who is the lead.
+     */
+    user: LeadRetrieveResponse.User;
+}
+export declare namespace LeadRetrieveResponse {
+    /**
+     * The converted member, if any.
+     */
+    interface Member {
+        /**
+         * The ID of the member
+         */
+        id: string;
+    }
+    /**
+     * The access pass the lead is interested in, if available.
+     */
+    interface Product {
+        /**
+         * The internal ID of the public product.
+         */
+        id: string;
+        /**
+         * The title of the product. Use for Whop 4.0.
+         */
+        title: string;
+    }
+    /**
+     * The user who is the lead.
+     */
+    interface User {
+        /**
+         * The internal ID of the user.
+         */
+        id: string;
+        /**
+         * The email of the user
+         */
+        email: string | null;
+        /**
+         * The name of the user from their Whop account.
+         */
+        name: string | null;
+        /**
+         * The username of the user from their Whop account.
+         */
+        username: string;
+    }
+}
+/**
+ * An object representing a lead (someone who is interested in a whop).
+ */
+export interface LeadUpdateResponse {
+    /**
+     * The ID of the lead.
+     */
+    id: string;
+    /**
+     * The timestamp of when the lead was created.
+     */
+    created_at: string;
+    /**
+     * The converted member, if any.
+     */
+    member: LeadUpdateResponse.Member | null;
+    /**
+     * Custom metadata for the lead.
+     */
+    metadata: {
+        [key: string]: unknown;
+    } | null;
+    /**
+     * The access pass the lead is interested in, if available.
+     */
+    product: LeadUpdateResponse.Product | null;
+    /**
+     * The referrer URL that brought this lead.
+     */
+    referrer: string | null;
+    /**
+     * The timestamp of when the lead was last updated.
+     */
+    updated_at: string;
+    /**
+     * The user who is the lead.
+     */
+    user: LeadUpdateResponse.User;
+}
+export declare namespace LeadUpdateResponse {
+    /**
+     * The converted member, if any.
+     */
+    interface Member {
+        /**
+         * The ID of the member
+         */
+        id: string;
+    }
+    /**
+     * The access pass the lead is interested in, if available.
+     */
+    interface Product {
+        /**
+         * The internal ID of the public product.
+         */
+        id: string;
+        /**
+         * The title of the product. Use for Whop 4.0.
+         */
+        title: string;
+    }
+    /**
+     * The user who is the lead.
+     */
+    interface User {
+        /**
+         * The internal ID of the user.
+         */
+        id: string;
+        /**
+         * The email of the user
+         */
+        email: string | null;
+        /**
+         * The name of the user from their Whop account.
+         */
+        name: string | null;
+        /**
+         * The username of the user from their Whop account.
+         */
+        username: string;
+    }
+}
+/**
+ * An object representing a lead (someone who is interested in a whop).
+ */
+export interface LeadListResponse {
+    /**
+     * The ID of the lead.
+     */
+    id: string;
+    /**
+     * The timestamp of when the lead was created.
+     */
+    created_at: string;
+    /**
+     * The converted member, if any.
+     */
+    member: LeadListResponse.Member | null;
+    /**
+     * Custom metadata for the lead.
+     */
+    metadata: {
+        [key: string]: unknown;
+    } | null;
+    /**
+     * The access pass the lead is interested in, if available.
+     */
+    product: LeadListResponse.Product | null;
+    /**
+     * The referrer URL that brought this lead.
+     */
+    referrer: string | null;
+    /**
+     * The timestamp of when the lead was last updated.
+     */
+    updated_at: string;
+    /**
+     * The user who is the lead.
+     */
+    user: LeadListResponse.User;
+}
+export declare namespace LeadListResponse {
+    /**
+     * The converted member, if any.
+     */
+    interface Member {
+        /**
+         * The ID of the member
+         */
+        id: string;
+    }
+    /**
+     * The access pass the lead is interested in, if available.
+     */
+    interface Product {
+        /**
+         * The internal ID of the public product.
+         */
+        id: string;
+        /**
+         * The title of the product. Use for Whop 4.0.
+         */
+        title: string;
+    }
+    /**
+     * The user who is the lead.
+     */
+    interface User {
+        /**
+         * The internal ID of the user.
+         */
+        id: string;
+        /**
+         * The email of the user
+         */
+        email: string | null;
+        /**
+         * The name of the user from their Whop account.
+         */
+        name: string | null;
+        /**
+         * The username of the user from their Whop account.
+         */
+        username: string;
+    }
+}
+export interface LeadCreateParams {
+    /**
+     * The ID of the company to create a lead for.
+     */
+    company_id: string;
+    /**
+     * Custom metadata for the lead.
+     */
+    metadata?: {
+        [key: string]: unknown;
+    } | null;
+    /**
+     * The ID of the product the lead is interested in.
+     */
+    product_id?: string | null;
+    /**
+     * The url referrer of the lead, if any.
+     */
+    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.
+     */
+    user_id?: string | null;
+}
+export interface LeadUpdateParams {
+    /**
+     * Custom metadata for the lead.
+     */
+    metadata?: {
+        [key: string]: unknown;
+    } | null;
+    /**
+     * The url referrer of the lead.
+     */
+    referrer?: string | null;
+}
+export interface LeadListParams extends CursorPageParams {
+    /**
+     * The ID of the company to list leads for
+     */
+    company_id: string;
+    /**
+     * Returns the elements in the list that come before the specified cursor.
+     */
+    before?: string | null;
+    /**
+     * The minimum creation date to filter by
+     */
+    created_after?: string | null;
+    /**
+     * The maximum creation date to filter by
+     */
+    created_before?: string | null;
+    /**
+     * Returns the first _n_ elements from the list.
+     */
+    first?: number | null;
+    /**
+     * Returns the last _n_ elements from the list.
+     */
+    last?: number | null;
+    /**
+     * The product IDs to filter the leads by
+     */
+    product_ids?: Array<string> | null;
+}
+export declare namespace Leads {
+    export { type LeadCreateResponse as LeadCreateResponse, type LeadRetrieveResponse as LeadRetrieveResponse, type LeadUpdateResponse as LeadUpdateResponse, type LeadListResponse as LeadListResponse, type LeadListResponsesCursorPage as LeadListResponsesCursorPage, type LeadCreateParams as LeadCreateParams, type LeadUpdateParams as LeadUpdateParams, type LeadListParams as LeadListParams, };
+}
+//# sourceMappingURL=leads.d.mts.map

package/resources/leads.d.mts.map

@@ -0,0 +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,kBAAkB,CAAC;IAIxF;;;;;;;;;;;;;;;;OAgBG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,oBAAoB,CAAC;IAIhF;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,kBAAkB,CAAC;IAIjC;;;;;;;;;;;;;;;;;;;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,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,kBAAkB,CAAC,MAAM,GAAG,IAAI,CAAC;IAEzC;;OAEG;IACH,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,OAAO,EAAE,kBAAkB,CAAC,OAAO,GAAG,IAAI,CAAC;IAE3C;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,kBAAkB,CAAC,IAAI,CAAC;CAC/B;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;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,oBAAoB;IACnC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,oBAAoB,CAAC,MAAM,GAAG,IAAI,CAAC;IAE3C;;OAEG;IACH,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,OAAO,EAAE,oBAAoB,CAAC,OAAO,GAAG,IAAI,CAAC;IAE7C;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,oBAAoB,CAAC,IAAI,CAAC;CACjC;AAED,yBAAiB,oBAAoB,CAAC;IACpC;;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,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,kBAAkB,CAAC,MAAM,GAAG,IAAI,CAAC;IAEzC;;OAEG;IACH,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,OAAO,EAAE,kBAAkB,CAAC,OAAO,GAAG,IAAI,CAAC;IAE3C;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,kBAAkB,CAAC,IAAI,CAAC;CAC/B;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;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,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,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"}