@whop/sdk 0.0.34 → 0.0.35

package/resources/affiliates/affiliates.d.ts

@@ -0,0 +1,345 @@
+import { APIResource } from "../../core/resource.js";
+import * as Shared from "../shared.js";
+import * as OverridesAPI from "./overrides.js";
+import { AffiliateAppliesToPayments, AffiliateAppliesToProducts, AffiliateOverrideRoles, AffiliatePayoutTypes, AffiliateRevenueBases, OverrideCreateParams, OverrideCreateResponse, OverrideDeleteParams, OverrideDeleteResponse, OverrideListParams, OverrideListResponse, OverrideListResponsesCursorPage, OverrideRetrieveParams, OverrideRetrieveResponse, OverrideUpdateParams, OverrideUpdateResponse, Overrides } from "./overrides.js";
+import { APIPromise } from "../../core/api-promise.js";
+import { CursorPage, type CursorPageParams, PagePromise } from "../../core/pagination.js";
+import { RequestOptions } from "../../internal/request-options.js";
+/**
+ * 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 of a company or a global affiliate
+ */
+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;
+    /**
+     * How many referrals have remained since they joined as members
+     */
+    customer_retention_rate: string;
+    /**
+     * A rolling 90-day retention rate for this affiliate
+     */
+    customer_retention_rate_ninety_days: string;
+    /**
+     * The total MRR of the affiliate
+     */
+    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 earnings of the affiliate from the users they referred
+     */
+    total_referral_earnings_usd: string;
+    /**
+     * The total referrals of the affiliate
+     */
+    total_referrals_count: number;
+    /**
+     * The total revenue of the affiliate from their referrals
+     */
+    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 of a company or a global affiliate
+ */
+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;
+    /**
+     * How many referrals have remained since they joined as members
+     */
+    customer_retention_rate: string;
+    /**
+     * A rolling 90-day retention rate for this affiliate
+     */
+    customer_retention_rate_ninety_days: string;
+    /**
+     * The total MRR of the affiliate
+     */
+    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 earnings of the affiliate from the users they referred
+     */
+    total_referral_earnings_usd: string;
+    /**
+     * The total referrals of the affiliate
+     */
+    total_referrals_count: number;
+    /**
+     * The total revenue of the affiliate from their referrals
+     */
+    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.ts.map

package/resources/affiliates/affiliates.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"affiliates.d.ts","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;;GAEG;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;;OAEG;IACH,6BAA6B,EAAE,MAAM,CAAC;IAEtC;;OAEG;IACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,qBAAqB,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,2BAA2B,EAAE,MAAM,CAAC;IAEpC;;OAEG;IACH,qBAAqB,EAAE,MAAM,CAAC;IAE9B;;OAEG;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;;GAEG;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;;OAEG;IACH,6BAA6B,EAAE,MAAM,CAAC;IAEtC;;OAEG;IACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,qBAAqB,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,2BAA2B,EAAE,MAAM,CAAC;IAEpC;;OAEG;IACH,qBAAqB,EAAE,MAAM,CAAC;IAE9B;;OAEG;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"}

package/resources/affiliates/affiliates.js

@@ -0,0 +1,112 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Affiliates = void 0;
+const tslib_1 = require("../../internal/tslib.js");
+const resource_1 = require("../../core/resource.js");
+const OverridesAPI = tslib_1.__importStar(require("./overrides.js"));
+const overrides_1 = require("./overrides.js");
+const pagination_1 = require("../../core/pagination.js");
+const path_1 = require("../../internal/utils/path.js");
+/**
+ * Affiliates
+ */
+class Affiliates extends resource_1.APIResource {
+    constructor() {
+        super(...arguments);
+        this.overrides = new OverridesAPI.Overrides(this._client);
+    }
+    /**
+     * 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, options) {
+        return this._client.post('/affiliates', { body, ...options });
+    }
+    /**
+     * Retrieves the details of an existing affiliate.
+     *
+     * Required permissions:
+     *
+     * - `affiliate:basic:read`
+     *
+     * @example
+     * ```ts
+     * const affiliate = await client.affiliates.retrieve(
+     *   'aff_xxxxxxxxxxxxxx',
+     * );
+     * ```
+     */
+    retrieve(id, options) {
+        return this._client.get((0, path_1.path) `/affiliates/${id}`, options);
+    }
+    /**
+     * 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, options) {
+        return this._client.getAPIList('/affiliates', (pagination_1.CursorPage), { query, ...options });
+    }
+    /**
+     * Archives an existing Affiliate
+     *
+     * Required permissions:
+     *
+     * - `affiliate:update`
+     *
+     * @example
+     * ```ts
+     * const response = await client.affiliates.archive(
+     *   'aff_xxxxxxxxxxxxxx',
+     * );
+     * ```
+     */
+    archive(id, options) {
+        return this._client.post((0, path_1.path) `/affiliates/${id}/archive`, options);
+    }
+    /**
+     * Unarchives an existing Affiliate
+     *
+     * Required permissions:
+     *
+     * - `affiliate:update`
+     *
+     * @example
+     * ```ts
+     * const response = await client.affiliates.unarchive(
+     *   'aff_xxxxxxxxxxxxxx',
+     * );
+     * ```
+     */
+    unarchive(id, options) {
+        return this._client.post((0, path_1.path) `/affiliates/${id}/unarchive`, options);
+    }
+}
+exports.Affiliates = Affiliates;
+Affiliates.Overrides = overrides_1.Overrides;
+//# sourceMappingURL=affiliates.js.map

package/resources/affiliates/affiliates.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"affiliates.js","sourceRoot":"","sources":["../../src/resources/affiliates/affiliates.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAElD,qEAA4C;AAC5C,8CAkBqB;AAErB,yDAAuF;AAEvF,uDAAiD;AAEjD;;GAEG;AACH,MAAa,UAAW,SAAQ,sBAAW;IAA3C;;QACE,cAAS,GAA2B,IAAI,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAmG/E,CAAC;IAjGC;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,IAA2B,EAAE,OAAwB;QAC1D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,eAAe,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,IAAI,CACF,KAA0B,EAC1B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,aAAa,EAAE,CAAA,uBAAiC,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1G,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,OAAO,CAAC,EAAU,EAAE,OAAwB;QAC1C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,eAAe,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;IACrE,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,SAAS,CAAC,EAAU,EAAE,OAAwB;QAC5C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,eAAe,EAAE,YAAY,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;CACF;AApGD,gCAoGC;AA6SD,UAAU,CAAC,SAAS,GAAG,qBAAS,CAAC"}

package/resources/affiliates/affiliates.mjs

@@ -0,0 +1,107 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../core/resource.mjs";
+import * as OverridesAPI from "./overrides.mjs";
+import { Overrides, } from "./overrides.mjs";
+import { CursorPage } from "../../core/pagination.mjs";
+import { path } from "../../internal/utils/path.mjs";
+/**
+ * Affiliates
+ */
+export class Affiliates extends APIResource {
+    constructor() {
+        super(...arguments);
+        this.overrides = new OverridesAPI.Overrides(this._client);
+    }
+    /**
+     * 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, options) {
+        return this._client.post('/affiliates', { body, ...options });
+    }
+    /**
+     * Retrieves the details of an existing affiliate.
+     *
+     * Required permissions:
+     *
+     * - `affiliate:basic:read`
+     *
+     * @example
+     * ```ts
+     * const affiliate = await client.affiliates.retrieve(
+     *   'aff_xxxxxxxxxxxxxx',
+     * );
+     * ```
+     */
+    retrieve(id, options) {
+        return this._client.get(path `/affiliates/${id}`, options);
+    }
+    /**
+     * 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, options) {
+        return this._client.getAPIList('/affiliates', (CursorPage), { query, ...options });
+    }
+    /**
+     * Archives an existing Affiliate
+     *
+     * Required permissions:
+     *
+     * - `affiliate:update`
+     *
+     * @example
+     * ```ts
+     * const response = await client.affiliates.archive(
+     *   'aff_xxxxxxxxxxxxxx',
+     * );
+     * ```
+     */
+    archive(id, options) {
+        return this._client.post(path `/affiliates/${id}/archive`, options);
+    }
+    /**
+     * Unarchives an existing Affiliate
+     *
+     * Required permissions:
+     *
+     * - `affiliate:update`
+     *
+     * @example
+     * ```ts
+     * const response = await client.affiliates.unarchive(
+     *   'aff_xxxxxxxxxxxxxx',
+     * );
+     * ```
+     */
+    unarchive(id, options) {
+        return this._client.post(path `/affiliates/${id}/unarchive`, options);
+    }
+}
+Affiliates.Overrides = Overrides;
+//# sourceMappingURL=affiliates.mjs.map

package/resources/affiliates/affiliates.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"affiliates.mjs","sourceRoot":"","sources":["../../src/resources/affiliates/affiliates.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,KAAK,YAAY;OACjB,EAiBL,SAAS,GACV;OAEM,EAAE,UAAU,EAAsC;OAElD,EAAE,IAAI,EAAE;AAEf;;GAEG;AACH,MAAM,OAAO,UAAW,SAAQ,WAAW;IAA3C;;QACE,cAAS,GAA2B,IAAI,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAmG/E,CAAC;IAjGC;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,IAA2B,EAAE,OAAwB;QAC1D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,eAAe,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,IAAI,CACF,KAA0B,EAC1B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,aAAa,EAAE,CAAA,UAAiC,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1G,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,OAAO,CAAC,EAAU,EAAE,OAAwB;QAC1C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,eAAe,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;IACrE,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,SAAS,CAAC,EAAU,EAAE,OAAwB;QAC5C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,eAAe,EAAE,YAAY,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;CACF;AA6SD,UAAU,CAAC,SAAS,GAAG,SAAS,CAAC"}

package/resources/affiliates/index.d.mts

@@ -0,0 +1,3 @@
+export { Affiliates, type Affiliate, type Status, type AffiliateListResponse, type AffiliateArchiveResponse, type AffiliateUnarchiveResponse, type AffiliateCreateParams, type AffiliateListParams, type AffiliateListResponsesCursorPage, } from "./affiliates.mjs";
+export { Overrides, type AffiliateAppliesToPayments, type AffiliateAppliesToProducts, type AffiliateOverrideRoles, type AffiliatePayoutTypes, type AffiliateRevenueBases, type OverrideCreateResponse, type OverrideRetrieveResponse, type OverrideUpdateResponse, type OverrideListResponse, type OverrideDeleteResponse, type OverrideCreateParams, type OverrideRetrieveParams, type OverrideUpdateParams, type OverrideListParams, type OverrideDeleteParams, type OverrideListResponsesCursorPage, } from "./overrides.mjs";
+//# sourceMappingURL=index.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/resources/affiliates/index.ts"],"names":[],"mappings":"OAEO,EACL,UAAU,EACV,KAAK,SAAS,EACd,KAAK,MAAM,EACX,KAAK,qBAAqB,EAC1B,KAAK,wBAAwB,EAC7B,KAAK,0BAA0B,EAC/B,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,gCAAgC,GACtC;OACM,EACL,SAAS,EACT,KAAK,0BAA0B,EAC/B,KAAK,0BAA0B,EAC/B,KAAK,sBAAsB,EAC3B,KAAK,oBAAoB,EACzB,KAAK,qBAAqB,EAC1B,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,EAC7B,KAAK,sBAAsB,EAC3B,KAAK,oBAAoB,EACzB,KAAK,sBAAsB,EAC3B,KAAK,oBAAoB,EACzB,KAAK,sBAAsB,EAC3B,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,oBAAoB,EACzB,KAAK,+BAA+B,GACrC"}

package/resources/affiliates/index.d.ts

@@ -0,0 +1,3 @@
+export { Affiliates, type Affiliate, type Status, type AffiliateListResponse, type AffiliateArchiveResponse, type AffiliateUnarchiveResponse, type AffiliateCreateParams, type AffiliateListParams, type AffiliateListResponsesCursorPage, } from "./affiliates.js";
+export { Overrides, type AffiliateAppliesToPayments, type AffiliateAppliesToProducts, type AffiliateOverrideRoles, type AffiliatePayoutTypes, type AffiliateRevenueBases, type OverrideCreateResponse, type OverrideRetrieveResponse, type OverrideUpdateResponse, type OverrideListResponse, type OverrideDeleteResponse, type OverrideCreateParams, type OverrideRetrieveParams, type OverrideUpdateParams, type OverrideListParams, type OverrideDeleteParams, type OverrideListResponsesCursorPage, } from "./overrides.js";
+//# sourceMappingURL=index.d.ts.map

package/resources/affiliates/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/resources/affiliates/index.ts"],"names":[],"mappings":"OAEO,EACL,UAAU,EACV,KAAK,SAAS,EACd,KAAK,MAAM,EACX,KAAK,qBAAqB,EAC1B,KAAK,wBAAwB,EAC7B,KAAK,0BAA0B,EAC/B,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,gCAAgC,GACtC;OACM,EACL,SAAS,EACT,KAAK,0BAA0B,EAC/B,KAAK,0BAA0B,EAC/B,KAAK,sBAAsB,EAC3B,KAAK,oBAAoB,EACzB,KAAK,qBAAqB,EAC1B,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,EAC7B,KAAK,sBAAsB,EAC3B,KAAK,oBAAoB,EACzB,KAAK,sBAAsB,EAC3B,KAAK,oBAAoB,EACzB,KAAK,sBAAsB,EAC3B,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,oBAAoB,EACzB,KAAK,+BAA+B,GACrC"}

package/resources/affiliates/index.js

@@ -0,0 +1,9 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Overrides = exports.Affiliates = void 0;
+var affiliates_1 = require("./affiliates.js");
+Object.defineProperty(exports, "Affiliates", { enumerable: true, get: function () { return affiliates_1.Affiliates; } });
+var overrides_1 = require("./overrides.js");
+Object.defineProperty(exports, "Overrides", { enumerable: true, get: function () { return overrides_1.Overrides; } });
+//# sourceMappingURL=index.js.map

package/resources/affiliates/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/resources/affiliates/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,8CAUsB;AATpB,wGAAA,UAAU,OAAA;AAUZ,4CAkBqB;AAjBnB,sGAAA,SAAS,OAAA"}

package/resources/affiliates/index.mjs

@@ -0,0 +1,4 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+export { Affiliates, } from "./affiliates.mjs";
+export { Overrides, } from "./overrides.mjs";
+//# sourceMappingURL=index.mjs.map

package/resources/affiliates/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/resources/affiliates/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EACL,UAAU,GASX;OACM,EACL,SAAS,GAiBV"}