@whop/sdk 0.0.34 → 0.0.36

package/resources/affiliates/affiliates.d.mts

@@ -0,0 +1,353 @@
+import { APIResource } from "../../core/resource.mjs";
+import * as Shared from "../shared.mjs";
+import * as OverridesAPI from "./overrides.mjs";
+import { AffiliateAppliesToPayments, AffiliateAppliesToProducts, AffiliateOverrideRoles, AffiliatePayoutTypes, AffiliateRevenueBases, OverrideCreateParams, OverrideCreateResponse, OverrideDeleteParams, OverrideDeleteResponse, OverrideListParams, OverrideListResponse, OverrideListResponsesCursorPage, OverrideRetrieveParams, OverrideRetrieveResponse, OverrideUpdateParams, OverrideUpdateResponse, Overrides } from "./overrides.mjs";
+import { APIPromise } from "../../core/api-promise.mjs";
+import { CursorPage, type CursorPageParams, PagePromise } from "../../core/pagination.mjs";
+import { RequestOptions } from "../../internal/request-options.mjs";
+/**
+ * Affiliates
+ */
+export declare class Affiliates extends APIResource {
+    overrides: OverridesAPI.Overrides;
+    /**
+     * Creates or finds an affiliate for a company and user.
+     *
+     * Required permissions:
+     *
+     * - `affiliate:create`
+     *
+     * @example
+     * ```ts
+     * const affiliate = await client.affiliates.create({
+     *   company_id: 'biz_xxxxxxxxxxxxxx',
+     *   user_identifier: 'user_identifier',
+     * });
+     * ```
+     */
+    create(body: AffiliateCreateParams, options?: RequestOptions): APIPromise<Affiliate>;
+    /**
+     * Retrieves the details of an existing affiliate.
+     *
+     * Required permissions:
+     *
+     * - `affiliate:basic:read`
+     *
+     * @example
+     * ```ts
+     * const affiliate = await client.affiliates.retrieve(
+     *   'aff_xxxxxxxxxxxxxx',
+     * );
+     * ```
+     */
+    retrieve(id: string, options?: RequestOptions): APIPromise<Affiliate>;
+    /**
+     * Returns a paginated list of affiliates for the actor in context, with optional
+     * filtering by status, search, and sorting.
+     *
+     * Required permissions:
+     *
+     * - `affiliate:basic:read`
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const affiliateListResponse of client.affiliates.list(
+     *   { company_id: 'biz_xxxxxxxxxxxxxx' },
+     * )) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(query: AffiliateListParams, options?: RequestOptions): PagePromise<AffiliateListResponsesCursorPage, AffiliateListResponse>;
+    /**
+     * Archives an existing Affiliate
+     *
+     * Required permissions:
+     *
+     * - `affiliate:update`
+     *
+     * @example
+     * ```ts
+     * const response = await client.affiliates.archive(
+     *   'aff_xxxxxxxxxxxxxx',
+     * );
+     * ```
+     */
+    archive(id: string, options?: RequestOptions): APIPromise<AffiliateArchiveResponse>;
+    /**
+     * Unarchives an existing Affiliate
+     *
+     * Required permissions:
+     *
+     * - `affiliate:update`
+     *
+     * @example
+     * ```ts
+     * const response = await client.affiliates.unarchive(
+     *   'aff_xxxxxxxxxxxxxx',
+     * );
+     * ```
+     */
+    unarchive(id: string, options?: RequestOptions): APIPromise<AffiliateUnarchiveResponse>;
+}
+export type AffiliateListResponsesCursorPage = CursorPage<AffiliateListResponse>;
+/**
+ * An affiliate tracks a user's referral performance and commission earnings for a
+ * company, including retention rates, revenue metrics, and payout configurations.
+ */
+export interface Affiliate {
+    /**
+     * The unique identifier for the affiliate.
+     */
+    id: string;
+    /**
+     * The total active members of the affiliate
+     */
+    active_members_count: number;
+    /**
+     * The company attached to this affiliate
+     */
+    company: Affiliate.Company;
+    /**
+     * The datetime the affiliate was created.
+     */
+    created_at: string;
+    /**
+     * The percentage of referred customers who are still active members
+     */
+    customer_retention_rate: string;
+    /**
+     * The percentage of referred customers who remained active over the last 90 days
+     */
+    customer_retention_rate_ninety_days: string;
+    /**
+     * The monthly recurring revenue generated by this affiliate's referrals, formatted
+     * as a USD currency string
+     */
+    monthly_recurring_revenue_usd: string;
+    /**
+     * Statuses for resources
+     */
+    status: Status | null;
+    /**
+     * The total count of all overrides for this affiliate
+     */
+    total_overrides_count: number;
+    /**
+     * The total commission earnings paid to this affiliate, formatted as a USD
+     * currency string
+     */
+    total_referral_earnings_usd: string;
+    /**
+     * The total referrals of the affiliate
+     */
+    total_referrals_count: number;
+    /**
+     * The total revenue generated from this affiliate's referrals, formatted as a USD
+     * currency string
+     */
+    total_revenue_usd: string;
+    /**
+     * The datetime the affiliate was last updated.
+     */
+    updated_at: string;
+    /**
+     * The user attached to this affiliate
+     */
+    user: Affiliate.User;
+}
+export declare namespace Affiliate {
+    /**
+     * The company attached to this affiliate
+     */
+    interface Company {
+        /**
+         * The unique identifier for the company.
+         */
+        id: string;
+        /**
+         * The written name of the company.
+         */
+        title: string;
+    }
+    /**
+     * The user attached to this affiliate
+     */
+    interface User {
+        /**
+         * The unique identifier for the user.
+         */
+        id: string;
+        /**
+         * The display name set on the user's Whop profile. Null if the user has not set a
+         * name.
+         */
+        name: string | null;
+        /**
+         * The unique username chosen by the user for their Whop profile. Null if the user
+         * has not set a username.
+         */
+        username: string | null;
+    }
+}
+/**
+ * Statuses for resources
+ */
+export type Status = 'active' | 'archived' | 'deleted';
+/**
+ * An affiliate tracks a user's referral performance and commission earnings for a
+ * company, including retention rates, revenue metrics, and payout configurations.
+ */
+export interface AffiliateListResponse {
+    /**
+     * The unique identifier for the affiliate.
+     */
+    id: string;
+    /**
+     * The total active members of the affiliate
+     */
+    active_members_count: number;
+    /**
+     * The company attached to this affiliate
+     */
+    company: AffiliateListResponse.Company;
+    /**
+     * The datetime the affiliate was created.
+     */
+    created_at: string;
+    /**
+     * The percentage of referred customers who are still active members
+     */
+    customer_retention_rate: string;
+    /**
+     * The percentage of referred customers who remained active over the last 90 days
+     */
+    customer_retention_rate_ninety_days: string;
+    /**
+     * The monthly recurring revenue generated by this affiliate's referrals, formatted
+     * as a USD currency string
+     */
+    monthly_recurring_revenue_usd: string;
+    /**
+     * Statuses for resources
+     */
+    status: Status | null;
+    /**
+     * The total count of all overrides for this affiliate
+     */
+    total_overrides_count: number;
+    /**
+     * The total commission earnings paid to this affiliate, formatted as a USD
+     * currency string
+     */
+    total_referral_earnings_usd: string;
+    /**
+     * The total referrals of the affiliate
+     */
+    total_referrals_count: number;
+    /**
+     * The total revenue generated from this affiliate's referrals, formatted as a USD
+     * currency string
+     */
+    total_revenue_usd: string;
+    /**
+     * The datetime the affiliate was last updated.
+     */
+    updated_at: string;
+    /**
+     * The user attached to this affiliate
+     */
+    user: AffiliateListResponse.User;
+}
+export declare namespace AffiliateListResponse {
+    /**
+     * The company attached to this affiliate
+     */
+    interface Company {
+        /**
+         * The unique identifier for the company.
+         */
+        id: string;
+        /**
+         * The written name of the company.
+         */
+        title: string;
+    }
+    /**
+     * The user attached to this affiliate
+     */
+    interface User {
+        /**
+         * The unique identifier for the user.
+         */
+        id: string;
+        /**
+         * The display name set on the user's Whop profile. Null if the user has not set a
+         * name.
+         */
+        name: string | null;
+        /**
+         * The unique username chosen by the user for their Whop profile. Null if the user
+         * has not set a username.
+         */
+        username: string | null;
+    }
+}
+/**
+ * Represents `true` or `false` values.
+ */
+export type AffiliateArchiveResponse = boolean;
+/**
+ * Represents `true` or `false` values.
+ */
+export type AffiliateUnarchiveResponse = boolean;
+export interface AffiliateCreateParams {
+    /**
+     * The ID of the company to create the affiliate for.
+     */
+    company_id: string;
+    /**
+     * The user identifier (username, email, user ID, or Discord ID).
+     */
+    user_identifier: string;
+}
+export interface AffiliateListParams extends CursorPageParams {
+    /**
+     * The unique identifier of the company to list affiliates for.
+     */
+    company_id: string;
+    /**
+     * Returns the elements in the list that come before the specified cursor.
+     */
+    before?: string | null;
+    /**
+     * The direction of the sort.
+     */
+    direction?: Shared.Direction | null;
+    /**
+     * Returns the first _n_ elements from the list.
+     */
+    first?: number | null;
+    /**
+     * Returns the last _n_ elements from the list.
+     */
+    last?: number | null;
+    /**
+     * Which columns can be used to sort.
+     */
+    order?: 'id' | 'created_at' | 'cached_total_referrals' | 'cached_total_rewards' | null;
+    /**
+     * Search affiliates by username.
+     */
+    query?: string | null;
+    /**
+     * Statuses for resources
+     */
+    status?: Status | null;
+}
+export declare namespace Affiliates {
+    export { type Affiliate as Affiliate, type Status as Status, type AffiliateListResponse as AffiliateListResponse, type AffiliateArchiveResponse as AffiliateArchiveResponse, type AffiliateUnarchiveResponse as AffiliateUnarchiveResponse, type AffiliateListResponsesCursorPage as AffiliateListResponsesCursorPage, type AffiliateCreateParams as AffiliateCreateParams, type AffiliateListParams as AffiliateListParams, };
+    export { Overrides as Overrides, type AffiliateAppliesToPayments as AffiliateAppliesToPayments, type AffiliateAppliesToProducts as AffiliateAppliesToProducts, type AffiliateOverrideRoles as AffiliateOverrideRoles, type AffiliatePayoutTypes as AffiliatePayoutTypes, type AffiliateRevenueBases as AffiliateRevenueBases, type OverrideCreateResponse as OverrideCreateResponse, type OverrideRetrieveResponse as OverrideRetrieveResponse, type OverrideUpdateResponse as OverrideUpdateResponse, type OverrideListResponse as OverrideListResponse, type OverrideDeleteResponse as OverrideDeleteResponse, type OverrideListResponsesCursorPage as OverrideListResponsesCursorPage, type OverrideCreateParams as OverrideCreateParams, type OverrideRetrieveParams as OverrideRetrieveParams, type OverrideUpdateParams as OverrideUpdateParams, type OverrideListParams as OverrideListParams, type OverrideDeleteParams as OverrideDeleteParams, };
+}
+//# sourceMappingURL=affiliates.d.mts.map

package/resources/affiliates/affiliates.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"affiliates.d.mts","sourceRoot":"","sources":["../../src/resources/affiliates/affiliates.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,KAAK,YAAY;OACjB,EACL,0BAA0B,EAC1B,0BAA0B,EAC1B,sBAAsB,EACtB,oBAAoB,EACpB,qBAAqB,EACrB,oBAAoB,EACpB,sBAAsB,EACtB,oBAAoB,EACpB,sBAAsB,EACtB,kBAAkB,EAClB,oBAAoB,EACpB,+BAA+B,EAC/B,sBAAsB,EACtB,wBAAwB,EACxB,oBAAoB,EACpB,sBAAsB,EACtB,SAAS,EACV;OACM,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,UAAW,SAAQ,WAAW;IACzC,SAAS,EAAE,YAAY,CAAC,SAAS,CAA4C;IAE7E;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,IAAI,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,SAAS,CAAC;IAIpF;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,SAAS,CAAC;IAIrE;;;;;;;;;;;;;;;;;OAiBG;IACH,IAAI,CACF,KAAK,EAAE,mBAAmB,EAC1B,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,gCAAgC,EAAE,qBAAqB,CAAC;IAIvE;;;;;;;;;;;;;OAaG;IACH,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;IAInF;;;;;;;;;;;;;OAaG;IACH,SAAS,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,0BAA0B,CAAC;CAGxF;AAED,MAAM,MAAM,gCAAgC,GAAG,UAAU,CAAC,qBAAqB,CAAC,CAAC;AAEjF;;;GAGG;AACH,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,OAAO,EAAE,SAAS,CAAC,OAAO,CAAC;IAE3B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,uBAAuB,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACH,mCAAmC,EAAE,MAAM,CAAC;IAE5C;;;OAGG;IACH,6BAA6B,EAAE,MAAM,CAAC;IAEtC;;OAEG;IACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,qBAAqB,EAAE,MAAM,CAAC;IAE9B;;;OAGG;IACH,2BAA2B,EAAE,MAAM,CAAC;IAEpC;;OAEG;IACH,qBAAqB,EAAE,MAAM,CAAC;IAE9B;;;OAGG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,SAAS,CAAC,IAAI,CAAC;CACtB;AAED,yBAAiB,SAAS,CAAC;IACzB;;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;;;WAGG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;;WAGG;QACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;KACzB;CACF;AAED;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG,QAAQ,GAAG,UAAU,GAAG,SAAS,CAAC;AAEvD;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,OAAO,EAAE,qBAAqB,CAAC,OAAO,CAAC;IAEvC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,uBAAuB,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACH,mCAAmC,EAAE,MAAM,CAAC;IAE5C;;;OAGG;IACH,6BAA6B,EAAE,MAAM,CAAC;IAEtC;;OAEG;IACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,qBAAqB,EAAE,MAAM,CAAC;IAE9B;;;OAGG;IACH,2BAA2B,EAAE,MAAM,CAAC;IAEpC;;OAEG;IACH,qBAAqB,EAAE,MAAM,CAAC;IAE9B;;;OAGG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,qBAAqB,CAAC,IAAI,CAAC;CAClC;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;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;;;WAGG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;;WAGG;QACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;KACzB;CACF;AAED;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG,OAAO,CAAC;AAE/C;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAAG,OAAO,CAAC;AAEjD,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,mBAAoB,SAAQ,gBAAgB;IAC3D;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,IAAI,GAAG,YAAY,GAAG,wBAAwB,GAAG,sBAAsB,GAAG,IAAI,CAAC;IAEvF;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAID,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;IAEF,OAAO,EACL,SAAS,IAAI,SAAS,EACtB,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}