@zinn-digital/sdk 0.1.1356 → 0.1.1358
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 +95 -0
- package/package.json +1 -1
|
@@ -48448,6 +48448,29 @@ export interface paths {
|
|
|
48448
48448
|
patch?: never;
|
|
48449
48449
|
trace?: never;
|
|
48450
48450
|
};
|
|
48451
|
+
"/v1/sites/{siteId}/install-progress": {
|
|
48452
|
+
parameters: {
|
|
48453
|
+
query?: never;
|
|
48454
|
+
header?: never;
|
|
48455
|
+
path: {
|
|
48456
|
+
/** @description Site ID (UUIDv7). */
|
|
48457
|
+
siteId: components["parameters"]["SiteId"];
|
|
48458
|
+
};
|
|
48459
|
+
cookie?: never;
|
|
48460
|
+
};
|
|
48461
|
+
/**
|
|
48462
|
+
* The installing screen's live stage, measured timing and Retry validity.
|
|
48463
|
+
* @description Row 45 (s1014, owner 2026-10-29). `install` is the same answer `retrySiteProvisioning` enforces; `step` is the running workflow's own progress answer, asked only while the site is installing and `null` when it cannot be asked (a Temporal fault degrades the field, never the response). Requires `sites.view`.
|
|
48464
|
+
*/
|
|
48465
|
+
get: operations["getSiteInstallProgress"];
|
|
48466
|
+
put?: never;
|
|
48467
|
+
post?: never;
|
|
48468
|
+
delete?: never;
|
|
48469
|
+
options?: never;
|
|
48470
|
+
head?: never;
|
|
48471
|
+
patch?: never;
|
|
48472
|
+
trace?: never;
|
|
48473
|
+
};
|
|
48451
48474
|
"/v1/sites/{siteId}/mail-smtp": {
|
|
48452
48475
|
parameters: {
|
|
48453
48476
|
query?: never;
|
|
@@ -50060,6 +50083,8 @@ export interface paths {
|
|
|
50060
50083
|
* ⛔ Nothing here calls Temporal (§2.9). The status change and a `site.created` event commit in one transaction and the existing consumer starts the workflow, so a Temporal outage cannot leave the row half-moved.
|
|
50061
50084
|
*
|
|
50062
50085
|
* A site that is `active`, `deleting` or `deleted` is a `422` — a retry re-runs the build, and those are past it. Requires `sites.view` and `hosting.deploy.manage`.
|
|
50086
|
+
*
|
|
50087
|
+
* **Row 45 (s1014).** A `provisioning` site past its measured p90 is STALLED: Retry terminates the old run and starts afresh (row-locked, so a double press starts one workflow; the second answers `refusal: in_flight`). A `failed` site is refused with `422` (`refusal.sites.retryCoolingDown`) for 3 minutes after the failure, and (`refusal.sites.retryNotInGoodStanding`) when the account is not in good standing - exactly when `Site.install.retry.enabled` is `false`.
|
|
50063
50088
|
*/
|
|
50064
50089
|
post: operations["retrySiteProvisioning"];
|
|
50065
50090
|
delete?: never;
|
|
@@ -61755,6 +61780,7 @@ export interface components {
|
|
|
61755
61780
|
/** Format: uuid */
|
|
61756
61781
|
connection_id: string;
|
|
61757
61782
|
country: string;
|
|
61783
|
+
/** @description Where calls are forwarded; `""` = forwarding switched off (calls refused unanswered). */
|
|
61758
61784
|
forward_to: string;
|
|
61759
61785
|
/** Format: uuid */
|
|
61760
61786
|
id: string;
|
|
@@ -95153,6 +95179,8 @@ export interface components {
|
|
|
95153
95179
|
*/
|
|
95154
95180
|
failed_step?: string;
|
|
95155
95181
|
id: components["schemas"]["Uuid"];
|
|
95182
|
+
/** @description Row 45 (s1014, owner 2026-10-29): what the installing screen may honestly say, and whether Retry is valid - the same answer `retrySiteProvisioning` enforces. `null` unless the site is `pending`, `provisioning` or `failed`. */
|
|
95183
|
+
install?: components["schemas"]["SiteInstallState"] | null;
|
|
95156
95184
|
/**
|
|
95157
95185
|
* @description Human label for the site; defaults to the primary domain.
|
|
95158
95186
|
* @example Acme Marketing Site
|
|
@@ -97839,6 +97867,40 @@ export interface components {
|
|
|
97839
97867
|
* @enum {string}
|
|
97840
97868
|
*/
|
|
97841
97869
|
SiteImportStatus: "pending" | "indexing" | "fetching" | "building" | "deploying" | "verifying" | "completed" | "failed" | "cancelled";
|
|
97870
|
+
/** @description The installing screen's one read (row 45). */
|
|
97871
|
+
SiteInstallProgress: {
|
|
97872
|
+
install: components["schemas"]["SiteInstallState"];
|
|
97873
|
+
/** Format: uuid */
|
|
97874
|
+
site_id: string;
|
|
97875
|
+
status: string;
|
|
97876
|
+
/** @description The running workflow's own stage key (`begin`, `placement`, `account`, `blueprint`, `cdn`, `dns`, `verify`, `activate`, `rollback`), or `null` when it could not be asked - unknown, never zero (ADR 0023). */
|
|
97877
|
+
step: string | null;
|
|
97878
|
+
steps_done: number | null;
|
|
97879
|
+
steps_total: number | null;
|
|
97880
|
+
};
|
|
97881
|
+
/** @description Row 45 (s1014): the installing screen's honest state. `stalled` means past the measured p90 for this application (never under 5 minutes) with no end; Retry then restarts it. Retry is HIDDEN while running normally and after success; SHOWN but disabled (`enabled: false` with a `reason`) during the 3-minute cool-down after a failure and when the account is not in good standing. */
|
|
97882
|
+
SiteInstallState: {
|
|
97883
|
+
elapsed_seconds: number;
|
|
97884
|
+
/** @description Median of the last 200 finished installs of this application on this location, measured ESTATE-WIDE (durations only, no tenant data), so every org reads the same figure; falls back to the application on any location, then every install. */
|
|
97885
|
+
p50_seconds: number;
|
|
97886
|
+
p90_seconds: number;
|
|
97887
|
+
retry: {
|
|
97888
|
+
enabled: boolean;
|
|
97889
|
+
/** @enum {string|null} */
|
|
97890
|
+
reason: "running" | "done" | "cooldown" | "not_in_good_standing" | "not_retryable" | null;
|
|
97891
|
+
/** Format: date-time */
|
|
97892
|
+
retry_after: string | null;
|
|
97893
|
+
visible: boolean;
|
|
97894
|
+
};
|
|
97895
|
+
/** @description `true` only while the run is still going AND staff were really paged about it (the hung-install page fires once at the later of p90 and 12 minutes). The screen says "our team has been alerted" only when this is `true`; past p90 alone is not a page. */
|
|
97896
|
+
staff_alerted: boolean;
|
|
97897
|
+
/** Format: date-time */
|
|
97898
|
+
started_at: string | null;
|
|
97899
|
+
/** @enum {string} */
|
|
97900
|
+
state: "running" | "stalled" | "failed" | "done" | "other";
|
|
97901
|
+
/** @description How many runs the percentiles were read from; `0` means the fallback. */
|
|
97902
|
+
timing_samples: number;
|
|
97903
|
+
};
|
|
97842
97904
|
SiteIntegrityFinding: {
|
|
97843
97905
|
/** @description Staff only. */
|
|
97844
97906
|
actor?: string;
|
|
@@ -99678,6 +99740,11 @@ export interface components {
|
|
|
99678
99740
|
};
|
|
99679
99741
|
/** @description The outcome of asking for a failed site to be built again. */
|
|
99680
99742
|
SiteProvisioningRetry: {
|
|
99743
|
+
/**
|
|
99744
|
+
* @description Why nothing was restarted, as a machine key: `in_flight` when a build is already running (a second press while one is in flight is never a second workflow). `null` when `restarted` is `true`.
|
|
99745
|
+
* @enum {string|null}
|
|
99746
|
+
*/
|
|
99747
|
+
refusal?: "in_flight" | null;
|
|
99681
99748
|
/**
|
|
99682
99749
|
* @description `true` when this call moved the row and queued a build; `false` when the site was **already** provisioning, which is a success and not a conflict.
|
|
99683
99750
|
*
|
|
@@ -136258,6 +136325,7 @@ export interface operations {
|
|
|
136258
136325
|
requestBody: {
|
|
136259
136326
|
content: {
|
|
136260
136327
|
"application/json": {
|
|
136328
|
+
/** @description The US phone number (E.164) calls are forwarded to; `""` switches forwarding off — the number is kept and every call to it is refused unanswered (no minute is billed). One of our own tracking numbers is refused (`callForwardToNotOffered`). */
|
|
136261
136329
|
forward_to?: string;
|
|
136262
136330
|
name?: string;
|
|
136263
136331
|
};
|
|
@@ -187556,6 +187624,33 @@ export interface operations {
|
|
|
187556
187624
|
404: components["responses"]["NotFound"];
|
|
187557
187625
|
};
|
|
187558
187626
|
};
|
|
187627
|
+
getSiteInstallProgress: {
|
|
187628
|
+
parameters: {
|
|
187629
|
+
query?: never;
|
|
187630
|
+
header?: never;
|
|
187631
|
+
path: {
|
|
187632
|
+
/** @description Site ID (UUIDv7). */
|
|
187633
|
+
siteId: components["parameters"]["SiteId"];
|
|
187634
|
+
};
|
|
187635
|
+
cookie?: never;
|
|
187636
|
+
};
|
|
187637
|
+
requestBody?: never;
|
|
187638
|
+
responses: {
|
|
187639
|
+
/** @description The site's install progress. */
|
|
187640
|
+
200: {
|
|
187641
|
+
headers: {
|
|
187642
|
+
[name: string]: unknown;
|
|
187643
|
+
};
|
|
187644
|
+
content: {
|
|
187645
|
+
"application/json": components["schemas"]["SiteInstallProgress"];
|
|
187646
|
+
};
|
|
187647
|
+
};
|
|
187648
|
+
401: components["responses"]["Unauthorized"];
|
|
187649
|
+
403: components["responses"]["Forbidden"];
|
|
187650
|
+
404: components["responses"]["NotFound"];
|
|
187651
|
+
429: components["responses"]["TooManyRequests"];
|
|
187652
|
+
};
|
|
187653
|
+
};
|
|
187559
187654
|
getSiteMailSmtp: {
|
|
187560
187655
|
parameters: {
|
|
187561
187656
|
query?: never;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@zinn-digital/sdk",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.1358",
|
|
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>",
|