@zinn-digital/sdk 0.1.1420 → 0.1.1424

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.
@@ -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).
@@ -15687,6 +15689,49 @@ export interface paths {
15687
15689
  patch?: never;
15688
15690
  trace?: never;
15689
15691
  };
15692
+ "/v1/admin/vendor-usage/moz": {
15693
+ parameters: {
15694
+ query?: never;
15695
+ header?: never;
15696
+ path?: never;
15697
+ cookie?: never;
15698
+ };
15699
+ /**
15700
+ * The shared Moz API account's usage, expected figures and plan advice (staff).
15701
+ * @description s1014 MOZ-V2. One Moz account (Growth Medium) serves V1, V2, ZinnHub and launch. An hourly workflow stores a free `quota.lookup` reading; this returns the newest (used / allotted), the daily burn for 14 days and its 7-day average, the projected month-end, each project's EXPECTED monthly rows (a planning figure, never a cap) with what it reported spending (V2's own spend is its call ledger; `used` null = that project has not reported), and an upgrade-or-overage advice computed from the stored plan prices. Requires staff + `platform.seo.manage`.
15702
+ */
15703
+ get: operations["getMozVendorUsage"];
15704
+ put?: never;
15705
+ post?: never;
15706
+ delete?: never;
15707
+ options?: never;
15708
+ head?: never;
15709
+ patch?: never;
15710
+ trace?: never;
15711
+ };
15712
+ "/v1/admin/vendor-usage/moz/caps/{project}": {
15713
+ parameters: {
15714
+ query?: never;
15715
+ header?: never;
15716
+ path: {
15717
+ /** @example v2 */
15718
+ project: string;
15719
+ };
15720
+ cookie?: never;
15721
+ };
15722
+ get?: never;
15723
+ put?: never;
15724
+ post?: never;
15725
+ delete?: never;
15726
+ options?: never;
15727
+ head?: never;
15728
+ /**
15729
+ * Change one project's expected monthly Moz rows (staff).
15730
+ * @description `monthly_rows` 0-5,000,000 and `alert_percent` 1-100. A planning figure only: nothing stops at it (owner, 2026-11-03: every eligible site is measured; the account-wide alerts are the control). Audit-logged with before and after. Requires staff + `platform.seo.manage`.
15731
+ */
15732
+ patch: operations["updateMozProjectCap"];
15733
+ trace?: never;
15734
+ };
15690
15735
  "/v1/admin/visibility": {
15691
15736
  parameters: {
15692
15737
  query?: never;
@@ -15924,6 +15969,66 @@ export interface paths {
15924
15969
  patch?: never;
15925
15970
  trace?: never;
15926
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
+ };
15927
16032
  "/v1/ads/asks": {
15928
16033
  parameters: {
15929
16034
  query?: never;
@@ -62263,6 +62368,113 @@ export interface components {
62263
62368
  connection_id: string;
62264
62369
  data: components["schemas"]["AdsAllowedTerm"][];
62265
62370
  };
62371
+ AdsAnalyticsBreakdown: components["schemas"]["AdsAnalyticsFrame"] & {
62372
+ /** @enum {string} */
62373
+ by: "network" | "connection" | "campaign" | "country" | "offering";
62374
+ limit: number;
62375
+ offset: number;
62376
+ rows: components["schemas"]["AdsAnalyticsRow"][];
62377
+ total: number;
62378
+ };
62379
+ AdsAnalyticsFigures: {
62380
+ /** Format: int64 */
62381
+ clicks: number;
62382
+ /** Format: int64 */
62383
+ conv_rate_bp: number | null;
62384
+ /** Format: int64 */
62385
+ conversions_milli: number;
62386
+ /** Format: int64 */
62387
+ cost_micros: number;
62388
+ /** Format: int64 */
62389
+ cpa_micros: number | null;
62390
+ /** Format: int64 */
62391
+ cpc_micros: number | null;
62392
+ /** Format: int64 */
62393
+ ctr_bp: number | null;
62394
+ /** Format: int64 */
62395
+ impressions: number;
62396
+ /** Format: int64 */
62397
+ roas_bp: number | null;
62398
+ /** Format: int64 */
62399
+ value_micros: number;
62400
+ };
62401
+ AdsAnalyticsFrame: {
62402
+ accounts: number;
62403
+ /** @enum {string} */
62404
+ compare: "previous" | "year" | "none";
62405
+ /** Format: date */
62406
+ compare_first_day: string | null;
62407
+ /** Format: date */
62408
+ compare_last_day: string | null;
62409
+ currency: string;
62410
+ /** Format: date */
62411
+ first_day: string;
62412
+ fx: components["schemas"]["AdsAnalyticsFx"][];
62413
+ /** @enum {string} */
62414
+ grain: "day" | "week" | "month";
62415
+ /** Format: date */
62416
+ last_day: string;
62417
+ range: string;
62418
+ /** @description Currencies left out of the blended figures for want of a stored rate; `???` stands for accounts whose currency is not known. */
62419
+ unconverted: string[];
62420
+ };
62421
+ AdsAnalyticsFx: {
62422
+ /** @description When the stored rate was fetched (ISO 8601). */
62423
+ as_of: string;
62424
+ from: string;
62425
+ /** @description Major-unit multiplier */
62426
+ rate: string;
62427
+ to: string;
62428
+ };
62429
+ AdsAnalyticsPoint: components["schemas"]["AdsAnalyticsFigures"] & {
62430
+ /** Format: date */
62431
+ bucket: string;
62432
+ };
62433
+ AdsAnalyticsRow: components["schemas"]["AdsAnalyticsFigures"] & {
62434
+ account?: string;
62435
+ assigned?: boolean;
62436
+ campaign_id?: string;
62437
+ /** Format: uuid */
62438
+ connection_id?: string;
62439
+ country?: string;
62440
+ currencies: string[];
62441
+ key: string;
62442
+ kind?: string;
62443
+ label: string;
62444
+ network?: string;
62445
+ /** Format: uuid */
62446
+ offering_id?: string | null;
62447
+ /** Format: uuid */
62448
+ org_id?: string;
62449
+ previous: components["schemas"]["AdsAnalyticsFigures"] | null;
62450
+ spark_cost_micros: number[];
62451
+ };
62452
+ AdsAnalyticsSeries: {
62453
+ buckets?: string[];
62454
+ clicks: number[];
62455
+ conversions_milli: number[];
62456
+ cost_micros: number[];
62457
+ impressions: number[];
62458
+ value_micros: number[];
62459
+ };
62460
+ AdsAnalyticsSummary: components["schemas"]["AdsAnalyticsFrame"] & {
62461
+ by_currency: (components["schemas"]["AdsAnalyticsFigures"] & {
62462
+ currency: string;
62463
+ })[];
62464
+ current: components["schemas"]["AdsAnalyticsFigures"];
62465
+ previous: components["schemas"]["AdsAnalyticsFigures"] | null;
62466
+ previous_sparklines: components["schemas"]["AdsAnalyticsSeries"] | null;
62467
+ sparklines: components["schemas"]["AdsAnalyticsSeries"];
62468
+ };
62469
+ AdsAnalyticsTimeseries: components["schemas"]["AdsAnalyticsFrame"] & {
62470
+ networks: {
62471
+ cost_micros: number[];
62472
+ network: string;
62473
+ value_micros: number[];
62474
+ }[];
62475
+ points: components["schemas"]["AdsAnalyticsPoint"][];
62476
+ previous: components["schemas"]["AdsAnalyticsPoint"][] | null;
62477
+ };
62266
62478
  /** @description One "Ask your ads" question and its checked answer (za-N7, docs/1006 §ASKADS). */
62267
62479
  AdsAsk: {
62268
62480
  /** @description Empty unless `answered`. Fact ids appear in square brackets after the figures they back. */
@@ -87185,6 +87397,65 @@ export interface components {
87185
87397
  step: string | null;
87186
87398
  to_release: string | null;
87187
87399
  };
87400
+ MozProjectCap: {
87401
+ /** @example 80 */
87402
+ alert_percent: number;
87403
+ /** @example V2 */
87404
+ label: string;
87405
+ /** @example 5000 */
87406
+ monthly_rows: number;
87407
+ /** @example v2 */
87408
+ project: string;
87409
+ };
87410
+ /** @description The shared Moz account, as `getMozVendorUsage` reports it (s1014 MOZ-V2). */
87411
+ MozVendorUsage: {
87412
+ advice: {
87413
+ /** @enum {string} */
87414
+ action: "stay" | "upgrade" | "unknown";
87415
+ break_even_rows?: number | null;
87416
+ /** @example USD */
87417
+ currency: string;
87418
+ current_cost_minor?: number | null;
87419
+ plan_key: string;
87420
+ plan_name: string;
87421
+ projected_cost_minor?: number | null;
87422
+ };
87423
+ /** @example 120000 */
87424
+ allotted: number | null;
87425
+ daily: {
87426
+ /** Format: date */
87427
+ day: string;
87428
+ rows: number;
87429
+ }[];
87430
+ daily_burn_avg_7d?: number;
87431
+ period_reset_at?: string | null;
87432
+ plans: {
87433
+ currency: string;
87434
+ is_current: boolean;
87435
+ key: string;
87436
+ monthly_minor: number;
87437
+ name: string;
87438
+ overage_block_rows?: number;
87439
+ overage_minor_per_block?: number | null;
87440
+ rows_included: number;
87441
+ }[];
87442
+ projected_month_end: number | null;
87443
+ projects: {
87444
+ alert_percent: number;
87445
+ label: string;
87446
+ monthly_rows: number;
87447
+ percent: number | null;
87448
+ project: string;
87449
+ used: number | null;
87450
+ }[];
87451
+ read_at: string | null;
87452
+ read_error?: string;
87453
+ read_ok: boolean;
87454
+ spare_rows?: number | null;
87455
+ today_rows?: number;
87456
+ /** @example 4120 */
87457
+ used: number | null;
87458
+ };
87188
87459
  /** @description What one manual sync did. */
87189
87460
  MyXeroSyncRun: {
87190
87461
  connection?: components["schemas"]["XeroConnection"];
@@ -102546,6 +102817,11 @@ export interface components {
102546
102817
  * @example -1
102547
102818
  */
102548
102819
  citation_flow_delta?: number | null;
102820
+ /**
102821
+ * @description s1014 MOZ-V2 (owner 2026-11-03) — Domain Authority by Moz (https://moz.com/), 1-100, free on every LIVE site whatever the plan: first measured 3 days after the site's own domain first reached us, then every 30 days. Null = not measured yet or Moz had no answer — never 0. Any surface showing it credits "Domain Authority by Moz".
102822
+ * @example 24
102823
+ */
102824
+ domain_authority?: number | null;
102549
102825
  /**
102550
102826
  * @description s1006 (owner D42) — Domain Rating by Ahrefs (https://ahrefs.com/), 0-100, on every site whatever the plan: first measured 3 days after the site is added, then monthly. Null = not measured yet or no answer — never 0. Any surface showing it must credit "Domain Rating by Ahrefs" (licence term).
102551
102827
  * @example 37
@@ -102580,6 +102856,13 @@ export interface components {
102580
102856
  * @enum {string}
102581
102857
  */
102582
102858
  index_state: "indexed" | "not_indexed" | "unknown" | "never_checked" | "not_entitled";
102859
+ /** @description When the Moz reading was taken. */
102860
+ moz_measured_at?: string | null;
102861
+ /**
102862
+ * @description Moz Page Authority of the site's homepage, 1-100, from the same reading.
102863
+ * @example 31
102864
+ */
102865
+ page_authority?: number | null;
102583
102866
  /**
102584
102867
  * @description Distinct domains linking here. Null when not supplied; `0` is a measurement.
102585
102868
  * @example 118
@@ -102617,6 +102900,11 @@ export interface components {
102617
102900
  * @enum {string}
102618
102901
  */
102619
102902
  seo_state: "measured" | "not_in_index" | "never_fetched" | "not_entitled";
102903
+ /**
102904
+ * @description Moz Spam Score, 0-100 (percent of sites with similar features Moz found penalised), from the same reading. 0 is a real, good reading; null is unmeasured.
102905
+ * @example 1
102906
+ */
102907
+ spam_score?: number | null;
102620
102908
  /**
102621
102909
  * @description Trust Flow, 0-100. **Null means the provider did not supply it**; `0` means it measured zero. Only present when `seo_state` is `measured`.
102622
102910
  * @example 24
@@ -110575,6 +110863,25 @@ export interface components {
110575
110863
  * ⚠️ A value that is not a UUID is **ignored**, not refused — the answer is exactly what you would get with no header at all.
110576
110864
  */
110577
110865
  ActiveOrg: string;
110866
+ /** @description Comma-separated `<connection_id>:<campaign_id>` tokens. */
110867
+ AdsAnalyticsCampaign: string;
110868
+ AdsAnalyticsCompare: "previous" | "year" | "none";
110869
+ /** @description Comma-separated ad-account connection ids. */
110870
+ AdsAnalyticsConnection: string;
110871
+ /** @description Comma-separated ISO 3166-1 alpha-2 codes. Reads the country-level figures. */
110872
+ AdsAnalyticsCountry: string;
110873
+ /** @description Reporting currency (ISO 4217). Default the one currency in play, else the organisation's. */
110874
+ AdsAnalyticsCurrency: string;
110875
+ AdsAnalyticsFrom: string;
110876
+ /** @description Bucket size. Default day up to 92 days, week up to 366, month beyond. */
110877
+ AdsAnalyticsGrain: "day" | "week" | "month";
110878
+ /** @description Comma-separated networks (google, microsoft, meta, linkedin, tiktok, x, pinterest, amazon). */
110879
+ AdsAnalyticsNetwork: string;
110880
+ /** @description Comma-separated product/site ids (za-290), or `unassigned`. */
110881
+ AdsAnalyticsOffering: string;
110882
+ /** @description The period. `custom` takes `from` and `to`. */
110883
+ AdsAnalyticsRange: "7d" | "30d" | "90d" | "ytd" | "12m" | "custom";
110884
+ AdsAnalyticsTo: string;
110578
110885
  /** @description Board card attachment ID (UUIDv7). */
110579
110886
  AgencyBoardAttachmentId: components["schemas"]["Uuid"];
110580
110887
  /** @description Board card ID (UUIDv7). */
@@ -135470,6 +135777,62 @@ export interface operations {
135470
135777
  429: components["responses"]["TooManyRequests"];
135471
135778
  };
135472
135779
  };
135780
+ getMozVendorUsage: {
135781
+ parameters: {
135782
+ query?: never;
135783
+ header?: never;
135784
+ path?: never;
135785
+ cookie?: never;
135786
+ };
135787
+ requestBody?: never;
135788
+ responses: {
135789
+ /** @description The usage report. */
135790
+ 200: {
135791
+ headers: {
135792
+ [name: string]: unknown;
135793
+ };
135794
+ content: {
135795
+ "application/json": components["schemas"]["MozVendorUsage"];
135796
+ };
135797
+ };
135798
+ 401: components["responses"]["Unauthorized"];
135799
+ 403: components["responses"]["Forbidden"];
135800
+ };
135801
+ };
135802
+ updateMozProjectCap: {
135803
+ parameters: {
135804
+ query?: never;
135805
+ header?: never;
135806
+ path: {
135807
+ /** @example v2 */
135808
+ project: string;
135809
+ };
135810
+ cookie?: never;
135811
+ };
135812
+ requestBody: {
135813
+ content: {
135814
+ "application/json": {
135815
+ alert_percent?: number;
135816
+ monthly_rows?: number;
135817
+ };
135818
+ };
135819
+ };
135820
+ responses: {
135821
+ /** @description The expected figure, as stored. */
135822
+ 200: {
135823
+ headers: {
135824
+ [name: string]: unknown;
135825
+ };
135826
+ content: {
135827
+ "application/json": components["schemas"]["MozProjectCap"];
135828
+ };
135829
+ };
135830
+ 401: components["responses"]["Unauthorized"];
135831
+ 403: components["responses"]["Forbidden"];
135832
+ 404: components["responses"]["NotFound"];
135833
+ 422: components["responses"]["UnprocessableEntity"];
135834
+ };
135835
+ };
135473
135836
  getVisibilitySpend: {
135474
135837
  parameters: {
135475
135838
  query?: never;
@@ -135809,6 +136172,153 @@ export interface operations {
135809
136172
  429: components["responses"]["TooManyRequests"];
135810
136173
  };
135811
136174
  };
136175
+ getAdsAnalyticsBreakdown: {
136176
+ parameters: {
136177
+ query?: {
136178
+ by?: "network" | "connection" | "campaign" | "country" | "offering";
136179
+ /** @description Comma-separated `<connection_id>:<campaign_id>` tokens. */
136180
+ campaign?: components["parameters"]["AdsAnalyticsCampaign"];
136181
+ compare?: components["parameters"]["AdsAnalyticsCompare"];
136182
+ /** @description Comma-separated ad-account connection ids. */
136183
+ connection?: components["parameters"]["AdsAnalyticsConnection"];
136184
+ /** @description Comma-separated ISO 3166-1 alpha-2 codes. Reads the country-level figures. */
136185
+ country?: components["parameters"]["AdsAnalyticsCountry"];
136186
+ /** @description Reporting currency (ISO 4217). Default the one currency in play, else the organisation's. */
136187
+ currency?: components["parameters"]["AdsAnalyticsCurrency"];
136188
+ from?: components["parameters"]["AdsAnalyticsFrom"];
136189
+ /** @description Bucket size. Default day up to 92 days, week up to 366, month beyond. */
136190
+ grain?: components["parameters"]["AdsAnalyticsGrain"];
136191
+ limit?: number;
136192
+ /** @description Comma-separated networks (google, microsoft, meta, linkedin, tiktok, x, pinterest, amazon). */
136193
+ network?: components["parameters"]["AdsAnalyticsNetwork"];
136194
+ /** @description Comma-separated product/site ids (za-290), or `unassigned`. */
136195
+ offering?: components["parameters"]["AdsAnalyticsOffering"];
136196
+ offset?: number;
136197
+ org_id?: string;
136198
+ /** @description The period. `custom` takes `from` and `to`. */
136199
+ range?: components["parameters"]["AdsAnalyticsRange"];
136200
+ to?: components["parameters"]["AdsAnalyticsTo"];
136201
+ };
136202
+ header?: never;
136203
+ path?: never;
136204
+ cookie?: never;
136205
+ };
136206
+ requestBody?: never;
136207
+ responses: {
136208
+ /** @description The figures. */
136209
+ 200: {
136210
+ headers: {
136211
+ [name: string]: unknown;
136212
+ };
136213
+ content: {
136214
+ "application/json": {
136215
+ data: components["schemas"]["AdsAnalyticsBreakdown"];
136216
+ };
136217
+ };
136218
+ };
136219
+ 401: components["responses"]["Unauthorized"];
136220
+ 403: components["responses"]["Forbidden"];
136221
+ 404: components["responses"]["NotFound"];
136222
+ 422: components["responses"]["UnprocessableEntity"];
136223
+ 429: components["responses"]["TooManyRequests"];
136224
+ };
136225
+ };
136226
+ getAdsAnalyticsSummary: {
136227
+ parameters: {
136228
+ query?: {
136229
+ /** @description Comma-separated `<connection_id>:<campaign_id>` tokens. */
136230
+ campaign?: components["parameters"]["AdsAnalyticsCampaign"];
136231
+ compare?: components["parameters"]["AdsAnalyticsCompare"];
136232
+ /** @description Comma-separated ad-account connection ids. */
136233
+ connection?: components["parameters"]["AdsAnalyticsConnection"];
136234
+ /** @description Comma-separated ISO 3166-1 alpha-2 codes. Reads the country-level figures. */
136235
+ country?: components["parameters"]["AdsAnalyticsCountry"];
136236
+ /** @description Reporting currency (ISO 4217). Default the one currency in play, else the organisation's. */
136237
+ currency?: components["parameters"]["AdsAnalyticsCurrency"];
136238
+ from?: components["parameters"]["AdsAnalyticsFrom"];
136239
+ /** @description Bucket size. Default day up to 92 days, week up to 366, month beyond. */
136240
+ grain?: components["parameters"]["AdsAnalyticsGrain"];
136241
+ /** @description Comma-separated networks (google, microsoft, meta, linkedin, tiktok, x, pinterest, amazon). */
136242
+ network?: components["parameters"]["AdsAnalyticsNetwork"];
136243
+ /** @description Comma-separated product/site ids (za-290), or `unassigned`. */
136244
+ offering?: components["parameters"]["AdsAnalyticsOffering"];
136245
+ org_id?: string;
136246
+ /** @description The period. `custom` takes `from` and `to`. */
136247
+ range?: components["parameters"]["AdsAnalyticsRange"];
136248
+ to?: components["parameters"]["AdsAnalyticsTo"];
136249
+ };
136250
+ header?: never;
136251
+ path?: never;
136252
+ cookie?: never;
136253
+ };
136254
+ requestBody?: never;
136255
+ responses: {
136256
+ /** @description The figures. */
136257
+ 200: {
136258
+ headers: {
136259
+ [name: string]: unknown;
136260
+ };
136261
+ content: {
136262
+ "application/json": {
136263
+ data: components["schemas"]["AdsAnalyticsSummary"];
136264
+ };
136265
+ };
136266
+ };
136267
+ 401: components["responses"]["Unauthorized"];
136268
+ 403: components["responses"]["Forbidden"];
136269
+ 404: components["responses"]["NotFound"];
136270
+ 422: components["responses"]["UnprocessableEntity"];
136271
+ 429: components["responses"]["TooManyRequests"];
136272
+ };
136273
+ };
136274
+ getAdsAnalyticsTimeseries: {
136275
+ parameters: {
136276
+ query?: {
136277
+ /** @description Comma-separated `<connection_id>:<campaign_id>` tokens. */
136278
+ campaign?: components["parameters"]["AdsAnalyticsCampaign"];
136279
+ compare?: components["parameters"]["AdsAnalyticsCompare"];
136280
+ /** @description Comma-separated ad-account connection ids. */
136281
+ connection?: components["parameters"]["AdsAnalyticsConnection"];
136282
+ /** @description Comma-separated ISO 3166-1 alpha-2 codes. Reads the country-level figures. */
136283
+ country?: components["parameters"]["AdsAnalyticsCountry"];
136284
+ /** @description Reporting currency (ISO 4217). Default the one currency in play, else the organisation's. */
136285
+ currency?: components["parameters"]["AdsAnalyticsCurrency"];
136286
+ from?: components["parameters"]["AdsAnalyticsFrom"];
136287
+ /** @description Bucket size. Default day up to 92 days, week up to 366, month beyond. */
136288
+ grain?: components["parameters"]["AdsAnalyticsGrain"];
136289
+ /** @description Comma-separated networks (google, microsoft, meta, linkedin, tiktok, x, pinterest, amazon). */
136290
+ network?: components["parameters"]["AdsAnalyticsNetwork"];
136291
+ /** @description Comma-separated product/site ids (za-290), or `unassigned`. */
136292
+ offering?: components["parameters"]["AdsAnalyticsOffering"];
136293
+ org_id?: string;
136294
+ /** @description The period. `custom` takes `from` and `to`. */
136295
+ range?: components["parameters"]["AdsAnalyticsRange"];
136296
+ to?: components["parameters"]["AdsAnalyticsTo"];
136297
+ };
136298
+ header?: never;
136299
+ path?: never;
136300
+ cookie?: never;
136301
+ };
136302
+ requestBody?: never;
136303
+ responses: {
136304
+ /** @description The figures. */
136305
+ 200: {
136306
+ headers: {
136307
+ [name: string]: unknown;
136308
+ };
136309
+ content: {
136310
+ "application/json": {
136311
+ data: components["schemas"]["AdsAnalyticsTimeseries"];
136312
+ };
136313
+ };
136314
+ };
136315
+ 401: components["responses"]["Unauthorized"];
136316
+ 403: components["responses"]["Forbidden"];
136317
+ 404: components["responses"]["NotFound"];
136318
+ 422: components["responses"]["UnprocessableEntity"];
136319
+ 429: components["responses"]["TooManyRequests"];
136320
+ };
136321
+ };
135812
136322
  listAdsAsks: {
135813
136323
  parameters: {
135814
136324
  query?: {
@@ -187139,8 +187649,20 @@ export interface operations {
187139
187649
  group?: string;
187140
187650
  /** @description Maximum items to return (page size). */
187141
187651
  limit?: components["parameters"]["Limit"];
187652
+ /** @description Only sites whose newest Moz Domain Authority is at most this. s1014 MOZ-V2. A site Moz has not measured is excluded by any bound on that metric (not measured is never 0). Applied across the whole collection. */
187653
+ max_da?: number;
187654
+ /** @description Only sites whose newest Moz homepage Page Authority is at most this. s1014 MOZ-V2. A site Moz has not measured is excluded by any bound on that metric (not measured is never 0). Applied across the whole collection. */
187655
+ max_pa?: number;
187656
+ /** @description Only sites whose newest Moz Spam Score (percent) is at most this. s1014 MOZ-V2. A site Moz has not measured is excluded by any bound on that metric (not measured is never 0). Applied across the whole collection. */
187657
+ max_spam?: number;
187658
+ /** @description Only sites whose newest Moz Domain Authority is at least this. s1014 MOZ-V2. A site Moz has not measured is excluded by any bound on that metric (not measured is never 0). Applied across the whole collection. */
187659
+ min_da?: number;
187660
+ /** @description Only sites whose newest Moz homepage Page Authority is at least this. s1014 MOZ-V2. A site Moz has not measured is excluded by any bound on that metric (not measured is never 0). Applied across the whole collection. */
187661
+ min_pa?: number;
187662
+ /** @description Only sites whose newest Moz Spam Score (percent) is at least this. s1014 MOZ-V2. A site Moz has not measured is excluded by any bound on that metric (not measured is never 0). Applied across the whole collection. */
187663
+ min_spam?: number;
187142
187664
  /** @description Sort key, optionally `-`-prefixed for descending. Defaults to `-created` (newest first). Sorting is applied across the whole collection and the cursor carries the sort position, so paging a sorted list is exact. An unrecognised key is a 422, never a silent fall back to the default. */
187143
- ordering?: "domain" | "-domain" | "name" | "-name" | "status" | "-status" | "line" | "-line" | "stack" | "-stack" | "region" | "-region" | "plan" | "-plan" | "created" | "-created" | "authority" | "-authority" | "indexed" | "-indexed";
187665
+ ordering?: "domain" | "-domain" | "name" | "-name" | "status" | "-status" | "line" | "-line" | "stack" | "-stack" | "region" | "-region" | "plan" | "-plan" | "created" | "-created" | "authority" | "-authority" | "indexed" | "-indexed" | "da" | "-da" | "pa" | "-pa" | "spam" | "-spam";
187144
187666
  /** @description Restrict to one organization in scope (default — the whole subtree). */
187145
187667
  org_id?: components["schemas"]["Uuid"];
187146
187668
  /** @description Filter by product line code (e.g. `footprint_free`, `mainstream`). */
@@ -197373,6 +197895,18 @@ export interface operations {
197373
197895
  query?: {
197374
197896
  /** @description Restrict to the sites in one site group. */
197375
197897
  group?: string;
197898
+ /** @description Only sites whose newest Moz Domain Authority is at most this, exactly as `listSites` applies it (s1014 MOZ-V2); an unmeasured site is excluded by any bound. */
197899
+ max_da?: number;
197900
+ /** @description Only sites whose newest Moz homepage Page Authority is at most this, exactly as `listSites` applies it (s1014 MOZ-V2); an unmeasured site is excluded by any bound. */
197901
+ max_pa?: number;
197902
+ /** @description Only sites whose newest Moz Spam Score (percent) is at most this, exactly as `listSites` applies it (s1014 MOZ-V2); an unmeasured site is excluded by any bound. */
197903
+ max_spam?: number;
197904
+ /** @description Only sites whose newest Moz Domain Authority is at least this, exactly as `listSites` applies it (s1014 MOZ-V2); an unmeasured site is excluded by any bound. */
197905
+ min_da?: number;
197906
+ /** @description Only sites whose newest Moz homepage Page Authority is at least this, exactly as `listSites` applies it (s1014 MOZ-V2); an unmeasured site is excluded by any bound. */
197907
+ min_pa?: number;
197908
+ /** @description Only sites whose newest Moz Spam Score (percent) is at least this, exactly as `listSites` applies it (s1014 MOZ-V2); an unmeasured site is excluded by any bound. */
197909
+ min_spam?: number;
197376
197910
  /** @description Restrict to one organization in the caller's scope. */
197377
197911
  org_id?: components["schemas"]["Uuid"];
197378
197912
  /** @description Filter by product line code. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@zinn-digital/sdk",
3
- "version": "0.1.1420",
3
+ "version": "0.1.1424",
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>",