@zinn-digital/sdk 0.1.1435 → 0.1.1436

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.
@@ -41232,6 +41232,28 @@ export interface paths {
41232
41232
  patch?: never;
41233
41233
  trace?: never;
41234
41234
  };
41235
+ "/v1/public/ads-tag/{public_key}/signals": {
41236
+ parameters: {
41237
+ query?: never;
41238
+ header?: never;
41239
+ path: {
41240
+ public_key: string;
41241
+ };
41242
+ cookie?: never;
41243
+ };
41244
+ get?: never;
41245
+ put?: never;
41246
+ /**
41247
+ * The universal tag's click-shield beacon (public, rate-limited, per-site key).
41248
+ * @description Public (SHIELDTAG, docs/1006.d/features/za-316-shieldtag.md): the universal script sends it with `navigator.sendBeacon` as `text/plain` JSON (no CORS preflight), so the click-fraud shield works on ANY website, not only sites Zinn® hosts. `k` is `landing` (a paid-click visit; `q` holds ONLY the recognised click ids — gclid, msclkid, fbclid, ttclid, li_fat_id, twclid, epik), `engaged` (the visitor scrolled, tapped or typed), `page` (a later page view, only after ad consent) or `conversion` (`zinnAds.conversion` ran). The visitor address and user agent are the REQUEST's (our ingress's trusted client address), never the body's; the host is the tag's own site; the time is the engine's. The `Origin` must be the tag's site or a subdomain of it. A follow-up is kept only when the same address landed from a paid click inside the 10-minute dwell window. Landings are scored by the same shield as hosted sites every 5 minutes once the dwell window closed (same weights, verdicts, IP exclusions and claim packs), only while the organisation has the shield and is in good standing; a site already scored as a hosted site or by the Zinn® Ads WordPress plugin is not scored twice. Beacons are deleted after 3 days. Always `204` for a well-formed beacon, stored or not (no oracle).
41249
+ */
41250
+ post: operations["sendAdsSiteTagSignal"];
41251
+ delete?: never;
41252
+ options?: never;
41253
+ head?: never;
41254
+ patch?: never;
41255
+ trace?: never;
41256
+ };
41235
41257
  "/v1/public/ads-wordpress/claim": {
41236
41258
  parameters: {
41237
41259
  query?: never;
@@ -67028,6 +67050,13 @@ export interface components {
67028
67050
  meta_pixel_id?: string;
67029
67051
  microsoft_uet_id?: string;
67030
67052
  };
67053
+ /** @description What the click shield has seen through this tag (SHIELDTAG, docs/1006.d/features/za-316-shieldtag.md): when the last paid-click landing beacon arrived and the clicks scored from it in 30 days. Set on the list and the single read; the tag protects a site we do not host as soon as it is installed and the organisation has the shield. */
67054
+ shield?: {
67055
+ clicks_30d: number;
67056
+ /** Format: date-time */
67057
+ last_landing_at: string | null;
67058
+ suspected_30d: number;
67059
+ };
67031
67060
  site_host: string;
67032
67061
  /** Format: date-time */
67033
67062
  updated_at: string | null;
@@ -179682,6 +179711,40 @@ export interface operations {
179682
179711
  };
179683
179712
  };
179684
179713
  };
179714
+ sendAdsSiteTagSignal: {
179715
+ parameters: {
179716
+ query?: never;
179717
+ header?: never;
179718
+ path: {
179719
+ public_key: string;
179720
+ };
179721
+ cookie?: never;
179722
+ };
179723
+ requestBody: {
179724
+ content: {
179725
+ "text/plain": string;
179726
+ };
179727
+ };
179728
+ responses: {
179729
+ /** @description Received (stored, or ignored on purpose). */
179730
+ 204: {
179731
+ headers: {
179732
+ /** @description * */
179733
+ "Access-Control-Allow-Origin"?: string;
179734
+ [name: string]: unknown;
179735
+ };
179736
+ content?: never;
179737
+ };
179738
+ /** @description Not a beacon (bad JSON, unknown kind, a landing without a click id, too large). */
179739
+ 400: {
179740
+ headers: {
179741
+ [name: string]: unknown;
179742
+ };
179743
+ content?: never;
179744
+ };
179745
+ 429: components["responses"]["TooManyRequests"];
179746
+ };
179747
+ };
179685
179748
  claimAdsWordPressSite: {
179686
179749
  parameters: {
179687
179750
  query?: never;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@zinn-digital/sdk",
3
- "version": "0.1.1435",
3
+ "version": "0.1.1436",
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>",