@whop/sdk 0.0.38 → 0.0.40

package/resources/ad-campaigns.d.mts

@@ -0,0 +1,296 @@
+import { APIResource } from "../core/resource.mjs";
+import * as AdGroupsAPI from "./ad-groups.mjs";
+import { APIPromise } from "../core/api-promise.mjs";
+import { CursorPage, type CursorPageParams, PagePromise } from "../core/pagination.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+/**
+ * Ad campaigns
+ */
+export declare class AdCampaigns extends APIResource {
+    /**
+     * Returns a paginated list of ad campaigns for a company, with optional filtering
+     * by status, and creation date.
+     *
+     * Required permissions:
+     *
+     * - `ad_campaign:basic:read`
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const adCampaignListResponse of client.adCampaigns.list()) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(query?: AdCampaignListParams | null | undefined, options?: RequestOptions): PagePromise<AdCampaignListResponsesCursorPage, AdCampaignListResponse>;
+    /**
+     * Retrieves a single ad campaign by its unique identifier.
+     *
+     * Required permissions:
+     *
+     * - `ad_campaign:basic:read`
+     *
+     * @example
+     * ```ts
+     * const adCampaign = await client.adCampaigns.retrieve(
+     *   'adcamp_xxxxxxxxxxx',
+     * );
+     * ```
+     */
+    retrieve(id: string, options?: RequestOptions): APIPromise<AdCampaign>;
+    /**
+     * Updates an ad campaign synchronously.
+     *
+     * Required permissions:
+     *
+     * - `ad_campaign:update`
+     *
+     * @example
+     * ```ts
+     * const adCampaign = await client.adCampaigns.update(
+     *   'adcamp_xxxxxxxxxxx',
+     * );
+     * ```
+     */
+    update(id: string, body?: AdCampaignUpdateParams | null | undefined, options?: RequestOptions): APIPromise<AdCampaign>;
+    /**
+     * Pauses an ad campaign, optionally until a specific date.
+     *
+     * Required permissions:
+     *
+     * - `ad_campaign:update`
+     *
+     * @example
+     * ```ts
+     * const adCampaign = await client.adCampaigns.pause(
+     *   'adcamp_xxxxxxxxxxx',
+     * );
+     * ```
+     */
+    pause(id: string, options?: RequestOptions): APIPromise<AdCampaign>;
+    /**
+     * Resumes a paused ad campaign.
+     *
+     * Required permissions:
+     *
+     * - `ad_campaign:update`
+     *
+     * @example
+     * ```ts
+     * const adCampaign = await client.adCampaigns.unpause(
+     *   'adcamp_xxxxxxxxxxx',
+     * );
+     * ```
+     */
+    unpause(id: string, options?: RequestOptions): APIPromise<AdCampaign>;
+}
+export type AdCampaignListResponsesCursorPage = CursorPage<AdCampaignListResponse>;
+/**
+ * An advertising campaign running on an external platform or within Whop.
+ */
+export interface AdCampaign {
+    /**
+     * The unique identifier for this ad campaign.
+     */
+    id: string;
+    /**
+     * Total budget in dollars.
+     */
+    budget: number | null;
+    /**
+     * The budget type for an ad campaign or ad group.
+     */
+    budget_type: AdGroupsAPI.AdBudgetType | null;
+    /**
+     * When the ad campaign was created.
+     */
+    created_at: string;
+    /**
+     * The user who created this ad campaign.
+     */
+    created_by_user: AdCampaign.CreatedByUser;
+    /**
+     * Meta-specific campaign configuration (objective, budget mode, etc.). Null for
+     * non-Meta campaigns.
+     */
+    meta_config: AdCampaign.MetaConfig | null;
+    /**
+     * The external ad platform this campaign is running on (e.g., meta, tiktok).
+     */
+    platform: AdCampaignPlatform;
+    /**
+     * Current status of the campaign (active, paused, or inactive).
+     */
+    status: AdCampaignStatus;
+    /**
+     * The campaign name shown in the Whop dashboard.
+     */
+    title: string;
+    /**
+     * Total amount spent in dollars.
+     */
+    total_spend: number;
+    /**
+     * When the ad campaign was last updated.
+     */
+    updated_at: string;
+}
+export declare namespace AdCampaign {
+    /**
+     * The user who created this ad campaign.
+     */
+    interface CreatedByUser {
+        /**
+         * The unique identifier for the user.
+         */
+        id: string;
+        /**
+         * The user's display name shown on their public profile.
+         */
+        name: string | null;
+        /**
+         * The user's unique username shown on their public profile.
+         */
+        username: string;
+    }
+    /**
+     * Meta-specific campaign configuration (objective, budget mode, etc.). Null for
+     * non-Meta campaigns.
+     */
+    interface MetaConfig {
+        /**
+         * Bid cap amount in cents. Only used when bid_strategy is bid_cap.
+         */
+        bid_amount: number | null;
+        /**
+         * The bidding strategy used to optimize spend for this campaign.
+         */
+        bid_strategy: 'lowest_cost' | 'bid_cap' | 'cost_cap' | null;
+        /**
+         * Whether campaign budget optimization (CBO) is enabled, allowing the platform to
+         * distribute budget across ad groups.
+         */
+        budget_optimization: boolean | null;
+        /**
+         * The actual delivery status, accounting for platform overrides (e.g., in_review,
+         * rejected).
+         */
+        effective_status: 'active' | 'paused' | 'deleted' | 'in_review' | 'rejected' | 'with_issues' | null;
+        /**
+         * The scheduled end time of the campaign (ISO8601).
+         */
+        end_time: string | null;
+        /**
+         * The campaign objective that determines how Meta optimizes delivery.
+         */
+        objective: 'awareness' | 'traffic' | 'engagement' | 'leads' | 'sales' | null;
+        /**
+         * Special ad categories required by the platform (e.g., housing, employment,
+         * credit).
+         */
+        special_categories: Array<string> | null;
+        /**
+         * The scheduled start time of the campaign (ISO8601).
+         */
+        start_time: string | null;
+        /**
+         * The campaign status as set by the advertiser (active or paused).
+         */
+        status: 'active' | 'paused' | null;
+    }
+}
+/**
+ * The platforms where an ad campaign can run.
+ */
+export type AdCampaignPlatform = 'meta' | 'tiktok';
+/**
+ * The status of an ad campaign.
+ */
+export type AdCampaignStatus = 'active' | 'paused' | 'payment_failed' | 'draft' | 'in_review' | 'flagged';
+/**
+ * An advertising campaign running on an external platform or within Whop.
+ */
+export interface AdCampaignListResponse {
+    /**
+     * The unique identifier for this ad campaign.
+     */
+    id: string;
+    /**
+     * Total budget in dollars.
+     */
+    budget: number | null;
+    /**
+     * The budget type for an ad campaign or ad group.
+     */
+    budget_type: AdGroupsAPI.AdBudgetType | null;
+    /**
+     * When the ad campaign was created.
+     */
+    created_at: string;
+    /**
+     * The external ad platform this campaign is running on (e.g., meta, tiktok).
+     */
+    platform: AdCampaignPlatform;
+    /**
+     * Current status of the campaign (active, paused, or inactive).
+     */
+    status: AdCampaignStatus;
+    /**
+     * The campaign name shown in the Whop dashboard.
+     */
+    title: string;
+    /**
+     * Total amount spent in dollars.
+     */
+    total_spend: number;
+    /**
+     * When the ad campaign was last updated.
+     */
+    updated_at: string;
+}
+export interface AdCampaignListParams extends CursorPageParams {
+    /**
+     * Returns the elements in the list that come before the specified cursor.
+     */
+    before?: string | null;
+    /**
+     * The unique identifier of the company to list ad campaigns for.
+     */
+    company_id?: string | null;
+    /**
+     * Only return ad campaigns created after this timestamp.
+     */
+    created_after?: string | null;
+    /**
+     * Only return ad campaigns created before this timestamp.
+     */
+    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;
+    /**
+     * Case-insensitive substring match against the campaign title.
+     */
+    query?: string | null;
+    /**
+     * The status of an ad campaign.
+     */
+    status?: AdCampaignStatus | null;
+}
+export interface AdCampaignUpdateParams {
+    /**
+     * The campaign budget in dollars. The interpretation (daily or lifetime) follows
+     * the campaign's existing budget type.
+     */
+    budget?: number | null;
+}
+export declare namespace AdCampaigns {
+    export { type AdCampaign as AdCampaign, type AdCampaignPlatform as AdCampaignPlatform, type AdCampaignStatus as AdCampaignStatus, type AdCampaignListResponse as AdCampaignListResponse, type AdCampaignListResponsesCursorPage as AdCampaignListResponsesCursorPage, type AdCampaignListParams as AdCampaignListParams, type AdCampaignUpdateParams as AdCampaignUpdateParams, };
+}
+//# sourceMappingURL=ad-campaigns.d.mts.map

package/resources/ad-campaigns.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ad-campaigns.d.mts","sourceRoot":"","sources":["../src/resources/ad-campaigns.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,WAAW;OAChB,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;;OAeG;IACH,IAAI,CACF,KAAK,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,iCAAiC,EAAE,sBAAsB,CAAC;IAOzE;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,UAAU,CAAC;IAItE;;;;;;;;;;;;;OAaG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,UAAU,CAAC;IAIzB;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,UAAU,CAAC;IAInE;;;;;;;;;;;;;OAaG;IACH,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,UAAU,CAAC;CAGtE;AAED,MAAM,MAAM,iCAAiC,GAAG,UAAU,CAAC,sBAAsB,CAAC,CAAC;AAEnF;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,WAAW,EAAE,WAAW,CAAC,YAAY,GAAG,IAAI,CAAC;IAE7C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,eAAe,EAAE,UAAU,CAAC,aAAa,CAAC;IAE1C;;;OAGG;IACH,WAAW,EAAE,UAAU,CAAC,UAAU,GAAG,IAAI,CAAC;IAE1C;;OAEG;IACH,QAAQ,EAAE,kBAAkB,CAAC;IAE7B;;OAEG;IACH,MAAM,EAAE,gBAAgB,CAAC;IAEzB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,yBAAiB,UAAU,CAAC;IAC1B;;OAEG;IACH,UAAiB,aAAa;QAC5B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;KAClB;IAED;;;OAGG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;WAEG;QACH,YAAY,EAAE,aAAa,GAAG,SAAS,GAAG,UAAU,GAAG,IAAI,CAAC;QAE5D;;;WAGG;QACH,mBAAmB,EAAE,OAAO,GAAG,IAAI,CAAC;QAEpC;;;WAGG;QACH,gBAAgB,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,WAAW,GAAG,UAAU,GAAG,aAAa,GAAG,IAAI,CAAC;QAEpG;;WAEG;QACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,SAAS,EAAE,WAAW,GAAG,SAAS,GAAG,YAAY,GAAG,OAAO,GAAG,OAAO,GAAG,IAAI,CAAC;QAE7E;;;WAGG;QACH,kBAAkB,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;QAEzC;;WAEG;QACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;WAEG;QACH,MAAM,EAAE,QAAQ,GAAG,QAAQ,GAAG,IAAI,CAAC;KACpC;CACF;AAED;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,MAAM,GAAG,QAAQ,CAAC;AAEnD;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,QAAQ,GAAG,QAAQ,GAAG,gBAAgB,GAAG,OAAO,GAAG,WAAW,GAAG,SAAS,CAAC;AAE1G;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,WAAW,EAAE,WAAW,CAAC,YAAY,GAAG,IAAI,CAAC;IAE7C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,kBAAkB,CAAC;IAE7B;;OAEG;IACH,MAAM,EAAE,gBAAgB,CAAC;IAEzB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,oBAAqB,SAAQ,gBAAgB;IAC5D;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;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,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,MAAM,CAAC,EAAE,gBAAgB,GAAG,IAAI,CAAC;CAClC;AAED,MAAM,WAAW,sBAAsB;IACrC;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}

package/resources/ad-campaigns.d.ts

@@ -0,0 +1,296 @@
+import { APIResource } from "../core/resource.js";
+import * as AdGroupsAPI from "./ad-groups.js";
+import { APIPromise } from "../core/api-promise.js";
+import { CursorPage, type CursorPageParams, PagePromise } from "../core/pagination.js";
+import { RequestOptions } from "../internal/request-options.js";
+/**
+ * Ad campaigns
+ */
+export declare class AdCampaigns extends APIResource {
+    /**
+     * Returns a paginated list of ad campaigns for a company, with optional filtering
+     * by status, and creation date.
+     *
+     * Required permissions:
+     *
+     * - `ad_campaign:basic:read`
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const adCampaignListResponse of client.adCampaigns.list()) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(query?: AdCampaignListParams | null | undefined, options?: RequestOptions): PagePromise<AdCampaignListResponsesCursorPage, AdCampaignListResponse>;
+    /**
+     * Retrieves a single ad campaign by its unique identifier.
+     *
+     * Required permissions:
+     *
+     * - `ad_campaign:basic:read`
+     *
+     * @example
+     * ```ts
+     * const adCampaign = await client.adCampaigns.retrieve(
+     *   'adcamp_xxxxxxxxxxx',
+     * );
+     * ```
+     */
+    retrieve(id: string, options?: RequestOptions): APIPromise<AdCampaign>;
+    /**
+     * Updates an ad campaign synchronously.
+     *
+     * Required permissions:
+     *
+     * - `ad_campaign:update`
+     *
+     * @example
+     * ```ts
+     * const adCampaign = await client.adCampaigns.update(
+     *   'adcamp_xxxxxxxxxxx',
+     * );
+     * ```
+     */
+    update(id: string, body?: AdCampaignUpdateParams | null | undefined, options?: RequestOptions): APIPromise<AdCampaign>;
+    /**
+     * Pauses an ad campaign, optionally until a specific date.
+     *
+     * Required permissions:
+     *
+     * - `ad_campaign:update`
+     *
+     * @example
+     * ```ts
+     * const adCampaign = await client.adCampaigns.pause(
+     *   'adcamp_xxxxxxxxxxx',
+     * );
+     * ```
+     */
+    pause(id: string, options?: RequestOptions): APIPromise<AdCampaign>;
+    /**
+     * Resumes a paused ad campaign.
+     *
+     * Required permissions:
+     *
+     * - `ad_campaign:update`
+     *
+     * @example
+     * ```ts
+     * const adCampaign = await client.adCampaigns.unpause(
+     *   'adcamp_xxxxxxxxxxx',
+     * );
+     * ```
+     */
+    unpause(id: string, options?: RequestOptions): APIPromise<AdCampaign>;
+}
+export type AdCampaignListResponsesCursorPage = CursorPage<AdCampaignListResponse>;
+/**
+ * An advertising campaign running on an external platform or within Whop.
+ */
+export interface AdCampaign {
+    /**
+     * The unique identifier for this ad campaign.
+     */
+    id: string;
+    /**
+     * Total budget in dollars.
+     */
+    budget: number | null;
+    /**
+     * The budget type for an ad campaign or ad group.
+     */
+    budget_type: AdGroupsAPI.AdBudgetType | null;
+    /**
+     * When the ad campaign was created.
+     */
+    created_at: string;
+    /**
+     * The user who created this ad campaign.
+     */
+    created_by_user: AdCampaign.CreatedByUser;
+    /**
+     * Meta-specific campaign configuration (objective, budget mode, etc.). Null for
+     * non-Meta campaigns.
+     */
+    meta_config: AdCampaign.MetaConfig | null;
+    /**
+     * The external ad platform this campaign is running on (e.g., meta, tiktok).
+     */
+    platform: AdCampaignPlatform;
+    /**
+     * Current status of the campaign (active, paused, or inactive).
+     */
+    status: AdCampaignStatus;
+    /**
+     * The campaign name shown in the Whop dashboard.
+     */
+    title: string;
+    /**
+     * Total amount spent in dollars.
+     */
+    total_spend: number;
+    /**
+     * When the ad campaign was last updated.
+     */
+    updated_at: string;
+}
+export declare namespace AdCampaign {
+    /**
+     * The user who created this ad campaign.
+     */
+    interface CreatedByUser {
+        /**
+         * The unique identifier for the user.
+         */
+        id: string;
+        /**
+         * The user's display name shown on their public profile.
+         */
+        name: string | null;
+        /**
+         * The user's unique username shown on their public profile.
+         */
+        username: string;
+    }
+    /**
+     * Meta-specific campaign configuration (objective, budget mode, etc.). Null for
+     * non-Meta campaigns.
+     */
+    interface MetaConfig {
+        /**
+         * Bid cap amount in cents. Only used when bid_strategy is bid_cap.
+         */
+        bid_amount: number | null;
+        /**
+         * The bidding strategy used to optimize spend for this campaign.
+         */
+        bid_strategy: 'lowest_cost' | 'bid_cap' | 'cost_cap' | null;
+        /**
+         * Whether campaign budget optimization (CBO) is enabled, allowing the platform to
+         * distribute budget across ad groups.
+         */
+        budget_optimization: boolean | null;
+        /**
+         * The actual delivery status, accounting for platform overrides (e.g., in_review,
+         * rejected).
+         */
+        effective_status: 'active' | 'paused' | 'deleted' | 'in_review' | 'rejected' | 'with_issues' | null;
+        /**
+         * The scheduled end time of the campaign (ISO8601).
+         */
+        end_time: string | null;
+        /**
+         * The campaign objective that determines how Meta optimizes delivery.
+         */
+        objective: 'awareness' | 'traffic' | 'engagement' | 'leads' | 'sales' | null;
+        /**
+         * Special ad categories required by the platform (e.g., housing, employment,
+         * credit).
+         */
+        special_categories: Array<string> | null;
+        /**
+         * The scheduled start time of the campaign (ISO8601).
+         */
+        start_time: string | null;
+        /**
+         * The campaign status as set by the advertiser (active or paused).
+         */
+        status: 'active' | 'paused' | null;
+    }
+}
+/**
+ * The platforms where an ad campaign can run.
+ */
+export type AdCampaignPlatform = 'meta' | 'tiktok';
+/**
+ * The status of an ad campaign.
+ */
+export type AdCampaignStatus = 'active' | 'paused' | 'payment_failed' | 'draft' | 'in_review' | 'flagged';
+/**
+ * An advertising campaign running on an external platform or within Whop.
+ */
+export interface AdCampaignListResponse {
+    /**
+     * The unique identifier for this ad campaign.
+     */
+    id: string;
+    /**
+     * Total budget in dollars.
+     */
+    budget: number | null;
+    /**
+     * The budget type for an ad campaign or ad group.
+     */
+    budget_type: AdGroupsAPI.AdBudgetType | null;
+    /**
+     * When the ad campaign was created.
+     */
+    created_at: string;
+    /**
+     * The external ad platform this campaign is running on (e.g., meta, tiktok).
+     */
+    platform: AdCampaignPlatform;
+    /**
+     * Current status of the campaign (active, paused, or inactive).
+     */
+    status: AdCampaignStatus;
+    /**
+     * The campaign name shown in the Whop dashboard.
+     */
+    title: string;
+    /**
+     * Total amount spent in dollars.
+     */
+    total_spend: number;
+    /**
+     * When the ad campaign was last updated.
+     */
+    updated_at: string;
+}
+export interface AdCampaignListParams extends CursorPageParams {
+    /**
+     * Returns the elements in the list that come before the specified cursor.
+     */
+    before?: string | null;
+    /**
+     * The unique identifier of the company to list ad campaigns for.
+     */
+    company_id?: string | null;
+    /**
+     * Only return ad campaigns created after this timestamp.
+     */
+    created_after?: string | null;
+    /**
+     * Only return ad campaigns created before this timestamp.
+     */
+    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;
+    /**
+     * Case-insensitive substring match against the campaign title.
+     */
+    query?: string | null;
+    /**
+     * The status of an ad campaign.
+     */
+    status?: AdCampaignStatus | null;
+}
+export interface AdCampaignUpdateParams {
+    /**
+     * The campaign budget in dollars. The interpretation (daily or lifetime) follows
+     * the campaign's existing budget type.
+     */
+    budget?: number | null;
+}
+export declare namespace AdCampaigns {
+    export { type AdCampaign as AdCampaign, type AdCampaignPlatform as AdCampaignPlatform, type AdCampaignStatus as AdCampaignStatus, type AdCampaignListResponse as AdCampaignListResponse, type AdCampaignListResponsesCursorPage as AdCampaignListResponsesCursorPage, type AdCampaignListParams as AdCampaignListParams, type AdCampaignUpdateParams as AdCampaignUpdateParams, };
+}
+//# sourceMappingURL=ad-campaigns.d.ts.map

package/resources/ad-campaigns.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ad-campaigns.d.ts","sourceRoot":"","sources":["../src/resources/ad-campaigns.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,WAAW;OAChB,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;;OAeG;IACH,IAAI,CACF,KAAK,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,iCAAiC,EAAE,sBAAsB,CAAC;IAOzE;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,UAAU,CAAC;IAItE;;;;;;;;;;;;;OAaG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,UAAU,CAAC;IAIzB;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,UAAU,CAAC;IAInE;;;;;;;;;;;;;OAaG;IACH,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,UAAU,CAAC;CAGtE;AAED,MAAM,MAAM,iCAAiC,GAAG,UAAU,CAAC,sBAAsB,CAAC,CAAC;AAEnF;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,WAAW,EAAE,WAAW,CAAC,YAAY,GAAG,IAAI,CAAC;IAE7C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,eAAe,EAAE,UAAU,CAAC,aAAa,CAAC;IAE1C;;;OAGG;IACH,WAAW,EAAE,UAAU,CAAC,UAAU,GAAG,IAAI,CAAC;IAE1C;;OAEG;IACH,QAAQ,EAAE,kBAAkB,CAAC;IAE7B;;OAEG;IACH,MAAM,EAAE,gBAAgB,CAAC;IAEzB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,yBAAiB,UAAU,CAAC;IAC1B;;OAEG;IACH,UAAiB,aAAa;QAC5B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;KAClB;IAED;;;OAGG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;WAEG;QACH,YAAY,EAAE,aAAa,GAAG,SAAS,GAAG,UAAU,GAAG,IAAI,CAAC;QAE5D;;;WAGG;QACH,mBAAmB,EAAE,OAAO,GAAG,IAAI,CAAC;QAEpC;;;WAGG;QACH,gBAAgB,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,WAAW,GAAG,UAAU,GAAG,aAAa,GAAG,IAAI,CAAC;QAEpG;;WAEG;QACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,SAAS,EAAE,WAAW,GAAG,SAAS,GAAG,YAAY,GAAG,OAAO,GAAG,OAAO,GAAG,IAAI,CAAC;QAE7E;;;WAGG;QACH,kBAAkB,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;QAEzC;;WAEG;QACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;WAEG;QACH,MAAM,EAAE,QAAQ,GAAG,QAAQ,GAAG,IAAI,CAAC;KACpC;CACF;AAED;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,MAAM,GAAG,QAAQ,CAAC;AAEnD;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,QAAQ,GAAG,QAAQ,GAAG,gBAAgB,GAAG,OAAO,GAAG,WAAW,GAAG,SAAS,CAAC;AAE1G;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,WAAW,EAAE,WAAW,CAAC,YAAY,GAAG,IAAI,CAAC;IAE7C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,kBAAkB,CAAC;IAE7B;;OAEG;IACH,MAAM,EAAE,gBAAgB,CAAC;IAEzB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,oBAAqB,SAAQ,gBAAgB;IAC5D;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;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,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,MAAM,CAAC,EAAE,gBAAgB,GAAG,IAAI,CAAC;CAClC;AAED,MAAM,WAAW,sBAAsB;IACrC;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}