@whop/sdk 0.0.38 → 0.0.40

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

@@ -0,0 +1 @@
+{"version":3,"file":"ad-reports.d.mts","sourceRoot":"","sources":["../src/resources/ad-reports.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,YAAY;OACjB,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB;;GAEG;AACH,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,KAAK,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;CAGxG;AAED;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,OAAO,GAAG,QAAQ,CAAC;AAE/C;;GAEG;AACH,MAAM,MAAM,eAAe,GACvB,cAAc,GACd,iCAAiC,GACjC,iBAAiB,GACjB,iBAAiB,GACjB,aAAa,GACb,mBAAmB,GACnB,oBAAoB,GACpB,OAAO,GACP,aAAa,GACb,eAAe,GACf,qBAAqB,GACrB,qBAAqB,GACrB,YAAY,GACZ,0BAA0B,GAC1B,OAAO,GACP,eAAe,GACf,iBAAiB,GACjB,aAAa,GACb,eAAe,GACf,eAAe,GACf,UAAU,GACV,mBAAmB,GACnB,6BAA6B,GAC7B,QAAQ,CAAC;AAEb;;;;GAIG;AACH,MAAM,WAAW,wBAAwB;IACvC;;;;OAIG;IACH,SAAS,EAAE,KAAK,CAAC,wBAAwB,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC;IAE5D;;;;OAIG;IACH,WAAW,EAAE,KAAK,CAAC,wBAAwB,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC;IAEhE;;OAEG;IACH,OAAO,EAAE,wBAAwB,CAAC,OAAO,CAAC;CAC3C;AAED,yBAAiB,wBAAwB,CAAC;IACxC;;;OAGG;IACH,UAAiB,SAAS;QACxB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;;;WAIG;QACH,WAAW,EAAE,KAAK,CAAC,SAAS,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC;QAEjD;;WAEG;QACH,KAAK,EAAE,UAAU,GAAG,UAAU,GAAG,IAAI,CAAC;QAEtC;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,OAAO,EAAE,SAAS,CAAC,OAAO,CAAC;KAC5B;IAED,UAAiB,SAAS,CAAC;QACzB;;;WAGG;QACH,UAAiB,WAAW;YAC1B;;;;eAIG;YACH,YAAY,EAAE,MAAM,CAAC;YAErB;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,WAAW,EAAE,YAAY,CAAC,aAAa,CAAC;YAExC;;eAEG;YACH,WAAW,EAAE,MAAM,CAAC;YAEpB;;;eAGG;YACH,KAAK,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;YAE5B;;eAEG;YACH,gBAAgB,EAAE,YAAY,CAAC,eAAe,GAAG,IAAI,CAAC;YAEtD;;eAEG;YACH,qBAAqB,EAAE,MAAM,GAAG,IAAI,CAAC;YAErC;;;eAGG;YACH,KAAK,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,cAAc,EAAE,MAAM,CAAC,QAAQ,CAAC;YAEhC;;;eAGG;YACH,SAAS,EAAE,MAAM,CAAC;YAElB;;;eAGG;YACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;SAC1B;QAED;;WAEG;QACH,UAAiB,OAAO;YACtB;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;YAE/B;;eAEG;YACH,GAAG,EAAE,MAAM,CAAC;YAEZ;;eAEG;YACH,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;YAEnB;;eAEG;YACH,GAAG,EAAE,MAAM,CAAC;YAEZ;;eAEG;YACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB;;eAEG;YACH,WAAW,EAAE,MAAM,CAAC;YAEpB;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;YAEd;;;eAGG;YACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;YAE5B;;eAEG;YACH,gBAAgB,EAAE,YAAY,CAAC,eAAe,GAAG,IAAI,CAAC;YAEtD;;eAEG;YACH,qBAAqB,EAAE,MAAM,GAAG,IAAI,CAAC;YAErC;;;eAGG;YACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;YAEpB;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,cAAc,EAAE,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC;SACxC;KACF;IAED;;;OAGG;IACH,UAAiB,WAAW;QAC1B;;;;WAIG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,WAAW,EAAE,YAAY,CAAC,aAAa,CAAC;QAExC;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;;WAGG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,gBAAgB,EAAE,YAAY,CAAC,eAAe,GAAG,IAAI,CAAC;QAEtD;;WAEG;QACH,qBAAqB,EAAE,MAAM,GAAG,IAAI,CAAC;QAErC;;;WAGG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC,QAAQ,CAAC;QAEhC;;;WAGG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;;WAGG;QACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;KAC1B;IAED;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;QAE/B;;WAEG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;QAEnB;;WAEG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;;WAGG;QACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,gBAAgB,EAAE,YAAY,CAAC,eAAe,GAAG,IAAI,CAAC;QAEtD;;WAEG;QACH,qBAAqB,EAAE,MAAM,GAAG,IAAI,CAAC;QAErC;;;WAGG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC;KACxC;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,SAAS,CAAC,EAAE,UAAU,GAAG,UAAU,GAAG,IAAI,GAAG,IAAI,CAAC;IAElD;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,WAAW,CAAC,EAAE,aAAa,GAAG,IAAI,CAAC;CACpC;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}

package/resources/ad-reports.d.ts

@@ -0,0 +1,379 @@
+import { APIResource } from "../core/resource.js";
+import * as AdReportsAPI from "./ad-reports.js";
+import * as Shared from "./shared.js";
+import { APIPromise } from "../core/api-promise.js";
+import { RequestOptions } from "../internal/request-options.js";
+/**
+ * Ad reports
+ */
+export declare class AdReports extends APIResource {
+    /**
+     * Performance report for a company, ad campaign, ad group, or ad. Always returns
+     * aggregate `summary` totals. Set `granularity` (`daily`/`hourly`) to additionally
+     * get a time series, or set `breakdown` (`campaign`/`ad_group`/`ad`) to
+     * additionally get per-entity rows inside the requested scope. Exactly one of
+     * `companyId`, `adCampaignId`, `adGroupId`, or `adId` must be provided.
+     *
+     * Required permissions:
+     *
+     * - `ad_campaign:stats:read`
+     */
+    retrieve(query: AdReportRetrieveParams, options?: RequestOptions): APIPromise<AdReportRetrieveResponse>;
+}
+/**
+ * Bucket size for external ad stat rows.
+ */
+export type Granularities = 'daily' | 'hourly';
+/**
+ * Types of optimization results tracked from external ad platforms
+ */
+export type ResultLabelKeys = 'app_installs' | 'messaging_conversations_started' | 'post_engagement' | 'event_responses' | 'impressions' | 'website_purchases' | 'landing_page_views' | 'leads' | 'link_clicks' | 'quality_calls' | 'appointments_booked' | 'messaging_purchases' | 'page_likes' | 'instagram_profile_visits' | 'reach' | 'reminders_set' | 'new_subscribers' | 'video_views' | 'registrations' | 'content_views' | 'searches' | 'website_schedules' | 'website_submit_applications' | 'custom';
+/**
+ * An ads performance report. Always returns a summary. The `granularity` field
+ * contains a per-bucket time series when the `granularity` arg is set; the
+ * `breakdown` field contains per-entity rows when the `breakdown` arg is set.
+ */
+export interface AdReportRetrieveResponse {
+    /**
+     * Per-entity rows over the date range. `null` when the `breakdown` arg on
+     * `adReport` is omitted; otherwise contains one row per ad campaign, ad group, or
+     * ad inside the requested scope at the requested level.
+     */
+    breakdown: Array<AdReportRetrieveResponse.Breakdown> | null;
+    /**
+     * Per-bucket time series over the date range, ordered ascending by `bucketStart`.
+     * `null` when the `granularity` arg on `adReport` is omitted; otherwise contains
+     * rows at the requested grain (`daily` or `hourly`).
+     */
+    granularity: Array<AdReportRetrieveResponse.Granularity> | null;
+    /**
+     * Aggregate totals and rates over the date range.
+     */
+    summary: AdReportRetrieveResponse.Summary;
+}
+export declare namespace AdReportRetrieveResponse {
+    /**
+     * Per-entity ad performance row. Returned when the `breakdown` arg on `adReport`
+     * is set.
+     */
+    interface Breakdown {
+        /**
+         * Tag of the entity (ad campaign, ad group, or ad).
+         */
+        id: string;
+        /**
+         * Per-bucket time series for this entity over the date range, ordered ascending by
+         * `bucketStart`. `null` when the `granularity` arg on `adReport` is omitted;
+         * otherwise contains rows at the requested grain (`daily` or `hourly`).
+         */
+        granularity: Array<Breakdown.Granularity> | null;
+        /**
+         * The entity level of this row — matches the `breakdown` arg.
+         */
+        level: 'campaign' | 'ad_group' | 'ad';
+        /**
+         * Display name of the entity, when available.
+         */
+        name: string | null;
+        /**
+         * Aggregate totals and rates for this entity over the date range.
+         */
+        summary: Breakdown.Summary;
+    }
+    namespace Breakdown {
+        /**
+         * Per-bucket ad performance for an ad campaign, ad group, or ad. Bucket grain is
+         * set by the `ad_report` query's `granularity` argument.
+         */
+        interface Granularity {
+            /**
+             * The bucket's start time as a real UTC instant. `(statDate, statHour)` resolved
+             * in the ad account's reporting timezone — render this in the viewer's local
+             * timezone.
+             */
+            bucket_start: string;
+            /**
+             * Clicks in this bucket.
+             */
+            clicks: number;
+            /**
+             * The bucket size of this row (`daily` or `hourly`).
+             */
+            granularity: AdReportsAPI.Granularities;
+            /**
+             * Impressions in this bucket.
+             */
+            impressions: number;
+            /**
+             * Unique users reached in this bucket. Always `0` for hourly rows (Meta does not
+             * return reach at hourly grain).
+             */
+            reach: number;
+            /**
+             * Count of the primary optimization result in this bucket.
+             */
+            result_count: number | null;
+            /**
+             * Types of optimization results tracked from external ad platforms
+             */
+            result_label_key: AdReportsAPI.ResultLabelKeys | null;
+            /**
+             * Advertiser-defined label for the result when `resultLabelKey` is `custom`.
+             */
+            result_label_override: string | null;
+            /**
+             * Charged spend in this bucket in the requested reporting currency — the amount
+             * billed including platform fees, not the platform-side net spend.
+             */
+            spend: number;
+            /**
+             * Currency of the `spend` value.
+             */
+            spend_currency: Shared.Currency;
+            /**
+             * The date these stats cover (midnight UTC). For hourly rows, see `statHour` and
+             * `bucketStart`.
+             */
+            stat_date: string;
+            /**
+             * Hour of the day in the ad account's reporting timezone (0-23). `null` for daily
+             * rows.
+             */
+            stat_hour: number | null;
+        }
+        /**
+         * Aggregate totals and rates for this entity over the date range.
+         */
+        interface Summary {
+            /**
+             * Total clicks over the date range.
+             */
+            clicks: number;
+            /**
+             * Spend divided by `resultCount`. Null when there are no results.
+             */
+            cost_per_result: number | null;
+            /**
+             * Cost per click in the requested reporting currency.
+             */
+            cpc: number;
+            /**
+             * Cost per thousand impressions in the requested reporting currency.
+             */
+            cpm: number | null;
+            /**
+             * Click-through rate (clicks / impressions).
+             */
+            ctr: number;
+            /**
+             * Average number of times each reached user saw an ad.
+             */
+            frequency: number | null;
+            /**
+             * Total impressions over the date range.
+             */
+            impressions: number;
+            /**
+             * Unique users reached, deduplicated by the external ad platform.
+             */
+            reach: number;
+            /**
+             * Count of the campaign's primary optimization result (purchases, clicks, etc.) —
+             * see `resultLabelKey`.
+             */
+            result_count: number | null;
+            /**
+             * Types of optimization results tracked from external ad platforms
+             */
+            result_label_key: AdReportsAPI.ResultLabelKeys | null;
+            /**
+             * Advertiser-defined label for the result when `resultLabelKey` is `custom`.
+             */
+            result_label_override: string | null;
+            /**
+             * Alias for `purchaseRoas` — return on ad spend for purchases, as reported by the
+             * external ad platform.
+             */
+            roas: number | null;
+            /**
+             * Total spend over the date range in the requested reporting currency.
+             */
+            spend: number;
+            /**
+             * The available currencies on the platform
+             */
+            spend_currency: Shared.Currency | null;
+        }
+    }
+    /**
+     * Per-bucket ad performance for an ad campaign, ad group, or ad. Bucket grain is
+     * set by the `ad_report` query's `granularity` argument.
+     */
+    interface Granularity {
+        /**
+         * The bucket's start time as a real UTC instant. `(statDate, statHour)` resolved
+         * in the ad account's reporting timezone — render this in the viewer's local
+         * timezone.
+         */
+        bucket_start: string;
+        /**
+         * Clicks in this bucket.
+         */
+        clicks: number;
+        /**
+         * The bucket size of this row (`daily` or `hourly`).
+         */
+        granularity: AdReportsAPI.Granularities;
+        /**
+         * Impressions in this bucket.
+         */
+        impressions: number;
+        /**
+         * Unique users reached in this bucket. Always `0` for hourly rows (Meta does not
+         * return reach at hourly grain).
+         */
+        reach: number;
+        /**
+         * Count of the primary optimization result in this bucket.
+         */
+        result_count: number | null;
+        /**
+         * Types of optimization results tracked from external ad platforms
+         */
+        result_label_key: AdReportsAPI.ResultLabelKeys | null;
+        /**
+         * Advertiser-defined label for the result when `resultLabelKey` is `custom`.
+         */
+        result_label_override: string | null;
+        /**
+         * Charged spend in this bucket in the requested reporting currency — the amount
+         * billed including platform fees, not the platform-side net spend.
+         */
+        spend: number;
+        /**
+         * Currency of the `spend` value.
+         */
+        spend_currency: Shared.Currency;
+        /**
+         * The date these stats cover (midnight UTC). For hourly rows, see `statHour` and
+         * `bucketStart`.
+         */
+        stat_date: string;
+        /**
+         * Hour of the day in the ad account's reporting timezone (0-23). `null` for daily
+         * rows.
+         */
+        stat_hour: number | null;
+    }
+    /**
+     * Aggregate totals and rates over the date range.
+     */
+    interface Summary {
+        /**
+         * Total clicks over the date range.
+         */
+        clicks: number;
+        /**
+         * Spend divided by `resultCount`. Null when there are no results.
+         */
+        cost_per_result: number | null;
+        /**
+         * Cost per click in the requested reporting currency.
+         */
+        cpc: number;
+        /**
+         * Cost per thousand impressions in the requested reporting currency.
+         */
+        cpm: number | null;
+        /**
+         * Click-through rate (clicks / impressions).
+         */
+        ctr: number;
+        /**
+         * Average number of times each reached user saw an ad.
+         */
+        frequency: number | null;
+        /**
+         * Total impressions over the date range.
+         */
+        impressions: number;
+        /**
+         * Unique users reached, deduplicated by the external ad platform.
+         */
+        reach: number;
+        /**
+         * Count of the campaign's primary optimization result (purchases, clicks, etc.) —
+         * see `resultLabelKey`.
+         */
+        result_count: number | null;
+        /**
+         * Types of optimization results tracked from external ad platforms
+         */
+        result_label_key: AdReportsAPI.ResultLabelKeys | null;
+        /**
+         * Advertiser-defined label for the result when `resultLabelKey` is `custom`.
+         */
+        result_label_override: string | null;
+        /**
+         * Alias for `purchaseRoas` — return on ad spend for purchases, as reported by the
+         * external ad platform.
+         */
+        roas: number | null;
+        /**
+         * Total spend over the date range in the requested reporting currency.
+         */
+        spend: number;
+        /**
+         * The available currencies on the platform
+         */
+        spend_currency: Shared.Currency | null;
+    }
+}
+export interface AdReportRetrieveParams {
+    /**
+     * Inclusive start of the reporting window.
+     */
+    from: string;
+    /**
+     * Inclusive end of the reporting window.
+     */
+    to: string;
+    /**
+     * The unique identifier of an ad campaign. Mutually exclusive with `companyId`,
+     * `adGroupId`, and `adId`.
+     */
+    ad_campaign_id?: string | null;
+    /**
+     * The unique identifier of an ad group. Mutually exclusive with `companyId`,
+     * `adCampaignId`, and `adId`.
+     */
+    ad_group_id?: string | null;
+    /**
+     * The unique identifier of an ad. Mutually exclusive with `companyId`,
+     * `adCampaignId`, and `adGroupId`.
+     */
+    ad_id?: string | null;
+    /**
+     * Entity level to group an ad report by.
+     */
+    breakdown?: 'campaign' | 'ad_group' | 'ad' | null;
+    /**
+     * The unique identifier of a company. Mutually exclusive with `adCampaignId`,
+     * `adGroupId`, and `adId`. Use with `breakdown` to fan out across every campaign,
+     * ad group, or ad in the company without paging.
+     */
+    company_id?: string | null;
+    /**
+     * ISO 4217 currency code to report `spend` in. Defaults to the company's ads
+     * reporting currency.
+     */
+    currency?: string | null;
+    /**
+     * Bucket size for external ad stat rows.
+     */
+    granularity?: Granularities | null;
+}
+export declare namespace AdReports {
+    export { type Granularities as Granularities, type ResultLabelKeys as ResultLabelKeys, type AdReportRetrieveResponse as AdReportRetrieveResponse, type AdReportRetrieveParams as AdReportRetrieveParams, };
+}
+//# sourceMappingURL=ad-reports.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ad-reports.d.ts","sourceRoot":"","sources":["../src/resources/ad-reports.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,YAAY;OACjB,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB;;GAEG;AACH,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,KAAK,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;CAGxG;AAED;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,OAAO,GAAG,QAAQ,CAAC;AAE/C;;GAEG;AACH,MAAM,MAAM,eAAe,GACvB,cAAc,GACd,iCAAiC,GACjC,iBAAiB,GACjB,iBAAiB,GACjB,aAAa,GACb,mBAAmB,GACnB,oBAAoB,GACpB,OAAO,GACP,aAAa,GACb,eAAe,GACf,qBAAqB,GACrB,qBAAqB,GACrB,YAAY,GACZ,0BAA0B,GAC1B,OAAO,GACP,eAAe,GACf,iBAAiB,GACjB,aAAa,GACb,eAAe,GACf,eAAe,GACf,UAAU,GACV,mBAAmB,GACnB,6BAA6B,GAC7B,QAAQ,CAAC;AAEb;;;;GAIG;AACH,MAAM,WAAW,wBAAwB;IACvC;;;;OAIG;IACH,SAAS,EAAE,KAAK,CAAC,wBAAwB,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC;IAE5D;;;;OAIG;IACH,WAAW,EAAE,KAAK,CAAC,wBAAwB,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC;IAEhE;;OAEG;IACH,OAAO,EAAE,wBAAwB,CAAC,OAAO,CAAC;CAC3C;AAED,yBAAiB,wBAAwB,CAAC;IACxC;;;OAGG;IACH,UAAiB,SAAS;QACxB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;;;WAIG;QACH,WAAW,EAAE,KAAK,CAAC,SAAS,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC;QAEjD;;WAEG;QACH,KAAK,EAAE,UAAU,GAAG,UAAU,GAAG,IAAI,CAAC;QAEtC;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,OAAO,EAAE,SAAS,CAAC,OAAO,CAAC;KAC5B;IAED,UAAiB,SAAS,CAAC;QACzB;;;WAGG;QACH,UAAiB,WAAW;YAC1B;;;;eAIG;YACH,YAAY,EAAE,MAAM,CAAC;YAErB;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,WAAW,EAAE,YAAY,CAAC,aAAa,CAAC;YAExC;;eAEG;YACH,WAAW,EAAE,MAAM,CAAC;YAEpB;;;eAGG;YACH,KAAK,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;YAE5B;;eAEG;YACH,gBAAgB,EAAE,YAAY,CAAC,eAAe,GAAG,IAAI,CAAC;YAEtD;;eAEG;YACH,qBAAqB,EAAE,MAAM,GAAG,IAAI,CAAC;YAErC;;;eAGG;YACH,KAAK,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,cAAc,EAAE,MAAM,CAAC,QAAQ,CAAC;YAEhC;;;eAGG;YACH,SAAS,EAAE,MAAM,CAAC;YAElB;;;eAGG;YACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;SAC1B;QAED;;WAEG;QACH,UAAiB,OAAO;YACtB;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;YAE/B;;eAEG;YACH,GAAG,EAAE,MAAM,CAAC;YAEZ;;eAEG;YACH,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;YAEnB;;eAEG;YACH,GAAG,EAAE,MAAM,CAAC;YAEZ;;eAEG;YACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB;;eAEG;YACH,WAAW,EAAE,MAAM,CAAC;YAEpB;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;YAEd;;;eAGG;YACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;YAE5B;;eAEG;YACH,gBAAgB,EAAE,YAAY,CAAC,eAAe,GAAG,IAAI,CAAC;YAEtD;;eAEG;YACH,qBAAqB,EAAE,MAAM,GAAG,IAAI,CAAC;YAErC;;;eAGG;YACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;YAEpB;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,cAAc,EAAE,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC;SACxC;KACF;IAED;;;OAGG;IACH,UAAiB,WAAW;QAC1B;;;;WAIG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,WAAW,EAAE,YAAY,CAAC,aAAa,CAAC;QAExC;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;;WAGG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,gBAAgB,EAAE,YAAY,CAAC,eAAe,GAAG,IAAI,CAAC;QAEtD;;WAEG;QACH,qBAAqB,EAAE,MAAM,GAAG,IAAI,CAAC;QAErC;;;WAGG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC,QAAQ,CAAC;QAEhC;;;WAGG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;;WAGG;QACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;KAC1B;IAED;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;QAE/B;;WAEG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;QAEnB;;WAEG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;;WAGG;QACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,gBAAgB,EAAE,YAAY,CAAC,eAAe,GAAG,IAAI,CAAC;QAEtD;;WAEG;QACH,qBAAqB,EAAE,MAAM,GAAG,IAAI,CAAC;QAErC;;;WAGG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC;KACxC;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,SAAS,CAAC,EAAE,UAAU,GAAG,UAAU,GAAG,IAAI,GAAG,IAAI,CAAC;IAElD;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,WAAW,CAAC,EAAE,aAAa,GAAG,IAAI,CAAC;CACpC;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}

package/resources/ad-reports.js

@@ -0,0 +1,26 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AdReports = void 0;
+const resource_1 = require("../core/resource.js");
+/**
+ * Ad reports
+ */
+class AdReports extends resource_1.APIResource {
+    /**
+     * Performance report for a company, ad campaign, ad group, or ad. Always returns
+     * aggregate `summary` totals. Set `granularity` (`daily`/`hourly`) to additionally
+     * get a time series, or set `breakdown` (`campaign`/`ad_group`/`ad`) to
+     * additionally get per-entity rows inside the requested scope. Exactly one of
+     * `companyId`, `adCampaignId`, `adGroupId`, or `adId` must be provided.
+     *
+     * Required permissions:
+     *
+     * - `ad_campaign:stats:read`
+     */
+    retrieve(query, options) {
+        return this._client.get('/ad_reports', { query, ...options });
+    }
+}
+exports.AdReports = AdReports;
+//# sourceMappingURL=ad-reports.js.map

package/resources/ad-reports.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ad-reports.js","sourceRoot":"","sources":["../src/resources/ad-reports.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAM/C;;GAEG;AACH,MAAa,SAAU,SAAQ,sBAAW;IACxC;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,KAA6B,EAAE,OAAwB;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChE,CAAC;CACF;AAfD,8BAeC"}

package/resources/ad-reports.mjs

@@ -0,0 +1,22 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../core/resource.mjs";
+/**
+ * Ad reports
+ */
+export class AdReports extends APIResource {
+    /**
+     * Performance report for a company, ad campaign, ad group, or ad. Always returns
+     * aggregate `summary` totals. Set `granularity` (`daily`/`hourly`) to additionally
+     * get a time series, or set `breakdown` (`campaign`/`ad_group`/`ad`) to
+     * additionally get per-entity rows inside the requested scope. Exactly one of
+     * `companyId`, `adCampaignId`, `adGroupId`, or `adId` must be provided.
+     *
+     * Required permissions:
+     *
+     * - `ad_campaign:stats:read`
+     */
+    retrieve(query, options) {
+        return this._client.get('/ad_reports', { query, ...options });
+    }
+}
+//# sourceMappingURL=ad-reports.mjs.map

package/resources/ad-reports.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"ad-reports.mjs","sourceRoot":"","sources":["../src/resources/ad-reports.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAMtB;;GAEG;AACH,MAAM,OAAO,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,KAA6B,EAAE,OAAwB;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChE,CAAC;CACF"}

package/resources/ads.d.mts

@@ -0,0 +1,234 @@
+import { APIResource } from "../core/resource.mjs";
+import * as AdCampaignsAPI from "./ad-campaigns.mjs";
+import * as Shared from "./shared.mjs";
+import { APIPromise } from "../core/api-promise.mjs";
+import { CursorPage, type CursorPageParams, PagePromise } from "../core/pagination.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+/**
+ * Ads
+ */
+export declare class Ads extends APIResource {
+    /**
+     * List ads scoped by ad group, campaign, or company.
+     *
+     * Required permissions:
+     *
+     * - `ad_campaign:basic:read`
+     */
+    list(query?: AdListParams | null | undefined, options?: RequestOptions): PagePromise<AdListResponsesCursorPage, AdListResponse>;
+    /**
+     * Retrieve an ad by its unique identifier.
+     *
+     * Required permissions:
+     *
+     * - `ad_campaign:basic:read`
+     */
+    retrieve(id: string, options?: RequestOptions): APIPromise<Ad>;
+    /**
+     * Pauses an ad.
+     *
+     * Required permissions:
+     *
+     * - `ad_campaign:update`
+     * - `ad_campaign:basic:read`
+     */
+    pause(id: string, options?: RequestOptions): APIPromise<Ad>;
+    /**
+     * Resumes a paused ad.
+     *
+     * Required permissions:
+     *
+     * - `ad_campaign:update`
+     * - `ad_campaign:basic:read`
+     */
+    unpause(id: string, options?: RequestOptions): APIPromise<Ad>;
+}
+export type AdListResponsesCursorPage = CursorPage<AdListResponse>;
+/**
+ * An ad belonging to an ad group.
+ */
+export interface Ad {
+    /**
+     * The unique identifier for this ad.
+     */
+    id: string;
+    /**
+     * The ad campaign this ad belongs to.
+     */
+    ad_campaign: Ad.AdCampaign;
+    /**
+     * The parent ad group this ad belongs to.
+     */
+    ad_group: Ad.AdGroup;
+    /**
+     * When the ad was created.
+     */
+    created_at: string;
+    /**
+     * The external ad platform this ad is running on (e.g., meta, tiktok).
+     */
+    platform: AdCampaignsAPI.AdCampaignPlatform;
+    /**
+     * Current delivery status of the ad.
+     */
+    status: ExternalAdStatus;
+    /**
+     * The display title of the ad. Falls back to the creative set caption when unset.
+     */
+    title: string | null;
+    /**
+     * When the ad was last updated.
+     */
+    updated_at: string;
+}
+export declare namespace Ad {
+    /**
+     * The ad campaign this ad belongs to.
+     */
+    interface AdCampaign {
+        /**
+         * The unique identifier for this ad campaign.
+         */
+        id: string;
+    }
+    /**
+     * The parent ad group this ad belongs to.
+     */
+    interface AdGroup {
+        /**
+         * The unique identifier for this ad group.
+         */
+        id: string;
+    }
+}
+/**
+ * The status of an external ad.
+ */
+export type ExternalAdStatus = 'active' | 'paused' | 'inactive' | 'in_review' | 'rejected' | 'flagged';
+/**
+ * An ad belonging to an ad group.
+ */
+export interface AdListResponse {
+    /**
+     * The unique identifier for this ad.
+     */
+    id: string;
+    /**
+     * The ad campaign this ad belongs to.
+     */
+    ad_campaign: AdListResponse.AdCampaign;
+    /**
+     * The parent ad group this ad belongs to.
+     */
+    ad_group: AdListResponse.AdGroup;
+    /**
+     * When the ad was created.
+     */
+    created_at: string;
+    /**
+     * The external ad platform this ad is running on (e.g., meta, tiktok).
+     */
+    platform: AdCampaignsAPI.AdCampaignPlatform;
+    /**
+     * Current delivery status of the ad.
+     */
+    status: ExternalAdStatus;
+    /**
+     * The display title of the ad. Falls back to the creative set caption when unset.
+     */
+    title: string | null;
+    /**
+     * When the ad was last updated.
+     */
+    updated_at: string;
+}
+export declare namespace AdListResponse {
+    /**
+     * The ad campaign this ad belongs to.
+     */
+    interface AdCampaign {
+        /**
+         * The unique identifier for this ad campaign.
+         */
+        id: string;
+    }
+    /**
+     * The parent ad group this ad belongs to.
+     */
+    interface AdGroup {
+        /**
+         * The unique identifier for this ad group.
+         */
+        id: string;
+    }
+}
+export interface AdListParams extends CursorPageParams {
+    /**
+     * Filter by ad group. Provide exactly one of ad_group_id, campaign_id, or
+     * company_id.
+     */
+    ad_group_id?: string | null;
+    /**
+     * Returns the elements in the list that come before the specified cursor.
+     */
+    before?: string | null;
+    /**
+     * Filter by campaign. Provide exactly one of ad_group_id, campaign_id, or
+     * company_id.
+     */
+    campaign_id?: string | null;
+    /**
+     * Filter by company. Provide exactly one of ad_group_id, campaign_id, or
+     * company_id.
+     */
+    company_id?: string | null;
+    /**
+     * Only return ads created after this timestamp.
+     */
+    created_after?: string | null;
+    /**
+     * Only return ads created before this timestamp.
+     */
+    created_before?: string | null;
+    /**
+     * Returns the first _n_ elements from the list.
+     */
+    first?: number | null;
+    /**
+     * When false, excludes paused ads so pagination matches the dashboard's
+     * hide-paused toggle.
+     */
+    include_paused?: boolean | null;
+    /**
+     * Returns the last _n_ elements from the list.
+     */
+    last?: number | null;
+    /**
+     * Columns that the listAds query can sort by.
+     */
+    order_by?: 'spend' | 'roas' | null;
+    /**
+     * The direction of the sort.
+     */
+    order_direction?: Shared.Direction | null;
+    /**
+     * Case-insensitive substring match against the ad title or tag.
+     */
+    query?: string | null;
+    /**
+     * Start of the stats date range used when order_by is a stats column.
+     */
+    stats_from?: string | null;
+    /**
+     * End of the stats date range used when order_by is a stats column.
+     */
+    stats_to?: string | null;
+    /**
+     * The status of an external ad.
+     */
+    status?: ExternalAdStatus | null;
+}
+export declare namespace Ads {
+    export { type Ad as Ad, type ExternalAdStatus as ExternalAdStatus, type AdListResponse as AdListResponse, type AdListResponsesCursorPage as AdListResponsesCursorPage, type AdListParams as AdListParams, };
+}
+//# sourceMappingURL=ads.d.mts.map