@relyio/sdk 0.14.0 → 0.16.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/CHANGELOG.md +59 -0
- package/dist/chunk-7BZW6XYJ.cjs +433 -0
- package/dist/chunk-CQHEG7QA.js +411 -0
- package/dist/{chunk-PCFTJLEP.js → chunk-DIZY6CKM.js} +2 -2
- package/dist/{chunk-X4KSS7PP.cjs → chunk-GHYB6IZK.cjs} +2 -2
- package/dist/{chunk-DBBZVZOS.js → chunk-NIUOPIIB.js} +413 -552
- package/dist/{chunk-GUPV2M3X.cjs → chunk-RLLZUFDB.cjs} +450 -585
- package/dist/client/index.cjs +4 -3
- package/dist/client/index.d.cts +3 -4
- package/dist/client/index.d.ts +3 -4
- package/dist/client/index.js +2 -1
- package/dist/{define-content-type-DOrZb_a_.d.ts → define-content-type-CAWSlgn0.d.ts} +579 -81
- package/dist/{define-content-type-BUZeWtpk.d.cts → define-content-type-LkI0rS2W.d.cts} +579 -81
- package/dist/{define-schema-5aHmsA8j.d.ts → define-schema-Dxu3RoHV.d.ts} +1 -1
- package/dist/{define-schema-nCfZeboB.d.cts → define-schema-wlsJOrnY.d.cts} +1 -1
- package/dist/{index-DOhFQbv7.d.ts → index-BH8JksfG.d.ts} +472 -179
- package/dist/{index-B97ZDj44.d.ts → index-CGtYxUuh.d.ts} +1 -1
- package/dist/{index-C-pcllqY.d.cts → index-CcHmRALk.d.cts} +1 -1
- package/dist/{index-DgVV5Nj7.d.cts → index-D80MXUkf.d.cts} +472 -179
- package/dist/index.cjs +96 -71
- package/dist/index.d.cts +26 -16
- package/dist/index.d.ts +26 -16
- package/dist/index.js +4 -3
- package/dist/markdown/index.cjs +10 -2
- package/dist/markdown/index.d.cts +12 -3
- package/dist/markdown/index.d.ts +12 -3
- package/dist/markdown/index.js +10 -2
- package/dist/preview/index.cjs +29 -0
- package/dist/preview/index.d.cts +117 -0
- package/dist/preview/index.d.ts +117 -0
- package/dist/preview/index.js +4 -0
- package/dist/rich-text/index.d.cts +2 -2
- package/dist/rich-text/index.d.ts +2 -2
- package/dist/schema/index.cjs +33 -33
- package/dist/schema/index.d.cts +3 -3
- package/dist/schema/index.d.ts +3 -3
- package/dist/schema/index.js +1 -1
- package/dist/types/index.d.cts +1 -1
- package/dist/types/index.d.ts +1 -1
- package/package.json +10 -4
|
@@ -439,6 +439,23 @@ interface paths {
|
|
|
439
439
|
patch?: never;
|
|
440
440
|
trace?: never;
|
|
441
441
|
};
|
|
442
|
+
'/v1/{contentType}/{id}/shared-versions/{versionNumber}/restore': {
|
|
443
|
+
parameters: {
|
|
444
|
+
query?: never;
|
|
445
|
+
header?: never;
|
|
446
|
+
path?: never;
|
|
447
|
+
cookie?: never;
|
|
448
|
+
};
|
|
449
|
+
get?: never;
|
|
450
|
+
put?: never;
|
|
451
|
+
/** Restore the untranslated fields from a version */
|
|
452
|
+
post: operations['restoreSharedEntryVersion'];
|
|
453
|
+
delete?: never;
|
|
454
|
+
options?: never;
|
|
455
|
+
head?: never;
|
|
456
|
+
patch?: never;
|
|
457
|
+
trace?: never;
|
|
458
|
+
};
|
|
442
459
|
'/v1/{contentType}/{id}/versions': {
|
|
443
460
|
parameters: {
|
|
444
461
|
query?: never;
|
|
@@ -1010,7 +1027,7 @@ interface components {
|
|
|
1010
1027
|
retriable?: boolean;
|
|
1011
1028
|
};
|
|
1012
1029
|
};
|
|
1013
|
-
/** @description An asset entry’s `urls`, sent beside its `file` once `file.status` is `ready`: an image’s `original` and `variants`, a file’s `original`, a video’s `playback`, `poster` and `
|
|
1030
|
+
/** @description An asset entry’s `urls`, sent beside its `file` once `file.status` is `ready`: an image’s `original` and `variants`, a file’s `original`, a video’s `playback`, `poster`, `download`, `captions`, `storyboard` and `storyboardSprite`. Every URL is on the delivery gateway; a protected or private asset’s carries a short-lived token minted for this request. */
|
|
1014
1031
|
AssetUrls: {
|
|
1015
1032
|
/** @description An image or a file: its original bytes. */
|
|
1016
1033
|
original?: string;
|
|
@@ -1024,6 +1041,14 @@ interface components {
|
|
|
1024
1041
|
poster?: string;
|
|
1025
1042
|
/** @description A video: its downloadable MP4, when enabled. */
|
|
1026
1043
|
download?: string;
|
|
1044
|
+
/** @description A video: each caption locale its type declares (`video.captions.requiredLocales`), mapped to that WebVTT track’s URL. */
|
|
1045
|
+
captions?: {
|
|
1046
|
+
[key: string]: string;
|
|
1047
|
+
};
|
|
1048
|
+
/** @description A video: its storyboard — the WebVTT thumbnail track for scrubbing previews — once enrichment found it available. */
|
|
1049
|
+
storyboard?: string;
|
|
1050
|
+
/** @description A video: the sprite sheet its storyboard’s cues address, beside `storyboard`. */
|
|
1051
|
+
storyboardSprite?: string;
|
|
1027
1052
|
};
|
|
1028
1053
|
/** @description One distinct value of the field, and the entry it was first found in. */
|
|
1029
1054
|
AutocompleteSuggestion: {
|
|
@@ -1068,9 +1093,60 @@ interface components {
|
|
|
1068
1093
|
/** @description Locale of the binding to delete */
|
|
1069
1094
|
locale?: string;
|
|
1070
1095
|
};
|
|
1071
|
-
/** @description One
|
|
1096
|
+
/** @description One version of a singleton or a settings group: the fields that locale stored when the version was written, and which version of which locale it is. */
|
|
1097
|
+
DocumentVersion: {
|
|
1098
|
+
/** @description The version’s own number, on `locale`’s counter. */
|
|
1099
|
+
version: number;
|
|
1100
|
+
/** @description That locale’s own fields, as stored when the version was written. */
|
|
1101
|
+
fields: {
|
|
1102
|
+
[key: string]: unknown;
|
|
1103
|
+
};
|
|
1104
|
+
/** @description The locale the version belongs to. */
|
|
1105
|
+
locale: string;
|
|
1106
|
+
/**
|
|
1107
|
+
* Format: date-time
|
|
1108
|
+
* @description When the version was published.
|
|
1109
|
+
*/
|
|
1110
|
+
publishedAt: string;
|
|
1111
|
+
/** @description Who wrote the version. */
|
|
1112
|
+
publishedBy: string;
|
|
1113
|
+
};
|
|
1114
|
+
/** @description A singleton’s or a settings group’s version history in one locale, newest first, and the version it is at now. */
|
|
1115
|
+
DocumentVersionHistory: {
|
|
1116
|
+
/** @description The listed locale’s own version counter, the number its `_metadata.version` reports when the document is read in that locale. A locale with nothing written of its own, or one the key cannot read, reports 0 and lists no versions. */
|
|
1117
|
+
currentVersion: number;
|
|
1118
|
+
/** @description The locale’s versions, newest first. */
|
|
1119
|
+
versions: components['schemas']['DocumentVersionRow'][];
|
|
1120
|
+
};
|
|
1121
|
+
/** @description One row of a singleton’s or a settings group’s version history: which version of which locale it is, who wrote it and when. The fields it stored are not listed; read one version for them. */
|
|
1122
|
+
DocumentVersionRow: {
|
|
1123
|
+
/** @description The version’s own number, on `locale`’s counter. */
|
|
1124
|
+
version: number;
|
|
1125
|
+
/** @description The locale the version belongs to. */
|
|
1126
|
+
locale: string;
|
|
1127
|
+
/**
|
|
1128
|
+
* Format: date-time
|
|
1129
|
+
* @description When the version was published.
|
|
1130
|
+
*/
|
|
1131
|
+
publishedAt: string;
|
|
1132
|
+
/** @description Who wrote the version. */
|
|
1133
|
+
publishedBy: string;
|
|
1134
|
+
};
|
|
1135
|
+
/** @description The entry, or a locale the write reaches, has unpublished changes made in the Studio, and a write through this API would land on top of them. Publish or discard the draft, then retry. */
|
|
1136
|
+
DraftExistsBlockage: {
|
|
1137
|
+
/** @enum {string} */
|
|
1138
|
+
kind: 'draft-exists';
|
|
1139
|
+
facts: Record<string, never>;
|
|
1140
|
+
};
|
|
1141
|
+
/** @description One entry: its fields at the top level, as the content type declares them, and `_metadata`. An asset entry also carries `file`, an `AssetFile`, and `urls`, an `AssetUrls`, once the file is ready. A read that asks for `children` also carries `_children`. */
|
|
1072
1142
|
Entry: {
|
|
1073
1143
|
_metadata: components['schemas']['EntryMetadata'];
|
|
1144
|
+
/** @description The entry’s first children, of every content type, to the depth the read asked for in `children`: `data` holds at most `page.limit` of them (`childrenLimit`), always from `page.offset` 0, and `page.total` counts the entry’s children, so more remain when the length of `data` is less than `page.total`. This block does not page: `GET /{contentType}/{id}/children` lists every child from its own first page, by its own cursor. For a key limited to some locales `page.total` is an upper bound, since it still counts children past `page.limit` that hold none of the key’s locales. Present only on a read that asked. */
|
|
1145
|
+
_children?: {
|
|
1146
|
+
/** @description The children, in the hierarchy’s order. */
|
|
1147
|
+
data: components['schemas']['Entry'][];
|
|
1148
|
+
page: components['schemas']['OffsetPage'];
|
|
1149
|
+
};
|
|
1074
1150
|
} & {
|
|
1075
1151
|
[key: string]: unknown;
|
|
1076
1152
|
};
|
|
@@ -1134,7 +1210,7 @@ interface components {
|
|
|
1134
1210
|
emptyRequiredFields?: string[];
|
|
1135
1211
|
/** @description Every locale the entry has content in, the default first. */
|
|
1136
1212
|
availableLocales: components['schemas']['EntryLocale'][];
|
|
1137
|
-
/** @description The fields of every other locale asked for, keyed by locale
|
|
1213
|
+
/** @description The fields of every other locale asked for, keyed by locale. Present on every `?locale=*` or `?locales=` read — `{}` when no other locale has visible fields — and absent on a single-locale read. A locale with no visible fields is left out. */
|
|
1138
1214
|
localizations?: {
|
|
1139
1215
|
[key: string]: {
|
|
1140
1216
|
[key: string]: unknown;
|
|
@@ -1170,9 +1246,110 @@ interface components {
|
|
|
1170
1246
|
/** @description The referenced entry’s id. */
|
|
1171
1247
|
entryUid: string;
|
|
1172
1248
|
};
|
|
1249
|
+
/** @description One version of an entry: the fields that locale stored when the version was written, at the top level and in the active schema’s order — a field since removed included, since a version is history — and `_metadata`. */
|
|
1250
|
+
EntryVersion: {
|
|
1251
|
+
_metadata: components['schemas']['EntryVersionMetadata'];
|
|
1252
|
+
} & {
|
|
1253
|
+
[key: string]: unknown;
|
|
1254
|
+
};
|
|
1255
|
+
/** @description What this service reports about one version of an entry. Not an entry read’s `EntryMetadata`: `version` and `locale` are the row’s own, `status` is `version`, and it carries no default or available locales, no fallback and no version list. */
|
|
1256
|
+
EntryVersionMetadata: {
|
|
1257
|
+
id: string;
|
|
1258
|
+
/** @description The content type the version was written under. */
|
|
1259
|
+
type: string;
|
|
1260
|
+
/** @enum {string} */
|
|
1261
|
+
entryType: 'asset' | 'content' | 'settings' | 'singleton';
|
|
1262
|
+
/** @description The entry’s live slug at the version’s locale, or null when the type declares none. */
|
|
1263
|
+
slug: string | null;
|
|
1264
|
+
/**
|
|
1265
|
+
* @description Always `version`: this is a historical row, not the entry’s lifecycle.
|
|
1266
|
+
* @enum {string}
|
|
1267
|
+
*/
|
|
1268
|
+
status: 'version';
|
|
1269
|
+
/** @description The version’s own number, on `locale`’s counter. */
|
|
1270
|
+
version: number;
|
|
1271
|
+
/** @description The entry’s live shared-field counter. A version is not a state a write is checked against, and no `X-Entity-Tag` is minted from it. */
|
|
1272
|
+
sharedVersion: number;
|
|
1273
|
+
/** @description The locale the version belongs to. */
|
|
1274
|
+
locale: string;
|
|
1275
|
+
/**
|
|
1276
|
+
* @description Publication state of `locale` on the live entry. Absent when it has no content of its own.
|
|
1277
|
+
* @enum {string}
|
|
1278
|
+
*/
|
|
1279
|
+
localeStatus?: 'archived' | 'draft' | 'published';
|
|
1280
|
+
/** @description Whether `locale` has unpublished changes of its own. */
|
|
1281
|
+
localeHasDraft: boolean;
|
|
1282
|
+
/** @description Every locale holding unpublished content of its own, sorted. A shared-field draft is not listed: it is `hasDraft`. */
|
|
1283
|
+
draftLocales: string[];
|
|
1284
|
+
/** @description Whether the shared (non-localized) fields have unpublished changes. Publishing any locale makes them live, so they are unpublished work in every locale. */
|
|
1285
|
+
hasDraft: boolean;
|
|
1286
|
+
/**
|
|
1287
|
+
* Format: date-time
|
|
1288
|
+
* @description When the version was written.
|
|
1289
|
+
*/
|
|
1290
|
+
createdAt: string;
|
|
1291
|
+
/**
|
|
1292
|
+
* Format: date-time
|
|
1293
|
+
* @description When the version was published — the same instant as `publishedAt`.
|
|
1294
|
+
*/
|
|
1295
|
+
updatedAt: string;
|
|
1296
|
+
/**
|
|
1297
|
+
* Format: date-time
|
|
1298
|
+
* @description When the version was published.
|
|
1299
|
+
*/
|
|
1300
|
+
publishedAt: string;
|
|
1301
|
+
/** @description The references the version held. */
|
|
1302
|
+
refs: components['schemas']['EntryRef'][];
|
|
1303
|
+
};
|
|
1304
|
+
/** @description One row of an entry’s version history in one locale: which version it is, who wrote it and when, and the fields that locale stored. */
|
|
1305
|
+
EntryVersionRow: {
|
|
1306
|
+
/** @description The version’s own number, on `locale`’s counter. */
|
|
1307
|
+
versionNumber: number;
|
|
1308
|
+
/** @description The locale the version belongs to. */
|
|
1309
|
+
locale: string;
|
|
1310
|
+
/** @description That locale’s own fields, as stored when the version was written. */
|
|
1311
|
+
fields: {
|
|
1312
|
+
[key: string]: unknown;
|
|
1313
|
+
};
|
|
1314
|
+
/**
|
|
1315
|
+
* Format: date-time
|
|
1316
|
+
* @description When the version was published.
|
|
1317
|
+
*/
|
|
1318
|
+
publishedAt: string;
|
|
1319
|
+
/** @description Who wrote the version. */
|
|
1320
|
+
publishedBy: string;
|
|
1321
|
+
};
|
|
1173
1322
|
ErrorResponse: {
|
|
1174
1323
|
error: {
|
|
1175
|
-
/**
|
|
1324
|
+
/**
|
|
1325
|
+
* @description - `ACCESS_DENIED`: The credential is valid, but its subject may not do this here. Fix: Use a key or a Role that grants this action on this resource, or ask an Owner to grant it; `details.rule` names the rule that refused.
|
|
1326
|
+
* - `AI_UNAVAILABLE_IN_REGION`: The Project's data region promises residency, and no AI processes inside that region yet. Fix: Run AI work on a Project in another region; no Plan, credential or retry changes this one.
|
|
1327
|
+
* - `CONTENT_INVALID`: The content does not satisfy the schema of the type it was written to. Fix: Correct each field `details.issues` names so it matches the schema, then write it again.
|
|
1328
|
+
* - `INTERNAL_ERROR`: The service failed while handling the request. Fix: Retry once; if it fails again, report it with the time and the request that failed.
|
|
1329
|
+
* - `INVALID_API_KEY`: The credential was read but is not accepted: it is malformed, expired, revoked, unknown, or a kind this route does not take. Fix: Read `details.reason`, then send a current credential of the kind the route takes, creating a new key if this one was revoked or expired.
|
|
1330
|
+
* - `METHOD_NOT_ALLOWED`: The route does not accept this HTTP method. Fix: Send the request with one of the methods the `Allow` header lists.
|
|
1331
|
+
* - `MISSING_API_KEY`: The request carried no credential, or one that did not authenticate. Fix: Send a credential with the request: an API key in the `X-API-Key` header, or the bearer token the route takes.
|
|
1332
|
+
* - `ORGANIZATION_BEING_DELETED`: The Organization is being deleted, so nothing more may be read from or written to it. Fix: Stop using the Organization: its deletion was asked for at `details.requestedAt`, and no retry succeeds.
|
|
1333
|
+
* - `ORGANIZATION_DELETE_BLOCKED`: The Organization cannot be deleted while a paid subscription or an open checkout still holds it. Fix: Resolve what `details.reason` names: downgrade and wait for the paid period to end, or let the open checkout expire, then delete again.
|
|
1334
|
+
* - `ORGANIZATION_IN_ANOTHER_CELL`: The request reached a region that is not the home of the Organization it names. Fix: Send the same request to the region `details.region` names; retrying it here will not succeed.
|
|
1335
|
+
* - `PAYLOAD_TOO_LARGE`: The request body is larger than the route accepts. Fix: Send a body within `details.limitBytes`, splitting the work across several requests.
|
|
1336
|
+
* - `PLAN_DOWNGRADE_BLOCKED`: The Organization keeps more than the target Plan allows, so it cannot move to it. Fix: Reduce each Stock Limit `details.stockLimits` lists to within the target Plan, then retry the change.
|
|
1337
|
+
* - `PLAN_FEATURE_UNAVAILABLE`: The Organization's Plan does not include the feature this request uses. Fix: Move the Organization to a Plan that includes `details.feature`, or leave the feature out of the request.
|
|
1338
|
+
* - `PROJECT_IN_ANOTHER_CELL`: The request reached a region that does not hold the Project it names. Fix: Send the same request to the region `details.region` names; retrying it here will not succeed.
|
|
1339
|
+
* - `RATE_LIMIT_EXCEEDED`: Too many requests arrived within the current rate-limit window. Fix: Wait the seconds the `Retry-After` header names before retrying, and spread requests out.
|
|
1340
|
+
* - `READ_ONLY_KEY`: The key may read but not write. Fix: Send the write with a key that may write, and keep the read-only key for reads.
|
|
1341
|
+
* - `REQUEST_INVALID`: The request is malformed: a path parameter, query parameter, header or body field the route cannot accept. Fix: Correct each field `details.issues` names, by its path and message, and send the request again.
|
|
1342
|
+
* - `REQUEST_TIMEOUT`: The request ran longer than the service allows and was stopped. Fix: Ask for less in one request, with a narrower filter or a smaller page, then retry.
|
|
1343
|
+
* - `RESOURCE_CONFLICT`: The write conflicts with the resource's current state: it changed since it was read, or something stands in the way. Fix: Re-read the resource and retry with what that read returns, or resolve the blockage `details.blockage` names.
|
|
1344
|
+
* - `RESOURCE_EXPIRED`: What the request names existed but has expired: a cursor the feed can no longer replay from, or an invitation or link past its date. Fix: Start again without it: read afresh instead of from the cursor, or ask for a new invitation or link.
|
|
1345
|
+
* - `RESOURCE_NOT_FOUND`: Nothing the credential can see exists under that id or path. Fix: Check the id, the path and the dataset the request selects; `details.kind` names what was looked for.
|
|
1346
|
+
* - `REVERIFICATION_REQUIRED`: The action hands authority out, and the session verified its factor too long ago. Fix: Have the User verify again at the level `details.level` names, then retry the request.
|
|
1347
|
+
* - `SERVICE_INDETERMINATE`: A service this request depends on could not answer, so the outcome could not be decided. Fix: Retry after the seconds the `Retry-After` header names; `details.missing` names what was unavailable.
|
|
1348
|
+
* - `TRANSACTION_ROLLED_BACK`: One operation of an all-or-nothing batch failed, so none of the batch was applied. Fix: Nothing was written. `details.failedIndex` is the index of the operation this refusal is for, which is not necessarily the one that failed. Fix the batch, then send the whole of it again.
|
|
1349
|
+
* - `USAGE_QUOTA_EXCEEDED`: The Organization has used all of this period's allowance for `details.meter`. Fix: Wait for the next billing period, or raise the allowance by moving to a larger Plan.
|
|
1350
|
+
* - `USER_NOT_PROVISIONED`: The session is valid, but the User's account is still being set up after sign-up. Fix: Keep the session and retry after the seconds the `Retry-After` header names.
|
|
1351
|
+
* @enum {string}
|
|
1352
|
+
*/
|
|
1176
1353
|
code: 'ACCESS_DENIED' | 'AI_UNAVAILABLE_IN_REGION' | 'CONTENT_INVALID' | 'INTERNAL_ERROR' | 'INVALID_API_KEY' | 'METHOD_NOT_ALLOWED' | 'MISSING_API_KEY' | 'ORGANIZATION_BEING_DELETED' | 'ORGANIZATION_DELETE_BLOCKED' | 'ORGANIZATION_IN_ANOTHER_CELL' | 'PAYLOAD_TOO_LARGE' | 'PLAN_DOWNGRADE_BLOCKED' | 'PLAN_FEATURE_UNAVAILABLE' | 'PROJECT_IN_ANOTHER_CELL' | 'RATE_LIMIT_EXCEEDED' | 'READ_ONLY_KEY' | 'REQUEST_INVALID' | 'REQUEST_TIMEOUT' | 'RESOURCE_CONFLICT' | 'RESOURCE_EXPIRED' | 'RESOURCE_NOT_FOUND' | 'REVERIFICATION_REQUIRED' | 'SERVICE_INDETERMINATE' | 'TRANSACTION_ROLLED_BACK' | 'USAGE_QUOTA_EXCEEDED' | 'USER_NOT_PROVISIONED';
|
|
1177
1354
|
messages: string[];
|
|
1178
1355
|
details?: {
|
|
@@ -1193,6 +1370,49 @@ interface components {
|
|
|
1193
1370
|
/** @description Locale of the binding to read */
|
|
1194
1371
|
locale?: string;
|
|
1195
1372
|
};
|
|
1373
|
+
GetChildrenDto: {
|
|
1374
|
+
/**
|
|
1375
|
+
* @description Requested locale for content. Returns content in this locale with fallback if configured. Use "*" to retrieve all available locales.
|
|
1376
|
+
* @example en-US
|
|
1377
|
+
*/
|
|
1378
|
+
locale?: string;
|
|
1379
|
+
/**
|
|
1380
|
+
* @description Comma-separated list of specific locales to retrieve. First locale becomes the primary (top-level), others go in _metadata.localizations.
|
|
1381
|
+
* @example en-US,es-ES,de-DE
|
|
1382
|
+
*/
|
|
1383
|
+
locales?: string;
|
|
1384
|
+
/**
|
|
1385
|
+
* @description Comma-separated include paths: the references to expand into the entries they point at. A path names fields, joined by dots, through lists, page builders, objects and references (`sections.features`, `sections.customers.logo`); each hop across a reference is written out. A path that stops at a list or an object expands every reference it holds. Fields in parentheses are the only fields each expanded entry returns, beside its `_metadata` (`sections.features(name,slug)`). A path that holds no reference is refused, naming the ones that do.
|
|
1386
|
+
* @example sections.features(name,slug),sections.customers.logo
|
|
1387
|
+
*/
|
|
1388
|
+
include?: string;
|
|
1389
|
+
/**
|
|
1390
|
+
* @description Embed each entry's children, of every content type, under `_children`. `true` or `1` → 1 level, `2` → 2 levels, `3` → 3 levels (the maximum).
|
|
1391
|
+
* @example true
|
|
1392
|
+
* @enum {string}
|
|
1393
|
+
*/
|
|
1394
|
+
children?: '1' | '2' | '3' | 'true';
|
|
1395
|
+
/**
|
|
1396
|
+
* @description Max children per parent when using children embedding. Default: 25, Max: 50.
|
|
1397
|
+
* @example 25
|
|
1398
|
+
*/
|
|
1399
|
+
childrenLimit?: number;
|
|
1400
|
+
/**
|
|
1401
|
+
* @description Cursor for pagination (from previous response). Use cursor-based pagination for best performance with large datasets.
|
|
1402
|
+
* @example eyJlbnRyeVVpZCI6ImFiYzEyMyIsImNyZWF0ZWRBdCI6IjIwMjQtMDEtMDEifQ
|
|
1403
|
+
*/
|
|
1404
|
+
cursor?: string;
|
|
1405
|
+
/**
|
|
1406
|
+
* @description Maximum number of items to return: the page size of a cursor or page-number read
|
|
1407
|
+
* @example 25
|
|
1408
|
+
*/
|
|
1409
|
+
limit?: number;
|
|
1410
|
+
/**
|
|
1411
|
+
* @description Page number (1-indexed, max 100). For deep pagination beyond this limit, use cursor-based pagination instead.
|
|
1412
|
+
* @example 1
|
|
1413
|
+
*/
|
|
1414
|
+
page?: number;
|
|
1415
|
+
};
|
|
1196
1416
|
GetEntriesDto: {
|
|
1197
1417
|
/**
|
|
1198
1418
|
* @description Requested locale for content. Returns content in this locale with fallback if configured. Use "*" to retrieve all available locales.
|
|
@@ -1347,7 +1567,10 @@ interface components {
|
|
|
1347
1567
|
};
|
|
1348
1568
|
RefusalAccessDenied: {
|
|
1349
1569
|
error: {
|
|
1350
|
-
/**
|
|
1570
|
+
/**
|
|
1571
|
+
* @description - `ACCESS_DENIED`: The credential is valid, but its subject may not do this here. Fix: Use a key or a Role that grants this action on this resource, or ask an Owner to grant it; `details.rule` names the rule that refused.
|
|
1572
|
+
* @enum {string}
|
|
1573
|
+
*/
|
|
1351
1574
|
code: 'ACCESS_DENIED';
|
|
1352
1575
|
messages: string[];
|
|
1353
1576
|
details?: {
|
|
@@ -1357,7 +1580,13 @@ interface components {
|
|
|
1357
1580
|
};
|
|
1358
1581
|
RefusalAccessDeniedOrPlanFeatureUnavailableOrReadOnlyKeyOrUsageQuotaExceeded: {
|
|
1359
1582
|
error: {
|
|
1360
|
-
/**
|
|
1583
|
+
/**
|
|
1584
|
+
* @description - `ACCESS_DENIED`: The credential is valid, but its subject may not do this here. Fix: Use a key or a Role that grants this action on this resource, or ask an Owner to grant it; `details.rule` names the rule that refused.
|
|
1585
|
+
* - `PLAN_FEATURE_UNAVAILABLE`: The Organization's Plan does not include the feature this request uses. Fix: Move the Organization to a Plan that includes `details.feature`, or leave the feature out of the request.
|
|
1586
|
+
* - `READ_ONLY_KEY`: The key may read but not write. Fix: Send the write with a key that may write, and keep the read-only key for reads.
|
|
1587
|
+
* - `USAGE_QUOTA_EXCEEDED`: The Organization has used all of this period's allowance for `details.meter`. Fix: Wait for the next billing period, or raise the allowance by moving to a larger Plan.
|
|
1588
|
+
* @enum {string}
|
|
1589
|
+
*/
|
|
1361
1590
|
code: 'ACCESS_DENIED' | 'PLAN_FEATURE_UNAVAILABLE' | 'READ_ONLY_KEY' | 'USAGE_QUOTA_EXCEEDED';
|
|
1362
1591
|
messages: string[];
|
|
1363
1592
|
details?: {
|
|
@@ -1367,7 +1596,12 @@ interface components {
|
|
|
1367
1596
|
};
|
|
1368
1597
|
RefusalAccessDeniedOrPlanFeatureUnavailableOrUsageQuotaExceeded: {
|
|
1369
1598
|
error: {
|
|
1370
|
-
/**
|
|
1599
|
+
/**
|
|
1600
|
+
* @description - `ACCESS_DENIED`: The credential is valid, but its subject may not do this here. Fix: Use a key or a Role that grants this action on this resource, or ask an Owner to grant it; `details.rule` names the rule that refused.
|
|
1601
|
+
* - `PLAN_FEATURE_UNAVAILABLE`: The Organization's Plan does not include the feature this request uses. Fix: Move the Organization to a Plan that includes `details.feature`, or leave the feature out of the request.
|
|
1602
|
+
* - `USAGE_QUOTA_EXCEEDED`: The Organization has used all of this period's allowance for `details.meter`. Fix: Wait for the next billing period, or raise the allowance by moving to a larger Plan.
|
|
1603
|
+
* @enum {string}
|
|
1604
|
+
*/
|
|
1371
1605
|
code: 'ACCESS_DENIED' | 'PLAN_FEATURE_UNAVAILABLE' | 'USAGE_QUOTA_EXCEEDED';
|
|
1372
1606
|
messages: string[];
|
|
1373
1607
|
details?: {
|
|
@@ -1377,7 +1611,11 @@ interface components {
|
|
|
1377
1611
|
};
|
|
1378
1612
|
RefusalContentInvalidOrRequestInvalid: {
|
|
1379
1613
|
error: {
|
|
1380
|
-
/**
|
|
1614
|
+
/**
|
|
1615
|
+
* @description - `CONTENT_INVALID`: The content does not satisfy the schema of the type it was written to. Fix: Correct each field `details.issues` names so it matches the schema, then write it again.
|
|
1616
|
+
* - `REQUEST_INVALID`: The request is malformed: a path parameter, query parameter, header or body field the route cannot accept. Fix: Correct each field `details.issues` names, by its path and message, and send the request again.
|
|
1617
|
+
* @enum {string}
|
|
1618
|
+
*/
|
|
1381
1619
|
code: 'CONTENT_INVALID' | 'REQUEST_INVALID';
|
|
1382
1620
|
messages: string[];
|
|
1383
1621
|
details?: {
|
|
@@ -1387,7 +1625,10 @@ interface components {
|
|
|
1387
1625
|
};
|
|
1388
1626
|
RefusalInternalError: {
|
|
1389
1627
|
error: {
|
|
1390
|
-
/**
|
|
1628
|
+
/**
|
|
1629
|
+
* @description - `INTERNAL_ERROR`: The service failed while handling the request. Fix: Retry once; if it fails again, report it with the time and the request that failed.
|
|
1630
|
+
* @enum {string}
|
|
1631
|
+
*/
|
|
1391
1632
|
code: 'INTERNAL_ERROR';
|
|
1392
1633
|
messages: string[];
|
|
1393
1634
|
details?: {
|
|
@@ -1397,7 +1638,11 @@ interface components {
|
|
|
1397
1638
|
};
|
|
1398
1639
|
RefusalInvalidApiKeyOrMissingApiKey: {
|
|
1399
1640
|
error: {
|
|
1400
|
-
/**
|
|
1641
|
+
/**
|
|
1642
|
+
* @description - `INVALID_API_KEY`: The credential was read but is not accepted: it is malformed, expired, revoked, unknown, or a kind this route does not take. Fix: Read `details.reason`, then send a current credential of the kind the route takes, creating a new key if this one was revoked or expired.
|
|
1643
|
+
* - `MISSING_API_KEY`: The request carried no credential, or one that did not authenticate. Fix: Send a credential with the request: an API key in the `X-API-Key` header, or the bearer token the route takes.
|
|
1644
|
+
* @enum {string}
|
|
1645
|
+
*/
|
|
1401
1646
|
code: 'INVALID_API_KEY' | 'MISSING_API_KEY';
|
|
1402
1647
|
messages: string[];
|
|
1403
1648
|
details?: {
|
|
@@ -1407,7 +1652,10 @@ interface components {
|
|
|
1407
1652
|
};
|
|
1408
1653
|
RefusalProjectInAnotherCell: {
|
|
1409
1654
|
error: {
|
|
1410
|
-
/**
|
|
1655
|
+
/**
|
|
1656
|
+
* @description - `PROJECT_IN_ANOTHER_CELL`: The request reached a region that does not hold the Project it names. Fix: Send the same request to the region `details.region` names; retrying it here will not succeed.
|
|
1657
|
+
* @enum {string}
|
|
1658
|
+
*/
|
|
1411
1659
|
code: 'PROJECT_IN_ANOTHER_CELL';
|
|
1412
1660
|
messages: string[];
|
|
1413
1661
|
details: {
|
|
@@ -1418,7 +1666,10 @@ interface components {
|
|
|
1418
1666
|
};
|
|
1419
1667
|
RefusalRateLimitExceeded: {
|
|
1420
1668
|
error: {
|
|
1421
|
-
/**
|
|
1669
|
+
/**
|
|
1670
|
+
* @description - `RATE_LIMIT_EXCEEDED`: Too many requests arrived within the current rate-limit window. Fix: Wait the seconds the `Retry-After` header names before retrying, and spread requests out.
|
|
1671
|
+
* @enum {string}
|
|
1672
|
+
*/
|
|
1422
1673
|
code: 'RATE_LIMIT_EXCEEDED';
|
|
1423
1674
|
messages: string[];
|
|
1424
1675
|
details?: {
|
|
@@ -1428,7 +1679,10 @@ interface components {
|
|
|
1428
1679
|
};
|
|
1429
1680
|
RefusalRequestInvalid: {
|
|
1430
1681
|
error: {
|
|
1431
|
-
/**
|
|
1682
|
+
/**
|
|
1683
|
+
* @description - `REQUEST_INVALID`: The request is malformed: a path parameter, query parameter, header or body field the route cannot accept. Fix: Correct each field `details.issues` names, by its path and message, and send the request again.
|
|
1684
|
+
* @enum {string}
|
|
1685
|
+
*/
|
|
1432
1686
|
code: 'REQUEST_INVALID';
|
|
1433
1687
|
messages: string[];
|
|
1434
1688
|
details?: {
|
|
@@ -1438,7 +1692,10 @@ interface components {
|
|
|
1438
1692
|
};
|
|
1439
1693
|
RefusalRequestTimeout: {
|
|
1440
1694
|
error: {
|
|
1441
|
-
/**
|
|
1695
|
+
/**
|
|
1696
|
+
* @description - `REQUEST_TIMEOUT`: The request ran longer than the service allows and was stopped. Fix: Ask for less in one request, with a narrower filter or a smaller page, then retry.
|
|
1697
|
+
* @enum {string}
|
|
1698
|
+
*/
|
|
1442
1699
|
code: 'REQUEST_TIMEOUT';
|
|
1443
1700
|
messages: string[];
|
|
1444
1701
|
details?: {
|
|
@@ -1448,7 +1705,10 @@ interface components {
|
|
|
1448
1705
|
};
|
|
1449
1706
|
RefusalResourceConflict: {
|
|
1450
1707
|
error: {
|
|
1451
|
-
/**
|
|
1708
|
+
/**
|
|
1709
|
+
* @description - `RESOURCE_CONFLICT`: The write conflicts with the resource's current state: it changed since it was read, or something stands in the way. Fix: Re-read the resource and retry with what that read returns, or resolve the blockage `details.blockage` names.
|
|
1710
|
+
* @enum {string}
|
|
1711
|
+
*/
|
|
1452
1712
|
code: 'RESOURCE_CONFLICT';
|
|
1453
1713
|
messages: string[];
|
|
1454
1714
|
details?: {
|
|
@@ -1456,19 +1716,44 @@ interface components {
|
|
|
1456
1716
|
};
|
|
1457
1717
|
};
|
|
1458
1718
|
};
|
|
1459
|
-
|
|
1719
|
+
RefusalResourceConflictNamingDraftExistsBlockageOrReleaseLockedBlockageOrSlugTakenBlockage: {
|
|
1460
1720
|
error: {
|
|
1461
|
-
/**
|
|
1462
|
-
|
|
1721
|
+
/**
|
|
1722
|
+
* @description - `RESOURCE_CONFLICT`: The write conflicts with the resource's current state: it changed since it was read, or something stands in the way. Fix: Re-read the resource and retry with what that read returns, or resolve the blockage `details.blockage` names.
|
|
1723
|
+
* @enum {string}
|
|
1724
|
+
*/
|
|
1725
|
+
code: 'RESOURCE_CONFLICT';
|
|
1463
1726
|
messages: string[];
|
|
1464
1727
|
details?: {
|
|
1728
|
+
blockage?: components['schemas']['DraftExistsBlockage'] | components['schemas']['ReleaseLockedBlockage'] | components['schemas']['SlugTakenBlockage'];
|
|
1729
|
+
} & {
|
|
1465
1730
|
[key: string]: unknown;
|
|
1466
1731
|
};
|
|
1467
1732
|
};
|
|
1468
1733
|
};
|
|
1734
|
+
RefusalResourceExpired: {
|
|
1735
|
+
error: {
|
|
1736
|
+
/**
|
|
1737
|
+
* @description - `RESOURCE_EXPIRED`: What the request names existed but has expired: a cursor the feed can no longer replay from, or an invitation or link past its date. Fix: Start again without it: read afresh instead of from the cursor, or ask for a new invitation or link.
|
|
1738
|
+
* @enum {string}
|
|
1739
|
+
*/
|
|
1740
|
+
code: 'RESOURCE_EXPIRED';
|
|
1741
|
+
messages: string[];
|
|
1742
|
+
details: {
|
|
1743
|
+
/**
|
|
1744
|
+
* @description `retention` and `dataset-replaced`: the changes feed cannot replay from the cursor. `version-pruned` and `superseded`: an idempotent replay cannot reproduce the original answer, though the original write happened. `past-expiry`: an invitation past its date.
|
|
1745
|
+
* @enum {string}
|
|
1746
|
+
*/
|
|
1747
|
+
reason: 'dataset-replaced' | 'past-expiry' | 'retention' | 'superseded' | 'version-pruned';
|
|
1748
|
+
};
|
|
1749
|
+
};
|
|
1750
|
+
};
|
|
1469
1751
|
RefusalResourceNotFound: {
|
|
1470
1752
|
error: {
|
|
1471
|
-
/**
|
|
1753
|
+
/**
|
|
1754
|
+
* @description - `RESOURCE_NOT_FOUND`: Nothing the credential can see exists under that id or path. Fix: Check the id, the path and the dataset the request selects; `details.kind` names what was looked for.
|
|
1755
|
+
* @enum {string}
|
|
1756
|
+
*/
|
|
1472
1757
|
code: 'RESOURCE_NOT_FOUND';
|
|
1473
1758
|
messages: string[];
|
|
1474
1759
|
details?: {
|
|
@@ -1478,7 +1763,10 @@ interface components {
|
|
|
1478
1763
|
};
|
|
1479
1764
|
RefusalServiceIndeterminate: {
|
|
1480
1765
|
error: {
|
|
1481
|
-
/**
|
|
1766
|
+
/**
|
|
1767
|
+
* @description - `SERVICE_INDETERMINATE`: A service this request depends on could not answer, so the outcome could not be decided. Fix: Retry after the seconds the `Retry-After` header names; `details.missing` names what was unavailable.
|
|
1768
|
+
* @enum {string}
|
|
1769
|
+
*/
|
|
1482
1770
|
code: 'SERVICE_INDETERMINATE';
|
|
1483
1771
|
messages: string[];
|
|
1484
1772
|
details?: {
|
|
@@ -1486,6 +1774,12 @@ interface components {
|
|
|
1486
1774
|
};
|
|
1487
1775
|
};
|
|
1488
1776
|
};
|
|
1777
|
+
/** @description A scheduled release holds the entry and refuses edits to it until the release publishes or lets it go. */
|
|
1778
|
+
ReleaseLockedBlockage: {
|
|
1779
|
+
/** @enum {string} */
|
|
1780
|
+
kind: 'release-locked';
|
|
1781
|
+
facts: Record<string, never>;
|
|
1782
|
+
};
|
|
1489
1783
|
/** @description The entry after a restore: its fields at the top level and `_metadata`, which also lists what the restore left out and the links other entries publish that it left pointing nowhere. */
|
|
1490
1784
|
RestoredEntry: {
|
|
1491
1785
|
_metadata: components['schemas']['RestoredEntryMetadata'];
|
|
@@ -1539,7 +1833,7 @@ interface components {
|
|
|
1539
1833
|
emptyRequiredFields?: string[];
|
|
1540
1834
|
/** @description Every locale the entry has content in, the default first. */
|
|
1541
1835
|
availableLocales: components['schemas']['EntryLocale'][];
|
|
1542
|
-
/** @description The fields of every other locale asked for, keyed by locale
|
|
1836
|
+
/** @description The fields of every other locale asked for, keyed by locale. Present on every `?locale=*` or `?locales=` read — `{}` when no other locale has visible fields — and absent on a single-locale read. A locale with no visible fields is left out. */
|
|
1543
1837
|
localizations?: {
|
|
1544
1838
|
[key: string]: {
|
|
1545
1839
|
[key: string]: unknown;
|
|
@@ -1625,7 +1919,7 @@ interface components {
|
|
|
1625
1919
|
emptyRequiredFields?: string[];
|
|
1626
1920
|
/** @description Every locale the entry has content in, the default first. */
|
|
1627
1921
|
availableLocales: components['schemas']['EntryLocale'][];
|
|
1628
|
-
/** @description The fields of every other locale asked for, keyed by locale
|
|
1922
|
+
/** @description The fields of every other locale asked for, keyed by locale. Present on every `?locale=*` or `?locales=` read — `{}` when no other locale has visible fields — and absent on a single-locale read. A locale with no visible fields is left out. */
|
|
1629
1923
|
localizations?: {
|
|
1630
1924
|
[key: string]: {
|
|
1631
1925
|
[key: string]: unknown;
|
|
@@ -1979,11 +2273,56 @@ interface components {
|
|
|
1979
2273
|
/** @description Each required field the singleton holds no value for, which this read filled with its kind’s empty value, as a value path naming a list item by its key — as on an entry. Absent when none was. */
|
|
1980
2274
|
emptyRequiredFields?: string[];
|
|
1981
2275
|
};
|
|
2276
|
+
/** @description Another entry holds the slug this write would store, in the locale `facts` names. Choose another slug. */
|
|
2277
|
+
SlugTakenBlockage: {
|
|
2278
|
+
/** @enum {string} */
|
|
2279
|
+
kind: 'slug-taken';
|
|
2280
|
+
facts: {
|
|
2281
|
+
/** @description The slug field, as a `CONTENT_INVALID` issue names it: with the locale for a localized slug (`slug.fr-FR`), without one for a shared slug. */
|
|
2282
|
+
path: string;
|
|
2283
|
+
/** @enum {string} */
|
|
2284
|
+
code: 'SLUG_TAKEN';
|
|
2285
|
+
/** @description The locale whose slug collided. A shared slug is reserved in every locale its entry has, so it names one too. */
|
|
2286
|
+
locale: string;
|
|
2287
|
+
/** @description The slug another entry holds. */
|
|
2288
|
+
slug: string;
|
|
2289
|
+
/** @description The entry holding the slug in that locale. */
|
|
2290
|
+
entryId: string;
|
|
2291
|
+
};
|
|
2292
|
+
};
|
|
1982
2293
|
SubFailure: {
|
|
1983
2294
|
index: number;
|
|
1984
2295
|
id?: string;
|
|
1985
2296
|
error: {
|
|
1986
|
-
/**
|
|
2297
|
+
/**
|
|
2298
|
+
* @description - `ACCESS_DENIED`: The credential is valid, but its subject may not do this here. Fix: Use a key or a Role that grants this action on this resource, or ask an Owner to grant it; `details.rule` names the rule that refused.
|
|
2299
|
+
* - `AI_UNAVAILABLE_IN_REGION`: The Project's data region promises residency, and no AI processes inside that region yet. Fix: Run AI work on a Project in another region; no Plan, credential or retry changes this one.
|
|
2300
|
+
* - `CONTENT_INVALID`: The content does not satisfy the schema of the type it was written to. Fix: Correct each field `details.issues` names so it matches the schema, then write it again.
|
|
2301
|
+
* - `INTERNAL_ERROR`: The service failed while handling the request. Fix: Retry once; if it fails again, report it with the time and the request that failed.
|
|
2302
|
+
* - `INVALID_API_KEY`: The credential was read but is not accepted: it is malformed, expired, revoked, unknown, or a kind this route does not take. Fix: Read `details.reason`, then send a current credential of the kind the route takes, creating a new key if this one was revoked or expired.
|
|
2303
|
+
* - `METHOD_NOT_ALLOWED`: The route does not accept this HTTP method. Fix: Send the request with one of the methods the `Allow` header lists.
|
|
2304
|
+
* - `MISSING_API_KEY`: The request carried no credential, or one that did not authenticate. Fix: Send a credential with the request: an API key in the `X-API-Key` header, or the bearer token the route takes.
|
|
2305
|
+
* - `ORGANIZATION_BEING_DELETED`: The Organization is being deleted, so nothing more may be read from or written to it. Fix: Stop using the Organization: its deletion was asked for at `details.requestedAt`, and no retry succeeds.
|
|
2306
|
+
* - `ORGANIZATION_DELETE_BLOCKED`: The Organization cannot be deleted while a paid subscription or an open checkout still holds it. Fix: Resolve what `details.reason` names: downgrade and wait for the paid period to end, or let the open checkout expire, then delete again.
|
|
2307
|
+
* - `ORGANIZATION_IN_ANOTHER_CELL`: The request reached a region that is not the home of the Organization it names. Fix: Send the same request to the region `details.region` names; retrying it here will not succeed.
|
|
2308
|
+
* - `PAYLOAD_TOO_LARGE`: The request body is larger than the route accepts. Fix: Send a body within `details.limitBytes`, splitting the work across several requests.
|
|
2309
|
+
* - `PLAN_DOWNGRADE_BLOCKED`: The Organization keeps more than the target Plan allows, so it cannot move to it. Fix: Reduce each Stock Limit `details.stockLimits` lists to within the target Plan, then retry the change.
|
|
2310
|
+
* - `PLAN_FEATURE_UNAVAILABLE`: The Organization's Plan does not include the feature this request uses. Fix: Move the Organization to a Plan that includes `details.feature`, or leave the feature out of the request.
|
|
2311
|
+
* - `PROJECT_IN_ANOTHER_CELL`: The request reached a region that does not hold the Project it names. Fix: Send the same request to the region `details.region` names; retrying it here will not succeed.
|
|
2312
|
+
* - `RATE_LIMIT_EXCEEDED`: Too many requests arrived within the current rate-limit window. Fix: Wait the seconds the `Retry-After` header names before retrying, and spread requests out.
|
|
2313
|
+
* - `READ_ONLY_KEY`: The key may read but not write. Fix: Send the write with a key that may write, and keep the read-only key for reads.
|
|
2314
|
+
* - `REQUEST_INVALID`: The request is malformed: a path parameter, query parameter, header or body field the route cannot accept. Fix: Correct each field `details.issues` names, by its path and message, and send the request again.
|
|
2315
|
+
* - `REQUEST_TIMEOUT`: The request ran longer than the service allows and was stopped. Fix: Ask for less in one request, with a narrower filter or a smaller page, then retry.
|
|
2316
|
+
* - `RESOURCE_CONFLICT`: The write conflicts with the resource's current state: it changed since it was read, or something stands in the way. Fix: Re-read the resource and retry with what that read returns, or resolve the blockage `details.blockage` names.
|
|
2317
|
+
* - `RESOURCE_EXPIRED`: What the request names existed but has expired: a cursor the feed can no longer replay from, or an invitation or link past its date. Fix: Start again without it: read afresh instead of from the cursor, or ask for a new invitation or link.
|
|
2318
|
+
* - `RESOURCE_NOT_FOUND`: Nothing the credential can see exists under that id or path. Fix: Check the id, the path and the dataset the request selects; `details.kind` names what was looked for.
|
|
2319
|
+
* - `REVERIFICATION_REQUIRED`: The action hands authority out, and the session verified its factor too long ago. Fix: Have the User verify again at the level `details.level` names, then retry the request.
|
|
2320
|
+
* - `SERVICE_INDETERMINATE`: A service this request depends on could not answer, so the outcome could not be decided. Fix: Retry after the seconds the `Retry-After` header names; `details.missing` names what was unavailable.
|
|
2321
|
+
* - `TRANSACTION_ROLLED_BACK`: One operation of an all-or-nothing batch failed, so none of the batch was applied. Fix: Nothing was written. `details.failedIndex` is the index of the operation this refusal is for, which is not necessarily the one that failed. Fix the batch, then send the whole of it again.
|
|
2322
|
+
* - `USAGE_QUOTA_EXCEEDED`: The Organization has used all of this period's allowance for `details.meter`. Fix: Wait for the next billing period, or raise the allowance by moving to a larger Plan.
|
|
2323
|
+
* - `USER_NOT_PROVISIONED`: The session is valid, but the User's account is still being set up after sign-up. Fix: Keep the session and retry after the seconds the `Retry-After` header names.
|
|
2324
|
+
* @enum {string}
|
|
2325
|
+
*/
|
|
1987
2326
|
code: 'ACCESS_DENIED' | 'AI_UNAVAILABLE_IN_REGION' | 'CONTENT_INVALID' | 'INTERNAL_ERROR' | 'INVALID_API_KEY' | 'METHOD_NOT_ALLOWED' | 'MISSING_API_KEY' | 'ORGANIZATION_BEING_DELETED' | 'ORGANIZATION_DELETE_BLOCKED' | 'ORGANIZATION_IN_ANOTHER_CELL' | 'PAYLOAD_TOO_LARGE' | 'PLAN_DOWNGRADE_BLOCKED' | 'PLAN_FEATURE_UNAVAILABLE' | 'PROJECT_IN_ANOTHER_CELL' | 'RATE_LIMIT_EXCEEDED' | 'READ_ONLY_KEY' | 'REQUEST_INVALID' | 'REQUEST_TIMEOUT' | 'RESOURCE_CONFLICT' | 'RESOURCE_EXPIRED' | 'RESOURCE_NOT_FOUND' | 'REVERIFICATION_REQUIRED' | 'SERVICE_INDETERMINATE' | 'TRANSACTION_ROLLED_BACK' | 'USAGE_QUOTA_EXCEEDED' | 'USER_NOT_PROVISIONED';
|
|
1988
2327
|
messages: string[];
|
|
1989
2328
|
details?: {
|
|
@@ -2854,8 +3193,7 @@ interface operations {
|
|
|
2854
3193
|
};
|
|
2855
3194
|
content: {
|
|
2856
3195
|
'application/json': {
|
|
2857
|
-
|
|
2858
|
-
data: unknown;
|
|
3196
|
+
data: components['schemas']['Entry'];
|
|
2859
3197
|
};
|
|
2860
3198
|
};
|
|
2861
3199
|
};
|
|
@@ -2901,7 +3239,7 @@ interface operations {
|
|
|
2901
3239
|
[name: string]: unknown;
|
|
2902
3240
|
};
|
|
2903
3241
|
content: {
|
|
2904
|
-
'application/json': components['schemas']['
|
|
3242
|
+
'application/json': components['schemas']['RefusalResourceConflictNamingDraftExistsBlockageOrReleaseLockedBlockageOrSlugTakenBlockage'];
|
|
2905
3243
|
};
|
|
2906
3244
|
};
|
|
2907
3245
|
/** @description RESOURCE_EXPIRED */
|
|
@@ -3130,7 +3468,7 @@ interface operations {
|
|
|
3130
3468
|
[name: string]: unknown;
|
|
3131
3469
|
};
|
|
3132
3470
|
content: {
|
|
3133
|
-
'application/json': components['schemas']['
|
|
3471
|
+
'application/json': components['schemas']['RefusalResourceConflictNamingDraftExistsBlockageOrReleaseLockedBlockageOrSlugTakenBlockage'];
|
|
3134
3472
|
};
|
|
3135
3473
|
};
|
|
3136
3474
|
/** @description RESOURCE_EXPIRED */
|
|
@@ -3248,7 +3586,7 @@ interface operations {
|
|
|
3248
3586
|
[name: string]: unknown;
|
|
3249
3587
|
};
|
|
3250
3588
|
content: {
|
|
3251
|
-
'application/json': components['schemas']['
|
|
3589
|
+
'application/json': components['schemas']['RefusalResourceConflictNamingDraftExistsBlockageOrReleaseLockedBlockageOrSlugTakenBlockage'];
|
|
3252
3590
|
};
|
|
3253
3591
|
};
|
|
3254
3592
|
/** @description RESOURCE_EXPIRED */
|
|
@@ -3307,12 +3645,18 @@ interface operations {
|
|
|
3307
3645
|
children?: '1' | '2' | '3' | 'true';
|
|
3308
3646
|
/** @description Max children per parent when using children embedding. Default: 25, Max: 50. */
|
|
3309
3647
|
childrenLimit?: number;
|
|
3648
|
+
/** @description Cursor for pagination (from previous response). Use cursor-based pagination for best performance with large datasets. */
|
|
3649
|
+
cursor?: string;
|
|
3310
3650
|
/** @description Comma-separated include paths: the references to expand into the entries they point at. A path names fields, joined by dots, through lists, page builders, objects and references (`sections.features`, `sections.customers.logo`); each hop across a reference is written out. A path that stops at a list or an object expands every reference it holds. Fields in parentheses are the only fields each expanded entry returns, beside its `_metadata` (`sections.features(name,slug)`). A path that holds no reference is refused, naming the ones that do. */
|
|
3311
3651
|
include?: string;
|
|
3652
|
+
/** @description Maximum number of items to return: the page size of a cursor or page-number read */
|
|
3653
|
+
limit?: number;
|
|
3312
3654
|
/** @description Requested locale for content. Returns content in this locale with fallback if configured. Use "*" to retrieve all available locales. */
|
|
3313
3655
|
locale?: string;
|
|
3314
3656
|
/** @description Comma-separated list of specific locales to retrieve. First locale becomes the primary (top-level), others go in _metadata.localizations. */
|
|
3315
3657
|
locales?: string;
|
|
3658
|
+
/** @description Page number (1-indexed, max 100). For deep pagination beyond this limit, use cursor-based pagination instead. */
|
|
3659
|
+
page?: number;
|
|
3316
3660
|
};
|
|
3317
3661
|
header?: never;
|
|
3318
3662
|
path: {
|
|
@@ -3334,8 +3678,8 @@ interface operations {
|
|
|
3334
3678
|
};
|
|
3335
3679
|
content: {
|
|
3336
3680
|
'application/json': {
|
|
3337
|
-
|
|
3338
|
-
|
|
3681
|
+
data: unknown[];
|
|
3682
|
+
page: components['schemas']['CursorPage'];
|
|
3339
3683
|
};
|
|
3340
3684
|
};
|
|
3341
3685
|
};
|
|
@@ -3439,13 +3783,13 @@ interface operations {
|
|
|
3439
3783
|
};
|
|
3440
3784
|
};
|
|
3441
3785
|
};
|
|
3442
|
-
/** @description
|
|
3786
|
+
/** @description REQUEST_INVALID */
|
|
3443
3787
|
400: {
|
|
3444
3788
|
headers: {
|
|
3445
3789
|
[name: string]: unknown;
|
|
3446
3790
|
};
|
|
3447
3791
|
content: {
|
|
3448
|
-
'application/json': components['schemas']['
|
|
3792
|
+
'application/json': components['schemas']['RefusalRequestInvalid'];
|
|
3449
3793
|
};
|
|
3450
3794
|
};
|
|
3451
3795
|
/** @description INVALID_API_KEY, MISSING_API_KEY */
|
|
@@ -4660,6 +5004,125 @@ interface operations {
|
|
|
4660
5004
|
};
|
|
4661
5005
|
};
|
|
4662
5006
|
};
|
|
5007
|
+
restoreSharedEntryVersion: {
|
|
5008
|
+
parameters: {
|
|
5009
|
+
query?: never;
|
|
5010
|
+
header?: {
|
|
5011
|
+
'Idempotency-Key'?: string;
|
|
5012
|
+
'If-Match'?: string;
|
|
5013
|
+
};
|
|
5014
|
+
path: {
|
|
5015
|
+
contentType: string;
|
|
5016
|
+
id: string;
|
|
5017
|
+
versionNumber: string;
|
|
5018
|
+
};
|
|
5019
|
+
cookie?: never;
|
|
5020
|
+
};
|
|
5021
|
+
requestBody?: never;
|
|
5022
|
+
responses: {
|
|
5023
|
+
/** @description Success. */
|
|
5024
|
+
200: {
|
|
5025
|
+
headers: {
|
|
5026
|
+
[name: string]: unknown;
|
|
5027
|
+
};
|
|
5028
|
+
content: {
|
|
5029
|
+
'application/json': {
|
|
5030
|
+
data: components['schemas']['RestoredEntry'];
|
|
5031
|
+
};
|
|
5032
|
+
};
|
|
5033
|
+
};
|
|
5034
|
+
/** @description CONTENT_INVALID, REQUEST_INVALID */
|
|
5035
|
+
400: {
|
|
5036
|
+
headers: {
|
|
5037
|
+
[name: string]: unknown;
|
|
5038
|
+
};
|
|
5039
|
+
content: {
|
|
5040
|
+
'application/json': components['schemas']['RefusalContentInvalidOrRequestInvalid'];
|
|
5041
|
+
};
|
|
5042
|
+
};
|
|
5043
|
+
/** @description INVALID_API_KEY, MISSING_API_KEY */
|
|
5044
|
+
401: {
|
|
5045
|
+
headers: {
|
|
5046
|
+
[name: string]: unknown;
|
|
5047
|
+
};
|
|
5048
|
+
content: {
|
|
5049
|
+
'application/json': components['schemas']['RefusalInvalidApiKeyOrMissingApiKey'];
|
|
5050
|
+
};
|
|
5051
|
+
};
|
|
5052
|
+
/** @description ACCESS_DENIED, PLAN_FEATURE_UNAVAILABLE, READ_ONLY_KEY, USAGE_QUOTA_EXCEEDED */
|
|
5053
|
+
403: {
|
|
5054
|
+
headers: {
|
|
5055
|
+
[name: string]: unknown;
|
|
5056
|
+
};
|
|
5057
|
+
content: {
|
|
5058
|
+
'application/json': components['schemas']['RefusalAccessDeniedOrPlanFeatureUnavailableOrReadOnlyKeyOrUsageQuotaExceeded'];
|
|
5059
|
+
};
|
|
5060
|
+
};
|
|
5061
|
+
/** @description RESOURCE_NOT_FOUND */
|
|
5062
|
+
404: {
|
|
5063
|
+
headers: {
|
|
5064
|
+
[name: string]: unknown;
|
|
5065
|
+
};
|
|
5066
|
+
content: {
|
|
5067
|
+
'application/json': components['schemas']['RefusalResourceNotFound'];
|
|
5068
|
+
};
|
|
5069
|
+
};
|
|
5070
|
+
/** @description RESOURCE_CONFLICT */
|
|
5071
|
+
409: {
|
|
5072
|
+
headers: {
|
|
5073
|
+
[name: string]: unknown;
|
|
5074
|
+
};
|
|
5075
|
+
content: {
|
|
5076
|
+
'application/json': components['schemas']['RefusalResourceConflictNamingDraftExistsBlockageOrReleaseLockedBlockageOrSlugTakenBlockage'];
|
|
5077
|
+
};
|
|
5078
|
+
};
|
|
5079
|
+
/** @description RESOURCE_EXPIRED */
|
|
5080
|
+
410: {
|
|
5081
|
+
headers: {
|
|
5082
|
+
[name: string]: unknown;
|
|
5083
|
+
};
|
|
5084
|
+
content: {
|
|
5085
|
+
'application/json': components['schemas']['RefusalResourceExpired'];
|
|
5086
|
+
};
|
|
5087
|
+
};
|
|
5088
|
+
/** @description PROJECT_IN_ANOTHER_CELL */
|
|
5089
|
+
421: {
|
|
5090
|
+
headers: {
|
|
5091
|
+
[name: string]: unknown;
|
|
5092
|
+
};
|
|
5093
|
+
content: {
|
|
5094
|
+
'application/json': components['schemas']['RefusalProjectInAnotherCell'];
|
|
5095
|
+
};
|
|
5096
|
+
};
|
|
5097
|
+
/** @description RATE_LIMIT_EXCEEDED */
|
|
5098
|
+
429: {
|
|
5099
|
+
headers: {
|
|
5100
|
+
[name: string]: unknown;
|
|
5101
|
+
};
|
|
5102
|
+
content: {
|
|
5103
|
+
'application/json': components['schemas']['RefusalRateLimitExceeded'];
|
|
5104
|
+
};
|
|
5105
|
+
};
|
|
5106
|
+
/** @description INTERNAL_ERROR */
|
|
5107
|
+
500: {
|
|
5108
|
+
headers: {
|
|
5109
|
+
[name: string]: unknown;
|
|
5110
|
+
};
|
|
5111
|
+
content: {
|
|
5112
|
+
'application/json': components['schemas']['RefusalInternalError'];
|
|
5113
|
+
};
|
|
5114
|
+
};
|
|
5115
|
+
/** @description SERVICE_INDETERMINATE */
|
|
5116
|
+
503: {
|
|
5117
|
+
headers: {
|
|
5118
|
+
[name: string]: unknown;
|
|
5119
|
+
};
|
|
5120
|
+
content: {
|
|
5121
|
+
'application/json': components['schemas']['RefusalServiceIndeterminate'];
|
|
5122
|
+
};
|
|
5123
|
+
};
|
|
5124
|
+
};
|
|
5125
|
+
};
|
|
4663
5126
|
getEntryVersions: {
|
|
4664
5127
|
parameters: {
|
|
4665
5128
|
query?: {
|
|
@@ -4684,8 +5147,7 @@ interface operations {
|
|
|
4684
5147
|
};
|
|
4685
5148
|
content: {
|
|
4686
5149
|
'application/json': {
|
|
4687
|
-
|
|
4688
|
-
data: unknown;
|
|
5150
|
+
data: components['schemas']['EntryVersionRow'][];
|
|
4689
5151
|
};
|
|
4690
5152
|
};
|
|
4691
5153
|
};
|
|
@@ -4786,8 +5248,7 @@ interface operations {
|
|
|
4786
5248
|
};
|
|
4787
5249
|
content: {
|
|
4788
5250
|
'application/json': {
|
|
4789
|
-
|
|
4790
|
-
data: unknown;
|
|
5251
|
+
data: components['schemas']['EntryVersion'];
|
|
4791
5252
|
};
|
|
4792
5253
|
};
|
|
4793
5254
|
};
|
|
@@ -4934,7 +5395,7 @@ interface operations {
|
|
|
4934
5395
|
[name: string]: unknown;
|
|
4935
5396
|
};
|
|
4936
5397
|
content: {
|
|
4937
|
-
'application/json': components['schemas']['
|
|
5398
|
+
'application/json': components['schemas']['RefusalResourceConflictNamingDraftExistsBlockageOrReleaseLockedBlockageOrSlugTakenBlockage'];
|
|
4938
5399
|
};
|
|
4939
5400
|
};
|
|
4940
5401
|
/** @description RESOURCE_EXPIRED */
|
|
@@ -5957,6 +6418,8 @@ interface operations {
|
|
|
5957
6418
|
runSavedQuery: {
|
|
5958
6419
|
parameters: {
|
|
5959
6420
|
query?: {
|
|
6421
|
+
/** @description A changes-feed cursor at or after the change this read follows — the `fresh` a change carries in `@relyio/sdk`. The answer is the read’s own, unchanged; the term only makes the request one that no cache holds an answer to from before that change. A value that is not a cursor the feed issued is refused. */
|
|
6422
|
+
_fresh?: string;
|
|
5960
6423
|
/** @description The locale to read. Outranks `Accept-Language`. */
|
|
5961
6424
|
locale?: string;
|
|
5962
6425
|
};
|
|
@@ -5971,6 +6434,10 @@ interface operations {
|
|
|
5971
6434
|
/** @description Success. */
|
|
5972
6435
|
200: {
|
|
5973
6436
|
headers: {
|
|
6437
|
+
'Cache-Control'?: string;
|
|
6438
|
+
ETag?: string;
|
|
6439
|
+
Vary?: string;
|
|
6440
|
+
'X-Cache'?: string;
|
|
5974
6441
|
[name: string]: unknown;
|
|
5975
6442
|
};
|
|
5976
6443
|
content: {
|
|
@@ -6066,6 +6533,8 @@ interface operations {
|
|
|
6066
6533
|
runSavedQueryWithBody: {
|
|
6067
6534
|
parameters: {
|
|
6068
6535
|
query?: {
|
|
6536
|
+
/** @description A changes-feed cursor at or after the change this read follows — the `fresh` a change carries in `@relyio/sdk`. The answer is the read’s own, unchanged; the term only makes the request one that no cache holds an answer to from before that change. A value that is not a cursor the feed issued is refused. */
|
|
6537
|
+
_fresh?: string;
|
|
6069
6538
|
/** @description The locale to read. Outranks `Accept-Language`. */
|
|
6070
6539
|
locale?: string;
|
|
6071
6540
|
};
|
|
@@ -6080,6 +6549,8 @@ interface operations {
|
|
|
6080
6549
|
/** @description Success. */
|
|
6081
6550
|
200: {
|
|
6082
6551
|
headers: {
|
|
6552
|
+
'Cache-Control'?: string;
|
|
6553
|
+
'X-Cache'?: string;
|
|
6083
6554
|
[name: string]: unknown;
|
|
6084
6555
|
};
|
|
6085
6556
|
content: {
|
|
@@ -6177,6 +6648,12 @@ interface operations {
|
|
|
6177
6648
|
query?: {
|
|
6178
6649
|
/** @description A changes-feed cursor at or after the change this read follows — the `fresh` a change carries in `@relyio/sdk`. The answer is the read’s own, unchanged; the term only makes the request one that no cache holds an answer to from before that change. A value that is not a cursor the feed issued is refused. */
|
|
6179
6650
|
_fresh?: string;
|
|
6651
|
+
/** @description Return the page after this one: the `page.nextCursor` of the previous answer. Absent, the first page. Only a fetch pages; a cursor is refused on a query that is not one. */
|
|
6652
|
+
cursor?: string;
|
|
6653
|
+
/** @description The locale to read. Outranks `Accept-Language`. Use `*` to retrieve every locale: the default at the top level and the rest in `_metadata.localizations`. */
|
|
6654
|
+
locale?: string;
|
|
6655
|
+
/** @description Comma-separated locales to retrieve. The first is the primary, composed at the top level; the rest go in `_metadata.localizations`. */
|
|
6656
|
+
locales?: string;
|
|
6180
6657
|
};
|
|
6181
6658
|
header?: never;
|
|
6182
6659
|
path?: never;
|
|
@@ -6193,8 +6670,11 @@ interface operations {
|
|
|
6193
6670
|
};
|
|
6194
6671
|
content: {
|
|
6195
6672
|
'application/json': {
|
|
6196
|
-
|
|
6197
|
-
|
|
6673
|
+
data: unknown[];
|
|
6674
|
+
page: components['schemas']['CursorPage'];
|
|
6675
|
+
meta: {
|
|
6676
|
+
[key: string]: unknown;
|
|
6677
|
+
};
|
|
6198
6678
|
};
|
|
6199
6679
|
};
|
|
6200
6680
|
};
|
|
@@ -6870,7 +7350,7 @@ interface operations {
|
|
|
6870
7350
|
[name: string]: unknown;
|
|
6871
7351
|
};
|
|
6872
7352
|
content: {
|
|
6873
|
-
'application/json': components['schemas']['
|
|
7353
|
+
'application/json': components['schemas']['RefusalResourceConflictNamingDraftExistsBlockageOrReleaseLockedBlockageOrSlugTakenBlockage'];
|
|
6874
7354
|
};
|
|
6875
7355
|
};
|
|
6876
7356
|
/** @description RESOURCE_EXPIRED */
|
|
@@ -7089,7 +7569,7 @@ interface operations {
|
|
|
7089
7569
|
[name: string]: unknown;
|
|
7090
7570
|
};
|
|
7091
7571
|
content: {
|
|
7092
|
-
'application/json': components['schemas']['
|
|
7572
|
+
'application/json': components['schemas']['RefusalResourceConflictNamingDraftExistsBlockageOrReleaseLockedBlockageOrSlugTakenBlockage'];
|
|
7093
7573
|
};
|
|
7094
7574
|
};
|
|
7095
7575
|
/** @description RESOURCE_EXPIRED */
|
|
@@ -7162,8 +7642,7 @@ interface operations {
|
|
|
7162
7642
|
};
|
|
7163
7643
|
content: {
|
|
7164
7644
|
'application/json': {
|
|
7165
|
-
|
|
7166
|
-
data: unknown;
|
|
7645
|
+
data: components['schemas']['DocumentVersionHistory'];
|
|
7167
7646
|
};
|
|
7168
7647
|
};
|
|
7169
7648
|
};
|
|
@@ -7263,8 +7742,7 @@ interface operations {
|
|
|
7263
7742
|
};
|
|
7264
7743
|
content: {
|
|
7265
7744
|
'application/json': {
|
|
7266
|
-
|
|
7267
|
-
data: unknown;
|
|
7745
|
+
data: components['schemas']['DocumentVersion'];
|
|
7268
7746
|
};
|
|
7269
7747
|
};
|
|
7270
7748
|
};
|
|
@@ -7517,7 +7995,7 @@ interface operations {
|
|
|
7517
7995
|
[name: string]: unknown;
|
|
7518
7996
|
};
|
|
7519
7997
|
content: {
|
|
7520
|
-
'application/json': components['schemas']['
|
|
7998
|
+
'application/json': components['schemas']['RefusalResourceConflictNamingDraftExistsBlockageOrReleaseLockedBlockageOrSlugTakenBlockage'];
|
|
7521
7999
|
};
|
|
7522
8000
|
};
|
|
7523
8001
|
/** @description RESOURCE_EXPIRED */
|
|
@@ -7687,8 +8165,7 @@ interface operations {
|
|
|
7687
8165
|
};
|
|
7688
8166
|
content: {
|
|
7689
8167
|
'application/json': {
|
|
7690
|
-
|
|
7691
|
-
data: unknown;
|
|
8168
|
+
data: components['schemas']['DocumentVersionHistory'];
|
|
7692
8169
|
};
|
|
7693
8170
|
};
|
|
7694
8171
|
};
|
|
@@ -7788,8 +8265,7 @@ interface operations {
|
|
|
7788
8265
|
};
|
|
7789
8266
|
content: {
|
|
7790
8267
|
'application/json': {
|
|
7791
|
-
|
|
7792
|
-
data: unknown;
|
|
8268
|
+
data: components['schemas']['DocumentVersion'];
|
|
7793
8269
|
};
|
|
7794
8270
|
};
|
|
7795
8271
|
};
|
|
@@ -7885,7 +8361,15 @@ interface RelyIOConfig {
|
|
|
7885
8361
|
apiKey: string;
|
|
7886
8362
|
/** Base URL for the RelyIO API */
|
|
7887
8363
|
baseUrl?: string;
|
|
7888
|
-
/**
|
|
8364
|
+
/**
|
|
8365
|
+
* Dataset to use, sent as `X-RelyIO-Dataset` — an id or a name.
|
|
8366
|
+
*
|
|
8367
|
+
* Which dataset a client reads, first match wins: an active `relyio dev` sandbox; this option; on
|
|
8368
|
+
* a host preview deployment (`VERCEL_ENV=preview`) and with a preview key (`rly_prev_…`), the pull
|
|
8369
|
+
* request's preview, `previewDatasetSlug(VERCEL_GIT_COMMIT_REF)` from `@relyio/sdk/preview` —
|
|
8370
|
+
* never in production, never with a published key, and, once the api answers that no such preview
|
|
8371
|
+
* exists, never again in that process; the key's own default.
|
|
8372
|
+
*/
|
|
7889
8373
|
dataset?: string;
|
|
7890
8374
|
/**
|
|
7891
8375
|
* Default locale for all content queries
|
|
@@ -7923,8 +8407,6 @@ interface RelyIOConfig {
|
|
|
7923
8407
|
* turn off under a framework that caches `fetch` itself (Next.js).
|
|
7924
8408
|
*/
|
|
7925
8409
|
cache?: CacheConfig;
|
|
7926
|
-
/** Real-time configuration */
|
|
7927
|
-
realtime?: RealtimeConfig;
|
|
7928
8410
|
/** Debug configuration */
|
|
7929
8411
|
debug?: DebugConfig;
|
|
7930
8412
|
/** Custom headers to include with requests */
|
|
@@ -8023,7 +8505,6 @@ type LiveWebSocketConstructor = new (url: string) => LiveWebSocket;
|
|
|
8023
8505
|
type RelyIOConfigUpdate = Update<Omit<RelyIOConfig, OptionBag | 'headers'>, UndefaultedOption> & {
|
|
8024
8506
|
browser?: Update<BrowserConfig, UndefaultedField['browser']>;
|
|
8025
8507
|
cache?: Update<CacheConfig, UndefaultedField['cache']>;
|
|
8026
|
-
realtime?: Update<RealtimeConfig, UndefaultedField['realtime']>;
|
|
8027
8508
|
debug?: Update<DebugConfig, UndefaultedField['debug']>;
|
|
8028
8509
|
/** Headers to add or replace, each kept until named again; `null` stops sending that header. */
|
|
8029
8510
|
headers?: Record<string, string | null>;
|
|
@@ -8044,18 +8525,6 @@ interface CacheConfig {
|
|
|
8044
8525
|
/** Cache strategies to use */
|
|
8045
8526
|
strategies?: CacheStrategy[];
|
|
8046
8527
|
}
|
|
8047
|
-
interface RealtimeConfig {
|
|
8048
|
-
/** Whether real-time features are enabled (defaults to true) */
|
|
8049
|
-
enabled?: boolean;
|
|
8050
|
-
/** WebSocket URL for real-time connections */
|
|
8051
|
-
wsUrl?: string;
|
|
8052
|
-
/** Maximum number of reconnection attempts (defaults to 10) */
|
|
8053
|
-
maxReconnectAttempts?: number;
|
|
8054
|
-
/** Reconnection delay in milliseconds (defaults to 1000) */
|
|
8055
|
-
reconnectDelay?: number;
|
|
8056
|
-
/** Heartbeat interval in milliseconds (defaults to 30000) */
|
|
8057
|
-
heartbeatInterval?: number;
|
|
8058
|
-
}
|
|
8059
8528
|
interface DebugConfig {
|
|
8060
8529
|
/** Whether debug mode is enabled (defaults to false) */
|
|
8061
8530
|
enabled?: boolean;
|
|
@@ -8176,7 +8645,7 @@ type WithDefaults<T, NoDefault extends keyof T = never> = Required<Omit<T, NoDef
|
|
|
8176
8645
|
*/
|
|
8177
8646
|
type UndefaultedOption = 'apiKey' | 'dataset' | 'locale' | 'dev' | 'fetch' | 'liveUrl' | 'webSocket';
|
|
8178
8647
|
/** The options that are themselves bags of options, each merged field by field. */
|
|
8179
|
-
type OptionBag = 'browser' | 'cache' | '
|
|
8648
|
+
type OptionBag = 'browser' | 'cache' | 'debug';
|
|
8180
8649
|
/**
|
|
8181
8650
|
* The fields of each bag with no default, absent from a merged configuration until the caller gives
|
|
8182
8651
|
* one — and the fields of a bag `updateConfig()` can clear with `null`.
|
|
@@ -8184,20 +8653,18 @@ type OptionBag = 'browser' | 'cache' | 'realtime' | 'debug';
|
|
|
8184
8653
|
interface UndefaultedField {
|
|
8185
8654
|
browser: 'onCorsError';
|
|
8186
8655
|
cache: never;
|
|
8187
|
-
realtime: 'wsUrl';
|
|
8188
8656
|
debug: 'logger';
|
|
8189
8657
|
}
|
|
8190
8658
|
/**
|
|
8191
8659
|
* The value each option takes when the caller gives none, down to each field of each bag — so a
|
|
8192
8660
|
* field of a merged configuration that has a default is never `undefined`, and a reader does not
|
|
8193
|
-
* restate the default. A field with no default (`onCorsError`, `
|
|
8661
|
+
* restate the default. A field with no default (`onCorsError`, `logger`) is named in
|
|
8194
8662
|
* {@link UndefaultedField}; a field added to a bag without one fails to compile at
|
|
8195
8663
|
* {@link DEFAULT_CONFIG} until it gets a default or a name there.
|
|
8196
8664
|
*/
|
|
8197
8665
|
type ConfigDefaults = WithDefaults<Omit<RelyIOConfig, UndefaultedOption | OptionBag>> & {
|
|
8198
8666
|
browser: WithDefaults<BrowserConfig, UndefaultedField['browser']>;
|
|
8199
8667
|
cache: WithDefaults<CacheConfig, UndefaultedField['cache']>;
|
|
8200
|
-
realtime: WithDefaults<RealtimeConfig, UndefaultedField['realtime']>;
|
|
8201
8668
|
debug: WithDefaults<DebugConfig, UndefaultedField['debug']>;
|
|
8202
8669
|
};
|
|
8203
8670
|
/** The configuration a client runs on: each option the caller gave, and its default where not. */
|
|
@@ -9988,7 +10455,16 @@ declare abstract class SDKError extends Error {
|
|
|
9988
10455
|
*/
|
|
9989
10456
|
isType(errorType: string): boolean;
|
|
9990
10457
|
/**
|
|
9991
|
-
* Create a
|
|
10458
|
+
* Create a copy of this error with additional context.
|
|
10459
|
+
*
|
|
10460
|
+
* The copy is made from this error's own properties, not by calling a constructor: subclasses
|
|
10461
|
+
* declare constructors of their own (violations, a timeout, a feature, a failed index second),
|
|
10462
|
+
* and no single argument order fits them all. Rebuilding through the base order put the status
|
|
10463
|
+
* code in the subclass's second slot. Copying keeps every field, the subclass's own included, and
|
|
10464
|
+
* the original `timestamp` and `stack`, since it is the same failure.
|
|
10465
|
+
*
|
|
10466
|
+
* `Object.create` runs no constructor, so a `#private` field would not survive the copy; none
|
|
10467
|
+
* exist in this directory. `stack` is not an own property on V8 and is copied by hand below.
|
|
9992
10468
|
*/
|
|
9993
10469
|
withContext(context: Record<string, unknown>): this;
|
|
9994
10470
|
}
|
|
@@ -10110,8 +10586,13 @@ type ViewScopeConfig = ContentTypeScopeConfig | ContentTypesScopeConfig | EntryT
|
|
|
10110
10586
|
* written here, so a view pulled by `relyio generate-types` that named one did not compile.
|
|
10111
10587
|
* `@relyio/codegen-typescript`'s `src/__tests__/sdk-definition-config.types.ts` holds the two to each
|
|
10112
10588
|
* other (REL-1457).
|
|
10589
|
+
*
|
|
10590
|
+
* Only spellings some field accepts (REL-1697): `isTrue`, `isFalse`, `today`, `yesterday`,
|
|
10591
|
+
* `thisWeek`, `thisMonth`, `thisYear`, `includes` and `notIncludes` were offered here and refused at
|
|
10592
|
+
* deploy on every field. A boolean is asked `is` with `true` or `false`; a date `isOn` or
|
|
10593
|
+
* `inTheLast`; tags `hasValue` or `isEmpty`.
|
|
10113
10594
|
*/
|
|
10114
|
-
type ViewFilterOperator = 'is' | 'isNot' | 'contains' | 'notContains' | 'startsWith' | 'endsWith' | 'isAnyOf' | 'isNoneOf' | '
|
|
10595
|
+
type ViewFilterOperator = 'is' | 'isNot' | 'contains' | 'notContains' | 'startsWith' | 'endsWith' | 'isAnyOf' | 'isNoneOf' | 'equals' | 'notEquals' | 'greaterThan' | 'lessThan' | 'greaterThanOrEqual' | 'lessThanOrEqual' | 'between' | 'isOn' | 'isBefore' | 'isAfter' | 'isBetween' | 'inTheLast' | 'inTheNext' | 'isEmpty' | 'hasValue';
|
|
10115
10596
|
/** A span of time back or forward from now, for `inTheLast` and `inTheNext`. */
|
|
10116
10597
|
interface ViewFilterRelativeDate {
|
|
10117
10598
|
amount: number;
|
|
@@ -10431,6 +10912,24 @@ type RevisedContent<T extends BaseContent> = Omit<T, '_metadata'> & {
|
|
|
10431
10912
|
type RestoredContent<T extends BaseContent> = Omit<T, '_metadata'> & {
|
|
10432
10913
|
_metadata: T['_metadata'] & Pick<components['schemas']['RestoredEntryMetadata'], 'leftOut' | 'brokenLinks'>;
|
|
10433
10914
|
};
|
|
10915
|
+
/**
|
|
10916
|
+
* One version of an entry, as `version(id, { version })` reads it — the document's `EntryVersion`
|
|
10917
|
+
* (REL-3181): the fields that locale stored when the version was written, at the top level, and
|
|
10918
|
+
* `EntryVersionMetadata`, whose `status` is `'version'` and which names no default or available
|
|
10919
|
+
* locales. Every field is optional: a locale's row holds that locale's own fields, never the shared
|
|
10920
|
+
* ones.
|
|
10921
|
+
*/
|
|
10922
|
+
type ContentVersion<T extends BaseContent> = Partial<Omit<T, '_metadata'>> & {
|
|
10923
|
+
_metadata: components['schemas']['EntryVersionMetadata'];
|
|
10924
|
+
};
|
|
10925
|
+
/**
|
|
10926
|
+
* One row of an entry's history, as `versions(id)` lists it — the document's `EntryVersionRow`
|
|
10927
|
+
* (REL-3269): which version of which locale, who wrote it and when, and the fields that locale
|
|
10928
|
+
* stored, nested under `fields` — its own fields only, never the shared ones.
|
|
10929
|
+
*/
|
|
10930
|
+
type ContentVersionRow<T extends BaseContent> = Omit<components['schemas']['EntryVersionRow'], 'fields'> & {
|
|
10931
|
+
fields: Partial<Omit<T, '_metadata'>>;
|
|
10932
|
+
};
|
|
10434
10933
|
/**
|
|
10435
10934
|
* Content update input - excludes system-managed metadata fields
|
|
10436
10935
|
*/
|
|
@@ -10486,7 +10985,7 @@ interface FieldDefinition {
|
|
|
10486
10985
|
/** Field name */
|
|
10487
10986
|
name: string;
|
|
10488
10987
|
/** Field type */
|
|
10489
|
-
type:
|
|
10988
|
+
type: FieldKind;
|
|
10490
10989
|
/** Display title */
|
|
10491
10990
|
title?: string;
|
|
10492
10991
|
/** Field description */
|
|
@@ -10500,10 +10999,6 @@ interface FieldDefinition {
|
|
|
10500
10999
|
/** Field options */
|
|
10501
11000
|
options?: FieldOptions;
|
|
10502
11001
|
}
|
|
10503
|
-
/**
|
|
10504
|
-
* Supported field type names (string identifiers)
|
|
10505
|
-
*/
|
|
10506
|
-
type FieldTypeName = 'string' | 'number' | 'boolean' | 'date' | 'datetime' | 'text' | 'markdown' | 'richtext' | 'slug' | 'url' | 'email' | 'image' | 'file' | 'reference' | 'array' | 'object' | 'geopoint' | 'color';
|
|
10507
11002
|
/**
|
|
10508
11003
|
* Field validation rules
|
|
10509
11004
|
*/
|
|
@@ -10662,8 +11157,12 @@ type FieldsOfShapes$2<Shape> = Shape extends {
|
|
|
10662
11157
|
type TargetFields<F, S> = F extends {
|
|
10663
11158
|
readonly config?: infer C;
|
|
10664
11159
|
} ? S extends FieldSchemaContext ? FieldsOfDefinition<Declared$1<S['contentTypes'], ReferenceTarget<NonNullable<C>>> | Declared$1<S['singletonContentTypes'], ReferenceTarget<NonNullable<C>>> | Declared$1<NonNullable<S['assetTypes']>, ReferenceTarget<NonNullable<C>>>> : never : never;
|
|
11160
|
+
/**
|
|
11161
|
+
* The fields a definition declares. An asset type's `fields` are optional, so they are read as
|
|
11162
|
+
* optional here — a required `fields` would read every asset as `never` and accept any path (REL-2366).
|
|
11163
|
+
*/
|
|
10665
11164
|
type FieldsOfDefinition<D> = D extends {
|
|
10666
|
-
readonly fields
|
|
11165
|
+
readonly fields?: unknown;
|
|
10667
11166
|
} ? DeclaredFields<D> : never;
|
|
10668
11167
|
/** `true` when a field is a reference, or a list or object holding one at any depth. */
|
|
10669
11168
|
type HoldsReference<F> = F extends AnyFieldDefinition ? IsReference<F> extends true ? true : true extends HoldsReference<ShapeFields<F>> ? true : true extends IsLinkingRichText<F> ? true : false : false;
|
|
@@ -10948,9 +11447,8 @@ interface AssetReading<D extends AnyAssetTypeDefinition, S extends FieldSchemaCo
|
|
|
10948
11447
|
/**
|
|
10949
11448
|
* What its `where` takes: every key the API filters its fields by, as a content type's
|
|
10950
11449
|
* ({@link FilterPaths}) — an asset is an entry on the same routes, held to the same check (REL-2195).
|
|
10951
|
-
* Its `fields` are optional, so they are read with `DeclaredFields`, which takes them so.
|
|
10952
11450
|
*/
|
|
10953
|
-
readonly where: FilterPaths<
|
|
11451
|
+
readonly where: FilterPaths<FieldsOfDefinition<D>, S>;
|
|
10954
11452
|
}
|
|
10955
11453
|
/** A read of the settings group `D` defines, in schema `S`. */
|
|
10956
11454
|
interface SettingsReading<D extends AnySettingsGroupDefinition, S extends FieldSchemaContext | undefined> extends Reading {
|
|
@@ -11903,4 +12401,4 @@ type InferContentType<T extends AnyContentTypeDefinition, S extends FieldSchemaC
|
|
|
11903
12401
|
_metadata: EntryMetadata;
|
|
11904
12402
|
};
|
|
11905
12403
|
|
|
11906
|
-
export { enumField as $, type AIConfig as A, type BaseFieldConfig as B, type CodeConfig as C, type DateConfig as D, type EmailConfig as E, type FieldAIConfig as F, type RuleConditions as G, type SlugConfig as H, type IntegerConfig as I, type JsonConfig as J, type KeyedEnumConfig as K, type ListConfig as L, type TagsConfig as M, type VisibilityRule as N, type ObjectConfig as O, boolean as P, code as Q, type ReadOnlyRule as R, type ShortTextConfig as S, type TableConfig as T, type UrlConfig as U, type ValidationRule$1 as V, type WidgetOptions as W, date as X, dateTime as Y, decimal as Z, email as _, type AnyFieldDefinition as a, type AssetTypeDefinition as a$, integer as a0, json as a1, list as a2, longText as a3, object as a4, reference as a5, richText as a6, shortText as a7, slug as a8, table as a9, type TextDirection as aA, type LocaleOptions as aB, type LocaleDefinition as aC, defineContentType as aD, fieldset as aE, type Fieldset as aF, type DeclaredFieldset as aG, type AnyDeclaredFieldset as aH, type KeyedFieldsetConfig as aI, type FieldMember as aJ, type KeyedContentTypeConfig as aK, type ContentTypeDefinition as aL, type EntryMetadata as aM, type InferContentType as aN, type LocalePublicationFields as aO, defineSingleton as aP, type KeyedSingletonConfig as aQ, type SingletonContentTypeDefinition as aR, type SingletonMetadata as aS, type InferSingleton as aT, defineSettingsGroup as aU, type KeyedSettingsGroupConfig as aV, type SettingsGroupDefinition as aW, type SettingsGroupMetadata as aX, type InferSettingsGroup as aY, defineAssetType as aZ, type KeyedAssetTypeConfig as a_, tags as aa, url as ab, type FieldSchemaContext as ac, type FieldValue as ad, type FieldValues as ae, type DeclaredFields as af, type UnresolvedEntry as ag, type Keyed as ah, type BlockOf as ai, type ShapeValue as aj, type AssetReading as ak, type CheckedIncludes as al, type CheckInclude as am, type ContentReading as an, type IncludablePaths as ao, type Reading as ap, type ReadWith as aq, type SettingsReading as ar, type SingletonReading as as, type UntypedReading as at, defineLocale as au, isLocaleDefinition as av, getLocaleCodes as aw, findDefaultLocale as ax, getActiveLocales as ay, buildFallbackChain as az, type AnyKeyedField as b, type ViewFilterOperator as b$, type InferAssetType as b0, type InferAssetEntry as b1, type AssetServedBlocks as b2, type ImageKindConfig as b3, type VideoKindConfig as b4, type FileKindConfig as b5, type ImageTransform as b6, type ImageFitMode as b7, type ImageOutputFormat as b8, type ImageUploadConfig as b9, type KeyedRolesAsList as bA, defineWorkflow as bB, defineWorkflowStage as bC, defineContentTypeWorkflow as bD, isWorkflowDefinition as bE, isWorkflowStageDefinition as bF, getWorkflowStageIds as bG, findWorkflowStage as bH, getNextWorkflowStage as bI, getFirstWorkflowStage as bJ, isFinalWorkflowStage as bK, type WorkflowEscalation as bL, type WorkflowAutoAssign as bM, type WorkflowStageConfig as bN, type WorkflowStageDefinition as bO, type WorkflowDefinition as bP, type ContentTypeWorkflowConfig as bQ, type KeyedWorkflowConfig as bR, type KeyedWorkflowStageConfig as bS, type KeyedWorkflowStageDefinition as bT, type KeyedWorkflowStages as bU, defineView as bV, type ViewScopeConfig as bW, type ContentTypeScopeConfig as bX, type ContentTypesScopeConfig as bY, type EntryTypeScopeConfig as bZ, type AllScopeConfig as b_, type ImageSourceConfig as ba, type ImageExifConfig as bb, type VariantDefinition as bc, type VideoUploadConfig as bd, type VideoPosterConfig as be, type VideoCaptionsConfig as bf, type VideoDownloadConfig as bg, type VideoWatermarkConfig as bh, type FileUploadConfig as bi, type FileScanConfig as bj, defineRole as bk, isRoleDefinition as bl, isBuiltInRole as bm, getBuiltInRoleActions as bn, BUILT_IN_ROLES as bo, ROLE_ACTIONS as bp, BUILT_IN_ROLE_ACTIONS as bq, type BuiltInRole as br, type RoleAction as bs, type ResourcePermission as bt, type FieldVisibility as bu, type RoleConfig as bv, type RoleDefinition as bw, type KeyedRoleConfig as bx, type KeyedRoleDefinition as by, type KeyedRoles as bz, type AssetAIConfig as c, type paths as c$, type ViewFilterValue as c0, type ViewFilterRelativeDate as c1, type ViewFilterCondition as c2, type ViewFilter as c3, type ViewConfig as c4, type ViewDefinition as c5, type KeyedViewConfig as c6, type KeyedViewDefinition as c7, type KeyedViews as c8, type KeyedViewsAsList as c9, type CreateInput as cA, type RevisedContent as cB, type RestoredContent as cC, type
|
|
12404
|
+
export { enumField as $, type AIConfig as A, type BaseFieldConfig as B, type CodeConfig as C, type DateConfig as D, type EmailConfig as E, type FieldAIConfig as F, type RuleConditions as G, type SlugConfig as H, type IntegerConfig as I, type JsonConfig as J, type KeyedEnumConfig as K, type ListConfig as L, type TagsConfig as M, type VisibilityRule as N, type ObjectConfig as O, boolean as P, code as Q, type ReadOnlyRule as R, type ShortTextConfig as S, type TableConfig as T, type UrlConfig as U, type ValidationRule$1 as V, type WidgetOptions as W, date as X, dateTime as Y, decimal as Z, email as _, type AnyFieldDefinition as a, type AssetTypeDefinition as a$, integer as a0, json as a1, list as a2, longText as a3, object as a4, reference as a5, richText as a6, shortText as a7, slug as a8, table as a9, type TextDirection as aA, type LocaleOptions as aB, type LocaleDefinition as aC, defineContentType as aD, fieldset as aE, type Fieldset as aF, type DeclaredFieldset as aG, type AnyDeclaredFieldset as aH, type KeyedFieldsetConfig as aI, type FieldMember as aJ, type KeyedContentTypeConfig as aK, type ContentTypeDefinition as aL, type EntryMetadata as aM, type InferContentType as aN, type LocalePublicationFields as aO, defineSingleton as aP, type KeyedSingletonConfig as aQ, type SingletonContentTypeDefinition as aR, type SingletonMetadata as aS, type InferSingleton as aT, defineSettingsGroup as aU, type KeyedSettingsGroupConfig as aV, type SettingsGroupDefinition as aW, type SettingsGroupMetadata as aX, type InferSettingsGroup as aY, defineAssetType as aZ, type KeyedAssetTypeConfig as a_, tags as aa, url as ab, type FieldSchemaContext as ac, type FieldValue as ad, type FieldValues as ae, type DeclaredFields as af, type UnresolvedEntry as ag, type Keyed as ah, type BlockOf as ai, type ShapeValue as aj, type AssetReading as ak, type CheckedIncludes as al, type CheckInclude as am, type ContentReading as an, type IncludablePaths as ao, type Reading as ap, type ReadWith as aq, type SettingsReading as ar, type SingletonReading as as, type UntypedReading as at, defineLocale as au, isLocaleDefinition as av, getLocaleCodes as aw, findDefaultLocale as ax, getActiveLocales as ay, buildFallbackChain as az, type AnyKeyedField as b, type ViewFilterOperator as b$, type InferAssetType as b0, type InferAssetEntry as b1, type AssetServedBlocks as b2, type ImageKindConfig as b3, type VideoKindConfig as b4, type FileKindConfig as b5, type ImageTransform as b6, type ImageFitMode as b7, type ImageOutputFormat as b8, type ImageUploadConfig as b9, type KeyedRolesAsList as bA, defineWorkflow as bB, defineWorkflowStage as bC, defineContentTypeWorkflow as bD, isWorkflowDefinition as bE, isWorkflowStageDefinition as bF, getWorkflowStageIds as bG, findWorkflowStage as bH, getNextWorkflowStage as bI, getFirstWorkflowStage as bJ, isFinalWorkflowStage as bK, type WorkflowEscalation as bL, type WorkflowAutoAssign as bM, type WorkflowStageConfig as bN, type WorkflowStageDefinition as bO, type WorkflowDefinition as bP, type ContentTypeWorkflowConfig as bQ, type KeyedWorkflowConfig as bR, type KeyedWorkflowStageConfig as bS, type KeyedWorkflowStageDefinition as bT, type KeyedWorkflowStages as bU, defineView as bV, type ViewScopeConfig as bW, type ContentTypeScopeConfig as bX, type ContentTypesScopeConfig as bY, type EntryTypeScopeConfig as bZ, type AllScopeConfig as b_, type ImageSourceConfig as ba, type ImageExifConfig as bb, type VariantDefinition as bc, type VideoUploadConfig as bd, type VideoPosterConfig as be, type VideoCaptionsConfig as bf, type VideoDownloadConfig as bg, type VideoWatermarkConfig as bh, type FileUploadConfig as bi, type FileScanConfig as bj, defineRole as bk, isRoleDefinition as bl, isBuiltInRole as bm, getBuiltInRoleActions as bn, BUILT_IN_ROLES as bo, ROLE_ACTIONS as bp, BUILT_IN_ROLE_ACTIONS as bq, type BuiltInRole as br, type RoleAction as bs, type ResourcePermission as bt, type FieldVisibility as bu, type RoleConfig as bv, type RoleDefinition as bw, type KeyedRoleConfig as bx, type KeyedRoleDefinition as by, type KeyedRoles as bz, type AssetAIConfig as c, type paths as c$, type ViewFilterValue as c0, type ViewFilterRelativeDate as c1, type ViewFilterCondition as c2, type ViewFilter as c3, type ViewConfig as c4, type ViewDefinition as c5, type KeyedViewConfig as c6, type KeyedViewDefinition as c7, type KeyedViews as c8, type KeyedViewsAsList as c9, type CreateInput as cA, type RevisedContent as cB, type RestoredContent as cC, type ContentVersion as cD, type ContentVersionRow as cE, type UpdateInput as cF, type SingletonContent as cG, type CustomQuery as cH, type ContentTypeSchema as cI, type ValidationRule as cJ, type FieldOptions as cK, type RealtimeEventType as cL, type RealtimeEvent as cM, type SubscriptionOptions as cN, type PerformanceMetrics as cO, type CacheConfig as cP, type DebugConfig as cQ, type RequestConfig as cR, type ApiResponse as cS, type RetryConfig as cT, type CacheStrategy as cU, type LogLevel as cV, type Environment as cW, type ValidationViolation as cX, BaseValidationError as cY, ValidationError as cZ, InvalidPayloadError as c_, type InferJsonSchema as ca, type JsonFieldValue as cb, type JsonSchema as cc, type JsonValue as cd, type CheckedLocales as ce, type CheckedRoles as cf, type CheckedWorkflow as cg, type CheckedSection as ch, type KeysDeclared as ci, type LocaleCodesOf as cj, type StagesDeclared as ck, SDKError as cl, type RelyIOConfig as cm, type RelyIOConfigUpdate as cn, type LiveWebSocket as co, type LiveWebSocketConstructor as cp, type AssetFileBlock as cq, type AssetUrls as cr, type BaseContent as cs, type BaseSingleton as ct, type BaseSettingsGroup as cu, type WhereScalar as cv, type WhereFieldCondition as cw, type WhereClause as cx, type WhereOperator as cy, type DateOnlyOperator as cz, type BooleanConfig as d, type MergedRelyIOConfig as d0, type ReadWhere as d1, type components as d2, type CheckedInclude as d3, type FieldDefinition as d4, type DateTimeConfig as e, type DecimalConfig as f, type EnumConfig as g, type FieldDefinition$1 as h, type FieldRule as i, type FieldType as j, type FieldUIConfig as k, type KeyedField as l, type KeyedFieldOptions as m, type KeyedFields as n, type KeyedFieldsOf as o, type KeyedMembers as p, type KeyedMembersOf as q, type LocalizationConfig as r, type Localized as s, type LocalizedDetails as t, type LongTextConfig as u, type ReferenceConfig as v, type RequirementRule as w, type RichTextConfig as x, type RichTextLinks as y, type RuleCondition as z };
|