@uniformdev/canvas 20.86.1-alpha.3.sha-954b5d18f0 → 20.87.1-alpha.20.sha-e5c7a15309
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/dist/index.d.mts +833 -920
- package/dist/index.d.ts +833 -920
- package/dist/index.esm.js +2 -239
- package/dist/index.js +3 -248
- package/dist/index.mjs +2 -239
- package/package.json +7 -6
package/dist/index.d.mts
CHANGED
|
@@ -2,7 +2,6 @@ import { ApiClient, ClientOptions, ExceptProject, ApiClientError } from '@unifor
|
|
|
2
2
|
export { ApiClientError } from '@uniformdev/context/api';
|
|
3
3
|
import { AssetGetResponseSingle, AssetDefinitionType, AssetParamValue, AssetParamValueItem } from '@uniformdev/assets';
|
|
4
4
|
export { AssetParamValue, AssetParamValueItem } from '@uniformdev/assets';
|
|
5
|
-
import { EndpointOut, EndpointHeadersOut, EndpointTransformationOut } from 'svix';
|
|
6
5
|
import { Quirks, StorageCommands, PersonalizedVariant, VariationMatchMetadata, TestVariant } from '@uniformdev/context';
|
|
7
6
|
import { Options as Options$1 } from 'p-retry';
|
|
8
7
|
import { Options } from 'p-throttle';
|
|
@@ -1941,8 +1940,6 @@ declare const CANVAS_TEST_TYPE = "$test";
|
|
|
1941
1940
|
declare const CANVAS_LOCALIZATION_TYPE = "$localization";
|
|
1942
1941
|
/** Public ID of Canvas slot section component type */
|
|
1943
1942
|
declare const CANVAS_SLOT_SECTION_TYPE = "$slotSection";
|
|
1944
|
-
/** Public ID of Canvas loop component type */
|
|
1945
|
-
declare const CANVAS_LOOP_TYPE = "$loop";
|
|
1946
1943
|
/** Public ID of the intent tag parameter on the Canvas personalization component type */
|
|
1947
1944
|
declare const CANVAS_INTENT_TAG_PARAM = "intentTag";
|
|
1948
1945
|
/** Public ID of the locale parameter on Canvas components */
|
|
@@ -1957,12 +1954,6 @@ declare const CANVAS_TEST_SLOT = "test";
|
|
|
1957
1954
|
declare const CANVAS_LOCALIZATION_SLOT = "localized";
|
|
1958
1955
|
/** Name of the slot on CANVAS_SLOT_SECTION_TYPE */
|
|
1959
1956
|
declare const CANVAS_SLOT_SECTION_SLOT = "$slotSectionItems";
|
|
1960
|
-
/** Name of the slot that CANVAS_LOOP_TYPE exposes for the iterator body */
|
|
1961
|
-
declare const CANVAS_LOOP_SLOT = "body";
|
|
1962
|
-
/** Name of data type that is a derived loop */
|
|
1963
|
-
declare const CANVAS_LOOP_DATA_TYPE = "sys-reserved-loop";
|
|
1964
|
-
/** Name of data type that is a derived alias */
|
|
1965
|
-
declare const CANVAS_ALIAS_DATA_TYPE = "sys-reserved-alias";
|
|
1966
1957
|
/** Name of the 'name' parameter on CANVAS_SLOT_SECTION_TYPE */
|
|
1967
1958
|
declare const CANVAS_SLOT_SECTION_NAME_PARAM = "name";
|
|
1968
1959
|
/** Name of the 'min' parameter on CANVAS_SLOT_SECTION_TYPE */
|
|
@@ -2226,6 +2217,8 @@ interface components$p {
|
|
|
2226
2217
|
* Timestamp when the item was moved to trash. Omitted if not in trash.
|
|
2227
2218
|
*/
|
|
2228
2219
|
deletedAt?: string;
|
|
2220
|
+
/** Present when the item is in trash, omitted otherwise. True when the item was published with no unpublished changes at the moment it was trashed. False otherwise, including items trashed before this field existed. */
|
|
2221
|
+
publishedWhenTrashed?: boolean;
|
|
2229
2222
|
/**
|
|
2230
2223
|
* True if the entry is a pattern (which can be referenced on other entries)
|
|
2231
2224
|
* @defaultValue false
|
|
@@ -3641,6 +3634,12 @@ interface paths$l {
|
|
|
3641
3634
|
releaseId?: string;
|
|
3642
3635
|
/** The state to delete (0 = draft, 64 = published [causes unpublishing], unspecified = all) */
|
|
3643
3636
|
state?: number;
|
|
3637
|
+
/**
|
|
3638
|
+
* Bypass the trash and permanently delete the entry.
|
|
3639
|
+
* Requires team admin rights.
|
|
3640
|
+
* Cannot be combined with releaseId.
|
|
3641
|
+
*/
|
|
3642
|
+
permanent?: boolean;
|
|
3644
3643
|
};
|
|
3645
3644
|
};
|
|
3646
3645
|
};
|
|
@@ -4169,6 +4168,8 @@ interface components$n {
|
|
|
4169
4168
|
* Timestamp when the item was moved to trash. Omitted if not in trash.
|
|
4170
4169
|
*/
|
|
4171
4170
|
deletedAt?: string;
|
|
4171
|
+
/** Present when the item is in trash, omitted otherwise. True when the item was published with no unpublished changes at the moment it was trashed. False otherwise, including items trashed before this field existed. */
|
|
4172
|
+
publishedWhenTrashed?: boolean;
|
|
4172
4173
|
/**
|
|
4173
4174
|
* True if the entry is a pattern (which can be referenced on other entries)
|
|
4174
4175
|
* @defaultValue false
|
|
@@ -6107,329 +6108,45 @@ type LocalePutParameters = LocalesApi['put']['requestBody']['content']['applicat
|
|
|
6107
6108
|
type LocaleDeleteParameters = LocalesApi['delete']['requestBody']['content']['application/json'];
|
|
6108
6109
|
declare const LOCALE_DYNAMIC_INPUT_NAME = "locale";
|
|
6109
6110
|
|
|
6110
|
-
interface paths$d {
|
|
6111
|
-
"/api/v1/views": {
|
|
6112
|
-
parameters: {
|
|
6113
|
-
query?: never;
|
|
6114
|
-
header?: never;
|
|
6115
|
-
path?: never;
|
|
6116
|
-
cookie?: never;
|
|
6117
|
-
};
|
|
6118
|
-
/** Lists saved views for a project + resource type. */
|
|
6119
|
-
get: {
|
|
6120
|
-
parameters: {
|
|
6121
|
-
query: {
|
|
6122
|
-
/** Project the views belong to. */
|
|
6123
|
-
projectId: string;
|
|
6124
|
-
/** Resource type these views apply to (e.g. "entry"). */
|
|
6125
|
-
resourceType: "composition" | "compositionPattern" | "component" | "componentPattern" | "entry" | "entryPattern" | "contentType" | "blockType" | "release" | "signal" | "intent" | "audience" | "asset";
|
|
6126
|
-
/** Number of records to skip. */
|
|
6127
|
-
offset?: number | null;
|
|
6128
|
-
/** Maximum number of records to return. */
|
|
6129
|
-
limit?: number;
|
|
6130
|
-
};
|
|
6131
|
-
header?: never;
|
|
6132
|
-
path?: never;
|
|
6133
|
-
cookie?: never;
|
|
6134
|
-
};
|
|
6135
|
-
requestBody?: never;
|
|
6136
|
-
responses: {
|
|
6137
|
-
/** OK */
|
|
6138
|
-
200: {
|
|
6139
|
-
headers: {
|
|
6140
|
-
[name: string]: unknown;
|
|
6141
|
-
};
|
|
6142
|
-
content: {
|
|
6143
|
-
"application/json": {
|
|
6144
|
-
views: {
|
|
6145
|
-
name: string;
|
|
6146
|
-
description?: string;
|
|
6147
|
-
searchTerm?: string;
|
|
6148
|
-
filters: {
|
|
6149
|
-
field: string;
|
|
6150
|
-
dynamicField?: string;
|
|
6151
|
-
operator: string;
|
|
6152
|
-
value: string | string[];
|
|
6153
|
-
}[];
|
|
6154
|
-
sort?: string[];
|
|
6155
|
-
shared: boolean;
|
|
6156
|
-
icon?: string;
|
|
6157
|
-
id: string;
|
|
6158
|
-
projectId: string;
|
|
6159
|
-
/** @enum {string} */
|
|
6160
|
-
resourceType: "composition" | "compositionPattern" | "component" | "componentPattern" | "entry" | "entryPattern" | "contentType" | "blockType" | "release" | "signal" | "intent" | "audience" | "asset";
|
|
6161
|
-
createdBy: string | null;
|
|
6162
|
-
/** Format: date-time */
|
|
6163
|
-
created: string;
|
|
6164
|
-
/** Format: date-time */
|
|
6165
|
-
modified: string;
|
|
6166
|
-
}[];
|
|
6167
|
-
totalCount: number;
|
|
6168
|
-
};
|
|
6169
|
-
};
|
|
6170
|
-
};
|
|
6171
|
-
400: components$f["responses"]["BadRequestError"];
|
|
6172
|
-
401: components$f["responses"]["UnauthorizedError"];
|
|
6173
|
-
403: components$f["responses"]["ForbiddenError"];
|
|
6174
|
-
429: components$f["responses"]["RateLimitError"];
|
|
6175
|
-
500: components$f["responses"]["InternalServerError"];
|
|
6176
|
-
};
|
|
6177
|
-
};
|
|
6178
|
-
/** Create-or-replace a saved view by id. The caller mints the UUID. Omitted optional fields are cleared. `shared` may only be promoted (personal → shared); demotion returns 400. `projectId` and `resourceType` are immutable after create. */
|
|
6179
|
-
put: {
|
|
6180
|
-
parameters: {
|
|
6181
|
-
query?: never;
|
|
6182
|
-
header?: never;
|
|
6183
|
-
path?: never;
|
|
6184
|
-
cookie?: never;
|
|
6185
|
-
};
|
|
6186
|
-
requestBody: {
|
|
6187
|
-
content: {
|
|
6188
|
-
"application/json": {
|
|
6189
|
-
name: string;
|
|
6190
|
-
description?: string;
|
|
6191
|
-
searchTerm?: string;
|
|
6192
|
-
filters: {
|
|
6193
|
-
field: string;
|
|
6194
|
-
dynamicField?: string;
|
|
6195
|
-
operator: string;
|
|
6196
|
-
value: string | string[];
|
|
6197
|
-
}[];
|
|
6198
|
-
sort?: string[];
|
|
6199
|
-
shared: boolean;
|
|
6200
|
-
icon?: string;
|
|
6201
|
-
id: string;
|
|
6202
|
-
projectId: string;
|
|
6203
|
-
/** @enum {string} */
|
|
6204
|
-
resourceType: "composition" | "compositionPattern" | "component" | "componentPattern" | "entry" | "entryPattern" | "contentType" | "blockType" | "release" | "signal" | "intent" | "audience" | "asset";
|
|
6205
|
-
};
|
|
6206
|
-
};
|
|
6207
|
-
};
|
|
6208
|
-
responses: {
|
|
6209
|
-
/** OK */
|
|
6210
|
-
200: {
|
|
6211
|
-
headers: {
|
|
6212
|
-
[name: string]: unknown;
|
|
6213
|
-
};
|
|
6214
|
-
content: {
|
|
6215
|
-
"application/json": {
|
|
6216
|
-
name: string;
|
|
6217
|
-
description?: string;
|
|
6218
|
-
searchTerm?: string;
|
|
6219
|
-
filters: {
|
|
6220
|
-
field: string;
|
|
6221
|
-
dynamicField?: string;
|
|
6222
|
-
operator: string;
|
|
6223
|
-
value: string | string[];
|
|
6224
|
-
}[];
|
|
6225
|
-
sort?: string[];
|
|
6226
|
-
shared: boolean;
|
|
6227
|
-
icon?: string;
|
|
6228
|
-
id: string;
|
|
6229
|
-
projectId: string;
|
|
6230
|
-
/** @enum {string} */
|
|
6231
|
-
resourceType: "composition" | "compositionPattern" | "component" | "componentPattern" | "entry" | "entryPattern" | "contentType" | "blockType" | "release" | "signal" | "intent" | "audience" | "asset";
|
|
6232
|
-
createdBy: string | null;
|
|
6233
|
-
/** Format: date-time */
|
|
6234
|
-
created: string;
|
|
6235
|
-
/** Format: date-time */
|
|
6236
|
-
modified: string;
|
|
6237
|
-
};
|
|
6238
|
-
};
|
|
6239
|
-
};
|
|
6240
|
-
400: components$f["responses"]["BadRequestError"];
|
|
6241
|
-
401: components$f["responses"]["UnauthorizedError"];
|
|
6242
|
-
403: components$f["responses"]["ForbiddenError"];
|
|
6243
|
-
/** View not found (or belongs to another project). */
|
|
6244
|
-
404: {
|
|
6245
|
-
headers: {
|
|
6246
|
-
[name: string]: unknown;
|
|
6247
|
-
};
|
|
6248
|
-
content?: never;
|
|
6249
|
-
};
|
|
6250
|
-
/** Quota exceeded: at most 100 saved views allowed for this project + resource type + user. Remove an existing view before creating a new one. */
|
|
6251
|
-
409: {
|
|
6252
|
-
headers: {
|
|
6253
|
-
[name: string]: unknown;
|
|
6254
|
-
};
|
|
6255
|
-
content?: never;
|
|
6256
|
-
};
|
|
6257
|
-
429: components$f["responses"]["RateLimitError"];
|
|
6258
|
-
500: components$f["responses"]["InternalServerError"];
|
|
6259
|
-
};
|
|
6260
|
-
};
|
|
6261
|
-
post?: never;
|
|
6262
|
-
/** Deletes a saved view by id. */
|
|
6263
|
-
delete: {
|
|
6264
|
-
parameters: {
|
|
6265
|
-
query?: never;
|
|
6266
|
-
header?: never;
|
|
6267
|
-
path?: never;
|
|
6268
|
-
cookie?: never;
|
|
6269
|
-
};
|
|
6270
|
-
requestBody: {
|
|
6271
|
-
content: {
|
|
6272
|
-
"application/json": {
|
|
6273
|
-
id: string;
|
|
6274
|
-
projectId: string;
|
|
6275
|
-
};
|
|
6276
|
-
};
|
|
6277
|
-
};
|
|
6278
|
-
responses: {
|
|
6279
|
-
/** No Content */
|
|
6280
|
-
204: {
|
|
6281
|
-
headers: {
|
|
6282
|
-
[name: string]: unknown;
|
|
6283
|
-
};
|
|
6284
|
-
content: {
|
|
6285
|
-
"application/json": string;
|
|
6286
|
-
};
|
|
6287
|
-
};
|
|
6288
|
-
400: components$f["responses"]["BadRequestError"];
|
|
6289
|
-
401: components$f["responses"]["UnauthorizedError"];
|
|
6290
|
-
403: components$f["responses"]["ForbiddenError"];
|
|
6291
|
-
/** View not found. */
|
|
6292
|
-
404: {
|
|
6293
|
-
headers: {
|
|
6294
|
-
[name: string]: unknown;
|
|
6295
|
-
};
|
|
6296
|
-
content?: never;
|
|
6297
|
-
};
|
|
6298
|
-
429: components$f["responses"]["RateLimitError"];
|
|
6299
|
-
500: components$f["responses"]["InternalServerError"];
|
|
6300
|
-
};
|
|
6301
|
-
};
|
|
6302
|
-
/** Handles preflight requests. This endpoint allows CORS. */
|
|
6303
|
-
options: {
|
|
6304
|
-
parameters: {
|
|
6305
|
-
query?: never;
|
|
6306
|
-
header?: never;
|
|
6307
|
-
path?: never;
|
|
6308
|
-
cookie?: never;
|
|
6309
|
-
};
|
|
6310
|
-
requestBody?: never;
|
|
6311
|
-
responses: {
|
|
6312
|
-
/** ok */
|
|
6313
|
-
204: {
|
|
6314
|
-
headers: {
|
|
6315
|
-
[name: string]: unknown;
|
|
6316
|
-
};
|
|
6317
|
-
content?: never;
|
|
6318
|
-
};
|
|
6319
|
-
};
|
|
6320
|
-
};
|
|
6321
|
-
head?: never;
|
|
6322
|
-
patch?: never;
|
|
6323
|
-
trace?: never;
|
|
6324
|
-
};
|
|
6325
|
-
}
|
|
6326
6111
|
interface components$f {
|
|
6327
6112
|
schemas: {
|
|
6328
|
-
|
|
6329
|
-
|
|
6330
|
-
|
|
6113
|
+
RouteResponse: components$f["schemas"]["RouteResponseRedirect"] | components$f["schemas"]["RouteResponseComposition"] | components$f["schemas"]["RouteResponseNotFound"];
|
|
6114
|
+
/** The route matches a redirection configured in Uniform */
|
|
6115
|
+
RouteResponseRedirect: {
|
|
6116
|
+
/** The route that was matched in the redirects */
|
|
6117
|
+
matchedRoute: string;
|
|
6118
|
+
dynamicInputs?: components$f["schemas"]["RouteDynamicInputs"];
|
|
6119
|
+
/** @enum {string} */
|
|
6120
|
+
type: "redirect";
|
|
6121
|
+
redirect: components$f["schemas"]["Redirect"];
|
|
6331
6122
|
};
|
|
6332
|
-
|
|
6333
|
-
|
|
6334
|
-
|
|
6335
|
-
|
|
6336
|
-
|
|
6337
|
-
|
|
6338
|
-
|
|
6339
|
-
|
|
6340
|
-
|
|
6341
|
-
|
|
6123
|
+
/**
|
|
6124
|
+
* The route matches a composition.
|
|
6125
|
+
* If any dynamic segments or query parameters are present in the route, they will be returned as dynamic inputs in the response
|
|
6126
|
+
*/
|
|
6127
|
+
RouteResponseComposition: {
|
|
6128
|
+
/** The route that was matched in the project map */
|
|
6129
|
+
matchedRoute: string;
|
|
6130
|
+
dynamicInputs?: components$f["schemas"]["RouteDynamicInputs"];
|
|
6131
|
+
/**
|
|
6132
|
+
* Indicates the data variant that was fetched for data resources.
|
|
6133
|
+
* undefined: Data resources were resolved using published data from their data source
|
|
6134
|
+
* unpublished: Data resources which support unpublished data retrieved unpublished data from their data source. Data resources that did not support unpublished data retrieved published data instead.
|
|
6135
|
+
|
|
6136
|
+
*/
|
|
6137
|
+
dataResourcesVariant?: "unpublished";
|
|
6138
|
+
/** @enum {string} */
|
|
6139
|
+
type: "composition";
|
|
6140
|
+
compositionApiResponse: components$f["schemas"]["CompositionApiResponse"];
|
|
6342
6141
|
};
|
|
6343
|
-
/**
|
|
6344
|
-
|
|
6345
|
-
|
|
6346
|
-
|
|
6347
|
-
|
|
6348
|
-
|
|
6349
|
-
|
|
6350
|
-
|
|
6351
|
-
};
|
|
6352
|
-
/** Permission was denied */
|
|
6353
|
-
ForbiddenError: {
|
|
6354
|
-
headers: {
|
|
6355
|
-
[name: string]: unknown;
|
|
6356
|
-
};
|
|
6357
|
-
content: {
|
|
6358
|
-
"application/json": components$f["schemas"]["Error"];
|
|
6359
|
-
};
|
|
6360
|
-
};
|
|
6361
|
-
/** Too many requests in allowed time period */
|
|
6362
|
-
RateLimitError: {
|
|
6363
|
-
headers: {
|
|
6364
|
-
[name: string]: unknown;
|
|
6365
|
-
};
|
|
6366
|
-
content?: never;
|
|
6367
|
-
};
|
|
6368
|
-
/** Execution error occurred */
|
|
6369
|
-
InternalServerError: {
|
|
6370
|
-
headers: {
|
|
6371
|
-
[name: string]: unknown;
|
|
6372
|
-
};
|
|
6373
|
-
content?: never;
|
|
6374
|
-
};
|
|
6375
|
-
};
|
|
6376
|
-
parameters: never;
|
|
6377
|
-
requestBodies: never;
|
|
6378
|
-
headers: never;
|
|
6379
|
-
pathItems: never;
|
|
6380
|
-
}
|
|
6381
|
-
|
|
6382
|
-
type ViewsApi = paths$d['/api/v1/views'];
|
|
6383
|
-
type ViewsQuery = ViewsApi['get']['parameters']['query'];
|
|
6384
|
-
type ViewPut = ViewsApi['put']['requestBody']['content']['application/json'];
|
|
6385
|
-
type ViewDelete = ViewsApi['delete']['requestBody']['content']['application/json'];
|
|
6386
|
-
type ViewsResponse = ViewsApi['get']['responses']['200']['content']['application/json'];
|
|
6387
|
-
type View = ViewsResponse['views'][number];
|
|
6388
|
-
/**
|
|
6389
|
-
* File/sync shape for a shared custom view. Audit fields and `projectId` are
|
|
6390
|
-
* stripped on pull; `id` is kept so PUT is create-or-replace across projects.
|
|
6391
|
-
*/
|
|
6392
|
-
type SerializedCustomView = Omit<View, 'projectId' | 'createdBy' | 'created' | 'modified'>;
|
|
6393
|
-
|
|
6394
|
-
interface components$e {
|
|
6395
|
-
schemas: {
|
|
6396
|
-
RouteResponse: components$e["schemas"]["RouteResponseRedirect"] | components$e["schemas"]["RouteResponseComposition"] | components$e["schemas"]["RouteResponseNotFound"];
|
|
6397
|
-
/** The route matches a redirection configured in Uniform */
|
|
6398
|
-
RouteResponseRedirect: {
|
|
6399
|
-
/** The route that was matched in the redirects */
|
|
6400
|
-
matchedRoute: string;
|
|
6401
|
-
dynamicInputs?: components$e["schemas"]["RouteDynamicInputs"];
|
|
6402
|
-
/** @enum {string} */
|
|
6403
|
-
type: "redirect";
|
|
6404
|
-
redirect: components$e["schemas"]["Redirect"];
|
|
6405
|
-
};
|
|
6406
|
-
/**
|
|
6407
|
-
* The route matches a composition.
|
|
6408
|
-
* If any dynamic segments or query parameters are present in the route, they will be returned as dynamic inputs in the response
|
|
6409
|
-
*/
|
|
6410
|
-
RouteResponseComposition: {
|
|
6411
|
-
/** The route that was matched in the project map */
|
|
6412
|
-
matchedRoute: string;
|
|
6413
|
-
dynamicInputs?: components$e["schemas"]["RouteDynamicInputs"];
|
|
6414
|
-
/**
|
|
6415
|
-
* Indicates the data variant that was fetched for data resources.
|
|
6416
|
-
* undefined: Data resources were resolved using published data from their data source
|
|
6417
|
-
* unpublished: Data resources which support unpublished data retrieved unpublished data from their data source. Data resources that did not support unpublished data retrieved published data instead.
|
|
6418
|
-
|
|
6419
|
-
*/
|
|
6420
|
-
dataResourcesVariant?: "unpublished";
|
|
6421
|
-
/** @enum {string} */
|
|
6422
|
-
type: "composition";
|
|
6423
|
-
compositionApiResponse: components$e["schemas"]["CompositionApiResponse"];
|
|
6424
|
-
};
|
|
6425
|
-
/**
|
|
6426
|
-
* The route does not match any configured redirections or compositions.
|
|
6427
|
-
* NOTE: This response differs from a HTTP 404, which indicates that the project map or project ID was not found.
|
|
6428
|
-
* Receiving this response with HTTP 200 means that the project was found, but the route did not match anything
|
|
6429
|
-
*/
|
|
6430
|
-
RouteResponseNotFound: {
|
|
6431
|
-
/** @enum {string} */
|
|
6432
|
-
type: "notFound";
|
|
6142
|
+
/**
|
|
6143
|
+
* The route does not match any configured redirections or compositions.
|
|
6144
|
+
* NOTE: This response differs from a HTTP 404, which indicates that the project map or project ID was not found.
|
|
6145
|
+
* Receiving this response with HTTP 200 means that the project was found, but the route did not match anything
|
|
6146
|
+
*/
|
|
6147
|
+
RouteResponseNotFound: {
|
|
6148
|
+
/** @enum {string} */
|
|
6149
|
+
type: "notFound";
|
|
6433
6150
|
};
|
|
6434
6151
|
RouteDynamicInputs: {
|
|
6435
6152
|
[key: string]: string;
|
|
@@ -6538,11 +6255,11 @@ interface components$e {
|
|
|
6538
6255
|
|
|
6539
6256
|
*/
|
|
6540
6257
|
op?: "&" | "|";
|
|
6541
|
-
clauses: (components$
|
|
6258
|
+
clauses: (components$f["schemas"]["VisibilityCriteria"] | components$f["schemas"]["VisibilityCriteriaGroup"])[];
|
|
6542
6259
|
};
|
|
6543
6260
|
/** Defines a conditional value for a component parameter */
|
|
6544
6261
|
ComponentParameterConditionalValue: {
|
|
6545
|
-
when: components$
|
|
6262
|
+
when: components$f["schemas"]["VisibilityCriteriaGroup"];
|
|
6546
6263
|
/**
|
|
6547
6264
|
* The value of the parameter. Any JSON-serializable value is acceptable.
|
|
6548
6265
|
* A value of `null` will cause the parameter value to be removed, if it matches.
|
|
@@ -6564,7 +6281,7 @@ interface components$e {
|
|
|
6564
6281
|
*
|
|
6565
6282
|
* When no locale is passed to a non-route API, conditions are not processed and all conditions are returned.
|
|
6566
6283
|
*/
|
|
6567
|
-
ComponentParameterConditions: components$
|
|
6284
|
+
ComponentParameterConditions: components$f["schemas"]["ComponentParameterConditionalValue"][];
|
|
6568
6285
|
/** Defines an editable parameter on a component */
|
|
6569
6286
|
ComponentParameter: {
|
|
6570
6287
|
/** The value of the parameter. Any JSON-serializable value is acceptable */
|
|
@@ -6572,7 +6289,7 @@ interface components$e {
|
|
|
6572
6289
|
/** The type of the parameter. Determines how it is displayed when editing and tells the consumer how to process it */
|
|
6573
6290
|
type: string;
|
|
6574
6291
|
/** @deprecated */
|
|
6575
|
-
connectedData?: components$
|
|
6292
|
+
connectedData?: components$f["schemas"]["DataElementConnectionDefinition"];
|
|
6576
6293
|
/**
|
|
6577
6294
|
* Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
|
|
6578
6295
|
* Note that locales must be registered on the entry/composition `_locales` before being used
|
|
@@ -6580,10 +6297,10 @@ interface components$e {
|
|
|
6580
6297
|
locales?: {
|
|
6581
6298
|
[key: string]: unknown;
|
|
6582
6299
|
};
|
|
6583
|
-
conditions?: components$
|
|
6300
|
+
conditions?: components$f["schemas"]["ComponentParameterConditions"];
|
|
6584
6301
|
/** Locale-specific conditional values for this parameter. Keys are locale codes, and values are the `conditions` for that locale. */
|
|
6585
6302
|
localesConditions?: {
|
|
6586
|
-
[key: string]: components$
|
|
6303
|
+
[key: string]: components$f["schemas"]["ComponentParameterConditions"];
|
|
6587
6304
|
};
|
|
6588
6305
|
};
|
|
6589
6306
|
ProjectMapNodeAllowedQueryString: {
|
|
@@ -6618,7 +6335,7 @@ interface components$e {
|
|
|
6618
6335
|
/** While performing a search if a node is a hit, this property will return true. If it's supporting structure, like a parent of a search hit, it will return false */
|
|
6619
6336
|
isSearchHit?: boolean;
|
|
6620
6337
|
/** Query strings that are allowed to be passed to the node */
|
|
6621
|
-
queryStrings?: components$
|
|
6338
|
+
queryStrings?: components$f["schemas"]["ProjectMapNodeAllowedQueryString"][];
|
|
6622
6339
|
/**
|
|
6623
6340
|
* For dynamic nodes, this is the preview value for the dynamic value.
|
|
6624
6341
|
* The preview value is used when editing a connected composition, and is the default
|
|
@@ -6643,7 +6360,7 @@ interface components$e {
|
|
|
6643
6360
|
* Unique identifier for the project map that this node belongs to
|
|
6644
6361
|
*/
|
|
6645
6362
|
projectMapId: string;
|
|
6646
|
-
data?: components$
|
|
6363
|
+
data?: components$f["schemas"]["ProjectMapNodeData"];
|
|
6647
6364
|
/**
|
|
6648
6365
|
* Locale-specific paths of the project map node.
|
|
6649
6366
|
* Keys are locale codes
|
|
@@ -6663,13 +6380,13 @@ interface components$e {
|
|
|
6663
6380
|
type: string;
|
|
6664
6381
|
/** Component parameter values for the component instance */
|
|
6665
6382
|
parameters?: {
|
|
6666
|
-
[key: string]: components$
|
|
6383
|
+
[key: string]: components$f["schemas"]["ComponentParameter"];
|
|
6667
6384
|
};
|
|
6668
6385
|
/** Public ID of alternate visual appearance for this component, if any selected */
|
|
6669
6386
|
variant?: string;
|
|
6670
6387
|
/** Slots containing any child components */
|
|
6671
6388
|
slots?: {
|
|
6672
|
-
[key: string]: components$
|
|
6389
|
+
[key: string]: components$f["schemas"]["ComponentInstance"][];
|
|
6673
6390
|
};
|
|
6674
6391
|
/**
|
|
6675
6392
|
* Unique identifier of the component within the composition.
|
|
@@ -6680,20 +6397,20 @@ interface components$e {
|
|
|
6680
6397
|
_id?: string;
|
|
6681
6398
|
/** Indicates this component instance should be sourced from a pattern library pattern */
|
|
6682
6399
|
_pattern?: string;
|
|
6683
|
-
_dataResources?: components$
|
|
6400
|
+
_dataResources?: components$f["schemas"]["DataResourceDefinitions"];
|
|
6684
6401
|
/**
|
|
6685
6402
|
* Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
|
6686
6403
|
* Means nothing for PUTs; it will be ignored
|
|
6687
6404
|
*/
|
|
6688
6405
|
_patternDataResources?: {
|
|
6689
|
-
[key: string]: components$
|
|
6406
|
+
[key: string]: components$f["schemas"]["DataResourceDefinition"];
|
|
6690
6407
|
};
|
|
6691
6408
|
/**
|
|
6692
6409
|
* Query-string opt-ins coming from a pattern resolved for this component.
|
|
6693
6410
|
* Means nothing for PUTs; it will be ignored
|
|
6694
6411
|
*/
|
|
6695
6412
|
_patternOptedInQueryStrings?: string[];
|
|
6696
|
-
_patternError?: components$
|
|
6413
|
+
_patternError?: components$f["schemas"]["PatternError"];
|
|
6697
6414
|
/**
|
|
6698
6415
|
* Defines patch overrides to component IDs that live in the composition.
|
|
6699
6416
|
* This can be used to override parameters that are defined on patterns,
|
|
@@ -6707,14 +6424,14 @@ interface components$e {
|
|
|
6707
6424
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
6708
6425
|
*/
|
|
6709
6426
|
_overrides?: {
|
|
6710
|
-
[key: string]: components$
|
|
6427
|
+
[key: string]: components$f["schemas"]["ComponentOverride"];
|
|
6711
6428
|
};
|
|
6712
6429
|
/**
|
|
6713
6430
|
* Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
|
|
6714
6431
|
* Means nothing for PUTs; it will be ignored
|
|
6715
6432
|
*/
|
|
6716
6433
|
_patternOverrides?: {
|
|
6717
|
-
[key: string]: components$
|
|
6434
|
+
[key: string]: components$f["schemas"]["ComponentOverride"];
|
|
6718
6435
|
};
|
|
6719
6436
|
/**
|
|
6720
6437
|
* When used on a pattern, defines how the pattern's parameters may be overridden
|
|
@@ -6723,7 +6440,7 @@ interface components$e {
|
|
|
6723
6440
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
6724
6441
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
6725
6442
|
*/
|
|
6726
|
-
_overridability?: components$
|
|
6443
|
+
_overridability?: components$f["schemas"]["ComponentOverridability"];
|
|
6727
6444
|
/** Array of locales that have data defined. Only set for pattern references or composition defaults */
|
|
6728
6445
|
_locales?: string[];
|
|
6729
6446
|
};
|
|
@@ -6748,14 +6465,14 @@ interface components$e {
|
|
|
6748
6465
|
* If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
|
|
6749
6466
|
*/
|
|
6750
6467
|
optionalPatternParameter?: boolean;
|
|
6751
|
-
variables?: components$
|
|
6468
|
+
variables?: components$f["schemas"]["DataResourceVariables"];
|
|
6752
6469
|
};
|
|
6753
6470
|
/**
|
|
6754
6471
|
* Data definitions attached to this component. The property name is the key of the data in the data document.
|
|
6755
6472
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key)
|
|
6756
6473
|
*/
|
|
6757
6474
|
DataResourceDefinitions: {
|
|
6758
|
-
[key: string]: components$
|
|
6475
|
+
[key: string]: components$f["schemas"]["DataResourceDefinition"];
|
|
6759
6476
|
};
|
|
6760
6477
|
/**
|
|
6761
6478
|
* Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
|
@@ -6773,10 +6490,10 @@ interface components$e {
|
|
|
6773
6490
|
*/
|
|
6774
6491
|
ComponentOverride: {
|
|
6775
6492
|
parameters?: {
|
|
6776
|
-
[key: string]: components$
|
|
6493
|
+
[key: string]: components$f["schemas"]["ComponentParameter"];
|
|
6777
6494
|
};
|
|
6778
6495
|
slots?: {
|
|
6779
|
-
[key: string]: components$
|
|
6496
|
+
[key: string]: components$f["schemas"]["ComponentInstance"][];
|
|
6780
6497
|
};
|
|
6781
6498
|
variant?: string;
|
|
6782
6499
|
/**
|
|
@@ -6785,7 +6502,7 @@ interface components$e {
|
|
|
6785
6502
|
* Overrides defined here replace values in either _dataResources or _patternDataResources on the target component.
|
|
6786
6503
|
*/
|
|
6787
6504
|
dataResources?: {
|
|
6788
|
-
[key: string]: components$
|
|
6505
|
+
[key: string]: components$f["schemas"]["DataResourceDefinition"];
|
|
6789
6506
|
};
|
|
6790
6507
|
};
|
|
6791
6508
|
/**
|
|
@@ -6806,7 +6523,7 @@ interface components$e {
|
|
|
6806
6523
|
ComponentOverridability: {
|
|
6807
6524
|
/** Defines component parameter value overrides. Keys are the parameter public ID */
|
|
6808
6525
|
parameters?: {
|
|
6809
|
-
[key: string]: components$
|
|
6526
|
+
[key: string]: components$f["schemas"]["OverrideOptions"];
|
|
6810
6527
|
};
|
|
6811
6528
|
/** Allows overriding a display variant is allowed if it is defined on the component the pattern is derived from. Default = false */
|
|
6812
6529
|
variants?: boolean;
|
|
@@ -6823,15 +6540,15 @@ interface components$e {
|
|
|
6823
6540
|
type: string;
|
|
6824
6541
|
/** Component parameter values for the component instance */
|
|
6825
6542
|
parameters?: {
|
|
6826
|
-
[key: string]: components$
|
|
6543
|
+
[key: string]: components$f["schemas"]["ComponentParameter"];
|
|
6827
6544
|
};
|
|
6828
6545
|
/** Public ID of alternate visual appearance for this component, if any selected */
|
|
6829
6546
|
variant?: string;
|
|
6830
6547
|
/** Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated */
|
|
6831
|
-
projectMapNodes?: components$
|
|
6548
|
+
projectMapNodes?: components$f["schemas"]["CompositionProjectMapNodeInfo"][];
|
|
6832
6549
|
/** Slots containing any child components */
|
|
6833
6550
|
slots?: {
|
|
6834
|
-
[key: string]: components$
|
|
6551
|
+
[key: string]: components$f["schemas"]["ComponentInstance"][];
|
|
6835
6552
|
};
|
|
6836
6553
|
/** The ID of the composition */
|
|
6837
6554
|
_id: string;
|
|
@@ -6854,15 +6571,15 @@ interface components$e {
|
|
|
6854
6571
|
* Means nothing for PUTs; it will be ignored
|
|
6855
6572
|
*/
|
|
6856
6573
|
_patternDataResources?: {
|
|
6857
|
-
[key: string]: components$
|
|
6574
|
+
[key: string]: components$f["schemas"]["DataResourceDefinition"];
|
|
6858
6575
|
};
|
|
6859
6576
|
/**
|
|
6860
6577
|
* Query-string opt-ins coming from a pattern resolved for this component.
|
|
6861
6578
|
* Means nothing for PUTs; it will be ignored
|
|
6862
6579
|
*/
|
|
6863
6580
|
_patternOptedInQueryStrings?: string[];
|
|
6864
|
-
_dataResources?: components$
|
|
6865
|
-
_patternError?: components$
|
|
6581
|
+
_dataResources?: components$f["schemas"]["DataResourceDefinitions"];
|
|
6582
|
+
_patternError?: components$f["schemas"]["PatternError"];
|
|
6866
6583
|
/**
|
|
6867
6584
|
* Defines patch overrides to component IDs that live in the composition.
|
|
6868
6585
|
* This can be used to override parameters that are defined on patterns,
|
|
@@ -6876,14 +6593,14 @@ interface components$e {
|
|
|
6876
6593
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
6877
6594
|
*/
|
|
6878
6595
|
_overrides?: {
|
|
6879
|
-
[key: string]: components$
|
|
6596
|
+
[key: string]: components$f["schemas"]["ComponentOverride"];
|
|
6880
6597
|
};
|
|
6881
6598
|
/**
|
|
6882
6599
|
* Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
|
|
6883
6600
|
* Means nothing for PUTs; it will be ignored
|
|
6884
6601
|
*/
|
|
6885
6602
|
_patternOverrides?: {
|
|
6886
|
-
[key: string]: components$
|
|
6603
|
+
[key: string]: components$f["schemas"]["ComponentOverride"];
|
|
6887
6604
|
};
|
|
6888
6605
|
/**
|
|
6889
6606
|
* When used on a pattern, defines how the pattern's parameters may be overridden
|
|
@@ -6892,7 +6609,7 @@ interface components$e {
|
|
|
6892
6609
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
6893
6610
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
6894
6611
|
*/
|
|
6895
|
-
_overridability?: components$
|
|
6612
|
+
_overridability?: components$f["schemas"]["ComponentOverridability"];
|
|
6896
6613
|
/** Array of locales which have data defined on the composition. If empty, the current default locale implicitly has data */
|
|
6897
6614
|
_locales?: string[];
|
|
6898
6615
|
/**
|
|
@@ -6931,7 +6648,7 @@ interface components$e {
|
|
|
6931
6648
|
* NOTE: Users without membership in any role listed here will be unable to execute the transition unless they are team admins
|
|
6932
6649
|
*/
|
|
6933
6650
|
permissions: {
|
|
6934
|
-
[key: string]: components$
|
|
6651
|
+
[key: string]: components$f["schemas"]["WorkflowStageTransitionPermission"];
|
|
6935
6652
|
};
|
|
6936
6653
|
};
|
|
6937
6654
|
/** Definition of a stage in a workflow */
|
|
@@ -6945,7 +6662,7 @@ interface components$e {
|
|
|
6945
6662
|
* listed here, the stage is read-only and publishing is disabled
|
|
6946
6663
|
*/
|
|
6947
6664
|
permissions: {
|
|
6948
|
-
[key: string]: components$
|
|
6665
|
+
[key: string]: components$f["schemas"]["WorkflowStagePermission"];
|
|
6949
6666
|
};
|
|
6950
6667
|
/**
|
|
6951
6668
|
* When true, transitioning into this stage from a different stage will automatically publish the entity.
|
|
@@ -6965,7 +6682,7 @@ interface components$e {
|
|
|
6965
6682
|
* Every stage must define at least one transition, to avoid creating a workflow that
|
|
6966
6683
|
* has a stage that can never be escaped
|
|
6967
6684
|
*/
|
|
6968
|
-
transitions: components$
|
|
6685
|
+
transitions: components$f["schemas"]["WorkflowStageTransition"][];
|
|
6969
6686
|
/**
|
|
6970
6687
|
* Icon name for the stage (e.g. 'chevron-double-right-o')
|
|
6971
6688
|
* @defaultValue chevron-double-right-o
|
|
@@ -6990,7 +6707,7 @@ interface components$e {
|
|
|
6990
6707
|
initialStage: string;
|
|
6991
6708
|
/** All stages of the workflow */
|
|
6992
6709
|
stages: {
|
|
6993
|
-
[key: string]: components$
|
|
6710
|
+
[key: string]: components$f["schemas"]["WorkflowStage"];
|
|
6994
6711
|
};
|
|
6995
6712
|
/** Last modified ISO date string for this definition (ignored for writes) */
|
|
6996
6713
|
modified?: string;
|
|
@@ -7038,6 +6755,8 @@ interface components$e {
|
|
|
7038
6755
|
* Timestamp when the item was moved to trash. Omitted if not in trash.
|
|
7039
6756
|
*/
|
|
7040
6757
|
deletedAt?: string;
|
|
6758
|
+
/** Present when the item is in trash, omitted otherwise. True when the item was published with no unpublished changes at the moment it was trashed. False otherwise, including items trashed before this field existed. */
|
|
6759
|
+
publishedWhenTrashed?: boolean;
|
|
7041
6760
|
/** User name of the creator of this composition */
|
|
7042
6761
|
creator?: string;
|
|
7043
6762
|
/** User name of the last editor of this composition */
|
|
@@ -7063,7 +6782,7 @@ interface components$e {
|
|
|
7063
6782
|
* The release this composition belongs to. If not set, it belongs to the base
|
|
7064
6783
|
*/
|
|
7065
6784
|
releaseId?: string;
|
|
7066
|
-
composition: components$
|
|
6785
|
+
composition: components$f["schemas"]["RootComponentInstance"];
|
|
7067
6786
|
/**
|
|
7068
6787
|
* Format: uuid
|
|
7069
6788
|
* The workflow ID assigned to this composition, if any. Normally comes from the component definition
|
|
@@ -7081,7 +6800,7 @@ interface components$e {
|
|
|
7081
6800
|
*/
|
|
7082
6801
|
instanceWorkflowId?: string;
|
|
7083
6802
|
/** The full definition of the assigned workflow, if any, including stages, permissions, etc. Returned only when `withWorkflowDefinition` is true */
|
|
7084
|
-
workflowDefinition?: components$
|
|
6803
|
+
workflowDefinition?: components$f["schemas"]["WorkflowDefinition"];
|
|
7085
6804
|
/**
|
|
7086
6805
|
* Format: uuid
|
|
7087
6806
|
* The edition ID. When set, this is a child edition of the composition in _id.
|
|
@@ -7123,10 +6842,8 @@ interface components$e {
|
|
|
7123
6842
|
* * If still ambiguous, the first matching route arbitrarily wins
|
|
7124
6843
|
*
|
|
7125
6844
|
* Invalid paths:
|
|
7126
|
-
* The request fails with HTTP 400 when the path, ignoring its query string and trailing slashes
|
|
7127
|
-
*
|
|
7128
|
-
* * has a path segment that is too long to match any route. The limit depends on the characters used,
|
|
7129
|
-
* and is generally 150-220 characters per segment.
|
|
6845
|
+
* The request fails with HTTP 400 when the path, ignoring its query string and trailing slashes,
|
|
6846
|
+
* contains consecutive slashes (for example "/en//about" or "//en/about").
|
|
7130
6847
|
*
|
|
7131
6848
|
* Probe paths:
|
|
7132
6849
|
* On uniform.global, paths ending in an archive, backup or database file extension (for example "/site.zip",
|
|
@@ -7192,7 +6909,7 @@ interface components$e {
|
|
|
7192
6909
|
pathItems: never;
|
|
7193
6910
|
}
|
|
7194
6911
|
|
|
7195
|
-
interface paths$
|
|
6912
|
+
interface paths$d {
|
|
7196
6913
|
"/api/v1/canvas": {
|
|
7197
6914
|
parameters: {
|
|
7198
6915
|
query?: never;
|
|
@@ -7314,56 +7031,56 @@ interface paths$c {
|
|
|
7314
7031
|
* This is a primary query parameter and cannot be used with any other primary query parameters.
|
|
7315
7032
|
* When `editions=raw`, this parameter matches on composition or edition IDs and edition resolution is disabled.
|
|
7316
7033
|
*/
|
|
7317
|
-
compositionId?: components$
|
|
7034
|
+
compositionId?: components$e["parameters"]["compositionId"];
|
|
7318
7035
|
/**
|
|
7319
7036
|
* Specify a single component ID to fetch the component's composition defaults. The response will be a single composition.
|
|
7320
7037
|
* This is a primary query parameter and cannot be used with any other primary query parameters
|
|
7321
7038
|
*/
|
|
7322
|
-
componentId?: components$
|
|
7039
|
+
componentId?: components$e["parameters"]["componentId"];
|
|
7323
7040
|
/**
|
|
7324
7041
|
* Specify a historical composition version ID to fetch (retrieved from the canvas-history API).
|
|
7325
7042
|
* Must be used with the `compositionId` parameter
|
|
7326
7043
|
*/
|
|
7327
|
-
versionId?: components$
|
|
7044
|
+
versionId?: components$e["parameters"]["versionId"];
|
|
7328
7045
|
/**
|
|
7329
7046
|
* Specify multiple composition IDs to fetch. The response type will be a list.
|
|
7330
7047
|
* This is a primary query parameter and cannot be used with any other primary query parameters.
|
|
7331
7048
|
* When `editions=raw`, this parameter matches on composition or edition IDs and edition resolution is disabled.
|
|
7332
7049
|
*/
|
|
7333
|
-
compositionIDs?: components$
|
|
7050
|
+
compositionIDs?: components$e["parameters"]["compositionIDs"];
|
|
7334
7051
|
/**
|
|
7335
7052
|
* Filters composition lists by the user who created them. The user is specified by their identity subject.
|
|
7336
7053
|
* This is a list query parameter and cannot be used with any primary query parameters
|
|
7337
7054
|
*/
|
|
7338
|
-
createdBy?: components$
|
|
7055
|
+
createdBy?: components$e["parameters"]["createdBy"];
|
|
7339
7056
|
/**
|
|
7340
7057
|
* Matches compositions where their name, slug, or definition name contains the specified keyword.
|
|
7341
7058
|
* NOT a full-text search; does not match composition contents.
|
|
7342
7059
|
* This is a list query parameter and cannot be used with any primary query parameters
|
|
7343
7060
|
*/
|
|
7344
|
-
keyword?: components$
|
|
7061
|
+
keyword?: components$e["parameters"]["keyword"];
|
|
7345
7062
|
/**
|
|
7346
7063
|
* Maximum number of records to return
|
|
7347
7064
|
* This is a list query parameter and cannot be used with any primary query parameters
|
|
7348
7065
|
*/
|
|
7349
|
-
limit?: components$
|
|
7066
|
+
limit?: components$e["parameters"]["limit"];
|
|
7350
7067
|
/**
|
|
7351
7068
|
* Number of records to skip
|
|
7352
7069
|
* This is a list query parameter and cannot be used with any primary query parameters
|
|
7353
7070
|
*/
|
|
7354
|
-
offset?: components$
|
|
7071
|
+
offset?: components$e["parameters"]["offset"];
|
|
7355
7072
|
/**
|
|
7356
7073
|
* Sets the sorting of the results. If unspecified, results are sorted by name ascending.
|
|
7357
7074
|
* Allowed values are: updated_at_DESC, updated_at_ASC, created_at_DESC, created_at_ASC,
|
|
7358
7075
|
* name_DESC, name_ASC, slug_DESC, slug_ASC.
|
|
7359
7076
|
* When using primary query parameters, this parameter is ignored
|
|
7360
7077
|
*/
|
|
7361
|
-
orderBy?: components$
|
|
7078
|
+
orderBy?: components$e["parameters"]["orderBy"];
|
|
7362
7079
|
/**
|
|
7363
7080
|
* @deprecated
|
|
7364
7081
|
* Returns counts for distinct values of the specified field or fields (provided as comma-separated IDs).
|
|
7365
7082
|
*/
|
|
7366
|
-
facetBy?: components$
|
|
7083
|
+
facetBy?: components$e["parameters"]["facetBy"];
|
|
7367
7084
|
/**
|
|
7368
7085
|
* Matches compositions based on whether they are a pattern composition or a regular composition.
|
|
7369
7086
|
* If true, only pattern compositions will be returned.
|
|
@@ -7371,44 +7088,44 @@ interface paths$c {
|
|
|
7371
7088
|
* If omitted or 'any', both pattern and regular compositions will be returned.
|
|
7372
7089
|
* This is a list query parameter and cannot be used with any primary query parameters
|
|
7373
7090
|
*/
|
|
7374
|
-
pattern?: components$
|
|
7091
|
+
pattern?: components$e["parameters"]["pattern"];
|
|
7375
7092
|
/**
|
|
7376
7093
|
* This specifies which type of patterns to return. This query parameter has no effect when `pattern` is false.
|
|
7377
7094
|
* * `all` - Returns all pattern instances
|
|
7378
7095
|
* * `component` - Returns only component patterns
|
|
7379
7096
|
* * `composition` - Returns only composition patterns
|
|
7380
7097
|
*/
|
|
7381
|
-
patternType?: components$
|
|
7098
|
+
patternType?: components$e["parameters"]["patternType"];
|
|
7382
7099
|
/**
|
|
7383
7100
|
* @deprecated
|
|
7384
7101
|
* Includes the `patternType` attribute in the response
|
|
7385
7102
|
*/
|
|
7386
|
-
withPatternType?: components$
|
|
7103
|
+
withPatternType?: components$e["parameters"]["withPatternType"];
|
|
7387
7104
|
/** The project the composition(s) belong to */
|
|
7388
|
-
projectId: components$
|
|
7105
|
+
projectId: components$e["parameters"]["projectId"];
|
|
7389
7106
|
/**
|
|
7390
7107
|
* Specify a project map ID to fetch by path or node ID from.
|
|
7391
7108
|
* If not specified, the default project map for the projectId is used.
|
|
7392
7109
|
* Only used when fetching by projectMapNodeId or projectMapNodePath
|
|
7393
7110
|
*/
|
|
7394
|
-
projectMapId?: components$
|
|
7111
|
+
projectMapId?: components$e["parameters"]["projectMapId"];
|
|
7395
7112
|
/**
|
|
7396
7113
|
* Specify a single composition to fetch by associated project map node ID. The response will be a single composition.
|
|
7397
7114
|
* This is a primary query parameter and cannot be used with any other primary query parameters
|
|
7398
7115
|
*/
|
|
7399
|
-
projectMapNodeId?: components$
|
|
7116
|
+
projectMapNodeId?: components$e["parameters"]["projectMapNodeId"];
|
|
7400
7117
|
/**
|
|
7401
7118
|
* Specify a single composition to fetch by associated project map node path. The response will be a single composition.
|
|
7402
7119
|
* This is a primary query parameter and cannot be used with any other primary query parameters
|
|
7403
7120
|
*/
|
|
7404
|
-
projectMapNodePath?: components$
|
|
7121
|
+
projectMapNodePath?: components$e["parameters"]["projectMapNodePath"];
|
|
7405
7122
|
/**
|
|
7406
7123
|
* @deprecated
|
|
7407
7124
|
* Signals an enhancer proxy to skip processing enhancements to the data and return raw data only.
|
|
7408
7125
|
* This improves performance if you do not require enhanced component data.
|
|
7409
7126
|
* If calling the Canvas API directly with no enhancer proxy, this has no effect
|
|
7410
7127
|
*/
|
|
7411
|
-
skipEnhance?: components$
|
|
7128
|
+
skipEnhance?: components$e["parameters"]["skipEnhance"];
|
|
7412
7129
|
/**
|
|
7413
7130
|
* If true, any pattern references in the composition will be left unresolved.
|
|
7414
7131
|
* This is appropriate if you intend to serialize the composition without patterns
|
|
@@ -7416,12 +7133,12 @@ interface paths$c {
|
|
|
7416
7133
|
* Default: true when `format` is canonical. False otherwise.
|
|
7417
7134
|
* Prefer selecting a `format` rather than using this option.
|
|
7418
7135
|
*/
|
|
7419
|
-
skipPatternResolution?: components$
|
|
7136
|
+
skipPatternResolution?: components$e["parameters"]["skipPatternResolution"];
|
|
7420
7137
|
/**
|
|
7421
7138
|
* @deprecated
|
|
7422
7139
|
* This parameter is unused and has no effect. Passing this parameter will become an error in the future
|
|
7423
7140
|
*/
|
|
7424
|
-
skipParameterResolution?: components$
|
|
7141
|
+
skipParameterResolution?: components$e["parameters"]["skipParameterResolution"];
|
|
7425
7142
|
/**
|
|
7426
7143
|
* If true, any pattern override data is not resolved by the API.
|
|
7427
7144
|
* This is intended for internal use in the Canvas editor and should not be used.
|
|
@@ -7429,69 +7146,69 @@ interface paths$c {
|
|
|
7429
7146
|
* Default: true when `format` is canonical or editor. False otherwise.
|
|
7430
7147
|
* Prefer selecting a `format` rather than using this option.
|
|
7431
7148
|
*/
|
|
7432
|
-
skipOverridesResolution?: components$
|
|
7149
|
+
skipOverridesResolution?: components$e["parameters"]["skipOverridesResolution"];
|
|
7433
7150
|
/**
|
|
7434
7151
|
* Specify a single composition to fetch by slug. The response will be a single composition.
|
|
7435
7152
|
* This is a primary query parameter and cannot be used with any other primary query parameters
|
|
7436
7153
|
*/
|
|
7437
|
-
slug?: components$
|
|
7154
|
+
slug?: components$e["parameters"]["slug"];
|
|
7438
7155
|
/** Filtration by category ID. An empty string can be used to include records without a category. */
|
|
7439
|
-
categories?: components$
|
|
7156
|
+
categories?: components$e["parameters"]["categories"];
|
|
7440
7157
|
/**
|
|
7441
7158
|
* Publishing state to fetch. 0 = draft, 64 = published.
|
|
7442
7159
|
* This is a list query parameter and cannot be used with any primary query parameters
|
|
7443
7160
|
*/
|
|
7444
|
-
state?: components$
|
|
7161
|
+
state?: components$e["parameters"]["state"];
|
|
7445
7162
|
/**
|
|
7446
7163
|
* The component type (by public ID) to filter by. Note that this filters the root composition type only; components in slots are not matched by this filter.
|
|
7447
7164
|
* This is a list query parameter and cannot be used with any primary query parameters
|
|
7448
7165
|
*/
|
|
7449
|
-
type?: components$
|
|
7166
|
+
type?: components$e["parameters"]["type"];
|
|
7450
7167
|
/**
|
|
7451
7168
|
* @deprecated
|
|
7452
7169
|
* Filters composition lists by the UI status of the composition.
|
|
7453
7170
|
* This internal status is subject to change without notice and is thus marked deprecated to discourage use of internal data.
|
|
7454
7171
|
* This is a list query parameter and cannot be used with any primary query parameters
|
|
7455
7172
|
*/
|
|
7456
|
-
uiStatus?: components$
|
|
7173
|
+
uiStatus?: components$e["parameters"]["uiStatus"];
|
|
7457
7174
|
/**
|
|
7458
7175
|
* Filters out compositions without attached node or filters out compositions with attached nodes
|
|
7459
7176
|
* if set to false. If not specified, no filtration is applied.
|
|
7460
7177
|
* This is a list query parameter and cannot be used with any primary query parameters
|
|
7461
7178
|
*/
|
|
7462
|
-
attachedToProjectMap?: components$
|
|
7179
|
+
attachedToProjectMap?: components$e["parameters"]["attachedToProjectMap"];
|
|
7463
7180
|
/**
|
|
7464
7181
|
* Filters composition lists by the user who last updated them. The user is specified by their identity subject.
|
|
7465
7182
|
* This is a list query parameter and cannot be used with any primary query parameters
|
|
7466
7183
|
*/
|
|
7467
|
-
updatedBy?: components$
|
|
7184
|
+
updatedBy?: components$e["parameters"]["updatedBy"];
|
|
7468
7185
|
/**
|
|
7469
7186
|
* If true, the `_id` unique identifier of each non-root component will be part of the response data.
|
|
7470
7187
|
* If false, the `_id` will not be present in the API response.
|
|
7471
7188
|
* Note: the default value depends on the `format`: true for editor or canonical, false for delivery or when no format is specified.
|
|
7472
7189
|
* Prefer selecting a `format` rather than using this option.
|
|
7473
7190
|
*/
|
|
7474
|
-
withComponentIDs?: components$
|
|
7191
|
+
withComponentIDs?: components$e["parameters"]["withComponentIDs"];
|
|
7475
7192
|
/**
|
|
7476
7193
|
* Controls whether the total count of results will be returned along with the current results page in a list.
|
|
7477
7194
|
* Has no effect when not fetching a list. This does impact performance when enabled
|
|
7478
7195
|
*/
|
|
7479
|
-
withTotalCount?: components$
|
|
7196
|
+
withTotalCount?: components$e["parameters"]["withTotalCount"];
|
|
7480
7197
|
/**
|
|
7481
7198
|
* @deprecated
|
|
7482
7199
|
* Returns the UI status string of the composition.
|
|
7483
7200
|
* This internal status is subject to change without notice and is thus marked deprecated to discourage use of internal data
|
|
7484
7201
|
*/
|
|
7485
|
-
withUIStatus?: components$
|
|
7202
|
+
withUIStatus?: components$e["parameters"]["withUIStatus"];
|
|
7486
7203
|
/** Returns the definition of any attached workflow along with the composition data */
|
|
7487
|
-
withWorkflowDefinition?: components$
|
|
7204
|
+
withWorkflowDefinition?: components$e["parameters"]["withWorkflowDefinition"];
|
|
7488
7205
|
/** Includes project map node information in the composition results */
|
|
7489
|
-
withProjectMapNodes?: components$
|
|
7206
|
+
withProjectMapNodes?: components$e["parameters"]["withProjectMapNodes"];
|
|
7490
7207
|
/**
|
|
7491
7208
|
* @deprecated
|
|
7492
7209
|
* Has no effect.
|
|
7493
7210
|
*/
|
|
7494
|
-
withContentSourceMap?: components$
|
|
7211
|
+
withContentSourceMap?: components$e["parameters"]["withContentSourceMap"];
|
|
7495
7212
|
/**
|
|
7496
7213
|
* One or more locales to filter and localize by.
|
|
7497
7214
|
* For list responses, only compositions that enable one of the specified locales _or enable no locales_ will be returned. When more than one locale is passed, the list matches with an OR on each locale.
|
|
@@ -7505,7 +7222,7 @@ interface paths$c {
|
|
|
7505
7222
|
* When this parameter is not passed, all locales' data will be returned.
|
|
7506
7223
|
* If a composition is requested by ID and does not possess any of the specified locales, HTTP 404 will be returned
|
|
7507
7224
|
*/
|
|
7508
|
-
locale?: components$
|
|
7225
|
+
locale?: components$e["parameters"]["locale"];
|
|
7509
7226
|
/**
|
|
7510
7227
|
* The ID of a release to fetch the content for.
|
|
7511
7228
|
*
|
|
@@ -7514,7 +7231,7 @@ interface paths$c {
|
|
|
7514
7231
|
*
|
|
7515
7232
|
* Content copied to a release can be differentiated from base content by the `releaseId` property on the content. If the content is not copied to the release, this property will be null
|
|
7516
7233
|
*/
|
|
7517
|
-
releaseId?: components$
|
|
7234
|
+
releaseId?: components$e["parameters"]["releaseId"];
|
|
7518
7235
|
/**
|
|
7519
7236
|
* Search on textual fields of a composition.
|
|
7520
7237
|
* Matches against fully rendered content including resolved pattern content.
|
|
@@ -7522,7 +7239,7 @@ interface paths$c {
|
|
|
7522
7239
|
* Note: For long text fields, the tail of the text is not guaranteed to be searchable.
|
|
7523
7240
|
* Example: ?search=hello
|
|
7524
7241
|
*/
|
|
7525
|
-
search?: components$
|
|
7242
|
+
search?: components$e["parameters"]["search"];
|
|
7526
7243
|
/**
|
|
7527
7244
|
* @deprecated
|
|
7528
7245
|
* BETA: Semantic search using vector similarity to find content by meaning.
|
|
@@ -7530,7 +7247,7 @@ interface paths$c {
|
|
|
7530
7247
|
* Use this for "where is this content defined" queries.
|
|
7531
7248
|
* Requires AI credits.
|
|
7532
7249
|
*/
|
|
7533
|
-
searchSemantic?: components$
|
|
7250
|
+
searchSemantic?: components$e["parameters"]["searchSemantic"];
|
|
7534
7251
|
/**
|
|
7535
7252
|
* Controls the edition resolution behavior.
|
|
7536
7253
|
*
|
|
@@ -7545,7 +7262,7 @@ interface paths$c {
|
|
|
7545
7262
|
* compositionId or compositionIDs MUST be provided with this option.
|
|
7546
7263
|
* If versionId is passed, this is always enabled.
|
|
7547
7264
|
*/
|
|
7548
|
-
editions?: components$
|
|
7265
|
+
editions?: components$e["parameters"]["editions"];
|
|
7549
7266
|
/**
|
|
7550
7267
|
* Specify a format you want the results in. Any explicit shaping flag (skipPatternResolution,
|
|
7551
7268
|
* skipOverridesResolution, withComponentIDs) overrides this alias.
|
|
@@ -7558,7 +7275,7 @@ interface paths$c {
|
|
|
7558
7275
|
* - `delivery`: default structure for serving to a frontend — patterns and overrides resolved
|
|
7559
7276
|
* and component `_id`s removed.
|
|
7560
7277
|
*/
|
|
7561
|
-
format?: components$
|
|
7278
|
+
format?: components$e["parameters"]["format"];
|
|
7562
7279
|
/**
|
|
7563
7280
|
* Controls filtering of trashed items.
|
|
7564
7281
|
*
|
|
@@ -7566,7 +7283,7 @@ interface paths$c {
|
|
|
7566
7283
|
* only: Only return trashed items (for trash view).
|
|
7567
7284
|
* include: Return both trashed and non-trashed items.
|
|
7568
7285
|
*/
|
|
7569
|
-
deleted?: components$
|
|
7286
|
+
deleted?: components$e["parameters"]["deleted"];
|
|
7570
7287
|
};
|
|
7571
7288
|
header?: never;
|
|
7572
7289
|
path?: never;
|
|
@@ -7580,12 +7297,12 @@ interface paths$c {
|
|
|
7580
7297
|
[name: string]: unknown;
|
|
7581
7298
|
};
|
|
7582
7299
|
content: {
|
|
7583
|
-
"application/json": components$
|
|
7300
|
+
"application/json": components$e["schemas"]["CompositionListResponse"] | components$e["schemas"]["CompositionApiResponse"];
|
|
7584
7301
|
};
|
|
7585
7302
|
};
|
|
7586
|
-
400: components$
|
|
7587
|
-
401: components$
|
|
7588
|
-
403: components$
|
|
7303
|
+
400: components$e["responses"]["BadRequestError"];
|
|
7304
|
+
401: components$e["responses"]["UnauthorizedError"];
|
|
7305
|
+
403: components$e["responses"]["ForbiddenError"];
|
|
7589
7306
|
/** Composition not found */
|
|
7590
7307
|
404: {
|
|
7591
7308
|
headers: {
|
|
@@ -7595,8 +7312,8 @@ interface paths$c {
|
|
|
7595
7312
|
"text/plain": string;
|
|
7596
7313
|
};
|
|
7597
7314
|
};
|
|
7598
|
-
429: components$
|
|
7599
|
-
500: components$
|
|
7315
|
+
429: components$e["responses"]["RateLimitError"];
|
|
7316
|
+
500: components$e["responses"]["InternalServerError"];
|
|
7600
7317
|
};
|
|
7601
7318
|
};
|
|
7602
7319
|
/** Upserts a composition */
|
|
@@ -7624,7 +7341,7 @@ interface paths$c {
|
|
|
7624
7341
|
projectId: string;
|
|
7625
7342
|
/** The publishing state to upsert into. 0 = draft, 64 = published */
|
|
7626
7343
|
state: number;
|
|
7627
|
-
composition: components$
|
|
7344
|
+
composition: components$e["schemas"]["RootComponentInstance"];
|
|
7628
7345
|
/**
|
|
7629
7346
|
* Indicates if the composition is a pattern that can be referenced in other compositions
|
|
7630
7347
|
* @defaultValue false
|
|
@@ -7700,9 +7417,9 @@ interface paths$c {
|
|
|
7700
7417
|
};
|
|
7701
7418
|
content?: never;
|
|
7702
7419
|
};
|
|
7703
|
-
400: components$
|
|
7704
|
-
401: components$
|
|
7705
|
-
403: components$
|
|
7420
|
+
400: components$e["responses"]["BadRequestError"];
|
|
7421
|
+
401: components$e["responses"]["UnauthorizedError"];
|
|
7422
|
+
403: components$e["responses"]["ForbiddenError"];
|
|
7706
7423
|
/** Conflict - Composition has been changed since being loaded */
|
|
7707
7424
|
409: {
|
|
7708
7425
|
headers: {
|
|
@@ -7712,8 +7429,8 @@ interface paths$c {
|
|
|
7712
7429
|
"text/plain": string;
|
|
7713
7430
|
};
|
|
7714
7431
|
};
|
|
7715
|
-
429: components$
|
|
7716
|
-
500: components$
|
|
7432
|
+
429: components$e["responses"]["RateLimitError"];
|
|
7433
|
+
500: components$e["responses"]["InternalServerError"];
|
|
7717
7434
|
};
|
|
7718
7435
|
};
|
|
7719
7436
|
post?: never;
|
|
@@ -7755,6 +7472,12 @@ interface paths$c {
|
|
|
7755
7472
|
releaseId?: string;
|
|
7756
7473
|
/** The state to delete (0 = draft, 64 = published [causes unpublishing], unspecified = all) */
|
|
7757
7474
|
state?: number;
|
|
7475
|
+
/**
|
|
7476
|
+
* Bypass the trash and permanently delete the composition.
|
|
7477
|
+
* Requires team admin rights.
|
|
7478
|
+
* Cannot be combined with releaseId.
|
|
7479
|
+
*/
|
|
7480
|
+
permanent?: boolean;
|
|
7758
7481
|
};
|
|
7759
7482
|
};
|
|
7760
7483
|
};
|
|
@@ -7766,11 +7489,11 @@ interface paths$c {
|
|
|
7766
7489
|
};
|
|
7767
7490
|
content?: never;
|
|
7768
7491
|
};
|
|
7769
|
-
400: components$
|
|
7770
|
-
401: components$
|
|
7771
|
-
403: components$
|
|
7772
|
-
429: components$
|
|
7773
|
-
500: components$
|
|
7492
|
+
400: components$e["responses"]["BadRequestError"];
|
|
7493
|
+
401: components$e["responses"]["UnauthorizedError"];
|
|
7494
|
+
403: components$e["responses"]["ForbiddenError"];
|
|
7495
|
+
429: components$e["responses"]["RateLimitError"];
|
|
7496
|
+
500: components$e["responses"]["InternalServerError"];
|
|
7774
7497
|
};
|
|
7775
7498
|
};
|
|
7776
7499
|
/** Handles preflight requests. This endpoint allows CORS */
|
|
@@ -7797,7 +7520,7 @@ interface paths$c {
|
|
|
7797
7520
|
trace?: never;
|
|
7798
7521
|
};
|
|
7799
7522
|
}
|
|
7800
|
-
interface components$
|
|
7523
|
+
interface components$e {
|
|
7801
7524
|
schemas: {
|
|
7802
7525
|
CompositionApiResponse: {
|
|
7803
7526
|
/** Publishing state to fetch. 0 = draft, 64 = published */
|
|
@@ -7828,6 +7551,8 @@ interface components$d {
|
|
|
7828
7551
|
* Timestamp when the item was moved to trash. Omitted if not in trash.
|
|
7829
7552
|
*/
|
|
7830
7553
|
deletedAt?: string;
|
|
7554
|
+
/** Present when the item is in trash, omitted otherwise. True when the item was published with no unpublished changes at the moment it was trashed. False otherwise, including items trashed before this field existed. */
|
|
7555
|
+
publishedWhenTrashed?: boolean;
|
|
7831
7556
|
/** User name of the creator of this composition */
|
|
7832
7557
|
creator?: string;
|
|
7833
7558
|
/** User name of the last editor of this composition */
|
|
@@ -7853,7 +7578,7 @@ interface components$d {
|
|
|
7853
7578
|
* The release this composition belongs to. If not set, it belongs to the base
|
|
7854
7579
|
*/
|
|
7855
7580
|
releaseId?: string;
|
|
7856
|
-
composition: components$
|
|
7581
|
+
composition: components$e["schemas"]["RootComponentInstance"];
|
|
7857
7582
|
/**
|
|
7858
7583
|
* Format: uuid
|
|
7859
7584
|
* The workflow ID assigned to this composition, if any. Normally comes from the component definition
|
|
@@ -7871,7 +7596,7 @@ interface components$d {
|
|
|
7871
7596
|
*/
|
|
7872
7597
|
instanceWorkflowId?: string;
|
|
7873
7598
|
/** The full definition of the assigned workflow, if any, including stages, permissions, etc. Returned only when `withWorkflowDefinition` is true */
|
|
7874
|
-
workflowDefinition?: components$
|
|
7599
|
+
workflowDefinition?: components$e["schemas"]["WorkflowDefinition"];
|
|
7875
7600
|
/**
|
|
7876
7601
|
* Format: uuid
|
|
7877
7602
|
* The edition ID. When set, this is a child edition of the composition in _id.
|
|
@@ -7889,7 +7614,7 @@ interface components$d {
|
|
|
7889
7614
|
editionPriority?: number;
|
|
7890
7615
|
};
|
|
7891
7616
|
CompositionListResponse: {
|
|
7892
|
-
compositions: components$
|
|
7617
|
+
compositions: components$e["schemas"]["CompositionApiResponse"][];
|
|
7893
7618
|
/** Total number of compositions that match the query. Present only when `withTotalCount` option is true */
|
|
7894
7619
|
totalCount?: number;
|
|
7895
7620
|
/** Per-field counts for distinct values */
|
|
@@ -7963,11 +7688,11 @@ interface components$d {
|
|
|
7963
7688
|
|
|
7964
7689
|
*/
|
|
7965
7690
|
op?: "&" | "|";
|
|
7966
|
-
clauses: (components$
|
|
7691
|
+
clauses: (components$e["schemas"]["VisibilityCriteria"] | components$e["schemas"]["VisibilityCriteriaGroup"])[];
|
|
7967
7692
|
};
|
|
7968
7693
|
/** Defines a conditional value for a component parameter */
|
|
7969
7694
|
ComponentParameterConditionalValue: {
|
|
7970
|
-
when: components$
|
|
7695
|
+
when: components$e["schemas"]["VisibilityCriteriaGroup"];
|
|
7971
7696
|
/**
|
|
7972
7697
|
* The value of the parameter. Any JSON-serializable value is acceptable.
|
|
7973
7698
|
* A value of `null` will cause the parameter value to be removed, if it matches.
|
|
@@ -7989,7 +7714,7 @@ interface components$d {
|
|
|
7989
7714
|
*
|
|
7990
7715
|
* When no locale is passed to a non-route API, conditions are not processed and all conditions are returned.
|
|
7991
7716
|
*/
|
|
7992
|
-
ComponentParameterConditions: components$
|
|
7717
|
+
ComponentParameterConditions: components$e["schemas"]["ComponentParameterConditionalValue"][];
|
|
7993
7718
|
/** Defines an editable parameter on a component */
|
|
7994
7719
|
ComponentParameter: {
|
|
7995
7720
|
/** The value of the parameter. Any JSON-serializable value is acceptable */
|
|
@@ -7997,7 +7722,7 @@ interface components$d {
|
|
|
7997
7722
|
/** The type of the parameter. Determines how it is displayed when editing and tells the consumer how to process it */
|
|
7998
7723
|
type: string;
|
|
7999
7724
|
/** @deprecated */
|
|
8000
|
-
connectedData?: components$
|
|
7725
|
+
connectedData?: components$e["schemas"]["DataElementConnectionDefinition"];
|
|
8001
7726
|
/**
|
|
8002
7727
|
* Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
|
|
8003
7728
|
* Note that locales must be registered on the entry/composition `_locales` before being used
|
|
@@ -8005,10 +7730,10 @@ interface components$d {
|
|
|
8005
7730
|
locales?: {
|
|
8006
7731
|
[key: string]: unknown;
|
|
8007
7732
|
};
|
|
8008
|
-
conditions?: components$
|
|
7733
|
+
conditions?: components$e["schemas"]["ComponentParameterConditions"];
|
|
8009
7734
|
/** Locale-specific conditional values for this parameter. Keys are locale codes, and values are the `conditions` for that locale. */
|
|
8010
7735
|
localesConditions?: {
|
|
8011
|
-
[key: string]: components$
|
|
7736
|
+
[key: string]: components$e["schemas"]["ComponentParameterConditions"];
|
|
8012
7737
|
};
|
|
8013
7738
|
};
|
|
8014
7739
|
ProjectMapNodeAllowedQueryString: {
|
|
@@ -8043,7 +7768,7 @@ interface components$d {
|
|
|
8043
7768
|
/** While performing a search if a node is a hit, this property will return true. If it's supporting structure, like a parent of a search hit, it will return false */
|
|
8044
7769
|
isSearchHit?: boolean;
|
|
8045
7770
|
/** Query strings that are allowed to be passed to the node */
|
|
8046
|
-
queryStrings?: components$
|
|
7771
|
+
queryStrings?: components$e["schemas"]["ProjectMapNodeAllowedQueryString"][];
|
|
8047
7772
|
/**
|
|
8048
7773
|
* For dynamic nodes, this is the preview value for the dynamic value.
|
|
8049
7774
|
* The preview value is used when editing a connected composition, and is the default
|
|
@@ -8068,7 +7793,7 @@ interface components$d {
|
|
|
8068
7793
|
* Unique identifier for the project map that this node belongs to
|
|
8069
7794
|
*/
|
|
8070
7795
|
projectMapId: string;
|
|
8071
|
-
data?: components$
|
|
7796
|
+
data?: components$e["schemas"]["ProjectMapNodeData"];
|
|
8072
7797
|
/**
|
|
8073
7798
|
* Locale-specific paths of the project map node.
|
|
8074
7799
|
* Keys are locale codes
|
|
@@ -8088,13 +7813,13 @@ interface components$d {
|
|
|
8088
7813
|
type: string;
|
|
8089
7814
|
/** Component parameter values for the component instance */
|
|
8090
7815
|
parameters?: {
|
|
8091
|
-
[key: string]: components$
|
|
7816
|
+
[key: string]: components$e["schemas"]["ComponentParameter"];
|
|
8092
7817
|
};
|
|
8093
7818
|
/** Public ID of alternate visual appearance for this component, if any selected */
|
|
8094
7819
|
variant?: string;
|
|
8095
7820
|
/** Slots containing any child components */
|
|
8096
7821
|
slots?: {
|
|
8097
|
-
[key: string]: components$
|
|
7822
|
+
[key: string]: components$e["schemas"]["ComponentInstance"][];
|
|
8098
7823
|
};
|
|
8099
7824
|
/**
|
|
8100
7825
|
* Unique identifier of the component within the composition.
|
|
@@ -8105,20 +7830,20 @@ interface components$d {
|
|
|
8105
7830
|
_id?: string;
|
|
8106
7831
|
/** Indicates this component instance should be sourced from a pattern library pattern */
|
|
8107
7832
|
_pattern?: string;
|
|
8108
|
-
_dataResources?: components$
|
|
7833
|
+
_dataResources?: components$e["schemas"]["DataResourceDefinitions"];
|
|
8109
7834
|
/**
|
|
8110
7835
|
* Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
|
8111
7836
|
* Means nothing for PUTs; it will be ignored
|
|
8112
7837
|
*/
|
|
8113
7838
|
_patternDataResources?: {
|
|
8114
|
-
[key: string]: components$
|
|
7839
|
+
[key: string]: components$e["schemas"]["DataResourceDefinition"];
|
|
8115
7840
|
};
|
|
8116
7841
|
/**
|
|
8117
7842
|
* Query-string opt-ins coming from a pattern resolved for this component.
|
|
8118
7843
|
* Means nothing for PUTs; it will be ignored
|
|
8119
7844
|
*/
|
|
8120
7845
|
_patternOptedInQueryStrings?: string[];
|
|
8121
|
-
_patternError?: components$
|
|
7846
|
+
_patternError?: components$e["schemas"]["PatternError"];
|
|
8122
7847
|
/**
|
|
8123
7848
|
* Defines patch overrides to component IDs that live in the composition.
|
|
8124
7849
|
* This can be used to override parameters that are defined on patterns,
|
|
@@ -8132,14 +7857,14 @@ interface components$d {
|
|
|
8132
7857
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
8133
7858
|
*/
|
|
8134
7859
|
_overrides?: {
|
|
8135
|
-
[key: string]: components$
|
|
7860
|
+
[key: string]: components$e["schemas"]["ComponentOverride"];
|
|
8136
7861
|
};
|
|
8137
7862
|
/**
|
|
8138
7863
|
* Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
|
|
8139
7864
|
* Means nothing for PUTs; it will be ignored
|
|
8140
7865
|
*/
|
|
8141
7866
|
_patternOverrides?: {
|
|
8142
|
-
[key: string]: components$
|
|
7867
|
+
[key: string]: components$e["schemas"]["ComponentOverride"];
|
|
8143
7868
|
};
|
|
8144
7869
|
/**
|
|
8145
7870
|
* When used on a pattern, defines how the pattern's parameters may be overridden
|
|
@@ -8148,7 +7873,7 @@ interface components$d {
|
|
|
8148
7873
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
8149
7874
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
8150
7875
|
*/
|
|
8151
|
-
_overridability?: components$
|
|
7876
|
+
_overridability?: components$e["schemas"]["ComponentOverridability"];
|
|
8152
7877
|
/** Array of locales that have data defined. Only set for pattern references or composition defaults */
|
|
8153
7878
|
_locales?: string[];
|
|
8154
7879
|
};
|
|
@@ -8173,14 +7898,14 @@ interface components$d {
|
|
|
8173
7898
|
* If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
|
|
8174
7899
|
*/
|
|
8175
7900
|
optionalPatternParameter?: boolean;
|
|
8176
|
-
variables?: components$
|
|
7901
|
+
variables?: components$e["schemas"]["DataResourceVariables"];
|
|
8177
7902
|
};
|
|
8178
7903
|
/**
|
|
8179
7904
|
* Data definitions attached to this component. The property name is the key of the data in the data document.
|
|
8180
7905
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key)
|
|
8181
7906
|
*/
|
|
8182
7907
|
DataResourceDefinitions: {
|
|
8183
|
-
[key: string]: components$
|
|
7908
|
+
[key: string]: components$e["schemas"]["DataResourceDefinition"];
|
|
8184
7909
|
};
|
|
8185
7910
|
/**
|
|
8186
7911
|
* Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
|
@@ -8198,10 +7923,10 @@ interface components$d {
|
|
|
8198
7923
|
*/
|
|
8199
7924
|
ComponentOverride: {
|
|
8200
7925
|
parameters?: {
|
|
8201
|
-
[key: string]: components$
|
|
7926
|
+
[key: string]: components$e["schemas"]["ComponentParameter"];
|
|
8202
7927
|
};
|
|
8203
7928
|
slots?: {
|
|
8204
|
-
[key: string]: components$
|
|
7929
|
+
[key: string]: components$e["schemas"]["ComponentInstance"][];
|
|
8205
7930
|
};
|
|
8206
7931
|
variant?: string;
|
|
8207
7932
|
/**
|
|
@@ -8210,7 +7935,7 @@ interface components$d {
|
|
|
8210
7935
|
* Overrides defined here replace values in either _dataResources or _patternDataResources on the target component.
|
|
8211
7936
|
*/
|
|
8212
7937
|
dataResources?: {
|
|
8213
|
-
[key: string]: components$
|
|
7938
|
+
[key: string]: components$e["schemas"]["DataResourceDefinition"];
|
|
8214
7939
|
};
|
|
8215
7940
|
};
|
|
8216
7941
|
/**
|
|
@@ -8231,7 +7956,7 @@ interface components$d {
|
|
|
8231
7956
|
ComponentOverridability: {
|
|
8232
7957
|
/** Defines component parameter value overrides. Keys are the parameter public ID */
|
|
8233
7958
|
parameters?: {
|
|
8234
|
-
[key: string]: components$
|
|
7959
|
+
[key: string]: components$e["schemas"]["OverrideOptions"];
|
|
8235
7960
|
};
|
|
8236
7961
|
/** Allows overriding a display variant is allowed if it is defined on the component the pattern is derived from. Default = false */
|
|
8237
7962
|
variants?: boolean;
|
|
@@ -8248,15 +7973,15 @@ interface components$d {
|
|
|
8248
7973
|
type: string;
|
|
8249
7974
|
/** Component parameter values for the component instance */
|
|
8250
7975
|
parameters?: {
|
|
8251
|
-
[key: string]: components$
|
|
7976
|
+
[key: string]: components$e["schemas"]["ComponentParameter"];
|
|
8252
7977
|
};
|
|
8253
7978
|
/** Public ID of alternate visual appearance for this component, if any selected */
|
|
8254
7979
|
variant?: string;
|
|
8255
7980
|
/** Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated */
|
|
8256
|
-
projectMapNodes?: components$
|
|
7981
|
+
projectMapNodes?: components$e["schemas"]["CompositionProjectMapNodeInfo"][];
|
|
8257
7982
|
/** Slots containing any child components */
|
|
8258
7983
|
slots?: {
|
|
8259
|
-
[key: string]: components$
|
|
7984
|
+
[key: string]: components$e["schemas"]["ComponentInstance"][];
|
|
8260
7985
|
};
|
|
8261
7986
|
/** The ID of the composition */
|
|
8262
7987
|
_id: string;
|
|
@@ -8279,15 +8004,15 @@ interface components$d {
|
|
|
8279
8004
|
* Means nothing for PUTs; it will be ignored
|
|
8280
8005
|
*/
|
|
8281
8006
|
_patternDataResources?: {
|
|
8282
|
-
[key: string]: components$
|
|
8007
|
+
[key: string]: components$e["schemas"]["DataResourceDefinition"];
|
|
8283
8008
|
};
|
|
8284
8009
|
/**
|
|
8285
8010
|
* Query-string opt-ins coming from a pattern resolved for this component.
|
|
8286
8011
|
* Means nothing for PUTs; it will be ignored
|
|
8287
8012
|
*/
|
|
8288
8013
|
_patternOptedInQueryStrings?: string[];
|
|
8289
|
-
_dataResources?: components$
|
|
8290
|
-
_patternError?: components$
|
|
8014
|
+
_dataResources?: components$e["schemas"]["DataResourceDefinitions"];
|
|
8015
|
+
_patternError?: components$e["schemas"]["PatternError"];
|
|
8291
8016
|
/**
|
|
8292
8017
|
* Defines patch overrides to component IDs that live in the composition.
|
|
8293
8018
|
* This can be used to override parameters that are defined on patterns,
|
|
@@ -8301,14 +8026,14 @@ interface components$d {
|
|
|
8301
8026
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
8302
8027
|
*/
|
|
8303
8028
|
_overrides?: {
|
|
8304
|
-
[key: string]: components$
|
|
8029
|
+
[key: string]: components$e["schemas"]["ComponentOverride"];
|
|
8305
8030
|
};
|
|
8306
8031
|
/**
|
|
8307
8032
|
* Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
|
|
8308
8033
|
* Means nothing for PUTs; it will be ignored
|
|
8309
8034
|
*/
|
|
8310
8035
|
_patternOverrides?: {
|
|
8311
|
-
[key: string]: components$
|
|
8036
|
+
[key: string]: components$e["schemas"]["ComponentOverride"];
|
|
8312
8037
|
};
|
|
8313
8038
|
/**
|
|
8314
8039
|
* When used on a pattern, defines how the pattern's parameters may be overridden
|
|
@@ -8317,7 +8042,7 @@ interface components$d {
|
|
|
8317
8042
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
8318
8043
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
8319
8044
|
*/
|
|
8320
|
-
_overridability?: components$
|
|
8045
|
+
_overridability?: components$e["schemas"]["ComponentOverridability"];
|
|
8321
8046
|
/** Array of locales which have data defined on the composition. If empty, the current default locale implicitly has data */
|
|
8322
8047
|
_locales?: string[];
|
|
8323
8048
|
/**
|
|
@@ -8356,7 +8081,7 @@ interface components$d {
|
|
|
8356
8081
|
* NOTE: Users without membership in any role listed here will be unable to execute the transition unless they are team admins
|
|
8357
8082
|
*/
|
|
8358
8083
|
permissions: {
|
|
8359
|
-
[key: string]: components$
|
|
8084
|
+
[key: string]: components$e["schemas"]["WorkflowStageTransitionPermission"];
|
|
8360
8085
|
};
|
|
8361
8086
|
};
|
|
8362
8087
|
/** Definition of a stage in a workflow */
|
|
@@ -8370,7 +8095,7 @@ interface components$d {
|
|
|
8370
8095
|
* listed here, the stage is read-only and publishing is disabled
|
|
8371
8096
|
*/
|
|
8372
8097
|
permissions: {
|
|
8373
|
-
[key: string]: components$
|
|
8098
|
+
[key: string]: components$e["schemas"]["WorkflowStagePermission"];
|
|
8374
8099
|
};
|
|
8375
8100
|
/**
|
|
8376
8101
|
* When true, transitioning into this stage from a different stage will automatically publish the entity.
|
|
@@ -8390,7 +8115,7 @@ interface components$d {
|
|
|
8390
8115
|
* Every stage must define at least one transition, to avoid creating a workflow that
|
|
8391
8116
|
* has a stage that can never be escaped
|
|
8392
8117
|
*/
|
|
8393
|
-
transitions: components$
|
|
8118
|
+
transitions: components$e["schemas"]["WorkflowStageTransition"][];
|
|
8394
8119
|
/**
|
|
8395
8120
|
* Icon name for the stage (e.g. 'chevron-double-right-o')
|
|
8396
8121
|
* @defaultValue chevron-double-right-o
|
|
@@ -8415,7 +8140,7 @@ interface components$d {
|
|
|
8415
8140
|
initialStage: string;
|
|
8416
8141
|
/** All stages of the workflow */
|
|
8417
8142
|
stages: {
|
|
8418
|
-
[key: string]: components$
|
|
8143
|
+
[key: string]: components$e["schemas"]["WorkflowStage"];
|
|
8419
8144
|
};
|
|
8420
8145
|
/** Last modified ISO date string for this definition (ignored for writes) */
|
|
8421
8146
|
modified?: string;
|
|
@@ -8446,7 +8171,7 @@ interface components$d {
|
|
|
8446
8171
|
[name: string]: unknown;
|
|
8447
8172
|
};
|
|
8448
8173
|
content: {
|
|
8449
|
-
"application/json": components$
|
|
8174
|
+
"application/json": components$e["schemas"]["Error"];
|
|
8450
8175
|
};
|
|
8451
8176
|
};
|
|
8452
8177
|
/** API key or token was not valid */
|
|
@@ -8455,7 +8180,7 @@ interface components$d {
|
|
|
8455
8180
|
[name: string]: unknown;
|
|
8456
8181
|
};
|
|
8457
8182
|
content: {
|
|
8458
|
-
"application/json": components$
|
|
8183
|
+
"application/json": components$e["schemas"]["Error"];
|
|
8459
8184
|
};
|
|
8460
8185
|
};
|
|
8461
8186
|
/** Permission was denied */
|
|
@@ -8464,7 +8189,7 @@ interface components$d {
|
|
|
8464
8189
|
[name: string]: unknown;
|
|
8465
8190
|
};
|
|
8466
8191
|
content: {
|
|
8467
|
-
"application/json": components$
|
|
8192
|
+
"application/json": components$e["schemas"]["Error"];
|
|
8468
8193
|
};
|
|
8469
8194
|
};
|
|
8470
8195
|
/** Too many requests in allowed time period */
|
|
@@ -8747,7 +8472,7 @@ interface components$d {
|
|
|
8747
8472
|
pathItems: never;
|
|
8748
8473
|
}
|
|
8749
8474
|
|
|
8750
|
-
interface paths$
|
|
8475
|
+
interface paths$c {
|
|
8751
8476
|
"/api/v1/canvas-history": {
|
|
8752
8477
|
parameters: {
|
|
8753
8478
|
query?: never;
|
|
@@ -8781,12 +8506,12 @@ interface paths$b {
|
|
|
8781
8506
|
[name: string]: unknown;
|
|
8782
8507
|
};
|
|
8783
8508
|
content: {
|
|
8784
|
-
"application/json": components$
|
|
8509
|
+
"application/json": components$d["schemas"]["HistoryApiResponse"];
|
|
8785
8510
|
};
|
|
8786
8511
|
};
|
|
8787
|
-
400: components$
|
|
8788
|
-
401: components$
|
|
8789
|
-
403: components$
|
|
8512
|
+
400: components$d["responses"]["BadRequestError"];
|
|
8513
|
+
401: components$d["responses"]["UnauthorizedError"];
|
|
8514
|
+
403: components$d["responses"]["ForbiddenError"];
|
|
8790
8515
|
/** Composition not found */
|
|
8791
8516
|
404: {
|
|
8792
8517
|
headers: {
|
|
@@ -8796,8 +8521,8 @@ interface paths$b {
|
|
|
8796
8521
|
"text/plain": string;
|
|
8797
8522
|
};
|
|
8798
8523
|
};
|
|
8799
|
-
429: components$
|
|
8800
|
-
500: components$
|
|
8524
|
+
429: components$d["responses"]["RateLimitError"];
|
|
8525
|
+
500: components$d["responses"]["InternalServerError"];
|
|
8801
8526
|
};
|
|
8802
8527
|
};
|
|
8803
8528
|
put?: never;
|
|
@@ -8809,7 +8534,7 @@ interface paths$b {
|
|
|
8809
8534
|
trace?: never;
|
|
8810
8535
|
};
|
|
8811
8536
|
}
|
|
8812
|
-
interface components$
|
|
8537
|
+
interface components$d {
|
|
8813
8538
|
schemas: {
|
|
8814
8539
|
HistoryEntry: {
|
|
8815
8540
|
/** The version ID of the entity. This can be used to fetch the version's data via the entity API */
|
|
@@ -8833,7 +8558,7 @@ interface components$c {
|
|
|
8833
8558
|
/** If more history is available than your plan allows, and additional entries are available by upgrading, this will be true */
|
|
8834
8559
|
truncated?: boolean;
|
|
8835
8560
|
/** Version history entries */
|
|
8836
|
-
results?: components$
|
|
8561
|
+
results?: components$d["schemas"]["HistoryEntry"][];
|
|
8837
8562
|
};
|
|
8838
8563
|
Error: {
|
|
8839
8564
|
/** Error message(s) that occurred while processing the request */
|
|
@@ -8847,7 +8572,7 @@ interface components$c {
|
|
|
8847
8572
|
[name: string]: unknown;
|
|
8848
8573
|
};
|
|
8849
8574
|
content: {
|
|
8850
|
-
"application/json": components$
|
|
8575
|
+
"application/json": components$d["schemas"]["Error"];
|
|
8851
8576
|
};
|
|
8852
8577
|
};
|
|
8853
8578
|
/** API key or token was not valid */
|
|
@@ -8856,7 +8581,7 @@ interface components$c {
|
|
|
8856
8581
|
[name: string]: unknown;
|
|
8857
8582
|
};
|
|
8858
8583
|
content: {
|
|
8859
|
-
"application/json": components$
|
|
8584
|
+
"application/json": components$d["schemas"]["Error"];
|
|
8860
8585
|
};
|
|
8861
8586
|
};
|
|
8862
8587
|
/** Permission was denied */
|
|
@@ -8865,7 +8590,7 @@ interface components$c {
|
|
|
8865
8590
|
[name: string]: unknown;
|
|
8866
8591
|
};
|
|
8867
8592
|
content: {
|
|
8868
|
-
"application/json": components$
|
|
8593
|
+
"application/json": components$d["schemas"]["Error"];
|
|
8869
8594
|
};
|
|
8870
8595
|
};
|
|
8871
8596
|
/** Too many requests in allowed time period */
|
|
@@ -8889,41 +8614,41 @@ interface components$c {
|
|
|
8889
8614
|
pathItems: never;
|
|
8890
8615
|
}
|
|
8891
8616
|
|
|
8892
|
-
interface components$
|
|
8617
|
+
interface components$c {
|
|
8893
8618
|
schemas: {
|
|
8894
|
-
CompositionResolvedGetResponse: components$
|
|
8619
|
+
CompositionResolvedGetResponse: components$c["schemas"]["EdgehancersResolutionInfo"] & components$c["schemas"]["CompositionApiResponse"];
|
|
8895
8620
|
CompositionResolvedListResponse: {
|
|
8896
|
-
diagnostics?: components$
|
|
8621
|
+
diagnostics?: components$c["schemas"]["EdgehancersDiagnostics"] & {
|
|
8897
8622
|
data?: {
|
|
8898
|
-
[key: string]: components$
|
|
8623
|
+
[key: string]: components$c["schemas"]["DataDiagnostic"][];
|
|
8899
8624
|
};
|
|
8900
8625
|
};
|
|
8901
8626
|
errors?: {
|
|
8902
|
-
[key: string]: components$
|
|
8627
|
+
[key: string]: components$c["schemas"]["DataResolutionIssue"][];
|
|
8903
8628
|
};
|
|
8904
8629
|
warnings?: {
|
|
8905
|
-
[key: string]: components$
|
|
8630
|
+
[key: string]: components$c["schemas"]["DataResolutionIssue"][];
|
|
8906
8631
|
};
|
|
8907
8632
|
infos?: {
|
|
8908
|
-
[key: string]: components$
|
|
8633
|
+
[key: string]: components$c["schemas"]["DataResolutionIssue"][];
|
|
8909
8634
|
};
|
|
8910
|
-
} & components$
|
|
8635
|
+
} & components$c["schemas"]["CompositionListResponse"];
|
|
8911
8636
|
EntryResolvedListResponse: {
|
|
8912
|
-
diagnostics?: components$
|
|
8637
|
+
diagnostics?: components$c["schemas"]["EdgehancersDiagnostics"] & {
|
|
8913
8638
|
data?: {
|
|
8914
|
-
[key: string]: components$
|
|
8639
|
+
[key: string]: components$c["schemas"]["DataDiagnostic"][];
|
|
8915
8640
|
};
|
|
8916
8641
|
};
|
|
8917
8642
|
errors?: {
|
|
8918
|
-
[key: string]: components$
|
|
8643
|
+
[key: string]: components$c["schemas"]["DataResolutionIssue"][];
|
|
8919
8644
|
};
|
|
8920
8645
|
warnings?: {
|
|
8921
|
-
[key: string]: components$
|
|
8646
|
+
[key: string]: components$c["schemas"]["DataResolutionIssue"][];
|
|
8922
8647
|
};
|
|
8923
8648
|
infos?: {
|
|
8924
|
-
[key: string]: components$
|
|
8649
|
+
[key: string]: components$c["schemas"]["DataResolutionIssue"][];
|
|
8925
8650
|
};
|
|
8926
|
-
} & components$
|
|
8651
|
+
} & components$c["schemas"]["EntryListResponse"];
|
|
8927
8652
|
EdgehancersResolutionInfo: {
|
|
8928
8653
|
wholeResponseCacheDiagnostics?: {
|
|
8929
8654
|
info: string;
|
|
@@ -8932,19 +8657,19 @@ interface components$b {
|
|
|
8932
8657
|
edgeLocation?: string;
|
|
8933
8658
|
requestId: string;
|
|
8934
8659
|
};
|
|
8935
|
-
diagnostics?: components$
|
|
8936
|
-
data?: components$
|
|
8660
|
+
diagnostics?: components$c["schemas"]["EdgehancersDiagnostics"] & {
|
|
8661
|
+
data?: components$c["schemas"]["DataDiagnostic"][];
|
|
8937
8662
|
};
|
|
8938
|
-
errors?: components$
|
|
8939
|
-
warnings?: components$
|
|
8940
|
-
infos?: components$
|
|
8663
|
+
errors?: components$c["schemas"]["DataResolutionIssue"][];
|
|
8664
|
+
warnings?: components$c["schemas"]["DataResolutionIssue"][];
|
|
8665
|
+
infos?: components$c["schemas"]["DataResolutionIssue"][];
|
|
8941
8666
|
};
|
|
8942
8667
|
EdgehancersError: {
|
|
8943
8668
|
message: string;
|
|
8944
8669
|
status: number;
|
|
8945
8670
|
statusText: string;
|
|
8946
8671
|
};
|
|
8947
|
-
UniformError: components$
|
|
8672
|
+
UniformError: components$c["schemas"]["EdgehancersError"] | components$c["schemas"]["Error"];
|
|
8948
8673
|
InvalidationPayload: {
|
|
8949
8674
|
/** List of variables with values to invalidate */
|
|
8950
8675
|
variables?: {
|
|
@@ -8958,7 +8683,7 @@ interface components$b {
|
|
|
8958
8683
|
dataTypeId: string;
|
|
8959
8684
|
/** Format: uuid */
|
|
8960
8685
|
purgeKey: string;
|
|
8961
|
-
conditions?: components$
|
|
8686
|
+
conditions?: components$c["schemas"]["InvalidationPayload"];
|
|
8962
8687
|
}[];
|
|
8963
8688
|
DataDiagnostic: {
|
|
8964
8689
|
componentPath: string;
|
|
@@ -9018,7 +8743,7 @@ interface components$b {
|
|
|
9018
8743
|
message: string;
|
|
9019
8744
|
type: string;
|
|
9020
8745
|
parameterName?: string;
|
|
9021
|
-
expression?: components$
|
|
8746
|
+
expression?: components$c["schemas"]["DataElementConnectionDefinition"];
|
|
9022
8747
|
dataName?: string;
|
|
9023
8748
|
dataType?: string;
|
|
9024
8749
|
inputName?: string;
|
|
@@ -9093,11 +8818,11 @@ interface components$b {
|
|
|
9093
8818
|
|
|
9094
8819
|
*/
|
|
9095
8820
|
op?: "&" | "|";
|
|
9096
|
-
clauses: (components$
|
|
8821
|
+
clauses: (components$c["schemas"]["VisibilityCriteria"] | components$c["schemas"]["VisibilityCriteriaGroup"])[];
|
|
9097
8822
|
};
|
|
9098
8823
|
/** Defines a conditional value for a component parameter */
|
|
9099
8824
|
ComponentParameterConditionalValue: {
|
|
9100
|
-
when: components$
|
|
8825
|
+
when: components$c["schemas"]["VisibilityCriteriaGroup"];
|
|
9101
8826
|
/**
|
|
9102
8827
|
* The value of the parameter. Any JSON-serializable value is acceptable.
|
|
9103
8828
|
* A value of `null` will cause the parameter value to be removed, if it matches.
|
|
@@ -9119,7 +8844,7 @@ interface components$b {
|
|
|
9119
8844
|
*
|
|
9120
8845
|
* When no locale is passed to a non-route API, conditions are not processed and all conditions are returned.
|
|
9121
8846
|
*/
|
|
9122
|
-
ComponentParameterConditions: components$
|
|
8847
|
+
ComponentParameterConditions: components$c["schemas"]["ComponentParameterConditionalValue"][];
|
|
9123
8848
|
/** Defines an editable parameter on a component */
|
|
9124
8849
|
ComponentParameter: {
|
|
9125
8850
|
/** The value of the parameter. Any JSON-serializable value is acceptable */
|
|
@@ -9127,7 +8852,7 @@ interface components$b {
|
|
|
9127
8852
|
/** The type of the parameter. Determines how it is displayed when editing and tells the consumer how to process it */
|
|
9128
8853
|
type: string;
|
|
9129
8854
|
/** @deprecated */
|
|
9130
|
-
connectedData?: components$
|
|
8855
|
+
connectedData?: components$c["schemas"]["DataElementConnectionDefinition"];
|
|
9131
8856
|
/**
|
|
9132
8857
|
* Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
|
|
9133
8858
|
* Note that locales must be registered on the entry/composition `_locales` before being used
|
|
@@ -9135,10 +8860,10 @@ interface components$b {
|
|
|
9135
8860
|
locales?: {
|
|
9136
8861
|
[key: string]: unknown;
|
|
9137
8862
|
};
|
|
9138
|
-
conditions?: components$
|
|
8863
|
+
conditions?: components$c["schemas"]["ComponentParameterConditions"];
|
|
9139
8864
|
/** Locale-specific conditional values for this parameter. Keys are locale codes, and values are the `conditions` for that locale. */
|
|
9140
8865
|
localesConditions?: {
|
|
9141
|
-
[key: string]: components$
|
|
8866
|
+
[key: string]: components$c["schemas"]["ComponentParameterConditions"];
|
|
9142
8867
|
};
|
|
9143
8868
|
};
|
|
9144
8869
|
ProjectMapNodeAllowedQueryString: {
|
|
@@ -9173,7 +8898,7 @@ interface components$b {
|
|
|
9173
8898
|
/** While performing a search if a node is a hit, this property will return true. If it's supporting structure, like a parent of a search hit, it will return false */
|
|
9174
8899
|
isSearchHit?: boolean;
|
|
9175
8900
|
/** Query strings that are allowed to be passed to the node */
|
|
9176
|
-
queryStrings?: components$
|
|
8901
|
+
queryStrings?: components$c["schemas"]["ProjectMapNodeAllowedQueryString"][];
|
|
9177
8902
|
/**
|
|
9178
8903
|
* For dynamic nodes, this is the preview value for the dynamic value.
|
|
9179
8904
|
* The preview value is used when editing a connected composition, and is the default
|
|
@@ -9198,7 +8923,7 @@ interface components$b {
|
|
|
9198
8923
|
* Unique identifier for the project map that this node belongs to
|
|
9199
8924
|
*/
|
|
9200
8925
|
projectMapId: string;
|
|
9201
|
-
data?: components$
|
|
8926
|
+
data?: components$c["schemas"]["ProjectMapNodeData"];
|
|
9202
8927
|
/**
|
|
9203
8928
|
* Locale-specific paths of the project map node.
|
|
9204
8929
|
* Keys are locale codes
|
|
@@ -9218,13 +8943,13 @@ interface components$b {
|
|
|
9218
8943
|
type: string;
|
|
9219
8944
|
/** Component parameter values for the component instance */
|
|
9220
8945
|
parameters?: {
|
|
9221
|
-
[key: string]: components$
|
|
8946
|
+
[key: string]: components$c["schemas"]["ComponentParameter"];
|
|
9222
8947
|
};
|
|
9223
8948
|
/** Public ID of alternate visual appearance for this component, if any selected */
|
|
9224
8949
|
variant?: string;
|
|
9225
8950
|
/** Slots containing any child components */
|
|
9226
8951
|
slots?: {
|
|
9227
|
-
[key: string]: components$
|
|
8952
|
+
[key: string]: components$c["schemas"]["ComponentInstance"][];
|
|
9228
8953
|
};
|
|
9229
8954
|
/**
|
|
9230
8955
|
* Unique identifier of the component within the composition.
|
|
@@ -9235,20 +8960,20 @@ interface components$b {
|
|
|
9235
8960
|
_id?: string;
|
|
9236
8961
|
/** Indicates this component instance should be sourced from a pattern library pattern */
|
|
9237
8962
|
_pattern?: string;
|
|
9238
|
-
_dataResources?: components$
|
|
8963
|
+
_dataResources?: components$c["schemas"]["DataResourceDefinitions"];
|
|
9239
8964
|
/**
|
|
9240
8965
|
* Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
|
9241
8966
|
* Means nothing for PUTs; it will be ignored
|
|
9242
8967
|
*/
|
|
9243
8968
|
_patternDataResources?: {
|
|
9244
|
-
[key: string]: components$
|
|
8969
|
+
[key: string]: components$c["schemas"]["DataResourceDefinition"];
|
|
9245
8970
|
};
|
|
9246
8971
|
/**
|
|
9247
8972
|
* Query-string opt-ins coming from a pattern resolved for this component.
|
|
9248
8973
|
* Means nothing for PUTs; it will be ignored
|
|
9249
8974
|
*/
|
|
9250
8975
|
_patternOptedInQueryStrings?: string[];
|
|
9251
|
-
_patternError?: components$
|
|
8976
|
+
_patternError?: components$c["schemas"]["PatternError"];
|
|
9252
8977
|
/**
|
|
9253
8978
|
* Defines patch overrides to component IDs that live in the composition.
|
|
9254
8979
|
* This can be used to override parameters that are defined on patterns,
|
|
@@ -9262,14 +8987,14 @@ interface components$b {
|
|
|
9262
8987
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
9263
8988
|
*/
|
|
9264
8989
|
_overrides?: {
|
|
9265
|
-
[key: string]: components$
|
|
8990
|
+
[key: string]: components$c["schemas"]["ComponentOverride"];
|
|
9266
8991
|
};
|
|
9267
8992
|
/**
|
|
9268
8993
|
* Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
|
|
9269
8994
|
* Means nothing for PUTs; it will be ignored
|
|
9270
8995
|
*/
|
|
9271
8996
|
_patternOverrides?: {
|
|
9272
|
-
[key: string]: components$
|
|
8997
|
+
[key: string]: components$c["schemas"]["ComponentOverride"];
|
|
9273
8998
|
};
|
|
9274
8999
|
/**
|
|
9275
9000
|
* When used on a pattern, defines how the pattern's parameters may be overridden
|
|
@@ -9278,7 +9003,7 @@ interface components$b {
|
|
|
9278
9003
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
9279
9004
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
9280
9005
|
*/
|
|
9281
|
-
_overridability?: components$
|
|
9006
|
+
_overridability?: components$c["schemas"]["ComponentOverridability"];
|
|
9282
9007
|
/** Array of locales that have data defined. Only set for pattern references or composition defaults */
|
|
9283
9008
|
_locales?: string[];
|
|
9284
9009
|
};
|
|
@@ -9303,14 +9028,14 @@ interface components$b {
|
|
|
9303
9028
|
* If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
|
|
9304
9029
|
*/
|
|
9305
9030
|
optionalPatternParameter?: boolean;
|
|
9306
|
-
variables?: components$
|
|
9031
|
+
variables?: components$c["schemas"]["DataResourceVariables"];
|
|
9307
9032
|
};
|
|
9308
9033
|
/**
|
|
9309
9034
|
* Data definitions attached to this component. The property name is the key of the data in the data document.
|
|
9310
9035
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key)
|
|
9311
9036
|
*/
|
|
9312
9037
|
DataResourceDefinitions: {
|
|
9313
|
-
[key: string]: components$
|
|
9038
|
+
[key: string]: components$c["schemas"]["DataResourceDefinition"];
|
|
9314
9039
|
};
|
|
9315
9040
|
/**
|
|
9316
9041
|
* Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
|
@@ -9328,10 +9053,10 @@ interface components$b {
|
|
|
9328
9053
|
*/
|
|
9329
9054
|
ComponentOverride: {
|
|
9330
9055
|
parameters?: {
|
|
9331
|
-
[key: string]: components$
|
|
9056
|
+
[key: string]: components$c["schemas"]["ComponentParameter"];
|
|
9332
9057
|
};
|
|
9333
9058
|
slots?: {
|
|
9334
|
-
[key: string]: components$
|
|
9059
|
+
[key: string]: components$c["schemas"]["ComponentInstance"][];
|
|
9335
9060
|
};
|
|
9336
9061
|
variant?: string;
|
|
9337
9062
|
/**
|
|
@@ -9340,7 +9065,7 @@ interface components$b {
|
|
|
9340
9065
|
* Overrides defined here replace values in either _dataResources or _patternDataResources on the target component.
|
|
9341
9066
|
*/
|
|
9342
9067
|
dataResources?: {
|
|
9343
|
-
[key: string]: components$
|
|
9068
|
+
[key: string]: components$c["schemas"]["DataResourceDefinition"];
|
|
9344
9069
|
};
|
|
9345
9070
|
};
|
|
9346
9071
|
/**
|
|
@@ -9361,7 +9086,7 @@ interface components$b {
|
|
|
9361
9086
|
ComponentOverridability: {
|
|
9362
9087
|
/** Defines component parameter value overrides. Keys are the parameter public ID */
|
|
9363
9088
|
parameters?: {
|
|
9364
|
-
[key: string]: components$
|
|
9089
|
+
[key: string]: components$c["schemas"]["OverrideOptions"];
|
|
9365
9090
|
};
|
|
9366
9091
|
/** Allows overriding a display variant is allowed if it is defined on the component the pattern is derived from. Default = false */
|
|
9367
9092
|
variants?: boolean;
|
|
@@ -9378,15 +9103,15 @@ interface components$b {
|
|
|
9378
9103
|
type: string;
|
|
9379
9104
|
/** Component parameter values for the component instance */
|
|
9380
9105
|
parameters?: {
|
|
9381
|
-
[key: string]: components$
|
|
9106
|
+
[key: string]: components$c["schemas"]["ComponentParameter"];
|
|
9382
9107
|
};
|
|
9383
9108
|
/** Public ID of alternate visual appearance for this component, if any selected */
|
|
9384
9109
|
variant?: string;
|
|
9385
9110
|
/** Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated */
|
|
9386
|
-
projectMapNodes?: components$
|
|
9111
|
+
projectMapNodes?: components$c["schemas"]["CompositionProjectMapNodeInfo"][];
|
|
9387
9112
|
/** Slots containing any child components */
|
|
9388
9113
|
slots?: {
|
|
9389
|
-
[key: string]: components$
|
|
9114
|
+
[key: string]: components$c["schemas"]["ComponentInstance"][];
|
|
9390
9115
|
};
|
|
9391
9116
|
/** The ID of the composition */
|
|
9392
9117
|
_id: string;
|
|
@@ -9409,15 +9134,15 @@ interface components$b {
|
|
|
9409
9134
|
* Means nothing for PUTs; it will be ignored
|
|
9410
9135
|
*/
|
|
9411
9136
|
_patternDataResources?: {
|
|
9412
|
-
[key: string]: components$
|
|
9137
|
+
[key: string]: components$c["schemas"]["DataResourceDefinition"];
|
|
9413
9138
|
};
|
|
9414
9139
|
/**
|
|
9415
9140
|
* Query-string opt-ins coming from a pattern resolved for this component.
|
|
9416
9141
|
* Means nothing for PUTs; it will be ignored
|
|
9417
9142
|
*/
|
|
9418
9143
|
_patternOptedInQueryStrings?: string[];
|
|
9419
|
-
_dataResources?: components$
|
|
9420
|
-
_patternError?: components$
|
|
9144
|
+
_dataResources?: components$c["schemas"]["DataResourceDefinitions"];
|
|
9145
|
+
_patternError?: components$c["schemas"]["PatternError"];
|
|
9421
9146
|
/**
|
|
9422
9147
|
* Defines patch overrides to component IDs that live in the composition.
|
|
9423
9148
|
* This can be used to override parameters that are defined on patterns,
|
|
@@ -9431,14 +9156,14 @@ interface components$b {
|
|
|
9431
9156
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
9432
9157
|
*/
|
|
9433
9158
|
_overrides?: {
|
|
9434
|
-
[key: string]: components$
|
|
9159
|
+
[key: string]: components$c["schemas"]["ComponentOverride"];
|
|
9435
9160
|
};
|
|
9436
9161
|
/**
|
|
9437
9162
|
* Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
|
|
9438
9163
|
* Means nothing for PUTs; it will be ignored
|
|
9439
9164
|
*/
|
|
9440
9165
|
_patternOverrides?: {
|
|
9441
|
-
[key: string]: components$
|
|
9166
|
+
[key: string]: components$c["schemas"]["ComponentOverride"];
|
|
9442
9167
|
};
|
|
9443
9168
|
/**
|
|
9444
9169
|
* When used on a pattern, defines how the pattern's parameters may be overridden
|
|
@@ -9447,7 +9172,7 @@ interface components$b {
|
|
|
9447
9172
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
9448
9173
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
9449
9174
|
*/
|
|
9450
|
-
_overridability?: components$
|
|
9175
|
+
_overridability?: components$c["schemas"]["ComponentOverridability"];
|
|
9451
9176
|
/** Array of locales which have data defined on the composition. If empty, the current default locale implicitly has data */
|
|
9452
9177
|
_locales?: string[];
|
|
9453
9178
|
/**
|
|
@@ -9486,7 +9211,7 @@ interface components$b {
|
|
|
9486
9211
|
* NOTE: Users without membership in any role listed here will be unable to execute the transition unless they are team admins
|
|
9487
9212
|
*/
|
|
9488
9213
|
permissions: {
|
|
9489
|
-
[key: string]: components$
|
|
9214
|
+
[key: string]: components$c["schemas"]["WorkflowStageTransitionPermission"];
|
|
9490
9215
|
};
|
|
9491
9216
|
};
|
|
9492
9217
|
/** Definition of a stage in a workflow */
|
|
@@ -9500,7 +9225,7 @@ interface components$b {
|
|
|
9500
9225
|
* listed here, the stage is read-only and publishing is disabled
|
|
9501
9226
|
*/
|
|
9502
9227
|
permissions: {
|
|
9503
|
-
[key: string]: components$
|
|
9228
|
+
[key: string]: components$c["schemas"]["WorkflowStagePermission"];
|
|
9504
9229
|
};
|
|
9505
9230
|
/**
|
|
9506
9231
|
* When true, transitioning into this stage from a different stage will automatically publish the entity.
|
|
@@ -9520,7 +9245,7 @@ interface components$b {
|
|
|
9520
9245
|
* Every stage must define at least one transition, to avoid creating a workflow that
|
|
9521
9246
|
* has a stage that can never be escaped
|
|
9522
9247
|
*/
|
|
9523
|
-
transitions: components$
|
|
9248
|
+
transitions: components$c["schemas"]["WorkflowStageTransition"][];
|
|
9524
9249
|
/**
|
|
9525
9250
|
* Icon name for the stage (e.g. 'chevron-double-right-o')
|
|
9526
9251
|
* @defaultValue chevron-double-right-o
|
|
@@ -9545,7 +9270,7 @@ interface components$b {
|
|
|
9545
9270
|
initialStage: string;
|
|
9546
9271
|
/** All stages of the workflow */
|
|
9547
9272
|
stages: {
|
|
9548
|
-
[key: string]: components$
|
|
9273
|
+
[key: string]: components$c["schemas"]["WorkflowStage"];
|
|
9549
9274
|
};
|
|
9550
9275
|
/** Last modified ISO date string for this definition (ignored for writes) */
|
|
9551
9276
|
modified?: string;
|
|
@@ -9593,6 +9318,8 @@ interface components$b {
|
|
|
9593
9318
|
* Timestamp when the item was moved to trash. Omitted if not in trash.
|
|
9594
9319
|
*/
|
|
9595
9320
|
deletedAt?: string;
|
|
9321
|
+
/** Present when the item is in trash, omitted otherwise. True when the item was published with no unpublished changes at the moment it was trashed. False otherwise, including items trashed before this field existed. */
|
|
9322
|
+
publishedWhenTrashed?: boolean;
|
|
9596
9323
|
/** User name of the creator of this composition */
|
|
9597
9324
|
creator?: string;
|
|
9598
9325
|
/** User name of the last editor of this composition */
|
|
@@ -9618,7 +9345,7 @@ interface components$b {
|
|
|
9618
9345
|
* The release this composition belongs to. If not set, it belongs to the base
|
|
9619
9346
|
*/
|
|
9620
9347
|
releaseId?: string;
|
|
9621
|
-
composition: components$
|
|
9348
|
+
composition: components$c["schemas"]["RootComponentInstance"];
|
|
9622
9349
|
/**
|
|
9623
9350
|
* Format: uuid
|
|
9624
9351
|
* The workflow ID assigned to this composition, if any. Normally comes from the component definition
|
|
@@ -9636,7 +9363,7 @@ interface components$b {
|
|
|
9636
9363
|
*/
|
|
9637
9364
|
instanceWorkflowId?: string;
|
|
9638
9365
|
/** The full definition of the assigned workflow, if any, including stages, permissions, etc. Returned only when `withWorkflowDefinition` is true */
|
|
9639
|
-
workflowDefinition?: components$
|
|
9366
|
+
workflowDefinition?: components$c["schemas"]["WorkflowDefinition"];
|
|
9640
9367
|
/**
|
|
9641
9368
|
* Format: uuid
|
|
9642
9369
|
* The edition ID. When set, this is a child edition of the composition in _id.
|
|
@@ -9654,7 +9381,7 @@ interface components$b {
|
|
|
9654
9381
|
editionPriority?: number;
|
|
9655
9382
|
};
|
|
9656
9383
|
CompositionListResponse: {
|
|
9657
|
-
compositions: components$
|
|
9384
|
+
compositions: components$c["schemas"]["CompositionApiResponse"][];
|
|
9658
9385
|
/** Total number of compositions that match the query. Present only when `withTotalCount` option is true */
|
|
9659
9386
|
totalCount?: number;
|
|
9660
9387
|
/** Per-field counts for distinct values */
|
|
@@ -9715,10 +9442,10 @@ interface components$b {
|
|
|
9715
9442
|
RouteResponseRedirect: {
|
|
9716
9443
|
/** The route that was matched in the redirects */
|
|
9717
9444
|
matchedRoute: string;
|
|
9718
|
-
dynamicInputs?: components$
|
|
9445
|
+
dynamicInputs?: components$c["schemas"]["RouteDynamicInputs"];
|
|
9719
9446
|
/** @enum {string} */
|
|
9720
9447
|
type: "redirect";
|
|
9721
|
-
redirect: components$
|
|
9448
|
+
redirect: components$c["schemas"]["Redirect"];
|
|
9722
9449
|
};
|
|
9723
9450
|
/**
|
|
9724
9451
|
* The route does not match any configured redirections or compositions.
|
|
@@ -9758,15 +9485,15 @@ interface components$b {
|
|
|
9758
9485
|
_locales?: string[];
|
|
9759
9486
|
/** Entry field values */
|
|
9760
9487
|
fields?: {
|
|
9761
|
-
[key: string]: components$
|
|
9488
|
+
[key: string]: components$c["schemas"]["ComponentParameter"];
|
|
9762
9489
|
};
|
|
9763
|
-
_dataResources?: components$
|
|
9490
|
+
_dataResources?: components$c["schemas"]["DataResourceDefinitions"];
|
|
9764
9491
|
/**
|
|
9765
9492
|
* Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
|
9766
9493
|
* Means nothing for PUTs; it will be ignored
|
|
9767
9494
|
*/
|
|
9768
9495
|
_patternDataResources?: {
|
|
9769
|
-
[key: string]: components$
|
|
9496
|
+
[key: string]: components$c["schemas"]["DataResourceDefinition"];
|
|
9770
9497
|
};
|
|
9771
9498
|
/**
|
|
9772
9499
|
* Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
|
@@ -9789,7 +9516,7 @@ interface components$b {
|
|
|
9789
9516
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
9790
9517
|
*/
|
|
9791
9518
|
_overrides?: {
|
|
9792
|
-
[key: string]: components$
|
|
9519
|
+
[key: string]: components$c["schemas"]["ComponentOverride"];
|
|
9793
9520
|
};
|
|
9794
9521
|
/**
|
|
9795
9522
|
* When used on a pattern, defines how the pattern's parameters may be overridden
|
|
@@ -9798,7 +9525,7 @@ interface components$b {
|
|
|
9798
9525
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
9799
9526
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
9800
9527
|
*/
|
|
9801
|
-
_overridability?: components$
|
|
9528
|
+
_overridability?: components$c["schemas"]["ComponentOverridability"];
|
|
9802
9529
|
};
|
|
9803
9530
|
EntryApiResponse: {
|
|
9804
9531
|
/** Publishing state to fetch. 0 = draft, 64 = published */
|
|
@@ -9834,12 +9561,14 @@ interface components$b {
|
|
|
9834
9561
|
* Timestamp when the item was moved to trash. Omitted if not in trash.
|
|
9835
9562
|
*/
|
|
9836
9563
|
deletedAt?: string;
|
|
9564
|
+
/** Present when the item is in trash, omitted otherwise. True when the item was published with no unpublished changes at the moment it was trashed. False otherwise, including items trashed before this field existed. */
|
|
9565
|
+
publishedWhenTrashed?: boolean;
|
|
9837
9566
|
/**
|
|
9838
9567
|
* True if the entry is a pattern (which can be referenced on other entries)
|
|
9839
9568
|
* @defaultValue false
|
|
9840
9569
|
*/
|
|
9841
9570
|
pattern?: boolean;
|
|
9842
|
-
entry: components$
|
|
9571
|
+
entry: components$c["schemas"]["Entry"];
|
|
9843
9572
|
/**
|
|
9844
9573
|
* Format: uuid
|
|
9845
9574
|
* The workflow ID that this entry is assigned. Normally comes from the content type
|
|
@@ -9857,7 +9586,7 @@ interface components$b {
|
|
|
9857
9586
|
*/
|
|
9858
9587
|
instanceWorkflowId?: string;
|
|
9859
9588
|
/** The full definition of the assigned workflow, if any, including stages, permissions, etc. Only returned when `withWorkflowDefinition` is true */
|
|
9860
|
-
workflowDefinition?: components$
|
|
9589
|
+
workflowDefinition?: components$c["schemas"]["WorkflowDefinition"];
|
|
9861
9590
|
/**
|
|
9862
9591
|
* Only present if an incomplete entry is returned; indicates reason for stubbing
|
|
9863
9592
|
|
|
@@ -9880,7 +9609,7 @@ interface components$b {
|
|
|
9880
9609
|
editionPriority?: number;
|
|
9881
9610
|
};
|
|
9882
9611
|
EntryListResponse: {
|
|
9883
|
-
entries: components$
|
|
9612
|
+
entries: components$c["schemas"]["EntryApiResponse"][];
|
|
9884
9613
|
/** Total number of entries that match the query. Only present when `withTotalCount` option is true */
|
|
9885
9614
|
totalCount?: number;
|
|
9886
9615
|
/** Per-field counts for distinct values */
|
|
@@ -9898,7 +9627,7 @@ interface components$b {
|
|
|
9898
9627
|
[name: string]: unknown;
|
|
9899
9628
|
};
|
|
9900
9629
|
content: {
|
|
9901
|
-
"application/json": components$
|
|
9630
|
+
"application/json": components$c["schemas"]["UniformError"];
|
|
9902
9631
|
};
|
|
9903
9632
|
};
|
|
9904
9633
|
/** Provided token or API key does not have access to the requested resource */
|
|
@@ -9907,7 +9636,7 @@ interface components$b {
|
|
|
9907
9636
|
[name: string]: unknown;
|
|
9908
9637
|
};
|
|
9909
9638
|
content: {
|
|
9910
|
-
"application/json": components$
|
|
9639
|
+
"application/json": components$c["schemas"]["UniformError"];
|
|
9911
9640
|
};
|
|
9912
9641
|
};
|
|
9913
9642
|
/** Provided token or API key does not allow this action */
|
|
@@ -9916,7 +9645,7 @@ interface components$b {
|
|
|
9916
9645
|
[name: string]: unknown;
|
|
9917
9646
|
};
|
|
9918
9647
|
content: {
|
|
9919
|
-
"application/json": components$
|
|
9648
|
+
"application/json": components$c["schemas"]["UniformError"];
|
|
9920
9649
|
};
|
|
9921
9650
|
};
|
|
9922
9651
|
/** The requested resource does not exist */
|
|
@@ -9925,7 +9654,7 @@ interface components$b {
|
|
|
9925
9654
|
[name: string]: unknown;
|
|
9926
9655
|
};
|
|
9927
9656
|
content: {
|
|
9928
|
-
"application/json": components$
|
|
9657
|
+
"application/json": components$c["schemas"]["UniformError"];
|
|
9929
9658
|
};
|
|
9930
9659
|
};
|
|
9931
9660
|
/** Invalid method was used to call the endpoint */
|
|
@@ -9934,7 +9663,7 @@ interface components$b {
|
|
|
9934
9663
|
[name: string]: unknown;
|
|
9935
9664
|
};
|
|
9936
9665
|
content: {
|
|
9937
|
-
"application/json": components$
|
|
9666
|
+
"application/json": components$c["schemas"]["UniformError"];
|
|
9938
9667
|
};
|
|
9939
9668
|
};
|
|
9940
9669
|
/** The request body could not be parsed or understood */
|
|
@@ -9943,7 +9672,7 @@ interface components$b {
|
|
|
9943
9672
|
[name: string]: unknown;
|
|
9944
9673
|
};
|
|
9945
9674
|
content: {
|
|
9946
|
-
"application/json": components$
|
|
9675
|
+
"application/json": components$c["schemas"]["UniformError"];
|
|
9947
9676
|
};
|
|
9948
9677
|
};
|
|
9949
9678
|
/** The endpoint is called too often */
|
|
@@ -9952,7 +9681,7 @@ interface components$b {
|
|
|
9952
9681
|
[name: string]: unknown;
|
|
9953
9682
|
};
|
|
9954
9683
|
content: {
|
|
9955
|
-
"application/json": components$
|
|
9684
|
+
"application/json": components$c["schemas"]["UniformError"];
|
|
9956
9685
|
};
|
|
9957
9686
|
};
|
|
9958
9687
|
/** An unexpected error occurred */
|
|
@@ -9961,7 +9690,7 @@ interface components$b {
|
|
|
9961
9690
|
[name: string]: unknown;
|
|
9962
9691
|
};
|
|
9963
9692
|
content: {
|
|
9964
|
-
"application/json": components$
|
|
9693
|
+
"application/json": components$c["schemas"]["UniformError"];
|
|
9965
9694
|
};
|
|
9966
9695
|
};
|
|
9967
9696
|
};
|
|
@@ -10174,10 +9903,8 @@ interface components$b {
|
|
|
10174
9903
|
* * If still ambiguous, the first matching route arbitrarily wins
|
|
10175
9904
|
*
|
|
10176
9905
|
* Invalid paths:
|
|
10177
|
-
* The request fails with HTTP 400 when the path, ignoring its query string and trailing slashes
|
|
10178
|
-
*
|
|
10179
|
-
* * has a path segment that is too long to match any route. The limit depends on the characters used,
|
|
10180
|
-
* and is generally 150-220 characters per segment.
|
|
9906
|
+
* The request fails with HTTP 400 when the path, ignoring its query string and trailing slashes,
|
|
9907
|
+
* contains consecutive slashes (for example "/en//about" or "//en/about").
|
|
10181
9908
|
*
|
|
10182
9909
|
* Probe paths:
|
|
10183
9910
|
* On uniform.global, paths ending in an archive, backup or database file extension (for example "/site.zip",
|
|
@@ -10271,7 +9998,7 @@ interface components$b {
|
|
|
10271
9998
|
pathItems: never;
|
|
10272
9999
|
}
|
|
10273
10000
|
|
|
10274
|
-
interface paths$
|
|
10001
|
+
interface paths$b {
|
|
10275
10002
|
"/api/v1/route": {
|
|
10276
10003
|
parameters: {
|
|
10277
10004
|
query?: never;
|
|
@@ -10337,7 +10064,7 @@ interface paths$a {
|
|
|
10337
10064
|
parameters: {
|
|
10338
10065
|
query: {
|
|
10339
10066
|
/** The project to fetch a route from */
|
|
10340
|
-
projectId: components$
|
|
10067
|
+
projectId: components$b["parameters"]["projectId"];
|
|
10341
10068
|
/**
|
|
10342
10069
|
* The path to resolve. Dynamic project map nodes and redirects can be resolved when a matching path is passed.
|
|
10343
10070
|
* Query string parameters may be passed with the path. They are ignored for route matching.
|
|
@@ -10358,31 +10085,29 @@ interface paths$a {
|
|
|
10358
10085
|
* * If still ambiguous, the first matching route arbitrarily wins
|
|
10359
10086
|
*
|
|
10360
10087
|
* Invalid paths:
|
|
10361
|
-
* The request fails with HTTP 400 when the path, ignoring its query string and trailing slashes
|
|
10362
|
-
*
|
|
10363
|
-
* * has a path segment that is too long to match any route. The limit depends on the characters used,
|
|
10364
|
-
* and is generally 150-220 characters per segment.
|
|
10088
|
+
* The request fails with HTTP 400 when the path, ignoring its query string and trailing slashes,
|
|
10089
|
+
* contains consecutive slashes (for example "/en//about" or "//en/about").
|
|
10365
10090
|
*
|
|
10366
10091
|
* Probe paths:
|
|
10367
10092
|
* On uniform.global, paths ending in an archive, backup or database file extension (for example "/site.zip",
|
|
10368
10093
|
* "/config.php.bak" or "/db.sql") return `{ "type": "notFound" }` without being matched, even where a dynamic
|
|
10369
10094
|
* project map node or redirect would match them.
|
|
10370
10095
|
*/
|
|
10371
|
-
path: components$
|
|
10096
|
+
path: components$b["parameters"]["path"];
|
|
10372
10097
|
/** Specify a project map ID to fetch route from. If not specified, the default project map for the projectId is used */
|
|
10373
|
-
projectMapId?: components$
|
|
10098
|
+
projectMapId?: components$b["parameters"]["projectMapId"];
|
|
10374
10099
|
/** Publishing state to fetch. 0 = draft, 64 = published */
|
|
10375
|
-
state?: components$
|
|
10100
|
+
state?: components$b["parameters"]["state"];
|
|
10376
10101
|
/**
|
|
10377
10102
|
* If true the `_id` unique identifier of each non-root component will be part of the response data.
|
|
10378
10103
|
* If false, the `_id` will not be present in the API response
|
|
10379
10104
|
*/
|
|
10380
|
-
withComponentIDs?: components$
|
|
10105
|
+
withComponentIDs?: components$b["parameters"]["withComponentIDs"];
|
|
10381
10106
|
/**
|
|
10382
10107
|
* @deprecated
|
|
10383
10108
|
* Has no effect.
|
|
10384
10109
|
*/
|
|
10385
|
-
withContentSourceMap?: components$
|
|
10110
|
+
withContentSourceMap?: components$b["parameters"]["withContentSourceMap"];
|
|
10386
10111
|
/**
|
|
10387
10112
|
* One or more locales to localize the response to.
|
|
10388
10113
|
* When the result is a composition, it includes only the first matching locale's data.
|
|
@@ -10399,7 +10124,7 @@ interface paths$a {
|
|
|
10399
10124
|
*
|
|
10400
10125
|
* When the result is a redirect, this parameter has no effect
|
|
10401
10126
|
*/
|
|
10402
|
-
locale?: components$
|
|
10127
|
+
locale?: components$b["parameters"]["locale"];
|
|
10403
10128
|
/**
|
|
10404
10129
|
* The ID of a release to fetch the content for.
|
|
10405
10130
|
*
|
|
@@ -10408,19 +10133,19 @@ interface paths$a {
|
|
|
10408
10133
|
*
|
|
10409
10134
|
* Content copied to a release can be differentiated from base content by the `releaseId` property on the content. If the content is not copied to the release, this property will be null
|
|
10410
10135
|
*/
|
|
10411
|
-
releaseId?: components$
|
|
10136
|
+
releaseId?: components$b["parameters"]["releaseId"];
|
|
10412
10137
|
/**
|
|
10413
10138
|
* Indicates the data variant that was fetched for data resources.
|
|
10414
10139
|
* undefined: Data resources were resolved using published data from their data source
|
|
10415
10140
|
* unpublished: Data resources which support unpublished data retrieved unpublished data from their data source. Data resources that did not support unpublished data retrieved published data instead.
|
|
10416
10141
|
*/
|
|
10417
|
-
dataSourceVariant?: components$
|
|
10142
|
+
dataSourceVariant?: components$b["parameters"]["dataSourceVariant"];
|
|
10418
10143
|
/**
|
|
10419
10144
|
* When true, redirects are not evaluated for the route matching; the result will be either a composition or not found.
|
|
10420
10145
|
* Note: this is always true when state=63 (internal RSC editor state) to allow contextual editing of compositions
|
|
10421
10146
|
* that have redirects configured on their paths.
|
|
10422
10147
|
*/
|
|
10423
|
-
ignoreRedirects?: components$
|
|
10148
|
+
ignoreRedirects?: components$b["parameters"]["ignoreRedirects"];
|
|
10424
10149
|
};
|
|
10425
10150
|
header?: never;
|
|
10426
10151
|
path?: never;
|
|
@@ -10434,14 +10159,14 @@ interface paths$a {
|
|
|
10434
10159
|
[name: string]: unknown;
|
|
10435
10160
|
};
|
|
10436
10161
|
content: {
|
|
10437
|
-
"application/json": components$
|
|
10162
|
+
"application/json": components$b["schemas"]["RouteResponse"];
|
|
10438
10163
|
};
|
|
10439
10164
|
};
|
|
10440
|
-
400: components$
|
|
10441
|
-
401: components$
|
|
10442
|
-
403: components$
|
|
10443
|
-
429: components$
|
|
10444
|
-
500: components$
|
|
10165
|
+
400: components$b["responses"]["BadRequestError"];
|
|
10166
|
+
401: components$b["responses"]["UnauthorizedError"];
|
|
10167
|
+
403: components$b["responses"]["ForbiddenError"];
|
|
10168
|
+
429: components$b["responses"]["RateLimitError"];
|
|
10169
|
+
500: components$b["responses"]["InternalServerError"];
|
|
10445
10170
|
};
|
|
10446
10171
|
};
|
|
10447
10172
|
put?: never;
|
|
@@ -10471,7 +10196,7 @@ interface paths$a {
|
|
|
10471
10196
|
trace?: never;
|
|
10472
10197
|
};
|
|
10473
10198
|
}
|
|
10474
|
-
interface components$
|
|
10199
|
+
interface components$b {
|
|
10475
10200
|
schemas: {
|
|
10476
10201
|
RouteDynamicInputs: {
|
|
10477
10202
|
[key: string]: string;
|
|
@@ -10520,10 +10245,10 @@ interface components$a {
|
|
|
10520
10245
|
RouteResponseRedirect: {
|
|
10521
10246
|
/** The route that was matched in the redirects */
|
|
10522
10247
|
matchedRoute: string;
|
|
10523
|
-
dynamicInputs?: components$
|
|
10248
|
+
dynamicInputs?: components$b["schemas"]["RouteDynamicInputs"];
|
|
10524
10249
|
/** @enum {string} */
|
|
10525
10250
|
type: "redirect";
|
|
10526
|
-
redirect: components$
|
|
10251
|
+
redirect: components$b["schemas"]["Redirect"];
|
|
10527
10252
|
};
|
|
10528
10253
|
/** Defines a connection to a dynamic token on a data resource */
|
|
10529
10254
|
DataElementConnectionDefinition: {
|
|
@@ -10589,11 +10314,11 @@ interface components$a {
|
|
|
10589
10314
|
|
|
10590
10315
|
*/
|
|
10591
10316
|
op?: "&" | "|";
|
|
10592
|
-
clauses: (components$
|
|
10317
|
+
clauses: (components$b["schemas"]["VisibilityCriteria"] | components$b["schemas"]["VisibilityCriteriaGroup"])[];
|
|
10593
10318
|
};
|
|
10594
10319
|
/** Defines a conditional value for a component parameter */
|
|
10595
10320
|
ComponentParameterConditionalValue: {
|
|
10596
|
-
when: components$
|
|
10321
|
+
when: components$b["schemas"]["VisibilityCriteriaGroup"];
|
|
10597
10322
|
/**
|
|
10598
10323
|
* The value of the parameter. Any JSON-serializable value is acceptable.
|
|
10599
10324
|
* A value of `null` will cause the parameter value to be removed, if it matches.
|
|
@@ -10615,7 +10340,7 @@ interface components$a {
|
|
|
10615
10340
|
*
|
|
10616
10341
|
* When no locale is passed to a non-route API, conditions are not processed and all conditions are returned.
|
|
10617
10342
|
*/
|
|
10618
|
-
ComponentParameterConditions: components$
|
|
10343
|
+
ComponentParameterConditions: components$b["schemas"]["ComponentParameterConditionalValue"][];
|
|
10619
10344
|
/** Defines an editable parameter on a component */
|
|
10620
10345
|
ComponentParameter: {
|
|
10621
10346
|
/** The value of the parameter. Any JSON-serializable value is acceptable */
|
|
@@ -10623,7 +10348,7 @@ interface components$a {
|
|
|
10623
10348
|
/** The type of the parameter. Determines how it is displayed when editing and tells the consumer how to process it */
|
|
10624
10349
|
type: string;
|
|
10625
10350
|
/** @deprecated */
|
|
10626
|
-
connectedData?: components$
|
|
10351
|
+
connectedData?: components$b["schemas"]["DataElementConnectionDefinition"];
|
|
10627
10352
|
/**
|
|
10628
10353
|
* Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
|
|
10629
10354
|
* Note that locales must be registered on the entry/composition `_locales` before being used
|
|
@@ -10631,10 +10356,10 @@ interface components$a {
|
|
|
10631
10356
|
locales?: {
|
|
10632
10357
|
[key: string]: unknown;
|
|
10633
10358
|
};
|
|
10634
|
-
conditions?: components$
|
|
10359
|
+
conditions?: components$b["schemas"]["ComponentParameterConditions"];
|
|
10635
10360
|
/** Locale-specific conditional values for this parameter. Keys are locale codes, and values are the `conditions` for that locale. */
|
|
10636
10361
|
localesConditions?: {
|
|
10637
|
-
[key: string]: components$
|
|
10362
|
+
[key: string]: components$b["schemas"]["ComponentParameterConditions"];
|
|
10638
10363
|
};
|
|
10639
10364
|
};
|
|
10640
10365
|
ProjectMapNodeAllowedQueryString: {
|
|
@@ -10669,7 +10394,7 @@ interface components$a {
|
|
|
10669
10394
|
/** While performing a search if a node is a hit, this property will return true. If it's supporting structure, like a parent of a search hit, it will return false */
|
|
10670
10395
|
isSearchHit?: boolean;
|
|
10671
10396
|
/** Query strings that are allowed to be passed to the node */
|
|
10672
|
-
queryStrings?: components$
|
|
10397
|
+
queryStrings?: components$b["schemas"]["ProjectMapNodeAllowedQueryString"][];
|
|
10673
10398
|
/**
|
|
10674
10399
|
* For dynamic nodes, this is the preview value for the dynamic value.
|
|
10675
10400
|
* The preview value is used when editing a connected composition, and is the default
|
|
@@ -10694,7 +10419,7 @@ interface components$a {
|
|
|
10694
10419
|
* Unique identifier for the project map that this node belongs to
|
|
10695
10420
|
*/
|
|
10696
10421
|
projectMapId: string;
|
|
10697
|
-
data?: components$
|
|
10422
|
+
data?: components$b["schemas"]["ProjectMapNodeData"];
|
|
10698
10423
|
/**
|
|
10699
10424
|
* Locale-specific paths of the project map node.
|
|
10700
10425
|
* Keys are locale codes
|
|
@@ -10714,13 +10439,13 @@ interface components$a {
|
|
|
10714
10439
|
type: string;
|
|
10715
10440
|
/** Component parameter values for the component instance */
|
|
10716
10441
|
parameters?: {
|
|
10717
|
-
[key: string]: components$
|
|
10442
|
+
[key: string]: components$b["schemas"]["ComponentParameter"];
|
|
10718
10443
|
};
|
|
10719
10444
|
/** Public ID of alternate visual appearance for this component, if any selected */
|
|
10720
10445
|
variant?: string;
|
|
10721
10446
|
/** Slots containing any child components */
|
|
10722
10447
|
slots?: {
|
|
10723
|
-
[key: string]: components$
|
|
10448
|
+
[key: string]: components$b["schemas"]["ComponentInstance"][];
|
|
10724
10449
|
};
|
|
10725
10450
|
/**
|
|
10726
10451
|
* Unique identifier of the component within the composition.
|
|
@@ -10731,20 +10456,20 @@ interface components$a {
|
|
|
10731
10456
|
_id?: string;
|
|
10732
10457
|
/** Indicates this component instance should be sourced from a pattern library pattern */
|
|
10733
10458
|
_pattern?: string;
|
|
10734
|
-
_dataResources?: components$
|
|
10459
|
+
_dataResources?: components$b["schemas"]["DataResourceDefinitions"];
|
|
10735
10460
|
/**
|
|
10736
10461
|
* Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
|
10737
10462
|
* Means nothing for PUTs; it will be ignored
|
|
10738
10463
|
*/
|
|
10739
10464
|
_patternDataResources?: {
|
|
10740
|
-
[key: string]: components$
|
|
10465
|
+
[key: string]: components$b["schemas"]["DataResourceDefinition"];
|
|
10741
10466
|
};
|
|
10742
10467
|
/**
|
|
10743
10468
|
* Query-string opt-ins coming from a pattern resolved for this component.
|
|
10744
10469
|
* Means nothing for PUTs; it will be ignored
|
|
10745
10470
|
*/
|
|
10746
10471
|
_patternOptedInQueryStrings?: string[];
|
|
10747
|
-
_patternError?: components$
|
|
10472
|
+
_patternError?: components$b["schemas"]["PatternError"];
|
|
10748
10473
|
/**
|
|
10749
10474
|
* Defines patch overrides to component IDs that live in the composition.
|
|
10750
10475
|
* This can be used to override parameters that are defined on patterns,
|
|
@@ -10758,14 +10483,14 @@ interface components$a {
|
|
|
10758
10483
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
10759
10484
|
*/
|
|
10760
10485
|
_overrides?: {
|
|
10761
|
-
[key: string]: components$
|
|
10486
|
+
[key: string]: components$b["schemas"]["ComponentOverride"];
|
|
10762
10487
|
};
|
|
10763
10488
|
/**
|
|
10764
10489
|
* Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
|
|
10765
10490
|
* Means nothing for PUTs; it will be ignored
|
|
10766
10491
|
*/
|
|
10767
10492
|
_patternOverrides?: {
|
|
10768
|
-
[key: string]: components$
|
|
10493
|
+
[key: string]: components$b["schemas"]["ComponentOverride"];
|
|
10769
10494
|
};
|
|
10770
10495
|
/**
|
|
10771
10496
|
* When used on a pattern, defines how the pattern's parameters may be overridden
|
|
@@ -10774,7 +10499,7 @@ interface components$a {
|
|
|
10774
10499
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
10775
10500
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
10776
10501
|
*/
|
|
10777
|
-
_overridability?: components$
|
|
10502
|
+
_overridability?: components$b["schemas"]["ComponentOverridability"];
|
|
10778
10503
|
/** Array of locales that have data defined. Only set for pattern references or composition defaults */
|
|
10779
10504
|
_locales?: string[];
|
|
10780
10505
|
};
|
|
@@ -10799,14 +10524,14 @@ interface components$a {
|
|
|
10799
10524
|
* If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
|
|
10800
10525
|
*/
|
|
10801
10526
|
optionalPatternParameter?: boolean;
|
|
10802
|
-
variables?: components$
|
|
10527
|
+
variables?: components$b["schemas"]["DataResourceVariables"];
|
|
10803
10528
|
};
|
|
10804
10529
|
/**
|
|
10805
10530
|
* Data definitions attached to this component. The property name is the key of the data in the data document.
|
|
10806
10531
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key)
|
|
10807
10532
|
*/
|
|
10808
10533
|
DataResourceDefinitions: {
|
|
10809
|
-
[key: string]: components$
|
|
10534
|
+
[key: string]: components$b["schemas"]["DataResourceDefinition"];
|
|
10810
10535
|
};
|
|
10811
10536
|
/**
|
|
10812
10537
|
* Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
|
@@ -10824,10 +10549,10 @@ interface components$a {
|
|
|
10824
10549
|
*/
|
|
10825
10550
|
ComponentOverride: {
|
|
10826
10551
|
parameters?: {
|
|
10827
|
-
[key: string]: components$
|
|
10552
|
+
[key: string]: components$b["schemas"]["ComponentParameter"];
|
|
10828
10553
|
};
|
|
10829
10554
|
slots?: {
|
|
10830
|
-
[key: string]: components$
|
|
10555
|
+
[key: string]: components$b["schemas"]["ComponentInstance"][];
|
|
10831
10556
|
};
|
|
10832
10557
|
variant?: string;
|
|
10833
10558
|
/**
|
|
@@ -10836,7 +10561,7 @@ interface components$a {
|
|
|
10836
10561
|
* Overrides defined here replace values in either _dataResources or _patternDataResources on the target component.
|
|
10837
10562
|
*/
|
|
10838
10563
|
dataResources?: {
|
|
10839
|
-
[key: string]: components$
|
|
10564
|
+
[key: string]: components$b["schemas"]["DataResourceDefinition"];
|
|
10840
10565
|
};
|
|
10841
10566
|
};
|
|
10842
10567
|
/**
|
|
@@ -10857,7 +10582,7 @@ interface components$a {
|
|
|
10857
10582
|
ComponentOverridability: {
|
|
10858
10583
|
/** Defines component parameter value overrides. Keys are the parameter public ID */
|
|
10859
10584
|
parameters?: {
|
|
10860
|
-
[key: string]: components$
|
|
10585
|
+
[key: string]: components$b["schemas"]["OverrideOptions"];
|
|
10861
10586
|
};
|
|
10862
10587
|
/** Allows overriding a display variant is allowed if it is defined on the component the pattern is derived from. Default = false */
|
|
10863
10588
|
variants?: boolean;
|
|
@@ -10874,15 +10599,15 @@ interface components$a {
|
|
|
10874
10599
|
type: string;
|
|
10875
10600
|
/** Component parameter values for the component instance */
|
|
10876
10601
|
parameters?: {
|
|
10877
|
-
[key: string]: components$
|
|
10602
|
+
[key: string]: components$b["schemas"]["ComponentParameter"];
|
|
10878
10603
|
};
|
|
10879
10604
|
/** Public ID of alternate visual appearance for this component, if any selected */
|
|
10880
10605
|
variant?: string;
|
|
10881
10606
|
/** Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated */
|
|
10882
|
-
projectMapNodes?: components$
|
|
10607
|
+
projectMapNodes?: components$b["schemas"]["CompositionProjectMapNodeInfo"][];
|
|
10883
10608
|
/** Slots containing any child components */
|
|
10884
10609
|
slots?: {
|
|
10885
|
-
[key: string]: components$
|
|
10610
|
+
[key: string]: components$b["schemas"]["ComponentInstance"][];
|
|
10886
10611
|
};
|
|
10887
10612
|
/** The ID of the composition */
|
|
10888
10613
|
_id: string;
|
|
@@ -10905,15 +10630,15 @@ interface components$a {
|
|
|
10905
10630
|
* Means nothing for PUTs; it will be ignored
|
|
10906
10631
|
*/
|
|
10907
10632
|
_patternDataResources?: {
|
|
10908
|
-
[key: string]: components$
|
|
10633
|
+
[key: string]: components$b["schemas"]["DataResourceDefinition"];
|
|
10909
10634
|
};
|
|
10910
10635
|
/**
|
|
10911
10636
|
* Query-string opt-ins coming from a pattern resolved for this component.
|
|
10912
10637
|
* Means nothing for PUTs; it will be ignored
|
|
10913
10638
|
*/
|
|
10914
10639
|
_patternOptedInQueryStrings?: string[];
|
|
10915
|
-
_dataResources?: components$
|
|
10916
|
-
_patternError?: components$
|
|
10640
|
+
_dataResources?: components$b["schemas"]["DataResourceDefinitions"];
|
|
10641
|
+
_patternError?: components$b["schemas"]["PatternError"];
|
|
10917
10642
|
/**
|
|
10918
10643
|
* Defines patch overrides to component IDs that live in the composition.
|
|
10919
10644
|
* This can be used to override parameters that are defined on patterns,
|
|
@@ -10927,14 +10652,14 @@ interface components$a {
|
|
|
10927
10652
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
10928
10653
|
*/
|
|
10929
10654
|
_overrides?: {
|
|
10930
|
-
[key: string]: components$
|
|
10655
|
+
[key: string]: components$b["schemas"]["ComponentOverride"];
|
|
10931
10656
|
};
|
|
10932
10657
|
/**
|
|
10933
10658
|
* Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
|
|
10934
10659
|
* Means nothing for PUTs; it will be ignored
|
|
10935
10660
|
*/
|
|
10936
10661
|
_patternOverrides?: {
|
|
10937
|
-
[key: string]: components$
|
|
10662
|
+
[key: string]: components$b["schemas"]["ComponentOverride"];
|
|
10938
10663
|
};
|
|
10939
10664
|
/**
|
|
10940
10665
|
* When used on a pattern, defines how the pattern's parameters may be overridden
|
|
@@ -10943,7 +10668,7 @@ interface components$a {
|
|
|
10943
10668
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
10944
10669
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
10945
10670
|
*/
|
|
10946
|
-
_overridability?: components$
|
|
10671
|
+
_overridability?: components$b["schemas"]["ComponentOverridability"];
|
|
10947
10672
|
/** Array of locales which have data defined on the composition. If empty, the current default locale implicitly has data */
|
|
10948
10673
|
_locales?: string[];
|
|
10949
10674
|
/**
|
|
@@ -10982,7 +10707,7 @@ interface components$a {
|
|
|
10982
10707
|
* NOTE: Users without membership in any role listed here will be unable to execute the transition unless they are team admins
|
|
10983
10708
|
*/
|
|
10984
10709
|
permissions: {
|
|
10985
|
-
[key: string]: components$
|
|
10710
|
+
[key: string]: components$b["schemas"]["WorkflowStageTransitionPermission"];
|
|
10986
10711
|
};
|
|
10987
10712
|
};
|
|
10988
10713
|
/** Definition of a stage in a workflow */
|
|
@@ -10996,7 +10721,7 @@ interface components$a {
|
|
|
10996
10721
|
* listed here, the stage is read-only and publishing is disabled
|
|
10997
10722
|
*/
|
|
10998
10723
|
permissions: {
|
|
10999
|
-
[key: string]: components$
|
|
10724
|
+
[key: string]: components$b["schemas"]["WorkflowStagePermission"];
|
|
11000
10725
|
};
|
|
11001
10726
|
/**
|
|
11002
10727
|
* When true, transitioning into this stage from a different stage will automatically publish the entity.
|
|
@@ -11016,7 +10741,7 @@ interface components$a {
|
|
|
11016
10741
|
* Every stage must define at least one transition, to avoid creating a workflow that
|
|
11017
10742
|
* has a stage that can never be escaped
|
|
11018
10743
|
*/
|
|
11019
|
-
transitions: components$
|
|
10744
|
+
transitions: components$b["schemas"]["WorkflowStageTransition"][];
|
|
11020
10745
|
/**
|
|
11021
10746
|
* Icon name for the stage (e.g. 'chevron-double-right-o')
|
|
11022
10747
|
* @defaultValue chevron-double-right-o
|
|
@@ -11041,7 +10766,7 @@ interface components$a {
|
|
|
11041
10766
|
initialStage: string;
|
|
11042
10767
|
/** All stages of the workflow */
|
|
11043
10768
|
stages: {
|
|
11044
|
-
[key: string]: components$
|
|
10769
|
+
[key: string]: components$b["schemas"]["WorkflowStage"];
|
|
11045
10770
|
};
|
|
11046
10771
|
/** Last modified ISO date string for this definition (ignored for writes) */
|
|
11047
10772
|
modified?: string;
|
|
@@ -11089,6 +10814,8 @@ interface components$a {
|
|
|
11089
10814
|
* Timestamp when the item was moved to trash. Omitted if not in trash.
|
|
11090
10815
|
*/
|
|
11091
10816
|
deletedAt?: string;
|
|
10817
|
+
/** Present when the item is in trash, omitted otherwise. True when the item was published with no unpublished changes at the moment it was trashed. False otherwise, including items trashed before this field existed. */
|
|
10818
|
+
publishedWhenTrashed?: boolean;
|
|
11092
10819
|
/** User name of the creator of this composition */
|
|
11093
10820
|
creator?: string;
|
|
11094
10821
|
/** User name of the last editor of this composition */
|
|
@@ -11114,7 +10841,7 @@ interface components$a {
|
|
|
11114
10841
|
* The release this composition belongs to. If not set, it belongs to the base
|
|
11115
10842
|
*/
|
|
11116
10843
|
releaseId?: string;
|
|
11117
|
-
composition: components$
|
|
10844
|
+
composition: components$b["schemas"]["RootComponentInstance"];
|
|
11118
10845
|
/**
|
|
11119
10846
|
* Format: uuid
|
|
11120
10847
|
* The workflow ID assigned to this composition, if any. Normally comes from the component definition
|
|
@@ -11132,7 +10859,7 @@ interface components$a {
|
|
|
11132
10859
|
*/
|
|
11133
10860
|
instanceWorkflowId?: string;
|
|
11134
10861
|
/** The full definition of the assigned workflow, if any, including stages, permissions, etc. Returned only when `withWorkflowDefinition` is true */
|
|
11135
|
-
workflowDefinition?: components$
|
|
10862
|
+
workflowDefinition?: components$b["schemas"]["WorkflowDefinition"];
|
|
11136
10863
|
/**
|
|
11137
10864
|
* Format: uuid
|
|
11138
10865
|
* The edition ID. When set, this is a child edition of the composition in _id.
|
|
@@ -11149,35 +10876,421 @@ interface components$a {
|
|
|
11149
10876
|
*/
|
|
11150
10877
|
editionPriority?: number;
|
|
11151
10878
|
};
|
|
11152
|
-
/**
|
|
11153
|
-
* The route matches a composition.
|
|
11154
|
-
* If any dynamic segments or query parameters are present in the route, they will be returned as dynamic inputs in the response
|
|
11155
|
-
*/
|
|
11156
|
-
RouteResponseComposition: {
|
|
11157
|
-
/** The route that was matched in the project map */
|
|
11158
|
-
matchedRoute: string;
|
|
11159
|
-
dynamicInputs?: components$
|
|
11160
|
-
/**
|
|
11161
|
-
* Indicates the data variant that was fetched for data resources.
|
|
11162
|
-
* undefined: Data resources were resolved using published data from their data source
|
|
11163
|
-
* unpublished: Data resources which support unpublished data retrieved unpublished data from their data source. Data resources that did not support unpublished data retrieved published data instead.
|
|
11164
|
-
|
|
11165
|
-
*/
|
|
11166
|
-
dataResourcesVariant?: "unpublished";
|
|
11167
|
-
/** @enum {string} */
|
|
11168
|
-
type: "composition";
|
|
11169
|
-
compositionApiResponse: components$
|
|
10879
|
+
/**
|
|
10880
|
+
* The route matches a composition.
|
|
10881
|
+
* If any dynamic segments or query parameters are present in the route, they will be returned as dynamic inputs in the response
|
|
10882
|
+
*/
|
|
10883
|
+
RouteResponseComposition: {
|
|
10884
|
+
/** The route that was matched in the project map */
|
|
10885
|
+
matchedRoute: string;
|
|
10886
|
+
dynamicInputs?: components$b["schemas"]["RouteDynamicInputs"];
|
|
10887
|
+
/**
|
|
10888
|
+
* Indicates the data variant that was fetched for data resources.
|
|
10889
|
+
* undefined: Data resources were resolved using published data from their data source
|
|
10890
|
+
* unpublished: Data resources which support unpublished data retrieved unpublished data from their data source. Data resources that did not support unpublished data retrieved published data instead.
|
|
10891
|
+
|
|
10892
|
+
*/
|
|
10893
|
+
dataResourcesVariant?: "unpublished";
|
|
10894
|
+
/** @enum {string} */
|
|
10895
|
+
type: "composition";
|
|
10896
|
+
compositionApiResponse: components$b["schemas"]["CompositionApiResponse"];
|
|
10897
|
+
};
|
|
10898
|
+
/**
|
|
10899
|
+
* The route does not match any configured redirections or compositions.
|
|
10900
|
+
* NOTE: This response differs from a HTTP 404, which indicates that the project map or project ID was not found.
|
|
10901
|
+
* Receiving this response with HTTP 200 means that the project was found, but the route did not match anything
|
|
10902
|
+
*/
|
|
10903
|
+
RouteResponseNotFound: {
|
|
10904
|
+
/** @enum {string} */
|
|
10905
|
+
type: "notFound";
|
|
10906
|
+
};
|
|
10907
|
+
RouteResponse: components$b["schemas"]["RouteResponseRedirect"] | components$b["schemas"]["RouteResponseComposition"] | components$b["schemas"]["RouteResponseNotFound"];
|
|
10908
|
+
Error: {
|
|
10909
|
+
/** Error message(s) that occurred while processing the request */
|
|
10910
|
+
errorMessage?: string[] | string;
|
|
10911
|
+
};
|
|
10912
|
+
};
|
|
10913
|
+
responses: {
|
|
10914
|
+
/** Request input validation failed */
|
|
10915
|
+
BadRequestError: {
|
|
10916
|
+
headers: {
|
|
10917
|
+
[name: string]: unknown;
|
|
10918
|
+
};
|
|
10919
|
+
content: {
|
|
10920
|
+
"application/json": components$b["schemas"]["Error"];
|
|
10921
|
+
};
|
|
10922
|
+
};
|
|
10923
|
+
/** API key or token was not valid */
|
|
10924
|
+
UnauthorizedError: {
|
|
10925
|
+
headers: {
|
|
10926
|
+
[name: string]: unknown;
|
|
10927
|
+
};
|
|
10928
|
+
content: {
|
|
10929
|
+
"application/json": components$b["schemas"]["Error"];
|
|
10930
|
+
};
|
|
10931
|
+
};
|
|
10932
|
+
/** Permission was denied */
|
|
10933
|
+
ForbiddenError: {
|
|
10934
|
+
headers: {
|
|
10935
|
+
[name: string]: unknown;
|
|
10936
|
+
};
|
|
10937
|
+
content: {
|
|
10938
|
+
"application/json": components$b["schemas"]["Error"];
|
|
10939
|
+
};
|
|
10940
|
+
};
|
|
10941
|
+
/** Too many requests in allowed time period */
|
|
10942
|
+
RateLimitError: {
|
|
10943
|
+
headers: {
|
|
10944
|
+
[name: string]: unknown;
|
|
10945
|
+
};
|
|
10946
|
+
content?: never;
|
|
10947
|
+
};
|
|
10948
|
+
/** Execution error occurred */
|
|
10949
|
+
InternalServerError: {
|
|
10950
|
+
headers: {
|
|
10951
|
+
[name: string]: unknown;
|
|
10952
|
+
};
|
|
10953
|
+
content?: never;
|
|
10954
|
+
};
|
|
10955
|
+
};
|
|
10956
|
+
parameters: {
|
|
10957
|
+
/** The project to fetch a route from */
|
|
10958
|
+
projectId: string;
|
|
10959
|
+
/**
|
|
10960
|
+
* The path to resolve. Dynamic project map nodes and redirects can be resolved when a matching path is passed.
|
|
10961
|
+
* Query string parameters may be passed with the path. They are ignored for route matching.
|
|
10962
|
+
* If the route matches a composition and the project map node allows passed query string parameters, query parameters will
|
|
10963
|
+
* be returned as as dynamic inputs to the composition.
|
|
10964
|
+
*
|
|
10965
|
+
* Examples:
|
|
10966
|
+
* * route "/company/about-us" would match "/company/about-us" in project map or redirects
|
|
10967
|
+
* * route "/products/123" would match "/products/:productId" in project map or "/products/*" in redirects
|
|
10968
|
+
* * route "/products/123?color=red" would match "/products/:productId" in project map, and provde productId=123 and color=red as dynamic inputs to the composition
|
|
10969
|
+
*
|
|
10970
|
+
* Conflict resolution:
|
|
10971
|
+
* If a route matches multiple possible project map or redirect nodes, the resulting action will use the following logic:
|
|
10972
|
+
* * If a redirect matches, it wins over project map nodes in all cases
|
|
10973
|
+
* * If multiple redirects or project map nodes match the route, the one with the most specific path wins:
|
|
10974
|
+
* * The route with the most path segments wins
|
|
10975
|
+
* * If several matches have the same number of segments, the one with the fewest dynamic segments wins
|
|
10976
|
+
* * If still ambiguous, the first matching route arbitrarily wins
|
|
10977
|
+
*
|
|
10978
|
+
* Invalid paths:
|
|
10979
|
+
* The request fails with HTTP 400 when the path, ignoring its query string and trailing slashes,
|
|
10980
|
+
* contains consecutive slashes (for example "/en//about" or "//en/about").
|
|
10981
|
+
*
|
|
10982
|
+
* Probe paths:
|
|
10983
|
+
* On uniform.global, paths ending in an archive, backup or database file extension (for example "/site.zip",
|
|
10984
|
+
* "/config.php.bak" or "/db.sql") return `{ "type": "notFound" }` without being matched, even where a dynamic
|
|
10985
|
+
* project map node or redirect would match them.
|
|
10986
|
+
*/
|
|
10987
|
+
path: string;
|
|
10988
|
+
/** Specify a project map ID to fetch route from. If not specified, the default project map for the projectId is used */
|
|
10989
|
+
projectMapId: string;
|
|
10990
|
+
/** Publishing state to fetch. 0 = draft, 64 = published */
|
|
10991
|
+
state: number;
|
|
10992
|
+
/**
|
|
10993
|
+
* If true the `_id` unique identifier of each non-root component will be part of the response data.
|
|
10994
|
+
* If false, the `_id` will not be present in the API response
|
|
10995
|
+
*/
|
|
10996
|
+
withComponentIDs: boolean;
|
|
10997
|
+
/**
|
|
10998
|
+
* @deprecated
|
|
10999
|
+
* Has no effect.
|
|
11000
|
+
*/
|
|
11001
|
+
withContentSourceMap: boolean;
|
|
11002
|
+
/**
|
|
11003
|
+
* One or more locales to localize the response to.
|
|
11004
|
+
* When the result is a composition, it includes only the first matching locale's data.
|
|
11005
|
+
* If no matching locale is found, the response will be a not-found result.
|
|
11006
|
+
*
|
|
11007
|
+
* This parameter accepts a single value, a comma-delimited list of values, or the Accept-Language header syntax. Examples:
|
|
11008
|
+
* en-US
|
|
11009
|
+
* fr-CA,fr
|
|
11010
|
+
* de-AT;q=0.9,de-DE;q=0.8,en;q=0.7
|
|
11011
|
+
*
|
|
11012
|
+
* When this parameter is not passed:
|
|
11013
|
+
* - If a dynamic :locale path segment is defined on a project map ancestor node, then it will be used as the locale. If the path segment and this parameter are provided, the parameter takes precedence.
|
|
11014
|
+
* - Otherwise, all locales' data is returned.
|
|
11015
|
+
*
|
|
11016
|
+
* When the result is a redirect, this parameter has no effect
|
|
11017
|
+
*/
|
|
11018
|
+
locale: string;
|
|
11019
|
+
/**
|
|
11020
|
+
* The ID of a release to fetch the content for.
|
|
11021
|
+
*
|
|
11022
|
+
* - When unspecified, all release content is excluded from the result(s).
|
|
11023
|
+
* - When specified, all content is returned as it would appear in the release if it was released now. This includes both content copied to the release and changed, as well as content that is not part of the release.
|
|
11024
|
+
*
|
|
11025
|
+
* Content copied to a release can be differentiated from base content by the `releaseId` property on the content. If the content is not copied to the release, this property will be null
|
|
11026
|
+
*/
|
|
11027
|
+
releaseId: string;
|
|
11028
|
+
/**
|
|
11029
|
+
* Indicates the data variant that was fetched for data resources.
|
|
11030
|
+
* undefined: Data resources were resolved using published data from their data source
|
|
11031
|
+
* unpublished: Data resources which support unpublished data retrieved unpublished data from their data source. Data resources that did not support unpublished data retrieved published data instead.
|
|
11032
|
+
*/
|
|
11033
|
+
dataSourceVariant: "unpublished";
|
|
11034
|
+
/**
|
|
11035
|
+
* When true, redirects are not evaluated for the route matching; the result will be either a composition or not found.
|
|
11036
|
+
* Note: this is always true when state=63 (internal RSC editor state) to allow contextual editing of compositions
|
|
11037
|
+
* that have redirects configured on their paths.
|
|
11038
|
+
*/
|
|
11039
|
+
ignoreRedirects: boolean;
|
|
11040
|
+
};
|
|
11041
|
+
requestBodies: never;
|
|
11042
|
+
headers: never;
|
|
11043
|
+
pathItems: never;
|
|
11044
|
+
}
|
|
11045
|
+
|
|
11046
|
+
interface paths$a {
|
|
11047
|
+
"/api/v1/views": {
|
|
11048
|
+
parameters: {
|
|
11049
|
+
query?: never;
|
|
11050
|
+
header?: never;
|
|
11051
|
+
path?: never;
|
|
11052
|
+
cookie?: never;
|
|
11053
|
+
};
|
|
11054
|
+
/** Lists saved views for a project + resource type. */
|
|
11055
|
+
get: {
|
|
11056
|
+
parameters: {
|
|
11057
|
+
query: {
|
|
11058
|
+
/** Project the views belong to. */
|
|
11059
|
+
projectId: string;
|
|
11060
|
+
/** Resource type these views apply to (e.g. "entry"). */
|
|
11061
|
+
resourceType: "composition" | "compositionPattern" | "component" | "componentPattern" | "entry" | "entryPattern" | "contentType" | "blockType" | "release" | "signal" | "intent" | "audience" | "asset";
|
|
11062
|
+
/** Number of records to skip. */
|
|
11063
|
+
offset?: number | null;
|
|
11064
|
+
/** Maximum number of records to return. */
|
|
11065
|
+
limit?: number;
|
|
11066
|
+
};
|
|
11067
|
+
header?: never;
|
|
11068
|
+
path?: never;
|
|
11069
|
+
cookie?: never;
|
|
11070
|
+
};
|
|
11071
|
+
requestBody?: never;
|
|
11072
|
+
responses: {
|
|
11073
|
+
/** OK */
|
|
11074
|
+
200: {
|
|
11075
|
+
headers: {
|
|
11076
|
+
[name: string]: unknown;
|
|
11077
|
+
};
|
|
11078
|
+
content: {
|
|
11079
|
+
"application/json": {
|
|
11080
|
+
views: {
|
|
11081
|
+
name: string;
|
|
11082
|
+
description?: string;
|
|
11083
|
+
searchTerm?: string;
|
|
11084
|
+
filters: {
|
|
11085
|
+
field: string;
|
|
11086
|
+
dynamicField?: string;
|
|
11087
|
+
operator: string;
|
|
11088
|
+
value: string | string[];
|
|
11089
|
+
}[];
|
|
11090
|
+
sort?: string[];
|
|
11091
|
+
shared: boolean;
|
|
11092
|
+
icon?: string;
|
|
11093
|
+
display?: {
|
|
11094
|
+
/** @enum {string} */
|
|
11095
|
+
layout?: "grid" | "list";
|
|
11096
|
+
list?: {
|
|
11097
|
+
visibility: {
|
|
11098
|
+
[key: string]: boolean;
|
|
11099
|
+
};
|
|
11100
|
+
order: string[];
|
|
11101
|
+
};
|
|
11102
|
+
};
|
|
11103
|
+
id: string;
|
|
11104
|
+
projectId: string;
|
|
11105
|
+
/** @enum {string} */
|
|
11106
|
+
resourceType: "composition" | "compositionPattern" | "component" | "componentPattern" | "entry" | "entryPattern" | "contentType" | "blockType" | "release" | "signal" | "intent" | "audience" | "asset";
|
|
11107
|
+
createdBy: string | null;
|
|
11108
|
+
/** Format: date-time */
|
|
11109
|
+
created: string;
|
|
11110
|
+
/** Format: date-time */
|
|
11111
|
+
modified: string;
|
|
11112
|
+
}[];
|
|
11113
|
+
totalCount: number;
|
|
11114
|
+
};
|
|
11115
|
+
};
|
|
11116
|
+
};
|
|
11117
|
+
400: components$a["responses"]["BadRequestError"];
|
|
11118
|
+
401: components$a["responses"]["UnauthorizedError"];
|
|
11119
|
+
403: components$a["responses"]["ForbiddenError"];
|
|
11120
|
+
429: components$a["responses"]["RateLimitError"];
|
|
11121
|
+
500: components$a["responses"]["InternalServerError"];
|
|
11122
|
+
};
|
|
11123
|
+
};
|
|
11124
|
+
/** Create-or-replace a saved view by id. The caller mints the UUID. Omitted optional fields are cleared. `shared` may only be promoted (personal → shared); demotion returns 400. `resourceType` is immutable after create. */
|
|
11125
|
+
put: {
|
|
11126
|
+
parameters: {
|
|
11127
|
+
query?: never;
|
|
11128
|
+
header?: never;
|
|
11129
|
+
path?: never;
|
|
11130
|
+
cookie?: never;
|
|
11131
|
+
};
|
|
11132
|
+
requestBody: {
|
|
11133
|
+
content: {
|
|
11134
|
+
"application/json": {
|
|
11135
|
+
name: string;
|
|
11136
|
+
description?: string;
|
|
11137
|
+
searchTerm?: string;
|
|
11138
|
+
filters: {
|
|
11139
|
+
field: string;
|
|
11140
|
+
dynamicField?: string;
|
|
11141
|
+
operator: string;
|
|
11142
|
+
value: string | string[];
|
|
11143
|
+
}[];
|
|
11144
|
+
sort?: string[];
|
|
11145
|
+
shared: boolean;
|
|
11146
|
+
icon?: string;
|
|
11147
|
+
display?: {
|
|
11148
|
+
/** @enum {string} */
|
|
11149
|
+
layout?: "grid" | "list";
|
|
11150
|
+
list?: {
|
|
11151
|
+
visibility: {
|
|
11152
|
+
[key: string]: boolean;
|
|
11153
|
+
};
|
|
11154
|
+
order: string[];
|
|
11155
|
+
};
|
|
11156
|
+
};
|
|
11157
|
+
id: string;
|
|
11158
|
+
projectId: string;
|
|
11159
|
+
/** @enum {string} */
|
|
11160
|
+
resourceType: "composition" | "compositionPattern" | "component" | "componentPattern" | "entry" | "entryPattern" | "contentType" | "blockType" | "release" | "signal" | "intent" | "audience" | "asset";
|
|
11161
|
+
};
|
|
11162
|
+
};
|
|
11163
|
+
};
|
|
11164
|
+
responses: {
|
|
11165
|
+
/** OK */
|
|
11166
|
+
200: {
|
|
11167
|
+
headers: {
|
|
11168
|
+
[name: string]: unknown;
|
|
11169
|
+
};
|
|
11170
|
+
content: {
|
|
11171
|
+
"application/json": {
|
|
11172
|
+
name: string;
|
|
11173
|
+
description?: string;
|
|
11174
|
+
searchTerm?: string;
|
|
11175
|
+
filters: {
|
|
11176
|
+
field: string;
|
|
11177
|
+
dynamicField?: string;
|
|
11178
|
+
operator: string;
|
|
11179
|
+
value: string | string[];
|
|
11180
|
+
}[];
|
|
11181
|
+
sort?: string[];
|
|
11182
|
+
shared: boolean;
|
|
11183
|
+
icon?: string;
|
|
11184
|
+
display?: {
|
|
11185
|
+
/** @enum {string} */
|
|
11186
|
+
layout?: "grid" | "list";
|
|
11187
|
+
list?: {
|
|
11188
|
+
visibility: {
|
|
11189
|
+
[key: string]: boolean;
|
|
11190
|
+
};
|
|
11191
|
+
order: string[];
|
|
11192
|
+
};
|
|
11193
|
+
};
|
|
11194
|
+
id: string;
|
|
11195
|
+
projectId: string;
|
|
11196
|
+
/** @enum {string} */
|
|
11197
|
+
resourceType: "composition" | "compositionPattern" | "component" | "componentPattern" | "entry" | "entryPattern" | "contentType" | "blockType" | "release" | "signal" | "intent" | "audience" | "asset";
|
|
11198
|
+
createdBy: string | null;
|
|
11199
|
+
/** Format: date-time */
|
|
11200
|
+
created: string;
|
|
11201
|
+
/** Format: date-time */
|
|
11202
|
+
modified: string;
|
|
11203
|
+
};
|
|
11204
|
+
};
|
|
11205
|
+
};
|
|
11206
|
+
400: components$a["responses"]["BadRequestError"];
|
|
11207
|
+
401: components$a["responses"]["UnauthorizedError"];
|
|
11208
|
+
403: components$a["responses"]["ForbiddenError"];
|
|
11209
|
+
/** View not found (or belongs to another project). */
|
|
11210
|
+
404: {
|
|
11211
|
+
headers: {
|
|
11212
|
+
[name: string]: unknown;
|
|
11213
|
+
};
|
|
11214
|
+
content?: never;
|
|
11215
|
+
};
|
|
11216
|
+
/** Quota exceeded: at most 100 saved views allowed for this project + resource type + user. Remove an existing view before creating a new one. */
|
|
11217
|
+
409: {
|
|
11218
|
+
headers: {
|
|
11219
|
+
[name: string]: unknown;
|
|
11220
|
+
};
|
|
11221
|
+
content?: never;
|
|
11222
|
+
};
|
|
11223
|
+
429: components$a["responses"]["RateLimitError"];
|
|
11224
|
+
500: components$a["responses"]["InternalServerError"];
|
|
11225
|
+
};
|
|
11226
|
+
};
|
|
11227
|
+
post?: never;
|
|
11228
|
+
/** Deletes a saved view by id. */
|
|
11229
|
+
delete: {
|
|
11230
|
+
parameters: {
|
|
11231
|
+
query?: never;
|
|
11232
|
+
header?: never;
|
|
11233
|
+
path?: never;
|
|
11234
|
+
cookie?: never;
|
|
11235
|
+
};
|
|
11236
|
+
requestBody: {
|
|
11237
|
+
content: {
|
|
11238
|
+
"application/json": {
|
|
11239
|
+
id: string;
|
|
11240
|
+
projectId: string;
|
|
11241
|
+
};
|
|
11242
|
+
};
|
|
11243
|
+
};
|
|
11244
|
+
responses: {
|
|
11245
|
+
/** No Content */
|
|
11246
|
+
204: {
|
|
11247
|
+
headers: {
|
|
11248
|
+
[name: string]: unknown;
|
|
11249
|
+
};
|
|
11250
|
+
content: {
|
|
11251
|
+
"application/json": string;
|
|
11252
|
+
};
|
|
11253
|
+
};
|
|
11254
|
+
400: components$a["responses"]["BadRequestError"];
|
|
11255
|
+
401: components$a["responses"]["UnauthorizedError"];
|
|
11256
|
+
403: components$a["responses"]["ForbiddenError"];
|
|
11257
|
+
/** View not found. */
|
|
11258
|
+
404: {
|
|
11259
|
+
headers: {
|
|
11260
|
+
[name: string]: unknown;
|
|
11261
|
+
};
|
|
11262
|
+
content?: never;
|
|
11263
|
+
};
|
|
11264
|
+
429: components$a["responses"]["RateLimitError"];
|
|
11265
|
+
500: components$a["responses"]["InternalServerError"];
|
|
11266
|
+
};
|
|
11170
11267
|
};
|
|
11171
|
-
/**
|
|
11172
|
-
|
|
11173
|
-
|
|
11174
|
-
|
|
11175
|
-
|
|
11176
|
-
|
|
11177
|
-
|
|
11178
|
-
|
|
11268
|
+
/** Handles preflight requests. This endpoint allows CORS. */
|
|
11269
|
+
options: {
|
|
11270
|
+
parameters: {
|
|
11271
|
+
query?: never;
|
|
11272
|
+
header?: never;
|
|
11273
|
+
path?: never;
|
|
11274
|
+
cookie?: never;
|
|
11275
|
+
};
|
|
11276
|
+
requestBody?: never;
|
|
11277
|
+
responses: {
|
|
11278
|
+
/** ok */
|
|
11279
|
+
204: {
|
|
11280
|
+
headers: {
|
|
11281
|
+
[name: string]: unknown;
|
|
11282
|
+
};
|
|
11283
|
+
content?: never;
|
|
11284
|
+
};
|
|
11285
|
+
};
|
|
11179
11286
|
};
|
|
11180
|
-
|
|
11287
|
+
head?: never;
|
|
11288
|
+
patch?: never;
|
|
11289
|
+
trace?: never;
|
|
11290
|
+
};
|
|
11291
|
+
}
|
|
11292
|
+
interface components$a {
|
|
11293
|
+
schemas: {
|
|
11181
11294
|
Error: {
|
|
11182
11295
|
/** Error message(s) that occurred while processing the request */
|
|
11183
11296
|
errorMessage?: string[] | string;
|
|
@@ -11226,102 +11339,28 @@ interface components$a {
|
|
|
11226
11339
|
content?: never;
|
|
11227
11340
|
};
|
|
11228
11341
|
};
|
|
11229
|
-
parameters:
|
|
11230
|
-
/** The project to fetch a route from */
|
|
11231
|
-
projectId: string;
|
|
11232
|
-
/**
|
|
11233
|
-
* The path to resolve. Dynamic project map nodes and redirects can be resolved when a matching path is passed.
|
|
11234
|
-
* Query string parameters may be passed with the path. They are ignored for route matching.
|
|
11235
|
-
* If the route matches a composition and the project map node allows passed query string parameters, query parameters will
|
|
11236
|
-
* be returned as as dynamic inputs to the composition.
|
|
11237
|
-
*
|
|
11238
|
-
* Examples:
|
|
11239
|
-
* * route "/company/about-us" would match "/company/about-us" in project map or redirects
|
|
11240
|
-
* * route "/products/123" would match "/products/:productId" in project map or "/products/*" in redirects
|
|
11241
|
-
* * route "/products/123?color=red" would match "/products/:productId" in project map, and provde productId=123 and color=red as dynamic inputs to the composition
|
|
11242
|
-
*
|
|
11243
|
-
* Conflict resolution:
|
|
11244
|
-
* If a route matches multiple possible project map or redirect nodes, the resulting action will use the following logic:
|
|
11245
|
-
* * If a redirect matches, it wins over project map nodes in all cases
|
|
11246
|
-
* * If multiple redirects or project map nodes match the route, the one with the most specific path wins:
|
|
11247
|
-
* * The route with the most path segments wins
|
|
11248
|
-
* * If several matches have the same number of segments, the one with the fewest dynamic segments wins
|
|
11249
|
-
* * If still ambiguous, the first matching route arbitrarily wins
|
|
11250
|
-
*
|
|
11251
|
-
* Invalid paths:
|
|
11252
|
-
* The request fails with HTTP 400 when the path, ignoring its query string and trailing slashes:
|
|
11253
|
-
* * contains consecutive slashes (for example "/en//about" or "//en/about")
|
|
11254
|
-
* * has a path segment that is too long to match any route. The limit depends on the characters used,
|
|
11255
|
-
* and is generally 150-220 characters per segment.
|
|
11256
|
-
*
|
|
11257
|
-
* Probe paths:
|
|
11258
|
-
* On uniform.global, paths ending in an archive, backup or database file extension (for example "/site.zip",
|
|
11259
|
-
* "/config.php.bak" or "/db.sql") return `{ "type": "notFound" }` without being matched, even where a dynamic
|
|
11260
|
-
* project map node or redirect would match them.
|
|
11261
|
-
*/
|
|
11262
|
-
path: string;
|
|
11263
|
-
/** Specify a project map ID to fetch route from. If not specified, the default project map for the projectId is used */
|
|
11264
|
-
projectMapId: string;
|
|
11265
|
-
/** Publishing state to fetch. 0 = draft, 64 = published */
|
|
11266
|
-
state: number;
|
|
11267
|
-
/**
|
|
11268
|
-
* If true the `_id` unique identifier of each non-root component will be part of the response data.
|
|
11269
|
-
* If false, the `_id` will not be present in the API response
|
|
11270
|
-
*/
|
|
11271
|
-
withComponentIDs: boolean;
|
|
11272
|
-
/**
|
|
11273
|
-
* @deprecated
|
|
11274
|
-
* Has no effect.
|
|
11275
|
-
*/
|
|
11276
|
-
withContentSourceMap: boolean;
|
|
11277
|
-
/**
|
|
11278
|
-
* One or more locales to localize the response to.
|
|
11279
|
-
* When the result is a composition, it includes only the first matching locale's data.
|
|
11280
|
-
* If no matching locale is found, the response will be a not-found result.
|
|
11281
|
-
*
|
|
11282
|
-
* This parameter accepts a single value, a comma-delimited list of values, or the Accept-Language header syntax. Examples:
|
|
11283
|
-
* en-US
|
|
11284
|
-
* fr-CA,fr
|
|
11285
|
-
* de-AT;q=0.9,de-DE;q=0.8,en;q=0.7
|
|
11286
|
-
*
|
|
11287
|
-
* When this parameter is not passed:
|
|
11288
|
-
* - If a dynamic :locale path segment is defined on a project map ancestor node, then it will be used as the locale. If the path segment and this parameter are provided, the parameter takes precedence.
|
|
11289
|
-
* - Otherwise, all locales' data is returned.
|
|
11290
|
-
*
|
|
11291
|
-
* When the result is a redirect, this parameter has no effect
|
|
11292
|
-
*/
|
|
11293
|
-
locale: string;
|
|
11294
|
-
/**
|
|
11295
|
-
* The ID of a release to fetch the content for.
|
|
11296
|
-
*
|
|
11297
|
-
* - When unspecified, all release content is excluded from the result(s).
|
|
11298
|
-
* - When specified, all content is returned as it would appear in the release if it was released now. This includes both content copied to the release and changed, as well as content that is not part of the release.
|
|
11299
|
-
*
|
|
11300
|
-
* Content copied to a release can be differentiated from base content by the `releaseId` property on the content. If the content is not copied to the release, this property will be null
|
|
11301
|
-
*/
|
|
11302
|
-
releaseId: string;
|
|
11303
|
-
/**
|
|
11304
|
-
* Indicates the data variant that was fetched for data resources.
|
|
11305
|
-
* undefined: Data resources were resolved using published data from their data source
|
|
11306
|
-
* unpublished: Data resources which support unpublished data retrieved unpublished data from their data source. Data resources that did not support unpublished data retrieved published data instead.
|
|
11307
|
-
*/
|
|
11308
|
-
dataSourceVariant: "unpublished";
|
|
11309
|
-
/**
|
|
11310
|
-
* When true, redirects are not evaluated for the route matching; the result will be either a composition or not found.
|
|
11311
|
-
* Note: this is always true when state=63 (internal RSC editor state) to allow contextual editing of compositions
|
|
11312
|
-
* that have redirects configured on their paths.
|
|
11313
|
-
*/
|
|
11314
|
-
ignoreRedirects: boolean;
|
|
11315
|
-
};
|
|
11342
|
+
parameters: never;
|
|
11316
11343
|
requestBodies: never;
|
|
11317
11344
|
headers: never;
|
|
11318
11345
|
pathItems: never;
|
|
11319
11346
|
}
|
|
11320
11347
|
|
|
11321
|
-
type
|
|
11348
|
+
type ViewsApi = paths$a['/api/v1/views'];
|
|
11349
|
+
type ViewsQuery = ViewsApi['get']['parameters']['query'];
|
|
11350
|
+
type ViewPut = ViewsApi['put']['requestBody']['content']['application/json'];
|
|
11351
|
+
type ViewDelete = ViewsApi['delete']['requestBody']['content']['application/json'];
|
|
11352
|
+
type ViewsResponse = ViewsApi['get']['responses']['200']['content']['application/json'];
|
|
11353
|
+
type View = ViewsResponse['views'][number];
|
|
11354
|
+
/**
|
|
11355
|
+
* File/sync shape for a shared custom view. Audit fields and `projectId` are
|
|
11356
|
+
* stripped on pull; `id` is kept so PUT is create-or-replace across projects.
|
|
11357
|
+
*/
|
|
11358
|
+
type SerializedCustomView = Omit<View, 'projectId' | 'createdBy' | 'created' | 'modified'>;
|
|
11359
|
+
|
|
11360
|
+
type Components = components$e['schemas'];
|
|
11322
11361
|
type SharedComponents$1 = components$r['schemas'];
|
|
11323
|
-
type Api = paths$
|
|
11324
|
-
type HistoryApi = paths$
|
|
11362
|
+
type Api = paths$d['/api/v1/canvas'];
|
|
11363
|
+
type HistoryApi = paths$c['/api/v1/canvas-history'];
|
|
11325
11364
|
/** Query parameter options for GET /api/v1/canvas */
|
|
11326
11365
|
type CompositionGetParameters = Omit<Api['get']['parameters']['query'], 'type'> & {
|
|
11327
11366
|
type?: string | string[];
|
|
@@ -11440,6 +11479,37 @@ type CopiedComponentSubtree = {
|
|
|
11440
11479
|
* Defines how a component on a pattern may have its values overridden
|
|
11441
11480
|
*/
|
|
11442
11481
|
type ComponentOverridability = SharedComponents$1['ComponentOverridability'];
|
|
11482
|
+
interface EndpointOut {
|
|
11483
|
+
channels?: string[] | null;
|
|
11484
|
+
createdAt: Date;
|
|
11485
|
+
description: string;
|
|
11486
|
+
disabled?: boolean;
|
|
11487
|
+
filterTypes?: string[] | null;
|
|
11488
|
+
id: string;
|
|
11489
|
+
metadata: {
|
|
11490
|
+
[key: string]: string;
|
|
11491
|
+
};
|
|
11492
|
+
rateLimit?: number | null;
|
|
11493
|
+
throttleRate?: number | null;
|
|
11494
|
+
uid?: string | null;
|
|
11495
|
+
updatedAt: Date;
|
|
11496
|
+
url: string;
|
|
11497
|
+
version: number;
|
|
11498
|
+
}
|
|
11499
|
+
interface EndpointHeadersOut {
|
|
11500
|
+
headers: {
|
|
11501
|
+
[key: string]: string;
|
|
11502
|
+
};
|
|
11503
|
+
sensitive: string[];
|
|
11504
|
+
}
|
|
11505
|
+
interface EndpointTransformationOut {
|
|
11506
|
+
code?: string | null;
|
|
11507
|
+
enabled?: boolean;
|
|
11508
|
+
updatedAt?: Date | null;
|
|
11509
|
+
variables?: {
|
|
11510
|
+
[key: string]: string;
|
|
11511
|
+
} | null;
|
|
11512
|
+
}
|
|
11443
11513
|
/**
|
|
11444
11514
|
* Defines the shape of serialized webhook
|
|
11445
11515
|
*/
|
|
@@ -11510,7 +11580,7 @@ type DataResolutionParameters = {
|
|
|
11510
11580
|
};
|
|
11511
11581
|
/** Types of issue that can occur when fetching composition data */
|
|
11512
11582
|
type DataResolutionIssue = PatternIssue | DataResourceIssue | MaxDepthExceededIssue | DataElementBindingIssue | DynamicInputIssue | DataResolutionConfigIssue;
|
|
11513
|
-
type DataResolutionIssueCore = components$
|
|
11583
|
+
type DataResolutionIssueCore = components$c['schemas']['DataResolutionIssue'];
|
|
11514
11584
|
/** An error that occured resolving a pattern that is referenced on the composition */
|
|
11515
11585
|
type PatternIssue = DataResolutionIssueCore & {
|
|
11516
11586
|
type: 'pattern';
|
|
@@ -11564,26 +11634,26 @@ type DataResolutionConfigIssue = {
|
|
|
11564
11634
|
type: 'config';
|
|
11565
11635
|
};
|
|
11566
11636
|
/** Diagnostics about edge request processing */
|
|
11567
|
-
type EdgehancersDiagnostics = components$
|
|
11568
|
-
type EdgehancersWholeResponseCacheDiagnostics = components$
|
|
11637
|
+
type EdgehancersDiagnostics = components$c['schemas']['EdgehancersDiagnostics'];
|
|
11638
|
+
type EdgehancersWholeResponseCacheDiagnostics = components$c['schemas']['EdgehancersResolutionInfo']['wholeResponseCacheDiagnostics'];
|
|
11569
11639
|
/** Diagnostic data about the load performance of attached composition datas */
|
|
11570
|
-
type DataDiagnostic = components$
|
|
11640
|
+
type DataDiagnostic = components$c['schemas']['DataDiagnostic'];
|
|
11571
11641
|
/** Response as it comes from uniform.global/api/v1/composition */
|
|
11572
|
-
type CompositionResolvedGetResponse = components$
|
|
11573
|
-
type CompositionResolvedListResponse = components$
|
|
11642
|
+
type CompositionResolvedGetResponse = components$c['schemas']['CompositionResolvedGetResponse'];
|
|
11643
|
+
type CompositionResolvedListResponse = components$c['schemas']['CompositionResolvedListResponse'];
|
|
11574
11644
|
/** All valid response types */
|
|
11575
11645
|
type CompositionGetValidResponses = CompositionGetResponse | CompositionResolvedGetResponse;
|
|
11576
11646
|
/** The GET response from /api/v1/route */
|
|
11577
|
-
type RouteGetParameters = paths$
|
|
11578
|
-
type RouteGetResponse = components$
|
|
11579
|
-
type RouteGetResponseComposition = components$
|
|
11580
|
-
type RouteGetResponseRedirect = components$
|
|
11581
|
-
type RouteGetResponseNotFound = components$
|
|
11582
|
-
type RouteDynamicInputs = components$
|
|
11647
|
+
type RouteGetParameters = paths$b['/api/v1/route']['get']['parameters']['query'] & DataResolutionParameters;
|
|
11648
|
+
type RouteGetResponse = components$f['schemas']['RouteResponse'];
|
|
11649
|
+
type RouteGetResponseComposition = components$f['schemas']['RouteResponseComposition'];
|
|
11650
|
+
type RouteGetResponseRedirect = components$f['schemas']['RouteResponseRedirect'];
|
|
11651
|
+
type RouteGetResponseNotFound = components$f['schemas']['RouteResponseNotFound'];
|
|
11652
|
+
type RouteDynamicInputs = components$f['schemas']['RouteDynamicInputs'];
|
|
11583
11653
|
/** The GET response from /api/v1/entries */
|
|
11584
11654
|
type EntriesGetParameters = paths$l['/api/v1/entries']['get']['parameters']['query'] & DataResolutionParameters;
|
|
11585
11655
|
type EntriesGetResponse = components$p['schemas']['EntryListResponse'];
|
|
11586
|
-
type EntriesResolvedListResponse = components$
|
|
11656
|
+
type EntriesResolvedListResponse = components$c['schemas']['EntryResolvedListResponse'];
|
|
11587
11657
|
/** GET response from uniform.global/api/v1/route when result is a composition */
|
|
11588
11658
|
type RouteGetResponseEdgehancedComposition = Omit<RouteGetResponseComposition, 'compositionApiResponse'> & {
|
|
11589
11659
|
compositionApiResponse: CompositionResolvedGetResponse;
|
|
@@ -12198,7 +12268,7 @@ type IntegrationPropertyEditorsGetResponse = paths$9['/api/v1/integration-proper
|
|
|
12198
12268
|
type IntegrationPropertyEditorsPutParameters = paths$9['/api/v1/integration-property-editors']['put']['requestBody']['content']['application/json'];
|
|
12199
12269
|
type IntegrationPropertyEditorsDeleteParameters = paths$9['/api/v1/integration-property-editors']['delete']['requestBody']['content']['application/json'];
|
|
12200
12270
|
|
|
12201
|
-
type schemas = components$
|
|
12271
|
+
type schemas = components$c['schemas'];
|
|
12202
12272
|
type InvalidationPayload = schemas['InvalidationPayload'];
|
|
12203
12273
|
type BatchInvalidationPayload = schemas['BatchInvalidationPayload'];
|
|
12204
12274
|
|
|
@@ -13080,6 +13150,11 @@ interface components$5 {
|
|
|
13080
13150
|
* NOTE: This is only required if the release content has an edition ID
|
|
13081
13151
|
*/
|
|
13082
13152
|
editionId?: string;
|
|
13153
|
+
/**
|
|
13154
|
+
* Bypass the trash and permanently delete the release content.
|
|
13155
|
+
* Requires team admin rights.
|
|
13156
|
+
*/
|
|
13157
|
+
permanent?: boolean;
|
|
13083
13158
|
/**
|
|
13084
13159
|
* Entity type (i.e. composition, entry, asset, ...).
|
|
13085
13160
|
* NOTE: New values may be added to this list without being considered a breaking API change.
|
|
@@ -16219,169 +16294,7 @@ declare function hasReferencedVariables(value: string | undefined): number;
|
|
|
16219
16294
|
*/
|
|
16220
16295
|
declare function parseVariableExpression(serialized: string, onToken?: (token: string, type: 'text' | 'variable', offset: number) => void | false): number;
|
|
16221
16296
|
|
|
16222
|
-
|
|
16223
|
-
* Well known parameters that are allowed on every Canvas component type
|
|
16224
|
-
* note: CANVAS_INTERNAL_VARIANT_PARAMETER is also a 'system' parameter at the database level,
|
|
16225
|
-
* but we extract it into the `variants` property proper before it is ever shown to the API or frontend,
|
|
16226
|
-
* so it is not included here.
|
|
16227
|
-
*
|
|
16228
|
-
* NOTE: any parameters added here will be removed from a component when it is converted to a pattern,
|
|
16229
|
-
* and then added back as a parameter override on the pattern reference.
|
|
16230
|
-
*/
|
|
16231
|
-
declare const wellKnownSystemComponentParameters: Array<ComponentDefinitionParameter>;
|
|
16232
|
-
|
|
16233
|
-
/** Well known component types that are always allowed since they are defined by the Canvas system. */
|
|
16234
|
-
declare const wellKnownSystemComponents: [{
|
|
16235
|
-
readonly id: "$personalization";
|
|
16236
|
-
readonly name: "Personalization";
|
|
16237
|
-
readonly icon: "track";
|
|
16238
|
-
readonly titleParameter: "trackingEventName";
|
|
16239
|
-
readonly description: "Contains components that will be shown to visitors based on configurable personalization criteria.";
|
|
16240
|
-
readonly slots: [{
|
|
16241
|
-
readonly id: "pz";
|
|
16242
|
-
readonly inheritAllowedComponents: true;
|
|
16243
|
-
readonly name: "Personalized Variations";
|
|
16244
|
-
readonly allowedComponents: [];
|
|
16245
|
-
}];
|
|
16246
|
-
readonly parameters: [{
|
|
16247
|
-
readonly id: "trackingEventName";
|
|
16248
|
-
readonly name: "Analytics tracking name";
|
|
16249
|
-
readonly type: "text";
|
|
16250
|
-
readonly typeConfig: {
|
|
16251
|
-
readonly required: true;
|
|
16252
|
-
readonly caption: "Will be sent to your analytics tool. We recommend not changing this once the composition is published.";
|
|
16253
|
-
};
|
|
16254
|
-
}, {
|
|
16255
|
-
readonly id: "algorithm";
|
|
16256
|
-
readonly name: "Selection method";
|
|
16257
|
-
readonly type: "pzAlgorithm";
|
|
16258
|
-
readonly typeConfig: {
|
|
16259
|
-
readonly required: true;
|
|
16260
|
-
};
|
|
16261
|
-
}, {
|
|
16262
|
-
readonly id: "count";
|
|
16263
|
-
readonly name: "Number of variations to select";
|
|
16264
|
-
readonly type: "number";
|
|
16265
|
-
readonly typeConfig: {
|
|
16266
|
-
readonly regex: "^[0-9]+$";
|
|
16267
|
-
readonly regexMessage: "Please enter a whole number";
|
|
16268
|
-
readonly placeholder: "1";
|
|
16269
|
-
};
|
|
16270
|
-
}, {
|
|
16271
|
-
readonly id: "$internal_hypothesis";
|
|
16272
|
-
readonly name: "Hypothesis";
|
|
16273
|
-
readonly type: "richText";
|
|
16274
|
-
readonly typeConfig: {
|
|
16275
|
-
readonly formatting: {
|
|
16276
|
-
readonly builtIn: readonly ["bold", "italic", "underline"];
|
|
16277
|
-
};
|
|
16278
|
-
readonly elements: {
|
|
16279
|
-
readonly builtIn: readonly ["unorderedList", "orderedList"];
|
|
16280
|
-
};
|
|
16281
|
-
};
|
|
16282
|
-
readonly helpText: "Document the hypothesis or reasoning behind this personalization strategy.";
|
|
16283
|
-
readonly guidance: "Document the hypothesis or reasoning behind this personalization strategy. Not localizable; do not pass a locale when editing.";
|
|
16284
|
-
}];
|
|
16285
|
-
}, {
|
|
16286
|
-
readonly id: "$test";
|
|
16287
|
-
readonly name: "A/B Test";
|
|
16288
|
-
readonly icon: "style";
|
|
16289
|
-
readonly titleParameter: "test";
|
|
16290
|
-
readonly description: "Contains components that will be shown to visitors randomly based on a configurable traffic split.";
|
|
16291
|
-
readonly slots: [{
|
|
16292
|
-
readonly id: "test";
|
|
16293
|
-
readonly inheritAllowedComponents: true;
|
|
16294
|
-
readonly name: "Test Variations";
|
|
16295
|
-
readonly allowedComponents: [];
|
|
16296
|
-
}];
|
|
16297
|
-
readonly parameters: [{
|
|
16298
|
-
readonly id: "test";
|
|
16299
|
-
readonly name: "Test name";
|
|
16300
|
-
readonly type: "testSelect";
|
|
16301
|
-
}, {
|
|
16302
|
-
readonly id: "$internal_hypothesis";
|
|
16303
|
-
readonly name: "Hypothesis";
|
|
16304
|
-
readonly type: "richText";
|
|
16305
|
-
readonly typeConfig: {
|
|
16306
|
-
readonly formatting: {
|
|
16307
|
-
readonly builtIn: readonly ["bold", "italic", "underline"];
|
|
16308
|
-
};
|
|
16309
|
-
readonly elements: {
|
|
16310
|
-
readonly builtIn: readonly ["unorderedList", "orderedList"];
|
|
16311
|
-
};
|
|
16312
|
-
};
|
|
16313
|
-
readonly helpText: "Document the hypothesis or expected outcome of this A/B test.";
|
|
16314
|
-
readonly guidance: "Document the hypothesis or expected outcome of this A/B test. Not localizable; do not pass a locale when editing.";
|
|
16315
|
-
}];
|
|
16316
|
-
}, {
|
|
16317
|
-
readonly id: "$localization";
|
|
16318
|
-
readonly name: "Localization";
|
|
16319
|
-
readonly icon: "globe-alt";
|
|
16320
|
-
readonly description: "Contains components that will be shown based on visitor locale.";
|
|
16321
|
-
readonly slots: [{
|
|
16322
|
-
readonly id: "localized";
|
|
16323
|
-
readonly inheritAllowedComponents: true;
|
|
16324
|
-
readonly name: "Localized Variations";
|
|
16325
|
-
readonly allowedComponents: [];
|
|
16326
|
-
}];
|
|
16327
|
-
}, {
|
|
16328
|
-
readonly id: "$loop";
|
|
16329
|
-
readonly name: "Loop";
|
|
16330
|
-
readonly icon: "repeat";
|
|
16331
|
-
readonly description: "Contains components that will be repeated for each item in a list (array) selected from a data resource.";
|
|
16332
|
-
readonly slots: [{
|
|
16333
|
-
readonly id: "body";
|
|
16334
|
-
readonly inheritAllowedComponents: true;
|
|
16335
|
-
readonly name: "Body";
|
|
16336
|
-
readonly minComponents: 1;
|
|
16337
|
-
readonly allowedComponents: [];
|
|
16338
|
-
}];
|
|
16339
|
-
}, {
|
|
16340
|
-
readonly id: "$slotSection";
|
|
16341
|
-
readonly name: "Slot Section";
|
|
16342
|
-
readonly icon: "copy-all";
|
|
16343
|
-
readonly titleParameter: "name";
|
|
16344
|
-
readonly description: "When using this pattern, new components may be added at the location where this component is inserted.";
|
|
16345
|
-
readonly slots: [{
|
|
16346
|
-
readonly id: "$slotSectionItems";
|
|
16347
|
-
readonly inheritAllowedComponents: true;
|
|
16348
|
-
readonly name: "Items";
|
|
16349
|
-
readonly allowedComponents: [];
|
|
16350
|
-
}];
|
|
16351
|
-
readonly parameters: [{
|
|
16352
|
-
readonly id: "name";
|
|
16353
|
-
readonly name: "Name";
|
|
16354
|
-
readonly type: "text";
|
|
16355
|
-
}, {
|
|
16356
|
-
readonly id: "min";
|
|
16357
|
-
readonly name: "Minimum";
|
|
16358
|
-
readonly type: "text";
|
|
16359
|
-
}, {
|
|
16360
|
-
readonly id: "max";
|
|
16361
|
-
readonly name: "Maximum";
|
|
16362
|
-
readonly type: "text";
|
|
16363
|
-
}, {
|
|
16364
|
-
readonly id: "groupType";
|
|
16365
|
-
readonly name: "Group Type";
|
|
16366
|
-
readonly type: "text";
|
|
16367
|
-
}, {
|
|
16368
|
-
readonly id: "specific";
|
|
16369
|
-
readonly name: "Specific";
|
|
16370
|
-
readonly type: "array";
|
|
16371
|
-
}];
|
|
16372
|
-
}];
|
|
16373
|
-
type SystemComponentSettings = {
|
|
16374
|
-
/** Allowed in every slot, whatever the slot allows. */
|
|
16375
|
-
isAutoAllowed?: boolean;
|
|
16376
|
-
/** Allowed only while editing a pattern. */
|
|
16377
|
-
isOnlyAllowedInPatternEditor?: boolean;
|
|
16378
|
-
};
|
|
16379
|
-
/** Placement rules of each system component type that differ from a regular component's. */
|
|
16380
|
-
declare const systemComponentsMetadata: Record<(typeof wellKnownSystemComponents)[number]['id'], SystemComponentSettings | undefined>;
|
|
16381
|
-
/** Returns the placement rules of a system component type, or undefined for any other type. */
|
|
16382
|
-
declare const getComponentMetadata: (type: string) => SystemComponentSettings | undefined;
|
|
16383
|
-
|
|
16384
|
-
declare const version = "20.86.0";
|
|
16297
|
+
declare const version = "20.87.0";
|
|
16385
16298
|
|
|
16386
16299
|
/** API client to enable managing workflow definitions */
|
|
16387
16300
|
declare class WorkflowClient extends ApiClient {
|
|
@@ -16404,4 +16317,4 @@ declare class WorkflowClient extends ApiClient {
|
|
|
16404
16317
|
|
|
16405
16318
|
declare const CanvasClientError: typeof ApiClientError;
|
|
16406
16319
|
|
|
16407
|
-
export { ASSETS_SOURCE_CUSTOM_URL, ASSETS_SOURCE_UNIFORM, ASSET_PARAMETER_TYPE, ATTRIBUTE_COMPONENT_ID, ATTRIBUTE_MULTILINE, ATTRIBUTE_PARAMETER_ID, ATTRIBUTE_PARAMETER_TYPE, ATTRIBUTE_PARAMETER_VALUE, ATTRIBUTE_PLACEHOLDER, type AddComponentMessage, type AiAction, type AssetParamConfig, type AwaitingReadyMessage, type BatchEnhancer, BatchEntry, type BatchInvalidationPayload, type BindVariablesOptions, type BindVariablesResult, type BindVariablesToObjectOptions, BlockFormatError, type BlockLocationReference, type BlockValue, CANVAS_ALIAS_DATA_TYPE, CANVAS_BLOCK_PARAM_TYPE, CANVAS_COMPONENT_DISPLAY_NAME_PARAM, CANVAS_CONTEXTUAL_EDITING_PARAM, CANVAS_DRAFT_STATE, CANVAS_EDITOR_STATE, CANVAS_ENRICHMENT_TAG_PARAM, CANVAS_HYPOTHESIS_PARAM, CANVAS_INTENT_TAG_PARAM, CANVAS_INTERNAL_PARAM_PREFIX, CANVAS_LOCALE_TAG_PARAM, CANVAS_LOCALIZATION_SLOT, CANVAS_LOCALIZATION_TYPE, CANVAS_LOOP_DATA_TYPE, CANVAS_LOOP_SLOT, CANVAS_LOOP_TYPE, CANVAS_PERSONALIZATION_ALGORITHM_PARAM, CANVAS_PERSONALIZATION_ALGORITHM_TYPE, CANVAS_PERSONALIZATION_EVENT_NAME_PARAM, CANVAS_PERSONALIZATION_PARAM, CANVAS_PERSONALIZATION_TAKE_PARAM, CANVAS_PERSONALIZE_SLOT, CANVAS_PERSONALIZE_TYPE, CANVAS_PUBLISHED_STATE, CANVAS_SLOT_SECTION_GROUP_TYPE_PARAM, CANVAS_SLOT_SECTION_MAX_PARAM, CANVAS_SLOT_SECTION_MIN_PARAM, CANVAS_SLOT_SECTION_NAME_PARAM, CANVAS_SLOT_SECTION_SLOT, CANVAS_SLOT_SECTION_SPECIFIC_PARAM, CANVAS_SLOT_SECTION_TYPE, CANVAS_TEST_SLOT, CANVAS_TEST_TYPE, CANVAS_TEST_VARIANT_PARAM, CANVAS_VIZ_CONTROL_PARAM, CANVAS_VIZ_DI_RULE, CANVAS_VIZ_DYNAMIC_TOKEN_RULE, CANVAS_VIZ_LOCALE_RULE, CANVAS_VIZ_QUIRKS_RULE, CanvasClient, CanvasClientError, type CanvasDefinitions, type CategoriesDeleteParameters, type CategoriesGetParameters, type CategoriesGetResponse, type CategoriesPutParameters, type Category, CategoryClient, type Channel, type ChannelMessage, ChildEnhancerBuilder, type ComponentDefinition, ComponentDefinitionClient, type ComponentDefinitionDeleteParameters, type ComponentDefinitionGetParameters, type ComponentDefinitionGetResponse, type ComponentDefinitionParameter, type ComponentDefinitionPermission, type ComponentDefinitionPutParameters, type ComponentDefinitionSlot, type ComponentDefinitionSlugSettings, type ComponentDefinitionVariant, type ComponentEnhancer, type ComponentEnhancerFunction, type ComponentEnhancerOptions, type ComponentInstance, type ComponentInstanceContextualEditing, type ComponentInstanceHistoryEntry, type ComponentInstanceHistoryGetParameters, type ComponentInstanceHistoryGetResponse, type ComponentLocationReference, type ComponentOverridability, type ComponentOverride, type ComponentOverrides, type ComponentParameter, type ComponentParameterBlock, type ComponentParameterConditionalValue, type ComponentParameterContextualEditing, type ComponentParameterEnhancer, type ComponentParameterEnhancerFunction, type ComponentParameterEnhancerOptions, type CompositionDeleteParameters, CompositionDeliveryClient, type CompositionDeliveryListQuery, type CompositionDeliveryReadOptions, type CompositionDeliverySelector, type CompositionFilters, type CompositionGetByComponentIdParameters, type CompositionGetByIdParameters, type CompositionGetByNodeIdParameters, type CompositionGetByNodePathParameters, type CompositionGetBySlugParameters, type CompositionGetListResponse, type CompositionGetParameters, type CompositionGetResponse, type CompositionGetValidResponses, type CompositionListQuery, CompositionManagementClient, type CompositionManagementListQuery, type CompositionManagementReadOptions, type CompositionManagementSelector, type CompositionPutParameters, type CompositionReadOptions, type CompositionResolvedGetResponse, type CompositionResolvedListResponse, type CompositionUIStatus, type CompositionWriteSelector, ContentClient, type ContentType, ContentTypeClient, type ContentTypeField, type ContentTypePreviewConfiguration, type ContextStorageUpdatedMessage, type ContextualEditingComponentReference, type ContextualEditingValue, type CopiedComponentSubtree, type DataDiagnostic, type DataElementBindingIssue, type DataElementConnectionDefinition, type DataElementConnectionFailureAction, type DataElementConnectionFailureLogLevel, type DataResolutionConfigIssue, type DataResolutionIssue, type DataResolutionOption, type DataResolutionOptionNegative, type DataResolutionOptionPositive, type DataResolutionParameters, type DataResourceDefinition, type DataResourceDefinitions, type DataResourceIssue, type DataResourceVariables, type DataSource, DataSourceClient, type DataSourceDeleteParameters, type DataSourceGetParameters, type DataSourceGetResponse, type DataSourcePutParameters, type DataSourceVariantData, type DataSourceVariantsKeys, type DataSourcesGetParameters, type DataSourcesGetResponse, type DataType, DataTypeClient, type DataTypeDeleteParameters, type DataTypeGetParameters, type DataTypeGetResponse, type DataTypePutParameters, type DataVariableDefinition, type DataWithProperties, type DateParamConfig, type DateParamValue, type DatetimeParamConfig, type DeleteContentTypeOptions, type DeleteEntryOptions, type DismissPlaceholderMessage, type DynamicInputIssue, EDGE_CACHE_DISABLED, EDGE_DEFAULT_CACHE_TTL, EDGE_MAX_CACHE_TTL, EDGE_MIN_CACHE_TTL, EMPTY_COMPOSITION, type EdgehancersDiagnostics, type EdgehancersWholeResponseCacheDiagnostics, type EditorStateUpdatedMessage, EnhancerBuilder, type EnhancerContext, type EnhancerError, EntityReleasesClient, type EntityReleasesGetParameters, type EntityReleasesGetResponse, type EntriesGetParameters, type EntriesGetResponse, type EntriesHistoryGetParameters, type EntriesHistoryGetResponse, type EntriesResolvedListResponse, type Entry, type EntryData, EntryDeliveryClient, type EntryDeliveryListQuery, type EntryDeliveryReadOptions, type EntryFilters, type EntryList, type EntryListQuery, EntryManagementClient, type EntryManagementListQuery, type EntryManagementReadOptions, type EntryReadOptions, type EntrySelector, type EntryWriteSelector, type EvaluateCriteriaGroupOptions, type EvaluateNodeTreeVisibilityOptions, type EvaluateNodeVisibilityParameterOptions, type EvaluatePropertyCriteriaOptions, type EvaluateWalkTreePropertyCriteriaOptions, type FieldTypesProjection, type FieldsProjection, type Filters, type FindInNodeTreeReference, type FlattenProperty, type FlattenValues, type FlattenValuesOptions, type GetContentTypesOptions, type GetContentTypesResponse, type GetEffectivePropertyValueOptions, type GetEntriesOptions, type GetEntriesResponse, type GetParameterAttributesProps, IN_CONTEXT_EDITOR_COMPONENT_END_ROLE, IN_CONTEXT_EDITOR_COMPONENT_START_ROLE, IN_CONTEXT_EDITOR_CONFIG_CHECK_QUERY_STRING_PARAM, IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID, IN_CONTEXT_EDITOR_FORCED_SETTINGS_QUERY_STRING_PARAM, IN_CONTEXT_EDITOR_PLAYGROUND_QUERY_STRING_PARAM, IN_CONTEXT_EDITOR_QUERY_STRING_PARAM, IS_RENDERED_BY_UNIFORM_ATTRIBUTE, IntegrationPropertyEditorsClient, type IntegrationPropertyEditorsDeleteParameters, type IntegrationPropertyEditorsGetParameters, type IntegrationPropertyEditorsGetResponse, type paths$9 as IntegrationPropertyEditorsPaths, type IntegrationPropertyEditorsPutParameters, type InvalidationPayload, LOCALE_DYNAMIC_INPUT_NAME, type Label, LabelClient, type LabelDelete, type LabelPut, type LabelsQuery, type LabelsResponse, type LimitPolicy, type LinkParamConfiguration, type LinkParamValue, type LinkParameterType, type LinkTypeConfiguration, type ListEditions, type Locale, LocaleClient, type LocaleDeleteParameters, type LocalePutParameters, type LocalesGetParameters, type LocalesGetResponse, type LocalizeOptions, type ManagementEditionsOverride, type ManagementFormat, type MaxDepthExceededIssue, type MessageHandler, type MoveComponentMessage, type MultiSelectParamConfiguration, type MultiSelectParamEditorType, type MultiSelectParamValue, type NodeLocationReference, type NonProjectMapLinkParamValue, type NumberParamConfig, type NumberParamEditorType, type NumberParamValue, type OpenParameterEditorMessage, type OverrideOptions, PLACEHOLDER_ID, type ParamTypeConfigConventions, type PatternIssue, PreviewClient, type PreviewPanelSettings, type PreviewUrl, type PreviewUrlDeleteParameters, type PreviewUrlDeleteResponse, type PreviewUrlPutParameters, type PreviewUrlPutResponse, type PreviewUrlsGetParameters, type PreviewUrlsGetResponse, type PreviewViewport, type PreviewViewportDeleteParameters, type PreviewViewportDeleteResponse, type PreviewViewportPutParameters, type PreviewViewportPutResponse, type PreviewViewportsGetParameters, type PreviewViewportsGetResponse, type Project, ProjectClient, type ProjectDeleteParameters, type ProjectGetParameters, type ProjectGetResponse, type ProjectMapLinkParamValue, type ProjectPutParameters, type ProjectPutResponse, type Projection, type ProjectionSpec, type ProjectsGetParameters, type ProjectsGetProject, type ProjectsGetResponse, type ProjectsGetTeam, type Prompt, PromptClient, type PromptsDeleteParameters, type PromptsGetParameters, type PromptsGetResponse, type PromptsPutParameters, type PropertyCriteriaMatch, type PropertyValue, type PutContentTypeBody, type PutEntryBody, REFERENCE_DATA_TYPE_ID, type ReadyMessage, RelationshipClient, type RelationshipResultInstance, type Release, ReleaseClient, type ReleaseContent, ReleaseContentsClient, type ReleaseContentsDeleteBody, type ReleaseContentsGetParameters, type ReleaseContentsGetResponse, type ReleaseDeleteParameters, type ReleasePatchParameters, type ReleasePutParameters, type ReleaseState, type ReleasesGetParameters, type ReleasesGetResponse, type ReportRenderedCompositionsMessage, type RequestComponentSuggestionMessage, type RequestPageHtmlMessage, type ResolvedRouteGetResponse, type RichTextBuiltInElement, type RichTextBuiltInFormat, type RichTextParamConfiguration, type RichTextParamValue, type RootComponentInstance, type RootEntryReference, type RootLocationReference, RouteClient, type RouteDynamicInputs, type RouteGetParameters, type RouteGetResponse, type RouteGetResponseComposition, type RouteGetResponseEdgehancedComposition, type RouteGetResponseEdgehancedNotFound, type RouteGetResponseNotFound, type RouteGetResponseRedirect, SECRET_QUERY_STRING_PARAM, SELECT_QUERY_PREFIX, type SaveOptions, type SaveResult, type SelectComponentMessage, type SelectParamConfiguration, type SelectParamEditorType, type SelectParamOption, type SelectParamValue, type SelectParameterMessage, type SendPageHtmlMessage, type SerializedCustomView, type SessionPendingMessage, type SlotsProjection, type SpecificProjectMap, type StringOperators, type SuggestComponentMessage, type TextParamConfig, type TextParamValue, type TreeNodeInfoTypes, type TriggerComponentActionMessage, type TriggerCompositionActionMessage, UncachedCanvasClient, UncachedCategoryClient, UncachedContentClient, UncachedLabelClient, UniqueBatchEntries, type UpdateAiActionsMessage, type UpdateComponentParameterMessage, type UpdateComponentReferencesMessage, type UpdateCompositionInternalMessage, type UpdateCompositionMessage, type UpdateCompositionOptions, type UpdateContextualEditingStateInternalMessage, type UpdateFeatureFlagsMessage, type UpdatePreviewSettingsMessage, type UpsertEntryOptions, type View, type ViewDelete, type ViewPut, type ViewsQuery, type ViewsResponse, type VisibilityCriteria, type VisibilityCriteriaEvaluationResult, type VisibilityCriteriaGroup, type VisibilityParameterValue, type VisibilityRule, type VisibilityRules, type WalkNodeTreeActions, type WalkNodeTreeOptions, type WebhookDefinition, WorkflowClient, type WorkflowDefinition, type WorkflowStage, type WorkflowStagePermission, type WorkflowStageTransition, type WorkflowStageTransitionPermission, type WorkflowsDeleteParameters, type WorkflowsGetParameters, type WorkflowsGetResponse, type WorkflowsPutParameters, autoFixParameterGroups, bindExpressionEscapeChars, bindExpressionPrefix, bindVariables, bindVariablesToObject, compose, convertEntryToPutEntry, convertToBindExpression, createBatchEnhancer, createCanvasChannel, createDynamicInputVisibilityRule, createDynamicTokenVisibilityRule, createLimitPolicy, createLocaleVisibilityRule, createQuirksVisibilityRule, createUniformApiEnhancer, createVariableReference, enhance, escapeBindExpressionDefaultValue, evaluateNodeVisibilityParameter, evaluatePropertyCriteria, evaluateVisibilityCriteriaGroup, evaluateWalkTreeNodeVisibility, evaluateWalkTreePropertyCriteria, extractLocales, findParameterInNodeTree, flattenValues, generateComponentPlaceholderId, generateHash, getBlockValue, getComponentJsonPointer, getComponentMetadata, getComponentPath, getDataSourceVariantFromRouteGetParams, getEffectivePropertyValue, getLocalizedPropertyValues, getNounForLocation, getNounForNode, getParameterAttributes, getPropertiesValue, hasReferencedVariables, isAddComponentMessage, isAllowedReferrer, isAssetParamValue, isAssetParamValueItem, isAwaitingReadyMessage, isComponentActionMessage, isComponentPlaceholderId, isContextStorageUpdatedMessage, isDismissPlaceholderMessage, isEntryData, isLinkParamValue, isMovingComponentMessage, isNestedNodeType, isOpenParameterEditorMessage, isReadyMessage, isReportRenderedCompositionsMessage, isRequestComponentSuggestionMessage, isRootEntryReference, isSelectComponentMessage, isSelectParameterMessage, isSessionPendingMessage, isSuggestComponentMessage, isSystemComponentDefinition, isTriggerCompositionActionMessage, isUpdateAiActionsMessage, isUpdateComponentParameterMessage, isUpdateComponentReferencesMessage, isUpdateCompositionInternalMessage, isUpdateCompositionMessage, isUpdateContextualEditingStateInternalMessage, isUpdateFeatureFlagsMessage, isUpdatePreviewSettingsMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, matchesProjectionPattern, mergeAssetConfigWithDefaults, nullLimitPolicy, parseComponentPlaceholderId, parseVariableExpression, projectionToQuery, queryToProjection, systemComponentsMetadata, version, walkNodeTree, walkPropertyValues, wellKnownSystemComponentParameters, wellKnownSystemComponents };
|
|
16320
|
+
export { ASSETS_SOURCE_CUSTOM_URL, ASSETS_SOURCE_UNIFORM, ASSET_PARAMETER_TYPE, ATTRIBUTE_COMPONENT_ID, ATTRIBUTE_MULTILINE, ATTRIBUTE_PARAMETER_ID, ATTRIBUTE_PARAMETER_TYPE, ATTRIBUTE_PARAMETER_VALUE, ATTRIBUTE_PLACEHOLDER, type AddComponentMessage, type AiAction, type AssetParamConfig, type AwaitingReadyMessage, type BatchEnhancer, BatchEntry, type BatchInvalidationPayload, type BindVariablesOptions, type BindVariablesResult, type BindVariablesToObjectOptions, BlockFormatError, type BlockLocationReference, type BlockValue, CANVAS_BLOCK_PARAM_TYPE, CANVAS_COMPONENT_DISPLAY_NAME_PARAM, CANVAS_CONTEXTUAL_EDITING_PARAM, CANVAS_DRAFT_STATE, CANVAS_EDITOR_STATE, CANVAS_ENRICHMENT_TAG_PARAM, CANVAS_HYPOTHESIS_PARAM, CANVAS_INTENT_TAG_PARAM, CANVAS_INTERNAL_PARAM_PREFIX, CANVAS_LOCALE_TAG_PARAM, CANVAS_LOCALIZATION_SLOT, CANVAS_LOCALIZATION_TYPE, CANVAS_PERSONALIZATION_ALGORITHM_PARAM, CANVAS_PERSONALIZATION_ALGORITHM_TYPE, CANVAS_PERSONALIZATION_EVENT_NAME_PARAM, CANVAS_PERSONALIZATION_PARAM, CANVAS_PERSONALIZATION_TAKE_PARAM, CANVAS_PERSONALIZE_SLOT, CANVAS_PERSONALIZE_TYPE, CANVAS_PUBLISHED_STATE, CANVAS_SLOT_SECTION_GROUP_TYPE_PARAM, CANVAS_SLOT_SECTION_MAX_PARAM, CANVAS_SLOT_SECTION_MIN_PARAM, CANVAS_SLOT_SECTION_NAME_PARAM, CANVAS_SLOT_SECTION_SLOT, CANVAS_SLOT_SECTION_SPECIFIC_PARAM, CANVAS_SLOT_SECTION_TYPE, CANVAS_TEST_SLOT, CANVAS_TEST_TYPE, CANVAS_TEST_VARIANT_PARAM, CANVAS_VIZ_CONTROL_PARAM, CANVAS_VIZ_DI_RULE, CANVAS_VIZ_DYNAMIC_TOKEN_RULE, CANVAS_VIZ_LOCALE_RULE, CANVAS_VIZ_QUIRKS_RULE, CanvasClient, CanvasClientError, type CanvasDefinitions, type CategoriesDeleteParameters, type CategoriesGetParameters, type CategoriesGetResponse, type CategoriesPutParameters, type Category, CategoryClient, type Channel, type ChannelMessage, ChildEnhancerBuilder, type ComponentDefinition, ComponentDefinitionClient, type ComponentDefinitionDeleteParameters, type ComponentDefinitionGetParameters, type ComponentDefinitionGetResponse, type ComponentDefinitionParameter, type ComponentDefinitionPermission, type ComponentDefinitionPutParameters, type ComponentDefinitionSlot, type ComponentDefinitionSlugSettings, type ComponentDefinitionVariant, type ComponentEnhancer, type ComponentEnhancerFunction, type ComponentEnhancerOptions, type ComponentInstance, type ComponentInstanceContextualEditing, type ComponentInstanceHistoryEntry, type ComponentInstanceHistoryGetParameters, type ComponentInstanceHistoryGetResponse, type ComponentLocationReference, type ComponentOverridability, type ComponentOverride, type ComponentOverrides, type ComponentParameter, type ComponentParameterBlock, type ComponentParameterConditionalValue, type ComponentParameterContextualEditing, type ComponentParameterEnhancer, type ComponentParameterEnhancerFunction, type ComponentParameterEnhancerOptions, type CompositionDeleteParameters, CompositionDeliveryClient, type CompositionDeliveryListQuery, type CompositionDeliveryReadOptions, type CompositionDeliverySelector, type CompositionFilters, type CompositionGetByComponentIdParameters, type CompositionGetByIdParameters, type CompositionGetByNodeIdParameters, type CompositionGetByNodePathParameters, type CompositionGetBySlugParameters, type CompositionGetListResponse, type CompositionGetParameters, type CompositionGetResponse, type CompositionGetValidResponses, type CompositionListQuery, CompositionManagementClient, type CompositionManagementListQuery, type CompositionManagementReadOptions, type CompositionManagementSelector, type CompositionPutParameters, type CompositionReadOptions, type CompositionResolvedGetResponse, type CompositionResolvedListResponse, type CompositionUIStatus, type CompositionWriteSelector, ContentClient, type ContentType, ContentTypeClient, type ContentTypeField, type ContentTypePreviewConfiguration, type ContextStorageUpdatedMessage, type ContextualEditingComponentReference, type ContextualEditingValue, type CopiedComponentSubtree, type DataDiagnostic, type DataElementBindingIssue, type DataElementConnectionDefinition, type DataElementConnectionFailureAction, type DataElementConnectionFailureLogLevel, type DataResolutionConfigIssue, type DataResolutionIssue, type DataResolutionOption, type DataResolutionOptionNegative, type DataResolutionOptionPositive, type DataResolutionParameters, type DataResourceDefinition, type DataResourceDefinitions, type DataResourceIssue, type DataResourceVariables, type DataSource, DataSourceClient, type DataSourceDeleteParameters, type DataSourceGetParameters, type DataSourceGetResponse, type DataSourcePutParameters, type DataSourceVariantData, type DataSourceVariantsKeys, type DataSourcesGetParameters, type DataSourcesGetResponse, type DataType, DataTypeClient, type DataTypeDeleteParameters, type DataTypeGetParameters, type DataTypeGetResponse, type DataTypePutParameters, type DataVariableDefinition, type DataWithProperties, type DateParamConfig, type DateParamValue, type DatetimeParamConfig, type DeleteContentTypeOptions, type DeleteEntryOptions, type DismissPlaceholderMessage, type DynamicInputIssue, EDGE_CACHE_DISABLED, EDGE_DEFAULT_CACHE_TTL, EDGE_MAX_CACHE_TTL, EDGE_MIN_CACHE_TTL, EMPTY_COMPOSITION, type EdgehancersDiagnostics, type EdgehancersWholeResponseCacheDiagnostics, type EditorStateUpdatedMessage, EnhancerBuilder, type EnhancerContext, type EnhancerError, EntityReleasesClient, type EntityReleasesGetParameters, type EntityReleasesGetResponse, type EntriesGetParameters, type EntriesGetResponse, type EntriesHistoryGetParameters, type EntriesHistoryGetResponse, type EntriesResolvedListResponse, type Entry, type EntryData, EntryDeliveryClient, type EntryDeliveryListQuery, type EntryDeliveryReadOptions, type EntryFilters, type EntryList, type EntryListQuery, EntryManagementClient, type EntryManagementListQuery, type EntryManagementReadOptions, type EntryReadOptions, type EntrySelector, type EntryWriteSelector, type EvaluateCriteriaGroupOptions, type EvaluateNodeTreeVisibilityOptions, type EvaluateNodeVisibilityParameterOptions, type EvaluatePropertyCriteriaOptions, type EvaluateWalkTreePropertyCriteriaOptions, type FieldTypesProjection, type FieldsProjection, type Filters, type FindInNodeTreeReference, type FlattenProperty, type FlattenValues, type FlattenValuesOptions, type GetContentTypesOptions, type GetContentTypesResponse, type GetEffectivePropertyValueOptions, type GetEntriesOptions, type GetEntriesResponse, type GetParameterAttributesProps, IN_CONTEXT_EDITOR_COMPONENT_END_ROLE, IN_CONTEXT_EDITOR_COMPONENT_START_ROLE, IN_CONTEXT_EDITOR_CONFIG_CHECK_QUERY_STRING_PARAM, IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID, IN_CONTEXT_EDITOR_FORCED_SETTINGS_QUERY_STRING_PARAM, IN_CONTEXT_EDITOR_PLAYGROUND_QUERY_STRING_PARAM, IN_CONTEXT_EDITOR_QUERY_STRING_PARAM, IS_RENDERED_BY_UNIFORM_ATTRIBUTE, IntegrationPropertyEditorsClient, type IntegrationPropertyEditorsDeleteParameters, type IntegrationPropertyEditorsGetParameters, type IntegrationPropertyEditorsGetResponse, type paths$9 as IntegrationPropertyEditorsPaths, type IntegrationPropertyEditorsPutParameters, type InvalidationPayload, LOCALE_DYNAMIC_INPUT_NAME, type Label, LabelClient, type LabelDelete, type LabelPut, type LabelsQuery, type LabelsResponse, type LimitPolicy, type LinkParamConfiguration, type LinkParamValue, type LinkParameterType, type LinkTypeConfiguration, type ListEditions, type Locale, LocaleClient, type LocaleDeleteParameters, type LocalePutParameters, type LocalesGetParameters, type LocalesGetResponse, type LocalizeOptions, type ManagementEditionsOverride, type ManagementFormat, type MaxDepthExceededIssue, type MessageHandler, type MoveComponentMessage, type MultiSelectParamConfiguration, type MultiSelectParamEditorType, type MultiSelectParamValue, type NodeLocationReference, type NonProjectMapLinkParamValue, type NumberParamConfig, type NumberParamEditorType, type NumberParamValue, type OpenParameterEditorMessage, type OverrideOptions, PLACEHOLDER_ID, type ParamTypeConfigConventions, type PatternIssue, PreviewClient, type PreviewPanelSettings, type PreviewUrl, type PreviewUrlDeleteParameters, type PreviewUrlDeleteResponse, type PreviewUrlPutParameters, type PreviewUrlPutResponse, type PreviewUrlsGetParameters, type PreviewUrlsGetResponse, type PreviewViewport, type PreviewViewportDeleteParameters, type PreviewViewportDeleteResponse, type PreviewViewportPutParameters, type PreviewViewportPutResponse, type PreviewViewportsGetParameters, type PreviewViewportsGetResponse, type Project, ProjectClient, type ProjectDeleteParameters, type ProjectGetParameters, type ProjectGetResponse, type ProjectMapLinkParamValue, type ProjectPutParameters, type ProjectPutResponse, type Projection, type ProjectionSpec, type ProjectsGetParameters, type ProjectsGetProject, type ProjectsGetResponse, type ProjectsGetTeam, type Prompt, PromptClient, type PromptsDeleteParameters, type PromptsGetParameters, type PromptsGetResponse, type PromptsPutParameters, type PropertyCriteriaMatch, type PropertyValue, type PutContentTypeBody, type PutEntryBody, REFERENCE_DATA_TYPE_ID, type ReadyMessage, RelationshipClient, type RelationshipResultInstance, type Release, ReleaseClient, type ReleaseContent, ReleaseContentsClient, type ReleaseContentsDeleteBody, type ReleaseContentsGetParameters, type ReleaseContentsGetResponse, type ReleaseDeleteParameters, type ReleasePatchParameters, type ReleasePutParameters, type ReleaseState, type ReleasesGetParameters, type ReleasesGetResponse, type ReportRenderedCompositionsMessage, type RequestComponentSuggestionMessage, type RequestPageHtmlMessage, type ResolvedRouteGetResponse, type RichTextBuiltInElement, type RichTextBuiltInFormat, type RichTextParamConfiguration, type RichTextParamValue, type RootComponentInstance, type RootEntryReference, type RootLocationReference, RouteClient, type RouteDynamicInputs, type RouteGetParameters, type RouteGetResponse, type RouteGetResponseComposition, type RouteGetResponseEdgehancedComposition, type RouteGetResponseEdgehancedNotFound, type RouteGetResponseNotFound, type RouteGetResponseRedirect, SECRET_QUERY_STRING_PARAM, SELECT_QUERY_PREFIX, type SaveOptions, type SaveResult, type SelectComponentMessage, type SelectParamConfiguration, type SelectParamEditorType, type SelectParamOption, type SelectParamValue, type SelectParameterMessage, type SendPageHtmlMessage, type SerializedCustomView, type SessionPendingMessage, type SlotsProjection, type SpecificProjectMap, type StringOperators, type SuggestComponentMessage, type TextParamConfig, type TextParamValue, type TreeNodeInfoTypes, type TriggerComponentActionMessage, type TriggerCompositionActionMessage, UncachedCanvasClient, UncachedCategoryClient, UncachedContentClient, UncachedLabelClient, UniqueBatchEntries, type UpdateAiActionsMessage, type UpdateComponentParameterMessage, type UpdateComponentReferencesMessage, type UpdateCompositionInternalMessage, type UpdateCompositionMessage, type UpdateCompositionOptions, type UpdateContextualEditingStateInternalMessage, type UpdateFeatureFlagsMessage, type UpdatePreviewSettingsMessage, type UpsertEntryOptions, type View, type ViewDelete, type ViewPut, type ViewsQuery, type ViewsResponse, type VisibilityCriteria, type VisibilityCriteriaEvaluationResult, type VisibilityCriteriaGroup, type VisibilityParameterValue, type VisibilityRule, type VisibilityRules, type WalkNodeTreeActions, type WalkNodeTreeOptions, type WebhookDefinition, WorkflowClient, type WorkflowDefinition, type WorkflowStage, type WorkflowStagePermission, type WorkflowStageTransition, type WorkflowStageTransitionPermission, type WorkflowsDeleteParameters, type WorkflowsGetParameters, type WorkflowsGetResponse, type WorkflowsPutParameters, autoFixParameterGroups, bindExpressionEscapeChars, bindExpressionPrefix, bindVariables, bindVariablesToObject, compose, convertEntryToPutEntry, convertToBindExpression, createBatchEnhancer, createCanvasChannel, createDynamicInputVisibilityRule, createDynamicTokenVisibilityRule, createLimitPolicy, createLocaleVisibilityRule, createQuirksVisibilityRule, createUniformApiEnhancer, createVariableReference, enhance, escapeBindExpressionDefaultValue, evaluateNodeVisibilityParameter, evaluatePropertyCriteria, evaluateVisibilityCriteriaGroup, evaluateWalkTreeNodeVisibility, evaluateWalkTreePropertyCriteria, extractLocales, findParameterInNodeTree, flattenValues, generateComponentPlaceholderId, generateHash, getBlockValue, getComponentJsonPointer, getComponentPath, getDataSourceVariantFromRouteGetParams, getEffectivePropertyValue, getLocalizedPropertyValues, getNounForLocation, getNounForNode, getParameterAttributes, getPropertiesValue, hasReferencedVariables, isAddComponentMessage, isAllowedReferrer, isAssetParamValue, isAssetParamValueItem, isAwaitingReadyMessage, isComponentActionMessage, isComponentPlaceholderId, isContextStorageUpdatedMessage, isDismissPlaceholderMessage, isEntryData, isLinkParamValue, isMovingComponentMessage, isNestedNodeType, isOpenParameterEditorMessage, isReadyMessage, isReportRenderedCompositionsMessage, isRequestComponentSuggestionMessage, isRootEntryReference, isSelectComponentMessage, isSelectParameterMessage, isSessionPendingMessage, isSuggestComponentMessage, isSystemComponentDefinition, isTriggerCompositionActionMessage, isUpdateAiActionsMessage, isUpdateComponentParameterMessage, isUpdateComponentReferencesMessage, isUpdateCompositionInternalMessage, isUpdateCompositionMessage, isUpdateContextualEditingStateInternalMessage, isUpdateFeatureFlagsMessage, isUpdatePreviewSettingsMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, matchesProjectionPattern, mergeAssetConfigWithDefaults, nullLimitPolicy, parseComponentPlaceholderId, parseVariableExpression, projectionToQuery, queryToProjection, version, walkNodeTree, walkPropertyValues };
|