@uniformdev/canvas 20.86.1-alpha.3.sha-954b5d18f0 → 20.87.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.mts +969 -1095
- package/dist/index.d.ts +969 -1095
- 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.ts
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
|
|
@@ -4169,6 +4162,8 @@ interface components$n {
|
|
|
4169
4162
|
* Timestamp when the item was moved to trash. Omitted if not in trash.
|
|
4170
4163
|
*/
|
|
4171
4164
|
deletedAt?: string;
|
|
4165
|
+
/** 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. */
|
|
4166
|
+
publishedWhenTrashed?: boolean;
|
|
4172
4167
|
/**
|
|
4173
4168
|
* True if the entry is a pattern (which can be referenced on other entries)
|
|
4174
4169
|
* @defaultValue false
|
|
@@ -6107,301 +6102,17 @@ type LocalePutParameters = LocalesApi['put']['requestBody']['content']['applicat
|
|
|
6107
6102
|
type LocaleDeleteParameters = LocalesApi['delete']['requestBody']['content']['application/json'];
|
|
6108
6103
|
declare const LOCALE_DYNAMIC_INPUT_NAME = "locale";
|
|
6109
6104
|
|
|
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
6105
|
interface components$f {
|
|
6327
6106
|
schemas: {
|
|
6328
|
-
|
|
6329
|
-
/** Error message(s) that occurred while processing the request */
|
|
6330
|
-
errorMessage?: string[] | string;
|
|
6331
|
-
};
|
|
6332
|
-
};
|
|
6333
|
-
responses: {
|
|
6334
|
-
/** Request input validation failed */
|
|
6335
|
-
BadRequestError: {
|
|
6336
|
-
headers: {
|
|
6337
|
-
[name: string]: unknown;
|
|
6338
|
-
};
|
|
6339
|
-
content: {
|
|
6340
|
-
"application/json": components$f["schemas"]["Error"];
|
|
6341
|
-
};
|
|
6342
|
-
};
|
|
6343
|
-
/** API key or token was not valid */
|
|
6344
|
-
UnauthorizedError: {
|
|
6345
|
-
headers: {
|
|
6346
|
-
[name: string]: unknown;
|
|
6347
|
-
};
|
|
6348
|
-
content: {
|
|
6349
|
-
"application/json": components$f["schemas"]["Error"];
|
|
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"];
|
|
6107
|
+
RouteResponse: components$f["schemas"]["RouteResponseRedirect"] | components$f["schemas"]["RouteResponseComposition"] | components$f["schemas"]["RouteResponseNotFound"];
|
|
6397
6108
|
/** The route matches a redirection configured in Uniform */
|
|
6398
6109
|
RouteResponseRedirect: {
|
|
6399
6110
|
/** The route that was matched in the redirects */
|
|
6400
6111
|
matchedRoute: string;
|
|
6401
|
-
dynamicInputs?: components$
|
|
6112
|
+
dynamicInputs?: components$f["schemas"]["RouteDynamicInputs"];
|
|
6402
6113
|
/** @enum {string} */
|
|
6403
6114
|
type: "redirect";
|
|
6404
|
-
redirect: components$
|
|
6115
|
+
redirect: components$f["schemas"]["Redirect"];
|
|
6405
6116
|
};
|
|
6406
6117
|
/**
|
|
6407
6118
|
* The route matches a composition.
|
|
@@ -6410,7 +6121,7 @@ interface components$e {
|
|
|
6410
6121
|
RouteResponseComposition: {
|
|
6411
6122
|
/** The route that was matched in the project map */
|
|
6412
6123
|
matchedRoute: string;
|
|
6413
|
-
dynamicInputs?: components$
|
|
6124
|
+
dynamicInputs?: components$f["schemas"]["RouteDynamicInputs"];
|
|
6414
6125
|
/**
|
|
6415
6126
|
* Indicates the data variant that was fetched for data resources.
|
|
6416
6127
|
* undefined: Data resources were resolved using published data from their data source
|
|
@@ -6420,7 +6131,7 @@ interface components$e {
|
|
|
6420
6131
|
dataResourcesVariant?: "unpublished";
|
|
6421
6132
|
/** @enum {string} */
|
|
6422
6133
|
type: "composition";
|
|
6423
|
-
compositionApiResponse: components$
|
|
6134
|
+
compositionApiResponse: components$f["schemas"]["CompositionApiResponse"];
|
|
6424
6135
|
};
|
|
6425
6136
|
/**
|
|
6426
6137
|
* The route does not match any configured redirections or compositions.
|
|
@@ -6538,11 +6249,11 @@ interface components$e {
|
|
|
6538
6249
|
|
|
6539
6250
|
*/
|
|
6540
6251
|
op?: "&" | "|";
|
|
6541
|
-
clauses: (components$
|
|
6252
|
+
clauses: (components$f["schemas"]["VisibilityCriteria"] | components$f["schemas"]["VisibilityCriteriaGroup"])[];
|
|
6542
6253
|
};
|
|
6543
6254
|
/** Defines a conditional value for a component parameter */
|
|
6544
6255
|
ComponentParameterConditionalValue: {
|
|
6545
|
-
when: components$
|
|
6256
|
+
when: components$f["schemas"]["VisibilityCriteriaGroup"];
|
|
6546
6257
|
/**
|
|
6547
6258
|
* The value of the parameter. Any JSON-serializable value is acceptable.
|
|
6548
6259
|
* A value of `null` will cause the parameter value to be removed, if it matches.
|
|
@@ -6564,7 +6275,7 @@ interface components$e {
|
|
|
6564
6275
|
*
|
|
6565
6276
|
* When no locale is passed to a non-route API, conditions are not processed and all conditions are returned.
|
|
6566
6277
|
*/
|
|
6567
|
-
ComponentParameterConditions: components$
|
|
6278
|
+
ComponentParameterConditions: components$f["schemas"]["ComponentParameterConditionalValue"][];
|
|
6568
6279
|
/** Defines an editable parameter on a component */
|
|
6569
6280
|
ComponentParameter: {
|
|
6570
6281
|
/** The value of the parameter. Any JSON-serializable value is acceptable */
|
|
@@ -6572,7 +6283,7 @@ interface components$e {
|
|
|
6572
6283
|
/** The type of the parameter. Determines how it is displayed when editing and tells the consumer how to process it */
|
|
6573
6284
|
type: string;
|
|
6574
6285
|
/** @deprecated */
|
|
6575
|
-
connectedData?: components$
|
|
6286
|
+
connectedData?: components$f["schemas"]["DataElementConnectionDefinition"];
|
|
6576
6287
|
/**
|
|
6577
6288
|
* Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
|
|
6578
6289
|
* Note that locales must be registered on the entry/composition `_locales` before being used
|
|
@@ -6580,10 +6291,10 @@ interface components$e {
|
|
|
6580
6291
|
locales?: {
|
|
6581
6292
|
[key: string]: unknown;
|
|
6582
6293
|
};
|
|
6583
|
-
conditions?: components$
|
|
6294
|
+
conditions?: components$f["schemas"]["ComponentParameterConditions"];
|
|
6584
6295
|
/** Locale-specific conditional values for this parameter. Keys are locale codes, and values are the `conditions` for that locale. */
|
|
6585
6296
|
localesConditions?: {
|
|
6586
|
-
[key: string]: components$
|
|
6297
|
+
[key: string]: components$f["schemas"]["ComponentParameterConditions"];
|
|
6587
6298
|
};
|
|
6588
6299
|
};
|
|
6589
6300
|
ProjectMapNodeAllowedQueryString: {
|
|
@@ -6618,7 +6329,7 @@ interface components$e {
|
|
|
6618
6329
|
/** 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
6330
|
isSearchHit?: boolean;
|
|
6620
6331
|
/** Query strings that are allowed to be passed to the node */
|
|
6621
|
-
queryStrings?: components$
|
|
6332
|
+
queryStrings?: components$f["schemas"]["ProjectMapNodeAllowedQueryString"][];
|
|
6622
6333
|
/**
|
|
6623
6334
|
* For dynamic nodes, this is the preview value for the dynamic value.
|
|
6624
6335
|
* The preview value is used when editing a connected composition, and is the default
|
|
@@ -6643,7 +6354,7 @@ interface components$e {
|
|
|
6643
6354
|
* Unique identifier for the project map that this node belongs to
|
|
6644
6355
|
*/
|
|
6645
6356
|
projectMapId: string;
|
|
6646
|
-
data?: components$
|
|
6357
|
+
data?: components$f["schemas"]["ProjectMapNodeData"];
|
|
6647
6358
|
/**
|
|
6648
6359
|
* Locale-specific paths of the project map node.
|
|
6649
6360
|
* Keys are locale codes
|
|
@@ -6663,13 +6374,13 @@ interface components$e {
|
|
|
6663
6374
|
type: string;
|
|
6664
6375
|
/** Component parameter values for the component instance */
|
|
6665
6376
|
parameters?: {
|
|
6666
|
-
[key: string]: components$
|
|
6377
|
+
[key: string]: components$f["schemas"]["ComponentParameter"];
|
|
6667
6378
|
};
|
|
6668
6379
|
/** Public ID of alternate visual appearance for this component, if any selected */
|
|
6669
6380
|
variant?: string;
|
|
6670
6381
|
/** Slots containing any child components */
|
|
6671
6382
|
slots?: {
|
|
6672
|
-
[key: string]: components$
|
|
6383
|
+
[key: string]: components$f["schemas"]["ComponentInstance"][];
|
|
6673
6384
|
};
|
|
6674
6385
|
/**
|
|
6675
6386
|
* Unique identifier of the component within the composition.
|
|
@@ -6680,20 +6391,20 @@ interface components$e {
|
|
|
6680
6391
|
_id?: string;
|
|
6681
6392
|
/** Indicates this component instance should be sourced from a pattern library pattern */
|
|
6682
6393
|
_pattern?: string;
|
|
6683
|
-
_dataResources?: components$
|
|
6394
|
+
_dataResources?: components$f["schemas"]["DataResourceDefinitions"];
|
|
6684
6395
|
/**
|
|
6685
6396
|
* Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
|
6686
6397
|
* Means nothing for PUTs; it will be ignored
|
|
6687
6398
|
*/
|
|
6688
6399
|
_patternDataResources?: {
|
|
6689
|
-
[key: string]: components$
|
|
6400
|
+
[key: string]: components$f["schemas"]["DataResourceDefinition"];
|
|
6690
6401
|
};
|
|
6691
6402
|
/**
|
|
6692
6403
|
* Query-string opt-ins coming from a pattern resolved for this component.
|
|
6693
6404
|
* Means nothing for PUTs; it will be ignored
|
|
6694
6405
|
*/
|
|
6695
6406
|
_patternOptedInQueryStrings?: string[];
|
|
6696
|
-
_patternError?: components$
|
|
6407
|
+
_patternError?: components$f["schemas"]["PatternError"];
|
|
6697
6408
|
/**
|
|
6698
6409
|
* Defines patch overrides to component IDs that live in the composition.
|
|
6699
6410
|
* This can be used to override parameters that are defined on patterns,
|
|
@@ -6707,14 +6418,14 @@ interface components$e {
|
|
|
6707
6418
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
6708
6419
|
*/
|
|
6709
6420
|
_overrides?: {
|
|
6710
|
-
[key: string]: components$
|
|
6421
|
+
[key: string]: components$f["schemas"]["ComponentOverride"];
|
|
6711
6422
|
};
|
|
6712
6423
|
/**
|
|
6713
6424
|
* Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
|
|
6714
6425
|
* Means nothing for PUTs; it will be ignored
|
|
6715
6426
|
*/
|
|
6716
6427
|
_patternOverrides?: {
|
|
6717
|
-
[key: string]: components$
|
|
6428
|
+
[key: string]: components$f["schemas"]["ComponentOverride"];
|
|
6718
6429
|
};
|
|
6719
6430
|
/**
|
|
6720
6431
|
* When used on a pattern, defines how the pattern's parameters may be overridden
|
|
@@ -6723,7 +6434,7 @@ interface components$e {
|
|
|
6723
6434
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
6724
6435
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
6725
6436
|
*/
|
|
6726
|
-
_overridability?: components$
|
|
6437
|
+
_overridability?: components$f["schemas"]["ComponentOverridability"];
|
|
6727
6438
|
/** Array of locales that have data defined. Only set for pattern references or composition defaults */
|
|
6728
6439
|
_locales?: string[];
|
|
6729
6440
|
};
|
|
@@ -6748,14 +6459,14 @@ interface components$e {
|
|
|
6748
6459
|
* If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
|
|
6749
6460
|
*/
|
|
6750
6461
|
optionalPatternParameter?: boolean;
|
|
6751
|
-
variables?: components$
|
|
6462
|
+
variables?: components$f["schemas"]["DataResourceVariables"];
|
|
6752
6463
|
};
|
|
6753
6464
|
/**
|
|
6754
6465
|
* Data definitions attached to this component. The property name is the key of the data in the data document.
|
|
6755
6466
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key)
|
|
6756
6467
|
*/
|
|
6757
6468
|
DataResourceDefinitions: {
|
|
6758
|
-
[key: string]: components$
|
|
6469
|
+
[key: string]: components$f["schemas"]["DataResourceDefinition"];
|
|
6759
6470
|
};
|
|
6760
6471
|
/**
|
|
6761
6472
|
* Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
|
@@ -6773,10 +6484,10 @@ interface components$e {
|
|
|
6773
6484
|
*/
|
|
6774
6485
|
ComponentOverride: {
|
|
6775
6486
|
parameters?: {
|
|
6776
|
-
[key: string]: components$
|
|
6487
|
+
[key: string]: components$f["schemas"]["ComponentParameter"];
|
|
6777
6488
|
};
|
|
6778
6489
|
slots?: {
|
|
6779
|
-
[key: string]: components$
|
|
6490
|
+
[key: string]: components$f["schemas"]["ComponentInstance"][];
|
|
6780
6491
|
};
|
|
6781
6492
|
variant?: string;
|
|
6782
6493
|
/**
|
|
@@ -6785,7 +6496,7 @@ interface components$e {
|
|
|
6785
6496
|
* Overrides defined here replace values in either _dataResources or _patternDataResources on the target component.
|
|
6786
6497
|
*/
|
|
6787
6498
|
dataResources?: {
|
|
6788
|
-
[key: string]: components$
|
|
6499
|
+
[key: string]: components$f["schemas"]["DataResourceDefinition"];
|
|
6789
6500
|
};
|
|
6790
6501
|
};
|
|
6791
6502
|
/**
|
|
@@ -6806,7 +6517,7 @@ interface components$e {
|
|
|
6806
6517
|
ComponentOverridability: {
|
|
6807
6518
|
/** Defines component parameter value overrides. Keys are the parameter public ID */
|
|
6808
6519
|
parameters?: {
|
|
6809
|
-
[key: string]: components$
|
|
6520
|
+
[key: string]: components$f["schemas"]["OverrideOptions"];
|
|
6810
6521
|
};
|
|
6811
6522
|
/** Allows overriding a display variant is allowed if it is defined on the component the pattern is derived from. Default = false */
|
|
6812
6523
|
variants?: boolean;
|
|
@@ -6823,15 +6534,15 @@ interface components$e {
|
|
|
6823
6534
|
type: string;
|
|
6824
6535
|
/** Component parameter values for the component instance */
|
|
6825
6536
|
parameters?: {
|
|
6826
|
-
[key: string]: components$
|
|
6537
|
+
[key: string]: components$f["schemas"]["ComponentParameter"];
|
|
6827
6538
|
};
|
|
6828
6539
|
/** Public ID of alternate visual appearance for this component, if any selected */
|
|
6829
6540
|
variant?: string;
|
|
6830
6541
|
/** Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated */
|
|
6831
|
-
projectMapNodes?: components$
|
|
6542
|
+
projectMapNodes?: components$f["schemas"]["CompositionProjectMapNodeInfo"][];
|
|
6832
6543
|
/** Slots containing any child components */
|
|
6833
6544
|
slots?: {
|
|
6834
|
-
[key: string]: components$
|
|
6545
|
+
[key: string]: components$f["schemas"]["ComponentInstance"][];
|
|
6835
6546
|
};
|
|
6836
6547
|
/** The ID of the composition */
|
|
6837
6548
|
_id: string;
|
|
@@ -6854,15 +6565,15 @@ interface components$e {
|
|
|
6854
6565
|
* Means nothing for PUTs; it will be ignored
|
|
6855
6566
|
*/
|
|
6856
6567
|
_patternDataResources?: {
|
|
6857
|
-
[key: string]: components$
|
|
6568
|
+
[key: string]: components$f["schemas"]["DataResourceDefinition"];
|
|
6858
6569
|
};
|
|
6859
6570
|
/**
|
|
6860
6571
|
* Query-string opt-ins coming from a pattern resolved for this component.
|
|
6861
6572
|
* Means nothing for PUTs; it will be ignored
|
|
6862
6573
|
*/
|
|
6863
6574
|
_patternOptedInQueryStrings?: string[];
|
|
6864
|
-
_dataResources?: components$
|
|
6865
|
-
_patternError?: components$
|
|
6575
|
+
_dataResources?: components$f["schemas"]["DataResourceDefinitions"];
|
|
6576
|
+
_patternError?: components$f["schemas"]["PatternError"];
|
|
6866
6577
|
/**
|
|
6867
6578
|
* Defines patch overrides to component IDs that live in the composition.
|
|
6868
6579
|
* This can be used to override parameters that are defined on patterns,
|
|
@@ -6876,14 +6587,14 @@ interface components$e {
|
|
|
6876
6587
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
6877
6588
|
*/
|
|
6878
6589
|
_overrides?: {
|
|
6879
|
-
[key: string]: components$
|
|
6590
|
+
[key: string]: components$f["schemas"]["ComponentOverride"];
|
|
6880
6591
|
};
|
|
6881
6592
|
/**
|
|
6882
6593
|
* Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
|
|
6883
6594
|
* Means nothing for PUTs; it will be ignored
|
|
6884
6595
|
*/
|
|
6885
6596
|
_patternOverrides?: {
|
|
6886
|
-
[key: string]: components$
|
|
6597
|
+
[key: string]: components$f["schemas"]["ComponentOverride"];
|
|
6887
6598
|
};
|
|
6888
6599
|
/**
|
|
6889
6600
|
* When used on a pattern, defines how the pattern's parameters may be overridden
|
|
@@ -6892,7 +6603,7 @@ interface components$e {
|
|
|
6892
6603
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
6893
6604
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
6894
6605
|
*/
|
|
6895
|
-
_overridability?: components$
|
|
6606
|
+
_overridability?: components$f["schemas"]["ComponentOverridability"];
|
|
6896
6607
|
/** Array of locales which have data defined on the composition. If empty, the current default locale implicitly has data */
|
|
6897
6608
|
_locales?: string[];
|
|
6898
6609
|
/**
|
|
@@ -6931,7 +6642,7 @@ interface components$e {
|
|
|
6931
6642
|
* NOTE: Users without membership in any role listed here will be unable to execute the transition unless they are team admins
|
|
6932
6643
|
*/
|
|
6933
6644
|
permissions: {
|
|
6934
|
-
[key: string]: components$
|
|
6645
|
+
[key: string]: components$f["schemas"]["WorkflowStageTransitionPermission"];
|
|
6935
6646
|
};
|
|
6936
6647
|
};
|
|
6937
6648
|
/** Definition of a stage in a workflow */
|
|
@@ -6945,7 +6656,7 @@ interface components$e {
|
|
|
6945
6656
|
* listed here, the stage is read-only and publishing is disabled
|
|
6946
6657
|
*/
|
|
6947
6658
|
permissions: {
|
|
6948
|
-
[key: string]: components$
|
|
6659
|
+
[key: string]: components$f["schemas"]["WorkflowStagePermission"];
|
|
6949
6660
|
};
|
|
6950
6661
|
/**
|
|
6951
6662
|
* When true, transitioning into this stage from a different stage will automatically publish the entity.
|
|
@@ -6965,7 +6676,7 @@ interface components$e {
|
|
|
6965
6676
|
* Every stage must define at least one transition, to avoid creating a workflow that
|
|
6966
6677
|
* has a stage that can never be escaped
|
|
6967
6678
|
*/
|
|
6968
|
-
transitions: components$
|
|
6679
|
+
transitions: components$f["schemas"]["WorkflowStageTransition"][];
|
|
6969
6680
|
/**
|
|
6970
6681
|
* Icon name for the stage (e.g. 'chevron-double-right-o')
|
|
6971
6682
|
* @defaultValue chevron-double-right-o
|
|
@@ -6990,7 +6701,7 @@ interface components$e {
|
|
|
6990
6701
|
initialStage: string;
|
|
6991
6702
|
/** All stages of the workflow */
|
|
6992
6703
|
stages: {
|
|
6993
|
-
[key: string]: components$
|
|
6704
|
+
[key: string]: components$f["schemas"]["WorkflowStage"];
|
|
6994
6705
|
};
|
|
6995
6706
|
/** Last modified ISO date string for this definition (ignored for writes) */
|
|
6996
6707
|
modified?: string;
|
|
@@ -7038,6 +6749,8 @@ interface components$e {
|
|
|
7038
6749
|
* Timestamp when the item was moved to trash. Omitted if not in trash.
|
|
7039
6750
|
*/
|
|
7040
6751
|
deletedAt?: string;
|
|
6752
|
+
/** 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. */
|
|
6753
|
+
publishedWhenTrashed?: boolean;
|
|
7041
6754
|
/** User name of the creator of this composition */
|
|
7042
6755
|
creator?: string;
|
|
7043
6756
|
/** User name of the last editor of this composition */
|
|
@@ -7063,7 +6776,7 @@ interface components$e {
|
|
|
7063
6776
|
* The release this composition belongs to. If not set, it belongs to the base
|
|
7064
6777
|
*/
|
|
7065
6778
|
releaseId?: string;
|
|
7066
|
-
composition: components$
|
|
6779
|
+
composition: components$f["schemas"]["RootComponentInstance"];
|
|
7067
6780
|
/**
|
|
7068
6781
|
* Format: uuid
|
|
7069
6782
|
* The workflow ID assigned to this composition, if any. Normally comes from the component definition
|
|
@@ -7081,7 +6794,7 @@ interface components$e {
|
|
|
7081
6794
|
*/
|
|
7082
6795
|
instanceWorkflowId?: string;
|
|
7083
6796
|
/** The full definition of the assigned workflow, if any, including stages, permissions, etc. Returned only when `withWorkflowDefinition` is true */
|
|
7084
|
-
workflowDefinition?: components$
|
|
6797
|
+
workflowDefinition?: components$f["schemas"]["WorkflowDefinition"];
|
|
7085
6798
|
/**
|
|
7086
6799
|
* Format: uuid
|
|
7087
6800
|
* The edition ID. When set, this is a child edition of the composition in _id.
|
|
@@ -7192,7 +6905,7 @@ interface components$e {
|
|
|
7192
6905
|
pathItems: never;
|
|
7193
6906
|
}
|
|
7194
6907
|
|
|
7195
|
-
interface paths$
|
|
6908
|
+
interface paths$d {
|
|
7196
6909
|
"/api/v1/canvas": {
|
|
7197
6910
|
parameters: {
|
|
7198
6911
|
query?: never;
|
|
@@ -7314,56 +7027,56 @@ interface paths$c {
|
|
|
7314
7027
|
* This is a primary query parameter and cannot be used with any other primary query parameters.
|
|
7315
7028
|
* When `editions=raw`, this parameter matches on composition or edition IDs and edition resolution is disabled.
|
|
7316
7029
|
*/
|
|
7317
|
-
compositionId?: components$
|
|
7030
|
+
compositionId?: components$e["parameters"]["compositionId"];
|
|
7318
7031
|
/**
|
|
7319
7032
|
* Specify a single component ID to fetch the component's composition defaults. The response will be a single composition.
|
|
7320
7033
|
* This is a primary query parameter and cannot be used with any other primary query parameters
|
|
7321
7034
|
*/
|
|
7322
|
-
componentId?: components$
|
|
7035
|
+
componentId?: components$e["parameters"]["componentId"];
|
|
7323
7036
|
/**
|
|
7324
7037
|
* Specify a historical composition version ID to fetch (retrieved from the canvas-history API).
|
|
7325
7038
|
* Must be used with the `compositionId` parameter
|
|
7326
7039
|
*/
|
|
7327
|
-
versionId?: components$
|
|
7040
|
+
versionId?: components$e["parameters"]["versionId"];
|
|
7328
7041
|
/**
|
|
7329
7042
|
* Specify multiple composition IDs to fetch. The response type will be a list.
|
|
7330
7043
|
* This is a primary query parameter and cannot be used with any other primary query parameters.
|
|
7331
7044
|
* When `editions=raw`, this parameter matches on composition or edition IDs and edition resolution is disabled.
|
|
7332
7045
|
*/
|
|
7333
|
-
compositionIDs?: components$
|
|
7046
|
+
compositionIDs?: components$e["parameters"]["compositionIDs"];
|
|
7334
7047
|
/**
|
|
7335
7048
|
* Filters composition lists by the user who created them. The user is specified by their identity subject.
|
|
7336
7049
|
* This is a list query parameter and cannot be used with any primary query parameters
|
|
7337
7050
|
*/
|
|
7338
|
-
createdBy?: components$
|
|
7051
|
+
createdBy?: components$e["parameters"]["createdBy"];
|
|
7339
7052
|
/**
|
|
7340
7053
|
* Matches compositions where their name, slug, or definition name contains the specified keyword.
|
|
7341
7054
|
* NOT a full-text search; does not match composition contents.
|
|
7342
7055
|
* This is a list query parameter and cannot be used with any primary query parameters
|
|
7343
7056
|
*/
|
|
7344
|
-
keyword?: components$
|
|
7057
|
+
keyword?: components$e["parameters"]["keyword"];
|
|
7345
7058
|
/**
|
|
7346
7059
|
* Maximum number of records to return
|
|
7347
7060
|
* This is a list query parameter and cannot be used with any primary query parameters
|
|
7348
7061
|
*/
|
|
7349
|
-
limit?: components$
|
|
7062
|
+
limit?: components$e["parameters"]["limit"];
|
|
7350
7063
|
/**
|
|
7351
7064
|
* Number of records to skip
|
|
7352
7065
|
* This is a list query parameter and cannot be used with any primary query parameters
|
|
7353
7066
|
*/
|
|
7354
|
-
offset?: components$
|
|
7067
|
+
offset?: components$e["parameters"]["offset"];
|
|
7355
7068
|
/**
|
|
7356
7069
|
* Sets the sorting of the results. If unspecified, results are sorted by name ascending.
|
|
7357
7070
|
* Allowed values are: updated_at_DESC, updated_at_ASC, created_at_DESC, created_at_ASC,
|
|
7358
7071
|
* name_DESC, name_ASC, slug_DESC, slug_ASC.
|
|
7359
7072
|
* When using primary query parameters, this parameter is ignored
|
|
7360
7073
|
*/
|
|
7361
|
-
orderBy?: components$
|
|
7074
|
+
orderBy?: components$e["parameters"]["orderBy"];
|
|
7362
7075
|
/**
|
|
7363
7076
|
* @deprecated
|
|
7364
7077
|
* Returns counts for distinct values of the specified field or fields (provided as comma-separated IDs).
|
|
7365
7078
|
*/
|
|
7366
|
-
facetBy?: components$
|
|
7079
|
+
facetBy?: components$e["parameters"]["facetBy"];
|
|
7367
7080
|
/**
|
|
7368
7081
|
* Matches compositions based on whether they are a pattern composition or a regular composition.
|
|
7369
7082
|
* If true, only pattern compositions will be returned.
|
|
@@ -7371,44 +7084,44 @@ interface paths$c {
|
|
|
7371
7084
|
* If omitted or 'any', both pattern and regular compositions will be returned.
|
|
7372
7085
|
* This is a list query parameter and cannot be used with any primary query parameters
|
|
7373
7086
|
*/
|
|
7374
|
-
pattern?: components$
|
|
7087
|
+
pattern?: components$e["parameters"]["pattern"];
|
|
7375
7088
|
/**
|
|
7376
7089
|
* This specifies which type of patterns to return. This query parameter has no effect when `pattern` is false.
|
|
7377
7090
|
* * `all` - Returns all pattern instances
|
|
7378
7091
|
* * `component` - Returns only component patterns
|
|
7379
7092
|
* * `composition` - Returns only composition patterns
|
|
7380
7093
|
*/
|
|
7381
|
-
patternType?: components$
|
|
7094
|
+
patternType?: components$e["parameters"]["patternType"];
|
|
7382
7095
|
/**
|
|
7383
7096
|
* @deprecated
|
|
7384
7097
|
* Includes the `patternType` attribute in the response
|
|
7385
7098
|
*/
|
|
7386
|
-
withPatternType?: components$
|
|
7099
|
+
withPatternType?: components$e["parameters"]["withPatternType"];
|
|
7387
7100
|
/** The project the composition(s) belong to */
|
|
7388
|
-
projectId: components$
|
|
7101
|
+
projectId: components$e["parameters"]["projectId"];
|
|
7389
7102
|
/**
|
|
7390
7103
|
* Specify a project map ID to fetch by path or node ID from.
|
|
7391
7104
|
* If not specified, the default project map for the projectId is used.
|
|
7392
7105
|
* Only used when fetching by projectMapNodeId or projectMapNodePath
|
|
7393
7106
|
*/
|
|
7394
|
-
projectMapId?: components$
|
|
7107
|
+
projectMapId?: components$e["parameters"]["projectMapId"];
|
|
7395
7108
|
/**
|
|
7396
7109
|
* Specify a single composition to fetch by associated project map node ID. The response will be a single composition.
|
|
7397
7110
|
* This is a primary query parameter and cannot be used with any other primary query parameters
|
|
7398
7111
|
*/
|
|
7399
|
-
projectMapNodeId?: components$
|
|
7112
|
+
projectMapNodeId?: components$e["parameters"]["projectMapNodeId"];
|
|
7400
7113
|
/**
|
|
7401
7114
|
* Specify a single composition to fetch by associated project map node path. The response will be a single composition.
|
|
7402
7115
|
* This is a primary query parameter and cannot be used with any other primary query parameters
|
|
7403
7116
|
*/
|
|
7404
|
-
projectMapNodePath?: components$
|
|
7117
|
+
projectMapNodePath?: components$e["parameters"]["projectMapNodePath"];
|
|
7405
7118
|
/**
|
|
7406
7119
|
* @deprecated
|
|
7407
7120
|
* Signals an enhancer proxy to skip processing enhancements to the data and return raw data only.
|
|
7408
7121
|
* This improves performance if you do not require enhanced component data.
|
|
7409
7122
|
* If calling the Canvas API directly with no enhancer proxy, this has no effect
|
|
7410
7123
|
*/
|
|
7411
|
-
skipEnhance?: components$
|
|
7124
|
+
skipEnhance?: components$e["parameters"]["skipEnhance"];
|
|
7412
7125
|
/**
|
|
7413
7126
|
* If true, any pattern references in the composition will be left unresolved.
|
|
7414
7127
|
* This is appropriate if you intend to serialize the composition without patterns
|
|
@@ -7416,12 +7129,12 @@ interface paths$c {
|
|
|
7416
7129
|
* Default: true when `format` is canonical. False otherwise.
|
|
7417
7130
|
* Prefer selecting a `format` rather than using this option.
|
|
7418
7131
|
*/
|
|
7419
|
-
skipPatternResolution?: components$
|
|
7132
|
+
skipPatternResolution?: components$e["parameters"]["skipPatternResolution"];
|
|
7420
7133
|
/**
|
|
7421
7134
|
* @deprecated
|
|
7422
7135
|
* This parameter is unused and has no effect. Passing this parameter will become an error in the future
|
|
7423
7136
|
*/
|
|
7424
|
-
skipParameterResolution?: components$
|
|
7137
|
+
skipParameterResolution?: components$e["parameters"]["skipParameterResolution"];
|
|
7425
7138
|
/**
|
|
7426
7139
|
* If true, any pattern override data is not resolved by the API.
|
|
7427
7140
|
* This is intended for internal use in the Canvas editor and should not be used.
|
|
@@ -7429,69 +7142,69 @@ interface paths$c {
|
|
|
7429
7142
|
* Default: true when `format` is canonical or editor. False otherwise.
|
|
7430
7143
|
* Prefer selecting a `format` rather than using this option.
|
|
7431
7144
|
*/
|
|
7432
|
-
skipOverridesResolution?: components$
|
|
7145
|
+
skipOverridesResolution?: components$e["parameters"]["skipOverridesResolution"];
|
|
7433
7146
|
/**
|
|
7434
7147
|
* Specify a single composition to fetch by slug. The response will be a single composition.
|
|
7435
7148
|
* This is a primary query parameter and cannot be used with any other primary query parameters
|
|
7436
7149
|
*/
|
|
7437
|
-
slug?: components$
|
|
7150
|
+
slug?: components$e["parameters"]["slug"];
|
|
7438
7151
|
/** Filtration by category ID. An empty string can be used to include records without a category. */
|
|
7439
|
-
categories?: components$
|
|
7152
|
+
categories?: components$e["parameters"]["categories"];
|
|
7440
7153
|
/**
|
|
7441
7154
|
* Publishing state to fetch. 0 = draft, 64 = published.
|
|
7442
7155
|
* This is a list query parameter and cannot be used with any primary query parameters
|
|
7443
7156
|
*/
|
|
7444
|
-
state?: components$
|
|
7157
|
+
state?: components$e["parameters"]["state"];
|
|
7445
7158
|
/**
|
|
7446
7159
|
* 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
7160
|
* This is a list query parameter and cannot be used with any primary query parameters
|
|
7448
7161
|
*/
|
|
7449
|
-
type?: components$
|
|
7162
|
+
type?: components$e["parameters"]["type"];
|
|
7450
7163
|
/**
|
|
7451
7164
|
* @deprecated
|
|
7452
7165
|
* Filters composition lists by the UI status of the composition.
|
|
7453
7166
|
* This internal status is subject to change without notice and is thus marked deprecated to discourage use of internal data.
|
|
7454
7167
|
* This is a list query parameter and cannot be used with any primary query parameters
|
|
7455
7168
|
*/
|
|
7456
|
-
uiStatus?: components$
|
|
7169
|
+
uiStatus?: components$e["parameters"]["uiStatus"];
|
|
7457
7170
|
/**
|
|
7458
7171
|
* Filters out compositions without attached node or filters out compositions with attached nodes
|
|
7459
7172
|
* if set to false. If not specified, no filtration is applied.
|
|
7460
7173
|
* This is a list query parameter and cannot be used with any primary query parameters
|
|
7461
7174
|
*/
|
|
7462
|
-
attachedToProjectMap?: components$
|
|
7175
|
+
attachedToProjectMap?: components$e["parameters"]["attachedToProjectMap"];
|
|
7463
7176
|
/**
|
|
7464
7177
|
* Filters composition lists by the user who last updated them. The user is specified by their identity subject.
|
|
7465
7178
|
* This is a list query parameter and cannot be used with any primary query parameters
|
|
7466
7179
|
*/
|
|
7467
|
-
updatedBy?: components$
|
|
7180
|
+
updatedBy?: components$e["parameters"]["updatedBy"];
|
|
7468
7181
|
/**
|
|
7469
7182
|
* If true, the `_id` unique identifier of each non-root component will be part of the response data.
|
|
7470
7183
|
* If false, the `_id` will not be present in the API response.
|
|
7471
7184
|
* Note: the default value depends on the `format`: true for editor or canonical, false for delivery or when no format is specified.
|
|
7472
7185
|
* Prefer selecting a `format` rather than using this option.
|
|
7473
7186
|
*/
|
|
7474
|
-
withComponentIDs?: components$
|
|
7187
|
+
withComponentIDs?: components$e["parameters"]["withComponentIDs"];
|
|
7475
7188
|
/**
|
|
7476
7189
|
* Controls whether the total count of results will be returned along with the current results page in a list.
|
|
7477
7190
|
* Has no effect when not fetching a list. This does impact performance when enabled
|
|
7478
7191
|
*/
|
|
7479
|
-
withTotalCount?: components$
|
|
7192
|
+
withTotalCount?: components$e["parameters"]["withTotalCount"];
|
|
7480
7193
|
/**
|
|
7481
7194
|
* @deprecated
|
|
7482
7195
|
* Returns the UI status string of the composition.
|
|
7483
7196
|
* This internal status is subject to change without notice and is thus marked deprecated to discourage use of internal data
|
|
7484
7197
|
*/
|
|
7485
|
-
withUIStatus?: components$
|
|
7198
|
+
withUIStatus?: components$e["parameters"]["withUIStatus"];
|
|
7486
7199
|
/** Returns the definition of any attached workflow along with the composition data */
|
|
7487
|
-
withWorkflowDefinition?: components$
|
|
7200
|
+
withWorkflowDefinition?: components$e["parameters"]["withWorkflowDefinition"];
|
|
7488
7201
|
/** Includes project map node information in the composition results */
|
|
7489
|
-
withProjectMapNodes?: components$
|
|
7202
|
+
withProjectMapNodes?: components$e["parameters"]["withProjectMapNodes"];
|
|
7490
7203
|
/**
|
|
7491
7204
|
* @deprecated
|
|
7492
7205
|
* Has no effect.
|
|
7493
7206
|
*/
|
|
7494
|
-
withContentSourceMap?: components$
|
|
7207
|
+
withContentSourceMap?: components$e["parameters"]["withContentSourceMap"];
|
|
7495
7208
|
/**
|
|
7496
7209
|
* One or more locales to filter and localize by.
|
|
7497
7210
|
* 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 +7218,7 @@ interface paths$c {
|
|
|
7505
7218
|
* When this parameter is not passed, all locales' data will be returned.
|
|
7506
7219
|
* If a composition is requested by ID and does not possess any of the specified locales, HTTP 404 will be returned
|
|
7507
7220
|
*/
|
|
7508
|
-
locale?: components$
|
|
7221
|
+
locale?: components$e["parameters"]["locale"];
|
|
7509
7222
|
/**
|
|
7510
7223
|
* The ID of a release to fetch the content for.
|
|
7511
7224
|
*
|
|
@@ -7514,7 +7227,7 @@ interface paths$c {
|
|
|
7514
7227
|
*
|
|
7515
7228
|
* 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
7229
|
*/
|
|
7517
|
-
releaseId?: components$
|
|
7230
|
+
releaseId?: components$e["parameters"]["releaseId"];
|
|
7518
7231
|
/**
|
|
7519
7232
|
* Search on textual fields of a composition.
|
|
7520
7233
|
* Matches against fully rendered content including resolved pattern content.
|
|
@@ -7522,7 +7235,7 @@ interface paths$c {
|
|
|
7522
7235
|
* Note: For long text fields, the tail of the text is not guaranteed to be searchable.
|
|
7523
7236
|
* Example: ?search=hello
|
|
7524
7237
|
*/
|
|
7525
|
-
search?: components$
|
|
7238
|
+
search?: components$e["parameters"]["search"];
|
|
7526
7239
|
/**
|
|
7527
7240
|
* @deprecated
|
|
7528
7241
|
* BETA: Semantic search using vector similarity to find content by meaning.
|
|
@@ -7530,7 +7243,7 @@ interface paths$c {
|
|
|
7530
7243
|
* Use this for "where is this content defined" queries.
|
|
7531
7244
|
* Requires AI credits.
|
|
7532
7245
|
*/
|
|
7533
|
-
searchSemantic?: components$
|
|
7246
|
+
searchSemantic?: components$e["parameters"]["searchSemantic"];
|
|
7534
7247
|
/**
|
|
7535
7248
|
* Controls the edition resolution behavior.
|
|
7536
7249
|
*
|
|
@@ -7545,7 +7258,7 @@ interface paths$c {
|
|
|
7545
7258
|
* compositionId or compositionIDs MUST be provided with this option.
|
|
7546
7259
|
* If versionId is passed, this is always enabled.
|
|
7547
7260
|
*/
|
|
7548
|
-
editions?: components$
|
|
7261
|
+
editions?: components$e["parameters"]["editions"];
|
|
7549
7262
|
/**
|
|
7550
7263
|
* Specify a format you want the results in. Any explicit shaping flag (skipPatternResolution,
|
|
7551
7264
|
* skipOverridesResolution, withComponentIDs) overrides this alias.
|
|
@@ -7558,7 +7271,7 @@ interface paths$c {
|
|
|
7558
7271
|
* - `delivery`: default structure for serving to a frontend — patterns and overrides resolved
|
|
7559
7272
|
* and component `_id`s removed.
|
|
7560
7273
|
*/
|
|
7561
|
-
format?: components$
|
|
7274
|
+
format?: components$e["parameters"]["format"];
|
|
7562
7275
|
/**
|
|
7563
7276
|
* Controls filtering of trashed items.
|
|
7564
7277
|
*
|
|
@@ -7566,7 +7279,7 @@ interface paths$c {
|
|
|
7566
7279
|
* only: Only return trashed items (for trash view).
|
|
7567
7280
|
* include: Return both trashed and non-trashed items.
|
|
7568
7281
|
*/
|
|
7569
|
-
deleted?: components$
|
|
7282
|
+
deleted?: components$e["parameters"]["deleted"];
|
|
7570
7283
|
};
|
|
7571
7284
|
header?: never;
|
|
7572
7285
|
path?: never;
|
|
@@ -7580,12 +7293,12 @@ interface paths$c {
|
|
|
7580
7293
|
[name: string]: unknown;
|
|
7581
7294
|
};
|
|
7582
7295
|
content: {
|
|
7583
|
-
"application/json": components$
|
|
7296
|
+
"application/json": components$e["schemas"]["CompositionListResponse"] | components$e["schemas"]["CompositionApiResponse"];
|
|
7584
7297
|
};
|
|
7585
7298
|
};
|
|
7586
|
-
400: components$
|
|
7587
|
-
401: components$
|
|
7588
|
-
403: components$
|
|
7299
|
+
400: components$e["responses"]["BadRequestError"];
|
|
7300
|
+
401: components$e["responses"]["UnauthorizedError"];
|
|
7301
|
+
403: components$e["responses"]["ForbiddenError"];
|
|
7589
7302
|
/** Composition not found */
|
|
7590
7303
|
404: {
|
|
7591
7304
|
headers: {
|
|
@@ -7595,8 +7308,8 @@ interface paths$c {
|
|
|
7595
7308
|
"text/plain": string;
|
|
7596
7309
|
};
|
|
7597
7310
|
};
|
|
7598
|
-
429: components$
|
|
7599
|
-
500: components$
|
|
7311
|
+
429: components$e["responses"]["RateLimitError"];
|
|
7312
|
+
500: components$e["responses"]["InternalServerError"];
|
|
7600
7313
|
};
|
|
7601
7314
|
};
|
|
7602
7315
|
/** Upserts a composition */
|
|
@@ -7624,7 +7337,7 @@ interface paths$c {
|
|
|
7624
7337
|
projectId: string;
|
|
7625
7338
|
/** The publishing state to upsert into. 0 = draft, 64 = published */
|
|
7626
7339
|
state: number;
|
|
7627
|
-
composition: components$
|
|
7340
|
+
composition: components$e["schemas"]["RootComponentInstance"];
|
|
7628
7341
|
/**
|
|
7629
7342
|
* Indicates if the composition is a pattern that can be referenced in other compositions
|
|
7630
7343
|
* @defaultValue false
|
|
@@ -7700,9 +7413,9 @@ interface paths$c {
|
|
|
7700
7413
|
};
|
|
7701
7414
|
content?: never;
|
|
7702
7415
|
};
|
|
7703
|
-
400: components$
|
|
7704
|
-
401: components$
|
|
7705
|
-
403: components$
|
|
7416
|
+
400: components$e["responses"]["BadRequestError"];
|
|
7417
|
+
401: components$e["responses"]["UnauthorizedError"];
|
|
7418
|
+
403: components$e["responses"]["ForbiddenError"];
|
|
7706
7419
|
/** Conflict - Composition has been changed since being loaded */
|
|
7707
7420
|
409: {
|
|
7708
7421
|
headers: {
|
|
@@ -7712,8 +7425,8 @@ interface paths$c {
|
|
|
7712
7425
|
"text/plain": string;
|
|
7713
7426
|
};
|
|
7714
7427
|
};
|
|
7715
|
-
429: components$
|
|
7716
|
-
500: components$
|
|
7428
|
+
429: components$e["responses"]["RateLimitError"];
|
|
7429
|
+
500: components$e["responses"]["InternalServerError"];
|
|
7717
7430
|
};
|
|
7718
7431
|
};
|
|
7719
7432
|
post?: never;
|
|
@@ -7766,11 +7479,11 @@ interface paths$c {
|
|
|
7766
7479
|
};
|
|
7767
7480
|
content?: never;
|
|
7768
7481
|
};
|
|
7769
|
-
400: components$
|
|
7770
|
-
401: components$
|
|
7771
|
-
403: components$
|
|
7772
|
-
429: components$
|
|
7773
|
-
500: components$
|
|
7482
|
+
400: components$e["responses"]["BadRequestError"];
|
|
7483
|
+
401: components$e["responses"]["UnauthorizedError"];
|
|
7484
|
+
403: components$e["responses"]["ForbiddenError"];
|
|
7485
|
+
429: components$e["responses"]["RateLimitError"];
|
|
7486
|
+
500: components$e["responses"]["InternalServerError"];
|
|
7774
7487
|
};
|
|
7775
7488
|
};
|
|
7776
7489
|
/** Handles preflight requests. This endpoint allows CORS */
|
|
@@ -7797,7 +7510,7 @@ interface paths$c {
|
|
|
7797
7510
|
trace?: never;
|
|
7798
7511
|
};
|
|
7799
7512
|
}
|
|
7800
|
-
interface components$
|
|
7513
|
+
interface components$e {
|
|
7801
7514
|
schemas: {
|
|
7802
7515
|
CompositionApiResponse: {
|
|
7803
7516
|
/** Publishing state to fetch. 0 = draft, 64 = published */
|
|
@@ -7828,6 +7541,8 @@ interface components$d {
|
|
|
7828
7541
|
* Timestamp when the item was moved to trash. Omitted if not in trash.
|
|
7829
7542
|
*/
|
|
7830
7543
|
deletedAt?: string;
|
|
7544
|
+
/** 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. */
|
|
7545
|
+
publishedWhenTrashed?: boolean;
|
|
7831
7546
|
/** User name of the creator of this composition */
|
|
7832
7547
|
creator?: string;
|
|
7833
7548
|
/** User name of the last editor of this composition */
|
|
@@ -7853,7 +7568,7 @@ interface components$d {
|
|
|
7853
7568
|
* The release this composition belongs to. If not set, it belongs to the base
|
|
7854
7569
|
*/
|
|
7855
7570
|
releaseId?: string;
|
|
7856
|
-
composition: components$
|
|
7571
|
+
composition: components$e["schemas"]["RootComponentInstance"];
|
|
7857
7572
|
/**
|
|
7858
7573
|
* Format: uuid
|
|
7859
7574
|
* The workflow ID assigned to this composition, if any. Normally comes from the component definition
|
|
@@ -7871,7 +7586,7 @@ interface components$d {
|
|
|
7871
7586
|
*/
|
|
7872
7587
|
instanceWorkflowId?: string;
|
|
7873
7588
|
/** The full definition of the assigned workflow, if any, including stages, permissions, etc. Returned only when `withWorkflowDefinition` is true */
|
|
7874
|
-
workflowDefinition?: components$
|
|
7589
|
+
workflowDefinition?: components$e["schemas"]["WorkflowDefinition"];
|
|
7875
7590
|
/**
|
|
7876
7591
|
* Format: uuid
|
|
7877
7592
|
* The edition ID. When set, this is a child edition of the composition in _id.
|
|
@@ -7889,7 +7604,7 @@ interface components$d {
|
|
|
7889
7604
|
editionPriority?: number;
|
|
7890
7605
|
};
|
|
7891
7606
|
CompositionListResponse: {
|
|
7892
|
-
compositions: components$
|
|
7607
|
+
compositions: components$e["schemas"]["CompositionApiResponse"][];
|
|
7893
7608
|
/** Total number of compositions that match the query. Present only when `withTotalCount` option is true */
|
|
7894
7609
|
totalCount?: number;
|
|
7895
7610
|
/** Per-field counts for distinct values */
|
|
@@ -7963,11 +7678,11 @@ interface components$d {
|
|
|
7963
7678
|
|
|
7964
7679
|
*/
|
|
7965
7680
|
op?: "&" | "|";
|
|
7966
|
-
clauses: (components$
|
|
7681
|
+
clauses: (components$e["schemas"]["VisibilityCriteria"] | components$e["schemas"]["VisibilityCriteriaGroup"])[];
|
|
7967
7682
|
};
|
|
7968
7683
|
/** Defines a conditional value for a component parameter */
|
|
7969
7684
|
ComponentParameterConditionalValue: {
|
|
7970
|
-
when: components$
|
|
7685
|
+
when: components$e["schemas"]["VisibilityCriteriaGroup"];
|
|
7971
7686
|
/**
|
|
7972
7687
|
* The value of the parameter. Any JSON-serializable value is acceptable.
|
|
7973
7688
|
* A value of `null` will cause the parameter value to be removed, if it matches.
|
|
@@ -7989,7 +7704,7 @@ interface components$d {
|
|
|
7989
7704
|
*
|
|
7990
7705
|
* When no locale is passed to a non-route API, conditions are not processed and all conditions are returned.
|
|
7991
7706
|
*/
|
|
7992
|
-
ComponentParameterConditions: components$
|
|
7707
|
+
ComponentParameterConditions: components$e["schemas"]["ComponentParameterConditionalValue"][];
|
|
7993
7708
|
/** Defines an editable parameter on a component */
|
|
7994
7709
|
ComponentParameter: {
|
|
7995
7710
|
/** The value of the parameter. Any JSON-serializable value is acceptable */
|
|
@@ -7997,7 +7712,7 @@ interface components$d {
|
|
|
7997
7712
|
/** The type of the parameter. Determines how it is displayed when editing and tells the consumer how to process it */
|
|
7998
7713
|
type: string;
|
|
7999
7714
|
/** @deprecated */
|
|
8000
|
-
connectedData?: components$
|
|
7715
|
+
connectedData?: components$e["schemas"]["DataElementConnectionDefinition"];
|
|
8001
7716
|
/**
|
|
8002
7717
|
* Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
|
|
8003
7718
|
* Note that locales must be registered on the entry/composition `_locales` before being used
|
|
@@ -8005,10 +7720,10 @@ interface components$d {
|
|
|
8005
7720
|
locales?: {
|
|
8006
7721
|
[key: string]: unknown;
|
|
8007
7722
|
};
|
|
8008
|
-
conditions?: components$
|
|
7723
|
+
conditions?: components$e["schemas"]["ComponentParameterConditions"];
|
|
8009
7724
|
/** Locale-specific conditional values for this parameter. Keys are locale codes, and values are the `conditions` for that locale. */
|
|
8010
7725
|
localesConditions?: {
|
|
8011
|
-
[key: string]: components$
|
|
7726
|
+
[key: string]: components$e["schemas"]["ComponentParameterConditions"];
|
|
8012
7727
|
};
|
|
8013
7728
|
};
|
|
8014
7729
|
ProjectMapNodeAllowedQueryString: {
|
|
@@ -8043,7 +7758,7 @@ interface components$d {
|
|
|
8043
7758
|
/** 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
7759
|
isSearchHit?: boolean;
|
|
8045
7760
|
/** Query strings that are allowed to be passed to the node */
|
|
8046
|
-
queryStrings?: components$
|
|
7761
|
+
queryStrings?: components$e["schemas"]["ProjectMapNodeAllowedQueryString"][];
|
|
8047
7762
|
/**
|
|
8048
7763
|
* For dynamic nodes, this is the preview value for the dynamic value.
|
|
8049
7764
|
* The preview value is used when editing a connected composition, and is the default
|
|
@@ -8068,7 +7783,7 @@ interface components$d {
|
|
|
8068
7783
|
* Unique identifier for the project map that this node belongs to
|
|
8069
7784
|
*/
|
|
8070
7785
|
projectMapId: string;
|
|
8071
|
-
data?: components$
|
|
7786
|
+
data?: components$e["schemas"]["ProjectMapNodeData"];
|
|
8072
7787
|
/**
|
|
8073
7788
|
* Locale-specific paths of the project map node.
|
|
8074
7789
|
* Keys are locale codes
|
|
@@ -8088,13 +7803,13 @@ interface components$d {
|
|
|
8088
7803
|
type: string;
|
|
8089
7804
|
/** Component parameter values for the component instance */
|
|
8090
7805
|
parameters?: {
|
|
8091
|
-
[key: string]: components$
|
|
7806
|
+
[key: string]: components$e["schemas"]["ComponentParameter"];
|
|
8092
7807
|
};
|
|
8093
7808
|
/** Public ID of alternate visual appearance for this component, if any selected */
|
|
8094
7809
|
variant?: string;
|
|
8095
7810
|
/** Slots containing any child components */
|
|
8096
7811
|
slots?: {
|
|
8097
|
-
[key: string]: components$
|
|
7812
|
+
[key: string]: components$e["schemas"]["ComponentInstance"][];
|
|
8098
7813
|
};
|
|
8099
7814
|
/**
|
|
8100
7815
|
* Unique identifier of the component within the composition.
|
|
@@ -8105,20 +7820,20 @@ interface components$d {
|
|
|
8105
7820
|
_id?: string;
|
|
8106
7821
|
/** Indicates this component instance should be sourced from a pattern library pattern */
|
|
8107
7822
|
_pattern?: string;
|
|
8108
|
-
_dataResources?: components$
|
|
7823
|
+
_dataResources?: components$e["schemas"]["DataResourceDefinitions"];
|
|
8109
7824
|
/**
|
|
8110
7825
|
* Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
|
8111
7826
|
* Means nothing for PUTs; it will be ignored
|
|
8112
7827
|
*/
|
|
8113
7828
|
_patternDataResources?: {
|
|
8114
|
-
[key: string]: components$
|
|
7829
|
+
[key: string]: components$e["schemas"]["DataResourceDefinition"];
|
|
8115
7830
|
};
|
|
8116
7831
|
/**
|
|
8117
7832
|
* Query-string opt-ins coming from a pattern resolved for this component.
|
|
8118
7833
|
* Means nothing for PUTs; it will be ignored
|
|
8119
7834
|
*/
|
|
8120
7835
|
_patternOptedInQueryStrings?: string[];
|
|
8121
|
-
_patternError?: components$
|
|
7836
|
+
_patternError?: components$e["schemas"]["PatternError"];
|
|
8122
7837
|
/**
|
|
8123
7838
|
* Defines patch overrides to component IDs that live in the composition.
|
|
8124
7839
|
* This can be used to override parameters that are defined on patterns,
|
|
@@ -8132,14 +7847,14 @@ interface components$d {
|
|
|
8132
7847
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
8133
7848
|
*/
|
|
8134
7849
|
_overrides?: {
|
|
8135
|
-
[key: string]: components$
|
|
7850
|
+
[key: string]: components$e["schemas"]["ComponentOverride"];
|
|
8136
7851
|
};
|
|
8137
7852
|
/**
|
|
8138
7853
|
* Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
|
|
8139
7854
|
* Means nothing for PUTs; it will be ignored
|
|
8140
7855
|
*/
|
|
8141
7856
|
_patternOverrides?: {
|
|
8142
|
-
[key: string]: components$
|
|
7857
|
+
[key: string]: components$e["schemas"]["ComponentOverride"];
|
|
8143
7858
|
};
|
|
8144
7859
|
/**
|
|
8145
7860
|
* When used on a pattern, defines how the pattern's parameters may be overridden
|
|
@@ -8148,7 +7863,7 @@ interface components$d {
|
|
|
8148
7863
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
8149
7864
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
8150
7865
|
*/
|
|
8151
|
-
_overridability?: components$
|
|
7866
|
+
_overridability?: components$e["schemas"]["ComponentOverridability"];
|
|
8152
7867
|
/** Array of locales that have data defined. Only set for pattern references or composition defaults */
|
|
8153
7868
|
_locales?: string[];
|
|
8154
7869
|
};
|
|
@@ -8173,14 +7888,14 @@ interface components$d {
|
|
|
8173
7888
|
* If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
|
|
8174
7889
|
*/
|
|
8175
7890
|
optionalPatternParameter?: boolean;
|
|
8176
|
-
variables?: components$
|
|
7891
|
+
variables?: components$e["schemas"]["DataResourceVariables"];
|
|
8177
7892
|
};
|
|
8178
7893
|
/**
|
|
8179
7894
|
* Data definitions attached to this component. The property name is the key of the data in the data document.
|
|
8180
7895
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key)
|
|
8181
7896
|
*/
|
|
8182
7897
|
DataResourceDefinitions: {
|
|
8183
|
-
[key: string]: components$
|
|
7898
|
+
[key: string]: components$e["schemas"]["DataResourceDefinition"];
|
|
8184
7899
|
};
|
|
8185
7900
|
/**
|
|
8186
7901
|
* Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
|
@@ -8198,10 +7913,10 @@ interface components$d {
|
|
|
8198
7913
|
*/
|
|
8199
7914
|
ComponentOverride: {
|
|
8200
7915
|
parameters?: {
|
|
8201
|
-
[key: string]: components$
|
|
7916
|
+
[key: string]: components$e["schemas"]["ComponentParameter"];
|
|
8202
7917
|
};
|
|
8203
7918
|
slots?: {
|
|
8204
|
-
[key: string]: components$
|
|
7919
|
+
[key: string]: components$e["schemas"]["ComponentInstance"][];
|
|
8205
7920
|
};
|
|
8206
7921
|
variant?: string;
|
|
8207
7922
|
/**
|
|
@@ -8210,7 +7925,7 @@ interface components$d {
|
|
|
8210
7925
|
* Overrides defined here replace values in either _dataResources or _patternDataResources on the target component.
|
|
8211
7926
|
*/
|
|
8212
7927
|
dataResources?: {
|
|
8213
|
-
[key: string]: components$
|
|
7928
|
+
[key: string]: components$e["schemas"]["DataResourceDefinition"];
|
|
8214
7929
|
};
|
|
8215
7930
|
};
|
|
8216
7931
|
/**
|
|
@@ -8231,7 +7946,7 @@ interface components$d {
|
|
|
8231
7946
|
ComponentOverridability: {
|
|
8232
7947
|
/** Defines component parameter value overrides. Keys are the parameter public ID */
|
|
8233
7948
|
parameters?: {
|
|
8234
|
-
[key: string]: components$
|
|
7949
|
+
[key: string]: components$e["schemas"]["OverrideOptions"];
|
|
8235
7950
|
};
|
|
8236
7951
|
/** Allows overriding a display variant is allowed if it is defined on the component the pattern is derived from. Default = false */
|
|
8237
7952
|
variants?: boolean;
|
|
@@ -8248,15 +7963,15 @@ interface components$d {
|
|
|
8248
7963
|
type: string;
|
|
8249
7964
|
/** Component parameter values for the component instance */
|
|
8250
7965
|
parameters?: {
|
|
8251
|
-
[key: string]: components$
|
|
7966
|
+
[key: string]: components$e["schemas"]["ComponentParameter"];
|
|
8252
7967
|
};
|
|
8253
7968
|
/** Public ID of alternate visual appearance for this component, if any selected */
|
|
8254
7969
|
variant?: string;
|
|
8255
7970
|
/** Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated */
|
|
8256
|
-
projectMapNodes?: components$
|
|
7971
|
+
projectMapNodes?: components$e["schemas"]["CompositionProjectMapNodeInfo"][];
|
|
8257
7972
|
/** Slots containing any child components */
|
|
8258
7973
|
slots?: {
|
|
8259
|
-
[key: string]: components$
|
|
7974
|
+
[key: string]: components$e["schemas"]["ComponentInstance"][];
|
|
8260
7975
|
};
|
|
8261
7976
|
/** The ID of the composition */
|
|
8262
7977
|
_id: string;
|
|
@@ -8279,15 +7994,15 @@ interface components$d {
|
|
|
8279
7994
|
* Means nothing for PUTs; it will be ignored
|
|
8280
7995
|
*/
|
|
8281
7996
|
_patternDataResources?: {
|
|
8282
|
-
[key: string]: components$
|
|
7997
|
+
[key: string]: components$e["schemas"]["DataResourceDefinition"];
|
|
8283
7998
|
};
|
|
8284
7999
|
/**
|
|
8285
8000
|
* Query-string opt-ins coming from a pattern resolved for this component.
|
|
8286
8001
|
* Means nothing for PUTs; it will be ignored
|
|
8287
8002
|
*/
|
|
8288
8003
|
_patternOptedInQueryStrings?: string[];
|
|
8289
|
-
_dataResources?: components$
|
|
8290
|
-
_patternError?: components$
|
|
8004
|
+
_dataResources?: components$e["schemas"]["DataResourceDefinitions"];
|
|
8005
|
+
_patternError?: components$e["schemas"]["PatternError"];
|
|
8291
8006
|
/**
|
|
8292
8007
|
* Defines patch overrides to component IDs that live in the composition.
|
|
8293
8008
|
* This can be used to override parameters that are defined on patterns,
|
|
@@ -8301,14 +8016,14 @@ interface components$d {
|
|
|
8301
8016
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
8302
8017
|
*/
|
|
8303
8018
|
_overrides?: {
|
|
8304
|
-
[key: string]: components$
|
|
8019
|
+
[key: string]: components$e["schemas"]["ComponentOverride"];
|
|
8305
8020
|
};
|
|
8306
8021
|
/**
|
|
8307
8022
|
* Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
|
|
8308
8023
|
* Means nothing for PUTs; it will be ignored
|
|
8309
8024
|
*/
|
|
8310
8025
|
_patternOverrides?: {
|
|
8311
|
-
[key: string]: components$
|
|
8026
|
+
[key: string]: components$e["schemas"]["ComponentOverride"];
|
|
8312
8027
|
};
|
|
8313
8028
|
/**
|
|
8314
8029
|
* When used on a pattern, defines how the pattern's parameters may be overridden
|
|
@@ -8317,7 +8032,7 @@ interface components$d {
|
|
|
8317
8032
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
8318
8033
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
8319
8034
|
*/
|
|
8320
|
-
_overridability?: components$
|
|
8035
|
+
_overridability?: components$e["schemas"]["ComponentOverridability"];
|
|
8321
8036
|
/** Array of locales which have data defined on the composition. If empty, the current default locale implicitly has data */
|
|
8322
8037
|
_locales?: string[];
|
|
8323
8038
|
/**
|
|
@@ -8356,7 +8071,7 @@ interface components$d {
|
|
|
8356
8071
|
* NOTE: Users without membership in any role listed here will be unable to execute the transition unless they are team admins
|
|
8357
8072
|
*/
|
|
8358
8073
|
permissions: {
|
|
8359
|
-
[key: string]: components$
|
|
8074
|
+
[key: string]: components$e["schemas"]["WorkflowStageTransitionPermission"];
|
|
8360
8075
|
};
|
|
8361
8076
|
};
|
|
8362
8077
|
/** Definition of a stage in a workflow */
|
|
@@ -8370,7 +8085,7 @@ interface components$d {
|
|
|
8370
8085
|
* listed here, the stage is read-only and publishing is disabled
|
|
8371
8086
|
*/
|
|
8372
8087
|
permissions: {
|
|
8373
|
-
[key: string]: components$
|
|
8088
|
+
[key: string]: components$e["schemas"]["WorkflowStagePermission"];
|
|
8374
8089
|
};
|
|
8375
8090
|
/**
|
|
8376
8091
|
* When true, transitioning into this stage from a different stage will automatically publish the entity.
|
|
@@ -8390,7 +8105,7 @@ interface components$d {
|
|
|
8390
8105
|
* Every stage must define at least one transition, to avoid creating a workflow that
|
|
8391
8106
|
* has a stage that can never be escaped
|
|
8392
8107
|
*/
|
|
8393
|
-
transitions: components$
|
|
8108
|
+
transitions: components$e["schemas"]["WorkflowStageTransition"][];
|
|
8394
8109
|
/**
|
|
8395
8110
|
* Icon name for the stage (e.g. 'chevron-double-right-o')
|
|
8396
8111
|
* @defaultValue chevron-double-right-o
|
|
@@ -8415,7 +8130,7 @@ interface components$d {
|
|
|
8415
8130
|
initialStage: string;
|
|
8416
8131
|
/** All stages of the workflow */
|
|
8417
8132
|
stages: {
|
|
8418
|
-
[key: string]: components$
|
|
8133
|
+
[key: string]: components$e["schemas"]["WorkflowStage"];
|
|
8419
8134
|
};
|
|
8420
8135
|
/** Last modified ISO date string for this definition (ignored for writes) */
|
|
8421
8136
|
modified?: string;
|
|
@@ -8446,7 +8161,7 @@ interface components$d {
|
|
|
8446
8161
|
[name: string]: unknown;
|
|
8447
8162
|
};
|
|
8448
8163
|
content: {
|
|
8449
|
-
"application/json": components$
|
|
8164
|
+
"application/json": components$e["schemas"]["Error"];
|
|
8450
8165
|
};
|
|
8451
8166
|
};
|
|
8452
8167
|
/** API key or token was not valid */
|
|
@@ -8455,7 +8170,7 @@ interface components$d {
|
|
|
8455
8170
|
[name: string]: unknown;
|
|
8456
8171
|
};
|
|
8457
8172
|
content: {
|
|
8458
|
-
"application/json": components$
|
|
8173
|
+
"application/json": components$e["schemas"]["Error"];
|
|
8459
8174
|
};
|
|
8460
8175
|
};
|
|
8461
8176
|
/** Permission was denied */
|
|
@@ -8464,7 +8179,7 @@ interface components$d {
|
|
|
8464
8179
|
[name: string]: unknown;
|
|
8465
8180
|
};
|
|
8466
8181
|
content: {
|
|
8467
|
-
"application/json": components$
|
|
8182
|
+
"application/json": components$e["schemas"]["Error"];
|
|
8468
8183
|
};
|
|
8469
8184
|
};
|
|
8470
8185
|
/** Too many requests in allowed time period */
|
|
@@ -8747,7 +8462,7 @@ interface components$d {
|
|
|
8747
8462
|
pathItems: never;
|
|
8748
8463
|
}
|
|
8749
8464
|
|
|
8750
|
-
interface paths$
|
|
8465
|
+
interface paths$c {
|
|
8751
8466
|
"/api/v1/canvas-history": {
|
|
8752
8467
|
parameters: {
|
|
8753
8468
|
query?: never;
|
|
@@ -8781,12 +8496,12 @@ interface paths$b {
|
|
|
8781
8496
|
[name: string]: unknown;
|
|
8782
8497
|
};
|
|
8783
8498
|
content: {
|
|
8784
|
-
"application/json": components$
|
|
8499
|
+
"application/json": components$d["schemas"]["HistoryApiResponse"];
|
|
8785
8500
|
};
|
|
8786
8501
|
};
|
|
8787
|
-
400: components$
|
|
8788
|
-
401: components$
|
|
8789
|
-
403: components$
|
|
8502
|
+
400: components$d["responses"]["BadRequestError"];
|
|
8503
|
+
401: components$d["responses"]["UnauthorizedError"];
|
|
8504
|
+
403: components$d["responses"]["ForbiddenError"];
|
|
8790
8505
|
/** Composition not found */
|
|
8791
8506
|
404: {
|
|
8792
8507
|
headers: {
|
|
@@ -8796,8 +8511,8 @@ interface paths$b {
|
|
|
8796
8511
|
"text/plain": string;
|
|
8797
8512
|
};
|
|
8798
8513
|
};
|
|
8799
|
-
429: components$
|
|
8800
|
-
500: components$
|
|
8514
|
+
429: components$d["responses"]["RateLimitError"];
|
|
8515
|
+
500: components$d["responses"]["InternalServerError"];
|
|
8801
8516
|
};
|
|
8802
8517
|
};
|
|
8803
8518
|
put?: never;
|
|
@@ -8809,7 +8524,7 @@ interface paths$b {
|
|
|
8809
8524
|
trace?: never;
|
|
8810
8525
|
};
|
|
8811
8526
|
}
|
|
8812
|
-
interface components$
|
|
8527
|
+
interface components$d {
|
|
8813
8528
|
schemas: {
|
|
8814
8529
|
HistoryEntry: {
|
|
8815
8530
|
/** The version ID of the entity. This can be used to fetch the version's data via the entity API */
|
|
@@ -8833,7 +8548,7 @@ interface components$c {
|
|
|
8833
8548
|
/** If more history is available than your plan allows, and additional entries are available by upgrading, this will be true */
|
|
8834
8549
|
truncated?: boolean;
|
|
8835
8550
|
/** Version history entries */
|
|
8836
|
-
results?: components$
|
|
8551
|
+
results?: components$d["schemas"]["HistoryEntry"][];
|
|
8837
8552
|
};
|
|
8838
8553
|
Error: {
|
|
8839
8554
|
/** Error message(s) that occurred while processing the request */
|
|
@@ -8847,7 +8562,7 @@ interface components$c {
|
|
|
8847
8562
|
[name: string]: unknown;
|
|
8848
8563
|
};
|
|
8849
8564
|
content: {
|
|
8850
|
-
"application/json": components$
|
|
8565
|
+
"application/json": components$d["schemas"]["Error"];
|
|
8851
8566
|
};
|
|
8852
8567
|
};
|
|
8853
8568
|
/** API key or token was not valid */
|
|
@@ -8856,7 +8571,7 @@ interface components$c {
|
|
|
8856
8571
|
[name: string]: unknown;
|
|
8857
8572
|
};
|
|
8858
8573
|
content: {
|
|
8859
|
-
"application/json": components$
|
|
8574
|
+
"application/json": components$d["schemas"]["Error"];
|
|
8860
8575
|
};
|
|
8861
8576
|
};
|
|
8862
8577
|
/** Permission was denied */
|
|
@@ -8865,7 +8580,7 @@ interface components$c {
|
|
|
8865
8580
|
[name: string]: unknown;
|
|
8866
8581
|
};
|
|
8867
8582
|
content: {
|
|
8868
|
-
"application/json": components$
|
|
8583
|
+
"application/json": components$d["schemas"]["Error"];
|
|
8869
8584
|
};
|
|
8870
8585
|
};
|
|
8871
8586
|
/** Too many requests in allowed time period */
|
|
@@ -8889,41 +8604,41 @@ interface components$c {
|
|
|
8889
8604
|
pathItems: never;
|
|
8890
8605
|
}
|
|
8891
8606
|
|
|
8892
|
-
interface components$
|
|
8607
|
+
interface components$c {
|
|
8893
8608
|
schemas: {
|
|
8894
|
-
CompositionResolvedGetResponse: components$
|
|
8609
|
+
CompositionResolvedGetResponse: components$c["schemas"]["EdgehancersResolutionInfo"] & components$c["schemas"]["CompositionApiResponse"];
|
|
8895
8610
|
CompositionResolvedListResponse: {
|
|
8896
|
-
diagnostics?: components$
|
|
8611
|
+
diagnostics?: components$c["schemas"]["EdgehancersDiagnostics"] & {
|
|
8897
8612
|
data?: {
|
|
8898
|
-
[key: string]: components$
|
|
8613
|
+
[key: string]: components$c["schemas"]["DataDiagnostic"][];
|
|
8899
8614
|
};
|
|
8900
8615
|
};
|
|
8901
8616
|
errors?: {
|
|
8902
|
-
[key: string]: components$
|
|
8617
|
+
[key: string]: components$c["schemas"]["DataResolutionIssue"][];
|
|
8903
8618
|
};
|
|
8904
8619
|
warnings?: {
|
|
8905
|
-
[key: string]: components$
|
|
8620
|
+
[key: string]: components$c["schemas"]["DataResolutionIssue"][];
|
|
8906
8621
|
};
|
|
8907
8622
|
infos?: {
|
|
8908
|
-
[key: string]: components$
|
|
8623
|
+
[key: string]: components$c["schemas"]["DataResolutionIssue"][];
|
|
8909
8624
|
};
|
|
8910
|
-
} & components$
|
|
8625
|
+
} & components$c["schemas"]["CompositionListResponse"];
|
|
8911
8626
|
EntryResolvedListResponse: {
|
|
8912
|
-
diagnostics?: components$
|
|
8627
|
+
diagnostics?: components$c["schemas"]["EdgehancersDiagnostics"] & {
|
|
8913
8628
|
data?: {
|
|
8914
|
-
[key: string]: components$
|
|
8629
|
+
[key: string]: components$c["schemas"]["DataDiagnostic"][];
|
|
8915
8630
|
};
|
|
8916
8631
|
};
|
|
8917
8632
|
errors?: {
|
|
8918
|
-
[key: string]: components$
|
|
8633
|
+
[key: string]: components$c["schemas"]["DataResolutionIssue"][];
|
|
8919
8634
|
};
|
|
8920
8635
|
warnings?: {
|
|
8921
|
-
[key: string]: components$
|
|
8636
|
+
[key: string]: components$c["schemas"]["DataResolutionIssue"][];
|
|
8922
8637
|
};
|
|
8923
8638
|
infos?: {
|
|
8924
|
-
[key: string]: components$
|
|
8639
|
+
[key: string]: components$c["schemas"]["DataResolutionIssue"][];
|
|
8925
8640
|
};
|
|
8926
|
-
} & components$
|
|
8641
|
+
} & components$c["schemas"]["EntryListResponse"];
|
|
8927
8642
|
EdgehancersResolutionInfo: {
|
|
8928
8643
|
wholeResponseCacheDiagnostics?: {
|
|
8929
8644
|
info: string;
|
|
@@ -8932,19 +8647,19 @@ interface components$b {
|
|
|
8932
8647
|
edgeLocation?: string;
|
|
8933
8648
|
requestId: string;
|
|
8934
8649
|
};
|
|
8935
|
-
diagnostics?: components$
|
|
8936
|
-
data?: components$
|
|
8650
|
+
diagnostics?: components$c["schemas"]["EdgehancersDiagnostics"] & {
|
|
8651
|
+
data?: components$c["schemas"]["DataDiagnostic"][];
|
|
8937
8652
|
};
|
|
8938
|
-
errors?: components$
|
|
8939
|
-
warnings?: components$
|
|
8940
|
-
infos?: components$
|
|
8653
|
+
errors?: components$c["schemas"]["DataResolutionIssue"][];
|
|
8654
|
+
warnings?: components$c["schemas"]["DataResolutionIssue"][];
|
|
8655
|
+
infos?: components$c["schemas"]["DataResolutionIssue"][];
|
|
8941
8656
|
};
|
|
8942
8657
|
EdgehancersError: {
|
|
8943
8658
|
message: string;
|
|
8944
8659
|
status: number;
|
|
8945
8660
|
statusText: string;
|
|
8946
8661
|
};
|
|
8947
|
-
UniformError: components$
|
|
8662
|
+
UniformError: components$c["schemas"]["EdgehancersError"] | components$c["schemas"]["Error"];
|
|
8948
8663
|
InvalidationPayload: {
|
|
8949
8664
|
/** List of variables with values to invalidate */
|
|
8950
8665
|
variables?: {
|
|
@@ -8958,7 +8673,7 @@ interface components$b {
|
|
|
8958
8673
|
dataTypeId: string;
|
|
8959
8674
|
/** Format: uuid */
|
|
8960
8675
|
purgeKey: string;
|
|
8961
|
-
conditions?: components$
|
|
8676
|
+
conditions?: components$c["schemas"]["InvalidationPayload"];
|
|
8962
8677
|
}[];
|
|
8963
8678
|
DataDiagnostic: {
|
|
8964
8679
|
componentPath: string;
|
|
@@ -9018,7 +8733,7 @@ interface components$b {
|
|
|
9018
8733
|
message: string;
|
|
9019
8734
|
type: string;
|
|
9020
8735
|
parameterName?: string;
|
|
9021
|
-
expression?: components$
|
|
8736
|
+
expression?: components$c["schemas"]["DataElementConnectionDefinition"];
|
|
9022
8737
|
dataName?: string;
|
|
9023
8738
|
dataType?: string;
|
|
9024
8739
|
inputName?: string;
|
|
@@ -9093,11 +8808,11 @@ interface components$b {
|
|
|
9093
8808
|
|
|
9094
8809
|
*/
|
|
9095
8810
|
op?: "&" | "|";
|
|
9096
|
-
clauses: (components$
|
|
8811
|
+
clauses: (components$c["schemas"]["VisibilityCriteria"] | components$c["schemas"]["VisibilityCriteriaGroup"])[];
|
|
9097
8812
|
};
|
|
9098
8813
|
/** Defines a conditional value for a component parameter */
|
|
9099
8814
|
ComponentParameterConditionalValue: {
|
|
9100
|
-
when: components$
|
|
8815
|
+
when: components$c["schemas"]["VisibilityCriteriaGroup"];
|
|
9101
8816
|
/**
|
|
9102
8817
|
* The value of the parameter. Any JSON-serializable value is acceptable.
|
|
9103
8818
|
* A value of `null` will cause the parameter value to be removed, if it matches.
|
|
@@ -9119,7 +8834,7 @@ interface components$b {
|
|
|
9119
8834
|
*
|
|
9120
8835
|
* When no locale is passed to a non-route API, conditions are not processed and all conditions are returned.
|
|
9121
8836
|
*/
|
|
9122
|
-
ComponentParameterConditions: components$
|
|
8837
|
+
ComponentParameterConditions: components$c["schemas"]["ComponentParameterConditionalValue"][];
|
|
9123
8838
|
/** Defines an editable parameter on a component */
|
|
9124
8839
|
ComponentParameter: {
|
|
9125
8840
|
/** The value of the parameter. Any JSON-serializable value is acceptable */
|
|
@@ -9127,7 +8842,7 @@ interface components$b {
|
|
|
9127
8842
|
/** The type of the parameter. Determines how it is displayed when editing and tells the consumer how to process it */
|
|
9128
8843
|
type: string;
|
|
9129
8844
|
/** @deprecated */
|
|
9130
|
-
connectedData?: components$
|
|
8845
|
+
connectedData?: components$c["schemas"]["DataElementConnectionDefinition"];
|
|
9131
8846
|
/**
|
|
9132
8847
|
* Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
|
|
9133
8848
|
* Note that locales must be registered on the entry/composition `_locales` before being used
|
|
@@ -9135,10 +8850,10 @@ interface components$b {
|
|
|
9135
8850
|
locales?: {
|
|
9136
8851
|
[key: string]: unknown;
|
|
9137
8852
|
};
|
|
9138
|
-
conditions?: components$
|
|
8853
|
+
conditions?: components$c["schemas"]["ComponentParameterConditions"];
|
|
9139
8854
|
/** Locale-specific conditional values for this parameter. Keys are locale codes, and values are the `conditions` for that locale. */
|
|
9140
8855
|
localesConditions?: {
|
|
9141
|
-
[key: string]: components$
|
|
8856
|
+
[key: string]: components$c["schemas"]["ComponentParameterConditions"];
|
|
9142
8857
|
};
|
|
9143
8858
|
};
|
|
9144
8859
|
ProjectMapNodeAllowedQueryString: {
|
|
@@ -9173,7 +8888,7 @@ interface components$b {
|
|
|
9173
8888
|
/** 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
8889
|
isSearchHit?: boolean;
|
|
9175
8890
|
/** Query strings that are allowed to be passed to the node */
|
|
9176
|
-
queryStrings?: components$
|
|
8891
|
+
queryStrings?: components$c["schemas"]["ProjectMapNodeAllowedQueryString"][];
|
|
9177
8892
|
/**
|
|
9178
8893
|
* For dynamic nodes, this is the preview value for the dynamic value.
|
|
9179
8894
|
* The preview value is used when editing a connected composition, and is the default
|
|
@@ -9198,7 +8913,7 @@ interface components$b {
|
|
|
9198
8913
|
* Unique identifier for the project map that this node belongs to
|
|
9199
8914
|
*/
|
|
9200
8915
|
projectMapId: string;
|
|
9201
|
-
data?: components$
|
|
8916
|
+
data?: components$c["schemas"]["ProjectMapNodeData"];
|
|
9202
8917
|
/**
|
|
9203
8918
|
* Locale-specific paths of the project map node.
|
|
9204
8919
|
* Keys are locale codes
|
|
@@ -9218,13 +8933,13 @@ interface components$b {
|
|
|
9218
8933
|
type: string;
|
|
9219
8934
|
/** Component parameter values for the component instance */
|
|
9220
8935
|
parameters?: {
|
|
9221
|
-
[key: string]: components$
|
|
8936
|
+
[key: string]: components$c["schemas"]["ComponentParameter"];
|
|
9222
8937
|
};
|
|
9223
8938
|
/** Public ID of alternate visual appearance for this component, if any selected */
|
|
9224
8939
|
variant?: string;
|
|
9225
8940
|
/** Slots containing any child components */
|
|
9226
8941
|
slots?: {
|
|
9227
|
-
[key: string]: components$
|
|
8942
|
+
[key: string]: components$c["schemas"]["ComponentInstance"][];
|
|
9228
8943
|
};
|
|
9229
8944
|
/**
|
|
9230
8945
|
* Unique identifier of the component within the composition.
|
|
@@ -9235,20 +8950,20 @@ interface components$b {
|
|
|
9235
8950
|
_id?: string;
|
|
9236
8951
|
/** Indicates this component instance should be sourced from a pattern library pattern */
|
|
9237
8952
|
_pattern?: string;
|
|
9238
|
-
_dataResources?: components$
|
|
8953
|
+
_dataResources?: components$c["schemas"]["DataResourceDefinitions"];
|
|
9239
8954
|
/**
|
|
9240
8955
|
* Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
|
9241
8956
|
* Means nothing for PUTs; it will be ignored
|
|
9242
8957
|
*/
|
|
9243
8958
|
_patternDataResources?: {
|
|
9244
|
-
[key: string]: components$
|
|
8959
|
+
[key: string]: components$c["schemas"]["DataResourceDefinition"];
|
|
9245
8960
|
};
|
|
9246
8961
|
/**
|
|
9247
8962
|
* Query-string opt-ins coming from a pattern resolved for this component.
|
|
9248
8963
|
* Means nothing for PUTs; it will be ignored
|
|
9249
8964
|
*/
|
|
9250
8965
|
_patternOptedInQueryStrings?: string[];
|
|
9251
|
-
_patternError?: components$
|
|
8966
|
+
_patternError?: components$c["schemas"]["PatternError"];
|
|
9252
8967
|
/**
|
|
9253
8968
|
* Defines patch overrides to component IDs that live in the composition.
|
|
9254
8969
|
* This can be used to override parameters that are defined on patterns,
|
|
@@ -9262,14 +8977,14 @@ interface components$b {
|
|
|
9262
8977
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
9263
8978
|
*/
|
|
9264
8979
|
_overrides?: {
|
|
9265
|
-
[key: string]: components$
|
|
8980
|
+
[key: string]: components$c["schemas"]["ComponentOverride"];
|
|
9266
8981
|
};
|
|
9267
8982
|
/**
|
|
9268
8983
|
* Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
|
|
9269
8984
|
* Means nothing for PUTs; it will be ignored
|
|
9270
8985
|
*/
|
|
9271
8986
|
_patternOverrides?: {
|
|
9272
|
-
[key: string]: components$
|
|
8987
|
+
[key: string]: components$c["schemas"]["ComponentOverride"];
|
|
9273
8988
|
};
|
|
9274
8989
|
/**
|
|
9275
8990
|
* When used on a pattern, defines how the pattern's parameters may be overridden
|
|
@@ -9278,7 +8993,7 @@ interface components$b {
|
|
|
9278
8993
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
9279
8994
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
9280
8995
|
*/
|
|
9281
|
-
_overridability?: components$
|
|
8996
|
+
_overridability?: components$c["schemas"]["ComponentOverridability"];
|
|
9282
8997
|
/** Array of locales that have data defined. Only set for pattern references or composition defaults */
|
|
9283
8998
|
_locales?: string[];
|
|
9284
8999
|
};
|
|
@@ -9303,14 +9018,14 @@ interface components$b {
|
|
|
9303
9018
|
* If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
|
|
9304
9019
|
*/
|
|
9305
9020
|
optionalPatternParameter?: boolean;
|
|
9306
|
-
variables?: components$
|
|
9021
|
+
variables?: components$c["schemas"]["DataResourceVariables"];
|
|
9307
9022
|
};
|
|
9308
9023
|
/**
|
|
9309
9024
|
* Data definitions attached to this component. The property name is the key of the data in the data document.
|
|
9310
9025
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key)
|
|
9311
9026
|
*/
|
|
9312
9027
|
DataResourceDefinitions: {
|
|
9313
|
-
[key: string]: components$
|
|
9028
|
+
[key: string]: components$c["schemas"]["DataResourceDefinition"];
|
|
9314
9029
|
};
|
|
9315
9030
|
/**
|
|
9316
9031
|
* Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
|
@@ -9328,10 +9043,10 @@ interface components$b {
|
|
|
9328
9043
|
*/
|
|
9329
9044
|
ComponentOverride: {
|
|
9330
9045
|
parameters?: {
|
|
9331
|
-
[key: string]: components$
|
|
9046
|
+
[key: string]: components$c["schemas"]["ComponentParameter"];
|
|
9332
9047
|
};
|
|
9333
9048
|
slots?: {
|
|
9334
|
-
[key: string]: components$
|
|
9049
|
+
[key: string]: components$c["schemas"]["ComponentInstance"][];
|
|
9335
9050
|
};
|
|
9336
9051
|
variant?: string;
|
|
9337
9052
|
/**
|
|
@@ -9340,7 +9055,7 @@ interface components$b {
|
|
|
9340
9055
|
* Overrides defined here replace values in either _dataResources or _patternDataResources on the target component.
|
|
9341
9056
|
*/
|
|
9342
9057
|
dataResources?: {
|
|
9343
|
-
[key: string]: components$
|
|
9058
|
+
[key: string]: components$c["schemas"]["DataResourceDefinition"];
|
|
9344
9059
|
};
|
|
9345
9060
|
};
|
|
9346
9061
|
/**
|
|
@@ -9361,7 +9076,7 @@ interface components$b {
|
|
|
9361
9076
|
ComponentOverridability: {
|
|
9362
9077
|
/** Defines component parameter value overrides. Keys are the parameter public ID */
|
|
9363
9078
|
parameters?: {
|
|
9364
|
-
[key: string]: components$
|
|
9079
|
+
[key: string]: components$c["schemas"]["OverrideOptions"];
|
|
9365
9080
|
};
|
|
9366
9081
|
/** Allows overriding a display variant is allowed if it is defined on the component the pattern is derived from. Default = false */
|
|
9367
9082
|
variants?: boolean;
|
|
@@ -9378,15 +9093,15 @@ interface components$b {
|
|
|
9378
9093
|
type: string;
|
|
9379
9094
|
/** Component parameter values for the component instance */
|
|
9380
9095
|
parameters?: {
|
|
9381
|
-
[key: string]: components$
|
|
9096
|
+
[key: string]: components$c["schemas"]["ComponentParameter"];
|
|
9382
9097
|
};
|
|
9383
9098
|
/** Public ID of alternate visual appearance for this component, if any selected */
|
|
9384
9099
|
variant?: string;
|
|
9385
9100
|
/** Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated */
|
|
9386
|
-
projectMapNodes?: components$
|
|
9101
|
+
projectMapNodes?: components$c["schemas"]["CompositionProjectMapNodeInfo"][];
|
|
9387
9102
|
/** Slots containing any child components */
|
|
9388
9103
|
slots?: {
|
|
9389
|
-
[key: string]: components$
|
|
9104
|
+
[key: string]: components$c["schemas"]["ComponentInstance"][];
|
|
9390
9105
|
};
|
|
9391
9106
|
/** The ID of the composition */
|
|
9392
9107
|
_id: string;
|
|
@@ -9409,15 +9124,15 @@ interface components$b {
|
|
|
9409
9124
|
* Means nothing for PUTs; it will be ignored
|
|
9410
9125
|
*/
|
|
9411
9126
|
_patternDataResources?: {
|
|
9412
|
-
[key: string]: components$
|
|
9127
|
+
[key: string]: components$c["schemas"]["DataResourceDefinition"];
|
|
9413
9128
|
};
|
|
9414
9129
|
/**
|
|
9415
9130
|
* Query-string opt-ins coming from a pattern resolved for this component.
|
|
9416
9131
|
* Means nothing for PUTs; it will be ignored
|
|
9417
9132
|
*/
|
|
9418
9133
|
_patternOptedInQueryStrings?: string[];
|
|
9419
|
-
_dataResources?: components$
|
|
9420
|
-
_patternError?: components$
|
|
9134
|
+
_dataResources?: components$c["schemas"]["DataResourceDefinitions"];
|
|
9135
|
+
_patternError?: components$c["schemas"]["PatternError"];
|
|
9421
9136
|
/**
|
|
9422
9137
|
* Defines patch overrides to component IDs that live in the composition.
|
|
9423
9138
|
* This can be used to override parameters that are defined on patterns,
|
|
@@ -9431,14 +9146,14 @@ interface components$b {
|
|
|
9431
9146
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
9432
9147
|
*/
|
|
9433
9148
|
_overrides?: {
|
|
9434
|
-
[key: string]: components$
|
|
9149
|
+
[key: string]: components$c["schemas"]["ComponentOverride"];
|
|
9435
9150
|
};
|
|
9436
9151
|
/**
|
|
9437
9152
|
* Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
|
|
9438
9153
|
* Means nothing for PUTs; it will be ignored
|
|
9439
9154
|
*/
|
|
9440
9155
|
_patternOverrides?: {
|
|
9441
|
-
[key: string]: components$
|
|
9156
|
+
[key: string]: components$c["schemas"]["ComponentOverride"];
|
|
9442
9157
|
};
|
|
9443
9158
|
/**
|
|
9444
9159
|
* When used on a pattern, defines how the pattern's parameters may be overridden
|
|
@@ -9447,7 +9162,7 @@ interface components$b {
|
|
|
9447
9162
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
9448
9163
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
9449
9164
|
*/
|
|
9450
|
-
_overridability?: components$
|
|
9165
|
+
_overridability?: components$c["schemas"]["ComponentOverridability"];
|
|
9451
9166
|
/** Array of locales which have data defined on the composition. If empty, the current default locale implicitly has data */
|
|
9452
9167
|
_locales?: string[];
|
|
9453
9168
|
/**
|
|
@@ -9486,7 +9201,7 @@ interface components$b {
|
|
|
9486
9201
|
* NOTE: Users without membership in any role listed here will be unable to execute the transition unless they are team admins
|
|
9487
9202
|
*/
|
|
9488
9203
|
permissions: {
|
|
9489
|
-
[key: string]: components$
|
|
9204
|
+
[key: string]: components$c["schemas"]["WorkflowStageTransitionPermission"];
|
|
9490
9205
|
};
|
|
9491
9206
|
};
|
|
9492
9207
|
/** Definition of a stage in a workflow */
|
|
@@ -9500,7 +9215,7 @@ interface components$b {
|
|
|
9500
9215
|
* listed here, the stage is read-only and publishing is disabled
|
|
9501
9216
|
*/
|
|
9502
9217
|
permissions: {
|
|
9503
|
-
[key: string]: components$
|
|
9218
|
+
[key: string]: components$c["schemas"]["WorkflowStagePermission"];
|
|
9504
9219
|
};
|
|
9505
9220
|
/**
|
|
9506
9221
|
* When true, transitioning into this stage from a different stage will automatically publish the entity.
|
|
@@ -9520,7 +9235,7 @@ interface components$b {
|
|
|
9520
9235
|
* Every stage must define at least one transition, to avoid creating a workflow that
|
|
9521
9236
|
* has a stage that can never be escaped
|
|
9522
9237
|
*/
|
|
9523
|
-
transitions: components$
|
|
9238
|
+
transitions: components$c["schemas"]["WorkflowStageTransition"][];
|
|
9524
9239
|
/**
|
|
9525
9240
|
* Icon name for the stage (e.g. 'chevron-double-right-o')
|
|
9526
9241
|
* @defaultValue chevron-double-right-o
|
|
@@ -9545,7 +9260,7 @@ interface components$b {
|
|
|
9545
9260
|
initialStage: string;
|
|
9546
9261
|
/** All stages of the workflow */
|
|
9547
9262
|
stages: {
|
|
9548
|
-
[key: string]: components$
|
|
9263
|
+
[key: string]: components$c["schemas"]["WorkflowStage"];
|
|
9549
9264
|
};
|
|
9550
9265
|
/** Last modified ISO date string for this definition (ignored for writes) */
|
|
9551
9266
|
modified?: string;
|
|
@@ -9593,6 +9308,8 @@ interface components$b {
|
|
|
9593
9308
|
* Timestamp when the item was moved to trash. Omitted if not in trash.
|
|
9594
9309
|
*/
|
|
9595
9310
|
deletedAt?: string;
|
|
9311
|
+
/** 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. */
|
|
9312
|
+
publishedWhenTrashed?: boolean;
|
|
9596
9313
|
/** User name of the creator of this composition */
|
|
9597
9314
|
creator?: string;
|
|
9598
9315
|
/** User name of the last editor of this composition */
|
|
@@ -9618,7 +9335,7 @@ interface components$b {
|
|
|
9618
9335
|
* The release this composition belongs to. If not set, it belongs to the base
|
|
9619
9336
|
*/
|
|
9620
9337
|
releaseId?: string;
|
|
9621
|
-
composition: components$
|
|
9338
|
+
composition: components$c["schemas"]["RootComponentInstance"];
|
|
9622
9339
|
/**
|
|
9623
9340
|
* Format: uuid
|
|
9624
9341
|
* The workflow ID assigned to this composition, if any. Normally comes from the component definition
|
|
@@ -9636,7 +9353,7 @@ interface components$b {
|
|
|
9636
9353
|
*/
|
|
9637
9354
|
instanceWorkflowId?: string;
|
|
9638
9355
|
/** The full definition of the assigned workflow, if any, including stages, permissions, etc. Returned only when `withWorkflowDefinition` is true */
|
|
9639
|
-
workflowDefinition?: components$
|
|
9356
|
+
workflowDefinition?: components$c["schemas"]["WorkflowDefinition"];
|
|
9640
9357
|
/**
|
|
9641
9358
|
* Format: uuid
|
|
9642
9359
|
* The edition ID. When set, this is a child edition of the composition in _id.
|
|
@@ -9654,7 +9371,7 @@ interface components$b {
|
|
|
9654
9371
|
editionPriority?: number;
|
|
9655
9372
|
};
|
|
9656
9373
|
CompositionListResponse: {
|
|
9657
|
-
compositions: components$
|
|
9374
|
+
compositions: components$c["schemas"]["CompositionApiResponse"][];
|
|
9658
9375
|
/** Total number of compositions that match the query. Present only when `withTotalCount` option is true */
|
|
9659
9376
|
totalCount?: number;
|
|
9660
9377
|
/** Per-field counts for distinct values */
|
|
@@ -9715,10 +9432,10 @@ interface components$b {
|
|
|
9715
9432
|
RouteResponseRedirect: {
|
|
9716
9433
|
/** The route that was matched in the redirects */
|
|
9717
9434
|
matchedRoute: string;
|
|
9718
|
-
dynamicInputs?: components$
|
|
9435
|
+
dynamicInputs?: components$c["schemas"]["RouteDynamicInputs"];
|
|
9719
9436
|
/** @enum {string} */
|
|
9720
9437
|
type: "redirect";
|
|
9721
|
-
redirect: components$
|
|
9438
|
+
redirect: components$c["schemas"]["Redirect"];
|
|
9722
9439
|
};
|
|
9723
9440
|
/**
|
|
9724
9441
|
* The route does not match any configured redirections or compositions.
|
|
@@ -9758,15 +9475,15 @@ interface components$b {
|
|
|
9758
9475
|
_locales?: string[];
|
|
9759
9476
|
/** Entry field values */
|
|
9760
9477
|
fields?: {
|
|
9761
|
-
[key: string]: components$
|
|
9478
|
+
[key: string]: components$c["schemas"]["ComponentParameter"];
|
|
9762
9479
|
};
|
|
9763
|
-
_dataResources?: components$
|
|
9480
|
+
_dataResources?: components$c["schemas"]["DataResourceDefinitions"];
|
|
9764
9481
|
/**
|
|
9765
9482
|
* Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
|
9766
9483
|
* Means nothing for PUTs; it will be ignored
|
|
9767
9484
|
*/
|
|
9768
9485
|
_patternDataResources?: {
|
|
9769
|
-
[key: string]: components$
|
|
9486
|
+
[key: string]: components$c["schemas"]["DataResourceDefinition"];
|
|
9770
9487
|
};
|
|
9771
9488
|
/**
|
|
9772
9489
|
* Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
|
@@ -9789,7 +9506,7 @@ interface components$b {
|
|
|
9789
9506
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
9790
9507
|
*/
|
|
9791
9508
|
_overrides?: {
|
|
9792
|
-
[key: string]: components$
|
|
9509
|
+
[key: string]: components$c["schemas"]["ComponentOverride"];
|
|
9793
9510
|
};
|
|
9794
9511
|
/**
|
|
9795
9512
|
* When used on a pattern, defines how the pattern's parameters may be overridden
|
|
@@ -9798,7 +9515,7 @@ interface components$b {
|
|
|
9798
9515
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
9799
9516
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
9800
9517
|
*/
|
|
9801
|
-
_overridability?: components$
|
|
9518
|
+
_overridability?: components$c["schemas"]["ComponentOverridability"];
|
|
9802
9519
|
};
|
|
9803
9520
|
EntryApiResponse: {
|
|
9804
9521
|
/** Publishing state to fetch. 0 = draft, 64 = published */
|
|
@@ -9834,12 +9551,14 @@ interface components$b {
|
|
|
9834
9551
|
* Timestamp when the item was moved to trash. Omitted if not in trash.
|
|
9835
9552
|
*/
|
|
9836
9553
|
deletedAt?: string;
|
|
9554
|
+
/** 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. */
|
|
9555
|
+
publishedWhenTrashed?: boolean;
|
|
9837
9556
|
/**
|
|
9838
9557
|
* True if the entry is a pattern (which can be referenced on other entries)
|
|
9839
9558
|
* @defaultValue false
|
|
9840
9559
|
*/
|
|
9841
9560
|
pattern?: boolean;
|
|
9842
|
-
entry: components$
|
|
9561
|
+
entry: components$c["schemas"]["Entry"];
|
|
9843
9562
|
/**
|
|
9844
9563
|
* Format: uuid
|
|
9845
9564
|
* The workflow ID that this entry is assigned. Normally comes from the content type
|
|
@@ -9857,7 +9576,7 @@ interface components$b {
|
|
|
9857
9576
|
*/
|
|
9858
9577
|
instanceWorkflowId?: string;
|
|
9859
9578
|
/** The full definition of the assigned workflow, if any, including stages, permissions, etc. Only returned when `withWorkflowDefinition` is true */
|
|
9860
|
-
workflowDefinition?: components$
|
|
9579
|
+
workflowDefinition?: components$c["schemas"]["WorkflowDefinition"];
|
|
9861
9580
|
/**
|
|
9862
9581
|
* Only present if an incomplete entry is returned; indicates reason for stubbing
|
|
9863
9582
|
|
|
@@ -9880,7 +9599,7 @@ interface components$b {
|
|
|
9880
9599
|
editionPriority?: number;
|
|
9881
9600
|
};
|
|
9882
9601
|
EntryListResponse: {
|
|
9883
|
-
entries: components$
|
|
9602
|
+
entries: components$c["schemas"]["EntryApiResponse"][];
|
|
9884
9603
|
/** Total number of entries that match the query. Only present when `withTotalCount` option is true */
|
|
9885
9604
|
totalCount?: number;
|
|
9886
9605
|
/** Per-field counts for distinct values */
|
|
@@ -9898,7 +9617,7 @@ interface components$b {
|
|
|
9898
9617
|
[name: string]: unknown;
|
|
9899
9618
|
};
|
|
9900
9619
|
content: {
|
|
9901
|
-
"application/json": components$
|
|
9620
|
+
"application/json": components$c["schemas"]["UniformError"];
|
|
9902
9621
|
};
|
|
9903
9622
|
};
|
|
9904
9623
|
/** Provided token or API key does not have access to the requested resource */
|
|
@@ -9907,7 +9626,7 @@ interface components$b {
|
|
|
9907
9626
|
[name: string]: unknown;
|
|
9908
9627
|
};
|
|
9909
9628
|
content: {
|
|
9910
|
-
"application/json": components$
|
|
9629
|
+
"application/json": components$c["schemas"]["UniformError"];
|
|
9911
9630
|
};
|
|
9912
9631
|
};
|
|
9913
9632
|
/** Provided token or API key does not allow this action */
|
|
@@ -9916,7 +9635,7 @@ interface components$b {
|
|
|
9916
9635
|
[name: string]: unknown;
|
|
9917
9636
|
};
|
|
9918
9637
|
content: {
|
|
9919
|
-
"application/json": components$
|
|
9638
|
+
"application/json": components$c["schemas"]["UniformError"];
|
|
9920
9639
|
};
|
|
9921
9640
|
};
|
|
9922
9641
|
/** The requested resource does not exist */
|
|
@@ -9925,7 +9644,7 @@ interface components$b {
|
|
|
9925
9644
|
[name: string]: unknown;
|
|
9926
9645
|
};
|
|
9927
9646
|
content: {
|
|
9928
|
-
"application/json": components$
|
|
9647
|
+
"application/json": components$c["schemas"]["UniformError"];
|
|
9929
9648
|
};
|
|
9930
9649
|
};
|
|
9931
9650
|
/** Invalid method was used to call the endpoint */
|
|
@@ -9934,7 +9653,7 @@ interface components$b {
|
|
|
9934
9653
|
[name: string]: unknown;
|
|
9935
9654
|
};
|
|
9936
9655
|
content: {
|
|
9937
|
-
"application/json": components$
|
|
9656
|
+
"application/json": components$c["schemas"]["UniformError"];
|
|
9938
9657
|
};
|
|
9939
9658
|
};
|
|
9940
9659
|
/** The request body could not be parsed or understood */
|
|
@@ -9943,7 +9662,7 @@ interface components$b {
|
|
|
9943
9662
|
[name: string]: unknown;
|
|
9944
9663
|
};
|
|
9945
9664
|
content: {
|
|
9946
|
-
"application/json": components$
|
|
9665
|
+
"application/json": components$c["schemas"]["UniformError"];
|
|
9947
9666
|
};
|
|
9948
9667
|
};
|
|
9949
9668
|
/** The endpoint is called too often */
|
|
@@ -9952,7 +9671,7 @@ interface components$b {
|
|
|
9952
9671
|
[name: string]: unknown;
|
|
9953
9672
|
};
|
|
9954
9673
|
content: {
|
|
9955
|
-
"application/json": components$
|
|
9674
|
+
"application/json": components$c["schemas"]["UniformError"];
|
|
9956
9675
|
};
|
|
9957
9676
|
};
|
|
9958
9677
|
/** An unexpected error occurred */
|
|
@@ -9961,7 +9680,7 @@ interface components$b {
|
|
|
9961
9680
|
[name: string]: unknown;
|
|
9962
9681
|
};
|
|
9963
9682
|
content: {
|
|
9964
|
-
"application/json": components$
|
|
9683
|
+
"application/json": components$c["schemas"]["UniformError"];
|
|
9965
9684
|
};
|
|
9966
9685
|
};
|
|
9967
9686
|
};
|
|
@@ -10271,7 +9990,7 @@ interface components$b {
|
|
|
10271
9990
|
pathItems: never;
|
|
10272
9991
|
}
|
|
10273
9992
|
|
|
10274
|
-
interface paths$
|
|
9993
|
+
interface paths$b {
|
|
10275
9994
|
"/api/v1/route": {
|
|
10276
9995
|
parameters: {
|
|
10277
9996
|
query?: never;
|
|
@@ -10337,7 +10056,7 @@ interface paths$a {
|
|
|
10337
10056
|
parameters: {
|
|
10338
10057
|
query: {
|
|
10339
10058
|
/** The project to fetch a route from */
|
|
10340
|
-
projectId: components$
|
|
10059
|
+
projectId: components$b["parameters"]["projectId"];
|
|
10341
10060
|
/**
|
|
10342
10061
|
* The path to resolve. Dynamic project map nodes and redirects can be resolved when a matching path is passed.
|
|
10343
10062
|
* Query string parameters may be passed with the path. They are ignored for route matching.
|
|
@@ -10368,21 +10087,21 @@ interface paths$a {
|
|
|
10368
10087
|
* "/config.php.bak" or "/db.sql") return `{ "type": "notFound" }` without being matched, even where a dynamic
|
|
10369
10088
|
* project map node or redirect would match them.
|
|
10370
10089
|
*/
|
|
10371
|
-
path: components$
|
|
10090
|
+
path: components$b["parameters"]["path"];
|
|
10372
10091
|
/** Specify a project map ID to fetch route from. If not specified, the default project map for the projectId is used */
|
|
10373
|
-
projectMapId?: components$
|
|
10092
|
+
projectMapId?: components$b["parameters"]["projectMapId"];
|
|
10374
10093
|
/** Publishing state to fetch. 0 = draft, 64 = published */
|
|
10375
|
-
state?: components$
|
|
10094
|
+
state?: components$b["parameters"]["state"];
|
|
10376
10095
|
/**
|
|
10377
10096
|
* If true the `_id` unique identifier of each non-root component will be part of the response data.
|
|
10378
10097
|
* If false, the `_id` will not be present in the API response
|
|
10379
10098
|
*/
|
|
10380
|
-
withComponentIDs?: components$
|
|
10099
|
+
withComponentIDs?: components$b["parameters"]["withComponentIDs"];
|
|
10381
10100
|
/**
|
|
10382
10101
|
* @deprecated
|
|
10383
10102
|
* Has no effect.
|
|
10384
10103
|
*/
|
|
10385
|
-
withContentSourceMap?: components$
|
|
10104
|
+
withContentSourceMap?: components$b["parameters"]["withContentSourceMap"];
|
|
10386
10105
|
/**
|
|
10387
10106
|
* One or more locales to localize the response to.
|
|
10388
10107
|
* When the result is a composition, it includes only the first matching locale's data.
|
|
@@ -10399,7 +10118,7 @@ interface paths$a {
|
|
|
10399
10118
|
*
|
|
10400
10119
|
* When the result is a redirect, this parameter has no effect
|
|
10401
10120
|
*/
|
|
10402
|
-
locale?: components$
|
|
10121
|
+
locale?: components$b["parameters"]["locale"];
|
|
10403
10122
|
/**
|
|
10404
10123
|
* The ID of a release to fetch the content for.
|
|
10405
10124
|
*
|
|
@@ -10408,19 +10127,19 @@ interface paths$a {
|
|
|
10408
10127
|
*
|
|
10409
10128
|
* 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
10129
|
*/
|
|
10411
|
-
releaseId?: components$
|
|
10130
|
+
releaseId?: components$b["parameters"]["releaseId"];
|
|
10412
10131
|
/**
|
|
10413
10132
|
* Indicates the data variant that was fetched for data resources.
|
|
10414
10133
|
* undefined: Data resources were resolved using published data from their data source
|
|
10415
10134
|
* 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
10135
|
*/
|
|
10417
|
-
dataSourceVariant?: components$
|
|
10136
|
+
dataSourceVariant?: components$b["parameters"]["dataSourceVariant"];
|
|
10418
10137
|
/**
|
|
10419
10138
|
* When true, redirects are not evaluated for the route matching; the result will be either a composition or not found.
|
|
10420
10139
|
* Note: this is always true when state=63 (internal RSC editor state) to allow contextual editing of compositions
|
|
10421
10140
|
* that have redirects configured on their paths.
|
|
10422
10141
|
*/
|
|
10423
|
-
ignoreRedirects?: components$
|
|
10142
|
+
ignoreRedirects?: components$b["parameters"]["ignoreRedirects"];
|
|
10424
10143
|
};
|
|
10425
10144
|
header?: never;
|
|
10426
10145
|
path?: never;
|
|
@@ -10434,14 +10153,14 @@ interface paths$a {
|
|
|
10434
10153
|
[name: string]: unknown;
|
|
10435
10154
|
};
|
|
10436
10155
|
content: {
|
|
10437
|
-
"application/json": components$
|
|
10156
|
+
"application/json": components$b["schemas"]["RouteResponse"];
|
|
10438
10157
|
};
|
|
10439
10158
|
};
|
|
10440
|
-
400: components$
|
|
10441
|
-
401: components$
|
|
10442
|
-
403: components$
|
|
10443
|
-
429: components$
|
|
10444
|
-
500: components$
|
|
10159
|
+
400: components$b["responses"]["BadRequestError"];
|
|
10160
|
+
401: components$b["responses"]["UnauthorizedError"];
|
|
10161
|
+
403: components$b["responses"]["ForbiddenError"];
|
|
10162
|
+
429: components$b["responses"]["RateLimitError"];
|
|
10163
|
+
500: components$b["responses"]["InternalServerError"];
|
|
10445
10164
|
};
|
|
10446
10165
|
};
|
|
10447
10166
|
put?: never;
|
|
@@ -10471,7 +10190,7 @@ interface paths$a {
|
|
|
10471
10190
|
trace?: never;
|
|
10472
10191
|
};
|
|
10473
10192
|
}
|
|
10474
|
-
interface components$
|
|
10193
|
+
interface components$b {
|
|
10475
10194
|
schemas: {
|
|
10476
10195
|
RouteDynamicInputs: {
|
|
10477
10196
|
[key: string]: string;
|
|
@@ -10520,10 +10239,10 @@ interface components$a {
|
|
|
10520
10239
|
RouteResponseRedirect: {
|
|
10521
10240
|
/** The route that was matched in the redirects */
|
|
10522
10241
|
matchedRoute: string;
|
|
10523
|
-
dynamicInputs?: components$
|
|
10242
|
+
dynamicInputs?: components$b["schemas"]["RouteDynamicInputs"];
|
|
10524
10243
|
/** @enum {string} */
|
|
10525
10244
|
type: "redirect";
|
|
10526
|
-
redirect: components$
|
|
10245
|
+
redirect: components$b["schemas"]["Redirect"];
|
|
10527
10246
|
};
|
|
10528
10247
|
/** Defines a connection to a dynamic token on a data resource */
|
|
10529
10248
|
DataElementConnectionDefinition: {
|
|
@@ -10589,11 +10308,11 @@ interface components$a {
|
|
|
10589
10308
|
|
|
10590
10309
|
*/
|
|
10591
10310
|
op?: "&" | "|";
|
|
10592
|
-
clauses: (components$
|
|
10311
|
+
clauses: (components$b["schemas"]["VisibilityCriteria"] | components$b["schemas"]["VisibilityCriteriaGroup"])[];
|
|
10593
10312
|
};
|
|
10594
10313
|
/** Defines a conditional value for a component parameter */
|
|
10595
10314
|
ComponentParameterConditionalValue: {
|
|
10596
|
-
when: components$
|
|
10315
|
+
when: components$b["schemas"]["VisibilityCriteriaGroup"];
|
|
10597
10316
|
/**
|
|
10598
10317
|
* The value of the parameter. Any JSON-serializable value is acceptable.
|
|
10599
10318
|
* A value of `null` will cause the parameter value to be removed, if it matches.
|
|
@@ -10615,7 +10334,7 @@ interface components$a {
|
|
|
10615
10334
|
*
|
|
10616
10335
|
* When no locale is passed to a non-route API, conditions are not processed and all conditions are returned.
|
|
10617
10336
|
*/
|
|
10618
|
-
ComponentParameterConditions: components$
|
|
10337
|
+
ComponentParameterConditions: components$b["schemas"]["ComponentParameterConditionalValue"][];
|
|
10619
10338
|
/** Defines an editable parameter on a component */
|
|
10620
10339
|
ComponentParameter: {
|
|
10621
10340
|
/** The value of the parameter. Any JSON-serializable value is acceptable */
|
|
@@ -10623,7 +10342,7 @@ interface components$a {
|
|
|
10623
10342
|
/** The type of the parameter. Determines how it is displayed when editing and tells the consumer how to process it */
|
|
10624
10343
|
type: string;
|
|
10625
10344
|
/** @deprecated */
|
|
10626
|
-
connectedData?: components$
|
|
10345
|
+
connectedData?: components$b["schemas"]["DataElementConnectionDefinition"];
|
|
10627
10346
|
/**
|
|
10628
10347
|
* Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
|
|
10629
10348
|
* Note that locales must be registered on the entry/composition `_locales` before being used
|
|
@@ -10631,10 +10350,10 @@ interface components$a {
|
|
|
10631
10350
|
locales?: {
|
|
10632
10351
|
[key: string]: unknown;
|
|
10633
10352
|
};
|
|
10634
|
-
conditions?: components$
|
|
10353
|
+
conditions?: components$b["schemas"]["ComponentParameterConditions"];
|
|
10635
10354
|
/** Locale-specific conditional values for this parameter. Keys are locale codes, and values are the `conditions` for that locale. */
|
|
10636
10355
|
localesConditions?: {
|
|
10637
|
-
[key: string]: components$
|
|
10356
|
+
[key: string]: components$b["schemas"]["ComponentParameterConditions"];
|
|
10638
10357
|
};
|
|
10639
10358
|
};
|
|
10640
10359
|
ProjectMapNodeAllowedQueryString: {
|
|
@@ -10669,7 +10388,7 @@ interface components$a {
|
|
|
10669
10388
|
/** 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
10389
|
isSearchHit?: boolean;
|
|
10671
10390
|
/** Query strings that are allowed to be passed to the node */
|
|
10672
|
-
queryStrings?: components$
|
|
10391
|
+
queryStrings?: components$b["schemas"]["ProjectMapNodeAllowedQueryString"][];
|
|
10673
10392
|
/**
|
|
10674
10393
|
* For dynamic nodes, this is the preview value for the dynamic value.
|
|
10675
10394
|
* The preview value is used when editing a connected composition, and is the default
|
|
@@ -10694,7 +10413,7 @@ interface components$a {
|
|
|
10694
10413
|
* Unique identifier for the project map that this node belongs to
|
|
10695
10414
|
*/
|
|
10696
10415
|
projectMapId: string;
|
|
10697
|
-
data?: components$
|
|
10416
|
+
data?: components$b["schemas"]["ProjectMapNodeData"];
|
|
10698
10417
|
/**
|
|
10699
10418
|
* Locale-specific paths of the project map node.
|
|
10700
10419
|
* Keys are locale codes
|
|
@@ -10714,13 +10433,13 @@ interface components$a {
|
|
|
10714
10433
|
type: string;
|
|
10715
10434
|
/** Component parameter values for the component instance */
|
|
10716
10435
|
parameters?: {
|
|
10717
|
-
[key: string]: components$
|
|
10436
|
+
[key: string]: components$b["schemas"]["ComponentParameter"];
|
|
10718
10437
|
};
|
|
10719
10438
|
/** Public ID of alternate visual appearance for this component, if any selected */
|
|
10720
10439
|
variant?: string;
|
|
10721
10440
|
/** Slots containing any child components */
|
|
10722
10441
|
slots?: {
|
|
10723
|
-
[key: string]: components$
|
|
10442
|
+
[key: string]: components$b["schemas"]["ComponentInstance"][];
|
|
10724
10443
|
};
|
|
10725
10444
|
/**
|
|
10726
10445
|
* Unique identifier of the component within the composition.
|
|
@@ -10731,20 +10450,20 @@ interface components$a {
|
|
|
10731
10450
|
_id?: string;
|
|
10732
10451
|
/** Indicates this component instance should be sourced from a pattern library pattern */
|
|
10733
10452
|
_pattern?: string;
|
|
10734
|
-
_dataResources?: components$
|
|
10453
|
+
_dataResources?: components$b["schemas"]["DataResourceDefinitions"];
|
|
10735
10454
|
/**
|
|
10736
10455
|
* Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
|
10737
10456
|
* Means nothing for PUTs; it will be ignored
|
|
10738
10457
|
*/
|
|
10739
10458
|
_patternDataResources?: {
|
|
10740
|
-
[key: string]: components$
|
|
10459
|
+
[key: string]: components$b["schemas"]["DataResourceDefinition"];
|
|
10741
10460
|
};
|
|
10742
10461
|
/**
|
|
10743
10462
|
* Query-string opt-ins coming from a pattern resolved for this component.
|
|
10744
10463
|
* Means nothing for PUTs; it will be ignored
|
|
10745
10464
|
*/
|
|
10746
10465
|
_patternOptedInQueryStrings?: string[];
|
|
10747
|
-
_patternError?: components$
|
|
10466
|
+
_patternError?: components$b["schemas"]["PatternError"];
|
|
10748
10467
|
/**
|
|
10749
10468
|
* Defines patch overrides to component IDs that live in the composition.
|
|
10750
10469
|
* This can be used to override parameters that are defined on patterns,
|
|
@@ -10758,14 +10477,14 @@ interface components$a {
|
|
|
10758
10477
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
10759
10478
|
*/
|
|
10760
10479
|
_overrides?: {
|
|
10761
|
-
[key: string]: components$
|
|
10480
|
+
[key: string]: components$b["schemas"]["ComponentOverride"];
|
|
10762
10481
|
};
|
|
10763
10482
|
/**
|
|
10764
10483
|
* Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
|
|
10765
10484
|
* Means nothing for PUTs; it will be ignored
|
|
10766
10485
|
*/
|
|
10767
10486
|
_patternOverrides?: {
|
|
10768
|
-
[key: string]: components$
|
|
10487
|
+
[key: string]: components$b["schemas"]["ComponentOverride"];
|
|
10769
10488
|
};
|
|
10770
10489
|
/**
|
|
10771
10490
|
* When used on a pattern, defines how the pattern's parameters may be overridden
|
|
@@ -10774,7 +10493,7 @@ interface components$a {
|
|
|
10774
10493
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
10775
10494
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
10776
10495
|
*/
|
|
10777
|
-
_overridability?: components$
|
|
10496
|
+
_overridability?: components$b["schemas"]["ComponentOverridability"];
|
|
10778
10497
|
/** Array of locales that have data defined. Only set for pattern references or composition defaults */
|
|
10779
10498
|
_locales?: string[];
|
|
10780
10499
|
};
|
|
@@ -10799,14 +10518,14 @@ interface components$a {
|
|
|
10799
10518
|
* If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
|
|
10800
10519
|
*/
|
|
10801
10520
|
optionalPatternParameter?: boolean;
|
|
10802
|
-
variables?: components$
|
|
10521
|
+
variables?: components$b["schemas"]["DataResourceVariables"];
|
|
10803
10522
|
};
|
|
10804
10523
|
/**
|
|
10805
10524
|
* Data definitions attached to this component. The property name is the key of the data in the data document.
|
|
10806
10525
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key)
|
|
10807
10526
|
*/
|
|
10808
10527
|
DataResourceDefinitions: {
|
|
10809
|
-
[key: string]: components$
|
|
10528
|
+
[key: string]: components$b["schemas"]["DataResourceDefinition"];
|
|
10810
10529
|
};
|
|
10811
10530
|
/**
|
|
10812
10531
|
* Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
|
@@ -10824,10 +10543,10 @@ interface components$a {
|
|
|
10824
10543
|
*/
|
|
10825
10544
|
ComponentOverride: {
|
|
10826
10545
|
parameters?: {
|
|
10827
|
-
[key: string]: components$
|
|
10546
|
+
[key: string]: components$b["schemas"]["ComponentParameter"];
|
|
10828
10547
|
};
|
|
10829
10548
|
slots?: {
|
|
10830
|
-
[key: string]: components$
|
|
10549
|
+
[key: string]: components$b["schemas"]["ComponentInstance"][];
|
|
10831
10550
|
};
|
|
10832
10551
|
variant?: string;
|
|
10833
10552
|
/**
|
|
@@ -10836,7 +10555,7 @@ interface components$a {
|
|
|
10836
10555
|
* Overrides defined here replace values in either _dataResources or _patternDataResources on the target component.
|
|
10837
10556
|
*/
|
|
10838
10557
|
dataResources?: {
|
|
10839
|
-
[key: string]: components$
|
|
10558
|
+
[key: string]: components$b["schemas"]["DataResourceDefinition"];
|
|
10840
10559
|
};
|
|
10841
10560
|
};
|
|
10842
10561
|
/**
|
|
@@ -10857,7 +10576,7 @@ interface components$a {
|
|
|
10857
10576
|
ComponentOverridability: {
|
|
10858
10577
|
/** Defines component parameter value overrides. Keys are the parameter public ID */
|
|
10859
10578
|
parameters?: {
|
|
10860
|
-
[key: string]: components$
|
|
10579
|
+
[key: string]: components$b["schemas"]["OverrideOptions"];
|
|
10861
10580
|
};
|
|
10862
10581
|
/** Allows overriding a display variant is allowed if it is defined on the component the pattern is derived from. Default = false */
|
|
10863
10582
|
variants?: boolean;
|
|
@@ -10874,15 +10593,15 @@ interface components$a {
|
|
|
10874
10593
|
type: string;
|
|
10875
10594
|
/** Component parameter values for the component instance */
|
|
10876
10595
|
parameters?: {
|
|
10877
|
-
[key: string]: components$
|
|
10596
|
+
[key: string]: components$b["schemas"]["ComponentParameter"];
|
|
10878
10597
|
};
|
|
10879
10598
|
/** Public ID of alternate visual appearance for this component, if any selected */
|
|
10880
10599
|
variant?: string;
|
|
10881
10600
|
/** Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated */
|
|
10882
|
-
projectMapNodes?: components$
|
|
10601
|
+
projectMapNodes?: components$b["schemas"]["CompositionProjectMapNodeInfo"][];
|
|
10883
10602
|
/** Slots containing any child components */
|
|
10884
10603
|
slots?: {
|
|
10885
|
-
[key: string]: components$
|
|
10604
|
+
[key: string]: components$b["schemas"]["ComponentInstance"][];
|
|
10886
10605
|
};
|
|
10887
10606
|
/** The ID of the composition */
|
|
10888
10607
|
_id: string;
|
|
@@ -10901,283 +10620,643 @@ interface components$a {
|
|
|
10901
10620
|
/** Indicates this component instance should be sourced from a pattern library pattern */
|
|
10902
10621
|
_pattern?: string;
|
|
10903
10622
|
/**
|
|
10904
|
-
* Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
|
10905
|
-
* Means nothing for PUTs; it will be ignored
|
|
10623
|
+
* Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
|
10624
|
+
* Means nothing for PUTs; it will be ignored
|
|
10625
|
+
*/
|
|
10626
|
+
_patternDataResources?: {
|
|
10627
|
+
[key: string]: components$b["schemas"]["DataResourceDefinition"];
|
|
10628
|
+
};
|
|
10629
|
+
/**
|
|
10630
|
+
* Query-string opt-ins coming from a pattern resolved for this component.
|
|
10631
|
+
* Means nothing for PUTs; it will be ignored
|
|
10632
|
+
*/
|
|
10633
|
+
_patternOptedInQueryStrings?: string[];
|
|
10634
|
+
_dataResources?: components$b["schemas"]["DataResourceDefinitions"];
|
|
10635
|
+
_patternError?: components$b["schemas"]["PatternError"];
|
|
10636
|
+
/**
|
|
10637
|
+
* Defines patch overrides to component IDs that live in the composition.
|
|
10638
|
+
* This can be used to override parameters that are defined on patterns,
|
|
10639
|
+
* including nested patterns, with values that are specific to this composition.
|
|
10640
|
+
* The keys in this object are component IDs.
|
|
10641
|
+
* Overrides are applied from the top down, so for example if both the composition
|
|
10642
|
+
* and a pattern on the composition define an override on a nested pattern,
|
|
10643
|
+
* the composition's override replaces the pattern's.
|
|
10644
|
+
*
|
|
10645
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
10646
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
10647
|
+
*/
|
|
10648
|
+
_overrides?: {
|
|
10649
|
+
[key: string]: components$b["schemas"]["ComponentOverride"];
|
|
10650
|
+
};
|
|
10651
|
+
/**
|
|
10652
|
+
* Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
|
|
10653
|
+
* Means nothing for PUTs; it will be ignored
|
|
10654
|
+
*/
|
|
10655
|
+
_patternOverrides?: {
|
|
10656
|
+
[key: string]: components$b["schemas"]["ComponentOverride"];
|
|
10657
|
+
};
|
|
10658
|
+
/**
|
|
10659
|
+
* When used on a pattern, defines how the pattern's parameters may be overridden
|
|
10660
|
+
* by consumers of the pattern.
|
|
10661
|
+
*
|
|
10662
|
+
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
10663
|
+
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
10664
|
+
*/
|
|
10665
|
+
_overridability?: components$b["schemas"]["ComponentOverridability"];
|
|
10666
|
+
/** Array of locales which have data defined on the composition. If empty, the current default locale implicitly has data */
|
|
10667
|
+
_locales?: string[];
|
|
10668
|
+
/**
|
|
10669
|
+
* Names of opt-in global query strings surfaced in the Canvas editor for this composition or pattern.
|
|
10670
|
+
* Opt-ins coming from a resolved pattern move to _patternOptedInQueryStrings, so this always
|
|
10671
|
+
* holds only what was authored here. Omitted whenever overrides are resolved.
|
|
10672
|
+
*/
|
|
10673
|
+
_optedInQueryStrings?: string[];
|
|
10674
|
+
};
|
|
10675
|
+
/** Permissions for a workflow stage */
|
|
10676
|
+
WorkflowStagePermission: {
|
|
10677
|
+
/** Allows writing to entities assigned to this stage. When false or unspecified the data is read-only */
|
|
10678
|
+
write?: boolean;
|
|
10679
|
+
/** Allows publishing entities assigned to this stage. When false or unspecified publishing is disabled */
|
|
10680
|
+
publish?: boolean;
|
|
10681
|
+
};
|
|
10682
|
+
/** Permissions for a workflow stage transition */
|
|
10683
|
+
WorkflowStageTransitionPermission: {
|
|
10684
|
+
/** Allows executing the transition for a role. Note that write permissions to the destination stage are NOT required to execute a transition to it */
|
|
10685
|
+
execute?: boolean;
|
|
10686
|
+
};
|
|
10687
|
+
/** Definition of a transition from one stage to another in a workflow */
|
|
10688
|
+
WorkflowStageTransition: {
|
|
10689
|
+
/**
|
|
10690
|
+
* Format: uuid
|
|
10691
|
+
* The target stage to transition to
|
|
10692
|
+
*/
|
|
10693
|
+
to: string;
|
|
10694
|
+
/**
|
|
10695
|
+
* Name shown to the user when they execute this transition.
|
|
10696
|
+
* If not provided, a default name will be assigned automatically based on the target stage
|
|
10697
|
+
*/
|
|
10698
|
+
name: string;
|
|
10699
|
+
/**
|
|
10700
|
+
* Permissions for the stage transition.
|
|
10701
|
+
* NOTE: Users without membership in any role listed here will be unable to execute the transition unless they are team admins
|
|
10702
|
+
*/
|
|
10703
|
+
permissions: {
|
|
10704
|
+
[key: string]: components$b["schemas"]["WorkflowStageTransitionPermission"];
|
|
10705
|
+
};
|
|
10706
|
+
};
|
|
10707
|
+
/** Definition of a stage in a workflow */
|
|
10708
|
+
WorkflowStage: {
|
|
10709
|
+
/** Name of the stage */
|
|
10710
|
+
name: string;
|
|
10711
|
+
/**
|
|
10712
|
+
* Defines roles which have permissions to this workflow stage
|
|
10713
|
+
* NOTE: Being able to write or publish to entities in a workflow stage requires both core write or publish permissions,
|
|
10714
|
+
* as well as membership in a role which grants the explicit rights to the stage. If a user is not a member of any role
|
|
10715
|
+
* listed here, the stage is read-only and publishing is disabled
|
|
10716
|
+
*/
|
|
10717
|
+
permissions: {
|
|
10718
|
+
[key: string]: components$b["schemas"]["WorkflowStagePermission"];
|
|
10719
|
+
};
|
|
10720
|
+
/**
|
|
10721
|
+
* When true, transitioning into this stage from a different stage will automatically publish the entity.
|
|
10722
|
+
* If the user making the transition does not have publish permissions to the stage as well as publish permission on the entity, the action will not run.
|
|
10723
|
+
* Setting this to true is equivalent to setting requireValidity to true, as publishing cannot be performed with validation errors.
|
|
10724
|
+
* NOTE: This is not executed by direct API calls. Only the Uniform UI performs this action
|
|
10725
|
+
*/
|
|
10726
|
+
autoPublish?: boolean;
|
|
10727
|
+
/**
|
|
10728
|
+
* When true, transitioning into this stage from a different stage will require the entity to have no validation errors.
|
|
10729
|
+
* If the entity is not valid, the transition will not be allowed.
|
|
10730
|
+
* NOTE: This is not executed by direct API calls. Only the Uniform UI performs this action
|
|
10731
|
+
*/
|
|
10732
|
+
requireValidity?: boolean;
|
|
10733
|
+
/**
|
|
10734
|
+
* Defines transitions to other stages
|
|
10735
|
+
* Every stage must define at least one transition, to avoid creating a workflow that
|
|
10736
|
+
* has a stage that can never be escaped
|
|
10737
|
+
*/
|
|
10738
|
+
transitions: components$b["schemas"]["WorkflowStageTransition"][];
|
|
10739
|
+
/**
|
|
10740
|
+
* Icon name for the stage (e.g. 'chevron-double-right-o')
|
|
10741
|
+
* @defaultValue chevron-double-right-o
|
|
10742
|
+
*/
|
|
10743
|
+
icon?: string;
|
|
10744
|
+
/** Sets the order of the stage when displayed in a list with other stages. If not set, the order defaults to alphabetical with any explicitly set orders first in the list */
|
|
10745
|
+
order?: number;
|
|
10746
|
+
};
|
|
10747
|
+
/** Definition of a workflow that can be assigned to entities */
|
|
10748
|
+
WorkflowDefinition: {
|
|
10749
|
+
/**
|
|
10750
|
+
* Format: uuid
|
|
10751
|
+
* Unique identifier of the workflow definition
|
|
10752
|
+
*/
|
|
10753
|
+
id: string;
|
|
10754
|
+
/** Workflow name */
|
|
10755
|
+
name: string;
|
|
10756
|
+
/**
|
|
10757
|
+
* Format: uuid
|
|
10758
|
+
* The ID of the initial stage in the stages object.
|
|
10759
|
+
*/
|
|
10760
|
+
initialStage: string;
|
|
10761
|
+
/** All stages of the workflow */
|
|
10762
|
+
stages: {
|
|
10763
|
+
[key: string]: components$b["schemas"]["WorkflowStage"];
|
|
10764
|
+
};
|
|
10765
|
+
/** Last modified ISO date string for this definition (ignored for writes) */
|
|
10766
|
+
modified?: string;
|
|
10767
|
+
/** Created ISO date string for this definition (ignored for writes) */
|
|
10768
|
+
created?: string;
|
|
10769
|
+
/**
|
|
10770
|
+
* Name of the original creator of the workflow.
|
|
10771
|
+
* If undefined, the user has been removed from the team.
|
|
10772
|
+
* Ignored for writes
|
|
10773
|
+
*/
|
|
10774
|
+
createdBy?: string;
|
|
10775
|
+
/**
|
|
10776
|
+
* Name of the last modifier of the workflow.
|
|
10777
|
+
* If undefined, the user has been removed from the team.
|
|
10778
|
+
* Ignored for writes
|
|
10779
|
+
*/
|
|
10780
|
+
modifiedBy?: string;
|
|
10781
|
+
};
|
|
10782
|
+
CompositionApiResponse: {
|
|
10783
|
+
/** Publishing state to fetch. 0 = draft, 64 = published */
|
|
10784
|
+
state: number;
|
|
10785
|
+
/**
|
|
10786
|
+
* @deprecated
|
|
10787
|
+
* UI status value. Subject to change without notice; do not rely on this value. Present only when `withUIStatus` is true
|
|
10788
|
+
|
|
10789
|
+
*/
|
|
10790
|
+
uiStatus?: "Draft" | "Modified" | "Published" | "Orphan" | "Previous" | "Unknown";
|
|
10791
|
+
/**
|
|
10792
|
+
* Format: uuid
|
|
10793
|
+
* The project ID this composition is part of
|
|
10794
|
+
*/
|
|
10795
|
+
projectId: string;
|
|
10796
|
+
/**
|
|
10797
|
+
* Format: date-time
|
|
10798
|
+
* Created date string for this composition
|
|
10799
|
+
*/
|
|
10800
|
+
created: string;
|
|
10801
|
+
/**
|
|
10802
|
+
* Format: date-time
|
|
10803
|
+
* Modified date string for this composition
|
|
10804
|
+
*/
|
|
10805
|
+
modified: string;
|
|
10806
|
+
/**
|
|
10807
|
+
* Format: date-time
|
|
10808
|
+
* Timestamp when the item was moved to trash. Omitted if not in trash.
|
|
10809
|
+
*/
|
|
10810
|
+
deletedAt?: string;
|
|
10811
|
+
/** 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. */
|
|
10812
|
+
publishedWhenTrashed?: boolean;
|
|
10813
|
+
/** User name of the creator of this composition */
|
|
10814
|
+
creator?: string;
|
|
10815
|
+
/** User name of the last editor of this composition */
|
|
10816
|
+
author?: string;
|
|
10817
|
+
/**
|
|
10818
|
+
* Format: uuid
|
|
10819
|
+
* Reference to the category this component definition belongs to
|
|
10820
|
+
*/
|
|
10821
|
+
categoryId?: string;
|
|
10822
|
+
/** A description of the component definition */
|
|
10823
|
+
description?: string;
|
|
10824
|
+
/** A preview image URL of the component definition */
|
|
10825
|
+
previewImageUrl?: string;
|
|
10826
|
+
/** Indicates if the composition is a pattern that can be referenced in other compositions */
|
|
10827
|
+
pattern: boolean;
|
|
10828
|
+
/**
|
|
10829
|
+
* If the instance is a pattern, this indicates if it's a component pattern or a composition pattern
|
|
10830
|
+
|
|
10906
10831
|
*/
|
|
10907
|
-
|
|
10908
|
-
[key: string]: components$a["schemas"]["DataResourceDefinition"];
|
|
10909
|
-
};
|
|
10832
|
+
patternType?: "component" | "composition";
|
|
10910
10833
|
/**
|
|
10911
|
-
*
|
|
10912
|
-
*
|
|
10834
|
+
* Format: uuid
|
|
10835
|
+
* The release this composition belongs to. If not set, it belongs to the base
|
|
10913
10836
|
*/
|
|
10914
|
-
|
|
10915
|
-
|
|
10916
|
-
_patternError?: components$a["schemas"]["PatternError"];
|
|
10837
|
+
releaseId?: string;
|
|
10838
|
+
composition: components$b["schemas"]["RootComponentInstance"];
|
|
10917
10839
|
/**
|
|
10918
|
-
*
|
|
10919
|
-
*
|
|
10920
|
-
* including nested patterns, with values that are specific to this composition.
|
|
10921
|
-
* The keys in this object are component IDs.
|
|
10922
|
-
* Overrides are applied from the top down, so for example if both the composition
|
|
10923
|
-
* and a pattern on the composition define an override on a nested pattern,
|
|
10924
|
-
* the composition's override replaces the pattern's.
|
|
10925
|
-
*
|
|
10926
|
-
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
10927
|
-
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
10840
|
+
* Format: uuid
|
|
10841
|
+
* The workflow ID assigned to this composition, if any. Normally comes from the component definition
|
|
10928
10842
|
*/
|
|
10929
|
-
|
|
10930
|
-
[key: string]: components$a["schemas"]["ComponentOverride"];
|
|
10931
|
-
};
|
|
10843
|
+
workflowId?: string;
|
|
10932
10844
|
/**
|
|
10933
|
-
*
|
|
10934
|
-
*
|
|
10845
|
+
* Format: uuid
|
|
10846
|
+
* The stage ID the composition is in within its assigned workflow. If undefined, it is implicitly in the initial stage of the workflow
|
|
10935
10847
|
*/
|
|
10936
|
-
|
|
10937
|
-
[key: string]: components$a["schemas"]["ComponentOverride"];
|
|
10938
|
-
};
|
|
10848
|
+
workflowStageId?: string;
|
|
10939
10849
|
/**
|
|
10940
|
-
*
|
|
10941
|
-
*
|
|
10942
|
-
*
|
|
10943
|
-
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
10944
|
-
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
10850
|
+
* Format: uuid
|
|
10851
|
+
* The workflow that compositions created from this pattern start in. This is not the
|
|
10852
|
+
* workflow the pattern itself is in, which is `workflowId`. Only ever set on composition patterns.
|
|
10945
10853
|
*/
|
|
10946
|
-
|
|
10947
|
-
/**
|
|
10948
|
-
|
|
10854
|
+
instanceWorkflowId?: string;
|
|
10855
|
+
/** The full definition of the assigned workflow, if any, including stages, permissions, etc. Returned only when `withWorkflowDefinition` is true */
|
|
10856
|
+
workflowDefinition?: components$b["schemas"]["WorkflowDefinition"];
|
|
10949
10857
|
/**
|
|
10950
|
-
*
|
|
10951
|
-
*
|
|
10952
|
-
* holds only what was authored here. Omitted whenever overrides are resolved.
|
|
10858
|
+
* Format: uuid
|
|
10859
|
+
* The edition ID. When set, this is a child edition of the composition in _id.
|
|
10953
10860
|
*/
|
|
10954
|
-
|
|
10861
|
+
editionId?: string;
|
|
10862
|
+
/**
|
|
10863
|
+
* The name of the composition or edition as shown in the editions listing.
|
|
10864
|
+
* Describes the purpose of an edition.
|
|
10865
|
+
*/
|
|
10866
|
+
editionName?: string;
|
|
10867
|
+
/**
|
|
10868
|
+
* The priority of the edition or composition. Higher numbers are higher priority.
|
|
10869
|
+
* When multiple editions enable the same locale, the highest priority edition is used.
|
|
10870
|
+
*/
|
|
10871
|
+
editionPriority?: number;
|
|
10955
10872
|
};
|
|
10956
|
-
/**
|
|
10957
|
-
|
|
10958
|
-
|
|
10959
|
-
|
|
10960
|
-
|
|
10961
|
-
|
|
10873
|
+
/**
|
|
10874
|
+
* The route matches a composition.
|
|
10875
|
+
* If any dynamic segments or query parameters are present in the route, they will be returned as dynamic inputs in the response
|
|
10876
|
+
*/
|
|
10877
|
+
RouteResponseComposition: {
|
|
10878
|
+
/** The route that was matched in the project map */
|
|
10879
|
+
matchedRoute: string;
|
|
10880
|
+
dynamicInputs?: components$b["schemas"]["RouteDynamicInputs"];
|
|
10881
|
+
/**
|
|
10882
|
+
* Indicates the data variant that was fetched for data resources.
|
|
10883
|
+
* undefined: Data resources were resolved using published data from their data source
|
|
10884
|
+
* 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.
|
|
10885
|
+
|
|
10886
|
+
*/
|
|
10887
|
+
dataResourcesVariant?: "unpublished";
|
|
10888
|
+
/** @enum {string} */
|
|
10889
|
+
type: "composition";
|
|
10890
|
+
compositionApiResponse: components$b["schemas"]["CompositionApiResponse"];
|
|
10962
10891
|
};
|
|
10963
|
-
/**
|
|
10964
|
-
|
|
10965
|
-
|
|
10966
|
-
|
|
10892
|
+
/**
|
|
10893
|
+
* The route does not match any configured redirections or compositions.
|
|
10894
|
+
* NOTE: This response differs from a HTTP 404, which indicates that the project map or project ID was not found.
|
|
10895
|
+
* Receiving this response with HTTP 200 means that the project was found, but the route did not match anything
|
|
10896
|
+
*/
|
|
10897
|
+
RouteResponseNotFound: {
|
|
10898
|
+
/** @enum {string} */
|
|
10899
|
+
type: "notFound";
|
|
10900
|
+
};
|
|
10901
|
+
RouteResponse: components$b["schemas"]["RouteResponseRedirect"] | components$b["schemas"]["RouteResponseComposition"] | components$b["schemas"]["RouteResponseNotFound"];
|
|
10902
|
+
Error: {
|
|
10903
|
+
/** Error message(s) that occurred while processing the request */
|
|
10904
|
+
errorMessage?: string[] | string;
|
|
10905
|
+
};
|
|
10906
|
+
};
|
|
10907
|
+
responses: {
|
|
10908
|
+
/** Request input validation failed */
|
|
10909
|
+
BadRequestError: {
|
|
10910
|
+
headers: {
|
|
10911
|
+
[name: string]: unknown;
|
|
10912
|
+
};
|
|
10913
|
+
content: {
|
|
10914
|
+
"application/json": components$b["schemas"]["Error"];
|
|
10915
|
+
};
|
|
10916
|
+
};
|
|
10917
|
+
/** API key or token was not valid */
|
|
10918
|
+
UnauthorizedError: {
|
|
10919
|
+
headers: {
|
|
10920
|
+
[name: string]: unknown;
|
|
10921
|
+
};
|
|
10922
|
+
content: {
|
|
10923
|
+
"application/json": components$b["schemas"]["Error"];
|
|
10924
|
+
};
|
|
10925
|
+
};
|
|
10926
|
+
/** Permission was denied */
|
|
10927
|
+
ForbiddenError: {
|
|
10928
|
+
headers: {
|
|
10929
|
+
[name: string]: unknown;
|
|
10930
|
+
};
|
|
10931
|
+
content: {
|
|
10932
|
+
"application/json": components$b["schemas"]["Error"];
|
|
10933
|
+
};
|
|
10934
|
+
};
|
|
10935
|
+
/** Too many requests in allowed time period */
|
|
10936
|
+
RateLimitError: {
|
|
10937
|
+
headers: {
|
|
10938
|
+
[name: string]: unknown;
|
|
10939
|
+
};
|
|
10940
|
+
content?: never;
|
|
10941
|
+
};
|
|
10942
|
+
/** Execution error occurred */
|
|
10943
|
+
InternalServerError: {
|
|
10944
|
+
headers: {
|
|
10945
|
+
[name: string]: unknown;
|
|
10946
|
+
};
|
|
10947
|
+
content?: never;
|
|
10948
|
+
};
|
|
10949
|
+
};
|
|
10950
|
+
parameters: {
|
|
10951
|
+
/** The project to fetch a route from */
|
|
10952
|
+
projectId: string;
|
|
10953
|
+
/**
|
|
10954
|
+
* The path to resolve. Dynamic project map nodes and redirects can be resolved when a matching path is passed.
|
|
10955
|
+
* Query string parameters may be passed with the path. They are ignored for route matching.
|
|
10956
|
+
* If the route matches a composition and the project map node allows passed query string parameters, query parameters will
|
|
10957
|
+
* be returned as as dynamic inputs to the composition.
|
|
10958
|
+
*
|
|
10959
|
+
* Examples:
|
|
10960
|
+
* * route "/company/about-us" would match "/company/about-us" in project map or redirects
|
|
10961
|
+
* * route "/products/123" would match "/products/:productId" in project map or "/products/*" in redirects
|
|
10962
|
+
* * 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
|
|
10963
|
+
*
|
|
10964
|
+
* Conflict resolution:
|
|
10965
|
+
* If a route matches multiple possible project map or redirect nodes, the resulting action will use the following logic:
|
|
10966
|
+
* * If a redirect matches, it wins over project map nodes in all cases
|
|
10967
|
+
* * If multiple redirects or project map nodes match the route, the one with the most specific path wins:
|
|
10968
|
+
* * The route with the most path segments wins
|
|
10969
|
+
* * If several matches have the same number of segments, the one with the fewest dynamic segments wins
|
|
10970
|
+
* * If still ambiguous, the first matching route arbitrarily wins
|
|
10971
|
+
*
|
|
10972
|
+
* Invalid paths:
|
|
10973
|
+
* The request fails with HTTP 400 when the path, ignoring its query string and trailing slashes:
|
|
10974
|
+
* * contains consecutive slashes (for example "/en//about" or "//en/about")
|
|
10975
|
+
* * has a path segment that is too long to match any route. The limit depends on the characters used,
|
|
10976
|
+
* and is generally 150-220 characters per segment.
|
|
10977
|
+
*
|
|
10978
|
+
* Probe paths:
|
|
10979
|
+
* On uniform.global, paths ending in an archive, backup or database file extension (for example "/site.zip",
|
|
10980
|
+
* "/config.php.bak" or "/db.sql") return `{ "type": "notFound" }` without being matched, even where a dynamic
|
|
10981
|
+
* project map node or redirect would match them.
|
|
10982
|
+
*/
|
|
10983
|
+
path: string;
|
|
10984
|
+
/** Specify a project map ID to fetch route from. If not specified, the default project map for the projectId is used */
|
|
10985
|
+
projectMapId: string;
|
|
10986
|
+
/** Publishing state to fetch. 0 = draft, 64 = published */
|
|
10987
|
+
state: number;
|
|
10988
|
+
/**
|
|
10989
|
+
* If true the `_id` unique identifier of each non-root component will be part of the response data.
|
|
10990
|
+
* If false, the `_id` will not be present in the API response
|
|
10991
|
+
*/
|
|
10992
|
+
withComponentIDs: boolean;
|
|
10993
|
+
/**
|
|
10994
|
+
* @deprecated
|
|
10995
|
+
* Has no effect.
|
|
10996
|
+
*/
|
|
10997
|
+
withContentSourceMap: boolean;
|
|
10998
|
+
/**
|
|
10999
|
+
* One or more locales to localize the response to.
|
|
11000
|
+
* When the result is a composition, it includes only the first matching locale's data.
|
|
11001
|
+
* If no matching locale is found, the response will be a not-found result.
|
|
11002
|
+
*
|
|
11003
|
+
* This parameter accepts a single value, a comma-delimited list of values, or the Accept-Language header syntax. Examples:
|
|
11004
|
+
* en-US
|
|
11005
|
+
* fr-CA,fr
|
|
11006
|
+
* de-AT;q=0.9,de-DE;q=0.8,en;q=0.7
|
|
11007
|
+
*
|
|
11008
|
+
* When this parameter is not passed:
|
|
11009
|
+
* - 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.
|
|
11010
|
+
* - Otherwise, all locales' data is returned.
|
|
11011
|
+
*
|
|
11012
|
+
* When the result is a redirect, this parameter has no effect
|
|
11013
|
+
*/
|
|
11014
|
+
locale: string;
|
|
11015
|
+
/**
|
|
11016
|
+
* The ID of a release to fetch the content for.
|
|
11017
|
+
*
|
|
11018
|
+
* - When unspecified, all release content is excluded from the result(s).
|
|
11019
|
+
* - 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.
|
|
11020
|
+
*
|
|
11021
|
+
* 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
|
|
11022
|
+
*/
|
|
11023
|
+
releaseId: string;
|
|
11024
|
+
/**
|
|
11025
|
+
* Indicates the data variant that was fetched for data resources.
|
|
11026
|
+
* undefined: Data resources were resolved using published data from their data source
|
|
11027
|
+
* 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.
|
|
11028
|
+
*/
|
|
11029
|
+
dataSourceVariant: "unpublished";
|
|
11030
|
+
/**
|
|
11031
|
+
* When true, redirects are not evaluated for the route matching; the result will be either a composition or not found.
|
|
11032
|
+
* Note: this is always true when state=63 (internal RSC editor state) to allow contextual editing of compositions
|
|
11033
|
+
* that have redirects configured on their paths.
|
|
11034
|
+
*/
|
|
11035
|
+
ignoreRedirects: boolean;
|
|
11036
|
+
};
|
|
11037
|
+
requestBodies: never;
|
|
11038
|
+
headers: never;
|
|
11039
|
+
pathItems: never;
|
|
11040
|
+
}
|
|
11041
|
+
|
|
11042
|
+
interface paths$a {
|
|
11043
|
+
"/api/v1/views": {
|
|
11044
|
+
parameters: {
|
|
11045
|
+
query?: never;
|
|
11046
|
+
header?: never;
|
|
11047
|
+
path?: never;
|
|
11048
|
+
cookie?: never;
|
|
10967
11049
|
};
|
|
10968
|
-
/**
|
|
10969
|
-
|
|
10970
|
-
|
|
10971
|
-
|
|
10972
|
-
|
|
10973
|
-
|
|
10974
|
-
|
|
10975
|
-
|
|
10976
|
-
|
|
10977
|
-
|
|
10978
|
-
|
|
10979
|
-
|
|
10980
|
-
|
|
10981
|
-
|
|
10982
|
-
|
|
10983
|
-
|
|
10984
|
-
permissions: {
|
|
10985
|
-
[key: string]: components$a["schemas"]["WorkflowStageTransitionPermission"];
|
|
11050
|
+
/** Lists saved views for a project + resource type. */
|
|
11051
|
+
get: {
|
|
11052
|
+
parameters: {
|
|
11053
|
+
query: {
|
|
11054
|
+
/** Project the views belong to. */
|
|
11055
|
+
projectId: string;
|
|
11056
|
+
/** Resource type these views apply to (e.g. "entry"). */
|
|
11057
|
+
resourceType: "composition" | "compositionPattern" | "component" | "componentPattern" | "entry" | "entryPattern" | "contentType" | "blockType" | "release" | "signal" | "intent" | "audience" | "asset";
|
|
11058
|
+
/** Number of records to skip. */
|
|
11059
|
+
offset?: number | null;
|
|
11060
|
+
/** Maximum number of records to return. */
|
|
11061
|
+
limit?: number;
|
|
11062
|
+
};
|
|
11063
|
+
header?: never;
|
|
11064
|
+
path?: never;
|
|
11065
|
+
cookie?: never;
|
|
10986
11066
|
};
|
|
10987
|
-
|
|
10988
|
-
|
|
10989
|
-
|
|
10990
|
-
|
|
10991
|
-
|
|
10992
|
-
|
|
10993
|
-
|
|
10994
|
-
|
|
10995
|
-
|
|
10996
|
-
|
|
10997
|
-
|
|
10998
|
-
|
|
10999
|
-
|
|
11067
|
+
requestBody?: never;
|
|
11068
|
+
responses: {
|
|
11069
|
+
/** OK */
|
|
11070
|
+
200: {
|
|
11071
|
+
headers: {
|
|
11072
|
+
[name: string]: unknown;
|
|
11073
|
+
};
|
|
11074
|
+
content: {
|
|
11075
|
+
"application/json": {
|
|
11076
|
+
views: {
|
|
11077
|
+
name: string;
|
|
11078
|
+
description?: string;
|
|
11079
|
+
searchTerm?: string;
|
|
11080
|
+
filters: {
|
|
11081
|
+
field: string;
|
|
11082
|
+
dynamicField?: string;
|
|
11083
|
+
operator: string;
|
|
11084
|
+
value: string | string[];
|
|
11085
|
+
}[];
|
|
11086
|
+
sort?: string[];
|
|
11087
|
+
shared: boolean;
|
|
11088
|
+
icon?: string;
|
|
11089
|
+
id: string;
|
|
11090
|
+
projectId: string;
|
|
11091
|
+
/** @enum {string} */
|
|
11092
|
+
resourceType: "composition" | "compositionPattern" | "component" | "componentPattern" | "entry" | "entryPattern" | "contentType" | "blockType" | "release" | "signal" | "intent" | "audience" | "asset";
|
|
11093
|
+
createdBy: string | null;
|
|
11094
|
+
/** Format: date-time */
|
|
11095
|
+
created: string;
|
|
11096
|
+
/** Format: date-time */
|
|
11097
|
+
modified: string;
|
|
11098
|
+
}[];
|
|
11099
|
+
totalCount: number;
|
|
11100
|
+
};
|
|
11101
|
+
};
|
|
11102
|
+
};
|
|
11103
|
+
400: components$a["responses"]["BadRequestError"];
|
|
11104
|
+
401: components$a["responses"]["UnauthorizedError"];
|
|
11105
|
+
403: components$a["responses"]["ForbiddenError"];
|
|
11106
|
+
429: components$a["responses"]["RateLimitError"];
|
|
11107
|
+
500: components$a["responses"]["InternalServerError"];
|
|
11000
11108
|
};
|
|
11001
|
-
/**
|
|
11002
|
-
* When true, transitioning into this stage from a different stage will automatically publish the entity.
|
|
11003
|
-
* If the user making the transition does not have publish permissions to the stage as well as publish permission on the entity, the action will not run.
|
|
11004
|
-
* Setting this to true is equivalent to setting requireValidity to true, as publishing cannot be performed with validation errors.
|
|
11005
|
-
* NOTE: This is not executed by direct API calls. Only the Uniform UI performs this action
|
|
11006
|
-
*/
|
|
11007
|
-
autoPublish?: boolean;
|
|
11008
|
-
/**
|
|
11009
|
-
* When true, transitioning into this stage from a different stage will require the entity to have no validation errors.
|
|
11010
|
-
* If the entity is not valid, the transition will not be allowed.
|
|
11011
|
-
* NOTE: This is not executed by direct API calls. Only the Uniform UI performs this action
|
|
11012
|
-
*/
|
|
11013
|
-
requireValidity?: boolean;
|
|
11014
|
-
/**
|
|
11015
|
-
* Defines transitions to other stages
|
|
11016
|
-
* Every stage must define at least one transition, to avoid creating a workflow that
|
|
11017
|
-
* has a stage that can never be escaped
|
|
11018
|
-
*/
|
|
11019
|
-
transitions: components$a["schemas"]["WorkflowStageTransition"][];
|
|
11020
|
-
/**
|
|
11021
|
-
* Icon name for the stage (e.g. 'chevron-double-right-o')
|
|
11022
|
-
* @defaultValue chevron-double-right-o
|
|
11023
|
-
*/
|
|
11024
|
-
icon?: string;
|
|
11025
|
-
/** Sets the order of the stage when displayed in a list with other stages. If not set, the order defaults to alphabetical with any explicitly set orders first in the list */
|
|
11026
|
-
order?: number;
|
|
11027
11109
|
};
|
|
11028
|
-
/**
|
|
11029
|
-
|
|
11030
|
-
|
|
11031
|
-
|
|
11032
|
-
|
|
11033
|
-
|
|
11034
|
-
|
|
11035
|
-
|
|
11036
|
-
|
|
11037
|
-
|
|
11038
|
-
|
|
11039
|
-
|
|
11040
|
-
|
|
11041
|
-
|
|
11042
|
-
|
|
11043
|
-
|
|
11044
|
-
|
|
11110
|
+
/** 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. */
|
|
11111
|
+
put: {
|
|
11112
|
+
parameters: {
|
|
11113
|
+
query?: never;
|
|
11114
|
+
header?: never;
|
|
11115
|
+
path?: never;
|
|
11116
|
+
cookie?: never;
|
|
11117
|
+
};
|
|
11118
|
+
requestBody: {
|
|
11119
|
+
content: {
|
|
11120
|
+
"application/json": {
|
|
11121
|
+
name: string;
|
|
11122
|
+
description?: string;
|
|
11123
|
+
searchTerm?: string;
|
|
11124
|
+
filters: {
|
|
11125
|
+
field: string;
|
|
11126
|
+
dynamicField?: string;
|
|
11127
|
+
operator: string;
|
|
11128
|
+
value: string | string[];
|
|
11129
|
+
}[];
|
|
11130
|
+
sort?: string[];
|
|
11131
|
+
shared: boolean;
|
|
11132
|
+
icon?: string;
|
|
11133
|
+
id: string;
|
|
11134
|
+
projectId: string;
|
|
11135
|
+
/** @enum {string} */
|
|
11136
|
+
resourceType: "composition" | "compositionPattern" | "component" | "componentPattern" | "entry" | "entryPattern" | "contentType" | "blockType" | "release" | "signal" | "intent" | "audience" | "asset";
|
|
11137
|
+
};
|
|
11138
|
+
};
|
|
11139
|
+
};
|
|
11140
|
+
responses: {
|
|
11141
|
+
/** OK */
|
|
11142
|
+
200: {
|
|
11143
|
+
headers: {
|
|
11144
|
+
[name: string]: unknown;
|
|
11145
|
+
};
|
|
11146
|
+
content: {
|
|
11147
|
+
"application/json": {
|
|
11148
|
+
name: string;
|
|
11149
|
+
description?: string;
|
|
11150
|
+
searchTerm?: string;
|
|
11151
|
+
filters: {
|
|
11152
|
+
field: string;
|
|
11153
|
+
dynamicField?: string;
|
|
11154
|
+
operator: string;
|
|
11155
|
+
value: string | string[];
|
|
11156
|
+
}[];
|
|
11157
|
+
sort?: string[];
|
|
11158
|
+
shared: boolean;
|
|
11159
|
+
icon?: string;
|
|
11160
|
+
id: string;
|
|
11161
|
+
projectId: string;
|
|
11162
|
+
/** @enum {string} */
|
|
11163
|
+
resourceType: "composition" | "compositionPattern" | "component" | "componentPattern" | "entry" | "entryPattern" | "contentType" | "blockType" | "release" | "signal" | "intent" | "audience" | "asset";
|
|
11164
|
+
createdBy: string | null;
|
|
11165
|
+
/** Format: date-time */
|
|
11166
|
+
created: string;
|
|
11167
|
+
/** Format: date-time */
|
|
11168
|
+
modified: string;
|
|
11169
|
+
};
|
|
11170
|
+
};
|
|
11171
|
+
};
|
|
11172
|
+
400: components$a["responses"]["BadRequestError"];
|
|
11173
|
+
401: components$a["responses"]["UnauthorizedError"];
|
|
11174
|
+
403: components$a["responses"]["ForbiddenError"];
|
|
11175
|
+
/** View not found (or belongs to another project). */
|
|
11176
|
+
404: {
|
|
11177
|
+
headers: {
|
|
11178
|
+
[name: string]: unknown;
|
|
11179
|
+
};
|
|
11180
|
+
content?: never;
|
|
11181
|
+
};
|
|
11182
|
+
/** Quota exceeded: at most 100 saved views allowed for this project + resource type + user. Remove an existing view before creating a new one. */
|
|
11183
|
+
409: {
|
|
11184
|
+
headers: {
|
|
11185
|
+
[name: string]: unknown;
|
|
11186
|
+
};
|
|
11187
|
+
content?: never;
|
|
11188
|
+
};
|
|
11189
|
+
429: components$a["responses"]["RateLimitError"];
|
|
11190
|
+
500: components$a["responses"]["InternalServerError"];
|
|
11045
11191
|
};
|
|
11046
|
-
/** Last modified ISO date string for this definition (ignored for writes) */
|
|
11047
|
-
modified?: string;
|
|
11048
|
-
/** Created ISO date string for this definition (ignored for writes) */
|
|
11049
|
-
created?: string;
|
|
11050
|
-
/**
|
|
11051
|
-
* Name of the original creator of the workflow.
|
|
11052
|
-
* If undefined, the user has been removed from the team.
|
|
11053
|
-
* Ignored for writes
|
|
11054
|
-
*/
|
|
11055
|
-
createdBy?: string;
|
|
11056
|
-
/**
|
|
11057
|
-
* Name of the last modifier of the workflow.
|
|
11058
|
-
* If undefined, the user has been removed from the team.
|
|
11059
|
-
* Ignored for writes
|
|
11060
|
-
*/
|
|
11061
|
-
modifiedBy?: string;
|
|
11062
|
-
};
|
|
11063
|
-
CompositionApiResponse: {
|
|
11064
|
-
/** Publishing state to fetch. 0 = draft, 64 = published */
|
|
11065
|
-
state: number;
|
|
11066
|
-
/**
|
|
11067
|
-
* @deprecated
|
|
11068
|
-
* UI status value. Subject to change without notice; do not rely on this value. Present only when `withUIStatus` is true
|
|
11069
|
-
|
|
11070
|
-
*/
|
|
11071
|
-
uiStatus?: "Draft" | "Modified" | "Published" | "Orphan" | "Previous" | "Unknown";
|
|
11072
|
-
/**
|
|
11073
|
-
* Format: uuid
|
|
11074
|
-
* The project ID this composition is part of
|
|
11075
|
-
*/
|
|
11076
|
-
projectId: string;
|
|
11077
|
-
/**
|
|
11078
|
-
* Format: date-time
|
|
11079
|
-
* Created date string for this composition
|
|
11080
|
-
*/
|
|
11081
|
-
created: string;
|
|
11082
|
-
/**
|
|
11083
|
-
* Format: date-time
|
|
11084
|
-
* Modified date string for this composition
|
|
11085
|
-
*/
|
|
11086
|
-
modified: string;
|
|
11087
|
-
/**
|
|
11088
|
-
* Format: date-time
|
|
11089
|
-
* Timestamp when the item was moved to trash. Omitted if not in trash.
|
|
11090
|
-
*/
|
|
11091
|
-
deletedAt?: string;
|
|
11092
|
-
/** User name of the creator of this composition */
|
|
11093
|
-
creator?: string;
|
|
11094
|
-
/** User name of the last editor of this composition */
|
|
11095
|
-
author?: string;
|
|
11096
|
-
/**
|
|
11097
|
-
* Format: uuid
|
|
11098
|
-
* Reference to the category this component definition belongs to
|
|
11099
|
-
*/
|
|
11100
|
-
categoryId?: string;
|
|
11101
|
-
/** A description of the component definition */
|
|
11102
|
-
description?: string;
|
|
11103
|
-
/** A preview image URL of the component definition */
|
|
11104
|
-
previewImageUrl?: string;
|
|
11105
|
-
/** Indicates if the composition is a pattern that can be referenced in other compositions */
|
|
11106
|
-
pattern: boolean;
|
|
11107
|
-
/**
|
|
11108
|
-
* If the instance is a pattern, this indicates if it's a component pattern or a composition pattern
|
|
11109
|
-
|
|
11110
|
-
*/
|
|
11111
|
-
patternType?: "component" | "composition";
|
|
11112
|
-
/**
|
|
11113
|
-
* Format: uuid
|
|
11114
|
-
* The release this composition belongs to. If not set, it belongs to the base
|
|
11115
|
-
*/
|
|
11116
|
-
releaseId?: string;
|
|
11117
|
-
composition: components$a["schemas"]["RootComponentInstance"];
|
|
11118
|
-
/**
|
|
11119
|
-
* Format: uuid
|
|
11120
|
-
* The workflow ID assigned to this composition, if any. Normally comes from the component definition
|
|
11121
|
-
*/
|
|
11122
|
-
workflowId?: string;
|
|
11123
|
-
/**
|
|
11124
|
-
* Format: uuid
|
|
11125
|
-
* The stage ID the composition is in within its assigned workflow. If undefined, it is implicitly in the initial stage of the workflow
|
|
11126
|
-
*/
|
|
11127
|
-
workflowStageId?: string;
|
|
11128
|
-
/**
|
|
11129
|
-
* Format: uuid
|
|
11130
|
-
* The workflow that compositions created from this pattern start in. This is not the
|
|
11131
|
-
* workflow the pattern itself is in, which is `workflowId`. Only ever set on composition patterns.
|
|
11132
|
-
*/
|
|
11133
|
-
instanceWorkflowId?: string;
|
|
11134
|
-
/** The full definition of the assigned workflow, if any, including stages, permissions, etc. Returned only when `withWorkflowDefinition` is true */
|
|
11135
|
-
workflowDefinition?: components$a["schemas"]["WorkflowDefinition"];
|
|
11136
|
-
/**
|
|
11137
|
-
* Format: uuid
|
|
11138
|
-
* The edition ID. When set, this is a child edition of the composition in _id.
|
|
11139
|
-
*/
|
|
11140
|
-
editionId?: string;
|
|
11141
|
-
/**
|
|
11142
|
-
* The name of the composition or edition as shown in the editions listing.
|
|
11143
|
-
* Describes the purpose of an edition.
|
|
11144
|
-
*/
|
|
11145
|
-
editionName?: string;
|
|
11146
|
-
/**
|
|
11147
|
-
* The priority of the edition or composition. Higher numbers are higher priority.
|
|
11148
|
-
* When multiple editions enable the same locale, the highest priority edition is used.
|
|
11149
|
-
*/
|
|
11150
|
-
editionPriority?: number;
|
|
11151
11192
|
};
|
|
11152
|
-
|
|
11153
|
-
|
|
11154
|
-
|
|
11155
|
-
|
|
11156
|
-
|
|
11157
|
-
|
|
11158
|
-
|
|
11159
|
-
|
|
11160
|
-
|
|
11161
|
-
|
|
11162
|
-
|
|
11163
|
-
|
|
11164
|
-
|
|
11165
|
-
|
|
11166
|
-
|
|
11167
|
-
|
|
11168
|
-
|
|
11169
|
-
|
|
11193
|
+
post?: never;
|
|
11194
|
+
/** Deletes a saved view by id. */
|
|
11195
|
+
delete: {
|
|
11196
|
+
parameters: {
|
|
11197
|
+
query?: never;
|
|
11198
|
+
header?: never;
|
|
11199
|
+
path?: never;
|
|
11200
|
+
cookie?: never;
|
|
11201
|
+
};
|
|
11202
|
+
requestBody: {
|
|
11203
|
+
content: {
|
|
11204
|
+
"application/json": {
|
|
11205
|
+
id: string;
|
|
11206
|
+
projectId: string;
|
|
11207
|
+
};
|
|
11208
|
+
};
|
|
11209
|
+
};
|
|
11210
|
+
responses: {
|
|
11211
|
+
/** No Content */
|
|
11212
|
+
204: {
|
|
11213
|
+
headers: {
|
|
11214
|
+
[name: string]: unknown;
|
|
11215
|
+
};
|
|
11216
|
+
content: {
|
|
11217
|
+
"application/json": string;
|
|
11218
|
+
};
|
|
11219
|
+
};
|
|
11220
|
+
400: components$a["responses"]["BadRequestError"];
|
|
11221
|
+
401: components$a["responses"]["UnauthorizedError"];
|
|
11222
|
+
403: components$a["responses"]["ForbiddenError"];
|
|
11223
|
+
/** View not found. */
|
|
11224
|
+
404: {
|
|
11225
|
+
headers: {
|
|
11226
|
+
[name: string]: unknown;
|
|
11227
|
+
};
|
|
11228
|
+
content?: never;
|
|
11229
|
+
};
|
|
11230
|
+
429: components$a["responses"]["RateLimitError"];
|
|
11231
|
+
500: components$a["responses"]["InternalServerError"];
|
|
11232
|
+
};
|
|
11170
11233
|
};
|
|
11171
|
-
/**
|
|
11172
|
-
|
|
11173
|
-
|
|
11174
|
-
|
|
11175
|
-
|
|
11176
|
-
|
|
11177
|
-
|
|
11178
|
-
|
|
11234
|
+
/** Handles preflight requests. This endpoint allows CORS. */
|
|
11235
|
+
options: {
|
|
11236
|
+
parameters: {
|
|
11237
|
+
query?: never;
|
|
11238
|
+
header?: never;
|
|
11239
|
+
path?: never;
|
|
11240
|
+
cookie?: never;
|
|
11241
|
+
};
|
|
11242
|
+
requestBody?: never;
|
|
11243
|
+
responses: {
|
|
11244
|
+
/** ok */
|
|
11245
|
+
204: {
|
|
11246
|
+
headers: {
|
|
11247
|
+
[name: string]: unknown;
|
|
11248
|
+
};
|
|
11249
|
+
content?: never;
|
|
11250
|
+
};
|
|
11251
|
+
};
|
|
11179
11252
|
};
|
|
11180
|
-
|
|
11253
|
+
head?: never;
|
|
11254
|
+
patch?: never;
|
|
11255
|
+
trace?: never;
|
|
11256
|
+
};
|
|
11257
|
+
}
|
|
11258
|
+
interface components$a {
|
|
11259
|
+
schemas: {
|
|
11181
11260
|
Error: {
|
|
11182
11261
|
/** Error message(s) that occurred while processing the request */
|
|
11183
11262
|
errorMessage?: string[] | string;
|
|
@@ -11226,102 +11305,28 @@ interface components$a {
|
|
|
11226
11305
|
content?: never;
|
|
11227
11306
|
};
|
|
11228
11307
|
};
|
|
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
|
-
};
|
|
11308
|
+
parameters: never;
|
|
11316
11309
|
requestBodies: never;
|
|
11317
11310
|
headers: never;
|
|
11318
11311
|
pathItems: never;
|
|
11319
11312
|
}
|
|
11320
11313
|
|
|
11321
|
-
type
|
|
11314
|
+
type ViewsApi = paths$a['/api/v1/views'];
|
|
11315
|
+
type ViewsQuery = ViewsApi['get']['parameters']['query'];
|
|
11316
|
+
type ViewPut = ViewsApi['put']['requestBody']['content']['application/json'];
|
|
11317
|
+
type ViewDelete = ViewsApi['delete']['requestBody']['content']['application/json'];
|
|
11318
|
+
type ViewsResponse = ViewsApi['get']['responses']['200']['content']['application/json'];
|
|
11319
|
+
type View = ViewsResponse['views'][number];
|
|
11320
|
+
/**
|
|
11321
|
+
* File/sync shape for a shared custom view. Audit fields and `projectId` are
|
|
11322
|
+
* stripped on pull; `id` is kept so PUT is create-or-replace across projects.
|
|
11323
|
+
*/
|
|
11324
|
+
type SerializedCustomView = Omit<View, 'projectId' | 'createdBy' | 'created' | 'modified'>;
|
|
11325
|
+
|
|
11326
|
+
type Components = components$e['schemas'];
|
|
11322
11327
|
type SharedComponents$1 = components$r['schemas'];
|
|
11323
|
-
type Api = paths$
|
|
11324
|
-
type HistoryApi = paths$
|
|
11328
|
+
type Api = paths$d['/api/v1/canvas'];
|
|
11329
|
+
type HistoryApi = paths$c['/api/v1/canvas-history'];
|
|
11325
11330
|
/** Query parameter options for GET /api/v1/canvas */
|
|
11326
11331
|
type CompositionGetParameters = Omit<Api['get']['parameters']['query'], 'type'> & {
|
|
11327
11332
|
type?: string | string[];
|
|
@@ -11440,6 +11445,37 @@ type CopiedComponentSubtree = {
|
|
|
11440
11445
|
* Defines how a component on a pattern may have its values overridden
|
|
11441
11446
|
*/
|
|
11442
11447
|
type ComponentOverridability = SharedComponents$1['ComponentOverridability'];
|
|
11448
|
+
interface EndpointOut {
|
|
11449
|
+
channels?: string[] | null;
|
|
11450
|
+
createdAt: Date;
|
|
11451
|
+
description: string;
|
|
11452
|
+
disabled?: boolean;
|
|
11453
|
+
filterTypes?: string[] | null;
|
|
11454
|
+
id: string;
|
|
11455
|
+
metadata: {
|
|
11456
|
+
[key: string]: string;
|
|
11457
|
+
};
|
|
11458
|
+
rateLimit?: number | null;
|
|
11459
|
+
throttleRate?: number | null;
|
|
11460
|
+
uid?: string | null;
|
|
11461
|
+
updatedAt: Date;
|
|
11462
|
+
url: string;
|
|
11463
|
+
version: number;
|
|
11464
|
+
}
|
|
11465
|
+
interface EndpointHeadersOut {
|
|
11466
|
+
headers: {
|
|
11467
|
+
[key: string]: string;
|
|
11468
|
+
};
|
|
11469
|
+
sensitive: string[];
|
|
11470
|
+
}
|
|
11471
|
+
interface EndpointTransformationOut {
|
|
11472
|
+
code?: string | null;
|
|
11473
|
+
enabled?: boolean;
|
|
11474
|
+
updatedAt?: Date | null;
|
|
11475
|
+
variables?: {
|
|
11476
|
+
[key: string]: string;
|
|
11477
|
+
} | null;
|
|
11478
|
+
}
|
|
11443
11479
|
/**
|
|
11444
11480
|
* Defines the shape of serialized webhook
|
|
11445
11481
|
*/
|
|
@@ -11510,7 +11546,7 @@ type DataResolutionParameters = {
|
|
|
11510
11546
|
};
|
|
11511
11547
|
/** Types of issue that can occur when fetching composition data */
|
|
11512
11548
|
type DataResolutionIssue = PatternIssue | DataResourceIssue | MaxDepthExceededIssue | DataElementBindingIssue | DynamicInputIssue | DataResolutionConfigIssue;
|
|
11513
|
-
type DataResolutionIssueCore = components$
|
|
11549
|
+
type DataResolutionIssueCore = components$c['schemas']['DataResolutionIssue'];
|
|
11514
11550
|
/** An error that occured resolving a pattern that is referenced on the composition */
|
|
11515
11551
|
type PatternIssue = DataResolutionIssueCore & {
|
|
11516
11552
|
type: 'pattern';
|
|
@@ -11564,26 +11600,26 @@ type DataResolutionConfigIssue = {
|
|
|
11564
11600
|
type: 'config';
|
|
11565
11601
|
};
|
|
11566
11602
|
/** Diagnostics about edge request processing */
|
|
11567
|
-
type EdgehancersDiagnostics = components$
|
|
11568
|
-
type EdgehancersWholeResponseCacheDiagnostics = components$
|
|
11603
|
+
type EdgehancersDiagnostics = components$c['schemas']['EdgehancersDiagnostics'];
|
|
11604
|
+
type EdgehancersWholeResponseCacheDiagnostics = components$c['schemas']['EdgehancersResolutionInfo']['wholeResponseCacheDiagnostics'];
|
|
11569
11605
|
/** Diagnostic data about the load performance of attached composition datas */
|
|
11570
|
-
type DataDiagnostic = components$
|
|
11606
|
+
type DataDiagnostic = components$c['schemas']['DataDiagnostic'];
|
|
11571
11607
|
/** Response as it comes from uniform.global/api/v1/composition */
|
|
11572
|
-
type CompositionResolvedGetResponse = components$
|
|
11573
|
-
type CompositionResolvedListResponse = components$
|
|
11608
|
+
type CompositionResolvedGetResponse = components$c['schemas']['CompositionResolvedGetResponse'];
|
|
11609
|
+
type CompositionResolvedListResponse = components$c['schemas']['CompositionResolvedListResponse'];
|
|
11574
11610
|
/** All valid response types */
|
|
11575
11611
|
type CompositionGetValidResponses = CompositionGetResponse | CompositionResolvedGetResponse;
|
|
11576
11612
|
/** 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$
|
|
11613
|
+
type RouteGetParameters = paths$b['/api/v1/route']['get']['parameters']['query'] & DataResolutionParameters;
|
|
11614
|
+
type RouteGetResponse = components$f['schemas']['RouteResponse'];
|
|
11615
|
+
type RouteGetResponseComposition = components$f['schemas']['RouteResponseComposition'];
|
|
11616
|
+
type RouteGetResponseRedirect = components$f['schemas']['RouteResponseRedirect'];
|
|
11617
|
+
type RouteGetResponseNotFound = components$f['schemas']['RouteResponseNotFound'];
|
|
11618
|
+
type RouteDynamicInputs = components$f['schemas']['RouteDynamicInputs'];
|
|
11583
11619
|
/** The GET response from /api/v1/entries */
|
|
11584
11620
|
type EntriesGetParameters = paths$l['/api/v1/entries']['get']['parameters']['query'] & DataResolutionParameters;
|
|
11585
11621
|
type EntriesGetResponse = components$p['schemas']['EntryListResponse'];
|
|
11586
|
-
type EntriesResolvedListResponse = components$
|
|
11622
|
+
type EntriesResolvedListResponse = components$c['schemas']['EntryResolvedListResponse'];
|
|
11587
11623
|
/** GET response from uniform.global/api/v1/route when result is a composition */
|
|
11588
11624
|
type RouteGetResponseEdgehancedComposition = Omit<RouteGetResponseComposition, 'compositionApiResponse'> & {
|
|
11589
11625
|
compositionApiResponse: CompositionResolvedGetResponse;
|
|
@@ -12198,7 +12234,7 @@ type IntegrationPropertyEditorsGetResponse = paths$9['/api/v1/integration-proper
|
|
|
12198
12234
|
type IntegrationPropertyEditorsPutParameters = paths$9['/api/v1/integration-property-editors']['put']['requestBody']['content']['application/json'];
|
|
12199
12235
|
type IntegrationPropertyEditorsDeleteParameters = paths$9['/api/v1/integration-property-editors']['delete']['requestBody']['content']['application/json'];
|
|
12200
12236
|
|
|
12201
|
-
type schemas = components$
|
|
12237
|
+
type schemas = components$c['schemas'];
|
|
12202
12238
|
type InvalidationPayload = schemas['InvalidationPayload'];
|
|
12203
12239
|
type BatchInvalidationPayload = schemas['BatchInvalidationPayload'];
|
|
12204
12240
|
|
|
@@ -16219,169 +16255,7 @@ declare function hasReferencedVariables(value: string | undefined): number;
|
|
|
16219
16255
|
*/
|
|
16220
16256
|
declare function parseVariableExpression(serialized: string, onToken?: (token: string, type: 'text' | 'variable', offset: number) => void | false): number;
|
|
16221
16257
|
|
|
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";
|
|
16258
|
+
declare const version = "20.87.0";
|
|
16385
16259
|
|
|
16386
16260
|
/** API client to enable managing workflow definitions */
|
|
16387
16261
|
declare class WorkflowClient extends ApiClient {
|
|
@@ -16404,4 +16278,4 @@ declare class WorkflowClient extends ApiClient {
|
|
|
16404
16278
|
|
|
16405
16279
|
declare const CanvasClientError: typeof ApiClientError;
|
|
16406
16280
|
|
|
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 };
|
|
16281
|
+
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 };
|