@uniformdev/canvas 20.86.1-alpha.3.sha-954b5d18f0 → 20.87.1-alpha.16.sha-e5d136cbc1
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 +756 -890
- package/dist/index.d.ts +756 -890
- package/dist/index.esm.js +2 -239
- package/dist/index.js +3 -248
- package/dist/index.mjs +2 -239
- package/package.json +7 -6
package/dist/index.d.mts
CHANGED
|
@@ -2,7 +2,6 @@ import { ApiClient, ClientOptions, ExceptProject, ApiClientError } from '@unifor
|
|
|
2
2
|
export { ApiClientError } from '@uniformdev/context/api';
|
|
3
3
|
import { AssetGetResponseSingle, AssetDefinitionType, AssetParamValue, AssetParamValueItem } from '@uniformdev/assets';
|
|
4
4
|
export { AssetParamValue, AssetParamValueItem } from '@uniformdev/assets';
|
|
5
|
-
import { EndpointOut, EndpointHeadersOut, EndpointTransformationOut } from 'svix';
|
|
6
5
|
import { Quirks, StorageCommands, PersonalizedVariant, VariationMatchMetadata, TestVariant } from '@uniformdev/context';
|
|
7
6
|
import { Options as Options$1 } from 'p-retry';
|
|
8
7
|
import { Options } from 'p-throttle';
|
|
@@ -1941,8 +1940,6 @@ declare const CANVAS_TEST_TYPE = "$test";
|
|
|
1941
1940
|
declare const CANVAS_LOCALIZATION_TYPE = "$localization";
|
|
1942
1941
|
/** Public ID of Canvas slot section component type */
|
|
1943
1942
|
declare const CANVAS_SLOT_SECTION_TYPE = "$slotSection";
|
|
1944
|
-
/** Public ID of Canvas loop component type */
|
|
1945
|
-
declare const CANVAS_LOOP_TYPE = "$loop";
|
|
1946
1943
|
/** Public ID of the intent tag parameter on the Canvas personalization component type */
|
|
1947
1944
|
declare const CANVAS_INTENT_TAG_PARAM = "intentTag";
|
|
1948
1945
|
/** Public ID of the locale parameter on Canvas components */
|
|
@@ -1957,12 +1954,6 @@ declare const CANVAS_TEST_SLOT = "test";
|
|
|
1957
1954
|
declare const CANVAS_LOCALIZATION_SLOT = "localized";
|
|
1958
1955
|
/** Name of the slot on CANVAS_SLOT_SECTION_TYPE */
|
|
1959
1956
|
declare const CANVAS_SLOT_SECTION_SLOT = "$slotSectionItems";
|
|
1960
|
-
/** Name of the slot that CANVAS_LOOP_TYPE exposes for the iterator body */
|
|
1961
|
-
declare const CANVAS_LOOP_SLOT = "body";
|
|
1962
|
-
/** Name of data type that is a derived loop */
|
|
1963
|
-
declare const CANVAS_LOOP_DATA_TYPE = "sys-reserved-loop";
|
|
1964
|
-
/** Name of data type that is a derived alias */
|
|
1965
|
-
declare const CANVAS_ALIAS_DATA_TYPE = "sys-reserved-alias";
|
|
1966
1957
|
/** Name of the 'name' parameter on CANVAS_SLOT_SECTION_TYPE */
|
|
1967
1958
|
declare const CANVAS_SLOT_SECTION_NAME_PARAM = "name";
|
|
1968
1959
|
/** Name of the 'min' parameter on CANVAS_SLOT_SECTION_TYPE */
|
|
@@ -2226,6 +2217,8 @@ interface components$p {
|
|
|
2226
2217
|
* Timestamp when the item was moved to trash. Omitted if not in trash.
|
|
2227
2218
|
*/
|
|
2228
2219
|
deletedAt?: string;
|
|
2220
|
+
/** Present when the item is in trash, omitted otherwise. True when the item was published with no unpublished changes at the moment it was trashed. False otherwise, including items trashed before this field existed. */
|
|
2221
|
+
publishedWhenTrashed?: boolean;
|
|
2229
2222
|
/**
|
|
2230
2223
|
* True if the entry is a pattern (which can be referenced on other entries)
|
|
2231
2224
|
* @defaultValue false
|
|
@@ -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.
|
|
@@ -7123,10 +6836,8 @@ interface components$e {
|
|
|
7123
6836
|
* * If still ambiguous, the first matching route arbitrarily wins
|
|
7124
6837
|
*
|
|
7125
6838
|
* Invalid paths:
|
|
7126
|
-
* The request fails with HTTP 400 when the path, ignoring its query string and trailing slashes
|
|
7127
|
-
*
|
|
7128
|
-
* * has a path segment that is too long to match any route. The limit depends on the characters used,
|
|
7129
|
-
* and is generally 150-220 characters per segment.
|
|
6839
|
+
* The request fails with HTTP 400 when the path, ignoring its query string and trailing slashes,
|
|
6840
|
+
* contains consecutive slashes (for example "/en//about" or "//en/about").
|
|
7130
6841
|
*
|
|
7131
6842
|
* Probe paths:
|
|
7132
6843
|
* On uniform.global, paths ending in an archive, backup or database file extension (for example "/site.zip",
|
|
@@ -7192,7 +6903,7 @@ interface components$e {
|
|
|
7192
6903
|
pathItems: never;
|
|
7193
6904
|
}
|
|
7194
6905
|
|
|
7195
|
-
interface paths$
|
|
6906
|
+
interface paths$d {
|
|
7196
6907
|
"/api/v1/canvas": {
|
|
7197
6908
|
parameters: {
|
|
7198
6909
|
query?: never;
|
|
@@ -7314,56 +7025,56 @@ interface paths$c {
|
|
|
7314
7025
|
* This is a primary query parameter and cannot be used with any other primary query parameters.
|
|
7315
7026
|
* When `editions=raw`, this parameter matches on composition or edition IDs and edition resolution is disabled.
|
|
7316
7027
|
*/
|
|
7317
|
-
compositionId?: components$
|
|
7028
|
+
compositionId?: components$e["parameters"]["compositionId"];
|
|
7318
7029
|
/**
|
|
7319
7030
|
* Specify a single component ID to fetch the component's composition defaults. The response will be a single composition.
|
|
7320
7031
|
* This is a primary query parameter and cannot be used with any other primary query parameters
|
|
7321
7032
|
*/
|
|
7322
|
-
componentId?: components$
|
|
7033
|
+
componentId?: components$e["parameters"]["componentId"];
|
|
7323
7034
|
/**
|
|
7324
7035
|
* Specify a historical composition version ID to fetch (retrieved from the canvas-history API).
|
|
7325
7036
|
* Must be used with the `compositionId` parameter
|
|
7326
7037
|
*/
|
|
7327
|
-
versionId?: components$
|
|
7038
|
+
versionId?: components$e["parameters"]["versionId"];
|
|
7328
7039
|
/**
|
|
7329
7040
|
* Specify multiple composition IDs to fetch. The response type will be a list.
|
|
7330
7041
|
* This is a primary query parameter and cannot be used with any other primary query parameters.
|
|
7331
7042
|
* When `editions=raw`, this parameter matches on composition or edition IDs and edition resolution is disabled.
|
|
7332
7043
|
*/
|
|
7333
|
-
compositionIDs?: components$
|
|
7044
|
+
compositionIDs?: components$e["parameters"]["compositionIDs"];
|
|
7334
7045
|
/**
|
|
7335
7046
|
* Filters composition lists by the user who created them. The user is specified by their identity subject.
|
|
7336
7047
|
* This is a list query parameter and cannot be used with any primary query parameters
|
|
7337
7048
|
*/
|
|
7338
|
-
createdBy?: components$
|
|
7049
|
+
createdBy?: components$e["parameters"]["createdBy"];
|
|
7339
7050
|
/**
|
|
7340
7051
|
* Matches compositions where their name, slug, or definition name contains the specified keyword.
|
|
7341
7052
|
* NOT a full-text search; does not match composition contents.
|
|
7342
7053
|
* This is a list query parameter and cannot be used with any primary query parameters
|
|
7343
7054
|
*/
|
|
7344
|
-
keyword?: components$
|
|
7055
|
+
keyword?: components$e["parameters"]["keyword"];
|
|
7345
7056
|
/**
|
|
7346
7057
|
* Maximum number of records to return
|
|
7347
7058
|
* This is a list query parameter and cannot be used with any primary query parameters
|
|
7348
7059
|
*/
|
|
7349
|
-
limit?: components$
|
|
7060
|
+
limit?: components$e["parameters"]["limit"];
|
|
7350
7061
|
/**
|
|
7351
7062
|
* Number of records to skip
|
|
7352
7063
|
* This is a list query parameter and cannot be used with any primary query parameters
|
|
7353
7064
|
*/
|
|
7354
|
-
offset?: components$
|
|
7065
|
+
offset?: components$e["parameters"]["offset"];
|
|
7355
7066
|
/**
|
|
7356
7067
|
* Sets the sorting of the results. If unspecified, results are sorted by name ascending.
|
|
7357
7068
|
* Allowed values are: updated_at_DESC, updated_at_ASC, created_at_DESC, created_at_ASC,
|
|
7358
7069
|
* name_DESC, name_ASC, slug_DESC, slug_ASC.
|
|
7359
7070
|
* When using primary query parameters, this parameter is ignored
|
|
7360
7071
|
*/
|
|
7361
|
-
orderBy?: components$
|
|
7072
|
+
orderBy?: components$e["parameters"]["orderBy"];
|
|
7362
7073
|
/**
|
|
7363
7074
|
* @deprecated
|
|
7364
7075
|
* Returns counts for distinct values of the specified field or fields (provided as comma-separated IDs).
|
|
7365
7076
|
*/
|
|
7366
|
-
facetBy?: components$
|
|
7077
|
+
facetBy?: components$e["parameters"]["facetBy"];
|
|
7367
7078
|
/**
|
|
7368
7079
|
* Matches compositions based on whether they are a pattern composition or a regular composition.
|
|
7369
7080
|
* If true, only pattern compositions will be returned.
|
|
@@ -7371,44 +7082,44 @@ interface paths$c {
|
|
|
7371
7082
|
* If omitted or 'any', both pattern and regular compositions will be returned.
|
|
7372
7083
|
* This is a list query parameter and cannot be used with any primary query parameters
|
|
7373
7084
|
*/
|
|
7374
|
-
pattern?: components$
|
|
7085
|
+
pattern?: components$e["parameters"]["pattern"];
|
|
7375
7086
|
/**
|
|
7376
7087
|
* This specifies which type of patterns to return. This query parameter has no effect when `pattern` is false.
|
|
7377
7088
|
* * `all` - Returns all pattern instances
|
|
7378
7089
|
* * `component` - Returns only component patterns
|
|
7379
7090
|
* * `composition` - Returns only composition patterns
|
|
7380
7091
|
*/
|
|
7381
|
-
patternType?: components$
|
|
7092
|
+
patternType?: components$e["parameters"]["patternType"];
|
|
7382
7093
|
/**
|
|
7383
7094
|
* @deprecated
|
|
7384
7095
|
* Includes the `patternType` attribute in the response
|
|
7385
7096
|
*/
|
|
7386
|
-
withPatternType?: components$
|
|
7097
|
+
withPatternType?: components$e["parameters"]["withPatternType"];
|
|
7387
7098
|
/** The project the composition(s) belong to */
|
|
7388
|
-
projectId: components$
|
|
7099
|
+
projectId: components$e["parameters"]["projectId"];
|
|
7389
7100
|
/**
|
|
7390
7101
|
* Specify a project map ID to fetch by path or node ID from.
|
|
7391
7102
|
* If not specified, the default project map for the projectId is used.
|
|
7392
7103
|
* Only used when fetching by projectMapNodeId or projectMapNodePath
|
|
7393
7104
|
*/
|
|
7394
|
-
projectMapId?: components$
|
|
7105
|
+
projectMapId?: components$e["parameters"]["projectMapId"];
|
|
7395
7106
|
/**
|
|
7396
7107
|
* Specify a single composition to fetch by associated project map node ID. The response will be a single composition.
|
|
7397
7108
|
* This is a primary query parameter and cannot be used with any other primary query parameters
|
|
7398
7109
|
*/
|
|
7399
|
-
projectMapNodeId?: components$
|
|
7110
|
+
projectMapNodeId?: components$e["parameters"]["projectMapNodeId"];
|
|
7400
7111
|
/**
|
|
7401
7112
|
* Specify a single composition to fetch by associated project map node path. The response will be a single composition.
|
|
7402
7113
|
* This is a primary query parameter and cannot be used with any other primary query parameters
|
|
7403
7114
|
*/
|
|
7404
|
-
projectMapNodePath?: components$
|
|
7115
|
+
projectMapNodePath?: components$e["parameters"]["projectMapNodePath"];
|
|
7405
7116
|
/**
|
|
7406
7117
|
* @deprecated
|
|
7407
7118
|
* Signals an enhancer proxy to skip processing enhancements to the data and return raw data only.
|
|
7408
7119
|
* This improves performance if you do not require enhanced component data.
|
|
7409
7120
|
* If calling the Canvas API directly with no enhancer proxy, this has no effect
|
|
7410
7121
|
*/
|
|
7411
|
-
skipEnhance?: components$
|
|
7122
|
+
skipEnhance?: components$e["parameters"]["skipEnhance"];
|
|
7412
7123
|
/**
|
|
7413
7124
|
* If true, any pattern references in the composition will be left unresolved.
|
|
7414
7125
|
* This is appropriate if you intend to serialize the composition without patterns
|
|
@@ -7416,12 +7127,12 @@ interface paths$c {
|
|
|
7416
7127
|
* Default: true when `format` is canonical. False otherwise.
|
|
7417
7128
|
* Prefer selecting a `format` rather than using this option.
|
|
7418
7129
|
*/
|
|
7419
|
-
skipPatternResolution?: components$
|
|
7130
|
+
skipPatternResolution?: components$e["parameters"]["skipPatternResolution"];
|
|
7420
7131
|
/**
|
|
7421
7132
|
* @deprecated
|
|
7422
7133
|
* This parameter is unused and has no effect. Passing this parameter will become an error in the future
|
|
7423
7134
|
*/
|
|
7424
|
-
skipParameterResolution?: components$
|
|
7135
|
+
skipParameterResolution?: components$e["parameters"]["skipParameterResolution"];
|
|
7425
7136
|
/**
|
|
7426
7137
|
* If true, any pattern override data is not resolved by the API.
|
|
7427
7138
|
* This is intended for internal use in the Canvas editor and should not be used.
|
|
@@ -7429,69 +7140,69 @@ interface paths$c {
|
|
|
7429
7140
|
* Default: true when `format` is canonical or editor. False otherwise.
|
|
7430
7141
|
* Prefer selecting a `format` rather than using this option.
|
|
7431
7142
|
*/
|
|
7432
|
-
skipOverridesResolution?: components$
|
|
7143
|
+
skipOverridesResolution?: components$e["parameters"]["skipOverridesResolution"];
|
|
7433
7144
|
/**
|
|
7434
7145
|
* Specify a single composition to fetch by slug. The response will be a single composition.
|
|
7435
7146
|
* This is a primary query parameter and cannot be used with any other primary query parameters
|
|
7436
7147
|
*/
|
|
7437
|
-
slug?: components$
|
|
7148
|
+
slug?: components$e["parameters"]["slug"];
|
|
7438
7149
|
/** Filtration by category ID. An empty string can be used to include records without a category. */
|
|
7439
|
-
categories?: components$
|
|
7150
|
+
categories?: components$e["parameters"]["categories"];
|
|
7440
7151
|
/**
|
|
7441
7152
|
* Publishing state to fetch. 0 = draft, 64 = published.
|
|
7442
7153
|
* This is a list query parameter and cannot be used with any primary query parameters
|
|
7443
7154
|
*/
|
|
7444
|
-
state?: components$
|
|
7155
|
+
state?: components$e["parameters"]["state"];
|
|
7445
7156
|
/**
|
|
7446
7157
|
* 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
7158
|
* This is a list query parameter and cannot be used with any primary query parameters
|
|
7448
7159
|
*/
|
|
7449
|
-
type?: components$
|
|
7160
|
+
type?: components$e["parameters"]["type"];
|
|
7450
7161
|
/**
|
|
7451
7162
|
* @deprecated
|
|
7452
7163
|
* Filters composition lists by the UI status of the composition.
|
|
7453
7164
|
* This internal status is subject to change without notice and is thus marked deprecated to discourage use of internal data.
|
|
7454
7165
|
* This is a list query parameter and cannot be used with any primary query parameters
|
|
7455
7166
|
*/
|
|
7456
|
-
uiStatus?: components$
|
|
7167
|
+
uiStatus?: components$e["parameters"]["uiStatus"];
|
|
7457
7168
|
/**
|
|
7458
7169
|
* Filters out compositions without attached node or filters out compositions with attached nodes
|
|
7459
7170
|
* if set to false. If not specified, no filtration is applied.
|
|
7460
7171
|
* This is a list query parameter and cannot be used with any primary query parameters
|
|
7461
7172
|
*/
|
|
7462
|
-
attachedToProjectMap?: components$
|
|
7173
|
+
attachedToProjectMap?: components$e["parameters"]["attachedToProjectMap"];
|
|
7463
7174
|
/**
|
|
7464
7175
|
* Filters composition lists by the user who last updated them. The user is specified by their identity subject.
|
|
7465
7176
|
* This is a list query parameter and cannot be used with any primary query parameters
|
|
7466
7177
|
*/
|
|
7467
|
-
updatedBy?: components$
|
|
7178
|
+
updatedBy?: components$e["parameters"]["updatedBy"];
|
|
7468
7179
|
/**
|
|
7469
7180
|
* If true, the `_id` unique identifier of each non-root component will be part of the response data.
|
|
7470
7181
|
* If false, the `_id` will not be present in the API response.
|
|
7471
7182
|
* Note: the default value depends on the `format`: true for editor or canonical, false for delivery or when no format is specified.
|
|
7472
7183
|
* Prefer selecting a `format` rather than using this option.
|
|
7473
7184
|
*/
|
|
7474
|
-
withComponentIDs?: components$
|
|
7185
|
+
withComponentIDs?: components$e["parameters"]["withComponentIDs"];
|
|
7475
7186
|
/**
|
|
7476
7187
|
* Controls whether the total count of results will be returned along with the current results page in a list.
|
|
7477
7188
|
* Has no effect when not fetching a list. This does impact performance when enabled
|
|
7478
7189
|
*/
|
|
7479
|
-
withTotalCount?: components$
|
|
7190
|
+
withTotalCount?: components$e["parameters"]["withTotalCount"];
|
|
7480
7191
|
/**
|
|
7481
7192
|
* @deprecated
|
|
7482
7193
|
* Returns the UI status string of the composition.
|
|
7483
7194
|
* This internal status is subject to change without notice and is thus marked deprecated to discourage use of internal data
|
|
7484
7195
|
*/
|
|
7485
|
-
withUIStatus?: components$
|
|
7196
|
+
withUIStatus?: components$e["parameters"]["withUIStatus"];
|
|
7486
7197
|
/** Returns the definition of any attached workflow along with the composition data */
|
|
7487
|
-
withWorkflowDefinition?: components$
|
|
7198
|
+
withWorkflowDefinition?: components$e["parameters"]["withWorkflowDefinition"];
|
|
7488
7199
|
/** Includes project map node information in the composition results */
|
|
7489
|
-
withProjectMapNodes?: components$
|
|
7200
|
+
withProjectMapNodes?: components$e["parameters"]["withProjectMapNodes"];
|
|
7490
7201
|
/**
|
|
7491
7202
|
* @deprecated
|
|
7492
7203
|
* Has no effect.
|
|
7493
7204
|
*/
|
|
7494
|
-
withContentSourceMap?: components$
|
|
7205
|
+
withContentSourceMap?: components$e["parameters"]["withContentSourceMap"];
|
|
7495
7206
|
/**
|
|
7496
7207
|
* One or more locales to filter and localize by.
|
|
7497
7208
|
* 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 +7216,7 @@ interface paths$c {
|
|
|
7505
7216
|
* When this parameter is not passed, all locales' data will be returned.
|
|
7506
7217
|
* If a composition is requested by ID and does not possess any of the specified locales, HTTP 404 will be returned
|
|
7507
7218
|
*/
|
|
7508
|
-
locale?: components$
|
|
7219
|
+
locale?: components$e["parameters"]["locale"];
|
|
7509
7220
|
/**
|
|
7510
7221
|
* The ID of a release to fetch the content for.
|
|
7511
7222
|
*
|
|
@@ -7514,7 +7225,7 @@ interface paths$c {
|
|
|
7514
7225
|
*
|
|
7515
7226
|
* 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
7227
|
*/
|
|
7517
|
-
releaseId?: components$
|
|
7228
|
+
releaseId?: components$e["parameters"]["releaseId"];
|
|
7518
7229
|
/**
|
|
7519
7230
|
* Search on textual fields of a composition.
|
|
7520
7231
|
* Matches against fully rendered content including resolved pattern content.
|
|
@@ -7522,7 +7233,7 @@ interface paths$c {
|
|
|
7522
7233
|
* Note: For long text fields, the tail of the text is not guaranteed to be searchable.
|
|
7523
7234
|
* Example: ?search=hello
|
|
7524
7235
|
*/
|
|
7525
|
-
search?: components$
|
|
7236
|
+
search?: components$e["parameters"]["search"];
|
|
7526
7237
|
/**
|
|
7527
7238
|
* @deprecated
|
|
7528
7239
|
* BETA: Semantic search using vector similarity to find content by meaning.
|
|
@@ -7530,7 +7241,7 @@ interface paths$c {
|
|
|
7530
7241
|
* Use this for "where is this content defined" queries.
|
|
7531
7242
|
* Requires AI credits.
|
|
7532
7243
|
*/
|
|
7533
|
-
searchSemantic?: components$
|
|
7244
|
+
searchSemantic?: components$e["parameters"]["searchSemantic"];
|
|
7534
7245
|
/**
|
|
7535
7246
|
* Controls the edition resolution behavior.
|
|
7536
7247
|
*
|
|
@@ -7545,7 +7256,7 @@ interface paths$c {
|
|
|
7545
7256
|
* compositionId or compositionIDs MUST be provided with this option.
|
|
7546
7257
|
* If versionId is passed, this is always enabled.
|
|
7547
7258
|
*/
|
|
7548
|
-
editions?: components$
|
|
7259
|
+
editions?: components$e["parameters"]["editions"];
|
|
7549
7260
|
/**
|
|
7550
7261
|
* Specify a format you want the results in. Any explicit shaping flag (skipPatternResolution,
|
|
7551
7262
|
* skipOverridesResolution, withComponentIDs) overrides this alias.
|
|
@@ -7558,7 +7269,7 @@ interface paths$c {
|
|
|
7558
7269
|
* - `delivery`: default structure for serving to a frontend — patterns and overrides resolved
|
|
7559
7270
|
* and component `_id`s removed.
|
|
7560
7271
|
*/
|
|
7561
|
-
format?: components$
|
|
7272
|
+
format?: components$e["parameters"]["format"];
|
|
7562
7273
|
/**
|
|
7563
7274
|
* Controls filtering of trashed items.
|
|
7564
7275
|
*
|
|
@@ -7566,7 +7277,7 @@ interface paths$c {
|
|
|
7566
7277
|
* only: Only return trashed items (for trash view).
|
|
7567
7278
|
* include: Return both trashed and non-trashed items.
|
|
7568
7279
|
*/
|
|
7569
|
-
deleted?: components$
|
|
7280
|
+
deleted?: components$e["parameters"]["deleted"];
|
|
7570
7281
|
};
|
|
7571
7282
|
header?: never;
|
|
7572
7283
|
path?: never;
|
|
@@ -7580,12 +7291,12 @@ interface paths$c {
|
|
|
7580
7291
|
[name: string]: unknown;
|
|
7581
7292
|
};
|
|
7582
7293
|
content: {
|
|
7583
|
-
"application/json": components$
|
|
7294
|
+
"application/json": components$e["schemas"]["CompositionListResponse"] | components$e["schemas"]["CompositionApiResponse"];
|
|
7584
7295
|
};
|
|
7585
7296
|
};
|
|
7586
|
-
400: components$
|
|
7587
|
-
401: components$
|
|
7588
|
-
403: components$
|
|
7297
|
+
400: components$e["responses"]["BadRequestError"];
|
|
7298
|
+
401: components$e["responses"]["UnauthorizedError"];
|
|
7299
|
+
403: components$e["responses"]["ForbiddenError"];
|
|
7589
7300
|
/** Composition not found */
|
|
7590
7301
|
404: {
|
|
7591
7302
|
headers: {
|
|
@@ -7595,8 +7306,8 @@ interface paths$c {
|
|
|
7595
7306
|
"text/plain": string;
|
|
7596
7307
|
};
|
|
7597
7308
|
};
|
|
7598
|
-
429: components$
|
|
7599
|
-
500: components$
|
|
7309
|
+
429: components$e["responses"]["RateLimitError"];
|
|
7310
|
+
500: components$e["responses"]["InternalServerError"];
|
|
7600
7311
|
};
|
|
7601
7312
|
};
|
|
7602
7313
|
/** Upserts a composition */
|
|
@@ -7624,7 +7335,7 @@ interface paths$c {
|
|
|
7624
7335
|
projectId: string;
|
|
7625
7336
|
/** The publishing state to upsert into. 0 = draft, 64 = published */
|
|
7626
7337
|
state: number;
|
|
7627
|
-
composition: components$
|
|
7338
|
+
composition: components$e["schemas"]["RootComponentInstance"];
|
|
7628
7339
|
/**
|
|
7629
7340
|
* Indicates if the composition is a pattern that can be referenced in other compositions
|
|
7630
7341
|
* @defaultValue false
|
|
@@ -7700,9 +7411,9 @@ interface paths$c {
|
|
|
7700
7411
|
};
|
|
7701
7412
|
content?: never;
|
|
7702
7413
|
};
|
|
7703
|
-
400: components$
|
|
7704
|
-
401: components$
|
|
7705
|
-
403: components$
|
|
7414
|
+
400: components$e["responses"]["BadRequestError"];
|
|
7415
|
+
401: components$e["responses"]["UnauthorizedError"];
|
|
7416
|
+
403: components$e["responses"]["ForbiddenError"];
|
|
7706
7417
|
/** Conflict - Composition has been changed since being loaded */
|
|
7707
7418
|
409: {
|
|
7708
7419
|
headers: {
|
|
@@ -7712,8 +7423,8 @@ interface paths$c {
|
|
|
7712
7423
|
"text/plain": string;
|
|
7713
7424
|
};
|
|
7714
7425
|
};
|
|
7715
|
-
429: components$
|
|
7716
|
-
500: components$
|
|
7426
|
+
429: components$e["responses"]["RateLimitError"];
|
|
7427
|
+
500: components$e["responses"]["InternalServerError"];
|
|
7717
7428
|
};
|
|
7718
7429
|
};
|
|
7719
7430
|
post?: never;
|
|
@@ -7766,11 +7477,11 @@ interface paths$c {
|
|
|
7766
7477
|
};
|
|
7767
7478
|
content?: never;
|
|
7768
7479
|
};
|
|
7769
|
-
400: components$
|
|
7770
|
-
401: components$
|
|
7771
|
-
403: components$
|
|
7772
|
-
429: components$
|
|
7773
|
-
500: components$
|
|
7480
|
+
400: components$e["responses"]["BadRequestError"];
|
|
7481
|
+
401: components$e["responses"]["UnauthorizedError"];
|
|
7482
|
+
403: components$e["responses"]["ForbiddenError"];
|
|
7483
|
+
429: components$e["responses"]["RateLimitError"];
|
|
7484
|
+
500: components$e["responses"]["InternalServerError"];
|
|
7774
7485
|
};
|
|
7775
7486
|
};
|
|
7776
7487
|
/** Handles preflight requests. This endpoint allows CORS */
|
|
@@ -7797,7 +7508,7 @@ interface paths$c {
|
|
|
7797
7508
|
trace?: never;
|
|
7798
7509
|
};
|
|
7799
7510
|
}
|
|
7800
|
-
interface components$
|
|
7511
|
+
interface components$e {
|
|
7801
7512
|
schemas: {
|
|
7802
7513
|
CompositionApiResponse: {
|
|
7803
7514
|
/** Publishing state to fetch. 0 = draft, 64 = published */
|
|
@@ -7828,6 +7539,8 @@ interface components$d {
|
|
|
7828
7539
|
* Timestamp when the item was moved to trash. Omitted if not in trash.
|
|
7829
7540
|
*/
|
|
7830
7541
|
deletedAt?: string;
|
|
7542
|
+
/** 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. */
|
|
7543
|
+
publishedWhenTrashed?: boolean;
|
|
7831
7544
|
/** User name of the creator of this composition */
|
|
7832
7545
|
creator?: string;
|
|
7833
7546
|
/** User name of the last editor of this composition */
|
|
@@ -7853,7 +7566,7 @@ interface components$d {
|
|
|
7853
7566
|
* The release this composition belongs to. If not set, it belongs to the base
|
|
7854
7567
|
*/
|
|
7855
7568
|
releaseId?: string;
|
|
7856
|
-
composition: components$
|
|
7569
|
+
composition: components$e["schemas"]["RootComponentInstance"];
|
|
7857
7570
|
/**
|
|
7858
7571
|
* Format: uuid
|
|
7859
7572
|
* The workflow ID assigned to this composition, if any. Normally comes from the component definition
|
|
@@ -7871,7 +7584,7 @@ interface components$d {
|
|
|
7871
7584
|
*/
|
|
7872
7585
|
instanceWorkflowId?: string;
|
|
7873
7586
|
/** The full definition of the assigned workflow, if any, including stages, permissions, etc. Returned only when `withWorkflowDefinition` is true */
|
|
7874
|
-
workflowDefinition?: components$
|
|
7587
|
+
workflowDefinition?: components$e["schemas"]["WorkflowDefinition"];
|
|
7875
7588
|
/**
|
|
7876
7589
|
* Format: uuid
|
|
7877
7590
|
* The edition ID. When set, this is a child edition of the composition in _id.
|
|
@@ -7889,7 +7602,7 @@ interface components$d {
|
|
|
7889
7602
|
editionPriority?: number;
|
|
7890
7603
|
};
|
|
7891
7604
|
CompositionListResponse: {
|
|
7892
|
-
compositions: components$
|
|
7605
|
+
compositions: components$e["schemas"]["CompositionApiResponse"][];
|
|
7893
7606
|
/** Total number of compositions that match the query. Present only when `withTotalCount` option is true */
|
|
7894
7607
|
totalCount?: number;
|
|
7895
7608
|
/** Per-field counts for distinct values */
|
|
@@ -7963,11 +7676,11 @@ interface components$d {
|
|
|
7963
7676
|
|
|
7964
7677
|
*/
|
|
7965
7678
|
op?: "&" | "|";
|
|
7966
|
-
clauses: (components$
|
|
7679
|
+
clauses: (components$e["schemas"]["VisibilityCriteria"] | components$e["schemas"]["VisibilityCriteriaGroup"])[];
|
|
7967
7680
|
};
|
|
7968
7681
|
/** Defines a conditional value for a component parameter */
|
|
7969
7682
|
ComponentParameterConditionalValue: {
|
|
7970
|
-
when: components$
|
|
7683
|
+
when: components$e["schemas"]["VisibilityCriteriaGroup"];
|
|
7971
7684
|
/**
|
|
7972
7685
|
* The value of the parameter. Any JSON-serializable value is acceptable.
|
|
7973
7686
|
* A value of `null` will cause the parameter value to be removed, if it matches.
|
|
@@ -7989,7 +7702,7 @@ interface components$d {
|
|
|
7989
7702
|
*
|
|
7990
7703
|
* When no locale is passed to a non-route API, conditions are not processed and all conditions are returned.
|
|
7991
7704
|
*/
|
|
7992
|
-
ComponentParameterConditions: components$
|
|
7705
|
+
ComponentParameterConditions: components$e["schemas"]["ComponentParameterConditionalValue"][];
|
|
7993
7706
|
/** Defines an editable parameter on a component */
|
|
7994
7707
|
ComponentParameter: {
|
|
7995
7708
|
/** The value of the parameter. Any JSON-serializable value is acceptable */
|
|
@@ -7997,7 +7710,7 @@ interface components$d {
|
|
|
7997
7710
|
/** The type of the parameter. Determines how it is displayed when editing and tells the consumer how to process it */
|
|
7998
7711
|
type: string;
|
|
7999
7712
|
/** @deprecated */
|
|
8000
|
-
connectedData?: components$
|
|
7713
|
+
connectedData?: components$e["schemas"]["DataElementConnectionDefinition"];
|
|
8001
7714
|
/**
|
|
8002
7715
|
* Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
|
|
8003
7716
|
* Note that locales must be registered on the entry/composition `_locales` before being used
|
|
@@ -8005,10 +7718,10 @@ interface components$d {
|
|
|
8005
7718
|
locales?: {
|
|
8006
7719
|
[key: string]: unknown;
|
|
8007
7720
|
};
|
|
8008
|
-
conditions?: components$
|
|
7721
|
+
conditions?: components$e["schemas"]["ComponentParameterConditions"];
|
|
8009
7722
|
/** Locale-specific conditional values for this parameter. Keys are locale codes, and values are the `conditions` for that locale. */
|
|
8010
7723
|
localesConditions?: {
|
|
8011
|
-
[key: string]: components$
|
|
7724
|
+
[key: string]: components$e["schemas"]["ComponentParameterConditions"];
|
|
8012
7725
|
};
|
|
8013
7726
|
};
|
|
8014
7727
|
ProjectMapNodeAllowedQueryString: {
|
|
@@ -8043,7 +7756,7 @@ interface components$d {
|
|
|
8043
7756
|
/** 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
7757
|
isSearchHit?: boolean;
|
|
8045
7758
|
/** Query strings that are allowed to be passed to the node */
|
|
8046
|
-
queryStrings?: components$
|
|
7759
|
+
queryStrings?: components$e["schemas"]["ProjectMapNodeAllowedQueryString"][];
|
|
8047
7760
|
/**
|
|
8048
7761
|
* For dynamic nodes, this is the preview value for the dynamic value.
|
|
8049
7762
|
* The preview value is used when editing a connected composition, and is the default
|
|
@@ -8068,7 +7781,7 @@ interface components$d {
|
|
|
8068
7781
|
* Unique identifier for the project map that this node belongs to
|
|
8069
7782
|
*/
|
|
8070
7783
|
projectMapId: string;
|
|
8071
|
-
data?: components$
|
|
7784
|
+
data?: components$e["schemas"]["ProjectMapNodeData"];
|
|
8072
7785
|
/**
|
|
8073
7786
|
* Locale-specific paths of the project map node.
|
|
8074
7787
|
* Keys are locale codes
|
|
@@ -8088,13 +7801,13 @@ interface components$d {
|
|
|
8088
7801
|
type: string;
|
|
8089
7802
|
/** Component parameter values for the component instance */
|
|
8090
7803
|
parameters?: {
|
|
8091
|
-
[key: string]: components$
|
|
7804
|
+
[key: string]: components$e["schemas"]["ComponentParameter"];
|
|
8092
7805
|
};
|
|
8093
7806
|
/** Public ID of alternate visual appearance for this component, if any selected */
|
|
8094
7807
|
variant?: string;
|
|
8095
7808
|
/** Slots containing any child components */
|
|
8096
7809
|
slots?: {
|
|
8097
|
-
[key: string]: components$
|
|
7810
|
+
[key: string]: components$e["schemas"]["ComponentInstance"][];
|
|
8098
7811
|
};
|
|
8099
7812
|
/**
|
|
8100
7813
|
* Unique identifier of the component within the composition.
|
|
@@ -8105,20 +7818,20 @@ interface components$d {
|
|
|
8105
7818
|
_id?: string;
|
|
8106
7819
|
/** Indicates this component instance should be sourced from a pattern library pattern */
|
|
8107
7820
|
_pattern?: string;
|
|
8108
|
-
_dataResources?: components$
|
|
7821
|
+
_dataResources?: components$e["schemas"]["DataResourceDefinitions"];
|
|
8109
7822
|
/**
|
|
8110
7823
|
* Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
|
8111
7824
|
* Means nothing for PUTs; it will be ignored
|
|
8112
7825
|
*/
|
|
8113
7826
|
_patternDataResources?: {
|
|
8114
|
-
[key: string]: components$
|
|
7827
|
+
[key: string]: components$e["schemas"]["DataResourceDefinition"];
|
|
8115
7828
|
};
|
|
8116
7829
|
/**
|
|
8117
7830
|
* Query-string opt-ins coming from a pattern resolved for this component.
|
|
8118
7831
|
* Means nothing for PUTs; it will be ignored
|
|
8119
7832
|
*/
|
|
8120
7833
|
_patternOptedInQueryStrings?: string[];
|
|
8121
|
-
_patternError?: components$
|
|
7834
|
+
_patternError?: components$e["schemas"]["PatternError"];
|
|
8122
7835
|
/**
|
|
8123
7836
|
* Defines patch overrides to component IDs that live in the composition.
|
|
8124
7837
|
* This can be used to override parameters that are defined on patterns,
|
|
@@ -8132,14 +7845,14 @@ interface components$d {
|
|
|
8132
7845
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
8133
7846
|
*/
|
|
8134
7847
|
_overrides?: {
|
|
8135
|
-
[key: string]: components$
|
|
7848
|
+
[key: string]: components$e["schemas"]["ComponentOverride"];
|
|
8136
7849
|
};
|
|
8137
7850
|
/**
|
|
8138
7851
|
* Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
|
|
8139
7852
|
* Means nothing for PUTs; it will be ignored
|
|
8140
7853
|
*/
|
|
8141
7854
|
_patternOverrides?: {
|
|
8142
|
-
[key: string]: components$
|
|
7855
|
+
[key: string]: components$e["schemas"]["ComponentOverride"];
|
|
8143
7856
|
};
|
|
8144
7857
|
/**
|
|
8145
7858
|
* When used on a pattern, defines how the pattern's parameters may be overridden
|
|
@@ -8148,7 +7861,7 @@ interface components$d {
|
|
|
8148
7861
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
8149
7862
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
8150
7863
|
*/
|
|
8151
|
-
_overridability?: components$
|
|
7864
|
+
_overridability?: components$e["schemas"]["ComponentOverridability"];
|
|
8152
7865
|
/** Array of locales that have data defined. Only set for pattern references or composition defaults */
|
|
8153
7866
|
_locales?: string[];
|
|
8154
7867
|
};
|
|
@@ -8173,14 +7886,14 @@ interface components$d {
|
|
|
8173
7886
|
* If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
|
|
8174
7887
|
*/
|
|
8175
7888
|
optionalPatternParameter?: boolean;
|
|
8176
|
-
variables?: components$
|
|
7889
|
+
variables?: components$e["schemas"]["DataResourceVariables"];
|
|
8177
7890
|
};
|
|
8178
7891
|
/**
|
|
8179
7892
|
* Data definitions attached to this component. The property name is the key of the data in the data document.
|
|
8180
7893
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key)
|
|
8181
7894
|
*/
|
|
8182
7895
|
DataResourceDefinitions: {
|
|
8183
|
-
[key: string]: components$
|
|
7896
|
+
[key: string]: components$e["schemas"]["DataResourceDefinition"];
|
|
8184
7897
|
};
|
|
8185
7898
|
/**
|
|
8186
7899
|
* Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
|
@@ -8198,10 +7911,10 @@ interface components$d {
|
|
|
8198
7911
|
*/
|
|
8199
7912
|
ComponentOverride: {
|
|
8200
7913
|
parameters?: {
|
|
8201
|
-
[key: string]: components$
|
|
7914
|
+
[key: string]: components$e["schemas"]["ComponentParameter"];
|
|
8202
7915
|
};
|
|
8203
7916
|
slots?: {
|
|
8204
|
-
[key: string]: components$
|
|
7917
|
+
[key: string]: components$e["schemas"]["ComponentInstance"][];
|
|
8205
7918
|
};
|
|
8206
7919
|
variant?: string;
|
|
8207
7920
|
/**
|
|
@@ -8210,7 +7923,7 @@ interface components$d {
|
|
|
8210
7923
|
* Overrides defined here replace values in either _dataResources or _patternDataResources on the target component.
|
|
8211
7924
|
*/
|
|
8212
7925
|
dataResources?: {
|
|
8213
|
-
[key: string]: components$
|
|
7926
|
+
[key: string]: components$e["schemas"]["DataResourceDefinition"];
|
|
8214
7927
|
};
|
|
8215
7928
|
};
|
|
8216
7929
|
/**
|
|
@@ -8231,7 +7944,7 @@ interface components$d {
|
|
|
8231
7944
|
ComponentOverridability: {
|
|
8232
7945
|
/** Defines component parameter value overrides. Keys are the parameter public ID */
|
|
8233
7946
|
parameters?: {
|
|
8234
|
-
[key: string]: components$
|
|
7947
|
+
[key: string]: components$e["schemas"]["OverrideOptions"];
|
|
8235
7948
|
};
|
|
8236
7949
|
/** Allows overriding a display variant is allowed if it is defined on the component the pattern is derived from. Default = false */
|
|
8237
7950
|
variants?: boolean;
|
|
@@ -8248,15 +7961,15 @@ interface components$d {
|
|
|
8248
7961
|
type: string;
|
|
8249
7962
|
/** Component parameter values for the component instance */
|
|
8250
7963
|
parameters?: {
|
|
8251
|
-
[key: string]: components$
|
|
7964
|
+
[key: string]: components$e["schemas"]["ComponentParameter"];
|
|
8252
7965
|
};
|
|
8253
7966
|
/** Public ID of alternate visual appearance for this component, if any selected */
|
|
8254
7967
|
variant?: string;
|
|
8255
7968
|
/** Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated */
|
|
8256
|
-
projectMapNodes?: components$
|
|
7969
|
+
projectMapNodes?: components$e["schemas"]["CompositionProjectMapNodeInfo"][];
|
|
8257
7970
|
/** Slots containing any child components */
|
|
8258
7971
|
slots?: {
|
|
8259
|
-
[key: string]: components$
|
|
7972
|
+
[key: string]: components$e["schemas"]["ComponentInstance"][];
|
|
8260
7973
|
};
|
|
8261
7974
|
/** The ID of the composition */
|
|
8262
7975
|
_id: string;
|
|
@@ -8279,15 +7992,15 @@ interface components$d {
|
|
|
8279
7992
|
* Means nothing for PUTs; it will be ignored
|
|
8280
7993
|
*/
|
|
8281
7994
|
_patternDataResources?: {
|
|
8282
|
-
[key: string]: components$
|
|
7995
|
+
[key: string]: components$e["schemas"]["DataResourceDefinition"];
|
|
8283
7996
|
};
|
|
8284
7997
|
/**
|
|
8285
7998
|
* Query-string opt-ins coming from a pattern resolved for this component.
|
|
8286
7999
|
* Means nothing for PUTs; it will be ignored
|
|
8287
8000
|
*/
|
|
8288
8001
|
_patternOptedInQueryStrings?: string[];
|
|
8289
|
-
_dataResources?: components$
|
|
8290
|
-
_patternError?: components$
|
|
8002
|
+
_dataResources?: components$e["schemas"]["DataResourceDefinitions"];
|
|
8003
|
+
_patternError?: components$e["schemas"]["PatternError"];
|
|
8291
8004
|
/**
|
|
8292
8005
|
* Defines patch overrides to component IDs that live in the composition.
|
|
8293
8006
|
* This can be used to override parameters that are defined on patterns,
|
|
@@ -8301,14 +8014,14 @@ interface components$d {
|
|
|
8301
8014
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
8302
8015
|
*/
|
|
8303
8016
|
_overrides?: {
|
|
8304
|
-
[key: string]: components$
|
|
8017
|
+
[key: string]: components$e["schemas"]["ComponentOverride"];
|
|
8305
8018
|
};
|
|
8306
8019
|
/**
|
|
8307
8020
|
* Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
|
|
8308
8021
|
* Means nothing for PUTs; it will be ignored
|
|
8309
8022
|
*/
|
|
8310
8023
|
_patternOverrides?: {
|
|
8311
|
-
[key: string]: components$
|
|
8024
|
+
[key: string]: components$e["schemas"]["ComponentOverride"];
|
|
8312
8025
|
};
|
|
8313
8026
|
/**
|
|
8314
8027
|
* When used on a pattern, defines how the pattern's parameters may be overridden
|
|
@@ -8317,7 +8030,7 @@ interface components$d {
|
|
|
8317
8030
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
8318
8031
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
8319
8032
|
*/
|
|
8320
|
-
_overridability?: components$
|
|
8033
|
+
_overridability?: components$e["schemas"]["ComponentOverridability"];
|
|
8321
8034
|
/** Array of locales which have data defined on the composition. If empty, the current default locale implicitly has data */
|
|
8322
8035
|
_locales?: string[];
|
|
8323
8036
|
/**
|
|
@@ -8356,7 +8069,7 @@ interface components$d {
|
|
|
8356
8069
|
* NOTE: Users without membership in any role listed here will be unable to execute the transition unless they are team admins
|
|
8357
8070
|
*/
|
|
8358
8071
|
permissions: {
|
|
8359
|
-
[key: string]: components$
|
|
8072
|
+
[key: string]: components$e["schemas"]["WorkflowStageTransitionPermission"];
|
|
8360
8073
|
};
|
|
8361
8074
|
};
|
|
8362
8075
|
/** Definition of a stage in a workflow */
|
|
@@ -8370,7 +8083,7 @@ interface components$d {
|
|
|
8370
8083
|
* listed here, the stage is read-only and publishing is disabled
|
|
8371
8084
|
*/
|
|
8372
8085
|
permissions: {
|
|
8373
|
-
[key: string]: components$
|
|
8086
|
+
[key: string]: components$e["schemas"]["WorkflowStagePermission"];
|
|
8374
8087
|
};
|
|
8375
8088
|
/**
|
|
8376
8089
|
* When true, transitioning into this stage from a different stage will automatically publish the entity.
|
|
@@ -8390,7 +8103,7 @@ interface components$d {
|
|
|
8390
8103
|
* Every stage must define at least one transition, to avoid creating a workflow that
|
|
8391
8104
|
* has a stage that can never be escaped
|
|
8392
8105
|
*/
|
|
8393
|
-
transitions: components$
|
|
8106
|
+
transitions: components$e["schemas"]["WorkflowStageTransition"][];
|
|
8394
8107
|
/**
|
|
8395
8108
|
* Icon name for the stage (e.g. 'chevron-double-right-o')
|
|
8396
8109
|
* @defaultValue chevron-double-right-o
|
|
@@ -8415,7 +8128,7 @@ interface components$d {
|
|
|
8415
8128
|
initialStage: string;
|
|
8416
8129
|
/** All stages of the workflow */
|
|
8417
8130
|
stages: {
|
|
8418
|
-
[key: string]: components$
|
|
8131
|
+
[key: string]: components$e["schemas"]["WorkflowStage"];
|
|
8419
8132
|
};
|
|
8420
8133
|
/** Last modified ISO date string for this definition (ignored for writes) */
|
|
8421
8134
|
modified?: string;
|
|
@@ -8446,7 +8159,7 @@ interface components$d {
|
|
|
8446
8159
|
[name: string]: unknown;
|
|
8447
8160
|
};
|
|
8448
8161
|
content: {
|
|
8449
|
-
"application/json": components$
|
|
8162
|
+
"application/json": components$e["schemas"]["Error"];
|
|
8450
8163
|
};
|
|
8451
8164
|
};
|
|
8452
8165
|
/** API key or token was not valid */
|
|
@@ -8455,7 +8168,7 @@ interface components$d {
|
|
|
8455
8168
|
[name: string]: unknown;
|
|
8456
8169
|
};
|
|
8457
8170
|
content: {
|
|
8458
|
-
"application/json": components$
|
|
8171
|
+
"application/json": components$e["schemas"]["Error"];
|
|
8459
8172
|
};
|
|
8460
8173
|
};
|
|
8461
8174
|
/** Permission was denied */
|
|
@@ -8464,7 +8177,7 @@ interface components$d {
|
|
|
8464
8177
|
[name: string]: unknown;
|
|
8465
8178
|
};
|
|
8466
8179
|
content: {
|
|
8467
|
-
"application/json": components$
|
|
8180
|
+
"application/json": components$e["schemas"]["Error"];
|
|
8468
8181
|
};
|
|
8469
8182
|
};
|
|
8470
8183
|
/** Too many requests in allowed time period */
|
|
@@ -8747,7 +8460,7 @@ interface components$d {
|
|
|
8747
8460
|
pathItems: never;
|
|
8748
8461
|
}
|
|
8749
8462
|
|
|
8750
|
-
interface paths$
|
|
8463
|
+
interface paths$c {
|
|
8751
8464
|
"/api/v1/canvas-history": {
|
|
8752
8465
|
parameters: {
|
|
8753
8466
|
query?: never;
|
|
@@ -8781,12 +8494,12 @@ interface paths$b {
|
|
|
8781
8494
|
[name: string]: unknown;
|
|
8782
8495
|
};
|
|
8783
8496
|
content: {
|
|
8784
|
-
"application/json": components$
|
|
8497
|
+
"application/json": components$d["schemas"]["HistoryApiResponse"];
|
|
8785
8498
|
};
|
|
8786
8499
|
};
|
|
8787
|
-
400: components$
|
|
8788
|
-
401: components$
|
|
8789
|
-
403: components$
|
|
8500
|
+
400: components$d["responses"]["BadRequestError"];
|
|
8501
|
+
401: components$d["responses"]["UnauthorizedError"];
|
|
8502
|
+
403: components$d["responses"]["ForbiddenError"];
|
|
8790
8503
|
/** Composition not found */
|
|
8791
8504
|
404: {
|
|
8792
8505
|
headers: {
|
|
@@ -8796,8 +8509,8 @@ interface paths$b {
|
|
|
8796
8509
|
"text/plain": string;
|
|
8797
8510
|
};
|
|
8798
8511
|
};
|
|
8799
|
-
429: components$
|
|
8800
|
-
500: components$
|
|
8512
|
+
429: components$d["responses"]["RateLimitError"];
|
|
8513
|
+
500: components$d["responses"]["InternalServerError"];
|
|
8801
8514
|
};
|
|
8802
8515
|
};
|
|
8803
8516
|
put?: never;
|
|
@@ -8809,7 +8522,7 @@ interface paths$b {
|
|
|
8809
8522
|
trace?: never;
|
|
8810
8523
|
};
|
|
8811
8524
|
}
|
|
8812
|
-
interface components$
|
|
8525
|
+
interface components$d {
|
|
8813
8526
|
schemas: {
|
|
8814
8527
|
HistoryEntry: {
|
|
8815
8528
|
/** The version ID of the entity. This can be used to fetch the version's data via the entity API */
|
|
@@ -8833,7 +8546,7 @@ interface components$c {
|
|
|
8833
8546
|
/** If more history is available than your plan allows, and additional entries are available by upgrading, this will be true */
|
|
8834
8547
|
truncated?: boolean;
|
|
8835
8548
|
/** Version history entries */
|
|
8836
|
-
results?: components$
|
|
8549
|
+
results?: components$d["schemas"]["HistoryEntry"][];
|
|
8837
8550
|
};
|
|
8838
8551
|
Error: {
|
|
8839
8552
|
/** Error message(s) that occurred while processing the request */
|
|
@@ -8847,7 +8560,7 @@ interface components$c {
|
|
|
8847
8560
|
[name: string]: unknown;
|
|
8848
8561
|
};
|
|
8849
8562
|
content: {
|
|
8850
|
-
"application/json": components$
|
|
8563
|
+
"application/json": components$d["schemas"]["Error"];
|
|
8851
8564
|
};
|
|
8852
8565
|
};
|
|
8853
8566
|
/** API key or token was not valid */
|
|
@@ -8856,7 +8569,7 @@ interface components$c {
|
|
|
8856
8569
|
[name: string]: unknown;
|
|
8857
8570
|
};
|
|
8858
8571
|
content: {
|
|
8859
|
-
"application/json": components$
|
|
8572
|
+
"application/json": components$d["schemas"]["Error"];
|
|
8860
8573
|
};
|
|
8861
8574
|
};
|
|
8862
8575
|
/** Permission was denied */
|
|
@@ -8865,7 +8578,7 @@ interface components$c {
|
|
|
8865
8578
|
[name: string]: unknown;
|
|
8866
8579
|
};
|
|
8867
8580
|
content: {
|
|
8868
|
-
"application/json": components$
|
|
8581
|
+
"application/json": components$d["schemas"]["Error"];
|
|
8869
8582
|
};
|
|
8870
8583
|
};
|
|
8871
8584
|
/** Too many requests in allowed time period */
|
|
@@ -8889,41 +8602,41 @@ interface components$c {
|
|
|
8889
8602
|
pathItems: never;
|
|
8890
8603
|
}
|
|
8891
8604
|
|
|
8892
|
-
interface components$
|
|
8605
|
+
interface components$c {
|
|
8893
8606
|
schemas: {
|
|
8894
|
-
CompositionResolvedGetResponse: components$
|
|
8607
|
+
CompositionResolvedGetResponse: components$c["schemas"]["EdgehancersResolutionInfo"] & components$c["schemas"]["CompositionApiResponse"];
|
|
8895
8608
|
CompositionResolvedListResponse: {
|
|
8896
|
-
diagnostics?: components$
|
|
8609
|
+
diagnostics?: components$c["schemas"]["EdgehancersDiagnostics"] & {
|
|
8897
8610
|
data?: {
|
|
8898
|
-
[key: string]: components$
|
|
8611
|
+
[key: string]: components$c["schemas"]["DataDiagnostic"][];
|
|
8899
8612
|
};
|
|
8900
8613
|
};
|
|
8901
8614
|
errors?: {
|
|
8902
|
-
[key: string]: components$
|
|
8615
|
+
[key: string]: components$c["schemas"]["DataResolutionIssue"][];
|
|
8903
8616
|
};
|
|
8904
8617
|
warnings?: {
|
|
8905
|
-
[key: string]: components$
|
|
8618
|
+
[key: string]: components$c["schemas"]["DataResolutionIssue"][];
|
|
8906
8619
|
};
|
|
8907
8620
|
infos?: {
|
|
8908
|
-
[key: string]: components$
|
|
8621
|
+
[key: string]: components$c["schemas"]["DataResolutionIssue"][];
|
|
8909
8622
|
};
|
|
8910
|
-
} & components$
|
|
8623
|
+
} & components$c["schemas"]["CompositionListResponse"];
|
|
8911
8624
|
EntryResolvedListResponse: {
|
|
8912
|
-
diagnostics?: components$
|
|
8625
|
+
diagnostics?: components$c["schemas"]["EdgehancersDiagnostics"] & {
|
|
8913
8626
|
data?: {
|
|
8914
|
-
[key: string]: components$
|
|
8627
|
+
[key: string]: components$c["schemas"]["DataDiagnostic"][];
|
|
8915
8628
|
};
|
|
8916
8629
|
};
|
|
8917
8630
|
errors?: {
|
|
8918
|
-
[key: string]: components$
|
|
8631
|
+
[key: string]: components$c["schemas"]["DataResolutionIssue"][];
|
|
8919
8632
|
};
|
|
8920
8633
|
warnings?: {
|
|
8921
|
-
[key: string]: components$
|
|
8634
|
+
[key: string]: components$c["schemas"]["DataResolutionIssue"][];
|
|
8922
8635
|
};
|
|
8923
8636
|
infos?: {
|
|
8924
|
-
[key: string]: components$
|
|
8637
|
+
[key: string]: components$c["schemas"]["DataResolutionIssue"][];
|
|
8925
8638
|
};
|
|
8926
|
-
} & components$
|
|
8639
|
+
} & components$c["schemas"]["EntryListResponse"];
|
|
8927
8640
|
EdgehancersResolutionInfo: {
|
|
8928
8641
|
wholeResponseCacheDiagnostics?: {
|
|
8929
8642
|
info: string;
|
|
@@ -8932,19 +8645,19 @@ interface components$b {
|
|
|
8932
8645
|
edgeLocation?: string;
|
|
8933
8646
|
requestId: string;
|
|
8934
8647
|
};
|
|
8935
|
-
diagnostics?: components$
|
|
8936
|
-
data?: components$
|
|
8648
|
+
diagnostics?: components$c["schemas"]["EdgehancersDiagnostics"] & {
|
|
8649
|
+
data?: components$c["schemas"]["DataDiagnostic"][];
|
|
8937
8650
|
};
|
|
8938
|
-
errors?: components$
|
|
8939
|
-
warnings?: components$
|
|
8940
|
-
infos?: components$
|
|
8651
|
+
errors?: components$c["schemas"]["DataResolutionIssue"][];
|
|
8652
|
+
warnings?: components$c["schemas"]["DataResolutionIssue"][];
|
|
8653
|
+
infos?: components$c["schemas"]["DataResolutionIssue"][];
|
|
8941
8654
|
};
|
|
8942
8655
|
EdgehancersError: {
|
|
8943
8656
|
message: string;
|
|
8944
8657
|
status: number;
|
|
8945
8658
|
statusText: string;
|
|
8946
8659
|
};
|
|
8947
|
-
UniformError: components$
|
|
8660
|
+
UniformError: components$c["schemas"]["EdgehancersError"] | components$c["schemas"]["Error"];
|
|
8948
8661
|
InvalidationPayload: {
|
|
8949
8662
|
/** List of variables with values to invalidate */
|
|
8950
8663
|
variables?: {
|
|
@@ -8958,7 +8671,7 @@ interface components$b {
|
|
|
8958
8671
|
dataTypeId: string;
|
|
8959
8672
|
/** Format: uuid */
|
|
8960
8673
|
purgeKey: string;
|
|
8961
|
-
conditions?: components$
|
|
8674
|
+
conditions?: components$c["schemas"]["InvalidationPayload"];
|
|
8962
8675
|
}[];
|
|
8963
8676
|
DataDiagnostic: {
|
|
8964
8677
|
componentPath: string;
|
|
@@ -9018,7 +8731,7 @@ interface components$b {
|
|
|
9018
8731
|
message: string;
|
|
9019
8732
|
type: string;
|
|
9020
8733
|
parameterName?: string;
|
|
9021
|
-
expression?: components$
|
|
8734
|
+
expression?: components$c["schemas"]["DataElementConnectionDefinition"];
|
|
9022
8735
|
dataName?: string;
|
|
9023
8736
|
dataType?: string;
|
|
9024
8737
|
inputName?: string;
|
|
@@ -9093,11 +8806,11 @@ interface components$b {
|
|
|
9093
8806
|
|
|
9094
8807
|
*/
|
|
9095
8808
|
op?: "&" | "|";
|
|
9096
|
-
clauses: (components$
|
|
8809
|
+
clauses: (components$c["schemas"]["VisibilityCriteria"] | components$c["schemas"]["VisibilityCriteriaGroup"])[];
|
|
9097
8810
|
};
|
|
9098
8811
|
/** Defines a conditional value for a component parameter */
|
|
9099
8812
|
ComponentParameterConditionalValue: {
|
|
9100
|
-
when: components$
|
|
8813
|
+
when: components$c["schemas"]["VisibilityCriteriaGroup"];
|
|
9101
8814
|
/**
|
|
9102
8815
|
* The value of the parameter. Any JSON-serializable value is acceptable.
|
|
9103
8816
|
* A value of `null` will cause the parameter value to be removed, if it matches.
|
|
@@ -9119,7 +8832,7 @@ interface components$b {
|
|
|
9119
8832
|
*
|
|
9120
8833
|
* When no locale is passed to a non-route API, conditions are not processed and all conditions are returned.
|
|
9121
8834
|
*/
|
|
9122
|
-
ComponentParameterConditions: components$
|
|
8835
|
+
ComponentParameterConditions: components$c["schemas"]["ComponentParameterConditionalValue"][];
|
|
9123
8836
|
/** Defines an editable parameter on a component */
|
|
9124
8837
|
ComponentParameter: {
|
|
9125
8838
|
/** The value of the parameter. Any JSON-serializable value is acceptable */
|
|
@@ -9127,7 +8840,7 @@ interface components$b {
|
|
|
9127
8840
|
/** The type of the parameter. Determines how it is displayed when editing and tells the consumer how to process it */
|
|
9128
8841
|
type: string;
|
|
9129
8842
|
/** @deprecated */
|
|
9130
|
-
connectedData?: components$
|
|
8843
|
+
connectedData?: components$c["schemas"]["DataElementConnectionDefinition"];
|
|
9131
8844
|
/**
|
|
9132
8845
|
* Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
|
|
9133
8846
|
* Note that locales must be registered on the entry/composition `_locales` before being used
|
|
@@ -9135,10 +8848,10 @@ interface components$b {
|
|
|
9135
8848
|
locales?: {
|
|
9136
8849
|
[key: string]: unknown;
|
|
9137
8850
|
};
|
|
9138
|
-
conditions?: components$
|
|
8851
|
+
conditions?: components$c["schemas"]["ComponentParameterConditions"];
|
|
9139
8852
|
/** Locale-specific conditional values for this parameter. Keys are locale codes, and values are the `conditions` for that locale. */
|
|
9140
8853
|
localesConditions?: {
|
|
9141
|
-
[key: string]: components$
|
|
8854
|
+
[key: string]: components$c["schemas"]["ComponentParameterConditions"];
|
|
9142
8855
|
};
|
|
9143
8856
|
};
|
|
9144
8857
|
ProjectMapNodeAllowedQueryString: {
|
|
@@ -9173,7 +8886,7 @@ interface components$b {
|
|
|
9173
8886
|
/** 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
8887
|
isSearchHit?: boolean;
|
|
9175
8888
|
/** Query strings that are allowed to be passed to the node */
|
|
9176
|
-
queryStrings?: components$
|
|
8889
|
+
queryStrings?: components$c["schemas"]["ProjectMapNodeAllowedQueryString"][];
|
|
9177
8890
|
/**
|
|
9178
8891
|
* For dynamic nodes, this is the preview value for the dynamic value.
|
|
9179
8892
|
* The preview value is used when editing a connected composition, and is the default
|
|
@@ -9198,7 +8911,7 @@ interface components$b {
|
|
|
9198
8911
|
* Unique identifier for the project map that this node belongs to
|
|
9199
8912
|
*/
|
|
9200
8913
|
projectMapId: string;
|
|
9201
|
-
data?: components$
|
|
8914
|
+
data?: components$c["schemas"]["ProjectMapNodeData"];
|
|
9202
8915
|
/**
|
|
9203
8916
|
* Locale-specific paths of the project map node.
|
|
9204
8917
|
* Keys are locale codes
|
|
@@ -9218,13 +8931,13 @@ interface components$b {
|
|
|
9218
8931
|
type: string;
|
|
9219
8932
|
/** Component parameter values for the component instance */
|
|
9220
8933
|
parameters?: {
|
|
9221
|
-
[key: string]: components$
|
|
8934
|
+
[key: string]: components$c["schemas"]["ComponentParameter"];
|
|
9222
8935
|
};
|
|
9223
8936
|
/** Public ID of alternate visual appearance for this component, if any selected */
|
|
9224
8937
|
variant?: string;
|
|
9225
8938
|
/** Slots containing any child components */
|
|
9226
8939
|
slots?: {
|
|
9227
|
-
[key: string]: components$
|
|
8940
|
+
[key: string]: components$c["schemas"]["ComponentInstance"][];
|
|
9228
8941
|
};
|
|
9229
8942
|
/**
|
|
9230
8943
|
* Unique identifier of the component within the composition.
|
|
@@ -9235,20 +8948,20 @@ interface components$b {
|
|
|
9235
8948
|
_id?: string;
|
|
9236
8949
|
/** Indicates this component instance should be sourced from a pattern library pattern */
|
|
9237
8950
|
_pattern?: string;
|
|
9238
|
-
_dataResources?: components$
|
|
8951
|
+
_dataResources?: components$c["schemas"]["DataResourceDefinitions"];
|
|
9239
8952
|
/**
|
|
9240
8953
|
* Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
|
9241
8954
|
* Means nothing for PUTs; it will be ignored
|
|
9242
8955
|
*/
|
|
9243
8956
|
_patternDataResources?: {
|
|
9244
|
-
[key: string]: components$
|
|
8957
|
+
[key: string]: components$c["schemas"]["DataResourceDefinition"];
|
|
9245
8958
|
};
|
|
9246
8959
|
/**
|
|
9247
8960
|
* Query-string opt-ins coming from a pattern resolved for this component.
|
|
9248
8961
|
* Means nothing for PUTs; it will be ignored
|
|
9249
8962
|
*/
|
|
9250
8963
|
_patternOptedInQueryStrings?: string[];
|
|
9251
|
-
_patternError?: components$
|
|
8964
|
+
_patternError?: components$c["schemas"]["PatternError"];
|
|
9252
8965
|
/**
|
|
9253
8966
|
* Defines patch overrides to component IDs that live in the composition.
|
|
9254
8967
|
* This can be used to override parameters that are defined on patterns,
|
|
@@ -9262,14 +8975,14 @@ interface components$b {
|
|
|
9262
8975
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
9263
8976
|
*/
|
|
9264
8977
|
_overrides?: {
|
|
9265
|
-
[key: string]: components$
|
|
8978
|
+
[key: string]: components$c["schemas"]["ComponentOverride"];
|
|
9266
8979
|
};
|
|
9267
8980
|
/**
|
|
9268
8981
|
* Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
|
|
9269
8982
|
* Means nothing for PUTs; it will be ignored
|
|
9270
8983
|
*/
|
|
9271
8984
|
_patternOverrides?: {
|
|
9272
|
-
[key: string]: components$
|
|
8985
|
+
[key: string]: components$c["schemas"]["ComponentOverride"];
|
|
9273
8986
|
};
|
|
9274
8987
|
/**
|
|
9275
8988
|
* When used on a pattern, defines how the pattern's parameters may be overridden
|
|
@@ -9278,7 +8991,7 @@ interface components$b {
|
|
|
9278
8991
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
9279
8992
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
9280
8993
|
*/
|
|
9281
|
-
_overridability?: components$
|
|
8994
|
+
_overridability?: components$c["schemas"]["ComponentOverridability"];
|
|
9282
8995
|
/** Array of locales that have data defined. Only set for pattern references or composition defaults */
|
|
9283
8996
|
_locales?: string[];
|
|
9284
8997
|
};
|
|
@@ -9303,14 +9016,14 @@ interface components$b {
|
|
|
9303
9016
|
* If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
|
|
9304
9017
|
*/
|
|
9305
9018
|
optionalPatternParameter?: boolean;
|
|
9306
|
-
variables?: components$
|
|
9019
|
+
variables?: components$c["schemas"]["DataResourceVariables"];
|
|
9307
9020
|
};
|
|
9308
9021
|
/**
|
|
9309
9022
|
* Data definitions attached to this component. The property name is the key of the data in the data document.
|
|
9310
9023
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key)
|
|
9311
9024
|
*/
|
|
9312
9025
|
DataResourceDefinitions: {
|
|
9313
|
-
[key: string]: components$
|
|
9026
|
+
[key: string]: components$c["schemas"]["DataResourceDefinition"];
|
|
9314
9027
|
};
|
|
9315
9028
|
/**
|
|
9316
9029
|
* Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
|
@@ -9328,10 +9041,10 @@ interface components$b {
|
|
|
9328
9041
|
*/
|
|
9329
9042
|
ComponentOverride: {
|
|
9330
9043
|
parameters?: {
|
|
9331
|
-
[key: string]: components$
|
|
9044
|
+
[key: string]: components$c["schemas"]["ComponentParameter"];
|
|
9332
9045
|
};
|
|
9333
9046
|
slots?: {
|
|
9334
|
-
[key: string]: components$
|
|
9047
|
+
[key: string]: components$c["schemas"]["ComponentInstance"][];
|
|
9335
9048
|
};
|
|
9336
9049
|
variant?: string;
|
|
9337
9050
|
/**
|
|
@@ -9340,7 +9053,7 @@ interface components$b {
|
|
|
9340
9053
|
* Overrides defined here replace values in either _dataResources or _patternDataResources on the target component.
|
|
9341
9054
|
*/
|
|
9342
9055
|
dataResources?: {
|
|
9343
|
-
[key: string]: components$
|
|
9056
|
+
[key: string]: components$c["schemas"]["DataResourceDefinition"];
|
|
9344
9057
|
};
|
|
9345
9058
|
};
|
|
9346
9059
|
/**
|
|
@@ -9361,7 +9074,7 @@ interface components$b {
|
|
|
9361
9074
|
ComponentOverridability: {
|
|
9362
9075
|
/** Defines component parameter value overrides. Keys are the parameter public ID */
|
|
9363
9076
|
parameters?: {
|
|
9364
|
-
[key: string]: components$
|
|
9077
|
+
[key: string]: components$c["schemas"]["OverrideOptions"];
|
|
9365
9078
|
};
|
|
9366
9079
|
/** Allows overriding a display variant is allowed if it is defined on the component the pattern is derived from. Default = false */
|
|
9367
9080
|
variants?: boolean;
|
|
@@ -9378,15 +9091,15 @@ interface components$b {
|
|
|
9378
9091
|
type: string;
|
|
9379
9092
|
/** Component parameter values for the component instance */
|
|
9380
9093
|
parameters?: {
|
|
9381
|
-
[key: string]: components$
|
|
9094
|
+
[key: string]: components$c["schemas"]["ComponentParameter"];
|
|
9382
9095
|
};
|
|
9383
9096
|
/** Public ID of alternate visual appearance for this component, if any selected */
|
|
9384
9097
|
variant?: string;
|
|
9385
9098
|
/** Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated */
|
|
9386
|
-
projectMapNodes?: components$
|
|
9099
|
+
projectMapNodes?: components$c["schemas"]["CompositionProjectMapNodeInfo"][];
|
|
9387
9100
|
/** Slots containing any child components */
|
|
9388
9101
|
slots?: {
|
|
9389
|
-
[key: string]: components$
|
|
9102
|
+
[key: string]: components$c["schemas"]["ComponentInstance"][];
|
|
9390
9103
|
};
|
|
9391
9104
|
/** The ID of the composition */
|
|
9392
9105
|
_id: string;
|
|
@@ -9409,15 +9122,15 @@ interface components$b {
|
|
|
9409
9122
|
* Means nothing for PUTs; it will be ignored
|
|
9410
9123
|
*/
|
|
9411
9124
|
_patternDataResources?: {
|
|
9412
|
-
[key: string]: components$
|
|
9125
|
+
[key: string]: components$c["schemas"]["DataResourceDefinition"];
|
|
9413
9126
|
};
|
|
9414
9127
|
/**
|
|
9415
9128
|
* Query-string opt-ins coming from a pattern resolved for this component.
|
|
9416
9129
|
* Means nothing for PUTs; it will be ignored
|
|
9417
9130
|
*/
|
|
9418
9131
|
_patternOptedInQueryStrings?: string[];
|
|
9419
|
-
_dataResources?: components$
|
|
9420
|
-
_patternError?: components$
|
|
9132
|
+
_dataResources?: components$c["schemas"]["DataResourceDefinitions"];
|
|
9133
|
+
_patternError?: components$c["schemas"]["PatternError"];
|
|
9421
9134
|
/**
|
|
9422
9135
|
* Defines patch overrides to component IDs that live in the composition.
|
|
9423
9136
|
* This can be used to override parameters that are defined on patterns,
|
|
@@ -9431,14 +9144,14 @@ interface components$b {
|
|
|
9431
9144
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
9432
9145
|
*/
|
|
9433
9146
|
_overrides?: {
|
|
9434
|
-
[key: string]: components$
|
|
9147
|
+
[key: string]: components$c["schemas"]["ComponentOverride"];
|
|
9435
9148
|
};
|
|
9436
9149
|
/**
|
|
9437
9150
|
* Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
|
|
9438
9151
|
* Means nothing for PUTs; it will be ignored
|
|
9439
9152
|
*/
|
|
9440
9153
|
_patternOverrides?: {
|
|
9441
|
-
[key: string]: components$
|
|
9154
|
+
[key: string]: components$c["schemas"]["ComponentOverride"];
|
|
9442
9155
|
};
|
|
9443
9156
|
/**
|
|
9444
9157
|
* When used on a pattern, defines how the pattern's parameters may be overridden
|
|
@@ -9447,7 +9160,7 @@ interface components$b {
|
|
|
9447
9160
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
9448
9161
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
9449
9162
|
*/
|
|
9450
|
-
_overridability?: components$
|
|
9163
|
+
_overridability?: components$c["schemas"]["ComponentOverridability"];
|
|
9451
9164
|
/** Array of locales which have data defined on the composition. If empty, the current default locale implicitly has data */
|
|
9452
9165
|
_locales?: string[];
|
|
9453
9166
|
/**
|
|
@@ -9486,7 +9199,7 @@ interface components$b {
|
|
|
9486
9199
|
* NOTE: Users without membership in any role listed here will be unable to execute the transition unless they are team admins
|
|
9487
9200
|
*/
|
|
9488
9201
|
permissions: {
|
|
9489
|
-
[key: string]: components$
|
|
9202
|
+
[key: string]: components$c["schemas"]["WorkflowStageTransitionPermission"];
|
|
9490
9203
|
};
|
|
9491
9204
|
};
|
|
9492
9205
|
/** Definition of a stage in a workflow */
|
|
@@ -9500,7 +9213,7 @@ interface components$b {
|
|
|
9500
9213
|
* listed here, the stage is read-only and publishing is disabled
|
|
9501
9214
|
*/
|
|
9502
9215
|
permissions: {
|
|
9503
|
-
[key: string]: components$
|
|
9216
|
+
[key: string]: components$c["schemas"]["WorkflowStagePermission"];
|
|
9504
9217
|
};
|
|
9505
9218
|
/**
|
|
9506
9219
|
* When true, transitioning into this stage from a different stage will automatically publish the entity.
|
|
@@ -9520,7 +9233,7 @@ interface components$b {
|
|
|
9520
9233
|
* Every stage must define at least one transition, to avoid creating a workflow that
|
|
9521
9234
|
* has a stage that can never be escaped
|
|
9522
9235
|
*/
|
|
9523
|
-
transitions: components$
|
|
9236
|
+
transitions: components$c["schemas"]["WorkflowStageTransition"][];
|
|
9524
9237
|
/**
|
|
9525
9238
|
* Icon name for the stage (e.g. 'chevron-double-right-o')
|
|
9526
9239
|
* @defaultValue chevron-double-right-o
|
|
@@ -9545,7 +9258,7 @@ interface components$b {
|
|
|
9545
9258
|
initialStage: string;
|
|
9546
9259
|
/** All stages of the workflow */
|
|
9547
9260
|
stages: {
|
|
9548
|
-
[key: string]: components$
|
|
9261
|
+
[key: string]: components$c["schemas"]["WorkflowStage"];
|
|
9549
9262
|
};
|
|
9550
9263
|
/** Last modified ISO date string for this definition (ignored for writes) */
|
|
9551
9264
|
modified?: string;
|
|
@@ -9593,6 +9306,8 @@ interface components$b {
|
|
|
9593
9306
|
* Timestamp when the item was moved to trash. Omitted if not in trash.
|
|
9594
9307
|
*/
|
|
9595
9308
|
deletedAt?: string;
|
|
9309
|
+
/** 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. */
|
|
9310
|
+
publishedWhenTrashed?: boolean;
|
|
9596
9311
|
/** User name of the creator of this composition */
|
|
9597
9312
|
creator?: string;
|
|
9598
9313
|
/** User name of the last editor of this composition */
|
|
@@ -9618,7 +9333,7 @@ interface components$b {
|
|
|
9618
9333
|
* The release this composition belongs to. If not set, it belongs to the base
|
|
9619
9334
|
*/
|
|
9620
9335
|
releaseId?: string;
|
|
9621
|
-
composition: components$
|
|
9336
|
+
composition: components$c["schemas"]["RootComponentInstance"];
|
|
9622
9337
|
/**
|
|
9623
9338
|
* Format: uuid
|
|
9624
9339
|
* The workflow ID assigned to this composition, if any. Normally comes from the component definition
|
|
@@ -9636,7 +9351,7 @@ interface components$b {
|
|
|
9636
9351
|
*/
|
|
9637
9352
|
instanceWorkflowId?: string;
|
|
9638
9353
|
/** The full definition of the assigned workflow, if any, including stages, permissions, etc. Returned only when `withWorkflowDefinition` is true */
|
|
9639
|
-
workflowDefinition?: components$
|
|
9354
|
+
workflowDefinition?: components$c["schemas"]["WorkflowDefinition"];
|
|
9640
9355
|
/**
|
|
9641
9356
|
* Format: uuid
|
|
9642
9357
|
* The edition ID. When set, this is a child edition of the composition in _id.
|
|
@@ -9654,7 +9369,7 @@ interface components$b {
|
|
|
9654
9369
|
editionPriority?: number;
|
|
9655
9370
|
};
|
|
9656
9371
|
CompositionListResponse: {
|
|
9657
|
-
compositions: components$
|
|
9372
|
+
compositions: components$c["schemas"]["CompositionApiResponse"][];
|
|
9658
9373
|
/** Total number of compositions that match the query. Present only when `withTotalCount` option is true */
|
|
9659
9374
|
totalCount?: number;
|
|
9660
9375
|
/** Per-field counts for distinct values */
|
|
@@ -9715,10 +9430,10 @@ interface components$b {
|
|
|
9715
9430
|
RouteResponseRedirect: {
|
|
9716
9431
|
/** The route that was matched in the redirects */
|
|
9717
9432
|
matchedRoute: string;
|
|
9718
|
-
dynamicInputs?: components$
|
|
9433
|
+
dynamicInputs?: components$c["schemas"]["RouteDynamicInputs"];
|
|
9719
9434
|
/** @enum {string} */
|
|
9720
9435
|
type: "redirect";
|
|
9721
|
-
redirect: components$
|
|
9436
|
+
redirect: components$c["schemas"]["Redirect"];
|
|
9722
9437
|
};
|
|
9723
9438
|
/**
|
|
9724
9439
|
* The route does not match any configured redirections or compositions.
|
|
@@ -9758,15 +9473,15 @@ interface components$b {
|
|
|
9758
9473
|
_locales?: string[];
|
|
9759
9474
|
/** Entry field values */
|
|
9760
9475
|
fields?: {
|
|
9761
|
-
[key: string]: components$
|
|
9476
|
+
[key: string]: components$c["schemas"]["ComponentParameter"];
|
|
9762
9477
|
};
|
|
9763
|
-
_dataResources?: components$
|
|
9478
|
+
_dataResources?: components$c["schemas"]["DataResourceDefinitions"];
|
|
9764
9479
|
/**
|
|
9765
9480
|
* Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
|
9766
9481
|
* Means nothing for PUTs; it will be ignored
|
|
9767
9482
|
*/
|
|
9768
9483
|
_patternDataResources?: {
|
|
9769
|
-
[key: string]: components$
|
|
9484
|
+
[key: string]: components$c["schemas"]["DataResourceDefinition"];
|
|
9770
9485
|
};
|
|
9771
9486
|
/**
|
|
9772
9487
|
* Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
|
@@ -9789,7 +9504,7 @@ interface components$b {
|
|
|
9789
9504
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
9790
9505
|
*/
|
|
9791
9506
|
_overrides?: {
|
|
9792
|
-
[key: string]: components$
|
|
9507
|
+
[key: string]: components$c["schemas"]["ComponentOverride"];
|
|
9793
9508
|
};
|
|
9794
9509
|
/**
|
|
9795
9510
|
* When used on a pattern, defines how the pattern's parameters may be overridden
|
|
@@ -9798,7 +9513,7 @@ interface components$b {
|
|
|
9798
9513
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
9799
9514
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
9800
9515
|
*/
|
|
9801
|
-
_overridability?: components$
|
|
9516
|
+
_overridability?: components$c["schemas"]["ComponentOverridability"];
|
|
9802
9517
|
};
|
|
9803
9518
|
EntryApiResponse: {
|
|
9804
9519
|
/** Publishing state to fetch. 0 = draft, 64 = published */
|
|
@@ -9834,12 +9549,14 @@ interface components$b {
|
|
|
9834
9549
|
* Timestamp when the item was moved to trash. Omitted if not in trash.
|
|
9835
9550
|
*/
|
|
9836
9551
|
deletedAt?: string;
|
|
9552
|
+
/** 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. */
|
|
9553
|
+
publishedWhenTrashed?: boolean;
|
|
9837
9554
|
/**
|
|
9838
9555
|
* True if the entry is a pattern (which can be referenced on other entries)
|
|
9839
9556
|
* @defaultValue false
|
|
9840
9557
|
*/
|
|
9841
9558
|
pattern?: boolean;
|
|
9842
|
-
entry: components$
|
|
9559
|
+
entry: components$c["schemas"]["Entry"];
|
|
9843
9560
|
/**
|
|
9844
9561
|
* Format: uuid
|
|
9845
9562
|
* The workflow ID that this entry is assigned. Normally comes from the content type
|
|
@@ -9857,7 +9574,7 @@ interface components$b {
|
|
|
9857
9574
|
*/
|
|
9858
9575
|
instanceWorkflowId?: string;
|
|
9859
9576
|
/** The full definition of the assigned workflow, if any, including stages, permissions, etc. Only returned when `withWorkflowDefinition` is true */
|
|
9860
|
-
workflowDefinition?: components$
|
|
9577
|
+
workflowDefinition?: components$c["schemas"]["WorkflowDefinition"];
|
|
9861
9578
|
/**
|
|
9862
9579
|
* Only present if an incomplete entry is returned; indicates reason for stubbing
|
|
9863
9580
|
|
|
@@ -9880,7 +9597,7 @@ interface components$b {
|
|
|
9880
9597
|
editionPriority?: number;
|
|
9881
9598
|
};
|
|
9882
9599
|
EntryListResponse: {
|
|
9883
|
-
entries: components$
|
|
9600
|
+
entries: components$c["schemas"]["EntryApiResponse"][];
|
|
9884
9601
|
/** Total number of entries that match the query. Only present when `withTotalCount` option is true */
|
|
9885
9602
|
totalCount?: number;
|
|
9886
9603
|
/** Per-field counts for distinct values */
|
|
@@ -9898,7 +9615,7 @@ interface components$b {
|
|
|
9898
9615
|
[name: string]: unknown;
|
|
9899
9616
|
};
|
|
9900
9617
|
content: {
|
|
9901
|
-
"application/json": components$
|
|
9618
|
+
"application/json": components$c["schemas"]["UniformError"];
|
|
9902
9619
|
};
|
|
9903
9620
|
};
|
|
9904
9621
|
/** Provided token or API key does not have access to the requested resource */
|
|
@@ -9907,7 +9624,7 @@ interface components$b {
|
|
|
9907
9624
|
[name: string]: unknown;
|
|
9908
9625
|
};
|
|
9909
9626
|
content: {
|
|
9910
|
-
"application/json": components$
|
|
9627
|
+
"application/json": components$c["schemas"]["UniformError"];
|
|
9911
9628
|
};
|
|
9912
9629
|
};
|
|
9913
9630
|
/** Provided token or API key does not allow this action */
|
|
@@ -9916,7 +9633,7 @@ interface components$b {
|
|
|
9916
9633
|
[name: string]: unknown;
|
|
9917
9634
|
};
|
|
9918
9635
|
content: {
|
|
9919
|
-
"application/json": components$
|
|
9636
|
+
"application/json": components$c["schemas"]["UniformError"];
|
|
9920
9637
|
};
|
|
9921
9638
|
};
|
|
9922
9639
|
/** The requested resource does not exist */
|
|
@@ -9925,7 +9642,7 @@ interface components$b {
|
|
|
9925
9642
|
[name: string]: unknown;
|
|
9926
9643
|
};
|
|
9927
9644
|
content: {
|
|
9928
|
-
"application/json": components$
|
|
9645
|
+
"application/json": components$c["schemas"]["UniformError"];
|
|
9929
9646
|
};
|
|
9930
9647
|
};
|
|
9931
9648
|
/** Invalid method was used to call the endpoint */
|
|
@@ -9934,7 +9651,7 @@ interface components$b {
|
|
|
9934
9651
|
[name: string]: unknown;
|
|
9935
9652
|
};
|
|
9936
9653
|
content: {
|
|
9937
|
-
"application/json": components$
|
|
9654
|
+
"application/json": components$c["schemas"]["UniformError"];
|
|
9938
9655
|
};
|
|
9939
9656
|
};
|
|
9940
9657
|
/** The request body could not be parsed or understood */
|
|
@@ -9943,7 +9660,7 @@ interface components$b {
|
|
|
9943
9660
|
[name: string]: unknown;
|
|
9944
9661
|
};
|
|
9945
9662
|
content: {
|
|
9946
|
-
"application/json": components$
|
|
9663
|
+
"application/json": components$c["schemas"]["UniformError"];
|
|
9947
9664
|
};
|
|
9948
9665
|
};
|
|
9949
9666
|
/** The endpoint is called too often */
|
|
@@ -9952,7 +9669,7 @@ interface components$b {
|
|
|
9952
9669
|
[name: string]: unknown;
|
|
9953
9670
|
};
|
|
9954
9671
|
content: {
|
|
9955
|
-
"application/json": components$
|
|
9672
|
+
"application/json": components$c["schemas"]["UniformError"];
|
|
9956
9673
|
};
|
|
9957
9674
|
};
|
|
9958
9675
|
/** An unexpected error occurred */
|
|
@@ -9961,7 +9678,7 @@ interface components$b {
|
|
|
9961
9678
|
[name: string]: unknown;
|
|
9962
9679
|
};
|
|
9963
9680
|
content: {
|
|
9964
|
-
"application/json": components$
|
|
9681
|
+
"application/json": components$c["schemas"]["UniformError"];
|
|
9965
9682
|
};
|
|
9966
9683
|
};
|
|
9967
9684
|
};
|
|
@@ -10174,10 +9891,8 @@ interface components$b {
|
|
|
10174
9891
|
* * If still ambiguous, the first matching route arbitrarily wins
|
|
10175
9892
|
*
|
|
10176
9893
|
* Invalid paths:
|
|
10177
|
-
* The request fails with HTTP 400 when the path, ignoring its query string and trailing slashes
|
|
10178
|
-
*
|
|
10179
|
-
* * has a path segment that is too long to match any route. The limit depends on the characters used,
|
|
10180
|
-
* and is generally 150-220 characters per segment.
|
|
9894
|
+
* The request fails with HTTP 400 when the path, ignoring its query string and trailing slashes,
|
|
9895
|
+
* contains consecutive slashes (for example "/en//about" or "//en/about").
|
|
10181
9896
|
*
|
|
10182
9897
|
* Probe paths:
|
|
10183
9898
|
* On uniform.global, paths ending in an archive, backup or database file extension (for example "/site.zip",
|
|
@@ -10271,7 +9986,7 @@ interface components$b {
|
|
|
10271
9986
|
pathItems: never;
|
|
10272
9987
|
}
|
|
10273
9988
|
|
|
10274
|
-
interface paths$
|
|
9989
|
+
interface paths$b {
|
|
10275
9990
|
"/api/v1/route": {
|
|
10276
9991
|
parameters: {
|
|
10277
9992
|
query?: never;
|
|
@@ -10337,7 +10052,7 @@ interface paths$a {
|
|
|
10337
10052
|
parameters: {
|
|
10338
10053
|
query: {
|
|
10339
10054
|
/** The project to fetch a route from */
|
|
10340
|
-
projectId: components$
|
|
10055
|
+
projectId: components$b["parameters"]["projectId"];
|
|
10341
10056
|
/**
|
|
10342
10057
|
* The path to resolve. Dynamic project map nodes and redirects can be resolved when a matching path is passed.
|
|
10343
10058
|
* Query string parameters may be passed with the path. They are ignored for route matching.
|
|
@@ -10358,31 +10073,29 @@ interface paths$a {
|
|
|
10358
10073
|
* * If still ambiguous, the first matching route arbitrarily wins
|
|
10359
10074
|
*
|
|
10360
10075
|
* Invalid paths:
|
|
10361
|
-
* The request fails with HTTP 400 when the path, ignoring its query string and trailing slashes
|
|
10362
|
-
*
|
|
10363
|
-
* * has a path segment that is too long to match any route. The limit depends on the characters used,
|
|
10364
|
-
* and is generally 150-220 characters per segment.
|
|
10076
|
+
* The request fails with HTTP 400 when the path, ignoring its query string and trailing slashes,
|
|
10077
|
+
* contains consecutive slashes (for example "/en//about" or "//en/about").
|
|
10365
10078
|
*
|
|
10366
10079
|
* Probe paths:
|
|
10367
10080
|
* On uniform.global, paths ending in an archive, backup or database file extension (for example "/site.zip",
|
|
10368
10081
|
* "/config.php.bak" or "/db.sql") return `{ "type": "notFound" }` without being matched, even where a dynamic
|
|
10369
10082
|
* project map node or redirect would match them.
|
|
10370
10083
|
*/
|
|
10371
|
-
path: components$
|
|
10084
|
+
path: components$b["parameters"]["path"];
|
|
10372
10085
|
/** Specify a project map ID to fetch route from. If not specified, the default project map for the projectId is used */
|
|
10373
|
-
projectMapId?: components$
|
|
10086
|
+
projectMapId?: components$b["parameters"]["projectMapId"];
|
|
10374
10087
|
/** Publishing state to fetch. 0 = draft, 64 = published */
|
|
10375
|
-
state?: components$
|
|
10088
|
+
state?: components$b["parameters"]["state"];
|
|
10376
10089
|
/**
|
|
10377
10090
|
* If true the `_id` unique identifier of each non-root component will be part of the response data.
|
|
10378
10091
|
* If false, the `_id` will not be present in the API response
|
|
10379
10092
|
*/
|
|
10380
|
-
withComponentIDs?: components$
|
|
10093
|
+
withComponentIDs?: components$b["parameters"]["withComponentIDs"];
|
|
10381
10094
|
/**
|
|
10382
10095
|
* @deprecated
|
|
10383
10096
|
* Has no effect.
|
|
10384
10097
|
*/
|
|
10385
|
-
withContentSourceMap?: components$
|
|
10098
|
+
withContentSourceMap?: components$b["parameters"]["withContentSourceMap"];
|
|
10386
10099
|
/**
|
|
10387
10100
|
* One or more locales to localize the response to.
|
|
10388
10101
|
* When the result is a composition, it includes only the first matching locale's data.
|
|
@@ -10399,7 +10112,7 @@ interface paths$a {
|
|
|
10399
10112
|
*
|
|
10400
10113
|
* When the result is a redirect, this parameter has no effect
|
|
10401
10114
|
*/
|
|
10402
|
-
locale?: components$
|
|
10115
|
+
locale?: components$b["parameters"]["locale"];
|
|
10403
10116
|
/**
|
|
10404
10117
|
* The ID of a release to fetch the content for.
|
|
10405
10118
|
*
|
|
@@ -10408,19 +10121,19 @@ interface paths$a {
|
|
|
10408
10121
|
*
|
|
10409
10122
|
* 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
10123
|
*/
|
|
10411
|
-
releaseId?: components$
|
|
10124
|
+
releaseId?: components$b["parameters"]["releaseId"];
|
|
10412
10125
|
/**
|
|
10413
10126
|
* Indicates the data variant that was fetched for data resources.
|
|
10414
10127
|
* undefined: Data resources were resolved using published data from their data source
|
|
10415
10128
|
* 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
10129
|
*/
|
|
10417
|
-
dataSourceVariant?: components$
|
|
10130
|
+
dataSourceVariant?: components$b["parameters"]["dataSourceVariant"];
|
|
10418
10131
|
/**
|
|
10419
10132
|
* When true, redirects are not evaluated for the route matching; the result will be either a composition or not found.
|
|
10420
10133
|
* Note: this is always true when state=63 (internal RSC editor state) to allow contextual editing of compositions
|
|
10421
10134
|
* that have redirects configured on their paths.
|
|
10422
10135
|
*/
|
|
10423
|
-
ignoreRedirects?: components$
|
|
10136
|
+
ignoreRedirects?: components$b["parameters"]["ignoreRedirects"];
|
|
10424
10137
|
};
|
|
10425
10138
|
header?: never;
|
|
10426
10139
|
path?: never;
|
|
@@ -10434,14 +10147,14 @@ interface paths$a {
|
|
|
10434
10147
|
[name: string]: unknown;
|
|
10435
10148
|
};
|
|
10436
10149
|
content: {
|
|
10437
|
-
"application/json": components$
|
|
10150
|
+
"application/json": components$b["schemas"]["RouteResponse"];
|
|
10438
10151
|
};
|
|
10439
10152
|
};
|
|
10440
|
-
400: components$
|
|
10441
|
-
401: components$
|
|
10442
|
-
403: components$
|
|
10443
|
-
429: components$
|
|
10444
|
-
500: components$
|
|
10153
|
+
400: components$b["responses"]["BadRequestError"];
|
|
10154
|
+
401: components$b["responses"]["UnauthorizedError"];
|
|
10155
|
+
403: components$b["responses"]["ForbiddenError"];
|
|
10156
|
+
429: components$b["responses"]["RateLimitError"];
|
|
10157
|
+
500: components$b["responses"]["InternalServerError"];
|
|
10445
10158
|
};
|
|
10446
10159
|
};
|
|
10447
10160
|
put?: never;
|
|
@@ -10471,7 +10184,7 @@ interface paths$a {
|
|
|
10471
10184
|
trace?: never;
|
|
10472
10185
|
};
|
|
10473
10186
|
}
|
|
10474
|
-
interface components$
|
|
10187
|
+
interface components$b {
|
|
10475
10188
|
schemas: {
|
|
10476
10189
|
RouteDynamicInputs: {
|
|
10477
10190
|
[key: string]: string;
|
|
@@ -10520,10 +10233,10 @@ interface components$a {
|
|
|
10520
10233
|
RouteResponseRedirect: {
|
|
10521
10234
|
/** The route that was matched in the redirects */
|
|
10522
10235
|
matchedRoute: string;
|
|
10523
|
-
dynamicInputs?: components$
|
|
10236
|
+
dynamicInputs?: components$b["schemas"]["RouteDynamicInputs"];
|
|
10524
10237
|
/** @enum {string} */
|
|
10525
10238
|
type: "redirect";
|
|
10526
|
-
redirect: components$
|
|
10239
|
+
redirect: components$b["schemas"]["Redirect"];
|
|
10527
10240
|
};
|
|
10528
10241
|
/** Defines a connection to a dynamic token on a data resource */
|
|
10529
10242
|
DataElementConnectionDefinition: {
|
|
@@ -10589,11 +10302,11 @@ interface components$a {
|
|
|
10589
10302
|
|
|
10590
10303
|
*/
|
|
10591
10304
|
op?: "&" | "|";
|
|
10592
|
-
clauses: (components$
|
|
10305
|
+
clauses: (components$b["schemas"]["VisibilityCriteria"] | components$b["schemas"]["VisibilityCriteriaGroup"])[];
|
|
10593
10306
|
};
|
|
10594
10307
|
/** Defines a conditional value for a component parameter */
|
|
10595
10308
|
ComponentParameterConditionalValue: {
|
|
10596
|
-
when: components$
|
|
10309
|
+
when: components$b["schemas"]["VisibilityCriteriaGroup"];
|
|
10597
10310
|
/**
|
|
10598
10311
|
* The value of the parameter. Any JSON-serializable value is acceptable.
|
|
10599
10312
|
* A value of `null` will cause the parameter value to be removed, if it matches.
|
|
@@ -10615,7 +10328,7 @@ interface components$a {
|
|
|
10615
10328
|
*
|
|
10616
10329
|
* When no locale is passed to a non-route API, conditions are not processed and all conditions are returned.
|
|
10617
10330
|
*/
|
|
10618
|
-
ComponentParameterConditions: components$
|
|
10331
|
+
ComponentParameterConditions: components$b["schemas"]["ComponentParameterConditionalValue"][];
|
|
10619
10332
|
/** Defines an editable parameter on a component */
|
|
10620
10333
|
ComponentParameter: {
|
|
10621
10334
|
/** The value of the parameter. Any JSON-serializable value is acceptable */
|
|
@@ -10623,7 +10336,7 @@ interface components$a {
|
|
|
10623
10336
|
/** The type of the parameter. Determines how it is displayed when editing and tells the consumer how to process it */
|
|
10624
10337
|
type: string;
|
|
10625
10338
|
/** @deprecated */
|
|
10626
|
-
connectedData?: components$
|
|
10339
|
+
connectedData?: components$b["schemas"]["DataElementConnectionDefinition"];
|
|
10627
10340
|
/**
|
|
10628
10341
|
* Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
|
|
10629
10342
|
* Note that locales must be registered on the entry/composition `_locales` before being used
|
|
@@ -10631,10 +10344,10 @@ interface components$a {
|
|
|
10631
10344
|
locales?: {
|
|
10632
10345
|
[key: string]: unknown;
|
|
10633
10346
|
};
|
|
10634
|
-
conditions?: components$
|
|
10347
|
+
conditions?: components$b["schemas"]["ComponentParameterConditions"];
|
|
10635
10348
|
/** Locale-specific conditional values for this parameter. Keys are locale codes, and values are the `conditions` for that locale. */
|
|
10636
10349
|
localesConditions?: {
|
|
10637
|
-
[key: string]: components$
|
|
10350
|
+
[key: string]: components$b["schemas"]["ComponentParameterConditions"];
|
|
10638
10351
|
};
|
|
10639
10352
|
};
|
|
10640
10353
|
ProjectMapNodeAllowedQueryString: {
|
|
@@ -10669,7 +10382,7 @@ interface components$a {
|
|
|
10669
10382
|
/** 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
10383
|
isSearchHit?: boolean;
|
|
10671
10384
|
/** Query strings that are allowed to be passed to the node */
|
|
10672
|
-
queryStrings?: components$
|
|
10385
|
+
queryStrings?: components$b["schemas"]["ProjectMapNodeAllowedQueryString"][];
|
|
10673
10386
|
/**
|
|
10674
10387
|
* For dynamic nodes, this is the preview value for the dynamic value.
|
|
10675
10388
|
* The preview value is used when editing a connected composition, and is the default
|
|
@@ -10694,7 +10407,7 @@ interface components$a {
|
|
|
10694
10407
|
* Unique identifier for the project map that this node belongs to
|
|
10695
10408
|
*/
|
|
10696
10409
|
projectMapId: string;
|
|
10697
|
-
data?: components$
|
|
10410
|
+
data?: components$b["schemas"]["ProjectMapNodeData"];
|
|
10698
10411
|
/**
|
|
10699
10412
|
* Locale-specific paths of the project map node.
|
|
10700
10413
|
* Keys are locale codes
|
|
@@ -10714,13 +10427,13 @@ interface components$a {
|
|
|
10714
10427
|
type: string;
|
|
10715
10428
|
/** Component parameter values for the component instance */
|
|
10716
10429
|
parameters?: {
|
|
10717
|
-
[key: string]: components$
|
|
10430
|
+
[key: string]: components$b["schemas"]["ComponentParameter"];
|
|
10718
10431
|
};
|
|
10719
10432
|
/** Public ID of alternate visual appearance for this component, if any selected */
|
|
10720
10433
|
variant?: string;
|
|
10721
10434
|
/** Slots containing any child components */
|
|
10722
10435
|
slots?: {
|
|
10723
|
-
[key: string]: components$
|
|
10436
|
+
[key: string]: components$b["schemas"]["ComponentInstance"][];
|
|
10724
10437
|
};
|
|
10725
10438
|
/**
|
|
10726
10439
|
* Unique identifier of the component within the composition.
|
|
@@ -10731,20 +10444,20 @@ interface components$a {
|
|
|
10731
10444
|
_id?: string;
|
|
10732
10445
|
/** Indicates this component instance should be sourced from a pattern library pattern */
|
|
10733
10446
|
_pattern?: string;
|
|
10734
|
-
_dataResources?: components$
|
|
10447
|
+
_dataResources?: components$b["schemas"]["DataResourceDefinitions"];
|
|
10735
10448
|
/**
|
|
10736
10449
|
* Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
|
10737
10450
|
* Means nothing for PUTs; it will be ignored
|
|
10738
10451
|
*/
|
|
10739
10452
|
_patternDataResources?: {
|
|
10740
|
-
[key: string]: components$
|
|
10453
|
+
[key: string]: components$b["schemas"]["DataResourceDefinition"];
|
|
10741
10454
|
};
|
|
10742
10455
|
/**
|
|
10743
10456
|
* Query-string opt-ins coming from a pattern resolved for this component.
|
|
10744
10457
|
* Means nothing for PUTs; it will be ignored
|
|
10745
10458
|
*/
|
|
10746
10459
|
_patternOptedInQueryStrings?: string[];
|
|
10747
|
-
_patternError?: components$
|
|
10460
|
+
_patternError?: components$b["schemas"]["PatternError"];
|
|
10748
10461
|
/**
|
|
10749
10462
|
* Defines patch overrides to component IDs that live in the composition.
|
|
10750
10463
|
* This can be used to override parameters that are defined on patterns,
|
|
@@ -10758,14 +10471,14 @@ interface components$a {
|
|
|
10758
10471
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
10759
10472
|
*/
|
|
10760
10473
|
_overrides?: {
|
|
10761
|
-
[key: string]: components$
|
|
10474
|
+
[key: string]: components$b["schemas"]["ComponentOverride"];
|
|
10762
10475
|
};
|
|
10763
10476
|
/**
|
|
10764
10477
|
* Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
|
|
10765
10478
|
* Means nothing for PUTs; it will be ignored
|
|
10766
10479
|
*/
|
|
10767
10480
|
_patternOverrides?: {
|
|
10768
|
-
[key: string]: components$
|
|
10481
|
+
[key: string]: components$b["schemas"]["ComponentOverride"];
|
|
10769
10482
|
};
|
|
10770
10483
|
/**
|
|
10771
10484
|
* When used on a pattern, defines how the pattern's parameters may be overridden
|
|
@@ -10774,7 +10487,7 @@ interface components$a {
|
|
|
10774
10487
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
10775
10488
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
10776
10489
|
*/
|
|
10777
|
-
_overridability?: components$
|
|
10490
|
+
_overridability?: components$b["schemas"]["ComponentOverridability"];
|
|
10778
10491
|
/** Array of locales that have data defined. Only set for pattern references or composition defaults */
|
|
10779
10492
|
_locales?: string[];
|
|
10780
10493
|
};
|
|
@@ -10799,14 +10512,14 @@ interface components$a {
|
|
|
10799
10512
|
* If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
|
|
10800
10513
|
*/
|
|
10801
10514
|
optionalPatternParameter?: boolean;
|
|
10802
|
-
variables?: components$
|
|
10515
|
+
variables?: components$b["schemas"]["DataResourceVariables"];
|
|
10803
10516
|
};
|
|
10804
10517
|
/**
|
|
10805
10518
|
* Data definitions attached to this component. The property name is the key of the data in the data document.
|
|
10806
10519
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key)
|
|
10807
10520
|
*/
|
|
10808
10521
|
DataResourceDefinitions: {
|
|
10809
|
-
[key: string]: components$
|
|
10522
|
+
[key: string]: components$b["schemas"]["DataResourceDefinition"];
|
|
10810
10523
|
};
|
|
10811
10524
|
/**
|
|
10812
10525
|
* Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
|
@@ -10824,10 +10537,10 @@ interface components$a {
|
|
|
10824
10537
|
*/
|
|
10825
10538
|
ComponentOverride: {
|
|
10826
10539
|
parameters?: {
|
|
10827
|
-
[key: string]: components$
|
|
10540
|
+
[key: string]: components$b["schemas"]["ComponentParameter"];
|
|
10828
10541
|
};
|
|
10829
10542
|
slots?: {
|
|
10830
|
-
[key: string]: components$
|
|
10543
|
+
[key: string]: components$b["schemas"]["ComponentInstance"][];
|
|
10831
10544
|
};
|
|
10832
10545
|
variant?: string;
|
|
10833
10546
|
/**
|
|
@@ -10836,7 +10549,7 @@ interface components$a {
|
|
|
10836
10549
|
* Overrides defined here replace values in either _dataResources or _patternDataResources on the target component.
|
|
10837
10550
|
*/
|
|
10838
10551
|
dataResources?: {
|
|
10839
|
-
[key: string]: components$
|
|
10552
|
+
[key: string]: components$b["schemas"]["DataResourceDefinition"];
|
|
10840
10553
|
};
|
|
10841
10554
|
};
|
|
10842
10555
|
/**
|
|
@@ -10857,7 +10570,7 @@ interface components$a {
|
|
|
10857
10570
|
ComponentOverridability: {
|
|
10858
10571
|
/** Defines component parameter value overrides. Keys are the parameter public ID */
|
|
10859
10572
|
parameters?: {
|
|
10860
|
-
[key: string]: components$
|
|
10573
|
+
[key: string]: components$b["schemas"]["OverrideOptions"];
|
|
10861
10574
|
};
|
|
10862
10575
|
/** Allows overriding a display variant is allowed if it is defined on the component the pattern is derived from. Default = false */
|
|
10863
10576
|
variants?: boolean;
|
|
@@ -10874,15 +10587,15 @@ interface components$a {
|
|
|
10874
10587
|
type: string;
|
|
10875
10588
|
/** Component parameter values for the component instance */
|
|
10876
10589
|
parameters?: {
|
|
10877
|
-
[key: string]: components$
|
|
10590
|
+
[key: string]: components$b["schemas"]["ComponentParameter"];
|
|
10878
10591
|
};
|
|
10879
10592
|
/** Public ID of alternate visual appearance for this component, if any selected */
|
|
10880
10593
|
variant?: string;
|
|
10881
10594
|
/** Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated */
|
|
10882
|
-
projectMapNodes?: components$
|
|
10595
|
+
projectMapNodes?: components$b["schemas"]["CompositionProjectMapNodeInfo"][];
|
|
10883
10596
|
/** Slots containing any child components */
|
|
10884
10597
|
slots?: {
|
|
10885
|
-
[key: string]: components$
|
|
10598
|
+
[key: string]: components$b["schemas"]["ComponentInstance"][];
|
|
10886
10599
|
};
|
|
10887
10600
|
/** The ID of the composition */
|
|
10888
10601
|
_id: string;
|
|
@@ -10905,15 +10618,15 @@ interface components$a {
|
|
|
10905
10618
|
* Means nothing for PUTs; it will be ignored
|
|
10906
10619
|
*/
|
|
10907
10620
|
_patternDataResources?: {
|
|
10908
|
-
[key: string]: components$
|
|
10621
|
+
[key: string]: components$b["schemas"]["DataResourceDefinition"];
|
|
10909
10622
|
};
|
|
10910
10623
|
/**
|
|
10911
10624
|
* Query-string opt-ins coming from a pattern resolved for this component.
|
|
10912
10625
|
* Means nothing for PUTs; it will be ignored
|
|
10913
10626
|
*/
|
|
10914
10627
|
_patternOptedInQueryStrings?: string[];
|
|
10915
|
-
_dataResources?: components$
|
|
10916
|
-
_patternError?: components$
|
|
10628
|
+
_dataResources?: components$b["schemas"]["DataResourceDefinitions"];
|
|
10629
|
+
_patternError?: components$b["schemas"]["PatternError"];
|
|
10917
10630
|
/**
|
|
10918
10631
|
* Defines patch overrides to component IDs that live in the composition.
|
|
10919
10632
|
* This can be used to override parameters that are defined on patterns,
|
|
@@ -10927,14 +10640,14 @@ interface components$a {
|
|
|
10927
10640
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
10928
10641
|
*/
|
|
10929
10642
|
_overrides?: {
|
|
10930
|
-
[key: string]: components$
|
|
10643
|
+
[key: string]: components$b["schemas"]["ComponentOverride"];
|
|
10931
10644
|
};
|
|
10932
10645
|
/**
|
|
10933
10646
|
* Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
|
|
10934
10647
|
* Means nothing for PUTs; it will be ignored
|
|
10935
10648
|
*/
|
|
10936
10649
|
_patternOverrides?: {
|
|
10937
|
-
[key: string]: components$
|
|
10650
|
+
[key: string]: components$b["schemas"]["ComponentOverride"];
|
|
10938
10651
|
};
|
|
10939
10652
|
/**
|
|
10940
10653
|
* When used on a pattern, defines how the pattern's parameters may be overridden
|
|
@@ -10943,7 +10656,7 @@ interface components$a {
|
|
|
10943
10656
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
10944
10657
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
10945
10658
|
*/
|
|
10946
|
-
_overridability?: components$
|
|
10659
|
+
_overridability?: components$b["schemas"]["ComponentOverridability"];
|
|
10947
10660
|
/** Array of locales which have data defined on the composition. If empty, the current default locale implicitly has data */
|
|
10948
10661
|
_locales?: string[];
|
|
10949
10662
|
/**
|
|
@@ -10982,7 +10695,7 @@ interface components$a {
|
|
|
10982
10695
|
* NOTE: Users without membership in any role listed here will be unable to execute the transition unless they are team admins
|
|
10983
10696
|
*/
|
|
10984
10697
|
permissions: {
|
|
10985
|
-
[key: string]: components$
|
|
10698
|
+
[key: string]: components$b["schemas"]["WorkflowStageTransitionPermission"];
|
|
10986
10699
|
};
|
|
10987
10700
|
};
|
|
10988
10701
|
/** Definition of a stage in a workflow */
|
|
@@ -10996,7 +10709,7 @@ interface components$a {
|
|
|
10996
10709
|
* listed here, the stage is read-only and publishing is disabled
|
|
10997
10710
|
*/
|
|
10998
10711
|
permissions: {
|
|
10999
|
-
[key: string]: components$
|
|
10712
|
+
[key: string]: components$b["schemas"]["WorkflowStagePermission"];
|
|
11000
10713
|
};
|
|
11001
10714
|
/**
|
|
11002
10715
|
* When true, transitioning into this stage from a different stage will automatically publish the entity.
|
|
@@ -11016,7 +10729,7 @@ interface components$a {
|
|
|
11016
10729
|
* Every stage must define at least one transition, to avoid creating a workflow that
|
|
11017
10730
|
* has a stage that can never be escaped
|
|
11018
10731
|
*/
|
|
11019
|
-
transitions: components$
|
|
10732
|
+
transitions: components$b["schemas"]["WorkflowStageTransition"][];
|
|
11020
10733
|
/**
|
|
11021
10734
|
* Icon name for the stage (e.g. 'chevron-double-right-o')
|
|
11022
10735
|
* @defaultValue chevron-double-right-o
|
|
@@ -11041,7 +10754,7 @@ interface components$a {
|
|
|
11041
10754
|
initialStage: string;
|
|
11042
10755
|
/** All stages of the workflow */
|
|
11043
10756
|
stages: {
|
|
11044
|
-
[key: string]: components$
|
|
10757
|
+
[key: string]: components$b["schemas"]["WorkflowStage"];
|
|
11045
10758
|
};
|
|
11046
10759
|
/** Last modified ISO date string for this definition (ignored for writes) */
|
|
11047
10760
|
modified?: string;
|
|
@@ -11089,6 +10802,8 @@ interface components$a {
|
|
|
11089
10802
|
* Timestamp when the item was moved to trash. Omitted if not in trash.
|
|
11090
10803
|
*/
|
|
11091
10804
|
deletedAt?: string;
|
|
10805
|
+
/** 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. */
|
|
10806
|
+
publishedWhenTrashed?: boolean;
|
|
11092
10807
|
/** User name of the creator of this composition */
|
|
11093
10808
|
creator?: string;
|
|
11094
10809
|
/** User name of the last editor of this composition */
|
|
@@ -11114,7 +10829,7 @@ interface components$a {
|
|
|
11114
10829
|
* The release this composition belongs to. If not set, it belongs to the base
|
|
11115
10830
|
*/
|
|
11116
10831
|
releaseId?: string;
|
|
11117
|
-
composition: components$
|
|
10832
|
+
composition: components$b["schemas"]["RootComponentInstance"];
|
|
11118
10833
|
/**
|
|
11119
10834
|
* Format: uuid
|
|
11120
10835
|
* The workflow ID assigned to this composition, if any. Normally comes from the component definition
|
|
@@ -11132,7 +10847,7 @@ interface components$a {
|
|
|
11132
10847
|
*/
|
|
11133
10848
|
instanceWorkflowId?: string;
|
|
11134
10849
|
/** The full definition of the assigned workflow, if any, including stages, permissions, etc. Returned only when `withWorkflowDefinition` is true */
|
|
11135
|
-
workflowDefinition?: components$
|
|
10850
|
+
workflowDefinition?: components$b["schemas"]["WorkflowDefinition"];
|
|
11136
10851
|
/**
|
|
11137
10852
|
* Format: uuid
|
|
11138
10853
|
* The edition ID. When set, this is a child edition of the composition in _id.
|
|
@@ -11149,35 +10864,391 @@ interface components$a {
|
|
|
11149
10864
|
*/
|
|
11150
10865
|
editionPriority?: number;
|
|
11151
10866
|
};
|
|
11152
|
-
/**
|
|
11153
|
-
* The route matches a composition.
|
|
11154
|
-
* If any dynamic segments or query parameters are present in the route, they will be returned as dynamic inputs in the response
|
|
11155
|
-
*/
|
|
11156
|
-
RouteResponseComposition: {
|
|
11157
|
-
/** The route that was matched in the project map */
|
|
11158
|
-
matchedRoute: string;
|
|
11159
|
-
dynamicInputs?: components$
|
|
11160
|
-
/**
|
|
11161
|
-
* Indicates the data variant that was fetched for data resources.
|
|
11162
|
-
* undefined: Data resources were resolved using published data from their data source
|
|
11163
|
-
* unpublished: Data resources which support unpublished data retrieved unpublished data from their data source. Data resources that did not support unpublished data retrieved published data instead.
|
|
11164
|
-
|
|
11165
|
-
*/
|
|
11166
|
-
dataResourcesVariant?: "unpublished";
|
|
11167
|
-
/** @enum {string} */
|
|
11168
|
-
type: "composition";
|
|
11169
|
-
compositionApiResponse: components$
|
|
10867
|
+
/**
|
|
10868
|
+
* The route matches a composition.
|
|
10869
|
+
* If any dynamic segments or query parameters are present in the route, they will be returned as dynamic inputs in the response
|
|
10870
|
+
*/
|
|
10871
|
+
RouteResponseComposition: {
|
|
10872
|
+
/** The route that was matched in the project map */
|
|
10873
|
+
matchedRoute: string;
|
|
10874
|
+
dynamicInputs?: components$b["schemas"]["RouteDynamicInputs"];
|
|
10875
|
+
/**
|
|
10876
|
+
* Indicates the data variant that was fetched for data resources.
|
|
10877
|
+
* undefined: Data resources were resolved using published data from their data source
|
|
10878
|
+
* 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.
|
|
10879
|
+
|
|
10880
|
+
*/
|
|
10881
|
+
dataResourcesVariant?: "unpublished";
|
|
10882
|
+
/** @enum {string} */
|
|
10883
|
+
type: "composition";
|
|
10884
|
+
compositionApiResponse: components$b["schemas"]["CompositionApiResponse"];
|
|
10885
|
+
};
|
|
10886
|
+
/**
|
|
10887
|
+
* The route does not match any configured redirections or compositions.
|
|
10888
|
+
* NOTE: This response differs from a HTTP 404, which indicates that the project map or project ID was not found.
|
|
10889
|
+
* Receiving this response with HTTP 200 means that the project was found, but the route did not match anything
|
|
10890
|
+
*/
|
|
10891
|
+
RouteResponseNotFound: {
|
|
10892
|
+
/** @enum {string} */
|
|
10893
|
+
type: "notFound";
|
|
10894
|
+
};
|
|
10895
|
+
RouteResponse: components$b["schemas"]["RouteResponseRedirect"] | components$b["schemas"]["RouteResponseComposition"] | components$b["schemas"]["RouteResponseNotFound"];
|
|
10896
|
+
Error: {
|
|
10897
|
+
/** Error message(s) that occurred while processing the request */
|
|
10898
|
+
errorMessage?: string[] | string;
|
|
10899
|
+
};
|
|
10900
|
+
};
|
|
10901
|
+
responses: {
|
|
10902
|
+
/** Request input validation failed */
|
|
10903
|
+
BadRequestError: {
|
|
10904
|
+
headers: {
|
|
10905
|
+
[name: string]: unknown;
|
|
10906
|
+
};
|
|
10907
|
+
content: {
|
|
10908
|
+
"application/json": components$b["schemas"]["Error"];
|
|
10909
|
+
};
|
|
10910
|
+
};
|
|
10911
|
+
/** API key or token was not valid */
|
|
10912
|
+
UnauthorizedError: {
|
|
10913
|
+
headers: {
|
|
10914
|
+
[name: string]: unknown;
|
|
10915
|
+
};
|
|
10916
|
+
content: {
|
|
10917
|
+
"application/json": components$b["schemas"]["Error"];
|
|
10918
|
+
};
|
|
10919
|
+
};
|
|
10920
|
+
/** Permission was denied */
|
|
10921
|
+
ForbiddenError: {
|
|
10922
|
+
headers: {
|
|
10923
|
+
[name: string]: unknown;
|
|
10924
|
+
};
|
|
10925
|
+
content: {
|
|
10926
|
+
"application/json": components$b["schemas"]["Error"];
|
|
10927
|
+
};
|
|
10928
|
+
};
|
|
10929
|
+
/** Too many requests in allowed time period */
|
|
10930
|
+
RateLimitError: {
|
|
10931
|
+
headers: {
|
|
10932
|
+
[name: string]: unknown;
|
|
10933
|
+
};
|
|
10934
|
+
content?: never;
|
|
10935
|
+
};
|
|
10936
|
+
/** Execution error occurred */
|
|
10937
|
+
InternalServerError: {
|
|
10938
|
+
headers: {
|
|
10939
|
+
[name: string]: unknown;
|
|
10940
|
+
};
|
|
10941
|
+
content?: never;
|
|
10942
|
+
};
|
|
10943
|
+
};
|
|
10944
|
+
parameters: {
|
|
10945
|
+
/** The project to fetch a route from */
|
|
10946
|
+
projectId: string;
|
|
10947
|
+
/**
|
|
10948
|
+
* The path to resolve. Dynamic project map nodes and redirects can be resolved when a matching path is passed.
|
|
10949
|
+
* Query string parameters may be passed with the path. They are ignored for route matching.
|
|
10950
|
+
* If the route matches a composition and the project map node allows passed query string parameters, query parameters will
|
|
10951
|
+
* be returned as as dynamic inputs to the composition.
|
|
10952
|
+
*
|
|
10953
|
+
* Examples:
|
|
10954
|
+
* * route "/company/about-us" would match "/company/about-us" in project map or redirects
|
|
10955
|
+
* * route "/products/123" would match "/products/:productId" in project map or "/products/*" in redirects
|
|
10956
|
+
* * 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
|
|
10957
|
+
*
|
|
10958
|
+
* Conflict resolution:
|
|
10959
|
+
* If a route matches multiple possible project map or redirect nodes, the resulting action will use the following logic:
|
|
10960
|
+
* * If a redirect matches, it wins over project map nodes in all cases
|
|
10961
|
+
* * If multiple redirects or project map nodes match the route, the one with the most specific path wins:
|
|
10962
|
+
* * The route with the most path segments wins
|
|
10963
|
+
* * If several matches have the same number of segments, the one with the fewest dynamic segments wins
|
|
10964
|
+
* * If still ambiguous, the first matching route arbitrarily wins
|
|
10965
|
+
*
|
|
10966
|
+
* Invalid paths:
|
|
10967
|
+
* The request fails with HTTP 400 when the path, ignoring its query string and trailing slashes,
|
|
10968
|
+
* contains consecutive slashes (for example "/en//about" or "//en/about").
|
|
10969
|
+
*
|
|
10970
|
+
* Probe paths:
|
|
10971
|
+
* On uniform.global, paths ending in an archive, backup or database file extension (for example "/site.zip",
|
|
10972
|
+
* "/config.php.bak" or "/db.sql") return `{ "type": "notFound" }` without being matched, even where a dynamic
|
|
10973
|
+
* project map node or redirect would match them.
|
|
10974
|
+
*/
|
|
10975
|
+
path: string;
|
|
10976
|
+
/** Specify a project map ID to fetch route from. If not specified, the default project map for the projectId is used */
|
|
10977
|
+
projectMapId: string;
|
|
10978
|
+
/** Publishing state to fetch. 0 = draft, 64 = published */
|
|
10979
|
+
state: number;
|
|
10980
|
+
/**
|
|
10981
|
+
* If true the `_id` unique identifier of each non-root component will be part of the response data.
|
|
10982
|
+
* If false, the `_id` will not be present in the API response
|
|
10983
|
+
*/
|
|
10984
|
+
withComponentIDs: boolean;
|
|
10985
|
+
/**
|
|
10986
|
+
* @deprecated
|
|
10987
|
+
* Has no effect.
|
|
10988
|
+
*/
|
|
10989
|
+
withContentSourceMap: boolean;
|
|
10990
|
+
/**
|
|
10991
|
+
* One or more locales to localize the response to.
|
|
10992
|
+
* When the result is a composition, it includes only the first matching locale's data.
|
|
10993
|
+
* If no matching locale is found, the response will be a not-found result.
|
|
10994
|
+
*
|
|
10995
|
+
* This parameter accepts a single value, a comma-delimited list of values, or the Accept-Language header syntax. Examples:
|
|
10996
|
+
* en-US
|
|
10997
|
+
* fr-CA,fr
|
|
10998
|
+
* de-AT;q=0.9,de-DE;q=0.8,en;q=0.7
|
|
10999
|
+
*
|
|
11000
|
+
* When this parameter is not passed:
|
|
11001
|
+
* - 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.
|
|
11002
|
+
* - Otherwise, all locales' data is returned.
|
|
11003
|
+
*
|
|
11004
|
+
* When the result is a redirect, this parameter has no effect
|
|
11005
|
+
*/
|
|
11006
|
+
locale: string;
|
|
11007
|
+
/**
|
|
11008
|
+
* The ID of a release to fetch the content for.
|
|
11009
|
+
*
|
|
11010
|
+
* - When unspecified, all release content is excluded from the result(s).
|
|
11011
|
+
* - 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.
|
|
11012
|
+
*
|
|
11013
|
+
* 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
|
|
11014
|
+
*/
|
|
11015
|
+
releaseId: string;
|
|
11016
|
+
/**
|
|
11017
|
+
* Indicates the data variant that was fetched for data resources.
|
|
11018
|
+
* undefined: Data resources were resolved using published data from their data source
|
|
11019
|
+
* 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.
|
|
11020
|
+
*/
|
|
11021
|
+
dataSourceVariant: "unpublished";
|
|
11022
|
+
/**
|
|
11023
|
+
* When true, redirects are not evaluated for the route matching; the result will be either a composition or not found.
|
|
11024
|
+
* Note: this is always true when state=63 (internal RSC editor state) to allow contextual editing of compositions
|
|
11025
|
+
* that have redirects configured on their paths.
|
|
11026
|
+
*/
|
|
11027
|
+
ignoreRedirects: boolean;
|
|
11028
|
+
};
|
|
11029
|
+
requestBodies: never;
|
|
11030
|
+
headers: never;
|
|
11031
|
+
pathItems: never;
|
|
11032
|
+
}
|
|
11033
|
+
|
|
11034
|
+
interface paths$a {
|
|
11035
|
+
"/api/v1/views": {
|
|
11036
|
+
parameters: {
|
|
11037
|
+
query?: never;
|
|
11038
|
+
header?: never;
|
|
11039
|
+
path?: never;
|
|
11040
|
+
cookie?: never;
|
|
11041
|
+
};
|
|
11042
|
+
/** Lists saved views for a project + resource type. */
|
|
11043
|
+
get: {
|
|
11044
|
+
parameters: {
|
|
11045
|
+
query: {
|
|
11046
|
+
/** Project the views belong to. */
|
|
11047
|
+
projectId: string;
|
|
11048
|
+
/** Resource type these views apply to (e.g. "entry"). */
|
|
11049
|
+
resourceType: "composition" | "compositionPattern" | "component" | "componentPattern" | "entry" | "entryPattern" | "contentType" | "blockType" | "release" | "signal" | "intent" | "audience" | "asset";
|
|
11050
|
+
/** Number of records to skip. */
|
|
11051
|
+
offset?: number | null;
|
|
11052
|
+
/** Maximum number of records to return. */
|
|
11053
|
+
limit?: number;
|
|
11054
|
+
};
|
|
11055
|
+
header?: never;
|
|
11056
|
+
path?: never;
|
|
11057
|
+
cookie?: never;
|
|
11058
|
+
};
|
|
11059
|
+
requestBody?: never;
|
|
11060
|
+
responses: {
|
|
11061
|
+
/** OK */
|
|
11062
|
+
200: {
|
|
11063
|
+
headers: {
|
|
11064
|
+
[name: string]: unknown;
|
|
11065
|
+
};
|
|
11066
|
+
content: {
|
|
11067
|
+
"application/json": {
|
|
11068
|
+
views: {
|
|
11069
|
+
name: string;
|
|
11070
|
+
description?: string;
|
|
11071
|
+
searchTerm?: string;
|
|
11072
|
+
filters: {
|
|
11073
|
+
field: string;
|
|
11074
|
+
dynamicField?: string;
|
|
11075
|
+
operator: string;
|
|
11076
|
+
value: string | string[];
|
|
11077
|
+
}[];
|
|
11078
|
+
sort?: string[];
|
|
11079
|
+
shared: boolean;
|
|
11080
|
+
icon?: string;
|
|
11081
|
+
id: string;
|
|
11082
|
+
projectId: string;
|
|
11083
|
+
/** @enum {string} */
|
|
11084
|
+
resourceType: "composition" | "compositionPattern" | "component" | "componentPattern" | "entry" | "entryPattern" | "contentType" | "blockType" | "release" | "signal" | "intent" | "audience" | "asset";
|
|
11085
|
+
createdBy: string | null;
|
|
11086
|
+
/** Format: date-time */
|
|
11087
|
+
created: string;
|
|
11088
|
+
/** Format: date-time */
|
|
11089
|
+
modified: string;
|
|
11090
|
+
}[];
|
|
11091
|
+
totalCount: number;
|
|
11092
|
+
};
|
|
11093
|
+
};
|
|
11094
|
+
};
|
|
11095
|
+
400: components$a["responses"]["BadRequestError"];
|
|
11096
|
+
401: components$a["responses"]["UnauthorizedError"];
|
|
11097
|
+
403: components$a["responses"]["ForbiddenError"];
|
|
11098
|
+
429: components$a["responses"]["RateLimitError"];
|
|
11099
|
+
500: components$a["responses"]["InternalServerError"];
|
|
11100
|
+
};
|
|
11101
|
+
};
|
|
11102
|
+
/** 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. */
|
|
11103
|
+
put: {
|
|
11104
|
+
parameters: {
|
|
11105
|
+
query?: never;
|
|
11106
|
+
header?: never;
|
|
11107
|
+
path?: never;
|
|
11108
|
+
cookie?: never;
|
|
11109
|
+
};
|
|
11110
|
+
requestBody: {
|
|
11111
|
+
content: {
|
|
11112
|
+
"application/json": {
|
|
11113
|
+
name: string;
|
|
11114
|
+
description?: string;
|
|
11115
|
+
searchTerm?: string;
|
|
11116
|
+
filters: {
|
|
11117
|
+
field: string;
|
|
11118
|
+
dynamicField?: string;
|
|
11119
|
+
operator: string;
|
|
11120
|
+
value: string | string[];
|
|
11121
|
+
}[];
|
|
11122
|
+
sort?: string[];
|
|
11123
|
+
shared: boolean;
|
|
11124
|
+
icon?: string;
|
|
11125
|
+
id: string;
|
|
11126
|
+
projectId: string;
|
|
11127
|
+
/** @enum {string} */
|
|
11128
|
+
resourceType: "composition" | "compositionPattern" | "component" | "componentPattern" | "entry" | "entryPattern" | "contentType" | "blockType" | "release" | "signal" | "intent" | "audience" | "asset";
|
|
11129
|
+
};
|
|
11130
|
+
};
|
|
11131
|
+
};
|
|
11132
|
+
responses: {
|
|
11133
|
+
/** OK */
|
|
11134
|
+
200: {
|
|
11135
|
+
headers: {
|
|
11136
|
+
[name: string]: unknown;
|
|
11137
|
+
};
|
|
11138
|
+
content: {
|
|
11139
|
+
"application/json": {
|
|
11140
|
+
name: string;
|
|
11141
|
+
description?: string;
|
|
11142
|
+
searchTerm?: string;
|
|
11143
|
+
filters: {
|
|
11144
|
+
field: string;
|
|
11145
|
+
dynamicField?: string;
|
|
11146
|
+
operator: string;
|
|
11147
|
+
value: string | string[];
|
|
11148
|
+
}[];
|
|
11149
|
+
sort?: string[];
|
|
11150
|
+
shared: boolean;
|
|
11151
|
+
icon?: string;
|
|
11152
|
+
id: string;
|
|
11153
|
+
projectId: string;
|
|
11154
|
+
/** @enum {string} */
|
|
11155
|
+
resourceType: "composition" | "compositionPattern" | "component" | "componentPattern" | "entry" | "entryPattern" | "contentType" | "blockType" | "release" | "signal" | "intent" | "audience" | "asset";
|
|
11156
|
+
createdBy: string | null;
|
|
11157
|
+
/** Format: date-time */
|
|
11158
|
+
created: string;
|
|
11159
|
+
/** Format: date-time */
|
|
11160
|
+
modified: string;
|
|
11161
|
+
};
|
|
11162
|
+
};
|
|
11163
|
+
};
|
|
11164
|
+
400: components$a["responses"]["BadRequestError"];
|
|
11165
|
+
401: components$a["responses"]["UnauthorizedError"];
|
|
11166
|
+
403: components$a["responses"]["ForbiddenError"];
|
|
11167
|
+
/** View not found (or belongs to another project). */
|
|
11168
|
+
404: {
|
|
11169
|
+
headers: {
|
|
11170
|
+
[name: string]: unknown;
|
|
11171
|
+
};
|
|
11172
|
+
content?: never;
|
|
11173
|
+
};
|
|
11174
|
+
/** Quota exceeded: at most 100 saved views allowed for this project + resource type + user. Remove an existing view before creating a new one. */
|
|
11175
|
+
409: {
|
|
11176
|
+
headers: {
|
|
11177
|
+
[name: string]: unknown;
|
|
11178
|
+
};
|
|
11179
|
+
content?: never;
|
|
11180
|
+
};
|
|
11181
|
+
429: components$a["responses"]["RateLimitError"];
|
|
11182
|
+
500: components$a["responses"]["InternalServerError"];
|
|
11183
|
+
};
|
|
11184
|
+
};
|
|
11185
|
+
post?: never;
|
|
11186
|
+
/** Deletes a saved view by id. */
|
|
11187
|
+
delete: {
|
|
11188
|
+
parameters: {
|
|
11189
|
+
query?: never;
|
|
11190
|
+
header?: never;
|
|
11191
|
+
path?: never;
|
|
11192
|
+
cookie?: never;
|
|
11193
|
+
};
|
|
11194
|
+
requestBody: {
|
|
11195
|
+
content: {
|
|
11196
|
+
"application/json": {
|
|
11197
|
+
id: string;
|
|
11198
|
+
projectId: string;
|
|
11199
|
+
};
|
|
11200
|
+
};
|
|
11201
|
+
};
|
|
11202
|
+
responses: {
|
|
11203
|
+
/** No Content */
|
|
11204
|
+
204: {
|
|
11205
|
+
headers: {
|
|
11206
|
+
[name: string]: unknown;
|
|
11207
|
+
};
|
|
11208
|
+
content: {
|
|
11209
|
+
"application/json": string;
|
|
11210
|
+
};
|
|
11211
|
+
};
|
|
11212
|
+
400: components$a["responses"]["BadRequestError"];
|
|
11213
|
+
401: components$a["responses"]["UnauthorizedError"];
|
|
11214
|
+
403: components$a["responses"]["ForbiddenError"];
|
|
11215
|
+
/** View not found. */
|
|
11216
|
+
404: {
|
|
11217
|
+
headers: {
|
|
11218
|
+
[name: string]: unknown;
|
|
11219
|
+
};
|
|
11220
|
+
content?: never;
|
|
11221
|
+
};
|
|
11222
|
+
429: components$a["responses"]["RateLimitError"];
|
|
11223
|
+
500: components$a["responses"]["InternalServerError"];
|
|
11224
|
+
};
|
|
11170
11225
|
};
|
|
11171
|
-
/**
|
|
11172
|
-
|
|
11173
|
-
|
|
11174
|
-
|
|
11175
|
-
|
|
11176
|
-
|
|
11177
|
-
|
|
11178
|
-
|
|
11226
|
+
/** Handles preflight requests. This endpoint allows CORS. */
|
|
11227
|
+
options: {
|
|
11228
|
+
parameters: {
|
|
11229
|
+
query?: never;
|
|
11230
|
+
header?: never;
|
|
11231
|
+
path?: never;
|
|
11232
|
+
cookie?: never;
|
|
11233
|
+
};
|
|
11234
|
+
requestBody?: never;
|
|
11235
|
+
responses: {
|
|
11236
|
+
/** ok */
|
|
11237
|
+
204: {
|
|
11238
|
+
headers: {
|
|
11239
|
+
[name: string]: unknown;
|
|
11240
|
+
};
|
|
11241
|
+
content?: never;
|
|
11242
|
+
};
|
|
11243
|
+
};
|
|
11179
11244
|
};
|
|
11180
|
-
|
|
11245
|
+
head?: never;
|
|
11246
|
+
patch?: never;
|
|
11247
|
+
trace?: never;
|
|
11248
|
+
};
|
|
11249
|
+
}
|
|
11250
|
+
interface components$a {
|
|
11251
|
+
schemas: {
|
|
11181
11252
|
Error: {
|
|
11182
11253
|
/** Error message(s) that occurred while processing the request */
|
|
11183
11254
|
errorMessage?: string[] | string;
|
|
@@ -11226,102 +11297,28 @@ interface components$a {
|
|
|
11226
11297
|
content?: never;
|
|
11227
11298
|
};
|
|
11228
11299
|
};
|
|
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
|
-
};
|
|
11300
|
+
parameters: never;
|
|
11316
11301
|
requestBodies: never;
|
|
11317
11302
|
headers: never;
|
|
11318
11303
|
pathItems: never;
|
|
11319
11304
|
}
|
|
11320
11305
|
|
|
11321
|
-
type
|
|
11306
|
+
type ViewsApi = paths$a['/api/v1/views'];
|
|
11307
|
+
type ViewsQuery = ViewsApi['get']['parameters']['query'];
|
|
11308
|
+
type ViewPut = ViewsApi['put']['requestBody']['content']['application/json'];
|
|
11309
|
+
type ViewDelete = ViewsApi['delete']['requestBody']['content']['application/json'];
|
|
11310
|
+
type ViewsResponse = ViewsApi['get']['responses']['200']['content']['application/json'];
|
|
11311
|
+
type View = ViewsResponse['views'][number];
|
|
11312
|
+
/**
|
|
11313
|
+
* File/sync shape for a shared custom view. Audit fields and `projectId` are
|
|
11314
|
+
* stripped on pull; `id` is kept so PUT is create-or-replace across projects.
|
|
11315
|
+
*/
|
|
11316
|
+
type SerializedCustomView = Omit<View, 'projectId' | 'createdBy' | 'created' | 'modified'>;
|
|
11317
|
+
|
|
11318
|
+
type Components = components$e['schemas'];
|
|
11322
11319
|
type SharedComponents$1 = components$r['schemas'];
|
|
11323
|
-
type Api = paths$
|
|
11324
|
-
type HistoryApi = paths$
|
|
11320
|
+
type Api = paths$d['/api/v1/canvas'];
|
|
11321
|
+
type HistoryApi = paths$c['/api/v1/canvas-history'];
|
|
11325
11322
|
/** Query parameter options for GET /api/v1/canvas */
|
|
11326
11323
|
type CompositionGetParameters = Omit<Api['get']['parameters']['query'], 'type'> & {
|
|
11327
11324
|
type?: string | string[];
|
|
@@ -11440,6 +11437,37 @@ type CopiedComponentSubtree = {
|
|
|
11440
11437
|
* Defines how a component on a pattern may have its values overridden
|
|
11441
11438
|
*/
|
|
11442
11439
|
type ComponentOverridability = SharedComponents$1['ComponentOverridability'];
|
|
11440
|
+
interface EndpointOut {
|
|
11441
|
+
channels?: string[] | null;
|
|
11442
|
+
createdAt: Date;
|
|
11443
|
+
description: string;
|
|
11444
|
+
disabled?: boolean;
|
|
11445
|
+
filterTypes?: string[] | null;
|
|
11446
|
+
id: string;
|
|
11447
|
+
metadata: {
|
|
11448
|
+
[key: string]: string;
|
|
11449
|
+
};
|
|
11450
|
+
rateLimit?: number | null;
|
|
11451
|
+
throttleRate?: number | null;
|
|
11452
|
+
uid?: string | null;
|
|
11453
|
+
updatedAt: Date;
|
|
11454
|
+
url: string;
|
|
11455
|
+
version: number;
|
|
11456
|
+
}
|
|
11457
|
+
interface EndpointHeadersOut {
|
|
11458
|
+
headers: {
|
|
11459
|
+
[key: string]: string;
|
|
11460
|
+
};
|
|
11461
|
+
sensitive: string[];
|
|
11462
|
+
}
|
|
11463
|
+
interface EndpointTransformationOut {
|
|
11464
|
+
code?: string | null;
|
|
11465
|
+
enabled?: boolean;
|
|
11466
|
+
updatedAt?: Date | null;
|
|
11467
|
+
variables?: {
|
|
11468
|
+
[key: string]: string;
|
|
11469
|
+
} | null;
|
|
11470
|
+
}
|
|
11443
11471
|
/**
|
|
11444
11472
|
* Defines the shape of serialized webhook
|
|
11445
11473
|
*/
|
|
@@ -11510,7 +11538,7 @@ type DataResolutionParameters = {
|
|
|
11510
11538
|
};
|
|
11511
11539
|
/** Types of issue that can occur when fetching composition data */
|
|
11512
11540
|
type DataResolutionIssue = PatternIssue | DataResourceIssue | MaxDepthExceededIssue | DataElementBindingIssue | DynamicInputIssue | DataResolutionConfigIssue;
|
|
11513
|
-
type DataResolutionIssueCore = components$
|
|
11541
|
+
type DataResolutionIssueCore = components$c['schemas']['DataResolutionIssue'];
|
|
11514
11542
|
/** An error that occured resolving a pattern that is referenced on the composition */
|
|
11515
11543
|
type PatternIssue = DataResolutionIssueCore & {
|
|
11516
11544
|
type: 'pattern';
|
|
@@ -11564,26 +11592,26 @@ type DataResolutionConfigIssue = {
|
|
|
11564
11592
|
type: 'config';
|
|
11565
11593
|
};
|
|
11566
11594
|
/** Diagnostics about edge request processing */
|
|
11567
|
-
type EdgehancersDiagnostics = components$
|
|
11568
|
-
type EdgehancersWholeResponseCacheDiagnostics = components$
|
|
11595
|
+
type EdgehancersDiagnostics = components$c['schemas']['EdgehancersDiagnostics'];
|
|
11596
|
+
type EdgehancersWholeResponseCacheDiagnostics = components$c['schemas']['EdgehancersResolutionInfo']['wholeResponseCacheDiagnostics'];
|
|
11569
11597
|
/** Diagnostic data about the load performance of attached composition datas */
|
|
11570
|
-
type DataDiagnostic = components$
|
|
11598
|
+
type DataDiagnostic = components$c['schemas']['DataDiagnostic'];
|
|
11571
11599
|
/** Response as it comes from uniform.global/api/v1/composition */
|
|
11572
|
-
type CompositionResolvedGetResponse = components$
|
|
11573
|
-
type CompositionResolvedListResponse = components$
|
|
11600
|
+
type CompositionResolvedGetResponse = components$c['schemas']['CompositionResolvedGetResponse'];
|
|
11601
|
+
type CompositionResolvedListResponse = components$c['schemas']['CompositionResolvedListResponse'];
|
|
11574
11602
|
/** All valid response types */
|
|
11575
11603
|
type CompositionGetValidResponses = CompositionGetResponse | CompositionResolvedGetResponse;
|
|
11576
11604
|
/** 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$
|
|
11605
|
+
type RouteGetParameters = paths$b['/api/v1/route']['get']['parameters']['query'] & DataResolutionParameters;
|
|
11606
|
+
type RouteGetResponse = components$f['schemas']['RouteResponse'];
|
|
11607
|
+
type RouteGetResponseComposition = components$f['schemas']['RouteResponseComposition'];
|
|
11608
|
+
type RouteGetResponseRedirect = components$f['schemas']['RouteResponseRedirect'];
|
|
11609
|
+
type RouteGetResponseNotFound = components$f['schemas']['RouteResponseNotFound'];
|
|
11610
|
+
type RouteDynamicInputs = components$f['schemas']['RouteDynamicInputs'];
|
|
11583
11611
|
/** The GET response from /api/v1/entries */
|
|
11584
11612
|
type EntriesGetParameters = paths$l['/api/v1/entries']['get']['parameters']['query'] & DataResolutionParameters;
|
|
11585
11613
|
type EntriesGetResponse = components$p['schemas']['EntryListResponse'];
|
|
11586
|
-
type EntriesResolvedListResponse = components$
|
|
11614
|
+
type EntriesResolvedListResponse = components$c['schemas']['EntryResolvedListResponse'];
|
|
11587
11615
|
/** GET response from uniform.global/api/v1/route when result is a composition */
|
|
11588
11616
|
type RouteGetResponseEdgehancedComposition = Omit<RouteGetResponseComposition, 'compositionApiResponse'> & {
|
|
11589
11617
|
compositionApiResponse: CompositionResolvedGetResponse;
|
|
@@ -12198,7 +12226,7 @@ type IntegrationPropertyEditorsGetResponse = paths$9['/api/v1/integration-proper
|
|
|
12198
12226
|
type IntegrationPropertyEditorsPutParameters = paths$9['/api/v1/integration-property-editors']['put']['requestBody']['content']['application/json'];
|
|
12199
12227
|
type IntegrationPropertyEditorsDeleteParameters = paths$9['/api/v1/integration-property-editors']['delete']['requestBody']['content']['application/json'];
|
|
12200
12228
|
|
|
12201
|
-
type schemas = components$
|
|
12229
|
+
type schemas = components$c['schemas'];
|
|
12202
12230
|
type InvalidationPayload = schemas['InvalidationPayload'];
|
|
12203
12231
|
type BatchInvalidationPayload = schemas['BatchInvalidationPayload'];
|
|
12204
12232
|
|
|
@@ -16219,169 +16247,7 @@ declare function hasReferencedVariables(value: string | undefined): number;
|
|
|
16219
16247
|
*/
|
|
16220
16248
|
declare function parseVariableExpression(serialized: string, onToken?: (token: string, type: 'text' | 'variable', offset: number) => void | false): number;
|
|
16221
16249
|
|
|
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";
|
|
16250
|
+
declare const version = "20.87.0";
|
|
16385
16251
|
|
|
16386
16252
|
/** API client to enable managing workflow definitions */
|
|
16387
16253
|
declare class WorkflowClient extends ApiClient {
|
|
@@ -16404,4 +16270,4 @@ declare class WorkflowClient extends ApiClient {
|
|
|
16404
16270
|
|
|
16405
16271
|
declare const CanvasClientError: typeof ApiClientError;
|
|
16406
16272
|
|
|
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 };
|
|
16273
|
+
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 };
|