@kanorio/sdk 1.2.0 → 1.4.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 +36 -6
- package/dist/edge.d.ts +4 -3
- package/dist/edge.js +20 -12
- package/dist/forms.d.ts +25 -2
- package/dist/forms.js +20 -7
- package/dist/generated/delivery.d.ts +125 -28
- package/dist/generated/management.d.ts +1361 -90
- package/dist/http.d.ts +2 -2
- package/dist/http.js +2 -2
- package/dist/image.d.ts +48 -18
- package/dist/image.js +74 -16
- package/dist/index.d.ts +3 -3
- package/dist/index.js +1 -1
- package/dist/next.d.ts +8 -2
- package/dist/next.js +16 -2
- package/dist/paginate.d.ts +23 -0
- package/dist/paginate.js +28 -2
- package/dist/seo.d.ts +31 -3
- package/dist/seo.js +41 -8
- package/dist/server-key.d.ts +13 -3
- package/dist/server-key.js +24 -5
- package/dist/shared/api/delivery/cache-tags.d.ts +2 -2
- package/dist/shared/api/delivery/cache-tags.js +3 -1
- package/dist/shared/api/server-key.d.ts +8 -0
- package/dist/shared/api/server-key.js +8 -0
- package/dist/shared/types/forms-logic.js +7 -2
- package/dist/warn-once.d.ts +3 -0
- package/dist/warn-once.js +16 -0
- package/package.json +1 -1
|
@@ -117,7 +117,7 @@ export interface paths {
|
|
|
117
117
|
};
|
|
118
118
|
/**
|
|
119
119
|
* operations.get
|
|
120
|
-
* @description Get the status of an asynchronous business operation by operationId (returned by capabilities such as sites.create mode=brief or imports.create, or carried on webhook events). Poll until status is terminal (SUCCEEDED, FAILED, CANCELLED, EXPIRED); respect pollAfterSeconds. UNKNOWN means an external call timed out and Kanorio is reconciling it: keep polling, do not retry the original request. pendingEffects lists side effects still in flight after the main operation succeeded. Synchronous operations never create an operation
|
|
120
|
+
* @description Get the status of an asynchronous business operation by operationId (returned by capabilities such as sites.create mode=brief or imports.create, or carried on webhook events). Poll until status is terminal (SUCCEEDED, FAILED, CANCELLED, EXPIRED); respect pollAfterSeconds. UNKNOWN means an external call timed out and Kanorio is reconciling it: keep polling, do not retry the original request. pendingEffects lists side effects still in flight after the main operation succeeded. Synchronous operations never create an operation. Retry one with the same Idempotency-Key only if it is marked x-kanorio-idempotent (over MCP: the tool has an idempotencyKey argument); any other write answers 400 IDEMPOTENCY_NOT_SUPPORTED to a key, so check whether the first attempt went through before sending it again. import_job operations stay RUNNING with stage=review while the batch waits for a human (or imports.apply) to confirm which rows to write; result carries batchId, batchStatus and totals. Errors: OPERATION_NOT_FOUND, FORBIDDEN.
|
|
121
121
|
*/
|
|
122
122
|
get: operations["operations_get"];
|
|
123
123
|
put?: never;
|
|
@@ -676,7 +676,7 @@ export interface paths {
|
|
|
676
676
|
put?: never;
|
|
677
677
|
/**
|
|
678
678
|
* posts.publish
|
|
679
|
-
* @description Publish a blog post (or re-publish a published post's pending edits). Snapshots the working copy to the public site immediately; the website itself must already be published (site.publish) or use frontendMode HEADLESS (a custom frontend, where publishing the hosted site is not needed). Pass scheduledAt (a future ISO timestamp) to schedule it instead: freezes title, excerpt, contentMarkdown and
|
|
679
|
+
* @description Publish a blog post (or re-publish a published post's pending edits). Snapshots the working copy to the public site immediately; the website itself must already be published (site.publish) or use frontendMode HEADLESS (a custom frontend, where publishing the hosted site is not needed). Pass scheduledAt (a future ISO timestamp) to schedule it instead: freezes title, excerpt, contentMarkdown, showToc and the cover (coverImageAssetId) as a revision and publishes exactly that snapshot when the time comes; categories, tags, authors, slug and SEO/OG fields are NOT frozen and use whatever they are set to at publish time, so further edits to those fields before the schedule fires do still take effect. Cancel with posts.unschedule. Publishing immediately (no scheduledAt) cancels any pending schedule, so it will not publish again later. Requires blog:publish (separate from blog:manage). Errors: FORBIDDEN, POST_NOT_FOUND, SITE_NOT_PUBLISHED, SLUG_TAKEN, VALIDATION (scheduledAt must be a future timestamp, or the post is already scheduled: call posts.unschedule first to change the time).
|
|
680
680
|
*/
|
|
681
681
|
post: operations["posts_publish"];
|
|
682
682
|
delete?: never;
|
|
@@ -852,7 +852,7 @@ export interface paths {
|
|
|
852
852
|
put?: never;
|
|
853
853
|
/**
|
|
854
854
|
* collections.create
|
|
855
|
-
* @description Create a collection (a small database for site content: teachers, projects, locations, FAQ…). Not for app data such as members, orders or comments. Field types: text, rich_text, email, phone, url, video_url, number, boolean, date, datetime, select, multi_select, color, image, gallery, file, reference, multi_reference, json. Every field needs id (snake_case), name, type; required defaults to false. Constraints: text min/max/pattern/unique/default; number integer/min/max/unique; select/multi_select options [{id,label}]; reference/multi_reference targetCollectionKey; gallery/multi_* max.
|
|
855
|
+
* @description Create a collection (a small database for site content: teachers, projects, locations, FAQ…). Not for app data such as members, orders or comments. Field types: text, rich_text, email, phone, url, video_url, number, boolean, date, datetime, select, multi_select, color, image, gallery, file, reference, multi_reference, json. Every field needs id (snake_case), name, type; required defaults to false. Constraints: text min/max/pattern/unique/default; number integer/min/max/unique; select/multi_select options [{id,label}]; reference/multi_reference targetCollectionKey; gallery/multi_* max; json schema (a JSON Schema subset: writes must match it, and kanorio types generates the value's type from it). help (up to 300 characters) explains a field to people in the dashboard; aiHint (up to 500 characters) tells future agents how to fill it. titleFieldId must point to a text/email/url field; it names items and generates slugs. Set singleton: true for content that exists once (site settings, homepage sections): the collection then holds one item, read at GET /api/v1/collections/{key}/item. Optional pathTemplate (e.g. /tours/{slug}): set it when your frontend renders a page per item, so published items are listed in the sitemap and search engines are notified. Optional previewUrlTemplate: where the dashboard's Preview button opens a draft item, when that differs from pathTemplate (for example a draft-mode route such as /api/draft?redirect=/tours/{slug}, or a page addressed by another field such as /tours/{region}/{slug}). Optional search: { fields, pathTemplate? } puts published items into site search (GET /api/v1/search returns kind=COLLECTION_ITEM, collectionKey, refId, slug; url only when pathTemplate is set). Returns the Delivery API endpoints and a fetch example. Errors: FORBIDDEN, VALIDATION (details.issues), KEY_TAKEN, COLLECTION_LIMIT_REACHED, SYSTEM_COLLECTION (reserved key).
|
|
856
856
|
*/
|
|
857
857
|
post: operations["collections_create"];
|
|
858
858
|
delete?: never;
|
|
@@ -884,7 +884,7 @@ export interface paths {
|
|
|
884
884
|
head?: never;
|
|
885
885
|
/**
|
|
886
886
|
* collections.update
|
|
887
|
-
* @description Change a collection's name, description, titleFieldId, fields, accessPolicy, search or
|
|
887
|
+
* @description Change a collection's name, description, titleFieldId, fields, accessPolicy, search, pathTemplate, previewUrlTemplate or singleton. fields replaces the whole ordered list: read it with collections.get, edit, send it back. Removing or retyping a field that previewUrlTemplate uses is refused unless previewUrlTemplate changes in the same request. Allowed immediately: add fields, rename, change help/aiHint, add options, relax constraints, remove custom fields (data is ignored, cleaned on next write). Type changes only along compatible paths (e.g. text→rich_text, select→multi_select, reference→multi_reference, image→gallery); otherwise add a new field, migrate, remove the old one. Tightened constraints are checked against existing items first. accessPolicy gates specific fieldIds (e.g. blog content) behind customer sign-in ({ kind: "customer" }) or an active commercial entitlement ({ kind: "entitlement", featureKey: "premium" }), with optional itemOverrideField (select field with public/customer/paid); pass null to clear. System collections (blog): reserved fields cannot be removed or retyped, but accessPolicy and custom fields can be configured. Errors: FORBIDDEN, COLLECTION_NOT_FOUND, VALIDATION (details.issues), SCHEMA_CHANGE_REJECTED (details.schemaIssues), SINGLETON_HAS_ITEMS (singleton: true while more than one item is outside the trash).
|
|
888
888
|
*/
|
|
889
889
|
patch: operations["collections_update"];
|
|
890
890
|
trace?: never;
|
|
@@ -904,7 +904,7 @@ export interface paths {
|
|
|
904
904
|
put?: never;
|
|
905
905
|
/**
|
|
906
906
|
* items.create
|
|
907
|
-
* @description Create one item. Values are validated against the collection schema; fix the listed fieldIds on VALIDATION. slug is generated from the title field when omitted. publish defaults to true, but is silently downgraded to false if the token/role has collections:manage without collections:publish (no error; check the returned status). Errors: FORBIDDEN, COLLECTION_NOT_FOUND, VALIDATION (details.issues: fieldId, code, message, example), UNIQUE_CONFLICT, SLUG_TAKEN, PLAN_ITEM_LIMIT_REACHED (details.quota), COLLECTION_ITEM_LIMIT_REACHED, SYSTEM_COLLECTION (blog collections are read-only here; use blog.*).
|
|
907
|
+
* @description Create one item. Values are validated against the collection schema; fix the listed fieldIds on VALIDATION. slug is generated from the title field when omitted. imageAlt sets the alt text of an image where this item uses it ({ fieldId: { assetId: alt } } for image and gallery fields), overriding the image's default alt from the media library. publish defaults to true, but is silently downgraded to false if the token/role has collections:manage without collections:publish (no error; check the returned status). Errors: FORBIDDEN, COLLECTION_NOT_FOUND, VALIDATION (details.issues: fieldId, code, message, example), UNIQUE_CONFLICT, SLUG_TAKEN, PLAN_ITEM_LIMIT_REACHED (details.quota), COLLECTION_ITEM_LIMIT_REACHED, SINGLETON_ITEM_EXISTS (a single-item collection already has its item; details.itemId is the one to update), SYSTEM_COLLECTION (blog collections are read-only here; use blog.*).
|
|
908
908
|
*/
|
|
909
909
|
post: operations["items_create"];
|
|
910
910
|
delete?: never;
|
|
@@ -924,7 +924,7 @@ export interface paths {
|
|
|
924
924
|
put?: never;
|
|
925
925
|
/**
|
|
926
926
|
* items.bulk_create
|
|
927
|
-
* @description Create up to 200 items in one transaction (all or nothing).
|
|
927
|
+
* @description Create up to 200 items in one transaction (all or nothing). If any entry fails, nothing is written and the request fails with VALIDATION; details.failed lists each bad entry by index with its code, message and issues. Fix those entries and send the whole batch again. publish defaults to true, but is silently downgraded to false if the token/role has collections:manage without collections:publish. Errors: FORBIDDEN, COLLECTION_NOT_FOUND, VALIDATION (details.failed), PLAN_ITEM_LIMIT_REACHED (details.quota), COLLECTION_ITEM_LIMIT_REACHED, SINGLETON_ITEM_EXISTS (more than one item for a single-item collection), SYSTEM_COLLECTION.
|
|
928
928
|
*/
|
|
929
929
|
post: operations["items_bulk_create"];
|
|
930
930
|
delete?: never;
|
|
@@ -932,7 +932,7 @@ export interface paths {
|
|
|
932
932
|
head?: never;
|
|
933
933
|
/**
|
|
934
934
|
* items.bulk_update
|
|
935
|
-
* @description Update up to 200 items in one transaction (all or nothing); each entry is a partial update by itemId. publish defaults to true, but is silently downgraded to false if the token/role has collections:manage without collections:publish. Pass ifUnmodifiedSince per entry (the updatedAt from items.list) to abort the whole batch instead of silently overwriting items changed since you read them;
|
|
935
|
+
* @description Update up to 200 items in one transaction (all or nothing); each entry is a partial update by itemId. publish defaults to true, but is silently downgraded to false if the token/role has collections:manage without collections:publish. If any entry fails, nothing is written and the request fails with VALIDATION; details.failed lists each bad entry by index with its code (VALIDATION, NOT_FOUND, SLUG_TAKEN, UNIQUE_CONFLICT, CONFLICT), message and issues. Pass ifUnmodifiedSince per entry (the updatedAt from items.list) to abort the whole batch instead of silently overwriting items changed since you read them; a stale entry is reported with code CONFLICT and conflict.updatedAt. If any item in the batch was submitted for review (items.request_review) and publish resolves to true, warning is set to REVIEW_CONTENT_CHANGED when its content differs from what was submitted (publish still proceeds). Errors: FORBIDDEN, COLLECTION_NOT_FOUND, VALIDATION (details.failed), SYSTEM_COLLECTION.
|
|
936
936
|
*/
|
|
937
937
|
patch: operations["items_bulk_update"];
|
|
938
938
|
trace?: never;
|
|
@@ -1020,7 +1020,7 @@ export interface paths {
|
|
|
1020
1020
|
head?: never;
|
|
1021
1021
|
/**
|
|
1022
1022
|
* items.update
|
|
1023
|
-
* @description Partially update an item: only the fieldIds you send change; send null to clear a field. publish=false keeps the public copy unchanged (status becomes changed). publish defaults to true, but is silently downgraded to false if the token/role has collections:manage without collections:publish (no error; check the returned status). Pass ifUnmodifiedSince (the updatedAt from items.get/items.list) to avoid silently overwriting a change made by someone else (or another agent run) since you last read it. If the item was submitted for review (items.request_review) and publish resolves to true, warning is set to REVIEW_CONTENT_CHANGED when the content differs from what was submitted (publish still proceeds). Errors: FORBIDDEN, COLLECTION_NOT_FOUND, ITEM_NOT_FOUND, CONFLICT (details.conflict.updatedAt: re-read and retry), VALIDATION (details.issues: fieldId, code, message, example), UNIQUE_CONFLICT, SLUG_TAKEN, PLAN_ITEM_LIMIT_REACHED (details.quota), COLLECTION_ITEM_LIMIT_REACHED, SYSTEM_COLLECTION (blog collections are read-only here; use blog.*).
|
|
1023
|
+
* @description Partially update an item: only the fieldIds you send change; send null to clear a field. publish=false keeps the public copy unchanged (status becomes changed). imageAlt patches the alt text of images where this item uses them ({ fieldId: { assetId: alt | null } }); entries you leave out are kept, and replacing an image drops the alt written for the old one. publish defaults to true, but is silently downgraded to false if the token/role has collections:manage without collections:publish (no error; check the returned status). Pass ifUnmodifiedSince (the updatedAt from items.get/items.list) to avoid silently overwriting a change made by someone else (or another agent run) since you last read it. If the item was submitted for review (items.request_review) and publish resolves to true, warning is set to REVIEW_CONTENT_CHANGED when the content differs from what was submitted (publish still proceeds). Errors: FORBIDDEN, COLLECTION_NOT_FOUND, ITEM_NOT_FOUND, CONFLICT (details.conflict.updatedAt: re-read and retry), VALIDATION (details.issues: fieldId, code, message, example), UNIQUE_CONFLICT, SLUG_TAKEN, PLAN_ITEM_LIMIT_REACHED (details.quota), COLLECTION_ITEM_LIMIT_REACHED, SINGLETON_ITEM_EXISTS (a single-item collection already has its item; details.itemId is the one to update), SYSTEM_COLLECTION (blog collections are read-only here; use blog.*).
|
|
1024
1024
|
*/
|
|
1025
1025
|
patch: operations["items_update"];
|
|
1026
1026
|
trace?: never;
|
|
@@ -1036,7 +1036,7 @@ export interface paths {
|
|
|
1036
1036
|
put?: never;
|
|
1037
1037
|
/**
|
|
1038
1038
|
* items.restore
|
|
1039
|
-
* @description Restore a trashed item back to its collection (status and content unchanged; still not re-published automatically if it was published before deletion but a draft-only edit happened — call items.publish if needed). Errors: FORBIDDEN, COLLECTION_NOT_FOUND, ITEM_NOT_FOUND, NOT_ARCHIVED.
|
|
1039
|
+
* @description Restore a trashed item back to its collection (status and content unchanged; still not re-published automatically if it was published before deletion but a draft-only edit happened — call items.publish if needed). Errors: FORBIDDEN, COLLECTION_NOT_FOUND, ITEM_NOT_FOUND, NOT_ARCHIVED, SINGLETON_ITEM_EXISTS (the single-item collection already has another item outside the trash).
|
|
1040
1040
|
*/
|
|
1041
1041
|
post: operations["items_restore"];
|
|
1042
1042
|
delete?: never;
|
|
@@ -1259,7 +1259,7 @@ export interface paths {
|
|
|
1259
1259
|
};
|
|
1260
1260
|
/**
|
|
1261
1261
|
* site.check_external_frontend
|
|
1262
|
-
* @description Run the External Frontend Doctor against the website's externalStorefrontUrl: probes /sitemap.xml, /robots.txt (including AI crawler rules), /llms.txt, /feed.xml, Schema.org JSON-LD @graph, published page content sync, 24h pageview reporting, active webhook revalidation endpoints, the system host 302 redirect, Search Console property alignment and the Customer API CORS allowlist. The switching parameter is deprecated and ignored: frontendMode is fixed when the site is created, and the former cutover checks now run every time. Call this after deploying or updating an external Next.js / Astro frontend to verify that every integration is green. Errors: FORBIDDEN.
|
|
1262
|
+
* @description Run the External Frontend Doctor against the website's externalStorefrontUrl: probes /sitemap.xml, /robots.txt (including AI crawler rules), /llms.txt, /feed.xml, Schema.org JSON-LD @graph, published page content sync, 24h pageview and AI crawler reporting, active webhook revalidation endpoints (on multilingual sites, also whether one receives the translation and localization events), the system host 302 redirect, Search Console property alignment and the Customer API CORS allowlist. The switching parameter is deprecated and ignored: frontendMode is fixed when the site is created, and the former cutover checks now run every time. Call this after deploying or updating an external Next.js / Astro frontend to verify that every integration is green. Errors: FORBIDDEN.
|
|
1263
1263
|
*/
|
|
1264
1264
|
get: operations["site_check_external_frontend"];
|
|
1265
1265
|
put?: never;
|
|
@@ -1304,7 +1304,7 @@ export interface paths {
|
|
|
1304
1304
|
get?: never;
|
|
1305
1305
|
/**
|
|
1306
1306
|
* webhooks.update_events
|
|
1307
|
-
* @description Replace the subscribed event list and optional filter (collectionKeys / formIds) of a webhook endpoint. Pass null for events to subscribe to all events (including future events). Errors: FORBIDDEN, WEBHOOK_NOT_FOUND, VALIDATION.
|
|
1307
|
+
* @description Replace the subscribed event list and optional filter (collectionKeys / formIds) of a webhook endpoint. Pass null for events to subscribe to all events (including future events). The list you send becomes the whole subscription: events you leave out stop being delivered. To add events, read the endpoint with webhooks.get and send its subscribedEvents plus the new keys. Errors: FORBIDDEN, WEBHOOK_NOT_FOUND, VALIDATION.
|
|
1308
1308
|
*/
|
|
1309
1309
|
put: operations["webhooks_update_events"];
|
|
1310
1310
|
post?: never;
|
|
@@ -1321,7 +1321,11 @@ export interface paths {
|
|
|
1321
1321
|
path?: never;
|
|
1322
1322
|
cookie?: never;
|
|
1323
1323
|
};
|
|
1324
|
-
|
|
1324
|
+
/**
|
|
1325
|
+
* webhooks.get
|
|
1326
|
+
* @description Get one webhook endpoint with the same fields as an entry of webhooks.list: subscribedEvents (null = all events, including future ones), filter and recent deliveries. Read it before webhooks.update_events, which replaces the whole event list: to add events, send the current subscribedEvents plus the new ones. Errors: FORBIDDEN, WEBHOOK_NOT_FOUND.
|
|
1327
|
+
*/
|
|
1328
|
+
get: operations["webhooks_get"];
|
|
1325
1329
|
put?: never;
|
|
1326
1330
|
post?: never;
|
|
1327
1331
|
/**
|
|
@@ -1369,7 +1373,7 @@ export interface paths {
|
|
|
1369
1373
|
put?: never;
|
|
1370
1374
|
/**
|
|
1371
1375
|
* localization.locales.add
|
|
1372
|
-
* @description Add a secondary locale. With autoTranslate (default true) it starts as TRANSLATING and a full-site translation job translates every record, then the locale goes live automatically; poll it with localization.jobs.list or localization.jobs.get. With autoTranslate false it starts as DRAFT: write translations with localization.translations.upsert, then publish it with localization.locales.update (status PUBLISHED). pathPrefix defaults to the language code (en), or the full code when two regional variants share a language (en-us, en-gb). Pass confirm: true. Safe to retry: adding a locale that is already on the website returns LOCALE_ALREADY_ADDED with details.locale (its current state). Errors: FORBIDDEN, CONFIRM_REQUIRED, UNSUPPORTED_LOCALE, LOCALE_ALREADY_ADDED, LOCALE_LIMIT_REACHED, INVALID_PATH_PREFIX, PATH_PREFIX_TAKEN, PATH_PREFIX_CONFLICT.
|
|
1376
|
+
* @description Add a secondary locale. With autoTranslate (default true) it starts as TRANSLATING and a full-site translation job translates every record, then the locale goes live automatically; poll it with localization.jobs.list or localization.jobs.get. Pass publishWhenTranslated: false to translate it the same way but keep it DRAFT when the job finishes, so you can check it before visitors see it; publish it with localization.locales.update (status PUBLISHED). With autoTranslate false it starts as DRAFT and nothing is translated: write translations with localization.translations.upsert, then publish it with localization.locales.update (status PUBLISHED). A DRAFT or TRANSLATING locale does not exist for visitors, the sitemap, hreflang or the Delivery API, except for Delivery requests made with a preview token (X-Kanorio-Preview: knr_pv_...), which accept it with ?locale= and read its draft translations. A new locale can take up to a minute to be accepted there. pathPrefix defaults to the language code (en), or the full code when two regional variants share a language (en-us, en-gb). Pass confirm: true. Safe to retry: adding a locale that is already on the website returns LOCALE_ALREADY_ADDED with details.locale (its current state). Errors: FORBIDDEN, CONFIRM_REQUIRED, UNSUPPORTED_LOCALE, LOCALE_ALREADY_ADDED, LOCALE_LIMIT_REACHED, INVALID_PATH_PREFIX, PATH_PREFIX_TAKEN, PATH_PREFIX_CONFLICT.
|
|
1373
1377
|
*/
|
|
1374
1378
|
post: operations["localization_locales_add"];
|
|
1375
1379
|
delete?: never;
|
|
@@ -1437,7 +1441,7 @@ export interface paths {
|
|
|
1437
1441
|
head?: never;
|
|
1438
1442
|
/**
|
|
1439
1443
|
* localization.locales.update
|
|
1440
|
-
* @description Update a locale: status PUBLISHED puts it live (adds it to the language switcher, hreflang, sitemap and the Delivery API) and DRAFT takes it offline (its URL prefix then 301-redirects to the primary locale); autoTranslate true starts a job that translates only what is missing or outdated; pathPrefix changes the URL prefix (a live locale's old prefix 301-redirects to the new one). Errors: FORBIDDEN, LOCALE_NOT_FOUND, PRIMARY_LOCALE_LOCKED, INVALID_PATH_PREFIX, PATH_PREFIX_TAKEN, PATH_PREFIX_CONFLICT.
|
|
1444
|
+
* @description Update a locale: status PUBLISHED puts it live (adds it to the language switcher, hreflang, sitemap and the Delivery API) and DRAFT takes it offline (its URL prefix then 301-redirects to the primary locale); DRAFT on a TRANSLATING locale keeps the translation job running but keeps the locale hidden when it finishes. autoTranslate true starts a job that translates only what is missing or outdated; on a DRAFT locale it also puts the locale live when the job finishes unless you pass status DRAFT with it. While autoTranslate is on, edits to the source keep being translated, live or not. pathPrefix changes the URL prefix (a live locale's old prefix 301-redirects to the new one). Errors: FORBIDDEN, LOCALE_NOT_FOUND, PRIMARY_LOCALE_LOCKED, INVALID_PATH_PREFIX, PATH_PREFIX_TAKEN, PATH_PREFIX_CONFLICT.
|
|
1441
1445
|
*/
|
|
1442
1446
|
patch: operations["localization_locales_update"];
|
|
1443
1447
|
trace?: never;
|
|
@@ -1462,6 +1466,26 @@ export interface paths {
|
|
|
1462
1466
|
patch?: never;
|
|
1463
1467
|
trace?: never;
|
|
1464
1468
|
};
|
|
1469
|
+
"/sites/{id}/translations/pending": {
|
|
1470
|
+
parameters: {
|
|
1471
|
+
query?: never;
|
|
1472
|
+
header?: never;
|
|
1473
|
+
path?: never;
|
|
1474
|
+
cookie?: never;
|
|
1475
|
+
};
|
|
1476
|
+
/**
|
|
1477
|
+
* localization.translations.pending
|
|
1478
|
+
* @description List the records of one type that still need translating into one locale, with only the fields that need work: missing (no translation yet) or outdated (the source changed after it was translated). state narrows to one of the two. Each record carries sourceHash and each field its current source text, so you can translate and write back with localization.translations.upsert without reading the record again. The source is the version being edited, as in localization.translations.get. Records come in a fixed order (by record id) and the cursor remembers the last record looked at, so writing translations back between pages neither skips nor repeats records. A page can hold fewer records than limit, or none, while hasMore is true (only part of a large site is checked per request): keep following nextCursor until hasMore is false. A collection's json, image and gallery fields are never missing here (an unwritten one shows the primary value by design, and machine translation skips them); a written one is outdated once its source changes. A caption track is not listed for a locale in its own language, or for one the owner uploaded captions in. Translating counts as editing the record, so the record type's own permission applies. Errors: FORBIDDEN, LOCALE_NOT_FOUND, LOCALE_IS_PRIMARY, INVALID_CURSOR.
|
|
1479
|
+
*/
|
|
1480
|
+
get: operations["localization_translations_pending"];
|
|
1481
|
+
put?: never;
|
|
1482
|
+
post?: never;
|
|
1483
|
+
delete?: never;
|
|
1484
|
+
options?: never;
|
|
1485
|
+
head?: never;
|
|
1486
|
+
patch?: never;
|
|
1487
|
+
trace?: never;
|
|
1488
|
+
};
|
|
1465
1489
|
"/sites/{id}/translations/{entityType}/{entityId}/{locale}": {
|
|
1466
1490
|
parameters: {
|
|
1467
1491
|
query?: never;
|
|
@@ -1476,7 +1500,7 @@ export interface paths {
|
|
|
1476
1500
|
get: operations["localization_translations_get"];
|
|
1477
1501
|
/**
|
|
1478
1502
|
* localization.translations.upsert
|
|
1479
|
-
* @description Write translated text for some fields of one record in one secondary locale. Only the given paths change; an empty string clears that field (visitors see the primary text). Paths must come from localization.translations.get source.fields. sourceHash must equal the current source.sourceHash; if the source changed since you read it the write is rejected with SOURCE_HASH_MISMATCH (details.sourceHash) — read it again and re-translate the outdated fields. Fields you write are locked against machine re-translation; if their source changes later they are re-translated using your wording as reference. slug sets this locale's URL slug (one segment, lowercase; pages translate only their last segment). null makes the locale follow the primary slug. Changing a live slug adds a 301 from the old URL in that locale. Pages, global sections, site settings, blog posts and collection items keep translations as drafts that go live when the record is published (or with localization.translations.publish); every other record type goes live on write. Errors: FORBIDDEN, VALIDATION, ENTITY_NOT_FOUND, LOCALE_NOT_FOUND, LOCALE_IS_PRIMARY, INVALID_FIELD_PATH (details.paths), SOURCE_HASH_MISMATCH, INVALID_SLUG, SLUG_TAKEN.
|
|
1503
|
+
* @description Write translated text for some fields of one record in one secondary locale. Only the given paths change; an empty string clears that field (visitors see the primary text). Paths must come from localization.translations.get source.fields. sourceHash must equal the current source.sourceHash; if the source changed since you read it the write is rejected with SOURCE_HASH_MISMATCH (details.sourceHash) — read it again and re-translate the outdated fields. Fields you write are locked against machine re-translation, including a translation that was already running when you wrote; if their source changes later they are re-translated using your wording as reference. slug sets this locale's URL slug (one segment, lowercase; pages translate only their last segment). null makes the locale follow the primary slug. Changing a live slug adds a 301 from the old URL in that locale. Pages, global sections, site settings, blog posts and collection items keep translations as drafts that go live when the record is published (or with localization.translations.publish), even when that locale's translation is already live; every other record type goes live on write. On a site with its own frontend (frontendMode HEADLESS), which is never published, site settings translations also go live on write. The response says which happened: live, and translation.publishState (changed = live with draft edits waiting). Errors: FORBIDDEN, VALIDATION (details.issues, each with path, code and message: a json value that is not valid JSON or does not pass the field's checks, or code invalid_placeholder when a text uses a template variable (a triple-brace placeholder such as the order number) that the source text does not have; nothing is written), ENTITY_NOT_FOUND, LOCALE_NOT_FOUND, LOCALE_IS_PRIMARY, INVALID_FIELD_PATH (details.paths), SOURCE_HASH_MISMATCH, INVALID_SLUG, SLUG_TAKEN.
|
|
1480
1504
|
*/
|
|
1481
1505
|
put: operations["localization_translations_upsert"];
|
|
1482
1506
|
post?: never;
|
|
@@ -1501,7 +1525,7 @@ export interface paths {
|
|
|
1501
1525
|
put?: never;
|
|
1502
1526
|
/**
|
|
1503
1527
|
* localization.translations.publish
|
|
1504
|
-
* @description Put one record's draft translation in one locale live without publishing the record's primary-language draft (for pages, global sections, site settings, blog posts and collection items, whose translations otherwise go live when the record is published). Visitors see it only where the record itself is live. For those record types this needs the record's publish permission (site:publish, blog:publish or collections:publish), not just edit access. Errors: FORBIDDEN, VALIDATION, TRANSLATION_NOT_FOUND.
|
|
1528
|
+
* @description Put one record's draft translation in one locale live without publishing the record's primary-language draft (for pages, global sections, site settings, blog posts and collection items, whose translations otherwise go live when the record is published). Visitors see it only where the record itself is live. For those record types this needs the record's publish permission (site:publish, blog:publish or collections:publish), not just edit access. Errors: FORBIDDEN, VALIDATION, TRANSLATION_NOT_FOUND, SLUG_TAKEN (another record already uses the draft slug live in this locale; nothing was published).
|
|
1505
1529
|
*/
|
|
1506
1530
|
post: operations["localization_translations_publish"];
|
|
1507
1531
|
delete?: never;
|
|
@@ -1521,7 +1545,7 @@ export interface paths {
|
|
|
1521
1545
|
put?: never;
|
|
1522
1546
|
/**
|
|
1523
1547
|
* localization.translations.translate
|
|
1524
|
-
* @description Machine-translate one record into one secondary locale now (synchronous; only missing and outdated fields; fields written by a person, an agent or an external tool are re-translated using their wording as reference). version draft (default) translates the editable draft and follows the record's publishing; version published translates the live content and
|
|
1548
|
+
* @description Machine-translate one record into one secondary locale now (synchronous; only missing and outdated fields; fields written by a person, an agent or an external tool are re-translated using their wording as reference). version draft (default) translates the editable draft and follows the record's publishing; version published translates the live content and the fields it translates go live immediately (other draft edits in that locale still wait for the record to be published). Counts toward the website's daily translation limit (no AI credits). Errors: FORBIDDEN, VALIDATION, ENTITY_NOT_FOUND, LOCALE_NOT_FOUND, LOCALE_IS_PRIMARY, DAILY_LIMIT_REACHED.
|
|
1525
1549
|
*/
|
|
1526
1550
|
post: operations["localization_translations_translate"];
|
|
1527
1551
|
delete?: never;
|
|
@@ -1545,7 +1569,7 @@ export interface paths {
|
|
|
1545
1569
|
put?: never;
|
|
1546
1570
|
/**
|
|
1547
1571
|
* localization.jobs.retry
|
|
1548
|
-
* @description Run the full-site translation job for a secondary locale (again): it translates only records that are missing or whose source changed, never overwrites fields written by a person, an agent or an external tool, and pauses (not fails) at the daily translation limit. Use it after a job failed or was cancelled, or to fill gaps on a locale with autoTranslate off. If a job for that locale is already queued, running or paused, returns it with alreadyRunning true. Errors: FORBIDDEN, LOCALE_NOT_FOUND, UNSUPPORTED_LOCALE.
|
|
1572
|
+
* @description Run the full-site translation job for a secondary locale (again): it translates only records that are missing or whose source changed, never overwrites fields written by a person, an agent or an external tool, and pauses (not fails) at the daily translation limit. Use it after a job failed or was cancelled, or to fill gaps on a locale with autoTranslate off. With refreshMachineTranslations: true it also translates again every field whose current translation came from machine translation, so a changed glossary (localization.glossary.upsert) reaches existing translations; this uses translation calls for the whole locale. When the locale's latest job was such a run and it failed, was cancelled or left records failed, a retry without the flag continues it (refreshMachineTranslations true in the output) and only translates again the machine-translated fields that job had not reached. If a job for that locale is already queued, running or paused, returns it with alreadyRunning true and its options unchanged; refreshMachineTranslations in the output says whether the returned job refreshes machine translations. If you asked for refreshMachineTranslations and the output says false, wait until that job finishes (localization.jobs.get until SUCCEEDED or FAILED) and call localization.jobs.retry again. Errors: FORBIDDEN, LOCALE_NOT_FOUND, UNSUPPORTED_LOCALE.
|
|
1549
1573
|
*/
|
|
1550
1574
|
post: operations["localization_jobs_retry"];
|
|
1551
1575
|
delete?: never;
|
|
@@ -1585,7 +1609,7 @@ export interface paths {
|
|
|
1585
1609
|
put?: never;
|
|
1586
1610
|
/**
|
|
1587
1611
|
* localization.jobs.cancel
|
|
1588
|
-
* @description Cancel a queued or paused full-site translation job
|
|
1612
|
+
* @description Cancel a queued or paused full-site translation job; a running job cannot be cancelled. Translations already written are kept, and the localization.job.failed webhook is sent with errorCode CANCELLED. Errors: FORBIDDEN, JOB_NOT_FOUND, JOB_NOT_CANCELLABLE.
|
|
1589
1613
|
*/
|
|
1590
1614
|
post: operations["localization_jobs_cancel"];
|
|
1591
1615
|
delete?: never;
|
|
@@ -1594,6 +1618,50 @@ export interface paths {
|
|
|
1594
1618
|
patch?: never;
|
|
1595
1619
|
trace?: never;
|
|
1596
1620
|
};
|
|
1621
|
+
"/sites/{id}/translation-glossary": {
|
|
1622
|
+
parameters: {
|
|
1623
|
+
query?: never;
|
|
1624
|
+
header?: never;
|
|
1625
|
+
path?: never;
|
|
1626
|
+
cookie?: never;
|
|
1627
|
+
};
|
|
1628
|
+
/**
|
|
1629
|
+
* localization.glossary.list
|
|
1630
|
+
* @description List the website's translation glossary, sorted by term: terms machine translation keeps as written (doNotTranslate) or renders with a fixed wording per locale (translations). At most 200 terms; max in the response. Errors: FORBIDDEN, WEBSITE_NOT_FOUND.
|
|
1631
|
+
*/
|
|
1632
|
+
get: operations["localization_glossary_list"];
|
|
1633
|
+
/**
|
|
1634
|
+
* localization.glossary.upsert
|
|
1635
|
+
* @description Add a term to the translation glossary, or replace the term with the same wording (case, full-width characters and spacing are ignored when matching). Either keep it as written in every language (doNotTranslate: true; brand and product names) or give the wording for one or more secondary locales (translations). Machine translation from now on follows it: full-site jobs, translation of changed content and localization.translations.translate. Existing machine translations change only when you run localization.jobs.retry with refreshMachineTranslations: true; translations written by a person, an agent or an external tool are never changed. Errors: FORBIDDEN, VALIDATION (a locale that is not a secondary locale of the site, or neither doNotTranslate nor a translation; see details.issues), GLOSSARY_LIMIT_REACHED (200 terms).
|
|
1636
|
+
*/
|
|
1637
|
+
put: operations["localization_glossary_upsert"];
|
|
1638
|
+
post?: never;
|
|
1639
|
+
delete?: never;
|
|
1640
|
+
options?: never;
|
|
1641
|
+
head?: never;
|
|
1642
|
+
patch?: never;
|
|
1643
|
+
trace?: never;
|
|
1644
|
+
};
|
|
1645
|
+
"/sites/{id}/translation-glossary/{termId}": {
|
|
1646
|
+
parameters: {
|
|
1647
|
+
query?: never;
|
|
1648
|
+
header?: never;
|
|
1649
|
+
path?: never;
|
|
1650
|
+
cookie?: never;
|
|
1651
|
+
};
|
|
1652
|
+
get?: never;
|
|
1653
|
+
put?: never;
|
|
1654
|
+
post?: never;
|
|
1655
|
+
/**
|
|
1656
|
+
* localization.glossary.delete
|
|
1657
|
+
* @description Delete one term from the translation glossary by id (from localization.glossary.list). Existing translations are not changed. Errors: FORBIDDEN, GLOSSARY_TERM_NOT_FOUND.
|
|
1658
|
+
*/
|
|
1659
|
+
delete: operations["localization_glossary_delete"];
|
|
1660
|
+
options?: never;
|
|
1661
|
+
head?: never;
|
|
1662
|
+
patch?: never;
|
|
1663
|
+
trace?: never;
|
|
1664
|
+
};
|
|
1597
1665
|
"/sites/{id}/forms": {
|
|
1598
1666
|
parameters: {
|
|
1599
1667
|
query?: never;
|
|
@@ -1661,7 +1729,7 @@ export interface paths {
|
|
|
1661
1729
|
head?: never;
|
|
1662
1730
|
/**
|
|
1663
1731
|
* forms.update
|
|
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.
|
|
1732
|
+
* @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; set a key to null to remove it (for example redirectUrl, openAt, closeAt or maxSubmissions), which restores the behaviour of a form without that setting. 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.
|
|
1665
1733
|
*/
|
|
1666
1734
|
patch: operations["forms_update"];
|
|
1667
1735
|
trace?: never;
|
|
@@ -3068,13 +3136,13 @@ export interface paths {
|
|
|
3068
3136
|
};
|
|
3069
3137
|
/**
|
|
3070
3138
|
* media.list
|
|
3071
|
-
* @description List the website's media library (the same files the user sees in the dashboard): public and protected images, videos, audio, PDFs and documents, newest first, plus storage usage (usedBytes vs limitBytes). Filter with assetKind, visibility, unusedOnly and search (file name). Files in the trash, older versions kept after media.replace, and broken records where the original file is missing (unless includeMissing=true) are not listed; files in the trash still count toward storage. Errors: FORBIDDEN, INVALID_CURSOR.
|
|
3139
|
+
* @description List the website's media library (the same files the user sees in the dashboard): public and protected images, videos, audio, PDFs and documents, newest first, plus storage usage (usedBytes vs limitBytes). Filter with assetKind, visibility, tags, unusedOnly and search (file name, default alt text or credit). Files in the trash, older versions kept after media.replace, and broken records where the original file is missing (unless includeMissing=true) are not listed; files in the trash still count toward storage. Errors: FORBIDDEN, INVALID_CURSOR.
|
|
3072
3140
|
*/
|
|
3073
3141
|
get: operations["media_list"];
|
|
3074
3142
|
put?: never;
|
|
3075
3143
|
/**
|
|
3076
3144
|
* media.upload
|
|
3077
|
-
* @description Upload one image or file into the website's media library. Provide exactly one of base64 or url. Files the user attaches in chat are not available to you: use media.create_upload_link for those (it also takes videos and documents), media.list_page_images for a page the user owns, or media.search_stock when they have no photos. Images: put asset.url in sections (pages.replace_sections), blog posts and product images. Videos, audio, PDFs, documents, e-books and ZIP files: pass fileName; use visibility "protected" for deliverable files (course lessons, e-books, downloads) and reference them by assetId in deliverable_units.*. Files over 40 MB (base64) or 100 MB (url): use media.request_upload. Keep asset.assetId to manage the file later (media.get, media.replace, media.trash). Uploads are kept; unused files show as unused in the media library. Errors: FORBIDDEN, VALIDATION, INVALID_IMAGE_DATA, INVALID_FILE_DATA, UNSUPPORTED_IMAGE_TYPE, UNSUPPORTED_FILE_TYPE (extension not accepted, or the file header does not match it), FILE_TOO_LARGE, FETCH_FAILED, UPLOAD_FAILED, SERVICE_UNAVAILABLE, STORAGE_LIMIT_EXCEEDED (plan storage is full; every upload counts toward it).
|
|
3145
|
+
* @description Upload one image or file into the website's media library. Provide exactly one of base64 or url. Files the user attaches in chat are not available to you: use media.create_upload_link for those (it also takes videos and documents), media.list_page_images for a page the user owns, or media.search_stock when they have no photos. Images: put asset.url in sections (pages.replace_sections), blog posts and product images. Videos, audio, PDFs, documents, e-books and ZIP files: pass fileName; use visibility "protected" for deliverable files (course lessons, e-books, downloads) and reference them by assetId in deliverable_units.*. Files over 40 MB (base64) or 100 MB (url): use media.request_upload. Keep asset.assetId to manage the file later (media.get, media.replace, media.trash). Uploads are kept; unused files show as unused in the media library. Set the file's details in the same call: altText (images), tags, credit and sourceUrl, with the same rules as media.update; they are stored with the file, and a request that breaks a rule fails before anything is uploaded. Send an Idempotency-Key header (idempotencyKey over MCP) to retry a timed-out or failed upload with the same body without storing the file twice: the retry returns the first upload's asset, also when the first attempt stored the file and then failed. Errors: FORBIDDEN, VALIDATION, IMAGES_ONLY (altText on a file that is not an image), TAGS_INVALID, INVALID_IMAGE_DATA, INVALID_FILE_DATA, UNSUPPORTED_IMAGE_TYPE, UNSUPPORTED_FILE_TYPE (extension not accepted, or the file header does not match it), FILE_TOO_LARGE, FETCH_FAILED, UPLOAD_FAILED, SERVICE_UNAVAILABLE, STORAGE_LIMIT_EXCEEDED (plan storage is full; every upload counts toward it).
|
|
3078
3146
|
*/
|
|
3079
3147
|
post: operations["media_upload"];
|
|
3080
3148
|
delete?: never;
|
|
@@ -3178,7 +3246,7 @@ export interface paths {
|
|
|
3178
3246
|
put?: never;
|
|
3179
3247
|
/**
|
|
3180
3248
|
* media.import_stock
|
|
3181
|
-
* @description Copy one stock photo from media.search_stock into the website's media library. Pass provider, id and downloadURL exactly as returned by the search. Returns the asset: put asset.url in sections (backgroundImage, images[].url) and keep asset.assetId to manage it. Write the imageAlt yourself in the site's content language, based on the photo's alt and the section's purpose. Errors: FORBIDDEN, UNKNOWN_PROVIDER, INVALID_STOCK_URL, STOCK_BUSY, INVALID_IMAGE_DATA, UPLOAD_FAILED, STORAGE_LIMIT_EXCEEDED.
|
|
3249
|
+
* @description Copy one stock photo from media.search_stock into the website's media library. Pass provider, id and downloadURL exactly as returned by the search. Returns the asset: put asset.url in sections (backgroundImage, images[].url) and keep asset.assetId to manage it. Write the imageAlt yourself in the site's content language, based on the photo's alt and the section's purpose. The asset is named <provider>-<id>.<ext> and gets its credit ("Photographer / Pexels") and sourceUrl (the photo's page) automatically; both are public in the Content Delivery API's assets[], so a frontend can show the attribution. The image is copied from the photo the search returned for that id; when the photo cannot be confirmed with the stock library, the asset is imported from downloadURL without credit and sourceUrl. Errors: FORBIDDEN, VALIDATION, UNKNOWN_PROVIDER, INVALID_STOCK_URL (downloadURL is not an image URL of that stock library, or for Pexels not the image of that id), STOCK_BUSY, INVALID_IMAGE_DATA, UPLOAD_FAILED, STORAGE_LIMIT_EXCEEDED.
|
|
3182
3250
|
*/
|
|
3183
3251
|
post: operations["media_import_stock"];
|
|
3184
3252
|
delete?: never;
|
|
@@ -3230,7 +3298,7 @@ export interface paths {
|
|
|
3230
3298
|
head?: never;
|
|
3231
3299
|
/**
|
|
3232
3300
|
* media.update
|
|
3233
|
-
* @description Set a file's tags and an image's defaults, kept across new versions.
|
|
3301
|
+
* @description Set a file's tags, name and credit, and an image's defaults, kept across new versions. Any file: tags (replaces the whole list; up to 20 tags of 1-40 characters, case-insensitive duplicates dropped; filter media.list with tags), fileName (rename; end it with the current extension or an extension of the file's format, case-insensitive, because renaming does not change the format), credit (photographer or rights holder, up to 200 characters; null clears it) and sourceUrl (where the file came from, http or https; null clears it); credit and sourceUrl are public in the Content Delivery API's assets[]. Images only: focus (0-1 point on the original that image fields without their own framing crop around; null resets to center), altText (used where the image is shown without an alt of its own; null clears it) and watermarkExempt (show this image without the site watermark; needs the site:manage_settings scope and permission). Text fields must not contain control characters such as NUL. The Delivery API and the editor use the new focus right away; published pages switch after the next site.publish. Captions are generated automatically once a video or audio file is used in a page, post, collection or course (there is no manual transcription or re-transcription; edit the text or upload a file with media.transcripts.*); media.transcripts.list shows the auto-generated track as queued or processing until it is done, and captions appear in renditions once media.asset.ready fires with processingKind MEDIA_CAPTIONS. Errors: FORBIDDEN, ASSET_NOT_FOUND (also for files in the trash and older versions), IMAGES_ONLY (focus or altText on a non-image), TAGS_INVALID, VISIBILITY_BLOCKED (details.reason: in_use | deliverable | trash | missing | processing | unsupported_kind | older_version; details.locations for in_use), VALIDATION (also a fileName whose extension does not match the file, a credit over 200 characters, a sourceUrl that is not http or https, or control characters in altText or credit).
|
|
3234
3302
|
*/
|
|
3235
3303
|
patch: operations["media_update"];
|
|
3236
3304
|
trace?: never;
|
|
@@ -3246,7 +3314,7 @@ export interface paths {
|
|
|
3246
3314
|
put?: never;
|
|
3247
3315
|
/**
|
|
3248
3316
|
* media.replace
|
|
3249
|
-
* @description Upload a new version of an image or file (exactly one of base64 or url). Every place that uses it switches to the new version and keeps the same assetId, so no content needs to be edited: the editor, brand logo, share images, products, blog posts and deliverables right away; published pages after the next site.publish (awaitingPublish). When the aspect ratio changes, crops are re-centered per layout (aspectRatioChanged): tell the user to check the pages listed in usages. Tell the user before replacing a file that many places use. Videos, audio, PDFs and documents need fileName and can only become the same kind (video to video, PDF to PDF). Replacing a protected file changes what buyers of the deliverable get right away. Files over 40 MB (base64) or 100 MB (url) are replaced in the dashboard media library. The older version stays until no published page uses it, then moves to the trash. Errors: FORBIDDEN, ASSET_NOT_FOUND (also for files in the trash), KIND_MISMATCH, REPLACE_NOT_AVAILABLE, VALIDATION, INVALID_IMAGE_DATA, INVALID_FILE_DATA, UNSUPPORTED_IMAGE_TYPE, UNSUPPORTED_FILE_TYPE, FILE_TOO_LARGE, FETCH_FAILED, STORAGE_LIMIT_EXCEEDED, SERVICE_UNAVAILABLE, UPLOAD_FAILED.
|
|
3317
|
+
* @description Upload a new version of an image or file (exactly one of base64 or url). Every place that uses it switches to the new version and keeps the same assetId, so no content needs to be edited: the editor, brand logo, share images, products, blog posts and deliverables right away; published pages after the next site.publish (awaitingPublish). When the aspect ratio changes, crops are re-centered per layout (aspectRatioChanged): tell the user to check the pages listed in usages. Tell the user before replacing a file that many places use. Videos, audio, PDFs and documents need fileName and can only become the same kind (video to video, PDF to PDF). An image keeps its name; when the new version has another format, the extension follows it (hero.jpg becomes hero.png). Replacing a protected file changes what buyers of the deliverable get right away. Files over 40 MB (base64) or 100 MB (url) are replaced in the dashboard media library. The older version stays until no published page uses it, then moves to the trash. Errors: FORBIDDEN, ASSET_NOT_FOUND (also for files in the trash), KIND_MISMATCH, REPLACE_NOT_AVAILABLE, VALIDATION, INVALID_IMAGE_DATA, INVALID_FILE_DATA, UNSUPPORTED_IMAGE_TYPE, UNSUPPORTED_FILE_TYPE, FILE_TOO_LARGE, FETCH_FAILED, STORAGE_LIMIT_EXCEEDED, SERVICE_UNAVAILABLE, UPLOAD_FAILED.
|
|
3250
3318
|
*/
|
|
3251
3319
|
post: operations["media_replace"];
|
|
3252
3320
|
delete?: never;
|
|
@@ -3696,7 +3764,7 @@ export interface paths {
|
|
|
3696
3764
|
};
|
|
3697
3765
|
/**
|
|
3698
3766
|
* sites.usage
|
|
3699
|
-
* @description Get the website's plan tier, storage quota & usage (usedBytes, limitBytes, remainingBytes), and content counts (general pages, blog posts, active products, custom domains) so you can check limits before uploading or creating resources. Errors: FORBIDDEN.
|
|
3767
|
+
* @description Get the website's plan tier, storage quota & usage (usedBytes, limitBytes, remainingBytes), content items against the plan's item quota (contentItems.used, limit, remaining), and content counts (general pages, blog posts, active products, custom domains) so you can check limits before uploading or creating resources. Errors: FORBIDDEN.
|
|
3700
3768
|
*/
|
|
3701
3769
|
get: operations["sites_usage"];
|
|
3702
3770
|
put?: never;
|
|
@@ -3824,10 +3892,10 @@ export interface components {
|
|
|
3824
3892
|
* @description Stable error code. Codes not listed here follow the suffix rules: *_NOT_FOUND → 404, *_REQUIRED / *_FORBIDDEN / *_PLAN_REQUIRED / *_LIMIT → 403, otherwise 422.
|
|
3825
3893
|
* @enum {string}
|
|
3826
3894
|
*/
|
|
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";
|
|
3895
|
+
ErrorCode: "EMPTY_SLUG" | "IDEMPOTENCY_NOT_SUPPORTED" | "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";
|
|
3828
3896
|
};
|
|
3829
3897
|
responses: {
|
|
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. */
|
|
3898
|
+
/** @description Input failed validation or is malformed. Codes: EMPTY_SLUG, IDEMPOTENCY_NOT_SUPPORTED, INVALID_BODY, INVALID_CURSOR, INVALID_EDITED_PATH, INVALID_FORMAT, INVALID_ORDER, INVALID_SUBDOMAIN, UNSUPPORTED_EDITED_PATH, VALIDATION. */
|
|
3831
3899
|
Error400: {
|
|
3832
3900
|
headers: {
|
|
3833
3901
|
[name: string]: unknown;
|
|
@@ -5271,6 +5339,10 @@ export interface operations {
|
|
|
5271
5339
|
edgeColor: string | null;
|
|
5272
5340
|
/** @description Default alt text, used when the place that shows the image has no alt of its own. */
|
|
5273
5341
|
altText: string | null;
|
|
5342
|
+
/** @description Credit line for the file (photographer or rights holder, for example "Jane Doe / Pexels"); filled automatically by media.import_stock. Public: the Content Delivery API returns it in assets[]. */
|
|
5343
|
+
credit: string | null;
|
|
5344
|
+
/** @description Where the file came from (the stock photo's page, the original source); filled automatically by media.import_stock. Public like credit. */
|
|
5345
|
+
sourceUrl: string | null;
|
|
5274
5346
|
/** @description true when the owner excluded this image from the site watermark. */
|
|
5275
5347
|
watermarkExempt: boolean;
|
|
5276
5348
|
createdAt: string;
|
|
@@ -5426,6 +5498,10 @@ export interface operations {
|
|
|
5426
5498
|
edgeColor: string | null;
|
|
5427
5499
|
/** @description Default alt text, used when the place that shows the image has no alt of its own. */
|
|
5428
5500
|
altText: string | null;
|
|
5501
|
+
/** @description Credit line for the file (photographer or rights holder, for example "Jane Doe / Pexels"); filled automatically by media.import_stock. Public: the Content Delivery API returns it in assets[]. */
|
|
5502
|
+
credit: string | null;
|
|
5503
|
+
/** @description Where the file came from (the stock photo's page, the original source); filled automatically by media.import_stock. Public like credit. */
|
|
5504
|
+
sourceUrl: string | null;
|
|
5429
5505
|
/** @description true when the owner excluded this image from the site watermark. */
|
|
5430
5506
|
watermarkExempt: boolean;
|
|
5431
5507
|
createdAt: string;
|
|
@@ -5843,6 +5919,10 @@ export interface operations {
|
|
|
5843
5919
|
edgeColor: string | null;
|
|
5844
5920
|
/** @description Default alt text, used when the place that shows the image has no alt of its own. */
|
|
5845
5921
|
altText: string | null;
|
|
5922
|
+
/** @description Credit line for the file (photographer or rights holder, for example "Jane Doe / Pexels"); filled automatically by media.import_stock. Public: the Content Delivery API returns it in assets[]. */
|
|
5923
|
+
credit: string | null;
|
|
5924
|
+
/** @description Where the file came from (the stock photo's page, the original source); filled automatically by media.import_stock. Public like credit. */
|
|
5925
|
+
sourceUrl: string | null;
|
|
5846
5926
|
/** @description true when the owner excluded this image from the site watermark. */
|
|
5847
5927
|
watermarkExempt: boolean;
|
|
5848
5928
|
createdAt: string;
|
|
@@ -6141,6 +6221,10 @@ export interface operations {
|
|
|
6141
6221
|
edgeColor: string | null;
|
|
6142
6222
|
/** @description Default alt text, used when the place that shows the image has no alt of its own. */
|
|
6143
6223
|
altText: string | null;
|
|
6224
|
+
/** @description Credit line for the file (photographer or rights holder, for example "Jane Doe / Pexels"); filled automatically by media.import_stock. Public: the Content Delivery API returns it in assets[]. */
|
|
6225
|
+
credit: string | null;
|
|
6226
|
+
/** @description Where the file came from (the stock photo's page, the original source); filled automatically by media.import_stock. Public like credit. */
|
|
6227
|
+
sourceUrl: string | null;
|
|
6144
6228
|
/** @description true when the owner excluded this image from the site watermark. */
|
|
6145
6229
|
watermarkExempt: boolean;
|
|
6146
6230
|
createdAt: string;
|
|
@@ -6553,6 +6637,10 @@ export interface operations {
|
|
|
6553
6637
|
edgeColor: string | null;
|
|
6554
6638
|
/** @description Default alt text, used when the place that shows the image has no alt of its own. */
|
|
6555
6639
|
altText: string | null;
|
|
6640
|
+
/** @description Credit line for the file (photographer or rights holder, for example "Jane Doe / Pexels"); filled automatically by media.import_stock. Public: the Content Delivery API returns it in assets[]. */
|
|
6641
|
+
credit: string | null;
|
|
6642
|
+
/** @description Where the file came from (the stock photo's page, the original source); filled automatically by media.import_stock. Public like credit. */
|
|
6643
|
+
sourceUrl: string | null;
|
|
6556
6644
|
/** @description true when the owner excluded this image from the site watermark. */
|
|
6557
6645
|
watermarkExempt: boolean;
|
|
6558
6646
|
createdAt: string;
|
|
@@ -6876,6 +6964,10 @@ export interface operations {
|
|
|
6876
6964
|
edgeColor: string | null;
|
|
6877
6965
|
/** @description Default alt text, used when the place that shows the image has no alt of its own. */
|
|
6878
6966
|
altText: string | null;
|
|
6967
|
+
/** @description Credit line for the file (photographer or rights holder, for example "Jane Doe / Pexels"); filled automatically by media.import_stock. Public: the Content Delivery API returns it in assets[]. */
|
|
6968
|
+
credit: string | null;
|
|
6969
|
+
/** @description Where the file came from (the stock photo's page, the original source); filled automatically by media.import_stock. Public like credit. */
|
|
6970
|
+
sourceUrl: string | null;
|
|
6879
6971
|
/** @description true when the owner excluded this image from the site watermark. */
|
|
6880
6972
|
watermarkExempt: boolean;
|
|
6881
6973
|
createdAt: string;
|
|
@@ -7668,6 +7760,8 @@ export interface operations {
|
|
|
7668
7760
|
* "focus": null,
|
|
7669
7761
|
* "edgeColor": null,
|
|
7670
7762
|
* "altText": null,
|
|
7763
|
+
* "credit": null,
|
|
7764
|
+
* "sourceUrl": null,
|
|
7671
7765
|
* "watermarkExempt": false,
|
|
7672
7766
|
* "createdAt": "2026-10-01T02:30:00.000Z"
|
|
7673
7767
|
* }
|
|
@@ -7840,6 +7934,10 @@ export interface operations {
|
|
|
7840
7934
|
edgeColor: string | null;
|
|
7841
7935
|
/** @description Default alt text, used when the place that shows the image has no alt of its own. */
|
|
7842
7936
|
altText: string | null;
|
|
7937
|
+
/** @description Credit line for the file (photographer or rights holder, for example "Jane Doe / Pexels"); filled automatically by media.import_stock. Public: the Content Delivery API returns it in assets[]. */
|
|
7938
|
+
credit: string | null;
|
|
7939
|
+
/** @description Where the file came from (the stock photo's page, the original source); filled automatically by media.import_stock. Public like credit. */
|
|
7940
|
+
sourceUrl: string | null;
|
|
7843
7941
|
/** @description true when the owner excluded this image from the site watermark. */
|
|
7844
7942
|
watermarkExempt: boolean;
|
|
7845
7943
|
createdAt: string;
|
|
@@ -8289,6 +8387,8 @@ export interface operations {
|
|
|
8289
8387
|
* "focus": null,
|
|
8290
8388
|
* "edgeColor": null,
|
|
8291
8389
|
* "altText": null,
|
|
8390
|
+
* "credit": null,
|
|
8391
|
+
* "sourceUrl": null,
|
|
8292
8392
|
* "watermarkExempt": false,
|
|
8293
8393
|
* "createdAt": "2026-10-01T02:30:00.000Z"
|
|
8294
8394
|
* }
|
|
@@ -8370,6 +8470,10 @@ export interface operations {
|
|
|
8370
8470
|
edgeColor: string | null;
|
|
8371
8471
|
/** @description Default alt text, used when the place that shows the image has no alt of its own. */
|
|
8372
8472
|
altText: string | null;
|
|
8473
|
+
/** @description Credit line for the file (photographer or rights holder, for example "Jane Doe / Pexels"); filled automatically by media.import_stock. Public: the Content Delivery API returns it in assets[]. */
|
|
8474
|
+
credit: string | null;
|
|
8475
|
+
/** @description Where the file came from (the stock photo's page, the original source); filled automatically by media.import_stock. Public like credit. */
|
|
8476
|
+
sourceUrl: string | null;
|
|
8373
8477
|
/** @description true when the owner excluded this image from the site watermark. */
|
|
8374
8478
|
watermarkExempt: boolean;
|
|
8375
8479
|
createdAt: string;
|
|
@@ -9071,6 +9175,8 @@ export interface operations {
|
|
|
9071
9175
|
* "focus": null,
|
|
9072
9176
|
* "edgeColor": null,
|
|
9073
9177
|
* "altText": null,
|
|
9178
|
+
* "credit": null,
|
|
9179
|
+
* "sourceUrl": null,
|
|
9074
9180
|
* "watermarkExempt": false,
|
|
9075
9181
|
* "createdAt": "2026-10-01T02:30:00.000Z"
|
|
9076
9182
|
* }
|
|
@@ -9267,6 +9373,10 @@ export interface operations {
|
|
|
9267
9373
|
edgeColor: string | null;
|
|
9268
9374
|
/** @description Default alt text, used when the place that shows the image has no alt of its own. */
|
|
9269
9375
|
altText: string | null;
|
|
9376
|
+
/** @description Credit line for the file (photographer or rights holder, for example "Jane Doe / Pexels"); filled automatically by media.import_stock. Public: the Content Delivery API returns it in assets[]. */
|
|
9377
|
+
credit: string | null;
|
|
9378
|
+
/** @description Where the file came from (the stock photo's page, the original source); filled automatically by media.import_stock. Public like credit. */
|
|
9379
|
+
sourceUrl: string | null;
|
|
9270
9380
|
/** @description true when the owner excluded this image from the site watermark. */
|
|
9271
9381
|
watermarkExempt: boolean;
|
|
9272
9382
|
createdAt: string;
|
|
@@ -10226,6 +10336,8 @@ export interface operations {
|
|
|
10226
10336
|
* "focus": null,
|
|
10227
10337
|
* "edgeColor": null,
|
|
10228
10338
|
* "altText": null,
|
|
10339
|
+
* "credit": null,
|
|
10340
|
+
* "sourceUrl": null,
|
|
10229
10341
|
* "watermarkExempt": false,
|
|
10230
10342
|
* "createdAt": "2026-10-01T02:30:00.000Z"
|
|
10231
10343
|
* }
|
|
@@ -10416,6 +10528,10 @@ export interface operations {
|
|
|
10416
10528
|
edgeColor: string | null;
|
|
10417
10529
|
/** @description Default alt text, used when the place that shows the image has no alt of its own. */
|
|
10418
10530
|
altText: string | null;
|
|
10531
|
+
/** @description Credit line for the file (photographer or rights holder, for example "Jane Doe / Pexels"); filled automatically by media.import_stock. Public: the Content Delivery API returns it in assets[]. */
|
|
10532
|
+
credit: string | null;
|
|
10533
|
+
/** @description Where the file came from (the stock photo's page, the original source); filled automatically by media.import_stock. Public like credit. */
|
|
10534
|
+
sourceUrl: string | null;
|
|
10419
10535
|
/** @description true when the owner excluded this image from the site watermark. */
|
|
10420
10536
|
watermarkExempt: boolean;
|
|
10421
10537
|
createdAt: string;
|
|
@@ -10645,6 +10761,8 @@ export interface operations {
|
|
|
10645
10761
|
* "focus": null,
|
|
10646
10762
|
* "edgeColor": null,
|
|
10647
10763
|
* "altText": null,
|
|
10764
|
+
* "credit": null,
|
|
10765
|
+
* "sourceUrl": null,
|
|
10648
10766
|
* "watermarkExempt": false,
|
|
10649
10767
|
* "createdAt": "2026-10-01T02:30:00.000Z"
|
|
10650
10768
|
* }
|
|
@@ -10835,6 +10953,10 @@ export interface operations {
|
|
|
10835
10953
|
edgeColor: string | null;
|
|
10836
10954
|
/** @description Default alt text, used when the place that shows the image has no alt of its own. */
|
|
10837
10955
|
altText: string | null;
|
|
10956
|
+
/** @description Credit line for the file (photographer or rights holder, for example "Jane Doe / Pexels"); filled automatically by media.import_stock. Public: the Content Delivery API returns it in assets[]. */
|
|
10957
|
+
credit: string | null;
|
|
10958
|
+
/** @description Where the file came from (the stock photo's page, the original source); filled automatically by media.import_stock. Public like credit. */
|
|
10959
|
+
sourceUrl: string | null;
|
|
10838
10960
|
/** @description true when the owner excluded this image from the site watermark. */
|
|
10839
10961
|
watermarkExempt: boolean;
|
|
10840
10962
|
createdAt: string;
|
|
@@ -10989,6 +11111,8 @@ export interface operations {
|
|
|
10989
11111
|
* "focus": null,
|
|
10990
11112
|
* "edgeColor": null,
|
|
10991
11113
|
* "altText": null,
|
|
11114
|
+
* "credit": null,
|
|
11115
|
+
* "sourceUrl": null,
|
|
10992
11116
|
* "watermarkExempt": false,
|
|
10993
11117
|
* "createdAt": "2026-10-01T02:30:00.000Z"
|
|
10994
11118
|
* }
|
|
@@ -11180,6 +11304,10 @@ export interface operations {
|
|
|
11180
11304
|
edgeColor: string | null;
|
|
11181
11305
|
/** @description Default alt text, used when the place that shows the image has no alt of its own. */
|
|
11182
11306
|
altText: string | null;
|
|
11307
|
+
/** @description Credit line for the file (photographer or rights holder, for example "Jane Doe / Pexels"); filled automatically by media.import_stock. Public: the Content Delivery API returns it in assets[]. */
|
|
11308
|
+
credit: string | null;
|
|
11309
|
+
/** @description Where the file came from (the stock photo's page, the original source); filled automatically by media.import_stock. Public like credit. */
|
|
11310
|
+
sourceUrl: string | null;
|
|
11183
11311
|
/** @description true when the owner excluded this image from the site watermark. */
|
|
11184
11312
|
watermarkExempt: boolean;
|
|
11185
11313
|
createdAt: string;
|
|
@@ -11326,6 +11454,8 @@ export interface operations {
|
|
|
11326
11454
|
* "focus": null,
|
|
11327
11455
|
* "edgeColor": null,
|
|
11328
11456
|
* "altText": null,
|
|
11457
|
+
* "credit": null,
|
|
11458
|
+
* "sourceUrl": null,
|
|
11329
11459
|
* "watermarkExempt": false,
|
|
11330
11460
|
* "createdAt": "2026-10-01T02:30:00.000Z"
|
|
11331
11461
|
* }
|
|
@@ -11516,6 +11646,10 @@ export interface operations {
|
|
|
11516
11646
|
edgeColor: string | null;
|
|
11517
11647
|
/** @description Default alt text, used when the place that shows the image has no alt of its own. */
|
|
11518
11648
|
altText: string | null;
|
|
11649
|
+
/** @description Credit line for the file (photographer or rights holder, for example "Jane Doe / Pexels"); filled automatically by media.import_stock. Public: the Content Delivery API returns it in assets[]. */
|
|
11650
|
+
credit: string | null;
|
|
11651
|
+
/** @description Where the file came from (the stock photo's page, the original source); filled automatically by media.import_stock. Public like credit. */
|
|
11652
|
+
sourceUrl: string | null;
|
|
11519
11653
|
/** @description true when the owner excluded this image from the site watermark. */
|
|
11520
11654
|
watermarkExempt: boolean;
|
|
11521
11655
|
createdAt: string;
|
|
@@ -11658,6 +11792,8 @@ export interface operations {
|
|
|
11658
11792
|
* "focus": null,
|
|
11659
11793
|
* "edgeColor": null,
|
|
11660
11794
|
* "altText": null,
|
|
11795
|
+
* "credit": null,
|
|
11796
|
+
* "sourceUrl": null,
|
|
11661
11797
|
* "watermarkExempt": false,
|
|
11662
11798
|
* "createdAt": "2026-10-01T02:30:00.000Z"
|
|
11663
11799
|
* }
|
|
@@ -11848,6 +11984,10 @@ export interface operations {
|
|
|
11848
11984
|
edgeColor: string | null;
|
|
11849
11985
|
/** @description Default alt text, used when the place that shows the image has no alt of its own. */
|
|
11850
11986
|
altText: string | null;
|
|
11987
|
+
/** @description Credit line for the file (photographer or rights holder, for example "Jane Doe / Pexels"); filled automatically by media.import_stock. Public: the Content Delivery API returns it in assets[]. */
|
|
11988
|
+
credit: string | null;
|
|
11989
|
+
/** @description Where the file came from (the stock photo's page, the original source); filled automatically by media.import_stock. Public like credit. */
|
|
11990
|
+
sourceUrl: string | null;
|
|
11851
11991
|
/** @description true when the owner excluded this image from the site watermark. */
|
|
11852
11992
|
watermarkExempt: boolean;
|
|
11853
11993
|
createdAt: string;
|
|
@@ -12001,6 +12141,8 @@ export interface operations {
|
|
|
12001
12141
|
* "focus": null,
|
|
12002
12142
|
* "edgeColor": null,
|
|
12003
12143
|
* "altText": null,
|
|
12144
|
+
* "credit": null,
|
|
12145
|
+
* "sourceUrl": null,
|
|
12004
12146
|
* "watermarkExempt": false,
|
|
12005
12147
|
* "createdAt": "2026-10-01T02:30:00.000Z"
|
|
12006
12148
|
* }
|
|
@@ -12191,6 +12333,10 @@ export interface operations {
|
|
|
12191
12333
|
edgeColor: string | null;
|
|
12192
12334
|
/** @description Default alt text, used when the place that shows the image has no alt of its own. */
|
|
12193
12335
|
altText: string | null;
|
|
12336
|
+
/** @description Credit line for the file (photographer or rights holder, for example "Jane Doe / Pexels"); filled automatically by media.import_stock. Public: the Content Delivery API returns it in assets[]. */
|
|
12337
|
+
credit: string | null;
|
|
12338
|
+
/** @description Where the file came from (the stock photo's page, the original source); filled automatically by media.import_stock. Public like credit. */
|
|
12339
|
+
sourceUrl: string | null;
|
|
12194
12340
|
/** @description true when the owner excluded this image from the site watermark. */
|
|
12195
12341
|
watermarkExempt: boolean;
|
|
12196
12342
|
createdAt: string;
|
|
@@ -12333,6 +12479,8 @@ export interface operations {
|
|
|
12333
12479
|
* "focus": null,
|
|
12334
12480
|
* "edgeColor": null,
|
|
12335
12481
|
* "altText": null,
|
|
12482
|
+
* "credit": null,
|
|
12483
|
+
* "sourceUrl": null,
|
|
12336
12484
|
* "watermarkExempt": false,
|
|
12337
12485
|
* "createdAt": "2026-10-01T02:30:00.000Z"
|
|
12338
12486
|
* }
|
|
@@ -12523,6 +12671,10 @@ export interface operations {
|
|
|
12523
12671
|
edgeColor: string | null;
|
|
12524
12672
|
/** @description Default alt text, used when the place that shows the image has no alt of its own. */
|
|
12525
12673
|
altText: string | null;
|
|
12674
|
+
/** @description Credit line for the file (photographer or rights holder, for example "Jane Doe / Pexels"); filled automatically by media.import_stock. Public: the Content Delivery API returns it in assets[]. */
|
|
12675
|
+
credit: string | null;
|
|
12676
|
+
/** @description Where the file came from (the stock photo's page, the original source); filled automatically by media.import_stock. Public like credit. */
|
|
12677
|
+
sourceUrl: string | null;
|
|
12526
12678
|
/** @description true when the owner excluded this image from the site watermark. */
|
|
12527
12679
|
watermarkExempt: boolean;
|
|
12528
12680
|
createdAt: string;
|
|
@@ -13095,6 +13247,8 @@ export interface operations {
|
|
|
13095
13247
|
* ]
|
|
13096
13248
|
* },
|
|
13097
13249
|
* "pathTemplate": "/teachers/{slug}",
|
|
13250
|
+
* "previewUrlTemplate": null,
|
|
13251
|
+
* "singleton": false,
|
|
13098
13252
|
* "createdBy": {
|
|
13099
13253
|
* "kind": "agent",
|
|
13100
13254
|
* "actorId": "user_example01",
|
|
@@ -13124,6 +13278,8 @@ export interface operations {
|
|
|
13124
13278
|
* "accessPolicy": null,
|
|
13125
13279
|
* "search": null,
|
|
13126
13280
|
* "pathTemplate": "/teachers/{slug}",
|
|
13281
|
+
* "previewUrlTemplate": null,
|
|
13282
|
+
* "singleton": false,
|
|
13127
13283
|
* "createdBy": {
|
|
13128
13284
|
* "kind": "agent",
|
|
13129
13285
|
* "actorId": "user_example01",
|
|
@@ -13160,6 +13316,8 @@ export interface operations {
|
|
|
13160
13316
|
aiHint?: string;
|
|
13161
13317
|
system?: boolean;
|
|
13162
13318
|
indexed?: boolean;
|
|
13319
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
13320
|
+
localized?: boolean;
|
|
13163
13321
|
unique?: boolean;
|
|
13164
13322
|
/** @constant */
|
|
13165
13323
|
type: "text";
|
|
@@ -13167,7 +13325,6 @@ export interface operations {
|
|
|
13167
13325
|
max?: number;
|
|
13168
13326
|
pattern?: string;
|
|
13169
13327
|
default?: string;
|
|
13170
|
-
localized?: boolean;
|
|
13171
13328
|
} | {
|
|
13172
13329
|
id: string;
|
|
13173
13330
|
name: string;
|
|
@@ -13177,10 +13334,11 @@ export interface operations {
|
|
|
13177
13334
|
aiHint?: string;
|
|
13178
13335
|
system?: boolean;
|
|
13179
13336
|
indexed?: boolean;
|
|
13337
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
13338
|
+
localized?: boolean;
|
|
13180
13339
|
/** @constant */
|
|
13181
13340
|
type: "rich_text";
|
|
13182
13341
|
max?: number;
|
|
13183
|
-
localized?: boolean;
|
|
13184
13342
|
} | {
|
|
13185
13343
|
id: string;
|
|
13186
13344
|
name: string;
|
|
@@ -13190,6 +13348,8 @@ export interface operations {
|
|
|
13190
13348
|
aiHint?: string;
|
|
13191
13349
|
system?: boolean;
|
|
13192
13350
|
indexed?: boolean;
|
|
13351
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
13352
|
+
localized?: boolean;
|
|
13193
13353
|
unique?: boolean;
|
|
13194
13354
|
/** @constant */
|
|
13195
13355
|
type: "email";
|
|
@@ -13203,6 +13363,8 @@ export interface operations {
|
|
|
13203
13363
|
aiHint?: string;
|
|
13204
13364
|
system?: boolean;
|
|
13205
13365
|
indexed?: boolean;
|
|
13366
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
13367
|
+
localized?: boolean;
|
|
13206
13368
|
unique?: boolean;
|
|
13207
13369
|
/** @constant */
|
|
13208
13370
|
type: "phone";
|
|
@@ -13216,6 +13378,8 @@ export interface operations {
|
|
|
13216
13378
|
aiHint?: string;
|
|
13217
13379
|
system?: boolean;
|
|
13218
13380
|
indexed?: boolean;
|
|
13381
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
13382
|
+
localized?: boolean;
|
|
13219
13383
|
unique?: boolean;
|
|
13220
13384
|
/** @constant */
|
|
13221
13385
|
type: "url";
|
|
@@ -13229,6 +13393,8 @@ export interface operations {
|
|
|
13229
13393
|
aiHint?: string;
|
|
13230
13394
|
system?: boolean;
|
|
13231
13395
|
indexed?: boolean;
|
|
13396
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
13397
|
+
localized?: boolean;
|
|
13232
13398
|
/** @constant */
|
|
13233
13399
|
type: "video_url";
|
|
13234
13400
|
} | {
|
|
@@ -13240,6 +13406,8 @@ export interface operations {
|
|
|
13240
13406
|
aiHint?: string;
|
|
13241
13407
|
system?: boolean;
|
|
13242
13408
|
indexed?: boolean;
|
|
13409
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
13410
|
+
localized?: boolean;
|
|
13243
13411
|
unique?: boolean;
|
|
13244
13412
|
/** @constant */
|
|
13245
13413
|
type: "number";
|
|
@@ -13256,6 +13424,8 @@ export interface operations {
|
|
|
13256
13424
|
aiHint?: string;
|
|
13257
13425
|
system?: boolean;
|
|
13258
13426
|
indexed?: boolean;
|
|
13427
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
13428
|
+
localized?: boolean;
|
|
13259
13429
|
/** @constant */
|
|
13260
13430
|
type: "boolean";
|
|
13261
13431
|
default?: boolean;
|
|
@@ -13268,6 +13438,8 @@ export interface operations {
|
|
|
13268
13438
|
aiHint?: string;
|
|
13269
13439
|
system?: boolean;
|
|
13270
13440
|
indexed?: boolean;
|
|
13441
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
13442
|
+
localized?: boolean;
|
|
13271
13443
|
/** @constant */
|
|
13272
13444
|
type: "date";
|
|
13273
13445
|
min?: string;
|
|
@@ -13282,6 +13454,8 @@ export interface operations {
|
|
|
13282
13454
|
aiHint?: string;
|
|
13283
13455
|
system?: boolean;
|
|
13284
13456
|
indexed?: boolean;
|
|
13457
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
13458
|
+
localized?: boolean;
|
|
13285
13459
|
/** @constant */
|
|
13286
13460
|
type: "datetime";
|
|
13287
13461
|
min?: string;
|
|
@@ -13296,6 +13470,8 @@ export interface operations {
|
|
|
13296
13470
|
aiHint?: string;
|
|
13297
13471
|
system?: boolean;
|
|
13298
13472
|
indexed?: boolean;
|
|
13473
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
13474
|
+
localized?: boolean;
|
|
13299
13475
|
/** @constant */
|
|
13300
13476
|
type: "select";
|
|
13301
13477
|
options: {
|
|
@@ -13313,6 +13489,8 @@ export interface operations {
|
|
|
13313
13489
|
aiHint?: string;
|
|
13314
13490
|
system?: boolean;
|
|
13315
13491
|
indexed?: boolean;
|
|
13492
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
13493
|
+
localized?: boolean;
|
|
13316
13494
|
/** @constant */
|
|
13317
13495
|
type: "multi_select";
|
|
13318
13496
|
options: {
|
|
@@ -13332,6 +13510,8 @@ export interface operations {
|
|
|
13332
13510
|
aiHint?: string;
|
|
13333
13511
|
system?: boolean;
|
|
13334
13512
|
indexed?: boolean;
|
|
13513
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
13514
|
+
localized?: boolean;
|
|
13335
13515
|
/** @constant */
|
|
13336
13516
|
type: "color";
|
|
13337
13517
|
default?: string;
|
|
@@ -13344,6 +13524,8 @@ export interface operations {
|
|
|
13344
13524
|
aiHint?: string;
|
|
13345
13525
|
system?: boolean;
|
|
13346
13526
|
indexed?: boolean;
|
|
13527
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
13528
|
+
localized?: boolean;
|
|
13347
13529
|
/** @constant */
|
|
13348
13530
|
type: "image";
|
|
13349
13531
|
} | {
|
|
@@ -13355,6 +13537,8 @@ export interface operations {
|
|
|
13355
13537
|
aiHint?: string;
|
|
13356
13538
|
system?: boolean;
|
|
13357
13539
|
indexed?: boolean;
|
|
13540
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
13541
|
+
localized?: boolean;
|
|
13358
13542
|
/** @constant */
|
|
13359
13543
|
type: "gallery";
|
|
13360
13544
|
min?: number;
|
|
@@ -13368,6 +13552,8 @@ export interface operations {
|
|
|
13368
13552
|
aiHint?: string;
|
|
13369
13553
|
system?: boolean;
|
|
13370
13554
|
indexed?: boolean;
|
|
13555
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
13556
|
+
localized?: boolean;
|
|
13371
13557
|
/** @constant */
|
|
13372
13558
|
type: "file";
|
|
13373
13559
|
} | {
|
|
@@ -13379,6 +13565,8 @@ export interface operations {
|
|
|
13379
13565
|
aiHint?: string;
|
|
13380
13566
|
system?: boolean;
|
|
13381
13567
|
indexed?: boolean;
|
|
13568
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
13569
|
+
localized?: boolean;
|
|
13382
13570
|
/** @constant */
|
|
13383
13571
|
type: "reference";
|
|
13384
13572
|
targetCollectionKey: string;
|
|
@@ -13391,6 +13579,8 @@ export interface operations {
|
|
|
13391
13579
|
aiHint?: string;
|
|
13392
13580
|
system?: boolean;
|
|
13393
13581
|
indexed?: boolean;
|
|
13582
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
13583
|
+
localized?: boolean;
|
|
13394
13584
|
/** @constant */
|
|
13395
13585
|
type: "multi_reference";
|
|
13396
13586
|
targetCollectionKey: string;
|
|
@@ -13405,8 +13595,14 @@ export interface operations {
|
|
|
13405
13595
|
aiHint?: string;
|
|
13406
13596
|
system?: boolean;
|
|
13407
13597
|
indexed?: boolean;
|
|
13598
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
13599
|
+
localized?: boolean;
|
|
13408
13600
|
/** @constant */
|
|
13409
13601
|
type: "json";
|
|
13602
|
+
/** @description JSON Schema (a subset of draft 2020-12) the value must match. Keywords: type, enum, const, properties, required, additionalProperties, minProperties, maxProperties, items, minItems, maxItems, uniqueItems, minLength, maxLength, pattern, format (date, date-time, email, uri), minimum, maximum, exclusiveMinimum, exclusiveMaximum, multipleOf, anyOf, oneOf; title, description, examples, default and $comment are annotations. Other keywords, $ref included, are rejected. Up to 16 KB and 10 levels of nesting. Writes are validated against it (VALIDATION with code json_schema and the path of each problem), and kanorio types generates the value's TypeScript type from it. An empty value (null, an empty string or an empty array) is stored as null and not checked; use required to demand a value. */
|
|
13603
|
+
schema?: {
|
|
13604
|
+
[key: string]: unknown;
|
|
13605
|
+
};
|
|
13410
13606
|
})[];
|
|
13411
13607
|
titleFieldId: string;
|
|
13412
13608
|
/** @description Field-level read policy for the Content Delivery API: gatedFields are stripped on anonymous requests (returning top-level access summary) and unlocked when a Customer Access Token (knr_cat_) satisfies requires (customer login or an active entitlement featureKey). */
|
|
@@ -13429,6 +13625,10 @@ export interface operations {
|
|
|
13429
13625
|
} | null;
|
|
13430
13626
|
/** @description Public address of the collection's items on the site, e.g. /tours/{slug}. When set, every published item is treated as a page: it is listed in sitemap.xml and GET /api/v1/seo/sitemap, search engines are notified when it is published or unpublished, and site-search hits carry its url. null = items are data only and have no page of their own. */
|
|
13431
13627
|
pathTemplate: string | null;
|
|
13628
|
+
/** @description Where the dashboard's Preview button on an item opens (a path on the site's front end or a full https URL, with {slug}, {id} or {fieldId} placeholders). null = Preview uses pathTemplate; with neither, items have no Preview button. */
|
|
13629
|
+
previewUrlTemplate: string | null;
|
|
13630
|
+
/** @description true = a single-item collection (site settings, homepage content): at most one item outside the trash, served by the Content Delivery API at GET /api/v1/collections/{key}/item. Create the item once with items.create, then change it with items.update. */
|
|
13631
|
+
singleton: boolean;
|
|
13432
13632
|
createdBy: {
|
|
13433
13633
|
/** @enum {string} */
|
|
13434
13634
|
kind: "agent" | "user";
|
|
@@ -13547,6 +13747,8 @@ export interface operations {
|
|
|
13547
13747
|
aiHint?: string;
|
|
13548
13748
|
system?: boolean;
|
|
13549
13749
|
indexed?: boolean;
|
|
13750
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
13751
|
+
localized?: boolean;
|
|
13550
13752
|
unique?: boolean;
|
|
13551
13753
|
/** @constant */
|
|
13552
13754
|
type: "text";
|
|
@@ -13554,7 +13756,6 @@ export interface operations {
|
|
|
13554
13756
|
max?: number;
|
|
13555
13757
|
pattern?: string;
|
|
13556
13758
|
default?: string;
|
|
13557
|
-
localized?: boolean;
|
|
13558
13759
|
} | {
|
|
13559
13760
|
id: string;
|
|
13560
13761
|
name: string;
|
|
@@ -13564,10 +13765,11 @@ export interface operations {
|
|
|
13564
13765
|
aiHint?: string;
|
|
13565
13766
|
system?: boolean;
|
|
13566
13767
|
indexed?: boolean;
|
|
13768
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
13769
|
+
localized?: boolean;
|
|
13567
13770
|
/** @constant */
|
|
13568
13771
|
type: "rich_text";
|
|
13569
13772
|
max?: number;
|
|
13570
|
-
localized?: boolean;
|
|
13571
13773
|
} | {
|
|
13572
13774
|
id: string;
|
|
13573
13775
|
name: string;
|
|
@@ -13577,6 +13779,8 @@ export interface operations {
|
|
|
13577
13779
|
aiHint?: string;
|
|
13578
13780
|
system?: boolean;
|
|
13579
13781
|
indexed?: boolean;
|
|
13782
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
13783
|
+
localized?: boolean;
|
|
13580
13784
|
unique?: boolean;
|
|
13581
13785
|
/** @constant */
|
|
13582
13786
|
type: "email";
|
|
@@ -13590,6 +13794,8 @@ export interface operations {
|
|
|
13590
13794
|
aiHint?: string;
|
|
13591
13795
|
system?: boolean;
|
|
13592
13796
|
indexed?: boolean;
|
|
13797
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
13798
|
+
localized?: boolean;
|
|
13593
13799
|
unique?: boolean;
|
|
13594
13800
|
/** @constant */
|
|
13595
13801
|
type: "phone";
|
|
@@ -13603,6 +13809,8 @@ export interface operations {
|
|
|
13603
13809
|
aiHint?: string;
|
|
13604
13810
|
system?: boolean;
|
|
13605
13811
|
indexed?: boolean;
|
|
13812
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
13813
|
+
localized?: boolean;
|
|
13606
13814
|
unique?: boolean;
|
|
13607
13815
|
/** @constant */
|
|
13608
13816
|
type: "url";
|
|
@@ -13616,6 +13824,8 @@ export interface operations {
|
|
|
13616
13824
|
aiHint?: string;
|
|
13617
13825
|
system?: boolean;
|
|
13618
13826
|
indexed?: boolean;
|
|
13827
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
13828
|
+
localized?: boolean;
|
|
13619
13829
|
/** @constant */
|
|
13620
13830
|
type: "video_url";
|
|
13621
13831
|
} | {
|
|
@@ -13627,6 +13837,8 @@ export interface operations {
|
|
|
13627
13837
|
aiHint?: string;
|
|
13628
13838
|
system?: boolean;
|
|
13629
13839
|
indexed?: boolean;
|
|
13840
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
13841
|
+
localized?: boolean;
|
|
13630
13842
|
unique?: boolean;
|
|
13631
13843
|
/** @constant */
|
|
13632
13844
|
type: "number";
|
|
@@ -13643,6 +13855,8 @@ export interface operations {
|
|
|
13643
13855
|
aiHint?: string;
|
|
13644
13856
|
system?: boolean;
|
|
13645
13857
|
indexed?: boolean;
|
|
13858
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
13859
|
+
localized?: boolean;
|
|
13646
13860
|
/** @constant */
|
|
13647
13861
|
type: "boolean";
|
|
13648
13862
|
default?: boolean;
|
|
@@ -13655,6 +13869,8 @@ export interface operations {
|
|
|
13655
13869
|
aiHint?: string;
|
|
13656
13870
|
system?: boolean;
|
|
13657
13871
|
indexed?: boolean;
|
|
13872
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
13873
|
+
localized?: boolean;
|
|
13658
13874
|
/** @constant */
|
|
13659
13875
|
type: "date";
|
|
13660
13876
|
min?: string;
|
|
@@ -13669,6 +13885,8 @@ export interface operations {
|
|
|
13669
13885
|
aiHint?: string;
|
|
13670
13886
|
system?: boolean;
|
|
13671
13887
|
indexed?: boolean;
|
|
13888
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
13889
|
+
localized?: boolean;
|
|
13672
13890
|
/** @constant */
|
|
13673
13891
|
type: "datetime";
|
|
13674
13892
|
min?: string;
|
|
@@ -13683,6 +13901,8 @@ export interface operations {
|
|
|
13683
13901
|
aiHint?: string;
|
|
13684
13902
|
system?: boolean;
|
|
13685
13903
|
indexed?: boolean;
|
|
13904
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
13905
|
+
localized?: boolean;
|
|
13686
13906
|
/** @constant */
|
|
13687
13907
|
type: "select";
|
|
13688
13908
|
options: {
|
|
@@ -13700,6 +13920,8 @@ export interface operations {
|
|
|
13700
13920
|
aiHint?: string;
|
|
13701
13921
|
system?: boolean;
|
|
13702
13922
|
indexed?: boolean;
|
|
13923
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
13924
|
+
localized?: boolean;
|
|
13703
13925
|
/** @constant */
|
|
13704
13926
|
type: "multi_select";
|
|
13705
13927
|
options: {
|
|
@@ -13719,6 +13941,8 @@ export interface operations {
|
|
|
13719
13941
|
aiHint?: string;
|
|
13720
13942
|
system?: boolean;
|
|
13721
13943
|
indexed?: boolean;
|
|
13944
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
13945
|
+
localized?: boolean;
|
|
13722
13946
|
/** @constant */
|
|
13723
13947
|
type: "color";
|
|
13724
13948
|
default?: string;
|
|
@@ -13731,6 +13955,8 @@ export interface operations {
|
|
|
13731
13955
|
aiHint?: string;
|
|
13732
13956
|
system?: boolean;
|
|
13733
13957
|
indexed?: boolean;
|
|
13958
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
13959
|
+
localized?: boolean;
|
|
13734
13960
|
/** @constant */
|
|
13735
13961
|
type: "image";
|
|
13736
13962
|
} | {
|
|
@@ -13742,6 +13968,8 @@ export interface operations {
|
|
|
13742
13968
|
aiHint?: string;
|
|
13743
13969
|
system?: boolean;
|
|
13744
13970
|
indexed?: boolean;
|
|
13971
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
13972
|
+
localized?: boolean;
|
|
13745
13973
|
/** @constant */
|
|
13746
13974
|
type: "gallery";
|
|
13747
13975
|
min?: number;
|
|
@@ -13755,6 +13983,8 @@ export interface operations {
|
|
|
13755
13983
|
aiHint?: string;
|
|
13756
13984
|
system?: boolean;
|
|
13757
13985
|
indexed?: boolean;
|
|
13986
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
13987
|
+
localized?: boolean;
|
|
13758
13988
|
/** @constant */
|
|
13759
13989
|
type: "file";
|
|
13760
13990
|
} | {
|
|
@@ -13766,6 +13996,8 @@ export interface operations {
|
|
|
13766
13996
|
aiHint?: string;
|
|
13767
13997
|
system?: boolean;
|
|
13768
13998
|
indexed?: boolean;
|
|
13999
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
14000
|
+
localized?: boolean;
|
|
13769
14001
|
/** @constant */
|
|
13770
14002
|
type: "reference";
|
|
13771
14003
|
targetCollectionKey: string;
|
|
@@ -13778,6 +14010,8 @@ export interface operations {
|
|
|
13778
14010
|
aiHint?: string;
|
|
13779
14011
|
system?: boolean;
|
|
13780
14012
|
indexed?: boolean;
|
|
14013
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
14014
|
+
localized?: boolean;
|
|
13781
14015
|
/** @constant */
|
|
13782
14016
|
type: "multi_reference";
|
|
13783
14017
|
targetCollectionKey: string;
|
|
@@ -13792,8 +14026,14 @@ export interface operations {
|
|
|
13792
14026
|
aiHint?: string;
|
|
13793
14027
|
system?: boolean;
|
|
13794
14028
|
indexed?: boolean;
|
|
14029
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
14030
|
+
localized?: boolean;
|
|
13795
14031
|
/** @constant */
|
|
13796
14032
|
type: "json";
|
|
14033
|
+
/** @description JSON Schema (a subset of draft 2020-12) the value must match. Keywords: type, enum, const, properties, required, additionalProperties, minProperties, maxProperties, items, minItems, maxItems, uniqueItems, minLength, maxLength, pattern, format (date, date-time, email, uri), minimum, maximum, exclusiveMinimum, exclusiveMaximum, multipleOf, anyOf, oneOf; title, description, examples, default and $comment are annotations. Other keywords, $ref included, are rejected. Up to 16 KB and 10 levels of nesting. Writes are validated against it (VALIDATION with code json_schema and the path of each problem), and kanorio types generates the value's TypeScript type from it. An empty value (null, an empty string or an empty array) is stored as null and not checked; use required to demand a value. */
|
|
14034
|
+
schema?: {
|
|
14035
|
+
[key: string]: unknown;
|
|
14036
|
+
};
|
|
13797
14037
|
})[];
|
|
13798
14038
|
titleFieldId: string;
|
|
13799
14039
|
accessPolicy?: {
|
|
@@ -13813,6 +14053,9 @@ export interface operations {
|
|
|
13813
14053
|
pathTemplate?: string | null;
|
|
13814
14054
|
} | null;
|
|
13815
14055
|
pathTemplate?: string | null;
|
|
14056
|
+
previewUrlTemplate?: string | null;
|
|
14057
|
+
/** @description true makes this a single-item collection (site settings, homepage content): it holds at most one item outside the trash, and the Content Delivery API serves it at GET /api/v1/collections/{key}/item. The item counts toward the plan's item quota like any other. Turning it on is refused with SINGLETON_HAS_ITEMS while the collection has more than one item outside the trash. */
|
|
14058
|
+
singleton?: boolean;
|
|
13816
14059
|
};
|
|
13817
14060
|
};
|
|
13818
14061
|
};
|
|
@@ -13899,6 +14142,8 @@ export interface operations {
|
|
|
13899
14142
|
* ]
|
|
13900
14143
|
* },
|
|
13901
14144
|
* "pathTemplate": "/teachers/{slug}",
|
|
14145
|
+
* "previewUrlTemplate": null,
|
|
14146
|
+
* "singleton": false,
|
|
13902
14147
|
* "createdBy": {
|
|
13903
14148
|
* "kind": "agent",
|
|
13904
14149
|
* "actorId": "user_example01",
|
|
@@ -13940,6 +14185,8 @@ export interface operations {
|
|
|
13940
14185
|
aiHint?: string;
|
|
13941
14186
|
system?: boolean;
|
|
13942
14187
|
indexed?: boolean;
|
|
14188
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
14189
|
+
localized?: boolean;
|
|
13943
14190
|
unique?: boolean;
|
|
13944
14191
|
/** @constant */
|
|
13945
14192
|
type: "text";
|
|
@@ -13947,7 +14194,6 @@ export interface operations {
|
|
|
13947
14194
|
max?: number;
|
|
13948
14195
|
pattern?: string;
|
|
13949
14196
|
default?: string;
|
|
13950
|
-
localized?: boolean;
|
|
13951
14197
|
} | {
|
|
13952
14198
|
id: string;
|
|
13953
14199
|
name: string;
|
|
@@ -13957,10 +14203,11 @@ export interface operations {
|
|
|
13957
14203
|
aiHint?: string;
|
|
13958
14204
|
system?: boolean;
|
|
13959
14205
|
indexed?: boolean;
|
|
14206
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
14207
|
+
localized?: boolean;
|
|
13960
14208
|
/** @constant */
|
|
13961
14209
|
type: "rich_text";
|
|
13962
14210
|
max?: number;
|
|
13963
|
-
localized?: boolean;
|
|
13964
14211
|
} | {
|
|
13965
14212
|
id: string;
|
|
13966
14213
|
name: string;
|
|
@@ -13970,6 +14217,8 @@ export interface operations {
|
|
|
13970
14217
|
aiHint?: string;
|
|
13971
14218
|
system?: boolean;
|
|
13972
14219
|
indexed?: boolean;
|
|
14220
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
14221
|
+
localized?: boolean;
|
|
13973
14222
|
unique?: boolean;
|
|
13974
14223
|
/** @constant */
|
|
13975
14224
|
type: "email";
|
|
@@ -13983,6 +14232,8 @@ export interface operations {
|
|
|
13983
14232
|
aiHint?: string;
|
|
13984
14233
|
system?: boolean;
|
|
13985
14234
|
indexed?: boolean;
|
|
14235
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
14236
|
+
localized?: boolean;
|
|
13986
14237
|
unique?: boolean;
|
|
13987
14238
|
/** @constant */
|
|
13988
14239
|
type: "phone";
|
|
@@ -13996,6 +14247,8 @@ export interface operations {
|
|
|
13996
14247
|
aiHint?: string;
|
|
13997
14248
|
system?: boolean;
|
|
13998
14249
|
indexed?: boolean;
|
|
14250
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
14251
|
+
localized?: boolean;
|
|
13999
14252
|
unique?: boolean;
|
|
14000
14253
|
/** @constant */
|
|
14001
14254
|
type: "url";
|
|
@@ -14009,6 +14262,8 @@ export interface operations {
|
|
|
14009
14262
|
aiHint?: string;
|
|
14010
14263
|
system?: boolean;
|
|
14011
14264
|
indexed?: boolean;
|
|
14265
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
14266
|
+
localized?: boolean;
|
|
14012
14267
|
/** @constant */
|
|
14013
14268
|
type: "video_url";
|
|
14014
14269
|
} | {
|
|
@@ -14020,6 +14275,8 @@ export interface operations {
|
|
|
14020
14275
|
aiHint?: string;
|
|
14021
14276
|
system?: boolean;
|
|
14022
14277
|
indexed?: boolean;
|
|
14278
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
14279
|
+
localized?: boolean;
|
|
14023
14280
|
unique?: boolean;
|
|
14024
14281
|
/** @constant */
|
|
14025
14282
|
type: "number";
|
|
@@ -14036,6 +14293,8 @@ export interface operations {
|
|
|
14036
14293
|
aiHint?: string;
|
|
14037
14294
|
system?: boolean;
|
|
14038
14295
|
indexed?: boolean;
|
|
14296
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
14297
|
+
localized?: boolean;
|
|
14039
14298
|
/** @constant */
|
|
14040
14299
|
type: "boolean";
|
|
14041
14300
|
default?: boolean;
|
|
@@ -14048,6 +14307,8 @@ export interface operations {
|
|
|
14048
14307
|
aiHint?: string;
|
|
14049
14308
|
system?: boolean;
|
|
14050
14309
|
indexed?: boolean;
|
|
14310
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
14311
|
+
localized?: boolean;
|
|
14051
14312
|
/** @constant */
|
|
14052
14313
|
type: "date";
|
|
14053
14314
|
min?: string;
|
|
@@ -14062,6 +14323,8 @@ export interface operations {
|
|
|
14062
14323
|
aiHint?: string;
|
|
14063
14324
|
system?: boolean;
|
|
14064
14325
|
indexed?: boolean;
|
|
14326
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
14327
|
+
localized?: boolean;
|
|
14065
14328
|
/** @constant */
|
|
14066
14329
|
type: "datetime";
|
|
14067
14330
|
min?: string;
|
|
@@ -14076,6 +14339,8 @@ export interface operations {
|
|
|
14076
14339
|
aiHint?: string;
|
|
14077
14340
|
system?: boolean;
|
|
14078
14341
|
indexed?: boolean;
|
|
14342
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
14343
|
+
localized?: boolean;
|
|
14079
14344
|
/** @constant */
|
|
14080
14345
|
type: "select";
|
|
14081
14346
|
options: {
|
|
@@ -14093,6 +14358,8 @@ export interface operations {
|
|
|
14093
14358
|
aiHint?: string;
|
|
14094
14359
|
system?: boolean;
|
|
14095
14360
|
indexed?: boolean;
|
|
14361
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
14362
|
+
localized?: boolean;
|
|
14096
14363
|
/** @constant */
|
|
14097
14364
|
type: "multi_select";
|
|
14098
14365
|
options: {
|
|
@@ -14112,6 +14379,8 @@ export interface operations {
|
|
|
14112
14379
|
aiHint?: string;
|
|
14113
14380
|
system?: boolean;
|
|
14114
14381
|
indexed?: boolean;
|
|
14382
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
14383
|
+
localized?: boolean;
|
|
14115
14384
|
/** @constant */
|
|
14116
14385
|
type: "color";
|
|
14117
14386
|
default?: string;
|
|
@@ -14124,6 +14393,8 @@ export interface operations {
|
|
|
14124
14393
|
aiHint?: string;
|
|
14125
14394
|
system?: boolean;
|
|
14126
14395
|
indexed?: boolean;
|
|
14396
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
14397
|
+
localized?: boolean;
|
|
14127
14398
|
/** @constant */
|
|
14128
14399
|
type: "image";
|
|
14129
14400
|
} | {
|
|
@@ -14135,6 +14406,8 @@ export interface operations {
|
|
|
14135
14406
|
aiHint?: string;
|
|
14136
14407
|
system?: boolean;
|
|
14137
14408
|
indexed?: boolean;
|
|
14409
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
14410
|
+
localized?: boolean;
|
|
14138
14411
|
/** @constant */
|
|
14139
14412
|
type: "gallery";
|
|
14140
14413
|
min?: number;
|
|
@@ -14148,6 +14421,8 @@ export interface operations {
|
|
|
14148
14421
|
aiHint?: string;
|
|
14149
14422
|
system?: boolean;
|
|
14150
14423
|
indexed?: boolean;
|
|
14424
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
14425
|
+
localized?: boolean;
|
|
14151
14426
|
/** @constant */
|
|
14152
14427
|
type: "file";
|
|
14153
14428
|
} | {
|
|
@@ -14159,6 +14434,8 @@ export interface operations {
|
|
|
14159
14434
|
aiHint?: string;
|
|
14160
14435
|
system?: boolean;
|
|
14161
14436
|
indexed?: boolean;
|
|
14437
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
14438
|
+
localized?: boolean;
|
|
14162
14439
|
/** @constant */
|
|
14163
14440
|
type: "reference";
|
|
14164
14441
|
targetCollectionKey: string;
|
|
@@ -14171,6 +14448,8 @@ export interface operations {
|
|
|
14171
14448
|
aiHint?: string;
|
|
14172
14449
|
system?: boolean;
|
|
14173
14450
|
indexed?: boolean;
|
|
14451
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
14452
|
+
localized?: boolean;
|
|
14174
14453
|
/** @constant */
|
|
14175
14454
|
type: "multi_reference";
|
|
14176
14455
|
targetCollectionKey: string;
|
|
@@ -14185,8 +14464,14 @@ export interface operations {
|
|
|
14185
14464
|
aiHint?: string;
|
|
14186
14465
|
system?: boolean;
|
|
14187
14466
|
indexed?: boolean;
|
|
14467
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
14468
|
+
localized?: boolean;
|
|
14188
14469
|
/** @constant */
|
|
14189
14470
|
type: "json";
|
|
14471
|
+
/** @description JSON Schema (a subset of draft 2020-12) the value must match. Keywords: type, enum, const, properties, required, additionalProperties, minProperties, maxProperties, items, minItems, maxItems, uniqueItems, minLength, maxLength, pattern, format (date, date-time, email, uri), minimum, maximum, exclusiveMinimum, exclusiveMaximum, multipleOf, anyOf, oneOf; title, description, examples, default and $comment are annotations. Other keywords, $ref included, are rejected. Up to 16 KB and 10 levels of nesting. Writes are validated against it (VALIDATION with code json_schema and the path of each problem), and kanorio types generates the value's TypeScript type from it. An empty value (null, an empty string or an empty array) is stored as null and not checked; use required to demand a value. */
|
|
14472
|
+
schema?: {
|
|
14473
|
+
[key: string]: unknown;
|
|
14474
|
+
};
|
|
14190
14475
|
})[];
|
|
14191
14476
|
titleFieldId: string;
|
|
14192
14477
|
/** @description Field-level read policy for the Content Delivery API: gatedFields are stripped on anonymous requests (returning top-level access summary) and unlocked when a Customer Access Token (knr_cat_) satisfies requires (customer login or an active entitlement featureKey). */
|
|
@@ -14209,6 +14494,10 @@ export interface operations {
|
|
|
14209
14494
|
} | null;
|
|
14210
14495
|
/** @description Public address of the collection's items on the site, e.g. /tours/{slug}. When set, every published item is treated as a page: it is listed in sitemap.xml and GET /api/v1/seo/sitemap, search engines are notified when it is published or unpublished, and site-search hits carry its url. null = items are data only and have no page of their own. */
|
|
14211
14496
|
pathTemplate: string | null;
|
|
14497
|
+
/** @description Where the dashboard's Preview button on an item opens (a path on the site's front end or a full https URL, with {slug}, {id} or {fieldId} placeholders). null = Preview uses pathTemplate; with neither, items have no Preview button. */
|
|
14498
|
+
previewUrlTemplate: string | null;
|
|
14499
|
+
/** @description true = a single-item collection (site settings, homepage content): at most one item outside the trash, served by the Content Delivery API at GET /api/v1/collections/{key}/item. Create the item once with items.create, then change it with items.update. */
|
|
14500
|
+
singleton: boolean;
|
|
14212
14501
|
createdBy: {
|
|
14213
14502
|
/** @enum {string} */
|
|
14214
14503
|
kind: "agent" | "user";
|
|
@@ -14223,7 +14512,7 @@ export interface operations {
|
|
|
14223
14512
|
/** @description The site's public origin. */
|
|
14224
14513
|
baseUrl: string;
|
|
14225
14514
|
listUrl: string;
|
|
14226
|
-
/** @description Replace {slug} with an item's slug. */
|
|
14515
|
+
/** @description Replace {slug} with an item's slug. For a single-item collection this is the URL of its one item, with no slug. */
|
|
14227
14516
|
itemUrl: string;
|
|
14228
14517
|
schemaUrl: string;
|
|
14229
14518
|
/** @description Copy-paste JavaScript using fetch(). */
|
|
@@ -14339,6 +14628,8 @@ export interface operations {
|
|
|
14339
14628
|
* ]
|
|
14340
14629
|
* },
|
|
14341
14630
|
* "pathTemplate": "/teachers/{slug}",
|
|
14631
|
+
* "previewUrlTemplate": null,
|
|
14632
|
+
* "singleton": false,
|
|
14342
14633
|
* "createdBy": {
|
|
14343
14634
|
* "kind": "agent",
|
|
14344
14635
|
* "actorId": "user_example01",
|
|
@@ -14380,6 +14671,8 @@ export interface operations {
|
|
|
14380
14671
|
aiHint?: string;
|
|
14381
14672
|
system?: boolean;
|
|
14382
14673
|
indexed?: boolean;
|
|
14674
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
14675
|
+
localized?: boolean;
|
|
14383
14676
|
unique?: boolean;
|
|
14384
14677
|
/** @constant */
|
|
14385
14678
|
type: "text";
|
|
@@ -14387,7 +14680,6 @@ export interface operations {
|
|
|
14387
14680
|
max?: number;
|
|
14388
14681
|
pattern?: string;
|
|
14389
14682
|
default?: string;
|
|
14390
|
-
localized?: boolean;
|
|
14391
14683
|
} | {
|
|
14392
14684
|
id: string;
|
|
14393
14685
|
name: string;
|
|
@@ -14397,10 +14689,11 @@ export interface operations {
|
|
|
14397
14689
|
aiHint?: string;
|
|
14398
14690
|
system?: boolean;
|
|
14399
14691
|
indexed?: boolean;
|
|
14692
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
14693
|
+
localized?: boolean;
|
|
14400
14694
|
/** @constant */
|
|
14401
14695
|
type: "rich_text";
|
|
14402
14696
|
max?: number;
|
|
14403
|
-
localized?: boolean;
|
|
14404
14697
|
} | {
|
|
14405
14698
|
id: string;
|
|
14406
14699
|
name: string;
|
|
@@ -14410,6 +14703,8 @@ export interface operations {
|
|
|
14410
14703
|
aiHint?: string;
|
|
14411
14704
|
system?: boolean;
|
|
14412
14705
|
indexed?: boolean;
|
|
14706
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
14707
|
+
localized?: boolean;
|
|
14413
14708
|
unique?: boolean;
|
|
14414
14709
|
/** @constant */
|
|
14415
14710
|
type: "email";
|
|
@@ -14423,6 +14718,8 @@ export interface operations {
|
|
|
14423
14718
|
aiHint?: string;
|
|
14424
14719
|
system?: boolean;
|
|
14425
14720
|
indexed?: boolean;
|
|
14721
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
14722
|
+
localized?: boolean;
|
|
14426
14723
|
unique?: boolean;
|
|
14427
14724
|
/** @constant */
|
|
14428
14725
|
type: "phone";
|
|
@@ -14436,6 +14733,8 @@ export interface operations {
|
|
|
14436
14733
|
aiHint?: string;
|
|
14437
14734
|
system?: boolean;
|
|
14438
14735
|
indexed?: boolean;
|
|
14736
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
14737
|
+
localized?: boolean;
|
|
14439
14738
|
unique?: boolean;
|
|
14440
14739
|
/** @constant */
|
|
14441
14740
|
type: "url";
|
|
@@ -14449,6 +14748,8 @@ export interface operations {
|
|
|
14449
14748
|
aiHint?: string;
|
|
14450
14749
|
system?: boolean;
|
|
14451
14750
|
indexed?: boolean;
|
|
14751
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
14752
|
+
localized?: boolean;
|
|
14452
14753
|
/** @constant */
|
|
14453
14754
|
type: "video_url";
|
|
14454
14755
|
} | {
|
|
@@ -14460,6 +14761,8 @@ export interface operations {
|
|
|
14460
14761
|
aiHint?: string;
|
|
14461
14762
|
system?: boolean;
|
|
14462
14763
|
indexed?: boolean;
|
|
14764
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
14765
|
+
localized?: boolean;
|
|
14463
14766
|
unique?: boolean;
|
|
14464
14767
|
/** @constant */
|
|
14465
14768
|
type: "number";
|
|
@@ -14476,6 +14779,8 @@ export interface operations {
|
|
|
14476
14779
|
aiHint?: string;
|
|
14477
14780
|
system?: boolean;
|
|
14478
14781
|
indexed?: boolean;
|
|
14782
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
14783
|
+
localized?: boolean;
|
|
14479
14784
|
/** @constant */
|
|
14480
14785
|
type: "boolean";
|
|
14481
14786
|
default?: boolean;
|
|
@@ -14488,6 +14793,8 @@ export interface operations {
|
|
|
14488
14793
|
aiHint?: string;
|
|
14489
14794
|
system?: boolean;
|
|
14490
14795
|
indexed?: boolean;
|
|
14796
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
14797
|
+
localized?: boolean;
|
|
14491
14798
|
/** @constant */
|
|
14492
14799
|
type: "date";
|
|
14493
14800
|
min?: string;
|
|
@@ -14502,6 +14809,8 @@ export interface operations {
|
|
|
14502
14809
|
aiHint?: string;
|
|
14503
14810
|
system?: boolean;
|
|
14504
14811
|
indexed?: boolean;
|
|
14812
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
14813
|
+
localized?: boolean;
|
|
14505
14814
|
/** @constant */
|
|
14506
14815
|
type: "datetime";
|
|
14507
14816
|
min?: string;
|
|
@@ -14516,6 +14825,8 @@ export interface operations {
|
|
|
14516
14825
|
aiHint?: string;
|
|
14517
14826
|
system?: boolean;
|
|
14518
14827
|
indexed?: boolean;
|
|
14828
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
14829
|
+
localized?: boolean;
|
|
14519
14830
|
/** @constant */
|
|
14520
14831
|
type: "select";
|
|
14521
14832
|
options: {
|
|
@@ -14533,6 +14844,8 @@ export interface operations {
|
|
|
14533
14844
|
aiHint?: string;
|
|
14534
14845
|
system?: boolean;
|
|
14535
14846
|
indexed?: boolean;
|
|
14847
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
14848
|
+
localized?: boolean;
|
|
14536
14849
|
/** @constant */
|
|
14537
14850
|
type: "multi_select";
|
|
14538
14851
|
options: {
|
|
@@ -14552,6 +14865,8 @@ export interface operations {
|
|
|
14552
14865
|
aiHint?: string;
|
|
14553
14866
|
system?: boolean;
|
|
14554
14867
|
indexed?: boolean;
|
|
14868
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
14869
|
+
localized?: boolean;
|
|
14555
14870
|
/** @constant */
|
|
14556
14871
|
type: "color";
|
|
14557
14872
|
default?: string;
|
|
@@ -14564,6 +14879,8 @@ export interface operations {
|
|
|
14564
14879
|
aiHint?: string;
|
|
14565
14880
|
system?: boolean;
|
|
14566
14881
|
indexed?: boolean;
|
|
14882
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
14883
|
+
localized?: boolean;
|
|
14567
14884
|
/** @constant */
|
|
14568
14885
|
type: "image";
|
|
14569
14886
|
} | {
|
|
@@ -14575,6 +14892,8 @@ export interface operations {
|
|
|
14575
14892
|
aiHint?: string;
|
|
14576
14893
|
system?: boolean;
|
|
14577
14894
|
indexed?: boolean;
|
|
14895
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
14896
|
+
localized?: boolean;
|
|
14578
14897
|
/** @constant */
|
|
14579
14898
|
type: "gallery";
|
|
14580
14899
|
min?: number;
|
|
@@ -14588,6 +14907,8 @@ export interface operations {
|
|
|
14588
14907
|
aiHint?: string;
|
|
14589
14908
|
system?: boolean;
|
|
14590
14909
|
indexed?: boolean;
|
|
14910
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
14911
|
+
localized?: boolean;
|
|
14591
14912
|
/** @constant */
|
|
14592
14913
|
type: "file";
|
|
14593
14914
|
} | {
|
|
@@ -14599,6 +14920,8 @@ export interface operations {
|
|
|
14599
14920
|
aiHint?: string;
|
|
14600
14921
|
system?: boolean;
|
|
14601
14922
|
indexed?: boolean;
|
|
14923
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
14924
|
+
localized?: boolean;
|
|
14602
14925
|
/** @constant */
|
|
14603
14926
|
type: "reference";
|
|
14604
14927
|
targetCollectionKey: string;
|
|
@@ -14611,6 +14934,8 @@ export interface operations {
|
|
|
14611
14934
|
aiHint?: string;
|
|
14612
14935
|
system?: boolean;
|
|
14613
14936
|
indexed?: boolean;
|
|
14937
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
14938
|
+
localized?: boolean;
|
|
14614
14939
|
/** @constant */
|
|
14615
14940
|
type: "multi_reference";
|
|
14616
14941
|
targetCollectionKey: string;
|
|
@@ -14625,8 +14950,14 @@ export interface operations {
|
|
|
14625
14950
|
aiHint?: string;
|
|
14626
14951
|
system?: boolean;
|
|
14627
14952
|
indexed?: boolean;
|
|
14953
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
14954
|
+
localized?: boolean;
|
|
14628
14955
|
/** @constant */
|
|
14629
14956
|
type: "json";
|
|
14957
|
+
/** @description JSON Schema (a subset of draft 2020-12) the value must match. Keywords: type, enum, const, properties, required, additionalProperties, minProperties, maxProperties, items, minItems, maxItems, uniqueItems, minLength, maxLength, pattern, format (date, date-time, email, uri), minimum, maximum, exclusiveMinimum, exclusiveMaximum, multipleOf, anyOf, oneOf; title, description, examples, default and $comment are annotations. Other keywords, $ref included, are rejected. Up to 16 KB and 10 levels of nesting. Writes are validated against it (VALIDATION with code json_schema and the path of each problem), and kanorio types generates the value's TypeScript type from it. An empty value (null, an empty string or an empty array) is stored as null and not checked; use required to demand a value. */
|
|
14958
|
+
schema?: {
|
|
14959
|
+
[key: string]: unknown;
|
|
14960
|
+
};
|
|
14630
14961
|
})[];
|
|
14631
14962
|
titleFieldId: string;
|
|
14632
14963
|
/** @description Field-level read policy for the Content Delivery API: gatedFields are stripped on anonymous requests (returning top-level access summary) and unlocked when a Customer Access Token (knr_cat_) satisfies requires (customer login or an active entitlement featureKey). */
|
|
@@ -14649,6 +14980,10 @@ export interface operations {
|
|
|
14649
14980
|
} | null;
|
|
14650
14981
|
/** @description Public address of the collection's items on the site, e.g. /tours/{slug}. When set, every published item is treated as a page: it is listed in sitemap.xml and GET /api/v1/seo/sitemap, search engines are notified when it is published or unpublished, and site-search hits carry its url. null = items are data only and have no page of their own. */
|
|
14651
14982
|
pathTemplate: string | null;
|
|
14983
|
+
/** @description Where the dashboard's Preview button on an item opens (a path on the site's front end or a full https URL, with {slug}, {id} or {fieldId} placeholders). null = Preview uses pathTemplate; with neither, items have no Preview button. */
|
|
14984
|
+
previewUrlTemplate: string | null;
|
|
14985
|
+
/** @description true = a single-item collection (site settings, homepage content): at most one item outside the trash, served by the Content Delivery API at GET /api/v1/collections/{key}/item. Create the item once with items.create, then change it with items.update. */
|
|
14986
|
+
singleton: boolean;
|
|
14652
14987
|
createdBy: {
|
|
14653
14988
|
/** @enum {string} */
|
|
14654
14989
|
kind: "agent" | "user";
|
|
@@ -14663,7 +14998,7 @@ export interface operations {
|
|
|
14663
14998
|
/** @description The site's public origin. */
|
|
14664
14999
|
baseUrl: string;
|
|
14665
15000
|
listUrl: string;
|
|
14666
|
-
/** @description Replace {slug} with an item's slug. */
|
|
15001
|
+
/** @description Replace {slug} with an item's slug. For a single-item collection this is the URL of its one item, with no slug. */
|
|
14667
15002
|
itemUrl: string;
|
|
14668
15003
|
schemaUrl: string;
|
|
14669
15004
|
/** @description Copy-paste JavaScript using fetch(). */
|
|
@@ -14827,6 +15162,8 @@ export interface operations {
|
|
|
14827
15162
|
aiHint?: string;
|
|
14828
15163
|
system?: boolean;
|
|
14829
15164
|
indexed?: boolean;
|
|
15165
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
15166
|
+
localized?: boolean;
|
|
14830
15167
|
unique?: boolean;
|
|
14831
15168
|
/** @constant */
|
|
14832
15169
|
type: "text";
|
|
@@ -14834,7 +15171,6 @@ export interface operations {
|
|
|
14834
15171
|
max?: number;
|
|
14835
15172
|
pattern?: string;
|
|
14836
15173
|
default?: string;
|
|
14837
|
-
localized?: boolean;
|
|
14838
15174
|
} | {
|
|
14839
15175
|
id: string;
|
|
14840
15176
|
name: string;
|
|
@@ -14844,10 +15180,11 @@ export interface operations {
|
|
|
14844
15180
|
aiHint?: string;
|
|
14845
15181
|
system?: boolean;
|
|
14846
15182
|
indexed?: boolean;
|
|
15183
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
15184
|
+
localized?: boolean;
|
|
14847
15185
|
/** @constant */
|
|
14848
15186
|
type: "rich_text";
|
|
14849
15187
|
max?: number;
|
|
14850
|
-
localized?: boolean;
|
|
14851
15188
|
} | {
|
|
14852
15189
|
id: string;
|
|
14853
15190
|
name: string;
|
|
@@ -14857,6 +15194,8 @@ export interface operations {
|
|
|
14857
15194
|
aiHint?: string;
|
|
14858
15195
|
system?: boolean;
|
|
14859
15196
|
indexed?: boolean;
|
|
15197
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
15198
|
+
localized?: boolean;
|
|
14860
15199
|
unique?: boolean;
|
|
14861
15200
|
/** @constant */
|
|
14862
15201
|
type: "email";
|
|
@@ -14870,6 +15209,8 @@ export interface operations {
|
|
|
14870
15209
|
aiHint?: string;
|
|
14871
15210
|
system?: boolean;
|
|
14872
15211
|
indexed?: boolean;
|
|
15212
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
15213
|
+
localized?: boolean;
|
|
14873
15214
|
unique?: boolean;
|
|
14874
15215
|
/** @constant */
|
|
14875
15216
|
type: "phone";
|
|
@@ -14883,6 +15224,8 @@ export interface operations {
|
|
|
14883
15224
|
aiHint?: string;
|
|
14884
15225
|
system?: boolean;
|
|
14885
15226
|
indexed?: boolean;
|
|
15227
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
15228
|
+
localized?: boolean;
|
|
14886
15229
|
unique?: boolean;
|
|
14887
15230
|
/** @constant */
|
|
14888
15231
|
type: "url";
|
|
@@ -14896,6 +15239,8 @@ export interface operations {
|
|
|
14896
15239
|
aiHint?: string;
|
|
14897
15240
|
system?: boolean;
|
|
14898
15241
|
indexed?: boolean;
|
|
15242
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
15243
|
+
localized?: boolean;
|
|
14899
15244
|
/** @constant */
|
|
14900
15245
|
type: "video_url";
|
|
14901
15246
|
} | {
|
|
@@ -14907,6 +15252,8 @@ export interface operations {
|
|
|
14907
15252
|
aiHint?: string;
|
|
14908
15253
|
system?: boolean;
|
|
14909
15254
|
indexed?: boolean;
|
|
15255
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
15256
|
+
localized?: boolean;
|
|
14910
15257
|
unique?: boolean;
|
|
14911
15258
|
/** @constant */
|
|
14912
15259
|
type: "number";
|
|
@@ -14923,6 +15270,8 @@ export interface operations {
|
|
|
14923
15270
|
aiHint?: string;
|
|
14924
15271
|
system?: boolean;
|
|
14925
15272
|
indexed?: boolean;
|
|
15273
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
15274
|
+
localized?: boolean;
|
|
14926
15275
|
/** @constant */
|
|
14927
15276
|
type: "boolean";
|
|
14928
15277
|
default?: boolean;
|
|
@@ -14935,6 +15284,8 @@ export interface operations {
|
|
|
14935
15284
|
aiHint?: string;
|
|
14936
15285
|
system?: boolean;
|
|
14937
15286
|
indexed?: boolean;
|
|
15287
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
15288
|
+
localized?: boolean;
|
|
14938
15289
|
/** @constant */
|
|
14939
15290
|
type: "date";
|
|
14940
15291
|
min?: string;
|
|
@@ -14949,6 +15300,8 @@ export interface operations {
|
|
|
14949
15300
|
aiHint?: string;
|
|
14950
15301
|
system?: boolean;
|
|
14951
15302
|
indexed?: boolean;
|
|
15303
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
15304
|
+
localized?: boolean;
|
|
14952
15305
|
/** @constant */
|
|
14953
15306
|
type: "datetime";
|
|
14954
15307
|
min?: string;
|
|
@@ -14963,6 +15316,8 @@ export interface operations {
|
|
|
14963
15316
|
aiHint?: string;
|
|
14964
15317
|
system?: boolean;
|
|
14965
15318
|
indexed?: boolean;
|
|
15319
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
15320
|
+
localized?: boolean;
|
|
14966
15321
|
/** @constant */
|
|
14967
15322
|
type: "select";
|
|
14968
15323
|
options: {
|
|
@@ -14980,6 +15335,8 @@ export interface operations {
|
|
|
14980
15335
|
aiHint?: string;
|
|
14981
15336
|
system?: boolean;
|
|
14982
15337
|
indexed?: boolean;
|
|
15338
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
15339
|
+
localized?: boolean;
|
|
14983
15340
|
/** @constant */
|
|
14984
15341
|
type: "multi_select";
|
|
14985
15342
|
options: {
|
|
@@ -14999,6 +15356,8 @@ export interface operations {
|
|
|
14999
15356
|
aiHint?: string;
|
|
15000
15357
|
system?: boolean;
|
|
15001
15358
|
indexed?: boolean;
|
|
15359
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
15360
|
+
localized?: boolean;
|
|
15002
15361
|
/** @constant */
|
|
15003
15362
|
type: "color";
|
|
15004
15363
|
default?: string;
|
|
@@ -15011,6 +15370,8 @@ export interface operations {
|
|
|
15011
15370
|
aiHint?: string;
|
|
15012
15371
|
system?: boolean;
|
|
15013
15372
|
indexed?: boolean;
|
|
15373
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
15374
|
+
localized?: boolean;
|
|
15014
15375
|
/** @constant */
|
|
15015
15376
|
type: "image";
|
|
15016
15377
|
} | {
|
|
@@ -15022,6 +15383,8 @@ export interface operations {
|
|
|
15022
15383
|
aiHint?: string;
|
|
15023
15384
|
system?: boolean;
|
|
15024
15385
|
indexed?: boolean;
|
|
15386
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
15387
|
+
localized?: boolean;
|
|
15025
15388
|
/** @constant */
|
|
15026
15389
|
type: "gallery";
|
|
15027
15390
|
min?: number;
|
|
@@ -15035,6 +15398,8 @@ export interface operations {
|
|
|
15035
15398
|
aiHint?: string;
|
|
15036
15399
|
system?: boolean;
|
|
15037
15400
|
indexed?: boolean;
|
|
15401
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
15402
|
+
localized?: boolean;
|
|
15038
15403
|
/** @constant */
|
|
15039
15404
|
type: "file";
|
|
15040
15405
|
} | {
|
|
@@ -15046,6 +15411,8 @@ export interface operations {
|
|
|
15046
15411
|
aiHint?: string;
|
|
15047
15412
|
system?: boolean;
|
|
15048
15413
|
indexed?: boolean;
|
|
15414
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
15415
|
+
localized?: boolean;
|
|
15049
15416
|
/** @constant */
|
|
15050
15417
|
type: "reference";
|
|
15051
15418
|
targetCollectionKey: string;
|
|
@@ -15058,6 +15425,8 @@ export interface operations {
|
|
|
15058
15425
|
aiHint?: string;
|
|
15059
15426
|
system?: boolean;
|
|
15060
15427
|
indexed?: boolean;
|
|
15428
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
15429
|
+
localized?: boolean;
|
|
15061
15430
|
/** @constant */
|
|
15062
15431
|
type: "multi_reference";
|
|
15063
15432
|
targetCollectionKey: string;
|
|
@@ -15072,8 +15441,14 @@ export interface operations {
|
|
|
15072
15441
|
aiHint?: string;
|
|
15073
15442
|
system?: boolean;
|
|
15074
15443
|
indexed?: boolean;
|
|
15444
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
15445
|
+
localized?: boolean;
|
|
15075
15446
|
/** @constant */
|
|
15076
15447
|
type: "json";
|
|
15448
|
+
/** @description JSON Schema (a subset of draft 2020-12) the value must match. Keywords: type, enum, const, properties, required, additionalProperties, minProperties, maxProperties, items, minItems, maxItems, uniqueItems, minLength, maxLength, pattern, format (date, date-time, email, uri), minimum, maximum, exclusiveMinimum, exclusiveMaximum, multipleOf, anyOf, oneOf; title, description, examples, default and $comment are annotations. Other keywords, $ref included, are rejected. Up to 16 KB and 10 levels of nesting. Writes are validated against it (VALIDATION with code json_schema and the path of each problem), and kanorio types generates the value's TypeScript type from it. An empty value (null, an empty string or an empty array) is stored as null and not checked; use required to demand a value. */
|
|
15449
|
+
schema?: {
|
|
15450
|
+
[key: string]: unknown;
|
|
15451
|
+
};
|
|
15077
15452
|
})[];
|
|
15078
15453
|
titleFieldId?: string;
|
|
15079
15454
|
/** @description Field-level read policy (gatedFields, requires: customer | entitlement(featureKey), optional itemOverrideField). Pass null to remove the policy. */
|
|
@@ -15096,6 +15471,9 @@ export interface operations {
|
|
|
15096
15471
|
} | null;
|
|
15097
15472
|
/** @description Public address of the items, e.g. /tours/{slug} (must contain {slug} once). Set it when your frontend renders a page per item so the items appear in the sitemap and search engines are notified. Pass null to clear. Not configurable on system collections. */
|
|
15098
15473
|
pathTemplate?: string | null;
|
|
15474
|
+
previewUrlTemplate?: string | null;
|
|
15475
|
+
/** @description true makes this a single-item collection (site settings, homepage content): it holds at most one item outside the trash, and the Content Delivery API serves it at GET /api/v1/collections/{key}/item. The item counts toward the plan's item quota like any other. Turning it on is refused with SINGLETON_HAS_ITEMS while the collection has more than one item outside the trash. */
|
|
15476
|
+
singleton?: boolean;
|
|
15099
15477
|
};
|
|
15100
15478
|
};
|
|
15101
15479
|
};
|
|
@@ -15182,6 +15560,8 @@ export interface operations {
|
|
|
15182
15560
|
* ]
|
|
15183
15561
|
* },
|
|
15184
15562
|
* "pathTemplate": "/teachers/{slug}",
|
|
15563
|
+
* "previewUrlTemplate": null,
|
|
15564
|
+
* "singleton": false,
|
|
15185
15565
|
* "createdBy": {
|
|
15186
15566
|
* "kind": "agent",
|
|
15187
15567
|
* "actorId": "user_example01",
|
|
@@ -15215,6 +15595,8 @@ export interface operations {
|
|
|
15215
15595
|
aiHint?: string;
|
|
15216
15596
|
system?: boolean;
|
|
15217
15597
|
indexed?: boolean;
|
|
15598
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
15599
|
+
localized?: boolean;
|
|
15218
15600
|
unique?: boolean;
|
|
15219
15601
|
/** @constant */
|
|
15220
15602
|
type: "text";
|
|
@@ -15222,7 +15604,6 @@ export interface operations {
|
|
|
15222
15604
|
max?: number;
|
|
15223
15605
|
pattern?: string;
|
|
15224
15606
|
default?: string;
|
|
15225
|
-
localized?: boolean;
|
|
15226
15607
|
} | {
|
|
15227
15608
|
id: string;
|
|
15228
15609
|
name: string;
|
|
@@ -15232,10 +15613,11 @@ export interface operations {
|
|
|
15232
15613
|
aiHint?: string;
|
|
15233
15614
|
system?: boolean;
|
|
15234
15615
|
indexed?: boolean;
|
|
15616
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
15617
|
+
localized?: boolean;
|
|
15235
15618
|
/** @constant */
|
|
15236
15619
|
type: "rich_text";
|
|
15237
15620
|
max?: number;
|
|
15238
|
-
localized?: boolean;
|
|
15239
15621
|
} | {
|
|
15240
15622
|
id: string;
|
|
15241
15623
|
name: string;
|
|
@@ -15245,6 +15627,8 @@ export interface operations {
|
|
|
15245
15627
|
aiHint?: string;
|
|
15246
15628
|
system?: boolean;
|
|
15247
15629
|
indexed?: boolean;
|
|
15630
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
15631
|
+
localized?: boolean;
|
|
15248
15632
|
unique?: boolean;
|
|
15249
15633
|
/** @constant */
|
|
15250
15634
|
type: "email";
|
|
@@ -15258,6 +15642,8 @@ export interface operations {
|
|
|
15258
15642
|
aiHint?: string;
|
|
15259
15643
|
system?: boolean;
|
|
15260
15644
|
indexed?: boolean;
|
|
15645
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
15646
|
+
localized?: boolean;
|
|
15261
15647
|
unique?: boolean;
|
|
15262
15648
|
/** @constant */
|
|
15263
15649
|
type: "phone";
|
|
@@ -15271,6 +15657,8 @@ export interface operations {
|
|
|
15271
15657
|
aiHint?: string;
|
|
15272
15658
|
system?: boolean;
|
|
15273
15659
|
indexed?: boolean;
|
|
15660
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
15661
|
+
localized?: boolean;
|
|
15274
15662
|
unique?: boolean;
|
|
15275
15663
|
/** @constant */
|
|
15276
15664
|
type: "url";
|
|
@@ -15284,6 +15672,8 @@ export interface operations {
|
|
|
15284
15672
|
aiHint?: string;
|
|
15285
15673
|
system?: boolean;
|
|
15286
15674
|
indexed?: boolean;
|
|
15675
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
15676
|
+
localized?: boolean;
|
|
15287
15677
|
/** @constant */
|
|
15288
15678
|
type: "video_url";
|
|
15289
15679
|
} | {
|
|
@@ -15295,6 +15685,8 @@ export interface operations {
|
|
|
15295
15685
|
aiHint?: string;
|
|
15296
15686
|
system?: boolean;
|
|
15297
15687
|
indexed?: boolean;
|
|
15688
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
15689
|
+
localized?: boolean;
|
|
15298
15690
|
unique?: boolean;
|
|
15299
15691
|
/** @constant */
|
|
15300
15692
|
type: "number";
|
|
@@ -15311,6 +15703,8 @@ export interface operations {
|
|
|
15311
15703
|
aiHint?: string;
|
|
15312
15704
|
system?: boolean;
|
|
15313
15705
|
indexed?: boolean;
|
|
15706
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
15707
|
+
localized?: boolean;
|
|
15314
15708
|
/** @constant */
|
|
15315
15709
|
type: "boolean";
|
|
15316
15710
|
default?: boolean;
|
|
@@ -15323,6 +15717,8 @@ export interface operations {
|
|
|
15323
15717
|
aiHint?: string;
|
|
15324
15718
|
system?: boolean;
|
|
15325
15719
|
indexed?: boolean;
|
|
15720
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
15721
|
+
localized?: boolean;
|
|
15326
15722
|
/** @constant */
|
|
15327
15723
|
type: "date";
|
|
15328
15724
|
min?: string;
|
|
@@ -15337,6 +15733,8 @@ export interface operations {
|
|
|
15337
15733
|
aiHint?: string;
|
|
15338
15734
|
system?: boolean;
|
|
15339
15735
|
indexed?: boolean;
|
|
15736
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
15737
|
+
localized?: boolean;
|
|
15340
15738
|
/** @constant */
|
|
15341
15739
|
type: "datetime";
|
|
15342
15740
|
min?: string;
|
|
@@ -15351,6 +15749,8 @@ export interface operations {
|
|
|
15351
15749
|
aiHint?: string;
|
|
15352
15750
|
system?: boolean;
|
|
15353
15751
|
indexed?: boolean;
|
|
15752
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
15753
|
+
localized?: boolean;
|
|
15354
15754
|
/** @constant */
|
|
15355
15755
|
type: "select";
|
|
15356
15756
|
options: {
|
|
@@ -15368,6 +15768,8 @@ export interface operations {
|
|
|
15368
15768
|
aiHint?: string;
|
|
15369
15769
|
system?: boolean;
|
|
15370
15770
|
indexed?: boolean;
|
|
15771
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
15772
|
+
localized?: boolean;
|
|
15371
15773
|
/** @constant */
|
|
15372
15774
|
type: "multi_select";
|
|
15373
15775
|
options: {
|
|
@@ -15387,6 +15789,8 @@ export interface operations {
|
|
|
15387
15789
|
aiHint?: string;
|
|
15388
15790
|
system?: boolean;
|
|
15389
15791
|
indexed?: boolean;
|
|
15792
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
15793
|
+
localized?: boolean;
|
|
15390
15794
|
/** @constant */
|
|
15391
15795
|
type: "color";
|
|
15392
15796
|
default?: string;
|
|
@@ -15399,6 +15803,8 @@ export interface operations {
|
|
|
15399
15803
|
aiHint?: string;
|
|
15400
15804
|
system?: boolean;
|
|
15401
15805
|
indexed?: boolean;
|
|
15806
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
15807
|
+
localized?: boolean;
|
|
15402
15808
|
/** @constant */
|
|
15403
15809
|
type: "image";
|
|
15404
15810
|
} | {
|
|
@@ -15410,6 +15816,8 @@ export interface operations {
|
|
|
15410
15816
|
aiHint?: string;
|
|
15411
15817
|
system?: boolean;
|
|
15412
15818
|
indexed?: boolean;
|
|
15819
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
15820
|
+
localized?: boolean;
|
|
15413
15821
|
/** @constant */
|
|
15414
15822
|
type: "gallery";
|
|
15415
15823
|
min?: number;
|
|
@@ -15423,6 +15831,8 @@ export interface operations {
|
|
|
15423
15831
|
aiHint?: string;
|
|
15424
15832
|
system?: boolean;
|
|
15425
15833
|
indexed?: boolean;
|
|
15834
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
15835
|
+
localized?: boolean;
|
|
15426
15836
|
/** @constant */
|
|
15427
15837
|
type: "file";
|
|
15428
15838
|
} | {
|
|
@@ -15434,6 +15844,8 @@ export interface operations {
|
|
|
15434
15844
|
aiHint?: string;
|
|
15435
15845
|
system?: boolean;
|
|
15436
15846
|
indexed?: boolean;
|
|
15847
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
15848
|
+
localized?: boolean;
|
|
15437
15849
|
/** @constant */
|
|
15438
15850
|
type: "reference";
|
|
15439
15851
|
targetCollectionKey: string;
|
|
@@ -15446,6 +15858,8 @@ export interface operations {
|
|
|
15446
15858
|
aiHint?: string;
|
|
15447
15859
|
system?: boolean;
|
|
15448
15860
|
indexed?: boolean;
|
|
15861
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
15862
|
+
localized?: boolean;
|
|
15449
15863
|
/** @constant */
|
|
15450
15864
|
type: "multi_reference";
|
|
15451
15865
|
targetCollectionKey: string;
|
|
@@ -15460,8 +15874,14 @@ export interface operations {
|
|
|
15460
15874
|
aiHint?: string;
|
|
15461
15875
|
system?: boolean;
|
|
15462
15876
|
indexed?: boolean;
|
|
15877
|
+
/** @description Multilingual sites: keep a value per locale. text and rich_text are translated by auto-translate; json, image and gallery keep one whole value per locale (a json value, an asset id, a list of asset ids), written with localization.translations.upsert or in the dashboard and never machine-translated (a locale without one shows the primary value). Other field types reject it. */
|
|
15878
|
+
localized?: boolean;
|
|
15463
15879
|
/** @constant */
|
|
15464
15880
|
type: "json";
|
|
15881
|
+
/** @description JSON Schema (a subset of draft 2020-12) the value must match. Keywords: type, enum, const, properties, required, additionalProperties, minProperties, maxProperties, items, minItems, maxItems, uniqueItems, minLength, maxLength, pattern, format (date, date-time, email, uri), minimum, maximum, exclusiveMinimum, exclusiveMaximum, multipleOf, anyOf, oneOf; title, description, examples, default and $comment are annotations. Other keywords, $ref included, are rejected. Up to 16 KB and 10 levels of nesting. Writes are validated against it (VALIDATION with code json_schema and the path of each problem), and kanorio types generates the value's TypeScript type from it. An empty value (null, an empty string or an empty array) is stored as null and not checked; use required to demand a value. */
|
|
15882
|
+
schema?: {
|
|
15883
|
+
[key: string]: unknown;
|
|
15884
|
+
};
|
|
15465
15885
|
})[];
|
|
15466
15886
|
titleFieldId: string;
|
|
15467
15887
|
/** @description Field-level read policy for the Content Delivery API: gatedFields are stripped on anonymous requests (returning top-level access summary) and unlocked when a Customer Access Token (knr_cat_) satisfies requires (customer login or an active entitlement featureKey). */
|
|
@@ -15484,6 +15904,10 @@ export interface operations {
|
|
|
15484
15904
|
} | null;
|
|
15485
15905
|
/** @description Public address of the collection's items on the site, e.g. /tours/{slug}. When set, every published item is treated as a page: it is listed in sitemap.xml and GET /api/v1/seo/sitemap, search engines are notified when it is published or unpublished, and site-search hits carry its url. null = items are data only and have no page of their own. */
|
|
15486
15906
|
pathTemplate: string | null;
|
|
15907
|
+
/** @description Where the dashboard's Preview button on an item opens (a path on the site's front end or a full https URL, with {slug}, {id} or {fieldId} placeholders). null = Preview uses pathTemplate; with neither, items have no Preview button. */
|
|
15908
|
+
previewUrlTemplate: string | null;
|
|
15909
|
+
/** @description true = a single-item collection (site settings, homepage content): at most one item outside the trash, served by the Content Delivery API at GET /api/v1/collections/{key}/item. Create the item once with items.create, then change it with items.update. */
|
|
15910
|
+
singleton: boolean;
|
|
15487
15911
|
createdBy: {
|
|
15488
15912
|
/** @enum {string} */
|
|
15489
15913
|
kind: "agent" | "user";
|
|
@@ -15501,6 +15925,7 @@ export interface operations {
|
|
|
15501
15925
|
401: components["responses"]["Error401"];
|
|
15502
15926
|
403: components["responses"]["Error403"];
|
|
15503
15927
|
404: components["responses"]["Error404"];
|
|
15928
|
+
409: components["responses"]["Error409"];
|
|
15504
15929
|
422: components["responses"]["Error422"];
|
|
15505
15930
|
429: components["responses"]["Error429"];
|
|
15506
15931
|
500: components["responses"]["Error500"];
|
|
@@ -15591,6 +16016,16 @@ export interface operations {
|
|
|
15591
16016
|
* "website": "https://amychen.example.com",
|
|
15592
16017
|
* "course": "item_example02"
|
|
15593
16018
|
* },
|
|
16019
|
+
* "imageAlt": {
|
|
16020
|
+
* "avatar": {
|
|
16021
|
+
* "asset_example01": "Amy Chen at the whiteboard in a geometry class"
|
|
16022
|
+
* }
|
|
16023
|
+
* },
|
|
16024
|
+
* "publishedImageAlt": {
|
|
16025
|
+
* "avatar": {
|
|
16026
|
+
* "asset_example01": "Amy Chen at the whiteboard in a geometry class"
|
|
16027
|
+
* }
|
|
16028
|
+
* },
|
|
15594
16029
|
* "publishedSlug": "amy-chen",
|
|
15595
16030
|
* "publishedAt": "2026-10-06T08:00:00.000Z",
|
|
15596
16031
|
* "sortOrder": 0,
|
|
@@ -15626,6 +16061,18 @@ export interface operations {
|
|
|
15626
16061
|
publishedFieldData: {
|
|
15627
16062
|
[key: string]: unknown;
|
|
15628
16063
|
} | null;
|
|
16064
|
+
/** @description Draft alt text written for an image where this item uses it, by image or gallery field and asset id: { fieldId: { assetId: alt } }. It overrides the asset's default alt; an image without an entry uses the default. fieldData keeps the asset ids unchanged. */
|
|
16065
|
+
imageAlt: {
|
|
16066
|
+
[key: string]: {
|
|
16067
|
+
[key: string]: string;
|
|
16068
|
+
};
|
|
16069
|
+
};
|
|
16070
|
+
/** @description The same for the published version; null when never published. */
|
|
16071
|
+
publishedImageAlt: {
|
|
16072
|
+
[key: string]: {
|
|
16073
|
+
[key: string]: string;
|
|
16074
|
+
};
|
|
16075
|
+
} | null;
|
|
15629
16076
|
publishedSlug: string | null;
|
|
15630
16077
|
publishedAt: string | null;
|
|
15631
16078
|
sortOrder: number;
|
|
@@ -15688,6 +16135,11 @@ export interface operations {
|
|
|
15688
16135
|
* "website": "https://amychen.example.com",
|
|
15689
16136
|
* "course": "item_example02"
|
|
15690
16137
|
* },
|
|
16138
|
+
* "imageAlt": {
|
|
16139
|
+
* "avatar": {
|
|
16140
|
+
* "asset_example01": "Amy Chen at the whiteboard in a geometry class"
|
|
16141
|
+
* }
|
|
16142
|
+
* },
|
|
15691
16143
|
* "publish": true
|
|
15692
16144
|
* }
|
|
15693
16145
|
*/
|
|
@@ -15696,6 +16148,12 @@ export interface operations {
|
|
|
15696
16148
|
fieldData: {
|
|
15697
16149
|
[key: string]: unknown;
|
|
15698
16150
|
};
|
|
16151
|
+
/** @description Alt text for an image where this item uses it, overriding the image's default alt from the media library: { [fieldId]: { [assetId]: alt } } for image and gallery fields. A string sets it (at most 500 characters; an empty string clears it), null clears it so the default alt applies again, and entries you leave out are kept. The asset must be the field's current image, or one of its gallery images, after this write. Replacing a field's image drops the alt written for the old one. */
|
|
16152
|
+
imageAlt?: {
|
|
16153
|
+
[key: string]: {
|
|
16154
|
+
[key: string]: string | null;
|
|
16155
|
+
};
|
|
16156
|
+
};
|
|
15699
16157
|
slug?: string;
|
|
15700
16158
|
/** @description Default true: the write is published immediately. false keeps it as a draft (status draft or changed). */
|
|
15701
16159
|
publish?: boolean;
|
|
@@ -15738,6 +16196,16 @@ export interface operations {
|
|
|
15738
16196
|
* "website": "https://amychen.example.com",
|
|
15739
16197
|
* "course": "item_example02"
|
|
15740
16198
|
* },
|
|
16199
|
+
* "imageAlt": {
|
|
16200
|
+
* "avatar": {
|
|
16201
|
+
* "asset_example01": "Amy Chen at the whiteboard in a geometry class"
|
|
16202
|
+
* }
|
|
16203
|
+
* },
|
|
16204
|
+
* "publishedImageAlt": {
|
|
16205
|
+
* "avatar": {
|
|
16206
|
+
* "asset_example01": "Amy Chen at the whiteboard in a geometry class"
|
|
16207
|
+
* }
|
|
16208
|
+
* },
|
|
15741
16209
|
* "publishedSlug": "amy-chen",
|
|
15742
16210
|
* "publishedAt": "2026-10-06T08:00:00.000Z",
|
|
15743
16211
|
* "sortOrder": 0,
|
|
@@ -15768,6 +16236,18 @@ export interface operations {
|
|
|
15768
16236
|
publishedFieldData: {
|
|
15769
16237
|
[key: string]: unknown;
|
|
15770
16238
|
} | null;
|
|
16239
|
+
/** @description Draft alt text written for an image where this item uses it, by image or gallery field and asset id: { fieldId: { assetId: alt } }. It overrides the asset's default alt; an image without an entry uses the default. fieldData keeps the asset ids unchanged. */
|
|
16240
|
+
imageAlt: {
|
|
16241
|
+
[key: string]: {
|
|
16242
|
+
[key: string]: string;
|
|
16243
|
+
};
|
|
16244
|
+
};
|
|
16245
|
+
/** @description The same for the published version; null when never published. */
|
|
16246
|
+
publishedImageAlt: {
|
|
16247
|
+
[key: string]: {
|
|
16248
|
+
[key: string]: string;
|
|
16249
|
+
};
|
|
16250
|
+
} | null;
|
|
15771
16251
|
publishedSlug: string | null;
|
|
15772
16252
|
publishedAt: string | null;
|
|
15773
16253
|
sortOrder: number;
|
|
@@ -15799,7 +16279,10 @@ export interface operations {
|
|
|
15799
16279
|
items_bulk_create: {
|
|
15800
16280
|
parameters: {
|
|
15801
16281
|
query?: never;
|
|
15802
|
-
header?:
|
|
16282
|
+
header?: {
|
|
16283
|
+
/** @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. */
|
|
16284
|
+
"Idempotency-Key"?: string;
|
|
16285
|
+
};
|
|
15803
16286
|
path: {
|
|
15804
16287
|
/** @description Website id. Get it from sites.list or from sites.create. */
|
|
15805
16288
|
id: string;
|
|
@@ -15844,6 +16327,12 @@ export interface operations {
|
|
|
15844
16327
|
fieldData: {
|
|
15845
16328
|
[key: string]: unknown;
|
|
15846
16329
|
};
|
|
16330
|
+
/** @description Alt text for an image where this item uses it, overriding the image's default alt from the media library: { [fieldId]: { [assetId]: alt } } for image and gallery fields. A string sets it (at most 500 characters; an empty string clears it), null clears it so the default alt applies again, and entries you leave out are kept. The asset must be the field's current image, or one of its gallery images, after this write. Replacing a field's image drops the alt written for the old one. */
|
|
16331
|
+
imageAlt?: {
|
|
16332
|
+
[key: string]: {
|
|
16333
|
+
[key: string]: string | null;
|
|
16334
|
+
};
|
|
16335
|
+
};
|
|
15847
16336
|
slug?: string;
|
|
15848
16337
|
}[];
|
|
15849
16338
|
/** @description Default true: the write is published immediately. false keeps it as a draft (status draft or changed). */
|
|
@@ -15889,6 +16378,16 @@ export interface operations {
|
|
|
15889
16378
|
* "website": "https://amychen.example.com",
|
|
15890
16379
|
* "course": "item_example02"
|
|
15891
16380
|
* },
|
|
16381
|
+
* "imageAlt": {
|
|
16382
|
+
* "avatar": {
|
|
16383
|
+
* "asset_example01": "Amy Chen at the whiteboard in a geometry class"
|
|
16384
|
+
* }
|
|
16385
|
+
* },
|
|
16386
|
+
* "publishedImageAlt": {
|
|
16387
|
+
* "avatar": {
|
|
16388
|
+
* "asset_example01": "Amy Chen at the whiteboard in a geometry class"
|
|
16389
|
+
* }
|
|
16390
|
+
* },
|
|
15892
16391
|
* "publishedSlug": "amy-chen",
|
|
15893
16392
|
* "publishedAt": "2026-10-06T08:00:00.000Z",
|
|
15894
16393
|
* "sortOrder": 0,
|
|
@@ -15918,6 +16417,8 @@ export interface operations {
|
|
|
15918
16417
|
* "english"
|
|
15919
16418
|
* ]
|
|
15920
16419
|
* },
|
|
16420
|
+
* "imageAlt": {},
|
|
16421
|
+
* "publishedImageAlt": {},
|
|
15921
16422
|
* "publishedSlug": "ben-lin",
|
|
15922
16423
|
* "publishedAt": "2026-10-06T08:00:00.000Z",
|
|
15923
16424
|
* "sortOrder": 1,
|
|
@@ -15952,6 +16453,18 @@ export interface operations {
|
|
|
15952
16453
|
publishedFieldData: {
|
|
15953
16454
|
[key: string]: unknown;
|
|
15954
16455
|
} | null;
|
|
16456
|
+
/** @description Draft alt text written for an image where this item uses it, by image or gallery field and asset id: { fieldId: { assetId: alt } }. It overrides the asset's default alt; an image without an entry uses the default. fieldData keeps the asset ids unchanged. */
|
|
16457
|
+
imageAlt: {
|
|
16458
|
+
[key: string]: {
|
|
16459
|
+
[key: string]: string;
|
|
16460
|
+
};
|
|
16461
|
+
};
|
|
16462
|
+
/** @description The same for the published version; null when never published. */
|
|
16463
|
+
publishedImageAlt: {
|
|
16464
|
+
[key: string]: {
|
|
16465
|
+
[key: string]: string;
|
|
16466
|
+
};
|
|
16467
|
+
} | null;
|
|
15955
16468
|
publishedSlug: string | null;
|
|
15956
16469
|
publishedAt: string | null;
|
|
15957
16470
|
sortOrder: number;
|
|
@@ -15968,6 +16481,7 @@ export interface operations {
|
|
|
15968
16481
|
/** @description Set by items.publish with scheduledAt; non-null means it will be published at this future time from a frozen snapshot. Cleared on items.unschedule or when published. */
|
|
15969
16482
|
scheduledAt: string | null;
|
|
15970
16483
|
}[];
|
|
16484
|
+
/** @description Always empty: a batch with a failing entry is rejected with VALIDATION and details.failed. */
|
|
15971
16485
|
failed: {
|
|
15972
16486
|
index: number;
|
|
15973
16487
|
error: {
|
|
@@ -16031,6 +16545,12 @@ export interface operations {
|
|
|
16031
16545
|
fieldData: {
|
|
16032
16546
|
[key: string]: unknown;
|
|
16033
16547
|
};
|
|
16548
|
+
/** @description Alt text for an image where this item uses it, overriding the image's default alt from the media library: { [fieldId]: { [assetId]: alt } } for image and gallery fields. A string sets it (at most 500 characters; an empty string clears it), null clears it so the default alt applies again, and entries you leave out are kept. The asset must be the field's current image, or one of its gallery images, after this write. Replacing a field's image drops the alt written for the old one. */
|
|
16549
|
+
imageAlt?: {
|
|
16550
|
+
[key: string]: {
|
|
16551
|
+
[key: string]: string | null;
|
|
16552
|
+
};
|
|
16553
|
+
};
|
|
16034
16554
|
slug?: string;
|
|
16035
16555
|
/**
|
|
16036
16556
|
* Format: date-time
|
|
@@ -16079,6 +16599,16 @@ export interface operations {
|
|
|
16079
16599
|
* "website": "https://amychen.example.com",
|
|
16080
16600
|
* "course": "item_example02"
|
|
16081
16601
|
* },
|
|
16602
|
+
* "imageAlt": {
|
|
16603
|
+
* "avatar": {
|
|
16604
|
+
* "asset_example01": "Amy Chen at the whiteboard in a geometry class"
|
|
16605
|
+
* }
|
|
16606
|
+
* },
|
|
16607
|
+
* "publishedImageAlt": {
|
|
16608
|
+
* "avatar": {
|
|
16609
|
+
* "asset_example01": "Amy Chen at the whiteboard in a geometry class"
|
|
16610
|
+
* }
|
|
16611
|
+
* },
|
|
16082
16612
|
* "publishedSlug": "amy-chen",
|
|
16083
16613
|
* "publishedAt": "2026-10-06T08:00:00.000Z",
|
|
16084
16614
|
* "sortOrder": 0,
|
|
@@ -16114,6 +16644,18 @@ export interface operations {
|
|
|
16114
16644
|
publishedFieldData: {
|
|
16115
16645
|
[key: string]: unknown;
|
|
16116
16646
|
} | null;
|
|
16647
|
+
/** @description Draft alt text written for an image where this item uses it, by image or gallery field and asset id: { fieldId: { assetId: alt } }. It overrides the asset's default alt; an image without an entry uses the default. fieldData keeps the asset ids unchanged. */
|
|
16648
|
+
imageAlt: {
|
|
16649
|
+
[key: string]: {
|
|
16650
|
+
[key: string]: string;
|
|
16651
|
+
};
|
|
16652
|
+
};
|
|
16653
|
+
/** @description The same for the published version; null when never published. */
|
|
16654
|
+
publishedImageAlt: {
|
|
16655
|
+
[key: string]: {
|
|
16656
|
+
[key: string]: string;
|
|
16657
|
+
};
|
|
16658
|
+
} | null;
|
|
16117
16659
|
publishedSlug: string | null;
|
|
16118
16660
|
publishedAt: string | null;
|
|
16119
16661
|
sortOrder: number;
|
|
@@ -16130,6 +16672,7 @@ export interface operations {
|
|
|
16130
16672
|
/** @description Set by items.publish with scheduledAt; non-null means it will be published at this future time from a frozen snapshot. Cleared on items.unschedule or when published. */
|
|
16131
16673
|
scheduledAt: string | null;
|
|
16132
16674
|
}[];
|
|
16675
|
+
/** @description Always empty: a batch with a failing entry is rejected with VALIDATION and details.failed. */
|
|
16133
16676
|
failed: {
|
|
16134
16677
|
index: number;
|
|
16135
16678
|
error: {
|
|
@@ -16225,6 +16768,16 @@ export interface operations {
|
|
|
16225
16768
|
* "website": "https://amychen.example.com",
|
|
16226
16769
|
* "course": "item_example02"
|
|
16227
16770
|
* },
|
|
16771
|
+
* "imageAlt": {
|
|
16772
|
+
* "avatar": {
|
|
16773
|
+
* "asset_example01": "Amy Chen at the whiteboard in a geometry class"
|
|
16774
|
+
* }
|
|
16775
|
+
* },
|
|
16776
|
+
* "publishedImageAlt": {
|
|
16777
|
+
* "avatar": {
|
|
16778
|
+
* "asset_example01": "Amy Chen at the whiteboard in a geometry class"
|
|
16779
|
+
* }
|
|
16780
|
+
* },
|
|
16228
16781
|
* "publishedSlug": "amy-chen",
|
|
16229
16782
|
* "publishedAt": "2026-10-06T08:00:00.000Z",
|
|
16230
16783
|
* "sortOrder": 0,
|
|
@@ -16260,6 +16813,18 @@ export interface operations {
|
|
|
16260
16813
|
publishedFieldData: {
|
|
16261
16814
|
[key: string]: unknown;
|
|
16262
16815
|
} | null;
|
|
16816
|
+
/** @description Draft alt text written for an image where this item uses it, by image or gallery field and asset id: { fieldId: { assetId: alt } }. It overrides the asset's default alt; an image without an entry uses the default. fieldData keeps the asset ids unchanged. */
|
|
16817
|
+
imageAlt: {
|
|
16818
|
+
[key: string]: {
|
|
16819
|
+
[key: string]: string;
|
|
16820
|
+
};
|
|
16821
|
+
};
|
|
16822
|
+
/** @description The same for the published version; null when never published. */
|
|
16823
|
+
publishedImageAlt: {
|
|
16824
|
+
[key: string]: {
|
|
16825
|
+
[key: string]: string;
|
|
16826
|
+
};
|
|
16827
|
+
} | null;
|
|
16263
16828
|
publishedSlug: string | null;
|
|
16264
16829
|
publishedAt: string | null;
|
|
16265
16830
|
sortOrder: number;
|
|
@@ -16346,6 +16911,12 @@ export interface operations {
|
|
|
16346
16911
|
* "course": "item_example02"
|
|
16347
16912
|
* },
|
|
16348
16913
|
* "publishedFieldData": null,
|
|
16914
|
+
* "imageAlt": {
|
|
16915
|
+
* "avatar": {
|
|
16916
|
+
* "asset_example01": "Amy Chen at the whiteboard in a geometry class"
|
|
16917
|
+
* }
|
|
16918
|
+
* },
|
|
16919
|
+
* "publishedImageAlt": null,
|
|
16349
16920
|
* "publishedSlug": null,
|
|
16350
16921
|
* "publishedAt": null,
|
|
16351
16922
|
* "sortOrder": 0,
|
|
@@ -16380,6 +16951,18 @@ export interface operations {
|
|
|
16380
16951
|
publishedFieldData: {
|
|
16381
16952
|
[key: string]: unknown;
|
|
16382
16953
|
} | null;
|
|
16954
|
+
/** @description Draft alt text written for an image where this item uses it, by image or gallery field and asset id: { fieldId: { assetId: alt } }. It overrides the asset's default alt; an image without an entry uses the default. fieldData keeps the asset ids unchanged. */
|
|
16955
|
+
imageAlt: {
|
|
16956
|
+
[key: string]: {
|
|
16957
|
+
[key: string]: string;
|
|
16958
|
+
};
|
|
16959
|
+
};
|
|
16960
|
+
/** @description The same for the published version; null when never published. */
|
|
16961
|
+
publishedImageAlt: {
|
|
16962
|
+
[key: string]: {
|
|
16963
|
+
[key: string]: string;
|
|
16964
|
+
};
|
|
16965
|
+
} | null;
|
|
16383
16966
|
publishedSlug: string | null;
|
|
16384
16967
|
publishedAt: string | null;
|
|
16385
16968
|
sortOrder: number;
|
|
@@ -16451,6 +17034,8 @@ export interface operations {
|
|
|
16451
17034
|
* ]
|
|
16452
17035
|
* },
|
|
16453
17036
|
* "publishedFieldData": null,
|
|
17037
|
+
* "imageAlt": {},
|
|
17038
|
+
* "publishedImageAlt": null,
|
|
16454
17039
|
* "publishedSlug": null,
|
|
16455
17040
|
* "publishedAt": null,
|
|
16456
17041
|
* "sortOrder": 0,
|
|
@@ -16486,6 +17071,18 @@ export interface operations {
|
|
|
16486
17071
|
publishedFieldData: {
|
|
16487
17072
|
[key: string]: unknown;
|
|
16488
17073
|
} | null;
|
|
17074
|
+
/** @description Draft alt text written for an image where this item uses it, by image or gallery field and asset id: { fieldId: { assetId: alt } }. It overrides the asset's default alt; an image without an entry uses the default. fieldData keeps the asset ids unchanged. */
|
|
17075
|
+
imageAlt: {
|
|
17076
|
+
[key: string]: {
|
|
17077
|
+
[key: string]: string;
|
|
17078
|
+
};
|
|
17079
|
+
};
|
|
17080
|
+
/** @description The same for the published version; null when never published. */
|
|
17081
|
+
publishedImageAlt: {
|
|
17082
|
+
[key: string]: {
|
|
17083
|
+
[key: string]: string;
|
|
17084
|
+
};
|
|
17085
|
+
} | null;
|
|
16489
17086
|
publishedSlug: string | null;
|
|
16490
17087
|
publishedAt: string | null;
|
|
16491
17088
|
sortOrder: number;
|
|
@@ -16569,6 +17166,16 @@ export interface operations {
|
|
|
16569
17166
|
* "website": "https://amychen.example.com",
|
|
16570
17167
|
* "course": "item_example02"
|
|
16571
17168
|
* },
|
|
17169
|
+
* "imageAlt": {
|
|
17170
|
+
* "avatar": {
|
|
17171
|
+
* "asset_example01": "Amy Chen at the whiteboard in a geometry class"
|
|
17172
|
+
* }
|
|
17173
|
+
* },
|
|
17174
|
+
* "publishedImageAlt": {
|
|
17175
|
+
* "avatar": {
|
|
17176
|
+
* "asset_example01": "Amy Chen at the whiteboard in a geometry class"
|
|
17177
|
+
* }
|
|
17178
|
+
* },
|
|
16572
17179
|
* "publishedSlug": "amy-chen",
|
|
16573
17180
|
* "publishedAt": "2026-10-06T08:00:00.000Z",
|
|
16574
17181
|
* "sortOrder": 0,
|
|
@@ -16599,6 +17206,18 @@ export interface operations {
|
|
|
16599
17206
|
publishedFieldData: {
|
|
16600
17207
|
[key: string]: unknown;
|
|
16601
17208
|
} | null;
|
|
17209
|
+
/** @description Draft alt text written for an image where this item uses it, by image or gallery field and asset id: { fieldId: { assetId: alt } }. It overrides the asset's default alt; an image without an entry uses the default. fieldData keeps the asset ids unchanged. */
|
|
17210
|
+
imageAlt: {
|
|
17211
|
+
[key: string]: {
|
|
17212
|
+
[key: string]: string;
|
|
17213
|
+
};
|
|
17214
|
+
};
|
|
17215
|
+
/** @description The same for the published version; null when never published. */
|
|
17216
|
+
publishedImageAlt: {
|
|
17217
|
+
[key: string]: {
|
|
17218
|
+
[key: string]: string;
|
|
17219
|
+
};
|
|
17220
|
+
} | null;
|
|
16602
17221
|
publishedSlug: string | null;
|
|
16603
17222
|
publishedAt: string | null;
|
|
16604
17223
|
sortOrder: number;
|
|
@@ -16700,6 +17319,12 @@ export interface operations {
|
|
|
16700
17319
|
fieldData?: {
|
|
16701
17320
|
[key: string]: unknown;
|
|
16702
17321
|
};
|
|
17322
|
+
/** @description Alt text for an image where this item uses it, overriding the image's default alt from the media library: { [fieldId]: { [assetId]: alt } } for image and gallery fields. A string sets it (at most 500 characters; an empty string clears it), null clears it so the default alt applies again, and entries you leave out are kept. The asset must be the field's current image, or one of its gallery images, after this write. Replacing a field's image drops the alt written for the old one. */
|
|
17323
|
+
imageAlt?: {
|
|
17324
|
+
[key: string]: {
|
|
17325
|
+
[key: string]: string | null;
|
|
17326
|
+
};
|
|
17327
|
+
};
|
|
16703
17328
|
slug?: string;
|
|
16704
17329
|
sortOrder?: number;
|
|
16705
17330
|
/** @description Default true: the write is published immediately. false keeps it as a draft (status draft or changed). */
|
|
@@ -16748,6 +17373,16 @@ export interface operations {
|
|
|
16748
17373
|
* "website": "https://amychen.example.com",
|
|
16749
17374
|
* "course": "item_example02"
|
|
16750
17375
|
* },
|
|
17376
|
+
* "imageAlt": {
|
|
17377
|
+
* "avatar": {
|
|
17378
|
+
* "asset_example01": "Amy Chen at the whiteboard in a geometry class"
|
|
17379
|
+
* }
|
|
17380
|
+
* },
|
|
17381
|
+
* "publishedImageAlt": {
|
|
17382
|
+
* "avatar": {
|
|
17383
|
+
* "asset_example01": "Amy Chen at the whiteboard in a geometry class"
|
|
17384
|
+
* }
|
|
17385
|
+
* },
|
|
16751
17386
|
* "publishedSlug": "amy-chen",
|
|
16752
17387
|
* "publishedAt": "2026-10-06T08:00:00.000Z",
|
|
16753
17388
|
* "sortOrder": 0,
|
|
@@ -16779,6 +17414,18 @@ export interface operations {
|
|
|
16779
17414
|
publishedFieldData: {
|
|
16780
17415
|
[key: string]: unknown;
|
|
16781
17416
|
} | null;
|
|
17417
|
+
/** @description Draft alt text written for an image where this item uses it, by image or gallery field and asset id: { fieldId: { assetId: alt } }. It overrides the asset's default alt; an image without an entry uses the default. fieldData keeps the asset ids unchanged. */
|
|
17418
|
+
imageAlt: {
|
|
17419
|
+
[key: string]: {
|
|
17420
|
+
[key: string]: string;
|
|
17421
|
+
};
|
|
17422
|
+
};
|
|
17423
|
+
/** @description The same for the published version; null when never published. */
|
|
17424
|
+
publishedImageAlt: {
|
|
17425
|
+
[key: string]: {
|
|
17426
|
+
[key: string]: string;
|
|
17427
|
+
};
|
|
17428
|
+
} | null;
|
|
16782
17429
|
publishedSlug: string | null;
|
|
16783
17430
|
publishedAt: string | null;
|
|
16784
17431
|
sortOrder: number;
|
|
@@ -16844,6 +17491,8 @@ export interface operations {
|
|
|
16844
17491
|
* ]
|
|
16845
17492
|
* },
|
|
16846
17493
|
* "publishedFieldData": null,
|
|
17494
|
+
* "imageAlt": {},
|
|
17495
|
+
* "publishedImageAlt": null,
|
|
16847
17496
|
* "publishedSlug": null,
|
|
16848
17497
|
* "publishedAt": null,
|
|
16849
17498
|
* "sortOrder": 0,
|
|
@@ -16874,6 +17523,18 @@ export interface operations {
|
|
|
16874
17523
|
publishedFieldData: {
|
|
16875
17524
|
[key: string]: unknown;
|
|
16876
17525
|
} | null;
|
|
17526
|
+
/** @description Draft alt text written for an image where this item uses it, by image or gallery field and asset id: { fieldId: { assetId: alt } }. It overrides the asset's default alt; an image without an entry uses the default. fieldData keeps the asset ids unchanged. */
|
|
17527
|
+
imageAlt: {
|
|
17528
|
+
[key: string]: {
|
|
17529
|
+
[key: string]: string;
|
|
17530
|
+
};
|
|
17531
|
+
};
|
|
17532
|
+
/** @description The same for the published version; null when never published. */
|
|
17533
|
+
publishedImageAlt: {
|
|
17534
|
+
[key: string]: {
|
|
17535
|
+
[key: string]: string;
|
|
17536
|
+
};
|
|
17537
|
+
} | null;
|
|
16877
17538
|
publishedSlug: string | null;
|
|
16878
17539
|
publishedAt: string | null;
|
|
16879
17540
|
sortOrder: number;
|
|
@@ -16896,6 +17557,7 @@ export interface operations {
|
|
|
16896
17557
|
401: components["responses"]["Error401"];
|
|
16897
17558
|
403: components["responses"]["Error403"];
|
|
16898
17559
|
404: components["responses"]["Error404"];
|
|
17560
|
+
409: components["responses"]["Error409"];
|
|
16899
17561
|
422: components["responses"]["Error422"];
|
|
16900
17562
|
429: components["responses"]["Error429"];
|
|
16901
17563
|
500: components["responses"]["Error500"];
|
|
@@ -16995,6 +17657,16 @@ export interface operations {
|
|
|
16995
17657
|
* "website": "https://amychen.example.com",
|
|
16996
17658
|
* "course": "item_example02"
|
|
16997
17659
|
* },
|
|
17660
|
+
* "imageAlt": {
|
|
17661
|
+
* "avatar": {
|
|
17662
|
+
* "asset_example01": "Amy Chen at the whiteboard in a geometry class"
|
|
17663
|
+
* }
|
|
17664
|
+
* },
|
|
17665
|
+
* "publishedImageAlt": {
|
|
17666
|
+
* "avatar": {
|
|
17667
|
+
* "asset_example01": "Amy Chen at the whiteboard in a geometry class"
|
|
17668
|
+
* }
|
|
17669
|
+
* },
|
|
16998
17670
|
* "publishedSlug": "amy-chen",
|
|
16999
17671
|
* "publishedAt": "2026-10-06T08:00:00.000Z",
|
|
17000
17672
|
* "sortOrder": 0,
|
|
@@ -17025,6 +17697,18 @@ export interface operations {
|
|
|
17025
17697
|
publishedFieldData: {
|
|
17026
17698
|
[key: string]: unknown;
|
|
17027
17699
|
} | null;
|
|
17700
|
+
/** @description Draft alt text written for an image where this item uses it, by image or gallery field and asset id: { fieldId: { assetId: alt } }. It overrides the asset's default alt; an image without an entry uses the default. fieldData keeps the asset ids unchanged. */
|
|
17701
|
+
imageAlt: {
|
|
17702
|
+
[key: string]: {
|
|
17703
|
+
[key: string]: string;
|
|
17704
|
+
};
|
|
17705
|
+
};
|
|
17706
|
+
/** @description The same for the published version; null when never published. */
|
|
17707
|
+
publishedImageAlt: {
|
|
17708
|
+
[key: string]: {
|
|
17709
|
+
[key: string]: string;
|
|
17710
|
+
};
|
|
17711
|
+
} | null;
|
|
17028
17712
|
publishedSlug: string | null;
|
|
17029
17713
|
publishedAt: string | null;
|
|
17030
17714
|
sortOrder: number;
|
|
@@ -17114,6 +17798,16 @@ export interface operations {
|
|
|
17114
17798
|
* "website": "https://amychen.example.com",
|
|
17115
17799
|
* "course": "item_example02"
|
|
17116
17800
|
* },
|
|
17801
|
+
* "imageAlt": {
|
|
17802
|
+
* "avatar": {
|
|
17803
|
+
* "asset_example01": "Amy Chen at the whiteboard in a geometry class"
|
|
17804
|
+
* }
|
|
17805
|
+
* },
|
|
17806
|
+
* "publishedImageAlt": {
|
|
17807
|
+
* "avatar": {
|
|
17808
|
+
* "asset_example01": "Amy Chen at the whiteboard in a geometry class"
|
|
17809
|
+
* }
|
|
17810
|
+
* },
|
|
17117
17811
|
* "publishedSlug": "amy-chen",
|
|
17118
17812
|
* "publishedAt": "2026-10-06T08:00:00.000Z",
|
|
17119
17813
|
* "sortOrder": 0,
|
|
@@ -17144,6 +17838,18 @@ export interface operations {
|
|
|
17144
17838
|
publishedFieldData: {
|
|
17145
17839
|
[key: string]: unknown;
|
|
17146
17840
|
} | null;
|
|
17841
|
+
/** @description Draft alt text written for an image where this item uses it, by image or gallery field and asset id: { fieldId: { assetId: alt } }. It overrides the asset's default alt; an image without an entry uses the default. fieldData keeps the asset ids unchanged. */
|
|
17842
|
+
imageAlt: {
|
|
17843
|
+
[key: string]: {
|
|
17844
|
+
[key: string]: string;
|
|
17845
|
+
};
|
|
17846
|
+
};
|
|
17847
|
+
/** @description The same for the published version; null when never published. */
|
|
17848
|
+
publishedImageAlt: {
|
|
17849
|
+
[key: string]: {
|
|
17850
|
+
[key: string]: string;
|
|
17851
|
+
};
|
|
17852
|
+
} | null;
|
|
17147
17853
|
publishedSlug: string | null;
|
|
17148
17854
|
publishedAt: string | null;
|
|
17149
17855
|
sortOrder: number;
|
|
@@ -17222,6 +17928,16 @@ export interface operations {
|
|
|
17222
17928
|
* "website": "https://amychen.example.com",
|
|
17223
17929
|
* "course": "item_example02"
|
|
17224
17930
|
* },
|
|
17931
|
+
* "imageAlt": {
|
|
17932
|
+
* "avatar": {
|
|
17933
|
+
* "asset_example01": "Amy Chen at the whiteboard in a geometry class"
|
|
17934
|
+
* }
|
|
17935
|
+
* },
|
|
17936
|
+
* "publishedImageAlt": {
|
|
17937
|
+
* "avatar": {
|
|
17938
|
+
* "asset_example01": "Amy Chen at the whiteboard in a geometry class"
|
|
17939
|
+
* }
|
|
17940
|
+
* },
|
|
17225
17941
|
* "publishedSlug": "amy-chen",
|
|
17226
17942
|
* "publishedAt": "2026-10-06T08:00:00.000Z",
|
|
17227
17943
|
* "sortOrder": 0,
|
|
@@ -17252,6 +17968,18 @@ export interface operations {
|
|
|
17252
17968
|
publishedFieldData: {
|
|
17253
17969
|
[key: string]: unknown;
|
|
17254
17970
|
} | null;
|
|
17971
|
+
/** @description Draft alt text written for an image where this item uses it, by image or gallery field and asset id: { fieldId: { assetId: alt } }. It overrides the asset's default alt; an image without an entry uses the default. fieldData keeps the asset ids unchanged. */
|
|
17972
|
+
imageAlt: {
|
|
17973
|
+
[key: string]: {
|
|
17974
|
+
[key: string]: string;
|
|
17975
|
+
};
|
|
17976
|
+
};
|
|
17977
|
+
/** @description The same for the published version; null when never published. */
|
|
17978
|
+
publishedImageAlt: {
|
|
17979
|
+
[key: string]: {
|
|
17980
|
+
[key: string]: string;
|
|
17981
|
+
};
|
|
17982
|
+
} | null;
|
|
17255
17983
|
publishedSlug: string | null;
|
|
17256
17984
|
publishedAt: string | null;
|
|
17257
17985
|
sortOrder: number;
|
|
@@ -17792,7 +18520,7 @@ export interface operations {
|
|
|
17792
18520
|
checkedAt: string;
|
|
17793
18521
|
checks: {
|
|
17794
18522
|
/**
|
|
17795
|
-
* @description i18n_* checks appear only on multilingual sites
|
|
18523
|
+
* @description i18n_* checks appear only on multilingual sites. They sample translated content from the sitemap (pages, blog posts, products, collection items with a URL): the content under its locale's URL, hreflang alternates on its primary-locale page, and per-locale llms.txt. hosted_redirect, gsc and customer_auth cover the system host 302, Search Console property alignment and the Customer API CORS allowlist.
|
|
17796
18524
|
* @enum {string}
|
|
17797
18525
|
*/
|
|
17798
18526
|
id: "derivatives" | "jsonld" | "content" | "analytics" | "revalidate" | "indexnow" | "hosted_redirect" | "gsc" | "customer_auth" | "i18n_pages" | "i18n_alternates" | "i18n_files";
|
|
@@ -17900,7 +18628,7 @@ export interface operations {
|
|
|
17900
18628
|
filter?: {
|
|
17901
18629
|
/** @description Only deliver collections.* events for these collection keys. */
|
|
17902
18630
|
collectionKeys?: string[];
|
|
17903
|
-
/** @description Only deliver customers.form.submitted
|
|
18631
|
+
/** @description Only deliver form events (customers.form.submitted, forms.form.updated and forms.form.deleted) for these form IDs. */
|
|
17904
18632
|
formIds?: string[];
|
|
17905
18633
|
} | null;
|
|
17906
18634
|
recentDeliveries: {
|
|
@@ -17970,7 +18698,7 @@ export interface operations {
|
|
|
17970
18698
|
filter?: {
|
|
17971
18699
|
/** @description Only deliver collections.* events for these collection keys. */
|
|
17972
18700
|
collectionKeys?: string[];
|
|
17973
|
-
/** @description Only deliver customers.form.submitted
|
|
18701
|
+
/** @description Only deliver form events (customers.form.submitted, forms.form.updated and forms.form.deleted) for these form IDs. */
|
|
17974
18702
|
formIds?: string[];
|
|
17975
18703
|
} | null;
|
|
17976
18704
|
};
|
|
@@ -18003,7 +18731,7 @@ export interface operations {
|
|
|
18003
18731
|
filter?: {
|
|
18004
18732
|
/** @description Only deliver collections.* events for these collection keys. */
|
|
18005
18733
|
collectionKeys?: string[];
|
|
18006
|
-
/** @description Only deliver customers.form.submitted
|
|
18734
|
+
/** @description Only deliver form events (customers.form.submitted, forms.form.updated and forms.form.deleted) for these form IDs. */
|
|
18007
18735
|
formIds?: string[];
|
|
18008
18736
|
} | null;
|
|
18009
18737
|
};
|
|
@@ -18035,13 +18763,11 @@ export interface operations {
|
|
|
18035
18763
|
/**
|
|
18036
18764
|
* @example {
|
|
18037
18765
|
* "events": [
|
|
18038
|
-
* "collections.item.published"
|
|
18766
|
+
* "collections.item.published",
|
|
18767
|
+
* "collections.items.bulkChanged",
|
|
18768
|
+
* "content.translation.published"
|
|
18039
18769
|
* ],
|
|
18040
|
-
* "filter":
|
|
18041
|
-
* "collectionKeys": [
|
|
18042
|
-
* "blog"
|
|
18043
|
-
* ]
|
|
18044
|
-
* }
|
|
18770
|
+
* "filter": null
|
|
18045
18771
|
* }
|
|
18046
18772
|
*/
|
|
18047
18773
|
"application/json": {
|
|
@@ -18051,7 +18777,7 @@ export interface operations {
|
|
|
18051
18777
|
filter?: {
|
|
18052
18778
|
/** @description Only deliver collections.* events for these collection keys. */
|
|
18053
18779
|
collectionKeys?: string[];
|
|
18054
|
-
/** @description Only deliver customers.form.submitted
|
|
18780
|
+
/** @description Only deliver form events (customers.form.submitted, forms.form.updated and forms.form.deleted) for these form IDs. */
|
|
18055
18781
|
formIds?: string[];
|
|
18056
18782
|
} | null;
|
|
18057
18783
|
};
|
|
@@ -18068,25 +18794,114 @@ export interface operations {
|
|
|
18068
18794
|
* @example {
|
|
18069
18795
|
* "id": "wh_example01",
|
|
18070
18796
|
* "subscribedEvents": [
|
|
18071
|
-
* "collections.item.published"
|
|
18797
|
+
* "collections.item.published",
|
|
18798
|
+
* "collections.items.bulkChanged",
|
|
18799
|
+
* "content.translation.published"
|
|
18072
18800
|
* ],
|
|
18073
|
-
* "filter":
|
|
18074
|
-
*
|
|
18075
|
-
|
|
18076
|
-
|
|
18077
|
-
|
|
18801
|
+
* "filter": null
|
|
18802
|
+
* }
|
|
18803
|
+
*/
|
|
18804
|
+
"application/json": {
|
|
18805
|
+
id: string;
|
|
18806
|
+
subscribedEvents: string[] | null;
|
|
18807
|
+
/** @description Optional sub-event filter for collection keys or form IDs. */
|
|
18808
|
+
filter?: {
|
|
18809
|
+
/** @description Only deliver collections.* events for these collection keys. */
|
|
18810
|
+
collectionKeys?: string[];
|
|
18811
|
+
/** @description Only deliver form events (customers.form.submitted, forms.form.updated and forms.form.deleted) for these form IDs. */
|
|
18812
|
+
formIds?: string[];
|
|
18813
|
+
} | null;
|
|
18814
|
+
};
|
|
18815
|
+
};
|
|
18816
|
+
};
|
|
18817
|
+
400: components["responses"]["Error400"];
|
|
18818
|
+
401: components["responses"]["Error401"];
|
|
18819
|
+
403: components["responses"]["Error403"];
|
|
18820
|
+
404: components["responses"]["Error404"];
|
|
18821
|
+
429: components["responses"]["Error429"];
|
|
18822
|
+
500: components["responses"]["Error500"];
|
|
18823
|
+
503: components["responses"]["Error503"];
|
|
18824
|
+
};
|
|
18825
|
+
};
|
|
18826
|
+
webhooks_get: {
|
|
18827
|
+
parameters: {
|
|
18828
|
+
query?: never;
|
|
18829
|
+
header?: never;
|
|
18830
|
+
path: {
|
|
18831
|
+
/** @description Website id. Get it from sites.list or from sites.create. */
|
|
18832
|
+
id: string;
|
|
18833
|
+
/** @description Webhook destination id. Get it from webhooks.list. */
|
|
18834
|
+
webhookId: string;
|
|
18835
|
+
};
|
|
18836
|
+
cookie?: never;
|
|
18837
|
+
};
|
|
18838
|
+
requestBody?: never;
|
|
18839
|
+
responses: {
|
|
18840
|
+
/** @description OK */
|
|
18841
|
+
200: {
|
|
18842
|
+
headers: {
|
|
18843
|
+
[name: string]: unknown;
|
|
18844
|
+
};
|
|
18845
|
+
content: {
|
|
18846
|
+
/**
|
|
18847
|
+
* @example {
|
|
18848
|
+
* "id": "wh_example01",
|
|
18849
|
+
* "label": "Vercel ISR Revalidate",
|
|
18850
|
+
* "addressPreview": "https://www.sunnybakery.example/…date",
|
|
18851
|
+
* "status": "ACTIVE",
|
|
18852
|
+
* "withinPlan": true,
|
|
18853
|
+
* "autoDisabled": false,
|
|
18854
|
+
* "createdAt": "2026-10-01T02:30:00.000Z",
|
|
18855
|
+
* "subscribedEvents": [
|
|
18856
|
+
* "collections.item.published",
|
|
18857
|
+
* "collections.items.bulkChanged"
|
|
18858
|
+
* ],
|
|
18859
|
+
* "filter": null,
|
|
18860
|
+
* "recentDeliveries": [
|
|
18861
|
+
* {
|
|
18862
|
+
* "id": "msg_example01",
|
|
18863
|
+
* "eventKey": "collections.item.published",
|
|
18864
|
+
* "status": "SENT",
|
|
18865
|
+
* "error": null,
|
|
18866
|
+
* "createdAt": "2026-10-06T08:00:00.000Z",
|
|
18867
|
+
* "attempts": 1,
|
|
18868
|
+
* "nextRetryAt": null,
|
|
18869
|
+
* "statusCode": 200,
|
|
18870
|
+
* "durationMs": 142
|
|
18871
|
+
* }
|
|
18872
|
+
* ]
|
|
18078
18873
|
* }
|
|
18079
18874
|
*/
|
|
18080
18875
|
"application/json": {
|
|
18081
18876
|
id: string;
|
|
18877
|
+
label: string | null;
|
|
18878
|
+
/** @description Masked destination URL (domain + last 4 chars of path). */
|
|
18879
|
+
addressPreview: string | null;
|
|
18880
|
+
/** @description ACTIVE or DISABLED. */
|
|
18881
|
+
status: string;
|
|
18882
|
+
withinPlan: boolean;
|
|
18883
|
+
autoDisabled: boolean;
|
|
18884
|
+
createdAt: string;
|
|
18885
|
+
/** @description null = subscribed to all events (including future events); array = only these event keys. */
|
|
18082
18886
|
subscribedEvents: string[] | null;
|
|
18083
18887
|
/** @description Optional sub-event filter for collection keys or form IDs. */
|
|
18084
18888
|
filter?: {
|
|
18085
18889
|
/** @description Only deliver collections.* events for these collection keys. */
|
|
18086
18890
|
collectionKeys?: string[];
|
|
18087
|
-
/** @description Only deliver customers.form.submitted
|
|
18891
|
+
/** @description Only deliver form events (customers.form.submitted, forms.form.updated and forms.form.deleted) for these form IDs. */
|
|
18088
18892
|
formIds?: string[];
|
|
18089
18893
|
} | null;
|
|
18894
|
+
recentDeliveries: {
|
|
18895
|
+
id: string;
|
|
18896
|
+
eventKey: string;
|
|
18897
|
+
status: string;
|
|
18898
|
+
error: string | null;
|
|
18899
|
+
createdAt: string;
|
|
18900
|
+
attempts: number;
|
|
18901
|
+
nextRetryAt: string | null;
|
|
18902
|
+
statusCode: number | null;
|
|
18903
|
+
durationMs: number | null;
|
|
18904
|
+
}[];
|
|
18090
18905
|
};
|
|
18091
18906
|
};
|
|
18092
18907
|
};
|
|
@@ -18320,9 +19135,11 @@ export interface operations {
|
|
|
18320
19135
|
locale: string;
|
|
18321
19136
|
/** @description Default true. */
|
|
18322
19137
|
autoTranslate?: boolean;
|
|
19138
|
+
/** @description Default true: with autoTranslate the locale goes live when the full-site job finishes. false keeps it DRAFT after translating; publish it with localization.locales.update. Ignored when autoTranslate is false. */
|
|
19139
|
+
publishWhenTranslated?: boolean;
|
|
18323
19140
|
/** @description URL prefix for this locale (lowercase letters, digits and hyphens, 2-30 chars), e.g. en or en-gb. Visitors reach the locale at /{prefix}/... Changing a live locale's prefix 301-redirects the old prefix. */
|
|
18324
19141
|
pathPrefix?: string;
|
|
18325
|
-
/** @description Must be true: with autoTranslate the whole site is translated and the locale goes live when done. */
|
|
19142
|
+
/** @description Must be true: with autoTranslate the whole site is translated (and, unless publishWhenTranslated is false, the locale goes live when done). */
|
|
18326
19143
|
confirm: boolean;
|
|
18327
19144
|
};
|
|
18328
19145
|
};
|
|
@@ -18678,10 +19495,10 @@ export interface operations {
|
|
|
18678
19495
|
parameters: {
|
|
18679
19496
|
query: {
|
|
18680
19497
|
/**
|
|
18681
|
-
* @description Translatable record type. page (pages.list ids), global_sections, site_settings and store_settings (the site itself: entityId defaults to websiteId), post / post_category / post_tag / author (blog), product / product_option / pricing_tier / product_category, deliverable / deliverable_unit, form, top_bar_banner / modal_announcement / floating_widget, collection_item (custom collection items), message_template (an automated email whose content the owner changed; the id of the customized template — untouched emails use the built-in version for every language), media_transcript (a video or audio transcript: media.transcripts.list ids; its translation becomes a subtitle track in that locale, paths are segments[i].t).
|
|
19498
|
+
* @description Translatable record type. page (pages.list ids), global_sections, site_settings and store_settings (the site itself: entityId defaults to websiteId), post / post_category / post_tag / author (blog), product / product_option / pricing_tier / product_category, deliverable / deliverable_unit, form, top_bar_banner / modal_announcement / floating_widget, collection_item (custom collection items), message_template (an automated email whose content the owner changed; the id of the customized template — untouched emails use the built-in version for every language), media_transcript (a video or audio transcript: media.transcripts.list ids; its translation becomes a subtitle track in that locale, paths are segments[i].t), media_asset (an image's default alt text in the media library: the asset id from media.list, path altText; live on write).
|
|
18682
19499
|
* @example product
|
|
18683
19500
|
*/
|
|
18684
|
-
entityType: "page" | "global_sections" | "site_settings" | "store_settings" | "post" | "post_category" | "post_tag" | "author" | "product" | "product_option" | "pricing_tier" | "product_category" | "deliverable" | "deliverable_unit" | "form" | "top_bar_banner" | "modal_announcement" | "floating_widget" | "collection_item" | "message_template" | "media_transcript";
|
|
19501
|
+
entityType: "page" | "global_sections" | "site_settings" | "store_settings" | "post" | "post_category" | "post_tag" | "author" | "product" | "product_option" | "pricing_tier" | "product_category" | "deliverable" | "deliverable_unit" | "form" | "top_bar_banner" | "modal_announcement" | "floating_widget" | "collection_item" | "message_template" | "media_transcript" | "media_asset";
|
|
18685
19502
|
/** @description Only this record. */
|
|
18686
19503
|
entityId?: string;
|
|
18687
19504
|
/**
|
|
@@ -18721,6 +19538,7 @@ export interface operations {
|
|
|
18721
19538
|
* "entityId": "prod_example01",
|
|
18722
19539
|
* "locale": "fr-FR",
|
|
18723
19540
|
* "status": "PUBLISHED",
|
|
19541
|
+
* "publishState": "published",
|
|
18724
19542
|
* "translatedBy": "AGENT",
|
|
18725
19543
|
* "fieldCount": 2,
|
|
18726
19544
|
* "sourceHash": "c1a0e6f2b47d93e8",
|
|
@@ -18738,10 +19556,15 @@ export interface operations {
|
|
|
18738
19556
|
entityId: string;
|
|
18739
19557
|
locale: string;
|
|
18740
19558
|
/**
|
|
18741
|
-
* @description PUBLISHED =
|
|
19559
|
+
* @description PUBLISHED = a published copy exists and is live; it can still be older than the draft copy (see publishState).
|
|
18742
19560
|
* @enum {string}
|
|
18743
19561
|
*/
|
|
18744
19562
|
status: "DRAFT" | "PUBLISHED";
|
|
19563
|
+
/**
|
|
19564
|
+
* @description draft = never put live; published = the live copy matches the draft copy; changed = live, but the draft copy has edits (text or slug) that visitors do not see yet. Put them live with localization.translations.publish, or by publishing the record.
|
|
19565
|
+
* @enum {string}
|
|
19566
|
+
*/
|
|
19567
|
+
publishState: "draft" | "published" | "changed";
|
|
18745
19568
|
/**
|
|
18746
19569
|
* @description Most significant author across fields: HUMAN > SEO_FIX > AGENT > EXTERNAL > MACHINE.
|
|
18747
19570
|
* @enum {string}
|
|
@@ -18769,6 +19592,110 @@ export interface operations {
|
|
|
18769
19592
|
503: components["responses"]["Error503"];
|
|
18770
19593
|
};
|
|
18771
19594
|
};
|
|
19595
|
+
localization_translations_pending: {
|
|
19596
|
+
parameters: {
|
|
19597
|
+
query: {
|
|
19598
|
+
/**
|
|
19599
|
+
* @description Translatable record type. page (pages.list ids), global_sections, site_settings and store_settings (the site itself: entityId defaults to websiteId), post / post_category / post_tag / author (blog), product / product_option / pricing_tier / product_category, deliverable / deliverable_unit, form, top_bar_banner / modal_announcement / floating_widget, collection_item (custom collection items), message_template (an automated email whose content the owner changed; the id of the customized template — untouched emails use the built-in version for every language), media_transcript (a video or audio transcript: media.transcripts.list ids; its translation becomes a subtitle track in that locale, paths are segments[i].t), media_asset (an image's default alt text in the media library: the asset id from media.list, path altText; live on write).
|
|
19600
|
+
* @example product
|
|
19601
|
+
*/
|
|
19602
|
+
entityType: "page" | "global_sections" | "site_settings" | "store_settings" | "post" | "post_category" | "post_tag" | "author" | "product" | "product_option" | "pricing_tier" | "product_category" | "deliverable" | "deliverable_unit" | "form" | "top_bar_banner" | "modal_announcement" | "floating_widget" | "collection_item" | "message_template" | "media_transcript" | "media_asset";
|
|
19603
|
+
/**
|
|
19604
|
+
* @description A secondary locale of the website.
|
|
19605
|
+
* @example fr-FR
|
|
19606
|
+
*/
|
|
19607
|
+
locale: string;
|
|
19608
|
+
/** @description Only fields in this state; omit for both. */
|
|
19609
|
+
state?: "missing" | "outdated";
|
|
19610
|
+
/** @description Maximum number of items to return, 1–50. Defaults to 20. */
|
|
19611
|
+
limit?: number;
|
|
19612
|
+
/** @description Opaque cursor from the previous page's nextCursor. Omit for the first page. */
|
|
19613
|
+
cursor?: string;
|
|
19614
|
+
};
|
|
19615
|
+
header?: never;
|
|
19616
|
+
path: {
|
|
19617
|
+
/** @description Website id. Get it from sites.list or from sites.create. */
|
|
19618
|
+
id: string;
|
|
19619
|
+
};
|
|
19620
|
+
cookie?: never;
|
|
19621
|
+
};
|
|
19622
|
+
requestBody?: never;
|
|
19623
|
+
responses: {
|
|
19624
|
+
/** @description OK */
|
|
19625
|
+
200: {
|
|
19626
|
+
headers: {
|
|
19627
|
+
[name: string]: unknown;
|
|
19628
|
+
};
|
|
19629
|
+
content: {
|
|
19630
|
+
/**
|
|
19631
|
+
* @example {
|
|
19632
|
+
* "data": [
|
|
19633
|
+
* {
|
|
19634
|
+
* "entityId": "prod_example01",
|
|
19635
|
+
* "label": "Country Sourdough",
|
|
19636
|
+
* "sourceHash": "c1a0e6f2b47d93e8",
|
|
19637
|
+
* "translationStatus": "PUBLISHED",
|
|
19638
|
+
* "fields": [
|
|
19639
|
+
* {
|
|
19640
|
+
* "path": "description",
|
|
19641
|
+
* "value": "Slow-fermented for 48 hours with **stone-ground** whole wheat.",
|
|
19642
|
+
* "profile": "body",
|
|
19643
|
+
* "sourceHash": "0b7c44d2",
|
|
19644
|
+
* "status": "outdated"
|
|
19645
|
+
* }
|
|
19646
|
+
* ]
|
|
19647
|
+
* }
|
|
19648
|
+
* ],
|
|
19649
|
+
* "hasMore": false,
|
|
19650
|
+
* "nextCursor": null
|
|
19651
|
+
* }
|
|
19652
|
+
*/
|
|
19653
|
+
"application/json": {
|
|
19654
|
+
data: {
|
|
19655
|
+
/** @description Record id (the websiteId for global_sections, site_settings and store_settings). */
|
|
19656
|
+
entityId: string;
|
|
19657
|
+
/** @description The record's name for people (page or post title, item title, form name…). */
|
|
19658
|
+
label: string;
|
|
19659
|
+
/** @description Fingerprint of all of the record's source fields: pass it as sourceHash to localization.translations.upsert. */
|
|
19660
|
+
sourceHash: string;
|
|
19661
|
+
/** @description This locale's translation row; null when nothing has been translated yet. */
|
|
19662
|
+
translationStatus: ("DRAFT" | "PUBLISHED") | null;
|
|
19663
|
+
/** @description Only the fields that need work, in the same shape as localization.translations.get source.fields: status missing (no translation) or outdated (the source changed after it was translated). */
|
|
19664
|
+
fields: {
|
|
19665
|
+
/** @description Field path to use as a key in fieldData (array indexes and section ids already filled in). */
|
|
19666
|
+
path: string;
|
|
19667
|
+
/** @description Current source text in the primary locale (editable draft). For profile json, the field's whole value as JSON text. */
|
|
19668
|
+
value: string;
|
|
19669
|
+
/**
|
|
19670
|
+
* @description Text format: plain = no markup; inline = inline Markdown only (bold, italic, links); body / article = Markdown blocks (article also keeps images and headings); email = email-safe Markdown. Keep the same markup in the translation. json = a localized json, image or gallery field of a collection item: the translation is this locale's whole value, written as JSON text (JSON.stringify of the value: the json value, an asset id, or a list of asset ids) and checked like the field's own value (size, depth, its JSON Schema); machine translation never translates it, so a locale without one shows the primary value.
|
|
19671
|
+
* @enum {string}
|
|
19672
|
+
*/
|
|
19673
|
+
profile: "plain" | "inline" | "body" | "article" | "email" | "json";
|
|
19674
|
+
sourceHash: string;
|
|
19675
|
+
/**
|
|
19676
|
+
* @description missing = no translation yet; current = translated from this exact source; outdated = the source changed after it was translated.
|
|
19677
|
+
* @enum {string}
|
|
19678
|
+
*/
|
|
19679
|
+
status: "missing" | "current" | "outdated";
|
|
19680
|
+
}[];
|
|
19681
|
+
}[];
|
|
19682
|
+
/** @description True when another page exists; pass nextCursor to fetch it. */
|
|
19683
|
+
hasMore: boolean;
|
|
19684
|
+
/** @description Cursor for the next page, or null on the last page. */
|
|
19685
|
+
nextCursor: string | null;
|
|
19686
|
+
};
|
|
19687
|
+
};
|
|
19688
|
+
};
|
|
19689
|
+
400: components["responses"]["Error400"];
|
|
19690
|
+
401: components["responses"]["Error401"];
|
|
19691
|
+
403: components["responses"]["Error403"];
|
|
19692
|
+
404: components["responses"]["Error404"];
|
|
19693
|
+
422: components["responses"]["Error422"];
|
|
19694
|
+
429: components["responses"]["Error429"];
|
|
19695
|
+
500: components["responses"]["Error500"];
|
|
19696
|
+
503: components["responses"]["Error503"];
|
|
19697
|
+
};
|
|
19698
|
+
};
|
|
18772
19699
|
localization_translations_get: {
|
|
18773
19700
|
parameters: {
|
|
18774
19701
|
query?: never;
|
|
@@ -18776,7 +19703,7 @@ export interface operations {
|
|
|
18776
19703
|
path: {
|
|
18777
19704
|
/** @description Website id. Get it from sites.list or from sites.create. */
|
|
18778
19705
|
id: string;
|
|
18779
|
-
/** @description Translatable record type. page (pages.list ids), global_sections, site_settings and store_settings (the site itself: entityId defaults to websiteId), post / post_category / post_tag / author (blog), product / product_option / pricing_tier / product_category, deliverable / deliverable_unit, form, top_bar_banner / modal_announcement / floating_widget, collection_item (custom collection items), message_template (an automated email whose content the owner changed; the id of the customized template — untouched emails use the built-in version for every language), media_transcript (a video or audio transcript: media.transcripts.list ids; its translation becomes a subtitle track in that locale, paths are segments[i].t). */
|
|
19706
|
+
/** @description Translatable record type. page (pages.list ids), global_sections, site_settings and store_settings (the site itself: entityId defaults to websiteId), post / post_category / post_tag / author (blog), product / product_option / pricing_tier / product_category, deliverable / deliverable_unit, form, top_bar_banner / modal_announcement / floating_widget, collection_item (custom collection items), message_template (an automated email whose content the owner changed; the id of the customized template — untouched emails use the built-in version for every language), media_transcript (a video or audio transcript: media.transcripts.list ids; its translation becomes a subtitle track in that locale, paths are segments[i].t), media_asset (an image's default alt text in the media library: the asset id from media.list, path altText; live on write). */
|
|
18780
19707
|
entityType: string;
|
|
18781
19708
|
/** @description Record id. Required except for global_sections and site_settings, whose id is the websiteId. */
|
|
18782
19709
|
entityId: string;
|
|
@@ -18803,6 +19730,7 @@ export interface operations {
|
|
|
18803
19730
|
* "entityId": "prod_example01",
|
|
18804
19731
|
* "locale": "fr-FR",
|
|
18805
19732
|
* "status": "PUBLISHED",
|
|
19733
|
+
* "publishState": "published",
|
|
18806
19734
|
* "translatedBy": "AGENT",
|
|
18807
19735
|
* "fieldCount": 2,
|
|
18808
19736
|
* "sourceHash": "c1a0e6f2b47d93e8",
|
|
@@ -18859,10 +19787,15 @@ export interface operations {
|
|
|
18859
19787
|
entityId: string;
|
|
18860
19788
|
locale: string;
|
|
18861
19789
|
/**
|
|
18862
|
-
* @description PUBLISHED =
|
|
19790
|
+
* @description PUBLISHED = a published copy exists and is live; it can still be older than the draft copy (see publishState).
|
|
18863
19791
|
* @enum {string}
|
|
18864
19792
|
*/
|
|
18865
19793
|
status: "DRAFT" | "PUBLISHED";
|
|
19794
|
+
/**
|
|
19795
|
+
* @description draft = never put live; published = the live copy matches the draft copy; changed = live, but the draft copy has edits (text or slug) that visitors do not see yet. Put them live with localization.translations.publish, or by publishing the record.
|
|
19796
|
+
* @enum {string}
|
|
19797
|
+
*/
|
|
19798
|
+
publishState: "draft" | "published" | "changed";
|
|
18866
19799
|
/**
|
|
18867
19800
|
* @description Most significant author across fields: HUMAN > SEO_FIX > AGENT > EXTERNAL > MACHINE.
|
|
18868
19801
|
* @enum {string}
|
|
@@ -18901,13 +19834,13 @@ export interface operations {
|
|
|
18901
19834
|
fields: {
|
|
18902
19835
|
/** @description Field path to use as a key in fieldData (array indexes and section ids already filled in). */
|
|
18903
19836
|
path: string;
|
|
18904
|
-
/** @description Current source text in the primary locale (editable draft). */
|
|
19837
|
+
/** @description Current source text in the primary locale (editable draft). For profile json, the field's whole value as JSON text. */
|
|
18905
19838
|
value: string;
|
|
18906
19839
|
/**
|
|
18907
|
-
* @description Text format: plain = no markup; inline = inline Markdown only (bold, italic, links); body / article = Markdown blocks (article also keeps images and headings); email = email-safe Markdown. Keep the same markup in the translation.
|
|
19840
|
+
* @description Text format: plain = no markup; inline = inline Markdown only (bold, italic, links); body / article = Markdown blocks (article also keeps images and headings); email = email-safe Markdown. Keep the same markup in the translation. json = a localized json, image or gallery field of a collection item: the translation is this locale's whole value, written as JSON text (JSON.stringify of the value: the json value, an asset id, or a list of asset ids) and checked like the field's own value (size, depth, its JSON Schema); machine translation never translates it, so a locale without one shows the primary value.
|
|
18908
19841
|
* @enum {string}
|
|
18909
19842
|
*/
|
|
18910
|
-
profile: "plain" | "inline" | "body" | "article" | "email";
|
|
19843
|
+
profile: "plain" | "inline" | "body" | "article" | "email" | "json";
|
|
18911
19844
|
sourceHash: string;
|
|
18912
19845
|
/**
|
|
18913
19846
|
* @description missing = no translation yet; current = translated from this exact source; outdated = the source changed after it was translated.
|
|
@@ -18936,7 +19869,7 @@ export interface operations {
|
|
|
18936
19869
|
path: {
|
|
18937
19870
|
/** @description Website id. Get it from sites.list or from sites.create. */
|
|
18938
19871
|
id: string;
|
|
18939
|
-
/** @description Translatable record type. page (pages.list ids), global_sections, site_settings and store_settings (the site itself: entityId defaults to websiteId), post / post_category / post_tag / author (blog), product / product_option / pricing_tier / product_category, deliverable / deliverable_unit, form, top_bar_banner / modal_announcement / floating_widget, collection_item (custom collection items), message_template (an automated email whose content the owner changed; the id of the customized template — untouched emails use the built-in version for every language), media_transcript (a video or audio transcript: media.transcripts.list ids; its translation becomes a subtitle track in that locale, paths are segments[i].t). */
|
|
19872
|
+
/** @description Translatable record type. page (pages.list ids), global_sections, site_settings and store_settings (the site itself: entityId defaults to websiteId), post / post_category / post_tag / author (blog), product / product_option / pricing_tier / product_category, deliverable / deliverable_unit, form, top_bar_banner / modal_announcement / floating_widget, collection_item (custom collection items), message_template (an automated email whose content the owner changed; the id of the customized template — untouched emails use the built-in version for every language), media_transcript (a video or audio transcript: media.transcripts.list ids; its translation becomes a subtitle track in that locale, paths are segments[i].t), media_asset (an image's default alt text in the media library: the asset id from media.list, path altText; live on write). */
|
|
18940
19873
|
entityType: string;
|
|
18941
19874
|
/** @description Record id. Required except for global_sections and site_settings, whose id is the websiteId. */
|
|
18942
19875
|
entityId: string;
|
|
@@ -18958,7 +19891,7 @@ export interface operations {
|
|
|
18958
19891
|
*/
|
|
18959
19892
|
"application/json": {
|
|
18960
19893
|
/**
|
|
18961
|
-
* @description Field path → translated text, keeping the source's Markdown for inline / body / article fields. May be empty when only slug changes.
|
|
19894
|
+
* @description Field path → translated text, keeping the source's Markdown for inline / body / article fields. For a json path (profile json), this locale's whole value as JSON text (JSON.stringify of the value); null, "" or [] clears it. May be empty when only slug changes.
|
|
18962
19895
|
* @default {}
|
|
18963
19896
|
*/
|
|
18964
19897
|
fieldData?: {
|
|
@@ -18990,6 +19923,7 @@ export interface operations {
|
|
|
18990
19923
|
* "entityId": "prod_example01",
|
|
18991
19924
|
* "locale": "fr-FR",
|
|
18992
19925
|
* "status": "PUBLISHED",
|
|
19926
|
+
* "publishState": "published",
|
|
18993
19927
|
* "translatedBy": "AGENT",
|
|
18994
19928
|
* "fieldCount": 2,
|
|
18995
19929
|
* "sourceHash": "c1a0e6f2b47d93e8",
|
|
@@ -19025,10 +19959,15 @@ export interface operations {
|
|
|
19025
19959
|
entityId: string;
|
|
19026
19960
|
locale: string;
|
|
19027
19961
|
/**
|
|
19028
|
-
* @description PUBLISHED =
|
|
19962
|
+
* @description PUBLISHED = a published copy exists and is live; it can still be older than the draft copy (see publishState).
|
|
19029
19963
|
* @enum {string}
|
|
19030
19964
|
*/
|
|
19031
19965
|
status: "DRAFT" | "PUBLISHED";
|
|
19966
|
+
/**
|
|
19967
|
+
* @description draft = never put live; published = the live copy matches the draft copy; changed = live, but the draft copy has edits (text or slug) that visitors do not see yet. Put them live with localization.translations.publish, or by publishing the record.
|
|
19968
|
+
* @enum {string}
|
|
19969
|
+
*/
|
|
19970
|
+
publishState: "draft" | "published" | "changed";
|
|
19032
19971
|
/**
|
|
19033
19972
|
* @description Most significant author across fields: HUMAN > SEO_FIX > AGENT > EXTERNAL > MACHINE.
|
|
19034
19973
|
* @enum {string}
|
|
@@ -19061,7 +20000,7 @@ export interface operations {
|
|
|
19061
20000
|
slug: string | null;
|
|
19062
20001
|
publishedSlug: string | null;
|
|
19063
20002
|
};
|
|
19064
|
-
/** @description true when visitors already see this
|
|
20003
|
+
/** @description true when visitors already see this write; false when it was saved to the draft copy only (translation.status can still be PUBLISHED for the older live copy): call localization.translations.publish, or publish the record, to put it live. */
|
|
19065
20004
|
live: boolean;
|
|
19066
20005
|
};
|
|
19067
20006
|
};
|
|
@@ -19084,7 +20023,7 @@ export interface operations {
|
|
|
19084
20023
|
path: {
|
|
19085
20024
|
/** @description Website id. Get it from sites.list or from sites.create. */
|
|
19086
20025
|
id: string;
|
|
19087
|
-
/** @description Translatable record type. page (pages.list ids), global_sections, site_settings and store_settings (the site itself: entityId defaults to websiteId), post / post_category / post_tag / author (blog), product / product_option / pricing_tier / product_category, deliverable / deliverable_unit, form, top_bar_banner / modal_announcement / floating_widget, collection_item (custom collection items), message_template (an automated email whose content the owner changed; the id of the customized template — untouched emails use the built-in version for every language), media_transcript (a video or audio transcript: media.transcripts.list ids; its translation becomes a subtitle track in that locale, paths are segments[i].t). */
|
|
20026
|
+
/** @description Translatable record type. page (pages.list ids), global_sections, site_settings and store_settings (the site itself: entityId defaults to websiteId), post / post_category / post_tag / author (blog), product / product_option / pricing_tier / product_category, deliverable / deliverable_unit, form, top_bar_banner / modal_announcement / floating_widget, collection_item (custom collection items), message_template (an automated email whose content the owner changed; the id of the customized template — untouched emails use the built-in version for every language), media_transcript (a video or audio transcript: media.transcripts.list ids; its translation becomes a subtitle track in that locale, paths are segments[i].t), media_asset (an image's default alt text in the media library: the asset id from media.list, path altText; live on write). */
|
|
19088
20027
|
entityType: string;
|
|
19089
20028
|
/** @description Record id. Required except for global_sections and site_settings, whose id is the websiteId. */
|
|
19090
20029
|
entityId: string;
|
|
@@ -19128,7 +20067,7 @@ export interface operations {
|
|
|
19128
20067
|
path: {
|
|
19129
20068
|
/** @description Website id. Get it from sites.list or from sites.create. */
|
|
19130
20069
|
id: string;
|
|
19131
|
-
/** @description Translatable record type. page (pages.list ids), global_sections, site_settings and store_settings (the site itself: entityId defaults to websiteId), post / post_category / post_tag / author (blog), product / product_option / pricing_tier / product_category, deliverable / deliverable_unit, form, top_bar_banner / modal_announcement / floating_widget, collection_item (custom collection items), message_template (an automated email whose content the owner changed; the id of the customized template — untouched emails use the built-in version for every language), media_transcript (a video or audio transcript: media.transcripts.list ids; its translation becomes a subtitle track in that locale, paths are segments[i].t). */
|
|
20070
|
+
/** @description Translatable record type. page (pages.list ids), global_sections, site_settings and store_settings (the site itself: entityId defaults to websiteId), post / post_category / post_tag / author (blog), product / product_option / pricing_tier / product_category, deliverable / deliverable_unit, form, top_bar_banner / modal_announcement / floating_widget, collection_item (custom collection items), message_template (an automated email whose content the owner changed; the id of the customized template — untouched emails use the built-in version for every language), media_transcript (a video or audio transcript: media.transcripts.list ids; its translation becomes a subtitle track in that locale, paths are segments[i].t), media_asset (an image's default alt text in the media library: the asset id from media.list, path altText; live on write). */
|
|
19132
20071
|
entityType: string;
|
|
19133
20072
|
/** @description Record id. Required except for global_sections and site_settings, whose id is the websiteId. */
|
|
19134
20073
|
entityId: string;
|
|
@@ -19152,6 +20091,7 @@ export interface operations {
|
|
|
19152
20091
|
* "entityId": "pg_example789",
|
|
19153
20092
|
* "locale": "fr-FR",
|
|
19154
20093
|
* "status": "PUBLISHED",
|
|
20094
|
+
* "publishState": "published",
|
|
19155
20095
|
* "translatedBy": "AGENT",
|
|
19156
20096
|
* "fieldCount": 2,
|
|
19157
20097
|
* "sourceHash": "c1a0e6f2b47d93e8",
|
|
@@ -19186,10 +20126,15 @@ export interface operations {
|
|
|
19186
20126
|
entityId: string;
|
|
19187
20127
|
locale: string;
|
|
19188
20128
|
/**
|
|
19189
|
-
* @description PUBLISHED =
|
|
20129
|
+
* @description PUBLISHED = a published copy exists and is live; it can still be older than the draft copy (see publishState).
|
|
19190
20130
|
* @enum {string}
|
|
19191
20131
|
*/
|
|
19192
20132
|
status: "DRAFT" | "PUBLISHED";
|
|
20133
|
+
/**
|
|
20134
|
+
* @description draft = never put live; published = the live copy matches the draft copy; changed = live, but the draft copy has edits (text or slug) that visitors do not see yet. Put them live with localization.translations.publish, or by publishing the record.
|
|
20135
|
+
* @enum {string}
|
|
20136
|
+
*/
|
|
20137
|
+
publishState: "draft" | "published" | "changed";
|
|
19193
20138
|
/**
|
|
19194
20139
|
* @description Most significant author across fields: HUMAN > SEO_FIX > AGENT > EXTERNAL > MACHINE.
|
|
19195
20140
|
* @enum {string}
|
|
@@ -19229,6 +20174,7 @@ export interface operations {
|
|
|
19229
20174
|
401: components["responses"]["Error401"];
|
|
19230
20175
|
403: components["responses"]["Error403"];
|
|
19231
20176
|
404: components["responses"]["Error404"];
|
|
20177
|
+
409: components["responses"]["Error409"];
|
|
19232
20178
|
429: components["responses"]["Error429"];
|
|
19233
20179
|
500: components["responses"]["Error500"];
|
|
19234
20180
|
503: components["responses"]["Error503"];
|
|
@@ -19241,7 +20187,7 @@ export interface operations {
|
|
|
19241
20187
|
path: {
|
|
19242
20188
|
/** @description Website id. Get it from sites.list or from sites.create. */
|
|
19243
20189
|
id: string;
|
|
19244
|
-
/** @description Translatable record type. page (pages.list ids), global_sections, site_settings and store_settings (the site itself: entityId defaults to websiteId), post / post_category / post_tag / author (blog), product / product_option / pricing_tier / product_category, deliverable / deliverable_unit, form, top_bar_banner / modal_announcement / floating_widget, collection_item (custom collection items), message_template (an automated email whose content the owner changed; the id of the customized template — untouched emails use the built-in version for every language), media_transcript (a video or audio transcript: media.transcripts.list ids; its translation becomes a subtitle track in that locale, paths are segments[i].t). */
|
|
20190
|
+
/** @description Translatable record type. page (pages.list ids), global_sections, site_settings and store_settings (the site itself: entityId defaults to websiteId), post / post_category / post_tag / author (blog), product / product_option / pricing_tier / product_category, deliverable / deliverable_unit, form, top_bar_banner / modal_announcement / floating_widget, collection_item (custom collection items), message_template (an automated email whose content the owner changed; the id of the customized template — untouched emails use the built-in version for every language), media_transcript (a video or audio transcript: media.transcripts.list ids; its translation becomes a subtitle track in that locale, paths are segments[i].t), media_asset (an image's default alt text in the media library: the asset id from media.list, path altText; live on write). */
|
|
19245
20191
|
entityType: string;
|
|
19246
20192
|
/** @description Record id. Required except for global_sections and site_settings, whose id is the websiteId. */
|
|
19247
20193
|
entityId: string;
|
|
@@ -19279,6 +20225,7 @@ export interface operations {
|
|
|
19279
20225
|
* "entityId": "prod_example01",
|
|
19280
20226
|
* "locale": "fr-FR",
|
|
19281
20227
|
* "status": "PUBLISHED",
|
|
20228
|
+
* "publishState": "published",
|
|
19282
20229
|
* "translatedBy": "AGENT",
|
|
19283
20230
|
* "fieldCount": 2,
|
|
19284
20231
|
* "sourceHash": "c1a0e6f2b47d93e8",
|
|
@@ -19319,10 +20266,15 @@ export interface operations {
|
|
|
19319
20266
|
entityId: string;
|
|
19320
20267
|
locale: string;
|
|
19321
20268
|
/**
|
|
19322
|
-
* @description PUBLISHED =
|
|
20269
|
+
* @description PUBLISHED = a published copy exists and is live; it can still be older than the draft copy (see publishState).
|
|
19323
20270
|
* @enum {string}
|
|
19324
20271
|
*/
|
|
19325
20272
|
status: "DRAFT" | "PUBLISHED";
|
|
20273
|
+
/**
|
|
20274
|
+
* @description draft = never put live; published = the live copy matches the draft copy; changed = live, but the draft copy has edits (text or slug) that visitors do not see yet. Put them live with localization.translations.publish, or by publishing the record.
|
|
20275
|
+
* @enum {string}
|
|
20276
|
+
*/
|
|
20277
|
+
publishState: "draft" | "published" | "changed";
|
|
19326
20278
|
/**
|
|
19327
20279
|
* @description Most significant author across fields: HUMAN > SEO_FIX > AGENT > EXTERNAL > MACHINE.
|
|
19328
20280
|
* @enum {string}
|
|
@@ -19406,6 +20358,7 @@ export interface operations {
|
|
|
19406
20358
|
* },
|
|
19407
20359
|
* "errorCode": null,
|
|
19408
20360
|
* "resumeAt": null,
|
|
20361
|
+
* "refreshMachineTranslations": false,
|
|
19409
20362
|
* "createdAt": "2026-10-06T08:00:00.000Z",
|
|
19410
20363
|
* "completedAt": null
|
|
19411
20364
|
* },
|
|
@@ -19426,6 +20379,7 @@ export interface operations {
|
|
|
19426
20379
|
* },
|
|
19427
20380
|
* "errorCode": null,
|
|
19428
20381
|
* "resumeAt": null,
|
|
20382
|
+
* "refreshMachineTranslations": false,
|
|
19429
20383
|
* "createdAt": "2026-10-06T08:00:00.000Z",
|
|
19430
20384
|
* "completedAt": "2026-10-01T02:30:00.000Z"
|
|
19431
20385
|
* }
|
|
@@ -19467,6 +20421,8 @@ export interface operations {
|
|
|
19467
20421
|
/** @description CANCELLED when cancelled; otherwise the failure reason. */
|
|
19468
20422
|
errorCode: string | null;
|
|
19469
20423
|
resumeAt: string | null;
|
|
20424
|
+
/** @description true when this job also translates again the fields whose current translation came from machine translation, even if their source did not change (localization.jobs.retry with refreshMachineTranslations, or a retry that continues such a job). */
|
|
20425
|
+
refreshMachineTranslations: boolean;
|
|
19470
20426
|
createdAt: string;
|
|
19471
20427
|
completedAt: string | null;
|
|
19472
20428
|
}[];
|
|
@@ -19499,12 +20455,15 @@ export interface operations {
|
|
|
19499
20455
|
content: {
|
|
19500
20456
|
/**
|
|
19501
20457
|
* @example {
|
|
19502
|
-
* "locale": "de"
|
|
20458
|
+
* "locale": "de",
|
|
20459
|
+
* "refreshMachineTranslations": true
|
|
19503
20460
|
* }
|
|
19504
20461
|
*/
|
|
19505
20462
|
"application/json": {
|
|
19506
20463
|
/** @description BCP 47 locale code exactly as listed by localization.locales.list (e.g. en-US, ja, zh-Hant). */
|
|
19507
20464
|
locale: string;
|
|
20465
|
+
/** @description Also translate again the fields whose current translation came from machine translation, even if their source did not change (after editing the glossary). Default false. */
|
|
20466
|
+
refreshMachineTranslations?: boolean;
|
|
19508
20467
|
};
|
|
19509
20468
|
};
|
|
19510
20469
|
};
|
|
@@ -19518,12 +20477,15 @@ export interface operations {
|
|
|
19518
20477
|
/**
|
|
19519
20478
|
* @example {
|
|
19520
20479
|
* "jobId": "ltj_example01",
|
|
19521
|
-
* "alreadyRunning": false
|
|
20480
|
+
* "alreadyRunning": false,
|
|
20481
|
+
* "refreshMachineTranslations": true
|
|
19522
20482
|
* }
|
|
19523
20483
|
*/
|
|
19524
20484
|
"application/json": {
|
|
19525
20485
|
jobId: string;
|
|
19526
20486
|
alreadyRunning: boolean;
|
|
20487
|
+
/** @description true when this job also translates again the fields whose current translation came from machine translation, even if their source did not change (localization.jobs.retry with refreshMachineTranslations, or a retry that continues such a job). */
|
|
20488
|
+
refreshMachineTranslations: boolean;
|
|
19527
20489
|
};
|
|
19528
20490
|
};
|
|
19529
20491
|
};
|
|
@@ -19575,6 +20537,7 @@ export interface operations {
|
|
|
19575
20537
|
* },
|
|
19576
20538
|
* "errorCode": null,
|
|
19577
20539
|
* "resumeAt": null,
|
|
20540
|
+
* "refreshMachineTranslations": false,
|
|
19578
20541
|
* "createdAt": "2026-10-06T08:00:00.000Z",
|
|
19579
20542
|
* "completedAt": null
|
|
19580
20543
|
* }
|
|
@@ -19613,6 +20576,8 @@ export interface operations {
|
|
|
19613
20576
|
/** @description CANCELLED when cancelled; otherwise the failure reason. */
|
|
19614
20577
|
errorCode: string | null;
|
|
19615
20578
|
resumeAt: string | null;
|
|
20579
|
+
/** @description true when this job also translates again the fields whose current translation came from machine translation, even if their source did not change (localization.jobs.retry with refreshMachineTranslations, or a retry that continues such a job). */
|
|
20580
|
+
refreshMachineTranslations: boolean;
|
|
19616
20581
|
createdAt: string;
|
|
19617
20582
|
completedAt: string | null;
|
|
19618
20583
|
};
|
|
@@ -19666,6 +20631,7 @@ export interface operations {
|
|
|
19666
20631
|
* },
|
|
19667
20632
|
* "errorCode": "CANCELLED",
|
|
19668
20633
|
* "resumeAt": null,
|
|
20634
|
+
* "refreshMachineTranslations": false,
|
|
19669
20635
|
* "createdAt": "2026-10-06T08:00:00.000Z",
|
|
19670
20636
|
* "completedAt": "2026-10-06T08:00:00.000Z"
|
|
19671
20637
|
* }
|
|
@@ -19704,6 +20670,8 @@ export interface operations {
|
|
|
19704
20670
|
/** @description CANCELLED when cancelled; otherwise the failure reason. */
|
|
19705
20671
|
errorCode: string | null;
|
|
19706
20672
|
resumeAt: string | null;
|
|
20673
|
+
/** @description true when this job also translates again the fields whose current translation came from machine translation, even if their source did not change (localization.jobs.retry with refreshMachineTranslations, or a retry that continues such a job). */
|
|
20674
|
+
refreshMachineTranslations: boolean;
|
|
19707
20675
|
createdAt: string;
|
|
19708
20676
|
completedAt: string | null;
|
|
19709
20677
|
};
|
|
@@ -19720,6 +20688,213 @@ export interface operations {
|
|
|
19720
20688
|
503: components["responses"]["Error503"];
|
|
19721
20689
|
};
|
|
19722
20690
|
};
|
|
20691
|
+
localization_glossary_list: {
|
|
20692
|
+
parameters: {
|
|
20693
|
+
query?: never;
|
|
20694
|
+
header?: never;
|
|
20695
|
+
path: {
|
|
20696
|
+
/** @description Website id. Get it from sites.list or from sites.create. */
|
|
20697
|
+
id: string;
|
|
20698
|
+
};
|
|
20699
|
+
cookie?: never;
|
|
20700
|
+
};
|
|
20701
|
+
requestBody?: never;
|
|
20702
|
+
responses: {
|
|
20703
|
+
/** @description OK */
|
|
20704
|
+
200: {
|
|
20705
|
+
headers: {
|
|
20706
|
+
[name: string]: unknown;
|
|
20707
|
+
};
|
|
20708
|
+
content: {
|
|
20709
|
+
/**
|
|
20710
|
+
* @example {
|
|
20711
|
+
* "data": [
|
|
20712
|
+
* {
|
|
20713
|
+
* "id": "lgt_example01",
|
|
20714
|
+
* "term": "Aurora Travel",
|
|
20715
|
+
* "doNotTranslate": true,
|
|
20716
|
+
* "translations": {},
|
|
20717
|
+
* "updatedAt": "2026-10-01T02:30:00.000Z"
|
|
20718
|
+
* },
|
|
20719
|
+
* {
|
|
20720
|
+
* "id": "lgt_example02",
|
|
20721
|
+
* "term": "Night Market Tour",
|
|
20722
|
+
* "doNotTranslate": false,
|
|
20723
|
+
* "translations": {
|
|
20724
|
+
* "fr-FR": "Visite du marché de nuit",
|
|
20725
|
+
* "de": "Nachtmarkt-Tour"
|
|
20726
|
+
* },
|
|
20727
|
+
* "updatedAt": "2026-10-06T08:00:00.000Z"
|
|
20728
|
+
* }
|
|
20729
|
+
* ],
|
|
20730
|
+
* "hasMore": false,
|
|
20731
|
+
* "nextCursor": null,
|
|
20732
|
+
* "max": 200
|
|
20733
|
+
* }
|
|
20734
|
+
*/
|
|
20735
|
+
"application/json": {
|
|
20736
|
+
data: {
|
|
20737
|
+
id: string;
|
|
20738
|
+
/** @description The term as written in the primary language. */
|
|
20739
|
+
term: string;
|
|
20740
|
+
/** @description true: machine translation keeps it as written in every language. */
|
|
20741
|
+
doNotTranslate: boolean;
|
|
20742
|
+
/** @description Locale code → the wording machine translation uses for this term. Empty when doNotTranslate is true. */
|
|
20743
|
+
translations: {
|
|
20744
|
+
[key: string]: string;
|
|
20745
|
+
};
|
|
20746
|
+
/** @description ISO 8601. */
|
|
20747
|
+
updatedAt: string;
|
|
20748
|
+
}[];
|
|
20749
|
+
/** @description True when another page exists; pass nextCursor to fetch it. */
|
|
20750
|
+
hasMore: boolean;
|
|
20751
|
+
/** @description Cursor for the next page, or null on the last page. */
|
|
20752
|
+
nextCursor: string | null;
|
|
20753
|
+
/** @description Most terms a glossary can hold. */
|
|
20754
|
+
max: number;
|
|
20755
|
+
};
|
|
20756
|
+
};
|
|
20757
|
+
};
|
|
20758
|
+
400: components["responses"]["Error400"];
|
|
20759
|
+
401: components["responses"]["Error401"];
|
|
20760
|
+
403: components["responses"]["Error403"];
|
|
20761
|
+
404: components["responses"]["Error404"];
|
|
20762
|
+
429: components["responses"]["Error429"];
|
|
20763
|
+
500: components["responses"]["Error500"];
|
|
20764
|
+
503: components["responses"]["Error503"];
|
|
20765
|
+
};
|
|
20766
|
+
};
|
|
20767
|
+
localization_glossary_upsert: {
|
|
20768
|
+
parameters: {
|
|
20769
|
+
query?: never;
|
|
20770
|
+
header?: never;
|
|
20771
|
+
path: {
|
|
20772
|
+
/** @description Website id. Get it from sites.list or from sites.create. */
|
|
20773
|
+
id: string;
|
|
20774
|
+
};
|
|
20775
|
+
cookie?: never;
|
|
20776
|
+
};
|
|
20777
|
+
requestBody: {
|
|
20778
|
+
content: {
|
|
20779
|
+
/**
|
|
20780
|
+
* @example {
|
|
20781
|
+
* "term": "Night Market Tour",
|
|
20782
|
+
* "translations": {
|
|
20783
|
+
* "fr-FR": "Visite du marché de nuit",
|
|
20784
|
+
* "de": "Nachtmarkt-Tour"
|
|
20785
|
+
* }
|
|
20786
|
+
* }
|
|
20787
|
+
*/
|
|
20788
|
+
"application/json": {
|
|
20789
|
+
/** @description The term as it is written in the primary language. A term that differs only in case, width or spacing replaces the existing one. */
|
|
20790
|
+
term: string;
|
|
20791
|
+
/**
|
|
20792
|
+
* @description true: keep the term as written in every language (brand and product names). translations must then be empty.
|
|
20793
|
+
* @default false
|
|
20794
|
+
*/
|
|
20795
|
+
doNotTranslate?: boolean;
|
|
20796
|
+
/**
|
|
20797
|
+
* @description Locale code (one of the site's secondary locales) → the wording machine translation must use. Replaces the term's previous translations; empty strings are ignored.
|
|
20798
|
+
* @default {}
|
|
20799
|
+
*/
|
|
20800
|
+
translations?: {
|
|
20801
|
+
[key: string]: string;
|
|
20802
|
+
};
|
|
20803
|
+
};
|
|
20804
|
+
};
|
|
20805
|
+
};
|
|
20806
|
+
responses: {
|
|
20807
|
+
/** @description OK */
|
|
20808
|
+
200: {
|
|
20809
|
+
headers: {
|
|
20810
|
+
[name: string]: unknown;
|
|
20811
|
+
};
|
|
20812
|
+
content: {
|
|
20813
|
+
/**
|
|
20814
|
+
* @example {
|
|
20815
|
+
* "term": {
|
|
20816
|
+
* "id": "lgt_example02",
|
|
20817
|
+
* "term": "Night Market Tour",
|
|
20818
|
+
* "doNotTranslate": false,
|
|
20819
|
+
* "translations": {
|
|
20820
|
+
* "fr-FR": "Visite du marché de nuit",
|
|
20821
|
+
* "de": "Nachtmarkt-Tour"
|
|
20822
|
+
* },
|
|
20823
|
+
* "updatedAt": "2026-10-06T08:00:00.000Z"
|
|
20824
|
+
* },
|
|
20825
|
+
* "created": true
|
|
20826
|
+
* }
|
|
20827
|
+
*/
|
|
20828
|
+
"application/json": {
|
|
20829
|
+
term: {
|
|
20830
|
+
id: string;
|
|
20831
|
+
/** @description The term as written in the primary language. */
|
|
20832
|
+
term: string;
|
|
20833
|
+
/** @description true: machine translation keeps it as written in every language. */
|
|
20834
|
+
doNotTranslate: boolean;
|
|
20835
|
+
/** @description Locale code → the wording machine translation uses for this term. Empty when doNotTranslate is true. */
|
|
20836
|
+
translations: {
|
|
20837
|
+
[key: string]: string;
|
|
20838
|
+
};
|
|
20839
|
+
/** @description ISO 8601. */
|
|
20840
|
+
updatedAt: string;
|
|
20841
|
+
};
|
|
20842
|
+
/** @description false when an existing term with the same wording was replaced. */
|
|
20843
|
+
created: boolean;
|
|
20844
|
+
};
|
|
20845
|
+
};
|
|
20846
|
+
};
|
|
20847
|
+
400: components["responses"]["Error400"];
|
|
20848
|
+
401: components["responses"]["Error401"];
|
|
20849
|
+
403: components["responses"]["Error403"];
|
|
20850
|
+
429: components["responses"]["Error429"];
|
|
20851
|
+
500: components["responses"]["Error500"];
|
|
20852
|
+
503: components["responses"]["Error503"];
|
|
20853
|
+
};
|
|
20854
|
+
};
|
|
20855
|
+
localization_glossary_delete: {
|
|
20856
|
+
parameters: {
|
|
20857
|
+
query?: never;
|
|
20858
|
+
header?: never;
|
|
20859
|
+
path: {
|
|
20860
|
+
/** @description Website id. Get it from sites.list or from sites.create. */
|
|
20861
|
+
id: string;
|
|
20862
|
+
/** @description Glossary term id from localization.glossary.list. */
|
|
20863
|
+
termId: string;
|
|
20864
|
+
};
|
|
20865
|
+
cookie?: never;
|
|
20866
|
+
};
|
|
20867
|
+
requestBody?: never;
|
|
20868
|
+
responses: {
|
|
20869
|
+
/** @description OK */
|
|
20870
|
+
200: {
|
|
20871
|
+
headers: {
|
|
20872
|
+
[name: string]: unknown;
|
|
20873
|
+
};
|
|
20874
|
+
content: {
|
|
20875
|
+
/**
|
|
20876
|
+
* @example {
|
|
20877
|
+
* "deleted": true,
|
|
20878
|
+
* "term": "Night Market Tour"
|
|
20879
|
+
* }
|
|
20880
|
+
*/
|
|
20881
|
+
"application/json": {
|
|
20882
|
+
/** @constant */
|
|
20883
|
+
deleted: true;
|
|
20884
|
+
/** @description The wording of the deleted term. */
|
|
20885
|
+
term: string;
|
|
20886
|
+
};
|
|
20887
|
+
};
|
|
20888
|
+
};
|
|
20889
|
+
400: components["responses"]["Error400"];
|
|
20890
|
+
401: components["responses"]["Error401"];
|
|
20891
|
+
403: components["responses"]["Error403"];
|
|
20892
|
+
404: components["responses"]["Error404"];
|
|
20893
|
+
429: components["responses"]["Error429"];
|
|
20894
|
+
500: components["responses"]["Error500"];
|
|
20895
|
+
503: components["responses"]["Error503"];
|
|
20896
|
+
};
|
|
20897
|
+
};
|
|
19723
20898
|
forms_list: {
|
|
19724
20899
|
parameters: {
|
|
19725
20900
|
query?: {
|
|
@@ -19880,7 +21055,7 @@ export interface operations {
|
|
|
19880
21055
|
fields: {
|
|
19881
21056
|
[key: string]: unknown;
|
|
19882
21057
|
}[];
|
|
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 (
|
|
21058
|
+
/** @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, written the way the form stores the answer (a phone number in international format, a choice as its option label, and nothing for a question its display conditions hide), 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 (the form's automation type, "Automation type" in the dashboard: it picks the confirmation email the person who filled in the form gets, and the automation form_<replyKind> that runs on each submission; whether that email is sent is switched on the automation, not here. inquiry = Inquiry, for contact, quotes, partnerships and support, the email says the message was received and a reply will follow; booking = Booking request, the email says the request was received and the time will be confirmed, never that the booking is confirmed; event = Event signup, the email says the person is registered, so add the time and place to it; application = Application, for jobs, memberships and resellers, the email says the application was received and the result will follow; signup = Sign-up, for waiting lists, back-in-stock alerts, downloads and trials, the email says the person is signed up; feedback = Feedback, the email thanks them, and a form without an email question sends nothing; general = Other, the email says the form was received. A new form without replyKind (or with null) gets inquiry, the same as a blank form created in the dashboard; on forms.update, null sets it back to 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. */
|
|
19884
21059
|
settings?: {
|
|
19885
21060
|
[key: string]: unknown;
|
|
19886
21061
|
};
|
|
@@ -20250,7 +21425,7 @@ export interface operations {
|
|
|
20250
21425
|
fields?: {
|
|
20251
21426
|
[key: string]: unknown;
|
|
20252
21427
|
}[];
|
|
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 (
|
|
21428
|
+
/** @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, written the way the form stores the answer (a phone number in international format, a choice as its option label, and nothing for a question its display conditions hide), 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 (the form's automation type, "Automation type" in the dashboard: it picks the confirmation email the person who filled in the form gets, and the automation form_<replyKind> that runs on each submission; whether that email is sent is switched on the automation, not here. inquiry = Inquiry, for contact, quotes, partnerships and support, the email says the message was received and a reply will follow; booking = Booking request, the email says the request was received and the time will be confirmed, never that the booking is confirmed; event = Event signup, the email says the person is registered, so add the time and place to it; application = Application, for jobs, memberships and resellers, the email says the application was received and the result will follow; signup = Sign-up, for waiting lists, back-in-stock alerts, downloads and trials, the email says the person is signed up; feedback = Feedback, the email thanks them, and a form without an email question sends nothing; general = Other, the email says the form was received. A new form without replyKind (or with null) gets inquiry, the same as a blank form created in the dashboard; on forms.update, null sets it back to 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. */
|
|
20254
21429
|
settings?: {
|
|
20255
21430
|
[key: string]: unknown;
|
|
20256
21431
|
};
|
|
@@ -28388,6 +29563,10 @@ export interface operations {
|
|
|
28388
29563
|
edgeColor: string | null;
|
|
28389
29564
|
/** @description Default alt text, used when the place that shows the image has no alt of its own. */
|
|
28390
29565
|
altText: string | null;
|
|
29566
|
+
/** @description Credit line for the file (photographer or rights holder, for example "Jane Doe / Pexels"); filled automatically by media.import_stock. Public: the Content Delivery API returns it in assets[]. */
|
|
29567
|
+
credit: string | null;
|
|
29568
|
+
/** @description Where the file came from (the stock photo's page, the original source); filled automatically by media.import_stock. Public like credit. */
|
|
29569
|
+
sourceUrl: string | null;
|
|
28391
29570
|
/** @description true when the owner excluded this image from the site watermark. */
|
|
28392
29571
|
watermarkExempt: boolean;
|
|
28393
29572
|
createdAt: string;
|
|
@@ -28556,6 +29735,10 @@ export interface operations {
|
|
|
28556
29735
|
edgeColor: string | null;
|
|
28557
29736
|
/** @description Default alt text, used when the place that shows the image has no alt of its own. */
|
|
28558
29737
|
altText: string | null;
|
|
29738
|
+
/** @description Credit line for the file (photographer or rights holder, for example "Jane Doe / Pexels"); filled automatically by media.import_stock. Public: the Content Delivery API returns it in assets[]. */
|
|
29739
|
+
credit: string | null;
|
|
29740
|
+
/** @description Where the file came from (the stock photo's page, the original source); filled automatically by media.import_stock. Public like credit. */
|
|
29741
|
+
sourceUrl: string | null;
|
|
28559
29742
|
/** @description true when the owner excluded this image from the site watermark. */
|
|
28560
29743
|
watermarkExempt: boolean;
|
|
28561
29744
|
createdAt: string;
|
|
@@ -33431,7 +34614,7 @@ export interface operations {
|
|
|
33431
34614
|
unusedOnly?: boolean | ("true" | "false");
|
|
33432
34615
|
/** @description Include broken asset records where the original file no longer exists on storage (defaults to false). */
|
|
33433
34616
|
includeMissing?: boolean | ("true" | "false");
|
|
33434
|
-
/** @description Part of the file name. */
|
|
34617
|
+
/** @description Part of the file name, default alt text or credit (case-insensitive). */
|
|
33435
34618
|
search?: string;
|
|
33436
34619
|
/** @description newest (default), oldest or largest. */
|
|
33437
34620
|
sort?: "newest" | "oldest" | "largest";
|
|
@@ -33483,6 +34666,8 @@ export interface operations {
|
|
|
33483
34666
|
* "focus": null,
|
|
33484
34667
|
* "edgeColor": null,
|
|
33485
34668
|
* "altText": null,
|
|
34669
|
+
* "credit": null,
|
|
34670
|
+
* "sourceUrl": null,
|
|
33486
34671
|
* "watermarkExempt": false,
|
|
33487
34672
|
* "createdAt": "2026-10-01T02:30:00.000Z"
|
|
33488
34673
|
* }
|
|
@@ -33566,6 +34751,10 @@ export interface operations {
|
|
|
33566
34751
|
edgeColor: string | null;
|
|
33567
34752
|
/** @description Default alt text, used when the place that shows the image has no alt of its own. */
|
|
33568
34753
|
altText: string | null;
|
|
34754
|
+
/** @description Credit line for the file (photographer or rights holder, for example "Jane Doe / Pexels"); filled automatically by media.import_stock. Public: the Content Delivery API returns it in assets[]. */
|
|
34755
|
+
credit: string | null;
|
|
34756
|
+
/** @description Where the file came from (the stock photo's page, the original source); filled automatically by media.import_stock. Public like credit. */
|
|
34757
|
+
sourceUrl: string | null;
|
|
33569
34758
|
/** @description true when the owner excluded this image from the site watermark. */
|
|
33570
34759
|
watermarkExempt: boolean;
|
|
33571
34760
|
createdAt: string;
|
|
@@ -33602,7 +34791,10 @@ export interface operations {
|
|
|
33602
34791
|
media_upload: {
|
|
33603
34792
|
parameters: {
|
|
33604
34793
|
query?: never;
|
|
33605
|
-
header?:
|
|
34794
|
+
header?: {
|
|
34795
|
+
/** @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. */
|
|
34796
|
+
"Idempotency-Key"?: string;
|
|
34797
|
+
};
|
|
33606
34798
|
path: {
|
|
33607
34799
|
/** @description Website id. Get it from sites.list or from sites.create. */
|
|
33608
34800
|
id: string;
|
|
@@ -33624,7 +34816,7 @@ export interface operations {
|
|
|
33624
34816
|
* @description Public https URL to copy from: images up to 40 MB, other files up to 100 MB (use media.request_upload for larger files). Private networks and redirects to them are rejected.
|
|
33625
34817
|
*/
|
|
33626
34818
|
url?: string;
|
|
33627
|
-
/** @description File name with extension, e.g. lesson-01.mp4 or workbook.pdf. Required for videos, audio, PDFs, documents, e-books and ZIP files (the extension decides the format; the file header must match).
|
|
34819
|
+
/** @description File name with extension, e.g. lesson-01.mp4 or workbook.pdf; no slashes or control characters (same rules as media.update). Required for videos, audio, PDFs, documents, e-books and ZIP files (the extension decides the format; the file header must match). Optional for images: it becomes the image's name in the media library, which is what media.list search and the activity log show, and its extension is set to the image's real format (a JPEG sent as photo.png is named photo.jpg); when omitted the name is taken from the url, or image.<ext> for base64. */
|
|
33628
34820
|
fileName?: string;
|
|
33629
34821
|
/**
|
|
33630
34822
|
* @description public (default): files for pages, posts and collections; anyone with the link can open them. protected: files for deliverables (paid courses, e-books, downloads) stored privately and only served to buyers through signed short-lived links. Protected images (JPG, PNG, WebP; pass fileName) are stored as private files too: no public variants, not offered in page or post pickers, not usable as deliverable covers.
|
|
@@ -33633,6 +34825,14 @@ export interface operations {
|
|
|
33633
34825
|
visibility?: "public" | "protected";
|
|
33634
34826
|
/** @description Hint for bookkeeping (images only): content (default), blog, product, favicon. */
|
|
33635
34827
|
usage?: string;
|
|
34828
|
+
/** @description Images only: default alt text in the site's content language, used where the image is shown without an alt of its own (same as media.update altText). */
|
|
34829
|
+
altText?: string;
|
|
34830
|
+
/** @description Tags for the media library, any file (same rules as media.update tags). */
|
|
34831
|
+
tags?: string[];
|
|
34832
|
+
/** @description Credit line, any file: photographer or rights holder, for example "Jane Doe / Example Studio". Public in the Content Delivery API (assets[].credit). */
|
|
34833
|
+
credit?: string;
|
|
34834
|
+
/** @description Where the file came from (http or https), any file. Public in the Content Delivery API (assets[].sourceUrl). */
|
|
34835
|
+
sourceUrl?: string;
|
|
33636
34836
|
};
|
|
33637
34837
|
};
|
|
33638
34838
|
};
|
|
@@ -33670,6 +34870,8 @@ export interface operations {
|
|
|
33670
34870
|
* "focus": null,
|
|
33671
34871
|
* "edgeColor": null,
|
|
33672
34872
|
* "altText": null,
|
|
34873
|
+
* "credit": null,
|
|
34874
|
+
* "sourceUrl": null,
|
|
33673
34875
|
* "watermarkExempt": false,
|
|
33674
34876
|
* "createdAt": "2026-10-06T08:00:00.000Z"
|
|
33675
34877
|
* }
|
|
@@ -33742,6 +34944,10 @@ export interface operations {
|
|
|
33742
34944
|
edgeColor: string | null;
|
|
33743
34945
|
/** @description Default alt text, used when the place that shows the image has no alt of its own. */
|
|
33744
34946
|
altText: string | null;
|
|
34947
|
+
/** @description Credit line for the file (photographer or rights holder, for example "Jane Doe / Pexels"); filled automatically by media.import_stock. Public: the Content Delivery API returns it in assets[]. */
|
|
34948
|
+
credit: string | null;
|
|
34949
|
+
/** @description Where the file came from (the stock photo's page, the original source); filled automatically by media.import_stock. Public like credit. */
|
|
34950
|
+
sourceUrl: string | null;
|
|
33745
34951
|
/** @description true when the owner excluded this image from the site watermark. */
|
|
33746
34952
|
watermarkExempt: boolean;
|
|
33747
34953
|
createdAt: string;
|
|
@@ -33778,7 +34984,7 @@ export interface operations {
|
|
|
33778
34984
|
* }
|
|
33779
34985
|
*/
|
|
33780
34986
|
"application/json": {
|
|
33781
|
-
/** @description File name with extension; the extension decides the format. */
|
|
34987
|
+
/** @description File name with extension; the extension decides the format. No slashes or control characters (same rules as media.update). */
|
|
33782
34988
|
fileName: string;
|
|
33783
34989
|
/** @description Exact size in bytes; the upload must match it. */
|
|
33784
34990
|
fileSize: number;
|
|
@@ -33899,6 +35105,8 @@ export interface operations {
|
|
|
33899
35105
|
* "focus": null,
|
|
33900
35106
|
* "edgeColor": null,
|
|
33901
35107
|
* "altText": null,
|
|
35108
|
+
* "credit": null,
|
|
35109
|
+
* "sourceUrl": null,
|
|
33902
35110
|
* "watermarkExempt": false,
|
|
33903
35111
|
* "createdAt": "2026-10-06T08:00:00.000Z"
|
|
33904
35112
|
* }
|
|
@@ -33971,6 +35179,10 @@ export interface operations {
|
|
|
33971
35179
|
edgeColor: string | null;
|
|
33972
35180
|
/** @description Default alt text, used when the place that shows the image has no alt of its own. */
|
|
33973
35181
|
altText: string | null;
|
|
35182
|
+
/** @description Credit line for the file (photographer or rights holder, for example "Jane Doe / Pexels"); filled automatically by media.import_stock. Public: the Content Delivery API returns it in assets[]. */
|
|
35183
|
+
credit: string | null;
|
|
35184
|
+
/** @description Where the file came from (the stock photo's page, the original source); filled automatically by media.import_stock. Public like credit. */
|
|
35185
|
+
sourceUrl: string | null;
|
|
33974
35186
|
/** @description true when the owner excluded this image from the site watermark. */
|
|
33975
35187
|
watermarkExempt: boolean;
|
|
33976
35188
|
createdAt: string;
|
|
@@ -34116,6 +35328,8 @@ export interface operations {
|
|
|
34116
35328
|
* "focus": null,
|
|
34117
35329
|
* "edgeColor": null,
|
|
34118
35330
|
* "altText": null,
|
|
35331
|
+
* "credit": null,
|
|
35332
|
+
* "sourceUrl": null,
|
|
34119
35333
|
* "watermarkExempt": false,
|
|
34120
35334
|
* "createdAt": "2026-10-06T08:00:00.000Z",
|
|
34121
35335
|
* "uploadedAt": "2026-10-06T08:00:00.000Z"
|
|
@@ -34145,6 +35359,8 @@ export interface operations {
|
|
|
34145
35359
|
* "focus": null,
|
|
34146
35360
|
* "edgeColor": null,
|
|
34147
35361
|
* "altText": null,
|
|
35362
|
+
* "credit": null,
|
|
35363
|
+
* "sourceUrl": null,
|
|
34148
35364
|
* "watermarkExempt": false,
|
|
34149
35365
|
* "createdAt": "2026-10-06T08:00:00.000Z",
|
|
34150
35366
|
* "uploadedAt": "2026-10-06T08:00:00.000Z"
|
|
@@ -34227,6 +35443,10 @@ export interface operations {
|
|
|
34227
35443
|
edgeColor: string | null;
|
|
34228
35444
|
/** @description Default alt text, used when the place that shows the image has no alt of its own. */
|
|
34229
35445
|
altText: string | null;
|
|
35446
|
+
/** @description Credit line for the file (photographer or rights holder, for example "Jane Doe / Pexels"); filled automatically by media.import_stock. Public: the Content Delivery API returns it in assets[]. */
|
|
35447
|
+
credit: string | null;
|
|
35448
|
+
/** @description Where the file came from (the stock photo's page, the original source); filled automatically by media.import_stock. Public like credit. */
|
|
35449
|
+
sourceUrl: string | null;
|
|
34230
35450
|
/** @description true when the owner excluded this image from the site watermark. */
|
|
34231
35451
|
watermarkExempt: boolean;
|
|
34232
35452
|
createdAt: string;
|
|
@@ -34353,7 +35573,7 @@ export interface operations {
|
|
|
34353
35573
|
"application/json": {
|
|
34354
35574
|
/** @enum {string} */
|
|
34355
35575
|
provider: "pexels" | "pixabay";
|
|
34356
|
-
/** @description Stock photo id from the search result. */
|
|
35576
|
+
/** @description Stock photo id from the search result (digits). */
|
|
34357
35577
|
id: string;
|
|
34358
35578
|
/**
|
|
34359
35579
|
* Format: uri
|
|
@@ -34399,6 +35619,8 @@ export interface operations {
|
|
|
34399
35619
|
* "focus": null,
|
|
34400
35620
|
* "edgeColor": null,
|
|
34401
35621
|
* "altText": null,
|
|
35622
|
+
* "credit": null,
|
|
35623
|
+
* "sourceUrl": null,
|
|
34402
35624
|
* "watermarkExempt": false,
|
|
34403
35625
|
* "createdAt": "2026-10-06T08:00:00.000Z"
|
|
34404
35626
|
* }
|
|
@@ -34471,6 +35693,10 @@ export interface operations {
|
|
|
34471
35693
|
edgeColor: string | null;
|
|
34472
35694
|
/** @description Default alt text, used when the place that shows the image has no alt of its own. */
|
|
34473
35695
|
altText: string | null;
|
|
35696
|
+
/** @description Credit line for the file (photographer or rights holder, for example "Jane Doe / Pexels"); filled automatically by media.import_stock. Public: the Content Delivery API returns it in assets[]. */
|
|
35697
|
+
credit: string | null;
|
|
35698
|
+
/** @description Where the file came from (the stock photo's page, the original source); filled automatically by media.import_stock. Public like credit. */
|
|
35699
|
+
sourceUrl: string | null;
|
|
34474
35700
|
/** @description true when the owner excluded this image from the site watermark. */
|
|
34475
35701
|
watermarkExempt: boolean;
|
|
34476
35702
|
createdAt: string;
|
|
@@ -34616,6 +35842,8 @@ export interface operations {
|
|
|
34616
35842
|
* "focus": null,
|
|
34617
35843
|
* "edgeColor": null,
|
|
34618
35844
|
* "altText": null,
|
|
35845
|
+
* "credit": null,
|
|
35846
|
+
* "sourceUrl": null,
|
|
34619
35847
|
* "watermarkExempt": false,
|
|
34620
35848
|
* "createdAt": "2026-10-01T02:30:00.000Z"
|
|
34621
35849
|
* },
|
|
@@ -34708,6 +35936,10 @@ export interface operations {
|
|
|
34708
35936
|
edgeColor: string | null;
|
|
34709
35937
|
/** @description Default alt text, used when the place that shows the image has no alt of its own. */
|
|
34710
35938
|
altText: string | null;
|
|
35939
|
+
/** @description Credit line for the file (photographer or rights holder, for example "Jane Doe / Pexels"); filled automatically by media.import_stock. Public: the Content Delivery API returns it in assets[]. */
|
|
35940
|
+
credit: string | null;
|
|
35941
|
+
/** @description Where the file came from (the stock photo's page, the original source); filled automatically by media.import_stock. Public like credit. */
|
|
35942
|
+
sourceUrl: string | null;
|
|
34711
35943
|
/** @description true when the owner excluded this image from the site watermark. */
|
|
34712
35944
|
watermarkExempt: boolean;
|
|
34713
35945
|
createdAt: string;
|
|
@@ -34830,6 +36062,12 @@ export interface operations {
|
|
|
34830
36062
|
altText?: string | null;
|
|
34831
36063
|
/** @description Replaces the file's tags (any file). Up to 20 tags of 1-40 characters; no commas, line breaks or leading #. */
|
|
34832
36064
|
tags?: string[];
|
|
36065
|
+
/** @description Renames the file (any file). End the name with the current extension or one of the format's extensions: a JPEG named hero.jpg can become storefront-hero.jpg or storefront-hero.jpeg, not storefront-hero.png. No slashes or control characters. */
|
|
36066
|
+
fileName?: string;
|
|
36067
|
+
/** @description Credit line (any file), for example "Jane Doe / Example Studio"; null or an empty string clears it. */
|
|
36068
|
+
credit?: string | null;
|
|
36069
|
+
/** @description Where the file came from (any file), http or https; null or an empty string clears it. */
|
|
36070
|
+
sourceUrl?: string | null;
|
|
34833
36071
|
/**
|
|
34834
36072
|
* @description Move a video, audio, PDF or document between public and protected. Images cannot be switched (public images live in the image CDN, protected images in private storage): upload the image again with the visibility you need (VISIBILITY_BLOCKED, reason unsupported_kind). The file is moved between storage buckets in the background: the asset shows processing until done and media.asset.ready fires. A video's streaming version is removed by the move and produced again once the file is placed somewhere that plays it; captions are kept. public → protected is refused while any content uses the file (VISIBILITY_BLOCKED, reason in_use, with locations); protected → public is refused while a deliverable unit uses it (reason deliverable). Old public URLs may stay cached at the CDN edge for a while after the move.
|
|
34835
36073
|
* @enum {string}
|
|
@@ -34882,6 +36120,8 @@ export interface operations {
|
|
|
34882
36120
|
* },
|
|
34883
36121
|
* "edgeColor": null,
|
|
34884
36122
|
* "altText": "Fresh croissants on the bakery counter",
|
|
36123
|
+
* "credit": null,
|
|
36124
|
+
* "sourceUrl": null,
|
|
34885
36125
|
* "watermarkExempt": false,
|
|
34886
36126
|
* "createdAt": "2026-10-01T02:30:00.000Z"
|
|
34887
36127
|
* }
|
|
@@ -34954,6 +36194,10 @@ export interface operations {
|
|
|
34954
36194
|
edgeColor: string | null;
|
|
34955
36195
|
/** @description Default alt text, used when the place that shows the image has no alt of its own. */
|
|
34956
36196
|
altText: string | null;
|
|
36197
|
+
/** @description Credit line for the file (photographer or rights holder, for example "Jane Doe / Pexels"); filled automatically by media.import_stock. Public: the Content Delivery API returns it in assets[]. */
|
|
36198
|
+
credit: string | null;
|
|
36199
|
+
/** @description Where the file came from (the stock photo's page, the original source); filled automatically by media.import_stock. Public like credit. */
|
|
36200
|
+
sourceUrl: string | null;
|
|
34957
36201
|
/** @description true when the owner excluded this image from the site watermark. */
|
|
34958
36202
|
watermarkExempt: boolean;
|
|
34959
36203
|
createdAt: string;
|
|
@@ -35037,6 +36281,8 @@ export interface operations {
|
|
|
35037
36281
|
* "focus": null,
|
|
35038
36282
|
* "edgeColor": null,
|
|
35039
36283
|
* "altText": null,
|
|
36284
|
+
* "credit": null,
|
|
36285
|
+
* "sourceUrl": null,
|
|
35040
36286
|
* "watermarkExempt": false,
|
|
35041
36287
|
* "createdAt": "2026-10-01T02:30:00.000Z"
|
|
35042
36288
|
* },
|
|
@@ -35118,6 +36364,10 @@ export interface operations {
|
|
|
35118
36364
|
edgeColor: string | null;
|
|
35119
36365
|
/** @description Default alt text, used when the place that shows the image has no alt of its own. */
|
|
35120
36366
|
altText: string | null;
|
|
36367
|
+
/** @description Credit line for the file (photographer or rights holder, for example "Jane Doe / Pexels"); filled automatically by media.import_stock. Public: the Content Delivery API returns it in assets[]. */
|
|
36368
|
+
credit: string | null;
|
|
36369
|
+
/** @description Where the file came from (the stock photo's page, the original source); filled automatically by media.import_stock. Public like credit. */
|
|
36370
|
+
sourceUrl: string | null;
|
|
35121
36371
|
/** @description true when the owner excluded this image from the site watermark. */
|
|
35122
36372
|
watermarkExempt: boolean;
|
|
35123
36373
|
createdAt: string;
|
|
@@ -36571,7 +37821,7 @@ export interface operations {
|
|
|
36571
37821
|
*/
|
|
36572
37822
|
status?: "draft" | "published" | "changed";
|
|
36573
37823
|
/**
|
|
36574
|
-
* @description Set when the system recorded this revision automatically: beforeDelete right before
|
|
37824
|
+
* @description Set when the system recorded this revision automatically: beforeDelete right before a collection item was moved to the trash or a page was deleted (a WEBSITE revision), scheduled when a scheduled publish froze the content to go live.
|
|
36575
37825
|
* @enum {string}
|
|
36576
37826
|
*/
|
|
36577
37827
|
backup?: "beforeDelete" | "scheduled";
|
|
@@ -36781,7 +38031,7 @@ export interface operations {
|
|
|
36781
38031
|
*/
|
|
36782
38032
|
status?: "draft" | "published" | "changed";
|
|
36783
38033
|
/**
|
|
36784
|
-
* @description Set when the system recorded this revision automatically: beforeDelete right before
|
|
38034
|
+
* @description Set when the system recorded this revision automatically: beforeDelete right before a collection item was moved to the trash or a page was deleted (a WEBSITE revision), scheduled when a scheduled publish froze the content to go live.
|
|
36785
38035
|
* @enum {string}
|
|
36786
38036
|
*/
|
|
36787
38037
|
backup?: "beforeDelete" | "scheduled";
|
|
@@ -36869,6 +38119,10 @@ export interface operations {
|
|
|
36869
38119
|
edgeColor: string | null;
|
|
36870
38120
|
/** @description Default alt text, used when the place that shows the image has no alt of its own. */
|
|
36871
38121
|
altText: string | null;
|
|
38122
|
+
/** @description Credit line for the file (photographer or rights holder, for example "Jane Doe / Pexels"); filled automatically by media.import_stock. Public: the Content Delivery API returns it in assets[]. */
|
|
38123
|
+
credit: string | null;
|
|
38124
|
+
/** @description Where the file came from (the stock photo's page, the original source); filled automatically by media.import_stock. Public like credit. */
|
|
38125
|
+
sourceUrl: string | null;
|
|
36872
38126
|
/** @description true when the owner excluded this image from the site watermark. */
|
|
36873
38127
|
watermarkExempt: boolean;
|
|
36874
38128
|
createdAt: string;
|
|
@@ -38445,6 +39699,12 @@ export interface operations {
|
|
|
38445
39699
|
* "remainingBytes": 10736936107,
|
|
38446
39700
|
* "scope": "website"
|
|
38447
39701
|
* },
|
|
39702
|
+
* "contentItems": {
|
|
39703
|
+
* "used": 213,
|
|
39704
|
+
* "limit": 1000,
|
|
39705
|
+
* "remaining": 787,
|
|
39706
|
+
* "perCollectionLimit": 20000
|
|
39707
|
+
* },
|
|
38448
39708
|
* "counts": {
|
|
38449
39709
|
* "generalPages": 5,
|
|
38450
39710
|
* "visiblePages": 4,
|
|
@@ -38473,6 +39733,17 @@ export interface operations {
|
|
|
38473
39733
|
*/
|
|
38474
39734
|
scope: "website" | "account";
|
|
38475
39735
|
};
|
|
39736
|
+
/** @description The plan's content item quota, the same number the dashboard's usage page shows and the one item writes are checked against. */
|
|
39737
|
+
contentItems: {
|
|
39738
|
+
/** @description Items counted against the plan's item quota: every item in the site's own collections, drafts and items in the trash included (a trashed item counts until it is permanently deleted with items.purge, or automatically 30 days after items.delete), plus blog posts, drafts included. Blog categories, tags and authors are not counted. */
|
|
39739
|
+
used: number;
|
|
39740
|
+
/** @description Items the site can hold now: the plan's included items plus add-on levels (the lower figure while a downgrade is scheduled). A write that would go past it fails with PLAN_ITEM_LIMIT_REACHED. */
|
|
39741
|
+
limit: number;
|
|
39742
|
+
/** @description limit minus used, never below 0. */
|
|
39743
|
+
remaining: number;
|
|
39744
|
+
/** @description Technical limit per collection, on any plan; a write past it fails with COLLECTION_ITEM_LIMIT_REACHED. */
|
|
39745
|
+
perCollectionLimit: number;
|
|
39746
|
+
};
|
|
38476
39747
|
counts: {
|
|
38477
39748
|
/** @description Total non-product pages. */
|
|
38478
39749
|
generalPages: number;
|