@kanorio/sdk 1.1.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.
@@ -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 consumes the owner's AI credits and daily site-creation quota. 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).
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;
@@ -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;
@@ -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
- delete?: never;
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;
@@ -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). Revisions are retained for 30 days and coalesced within 10-minute autosave windows. Optionally pass pageId when listing WEBSITE revisions to filter to edits that touched that page. Newest first. Errors: FORBIDDEN, INVALID_CURSOR.
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
- post?: never;
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 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. Errors: UNAUTHORIZED, FORBIDDEN (websiteId given but the credential has no access to that website).
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;
@@ -3792,9 +3880,13 @@ export interface components {
3792
3880
  * @example {
3793
3881
  * "error": {
3794
3882
  * "code": "FORBIDDEN",
3795
- * "message": "This token lacks the \"content:edit\" scope.",
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
  * }
@@ -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: {
@@ -5740,7 +5832,7 @@ export interface operations {
5740
5832
  pageCount: number | null;
5741
5833
  /** @description Where it was uploaded (page module, blog, product, media library…). */
5742
5834
  source: string;
5743
- /** @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. */
5744
5836
  inUse: boolean;
5745
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. */
5746
5838
  focus: {
@@ -6038,7 +6130,7 @@ export interface operations {
6038
6130
  pageCount: number | null;
6039
6131
  /** @description Where it was uploaded (page module, blog, product, media library…). */
6040
6132
  source: string;
6041
- /** @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. */
6042
6134
  inUse: boolean;
6043
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. */
6044
6136
  focus: {
@@ -6450,7 +6542,7 @@ export interface operations {
6450
6542
  pageCount: number | null;
6451
6543
  /** @description Where it was uploaded (page module, blog, product, media library…). */
6452
6544
  source: string;
6453
- /** @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. */
6454
6546
  inUse: boolean;
6455
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. */
6456
6548
  focus: {
@@ -6773,7 +6865,7 @@ export interface operations {
6773
6865
  pageCount: number | null;
6774
6866
  /** @description Where it was uploaded (page module, blog, product, media library…). */
6775
6867
  source: string;
6776
- /** @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. */
6777
6869
  inUse: boolean;
6778
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. */
6779
6871
  focus: {
@@ -7737,7 +7829,7 @@ export interface operations {
7737
7829
  pageCount: number | null;
7738
7830
  /** @description Where it was uploaded (page module, blog, product, media library…). */
7739
7831
  source: string;
7740
- /** @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. */
7741
7833
  inUse: boolean;
7742
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. */
7743
7835
  focus: {
@@ -8267,7 +8359,7 @@ export interface operations {
8267
8359
  pageCount: number | null;
8268
8360
  /** @description Where it was uploaded (page module, blog, product, media library…). */
8269
8361
  source: string;
8270
- /** @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. */
8271
8363
  inUse: boolean;
8272
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. */
8273
8365
  focus: {
@@ -8689,7 +8781,7 @@ export interface operations {
8689
8781
  * "name": "Sunny"
8690
8782
  * }
8691
8783
  * ],
8692
- * "coverImage": "https://media.kanorio.com/example/sunny-bakery-hero.jpg",
8784
+ * "coverImageAssetId": "asset_example01",
8693
8785
  * "pageviews": 0
8694
8786
  * }
8695
8787
  * ],
@@ -8731,8 +8823,8 @@ export interface operations {
8731
8823
  slug: string;
8732
8824
  name: string;
8733
8825
  }[];
8734
- /** @description ogImage, else auto-generated OG image, else first image in content. */
8735
- coverImage: string | null;
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;
8736
8828
  pageviews?: number;
8737
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. */
8738
8830
  reviewRequestedAt: string | null;
@@ -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![Starter jar on the counter](asset:asset_example01)\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: {
@@ -9099,7 +9199,7 @@ export interface operations {
9099
9199
  /** @description When true, this post is excluded from visitor site search (independent of robotsIndex). */
9100
9200
  excludeFromSiteSearch: boolean;
9101
9201
  };
9102
- /** @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. */
9103
9203
  assets: {
9104
9204
  [key: string]: {
9105
9205
  /** @description Stable id of the file. Reference files by this id; it stays the same when media.replace uploads a new version. */
@@ -9156,7 +9256,7 @@ export interface operations {
9156
9256
  pageCount: number | null;
9157
9257
  /** @description Where it was uploaded (page module, blog, product, media library…). */
9158
9258
  source: string;
9159
- /** @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. */
9160
9260
  inUse: boolean;
9161
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. */
9162
9262
  focus: {
@@ -10065,6 +10165,8 @@ export interface operations {
10065
10165
  * "name": "Sunny"
10066
10166
  * }
10067
10167
  * ],
10168
+ * "coverImageAssetId": "asset_example01",
10169
+ * "coverImage": "https://media.kanorio.com/example/sunny-bakery-hero.jpg",
10068
10170
  * "contentMarkdown": "## 5 a.m. in the bakehouse\n\n![Starter jar on the counter](asset:asset_example01)\n\nDiscard half the starter, then fold in fresh flour and warm water...",
10069
10171
  * "segments": [
10070
10172
  * {
@@ -10164,12 +10266,16 @@ export interface operations {
10164
10266
  slug: string;
10165
10267
  name: string;
10166
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;
10167
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. */
10168
10272
  reviewRequestedAt: string | null;
10169
10273
  /** @description Who last requested review; kept after a rejection so posts.request_review can be called again by the same person. */
10170
10274
  reviewRequestedByUserId: string | null;
10171
10275
  /** @description Reason from the last posts.reject_review call; cleared on the next request or successful publish. */
10172
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;
10173
10279
  contentMarkdown: string;
10174
10280
  /** @description Structured content blocks (markdown, cta, faq, gallery, toggle, embed, audio, pdf, file) parsed from contentMarkdown. */
10175
10281
  segments: {
@@ -10242,7 +10348,7 @@ export interface operations {
10242
10348
  /** @description When true, this post is excluded from visitor site search (independent of robotsIndex). */
10243
10349
  excludeFromSiteSearch: boolean;
10244
10350
  };
10245
- /** @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. */
10246
10352
  assets: {
10247
10353
  [key: string]: {
10248
10354
  /** @description Stable id of the file. Reference files by this id; it stays the same when media.replace uploads a new version. */
@@ -10299,7 +10405,7 @@ export interface operations {
10299
10405
  pageCount: number | null;
10300
10406
  /** @description Where it was uploaded (page module, blog, product, media library…). */
10301
10407
  source: string;
10302
- /** @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. */
10303
10409
  inUse: boolean;
10304
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. */
10305
10411
  focus: {
@@ -10423,6 +10529,8 @@ export interface operations {
10423
10529
  excludeFromSiteSearch?: boolean;
10424
10530
  /** @description Share image: assetId of an image in the media library. null removes it; without a share image one is generated automatically. */
10425
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;
10426
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. */
10427
10535
  ifUnmodifiedSince?: string;
10428
10536
  };
@@ -10476,6 +10584,8 @@ export interface operations {
10476
10584
  * "name": "Sunny"
10477
10585
  * }
10478
10586
  * ],
10587
+ * "coverImageAssetId": "asset_example01",
10588
+ * "coverImage": "https://media.kanorio.com/example/sunny-bakery-hero.jpg",
10479
10589
  * "contentMarkdown": "## 5 a.m. in the bakehouse\n\n![Starter jar on the counter](asset:asset_example01)\n\nDiscard half the starter, then fold in fresh flour and warm water...",
10480
10590
  * "segments": [
10481
10591
  * {
@@ -10575,12 +10685,16 @@ export interface operations {
10575
10685
  slug: string;
10576
10686
  name: string;
10577
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;
10578
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. */
10579
10691
  reviewRequestedAt: string | null;
10580
10692
  /** @description Who last requested review; kept after a rejection so posts.request_review can be called again by the same person. */
10581
10693
  reviewRequestedByUserId: string | null;
10582
10694
  /** @description Reason from the last posts.reject_review call; cleared on the next request or successful publish. */
10583
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;
10584
10698
  contentMarkdown: string;
10585
10699
  /** @description Structured content blocks (markdown, cta, faq, gallery, toggle, embed, audio, pdf, file) parsed from contentMarkdown. */
10586
10700
  segments: {
@@ -10653,7 +10767,7 @@ export interface operations {
10653
10767
  /** @description When true, this post is excluded from visitor site search (independent of robotsIndex). */
10654
10768
  excludeFromSiteSearch: boolean;
10655
10769
  };
10656
- /** @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. */
10657
10771
  assets: {
10658
10772
  [key: string]: {
10659
10773
  /** @description Stable id of the file. Reference files by this id; it stays the same when media.replace uploads a new version. */
@@ -10710,7 +10824,7 @@ export interface operations {
10710
10824
  pageCount: number | null;
10711
10825
  /** @description Where it was uploaded (page module, blog, product, media library…). */
10712
10826
  source: string;
10713
- /** @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. */
10714
10828
  inUse: boolean;
10715
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. */
10716
10830
  focus: {
@@ -10814,6 +10928,8 @@ export interface operations {
10814
10928
  * "name": "Sunny"
10815
10929
  * }
10816
10930
  * ],
10931
+ * "coverImageAssetId": "asset_example01",
10932
+ * "coverImage": "https://media.kanorio.com/example/sunny-bakery-hero.jpg",
10817
10933
  * "contentMarkdown": "## 5 a.m. in the bakehouse\n\n![Starter jar on the counter](asset:asset_example01)\n\nDiscard half the starter, then fold in fresh flour and warm water...",
10818
10934
  * "segments": [
10819
10935
  * {
@@ -10914,12 +11030,16 @@ export interface operations {
10914
11030
  slug: string;
10915
11031
  name: string;
10916
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;
10917
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. */
10918
11036
  reviewRequestedAt: string | null;
10919
11037
  /** @description Who last requested review; kept after a rejection so posts.request_review can be called again by the same person. */
10920
11038
  reviewRequestedByUserId: string | null;
10921
11039
  /** @description Reason from the last posts.reject_review call; cleared on the next request or successful publish. */
10922
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;
10923
11043
  contentMarkdown: string;
10924
11044
  /** @description Structured content blocks (markdown, cta, faq, gallery, toggle, embed, audio, pdf, file) parsed from contentMarkdown. */
10925
11045
  segments: {
@@ -10992,7 +11112,7 @@ export interface operations {
10992
11112
  /** @description When true, this post is excluded from visitor site search (independent of robotsIndex). */
10993
11113
  excludeFromSiteSearch: boolean;
10994
11114
  };
10995
- /** @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. */
10996
11116
  assets: {
10997
11117
  [key: string]: {
10998
11118
  /** @description Stable id of the file. Reference files by this id; it stays the same when media.replace uploads a new version. */
@@ -11049,7 +11169,7 @@ export interface operations {
11049
11169
  pageCount: number | null;
11050
11170
  /** @description Where it was uploaded (page module, blog, product, media library…). */
11051
11171
  source: string;
11052
- /** @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. */
11053
11173
  inUse: boolean;
11054
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. */
11055
11175
  focus: {
@@ -11145,6 +11265,8 @@ export interface operations {
11145
11265
  * "name": "Sunny"
11146
11266
  * }
11147
11267
  * ],
11268
+ * "coverImageAssetId": "asset_example01",
11269
+ * "coverImage": "https://media.kanorio.com/example/sunny-bakery-hero.jpg",
11148
11270
  * "contentMarkdown": "## 5 a.m. in the bakehouse\n\n![Starter jar on the counter](asset:asset_example01)\n\nDiscard half the starter, then fold in fresh flour and warm water...",
11149
11271
  * "segments": [
11150
11272
  * {
@@ -11244,12 +11366,16 @@ export interface operations {
11244
11366
  slug: string;
11245
11367
  name: string;
11246
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;
11247
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. */
11248
11372
  reviewRequestedAt: string | null;
11249
11373
  /** @description Who last requested review; kept after a rejection so posts.request_review can be called again by the same person. */
11250
11374
  reviewRequestedByUserId: string | null;
11251
11375
  /** @description Reason from the last posts.reject_review call; cleared on the next request or successful publish. */
11252
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;
11253
11379
  contentMarkdown: string;
11254
11380
  /** @description Structured content blocks (markdown, cta, faq, gallery, toggle, embed, audio, pdf, file) parsed from contentMarkdown. */
11255
11381
  segments: {
@@ -11322,7 +11448,7 @@ export interface operations {
11322
11448
  /** @description When true, this post is excluded from visitor site search (independent of robotsIndex). */
11323
11449
  excludeFromSiteSearch: boolean;
11324
11450
  };
11325
- /** @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. */
11326
11452
  assets: {
11327
11453
  [key: string]: {
11328
11454
  /** @description Stable id of the file. Reference files by this id; it stays the same when media.replace uploads a new version. */
@@ -11379,7 +11505,7 @@ export interface operations {
11379
11505
  pageCount: number | null;
11380
11506
  /** @description Where it was uploaded (page module, blog, product, media library…). */
11381
11507
  source: string;
11382
- /** @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. */
11383
11509
  inUse: boolean;
11384
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. */
11385
11511
  focus: {
@@ -11471,6 +11597,8 @@ export interface operations {
11471
11597
  * "name": "Sunny"
11472
11598
  * }
11473
11599
  * ],
11600
+ * "coverImageAssetId": "asset_example01",
11601
+ * "coverImage": "https://media.kanorio.com/example/sunny-bakery-hero.jpg",
11474
11602
  * "contentMarkdown": "## 5 a.m. in the bakehouse\n\n![Starter jar on the counter](asset:asset_example01)\n\nDiscard half the starter, then fold in fresh flour and warm water...",
11475
11603
  * "segments": [
11476
11604
  * {
@@ -11570,12 +11698,16 @@ export interface operations {
11570
11698
  slug: string;
11571
11699
  name: string;
11572
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;
11573
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. */
11574
11704
  reviewRequestedAt: string | null;
11575
11705
  /** @description Who last requested review; kept after a rejection so posts.request_review can be called again by the same person. */
11576
11706
  reviewRequestedByUserId: string | null;
11577
11707
  /** @description Reason from the last posts.reject_review call; cleared on the next request or successful publish. */
11578
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;
11579
11711
  contentMarkdown: string;
11580
11712
  /** @description Structured content blocks (markdown, cta, faq, gallery, toggle, embed, audio, pdf, file) parsed from contentMarkdown. */
11581
11713
  segments: {
@@ -11648,7 +11780,7 @@ export interface operations {
11648
11780
  /** @description When true, this post is excluded from visitor site search (independent of robotsIndex). */
11649
11781
  excludeFromSiteSearch: boolean;
11650
11782
  };
11651
- /** @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. */
11652
11784
  assets: {
11653
11785
  [key: string]: {
11654
11786
  /** @description Stable id of the file. Reference files by this id; it stays the same when media.replace uploads a new version. */
@@ -11705,7 +11837,7 @@ export interface operations {
11705
11837
  pageCount: number | null;
11706
11838
  /** @description Where it was uploaded (page module, blog, product, media library…). */
11707
11839
  source: string;
11708
- /** @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. */
11709
11841
  inUse: boolean;
11710
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. */
11711
11843
  focus: {
@@ -11808,6 +11940,8 @@ export interface operations {
11808
11940
  * "name": "Sunny"
11809
11941
  * }
11810
11942
  * ],
11943
+ * "coverImageAssetId": "asset_example01",
11944
+ * "coverImage": "https://media.kanorio.com/example/sunny-bakery-hero.jpg",
11811
11945
  * "contentMarkdown": "## 5 a.m. in the bakehouse\n\n![Starter jar on the counter](asset:asset_example01)\n\nDiscard half the starter, then fold in fresh flour and warm water...",
11812
11946
  * "segments": [
11813
11947
  * {
@@ -11907,12 +12041,16 @@ export interface operations {
11907
12041
  slug: string;
11908
12042
  name: string;
11909
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;
11910
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. */
11911
12047
  reviewRequestedAt: string | null;
11912
12048
  /** @description Who last requested review; kept after a rejection so posts.request_review can be called again by the same person. */
11913
12049
  reviewRequestedByUserId: string | null;
11914
12050
  /** @description Reason from the last posts.reject_review call; cleared on the next request or successful publish. */
11915
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;
11916
12054
  contentMarkdown: string;
11917
12055
  /** @description Structured content blocks (markdown, cta, faq, gallery, toggle, embed, audio, pdf, file) parsed from contentMarkdown. */
11918
12056
  segments: {
@@ -11985,7 +12123,7 @@ export interface operations {
11985
12123
  /** @description When true, this post is excluded from visitor site search (independent of robotsIndex). */
11986
12124
  excludeFromSiteSearch: boolean;
11987
12125
  };
11988
- /** @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. */
11989
12127
  assets: {
11990
12128
  [key: string]: {
11991
12129
  /** @description Stable id of the file. Reference files by this id; it stays the same when media.replace uploads a new version. */
@@ -12042,7 +12180,7 @@ export interface operations {
12042
12180
  pageCount: number | null;
12043
12181
  /** @description Where it was uploaded (page module, blog, product, media library…). */
12044
12182
  source: string;
12045
- /** @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. */
12046
12184
  inUse: boolean;
12047
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. */
12048
12186
  focus: {
@@ -12134,6 +12272,8 @@ export interface operations {
12134
12272
  * "name": "Sunny"
12135
12273
  * }
12136
12274
  * ],
12275
+ * "coverImageAssetId": "asset_example01",
12276
+ * "coverImage": "https://media.kanorio.com/example/sunny-bakery-hero.jpg",
12137
12277
  * "contentMarkdown": "## 5 a.m. in the bakehouse\n\n![Starter jar on the counter](asset:asset_example01)\n\nDiscard half the starter, then fold in fresh flour and warm water...",
12138
12278
  * "segments": [
12139
12279
  * {
@@ -12233,12 +12373,16 @@ export interface operations {
12233
12373
  slug: string;
12234
12374
  name: string;
12235
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;
12236
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. */
12237
12379
  reviewRequestedAt: string | null;
12238
12380
  /** @description Who last requested review; kept after a rejection so posts.request_review can be called again by the same person. */
12239
12381
  reviewRequestedByUserId: string | null;
12240
12382
  /** @description Reason from the last posts.reject_review call; cleared on the next request or successful publish. */
12241
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;
12242
12386
  contentMarkdown: string;
12243
12387
  /** @description Structured content blocks (markdown, cta, faq, gallery, toggle, embed, audio, pdf, file) parsed from contentMarkdown. */
12244
12388
  segments: {
@@ -12311,7 +12455,7 @@ export interface operations {
12311
12455
  /** @description When true, this post is excluded from visitor site search (independent of robotsIndex). */
12312
12456
  excludeFromSiteSearch: boolean;
12313
12457
  };
12314
- /** @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. */
12315
12459
  assets: {
12316
12460
  [key: string]: {
12317
12461
  /** @description Stable id of the file. Reference files by this id; it stays the same when media.replace uploads a new version. */
@@ -12368,7 +12512,7 @@ export interface operations {
12368
12512
  pageCount: number | null;
12369
12513
  /** @description Where it was uploaded (page module, blog, product, media library…). */
12370
12514
  source: string;
12371
- /** @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. */
12372
12516
  inUse: boolean;
12373
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. */
12374
12518
  focus: {
@@ -19736,7 +19880,7 @@ export interface operations {
19736
19880
  fields: {
19737
19881
  [key: string]: unknown;
19738
19882
  }[];
19739
- /** @description Form settings. Keys: submitLabel, successMessage, redirectUrl (a path on this site or a URL on one of its domains), marketingConsent (off or checkbox; checkbox needs an email question), limitOnePerContact, replyKind, 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. */
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. */
19740
19884
  settings?: {
19741
19885
  [key: string]: unknown;
19742
19886
  };
@@ -19855,6 +19999,75 @@ export interface operations {
19855
19999
  503: components["responses"]["Error503"];
19856
20000
  };
19857
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
+ };
19858
20071
  forms_get: {
19859
20072
  parameters: {
19860
20073
  query?: never;
@@ -19955,6 +20168,59 @@ export interface operations {
19955
20168
  503: components["responses"]["Error503"];
19956
20169
  };
19957
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
+ };
19958
20224
  forms_update: {
19959
20225
  parameters: {
19960
20226
  query?: never;
@@ -19984,7 +20250,7 @@ export interface operations {
19984
20250
  fields?: {
19985
20251
  [key: string]: unknown;
19986
20252
  }[];
19987
- /** @description Form settings. Keys: submitLabel, successMessage, redirectUrl (a path on this site or a URL on one of its domains), marketingConsent (off or checkbox; checkbox needs an email question), limitOnePerContact, replyKind, 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. */
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. */
19988
20254
  settings?: {
19989
20255
  [key: string]: unknown;
19990
20256
  };
@@ -20073,6 +20339,291 @@ export interface operations {
20073
20339
  503: components["responses"]["Error503"];
20074
20340
  };
20075
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
+ };
20076
20627
  submissions_list: {
20077
20628
  parameters: {
20078
20629
  query?: {
@@ -27826,7 +28377,7 @@ export interface operations {
27826
28377
  pageCount: number | null;
27827
28378
  /** @description Where it was uploaded (page module, blog, product, media library…). */
27828
28379
  source: string;
27829
- /** @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. */
27830
28381
  inUse: boolean;
27831
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. */
27832
28383
  focus: {
@@ -27994,7 +28545,7 @@ export interface operations {
27994
28545
  pageCount: number | null;
27995
28546
  /** @description Where it was uploaded (page module, blog, product, media library…). */
27996
28547
  source: string;
27997
- /** @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. */
27998
28549
  inUse: boolean;
27999
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. */
28000
28551
  focus: {
@@ -33004,7 +33555,7 @@ export interface operations {
33004
33555
  pageCount: number | null;
33005
33556
  /** @description Where it was uploaded (page module, blog, product, media library…). */
33006
33557
  source: string;
33007
- /** @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. */
33008
33559
  inUse: boolean;
33009
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. */
33010
33561
  focus: {
@@ -33180,7 +33731,7 @@ export interface operations {
33180
33731
  pageCount: number | null;
33181
33732
  /** @description Where it was uploaded (page module, blog, product, media library…). */
33182
33733
  source: string;
33183
- /** @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. */
33184
33735
  inUse: boolean;
33185
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. */
33186
33737
  focus: {
@@ -33409,7 +33960,7 @@ export interface operations {
33409
33960
  pageCount: number | null;
33410
33961
  /** @description Where it was uploaded (page module, blog, product, media library…). */
33411
33962
  source: string;
33412
- /** @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. */
33413
33964
  inUse: boolean;
33414
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. */
33415
33966
  focus: {
@@ -33665,7 +34216,7 @@ export interface operations {
33665
34216
  pageCount: number | null;
33666
34217
  /** @description Where it was uploaded (page module, blog, product, media library…). */
33667
34218
  source: string;
33668
- /** @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. */
33669
34220
  inUse: boolean;
33670
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. */
33671
34222
  focus: {
@@ -33909,7 +34460,7 @@ export interface operations {
33909
34460
  pageCount: number | null;
33910
34461
  /** @description Where it was uploaded (page module, blog, product, media library…). */
33911
34462
  source: string;
33912
- /** @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. */
33913
34464
  inUse: boolean;
33914
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. */
33915
34466
  focus: {
@@ -34146,7 +34697,7 @@ export interface operations {
34146
34697
  pageCount: number | null;
34147
34698
  /** @description Where it was uploaded (page module, blog, product, media library…). */
34148
34699
  source: string;
34149
- /** @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. */
34150
34701
  inUse: boolean;
34151
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. */
34152
34703
  focus: {
@@ -34392,7 +34943,7 @@ export interface operations {
34392
34943
  pageCount: number | null;
34393
34944
  /** @description Where it was uploaded (page module, blog, product, media library…). */
34394
34945
  source: string;
34395
- /** @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. */
34396
34947
  inUse: boolean;
34397
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. */
34398
34949
  focus: {
@@ -34556,7 +35107,7 @@ export interface operations {
34556
35107
  pageCount: number | null;
34557
35108
  /** @description Where it was uploaded (page module, blog, product, media library…). */
34558
35109
  source: string;
34559
- /** @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. */
34560
35111
  inUse: boolean;
34561
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. */
34562
35113
  focus: {
@@ -36020,10 +36571,10 @@ export interface operations {
36020
36571
  */
36021
36572
  status?: "draft" | "published" | "changed";
36022
36573
  /**
36023
- * @description Set when the system recorded this revision automatically (e.g. right before the item was moved to the trash).
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.
36024
36575
  * @enum {string}
36025
36576
  */
36026
- backup?: "beforeDelete";
36577
+ backup?: "beforeDelete" | "scheduled";
36027
36578
  } | null;
36028
36579
  label: string | null;
36029
36580
  actor: {
@@ -36053,6 +36604,79 @@ export interface operations {
36053
36604
  503: components["responses"]["Error503"];
36054
36605
  };
36055
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
+ };
36056
36680
  revisions_get: {
36057
36681
  parameters: {
36058
36682
  query?: never;
@@ -36157,10 +36781,10 @@ export interface operations {
36157
36781
  */
36158
36782
  status?: "draft" | "published" | "changed";
36159
36783
  /**
36160
- * @description Set when the system recorded this revision automatically (e.g. right before the item was moved to the trash).
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.
36161
36785
  * @enum {string}
36162
36786
  */
36163
- backup?: "beforeDelete";
36787
+ backup?: "beforeDelete" | "scheduled";
36164
36788
  } | null;
36165
36789
  label: string | null;
36166
36790
  actor: {
@@ -36234,7 +36858,7 @@ export interface operations {
36234
36858
  pageCount: number | null;
36235
36859
  /** @description Where it was uploaded (page module, blog, product, media library…). */
36236
36860
  source: string;
36237
- /** @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. */
36238
36862
  inUse: boolean;
36239
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. */
36240
36864
  focus: {