@kanorio/sdk 1.0.0 → 1.2.0
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/README.md +41 -2
- package/dist/customer-oauth.d.ts +21 -21
- package/dist/customer-oauth.js +12 -12
- package/dist/customer.d.ts +22 -22
- package/dist/customer.js +20 -11
- package/dist/delivery.d.ts +9 -9
- package/dist/delivery.js +6 -6
- package/dist/edge.d.ts +25 -21
- package/dist/edge.js +36 -20
- package/dist/forms.d.ts +33 -14
- package/dist/forms.js +20 -14
- package/dist/generated/delivery.d.ts +564 -13
- package/dist/generated/management.d.ts +790 -81
- package/dist/http.d.ts +13 -13
- package/dist/http.js +8 -8
- package/dist/image.d.ts +77 -0
- package/dist/image.js +78 -0
- package/dist/index.d.ts +2 -1
- package/dist/index.js +4 -3
- package/dist/locales.d.ts +22 -22
- package/dist/locales.js +12 -12
- package/dist/management.d.ts +5 -5
- package/dist/management.js +3 -3
- package/dist/next.d.ts +66 -0
- package/dist/next.js +58 -0
- package/dist/paginate.d.ts +3 -3
- package/dist/paginate.js +3 -3
- package/dist/preview.d.ts +13 -13
- package/dist/preview.js +11 -11
- package/dist/protection.d.ts +18 -18
- package/dist/protection.js +11 -11
- package/dist/revalidate.d.ts +22 -22
- package/dist/revalidate.js +14 -14
- package/dist/seo.d.ts +137 -21
- package/dist/seo.js +113 -21
- package/dist/server-key.d.ts +2 -2
- package/dist/server-key.js +2 -2
- package/dist/shared/api/delivery/cache-tags.d.ts +41 -39
- package/dist/shared/api/delivery/cache-tags.js +36 -34
- package/dist/shared/api/server-key.d.ts +32 -28
- package/dist/shared/api/server-key.js +41 -33
- package/dist/shared/business-registry/attribution.d.ts +5 -5
- package/dist/shared/business-registry/attribution.js +4 -4
- package/dist/shared/business-registry/define.d.ts +1 -1
- package/dist/shared/business-registry/define.js +1 -1
- package/dist/shared/business-registry/formats/eu-vat.js +4 -4
- package/dist/shared/business-registry/formats/hk-br.d.ts +2 -2
- package/dist/shared/business-registry/formats/hk-br.js +4 -4
- package/dist/shared/business-registry/formats/jp-trn.d.ts +3 -3
- package/dist/shared/business-registry/formats/jp-trn.js +4 -4
- package/dist/shared/business-registry/formats/kr-brn.d.ts +2 -2
- package/dist/shared/business-registry/formats/kr-brn.js +3 -3
- package/dist/shared/business-registry/formats/my.d.ts +3 -3
- package/dist/shared/business-registry/formats/my.js +4 -4
- package/dist/shared/business-registry/formats/sg-uen.js +4 -4
- package/dist/shared/business-registry/formats/tw-vat.d.ts +5 -5
- package/dist/shared/business-registry/formats/tw-vat.js +6 -6
- package/dist/shared/business-registry/index.js +1 -1
- package/dist/shared/business-registry/lookup-wire.d.ts +9 -9
- package/dist/shared/business-registry/lookup-wire.js +4 -4
- package/dist/shared/business-registry/normalize.d.ts +3 -3
- package/dist/shared/business-registry/normalize.js +4 -4
- package/dist/shared/business-registry/registry.d.ts +9 -9
- package/dist/shared/business-registry/registry.js +13 -13
- package/dist/shared/business-registry/types.d.ts +20 -20
- package/dist/shared/business-registry/types.js +6 -6
- package/dist/shared/localization/locale-path.d.ts +18 -18
- package/dist/shared/localization/locale-path.js +18 -18
- package/dist/shared/localization/request-locale.d.ts +16 -16
- package/dist/shared/localization/request-locale.js +13 -13
- package/dist/shared/seo/alternates.d.ts +26 -26
- package/dist/shared/seo/alternates.js +18 -18
- package/dist/shared/types/forms-logic.d.ts +28 -28
- package/dist/shared/types/forms-logic.js +27 -27
- package/dist/shared/types/number-input.d.ts +2 -2
- package/dist/shared/types/number-input.js +3 -3
- package/dist/shared/utils/redirect-matching.d.ts +33 -24
- package/dist/shared/utils/redirect-matching.js +73 -40
- package/dist/typed.d.ts +5 -5
- package/dist/typed.js +3 -3
- package/package.json +15 -10
|
@@ -39,7 +39,7 @@ export interface paths {
|
|
|
39
39
|
put?: never;
|
|
40
40
|
/**
|
|
41
41
|
* sites.create
|
|
42
|
-
* @description Create a new website owned by the token owner. Requires a token granted for all websites (not restricted to specific websiteIds). mode=blank: creates the skeleton immediately (empty home page, hidden legal pages, a default header and footer in globalSections, owner membership) and returns websiteId. Then follow sections.describe -> conventions.brandFirst: set the theme (site.update_settings), define buttons (globals.update_site_settings), create pages, fill them with pages.replace_sections, rebuild the header navigation (globals.replace_header) and publish. mode=brief: queues the AI site builder with a brand brief and returns operationId; poll operations.get every 5-10 seconds until status is SUCCEEDED (result.websiteId is set) or FAILED. This
|
|
42
|
+
* @description Create a new website owned by the token owner. Requires a token granted for all websites (not restricted to specific websiteIds). mode=blank: creates the skeleton immediately (empty home page, hidden legal pages, a default header and footer in globalSections, owner membership) and returns websiteId. Then follow sections.describe -> conventions.brandFirst: set the theme (site.update_settings), define buttons (globals.update_site_settings), create pages, fill them with pages.replace_sections, rebuild the header navigation (globals.replace_header) and publish. mode=brief: queues the AI site builder with a brand brief and returns operationId; poll operations.get every 5-10 seconds until status is SUCCEEDED (result.websiteId is set) or FAILED. This counts toward the owner's daily site-creation limit and does not use AI credits. mode=blank with frontendMode=HEADLESS creates a custom-frontend site (returns systemHost; call sites.context next). While the headless beta is by invitation the account must be invited first: call account.context, and never create a hosted site as a substitute without asking the user. Errors: TOKEN_WEBSITE_SCOPED, VALIDATION, DAILY_LIMIT_REACHED (brief), HEADLESS_BETA_INVITE_REQUIRED (details.status, details.resolution: apply | wait | contact_support).
|
|
43
43
|
*/
|
|
44
44
|
post: operations["sites_create"];
|
|
45
45
|
delete?: never;
|
|
@@ -463,7 +463,7 @@ export interface paths {
|
|
|
463
463
|
get: operations["domains_list"];
|
|
464
464
|
/**
|
|
465
465
|
* domains.bind
|
|
466
|
-
* @description Set the complete list of custom domains for a website: the first hostname becomes the primary (canonical) domain, the rest become aliases that 301-redirect to it. Hostnames missing from the list are unbound; pass an empty list to remove all custom domains. After binding, the owner must point DNS (CNAME) at Kanorio; call domains.status to see the exact record and verification progress. Requires a paid plan. Errors: FORBIDDEN, PRO_REQUIRED, INVALID_FORMAT, BLOCKED, HIGH_RISK_TLD, LIMIT_REACHED (details.max), TAKEN (used by another site), READD_COOLDOWN (details.retryAfterSeconds).
|
|
466
|
+
* @description Set the complete list of custom domains for a website: the first hostname becomes the primary (canonical) domain, the rest become aliases that 301-redirect to it. Hostnames missing from the list are unbound; pass an empty list to remove all custom domains. After binding, the owner must point DNS (CNAME) at Kanorio; call domains.status to see the exact record and verification progress. Requires a paid plan. On a headless site the list holds the service domain that serves checkout, sign-in, the customer account and the API: exactly one hostname, it must be a subdomain (not the root domain), and it must not be the external frontend's host. Errors: FORBIDDEN, PRO_REQUIRED, INVALID_FORMAT, BLOCKED, HIGH_RISK_TLD, LIMIT_REACHED (details.max), TAKEN (used by another site), READD_COOLDOWN (details.retryAfterSeconds), SERVICE_DOMAIN_SINGLE, SERVICE_DOMAIN_NOT_SUBDOMAIN (details.suggestion), SERVICE_DOMAIN_IS_FRONTEND.
|
|
467
467
|
*/
|
|
468
468
|
put: operations["domains_bind"];
|
|
469
469
|
post?: never;
|
|
@@ -508,7 +508,7 @@ export interface paths {
|
|
|
508
508
|
put?: never;
|
|
509
509
|
/**
|
|
510
510
|
* posts.create
|
|
511
|
-
* @description Create a blog post as a DRAFT. Drafts are not visible on the public site until posts.publish. Taxonomy ids (categoryIds, tagIds, authorIds) must belong to this website; use blog_categories.list / blog_tags.list first. Errors: FORBIDDEN, VALIDATION, SLUG_TAKEN, ASSET_NOT_FOUND (details.assetIds: not in this site's media library; the share image also must not be in the trash), ASSET_NOT_ALLOWED (product files, or a non-image as the share image).
|
|
511
|
+
* @description Create a blog post as a DRAFT. Drafts are not visible on the public site until posts.publish. Taxonomy ids (categoryIds, tagIds, authorIds) must belong to this website; use blog_categories.list / blog_tags.list first. Errors: FORBIDDEN, VALIDATION, SLUG_TAKEN, ASSET_NOT_FOUND (details.assetIds: not in this site's media library; the cover and the share image also must not be in the trash), ASSET_NOT_ALLOWED (product files, or a non-image as the cover or the share image).
|
|
512
512
|
*/
|
|
513
513
|
post: operations["posts_create"];
|
|
514
514
|
delete?: never;
|
|
@@ -660,7 +660,7 @@ export interface paths {
|
|
|
660
660
|
head?: never;
|
|
661
661
|
/**
|
|
662
662
|
* posts.update
|
|
663
|
-
* @description Partially update a blog post's working copy (only provided fields change; categoryIds/tagIds/authorIds replace the whole list when provided). Editing a PUBLISHED post does not change the public copy until posts.publish is called again (hasDraftChanges becomes true). Pass ifUnmodifiedSince (the updatedAt from posts.get/posts.list) to avoid silently overwriting a change made by someone else (or another agent run) since you last read it. Errors: FORBIDDEN, POST_NOT_FOUND, CONFLICT (re-read with posts.get and retry), VALIDATION, SLUG_TAKEN, ASSET_NOT_FOUND (details.assetIds: not in this site's media library; the share image also must not be in the trash), ASSET_NOT_ALLOWED (product files, or a non-image as the share image).
|
|
663
|
+
* @description Partially update a blog post's working copy (only provided fields change; categoryIds/tagIds/authorIds replace the whole list when provided). Editing a PUBLISHED post does not change the public copy until posts.publish is called again (hasDraftChanges becomes true). Pass ifUnmodifiedSince (the updatedAt from posts.get/posts.list) to avoid silently overwriting a change made by someone else (or another agent run) since you last read it. Errors: FORBIDDEN, POST_NOT_FOUND, CONFLICT (re-read with posts.get and retry), VALIDATION, SLUG_TAKEN, ASSET_NOT_FOUND (details.assetIds: not in this site's media library; the cover and the share image also must not be in the trash), ASSET_NOT_ALLOWED (product files, or a non-image as the cover or the share image).
|
|
664
664
|
*/
|
|
665
665
|
patch: operations["posts_update"];
|
|
666
666
|
trace?: never;
|
|
@@ -1139,7 +1139,7 @@ export interface paths {
|
|
|
1139
1139
|
get: operations["site_get_allowed_origins"];
|
|
1140
1140
|
/**
|
|
1141
1141
|
* site.update_allowed_origins
|
|
1142
|
-
* @description Replace the CORS allowlist for the Content Delivery API (up to 20 https origins such as https://app.example.com; no paths or wildcards). Errors: FORBIDDEN, VALIDATION (details.issues).
|
|
1142
|
+
* @description Replace the CORS allowlist for the Content Delivery API (up to 20 https origins such as https://app.example.com; no paths or wildcards). An origin on this list is treated as one of the site's own front ends: customer sign-in links and the hosted sign-in page may send customers back to it, so list only origins the site owner controls, never a third-party domain. A form's redirect after submit does not use this list. Errors: FORBIDDEN, VALIDATION (details.issues).
|
|
1143
1143
|
*/
|
|
1144
1144
|
put: operations["site_update_allowed_origins"];
|
|
1145
1145
|
post?: never;
|
|
@@ -1241,7 +1241,7 @@ export interface paths {
|
|
|
1241
1241
|
put?: never;
|
|
1242
1242
|
/**
|
|
1243
1243
|
* site.create_server_key
|
|
1244
|
-
* @description Issue a server key (
|
|
1244
|
+
* @description Issue a server key (knr_sk_…) for the site's own frontend server: the key that lets server-side code submit forms, exchange customer sign-in codes and report crawler hits on behalf of visitors (send it as X-Kanorio-Server-Key to the site's /api/v1 endpoints). The key cannot call this Management API and can only do what a visitor could already do. It is returned once; store it on the frontend host as an environment variable and never in source code. If a server-key service account with the same name already exists, a new key is added to it (create the new key, switch the host over, then revoke the old one). REST only: not available over MCP, so the key never appears in an AI conversation. Errors: FORBIDDEN, LIMIT_REACHED, VALIDATION.
|
|
1245
1245
|
*/
|
|
1246
1246
|
post: operations["site_create_server_key"];
|
|
1247
1247
|
delete?: never;
|
|
@@ -1618,6 +1618,26 @@ export interface paths {
|
|
|
1618
1618
|
patch?: never;
|
|
1619
1619
|
trace?: never;
|
|
1620
1620
|
};
|
|
1621
|
+
"/sites/{id}/forms/trash": {
|
|
1622
|
+
parameters: {
|
|
1623
|
+
query?: never;
|
|
1624
|
+
header?: never;
|
|
1625
|
+
path?: never;
|
|
1626
|
+
cookie?: never;
|
|
1627
|
+
};
|
|
1628
|
+
/**
|
|
1629
|
+
* forms.list_trashed
|
|
1630
|
+
* @description List the forms in the trash (moved there by forms.delete or from the dashboard), most recently trashed first, each with the time it will be permanently deleted (30 days after it was trashed). Bring one back with forms.restore. Errors: FORBIDDEN, INVALID_CURSOR.
|
|
1631
|
+
*/
|
|
1632
|
+
get: operations["forms_list_trashed"];
|
|
1633
|
+
put?: never;
|
|
1634
|
+
post?: never;
|
|
1635
|
+
delete?: never;
|
|
1636
|
+
options?: never;
|
|
1637
|
+
head?: never;
|
|
1638
|
+
patch?: never;
|
|
1639
|
+
trace?: never;
|
|
1640
|
+
};
|
|
1621
1641
|
"/sites/{id}/forms/{formId}": {
|
|
1622
1642
|
parameters: {
|
|
1623
1643
|
query?: never;
|
|
@@ -1632,16 +1652,80 @@ export interface paths {
|
|
|
1632
1652
|
get: operations["forms_get"];
|
|
1633
1653
|
put?: never;
|
|
1634
1654
|
post?: never;
|
|
1635
|
-
|
|
1655
|
+
/**
|
|
1656
|
+
* forms.delete
|
|
1657
|
+
* @description Move a form to the trash. It stops accepting submissions at once, the Content Delivery API stops returning it (404), and it no longer appears in forms.list. Its submissions are kept and come back with it on forms.restore. After 30 days in the trash the form and its submissions are permanently deleted (deleteAfter); deleting it permanently before that is done by a person in the dashboard and is not available through the API. Refused with FORM_IN_USE while the form is placed on a page or in a popup (details.placements lists the pages, details.popups counts the popups; a person removes those in the dashboard), and with FORM_NOT_PAUSED while it has submissions and is still accepting them (call forms.pause first). Errors: FORBIDDEN, FORM_NOT_FOUND, FORM_IN_USE, FORM_NOT_PAUSED.
|
|
1658
|
+
*/
|
|
1659
|
+
delete: operations["forms_delete"];
|
|
1636
1660
|
options?: never;
|
|
1637
1661
|
head?: never;
|
|
1638
1662
|
/**
|
|
1639
1663
|
* forms.update
|
|
1640
|
-
* @description Update a form (PATCH). name and description: left out means unchanged. fields: replaces the whole list, so send every question you want to keep. settings: merged key by key into the current settings. On a form that already has submissions, an existing question's type cannot change (add a new question instead). Changes go live immediately on pages and popups that show the form. Errors: FORBIDDEN, VALIDATION (details.code: INVALID_NAME, INVALID_DEFINITION with details.issues[{ path, message }], INVALID_REDIRECT, RESTRICTED_SETTING with details.path, FIELD_TYPE_LOCKED with details.fieldIds), SITE_SUSPENDED, FORM_NOT_FOUND.
|
|
1664
|
+
* @description Update a form (PATCH). name and description: left out means unchanged. fields: replaces the whole list, so send every question you want to keep. settings: merged key by key into the current settings. On a form that already has submissions, an existing question's type cannot change (add a new question instead). Changes go live immediately on pages and popups that show the form; the Delivery API (GET /forms/{id}) returns the new definition within about 7 seconds, so wait that long before reading it back to verify. Errors: FORBIDDEN, VALIDATION (details.code: INVALID_NAME, INVALID_DEFINITION with details.issues[{ path, message }], INVALID_REDIRECT, RESTRICTED_SETTING with details.path, FIELD_TYPE_LOCKED with details.fieldIds), SITE_SUSPENDED, FORM_NOT_FOUND.
|
|
1641
1665
|
*/
|
|
1642
1666
|
patch: operations["forms_update"];
|
|
1643
1667
|
trace?: never;
|
|
1644
1668
|
};
|
|
1669
|
+
"/sites/{id}/forms/{formId}/pause": {
|
|
1670
|
+
parameters: {
|
|
1671
|
+
query?: never;
|
|
1672
|
+
header?: never;
|
|
1673
|
+
path?: never;
|
|
1674
|
+
cookie?: never;
|
|
1675
|
+
};
|
|
1676
|
+
get?: never;
|
|
1677
|
+
put?: never;
|
|
1678
|
+
/**
|
|
1679
|
+
* forms.pause
|
|
1680
|
+
* @description Stop a form from accepting submissions. It takes effect at once: the form stays where it is placed and shows visitors that it is closed, submit requests are refused, and submissions already received are kept. The returned form has status ARCHIVED and availability closed. Calling it on a form that is already paused changes nothing and succeeds. Undo with forms.resume. To close a form at a set time instead, set settings.closeAt with forms.update. Errors: FORBIDDEN, FORM_NOT_FOUND.
|
|
1681
|
+
*/
|
|
1682
|
+
post: operations["forms_pause"];
|
|
1683
|
+
delete?: never;
|
|
1684
|
+
options?: never;
|
|
1685
|
+
head?: never;
|
|
1686
|
+
patch?: never;
|
|
1687
|
+
trace?: never;
|
|
1688
|
+
};
|
|
1689
|
+
"/sites/{id}/forms/{formId}/resume": {
|
|
1690
|
+
parameters: {
|
|
1691
|
+
query?: never;
|
|
1692
|
+
header?: never;
|
|
1693
|
+
path?: never;
|
|
1694
|
+
cookie?: never;
|
|
1695
|
+
};
|
|
1696
|
+
get?: never;
|
|
1697
|
+
put?: never;
|
|
1698
|
+
/**
|
|
1699
|
+
* forms.resume
|
|
1700
|
+
* @description Let a paused form accept submissions again. It takes effect at once and the returned form has status ACTIVE. availability can still be not_open, closed or full when the form's own opening time, closing time or submission cap says so; change those with forms.update. Calling it on a form that is not paused changes nothing and succeeds. Errors: FORBIDDEN, FORM_NOT_FOUND.
|
|
1701
|
+
*/
|
|
1702
|
+
post: operations["forms_resume"];
|
|
1703
|
+
delete?: never;
|
|
1704
|
+
options?: never;
|
|
1705
|
+
head?: never;
|
|
1706
|
+
patch?: never;
|
|
1707
|
+
trace?: never;
|
|
1708
|
+
};
|
|
1709
|
+
"/sites/{id}/forms/{formId}/restore": {
|
|
1710
|
+
parameters: {
|
|
1711
|
+
query?: never;
|
|
1712
|
+
header?: never;
|
|
1713
|
+
path?: never;
|
|
1714
|
+
cookie?: never;
|
|
1715
|
+
};
|
|
1716
|
+
get?: never;
|
|
1717
|
+
put?: never;
|
|
1718
|
+
/**
|
|
1719
|
+
* forms.restore
|
|
1720
|
+
* @description Restore a form from the trash. It returns to forms.list with the status it had (ACTIVE accepts submissions again at once, ARCHIVED stays paused until forms.resume), the Content Delivery API returns it again, and its submissions are readable again. It is not placed back on any page. Calling it on a form that is not in the trash changes nothing and succeeds. Errors: FORBIDDEN, FORM_NOT_FOUND.
|
|
1721
|
+
*/
|
|
1722
|
+
post: operations["forms_restore"];
|
|
1723
|
+
delete?: never;
|
|
1724
|
+
options?: never;
|
|
1725
|
+
head?: never;
|
|
1726
|
+
patch?: never;
|
|
1727
|
+
trace?: never;
|
|
1728
|
+
};
|
|
1645
1729
|
"/sites/{id}/forms/{formId}/submissions": {
|
|
1646
1730
|
parameters: {
|
|
1647
1731
|
query?: never;
|
|
@@ -3132,7 +3216,7 @@ export interface paths {
|
|
|
3132
3216
|
};
|
|
3133
3217
|
/**
|
|
3134
3218
|
* media.get
|
|
3135
|
-
* @description Get one file from the media library or the trash, with every place the site uses it (page sections, share images, brand, posts, products, emails). Errors: FORBIDDEN, ASSET_NOT_FOUND.
|
|
3219
|
+
* @description Get one file from the media library or the trash, with every place the site uses it (page sections, share images, brand, posts, products, collection items, deliverables, emails). Errors: FORBIDDEN, ASSET_NOT_FOUND.
|
|
3136
3220
|
*/
|
|
3137
3221
|
get: operations["media_get"];
|
|
3138
3222
|
put?: never;
|
|
@@ -3332,7 +3416,7 @@ export interface paths {
|
|
|
3332
3416
|
};
|
|
3333
3417
|
/**
|
|
3334
3418
|
* seo.search_console.status
|
|
3335
|
-
* @description Report the Google Search Console connection
|
|
3419
|
+
* @description Report whether a website is registered with Google and the Google Search Console connection behind it. registration.state is the single answer to whether Google knows the site's current address; when it is registered there is nothing to do, including when registration.via is self: do not ask the owner to connect or submit again, connecting a Google account then only adds search data to the dashboard. The remaining fields describe the connection: whether a Google account is connected, which property and sitemap Kanorio uses, whether ownership is verified and how, and when the sitemap was last submitted. Marking a site as registered by the owner is something the owner does under SEO › Settings; no capability does it. Connecting a Google account is a browser OAuth step the owner must do under SEO › Settings; this capability cannot connect. Use it before seo.search_console.verify_and_submit, and to explain the next step to the owner when lastFailureCode is OWNERSHIP_REQUIRED (verify the domain in Search Console), SITEMAP_NOT_REACHABLE (fix the external frontend's /sitemap.xml) or DNS_NOT_PROPAGATED (just wait). Errors: FORBIDDEN (also when the website does not exist).
|
|
3336
3420
|
*/
|
|
3337
3421
|
get: operations["seo_search_console_status"];
|
|
3338
3422
|
put?: never;
|
|
@@ -3354,7 +3438,7 @@ export interface paths {
|
|
|
3354
3438
|
put?: never;
|
|
3355
3439
|
/**
|
|
3356
3440
|
* seo.search_console.verify_and_submit
|
|
3357
|
-
* @description Verify ownership of the website's current property in Google Search Console, add the property, and submit the sitemap. Same flow as the dashboard's Check again button. HOSTED sites verify with a meta tag Kanorio renders. HEADLESS sites with externalStorefrontUrl first check whether the connected Google account already owns a covering property; if not and the domain's DNS is managed by Kanorio, Kanorio writes a TXT record and verifies via DNS; otherwise the owner must verify the domain in Search Console themselves. Requires a connected Google account (owner does this in the dashboard) and a public URL. On failure the site is marked needsReverify and a background job keeps retrying transient causes (META_NOT_LIVE, DNS_NOT_PROPAGATED), but not OWNERSHIP_REQUIRED or SITEMAP_NOT_REACHABLE, which need the owner. Errors: FORBIDDEN, NO_PUBLIC_URL, SEARCH_CONSOLE_NOT_CONNECTED, META_NOT_LIVE (retry in 20-30 s), OWNERSHIP_REQUIRED, SITEMAP_NOT_REACHABLE, DNS_NOT_PROPAGATED (retry later), SEARCH_CONSOLE_AUTH_EXPIRED, SEARCH_CONSOLE_PERMISSION_DENIED, SEARCH_CONSOLE_QUOTA_EXCEEDED, SEARCH_CONSOLE_PROPERTY_NOT_FOUND, SEARCH_CONSOLE_UNAVAILABLE, SEARCH_CONSOLE_ERROR.
|
|
3441
|
+
* @description Verify ownership of the website's current property in Google Search Console, add the property, and submit the sitemap. Same flow as the dashboard's Check again button. Call it only when a Google account is connected and seo.search_console.status reports registration.state in_progress; when the state is registered it is not needed. HOSTED sites verify with a meta tag Kanorio renders. HEADLESS sites with externalStorefrontUrl first check whether the connected Google account already owns a covering property; if not and the domain's DNS is managed by Kanorio, Kanorio writes a TXT record and verifies via DNS; otherwise the owner must verify the domain in Search Console themselves. Requires a connected Google account (owner does this in the dashboard) and a public URL. On failure the site is marked needsReverify and a background job keeps retrying transient causes (META_NOT_LIVE, DNS_NOT_PROPAGATED), but not OWNERSHIP_REQUIRED or SITEMAP_NOT_REACHABLE, which need the owner. Errors: FORBIDDEN, NO_PUBLIC_URL, SEARCH_CONSOLE_NOT_CONNECTED, META_NOT_LIVE (retry in 20-30 s), OWNERSHIP_REQUIRED, SITEMAP_NOT_REACHABLE, DNS_NOT_PROPAGATED (retry later), SEARCH_CONSOLE_AUTH_EXPIRED, SEARCH_CONSOLE_PERMISSION_DENIED, SEARCH_CONSOLE_QUOTA_EXCEEDED, SEARCH_CONSOLE_PROPERTY_NOT_FOUND, SEARCH_CONSOLE_UNAVAILABLE, SEARCH_CONSOLE_ERROR.
|
|
3358
3442
|
*/
|
|
3359
3443
|
post: operations["seo_search_console_verify_and_submit"];
|
|
3360
3444
|
delete?: never;
|
|
@@ -3396,11 +3480,15 @@ export interface paths {
|
|
|
3396
3480
|
};
|
|
3397
3481
|
/**
|
|
3398
3482
|
* revisions.list
|
|
3399
|
-
* @description List content revisions for a website draft (subject: WEBSITE, subjectId omitted or equal to websiteId), a blog post (subject: BLOG_POST, subjectId: postId), or a custom collection item (subject: CONTENT_ITEM, subjectId: itemId).
|
|
3483
|
+
* @description List content revisions for a website draft (subject: WEBSITE, subjectId omitted or equal to websiteId), a blog post (subject: BLOG_POST, subjectId: postId), or a custom collection item (subject: CONTENT_ITEM, subjectId: itemId). Each subject keeps its most recent 50 revisions, for up to 7 days on the Free plan, 30 on Pro and 90 on Business. Autosaves by the same author within a 10-minute window are merged into one revision; every publish keeps its own revision (publishing again without a change adds none). When a subject goes over 50, older revisions are thinned before any are dropped (one per day once they are over 24 hours old, then one per week once over 7 days), so a frequently edited subject still reaches back the full retention period. The latest published revision of a subject is always kept, and so are named revisions (kind MANUAL with a label, created with revisions.create): they do not expire and do not count toward the 50. There is no separate export: page through this list and read each revision with revisions.get. Optionally pass pageId when listing WEBSITE revisions to filter to edits that touched that page. Newest first. Errors: FORBIDDEN, INVALID_CURSOR.
|
|
3400
3484
|
*/
|
|
3401
3485
|
get: operations["revisions_list"];
|
|
3402
3486
|
put?: never;
|
|
3403
|
-
|
|
3487
|
+
/**
|
|
3488
|
+
* revisions.create
|
|
3489
|
+
* @description Save the current draft of a website, blog post or collection item as a named revision (subject and subjectId work as in revisions.list). A named revision is kept until someone deletes it in the dashboard: it does not expire with the plan's retention period and does not count toward the 50 revisions kept per subject. Use it for a state worth returning to much later, for example the version that went live for a season. Each subject can have up to 20 named revisions; beyond that the call fails with NAMED_REVISION_LIMIT and nothing is removed automatically. Deleting a named revision is not available through the API: ask a person to delete one they no longer need from the version history in the dashboard. It records the draft as it is now and changes nothing else. In revisions.list it appears with kind MANUAL and the label. Errors: FORBIDDEN, VALIDATION_FAILED, SUBJECT_NOT_FOUND, NAMED_REVISION_LIMIT.
|
|
3490
|
+
*/
|
|
3491
|
+
post: operations["revisions_create"];
|
|
3404
3492
|
delete?: never;
|
|
3405
3493
|
options?: never;
|
|
3406
3494
|
head?: never;
|
|
@@ -3668,7 +3756,7 @@ export interface paths {
|
|
|
3668
3756
|
};
|
|
3669
3757
|
/**
|
|
3670
3758
|
* auth.whoami
|
|
3671
|
-
* @description Inspect the current
|
|
3759
|
+
* @description Inspect the current credential: who it acts as (principal: a user, or a service account that belongs to one website), its granted scopes, website restrictions, and any capabilities it cannot call (hiddenCapabilities, with the exact reason: missing_scope, feature_disabled, or principal_not_allowed for operations that need a person's token). Call this before telling the user a feature is unsupported. Pass websiteId to also get the role on that website and the effective permissions there (token scopes intersected with the role's or the service account's permissions), plus capabilities the token has the scope for but the role does not allow on that website. A server key (knr_sk_) is not a Management API credential and gets UNAUTHORIZED. With websiteId, the credential only has to cover that website: no particular permission is needed, so a narrowly scoped service account can check itself. Errors: UNAUTHORIZED, FORBIDDEN (websiteId given but the credential has no access to that website).
|
|
3672
3760
|
*/
|
|
3673
3761
|
get: operations["auth_whoami"];
|
|
3674
3762
|
put?: never;
|
|
@@ -3736,7 +3824,7 @@ export interface components {
|
|
|
3736
3824
|
* @description Stable error code. Codes not listed here follow the suffix rules: *_NOT_FOUND → 404, *_REQUIRED / *_FORBIDDEN / *_PLAN_REQUIRED / *_LIMIT → 403, otherwise 422.
|
|
3737
3825
|
* @enum {string}
|
|
3738
3826
|
*/
|
|
3739
|
-
ErrorCode: "EMPTY_SLUG" | "INVALID_BODY" | "INVALID_CURSOR" | "INVALID_EDITED_PATH" | "INVALID_FORMAT" | "INVALID_ORDER" | "INVALID_SUBDOMAIN" | "UNSUPPORTED_EDITED_PATH" | "VALIDATION" | "UNAUTHENTICATED" | "UNAUTHORIZED" | "CUSTOM_DOMAIN_CHANGE_FORBIDDEN" | "CUSTOM_DOMAIN_LIMIT_REACHED" | "CUSTOM_DOMAIN_OWNER_REQUIRED" | "FORBIDDEN" | "LIMIT_REACHED" | "MODERATION_LOCKED" | "OWNER_REQUIRED" | "PLAN_CANNOT_PUBLISH" | "PLATFORM_DOMAIN_OWNER_REQUIRED" | "PRO_REQUIRED" | "REDIRECT_LIMIT" | "SUBDOMAIN_CHANGE_FORBIDDEN" | "TOKEN_WEBSITE_SCOPED" | "HEADER_NOT_FOUND" | "HOME_PAGE_NOT_FOUND" | "NOT_FOUND" | "OWNER_NOT_FOUND" | "PAGE_NOT_FOUND" | "PARENT_NOT_FOUND" | "PRODUCT_NOT_FOUND" | "WEBSITE_NOT_FOUND" | "METHOD_NOT_ALLOWED" | "CONFLICT" | "CUSTOM_DOMAIN_FORWARDING" | "CUSTOM_DOMAIN_TAKEN" | "DOMAIN_FORWARDING" | "HAS_CHILDREN" | "HOSTED_ONLY" | "HOSTNAME_CONFLICT" | "IDEMPOTENCY_CONFLICT" | "IDEMPOTENCY_IN_PROGRESS" | "KEY_TAKEN" | "PRIMARY_HEADER_PROTECTED" | "READD_COOLDOWN" | "REDIRECT_CONFLICT" | "SLUG_TAKEN" | "SUBDOMAIN_TAKEN" | "TAKEN" | "BLOCKED" | "BREADCRUMB_PARENT_INVALID" | "CONTENT_VALIDATION_FAILED" | "CORE_SECTION_VIOLATION" | "CUSTOM_DOMAIN_BLOCKED" | "CUSTOM_DOMAIN_HIGH_RISK_TLD" | "CUSTOM_DOMAIN_NOT_ACTIVE" | "CUSTOM_DOMAIN_TOO_LONG" | "CUSTOM_DOMAIN_WWW_REDUNDANT" | "DEPTH_EXCEEDED" | "DNS_NOT_PROPAGATED" | "DOMAIN_CHANGE_NOT_ALLOWED" | "EMPTY_CONTENT" | "FOREIGN_PAGE" | "HIGH_RISK_TLD" | "HOME_HAS_HIERARCHY" | "HOME_NOT_CREATABLE" | "HOME_NOT_DELETABLE" | "HOME_NOT_SORTABLE" | "HOME_SLUG_IMMUTABLE" | "LINK_IN_BIO_DEDICATED_ENTRY" | "LINK_IN_BIO_NOT_DUPLICABLE" | "META_NOT_LIVE" | "NO_PUBLIC_URL" | "OWNERSHIP_REQUIRED" | "PAGE_LIMIT_REACHED" | "PARENT_NOT_ALLOWED" | "PLATFORM_DOMAIN_NOT_ACTIVE" | "PLATFORM_DOMAIN_WWW_REDUNDANT" | "RESERVED_SEGMENT" | "RESERVED_SLUG" | "RESERVED_SUBDOMAIN" | "SANITIZE_FAILED" | "SEARCH_CONSOLE_AUTH_EXPIRED" | "SEARCH_CONSOLE_NOT_CONNECTED" | "SEARCH_CONSOLE_PERMISSION_DENIED" | "SEARCH_CONSOLE_PROPERTY_NOT_FOUND" | "SEGMENT_TOO_LONG" | "SITEMAP_NOT_REACHABLE" | "SUBDOMAIN_MISSING" | "SYSTEM_PAGE_LOCKED" | "TEMPLATE_PRODUCT_LOCKED" | "ANALYTICS_BUSY" | "DAILY_LIMIT_REACHED" | "RATE_LIMITED" | "SEARCH_BUSY" | "SEARCH_CONSOLE_QUOTA_EXCEEDED" | "STOCK_BUSY" | "INTERNAL" | "SEARCH_CONSOLE_ERROR" | "BUSY" | "SEARCH_CONSOLE_UNAVAILABLE" | "SERVICE_UNAVAILABLE" | "WRITE_FROZEN";
|
|
3827
|
+
ErrorCode: "EMPTY_SLUG" | "INVALID_BODY" | "INVALID_CURSOR" | "INVALID_EDITED_PATH" | "INVALID_FORMAT" | "INVALID_ORDER" | "INVALID_SUBDOMAIN" | "UNSUPPORTED_EDITED_PATH" | "VALIDATION" | "UNAUTHENTICATED" | "UNAUTHORIZED" | "CUSTOM_DOMAIN_CHANGE_FORBIDDEN" | "CUSTOM_DOMAIN_LIMIT_REACHED" | "CUSTOM_DOMAIN_OWNER_REQUIRED" | "FORBIDDEN" | "LIMIT_REACHED" | "MODERATION_LOCKED" | "OWNER_REQUIRED" | "PLAN_CANNOT_PUBLISH" | "PLATFORM_DOMAIN_OWNER_REQUIRED" | "PRO_REQUIRED" | "REDIRECT_LIMIT" | "SUBDOMAIN_CHANGE_FORBIDDEN" | "TOKEN_WEBSITE_SCOPED" | "HEADER_NOT_FOUND" | "HOME_PAGE_NOT_FOUND" | "NOT_FOUND" | "OWNER_NOT_FOUND" | "PAGE_NOT_FOUND" | "PARENT_NOT_FOUND" | "PRODUCT_NOT_FOUND" | "WEBSITE_NOT_FOUND" | "METHOD_NOT_ALLOWED" | "CONFLICT" | "CUSTOM_DOMAIN_FORWARDING" | "CUSTOM_DOMAIN_TAKEN" | "DOMAIN_FORWARDING" | "HAS_CHILDREN" | "HOSTED_ONLY" | "HOSTNAME_CONFLICT" | "IDEMPOTENCY_CONFLICT" | "IDEMPOTENCY_IN_PROGRESS" | "KEY_TAKEN" | "PRIMARY_HEADER_PROTECTED" | "READD_COOLDOWN" | "REDIRECT_CONFLICT" | "SLUG_TAKEN" | "SUBDOMAIN_TAKEN" | "TAKEN" | "BLOCKED" | "BREADCRUMB_PARENT_INVALID" | "CONTENT_VALIDATION_FAILED" | "CORE_SECTION_VIOLATION" | "CUSTOM_DOMAIN_BLOCKED" | "CUSTOM_DOMAIN_HIGH_RISK_TLD" | "CUSTOM_DOMAIN_NOT_ACTIVE" | "CUSTOM_DOMAIN_TOO_LONG" | "CUSTOM_DOMAIN_WWW_REDUNDANT" | "DEPTH_EXCEEDED" | "DNS_NOT_PROPAGATED" | "DOMAIN_CHANGE_NOT_ALLOWED" | "EMPTY_CONTENT" | "FOREIGN_PAGE" | "HIGH_RISK_TLD" | "HOME_HAS_HIERARCHY" | "HOME_NOT_CREATABLE" | "HOME_NOT_DELETABLE" | "HOME_NOT_SORTABLE" | "HOME_SLUG_IMMUTABLE" | "LINK_IN_BIO_DEDICATED_ENTRY" | "LINK_IN_BIO_NOT_DUPLICABLE" | "META_NOT_LIVE" | "NO_PUBLIC_URL" | "OWNERSHIP_REQUIRED" | "PAGE_LIMIT_REACHED" | "PARENT_NOT_ALLOWED" | "PLATFORM_DOMAIN_NOT_ACTIVE" | "PLATFORM_DOMAIN_WWW_REDUNDANT" | "RESERVED_SEGMENT" | "RESERVED_SLUG" | "RESERVED_SUBDOMAIN" | "SANITIZE_FAILED" | "SEARCH_CONSOLE_AUTH_EXPIRED" | "SEARCH_CONSOLE_NOT_CONNECTED" | "SEARCH_CONSOLE_PERMISSION_DENIED" | "SEARCH_CONSOLE_PROPERTY_NOT_FOUND" | "SEGMENT_TOO_LONG" | "SERVICE_DOMAIN_IS_FRONTEND" | "SERVICE_DOMAIN_NOT_SUBDOMAIN" | "SERVICE_DOMAIN_SINGLE" | "SITEMAP_NOT_REACHABLE" | "SUBDOMAIN_MISSING" | "SYSTEM_PAGE_LOCKED" | "TEMPLATE_PRODUCT_LOCKED" | "ANALYTICS_BUSY" | "DAILY_LIMIT_REACHED" | "RATE_LIMITED" | "SEARCH_BUSY" | "SEARCH_CONSOLE_QUOTA_EXCEEDED" | "STOCK_BUSY" | "INTERNAL" | "SEARCH_CONSOLE_ERROR" | "BUSY" | "SEARCH_CONSOLE_UNAVAILABLE" | "SERVICE_UNAVAILABLE" | "WRITE_FROZEN";
|
|
3740
3828
|
};
|
|
3741
3829
|
responses: {
|
|
3742
3830
|
/** @description Input failed validation or is malformed. Codes: EMPTY_SLUG, INVALID_BODY, INVALID_CURSOR, INVALID_EDITED_PATH, INVALID_FORMAT, INVALID_ORDER, INVALID_SUBDOMAIN, UNSUPPORTED_EDITED_PATH, VALIDATION. */
|
|
@@ -3792,9 +3880,13 @@ export interface components {
|
|
|
3792
3880
|
* @example {
|
|
3793
3881
|
* "error": {
|
|
3794
3882
|
* "code": "FORBIDDEN",
|
|
3795
|
-
* "message": "This
|
|
3883
|
+
* "message": "This operation needs the \"content:edit\" permission, which this API key does not have. The user can add it to the same key, with no new key to copy: open https://app.kanorio.com/account/api-access?token=tok_123&need=content%3Aedit, tick the permission and save, then retry.",
|
|
3796
3884
|
* "details": {
|
|
3797
|
-
* "requiredScope": "content:edit"
|
|
3885
|
+
* "requiredScope": "content:edit",
|
|
3886
|
+
* "reason": "missing_scope",
|
|
3887
|
+
* "credentialKind": "PAT",
|
|
3888
|
+
* "resolution": "edit_token",
|
|
3889
|
+
* "manageUrl": "https://app.kanorio.com/account/api-access?token=tok_123&need=content%3Aedit"
|
|
3798
3890
|
* }
|
|
3799
3891
|
* }
|
|
3800
3892
|
* }
|
|
@@ -3856,7 +3948,7 @@ export interface components {
|
|
|
3856
3948
|
"application/json": components["schemas"]["ErrorEnvelope"];
|
|
3857
3949
|
};
|
|
3858
3950
|
};
|
|
3859
|
-
/** @description Business rule rejected the request. Codes: BLOCKED, BREADCRUMB_PARENT_INVALID, CONTENT_VALIDATION_FAILED, CORE_SECTION_VIOLATION, CUSTOM_DOMAIN_BLOCKED, CUSTOM_DOMAIN_HIGH_RISK_TLD, CUSTOM_DOMAIN_NOT_ACTIVE, CUSTOM_DOMAIN_TOO_LONG, CUSTOM_DOMAIN_WWW_REDUNDANT, DEPTH_EXCEEDED, DNS_NOT_PROPAGATED, DOMAIN_CHANGE_NOT_ALLOWED, EMPTY_CONTENT, FOREIGN_PAGE, HIGH_RISK_TLD, HOME_HAS_HIERARCHY, HOME_NOT_CREATABLE, HOME_NOT_DELETABLE, HOME_NOT_SORTABLE, HOME_SLUG_IMMUTABLE, LINK_IN_BIO_DEDICATED_ENTRY, LINK_IN_BIO_NOT_DUPLICABLE, META_NOT_LIVE, NO_PUBLIC_URL, OWNERSHIP_REQUIRED, PAGE_LIMIT_REACHED, PARENT_NOT_ALLOWED, PLATFORM_DOMAIN_NOT_ACTIVE, PLATFORM_DOMAIN_WWW_REDUNDANT, RESERVED_SEGMENT, RESERVED_SLUG, RESERVED_SUBDOMAIN, SANITIZE_FAILED, SEARCH_CONSOLE_AUTH_EXPIRED, SEARCH_CONSOLE_NOT_CONNECTED, SEARCH_CONSOLE_PERMISSION_DENIED, SEARCH_CONSOLE_PROPERTY_NOT_FOUND, SEGMENT_TOO_LONG, SITEMAP_NOT_REACHABLE, SUBDOMAIN_MISSING, SYSTEM_PAGE_LOCKED, TEMPLATE_PRODUCT_LOCKED. */
|
|
3951
|
+
/** @description Business rule rejected the request. Codes: BLOCKED, BREADCRUMB_PARENT_INVALID, CONTENT_VALIDATION_FAILED, CORE_SECTION_VIOLATION, CUSTOM_DOMAIN_BLOCKED, CUSTOM_DOMAIN_HIGH_RISK_TLD, CUSTOM_DOMAIN_NOT_ACTIVE, CUSTOM_DOMAIN_TOO_LONG, CUSTOM_DOMAIN_WWW_REDUNDANT, DEPTH_EXCEEDED, DNS_NOT_PROPAGATED, DOMAIN_CHANGE_NOT_ALLOWED, EMPTY_CONTENT, FOREIGN_PAGE, HIGH_RISK_TLD, HOME_HAS_HIERARCHY, HOME_NOT_CREATABLE, HOME_NOT_DELETABLE, HOME_NOT_SORTABLE, HOME_SLUG_IMMUTABLE, LINK_IN_BIO_DEDICATED_ENTRY, LINK_IN_BIO_NOT_DUPLICABLE, META_NOT_LIVE, NO_PUBLIC_URL, OWNERSHIP_REQUIRED, PAGE_LIMIT_REACHED, PARENT_NOT_ALLOWED, PLATFORM_DOMAIN_NOT_ACTIVE, PLATFORM_DOMAIN_WWW_REDUNDANT, RESERVED_SEGMENT, RESERVED_SLUG, RESERVED_SUBDOMAIN, SANITIZE_FAILED, SEARCH_CONSOLE_AUTH_EXPIRED, SEARCH_CONSOLE_NOT_CONNECTED, SEARCH_CONSOLE_PERMISSION_DENIED, SEARCH_CONSOLE_PROPERTY_NOT_FOUND, SEGMENT_TOO_LONG, SERVICE_DOMAIN_IS_FRONTEND, SERVICE_DOMAIN_NOT_SUBDOMAIN, SERVICE_DOMAIN_SINGLE, SITEMAP_NOT_REACHABLE, SUBDOMAIN_MISSING, SYSTEM_PAGE_LOCKED, TEMPLATE_PRODUCT_LOCKED. */
|
|
3860
3952
|
Error422: {
|
|
3861
3953
|
headers: {
|
|
3862
3954
|
[name: string]: unknown;
|
|
@@ -5168,7 +5260,7 @@ export interface operations {
|
|
|
5168
5260
|
pageCount: number | null;
|
|
5169
5261
|
/** @description Where it was uploaded (page module, blog, product, media library…). */
|
|
5170
5262
|
source: string;
|
|
5171
|
-
/** @description Used by site content, products, deliverables, emails or a published snapshot. */
|
|
5263
|
+
/** @description Used by site content, posts, collection items, products, deliverables, emails or a published snapshot. A collection item counts when an image, file or gallery field holds the asset id, or when any field (json and rich text included) holds `asset:<assetId>` or the file's URL. */
|
|
5172
5264
|
inUse: boolean;
|
|
5173
5265
|
/** @description Default focal point of an image (0-1 on the original): image fields without their own framing crop around it. null when unset or centered. */
|
|
5174
5266
|
focus: {
|
|
@@ -5323,7 +5415,7 @@ export interface operations {
|
|
|
5323
5415
|
pageCount: number | null;
|
|
5324
5416
|
/** @description Where it was uploaded (page module, blog, product, media library…). */
|
|
5325
5417
|
source: string;
|
|
5326
|
-
/** @description Used by site content, products, deliverables, emails or a published snapshot. */
|
|
5418
|
+
/** @description Used by site content, posts, collection items, products, deliverables, emails or a published snapshot. A collection item counts when an image, file or gallery field holds the asset id, or when any field (json and rich text included) holds `asset:<assetId>` or the file's URL. */
|
|
5327
5419
|
inUse: boolean;
|
|
5328
5420
|
/** @description Default focal point of an image (0-1 on the original): image fields without their own framing crop around it. null when unset or centered. */
|
|
5329
5421
|
focus: {
|
|
@@ -5619,7 +5711,6 @@ export interface operations {
|
|
|
5619
5711
|
* @enum {string}
|
|
5620
5712
|
*/
|
|
5621
5713
|
icon?: "briefcase" | "star" | "award" | "crown" | "flame" | "zap" | "target" | "rocket" | "flag" | "gem" | "diamond" | "scroll" | "fingerprint" | "smile" | "laugh" | "clock" | "phone" | "mail" | "bell" | "settings" | "check-circle" | "info" | "help-circle" | "headset" | "megaphone" | "newspaper" | "hourglass" | "stamp" | "milestone" | "utensils" | "utensils-crossed" | "chef-hat" | "coffee" | "pizza" | "soup" | "ice-cream-cone" | "sandwich" | "beef" | "fish" | "salad" | "cookie" | "cake" | "cake-slice" | "dessert" | "cup-soda" | "wine" | "beer" | "martini" | "milk" | "wheat" | "egg" | "croissant" | "popcorn" | "candy" | "apple" | "cherry" | "banana" | "citrus" | "grape" | "carrot" | "drumstick" | "cooking-pot" | "shrimp" | "donut" | "bean" | "vegan" | "store" | "shopping-bag" | "shopping-cart" | "shopping-basket" | "package" | "package-check" | "boxes" | "truck" | "motorbike" | "warehouse" | "tag" | "tags" | "ticket-percent" | "barcode" | "qr-code" | "scan-qr-code" | "credit-card" | "smartphone-nfc" | "wallet" | "banknote" | "coins" | "dollar-sign" | "percent" | "badge-percent" | "receipt" | "shirt" | "heart" | "heart-pulse" | "stethoscope" | "hospital" | "syringe" | "pill" | "pill-bottle" | "bandage" | "cross" | "thermometer" | "briefcase-medical" | "scissors" | "sparkles" | "scan-face" | "hand" | "bath" | "droplet" | "droplets" | "flower" | "flower-2" | "sun" | "moon" | "book-open" | "book-text" | "book-copy" | "book-marked" | "book-check" | "graduation-cap" | "school" | "library" | "monitor-play" | "backpack" | "pencil" | "pen-tool" | "file-text" | "scroll-text" | "notebook-pen" | "languages" | "calculator" | "presentation" | "lightbulb" | "brain" | "puzzle" | "laptop" | "monitor" | "smartphone" | "tablet" | "code" | "code-2" | "terminal" | "server" | "database" | "cloud" | "cpu" | "globe" | "network" | "circuit-board" | "brain-circuit" | "bot" | "blocks" | "palette" | "brush" | "paint-bucket" | "pen-line" | "image" | "image-plus" | "camera" | "video" | "film" | "clapperboard" | "music" | "music-2" | "music-4" | "mic" | "mic-2" | "headphones" | "speaker" | "radio" | "podcast" | "piano" | "plane" | "map-pin" | "map-pinned" | "navigation" | "route" | "compass" | "mountain" | "tree-pine" | "trees" | "tent" | "umbrella" | "anchor" | "ship" | "car" | "bike" | "bus" | "train" | "luggage" | "hotel" | "bed-double" | "concierge-bell" | "wifi" | "parking-square" | "air-vent" | "washing-machine" | "cigarette-off" | "accessibility" | "dumbbell" | "biceps-flexed" | "footprints" | "timer" | "watch" | "medal" | "trophy" | "swords" | "badge-check" | "activity" | "building" | "building-2" | "factory" | "house" | "house-plus" | "map-pin-house" | "door-open" | "door-closed" | "key" | "key-round" | "fence" | "sofa" | "ruler" | "hard-hat" | "hammer" | "wrench" | "paint-roller" | "brush-cleaning" | "cat" | "dog" | "bird" | "rabbit" | "squirrel" | "paw-print" | "bone" | "leaf" | "sprout" | "clover" | "tractor" | "cloud-sun" | "cloud-rain" | "snowflake" | "leafy-green" | "tree-deciduous" | "wind" | "waves" | "recycle" | "landmark" | "vault" | "scale" | "gavel" | "shield" | "shield-check" | "badge-dollar-sign" | "hand-coins" | "trending-up" | "trending-down" | "bar-chart" | "bar-chart-2" | "bar-chart-3" | "pie-chart" | "line-chart" | "chart-no-axes-combined" | "users" | "users-round" | "user-circle" | "user-plus" | "hand-heart" | "hand-helping" | "heart-handshake" | "handshake" | "baby" | "church" | "party-popper" | "sparkle" | "gift" | "ticket" | "calendar" | "calendar-days" | "calendar-check" | "calendar-clock";
|
|
5622
|
-
} & {
|
|
5623
5714
|
dark?: {
|
|
5624
5715
|
/** @enum {string} */
|
|
5625
5716
|
type: "image" | "icon";
|
|
@@ -5741,7 +5832,7 @@ export interface operations {
|
|
|
5741
5832
|
pageCount: number | null;
|
|
5742
5833
|
/** @description Where it was uploaded (page module, blog, product, media library…). */
|
|
5743
5834
|
source: string;
|
|
5744
|
-
/** @description Used by site content, products, deliverables, emails or a published snapshot. */
|
|
5835
|
+
/** @description Used by site content, posts, collection items, products, deliverables, emails or a published snapshot. A collection item counts when an image, file or gallery field holds the asset id, or when any field (json and rich text included) holds `asset:<assetId>` or the file's URL. */
|
|
5745
5836
|
inUse: boolean;
|
|
5746
5837
|
/** @description Default focal point of an image (0-1 on the original): image fields without their own framing crop around it. null when unset or centered. */
|
|
5747
5838
|
focus: {
|
|
@@ -6039,7 +6130,7 @@ export interface operations {
|
|
|
6039
6130
|
pageCount: number | null;
|
|
6040
6131
|
/** @description Where it was uploaded (page module, blog, product, media library…). */
|
|
6041
6132
|
source: string;
|
|
6042
|
-
/** @description Used by site content, products, deliverables, emails or a published snapshot. */
|
|
6133
|
+
/** @description Used by site content, posts, collection items, products, deliverables, emails or a published snapshot. A collection item counts when an image, file or gallery field holds the asset id, or when any field (json and rich text included) holds `asset:<assetId>` or the file's URL. */
|
|
6043
6134
|
inUse: boolean;
|
|
6044
6135
|
/** @description Default focal point of an image (0-1 on the original): image fields without their own framing crop around it. null when unset or centered. */
|
|
6045
6136
|
focus: {
|
|
@@ -6335,7 +6426,6 @@ export interface operations {
|
|
|
6335
6426
|
* @enum {string}
|
|
6336
6427
|
*/
|
|
6337
6428
|
icon?: "briefcase" | "star" | "award" | "crown" | "flame" | "zap" | "target" | "rocket" | "flag" | "gem" | "diamond" | "scroll" | "fingerprint" | "smile" | "laugh" | "clock" | "phone" | "mail" | "bell" | "settings" | "check-circle" | "info" | "help-circle" | "headset" | "megaphone" | "newspaper" | "hourglass" | "stamp" | "milestone" | "utensils" | "utensils-crossed" | "chef-hat" | "coffee" | "pizza" | "soup" | "ice-cream-cone" | "sandwich" | "beef" | "fish" | "salad" | "cookie" | "cake" | "cake-slice" | "dessert" | "cup-soda" | "wine" | "beer" | "martini" | "milk" | "wheat" | "egg" | "croissant" | "popcorn" | "candy" | "apple" | "cherry" | "banana" | "citrus" | "grape" | "carrot" | "drumstick" | "cooking-pot" | "shrimp" | "donut" | "bean" | "vegan" | "store" | "shopping-bag" | "shopping-cart" | "shopping-basket" | "package" | "package-check" | "boxes" | "truck" | "motorbike" | "warehouse" | "tag" | "tags" | "ticket-percent" | "barcode" | "qr-code" | "scan-qr-code" | "credit-card" | "smartphone-nfc" | "wallet" | "banknote" | "coins" | "dollar-sign" | "percent" | "badge-percent" | "receipt" | "shirt" | "heart" | "heart-pulse" | "stethoscope" | "hospital" | "syringe" | "pill" | "pill-bottle" | "bandage" | "cross" | "thermometer" | "briefcase-medical" | "scissors" | "sparkles" | "scan-face" | "hand" | "bath" | "droplet" | "droplets" | "flower" | "flower-2" | "sun" | "moon" | "book-open" | "book-text" | "book-copy" | "book-marked" | "book-check" | "graduation-cap" | "school" | "library" | "monitor-play" | "backpack" | "pencil" | "pen-tool" | "file-text" | "scroll-text" | "notebook-pen" | "languages" | "calculator" | "presentation" | "lightbulb" | "brain" | "puzzle" | "laptop" | "monitor" | "smartphone" | "tablet" | "code" | "code-2" | "terminal" | "server" | "database" | "cloud" | "cpu" | "globe" | "network" | "circuit-board" | "brain-circuit" | "bot" | "blocks" | "palette" | "brush" | "paint-bucket" | "pen-line" | "image" | "image-plus" | "camera" | "video" | "film" | "clapperboard" | "music" | "music-2" | "music-4" | "mic" | "mic-2" | "headphones" | "speaker" | "radio" | "podcast" | "piano" | "plane" | "map-pin" | "map-pinned" | "navigation" | "route" | "compass" | "mountain" | "tree-pine" | "trees" | "tent" | "umbrella" | "anchor" | "ship" | "car" | "bike" | "bus" | "train" | "luggage" | "hotel" | "bed-double" | "concierge-bell" | "wifi" | "parking-square" | "air-vent" | "washing-machine" | "cigarette-off" | "accessibility" | "dumbbell" | "biceps-flexed" | "footprints" | "timer" | "watch" | "medal" | "trophy" | "swords" | "badge-check" | "activity" | "building" | "building-2" | "factory" | "house" | "house-plus" | "map-pin-house" | "door-open" | "door-closed" | "key" | "key-round" | "fence" | "sofa" | "ruler" | "hard-hat" | "hammer" | "wrench" | "paint-roller" | "brush-cleaning" | "cat" | "dog" | "bird" | "rabbit" | "squirrel" | "paw-print" | "bone" | "leaf" | "sprout" | "clover" | "tractor" | "cloud-sun" | "cloud-rain" | "snowflake" | "leafy-green" | "tree-deciduous" | "wind" | "waves" | "recycle" | "landmark" | "vault" | "scale" | "gavel" | "shield" | "shield-check" | "badge-dollar-sign" | "hand-coins" | "trending-up" | "trending-down" | "bar-chart" | "bar-chart-2" | "bar-chart-3" | "pie-chart" | "line-chart" | "chart-no-axes-combined" | "users" | "users-round" | "user-circle" | "user-plus" | "hand-heart" | "hand-helping" | "heart-handshake" | "handshake" | "baby" | "church" | "party-popper" | "sparkle" | "gift" | "ticket" | "calendar" | "calendar-days" | "calendar-check" | "calendar-clock";
|
|
6338
|
-
} & {
|
|
6339
6429
|
dark?: {
|
|
6340
6430
|
/** @enum {string} */
|
|
6341
6431
|
type: "image" | "icon";
|
|
@@ -6452,7 +6542,7 @@ export interface operations {
|
|
|
6452
6542
|
pageCount: number | null;
|
|
6453
6543
|
/** @description Where it was uploaded (page module, blog, product, media library…). */
|
|
6454
6544
|
source: string;
|
|
6455
|
-
/** @description Used by site content, products, deliverables, emails or a published snapshot. */
|
|
6545
|
+
/** @description Used by site content, posts, collection items, products, deliverables, emails or a published snapshot. A collection item counts when an image, file or gallery field holds the asset id, or when any field (json and rich text included) holds `asset:<assetId>` or the file's URL. */
|
|
6456
6546
|
inUse: boolean;
|
|
6457
6547
|
/** @description Default focal point of an image (0-1 on the original): image fields without their own framing crop around it. null when unset or centered. */
|
|
6458
6548
|
focus: {
|
|
@@ -6775,7 +6865,7 @@ export interface operations {
|
|
|
6775
6865
|
pageCount: number | null;
|
|
6776
6866
|
/** @description Where it was uploaded (page module, blog, product, media library…). */
|
|
6777
6867
|
source: string;
|
|
6778
|
-
/** @description Used by site content, products, deliverables, emails or a published snapshot. */
|
|
6868
|
+
/** @description Used by site content, posts, collection items, products, deliverables, emails or a published snapshot. A collection item counts when an image, file or gallery field holds the asset id, or when any field (json and rich text included) holds `asset:<assetId>` or the file's URL. */
|
|
6779
6869
|
inUse: boolean;
|
|
6780
6870
|
/** @description Default focal point of an image (0-1 on the original): image fields without their own framing crop around it. null when unset or centered. */
|
|
6781
6871
|
focus: {
|
|
@@ -7739,7 +7829,7 @@ export interface operations {
|
|
|
7739
7829
|
pageCount: number | null;
|
|
7740
7830
|
/** @description Where it was uploaded (page module, blog, product, media library…). */
|
|
7741
7831
|
source: string;
|
|
7742
|
-
/** @description Used by site content, products, deliverables, emails or a published snapshot. */
|
|
7832
|
+
/** @description Used by site content, posts, collection items, products, deliverables, emails or a published snapshot. A collection item counts when an image, file or gallery field holds the asset id, or when any field (json and rich text included) holds `asset:<assetId>` or the file's URL. */
|
|
7743
7833
|
inUse: boolean;
|
|
7744
7834
|
/** @description Default focal point of an image (0-1 on the original): image fields without their own framing crop around it. null when unset or centered. */
|
|
7745
7835
|
focus: {
|
|
@@ -8269,7 +8359,7 @@ export interface operations {
|
|
|
8269
8359
|
pageCount: number | null;
|
|
8270
8360
|
/** @description Where it was uploaded (page module, blog, product, media library…). */
|
|
8271
8361
|
source: string;
|
|
8272
|
-
/** @description Used by site content, products, deliverables, emails or a published snapshot. */
|
|
8362
|
+
/** @description Used by site content, posts, collection items, products, deliverables, emails or a published snapshot. A collection item counts when an image, file or gallery field holds the asset id, or when any field (json and rich text included) holds `asset:<assetId>` or the file's URL. */
|
|
8273
8363
|
inUse: boolean;
|
|
8274
8364
|
/** @description Default focal point of an image (0-1 on the original): image fields without their own framing crop around it. null when unset or centered. */
|
|
8275
8365
|
focus: {
|
|
@@ -8691,7 +8781,7 @@ export interface operations {
|
|
|
8691
8781
|
* "name": "Sunny"
|
|
8692
8782
|
* }
|
|
8693
8783
|
* ],
|
|
8694
|
-
* "
|
|
8784
|
+
* "coverImageAssetId": "asset_example01",
|
|
8695
8785
|
* "pageviews": 0
|
|
8696
8786
|
* }
|
|
8697
8787
|
* ],
|
|
@@ -8733,8 +8823,8 @@ export interface operations {
|
|
|
8733
8823
|
slug: string;
|
|
8734
8824
|
name: string;
|
|
8735
8825
|
}[];
|
|
8736
|
-
/** @description
|
|
8737
|
-
|
|
8826
|
+
/** @description assetId of the cover the author picked for this post, or null when none was picked. It is never derived from the share image or the body. posts.get also returns its display URL. */
|
|
8827
|
+
coverImageAssetId: string | null;
|
|
8738
8828
|
pageviews?: number;
|
|
8739
8829
|
/** @description Set by posts.request_review; non-null means it is waiting for someone with blog:publish. Cleared on posts.publish/posts.reject_review. */
|
|
8740
8830
|
reviewRequestedAt: string | null;
|
|
@@ -8809,8 +8899,10 @@ export interface operations {
|
|
|
8809
8899
|
/** @description Ids from blog_tags.list. */
|
|
8810
8900
|
tagIds?: string[];
|
|
8811
8901
|
showToc?: boolean;
|
|
8812
|
-
|
|
8813
|
-
|
|
8902
|
+
/** @description SEO title. Null or an empty string clears it; a post's public SEO title then follows the post title again. */
|
|
8903
|
+
seoTitle?: string | null;
|
|
8904
|
+
/** @description SEO description. Null or an empty string clears it; a post's public description then follows the excerpt again. */
|
|
8905
|
+
seoDescription?: string | null;
|
|
8814
8906
|
seoKeywords?: string[];
|
|
8815
8907
|
ogImageAlt?: string;
|
|
8816
8908
|
ogImageFraming?: {
|
|
@@ -8865,6 +8957,8 @@ export interface operations {
|
|
|
8865
8957
|
excludeFromSiteSearch?: boolean;
|
|
8866
8958
|
/** @description Share image: assetId of an image in the media library. null removes it; without a share image one is generated automatically. */
|
|
8867
8959
|
ogImageAssetId?: string | null;
|
|
8960
|
+
/** @description Cover of the post: assetId of an image in the media library. null removes it. The cover is shown on the post and in lists; when no share image is set, it is also the share image. Like the body, it goes live on posts.publish. */
|
|
8961
|
+
coverImageAssetId?: string | null;
|
|
8868
8962
|
};
|
|
8869
8963
|
};
|
|
8870
8964
|
};
|
|
@@ -8916,6 +9010,8 @@ export interface operations {
|
|
|
8916
9010
|
* "name": "Sunny"
|
|
8917
9011
|
* }
|
|
8918
9012
|
* ],
|
|
9013
|
+
* "coverImageAssetId": "asset_example01",
|
|
9014
|
+
* "coverImage": "https://media.kanorio.com/example/sunny-bakery-hero.jpg",
|
|
8919
9015
|
* "contentMarkdown": "## 5 a.m. in the bakehouse\n\n\n\nDiscard half the starter, then fold in fresh flour and warm water...",
|
|
8920
9016
|
* "segments": [
|
|
8921
9017
|
* {
|
|
@@ -9021,12 +9117,16 @@ export interface operations {
|
|
|
9021
9117
|
slug: string;
|
|
9022
9118
|
name: string;
|
|
9023
9119
|
}[];
|
|
9120
|
+
/** @description assetId of the cover the author picked for this post, or null when none was picked. It is never derived from the share image or the body. posts.get also returns its display URL. */
|
|
9121
|
+
coverImageAssetId: string | null;
|
|
9024
9122
|
/** @description Set by posts.request_review; non-null means it is waiting for someone with blog:publish. Cleared on posts.publish/posts.reject_review. */
|
|
9025
9123
|
reviewRequestedAt: string | null;
|
|
9026
9124
|
/** @description Who last requested review; kept after a rejection so posts.request_review can be called again by the same person. */
|
|
9027
9125
|
reviewRequestedByUserId: string | null;
|
|
9028
9126
|
/** @description Reason from the last posts.reject_review call; cleared on the next request or successful publish. */
|
|
9029
9127
|
reviewNote: string | null;
|
|
9128
|
+
/** @description Display URL of the cover (changes with versions; do not store it). Null when the post has no cover. */
|
|
9129
|
+
coverImage: string | null;
|
|
9030
9130
|
contentMarkdown: string;
|
|
9031
9131
|
/** @description Structured content blocks (markdown, cta, faq, gallery, toggle, embed, audio, pdf, file) parsed from contentMarkdown. */
|
|
9032
9132
|
segments: {
|
|
@@ -9040,7 +9140,9 @@ export interface operations {
|
|
|
9040
9140
|
}[];
|
|
9041
9141
|
showToc: boolean;
|
|
9042
9142
|
seo: {
|
|
9143
|
+
/** @description The author's own SEO title. Null means none was written: the public SEO title then follows the post title and is refreshed on every publish. */
|
|
9043
9144
|
seoTitle: string | null;
|
|
9145
|
+
/** @description The author's own SEO description. Null means none was written: the public description then follows the excerpt, or the first paragraph, and is refreshed on every publish. */
|
|
9044
9146
|
seoDescription: string | null;
|
|
9045
9147
|
seoKeywords: string[] | null;
|
|
9046
9148
|
/** @description Share image display URL (changes with versions; do not store it). */
|
|
@@ -9097,7 +9199,7 @@ export interface operations {
|
|
|
9097
9199
|
/** @description When true, this post is excluded from visitor site search (independent of robotsIndex). */
|
|
9098
9200
|
excludeFromSiteSearch: boolean;
|
|
9099
9201
|
};
|
|
9100
|
-
/** @description The media-library files contentMarkdown and the share image use, by assetId. */
|
|
9202
|
+
/** @description The media-library files contentMarkdown, the cover and the share image use, by assetId. */
|
|
9101
9203
|
assets: {
|
|
9102
9204
|
[key: string]: {
|
|
9103
9205
|
/** @description Stable id of the file. Reference files by this id; it stays the same when media.replace uploads a new version. */
|
|
@@ -9154,7 +9256,7 @@ export interface operations {
|
|
|
9154
9256
|
pageCount: number | null;
|
|
9155
9257
|
/** @description Where it was uploaded (page module, blog, product, media library…). */
|
|
9156
9258
|
source: string;
|
|
9157
|
-
/** @description Used by site content, products, deliverables, emails or a published snapshot. */
|
|
9259
|
+
/** @description Used by site content, posts, collection items, products, deliverables, emails or a published snapshot. A collection item counts when an image, file or gallery field holds the asset id, or when any field (json and rich text included) holds `asset:<assetId>` or the file's URL. */
|
|
9158
9260
|
inUse: boolean;
|
|
9159
9261
|
/** @description Default focal point of an image (0-1 on the original): image fields without their own framing crop around it. null when unset or centered. */
|
|
9160
9262
|
focus: {
|
|
@@ -10063,6 +10165,8 @@ export interface operations {
|
|
|
10063
10165
|
* "name": "Sunny"
|
|
10064
10166
|
* }
|
|
10065
10167
|
* ],
|
|
10168
|
+
* "coverImageAssetId": "asset_example01",
|
|
10169
|
+
* "coverImage": "https://media.kanorio.com/example/sunny-bakery-hero.jpg",
|
|
10066
10170
|
* "contentMarkdown": "## 5 a.m. in the bakehouse\n\n\n\nDiscard half the starter, then fold in fresh flour and warm water...",
|
|
10067
10171
|
* "segments": [
|
|
10068
10172
|
* {
|
|
@@ -10162,12 +10266,16 @@ export interface operations {
|
|
|
10162
10266
|
slug: string;
|
|
10163
10267
|
name: string;
|
|
10164
10268
|
}[];
|
|
10269
|
+
/** @description assetId of the cover the author picked for this post, or null when none was picked. It is never derived from the share image or the body. posts.get also returns its display URL. */
|
|
10270
|
+
coverImageAssetId: string | null;
|
|
10165
10271
|
/** @description Set by posts.request_review; non-null means it is waiting for someone with blog:publish. Cleared on posts.publish/posts.reject_review. */
|
|
10166
10272
|
reviewRequestedAt: string | null;
|
|
10167
10273
|
/** @description Who last requested review; kept after a rejection so posts.request_review can be called again by the same person. */
|
|
10168
10274
|
reviewRequestedByUserId: string | null;
|
|
10169
10275
|
/** @description Reason from the last posts.reject_review call; cleared on the next request or successful publish. */
|
|
10170
10276
|
reviewNote: string | null;
|
|
10277
|
+
/** @description Display URL of the cover (changes with versions; do not store it). Null when the post has no cover. */
|
|
10278
|
+
coverImage: string | null;
|
|
10171
10279
|
contentMarkdown: string;
|
|
10172
10280
|
/** @description Structured content blocks (markdown, cta, faq, gallery, toggle, embed, audio, pdf, file) parsed from contentMarkdown. */
|
|
10173
10281
|
segments: {
|
|
@@ -10181,7 +10289,9 @@ export interface operations {
|
|
|
10181
10289
|
}[];
|
|
10182
10290
|
showToc: boolean;
|
|
10183
10291
|
seo: {
|
|
10292
|
+
/** @description The author's own SEO title. Null means none was written: the public SEO title then follows the post title and is refreshed on every publish. */
|
|
10184
10293
|
seoTitle: string | null;
|
|
10294
|
+
/** @description The author's own SEO description. Null means none was written: the public description then follows the excerpt, or the first paragraph, and is refreshed on every publish. */
|
|
10185
10295
|
seoDescription: string | null;
|
|
10186
10296
|
seoKeywords: string[] | null;
|
|
10187
10297
|
/** @description Share image display URL (changes with versions; do not store it). */
|
|
@@ -10238,7 +10348,7 @@ export interface operations {
|
|
|
10238
10348
|
/** @description When true, this post is excluded from visitor site search (independent of robotsIndex). */
|
|
10239
10349
|
excludeFromSiteSearch: boolean;
|
|
10240
10350
|
};
|
|
10241
|
-
/** @description The media-library files contentMarkdown and the share image use, by assetId. */
|
|
10351
|
+
/** @description The media-library files contentMarkdown, the cover and the share image use, by assetId. */
|
|
10242
10352
|
assets: {
|
|
10243
10353
|
[key: string]: {
|
|
10244
10354
|
/** @description Stable id of the file. Reference files by this id; it stays the same when media.replace uploads a new version. */
|
|
@@ -10295,7 +10405,7 @@ export interface operations {
|
|
|
10295
10405
|
pageCount: number | null;
|
|
10296
10406
|
/** @description Where it was uploaded (page module, blog, product, media library…). */
|
|
10297
10407
|
source: string;
|
|
10298
|
-
/** @description Used by site content, products, deliverables, emails or a published snapshot. */
|
|
10408
|
+
/** @description Used by site content, posts, collection items, products, deliverables, emails or a published snapshot. A collection item counts when an image, file or gallery field holds the asset id, or when any field (json and rich text included) holds `asset:<assetId>` or the file's URL. */
|
|
10299
10409
|
inUse: boolean;
|
|
10300
10410
|
/** @description Default focal point of an image (0-1 on the original): image fields without their own framing crop around it. null when unset or centered. */
|
|
10301
10411
|
focus: {
|
|
@@ -10361,8 +10471,10 @@ export interface operations {
|
|
|
10361
10471
|
/** @description Ids from blog_tags.list. */
|
|
10362
10472
|
tagIds?: string[];
|
|
10363
10473
|
showToc?: boolean;
|
|
10364
|
-
|
|
10365
|
-
|
|
10474
|
+
/** @description SEO title. Null or an empty string clears it; a post's public SEO title then follows the post title again. */
|
|
10475
|
+
seoTitle?: string | null;
|
|
10476
|
+
/** @description SEO description. Null or an empty string clears it; a post's public description then follows the excerpt again. */
|
|
10477
|
+
seoDescription?: string | null;
|
|
10366
10478
|
seoKeywords?: string[];
|
|
10367
10479
|
ogImageAlt?: string;
|
|
10368
10480
|
ogImageFraming?: {
|
|
@@ -10417,6 +10529,8 @@ export interface operations {
|
|
|
10417
10529
|
excludeFromSiteSearch?: boolean;
|
|
10418
10530
|
/** @description Share image: assetId of an image in the media library. null removes it; without a share image one is generated automatically. */
|
|
10419
10531
|
ogImageAssetId?: string | null;
|
|
10532
|
+
/** @description Cover of the post: assetId of an image in the media library. null removes it. The cover is shown on the post and in lists; when no share image is set, it is also the share image. Like the body, it goes live on posts.publish. */
|
|
10533
|
+
coverImageAssetId?: string | null;
|
|
10420
10534
|
/** @description Optimistic lock: the post's updatedAt you last read. If it no longer matches, the update is rejected with CONFLICT instead of overwriting. */
|
|
10421
10535
|
ifUnmodifiedSince?: string;
|
|
10422
10536
|
};
|
|
@@ -10470,6 +10584,8 @@ export interface operations {
|
|
|
10470
10584
|
* "name": "Sunny"
|
|
10471
10585
|
* }
|
|
10472
10586
|
* ],
|
|
10587
|
+
* "coverImageAssetId": "asset_example01",
|
|
10588
|
+
* "coverImage": "https://media.kanorio.com/example/sunny-bakery-hero.jpg",
|
|
10473
10589
|
* "contentMarkdown": "## 5 a.m. in the bakehouse\n\n\n\nDiscard half the starter, then fold in fresh flour and warm water...",
|
|
10474
10590
|
* "segments": [
|
|
10475
10591
|
* {
|
|
@@ -10569,12 +10685,16 @@ export interface operations {
|
|
|
10569
10685
|
slug: string;
|
|
10570
10686
|
name: string;
|
|
10571
10687
|
}[];
|
|
10688
|
+
/** @description assetId of the cover the author picked for this post, or null when none was picked. It is never derived from the share image or the body. posts.get also returns its display URL. */
|
|
10689
|
+
coverImageAssetId: string | null;
|
|
10572
10690
|
/** @description Set by posts.request_review; non-null means it is waiting for someone with blog:publish. Cleared on posts.publish/posts.reject_review. */
|
|
10573
10691
|
reviewRequestedAt: string | null;
|
|
10574
10692
|
/** @description Who last requested review; kept after a rejection so posts.request_review can be called again by the same person. */
|
|
10575
10693
|
reviewRequestedByUserId: string | null;
|
|
10576
10694
|
/** @description Reason from the last posts.reject_review call; cleared on the next request or successful publish. */
|
|
10577
10695
|
reviewNote: string | null;
|
|
10696
|
+
/** @description Display URL of the cover (changes with versions; do not store it). Null when the post has no cover. */
|
|
10697
|
+
coverImage: string | null;
|
|
10578
10698
|
contentMarkdown: string;
|
|
10579
10699
|
/** @description Structured content blocks (markdown, cta, faq, gallery, toggle, embed, audio, pdf, file) parsed from contentMarkdown. */
|
|
10580
10700
|
segments: {
|
|
@@ -10588,7 +10708,9 @@ export interface operations {
|
|
|
10588
10708
|
}[];
|
|
10589
10709
|
showToc: boolean;
|
|
10590
10710
|
seo: {
|
|
10711
|
+
/** @description The author's own SEO title. Null means none was written: the public SEO title then follows the post title and is refreshed on every publish. */
|
|
10591
10712
|
seoTitle: string | null;
|
|
10713
|
+
/** @description The author's own SEO description. Null means none was written: the public description then follows the excerpt, or the first paragraph, and is refreshed on every publish. */
|
|
10592
10714
|
seoDescription: string | null;
|
|
10593
10715
|
seoKeywords: string[] | null;
|
|
10594
10716
|
/** @description Share image display URL (changes with versions; do not store it). */
|
|
@@ -10645,7 +10767,7 @@ export interface operations {
|
|
|
10645
10767
|
/** @description When true, this post is excluded from visitor site search (independent of robotsIndex). */
|
|
10646
10768
|
excludeFromSiteSearch: boolean;
|
|
10647
10769
|
};
|
|
10648
|
-
/** @description The media-library files contentMarkdown and the share image use, by assetId. */
|
|
10770
|
+
/** @description The media-library files contentMarkdown, the cover and the share image use, by assetId. */
|
|
10649
10771
|
assets: {
|
|
10650
10772
|
[key: string]: {
|
|
10651
10773
|
/** @description Stable id of the file. Reference files by this id; it stays the same when media.replace uploads a new version. */
|
|
@@ -10702,7 +10824,7 @@ export interface operations {
|
|
|
10702
10824
|
pageCount: number | null;
|
|
10703
10825
|
/** @description Where it was uploaded (page module, blog, product, media library…). */
|
|
10704
10826
|
source: string;
|
|
10705
|
-
/** @description Used by site content, products, deliverables, emails or a published snapshot. */
|
|
10827
|
+
/** @description Used by site content, posts, collection items, products, deliverables, emails or a published snapshot. A collection item counts when an image, file or gallery field holds the asset id, or when any field (json and rich text included) holds `asset:<assetId>` or the file's URL. */
|
|
10706
10828
|
inUse: boolean;
|
|
10707
10829
|
/** @description Default focal point of an image (0-1 on the original): image fields without their own framing crop around it. null when unset or centered. */
|
|
10708
10830
|
focus: {
|
|
@@ -10806,6 +10928,8 @@ export interface operations {
|
|
|
10806
10928
|
* "name": "Sunny"
|
|
10807
10929
|
* }
|
|
10808
10930
|
* ],
|
|
10931
|
+
* "coverImageAssetId": "asset_example01",
|
|
10932
|
+
* "coverImage": "https://media.kanorio.com/example/sunny-bakery-hero.jpg",
|
|
10809
10933
|
* "contentMarkdown": "## 5 a.m. in the bakehouse\n\n\n\nDiscard half the starter, then fold in fresh flour and warm water...",
|
|
10810
10934
|
* "segments": [
|
|
10811
10935
|
* {
|
|
@@ -10906,12 +11030,16 @@ export interface operations {
|
|
|
10906
11030
|
slug: string;
|
|
10907
11031
|
name: string;
|
|
10908
11032
|
}[];
|
|
11033
|
+
/** @description assetId of the cover the author picked for this post, or null when none was picked. It is never derived from the share image or the body. posts.get also returns its display URL. */
|
|
11034
|
+
coverImageAssetId: string | null;
|
|
10909
11035
|
/** @description Set by posts.request_review; non-null means it is waiting for someone with blog:publish. Cleared on posts.publish/posts.reject_review. */
|
|
10910
11036
|
reviewRequestedAt: string | null;
|
|
10911
11037
|
/** @description Who last requested review; kept after a rejection so posts.request_review can be called again by the same person. */
|
|
10912
11038
|
reviewRequestedByUserId: string | null;
|
|
10913
11039
|
/** @description Reason from the last posts.reject_review call; cleared on the next request or successful publish. */
|
|
10914
11040
|
reviewNote: string | null;
|
|
11041
|
+
/** @description Display URL of the cover (changes with versions; do not store it). Null when the post has no cover. */
|
|
11042
|
+
coverImage: string | null;
|
|
10915
11043
|
contentMarkdown: string;
|
|
10916
11044
|
/** @description Structured content blocks (markdown, cta, faq, gallery, toggle, embed, audio, pdf, file) parsed from contentMarkdown. */
|
|
10917
11045
|
segments: {
|
|
@@ -10925,7 +11053,9 @@ export interface operations {
|
|
|
10925
11053
|
}[];
|
|
10926
11054
|
showToc: boolean;
|
|
10927
11055
|
seo: {
|
|
11056
|
+
/** @description The author's own SEO title. Null means none was written: the public SEO title then follows the post title and is refreshed on every publish. */
|
|
10928
11057
|
seoTitle: string | null;
|
|
11058
|
+
/** @description The author's own SEO description. Null means none was written: the public description then follows the excerpt, or the first paragraph, and is refreshed on every publish. */
|
|
10929
11059
|
seoDescription: string | null;
|
|
10930
11060
|
seoKeywords: string[] | null;
|
|
10931
11061
|
/** @description Share image display URL (changes with versions; do not store it). */
|
|
@@ -10982,7 +11112,7 @@ export interface operations {
|
|
|
10982
11112
|
/** @description When true, this post is excluded from visitor site search (independent of robotsIndex). */
|
|
10983
11113
|
excludeFromSiteSearch: boolean;
|
|
10984
11114
|
};
|
|
10985
|
-
/** @description The media-library files contentMarkdown and the share image use, by assetId. */
|
|
11115
|
+
/** @description The media-library files contentMarkdown, the cover and the share image use, by assetId. */
|
|
10986
11116
|
assets: {
|
|
10987
11117
|
[key: string]: {
|
|
10988
11118
|
/** @description Stable id of the file. Reference files by this id; it stays the same when media.replace uploads a new version. */
|
|
@@ -11039,7 +11169,7 @@ export interface operations {
|
|
|
11039
11169
|
pageCount: number | null;
|
|
11040
11170
|
/** @description Where it was uploaded (page module, blog, product, media library…). */
|
|
11041
11171
|
source: string;
|
|
11042
|
-
/** @description Used by site content, products, deliverables, emails or a published snapshot. */
|
|
11172
|
+
/** @description Used by site content, posts, collection items, products, deliverables, emails or a published snapshot. A collection item counts when an image, file or gallery field holds the asset id, or when any field (json and rich text included) holds `asset:<assetId>` or the file's URL. */
|
|
11043
11173
|
inUse: boolean;
|
|
11044
11174
|
/** @description Default focal point of an image (0-1 on the original): image fields without their own framing crop around it. null when unset or centered. */
|
|
11045
11175
|
focus: {
|
|
@@ -11135,6 +11265,8 @@ export interface operations {
|
|
|
11135
11265
|
* "name": "Sunny"
|
|
11136
11266
|
* }
|
|
11137
11267
|
* ],
|
|
11268
|
+
* "coverImageAssetId": "asset_example01",
|
|
11269
|
+
* "coverImage": "https://media.kanorio.com/example/sunny-bakery-hero.jpg",
|
|
11138
11270
|
* "contentMarkdown": "## 5 a.m. in the bakehouse\n\n\n\nDiscard half the starter, then fold in fresh flour and warm water...",
|
|
11139
11271
|
* "segments": [
|
|
11140
11272
|
* {
|
|
@@ -11234,12 +11366,16 @@ export interface operations {
|
|
|
11234
11366
|
slug: string;
|
|
11235
11367
|
name: string;
|
|
11236
11368
|
}[];
|
|
11369
|
+
/** @description assetId of the cover the author picked for this post, or null when none was picked. It is never derived from the share image or the body. posts.get also returns its display URL. */
|
|
11370
|
+
coverImageAssetId: string | null;
|
|
11237
11371
|
/** @description Set by posts.request_review; non-null means it is waiting for someone with blog:publish. Cleared on posts.publish/posts.reject_review. */
|
|
11238
11372
|
reviewRequestedAt: string | null;
|
|
11239
11373
|
/** @description Who last requested review; kept after a rejection so posts.request_review can be called again by the same person. */
|
|
11240
11374
|
reviewRequestedByUserId: string | null;
|
|
11241
11375
|
/** @description Reason from the last posts.reject_review call; cleared on the next request or successful publish. */
|
|
11242
11376
|
reviewNote: string | null;
|
|
11377
|
+
/** @description Display URL of the cover (changes with versions; do not store it). Null when the post has no cover. */
|
|
11378
|
+
coverImage: string | null;
|
|
11243
11379
|
contentMarkdown: string;
|
|
11244
11380
|
/** @description Structured content blocks (markdown, cta, faq, gallery, toggle, embed, audio, pdf, file) parsed from contentMarkdown. */
|
|
11245
11381
|
segments: {
|
|
@@ -11253,7 +11389,9 @@ export interface operations {
|
|
|
11253
11389
|
}[];
|
|
11254
11390
|
showToc: boolean;
|
|
11255
11391
|
seo: {
|
|
11392
|
+
/** @description The author's own SEO title. Null means none was written: the public SEO title then follows the post title and is refreshed on every publish. */
|
|
11256
11393
|
seoTitle: string | null;
|
|
11394
|
+
/** @description The author's own SEO description. Null means none was written: the public description then follows the excerpt, or the first paragraph, and is refreshed on every publish. */
|
|
11257
11395
|
seoDescription: string | null;
|
|
11258
11396
|
seoKeywords: string[] | null;
|
|
11259
11397
|
/** @description Share image display URL (changes with versions; do not store it). */
|
|
@@ -11310,7 +11448,7 @@ export interface operations {
|
|
|
11310
11448
|
/** @description When true, this post is excluded from visitor site search (independent of robotsIndex). */
|
|
11311
11449
|
excludeFromSiteSearch: boolean;
|
|
11312
11450
|
};
|
|
11313
|
-
/** @description The media-library files contentMarkdown and the share image use, by assetId. */
|
|
11451
|
+
/** @description The media-library files contentMarkdown, the cover and the share image use, by assetId. */
|
|
11314
11452
|
assets: {
|
|
11315
11453
|
[key: string]: {
|
|
11316
11454
|
/** @description Stable id of the file. Reference files by this id; it stays the same when media.replace uploads a new version. */
|
|
@@ -11367,7 +11505,7 @@ export interface operations {
|
|
|
11367
11505
|
pageCount: number | null;
|
|
11368
11506
|
/** @description Where it was uploaded (page module, blog, product, media library…). */
|
|
11369
11507
|
source: string;
|
|
11370
|
-
/** @description Used by site content, products, deliverables, emails or a published snapshot. */
|
|
11508
|
+
/** @description Used by site content, posts, collection items, products, deliverables, emails or a published snapshot. A collection item counts when an image, file or gallery field holds the asset id, or when any field (json and rich text included) holds `asset:<assetId>` or the file's URL. */
|
|
11371
11509
|
inUse: boolean;
|
|
11372
11510
|
/** @description Default focal point of an image (0-1 on the original): image fields without their own framing crop around it. null when unset or centered. */
|
|
11373
11511
|
focus: {
|
|
@@ -11459,6 +11597,8 @@ export interface operations {
|
|
|
11459
11597
|
* "name": "Sunny"
|
|
11460
11598
|
* }
|
|
11461
11599
|
* ],
|
|
11600
|
+
* "coverImageAssetId": "asset_example01",
|
|
11601
|
+
* "coverImage": "https://media.kanorio.com/example/sunny-bakery-hero.jpg",
|
|
11462
11602
|
* "contentMarkdown": "## 5 a.m. in the bakehouse\n\n\n\nDiscard half the starter, then fold in fresh flour and warm water...",
|
|
11463
11603
|
* "segments": [
|
|
11464
11604
|
* {
|
|
@@ -11558,12 +11698,16 @@ export interface operations {
|
|
|
11558
11698
|
slug: string;
|
|
11559
11699
|
name: string;
|
|
11560
11700
|
}[];
|
|
11701
|
+
/** @description assetId of the cover the author picked for this post, or null when none was picked. It is never derived from the share image or the body. posts.get also returns its display URL. */
|
|
11702
|
+
coverImageAssetId: string | null;
|
|
11561
11703
|
/** @description Set by posts.request_review; non-null means it is waiting for someone with blog:publish. Cleared on posts.publish/posts.reject_review. */
|
|
11562
11704
|
reviewRequestedAt: string | null;
|
|
11563
11705
|
/** @description Who last requested review; kept after a rejection so posts.request_review can be called again by the same person. */
|
|
11564
11706
|
reviewRequestedByUserId: string | null;
|
|
11565
11707
|
/** @description Reason from the last posts.reject_review call; cleared on the next request or successful publish. */
|
|
11566
11708
|
reviewNote: string | null;
|
|
11709
|
+
/** @description Display URL of the cover (changes with versions; do not store it). Null when the post has no cover. */
|
|
11710
|
+
coverImage: string | null;
|
|
11567
11711
|
contentMarkdown: string;
|
|
11568
11712
|
/** @description Structured content blocks (markdown, cta, faq, gallery, toggle, embed, audio, pdf, file) parsed from contentMarkdown. */
|
|
11569
11713
|
segments: {
|
|
@@ -11577,7 +11721,9 @@ export interface operations {
|
|
|
11577
11721
|
}[];
|
|
11578
11722
|
showToc: boolean;
|
|
11579
11723
|
seo: {
|
|
11724
|
+
/** @description The author's own SEO title. Null means none was written: the public SEO title then follows the post title and is refreshed on every publish. */
|
|
11580
11725
|
seoTitle: string | null;
|
|
11726
|
+
/** @description The author's own SEO description. Null means none was written: the public description then follows the excerpt, or the first paragraph, and is refreshed on every publish. */
|
|
11581
11727
|
seoDescription: string | null;
|
|
11582
11728
|
seoKeywords: string[] | null;
|
|
11583
11729
|
/** @description Share image display URL (changes with versions; do not store it). */
|
|
@@ -11634,7 +11780,7 @@ export interface operations {
|
|
|
11634
11780
|
/** @description When true, this post is excluded from visitor site search (independent of robotsIndex). */
|
|
11635
11781
|
excludeFromSiteSearch: boolean;
|
|
11636
11782
|
};
|
|
11637
|
-
/** @description The media-library files contentMarkdown and the share image use, by assetId. */
|
|
11783
|
+
/** @description The media-library files contentMarkdown, the cover and the share image use, by assetId. */
|
|
11638
11784
|
assets: {
|
|
11639
11785
|
[key: string]: {
|
|
11640
11786
|
/** @description Stable id of the file. Reference files by this id; it stays the same when media.replace uploads a new version. */
|
|
@@ -11691,7 +11837,7 @@ export interface operations {
|
|
|
11691
11837
|
pageCount: number | null;
|
|
11692
11838
|
/** @description Where it was uploaded (page module, blog, product, media library…). */
|
|
11693
11839
|
source: string;
|
|
11694
|
-
/** @description Used by site content, products, deliverables, emails or a published snapshot. */
|
|
11840
|
+
/** @description Used by site content, posts, collection items, products, deliverables, emails or a published snapshot. A collection item counts when an image, file or gallery field holds the asset id, or when any field (json and rich text included) holds `asset:<assetId>` or the file's URL. */
|
|
11695
11841
|
inUse: boolean;
|
|
11696
11842
|
/** @description Default focal point of an image (0-1 on the original): image fields without their own framing crop around it. null when unset or centered. */
|
|
11697
11843
|
focus: {
|
|
@@ -11794,6 +11940,8 @@ export interface operations {
|
|
|
11794
11940
|
* "name": "Sunny"
|
|
11795
11941
|
* }
|
|
11796
11942
|
* ],
|
|
11943
|
+
* "coverImageAssetId": "asset_example01",
|
|
11944
|
+
* "coverImage": "https://media.kanorio.com/example/sunny-bakery-hero.jpg",
|
|
11797
11945
|
* "contentMarkdown": "## 5 a.m. in the bakehouse\n\n\n\nDiscard half the starter, then fold in fresh flour and warm water...",
|
|
11798
11946
|
* "segments": [
|
|
11799
11947
|
* {
|
|
@@ -11893,12 +12041,16 @@ export interface operations {
|
|
|
11893
12041
|
slug: string;
|
|
11894
12042
|
name: string;
|
|
11895
12043
|
}[];
|
|
12044
|
+
/** @description assetId of the cover the author picked for this post, or null when none was picked. It is never derived from the share image or the body. posts.get also returns its display URL. */
|
|
12045
|
+
coverImageAssetId: string | null;
|
|
11896
12046
|
/** @description Set by posts.request_review; non-null means it is waiting for someone with blog:publish. Cleared on posts.publish/posts.reject_review. */
|
|
11897
12047
|
reviewRequestedAt: string | null;
|
|
11898
12048
|
/** @description Who last requested review; kept after a rejection so posts.request_review can be called again by the same person. */
|
|
11899
12049
|
reviewRequestedByUserId: string | null;
|
|
11900
12050
|
/** @description Reason from the last posts.reject_review call; cleared on the next request or successful publish. */
|
|
11901
12051
|
reviewNote: string | null;
|
|
12052
|
+
/** @description Display URL of the cover (changes with versions; do not store it). Null when the post has no cover. */
|
|
12053
|
+
coverImage: string | null;
|
|
11902
12054
|
contentMarkdown: string;
|
|
11903
12055
|
/** @description Structured content blocks (markdown, cta, faq, gallery, toggle, embed, audio, pdf, file) parsed from contentMarkdown. */
|
|
11904
12056
|
segments: {
|
|
@@ -11912,7 +12064,9 @@ export interface operations {
|
|
|
11912
12064
|
}[];
|
|
11913
12065
|
showToc: boolean;
|
|
11914
12066
|
seo: {
|
|
12067
|
+
/** @description The author's own SEO title. Null means none was written: the public SEO title then follows the post title and is refreshed on every publish. */
|
|
11915
12068
|
seoTitle: string | null;
|
|
12069
|
+
/** @description The author's own SEO description. Null means none was written: the public description then follows the excerpt, or the first paragraph, and is refreshed on every publish. */
|
|
11916
12070
|
seoDescription: string | null;
|
|
11917
12071
|
seoKeywords: string[] | null;
|
|
11918
12072
|
/** @description Share image display URL (changes with versions; do not store it). */
|
|
@@ -11969,7 +12123,7 @@ export interface operations {
|
|
|
11969
12123
|
/** @description When true, this post is excluded from visitor site search (independent of robotsIndex). */
|
|
11970
12124
|
excludeFromSiteSearch: boolean;
|
|
11971
12125
|
};
|
|
11972
|
-
/** @description The media-library files contentMarkdown and the share image use, by assetId. */
|
|
12126
|
+
/** @description The media-library files contentMarkdown, the cover and the share image use, by assetId. */
|
|
11973
12127
|
assets: {
|
|
11974
12128
|
[key: string]: {
|
|
11975
12129
|
/** @description Stable id of the file. Reference files by this id; it stays the same when media.replace uploads a new version. */
|
|
@@ -12026,7 +12180,7 @@ export interface operations {
|
|
|
12026
12180
|
pageCount: number | null;
|
|
12027
12181
|
/** @description Where it was uploaded (page module, blog, product, media library…). */
|
|
12028
12182
|
source: string;
|
|
12029
|
-
/** @description Used by site content, products, deliverables, emails or a published snapshot. */
|
|
12183
|
+
/** @description Used by site content, posts, collection items, products, deliverables, emails or a published snapshot. A collection item counts when an image, file or gallery field holds the asset id, or when any field (json and rich text included) holds `asset:<assetId>` or the file's URL. */
|
|
12030
12184
|
inUse: boolean;
|
|
12031
12185
|
/** @description Default focal point of an image (0-1 on the original): image fields without their own framing crop around it. null when unset or centered. */
|
|
12032
12186
|
focus: {
|
|
@@ -12118,6 +12272,8 @@ export interface operations {
|
|
|
12118
12272
|
* "name": "Sunny"
|
|
12119
12273
|
* }
|
|
12120
12274
|
* ],
|
|
12275
|
+
* "coverImageAssetId": "asset_example01",
|
|
12276
|
+
* "coverImage": "https://media.kanorio.com/example/sunny-bakery-hero.jpg",
|
|
12121
12277
|
* "contentMarkdown": "## 5 a.m. in the bakehouse\n\n\n\nDiscard half the starter, then fold in fresh flour and warm water...",
|
|
12122
12278
|
* "segments": [
|
|
12123
12279
|
* {
|
|
@@ -12217,12 +12373,16 @@ export interface operations {
|
|
|
12217
12373
|
slug: string;
|
|
12218
12374
|
name: string;
|
|
12219
12375
|
}[];
|
|
12376
|
+
/** @description assetId of the cover the author picked for this post, or null when none was picked. It is never derived from the share image or the body. posts.get also returns its display URL. */
|
|
12377
|
+
coverImageAssetId: string | null;
|
|
12220
12378
|
/** @description Set by posts.request_review; non-null means it is waiting for someone with blog:publish. Cleared on posts.publish/posts.reject_review. */
|
|
12221
12379
|
reviewRequestedAt: string | null;
|
|
12222
12380
|
/** @description Who last requested review; kept after a rejection so posts.request_review can be called again by the same person. */
|
|
12223
12381
|
reviewRequestedByUserId: string | null;
|
|
12224
12382
|
/** @description Reason from the last posts.reject_review call; cleared on the next request or successful publish. */
|
|
12225
12383
|
reviewNote: string | null;
|
|
12384
|
+
/** @description Display URL of the cover (changes with versions; do not store it). Null when the post has no cover. */
|
|
12385
|
+
coverImage: string | null;
|
|
12226
12386
|
contentMarkdown: string;
|
|
12227
12387
|
/** @description Structured content blocks (markdown, cta, faq, gallery, toggle, embed, audio, pdf, file) parsed from contentMarkdown. */
|
|
12228
12388
|
segments: {
|
|
@@ -12236,7 +12396,9 @@ export interface operations {
|
|
|
12236
12396
|
}[];
|
|
12237
12397
|
showToc: boolean;
|
|
12238
12398
|
seo: {
|
|
12399
|
+
/** @description The author's own SEO title. Null means none was written: the public SEO title then follows the post title and is refreshed on every publish. */
|
|
12239
12400
|
seoTitle: string | null;
|
|
12401
|
+
/** @description The author's own SEO description. Null means none was written: the public description then follows the excerpt, or the first paragraph, and is refreshed on every publish. */
|
|
12240
12402
|
seoDescription: string | null;
|
|
12241
12403
|
seoKeywords: string[] | null;
|
|
12242
12404
|
/** @description Share image display URL (changes with versions; do not store it). */
|
|
@@ -12293,7 +12455,7 @@ export interface operations {
|
|
|
12293
12455
|
/** @description When true, this post is excluded from visitor site search (independent of robotsIndex). */
|
|
12294
12456
|
excludeFromSiteSearch: boolean;
|
|
12295
12457
|
};
|
|
12296
|
-
/** @description The media-library files contentMarkdown and the share image use, by assetId. */
|
|
12458
|
+
/** @description The media-library files contentMarkdown, the cover and the share image use, by assetId. */
|
|
12297
12459
|
assets: {
|
|
12298
12460
|
[key: string]: {
|
|
12299
12461
|
/** @description Stable id of the file. Reference files by this id; it stays the same when media.replace uploads a new version. */
|
|
@@ -12350,7 +12512,7 @@ export interface operations {
|
|
|
12350
12512
|
pageCount: number | null;
|
|
12351
12513
|
/** @description Where it was uploaded (page module, blog, product, media library…). */
|
|
12352
12514
|
source: string;
|
|
12353
|
-
/** @description Used by site content, products, deliverables, emails or a published snapshot. */
|
|
12515
|
+
/** @description Used by site content, posts, collection items, products, deliverables, emails or a published snapshot. A collection item counts when an image, file or gallery field holds the asset id, or when any field (json and rich text included) holds `asset:<assetId>` or the file's URL. */
|
|
12354
12516
|
inUse: boolean;
|
|
12355
12517
|
/** @description Default focal point of an image (0-1 on the original): image fields without their own framing crop around it. null when unset or centered. */
|
|
12356
12518
|
focus: {
|
|
@@ -17515,8 +17677,8 @@ export interface operations {
|
|
|
17515
17677
|
* "tokenId": "cm9example0001apitoken",
|
|
17516
17678
|
* "name": "Website server",
|
|
17517
17679
|
* "keyName": "Vercel production",
|
|
17518
|
-
* "prefix": "
|
|
17519
|
-
* "key": "
|
|
17680
|
+
* "prefix": "knr_sk_xxxxxxxx",
|
|
17681
|
+
* "key": "knr_sk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
|
|
17520
17682
|
* "envName": "KANORIO_SERVER_KEY",
|
|
17521
17683
|
* "createdAt": "2026-10-06T08:00:00.000Z"
|
|
17522
17684
|
* }
|
|
@@ -17527,9 +17689,9 @@ export interface operations {
|
|
|
17527
17689
|
/** @description Service account name. */
|
|
17528
17690
|
name: string;
|
|
17529
17691
|
keyName: string;
|
|
17530
|
-
/** @description Display prefix of the key (
|
|
17692
|
+
/** @description Display prefix of the key (knr_sk_ plus 8 characters). */
|
|
17531
17693
|
prefix: string;
|
|
17532
|
-
/** @description The server key (
|
|
17694
|
+
/** @description The server key (knr_sk_…). Shown only once. */
|
|
17533
17695
|
key: string;
|
|
17534
17696
|
/** @description Environment variable name to store the key under. */
|
|
17535
17697
|
envName: string;
|
|
@@ -17547,9 +17709,9 @@ export interface operations {
|
|
|
17547
17709
|
};
|
|
17548
17710
|
site_check_external_frontend: {
|
|
17549
17711
|
parameters: {
|
|
17550
|
-
query
|
|
17712
|
+
query?: {
|
|
17551
17713
|
/** @description Deprecated and ignored: the former cutover checks (hosted 302 redirect, GSC, customer auth CORS) now run every time. */
|
|
17552
|
-
switching
|
|
17714
|
+
switching?: boolean;
|
|
17553
17715
|
};
|
|
17554
17716
|
header?: never;
|
|
17555
17717
|
path: {
|
|
@@ -17574,13 +17736,15 @@ export interface operations {
|
|
|
17574
17736
|
* "checks": [
|
|
17575
17737
|
* {
|
|
17576
17738
|
* "id": "derivatives",
|
|
17739
|
+
* "code": "ok",
|
|
17577
17740
|
* "title": "SEO & AEO derivative files (sitemap, robots, llms, feed)",
|
|
17578
17741
|
* "status": "pass",
|
|
17579
|
-
* "summary": "sitemap.xml, robots.txt, llms.txt and feed.xml are live
|
|
17742
|
+
* "summary": "sitemap.xml, robots.txt, llms.txt and feed.xml are live.",
|
|
17580
17743
|
* "remediation": "Add seoRewrites({ siteUrl, framework: \"next\" | \"astro\" }) from @kanorio/sdk."
|
|
17581
17744
|
* },
|
|
17582
17745
|
* {
|
|
17583
17746
|
* "id": "jsonld",
|
|
17747
|
+
* "code": "ok",
|
|
17584
17748
|
* "title": "Schema.org JSON-LD structured data",
|
|
17585
17749
|
* "status": "pass",
|
|
17586
17750
|
* "summary": "JSON-LD @graph matched on all 3 sampled page(s).",
|
|
@@ -17588,6 +17752,7 @@ export interface operations {
|
|
|
17588
17752
|
* },
|
|
17589
17753
|
* {
|
|
17590
17754
|
* "id": "content",
|
|
17755
|
+
* "code": "ok",
|
|
17591
17756
|
* "title": "Published page content sync",
|
|
17592
17757
|
* "status": "pass",
|
|
17593
17758
|
* "summary": "All 3 sampled page(s) match published titles and content.",
|
|
@@ -17595,6 +17760,7 @@ export interface operations {
|
|
|
17595
17760
|
* },
|
|
17596
17761
|
* {
|
|
17597
17762
|
* "id": "analytics",
|
|
17763
|
+
* "code": "ok",
|
|
17598
17764
|
* "title": "Visitor pageview reporting (last 24h)",
|
|
17599
17765
|
* "status": "pass",
|
|
17600
17766
|
* "summary": "Received 42 pageview(s) from the external storefront in the last 24 hours.",
|
|
@@ -17602,6 +17768,7 @@ export interface operations {
|
|
|
17602
17768
|
* },
|
|
17603
17769
|
* {
|
|
17604
17770
|
* "id": "revalidate",
|
|
17771
|
+
* "code": "ok",
|
|
17605
17772
|
* "title": "On-demand ISR cache revalidation webhook",
|
|
17606
17773
|
* "status": "pass",
|
|
17607
17774
|
* "summary": "1 active webhook endpoint(s) subscribed for cache invalidation.",
|
|
@@ -17609,6 +17776,7 @@ export interface operations {
|
|
|
17609
17776
|
* },
|
|
17610
17777
|
* {
|
|
17611
17778
|
* "id": "indexnow",
|
|
17779
|
+
* "code": "ok",
|
|
17612
17780
|
* "title": "IndexNow key verification file (/<key>.txt)",
|
|
17613
17781
|
* "status": "pass",
|
|
17614
17782
|
* "summary": "The IndexNow key file is reachable and matches, so search engines can verify new or updated content.",
|
|
@@ -17628,11 +17796,17 @@ export interface operations {
|
|
|
17628
17796
|
* @enum {string}
|
|
17629
17797
|
*/
|
|
17630
17798
|
id: "derivatives" | "jsonld" | "content" | "analytics" | "revalidate" | "indexnow" | "hosted_redirect" | "gsc" | "customer_auth" | "i18n_pages" | "i18n_alternates" | "i18n_files";
|
|
17799
|
+
/** @description Stable result code for this check (for example ok, partial, unreachable, none, paused, not_connected). Branch on id + code; title, summary and remediation are English text that may be reworded. */
|
|
17800
|
+
code: string;
|
|
17631
17801
|
title: string;
|
|
17632
17802
|
/** @enum {string} */
|
|
17633
17803
|
status: "pass" | "warn" | "fail";
|
|
17634
17804
|
summary: string;
|
|
17635
17805
|
remediation: string;
|
|
17806
|
+
/** @description Values behind the result (counts, URLs, lists). */
|
|
17807
|
+
params?: {
|
|
17808
|
+
[key: string]: string | number;
|
|
17809
|
+
};
|
|
17636
17810
|
details?: {
|
|
17637
17811
|
[key: string]: unknown;
|
|
17638
17812
|
};
|
|
@@ -19706,7 +19880,7 @@ export interface operations {
|
|
|
19706
19880
|
fields: {
|
|
19707
19881
|
[key: string]: unknown;
|
|
19708
19882
|
}[];
|
|
19709
|
-
/** @description Form settings. Keys: submitLabel, successMessage, redirectUrl (a path on this site or
|
|
19883
|
+
/** @description Form settings. Keys: submitLabel, successMessage, redirectUrl (where the visitor goes after a successful submit: a path on this site, or an https URL on any site, for example a LINE or WhatsApp chat link or a partner's booking page. It can carry {answers.<fieldId>} and {submissionId} in its path, query or fragment, never in the host; each is replaced with the percent-encoded answer text, and <fieldId> must be a question of this form that is not a file question, or one of its hidden fields), marketingConsent (off or checkbox; checkbox needs an email question), limitOnePerContact, replyKind (which confirmation email template the person who filled in the form gets: inquiry, booking, event, application, signup, feedback, general; default general), openAt, closeAt (ISO date-times), maxSubmissions, hiddenFields [{ id, label? }]. Not settable through the API: marketingConsent "submit" (subscribe on submit) and consentText (custom consent wording); the owner sets those in the console. The submission retention period is not part of settings and cannot be changed here. */
|
|
19710
19884
|
settings?: {
|
|
19711
19885
|
[key: string]: unknown;
|
|
19712
19886
|
};
|
|
@@ -19825,6 +19999,75 @@ export interface operations {
|
|
|
19825
19999
|
503: components["responses"]["Error503"];
|
|
19826
20000
|
};
|
|
19827
20001
|
};
|
|
20002
|
+
forms_list_trashed: {
|
|
20003
|
+
parameters: {
|
|
20004
|
+
query?: {
|
|
20005
|
+
/**
|
|
20006
|
+
* @description Maximum number of items to return, 1–100. Defaults to 20.
|
|
20007
|
+
* @example 20
|
|
20008
|
+
*/
|
|
20009
|
+
limit?: number;
|
|
20010
|
+
/** @description Opaque cursor from the previous page's nextCursor. Omit for the first page. */
|
|
20011
|
+
cursor?: string;
|
|
20012
|
+
};
|
|
20013
|
+
header?: never;
|
|
20014
|
+
path: {
|
|
20015
|
+
/** @description Website id. Get it from sites.list or from sites.create. */
|
|
20016
|
+
id: string;
|
|
20017
|
+
};
|
|
20018
|
+
cookie?: never;
|
|
20019
|
+
};
|
|
20020
|
+
requestBody?: never;
|
|
20021
|
+
responses: {
|
|
20022
|
+
/** @description OK */
|
|
20023
|
+
200: {
|
|
20024
|
+
headers: {
|
|
20025
|
+
[name: string]: unknown;
|
|
20026
|
+
};
|
|
20027
|
+
content: {
|
|
20028
|
+
/**
|
|
20029
|
+
* @example {
|
|
20030
|
+
* "data": [
|
|
20031
|
+
* {
|
|
20032
|
+
* "id": "form_example01",
|
|
20033
|
+
* "name": "Pre-order form",
|
|
20034
|
+
* "status": "ARCHIVED",
|
|
20035
|
+
* "submissionCount": 12,
|
|
20036
|
+
* "trashedAt": "2026-10-06T08:00:00.000Z",
|
|
20037
|
+
* "deleteAfter": "2026-12-17T08:00:00.000Z"
|
|
20038
|
+
* }
|
|
20039
|
+
* ],
|
|
20040
|
+
* "hasMore": false,
|
|
20041
|
+
* "nextCursor": null
|
|
20042
|
+
* }
|
|
20043
|
+
*/
|
|
20044
|
+
"application/json": {
|
|
20045
|
+
data: {
|
|
20046
|
+
id: string;
|
|
20047
|
+
name: string;
|
|
20048
|
+
/** @description The status the form returns to when restored (ACTIVE or ARCHIVED). While it is in the trash it accepts no submissions either way. */
|
|
20049
|
+
status: string;
|
|
20050
|
+
/** @description Non-spam submissions. They are kept while the form is in the trash and are readable again after forms.restore. */
|
|
20051
|
+
submissionCount: number;
|
|
20052
|
+
trashedAt: string;
|
|
20053
|
+
/** @description After this time the form and its submissions are permanently deleted. */
|
|
20054
|
+
deleteAfter: string;
|
|
20055
|
+
}[];
|
|
20056
|
+
/** @description True when another page exists; pass nextCursor to fetch it. */
|
|
20057
|
+
hasMore: boolean;
|
|
20058
|
+
/** @description Cursor for the next page, or null on the last page. */
|
|
20059
|
+
nextCursor: string | null;
|
|
20060
|
+
};
|
|
20061
|
+
};
|
|
20062
|
+
};
|
|
20063
|
+
400: components["responses"]["Error400"];
|
|
20064
|
+
401: components["responses"]["Error401"];
|
|
20065
|
+
403: components["responses"]["Error403"];
|
|
20066
|
+
429: components["responses"]["Error429"];
|
|
20067
|
+
500: components["responses"]["Error500"];
|
|
20068
|
+
503: components["responses"]["Error503"];
|
|
20069
|
+
};
|
|
20070
|
+
};
|
|
19828
20071
|
forms_get: {
|
|
19829
20072
|
parameters: {
|
|
19830
20073
|
query?: never;
|
|
@@ -19925,6 +20168,59 @@ export interface operations {
|
|
|
19925
20168
|
503: components["responses"]["Error503"];
|
|
19926
20169
|
};
|
|
19927
20170
|
};
|
|
20171
|
+
forms_delete: {
|
|
20172
|
+
parameters: {
|
|
20173
|
+
query?: never;
|
|
20174
|
+
header?: never;
|
|
20175
|
+
path: {
|
|
20176
|
+
/** @description Website id. Get it from sites.list or from sites.create. */
|
|
20177
|
+
id: string;
|
|
20178
|
+
/** @description Form id. Get it from forms.list. */
|
|
20179
|
+
formId: string;
|
|
20180
|
+
};
|
|
20181
|
+
cookie?: never;
|
|
20182
|
+
};
|
|
20183
|
+
requestBody?: never;
|
|
20184
|
+
responses: {
|
|
20185
|
+
/** @description OK */
|
|
20186
|
+
200: {
|
|
20187
|
+
headers: {
|
|
20188
|
+
[name: string]: unknown;
|
|
20189
|
+
};
|
|
20190
|
+
content: {
|
|
20191
|
+
/**
|
|
20192
|
+
* @example {
|
|
20193
|
+
* "id": "form_example01",
|
|
20194
|
+
* "name": "Pre-order form",
|
|
20195
|
+
* "status": "ARCHIVED",
|
|
20196
|
+
* "submissionCount": 12,
|
|
20197
|
+
* "trashedAt": "2026-10-06T08:00:00.000Z",
|
|
20198
|
+
* "deleteAfter": "2026-12-17T08:00:00.000Z"
|
|
20199
|
+
* }
|
|
20200
|
+
*/
|
|
20201
|
+
"application/json": {
|
|
20202
|
+
id: string;
|
|
20203
|
+
name: string;
|
|
20204
|
+
/** @description The status the form returns to when restored (ACTIVE or ARCHIVED). While it is in the trash it accepts no submissions either way. */
|
|
20205
|
+
status: string;
|
|
20206
|
+
/** @description Non-spam submissions. They are kept while the form is in the trash and are readable again after forms.restore. */
|
|
20207
|
+
submissionCount: number;
|
|
20208
|
+
trashedAt: string;
|
|
20209
|
+
/** @description After this time the form and its submissions are permanently deleted. */
|
|
20210
|
+
deleteAfter: string;
|
|
20211
|
+
};
|
|
20212
|
+
};
|
|
20213
|
+
};
|
|
20214
|
+
400: components["responses"]["Error400"];
|
|
20215
|
+
401: components["responses"]["Error401"];
|
|
20216
|
+
403: components["responses"]["Error403"];
|
|
20217
|
+
404: components["responses"]["Error404"];
|
|
20218
|
+
409: components["responses"]["Error409"];
|
|
20219
|
+
429: components["responses"]["Error429"];
|
|
20220
|
+
500: components["responses"]["Error500"];
|
|
20221
|
+
503: components["responses"]["Error503"];
|
|
20222
|
+
};
|
|
20223
|
+
};
|
|
19928
20224
|
forms_update: {
|
|
19929
20225
|
parameters: {
|
|
19930
20226
|
query?: never;
|
|
@@ -19954,7 +20250,7 @@ export interface operations {
|
|
|
19954
20250
|
fields?: {
|
|
19955
20251
|
[key: string]: unknown;
|
|
19956
20252
|
}[];
|
|
19957
|
-
/** @description Form settings. Keys: submitLabel, successMessage, redirectUrl (a path on this site or
|
|
20253
|
+
/** @description Form settings. Keys: submitLabel, successMessage, redirectUrl (where the visitor goes after a successful submit: a path on this site, or an https URL on any site, for example a LINE or WhatsApp chat link or a partner's booking page. It can carry {answers.<fieldId>} and {submissionId} in its path, query or fragment, never in the host; each is replaced with the percent-encoded answer text, and <fieldId> must be a question of this form that is not a file question, or one of its hidden fields), marketingConsent (off or checkbox; checkbox needs an email question), limitOnePerContact, replyKind (which confirmation email template the person who filled in the form gets: inquiry, booking, event, application, signup, feedback, general; default general), openAt, closeAt (ISO date-times), maxSubmissions, hiddenFields [{ id, label? }]. Not settable through the API: marketingConsent "submit" (subscribe on submit) and consentText (custom consent wording); the owner sets those in the console. The submission retention period is not part of settings and cannot be changed here. */
|
|
19958
20254
|
settings?: {
|
|
19959
20255
|
[key: string]: unknown;
|
|
19960
20256
|
};
|
|
@@ -20043,6 +20339,291 @@ export interface operations {
|
|
|
20043
20339
|
503: components["responses"]["Error503"];
|
|
20044
20340
|
};
|
|
20045
20341
|
};
|
|
20342
|
+
forms_pause: {
|
|
20343
|
+
parameters: {
|
|
20344
|
+
query?: never;
|
|
20345
|
+
header?: never;
|
|
20346
|
+
path: {
|
|
20347
|
+
/** @description Website id. Get it from sites.list or from sites.create. */
|
|
20348
|
+
id: string;
|
|
20349
|
+
/** @description Form id. Get it from forms.list. */
|
|
20350
|
+
formId: string;
|
|
20351
|
+
};
|
|
20352
|
+
cookie?: never;
|
|
20353
|
+
};
|
|
20354
|
+
requestBody?: never;
|
|
20355
|
+
responses: {
|
|
20356
|
+
/** @description OK */
|
|
20357
|
+
200: {
|
|
20358
|
+
headers: {
|
|
20359
|
+
[name: string]: unknown;
|
|
20360
|
+
};
|
|
20361
|
+
content: {
|
|
20362
|
+
/**
|
|
20363
|
+
* @example {
|
|
20364
|
+
* "id": "form_example01",
|
|
20365
|
+
* "name": "Pre-order form",
|
|
20366
|
+
* "description": "Leave your details and we'll confirm your order by email.",
|
|
20367
|
+
* "status": "ARCHIVED",
|
|
20368
|
+
* "availability": "closed",
|
|
20369
|
+
* "fields": [
|
|
20370
|
+
* {
|
|
20371
|
+
* "id": "name",
|
|
20372
|
+
* "type": "short_text",
|
|
20373
|
+
* "label": "Name",
|
|
20374
|
+
* "required": true,
|
|
20375
|
+
* "contactMapping": "name"
|
|
20376
|
+
* },
|
|
20377
|
+
* {
|
|
20378
|
+
* "id": "email",
|
|
20379
|
+
* "type": "email",
|
|
20380
|
+
* "label": "Email",
|
|
20381
|
+
* "required": true
|
|
20382
|
+
* },
|
|
20383
|
+
* {
|
|
20384
|
+
* "id": "message",
|
|
20385
|
+
* "type": "long_text",
|
|
20386
|
+
* "label": "Message",
|
|
20387
|
+
* "required": false
|
|
20388
|
+
* }
|
|
20389
|
+
* ],
|
|
20390
|
+
* "settings": {
|
|
20391
|
+
* "successMessage": "Thanks! We'll get back to you shortly.",
|
|
20392
|
+
* "marketingConsent": "checkbox",
|
|
20393
|
+
* "limitOnePerContact": false,
|
|
20394
|
+
* "replyKind": "inquiry",
|
|
20395
|
+
* "closeAt": "2026-12-31T15:59:00.000Z",
|
|
20396
|
+
* "maxSubmissions": 200
|
|
20397
|
+
* },
|
|
20398
|
+
* "replyEmailEnabled": true,
|
|
20399
|
+
* "submissionCount": 12,
|
|
20400
|
+
* "createdAt": "2026-08-12T03:20:00.000Z",
|
|
20401
|
+
* "updatedAt": "2026-10-01T02:30:00.000Z"
|
|
20402
|
+
* }
|
|
20403
|
+
*/
|
|
20404
|
+
"application/json": {
|
|
20405
|
+
id: string;
|
|
20406
|
+
name: string;
|
|
20407
|
+
description: string | null;
|
|
20408
|
+
status: string;
|
|
20409
|
+
/**
|
|
20410
|
+
* @description Whether visitors can submit right now: open; not_open (before the opening time); closed (paused or past the closing time); full (submission cap reached).
|
|
20411
|
+
* @enum {string}
|
|
20412
|
+
*/
|
|
20413
|
+
availability: "open" | "not_open" | "closed" | "full";
|
|
20414
|
+
/** @description Form field definitions (id, type, label, required, options, contactMapping...). New field types and keys can be added over time; ignore the ones you do not recognise. */
|
|
20415
|
+
fields: {
|
|
20416
|
+
[key: string]: unknown;
|
|
20417
|
+
}[];
|
|
20418
|
+
settings: {
|
|
20419
|
+
[key: string]: unknown;
|
|
20420
|
+
};
|
|
20421
|
+
replyEmailEnabled: boolean;
|
|
20422
|
+
submissionCount: number;
|
|
20423
|
+
createdAt: string;
|
|
20424
|
+
updatedAt: string;
|
|
20425
|
+
};
|
|
20426
|
+
};
|
|
20427
|
+
};
|
|
20428
|
+
400: components["responses"]["Error400"];
|
|
20429
|
+
401: components["responses"]["Error401"];
|
|
20430
|
+
403: components["responses"]["Error403"];
|
|
20431
|
+
404: components["responses"]["Error404"];
|
|
20432
|
+
429: components["responses"]["Error429"];
|
|
20433
|
+
500: components["responses"]["Error500"];
|
|
20434
|
+
503: components["responses"]["Error503"];
|
|
20435
|
+
};
|
|
20436
|
+
};
|
|
20437
|
+
forms_resume: {
|
|
20438
|
+
parameters: {
|
|
20439
|
+
query?: never;
|
|
20440
|
+
header?: never;
|
|
20441
|
+
path: {
|
|
20442
|
+
/** @description Website id. Get it from sites.list or from sites.create. */
|
|
20443
|
+
id: string;
|
|
20444
|
+
/** @description Form id. Get it from forms.list. */
|
|
20445
|
+
formId: string;
|
|
20446
|
+
};
|
|
20447
|
+
cookie?: never;
|
|
20448
|
+
};
|
|
20449
|
+
requestBody?: never;
|
|
20450
|
+
responses: {
|
|
20451
|
+
/** @description OK */
|
|
20452
|
+
200: {
|
|
20453
|
+
headers: {
|
|
20454
|
+
[name: string]: unknown;
|
|
20455
|
+
};
|
|
20456
|
+
content: {
|
|
20457
|
+
/**
|
|
20458
|
+
* @example {
|
|
20459
|
+
* "id": "form_example01",
|
|
20460
|
+
* "name": "Pre-order form",
|
|
20461
|
+
* "description": "Leave your details and we'll confirm your order by email.",
|
|
20462
|
+
* "status": "ACTIVE",
|
|
20463
|
+
* "availability": "open",
|
|
20464
|
+
* "fields": [
|
|
20465
|
+
* {
|
|
20466
|
+
* "id": "name",
|
|
20467
|
+
* "type": "short_text",
|
|
20468
|
+
* "label": "Name",
|
|
20469
|
+
* "required": true,
|
|
20470
|
+
* "contactMapping": "name"
|
|
20471
|
+
* },
|
|
20472
|
+
* {
|
|
20473
|
+
* "id": "email",
|
|
20474
|
+
* "type": "email",
|
|
20475
|
+
* "label": "Email",
|
|
20476
|
+
* "required": true
|
|
20477
|
+
* },
|
|
20478
|
+
* {
|
|
20479
|
+
* "id": "message",
|
|
20480
|
+
* "type": "long_text",
|
|
20481
|
+
* "label": "Message",
|
|
20482
|
+
* "required": false
|
|
20483
|
+
* }
|
|
20484
|
+
* ],
|
|
20485
|
+
* "settings": {
|
|
20486
|
+
* "successMessage": "Thanks! We'll get back to you shortly.",
|
|
20487
|
+
* "marketingConsent": "checkbox",
|
|
20488
|
+
* "limitOnePerContact": false,
|
|
20489
|
+
* "replyKind": "inquiry",
|
|
20490
|
+
* "closeAt": "2026-12-31T15:59:00.000Z",
|
|
20491
|
+
* "maxSubmissions": 200
|
|
20492
|
+
* },
|
|
20493
|
+
* "replyEmailEnabled": true,
|
|
20494
|
+
* "submissionCount": 12,
|
|
20495
|
+
* "createdAt": "2026-08-12T03:20:00.000Z",
|
|
20496
|
+
* "updatedAt": "2026-10-01T02:30:00.000Z"
|
|
20497
|
+
* }
|
|
20498
|
+
*/
|
|
20499
|
+
"application/json": {
|
|
20500
|
+
id: string;
|
|
20501
|
+
name: string;
|
|
20502
|
+
description: string | null;
|
|
20503
|
+
status: string;
|
|
20504
|
+
/**
|
|
20505
|
+
* @description Whether visitors can submit right now: open; not_open (before the opening time); closed (paused or past the closing time); full (submission cap reached).
|
|
20506
|
+
* @enum {string}
|
|
20507
|
+
*/
|
|
20508
|
+
availability: "open" | "not_open" | "closed" | "full";
|
|
20509
|
+
/** @description Form field definitions (id, type, label, required, options, contactMapping...). New field types and keys can be added over time; ignore the ones you do not recognise. */
|
|
20510
|
+
fields: {
|
|
20511
|
+
[key: string]: unknown;
|
|
20512
|
+
}[];
|
|
20513
|
+
settings: {
|
|
20514
|
+
[key: string]: unknown;
|
|
20515
|
+
};
|
|
20516
|
+
replyEmailEnabled: boolean;
|
|
20517
|
+
submissionCount: number;
|
|
20518
|
+
createdAt: string;
|
|
20519
|
+
updatedAt: string;
|
|
20520
|
+
};
|
|
20521
|
+
};
|
|
20522
|
+
};
|
|
20523
|
+
400: components["responses"]["Error400"];
|
|
20524
|
+
401: components["responses"]["Error401"];
|
|
20525
|
+
403: components["responses"]["Error403"];
|
|
20526
|
+
404: components["responses"]["Error404"];
|
|
20527
|
+
429: components["responses"]["Error429"];
|
|
20528
|
+
500: components["responses"]["Error500"];
|
|
20529
|
+
503: components["responses"]["Error503"];
|
|
20530
|
+
};
|
|
20531
|
+
};
|
|
20532
|
+
forms_restore: {
|
|
20533
|
+
parameters: {
|
|
20534
|
+
query?: never;
|
|
20535
|
+
header?: never;
|
|
20536
|
+
path: {
|
|
20537
|
+
/** @description Website id. Get it from sites.list or from sites.create. */
|
|
20538
|
+
id: string;
|
|
20539
|
+
/** @description Form id. Get it from forms.list. */
|
|
20540
|
+
formId: string;
|
|
20541
|
+
};
|
|
20542
|
+
cookie?: never;
|
|
20543
|
+
};
|
|
20544
|
+
requestBody?: never;
|
|
20545
|
+
responses: {
|
|
20546
|
+
/** @description OK */
|
|
20547
|
+
200: {
|
|
20548
|
+
headers: {
|
|
20549
|
+
[name: string]: unknown;
|
|
20550
|
+
};
|
|
20551
|
+
content: {
|
|
20552
|
+
/**
|
|
20553
|
+
* @example {
|
|
20554
|
+
* "id": "form_example01",
|
|
20555
|
+
* "name": "Pre-order form",
|
|
20556
|
+
* "description": "Leave your details and we'll confirm your order by email.",
|
|
20557
|
+
* "status": "ARCHIVED",
|
|
20558
|
+
* "availability": "closed",
|
|
20559
|
+
* "fields": [
|
|
20560
|
+
* {
|
|
20561
|
+
* "id": "name",
|
|
20562
|
+
* "type": "short_text",
|
|
20563
|
+
* "label": "Name",
|
|
20564
|
+
* "required": true,
|
|
20565
|
+
* "contactMapping": "name"
|
|
20566
|
+
* },
|
|
20567
|
+
* {
|
|
20568
|
+
* "id": "email",
|
|
20569
|
+
* "type": "email",
|
|
20570
|
+
* "label": "Email",
|
|
20571
|
+
* "required": true
|
|
20572
|
+
* },
|
|
20573
|
+
* {
|
|
20574
|
+
* "id": "message",
|
|
20575
|
+
* "type": "long_text",
|
|
20576
|
+
* "label": "Message",
|
|
20577
|
+
* "required": false
|
|
20578
|
+
* }
|
|
20579
|
+
* ],
|
|
20580
|
+
* "settings": {
|
|
20581
|
+
* "successMessage": "Thanks! We'll get back to you shortly.",
|
|
20582
|
+
* "marketingConsent": "checkbox",
|
|
20583
|
+
* "limitOnePerContact": false,
|
|
20584
|
+
* "replyKind": "inquiry",
|
|
20585
|
+
* "closeAt": "2026-12-31T15:59:00.000Z",
|
|
20586
|
+
* "maxSubmissions": 200
|
|
20587
|
+
* },
|
|
20588
|
+
* "replyEmailEnabled": true,
|
|
20589
|
+
* "submissionCount": 12,
|
|
20590
|
+
* "createdAt": "2026-08-12T03:20:00.000Z",
|
|
20591
|
+
* "updatedAt": "2026-10-01T02:30:00.000Z"
|
|
20592
|
+
* }
|
|
20593
|
+
*/
|
|
20594
|
+
"application/json": {
|
|
20595
|
+
id: string;
|
|
20596
|
+
name: string;
|
|
20597
|
+
description: string | null;
|
|
20598
|
+
status: string;
|
|
20599
|
+
/**
|
|
20600
|
+
* @description Whether visitors can submit right now: open; not_open (before the opening time); closed (paused or past the closing time); full (submission cap reached).
|
|
20601
|
+
* @enum {string}
|
|
20602
|
+
*/
|
|
20603
|
+
availability: "open" | "not_open" | "closed" | "full";
|
|
20604
|
+
/** @description Form field definitions (id, type, label, required, options, contactMapping...). New field types and keys can be added over time; ignore the ones you do not recognise. */
|
|
20605
|
+
fields: {
|
|
20606
|
+
[key: string]: unknown;
|
|
20607
|
+
}[];
|
|
20608
|
+
settings: {
|
|
20609
|
+
[key: string]: unknown;
|
|
20610
|
+
};
|
|
20611
|
+
replyEmailEnabled: boolean;
|
|
20612
|
+
submissionCount: number;
|
|
20613
|
+
createdAt: string;
|
|
20614
|
+
updatedAt: string;
|
|
20615
|
+
};
|
|
20616
|
+
};
|
|
20617
|
+
};
|
|
20618
|
+
400: components["responses"]["Error400"];
|
|
20619
|
+
401: components["responses"]["Error401"];
|
|
20620
|
+
403: components["responses"]["Error403"];
|
|
20621
|
+
404: components["responses"]["Error404"];
|
|
20622
|
+
429: components["responses"]["Error429"];
|
|
20623
|
+
500: components["responses"]["Error500"];
|
|
20624
|
+
503: components["responses"]["Error503"];
|
|
20625
|
+
};
|
|
20626
|
+
};
|
|
20046
20627
|
submissions_list: {
|
|
20047
20628
|
parameters: {
|
|
20048
20629
|
query?: {
|
|
@@ -27796,7 +28377,7 @@ export interface operations {
|
|
|
27796
28377
|
pageCount: number | null;
|
|
27797
28378
|
/** @description Where it was uploaded (page module, blog, product, media library…). */
|
|
27798
28379
|
source: string;
|
|
27799
|
-
/** @description Used by site content, products, deliverables, emails or a published snapshot. */
|
|
28380
|
+
/** @description Used by site content, posts, collection items, products, deliverables, emails or a published snapshot. A collection item counts when an image, file or gallery field holds the asset id, or when any field (json and rich text included) holds `asset:<assetId>` or the file's URL. */
|
|
27800
28381
|
inUse: boolean;
|
|
27801
28382
|
/** @description Default focal point of an image (0-1 on the original): image fields without their own framing crop around it. null when unset or centered. */
|
|
27802
28383
|
focus: {
|
|
@@ -27964,7 +28545,7 @@ export interface operations {
|
|
|
27964
28545
|
pageCount: number | null;
|
|
27965
28546
|
/** @description Where it was uploaded (page module, blog, product, media library…). */
|
|
27966
28547
|
source: string;
|
|
27967
|
-
/** @description Used by site content, products, deliverables, emails or a published snapshot. */
|
|
28548
|
+
/** @description Used by site content, posts, collection items, products, deliverables, emails or a published snapshot. A collection item counts when an image, file or gallery field holds the asset id, or when any field (json and rich text included) holds `asset:<assetId>` or the file's URL. */
|
|
27968
28549
|
inUse: boolean;
|
|
27969
28550
|
/** @description Default focal point of an image (0-1 on the original): image fields without their own framing crop around it. null when unset or centered. */
|
|
27970
28551
|
focus: {
|
|
@@ -32974,7 +33555,7 @@ export interface operations {
|
|
|
32974
33555
|
pageCount: number | null;
|
|
32975
33556
|
/** @description Where it was uploaded (page module, blog, product, media library…). */
|
|
32976
33557
|
source: string;
|
|
32977
|
-
/** @description Used by site content, products, deliverables, emails or a published snapshot. */
|
|
33558
|
+
/** @description Used by site content, posts, collection items, products, deliverables, emails or a published snapshot. A collection item counts when an image, file or gallery field holds the asset id, or when any field (json and rich text included) holds `asset:<assetId>` or the file's URL. */
|
|
32978
33559
|
inUse: boolean;
|
|
32979
33560
|
/** @description Default focal point of an image (0-1 on the original): image fields without their own framing crop around it. null when unset or centered. */
|
|
32980
33561
|
focus: {
|
|
@@ -33150,7 +33731,7 @@ export interface operations {
|
|
|
33150
33731
|
pageCount: number | null;
|
|
33151
33732
|
/** @description Where it was uploaded (page module, blog, product, media library…). */
|
|
33152
33733
|
source: string;
|
|
33153
|
-
/** @description Used by site content, products, deliverables, emails or a published snapshot. */
|
|
33734
|
+
/** @description Used by site content, posts, collection items, products, deliverables, emails or a published snapshot. A collection item counts when an image, file or gallery field holds the asset id, or when any field (json and rich text included) holds `asset:<assetId>` or the file's URL. */
|
|
33154
33735
|
inUse: boolean;
|
|
33155
33736
|
/** @description Default focal point of an image (0-1 on the original): image fields without their own framing crop around it. null when unset or centered. */
|
|
33156
33737
|
focus: {
|
|
@@ -33379,7 +33960,7 @@ export interface operations {
|
|
|
33379
33960
|
pageCount: number | null;
|
|
33380
33961
|
/** @description Where it was uploaded (page module, blog, product, media library…). */
|
|
33381
33962
|
source: string;
|
|
33382
|
-
/** @description Used by site content, products, deliverables, emails or a published snapshot. */
|
|
33963
|
+
/** @description Used by site content, posts, collection items, products, deliverables, emails or a published snapshot. A collection item counts when an image, file or gallery field holds the asset id, or when any field (json and rich text included) holds `asset:<assetId>` or the file's URL. */
|
|
33383
33964
|
inUse: boolean;
|
|
33384
33965
|
/** @description Default focal point of an image (0-1 on the original): image fields without their own framing crop around it. null when unset or centered. */
|
|
33385
33966
|
focus: {
|
|
@@ -33635,7 +34216,7 @@ export interface operations {
|
|
|
33635
34216
|
pageCount: number | null;
|
|
33636
34217
|
/** @description Where it was uploaded (page module, blog, product, media library…). */
|
|
33637
34218
|
source: string;
|
|
33638
|
-
/** @description Used by site content, products, deliverables, emails or a published snapshot. */
|
|
34219
|
+
/** @description Used by site content, posts, collection items, products, deliverables, emails or a published snapshot. A collection item counts when an image, file or gallery field holds the asset id, or when any field (json and rich text included) holds `asset:<assetId>` or the file's URL. */
|
|
33639
34220
|
inUse: boolean;
|
|
33640
34221
|
/** @description Default focal point of an image (0-1 on the original): image fields without their own framing crop around it. null when unset or centered. */
|
|
33641
34222
|
focus: {
|
|
@@ -33879,7 +34460,7 @@ export interface operations {
|
|
|
33879
34460
|
pageCount: number | null;
|
|
33880
34461
|
/** @description Where it was uploaded (page module, blog, product, media library…). */
|
|
33881
34462
|
source: string;
|
|
33882
|
-
/** @description Used by site content, products, deliverables, emails or a published snapshot. */
|
|
34463
|
+
/** @description Used by site content, posts, collection items, products, deliverables, emails or a published snapshot. A collection item counts when an image, file or gallery field holds the asset id, or when any field (json and rich text included) holds `asset:<assetId>` or the file's URL. */
|
|
33883
34464
|
inUse: boolean;
|
|
33884
34465
|
/** @description Default focal point of an image (0-1 on the original): image fields without their own framing crop around it. null when unset or centered. */
|
|
33885
34466
|
focus: {
|
|
@@ -34116,7 +34697,7 @@ export interface operations {
|
|
|
34116
34697
|
pageCount: number | null;
|
|
34117
34698
|
/** @description Where it was uploaded (page module, blog, product, media library…). */
|
|
34118
34699
|
source: string;
|
|
34119
|
-
/** @description Used by site content, products, deliverables, emails or a published snapshot. */
|
|
34700
|
+
/** @description Used by site content, posts, collection items, products, deliverables, emails or a published snapshot. A collection item counts when an image, file or gallery field holds the asset id, or when any field (json and rich text included) holds `asset:<assetId>` or the file's URL. */
|
|
34120
34701
|
inUse: boolean;
|
|
34121
34702
|
/** @description Default focal point of an image (0-1 on the original): image fields without their own framing crop around it. null when unset or centered. */
|
|
34122
34703
|
focus: {
|
|
@@ -34362,7 +34943,7 @@ export interface operations {
|
|
|
34362
34943
|
pageCount: number | null;
|
|
34363
34944
|
/** @description Where it was uploaded (page module, blog, product, media library…). */
|
|
34364
34945
|
source: string;
|
|
34365
|
-
/** @description Used by site content, products, deliverables, emails or a published snapshot. */
|
|
34946
|
+
/** @description Used by site content, posts, collection items, products, deliverables, emails or a published snapshot. A collection item counts when an image, file or gallery field holds the asset id, or when any field (json and rich text included) holds `asset:<assetId>` or the file's URL. */
|
|
34366
34947
|
inUse: boolean;
|
|
34367
34948
|
/** @description Default focal point of an image (0-1 on the original): image fields without their own framing crop around it. null when unset or centered. */
|
|
34368
34949
|
focus: {
|
|
@@ -34526,7 +35107,7 @@ export interface operations {
|
|
|
34526
35107
|
pageCount: number | null;
|
|
34527
35108
|
/** @description Where it was uploaded (page module, blog, product, media library…). */
|
|
34528
35109
|
source: string;
|
|
34529
|
-
/** @description Used by site content, products, deliverables, emails or a published snapshot. */
|
|
35110
|
+
/** @description Used by site content, posts, collection items, products, deliverables, emails or a published snapshot. A collection item counts when an image, file or gallery field holds the asset id, or when any field (json and rich text included) holds `asset:<assetId>` or the file's URL. */
|
|
34530
35111
|
inUse: boolean;
|
|
34531
35112
|
/** @description Default focal point of an image (0-1 on the original): image fields without their own framing crop around it. null when unset or centered. */
|
|
34532
35113
|
focus: {
|
|
@@ -35664,6 +36245,15 @@ export interface operations {
|
|
|
35664
36245
|
content: {
|
|
35665
36246
|
/**
|
|
35666
36247
|
* @example {
|
|
36248
|
+
* "registration": {
|
|
36249
|
+
* "state": "registered",
|
|
36250
|
+
* "via": "kanorio",
|
|
36251
|
+
* "step": null,
|
|
36252
|
+
* "reason": null,
|
|
36253
|
+
* "propertyUrl": "https://www.sunnybakery.example/",
|
|
36254
|
+
* "registeredAt": "2026-10-01T02:30:00.000Z"
|
|
36255
|
+
* },
|
|
36256
|
+
* "dataLink": "connected",
|
|
35667
36257
|
* "connected": true,
|
|
35668
36258
|
* "email": "owner@sunnybakery.example",
|
|
35669
36259
|
* "propertyUrl": "https://www.sunnybakery.example/",
|
|
@@ -35677,6 +36267,29 @@ export interface operations {
|
|
|
35677
36267
|
* }
|
|
35678
36268
|
*/
|
|
35679
36269
|
"application/json": {
|
|
36270
|
+
/** @description Registration with Google for the site's current address. */
|
|
36271
|
+
registration: {
|
|
36272
|
+
/**
|
|
36273
|
+
* @description The single answer to whether Google knows the site's current public address. registered: nothing to do. not_registered: the owner either connects a Google account under SEO › Settings or registers the site in Google Search Console and marks it there. in_progress: a Google account is connected and registration is running or waiting on `step`. blocked: a HEADLESS frontend does not serve /sitemap.xml yet. url_changed: the address changed, Google only knows a previous one, and no Google account is connected to register the new one. unavailable: there is no public address to register (see `reason`).
|
|
36274
|
+
* @enum {string}
|
|
36275
|
+
*/
|
|
36276
|
+
state: "unavailable" | "not_registered" | "in_progress" | "blocked" | "registered" | "url_changed";
|
|
36277
|
+
/** @description Who registered the current address: kanorio (through the connected Google account) or self (the owner registered it in Google Search Console and marked it in the dashboard). null unless state is registered. */
|
|
36278
|
+
via: ("kanorio" | "self") | null;
|
|
36279
|
+
/** @description Where an in-progress registration stands. verifying, dns_pending and retrying resolve on their own. ownership_required: the owner verifies the domain in Google Search Console. sitemap_not_reachable: fix /sitemap.xml on the frontend. reconnect_required: the owner reconnects the Google account. null unless state is in_progress. */
|
|
36280
|
+
step: ("verifying" | "ownership_required" | "sitemap_not_reachable" | "dns_pending" | "reconnect_required" | "retrying") | null;
|
|
36281
|
+
/** @description Why there is nothing to register. null unless state is unavailable. */
|
|
36282
|
+
reason: ("not_published" | "no_frontend_url" | "service_closed" | "indexing_off") | null;
|
|
36283
|
+
/** @description The site's current public address in Search Console URL-prefix form. */
|
|
36284
|
+
propertyUrl: string | null;
|
|
36285
|
+
/** @description ISO time the current address was registered. null unless state is registered. */
|
|
36286
|
+
registeredAt: string | null;
|
|
36287
|
+
};
|
|
36288
|
+
/**
|
|
36289
|
+
* @description Whether a Google account is connected without an authorization problem (not_connected, connected, reconnect_required). Independent of registration.state: a site its owner registered has registration.state registered and dataLink not_connected, and that is complete. connected does not guarantee fresh data: when lastFailureCode is set (for example after switching to a Google account that does not own the domain), search performance and index status stop updating until the owner fixes the step it names.
|
|
36290
|
+
* @enum {string}
|
|
36291
|
+
*/
|
|
36292
|
+
dataLink: "not_connected" | "connected" | "reconnect_required";
|
|
35680
36293
|
/** @description A Google account is connected (refresh token present). */
|
|
35681
36294
|
connected: boolean;
|
|
35682
36295
|
/** @description Connected Google account email. */
|
|
@@ -35958,10 +36571,10 @@ export interface operations {
|
|
|
35958
36571
|
*/
|
|
35959
36572
|
status?: "draft" | "published" | "changed";
|
|
35960
36573
|
/**
|
|
35961
|
-
* @description Set when the system recorded this revision automatically
|
|
36574
|
+
* @description Set when the system recorded this revision automatically: beforeDelete right before the item was moved to the trash, scheduled when a scheduled publish froze the content to go live.
|
|
35962
36575
|
* @enum {string}
|
|
35963
36576
|
*/
|
|
35964
|
-
backup?: "beforeDelete";
|
|
36577
|
+
backup?: "beforeDelete" | "scheduled";
|
|
35965
36578
|
} | null;
|
|
35966
36579
|
label: string | null;
|
|
35967
36580
|
actor: {
|
|
@@ -35991,6 +36604,79 @@ export interface operations {
|
|
|
35991
36604
|
503: components["responses"]["Error503"];
|
|
35992
36605
|
};
|
|
35993
36606
|
};
|
|
36607
|
+
revisions_create: {
|
|
36608
|
+
parameters: {
|
|
36609
|
+
query?: never;
|
|
36610
|
+
header?: {
|
|
36611
|
+
/** @description Client-chosen key (1-200 chars). Retrying with the same key and the same body returns the original result; the same key with a different body is rejected with IDEMPOTENCY_CONFLICT (409). Keys expire after 24 hours. */
|
|
36612
|
+
"Idempotency-Key"?: string;
|
|
36613
|
+
};
|
|
36614
|
+
path: {
|
|
36615
|
+
/** @description Website id. Get it from sites.list or from sites.create. */
|
|
36616
|
+
id: string;
|
|
36617
|
+
};
|
|
36618
|
+
cookie?: never;
|
|
36619
|
+
};
|
|
36620
|
+
requestBody: {
|
|
36621
|
+
content: {
|
|
36622
|
+
/**
|
|
36623
|
+
* @example {
|
|
36624
|
+
* "subject": "WEBSITE",
|
|
36625
|
+
* "label": "Before the autumn relaunch"
|
|
36626
|
+
* }
|
|
36627
|
+
*/
|
|
36628
|
+
"application/json": {
|
|
36629
|
+
/**
|
|
36630
|
+
* @description Defaults to WEBSITE.
|
|
36631
|
+
* @enum {string}
|
|
36632
|
+
*/
|
|
36633
|
+
subject?: "WEBSITE" | "BLOG_POST" | "CONTENT_ITEM";
|
|
36634
|
+
/** @description Required unless subject is WEBSITE (pass postId for BLOG_POST, itemId for CONTENT_ITEM); defaults to websiteId for WEBSITE. */
|
|
36635
|
+
subjectId?: string;
|
|
36636
|
+
/** @description The name people will see in the version history. */
|
|
36637
|
+
label: string;
|
|
36638
|
+
};
|
|
36639
|
+
};
|
|
36640
|
+
};
|
|
36641
|
+
responses: {
|
|
36642
|
+
/** @description OK */
|
|
36643
|
+
200: {
|
|
36644
|
+
headers: {
|
|
36645
|
+
[name: string]: unknown;
|
|
36646
|
+
};
|
|
36647
|
+
content: {
|
|
36648
|
+
/**
|
|
36649
|
+
* @example {
|
|
36650
|
+
* "revisionId": "rev_example01",
|
|
36651
|
+
* "subject": "WEBSITE",
|
|
36652
|
+
* "subjectId": "ws_example123",
|
|
36653
|
+
* "label": "Before the autumn relaunch"
|
|
36654
|
+
* }
|
|
36655
|
+
*/
|
|
36656
|
+
"application/json": {
|
|
36657
|
+
revisionId: string;
|
|
36658
|
+
/**
|
|
36659
|
+
* @description Subject type: WEBSITE for site-wide draft and page sections, BLOG_POST for a blog article, CONTENT_ITEM for a custom collection item.
|
|
36660
|
+
* @enum {string}
|
|
36661
|
+
*/
|
|
36662
|
+
subject: "WEBSITE" | "BLOG_POST" | "CONTENT_ITEM";
|
|
36663
|
+
subjectId: string;
|
|
36664
|
+
label: string;
|
|
36665
|
+
/** @description CONTENT_ITEM only: the collection this item belongs to. */
|
|
36666
|
+
collectionKey?: string;
|
|
36667
|
+
};
|
|
36668
|
+
};
|
|
36669
|
+
};
|
|
36670
|
+
400: components["responses"]["Error400"];
|
|
36671
|
+
401: components["responses"]["Error401"];
|
|
36672
|
+
403: components["responses"]["Error403"];
|
|
36673
|
+
404: components["responses"]["Error404"];
|
|
36674
|
+
422: components["responses"]["Error422"];
|
|
36675
|
+
429: components["responses"]["Error429"];
|
|
36676
|
+
500: components["responses"]["Error500"];
|
|
36677
|
+
503: components["responses"]["Error503"];
|
|
36678
|
+
};
|
|
36679
|
+
};
|
|
35994
36680
|
revisions_get: {
|
|
35995
36681
|
parameters: {
|
|
35996
36682
|
query?: never;
|
|
@@ -36095,10 +36781,10 @@ export interface operations {
|
|
|
36095
36781
|
*/
|
|
36096
36782
|
status?: "draft" | "published" | "changed";
|
|
36097
36783
|
/**
|
|
36098
|
-
* @description Set when the system recorded this revision automatically
|
|
36784
|
+
* @description Set when the system recorded this revision automatically: beforeDelete right before the item was moved to the trash, scheduled when a scheduled publish froze the content to go live.
|
|
36099
36785
|
* @enum {string}
|
|
36100
36786
|
*/
|
|
36101
|
-
backup?: "beforeDelete";
|
|
36787
|
+
backup?: "beforeDelete" | "scheduled";
|
|
36102
36788
|
} | null;
|
|
36103
36789
|
label: string | null;
|
|
36104
36790
|
actor: {
|
|
@@ -36172,7 +36858,7 @@ export interface operations {
|
|
|
36172
36858
|
pageCount: number | null;
|
|
36173
36859
|
/** @description Where it was uploaded (page module, blog, product, media library…). */
|
|
36174
36860
|
source: string;
|
|
36175
|
-
/** @description Used by site content, products, deliverables, emails or a published snapshot. */
|
|
36861
|
+
/** @description Used by site content, posts, collection items, products, deliverables, emails or a published snapshot. A collection item counts when an image, file or gallery field holds the asset id, or when any field (json and rich text included) holds `asset:<assetId>` or the file's URL. */
|
|
36176
36862
|
inUse: boolean;
|
|
36177
36863
|
/** @description Default focal point of an image (0-1 on the original): image fields without their own framing crop around it. null when unset or centered. */
|
|
36178
36864
|
focus: {
|
|
@@ -37977,6 +38663,12 @@ export interface operations {
|
|
|
37977
38663
|
content: {
|
|
37978
38664
|
/**
|
|
37979
38665
|
* @example {
|
|
38666
|
+
* "principal": {
|
|
38667
|
+
* "kind": "USER",
|
|
38668
|
+
* "id": "usr_example01",
|
|
38669
|
+
* "name": null
|
|
38670
|
+
* },
|
|
38671
|
+
* "credentialKind": "PAT",
|
|
37980
38672
|
* "userId": "usr_example01",
|
|
37981
38673
|
* "tokenId": "tok_example01",
|
|
37982
38674
|
* "channel": "mcp",
|
|
@@ -37997,8 +38689,25 @@ export interface operations {
|
|
|
37997
38689
|
* }
|
|
37998
38690
|
*/
|
|
37999
38691
|
"application/json": {
|
|
38000
|
-
/** @description
|
|
38001
|
-
|
|
38692
|
+
/** @description Who this credential acts as. */
|
|
38693
|
+
principal: {
|
|
38694
|
+
/**
|
|
38695
|
+
* @description USER: a personal access token or an OAuth connection acting as a person. SERVICE_ACCOUNT: a service account token acting as the website itself.
|
|
38696
|
+
* @enum {string}
|
|
38697
|
+
*/
|
|
38698
|
+
kind: "USER" | "SERVICE_ACCOUNT";
|
|
38699
|
+
/** @description User id, or service account id. */
|
|
38700
|
+
id: string;
|
|
38701
|
+
/** @description Service account name; null for a user. */
|
|
38702
|
+
name: string | null;
|
|
38703
|
+
};
|
|
38704
|
+
/**
|
|
38705
|
+
* @description Kind of credential: personal access token, OAuth access token, or service account token.
|
|
38706
|
+
* @enum {string}
|
|
38707
|
+
*/
|
|
38708
|
+
credentialKind: "PAT" | "OAUTH" | "SERVICE_TOKEN";
|
|
38709
|
+
/** @description Authenticated user id; null for a service account token (use principal). */
|
|
38710
|
+
userId: string | null;
|
|
38002
38711
|
/** @description Current token id. */
|
|
38003
38712
|
tokenId: string;
|
|
38004
38713
|
/** @description Request channel (mcp or api). */
|
|
@@ -38016,10 +38725,10 @@ export interface operations {
|
|
|
38016
38725
|
/** @description Capability name. */
|
|
38017
38726
|
name: string;
|
|
38018
38727
|
/**
|
|
38019
|
-
* @description Why the capability is
|
|
38728
|
+
* @description Why the capability cannot be called: the token lacks requiredScope, the feature is off on this deployment, or this kind of principal may not call it (a service account calling an operation that needs a person's token).
|
|
38020
38729
|
* @enum {string}
|
|
38021
38730
|
*/
|
|
38022
|
-
reason: "missing_scope" | "feature_disabled";
|
|
38731
|
+
reason: "missing_scope" | "feature_disabled" | "principal_not_allowed";
|
|
38023
38732
|
/** @description Scope needed to unlock this capability. */
|
|
38024
38733
|
requiredScope: string | null;
|
|
38025
38734
|
}[];
|
|
@@ -38027,7 +38736,7 @@ export interface operations {
|
|
|
38027
38736
|
site?: {
|
|
38028
38737
|
websiteId: string;
|
|
38029
38738
|
/**
|
|
38030
|
-
* @description Your team role kind on this website.
|
|
38739
|
+
* @description Your team role kind on this website; custom for a service account (its permissions are the ones it was granted).
|
|
38031
38740
|
* @enum {string}
|
|
38032
38741
|
*/
|
|
38033
38742
|
role: "owner" | "admin" | "custom";
|
|
@@ -38132,7 +38841,7 @@ export interface operations {
|
|
|
38132
38841
|
systemHost: string | null;
|
|
38133
38842
|
externalStorefrontUrl: string | null;
|
|
38134
38843
|
}[];
|
|
38135
|
-
/** @description false when this token is restricted to specific websites; sites.create then fails with TOKEN_WEBSITE_SCOPED
|
|
38844
|
+
/** @description false when this token is restricted to specific websites; sites.create then fails with TOKEN_WEBSITE_SCOPED. The user either creates the site in the backoffice, or switches this connection to all websites under Account settings > API access (no reconnection needed); see guidance. */
|
|
38136
38845
|
tokenCanCreateSites: boolean;
|
|
38137
38846
|
/**
|
|
38138
38847
|
* @description Where the account is on the path to a custom-frontend site.
|