@uniformdev/canvas 20.80.0 → 20.80.1-alpha.3.sha-1a5ce5809e
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 +770 -485
- package/dist/index.d.ts +770 -485
- package/package.json +5 -5
package/dist/index.d.ts
CHANGED
|
@@ -8,7 +8,7 @@ import { Options as Options$1 } from 'p-retry';
|
|
|
8
8
|
import { Options } from 'p-throttle';
|
|
9
9
|
import { LinkAttributesConfiguration, RichTextBuiltInElement as RichTextBuiltInElement$1, RichTextBuiltInFormat as RichTextBuiltInFormat$1, RichTextParamConfiguration as RichTextParamConfiguration$1, ParameterRichTextValue } from '@uniformdev/richtext';
|
|
10
10
|
|
|
11
|
-
interface paths$
|
|
11
|
+
interface paths$o {
|
|
12
12
|
"/api/v1/categories": {
|
|
13
13
|
parameters: {
|
|
14
14
|
query?: never;
|
|
@@ -34,15 +34,15 @@ interface paths$n {
|
|
|
34
34
|
};
|
|
35
35
|
content: {
|
|
36
36
|
"application/json": {
|
|
37
|
-
categories: components$
|
|
37
|
+
categories: components$s["schemas"]["Category"][];
|
|
38
38
|
};
|
|
39
39
|
};
|
|
40
40
|
};
|
|
41
|
-
400: components$
|
|
42
|
-
401: components$
|
|
43
|
-
403: components$
|
|
44
|
-
429: components$
|
|
45
|
-
500: components$
|
|
41
|
+
400: components$s["responses"]["BadRequestError"];
|
|
42
|
+
401: components$s["responses"]["UnauthorizedError"];
|
|
43
|
+
403: components$s["responses"]["ForbiddenError"];
|
|
44
|
+
429: components$s["responses"]["RateLimitError"];
|
|
45
|
+
500: components$s["responses"]["InternalServerError"];
|
|
46
46
|
};
|
|
47
47
|
};
|
|
48
48
|
put: {
|
|
@@ -57,7 +57,7 @@ interface paths$n {
|
|
|
57
57
|
"application/json": {
|
|
58
58
|
/** Format: uuid */
|
|
59
59
|
projectId: string;
|
|
60
|
-
categories: components$
|
|
60
|
+
categories: components$s["schemas"]["Category"][];
|
|
61
61
|
};
|
|
62
62
|
};
|
|
63
63
|
};
|
|
@@ -69,11 +69,11 @@ interface paths$n {
|
|
|
69
69
|
};
|
|
70
70
|
content?: never;
|
|
71
71
|
};
|
|
72
|
-
400: components$
|
|
73
|
-
401: components$
|
|
74
|
-
403: components$
|
|
75
|
-
429: components$
|
|
76
|
-
500: components$
|
|
72
|
+
400: components$s["responses"]["BadRequestError"];
|
|
73
|
+
401: components$s["responses"]["UnauthorizedError"];
|
|
74
|
+
403: components$s["responses"]["ForbiddenError"];
|
|
75
|
+
429: components$s["responses"]["RateLimitError"];
|
|
76
|
+
500: components$s["responses"]["InternalServerError"];
|
|
77
77
|
};
|
|
78
78
|
};
|
|
79
79
|
post?: never;
|
|
@@ -102,11 +102,11 @@ interface paths$n {
|
|
|
102
102
|
};
|
|
103
103
|
content?: never;
|
|
104
104
|
};
|
|
105
|
-
400: components$
|
|
106
|
-
401: components$
|
|
107
|
-
403: components$
|
|
108
|
-
429: components$
|
|
109
|
-
500: components$
|
|
105
|
+
400: components$s["responses"]["BadRequestError"];
|
|
106
|
+
401: components$s["responses"]["UnauthorizedError"];
|
|
107
|
+
403: components$s["responses"]["ForbiddenError"];
|
|
108
|
+
429: components$s["responses"]["RateLimitError"];
|
|
109
|
+
500: components$s["responses"]["InternalServerError"];
|
|
110
110
|
};
|
|
111
111
|
};
|
|
112
112
|
options?: never;
|
|
@@ -115,7 +115,7 @@ interface paths$n {
|
|
|
115
115
|
trace?: never;
|
|
116
116
|
};
|
|
117
117
|
}
|
|
118
|
-
interface components$
|
|
118
|
+
interface components$s {
|
|
119
119
|
schemas: {
|
|
120
120
|
/** Category for tagging canvas entities */
|
|
121
121
|
Category: {
|
|
@@ -144,7 +144,7 @@ interface components$r {
|
|
|
144
144
|
[name: string]: unknown;
|
|
145
145
|
};
|
|
146
146
|
content: {
|
|
147
|
-
"application/json": components$
|
|
147
|
+
"application/json": components$s["schemas"]["Error"];
|
|
148
148
|
};
|
|
149
149
|
};
|
|
150
150
|
/** API key or token was not valid */
|
|
@@ -153,7 +153,7 @@ interface components$r {
|
|
|
153
153
|
[name: string]: unknown;
|
|
154
154
|
};
|
|
155
155
|
content: {
|
|
156
|
-
"application/json": components$
|
|
156
|
+
"application/json": components$s["schemas"]["Error"];
|
|
157
157
|
};
|
|
158
158
|
};
|
|
159
159
|
/** Permission was denied */
|
|
@@ -162,7 +162,7 @@ interface components$r {
|
|
|
162
162
|
[name: string]: unknown;
|
|
163
163
|
};
|
|
164
164
|
content: {
|
|
165
|
-
"application/json": components$
|
|
165
|
+
"application/json": components$s["schemas"]["Error"];
|
|
166
166
|
};
|
|
167
167
|
};
|
|
168
168
|
/** Too many requests in allowed time period */
|
|
@@ -186,13 +186,13 @@ interface components$r {
|
|
|
186
186
|
pathItems: never;
|
|
187
187
|
}
|
|
188
188
|
|
|
189
|
-
interface components$
|
|
189
|
+
interface components$r {
|
|
190
190
|
schemas: {
|
|
191
191
|
/** Public ID (used in code). Do not change after creation */
|
|
192
192
|
PublicIdProperty: string;
|
|
193
193
|
/** The definition of a component parameter */
|
|
194
194
|
ComponentDefinitionParameter: {
|
|
195
|
-
id: components$
|
|
195
|
+
id: components$r["schemas"]["PublicIdProperty"];
|
|
196
196
|
/** Friendly name of the parameter */
|
|
197
197
|
name: string;
|
|
198
198
|
/** Appears next to the parameter in the Composition editor */
|
|
@@ -226,7 +226,7 @@ interface components$q {
|
|
|
226
226
|
};
|
|
227
227
|
/** The definition of a named component slot that can contain other components */
|
|
228
228
|
ComponentDefinitionSlot: {
|
|
229
|
-
id: components$
|
|
229
|
+
id: components$r["schemas"]["PublicIdProperty"];
|
|
230
230
|
/** Friendly name of the slot */
|
|
231
231
|
name: string;
|
|
232
232
|
/** A list of component definition public IDs that are allowed in this named slot */
|
|
@@ -281,13 +281,13 @@ interface components$q {
|
|
|
281
281
|
};
|
|
282
282
|
/** The definition of a component variant */
|
|
283
283
|
ComponentDefinitionVariant: {
|
|
284
|
-
id: components$
|
|
284
|
+
id: components$r["schemas"]["PublicIdProperty"];
|
|
285
285
|
/** Friendly name of the variant */
|
|
286
286
|
name: string;
|
|
287
287
|
};
|
|
288
288
|
/** Permission set for a component definition */
|
|
289
289
|
ComponentDefinitionPermission: {
|
|
290
|
-
roleId: components$
|
|
290
|
+
roleId: components$r["schemas"]["PublicIdProperty"];
|
|
291
291
|
/**
|
|
292
292
|
* Permission type for this permission ComponentDefinition:
|
|
293
293
|
* read | write | create | delete
|
|
@@ -299,7 +299,7 @@ interface components$q {
|
|
|
299
299
|
};
|
|
300
300
|
/** Defines a component type that can live on a Composition */
|
|
301
301
|
ComponentDefinition: {
|
|
302
|
-
id: components$
|
|
302
|
+
id: components$r["schemas"]["PublicIdProperty"];
|
|
303
303
|
/** Friendly name of the component definition */
|
|
304
304
|
name: string;
|
|
305
305
|
/**
|
|
@@ -324,7 +324,7 @@ interface components$q {
|
|
|
324
324
|
*/
|
|
325
325
|
canBeComposition?: boolean;
|
|
326
326
|
/** The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries */
|
|
327
|
-
parameters?: components$
|
|
327
|
+
parameters?: components$r["schemas"]["ComponentDefinitionParameter"][];
|
|
328
328
|
/**
|
|
329
329
|
* Format: uuid
|
|
330
330
|
* Reference to the category this component definition belongs to
|
|
@@ -341,14 +341,14 @@ interface components$q {
|
|
|
341
341
|
*/
|
|
342
342
|
useTeamPermissions?: boolean;
|
|
343
343
|
/** Custom role permissions for this component definition */
|
|
344
|
-
permissions?: components$
|
|
344
|
+
permissions?: components$r["schemas"]["ComponentDefinitionPermission"][];
|
|
345
345
|
/** The named slots for this component; placement areas where arrays of other components can be added */
|
|
346
|
-
slots?: components$
|
|
347
|
-
slugSettings?: components$
|
|
346
|
+
slots?: components$r["schemas"]["ComponentDefinitionSlot"][];
|
|
347
|
+
slugSettings?: components$r["schemas"]["ComponentDefinitionSlugSettings"];
|
|
348
348
|
/** Default component instance value */
|
|
349
|
-
defaults?: components$
|
|
349
|
+
defaults?: components$r["schemas"]["ComponentInstance"] | null;
|
|
350
350
|
/** Named variants for this component; enables the creation of visual variants that use the same parameter data */
|
|
351
|
-
variants?: components$
|
|
351
|
+
variants?: components$r["schemas"]["ComponentDefinitionVariant"][];
|
|
352
352
|
/** Created date string for this definition (ignored for writes) */
|
|
353
353
|
created?: string;
|
|
354
354
|
/** Last modified date string for this definition (ignored for writes) */
|
|
@@ -361,7 +361,7 @@ interface components$q {
|
|
|
361
361
|
};
|
|
362
362
|
/** Defines a content type */
|
|
363
363
|
ContentType: {
|
|
364
|
-
id: components$
|
|
364
|
+
id: components$r["schemas"]["PublicIdProperty"];
|
|
365
365
|
/** Friendly name of the content type */
|
|
366
366
|
name: string;
|
|
367
367
|
/**
|
|
@@ -375,7 +375,7 @@ interface components$q {
|
|
|
375
375
|
*/
|
|
376
376
|
thumbnailField?: string | null;
|
|
377
377
|
/** The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
|
|
378
|
-
fields?: components$
|
|
378
|
+
fields?: components$r["schemas"]["ComponentDefinitionParameter"][];
|
|
379
379
|
/** Description of the content type */
|
|
380
380
|
description?: string;
|
|
381
381
|
/**
|
|
@@ -387,7 +387,7 @@ interface components$q {
|
|
|
387
387
|
created?: string;
|
|
388
388
|
/** Last modified date string for this content type (ignored for writes) */
|
|
389
389
|
updated?: string;
|
|
390
|
-
slugSettings?: components$
|
|
390
|
+
slugSettings?: components$r["schemas"]["ComponentDefinitionSlugSettings"];
|
|
391
391
|
/**
|
|
392
392
|
* The definition type of this content type (block or content type)
|
|
393
393
|
* @defaultValue contentType
|
|
@@ -400,14 +400,14 @@ interface components$q {
|
|
|
400
400
|
*/
|
|
401
401
|
useTeamPermissions?: boolean;
|
|
402
402
|
/** Custom role permissions for this content type */
|
|
403
|
-
permissions?: components$
|
|
403
|
+
permissions?: components$r["schemas"]["ComponentDefinitionPermission"][];
|
|
404
404
|
/**
|
|
405
405
|
* Format: uuid
|
|
406
406
|
* ID of the workflow that instances of this content type will use by default. When not set, no workflow is attached
|
|
407
407
|
*/
|
|
408
408
|
workflowId?: string;
|
|
409
409
|
/** Configurations for previewing an entry on a consuming pattern or composition. */
|
|
410
|
-
previewConfigurations?: components$
|
|
410
|
+
previewConfigurations?: components$r["schemas"]["ContentTypePreviewConfiguration"][];
|
|
411
411
|
};
|
|
412
412
|
/** Defines a configuration for previewing an entry on a consuming pattern or composition. */
|
|
413
413
|
ContentTypePreviewConfiguration: {
|
|
@@ -435,7 +435,7 @@ interface components$q {
|
|
|
435
435
|
/** The type of the parameter. Determines how it is displayed when editing and tells the consumer how to process it */
|
|
436
436
|
type: string;
|
|
437
437
|
/** @deprecated */
|
|
438
|
-
connectedData?: components$
|
|
438
|
+
connectedData?: components$r["schemas"]["DataElementConnectionDefinition"];
|
|
439
439
|
/**
|
|
440
440
|
* Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
|
|
441
441
|
* Note that locales must be registered on the entry/composition `_locales` before being used
|
|
@@ -443,10 +443,10 @@ interface components$q {
|
|
|
443
443
|
locales?: {
|
|
444
444
|
[key: string]: unknown;
|
|
445
445
|
};
|
|
446
|
-
conditions?: components$
|
|
446
|
+
conditions?: components$r["schemas"]["ComponentParameterConditions"];
|
|
447
447
|
/** Locale-specific conditional values for this parameter. Keys are locale codes, and values are the `conditions` for that locale. */
|
|
448
448
|
localesConditions?: {
|
|
449
|
-
[key: string]: components$
|
|
449
|
+
[key: string]: components$r["schemas"]["ComponentParameterConditions"];
|
|
450
450
|
};
|
|
451
451
|
};
|
|
452
452
|
/**
|
|
@@ -459,10 +459,10 @@ interface components$q {
|
|
|
459
459
|
*
|
|
460
460
|
* When no locale is passed to a non-route API, conditions are not processed and all conditions are returned.
|
|
461
461
|
*/
|
|
462
|
-
ComponentParameterConditions: components$
|
|
462
|
+
ComponentParameterConditions: components$r["schemas"]["ComponentParameterConditionalValue"][];
|
|
463
463
|
/** Defines a conditional value for a component parameter */
|
|
464
464
|
ComponentParameterConditionalValue: {
|
|
465
|
-
when: components$
|
|
465
|
+
when: components$r["schemas"]["VisibilityCriteriaGroup"];
|
|
466
466
|
/**
|
|
467
467
|
* The value of the parameter. Any JSON-serializable value is acceptable.
|
|
468
468
|
* A value of `null` will cause the parameter value to be removed, if it matches.
|
|
@@ -484,7 +484,7 @@ interface components$q {
|
|
|
484
484
|
|
|
485
485
|
*/
|
|
486
486
|
op?: "&" | "|";
|
|
487
|
-
clauses: (components$
|
|
487
|
+
clauses: (components$r["schemas"]["VisibilityCriteria"] | components$r["schemas"]["VisibilityCriteriaGroup"])[];
|
|
488
488
|
};
|
|
489
489
|
/**
|
|
490
490
|
* @deprecated
|
|
@@ -546,13 +546,13 @@ interface components$q {
|
|
|
546
546
|
type: string;
|
|
547
547
|
/** Component parameter values for the component instance */
|
|
548
548
|
parameters?: {
|
|
549
|
-
[key: string]: components$
|
|
549
|
+
[key: string]: components$r["schemas"]["ComponentParameter"];
|
|
550
550
|
};
|
|
551
551
|
/** Public ID of alternate visual appearance for this component, if any selected */
|
|
552
552
|
variant?: string;
|
|
553
553
|
/** Slots containing any child components */
|
|
554
554
|
slots?: {
|
|
555
|
-
[key: string]: components$
|
|
555
|
+
[key: string]: components$r["schemas"]["ComponentInstance"][];
|
|
556
556
|
};
|
|
557
557
|
/**
|
|
558
558
|
* Unique identifier of the component within the composition.
|
|
@@ -563,20 +563,20 @@ interface components$q {
|
|
|
563
563
|
_id?: string;
|
|
564
564
|
/** Indicates this component instance should be sourced from a pattern library pattern */
|
|
565
565
|
_pattern?: string;
|
|
566
|
-
_dataResources?: components$
|
|
566
|
+
_dataResources?: components$r["schemas"]["DataResourceDefinitions"];
|
|
567
567
|
/**
|
|
568
568
|
* Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
|
569
569
|
* Means nothing for PUTs; it will be ignored
|
|
570
570
|
*/
|
|
571
571
|
_patternDataResources?: {
|
|
572
|
-
[key: string]: components$
|
|
572
|
+
[key: string]: components$r["schemas"]["DataResourceDefinition"];
|
|
573
573
|
};
|
|
574
574
|
/**
|
|
575
575
|
* Query-string opt-ins coming from a pattern resolved for this component.
|
|
576
576
|
* Means nothing for PUTs; it will be ignored
|
|
577
577
|
*/
|
|
578
578
|
_patternOptedInQueryStrings?: string[];
|
|
579
|
-
_patternError?: components$
|
|
579
|
+
_patternError?: components$r["schemas"]["PatternError"];
|
|
580
580
|
/**
|
|
581
581
|
* Defines patch overrides to component IDs that live in the composition.
|
|
582
582
|
* This can be used to override parameters that are defined on patterns,
|
|
@@ -590,14 +590,14 @@ interface components$q {
|
|
|
590
590
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
591
591
|
*/
|
|
592
592
|
_overrides?: {
|
|
593
|
-
[key: string]: components$
|
|
593
|
+
[key: string]: components$r["schemas"]["ComponentOverride"];
|
|
594
594
|
};
|
|
595
595
|
/**
|
|
596
596
|
* Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
|
|
597
597
|
* Means nothing for PUTs; it will be ignored
|
|
598
598
|
*/
|
|
599
599
|
_patternOverrides?: {
|
|
600
|
-
[key: string]: components$
|
|
600
|
+
[key: string]: components$r["schemas"]["ComponentOverride"];
|
|
601
601
|
};
|
|
602
602
|
/**
|
|
603
603
|
* When used on a pattern, defines how the pattern's parameters may be overridden
|
|
@@ -606,7 +606,7 @@ interface components$q {
|
|
|
606
606
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
607
607
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
608
608
|
*/
|
|
609
|
-
_overridability?: components$
|
|
609
|
+
_overridability?: components$r["schemas"]["ComponentOverridability"];
|
|
610
610
|
/** Array of locales that have data defined. Only set for pattern references or composition defaults */
|
|
611
611
|
_locales?: string[];
|
|
612
612
|
};
|
|
@@ -616,15 +616,15 @@ interface components$q {
|
|
|
616
616
|
type: string;
|
|
617
617
|
/** Component parameter values for the component instance */
|
|
618
618
|
parameters?: {
|
|
619
|
-
[key: string]: components$
|
|
619
|
+
[key: string]: components$r["schemas"]["ComponentParameter"];
|
|
620
620
|
};
|
|
621
621
|
/** Public ID of alternate visual appearance for this component, if any selected */
|
|
622
622
|
variant?: string;
|
|
623
623
|
/** Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated */
|
|
624
|
-
projectMapNodes?: components$
|
|
624
|
+
projectMapNodes?: components$r["schemas"]["CompositionProjectMapNodeInfo"][];
|
|
625
625
|
/** Slots containing any child components */
|
|
626
626
|
slots?: {
|
|
627
|
-
[key: string]: components$
|
|
627
|
+
[key: string]: components$r["schemas"]["ComponentInstance"][];
|
|
628
628
|
};
|
|
629
629
|
/** The ID of the composition */
|
|
630
630
|
_id: string;
|
|
@@ -647,15 +647,15 @@ interface components$q {
|
|
|
647
647
|
* Means nothing for PUTs; it will be ignored
|
|
648
648
|
*/
|
|
649
649
|
_patternDataResources?: {
|
|
650
|
-
[key: string]: components$
|
|
650
|
+
[key: string]: components$r["schemas"]["DataResourceDefinition"];
|
|
651
651
|
};
|
|
652
652
|
/**
|
|
653
653
|
* Query-string opt-ins coming from a pattern resolved for this component.
|
|
654
654
|
* Means nothing for PUTs; it will be ignored
|
|
655
655
|
*/
|
|
656
656
|
_patternOptedInQueryStrings?: string[];
|
|
657
|
-
_dataResources?: components$
|
|
658
|
-
_patternError?: components$
|
|
657
|
+
_dataResources?: components$r["schemas"]["DataResourceDefinitions"];
|
|
658
|
+
_patternError?: components$r["schemas"]["PatternError"];
|
|
659
659
|
/**
|
|
660
660
|
* Defines patch overrides to component IDs that live in the composition.
|
|
661
661
|
* This can be used to override parameters that are defined on patterns,
|
|
@@ -669,14 +669,14 @@ interface components$q {
|
|
|
669
669
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
670
670
|
*/
|
|
671
671
|
_overrides?: {
|
|
672
|
-
[key: string]: components$
|
|
672
|
+
[key: string]: components$r["schemas"]["ComponentOverride"];
|
|
673
673
|
};
|
|
674
674
|
/**
|
|
675
675
|
* Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
|
|
676
676
|
* Means nothing for PUTs; it will be ignored
|
|
677
677
|
*/
|
|
678
678
|
_patternOverrides?: {
|
|
679
|
-
[key: string]: components$
|
|
679
|
+
[key: string]: components$r["schemas"]["ComponentOverride"];
|
|
680
680
|
};
|
|
681
681
|
/**
|
|
682
682
|
* When used on a pattern, defines how the pattern's parameters may be overridden
|
|
@@ -685,7 +685,7 @@ interface components$q {
|
|
|
685
685
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
686
686
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
687
687
|
*/
|
|
688
|
-
_overridability?: components$
|
|
688
|
+
_overridability?: components$r["schemas"]["ComponentOverridability"];
|
|
689
689
|
/** Array of locales which have data defined on the composition. If empty, the current default locale implicitly has data */
|
|
690
690
|
_locales?: string[];
|
|
691
691
|
/**
|
|
@@ -703,10 +703,10 @@ interface components$q {
|
|
|
703
703
|
*/
|
|
704
704
|
ComponentOverride: {
|
|
705
705
|
parameters?: {
|
|
706
|
-
[key: string]: components$
|
|
706
|
+
[key: string]: components$r["schemas"]["ComponentParameter"];
|
|
707
707
|
};
|
|
708
708
|
slots?: {
|
|
709
|
-
[key: string]: components$
|
|
709
|
+
[key: string]: components$r["schemas"]["ComponentInstance"][];
|
|
710
710
|
};
|
|
711
711
|
variant?: string;
|
|
712
712
|
/**
|
|
@@ -715,7 +715,7 @@ interface components$q {
|
|
|
715
715
|
* Overrides defined here replace values in either _dataResources or _patternDataResources on the target component.
|
|
716
716
|
*/
|
|
717
717
|
dataResources?: {
|
|
718
|
-
[key: string]: components$
|
|
718
|
+
[key: string]: components$r["schemas"]["DataResourceDefinition"];
|
|
719
719
|
};
|
|
720
720
|
};
|
|
721
721
|
/**
|
|
@@ -728,7 +728,7 @@ interface components$q {
|
|
|
728
728
|
ComponentOverridability: {
|
|
729
729
|
/** Defines component parameter value overrides. Keys are the parameter public ID */
|
|
730
730
|
parameters?: {
|
|
731
|
-
[key: string]: components$
|
|
731
|
+
[key: string]: components$r["schemas"]["OverrideOptions"];
|
|
732
732
|
};
|
|
733
733
|
/** Allows overriding a display variant is allowed if it is defined on the component the pattern is derived from. Default = false */
|
|
734
734
|
variants?: boolean;
|
|
@@ -765,7 +765,7 @@ interface components$q {
|
|
|
765
765
|
}[];
|
|
766
766
|
/** Variables needed to make calls to the data source */
|
|
767
767
|
variables?: {
|
|
768
|
-
[key: string]: components$
|
|
768
|
+
[key: string]: components$r["schemas"]["DataVariableDefinition"];
|
|
769
769
|
};
|
|
770
770
|
};
|
|
771
771
|
/**
|
|
@@ -795,7 +795,7 @@ interface components$q {
|
|
|
795
795
|
}[];
|
|
796
796
|
/** Variables needed to make calls to the data source */
|
|
797
797
|
variables?: {
|
|
798
|
-
[key: string]: components$
|
|
798
|
+
[key: string]: components$r["schemas"]["DataVariableDefinition"];
|
|
799
799
|
};
|
|
800
800
|
/**
|
|
801
801
|
* Mapping of locale codes to data source locale codes. Keys are Uniform locale codes, values are data source locale codes.
|
|
@@ -819,7 +819,7 @@ interface components$q {
|
|
|
819
819
|
};
|
|
820
820
|
/** Different connector detail variants to use in the different contexts like e.g. Unpublished Data */
|
|
821
821
|
variants?: {
|
|
822
|
-
unpublished?: components$
|
|
822
|
+
unpublished?: components$r["schemas"]["AlternativeDataSourceData"];
|
|
823
823
|
};
|
|
824
824
|
/** Created date of the data source in ISO 8601 format (ignored for writes) */
|
|
825
825
|
created?: string;
|
|
@@ -875,7 +875,7 @@ interface components$q {
|
|
|
875
875
|
method: "GET" | "POST" | "HEAD";
|
|
876
876
|
/** Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys */
|
|
877
877
|
variables?: {
|
|
878
|
-
[key: string]: components$
|
|
878
|
+
[key: string]: components$r["schemas"]["DataVariableDefinition"];
|
|
879
879
|
};
|
|
880
880
|
/** Custom configuration specific to the data source being defined */
|
|
881
881
|
custom?: {
|
|
@@ -916,7 +916,7 @@ interface components$q {
|
|
|
916
916
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key)
|
|
917
917
|
*/
|
|
918
918
|
DataResourceDefinitions: {
|
|
919
|
-
[key: string]: components$
|
|
919
|
+
[key: string]: components$r["schemas"]["DataResourceDefinition"];
|
|
920
920
|
};
|
|
921
921
|
/** Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
|
|
922
922
|
DataResourceDefinition: {
|
|
@@ -935,7 +935,7 @@ interface components$q {
|
|
|
935
935
|
* If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
|
|
936
936
|
*/
|
|
937
937
|
optionalPatternParameter?: boolean;
|
|
938
|
-
variables?: components$
|
|
938
|
+
variables?: components$r["schemas"]["DataResourceVariables"];
|
|
939
939
|
};
|
|
940
940
|
/** Variable values for a data resource */
|
|
941
941
|
DataResourceVariables: {
|
|
@@ -958,7 +958,7 @@ interface components$q {
|
|
|
958
958
|
/** If more history is available than your plan allows, and additional entries are available by upgrading, this will be true */
|
|
959
959
|
truncated?: boolean;
|
|
960
960
|
/** Version history entries */
|
|
961
|
-
results?: components$
|
|
961
|
+
results?: components$r["schemas"]["HistoryEntry"][];
|
|
962
962
|
};
|
|
963
963
|
HistoryEntry: {
|
|
964
964
|
/** The version ID of the entity. This can be used to fetch the version's data via the entity API */
|
|
@@ -1005,7 +1005,7 @@ interface components$q {
|
|
|
1005
1005
|
* Unique identifier for the project map that this node belongs to
|
|
1006
1006
|
*/
|
|
1007
1007
|
projectMapId: string;
|
|
1008
|
-
data?: components$
|
|
1008
|
+
data?: components$r["schemas"]["ProjectMapNodeData"];
|
|
1009
1009
|
/**
|
|
1010
1010
|
* Locale-specific paths of the project map node.
|
|
1011
1011
|
* Keys are locale codes
|
|
@@ -1059,7 +1059,7 @@ interface components$q {
|
|
|
1059
1059
|
initialStage: string;
|
|
1060
1060
|
/** All stages of the workflow */
|
|
1061
1061
|
stages: {
|
|
1062
|
-
[key: string]: components$
|
|
1062
|
+
[key: string]: components$r["schemas"]["WorkflowStage"];
|
|
1063
1063
|
};
|
|
1064
1064
|
/** Last modified ISO date string for this definition (ignored for writes) */
|
|
1065
1065
|
modified?: string;
|
|
@@ -1089,7 +1089,7 @@ interface components$q {
|
|
|
1089
1089
|
* listed here, the stage is read-only and publishing is disabled
|
|
1090
1090
|
*/
|
|
1091
1091
|
permissions: {
|
|
1092
|
-
[key: string]: components$
|
|
1092
|
+
[key: string]: components$r["schemas"]["WorkflowStagePermission"];
|
|
1093
1093
|
};
|
|
1094
1094
|
/**
|
|
1095
1095
|
* When true, transitioning into this stage from a different stage will automatically publish the entity.
|
|
@@ -1109,7 +1109,7 @@ interface components$q {
|
|
|
1109
1109
|
* Every stage must define at least one transition, to avoid creating a workflow that
|
|
1110
1110
|
* has a stage that can never be escaped
|
|
1111
1111
|
*/
|
|
1112
|
-
transitions: components$
|
|
1112
|
+
transitions: components$r["schemas"]["WorkflowStageTransition"][];
|
|
1113
1113
|
/**
|
|
1114
1114
|
* Icon name for the stage (e.g. 'chevron-double-right-o')
|
|
1115
1115
|
* @defaultValue chevron-double-right-o
|
|
@@ -1135,7 +1135,7 @@ interface components$q {
|
|
|
1135
1135
|
* NOTE: Users without membership in any role listed here will be unable to execute the transition unless they are team admins
|
|
1136
1136
|
*/
|
|
1137
1137
|
permissions: {
|
|
1138
|
-
[key: string]: components$
|
|
1138
|
+
[key: string]: components$r["schemas"]["WorkflowStageTransitionPermission"];
|
|
1139
1139
|
};
|
|
1140
1140
|
};
|
|
1141
1141
|
/** Permissions for a workflow stage */
|
|
@@ -1186,7 +1186,7 @@ interface components$q {
|
|
|
1186
1186
|
/** 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 */
|
|
1187
1187
|
isSearchHit?: boolean;
|
|
1188
1188
|
/** Query strings that are allowed to be passed to the node */
|
|
1189
|
-
queryStrings?: components$
|
|
1189
|
+
queryStrings?: components$r["schemas"]["ProjectMapNodeAllowedQueryString"][];
|
|
1190
1190
|
/**
|
|
1191
1191
|
* For dynamic nodes, this is the preview value for the dynamic value.
|
|
1192
1192
|
* The preview value is used when editing a connected composition, and is the default
|
|
@@ -1202,8 +1202,8 @@ interface components$q {
|
|
|
1202
1202
|
pathItems: never;
|
|
1203
1203
|
}
|
|
1204
1204
|
|
|
1205
|
-
type SharedComponents$3 = components$
|
|
1206
|
-
type Api$2 = paths$
|
|
1205
|
+
type SharedComponents$3 = components$r['schemas'];
|
|
1206
|
+
type Api$2 = paths$o['/api/v1/categories'];
|
|
1207
1207
|
/** Shape of the GET response from /api/v1/category */
|
|
1208
1208
|
type CategoriesGetResponse = Api$2['get']['responses']['200']['content']['application/json'];
|
|
1209
1209
|
/** Shape of the PUT request body for /api/v1/category */
|
|
@@ -1219,11 +1219,11 @@ declare class CategoryClient extends ApiClient {
|
|
|
1219
1219
|
constructor(options: ClientOptions);
|
|
1220
1220
|
/** Fetches a list of categories created in given project */
|
|
1221
1221
|
list(options?: Omit<CategoriesGetParameters, 'projectId'>): Promise<{
|
|
1222
|
-
categories: components$
|
|
1222
|
+
categories: components$s["schemas"]["Category"][];
|
|
1223
1223
|
}>;
|
|
1224
1224
|
/** @deprecated Use {@link list} instead. */
|
|
1225
1225
|
getCategories(options?: Omit<CategoriesGetParameters, 'projectId'>): Promise<{
|
|
1226
|
-
categories: components$
|
|
1226
|
+
categories: components$s["schemas"]["Category"][];
|
|
1227
1227
|
}>;
|
|
1228
1228
|
/** Updates or creates a category, also used to re-order them */
|
|
1229
1229
|
save(categories: CategoriesPutParameters['categories']): Promise<unknown>;
|
|
@@ -1239,7 +1239,7 @@ declare class UncachedCategoryClient extends CategoryClient {
|
|
|
1239
1239
|
constructor(options: Omit<ClientOptions, 'bypassCache'>);
|
|
1240
1240
|
}
|
|
1241
1241
|
|
|
1242
|
-
interface paths$
|
|
1242
|
+
interface paths$n {
|
|
1243
1243
|
"/api/v1/canvas-definitions": {
|
|
1244
1244
|
parameters: {
|
|
1245
1245
|
query?: never;
|
|
@@ -1277,15 +1277,15 @@ interface paths$m {
|
|
|
1277
1277
|
content: {
|
|
1278
1278
|
"application/json": {
|
|
1279
1279
|
/** Component definitions that match the query */
|
|
1280
|
-
componentDefinitions: components$
|
|
1280
|
+
componentDefinitions: components$q["schemas"]["ComponentDefinition"][];
|
|
1281
1281
|
};
|
|
1282
1282
|
};
|
|
1283
1283
|
};
|
|
1284
|
-
400: components$
|
|
1285
|
-
401: components$
|
|
1286
|
-
403: components$
|
|
1287
|
-
429: components$
|
|
1288
|
-
500: components$
|
|
1284
|
+
400: components$q["responses"]["BadRequestError"];
|
|
1285
|
+
401: components$q["responses"]["UnauthorizedError"];
|
|
1286
|
+
403: components$q["responses"]["ForbiddenError"];
|
|
1287
|
+
429: components$q["responses"]["RateLimitError"];
|
|
1288
|
+
500: components$q["responses"]["InternalServerError"];
|
|
1289
1289
|
};
|
|
1290
1290
|
};
|
|
1291
1291
|
/** Upserts a component definition */
|
|
@@ -1304,7 +1304,7 @@ interface paths$m {
|
|
|
1304
1304
|
* The project ID to upsert the component definition to
|
|
1305
1305
|
*/
|
|
1306
1306
|
projectId: string;
|
|
1307
|
-
componentDefinition: components$
|
|
1307
|
+
componentDefinition: components$q["schemas"]["ComponentDefinition"];
|
|
1308
1308
|
};
|
|
1309
1309
|
};
|
|
1310
1310
|
};
|
|
@@ -1316,11 +1316,11 @@ interface paths$m {
|
|
|
1316
1316
|
};
|
|
1317
1317
|
content?: never;
|
|
1318
1318
|
};
|
|
1319
|
-
400: components$
|
|
1320
|
-
401: components$
|
|
1321
|
-
403: components$
|
|
1322
|
-
429: components$
|
|
1323
|
-
500: components$
|
|
1319
|
+
400: components$q["responses"]["BadRequestError"];
|
|
1320
|
+
401: components$q["responses"]["UnauthorizedError"];
|
|
1321
|
+
403: components$q["responses"]["ForbiddenError"];
|
|
1322
|
+
429: components$q["responses"]["RateLimitError"];
|
|
1323
|
+
500: components$q["responses"]["InternalServerError"];
|
|
1324
1324
|
};
|
|
1325
1325
|
};
|
|
1326
1326
|
post?: never;
|
|
@@ -1353,11 +1353,11 @@ interface paths$m {
|
|
|
1353
1353
|
};
|
|
1354
1354
|
content?: never;
|
|
1355
1355
|
};
|
|
1356
|
-
400: components$
|
|
1357
|
-
401: components$
|
|
1358
|
-
403: components$
|
|
1359
|
-
429: components$
|
|
1360
|
-
500: components$
|
|
1356
|
+
400: components$q["responses"]["BadRequestError"];
|
|
1357
|
+
401: components$q["responses"]["UnauthorizedError"];
|
|
1358
|
+
403: components$q["responses"]["ForbiddenError"];
|
|
1359
|
+
429: components$q["responses"]["RateLimitError"];
|
|
1360
|
+
500: components$q["responses"]["InternalServerError"];
|
|
1361
1361
|
};
|
|
1362
1362
|
};
|
|
1363
1363
|
/** Handles preflight requests. This endpoint allows CORS */
|
|
@@ -1384,13 +1384,13 @@ interface paths$m {
|
|
|
1384
1384
|
trace?: never;
|
|
1385
1385
|
};
|
|
1386
1386
|
}
|
|
1387
|
-
interface components$
|
|
1387
|
+
interface components$q {
|
|
1388
1388
|
schemas: {
|
|
1389
1389
|
/** Public ID (used in code). Do not change after creation */
|
|
1390
1390
|
PublicIdProperty: string;
|
|
1391
1391
|
/** The definition of a component parameter */
|
|
1392
1392
|
ComponentDefinitionParameter: {
|
|
1393
|
-
id: components$
|
|
1393
|
+
id: components$q["schemas"]["PublicIdProperty"];
|
|
1394
1394
|
/** Friendly name of the parameter */
|
|
1395
1395
|
name: string;
|
|
1396
1396
|
/** Appears next to the parameter in the Composition editor */
|
|
@@ -1424,7 +1424,7 @@ interface components$p {
|
|
|
1424
1424
|
};
|
|
1425
1425
|
/** Permission set for a component definition */
|
|
1426
1426
|
ComponentDefinitionPermission: {
|
|
1427
|
-
roleId: components$
|
|
1427
|
+
roleId: components$q["schemas"]["PublicIdProperty"];
|
|
1428
1428
|
/**
|
|
1429
1429
|
* Permission type for this permission ComponentDefinition:
|
|
1430
1430
|
* read | write | create | delete
|
|
@@ -1436,7 +1436,7 @@ interface components$p {
|
|
|
1436
1436
|
};
|
|
1437
1437
|
/** The definition of a named component slot that can contain other components */
|
|
1438
1438
|
ComponentDefinitionSlot: {
|
|
1439
|
-
id: components$
|
|
1439
|
+
id: components$q["schemas"]["PublicIdProperty"];
|
|
1440
1440
|
/** Friendly name of the slot */
|
|
1441
1441
|
name: string;
|
|
1442
1442
|
/** A list of component definition public IDs that are allowed in this named slot */
|
|
@@ -1553,11 +1553,11 @@ interface components$p {
|
|
|
1553
1553
|
|
|
1554
1554
|
*/
|
|
1555
1555
|
op?: "&" | "|";
|
|
1556
|
-
clauses: (components$
|
|
1556
|
+
clauses: (components$q["schemas"]["VisibilityCriteria"] | components$q["schemas"]["VisibilityCriteriaGroup"])[];
|
|
1557
1557
|
};
|
|
1558
1558
|
/** Defines a conditional value for a component parameter */
|
|
1559
1559
|
ComponentParameterConditionalValue: {
|
|
1560
|
-
when: components$
|
|
1560
|
+
when: components$q["schemas"]["VisibilityCriteriaGroup"];
|
|
1561
1561
|
/**
|
|
1562
1562
|
* The value of the parameter. Any JSON-serializable value is acceptable.
|
|
1563
1563
|
* A value of `null` will cause the parameter value to be removed, if it matches.
|
|
@@ -1579,7 +1579,7 @@ interface components$p {
|
|
|
1579
1579
|
*
|
|
1580
1580
|
* When no locale is passed to a non-route API, conditions are not processed and all conditions are returned.
|
|
1581
1581
|
*/
|
|
1582
|
-
ComponentParameterConditions: components$
|
|
1582
|
+
ComponentParameterConditions: components$q["schemas"]["ComponentParameterConditionalValue"][];
|
|
1583
1583
|
/** Defines an editable parameter on a component */
|
|
1584
1584
|
ComponentParameter: {
|
|
1585
1585
|
/** The value of the parameter. Any JSON-serializable value is acceptable */
|
|
@@ -1587,7 +1587,7 @@ interface components$p {
|
|
|
1587
1587
|
/** The type of the parameter. Determines how it is displayed when editing and tells the consumer how to process it */
|
|
1588
1588
|
type: string;
|
|
1589
1589
|
/** @deprecated */
|
|
1590
|
-
connectedData?: components$
|
|
1590
|
+
connectedData?: components$q["schemas"]["DataElementConnectionDefinition"];
|
|
1591
1591
|
/**
|
|
1592
1592
|
* Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
|
|
1593
1593
|
* Note that locales must be registered on the entry/composition `_locales` before being used
|
|
@@ -1595,10 +1595,10 @@ interface components$p {
|
|
|
1595
1595
|
locales?: {
|
|
1596
1596
|
[key: string]: unknown;
|
|
1597
1597
|
};
|
|
1598
|
-
conditions?: components$
|
|
1598
|
+
conditions?: components$q["schemas"]["ComponentParameterConditions"];
|
|
1599
1599
|
/** Locale-specific conditional values for this parameter. Keys are locale codes, and values are the `conditions` for that locale. */
|
|
1600
1600
|
localesConditions?: {
|
|
1601
|
-
[key: string]: components$
|
|
1601
|
+
[key: string]: components$q["schemas"]["ComponentParameterConditions"];
|
|
1602
1602
|
};
|
|
1603
1603
|
};
|
|
1604
1604
|
/** Defines the shape of a component instance served by the composition API */
|
|
@@ -1607,13 +1607,13 @@ interface components$p {
|
|
|
1607
1607
|
type: string;
|
|
1608
1608
|
/** Component parameter values for the component instance */
|
|
1609
1609
|
parameters?: {
|
|
1610
|
-
[key: string]: components$
|
|
1610
|
+
[key: string]: components$q["schemas"]["ComponentParameter"];
|
|
1611
1611
|
};
|
|
1612
1612
|
/** Public ID of alternate visual appearance for this component, if any selected */
|
|
1613
1613
|
variant?: string;
|
|
1614
1614
|
/** Slots containing any child components */
|
|
1615
1615
|
slots?: {
|
|
1616
|
-
[key: string]: components$
|
|
1616
|
+
[key: string]: components$q["schemas"]["ComponentInstance"][];
|
|
1617
1617
|
};
|
|
1618
1618
|
/**
|
|
1619
1619
|
* Unique identifier of the component within the composition.
|
|
@@ -1624,20 +1624,20 @@ interface components$p {
|
|
|
1624
1624
|
_id?: string;
|
|
1625
1625
|
/** Indicates this component instance should be sourced from a pattern library pattern */
|
|
1626
1626
|
_pattern?: string;
|
|
1627
|
-
_dataResources?: components$
|
|
1627
|
+
_dataResources?: components$q["schemas"]["DataResourceDefinitions"];
|
|
1628
1628
|
/**
|
|
1629
1629
|
* Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
|
1630
1630
|
* Means nothing for PUTs; it will be ignored
|
|
1631
1631
|
*/
|
|
1632
1632
|
_patternDataResources?: {
|
|
1633
|
-
[key: string]: components$
|
|
1633
|
+
[key: string]: components$q["schemas"]["DataResourceDefinition"];
|
|
1634
1634
|
};
|
|
1635
1635
|
/**
|
|
1636
1636
|
* Query-string opt-ins coming from a pattern resolved for this component.
|
|
1637
1637
|
* Means nothing for PUTs; it will be ignored
|
|
1638
1638
|
*/
|
|
1639
1639
|
_patternOptedInQueryStrings?: string[];
|
|
1640
|
-
_patternError?: components$
|
|
1640
|
+
_patternError?: components$q["schemas"]["PatternError"];
|
|
1641
1641
|
/**
|
|
1642
1642
|
* Defines patch overrides to component IDs that live in the composition.
|
|
1643
1643
|
* This can be used to override parameters that are defined on patterns,
|
|
@@ -1651,14 +1651,14 @@ interface components$p {
|
|
|
1651
1651
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
1652
1652
|
*/
|
|
1653
1653
|
_overrides?: {
|
|
1654
|
-
[key: string]: components$
|
|
1654
|
+
[key: string]: components$q["schemas"]["ComponentOverride"];
|
|
1655
1655
|
};
|
|
1656
1656
|
/**
|
|
1657
1657
|
* Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
|
|
1658
1658
|
* Means nothing for PUTs; it will be ignored
|
|
1659
1659
|
*/
|
|
1660
1660
|
_patternOverrides?: {
|
|
1661
|
-
[key: string]: components$
|
|
1661
|
+
[key: string]: components$q["schemas"]["ComponentOverride"];
|
|
1662
1662
|
};
|
|
1663
1663
|
/**
|
|
1664
1664
|
* When used on a pattern, defines how the pattern's parameters may be overridden
|
|
@@ -1667,7 +1667,7 @@ interface components$p {
|
|
|
1667
1667
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
1668
1668
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
1669
1669
|
*/
|
|
1670
|
-
_overridability?: components$
|
|
1670
|
+
_overridability?: components$q["schemas"]["ComponentOverridability"];
|
|
1671
1671
|
/** Array of locales that have data defined. Only set for pattern references or composition defaults */
|
|
1672
1672
|
_locales?: string[];
|
|
1673
1673
|
};
|
|
@@ -1692,14 +1692,14 @@ interface components$p {
|
|
|
1692
1692
|
* If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
|
|
1693
1693
|
*/
|
|
1694
1694
|
optionalPatternParameter?: boolean;
|
|
1695
|
-
variables?: components$
|
|
1695
|
+
variables?: components$q["schemas"]["DataResourceVariables"];
|
|
1696
1696
|
};
|
|
1697
1697
|
/**
|
|
1698
1698
|
* Data definitions attached to this component. The property name is the key of the data in the data document.
|
|
1699
1699
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key)
|
|
1700
1700
|
*/
|
|
1701
1701
|
DataResourceDefinitions: {
|
|
1702
|
-
[key: string]: components$
|
|
1702
|
+
[key: string]: components$q["schemas"]["DataResourceDefinition"];
|
|
1703
1703
|
};
|
|
1704
1704
|
/**
|
|
1705
1705
|
* Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
|
@@ -1717,10 +1717,10 @@ interface components$p {
|
|
|
1717
1717
|
*/
|
|
1718
1718
|
ComponentOverride: {
|
|
1719
1719
|
parameters?: {
|
|
1720
|
-
[key: string]: components$
|
|
1720
|
+
[key: string]: components$q["schemas"]["ComponentParameter"];
|
|
1721
1721
|
};
|
|
1722
1722
|
slots?: {
|
|
1723
|
-
[key: string]: components$
|
|
1723
|
+
[key: string]: components$q["schemas"]["ComponentInstance"][];
|
|
1724
1724
|
};
|
|
1725
1725
|
variant?: string;
|
|
1726
1726
|
/**
|
|
@@ -1729,7 +1729,7 @@ interface components$p {
|
|
|
1729
1729
|
* Overrides defined here replace values in either _dataResources or _patternDataResources on the target component.
|
|
1730
1730
|
*/
|
|
1731
1731
|
dataResources?: {
|
|
1732
|
-
[key: string]: components$
|
|
1732
|
+
[key: string]: components$q["schemas"]["DataResourceDefinition"];
|
|
1733
1733
|
};
|
|
1734
1734
|
};
|
|
1735
1735
|
/**
|
|
@@ -1750,7 +1750,7 @@ interface components$p {
|
|
|
1750
1750
|
ComponentOverridability: {
|
|
1751
1751
|
/** Defines component parameter value overrides. Keys are the parameter public ID */
|
|
1752
1752
|
parameters?: {
|
|
1753
|
-
[key: string]: components$
|
|
1753
|
+
[key: string]: components$q["schemas"]["OverrideOptions"];
|
|
1754
1754
|
};
|
|
1755
1755
|
/** Allows overriding a display variant is allowed if it is defined on the component the pattern is derived from. Default = false */
|
|
1756
1756
|
variants?: boolean;
|
|
@@ -1763,13 +1763,13 @@ interface components$p {
|
|
|
1763
1763
|
};
|
|
1764
1764
|
/** The definition of a component variant */
|
|
1765
1765
|
ComponentDefinitionVariant: {
|
|
1766
|
-
id: components$
|
|
1766
|
+
id: components$q["schemas"]["PublicIdProperty"];
|
|
1767
1767
|
/** Friendly name of the variant */
|
|
1768
1768
|
name: string;
|
|
1769
1769
|
};
|
|
1770
1770
|
/** Defines a component type that can live on a Composition */
|
|
1771
1771
|
ComponentDefinition: {
|
|
1772
|
-
id: components$
|
|
1772
|
+
id: components$q["schemas"]["PublicIdProperty"];
|
|
1773
1773
|
/** Friendly name of the component definition */
|
|
1774
1774
|
name: string;
|
|
1775
1775
|
/**
|
|
@@ -1794,7 +1794,7 @@ interface components$p {
|
|
|
1794
1794
|
*/
|
|
1795
1795
|
canBeComposition?: boolean;
|
|
1796
1796
|
/** The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries */
|
|
1797
|
-
parameters?: components$
|
|
1797
|
+
parameters?: components$q["schemas"]["ComponentDefinitionParameter"][];
|
|
1798
1798
|
/**
|
|
1799
1799
|
* Format: uuid
|
|
1800
1800
|
* Reference to the category this component definition belongs to
|
|
@@ -1811,14 +1811,14 @@ interface components$p {
|
|
|
1811
1811
|
*/
|
|
1812
1812
|
useTeamPermissions?: boolean;
|
|
1813
1813
|
/** Custom role permissions for this component definition */
|
|
1814
|
-
permissions?: components$
|
|
1814
|
+
permissions?: components$q["schemas"]["ComponentDefinitionPermission"][];
|
|
1815
1815
|
/** The named slots for this component; placement areas where arrays of other components can be added */
|
|
1816
|
-
slots?: components$
|
|
1817
|
-
slugSettings?: components$
|
|
1816
|
+
slots?: components$q["schemas"]["ComponentDefinitionSlot"][];
|
|
1817
|
+
slugSettings?: components$q["schemas"]["ComponentDefinitionSlugSettings"];
|
|
1818
1818
|
/** Default component instance value */
|
|
1819
|
-
defaults?: components$
|
|
1819
|
+
defaults?: components$q["schemas"]["ComponentInstance"] | null;
|
|
1820
1820
|
/** Named variants for this component; enables the creation of visual variants that use the same parameter data */
|
|
1821
|
-
variants?: components$
|
|
1821
|
+
variants?: components$q["schemas"]["ComponentDefinitionVariant"][];
|
|
1822
1822
|
/** Created date string for this definition (ignored for writes) */
|
|
1823
1823
|
created?: string;
|
|
1824
1824
|
/** Last modified date string for this definition (ignored for writes) */
|
|
@@ -1841,7 +1841,7 @@ interface components$p {
|
|
|
1841
1841
|
[name: string]: unknown;
|
|
1842
1842
|
};
|
|
1843
1843
|
content: {
|
|
1844
|
-
"application/json": components$
|
|
1844
|
+
"application/json": components$q["schemas"]["Error"];
|
|
1845
1845
|
};
|
|
1846
1846
|
};
|
|
1847
1847
|
/** API key or token was not valid */
|
|
@@ -1850,7 +1850,7 @@ interface components$p {
|
|
|
1850
1850
|
[name: string]: unknown;
|
|
1851
1851
|
};
|
|
1852
1852
|
content: {
|
|
1853
|
-
"application/json": components$
|
|
1853
|
+
"application/json": components$q["schemas"]["Error"];
|
|
1854
1854
|
};
|
|
1855
1855
|
};
|
|
1856
1856
|
/** Permission was denied */
|
|
@@ -1859,7 +1859,7 @@ interface components$p {
|
|
|
1859
1859
|
[name: string]: unknown;
|
|
1860
1860
|
};
|
|
1861
1861
|
content: {
|
|
1862
|
-
"application/json": components$
|
|
1862
|
+
"application/json": components$q["schemas"]["Error"];
|
|
1863
1863
|
};
|
|
1864
1864
|
};
|
|
1865
1865
|
/** Too many requests in allowed time period */
|
|
@@ -1883,8 +1883,8 @@ interface components$p {
|
|
|
1883
1883
|
pathItems: never;
|
|
1884
1884
|
}
|
|
1885
1885
|
|
|
1886
|
-
type SharedComponents$2 = components$
|
|
1887
|
-
type Api$1 = paths$
|
|
1886
|
+
type SharedComponents$2 = components$r['schemas'];
|
|
1887
|
+
type Api$1 = paths$n['/api/v1/canvas-definitions'];
|
|
1888
1888
|
/** Shape of the GET response from /api/v1/canvas-definitions */
|
|
1889
1889
|
type ComponentDefinitionGetResponse = Api$1['get']['responses']['200']['content']['application/json'];
|
|
1890
1890
|
/** Shape of the PUT request body for /api/v1/canvas-definitions */
|
|
@@ -1894,7 +1894,7 @@ type ComponentDefinitionDeleteParameters = Api$1['delete']['requestBody']['conte
|
|
|
1894
1894
|
/** Query parameter options for GET /api/v1/canvas-definitions */
|
|
1895
1895
|
type ComponentDefinitionGetParameters = Api$1['get']['parameters']['query'];
|
|
1896
1896
|
/** The definition of a component parameter */
|
|
1897
|
-
type ComponentDefinitionParameter<TConfig = unknown> = Omit<components$
|
|
1897
|
+
type ComponentDefinitionParameter<TConfig = unknown> = Omit<components$r['schemas']['ComponentDefinitionParameter'], 'typeConfig'> & {
|
|
1898
1898
|
typeConfig?: TConfig;
|
|
1899
1899
|
};
|
|
1900
1900
|
/** The definition of a component visual variant */
|
|
@@ -2045,7 +2045,7 @@ declare const ASSETS_SOURCE_CUSTOM_URL = "custom-url";
|
|
|
2045
2045
|
/** The data type ID for internal content references (entry-to-entry relationships) */
|
|
2046
2046
|
declare const REFERENCE_DATA_TYPE_ID = "uniformContentInternalReference";
|
|
2047
2047
|
|
|
2048
|
-
interface components$
|
|
2048
|
+
interface components$p {
|
|
2049
2049
|
schemas: {
|
|
2050
2050
|
/** Defines the shape of the entry */
|
|
2051
2051
|
Entry: {
|
|
@@ -2076,15 +2076,15 @@ interface components$o {
|
|
|
2076
2076
|
_locales?: string[];
|
|
2077
2077
|
/** Entry field values */
|
|
2078
2078
|
fields?: {
|
|
2079
|
-
[key: string]: components$
|
|
2079
|
+
[key: string]: components$p["schemas"]["ComponentParameter"];
|
|
2080
2080
|
};
|
|
2081
|
-
_dataResources?: components$
|
|
2081
|
+
_dataResources?: components$p["schemas"]["DataResourceDefinitions"];
|
|
2082
2082
|
/**
|
|
2083
2083
|
* Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
|
2084
2084
|
* Means nothing for PUTs; it will be ignored
|
|
2085
2085
|
*/
|
|
2086
2086
|
_patternDataResources?: {
|
|
2087
|
-
[key: string]: components$
|
|
2087
|
+
[key: string]: components$p["schemas"]["DataResourceDefinition"];
|
|
2088
2088
|
};
|
|
2089
2089
|
/**
|
|
2090
2090
|
* Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
|
@@ -2107,7 +2107,7 @@ interface components$o {
|
|
|
2107
2107
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
2108
2108
|
*/
|
|
2109
2109
|
_overrides?: {
|
|
2110
|
-
[key: string]: components$
|
|
2110
|
+
[key: string]: components$p["schemas"]["ComponentOverride"];
|
|
2111
2111
|
};
|
|
2112
2112
|
/**
|
|
2113
2113
|
* When used on a pattern, defines how the pattern's parameters may be overridden
|
|
@@ -2116,7 +2116,7 @@ interface components$o {
|
|
|
2116
2116
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
2117
2117
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
2118
2118
|
*/
|
|
2119
|
-
_overridability?: components$
|
|
2119
|
+
_overridability?: components$p["schemas"]["ComponentOverridability"];
|
|
2120
2120
|
};
|
|
2121
2121
|
/** Defines the shape of the entry input */
|
|
2122
2122
|
EntryInput: {
|
|
@@ -2143,9 +2143,9 @@ interface components$o {
|
|
|
2143
2143
|
_creatorSubject?: string;
|
|
2144
2144
|
/** Entry field values */
|
|
2145
2145
|
fields?: {
|
|
2146
|
-
[key: string]: components$
|
|
2146
|
+
[key: string]: components$p["schemas"]["ComponentParameter"];
|
|
2147
2147
|
};
|
|
2148
|
-
_dataResources?: components$
|
|
2148
|
+
_dataResources?: components$p["schemas"]["DataResourceDefinitions"];
|
|
2149
2149
|
/** Indicates this content entry should be sourced from a pattern library pattern */
|
|
2150
2150
|
_pattern?: string;
|
|
2151
2151
|
/**
|
|
@@ -2153,7 +2153,7 @@ interface components$o {
|
|
|
2153
2153
|
* Means nothing for PUTs; it will be ignored
|
|
2154
2154
|
*/
|
|
2155
2155
|
_patternDataResources?: {
|
|
2156
|
-
[key: string]: components$
|
|
2156
|
+
[key: string]: components$p["schemas"]["DataResourceDefinition"];
|
|
2157
2157
|
};
|
|
2158
2158
|
/**
|
|
2159
2159
|
* Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
|
@@ -2171,7 +2171,7 @@ interface components$o {
|
|
|
2171
2171
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
2172
2172
|
*/
|
|
2173
2173
|
_overrides?: {
|
|
2174
|
-
[key: string]: components$
|
|
2174
|
+
[key: string]: components$p["schemas"]["ComponentOverride"];
|
|
2175
2175
|
};
|
|
2176
2176
|
/**
|
|
2177
2177
|
* When used on a pattern, defines how the pattern's fields may be overridden
|
|
@@ -2180,7 +2180,7 @@ interface components$o {
|
|
|
2180
2180
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
2181
2181
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
2182
2182
|
*/
|
|
2183
|
-
_overridability?: components$
|
|
2183
|
+
_overridability?: components$p["schemas"]["ComponentOverridability"];
|
|
2184
2184
|
/** Array of locales which have data defined on the entry. If empty, the current default locale implicitly has data */
|
|
2185
2185
|
_locales?: string[];
|
|
2186
2186
|
};
|
|
@@ -2223,7 +2223,7 @@ interface components$o {
|
|
|
2223
2223
|
* @defaultValue false
|
|
2224
2224
|
*/
|
|
2225
2225
|
pattern?: boolean;
|
|
2226
|
-
entry: components$
|
|
2226
|
+
entry: components$p["schemas"]["Entry"];
|
|
2227
2227
|
/**
|
|
2228
2228
|
* Format: uuid
|
|
2229
2229
|
* The workflow ID that this entry is assigned. Normally comes from the content type
|
|
@@ -2235,7 +2235,7 @@ interface components$o {
|
|
|
2235
2235
|
*/
|
|
2236
2236
|
workflowStageId?: string;
|
|
2237
2237
|
/** The full definition of the assigned workflow, if any, including stages, permissions, etc. Only returned when `withWorkflowDefinition` is true */
|
|
2238
|
-
workflowDefinition?: components$
|
|
2238
|
+
workflowDefinition?: components$p["schemas"]["WorkflowDefinition"];
|
|
2239
2239
|
/**
|
|
2240
2240
|
* Only present if an incomplete entry is returned; indicates reason for stubbing
|
|
2241
2241
|
|
|
@@ -2258,7 +2258,7 @@ interface components$o {
|
|
|
2258
2258
|
editionPriority?: number;
|
|
2259
2259
|
};
|
|
2260
2260
|
EntryListResponse: {
|
|
2261
|
-
entries: components$
|
|
2261
|
+
entries: components$p["schemas"]["EntryApiResponse"][];
|
|
2262
2262
|
/** Total number of entries that match the query. Only present when `withTotalCount` option is true */
|
|
2263
2263
|
totalCount?: number;
|
|
2264
2264
|
/** Per-field counts for distinct values */
|
|
@@ -2332,11 +2332,11 @@ interface components$o {
|
|
|
2332
2332
|
|
|
2333
2333
|
*/
|
|
2334
2334
|
op?: "&" | "|";
|
|
2335
|
-
clauses: (components$
|
|
2335
|
+
clauses: (components$p["schemas"]["VisibilityCriteria"] | components$p["schemas"]["VisibilityCriteriaGroup"])[];
|
|
2336
2336
|
};
|
|
2337
2337
|
/** Defines a conditional value for a component parameter */
|
|
2338
2338
|
ComponentParameterConditionalValue: {
|
|
2339
|
-
when: components$
|
|
2339
|
+
when: components$p["schemas"]["VisibilityCriteriaGroup"];
|
|
2340
2340
|
/**
|
|
2341
2341
|
* The value of the parameter. Any JSON-serializable value is acceptable.
|
|
2342
2342
|
* A value of `null` will cause the parameter value to be removed, if it matches.
|
|
@@ -2358,7 +2358,7 @@ interface components$o {
|
|
|
2358
2358
|
*
|
|
2359
2359
|
* When no locale is passed to a non-route API, conditions are not processed and all conditions are returned.
|
|
2360
2360
|
*/
|
|
2361
|
-
ComponentParameterConditions: components$
|
|
2361
|
+
ComponentParameterConditions: components$p["schemas"]["ComponentParameterConditionalValue"][];
|
|
2362
2362
|
/** Defines an editable parameter on a component */
|
|
2363
2363
|
ComponentParameter: {
|
|
2364
2364
|
/** The value of the parameter. Any JSON-serializable value is acceptable */
|
|
@@ -2366,7 +2366,7 @@ interface components$o {
|
|
|
2366
2366
|
/** The type of the parameter. Determines how it is displayed when editing and tells the consumer how to process it */
|
|
2367
2367
|
type: string;
|
|
2368
2368
|
/** @deprecated */
|
|
2369
|
-
connectedData?: components$
|
|
2369
|
+
connectedData?: components$p["schemas"]["DataElementConnectionDefinition"];
|
|
2370
2370
|
/**
|
|
2371
2371
|
* Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
|
|
2372
2372
|
* Note that locales must be registered on the entry/composition `_locales` before being used
|
|
@@ -2374,10 +2374,10 @@ interface components$o {
|
|
|
2374
2374
|
locales?: {
|
|
2375
2375
|
[key: string]: unknown;
|
|
2376
2376
|
};
|
|
2377
|
-
conditions?: components$
|
|
2377
|
+
conditions?: components$p["schemas"]["ComponentParameterConditions"];
|
|
2378
2378
|
/** Locale-specific conditional values for this parameter. Keys are locale codes, and values are the `conditions` for that locale. */
|
|
2379
2379
|
localesConditions?: {
|
|
2380
|
-
[key: string]: components$
|
|
2380
|
+
[key: string]: components$p["schemas"]["ComponentParameterConditions"];
|
|
2381
2381
|
};
|
|
2382
2382
|
};
|
|
2383
2383
|
/** Variable values for a data resource */
|
|
@@ -2401,14 +2401,14 @@ interface components$o {
|
|
|
2401
2401
|
* If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
|
|
2402
2402
|
*/
|
|
2403
2403
|
optionalPatternParameter?: boolean;
|
|
2404
|
-
variables?: components$
|
|
2404
|
+
variables?: components$p["schemas"]["DataResourceVariables"];
|
|
2405
2405
|
};
|
|
2406
2406
|
/**
|
|
2407
2407
|
* Data definitions attached to this component. The property name is the key of the data in the data document.
|
|
2408
2408
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key)
|
|
2409
2409
|
*/
|
|
2410
2410
|
DataResourceDefinitions: {
|
|
2411
|
-
[key: string]: components$
|
|
2411
|
+
[key: string]: components$p["schemas"]["DataResourceDefinition"];
|
|
2412
2412
|
};
|
|
2413
2413
|
/** Defines the shape of a component instance served by the composition API */
|
|
2414
2414
|
ComponentInstance: {
|
|
@@ -2416,13 +2416,13 @@ interface components$o {
|
|
|
2416
2416
|
type: string;
|
|
2417
2417
|
/** Component parameter values for the component instance */
|
|
2418
2418
|
parameters?: {
|
|
2419
|
-
[key: string]: components$
|
|
2419
|
+
[key: string]: components$p["schemas"]["ComponentParameter"];
|
|
2420
2420
|
};
|
|
2421
2421
|
/** Public ID of alternate visual appearance for this component, if any selected */
|
|
2422
2422
|
variant?: string;
|
|
2423
2423
|
/** Slots containing any child components */
|
|
2424
2424
|
slots?: {
|
|
2425
|
-
[key: string]: components$
|
|
2425
|
+
[key: string]: components$p["schemas"]["ComponentInstance"][];
|
|
2426
2426
|
};
|
|
2427
2427
|
/**
|
|
2428
2428
|
* Unique identifier of the component within the composition.
|
|
@@ -2433,20 +2433,20 @@ interface components$o {
|
|
|
2433
2433
|
_id?: string;
|
|
2434
2434
|
/** Indicates this component instance should be sourced from a pattern library pattern */
|
|
2435
2435
|
_pattern?: string;
|
|
2436
|
-
_dataResources?: components$
|
|
2436
|
+
_dataResources?: components$p["schemas"]["DataResourceDefinitions"];
|
|
2437
2437
|
/**
|
|
2438
2438
|
* Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
|
2439
2439
|
* Means nothing for PUTs; it will be ignored
|
|
2440
2440
|
*/
|
|
2441
2441
|
_patternDataResources?: {
|
|
2442
|
-
[key: string]: components$
|
|
2442
|
+
[key: string]: components$p["schemas"]["DataResourceDefinition"];
|
|
2443
2443
|
};
|
|
2444
2444
|
/**
|
|
2445
2445
|
* Query-string opt-ins coming from a pattern resolved for this component.
|
|
2446
2446
|
* Means nothing for PUTs; it will be ignored
|
|
2447
2447
|
*/
|
|
2448
2448
|
_patternOptedInQueryStrings?: string[];
|
|
2449
|
-
_patternError?: components$
|
|
2449
|
+
_patternError?: components$p["schemas"]["PatternError"];
|
|
2450
2450
|
/**
|
|
2451
2451
|
* Defines patch overrides to component IDs that live in the composition.
|
|
2452
2452
|
* This can be used to override parameters that are defined on patterns,
|
|
@@ -2460,14 +2460,14 @@ interface components$o {
|
|
|
2460
2460
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
2461
2461
|
*/
|
|
2462
2462
|
_overrides?: {
|
|
2463
|
-
[key: string]: components$
|
|
2463
|
+
[key: string]: components$p["schemas"]["ComponentOverride"];
|
|
2464
2464
|
};
|
|
2465
2465
|
/**
|
|
2466
2466
|
* Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
|
|
2467
2467
|
* Means nothing for PUTs; it will be ignored
|
|
2468
2468
|
*/
|
|
2469
2469
|
_patternOverrides?: {
|
|
2470
|
-
[key: string]: components$
|
|
2470
|
+
[key: string]: components$p["schemas"]["ComponentOverride"];
|
|
2471
2471
|
};
|
|
2472
2472
|
/**
|
|
2473
2473
|
* When used on a pattern, defines how the pattern's parameters may be overridden
|
|
@@ -2476,7 +2476,7 @@ interface components$o {
|
|
|
2476
2476
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
2477
2477
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
2478
2478
|
*/
|
|
2479
|
-
_overridability?: components$
|
|
2479
|
+
_overridability?: components$p["schemas"]["ComponentOverridability"];
|
|
2480
2480
|
/** Array of locales that have data defined. Only set for pattern references or composition defaults */
|
|
2481
2481
|
_locales?: string[];
|
|
2482
2482
|
};
|
|
@@ -2496,10 +2496,10 @@ interface components$o {
|
|
|
2496
2496
|
*/
|
|
2497
2497
|
ComponentOverride: {
|
|
2498
2498
|
parameters?: {
|
|
2499
|
-
[key: string]: components$
|
|
2499
|
+
[key: string]: components$p["schemas"]["ComponentParameter"];
|
|
2500
2500
|
};
|
|
2501
2501
|
slots?: {
|
|
2502
|
-
[key: string]: components$
|
|
2502
|
+
[key: string]: components$p["schemas"]["ComponentInstance"][];
|
|
2503
2503
|
};
|
|
2504
2504
|
variant?: string;
|
|
2505
2505
|
/**
|
|
@@ -2508,7 +2508,7 @@ interface components$o {
|
|
|
2508
2508
|
* Overrides defined here replace values in either _dataResources or _patternDataResources on the target component.
|
|
2509
2509
|
*/
|
|
2510
2510
|
dataResources?: {
|
|
2511
|
-
[key: string]: components$
|
|
2511
|
+
[key: string]: components$p["schemas"]["DataResourceDefinition"];
|
|
2512
2512
|
};
|
|
2513
2513
|
};
|
|
2514
2514
|
/**
|
|
@@ -2529,7 +2529,7 @@ interface components$o {
|
|
|
2529
2529
|
ComponentOverridability: {
|
|
2530
2530
|
/** Defines component parameter value overrides. Keys are the parameter public ID */
|
|
2531
2531
|
parameters?: {
|
|
2532
|
-
[key: string]: components$
|
|
2532
|
+
[key: string]: components$p["schemas"]["OverrideOptions"];
|
|
2533
2533
|
};
|
|
2534
2534
|
/** Allows overriding a display variant is allowed if it is defined on the component the pattern is derived from. Default = false */
|
|
2535
2535
|
variants?: boolean;
|
|
@@ -2569,7 +2569,7 @@ interface components$o {
|
|
|
2569
2569
|
* NOTE: Users without membership in any role listed here will be unable to execute the transition unless they are team admins
|
|
2570
2570
|
*/
|
|
2571
2571
|
permissions: {
|
|
2572
|
-
[key: string]: components$
|
|
2572
|
+
[key: string]: components$p["schemas"]["WorkflowStageTransitionPermission"];
|
|
2573
2573
|
};
|
|
2574
2574
|
};
|
|
2575
2575
|
/** Definition of a stage in a workflow */
|
|
@@ -2583,7 +2583,7 @@ interface components$o {
|
|
|
2583
2583
|
* listed here, the stage is read-only and publishing is disabled
|
|
2584
2584
|
*/
|
|
2585
2585
|
permissions: {
|
|
2586
|
-
[key: string]: components$
|
|
2586
|
+
[key: string]: components$p["schemas"]["WorkflowStagePermission"];
|
|
2587
2587
|
};
|
|
2588
2588
|
/**
|
|
2589
2589
|
* When true, transitioning into this stage from a different stage will automatically publish the entity.
|
|
@@ -2603,7 +2603,7 @@ interface components$o {
|
|
|
2603
2603
|
* Every stage must define at least one transition, to avoid creating a workflow that
|
|
2604
2604
|
* has a stage that can never be escaped
|
|
2605
2605
|
*/
|
|
2606
|
-
transitions: components$
|
|
2606
|
+
transitions: components$p["schemas"]["WorkflowStageTransition"][];
|
|
2607
2607
|
/**
|
|
2608
2608
|
* Icon name for the stage (e.g. 'chevron-double-right-o')
|
|
2609
2609
|
* @defaultValue chevron-double-right-o
|
|
@@ -2628,7 +2628,7 @@ interface components$o {
|
|
|
2628
2628
|
initialStage: string;
|
|
2629
2629
|
/** All stages of the workflow */
|
|
2630
2630
|
stages: {
|
|
2631
|
-
[key: string]: components$
|
|
2631
|
+
[key: string]: components$p["schemas"]["WorkflowStage"];
|
|
2632
2632
|
};
|
|
2633
2633
|
/** Last modified ISO date string for this definition (ignored for writes) */
|
|
2634
2634
|
modified?: string;
|
|
@@ -2829,7 +2829,7 @@ interface components$o {
|
|
|
2829
2829
|
pathItems: never;
|
|
2830
2830
|
}
|
|
2831
2831
|
|
|
2832
|
-
interface paths$
|
|
2832
|
+
interface paths$m {
|
|
2833
2833
|
"/api/v1/content-types": {
|
|
2834
2834
|
parameters: {
|
|
2835
2835
|
query?: never;
|
|
@@ -2865,15 +2865,15 @@ interface paths$l {
|
|
|
2865
2865
|
content: {
|
|
2866
2866
|
"application/json": {
|
|
2867
2867
|
/** Content types that match the query */
|
|
2868
|
-
contentTypes: components$
|
|
2868
|
+
contentTypes: components$o["schemas"]["ContentType"][];
|
|
2869
2869
|
};
|
|
2870
2870
|
};
|
|
2871
2871
|
};
|
|
2872
|
-
400: components$
|
|
2873
|
-
401: components$
|
|
2874
|
-
403: components$
|
|
2875
|
-
429: components$
|
|
2876
|
-
500: components$
|
|
2872
|
+
400: components$o["responses"]["BadRequestError"];
|
|
2873
|
+
401: components$o["responses"]["UnauthorizedError"];
|
|
2874
|
+
403: components$o["responses"]["ForbiddenError"];
|
|
2875
|
+
429: components$o["responses"]["RateLimitError"];
|
|
2876
|
+
500: components$o["responses"]["InternalServerError"];
|
|
2877
2877
|
};
|
|
2878
2878
|
};
|
|
2879
2879
|
/** Upserts a content type */
|
|
@@ -2892,7 +2892,7 @@ interface paths$l {
|
|
|
2892
2892
|
* The project ID to upsert the content type to
|
|
2893
2893
|
*/
|
|
2894
2894
|
projectId: string;
|
|
2895
|
-
contentType: components$
|
|
2895
|
+
contentType: components$o["schemas"]["ContentType"];
|
|
2896
2896
|
};
|
|
2897
2897
|
};
|
|
2898
2898
|
};
|
|
@@ -2904,11 +2904,11 @@ interface paths$l {
|
|
|
2904
2904
|
};
|
|
2905
2905
|
content?: never;
|
|
2906
2906
|
};
|
|
2907
|
-
400: components$
|
|
2908
|
-
401: components$
|
|
2909
|
-
403: components$
|
|
2910
|
-
429: components$
|
|
2911
|
-
500: components$
|
|
2907
|
+
400: components$o["responses"]["BadRequestError"];
|
|
2908
|
+
401: components$o["responses"]["UnauthorizedError"];
|
|
2909
|
+
403: components$o["responses"]["ForbiddenError"];
|
|
2910
|
+
429: components$o["responses"]["RateLimitError"];
|
|
2911
|
+
500: components$o["responses"]["InternalServerError"];
|
|
2912
2912
|
};
|
|
2913
2913
|
};
|
|
2914
2914
|
post?: never;
|
|
@@ -2941,11 +2941,11 @@ interface paths$l {
|
|
|
2941
2941
|
};
|
|
2942
2942
|
content?: never;
|
|
2943
2943
|
};
|
|
2944
|
-
400: components$
|
|
2945
|
-
401: components$
|
|
2946
|
-
403: components$
|
|
2947
|
-
429: components$
|
|
2948
|
-
500: components$
|
|
2944
|
+
400: components$o["responses"]["BadRequestError"];
|
|
2945
|
+
401: components$o["responses"]["UnauthorizedError"];
|
|
2946
|
+
403: components$o["responses"]["ForbiddenError"];
|
|
2947
|
+
429: components$o["responses"]["RateLimitError"];
|
|
2948
|
+
500: components$o["responses"]["InternalServerError"];
|
|
2949
2949
|
};
|
|
2950
2950
|
};
|
|
2951
2951
|
/** Handles preflight requests. This endpoint allows CORS */
|
|
@@ -2972,13 +2972,13 @@ interface paths$l {
|
|
|
2972
2972
|
trace?: never;
|
|
2973
2973
|
};
|
|
2974
2974
|
}
|
|
2975
|
-
interface components$
|
|
2975
|
+
interface components$o {
|
|
2976
2976
|
schemas: {
|
|
2977
2977
|
/** Public ID (used in code). Do not change after creation */
|
|
2978
2978
|
PublicIdProperty: string;
|
|
2979
2979
|
/** The definition of a component parameter */
|
|
2980
2980
|
ComponentDefinitionParameter: {
|
|
2981
|
-
id: components$
|
|
2981
|
+
id: components$o["schemas"]["PublicIdProperty"];
|
|
2982
2982
|
/** Friendly name of the parameter */
|
|
2983
2983
|
name: string;
|
|
2984
2984
|
/** Appears next to the parameter in the Composition editor */
|
|
@@ -3039,7 +3039,7 @@ interface components$n {
|
|
|
3039
3039
|
};
|
|
3040
3040
|
/** Permission set for a component definition */
|
|
3041
3041
|
ComponentDefinitionPermission: {
|
|
3042
|
-
roleId: components$
|
|
3042
|
+
roleId: components$o["schemas"]["PublicIdProperty"];
|
|
3043
3043
|
/**
|
|
3044
3044
|
* Permission type for this permission ComponentDefinition:
|
|
3045
3045
|
* read | write | create | delete
|
|
@@ -3070,7 +3070,7 @@ interface components$n {
|
|
|
3070
3070
|
};
|
|
3071
3071
|
/** Defines a content type */
|
|
3072
3072
|
ContentType: {
|
|
3073
|
-
id: components$
|
|
3073
|
+
id: components$o["schemas"]["PublicIdProperty"];
|
|
3074
3074
|
/** Friendly name of the content type */
|
|
3075
3075
|
name: string;
|
|
3076
3076
|
/**
|
|
@@ -3084,7 +3084,7 @@ interface components$n {
|
|
|
3084
3084
|
*/
|
|
3085
3085
|
thumbnailField?: string | null;
|
|
3086
3086
|
/** The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
|
|
3087
|
-
fields?: components$
|
|
3087
|
+
fields?: components$o["schemas"]["ComponentDefinitionParameter"][];
|
|
3088
3088
|
/** Description of the content type */
|
|
3089
3089
|
description?: string;
|
|
3090
3090
|
/**
|
|
@@ -3096,7 +3096,7 @@ interface components$n {
|
|
|
3096
3096
|
created?: string;
|
|
3097
3097
|
/** Last modified date string for this content type (ignored for writes) */
|
|
3098
3098
|
updated?: string;
|
|
3099
|
-
slugSettings?: components$
|
|
3099
|
+
slugSettings?: components$o["schemas"]["ComponentDefinitionSlugSettings"];
|
|
3100
3100
|
/**
|
|
3101
3101
|
* The definition type of this content type (block or content type)
|
|
3102
3102
|
* @defaultValue contentType
|
|
@@ -3109,14 +3109,14 @@ interface components$n {
|
|
|
3109
3109
|
*/
|
|
3110
3110
|
useTeamPermissions?: boolean;
|
|
3111
3111
|
/** Custom role permissions for this content type */
|
|
3112
|
-
permissions?: components$
|
|
3112
|
+
permissions?: components$o["schemas"]["ComponentDefinitionPermission"][];
|
|
3113
3113
|
/**
|
|
3114
3114
|
* Format: uuid
|
|
3115
3115
|
* ID of the workflow that instances of this content type will use by default. When not set, no workflow is attached
|
|
3116
3116
|
*/
|
|
3117
3117
|
workflowId?: string;
|
|
3118
3118
|
/** Configurations for previewing an entry on a consuming pattern or composition. */
|
|
3119
|
-
previewConfigurations?: components$
|
|
3119
|
+
previewConfigurations?: components$o["schemas"]["ContentTypePreviewConfiguration"][];
|
|
3120
3120
|
};
|
|
3121
3121
|
Error: {
|
|
3122
3122
|
/** Error message(s) that occurred while processing the request */
|
|
@@ -3130,7 +3130,7 @@ interface components$n {
|
|
|
3130
3130
|
[name: string]: unknown;
|
|
3131
3131
|
};
|
|
3132
3132
|
content: {
|
|
3133
|
-
"application/json": components$
|
|
3133
|
+
"application/json": components$o["schemas"]["Error"];
|
|
3134
3134
|
};
|
|
3135
3135
|
};
|
|
3136
3136
|
/** API key or token was not valid */
|
|
@@ -3139,7 +3139,7 @@ interface components$n {
|
|
|
3139
3139
|
[name: string]: unknown;
|
|
3140
3140
|
};
|
|
3141
3141
|
content: {
|
|
3142
|
-
"application/json": components$
|
|
3142
|
+
"application/json": components$o["schemas"]["Error"];
|
|
3143
3143
|
};
|
|
3144
3144
|
};
|
|
3145
3145
|
/** Permission was denied */
|
|
@@ -3148,7 +3148,7 @@ interface components$n {
|
|
|
3148
3148
|
[name: string]: unknown;
|
|
3149
3149
|
};
|
|
3150
3150
|
content: {
|
|
3151
|
-
"application/json": components$
|
|
3151
|
+
"application/json": components$o["schemas"]["Error"];
|
|
3152
3152
|
};
|
|
3153
3153
|
};
|
|
3154
3154
|
/** Too many requests in allowed time period */
|
|
@@ -3172,7 +3172,7 @@ interface components$n {
|
|
|
3172
3172
|
pathItems: never;
|
|
3173
3173
|
}
|
|
3174
3174
|
|
|
3175
|
-
interface paths$
|
|
3175
|
+
interface paths$l {
|
|
3176
3176
|
"/api/v1/entries": {
|
|
3177
3177
|
parameters: {
|
|
3178
3178
|
query?: never;
|
|
@@ -3287,73 +3287,73 @@ interface paths$k {
|
|
|
3287
3287
|
* When `editions=raw`, this matches on edition IDs or entry IDs and edition resolution is disabled.
|
|
3288
3288
|
* When `versionId` is passed, this parameter is required and must contain only one entry ID.
|
|
3289
3289
|
*/
|
|
3290
|
-
entryIDs?: components$
|
|
3290
|
+
entryIDs?: components$n["parameters"]["entryIDs"];
|
|
3291
3291
|
/**
|
|
3292
3292
|
* Specify a historical entry version ID to fetch (retrieved from the entries-history API).
|
|
3293
3293
|
* Must be used with the `entryIDs` parameter, and there must be only one entryID passed
|
|
3294
3294
|
*/
|
|
3295
|
-
versionId?: components$
|
|
3295
|
+
versionId?: components$n["parameters"]["versionId"];
|
|
3296
3296
|
/** Specify a single entry to fetch by slug */
|
|
3297
|
-
slug?: components$
|
|
3297
|
+
slug?: components$n["parameters"]["slug"];
|
|
3298
3298
|
/** Filters entry lists by the user who created them. The user is specified by their identity subject */
|
|
3299
|
-
createdBy?: components$
|
|
3299
|
+
createdBy?: components$n["parameters"]["createdBy"];
|
|
3300
3300
|
/** Max number of records to return */
|
|
3301
|
-
limit?: components$
|
|
3301
|
+
limit?: components$n["parameters"]["limit"];
|
|
3302
3302
|
/** Number of records to skip */
|
|
3303
|
-
offset?: components$
|
|
3303
|
+
offset?: components$n["parameters"]["offset"];
|
|
3304
3304
|
/**
|
|
3305
3305
|
* Sets the sorting of the results. If unspecified, results are sorted by modification date descending.
|
|
3306
3306
|
* Allowed values are: updated_at_DESC, updated_at_ASC, created_at_DESC, created_at_ASC, name_DESC, name_ASC, slug_DESC, slug_ASC
|
|
3307
3307
|
*/
|
|
3308
|
-
orderBy?: components$
|
|
3308
|
+
orderBy?: components$n["parameters"]["orderBy"];
|
|
3309
3309
|
/**
|
|
3310
3310
|
* @deprecated
|
|
3311
3311
|
* Returns counts for distinct values of the specified field or fields (provided as comma-separated IDs).
|
|
3312
3312
|
*/
|
|
3313
|
-
facetBy?: components$
|
|
3313
|
+
facetBy?: components$n["parameters"]["facetBy"];
|
|
3314
3314
|
/**
|
|
3315
3315
|
* Matches entries based on whether they are pattern entries or regular entries.
|
|
3316
3316
|
* If true, only pattern entries will be returned.
|
|
3317
3317
|
* If false (default), only regular entries will be returned.
|
|
3318
3318
|
* If 'any', both pattern and regular entries will be returned (useful for ID lookups).
|
|
3319
3319
|
*/
|
|
3320
|
-
pattern?: components$
|
|
3320
|
+
pattern?: components$n["parameters"]["pattern"];
|
|
3321
3321
|
/** The project the entry/entries are on */
|
|
3322
|
-
projectId: components$
|
|
3322
|
+
projectId: components$n["parameters"]["projectId"];
|
|
3323
3323
|
/** Publishing state to fetch. 0 = draft, 64 = published */
|
|
3324
|
-
state?: components$
|
|
3324
|
+
state?: components$n["parameters"]["state"];
|
|
3325
3325
|
/** The content type ID to filter by */
|
|
3326
|
-
type?: components$
|
|
3326
|
+
type?: components$n["parameters"]["type"];
|
|
3327
3327
|
/**
|
|
3328
3328
|
* @deprecated
|
|
3329
3329
|
* Filters entries lists by the UI status of the entry.
|
|
3330
3330
|
* This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data
|
|
3331
3331
|
*/
|
|
3332
|
-
uiStatus?: components$
|
|
3332
|
+
uiStatus?: components$n["parameters"]["uiStatus"];
|
|
3333
3333
|
/** Filters entry lists by the user who last updated them. The user is specified by their identity subject */
|
|
3334
|
-
updatedBy?: components$
|
|
3334
|
+
updatedBy?: components$n["parameters"]["updatedBy"];
|
|
3335
3335
|
/**
|
|
3336
3336
|
* Controls whether the total count of results will be returned along with the current results page in a list.
|
|
3337
3337
|
* Has no effect when not fetching a list. This does impact performance when enabled
|
|
3338
3338
|
*/
|
|
3339
|
-
withTotalCount?: components$
|
|
3339
|
+
withTotalCount?: components$n["parameters"]["withTotalCount"];
|
|
3340
3340
|
/**
|
|
3341
3341
|
* @deprecated
|
|
3342
3342
|
* Returns the UI status string of the entry.
|
|
3343
3343
|
* This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data
|
|
3344
3344
|
*/
|
|
3345
|
-
withUIStatus?: components$
|
|
3345
|
+
withUIStatus?: components$n["parameters"]["withUIStatus"];
|
|
3346
3346
|
/** Returns the definition of any attached workflow along with the entry data */
|
|
3347
|
-
withWorkflowDefinition?: components$
|
|
3347
|
+
withWorkflowDefinition?: components$n["parameters"]["withWorkflowDefinition"];
|
|
3348
3348
|
/**
|
|
3349
3349
|
* If true the `_id` unique identifier of blocks will be part of the response data.
|
|
3350
3350
|
* If false, the `_id` will not be present in the API response.
|
|
3351
3351
|
* Note: the default value depends on the `format`: true for editor or canonical, false for delivery or when no format is specified.
|
|
3352
3352
|
* Prefer selecting a `format` rather than using this option.
|
|
3353
3353
|
*/
|
|
3354
|
-
withComponentIDs?: components$
|
|
3354
|
+
withComponentIDs?: components$n["parameters"]["withComponentIDs"];
|
|
3355
3355
|
/** Performs keyword search on the entries */
|
|
3356
|
-
keyword?: components$
|
|
3356
|
+
keyword?: components$n["parameters"]["keyword"];
|
|
3357
3357
|
/**
|
|
3358
3358
|
* If true, any pattern references in the composition will be left unresolved.
|
|
3359
3359
|
* This is appropriate if you intend to serialize the composition without patterns
|
|
@@ -3361,12 +3361,12 @@ interface paths$k {
|
|
|
3361
3361
|
* Default: true when `format` is canonical. False otherwise
|
|
3362
3362
|
* Prefer selecting a `format` rather than using this option.
|
|
3363
3363
|
*/
|
|
3364
|
-
skipPatternResolution?: components$
|
|
3364
|
+
skipPatternResolution?: components$n["parameters"]["skipPatternResolution"];
|
|
3365
3365
|
/**
|
|
3366
3366
|
* @deprecated
|
|
3367
3367
|
* This parameter is unused and has no effect. Passing this parameter will become an error in the future
|
|
3368
3368
|
*/
|
|
3369
|
-
skipParameterResolution?: components$
|
|
3369
|
+
skipParameterResolution?: components$n["parameters"]["skipParameterResolution"];
|
|
3370
3370
|
/**
|
|
3371
3371
|
* If true, any pattern override data is not resolved by the API.
|
|
3372
3372
|
* This is intended for internal use in the Canvas editor, and should not be used.
|
|
@@ -3374,13 +3374,13 @@ interface paths$k {
|
|
|
3374
3374
|
* Default: true when `format` is canonical or editor. False otherwise.
|
|
3375
3375
|
* Prefer selecting a `format` rather than using this option.
|
|
3376
3376
|
*/
|
|
3377
|
-
skipOverridesResolution?: components$
|
|
3377
|
+
skipOverridesResolution?: components$n["parameters"]["skipOverridesResolution"];
|
|
3378
3378
|
/**
|
|
3379
3379
|
* Improves performance by skipping dynamic data revalidations; appropriate for content delivery.
|
|
3380
3380
|
* Default: true when `format` is delivery. False otherwise.
|
|
3381
3381
|
* Prefer selecting a `format` rather than using this option.
|
|
3382
3382
|
*/
|
|
3383
|
-
skipContentTypeResolution?: components$
|
|
3383
|
+
skipContentTypeResolution?: components$n["parameters"]["skipContentTypeResolution"];
|
|
3384
3384
|
/**
|
|
3385
3385
|
* One or more locales to filter and localize by.
|
|
3386
3386
|
* Only entries that enable one of the specified locales _or enable no locales_ will be returned.
|
|
@@ -3393,7 +3393,7 @@ interface paths$k {
|
|
|
3393
3393
|
*
|
|
3394
3394
|
* When this parameter is not passed, all locales' data will be returned
|
|
3395
3395
|
*/
|
|
3396
|
-
locale?: components$
|
|
3396
|
+
locale?: components$n["parameters"]["locale"];
|
|
3397
3397
|
/**
|
|
3398
3398
|
* The ID of a release to fetch the content for.
|
|
3399
3399
|
*
|
|
@@ -3402,7 +3402,7 @@ interface paths$k {
|
|
|
3402
3402
|
*
|
|
3403
3403
|
* 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
|
|
3404
3404
|
*/
|
|
3405
|
-
releaseId?: components$
|
|
3405
|
+
releaseId?: components$n["parameters"]["releaseId"];
|
|
3406
3406
|
/**
|
|
3407
3407
|
* Search on textual fields of an entry.
|
|
3408
3408
|
* Matches against fully rendered content including resolved pattern content.
|
|
@@ -3410,7 +3410,7 @@ interface paths$k {
|
|
|
3410
3410
|
* Note: For long text fields, the tail of the text is not guaranteed to be searchable.
|
|
3411
3411
|
* Example: ?search=hello
|
|
3412
3412
|
*/
|
|
3413
|
-
search?: components$
|
|
3413
|
+
search?: components$n["parameters"]["search"];
|
|
3414
3414
|
/**
|
|
3415
3415
|
* @deprecated
|
|
3416
3416
|
* BETA: Semantic search using vector similarity to find content by meaning.
|
|
@@ -3418,7 +3418,7 @@ interface paths$k {
|
|
|
3418
3418
|
* Use this for "where is this content defined" queries.
|
|
3419
3419
|
* Requires AI credits.
|
|
3420
3420
|
*/
|
|
3421
|
-
searchSemantic?: components$
|
|
3421
|
+
searchSemantic?: components$n["parameters"]["searchSemantic"];
|
|
3422
3422
|
/**
|
|
3423
3423
|
* Controls the edition resolution behavior.
|
|
3424
3424
|
*
|
|
@@ -3432,7 +3432,7 @@ interface paths$k {
|
|
|
3432
3432
|
* entryIDs MUST be provided with this option.
|
|
3433
3433
|
* If versionId is passed, this is always enabled.
|
|
3434
3434
|
*/
|
|
3435
|
-
editions?: components$
|
|
3435
|
+
editions?: components$n["parameters"]["editions"];
|
|
3436
3436
|
/**
|
|
3437
3437
|
* Specify a format you want the results in. Any explicit shaping flag (skipPatternResolution,
|
|
3438
3438
|
* skipOverridesResolution, withComponentIDs, skipContentTypeResolution) overrides this alias.
|
|
@@ -3446,7 +3446,7 @@ interface paths$k {
|
|
|
3446
3446
|
* component `_id`s removed, and each entry returned as stored
|
|
3447
3447
|
* (skipContentTypeResolution=true).
|
|
3448
3448
|
*/
|
|
3449
|
-
format?: components$
|
|
3449
|
+
format?: components$n["parameters"]["format"];
|
|
3450
3450
|
/**
|
|
3451
3451
|
* Controls filtering of trashed items.
|
|
3452
3452
|
*
|
|
@@ -3454,7 +3454,7 @@ interface paths$k {
|
|
|
3454
3454
|
* only: Only return trashed items (for trash view).
|
|
3455
3455
|
* include: Return both trashed and non-trashed items.
|
|
3456
3456
|
*/
|
|
3457
|
-
deleted?: components$
|
|
3457
|
+
deleted?: components$n["parameters"]["deleted"];
|
|
3458
3458
|
};
|
|
3459
3459
|
header?: never;
|
|
3460
3460
|
path?: never;
|
|
@@ -3468,12 +3468,12 @@ interface paths$k {
|
|
|
3468
3468
|
[name: string]: unknown;
|
|
3469
3469
|
};
|
|
3470
3470
|
content: {
|
|
3471
|
-
"application/json": components$
|
|
3471
|
+
"application/json": components$n["schemas"]["EntryListResponse"];
|
|
3472
3472
|
};
|
|
3473
3473
|
};
|
|
3474
|
-
400: components$
|
|
3475
|
-
401: components$
|
|
3476
|
-
403: components$
|
|
3474
|
+
400: components$n["responses"]["BadRequestError"];
|
|
3475
|
+
401: components$n["responses"]["UnauthorizedError"];
|
|
3476
|
+
403: components$n["responses"]["ForbiddenError"];
|
|
3477
3477
|
/** Entry not found */
|
|
3478
3478
|
404: {
|
|
3479
3479
|
headers: {
|
|
@@ -3483,8 +3483,8 @@ interface paths$k {
|
|
|
3483
3483
|
"text/plain": string;
|
|
3484
3484
|
};
|
|
3485
3485
|
};
|
|
3486
|
-
429: components$
|
|
3487
|
-
500: components$
|
|
3486
|
+
429: components$n["responses"]["RateLimitError"];
|
|
3487
|
+
500: components$n["responses"]["InternalServerError"];
|
|
3488
3488
|
};
|
|
3489
3489
|
};
|
|
3490
3490
|
/** Upserts an entry */
|
|
@@ -3512,7 +3512,7 @@ interface paths$k {
|
|
|
3512
3512
|
projectId: string;
|
|
3513
3513
|
/** The publishing state to upsert into. 0 = draft, 64 = published */
|
|
3514
3514
|
state: number;
|
|
3515
|
-
entry: components$
|
|
3515
|
+
entry: components$n["schemas"]["EntryInput"];
|
|
3516
3516
|
/** Ignored if present */
|
|
3517
3517
|
created?: string;
|
|
3518
3518
|
/** Ignored if present */
|
|
@@ -3563,9 +3563,9 @@ interface paths$k {
|
|
|
3563
3563
|
};
|
|
3564
3564
|
content?: never;
|
|
3565
3565
|
};
|
|
3566
|
-
400: components$
|
|
3567
|
-
401: components$
|
|
3568
|
-
403: components$
|
|
3566
|
+
400: components$n["responses"]["BadRequestError"];
|
|
3567
|
+
401: components$n["responses"]["UnauthorizedError"];
|
|
3568
|
+
403: components$n["responses"]["ForbiddenError"];
|
|
3569
3569
|
/** Conflict - Entry has been changed since being loaded */
|
|
3570
3570
|
409: {
|
|
3571
3571
|
headers: {
|
|
@@ -3575,8 +3575,8 @@ interface paths$k {
|
|
|
3575
3575
|
"text/plain": string;
|
|
3576
3576
|
};
|
|
3577
3577
|
};
|
|
3578
|
-
429: components$
|
|
3579
|
-
500: components$
|
|
3578
|
+
429: components$n["responses"]["RateLimitError"];
|
|
3579
|
+
500: components$n["responses"]["InternalServerError"];
|
|
3580
3580
|
};
|
|
3581
3581
|
};
|
|
3582
3582
|
post?: never;
|
|
@@ -3629,11 +3629,11 @@ interface paths$k {
|
|
|
3629
3629
|
};
|
|
3630
3630
|
content?: never;
|
|
3631
3631
|
};
|
|
3632
|
-
400: components$
|
|
3633
|
-
401: components$
|
|
3634
|
-
403: components$
|
|
3635
|
-
429: components$
|
|
3636
|
-
500: components$
|
|
3632
|
+
400: components$n["responses"]["BadRequestError"];
|
|
3633
|
+
401: components$n["responses"]["UnauthorizedError"];
|
|
3634
|
+
403: components$n["responses"]["ForbiddenError"];
|
|
3635
|
+
429: components$n["responses"]["RateLimitError"];
|
|
3636
|
+
500: components$n["responses"]["InternalServerError"];
|
|
3637
3637
|
};
|
|
3638
3638
|
};
|
|
3639
3639
|
/** Handles preflight requests. This endpoint allows CORS */
|
|
@@ -3660,7 +3660,7 @@ interface paths$k {
|
|
|
3660
3660
|
trace?: never;
|
|
3661
3661
|
};
|
|
3662
3662
|
}
|
|
3663
|
-
interface components$
|
|
3663
|
+
interface components$n {
|
|
3664
3664
|
schemas: {
|
|
3665
3665
|
/** Defines a connection to a dynamic token on a data resource */
|
|
3666
3666
|
DataElementConnectionDefinition: {
|
|
@@ -3726,11 +3726,11 @@ interface components$m {
|
|
|
3726
3726
|
|
|
3727
3727
|
*/
|
|
3728
3728
|
op?: "&" | "|";
|
|
3729
|
-
clauses: (components$
|
|
3729
|
+
clauses: (components$n["schemas"]["VisibilityCriteria"] | components$n["schemas"]["VisibilityCriteriaGroup"])[];
|
|
3730
3730
|
};
|
|
3731
3731
|
/** Defines a conditional value for a component parameter */
|
|
3732
3732
|
ComponentParameterConditionalValue: {
|
|
3733
|
-
when: components$
|
|
3733
|
+
when: components$n["schemas"]["VisibilityCriteriaGroup"];
|
|
3734
3734
|
/**
|
|
3735
3735
|
* The value of the parameter. Any JSON-serializable value is acceptable.
|
|
3736
3736
|
* A value of `null` will cause the parameter value to be removed, if it matches.
|
|
@@ -3752,7 +3752,7 @@ interface components$m {
|
|
|
3752
3752
|
*
|
|
3753
3753
|
* When no locale is passed to a non-route API, conditions are not processed and all conditions are returned.
|
|
3754
3754
|
*/
|
|
3755
|
-
ComponentParameterConditions: components$
|
|
3755
|
+
ComponentParameterConditions: components$n["schemas"]["ComponentParameterConditionalValue"][];
|
|
3756
3756
|
/** Defines an editable parameter on a component */
|
|
3757
3757
|
ComponentParameter: {
|
|
3758
3758
|
/** The value of the parameter. Any JSON-serializable value is acceptable */
|
|
@@ -3760,7 +3760,7 @@ interface components$m {
|
|
|
3760
3760
|
/** The type of the parameter. Determines how it is displayed when editing and tells the consumer how to process it */
|
|
3761
3761
|
type: string;
|
|
3762
3762
|
/** @deprecated */
|
|
3763
|
-
connectedData?: components$
|
|
3763
|
+
connectedData?: components$n["schemas"]["DataElementConnectionDefinition"];
|
|
3764
3764
|
/**
|
|
3765
3765
|
* Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
|
|
3766
3766
|
* Note that locales must be registered on the entry/composition `_locales` before being used
|
|
@@ -3768,10 +3768,10 @@ interface components$m {
|
|
|
3768
3768
|
locales?: {
|
|
3769
3769
|
[key: string]: unknown;
|
|
3770
3770
|
};
|
|
3771
|
-
conditions?: components$
|
|
3771
|
+
conditions?: components$n["schemas"]["ComponentParameterConditions"];
|
|
3772
3772
|
/** Locale-specific conditional values for this parameter. Keys are locale codes, and values are the `conditions` for that locale. */
|
|
3773
3773
|
localesConditions?: {
|
|
3774
|
-
[key: string]: components$
|
|
3774
|
+
[key: string]: components$n["schemas"]["ComponentParameterConditions"];
|
|
3775
3775
|
};
|
|
3776
3776
|
};
|
|
3777
3777
|
/** Variable values for a data resource */
|
|
@@ -3795,14 +3795,14 @@ interface components$m {
|
|
|
3795
3795
|
* If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
|
|
3796
3796
|
*/
|
|
3797
3797
|
optionalPatternParameter?: boolean;
|
|
3798
|
-
variables?: components$
|
|
3798
|
+
variables?: components$n["schemas"]["DataResourceVariables"];
|
|
3799
3799
|
};
|
|
3800
3800
|
/**
|
|
3801
3801
|
* Data definitions attached to this component. The property name is the key of the data in the data document.
|
|
3802
3802
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key)
|
|
3803
3803
|
*/
|
|
3804
3804
|
DataResourceDefinitions: {
|
|
3805
|
-
[key: string]: components$
|
|
3805
|
+
[key: string]: components$n["schemas"]["DataResourceDefinition"];
|
|
3806
3806
|
};
|
|
3807
3807
|
/** Defines the shape of a component instance served by the composition API */
|
|
3808
3808
|
ComponentInstance: {
|
|
@@ -3810,13 +3810,13 @@ interface components$m {
|
|
|
3810
3810
|
type: string;
|
|
3811
3811
|
/** Component parameter values for the component instance */
|
|
3812
3812
|
parameters?: {
|
|
3813
|
-
[key: string]: components$
|
|
3813
|
+
[key: string]: components$n["schemas"]["ComponentParameter"];
|
|
3814
3814
|
};
|
|
3815
3815
|
/** Public ID of alternate visual appearance for this component, if any selected */
|
|
3816
3816
|
variant?: string;
|
|
3817
3817
|
/** Slots containing any child components */
|
|
3818
3818
|
slots?: {
|
|
3819
|
-
[key: string]: components$
|
|
3819
|
+
[key: string]: components$n["schemas"]["ComponentInstance"][];
|
|
3820
3820
|
};
|
|
3821
3821
|
/**
|
|
3822
3822
|
* Unique identifier of the component within the composition.
|
|
@@ -3827,20 +3827,20 @@ interface components$m {
|
|
|
3827
3827
|
_id?: string;
|
|
3828
3828
|
/** Indicates this component instance should be sourced from a pattern library pattern */
|
|
3829
3829
|
_pattern?: string;
|
|
3830
|
-
_dataResources?: components$
|
|
3830
|
+
_dataResources?: components$n["schemas"]["DataResourceDefinitions"];
|
|
3831
3831
|
/**
|
|
3832
3832
|
* Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
|
3833
3833
|
* Means nothing for PUTs; it will be ignored
|
|
3834
3834
|
*/
|
|
3835
3835
|
_patternDataResources?: {
|
|
3836
|
-
[key: string]: components$
|
|
3836
|
+
[key: string]: components$n["schemas"]["DataResourceDefinition"];
|
|
3837
3837
|
};
|
|
3838
3838
|
/**
|
|
3839
3839
|
* Query-string opt-ins coming from a pattern resolved for this component.
|
|
3840
3840
|
* Means nothing for PUTs; it will be ignored
|
|
3841
3841
|
*/
|
|
3842
3842
|
_patternOptedInQueryStrings?: string[];
|
|
3843
|
-
_patternError?: components$
|
|
3843
|
+
_patternError?: components$n["schemas"]["PatternError"];
|
|
3844
3844
|
/**
|
|
3845
3845
|
* Defines patch overrides to component IDs that live in the composition.
|
|
3846
3846
|
* This can be used to override parameters that are defined on patterns,
|
|
@@ -3854,14 +3854,14 @@ interface components$m {
|
|
|
3854
3854
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
3855
3855
|
*/
|
|
3856
3856
|
_overrides?: {
|
|
3857
|
-
[key: string]: components$
|
|
3857
|
+
[key: string]: components$n["schemas"]["ComponentOverride"];
|
|
3858
3858
|
};
|
|
3859
3859
|
/**
|
|
3860
3860
|
* Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
|
|
3861
3861
|
* Means nothing for PUTs; it will be ignored
|
|
3862
3862
|
*/
|
|
3863
3863
|
_patternOverrides?: {
|
|
3864
|
-
[key: string]: components$
|
|
3864
|
+
[key: string]: components$n["schemas"]["ComponentOverride"];
|
|
3865
3865
|
};
|
|
3866
3866
|
/**
|
|
3867
3867
|
* When used on a pattern, defines how the pattern's parameters may be overridden
|
|
@@ -3870,7 +3870,7 @@ interface components$m {
|
|
|
3870
3870
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
3871
3871
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
3872
3872
|
*/
|
|
3873
|
-
_overridability?: components$
|
|
3873
|
+
_overridability?: components$n["schemas"]["ComponentOverridability"];
|
|
3874
3874
|
/** Array of locales that have data defined. Only set for pattern references or composition defaults */
|
|
3875
3875
|
_locales?: string[];
|
|
3876
3876
|
};
|
|
@@ -3890,10 +3890,10 @@ interface components$m {
|
|
|
3890
3890
|
*/
|
|
3891
3891
|
ComponentOverride: {
|
|
3892
3892
|
parameters?: {
|
|
3893
|
-
[key: string]: components$
|
|
3893
|
+
[key: string]: components$n["schemas"]["ComponentParameter"];
|
|
3894
3894
|
};
|
|
3895
3895
|
slots?: {
|
|
3896
|
-
[key: string]: components$
|
|
3896
|
+
[key: string]: components$n["schemas"]["ComponentInstance"][];
|
|
3897
3897
|
};
|
|
3898
3898
|
variant?: string;
|
|
3899
3899
|
/**
|
|
@@ -3902,7 +3902,7 @@ interface components$m {
|
|
|
3902
3902
|
* Overrides defined here replace values in either _dataResources or _patternDataResources on the target component.
|
|
3903
3903
|
*/
|
|
3904
3904
|
dataResources?: {
|
|
3905
|
-
[key: string]: components$
|
|
3905
|
+
[key: string]: components$n["schemas"]["DataResourceDefinition"];
|
|
3906
3906
|
};
|
|
3907
3907
|
};
|
|
3908
3908
|
/**
|
|
@@ -3923,7 +3923,7 @@ interface components$m {
|
|
|
3923
3923
|
ComponentOverridability: {
|
|
3924
3924
|
/** Defines component parameter value overrides. Keys are the parameter public ID */
|
|
3925
3925
|
parameters?: {
|
|
3926
|
-
[key: string]: components$
|
|
3926
|
+
[key: string]: components$n["schemas"]["OverrideOptions"];
|
|
3927
3927
|
};
|
|
3928
3928
|
/** Allows overriding a display variant is allowed if it is defined on the component the pattern is derived from. Default = false */
|
|
3929
3929
|
variants?: boolean;
|
|
@@ -3963,15 +3963,15 @@ interface components$m {
|
|
|
3963
3963
|
_locales?: string[];
|
|
3964
3964
|
/** Entry field values */
|
|
3965
3965
|
fields?: {
|
|
3966
|
-
[key: string]: components$
|
|
3966
|
+
[key: string]: components$n["schemas"]["ComponentParameter"];
|
|
3967
3967
|
};
|
|
3968
|
-
_dataResources?: components$
|
|
3968
|
+
_dataResources?: components$n["schemas"]["DataResourceDefinitions"];
|
|
3969
3969
|
/**
|
|
3970
3970
|
* Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
|
3971
3971
|
* Means nothing for PUTs; it will be ignored
|
|
3972
3972
|
*/
|
|
3973
3973
|
_patternDataResources?: {
|
|
3974
|
-
[key: string]: components$
|
|
3974
|
+
[key: string]: components$n["schemas"]["DataResourceDefinition"];
|
|
3975
3975
|
};
|
|
3976
3976
|
/**
|
|
3977
3977
|
* Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
|
@@ -3994,7 +3994,7 @@ interface components$m {
|
|
|
3994
3994
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
3995
3995
|
*/
|
|
3996
3996
|
_overrides?: {
|
|
3997
|
-
[key: string]: components$
|
|
3997
|
+
[key: string]: components$n["schemas"]["ComponentOverride"];
|
|
3998
3998
|
};
|
|
3999
3999
|
/**
|
|
4000
4000
|
* When used on a pattern, defines how the pattern's parameters may be overridden
|
|
@@ -4003,7 +4003,7 @@ interface components$m {
|
|
|
4003
4003
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
4004
4004
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
4005
4005
|
*/
|
|
4006
|
-
_overridability?: components$
|
|
4006
|
+
_overridability?: components$n["schemas"]["ComponentOverridability"];
|
|
4007
4007
|
};
|
|
4008
4008
|
/** Permissions for a workflow stage */
|
|
4009
4009
|
WorkflowStagePermission: {
|
|
@@ -4034,7 +4034,7 @@ interface components$m {
|
|
|
4034
4034
|
* NOTE: Users without membership in any role listed here will be unable to execute the transition unless they are team admins
|
|
4035
4035
|
*/
|
|
4036
4036
|
permissions: {
|
|
4037
|
-
[key: string]: components$
|
|
4037
|
+
[key: string]: components$n["schemas"]["WorkflowStageTransitionPermission"];
|
|
4038
4038
|
};
|
|
4039
4039
|
};
|
|
4040
4040
|
/** Definition of a stage in a workflow */
|
|
@@ -4048,7 +4048,7 @@ interface components$m {
|
|
|
4048
4048
|
* listed here, the stage is read-only and publishing is disabled
|
|
4049
4049
|
*/
|
|
4050
4050
|
permissions: {
|
|
4051
|
-
[key: string]: components$
|
|
4051
|
+
[key: string]: components$n["schemas"]["WorkflowStagePermission"];
|
|
4052
4052
|
};
|
|
4053
4053
|
/**
|
|
4054
4054
|
* When true, transitioning into this stage from a different stage will automatically publish the entity.
|
|
@@ -4068,7 +4068,7 @@ interface components$m {
|
|
|
4068
4068
|
* Every stage must define at least one transition, to avoid creating a workflow that
|
|
4069
4069
|
* has a stage that can never be escaped
|
|
4070
4070
|
*/
|
|
4071
|
-
transitions: components$
|
|
4071
|
+
transitions: components$n["schemas"]["WorkflowStageTransition"][];
|
|
4072
4072
|
/**
|
|
4073
4073
|
* Icon name for the stage (e.g. 'chevron-double-right-o')
|
|
4074
4074
|
* @defaultValue chevron-double-right-o
|
|
@@ -4093,7 +4093,7 @@ interface components$m {
|
|
|
4093
4093
|
initialStage: string;
|
|
4094
4094
|
/** All stages of the workflow */
|
|
4095
4095
|
stages: {
|
|
4096
|
-
[key: string]: components$
|
|
4096
|
+
[key: string]: components$n["schemas"]["WorkflowStage"];
|
|
4097
4097
|
};
|
|
4098
4098
|
/** Last modified ISO date string for this definition (ignored for writes) */
|
|
4099
4099
|
modified?: string;
|
|
@@ -4151,7 +4151,7 @@ interface components$m {
|
|
|
4151
4151
|
* @defaultValue false
|
|
4152
4152
|
*/
|
|
4153
4153
|
pattern?: boolean;
|
|
4154
|
-
entry: components$
|
|
4154
|
+
entry: components$n["schemas"]["Entry"];
|
|
4155
4155
|
/**
|
|
4156
4156
|
* Format: uuid
|
|
4157
4157
|
* The workflow ID that this entry is assigned. Normally comes from the content type
|
|
@@ -4163,7 +4163,7 @@ interface components$m {
|
|
|
4163
4163
|
*/
|
|
4164
4164
|
workflowStageId?: string;
|
|
4165
4165
|
/** The full definition of the assigned workflow, if any, including stages, permissions, etc. Only returned when `withWorkflowDefinition` is true */
|
|
4166
|
-
workflowDefinition?: components$
|
|
4166
|
+
workflowDefinition?: components$n["schemas"]["WorkflowDefinition"];
|
|
4167
4167
|
/**
|
|
4168
4168
|
* Only present if an incomplete entry is returned; indicates reason for stubbing
|
|
4169
4169
|
|
|
@@ -4186,7 +4186,7 @@ interface components$m {
|
|
|
4186
4186
|
editionPriority?: number;
|
|
4187
4187
|
};
|
|
4188
4188
|
EntryListResponse: {
|
|
4189
|
-
entries: components$
|
|
4189
|
+
entries: components$n["schemas"]["EntryApiResponse"][];
|
|
4190
4190
|
/** Total number of entries that match the query. Only present when `withTotalCount` option is true */
|
|
4191
4191
|
totalCount?: number;
|
|
4192
4192
|
/** Per-field counts for distinct values */
|
|
@@ -4225,9 +4225,9 @@ interface components$m {
|
|
|
4225
4225
|
_creatorSubject?: string;
|
|
4226
4226
|
/** Entry field values */
|
|
4227
4227
|
fields?: {
|
|
4228
|
-
[key: string]: components$
|
|
4228
|
+
[key: string]: components$n["schemas"]["ComponentParameter"];
|
|
4229
4229
|
};
|
|
4230
|
-
_dataResources?: components$
|
|
4230
|
+
_dataResources?: components$n["schemas"]["DataResourceDefinitions"];
|
|
4231
4231
|
/** Indicates this content entry should be sourced from a pattern library pattern */
|
|
4232
4232
|
_pattern?: string;
|
|
4233
4233
|
/**
|
|
@@ -4235,7 +4235,7 @@ interface components$m {
|
|
|
4235
4235
|
* Means nothing for PUTs; it will be ignored
|
|
4236
4236
|
*/
|
|
4237
4237
|
_patternDataResources?: {
|
|
4238
|
-
[key: string]: components$
|
|
4238
|
+
[key: string]: components$n["schemas"]["DataResourceDefinition"];
|
|
4239
4239
|
};
|
|
4240
4240
|
/**
|
|
4241
4241
|
* Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
|
@@ -4253,7 +4253,7 @@ interface components$m {
|
|
|
4253
4253
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
4254
4254
|
*/
|
|
4255
4255
|
_overrides?: {
|
|
4256
|
-
[key: string]: components$
|
|
4256
|
+
[key: string]: components$n["schemas"]["ComponentOverride"];
|
|
4257
4257
|
};
|
|
4258
4258
|
/**
|
|
4259
4259
|
* When used on a pattern, defines how the pattern's fields may be overridden
|
|
@@ -4262,7 +4262,7 @@ interface components$m {
|
|
|
4262
4262
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
4263
4263
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
4264
4264
|
*/
|
|
4265
|
-
_overridability?: components$
|
|
4265
|
+
_overridability?: components$n["schemas"]["ComponentOverridability"];
|
|
4266
4266
|
/** Array of locales which have data defined on the entry. If empty, the current default locale implicitly has data */
|
|
4267
4267
|
_locales?: string[];
|
|
4268
4268
|
};
|
|
@@ -4274,7 +4274,7 @@ interface components$m {
|
|
|
4274
4274
|
[name: string]: unknown;
|
|
4275
4275
|
};
|
|
4276
4276
|
content: {
|
|
4277
|
-
"application/json": components$
|
|
4277
|
+
"application/json": components$n["schemas"]["Error"];
|
|
4278
4278
|
};
|
|
4279
4279
|
};
|
|
4280
4280
|
/** API key or token was not valid */
|
|
@@ -4283,7 +4283,7 @@ interface components$m {
|
|
|
4283
4283
|
[name: string]: unknown;
|
|
4284
4284
|
};
|
|
4285
4285
|
content: {
|
|
4286
|
-
"application/json": components$
|
|
4286
|
+
"application/json": components$n["schemas"]["Error"];
|
|
4287
4287
|
};
|
|
4288
4288
|
};
|
|
4289
4289
|
/** Permission was denied */
|
|
@@ -4292,7 +4292,7 @@ interface components$m {
|
|
|
4292
4292
|
[name: string]: unknown;
|
|
4293
4293
|
};
|
|
4294
4294
|
content: {
|
|
4295
|
-
"application/json": components$
|
|
4295
|
+
"application/json": components$n["schemas"]["Error"];
|
|
4296
4296
|
};
|
|
4297
4297
|
};
|
|
4298
4298
|
/** Too many requests in allowed time period */
|
|
@@ -4490,7 +4490,7 @@ interface components$m {
|
|
|
4490
4490
|
pathItems: never;
|
|
4491
4491
|
}
|
|
4492
4492
|
|
|
4493
|
-
interface paths$
|
|
4493
|
+
interface paths$k {
|
|
4494
4494
|
"/api/v1/entries-history": {
|
|
4495
4495
|
parameters: {
|
|
4496
4496
|
query?: never;
|
|
@@ -4527,12 +4527,12 @@ interface paths$j {
|
|
|
4527
4527
|
[name: string]: unknown;
|
|
4528
4528
|
};
|
|
4529
4529
|
content: {
|
|
4530
|
-
"application/json": components$
|
|
4530
|
+
"application/json": components$m["schemas"]["HistoryApiResponse"];
|
|
4531
4531
|
};
|
|
4532
4532
|
};
|
|
4533
|
-
400: components$
|
|
4534
|
-
401: components$
|
|
4535
|
-
403: components$
|
|
4533
|
+
400: components$m["responses"]["BadRequestError"];
|
|
4534
|
+
401: components$m["responses"]["UnauthorizedError"];
|
|
4535
|
+
403: components$m["responses"]["ForbiddenError"];
|
|
4536
4536
|
/** Entry not found */
|
|
4537
4537
|
404: {
|
|
4538
4538
|
headers: {
|
|
@@ -4542,8 +4542,8 @@ interface paths$j {
|
|
|
4542
4542
|
"text/plain": string;
|
|
4543
4543
|
};
|
|
4544
4544
|
};
|
|
4545
|
-
429: components$
|
|
4546
|
-
500: components$
|
|
4545
|
+
429: components$m["responses"]["RateLimitError"];
|
|
4546
|
+
500: components$m["responses"]["InternalServerError"];
|
|
4547
4547
|
};
|
|
4548
4548
|
};
|
|
4549
4549
|
put?: never;
|
|
@@ -4555,7 +4555,7 @@ interface paths$j {
|
|
|
4555
4555
|
trace?: never;
|
|
4556
4556
|
};
|
|
4557
4557
|
}
|
|
4558
|
-
interface components$
|
|
4558
|
+
interface components$m {
|
|
4559
4559
|
schemas: {
|
|
4560
4560
|
HistoryEntry: {
|
|
4561
4561
|
/** The version ID of the entity. This can be used to fetch the version's data via the entity API */
|
|
@@ -4579,7 +4579,7 @@ interface components$l {
|
|
|
4579
4579
|
/** If more history is available than your plan allows, and additional entries are available by upgrading, this will be true */
|
|
4580
4580
|
truncated?: boolean;
|
|
4581
4581
|
/** Version history entries */
|
|
4582
|
-
results?: components$
|
|
4582
|
+
results?: components$m["schemas"]["HistoryEntry"][];
|
|
4583
4583
|
};
|
|
4584
4584
|
Error: {
|
|
4585
4585
|
/** Error message(s) that occurred while processing the request */
|
|
@@ -4593,7 +4593,7 @@ interface components$l {
|
|
|
4593
4593
|
[name: string]: unknown;
|
|
4594
4594
|
};
|
|
4595
4595
|
content: {
|
|
4596
|
-
"application/json": components$
|
|
4596
|
+
"application/json": components$m["schemas"]["Error"];
|
|
4597
4597
|
};
|
|
4598
4598
|
};
|
|
4599
4599
|
/** API key or token was not valid */
|
|
@@ -4602,7 +4602,7 @@ interface components$l {
|
|
|
4602
4602
|
[name: string]: unknown;
|
|
4603
4603
|
};
|
|
4604
4604
|
content: {
|
|
4605
|
-
"application/json": components$
|
|
4605
|
+
"application/json": components$m["schemas"]["Error"];
|
|
4606
4606
|
};
|
|
4607
4607
|
};
|
|
4608
4608
|
/** Permission was denied */
|
|
@@ -4611,7 +4611,7 @@ interface components$l {
|
|
|
4611
4611
|
[name: string]: unknown;
|
|
4612
4612
|
};
|
|
4613
4613
|
content: {
|
|
4614
|
-
"application/json": components$
|
|
4614
|
+
"application/json": components$m["schemas"]["Error"];
|
|
4615
4615
|
};
|
|
4616
4616
|
};
|
|
4617
4617
|
/** Too many requests in allowed time period */
|
|
@@ -4635,27 +4635,27 @@ interface components$l {
|
|
|
4635
4635
|
pathItems: never;
|
|
4636
4636
|
}
|
|
4637
4637
|
|
|
4638
|
-
type HistoryApi$1 = paths$
|
|
4639
|
-
type ContentType = components$
|
|
4640
|
-
type ContentTypePreviewConfiguration = components$
|
|
4638
|
+
type HistoryApi$1 = paths$k['/api/v1/entries-history'];
|
|
4639
|
+
type ContentType = components$r['schemas']['ContentType'];
|
|
4640
|
+
type ContentTypePreviewConfiguration = components$r['schemas']['ContentTypePreviewConfiguration'];
|
|
4641
4641
|
type ContentTypeField = Exclude<ContentType['fields'], undefined>[number];
|
|
4642
|
-
type GetContentTypesOptions = paths$
|
|
4643
|
-
type DeleteContentTypeOptions = paths$
|
|
4644
|
-
type PutContentTypeBody = paths$
|
|
4645
|
-
type GetContentTypesResponse = paths$
|
|
4646
|
-
type Entry = components$
|
|
4647
|
-
type EntryList = components$
|
|
4642
|
+
type GetContentTypesOptions = paths$m['/api/v1/content-types']['get']['parameters']['query'];
|
|
4643
|
+
type DeleteContentTypeOptions = paths$m['/api/v1/content-types']['delete']['requestBody']['content']['application/json'];
|
|
4644
|
+
type PutContentTypeBody = paths$m['/api/v1/content-types']['put']['requestBody']['content']['application/json'];
|
|
4645
|
+
type GetContentTypesResponse = paths$m['/api/v1/content-types']['get']['responses']['200']['content']['application/json'];
|
|
4646
|
+
type Entry = components$p['schemas']['EntryApiResponse'];
|
|
4647
|
+
type EntryList = components$p['schemas']['EntryListResponse'];
|
|
4648
4648
|
type EntryData = Entry['entry'];
|
|
4649
|
-
type GetEntriesOptions = paths$
|
|
4650
|
-
type GetEntriesResponse = paths$
|
|
4651
|
-
type DeleteEntryOptions = paths$
|
|
4652
|
-
type PutEntryBody = paths$
|
|
4649
|
+
type GetEntriesOptions = paths$l['/api/v1/entries']['get']['parameters']['query'];
|
|
4650
|
+
type GetEntriesResponse = paths$l['/api/v1/entries']['get']['responses']['200']['content']['application/json'];
|
|
4651
|
+
type DeleteEntryOptions = paths$l['/api/v1/entries']['delete']['requestBody']['content']['application/json'];
|
|
4652
|
+
type PutEntryBody = paths$l['/api/v1/entries']['put']['requestBody']['content']['application/json'];
|
|
4653
4653
|
/** The GET response from /api/v1/entries-history (history for one entry) */
|
|
4654
4654
|
type EntriesHistoryGetParameters = HistoryApi$1['get']['parameters']['query'];
|
|
4655
4655
|
/** The GET response from /api/v1/entries-history */
|
|
4656
|
-
type EntriesHistoryGetResponse = components$
|
|
4656
|
+
type EntriesHistoryGetResponse = components$r['schemas']['HistoryApiResponse'];
|
|
4657
4657
|
|
|
4658
|
-
interface paths$
|
|
4658
|
+
interface paths$j {
|
|
4659
4659
|
"/api/v1/data-source": {
|
|
4660
4660
|
parameters: {
|
|
4661
4661
|
query?: never;
|
|
@@ -4682,15 +4682,15 @@ interface paths$i {
|
|
|
4682
4682
|
};
|
|
4683
4683
|
content: {
|
|
4684
4684
|
"application/json": {
|
|
4685
|
-
result: components$
|
|
4685
|
+
result: components$l["schemas"]["DataSource"];
|
|
4686
4686
|
};
|
|
4687
4687
|
};
|
|
4688
4688
|
};
|
|
4689
|
-
400: components$
|
|
4690
|
-
401: components$
|
|
4691
|
-
403: components$
|
|
4692
|
-
429: components$
|
|
4693
|
-
500: components$
|
|
4689
|
+
400: components$l["responses"]["BadRequestError"];
|
|
4690
|
+
401: components$l["responses"]["UnauthorizedError"];
|
|
4691
|
+
403: components$l["responses"]["ForbiddenError"];
|
|
4692
|
+
429: components$l["responses"]["RateLimitError"];
|
|
4693
|
+
500: components$l["responses"]["InternalServerError"];
|
|
4694
4694
|
};
|
|
4695
4695
|
};
|
|
4696
4696
|
put: {
|
|
@@ -4703,7 +4703,7 @@ interface paths$i {
|
|
|
4703
4703
|
requestBody: {
|
|
4704
4704
|
content: {
|
|
4705
4705
|
"application/json": {
|
|
4706
|
-
data: components$
|
|
4706
|
+
data: components$l["schemas"]["DataSource"];
|
|
4707
4707
|
/** Format: uuid */
|
|
4708
4708
|
projectId: string;
|
|
4709
4709
|
/**
|
|
@@ -4725,11 +4725,11 @@ interface paths$i {
|
|
|
4725
4725
|
};
|
|
4726
4726
|
content?: never;
|
|
4727
4727
|
};
|
|
4728
|
-
400: components$
|
|
4729
|
-
401: components$
|
|
4730
|
-
403: components$
|
|
4731
|
-
429: components$
|
|
4732
|
-
500: components$
|
|
4728
|
+
400: components$l["responses"]["BadRequestError"];
|
|
4729
|
+
401: components$l["responses"]["UnauthorizedError"];
|
|
4730
|
+
403: components$l["responses"]["ForbiddenError"];
|
|
4731
|
+
429: components$l["responses"]["RateLimitError"];
|
|
4732
|
+
500: components$l["responses"]["InternalServerError"];
|
|
4733
4733
|
};
|
|
4734
4734
|
};
|
|
4735
4735
|
post?: never;
|
|
@@ -4757,11 +4757,11 @@ interface paths$i {
|
|
|
4757
4757
|
};
|
|
4758
4758
|
content?: never;
|
|
4759
4759
|
};
|
|
4760
|
-
400: components$
|
|
4761
|
-
401: components$
|
|
4762
|
-
403: components$
|
|
4763
|
-
429: components$
|
|
4764
|
-
500: components$
|
|
4760
|
+
400: components$l["responses"]["BadRequestError"];
|
|
4761
|
+
401: components$l["responses"]["UnauthorizedError"];
|
|
4762
|
+
403: components$l["responses"]["ForbiddenError"];
|
|
4763
|
+
429: components$l["responses"]["RateLimitError"];
|
|
4764
|
+
500: components$l["responses"]["InternalServerError"];
|
|
4765
4765
|
};
|
|
4766
4766
|
};
|
|
4767
4767
|
options?: never;
|
|
@@ -4770,7 +4770,7 @@ interface paths$i {
|
|
|
4770
4770
|
trace?: never;
|
|
4771
4771
|
};
|
|
4772
4772
|
}
|
|
4773
|
-
interface components$
|
|
4773
|
+
interface components$l {
|
|
4774
4774
|
schemas: {
|
|
4775
4775
|
/** Defines the shape of a data variable on a Data Source or Data Type */
|
|
4776
4776
|
DataVariableDefinition: {
|
|
@@ -4811,7 +4811,7 @@ interface components$k {
|
|
|
4811
4811
|
}[];
|
|
4812
4812
|
/** Variables needed to make calls to the data source */
|
|
4813
4813
|
variables?: {
|
|
4814
|
-
[key: string]: components$
|
|
4814
|
+
[key: string]: components$l["schemas"]["DataVariableDefinition"];
|
|
4815
4815
|
};
|
|
4816
4816
|
};
|
|
4817
4817
|
/**
|
|
@@ -4841,7 +4841,7 @@ interface components$k {
|
|
|
4841
4841
|
}[];
|
|
4842
4842
|
/** Variables needed to make calls to the data source */
|
|
4843
4843
|
variables?: {
|
|
4844
|
-
[key: string]: components$
|
|
4844
|
+
[key: string]: components$l["schemas"]["DataVariableDefinition"];
|
|
4845
4845
|
};
|
|
4846
4846
|
/**
|
|
4847
4847
|
* Mapping of locale codes to data source locale codes. Keys are Uniform locale codes, values are data source locale codes.
|
|
@@ -4865,7 +4865,7 @@ interface components$k {
|
|
|
4865
4865
|
};
|
|
4866
4866
|
/** Different connector detail variants to use in the different contexts like e.g. Unpublished Data */
|
|
4867
4867
|
variants?: {
|
|
4868
|
-
unpublished?: components$
|
|
4868
|
+
unpublished?: components$l["schemas"]["AlternativeDataSourceData"];
|
|
4869
4869
|
};
|
|
4870
4870
|
/** Created date of the data source in ISO 8601 format (ignored for writes) */
|
|
4871
4871
|
created?: string;
|
|
@@ -4888,7 +4888,7 @@ interface components$k {
|
|
|
4888
4888
|
[name: string]: unknown;
|
|
4889
4889
|
};
|
|
4890
4890
|
content: {
|
|
4891
|
-
"application/json": components$
|
|
4891
|
+
"application/json": components$l["schemas"]["Error"];
|
|
4892
4892
|
};
|
|
4893
4893
|
};
|
|
4894
4894
|
/** API key or token was not valid */
|
|
@@ -4897,7 +4897,7 @@ interface components$k {
|
|
|
4897
4897
|
[name: string]: unknown;
|
|
4898
4898
|
};
|
|
4899
4899
|
content: {
|
|
4900
|
-
"application/json": components$
|
|
4900
|
+
"application/json": components$l["schemas"]["Error"];
|
|
4901
4901
|
};
|
|
4902
4902
|
};
|
|
4903
4903
|
/** Permission was denied */
|
|
@@ -4906,7 +4906,7 @@ interface components$k {
|
|
|
4906
4906
|
[name: string]: unknown;
|
|
4907
4907
|
};
|
|
4908
4908
|
content: {
|
|
4909
|
-
"application/json": components$
|
|
4909
|
+
"application/json": components$l["schemas"]["Error"];
|
|
4910
4910
|
};
|
|
4911
4911
|
};
|
|
4912
4912
|
/** Too many requests in allowed time period */
|
|
@@ -4930,7 +4930,7 @@ interface components$k {
|
|
|
4930
4930
|
pathItems: never;
|
|
4931
4931
|
}
|
|
4932
4932
|
|
|
4933
|
-
interface paths$
|
|
4933
|
+
interface paths$i {
|
|
4934
4934
|
"/api/v1/data-sources": {
|
|
4935
4935
|
parameters: {
|
|
4936
4936
|
query?: never;
|
|
@@ -4961,15 +4961,15 @@ interface paths$h {
|
|
|
4961
4961
|
};
|
|
4962
4962
|
content: {
|
|
4963
4963
|
"application/json": {
|
|
4964
|
-
results: components$
|
|
4964
|
+
results: components$k["schemas"]["DataSource"][];
|
|
4965
4965
|
};
|
|
4966
4966
|
};
|
|
4967
4967
|
};
|
|
4968
|
-
400: components$
|
|
4969
|
-
401: components$
|
|
4970
|
-
403: components$
|
|
4971
|
-
429: components$
|
|
4972
|
-
500: components$
|
|
4968
|
+
400: components$k["responses"]["BadRequestError"];
|
|
4969
|
+
401: components$k["responses"]["UnauthorizedError"];
|
|
4970
|
+
403: components$k["responses"]["ForbiddenError"];
|
|
4971
|
+
429: components$k["responses"]["RateLimitError"];
|
|
4972
|
+
500: components$k["responses"]["InternalServerError"];
|
|
4973
4973
|
};
|
|
4974
4974
|
};
|
|
4975
4975
|
put?: never;
|
|
@@ -4981,7 +4981,7 @@ interface paths$h {
|
|
|
4981
4981
|
trace?: never;
|
|
4982
4982
|
};
|
|
4983
4983
|
}
|
|
4984
|
-
interface components$
|
|
4984
|
+
interface components$k {
|
|
4985
4985
|
schemas: {
|
|
4986
4986
|
/** Defines the shape of a data variable on a Data Source or Data Type */
|
|
4987
4987
|
DataVariableDefinition: {
|
|
@@ -5022,7 +5022,7 @@ interface components$j {
|
|
|
5022
5022
|
}[];
|
|
5023
5023
|
/** Variables needed to make calls to the data source */
|
|
5024
5024
|
variables?: {
|
|
5025
|
-
[key: string]: components$
|
|
5025
|
+
[key: string]: components$k["schemas"]["DataVariableDefinition"];
|
|
5026
5026
|
};
|
|
5027
5027
|
};
|
|
5028
5028
|
/**
|
|
@@ -5052,7 +5052,7 @@ interface components$j {
|
|
|
5052
5052
|
}[];
|
|
5053
5053
|
/** Variables needed to make calls to the data source */
|
|
5054
5054
|
variables?: {
|
|
5055
|
-
[key: string]: components$
|
|
5055
|
+
[key: string]: components$k["schemas"]["DataVariableDefinition"];
|
|
5056
5056
|
};
|
|
5057
5057
|
/**
|
|
5058
5058
|
* Mapping of locale codes to data source locale codes. Keys are Uniform locale codes, values are data source locale codes.
|
|
@@ -5076,7 +5076,7 @@ interface components$j {
|
|
|
5076
5076
|
};
|
|
5077
5077
|
/** Different connector detail variants to use in the different contexts like e.g. Unpublished Data */
|
|
5078
5078
|
variants?: {
|
|
5079
|
-
unpublished?: components$
|
|
5079
|
+
unpublished?: components$k["schemas"]["AlternativeDataSourceData"];
|
|
5080
5080
|
};
|
|
5081
5081
|
/** Created date of the data source in ISO 8601 format (ignored for writes) */
|
|
5082
5082
|
created?: string;
|
|
@@ -5099,7 +5099,7 @@ interface components$j {
|
|
|
5099
5099
|
[name: string]: unknown;
|
|
5100
5100
|
};
|
|
5101
5101
|
content: {
|
|
5102
|
-
"application/json": components$
|
|
5102
|
+
"application/json": components$k["schemas"]["Error"];
|
|
5103
5103
|
};
|
|
5104
5104
|
};
|
|
5105
5105
|
/** API key or token was not valid */
|
|
@@ -5108,7 +5108,7 @@ interface components$j {
|
|
|
5108
5108
|
[name: string]: unknown;
|
|
5109
5109
|
};
|
|
5110
5110
|
content: {
|
|
5111
|
-
"application/json": components$
|
|
5111
|
+
"application/json": components$k["schemas"]["Error"];
|
|
5112
5112
|
};
|
|
5113
5113
|
};
|
|
5114
5114
|
/** Permission was denied */
|
|
@@ -5117,7 +5117,7 @@ interface components$j {
|
|
|
5117
5117
|
[name: string]: unknown;
|
|
5118
5118
|
};
|
|
5119
5119
|
content: {
|
|
5120
|
-
"application/json": components$
|
|
5120
|
+
"application/json": components$k["schemas"]["Error"];
|
|
5121
5121
|
};
|
|
5122
5122
|
};
|
|
5123
5123
|
/** Too many requests in allowed time period */
|
|
@@ -5141,7 +5141,7 @@ interface components$j {
|
|
|
5141
5141
|
pathItems: never;
|
|
5142
5142
|
}
|
|
5143
5143
|
|
|
5144
|
-
interface paths$
|
|
5144
|
+
interface paths$h {
|
|
5145
5145
|
"/api/v1/data-types": {
|
|
5146
5146
|
parameters: {
|
|
5147
5147
|
query?: never;
|
|
@@ -5167,15 +5167,15 @@ interface paths$g {
|
|
|
5167
5167
|
};
|
|
5168
5168
|
content: {
|
|
5169
5169
|
"application/json": {
|
|
5170
|
-
results: components$
|
|
5170
|
+
results: components$j["schemas"]["DataType"][];
|
|
5171
5171
|
};
|
|
5172
5172
|
};
|
|
5173
5173
|
};
|
|
5174
|
-
400: components$
|
|
5175
|
-
401: components$
|
|
5176
|
-
403: components$
|
|
5177
|
-
429: components$
|
|
5178
|
-
500: components$
|
|
5174
|
+
400: components$j["responses"]["BadRequestError"];
|
|
5175
|
+
401: components$j["responses"]["UnauthorizedError"];
|
|
5176
|
+
403: components$j["responses"]["ForbiddenError"];
|
|
5177
|
+
429: components$j["responses"]["RateLimitError"];
|
|
5178
|
+
500: components$j["responses"]["InternalServerError"];
|
|
5179
5179
|
};
|
|
5180
5180
|
};
|
|
5181
5181
|
put: {
|
|
@@ -5188,7 +5188,7 @@ interface paths$g {
|
|
|
5188
5188
|
requestBody: {
|
|
5189
5189
|
content: {
|
|
5190
5190
|
"application/json": {
|
|
5191
|
-
data: components$
|
|
5191
|
+
data: components$j["schemas"]["DataType"];
|
|
5192
5192
|
/** Format: uuid */
|
|
5193
5193
|
projectId: string;
|
|
5194
5194
|
};
|
|
@@ -5202,11 +5202,11 @@ interface paths$g {
|
|
|
5202
5202
|
};
|
|
5203
5203
|
content?: never;
|
|
5204
5204
|
};
|
|
5205
|
-
400: components$
|
|
5206
|
-
401: components$
|
|
5207
|
-
403: components$
|
|
5208
|
-
429: components$
|
|
5209
|
-
500: components$
|
|
5205
|
+
400: components$j["responses"]["BadRequestError"];
|
|
5206
|
+
401: components$j["responses"]["UnauthorizedError"];
|
|
5207
|
+
403: components$j["responses"]["ForbiddenError"];
|
|
5208
|
+
429: components$j["responses"]["RateLimitError"];
|
|
5209
|
+
500: components$j["responses"]["InternalServerError"];
|
|
5210
5210
|
};
|
|
5211
5211
|
};
|
|
5212
5212
|
post?: never;
|
|
@@ -5234,11 +5234,11 @@ interface paths$g {
|
|
|
5234
5234
|
};
|
|
5235
5235
|
content?: never;
|
|
5236
5236
|
};
|
|
5237
|
-
400: components$
|
|
5238
|
-
401: components$
|
|
5239
|
-
403: components$
|
|
5240
|
-
429: components$
|
|
5241
|
-
500: components$
|
|
5237
|
+
400: components$j["responses"]["BadRequestError"];
|
|
5238
|
+
401: components$j["responses"]["UnauthorizedError"];
|
|
5239
|
+
403: components$j["responses"]["ForbiddenError"];
|
|
5240
|
+
429: components$j["responses"]["RateLimitError"];
|
|
5241
|
+
500: components$j["responses"]["InternalServerError"];
|
|
5242
5242
|
};
|
|
5243
5243
|
};
|
|
5244
5244
|
options?: never;
|
|
@@ -5247,7 +5247,7 @@ interface paths$g {
|
|
|
5247
5247
|
trace?: never;
|
|
5248
5248
|
};
|
|
5249
5249
|
}
|
|
5250
|
-
interface components$
|
|
5250
|
+
interface components$j {
|
|
5251
5251
|
schemas: {
|
|
5252
5252
|
/** Defines the shape of a data variable on a Data Source or Data Type */
|
|
5253
5253
|
DataVariableDefinition: {
|
|
@@ -5315,7 +5315,7 @@ interface components$i {
|
|
|
5315
5315
|
method: "GET" | "POST" | "HEAD";
|
|
5316
5316
|
/** Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys */
|
|
5317
5317
|
variables?: {
|
|
5318
|
-
[key: string]: components$
|
|
5318
|
+
[key: string]: components$j["schemas"]["DataVariableDefinition"];
|
|
5319
5319
|
};
|
|
5320
5320
|
/** Custom configuration specific to the data source being defined */
|
|
5321
5321
|
custom?: {
|
|
@@ -5342,7 +5342,7 @@ interface components$i {
|
|
|
5342
5342
|
[name: string]: unknown;
|
|
5343
5343
|
};
|
|
5344
5344
|
content: {
|
|
5345
|
-
"application/json": components$
|
|
5345
|
+
"application/json": components$j["schemas"]["Error"];
|
|
5346
5346
|
};
|
|
5347
5347
|
};
|
|
5348
5348
|
/** API key or token was not valid */
|
|
@@ -5351,7 +5351,7 @@ interface components$i {
|
|
|
5351
5351
|
[name: string]: unknown;
|
|
5352
5352
|
};
|
|
5353
5353
|
content: {
|
|
5354
|
-
"application/json": components$
|
|
5354
|
+
"application/json": components$j["schemas"]["Error"];
|
|
5355
5355
|
};
|
|
5356
5356
|
};
|
|
5357
5357
|
/** Permission was denied */
|
|
@@ -5360,7 +5360,7 @@ interface components$i {
|
|
|
5360
5360
|
[name: string]: unknown;
|
|
5361
5361
|
};
|
|
5362
5362
|
content: {
|
|
5363
|
-
"application/json": components$
|
|
5363
|
+
"application/json": components$j["schemas"]["Error"];
|
|
5364
5364
|
};
|
|
5365
5365
|
};
|
|
5366
5366
|
/** Too many requests in allowed time period */
|
|
@@ -5384,7 +5384,7 @@ interface components$i {
|
|
|
5384
5384
|
pathItems: never;
|
|
5385
5385
|
}
|
|
5386
5386
|
|
|
5387
|
-
interface paths$
|
|
5387
|
+
interface paths$g {
|
|
5388
5388
|
"/api/v1/prompts": {
|
|
5389
5389
|
parameters: {
|
|
5390
5390
|
query?: never;
|
|
@@ -5411,14 +5411,14 @@ interface paths$f {
|
|
|
5411
5411
|
[name: string]: unknown;
|
|
5412
5412
|
};
|
|
5413
5413
|
content: {
|
|
5414
|
-
"application/json": components$
|
|
5414
|
+
"application/json": components$i["schemas"]["Prompt"] | components$i["schemas"]["Prompt"][];
|
|
5415
5415
|
};
|
|
5416
5416
|
};
|
|
5417
|
-
400: components$
|
|
5418
|
-
401: components$
|
|
5419
|
-
403: components$
|
|
5420
|
-
429: components$
|
|
5421
|
-
500: components$
|
|
5417
|
+
400: components$i["responses"]["BadRequestError"];
|
|
5418
|
+
401: components$i["responses"]["UnauthorizedError"];
|
|
5419
|
+
403: components$i["responses"]["ForbiddenError"];
|
|
5420
|
+
429: components$i["responses"]["RateLimitError"];
|
|
5421
|
+
500: components$i["responses"]["InternalServerError"];
|
|
5422
5422
|
};
|
|
5423
5423
|
};
|
|
5424
5424
|
/** @deprecated */
|
|
@@ -5432,7 +5432,7 @@ interface paths$f {
|
|
|
5432
5432
|
requestBody: {
|
|
5433
5433
|
content: {
|
|
5434
5434
|
"application/json": {
|
|
5435
|
-
data: components$
|
|
5435
|
+
data: components$i["schemas"]["Prompt"];
|
|
5436
5436
|
/** Format: uuid */
|
|
5437
5437
|
projectId: string;
|
|
5438
5438
|
};
|
|
@@ -5446,11 +5446,11 @@ interface paths$f {
|
|
|
5446
5446
|
};
|
|
5447
5447
|
content?: never;
|
|
5448
5448
|
};
|
|
5449
|
-
400: components$
|
|
5450
|
-
401: components$
|
|
5451
|
-
403: components$
|
|
5452
|
-
429: components$
|
|
5453
|
-
500: components$
|
|
5449
|
+
400: components$i["responses"]["BadRequestError"];
|
|
5450
|
+
401: components$i["responses"]["UnauthorizedError"];
|
|
5451
|
+
403: components$i["responses"]["ForbiddenError"];
|
|
5452
|
+
429: components$i["responses"]["RateLimitError"];
|
|
5453
|
+
500: components$i["responses"]["InternalServerError"];
|
|
5454
5454
|
};
|
|
5455
5455
|
};
|
|
5456
5456
|
post?: never;
|
|
@@ -5480,11 +5480,11 @@ interface paths$f {
|
|
|
5480
5480
|
};
|
|
5481
5481
|
content?: never;
|
|
5482
5482
|
};
|
|
5483
|
-
400: components$
|
|
5484
|
-
401: components$
|
|
5485
|
-
403: components$
|
|
5486
|
-
429: components$
|
|
5487
|
-
500: components$
|
|
5483
|
+
400: components$i["responses"]["BadRequestError"];
|
|
5484
|
+
401: components$i["responses"]["UnauthorizedError"];
|
|
5485
|
+
403: components$i["responses"]["ForbiddenError"];
|
|
5486
|
+
429: components$i["responses"]["RateLimitError"];
|
|
5487
|
+
500: components$i["responses"]["InternalServerError"];
|
|
5488
5488
|
};
|
|
5489
5489
|
};
|
|
5490
5490
|
options?: never;
|
|
@@ -5493,7 +5493,7 @@ interface paths$f {
|
|
|
5493
5493
|
trace?: never;
|
|
5494
5494
|
};
|
|
5495
5495
|
}
|
|
5496
|
-
interface components$
|
|
5496
|
+
interface components$i {
|
|
5497
5497
|
schemas: {
|
|
5498
5498
|
/** AI Prompt definition */
|
|
5499
5499
|
Prompt: {
|
|
@@ -5531,7 +5531,7 @@ interface components$h {
|
|
|
5531
5531
|
[name: string]: unknown;
|
|
5532
5532
|
};
|
|
5533
5533
|
content: {
|
|
5534
|
-
"application/json": components$
|
|
5534
|
+
"application/json": components$i["schemas"]["Error"];
|
|
5535
5535
|
};
|
|
5536
5536
|
};
|
|
5537
5537
|
/** API key or token was not valid */
|
|
@@ -5540,7 +5540,7 @@ interface components$h {
|
|
|
5540
5540
|
[name: string]: unknown;
|
|
5541
5541
|
};
|
|
5542
5542
|
content: {
|
|
5543
|
-
"application/json": components$
|
|
5543
|
+
"application/json": components$i["schemas"]["Error"];
|
|
5544
5544
|
};
|
|
5545
5545
|
};
|
|
5546
5546
|
/** Permission was denied */
|
|
@@ -5549,7 +5549,7 @@ interface components$h {
|
|
|
5549
5549
|
[name: string]: unknown;
|
|
5550
5550
|
};
|
|
5551
5551
|
content: {
|
|
5552
|
-
"application/json": components$
|
|
5552
|
+
"application/json": components$i["schemas"]["Error"];
|
|
5553
5553
|
};
|
|
5554
5554
|
};
|
|
5555
5555
|
/** Too many requests in allowed time period */
|
|
@@ -5573,10 +5573,10 @@ interface components$h {
|
|
|
5573
5573
|
pathItems: never;
|
|
5574
5574
|
}
|
|
5575
5575
|
|
|
5576
|
-
type PromptsApi = paths$
|
|
5577
|
-
type DataTypeApi = paths$
|
|
5578
|
-
type DataSourcesApi = paths$
|
|
5579
|
-
type DataSourceApi = paths$
|
|
5576
|
+
type PromptsApi = paths$g['/api/v1/prompts'];
|
|
5577
|
+
type DataTypeApi = paths$h['/api/v1/data-types'];
|
|
5578
|
+
type DataSourcesApi = paths$i['/api/v1/data-sources'];
|
|
5579
|
+
type DataSourceApi = paths$j['/api/v1/data-source'];
|
|
5580
5580
|
/** Query parameter options for GET /api/v1/data-types */
|
|
5581
5581
|
type DataTypeGetParameters = DataTypeApi['get']['parameters']['query'];
|
|
5582
5582
|
/** The GET response from /api/v1/data-types */
|
|
@@ -5605,14 +5605,14 @@ type PromptsGetResponse = PromptsApi['get']['responses']['200']['content']['appl
|
|
|
5605
5605
|
type PromptsPutParameters = PromptsApi['put']['requestBody']['content']['application/json'];
|
|
5606
5606
|
/** Shape of the DELETE request body for /api/v1/prompts */
|
|
5607
5607
|
type PromptsDeleteParameters = PromptsApi['delete']['requestBody']['content']['application/json'];
|
|
5608
|
-
type DataType = components$
|
|
5609
|
-
type DataSource = components$
|
|
5610
|
-
type DataVariableDefinition = components$
|
|
5611
|
-
type Prompt = components$
|
|
5608
|
+
type DataType = components$r['schemas']['DataType'];
|
|
5609
|
+
type DataSource = components$r['schemas']['DataSource'];
|
|
5610
|
+
type DataVariableDefinition = components$r['schemas']['DataVariableDefinition'];
|
|
5611
|
+
type Prompt = components$r['schemas']['Prompt'];
|
|
5612
5612
|
type DataSourceVariantsKeys = keyof NonNullable<DataSource['variants']>;
|
|
5613
5613
|
type DataSourceVariantData = NonNullable<DataSource['variants']>['unpublished'];
|
|
5614
5614
|
|
|
5615
|
-
interface paths$
|
|
5615
|
+
interface paths$f {
|
|
5616
5616
|
"/api/v1/labels": {
|
|
5617
5617
|
parameters: {
|
|
5618
5618
|
query?: never;
|
|
@@ -5683,11 +5683,11 @@ interface paths$e {
|
|
|
5683
5683
|
};
|
|
5684
5684
|
};
|
|
5685
5685
|
};
|
|
5686
|
-
400: components$
|
|
5687
|
-
401: components$
|
|
5688
|
-
403: components$
|
|
5689
|
-
429: components$
|
|
5690
|
-
500: components$
|
|
5686
|
+
400: components$h["responses"]["BadRequestError"];
|
|
5687
|
+
401: components$h["responses"]["UnauthorizedError"];
|
|
5688
|
+
403: components$h["responses"]["ForbiddenError"];
|
|
5689
|
+
429: components$h["responses"]["RateLimitError"];
|
|
5690
|
+
500: components$h["responses"]["InternalServerError"];
|
|
5691
5691
|
};
|
|
5692
5692
|
};
|
|
5693
5693
|
/** Creates or updates a label */
|
|
@@ -5727,11 +5727,11 @@ interface paths$e {
|
|
|
5727
5727
|
"application/json": string;
|
|
5728
5728
|
};
|
|
5729
5729
|
};
|
|
5730
|
-
400: components$
|
|
5731
|
-
401: components$
|
|
5732
|
-
403: components$
|
|
5733
|
-
429: components$
|
|
5734
|
-
500: components$
|
|
5730
|
+
400: components$h["responses"]["BadRequestError"];
|
|
5731
|
+
401: components$h["responses"]["UnauthorizedError"];
|
|
5732
|
+
403: components$h["responses"]["ForbiddenError"];
|
|
5733
|
+
429: components$h["responses"]["RateLimitError"];
|
|
5734
|
+
500: components$h["responses"]["InternalServerError"];
|
|
5735
5735
|
};
|
|
5736
5736
|
};
|
|
5737
5737
|
post?: never;
|
|
@@ -5763,11 +5763,11 @@ interface paths$e {
|
|
|
5763
5763
|
"application/json": string;
|
|
5764
5764
|
};
|
|
5765
5765
|
};
|
|
5766
|
-
400: components$
|
|
5767
|
-
401: components$
|
|
5768
|
-
403: components$
|
|
5769
|
-
429: components$
|
|
5770
|
-
500: components$
|
|
5766
|
+
400: components$h["responses"]["BadRequestError"];
|
|
5767
|
+
401: components$h["responses"]["UnauthorizedError"];
|
|
5768
|
+
403: components$h["responses"]["ForbiddenError"];
|
|
5769
|
+
429: components$h["responses"]["RateLimitError"];
|
|
5770
|
+
500: components$h["responses"]["InternalServerError"];
|
|
5771
5771
|
};
|
|
5772
5772
|
};
|
|
5773
5773
|
/** Handles preflight requests. This endpoint allows CORS. */
|
|
@@ -5794,7 +5794,7 @@ interface paths$e {
|
|
|
5794
5794
|
trace?: never;
|
|
5795
5795
|
};
|
|
5796
5796
|
}
|
|
5797
|
-
interface components$
|
|
5797
|
+
interface components$h {
|
|
5798
5798
|
schemas: {
|
|
5799
5799
|
Error: {
|
|
5800
5800
|
/** Error message(s) that occurred while processing the request */
|
|
@@ -5808,7 +5808,7 @@ interface components$g {
|
|
|
5808
5808
|
[name: string]: unknown;
|
|
5809
5809
|
};
|
|
5810
5810
|
content: {
|
|
5811
|
-
"application/json": components$
|
|
5811
|
+
"application/json": components$h["schemas"]["Error"];
|
|
5812
5812
|
};
|
|
5813
5813
|
};
|
|
5814
5814
|
/** API key or token was not valid */
|
|
@@ -5817,7 +5817,7 @@ interface components$g {
|
|
|
5817
5817
|
[name: string]: unknown;
|
|
5818
5818
|
};
|
|
5819
5819
|
content: {
|
|
5820
|
-
"application/json": components$
|
|
5820
|
+
"application/json": components$h["schemas"]["Error"];
|
|
5821
5821
|
};
|
|
5822
5822
|
};
|
|
5823
5823
|
/** Permission was denied */
|
|
@@ -5826,7 +5826,7 @@ interface components$g {
|
|
|
5826
5826
|
[name: string]: unknown;
|
|
5827
5827
|
};
|
|
5828
5828
|
content: {
|
|
5829
|
-
"application/json": components$
|
|
5829
|
+
"application/json": components$h["schemas"]["Error"];
|
|
5830
5830
|
};
|
|
5831
5831
|
};
|
|
5832
5832
|
/** Too many requests in allowed time period */
|
|
@@ -5850,14 +5850,14 @@ interface components$g {
|
|
|
5850
5850
|
pathItems: never;
|
|
5851
5851
|
}
|
|
5852
5852
|
|
|
5853
|
-
type LabelsApi = paths$
|
|
5853
|
+
type LabelsApi = paths$f['/api/v1/labels'];
|
|
5854
5854
|
type LabelsQuery = LabelsApi['get']['parameters']['query'];
|
|
5855
5855
|
type LabelPut = LabelsApi['put']['requestBody']['content']['application/json'];
|
|
5856
5856
|
type LabelDelete = LabelsApi['delete']['requestBody']['content']['application/json'];
|
|
5857
5857
|
type LabelsResponse = LabelsApi['get']['responses']['200']['content']['application/json'];
|
|
5858
5858
|
type Label = LabelsResponse['labels'][number];
|
|
5859
5859
|
|
|
5860
|
-
interface paths$
|
|
5860
|
+
interface paths$e {
|
|
5861
5861
|
"/api/v1/locales": {
|
|
5862
5862
|
parameters: {
|
|
5863
5863
|
query?: never;
|
|
@@ -5883,15 +5883,15 @@ interface paths$d {
|
|
|
5883
5883
|
};
|
|
5884
5884
|
content: {
|
|
5885
5885
|
"application/json": {
|
|
5886
|
-
results: components$
|
|
5886
|
+
results: components$g["schemas"]["Locale"][];
|
|
5887
5887
|
};
|
|
5888
5888
|
};
|
|
5889
5889
|
};
|
|
5890
|
-
400: components$
|
|
5891
|
-
401: components$
|
|
5892
|
-
403: components$
|
|
5893
|
-
429: components$
|
|
5894
|
-
500: components$
|
|
5890
|
+
400: components$g["responses"]["BadRequestError"];
|
|
5891
|
+
401: components$g["responses"]["UnauthorizedError"];
|
|
5892
|
+
403: components$g["responses"]["ForbiddenError"];
|
|
5893
|
+
429: components$g["responses"]["RateLimitError"];
|
|
5894
|
+
500: components$g["responses"]["InternalServerError"];
|
|
5895
5895
|
};
|
|
5896
5896
|
};
|
|
5897
5897
|
put: {
|
|
@@ -5903,7 +5903,7 @@ interface paths$d {
|
|
|
5903
5903
|
};
|
|
5904
5904
|
requestBody: {
|
|
5905
5905
|
content: {
|
|
5906
|
-
"application/json": components$
|
|
5906
|
+
"application/json": components$g["schemas"]["LocalePutBody"];
|
|
5907
5907
|
};
|
|
5908
5908
|
};
|
|
5909
5909
|
responses: {
|
|
@@ -5914,11 +5914,11 @@ interface paths$d {
|
|
|
5914
5914
|
};
|
|
5915
5915
|
content?: never;
|
|
5916
5916
|
};
|
|
5917
|
-
400: components$
|
|
5918
|
-
401: components$
|
|
5919
|
-
403: components$
|
|
5920
|
-
429: components$
|
|
5921
|
-
500: components$
|
|
5917
|
+
400: components$g["responses"]["BadRequestError"];
|
|
5918
|
+
401: components$g["responses"]["UnauthorizedError"];
|
|
5919
|
+
403: components$g["responses"]["ForbiddenError"];
|
|
5920
|
+
429: components$g["responses"]["RateLimitError"];
|
|
5921
|
+
500: components$g["responses"]["InternalServerError"];
|
|
5922
5922
|
};
|
|
5923
5923
|
};
|
|
5924
5924
|
post?: never;
|
|
@@ -5931,7 +5931,7 @@ interface paths$d {
|
|
|
5931
5931
|
};
|
|
5932
5932
|
requestBody: {
|
|
5933
5933
|
content: {
|
|
5934
|
-
"application/json": components$
|
|
5934
|
+
"application/json": components$g["schemas"]["LocaleDeleteBody"];
|
|
5935
5935
|
};
|
|
5936
5936
|
};
|
|
5937
5937
|
responses: {
|
|
@@ -5942,11 +5942,11 @@ interface paths$d {
|
|
|
5942
5942
|
};
|
|
5943
5943
|
content?: never;
|
|
5944
5944
|
};
|
|
5945
|
-
400: components$
|
|
5946
|
-
401: components$
|
|
5947
|
-
403: components$
|
|
5948
|
-
429: components$
|
|
5949
|
-
500: components$
|
|
5945
|
+
400: components$g["responses"]["BadRequestError"];
|
|
5946
|
+
401: components$g["responses"]["UnauthorizedError"];
|
|
5947
|
+
403: components$g["responses"]["ForbiddenError"];
|
|
5948
|
+
429: components$g["responses"]["RateLimitError"];
|
|
5949
|
+
500: components$g["responses"]["InternalServerError"];
|
|
5950
5950
|
};
|
|
5951
5951
|
};
|
|
5952
5952
|
options?: never;
|
|
@@ -5955,7 +5955,7 @@ interface paths$d {
|
|
|
5955
5955
|
trace?: never;
|
|
5956
5956
|
};
|
|
5957
5957
|
}
|
|
5958
|
-
interface components$
|
|
5958
|
+
interface components$g {
|
|
5959
5959
|
schemas: {
|
|
5960
5960
|
Locale: {
|
|
5961
5961
|
/**
|
|
@@ -5996,7 +5996,7 @@ interface components$f {
|
|
|
5996
5996
|
order?: number;
|
|
5997
5997
|
};
|
|
5998
5998
|
LocalePutBody: {
|
|
5999
|
-
locale: components$
|
|
5999
|
+
locale: components$g["schemas"]["Locale"];
|
|
6000
6000
|
/**
|
|
6001
6001
|
* Format: uuid
|
|
6002
6002
|
* The project ID
|
|
@@ -6023,7 +6023,7 @@ interface components$f {
|
|
|
6023
6023
|
[name: string]: unknown;
|
|
6024
6024
|
};
|
|
6025
6025
|
content: {
|
|
6026
|
-
"application/json": components$
|
|
6026
|
+
"application/json": components$g["schemas"]["Error"];
|
|
6027
6027
|
};
|
|
6028
6028
|
};
|
|
6029
6029
|
/** API key or token was not valid */
|
|
@@ -6032,7 +6032,7 @@ interface components$f {
|
|
|
6032
6032
|
[name: string]: unknown;
|
|
6033
6033
|
};
|
|
6034
6034
|
content: {
|
|
6035
|
-
"application/json": components$
|
|
6035
|
+
"application/json": components$g["schemas"]["Error"];
|
|
6036
6036
|
};
|
|
6037
6037
|
};
|
|
6038
6038
|
/** Permission was denied */
|
|
@@ -6041,7 +6041,7 @@ interface components$f {
|
|
|
6041
6041
|
[name: string]: unknown;
|
|
6042
6042
|
};
|
|
6043
6043
|
content: {
|
|
6044
|
-
"application/json": components$
|
|
6044
|
+
"application/json": components$g["schemas"]["Error"];
|
|
6045
6045
|
};
|
|
6046
6046
|
};
|
|
6047
6047
|
/** Too many requests in allowed time period */
|
|
@@ -6065,9 +6065,9 @@ interface components$f {
|
|
|
6065
6065
|
pathItems: never;
|
|
6066
6066
|
}
|
|
6067
6067
|
|
|
6068
|
-
type LocalesApi = paths$
|
|
6068
|
+
type LocalesApi = paths$e['/api/v1/locales'];
|
|
6069
6069
|
/** A locale definition */
|
|
6070
|
-
type Locale = components$
|
|
6070
|
+
type Locale = components$g['schemas']['Locale'];
|
|
6071
6071
|
/** Query parameter options for GET /api/v1/locales */
|
|
6072
6072
|
type LocalesGetParameters = LocalesApi['get']['parameters']['query'];
|
|
6073
6073
|
/** The GET response from /api/v1/locales */
|
|
@@ -6078,6 +6078,290 @@ type LocalePutParameters = LocalesApi['put']['requestBody']['content']['applicat
|
|
|
6078
6078
|
type LocaleDeleteParameters = LocalesApi['delete']['requestBody']['content']['application/json'];
|
|
6079
6079
|
declare const LOCALE_DYNAMIC_INPUT_NAME = "locale";
|
|
6080
6080
|
|
|
6081
|
+
interface paths$d {
|
|
6082
|
+
"/api/v1/views": {
|
|
6083
|
+
parameters: {
|
|
6084
|
+
query?: never;
|
|
6085
|
+
header?: never;
|
|
6086
|
+
path?: never;
|
|
6087
|
+
cookie?: never;
|
|
6088
|
+
};
|
|
6089
|
+
/** Lists saved views for a project + resource type. */
|
|
6090
|
+
get: {
|
|
6091
|
+
parameters: {
|
|
6092
|
+
query: {
|
|
6093
|
+
/** Project the views belong to. */
|
|
6094
|
+
projectId: string;
|
|
6095
|
+
/** Resource type these views apply to (e.g. "entry"). */
|
|
6096
|
+
resourceType: "composition" | "compositionPattern" | "component" | "componentPattern" | "entry" | "entryPattern" | "contentType" | "blockType" | "release" | "signal" | "intent" | "audience" | "asset";
|
|
6097
|
+
/** Number of records to skip. */
|
|
6098
|
+
offset?: number | null;
|
|
6099
|
+
/** Maximum number of records to return. */
|
|
6100
|
+
limit?: number;
|
|
6101
|
+
};
|
|
6102
|
+
header?: never;
|
|
6103
|
+
path?: never;
|
|
6104
|
+
cookie?: never;
|
|
6105
|
+
};
|
|
6106
|
+
requestBody?: never;
|
|
6107
|
+
responses: {
|
|
6108
|
+
/** OK */
|
|
6109
|
+
200: {
|
|
6110
|
+
headers: {
|
|
6111
|
+
[name: string]: unknown;
|
|
6112
|
+
};
|
|
6113
|
+
content: {
|
|
6114
|
+
"application/json": {
|
|
6115
|
+
views: {
|
|
6116
|
+
name: string;
|
|
6117
|
+
description?: string;
|
|
6118
|
+
searchTerm?: string;
|
|
6119
|
+
filters: {
|
|
6120
|
+
field: string;
|
|
6121
|
+
dynamicField?: string;
|
|
6122
|
+
operator: string;
|
|
6123
|
+
value: string | string[];
|
|
6124
|
+
}[];
|
|
6125
|
+
sort?: string[];
|
|
6126
|
+
shared: boolean;
|
|
6127
|
+
icon?: string;
|
|
6128
|
+
id: string;
|
|
6129
|
+
projectId: string;
|
|
6130
|
+
/** @enum {string} */
|
|
6131
|
+
resourceType: "composition" | "compositionPattern" | "component" | "componentPattern" | "entry" | "entryPattern" | "contentType" | "blockType" | "release" | "signal" | "intent" | "audience" | "asset";
|
|
6132
|
+
createdBy: string | null;
|
|
6133
|
+
/** Format: date-time */
|
|
6134
|
+
created: string;
|
|
6135
|
+
/** Format: date-time */
|
|
6136
|
+
modified: string;
|
|
6137
|
+
}[];
|
|
6138
|
+
totalCount: number;
|
|
6139
|
+
};
|
|
6140
|
+
};
|
|
6141
|
+
};
|
|
6142
|
+
400: components$f["responses"]["BadRequestError"];
|
|
6143
|
+
401: components$f["responses"]["UnauthorizedError"];
|
|
6144
|
+
403: components$f["responses"]["ForbiddenError"];
|
|
6145
|
+
429: components$f["responses"]["RateLimitError"];
|
|
6146
|
+
500: components$f["responses"]["InternalServerError"];
|
|
6147
|
+
};
|
|
6148
|
+
};
|
|
6149
|
+
/** Create-or-replace a saved view by id. The caller mints the UUID. Omitted optional fields are cleared. `shared` may only be promoted (personal → shared); demotion returns 400. `projectId` and `resourceType` are immutable after create. */
|
|
6150
|
+
put: {
|
|
6151
|
+
parameters: {
|
|
6152
|
+
query?: never;
|
|
6153
|
+
header?: never;
|
|
6154
|
+
path?: never;
|
|
6155
|
+
cookie?: never;
|
|
6156
|
+
};
|
|
6157
|
+
requestBody: {
|
|
6158
|
+
content: {
|
|
6159
|
+
"application/json": {
|
|
6160
|
+
name: string;
|
|
6161
|
+
description?: string;
|
|
6162
|
+
searchTerm?: string;
|
|
6163
|
+
filters: {
|
|
6164
|
+
field: string;
|
|
6165
|
+
dynamicField?: string;
|
|
6166
|
+
operator: string;
|
|
6167
|
+
value: string | string[];
|
|
6168
|
+
}[];
|
|
6169
|
+
sort?: string[];
|
|
6170
|
+
shared: boolean;
|
|
6171
|
+
icon?: string;
|
|
6172
|
+
id: string;
|
|
6173
|
+
projectId: string;
|
|
6174
|
+
/** @enum {string} */
|
|
6175
|
+
resourceType: "composition" | "compositionPattern" | "component" | "componentPattern" | "entry" | "entryPattern" | "contentType" | "blockType" | "release" | "signal" | "intent" | "audience" | "asset";
|
|
6176
|
+
};
|
|
6177
|
+
};
|
|
6178
|
+
};
|
|
6179
|
+
responses: {
|
|
6180
|
+
/** OK */
|
|
6181
|
+
200: {
|
|
6182
|
+
headers: {
|
|
6183
|
+
[name: string]: unknown;
|
|
6184
|
+
};
|
|
6185
|
+
content: {
|
|
6186
|
+
"application/json": {
|
|
6187
|
+
name: string;
|
|
6188
|
+
description?: string;
|
|
6189
|
+
searchTerm?: string;
|
|
6190
|
+
filters: {
|
|
6191
|
+
field: string;
|
|
6192
|
+
dynamicField?: string;
|
|
6193
|
+
operator: string;
|
|
6194
|
+
value: string | string[];
|
|
6195
|
+
}[];
|
|
6196
|
+
sort?: string[];
|
|
6197
|
+
shared: boolean;
|
|
6198
|
+
icon?: string;
|
|
6199
|
+
id: string;
|
|
6200
|
+
projectId: string;
|
|
6201
|
+
/** @enum {string} */
|
|
6202
|
+
resourceType: "composition" | "compositionPattern" | "component" | "componentPattern" | "entry" | "entryPattern" | "contentType" | "blockType" | "release" | "signal" | "intent" | "audience" | "asset";
|
|
6203
|
+
createdBy: string | null;
|
|
6204
|
+
/** Format: date-time */
|
|
6205
|
+
created: string;
|
|
6206
|
+
/** Format: date-time */
|
|
6207
|
+
modified: string;
|
|
6208
|
+
};
|
|
6209
|
+
};
|
|
6210
|
+
};
|
|
6211
|
+
400: components$f["responses"]["BadRequestError"];
|
|
6212
|
+
401: components$f["responses"]["UnauthorizedError"];
|
|
6213
|
+
403: components$f["responses"]["ForbiddenError"];
|
|
6214
|
+
/** View not found (or belongs to another project). */
|
|
6215
|
+
404: {
|
|
6216
|
+
headers: {
|
|
6217
|
+
[name: string]: unknown;
|
|
6218
|
+
};
|
|
6219
|
+
content?: never;
|
|
6220
|
+
};
|
|
6221
|
+
/** Quota exceeded: at most 100 saved views allowed for this project + resource type + user. Remove an existing view before creating a new one. */
|
|
6222
|
+
409: {
|
|
6223
|
+
headers: {
|
|
6224
|
+
[name: string]: unknown;
|
|
6225
|
+
};
|
|
6226
|
+
content?: never;
|
|
6227
|
+
};
|
|
6228
|
+
429: components$f["responses"]["RateLimitError"];
|
|
6229
|
+
500: components$f["responses"]["InternalServerError"];
|
|
6230
|
+
};
|
|
6231
|
+
};
|
|
6232
|
+
post?: never;
|
|
6233
|
+
/** Deletes a saved view by id. */
|
|
6234
|
+
delete: {
|
|
6235
|
+
parameters: {
|
|
6236
|
+
query?: never;
|
|
6237
|
+
header?: never;
|
|
6238
|
+
path?: never;
|
|
6239
|
+
cookie?: never;
|
|
6240
|
+
};
|
|
6241
|
+
requestBody: {
|
|
6242
|
+
content: {
|
|
6243
|
+
"application/json": {
|
|
6244
|
+
id: string;
|
|
6245
|
+
projectId: string;
|
|
6246
|
+
};
|
|
6247
|
+
};
|
|
6248
|
+
};
|
|
6249
|
+
responses: {
|
|
6250
|
+
/** No Content */
|
|
6251
|
+
204: {
|
|
6252
|
+
headers: {
|
|
6253
|
+
[name: string]: unknown;
|
|
6254
|
+
};
|
|
6255
|
+
content: {
|
|
6256
|
+
"application/json": string;
|
|
6257
|
+
};
|
|
6258
|
+
};
|
|
6259
|
+
400: components$f["responses"]["BadRequestError"];
|
|
6260
|
+
401: components$f["responses"]["UnauthorizedError"];
|
|
6261
|
+
403: components$f["responses"]["ForbiddenError"];
|
|
6262
|
+
/** View not found. */
|
|
6263
|
+
404: {
|
|
6264
|
+
headers: {
|
|
6265
|
+
[name: string]: unknown;
|
|
6266
|
+
};
|
|
6267
|
+
content?: never;
|
|
6268
|
+
};
|
|
6269
|
+
429: components$f["responses"]["RateLimitError"];
|
|
6270
|
+
500: components$f["responses"]["InternalServerError"];
|
|
6271
|
+
};
|
|
6272
|
+
};
|
|
6273
|
+
/** Handles preflight requests. This endpoint allows CORS. */
|
|
6274
|
+
options: {
|
|
6275
|
+
parameters: {
|
|
6276
|
+
query?: never;
|
|
6277
|
+
header?: never;
|
|
6278
|
+
path?: never;
|
|
6279
|
+
cookie?: never;
|
|
6280
|
+
};
|
|
6281
|
+
requestBody?: never;
|
|
6282
|
+
responses: {
|
|
6283
|
+
/** ok */
|
|
6284
|
+
204: {
|
|
6285
|
+
headers: {
|
|
6286
|
+
[name: string]: unknown;
|
|
6287
|
+
};
|
|
6288
|
+
content?: never;
|
|
6289
|
+
};
|
|
6290
|
+
};
|
|
6291
|
+
};
|
|
6292
|
+
head?: never;
|
|
6293
|
+
patch?: never;
|
|
6294
|
+
trace?: never;
|
|
6295
|
+
};
|
|
6296
|
+
}
|
|
6297
|
+
interface components$f {
|
|
6298
|
+
schemas: {
|
|
6299
|
+
Error: {
|
|
6300
|
+
/** Error message(s) that occurred while processing the request */
|
|
6301
|
+
errorMessage?: string[] | string;
|
|
6302
|
+
};
|
|
6303
|
+
};
|
|
6304
|
+
responses: {
|
|
6305
|
+
/** Request input validation failed */
|
|
6306
|
+
BadRequestError: {
|
|
6307
|
+
headers: {
|
|
6308
|
+
[name: string]: unknown;
|
|
6309
|
+
};
|
|
6310
|
+
content: {
|
|
6311
|
+
"application/json": components$f["schemas"]["Error"];
|
|
6312
|
+
};
|
|
6313
|
+
};
|
|
6314
|
+
/** API key or token was not valid */
|
|
6315
|
+
UnauthorizedError: {
|
|
6316
|
+
headers: {
|
|
6317
|
+
[name: string]: unknown;
|
|
6318
|
+
};
|
|
6319
|
+
content: {
|
|
6320
|
+
"application/json": components$f["schemas"]["Error"];
|
|
6321
|
+
};
|
|
6322
|
+
};
|
|
6323
|
+
/** Permission was denied */
|
|
6324
|
+
ForbiddenError: {
|
|
6325
|
+
headers: {
|
|
6326
|
+
[name: string]: unknown;
|
|
6327
|
+
};
|
|
6328
|
+
content: {
|
|
6329
|
+
"application/json": components$f["schemas"]["Error"];
|
|
6330
|
+
};
|
|
6331
|
+
};
|
|
6332
|
+
/** Too many requests in allowed time period */
|
|
6333
|
+
RateLimitError: {
|
|
6334
|
+
headers: {
|
|
6335
|
+
[name: string]: unknown;
|
|
6336
|
+
};
|
|
6337
|
+
content?: never;
|
|
6338
|
+
};
|
|
6339
|
+
/** Execution error occurred */
|
|
6340
|
+
InternalServerError: {
|
|
6341
|
+
headers: {
|
|
6342
|
+
[name: string]: unknown;
|
|
6343
|
+
};
|
|
6344
|
+
content?: never;
|
|
6345
|
+
};
|
|
6346
|
+
};
|
|
6347
|
+
parameters: never;
|
|
6348
|
+
requestBodies: never;
|
|
6349
|
+
headers: never;
|
|
6350
|
+
pathItems: never;
|
|
6351
|
+
}
|
|
6352
|
+
|
|
6353
|
+
type ViewsApi = paths$d['/api/v1/views'];
|
|
6354
|
+
type ViewsQuery = ViewsApi['get']['parameters']['query'];
|
|
6355
|
+
type ViewPut = ViewsApi['put']['requestBody']['content']['application/json'];
|
|
6356
|
+
type ViewDelete = ViewsApi['delete']['requestBody']['content']['application/json'];
|
|
6357
|
+
type ViewsResponse = ViewsApi['get']['responses']['200']['content']['application/json'];
|
|
6358
|
+
type View = ViewsResponse['views'][number];
|
|
6359
|
+
/**
|
|
6360
|
+
* File/sync shape for a shared custom view. Audit fields and `projectId` are
|
|
6361
|
+
* stripped on pull; `id` is kept so PUT is create-or-replace across projects.
|
|
6362
|
+
*/
|
|
6363
|
+
type SerializedCustomView = Omit<View, 'projectId' | 'createdBy' | 'created' | 'modified'>;
|
|
6364
|
+
|
|
6081
6365
|
interface components$e {
|
|
6082
6366
|
schemas: {
|
|
6083
6367
|
RouteResponse: components$e["schemas"]["RouteResponseRedirect"] | components$e["schemas"]["RouteResponseComposition"] | components$e["schemas"]["RouteResponseNotFound"];
|
|
@@ -10923,7 +11207,7 @@ interface components$a {
|
|
|
10923
11207
|
}
|
|
10924
11208
|
|
|
10925
11209
|
type Components = components$d['schemas'];
|
|
10926
|
-
type SharedComponents$1 = components$
|
|
11210
|
+
type SharedComponents$1 = components$r['schemas'];
|
|
10927
11211
|
type Api = paths$c['/api/v1/canvas'];
|
|
10928
11212
|
type HistoryApi = paths$b['/api/v1/canvas-history'];
|
|
10929
11213
|
/** Query parameter options for GET /api/v1/canvas */
|
|
@@ -11071,6 +11355,7 @@ type CanvasDefinitions = {
|
|
|
11071
11355
|
previewUrls?: Array<PreviewUrl>;
|
|
11072
11356
|
previewViewports?: Array<PreviewViewport>;
|
|
11073
11357
|
webhooks?: Array<WebhookDefinition>;
|
|
11358
|
+
customViews?: Array<SerializedCustomView>;
|
|
11074
11359
|
};
|
|
11075
11360
|
/** Defines shared parameters for requests getting a single composition */
|
|
11076
11361
|
type CompositionGetOneSharedParameters = Pick<CompositionGetParameters, 'state' | 'skipEnhance' | 'skipPatternResolution' | 'withComponentIDs' | 'withUIStatus' | 'withWorkflowDefinition' | 'withProjectMapNodes' | 'withTotalCount' | 'skipOverridesResolution' | 'withContentSourceMap' | 'versionId' | 'locale' | 'releaseId' | 'editions' | 'deleted' | 'pattern' | 'withPatternType'>;
|
|
@@ -11184,8 +11469,8 @@ type RouteGetResponseRedirect = components$e['schemas']['RouteResponseRedirect']
|
|
|
11184
11469
|
type RouteGetResponseNotFound = components$e['schemas']['RouteResponseNotFound'];
|
|
11185
11470
|
type RouteDynamicInputs = components$e['schemas']['RouteDynamicInputs'];
|
|
11186
11471
|
/** The GET response from /api/v1/entries */
|
|
11187
|
-
type EntriesGetParameters = paths$
|
|
11188
|
-
type EntriesGetResponse = components$
|
|
11472
|
+
type EntriesGetParameters = paths$l['/api/v1/entries']['get']['parameters']['query'] & DataResolutionParameters;
|
|
11473
|
+
type EntriesGetResponse = components$p['schemas']['EntryListResponse'];
|
|
11189
11474
|
type EntriesResolvedListResponse = components$b['schemas']['EntryResolvedListResponse'];
|
|
11190
11475
|
/** GET response from uniform.global/api/v1/route when result is a composition */
|
|
11191
11476
|
type RouteGetResponseEdgehancedComposition = Omit<RouteGetResponseComposition, 'compositionApiResponse'> & {
|
|
@@ -13336,7 +13621,7 @@ interface components$3 {
|
|
|
13336
13621
|
}
|
|
13337
13622
|
|
|
13338
13623
|
type WorkflowsApi = paths$3['/api/v1/workflows'];
|
|
13339
|
-
type SharedComponents = components$
|
|
13624
|
+
type SharedComponents = components$r['schemas'];
|
|
13340
13625
|
type WorkflowDefinition = SharedComponents['WorkflowDefinition'];
|
|
13341
13626
|
type WorkflowStage = SharedComponents['WorkflowStage'];
|
|
13342
13627
|
type WorkflowStagePermission = SharedComponents['WorkflowStagePermission'];
|
|
@@ -13659,7 +13944,7 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
|
|
|
13659
13944
|
getCompositionHistory(options: ExceptProject<ComponentInstanceHistoryGetParameters>): Promise<{
|
|
13660
13945
|
cursor?: string;
|
|
13661
13946
|
truncated?: boolean;
|
|
13662
|
-
results?: components$
|
|
13947
|
+
results?: components$r["schemas"]["HistoryEntry"][];
|
|
13663
13948
|
}>;
|
|
13664
13949
|
private getOneComposition;
|
|
13665
13950
|
/** Updates or creates a Canvas component definition */
|
|
@@ -13670,7 +13955,7 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
|
|
|
13670
13955
|
removeComposition(body: Omit<CompositionDeleteParameters, 'projectId'>): Promise<void>;
|
|
13671
13956
|
/** Fetches all Canvas component definitions */
|
|
13672
13957
|
getComponentDefinitions(options?: Omit<ComponentDefinitionGetParameters, 'projectId'>): Promise<{
|
|
13673
|
-
componentDefinitions: components$
|
|
13958
|
+
componentDefinitions: components$q["schemas"]["ComponentDefinition"][];
|
|
13674
13959
|
}>;
|
|
13675
13960
|
/** Updates or creates a Canvas component definition */
|
|
13676
13961
|
updateComponentDefinition(body: Omit<ComponentDefinitionPutParameters, 'projectId'>): Promise<void>;
|
|
@@ -13712,7 +13997,7 @@ declare class ContentClient extends ApiClient<ContentClientOptions> {
|
|
|
13712
13997
|
getEntryHistory(options: ExceptProject<EntriesHistoryGetParameters>): Promise<{
|
|
13713
13998
|
cursor?: string;
|
|
13714
13999
|
truncated?: boolean;
|
|
13715
|
-
results?: components$
|
|
14000
|
+
results?: components$r["schemas"]["HistoryEntry"][];
|
|
13716
14001
|
}>;
|
|
13717
14002
|
upsertContentType(body: ExceptProject<PutContentTypeBody>, opts?: {
|
|
13718
14003
|
autogenerateDataTypes?: boolean;
|
|
@@ -13737,15 +14022,15 @@ declare class DataSourceClient extends ApiClient {
|
|
|
13737
14022
|
constructor(options: ClientOptions);
|
|
13738
14023
|
/** Fetches a single DataSource by id (with decrypted secrets). */
|
|
13739
14024
|
get(options?: ExceptProject<DataSourceGetParameters>): Promise<{
|
|
13740
|
-
result: components$
|
|
14025
|
+
result: components$l["schemas"]["DataSource"];
|
|
13741
14026
|
}>;
|
|
13742
14027
|
/** Fetches the list of DataSources for a project (secrets masked). */
|
|
13743
14028
|
list(options?: ExceptProject<DataSourcesGetParameters>): Promise<{
|
|
13744
|
-
results: components$
|
|
14029
|
+
results: components$k["schemas"]["DataSource"][];
|
|
13745
14030
|
}>;
|
|
13746
14031
|
/** @deprecated Use {@link list} instead. */
|
|
13747
14032
|
getList(options?: ExceptProject<DataSourcesGetParameters>): Promise<{
|
|
13748
|
-
results: components$
|
|
14033
|
+
results: components$k["schemas"]["DataSource"][];
|
|
13749
14034
|
}>;
|
|
13750
14035
|
/** Updates or creates (based on id) a DataSource */
|
|
13751
14036
|
save(body: ExceptProject<DataSourcePutParameters>): Promise<void>;
|
|
@@ -14122,9 +14407,9 @@ type VisibilityParameterValue = {
|
|
|
14122
14407
|
/** Criteria for the visibility of the component. If these evaluate to false, the component is hidden. */
|
|
14123
14408
|
criteria?: VisibilityCriteriaGroup;
|
|
14124
14409
|
};
|
|
14125
|
-
type VisibilityCriteriaGroup = components$
|
|
14126
|
-
type VisibilityCriteria = components$
|
|
14127
|
-
type ComponentParameterConditionalValue<TValue = unknown> = Omit<components$
|
|
14410
|
+
type VisibilityCriteriaGroup = components$r['schemas']['VisibilityCriteriaGroup'];
|
|
14411
|
+
type VisibilityCriteria = components$r['schemas']['VisibilityCriteria'];
|
|
14412
|
+
type ComponentParameterConditionalValue<TValue = unknown> = Omit<components$r['schemas']['ComponentParameterConditionalValue'], 'value'> & {
|
|
14128
14413
|
value: TValue;
|
|
14129
14414
|
};
|
|
14130
14415
|
/**
|
|
@@ -14388,11 +14673,11 @@ declare class LocaleClient extends ApiClient {
|
|
|
14388
14673
|
constructor(options: ClientOptions);
|
|
14389
14674
|
/** Fetches a list of locales for a project */
|
|
14390
14675
|
list(options?: ExceptProject<LocalesGetParameters>): Promise<{
|
|
14391
|
-
results: components$
|
|
14676
|
+
results: components$g["schemas"]["Locale"][];
|
|
14392
14677
|
}>;
|
|
14393
14678
|
/** @deprecated Use {@link list} instead. */
|
|
14394
14679
|
get(options?: ExceptProject<LocalesGetParameters>): Promise<{
|
|
14395
|
-
results: components$
|
|
14680
|
+
results: components$g["schemas"]["Locale"][];
|
|
14396
14681
|
}>;
|
|
14397
14682
|
/** Updates or creates (based on id) a locale */
|
|
14398
14683
|
save(body: ExceptProject<LocalePutParameters>): Promise<void>;
|
|
@@ -15546,12 +15831,12 @@ declare const createUniformApiEnhancer: ({ apiUrl }: {
|
|
|
15546
15831
|
}) => (message: Pick<UpdateCompositionMessage, "composition" | "hash">) => Promise<{
|
|
15547
15832
|
type: string;
|
|
15548
15833
|
parameters?: {
|
|
15549
|
-
[key: string]: components$
|
|
15834
|
+
[key: string]: components$r["schemas"]["ComponentParameter"];
|
|
15550
15835
|
};
|
|
15551
15836
|
variant?: string;
|
|
15552
|
-
projectMapNodes?: components$
|
|
15837
|
+
projectMapNodes?: components$r["schemas"]["CompositionProjectMapNodeInfo"][];
|
|
15553
15838
|
slots?: {
|
|
15554
|
-
[key: string]: components$
|
|
15839
|
+
[key: string]: components$r["schemas"]["ComponentInstance"][];
|
|
15555
15840
|
};
|
|
15556
15841
|
_id: string;
|
|
15557
15842
|
_slug?: string | null;
|
|
@@ -15562,18 +15847,18 @@ declare const createUniformApiEnhancer: ({ apiUrl }: {
|
|
|
15562
15847
|
_creatorSubject?: string;
|
|
15563
15848
|
_pattern?: string;
|
|
15564
15849
|
_patternDataResources?: {
|
|
15565
|
-
[key: string]: components$
|
|
15850
|
+
[key: string]: components$r["schemas"]["DataResourceDefinition"];
|
|
15566
15851
|
};
|
|
15567
15852
|
_patternOptedInQueryStrings?: string[];
|
|
15568
|
-
_dataResources?: components$
|
|
15569
|
-
_patternError?: components$
|
|
15853
|
+
_dataResources?: components$r["schemas"]["DataResourceDefinitions"];
|
|
15854
|
+
_patternError?: components$r["schemas"]["PatternError"];
|
|
15570
15855
|
_overrides?: {
|
|
15571
|
-
[key: string]: components$
|
|
15856
|
+
[key: string]: components$r["schemas"]["ComponentOverride"];
|
|
15572
15857
|
};
|
|
15573
15858
|
_patternOverrides?: {
|
|
15574
|
-
[key: string]: components$
|
|
15859
|
+
[key: string]: components$r["schemas"]["ComponentOverride"];
|
|
15575
15860
|
};
|
|
15576
|
-
_overridability?: components$
|
|
15861
|
+
_overridability?: components$r["schemas"]["ComponentOverridability"];
|
|
15577
15862
|
_locales?: string[];
|
|
15578
15863
|
_optedInQueryStrings?: string[];
|
|
15579
15864
|
}>;
|
|
@@ -15832,4 +16117,4 @@ declare class WorkflowClient extends ApiClient {
|
|
|
15832
16117
|
|
|
15833
16118
|
declare const CanvasClientError: typeof ApiClientError;
|
|
15834
16119
|
|
|
15835
|
-
export { ASSETS_SOURCE_CUSTOM_URL, ASSETS_SOURCE_UNIFORM, ASSET_PARAMETER_TYPE, ATTRIBUTE_COMPONENT_ID, ATTRIBUTE_MULTILINE, ATTRIBUTE_PARAMETER_ID, ATTRIBUTE_PARAMETER_TYPE, ATTRIBUTE_PARAMETER_VALUE, ATTRIBUTE_PLACEHOLDER, type AddComponentMessage, type AiAction, type AssetParamConfig, type AwaitingReadyMessage, type BatchEnhancer, BatchEntry, type BatchInvalidationPayload, type BindVariablesOptions, type BindVariablesResult, type BindVariablesToObjectOptions, BlockFormatError, type BlockLocationReference, type BlockValue, CANVAS_BLOCK_PARAM_TYPE, CANVAS_COMPONENT_DISPLAY_NAME_PARAM, CANVAS_CONTEXTUAL_EDITING_PARAM, CANVAS_DRAFT_STATE, CANVAS_EDITOR_STATE, CANVAS_ENRICHMENT_TAG_PARAM, CANVAS_HYPOTHESIS_PARAM, CANVAS_INTENT_TAG_PARAM, CANVAS_INTERNAL_PARAM_PREFIX, CANVAS_LOCALE_TAG_PARAM, CANVAS_LOCALIZATION_SLOT, CANVAS_LOCALIZATION_TYPE, CANVAS_PERSONALIZATION_ALGORITHM_PARAM, CANVAS_PERSONALIZATION_ALGORITHM_TYPE, CANVAS_PERSONALIZATION_EVENT_NAME_PARAM, CANVAS_PERSONALIZATION_PARAM, CANVAS_PERSONALIZATION_TAKE_PARAM, CANVAS_PERSONALIZE_SLOT, CANVAS_PERSONALIZE_TYPE, CANVAS_PUBLISHED_STATE, CANVAS_SLOT_SECTION_GROUP_TYPE_PARAM, CANVAS_SLOT_SECTION_MAX_PARAM, CANVAS_SLOT_SECTION_MIN_PARAM, CANVAS_SLOT_SECTION_NAME_PARAM, CANVAS_SLOT_SECTION_SLOT, CANVAS_SLOT_SECTION_SPECIFIC_PARAM, CANVAS_SLOT_SECTION_TYPE, CANVAS_TEST_SLOT, CANVAS_TEST_TYPE, CANVAS_TEST_VARIANT_PARAM, CANVAS_VIZ_CONTROL_PARAM, CANVAS_VIZ_DI_RULE, CANVAS_VIZ_DYNAMIC_TOKEN_RULE, CANVAS_VIZ_LOCALE_RULE, CANVAS_VIZ_QUIRKS_RULE, CanvasClient, CanvasClientError, type CanvasDefinitions, type CategoriesDeleteParameters, type CategoriesGetParameters, type CategoriesGetResponse, type CategoriesPutParameters, type Category, CategoryClient, type Channel, type ChannelMessage, ChildEnhancerBuilder, type ComponentDefinition, ComponentDefinitionClient, type ComponentDefinitionDeleteParameters, type ComponentDefinitionGetParameters, type ComponentDefinitionGetResponse, type ComponentDefinitionParameter, type ComponentDefinitionPermission, type ComponentDefinitionPutParameters, type ComponentDefinitionSlot, type ComponentDefinitionSlugSettings, type ComponentDefinitionVariant, type ComponentEnhancer, type ComponentEnhancerFunction, type ComponentEnhancerOptions, type ComponentInstance, type ComponentInstanceContextualEditing, type ComponentInstanceHistoryEntry, type ComponentInstanceHistoryGetParameters, type ComponentInstanceHistoryGetResponse, type ComponentLocationReference, type ComponentOverridability, type ComponentOverride, type ComponentOverrides, type ComponentParameter, type ComponentParameterBlock, type ComponentParameterConditionalValue, type ComponentParameterContextualEditing, type ComponentParameterEnhancer, type ComponentParameterEnhancerFunction, type ComponentParameterEnhancerOptions, type CompositionDeleteParameters, CompositionDeliveryClient, type CompositionDeliveryListQuery, type CompositionDeliveryReadOptions, type CompositionDeliverySelector, type CompositionFilters, type CompositionGetByComponentIdParameters, type CompositionGetByIdParameters, type CompositionGetByNodeIdParameters, type CompositionGetByNodePathParameters, type CompositionGetBySlugParameters, type CompositionGetListResponse, type CompositionGetParameters, type CompositionGetResponse, type CompositionGetValidResponses, type CompositionListQuery, CompositionManagementClient, type CompositionManagementListQuery, type CompositionManagementReadOptions, type CompositionManagementSelector, type CompositionPutParameters, type CompositionReadOptions, type CompositionResolvedGetResponse, type CompositionResolvedListResponse, type CompositionUIStatus, type CompositionWriteSelector, ContentClient, type ContentType, ContentTypeClient, type ContentTypeField, type ContentTypePreviewConfiguration, type ContextStorageUpdatedMessage, type ContextualEditingComponentReference, type ContextualEditingValue, type CopiedComponentSubtree, type DataDiagnostic, type DataElementBindingIssue, type DataElementConnectionDefinition, type DataElementConnectionFailureAction, type DataElementConnectionFailureLogLevel, type DataResolutionConfigIssue, type DataResolutionIssue, type DataResolutionOption, type DataResolutionOptionNegative, type DataResolutionOptionPositive, type DataResolutionParameters, type DataResourceDefinition, type DataResourceDefinitions, type DataResourceIssue, type DataResourceVariables, type DataSource, DataSourceClient, type DataSourceDeleteParameters, type DataSourceGetParameters, type DataSourceGetResponse, type DataSourcePutParameters, type DataSourceVariantData, type DataSourceVariantsKeys, type DataSourcesGetParameters, type DataSourcesGetResponse, type DataType, DataTypeClient, type DataTypeDeleteParameters, type DataTypeGetParameters, type DataTypeGetResponse, type DataTypePutParameters, type DataVariableDefinition, type DataWithProperties, type DateParamConfig, type DateParamValue, type DatetimeParamConfig, type DeleteContentTypeOptions, type DeleteEntryOptions, type DismissPlaceholderMessage, type DynamicInputIssue, EDGE_CACHE_DISABLED, EDGE_DEFAULT_CACHE_TTL, EDGE_MAX_CACHE_TTL, EDGE_MIN_CACHE_TTL, EMPTY_COMPOSITION, type EdgehancersDiagnostics, type EdgehancersWholeResponseCacheDiagnostics, type EditorStateUpdatedMessage, EnhancerBuilder, type EnhancerContext, type EnhancerError, EntityReleasesClient, type EntityReleasesGetParameters, type EntityReleasesGetResponse, type EntriesGetParameters, type EntriesGetResponse, type EntriesHistoryGetParameters, type EntriesHistoryGetResponse, type EntriesResolvedListResponse, type Entry, type EntryData, EntryDeliveryClient, type EntryDeliveryListQuery, type EntryDeliveryReadOptions, type EntryFilters, type EntryList, type EntryListQuery, EntryManagementClient, type EntryManagementListQuery, type EntryManagementReadOptions, type EntryReadOptions, type EntrySelector, type EntryWriteSelector, type EvaluateCriteriaGroupOptions, type EvaluateNodeTreeVisibilityOptions, type EvaluateNodeVisibilityParameterOptions, type EvaluatePropertyCriteriaOptions, type EvaluateWalkTreePropertyCriteriaOptions, type FieldTypesProjection, type FieldsProjection, type Filters, type FindInNodeTreeReference, type FlattenProperty, type FlattenValues, type FlattenValuesOptions, type GetContentTypesOptions, type GetContentTypesResponse, type GetEffectivePropertyValueOptions, type GetEntriesOptions, type GetEntriesResponse, type GetParameterAttributesProps, IN_CONTEXT_EDITOR_COMPONENT_END_ROLE, IN_CONTEXT_EDITOR_COMPONENT_START_ROLE, IN_CONTEXT_EDITOR_CONFIG_CHECK_QUERY_STRING_PARAM, IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID, IN_CONTEXT_EDITOR_FORCED_SETTINGS_QUERY_STRING_PARAM, IN_CONTEXT_EDITOR_PLAYGROUND_QUERY_STRING_PARAM, IN_CONTEXT_EDITOR_QUERY_STRING_PARAM, IS_RENDERED_BY_UNIFORM_ATTRIBUTE, IntegrationPropertyEditorsClient, type IntegrationPropertyEditorsDeleteParameters, type IntegrationPropertyEditorsGetParameters, type IntegrationPropertyEditorsGetResponse, type paths$9 as IntegrationPropertyEditorsPaths, type IntegrationPropertyEditorsPutParameters, type InvalidationPayload, LOCALE_DYNAMIC_INPUT_NAME, type Label, LabelClient, type LabelDelete, type LabelPut, type LabelsQuery, type LabelsResponse, type LimitPolicy, type LinkParamConfiguration, type LinkParamValue, type LinkParameterType, type LinkTypeConfiguration, type ListEditions, type Locale, LocaleClient, type LocaleDeleteParameters, type LocalePutParameters, type LocalesGetParameters, type LocalesGetResponse, type LocalizeOptions, type ManagementEditionsOverride, type ManagementFormat, type MaxDepthExceededIssue, type MessageHandler, type MoveComponentMessage, type MultiSelectParamConfiguration, type MultiSelectParamEditorType, type MultiSelectParamValue, type NodeLocationReference, type NonProjectMapLinkParamValue, type NumberParamConfig, type NumberParamEditorType, type NumberParamValue, type OpenParameterEditorMessage, type OverrideOptions, PLACEHOLDER_ID, type ParamTypeConfigConventions, type PatternIssue, PreviewClient, type PreviewPanelSettings, type PreviewUrl, type PreviewUrlDeleteParameters, type PreviewUrlDeleteResponse, type PreviewUrlPutParameters, type PreviewUrlPutResponse, type PreviewUrlsGetParameters, type PreviewUrlsGetResponse, type PreviewViewport, type PreviewViewportDeleteParameters, type PreviewViewportDeleteResponse, type PreviewViewportPutParameters, type PreviewViewportPutResponse, type PreviewViewportsGetParameters, type PreviewViewportsGetResponse, type Project, ProjectClient, type ProjectDeleteParameters, type ProjectGetParameters, type ProjectGetResponse, type ProjectMapLinkParamValue, type ProjectPutParameters, type ProjectPutResponse, type Projection, type ProjectionSpec, type ProjectsGetParameters, type ProjectsGetProject, type ProjectsGetResponse, type ProjectsGetTeam, type Prompt, PromptClient, type PromptsDeleteParameters, type PromptsGetParameters, type PromptsGetResponse, type PromptsPutParameters, type PropertyCriteriaMatch, type PropertyValue, type PutContentTypeBody, type PutEntryBody, REFERENCE_DATA_TYPE_ID, type ReadyMessage, RelationshipClient, type RelationshipResultInstance, type Release, ReleaseClient, type ReleaseContent, ReleaseContentsClient, type ReleaseContentsDeleteBody, type ReleaseContentsGetParameters, type ReleaseContentsGetResponse, type ReleaseDeleteParameters, type ReleasePatchParameters, type ReleasePutParameters, type ReleaseState, type ReleasesGetParameters, type ReleasesGetResponse, type ReportRenderedCompositionsMessage, type RequestComponentSuggestionMessage, type RequestPageHtmlMessage, type ResolvedRouteGetResponse, type RichTextBuiltInElement, type RichTextBuiltInFormat, type RichTextParamConfiguration, type RichTextParamValue, type RootComponentInstance, type RootEntryReference, type RootLocationReference, RouteClient, type RouteDynamicInputs, type RouteGetParameters, type RouteGetResponse, type RouteGetResponseComposition, type RouteGetResponseEdgehancedComposition, type RouteGetResponseEdgehancedNotFound, type RouteGetResponseNotFound, type RouteGetResponseRedirect, SECRET_QUERY_STRING_PARAM, SELECT_QUERY_PREFIX, type SaveOptions, type SaveResult, type SelectComponentMessage, type SelectParamConfiguration, type SelectParamEditorType, type SelectParamOption, type SelectParamValue, type SelectParameterMessage, type SendPageHtmlMessage, type SessionPendingMessage, type SlotsProjection, type SpecificProjectMap, type StringOperators, type SuggestComponentMessage, type TextParamConfig, type TextParamValue, type TreeNodeInfoTypes, type TriggerComponentActionMessage, type TriggerCompositionActionMessage, UncachedCanvasClient, UncachedCategoryClient, UncachedContentClient, UncachedLabelClient, UniqueBatchEntries, type UpdateAiActionsMessage, type UpdateComponentParameterMessage, type UpdateComponentReferencesMessage, type UpdateCompositionInternalMessage, type UpdateCompositionMessage, type UpdateCompositionOptions, type UpdateContextualEditingStateInternalMessage, type UpdateFeatureFlagsMessage, type UpdatePreviewSettingsMessage, type UpsertEntryOptions, type VisibilityCriteria, type VisibilityCriteriaEvaluationResult, type VisibilityCriteriaGroup, type VisibilityParameterValue, type VisibilityRule, type VisibilityRules, type WalkNodeTreeActions, type WalkNodeTreeOptions, type WebhookDefinition, WorkflowClient, type WorkflowDefinition, type WorkflowStage, type WorkflowStagePermission, type WorkflowStageTransition, type WorkflowStageTransitionPermission, type WorkflowsDeleteParameters, type WorkflowsGetParameters, type WorkflowsGetResponse, type WorkflowsPutParameters, autoFixParameterGroups, bindExpressionEscapeChars, bindExpressionPrefix, bindVariables, bindVariablesToObject, compose, convertEntryToPutEntry, convertToBindExpression, createBatchEnhancer, createCanvasChannel, createDynamicInputVisibilityRule, createDynamicTokenVisibilityRule, createLimitPolicy, createLocaleVisibilityRule, createQuirksVisibilityRule, createUniformApiEnhancer, createVariableReference, enhance, escapeBindExpressionDefaultValue, evaluateNodeVisibilityParameter, evaluatePropertyCriteria, evaluateVisibilityCriteriaGroup, evaluateWalkTreeNodeVisibility, evaluateWalkTreePropertyCriteria, extractLocales, findParameterInNodeTree, flattenValues, generateComponentPlaceholderId, generateHash, getBlockValue, getComponentJsonPointer, getComponentPath, getDataSourceVariantFromRouteGetParams, getEffectivePropertyValue, getLocalizedPropertyValues, getNounForLocation, getNounForNode, getParameterAttributes, getPropertiesValue, hasReferencedVariables, isAddComponentMessage, isAllowedReferrer, isAssetParamValue, isAssetParamValueItem, isAwaitingReadyMessage, isComponentActionMessage, isComponentPlaceholderId, isContextStorageUpdatedMessage, isDismissPlaceholderMessage, isEntryData, isLinkParamValue, isMovingComponentMessage, isNestedNodeType, isOpenParameterEditorMessage, isReadyMessage, isReportRenderedCompositionsMessage, isRequestComponentSuggestionMessage, isRootEntryReference, isSelectComponentMessage, isSelectParameterMessage, isSessionPendingMessage, isSuggestComponentMessage, isSystemComponentDefinition, isTriggerCompositionActionMessage, isUpdateAiActionsMessage, isUpdateComponentParameterMessage, isUpdateComponentReferencesMessage, isUpdateCompositionInternalMessage, isUpdateCompositionMessage, isUpdateContextualEditingStateInternalMessage, isUpdateFeatureFlagsMessage, isUpdatePreviewSettingsMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, matchesProjectionPattern, mergeAssetConfigWithDefaults, nullLimitPolicy, parseComponentPlaceholderId, parseVariableExpression, projectionToQuery, queryToProjection, version, walkNodeTree, walkPropertyValues };
|
|
16120
|
+
export { ASSETS_SOURCE_CUSTOM_URL, ASSETS_SOURCE_UNIFORM, ASSET_PARAMETER_TYPE, ATTRIBUTE_COMPONENT_ID, ATTRIBUTE_MULTILINE, ATTRIBUTE_PARAMETER_ID, ATTRIBUTE_PARAMETER_TYPE, ATTRIBUTE_PARAMETER_VALUE, ATTRIBUTE_PLACEHOLDER, type AddComponentMessage, type AiAction, type AssetParamConfig, type AwaitingReadyMessage, type BatchEnhancer, BatchEntry, type BatchInvalidationPayload, type BindVariablesOptions, type BindVariablesResult, type BindVariablesToObjectOptions, BlockFormatError, type BlockLocationReference, type BlockValue, CANVAS_BLOCK_PARAM_TYPE, CANVAS_COMPONENT_DISPLAY_NAME_PARAM, CANVAS_CONTEXTUAL_EDITING_PARAM, CANVAS_DRAFT_STATE, CANVAS_EDITOR_STATE, CANVAS_ENRICHMENT_TAG_PARAM, CANVAS_HYPOTHESIS_PARAM, CANVAS_INTENT_TAG_PARAM, CANVAS_INTERNAL_PARAM_PREFIX, CANVAS_LOCALE_TAG_PARAM, CANVAS_LOCALIZATION_SLOT, CANVAS_LOCALIZATION_TYPE, CANVAS_PERSONALIZATION_ALGORITHM_PARAM, CANVAS_PERSONALIZATION_ALGORITHM_TYPE, CANVAS_PERSONALIZATION_EVENT_NAME_PARAM, CANVAS_PERSONALIZATION_PARAM, CANVAS_PERSONALIZATION_TAKE_PARAM, CANVAS_PERSONALIZE_SLOT, CANVAS_PERSONALIZE_TYPE, CANVAS_PUBLISHED_STATE, CANVAS_SLOT_SECTION_GROUP_TYPE_PARAM, CANVAS_SLOT_SECTION_MAX_PARAM, CANVAS_SLOT_SECTION_MIN_PARAM, CANVAS_SLOT_SECTION_NAME_PARAM, CANVAS_SLOT_SECTION_SLOT, CANVAS_SLOT_SECTION_SPECIFIC_PARAM, CANVAS_SLOT_SECTION_TYPE, CANVAS_TEST_SLOT, CANVAS_TEST_TYPE, CANVAS_TEST_VARIANT_PARAM, CANVAS_VIZ_CONTROL_PARAM, CANVAS_VIZ_DI_RULE, CANVAS_VIZ_DYNAMIC_TOKEN_RULE, CANVAS_VIZ_LOCALE_RULE, CANVAS_VIZ_QUIRKS_RULE, CanvasClient, CanvasClientError, type CanvasDefinitions, type CategoriesDeleteParameters, type CategoriesGetParameters, type CategoriesGetResponse, type CategoriesPutParameters, type Category, CategoryClient, type Channel, type ChannelMessage, ChildEnhancerBuilder, type ComponentDefinition, ComponentDefinitionClient, type ComponentDefinitionDeleteParameters, type ComponentDefinitionGetParameters, type ComponentDefinitionGetResponse, type ComponentDefinitionParameter, type ComponentDefinitionPermission, type ComponentDefinitionPutParameters, type ComponentDefinitionSlot, type ComponentDefinitionSlugSettings, type ComponentDefinitionVariant, type ComponentEnhancer, type ComponentEnhancerFunction, type ComponentEnhancerOptions, type ComponentInstance, type ComponentInstanceContextualEditing, type ComponentInstanceHistoryEntry, type ComponentInstanceHistoryGetParameters, type ComponentInstanceHistoryGetResponse, type ComponentLocationReference, type ComponentOverridability, type ComponentOverride, type ComponentOverrides, type ComponentParameter, type ComponentParameterBlock, type ComponentParameterConditionalValue, type ComponentParameterContextualEditing, type ComponentParameterEnhancer, type ComponentParameterEnhancerFunction, type ComponentParameterEnhancerOptions, type CompositionDeleteParameters, CompositionDeliveryClient, type CompositionDeliveryListQuery, type CompositionDeliveryReadOptions, type CompositionDeliverySelector, type CompositionFilters, type CompositionGetByComponentIdParameters, type CompositionGetByIdParameters, type CompositionGetByNodeIdParameters, type CompositionGetByNodePathParameters, type CompositionGetBySlugParameters, type CompositionGetListResponse, type CompositionGetParameters, type CompositionGetResponse, type CompositionGetValidResponses, type CompositionListQuery, CompositionManagementClient, type CompositionManagementListQuery, type CompositionManagementReadOptions, type CompositionManagementSelector, type CompositionPutParameters, type CompositionReadOptions, type CompositionResolvedGetResponse, type CompositionResolvedListResponse, type CompositionUIStatus, type CompositionWriteSelector, ContentClient, type ContentType, ContentTypeClient, type ContentTypeField, type ContentTypePreviewConfiguration, type ContextStorageUpdatedMessage, type ContextualEditingComponentReference, type ContextualEditingValue, type CopiedComponentSubtree, type DataDiagnostic, type DataElementBindingIssue, type DataElementConnectionDefinition, type DataElementConnectionFailureAction, type DataElementConnectionFailureLogLevel, type DataResolutionConfigIssue, type DataResolutionIssue, type DataResolutionOption, type DataResolutionOptionNegative, type DataResolutionOptionPositive, type DataResolutionParameters, type DataResourceDefinition, type DataResourceDefinitions, type DataResourceIssue, type DataResourceVariables, type DataSource, DataSourceClient, type DataSourceDeleteParameters, type DataSourceGetParameters, type DataSourceGetResponse, type DataSourcePutParameters, type DataSourceVariantData, type DataSourceVariantsKeys, type DataSourcesGetParameters, type DataSourcesGetResponse, type DataType, DataTypeClient, type DataTypeDeleteParameters, type DataTypeGetParameters, type DataTypeGetResponse, type DataTypePutParameters, type DataVariableDefinition, type DataWithProperties, type DateParamConfig, type DateParamValue, type DatetimeParamConfig, type DeleteContentTypeOptions, type DeleteEntryOptions, type DismissPlaceholderMessage, type DynamicInputIssue, EDGE_CACHE_DISABLED, EDGE_DEFAULT_CACHE_TTL, EDGE_MAX_CACHE_TTL, EDGE_MIN_CACHE_TTL, EMPTY_COMPOSITION, type EdgehancersDiagnostics, type EdgehancersWholeResponseCacheDiagnostics, type EditorStateUpdatedMessage, EnhancerBuilder, type EnhancerContext, type EnhancerError, EntityReleasesClient, type EntityReleasesGetParameters, type EntityReleasesGetResponse, type EntriesGetParameters, type EntriesGetResponse, type EntriesHistoryGetParameters, type EntriesHistoryGetResponse, type EntriesResolvedListResponse, type Entry, type EntryData, EntryDeliveryClient, type EntryDeliveryListQuery, type EntryDeliveryReadOptions, type EntryFilters, type EntryList, type EntryListQuery, EntryManagementClient, type EntryManagementListQuery, type EntryManagementReadOptions, type EntryReadOptions, type EntrySelector, type EntryWriteSelector, type EvaluateCriteriaGroupOptions, type EvaluateNodeTreeVisibilityOptions, type EvaluateNodeVisibilityParameterOptions, type EvaluatePropertyCriteriaOptions, type EvaluateWalkTreePropertyCriteriaOptions, type FieldTypesProjection, type FieldsProjection, type Filters, type FindInNodeTreeReference, type FlattenProperty, type FlattenValues, type FlattenValuesOptions, type GetContentTypesOptions, type GetContentTypesResponse, type GetEffectivePropertyValueOptions, type GetEntriesOptions, type GetEntriesResponse, type GetParameterAttributesProps, IN_CONTEXT_EDITOR_COMPONENT_END_ROLE, IN_CONTEXT_EDITOR_COMPONENT_START_ROLE, IN_CONTEXT_EDITOR_CONFIG_CHECK_QUERY_STRING_PARAM, IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID, IN_CONTEXT_EDITOR_FORCED_SETTINGS_QUERY_STRING_PARAM, IN_CONTEXT_EDITOR_PLAYGROUND_QUERY_STRING_PARAM, IN_CONTEXT_EDITOR_QUERY_STRING_PARAM, IS_RENDERED_BY_UNIFORM_ATTRIBUTE, IntegrationPropertyEditorsClient, type IntegrationPropertyEditorsDeleteParameters, type IntegrationPropertyEditorsGetParameters, type IntegrationPropertyEditorsGetResponse, type paths$9 as IntegrationPropertyEditorsPaths, type IntegrationPropertyEditorsPutParameters, type InvalidationPayload, LOCALE_DYNAMIC_INPUT_NAME, type Label, LabelClient, type LabelDelete, type LabelPut, type LabelsQuery, type LabelsResponse, type LimitPolicy, type LinkParamConfiguration, type LinkParamValue, type LinkParameterType, type LinkTypeConfiguration, type ListEditions, type Locale, LocaleClient, type LocaleDeleteParameters, type LocalePutParameters, type LocalesGetParameters, type LocalesGetResponse, type LocalizeOptions, type ManagementEditionsOverride, type ManagementFormat, type MaxDepthExceededIssue, type MessageHandler, type MoveComponentMessage, type MultiSelectParamConfiguration, type MultiSelectParamEditorType, type MultiSelectParamValue, type NodeLocationReference, type NonProjectMapLinkParamValue, type NumberParamConfig, type NumberParamEditorType, type NumberParamValue, type OpenParameterEditorMessage, type OverrideOptions, PLACEHOLDER_ID, type ParamTypeConfigConventions, type PatternIssue, PreviewClient, type PreviewPanelSettings, type PreviewUrl, type PreviewUrlDeleteParameters, type PreviewUrlDeleteResponse, type PreviewUrlPutParameters, type PreviewUrlPutResponse, type PreviewUrlsGetParameters, type PreviewUrlsGetResponse, type PreviewViewport, type PreviewViewportDeleteParameters, type PreviewViewportDeleteResponse, type PreviewViewportPutParameters, type PreviewViewportPutResponse, type PreviewViewportsGetParameters, type PreviewViewportsGetResponse, type Project, ProjectClient, type ProjectDeleteParameters, type ProjectGetParameters, type ProjectGetResponse, type ProjectMapLinkParamValue, type ProjectPutParameters, type ProjectPutResponse, type Projection, type ProjectionSpec, type ProjectsGetParameters, type ProjectsGetProject, type ProjectsGetResponse, type ProjectsGetTeam, type Prompt, PromptClient, type PromptsDeleteParameters, type PromptsGetParameters, type PromptsGetResponse, type PromptsPutParameters, type PropertyCriteriaMatch, type PropertyValue, type PutContentTypeBody, type PutEntryBody, REFERENCE_DATA_TYPE_ID, type ReadyMessage, RelationshipClient, type RelationshipResultInstance, type Release, ReleaseClient, type ReleaseContent, ReleaseContentsClient, type ReleaseContentsDeleteBody, type ReleaseContentsGetParameters, type ReleaseContentsGetResponse, type ReleaseDeleteParameters, type ReleasePatchParameters, type ReleasePutParameters, type ReleaseState, type ReleasesGetParameters, type ReleasesGetResponse, type ReportRenderedCompositionsMessage, type RequestComponentSuggestionMessage, type RequestPageHtmlMessage, type ResolvedRouteGetResponse, type RichTextBuiltInElement, type RichTextBuiltInFormat, type RichTextParamConfiguration, type RichTextParamValue, type RootComponentInstance, type RootEntryReference, type RootLocationReference, RouteClient, type RouteDynamicInputs, type RouteGetParameters, type RouteGetResponse, type RouteGetResponseComposition, type RouteGetResponseEdgehancedComposition, type RouteGetResponseEdgehancedNotFound, type RouteGetResponseNotFound, type RouteGetResponseRedirect, SECRET_QUERY_STRING_PARAM, SELECT_QUERY_PREFIX, type SaveOptions, type SaveResult, type SelectComponentMessage, type SelectParamConfiguration, type SelectParamEditorType, type SelectParamOption, type SelectParamValue, type SelectParameterMessage, type SendPageHtmlMessage, type SerializedCustomView, type SessionPendingMessage, type SlotsProjection, type SpecificProjectMap, type StringOperators, type SuggestComponentMessage, type TextParamConfig, type TextParamValue, type TreeNodeInfoTypes, type TriggerComponentActionMessage, type TriggerCompositionActionMessage, UncachedCanvasClient, UncachedCategoryClient, UncachedContentClient, UncachedLabelClient, UniqueBatchEntries, type UpdateAiActionsMessage, type UpdateComponentParameterMessage, type UpdateComponentReferencesMessage, type UpdateCompositionInternalMessage, type UpdateCompositionMessage, type UpdateCompositionOptions, type UpdateContextualEditingStateInternalMessage, type UpdateFeatureFlagsMessage, type UpdatePreviewSettingsMessage, type UpsertEntryOptions, type View, type ViewDelete, type ViewPut, type ViewsQuery, type ViewsResponse, type VisibilityCriteria, type VisibilityCriteriaEvaluationResult, type VisibilityCriteriaGroup, type VisibilityParameterValue, type VisibilityRule, type VisibilityRules, type WalkNodeTreeActions, type WalkNodeTreeOptions, type WebhookDefinition, WorkflowClient, type WorkflowDefinition, type WorkflowStage, type WorkflowStagePermission, type WorkflowStageTransition, type WorkflowStageTransitionPermission, type WorkflowsDeleteParameters, type WorkflowsGetParameters, type WorkflowsGetResponse, type WorkflowsPutParameters, autoFixParameterGroups, bindExpressionEscapeChars, bindExpressionPrefix, bindVariables, bindVariablesToObject, compose, convertEntryToPutEntry, convertToBindExpression, createBatchEnhancer, createCanvasChannel, createDynamicInputVisibilityRule, createDynamicTokenVisibilityRule, createLimitPolicy, createLocaleVisibilityRule, createQuirksVisibilityRule, createUniformApiEnhancer, createVariableReference, enhance, escapeBindExpressionDefaultValue, evaluateNodeVisibilityParameter, evaluatePropertyCriteria, evaluateVisibilityCriteriaGroup, evaluateWalkTreeNodeVisibility, evaluateWalkTreePropertyCriteria, extractLocales, findParameterInNodeTree, flattenValues, generateComponentPlaceholderId, generateHash, getBlockValue, getComponentJsonPointer, getComponentPath, getDataSourceVariantFromRouteGetParams, getEffectivePropertyValue, getLocalizedPropertyValues, getNounForLocation, getNounForNode, getParameterAttributes, getPropertiesValue, hasReferencedVariables, isAddComponentMessage, isAllowedReferrer, isAssetParamValue, isAssetParamValueItem, isAwaitingReadyMessage, isComponentActionMessage, isComponentPlaceholderId, isContextStorageUpdatedMessage, isDismissPlaceholderMessage, isEntryData, isLinkParamValue, isMovingComponentMessage, isNestedNodeType, isOpenParameterEditorMessage, isReadyMessage, isReportRenderedCompositionsMessage, isRequestComponentSuggestionMessage, isRootEntryReference, isSelectComponentMessage, isSelectParameterMessage, isSessionPendingMessage, isSuggestComponentMessage, isSystemComponentDefinition, isTriggerCompositionActionMessage, isUpdateAiActionsMessage, isUpdateComponentParameterMessage, isUpdateComponentReferencesMessage, isUpdateCompositionInternalMessage, isUpdateCompositionMessage, isUpdateContextualEditingStateInternalMessage, isUpdateFeatureFlagsMessage, isUpdatePreviewSettingsMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, matchesProjectionPattern, mergeAssetConfigWithDefaults, nullLimitPolicy, parseComponentPlaceholderId, parseVariableExpression, projectionToQuery, queryToProjection, version, walkNodeTree, walkPropertyValues };
|