@zinn-digital/sdk 0.1.1377 → 0.1.1380

package/dist/generated/schema.d.ts

@@ -19752,6 +19752,114 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/ads/report/pdf": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * One client's white-label advertising report as a PDF (za-200).
+         * @description Gated on `ads.view`. The same document a scheduled report e-mails: the client organisation's figures (and its sub-organisations') over the last `days` days, under the brand that organisation renders under (the agency's white label), in `locale` (any of the 58 platform languages; Arabic and Hebrew right to left). Stored rows only. Throttled per caller (`ads_report_render`, 300 per hour) on top of the account limits.
+         */
+        get: operations["getAdsReportPdf"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/ads/report/rows": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Daily campaign rows for Looker Studio (za-200).
+         * @description Gated on `ads.view`. One row per day, ad account and campaign over `start`..`end` (inclusive, at most 400 days) for the organisations the caller may view; `org_id` narrows to that organisation and its clients. Built for the Zinn® Ads Looker Studio community connector, which authenticates with an API key minted on ONE client organisation with only the `ads.view` scope, so the key reads that client and nothing else. Spend and value are integer micros of the account currency (`currency` on every row); conversions are thousandths. Paged: follow `next_offset` until it is `null`. Stored rows only - never a network call in the request.
+         */
+        get: operations["listAdsReportRows"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/ads/report/schedules": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * The scheduled white-label PDF reports (za-200).
+         * @description Gated on `ads.view`. Every schedule in the organisations the caller may view; `org_id` narrows to that organisation and its clients.
+         */
+        get: operations["listAdsReportSchedules"];
+        put?: never;
+        /**
+         * Create or replace a client's weekly or monthly PDF report (za-200).
+         * @description Gated on `ads.manage`; audit action `ads.report_schedule.save`. One schedule per client organisation and cadence: posting the same cadence again replaces it (200), a new one answers 201. Weekly reports are sent on Monday at 06:00 UTC, monthly ones on the 1st at 06:00 UTC, by a Temporal workflow. A bad field answers `422 badLimit` naming it.
+         */
+        post: operations["saveAdsReportSchedule"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/ads/report/schedules/{schedule_id}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post?: never;
+        /**
+         * Stop and remove a scheduled report (za-200).
+         * @description Gated on `ads.manage`; audit action `ads.report_schedule.delete`.
+         */
+        delete: operations["deleteAdsReportSchedule"];
+        options?: never;
+        head?: never;
+        /**
+         * Change a scheduled report's recipients, language, window or on/off (za-200).
+         * @description Gated on `ads.manage`; audit action `ads.report_schedule.save`.
+         */
+        patch: operations["updateAdsReportSchedule"];
+        trace?: never;
+    };
+    "/v1/ads/report/schedules/{schedule_id}/send": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * E-mail this period's report now, without moving the schedule (za-200).
+         * @description Gated on `ads.manage`; audit action `ads.report_schedule.send`. Refused with `422 notInGoodStanding` when the paying organisation is not in good standing. Throttled per caller (`ads_report_send`, 300 per hour) on top of the account limits.
+         */
+        post: operations["sendAdsReportScheduleNow"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/ads/shield": {
         parameters: {
             query?: never;
@@ -45929,7 +46037,7 @@ export interface paths {
         };
         /**
          * Read a site's automatic app updates add-on and its window.
-         * @description The paid automatic-updates add-on for the app the site runs (`wordpress_auto_updates`, `woocommerce_auto_updates` or `joomla_auto_updates`, USD 29 a year per site; `nextcloud_auto_updates`, USD 50 a year per site; s1014 row 41): whether it is on sale and on, its price in the caller's currency, the renewal, the quiet window and the last run. Each run takes a safety backup first and rolls back to it when the homepage breaks. WordPress: core, plugins and themes (a held plugin version is never applied). Joomla!: the core only, through Joomla's own console; extensions and templates are not updated. Nextcloud: the server through its own updater, then every app with an update. Buy it through `purchaseExtra` with `site_id`. Requires `sites.view`.
+         * @description The paid automatic-updates add-on for the app the site runs (`wordpress_auto_updates`, `woocommerce_auto_updates`, `joomla_auto_updates` or `drupal_auto_updates`, USD 29 a year per site; `nextcloud_auto_updates`, USD 50 a year per site; s1014 row 41): whether it is on sale and on, its price in the caller's currency, the renewal, the quiet window and the last run. Each run takes a safety backup first and rolls back to it when the homepage breaks. WordPress: core, plugins and themes (a held plugin version is never applied). Joomla!: the core only, through Joomla's own console; extensions and templates are not updated. Nextcloud: the server through its own updater, then every app with an update. Drupal: the core only (the newest release of the installed major version, then its database updates); contributed modules and themes are not updated. Buy it through `purchaseExtra` with `site_id`. Requires `sites.view`.
          */
         get: operations["getSiteAppAutoUpdate"];
         /**
@@ -64174,6 +64282,77 @@ export interface components {
             /** Format: int64 */
             value_micros: number;
         };
+        AdsReportRows: {
+            /** Format: date */
+            end: string;
+            fields: {
+                name: string;
+                /** @description The Looker Studio semantic type. */
+                type: string;
+            }[];
+            next_offset: number | null;
+            rows: {
+                account: string;
+                campaign: string;
+                campaign_id: string;
+                clicks: number;
+                client: string;
+                /** Format: uuid */
+                client_org_id: string;
+                /** Format: uuid */
+                connection_id: string;
+                conversions_milli: number;
+                cost_micros: number;
+                currency: string;
+                /** Format: date */
+                day: string;
+                impressions: number;
+                platform: string;
+                value_micros: number;
+            }[];
+            /** Format: date */
+            start: string;
+        };
+        AdsReportSchedule: {
+            /** @enum {string} */
+            cadence: "weekly" | "monthly";
+            enabled: boolean;
+            /** Format: uuid */
+            id: string;
+            /** @description `notInGoodStanding`, `mailRefused`, `renderFailed` or empty. */
+            last_error: string;
+            /** Format: date-time */
+            last_sent_at: string | null;
+            locale: string;
+            /** Format: date-time */
+            next_run_at: string | null;
+            /** Format: uuid */
+            org_id: string;
+            recipients: string[];
+            window_days: number;
+        };
+        AdsReportScheduleInput: {
+            /** @enum {string} */
+            cadence: "weekly" | "monthly";
+            /** @default true */
+            enabled: boolean;
+            /**
+             * @description One of the 58 platform languages.
+             * @default en
+             */
+            locale: string;
+            /**
+             * Format: uuid
+             * @description The client organisation the report is about.
+             */
+            org_id?: string;
+            recipients: string[];
+            /**
+             * @description Default 7 (weekly) or 30 (monthly).
+             * @enum {integer}
+             */
+            window_days?: 7 | 30 | 90;
+        };
         /** @description A scheduled review (AUTOREVIEW1). `figures` are the measurements the verdict rests on: the judged window (`after`) and the same length before it (`before`) with impressions, clicks, cost in the account's integer micros and conversions in thousandths (plus our own first-party `outcomes` on the house account), per campaign; a funnel's `idle` campaigns; a Quality Score review's `now` and `before` (`qs_x10`, `lp_below`, `keywords`); `stale` when the stored figures could not be read. */
         AdsReview: {
             campaign_ids: string[];
@@ -95693,7 +95872,7 @@ export interface components {
             total_ms: number;
             transaction: string;
         };
-        /** @description The paid automatic app updates add-on for one site (s1014 row 41): the code that applies (`wordpress_auto_updates`, `woocommerce_auto_updates`, `joomla_auto_updates` or `nextcloud_auto_updates`), the window and the last run's outcome. */
+        /** @description The paid automatic app updates add-on for one site (s1014 row 41): the code that applies (`wordpress_auto_updates`, `woocommerce_auto_updates`, `joomla_auto_updates`, `nextcloud_auto_updates` or `drupal_auto_updates`), the window and the last run's outcome. */
         SiteAppAutoUpdate: {
             /** @description Whether the add-on is on and in good standing now. */
             active: boolean;
@@ -95701,7 +95880,7 @@ export interface components {
              * @description The app the add-on serves on this site, or null when none is sold for it.
              * @enum {string|null}
              */
-            app_key: "wordpress" | "woocommerce" | "joomla" | "nextcloud" | null;
+            app_key: "wordpress" | "woocommerce" | "joomla" | "nextcloud" | "drupal" | null;
             can_buy: boolean;
             /** @description The catalogue code to buy (`<app_key>_auto_updates`). */
             code: string | null;
@@ -141206,6 +141385,233 @@ export interface operations {
             429: components["responses"]["TooManyRequests"];
         };
     };
+    getAdsReportPdf: {
+        parameters: {
+            query?: {
+                days?: 7 | 30 | 90;
+                locale?: string;
+                org_id?: string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description The PDF. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/pdf": string;
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            403: components["responses"]["Forbidden"];
+            404: components["responses"]["NotFound"];
+            422: components["responses"]["UnprocessableEntity"];
+            429: components["responses"]["TooManyRequests"];
+        };
+    };
+    listAdsReportRows: {
+        parameters: {
+            query: {
+                end: string;
+                offset?: number;
+                org_id?: string;
+                start: string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description One page of rows. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        data: components["schemas"]["AdsReportRows"];
+                    };
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            403: components["responses"]["Forbidden"];
+            404: components["responses"]["NotFound"];
+            422: components["responses"]["UnprocessableEntity"];
+            429: components["responses"]["TooManyRequests"];
+        };
+    };
+    listAdsReportSchedules: {
+        parameters: {
+            query?: {
+                org_id?: string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description The schedules. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        data: components["schemas"]["AdsReportSchedule"][];
+                    };
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            403: components["responses"]["Forbidden"];
+            404: components["responses"]["NotFound"];
+            429: components["responses"]["TooManyRequests"];
+        };
+    };
+    saveAdsReportSchedule: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["AdsReportScheduleInput"];
+            };
+        };
+        responses: {
+            /** @description The replaced schedule. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        data: components["schemas"]["AdsReportSchedule"];
+                    };
+                };
+            };
+            /** @description The new schedule. */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        data: components["schemas"]["AdsReportSchedule"];
+                    };
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            403: components["responses"]["Forbidden"];
+            404: components["responses"]["NotFound"];
+            422: components["responses"]["UnprocessableEntity"];
+            429: components["responses"]["TooManyRequests"];
+        };
+    };
+    deleteAdsReportSchedule: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                schedule_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Removed. */
+            204: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            401: components["responses"]["Unauthorized"];
+            403: components["responses"]["Forbidden"];
+            404: components["responses"]["NotFound"];
+            429: components["responses"]["TooManyRequests"];
+        };
+    };
+    updateAdsReportSchedule: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                schedule_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": {
+                    enabled?: boolean;
+                    locale?: string;
+                    recipients?: string[];
+                    /** @enum {integer} */
+                    window_days?: 7 | 30 | 90;
+                };
+            };
+        };
+        responses: {
+            /** @description The schedule. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        data: components["schemas"]["AdsReportSchedule"];
+                    };
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            403: components["responses"]["Forbidden"];
+            404: components["responses"]["NotFound"];
+            422: components["responses"]["UnprocessableEntity"];
+            429: components["responses"]["TooManyRequests"];
+        };
+    };
+    sendAdsReportScheduleNow: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                schedule_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description How many recipients the report went to. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        data: {
+                            recipients: number;
+                            /** Format: uuid */
+                            schedule_id: string;
+                        };
+                    };
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            403: components["responses"]["Forbidden"];
+            404: components["responses"]["NotFound"];
+            422: components["responses"]["UnprocessableEntity"];
+            429: components["responses"]["TooManyRequests"];
+        };
+    };
     getAdsShield: {
         parameters: {
             query?: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zinn-digital/sdk",
-  "version": "0.1.1377",
+  "version": "0.1.1380",
   "description": "Typed TypeScript client for the Zinn Digital Platform API, generated from its OpenAPI spec.",
   "license": "MIT",
   "author": "Neil Lock \u2014 CEO, Zinn Digital\u00ae Ltd <office@zinndigital.com>",