@kanorio/sdk 1.2.0 → 1.3.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 +120 -27
- package/dist/generated/management.d.ts +1220 -70
- 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;
|
|
@@ -1369,7 +1369,7 @@ export interface paths {
|
|
|
1369
1369
|
put?: never;
|
|
1370
1370
|
/**
|
|
1371
1371
|
* 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.
|
|
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. 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
1373
|
*/
|
|
1374
1374
|
post: operations["localization_locales_add"];
|
|
1375
1375
|
delete?: never;
|
|
@@ -1437,7 +1437,7 @@ export interface paths {
|
|
|
1437
1437
|
head?: never;
|
|
1438
1438
|
/**
|
|
1439
1439
|
* 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.
|
|
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); 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
1441
|
*/
|
|
1442
1442
|
patch: operations["localization_locales_update"];
|
|
1443
1443
|
trace?: never;
|
|
@@ -1462,6 +1462,26 @@ export interface paths {
|
|
|
1462
1462
|
patch?: never;
|
|
1463
1463
|
trace?: never;
|
|
1464
1464
|
};
|
|
1465
|
+
"/sites/{id}/translations/pending": {
|
|
1466
|
+
parameters: {
|
|
1467
|
+
query?: never;
|
|
1468
|
+
header?: never;
|
|
1469
|
+
path?: never;
|
|
1470
|
+
cookie?: never;
|
|
1471
|
+
};
|
|
1472
|
+
/**
|
|
1473
|
+
* localization.translations.pending
|
|
1474
|
+
* @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.
|
|
1475
|
+
*/
|
|
1476
|
+
get: operations["localization_translations_pending"];
|
|
1477
|
+
put?: never;
|
|
1478
|
+
post?: never;
|
|
1479
|
+
delete?: never;
|
|
1480
|
+
options?: never;
|
|
1481
|
+
head?: never;
|
|
1482
|
+
patch?: never;
|
|
1483
|
+
trace?: never;
|
|
1484
|
+
};
|
|
1465
1485
|
"/sites/{id}/translations/{entityType}/{entityId}/{locale}": {
|
|
1466
1486
|
parameters: {
|
|
1467
1487
|
query?: never;
|
|
@@ -1476,7 +1496,7 @@ export interface paths {
|
|
|
1476
1496
|
get: operations["localization_translations_get"];
|
|
1477
1497
|
/**
|
|
1478
1498
|
* 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.
|
|
1499
|
+
* @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); 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. 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
1500
|
*/
|
|
1481
1501
|
put: operations["localization_translations_upsert"];
|
|
1482
1502
|
post?: never;
|
|
@@ -1501,7 +1521,7 @@ export interface paths {
|
|
|
1501
1521
|
put?: never;
|
|
1502
1522
|
/**
|
|
1503
1523
|
* 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.
|
|
1524
|
+
* @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
1525
|
*/
|
|
1506
1526
|
post: operations["localization_translations_publish"];
|
|
1507
1527
|
delete?: never;
|
|
@@ -1521,7 +1541,7 @@ export interface paths {
|
|
|
1521
1541
|
put?: never;
|
|
1522
1542
|
/**
|
|
1523
1543
|
* 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
|
|
1544
|
+
* @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
1545
|
*/
|
|
1526
1546
|
post: operations["localization_translations_translate"];
|
|
1527
1547
|
delete?: never;
|
|
@@ -1545,7 +1565,7 @@ export interface paths {
|
|
|
1545
1565
|
put?: never;
|
|
1546
1566
|
/**
|
|
1547
1567
|
* 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.
|
|
1568
|
+
* @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
1569
|
*/
|
|
1550
1570
|
post: operations["localization_jobs_retry"];
|
|
1551
1571
|
delete?: never;
|
|
@@ -1585,7 +1605,7 @@ export interface paths {
|
|
|
1585
1605
|
put?: never;
|
|
1586
1606
|
/**
|
|
1587
1607
|
* localization.jobs.cancel
|
|
1588
|
-
* @description Cancel a queued or paused full-site translation job
|
|
1608
|
+
* @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
1609
|
*/
|
|
1590
1610
|
post: operations["localization_jobs_cancel"];
|
|
1591
1611
|
delete?: never;
|
|
@@ -1594,6 +1614,50 @@ export interface paths {
|
|
|
1594
1614
|
patch?: never;
|
|
1595
1615
|
trace?: never;
|
|
1596
1616
|
};
|
|
1617
|
+
"/sites/{id}/translation-glossary": {
|
|
1618
|
+
parameters: {
|
|
1619
|
+
query?: never;
|
|
1620
|
+
header?: never;
|
|
1621
|
+
path?: never;
|
|
1622
|
+
cookie?: never;
|
|
1623
|
+
};
|
|
1624
|
+
/**
|
|
1625
|
+
* localization.glossary.list
|
|
1626
|
+
* @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.
|
|
1627
|
+
*/
|
|
1628
|
+
get: operations["localization_glossary_list"];
|
|
1629
|
+
/**
|
|
1630
|
+
* localization.glossary.upsert
|
|
1631
|
+
* @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).
|
|
1632
|
+
*/
|
|
1633
|
+
put: operations["localization_glossary_upsert"];
|
|
1634
|
+
post?: never;
|
|
1635
|
+
delete?: never;
|
|
1636
|
+
options?: never;
|
|
1637
|
+
head?: never;
|
|
1638
|
+
patch?: never;
|
|
1639
|
+
trace?: never;
|
|
1640
|
+
};
|
|
1641
|
+
"/sites/{id}/translation-glossary/{termId}": {
|
|
1642
|
+
parameters: {
|
|
1643
|
+
query?: never;
|
|
1644
|
+
header?: never;
|
|
1645
|
+
path?: never;
|
|
1646
|
+
cookie?: never;
|
|
1647
|
+
};
|
|
1648
|
+
get?: never;
|
|
1649
|
+
put?: never;
|
|
1650
|
+
post?: never;
|
|
1651
|
+
/**
|
|
1652
|
+
* localization.glossary.delete
|
|
1653
|
+
* @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.
|
|
1654
|
+
*/
|
|
1655
|
+
delete: operations["localization_glossary_delete"];
|
|
1656
|
+
options?: never;
|
|
1657
|
+
head?: never;
|
|
1658
|
+
patch?: never;
|
|
1659
|
+
trace?: never;
|
|
1660
|
+
};
|
|
1597
1661
|
"/sites/{id}/forms": {
|
|
1598
1662
|
parameters: {
|
|
1599
1663
|
query?: never;
|
|
@@ -1661,7 +1725,7 @@ export interface paths {
|
|
|
1661
1725
|
head?: never;
|
|
1662
1726
|
/**
|
|
1663
1727
|
* 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.
|
|
1728
|
+
* @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
1729
|
*/
|
|
1666
1730
|
patch: operations["forms_update"];
|
|
1667
1731
|
trace?: never;
|
|
@@ -3068,13 +3132,13 @@ export interface paths {
|
|
|
3068
3132
|
};
|
|
3069
3133
|
/**
|
|
3070
3134
|
* 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.
|
|
3135
|
+
* @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
3136
|
*/
|
|
3073
3137
|
get: operations["media_list"];
|
|
3074
3138
|
put?: never;
|
|
3075
3139
|
/**
|
|
3076
3140
|
* 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).
|
|
3141
|
+
* @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
3142
|
*/
|
|
3079
3143
|
post: operations["media_upload"];
|
|
3080
3144
|
delete?: never;
|
|
@@ -3178,7 +3242,7 @@ export interface paths {
|
|
|
3178
3242
|
put?: never;
|
|
3179
3243
|
/**
|
|
3180
3244
|
* 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.
|
|
3245
|
+
* @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
3246
|
*/
|
|
3183
3247
|
post: operations["media_import_stock"];
|
|
3184
3248
|
delete?: never;
|
|
@@ -3230,7 +3294,7 @@ export interface paths {
|
|
|
3230
3294
|
head?: never;
|
|
3231
3295
|
/**
|
|
3232
3296
|
* media.update
|
|
3233
|
-
* @description Set a file's tags and an image's defaults, kept across new versions.
|
|
3297
|
+
* @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
3298
|
*/
|
|
3235
3299
|
patch: operations["media_update"];
|
|
3236
3300
|
trace?: never;
|
|
@@ -3246,7 +3310,7 @@ export interface paths {
|
|
|
3246
3310
|
put?: never;
|
|
3247
3311
|
/**
|
|
3248
3312
|
* 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.
|
|
3313
|
+
* @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
3314
|
*/
|
|
3251
3315
|
post: operations["media_replace"];
|
|
3252
3316
|
delete?: never;
|
|
@@ -3696,7 +3760,7 @@ export interface paths {
|
|
|
3696
3760
|
};
|
|
3697
3761
|
/**
|
|
3698
3762
|
* 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.
|
|
3763
|
+
* @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
3764
|
*/
|
|
3701
3765
|
get: operations["sites_usage"];
|
|
3702
3766
|
put?: never;
|
|
@@ -3824,10 +3888,10 @@ export interface components {
|
|
|
3824
3888
|
* @description Stable error code. Codes not listed here follow the suffix rules: *_NOT_FOUND → 404, *_REQUIRED / *_FORBIDDEN / *_PLAN_REQUIRED / *_LIMIT → 403, otherwise 422.
|
|
3825
3889
|
* @enum {string}
|
|
3826
3890
|
*/
|
|
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";
|
|
3891
|
+
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
3892
|
};
|
|
3829
3893
|
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. */
|
|
3894
|
+
/** @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
3895
|
Error400: {
|
|
3832
3896
|
headers: {
|
|
3833
3897
|
[name: string]: unknown;
|
|
@@ -5271,6 +5335,10 @@ export interface operations {
|
|
|
5271
5335
|
edgeColor: string | null;
|
|
5272
5336
|
/** @description Default alt text, used when the place that shows the image has no alt of its own. */
|
|
5273
5337
|
altText: string | null;
|
|
5338
|
+
/** @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[]. */
|
|
5339
|
+
credit: string | null;
|
|
5340
|
+
/** @description Where the file came from (the stock photo's page, the original source); filled automatically by media.import_stock. Public like credit. */
|
|
5341
|
+
sourceUrl: string | null;
|
|
5274
5342
|
/** @description true when the owner excluded this image from the site watermark. */
|
|
5275
5343
|
watermarkExempt: boolean;
|
|
5276
5344
|
createdAt: string;
|
|
@@ -5426,6 +5494,10 @@ export interface operations {
|
|
|
5426
5494
|
edgeColor: string | null;
|
|
5427
5495
|
/** @description Default alt text, used when the place that shows the image has no alt of its own. */
|
|
5428
5496
|
altText: string | null;
|
|
5497
|
+
/** @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[]. */
|
|
5498
|
+
credit: string | null;
|
|
5499
|
+
/** @description Where the file came from (the stock photo's page, the original source); filled automatically by media.import_stock. Public like credit. */
|
|
5500
|
+
sourceUrl: string | null;
|
|
5429
5501
|
/** @description true when the owner excluded this image from the site watermark. */
|
|
5430
5502
|
watermarkExempt: boolean;
|
|
5431
5503
|
createdAt: string;
|
|
@@ -5843,6 +5915,10 @@ export interface operations {
|
|
|
5843
5915
|
edgeColor: string | null;
|
|
5844
5916
|
/** @description Default alt text, used when the place that shows the image has no alt of its own. */
|
|
5845
5917
|
altText: string | null;
|
|
5918
|
+
/** @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[]. */
|
|
5919
|
+
credit: string | null;
|
|
5920
|
+
/** @description Where the file came from (the stock photo's page, the original source); filled automatically by media.import_stock. Public like credit. */
|
|
5921
|
+
sourceUrl: string | null;
|
|
5846
5922
|
/** @description true when the owner excluded this image from the site watermark. */
|
|
5847
5923
|
watermarkExempt: boolean;
|
|
5848
5924
|
createdAt: string;
|
|
@@ -6141,6 +6217,10 @@ export interface operations {
|
|
|
6141
6217
|
edgeColor: string | null;
|
|
6142
6218
|
/** @description Default alt text, used when the place that shows the image has no alt of its own. */
|
|
6143
6219
|
altText: string | null;
|
|
6220
|
+
/** @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[]. */
|
|
6221
|
+
credit: string | null;
|
|
6222
|
+
/** @description Where the file came from (the stock photo's page, the original source); filled automatically by media.import_stock. Public like credit. */
|
|
6223
|
+
sourceUrl: string | null;
|
|
6144
6224
|
/** @description true when the owner excluded this image from the site watermark. */
|
|
6145
6225
|
watermarkExempt: boolean;
|
|
6146
6226
|
createdAt: string;
|
|
@@ -6553,6 +6633,10 @@ export interface operations {
|
|
|
6553
6633
|
edgeColor: string | null;
|
|
6554
6634
|
/** @description Default alt text, used when the place that shows the image has no alt of its own. */
|
|
6555
6635
|
altText: string | null;
|
|
6636
|
+
/** @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[]. */
|
|
6637
|
+
credit: string | null;
|
|
6638
|
+
/** @description Where the file came from (the stock photo's page, the original source); filled automatically by media.import_stock. Public like credit. */
|
|
6639
|
+
sourceUrl: string | null;
|
|
6556
6640
|
/** @description true when the owner excluded this image from the site watermark. */
|
|
6557
6641
|
watermarkExempt: boolean;
|
|
6558
6642
|
createdAt: string;
|
|
@@ -6876,6 +6960,10 @@ export interface operations {
|
|
|
6876
6960
|
edgeColor: string | null;
|
|
6877
6961
|
/** @description Default alt text, used when the place that shows the image has no alt of its own. */
|
|
6878
6962
|
altText: string | null;
|
|
6963
|
+
/** @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[]. */
|
|
6964
|
+
credit: string | null;
|
|
6965
|
+
/** @description Where the file came from (the stock photo's page, the original source); filled automatically by media.import_stock. Public like credit. */
|
|
6966
|
+
sourceUrl: string | null;
|
|
6879
6967
|
/** @description true when the owner excluded this image from the site watermark. */
|
|
6880
6968
|
watermarkExempt: boolean;
|
|
6881
6969
|
createdAt: string;
|
|
@@ -7668,6 +7756,8 @@ export interface operations {
|
|
|
7668
7756
|
* "focus": null,
|
|
7669
7757
|
* "edgeColor": null,
|
|
7670
7758
|
* "altText": null,
|
|
7759
|
+
* "credit": null,
|
|
7760
|
+
* "sourceUrl": null,
|
|
7671
7761
|
* "watermarkExempt": false,
|
|
7672
7762
|
* "createdAt": "2026-10-01T02:30:00.000Z"
|
|
7673
7763
|
* }
|
|
@@ -7840,6 +7930,10 @@ export interface operations {
|
|
|
7840
7930
|
edgeColor: string | null;
|
|
7841
7931
|
/** @description Default alt text, used when the place that shows the image has no alt of its own. */
|
|
7842
7932
|
altText: string | null;
|
|
7933
|
+
/** @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[]. */
|
|
7934
|
+
credit: string | null;
|
|
7935
|
+
/** @description Where the file came from (the stock photo's page, the original source); filled automatically by media.import_stock. Public like credit. */
|
|
7936
|
+
sourceUrl: string | null;
|
|
7843
7937
|
/** @description true when the owner excluded this image from the site watermark. */
|
|
7844
7938
|
watermarkExempt: boolean;
|
|
7845
7939
|
createdAt: string;
|
|
@@ -8289,6 +8383,8 @@ export interface operations {
|
|
|
8289
8383
|
* "focus": null,
|
|
8290
8384
|
* "edgeColor": null,
|
|
8291
8385
|
* "altText": null,
|
|
8386
|
+
* "credit": null,
|
|
8387
|
+
* "sourceUrl": null,
|
|
8292
8388
|
* "watermarkExempt": false,
|
|
8293
8389
|
* "createdAt": "2026-10-01T02:30:00.000Z"
|
|
8294
8390
|
* }
|
|
@@ -8370,6 +8466,10 @@ export interface operations {
|
|
|
8370
8466
|
edgeColor: string | null;
|
|
8371
8467
|
/** @description Default alt text, used when the place that shows the image has no alt of its own. */
|
|
8372
8468
|
altText: string | null;
|
|
8469
|
+
/** @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[]. */
|
|
8470
|
+
credit: string | null;
|
|
8471
|
+
/** @description Where the file came from (the stock photo's page, the original source); filled automatically by media.import_stock. Public like credit. */
|
|
8472
|
+
sourceUrl: string | null;
|
|
8373
8473
|
/** @description true when the owner excluded this image from the site watermark. */
|
|
8374
8474
|
watermarkExempt: boolean;
|
|
8375
8475
|
createdAt: string;
|
|
@@ -9071,6 +9171,8 @@ export interface operations {
|
|
|
9071
9171
|
* "focus": null,
|
|
9072
9172
|
* "edgeColor": null,
|
|
9073
9173
|
* "altText": null,
|
|
9174
|
+
* "credit": null,
|
|
9175
|
+
* "sourceUrl": null,
|
|
9074
9176
|
* "watermarkExempt": false,
|
|
9075
9177
|
* "createdAt": "2026-10-01T02:30:00.000Z"
|
|
9076
9178
|
* }
|
|
@@ -9267,6 +9369,10 @@ export interface operations {
|
|
|
9267
9369
|
edgeColor: string | null;
|
|
9268
9370
|
/** @description Default alt text, used when the place that shows the image has no alt of its own. */
|
|
9269
9371
|
altText: string | null;
|
|
9372
|
+
/** @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[]. */
|
|
9373
|
+
credit: string | null;
|
|
9374
|
+
/** @description Where the file came from (the stock photo's page, the original source); filled automatically by media.import_stock. Public like credit. */
|
|
9375
|
+
sourceUrl: string | null;
|
|
9270
9376
|
/** @description true when the owner excluded this image from the site watermark. */
|
|
9271
9377
|
watermarkExempt: boolean;
|
|
9272
9378
|
createdAt: string;
|
|
@@ -10226,6 +10332,8 @@ export interface operations {
|
|
|
10226
10332
|
* "focus": null,
|
|
10227
10333
|
* "edgeColor": null,
|
|
10228
10334
|
* "altText": null,
|
|
10335
|
+
* "credit": null,
|
|
10336
|
+
* "sourceUrl": null,
|
|
10229
10337
|
* "watermarkExempt": false,
|
|
10230
10338
|
* "createdAt": "2026-10-01T02:30:00.000Z"
|
|
10231
10339
|
* }
|
|
@@ -10416,6 +10524,10 @@ export interface operations {
|
|
|
10416
10524
|
edgeColor: string | null;
|
|
10417
10525
|
/** @description Default alt text, used when the place that shows the image has no alt of its own. */
|
|
10418
10526
|
altText: string | null;
|
|
10527
|
+
/** @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[]. */
|
|
10528
|
+
credit: string | null;
|
|
10529
|
+
/** @description Where the file came from (the stock photo's page, the original source); filled automatically by media.import_stock. Public like credit. */
|
|
10530
|
+
sourceUrl: string | null;
|
|
10419
10531
|
/** @description true when the owner excluded this image from the site watermark. */
|
|
10420
10532
|
watermarkExempt: boolean;
|
|
10421
10533
|
createdAt: string;
|
|
@@ -10645,6 +10757,8 @@ export interface operations {
|
|
|
10645
10757
|
* "focus": null,
|
|
10646
10758
|
* "edgeColor": null,
|
|
10647
10759
|
* "altText": null,
|
|
10760
|
+
* "credit": null,
|
|
10761
|
+
* "sourceUrl": null,
|
|
10648
10762
|
* "watermarkExempt": false,
|
|
10649
10763
|
* "createdAt": "2026-10-01T02:30:00.000Z"
|
|
10650
10764
|
* }
|
|
@@ -10835,6 +10949,10 @@ export interface operations {
|
|
|
10835
10949
|
edgeColor: string | null;
|
|
10836
10950
|
/** @description Default alt text, used when the place that shows the image has no alt of its own. */
|
|
10837
10951
|
altText: string | null;
|
|
10952
|
+
/** @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[]. */
|
|
10953
|
+
credit: string | null;
|
|
10954
|
+
/** @description Where the file came from (the stock photo's page, the original source); filled automatically by media.import_stock. Public like credit. */
|
|
10955
|
+
sourceUrl: string | null;
|
|
10838
10956
|
/** @description true when the owner excluded this image from the site watermark. */
|
|
10839
10957
|
watermarkExempt: boolean;
|
|
10840
10958
|
createdAt: string;
|
|
@@ -10989,6 +11107,8 @@ export interface operations {
|
|
|
10989
11107
|
* "focus": null,
|
|
10990
11108
|
* "edgeColor": null,
|
|
10991
11109
|
* "altText": null,
|
|
11110
|
+
* "credit": null,
|
|
11111
|
+
* "sourceUrl": null,
|
|
10992
11112
|
* "watermarkExempt": false,
|
|
10993
11113
|
* "createdAt": "2026-10-01T02:30:00.000Z"
|
|
10994
11114
|
* }
|
|
@@ -11180,6 +11300,10 @@ export interface operations {
|
|
|
11180
11300
|
edgeColor: string | null;
|
|
11181
11301
|
/** @description Default alt text, used when the place that shows the image has no alt of its own. */
|
|
11182
11302
|
altText: string | null;
|
|
11303
|
+
/** @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[]. */
|
|
11304
|
+
credit: string | null;
|
|
11305
|
+
/** @description Where the file came from (the stock photo's page, the original source); filled automatically by media.import_stock. Public like credit. */
|
|
11306
|
+
sourceUrl: string | null;
|
|
11183
11307
|
/** @description true when the owner excluded this image from the site watermark. */
|
|
11184
11308
|
watermarkExempt: boolean;
|
|
11185
11309
|
createdAt: string;
|
|
@@ -11326,6 +11450,8 @@ export interface operations {
|
|
|
11326
11450
|
* "focus": null,
|
|
11327
11451
|
* "edgeColor": null,
|
|
11328
11452
|
* "altText": null,
|
|
11453
|
+
* "credit": null,
|
|
11454
|
+
* "sourceUrl": null,
|
|
11329
11455
|
* "watermarkExempt": false,
|
|
11330
11456
|
* "createdAt": "2026-10-01T02:30:00.000Z"
|
|
11331
11457
|
* }
|
|
@@ -11516,6 +11642,10 @@ export interface operations {
|
|
|
11516
11642
|
edgeColor: string | null;
|
|
11517
11643
|
/** @description Default alt text, used when the place that shows the image has no alt of its own. */
|
|
11518
11644
|
altText: string | null;
|
|
11645
|
+
/** @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[]. */
|
|
11646
|
+
credit: string | null;
|
|
11647
|
+
/** @description Where the file came from (the stock photo's page, the original source); filled automatically by media.import_stock. Public like credit. */
|
|
11648
|
+
sourceUrl: string | null;
|
|
11519
11649
|
/** @description true when the owner excluded this image from the site watermark. */
|
|
11520
11650
|
watermarkExempt: boolean;
|
|
11521
11651
|
createdAt: string;
|
|
@@ -11658,6 +11788,8 @@ export interface operations {
|
|
|
11658
11788
|
* "focus": null,
|
|
11659
11789
|
* "edgeColor": null,
|
|
11660
11790
|
* "altText": null,
|
|
11791
|
+
* "credit": null,
|
|
11792
|
+
* "sourceUrl": null,
|
|
11661
11793
|
* "watermarkExempt": false,
|
|
11662
11794
|
* "createdAt": "2026-10-01T02:30:00.000Z"
|
|
11663
11795
|
* }
|
|
@@ -11848,6 +11980,10 @@ export interface operations {
|
|
|
11848
11980
|
edgeColor: string | null;
|
|
11849
11981
|
/** @description Default alt text, used when the place that shows the image has no alt of its own. */
|
|
11850
11982
|
altText: string | null;
|
|
11983
|
+
/** @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[]. */
|
|
11984
|
+
credit: string | null;
|
|
11985
|
+
/** @description Where the file came from (the stock photo's page, the original source); filled automatically by media.import_stock. Public like credit. */
|
|
11986
|
+
sourceUrl: string | null;
|
|
11851
11987
|
/** @description true when the owner excluded this image from the site watermark. */
|
|
11852
11988
|
watermarkExempt: boolean;
|
|
11853
11989
|
createdAt: string;
|
|
@@ -12001,6 +12137,8 @@ export interface operations {
|
|
|
12001
12137
|
* "focus": null,
|
|
12002
12138
|
* "edgeColor": null,
|
|
12003
12139
|
* "altText": null,
|
|
12140
|
+
* "credit": null,
|
|
12141
|
+
* "sourceUrl": null,
|
|
12004
12142
|
* "watermarkExempt": false,
|
|
12005
12143
|
* "createdAt": "2026-10-01T02:30:00.000Z"
|
|
12006
12144
|
* }
|
|
@@ -12191,6 +12329,10 @@ export interface operations {
|
|
|
12191
12329
|
edgeColor: string | null;
|
|
12192
12330
|
/** @description Default alt text, used when the place that shows the image has no alt of its own. */
|
|
12193
12331
|
altText: string | null;
|
|
12332
|
+
/** @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[]. */
|
|
12333
|
+
credit: string | null;
|
|
12334
|
+
/** @description Where the file came from (the stock photo's page, the original source); filled automatically by media.import_stock. Public like credit. */
|
|
12335
|
+
sourceUrl: string | null;
|
|
12194
12336
|
/** @description true when the owner excluded this image from the site watermark. */
|
|
12195
12337
|
watermarkExempt: boolean;
|
|
12196
12338
|
createdAt: string;
|
|
@@ -12333,6 +12475,8 @@ export interface operations {
|
|
|
12333
12475
|
* "focus": null,
|
|
12334
12476
|
* "edgeColor": null,
|
|
12335
12477
|
* "altText": null,
|
|
12478
|
+
* "credit": null,
|
|
12479
|
+
* "sourceUrl": null,
|
|
12336
12480
|
* "watermarkExempt": false,
|
|
12337
12481
|
* "createdAt": "2026-10-01T02:30:00.000Z"
|
|
12338
12482
|
* }
|
|
@@ -12523,6 +12667,10 @@ export interface operations {
|
|
|
12523
12667
|
edgeColor: string | null;
|
|
12524
12668
|
/** @description Default alt text, used when the place that shows the image has no alt of its own. */
|
|
12525
12669
|
altText: string | null;
|
|
12670
|
+
/** @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[]. */
|
|
12671
|
+
credit: string | null;
|
|
12672
|
+
/** @description Where the file came from (the stock photo's page, the original source); filled automatically by media.import_stock. Public like credit. */
|
|
12673
|
+
sourceUrl: string | null;
|
|
12526
12674
|
/** @description true when the owner excluded this image from the site watermark. */
|
|
12527
12675
|
watermarkExempt: boolean;
|
|
12528
12676
|
createdAt: string;
|
|
@@ -13095,6 +13243,8 @@ export interface operations {
|
|
|
13095
13243
|
* ]
|
|
13096
13244
|
* },
|
|
13097
13245
|
* "pathTemplate": "/teachers/{slug}",
|
|
13246
|
+
* "previewUrlTemplate": null,
|
|
13247
|
+
* "singleton": false,
|
|
13098
13248
|
* "createdBy": {
|
|
13099
13249
|
* "kind": "agent",
|
|
13100
13250
|
* "actorId": "user_example01",
|
|
@@ -13124,6 +13274,8 @@ export interface operations {
|
|
|
13124
13274
|
* "accessPolicy": null,
|
|
13125
13275
|
* "search": null,
|
|
13126
13276
|
* "pathTemplate": "/teachers/{slug}",
|
|
13277
|
+
* "previewUrlTemplate": null,
|
|
13278
|
+
* "singleton": false,
|
|
13127
13279
|
* "createdBy": {
|
|
13128
13280
|
* "kind": "agent",
|
|
13129
13281
|
* "actorId": "user_example01",
|
|
@@ -13160,6 +13312,8 @@ export interface operations {
|
|
|
13160
13312
|
aiHint?: string;
|
|
13161
13313
|
system?: boolean;
|
|
13162
13314
|
indexed?: boolean;
|
|
13315
|
+
/** @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. */
|
|
13316
|
+
localized?: boolean;
|
|
13163
13317
|
unique?: boolean;
|
|
13164
13318
|
/** @constant */
|
|
13165
13319
|
type: "text";
|
|
@@ -13167,7 +13321,6 @@ export interface operations {
|
|
|
13167
13321
|
max?: number;
|
|
13168
13322
|
pattern?: string;
|
|
13169
13323
|
default?: string;
|
|
13170
|
-
localized?: boolean;
|
|
13171
13324
|
} | {
|
|
13172
13325
|
id: string;
|
|
13173
13326
|
name: string;
|
|
@@ -13177,10 +13330,11 @@ export interface operations {
|
|
|
13177
13330
|
aiHint?: string;
|
|
13178
13331
|
system?: boolean;
|
|
13179
13332
|
indexed?: boolean;
|
|
13333
|
+
/** @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. */
|
|
13334
|
+
localized?: boolean;
|
|
13180
13335
|
/** @constant */
|
|
13181
13336
|
type: "rich_text";
|
|
13182
13337
|
max?: number;
|
|
13183
|
-
localized?: boolean;
|
|
13184
13338
|
} | {
|
|
13185
13339
|
id: string;
|
|
13186
13340
|
name: string;
|
|
@@ -13190,6 +13344,8 @@ export interface operations {
|
|
|
13190
13344
|
aiHint?: string;
|
|
13191
13345
|
system?: boolean;
|
|
13192
13346
|
indexed?: boolean;
|
|
13347
|
+
/** @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. */
|
|
13348
|
+
localized?: boolean;
|
|
13193
13349
|
unique?: boolean;
|
|
13194
13350
|
/** @constant */
|
|
13195
13351
|
type: "email";
|
|
@@ -13203,6 +13359,8 @@ export interface operations {
|
|
|
13203
13359
|
aiHint?: string;
|
|
13204
13360
|
system?: boolean;
|
|
13205
13361
|
indexed?: boolean;
|
|
13362
|
+
/** @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. */
|
|
13363
|
+
localized?: boolean;
|
|
13206
13364
|
unique?: boolean;
|
|
13207
13365
|
/** @constant */
|
|
13208
13366
|
type: "phone";
|
|
@@ -13216,6 +13374,8 @@ export interface operations {
|
|
|
13216
13374
|
aiHint?: string;
|
|
13217
13375
|
system?: boolean;
|
|
13218
13376
|
indexed?: boolean;
|
|
13377
|
+
/** @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. */
|
|
13378
|
+
localized?: boolean;
|
|
13219
13379
|
unique?: boolean;
|
|
13220
13380
|
/** @constant */
|
|
13221
13381
|
type: "url";
|
|
@@ -13229,6 +13389,8 @@ export interface operations {
|
|
|
13229
13389
|
aiHint?: string;
|
|
13230
13390
|
system?: boolean;
|
|
13231
13391
|
indexed?: boolean;
|
|
13392
|
+
/** @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. */
|
|
13393
|
+
localized?: boolean;
|
|
13232
13394
|
/** @constant */
|
|
13233
13395
|
type: "video_url";
|
|
13234
13396
|
} | {
|
|
@@ -13240,6 +13402,8 @@ export interface operations {
|
|
|
13240
13402
|
aiHint?: string;
|
|
13241
13403
|
system?: boolean;
|
|
13242
13404
|
indexed?: boolean;
|
|
13405
|
+
/** @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. */
|
|
13406
|
+
localized?: boolean;
|
|
13243
13407
|
unique?: boolean;
|
|
13244
13408
|
/** @constant */
|
|
13245
13409
|
type: "number";
|
|
@@ -13256,6 +13420,8 @@ export interface operations {
|
|
|
13256
13420
|
aiHint?: string;
|
|
13257
13421
|
system?: boolean;
|
|
13258
13422
|
indexed?: boolean;
|
|
13423
|
+
/** @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. */
|
|
13424
|
+
localized?: boolean;
|
|
13259
13425
|
/** @constant */
|
|
13260
13426
|
type: "boolean";
|
|
13261
13427
|
default?: boolean;
|
|
@@ -13268,6 +13434,8 @@ export interface operations {
|
|
|
13268
13434
|
aiHint?: string;
|
|
13269
13435
|
system?: boolean;
|
|
13270
13436
|
indexed?: boolean;
|
|
13437
|
+
/** @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. */
|
|
13438
|
+
localized?: boolean;
|
|
13271
13439
|
/** @constant */
|
|
13272
13440
|
type: "date";
|
|
13273
13441
|
min?: string;
|
|
@@ -13282,6 +13450,8 @@ export interface operations {
|
|
|
13282
13450
|
aiHint?: string;
|
|
13283
13451
|
system?: boolean;
|
|
13284
13452
|
indexed?: boolean;
|
|
13453
|
+
/** @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. */
|
|
13454
|
+
localized?: boolean;
|
|
13285
13455
|
/** @constant */
|
|
13286
13456
|
type: "datetime";
|
|
13287
13457
|
min?: string;
|
|
@@ -13296,6 +13466,8 @@ export interface operations {
|
|
|
13296
13466
|
aiHint?: string;
|
|
13297
13467
|
system?: boolean;
|
|
13298
13468
|
indexed?: boolean;
|
|
13469
|
+
/** @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. */
|
|
13470
|
+
localized?: boolean;
|
|
13299
13471
|
/** @constant */
|
|
13300
13472
|
type: "select";
|
|
13301
13473
|
options: {
|
|
@@ -13313,6 +13485,8 @@ export interface operations {
|
|
|
13313
13485
|
aiHint?: string;
|
|
13314
13486
|
system?: boolean;
|
|
13315
13487
|
indexed?: boolean;
|
|
13488
|
+
/** @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. */
|
|
13489
|
+
localized?: boolean;
|
|
13316
13490
|
/** @constant */
|
|
13317
13491
|
type: "multi_select";
|
|
13318
13492
|
options: {
|
|
@@ -13332,6 +13506,8 @@ export interface operations {
|
|
|
13332
13506
|
aiHint?: string;
|
|
13333
13507
|
system?: boolean;
|
|
13334
13508
|
indexed?: boolean;
|
|
13509
|
+
/** @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. */
|
|
13510
|
+
localized?: boolean;
|
|
13335
13511
|
/** @constant */
|
|
13336
13512
|
type: "color";
|
|
13337
13513
|
default?: string;
|
|
@@ -13344,6 +13520,8 @@ export interface operations {
|
|
|
13344
13520
|
aiHint?: string;
|
|
13345
13521
|
system?: boolean;
|
|
13346
13522
|
indexed?: boolean;
|
|
13523
|
+
/** @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. */
|
|
13524
|
+
localized?: boolean;
|
|
13347
13525
|
/** @constant */
|
|
13348
13526
|
type: "image";
|
|
13349
13527
|
} | {
|
|
@@ -13355,6 +13533,8 @@ export interface operations {
|
|
|
13355
13533
|
aiHint?: string;
|
|
13356
13534
|
system?: boolean;
|
|
13357
13535
|
indexed?: boolean;
|
|
13536
|
+
/** @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. */
|
|
13537
|
+
localized?: boolean;
|
|
13358
13538
|
/** @constant */
|
|
13359
13539
|
type: "gallery";
|
|
13360
13540
|
min?: number;
|
|
@@ -13368,6 +13548,8 @@ export interface operations {
|
|
|
13368
13548
|
aiHint?: string;
|
|
13369
13549
|
system?: boolean;
|
|
13370
13550
|
indexed?: boolean;
|
|
13551
|
+
/** @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. */
|
|
13552
|
+
localized?: boolean;
|
|
13371
13553
|
/** @constant */
|
|
13372
13554
|
type: "file";
|
|
13373
13555
|
} | {
|
|
@@ -13379,6 +13561,8 @@ export interface operations {
|
|
|
13379
13561
|
aiHint?: string;
|
|
13380
13562
|
system?: boolean;
|
|
13381
13563
|
indexed?: boolean;
|
|
13564
|
+
/** @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. */
|
|
13565
|
+
localized?: boolean;
|
|
13382
13566
|
/** @constant */
|
|
13383
13567
|
type: "reference";
|
|
13384
13568
|
targetCollectionKey: string;
|
|
@@ -13391,6 +13575,8 @@ export interface operations {
|
|
|
13391
13575
|
aiHint?: string;
|
|
13392
13576
|
system?: boolean;
|
|
13393
13577
|
indexed?: boolean;
|
|
13578
|
+
/** @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. */
|
|
13579
|
+
localized?: boolean;
|
|
13394
13580
|
/** @constant */
|
|
13395
13581
|
type: "multi_reference";
|
|
13396
13582
|
targetCollectionKey: string;
|
|
@@ -13405,8 +13591,14 @@ export interface operations {
|
|
|
13405
13591
|
aiHint?: string;
|
|
13406
13592
|
system?: boolean;
|
|
13407
13593
|
indexed?: boolean;
|
|
13594
|
+
/** @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. */
|
|
13595
|
+
localized?: boolean;
|
|
13408
13596
|
/** @constant */
|
|
13409
13597
|
type: "json";
|
|
13598
|
+
/** @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. */
|
|
13599
|
+
schema?: {
|
|
13600
|
+
[key: string]: unknown;
|
|
13601
|
+
};
|
|
13410
13602
|
})[];
|
|
13411
13603
|
titleFieldId: string;
|
|
13412
13604
|
/** @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 +13621,10 @@ export interface operations {
|
|
|
13429
13621
|
} | null;
|
|
13430
13622
|
/** @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
13623
|
pathTemplate: string | null;
|
|
13624
|
+
/** @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. */
|
|
13625
|
+
previewUrlTemplate: string | null;
|
|
13626
|
+
/** @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. */
|
|
13627
|
+
singleton: boolean;
|
|
13432
13628
|
createdBy: {
|
|
13433
13629
|
/** @enum {string} */
|
|
13434
13630
|
kind: "agent" | "user";
|
|
@@ -13547,6 +13743,8 @@ export interface operations {
|
|
|
13547
13743
|
aiHint?: string;
|
|
13548
13744
|
system?: boolean;
|
|
13549
13745
|
indexed?: boolean;
|
|
13746
|
+
/** @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. */
|
|
13747
|
+
localized?: boolean;
|
|
13550
13748
|
unique?: boolean;
|
|
13551
13749
|
/** @constant */
|
|
13552
13750
|
type: "text";
|
|
@@ -13554,7 +13752,6 @@ export interface operations {
|
|
|
13554
13752
|
max?: number;
|
|
13555
13753
|
pattern?: string;
|
|
13556
13754
|
default?: string;
|
|
13557
|
-
localized?: boolean;
|
|
13558
13755
|
} | {
|
|
13559
13756
|
id: string;
|
|
13560
13757
|
name: string;
|
|
@@ -13564,10 +13761,11 @@ export interface operations {
|
|
|
13564
13761
|
aiHint?: string;
|
|
13565
13762
|
system?: boolean;
|
|
13566
13763
|
indexed?: boolean;
|
|
13764
|
+
/** @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. */
|
|
13765
|
+
localized?: boolean;
|
|
13567
13766
|
/** @constant */
|
|
13568
13767
|
type: "rich_text";
|
|
13569
13768
|
max?: number;
|
|
13570
|
-
localized?: boolean;
|
|
13571
13769
|
} | {
|
|
13572
13770
|
id: string;
|
|
13573
13771
|
name: string;
|
|
@@ -13577,6 +13775,8 @@ export interface operations {
|
|
|
13577
13775
|
aiHint?: string;
|
|
13578
13776
|
system?: boolean;
|
|
13579
13777
|
indexed?: boolean;
|
|
13778
|
+
/** @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. */
|
|
13779
|
+
localized?: boolean;
|
|
13580
13780
|
unique?: boolean;
|
|
13581
13781
|
/** @constant */
|
|
13582
13782
|
type: "email";
|
|
@@ -13590,6 +13790,8 @@ export interface operations {
|
|
|
13590
13790
|
aiHint?: string;
|
|
13591
13791
|
system?: boolean;
|
|
13592
13792
|
indexed?: boolean;
|
|
13793
|
+
/** @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. */
|
|
13794
|
+
localized?: boolean;
|
|
13593
13795
|
unique?: boolean;
|
|
13594
13796
|
/** @constant */
|
|
13595
13797
|
type: "phone";
|
|
@@ -13603,6 +13805,8 @@ export interface operations {
|
|
|
13603
13805
|
aiHint?: string;
|
|
13604
13806
|
system?: boolean;
|
|
13605
13807
|
indexed?: boolean;
|
|
13808
|
+
/** @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. */
|
|
13809
|
+
localized?: boolean;
|
|
13606
13810
|
unique?: boolean;
|
|
13607
13811
|
/** @constant */
|
|
13608
13812
|
type: "url";
|
|
@@ -13616,6 +13820,8 @@ export interface operations {
|
|
|
13616
13820
|
aiHint?: string;
|
|
13617
13821
|
system?: boolean;
|
|
13618
13822
|
indexed?: boolean;
|
|
13823
|
+
/** @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. */
|
|
13824
|
+
localized?: boolean;
|
|
13619
13825
|
/** @constant */
|
|
13620
13826
|
type: "video_url";
|
|
13621
13827
|
} | {
|
|
@@ -13627,6 +13833,8 @@ export interface operations {
|
|
|
13627
13833
|
aiHint?: string;
|
|
13628
13834
|
system?: boolean;
|
|
13629
13835
|
indexed?: boolean;
|
|
13836
|
+
/** @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. */
|
|
13837
|
+
localized?: boolean;
|
|
13630
13838
|
unique?: boolean;
|
|
13631
13839
|
/** @constant */
|
|
13632
13840
|
type: "number";
|
|
@@ -13643,6 +13851,8 @@ export interface operations {
|
|
|
13643
13851
|
aiHint?: string;
|
|
13644
13852
|
system?: boolean;
|
|
13645
13853
|
indexed?: boolean;
|
|
13854
|
+
/** @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. */
|
|
13855
|
+
localized?: boolean;
|
|
13646
13856
|
/** @constant */
|
|
13647
13857
|
type: "boolean";
|
|
13648
13858
|
default?: boolean;
|
|
@@ -13655,6 +13865,8 @@ export interface operations {
|
|
|
13655
13865
|
aiHint?: string;
|
|
13656
13866
|
system?: boolean;
|
|
13657
13867
|
indexed?: boolean;
|
|
13868
|
+
/** @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. */
|
|
13869
|
+
localized?: boolean;
|
|
13658
13870
|
/** @constant */
|
|
13659
13871
|
type: "date";
|
|
13660
13872
|
min?: string;
|
|
@@ -13669,6 +13881,8 @@ export interface operations {
|
|
|
13669
13881
|
aiHint?: string;
|
|
13670
13882
|
system?: boolean;
|
|
13671
13883
|
indexed?: boolean;
|
|
13884
|
+
/** @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. */
|
|
13885
|
+
localized?: boolean;
|
|
13672
13886
|
/** @constant */
|
|
13673
13887
|
type: "datetime";
|
|
13674
13888
|
min?: string;
|
|
@@ -13683,6 +13897,8 @@ export interface operations {
|
|
|
13683
13897
|
aiHint?: string;
|
|
13684
13898
|
system?: boolean;
|
|
13685
13899
|
indexed?: boolean;
|
|
13900
|
+
/** @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. */
|
|
13901
|
+
localized?: boolean;
|
|
13686
13902
|
/** @constant */
|
|
13687
13903
|
type: "select";
|
|
13688
13904
|
options: {
|
|
@@ -13700,6 +13916,8 @@ export interface operations {
|
|
|
13700
13916
|
aiHint?: string;
|
|
13701
13917
|
system?: boolean;
|
|
13702
13918
|
indexed?: boolean;
|
|
13919
|
+
/** @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. */
|
|
13920
|
+
localized?: boolean;
|
|
13703
13921
|
/** @constant */
|
|
13704
13922
|
type: "multi_select";
|
|
13705
13923
|
options: {
|
|
@@ -13719,6 +13937,8 @@ export interface operations {
|
|
|
13719
13937
|
aiHint?: string;
|
|
13720
13938
|
system?: boolean;
|
|
13721
13939
|
indexed?: boolean;
|
|
13940
|
+
/** @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. */
|
|
13941
|
+
localized?: boolean;
|
|
13722
13942
|
/** @constant */
|
|
13723
13943
|
type: "color";
|
|
13724
13944
|
default?: string;
|
|
@@ -13731,6 +13951,8 @@ export interface operations {
|
|
|
13731
13951
|
aiHint?: string;
|
|
13732
13952
|
system?: boolean;
|
|
13733
13953
|
indexed?: boolean;
|
|
13954
|
+
/** @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. */
|
|
13955
|
+
localized?: boolean;
|
|
13734
13956
|
/** @constant */
|
|
13735
13957
|
type: "image";
|
|
13736
13958
|
} | {
|
|
@@ -13742,6 +13964,8 @@ export interface operations {
|
|
|
13742
13964
|
aiHint?: string;
|
|
13743
13965
|
system?: boolean;
|
|
13744
13966
|
indexed?: boolean;
|
|
13967
|
+
/** @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. */
|
|
13968
|
+
localized?: boolean;
|
|
13745
13969
|
/** @constant */
|
|
13746
13970
|
type: "gallery";
|
|
13747
13971
|
min?: number;
|
|
@@ -13755,6 +13979,8 @@ export interface operations {
|
|
|
13755
13979
|
aiHint?: string;
|
|
13756
13980
|
system?: boolean;
|
|
13757
13981
|
indexed?: boolean;
|
|
13982
|
+
/** @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. */
|
|
13983
|
+
localized?: boolean;
|
|
13758
13984
|
/** @constant */
|
|
13759
13985
|
type: "file";
|
|
13760
13986
|
} | {
|
|
@@ -13766,6 +13992,8 @@ export interface operations {
|
|
|
13766
13992
|
aiHint?: string;
|
|
13767
13993
|
system?: boolean;
|
|
13768
13994
|
indexed?: boolean;
|
|
13995
|
+
/** @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. */
|
|
13996
|
+
localized?: boolean;
|
|
13769
13997
|
/** @constant */
|
|
13770
13998
|
type: "reference";
|
|
13771
13999
|
targetCollectionKey: string;
|
|
@@ -13778,6 +14006,8 @@ export interface operations {
|
|
|
13778
14006
|
aiHint?: string;
|
|
13779
14007
|
system?: boolean;
|
|
13780
14008
|
indexed?: boolean;
|
|
14009
|
+
/** @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. */
|
|
14010
|
+
localized?: boolean;
|
|
13781
14011
|
/** @constant */
|
|
13782
14012
|
type: "multi_reference";
|
|
13783
14013
|
targetCollectionKey: string;
|
|
@@ -13792,8 +14022,14 @@ export interface operations {
|
|
|
13792
14022
|
aiHint?: string;
|
|
13793
14023
|
system?: boolean;
|
|
13794
14024
|
indexed?: boolean;
|
|
14025
|
+
/** @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. */
|
|
14026
|
+
localized?: boolean;
|
|
13795
14027
|
/** @constant */
|
|
13796
14028
|
type: "json";
|
|
14029
|
+
/** @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. */
|
|
14030
|
+
schema?: {
|
|
14031
|
+
[key: string]: unknown;
|
|
14032
|
+
};
|
|
13797
14033
|
})[];
|
|
13798
14034
|
titleFieldId: string;
|
|
13799
14035
|
accessPolicy?: {
|
|
@@ -13813,6 +14049,9 @@ export interface operations {
|
|
|
13813
14049
|
pathTemplate?: string | null;
|
|
13814
14050
|
} | null;
|
|
13815
14051
|
pathTemplate?: string | null;
|
|
14052
|
+
previewUrlTemplate?: string | null;
|
|
14053
|
+
/** @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. */
|
|
14054
|
+
singleton?: boolean;
|
|
13816
14055
|
};
|
|
13817
14056
|
};
|
|
13818
14057
|
};
|
|
@@ -13899,6 +14138,8 @@ export interface operations {
|
|
|
13899
14138
|
* ]
|
|
13900
14139
|
* },
|
|
13901
14140
|
* "pathTemplate": "/teachers/{slug}",
|
|
14141
|
+
* "previewUrlTemplate": null,
|
|
14142
|
+
* "singleton": false,
|
|
13902
14143
|
* "createdBy": {
|
|
13903
14144
|
* "kind": "agent",
|
|
13904
14145
|
* "actorId": "user_example01",
|
|
@@ -13940,6 +14181,8 @@ export interface operations {
|
|
|
13940
14181
|
aiHint?: string;
|
|
13941
14182
|
system?: boolean;
|
|
13942
14183
|
indexed?: boolean;
|
|
14184
|
+
/** @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. */
|
|
14185
|
+
localized?: boolean;
|
|
13943
14186
|
unique?: boolean;
|
|
13944
14187
|
/** @constant */
|
|
13945
14188
|
type: "text";
|
|
@@ -13947,7 +14190,6 @@ export interface operations {
|
|
|
13947
14190
|
max?: number;
|
|
13948
14191
|
pattern?: string;
|
|
13949
14192
|
default?: string;
|
|
13950
|
-
localized?: boolean;
|
|
13951
14193
|
} | {
|
|
13952
14194
|
id: string;
|
|
13953
14195
|
name: string;
|
|
@@ -13957,10 +14199,11 @@ export interface operations {
|
|
|
13957
14199
|
aiHint?: string;
|
|
13958
14200
|
system?: boolean;
|
|
13959
14201
|
indexed?: boolean;
|
|
14202
|
+
/** @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. */
|
|
14203
|
+
localized?: boolean;
|
|
13960
14204
|
/** @constant */
|
|
13961
14205
|
type: "rich_text";
|
|
13962
14206
|
max?: number;
|
|
13963
|
-
localized?: boolean;
|
|
13964
14207
|
} | {
|
|
13965
14208
|
id: string;
|
|
13966
14209
|
name: string;
|
|
@@ -13970,6 +14213,8 @@ export interface operations {
|
|
|
13970
14213
|
aiHint?: string;
|
|
13971
14214
|
system?: boolean;
|
|
13972
14215
|
indexed?: boolean;
|
|
14216
|
+
/** @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. */
|
|
14217
|
+
localized?: boolean;
|
|
13973
14218
|
unique?: boolean;
|
|
13974
14219
|
/** @constant */
|
|
13975
14220
|
type: "email";
|
|
@@ -13983,6 +14228,8 @@ export interface operations {
|
|
|
13983
14228
|
aiHint?: string;
|
|
13984
14229
|
system?: boolean;
|
|
13985
14230
|
indexed?: boolean;
|
|
14231
|
+
/** @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. */
|
|
14232
|
+
localized?: boolean;
|
|
13986
14233
|
unique?: boolean;
|
|
13987
14234
|
/** @constant */
|
|
13988
14235
|
type: "phone";
|
|
@@ -13996,6 +14243,8 @@ export interface operations {
|
|
|
13996
14243
|
aiHint?: string;
|
|
13997
14244
|
system?: boolean;
|
|
13998
14245
|
indexed?: boolean;
|
|
14246
|
+
/** @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. */
|
|
14247
|
+
localized?: boolean;
|
|
13999
14248
|
unique?: boolean;
|
|
14000
14249
|
/** @constant */
|
|
14001
14250
|
type: "url";
|
|
@@ -14009,6 +14258,8 @@ export interface operations {
|
|
|
14009
14258
|
aiHint?: string;
|
|
14010
14259
|
system?: boolean;
|
|
14011
14260
|
indexed?: boolean;
|
|
14261
|
+
/** @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. */
|
|
14262
|
+
localized?: boolean;
|
|
14012
14263
|
/** @constant */
|
|
14013
14264
|
type: "video_url";
|
|
14014
14265
|
} | {
|
|
@@ -14020,6 +14271,8 @@ export interface operations {
|
|
|
14020
14271
|
aiHint?: string;
|
|
14021
14272
|
system?: boolean;
|
|
14022
14273
|
indexed?: boolean;
|
|
14274
|
+
/** @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. */
|
|
14275
|
+
localized?: boolean;
|
|
14023
14276
|
unique?: boolean;
|
|
14024
14277
|
/** @constant */
|
|
14025
14278
|
type: "number";
|
|
@@ -14036,6 +14289,8 @@ export interface operations {
|
|
|
14036
14289
|
aiHint?: string;
|
|
14037
14290
|
system?: boolean;
|
|
14038
14291
|
indexed?: boolean;
|
|
14292
|
+
/** @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. */
|
|
14293
|
+
localized?: boolean;
|
|
14039
14294
|
/** @constant */
|
|
14040
14295
|
type: "boolean";
|
|
14041
14296
|
default?: boolean;
|
|
@@ -14048,6 +14303,8 @@ export interface operations {
|
|
|
14048
14303
|
aiHint?: string;
|
|
14049
14304
|
system?: boolean;
|
|
14050
14305
|
indexed?: boolean;
|
|
14306
|
+
/** @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. */
|
|
14307
|
+
localized?: boolean;
|
|
14051
14308
|
/** @constant */
|
|
14052
14309
|
type: "date";
|
|
14053
14310
|
min?: string;
|
|
@@ -14062,6 +14319,8 @@ export interface operations {
|
|
|
14062
14319
|
aiHint?: string;
|
|
14063
14320
|
system?: boolean;
|
|
14064
14321
|
indexed?: boolean;
|
|
14322
|
+
/** @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. */
|
|
14323
|
+
localized?: boolean;
|
|
14065
14324
|
/** @constant */
|
|
14066
14325
|
type: "datetime";
|
|
14067
14326
|
min?: string;
|
|
@@ -14076,6 +14335,8 @@ export interface operations {
|
|
|
14076
14335
|
aiHint?: string;
|
|
14077
14336
|
system?: boolean;
|
|
14078
14337
|
indexed?: boolean;
|
|
14338
|
+
/** @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. */
|
|
14339
|
+
localized?: boolean;
|
|
14079
14340
|
/** @constant */
|
|
14080
14341
|
type: "select";
|
|
14081
14342
|
options: {
|
|
@@ -14093,6 +14354,8 @@ export interface operations {
|
|
|
14093
14354
|
aiHint?: string;
|
|
14094
14355
|
system?: boolean;
|
|
14095
14356
|
indexed?: boolean;
|
|
14357
|
+
/** @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. */
|
|
14358
|
+
localized?: boolean;
|
|
14096
14359
|
/** @constant */
|
|
14097
14360
|
type: "multi_select";
|
|
14098
14361
|
options: {
|
|
@@ -14112,6 +14375,8 @@ export interface operations {
|
|
|
14112
14375
|
aiHint?: string;
|
|
14113
14376
|
system?: boolean;
|
|
14114
14377
|
indexed?: boolean;
|
|
14378
|
+
/** @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. */
|
|
14379
|
+
localized?: boolean;
|
|
14115
14380
|
/** @constant */
|
|
14116
14381
|
type: "color";
|
|
14117
14382
|
default?: string;
|
|
@@ -14124,6 +14389,8 @@ export interface operations {
|
|
|
14124
14389
|
aiHint?: string;
|
|
14125
14390
|
system?: boolean;
|
|
14126
14391
|
indexed?: boolean;
|
|
14392
|
+
/** @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. */
|
|
14393
|
+
localized?: boolean;
|
|
14127
14394
|
/** @constant */
|
|
14128
14395
|
type: "image";
|
|
14129
14396
|
} | {
|
|
@@ -14135,6 +14402,8 @@ export interface operations {
|
|
|
14135
14402
|
aiHint?: string;
|
|
14136
14403
|
system?: boolean;
|
|
14137
14404
|
indexed?: boolean;
|
|
14405
|
+
/** @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. */
|
|
14406
|
+
localized?: boolean;
|
|
14138
14407
|
/** @constant */
|
|
14139
14408
|
type: "gallery";
|
|
14140
14409
|
min?: number;
|
|
@@ -14148,6 +14417,8 @@ export interface operations {
|
|
|
14148
14417
|
aiHint?: string;
|
|
14149
14418
|
system?: boolean;
|
|
14150
14419
|
indexed?: boolean;
|
|
14420
|
+
/** @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. */
|
|
14421
|
+
localized?: boolean;
|
|
14151
14422
|
/** @constant */
|
|
14152
14423
|
type: "file";
|
|
14153
14424
|
} | {
|
|
@@ -14159,6 +14430,8 @@ export interface operations {
|
|
|
14159
14430
|
aiHint?: string;
|
|
14160
14431
|
system?: boolean;
|
|
14161
14432
|
indexed?: boolean;
|
|
14433
|
+
/** @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. */
|
|
14434
|
+
localized?: boolean;
|
|
14162
14435
|
/** @constant */
|
|
14163
14436
|
type: "reference";
|
|
14164
14437
|
targetCollectionKey: string;
|
|
@@ -14171,6 +14444,8 @@ export interface operations {
|
|
|
14171
14444
|
aiHint?: string;
|
|
14172
14445
|
system?: boolean;
|
|
14173
14446
|
indexed?: boolean;
|
|
14447
|
+
/** @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. */
|
|
14448
|
+
localized?: boolean;
|
|
14174
14449
|
/** @constant */
|
|
14175
14450
|
type: "multi_reference";
|
|
14176
14451
|
targetCollectionKey: string;
|
|
@@ -14185,8 +14460,14 @@ export interface operations {
|
|
|
14185
14460
|
aiHint?: string;
|
|
14186
14461
|
system?: boolean;
|
|
14187
14462
|
indexed?: boolean;
|
|
14463
|
+
/** @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. */
|
|
14464
|
+
localized?: boolean;
|
|
14188
14465
|
/** @constant */
|
|
14189
14466
|
type: "json";
|
|
14467
|
+
/** @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. */
|
|
14468
|
+
schema?: {
|
|
14469
|
+
[key: string]: unknown;
|
|
14470
|
+
};
|
|
14190
14471
|
})[];
|
|
14191
14472
|
titleFieldId: string;
|
|
14192
14473
|
/** @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 +14490,10 @@ export interface operations {
|
|
|
14209
14490
|
} | null;
|
|
14210
14491
|
/** @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
14492
|
pathTemplate: string | null;
|
|
14493
|
+
/** @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. */
|
|
14494
|
+
previewUrlTemplate: string | null;
|
|
14495
|
+
/** @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. */
|
|
14496
|
+
singleton: boolean;
|
|
14212
14497
|
createdBy: {
|
|
14213
14498
|
/** @enum {string} */
|
|
14214
14499
|
kind: "agent" | "user";
|
|
@@ -14223,7 +14508,7 @@ export interface operations {
|
|
|
14223
14508
|
/** @description The site's public origin. */
|
|
14224
14509
|
baseUrl: string;
|
|
14225
14510
|
listUrl: string;
|
|
14226
|
-
/** @description Replace {slug} with an item's slug. */
|
|
14511
|
+
/** @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
14512
|
itemUrl: string;
|
|
14228
14513
|
schemaUrl: string;
|
|
14229
14514
|
/** @description Copy-paste JavaScript using fetch(). */
|
|
@@ -14339,6 +14624,8 @@ export interface operations {
|
|
|
14339
14624
|
* ]
|
|
14340
14625
|
* },
|
|
14341
14626
|
* "pathTemplate": "/teachers/{slug}",
|
|
14627
|
+
* "previewUrlTemplate": null,
|
|
14628
|
+
* "singleton": false,
|
|
14342
14629
|
* "createdBy": {
|
|
14343
14630
|
* "kind": "agent",
|
|
14344
14631
|
* "actorId": "user_example01",
|
|
@@ -14380,6 +14667,8 @@ export interface operations {
|
|
|
14380
14667
|
aiHint?: string;
|
|
14381
14668
|
system?: boolean;
|
|
14382
14669
|
indexed?: boolean;
|
|
14670
|
+
/** @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. */
|
|
14671
|
+
localized?: boolean;
|
|
14383
14672
|
unique?: boolean;
|
|
14384
14673
|
/** @constant */
|
|
14385
14674
|
type: "text";
|
|
@@ -14387,7 +14676,6 @@ export interface operations {
|
|
|
14387
14676
|
max?: number;
|
|
14388
14677
|
pattern?: string;
|
|
14389
14678
|
default?: string;
|
|
14390
|
-
localized?: boolean;
|
|
14391
14679
|
} | {
|
|
14392
14680
|
id: string;
|
|
14393
14681
|
name: string;
|
|
@@ -14397,10 +14685,11 @@ export interface operations {
|
|
|
14397
14685
|
aiHint?: string;
|
|
14398
14686
|
system?: boolean;
|
|
14399
14687
|
indexed?: boolean;
|
|
14688
|
+
/** @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. */
|
|
14689
|
+
localized?: boolean;
|
|
14400
14690
|
/** @constant */
|
|
14401
14691
|
type: "rich_text";
|
|
14402
14692
|
max?: number;
|
|
14403
|
-
localized?: boolean;
|
|
14404
14693
|
} | {
|
|
14405
14694
|
id: string;
|
|
14406
14695
|
name: string;
|
|
@@ -14410,6 +14699,8 @@ export interface operations {
|
|
|
14410
14699
|
aiHint?: string;
|
|
14411
14700
|
system?: boolean;
|
|
14412
14701
|
indexed?: boolean;
|
|
14702
|
+
/** @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. */
|
|
14703
|
+
localized?: boolean;
|
|
14413
14704
|
unique?: boolean;
|
|
14414
14705
|
/** @constant */
|
|
14415
14706
|
type: "email";
|
|
@@ -14423,6 +14714,8 @@ export interface operations {
|
|
|
14423
14714
|
aiHint?: string;
|
|
14424
14715
|
system?: boolean;
|
|
14425
14716
|
indexed?: boolean;
|
|
14717
|
+
/** @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. */
|
|
14718
|
+
localized?: boolean;
|
|
14426
14719
|
unique?: boolean;
|
|
14427
14720
|
/** @constant */
|
|
14428
14721
|
type: "phone";
|
|
@@ -14436,6 +14729,8 @@ export interface operations {
|
|
|
14436
14729
|
aiHint?: string;
|
|
14437
14730
|
system?: boolean;
|
|
14438
14731
|
indexed?: boolean;
|
|
14732
|
+
/** @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. */
|
|
14733
|
+
localized?: boolean;
|
|
14439
14734
|
unique?: boolean;
|
|
14440
14735
|
/** @constant */
|
|
14441
14736
|
type: "url";
|
|
@@ -14449,6 +14744,8 @@ export interface operations {
|
|
|
14449
14744
|
aiHint?: string;
|
|
14450
14745
|
system?: boolean;
|
|
14451
14746
|
indexed?: boolean;
|
|
14747
|
+
/** @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. */
|
|
14748
|
+
localized?: boolean;
|
|
14452
14749
|
/** @constant */
|
|
14453
14750
|
type: "video_url";
|
|
14454
14751
|
} | {
|
|
@@ -14460,6 +14757,8 @@ export interface operations {
|
|
|
14460
14757
|
aiHint?: string;
|
|
14461
14758
|
system?: boolean;
|
|
14462
14759
|
indexed?: boolean;
|
|
14760
|
+
/** @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. */
|
|
14761
|
+
localized?: boolean;
|
|
14463
14762
|
unique?: boolean;
|
|
14464
14763
|
/** @constant */
|
|
14465
14764
|
type: "number";
|
|
@@ -14476,6 +14775,8 @@ export interface operations {
|
|
|
14476
14775
|
aiHint?: string;
|
|
14477
14776
|
system?: boolean;
|
|
14478
14777
|
indexed?: boolean;
|
|
14778
|
+
/** @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. */
|
|
14779
|
+
localized?: boolean;
|
|
14479
14780
|
/** @constant */
|
|
14480
14781
|
type: "boolean";
|
|
14481
14782
|
default?: boolean;
|
|
@@ -14488,6 +14789,8 @@ export interface operations {
|
|
|
14488
14789
|
aiHint?: string;
|
|
14489
14790
|
system?: boolean;
|
|
14490
14791
|
indexed?: boolean;
|
|
14792
|
+
/** @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. */
|
|
14793
|
+
localized?: boolean;
|
|
14491
14794
|
/** @constant */
|
|
14492
14795
|
type: "date";
|
|
14493
14796
|
min?: string;
|
|
@@ -14502,6 +14805,8 @@ export interface operations {
|
|
|
14502
14805
|
aiHint?: string;
|
|
14503
14806
|
system?: boolean;
|
|
14504
14807
|
indexed?: boolean;
|
|
14808
|
+
/** @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. */
|
|
14809
|
+
localized?: boolean;
|
|
14505
14810
|
/** @constant */
|
|
14506
14811
|
type: "datetime";
|
|
14507
14812
|
min?: string;
|
|
@@ -14516,6 +14821,8 @@ export interface operations {
|
|
|
14516
14821
|
aiHint?: string;
|
|
14517
14822
|
system?: boolean;
|
|
14518
14823
|
indexed?: boolean;
|
|
14824
|
+
/** @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. */
|
|
14825
|
+
localized?: boolean;
|
|
14519
14826
|
/** @constant */
|
|
14520
14827
|
type: "select";
|
|
14521
14828
|
options: {
|
|
@@ -14533,6 +14840,8 @@ export interface operations {
|
|
|
14533
14840
|
aiHint?: string;
|
|
14534
14841
|
system?: boolean;
|
|
14535
14842
|
indexed?: boolean;
|
|
14843
|
+
/** @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. */
|
|
14844
|
+
localized?: boolean;
|
|
14536
14845
|
/** @constant */
|
|
14537
14846
|
type: "multi_select";
|
|
14538
14847
|
options: {
|
|
@@ -14552,6 +14861,8 @@ export interface operations {
|
|
|
14552
14861
|
aiHint?: string;
|
|
14553
14862
|
system?: boolean;
|
|
14554
14863
|
indexed?: boolean;
|
|
14864
|
+
/** @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. */
|
|
14865
|
+
localized?: boolean;
|
|
14555
14866
|
/** @constant */
|
|
14556
14867
|
type: "color";
|
|
14557
14868
|
default?: string;
|
|
@@ -14564,6 +14875,8 @@ export interface operations {
|
|
|
14564
14875
|
aiHint?: string;
|
|
14565
14876
|
system?: boolean;
|
|
14566
14877
|
indexed?: boolean;
|
|
14878
|
+
/** @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. */
|
|
14879
|
+
localized?: boolean;
|
|
14567
14880
|
/** @constant */
|
|
14568
14881
|
type: "image";
|
|
14569
14882
|
} | {
|
|
@@ -14575,6 +14888,8 @@ export interface operations {
|
|
|
14575
14888
|
aiHint?: string;
|
|
14576
14889
|
system?: boolean;
|
|
14577
14890
|
indexed?: boolean;
|
|
14891
|
+
/** @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. */
|
|
14892
|
+
localized?: boolean;
|
|
14578
14893
|
/** @constant */
|
|
14579
14894
|
type: "gallery";
|
|
14580
14895
|
min?: number;
|
|
@@ -14588,6 +14903,8 @@ export interface operations {
|
|
|
14588
14903
|
aiHint?: string;
|
|
14589
14904
|
system?: boolean;
|
|
14590
14905
|
indexed?: boolean;
|
|
14906
|
+
/** @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. */
|
|
14907
|
+
localized?: boolean;
|
|
14591
14908
|
/** @constant */
|
|
14592
14909
|
type: "file";
|
|
14593
14910
|
} | {
|
|
@@ -14599,6 +14916,8 @@ export interface operations {
|
|
|
14599
14916
|
aiHint?: string;
|
|
14600
14917
|
system?: boolean;
|
|
14601
14918
|
indexed?: boolean;
|
|
14919
|
+
/** @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. */
|
|
14920
|
+
localized?: boolean;
|
|
14602
14921
|
/** @constant */
|
|
14603
14922
|
type: "reference";
|
|
14604
14923
|
targetCollectionKey: string;
|
|
@@ -14611,6 +14930,8 @@ export interface operations {
|
|
|
14611
14930
|
aiHint?: string;
|
|
14612
14931
|
system?: boolean;
|
|
14613
14932
|
indexed?: boolean;
|
|
14933
|
+
/** @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. */
|
|
14934
|
+
localized?: boolean;
|
|
14614
14935
|
/** @constant */
|
|
14615
14936
|
type: "multi_reference";
|
|
14616
14937
|
targetCollectionKey: string;
|
|
@@ -14625,8 +14946,14 @@ export interface operations {
|
|
|
14625
14946
|
aiHint?: string;
|
|
14626
14947
|
system?: boolean;
|
|
14627
14948
|
indexed?: boolean;
|
|
14949
|
+
/** @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. */
|
|
14950
|
+
localized?: boolean;
|
|
14628
14951
|
/** @constant */
|
|
14629
14952
|
type: "json";
|
|
14953
|
+
/** @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. */
|
|
14954
|
+
schema?: {
|
|
14955
|
+
[key: string]: unknown;
|
|
14956
|
+
};
|
|
14630
14957
|
})[];
|
|
14631
14958
|
titleFieldId: string;
|
|
14632
14959
|
/** @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 +14976,10 @@ export interface operations {
|
|
|
14649
14976
|
} | null;
|
|
14650
14977
|
/** @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
14978
|
pathTemplate: string | null;
|
|
14979
|
+
/** @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. */
|
|
14980
|
+
previewUrlTemplate: string | null;
|
|
14981
|
+
/** @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. */
|
|
14982
|
+
singleton: boolean;
|
|
14652
14983
|
createdBy: {
|
|
14653
14984
|
/** @enum {string} */
|
|
14654
14985
|
kind: "agent" | "user";
|
|
@@ -14663,7 +14994,7 @@ export interface operations {
|
|
|
14663
14994
|
/** @description The site's public origin. */
|
|
14664
14995
|
baseUrl: string;
|
|
14665
14996
|
listUrl: string;
|
|
14666
|
-
/** @description Replace {slug} with an item's slug. */
|
|
14997
|
+
/** @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
14998
|
itemUrl: string;
|
|
14668
14999
|
schemaUrl: string;
|
|
14669
15000
|
/** @description Copy-paste JavaScript using fetch(). */
|
|
@@ -14827,6 +15158,8 @@ export interface operations {
|
|
|
14827
15158
|
aiHint?: string;
|
|
14828
15159
|
system?: boolean;
|
|
14829
15160
|
indexed?: boolean;
|
|
15161
|
+
/** @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. */
|
|
15162
|
+
localized?: boolean;
|
|
14830
15163
|
unique?: boolean;
|
|
14831
15164
|
/** @constant */
|
|
14832
15165
|
type: "text";
|
|
@@ -14834,7 +15167,6 @@ export interface operations {
|
|
|
14834
15167
|
max?: number;
|
|
14835
15168
|
pattern?: string;
|
|
14836
15169
|
default?: string;
|
|
14837
|
-
localized?: boolean;
|
|
14838
15170
|
} | {
|
|
14839
15171
|
id: string;
|
|
14840
15172
|
name: string;
|
|
@@ -14844,10 +15176,11 @@ export interface operations {
|
|
|
14844
15176
|
aiHint?: string;
|
|
14845
15177
|
system?: boolean;
|
|
14846
15178
|
indexed?: boolean;
|
|
15179
|
+
/** @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. */
|
|
15180
|
+
localized?: boolean;
|
|
14847
15181
|
/** @constant */
|
|
14848
15182
|
type: "rich_text";
|
|
14849
15183
|
max?: number;
|
|
14850
|
-
localized?: boolean;
|
|
14851
15184
|
} | {
|
|
14852
15185
|
id: string;
|
|
14853
15186
|
name: string;
|
|
@@ -14857,6 +15190,8 @@ export interface operations {
|
|
|
14857
15190
|
aiHint?: string;
|
|
14858
15191
|
system?: boolean;
|
|
14859
15192
|
indexed?: boolean;
|
|
15193
|
+
/** @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. */
|
|
15194
|
+
localized?: boolean;
|
|
14860
15195
|
unique?: boolean;
|
|
14861
15196
|
/** @constant */
|
|
14862
15197
|
type: "email";
|
|
@@ -14870,6 +15205,8 @@ export interface operations {
|
|
|
14870
15205
|
aiHint?: string;
|
|
14871
15206
|
system?: boolean;
|
|
14872
15207
|
indexed?: boolean;
|
|
15208
|
+
/** @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. */
|
|
15209
|
+
localized?: boolean;
|
|
14873
15210
|
unique?: boolean;
|
|
14874
15211
|
/** @constant */
|
|
14875
15212
|
type: "phone";
|
|
@@ -14883,6 +15220,8 @@ export interface operations {
|
|
|
14883
15220
|
aiHint?: string;
|
|
14884
15221
|
system?: boolean;
|
|
14885
15222
|
indexed?: boolean;
|
|
15223
|
+
/** @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. */
|
|
15224
|
+
localized?: boolean;
|
|
14886
15225
|
unique?: boolean;
|
|
14887
15226
|
/** @constant */
|
|
14888
15227
|
type: "url";
|
|
@@ -14896,6 +15235,8 @@ export interface operations {
|
|
|
14896
15235
|
aiHint?: string;
|
|
14897
15236
|
system?: boolean;
|
|
14898
15237
|
indexed?: boolean;
|
|
15238
|
+
/** @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. */
|
|
15239
|
+
localized?: boolean;
|
|
14899
15240
|
/** @constant */
|
|
14900
15241
|
type: "video_url";
|
|
14901
15242
|
} | {
|
|
@@ -14907,6 +15248,8 @@ export interface operations {
|
|
|
14907
15248
|
aiHint?: string;
|
|
14908
15249
|
system?: boolean;
|
|
14909
15250
|
indexed?: boolean;
|
|
15251
|
+
/** @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. */
|
|
15252
|
+
localized?: boolean;
|
|
14910
15253
|
unique?: boolean;
|
|
14911
15254
|
/** @constant */
|
|
14912
15255
|
type: "number";
|
|
@@ -14923,6 +15266,8 @@ export interface operations {
|
|
|
14923
15266
|
aiHint?: string;
|
|
14924
15267
|
system?: boolean;
|
|
14925
15268
|
indexed?: boolean;
|
|
15269
|
+
/** @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. */
|
|
15270
|
+
localized?: boolean;
|
|
14926
15271
|
/** @constant */
|
|
14927
15272
|
type: "boolean";
|
|
14928
15273
|
default?: boolean;
|
|
@@ -14935,6 +15280,8 @@ export interface operations {
|
|
|
14935
15280
|
aiHint?: string;
|
|
14936
15281
|
system?: boolean;
|
|
14937
15282
|
indexed?: boolean;
|
|
15283
|
+
/** @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. */
|
|
15284
|
+
localized?: boolean;
|
|
14938
15285
|
/** @constant */
|
|
14939
15286
|
type: "date";
|
|
14940
15287
|
min?: string;
|
|
@@ -14949,6 +15296,8 @@ export interface operations {
|
|
|
14949
15296
|
aiHint?: string;
|
|
14950
15297
|
system?: boolean;
|
|
14951
15298
|
indexed?: boolean;
|
|
15299
|
+
/** @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. */
|
|
15300
|
+
localized?: boolean;
|
|
14952
15301
|
/** @constant */
|
|
14953
15302
|
type: "datetime";
|
|
14954
15303
|
min?: string;
|
|
@@ -14963,6 +15312,8 @@ export interface operations {
|
|
|
14963
15312
|
aiHint?: string;
|
|
14964
15313
|
system?: boolean;
|
|
14965
15314
|
indexed?: boolean;
|
|
15315
|
+
/** @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. */
|
|
15316
|
+
localized?: boolean;
|
|
14966
15317
|
/** @constant */
|
|
14967
15318
|
type: "select";
|
|
14968
15319
|
options: {
|
|
@@ -14980,6 +15331,8 @@ export interface operations {
|
|
|
14980
15331
|
aiHint?: string;
|
|
14981
15332
|
system?: boolean;
|
|
14982
15333
|
indexed?: boolean;
|
|
15334
|
+
/** @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. */
|
|
15335
|
+
localized?: boolean;
|
|
14983
15336
|
/** @constant */
|
|
14984
15337
|
type: "multi_select";
|
|
14985
15338
|
options: {
|
|
@@ -14999,6 +15352,8 @@ export interface operations {
|
|
|
14999
15352
|
aiHint?: string;
|
|
15000
15353
|
system?: boolean;
|
|
15001
15354
|
indexed?: boolean;
|
|
15355
|
+
/** @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. */
|
|
15356
|
+
localized?: boolean;
|
|
15002
15357
|
/** @constant */
|
|
15003
15358
|
type: "color";
|
|
15004
15359
|
default?: string;
|
|
@@ -15011,6 +15366,8 @@ export interface operations {
|
|
|
15011
15366
|
aiHint?: string;
|
|
15012
15367
|
system?: boolean;
|
|
15013
15368
|
indexed?: boolean;
|
|
15369
|
+
/** @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. */
|
|
15370
|
+
localized?: boolean;
|
|
15014
15371
|
/** @constant */
|
|
15015
15372
|
type: "image";
|
|
15016
15373
|
} | {
|
|
@@ -15022,6 +15379,8 @@ export interface operations {
|
|
|
15022
15379
|
aiHint?: string;
|
|
15023
15380
|
system?: boolean;
|
|
15024
15381
|
indexed?: boolean;
|
|
15382
|
+
/** @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. */
|
|
15383
|
+
localized?: boolean;
|
|
15025
15384
|
/** @constant */
|
|
15026
15385
|
type: "gallery";
|
|
15027
15386
|
min?: number;
|
|
@@ -15035,6 +15394,8 @@ export interface operations {
|
|
|
15035
15394
|
aiHint?: string;
|
|
15036
15395
|
system?: boolean;
|
|
15037
15396
|
indexed?: boolean;
|
|
15397
|
+
/** @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. */
|
|
15398
|
+
localized?: boolean;
|
|
15038
15399
|
/** @constant */
|
|
15039
15400
|
type: "file";
|
|
15040
15401
|
} | {
|
|
@@ -15046,6 +15407,8 @@ export interface operations {
|
|
|
15046
15407
|
aiHint?: string;
|
|
15047
15408
|
system?: boolean;
|
|
15048
15409
|
indexed?: boolean;
|
|
15410
|
+
/** @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. */
|
|
15411
|
+
localized?: boolean;
|
|
15049
15412
|
/** @constant */
|
|
15050
15413
|
type: "reference";
|
|
15051
15414
|
targetCollectionKey: string;
|
|
@@ -15058,6 +15421,8 @@ export interface operations {
|
|
|
15058
15421
|
aiHint?: string;
|
|
15059
15422
|
system?: boolean;
|
|
15060
15423
|
indexed?: boolean;
|
|
15424
|
+
/** @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. */
|
|
15425
|
+
localized?: boolean;
|
|
15061
15426
|
/** @constant */
|
|
15062
15427
|
type: "multi_reference";
|
|
15063
15428
|
targetCollectionKey: string;
|
|
@@ -15072,8 +15437,14 @@ export interface operations {
|
|
|
15072
15437
|
aiHint?: string;
|
|
15073
15438
|
system?: boolean;
|
|
15074
15439
|
indexed?: boolean;
|
|
15440
|
+
/** @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. */
|
|
15441
|
+
localized?: boolean;
|
|
15075
15442
|
/** @constant */
|
|
15076
15443
|
type: "json";
|
|
15444
|
+
/** @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. */
|
|
15445
|
+
schema?: {
|
|
15446
|
+
[key: string]: unknown;
|
|
15447
|
+
};
|
|
15077
15448
|
})[];
|
|
15078
15449
|
titleFieldId?: string;
|
|
15079
15450
|
/** @description Field-level read policy (gatedFields, requires: customer | entitlement(featureKey), optional itemOverrideField). Pass null to remove the policy. */
|
|
@@ -15096,6 +15467,9 @@ export interface operations {
|
|
|
15096
15467
|
} | null;
|
|
15097
15468
|
/** @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
15469
|
pathTemplate?: string | null;
|
|
15470
|
+
previewUrlTemplate?: string | null;
|
|
15471
|
+
/** @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. */
|
|
15472
|
+
singleton?: boolean;
|
|
15099
15473
|
};
|
|
15100
15474
|
};
|
|
15101
15475
|
};
|
|
@@ -15182,6 +15556,8 @@ export interface operations {
|
|
|
15182
15556
|
* ]
|
|
15183
15557
|
* },
|
|
15184
15558
|
* "pathTemplate": "/teachers/{slug}",
|
|
15559
|
+
* "previewUrlTemplate": null,
|
|
15560
|
+
* "singleton": false,
|
|
15185
15561
|
* "createdBy": {
|
|
15186
15562
|
* "kind": "agent",
|
|
15187
15563
|
* "actorId": "user_example01",
|
|
@@ -15215,6 +15591,8 @@ export interface operations {
|
|
|
15215
15591
|
aiHint?: string;
|
|
15216
15592
|
system?: boolean;
|
|
15217
15593
|
indexed?: boolean;
|
|
15594
|
+
/** @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. */
|
|
15595
|
+
localized?: boolean;
|
|
15218
15596
|
unique?: boolean;
|
|
15219
15597
|
/** @constant */
|
|
15220
15598
|
type: "text";
|
|
@@ -15222,7 +15600,6 @@ export interface operations {
|
|
|
15222
15600
|
max?: number;
|
|
15223
15601
|
pattern?: string;
|
|
15224
15602
|
default?: string;
|
|
15225
|
-
localized?: boolean;
|
|
15226
15603
|
} | {
|
|
15227
15604
|
id: string;
|
|
15228
15605
|
name: string;
|
|
@@ -15232,10 +15609,11 @@ export interface operations {
|
|
|
15232
15609
|
aiHint?: string;
|
|
15233
15610
|
system?: boolean;
|
|
15234
15611
|
indexed?: boolean;
|
|
15612
|
+
/** @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. */
|
|
15613
|
+
localized?: boolean;
|
|
15235
15614
|
/** @constant */
|
|
15236
15615
|
type: "rich_text";
|
|
15237
15616
|
max?: number;
|
|
15238
|
-
localized?: boolean;
|
|
15239
15617
|
} | {
|
|
15240
15618
|
id: string;
|
|
15241
15619
|
name: string;
|
|
@@ -15245,6 +15623,8 @@ export interface operations {
|
|
|
15245
15623
|
aiHint?: string;
|
|
15246
15624
|
system?: boolean;
|
|
15247
15625
|
indexed?: boolean;
|
|
15626
|
+
/** @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. */
|
|
15627
|
+
localized?: boolean;
|
|
15248
15628
|
unique?: boolean;
|
|
15249
15629
|
/** @constant */
|
|
15250
15630
|
type: "email";
|
|
@@ -15258,6 +15638,8 @@ export interface operations {
|
|
|
15258
15638
|
aiHint?: string;
|
|
15259
15639
|
system?: boolean;
|
|
15260
15640
|
indexed?: boolean;
|
|
15641
|
+
/** @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. */
|
|
15642
|
+
localized?: boolean;
|
|
15261
15643
|
unique?: boolean;
|
|
15262
15644
|
/** @constant */
|
|
15263
15645
|
type: "phone";
|
|
@@ -15271,6 +15653,8 @@ export interface operations {
|
|
|
15271
15653
|
aiHint?: string;
|
|
15272
15654
|
system?: boolean;
|
|
15273
15655
|
indexed?: boolean;
|
|
15656
|
+
/** @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. */
|
|
15657
|
+
localized?: boolean;
|
|
15274
15658
|
unique?: boolean;
|
|
15275
15659
|
/** @constant */
|
|
15276
15660
|
type: "url";
|
|
@@ -15284,6 +15668,8 @@ export interface operations {
|
|
|
15284
15668
|
aiHint?: string;
|
|
15285
15669
|
system?: boolean;
|
|
15286
15670
|
indexed?: boolean;
|
|
15671
|
+
/** @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. */
|
|
15672
|
+
localized?: boolean;
|
|
15287
15673
|
/** @constant */
|
|
15288
15674
|
type: "video_url";
|
|
15289
15675
|
} | {
|
|
@@ -15295,6 +15681,8 @@ export interface operations {
|
|
|
15295
15681
|
aiHint?: string;
|
|
15296
15682
|
system?: boolean;
|
|
15297
15683
|
indexed?: boolean;
|
|
15684
|
+
/** @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. */
|
|
15685
|
+
localized?: boolean;
|
|
15298
15686
|
unique?: boolean;
|
|
15299
15687
|
/** @constant */
|
|
15300
15688
|
type: "number";
|
|
@@ -15311,6 +15699,8 @@ export interface operations {
|
|
|
15311
15699
|
aiHint?: string;
|
|
15312
15700
|
system?: boolean;
|
|
15313
15701
|
indexed?: boolean;
|
|
15702
|
+
/** @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. */
|
|
15703
|
+
localized?: boolean;
|
|
15314
15704
|
/** @constant */
|
|
15315
15705
|
type: "boolean";
|
|
15316
15706
|
default?: boolean;
|
|
@@ -15323,6 +15713,8 @@ export interface operations {
|
|
|
15323
15713
|
aiHint?: string;
|
|
15324
15714
|
system?: boolean;
|
|
15325
15715
|
indexed?: boolean;
|
|
15716
|
+
/** @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. */
|
|
15717
|
+
localized?: boolean;
|
|
15326
15718
|
/** @constant */
|
|
15327
15719
|
type: "date";
|
|
15328
15720
|
min?: string;
|
|
@@ -15337,6 +15729,8 @@ export interface operations {
|
|
|
15337
15729
|
aiHint?: string;
|
|
15338
15730
|
system?: boolean;
|
|
15339
15731
|
indexed?: boolean;
|
|
15732
|
+
/** @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. */
|
|
15733
|
+
localized?: boolean;
|
|
15340
15734
|
/** @constant */
|
|
15341
15735
|
type: "datetime";
|
|
15342
15736
|
min?: string;
|
|
@@ -15351,6 +15745,8 @@ export interface operations {
|
|
|
15351
15745
|
aiHint?: string;
|
|
15352
15746
|
system?: boolean;
|
|
15353
15747
|
indexed?: boolean;
|
|
15748
|
+
/** @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. */
|
|
15749
|
+
localized?: boolean;
|
|
15354
15750
|
/** @constant */
|
|
15355
15751
|
type: "select";
|
|
15356
15752
|
options: {
|
|
@@ -15368,6 +15764,8 @@ export interface operations {
|
|
|
15368
15764
|
aiHint?: string;
|
|
15369
15765
|
system?: boolean;
|
|
15370
15766
|
indexed?: boolean;
|
|
15767
|
+
/** @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. */
|
|
15768
|
+
localized?: boolean;
|
|
15371
15769
|
/** @constant */
|
|
15372
15770
|
type: "multi_select";
|
|
15373
15771
|
options: {
|
|
@@ -15387,6 +15785,8 @@ export interface operations {
|
|
|
15387
15785
|
aiHint?: string;
|
|
15388
15786
|
system?: boolean;
|
|
15389
15787
|
indexed?: boolean;
|
|
15788
|
+
/** @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. */
|
|
15789
|
+
localized?: boolean;
|
|
15390
15790
|
/** @constant */
|
|
15391
15791
|
type: "color";
|
|
15392
15792
|
default?: string;
|
|
@@ -15399,6 +15799,8 @@ export interface operations {
|
|
|
15399
15799
|
aiHint?: string;
|
|
15400
15800
|
system?: boolean;
|
|
15401
15801
|
indexed?: boolean;
|
|
15802
|
+
/** @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. */
|
|
15803
|
+
localized?: boolean;
|
|
15402
15804
|
/** @constant */
|
|
15403
15805
|
type: "image";
|
|
15404
15806
|
} | {
|
|
@@ -15410,6 +15812,8 @@ export interface operations {
|
|
|
15410
15812
|
aiHint?: string;
|
|
15411
15813
|
system?: boolean;
|
|
15412
15814
|
indexed?: boolean;
|
|
15815
|
+
/** @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. */
|
|
15816
|
+
localized?: boolean;
|
|
15413
15817
|
/** @constant */
|
|
15414
15818
|
type: "gallery";
|
|
15415
15819
|
min?: number;
|
|
@@ -15423,6 +15827,8 @@ export interface operations {
|
|
|
15423
15827
|
aiHint?: string;
|
|
15424
15828
|
system?: boolean;
|
|
15425
15829
|
indexed?: boolean;
|
|
15830
|
+
/** @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. */
|
|
15831
|
+
localized?: boolean;
|
|
15426
15832
|
/** @constant */
|
|
15427
15833
|
type: "file";
|
|
15428
15834
|
} | {
|
|
@@ -15434,6 +15840,8 @@ export interface operations {
|
|
|
15434
15840
|
aiHint?: string;
|
|
15435
15841
|
system?: boolean;
|
|
15436
15842
|
indexed?: boolean;
|
|
15843
|
+
/** @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. */
|
|
15844
|
+
localized?: boolean;
|
|
15437
15845
|
/** @constant */
|
|
15438
15846
|
type: "reference";
|
|
15439
15847
|
targetCollectionKey: string;
|
|
@@ -15446,6 +15854,8 @@ export interface operations {
|
|
|
15446
15854
|
aiHint?: string;
|
|
15447
15855
|
system?: boolean;
|
|
15448
15856
|
indexed?: boolean;
|
|
15857
|
+
/** @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. */
|
|
15858
|
+
localized?: boolean;
|
|
15449
15859
|
/** @constant */
|
|
15450
15860
|
type: "multi_reference";
|
|
15451
15861
|
targetCollectionKey: string;
|
|
@@ -15460,8 +15870,14 @@ export interface operations {
|
|
|
15460
15870
|
aiHint?: string;
|
|
15461
15871
|
system?: boolean;
|
|
15462
15872
|
indexed?: boolean;
|
|
15873
|
+
/** @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. */
|
|
15874
|
+
localized?: boolean;
|
|
15463
15875
|
/** @constant */
|
|
15464
15876
|
type: "json";
|
|
15877
|
+
/** @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. */
|
|
15878
|
+
schema?: {
|
|
15879
|
+
[key: string]: unknown;
|
|
15880
|
+
};
|
|
15465
15881
|
})[];
|
|
15466
15882
|
titleFieldId: string;
|
|
15467
15883
|
/** @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 +15900,10 @@ export interface operations {
|
|
|
15484
15900
|
} | null;
|
|
15485
15901
|
/** @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
15902
|
pathTemplate: string | null;
|
|
15903
|
+
/** @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. */
|
|
15904
|
+
previewUrlTemplate: string | null;
|
|
15905
|
+
/** @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. */
|
|
15906
|
+
singleton: boolean;
|
|
15487
15907
|
createdBy: {
|
|
15488
15908
|
/** @enum {string} */
|
|
15489
15909
|
kind: "agent" | "user";
|
|
@@ -15501,6 +15921,7 @@ export interface operations {
|
|
|
15501
15921
|
401: components["responses"]["Error401"];
|
|
15502
15922
|
403: components["responses"]["Error403"];
|
|
15503
15923
|
404: components["responses"]["Error404"];
|
|
15924
|
+
409: components["responses"]["Error409"];
|
|
15504
15925
|
422: components["responses"]["Error422"];
|
|
15505
15926
|
429: components["responses"]["Error429"];
|
|
15506
15927
|
500: components["responses"]["Error500"];
|
|
@@ -15591,6 +16012,16 @@ export interface operations {
|
|
|
15591
16012
|
* "website": "https://amychen.example.com",
|
|
15592
16013
|
* "course": "item_example02"
|
|
15593
16014
|
* },
|
|
16015
|
+
* "imageAlt": {
|
|
16016
|
+
* "avatar": {
|
|
16017
|
+
* "asset_example01": "Amy Chen at the whiteboard in a geometry class"
|
|
16018
|
+
* }
|
|
16019
|
+
* },
|
|
16020
|
+
* "publishedImageAlt": {
|
|
16021
|
+
* "avatar": {
|
|
16022
|
+
* "asset_example01": "Amy Chen at the whiteboard in a geometry class"
|
|
16023
|
+
* }
|
|
16024
|
+
* },
|
|
15594
16025
|
* "publishedSlug": "amy-chen",
|
|
15595
16026
|
* "publishedAt": "2026-10-06T08:00:00.000Z",
|
|
15596
16027
|
* "sortOrder": 0,
|
|
@@ -15626,6 +16057,18 @@ export interface operations {
|
|
|
15626
16057
|
publishedFieldData: {
|
|
15627
16058
|
[key: string]: unknown;
|
|
15628
16059
|
} | null;
|
|
16060
|
+
/** @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. */
|
|
16061
|
+
imageAlt: {
|
|
16062
|
+
[key: string]: {
|
|
16063
|
+
[key: string]: string;
|
|
16064
|
+
};
|
|
16065
|
+
};
|
|
16066
|
+
/** @description The same for the published version; null when never published. */
|
|
16067
|
+
publishedImageAlt: {
|
|
16068
|
+
[key: string]: {
|
|
16069
|
+
[key: string]: string;
|
|
16070
|
+
};
|
|
16071
|
+
} | null;
|
|
15629
16072
|
publishedSlug: string | null;
|
|
15630
16073
|
publishedAt: string | null;
|
|
15631
16074
|
sortOrder: number;
|
|
@@ -15688,6 +16131,11 @@ export interface operations {
|
|
|
15688
16131
|
* "website": "https://amychen.example.com",
|
|
15689
16132
|
* "course": "item_example02"
|
|
15690
16133
|
* },
|
|
16134
|
+
* "imageAlt": {
|
|
16135
|
+
* "avatar": {
|
|
16136
|
+
* "asset_example01": "Amy Chen at the whiteboard in a geometry class"
|
|
16137
|
+
* }
|
|
16138
|
+
* },
|
|
15691
16139
|
* "publish": true
|
|
15692
16140
|
* }
|
|
15693
16141
|
*/
|
|
@@ -15696,6 +16144,12 @@ export interface operations {
|
|
|
15696
16144
|
fieldData: {
|
|
15697
16145
|
[key: string]: unknown;
|
|
15698
16146
|
};
|
|
16147
|
+
/** @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. */
|
|
16148
|
+
imageAlt?: {
|
|
16149
|
+
[key: string]: {
|
|
16150
|
+
[key: string]: string | null;
|
|
16151
|
+
};
|
|
16152
|
+
};
|
|
15699
16153
|
slug?: string;
|
|
15700
16154
|
/** @description Default true: the write is published immediately. false keeps it as a draft (status draft or changed). */
|
|
15701
16155
|
publish?: boolean;
|
|
@@ -15738,6 +16192,16 @@ export interface operations {
|
|
|
15738
16192
|
* "website": "https://amychen.example.com",
|
|
15739
16193
|
* "course": "item_example02"
|
|
15740
16194
|
* },
|
|
16195
|
+
* "imageAlt": {
|
|
16196
|
+
* "avatar": {
|
|
16197
|
+
* "asset_example01": "Amy Chen at the whiteboard in a geometry class"
|
|
16198
|
+
* }
|
|
16199
|
+
* },
|
|
16200
|
+
* "publishedImageAlt": {
|
|
16201
|
+
* "avatar": {
|
|
16202
|
+
* "asset_example01": "Amy Chen at the whiteboard in a geometry class"
|
|
16203
|
+
* }
|
|
16204
|
+
* },
|
|
15741
16205
|
* "publishedSlug": "amy-chen",
|
|
15742
16206
|
* "publishedAt": "2026-10-06T08:00:00.000Z",
|
|
15743
16207
|
* "sortOrder": 0,
|
|
@@ -15768,6 +16232,18 @@ export interface operations {
|
|
|
15768
16232
|
publishedFieldData: {
|
|
15769
16233
|
[key: string]: unknown;
|
|
15770
16234
|
} | null;
|
|
16235
|
+
/** @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. */
|
|
16236
|
+
imageAlt: {
|
|
16237
|
+
[key: string]: {
|
|
16238
|
+
[key: string]: string;
|
|
16239
|
+
};
|
|
16240
|
+
};
|
|
16241
|
+
/** @description The same for the published version; null when never published. */
|
|
16242
|
+
publishedImageAlt: {
|
|
16243
|
+
[key: string]: {
|
|
16244
|
+
[key: string]: string;
|
|
16245
|
+
};
|
|
16246
|
+
} | null;
|
|
15771
16247
|
publishedSlug: string | null;
|
|
15772
16248
|
publishedAt: string | null;
|
|
15773
16249
|
sortOrder: number;
|
|
@@ -15799,7 +16275,10 @@ export interface operations {
|
|
|
15799
16275
|
items_bulk_create: {
|
|
15800
16276
|
parameters: {
|
|
15801
16277
|
query?: never;
|
|
15802
|
-
header?:
|
|
16278
|
+
header?: {
|
|
16279
|
+
/** @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. */
|
|
16280
|
+
"Idempotency-Key"?: string;
|
|
16281
|
+
};
|
|
15803
16282
|
path: {
|
|
15804
16283
|
/** @description Website id. Get it from sites.list or from sites.create. */
|
|
15805
16284
|
id: string;
|
|
@@ -15844,6 +16323,12 @@ export interface operations {
|
|
|
15844
16323
|
fieldData: {
|
|
15845
16324
|
[key: string]: unknown;
|
|
15846
16325
|
};
|
|
16326
|
+
/** @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. */
|
|
16327
|
+
imageAlt?: {
|
|
16328
|
+
[key: string]: {
|
|
16329
|
+
[key: string]: string | null;
|
|
16330
|
+
};
|
|
16331
|
+
};
|
|
15847
16332
|
slug?: string;
|
|
15848
16333
|
}[];
|
|
15849
16334
|
/** @description Default true: the write is published immediately. false keeps it as a draft (status draft or changed). */
|
|
@@ -15889,6 +16374,16 @@ export interface operations {
|
|
|
15889
16374
|
* "website": "https://amychen.example.com",
|
|
15890
16375
|
* "course": "item_example02"
|
|
15891
16376
|
* },
|
|
16377
|
+
* "imageAlt": {
|
|
16378
|
+
* "avatar": {
|
|
16379
|
+
* "asset_example01": "Amy Chen at the whiteboard in a geometry class"
|
|
16380
|
+
* }
|
|
16381
|
+
* },
|
|
16382
|
+
* "publishedImageAlt": {
|
|
16383
|
+
* "avatar": {
|
|
16384
|
+
* "asset_example01": "Amy Chen at the whiteboard in a geometry class"
|
|
16385
|
+
* }
|
|
16386
|
+
* },
|
|
15892
16387
|
* "publishedSlug": "amy-chen",
|
|
15893
16388
|
* "publishedAt": "2026-10-06T08:00:00.000Z",
|
|
15894
16389
|
* "sortOrder": 0,
|
|
@@ -15918,6 +16413,8 @@ export interface operations {
|
|
|
15918
16413
|
* "english"
|
|
15919
16414
|
* ]
|
|
15920
16415
|
* },
|
|
16416
|
+
* "imageAlt": {},
|
|
16417
|
+
* "publishedImageAlt": {},
|
|
15921
16418
|
* "publishedSlug": "ben-lin",
|
|
15922
16419
|
* "publishedAt": "2026-10-06T08:00:00.000Z",
|
|
15923
16420
|
* "sortOrder": 1,
|
|
@@ -15952,6 +16449,18 @@ export interface operations {
|
|
|
15952
16449
|
publishedFieldData: {
|
|
15953
16450
|
[key: string]: unknown;
|
|
15954
16451
|
} | null;
|
|
16452
|
+
/** @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. */
|
|
16453
|
+
imageAlt: {
|
|
16454
|
+
[key: string]: {
|
|
16455
|
+
[key: string]: string;
|
|
16456
|
+
};
|
|
16457
|
+
};
|
|
16458
|
+
/** @description The same for the published version; null when never published. */
|
|
16459
|
+
publishedImageAlt: {
|
|
16460
|
+
[key: string]: {
|
|
16461
|
+
[key: string]: string;
|
|
16462
|
+
};
|
|
16463
|
+
} | null;
|
|
15955
16464
|
publishedSlug: string | null;
|
|
15956
16465
|
publishedAt: string | null;
|
|
15957
16466
|
sortOrder: number;
|
|
@@ -15968,6 +16477,7 @@ export interface operations {
|
|
|
15968
16477
|
/** @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
16478
|
scheduledAt: string | null;
|
|
15970
16479
|
}[];
|
|
16480
|
+
/** @description Always empty: a batch with a failing entry is rejected with VALIDATION and details.failed. */
|
|
15971
16481
|
failed: {
|
|
15972
16482
|
index: number;
|
|
15973
16483
|
error: {
|
|
@@ -16031,6 +16541,12 @@ export interface operations {
|
|
|
16031
16541
|
fieldData: {
|
|
16032
16542
|
[key: string]: unknown;
|
|
16033
16543
|
};
|
|
16544
|
+
/** @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. */
|
|
16545
|
+
imageAlt?: {
|
|
16546
|
+
[key: string]: {
|
|
16547
|
+
[key: string]: string | null;
|
|
16548
|
+
};
|
|
16549
|
+
};
|
|
16034
16550
|
slug?: string;
|
|
16035
16551
|
/**
|
|
16036
16552
|
* Format: date-time
|
|
@@ -16079,6 +16595,16 @@ export interface operations {
|
|
|
16079
16595
|
* "website": "https://amychen.example.com",
|
|
16080
16596
|
* "course": "item_example02"
|
|
16081
16597
|
* },
|
|
16598
|
+
* "imageAlt": {
|
|
16599
|
+
* "avatar": {
|
|
16600
|
+
* "asset_example01": "Amy Chen at the whiteboard in a geometry class"
|
|
16601
|
+
* }
|
|
16602
|
+
* },
|
|
16603
|
+
* "publishedImageAlt": {
|
|
16604
|
+
* "avatar": {
|
|
16605
|
+
* "asset_example01": "Amy Chen at the whiteboard in a geometry class"
|
|
16606
|
+
* }
|
|
16607
|
+
* },
|
|
16082
16608
|
* "publishedSlug": "amy-chen",
|
|
16083
16609
|
* "publishedAt": "2026-10-06T08:00:00.000Z",
|
|
16084
16610
|
* "sortOrder": 0,
|
|
@@ -16114,6 +16640,18 @@ export interface operations {
|
|
|
16114
16640
|
publishedFieldData: {
|
|
16115
16641
|
[key: string]: unknown;
|
|
16116
16642
|
} | null;
|
|
16643
|
+
/** @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. */
|
|
16644
|
+
imageAlt: {
|
|
16645
|
+
[key: string]: {
|
|
16646
|
+
[key: string]: string;
|
|
16647
|
+
};
|
|
16648
|
+
};
|
|
16649
|
+
/** @description The same for the published version; null when never published. */
|
|
16650
|
+
publishedImageAlt: {
|
|
16651
|
+
[key: string]: {
|
|
16652
|
+
[key: string]: string;
|
|
16653
|
+
};
|
|
16654
|
+
} | null;
|
|
16117
16655
|
publishedSlug: string | null;
|
|
16118
16656
|
publishedAt: string | null;
|
|
16119
16657
|
sortOrder: number;
|
|
@@ -16130,6 +16668,7 @@ export interface operations {
|
|
|
16130
16668
|
/** @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
16669
|
scheduledAt: string | null;
|
|
16132
16670
|
}[];
|
|
16671
|
+
/** @description Always empty: a batch with a failing entry is rejected with VALIDATION and details.failed. */
|
|
16133
16672
|
failed: {
|
|
16134
16673
|
index: number;
|
|
16135
16674
|
error: {
|
|
@@ -16225,6 +16764,16 @@ export interface operations {
|
|
|
16225
16764
|
* "website": "https://amychen.example.com",
|
|
16226
16765
|
* "course": "item_example02"
|
|
16227
16766
|
* },
|
|
16767
|
+
* "imageAlt": {
|
|
16768
|
+
* "avatar": {
|
|
16769
|
+
* "asset_example01": "Amy Chen at the whiteboard in a geometry class"
|
|
16770
|
+
* }
|
|
16771
|
+
* },
|
|
16772
|
+
* "publishedImageAlt": {
|
|
16773
|
+
* "avatar": {
|
|
16774
|
+
* "asset_example01": "Amy Chen at the whiteboard in a geometry class"
|
|
16775
|
+
* }
|
|
16776
|
+
* },
|
|
16228
16777
|
* "publishedSlug": "amy-chen",
|
|
16229
16778
|
* "publishedAt": "2026-10-06T08:00:00.000Z",
|
|
16230
16779
|
* "sortOrder": 0,
|
|
@@ -16260,6 +16809,18 @@ export interface operations {
|
|
|
16260
16809
|
publishedFieldData: {
|
|
16261
16810
|
[key: string]: unknown;
|
|
16262
16811
|
} | null;
|
|
16812
|
+
/** @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. */
|
|
16813
|
+
imageAlt: {
|
|
16814
|
+
[key: string]: {
|
|
16815
|
+
[key: string]: string;
|
|
16816
|
+
};
|
|
16817
|
+
};
|
|
16818
|
+
/** @description The same for the published version; null when never published. */
|
|
16819
|
+
publishedImageAlt: {
|
|
16820
|
+
[key: string]: {
|
|
16821
|
+
[key: string]: string;
|
|
16822
|
+
};
|
|
16823
|
+
} | null;
|
|
16263
16824
|
publishedSlug: string | null;
|
|
16264
16825
|
publishedAt: string | null;
|
|
16265
16826
|
sortOrder: number;
|
|
@@ -16346,6 +16907,12 @@ export interface operations {
|
|
|
16346
16907
|
* "course": "item_example02"
|
|
16347
16908
|
* },
|
|
16348
16909
|
* "publishedFieldData": null,
|
|
16910
|
+
* "imageAlt": {
|
|
16911
|
+
* "avatar": {
|
|
16912
|
+
* "asset_example01": "Amy Chen at the whiteboard in a geometry class"
|
|
16913
|
+
* }
|
|
16914
|
+
* },
|
|
16915
|
+
* "publishedImageAlt": null,
|
|
16349
16916
|
* "publishedSlug": null,
|
|
16350
16917
|
* "publishedAt": null,
|
|
16351
16918
|
* "sortOrder": 0,
|
|
@@ -16380,6 +16947,18 @@ export interface operations {
|
|
|
16380
16947
|
publishedFieldData: {
|
|
16381
16948
|
[key: string]: unknown;
|
|
16382
16949
|
} | null;
|
|
16950
|
+
/** @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. */
|
|
16951
|
+
imageAlt: {
|
|
16952
|
+
[key: string]: {
|
|
16953
|
+
[key: string]: string;
|
|
16954
|
+
};
|
|
16955
|
+
};
|
|
16956
|
+
/** @description The same for the published version; null when never published. */
|
|
16957
|
+
publishedImageAlt: {
|
|
16958
|
+
[key: string]: {
|
|
16959
|
+
[key: string]: string;
|
|
16960
|
+
};
|
|
16961
|
+
} | null;
|
|
16383
16962
|
publishedSlug: string | null;
|
|
16384
16963
|
publishedAt: string | null;
|
|
16385
16964
|
sortOrder: number;
|
|
@@ -16451,6 +17030,8 @@ export interface operations {
|
|
|
16451
17030
|
* ]
|
|
16452
17031
|
* },
|
|
16453
17032
|
* "publishedFieldData": null,
|
|
17033
|
+
* "imageAlt": {},
|
|
17034
|
+
* "publishedImageAlt": null,
|
|
16454
17035
|
* "publishedSlug": null,
|
|
16455
17036
|
* "publishedAt": null,
|
|
16456
17037
|
* "sortOrder": 0,
|
|
@@ -16486,6 +17067,18 @@ export interface operations {
|
|
|
16486
17067
|
publishedFieldData: {
|
|
16487
17068
|
[key: string]: unknown;
|
|
16488
17069
|
} | null;
|
|
17070
|
+
/** @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. */
|
|
17071
|
+
imageAlt: {
|
|
17072
|
+
[key: string]: {
|
|
17073
|
+
[key: string]: string;
|
|
17074
|
+
};
|
|
17075
|
+
};
|
|
17076
|
+
/** @description The same for the published version; null when never published. */
|
|
17077
|
+
publishedImageAlt: {
|
|
17078
|
+
[key: string]: {
|
|
17079
|
+
[key: string]: string;
|
|
17080
|
+
};
|
|
17081
|
+
} | null;
|
|
16489
17082
|
publishedSlug: string | null;
|
|
16490
17083
|
publishedAt: string | null;
|
|
16491
17084
|
sortOrder: number;
|
|
@@ -16569,6 +17162,16 @@ export interface operations {
|
|
|
16569
17162
|
* "website": "https://amychen.example.com",
|
|
16570
17163
|
* "course": "item_example02"
|
|
16571
17164
|
* },
|
|
17165
|
+
* "imageAlt": {
|
|
17166
|
+
* "avatar": {
|
|
17167
|
+
* "asset_example01": "Amy Chen at the whiteboard in a geometry class"
|
|
17168
|
+
* }
|
|
17169
|
+
* },
|
|
17170
|
+
* "publishedImageAlt": {
|
|
17171
|
+
* "avatar": {
|
|
17172
|
+
* "asset_example01": "Amy Chen at the whiteboard in a geometry class"
|
|
17173
|
+
* }
|
|
17174
|
+
* },
|
|
16572
17175
|
* "publishedSlug": "amy-chen",
|
|
16573
17176
|
* "publishedAt": "2026-10-06T08:00:00.000Z",
|
|
16574
17177
|
* "sortOrder": 0,
|
|
@@ -16599,6 +17202,18 @@ export interface operations {
|
|
|
16599
17202
|
publishedFieldData: {
|
|
16600
17203
|
[key: string]: unknown;
|
|
16601
17204
|
} | null;
|
|
17205
|
+
/** @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. */
|
|
17206
|
+
imageAlt: {
|
|
17207
|
+
[key: string]: {
|
|
17208
|
+
[key: string]: string;
|
|
17209
|
+
};
|
|
17210
|
+
};
|
|
17211
|
+
/** @description The same for the published version; null when never published. */
|
|
17212
|
+
publishedImageAlt: {
|
|
17213
|
+
[key: string]: {
|
|
17214
|
+
[key: string]: string;
|
|
17215
|
+
};
|
|
17216
|
+
} | null;
|
|
16602
17217
|
publishedSlug: string | null;
|
|
16603
17218
|
publishedAt: string | null;
|
|
16604
17219
|
sortOrder: number;
|
|
@@ -16700,6 +17315,12 @@ export interface operations {
|
|
|
16700
17315
|
fieldData?: {
|
|
16701
17316
|
[key: string]: unknown;
|
|
16702
17317
|
};
|
|
17318
|
+
/** @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. */
|
|
17319
|
+
imageAlt?: {
|
|
17320
|
+
[key: string]: {
|
|
17321
|
+
[key: string]: string | null;
|
|
17322
|
+
};
|
|
17323
|
+
};
|
|
16703
17324
|
slug?: string;
|
|
16704
17325
|
sortOrder?: number;
|
|
16705
17326
|
/** @description Default true: the write is published immediately. false keeps it as a draft (status draft or changed). */
|
|
@@ -16748,6 +17369,16 @@ export interface operations {
|
|
|
16748
17369
|
* "website": "https://amychen.example.com",
|
|
16749
17370
|
* "course": "item_example02"
|
|
16750
17371
|
* },
|
|
17372
|
+
* "imageAlt": {
|
|
17373
|
+
* "avatar": {
|
|
17374
|
+
* "asset_example01": "Amy Chen at the whiteboard in a geometry class"
|
|
17375
|
+
* }
|
|
17376
|
+
* },
|
|
17377
|
+
* "publishedImageAlt": {
|
|
17378
|
+
* "avatar": {
|
|
17379
|
+
* "asset_example01": "Amy Chen at the whiteboard in a geometry class"
|
|
17380
|
+
* }
|
|
17381
|
+
* },
|
|
16751
17382
|
* "publishedSlug": "amy-chen",
|
|
16752
17383
|
* "publishedAt": "2026-10-06T08:00:00.000Z",
|
|
16753
17384
|
* "sortOrder": 0,
|
|
@@ -16779,6 +17410,18 @@ export interface operations {
|
|
|
16779
17410
|
publishedFieldData: {
|
|
16780
17411
|
[key: string]: unknown;
|
|
16781
17412
|
} | null;
|
|
17413
|
+
/** @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. */
|
|
17414
|
+
imageAlt: {
|
|
17415
|
+
[key: string]: {
|
|
17416
|
+
[key: string]: string;
|
|
17417
|
+
};
|
|
17418
|
+
};
|
|
17419
|
+
/** @description The same for the published version; null when never published. */
|
|
17420
|
+
publishedImageAlt: {
|
|
17421
|
+
[key: string]: {
|
|
17422
|
+
[key: string]: string;
|
|
17423
|
+
};
|
|
17424
|
+
} | null;
|
|
16782
17425
|
publishedSlug: string | null;
|
|
16783
17426
|
publishedAt: string | null;
|
|
16784
17427
|
sortOrder: number;
|
|
@@ -16844,6 +17487,8 @@ export interface operations {
|
|
|
16844
17487
|
* ]
|
|
16845
17488
|
* },
|
|
16846
17489
|
* "publishedFieldData": null,
|
|
17490
|
+
* "imageAlt": {},
|
|
17491
|
+
* "publishedImageAlt": null,
|
|
16847
17492
|
* "publishedSlug": null,
|
|
16848
17493
|
* "publishedAt": null,
|
|
16849
17494
|
* "sortOrder": 0,
|
|
@@ -16874,6 +17519,18 @@ export interface operations {
|
|
|
16874
17519
|
publishedFieldData: {
|
|
16875
17520
|
[key: string]: unknown;
|
|
16876
17521
|
} | null;
|
|
17522
|
+
/** @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. */
|
|
17523
|
+
imageAlt: {
|
|
17524
|
+
[key: string]: {
|
|
17525
|
+
[key: string]: string;
|
|
17526
|
+
};
|
|
17527
|
+
};
|
|
17528
|
+
/** @description The same for the published version; null when never published. */
|
|
17529
|
+
publishedImageAlt: {
|
|
17530
|
+
[key: string]: {
|
|
17531
|
+
[key: string]: string;
|
|
17532
|
+
};
|
|
17533
|
+
} | null;
|
|
16877
17534
|
publishedSlug: string | null;
|
|
16878
17535
|
publishedAt: string | null;
|
|
16879
17536
|
sortOrder: number;
|
|
@@ -16896,6 +17553,7 @@ export interface operations {
|
|
|
16896
17553
|
401: components["responses"]["Error401"];
|
|
16897
17554
|
403: components["responses"]["Error403"];
|
|
16898
17555
|
404: components["responses"]["Error404"];
|
|
17556
|
+
409: components["responses"]["Error409"];
|
|
16899
17557
|
422: components["responses"]["Error422"];
|
|
16900
17558
|
429: components["responses"]["Error429"];
|
|
16901
17559
|
500: components["responses"]["Error500"];
|
|
@@ -16995,6 +17653,16 @@ export interface operations {
|
|
|
16995
17653
|
* "website": "https://amychen.example.com",
|
|
16996
17654
|
* "course": "item_example02"
|
|
16997
17655
|
* },
|
|
17656
|
+
* "imageAlt": {
|
|
17657
|
+
* "avatar": {
|
|
17658
|
+
* "asset_example01": "Amy Chen at the whiteboard in a geometry class"
|
|
17659
|
+
* }
|
|
17660
|
+
* },
|
|
17661
|
+
* "publishedImageAlt": {
|
|
17662
|
+
* "avatar": {
|
|
17663
|
+
* "asset_example01": "Amy Chen at the whiteboard in a geometry class"
|
|
17664
|
+
* }
|
|
17665
|
+
* },
|
|
16998
17666
|
* "publishedSlug": "amy-chen",
|
|
16999
17667
|
* "publishedAt": "2026-10-06T08:00:00.000Z",
|
|
17000
17668
|
* "sortOrder": 0,
|
|
@@ -17025,6 +17693,18 @@ export interface operations {
|
|
|
17025
17693
|
publishedFieldData: {
|
|
17026
17694
|
[key: string]: unknown;
|
|
17027
17695
|
} | null;
|
|
17696
|
+
/** @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. */
|
|
17697
|
+
imageAlt: {
|
|
17698
|
+
[key: string]: {
|
|
17699
|
+
[key: string]: string;
|
|
17700
|
+
};
|
|
17701
|
+
};
|
|
17702
|
+
/** @description The same for the published version; null when never published. */
|
|
17703
|
+
publishedImageAlt: {
|
|
17704
|
+
[key: string]: {
|
|
17705
|
+
[key: string]: string;
|
|
17706
|
+
};
|
|
17707
|
+
} | null;
|
|
17028
17708
|
publishedSlug: string | null;
|
|
17029
17709
|
publishedAt: string | null;
|
|
17030
17710
|
sortOrder: number;
|
|
@@ -17114,6 +17794,16 @@ export interface operations {
|
|
|
17114
17794
|
* "website": "https://amychen.example.com",
|
|
17115
17795
|
* "course": "item_example02"
|
|
17116
17796
|
* },
|
|
17797
|
+
* "imageAlt": {
|
|
17798
|
+
* "avatar": {
|
|
17799
|
+
* "asset_example01": "Amy Chen at the whiteboard in a geometry class"
|
|
17800
|
+
* }
|
|
17801
|
+
* },
|
|
17802
|
+
* "publishedImageAlt": {
|
|
17803
|
+
* "avatar": {
|
|
17804
|
+
* "asset_example01": "Amy Chen at the whiteboard in a geometry class"
|
|
17805
|
+
* }
|
|
17806
|
+
* },
|
|
17117
17807
|
* "publishedSlug": "amy-chen",
|
|
17118
17808
|
* "publishedAt": "2026-10-06T08:00:00.000Z",
|
|
17119
17809
|
* "sortOrder": 0,
|
|
@@ -17144,6 +17834,18 @@ export interface operations {
|
|
|
17144
17834
|
publishedFieldData: {
|
|
17145
17835
|
[key: string]: unknown;
|
|
17146
17836
|
} | null;
|
|
17837
|
+
/** @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. */
|
|
17838
|
+
imageAlt: {
|
|
17839
|
+
[key: string]: {
|
|
17840
|
+
[key: string]: string;
|
|
17841
|
+
};
|
|
17842
|
+
};
|
|
17843
|
+
/** @description The same for the published version; null when never published. */
|
|
17844
|
+
publishedImageAlt: {
|
|
17845
|
+
[key: string]: {
|
|
17846
|
+
[key: string]: string;
|
|
17847
|
+
};
|
|
17848
|
+
} | null;
|
|
17147
17849
|
publishedSlug: string | null;
|
|
17148
17850
|
publishedAt: string | null;
|
|
17149
17851
|
sortOrder: number;
|
|
@@ -17222,6 +17924,16 @@ export interface operations {
|
|
|
17222
17924
|
* "website": "https://amychen.example.com",
|
|
17223
17925
|
* "course": "item_example02"
|
|
17224
17926
|
* },
|
|
17927
|
+
* "imageAlt": {
|
|
17928
|
+
* "avatar": {
|
|
17929
|
+
* "asset_example01": "Amy Chen at the whiteboard in a geometry class"
|
|
17930
|
+
* }
|
|
17931
|
+
* },
|
|
17932
|
+
* "publishedImageAlt": {
|
|
17933
|
+
* "avatar": {
|
|
17934
|
+
* "asset_example01": "Amy Chen at the whiteboard in a geometry class"
|
|
17935
|
+
* }
|
|
17936
|
+
* },
|
|
17225
17937
|
* "publishedSlug": "amy-chen",
|
|
17226
17938
|
* "publishedAt": "2026-10-06T08:00:00.000Z",
|
|
17227
17939
|
* "sortOrder": 0,
|
|
@@ -17252,6 +17964,18 @@ export interface operations {
|
|
|
17252
17964
|
publishedFieldData: {
|
|
17253
17965
|
[key: string]: unknown;
|
|
17254
17966
|
} | null;
|
|
17967
|
+
/** @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. */
|
|
17968
|
+
imageAlt: {
|
|
17969
|
+
[key: string]: {
|
|
17970
|
+
[key: string]: string;
|
|
17971
|
+
};
|
|
17972
|
+
};
|
|
17973
|
+
/** @description The same for the published version; null when never published. */
|
|
17974
|
+
publishedImageAlt: {
|
|
17975
|
+
[key: string]: {
|
|
17976
|
+
[key: string]: string;
|
|
17977
|
+
};
|
|
17978
|
+
} | null;
|
|
17255
17979
|
publishedSlug: string | null;
|
|
17256
17980
|
publishedAt: string | null;
|
|
17257
17981
|
sortOrder: number;
|
|
@@ -17792,7 +18516,7 @@ export interface operations {
|
|
|
17792
18516
|
checkedAt: string;
|
|
17793
18517
|
checks: {
|
|
17794
18518
|
/**
|
|
17795
|
-
* @description i18n_* checks appear only on multilingual sites
|
|
18519
|
+
* @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
18520
|
* @enum {string}
|
|
17797
18521
|
*/
|
|
17798
18522
|
id: "derivatives" | "jsonld" | "content" | "analytics" | "revalidate" | "indexnow" | "hosted_redirect" | "gsc" | "customer_auth" | "i18n_pages" | "i18n_alternates" | "i18n_files";
|
|
@@ -17900,7 +18624,7 @@ export interface operations {
|
|
|
17900
18624
|
filter?: {
|
|
17901
18625
|
/** @description Only deliver collections.* events for these collection keys. */
|
|
17902
18626
|
collectionKeys?: string[];
|
|
17903
|
-
/** @description Only deliver customers.form.submitted
|
|
18627
|
+
/** @description Only deliver form events (customers.form.submitted, forms.form.updated and forms.form.deleted) for these form IDs. */
|
|
17904
18628
|
formIds?: string[];
|
|
17905
18629
|
} | null;
|
|
17906
18630
|
recentDeliveries: {
|
|
@@ -17970,7 +18694,7 @@ export interface operations {
|
|
|
17970
18694
|
filter?: {
|
|
17971
18695
|
/** @description Only deliver collections.* events for these collection keys. */
|
|
17972
18696
|
collectionKeys?: string[];
|
|
17973
|
-
/** @description Only deliver customers.form.submitted
|
|
18697
|
+
/** @description Only deliver form events (customers.form.submitted, forms.form.updated and forms.form.deleted) for these form IDs. */
|
|
17974
18698
|
formIds?: string[];
|
|
17975
18699
|
} | null;
|
|
17976
18700
|
};
|
|
@@ -18003,7 +18727,7 @@ export interface operations {
|
|
|
18003
18727
|
filter?: {
|
|
18004
18728
|
/** @description Only deliver collections.* events for these collection keys. */
|
|
18005
18729
|
collectionKeys?: string[];
|
|
18006
|
-
/** @description Only deliver customers.form.submitted
|
|
18730
|
+
/** @description Only deliver form events (customers.form.submitted, forms.form.updated and forms.form.deleted) for these form IDs. */
|
|
18007
18731
|
formIds?: string[];
|
|
18008
18732
|
} | null;
|
|
18009
18733
|
};
|
|
@@ -18051,7 +18775,7 @@ export interface operations {
|
|
|
18051
18775
|
filter?: {
|
|
18052
18776
|
/** @description Only deliver collections.* events for these collection keys. */
|
|
18053
18777
|
collectionKeys?: string[];
|
|
18054
|
-
/** @description Only deliver customers.form.submitted
|
|
18778
|
+
/** @description Only deliver form events (customers.form.submitted, forms.form.updated and forms.form.deleted) for these form IDs. */
|
|
18055
18779
|
formIds?: string[];
|
|
18056
18780
|
} | null;
|
|
18057
18781
|
};
|
|
@@ -18084,7 +18808,7 @@ export interface operations {
|
|
|
18084
18808
|
filter?: {
|
|
18085
18809
|
/** @description Only deliver collections.* events for these collection keys. */
|
|
18086
18810
|
collectionKeys?: string[];
|
|
18087
|
-
/** @description Only deliver customers.form.submitted
|
|
18811
|
+
/** @description Only deliver form events (customers.form.submitted, forms.form.updated and forms.form.deleted) for these form IDs. */
|
|
18088
18812
|
formIds?: string[];
|
|
18089
18813
|
} | null;
|
|
18090
18814
|
};
|
|
@@ -18320,9 +19044,11 @@ export interface operations {
|
|
|
18320
19044
|
locale: string;
|
|
18321
19045
|
/** @description Default true. */
|
|
18322
19046
|
autoTranslate?: boolean;
|
|
19047
|
+
/** @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. */
|
|
19048
|
+
publishWhenTranslated?: boolean;
|
|
18323
19049
|
/** @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
19050
|
pathPrefix?: string;
|
|
18325
|
-
/** @description Must be true: with autoTranslate the whole site is translated and the locale goes live when done. */
|
|
19051
|
+
/** @description Must be true: with autoTranslate the whole site is translated (and, unless publishWhenTranslated is false, the locale goes live when done). */
|
|
18326
19052
|
confirm: boolean;
|
|
18327
19053
|
};
|
|
18328
19054
|
};
|
|
@@ -18678,10 +19404,10 @@ export interface operations {
|
|
|
18678
19404
|
parameters: {
|
|
18679
19405
|
query: {
|
|
18680
19406
|
/**
|
|
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).
|
|
19407
|
+
* @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
19408
|
* @example product
|
|
18683
19409
|
*/
|
|
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";
|
|
19410
|
+
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
19411
|
/** @description Only this record. */
|
|
18686
19412
|
entityId?: string;
|
|
18687
19413
|
/**
|
|
@@ -18769,6 +19495,110 @@ export interface operations {
|
|
|
18769
19495
|
503: components["responses"]["Error503"];
|
|
18770
19496
|
};
|
|
18771
19497
|
};
|
|
19498
|
+
localization_translations_pending: {
|
|
19499
|
+
parameters: {
|
|
19500
|
+
query: {
|
|
19501
|
+
/**
|
|
19502
|
+
* @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).
|
|
19503
|
+
* @example product
|
|
19504
|
+
*/
|
|
19505
|
+
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";
|
|
19506
|
+
/**
|
|
19507
|
+
* @description A secondary locale of the website.
|
|
19508
|
+
* @example fr-FR
|
|
19509
|
+
*/
|
|
19510
|
+
locale: string;
|
|
19511
|
+
/** @description Only fields in this state; omit for both. */
|
|
19512
|
+
state?: "missing" | "outdated";
|
|
19513
|
+
/** @description Maximum number of items to return, 1–50. Defaults to 20. */
|
|
19514
|
+
limit?: number;
|
|
19515
|
+
/** @description Opaque cursor from the previous page's nextCursor. Omit for the first page. */
|
|
19516
|
+
cursor?: string;
|
|
19517
|
+
};
|
|
19518
|
+
header?: never;
|
|
19519
|
+
path: {
|
|
19520
|
+
/** @description Website id. Get it from sites.list or from sites.create. */
|
|
19521
|
+
id: string;
|
|
19522
|
+
};
|
|
19523
|
+
cookie?: never;
|
|
19524
|
+
};
|
|
19525
|
+
requestBody?: never;
|
|
19526
|
+
responses: {
|
|
19527
|
+
/** @description OK */
|
|
19528
|
+
200: {
|
|
19529
|
+
headers: {
|
|
19530
|
+
[name: string]: unknown;
|
|
19531
|
+
};
|
|
19532
|
+
content: {
|
|
19533
|
+
/**
|
|
19534
|
+
* @example {
|
|
19535
|
+
* "data": [
|
|
19536
|
+
* {
|
|
19537
|
+
* "entityId": "prod_example01",
|
|
19538
|
+
* "label": "Country Sourdough",
|
|
19539
|
+
* "sourceHash": "c1a0e6f2b47d93e8",
|
|
19540
|
+
* "translationStatus": "PUBLISHED",
|
|
19541
|
+
* "fields": [
|
|
19542
|
+
* {
|
|
19543
|
+
* "path": "description",
|
|
19544
|
+
* "value": "Slow-fermented for 48 hours with **stone-ground** whole wheat.",
|
|
19545
|
+
* "profile": "body",
|
|
19546
|
+
* "sourceHash": "0b7c44d2",
|
|
19547
|
+
* "status": "outdated"
|
|
19548
|
+
* }
|
|
19549
|
+
* ]
|
|
19550
|
+
* }
|
|
19551
|
+
* ],
|
|
19552
|
+
* "hasMore": false,
|
|
19553
|
+
* "nextCursor": null
|
|
19554
|
+
* }
|
|
19555
|
+
*/
|
|
19556
|
+
"application/json": {
|
|
19557
|
+
data: {
|
|
19558
|
+
/** @description Record id (the websiteId for global_sections, site_settings and store_settings). */
|
|
19559
|
+
entityId: string;
|
|
19560
|
+
/** @description The record's name for people (page or post title, item title, form name…). */
|
|
19561
|
+
label: string;
|
|
19562
|
+
/** @description Fingerprint of all of the record's source fields: pass it as sourceHash to localization.translations.upsert. */
|
|
19563
|
+
sourceHash: string;
|
|
19564
|
+
/** @description This locale's translation row; null when nothing has been translated yet. */
|
|
19565
|
+
translationStatus: ("DRAFT" | "PUBLISHED") | null;
|
|
19566
|
+
/** @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). */
|
|
19567
|
+
fields: {
|
|
19568
|
+
/** @description Field path to use as a key in fieldData (array indexes and section ids already filled in). */
|
|
19569
|
+
path: string;
|
|
19570
|
+
/** @description Current source text in the primary locale (editable draft). For profile json, the field's whole value as JSON text. */
|
|
19571
|
+
value: string;
|
|
19572
|
+
/**
|
|
19573
|
+
* @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.
|
|
19574
|
+
* @enum {string}
|
|
19575
|
+
*/
|
|
19576
|
+
profile: "plain" | "inline" | "body" | "article" | "email" | "json";
|
|
19577
|
+
sourceHash: string;
|
|
19578
|
+
/**
|
|
19579
|
+
* @description missing = no translation yet; current = translated from this exact source; outdated = the source changed after it was translated.
|
|
19580
|
+
* @enum {string}
|
|
19581
|
+
*/
|
|
19582
|
+
status: "missing" | "current" | "outdated";
|
|
19583
|
+
}[];
|
|
19584
|
+
}[];
|
|
19585
|
+
/** @description True when another page exists; pass nextCursor to fetch it. */
|
|
19586
|
+
hasMore: boolean;
|
|
19587
|
+
/** @description Cursor for the next page, or null on the last page. */
|
|
19588
|
+
nextCursor: string | null;
|
|
19589
|
+
};
|
|
19590
|
+
};
|
|
19591
|
+
};
|
|
19592
|
+
400: components["responses"]["Error400"];
|
|
19593
|
+
401: components["responses"]["Error401"];
|
|
19594
|
+
403: components["responses"]["Error403"];
|
|
19595
|
+
404: components["responses"]["Error404"];
|
|
19596
|
+
422: components["responses"]["Error422"];
|
|
19597
|
+
429: components["responses"]["Error429"];
|
|
19598
|
+
500: components["responses"]["Error500"];
|
|
19599
|
+
503: components["responses"]["Error503"];
|
|
19600
|
+
};
|
|
19601
|
+
};
|
|
18772
19602
|
localization_translations_get: {
|
|
18773
19603
|
parameters: {
|
|
18774
19604
|
query?: never;
|
|
@@ -18776,7 +19606,7 @@ export interface operations {
|
|
|
18776
19606
|
path: {
|
|
18777
19607
|
/** @description Website id. Get it from sites.list or from sites.create. */
|
|
18778
19608
|
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). */
|
|
19609
|
+
/** @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
19610
|
entityType: string;
|
|
18781
19611
|
/** @description Record id. Required except for global_sections and site_settings, whose id is the websiteId. */
|
|
18782
19612
|
entityId: string;
|
|
@@ -18901,13 +19731,13 @@ export interface operations {
|
|
|
18901
19731
|
fields: {
|
|
18902
19732
|
/** @description Field path to use as a key in fieldData (array indexes and section ids already filled in). */
|
|
18903
19733
|
path: string;
|
|
18904
|
-
/** @description Current source text in the primary locale (editable draft). */
|
|
19734
|
+
/** @description Current source text in the primary locale (editable draft). For profile json, the field's whole value as JSON text. */
|
|
18905
19735
|
value: string;
|
|
18906
19736
|
/**
|
|
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.
|
|
19737
|
+
* @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
19738
|
* @enum {string}
|
|
18909
19739
|
*/
|
|
18910
|
-
profile: "plain" | "inline" | "body" | "article" | "email";
|
|
19740
|
+
profile: "plain" | "inline" | "body" | "article" | "email" | "json";
|
|
18911
19741
|
sourceHash: string;
|
|
18912
19742
|
/**
|
|
18913
19743
|
* @description missing = no translation yet; current = translated from this exact source; outdated = the source changed after it was translated.
|
|
@@ -18936,7 +19766,7 @@ export interface operations {
|
|
|
18936
19766
|
path: {
|
|
18937
19767
|
/** @description Website id. Get it from sites.list or from sites.create. */
|
|
18938
19768
|
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). */
|
|
19769
|
+
/** @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
19770
|
entityType: string;
|
|
18941
19771
|
/** @description Record id. Required except for global_sections and site_settings, whose id is the websiteId. */
|
|
18942
19772
|
entityId: string;
|
|
@@ -18958,7 +19788,7 @@ export interface operations {
|
|
|
18958
19788
|
*/
|
|
18959
19789
|
"application/json": {
|
|
18960
19790
|
/**
|
|
18961
|
-
* @description Field path → translated text, keeping the source's Markdown for inline / body / article fields. May be empty when only slug changes.
|
|
19791
|
+
* @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
19792
|
* @default {}
|
|
18963
19793
|
*/
|
|
18964
19794
|
fieldData?: {
|
|
@@ -19084,7 +19914,7 @@ export interface operations {
|
|
|
19084
19914
|
path: {
|
|
19085
19915
|
/** @description Website id. Get it from sites.list or from sites.create. */
|
|
19086
19916
|
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). */
|
|
19917
|
+
/** @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
19918
|
entityType: string;
|
|
19089
19919
|
/** @description Record id. Required except for global_sections and site_settings, whose id is the websiteId. */
|
|
19090
19920
|
entityId: string;
|
|
@@ -19128,7 +19958,7 @@ export interface operations {
|
|
|
19128
19958
|
path: {
|
|
19129
19959
|
/** @description Website id. Get it from sites.list or from sites.create. */
|
|
19130
19960
|
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). */
|
|
19961
|
+
/** @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
19962
|
entityType: string;
|
|
19133
19963
|
/** @description Record id. Required except for global_sections and site_settings, whose id is the websiteId. */
|
|
19134
19964
|
entityId: string;
|
|
@@ -19229,6 +20059,7 @@ export interface operations {
|
|
|
19229
20059
|
401: components["responses"]["Error401"];
|
|
19230
20060
|
403: components["responses"]["Error403"];
|
|
19231
20061
|
404: components["responses"]["Error404"];
|
|
20062
|
+
409: components["responses"]["Error409"];
|
|
19232
20063
|
429: components["responses"]["Error429"];
|
|
19233
20064
|
500: components["responses"]["Error500"];
|
|
19234
20065
|
503: components["responses"]["Error503"];
|
|
@@ -19241,7 +20072,7 @@ export interface operations {
|
|
|
19241
20072
|
path: {
|
|
19242
20073
|
/** @description Website id. Get it from sites.list or from sites.create. */
|
|
19243
20074
|
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). */
|
|
20075
|
+
/** @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
20076
|
entityType: string;
|
|
19246
20077
|
/** @description Record id. Required except for global_sections and site_settings, whose id is the websiteId. */
|
|
19247
20078
|
entityId: string;
|
|
@@ -19406,6 +20237,7 @@ export interface operations {
|
|
|
19406
20237
|
* },
|
|
19407
20238
|
* "errorCode": null,
|
|
19408
20239
|
* "resumeAt": null,
|
|
20240
|
+
* "refreshMachineTranslations": false,
|
|
19409
20241
|
* "createdAt": "2026-10-06T08:00:00.000Z",
|
|
19410
20242
|
* "completedAt": null
|
|
19411
20243
|
* },
|
|
@@ -19426,6 +20258,7 @@ export interface operations {
|
|
|
19426
20258
|
* },
|
|
19427
20259
|
* "errorCode": null,
|
|
19428
20260
|
* "resumeAt": null,
|
|
20261
|
+
* "refreshMachineTranslations": false,
|
|
19429
20262
|
* "createdAt": "2026-10-06T08:00:00.000Z",
|
|
19430
20263
|
* "completedAt": "2026-10-01T02:30:00.000Z"
|
|
19431
20264
|
* }
|
|
@@ -19467,6 +20300,8 @@ export interface operations {
|
|
|
19467
20300
|
/** @description CANCELLED when cancelled; otherwise the failure reason. */
|
|
19468
20301
|
errorCode: string | null;
|
|
19469
20302
|
resumeAt: string | null;
|
|
20303
|
+
/** @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). */
|
|
20304
|
+
refreshMachineTranslations: boolean;
|
|
19470
20305
|
createdAt: string;
|
|
19471
20306
|
completedAt: string | null;
|
|
19472
20307
|
}[];
|
|
@@ -19499,12 +20334,15 @@ export interface operations {
|
|
|
19499
20334
|
content: {
|
|
19500
20335
|
/**
|
|
19501
20336
|
* @example {
|
|
19502
|
-
* "locale": "de"
|
|
20337
|
+
* "locale": "de",
|
|
20338
|
+
* "refreshMachineTranslations": true
|
|
19503
20339
|
* }
|
|
19504
20340
|
*/
|
|
19505
20341
|
"application/json": {
|
|
19506
20342
|
/** @description BCP 47 locale code exactly as listed by localization.locales.list (e.g. en-US, ja, zh-Hant). */
|
|
19507
20343
|
locale: string;
|
|
20344
|
+
/** @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. */
|
|
20345
|
+
refreshMachineTranslations?: boolean;
|
|
19508
20346
|
};
|
|
19509
20347
|
};
|
|
19510
20348
|
};
|
|
@@ -19518,12 +20356,15 @@ export interface operations {
|
|
|
19518
20356
|
/**
|
|
19519
20357
|
* @example {
|
|
19520
20358
|
* "jobId": "ltj_example01",
|
|
19521
|
-
* "alreadyRunning": false
|
|
20359
|
+
* "alreadyRunning": false,
|
|
20360
|
+
* "refreshMachineTranslations": true
|
|
19522
20361
|
* }
|
|
19523
20362
|
*/
|
|
19524
20363
|
"application/json": {
|
|
19525
20364
|
jobId: string;
|
|
19526
20365
|
alreadyRunning: boolean;
|
|
20366
|
+
/** @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). */
|
|
20367
|
+
refreshMachineTranslations: boolean;
|
|
19527
20368
|
};
|
|
19528
20369
|
};
|
|
19529
20370
|
};
|
|
@@ -19575,6 +20416,7 @@ export interface operations {
|
|
|
19575
20416
|
* },
|
|
19576
20417
|
* "errorCode": null,
|
|
19577
20418
|
* "resumeAt": null,
|
|
20419
|
+
* "refreshMachineTranslations": false,
|
|
19578
20420
|
* "createdAt": "2026-10-06T08:00:00.000Z",
|
|
19579
20421
|
* "completedAt": null
|
|
19580
20422
|
* }
|
|
@@ -19613,6 +20455,8 @@ export interface operations {
|
|
|
19613
20455
|
/** @description CANCELLED when cancelled; otherwise the failure reason. */
|
|
19614
20456
|
errorCode: string | null;
|
|
19615
20457
|
resumeAt: string | null;
|
|
20458
|
+
/** @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). */
|
|
20459
|
+
refreshMachineTranslations: boolean;
|
|
19616
20460
|
createdAt: string;
|
|
19617
20461
|
completedAt: string | null;
|
|
19618
20462
|
};
|
|
@@ -19666,6 +20510,7 @@ export interface operations {
|
|
|
19666
20510
|
* },
|
|
19667
20511
|
* "errorCode": "CANCELLED",
|
|
19668
20512
|
* "resumeAt": null,
|
|
20513
|
+
* "refreshMachineTranslations": false,
|
|
19669
20514
|
* "createdAt": "2026-10-06T08:00:00.000Z",
|
|
19670
20515
|
* "completedAt": "2026-10-06T08:00:00.000Z"
|
|
19671
20516
|
* }
|
|
@@ -19704,6 +20549,8 @@ export interface operations {
|
|
|
19704
20549
|
/** @description CANCELLED when cancelled; otherwise the failure reason. */
|
|
19705
20550
|
errorCode: string | null;
|
|
19706
20551
|
resumeAt: string | null;
|
|
20552
|
+
/** @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). */
|
|
20553
|
+
refreshMachineTranslations: boolean;
|
|
19707
20554
|
createdAt: string;
|
|
19708
20555
|
completedAt: string | null;
|
|
19709
20556
|
};
|
|
@@ -19720,6 +20567,213 @@ export interface operations {
|
|
|
19720
20567
|
503: components["responses"]["Error503"];
|
|
19721
20568
|
};
|
|
19722
20569
|
};
|
|
20570
|
+
localization_glossary_list: {
|
|
20571
|
+
parameters: {
|
|
20572
|
+
query?: never;
|
|
20573
|
+
header?: never;
|
|
20574
|
+
path: {
|
|
20575
|
+
/** @description Website id. Get it from sites.list or from sites.create. */
|
|
20576
|
+
id: string;
|
|
20577
|
+
};
|
|
20578
|
+
cookie?: never;
|
|
20579
|
+
};
|
|
20580
|
+
requestBody?: never;
|
|
20581
|
+
responses: {
|
|
20582
|
+
/** @description OK */
|
|
20583
|
+
200: {
|
|
20584
|
+
headers: {
|
|
20585
|
+
[name: string]: unknown;
|
|
20586
|
+
};
|
|
20587
|
+
content: {
|
|
20588
|
+
/**
|
|
20589
|
+
* @example {
|
|
20590
|
+
* "data": [
|
|
20591
|
+
* {
|
|
20592
|
+
* "id": "lgt_example01",
|
|
20593
|
+
* "term": "Aurora Travel",
|
|
20594
|
+
* "doNotTranslate": true,
|
|
20595
|
+
* "translations": {},
|
|
20596
|
+
* "updatedAt": "2026-10-01T02:30:00.000Z"
|
|
20597
|
+
* },
|
|
20598
|
+
* {
|
|
20599
|
+
* "id": "lgt_example02",
|
|
20600
|
+
* "term": "Night Market Tour",
|
|
20601
|
+
* "doNotTranslate": false,
|
|
20602
|
+
* "translations": {
|
|
20603
|
+
* "fr-FR": "Visite du marché de nuit",
|
|
20604
|
+
* "de": "Nachtmarkt-Tour"
|
|
20605
|
+
* },
|
|
20606
|
+
* "updatedAt": "2026-10-06T08:00:00.000Z"
|
|
20607
|
+
* }
|
|
20608
|
+
* ],
|
|
20609
|
+
* "hasMore": false,
|
|
20610
|
+
* "nextCursor": null,
|
|
20611
|
+
* "max": 200
|
|
20612
|
+
* }
|
|
20613
|
+
*/
|
|
20614
|
+
"application/json": {
|
|
20615
|
+
data: {
|
|
20616
|
+
id: string;
|
|
20617
|
+
/** @description The term as written in the primary language. */
|
|
20618
|
+
term: string;
|
|
20619
|
+
/** @description true: machine translation keeps it as written in every language. */
|
|
20620
|
+
doNotTranslate: boolean;
|
|
20621
|
+
/** @description Locale code → the wording machine translation uses for this term. Empty when doNotTranslate is true. */
|
|
20622
|
+
translations: {
|
|
20623
|
+
[key: string]: string;
|
|
20624
|
+
};
|
|
20625
|
+
/** @description ISO 8601. */
|
|
20626
|
+
updatedAt: string;
|
|
20627
|
+
}[];
|
|
20628
|
+
/** @description True when another page exists; pass nextCursor to fetch it. */
|
|
20629
|
+
hasMore: boolean;
|
|
20630
|
+
/** @description Cursor for the next page, or null on the last page. */
|
|
20631
|
+
nextCursor: string | null;
|
|
20632
|
+
/** @description Most terms a glossary can hold. */
|
|
20633
|
+
max: number;
|
|
20634
|
+
};
|
|
20635
|
+
};
|
|
20636
|
+
};
|
|
20637
|
+
400: components["responses"]["Error400"];
|
|
20638
|
+
401: components["responses"]["Error401"];
|
|
20639
|
+
403: components["responses"]["Error403"];
|
|
20640
|
+
404: components["responses"]["Error404"];
|
|
20641
|
+
429: components["responses"]["Error429"];
|
|
20642
|
+
500: components["responses"]["Error500"];
|
|
20643
|
+
503: components["responses"]["Error503"];
|
|
20644
|
+
};
|
|
20645
|
+
};
|
|
20646
|
+
localization_glossary_upsert: {
|
|
20647
|
+
parameters: {
|
|
20648
|
+
query?: never;
|
|
20649
|
+
header?: never;
|
|
20650
|
+
path: {
|
|
20651
|
+
/** @description Website id. Get it from sites.list or from sites.create. */
|
|
20652
|
+
id: string;
|
|
20653
|
+
};
|
|
20654
|
+
cookie?: never;
|
|
20655
|
+
};
|
|
20656
|
+
requestBody: {
|
|
20657
|
+
content: {
|
|
20658
|
+
/**
|
|
20659
|
+
* @example {
|
|
20660
|
+
* "term": "Night Market Tour",
|
|
20661
|
+
* "translations": {
|
|
20662
|
+
* "fr-FR": "Visite du marché de nuit",
|
|
20663
|
+
* "de": "Nachtmarkt-Tour"
|
|
20664
|
+
* }
|
|
20665
|
+
* }
|
|
20666
|
+
*/
|
|
20667
|
+
"application/json": {
|
|
20668
|
+
/** @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. */
|
|
20669
|
+
term: string;
|
|
20670
|
+
/**
|
|
20671
|
+
* @description true: keep the term as written in every language (brand and product names). translations must then be empty.
|
|
20672
|
+
* @default false
|
|
20673
|
+
*/
|
|
20674
|
+
doNotTranslate?: boolean;
|
|
20675
|
+
/**
|
|
20676
|
+
* @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.
|
|
20677
|
+
* @default {}
|
|
20678
|
+
*/
|
|
20679
|
+
translations?: {
|
|
20680
|
+
[key: string]: string;
|
|
20681
|
+
};
|
|
20682
|
+
};
|
|
20683
|
+
};
|
|
20684
|
+
};
|
|
20685
|
+
responses: {
|
|
20686
|
+
/** @description OK */
|
|
20687
|
+
200: {
|
|
20688
|
+
headers: {
|
|
20689
|
+
[name: string]: unknown;
|
|
20690
|
+
};
|
|
20691
|
+
content: {
|
|
20692
|
+
/**
|
|
20693
|
+
* @example {
|
|
20694
|
+
* "term": {
|
|
20695
|
+
* "id": "lgt_example02",
|
|
20696
|
+
* "term": "Night Market Tour",
|
|
20697
|
+
* "doNotTranslate": false,
|
|
20698
|
+
* "translations": {
|
|
20699
|
+
* "fr-FR": "Visite du marché de nuit",
|
|
20700
|
+
* "de": "Nachtmarkt-Tour"
|
|
20701
|
+
* },
|
|
20702
|
+
* "updatedAt": "2026-10-06T08:00:00.000Z"
|
|
20703
|
+
* },
|
|
20704
|
+
* "created": true
|
|
20705
|
+
* }
|
|
20706
|
+
*/
|
|
20707
|
+
"application/json": {
|
|
20708
|
+
term: {
|
|
20709
|
+
id: string;
|
|
20710
|
+
/** @description The term as written in the primary language. */
|
|
20711
|
+
term: string;
|
|
20712
|
+
/** @description true: machine translation keeps it as written in every language. */
|
|
20713
|
+
doNotTranslate: boolean;
|
|
20714
|
+
/** @description Locale code → the wording machine translation uses for this term. Empty when doNotTranslate is true. */
|
|
20715
|
+
translations: {
|
|
20716
|
+
[key: string]: string;
|
|
20717
|
+
};
|
|
20718
|
+
/** @description ISO 8601. */
|
|
20719
|
+
updatedAt: string;
|
|
20720
|
+
};
|
|
20721
|
+
/** @description false when an existing term with the same wording was replaced. */
|
|
20722
|
+
created: boolean;
|
|
20723
|
+
};
|
|
20724
|
+
};
|
|
20725
|
+
};
|
|
20726
|
+
400: components["responses"]["Error400"];
|
|
20727
|
+
401: components["responses"]["Error401"];
|
|
20728
|
+
403: components["responses"]["Error403"];
|
|
20729
|
+
429: components["responses"]["Error429"];
|
|
20730
|
+
500: components["responses"]["Error500"];
|
|
20731
|
+
503: components["responses"]["Error503"];
|
|
20732
|
+
};
|
|
20733
|
+
};
|
|
20734
|
+
localization_glossary_delete: {
|
|
20735
|
+
parameters: {
|
|
20736
|
+
query?: never;
|
|
20737
|
+
header?: never;
|
|
20738
|
+
path: {
|
|
20739
|
+
/** @description Website id. Get it from sites.list or from sites.create. */
|
|
20740
|
+
id: string;
|
|
20741
|
+
/** @description Glossary term id from localization.glossary.list. */
|
|
20742
|
+
termId: string;
|
|
20743
|
+
};
|
|
20744
|
+
cookie?: never;
|
|
20745
|
+
};
|
|
20746
|
+
requestBody?: never;
|
|
20747
|
+
responses: {
|
|
20748
|
+
/** @description OK */
|
|
20749
|
+
200: {
|
|
20750
|
+
headers: {
|
|
20751
|
+
[name: string]: unknown;
|
|
20752
|
+
};
|
|
20753
|
+
content: {
|
|
20754
|
+
/**
|
|
20755
|
+
* @example {
|
|
20756
|
+
* "deleted": true,
|
|
20757
|
+
* "term": "Night Market Tour"
|
|
20758
|
+
* }
|
|
20759
|
+
*/
|
|
20760
|
+
"application/json": {
|
|
20761
|
+
/** @constant */
|
|
20762
|
+
deleted: true;
|
|
20763
|
+
/** @description The wording of the deleted term. */
|
|
20764
|
+
term: string;
|
|
20765
|
+
};
|
|
20766
|
+
};
|
|
20767
|
+
};
|
|
20768
|
+
400: components["responses"]["Error400"];
|
|
20769
|
+
401: components["responses"]["Error401"];
|
|
20770
|
+
403: components["responses"]["Error403"];
|
|
20771
|
+
404: components["responses"]["Error404"];
|
|
20772
|
+
429: components["responses"]["Error429"];
|
|
20773
|
+
500: components["responses"]["Error500"];
|
|
20774
|
+
503: components["responses"]["Error503"];
|
|
20775
|
+
};
|
|
20776
|
+
};
|
|
19723
20777
|
forms_list: {
|
|
19724
20778
|
parameters: {
|
|
19725
20779
|
query?: {
|
|
@@ -19880,7 +20934,7 @@ export interface operations {
|
|
|
19880
20934
|
fields: {
|
|
19881
20935
|
[key: string]: unknown;
|
|
19882
20936
|
}[];
|
|
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 (
|
|
20937
|
+
/** @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
20938
|
settings?: {
|
|
19885
20939
|
[key: string]: unknown;
|
|
19886
20940
|
};
|
|
@@ -20250,7 +21304,7 @@ export interface operations {
|
|
|
20250
21304
|
fields?: {
|
|
20251
21305
|
[key: string]: unknown;
|
|
20252
21306
|
}[];
|
|
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 (
|
|
21307
|
+
/** @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
21308
|
settings?: {
|
|
20255
21309
|
[key: string]: unknown;
|
|
20256
21310
|
};
|
|
@@ -28388,6 +29442,10 @@ export interface operations {
|
|
|
28388
29442
|
edgeColor: string | null;
|
|
28389
29443
|
/** @description Default alt text, used when the place that shows the image has no alt of its own. */
|
|
28390
29444
|
altText: string | null;
|
|
29445
|
+
/** @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[]. */
|
|
29446
|
+
credit: string | null;
|
|
29447
|
+
/** @description Where the file came from (the stock photo's page, the original source); filled automatically by media.import_stock. Public like credit. */
|
|
29448
|
+
sourceUrl: string | null;
|
|
28391
29449
|
/** @description true when the owner excluded this image from the site watermark. */
|
|
28392
29450
|
watermarkExempt: boolean;
|
|
28393
29451
|
createdAt: string;
|
|
@@ -28556,6 +29614,10 @@ export interface operations {
|
|
|
28556
29614
|
edgeColor: string | null;
|
|
28557
29615
|
/** @description Default alt text, used when the place that shows the image has no alt of its own. */
|
|
28558
29616
|
altText: string | null;
|
|
29617
|
+
/** @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[]. */
|
|
29618
|
+
credit: string | null;
|
|
29619
|
+
/** @description Where the file came from (the stock photo's page, the original source); filled automatically by media.import_stock. Public like credit. */
|
|
29620
|
+
sourceUrl: string | null;
|
|
28559
29621
|
/** @description true when the owner excluded this image from the site watermark. */
|
|
28560
29622
|
watermarkExempt: boolean;
|
|
28561
29623
|
createdAt: string;
|
|
@@ -33431,7 +34493,7 @@ export interface operations {
|
|
|
33431
34493
|
unusedOnly?: boolean | ("true" | "false");
|
|
33432
34494
|
/** @description Include broken asset records where the original file no longer exists on storage (defaults to false). */
|
|
33433
34495
|
includeMissing?: boolean | ("true" | "false");
|
|
33434
|
-
/** @description Part of the file name. */
|
|
34496
|
+
/** @description Part of the file name, default alt text or credit (case-insensitive). */
|
|
33435
34497
|
search?: string;
|
|
33436
34498
|
/** @description newest (default), oldest or largest. */
|
|
33437
34499
|
sort?: "newest" | "oldest" | "largest";
|
|
@@ -33483,6 +34545,8 @@ export interface operations {
|
|
|
33483
34545
|
* "focus": null,
|
|
33484
34546
|
* "edgeColor": null,
|
|
33485
34547
|
* "altText": null,
|
|
34548
|
+
* "credit": null,
|
|
34549
|
+
* "sourceUrl": null,
|
|
33486
34550
|
* "watermarkExempt": false,
|
|
33487
34551
|
* "createdAt": "2026-10-01T02:30:00.000Z"
|
|
33488
34552
|
* }
|
|
@@ -33566,6 +34630,10 @@ export interface operations {
|
|
|
33566
34630
|
edgeColor: string | null;
|
|
33567
34631
|
/** @description Default alt text, used when the place that shows the image has no alt of its own. */
|
|
33568
34632
|
altText: string | null;
|
|
34633
|
+
/** @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[]. */
|
|
34634
|
+
credit: string | null;
|
|
34635
|
+
/** @description Where the file came from (the stock photo's page, the original source); filled automatically by media.import_stock. Public like credit. */
|
|
34636
|
+
sourceUrl: string | null;
|
|
33569
34637
|
/** @description true when the owner excluded this image from the site watermark. */
|
|
33570
34638
|
watermarkExempt: boolean;
|
|
33571
34639
|
createdAt: string;
|
|
@@ -33602,7 +34670,10 @@ export interface operations {
|
|
|
33602
34670
|
media_upload: {
|
|
33603
34671
|
parameters: {
|
|
33604
34672
|
query?: never;
|
|
33605
|
-
header?:
|
|
34673
|
+
header?: {
|
|
34674
|
+
/** @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. */
|
|
34675
|
+
"Idempotency-Key"?: string;
|
|
34676
|
+
};
|
|
33606
34677
|
path: {
|
|
33607
34678
|
/** @description Website id. Get it from sites.list or from sites.create. */
|
|
33608
34679
|
id: string;
|
|
@@ -33624,7 +34695,7 @@ export interface operations {
|
|
|
33624
34695
|
* @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
34696
|
*/
|
|
33626
34697
|
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).
|
|
34698
|
+
/** @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
34699
|
fileName?: string;
|
|
33629
34700
|
/**
|
|
33630
34701
|
* @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 +34704,14 @@ export interface operations {
|
|
|
33633
34704
|
visibility?: "public" | "protected";
|
|
33634
34705
|
/** @description Hint for bookkeeping (images only): content (default), blog, product, favicon. */
|
|
33635
34706
|
usage?: string;
|
|
34707
|
+
/** @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). */
|
|
34708
|
+
altText?: string;
|
|
34709
|
+
/** @description Tags for the media library, any file (same rules as media.update tags). */
|
|
34710
|
+
tags?: string[];
|
|
34711
|
+
/** @description Credit line, any file: photographer or rights holder, for example "Jane Doe / Example Studio". Public in the Content Delivery API (assets[].credit). */
|
|
34712
|
+
credit?: string;
|
|
34713
|
+
/** @description Where the file came from (http or https), any file. Public in the Content Delivery API (assets[].sourceUrl). */
|
|
34714
|
+
sourceUrl?: string;
|
|
33636
34715
|
};
|
|
33637
34716
|
};
|
|
33638
34717
|
};
|
|
@@ -33670,6 +34749,8 @@ export interface operations {
|
|
|
33670
34749
|
* "focus": null,
|
|
33671
34750
|
* "edgeColor": null,
|
|
33672
34751
|
* "altText": null,
|
|
34752
|
+
* "credit": null,
|
|
34753
|
+
* "sourceUrl": null,
|
|
33673
34754
|
* "watermarkExempt": false,
|
|
33674
34755
|
* "createdAt": "2026-10-06T08:00:00.000Z"
|
|
33675
34756
|
* }
|
|
@@ -33742,6 +34823,10 @@ export interface operations {
|
|
|
33742
34823
|
edgeColor: string | null;
|
|
33743
34824
|
/** @description Default alt text, used when the place that shows the image has no alt of its own. */
|
|
33744
34825
|
altText: string | null;
|
|
34826
|
+
/** @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[]. */
|
|
34827
|
+
credit: string | null;
|
|
34828
|
+
/** @description Where the file came from (the stock photo's page, the original source); filled automatically by media.import_stock. Public like credit. */
|
|
34829
|
+
sourceUrl: string | null;
|
|
33745
34830
|
/** @description true when the owner excluded this image from the site watermark. */
|
|
33746
34831
|
watermarkExempt: boolean;
|
|
33747
34832
|
createdAt: string;
|
|
@@ -33778,7 +34863,7 @@ export interface operations {
|
|
|
33778
34863
|
* }
|
|
33779
34864
|
*/
|
|
33780
34865
|
"application/json": {
|
|
33781
|
-
/** @description File name with extension; the extension decides the format. */
|
|
34866
|
+
/** @description File name with extension; the extension decides the format. No slashes or control characters (same rules as media.update). */
|
|
33782
34867
|
fileName: string;
|
|
33783
34868
|
/** @description Exact size in bytes; the upload must match it. */
|
|
33784
34869
|
fileSize: number;
|
|
@@ -33899,6 +34984,8 @@ export interface operations {
|
|
|
33899
34984
|
* "focus": null,
|
|
33900
34985
|
* "edgeColor": null,
|
|
33901
34986
|
* "altText": null,
|
|
34987
|
+
* "credit": null,
|
|
34988
|
+
* "sourceUrl": null,
|
|
33902
34989
|
* "watermarkExempt": false,
|
|
33903
34990
|
* "createdAt": "2026-10-06T08:00:00.000Z"
|
|
33904
34991
|
* }
|
|
@@ -33971,6 +35058,10 @@ export interface operations {
|
|
|
33971
35058
|
edgeColor: string | null;
|
|
33972
35059
|
/** @description Default alt text, used when the place that shows the image has no alt of its own. */
|
|
33973
35060
|
altText: string | null;
|
|
35061
|
+
/** @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[]. */
|
|
35062
|
+
credit: string | null;
|
|
35063
|
+
/** @description Where the file came from (the stock photo's page, the original source); filled automatically by media.import_stock. Public like credit. */
|
|
35064
|
+
sourceUrl: string | null;
|
|
33974
35065
|
/** @description true when the owner excluded this image from the site watermark. */
|
|
33975
35066
|
watermarkExempt: boolean;
|
|
33976
35067
|
createdAt: string;
|
|
@@ -34116,6 +35207,8 @@ export interface operations {
|
|
|
34116
35207
|
* "focus": null,
|
|
34117
35208
|
* "edgeColor": null,
|
|
34118
35209
|
* "altText": null,
|
|
35210
|
+
* "credit": null,
|
|
35211
|
+
* "sourceUrl": null,
|
|
34119
35212
|
* "watermarkExempt": false,
|
|
34120
35213
|
* "createdAt": "2026-10-06T08:00:00.000Z",
|
|
34121
35214
|
* "uploadedAt": "2026-10-06T08:00:00.000Z"
|
|
@@ -34145,6 +35238,8 @@ export interface operations {
|
|
|
34145
35238
|
* "focus": null,
|
|
34146
35239
|
* "edgeColor": null,
|
|
34147
35240
|
* "altText": null,
|
|
35241
|
+
* "credit": null,
|
|
35242
|
+
* "sourceUrl": null,
|
|
34148
35243
|
* "watermarkExempt": false,
|
|
34149
35244
|
* "createdAt": "2026-10-06T08:00:00.000Z",
|
|
34150
35245
|
* "uploadedAt": "2026-10-06T08:00:00.000Z"
|
|
@@ -34227,6 +35322,10 @@ export interface operations {
|
|
|
34227
35322
|
edgeColor: string | null;
|
|
34228
35323
|
/** @description Default alt text, used when the place that shows the image has no alt of its own. */
|
|
34229
35324
|
altText: string | null;
|
|
35325
|
+
/** @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[]. */
|
|
35326
|
+
credit: string | null;
|
|
35327
|
+
/** @description Where the file came from (the stock photo's page, the original source); filled automatically by media.import_stock. Public like credit. */
|
|
35328
|
+
sourceUrl: string | null;
|
|
34230
35329
|
/** @description true when the owner excluded this image from the site watermark. */
|
|
34231
35330
|
watermarkExempt: boolean;
|
|
34232
35331
|
createdAt: string;
|
|
@@ -34353,7 +35452,7 @@ export interface operations {
|
|
|
34353
35452
|
"application/json": {
|
|
34354
35453
|
/** @enum {string} */
|
|
34355
35454
|
provider: "pexels" | "pixabay";
|
|
34356
|
-
/** @description Stock photo id from the search result. */
|
|
35455
|
+
/** @description Stock photo id from the search result (digits). */
|
|
34357
35456
|
id: string;
|
|
34358
35457
|
/**
|
|
34359
35458
|
* Format: uri
|
|
@@ -34399,6 +35498,8 @@ export interface operations {
|
|
|
34399
35498
|
* "focus": null,
|
|
34400
35499
|
* "edgeColor": null,
|
|
34401
35500
|
* "altText": null,
|
|
35501
|
+
* "credit": null,
|
|
35502
|
+
* "sourceUrl": null,
|
|
34402
35503
|
* "watermarkExempt": false,
|
|
34403
35504
|
* "createdAt": "2026-10-06T08:00:00.000Z"
|
|
34404
35505
|
* }
|
|
@@ -34471,6 +35572,10 @@ export interface operations {
|
|
|
34471
35572
|
edgeColor: string | null;
|
|
34472
35573
|
/** @description Default alt text, used when the place that shows the image has no alt of its own. */
|
|
34473
35574
|
altText: string | null;
|
|
35575
|
+
/** @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[]. */
|
|
35576
|
+
credit: string | null;
|
|
35577
|
+
/** @description Where the file came from (the stock photo's page, the original source); filled automatically by media.import_stock. Public like credit. */
|
|
35578
|
+
sourceUrl: string | null;
|
|
34474
35579
|
/** @description true when the owner excluded this image from the site watermark. */
|
|
34475
35580
|
watermarkExempt: boolean;
|
|
34476
35581
|
createdAt: string;
|
|
@@ -34616,6 +35721,8 @@ export interface operations {
|
|
|
34616
35721
|
* "focus": null,
|
|
34617
35722
|
* "edgeColor": null,
|
|
34618
35723
|
* "altText": null,
|
|
35724
|
+
* "credit": null,
|
|
35725
|
+
* "sourceUrl": null,
|
|
34619
35726
|
* "watermarkExempt": false,
|
|
34620
35727
|
* "createdAt": "2026-10-01T02:30:00.000Z"
|
|
34621
35728
|
* },
|
|
@@ -34708,6 +35815,10 @@ export interface operations {
|
|
|
34708
35815
|
edgeColor: string | null;
|
|
34709
35816
|
/** @description Default alt text, used when the place that shows the image has no alt of its own. */
|
|
34710
35817
|
altText: string | null;
|
|
35818
|
+
/** @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[]. */
|
|
35819
|
+
credit: string | null;
|
|
35820
|
+
/** @description Where the file came from (the stock photo's page, the original source); filled automatically by media.import_stock. Public like credit. */
|
|
35821
|
+
sourceUrl: string | null;
|
|
34711
35822
|
/** @description true when the owner excluded this image from the site watermark. */
|
|
34712
35823
|
watermarkExempt: boolean;
|
|
34713
35824
|
createdAt: string;
|
|
@@ -34830,6 +35941,12 @@ export interface operations {
|
|
|
34830
35941
|
altText?: string | null;
|
|
34831
35942
|
/** @description Replaces the file's tags (any file). Up to 20 tags of 1-40 characters; no commas, line breaks or leading #. */
|
|
34832
35943
|
tags?: string[];
|
|
35944
|
+
/** @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. */
|
|
35945
|
+
fileName?: string;
|
|
35946
|
+
/** @description Credit line (any file), for example "Jane Doe / Example Studio"; null or an empty string clears it. */
|
|
35947
|
+
credit?: string | null;
|
|
35948
|
+
/** @description Where the file came from (any file), http or https; null or an empty string clears it. */
|
|
35949
|
+
sourceUrl?: string | null;
|
|
34833
35950
|
/**
|
|
34834
35951
|
* @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
35952
|
* @enum {string}
|
|
@@ -34882,6 +35999,8 @@ export interface operations {
|
|
|
34882
35999
|
* },
|
|
34883
36000
|
* "edgeColor": null,
|
|
34884
36001
|
* "altText": "Fresh croissants on the bakery counter",
|
|
36002
|
+
* "credit": null,
|
|
36003
|
+
* "sourceUrl": null,
|
|
34885
36004
|
* "watermarkExempt": false,
|
|
34886
36005
|
* "createdAt": "2026-10-01T02:30:00.000Z"
|
|
34887
36006
|
* }
|
|
@@ -34954,6 +36073,10 @@ export interface operations {
|
|
|
34954
36073
|
edgeColor: string | null;
|
|
34955
36074
|
/** @description Default alt text, used when the place that shows the image has no alt of its own. */
|
|
34956
36075
|
altText: string | null;
|
|
36076
|
+
/** @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[]. */
|
|
36077
|
+
credit: string | null;
|
|
36078
|
+
/** @description Where the file came from (the stock photo's page, the original source); filled automatically by media.import_stock. Public like credit. */
|
|
36079
|
+
sourceUrl: string | null;
|
|
34957
36080
|
/** @description true when the owner excluded this image from the site watermark. */
|
|
34958
36081
|
watermarkExempt: boolean;
|
|
34959
36082
|
createdAt: string;
|
|
@@ -35037,6 +36160,8 @@ export interface operations {
|
|
|
35037
36160
|
* "focus": null,
|
|
35038
36161
|
* "edgeColor": null,
|
|
35039
36162
|
* "altText": null,
|
|
36163
|
+
* "credit": null,
|
|
36164
|
+
* "sourceUrl": null,
|
|
35040
36165
|
* "watermarkExempt": false,
|
|
35041
36166
|
* "createdAt": "2026-10-01T02:30:00.000Z"
|
|
35042
36167
|
* },
|
|
@@ -35118,6 +36243,10 @@ export interface operations {
|
|
|
35118
36243
|
edgeColor: string | null;
|
|
35119
36244
|
/** @description Default alt text, used when the place that shows the image has no alt of its own. */
|
|
35120
36245
|
altText: string | null;
|
|
36246
|
+
/** @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[]. */
|
|
36247
|
+
credit: string | null;
|
|
36248
|
+
/** @description Where the file came from (the stock photo's page, the original source); filled automatically by media.import_stock. Public like credit. */
|
|
36249
|
+
sourceUrl: string | null;
|
|
35121
36250
|
/** @description true when the owner excluded this image from the site watermark. */
|
|
35122
36251
|
watermarkExempt: boolean;
|
|
35123
36252
|
createdAt: string;
|
|
@@ -36571,7 +37700,7 @@ export interface operations {
|
|
|
36571
37700
|
*/
|
|
36572
37701
|
status?: "draft" | "published" | "changed";
|
|
36573
37702
|
/**
|
|
36574
|
-
* @description Set when the system recorded this revision automatically: beforeDelete right before
|
|
37703
|
+
* @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
37704
|
* @enum {string}
|
|
36576
37705
|
*/
|
|
36577
37706
|
backup?: "beforeDelete" | "scheduled";
|
|
@@ -36781,7 +37910,7 @@ export interface operations {
|
|
|
36781
37910
|
*/
|
|
36782
37911
|
status?: "draft" | "published" | "changed";
|
|
36783
37912
|
/**
|
|
36784
|
-
* @description Set when the system recorded this revision automatically: beforeDelete right before
|
|
37913
|
+
* @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
37914
|
* @enum {string}
|
|
36786
37915
|
*/
|
|
36787
37916
|
backup?: "beforeDelete" | "scheduled";
|
|
@@ -36869,6 +37998,10 @@ export interface operations {
|
|
|
36869
37998
|
edgeColor: string | null;
|
|
36870
37999
|
/** @description Default alt text, used when the place that shows the image has no alt of its own. */
|
|
36871
38000
|
altText: string | null;
|
|
38001
|
+
/** @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[]. */
|
|
38002
|
+
credit: string | null;
|
|
38003
|
+
/** @description Where the file came from (the stock photo's page, the original source); filled automatically by media.import_stock. Public like credit. */
|
|
38004
|
+
sourceUrl: string | null;
|
|
36872
38005
|
/** @description true when the owner excluded this image from the site watermark. */
|
|
36873
38006
|
watermarkExempt: boolean;
|
|
36874
38007
|
createdAt: string;
|
|
@@ -38445,6 +39578,12 @@ export interface operations {
|
|
|
38445
39578
|
* "remainingBytes": 10736936107,
|
|
38446
39579
|
* "scope": "website"
|
|
38447
39580
|
* },
|
|
39581
|
+
* "contentItems": {
|
|
39582
|
+
* "used": 213,
|
|
39583
|
+
* "limit": 1000,
|
|
39584
|
+
* "remaining": 787,
|
|
39585
|
+
* "perCollectionLimit": 20000
|
|
39586
|
+
* },
|
|
38448
39587
|
* "counts": {
|
|
38449
39588
|
* "generalPages": 5,
|
|
38450
39589
|
* "visiblePages": 4,
|
|
@@ -38473,6 +39612,17 @@ export interface operations {
|
|
|
38473
39612
|
*/
|
|
38474
39613
|
scope: "website" | "account";
|
|
38475
39614
|
};
|
|
39615
|
+
/** @description The plan's content item quota, the same number the dashboard's usage page shows and the one item writes are checked against. */
|
|
39616
|
+
contentItems: {
|
|
39617
|
+
/** @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. */
|
|
39618
|
+
used: number;
|
|
39619
|
+
/** @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. */
|
|
39620
|
+
limit: number;
|
|
39621
|
+
/** @description limit minus used, never below 0. */
|
|
39622
|
+
remaining: number;
|
|
39623
|
+
/** @description Technical limit per collection, on any plan; a write past it fails with COLLECTION_ITEM_LIMIT_REACHED. */
|
|
39624
|
+
perCollectionLimit: number;
|
|
39625
|
+
};
|
|
38476
39626
|
counts: {
|
|
38477
39627
|
/** @description Total non-product pages. */
|
|
38478
39628
|
generalPages: number;
|