@zinn-digital/sdk 0.1.1421 → 0.1.1426
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/generated/schema.d.ts +574 -0
- package/package.json +1 -1
|
@@ -5479,6 +5479,8 @@ export interface paths {
|
|
|
5479
5479
|
*
|
|
5480
5480
|
* **Written for every box the automation REACHED, before its outcome is judged**, so a box that fails every time still shows a recent attempt rather than looking untouched. `ok` and `failed` are both recorded; only *never attempted* leaves the fields empty, and that is the state worth seeing.
|
|
5481
5481
|
*
|
|
5482
|
+
* A note of exactly `ok` also resolves the OPEN converge ops alerts (`box-job:fleet-apply`, `box-job:worker-converge`) whose only failing box is this one, whichever converge path raised them (s1014 CONVERGECLEAR).
|
|
5483
|
+
*
|
|
5482
5484
|
* A hostname the engine does not know is a **404**, never a quiet 200 — the automation reporting about a box the fleet registry has never heard of is a real disagreement between the two, and swallowing it would re-create the divergence this pair exists to remove.
|
|
5483
5485
|
*
|
|
5484
5486
|
* **Auth: a GitHub Actions OIDC token from `worker-converge.yml`, or a staff member with `fleet.manage`** — the converge runs on the platform's own box since 2026-10-15 and reports as the staff verification identity; a staff write is audited (`fleet.converge_result.recorded`). This writes, so it is a separate grant from the read-only freshness view (`fleet.view` is refused).
|
|
@@ -15967,6 +15969,66 @@ export interface paths {
|
|
|
15967
15969
|
patch?: never;
|
|
15968
15970
|
trace?: never;
|
|
15969
15971
|
};
|
|
15972
|
+
"/v1/ads/analytics/breakdown": {
|
|
15973
|
+
parameters: {
|
|
15974
|
+
query?: never;
|
|
15975
|
+
header?: never;
|
|
15976
|
+
path?: never;
|
|
15977
|
+
cookie?: never;
|
|
15978
|
+
};
|
|
15979
|
+
/**
|
|
15980
|
+
* Zinn® Ads analytics leaderboard by network, account, campaign, country or product/site (za-280).
|
|
15981
|
+
* @description Rows sorted by spend, paged with `offset` and `limit` (`total` counts every row), each with its comparison figures and a spend sparkline. Gated on `ads.view` over the organisations the person can view; `org_id` narrows to that organisation and its client organisations. Stored rows only (the daily audit's figures), never a network call. Money is integer micros of the reporting `currency`: each account's currency is converted at the CURRENT stored rate, named in `fx`; a currency with no rate is left out of the blended figures and listed in `unconverted`. Conversions are thousandths; ROAS, CTR and conversion rate are basis points; CPA and CPC are micros; a ratio with no denominator is null (za-280).
|
|
15982
|
+
*/
|
|
15983
|
+
get: operations["getAdsAnalyticsBreakdown"];
|
|
15984
|
+
put?: never;
|
|
15985
|
+
post?: never;
|
|
15986
|
+
delete?: never;
|
|
15987
|
+
options?: never;
|
|
15988
|
+
head?: never;
|
|
15989
|
+
patch?: never;
|
|
15990
|
+
trace?: never;
|
|
15991
|
+
};
|
|
15992
|
+
"/v1/ads/analytics/summary": {
|
|
15993
|
+
parameters: {
|
|
15994
|
+
query?: never;
|
|
15995
|
+
header?: never;
|
|
15996
|
+
path?: never;
|
|
15997
|
+
cookie?: never;
|
|
15998
|
+
};
|
|
15999
|
+
/**
|
|
16000
|
+
* Zinn® Ads analytics KPI tiles for a period and its comparison (za-280).
|
|
16001
|
+
* @description The period and comparison-period totals with a sparkline per figure, and the totals per account currency. Gated on `ads.view` over the organisations the person can view; `org_id` narrows to that organisation and its client organisations. Stored rows only (the daily audit's figures), never a network call. Money is integer micros of the reporting `currency`: each account's currency is converted at the CURRENT stored rate, named in `fx`; a currency with no rate is left out of the blended figures and listed in `unconverted`. Conversions are thousandths; ROAS, CTR and conversion rate are basis points; CPA and CPC are micros; a ratio with no denominator is null (za-280).
|
|
16002
|
+
*/
|
|
16003
|
+
get: operations["getAdsAnalyticsSummary"];
|
|
16004
|
+
put?: never;
|
|
16005
|
+
post?: never;
|
|
16006
|
+
delete?: never;
|
|
16007
|
+
options?: never;
|
|
16008
|
+
head?: never;
|
|
16009
|
+
patch?: never;
|
|
16010
|
+
trace?: never;
|
|
16011
|
+
};
|
|
16012
|
+
"/v1/ads/analytics/timeseries": {
|
|
16013
|
+
parameters: {
|
|
16014
|
+
query?: never;
|
|
16015
|
+
header?: never;
|
|
16016
|
+
path?: never;
|
|
16017
|
+
cookie?: never;
|
|
16018
|
+
};
|
|
16019
|
+
/**
|
|
16020
|
+
* Zinn® Ads analytics trend per day, week or month (za-280).
|
|
16021
|
+
* @description Every bucket of the period (zero-filled) with all figures, the comparison period bucket by bucket, and spend and value per network for the stacked network share. Gated on `ads.view` over the organisations the person can view; `org_id` narrows to that organisation and its client organisations. Stored rows only (the daily audit's figures), never a network call. Money is integer micros of the reporting `currency`: each account's currency is converted at the CURRENT stored rate, named in `fx`; a currency with no rate is left out of the blended figures and listed in `unconverted`. Conversions are thousandths; ROAS, CTR and conversion rate are basis points; CPA and CPC are micros; a ratio with no denominator is null (za-280).
|
|
16022
|
+
*/
|
|
16023
|
+
get: operations["getAdsAnalyticsTimeseries"];
|
|
16024
|
+
put?: never;
|
|
16025
|
+
post?: never;
|
|
16026
|
+
delete?: never;
|
|
16027
|
+
options?: never;
|
|
16028
|
+
head?: never;
|
|
16029
|
+
patch?: never;
|
|
16030
|
+
trace?: never;
|
|
16031
|
+
};
|
|
15970
16032
|
"/v1/ads/asks": {
|
|
15971
16033
|
parameters: {
|
|
15972
16034
|
query?: never;
|
|
@@ -20540,6 +20602,59 @@ export interface paths {
|
|
|
20540
20602
|
patch?: never;
|
|
20541
20603
|
trace?: never;
|
|
20542
20604
|
};
|
|
20605
|
+
"/v1/ads/tracking-hub": {
|
|
20606
|
+
parameters: {
|
|
20607
|
+
query?: never;
|
|
20608
|
+
header?: never;
|
|
20609
|
+
path?: never;
|
|
20610
|
+
cookie?: never;
|
|
20611
|
+
};
|
|
20612
|
+
/**
|
|
20613
|
+
* The tracking hub — every network tag, conversion id and server-side key status.
|
|
20614
|
+
* @description Gated on `ads.view` (docs/1006 §104, za-126). One hub per organisation: the browser tag id of each network (Google Ads, GA4, Microsoft UET, Meta pixel, TikTok, LinkedIn Insight, X, Pinterest, Amazon), the conversion id per network and outcome kind, and WHICH server-side keys are set (never the key: it is kept only in Vault). `server_routes` says per network how server-side conversions travel: through a connected ad account, through a key in the hub, or not at all. Every site tag (za-128) serves the hub's ids where it leaves its own blank. An organisation with no hub yet answers `version: 0`.
|
|
20615
|
+
*/
|
|
20616
|
+
get: operations["getAdsTrackingHub"];
|
|
20617
|
+
/**
|
|
20618
|
+
* Change the hub's tag ids and conversion ids.
|
|
20619
|
+
* @description Gated on `ads.manage`; audit-logged (`ads.tracking_hub_updated`). `tags` and `conversions` each REPLACE the stored map when present (a blank id removes it). Each tag id is checked against its network's format; a wrong one is a `422` (`refusal.adsconnect.trackingHub.*`) naming the field, e.g. `tags.ga4`. The version goes up by one and the cached script of every site tag of the organisation is rewritten.
|
|
20620
|
+
*/
|
|
20621
|
+
put: operations["updateAdsTrackingHub"];
|
|
20622
|
+
post?: never;
|
|
20623
|
+
delete?: never;
|
|
20624
|
+
options?: never;
|
|
20625
|
+
head?: never;
|
|
20626
|
+
patch?: never;
|
|
20627
|
+
trace?: never;
|
|
20628
|
+
};
|
|
20629
|
+
"/v1/ads/tracking-hub/keys/{kind}": {
|
|
20630
|
+
parameters: {
|
|
20631
|
+
query?: {
|
|
20632
|
+
/** @description Required when you belong to more than one organisation. */
|
|
20633
|
+
org_id?: string;
|
|
20634
|
+
};
|
|
20635
|
+
header?: never;
|
|
20636
|
+
path: {
|
|
20637
|
+
kind: "meta_capi" | "tiktok_events" | "ga4_mp" | "linkedin_capi" | "pinterest_capi";
|
|
20638
|
+
};
|
|
20639
|
+
cookie?: never;
|
|
20640
|
+
};
|
|
20641
|
+
get?: never;
|
|
20642
|
+
/**
|
|
20643
|
+
* Store one server-side key (write-only; kept in Vault).
|
|
20644
|
+
* @description Gated on `ads.manage`; audit-logged (`ads.tracking_hub_key_set`, the kind only). The key is written to Vault and never returned, logged or stored in the database; the hub keeps the time it was set and its last four characters. `503` when Vault could not be written (nothing is saved; retry).
|
|
20645
|
+
*/
|
|
20646
|
+
put: operations["setAdsTrackingHubKey"];
|
|
20647
|
+
post?: never;
|
|
20648
|
+
/**
|
|
20649
|
+
* Remove one server-side key from Vault and from the hub.
|
|
20650
|
+
* @description Gated on `ads.manage`; audit-logged (`ads.tracking_hub_key_removed`). The record is removed only after Vault confirmed the delete. Removing a key that is not set is a `204`.
|
|
20651
|
+
*/
|
|
20652
|
+
delete: operations["deleteAdsTrackingHubKey"];
|
|
20653
|
+
options?: never;
|
|
20654
|
+
head?: never;
|
|
20655
|
+
patch?: never;
|
|
20656
|
+
trace?: never;
|
|
20657
|
+
};
|
|
20543
20658
|
"/v1/ads/tracking/events": {
|
|
20544
20659
|
parameters: {
|
|
20545
20660
|
query?: never;
|
|
@@ -62306,6 +62421,113 @@ export interface components {
|
|
|
62306
62421
|
connection_id: string;
|
|
62307
62422
|
data: components["schemas"]["AdsAllowedTerm"][];
|
|
62308
62423
|
};
|
|
62424
|
+
AdsAnalyticsBreakdown: components["schemas"]["AdsAnalyticsFrame"] & {
|
|
62425
|
+
/** @enum {string} */
|
|
62426
|
+
by: "network" | "connection" | "campaign" | "country" | "offering";
|
|
62427
|
+
limit: number;
|
|
62428
|
+
offset: number;
|
|
62429
|
+
rows: components["schemas"]["AdsAnalyticsRow"][];
|
|
62430
|
+
total: number;
|
|
62431
|
+
};
|
|
62432
|
+
AdsAnalyticsFigures: {
|
|
62433
|
+
/** Format: int64 */
|
|
62434
|
+
clicks: number;
|
|
62435
|
+
/** Format: int64 */
|
|
62436
|
+
conv_rate_bp: number | null;
|
|
62437
|
+
/** Format: int64 */
|
|
62438
|
+
conversions_milli: number;
|
|
62439
|
+
/** Format: int64 */
|
|
62440
|
+
cost_micros: number;
|
|
62441
|
+
/** Format: int64 */
|
|
62442
|
+
cpa_micros: number | null;
|
|
62443
|
+
/** Format: int64 */
|
|
62444
|
+
cpc_micros: number | null;
|
|
62445
|
+
/** Format: int64 */
|
|
62446
|
+
ctr_bp: number | null;
|
|
62447
|
+
/** Format: int64 */
|
|
62448
|
+
impressions: number;
|
|
62449
|
+
/** Format: int64 */
|
|
62450
|
+
roas_bp: number | null;
|
|
62451
|
+
/** Format: int64 */
|
|
62452
|
+
value_micros: number;
|
|
62453
|
+
};
|
|
62454
|
+
AdsAnalyticsFrame: {
|
|
62455
|
+
accounts: number;
|
|
62456
|
+
/** @enum {string} */
|
|
62457
|
+
compare: "previous" | "year" | "none";
|
|
62458
|
+
/** Format: date */
|
|
62459
|
+
compare_first_day: string | null;
|
|
62460
|
+
/** Format: date */
|
|
62461
|
+
compare_last_day: string | null;
|
|
62462
|
+
currency: string;
|
|
62463
|
+
/** Format: date */
|
|
62464
|
+
first_day: string;
|
|
62465
|
+
fx: components["schemas"]["AdsAnalyticsFx"][];
|
|
62466
|
+
/** @enum {string} */
|
|
62467
|
+
grain: "day" | "week" | "month";
|
|
62468
|
+
/** Format: date */
|
|
62469
|
+
last_day: string;
|
|
62470
|
+
range: string;
|
|
62471
|
+
/** @description Currencies left out of the blended figures for want of a stored rate; `???` stands for accounts whose currency is not known. */
|
|
62472
|
+
unconverted: string[];
|
|
62473
|
+
};
|
|
62474
|
+
AdsAnalyticsFx: {
|
|
62475
|
+
/** @description When the stored rate was fetched (ISO 8601). */
|
|
62476
|
+
as_of: string;
|
|
62477
|
+
from: string;
|
|
62478
|
+
/** @description Major-unit multiplier */
|
|
62479
|
+
rate: string;
|
|
62480
|
+
to: string;
|
|
62481
|
+
};
|
|
62482
|
+
AdsAnalyticsPoint: components["schemas"]["AdsAnalyticsFigures"] & {
|
|
62483
|
+
/** Format: date */
|
|
62484
|
+
bucket: string;
|
|
62485
|
+
};
|
|
62486
|
+
AdsAnalyticsRow: components["schemas"]["AdsAnalyticsFigures"] & {
|
|
62487
|
+
account?: string;
|
|
62488
|
+
assigned?: boolean;
|
|
62489
|
+
campaign_id?: string;
|
|
62490
|
+
/** Format: uuid */
|
|
62491
|
+
connection_id?: string;
|
|
62492
|
+
country?: string;
|
|
62493
|
+
currencies: string[];
|
|
62494
|
+
key: string;
|
|
62495
|
+
kind?: string;
|
|
62496
|
+
label: string;
|
|
62497
|
+
network?: string;
|
|
62498
|
+
/** Format: uuid */
|
|
62499
|
+
offering_id?: string | null;
|
|
62500
|
+
/** Format: uuid */
|
|
62501
|
+
org_id?: string;
|
|
62502
|
+
previous: components["schemas"]["AdsAnalyticsFigures"] | null;
|
|
62503
|
+
spark_cost_micros: number[];
|
|
62504
|
+
};
|
|
62505
|
+
AdsAnalyticsSeries: {
|
|
62506
|
+
buckets?: string[];
|
|
62507
|
+
clicks: number[];
|
|
62508
|
+
conversions_milli: number[];
|
|
62509
|
+
cost_micros: number[];
|
|
62510
|
+
impressions: number[];
|
|
62511
|
+
value_micros: number[];
|
|
62512
|
+
};
|
|
62513
|
+
AdsAnalyticsSummary: components["schemas"]["AdsAnalyticsFrame"] & {
|
|
62514
|
+
by_currency: (components["schemas"]["AdsAnalyticsFigures"] & {
|
|
62515
|
+
currency: string;
|
|
62516
|
+
})[];
|
|
62517
|
+
current: components["schemas"]["AdsAnalyticsFigures"];
|
|
62518
|
+
previous: components["schemas"]["AdsAnalyticsFigures"] | null;
|
|
62519
|
+
previous_sparklines: components["schemas"]["AdsAnalyticsSeries"] | null;
|
|
62520
|
+
sparklines: components["schemas"]["AdsAnalyticsSeries"];
|
|
62521
|
+
};
|
|
62522
|
+
AdsAnalyticsTimeseries: components["schemas"]["AdsAnalyticsFrame"] & {
|
|
62523
|
+
networks: {
|
|
62524
|
+
cost_micros: number[];
|
|
62525
|
+
network: string;
|
|
62526
|
+
value_micros: number[];
|
|
62527
|
+
}[];
|
|
62528
|
+
points: components["schemas"]["AdsAnalyticsPoint"][];
|
|
62529
|
+
previous: components["schemas"]["AdsAnalyticsPoint"][] | null;
|
|
62530
|
+
};
|
|
62309
62531
|
/** @description One "Ask your ads" question and its checked answer (za-N7, docs/1006 §ASKADS). */
|
|
62310
62532
|
AdsAsk: {
|
|
62311
62533
|
/** @description Empty unless `answered`. Fact ids appear in square brackets after the figures they back. */
|
|
@@ -66493,6 +66715,16 @@ export interface components {
|
|
|
66493
66715
|
org_id: string;
|
|
66494
66716
|
/** @description Public (it is in the page source); never an API credential. */
|
|
66495
66717
|
public_key: string;
|
|
66718
|
+
/** @description za-126: the ids this site actually serves — its own, else the organisation's tracking hub's. */
|
|
66719
|
+
served?: {
|
|
66720
|
+
ga4_id?: string;
|
|
66721
|
+
google_ads_id?: string;
|
|
66722
|
+
google_labels?: {
|
|
66723
|
+
[key: string]: string;
|
|
66724
|
+
};
|
|
66725
|
+
meta_pixel_id?: string;
|
|
66726
|
+
microsoft_uet_id?: string;
|
|
66727
|
+
};
|
|
66496
66728
|
site_host: string;
|
|
66497
66729
|
/** Format: date-time */
|
|
66498
66730
|
updated_at: string | null;
|
|
@@ -66800,6 +67032,59 @@ export interface components {
|
|
|
66800
67032
|
rejected: number;
|
|
66801
67033
|
waiting: number;
|
|
66802
67034
|
};
|
|
67035
|
+
/** @description One organisation's tracking hub (docs/1006 §104, za-126). */
|
|
67036
|
+
AdsTrackingHub: {
|
|
67037
|
+
/** @description Network -> outcome kind -> conversion id (a Google Ads label, a Meta custom conversion, a TikTok event …). */
|
|
67038
|
+
conversions: {
|
|
67039
|
+
[key: string]: {
|
|
67040
|
+
[key: string]: string;
|
|
67041
|
+
};
|
|
67042
|
+
};
|
|
67043
|
+
kinds: string[];
|
|
67044
|
+
networks: string[];
|
|
67045
|
+
/** Format: uuid */
|
|
67046
|
+
org_id: string;
|
|
67047
|
+
server_keys: {
|
|
67048
|
+
/** @description The key's last four characters (blank when not set). */
|
|
67049
|
+
hint: string;
|
|
67050
|
+
/** @enum {string} */
|
|
67051
|
+
kind: "meta_capi" | "tiktok_events" | "ga4_mp" | "linkedin_capi" | "pinterest_capi";
|
|
67052
|
+
network: string;
|
|
67053
|
+
set: boolean;
|
|
67054
|
+
/** Format: date-time */
|
|
67055
|
+
set_at: string | null;
|
|
67056
|
+
}[];
|
|
67057
|
+
/** @description Network -> how its server-side conversions travel. */
|
|
67058
|
+
server_routes: {
|
|
67059
|
+
[key: string]: {
|
|
67060
|
+
connected_provider: string | null;
|
|
67061
|
+
key_kind: string | null;
|
|
67062
|
+
/** @enum {string} */
|
|
67063
|
+
route: "connected" | "key" | "none";
|
|
67064
|
+
};
|
|
67065
|
+
};
|
|
67066
|
+
/** @description Network -> its browser tag id (google_ads, ga4, microsoft_uet, meta_pixel, tiktok_pixel, linkedin_insight, x_pixel, pinterest_tag, amazon_tag). */
|
|
67067
|
+
tags: {
|
|
67068
|
+
[key: string]: string;
|
|
67069
|
+
};
|
|
67070
|
+
/** Format: date-time */
|
|
67071
|
+
updated_at: string | null;
|
|
67072
|
+
/** @description 0 when no hub has been saved yet. */
|
|
67073
|
+
version: number;
|
|
67074
|
+
};
|
|
67075
|
+
AdsTrackingHubUpdate: {
|
|
67076
|
+
/** @description Network -> {outcome kind: conversion id}. A LinkedIn conversion id is numeric and an X event id is tw-PIXEL-EVENT (for example tw-o1abc-o1xyz); any other shape for those two is refused (badConversion), since the page could never fire it. */
|
|
67077
|
+
conversions?: {
|
|
67078
|
+
[key: string]: {
|
|
67079
|
+
[key: string]: string;
|
|
67080
|
+
};
|
|
67081
|
+
};
|
|
67082
|
+
/** Format: uuid */
|
|
67083
|
+
org_id?: string;
|
|
67084
|
+
tags?: {
|
|
67085
|
+
[key: string]: string;
|
|
67086
|
+
};
|
|
67087
|
+
};
|
|
66803
67088
|
/** @description One ad account's tracking-truth settings (docs/1006 §21). */
|
|
66804
67089
|
AdsTrackingSettings: {
|
|
66805
67090
|
/** @description Network actions that stand for these outcomes; empty = every PRIMARY one. */
|
|
@@ -99081,6 +99366,10 @@ export interface components {
|
|
|
99081
99366
|
runtime?: components["schemas"]["Runtime"];
|
|
99082
99367
|
/** @description One of **your own** captured sites (`GET /v1/site-blueprints`) to build this one from. The new site is provisioned on that blueprint's stack and its archive is then restored onto it, so it comes up with the same content, plugins, theme and settings as the site it was captured from — and its stored web addresses are rewritten to this site's domain. ⛔ **Not the same field as `blueprint_id`**: that one names a stack recipe Zinn® publishes, this one names a template you made from a site you already built. Sending both is a `422`. When given, `source`, `stack_type` and `runtime` are all derived and must not be sent. A blueprint whose capture has not finished, or whose backup is no longer available, is a `422` at create time rather than a site that comes up empty an hour later. */
|
|
99083
99368
|
site_blueprint_id?: components["schemas"]["Uuid"] | null;
|
|
99369
|
+
/** @description The WordPress **Tagline** (`blogdescription`). Read for a WordPress stack only. Omitted or blank leaves WordPress's own tagline. */
|
|
99370
|
+
site_tagline?: string;
|
|
99371
|
+
/** @description The WordPress **Site Title** (V1 parity). Read for a WordPress stack only. Omitted or blank means the primary domain, as before. */
|
|
99372
|
+
site_title?: string;
|
|
99084
99373
|
source?: components["schemas"]["SiteSource"];
|
|
99085
99374
|
stack_type?: components["schemas"]["StackType"];
|
|
99086
99375
|
/** @description The subscription entitling this site. Must belong to the org that will own the site; anything else is a `422` (never a `404`, so it cannot be used to probe which subscription ids exist elsewhere). */
|
|
@@ -110694,6 +110983,25 @@ export interface components {
|
|
|
110694
110983
|
* ⚠️ A value that is not a UUID is **ignored**, not refused — the answer is exactly what you would get with no header at all.
|
|
110695
110984
|
*/
|
|
110696
110985
|
ActiveOrg: string;
|
|
110986
|
+
/** @description Comma-separated `<connection_id>:<campaign_id>` tokens. */
|
|
110987
|
+
AdsAnalyticsCampaign: string;
|
|
110988
|
+
AdsAnalyticsCompare: "previous" | "year" | "none";
|
|
110989
|
+
/** @description Comma-separated ad-account connection ids. */
|
|
110990
|
+
AdsAnalyticsConnection: string;
|
|
110991
|
+
/** @description Comma-separated ISO 3166-1 alpha-2 codes. Reads the country-level figures. */
|
|
110992
|
+
AdsAnalyticsCountry: string;
|
|
110993
|
+
/** @description Reporting currency (ISO 4217). Default the one currency in play, else the organisation's. */
|
|
110994
|
+
AdsAnalyticsCurrency: string;
|
|
110995
|
+
AdsAnalyticsFrom: string;
|
|
110996
|
+
/** @description Bucket size. Default day up to 92 days, week up to 366, month beyond. */
|
|
110997
|
+
AdsAnalyticsGrain: "day" | "week" | "month";
|
|
110998
|
+
/** @description Comma-separated networks (google, microsoft, meta, linkedin, tiktok, x, pinterest, amazon). */
|
|
110999
|
+
AdsAnalyticsNetwork: string;
|
|
111000
|
+
/** @description Comma-separated product/site ids (za-290), or `unassigned`. */
|
|
111001
|
+
AdsAnalyticsOffering: string;
|
|
111002
|
+
/** @description The period. `custom` takes `from` and `to`. */
|
|
111003
|
+
AdsAnalyticsRange: "7d" | "30d" | "90d" | "ytd" | "12m" | "custom";
|
|
111004
|
+
AdsAnalyticsTo: string;
|
|
110697
111005
|
/** @description Board card attachment ID (UUIDv7). */
|
|
110698
111006
|
AgencyBoardAttachmentId: components["schemas"]["Uuid"];
|
|
110699
111007
|
/** @description Board card ID (UUIDv7). */
|
|
@@ -135984,6 +136292,153 @@ export interface operations {
|
|
|
135984
136292
|
429: components["responses"]["TooManyRequests"];
|
|
135985
136293
|
};
|
|
135986
136294
|
};
|
|
136295
|
+
getAdsAnalyticsBreakdown: {
|
|
136296
|
+
parameters: {
|
|
136297
|
+
query?: {
|
|
136298
|
+
by?: "network" | "connection" | "campaign" | "country" | "offering";
|
|
136299
|
+
/** @description Comma-separated `<connection_id>:<campaign_id>` tokens. */
|
|
136300
|
+
campaign?: components["parameters"]["AdsAnalyticsCampaign"];
|
|
136301
|
+
compare?: components["parameters"]["AdsAnalyticsCompare"];
|
|
136302
|
+
/** @description Comma-separated ad-account connection ids. */
|
|
136303
|
+
connection?: components["parameters"]["AdsAnalyticsConnection"];
|
|
136304
|
+
/** @description Comma-separated ISO 3166-1 alpha-2 codes. Reads the country-level figures. */
|
|
136305
|
+
country?: components["parameters"]["AdsAnalyticsCountry"];
|
|
136306
|
+
/** @description Reporting currency (ISO 4217). Default the one currency in play, else the organisation's. */
|
|
136307
|
+
currency?: components["parameters"]["AdsAnalyticsCurrency"];
|
|
136308
|
+
from?: components["parameters"]["AdsAnalyticsFrom"];
|
|
136309
|
+
/** @description Bucket size. Default day up to 92 days, week up to 366, month beyond. */
|
|
136310
|
+
grain?: components["parameters"]["AdsAnalyticsGrain"];
|
|
136311
|
+
limit?: number;
|
|
136312
|
+
/** @description Comma-separated networks (google, microsoft, meta, linkedin, tiktok, x, pinterest, amazon). */
|
|
136313
|
+
network?: components["parameters"]["AdsAnalyticsNetwork"];
|
|
136314
|
+
/** @description Comma-separated product/site ids (za-290), or `unassigned`. */
|
|
136315
|
+
offering?: components["parameters"]["AdsAnalyticsOffering"];
|
|
136316
|
+
offset?: number;
|
|
136317
|
+
org_id?: string;
|
|
136318
|
+
/** @description The period. `custom` takes `from` and `to`. */
|
|
136319
|
+
range?: components["parameters"]["AdsAnalyticsRange"];
|
|
136320
|
+
to?: components["parameters"]["AdsAnalyticsTo"];
|
|
136321
|
+
};
|
|
136322
|
+
header?: never;
|
|
136323
|
+
path?: never;
|
|
136324
|
+
cookie?: never;
|
|
136325
|
+
};
|
|
136326
|
+
requestBody?: never;
|
|
136327
|
+
responses: {
|
|
136328
|
+
/** @description The figures. */
|
|
136329
|
+
200: {
|
|
136330
|
+
headers: {
|
|
136331
|
+
[name: string]: unknown;
|
|
136332
|
+
};
|
|
136333
|
+
content: {
|
|
136334
|
+
"application/json": {
|
|
136335
|
+
data: components["schemas"]["AdsAnalyticsBreakdown"];
|
|
136336
|
+
};
|
|
136337
|
+
};
|
|
136338
|
+
};
|
|
136339
|
+
401: components["responses"]["Unauthorized"];
|
|
136340
|
+
403: components["responses"]["Forbidden"];
|
|
136341
|
+
404: components["responses"]["NotFound"];
|
|
136342
|
+
422: components["responses"]["UnprocessableEntity"];
|
|
136343
|
+
429: components["responses"]["TooManyRequests"];
|
|
136344
|
+
};
|
|
136345
|
+
};
|
|
136346
|
+
getAdsAnalyticsSummary: {
|
|
136347
|
+
parameters: {
|
|
136348
|
+
query?: {
|
|
136349
|
+
/** @description Comma-separated `<connection_id>:<campaign_id>` tokens. */
|
|
136350
|
+
campaign?: components["parameters"]["AdsAnalyticsCampaign"];
|
|
136351
|
+
compare?: components["parameters"]["AdsAnalyticsCompare"];
|
|
136352
|
+
/** @description Comma-separated ad-account connection ids. */
|
|
136353
|
+
connection?: components["parameters"]["AdsAnalyticsConnection"];
|
|
136354
|
+
/** @description Comma-separated ISO 3166-1 alpha-2 codes. Reads the country-level figures. */
|
|
136355
|
+
country?: components["parameters"]["AdsAnalyticsCountry"];
|
|
136356
|
+
/** @description Reporting currency (ISO 4217). Default the one currency in play, else the organisation's. */
|
|
136357
|
+
currency?: components["parameters"]["AdsAnalyticsCurrency"];
|
|
136358
|
+
from?: components["parameters"]["AdsAnalyticsFrom"];
|
|
136359
|
+
/** @description Bucket size. Default day up to 92 days, week up to 366, month beyond. */
|
|
136360
|
+
grain?: components["parameters"]["AdsAnalyticsGrain"];
|
|
136361
|
+
/** @description Comma-separated networks (google, microsoft, meta, linkedin, tiktok, x, pinterest, amazon). */
|
|
136362
|
+
network?: components["parameters"]["AdsAnalyticsNetwork"];
|
|
136363
|
+
/** @description Comma-separated product/site ids (za-290), or `unassigned`. */
|
|
136364
|
+
offering?: components["parameters"]["AdsAnalyticsOffering"];
|
|
136365
|
+
org_id?: string;
|
|
136366
|
+
/** @description The period. `custom` takes `from` and `to`. */
|
|
136367
|
+
range?: components["parameters"]["AdsAnalyticsRange"];
|
|
136368
|
+
to?: components["parameters"]["AdsAnalyticsTo"];
|
|
136369
|
+
};
|
|
136370
|
+
header?: never;
|
|
136371
|
+
path?: never;
|
|
136372
|
+
cookie?: never;
|
|
136373
|
+
};
|
|
136374
|
+
requestBody?: never;
|
|
136375
|
+
responses: {
|
|
136376
|
+
/** @description The figures. */
|
|
136377
|
+
200: {
|
|
136378
|
+
headers: {
|
|
136379
|
+
[name: string]: unknown;
|
|
136380
|
+
};
|
|
136381
|
+
content: {
|
|
136382
|
+
"application/json": {
|
|
136383
|
+
data: components["schemas"]["AdsAnalyticsSummary"];
|
|
136384
|
+
};
|
|
136385
|
+
};
|
|
136386
|
+
};
|
|
136387
|
+
401: components["responses"]["Unauthorized"];
|
|
136388
|
+
403: components["responses"]["Forbidden"];
|
|
136389
|
+
404: components["responses"]["NotFound"];
|
|
136390
|
+
422: components["responses"]["UnprocessableEntity"];
|
|
136391
|
+
429: components["responses"]["TooManyRequests"];
|
|
136392
|
+
};
|
|
136393
|
+
};
|
|
136394
|
+
getAdsAnalyticsTimeseries: {
|
|
136395
|
+
parameters: {
|
|
136396
|
+
query?: {
|
|
136397
|
+
/** @description Comma-separated `<connection_id>:<campaign_id>` tokens. */
|
|
136398
|
+
campaign?: components["parameters"]["AdsAnalyticsCampaign"];
|
|
136399
|
+
compare?: components["parameters"]["AdsAnalyticsCompare"];
|
|
136400
|
+
/** @description Comma-separated ad-account connection ids. */
|
|
136401
|
+
connection?: components["parameters"]["AdsAnalyticsConnection"];
|
|
136402
|
+
/** @description Comma-separated ISO 3166-1 alpha-2 codes. Reads the country-level figures. */
|
|
136403
|
+
country?: components["parameters"]["AdsAnalyticsCountry"];
|
|
136404
|
+
/** @description Reporting currency (ISO 4217). Default the one currency in play, else the organisation's. */
|
|
136405
|
+
currency?: components["parameters"]["AdsAnalyticsCurrency"];
|
|
136406
|
+
from?: components["parameters"]["AdsAnalyticsFrom"];
|
|
136407
|
+
/** @description Bucket size. Default day up to 92 days, week up to 366, month beyond. */
|
|
136408
|
+
grain?: components["parameters"]["AdsAnalyticsGrain"];
|
|
136409
|
+
/** @description Comma-separated networks (google, microsoft, meta, linkedin, tiktok, x, pinterest, amazon). */
|
|
136410
|
+
network?: components["parameters"]["AdsAnalyticsNetwork"];
|
|
136411
|
+
/** @description Comma-separated product/site ids (za-290), or `unassigned`. */
|
|
136412
|
+
offering?: components["parameters"]["AdsAnalyticsOffering"];
|
|
136413
|
+
org_id?: string;
|
|
136414
|
+
/** @description The period. `custom` takes `from` and `to`. */
|
|
136415
|
+
range?: components["parameters"]["AdsAnalyticsRange"];
|
|
136416
|
+
to?: components["parameters"]["AdsAnalyticsTo"];
|
|
136417
|
+
};
|
|
136418
|
+
header?: never;
|
|
136419
|
+
path?: never;
|
|
136420
|
+
cookie?: never;
|
|
136421
|
+
};
|
|
136422
|
+
requestBody?: never;
|
|
136423
|
+
responses: {
|
|
136424
|
+
/** @description The figures. */
|
|
136425
|
+
200: {
|
|
136426
|
+
headers: {
|
|
136427
|
+
[name: string]: unknown;
|
|
136428
|
+
};
|
|
136429
|
+
content: {
|
|
136430
|
+
"application/json": {
|
|
136431
|
+
data: components["schemas"]["AdsAnalyticsTimeseries"];
|
|
136432
|
+
};
|
|
136433
|
+
};
|
|
136434
|
+
};
|
|
136435
|
+
401: components["responses"]["Unauthorized"];
|
|
136436
|
+
403: components["responses"]["Forbidden"];
|
|
136437
|
+
404: components["responses"]["NotFound"];
|
|
136438
|
+
422: components["responses"]["UnprocessableEntity"];
|
|
136439
|
+
429: components["responses"]["TooManyRequests"];
|
|
136440
|
+
};
|
|
136441
|
+
};
|
|
135987
136442
|
listAdsAsks: {
|
|
135988
136443
|
parameters: {
|
|
135989
136444
|
query?: {
|
|
@@ -144841,6 +145296,125 @@ export interface operations {
|
|
|
144841
145296
|
429: components["responses"]["TooManyRequests"];
|
|
144842
145297
|
};
|
|
144843
145298
|
};
|
|
145299
|
+
getAdsTrackingHub: {
|
|
145300
|
+
parameters: {
|
|
145301
|
+
query?: {
|
|
145302
|
+
/** @description Required when you belong to more than one organisation. */
|
|
145303
|
+
org_id?: string;
|
|
145304
|
+
};
|
|
145305
|
+
header?: never;
|
|
145306
|
+
path?: never;
|
|
145307
|
+
cookie?: never;
|
|
145308
|
+
};
|
|
145309
|
+
requestBody?: never;
|
|
145310
|
+
responses: {
|
|
145311
|
+
/** @description The organisation's tracking hub. */
|
|
145312
|
+
200: {
|
|
145313
|
+
headers: {
|
|
145314
|
+
[name: string]: unknown;
|
|
145315
|
+
};
|
|
145316
|
+
content: {
|
|
145317
|
+
"application/json": components["schemas"]["AdsTrackingHub"];
|
|
145318
|
+
};
|
|
145319
|
+
};
|
|
145320
|
+
401: components["responses"]["Unauthorized"];
|
|
145321
|
+
403: components["responses"]["Forbidden"];
|
|
145322
|
+
404: components["responses"]["NotFound"];
|
|
145323
|
+
422: components["responses"]["UnprocessableEntity"];
|
|
145324
|
+
};
|
|
145325
|
+
};
|
|
145326
|
+
updateAdsTrackingHub: {
|
|
145327
|
+
parameters: {
|
|
145328
|
+
query?: never;
|
|
145329
|
+
header?: never;
|
|
145330
|
+
path?: never;
|
|
145331
|
+
cookie?: never;
|
|
145332
|
+
};
|
|
145333
|
+
requestBody: {
|
|
145334
|
+
content: {
|
|
145335
|
+
"application/json": components["schemas"]["AdsTrackingHubUpdate"];
|
|
145336
|
+
};
|
|
145337
|
+
};
|
|
145338
|
+
responses: {
|
|
145339
|
+
/** @description The hub after the change. */
|
|
145340
|
+
200: {
|
|
145341
|
+
headers: {
|
|
145342
|
+
[name: string]: unknown;
|
|
145343
|
+
};
|
|
145344
|
+
content: {
|
|
145345
|
+
"application/json": components["schemas"]["AdsTrackingHub"];
|
|
145346
|
+
};
|
|
145347
|
+
};
|
|
145348
|
+
401: components["responses"]["Unauthorized"];
|
|
145349
|
+
403: components["responses"]["Forbidden"];
|
|
145350
|
+
404: components["responses"]["NotFound"];
|
|
145351
|
+
422: components["responses"]["UnprocessableEntity"];
|
|
145352
|
+
};
|
|
145353
|
+
};
|
|
145354
|
+
setAdsTrackingHubKey: {
|
|
145355
|
+
parameters: {
|
|
145356
|
+
query?: {
|
|
145357
|
+
/** @description Required when you belong to more than one organisation. */
|
|
145358
|
+
org_id?: string;
|
|
145359
|
+
};
|
|
145360
|
+
header?: never;
|
|
145361
|
+
path: {
|
|
145362
|
+
kind: "meta_capi" | "tiktok_events" | "ga4_mp" | "linkedin_capi" | "pinterest_capi";
|
|
145363
|
+
};
|
|
145364
|
+
cookie?: never;
|
|
145365
|
+
};
|
|
145366
|
+
requestBody: {
|
|
145367
|
+
content: {
|
|
145368
|
+
"application/json": {
|
|
145369
|
+
key: string;
|
|
145370
|
+
};
|
|
145371
|
+
};
|
|
145372
|
+
};
|
|
145373
|
+
responses: {
|
|
145374
|
+
/** @description The hub after the change. */
|
|
145375
|
+
200: {
|
|
145376
|
+
headers: {
|
|
145377
|
+
[name: string]: unknown;
|
|
145378
|
+
};
|
|
145379
|
+
content: {
|
|
145380
|
+
"application/json": components["schemas"]["AdsTrackingHub"];
|
|
145381
|
+
};
|
|
145382
|
+
};
|
|
145383
|
+
401: components["responses"]["Unauthorized"];
|
|
145384
|
+
403: components["responses"]["Forbidden"];
|
|
145385
|
+
404: components["responses"]["NotFound"];
|
|
145386
|
+
422: components["responses"]["UnprocessableEntity"];
|
|
145387
|
+
503: components["responses"]["ServiceUnavailable"];
|
|
145388
|
+
};
|
|
145389
|
+
};
|
|
145390
|
+
deleteAdsTrackingHubKey: {
|
|
145391
|
+
parameters: {
|
|
145392
|
+
query?: {
|
|
145393
|
+
/** @description Required when you belong to more than one organisation. */
|
|
145394
|
+
org_id?: string;
|
|
145395
|
+
};
|
|
145396
|
+
header?: never;
|
|
145397
|
+
path: {
|
|
145398
|
+
kind: "meta_capi" | "tiktok_events" | "ga4_mp" | "linkedin_capi" | "pinterest_capi";
|
|
145399
|
+
};
|
|
145400
|
+
cookie?: never;
|
|
145401
|
+
};
|
|
145402
|
+
requestBody?: never;
|
|
145403
|
+
responses: {
|
|
145404
|
+
/** @description Removed (or was not set). */
|
|
145405
|
+
204: {
|
|
145406
|
+
headers: {
|
|
145407
|
+
[name: string]: unknown;
|
|
145408
|
+
};
|
|
145409
|
+
content?: never;
|
|
145410
|
+
};
|
|
145411
|
+
401: components["responses"]["Unauthorized"];
|
|
145412
|
+
403: components["responses"]["Forbidden"];
|
|
145413
|
+
404: components["responses"]["NotFound"];
|
|
145414
|
+
422: components["responses"]["UnprocessableEntity"];
|
|
145415
|
+
503: components["responses"]["ServiceUnavailable"];
|
|
145416
|
+
};
|
|
145417
|
+
};
|
|
144844
145418
|
listAdsTrackingEvents: {
|
|
144845
145419
|
parameters: {
|
|
144846
145420
|
query?: {
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@zinn-digital/sdk",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.1426",
|
|
4
4
|
"description": "Typed TypeScript client for the Zinn Digital Platform API, generated from its OpenAPI spec.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"author": "Neil Lock \u2014 CEO, Zinn Digital\u00ae Ltd <office@zinndigital.com>",
|