@zinn-digital/sdk 0.1.1365 → 0.1.1366
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 +182 -0
- package/package.json +1 -1
|
@@ -45873,6 +45873,56 @@ export interface paths {
|
|
|
45873
45873
|
patch?: never;
|
|
45874
45874
|
trace?: never;
|
|
45875
45875
|
};
|
|
45876
|
+
"/v1/sites/{siteId}/app-auto-update": {
|
|
45877
|
+
parameters: {
|
|
45878
|
+
query?: never;
|
|
45879
|
+
header?: never;
|
|
45880
|
+
path: {
|
|
45881
|
+
/** @description Site ID (UUIDv7). */
|
|
45882
|
+
siteId: components["parameters"]["SiteId"];
|
|
45883
|
+
};
|
|
45884
|
+
cookie?: never;
|
|
45885
|
+
};
|
|
45886
|
+
/**
|
|
45887
|
+
* Read a site's automatic app updates add-on and its window.
|
|
45888
|
+
* @description The paid automatic-updates add-on for the app the site runs (`wordpress_auto_updates` or `woocommerce_auto_updates`, USD 29 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 updates WordPress core, plugins and themes in the window, takes a safety backup first and rolls back to it when the homepage breaks. A held plugin version is never applied. Buy it through `purchaseExtra` with `site_id`. Requires `sites.view`.
|
|
45889
|
+
*/
|
|
45890
|
+
get: operations["getSiteAppAutoUpdate"];
|
|
45891
|
+
/**
|
|
45892
|
+
* Turn automatic app updates on or off and choose the window.
|
|
45893
|
+
* @description Sets the quiet window (`window_weekday` 0 = Monday to 6 = Sunday, or null for every day; `window_hour` 0-23; an IANA `timezone`). Turning it on needs the add-on on this site (`422 refusal.appAutoUpdate.notOnSite`); a bad hour, weekday or time zone is `422`. Requires `sites.view` and `hosting.applications.manage`.
|
|
45894
|
+
*/
|
|
45895
|
+
put: operations["updateSiteAppAutoUpdate"];
|
|
45896
|
+
post?: never;
|
|
45897
|
+
delete?: never;
|
|
45898
|
+
options?: never;
|
|
45899
|
+
head?: never;
|
|
45900
|
+
patch?: never;
|
|
45901
|
+
trace?: never;
|
|
45902
|
+
};
|
|
45903
|
+
"/v1/sites/{siteId}/app-auto-update/stop": {
|
|
45904
|
+
parameters: {
|
|
45905
|
+
query?: never;
|
|
45906
|
+
header?: never;
|
|
45907
|
+
path: {
|
|
45908
|
+
/** @description Site ID (UUIDv7). */
|
|
45909
|
+
siteId: components["parameters"]["SiteId"];
|
|
45910
|
+
};
|
|
45911
|
+
cookie?: never;
|
|
45912
|
+
};
|
|
45913
|
+
get?: never;
|
|
45914
|
+
put?: never;
|
|
45915
|
+
/**
|
|
45916
|
+
* Stop a site's automatic app updates renewing.
|
|
45917
|
+
* @description Stops the yearly renewal of the site's automatic app updates add-on. Updates keep running until the day before the renewal date and are not refunded. A site without the add-on is `422 refusal.appAutoUpdate.notOnSite`. Requires `sites.view` and `billing.payment.manage`.
|
|
45918
|
+
*/
|
|
45919
|
+
post: operations["stopSiteAppAutoUpdate"];
|
|
45920
|
+
delete?: never;
|
|
45921
|
+
options?: never;
|
|
45922
|
+
head?: never;
|
|
45923
|
+
patch?: never;
|
|
45924
|
+
trace?: never;
|
|
45925
|
+
};
|
|
45876
45926
|
"/v1/sites/{siteId}/app/previews/{previewId}": {
|
|
45877
45927
|
parameters: {
|
|
45878
45928
|
query?: never;
|
|
@@ -95492,6 +95542,46 @@ export interface components {
|
|
|
95492
95542
|
total_ms: number;
|
|
95493
95543
|
transaction: string;
|
|
95494
95544
|
};
|
|
95545
|
+
/** @description The paid automatic app updates add-on for one site (s1014 row 41): the code that applies (`wordpress_auto_updates` or `woocommerce_auto_updates`), the window and the last run's outcome. */
|
|
95546
|
+
SiteAppAutoUpdate: {
|
|
95547
|
+
/** @description Whether the add-on is on and in good standing now. */
|
|
95548
|
+
active: boolean;
|
|
95549
|
+
/**
|
|
95550
|
+
* @description The app the add-on serves on this site, or null when none is sold for it.
|
|
95551
|
+
* @enum {string|null}
|
|
95552
|
+
*/
|
|
95553
|
+
app_key: "wordpress" | "woocommerce" | null;
|
|
95554
|
+
can_buy: boolean;
|
|
95555
|
+
/** @description The catalogue code to buy (`<app_key>_auto_updates`). */
|
|
95556
|
+
code: string | null;
|
|
95557
|
+
enabled: boolean;
|
|
95558
|
+
/** Format: date */
|
|
95559
|
+
ends_on: string | null;
|
|
95560
|
+
/** @description What the last run changed, or why it was rolled back. */
|
|
95561
|
+
last_detail: string | null;
|
|
95562
|
+
/** @enum {string|null} */
|
|
95563
|
+
last_outcome: "updated" | "current" | "rolled_back" | "failed" | null;
|
|
95564
|
+
/** Format: date-time */
|
|
95565
|
+
last_run_at: string | null;
|
|
95566
|
+
/** Format: date-time */
|
|
95567
|
+
next_window_at: string | null;
|
|
95568
|
+
/** @description Whether the add-on is on sale to this organisation. */
|
|
95569
|
+
offered: boolean;
|
|
95570
|
+
/** @description The yearly price in the caller's currency, or null when not on sale. */
|
|
95571
|
+
price: components["schemas"]["MoneyAmount"] | null;
|
|
95572
|
+
/** Format: uuid */
|
|
95573
|
+
purchase_id: string | null;
|
|
95574
|
+
/** @description Why it cannot be bought right now, or null. */
|
|
95575
|
+
refusal: string | null;
|
|
95576
|
+
/** Format: date */
|
|
95577
|
+
renews_on: string | null;
|
|
95578
|
+
/** Format: uuid */
|
|
95579
|
+
site_id: string;
|
|
95580
|
+
timezone: string;
|
|
95581
|
+
window_hour: number;
|
|
95582
|
+
/** @description 0 = Monday to 6 = Sunday; null = every day. */
|
|
95583
|
+
window_weekday: number | null;
|
|
95584
|
+
};
|
|
95495
95585
|
SiteBackup: {
|
|
95496
95586
|
/** Format: date-time */
|
|
95497
95587
|
created_at: string;
|
|
@@ -183771,6 +183861,98 @@ export interface operations {
|
|
|
183771
183861
|
429: components["responses"]["TooManyRequests"];
|
|
183772
183862
|
};
|
|
183773
183863
|
};
|
|
183864
|
+
getSiteAppAutoUpdate: {
|
|
183865
|
+
parameters: {
|
|
183866
|
+
query?: never;
|
|
183867
|
+
header?: never;
|
|
183868
|
+
path: {
|
|
183869
|
+
/** @description Site ID (UUIDv7). */
|
|
183870
|
+
siteId: components["parameters"]["SiteId"];
|
|
183871
|
+
};
|
|
183872
|
+
cookie?: never;
|
|
183873
|
+
};
|
|
183874
|
+
requestBody?: never;
|
|
183875
|
+
responses: {
|
|
183876
|
+
/** @description The site's automatic app updates state. */
|
|
183877
|
+
200: {
|
|
183878
|
+
headers: {
|
|
183879
|
+
[name: string]: unknown;
|
|
183880
|
+
};
|
|
183881
|
+
content: {
|
|
183882
|
+
"application/json": components["schemas"]["SiteAppAutoUpdate"];
|
|
183883
|
+
};
|
|
183884
|
+
};
|
|
183885
|
+
401: components["responses"]["Unauthorized"];
|
|
183886
|
+
403: components["responses"]["Forbidden"];
|
|
183887
|
+
404: components["responses"]["NotFound"];
|
|
183888
|
+
429: components["responses"]["TooManyRequests"];
|
|
183889
|
+
};
|
|
183890
|
+
};
|
|
183891
|
+
updateSiteAppAutoUpdate: {
|
|
183892
|
+
parameters: {
|
|
183893
|
+
query?: never;
|
|
183894
|
+
header?: never;
|
|
183895
|
+
path: {
|
|
183896
|
+
/** @description Site ID (UUIDv7). */
|
|
183897
|
+
siteId: components["parameters"]["SiteId"];
|
|
183898
|
+
};
|
|
183899
|
+
cookie?: never;
|
|
183900
|
+
};
|
|
183901
|
+
requestBody: {
|
|
183902
|
+
content: {
|
|
183903
|
+
"application/json": {
|
|
183904
|
+
enabled: boolean;
|
|
183905
|
+
timezone: string;
|
|
183906
|
+
window_hour: number;
|
|
183907
|
+
window_weekday?: number | null;
|
|
183908
|
+
};
|
|
183909
|
+
};
|
|
183910
|
+
};
|
|
183911
|
+
responses: {
|
|
183912
|
+
/** @description The site's automatic app updates state after the change. */
|
|
183913
|
+
200: {
|
|
183914
|
+
headers: {
|
|
183915
|
+
[name: string]: unknown;
|
|
183916
|
+
};
|
|
183917
|
+
content: {
|
|
183918
|
+
"application/json": components["schemas"]["SiteAppAutoUpdate"];
|
|
183919
|
+
};
|
|
183920
|
+
};
|
|
183921
|
+
401: components["responses"]["Unauthorized"];
|
|
183922
|
+
403: components["responses"]["Forbidden"];
|
|
183923
|
+
404: components["responses"]["NotFound"];
|
|
183924
|
+
422: components["responses"]["UnprocessableEntity"];
|
|
183925
|
+
429: components["responses"]["TooManyRequests"];
|
|
183926
|
+
};
|
|
183927
|
+
};
|
|
183928
|
+
stopSiteAppAutoUpdate: {
|
|
183929
|
+
parameters: {
|
|
183930
|
+
query?: never;
|
|
183931
|
+
header?: never;
|
|
183932
|
+
path: {
|
|
183933
|
+
/** @description Site ID (UUIDv7). */
|
|
183934
|
+
siteId: components["parameters"]["SiteId"];
|
|
183935
|
+
};
|
|
183936
|
+
cookie?: never;
|
|
183937
|
+
};
|
|
183938
|
+
requestBody?: never;
|
|
183939
|
+
responses: {
|
|
183940
|
+
/** @description The renewal is stopped; the state after the change. */
|
|
183941
|
+
200: {
|
|
183942
|
+
headers: {
|
|
183943
|
+
[name: string]: unknown;
|
|
183944
|
+
};
|
|
183945
|
+
content: {
|
|
183946
|
+
"application/json": components["schemas"]["SiteAppAutoUpdate"];
|
|
183947
|
+
};
|
|
183948
|
+
};
|
|
183949
|
+
401: components["responses"]["Unauthorized"];
|
|
183950
|
+
403: components["responses"]["Forbidden"];
|
|
183951
|
+
404: components["responses"]["NotFound"];
|
|
183952
|
+
422: components["responses"]["UnprocessableEntity"];
|
|
183953
|
+
429: components["responses"]["TooManyRequests"];
|
|
183954
|
+
};
|
|
183955
|
+
};
|
|
183774
183956
|
deleteSiteAppPreview: {
|
|
183775
183957
|
parameters: {
|
|
183776
183958
|
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.1366",
|
|
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>",
|