@uniformdev/canvas 20.49.4-alpha.102 → 20.49.4-alpha.124
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 +790 -749
- package/dist/index.d.ts +790 -749
- package/dist/index.esm.js +57 -18
- package/dist/index.js +62 -21
- package/dist/index.mjs +57 -18
- package/package.json +5 -5
package/dist/index.d.ts
CHANGED
|
@@ -5117,17 +5117,28 @@ type DataSourceVariantsKeys = keyof NonNullable<DataSource['variants']>;
|
|
|
5117
5117
|
type DataSourceVariantData = NonNullable<DataSource['variants']>['unpublished'];
|
|
5118
5118
|
|
|
5119
5119
|
interface paths$d {
|
|
5120
|
-
"/api/v1/
|
|
5120
|
+
"/api/v1/labels": {
|
|
5121
5121
|
parameters: {
|
|
5122
5122
|
query?: never;
|
|
5123
5123
|
header?: never;
|
|
5124
5124
|
path?: never;
|
|
5125
5125
|
cookie?: never;
|
|
5126
5126
|
};
|
|
5127
|
+
/**
|
|
5128
|
+
* @deprecated
|
|
5129
|
+
* @description Gets labels for a project
|
|
5130
|
+
*/
|
|
5127
5131
|
get: {
|
|
5128
5132
|
parameters: {
|
|
5129
5133
|
query: {
|
|
5130
5134
|
projectId: string;
|
|
5135
|
+
offset?: number | null;
|
|
5136
|
+
limit?: number;
|
|
5137
|
+
labelIds?: string;
|
|
5138
|
+
groupId?: string;
|
|
5139
|
+
isGroup?: boolean | null;
|
|
5140
|
+
idPrefix?: string;
|
|
5141
|
+
namePrefix?: string;
|
|
5131
5142
|
};
|
|
5132
5143
|
header?: never;
|
|
5133
5144
|
path?: never;
|
|
@@ -5135,15 +5146,40 @@ interface paths$d {
|
|
|
5135
5146
|
};
|
|
5136
5147
|
requestBody?: never;
|
|
5137
5148
|
responses: {
|
|
5138
|
-
/** @description
|
|
5139
|
-
* */
|
|
5149
|
+
/** @description OK */
|
|
5140
5150
|
200: {
|
|
5141
5151
|
headers: {
|
|
5142
5152
|
[name: string]: unknown;
|
|
5143
5153
|
};
|
|
5144
5154
|
content: {
|
|
5145
5155
|
"application/json": {
|
|
5146
|
-
|
|
5156
|
+
labels: {
|
|
5157
|
+
/** Format: uuid */
|
|
5158
|
+
projectId: string;
|
|
5159
|
+
label: {
|
|
5160
|
+
/** @description Public ID of the label (cannot be changed after creation) */
|
|
5161
|
+
publicId: string;
|
|
5162
|
+
/** @description Human readable name of the label */
|
|
5163
|
+
displayName: string;
|
|
5164
|
+
/** @description Whether this label is a group label (cannot be changed after creation) */
|
|
5165
|
+
isGroup: boolean;
|
|
5166
|
+
/** @description Public ID of the parent group label */
|
|
5167
|
+
parent?: string;
|
|
5168
|
+
/** @description Human readable color identifier */
|
|
5169
|
+
color: string;
|
|
5170
|
+
/** @description Short description of what the label is about */
|
|
5171
|
+
description?: string;
|
|
5172
|
+
/** @description Scope of the label (currently unused) */
|
|
5173
|
+
scope: string[];
|
|
5174
|
+
};
|
|
5175
|
+
/** Format: date-time */
|
|
5176
|
+
created: string;
|
|
5177
|
+
/** Format: date-time */
|
|
5178
|
+
modified: string;
|
|
5179
|
+
createdBy?: string;
|
|
5180
|
+
modifiedBy?: string;
|
|
5181
|
+
}[];
|
|
5182
|
+
totalCount: number;
|
|
5147
5183
|
};
|
|
5148
5184
|
};
|
|
5149
5185
|
};
|
|
@@ -5154,6 +5190,10 @@ interface paths$d {
|
|
|
5154
5190
|
500: components$f["responses"]["InternalServerError"];
|
|
5155
5191
|
};
|
|
5156
5192
|
};
|
|
5193
|
+
/**
|
|
5194
|
+
* @deprecated
|
|
5195
|
+
* @description Creates or updates a label
|
|
5196
|
+
*/
|
|
5157
5197
|
put: {
|
|
5158
5198
|
parameters: {
|
|
5159
5199
|
query?: never;
|
|
@@ -5163,7 +5203,22 @@ interface paths$d {
|
|
|
5163
5203
|
};
|
|
5164
5204
|
requestBody: {
|
|
5165
5205
|
content: {
|
|
5166
|
-
"application/json":
|
|
5206
|
+
"application/json": {
|
|
5207
|
+
/** Format: uuid */
|
|
5208
|
+
projectId: string;
|
|
5209
|
+
label: {
|
|
5210
|
+
/** @description Public ID of the label */
|
|
5211
|
+
publicId: string;
|
|
5212
|
+
displayName: string;
|
|
5213
|
+
/** @default false */
|
|
5214
|
+
isGroup?: boolean;
|
|
5215
|
+
parent?: string;
|
|
5216
|
+
color: string;
|
|
5217
|
+
description?: string;
|
|
5218
|
+
/** @description Ignored on PUT */
|
|
5219
|
+
scope?: string[];
|
|
5220
|
+
};
|
|
5221
|
+
};
|
|
5167
5222
|
};
|
|
5168
5223
|
};
|
|
5169
5224
|
responses: {
|
|
@@ -5172,7 +5227,9 @@ interface paths$d {
|
|
|
5172
5227
|
headers: {
|
|
5173
5228
|
[name: string]: unknown;
|
|
5174
5229
|
};
|
|
5175
|
-
content
|
|
5230
|
+
content: {
|
|
5231
|
+
"application/json": string;
|
|
5232
|
+
};
|
|
5176
5233
|
};
|
|
5177
5234
|
400: components$f["responses"]["BadRequestError"];
|
|
5178
5235
|
401: components$f["responses"]["UnauthorizedError"];
|
|
@@ -5182,6 +5239,10 @@ interface paths$d {
|
|
|
5182
5239
|
};
|
|
5183
5240
|
};
|
|
5184
5241
|
post?: never;
|
|
5242
|
+
/**
|
|
5243
|
+
* @deprecated
|
|
5244
|
+
* @description Deletes a label
|
|
5245
|
+
*/
|
|
5185
5246
|
delete: {
|
|
5186
5247
|
parameters: {
|
|
5187
5248
|
query?: never;
|
|
@@ -5191,7 +5252,15 @@ interface paths$d {
|
|
|
5191
5252
|
};
|
|
5192
5253
|
requestBody: {
|
|
5193
5254
|
content: {
|
|
5194
|
-
"application/json":
|
|
5255
|
+
"application/json": {
|
|
5256
|
+
/**
|
|
5257
|
+
* Format: uuid
|
|
5258
|
+
* @description The project ID
|
|
5259
|
+
*/
|
|
5260
|
+
projectId: string;
|
|
5261
|
+
/** @description Public ID of the label to delete */
|
|
5262
|
+
labelId: string;
|
|
5263
|
+
};
|
|
5195
5264
|
};
|
|
5196
5265
|
};
|
|
5197
5266
|
responses: {
|
|
@@ -5200,7 +5269,9 @@ interface paths$d {
|
|
|
5200
5269
|
headers: {
|
|
5201
5270
|
[name: string]: unknown;
|
|
5202
5271
|
};
|
|
5203
|
-
content
|
|
5272
|
+
content: {
|
|
5273
|
+
"application/json": string;
|
|
5274
|
+
};
|
|
5204
5275
|
};
|
|
5205
5276
|
400: components$f["responses"]["BadRequestError"];
|
|
5206
5277
|
401: components$f["responses"]["UnauthorizedError"];
|
|
@@ -5209,13 +5280,193 @@ interface paths$d {
|
|
|
5209
5280
|
500: components$f["responses"]["InternalServerError"];
|
|
5210
5281
|
};
|
|
5211
5282
|
};
|
|
5212
|
-
|
|
5283
|
+
/** @description Handles preflight requests. This endpoint allows CORS. */
|
|
5284
|
+
options: {
|
|
5285
|
+
parameters: {
|
|
5286
|
+
query?: never;
|
|
5287
|
+
header?: never;
|
|
5288
|
+
path?: never;
|
|
5289
|
+
cookie?: never;
|
|
5290
|
+
};
|
|
5291
|
+
requestBody?: never;
|
|
5292
|
+
responses: {
|
|
5293
|
+
/** @description ok */
|
|
5294
|
+
204: {
|
|
5295
|
+
headers: {
|
|
5296
|
+
[name: string]: unknown;
|
|
5297
|
+
};
|
|
5298
|
+
content?: never;
|
|
5299
|
+
};
|
|
5300
|
+
};
|
|
5301
|
+
};
|
|
5213
5302
|
head?: never;
|
|
5214
5303
|
patch?: never;
|
|
5215
5304
|
trace?: never;
|
|
5216
5305
|
};
|
|
5217
5306
|
}
|
|
5218
5307
|
interface components$f {
|
|
5308
|
+
schemas: {
|
|
5309
|
+
Error: {
|
|
5310
|
+
/** @description Error message(s) that occurred while processing the request */
|
|
5311
|
+
errorMessage?: string[] | string;
|
|
5312
|
+
};
|
|
5313
|
+
};
|
|
5314
|
+
responses: {
|
|
5315
|
+
/** @description Request input validation failed */
|
|
5316
|
+
BadRequestError: {
|
|
5317
|
+
headers: {
|
|
5318
|
+
[name: string]: unknown;
|
|
5319
|
+
};
|
|
5320
|
+
content: {
|
|
5321
|
+
"application/json": components$f["schemas"]["Error"];
|
|
5322
|
+
};
|
|
5323
|
+
};
|
|
5324
|
+
/** @description API key or token was not valid */
|
|
5325
|
+
UnauthorizedError: {
|
|
5326
|
+
headers: {
|
|
5327
|
+
[name: string]: unknown;
|
|
5328
|
+
};
|
|
5329
|
+
content: {
|
|
5330
|
+
"application/json": components$f["schemas"]["Error"];
|
|
5331
|
+
};
|
|
5332
|
+
};
|
|
5333
|
+
/** @description Permission was denied */
|
|
5334
|
+
ForbiddenError: {
|
|
5335
|
+
headers: {
|
|
5336
|
+
[name: string]: unknown;
|
|
5337
|
+
};
|
|
5338
|
+
content: {
|
|
5339
|
+
"application/json": components$f["schemas"]["Error"];
|
|
5340
|
+
};
|
|
5341
|
+
};
|
|
5342
|
+
/** @description Too many requests in allowed time period */
|
|
5343
|
+
RateLimitError: {
|
|
5344
|
+
headers: {
|
|
5345
|
+
[name: string]: unknown;
|
|
5346
|
+
};
|
|
5347
|
+
content?: never;
|
|
5348
|
+
};
|
|
5349
|
+
/** @description Execution error occurred */
|
|
5350
|
+
InternalServerError: {
|
|
5351
|
+
headers: {
|
|
5352
|
+
[name: string]: unknown;
|
|
5353
|
+
};
|
|
5354
|
+
content?: never;
|
|
5355
|
+
};
|
|
5356
|
+
};
|
|
5357
|
+
parameters: never;
|
|
5358
|
+
requestBodies: never;
|
|
5359
|
+
headers: never;
|
|
5360
|
+
pathItems: never;
|
|
5361
|
+
}
|
|
5362
|
+
|
|
5363
|
+
type LabelsApi = paths$d['/api/v1/labels'];
|
|
5364
|
+
type LabelsQuery = LabelsApi['get']['parameters']['query'];
|
|
5365
|
+
type LabelPut = LabelsApi['put']['requestBody']['content']['application/json'];
|
|
5366
|
+
type LabelDelete = LabelsApi['delete']['requestBody']['content']['application/json'];
|
|
5367
|
+
type LabelsResponse = LabelsApi['get']['responses']['200']['content']['application/json'];
|
|
5368
|
+
type Label = LabelsResponse['labels'][number];
|
|
5369
|
+
|
|
5370
|
+
interface paths$c {
|
|
5371
|
+
"/api/v1/locales": {
|
|
5372
|
+
parameters: {
|
|
5373
|
+
query?: never;
|
|
5374
|
+
header?: never;
|
|
5375
|
+
path?: never;
|
|
5376
|
+
cookie?: never;
|
|
5377
|
+
};
|
|
5378
|
+
get: {
|
|
5379
|
+
parameters: {
|
|
5380
|
+
query: {
|
|
5381
|
+
projectId: string;
|
|
5382
|
+
};
|
|
5383
|
+
header?: never;
|
|
5384
|
+
path?: never;
|
|
5385
|
+
cookie?: never;
|
|
5386
|
+
};
|
|
5387
|
+
requestBody?: never;
|
|
5388
|
+
responses: {
|
|
5389
|
+
/** @description Gets a list of all defined locales for a project
|
|
5390
|
+
* */
|
|
5391
|
+
200: {
|
|
5392
|
+
headers: {
|
|
5393
|
+
[name: string]: unknown;
|
|
5394
|
+
};
|
|
5395
|
+
content: {
|
|
5396
|
+
"application/json": {
|
|
5397
|
+
results: components$e["schemas"]["Locale"][];
|
|
5398
|
+
};
|
|
5399
|
+
};
|
|
5400
|
+
};
|
|
5401
|
+
400: components$e["responses"]["BadRequestError"];
|
|
5402
|
+
401: components$e["responses"]["UnauthorizedError"];
|
|
5403
|
+
403: components$e["responses"]["ForbiddenError"];
|
|
5404
|
+
429: components$e["responses"]["RateLimitError"];
|
|
5405
|
+
500: components$e["responses"]["InternalServerError"];
|
|
5406
|
+
};
|
|
5407
|
+
};
|
|
5408
|
+
put: {
|
|
5409
|
+
parameters: {
|
|
5410
|
+
query?: never;
|
|
5411
|
+
header?: never;
|
|
5412
|
+
path?: never;
|
|
5413
|
+
cookie?: never;
|
|
5414
|
+
};
|
|
5415
|
+
requestBody: {
|
|
5416
|
+
content: {
|
|
5417
|
+
"application/json": components$e["schemas"]["LocalePutBody"];
|
|
5418
|
+
};
|
|
5419
|
+
};
|
|
5420
|
+
responses: {
|
|
5421
|
+
/** @description OK */
|
|
5422
|
+
204: {
|
|
5423
|
+
headers: {
|
|
5424
|
+
[name: string]: unknown;
|
|
5425
|
+
};
|
|
5426
|
+
content?: never;
|
|
5427
|
+
};
|
|
5428
|
+
400: components$e["responses"]["BadRequestError"];
|
|
5429
|
+
401: components$e["responses"]["UnauthorizedError"];
|
|
5430
|
+
403: components$e["responses"]["ForbiddenError"];
|
|
5431
|
+
429: components$e["responses"]["RateLimitError"];
|
|
5432
|
+
500: components$e["responses"]["InternalServerError"];
|
|
5433
|
+
};
|
|
5434
|
+
};
|
|
5435
|
+
post?: never;
|
|
5436
|
+
delete: {
|
|
5437
|
+
parameters: {
|
|
5438
|
+
query?: never;
|
|
5439
|
+
header?: never;
|
|
5440
|
+
path?: never;
|
|
5441
|
+
cookie?: never;
|
|
5442
|
+
};
|
|
5443
|
+
requestBody: {
|
|
5444
|
+
content: {
|
|
5445
|
+
"application/json": components$e["schemas"]["LocaleDeleteBody"];
|
|
5446
|
+
};
|
|
5447
|
+
};
|
|
5448
|
+
responses: {
|
|
5449
|
+
/** @description OK */
|
|
5450
|
+
204: {
|
|
5451
|
+
headers: {
|
|
5452
|
+
[name: string]: unknown;
|
|
5453
|
+
};
|
|
5454
|
+
content?: never;
|
|
5455
|
+
};
|
|
5456
|
+
400: components$e["responses"]["BadRequestError"];
|
|
5457
|
+
401: components$e["responses"]["UnauthorizedError"];
|
|
5458
|
+
403: components$e["responses"]["ForbiddenError"];
|
|
5459
|
+
429: components$e["responses"]["RateLimitError"];
|
|
5460
|
+
500: components$e["responses"]["InternalServerError"];
|
|
5461
|
+
};
|
|
5462
|
+
};
|
|
5463
|
+
options?: never;
|
|
5464
|
+
head?: never;
|
|
5465
|
+
patch?: never;
|
|
5466
|
+
trace?: never;
|
|
5467
|
+
};
|
|
5468
|
+
}
|
|
5469
|
+
interface components$e {
|
|
5219
5470
|
schemas: {
|
|
5220
5471
|
Locale: {
|
|
5221
5472
|
/**
|
|
@@ -5257,7 +5508,7 @@ interface components$f {
|
|
|
5257
5508
|
order?: number;
|
|
5258
5509
|
};
|
|
5259
5510
|
LocalePutBody: {
|
|
5260
|
-
locale: components$
|
|
5511
|
+
locale: components$e["schemas"]["Locale"];
|
|
5261
5512
|
/**
|
|
5262
5513
|
* Format: uuid
|
|
5263
5514
|
* @description The project ID
|
|
@@ -5284,7 +5535,7 @@ interface components$f {
|
|
|
5284
5535
|
[name: string]: unknown;
|
|
5285
5536
|
};
|
|
5286
5537
|
content: {
|
|
5287
|
-
"application/json": components$
|
|
5538
|
+
"application/json": components$e["schemas"]["Error"];
|
|
5288
5539
|
};
|
|
5289
5540
|
};
|
|
5290
5541
|
/** @description API key or token was not valid */
|
|
@@ -5293,7 +5544,7 @@ interface components$f {
|
|
|
5293
5544
|
[name: string]: unknown;
|
|
5294
5545
|
};
|
|
5295
5546
|
content: {
|
|
5296
|
-
"application/json": components$
|
|
5547
|
+
"application/json": components$e["schemas"]["Error"];
|
|
5297
5548
|
};
|
|
5298
5549
|
};
|
|
5299
5550
|
/** @description Permission was denied */
|
|
@@ -5302,7 +5553,7 @@ interface components$f {
|
|
|
5302
5553
|
[name: string]: unknown;
|
|
5303
5554
|
};
|
|
5304
5555
|
content: {
|
|
5305
|
-
"application/json": components$
|
|
5556
|
+
"application/json": components$e["schemas"]["Error"];
|
|
5306
5557
|
};
|
|
5307
5558
|
};
|
|
5308
5559
|
/** @description Too many requests in allowed time period */
|
|
@@ -5326,9 +5577,9 @@ interface components$f {
|
|
|
5326
5577
|
pathItems: never;
|
|
5327
5578
|
}
|
|
5328
5579
|
|
|
5329
|
-
type LocalesApi = paths$
|
|
5580
|
+
type LocalesApi = paths$c['/api/v1/locales'];
|
|
5330
5581
|
/** A locale definition */
|
|
5331
|
-
type Locale = components$
|
|
5582
|
+
type Locale = components$e['schemas']['Locale'];
|
|
5332
5583
|
/** Query parameter options for GET /api/v1/locales */
|
|
5333
5584
|
type LocalesGetParameters = LocalesApi['get']['parameters']['query'];
|
|
5334
5585
|
/** The GET response from /api/v1/locales */
|
|
@@ -5339,18 +5590,18 @@ type LocalePutParameters = LocalesApi['put']['requestBody']['content']['applicat
|
|
|
5339
5590
|
type LocaleDeleteParameters = LocalesApi['delete']['requestBody']['content']['application/json'];
|
|
5340
5591
|
declare const LOCALE_DYNAMIC_INPUT_NAME = "locale";
|
|
5341
5592
|
|
|
5342
|
-
interface components$
|
|
5593
|
+
interface components$d {
|
|
5343
5594
|
schemas: {
|
|
5344
|
-
RouteResponse: components$
|
|
5595
|
+
RouteResponse: components$d["schemas"]["RouteResponseRedirect"] | components$d["schemas"]["RouteResponseComposition"] | components$d["schemas"]["RouteResponseNotFound"];
|
|
5345
5596
|
/** @description The route matches a redirection configured in Uniform
|
|
5346
5597
|
* */
|
|
5347
5598
|
RouteResponseRedirect: {
|
|
5348
5599
|
/** @description The route that was matched in the redirects */
|
|
5349
5600
|
matchedRoute: string;
|
|
5350
|
-
dynamicInputs?: components$
|
|
5601
|
+
dynamicInputs?: components$d["schemas"]["RouteDynamicInputs"];
|
|
5351
5602
|
/** @enum {string} */
|
|
5352
5603
|
type: "redirect";
|
|
5353
|
-
redirect: components$
|
|
5604
|
+
redirect: components$d["schemas"]["Redirect"];
|
|
5354
5605
|
};
|
|
5355
5606
|
/** @description The route matches a composition.
|
|
5356
5607
|
* If any dynamic segments or query parameters are present in the route, they will be returned as dynamic inputs in the response
|
|
@@ -5358,7 +5609,7 @@ interface components$e {
|
|
|
5358
5609
|
RouteResponseComposition: {
|
|
5359
5610
|
/** @description The route that was matched in the project map */
|
|
5360
5611
|
matchedRoute: string;
|
|
5361
|
-
dynamicInputs?: components$
|
|
5612
|
+
dynamicInputs?: components$d["schemas"]["RouteDynamicInputs"];
|
|
5362
5613
|
/**
|
|
5363
5614
|
* @description Indicates the data variant that was fetched for data resources.
|
|
5364
5615
|
* undefined: Data resources were resolved using published data from their data source
|
|
@@ -5369,7 +5620,7 @@ interface components$e {
|
|
|
5369
5620
|
dataResourcesVariant?: "unpublished";
|
|
5370
5621
|
/** @enum {string} */
|
|
5371
5622
|
type: "composition";
|
|
5372
|
-
compositionApiResponse: components$
|
|
5623
|
+
compositionApiResponse: components$d["schemas"]["CompositionApiResponse"];
|
|
5373
5624
|
};
|
|
5374
5625
|
/** @description The route does not match any configured redirections or compositions.
|
|
5375
5626
|
* NOTE: This response differs from a HTTP 404, which indicates that the project map or project ID was not found.
|
|
@@ -5487,12 +5738,12 @@ interface components$e {
|
|
|
5487
5738
|
* @enum {string}
|
|
5488
5739
|
*/
|
|
5489
5740
|
op?: "&" | "|";
|
|
5490
|
-
clauses: (components$
|
|
5741
|
+
clauses: (components$d["schemas"]["VisibilityCriteria"] | components$d["schemas"]["VisibilityCriteriaGroup"])[];
|
|
5491
5742
|
};
|
|
5492
5743
|
/** @description Defines a conditional value for a component parameter
|
|
5493
5744
|
* */
|
|
5494
5745
|
ComponentParameterConditionalValue: {
|
|
5495
|
-
when: components$
|
|
5746
|
+
when: components$d["schemas"]["VisibilityCriteriaGroup"];
|
|
5496
5747
|
/** @description The value of the parameter. Any JSON-serializable value is acceptable.
|
|
5497
5748
|
* A value of `null` will cause the parameter value to be removed, if it matches.
|
|
5498
5749
|
* */
|
|
@@ -5511,7 +5762,7 @@ interface components$e {
|
|
|
5511
5762
|
*
|
|
5512
5763
|
* When no locale is passed to a non-route API, conditions are not processed and all conditions are returned.
|
|
5513
5764
|
* */
|
|
5514
|
-
ComponentParameterConditions: components$
|
|
5765
|
+
ComponentParameterConditions: components$d["schemas"]["ComponentParameterConditionalValue"][];
|
|
5515
5766
|
/** @description Defines an editable parameter on a component */
|
|
5516
5767
|
ComponentParameter: {
|
|
5517
5768
|
/** @description The value of the parameter. Any JSON-serializable value is acceptable */
|
|
@@ -5519,18 +5770,18 @@ interface components$e {
|
|
|
5519
5770
|
/** @description The type of the parameter. Determines how it is displayed when editing and tells the consumer how to process it */
|
|
5520
5771
|
type: string;
|
|
5521
5772
|
/** @deprecated */
|
|
5522
|
-
connectedData?: components$
|
|
5773
|
+
connectedData?: components$d["schemas"]["DataElementConnectionDefinition"];
|
|
5523
5774
|
/** @description Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
|
|
5524
5775
|
* Note that locales must be registered on the entry/composition `_locales` before being used
|
|
5525
5776
|
* */
|
|
5526
5777
|
locales?: {
|
|
5527
5778
|
[key: string]: unknown;
|
|
5528
5779
|
};
|
|
5529
|
-
conditions?: components$
|
|
5780
|
+
conditions?: components$d["schemas"]["ComponentParameterConditions"];
|
|
5530
5781
|
/** @description Locale-specific conditional values for this parameter. Keys are locale codes, and values are the `conditions` for that locale.
|
|
5531
5782
|
* */
|
|
5532
5783
|
localesConditions?: {
|
|
5533
|
-
[key: string]: components$
|
|
5784
|
+
[key: string]: components$d["schemas"]["ComponentParameterConditions"];
|
|
5534
5785
|
};
|
|
5535
5786
|
};
|
|
5536
5787
|
ProjectMapNodeAllowedQueryString: {
|
|
@@ -5559,7 +5810,7 @@ interface components$e {
|
|
|
5559
5810
|
/** @description 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 */
|
|
5560
5811
|
isSearchHit?: boolean;
|
|
5561
5812
|
/** @description Query strings that are allowed to be passed to the node */
|
|
5562
|
-
queryStrings?: components$
|
|
5813
|
+
queryStrings?: components$d["schemas"]["ProjectMapNodeAllowedQueryString"][];
|
|
5563
5814
|
/** @description For dynamic nodes, this is the preview value for the dynamic value.
|
|
5564
5815
|
* The preview value is used when editing a connected composition, and is the default
|
|
5565
5816
|
* dynamic node value unless the author has explicitly chosen a different value
|
|
@@ -5582,7 +5833,7 @@ interface components$e {
|
|
|
5582
5833
|
* @description Unique identifier for the project map that this node belongs to
|
|
5583
5834
|
*/
|
|
5584
5835
|
projectMapId: string;
|
|
5585
|
-
data?: components$
|
|
5836
|
+
data?: components$d["schemas"]["ProjectMapNodeData"];
|
|
5586
5837
|
/** @description Locale-specific paths of the project map node.
|
|
5587
5838
|
* Keys are locale codes
|
|
5588
5839
|
* */
|
|
@@ -5602,13 +5853,13 @@ interface components$e {
|
|
|
5602
5853
|
type: string;
|
|
5603
5854
|
/** @description Component parameter values for the component instance */
|
|
5604
5855
|
parameters?: {
|
|
5605
|
-
[key: string]: components$
|
|
5856
|
+
[key: string]: components$d["schemas"]["ComponentParameter"];
|
|
5606
5857
|
};
|
|
5607
5858
|
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
|
5608
5859
|
variant?: string;
|
|
5609
5860
|
/** @description Slots containing any child components */
|
|
5610
5861
|
slots?: {
|
|
5611
|
-
[key: string]: components$
|
|
5862
|
+
[key: string]: components$d["schemas"]["ComponentInstance"][];
|
|
5612
5863
|
};
|
|
5613
5864
|
/** @description Unique identifier of the component within the composition.
|
|
5614
5865
|
* No assumptions should be made about the format of this value other than "it will be unique."
|
|
@@ -5618,14 +5869,14 @@ interface components$e {
|
|
|
5618
5869
|
_id?: string;
|
|
5619
5870
|
/** @description Indicates this component instance should be sourced from a pattern library pattern */
|
|
5620
5871
|
_pattern?: string;
|
|
5621
|
-
_dataResources?: components$
|
|
5872
|
+
_dataResources?: components$d["schemas"]["DataResourceDefinitions"];
|
|
5622
5873
|
/** @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
|
5623
5874
|
* Means nothing for PUTs; it will be ignored
|
|
5624
5875
|
* */
|
|
5625
5876
|
_patternDataResources?: {
|
|
5626
|
-
[key: string]: components$
|
|
5877
|
+
[key: string]: components$d["schemas"]["DataResourceDefinition"];
|
|
5627
5878
|
};
|
|
5628
|
-
_patternError?: components$
|
|
5879
|
+
_patternError?: components$d["schemas"]["PatternError"];
|
|
5629
5880
|
/** @description Defines patch overrides to component IDs that live in the composition.
|
|
5630
5881
|
* This can be used to override parameters that are defined on patterns,
|
|
5631
5882
|
* including nested patterns, with values that are specific to this composition.
|
|
@@ -5638,13 +5889,13 @@ interface components$e {
|
|
|
5638
5889
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
5639
5890
|
* */
|
|
5640
5891
|
_overrides?: {
|
|
5641
|
-
[key: string]: components$
|
|
5892
|
+
[key: string]: components$d["schemas"]["ComponentOverride"];
|
|
5642
5893
|
};
|
|
5643
5894
|
/** @description Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
|
|
5644
5895
|
* Means nothing for PUTs; it will be ignored
|
|
5645
5896
|
* */
|
|
5646
5897
|
_patternOverrides?: {
|
|
5647
|
-
[key: string]: components$
|
|
5898
|
+
[key: string]: components$d["schemas"]["ComponentOverride"];
|
|
5648
5899
|
};
|
|
5649
5900
|
/** @description When used on a pattern, defines how the pattern's parameters may be overridden
|
|
5650
5901
|
* by consumers of the pattern.
|
|
@@ -5652,7 +5903,7 @@ interface components$e {
|
|
|
5652
5903
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
5653
5904
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
5654
5905
|
* */
|
|
5655
|
-
_overridability?: components$
|
|
5906
|
+
_overridability?: components$d["schemas"]["ComponentOverridability"];
|
|
5656
5907
|
/** @description Array of locales that have data defined. Only set for pattern references or composition defaults */
|
|
5657
5908
|
_locales?: string[];
|
|
5658
5909
|
};
|
|
@@ -5675,13 +5926,13 @@ interface components$e {
|
|
|
5675
5926
|
* If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
|
|
5676
5927
|
* */
|
|
5677
5928
|
optionalPatternParameter?: boolean;
|
|
5678
|
-
variables?: components$
|
|
5929
|
+
variables?: components$d["schemas"]["DataResourceVariables"];
|
|
5679
5930
|
};
|
|
5680
5931
|
/** @description Data definitions attached to this component. The property name is the key of the data in the data document.
|
|
5681
5932
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key)
|
|
5682
5933
|
* */
|
|
5683
5934
|
DataResourceDefinitions: {
|
|
5684
|
-
[key: string]: components$
|
|
5935
|
+
[key: string]: components$d["schemas"]["DataResourceDefinition"];
|
|
5685
5936
|
};
|
|
5686
5937
|
/**
|
|
5687
5938
|
* @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
|
@@ -5699,10 +5950,10 @@ interface components$e {
|
|
|
5699
5950
|
* */
|
|
5700
5951
|
ComponentOverride: {
|
|
5701
5952
|
parameters?: {
|
|
5702
|
-
[key: string]: components$
|
|
5953
|
+
[key: string]: components$d["schemas"]["ComponentParameter"];
|
|
5703
5954
|
};
|
|
5704
5955
|
slots?: {
|
|
5705
|
-
[key: string]: components$
|
|
5956
|
+
[key: string]: components$d["schemas"]["ComponentInstance"][];
|
|
5706
5957
|
};
|
|
5707
5958
|
variant?: string;
|
|
5708
5959
|
/** @description Overrides data resource definitions for a pattern component.
|
|
@@ -5710,7 +5961,7 @@ interface components$e {
|
|
|
5710
5961
|
* Overrides defined here replace values in either _dataResources or _patternDataResources on the target component.
|
|
5711
5962
|
* */
|
|
5712
5963
|
dataResources?: {
|
|
5713
|
-
[key: string]: components$
|
|
5964
|
+
[key: string]: components$d["schemas"]["DataResourceDefinition"];
|
|
5714
5965
|
};
|
|
5715
5966
|
};
|
|
5716
5967
|
/**
|
|
@@ -5731,7 +5982,7 @@ interface components$e {
|
|
|
5731
5982
|
ComponentOverridability: {
|
|
5732
5983
|
/** @description Defines component parameter value overrides. Keys are the parameter public ID */
|
|
5733
5984
|
parameters?: {
|
|
5734
|
-
[key: string]: components$
|
|
5985
|
+
[key: string]: components$d["schemas"]["OverrideOptions"];
|
|
5735
5986
|
};
|
|
5736
5987
|
/** @description Allows overriding a display variant is allowed if it is defined on the component the pattern is derived from. Default = false */
|
|
5737
5988
|
variants?: boolean;
|
|
@@ -5747,15 +5998,15 @@ interface components$e {
|
|
|
5747
5998
|
type: string;
|
|
5748
5999
|
/** @description Component parameter values for the component instance */
|
|
5749
6000
|
parameters?: {
|
|
5750
|
-
[key: string]: components$
|
|
6001
|
+
[key: string]: components$d["schemas"]["ComponentParameter"];
|
|
5751
6002
|
};
|
|
5752
6003
|
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
|
5753
6004
|
variant?: string;
|
|
5754
6005
|
/** @description Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated */
|
|
5755
|
-
projectMapNodes?: components$
|
|
6006
|
+
projectMapNodes?: components$d["schemas"]["CompositionProjectMapNodeInfo"][];
|
|
5756
6007
|
/** @description Slots containing any child components */
|
|
5757
6008
|
slots?: {
|
|
5758
|
-
[key: string]: components$
|
|
6009
|
+
[key: string]: components$d["schemas"]["ComponentInstance"][];
|
|
5759
6010
|
};
|
|
5760
6011
|
/** @description The ID of the composition */
|
|
5761
6012
|
_id: string;
|
|
@@ -5777,10 +6028,10 @@ interface components$e {
|
|
|
5777
6028
|
* Means nothing for PUTs; it will be ignored
|
|
5778
6029
|
* */
|
|
5779
6030
|
_patternDataResources?: {
|
|
5780
|
-
[key: string]: components$
|
|
6031
|
+
[key: string]: components$d["schemas"]["DataResourceDefinition"];
|
|
5781
6032
|
};
|
|
5782
|
-
_dataResources?: components$
|
|
5783
|
-
_patternError?: components$
|
|
6033
|
+
_dataResources?: components$d["schemas"]["DataResourceDefinitions"];
|
|
6034
|
+
_patternError?: components$d["schemas"]["PatternError"];
|
|
5784
6035
|
/** @description Defines patch overrides to component IDs that live in the composition.
|
|
5785
6036
|
* This can be used to override parameters that are defined on patterns,
|
|
5786
6037
|
* including nested patterns, with values that are specific to this composition.
|
|
@@ -5793,13 +6044,13 @@ interface components$e {
|
|
|
5793
6044
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
5794
6045
|
* */
|
|
5795
6046
|
_overrides?: {
|
|
5796
|
-
[key: string]: components$
|
|
6047
|
+
[key: string]: components$d["schemas"]["ComponentOverride"];
|
|
5797
6048
|
};
|
|
5798
6049
|
/** @description Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
|
|
5799
6050
|
* Means nothing for PUTs; it will be ignored
|
|
5800
6051
|
* */
|
|
5801
6052
|
_patternOverrides?: {
|
|
5802
|
-
[key: string]: components$
|
|
6053
|
+
[key: string]: components$d["schemas"]["ComponentOverride"];
|
|
5803
6054
|
};
|
|
5804
6055
|
/** @description When used on a pattern, defines how the pattern's parameters may be overridden
|
|
5805
6056
|
* by consumers of the pattern.
|
|
@@ -5807,7 +6058,7 @@ interface components$e {
|
|
|
5807
6058
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
5808
6059
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
5809
6060
|
* */
|
|
5810
|
-
_overridability?: components$
|
|
6061
|
+
_overridability?: components$d["schemas"]["ComponentOverridability"];
|
|
5811
6062
|
/** @description Array of locales which have data defined on the composition. If empty, the current default locale implicitly has data */
|
|
5812
6063
|
_locales?: string[];
|
|
5813
6064
|
};
|
|
@@ -5838,7 +6089,7 @@ interface components$e {
|
|
|
5838
6089
|
* NOTE: Users without membership in any role listed here will be unable to execute the transition unless they are team admins
|
|
5839
6090
|
* */
|
|
5840
6091
|
permissions: {
|
|
5841
|
-
[key: string]: components$
|
|
6092
|
+
[key: string]: components$d["schemas"]["WorkflowStageTransitionPermission"];
|
|
5842
6093
|
};
|
|
5843
6094
|
};
|
|
5844
6095
|
/** @description Definition of a stage in a workflow */
|
|
@@ -5851,7 +6102,7 @@ interface components$e {
|
|
|
5851
6102
|
* listed here, the stage is read-only and publishing is disabled
|
|
5852
6103
|
* */
|
|
5853
6104
|
permissions: {
|
|
5854
|
-
[key: string]: components$
|
|
6105
|
+
[key: string]: components$d["schemas"]["WorkflowStagePermission"];
|
|
5855
6106
|
};
|
|
5856
6107
|
/** @description When true, transitioning into this stage from a different stage will automatically publish the entity.
|
|
5857
6108
|
* If the user making the transition does not have publish permissions to the stage as well as publish permission on the entity, the action will not run.
|
|
@@ -5868,7 +6119,7 @@ interface components$e {
|
|
|
5868
6119
|
* Every stage must define at least one transition, to avoid creating a workflow that
|
|
5869
6120
|
* has a stage that can never be escaped
|
|
5870
6121
|
* */
|
|
5871
|
-
transitions: components$
|
|
6122
|
+
transitions: components$d["schemas"]["WorkflowStageTransition"][];
|
|
5872
6123
|
/**
|
|
5873
6124
|
* @description Icon name for the stage (e.g. 'chevron-double-right-o')
|
|
5874
6125
|
* @default chevron-double-right-o
|
|
@@ -5893,7 +6144,7 @@ interface components$e {
|
|
|
5893
6144
|
initialStage: string;
|
|
5894
6145
|
/** @description All stages of the workflow */
|
|
5895
6146
|
stages: {
|
|
5896
|
-
[key: string]: components$
|
|
6147
|
+
[key: string]: components$d["schemas"]["WorkflowStage"];
|
|
5897
6148
|
};
|
|
5898
6149
|
/** @description Last modified ISO date string for this definition (ignored for writes) */
|
|
5899
6150
|
modified?: string;
|
|
@@ -5959,7 +6210,7 @@ interface components$e {
|
|
|
5959
6210
|
* @description The release this composition belongs to. If not set, it belongs to the base
|
|
5960
6211
|
*/
|
|
5961
6212
|
releaseId?: string;
|
|
5962
|
-
composition: components$
|
|
6213
|
+
composition: components$d["schemas"]["RootComponentInstance"];
|
|
5963
6214
|
/**
|
|
5964
6215
|
* Format: uuid
|
|
5965
6216
|
* @description The workflow ID assigned to this composition, if any. Normally comes from the component definition
|
|
@@ -5971,7 +6222,7 @@ interface components$e {
|
|
|
5971
6222
|
*/
|
|
5972
6223
|
workflowStageId?: string;
|
|
5973
6224
|
/** @description The full definition of the assigned workflow, if any, including stages, permissions, etc. Returned only when `withWorkflowDefinition` is true */
|
|
5974
|
-
workflowDefinition?: components$
|
|
6225
|
+
workflowDefinition?: components$d["schemas"]["WorkflowDefinition"];
|
|
5975
6226
|
/**
|
|
5976
6227
|
* Format: uuid
|
|
5977
6228
|
* @description The edition ID. When set, this is a child edition of the composition in _id.
|
|
@@ -6059,7 +6310,7 @@ interface components$e {
|
|
|
6059
6310
|
pathItems: never;
|
|
6060
6311
|
}
|
|
6061
6312
|
|
|
6062
|
-
interface paths$
|
|
6313
|
+
interface paths$b {
|
|
6063
6314
|
"/api/v1/canvas": {
|
|
6064
6315
|
parameters: {
|
|
6065
6316
|
query?: never;
|
|
@@ -6074,81 +6325,81 @@ interface paths$c {
|
|
|
6074
6325
|
* This is a primary query parameter and cannot be used with any other primary query parameters.
|
|
6075
6326
|
* When `editions=raw`, this parameter matches on composition or edition IDs and edition resolution is disabled.
|
|
6076
6327
|
* */
|
|
6077
|
-
compositionId?: components$
|
|
6328
|
+
compositionId?: components$c["parameters"]["compositionId"];
|
|
6078
6329
|
/** @description Specify a single component ID to fetch the component's composition defaults. The response will be a single composition.
|
|
6079
6330
|
* This is a primary query parameter and cannot be used with any other primary query parameters
|
|
6080
6331
|
* */
|
|
6081
|
-
componentId?: components$
|
|
6332
|
+
componentId?: components$c["parameters"]["componentId"];
|
|
6082
6333
|
/** @description Specify a historical composition version ID to fetch (retrieved from the canvas-history API).
|
|
6083
6334
|
* Must be used with the `compositionId` parameter
|
|
6084
6335
|
* */
|
|
6085
|
-
versionId?: components$
|
|
6336
|
+
versionId?: components$c["parameters"]["versionId"];
|
|
6086
6337
|
/** @description Specify multiple composition IDs to fetch. The response type will be a list.
|
|
6087
6338
|
* This is a primary query parameter and cannot be used with any other primary query parameters.
|
|
6088
6339
|
* When `editions=raw`, this parameter matches on composition or edition IDs and edition resolution is disabled.
|
|
6089
6340
|
* */
|
|
6090
|
-
compositionIDs?: components$
|
|
6341
|
+
compositionIDs?: components$c["parameters"]["compositionIDs"];
|
|
6091
6342
|
/** @description Filters composition lists by the user who created them. The user is specified by their identity subject.
|
|
6092
6343
|
* This is a list query parameter and cannot be used with any primary query parameters
|
|
6093
6344
|
* */
|
|
6094
|
-
createdBy?: components$
|
|
6345
|
+
createdBy?: components$c["parameters"]["createdBy"];
|
|
6095
6346
|
/** @description Matches compositions where their name, slug, or definition name contains the specified keyword.
|
|
6096
6347
|
* NOT a full-text search; does not match composition contents.
|
|
6097
6348
|
* This is a list query parameter and cannot be used with any primary query parameters
|
|
6098
6349
|
* */
|
|
6099
|
-
keyword?: components$
|
|
6350
|
+
keyword?: components$c["parameters"]["keyword"];
|
|
6100
6351
|
/** @description Maximum number of records to return
|
|
6101
6352
|
* This is a list query parameter and cannot be used with any primary query parameters
|
|
6102
6353
|
* */
|
|
6103
|
-
limit?: components$
|
|
6354
|
+
limit?: components$c["parameters"]["limit"];
|
|
6104
6355
|
/** @description Number of records to skip
|
|
6105
6356
|
* This is a list query parameter and cannot be used with any primary query parameters
|
|
6106
6357
|
* */
|
|
6107
|
-
offset?: components$
|
|
6358
|
+
offset?: components$c["parameters"]["offset"];
|
|
6108
6359
|
/** @description Sets the sorting of the results. If unspecified, results are sorted by name ascending.
|
|
6109
6360
|
* Allowed values are: updated_at_DESC, updated_at_ASC, created_at_DESC, created_at_ASC,
|
|
6110
6361
|
* name_DESC, name_ASC, slug_DESC, slug_ASC.
|
|
6111
6362
|
* When using primary query parameters, this parameter is ignored
|
|
6112
6363
|
* */
|
|
6113
|
-
orderBy?: components$
|
|
6364
|
+
orderBy?: components$c["parameters"]["orderBy"];
|
|
6114
6365
|
/**
|
|
6115
6366
|
* @deprecated
|
|
6116
6367
|
* @description Returns counts for distinct values of the specified field or fields (provided as comma-separated IDs).
|
|
6117
6368
|
*/
|
|
6118
|
-
facetBy?: components$
|
|
6369
|
+
facetBy?: components$c["parameters"]["facetBy"];
|
|
6119
6370
|
/** @description Matches compositions based on whether they are a pattern composition or a regular composition.
|
|
6120
6371
|
* If true, only pattern compositions will be returned.
|
|
6121
6372
|
* If false, only regular compositions will be returned.
|
|
6122
6373
|
* If omitted, both pattern and regular compositions will be returned.
|
|
6123
6374
|
* This is a list query parameter and cannot be used with any primary query parameters
|
|
6124
6375
|
* */
|
|
6125
|
-
pattern?: components$
|
|
6376
|
+
pattern?: components$c["parameters"]["pattern"];
|
|
6126
6377
|
/** @description This specifies which type of patterns to return. This query parameter has no effect when `pattern` is false.
|
|
6127
6378
|
* * `all` - Returns all pattern instances
|
|
6128
6379
|
* * `component` - Returns only component patterns
|
|
6129
6380
|
* * `composition` - Returns only composition patterns
|
|
6130
6381
|
* */
|
|
6131
|
-
patternType?: components$
|
|
6382
|
+
patternType?: components$c["parameters"]["patternType"];
|
|
6132
6383
|
/**
|
|
6133
6384
|
* @deprecated
|
|
6134
6385
|
* @description Includes the `patternType` attribute in the response
|
|
6135
6386
|
*/
|
|
6136
|
-
withPatternType?: components$
|
|
6387
|
+
withPatternType?: components$c["parameters"]["withPatternType"];
|
|
6137
6388
|
/** @description The project the composition(s) belong to */
|
|
6138
|
-
projectId: components$
|
|
6389
|
+
projectId: components$c["parameters"]["projectId"];
|
|
6139
6390
|
/** @description Specify a project map ID to fetch by path or node ID from.
|
|
6140
6391
|
* If not specified, the default project map for the projectId is used.
|
|
6141
6392
|
* Only used when fetching by projectMapNodeId or projectMapNodePath
|
|
6142
6393
|
* */
|
|
6143
|
-
projectMapId?: components$
|
|
6394
|
+
projectMapId?: components$c["parameters"]["projectMapId"];
|
|
6144
6395
|
/** @description Specify a single composition to fetch by associated project map node ID. The response will be a single composition.
|
|
6145
6396
|
* This is a primary query parameter and cannot be used with any other primary query parameters
|
|
6146
6397
|
* */
|
|
6147
|
-
projectMapNodeId?: components$
|
|
6398
|
+
projectMapNodeId?: components$c["parameters"]["projectMapNodeId"];
|
|
6148
6399
|
/** @description Specify a single composition to fetch by associated project map node path. The response will be a single composition.
|
|
6149
6400
|
* This is a primary query parameter and cannot be used with any other primary query parameters
|
|
6150
6401
|
* */
|
|
6151
|
-
projectMapNodePath?: components$
|
|
6402
|
+
projectMapNodePath?: components$c["parameters"]["projectMapNodePath"];
|
|
6152
6403
|
/**
|
|
6153
6404
|
* @deprecated
|
|
6154
6405
|
* @description Signals an enhancer proxy to skip processing enhancements to the data and return raw data only.
|
|
@@ -6156,37 +6407,37 @@ interface paths$c {
|
|
|
6156
6407
|
* If calling the Canvas API directly with no enhancer proxy, this has no effect
|
|
6157
6408
|
*
|
|
6158
6409
|
*/
|
|
6159
|
-
skipEnhance?: components$
|
|
6410
|
+
skipEnhance?: components$c["parameters"]["skipEnhance"];
|
|
6160
6411
|
/** @description If true, any pattern references in the composition will be left unresolved.
|
|
6161
6412
|
* This is appropriate if you intend to serialize the composition without patterns
|
|
6162
6413
|
* embedded into it, and serialize the pattern data separately
|
|
6163
6414
|
* */
|
|
6164
|
-
skipPatternResolution?: components$
|
|
6415
|
+
skipPatternResolution?: components$c["parameters"]["skipPatternResolution"];
|
|
6165
6416
|
/**
|
|
6166
6417
|
* @deprecated
|
|
6167
6418
|
* @description This parameter is unused and has no effect. Passing this parameter will become an error in the future
|
|
6168
6419
|
*
|
|
6169
6420
|
*/
|
|
6170
|
-
skipParameterResolution?: components$
|
|
6421
|
+
skipParameterResolution?: components$c["parameters"]["skipParameterResolution"];
|
|
6171
6422
|
/** @description If true, any pattern override data is not resolved by the API.
|
|
6172
6423
|
* This is intended for internal use in the Canvas editor and should not be used.
|
|
6173
6424
|
* Passing this parameter automatically implies `withComponentIDs` is true
|
|
6174
6425
|
* */
|
|
6175
|
-
skipOverridesResolution?: components$
|
|
6426
|
+
skipOverridesResolution?: components$c["parameters"]["skipOverridesResolution"];
|
|
6176
6427
|
/** @description Specify a single composition to fetch by slug. The response will be a single composition.
|
|
6177
6428
|
* This is a primary query parameter and cannot be used with any other primary query parameters
|
|
6178
6429
|
* */
|
|
6179
|
-
slug?: components$
|
|
6430
|
+
slug?: components$c["parameters"]["slug"];
|
|
6180
6431
|
/** @description Filtration by category ID. An empty string can be used to include records without a category. */
|
|
6181
|
-
categories?: components$
|
|
6432
|
+
categories?: components$c["parameters"]["categories"];
|
|
6182
6433
|
/** @description Publishing state to fetch. 0 = draft, 64 = published.
|
|
6183
6434
|
* This is a list query parameter and cannot be used with any primary query parameters
|
|
6184
6435
|
* */
|
|
6185
|
-
state?: components$
|
|
6436
|
+
state?: components$c["parameters"]["state"];
|
|
6186
6437
|
/** @description 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.
|
|
6187
6438
|
* This is a list query parameter and cannot be used with any primary query parameters
|
|
6188
6439
|
* */
|
|
6189
|
-
type?: components$
|
|
6440
|
+
type?: components$c["parameters"]["type"];
|
|
6190
6441
|
/**
|
|
6191
6442
|
* @deprecated
|
|
6192
6443
|
* @description Filters composition lists by the UI status of the composition.
|
|
@@ -6194,41 +6445,41 @@ interface paths$c {
|
|
|
6194
6445
|
* This is a list query parameter and cannot be used with any primary query parameters
|
|
6195
6446
|
*
|
|
6196
6447
|
*/
|
|
6197
|
-
uiStatus?: components$
|
|
6448
|
+
uiStatus?: components$c["parameters"]["uiStatus"];
|
|
6198
6449
|
/** @description Filters out compositions without attached node or filters out compositions with attached nodes
|
|
6199
6450
|
* if set to false. If not specified, no filtration is applied.
|
|
6200
6451
|
* This is a list query parameter and cannot be used with any primary query parameters
|
|
6201
6452
|
* */
|
|
6202
|
-
attachedToProjectMap?: components$
|
|
6453
|
+
attachedToProjectMap?: components$c["parameters"]["attachedToProjectMap"];
|
|
6203
6454
|
/** @description Filters composition lists by the user who last updated them. The user is specified by their identity subject.
|
|
6204
6455
|
* This is a list query parameter and cannot be used with any primary query parameters
|
|
6205
6456
|
* */
|
|
6206
|
-
updatedBy?: components$
|
|
6457
|
+
updatedBy?: components$c["parameters"]["updatedBy"];
|
|
6207
6458
|
/** @description If true, the `_id` unique identifier of each non-root component will be part of the response data.
|
|
6208
6459
|
* If false, the `_id` will not be present in the API response
|
|
6209
6460
|
* */
|
|
6210
|
-
withComponentIDs?: components$
|
|
6461
|
+
withComponentIDs?: components$c["parameters"]["withComponentIDs"];
|
|
6211
6462
|
/** @description Controls whether the total count of results will be returned along with the current results page in a list.
|
|
6212
6463
|
* Has no effect when not fetching a list. This does impact performance when enabled
|
|
6213
6464
|
* */
|
|
6214
|
-
withTotalCount?: components$
|
|
6465
|
+
withTotalCount?: components$c["parameters"]["withTotalCount"];
|
|
6215
6466
|
/**
|
|
6216
6467
|
* @deprecated
|
|
6217
6468
|
* @description Returns the UI status string of the composition.
|
|
6218
6469
|
* This internal status is subject to change without notice and is thus marked deprecated to discourage use of internal data
|
|
6219
6470
|
*
|
|
6220
6471
|
*/
|
|
6221
|
-
withUIStatus?: components$
|
|
6472
|
+
withUIStatus?: components$c["parameters"]["withUIStatus"];
|
|
6222
6473
|
/** @description Returns the definition of any attached workflow along with the composition data
|
|
6223
6474
|
* */
|
|
6224
|
-
withWorkflowDefinition?: components$
|
|
6475
|
+
withWorkflowDefinition?: components$c["parameters"]["withWorkflowDefinition"];
|
|
6225
6476
|
/** @description Includes project map node information in the composition results */
|
|
6226
|
-
withProjectMapNodes?: components$
|
|
6477
|
+
withProjectMapNodes?: components$c["parameters"]["withProjectMapNodes"];
|
|
6227
6478
|
/**
|
|
6228
6479
|
* @deprecated
|
|
6229
6480
|
* @description Includes content source map metadata on supported parameters
|
|
6230
6481
|
*/
|
|
6231
|
-
withContentSourceMap?: components$
|
|
6482
|
+
withContentSourceMap?: components$c["parameters"]["withContentSourceMap"];
|
|
6232
6483
|
/** @description One or more locales to filter and localize by.
|
|
6233
6484
|
* 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.
|
|
6234
6485
|
* For all types of response, the response will be localized to include only the first matching locale's data.
|
|
@@ -6241,7 +6492,7 @@ interface paths$c {
|
|
|
6241
6492
|
* When this parameter is not passed, all locales' data will be returned.
|
|
6242
6493
|
* If a composition is requested by ID and does not possess any of the specified locales, HTTP 404 will be returned
|
|
6243
6494
|
* */
|
|
6244
|
-
locale?: components$
|
|
6495
|
+
locale?: components$c["parameters"]["locale"];
|
|
6245
6496
|
/** @description The ID of a release to fetch the content for.
|
|
6246
6497
|
*
|
|
6247
6498
|
* - When unspecified, all release content is excluded from the result(s).
|
|
@@ -6249,12 +6500,12 @@ interface paths$c {
|
|
|
6249
6500
|
*
|
|
6250
6501
|
* 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
|
|
6251
6502
|
* */
|
|
6252
|
-
releaseId?: components$
|
|
6503
|
+
releaseId?: components$c["parameters"]["releaseId"];
|
|
6253
6504
|
/** @description Search on textual fields of a composition.
|
|
6254
6505
|
* Note: For long text fields, the tail of the text is not guaranteed to be searchable
|
|
6255
6506
|
* Example: ?search=hello
|
|
6256
6507
|
* */
|
|
6257
|
-
search?: components$
|
|
6508
|
+
search?: components$c["parameters"]["search"];
|
|
6258
6509
|
/** @description Controls the edition resolution behavior.
|
|
6259
6510
|
*
|
|
6260
6511
|
* auto: (default) Editions are evaluated automatically and the best matching edition is returned.
|
|
@@ -6268,7 +6519,7 @@ interface paths$c {
|
|
|
6268
6519
|
* compositionId or compositionIDs MUST be provided with this option.
|
|
6269
6520
|
* If versionId is passed, this is always enabled.
|
|
6270
6521
|
* */
|
|
6271
|
-
editions?: components$
|
|
6522
|
+
editions?: components$c["parameters"]["editions"];
|
|
6272
6523
|
};
|
|
6273
6524
|
header?: never;
|
|
6274
6525
|
path?: never;
|
|
@@ -6282,12 +6533,12 @@ interface paths$c {
|
|
|
6282
6533
|
[name: string]: unknown;
|
|
6283
6534
|
};
|
|
6284
6535
|
content: {
|
|
6285
|
-
"application/json": components$
|
|
6536
|
+
"application/json": components$c["schemas"]["CompositionListResponse"] | components$c["schemas"]["CompositionApiResponse"];
|
|
6286
6537
|
};
|
|
6287
6538
|
};
|
|
6288
|
-
400: components$
|
|
6289
|
-
401: components$
|
|
6290
|
-
403: components$
|
|
6539
|
+
400: components$c["responses"]["BadRequestError"];
|
|
6540
|
+
401: components$c["responses"]["UnauthorizedError"];
|
|
6541
|
+
403: components$c["responses"]["ForbiddenError"];
|
|
6291
6542
|
/** @description Composition not found */
|
|
6292
6543
|
404: {
|
|
6293
6544
|
headers: {
|
|
@@ -6297,8 +6548,8 @@ interface paths$c {
|
|
|
6297
6548
|
"text/plain": string;
|
|
6298
6549
|
};
|
|
6299
6550
|
};
|
|
6300
|
-
429: components$
|
|
6301
|
-
500: components$
|
|
6551
|
+
429: components$c["responses"]["RateLimitError"];
|
|
6552
|
+
500: components$c["responses"]["InternalServerError"];
|
|
6302
6553
|
};
|
|
6303
6554
|
};
|
|
6304
6555
|
/** @description Upserts a composition */
|
|
@@ -6325,7 +6576,7 @@ interface paths$c {
|
|
|
6325
6576
|
projectId: string;
|
|
6326
6577
|
/** @description The publishing state to upsert into. 0 = draft, 64 = published */
|
|
6327
6578
|
state: number;
|
|
6328
|
-
composition: components$
|
|
6579
|
+
composition: components$c["schemas"]["RootComponentInstance"];
|
|
6329
6580
|
/**
|
|
6330
6581
|
* @description Indicates if the composition is a pattern that can be referenced in other compositions
|
|
6331
6582
|
* @default false
|
|
@@ -6391,9 +6642,9 @@ interface paths$c {
|
|
|
6391
6642
|
};
|
|
6392
6643
|
content?: never;
|
|
6393
6644
|
};
|
|
6394
|
-
400: components$
|
|
6395
|
-
401: components$
|
|
6396
|
-
403: components$
|
|
6645
|
+
400: components$c["responses"]["BadRequestError"];
|
|
6646
|
+
401: components$c["responses"]["UnauthorizedError"];
|
|
6647
|
+
403: components$c["responses"]["ForbiddenError"];
|
|
6397
6648
|
/** @description Conflict - Composition has been changed since being loaded */
|
|
6398
6649
|
409: {
|
|
6399
6650
|
headers: {
|
|
@@ -6403,8 +6654,8 @@ interface paths$c {
|
|
|
6403
6654
|
"text/plain": string;
|
|
6404
6655
|
};
|
|
6405
6656
|
};
|
|
6406
|
-
429: components$
|
|
6407
|
-
500: components$
|
|
6657
|
+
429: components$c["responses"]["RateLimitError"];
|
|
6658
|
+
500: components$c["responses"]["InternalServerError"];
|
|
6408
6659
|
};
|
|
6409
6660
|
};
|
|
6410
6661
|
post?: never;
|
|
@@ -6460,11 +6711,11 @@ interface paths$c {
|
|
|
6460
6711
|
};
|
|
6461
6712
|
content?: never;
|
|
6462
6713
|
};
|
|
6463
|
-
400: components$
|
|
6464
|
-
401: components$
|
|
6465
|
-
403: components$
|
|
6466
|
-
429: components$
|
|
6467
|
-
500: components$
|
|
6714
|
+
400: components$c["responses"]["BadRequestError"];
|
|
6715
|
+
401: components$c["responses"]["UnauthorizedError"];
|
|
6716
|
+
403: components$c["responses"]["ForbiddenError"];
|
|
6717
|
+
429: components$c["responses"]["RateLimitError"];
|
|
6718
|
+
500: components$c["responses"]["InternalServerError"];
|
|
6468
6719
|
};
|
|
6469
6720
|
};
|
|
6470
6721
|
/** @description Handles preflight requests. This endpoint allows CORS */
|
|
@@ -6491,7 +6742,7 @@ interface paths$c {
|
|
|
6491
6742
|
trace?: never;
|
|
6492
6743
|
};
|
|
6493
6744
|
}
|
|
6494
|
-
interface components$
|
|
6745
|
+
interface components$c {
|
|
6495
6746
|
schemas: {
|
|
6496
6747
|
CompositionApiResponse: {
|
|
6497
6748
|
/** @description Publishing state to fetch. 0 = draft, 64 = published */
|
|
@@ -6542,7 +6793,7 @@ interface components$d {
|
|
|
6542
6793
|
* @description The release this composition belongs to. If not set, it belongs to the base
|
|
6543
6794
|
*/
|
|
6544
6795
|
releaseId?: string;
|
|
6545
|
-
composition: components$
|
|
6796
|
+
composition: components$c["schemas"]["RootComponentInstance"];
|
|
6546
6797
|
/**
|
|
6547
6798
|
* Format: uuid
|
|
6548
6799
|
* @description The workflow ID assigned to this composition, if any. Normally comes from the component definition
|
|
@@ -6554,7 +6805,7 @@ interface components$d {
|
|
|
6554
6805
|
*/
|
|
6555
6806
|
workflowStageId?: string;
|
|
6556
6807
|
/** @description The full definition of the assigned workflow, if any, including stages, permissions, etc. Returned only when `withWorkflowDefinition` is true */
|
|
6557
|
-
workflowDefinition?: components$
|
|
6808
|
+
workflowDefinition?: components$c["schemas"]["WorkflowDefinition"];
|
|
6558
6809
|
/**
|
|
6559
6810
|
* Format: uuid
|
|
6560
6811
|
* @description The edition ID. When set, this is a child edition of the composition in _id.
|
|
@@ -6571,7 +6822,7 @@ interface components$d {
|
|
|
6571
6822
|
editionPriority?: number;
|
|
6572
6823
|
};
|
|
6573
6824
|
CompositionListResponse: {
|
|
6574
|
-
compositions: components$
|
|
6825
|
+
compositions: components$c["schemas"]["CompositionApiResponse"][];
|
|
6575
6826
|
/** @description Total number of compositions that match the query. Present only when `withTotalCount` option is true */
|
|
6576
6827
|
totalCount?: number;
|
|
6577
6828
|
/** @description Per-field counts for distinct values */
|
|
@@ -6646,12 +6897,12 @@ interface components$d {
|
|
|
6646
6897
|
* @enum {string}
|
|
6647
6898
|
*/
|
|
6648
6899
|
op?: "&" | "|";
|
|
6649
|
-
clauses: (components$
|
|
6900
|
+
clauses: (components$c["schemas"]["VisibilityCriteria"] | components$c["schemas"]["VisibilityCriteriaGroup"])[];
|
|
6650
6901
|
};
|
|
6651
6902
|
/** @description Defines a conditional value for a component parameter
|
|
6652
6903
|
* */
|
|
6653
6904
|
ComponentParameterConditionalValue: {
|
|
6654
|
-
when: components$
|
|
6905
|
+
when: components$c["schemas"]["VisibilityCriteriaGroup"];
|
|
6655
6906
|
/** @description The value of the parameter. Any JSON-serializable value is acceptable.
|
|
6656
6907
|
* A value of `null` will cause the parameter value to be removed, if it matches.
|
|
6657
6908
|
* */
|
|
@@ -6670,7 +6921,7 @@ interface components$d {
|
|
|
6670
6921
|
*
|
|
6671
6922
|
* When no locale is passed to a non-route API, conditions are not processed and all conditions are returned.
|
|
6672
6923
|
* */
|
|
6673
|
-
ComponentParameterConditions: components$
|
|
6924
|
+
ComponentParameterConditions: components$c["schemas"]["ComponentParameterConditionalValue"][];
|
|
6674
6925
|
/** @description Defines an editable parameter on a component */
|
|
6675
6926
|
ComponentParameter: {
|
|
6676
6927
|
/** @description The value of the parameter. Any JSON-serializable value is acceptable */
|
|
@@ -6678,18 +6929,18 @@ interface components$d {
|
|
|
6678
6929
|
/** @description The type of the parameter. Determines how it is displayed when editing and tells the consumer how to process it */
|
|
6679
6930
|
type: string;
|
|
6680
6931
|
/** @deprecated */
|
|
6681
|
-
connectedData?: components$
|
|
6932
|
+
connectedData?: components$c["schemas"]["DataElementConnectionDefinition"];
|
|
6682
6933
|
/** @description Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
|
|
6683
6934
|
* Note that locales must be registered on the entry/composition `_locales` before being used
|
|
6684
6935
|
* */
|
|
6685
6936
|
locales?: {
|
|
6686
6937
|
[key: string]: unknown;
|
|
6687
6938
|
};
|
|
6688
|
-
conditions?: components$
|
|
6939
|
+
conditions?: components$c["schemas"]["ComponentParameterConditions"];
|
|
6689
6940
|
/** @description Locale-specific conditional values for this parameter. Keys are locale codes, and values are the `conditions` for that locale.
|
|
6690
6941
|
* */
|
|
6691
6942
|
localesConditions?: {
|
|
6692
|
-
[key: string]: components$
|
|
6943
|
+
[key: string]: components$c["schemas"]["ComponentParameterConditions"];
|
|
6693
6944
|
};
|
|
6694
6945
|
};
|
|
6695
6946
|
ProjectMapNodeAllowedQueryString: {
|
|
@@ -6718,7 +6969,7 @@ interface components$d {
|
|
|
6718
6969
|
/** @description 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 */
|
|
6719
6970
|
isSearchHit?: boolean;
|
|
6720
6971
|
/** @description Query strings that are allowed to be passed to the node */
|
|
6721
|
-
queryStrings?: components$
|
|
6972
|
+
queryStrings?: components$c["schemas"]["ProjectMapNodeAllowedQueryString"][];
|
|
6722
6973
|
/** @description For dynamic nodes, this is the preview value for the dynamic value.
|
|
6723
6974
|
* The preview value is used when editing a connected composition, and is the default
|
|
6724
6975
|
* dynamic node value unless the author has explicitly chosen a different value
|
|
@@ -6741,7 +6992,7 @@ interface components$d {
|
|
|
6741
6992
|
* @description Unique identifier for the project map that this node belongs to
|
|
6742
6993
|
*/
|
|
6743
6994
|
projectMapId: string;
|
|
6744
|
-
data?: components$
|
|
6995
|
+
data?: components$c["schemas"]["ProjectMapNodeData"];
|
|
6745
6996
|
/** @description Locale-specific paths of the project map node.
|
|
6746
6997
|
* Keys are locale codes
|
|
6747
6998
|
* */
|
|
@@ -6761,13 +7012,13 @@ interface components$d {
|
|
|
6761
7012
|
type: string;
|
|
6762
7013
|
/** @description Component parameter values for the component instance */
|
|
6763
7014
|
parameters?: {
|
|
6764
|
-
[key: string]: components$
|
|
7015
|
+
[key: string]: components$c["schemas"]["ComponentParameter"];
|
|
6765
7016
|
};
|
|
6766
7017
|
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
|
6767
7018
|
variant?: string;
|
|
6768
7019
|
/** @description Slots containing any child components */
|
|
6769
7020
|
slots?: {
|
|
6770
|
-
[key: string]: components$
|
|
7021
|
+
[key: string]: components$c["schemas"]["ComponentInstance"][];
|
|
6771
7022
|
};
|
|
6772
7023
|
/** @description Unique identifier of the component within the composition.
|
|
6773
7024
|
* No assumptions should be made about the format of this value other than "it will be unique."
|
|
@@ -6777,14 +7028,14 @@ interface components$d {
|
|
|
6777
7028
|
_id?: string;
|
|
6778
7029
|
/** @description Indicates this component instance should be sourced from a pattern library pattern */
|
|
6779
7030
|
_pattern?: string;
|
|
6780
|
-
_dataResources?: components$
|
|
7031
|
+
_dataResources?: components$c["schemas"]["DataResourceDefinitions"];
|
|
6781
7032
|
/** @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
|
6782
7033
|
* Means nothing for PUTs; it will be ignored
|
|
6783
7034
|
* */
|
|
6784
7035
|
_patternDataResources?: {
|
|
6785
|
-
[key: string]: components$
|
|
7036
|
+
[key: string]: components$c["schemas"]["DataResourceDefinition"];
|
|
6786
7037
|
};
|
|
6787
|
-
_patternError?: components$
|
|
7038
|
+
_patternError?: components$c["schemas"]["PatternError"];
|
|
6788
7039
|
/** @description Defines patch overrides to component IDs that live in the composition.
|
|
6789
7040
|
* This can be used to override parameters that are defined on patterns,
|
|
6790
7041
|
* including nested patterns, with values that are specific to this composition.
|
|
@@ -6797,13 +7048,13 @@ interface components$d {
|
|
|
6797
7048
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
6798
7049
|
* */
|
|
6799
7050
|
_overrides?: {
|
|
6800
|
-
[key: string]: components$
|
|
7051
|
+
[key: string]: components$c["schemas"]["ComponentOverride"];
|
|
6801
7052
|
};
|
|
6802
7053
|
/** @description Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
|
|
6803
7054
|
* Means nothing for PUTs; it will be ignored
|
|
6804
7055
|
* */
|
|
6805
7056
|
_patternOverrides?: {
|
|
6806
|
-
[key: string]: components$
|
|
7057
|
+
[key: string]: components$c["schemas"]["ComponentOverride"];
|
|
6807
7058
|
};
|
|
6808
7059
|
/** @description When used on a pattern, defines how the pattern's parameters may be overridden
|
|
6809
7060
|
* by consumers of the pattern.
|
|
@@ -6811,7 +7062,7 @@ interface components$d {
|
|
|
6811
7062
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
6812
7063
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
6813
7064
|
* */
|
|
6814
|
-
_overridability?: components$
|
|
7065
|
+
_overridability?: components$c["schemas"]["ComponentOverridability"];
|
|
6815
7066
|
/** @description Array of locales that have data defined. Only set for pattern references or composition defaults */
|
|
6816
7067
|
_locales?: string[];
|
|
6817
7068
|
};
|
|
@@ -6834,13 +7085,13 @@ interface components$d {
|
|
|
6834
7085
|
* If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
|
|
6835
7086
|
* */
|
|
6836
7087
|
optionalPatternParameter?: boolean;
|
|
6837
|
-
variables?: components$
|
|
7088
|
+
variables?: components$c["schemas"]["DataResourceVariables"];
|
|
6838
7089
|
};
|
|
6839
7090
|
/** @description Data definitions attached to this component. The property name is the key of the data in the data document.
|
|
6840
7091
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key)
|
|
6841
7092
|
* */
|
|
6842
7093
|
DataResourceDefinitions: {
|
|
6843
|
-
[key: string]: components$
|
|
7094
|
+
[key: string]: components$c["schemas"]["DataResourceDefinition"];
|
|
6844
7095
|
};
|
|
6845
7096
|
/**
|
|
6846
7097
|
* @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
|
@@ -6858,10 +7109,10 @@ interface components$d {
|
|
|
6858
7109
|
* */
|
|
6859
7110
|
ComponentOverride: {
|
|
6860
7111
|
parameters?: {
|
|
6861
|
-
[key: string]: components$
|
|
7112
|
+
[key: string]: components$c["schemas"]["ComponentParameter"];
|
|
6862
7113
|
};
|
|
6863
7114
|
slots?: {
|
|
6864
|
-
[key: string]: components$
|
|
7115
|
+
[key: string]: components$c["schemas"]["ComponentInstance"][];
|
|
6865
7116
|
};
|
|
6866
7117
|
variant?: string;
|
|
6867
7118
|
/** @description Overrides data resource definitions for a pattern component.
|
|
@@ -6869,7 +7120,7 @@ interface components$d {
|
|
|
6869
7120
|
* Overrides defined here replace values in either _dataResources or _patternDataResources on the target component.
|
|
6870
7121
|
* */
|
|
6871
7122
|
dataResources?: {
|
|
6872
|
-
[key: string]: components$
|
|
7123
|
+
[key: string]: components$c["schemas"]["DataResourceDefinition"];
|
|
6873
7124
|
};
|
|
6874
7125
|
};
|
|
6875
7126
|
/**
|
|
@@ -6890,7 +7141,7 @@ interface components$d {
|
|
|
6890
7141
|
ComponentOverridability: {
|
|
6891
7142
|
/** @description Defines component parameter value overrides. Keys are the parameter public ID */
|
|
6892
7143
|
parameters?: {
|
|
6893
|
-
[key: string]: components$
|
|
7144
|
+
[key: string]: components$c["schemas"]["OverrideOptions"];
|
|
6894
7145
|
};
|
|
6895
7146
|
/** @description Allows overriding a display variant is allowed if it is defined on the component the pattern is derived from. Default = false */
|
|
6896
7147
|
variants?: boolean;
|
|
@@ -6906,15 +7157,15 @@ interface components$d {
|
|
|
6906
7157
|
type: string;
|
|
6907
7158
|
/** @description Component parameter values for the component instance */
|
|
6908
7159
|
parameters?: {
|
|
6909
|
-
[key: string]: components$
|
|
7160
|
+
[key: string]: components$c["schemas"]["ComponentParameter"];
|
|
6910
7161
|
};
|
|
6911
7162
|
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
|
6912
7163
|
variant?: string;
|
|
6913
7164
|
/** @description Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated */
|
|
6914
|
-
projectMapNodes?: components$
|
|
7165
|
+
projectMapNodes?: components$c["schemas"]["CompositionProjectMapNodeInfo"][];
|
|
6915
7166
|
/** @description Slots containing any child components */
|
|
6916
7167
|
slots?: {
|
|
6917
|
-
[key: string]: components$
|
|
7168
|
+
[key: string]: components$c["schemas"]["ComponentInstance"][];
|
|
6918
7169
|
};
|
|
6919
7170
|
/** @description The ID of the composition */
|
|
6920
7171
|
_id: string;
|
|
@@ -6936,10 +7187,10 @@ interface components$d {
|
|
|
6936
7187
|
* Means nothing for PUTs; it will be ignored
|
|
6937
7188
|
* */
|
|
6938
7189
|
_patternDataResources?: {
|
|
6939
|
-
[key: string]: components$
|
|
7190
|
+
[key: string]: components$c["schemas"]["DataResourceDefinition"];
|
|
6940
7191
|
};
|
|
6941
|
-
_dataResources?: components$
|
|
6942
|
-
_patternError?: components$
|
|
7192
|
+
_dataResources?: components$c["schemas"]["DataResourceDefinitions"];
|
|
7193
|
+
_patternError?: components$c["schemas"]["PatternError"];
|
|
6943
7194
|
/** @description Defines patch overrides to component IDs that live in the composition.
|
|
6944
7195
|
* This can be used to override parameters that are defined on patterns,
|
|
6945
7196
|
* including nested patterns, with values that are specific to this composition.
|
|
@@ -6952,13 +7203,13 @@ interface components$d {
|
|
|
6952
7203
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
6953
7204
|
* */
|
|
6954
7205
|
_overrides?: {
|
|
6955
|
-
[key: string]: components$
|
|
7206
|
+
[key: string]: components$c["schemas"]["ComponentOverride"];
|
|
6956
7207
|
};
|
|
6957
7208
|
/** @description Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
|
|
6958
7209
|
* Means nothing for PUTs; it will be ignored
|
|
6959
7210
|
* */
|
|
6960
7211
|
_patternOverrides?: {
|
|
6961
|
-
[key: string]: components$
|
|
7212
|
+
[key: string]: components$c["schemas"]["ComponentOverride"];
|
|
6962
7213
|
};
|
|
6963
7214
|
/** @description When used on a pattern, defines how the pattern's parameters may be overridden
|
|
6964
7215
|
* by consumers of the pattern.
|
|
@@ -6966,7 +7217,7 @@ interface components$d {
|
|
|
6966
7217
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
6967
7218
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
6968
7219
|
* */
|
|
6969
|
-
_overridability?: components$
|
|
7220
|
+
_overridability?: components$c["schemas"]["ComponentOverridability"];
|
|
6970
7221
|
/** @description Array of locales which have data defined on the composition. If empty, the current default locale implicitly has data */
|
|
6971
7222
|
_locales?: string[];
|
|
6972
7223
|
};
|
|
@@ -6997,7 +7248,7 @@ interface components$d {
|
|
|
6997
7248
|
* NOTE: Users without membership in any role listed here will be unable to execute the transition unless they are team admins
|
|
6998
7249
|
* */
|
|
6999
7250
|
permissions: {
|
|
7000
|
-
[key: string]: components$
|
|
7251
|
+
[key: string]: components$c["schemas"]["WorkflowStageTransitionPermission"];
|
|
7001
7252
|
};
|
|
7002
7253
|
};
|
|
7003
7254
|
/** @description Definition of a stage in a workflow */
|
|
@@ -7010,7 +7261,7 @@ interface components$d {
|
|
|
7010
7261
|
* listed here, the stage is read-only and publishing is disabled
|
|
7011
7262
|
* */
|
|
7012
7263
|
permissions: {
|
|
7013
|
-
[key: string]: components$
|
|
7264
|
+
[key: string]: components$c["schemas"]["WorkflowStagePermission"];
|
|
7014
7265
|
};
|
|
7015
7266
|
/** @description When true, transitioning into this stage from a different stage will automatically publish the entity.
|
|
7016
7267
|
* If the user making the transition does not have publish permissions to the stage as well as publish permission on the entity, the action will not run.
|
|
@@ -7027,7 +7278,7 @@ interface components$d {
|
|
|
7027
7278
|
* Every stage must define at least one transition, to avoid creating a workflow that
|
|
7028
7279
|
* has a stage that can never be escaped
|
|
7029
7280
|
* */
|
|
7030
|
-
transitions: components$
|
|
7281
|
+
transitions: components$c["schemas"]["WorkflowStageTransition"][];
|
|
7031
7282
|
/**
|
|
7032
7283
|
* @description Icon name for the stage (e.g. 'chevron-double-right-o')
|
|
7033
7284
|
* @default chevron-double-right-o
|
|
@@ -7052,7 +7303,7 @@ interface components$d {
|
|
|
7052
7303
|
initialStage: string;
|
|
7053
7304
|
/** @description All stages of the workflow */
|
|
7054
7305
|
stages: {
|
|
7055
|
-
[key: string]: components$
|
|
7306
|
+
[key: string]: components$c["schemas"]["WorkflowStage"];
|
|
7056
7307
|
};
|
|
7057
7308
|
/** @description Last modified ISO date string for this definition (ignored for writes) */
|
|
7058
7309
|
modified?: string;
|
|
@@ -7081,7 +7332,7 @@ interface components$d {
|
|
|
7081
7332
|
[name: string]: unknown;
|
|
7082
7333
|
};
|
|
7083
7334
|
content: {
|
|
7084
|
-
"application/json": components$
|
|
7335
|
+
"application/json": components$c["schemas"]["Error"];
|
|
7085
7336
|
};
|
|
7086
7337
|
};
|
|
7087
7338
|
/** @description API key or token was not valid */
|
|
@@ -7090,7 +7341,7 @@ interface components$d {
|
|
|
7090
7341
|
[name: string]: unknown;
|
|
7091
7342
|
};
|
|
7092
7343
|
content: {
|
|
7093
|
-
"application/json": components$
|
|
7344
|
+
"application/json": components$c["schemas"]["Error"];
|
|
7094
7345
|
};
|
|
7095
7346
|
};
|
|
7096
7347
|
/** @description Permission was denied */
|
|
@@ -7099,7 +7350,7 @@ interface components$d {
|
|
|
7099
7350
|
[name: string]: unknown;
|
|
7100
7351
|
};
|
|
7101
7352
|
content: {
|
|
7102
|
-
"application/json": components$
|
|
7353
|
+
"application/json": components$c["schemas"]["Error"];
|
|
7103
7354
|
};
|
|
7104
7355
|
};
|
|
7105
7356
|
/** @description Too many requests in allowed time period */
|
|
@@ -7323,7 +7574,7 @@ interface components$d {
|
|
|
7323
7574
|
pathItems: never;
|
|
7324
7575
|
}
|
|
7325
7576
|
|
|
7326
|
-
interface paths$
|
|
7577
|
+
interface paths$a {
|
|
7327
7578
|
"/api/v1/canvas-history": {
|
|
7328
7579
|
parameters: {
|
|
7329
7580
|
query?: never;
|
|
@@ -7361,12 +7612,12 @@ interface paths$b {
|
|
|
7361
7612
|
[name: string]: unknown;
|
|
7362
7613
|
};
|
|
7363
7614
|
content: {
|
|
7364
|
-
"application/json": components$
|
|
7615
|
+
"application/json": components$b["schemas"]["HistoryApiResponse"];
|
|
7365
7616
|
};
|
|
7366
7617
|
};
|
|
7367
|
-
400: components$
|
|
7368
|
-
401: components$
|
|
7369
|
-
403: components$
|
|
7618
|
+
400: components$b["responses"]["BadRequestError"];
|
|
7619
|
+
401: components$b["responses"]["UnauthorizedError"];
|
|
7620
|
+
403: components$b["responses"]["ForbiddenError"];
|
|
7370
7621
|
/** @description Composition not found */
|
|
7371
7622
|
404: {
|
|
7372
7623
|
headers: {
|
|
@@ -7376,8 +7627,8 @@ interface paths$b {
|
|
|
7376
7627
|
"text/plain": string;
|
|
7377
7628
|
};
|
|
7378
7629
|
};
|
|
7379
|
-
429: components$
|
|
7380
|
-
500: components$
|
|
7630
|
+
429: components$b["responses"]["RateLimitError"];
|
|
7631
|
+
500: components$b["responses"]["InternalServerError"];
|
|
7381
7632
|
};
|
|
7382
7633
|
};
|
|
7383
7634
|
put?: never;
|
|
@@ -7389,7 +7640,7 @@ interface paths$b {
|
|
|
7389
7640
|
trace?: never;
|
|
7390
7641
|
};
|
|
7391
7642
|
}
|
|
7392
|
-
interface components$
|
|
7643
|
+
interface components$b {
|
|
7393
7644
|
schemas: {
|
|
7394
7645
|
HistoryEntry: {
|
|
7395
7646
|
/** @description The version ID of the entity. This can be used to fetch the version's data via the entity API */
|
|
@@ -7410,7 +7661,7 @@ interface components$c {
|
|
|
7410
7661
|
/** @description If more history is available than your plan allows, and additional entries are available by upgrading, this will be true */
|
|
7411
7662
|
truncated?: boolean;
|
|
7412
7663
|
/** @description Version history entries */
|
|
7413
|
-
results?: components$
|
|
7664
|
+
results?: components$b["schemas"]["HistoryEntry"][];
|
|
7414
7665
|
};
|
|
7415
7666
|
Error: {
|
|
7416
7667
|
/** @description Error message(s) that occurred while processing the request */
|
|
@@ -7424,7 +7675,7 @@ interface components$c {
|
|
|
7424
7675
|
[name: string]: unknown;
|
|
7425
7676
|
};
|
|
7426
7677
|
content: {
|
|
7427
|
-
"application/json": components$
|
|
7678
|
+
"application/json": components$b["schemas"]["Error"];
|
|
7428
7679
|
};
|
|
7429
7680
|
};
|
|
7430
7681
|
/** @description API key or token was not valid */
|
|
@@ -7433,7 +7684,7 @@ interface components$c {
|
|
|
7433
7684
|
[name: string]: unknown;
|
|
7434
7685
|
};
|
|
7435
7686
|
content: {
|
|
7436
|
-
"application/json": components$
|
|
7687
|
+
"application/json": components$b["schemas"]["Error"];
|
|
7437
7688
|
};
|
|
7438
7689
|
};
|
|
7439
7690
|
/** @description Permission was denied */
|
|
@@ -7442,7 +7693,7 @@ interface components$c {
|
|
|
7442
7693
|
[name: string]: unknown;
|
|
7443
7694
|
};
|
|
7444
7695
|
content: {
|
|
7445
|
-
"application/json": components$
|
|
7696
|
+
"application/json": components$b["schemas"]["Error"];
|
|
7446
7697
|
};
|
|
7447
7698
|
};
|
|
7448
7699
|
/** @description Too many requests in allowed time period */
|
|
@@ -7466,41 +7717,41 @@ interface components$c {
|
|
|
7466
7717
|
pathItems: never;
|
|
7467
7718
|
}
|
|
7468
7719
|
|
|
7469
|
-
interface components$
|
|
7720
|
+
interface components$a {
|
|
7470
7721
|
schemas: {
|
|
7471
|
-
CompositionResolvedGetResponse: components$
|
|
7722
|
+
CompositionResolvedGetResponse: components$a["schemas"]["EdgehancersResolutionInfo"] & components$a["schemas"]["CompositionApiResponse"];
|
|
7472
7723
|
CompositionResolvedListResponse: {
|
|
7473
|
-
diagnostics?: components$
|
|
7724
|
+
diagnostics?: components$a["schemas"]["EdgehancersDiagnostics"] & {
|
|
7474
7725
|
data?: {
|
|
7475
|
-
[key: string]: components$
|
|
7726
|
+
[key: string]: components$a["schemas"]["DataDiagnostic"][];
|
|
7476
7727
|
};
|
|
7477
7728
|
};
|
|
7478
7729
|
errors?: {
|
|
7479
|
-
[key: string]: components$
|
|
7730
|
+
[key: string]: components$a["schemas"]["DataResolutionIssue"][];
|
|
7480
7731
|
};
|
|
7481
7732
|
warnings?: {
|
|
7482
|
-
[key: string]: components$
|
|
7733
|
+
[key: string]: components$a["schemas"]["DataResolutionIssue"][];
|
|
7483
7734
|
};
|
|
7484
7735
|
infos?: {
|
|
7485
|
-
[key: string]: components$
|
|
7736
|
+
[key: string]: components$a["schemas"]["DataResolutionIssue"][];
|
|
7486
7737
|
};
|
|
7487
|
-
} & components$
|
|
7738
|
+
} & components$a["schemas"]["CompositionListResponse"];
|
|
7488
7739
|
EntryResolvedListResponse: {
|
|
7489
|
-
diagnostics?: components$
|
|
7740
|
+
diagnostics?: components$a["schemas"]["EdgehancersDiagnostics"] & {
|
|
7490
7741
|
data?: {
|
|
7491
|
-
[key: string]: components$
|
|
7742
|
+
[key: string]: components$a["schemas"]["DataDiagnostic"][];
|
|
7492
7743
|
};
|
|
7493
7744
|
};
|
|
7494
7745
|
errors?: {
|
|
7495
|
-
[key: string]: components$
|
|
7746
|
+
[key: string]: components$a["schemas"]["DataResolutionIssue"][];
|
|
7496
7747
|
};
|
|
7497
7748
|
warnings?: {
|
|
7498
|
-
[key: string]: components$
|
|
7749
|
+
[key: string]: components$a["schemas"]["DataResolutionIssue"][];
|
|
7499
7750
|
};
|
|
7500
7751
|
infos?: {
|
|
7501
|
-
[key: string]: components$
|
|
7752
|
+
[key: string]: components$a["schemas"]["DataResolutionIssue"][];
|
|
7502
7753
|
};
|
|
7503
|
-
} & components$
|
|
7754
|
+
} & components$a["schemas"]["EntryListResponse"];
|
|
7504
7755
|
EdgehancersResolutionInfo: {
|
|
7505
7756
|
wholeResponseCacheDiagnostics?: {
|
|
7506
7757
|
info: string;
|
|
@@ -7509,19 +7760,19 @@ interface components$b {
|
|
|
7509
7760
|
edgeLocation?: string;
|
|
7510
7761
|
requestId: string;
|
|
7511
7762
|
};
|
|
7512
|
-
diagnostics?: components$
|
|
7513
|
-
data?: components$
|
|
7763
|
+
diagnostics?: components$a["schemas"]["EdgehancersDiagnostics"] & {
|
|
7764
|
+
data?: components$a["schemas"]["DataDiagnostic"][];
|
|
7514
7765
|
};
|
|
7515
|
-
errors?: components$
|
|
7516
|
-
warnings?: components$
|
|
7517
|
-
infos?: components$
|
|
7766
|
+
errors?: components$a["schemas"]["DataResolutionIssue"][];
|
|
7767
|
+
warnings?: components$a["schemas"]["DataResolutionIssue"][];
|
|
7768
|
+
infos?: components$a["schemas"]["DataResolutionIssue"][];
|
|
7518
7769
|
};
|
|
7519
7770
|
EdgehancersError: {
|
|
7520
7771
|
message: string;
|
|
7521
7772
|
status: number;
|
|
7522
7773
|
statusText: string;
|
|
7523
7774
|
};
|
|
7524
|
-
UniformError: components$
|
|
7775
|
+
UniformError: components$a["schemas"]["EdgehancersError"] | components$a["schemas"]["Error"];
|
|
7525
7776
|
InvalidationPayload: {
|
|
7526
7777
|
/** @description List of variables with values to invalidate */
|
|
7527
7778
|
variables?: {
|
|
@@ -7535,7 +7786,7 @@ interface components$b {
|
|
|
7535
7786
|
dataTypeId: string;
|
|
7536
7787
|
/** Format: uuid */
|
|
7537
7788
|
purgeKey: string;
|
|
7538
|
-
conditions?: components$
|
|
7789
|
+
conditions?: components$a["schemas"]["InvalidationPayload"];
|
|
7539
7790
|
}[];
|
|
7540
7791
|
DataDiagnostic: {
|
|
7541
7792
|
componentPath: string;
|
|
@@ -7591,7 +7842,7 @@ interface components$b {
|
|
|
7591
7842
|
message: string;
|
|
7592
7843
|
type: string;
|
|
7593
7844
|
parameterName?: string;
|
|
7594
|
-
expression?: components$
|
|
7845
|
+
expression?: components$a["schemas"]["DataElementConnectionDefinition"];
|
|
7595
7846
|
dataName?: string;
|
|
7596
7847
|
dataType?: string;
|
|
7597
7848
|
inputName?: string;
|
|
@@ -7665,12 +7916,12 @@ interface components$b {
|
|
|
7665
7916
|
* @enum {string}
|
|
7666
7917
|
*/
|
|
7667
7918
|
op?: "&" | "|";
|
|
7668
|
-
clauses: (components$
|
|
7919
|
+
clauses: (components$a["schemas"]["VisibilityCriteria"] | components$a["schemas"]["VisibilityCriteriaGroup"])[];
|
|
7669
7920
|
};
|
|
7670
7921
|
/** @description Defines a conditional value for a component parameter
|
|
7671
7922
|
* */
|
|
7672
7923
|
ComponentParameterConditionalValue: {
|
|
7673
|
-
when: components$
|
|
7924
|
+
when: components$a["schemas"]["VisibilityCriteriaGroup"];
|
|
7674
7925
|
/** @description The value of the parameter. Any JSON-serializable value is acceptable.
|
|
7675
7926
|
* A value of `null` will cause the parameter value to be removed, if it matches.
|
|
7676
7927
|
* */
|
|
@@ -7689,7 +7940,7 @@ interface components$b {
|
|
|
7689
7940
|
*
|
|
7690
7941
|
* When no locale is passed to a non-route API, conditions are not processed and all conditions are returned.
|
|
7691
7942
|
* */
|
|
7692
|
-
ComponentParameterConditions: components$
|
|
7943
|
+
ComponentParameterConditions: components$a["schemas"]["ComponentParameterConditionalValue"][];
|
|
7693
7944
|
/** @description Defines an editable parameter on a component */
|
|
7694
7945
|
ComponentParameter: {
|
|
7695
7946
|
/** @description The value of the parameter. Any JSON-serializable value is acceptable */
|
|
@@ -7697,18 +7948,18 @@ interface components$b {
|
|
|
7697
7948
|
/** @description The type of the parameter. Determines how it is displayed when editing and tells the consumer how to process it */
|
|
7698
7949
|
type: string;
|
|
7699
7950
|
/** @deprecated */
|
|
7700
|
-
connectedData?: components$
|
|
7951
|
+
connectedData?: components$a["schemas"]["DataElementConnectionDefinition"];
|
|
7701
7952
|
/** @description Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
|
|
7702
7953
|
* Note that locales must be registered on the entry/composition `_locales` before being used
|
|
7703
7954
|
* */
|
|
7704
7955
|
locales?: {
|
|
7705
7956
|
[key: string]: unknown;
|
|
7706
7957
|
};
|
|
7707
|
-
conditions?: components$
|
|
7958
|
+
conditions?: components$a["schemas"]["ComponentParameterConditions"];
|
|
7708
7959
|
/** @description Locale-specific conditional values for this parameter. Keys are locale codes, and values are the `conditions` for that locale.
|
|
7709
7960
|
* */
|
|
7710
7961
|
localesConditions?: {
|
|
7711
|
-
[key: string]: components$
|
|
7962
|
+
[key: string]: components$a["schemas"]["ComponentParameterConditions"];
|
|
7712
7963
|
};
|
|
7713
7964
|
};
|
|
7714
7965
|
ProjectMapNodeAllowedQueryString: {
|
|
@@ -7737,7 +7988,7 @@ interface components$b {
|
|
|
7737
7988
|
/** @description 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 */
|
|
7738
7989
|
isSearchHit?: boolean;
|
|
7739
7990
|
/** @description Query strings that are allowed to be passed to the node */
|
|
7740
|
-
queryStrings?: components$
|
|
7991
|
+
queryStrings?: components$a["schemas"]["ProjectMapNodeAllowedQueryString"][];
|
|
7741
7992
|
/** @description For dynamic nodes, this is the preview value for the dynamic value.
|
|
7742
7993
|
* The preview value is used when editing a connected composition, and is the default
|
|
7743
7994
|
* dynamic node value unless the author has explicitly chosen a different value
|
|
@@ -7760,7 +8011,7 @@ interface components$b {
|
|
|
7760
8011
|
* @description Unique identifier for the project map that this node belongs to
|
|
7761
8012
|
*/
|
|
7762
8013
|
projectMapId: string;
|
|
7763
|
-
data?: components$
|
|
8014
|
+
data?: components$a["schemas"]["ProjectMapNodeData"];
|
|
7764
8015
|
/** @description Locale-specific paths of the project map node.
|
|
7765
8016
|
* Keys are locale codes
|
|
7766
8017
|
* */
|
|
@@ -7780,13 +8031,13 @@ interface components$b {
|
|
|
7780
8031
|
type: string;
|
|
7781
8032
|
/** @description Component parameter values for the component instance */
|
|
7782
8033
|
parameters?: {
|
|
7783
|
-
[key: string]: components$
|
|
8034
|
+
[key: string]: components$a["schemas"]["ComponentParameter"];
|
|
7784
8035
|
};
|
|
7785
8036
|
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
|
7786
8037
|
variant?: string;
|
|
7787
8038
|
/** @description Slots containing any child components */
|
|
7788
8039
|
slots?: {
|
|
7789
|
-
[key: string]: components$
|
|
8040
|
+
[key: string]: components$a["schemas"]["ComponentInstance"][];
|
|
7790
8041
|
};
|
|
7791
8042
|
/** @description Unique identifier of the component within the composition.
|
|
7792
8043
|
* No assumptions should be made about the format of this value other than "it will be unique."
|
|
@@ -7796,14 +8047,14 @@ interface components$b {
|
|
|
7796
8047
|
_id?: string;
|
|
7797
8048
|
/** @description Indicates this component instance should be sourced from a pattern library pattern */
|
|
7798
8049
|
_pattern?: string;
|
|
7799
|
-
_dataResources?: components$
|
|
8050
|
+
_dataResources?: components$a["schemas"]["DataResourceDefinitions"];
|
|
7800
8051
|
/** @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
|
7801
8052
|
* Means nothing for PUTs; it will be ignored
|
|
7802
8053
|
* */
|
|
7803
8054
|
_patternDataResources?: {
|
|
7804
|
-
[key: string]: components$
|
|
8055
|
+
[key: string]: components$a["schemas"]["DataResourceDefinition"];
|
|
7805
8056
|
};
|
|
7806
|
-
_patternError?: components$
|
|
8057
|
+
_patternError?: components$a["schemas"]["PatternError"];
|
|
7807
8058
|
/** @description Defines patch overrides to component IDs that live in the composition.
|
|
7808
8059
|
* This can be used to override parameters that are defined on patterns,
|
|
7809
8060
|
* including nested patterns, with values that are specific to this composition.
|
|
@@ -7816,13 +8067,13 @@ interface components$b {
|
|
|
7816
8067
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
7817
8068
|
* */
|
|
7818
8069
|
_overrides?: {
|
|
7819
|
-
[key: string]: components$
|
|
8070
|
+
[key: string]: components$a["schemas"]["ComponentOverride"];
|
|
7820
8071
|
};
|
|
7821
8072
|
/** @description Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
|
|
7822
8073
|
* Means nothing for PUTs; it will be ignored
|
|
7823
8074
|
* */
|
|
7824
8075
|
_patternOverrides?: {
|
|
7825
|
-
[key: string]: components$
|
|
8076
|
+
[key: string]: components$a["schemas"]["ComponentOverride"];
|
|
7826
8077
|
};
|
|
7827
8078
|
/** @description When used on a pattern, defines how the pattern's parameters may be overridden
|
|
7828
8079
|
* by consumers of the pattern.
|
|
@@ -7830,7 +8081,7 @@ interface components$b {
|
|
|
7830
8081
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
7831
8082
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
7832
8083
|
* */
|
|
7833
|
-
_overridability?: components$
|
|
8084
|
+
_overridability?: components$a["schemas"]["ComponentOverridability"];
|
|
7834
8085
|
/** @description Array of locales that have data defined. Only set for pattern references or composition defaults */
|
|
7835
8086
|
_locales?: string[];
|
|
7836
8087
|
};
|
|
@@ -7853,13 +8104,13 @@ interface components$b {
|
|
|
7853
8104
|
* If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
|
|
7854
8105
|
* */
|
|
7855
8106
|
optionalPatternParameter?: boolean;
|
|
7856
|
-
variables?: components$
|
|
8107
|
+
variables?: components$a["schemas"]["DataResourceVariables"];
|
|
7857
8108
|
};
|
|
7858
8109
|
/** @description Data definitions attached to this component. The property name is the key of the data in the data document.
|
|
7859
8110
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key)
|
|
7860
8111
|
* */
|
|
7861
8112
|
DataResourceDefinitions: {
|
|
7862
|
-
[key: string]: components$
|
|
8113
|
+
[key: string]: components$a["schemas"]["DataResourceDefinition"];
|
|
7863
8114
|
};
|
|
7864
8115
|
/**
|
|
7865
8116
|
* @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
|
@@ -7877,10 +8128,10 @@ interface components$b {
|
|
|
7877
8128
|
* */
|
|
7878
8129
|
ComponentOverride: {
|
|
7879
8130
|
parameters?: {
|
|
7880
|
-
[key: string]: components$
|
|
8131
|
+
[key: string]: components$a["schemas"]["ComponentParameter"];
|
|
7881
8132
|
};
|
|
7882
8133
|
slots?: {
|
|
7883
|
-
[key: string]: components$
|
|
8134
|
+
[key: string]: components$a["schemas"]["ComponentInstance"][];
|
|
7884
8135
|
};
|
|
7885
8136
|
variant?: string;
|
|
7886
8137
|
/** @description Overrides data resource definitions for a pattern component.
|
|
@@ -7888,7 +8139,7 @@ interface components$b {
|
|
|
7888
8139
|
* Overrides defined here replace values in either _dataResources or _patternDataResources on the target component.
|
|
7889
8140
|
* */
|
|
7890
8141
|
dataResources?: {
|
|
7891
|
-
[key: string]: components$
|
|
8142
|
+
[key: string]: components$a["schemas"]["DataResourceDefinition"];
|
|
7892
8143
|
};
|
|
7893
8144
|
};
|
|
7894
8145
|
/**
|
|
@@ -7909,7 +8160,7 @@ interface components$b {
|
|
|
7909
8160
|
ComponentOverridability: {
|
|
7910
8161
|
/** @description Defines component parameter value overrides. Keys are the parameter public ID */
|
|
7911
8162
|
parameters?: {
|
|
7912
|
-
[key: string]: components$
|
|
8163
|
+
[key: string]: components$a["schemas"]["OverrideOptions"];
|
|
7913
8164
|
};
|
|
7914
8165
|
/** @description Allows overriding a display variant is allowed if it is defined on the component the pattern is derived from. Default = false */
|
|
7915
8166
|
variants?: boolean;
|
|
@@ -7925,15 +8176,15 @@ interface components$b {
|
|
|
7925
8176
|
type: string;
|
|
7926
8177
|
/** @description Component parameter values for the component instance */
|
|
7927
8178
|
parameters?: {
|
|
7928
|
-
[key: string]: components$
|
|
8179
|
+
[key: string]: components$a["schemas"]["ComponentParameter"];
|
|
7929
8180
|
};
|
|
7930
8181
|
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
|
7931
8182
|
variant?: string;
|
|
7932
8183
|
/** @description Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated */
|
|
7933
|
-
projectMapNodes?: components$
|
|
8184
|
+
projectMapNodes?: components$a["schemas"]["CompositionProjectMapNodeInfo"][];
|
|
7934
8185
|
/** @description Slots containing any child components */
|
|
7935
8186
|
slots?: {
|
|
7936
|
-
[key: string]: components$
|
|
8187
|
+
[key: string]: components$a["schemas"]["ComponentInstance"][];
|
|
7937
8188
|
};
|
|
7938
8189
|
/** @description The ID of the composition */
|
|
7939
8190
|
_id: string;
|
|
@@ -7955,10 +8206,10 @@ interface components$b {
|
|
|
7955
8206
|
* Means nothing for PUTs; it will be ignored
|
|
7956
8207
|
* */
|
|
7957
8208
|
_patternDataResources?: {
|
|
7958
|
-
[key: string]: components$
|
|
8209
|
+
[key: string]: components$a["schemas"]["DataResourceDefinition"];
|
|
7959
8210
|
};
|
|
7960
|
-
_dataResources?: components$
|
|
7961
|
-
_patternError?: components$
|
|
8211
|
+
_dataResources?: components$a["schemas"]["DataResourceDefinitions"];
|
|
8212
|
+
_patternError?: components$a["schemas"]["PatternError"];
|
|
7962
8213
|
/** @description Defines patch overrides to component IDs that live in the composition.
|
|
7963
8214
|
* This can be used to override parameters that are defined on patterns,
|
|
7964
8215
|
* including nested patterns, with values that are specific to this composition.
|
|
@@ -7971,13 +8222,13 @@ interface components$b {
|
|
|
7971
8222
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
7972
8223
|
* */
|
|
7973
8224
|
_overrides?: {
|
|
7974
|
-
[key: string]: components$
|
|
8225
|
+
[key: string]: components$a["schemas"]["ComponentOverride"];
|
|
7975
8226
|
};
|
|
7976
8227
|
/** @description Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
|
|
7977
8228
|
* Means nothing for PUTs; it will be ignored
|
|
7978
8229
|
* */
|
|
7979
8230
|
_patternOverrides?: {
|
|
7980
|
-
[key: string]: components$
|
|
8231
|
+
[key: string]: components$a["schemas"]["ComponentOverride"];
|
|
7981
8232
|
};
|
|
7982
8233
|
/** @description When used on a pattern, defines how the pattern's parameters may be overridden
|
|
7983
8234
|
* by consumers of the pattern.
|
|
@@ -7985,7 +8236,7 @@ interface components$b {
|
|
|
7985
8236
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
7986
8237
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
7987
8238
|
* */
|
|
7988
|
-
_overridability?: components$
|
|
8239
|
+
_overridability?: components$a["schemas"]["ComponentOverridability"];
|
|
7989
8240
|
/** @description Array of locales which have data defined on the composition. If empty, the current default locale implicitly has data */
|
|
7990
8241
|
_locales?: string[];
|
|
7991
8242
|
};
|
|
@@ -8016,7 +8267,7 @@ interface components$b {
|
|
|
8016
8267
|
* NOTE: Users without membership in any role listed here will be unable to execute the transition unless they are team admins
|
|
8017
8268
|
* */
|
|
8018
8269
|
permissions: {
|
|
8019
|
-
[key: string]: components$
|
|
8270
|
+
[key: string]: components$a["schemas"]["WorkflowStageTransitionPermission"];
|
|
8020
8271
|
};
|
|
8021
8272
|
};
|
|
8022
8273
|
/** @description Definition of a stage in a workflow */
|
|
@@ -8029,7 +8280,7 @@ interface components$b {
|
|
|
8029
8280
|
* listed here, the stage is read-only and publishing is disabled
|
|
8030
8281
|
* */
|
|
8031
8282
|
permissions: {
|
|
8032
|
-
[key: string]: components$
|
|
8283
|
+
[key: string]: components$a["schemas"]["WorkflowStagePermission"];
|
|
8033
8284
|
};
|
|
8034
8285
|
/** @description When true, transitioning into this stage from a different stage will automatically publish the entity.
|
|
8035
8286
|
* If the user making the transition does not have publish permissions to the stage as well as publish permission on the entity, the action will not run.
|
|
@@ -8046,7 +8297,7 @@ interface components$b {
|
|
|
8046
8297
|
* Every stage must define at least one transition, to avoid creating a workflow that
|
|
8047
8298
|
* has a stage that can never be escaped
|
|
8048
8299
|
* */
|
|
8049
|
-
transitions: components$
|
|
8300
|
+
transitions: components$a["schemas"]["WorkflowStageTransition"][];
|
|
8050
8301
|
/**
|
|
8051
8302
|
* @description Icon name for the stage (e.g. 'chevron-double-right-o')
|
|
8052
8303
|
* @default chevron-double-right-o
|
|
@@ -8071,7 +8322,7 @@ interface components$b {
|
|
|
8071
8322
|
initialStage: string;
|
|
8072
8323
|
/** @description All stages of the workflow */
|
|
8073
8324
|
stages: {
|
|
8074
|
-
[key: string]: components$
|
|
8325
|
+
[key: string]: components$a["schemas"]["WorkflowStage"];
|
|
8075
8326
|
};
|
|
8076
8327
|
/** @description Last modified ISO date string for this definition (ignored for writes) */
|
|
8077
8328
|
modified?: string;
|
|
@@ -8137,7 +8388,7 @@ interface components$b {
|
|
|
8137
8388
|
* @description The release this composition belongs to. If not set, it belongs to the base
|
|
8138
8389
|
*/
|
|
8139
8390
|
releaseId?: string;
|
|
8140
|
-
composition: components$
|
|
8391
|
+
composition: components$a["schemas"]["RootComponentInstance"];
|
|
8141
8392
|
/**
|
|
8142
8393
|
* Format: uuid
|
|
8143
8394
|
* @description The workflow ID assigned to this composition, if any. Normally comes from the component definition
|
|
@@ -8149,7 +8400,7 @@ interface components$b {
|
|
|
8149
8400
|
*/
|
|
8150
8401
|
workflowStageId?: string;
|
|
8151
8402
|
/** @description The full definition of the assigned workflow, if any, including stages, permissions, etc. Returned only when `withWorkflowDefinition` is true */
|
|
8152
|
-
workflowDefinition?: components$
|
|
8403
|
+
workflowDefinition?: components$a["schemas"]["WorkflowDefinition"];
|
|
8153
8404
|
/**
|
|
8154
8405
|
* Format: uuid
|
|
8155
8406
|
* @description The edition ID. When set, this is a child edition of the composition in _id.
|
|
@@ -8166,7 +8417,7 @@ interface components$b {
|
|
|
8166
8417
|
editionPriority?: number;
|
|
8167
8418
|
};
|
|
8168
8419
|
CompositionListResponse: {
|
|
8169
|
-
compositions: components$
|
|
8420
|
+
compositions: components$a["schemas"]["CompositionApiResponse"][];
|
|
8170
8421
|
/** @description Total number of compositions that match the query. Present only when `withTotalCount` option is true */
|
|
8171
8422
|
totalCount?: number;
|
|
8172
8423
|
/** @description Per-field counts for distinct values */
|
|
@@ -8228,10 +8479,10 @@ interface components$b {
|
|
|
8228
8479
|
RouteResponseRedirect: {
|
|
8229
8480
|
/** @description The route that was matched in the redirects */
|
|
8230
8481
|
matchedRoute: string;
|
|
8231
|
-
dynamicInputs?: components$
|
|
8482
|
+
dynamicInputs?: components$a["schemas"]["RouteDynamicInputs"];
|
|
8232
8483
|
/** @enum {string} */
|
|
8233
8484
|
type: "redirect";
|
|
8234
|
-
redirect: components$
|
|
8485
|
+
redirect: components$a["schemas"]["Redirect"];
|
|
8235
8486
|
};
|
|
8236
8487
|
/** @description The route does not match any configured redirections or compositions.
|
|
8237
8488
|
* NOTE: This response differs from a HTTP 404, which indicates that the project map or project ID was not found.
|
|
@@ -8270,14 +8521,14 @@ interface components$b {
|
|
|
8270
8521
|
_locales?: string[];
|
|
8271
8522
|
/** @description Entry field values */
|
|
8272
8523
|
fields?: {
|
|
8273
|
-
[key: string]: components$
|
|
8524
|
+
[key: string]: components$a["schemas"]["ComponentParameter"];
|
|
8274
8525
|
};
|
|
8275
|
-
_dataResources?: components$
|
|
8526
|
+
_dataResources?: components$a["schemas"]["DataResourceDefinitions"];
|
|
8276
8527
|
/** @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
|
8277
8528
|
* Means nothing for PUTs; it will be ignored
|
|
8278
8529
|
* */
|
|
8279
8530
|
_patternDataResources?: {
|
|
8280
|
-
[key: string]: components$
|
|
8531
|
+
[key: string]: components$a["schemas"]["DataResourceDefinition"];
|
|
8281
8532
|
};
|
|
8282
8533
|
/**
|
|
8283
8534
|
* @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
|
@@ -8300,7 +8551,7 @@ interface components$b {
|
|
|
8300
8551
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
8301
8552
|
* */
|
|
8302
8553
|
_overrides?: {
|
|
8303
|
-
[key: string]: components$
|
|
8554
|
+
[key: string]: components$a["schemas"]["ComponentOverride"];
|
|
8304
8555
|
};
|
|
8305
8556
|
/** @description When used on a pattern, defines how the pattern's parameters may be overridden
|
|
8306
8557
|
* by consumers of the pattern.
|
|
@@ -8308,7 +8559,7 @@ interface components$b {
|
|
|
8308
8559
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
8309
8560
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
8310
8561
|
* */
|
|
8311
|
-
_overridability?: components$
|
|
8562
|
+
_overridability?: components$a["schemas"]["ComponentOverridability"];
|
|
8312
8563
|
};
|
|
8313
8564
|
EntryApiResponse: {
|
|
8314
8565
|
/** @description Publishing state to fetch. 0 = draft, 64 = published */
|
|
@@ -8344,7 +8595,7 @@ interface components$b {
|
|
|
8344
8595
|
* @default false
|
|
8345
8596
|
*/
|
|
8346
8597
|
pattern?: boolean;
|
|
8347
|
-
entry: components$
|
|
8598
|
+
entry: components$a["schemas"]["Entry"];
|
|
8348
8599
|
/**
|
|
8349
8600
|
* Format: uuid
|
|
8350
8601
|
* @description The workflow ID that this entry is assigned. Normally comes from the content type
|
|
@@ -8356,7 +8607,7 @@ interface components$b {
|
|
|
8356
8607
|
*/
|
|
8357
8608
|
workflowStageId?: string;
|
|
8358
8609
|
/** @description The full definition of the assigned workflow, if any, including stages, permissions, etc. Only returned when `withWorkflowDefinition` is true */
|
|
8359
|
-
workflowDefinition?: components$
|
|
8610
|
+
workflowDefinition?: components$a["schemas"]["WorkflowDefinition"];
|
|
8360
8611
|
/**
|
|
8361
8612
|
* @description Only present if an incomplete entry is returned; indicates reason for stubbing
|
|
8362
8613
|
* @enum {string}
|
|
@@ -8378,7 +8629,7 @@ interface components$b {
|
|
|
8378
8629
|
editionPriority?: number;
|
|
8379
8630
|
};
|
|
8380
8631
|
EntryListResponse: {
|
|
8381
|
-
entries: components$
|
|
8632
|
+
entries: components$a["schemas"]["EntryApiResponse"][];
|
|
8382
8633
|
/** @description Total number of entries that match the query. Only present when `withTotalCount` option is true */
|
|
8383
8634
|
totalCount?: number;
|
|
8384
8635
|
/** @description Per-field counts for distinct values */
|
|
@@ -8396,7 +8647,7 @@ interface components$b {
|
|
|
8396
8647
|
[name: string]: unknown;
|
|
8397
8648
|
};
|
|
8398
8649
|
content: {
|
|
8399
|
-
"application/json": components$
|
|
8650
|
+
"application/json": components$a["schemas"]["UniformError"];
|
|
8400
8651
|
};
|
|
8401
8652
|
};
|
|
8402
8653
|
/** @description Provided token or API key does not have access to the requested resource */
|
|
@@ -8405,7 +8656,7 @@ interface components$b {
|
|
|
8405
8656
|
[name: string]: unknown;
|
|
8406
8657
|
};
|
|
8407
8658
|
content: {
|
|
8408
|
-
"application/json": components$
|
|
8659
|
+
"application/json": components$a["schemas"]["UniformError"];
|
|
8409
8660
|
};
|
|
8410
8661
|
};
|
|
8411
8662
|
/** @description Provided token or API key does not allow this action */
|
|
@@ -8414,7 +8665,7 @@ interface components$b {
|
|
|
8414
8665
|
[name: string]: unknown;
|
|
8415
8666
|
};
|
|
8416
8667
|
content: {
|
|
8417
|
-
"application/json": components$
|
|
8668
|
+
"application/json": components$a["schemas"]["UniformError"];
|
|
8418
8669
|
};
|
|
8419
8670
|
};
|
|
8420
8671
|
/** @description The requested resource does not exist */
|
|
@@ -8423,7 +8674,7 @@ interface components$b {
|
|
|
8423
8674
|
[name: string]: unknown;
|
|
8424
8675
|
};
|
|
8425
8676
|
content: {
|
|
8426
|
-
"application/json": components$
|
|
8677
|
+
"application/json": components$a["schemas"]["UniformError"];
|
|
8427
8678
|
};
|
|
8428
8679
|
};
|
|
8429
8680
|
/** @description Invalid method was used to call the endpoint */
|
|
@@ -8432,7 +8683,7 @@ interface components$b {
|
|
|
8432
8683
|
[name: string]: unknown;
|
|
8433
8684
|
};
|
|
8434
8685
|
content: {
|
|
8435
|
-
"application/json": components$
|
|
8686
|
+
"application/json": components$a["schemas"]["UniformError"];
|
|
8436
8687
|
};
|
|
8437
8688
|
};
|
|
8438
8689
|
/** @description The request body could not be parsed or understood */
|
|
@@ -8441,7 +8692,7 @@ interface components$b {
|
|
|
8441
8692
|
[name: string]: unknown;
|
|
8442
8693
|
};
|
|
8443
8694
|
content: {
|
|
8444
|
-
"application/json": components$
|
|
8695
|
+
"application/json": components$a["schemas"]["UniformError"];
|
|
8445
8696
|
};
|
|
8446
8697
|
};
|
|
8447
8698
|
/** @description The endpoint is called too often */
|
|
@@ -8450,7 +8701,7 @@ interface components$b {
|
|
|
8450
8701
|
[name: string]: unknown;
|
|
8451
8702
|
};
|
|
8452
8703
|
content: {
|
|
8453
|
-
"application/json": components$
|
|
8704
|
+
"application/json": components$a["schemas"]["UniformError"];
|
|
8454
8705
|
};
|
|
8455
8706
|
};
|
|
8456
8707
|
/** @description An unexpected error occurred */
|
|
@@ -8459,7 +8710,7 @@ interface components$b {
|
|
|
8459
8710
|
[name: string]: unknown;
|
|
8460
8711
|
};
|
|
8461
8712
|
content: {
|
|
8462
|
-
"application/json": components$
|
|
8713
|
+
"application/json": components$a["schemas"]["UniformError"];
|
|
8463
8714
|
};
|
|
8464
8715
|
};
|
|
8465
8716
|
};
|
|
@@ -8725,7 +8976,7 @@ interface components$b {
|
|
|
8725
8976
|
pathItems: never;
|
|
8726
8977
|
}
|
|
8727
8978
|
|
|
8728
|
-
interface paths$
|
|
8979
|
+
interface paths$9 {
|
|
8729
8980
|
"/api/v1/route": {
|
|
8730
8981
|
parameters: {
|
|
8731
8982
|
query?: never;
|
|
@@ -8738,7 +8989,7 @@ interface paths$a {
|
|
|
8738
8989
|
parameters: {
|
|
8739
8990
|
query: {
|
|
8740
8991
|
/** @description The project to fetch a route from */
|
|
8741
|
-
projectId: components$
|
|
8992
|
+
projectId: components$9["parameters"]["projectId"];
|
|
8742
8993
|
/** @description The path to resolve. Dynamic project map nodes and redirects can be resolved when a matching path is passed.
|
|
8743
8994
|
* Query string parameters may be passed with the path. They are ignored for route matching.
|
|
8744
8995
|
* If the route matches a composition and the project map node allows passed query string parameters, query parameters will
|
|
@@ -8757,20 +9008,20 @@ interface paths$a {
|
|
|
8757
9008
|
* * If several matches have the same number of segments, the one with the fewest dynamic segments wins
|
|
8758
9009
|
* * If still ambiguous, the first matching route arbitrarily wins
|
|
8759
9010
|
* */
|
|
8760
|
-
path: components$
|
|
9011
|
+
path: components$9["parameters"]["path"];
|
|
8761
9012
|
/** @description Specify a project map ID to fetch route from. If not specified, the default project map for the projectId is used */
|
|
8762
|
-
projectMapId?: components$
|
|
9013
|
+
projectMapId?: components$9["parameters"]["projectMapId"];
|
|
8763
9014
|
/** @description Publishing state to fetch. 0 = draft, 64 = published */
|
|
8764
|
-
state?: components$
|
|
9015
|
+
state?: components$9["parameters"]["state"];
|
|
8765
9016
|
/** @description If true the `_id` unique identifier of each non-root component will be part of the response data.
|
|
8766
9017
|
* If false, the `_id` will not be present in the API response
|
|
8767
9018
|
* */
|
|
8768
|
-
withComponentIDs?: components$
|
|
9019
|
+
withComponentIDs?: components$9["parameters"]["withComponentIDs"];
|
|
8769
9020
|
/**
|
|
8770
9021
|
* @deprecated
|
|
8771
9022
|
* @description Includes content source map metadata on supported parameters
|
|
8772
9023
|
*/
|
|
8773
|
-
withContentSourceMap?: components$
|
|
9024
|
+
withContentSourceMap?: components$9["parameters"]["withContentSourceMap"];
|
|
8774
9025
|
/** @description One or more locales to localize the response to.
|
|
8775
9026
|
* When the result is a composition, it includes only the first matching locale's data.
|
|
8776
9027
|
* If no matching locale is found, the response will be a not-found result.
|
|
@@ -8786,7 +9037,7 @@ interface paths$a {
|
|
|
8786
9037
|
*
|
|
8787
9038
|
* When the result is a redirect, this parameter has no effect
|
|
8788
9039
|
* */
|
|
8789
|
-
locale?: components$
|
|
9040
|
+
locale?: components$9["parameters"]["locale"];
|
|
8790
9041
|
/** @description The ID of a release to fetch the content for.
|
|
8791
9042
|
*
|
|
8792
9043
|
* - When unspecified, all release content is excluded from the result(s).
|
|
@@ -8794,12 +9045,12 @@ interface paths$a {
|
|
|
8794
9045
|
*
|
|
8795
9046
|
* 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
|
|
8796
9047
|
* */
|
|
8797
|
-
releaseId?: components$
|
|
9048
|
+
releaseId?: components$9["parameters"]["releaseId"];
|
|
8798
9049
|
/** @description Indicates the data variant that was fetched for data resources.
|
|
8799
9050
|
* undefined: Data resources were resolved using published data from their data source
|
|
8800
9051
|
* 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.
|
|
8801
9052
|
* */
|
|
8802
|
-
dataSourceVariant?: components$
|
|
9053
|
+
dataSourceVariant?: components$9["parameters"]["dataSourceVariant"];
|
|
8803
9054
|
};
|
|
8804
9055
|
header?: never;
|
|
8805
9056
|
path?: never;
|
|
@@ -8813,14 +9064,14 @@ interface paths$a {
|
|
|
8813
9064
|
[name: string]: unknown;
|
|
8814
9065
|
};
|
|
8815
9066
|
content: {
|
|
8816
|
-
"application/json": components$
|
|
9067
|
+
"application/json": components$9["schemas"]["RouteResponse"];
|
|
8817
9068
|
};
|
|
8818
9069
|
};
|
|
8819
|
-
400: components$
|
|
8820
|
-
401: components$
|
|
8821
|
-
403: components$
|
|
8822
|
-
429: components$
|
|
8823
|
-
500: components$
|
|
9070
|
+
400: components$9["responses"]["BadRequestError"];
|
|
9071
|
+
401: components$9["responses"]["UnauthorizedError"];
|
|
9072
|
+
403: components$9["responses"]["ForbiddenError"];
|
|
9073
|
+
429: components$9["responses"]["RateLimitError"];
|
|
9074
|
+
500: components$9["responses"]["InternalServerError"];
|
|
8824
9075
|
};
|
|
8825
9076
|
};
|
|
8826
9077
|
put?: never;
|
|
@@ -8850,7 +9101,7 @@ interface paths$a {
|
|
|
8850
9101
|
trace?: never;
|
|
8851
9102
|
};
|
|
8852
9103
|
}
|
|
8853
|
-
interface components$
|
|
9104
|
+
interface components$9 {
|
|
8854
9105
|
schemas: {
|
|
8855
9106
|
RouteDynamicInputs: {
|
|
8856
9107
|
[key: string]: string;
|
|
@@ -8900,10 +9151,10 @@ interface components$a {
|
|
|
8900
9151
|
RouteResponseRedirect: {
|
|
8901
9152
|
/** @description The route that was matched in the redirects */
|
|
8902
9153
|
matchedRoute: string;
|
|
8903
|
-
dynamicInputs?: components$
|
|
9154
|
+
dynamicInputs?: components$9["schemas"]["RouteDynamicInputs"];
|
|
8904
9155
|
/** @enum {string} */
|
|
8905
9156
|
type: "redirect";
|
|
8906
|
-
redirect: components$
|
|
9157
|
+
redirect: components$9["schemas"]["Redirect"];
|
|
8907
9158
|
};
|
|
8908
9159
|
/** @description Defines a connection to a dynamic token on a data resource
|
|
8909
9160
|
* */
|
|
@@ -8970,12 +9221,12 @@ interface components$a {
|
|
|
8970
9221
|
* @enum {string}
|
|
8971
9222
|
*/
|
|
8972
9223
|
op?: "&" | "|";
|
|
8973
|
-
clauses: (components$
|
|
9224
|
+
clauses: (components$9["schemas"]["VisibilityCriteria"] | components$9["schemas"]["VisibilityCriteriaGroup"])[];
|
|
8974
9225
|
};
|
|
8975
9226
|
/** @description Defines a conditional value for a component parameter
|
|
8976
9227
|
* */
|
|
8977
9228
|
ComponentParameterConditionalValue: {
|
|
8978
|
-
when: components$
|
|
9229
|
+
when: components$9["schemas"]["VisibilityCriteriaGroup"];
|
|
8979
9230
|
/** @description The value of the parameter. Any JSON-serializable value is acceptable.
|
|
8980
9231
|
* A value of `null` will cause the parameter value to be removed, if it matches.
|
|
8981
9232
|
* */
|
|
@@ -8994,7 +9245,7 @@ interface components$a {
|
|
|
8994
9245
|
*
|
|
8995
9246
|
* When no locale is passed to a non-route API, conditions are not processed and all conditions are returned.
|
|
8996
9247
|
* */
|
|
8997
|
-
ComponentParameterConditions: components$
|
|
9248
|
+
ComponentParameterConditions: components$9["schemas"]["ComponentParameterConditionalValue"][];
|
|
8998
9249
|
/** @description Defines an editable parameter on a component */
|
|
8999
9250
|
ComponentParameter: {
|
|
9000
9251
|
/** @description The value of the parameter. Any JSON-serializable value is acceptable */
|
|
@@ -9002,18 +9253,18 @@ interface components$a {
|
|
|
9002
9253
|
/** @description The type of the parameter. Determines how it is displayed when editing and tells the consumer how to process it */
|
|
9003
9254
|
type: string;
|
|
9004
9255
|
/** @deprecated */
|
|
9005
|
-
connectedData?: components$
|
|
9256
|
+
connectedData?: components$9["schemas"]["DataElementConnectionDefinition"];
|
|
9006
9257
|
/** @description Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
|
|
9007
9258
|
* Note that locales must be registered on the entry/composition `_locales` before being used
|
|
9008
9259
|
* */
|
|
9009
9260
|
locales?: {
|
|
9010
9261
|
[key: string]: unknown;
|
|
9011
9262
|
};
|
|
9012
|
-
conditions?: components$
|
|
9263
|
+
conditions?: components$9["schemas"]["ComponentParameterConditions"];
|
|
9013
9264
|
/** @description Locale-specific conditional values for this parameter. Keys are locale codes, and values are the `conditions` for that locale.
|
|
9014
9265
|
* */
|
|
9015
9266
|
localesConditions?: {
|
|
9016
|
-
[key: string]: components$
|
|
9267
|
+
[key: string]: components$9["schemas"]["ComponentParameterConditions"];
|
|
9017
9268
|
};
|
|
9018
9269
|
};
|
|
9019
9270
|
ProjectMapNodeAllowedQueryString: {
|
|
@@ -9042,7 +9293,7 @@ interface components$a {
|
|
|
9042
9293
|
/** @description 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 */
|
|
9043
9294
|
isSearchHit?: boolean;
|
|
9044
9295
|
/** @description Query strings that are allowed to be passed to the node */
|
|
9045
|
-
queryStrings?: components$
|
|
9296
|
+
queryStrings?: components$9["schemas"]["ProjectMapNodeAllowedQueryString"][];
|
|
9046
9297
|
/** @description For dynamic nodes, this is the preview value for the dynamic value.
|
|
9047
9298
|
* The preview value is used when editing a connected composition, and is the default
|
|
9048
9299
|
* dynamic node value unless the author has explicitly chosen a different value
|
|
@@ -9065,7 +9316,7 @@ interface components$a {
|
|
|
9065
9316
|
* @description Unique identifier for the project map that this node belongs to
|
|
9066
9317
|
*/
|
|
9067
9318
|
projectMapId: string;
|
|
9068
|
-
data?: components$
|
|
9319
|
+
data?: components$9["schemas"]["ProjectMapNodeData"];
|
|
9069
9320
|
/** @description Locale-specific paths of the project map node.
|
|
9070
9321
|
* Keys are locale codes
|
|
9071
9322
|
* */
|
|
@@ -9085,13 +9336,13 @@ interface components$a {
|
|
|
9085
9336
|
type: string;
|
|
9086
9337
|
/** @description Component parameter values for the component instance */
|
|
9087
9338
|
parameters?: {
|
|
9088
|
-
[key: string]: components$
|
|
9339
|
+
[key: string]: components$9["schemas"]["ComponentParameter"];
|
|
9089
9340
|
};
|
|
9090
9341
|
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
|
9091
9342
|
variant?: string;
|
|
9092
9343
|
/** @description Slots containing any child components */
|
|
9093
9344
|
slots?: {
|
|
9094
|
-
[key: string]: components$
|
|
9345
|
+
[key: string]: components$9["schemas"]["ComponentInstance"][];
|
|
9095
9346
|
};
|
|
9096
9347
|
/** @description Unique identifier of the component within the composition.
|
|
9097
9348
|
* No assumptions should be made about the format of this value other than "it will be unique."
|
|
@@ -9101,14 +9352,14 @@ interface components$a {
|
|
|
9101
9352
|
_id?: string;
|
|
9102
9353
|
/** @description Indicates this component instance should be sourced from a pattern library pattern */
|
|
9103
9354
|
_pattern?: string;
|
|
9104
|
-
_dataResources?: components$
|
|
9355
|
+
_dataResources?: components$9["schemas"]["DataResourceDefinitions"];
|
|
9105
9356
|
/** @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
|
9106
9357
|
* Means nothing for PUTs; it will be ignored
|
|
9107
9358
|
* */
|
|
9108
9359
|
_patternDataResources?: {
|
|
9109
|
-
[key: string]: components$
|
|
9360
|
+
[key: string]: components$9["schemas"]["DataResourceDefinition"];
|
|
9110
9361
|
};
|
|
9111
|
-
_patternError?: components$
|
|
9362
|
+
_patternError?: components$9["schemas"]["PatternError"];
|
|
9112
9363
|
/** @description Defines patch overrides to component IDs that live in the composition.
|
|
9113
9364
|
* This can be used to override parameters that are defined on patterns,
|
|
9114
9365
|
* including nested patterns, with values that are specific to this composition.
|
|
@@ -9121,13 +9372,13 @@ interface components$a {
|
|
|
9121
9372
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
9122
9373
|
* */
|
|
9123
9374
|
_overrides?: {
|
|
9124
|
-
[key: string]: components$
|
|
9375
|
+
[key: string]: components$9["schemas"]["ComponentOverride"];
|
|
9125
9376
|
};
|
|
9126
9377
|
/** @description Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
|
|
9127
9378
|
* Means nothing for PUTs; it will be ignored
|
|
9128
9379
|
* */
|
|
9129
9380
|
_patternOverrides?: {
|
|
9130
|
-
[key: string]: components$
|
|
9381
|
+
[key: string]: components$9["schemas"]["ComponentOverride"];
|
|
9131
9382
|
};
|
|
9132
9383
|
/** @description When used on a pattern, defines how the pattern's parameters may be overridden
|
|
9133
9384
|
* by consumers of the pattern.
|
|
@@ -9135,7 +9386,7 @@ interface components$a {
|
|
|
9135
9386
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
9136
9387
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
9137
9388
|
* */
|
|
9138
|
-
_overridability?: components$
|
|
9389
|
+
_overridability?: components$9["schemas"]["ComponentOverridability"];
|
|
9139
9390
|
/** @description Array of locales that have data defined. Only set for pattern references or composition defaults */
|
|
9140
9391
|
_locales?: string[];
|
|
9141
9392
|
};
|
|
@@ -9158,13 +9409,13 @@ interface components$a {
|
|
|
9158
9409
|
* If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
|
|
9159
9410
|
* */
|
|
9160
9411
|
optionalPatternParameter?: boolean;
|
|
9161
|
-
variables?: components$
|
|
9412
|
+
variables?: components$9["schemas"]["DataResourceVariables"];
|
|
9162
9413
|
};
|
|
9163
9414
|
/** @description Data definitions attached to this component. The property name is the key of the data in the data document.
|
|
9164
9415
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key)
|
|
9165
9416
|
* */
|
|
9166
9417
|
DataResourceDefinitions: {
|
|
9167
|
-
[key: string]: components$
|
|
9418
|
+
[key: string]: components$9["schemas"]["DataResourceDefinition"];
|
|
9168
9419
|
};
|
|
9169
9420
|
/**
|
|
9170
9421
|
* @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
|
@@ -9182,10 +9433,10 @@ interface components$a {
|
|
|
9182
9433
|
* */
|
|
9183
9434
|
ComponentOverride: {
|
|
9184
9435
|
parameters?: {
|
|
9185
|
-
[key: string]: components$
|
|
9436
|
+
[key: string]: components$9["schemas"]["ComponentParameter"];
|
|
9186
9437
|
};
|
|
9187
9438
|
slots?: {
|
|
9188
|
-
[key: string]: components$
|
|
9439
|
+
[key: string]: components$9["schemas"]["ComponentInstance"][];
|
|
9189
9440
|
};
|
|
9190
9441
|
variant?: string;
|
|
9191
9442
|
/** @description Overrides data resource definitions for a pattern component.
|
|
@@ -9193,7 +9444,7 @@ interface components$a {
|
|
|
9193
9444
|
* Overrides defined here replace values in either _dataResources or _patternDataResources on the target component.
|
|
9194
9445
|
* */
|
|
9195
9446
|
dataResources?: {
|
|
9196
|
-
[key: string]: components$
|
|
9447
|
+
[key: string]: components$9["schemas"]["DataResourceDefinition"];
|
|
9197
9448
|
};
|
|
9198
9449
|
};
|
|
9199
9450
|
/**
|
|
@@ -9214,7 +9465,7 @@ interface components$a {
|
|
|
9214
9465
|
ComponentOverridability: {
|
|
9215
9466
|
/** @description Defines component parameter value overrides. Keys are the parameter public ID */
|
|
9216
9467
|
parameters?: {
|
|
9217
|
-
[key: string]: components$
|
|
9468
|
+
[key: string]: components$9["schemas"]["OverrideOptions"];
|
|
9218
9469
|
};
|
|
9219
9470
|
/** @description Allows overriding a display variant is allowed if it is defined on the component the pattern is derived from. Default = false */
|
|
9220
9471
|
variants?: boolean;
|
|
@@ -9230,15 +9481,15 @@ interface components$a {
|
|
|
9230
9481
|
type: string;
|
|
9231
9482
|
/** @description Component parameter values for the component instance */
|
|
9232
9483
|
parameters?: {
|
|
9233
|
-
[key: string]: components$
|
|
9484
|
+
[key: string]: components$9["schemas"]["ComponentParameter"];
|
|
9234
9485
|
};
|
|
9235
9486
|
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
|
9236
9487
|
variant?: string;
|
|
9237
9488
|
/** @description Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated */
|
|
9238
|
-
projectMapNodes?: components$
|
|
9489
|
+
projectMapNodes?: components$9["schemas"]["CompositionProjectMapNodeInfo"][];
|
|
9239
9490
|
/** @description Slots containing any child components */
|
|
9240
9491
|
slots?: {
|
|
9241
|
-
[key: string]: components$
|
|
9492
|
+
[key: string]: components$9["schemas"]["ComponentInstance"][];
|
|
9242
9493
|
};
|
|
9243
9494
|
/** @description The ID of the composition */
|
|
9244
9495
|
_id: string;
|
|
@@ -9260,10 +9511,10 @@ interface components$a {
|
|
|
9260
9511
|
* Means nothing for PUTs; it will be ignored
|
|
9261
9512
|
* */
|
|
9262
9513
|
_patternDataResources?: {
|
|
9263
|
-
[key: string]: components$
|
|
9514
|
+
[key: string]: components$9["schemas"]["DataResourceDefinition"];
|
|
9264
9515
|
};
|
|
9265
|
-
_dataResources?: components$
|
|
9266
|
-
_patternError?: components$
|
|
9516
|
+
_dataResources?: components$9["schemas"]["DataResourceDefinitions"];
|
|
9517
|
+
_patternError?: components$9["schemas"]["PatternError"];
|
|
9267
9518
|
/** @description Defines patch overrides to component IDs that live in the composition.
|
|
9268
9519
|
* This can be used to override parameters that are defined on patterns,
|
|
9269
9520
|
* including nested patterns, with values that are specific to this composition.
|
|
@@ -9276,13 +9527,13 @@ interface components$a {
|
|
|
9276
9527
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
9277
9528
|
* */
|
|
9278
9529
|
_overrides?: {
|
|
9279
|
-
[key: string]: components$
|
|
9530
|
+
[key: string]: components$9["schemas"]["ComponentOverride"];
|
|
9280
9531
|
};
|
|
9281
9532
|
/** @description Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
|
|
9282
9533
|
* Means nothing for PUTs; it will be ignored
|
|
9283
9534
|
* */
|
|
9284
9535
|
_patternOverrides?: {
|
|
9285
|
-
[key: string]: components$
|
|
9536
|
+
[key: string]: components$9["schemas"]["ComponentOverride"];
|
|
9286
9537
|
};
|
|
9287
9538
|
/** @description When used on a pattern, defines how the pattern's parameters may be overridden
|
|
9288
9539
|
* by consumers of the pattern.
|
|
@@ -9290,7 +9541,7 @@ interface components$a {
|
|
|
9290
9541
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
9291
9542
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
9292
9543
|
* */
|
|
9293
|
-
_overridability?: components$
|
|
9544
|
+
_overridability?: components$9["schemas"]["ComponentOverridability"];
|
|
9294
9545
|
/** @description Array of locales which have data defined on the composition. If empty, the current default locale implicitly has data */
|
|
9295
9546
|
_locales?: string[];
|
|
9296
9547
|
};
|
|
@@ -9321,7 +9572,7 @@ interface components$a {
|
|
|
9321
9572
|
* NOTE: Users without membership in any role listed here will be unable to execute the transition unless they are team admins
|
|
9322
9573
|
* */
|
|
9323
9574
|
permissions: {
|
|
9324
|
-
[key: string]: components$
|
|
9575
|
+
[key: string]: components$9["schemas"]["WorkflowStageTransitionPermission"];
|
|
9325
9576
|
};
|
|
9326
9577
|
};
|
|
9327
9578
|
/** @description Definition of a stage in a workflow */
|
|
@@ -9334,7 +9585,7 @@ interface components$a {
|
|
|
9334
9585
|
* listed here, the stage is read-only and publishing is disabled
|
|
9335
9586
|
* */
|
|
9336
9587
|
permissions: {
|
|
9337
|
-
[key: string]: components$
|
|
9588
|
+
[key: string]: components$9["schemas"]["WorkflowStagePermission"];
|
|
9338
9589
|
};
|
|
9339
9590
|
/** @description When true, transitioning into this stage from a different stage will automatically publish the entity.
|
|
9340
9591
|
* If the user making the transition does not have publish permissions to the stage as well as publish permission on the entity, the action will not run.
|
|
@@ -9351,7 +9602,7 @@ interface components$a {
|
|
|
9351
9602
|
* Every stage must define at least one transition, to avoid creating a workflow that
|
|
9352
9603
|
* has a stage that can never be escaped
|
|
9353
9604
|
* */
|
|
9354
|
-
transitions: components$
|
|
9605
|
+
transitions: components$9["schemas"]["WorkflowStageTransition"][];
|
|
9355
9606
|
/**
|
|
9356
9607
|
* @description Icon name for the stage (e.g. 'chevron-double-right-o')
|
|
9357
9608
|
* @default chevron-double-right-o
|
|
@@ -9376,7 +9627,7 @@ interface components$a {
|
|
|
9376
9627
|
initialStage: string;
|
|
9377
9628
|
/** @description All stages of the workflow */
|
|
9378
9629
|
stages: {
|
|
9379
|
-
[key: string]: components$
|
|
9630
|
+
[key: string]: components$9["schemas"]["WorkflowStage"];
|
|
9380
9631
|
};
|
|
9381
9632
|
/** @description Last modified ISO date string for this definition (ignored for writes) */
|
|
9382
9633
|
modified?: string;
|
|
@@ -9442,7 +9693,7 @@ interface components$a {
|
|
|
9442
9693
|
* @description The release this composition belongs to. If not set, it belongs to the base
|
|
9443
9694
|
*/
|
|
9444
9695
|
releaseId?: string;
|
|
9445
|
-
composition: components$
|
|
9696
|
+
composition: components$9["schemas"]["RootComponentInstance"];
|
|
9446
9697
|
/**
|
|
9447
9698
|
* Format: uuid
|
|
9448
9699
|
* @description The workflow ID assigned to this composition, if any. Normally comes from the component definition
|
|
@@ -9454,7 +9705,7 @@ interface components$a {
|
|
|
9454
9705
|
*/
|
|
9455
9706
|
workflowStageId?: string;
|
|
9456
9707
|
/** @description The full definition of the assigned workflow, if any, including stages, permissions, etc. Returned only when `withWorkflowDefinition` is true */
|
|
9457
|
-
workflowDefinition?: components$
|
|
9708
|
+
workflowDefinition?: components$9["schemas"]["WorkflowDefinition"];
|
|
9458
9709
|
/**
|
|
9459
9710
|
* Format: uuid
|
|
9460
9711
|
* @description The edition ID. When set, this is a child edition of the composition in _id.
|
|
@@ -9476,7 +9727,7 @@ interface components$a {
|
|
|
9476
9727
|
RouteResponseComposition: {
|
|
9477
9728
|
/** @description The route that was matched in the project map */
|
|
9478
9729
|
matchedRoute: string;
|
|
9479
|
-
dynamicInputs?: components$
|
|
9730
|
+
dynamicInputs?: components$9["schemas"]["RouteDynamicInputs"];
|
|
9480
9731
|
/**
|
|
9481
9732
|
* @description Indicates the data variant that was fetched for data resources.
|
|
9482
9733
|
* undefined: Data resources were resolved using published data from their data source
|
|
@@ -9487,7 +9738,7 @@ interface components$a {
|
|
|
9487
9738
|
dataResourcesVariant?: "unpublished";
|
|
9488
9739
|
/** @enum {string} */
|
|
9489
9740
|
type: "composition";
|
|
9490
|
-
compositionApiResponse: components$
|
|
9741
|
+
compositionApiResponse: components$9["schemas"]["CompositionApiResponse"];
|
|
9491
9742
|
};
|
|
9492
9743
|
/** @description The route does not match any configured redirections or compositions.
|
|
9493
9744
|
* NOTE: This response differs from a HTTP 404, which indicates that the project map or project ID was not found.
|
|
@@ -9497,7 +9748,7 @@ interface components$a {
|
|
|
9497
9748
|
/** @enum {string} */
|
|
9498
9749
|
type: "notFound";
|
|
9499
9750
|
};
|
|
9500
|
-
RouteResponse: components$
|
|
9751
|
+
RouteResponse: components$9["schemas"]["RouteResponseRedirect"] | components$9["schemas"]["RouteResponseComposition"] | components$9["schemas"]["RouteResponseNotFound"];
|
|
9501
9752
|
Error: {
|
|
9502
9753
|
/** @description Error message(s) that occurred while processing the request */
|
|
9503
9754
|
errorMessage?: string[] | string;
|
|
@@ -9510,7 +9761,7 @@ interface components$a {
|
|
|
9510
9761
|
[name: string]: unknown;
|
|
9511
9762
|
};
|
|
9512
9763
|
content: {
|
|
9513
|
-
"application/json": components$
|
|
9764
|
+
"application/json": components$9["schemas"]["Error"];
|
|
9514
9765
|
};
|
|
9515
9766
|
};
|
|
9516
9767
|
/** @description API key or token was not valid */
|
|
@@ -9519,7 +9770,7 @@ interface components$a {
|
|
|
9519
9770
|
[name: string]: unknown;
|
|
9520
9771
|
};
|
|
9521
9772
|
content: {
|
|
9522
|
-
"application/json": components$
|
|
9773
|
+
"application/json": components$9["schemas"]["Error"];
|
|
9523
9774
|
};
|
|
9524
9775
|
};
|
|
9525
9776
|
/** @description Permission was denied */
|
|
@@ -9528,7 +9779,7 @@ interface components$a {
|
|
|
9528
9779
|
[name: string]: unknown;
|
|
9529
9780
|
};
|
|
9530
9781
|
content: {
|
|
9531
|
-
"application/json": components$
|
|
9782
|
+
"application/json": components$9["schemas"]["Error"];
|
|
9532
9783
|
};
|
|
9533
9784
|
};
|
|
9534
9785
|
/** @description Too many requests in allowed time period */
|
|
@@ -9616,10 +9867,10 @@ interface components$a {
|
|
|
9616
9867
|
pathItems: never;
|
|
9617
9868
|
}
|
|
9618
9869
|
|
|
9619
|
-
type Components = components$
|
|
9870
|
+
type Components = components$c['schemas'];
|
|
9620
9871
|
type SharedComponents$1 = components$p['schemas'];
|
|
9621
|
-
type Api = paths$
|
|
9622
|
-
type HistoryApi = paths$
|
|
9872
|
+
type Api = paths$b['/api/v1/canvas'];
|
|
9873
|
+
type HistoryApi = paths$a['/api/v1/canvas-history'];
|
|
9623
9874
|
/** Query parameter options for GET /api/v1/canvas */
|
|
9624
9875
|
type CompositionGetParameters = Omit<Api['get']['parameters']['query'], 'type'> & {
|
|
9625
9876
|
type?: string | string[];
|
|
@@ -9758,6 +10009,7 @@ type CanvasDefinitions = {
|
|
|
9758
10009
|
entries?: Array<Entry>;
|
|
9759
10010
|
entryPatterns?: Array<Entry>;
|
|
9760
10011
|
prompts?: Array<Prompt>;
|
|
10012
|
+
labels?: Array<Label>;
|
|
9761
10013
|
assets?: Array<AssetGetResponseSingle>;
|
|
9762
10014
|
locales?: Array<Locale>;
|
|
9763
10015
|
workflows?: Array<WorkflowDefinition>;
|
|
@@ -9806,7 +10058,7 @@ type DataResolutionParameters = {
|
|
|
9806
10058
|
};
|
|
9807
10059
|
/** Types of issue that can occur when fetching composition data */
|
|
9808
10060
|
type DataResolutionIssue = PatternIssue | DataResourceIssue | MaxDepthExceededIssue | DataElementBindingIssue | DynamicInputIssue | DataResolutionConfigIssue;
|
|
9809
|
-
type DataResolutionIssueCore = components$
|
|
10061
|
+
type DataResolutionIssueCore = components$a['schemas']['DataResolutionIssue'];
|
|
9810
10062
|
/** An error that occured resolving a pattern that is referenced on the composition */
|
|
9811
10063
|
type PatternIssue = DataResolutionIssueCore & {
|
|
9812
10064
|
type: 'pattern';
|
|
@@ -9856,26 +10108,26 @@ type DataResolutionConfigIssue = {
|
|
|
9856
10108
|
type: 'config';
|
|
9857
10109
|
};
|
|
9858
10110
|
/** Diagnostics about edge request processing */
|
|
9859
|
-
type EdgehancersDiagnostics = components$
|
|
9860
|
-
type EdgehancersWholeResponseCacheDiagnostics = components$
|
|
10111
|
+
type EdgehancersDiagnostics = components$a['schemas']['EdgehancersDiagnostics'];
|
|
10112
|
+
type EdgehancersWholeResponseCacheDiagnostics = components$a['schemas']['EdgehancersResolutionInfo']['wholeResponseCacheDiagnostics'];
|
|
9861
10113
|
/** Diagnostic data about the load performance of attached composition datas */
|
|
9862
|
-
type DataDiagnostic = components$
|
|
10114
|
+
type DataDiagnostic = components$a['schemas']['DataDiagnostic'];
|
|
9863
10115
|
/** Response as it comes from uniform.global/api/v1/composition */
|
|
9864
|
-
type CompositionResolvedGetResponse = components$
|
|
9865
|
-
type CompositionResolvedListResponse = components$
|
|
10116
|
+
type CompositionResolvedGetResponse = components$a['schemas']['CompositionResolvedGetResponse'];
|
|
10117
|
+
type CompositionResolvedListResponse = components$a['schemas']['CompositionResolvedListResponse'];
|
|
9866
10118
|
/** All valid response types */
|
|
9867
10119
|
type CompositionGetValidResponses = CompositionGetResponse | CompositionResolvedGetResponse;
|
|
9868
10120
|
/** The GET response from /api/v1/route */
|
|
9869
|
-
type RouteGetParameters = paths$
|
|
9870
|
-
type RouteGetResponse = components$
|
|
9871
|
-
type RouteGetResponseComposition = components$
|
|
9872
|
-
type RouteGetResponseRedirect = components$
|
|
9873
|
-
type RouteGetResponseNotFound = components$
|
|
9874
|
-
type RouteDynamicInputs = components$
|
|
10121
|
+
type RouteGetParameters = paths$9['/api/v1/route']['get']['parameters']['query'] & DataResolutionParameters;
|
|
10122
|
+
type RouteGetResponse = components$d['schemas']['RouteResponse'];
|
|
10123
|
+
type RouteGetResponseComposition = components$d['schemas']['RouteResponseComposition'];
|
|
10124
|
+
type RouteGetResponseRedirect = components$d['schemas']['RouteResponseRedirect'];
|
|
10125
|
+
type RouteGetResponseNotFound = components$d['schemas']['RouteResponseNotFound'];
|
|
10126
|
+
type RouteDynamicInputs = components$d['schemas']['RouteDynamicInputs'];
|
|
9875
10127
|
/** The GET response from /api/v1/entries */
|
|
9876
10128
|
type EntriesGetParameters = paths$j['/api/v1/entries']['get']['parameters']['query'] & DataResolutionParameters;
|
|
9877
10129
|
type EntriesGetResponse = components$n['schemas']['EntryListResponse'];
|
|
9878
|
-
type EntriesResolvedListResponse = components$
|
|
10130
|
+
type EntriesResolvedListResponse = components$a['schemas']['EntryResolvedListResponse'];
|
|
9879
10131
|
/** GET response from uniform.global/api/v1/route when result is a composition */
|
|
9880
10132
|
type RouteGetResponseEdgehancedComposition = Omit<RouteGetResponseComposition, 'compositionApiResponse'> & {
|
|
9881
10133
|
compositionApiResponse: CompositionResolvedGetResponse;
|
|
@@ -10023,380 +10275,105 @@ type ComponentParameterEnhancer<TRawValue = unknown, TOutputValue = unknown, TCo
|
|
|
10023
10275
|
type StringAlwaysPresentExactField = 'entityId' | 'type' | 'uiStatus';
|
|
10024
10276
|
type DateAlwaysPresentField = 'created' | 'modified';
|
|
10025
10277
|
type StringOptionalField = 'locale' | 'patternId' | 'workflowId' | 'workflowStageId';
|
|
10026
|
-
type StringAlwaysPresentField = 'name' | 'slug' | 'creator' | 'author';
|
|
10027
|
-
type ProjectMapField = 'projectMapId' | 'projectMapNodeId';
|
|
10028
|
-
type InNinFilter<T> = T | T[];
|
|
10029
|
-
type DefFilter = boolean | 'true' | 'false';
|
|
10030
|
-
type Filters<CustomFieldPrefix extends string = 'fields'> = Partial<Record<StringAlwaysPresentExactField, {
|
|
10031
|
-
eq: string;
|
|
10032
|
-
} | {
|
|
10033
|
-
neq: string;
|
|
10034
|
-
} | {
|
|
10035
|
-
in: InNinFilter<string>;
|
|
10036
|
-
} | {
|
|
10037
|
-
nin: InNinFilter<string>;
|
|
10038
|
-
}> | Record<`${StringAlwaysPresentExactField}[${'eq' | 'neq'}]`, string> | Record<`${StringAlwaysPresentExactField}[${'in' | 'nin'}]`, InNinFilter<string>> | Record<DateAlwaysPresentField, {
|
|
10039
|
-
eq: string;
|
|
10040
|
-
} | {
|
|
10041
|
-
neq: string;
|
|
10042
|
-
} | {
|
|
10043
|
-
in: InNinFilter<string>;
|
|
10044
|
-
} | {
|
|
10045
|
-
nin: InNinFilter<string>;
|
|
10046
|
-
} | {
|
|
10047
|
-
gt: string;
|
|
10048
|
-
} | {
|
|
10049
|
-
gte: string;
|
|
10050
|
-
} | {
|
|
10051
|
-
lt: string;
|
|
10052
|
-
} | {
|
|
10053
|
-
lte: string;
|
|
10054
|
-
}> | Record<`${DateAlwaysPresentField}[${'eq' | 'neq' | 'gt' | 'gte' | 'lt' | 'lte'}]`, string> | Record<`${DateAlwaysPresentField}[${'in' | 'nin'}]`, InNinFilter<string>> | Record<StringOptionalField, {
|
|
10055
|
-
eq: string;
|
|
10056
|
-
} | {
|
|
10057
|
-
neq: string;
|
|
10058
|
-
} | {
|
|
10059
|
-
in: InNinFilter<string>;
|
|
10060
|
-
} | {
|
|
10061
|
-
nin: InNinFilter<string>;
|
|
10062
|
-
} | {
|
|
10063
|
-
def: DefFilter;
|
|
10064
|
-
}> | Record<`${StringOptionalField}[${'eq' | 'neq'}]`, string> | Record<`${StringOptionalField}[${'in' | 'nin'}]`, InNinFilter<string>> | Record<`${StringOptionalField}[def]`, DefFilter> | Record<StringAlwaysPresentField, {
|
|
10065
|
-
match: string;
|
|
10066
|
-
} | {
|
|
10067
|
-
starts: string;
|
|
10068
|
-
} | {
|
|
10069
|
-
eq: string;
|
|
10070
|
-
} | {
|
|
10071
|
-
neq: string;
|
|
10072
|
-
} | {
|
|
10073
|
-
in: InNinFilter<string>;
|
|
10074
|
-
} | {
|
|
10075
|
-
nin: InNinFilter<string>;
|
|
10076
|
-
}> | Record<`${StringAlwaysPresentField}[${'match' | 'starts' | 'eq' | 'neq'}]`, string> | Record<`${StringAlwaysPresentField}[${'in' | 'nin'}]`, InNinFilter<string>> | Record<`${CustomFieldPrefix}.${string}`, {
|
|
10077
|
-
match: string;
|
|
10078
|
-
} | {
|
|
10079
|
-
starts: string;
|
|
10080
|
-
} | {
|
|
10081
|
-
eq: string | number | boolean;
|
|
10082
|
-
} | {
|
|
10083
|
-
neq: string | number | boolean;
|
|
10084
|
-
} | {
|
|
10085
|
-
in: InNinFilter<string | number | boolean>;
|
|
10086
|
-
} | {
|
|
10087
|
-
nin: InNinFilter<string | number | boolean>;
|
|
10088
|
-
} | {
|
|
10089
|
-
gt: string | number;
|
|
10090
|
-
} | {
|
|
10091
|
-
gte: string | number;
|
|
10092
|
-
} | {
|
|
10093
|
-
lt: string | number;
|
|
10094
|
-
} | {
|
|
10095
|
-
lte: string | number;
|
|
10096
|
-
} | {
|
|
10097
|
-
def: DefFilter;
|
|
10098
|
-
}> | Record<`${CustomFieldPrefix}.${string}[${'match' | 'starts'}]`, string> | Record<`${CustomFieldPrefix}.${string}[${'eq' | 'neq' | 'gt' | 'gte' | 'lt' | 'lte'}]`, string | number> | Record<`${CustomFieldPrefix}.${string}[${'in' | 'nin'}]`, InNinFilter<string | number | boolean>> | Record<`${CustomFieldPrefix}.${string}[def]`, DefFilter>>;
|
|
10099
|
-
type EntryFilters = Filters<'fields'>;
|
|
10100
|
-
type CompositionFilters = Filters<'parameters'> & Partial<Record<ProjectMapField, {
|
|
10101
|
-
eq: string;
|
|
10102
|
-
} | {
|
|
10103
|
-
neq: string;
|
|
10104
|
-
} | {
|
|
10105
|
-
in: InNinFilter<string>;
|
|
10106
|
-
} | {
|
|
10107
|
-
nin: InNinFilter<string>;
|
|
10108
|
-
} | {
|
|
10109
|
-
def: DefFilter;
|
|
10110
|
-
}> | Record<`${ProjectMapField}[${'eq' | 'neq'}]`, string> | Record<`${ProjectMapField}[${'in' | 'nin'}]`, InNinFilter<string>> | Record<`${ProjectMapField}[def]`, DefFilter>>;
|
|
10111
|
-
|
|
10112
|
-
interface paths$9 {
|
|
10113
|
-
"/api/v1/integration-property-editors": {
|
|
10114
|
-
parameters: {
|
|
10115
|
-
query?: never;
|
|
10116
|
-
header?: never;
|
|
10117
|
-
path?: never;
|
|
10118
|
-
cookie?: never;
|
|
10119
|
-
};
|
|
10120
|
-
/** @description Gets a list of propertyType and hook names for the current team, including public integrations' hooks. */
|
|
10121
|
-
get: {
|
|
10122
|
-
parameters: {
|
|
10123
|
-
query: {
|
|
10124
|
-
teamId: string;
|
|
10125
|
-
};
|
|
10126
|
-
header?: never;
|
|
10127
|
-
path?: never;
|
|
10128
|
-
cookie?: never;
|
|
10129
|
-
};
|
|
10130
|
-
requestBody?: never;
|
|
10131
|
-
responses: {
|
|
10132
|
-
/** @description 200 response */
|
|
10133
|
-
200: {
|
|
10134
|
-
headers: {
|
|
10135
|
-
[name: string]: unknown;
|
|
10136
|
-
};
|
|
10137
|
-
content: {
|
|
10138
|
-
"application/json": {
|
|
10139
|
-
/** @description A map of property types to a map of hook names to integration details */
|
|
10140
|
-
propertyEditors: {
|
|
10141
|
-
[key: string]: {
|
|
10142
|
-
[key: string]: {
|
|
10143
|
-
/** @description Internal unique identifier for the editor */
|
|
10144
|
-
id: string;
|
|
10145
|
-
/** @description The integration type */
|
|
10146
|
-
integrationType: string;
|
|
10147
|
-
/** @description Whether this is a public integration */
|
|
10148
|
-
isPublic: boolean;
|
|
10149
|
-
/**
|
|
10150
|
-
* Format: uuid
|
|
10151
|
-
* @description The team ID for public integrations. Omitted for private integrations.
|
|
10152
|
-
*/
|
|
10153
|
-
teamId?: string;
|
|
10154
|
-
};
|
|
10155
|
-
};
|
|
10156
|
-
};
|
|
10157
|
-
};
|
|
10158
|
-
};
|
|
10159
|
-
};
|
|
10160
|
-
400: components$9["responses"]["BadRequestError"];
|
|
10161
|
-
401: components$9["responses"]["UnauthorizedError"];
|
|
10162
|
-
403: components$9["responses"]["ForbiddenError"];
|
|
10163
|
-
/** @description Team not found */
|
|
10164
|
-
404: {
|
|
10165
|
-
headers: {
|
|
10166
|
-
[name: string]: unknown;
|
|
10167
|
-
};
|
|
10168
|
-
content?: never;
|
|
10169
|
-
};
|
|
10170
|
-
429: components$9["responses"]["RateLimitError"];
|
|
10171
|
-
500: components$9["responses"]["InternalServerError"];
|
|
10172
|
-
};
|
|
10173
|
-
};
|
|
10174
|
-
/** @description Creates or updates a custom AI property editor on a Mesh app. */
|
|
10175
|
-
put: {
|
|
10176
|
-
parameters: {
|
|
10177
|
-
query?: never;
|
|
10178
|
-
header?: never;
|
|
10179
|
-
path?: never;
|
|
10180
|
-
cookie?: never;
|
|
10181
|
-
};
|
|
10182
|
-
requestBody: {
|
|
10183
|
-
content: {
|
|
10184
|
-
"application/json": {
|
|
10185
|
-
/**
|
|
10186
|
-
* Format: uuid
|
|
10187
|
-
* @description The team ID
|
|
10188
|
-
*/
|
|
10189
|
-
teamId: string;
|
|
10190
|
-
/** @description The property type to attach the editor to */
|
|
10191
|
-
propertyType: string;
|
|
10192
|
-
/**
|
|
10193
|
-
* @description The hook to attach the editor to
|
|
10194
|
-
* @enum {string}
|
|
10195
|
-
*/
|
|
10196
|
-
hook: "createAIEdit" | "afterAIEdit";
|
|
10197
|
-
/** @description ESM JS code to run for the custom property editor. It runs in a v8 runtime, and is expected to default-export a function which conforms to the hook type specs. */
|
|
10198
|
-
code: string;
|
|
10199
|
-
/** @description Date indicating targeted support in the custom property editor runtime. Backwards incompatible fixes to the runtime following this date will not affect this custom property editor. */
|
|
10200
|
-
compatibilityDate?: string;
|
|
10201
|
-
};
|
|
10202
|
-
};
|
|
10203
|
-
};
|
|
10204
|
-
responses: {
|
|
10205
|
-
/** @description Put successful */
|
|
10206
|
-
204: {
|
|
10207
|
-
headers: {
|
|
10208
|
-
[name: string]: unknown;
|
|
10209
|
-
};
|
|
10210
|
-
content?: never;
|
|
10211
|
-
};
|
|
10212
|
-
400: components$9["responses"]["BadRequestError"];
|
|
10213
|
-
401: components$9["responses"]["UnauthorizedError"];
|
|
10214
|
-
403: components$9["responses"]["ForbiddenError"];
|
|
10215
|
-
/** @description Property type does not exist */
|
|
10216
|
-
404: {
|
|
10217
|
-
headers: {
|
|
10218
|
-
[name: string]: unknown;
|
|
10219
|
-
};
|
|
10220
|
-
content?: never;
|
|
10221
|
-
};
|
|
10222
|
-
429: components$9["responses"]["RateLimitError"];
|
|
10223
|
-
500: components$9["responses"]["InternalServerError"];
|
|
10224
|
-
/** @description Internal error */
|
|
10225
|
-
502: {
|
|
10226
|
-
headers: {
|
|
10227
|
-
[name: string]: unknown;
|
|
10228
|
-
};
|
|
10229
|
-
content?: never;
|
|
10230
|
-
};
|
|
10231
|
-
};
|
|
10232
|
-
};
|
|
10233
|
-
post?: never;
|
|
10234
|
-
/** @description Removes a custom AI property editor from a Mesh app. The property type will not be removed, only the custom code. */
|
|
10235
|
-
delete: {
|
|
10236
|
-
parameters: {
|
|
10237
|
-
query?: never;
|
|
10238
|
-
header?: never;
|
|
10239
|
-
path?: never;
|
|
10240
|
-
cookie?: never;
|
|
10241
|
-
};
|
|
10242
|
-
requestBody: {
|
|
10243
|
-
content: {
|
|
10244
|
-
"application/json": {
|
|
10245
|
-
/**
|
|
10246
|
-
* Format: uuid
|
|
10247
|
-
* @description The team ID
|
|
10248
|
-
*/
|
|
10249
|
-
teamId: string;
|
|
10250
|
-
/** @description The property type to remove the editor from */
|
|
10251
|
-
propertyType: string;
|
|
10252
|
-
/**
|
|
10253
|
-
* @description The hook to remove the editor from
|
|
10254
|
-
* @enum {string}
|
|
10255
|
-
*/
|
|
10256
|
-
hook: "createAIEdit" | "afterAIEdit";
|
|
10257
|
-
};
|
|
10258
|
-
};
|
|
10259
|
-
};
|
|
10260
|
-
responses: {
|
|
10261
|
-
/** @description Delete successful */
|
|
10262
|
-
204: {
|
|
10263
|
-
headers: {
|
|
10264
|
-
[name: string]: unknown;
|
|
10265
|
-
};
|
|
10266
|
-
content?: never;
|
|
10267
|
-
};
|
|
10268
|
-
400: components$9["responses"]["BadRequestError"];
|
|
10269
|
-
401: components$9["responses"]["UnauthorizedError"];
|
|
10270
|
-
403: components$9["responses"]["ForbiddenError"];
|
|
10271
|
-
/** @description Property type/hook did not exist, nothing deleted. */
|
|
10272
|
-
404: {
|
|
10273
|
-
headers: {
|
|
10274
|
-
[name: string]: unknown;
|
|
10275
|
-
};
|
|
10276
|
-
content?: never;
|
|
10277
|
-
};
|
|
10278
|
-
429: components$9["responses"]["RateLimitError"];
|
|
10279
|
-
500: components$9["responses"]["InternalServerError"];
|
|
10280
|
-
/** @description Internal error */
|
|
10281
|
-
502: {
|
|
10282
|
-
headers: {
|
|
10283
|
-
[name: string]: unknown;
|
|
10284
|
-
};
|
|
10285
|
-
content?: never;
|
|
10286
|
-
};
|
|
10287
|
-
};
|
|
10288
|
-
};
|
|
10289
|
-
/** @description Handles preflight requests. This endpoint allows CORS. */
|
|
10290
|
-
options: {
|
|
10291
|
-
parameters: {
|
|
10292
|
-
query?: never;
|
|
10293
|
-
header?: never;
|
|
10294
|
-
path?: never;
|
|
10295
|
-
cookie?: never;
|
|
10296
|
-
};
|
|
10297
|
-
requestBody?: never;
|
|
10298
|
-
responses: {
|
|
10299
|
-
/** @description ok */
|
|
10300
|
-
204: {
|
|
10301
|
-
headers: {
|
|
10302
|
-
[name: string]: unknown;
|
|
10303
|
-
};
|
|
10304
|
-
content?: never;
|
|
10305
|
-
};
|
|
10306
|
-
};
|
|
10307
|
-
};
|
|
10308
|
-
head?: never;
|
|
10309
|
-
patch?: never;
|
|
10310
|
-
trace?: never;
|
|
10311
|
-
};
|
|
10312
|
-
}
|
|
10313
|
-
interface components$9 {
|
|
10314
|
-
schemas: {
|
|
10315
|
-
Error: {
|
|
10316
|
-
/** @description Error message(s) that occurred while processing the request */
|
|
10317
|
-
errorMessage?: string[] | string;
|
|
10318
|
-
};
|
|
10319
|
-
};
|
|
10320
|
-
responses: {
|
|
10321
|
-
/** @description Request input validation failed */
|
|
10322
|
-
BadRequestError: {
|
|
10323
|
-
headers: {
|
|
10324
|
-
[name: string]: unknown;
|
|
10325
|
-
};
|
|
10326
|
-
content: {
|
|
10327
|
-
"application/json": components$9["schemas"]["Error"];
|
|
10328
|
-
};
|
|
10329
|
-
};
|
|
10330
|
-
/** @description API key or token was not valid */
|
|
10331
|
-
UnauthorizedError: {
|
|
10332
|
-
headers: {
|
|
10333
|
-
[name: string]: unknown;
|
|
10334
|
-
};
|
|
10335
|
-
content: {
|
|
10336
|
-
"application/json": components$9["schemas"]["Error"];
|
|
10337
|
-
};
|
|
10338
|
-
};
|
|
10339
|
-
/** @description Permission was denied */
|
|
10340
|
-
ForbiddenError: {
|
|
10341
|
-
headers: {
|
|
10342
|
-
[name: string]: unknown;
|
|
10343
|
-
};
|
|
10344
|
-
content: {
|
|
10345
|
-
"application/json": components$9["schemas"]["Error"];
|
|
10346
|
-
};
|
|
10347
|
-
};
|
|
10348
|
-
/** @description Too many requests in allowed time period */
|
|
10349
|
-
RateLimitError: {
|
|
10350
|
-
headers: {
|
|
10351
|
-
[name: string]: unknown;
|
|
10352
|
-
};
|
|
10353
|
-
content?: never;
|
|
10354
|
-
};
|
|
10355
|
-
/** @description Execution error occurred */
|
|
10356
|
-
InternalServerError: {
|
|
10357
|
-
headers: {
|
|
10358
|
-
[name: string]: unknown;
|
|
10359
|
-
};
|
|
10360
|
-
content?: never;
|
|
10361
|
-
};
|
|
10362
|
-
};
|
|
10363
|
-
parameters: never;
|
|
10364
|
-
requestBodies: never;
|
|
10365
|
-
headers: never;
|
|
10366
|
-
pathItems: never;
|
|
10367
|
-
}
|
|
10368
|
-
|
|
10369
|
-
type IntegrationPropertyEditorsGetParameters = {
|
|
10370
|
-
teamId: string;
|
|
10371
|
-
};
|
|
10372
|
-
type IntegrationPropertyEditorsGetResponse = paths$9['/api/v1/integration-property-editors']['get']['responses']['200']['content']['application/json'];
|
|
10373
|
-
type IntegrationPropertyEditorsPutParameters = paths$9['/api/v1/integration-property-editors']['put']['requestBody']['content']['application/json'];
|
|
10374
|
-
type IntegrationPropertyEditorsDeleteParameters = paths$9['/api/v1/integration-property-editors']['delete']['requestBody']['content']['application/json'];
|
|
10375
|
-
|
|
10376
|
-
type schemas = components$b['schemas'];
|
|
10377
|
-
type InvalidationPayload = schemas['InvalidationPayload'];
|
|
10378
|
-
type BatchInvalidationPayload = schemas['BatchInvalidationPayload'];
|
|
10278
|
+
type StringAlwaysPresentField = 'name' | 'slug' | 'creator' | 'author';
|
|
10279
|
+
type ProjectMapField = 'projectMapId' | 'projectMapNodeId';
|
|
10280
|
+
type InNinFilter<T> = T | T[];
|
|
10281
|
+
type DefFilter = boolean | 'true' | 'false';
|
|
10282
|
+
type Filters<CustomFieldPrefix extends string = 'fields'> = Partial<Record<StringAlwaysPresentExactField, {
|
|
10283
|
+
eq: string;
|
|
10284
|
+
} | {
|
|
10285
|
+
neq: string;
|
|
10286
|
+
} | {
|
|
10287
|
+
in: InNinFilter<string>;
|
|
10288
|
+
} | {
|
|
10289
|
+
nin: InNinFilter<string>;
|
|
10290
|
+
}> | Record<`${StringAlwaysPresentExactField}[${'eq' | 'neq'}]`, string> | Record<`${StringAlwaysPresentExactField}[${'in' | 'nin'}]`, InNinFilter<string>> | Record<DateAlwaysPresentField, {
|
|
10291
|
+
eq: string;
|
|
10292
|
+
} | {
|
|
10293
|
+
neq: string;
|
|
10294
|
+
} | {
|
|
10295
|
+
in: InNinFilter<string>;
|
|
10296
|
+
} | {
|
|
10297
|
+
nin: InNinFilter<string>;
|
|
10298
|
+
} | {
|
|
10299
|
+
gt: string;
|
|
10300
|
+
} | {
|
|
10301
|
+
gte: string;
|
|
10302
|
+
} | {
|
|
10303
|
+
lt: string;
|
|
10304
|
+
} | {
|
|
10305
|
+
lte: string;
|
|
10306
|
+
}> | Record<`${DateAlwaysPresentField}[${'eq' | 'neq' | 'gt' | 'gte' | 'lt' | 'lte'}]`, string> | Record<`${DateAlwaysPresentField}[${'in' | 'nin'}]`, InNinFilter<string>> | Record<StringOptionalField, {
|
|
10307
|
+
eq: string;
|
|
10308
|
+
} | {
|
|
10309
|
+
neq: string;
|
|
10310
|
+
} | {
|
|
10311
|
+
in: InNinFilter<string>;
|
|
10312
|
+
} | {
|
|
10313
|
+
nin: InNinFilter<string>;
|
|
10314
|
+
} | {
|
|
10315
|
+
def: DefFilter;
|
|
10316
|
+
}> | Record<`${StringOptionalField}[${'eq' | 'neq'}]`, string> | Record<`${StringOptionalField}[${'in' | 'nin'}]`, InNinFilter<string>> | Record<`${StringOptionalField}[def]`, DefFilter> | Record<StringAlwaysPresentField, {
|
|
10317
|
+
match: string;
|
|
10318
|
+
} | {
|
|
10319
|
+
starts: string;
|
|
10320
|
+
} | {
|
|
10321
|
+
eq: string;
|
|
10322
|
+
} | {
|
|
10323
|
+
neq: string;
|
|
10324
|
+
} | {
|
|
10325
|
+
in: InNinFilter<string>;
|
|
10326
|
+
} | {
|
|
10327
|
+
nin: InNinFilter<string>;
|
|
10328
|
+
}> | Record<`${StringAlwaysPresentField}[${'match' | 'starts' | 'eq' | 'neq'}]`, string> | Record<`${StringAlwaysPresentField}[${'in' | 'nin'}]`, InNinFilter<string>> | Record<`${CustomFieldPrefix}.${string}`, {
|
|
10329
|
+
match: string;
|
|
10330
|
+
} | {
|
|
10331
|
+
starts: string;
|
|
10332
|
+
} | {
|
|
10333
|
+
eq: string | number | boolean;
|
|
10334
|
+
} | {
|
|
10335
|
+
neq: string | number | boolean;
|
|
10336
|
+
} | {
|
|
10337
|
+
in: InNinFilter<string | number | boolean>;
|
|
10338
|
+
} | {
|
|
10339
|
+
nin: InNinFilter<string | number | boolean>;
|
|
10340
|
+
} | {
|
|
10341
|
+
gt: string | number;
|
|
10342
|
+
} | {
|
|
10343
|
+
gte: string | number;
|
|
10344
|
+
} | {
|
|
10345
|
+
lt: string | number;
|
|
10346
|
+
} | {
|
|
10347
|
+
lte: string | number;
|
|
10348
|
+
} | {
|
|
10349
|
+
def: DefFilter;
|
|
10350
|
+
}> | Record<`${CustomFieldPrefix}.${string}[${'match' | 'starts'}]`, string> | Record<`${CustomFieldPrefix}.${string}[${'eq' | 'neq' | 'gt' | 'gte' | 'lt' | 'lte'}]`, string | number> | Record<`${CustomFieldPrefix}.${string}[${'in' | 'nin'}]`, InNinFilter<string | number | boolean>> | Record<`${CustomFieldPrefix}.${string}[def]`, DefFilter>>;
|
|
10351
|
+
type EntryFilters = Filters<'fields'>;
|
|
10352
|
+
type CompositionFilters = Filters<'parameters'> & Partial<Record<ProjectMapField, {
|
|
10353
|
+
eq: string;
|
|
10354
|
+
} | {
|
|
10355
|
+
neq: string;
|
|
10356
|
+
} | {
|
|
10357
|
+
in: InNinFilter<string>;
|
|
10358
|
+
} | {
|
|
10359
|
+
nin: InNinFilter<string>;
|
|
10360
|
+
} | {
|
|
10361
|
+
def: DefFilter;
|
|
10362
|
+
}> | Record<`${ProjectMapField}[${'eq' | 'neq'}]`, string> | Record<`${ProjectMapField}[${'in' | 'nin'}]`, InNinFilter<string>> | Record<`${ProjectMapField}[def]`, DefFilter>>;
|
|
10379
10363
|
|
|
10380
10364
|
interface paths$8 {
|
|
10381
|
-
"/api/v1/
|
|
10365
|
+
"/api/v1/integration-property-editors": {
|
|
10382
10366
|
parameters: {
|
|
10383
10367
|
query?: never;
|
|
10384
10368
|
header?: never;
|
|
10385
10369
|
path?: never;
|
|
10386
10370
|
cookie?: never;
|
|
10387
10371
|
};
|
|
10388
|
-
/** @description Gets
|
|
10372
|
+
/** @description Gets a list of propertyType and hook names for the current team, including public integrations' hooks. */
|
|
10389
10373
|
get: {
|
|
10390
10374
|
parameters: {
|
|
10391
10375
|
query: {
|
|
10392
|
-
|
|
10393
|
-
offset?: number | null;
|
|
10394
|
-
limit?: number;
|
|
10395
|
-
labelIds?: string;
|
|
10396
|
-
groupId?: string;
|
|
10397
|
-
isGroup?: boolean | null;
|
|
10398
|
-
idPrefix?: string;
|
|
10399
|
-
namePrefix?: string;
|
|
10376
|
+
teamId: string;
|
|
10400
10377
|
};
|
|
10401
10378
|
header?: never;
|
|
10402
10379
|
path?: never;
|
|
@@ -10404,51 +10381,49 @@ interface paths$8 {
|
|
|
10404
10381
|
};
|
|
10405
10382
|
requestBody?: never;
|
|
10406
10383
|
responses: {
|
|
10407
|
-
/** @description
|
|
10384
|
+
/** @description 200 response */
|
|
10408
10385
|
200: {
|
|
10409
10386
|
headers: {
|
|
10410
10387
|
[name: string]: unknown;
|
|
10411
10388
|
};
|
|
10412
10389
|
content: {
|
|
10413
10390
|
"application/json": {
|
|
10414
|
-
|
|
10415
|
-
|
|
10416
|
-
|
|
10417
|
-
|
|
10418
|
-
|
|
10419
|
-
|
|
10420
|
-
|
|
10421
|
-
|
|
10422
|
-
|
|
10423
|
-
|
|
10424
|
-
|
|
10425
|
-
|
|
10426
|
-
|
|
10427
|
-
|
|
10428
|
-
|
|
10429
|
-
|
|
10430
|
-
/** @description Scope of the label (currently unused) */
|
|
10431
|
-
scope: string[];
|
|
10391
|
+
/** @description A map of property types to a map of hook names to integration details */
|
|
10392
|
+
propertyEditors: {
|
|
10393
|
+
[key: string]: {
|
|
10394
|
+
[key: string]: {
|
|
10395
|
+
/** @description Internal unique identifier for the editor */
|
|
10396
|
+
id: string;
|
|
10397
|
+
/** @description The integration type */
|
|
10398
|
+
integrationType: string;
|
|
10399
|
+
/** @description Whether this is a public integration */
|
|
10400
|
+
isPublic: boolean;
|
|
10401
|
+
/**
|
|
10402
|
+
* Format: uuid
|
|
10403
|
+
* @description The team ID for public integrations. Omitted for private integrations.
|
|
10404
|
+
*/
|
|
10405
|
+
teamId?: string;
|
|
10406
|
+
};
|
|
10432
10407
|
};
|
|
10433
|
-
|
|
10434
|
-
created: string;
|
|
10435
|
-
/** Format: date-time */
|
|
10436
|
-
modified: string;
|
|
10437
|
-
createdBy: string;
|
|
10438
|
-
modifiedBy: string;
|
|
10439
|
-
}[];
|
|
10440
|
-
totalCount: number;
|
|
10408
|
+
};
|
|
10441
10409
|
};
|
|
10442
10410
|
};
|
|
10443
10411
|
};
|
|
10444
10412
|
400: components$8["responses"]["BadRequestError"];
|
|
10445
10413
|
401: components$8["responses"]["UnauthorizedError"];
|
|
10446
10414
|
403: components$8["responses"]["ForbiddenError"];
|
|
10415
|
+
/** @description Team not found */
|
|
10416
|
+
404: {
|
|
10417
|
+
headers: {
|
|
10418
|
+
[name: string]: unknown;
|
|
10419
|
+
};
|
|
10420
|
+
content?: never;
|
|
10421
|
+
};
|
|
10447
10422
|
429: components$8["responses"]["RateLimitError"];
|
|
10448
10423
|
500: components$8["responses"]["InternalServerError"];
|
|
10449
10424
|
};
|
|
10450
10425
|
};
|
|
10451
|
-
/** @description Creates or updates a
|
|
10426
|
+
/** @description Creates or updates a custom AI property editor on a Mesh app. */
|
|
10452
10427
|
put: {
|
|
10453
10428
|
parameters: {
|
|
10454
10429
|
query?: never;
|
|
@@ -10459,42 +10434,56 @@ interface paths$8 {
|
|
|
10459
10434
|
requestBody: {
|
|
10460
10435
|
content: {
|
|
10461
10436
|
"application/json": {
|
|
10462
|
-
/**
|
|
10463
|
-
|
|
10464
|
-
|
|
10465
|
-
|
|
10466
|
-
|
|
10467
|
-
|
|
10468
|
-
|
|
10469
|
-
|
|
10470
|
-
|
|
10471
|
-
|
|
10472
|
-
|
|
10473
|
-
|
|
10474
|
-
|
|
10475
|
-
|
|
10437
|
+
/**
|
|
10438
|
+
* Format: uuid
|
|
10439
|
+
* @description The team ID
|
|
10440
|
+
*/
|
|
10441
|
+
teamId: string;
|
|
10442
|
+
/** @description The property type to attach the editor to */
|
|
10443
|
+
propertyType: string;
|
|
10444
|
+
/**
|
|
10445
|
+
* @description The hook to attach the editor to
|
|
10446
|
+
* @enum {string}
|
|
10447
|
+
*/
|
|
10448
|
+
hook: "createAIEdit" | "afterAIEdit";
|
|
10449
|
+
/** @description ESM JS code to run for the custom property editor. It runs in a v8 runtime, and is expected to default-export a function which conforms to the hook type specs. */
|
|
10450
|
+
code: string;
|
|
10451
|
+
/** @description Date indicating targeted support in the custom property editor runtime. Backwards incompatible fixes to the runtime following this date will not affect this custom property editor. */
|
|
10452
|
+
compatibilityDate?: string;
|
|
10476
10453
|
};
|
|
10477
10454
|
};
|
|
10478
10455
|
};
|
|
10479
10456
|
responses: {
|
|
10480
|
-
/** @description
|
|
10457
|
+
/** @description Put successful */
|
|
10481
10458
|
204: {
|
|
10482
10459
|
headers: {
|
|
10483
10460
|
[name: string]: unknown;
|
|
10484
10461
|
};
|
|
10485
|
-
content
|
|
10486
|
-
"application/json": string;
|
|
10487
|
-
};
|
|
10462
|
+
content?: never;
|
|
10488
10463
|
};
|
|
10489
10464
|
400: components$8["responses"]["BadRequestError"];
|
|
10490
10465
|
401: components$8["responses"]["UnauthorizedError"];
|
|
10491
10466
|
403: components$8["responses"]["ForbiddenError"];
|
|
10467
|
+
/** @description Property type does not exist */
|
|
10468
|
+
404: {
|
|
10469
|
+
headers: {
|
|
10470
|
+
[name: string]: unknown;
|
|
10471
|
+
};
|
|
10472
|
+
content?: never;
|
|
10473
|
+
};
|
|
10492
10474
|
429: components$8["responses"]["RateLimitError"];
|
|
10493
10475
|
500: components$8["responses"]["InternalServerError"];
|
|
10476
|
+
/** @description Internal error */
|
|
10477
|
+
502: {
|
|
10478
|
+
headers: {
|
|
10479
|
+
[name: string]: unknown;
|
|
10480
|
+
};
|
|
10481
|
+
content?: never;
|
|
10482
|
+
};
|
|
10494
10483
|
};
|
|
10495
10484
|
};
|
|
10496
10485
|
post?: never;
|
|
10497
|
-
/** @description
|
|
10486
|
+
/** @description Removes a custom AI property editor from a Mesh app. The property type will not be removed, only the custom code. */
|
|
10498
10487
|
delete: {
|
|
10499
10488
|
parameters: {
|
|
10500
10489
|
query?: never;
|
|
@@ -10507,29 +10496,46 @@ interface paths$8 {
|
|
|
10507
10496
|
"application/json": {
|
|
10508
10497
|
/**
|
|
10509
10498
|
* Format: uuid
|
|
10510
|
-
* @description The
|
|
10499
|
+
* @description The team ID
|
|
10511
10500
|
*/
|
|
10512
|
-
|
|
10513
|
-
/** @description
|
|
10514
|
-
|
|
10501
|
+
teamId: string;
|
|
10502
|
+
/** @description The property type to remove the editor from */
|
|
10503
|
+
propertyType: string;
|
|
10504
|
+
/**
|
|
10505
|
+
* @description The hook to remove the editor from
|
|
10506
|
+
* @enum {string}
|
|
10507
|
+
*/
|
|
10508
|
+
hook: "createAIEdit" | "afterAIEdit";
|
|
10515
10509
|
};
|
|
10516
10510
|
};
|
|
10517
10511
|
};
|
|
10518
10512
|
responses: {
|
|
10519
|
-
/** @description
|
|
10513
|
+
/** @description Delete successful */
|
|
10520
10514
|
204: {
|
|
10521
10515
|
headers: {
|
|
10522
10516
|
[name: string]: unknown;
|
|
10523
10517
|
};
|
|
10524
|
-
content
|
|
10525
|
-
"application/json": string;
|
|
10526
|
-
};
|
|
10518
|
+
content?: never;
|
|
10527
10519
|
};
|
|
10528
10520
|
400: components$8["responses"]["BadRequestError"];
|
|
10529
10521
|
401: components$8["responses"]["UnauthorizedError"];
|
|
10530
10522
|
403: components$8["responses"]["ForbiddenError"];
|
|
10523
|
+
/** @description Property type/hook did not exist, nothing deleted. */
|
|
10524
|
+
404: {
|
|
10525
|
+
headers: {
|
|
10526
|
+
[name: string]: unknown;
|
|
10527
|
+
};
|
|
10528
|
+
content?: never;
|
|
10529
|
+
};
|
|
10531
10530
|
429: components$8["responses"]["RateLimitError"];
|
|
10532
10531
|
500: components$8["responses"]["InternalServerError"];
|
|
10532
|
+
/** @description Internal error */
|
|
10533
|
+
502: {
|
|
10534
|
+
headers: {
|
|
10535
|
+
[name: string]: unknown;
|
|
10536
|
+
};
|
|
10537
|
+
content?: never;
|
|
10538
|
+
};
|
|
10533
10539
|
};
|
|
10534
10540
|
};
|
|
10535
10541
|
/** @description Handles preflight requests. This endpoint allows CORS. */
|
|
@@ -10612,11 +10618,16 @@ interface components$8 {
|
|
|
10612
10618
|
pathItems: never;
|
|
10613
10619
|
}
|
|
10614
10620
|
|
|
10615
|
-
type
|
|
10616
|
-
|
|
10617
|
-
|
|
10618
|
-
type
|
|
10619
|
-
type
|
|
10621
|
+
type IntegrationPropertyEditorsGetParameters = {
|
|
10622
|
+
teamId: string;
|
|
10623
|
+
};
|
|
10624
|
+
type IntegrationPropertyEditorsGetResponse = paths$8['/api/v1/integration-property-editors']['get']['responses']['200']['content']['application/json'];
|
|
10625
|
+
type IntegrationPropertyEditorsPutParameters = paths$8['/api/v1/integration-property-editors']['put']['requestBody']['content']['application/json'];
|
|
10626
|
+
type IntegrationPropertyEditorsDeleteParameters = paths$8['/api/v1/integration-property-editors']['delete']['requestBody']['content']['application/json'];
|
|
10627
|
+
|
|
10628
|
+
type schemas = components$a['schemas'];
|
|
10629
|
+
type InvalidationPayload = schemas['InvalidationPayload'];
|
|
10630
|
+
type BatchInvalidationPayload = schemas['BatchInvalidationPayload'];
|
|
10620
10631
|
|
|
10621
10632
|
interface AssetParamConfig extends ParamTypeConfigConventions {
|
|
10622
10633
|
min?: number;
|
|
@@ -12851,12 +12862,42 @@ declare class IntegrationPropertyEditorsClient extends ApiClient<IntegrationProp
|
|
|
12851
12862
|
delete(body: ExceptTeam<IntegrationPropertyEditorsDeleteParameters>): Promise<void>;
|
|
12852
12863
|
}
|
|
12853
12864
|
|
|
12865
|
+
declare class LabelClient extends ApiClient {
|
|
12866
|
+
/** Fetches labels for the current project. */
|
|
12867
|
+
getLabels(options?: Omit<LabelsQuery, 'projectId'>): Promise<{
|
|
12868
|
+
labels: {
|
|
12869
|
+
projectId: string;
|
|
12870
|
+
label: {
|
|
12871
|
+
publicId: string;
|
|
12872
|
+
displayName: string;
|
|
12873
|
+
isGroup: boolean;
|
|
12874
|
+
parent?: string;
|
|
12875
|
+
color: string;
|
|
12876
|
+
description?: string;
|
|
12877
|
+
scope: string[];
|
|
12878
|
+
};
|
|
12879
|
+
created: string;
|
|
12880
|
+
modified: string;
|
|
12881
|
+
createdBy?: string;
|
|
12882
|
+
modifiedBy?: string;
|
|
12883
|
+
}[];
|
|
12884
|
+
totalCount: number;
|
|
12885
|
+
}>;
|
|
12886
|
+
/** Updates or creates a label. */
|
|
12887
|
+
upsertLabel(body: Omit<LabelPut, 'projectId'>): Promise<void>;
|
|
12888
|
+
/** Deletes a label by id. */
|
|
12889
|
+
removeLabel(options: Omit<LabelDelete, 'projectId'>): Promise<void>;
|
|
12890
|
+
}
|
|
12891
|
+
declare class UncachedLabelClient extends LabelClient {
|
|
12892
|
+
constructor(options: Omit<ClientOptions, 'bypassCache'>);
|
|
12893
|
+
}
|
|
12894
|
+
|
|
12854
12895
|
/** API client to enable managing project locales */
|
|
12855
12896
|
declare class LocaleClient extends ApiClient {
|
|
12856
12897
|
constructor(options: ClientOptions);
|
|
12857
12898
|
/** Fetches all locales for a project */
|
|
12858
12899
|
get(options?: ExceptProject<LocalesGetParameters>): Promise<{
|
|
12859
|
-
results: components$
|
|
12900
|
+
results: components$e["schemas"]["Locale"][];
|
|
12860
12901
|
}>;
|
|
12861
12902
|
/** Updates or creates (based on id) a locale */
|
|
12862
12903
|
upsert(body: ExceptProject<LocalePutParameters>): Promise<void>;
|
|
@@ -13979,4 +14020,4 @@ declare class WorkflowClient extends ApiClient {
|
|
|
13979
14020
|
|
|
13980
14021
|
declare const CanvasClientError: typeof ApiClientError;
|
|
13981
14022
|
|
|
13982
|
-
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 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, 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, type CompositionFilters, type CompositionGetByComponentIdParameters, type CompositionGetByIdParameters, type CompositionGetByNodeIdParameters, type CompositionGetByNodePathParameters, type CompositionGetBySlugParameters, type CompositionGetListResponse, type CompositionGetParameters, type CompositionGetResponse, type CompositionGetValidResponses, type CompositionPutParameters, type CompositionResolvedGetResponse, type CompositionResolvedListResponse, type CompositionUIStatus, ContentClient, type ContentType, 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, type EntryFilters, type EntryList, type EvaluateCriteriaGroupOptions, type EvaluateNodeTreeVisibilityOptions, type EvaluateNodeVisibilityParameterOptions, type EvaluatePropertyCriteriaOptions, type EvaluateWalkTreePropertyCriteriaOptions, 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, type LabelPut, type LabelsQuery, type LabelsResponse, type LimitPolicy, type LinkParamConfiguration, type LinkParamValue, type LinkParameterType, type LinkTypeConfiguration, type Locale, LocaleClient, type LocaleDeleteParameters, type LocalePutParameters, type LocalesGetParameters, type LocalesGetResponse, type LocalizeOptions, 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 Prompt, PromptClient, type PromptsDeleteParameters, type PromptsGetParameters, type PromptsGetResponse, type PromptsPutParameters, type PropertyCriteriaMatch, type PropertyValue, type PutContentTypeBody, type PutEntryBody, 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, type SelectComponentMessage, type SelectParamConfiguration, type SelectParamEditorType, type SelectParamOption, type SelectParamValue, type SelectParameterMessage, type SendPageHtmlMessage, type SpecificProjectMap, type StringOperators, type SuggestComponentMessage, type TextParamConfig, type TextParamValue, type TreeNodeInfoTypes, type TriggerComponentActionMessage, type TriggerCompositionActionMessage, UncachedCanvasClient, UncachedCategoryClient, UncachedContentClient, UniqueBatchEntries, type UpdateAiActionsMessage, type UpdateComponentParameterMessage, type UpdateComponentReferencesMessage, type UpdateCompositionInternalMessage, type UpdateCompositionMessage, type UpdateCompositionOptions, type UpdateContextualEditingStateInternalMessage, type UpdateFeatureFlagsMessage, type UpdatePreviewSettingsMessage, type UpsertEntryOptions, 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, isComponentActionMessage, isComponentPlaceholderId, isContextStorageUpdatedMessage, isDismissPlaceholderMessage, isEntryData, isLinkParamValue, isMovingComponentMessage, isNestedNodeType, isOpenParameterEditorMessage, isReadyMessage, isReportRenderedCompositionsMessage, isRequestComponentSuggestionMessage, isRootEntryReference, isSelectComponentMessage, isSelectParameterMessage, isSuggestComponentMessage, isSystemComponentDefinition, isTriggerCompositionActionMessage, isUpdateAiActionsMessage, isUpdateComponentParameterMessage, isUpdateComponentReferencesMessage, isUpdateCompositionInternalMessage, isUpdateCompositionMessage, isUpdateContextualEditingStateInternalMessage, isUpdateFeatureFlagsMessage, isUpdatePreviewSettingsMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, mergeAssetConfigWithDefaults, nullLimitPolicy, parseComponentPlaceholderId, parseVariableExpression, version, walkNodeTree, walkPropertyValues };
|
|
14023
|
+
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 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, 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, type CompositionFilters, type CompositionGetByComponentIdParameters, type CompositionGetByIdParameters, type CompositionGetByNodeIdParameters, type CompositionGetByNodePathParameters, type CompositionGetBySlugParameters, type CompositionGetListResponse, type CompositionGetParameters, type CompositionGetResponse, type CompositionGetValidResponses, type CompositionPutParameters, type CompositionResolvedGetResponse, type CompositionResolvedListResponse, type CompositionUIStatus, ContentClient, type ContentType, 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, type EntryFilters, type EntryList, type EvaluateCriteriaGroupOptions, type EvaluateNodeTreeVisibilityOptions, type EvaluateNodeVisibilityParameterOptions, type EvaluatePropertyCriteriaOptions, type EvaluateWalkTreePropertyCriteriaOptions, 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$8 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 Locale, LocaleClient, type LocaleDeleteParameters, type LocalePutParameters, type LocalesGetParameters, type LocalesGetResponse, type LocalizeOptions, 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 Prompt, PromptClient, type PromptsDeleteParameters, type PromptsGetParameters, type PromptsGetResponse, type PromptsPutParameters, type PropertyCriteriaMatch, type PropertyValue, type PutContentTypeBody, type PutEntryBody, 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, type SelectComponentMessage, type SelectParamConfiguration, type SelectParamEditorType, type SelectParamOption, type SelectParamValue, type SelectParameterMessage, type SendPageHtmlMessage, 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 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, isComponentActionMessage, isComponentPlaceholderId, isContextStorageUpdatedMessage, isDismissPlaceholderMessage, isEntryData, isLinkParamValue, isMovingComponentMessage, isNestedNodeType, isOpenParameterEditorMessage, isReadyMessage, isReportRenderedCompositionsMessage, isRequestComponentSuggestionMessage, isRootEntryReference, isSelectComponentMessage, isSelectParameterMessage, isSuggestComponentMessage, isSystemComponentDefinition, isTriggerCompositionActionMessage, isUpdateAiActionsMessage, isUpdateComponentParameterMessage, isUpdateComponentReferencesMessage, isUpdateCompositionInternalMessage, isUpdateCompositionMessage, isUpdateContextualEditingStateInternalMessage, isUpdateFeatureFlagsMessage, isUpdatePreviewSettingsMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, mergeAssetConfigWithDefaults, nullLimitPolicy, parseComponentPlaceholderId, parseVariableExpression, version, walkNodeTree, walkPropertyValues };
|