@uniformdev/canvas 20.50.3-alpha.6 → 20.51.1-alpha.14
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 +811 -526
- package/dist/index.d.ts +811 -526
- package/dist/index.esm.js +62 -39
- package/dist/index.js +65 -40
- package/dist/index.mjs +62 -39
- package/package.json +5 -5
package/dist/index.d.mts
CHANGED
|
@@ -8,7 +8,7 @@ import { Options as Options$1 } from 'p-retry';
|
|
|
8
8
|
import { Options } from 'p-throttle';
|
|
9
9
|
import { RichTextBuiltInFormat as RichTextBuiltInFormat$1, RichTextBuiltInElement as RichTextBuiltInElement$1, RichTextParamConfiguration as RichTextParamConfiguration$1, ParameterRichTextValue } from '@uniformdev/richtext';
|
|
10
10
|
|
|
11
|
-
interface paths$
|
|
11
|
+
interface paths$n {
|
|
12
12
|
"/api/v1/canvas-definitions": {
|
|
13
13
|
parameters: {
|
|
14
14
|
query?: never;
|
|
@@ -46,15 +46,15 @@ interface paths$m {
|
|
|
46
46
|
content: {
|
|
47
47
|
"application/json": {
|
|
48
48
|
/** @description Component definitions that match the query */
|
|
49
|
-
componentDefinitions: components$
|
|
49
|
+
componentDefinitions: components$r["schemas"]["ComponentDefinition"][];
|
|
50
50
|
};
|
|
51
51
|
};
|
|
52
52
|
};
|
|
53
|
-
400: components$
|
|
54
|
-
401: components$
|
|
55
|
-
403: components$
|
|
56
|
-
429: components$
|
|
57
|
-
500: components$
|
|
53
|
+
400: components$r["responses"]["BadRequestError"];
|
|
54
|
+
401: components$r["responses"]["UnauthorizedError"];
|
|
55
|
+
403: components$r["responses"]["ForbiddenError"];
|
|
56
|
+
429: components$r["responses"]["RateLimitError"];
|
|
57
|
+
500: components$r["responses"]["InternalServerError"];
|
|
58
58
|
};
|
|
59
59
|
};
|
|
60
60
|
/** @description Upserts a component definition */
|
|
@@ -73,7 +73,7 @@ interface paths$m {
|
|
|
73
73
|
* @description The project ID to upsert the component definition to
|
|
74
74
|
*/
|
|
75
75
|
projectId: string;
|
|
76
|
-
componentDefinition: components$
|
|
76
|
+
componentDefinition: components$r["schemas"]["ComponentDefinition"];
|
|
77
77
|
};
|
|
78
78
|
};
|
|
79
79
|
};
|
|
@@ -85,11 +85,11 @@ interface paths$m {
|
|
|
85
85
|
};
|
|
86
86
|
content?: never;
|
|
87
87
|
};
|
|
88
|
-
400: components$
|
|
89
|
-
401: components$
|
|
90
|
-
403: components$
|
|
91
|
-
429: components$
|
|
92
|
-
500: components$
|
|
88
|
+
400: components$r["responses"]["BadRequestError"];
|
|
89
|
+
401: components$r["responses"]["UnauthorizedError"];
|
|
90
|
+
403: components$r["responses"]["ForbiddenError"];
|
|
91
|
+
429: components$r["responses"]["RateLimitError"];
|
|
92
|
+
500: components$r["responses"]["InternalServerError"];
|
|
93
93
|
};
|
|
94
94
|
};
|
|
95
95
|
post?: never;
|
|
@@ -122,11 +122,11 @@ interface paths$m {
|
|
|
122
122
|
};
|
|
123
123
|
content?: never;
|
|
124
124
|
};
|
|
125
|
-
400: components$
|
|
126
|
-
401: components$
|
|
127
|
-
403: components$
|
|
128
|
-
429: components$
|
|
129
|
-
500: components$
|
|
125
|
+
400: components$r["responses"]["BadRequestError"];
|
|
126
|
+
401: components$r["responses"]["UnauthorizedError"];
|
|
127
|
+
403: components$r["responses"]["ForbiddenError"];
|
|
128
|
+
429: components$r["responses"]["RateLimitError"];
|
|
129
|
+
500: components$r["responses"]["InternalServerError"];
|
|
130
130
|
};
|
|
131
131
|
};
|
|
132
132
|
/** @description Handles preflight requests. This endpoint allows CORS */
|
|
@@ -153,13 +153,13 @@ interface paths$m {
|
|
|
153
153
|
trace?: never;
|
|
154
154
|
};
|
|
155
155
|
}
|
|
156
|
-
interface components$
|
|
156
|
+
interface components$r {
|
|
157
157
|
schemas: {
|
|
158
158
|
/** @description Public ID (used in code). Do not change after creation */
|
|
159
159
|
PublicIdProperty: string;
|
|
160
160
|
/** @description The definition of a component parameter */
|
|
161
161
|
ComponentDefinitionParameter: {
|
|
162
|
-
id: components$
|
|
162
|
+
id: components$r["schemas"]["PublicIdProperty"];
|
|
163
163
|
/** @description Friendly name of the parameter */
|
|
164
164
|
name: string;
|
|
165
165
|
/** @description Appears next to the parameter in the Composition editor */
|
|
@@ -190,7 +190,7 @@ interface components$q {
|
|
|
190
190
|
};
|
|
191
191
|
/** @description Permission set for a component definition */
|
|
192
192
|
ComponentDefinitionPermission: {
|
|
193
|
-
roleId: components$
|
|
193
|
+
roleId: components$r["schemas"]["PublicIdProperty"];
|
|
194
194
|
/**
|
|
195
195
|
* @description Permission type for this permission ComponentDefinition:
|
|
196
196
|
* read | write | create | delete
|
|
@@ -203,7 +203,7 @@ interface components$q {
|
|
|
203
203
|
};
|
|
204
204
|
/** @description The definition of a named component slot that can contain other components */
|
|
205
205
|
ComponentDefinitionSlot: {
|
|
206
|
-
id: components$
|
|
206
|
+
id: components$r["schemas"]["PublicIdProperty"];
|
|
207
207
|
/** @description Friendly name of the slot */
|
|
208
208
|
name: string;
|
|
209
209
|
/** @description A list of component definition public IDs that are allowed in this named slot */
|
|
@@ -321,12 +321,12 @@ interface components$q {
|
|
|
321
321
|
* @enum {string}
|
|
322
322
|
*/
|
|
323
323
|
op?: "&" | "|";
|
|
324
|
-
clauses: (components$
|
|
324
|
+
clauses: (components$r["schemas"]["VisibilityCriteria"] | components$r["schemas"]["VisibilityCriteriaGroup"])[];
|
|
325
325
|
};
|
|
326
326
|
/** @description Defines a conditional value for a component parameter
|
|
327
327
|
* */
|
|
328
328
|
ComponentParameterConditionalValue: {
|
|
329
|
-
when: components$
|
|
329
|
+
when: components$r["schemas"]["VisibilityCriteriaGroup"];
|
|
330
330
|
/** @description The value of the parameter. Any JSON-serializable value is acceptable.
|
|
331
331
|
* A value of `null` will cause the parameter value to be removed, if it matches.
|
|
332
332
|
* */
|
|
@@ -345,7 +345,7 @@ interface components$q {
|
|
|
345
345
|
*
|
|
346
346
|
* When no locale is passed to a non-route API, conditions are not processed and all conditions are returned.
|
|
347
347
|
* */
|
|
348
|
-
ComponentParameterConditions: components$
|
|
348
|
+
ComponentParameterConditions: components$r["schemas"]["ComponentParameterConditionalValue"][];
|
|
349
349
|
/** @description Defines an editable parameter on a component */
|
|
350
350
|
ComponentParameter: {
|
|
351
351
|
/** @description The value of the parameter. Any JSON-serializable value is acceptable */
|
|
@@ -353,18 +353,18 @@ interface components$q {
|
|
|
353
353
|
/** @description The type of the parameter. Determines how it is displayed when editing and tells the consumer how to process it */
|
|
354
354
|
type: string;
|
|
355
355
|
/** @deprecated */
|
|
356
|
-
connectedData?: components$
|
|
356
|
+
connectedData?: components$r["schemas"]["DataElementConnectionDefinition"];
|
|
357
357
|
/** @description Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
|
|
358
358
|
* Note that locales must be registered on the entry/composition `_locales` before being used
|
|
359
359
|
* */
|
|
360
360
|
locales?: {
|
|
361
361
|
[key: string]: unknown;
|
|
362
362
|
};
|
|
363
|
-
conditions?: components$
|
|
363
|
+
conditions?: components$r["schemas"]["ComponentParameterConditions"];
|
|
364
364
|
/** @description Locale-specific conditional values for this parameter. Keys are locale codes, and values are the `conditions` for that locale.
|
|
365
365
|
* */
|
|
366
366
|
localesConditions?: {
|
|
367
|
-
[key: string]: components$
|
|
367
|
+
[key: string]: components$r["schemas"]["ComponentParameterConditions"];
|
|
368
368
|
};
|
|
369
369
|
};
|
|
370
370
|
/** @description Defines the shape of a component instance served by the composition API */
|
|
@@ -373,13 +373,13 @@ interface components$q {
|
|
|
373
373
|
type: string;
|
|
374
374
|
/** @description Component parameter values for the component instance */
|
|
375
375
|
parameters?: {
|
|
376
|
-
[key: string]: components$
|
|
376
|
+
[key: string]: components$r["schemas"]["ComponentParameter"];
|
|
377
377
|
};
|
|
378
378
|
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
|
379
379
|
variant?: string;
|
|
380
380
|
/** @description Slots containing any child components */
|
|
381
381
|
slots?: {
|
|
382
|
-
[key: string]: components$
|
|
382
|
+
[key: string]: components$r["schemas"]["ComponentInstance"][];
|
|
383
383
|
};
|
|
384
384
|
/** @description Unique identifier of the component within the composition.
|
|
385
385
|
* No assumptions should be made about the format of this value other than "it will be unique."
|
|
@@ -389,14 +389,14 @@ interface components$q {
|
|
|
389
389
|
_id?: string;
|
|
390
390
|
/** @description Indicates this component instance should be sourced from a pattern library pattern */
|
|
391
391
|
_pattern?: string;
|
|
392
|
-
_dataResources?: components$
|
|
392
|
+
_dataResources?: components$r["schemas"]["DataResourceDefinitions"];
|
|
393
393
|
/** @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
|
394
394
|
* Means nothing for PUTs; it will be ignored
|
|
395
395
|
* */
|
|
396
396
|
_patternDataResources?: {
|
|
397
|
-
[key: string]: components$
|
|
397
|
+
[key: string]: components$r["schemas"]["DataResourceDefinition"];
|
|
398
398
|
};
|
|
399
|
-
_patternError?: components$
|
|
399
|
+
_patternError?: components$r["schemas"]["PatternError"];
|
|
400
400
|
/** @description Defines patch overrides to component IDs that live in the composition.
|
|
401
401
|
* This can be used to override parameters that are defined on patterns,
|
|
402
402
|
* including nested patterns, with values that are specific to this composition.
|
|
@@ -409,13 +409,13 @@ interface components$q {
|
|
|
409
409
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
410
410
|
* */
|
|
411
411
|
_overrides?: {
|
|
412
|
-
[key: string]: components$
|
|
412
|
+
[key: string]: components$r["schemas"]["ComponentOverride"];
|
|
413
413
|
};
|
|
414
414
|
/** @description Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
|
|
415
415
|
* Means nothing for PUTs; it will be ignored
|
|
416
416
|
* */
|
|
417
417
|
_patternOverrides?: {
|
|
418
|
-
[key: string]: components$
|
|
418
|
+
[key: string]: components$r["schemas"]["ComponentOverride"];
|
|
419
419
|
};
|
|
420
420
|
/** @description When used on a pattern, defines how the pattern's parameters may be overridden
|
|
421
421
|
* by consumers of the pattern.
|
|
@@ -423,7 +423,7 @@ interface components$q {
|
|
|
423
423
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
424
424
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
425
425
|
* */
|
|
426
|
-
_overridability?: components$
|
|
426
|
+
_overridability?: components$r["schemas"]["ComponentOverridability"];
|
|
427
427
|
/** @description Array of locales that have data defined. Only set for pattern references or composition defaults */
|
|
428
428
|
_locales?: string[];
|
|
429
429
|
};
|
|
@@ -446,13 +446,13 @@ interface components$q {
|
|
|
446
446
|
* If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
|
|
447
447
|
* */
|
|
448
448
|
optionalPatternParameter?: boolean;
|
|
449
|
-
variables?: components$
|
|
449
|
+
variables?: components$r["schemas"]["DataResourceVariables"];
|
|
450
450
|
};
|
|
451
451
|
/** @description Data definitions attached to this component. The property name is the key of the data in the data document.
|
|
452
452
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key)
|
|
453
453
|
* */
|
|
454
454
|
DataResourceDefinitions: {
|
|
455
|
-
[key: string]: components$
|
|
455
|
+
[key: string]: components$r["schemas"]["DataResourceDefinition"];
|
|
456
456
|
};
|
|
457
457
|
/**
|
|
458
458
|
* @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
|
@@ -470,10 +470,10 @@ interface components$q {
|
|
|
470
470
|
* */
|
|
471
471
|
ComponentOverride: {
|
|
472
472
|
parameters?: {
|
|
473
|
-
[key: string]: components$
|
|
473
|
+
[key: string]: components$r["schemas"]["ComponentParameter"];
|
|
474
474
|
};
|
|
475
475
|
slots?: {
|
|
476
|
-
[key: string]: components$
|
|
476
|
+
[key: string]: components$r["schemas"]["ComponentInstance"][];
|
|
477
477
|
};
|
|
478
478
|
variant?: string;
|
|
479
479
|
/** @description Overrides data resource definitions for a pattern component.
|
|
@@ -481,7 +481,7 @@ interface components$q {
|
|
|
481
481
|
* Overrides defined here replace values in either _dataResources or _patternDataResources on the target component.
|
|
482
482
|
* */
|
|
483
483
|
dataResources?: {
|
|
484
|
-
[key: string]: components$
|
|
484
|
+
[key: string]: components$r["schemas"]["DataResourceDefinition"];
|
|
485
485
|
};
|
|
486
486
|
};
|
|
487
487
|
/**
|
|
@@ -502,7 +502,7 @@ interface components$q {
|
|
|
502
502
|
ComponentOverridability: {
|
|
503
503
|
/** @description Defines component parameter value overrides. Keys are the parameter public ID */
|
|
504
504
|
parameters?: {
|
|
505
|
-
[key: string]: components$
|
|
505
|
+
[key: string]: components$r["schemas"]["OverrideOptions"];
|
|
506
506
|
};
|
|
507
507
|
/** @description Allows overriding a display variant is allowed if it is defined on the component the pattern is derived from. Default = false */
|
|
508
508
|
variants?: boolean;
|
|
@@ -514,13 +514,13 @@ interface components$q {
|
|
|
514
514
|
};
|
|
515
515
|
/** @description The definition of a component variant */
|
|
516
516
|
ComponentDefinitionVariant: {
|
|
517
|
-
id: components$
|
|
517
|
+
id: components$r["schemas"]["PublicIdProperty"];
|
|
518
518
|
/** @description Friendly name of the variant */
|
|
519
519
|
name: string;
|
|
520
520
|
};
|
|
521
521
|
/** @description Defines a component type that can live on a Composition */
|
|
522
522
|
ComponentDefinition: {
|
|
523
|
-
id: components$
|
|
523
|
+
id: components$r["schemas"]["PublicIdProperty"];
|
|
524
524
|
/** @description Friendly name of the component definition */
|
|
525
525
|
name: string;
|
|
526
526
|
/**
|
|
@@ -547,7 +547,7 @@ interface components$q {
|
|
|
547
547
|
*/
|
|
548
548
|
canBeComposition?: boolean;
|
|
549
549
|
/** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries */
|
|
550
|
-
parameters?: components$
|
|
550
|
+
parameters?: components$r["schemas"]["ComponentDefinitionParameter"][];
|
|
551
551
|
/**
|
|
552
552
|
* Format: uuid
|
|
553
553
|
* @description Reference to the category this component definition belongs to
|
|
@@ -564,14 +564,14 @@ interface components$q {
|
|
|
564
564
|
*/
|
|
565
565
|
useTeamPermissions?: boolean;
|
|
566
566
|
/** @description Custom role permissions for this component definition */
|
|
567
|
-
permissions?: components$
|
|
567
|
+
permissions?: components$r["schemas"]["ComponentDefinitionPermission"][];
|
|
568
568
|
/** @description The named slots for this component; placement areas where arrays of other components can be added */
|
|
569
|
-
slots?: components$
|
|
570
|
-
slugSettings?: components$
|
|
569
|
+
slots?: components$r["schemas"]["ComponentDefinitionSlot"][];
|
|
570
|
+
slugSettings?: components$r["schemas"]["ComponentDefinitionSlugSettings"];
|
|
571
571
|
/** @description Default component instance value */
|
|
572
|
-
defaults?: components$
|
|
572
|
+
defaults?: components$r["schemas"]["ComponentInstance"] | null;
|
|
573
573
|
/** @description Named variants for this component; enables the creation of visual variants that use the same parameter data */
|
|
574
|
-
variants?: components$
|
|
574
|
+
variants?: components$r["schemas"]["ComponentDefinitionVariant"][];
|
|
575
575
|
/** @description Created date string for this definition (ignored for writes) */
|
|
576
576
|
created?: string;
|
|
577
577
|
/** @description Last modified date string for this definition (ignored for writes) */
|
|
@@ -594,7 +594,7 @@ interface components$q {
|
|
|
594
594
|
[name: string]: unknown;
|
|
595
595
|
};
|
|
596
596
|
content: {
|
|
597
|
-
"application/json": components$
|
|
597
|
+
"application/json": components$r["schemas"]["Error"];
|
|
598
598
|
};
|
|
599
599
|
};
|
|
600
600
|
/** @description API key or token was not valid */
|
|
@@ -603,7 +603,7 @@ interface components$q {
|
|
|
603
603
|
[name: string]: unknown;
|
|
604
604
|
};
|
|
605
605
|
content: {
|
|
606
|
-
"application/json": components$
|
|
606
|
+
"application/json": components$r["schemas"]["Error"];
|
|
607
607
|
};
|
|
608
608
|
};
|
|
609
609
|
/** @description Permission was denied */
|
|
@@ -612,7 +612,7 @@ interface components$q {
|
|
|
612
612
|
[name: string]: unknown;
|
|
613
613
|
};
|
|
614
614
|
content: {
|
|
615
|
-
"application/json": components$
|
|
615
|
+
"application/json": components$r["schemas"]["Error"];
|
|
616
616
|
};
|
|
617
617
|
};
|
|
618
618
|
/** @description Too many requests in allowed time period */
|
|
@@ -636,13 +636,13 @@ interface components$q {
|
|
|
636
636
|
pathItems: never;
|
|
637
637
|
}
|
|
638
638
|
|
|
639
|
-
interface components$
|
|
639
|
+
interface components$q {
|
|
640
640
|
schemas: {
|
|
641
641
|
/** @description Public ID (used in code). Do not change after creation */
|
|
642
642
|
PublicIdProperty: string;
|
|
643
643
|
/** @description The definition of a component parameter */
|
|
644
644
|
ComponentDefinitionParameter: {
|
|
645
|
-
id: components$
|
|
645
|
+
id: components$q["schemas"]["PublicIdProperty"];
|
|
646
646
|
/** @description Friendly name of the parameter */
|
|
647
647
|
name: string;
|
|
648
648
|
/** @description Appears next to the parameter in the Composition editor */
|
|
@@ -673,7 +673,7 @@ interface components$p {
|
|
|
673
673
|
};
|
|
674
674
|
/** @description The definition of a named component slot that can contain other components */
|
|
675
675
|
ComponentDefinitionSlot: {
|
|
676
|
-
id: components$
|
|
676
|
+
id: components$q["schemas"]["PublicIdProperty"];
|
|
677
677
|
/** @description Friendly name of the slot */
|
|
678
678
|
name: string;
|
|
679
679
|
/** @description A list of component definition public IDs that are allowed in this named slot */
|
|
@@ -728,13 +728,13 @@ interface components$p {
|
|
|
728
728
|
};
|
|
729
729
|
/** @description The definition of a component variant */
|
|
730
730
|
ComponentDefinitionVariant: {
|
|
731
|
-
id: components$
|
|
731
|
+
id: components$q["schemas"]["PublicIdProperty"];
|
|
732
732
|
/** @description Friendly name of the variant */
|
|
733
733
|
name: string;
|
|
734
734
|
};
|
|
735
735
|
/** @description Permission set for a component definition */
|
|
736
736
|
ComponentDefinitionPermission: {
|
|
737
|
-
roleId: components$
|
|
737
|
+
roleId: components$q["schemas"]["PublicIdProperty"];
|
|
738
738
|
/**
|
|
739
739
|
* @description Permission type for this permission ComponentDefinition:
|
|
740
740
|
* read | write | create | delete
|
|
@@ -747,7 +747,7 @@ interface components$p {
|
|
|
747
747
|
};
|
|
748
748
|
/** @description Defines a component type that can live on a Composition */
|
|
749
749
|
ComponentDefinition: {
|
|
750
|
-
id: components$
|
|
750
|
+
id: components$q["schemas"]["PublicIdProperty"];
|
|
751
751
|
/** @description Friendly name of the component definition */
|
|
752
752
|
name: string;
|
|
753
753
|
/**
|
|
@@ -774,7 +774,7 @@ interface components$p {
|
|
|
774
774
|
*/
|
|
775
775
|
canBeComposition?: boolean;
|
|
776
776
|
/** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries */
|
|
777
|
-
parameters?: components$
|
|
777
|
+
parameters?: components$q["schemas"]["ComponentDefinitionParameter"][];
|
|
778
778
|
/**
|
|
779
779
|
* Format: uuid
|
|
780
780
|
* @description Reference to the category this component definition belongs to
|
|
@@ -791,14 +791,14 @@ interface components$p {
|
|
|
791
791
|
*/
|
|
792
792
|
useTeamPermissions?: boolean;
|
|
793
793
|
/** @description Custom role permissions for this component definition */
|
|
794
|
-
permissions?: components$
|
|
794
|
+
permissions?: components$q["schemas"]["ComponentDefinitionPermission"][];
|
|
795
795
|
/** @description The named slots for this component; placement areas where arrays of other components can be added */
|
|
796
|
-
slots?: components$
|
|
797
|
-
slugSettings?: components$
|
|
796
|
+
slots?: components$q["schemas"]["ComponentDefinitionSlot"][];
|
|
797
|
+
slugSettings?: components$q["schemas"]["ComponentDefinitionSlugSettings"];
|
|
798
798
|
/** @description Default component instance value */
|
|
799
|
-
defaults?: components$
|
|
799
|
+
defaults?: components$q["schemas"]["ComponentInstance"] | null;
|
|
800
800
|
/** @description Named variants for this component; enables the creation of visual variants that use the same parameter data */
|
|
801
|
-
variants?: components$
|
|
801
|
+
variants?: components$q["schemas"]["ComponentDefinitionVariant"][];
|
|
802
802
|
/** @description Created date string for this definition (ignored for writes) */
|
|
803
803
|
created?: string;
|
|
804
804
|
/** @description Last modified date string for this definition (ignored for writes) */
|
|
@@ -811,7 +811,7 @@ interface components$p {
|
|
|
811
811
|
};
|
|
812
812
|
/** @description Defines a content type */
|
|
813
813
|
ContentType: {
|
|
814
|
-
id: components$
|
|
814
|
+
id: components$q["schemas"]["PublicIdProperty"];
|
|
815
815
|
/** @description Friendly name of the content type */
|
|
816
816
|
name: string;
|
|
817
817
|
/** @description The public ID of the field whose value should be used to create a display name for entries of this content type in the UI.
|
|
@@ -825,7 +825,7 @@ interface components$p {
|
|
|
825
825
|
*/
|
|
826
826
|
thumbnailField?: string | null;
|
|
827
827
|
/** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
|
|
828
|
-
fields?: components$
|
|
828
|
+
fields?: components$q["schemas"]["ComponentDefinitionParameter"][];
|
|
829
829
|
/** @description Description of the content type */
|
|
830
830
|
description?: string;
|
|
831
831
|
/**
|
|
@@ -837,7 +837,7 @@ interface components$p {
|
|
|
837
837
|
created?: string;
|
|
838
838
|
/** @description Last modified date string for this content type (ignored for writes) */
|
|
839
839
|
updated?: string;
|
|
840
|
-
slugSettings?: components$
|
|
840
|
+
slugSettings?: components$q["schemas"]["ComponentDefinitionSlugSettings"];
|
|
841
841
|
/**
|
|
842
842
|
* @description The definition type of this content type (block or content type)
|
|
843
843
|
* @default contentType
|
|
@@ -850,14 +850,14 @@ interface components$p {
|
|
|
850
850
|
*/
|
|
851
851
|
useTeamPermissions?: boolean;
|
|
852
852
|
/** @description Custom role permissions for this content type */
|
|
853
|
-
permissions?: components$
|
|
853
|
+
permissions?: components$q["schemas"]["ComponentDefinitionPermission"][];
|
|
854
854
|
/**
|
|
855
855
|
* Format: uuid
|
|
856
856
|
* @description ID of the workflow that instances of this content type will use by default. When not set, no workflow is attached
|
|
857
857
|
*/
|
|
858
858
|
workflowId?: string;
|
|
859
859
|
/** @description Configurations for previewing an entry on a consuming pattern or composition. */
|
|
860
|
-
previewConfigurations?: components$
|
|
860
|
+
previewConfigurations?: components$q["schemas"]["ContentTypePreviewConfiguration"][];
|
|
861
861
|
};
|
|
862
862
|
/** @description Defines a configuration for previewing an entry on a consuming pattern or composition. */
|
|
863
863
|
ContentTypePreviewConfiguration: {
|
|
@@ -885,18 +885,18 @@ interface components$p {
|
|
|
885
885
|
/** @description The type of the parameter. Determines how it is displayed when editing and tells the consumer how to process it */
|
|
886
886
|
type: string;
|
|
887
887
|
/** @deprecated */
|
|
888
|
-
connectedData?: components$
|
|
888
|
+
connectedData?: components$q["schemas"]["DataElementConnectionDefinition"];
|
|
889
889
|
/** @description Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
|
|
890
890
|
* Note that locales must be registered on the entry/composition `_locales` before being used
|
|
891
891
|
* */
|
|
892
892
|
locales?: {
|
|
893
893
|
[key: string]: unknown;
|
|
894
894
|
};
|
|
895
|
-
conditions?: components$
|
|
895
|
+
conditions?: components$q["schemas"]["ComponentParameterConditions"];
|
|
896
896
|
/** @description Locale-specific conditional values for this parameter. Keys are locale codes, and values are the `conditions` for that locale.
|
|
897
897
|
* */
|
|
898
898
|
localesConditions?: {
|
|
899
|
-
[key: string]: components$
|
|
899
|
+
[key: string]: components$q["schemas"]["ComponentParameterConditions"];
|
|
900
900
|
};
|
|
901
901
|
};
|
|
902
902
|
/** @description Array of alternate values which are based on conditions.
|
|
@@ -908,11 +908,11 @@ interface components$p {
|
|
|
908
908
|
*
|
|
909
909
|
* When no locale is passed to a non-route API, conditions are not processed and all conditions are returned.
|
|
910
910
|
* */
|
|
911
|
-
ComponentParameterConditions: components$
|
|
911
|
+
ComponentParameterConditions: components$q["schemas"]["ComponentParameterConditionalValue"][];
|
|
912
912
|
/** @description Defines a conditional value for a component parameter
|
|
913
913
|
* */
|
|
914
914
|
ComponentParameterConditionalValue: {
|
|
915
|
-
when: components$
|
|
915
|
+
when: components$q["schemas"]["VisibilityCriteriaGroup"];
|
|
916
916
|
/** @description The value of the parameter. Any JSON-serializable value is acceptable.
|
|
917
917
|
* A value of `null` will cause the parameter value to be removed, if it matches.
|
|
918
918
|
* */
|
|
@@ -932,7 +932,7 @@ interface components$p {
|
|
|
932
932
|
* @enum {string}
|
|
933
933
|
*/
|
|
934
934
|
op?: "&" | "|";
|
|
935
|
-
clauses: (components$
|
|
935
|
+
clauses: (components$q["schemas"]["VisibilityCriteria"] | components$q["schemas"]["VisibilityCriteriaGroup"])[];
|
|
936
936
|
};
|
|
937
937
|
/**
|
|
938
938
|
* @deprecated
|
|
@@ -995,13 +995,13 @@ interface components$p {
|
|
|
995
995
|
type: string;
|
|
996
996
|
/** @description Component parameter values for the component instance */
|
|
997
997
|
parameters?: {
|
|
998
|
-
[key: string]: components$
|
|
998
|
+
[key: string]: components$q["schemas"]["ComponentParameter"];
|
|
999
999
|
};
|
|
1000
1000
|
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
|
1001
1001
|
variant?: string;
|
|
1002
1002
|
/** @description Slots containing any child components */
|
|
1003
1003
|
slots?: {
|
|
1004
|
-
[key: string]: components$
|
|
1004
|
+
[key: string]: components$q["schemas"]["ComponentInstance"][];
|
|
1005
1005
|
};
|
|
1006
1006
|
/** @description Unique identifier of the component within the composition.
|
|
1007
1007
|
* No assumptions should be made about the format of this value other than "it will be unique."
|
|
@@ -1011,14 +1011,14 @@ interface components$p {
|
|
|
1011
1011
|
_id?: string;
|
|
1012
1012
|
/** @description Indicates this component instance should be sourced from a pattern library pattern */
|
|
1013
1013
|
_pattern?: string;
|
|
1014
|
-
_dataResources?: components$
|
|
1014
|
+
_dataResources?: components$q["schemas"]["DataResourceDefinitions"];
|
|
1015
1015
|
/** @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
|
1016
1016
|
* Means nothing for PUTs; it will be ignored
|
|
1017
1017
|
* */
|
|
1018
1018
|
_patternDataResources?: {
|
|
1019
|
-
[key: string]: components$
|
|
1019
|
+
[key: string]: components$q["schemas"]["DataResourceDefinition"];
|
|
1020
1020
|
};
|
|
1021
|
-
_patternError?: components$
|
|
1021
|
+
_patternError?: components$q["schemas"]["PatternError"];
|
|
1022
1022
|
/** @description Defines patch overrides to component IDs that live in the composition.
|
|
1023
1023
|
* This can be used to override parameters that are defined on patterns,
|
|
1024
1024
|
* including nested patterns, with values that are specific to this composition.
|
|
@@ -1031,13 +1031,13 @@ interface components$p {
|
|
|
1031
1031
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
1032
1032
|
* */
|
|
1033
1033
|
_overrides?: {
|
|
1034
|
-
[key: string]: components$
|
|
1034
|
+
[key: string]: components$q["schemas"]["ComponentOverride"];
|
|
1035
1035
|
};
|
|
1036
1036
|
/** @description Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
|
|
1037
1037
|
* Means nothing for PUTs; it will be ignored
|
|
1038
1038
|
* */
|
|
1039
1039
|
_patternOverrides?: {
|
|
1040
|
-
[key: string]: components$
|
|
1040
|
+
[key: string]: components$q["schemas"]["ComponentOverride"];
|
|
1041
1041
|
};
|
|
1042
1042
|
/** @description When used on a pattern, defines how the pattern's parameters may be overridden
|
|
1043
1043
|
* by consumers of the pattern.
|
|
@@ -1045,7 +1045,7 @@ interface components$p {
|
|
|
1045
1045
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
1046
1046
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
1047
1047
|
* */
|
|
1048
|
-
_overridability?: components$
|
|
1048
|
+
_overridability?: components$q["schemas"]["ComponentOverridability"];
|
|
1049
1049
|
/** @description Array of locales that have data defined. Only set for pattern references or composition defaults */
|
|
1050
1050
|
_locales?: string[];
|
|
1051
1051
|
};
|
|
@@ -1055,15 +1055,15 @@ interface components$p {
|
|
|
1055
1055
|
type: string;
|
|
1056
1056
|
/** @description Component parameter values for the component instance */
|
|
1057
1057
|
parameters?: {
|
|
1058
|
-
[key: string]: components$
|
|
1058
|
+
[key: string]: components$q["schemas"]["ComponentParameter"];
|
|
1059
1059
|
};
|
|
1060
1060
|
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
|
1061
1061
|
variant?: string;
|
|
1062
1062
|
/** @description Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated */
|
|
1063
|
-
projectMapNodes?: components$
|
|
1063
|
+
projectMapNodes?: components$q["schemas"]["CompositionProjectMapNodeInfo"][];
|
|
1064
1064
|
/** @description Slots containing any child components */
|
|
1065
1065
|
slots?: {
|
|
1066
|
-
[key: string]: components$
|
|
1066
|
+
[key: string]: components$q["schemas"]["ComponentInstance"][];
|
|
1067
1067
|
};
|
|
1068
1068
|
/** @description The ID of the composition */
|
|
1069
1069
|
_id: string;
|
|
@@ -1085,10 +1085,10 @@ interface components$p {
|
|
|
1085
1085
|
* Means nothing for PUTs; it will be ignored
|
|
1086
1086
|
* */
|
|
1087
1087
|
_patternDataResources?: {
|
|
1088
|
-
[key: string]: components$
|
|
1088
|
+
[key: string]: components$q["schemas"]["DataResourceDefinition"];
|
|
1089
1089
|
};
|
|
1090
|
-
_dataResources?: components$
|
|
1091
|
-
_patternError?: components$
|
|
1090
|
+
_dataResources?: components$q["schemas"]["DataResourceDefinitions"];
|
|
1091
|
+
_patternError?: components$q["schemas"]["PatternError"];
|
|
1092
1092
|
/** @description Defines patch overrides to component IDs that live in the composition.
|
|
1093
1093
|
* This can be used to override parameters that are defined on patterns,
|
|
1094
1094
|
* including nested patterns, with values that are specific to this composition.
|
|
@@ -1101,13 +1101,13 @@ interface components$p {
|
|
|
1101
1101
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
1102
1102
|
* */
|
|
1103
1103
|
_overrides?: {
|
|
1104
|
-
[key: string]: components$
|
|
1104
|
+
[key: string]: components$q["schemas"]["ComponentOverride"];
|
|
1105
1105
|
};
|
|
1106
1106
|
/** @description Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
|
|
1107
1107
|
* Means nothing for PUTs; it will be ignored
|
|
1108
1108
|
* */
|
|
1109
1109
|
_patternOverrides?: {
|
|
1110
|
-
[key: string]: components$
|
|
1110
|
+
[key: string]: components$q["schemas"]["ComponentOverride"];
|
|
1111
1111
|
};
|
|
1112
1112
|
/** @description When used on a pattern, defines how the pattern's parameters may be overridden
|
|
1113
1113
|
* by consumers of the pattern.
|
|
@@ -1115,7 +1115,7 @@ interface components$p {
|
|
|
1115
1115
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
1116
1116
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
1117
1117
|
* */
|
|
1118
|
-
_overridability?: components$
|
|
1118
|
+
_overridability?: components$q["schemas"]["ComponentOverridability"];
|
|
1119
1119
|
/** @description Array of locales which have data defined on the composition. If empty, the current default locale implicitly has data */
|
|
1120
1120
|
_locales?: string[];
|
|
1121
1121
|
};
|
|
@@ -1126,10 +1126,10 @@ interface components$p {
|
|
|
1126
1126
|
* */
|
|
1127
1127
|
ComponentOverride: {
|
|
1128
1128
|
parameters?: {
|
|
1129
|
-
[key: string]: components$
|
|
1129
|
+
[key: string]: components$q["schemas"]["ComponentParameter"];
|
|
1130
1130
|
};
|
|
1131
1131
|
slots?: {
|
|
1132
|
-
[key: string]: components$
|
|
1132
|
+
[key: string]: components$q["schemas"]["ComponentInstance"][];
|
|
1133
1133
|
};
|
|
1134
1134
|
variant?: string;
|
|
1135
1135
|
/** @description Overrides data resource definitions for a pattern component.
|
|
@@ -1137,7 +1137,7 @@ interface components$p {
|
|
|
1137
1137
|
* Overrides defined here replace values in either _dataResources or _patternDataResources on the target component.
|
|
1138
1138
|
* */
|
|
1139
1139
|
dataResources?: {
|
|
1140
|
-
[key: string]: components$
|
|
1140
|
+
[key: string]: components$q["schemas"]["DataResourceDefinition"];
|
|
1141
1141
|
};
|
|
1142
1142
|
};
|
|
1143
1143
|
/** @description Defines how a component on a pattern may have its values overridden.
|
|
@@ -1149,7 +1149,7 @@ interface components$p {
|
|
|
1149
1149
|
ComponentOverridability: {
|
|
1150
1150
|
/** @description Defines component parameter value overrides. Keys are the parameter public ID */
|
|
1151
1151
|
parameters?: {
|
|
1152
|
-
[key: string]: components$
|
|
1152
|
+
[key: string]: components$q["schemas"]["OverrideOptions"];
|
|
1153
1153
|
};
|
|
1154
1154
|
/** @description Allows overriding a display variant is allowed if it is defined on the component the pattern is derived from. Default = false */
|
|
1155
1155
|
variants?: boolean;
|
|
@@ -1187,7 +1187,7 @@ interface components$p {
|
|
|
1187
1187
|
}[];
|
|
1188
1188
|
/** @description Variables needed to make calls to the data source */
|
|
1189
1189
|
variables?: {
|
|
1190
|
-
[key: string]: components$
|
|
1190
|
+
[key: string]: components$q["schemas"]["DataVariableDefinition"];
|
|
1191
1191
|
};
|
|
1192
1192
|
};
|
|
1193
1193
|
/** @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
|
|
@@ -1216,7 +1216,7 @@ interface components$p {
|
|
|
1216
1216
|
}[];
|
|
1217
1217
|
/** @description Variables needed to make calls to the data source */
|
|
1218
1218
|
variables?: {
|
|
1219
|
-
[key: string]: components$
|
|
1219
|
+
[key: string]: components$q["schemas"]["DataVariableDefinition"];
|
|
1220
1220
|
};
|
|
1221
1221
|
/** @description Mapping of locale codes to data source locale codes. Keys are Uniform locale codes, values are data source locale codes.
|
|
1222
1222
|
* If a locale is not mapped, it will be passed through to the data source as-is
|
|
@@ -1238,7 +1238,7 @@ interface components$p {
|
|
|
1238
1238
|
};
|
|
1239
1239
|
/** @description Different connector detail variants to use in the different contexts like e.g. Unpublished Data */
|
|
1240
1240
|
variants?: {
|
|
1241
|
-
unpublished?: components$
|
|
1241
|
+
unpublished?: components$q["schemas"]["AlternativeDataSourceData"];
|
|
1242
1242
|
};
|
|
1243
1243
|
};
|
|
1244
1244
|
/** @description A specific type of data that a Data Source can provide (i.e. "Recipe", "Recipes List by Tag", "Yelp Reviews of My Restaurant"). These are created in the UI and shared a whole project */
|
|
@@ -1285,7 +1285,7 @@ interface components$p {
|
|
|
1285
1285
|
method: "GET" | "POST" | "HEAD";
|
|
1286
1286
|
/** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys */
|
|
1287
1287
|
variables?: {
|
|
1288
|
-
[key: string]: components$
|
|
1288
|
+
[key: string]: components$q["schemas"]["DataVariableDefinition"];
|
|
1289
1289
|
};
|
|
1290
1290
|
/** @description Custom configuration specific to the data source being defined */
|
|
1291
1291
|
custom?: {
|
|
@@ -1316,7 +1316,7 @@ interface components$p {
|
|
|
1316
1316
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key)
|
|
1317
1317
|
* */
|
|
1318
1318
|
DataResourceDefinitions: {
|
|
1319
|
-
[key: string]: components$
|
|
1319
|
+
[key: string]: components$q["schemas"]["DataResourceDefinition"];
|
|
1320
1320
|
};
|
|
1321
1321
|
/** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
|
|
1322
1322
|
DataResourceDefinition: {
|
|
@@ -1333,7 +1333,7 @@ interface components$p {
|
|
|
1333
1333
|
* If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
|
|
1334
1334
|
* */
|
|
1335
1335
|
optionalPatternParameter?: boolean;
|
|
1336
|
-
variables?: components$
|
|
1336
|
+
variables?: components$q["schemas"]["DataResourceVariables"];
|
|
1337
1337
|
};
|
|
1338
1338
|
/** @description Variable values for a data resource */
|
|
1339
1339
|
DataResourceVariables: {
|
|
@@ -1356,7 +1356,7 @@ interface components$p {
|
|
|
1356
1356
|
/** @description If more history is available than your plan allows, and additional entries are available by upgrading, this will be true */
|
|
1357
1357
|
truncated?: boolean;
|
|
1358
1358
|
/** @description Version history entries */
|
|
1359
|
-
results?: components$
|
|
1359
|
+
results?: components$q["schemas"]["HistoryEntry"][];
|
|
1360
1360
|
};
|
|
1361
1361
|
HistoryEntry: {
|
|
1362
1362
|
/** @description The version ID of the entity. This can be used to fetch the version's data via the entity API */
|
|
@@ -1400,7 +1400,7 @@ interface components$p {
|
|
|
1400
1400
|
* @description Unique identifier for the project map that this node belongs to
|
|
1401
1401
|
*/
|
|
1402
1402
|
projectMapId: string;
|
|
1403
|
-
data?: components$
|
|
1403
|
+
data?: components$q["schemas"]["ProjectMapNodeData"];
|
|
1404
1404
|
/** @description Locale-specific paths of the project map node.
|
|
1405
1405
|
* Keys are locale codes
|
|
1406
1406
|
* */
|
|
@@ -1454,7 +1454,7 @@ interface components$p {
|
|
|
1454
1454
|
initialStage: string;
|
|
1455
1455
|
/** @description All stages of the workflow */
|
|
1456
1456
|
stages: {
|
|
1457
|
-
[key: string]: components$
|
|
1457
|
+
[key: string]: components$q["schemas"]["WorkflowStage"];
|
|
1458
1458
|
};
|
|
1459
1459
|
/** @description Last modified ISO date string for this definition (ignored for writes) */
|
|
1460
1460
|
modified?: string;
|
|
@@ -1481,7 +1481,7 @@ interface components$p {
|
|
|
1481
1481
|
* listed here, the stage is read-only and publishing is disabled
|
|
1482
1482
|
* */
|
|
1483
1483
|
permissions: {
|
|
1484
|
-
[key: string]: components$
|
|
1484
|
+
[key: string]: components$q["schemas"]["WorkflowStagePermission"];
|
|
1485
1485
|
};
|
|
1486
1486
|
/** @description When true, transitioning into this stage from a different stage will automatically publish the entity.
|
|
1487
1487
|
* If the user making the transition does not have publish permissions to the stage as well as publish permission on the entity, the action will not run.
|
|
@@ -1498,7 +1498,7 @@ interface components$p {
|
|
|
1498
1498
|
* Every stage must define at least one transition, to avoid creating a workflow that
|
|
1499
1499
|
* has a stage that can never be escaped
|
|
1500
1500
|
* */
|
|
1501
|
-
transitions: components$
|
|
1501
|
+
transitions: components$q["schemas"]["WorkflowStageTransition"][];
|
|
1502
1502
|
/**
|
|
1503
1503
|
* @description Icon name for the stage (e.g. 'chevron-double-right-o')
|
|
1504
1504
|
* @default chevron-double-right-o
|
|
@@ -1522,7 +1522,7 @@ interface components$p {
|
|
|
1522
1522
|
* NOTE: Users without membership in any role listed here will be unable to execute the transition unless they are team admins
|
|
1523
1523
|
* */
|
|
1524
1524
|
permissions: {
|
|
1525
|
-
[key: string]: components$
|
|
1525
|
+
[key: string]: components$q["schemas"]["WorkflowStageTransitionPermission"];
|
|
1526
1526
|
};
|
|
1527
1527
|
};
|
|
1528
1528
|
/** @description Permissions for a workflow stage */
|
|
@@ -1565,7 +1565,7 @@ interface components$p {
|
|
|
1565
1565
|
/** @description While performing a search if a node is a hit, this property will return true. If it's supporting structure, like a parent of a search hit, it will return false */
|
|
1566
1566
|
isSearchHit?: boolean;
|
|
1567
1567
|
/** @description Query strings that are allowed to be passed to the node */
|
|
1568
|
-
queryStrings?: components$
|
|
1568
|
+
queryStrings?: components$q["schemas"]["ProjectMapNodeAllowedQueryString"][];
|
|
1569
1569
|
/** @description For dynamic nodes, this is the preview value for the dynamic value.
|
|
1570
1570
|
* The preview value is used when editing a connected composition, and is the default
|
|
1571
1571
|
* dynamic node value unless the author has explicitly chosen a different value
|
|
@@ -1580,7 +1580,7 @@ interface components$p {
|
|
|
1580
1580
|
pathItems: never;
|
|
1581
1581
|
}
|
|
1582
1582
|
|
|
1583
|
-
interface paths$
|
|
1583
|
+
interface paths$m {
|
|
1584
1584
|
"/api/v1/categories": {
|
|
1585
1585
|
parameters: {
|
|
1586
1586
|
query?: never;
|
|
@@ -1606,15 +1606,15 @@ interface paths$l {
|
|
|
1606
1606
|
};
|
|
1607
1607
|
content: {
|
|
1608
1608
|
"application/json": {
|
|
1609
|
-
categories: components$
|
|
1609
|
+
categories: components$p["schemas"]["Category"][];
|
|
1610
1610
|
};
|
|
1611
1611
|
};
|
|
1612
1612
|
};
|
|
1613
|
-
400: components$
|
|
1614
|
-
401: components$
|
|
1615
|
-
403: components$
|
|
1616
|
-
429: components$
|
|
1617
|
-
500: components$
|
|
1613
|
+
400: components$p["responses"]["BadRequestError"];
|
|
1614
|
+
401: components$p["responses"]["UnauthorizedError"];
|
|
1615
|
+
403: components$p["responses"]["ForbiddenError"];
|
|
1616
|
+
429: components$p["responses"]["RateLimitError"];
|
|
1617
|
+
500: components$p["responses"]["InternalServerError"];
|
|
1618
1618
|
};
|
|
1619
1619
|
};
|
|
1620
1620
|
put: {
|
|
@@ -1629,7 +1629,7 @@ interface paths$l {
|
|
|
1629
1629
|
"application/json": {
|
|
1630
1630
|
/** Format: uuid */
|
|
1631
1631
|
projectId: string;
|
|
1632
|
-
categories: components$
|
|
1632
|
+
categories: components$p["schemas"]["Category"][];
|
|
1633
1633
|
};
|
|
1634
1634
|
};
|
|
1635
1635
|
};
|
|
@@ -1641,11 +1641,11 @@ interface paths$l {
|
|
|
1641
1641
|
};
|
|
1642
1642
|
content?: never;
|
|
1643
1643
|
};
|
|
1644
|
-
400: components$
|
|
1645
|
-
401: components$
|
|
1646
|
-
403: components$
|
|
1647
|
-
429: components$
|
|
1648
|
-
500: components$
|
|
1644
|
+
400: components$p["responses"]["BadRequestError"];
|
|
1645
|
+
401: components$p["responses"]["UnauthorizedError"];
|
|
1646
|
+
403: components$p["responses"]["ForbiddenError"];
|
|
1647
|
+
429: components$p["responses"]["RateLimitError"];
|
|
1648
|
+
500: components$p["responses"]["InternalServerError"];
|
|
1649
1649
|
};
|
|
1650
1650
|
};
|
|
1651
1651
|
post?: never;
|
|
@@ -1674,11 +1674,11 @@ interface paths$l {
|
|
|
1674
1674
|
};
|
|
1675
1675
|
content?: never;
|
|
1676
1676
|
};
|
|
1677
|
-
400: components$
|
|
1678
|
-
401: components$
|
|
1679
|
-
403: components$
|
|
1680
|
-
429: components$
|
|
1681
|
-
500: components$
|
|
1677
|
+
400: components$p["responses"]["BadRequestError"];
|
|
1678
|
+
401: components$p["responses"]["UnauthorizedError"];
|
|
1679
|
+
403: components$p["responses"]["ForbiddenError"];
|
|
1680
|
+
429: components$p["responses"]["RateLimitError"];
|
|
1681
|
+
500: components$p["responses"]["InternalServerError"];
|
|
1682
1682
|
};
|
|
1683
1683
|
};
|
|
1684
1684
|
options?: never;
|
|
@@ -1687,7 +1687,7 @@ interface paths$l {
|
|
|
1687
1687
|
trace?: never;
|
|
1688
1688
|
};
|
|
1689
1689
|
}
|
|
1690
|
-
interface components$
|
|
1690
|
+
interface components$p {
|
|
1691
1691
|
schemas: {
|
|
1692
1692
|
/** @description Category for tagging canvas entities */
|
|
1693
1693
|
Category: {
|
|
@@ -1716,7 +1716,7 @@ interface components$o {
|
|
|
1716
1716
|
[name: string]: unknown;
|
|
1717
1717
|
};
|
|
1718
1718
|
content: {
|
|
1719
|
-
"application/json": components$
|
|
1719
|
+
"application/json": components$p["schemas"]["Error"];
|
|
1720
1720
|
};
|
|
1721
1721
|
};
|
|
1722
1722
|
/** @description API key or token was not valid */
|
|
@@ -1725,7 +1725,7 @@ interface components$o {
|
|
|
1725
1725
|
[name: string]: unknown;
|
|
1726
1726
|
};
|
|
1727
1727
|
content: {
|
|
1728
|
-
"application/json": components$
|
|
1728
|
+
"application/json": components$p["schemas"]["Error"];
|
|
1729
1729
|
};
|
|
1730
1730
|
};
|
|
1731
1731
|
/** @description Permission was denied */
|
|
@@ -1734,7 +1734,7 @@ interface components$o {
|
|
|
1734
1734
|
[name: string]: unknown;
|
|
1735
1735
|
};
|
|
1736
1736
|
content: {
|
|
1737
|
-
"application/json": components$
|
|
1737
|
+
"application/json": components$p["schemas"]["Error"];
|
|
1738
1738
|
};
|
|
1739
1739
|
};
|
|
1740
1740
|
/** @description Too many requests in allowed time period */
|
|
@@ -1758,8 +1758,8 @@ interface components$o {
|
|
|
1758
1758
|
pathItems: never;
|
|
1759
1759
|
}
|
|
1760
1760
|
|
|
1761
|
-
type SharedComponents$3 = components$
|
|
1762
|
-
type Api$2 = paths$
|
|
1761
|
+
type SharedComponents$3 = components$q['schemas'];
|
|
1762
|
+
type Api$2 = paths$m['/api/v1/categories'];
|
|
1763
1763
|
/** Shape of the GET response from /api/v1/category */
|
|
1764
1764
|
type CategoriesGetResponse = Api$2['get']['responses']['200']['content']['application/json'];
|
|
1765
1765
|
/** Shape of the PUT request body for /api/v1/category */
|
|
@@ -1771,8 +1771,8 @@ type CategoriesGetParameters = Api$2['get']['parameters']['query'];
|
|
|
1771
1771
|
/** Defines a component type that can live on a Composition */
|
|
1772
1772
|
type Category = SharedComponents$3['Category'];
|
|
1773
1773
|
|
|
1774
|
-
type SharedComponents$2 = components$
|
|
1775
|
-
type Api$1 = paths$
|
|
1774
|
+
type SharedComponents$2 = components$q['schemas'];
|
|
1775
|
+
type Api$1 = paths$n['/api/v1/canvas-definitions'];
|
|
1776
1776
|
/** Shape of the GET response from /api/v1/canvas-definitions */
|
|
1777
1777
|
type ComponentDefinitionGetResponse = Api$1['get']['responses']['200']['content']['application/json'];
|
|
1778
1778
|
/** Shape of the PUT request body for /api/v1/canvas-definitions */
|
|
@@ -1782,7 +1782,7 @@ type ComponentDefinitionDeleteParameters = Api$1['delete']['requestBody']['conte
|
|
|
1782
1782
|
/** Query parameter options for GET /api/v1/canvas-definitions */
|
|
1783
1783
|
type ComponentDefinitionGetParameters = Api$1['get']['parameters']['query'];
|
|
1784
1784
|
/** The definition of a component parameter */
|
|
1785
|
-
type ComponentDefinitionParameter<TConfig = unknown> = Omit<components$
|
|
1785
|
+
type ComponentDefinitionParameter<TConfig = unknown> = Omit<components$q['schemas']['ComponentDefinitionParameter'], 'typeConfig'> & {
|
|
1786
1786
|
typeConfig?: TConfig;
|
|
1787
1787
|
};
|
|
1788
1788
|
/** The definition of a component visual variant */
|
|
@@ -1906,7 +1906,7 @@ declare const ASSETS_SOURCE_UNIFORM = "uniform-assets";
|
|
|
1906
1906
|
/** The _source for any assets which have manually set fields */
|
|
1907
1907
|
declare const ASSETS_SOURCE_CUSTOM_URL = "custom-url";
|
|
1908
1908
|
|
|
1909
|
-
interface components$
|
|
1909
|
+
interface components$o {
|
|
1910
1910
|
schemas: {
|
|
1911
1911
|
/** @description Defines the shape of the entry */
|
|
1912
1912
|
Entry: {
|
|
@@ -1937,14 +1937,14 @@ interface components$n {
|
|
|
1937
1937
|
_locales?: string[];
|
|
1938
1938
|
/** @description Entry field values */
|
|
1939
1939
|
fields?: {
|
|
1940
|
-
[key: string]: components$
|
|
1940
|
+
[key: string]: components$o["schemas"]["ComponentParameter"];
|
|
1941
1941
|
};
|
|
1942
|
-
_dataResources?: components$
|
|
1942
|
+
_dataResources?: components$o["schemas"]["DataResourceDefinitions"];
|
|
1943
1943
|
/** @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
|
1944
1944
|
* Means nothing for PUTs; it will be ignored
|
|
1945
1945
|
* */
|
|
1946
1946
|
_patternDataResources?: {
|
|
1947
|
-
[key: string]: components$
|
|
1947
|
+
[key: string]: components$o["schemas"]["DataResourceDefinition"];
|
|
1948
1948
|
};
|
|
1949
1949
|
/**
|
|
1950
1950
|
* @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
|
@@ -1967,7 +1967,7 @@ interface components$n {
|
|
|
1967
1967
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
1968
1968
|
* */
|
|
1969
1969
|
_overrides?: {
|
|
1970
|
-
[key: string]: components$
|
|
1970
|
+
[key: string]: components$o["schemas"]["ComponentOverride"];
|
|
1971
1971
|
};
|
|
1972
1972
|
/** @description When used on a pattern, defines how the pattern's parameters may be overridden
|
|
1973
1973
|
* by consumers of the pattern.
|
|
@@ -1975,7 +1975,7 @@ interface components$n {
|
|
|
1975
1975
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
1976
1976
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
1977
1977
|
* */
|
|
1978
|
-
_overridability?: components$
|
|
1978
|
+
_overridability?: components$o["schemas"]["ComponentOverridability"];
|
|
1979
1979
|
};
|
|
1980
1980
|
/** @description Defines the shape of the entry input */
|
|
1981
1981
|
EntryInput: {
|
|
@@ -2002,16 +2002,16 @@ interface components$n {
|
|
|
2002
2002
|
_creatorSubject?: string;
|
|
2003
2003
|
/** @description Entry field values */
|
|
2004
2004
|
fields?: {
|
|
2005
|
-
[key: string]: components$
|
|
2005
|
+
[key: string]: components$o["schemas"]["ComponentParameter"];
|
|
2006
2006
|
};
|
|
2007
|
-
_dataResources?: components$
|
|
2007
|
+
_dataResources?: components$o["schemas"]["DataResourceDefinitions"];
|
|
2008
2008
|
/** @description Indicates this content entry should be sourced from a pattern library pattern */
|
|
2009
2009
|
_pattern?: string;
|
|
2010
2010
|
/** @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
|
2011
2011
|
* Means nothing for PUTs; it will be ignored
|
|
2012
2012
|
* */
|
|
2013
2013
|
_patternDataResources?: {
|
|
2014
|
-
[key: string]: components$
|
|
2014
|
+
[key: string]: components$o["schemas"]["DataResourceDefinition"];
|
|
2015
2015
|
};
|
|
2016
2016
|
/**
|
|
2017
2017
|
* @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
|
@@ -2029,7 +2029,7 @@ interface components$n {
|
|
|
2029
2029
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
2030
2030
|
* */
|
|
2031
2031
|
_overrides?: {
|
|
2032
|
-
[key: string]: components$
|
|
2032
|
+
[key: string]: components$o["schemas"]["ComponentOverride"];
|
|
2033
2033
|
};
|
|
2034
2034
|
/** @description When used on a pattern, defines how the pattern's fields may be overridden
|
|
2035
2035
|
* by consumers of the pattern.
|
|
@@ -2037,7 +2037,7 @@ interface components$n {
|
|
|
2037
2037
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
2038
2038
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
2039
2039
|
* */
|
|
2040
|
-
_overridability?: components$
|
|
2040
|
+
_overridability?: components$o["schemas"]["ComponentOverridability"];
|
|
2041
2041
|
/** @description Array of locales which have data defined on the entry. If empty, the current default locale implicitly has data */
|
|
2042
2042
|
_locales?: string[];
|
|
2043
2043
|
};
|
|
@@ -2075,7 +2075,7 @@ interface components$n {
|
|
|
2075
2075
|
* @default false
|
|
2076
2076
|
*/
|
|
2077
2077
|
pattern?: boolean;
|
|
2078
|
-
entry: components$
|
|
2078
|
+
entry: components$o["schemas"]["Entry"];
|
|
2079
2079
|
/**
|
|
2080
2080
|
* Format: uuid
|
|
2081
2081
|
* @description The workflow ID that this entry is assigned. Normally comes from the content type
|
|
@@ -2087,7 +2087,7 @@ interface components$n {
|
|
|
2087
2087
|
*/
|
|
2088
2088
|
workflowStageId?: string;
|
|
2089
2089
|
/** @description The full definition of the assigned workflow, if any, including stages, permissions, etc. Only returned when `withWorkflowDefinition` is true */
|
|
2090
|
-
workflowDefinition?: components$
|
|
2090
|
+
workflowDefinition?: components$o["schemas"]["WorkflowDefinition"];
|
|
2091
2091
|
/**
|
|
2092
2092
|
* @description Only present if an incomplete entry is returned; indicates reason for stubbing
|
|
2093
2093
|
* @enum {string}
|
|
@@ -2109,7 +2109,7 @@ interface components$n {
|
|
|
2109
2109
|
editionPriority?: number;
|
|
2110
2110
|
};
|
|
2111
2111
|
EntryListResponse: {
|
|
2112
|
-
entries: components$
|
|
2112
|
+
entries: components$o["schemas"]["EntryApiResponse"][];
|
|
2113
2113
|
/** @description Total number of entries that match the query. Only present when `withTotalCount` option is true */
|
|
2114
2114
|
totalCount?: number;
|
|
2115
2115
|
/** @description Per-field counts for distinct values */
|
|
@@ -2184,12 +2184,12 @@ interface components$n {
|
|
|
2184
2184
|
* @enum {string}
|
|
2185
2185
|
*/
|
|
2186
2186
|
op?: "&" | "|";
|
|
2187
|
-
clauses: (components$
|
|
2187
|
+
clauses: (components$o["schemas"]["VisibilityCriteria"] | components$o["schemas"]["VisibilityCriteriaGroup"])[];
|
|
2188
2188
|
};
|
|
2189
2189
|
/** @description Defines a conditional value for a component parameter
|
|
2190
2190
|
* */
|
|
2191
2191
|
ComponentParameterConditionalValue: {
|
|
2192
|
-
when: components$
|
|
2192
|
+
when: components$o["schemas"]["VisibilityCriteriaGroup"];
|
|
2193
2193
|
/** @description The value of the parameter. Any JSON-serializable value is acceptable.
|
|
2194
2194
|
* A value of `null` will cause the parameter value to be removed, if it matches.
|
|
2195
2195
|
* */
|
|
@@ -2208,7 +2208,7 @@ interface components$n {
|
|
|
2208
2208
|
*
|
|
2209
2209
|
* When no locale is passed to a non-route API, conditions are not processed and all conditions are returned.
|
|
2210
2210
|
* */
|
|
2211
|
-
ComponentParameterConditions: components$
|
|
2211
|
+
ComponentParameterConditions: components$o["schemas"]["ComponentParameterConditionalValue"][];
|
|
2212
2212
|
/** @description Defines an editable parameter on a component */
|
|
2213
2213
|
ComponentParameter: {
|
|
2214
2214
|
/** @description The value of the parameter. Any JSON-serializable value is acceptable */
|
|
@@ -2216,18 +2216,18 @@ interface components$n {
|
|
|
2216
2216
|
/** @description The type of the parameter. Determines how it is displayed when editing and tells the consumer how to process it */
|
|
2217
2217
|
type: string;
|
|
2218
2218
|
/** @deprecated */
|
|
2219
|
-
connectedData?: components$
|
|
2219
|
+
connectedData?: components$o["schemas"]["DataElementConnectionDefinition"];
|
|
2220
2220
|
/** @description Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
|
|
2221
2221
|
* Note that locales must be registered on the entry/composition `_locales` before being used
|
|
2222
2222
|
* */
|
|
2223
2223
|
locales?: {
|
|
2224
2224
|
[key: string]: unknown;
|
|
2225
2225
|
};
|
|
2226
|
-
conditions?: components$
|
|
2226
|
+
conditions?: components$o["schemas"]["ComponentParameterConditions"];
|
|
2227
2227
|
/** @description Locale-specific conditional values for this parameter. Keys are locale codes, and values are the `conditions` for that locale.
|
|
2228
2228
|
* */
|
|
2229
2229
|
localesConditions?: {
|
|
2230
|
-
[key: string]: components$
|
|
2230
|
+
[key: string]: components$o["schemas"]["ComponentParameterConditions"];
|
|
2231
2231
|
};
|
|
2232
2232
|
};
|
|
2233
2233
|
/** @description Variable values for a data resource */
|
|
@@ -2249,13 +2249,13 @@ interface components$n {
|
|
|
2249
2249
|
* If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
|
|
2250
2250
|
* */
|
|
2251
2251
|
optionalPatternParameter?: boolean;
|
|
2252
|
-
variables?: components$
|
|
2252
|
+
variables?: components$o["schemas"]["DataResourceVariables"];
|
|
2253
2253
|
};
|
|
2254
2254
|
/** @description Data definitions attached to this component. The property name is the key of the data in the data document.
|
|
2255
2255
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key)
|
|
2256
2256
|
* */
|
|
2257
2257
|
DataResourceDefinitions: {
|
|
2258
|
-
[key: string]: components$
|
|
2258
|
+
[key: string]: components$o["schemas"]["DataResourceDefinition"];
|
|
2259
2259
|
};
|
|
2260
2260
|
/** @description Defines the shape of a component instance served by the composition API */
|
|
2261
2261
|
ComponentInstance: {
|
|
@@ -2263,13 +2263,13 @@ interface components$n {
|
|
|
2263
2263
|
type: string;
|
|
2264
2264
|
/** @description Component parameter values for the component instance */
|
|
2265
2265
|
parameters?: {
|
|
2266
|
-
[key: string]: components$
|
|
2266
|
+
[key: string]: components$o["schemas"]["ComponentParameter"];
|
|
2267
2267
|
};
|
|
2268
2268
|
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
|
2269
2269
|
variant?: string;
|
|
2270
2270
|
/** @description Slots containing any child components */
|
|
2271
2271
|
slots?: {
|
|
2272
|
-
[key: string]: components$
|
|
2272
|
+
[key: string]: components$o["schemas"]["ComponentInstance"][];
|
|
2273
2273
|
};
|
|
2274
2274
|
/** @description Unique identifier of the component within the composition.
|
|
2275
2275
|
* No assumptions should be made about the format of this value other than "it will be unique."
|
|
@@ -2279,14 +2279,14 @@ interface components$n {
|
|
|
2279
2279
|
_id?: string;
|
|
2280
2280
|
/** @description Indicates this component instance should be sourced from a pattern library pattern */
|
|
2281
2281
|
_pattern?: string;
|
|
2282
|
-
_dataResources?: components$
|
|
2282
|
+
_dataResources?: components$o["schemas"]["DataResourceDefinitions"];
|
|
2283
2283
|
/** @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
|
2284
2284
|
* Means nothing for PUTs; it will be ignored
|
|
2285
2285
|
* */
|
|
2286
2286
|
_patternDataResources?: {
|
|
2287
|
-
[key: string]: components$
|
|
2287
|
+
[key: string]: components$o["schemas"]["DataResourceDefinition"];
|
|
2288
2288
|
};
|
|
2289
|
-
_patternError?: components$
|
|
2289
|
+
_patternError?: components$o["schemas"]["PatternError"];
|
|
2290
2290
|
/** @description Defines patch overrides to component IDs that live in the composition.
|
|
2291
2291
|
* This can be used to override parameters that are defined on patterns,
|
|
2292
2292
|
* including nested patterns, with values that are specific to this composition.
|
|
@@ -2299,13 +2299,13 @@ interface components$n {
|
|
|
2299
2299
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
2300
2300
|
* */
|
|
2301
2301
|
_overrides?: {
|
|
2302
|
-
[key: string]: components$
|
|
2302
|
+
[key: string]: components$o["schemas"]["ComponentOverride"];
|
|
2303
2303
|
};
|
|
2304
2304
|
/** @description Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
|
|
2305
2305
|
* Means nothing for PUTs; it will be ignored
|
|
2306
2306
|
* */
|
|
2307
2307
|
_patternOverrides?: {
|
|
2308
|
-
[key: string]: components$
|
|
2308
|
+
[key: string]: components$o["schemas"]["ComponentOverride"];
|
|
2309
2309
|
};
|
|
2310
2310
|
/** @description When used on a pattern, defines how the pattern's parameters may be overridden
|
|
2311
2311
|
* by consumers of the pattern.
|
|
@@ -2313,7 +2313,7 @@ interface components$n {
|
|
|
2313
2313
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
2314
2314
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
2315
2315
|
* */
|
|
2316
|
-
_overridability?: components$
|
|
2316
|
+
_overridability?: components$o["schemas"]["ComponentOverridability"];
|
|
2317
2317
|
/** @description Array of locales that have data defined. Only set for pattern references or composition defaults */
|
|
2318
2318
|
_locales?: string[];
|
|
2319
2319
|
};
|
|
@@ -2333,10 +2333,10 @@ interface components$n {
|
|
|
2333
2333
|
* */
|
|
2334
2334
|
ComponentOverride: {
|
|
2335
2335
|
parameters?: {
|
|
2336
|
-
[key: string]: components$
|
|
2336
|
+
[key: string]: components$o["schemas"]["ComponentParameter"];
|
|
2337
2337
|
};
|
|
2338
2338
|
slots?: {
|
|
2339
|
-
[key: string]: components$
|
|
2339
|
+
[key: string]: components$o["schemas"]["ComponentInstance"][];
|
|
2340
2340
|
};
|
|
2341
2341
|
variant?: string;
|
|
2342
2342
|
/** @description Overrides data resource definitions for a pattern component.
|
|
@@ -2344,7 +2344,7 @@ interface components$n {
|
|
|
2344
2344
|
* Overrides defined here replace values in either _dataResources or _patternDataResources on the target component.
|
|
2345
2345
|
* */
|
|
2346
2346
|
dataResources?: {
|
|
2347
|
-
[key: string]: components$
|
|
2347
|
+
[key: string]: components$o["schemas"]["DataResourceDefinition"];
|
|
2348
2348
|
};
|
|
2349
2349
|
};
|
|
2350
2350
|
/**
|
|
@@ -2365,7 +2365,7 @@ interface components$n {
|
|
|
2365
2365
|
ComponentOverridability: {
|
|
2366
2366
|
/** @description Defines component parameter value overrides. Keys are the parameter public ID */
|
|
2367
2367
|
parameters?: {
|
|
2368
|
-
[key: string]: components$
|
|
2368
|
+
[key: string]: components$o["schemas"]["OverrideOptions"];
|
|
2369
2369
|
};
|
|
2370
2370
|
/** @description Allows overriding a display variant is allowed if it is defined on the component the pattern is derived from. Default = false */
|
|
2371
2371
|
variants?: boolean;
|
|
@@ -2402,7 +2402,7 @@ interface components$n {
|
|
|
2402
2402
|
* NOTE: Users without membership in any role listed here will be unable to execute the transition unless they are team admins
|
|
2403
2403
|
* */
|
|
2404
2404
|
permissions: {
|
|
2405
|
-
[key: string]: components$
|
|
2405
|
+
[key: string]: components$o["schemas"]["WorkflowStageTransitionPermission"];
|
|
2406
2406
|
};
|
|
2407
2407
|
};
|
|
2408
2408
|
/** @description Definition of a stage in a workflow */
|
|
@@ -2415,7 +2415,7 @@ interface components$n {
|
|
|
2415
2415
|
* listed here, the stage is read-only and publishing is disabled
|
|
2416
2416
|
* */
|
|
2417
2417
|
permissions: {
|
|
2418
|
-
[key: string]: components$
|
|
2418
|
+
[key: string]: components$o["schemas"]["WorkflowStagePermission"];
|
|
2419
2419
|
};
|
|
2420
2420
|
/** @description When true, transitioning into this stage from a different stage will automatically publish the entity.
|
|
2421
2421
|
* If the user making the transition does not have publish permissions to the stage as well as publish permission on the entity, the action will not run.
|
|
@@ -2432,7 +2432,7 @@ interface components$n {
|
|
|
2432
2432
|
* Every stage must define at least one transition, to avoid creating a workflow that
|
|
2433
2433
|
* has a stage that can never be escaped
|
|
2434
2434
|
* */
|
|
2435
|
-
transitions: components$
|
|
2435
|
+
transitions: components$o["schemas"]["WorkflowStageTransition"][];
|
|
2436
2436
|
/**
|
|
2437
2437
|
* @description Icon name for the stage (e.g. 'chevron-double-right-o')
|
|
2438
2438
|
* @default chevron-double-right-o
|
|
@@ -2457,7 +2457,7 @@ interface components$n {
|
|
|
2457
2457
|
initialStage: string;
|
|
2458
2458
|
/** @description All stages of the workflow */
|
|
2459
2459
|
stages: {
|
|
2460
|
-
[key: string]: components$
|
|
2460
|
+
[key: string]: components$o["schemas"]["WorkflowStage"];
|
|
2461
2461
|
};
|
|
2462
2462
|
/** @description Last modified ISO date string for this definition (ignored for writes) */
|
|
2463
2463
|
modified?: string;
|
|
@@ -2605,7 +2605,7 @@ interface components$n {
|
|
|
2605
2605
|
pathItems: never;
|
|
2606
2606
|
}
|
|
2607
2607
|
|
|
2608
|
-
interface paths$
|
|
2608
|
+
interface paths$l {
|
|
2609
2609
|
"/api/v1/content-types": {
|
|
2610
2610
|
parameters: {
|
|
2611
2611
|
query?: never;
|
|
@@ -2639,15 +2639,15 @@ interface paths$k {
|
|
|
2639
2639
|
content: {
|
|
2640
2640
|
"application/json": {
|
|
2641
2641
|
/** @description Content types that match the query */
|
|
2642
|
-
contentTypes: components$
|
|
2642
|
+
contentTypes: components$n["schemas"]["ContentType"][];
|
|
2643
2643
|
};
|
|
2644
2644
|
};
|
|
2645
2645
|
};
|
|
2646
|
-
400: components$
|
|
2647
|
-
401: components$
|
|
2648
|
-
403: components$
|
|
2649
|
-
429: components$
|
|
2650
|
-
500: components$
|
|
2646
|
+
400: components$n["responses"]["BadRequestError"];
|
|
2647
|
+
401: components$n["responses"]["UnauthorizedError"];
|
|
2648
|
+
403: components$n["responses"]["ForbiddenError"];
|
|
2649
|
+
429: components$n["responses"]["RateLimitError"];
|
|
2650
|
+
500: components$n["responses"]["InternalServerError"];
|
|
2651
2651
|
};
|
|
2652
2652
|
};
|
|
2653
2653
|
/** @description Upserts a content type */
|
|
@@ -2666,7 +2666,7 @@ interface paths$k {
|
|
|
2666
2666
|
* @description The project ID to upsert the content type to
|
|
2667
2667
|
*/
|
|
2668
2668
|
projectId: string;
|
|
2669
|
-
contentType: components$
|
|
2669
|
+
contentType: components$n["schemas"]["ContentType"];
|
|
2670
2670
|
};
|
|
2671
2671
|
};
|
|
2672
2672
|
};
|
|
@@ -2678,11 +2678,11 @@ interface paths$k {
|
|
|
2678
2678
|
};
|
|
2679
2679
|
content?: never;
|
|
2680
2680
|
};
|
|
2681
|
-
400: components$
|
|
2682
|
-
401: components$
|
|
2683
|
-
403: components$
|
|
2684
|
-
429: components$
|
|
2685
|
-
500: components$
|
|
2681
|
+
400: components$n["responses"]["BadRequestError"];
|
|
2682
|
+
401: components$n["responses"]["UnauthorizedError"];
|
|
2683
|
+
403: components$n["responses"]["ForbiddenError"];
|
|
2684
|
+
429: components$n["responses"]["RateLimitError"];
|
|
2685
|
+
500: components$n["responses"]["InternalServerError"];
|
|
2686
2686
|
};
|
|
2687
2687
|
};
|
|
2688
2688
|
post?: never;
|
|
@@ -2715,11 +2715,11 @@ interface paths$k {
|
|
|
2715
2715
|
};
|
|
2716
2716
|
content?: never;
|
|
2717
2717
|
};
|
|
2718
|
-
400: components$
|
|
2719
|
-
401: components$
|
|
2720
|
-
403: components$
|
|
2721
|
-
429: components$
|
|
2722
|
-
500: components$
|
|
2718
|
+
400: components$n["responses"]["BadRequestError"];
|
|
2719
|
+
401: components$n["responses"]["UnauthorizedError"];
|
|
2720
|
+
403: components$n["responses"]["ForbiddenError"];
|
|
2721
|
+
429: components$n["responses"]["RateLimitError"];
|
|
2722
|
+
500: components$n["responses"]["InternalServerError"];
|
|
2723
2723
|
};
|
|
2724
2724
|
};
|
|
2725
2725
|
/** @description Handles preflight requests. This endpoint allows CORS */
|
|
@@ -2746,13 +2746,13 @@ interface paths$k {
|
|
|
2746
2746
|
trace?: never;
|
|
2747
2747
|
};
|
|
2748
2748
|
}
|
|
2749
|
-
interface components$
|
|
2749
|
+
interface components$n {
|
|
2750
2750
|
schemas: {
|
|
2751
2751
|
/** @description Public ID (used in code). Do not change after creation */
|
|
2752
2752
|
PublicIdProperty: string;
|
|
2753
2753
|
/** @description The definition of a component parameter */
|
|
2754
2754
|
ComponentDefinitionParameter: {
|
|
2755
|
-
id: components$
|
|
2755
|
+
id: components$n["schemas"]["PublicIdProperty"];
|
|
2756
2756
|
/** @description Friendly name of the parameter */
|
|
2757
2757
|
name: string;
|
|
2758
2758
|
/** @description Appears next to the parameter in the Composition editor */
|
|
@@ -2811,7 +2811,7 @@ interface components$m {
|
|
|
2811
2811
|
};
|
|
2812
2812
|
/** @description Permission set for a component definition */
|
|
2813
2813
|
ComponentDefinitionPermission: {
|
|
2814
|
-
roleId: components$
|
|
2814
|
+
roleId: components$n["schemas"]["PublicIdProperty"];
|
|
2815
2815
|
/**
|
|
2816
2816
|
* @description Permission type for this permission ComponentDefinition:
|
|
2817
2817
|
* read | write | create | delete
|
|
@@ -2843,7 +2843,7 @@ interface components$m {
|
|
|
2843
2843
|
};
|
|
2844
2844
|
/** @description Defines a content type */
|
|
2845
2845
|
ContentType: {
|
|
2846
|
-
id: components$
|
|
2846
|
+
id: components$n["schemas"]["PublicIdProperty"];
|
|
2847
2847
|
/** @description Friendly name of the content type */
|
|
2848
2848
|
name: string;
|
|
2849
2849
|
/** @description The public ID of the field whose value should be used to create a display name for entries of this content type in the UI.
|
|
@@ -2857,7 +2857,7 @@ interface components$m {
|
|
|
2857
2857
|
*/
|
|
2858
2858
|
thumbnailField?: string | null;
|
|
2859
2859
|
/** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
|
|
2860
|
-
fields?: components$
|
|
2860
|
+
fields?: components$n["schemas"]["ComponentDefinitionParameter"][];
|
|
2861
2861
|
/** @description Description of the content type */
|
|
2862
2862
|
description?: string;
|
|
2863
2863
|
/**
|
|
@@ -2869,7 +2869,7 @@ interface components$m {
|
|
|
2869
2869
|
created?: string;
|
|
2870
2870
|
/** @description Last modified date string for this content type (ignored for writes) */
|
|
2871
2871
|
updated?: string;
|
|
2872
|
-
slugSettings?: components$
|
|
2872
|
+
slugSettings?: components$n["schemas"]["ComponentDefinitionSlugSettings"];
|
|
2873
2873
|
/**
|
|
2874
2874
|
* @description The definition type of this content type (block or content type)
|
|
2875
2875
|
* @default contentType
|
|
@@ -2882,14 +2882,14 @@ interface components$m {
|
|
|
2882
2882
|
*/
|
|
2883
2883
|
useTeamPermissions?: boolean;
|
|
2884
2884
|
/** @description Custom role permissions for this content type */
|
|
2885
|
-
permissions?: components$
|
|
2885
|
+
permissions?: components$n["schemas"]["ComponentDefinitionPermission"][];
|
|
2886
2886
|
/**
|
|
2887
2887
|
* Format: uuid
|
|
2888
2888
|
* @description ID of the workflow that instances of this content type will use by default. When not set, no workflow is attached
|
|
2889
2889
|
*/
|
|
2890
2890
|
workflowId?: string;
|
|
2891
2891
|
/** @description Configurations for previewing an entry on a consuming pattern or composition. */
|
|
2892
|
-
previewConfigurations?: components$
|
|
2892
|
+
previewConfigurations?: components$n["schemas"]["ContentTypePreviewConfiguration"][];
|
|
2893
2893
|
};
|
|
2894
2894
|
Error: {
|
|
2895
2895
|
/** @description Error message(s) that occurred while processing the request */
|
|
@@ -2903,7 +2903,7 @@ interface components$m {
|
|
|
2903
2903
|
[name: string]: unknown;
|
|
2904
2904
|
};
|
|
2905
2905
|
content: {
|
|
2906
|
-
"application/json": components$
|
|
2906
|
+
"application/json": components$n["schemas"]["Error"];
|
|
2907
2907
|
};
|
|
2908
2908
|
};
|
|
2909
2909
|
/** @description API key or token was not valid */
|
|
@@ -2912,7 +2912,7 @@ interface components$m {
|
|
|
2912
2912
|
[name: string]: unknown;
|
|
2913
2913
|
};
|
|
2914
2914
|
content: {
|
|
2915
|
-
"application/json": components$
|
|
2915
|
+
"application/json": components$n["schemas"]["Error"];
|
|
2916
2916
|
};
|
|
2917
2917
|
};
|
|
2918
2918
|
/** @description Permission was denied */
|
|
@@ -2921,7 +2921,7 @@ interface components$m {
|
|
|
2921
2921
|
[name: string]: unknown;
|
|
2922
2922
|
};
|
|
2923
2923
|
content: {
|
|
2924
|
-
"application/json": components$
|
|
2924
|
+
"application/json": components$n["schemas"]["Error"];
|
|
2925
2925
|
};
|
|
2926
2926
|
};
|
|
2927
2927
|
/** @description Too many requests in allowed time period */
|
|
@@ -2945,7 +2945,7 @@ interface components$m {
|
|
|
2945
2945
|
pathItems: never;
|
|
2946
2946
|
}
|
|
2947
2947
|
|
|
2948
|
-
interface paths$
|
|
2948
|
+
interface paths$k {
|
|
2949
2949
|
"/api/v1/entries": {
|
|
2950
2950
|
parameters: {
|
|
2951
2951
|
query?: never;
|
|
@@ -2960,86 +2960,86 @@ interface paths$j {
|
|
|
2960
2960
|
* When `editions=raw`, this matches on edition IDs or entry IDs and edition resolution is disabled.
|
|
2961
2961
|
* When `versionId` is passed, this parameter is required and must contain only one entry ID.
|
|
2962
2962
|
* */
|
|
2963
|
-
entryIDs?: components$
|
|
2963
|
+
entryIDs?: components$m["parameters"]["entryIDs"];
|
|
2964
2964
|
/** @description Specify a historical entry version ID to fetch (retrieved from the entries-history API).
|
|
2965
2965
|
* Must be used with the `entryIDs` parameter, and there must be only one entryID passed
|
|
2966
2966
|
* */
|
|
2967
|
-
versionId?: components$
|
|
2967
|
+
versionId?: components$m["parameters"]["versionId"];
|
|
2968
2968
|
/** @description Specify a single entry to fetch by slug */
|
|
2969
|
-
slug?: components$
|
|
2969
|
+
slug?: components$m["parameters"]["slug"];
|
|
2970
2970
|
/** @description Filters entry lists by the user who created them. The user is specified by their identity subject
|
|
2971
2971
|
* */
|
|
2972
|
-
createdBy?: components$
|
|
2972
|
+
createdBy?: components$m["parameters"]["createdBy"];
|
|
2973
2973
|
/** @description Max number of records to return */
|
|
2974
|
-
limit?: components$
|
|
2974
|
+
limit?: components$m["parameters"]["limit"];
|
|
2975
2975
|
/** @description Number of records to skip */
|
|
2976
|
-
offset?: components$
|
|
2976
|
+
offset?: components$m["parameters"]["offset"];
|
|
2977
2977
|
/** @description Sets the sorting of the results. If unspecified, results are sorted by modification date descending.
|
|
2978
2978
|
* Allowed values are: updated_at_DESC, updated_at_ASC, created_at_DESC, created_at_ASC, name_DESC, name_ASC, slug_DESC, slug_ASC
|
|
2979
2979
|
* */
|
|
2980
|
-
orderBy?: components$
|
|
2980
|
+
orderBy?: components$m["parameters"]["orderBy"];
|
|
2981
2981
|
/**
|
|
2982
2982
|
* @deprecated
|
|
2983
2983
|
* @description Returns counts for distinct values of the specified field or fields (provided as comma-separated IDs).
|
|
2984
2984
|
*/
|
|
2985
|
-
facetBy?: components$
|
|
2985
|
+
facetBy?: components$m["parameters"]["facetBy"];
|
|
2986
2986
|
/** @description Matches entries based on whether they are pattern entries or regular entries.
|
|
2987
2987
|
* If true, only pattern entries will be returned.
|
|
2988
2988
|
* If false (default), only regular entries will be returned
|
|
2989
2989
|
* */
|
|
2990
|
-
pattern?: components$
|
|
2990
|
+
pattern?: components$m["parameters"]["pattern"];
|
|
2991
2991
|
/** @description The project the entry/entries are on */
|
|
2992
|
-
projectId: components$
|
|
2992
|
+
projectId: components$m["parameters"]["projectId"];
|
|
2993
2993
|
/** @description Publishing state to fetch. 0 = draft, 64 = published */
|
|
2994
|
-
state?: components$
|
|
2994
|
+
state?: components$m["parameters"]["state"];
|
|
2995
2995
|
/** @description The content type ID to filter by */
|
|
2996
|
-
type?: components$
|
|
2996
|
+
type?: components$m["parameters"]["type"];
|
|
2997
2997
|
/**
|
|
2998
2998
|
* @deprecated
|
|
2999
2999
|
* @description Filters entries lists by the UI status of the entry.
|
|
3000
3000
|
* This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data
|
|
3001
3001
|
*
|
|
3002
3002
|
*/
|
|
3003
|
-
uiStatus?: components$
|
|
3003
|
+
uiStatus?: components$m["parameters"]["uiStatus"];
|
|
3004
3004
|
/** @description Filters entry lists by the user who last updated them. The user is specified by their identity subject
|
|
3005
3005
|
* */
|
|
3006
|
-
updatedBy?: components$
|
|
3006
|
+
updatedBy?: components$m["parameters"]["updatedBy"];
|
|
3007
3007
|
/** @description Controls whether the total count of results will be returned along with the current results page in a list.
|
|
3008
3008
|
* Has no effect when not fetching a list. This does impact performance when enabled
|
|
3009
3009
|
* */
|
|
3010
|
-
withTotalCount?: components$
|
|
3010
|
+
withTotalCount?: components$m["parameters"]["withTotalCount"];
|
|
3011
3011
|
/**
|
|
3012
3012
|
* @deprecated
|
|
3013
3013
|
* @description Returns the UI status string of the entry.
|
|
3014
3014
|
* This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data
|
|
3015
3015
|
*
|
|
3016
3016
|
*/
|
|
3017
|
-
withUIStatus?: components$
|
|
3017
|
+
withUIStatus?: components$m["parameters"]["withUIStatus"];
|
|
3018
3018
|
/** @description Returns the definition of any attached workflow along with the entry data
|
|
3019
3019
|
* */
|
|
3020
|
-
withWorkflowDefinition?: components$
|
|
3020
|
+
withWorkflowDefinition?: components$m["parameters"]["withWorkflowDefinition"];
|
|
3021
3021
|
/** @description If true the `_id` unique identifier of blocks will be part of the response data.
|
|
3022
3022
|
* If false, the `_id` will not be present in the API response
|
|
3023
3023
|
* */
|
|
3024
|
-
withComponentIDs?: components$
|
|
3024
|
+
withComponentIDs?: components$m["parameters"]["withComponentIDs"];
|
|
3025
3025
|
/** @description Performs keyword search on the entries */
|
|
3026
|
-
keyword?: components$
|
|
3026
|
+
keyword?: components$m["parameters"]["keyword"];
|
|
3027
3027
|
/** @description If true, any pattern references in the composition will be left unresolved.
|
|
3028
3028
|
* This is appropriate if you intend to serialize the composition without patterns
|
|
3029
3029
|
* embedded into it, and serialize the pattern data separately
|
|
3030
3030
|
* */
|
|
3031
|
-
skipPatternResolution?: components$
|
|
3031
|
+
skipPatternResolution?: components$m["parameters"]["skipPatternResolution"];
|
|
3032
3032
|
/**
|
|
3033
3033
|
* @deprecated
|
|
3034
3034
|
* @description This parameter is unused and has no effect. Passing this parameter will become an error in the future
|
|
3035
3035
|
*
|
|
3036
3036
|
*/
|
|
3037
|
-
skipParameterResolution?: components$
|
|
3037
|
+
skipParameterResolution?: components$m["parameters"]["skipParameterResolution"];
|
|
3038
3038
|
/** @description If true, any pattern override data is not resolved by the API.
|
|
3039
3039
|
* This is intended for internal use in the Canvas editor, and should not be used.
|
|
3040
3040
|
* Passing this parameter automatically implies withComponentIDs to be true
|
|
3041
3041
|
* */
|
|
3042
|
-
skipOverridesResolution?: components$
|
|
3042
|
+
skipOverridesResolution?: components$m["parameters"]["skipOverridesResolution"];
|
|
3043
3043
|
/** @description One or more locales to filter and localize by.
|
|
3044
3044
|
* Only entries that enable one of the specified locales _or enable no locales_ will be returned.
|
|
3045
3045
|
* The response will be localized to include only the first matching locale's data.
|
|
@@ -3051,7 +3051,7 @@ interface paths$j {
|
|
|
3051
3051
|
*
|
|
3052
3052
|
* When this parameter is not passed, all locales' data will be returned
|
|
3053
3053
|
* */
|
|
3054
|
-
locale?: components$
|
|
3054
|
+
locale?: components$m["parameters"]["locale"];
|
|
3055
3055
|
/** @description The ID of a release to fetch the content for.
|
|
3056
3056
|
*
|
|
3057
3057
|
* - When unspecified, all release content is excluded from the result(s).
|
|
@@ -3059,12 +3059,12 @@ interface paths$j {
|
|
|
3059
3059
|
*
|
|
3060
3060
|
* 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
|
|
3061
3061
|
* */
|
|
3062
|
-
releaseId?: components$
|
|
3062
|
+
releaseId?: components$m["parameters"]["releaseId"];
|
|
3063
3063
|
/** @description Search on textual fields of an entry.
|
|
3064
3064
|
* Note: for long text fields the tail of the text is not guaranteed to be searchable.
|
|
3065
3065
|
* Example: ?search=hello
|
|
3066
3066
|
* */
|
|
3067
|
-
search?: components$
|
|
3067
|
+
search?: components$m["parameters"]["search"];
|
|
3068
3068
|
/** @description Controls the edition resolution behavior.
|
|
3069
3069
|
*
|
|
3070
3070
|
* auto: (default) Editions are evaluated automatically and the best matching edition is returned.
|
|
@@ -3077,7 +3077,7 @@ interface paths$j {
|
|
|
3077
3077
|
* entryIDs MUST be provided with this option.
|
|
3078
3078
|
* If versionId is passed, this is always enabled.
|
|
3079
3079
|
* */
|
|
3080
|
-
editions?: components$
|
|
3080
|
+
editions?: components$m["parameters"]["editions"];
|
|
3081
3081
|
};
|
|
3082
3082
|
header?: never;
|
|
3083
3083
|
path?: never;
|
|
@@ -3091,12 +3091,12 @@ interface paths$j {
|
|
|
3091
3091
|
[name: string]: unknown;
|
|
3092
3092
|
};
|
|
3093
3093
|
content: {
|
|
3094
|
-
"application/json": components$
|
|
3094
|
+
"application/json": components$m["schemas"]["EntryListResponse"];
|
|
3095
3095
|
};
|
|
3096
3096
|
};
|
|
3097
|
-
400: components$
|
|
3098
|
-
401: components$
|
|
3099
|
-
403: components$
|
|
3097
|
+
400: components$m["responses"]["BadRequestError"];
|
|
3098
|
+
401: components$m["responses"]["UnauthorizedError"];
|
|
3099
|
+
403: components$m["responses"]["ForbiddenError"];
|
|
3100
3100
|
/** @description Entry not found */
|
|
3101
3101
|
404: {
|
|
3102
3102
|
headers: {
|
|
@@ -3106,8 +3106,8 @@ interface paths$j {
|
|
|
3106
3106
|
"text/plain": string;
|
|
3107
3107
|
};
|
|
3108
3108
|
};
|
|
3109
|
-
429: components$
|
|
3110
|
-
500: components$
|
|
3109
|
+
429: components$m["responses"]["RateLimitError"];
|
|
3110
|
+
500: components$m["responses"]["InternalServerError"];
|
|
3111
3111
|
};
|
|
3112
3112
|
};
|
|
3113
3113
|
/** @description Upserts an entry */
|
|
@@ -3134,7 +3134,7 @@ interface paths$j {
|
|
|
3134
3134
|
projectId: string;
|
|
3135
3135
|
/** @description The publishing state to upsert into. 0 = draft, 64 = published */
|
|
3136
3136
|
state: number;
|
|
3137
|
-
entry: components$
|
|
3137
|
+
entry: components$m["schemas"]["EntryInput"];
|
|
3138
3138
|
/** @description Ignored if present */
|
|
3139
3139
|
created?: string;
|
|
3140
3140
|
/** @description Ignored if present */
|
|
@@ -3184,9 +3184,9 @@ interface paths$j {
|
|
|
3184
3184
|
};
|
|
3185
3185
|
content?: never;
|
|
3186
3186
|
};
|
|
3187
|
-
400: components$
|
|
3188
|
-
401: components$
|
|
3189
|
-
403: components$
|
|
3187
|
+
400: components$m["responses"]["BadRequestError"];
|
|
3188
|
+
401: components$m["responses"]["UnauthorizedError"];
|
|
3189
|
+
403: components$m["responses"]["ForbiddenError"];
|
|
3190
3190
|
/** @description Conflict - Entry has been changed since being loaded */
|
|
3191
3191
|
409: {
|
|
3192
3192
|
headers: {
|
|
@@ -3196,8 +3196,8 @@ interface paths$j {
|
|
|
3196
3196
|
"text/plain": string;
|
|
3197
3197
|
};
|
|
3198
3198
|
};
|
|
3199
|
-
429: components$
|
|
3200
|
-
500: components$
|
|
3199
|
+
429: components$m["responses"]["RateLimitError"];
|
|
3200
|
+
500: components$m["responses"]["InternalServerError"];
|
|
3201
3201
|
};
|
|
3202
3202
|
};
|
|
3203
3203
|
post?: never;
|
|
@@ -3253,11 +3253,11 @@ interface paths$j {
|
|
|
3253
3253
|
};
|
|
3254
3254
|
content?: never;
|
|
3255
3255
|
};
|
|
3256
|
-
400: components$
|
|
3257
|
-
401: components$
|
|
3258
|
-
403: components$
|
|
3259
|
-
429: components$
|
|
3260
|
-
500: components$
|
|
3256
|
+
400: components$m["responses"]["BadRequestError"];
|
|
3257
|
+
401: components$m["responses"]["UnauthorizedError"];
|
|
3258
|
+
403: components$m["responses"]["ForbiddenError"];
|
|
3259
|
+
429: components$m["responses"]["RateLimitError"];
|
|
3260
|
+
500: components$m["responses"]["InternalServerError"];
|
|
3261
3261
|
};
|
|
3262
3262
|
};
|
|
3263
3263
|
/** @description Handles preflight requests. This endpoint allows CORS */
|
|
@@ -3284,7 +3284,7 @@ interface paths$j {
|
|
|
3284
3284
|
trace?: never;
|
|
3285
3285
|
};
|
|
3286
3286
|
}
|
|
3287
|
-
interface components$
|
|
3287
|
+
interface components$m {
|
|
3288
3288
|
schemas: {
|
|
3289
3289
|
/** @description Defines a connection to a dynamic token on a data resource
|
|
3290
3290
|
* */
|
|
@@ -3351,12 +3351,12 @@ interface components$l {
|
|
|
3351
3351
|
* @enum {string}
|
|
3352
3352
|
*/
|
|
3353
3353
|
op?: "&" | "|";
|
|
3354
|
-
clauses: (components$
|
|
3354
|
+
clauses: (components$m["schemas"]["VisibilityCriteria"] | components$m["schemas"]["VisibilityCriteriaGroup"])[];
|
|
3355
3355
|
};
|
|
3356
3356
|
/** @description Defines a conditional value for a component parameter
|
|
3357
3357
|
* */
|
|
3358
3358
|
ComponentParameterConditionalValue: {
|
|
3359
|
-
when: components$
|
|
3359
|
+
when: components$m["schemas"]["VisibilityCriteriaGroup"];
|
|
3360
3360
|
/** @description The value of the parameter. Any JSON-serializable value is acceptable.
|
|
3361
3361
|
* A value of `null` will cause the parameter value to be removed, if it matches.
|
|
3362
3362
|
* */
|
|
@@ -3375,7 +3375,7 @@ interface components$l {
|
|
|
3375
3375
|
*
|
|
3376
3376
|
* When no locale is passed to a non-route API, conditions are not processed and all conditions are returned.
|
|
3377
3377
|
* */
|
|
3378
|
-
ComponentParameterConditions: components$
|
|
3378
|
+
ComponentParameterConditions: components$m["schemas"]["ComponentParameterConditionalValue"][];
|
|
3379
3379
|
/** @description Defines an editable parameter on a component */
|
|
3380
3380
|
ComponentParameter: {
|
|
3381
3381
|
/** @description The value of the parameter. Any JSON-serializable value is acceptable */
|
|
@@ -3383,18 +3383,18 @@ interface components$l {
|
|
|
3383
3383
|
/** @description The type of the parameter. Determines how it is displayed when editing and tells the consumer how to process it */
|
|
3384
3384
|
type: string;
|
|
3385
3385
|
/** @deprecated */
|
|
3386
|
-
connectedData?: components$
|
|
3386
|
+
connectedData?: components$m["schemas"]["DataElementConnectionDefinition"];
|
|
3387
3387
|
/** @description Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
|
|
3388
3388
|
* Note that locales must be registered on the entry/composition `_locales` before being used
|
|
3389
3389
|
* */
|
|
3390
3390
|
locales?: {
|
|
3391
3391
|
[key: string]: unknown;
|
|
3392
3392
|
};
|
|
3393
|
-
conditions?: components$
|
|
3393
|
+
conditions?: components$m["schemas"]["ComponentParameterConditions"];
|
|
3394
3394
|
/** @description Locale-specific conditional values for this parameter. Keys are locale codes, and values are the `conditions` for that locale.
|
|
3395
3395
|
* */
|
|
3396
3396
|
localesConditions?: {
|
|
3397
|
-
[key: string]: components$
|
|
3397
|
+
[key: string]: components$m["schemas"]["ComponentParameterConditions"];
|
|
3398
3398
|
};
|
|
3399
3399
|
};
|
|
3400
3400
|
/** @description Variable values for a data resource */
|
|
@@ -3416,13 +3416,13 @@ interface components$l {
|
|
|
3416
3416
|
* If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
|
|
3417
3417
|
* */
|
|
3418
3418
|
optionalPatternParameter?: boolean;
|
|
3419
|
-
variables?: components$
|
|
3419
|
+
variables?: components$m["schemas"]["DataResourceVariables"];
|
|
3420
3420
|
};
|
|
3421
3421
|
/** @description Data definitions attached to this component. The property name is the key of the data in the data document.
|
|
3422
3422
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key)
|
|
3423
3423
|
* */
|
|
3424
3424
|
DataResourceDefinitions: {
|
|
3425
|
-
[key: string]: components$
|
|
3425
|
+
[key: string]: components$m["schemas"]["DataResourceDefinition"];
|
|
3426
3426
|
};
|
|
3427
3427
|
/** @description Defines the shape of a component instance served by the composition API */
|
|
3428
3428
|
ComponentInstance: {
|
|
@@ -3430,13 +3430,13 @@ interface components$l {
|
|
|
3430
3430
|
type: string;
|
|
3431
3431
|
/** @description Component parameter values for the component instance */
|
|
3432
3432
|
parameters?: {
|
|
3433
|
-
[key: string]: components$
|
|
3433
|
+
[key: string]: components$m["schemas"]["ComponentParameter"];
|
|
3434
3434
|
};
|
|
3435
3435
|
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
|
3436
3436
|
variant?: string;
|
|
3437
3437
|
/** @description Slots containing any child components */
|
|
3438
3438
|
slots?: {
|
|
3439
|
-
[key: string]: components$
|
|
3439
|
+
[key: string]: components$m["schemas"]["ComponentInstance"][];
|
|
3440
3440
|
};
|
|
3441
3441
|
/** @description Unique identifier of the component within the composition.
|
|
3442
3442
|
* No assumptions should be made about the format of this value other than "it will be unique."
|
|
@@ -3446,14 +3446,14 @@ interface components$l {
|
|
|
3446
3446
|
_id?: string;
|
|
3447
3447
|
/** @description Indicates this component instance should be sourced from a pattern library pattern */
|
|
3448
3448
|
_pattern?: string;
|
|
3449
|
-
_dataResources?: components$
|
|
3449
|
+
_dataResources?: components$m["schemas"]["DataResourceDefinitions"];
|
|
3450
3450
|
/** @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
|
3451
3451
|
* Means nothing for PUTs; it will be ignored
|
|
3452
3452
|
* */
|
|
3453
3453
|
_patternDataResources?: {
|
|
3454
|
-
[key: string]: components$
|
|
3454
|
+
[key: string]: components$m["schemas"]["DataResourceDefinition"];
|
|
3455
3455
|
};
|
|
3456
|
-
_patternError?: components$
|
|
3456
|
+
_patternError?: components$m["schemas"]["PatternError"];
|
|
3457
3457
|
/** @description Defines patch overrides to component IDs that live in the composition.
|
|
3458
3458
|
* This can be used to override parameters that are defined on patterns,
|
|
3459
3459
|
* including nested patterns, with values that are specific to this composition.
|
|
@@ -3466,13 +3466,13 @@ interface components$l {
|
|
|
3466
3466
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
3467
3467
|
* */
|
|
3468
3468
|
_overrides?: {
|
|
3469
|
-
[key: string]: components$
|
|
3469
|
+
[key: string]: components$m["schemas"]["ComponentOverride"];
|
|
3470
3470
|
};
|
|
3471
3471
|
/** @description Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
|
|
3472
3472
|
* Means nothing for PUTs; it will be ignored
|
|
3473
3473
|
* */
|
|
3474
3474
|
_patternOverrides?: {
|
|
3475
|
-
[key: string]: components$
|
|
3475
|
+
[key: string]: components$m["schemas"]["ComponentOverride"];
|
|
3476
3476
|
};
|
|
3477
3477
|
/** @description When used on a pattern, defines how the pattern's parameters may be overridden
|
|
3478
3478
|
* by consumers of the pattern.
|
|
@@ -3480,7 +3480,7 @@ interface components$l {
|
|
|
3480
3480
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
3481
3481
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
3482
3482
|
* */
|
|
3483
|
-
_overridability?: components$
|
|
3483
|
+
_overridability?: components$m["schemas"]["ComponentOverridability"];
|
|
3484
3484
|
/** @description Array of locales that have data defined. Only set for pattern references or composition defaults */
|
|
3485
3485
|
_locales?: string[];
|
|
3486
3486
|
};
|
|
@@ -3500,10 +3500,10 @@ interface components$l {
|
|
|
3500
3500
|
* */
|
|
3501
3501
|
ComponentOverride: {
|
|
3502
3502
|
parameters?: {
|
|
3503
|
-
[key: string]: components$
|
|
3503
|
+
[key: string]: components$m["schemas"]["ComponentParameter"];
|
|
3504
3504
|
};
|
|
3505
3505
|
slots?: {
|
|
3506
|
-
[key: string]: components$
|
|
3506
|
+
[key: string]: components$m["schemas"]["ComponentInstance"][];
|
|
3507
3507
|
};
|
|
3508
3508
|
variant?: string;
|
|
3509
3509
|
/** @description Overrides data resource definitions for a pattern component.
|
|
@@ -3511,7 +3511,7 @@ interface components$l {
|
|
|
3511
3511
|
* Overrides defined here replace values in either _dataResources or _patternDataResources on the target component.
|
|
3512
3512
|
* */
|
|
3513
3513
|
dataResources?: {
|
|
3514
|
-
[key: string]: components$
|
|
3514
|
+
[key: string]: components$m["schemas"]["DataResourceDefinition"];
|
|
3515
3515
|
};
|
|
3516
3516
|
};
|
|
3517
3517
|
/**
|
|
@@ -3532,7 +3532,7 @@ interface components$l {
|
|
|
3532
3532
|
ComponentOverridability: {
|
|
3533
3533
|
/** @description Defines component parameter value overrides. Keys are the parameter public ID */
|
|
3534
3534
|
parameters?: {
|
|
3535
|
-
[key: string]: components$
|
|
3535
|
+
[key: string]: components$m["schemas"]["OverrideOptions"];
|
|
3536
3536
|
};
|
|
3537
3537
|
/** @description Allows overriding a display variant is allowed if it is defined on the component the pattern is derived from. Default = false */
|
|
3538
3538
|
variants?: boolean;
|
|
@@ -3571,14 +3571,14 @@ interface components$l {
|
|
|
3571
3571
|
_locales?: string[];
|
|
3572
3572
|
/** @description Entry field values */
|
|
3573
3573
|
fields?: {
|
|
3574
|
-
[key: string]: components$
|
|
3574
|
+
[key: string]: components$m["schemas"]["ComponentParameter"];
|
|
3575
3575
|
};
|
|
3576
|
-
_dataResources?: components$
|
|
3576
|
+
_dataResources?: components$m["schemas"]["DataResourceDefinitions"];
|
|
3577
3577
|
/** @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
|
3578
3578
|
* Means nothing for PUTs; it will be ignored
|
|
3579
3579
|
* */
|
|
3580
3580
|
_patternDataResources?: {
|
|
3581
|
-
[key: string]: components$
|
|
3581
|
+
[key: string]: components$m["schemas"]["DataResourceDefinition"];
|
|
3582
3582
|
};
|
|
3583
3583
|
/**
|
|
3584
3584
|
* @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
|
@@ -3601,7 +3601,7 @@ interface components$l {
|
|
|
3601
3601
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
3602
3602
|
* */
|
|
3603
3603
|
_overrides?: {
|
|
3604
|
-
[key: string]: components$
|
|
3604
|
+
[key: string]: components$m["schemas"]["ComponentOverride"];
|
|
3605
3605
|
};
|
|
3606
3606
|
/** @description When used on a pattern, defines how the pattern's parameters may be overridden
|
|
3607
3607
|
* by consumers of the pattern.
|
|
@@ -3609,7 +3609,7 @@ interface components$l {
|
|
|
3609
3609
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
3610
3610
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
3611
3611
|
* */
|
|
3612
|
-
_overridability?: components$
|
|
3612
|
+
_overridability?: components$m["schemas"]["ComponentOverridability"];
|
|
3613
3613
|
};
|
|
3614
3614
|
/** @description Permissions for a workflow stage */
|
|
3615
3615
|
WorkflowStagePermission: {
|
|
@@ -3638,7 +3638,7 @@ interface components$l {
|
|
|
3638
3638
|
* NOTE: Users without membership in any role listed here will be unable to execute the transition unless they are team admins
|
|
3639
3639
|
* */
|
|
3640
3640
|
permissions: {
|
|
3641
|
-
[key: string]: components$
|
|
3641
|
+
[key: string]: components$m["schemas"]["WorkflowStageTransitionPermission"];
|
|
3642
3642
|
};
|
|
3643
3643
|
};
|
|
3644
3644
|
/** @description Definition of a stage in a workflow */
|
|
@@ -3651,7 +3651,7 @@ interface components$l {
|
|
|
3651
3651
|
* listed here, the stage is read-only and publishing is disabled
|
|
3652
3652
|
* */
|
|
3653
3653
|
permissions: {
|
|
3654
|
-
[key: string]: components$
|
|
3654
|
+
[key: string]: components$m["schemas"]["WorkflowStagePermission"];
|
|
3655
3655
|
};
|
|
3656
3656
|
/** @description When true, transitioning into this stage from a different stage will automatically publish the entity.
|
|
3657
3657
|
* If the user making the transition does not have publish permissions to the stage as well as publish permission on the entity, the action will not run.
|
|
@@ -3668,7 +3668,7 @@ interface components$l {
|
|
|
3668
3668
|
* Every stage must define at least one transition, to avoid creating a workflow that
|
|
3669
3669
|
* has a stage that can never be escaped
|
|
3670
3670
|
* */
|
|
3671
|
-
transitions: components$
|
|
3671
|
+
transitions: components$m["schemas"]["WorkflowStageTransition"][];
|
|
3672
3672
|
/**
|
|
3673
3673
|
* @description Icon name for the stage (e.g. 'chevron-double-right-o')
|
|
3674
3674
|
* @default chevron-double-right-o
|
|
@@ -3693,7 +3693,7 @@ interface components$l {
|
|
|
3693
3693
|
initialStage: string;
|
|
3694
3694
|
/** @description All stages of the workflow */
|
|
3695
3695
|
stages: {
|
|
3696
|
-
[key: string]: components$
|
|
3696
|
+
[key: string]: components$m["schemas"]["WorkflowStage"];
|
|
3697
3697
|
};
|
|
3698
3698
|
/** @description Last modified ISO date string for this definition (ignored for writes) */
|
|
3699
3699
|
modified?: string;
|
|
@@ -3744,7 +3744,7 @@ interface components$l {
|
|
|
3744
3744
|
* @default false
|
|
3745
3745
|
*/
|
|
3746
3746
|
pattern?: boolean;
|
|
3747
|
-
entry: components$
|
|
3747
|
+
entry: components$m["schemas"]["Entry"];
|
|
3748
3748
|
/**
|
|
3749
3749
|
* Format: uuid
|
|
3750
3750
|
* @description The workflow ID that this entry is assigned. Normally comes from the content type
|
|
@@ -3756,7 +3756,7 @@ interface components$l {
|
|
|
3756
3756
|
*/
|
|
3757
3757
|
workflowStageId?: string;
|
|
3758
3758
|
/** @description The full definition of the assigned workflow, if any, including stages, permissions, etc. Only returned when `withWorkflowDefinition` is true */
|
|
3759
|
-
workflowDefinition?: components$
|
|
3759
|
+
workflowDefinition?: components$m["schemas"]["WorkflowDefinition"];
|
|
3760
3760
|
/**
|
|
3761
3761
|
* @description Only present if an incomplete entry is returned; indicates reason for stubbing
|
|
3762
3762
|
* @enum {string}
|
|
@@ -3778,7 +3778,7 @@ interface components$l {
|
|
|
3778
3778
|
editionPriority?: number;
|
|
3779
3779
|
};
|
|
3780
3780
|
EntryListResponse: {
|
|
3781
|
-
entries: components$
|
|
3781
|
+
entries: components$m["schemas"]["EntryApiResponse"][];
|
|
3782
3782
|
/** @description Total number of entries that match the query. Only present when `withTotalCount` option is true */
|
|
3783
3783
|
totalCount?: number;
|
|
3784
3784
|
/** @description Per-field counts for distinct values */
|
|
@@ -3817,16 +3817,16 @@ interface components$l {
|
|
|
3817
3817
|
_creatorSubject?: string;
|
|
3818
3818
|
/** @description Entry field values */
|
|
3819
3819
|
fields?: {
|
|
3820
|
-
[key: string]: components$
|
|
3820
|
+
[key: string]: components$m["schemas"]["ComponentParameter"];
|
|
3821
3821
|
};
|
|
3822
|
-
_dataResources?: components$
|
|
3822
|
+
_dataResources?: components$m["schemas"]["DataResourceDefinitions"];
|
|
3823
3823
|
/** @description Indicates this content entry should be sourced from a pattern library pattern */
|
|
3824
3824
|
_pattern?: string;
|
|
3825
3825
|
/** @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
|
3826
3826
|
* Means nothing for PUTs; it will be ignored
|
|
3827
3827
|
* */
|
|
3828
3828
|
_patternDataResources?: {
|
|
3829
|
-
[key: string]: components$
|
|
3829
|
+
[key: string]: components$m["schemas"]["DataResourceDefinition"];
|
|
3830
3830
|
};
|
|
3831
3831
|
/**
|
|
3832
3832
|
* @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
|
@@ -3844,7 +3844,7 @@ interface components$l {
|
|
|
3844
3844
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
3845
3845
|
* */
|
|
3846
3846
|
_overrides?: {
|
|
3847
|
-
[key: string]: components$
|
|
3847
|
+
[key: string]: components$m["schemas"]["ComponentOverride"];
|
|
3848
3848
|
};
|
|
3849
3849
|
/** @description When used on a pattern, defines how the pattern's fields may be overridden
|
|
3850
3850
|
* by consumers of the pattern.
|
|
@@ -3852,7 +3852,7 @@ interface components$l {
|
|
|
3852
3852
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
3853
3853
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
3854
3854
|
* */
|
|
3855
|
-
_overridability?: components$
|
|
3855
|
+
_overridability?: components$m["schemas"]["ComponentOverridability"];
|
|
3856
3856
|
/** @description Array of locales which have data defined on the entry. If empty, the current default locale implicitly has data */
|
|
3857
3857
|
_locales?: string[];
|
|
3858
3858
|
};
|
|
@@ -3864,7 +3864,7 @@ interface components$l {
|
|
|
3864
3864
|
[name: string]: unknown;
|
|
3865
3865
|
};
|
|
3866
3866
|
content: {
|
|
3867
|
-
"application/json": components$
|
|
3867
|
+
"application/json": components$m["schemas"]["Error"];
|
|
3868
3868
|
};
|
|
3869
3869
|
};
|
|
3870
3870
|
/** @description API key or token was not valid */
|
|
@@ -3873,7 +3873,7 @@ interface components$l {
|
|
|
3873
3873
|
[name: string]: unknown;
|
|
3874
3874
|
};
|
|
3875
3875
|
content: {
|
|
3876
|
-
"application/json": components$
|
|
3876
|
+
"application/json": components$m["schemas"]["Error"];
|
|
3877
3877
|
};
|
|
3878
3878
|
};
|
|
3879
3879
|
/** @description Permission was denied */
|
|
@@ -3882,7 +3882,7 @@ interface components$l {
|
|
|
3882
3882
|
[name: string]: unknown;
|
|
3883
3883
|
};
|
|
3884
3884
|
content: {
|
|
3885
|
-
"application/json": components$
|
|
3885
|
+
"application/json": components$m["schemas"]["Error"];
|
|
3886
3886
|
};
|
|
3887
3887
|
};
|
|
3888
3888
|
/** @description Too many requests in allowed time period */
|
|
@@ -4029,7 +4029,7 @@ interface components$l {
|
|
|
4029
4029
|
pathItems: never;
|
|
4030
4030
|
}
|
|
4031
4031
|
|
|
4032
|
-
interface paths$
|
|
4032
|
+
interface paths$j {
|
|
4033
4033
|
"/api/v1/entries-history": {
|
|
4034
4034
|
parameters: {
|
|
4035
4035
|
query?: never;
|
|
@@ -4067,12 +4067,12 @@ interface paths$i {
|
|
|
4067
4067
|
[name: string]: unknown;
|
|
4068
4068
|
};
|
|
4069
4069
|
content: {
|
|
4070
|
-
"application/json": components$
|
|
4070
|
+
"application/json": components$l["schemas"]["HistoryApiResponse"];
|
|
4071
4071
|
};
|
|
4072
4072
|
};
|
|
4073
|
-
400: components$
|
|
4074
|
-
401: components$
|
|
4075
|
-
403: components$
|
|
4073
|
+
400: components$l["responses"]["BadRequestError"];
|
|
4074
|
+
401: components$l["responses"]["UnauthorizedError"];
|
|
4075
|
+
403: components$l["responses"]["ForbiddenError"];
|
|
4076
4076
|
/** @description Entry not found */
|
|
4077
4077
|
404: {
|
|
4078
4078
|
headers: {
|
|
@@ -4082,8 +4082,8 @@ interface paths$i {
|
|
|
4082
4082
|
"text/plain": string;
|
|
4083
4083
|
};
|
|
4084
4084
|
};
|
|
4085
|
-
429: components$
|
|
4086
|
-
500: components$
|
|
4085
|
+
429: components$l["responses"]["RateLimitError"];
|
|
4086
|
+
500: components$l["responses"]["InternalServerError"];
|
|
4087
4087
|
};
|
|
4088
4088
|
};
|
|
4089
4089
|
put?: never;
|
|
@@ -4095,7 +4095,7 @@ interface paths$i {
|
|
|
4095
4095
|
trace?: never;
|
|
4096
4096
|
};
|
|
4097
4097
|
}
|
|
4098
|
-
interface components$
|
|
4098
|
+
interface components$l {
|
|
4099
4099
|
schemas: {
|
|
4100
4100
|
HistoryEntry: {
|
|
4101
4101
|
/** @description The version ID of the entity. This can be used to fetch the version's data via the entity API */
|
|
@@ -4116,7 +4116,7 @@ interface components$k {
|
|
|
4116
4116
|
/** @description If more history is available than your plan allows, and additional entries are available by upgrading, this will be true */
|
|
4117
4117
|
truncated?: boolean;
|
|
4118
4118
|
/** @description Version history entries */
|
|
4119
|
-
results?: components$
|
|
4119
|
+
results?: components$l["schemas"]["HistoryEntry"][];
|
|
4120
4120
|
};
|
|
4121
4121
|
Error: {
|
|
4122
4122
|
/** @description Error message(s) that occurred while processing the request */
|
|
@@ -4130,7 +4130,7 @@ interface components$k {
|
|
|
4130
4130
|
[name: string]: unknown;
|
|
4131
4131
|
};
|
|
4132
4132
|
content: {
|
|
4133
|
-
"application/json": components$
|
|
4133
|
+
"application/json": components$l["schemas"]["Error"];
|
|
4134
4134
|
};
|
|
4135
4135
|
};
|
|
4136
4136
|
/** @description API key or token was not valid */
|
|
@@ -4139,7 +4139,7 @@ interface components$k {
|
|
|
4139
4139
|
[name: string]: unknown;
|
|
4140
4140
|
};
|
|
4141
4141
|
content: {
|
|
4142
|
-
"application/json": components$
|
|
4142
|
+
"application/json": components$l["schemas"]["Error"];
|
|
4143
4143
|
};
|
|
4144
4144
|
};
|
|
4145
4145
|
/** @description Permission was denied */
|
|
@@ -4148,7 +4148,7 @@ interface components$k {
|
|
|
4148
4148
|
[name: string]: unknown;
|
|
4149
4149
|
};
|
|
4150
4150
|
content: {
|
|
4151
|
-
"application/json": components$
|
|
4151
|
+
"application/json": components$l["schemas"]["Error"];
|
|
4152
4152
|
};
|
|
4153
4153
|
};
|
|
4154
4154
|
/** @description Too many requests in allowed time period */
|
|
@@ -4172,27 +4172,27 @@ interface components$k {
|
|
|
4172
4172
|
pathItems: never;
|
|
4173
4173
|
}
|
|
4174
4174
|
|
|
4175
|
-
type HistoryApi$1 = paths$
|
|
4176
|
-
type ContentType = components$
|
|
4177
|
-
type ContentTypePreviewConfiguration = components$
|
|
4175
|
+
type HistoryApi$1 = paths$j['/api/v1/entries-history'];
|
|
4176
|
+
type ContentType = components$q['schemas']['ContentType'];
|
|
4177
|
+
type ContentTypePreviewConfiguration = components$q['schemas']['ContentTypePreviewConfiguration'];
|
|
4178
4178
|
type ContentTypeField = Exclude<ContentType['fields'], undefined>[number];
|
|
4179
|
-
type GetContentTypesOptions = paths$
|
|
4180
|
-
type DeleteContentTypeOptions = paths$
|
|
4181
|
-
type PutContentTypeBody = paths$
|
|
4182
|
-
type GetContentTypesResponse = paths$
|
|
4183
|
-
type Entry = components$
|
|
4184
|
-
type EntryList = components$
|
|
4179
|
+
type GetContentTypesOptions = paths$l['/api/v1/content-types']['get']['parameters']['query'];
|
|
4180
|
+
type DeleteContentTypeOptions = paths$l['/api/v1/content-types']['delete']['requestBody']['content']['application/json'];
|
|
4181
|
+
type PutContentTypeBody = paths$l['/api/v1/content-types']['put']['requestBody']['content']['application/json'];
|
|
4182
|
+
type GetContentTypesResponse = paths$l['/api/v1/content-types']['get']['responses']['200']['content']['application/json'];
|
|
4183
|
+
type Entry = components$o['schemas']['EntryApiResponse'];
|
|
4184
|
+
type EntryList = components$o['schemas']['EntryListResponse'];
|
|
4185
4185
|
type EntryData = Entry['entry'];
|
|
4186
|
-
type GetEntriesOptions = paths$
|
|
4187
|
-
type GetEntriesResponse = paths$
|
|
4188
|
-
type DeleteEntryOptions = paths$
|
|
4189
|
-
type PutEntryBody = paths$
|
|
4186
|
+
type GetEntriesOptions = paths$k['/api/v1/entries']['get']['parameters']['query'];
|
|
4187
|
+
type GetEntriesResponse = paths$k['/api/v1/entries']['get']['responses']['200']['content']['application/json'];
|
|
4188
|
+
type DeleteEntryOptions = paths$k['/api/v1/entries']['delete']['requestBody']['content']['application/json'];
|
|
4189
|
+
type PutEntryBody = paths$k['/api/v1/entries']['put']['requestBody']['content']['application/json'];
|
|
4190
4190
|
/** The GET response from /api/v1/entries-history (history for one entry) */
|
|
4191
4191
|
type EntriesHistoryGetParameters = HistoryApi$1['get']['parameters']['query'];
|
|
4192
4192
|
/** The GET response from /api/v1/entries-history */
|
|
4193
|
-
type EntriesHistoryGetResponse = components$
|
|
4193
|
+
type EntriesHistoryGetResponse = components$q['schemas']['HistoryApiResponse'];
|
|
4194
4194
|
|
|
4195
|
-
interface paths$
|
|
4195
|
+
interface paths$i {
|
|
4196
4196
|
"/api/v1/data-source": {
|
|
4197
4197
|
parameters: {
|
|
4198
4198
|
query?: never;
|
|
@@ -4219,15 +4219,15 @@ interface paths$h {
|
|
|
4219
4219
|
};
|
|
4220
4220
|
content: {
|
|
4221
4221
|
"application/json": {
|
|
4222
|
-
result: components$
|
|
4222
|
+
result: components$k["schemas"]["DataSource"];
|
|
4223
4223
|
};
|
|
4224
4224
|
};
|
|
4225
4225
|
};
|
|
4226
|
-
400: components$
|
|
4227
|
-
401: components$
|
|
4228
|
-
403: components$
|
|
4229
|
-
429: components$
|
|
4230
|
-
500: components$
|
|
4226
|
+
400: components$k["responses"]["BadRequestError"];
|
|
4227
|
+
401: components$k["responses"]["UnauthorizedError"];
|
|
4228
|
+
403: components$k["responses"]["ForbiddenError"];
|
|
4229
|
+
429: components$k["responses"]["RateLimitError"];
|
|
4230
|
+
500: components$k["responses"]["InternalServerError"];
|
|
4231
4231
|
};
|
|
4232
4232
|
};
|
|
4233
4233
|
put: {
|
|
@@ -4240,7 +4240,7 @@ interface paths$h {
|
|
|
4240
4240
|
requestBody: {
|
|
4241
4241
|
content: {
|
|
4242
4242
|
"application/json": {
|
|
4243
|
-
data: components$
|
|
4243
|
+
data: components$k["schemas"]["DataSource"];
|
|
4244
4244
|
/** Format: uuid */
|
|
4245
4245
|
projectId: string;
|
|
4246
4246
|
/**
|
|
@@ -4262,11 +4262,11 @@ interface paths$h {
|
|
|
4262
4262
|
};
|
|
4263
4263
|
content?: never;
|
|
4264
4264
|
};
|
|
4265
|
-
400: components$
|
|
4266
|
-
401: components$
|
|
4267
|
-
403: components$
|
|
4268
|
-
429: components$
|
|
4269
|
-
500: components$
|
|
4265
|
+
400: components$k["responses"]["BadRequestError"];
|
|
4266
|
+
401: components$k["responses"]["UnauthorizedError"];
|
|
4267
|
+
403: components$k["responses"]["ForbiddenError"];
|
|
4268
|
+
429: components$k["responses"]["RateLimitError"];
|
|
4269
|
+
500: components$k["responses"]["InternalServerError"];
|
|
4270
4270
|
};
|
|
4271
4271
|
};
|
|
4272
4272
|
post?: never;
|
|
@@ -4294,11 +4294,11 @@ interface paths$h {
|
|
|
4294
4294
|
};
|
|
4295
4295
|
content?: never;
|
|
4296
4296
|
};
|
|
4297
|
-
400: components$
|
|
4298
|
-
401: components$
|
|
4299
|
-
403: components$
|
|
4300
|
-
429: components$
|
|
4301
|
-
500: components$
|
|
4297
|
+
400: components$k["responses"]["BadRequestError"];
|
|
4298
|
+
401: components$k["responses"]["UnauthorizedError"];
|
|
4299
|
+
403: components$k["responses"]["ForbiddenError"];
|
|
4300
|
+
429: components$k["responses"]["RateLimitError"];
|
|
4301
|
+
500: components$k["responses"]["InternalServerError"];
|
|
4302
4302
|
};
|
|
4303
4303
|
};
|
|
4304
4304
|
options?: never;
|
|
@@ -4307,7 +4307,7 @@ interface paths$h {
|
|
|
4307
4307
|
trace?: never;
|
|
4308
4308
|
};
|
|
4309
4309
|
}
|
|
4310
|
-
interface components$
|
|
4310
|
+
interface components$k {
|
|
4311
4311
|
schemas: {
|
|
4312
4312
|
/** @description Defines the shape of a data variable on a Data Source or Data Type */
|
|
4313
4313
|
DataVariableDefinition: {
|
|
@@ -4348,7 +4348,7 @@ interface components$j {
|
|
|
4348
4348
|
}[];
|
|
4349
4349
|
/** @description Variables needed to make calls to the data source */
|
|
4350
4350
|
variables?: {
|
|
4351
|
-
[key: string]: components$
|
|
4351
|
+
[key: string]: components$k["schemas"]["DataVariableDefinition"];
|
|
4352
4352
|
};
|
|
4353
4353
|
};
|
|
4354
4354
|
/** @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
|
|
@@ -4377,7 +4377,7 @@ interface components$j {
|
|
|
4377
4377
|
}[];
|
|
4378
4378
|
/** @description Variables needed to make calls to the data source */
|
|
4379
4379
|
variables?: {
|
|
4380
|
-
[key: string]: components$
|
|
4380
|
+
[key: string]: components$k["schemas"]["DataVariableDefinition"];
|
|
4381
4381
|
};
|
|
4382
4382
|
/** @description Mapping of locale codes to data source locale codes. Keys are Uniform locale codes, values are data source locale codes.
|
|
4383
4383
|
* If a locale is not mapped, it will be passed through to the data source as-is
|
|
@@ -4399,7 +4399,7 @@ interface components$j {
|
|
|
4399
4399
|
};
|
|
4400
4400
|
/** @description Different connector detail variants to use in the different contexts like e.g. Unpublished Data */
|
|
4401
4401
|
variants?: {
|
|
4402
|
-
unpublished?: components$
|
|
4402
|
+
unpublished?: components$k["schemas"]["AlternativeDataSourceData"];
|
|
4403
4403
|
};
|
|
4404
4404
|
};
|
|
4405
4405
|
Error: {
|
|
@@ -4414,7 +4414,7 @@ interface components$j {
|
|
|
4414
4414
|
[name: string]: unknown;
|
|
4415
4415
|
};
|
|
4416
4416
|
content: {
|
|
4417
|
-
"application/json": components$
|
|
4417
|
+
"application/json": components$k["schemas"]["Error"];
|
|
4418
4418
|
};
|
|
4419
4419
|
};
|
|
4420
4420
|
/** @description API key or token was not valid */
|
|
@@ -4423,7 +4423,7 @@ interface components$j {
|
|
|
4423
4423
|
[name: string]: unknown;
|
|
4424
4424
|
};
|
|
4425
4425
|
content: {
|
|
4426
|
-
"application/json": components$
|
|
4426
|
+
"application/json": components$k["schemas"]["Error"];
|
|
4427
4427
|
};
|
|
4428
4428
|
};
|
|
4429
4429
|
/** @description Permission was denied */
|
|
@@ -4432,7 +4432,7 @@ interface components$j {
|
|
|
4432
4432
|
[name: string]: unknown;
|
|
4433
4433
|
};
|
|
4434
4434
|
content: {
|
|
4435
|
-
"application/json": components$
|
|
4435
|
+
"application/json": components$k["schemas"]["Error"];
|
|
4436
4436
|
};
|
|
4437
4437
|
};
|
|
4438
4438
|
/** @description Too many requests in allowed time period */
|
|
@@ -4456,7 +4456,7 @@ interface components$j {
|
|
|
4456
4456
|
pathItems: never;
|
|
4457
4457
|
}
|
|
4458
4458
|
|
|
4459
|
-
interface paths$
|
|
4459
|
+
interface paths$h {
|
|
4460
4460
|
"/api/v1/data-sources": {
|
|
4461
4461
|
parameters: {
|
|
4462
4462
|
query?: never;
|
|
@@ -4486,15 +4486,15 @@ interface paths$g {
|
|
|
4486
4486
|
};
|
|
4487
4487
|
content: {
|
|
4488
4488
|
"application/json": {
|
|
4489
|
-
results: components$
|
|
4489
|
+
results: components$j["schemas"]["DataSource"][];
|
|
4490
4490
|
};
|
|
4491
4491
|
};
|
|
4492
4492
|
};
|
|
4493
|
-
400: components$
|
|
4494
|
-
401: components$
|
|
4495
|
-
403: components$
|
|
4496
|
-
429: components$
|
|
4497
|
-
500: components$
|
|
4493
|
+
400: components$j["responses"]["BadRequestError"];
|
|
4494
|
+
401: components$j["responses"]["UnauthorizedError"];
|
|
4495
|
+
403: components$j["responses"]["ForbiddenError"];
|
|
4496
|
+
429: components$j["responses"]["RateLimitError"];
|
|
4497
|
+
500: components$j["responses"]["InternalServerError"];
|
|
4498
4498
|
};
|
|
4499
4499
|
};
|
|
4500
4500
|
put?: never;
|
|
@@ -4506,7 +4506,7 @@ interface paths$g {
|
|
|
4506
4506
|
trace?: never;
|
|
4507
4507
|
};
|
|
4508
4508
|
}
|
|
4509
|
-
interface components$
|
|
4509
|
+
interface components$j {
|
|
4510
4510
|
schemas: {
|
|
4511
4511
|
/** @description Defines the shape of a data variable on a Data Source or Data Type */
|
|
4512
4512
|
DataVariableDefinition: {
|
|
@@ -4547,7 +4547,7 @@ interface components$i {
|
|
|
4547
4547
|
}[];
|
|
4548
4548
|
/** @description Variables needed to make calls to the data source */
|
|
4549
4549
|
variables?: {
|
|
4550
|
-
[key: string]: components$
|
|
4550
|
+
[key: string]: components$j["schemas"]["DataVariableDefinition"];
|
|
4551
4551
|
};
|
|
4552
4552
|
};
|
|
4553
4553
|
/** @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
|
|
@@ -4576,7 +4576,7 @@ interface components$i {
|
|
|
4576
4576
|
}[];
|
|
4577
4577
|
/** @description Variables needed to make calls to the data source */
|
|
4578
4578
|
variables?: {
|
|
4579
|
-
[key: string]: components$
|
|
4579
|
+
[key: string]: components$j["schemas"]["DataVariableDefinition"];
|
|
4580
4580
|
};
|
|
4581
4581
|
/** @description Mapping of locale codes to data source locale codes. Keys are Uniform locale codes, values are data source locale codes.
|
|
4582
4582
|
* If a locale is not mapped, it will be passed through to the data source as-is
|
|
@@ -4592,14 +4592,247 @@ interface components$i {
|
|
|
4592
4592
|
customPublic?: {
|
|
4593
4593
|
[key: string]: unknown;
|
|
4594
4594
|
};
|
|
4595
|
-
/** @description Custom configuration accessible to the data source editor UI and custom edgehancer that may contain secrets. This cannot be read by the data type or data resource editors */
|
|
4595
|
+
/** @description Custom configuration accessible to the data source editor UI and custom edgehancer that may contain secrets. This cannot be read by the data type or data resource editors */
|
|
4596
|
+
custom?: {
|
|
4597
|
+
[key: string]: unknown;
|
|
4598
|
+
};
|
|
4599
|
+
/** @description Different connector detail variants to use in the different contexts like e.g. Unpublished Data */
|
|
4600
|
+
variants?: {
|
|
4601
|
+
unpublished?: components$j["schemas"]["AlternativeDataSourceData"];
|
|
4602
|
+
};
|
|
4603
|
+
};
|
|
4604
|
+
Error: {
|
|
4605
|
+
/** @description Error message(s) that occurred while processing the request */
|
|
4606
|
+
errorMessage?: string[] | string;
|
|
4607
|
+
};
|
|
4608
|
+
};
|
|
4609
|
+
responses: {
|
|
4610
|
+
/** @description Request input validation failed */
|
|
4611
|
+
BadRequestError: {
|
|
4612
|
+
headers: {
|
|
4613
|
+
[name: string]: unknown;
|
|
4614
|
+
};
|
|
4615
|
+
content: {
|
|
4616
|
+
"application/json": components$j["schemas"]["Error"];
|
|
4617
|
+
};
|
|
4618
|
+
};
|
|
4619
|
+
/** @description API key or token was not valid */
|
|
4620
|
+
UnauthorizedError: {
|
|
4621
|
+
headers: {
|
|
4622
|
+
[name: string]: unknown;
|
|
4623
|
+
};
|
|
4624
|
+
content: {
|
|
4625
|
+
"application/json": components$j["schemas"]["Error"];
|
|
4626
|
+
};
|
|
4627
|
+
};
|
|
4628
|
+
/** @description Permission was denied */
|
|
4629
|
+
ForbiddenError: {
|
|
4630
|
+
headers: {
|
|
4631
|
+
[name: string]: unknown;
|
|
4632
|
+
};
|
|
4633
|
+
content: {
|
|
4634
|
+
"application/json": components$j["schemas"]["Error"];
|
|
4635
|
+
};
|
|
4636
|
+
};
|
|
4637
|
+
/** @description Too many requests in allowed time period */
|
|
4638
|
+
RateLimitError: {
|
|
4639
|
+
headers: {
|
|
4640
|
+
[name: string]: unknown;
|
|
4641
|
+
};
|
|
4642
|
+
content?: never;
|
|
4643
|
+
};
|
|
4644
|
+
/** @description Execution error occurred */
|
|
4645
|
+
InternalServerError: {
|
|
4646
|
+
headers: {
|
|
4647
|
+
[name: string]: unknown;
|
|
4648
|
+
};
|
|
4649
|
+
content?: never;
|
|
4650
|
+
};
|
|
4651
|
+
};
|
|
4652
|
+
parameters: never;
|
|
4653
|
+
requestBodies: never;
|
|
4654
|
+
headers: never;
|
|
4655
|
+
pathItems: never;
|
|
4656
|
+
}
|
|
4657
|
+
|
|
4658
|
+
interface paths$g {
|
|
4659
|
+
"/api/v1/data-types": {
|
|
4660
|
+
parameters: {
|
|
4661
|
+
query?: never;
|
|
4662
|
+
header?: never;
|
|
4663
|
+
path?: never;
|
|
4664
|
+
cookie?: never;
|
|
4665
|
+
};
|
|
4666
|
+
get: {
|
|
4667
|
+
parameters: {
|
|
4668
|
+
query: {
|
|
4669
|
+
projectId: string;
|
|
4670
|
+
};
|
|
4671
|
+
header?: never;
|
|
4672
|
+
path?: never;
|
|
4673
|
+
cookie?: never;
|
|
4674
|
+
};
|
|
4675
|
+
requestBody?: never;
|
|
4676
|
+
responses: {
|
|
4677
|
+
/** @description OK */
|
|
4678
|
+
200: {
|
|
4679
|
+
headers: {
|
|
4680
|
+
[name: string]: unknown;
|
|
4681
|
+
};
|
|
4682
|
+
content: {
|
|
4683
|
+
"application/json": {
|
|
4684
|
+
results: components$i["schemas"]["DataType"][];
|
|
4685
|
+
};
|
|
4686
|
+
};
|
|
4687
|
+
};
|
|
4688
|
+
400: components$i["responses"]["BadRequestError"];
|
|
4689
|
+
401: components$i["responses"]["UnauthorizedError"];
|
|
4690
|
+
403: components$i["responses"]["ForbiddenError"];
|
|
4691
|
+
429: components$i["responses"]["RateLimitError"];
|
|
4692
|
+
500: components$i["responses"]["InternalServerError"];
|
|
4693
|
+
};
|
|
4694
|
+
};
|
|
4695
|
+
put: {
|
|
4696
|
+
parameters: {
|
|
4697
|
+
query?: never;
|
|
4698
|
+
header?: never;
|
|
4699
|
+
path?: never;
|
|
4700
|
+
cookie?: never;
|
|
4701
|
+
};
|
|
4702
|
+
requestBody: {
|
|
4703
|
+
content: {
|
|
4704
|
+
"application/json": {
|
|
4705
|
+
data: components$i["schemas"]["DataType"];
|
|
4706
|
+
/** Format: uuid */
|
|
4707
|
+
projectId: string;
|
|
4708
|
+
};
|
|
4709
|
+
};
|
|
4710
|
+
};
|
|
4711
|
+
responses: {
|
|
4712
|
+
/** @description OK */
|
|
4713
|
+
204: {
|
|
4714
|
+
headers: {
|
|
4715
|
+
[name: string]: unknown;
|
|
4716
|
+
};
|
|
4717
|
+
content?: never;
|
|
4718
|
+
};
|
|
4719
|
+
400: components$i["responses"]["BadRequestError"];
|
|
4720
|
+
401: components$i["responses"]["UnauthorizedError"];
|
|
4721
|
+
403: components$i["responses"]["ForbiddenError"];
|
|
4722
|
+
429: components$i["responses"]["RateLimitError"];
|
|
4723
|
+
500: components$i["responses"]["InternalServerError"];
|
|
4724
|
+
};
|
|
4725
|
+
};
|
|
4726
|
+
post?: never;
|
|
4727
|
+
delete: {
|
|
4728
|
+
parameters: {
|
|
4729
|
+
query?: never;
|
|
4730
|
+
header?: never;
|
|
4731
|
+
path?: never;
|
|
4732
|
+
cookie?: never;
|
|
4733
|
+
};
|
|
4734
|
+
requestBody: {
|
|
4735
|
+
content: {
|
|
4736
|
+
"application/json": {
|
|
4737
|
+
typeId: string;
|
|
4738
|
+
/** Format: uuid */
|
|
4739
|
+
projectId: string;
|
|
4740
|
+
};
|
|
4741
|
+
};
|
|
4742
|
+
};
|
|
4743
|
+
responses: {
|
|
4744
|
+
/** @description OK */
|
|
4745
|
+
204: {
|
|
4746
|
+
headers: {
|
|
4747
|
+
[name: string]: unknown;
|
|
4748
|
+
};
|
|
4749
|
+
content?: never;
|
|
4750
|
+
};
|
|
4751
|
+
400: components$i["responses"]["BadRequestError"];
|
|
4752
|
+
401: components$i["responses"]["UnauthorizedError"];
|
|
4753
|
+
403: components$i["responses"]["ForbiddenError"];
|
|
4754
|
+
429: components$i["responses"]["RateLimitError"];
|
|
4755
|
+
500: components$i["responses"]["InternalServerError"];
|
|
4756
|
+
};
|
|
4757
|
+
};
|
|
4758
|
+
options?: never;
|
|
4759
|
+
head?: never;
|
|
4760
|
+
patch?: never;
|
|
4761
|
+
trace?: never;
|
|
4762
|
+
};
|
|
4763
|
+
}
|
|
4764
|
+
interface components$i {
|
|
4765
|
+
schemas: {
|
|
4766
|
+
/** @description Defines the shape of a data variable on a Data Source or Data Type */
|
|
4767
|
+
DataVariableDefinition: {
|
|
4768
|
+
/** @description Display name of the data variable */
|
|
4769
|
+
displayName?: string;
|
|
4770
|
+
/** @description Explanatory text that is provided to the data resource editor to explain what this variable does */
|
|
4771
|
+
helpText?: string;
|
|
4772
|
+
/**
|
|
4773
|
+
* @description Type of the data variable. Optionally used as a point of reference for custom integrations to decide how to render an editor for a variable
|
|
4774
|
+
* @default text
|
|
4775
|
+
*/
|
|
4776
|
+
type?: string;
|
|
4777
|
+
/** @description Default value of the data variable */
|
|
4778
|
+
default: string;
|
|
4779
|
+
/** @description Sets the order of the variable when displayed in a list with other variables. If not set, the order defaults to alphabetical with any explicitly set orders first in the list */
|
|
4780
|
+
order?: number;
|
|
4781
|
+
/** @description An optional arbitrary human readable source identifier to describe where this variable is from.
|
|
4782
|
+
* Some user interfaces may group variables by source value, for example 'From URL' or 'My Integration'
|
|
4783
|
+
* */
|
|
4784
|
+
source?: string;
|
|
4785
|
+
};
|
|
4786
|
+
/** @description A specific type of data that a Data Source can provide (i.e. "Recipe", "Recipes List by Tag", "Yelp Reviews of My Restaurant"). These are created in the UI and shared a whole project */
|
|
4787
|
+
DataType: {
|
|
4788
|
+
/** @description Public ID of the data type */
|
|
4789
|
+
id: string;
|
|
4790
|
+
/** @description Display name of the data type */
|
|
4791
|
+
displayName: string;
|
|
4792
|
+
/** @description Public ID of the associated data source */
|
|
4793
|
+
dataSourceId: string;
|
|
4794
|
+
/** @description A connector-specific archetype for this data type; used to select UI as well as perform any
|
|
4795
|
+
* necessary post-processing on the response. e.g. 'cms-entry', 'cms-query'. Can be undefined if
|
|
4796
|
+
* no special UI or processing is required
|
|
4797
|
+
* */
|
|
4798
|
+
archetype?: string;
|
|
4799
|
+
allowedOnComponents?: string[];
|
|
4800
|
+
/** @description Resource path, appended to the data source's baseUrl (e.g. baseUrl = https://base.url, path = /v1/endpoint -> final URL https://base.url/v1/endpoint). Must have a leading slash */
|
|
4801
|
+
path: string;
|
|
4802
|
+
/** @description Time-to-live (in seconds) for the resource data cache */
|
|
4803
|
+
ttl?: number;
|
|
4804
|
+
/** @description A key for the resource data cache purging */
|
|
4805
|
+
purgeKey?: string;
|
|
4806
|
+
/** @description URL to a custom badge icon for the Uniform dashboard for this data type. If not set falls back to the data connector or integration icons */
|
|
4807
|
+
badgeIconUrl?: string;
|
|
4808
|
+
/** @description HTTP headers to pass with requests to the data type. Merged with headers from the data source, overriding identical keys */
|
|
4809
|
+
headers?: {
|
|
4810
|
+
key: string;
|
|
4811
|
+
value: string;
|
|
4812
|
+
omitIfEmpty?: boolean;
|
|
4813
|
+
}[];
|
|
4814
|
+
/** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys */
|
|
4815
|
+
parameters?: {
|
|
4816
|
+
key: string;
|
|
4817
|
+
value: string;
|
|
4818
|
+
omitIfEmpty?: boolean;
|
|
4819
|
+
}[];
|
|
4820
|
+
/** @description Body to pass with requests to the data type (ignored unless the method is POST) */
|
|
4821
|
+
body?: string;
|
|
4822
|
+
/**
|
|
4823
|
+
* @description HTTP method to use with requests to the data type
|
|
4824
|
+
* @default GET
|
|
4825
|
+
* @enum {string}
|
|
4826
|
+
*/
|
|
4827
|
+
method: "GET" | "POST" | "HEAD";
|
|
4828
|
+
/** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys */
|
|
4829
|
+
variables?: {
|
|
4830
|
+
[key: string]: components$i["schemas"]["DataVariableDefinition"];
|
|
4831
|
+
};
|
|
4832
|
+
/** @description Custom configuration specific to the data source being defined */
|
|
4596
4833
|
custom?: {
|
|
4597
4834
|
[key: string]: unknown;
|
|
4598
4835
|
};
|
|
4599
|
-
/** @description Different connector detail variants to use in the different contexts like e.g. Unpublished Data */
|
|
4600
|
-
variants?: {
|
|
4601
|
-
unpublished?: components$i["schemas"]["AlternativeDataSourceData"];
|
|
4602
|
-
};
|
|
4603
4836
|
};
|
|
4604
4837
|
Error: {
|
|
4605
4838
|
/** @description Error message(s) that occurred while processing the request */
|
|
@@ -4656,16 +4889,18 @@ interface components$i {
|
|
|
4656
4889
|
}
|
|
4657
4890
|
|
|
4658
4891
|
interface paths$f {
|
|
4659
|
-
"/api/v1/
|
|
4892
|
+
"/api/v1/prompts": {
|
|
4660
4893
|
parameters: {
|
|
4661
4894
|
query?: never;
|
|
4662
4895
|
header?: never;
|
|
4663
4896
|
path?: never;
|
|
4664
4897
|
cookie?: never;
|
|
4665
4898
|
};
|
|
4899
|
+
/** @deprecated */
|
|
4666
4900
|
get: {
|
|
4667
4901
|
parameters: {
|
|
4668
4902
|
query: {
|
|
4903
|
+
promptId?: string;
|
|
4669
4904
|
projectId: string;
|
|
4670
4905
|
};
|
|
4671
4906
|
header?: never;
|
|
@@ -4680,9 +4915,7 @@ interface paths$f {
|
|
|
4680
4915
|
[name: string]: unknown;
|
|
4681
4916
|
};
|
|
4682
4917
|
content: {
|
|
4683
|
-
"application/json":
|
|
4684
|
-
results: components$h["schemas"]["DataType"][];
|
|
4685
|
-
};
|
|
4918
|
+
"application/json": components$h["schemas"]["Prompt"] | components$h["schemas"]["Prompt"][];
|
|
4686
4919
|
};
|
|
4687
4920
|
};
|
|
4688
4921
|
400: components$h["responses"]["BadRequestError"];
|
|
@@ -4692,6 +4925,7 @@ interface paths$f {
|
|
|
4692
4925
|
500: components$h["responses"]["InternalServerError"];
|
|
4693
4926
|
};
|
|
4694
4927
|
};
|
|
4928
|
+
/** @deprecated */
|
|
4695
4929
|
put: {
|
|
4696
4930
|
parameters: {
|
|
4697
4931
|
query?: never;
|
|
@@ -4702,7 +4936,7 @@ interface paths$f {
|
|
|
4702
4936
|
requestBody: {
|
|
4703
4937
|
content: {
|
|
4704
4938
|
"application/json": {
|
|
4705
|
-
data: components$h["schemas"]["
|
|
4939
|
+
data: components$h["schemas"]["Prompt"];
|
|
4706
4940
|
/** Format: uuid */
|
|
4707
4941
|
projectId: string;
|
|
4708
4942
|
};
|
|
@@ -4724,6 +4958,7 @@ interface paths$f {
|
|
|
4724
4958
|
};
|
|
4725
4959
|
};
|
|
4726
4960
|
post?: never;
|
|
4961
|
+
/** @deprecated */
|
|
4727
4962
|
delete: {
|
|
4728
4963
|
parameters: {
|
|
4729
4964
|
query?: never;
|
|
@@ -4734,9 +4969,10 @@ interface paths$f {
|
|
|
4734
4969
|
requestBody: {
|
|
4735
4970
|
content: {
|
|
4736
4971
|
"application/json": {
|
|
4737
|
-
typeId: string;
|
|
4738
4972
|
/** Format: uuid */
|
|
4739
4973
|
projectId: string;
|
|
4974
|
+
/** Format: uuid */
|
|
4975
|
+
promptId: string;
|
|
4740
4976
|
};
|
|
4741
4977
|
};
|
|
4742
4978
|
};
|
|
@@ -4763,76 +4999,29 @@ interface paths$f {
|
|
|
4763
4999
|
}
|
|
4764
5000
|
interface components$h {
|
|
4765
5001
|
schemas: {
|
|
4766
|
-
/** @description
|
|
4767
|
-
|
|
4768
|
-
/** @description Display name of the data variable */
|
|
4769
|
-
displayName?: string;
|
|
4770
|
-
/** @description Explanatory text that is provided to the data resource editor to explain what this variable does */
|
|
4771
|
-
helpText?: string;
|
|
5002
|
+
/** @description AI Prompt definition */
|
|
5003
|
+
Prompt: {
|
|
4772
5004
|
/**
|
|
4773
|
-
*
|
|
4774
|
-
* @
|
|
5005
|
+
* Format: uuid
|
|
5006
|
+
* @description Unique identifier for the prompt
|
|
4775
5007
|
*/
|
|
4776
|
-
type?: string;
|
|
4777
|
-
/** @description Default value of the data variable */
|
|
4778
|
-
default: string;
|
|
4779
|
-
/** @description Sets the order of the variable when displayed in a list with other variables. If not set, the order defaults to alphabetical with any explicitly set orders first in the list */
|
|
4780
|
-
order?: number;
|
|
4781
|
-
/** @description An optional arbitrary human readable source identifier to describe where this variable is from.
|
|
4782
|
-
* Some user interfaces may group variables by source value, for example 'From URL' or 'My Integration'
|
|
4783
|
-
* */
|
|
4784
|
-
source?: string;
|
|
4785
|
-
};
|
|
4786
|
-
/** @description A specific type of data that a Data Source can provide (i.e. "Recipe", "Recipes List by Tag", "Yelp Reviews of My Restaurant"). These are created in the UI and shared a whole project */
|
|
4787
|
-
DataType: {
|
|
4788
|
-
/** @description Public ID of the data type */
|
|
4789
5008
|
id: string;
|
|
4790
|
-
/** @description
|
|
4791
|
-
|
|
4792
|
-
/** @description
|
|
4793
|
-
|
|
4794
|
-
/** @description
|
|
4795
|
-
|
|
4796
|
-
|
|
4797
|
-
|
|
4798
|
-
archetype?: string;
|
|
4799
|
-
allowedOnComponents?: string[];
|
|
4800
|
-
/** @description Resource path, appended to the data source's baseUrl (e.g. baseUrl = https://base.url, path = /v1/endpoint -> final URL https://base.url/v1/endpoint). Must have a leading slash */
|
|
4801
|
-
path: string;
|
|
4802
|
-
/** @description Time-to-live (in seconds) for the resource data cache */
|
|
4803
|
-
ttl?: number;
|
|
4804
|
-
/** @description A key for the resource data cache purging */
|
|
4805
|
-
purgeKey?: string;
|
|
4806
|
-
/** @description URL to a custom badge icon for the Uniform dashboard for this data type. If not set falls back to the data connector or integration icons */
|
|
4807
|
-
badgeIconUrl?: string;
|
|
4808
|
-
/** @description HTTP headers to pass with requests to the data type. Merged with headers from the data source, overriding identical keys */
|
|
4809
|
-
headers?: {
|
|
4810
|
-
key: string;
|
|
4811
|
-
value: string;
|
|
4812
|
-
omitIfEmpty?: boolean;
|
|
4813
|
-
}[];
|
|
4814
|
-
/** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys */
|
|
4815
|
-
parameters?: {
|
|
4816
|
-
key: string;
|
|
4817
|
-
value: string;
|
|
4818
|
-
omitIfEmpty?: boolean;
|
|
4819
|
-
}[];
|
|
4820
|
-
/** @description Body to pass with requests to the data type (ignored unless the method is POST) */
|
|
4821
|
-
body?: string;
|
|
4822
|
-
/**
|
|
4823
|
-
* @description HTTP method to use with requests to the data type
|
|
4824
|
-
* @default GET
|
|
4825
|
-
* @enum {string}
|
|
4826
|
-
*/
|
|
4827
|
-
method: "GET" | "POST" | "HEAD";
|
|
4828
|
-
/** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys */
|
|
4829
|
-
variables?: {
|
|
4830
|
-
[key: string]: components$h["schemas"]["DataVariableDefinition"];
|
|
4831
|
-
};
|
|
4832
|
-
/** @description Custom configuration specific to the data source being defined */
|
|
4833
|
-
custom?: {
|
|
5009
|
+
/** @description Unique identifier for the integration that this prompt belongs to */
|
|
5010
|
+
integrationType: string;
|
|
5011
|
+
/** @description Name for the prompt */
|
|
5012
|
+
name?: string | null;
|
|
5013
|
+
/** @description Text for the prompt */
|
|
5014
|
+
text?: string | null;
|
|
5015
|
+
/** @description Data for the prompt */
|
|
5016
|
+
data?: {
|
|
4834
5017
|
[key: string]: unknown;
|
|
4835
|
-
};
|
|
5018
|
+
} | null;
|
|
5019
|
+
/** @description Turn off/on prompt */
|
|
5020
|
+
enabled?: boolean | null;
|
|
5021
|
+
/** @description Integration default prompt */
|
|
5022
|
+
builtIn?: boolean | null;
|
|
5023
|
+
/** @description Supported parameter types */
|
|
5024
|
+
parameterTypes?: string[] | null;
|
|
4836
5025
|
};
|
|
4837
5026
|
Error: {
|
|
4838
5027
|
/** @description Error message(s) that occurred while processing the request */
|
|
@@ -4888,20 +5077,68 @@ interface components$h {
|
|
|
4888
5077
|
pathItems: never;
|
|
4889
5078
|
}
|
|
4890
5079
|
|
|
5080
|
+
type PromptsApi = paths$f['/api/v1/prompts'];
|
|
5081
|
+
type DataTypeApi = paths$g['/api/v1/data-types'];
|
|
5082
|
+
type DataSourcesApi = paths$h['/api/v1/data-sources'];
|
|
5083
|
+
type DataSourceApi = paths$i['/api/v1/data-source'];
|
|
5084
|
+
/** Query parameter options for GET /api/v1/data-types */
|
|
5085
|
+
type DataTypeGetParameters = DataTypeApi['get']['parameters']['query'];
|
|
5086
|
+
/** The GET response from /api/v1/data-types */
|
|
5087
|
+
type DataTypeGetResponse = DataTypeApi['get']['responses']['200']['content']['application/json'];
|
|
5088
|
+
/** The PUT request body for /api/v1/data-types */
|
|
5089
|
+
type DataTypePutParameters = DataTypeApi['put']['requestBody']['content']['application/json'];
|
|
5090
|
+
/** Shape of the DELETE request body for /api/v1/data-types */
|
|
5091
|
+
type DataTypeDeleteParameters = DataTypeApi['delete']['requestBody']['content']['application/json'];
|
|
5092
|
+
/** Query parameter options for GET /api/v1/data-source */
|
|
5093
|
+
type DataSourceGetParameters = DataSourceApi['get']['parameters']['query'];
|
|
5094
|
+
/** Query parameter options for GET /api/v1/data-sources */
|
|
5095
|
+
type DataSourcesGetParameters = DataSourcesApi['get']['parameters']['query'];
|
|
5096
|
+
/** The GET response from /api/v1/data-sources */
|
|
5097
|
+
type DataSourceGetResponse = DataSourceApi['get']['responses']['200']['content']['application/json'];
|
|
5098
|
+
/** The GET response from /api/v1/data-sources */
|
|
5099
|
+
type DataSourcesGetResponse = DataSourcesApi['get']['responses']['200']['content']['application/json'];
|
|
5100
|
+
/** The PUT request body for /api/v1/data-source */
|
|
5101
|
+
type DataSourcePutParameters = DataSourceApi['put']['requestBody']['content']['application/json'];
|
|
5102
|
+
/** Shape of the DELETE request body for /api/v1/data-source */
|
|
5103
|
+
type DataSourceDeleteParameters = DataSourceApi['delete']['requestBody']['content']['application/json'];
|
|
5104
|
+
/** Query parameter options for GET /api/v1/prompts */
|
|
5105
|
+
type PromptsGetParameters = PromptsApi['get']['parameters']['query'];
|
|
5106
|
+
/** The GET response from /api/v1/prompts */
|
|
5107
|
+
type PromptsGetResponse = PromptsApi['get']['responses']['200']['content']['application/json'];
|
|
5108
|
+
/** The PUT request body for /api/v1/prompts */
|
|
5109
|
+
type PromptsPutParameters = PromptsApi['put']['requestBody']['content']['application/json'];
|
|
5110
|
+
/** Shape of the DELETE request body for /api/v1/prompts */
|
|
5111
|
+
type PromptsDeleteParameters = PromptsApi['delete']['requestBody']['content']['application/json'];
|
|
5112
|
+
type DataType = components$q['schemas']['DataType'];
|
|
5113
|
+
type DataSource = components$q['schemas']['DataSource'];
|
|
5114
|
+
type DataVariableDefinition = components$q['schemas']['DataVariableDefinition'];
|
|
5115
|
+
type Prompt = components$q['schemas']['Prompt'];
|
|
5116
|
+
type DataSourceVariantsKeys = keyof NonNullable<DataSource['variants']>;
|
|
5117
|
+
type DataSourceVariantData = NonNullable<DataSource['variants']>['unpublished'];
|
|
5118
|
+
|
|
4891
5119
|
interface paths$e {
|
|
4892
|
-
"/api/v1/
|
|
5120
|
+
"/api/v1/labels": {
|
|
4893
5121
|
parameters: {
|
|
4894
5122
|
query?: never;
|
|
4895
5123
|
header?: never;
|
|
4896
5124
|
path?: never;
|
|
4897
5125
|
cookie?: never;
|
|
4898
5126
|
};
|
|
4899
|
-
/**
|
|
5127
|
+
/**
|
|
5128
|
+
* @deprecated
|
|
5129
|
+
* @description Gets labels for a project
|
|
5130
|
+
*/
|
|
4900
5131
|
get: {
|
|
4901
5132
|
parameters: {
|
|
4902
5133
|
query: {
|
|
4903
|
-
promptId?: string;
|
|
4904
5134
|
projectId: string;
|
|
5135
|
+
offset?: number | null;
|
|
5136
|
+
limit?: number;
|
|
5137
|
+
labelIds?: string;
|
|
5138
|
+
groupId?: string;
|
|
5139
|
+
isGroup?: boolean | null;
|
|
5140
|
+
idPrefix?: string;
|
|
5141
|
+
namePrefix?: string;
|
|
4905
5142
|
};
|
|
4906
5143
|
header?: never;
|
|
4907
5144
|
path?: never;
|
|
@@ -4915,7 +5152,35 @@ interface paths$e {
|
|
|
4915
5152
|
[name: string]: unknown;
|
|
4916
5153
|
};
|
|
4917
5154
|
content: {
|
|
4918
|
-
"application/json":
|
|
5155
|
+
"application/json": {
|
|
5156
|
+
labels: {
|
|
5157
|
+
/** Format: uuid */
|
|
5158
|
+
projectId: string;
|
|
5159
|
+
label: {
|
|
5160
|
+
/** @description Public ID of the label (cannot be changed after creation) */
|
|
5161
|
+
publicId: string;
|
|
5162
|
+
/** @description Human readable name of the label */
|
|
5163
|
+
displayName: string;
|
|
5164
|
+
/** @description Whether this label is a group label (cannot be changed after creation) */
|
|
5165
|
+
isGroup: boolean;
|
|
5166
|
+
/** @description Public ID of the parent group label */
|
|
5167
|
+
parent?: string;
|
|
5168
|
+
/** @description Human readable color identifier */
|
|
5169
|
+
color: string;
|
|
5170
|
+
/** @description Short description of what the label is about */
|
|
5171
|
+
description?: string;
|
|
5172
|
+
/** @description Scope of the label (currently unused) */
|
|
5173
|
+
scope: string[];
|
|
5174
|
+
};
|
|
5175
|
+
/** Format: date-time */
|
|
5176
|
+
created: string;
|
|
5177
|
+
/** Format: date-time */
|
|
5178
|
+
modified: string;
|
|
5179
|
+
createdBy?: string;
|
|
5180
|
+
modifiedBy?: string;
|
|
5181
|
+
}[];
|
|
5182
|
+
totalCount: number;
|
|
5183
|
+
};
|
|
4919
5184
|
};
|
|
4920
5185
|
};
|
|
4921
5186
|
400: components$g["responses"]["BadRequestError"];
|
|
@@ -4925,7 +5190,10 @@ interface paths$e {
|
|
|
4925
5190
|
500: components$g["responses"]["InternalServerError"];
|
|
4926
5191
|
};
|
|
4927
5192
|
};
|
|
4928
|
-
/**
|
|
5193
|
+
/**
|
|
5194
|
+
* @deprecated
|
|
5195
|
+
* @description Creates or updates a label
|
|
5196
|
+
*/
|
|
4929
5197
|
put: {
|
|
4930
5198
|
parameters: {
|
|
4931
5199
|
query?: never;
|
|
@@ -4936,9 +5204,20 @@ interface paths$e {
|
|
|
4936
5204
|
requestBody: {
|
|
4937
5205
|
content: {
|
|
4938
5206
|
"application/json": {
|
|
4939
|
-
data: components$g["schemas"]["Prompt"];
|
|
4940
5207
|
/** Format: uuid */
|
|
4941
5208
|
projectId: string;
|
|
5209
|
+
label: {
|
|
5210
|
+
/** @description Public ID of the label */
|
|
5211
|
+
publicId: string;
|
|
5212
|
+
displayName: string;
|
|
5213
|
+
/** @default false */
|
|
5214
|
+
isGroup?: boolean;
|
|
5215
|
+
parent?: string;
|
|
5216
|
+
color: string;
|
|
5217
|
+
description?: string;
|
|
5218
|
+
/** @description Ignored on PUT */
|
|
5219
|
+
scope?: string[];
|
|
5220
|
+
};
|
|
4942
5221
|
};
|
|
4943
5222
|
};
|
|
4944
5223
|
};
|
|
@@ -4948,7 +5227,9 @@ interface paths$e {
|
|
|
4948
5227
|
headers: {
|
|
4949
5228
|
[name: string]: unknown;
|
|
4950
5229
|
};
|
|
4951
|
-
content
|
|
5230
|
+
content: {
|
|
5231
|
+
"application/json": string;
|
|
5232
|
+
};
|
|
4952
5233
|
};
|
|
4953
5234
|
400: components$g["responses"]["BadRequestError"];
|
|
4954
5235
|
401: components$g["responses"]["UnauthorizedError"];
|
|
@@ -4958,7 +5239,10 @@ interface paths$e {
|
|
|
4958
5239
|
};
|
|
4959
5240
|
};
|
|
4960
5241
|
post?: never;
|
|
4961
|
-
/**
|
|
5242
|
+
/**
|
|
5243
|
+
* @deprecated
|
|
5244
|
+
* @description Deletes a label
|
|
5245
|
+
*/
|
|
4962
5246
|
delete: {
|
|
4963
5247
|
parameters: {
|
|
4964
5248
|
query?: never;
|
|
@@ -4969,10 +5253,13 @@ interface paths$e {
|
|
|
4969
5253
|
requestBody: {
|
|
4970
5254
|
content: {
|
|
4971
5255
|
"application/json": {
|
|
4972
|
-
/**
|
|
5256
|
+
/**
|
|
5257
|
+
* Format: uuid
|
|
5258
|
+
* @description The project ID
|
|
5259
|
+
*/
|
|
4973
5260
|
projectId: string;
|
|
4974
|
-
/**
|
|
4975
|
-
|
|
5261
|
+
/** @description Public ID of the label to delete */
|
|
5262
|
+
labelId: string;
|
|
4976
5263
|
};
|
|
4977
5264
|
};
|
|
4978
5265
|
};
|
|
@@ -4982,7 +5269,9 @@ interface paths$e {
|
|
|
4982
5269
|
headers: {
|
|
4983
5270
|
[name: string]: unknown;
|
|
4984
5271
|
};
|
|
4985
|
-
content
|
|
5272
|
+
content: {
|
|
5273
|
+
"application/json": string;
|
|
5274
|
+
};
|
|
4986
5275
|
};
|
|
4987
5276
|
400: components$g["responses"]["BadRequestError"];
|
|
4988
5277
|
401: components$g["responses"]["UnauthorizedError"];
|
|
@@ -4991,7 +5280,25 @@ interface paths$e {
|
|
|
4991
5280
|
500: components$g["responses"]["InternalServerError"];
|
|
4992
5281
|
};
|
|
4993
5282
|
};
|
|
4994
|
-
|
|
5283
|
+
/** @description Handles preflight requests. This endpoint allows CORS. */
|
|
5284
|
+
options: {
|
|
5285
|
+
parameters: {
|
|
5286
|
+
query?: never;
|
|
5287
|
+
header?: never;
|
|
5288
|
+
path?: never;
|
|
5289
|
+
cookie?: never;
|
|
5290
|
+
};
|
|
5291
|
+
requestBody?: never;
|
|
5292
|
+
responses: {
|
|
5293
|
+
/** @description ok */
|
|
5294
|
+
204: {
|
|
5295
|
+
headers: {
|
|
5296
|
+
[name: string]: unknown;
|
|
5297
|
+
};
|
|
5298
|
+
content?: never;
|
|
5299
|
+
};
|
|
5300
|
+
};
|
|
5301
|
+
};
|
|
4995
5302
|
head?: never;
|
|
4996
5303
|
patch?: never;
|
|
4997
5304
|
trace?: never;
|
|
@@ -4999,30 +5306,6 @@ interface paths$e {
|
|
|
4999
5306
|
}
|
|
5000
5307
|
interface components$g {
|
|
5001
5308
|
schemas: {
|
|
5002
|
-
/** @description AI Prompt definition */
|
|
5003
|
-
Prompt: {
|
|
5004
|
-
/**
|
|
5005
|
-
* Format: uuid
|
|
5006
|
-
* @description Unique identifier for the prompt
|
|
5007
|
-
*/
|
|
5008
|
-
id: string;
|
|
5009
|
-
/** @description Unique identifier for the integration that this prompt belongs to */
|
|
5010
|
-
integrationType: string;
|
|
5011
|
-
/** @description Name for the prompt */
|
|
5012
|
-
name?: string | null;
|
|
5013
|
-
/** @description Text for the prompt */
|
|
5014
|
-
text?: string | null;
|
|
5015
|
-
/** @description Data for the prompt */
|
|
5016
|
-
data?: {
|
|
5017
|
-
[key: string]: unknown;
|
|
5018
|
-
} | null;
|
|
5019
|
-
/** @description Turn off/on prompt */
|
|
5020
|
-
enabled?: boolean | null;
|
|
5021
|
-
/** @description Integration default prompt */
|
|
5022
|
-
builtIn?: boolean | null;
|
|
5023
|
-
/** @description Supported parameter types */
|
|
5024
|
-
parameterTypes?: string[] | null;
|
|
5025
|
-
};
|
|
5026
5309
|
Error: {
|
|
5027
5310
|
/** @description Error message(s) that occurred while processing the request */
|
|
5028
5311
|
errorMessage?: string[] | string;
|
|
@@ -5077,44 +5360,12 @@ interface components$g {
|
|
|
5077
5360
|
pathItems: never;
|
|
5078
5361
|
}
|
|
5079
5362
|
|
|
5080
|
-
type
|
|
5081
|
-
type
|
|
5082
|
-
type
|
|
5083
|
-
type
|
|
5084
|
-
|
|
5085
|
-
type
|
|
5086
|
-
/** The GET response from /api/v1/data-types */
|
|
5087
|
-
type DataTypeGetResponse = DataTypeApi['get']['responses']['200']['content']['application/json'];
|
|
5088
|
-
/** The PUT request body for /api/v1/data-types */
|
|
5089
|
-
type DataTypePutParameters = DataTypeApi['put']['requestBody']['content']['application/json'];
|
|
5090
|
-
/** Shape of the DELETE request body for /api/v1/data-types */
|
|
5091
|
-
type DataTypeDeleteParameters = DataTypeApi['delete']['requestBody']['content']['application/json'];
|
|
5092
|
-
/** Query parameter options for GET /api/v1/data-source */
|
|
5093
|
-
type DataSourceGetParameters = DataSourceApi['get']['parameters']['query'];
|
|
5094
|
-
/** Query parameter options for GET /api/v1/data-sources */
|
|
5095
|
-
type DataSourcesGetParameters = DataSourcesApi['get']['parameters']['query'];
|
|
5096
|
-
/** The GET response from /api/v1/data-sources */
|
|
5097
|
-
type DataSourceGetResponse = DataSourceApi['get']['responses']['200']['content']['application/json'];
|
|
5098
|
-
/** The GET response from /api/v1/data-sources */
|
|
5099
|
-
type DataSourcesGetResponse = DataSourcesApi['get']['responses']['200']['content']['application/json'];
|
|
5100
|
-
/** The PUT request body for /api/v1/data-source */
|
|
5101
|
-
type DataSourcePutParameters = DataSourceApi['put']['requestBody']['content']['application/json'];
|
|
5102
|
-
/** Shape of the DELETE request body for /api/v1/data-source */
|
|
5103
|
-
type DataSourceDeleteParameters = DataSourceApi['delete']['requestBody']['content']['application/json'];
|
|
5104
|
-
/** Query parameter options for GET /api/v1/prompts */
|
|
5105
|
-
type PromptsGetParameters = PromptsApi['get']['parameters']['query'];
|
|
5106
|
-
/** The GET response from /api/v1/prompts */
|
|
5107
|
-
type PromptsGetResponse = PromptsApi['get']['responses']['200']['content']['application/json'];
|
|
5108
|
-
/** The PUT request body for /api/v1/prompts */
|
|
5109
|
-
type PromptsPutParameters = PromptsApi['put']['requestBody']['content']['application/json'];
|
|
5110
|
-
/** Shape of the DELETE request body for /api/v1/prompts */
|
|
5111
|
-
type PromptsDeleteParameters = PromptsApi['delete']['requestBody']['content']['application/json'];
|
|
5112
|
-
type DataType = components$p['schemas']['DataType'];
|
|
5113
|
-
type DataSource = components$p['schemas']['DataSource'];
|
|
5114
|
-
type DataVariableDefinition = components$p['schemas']['DataVariableDefinition'];
|
|
5115
|
-
type Prompt = components$p['schemas']['Prompt'];
|
|
5116
|
-
type DataSourceVariantsKeys = keyof NonNullable<DataSource['variants']>;
|
|
5117
|
-
type DataSourceVariantData = NonNullable<DataSource['variants']>['unpublished'];
|
|
5363
|
+
type LabelsApi = paths$e['/api/v1/labels'];
|
|
5364
|
+
type LabelsQuery = LabelsApi['get']['parameters']['query'];
|
|
5365
|
+
type LabelPut = LabelsApi['put']['requestBody']['content']['application/json'];
|
|
5366
|
+
type LabelDelete = LabelsApi['delete']['requestBody']['content']['application/json'];
|
|
5367
|
+
type LabelsResponse = LabelsApi['get']['responses']['200']['content']['application/json'];
|
|
5368
|
+
type Label = LabelsResponse['labels'][number];
|
|
5118
5369
|
|
|
5119
5370
|
interface paths$d {
|
|
5120
5371
|
"/api/v1/locales": {
|
|
@@ -9617,7 +9868,7 @@ interface components$a {
|
|
|
9617
9868
|
}
|
|
9618
9869
|
|
|
9619
9870
|
type Components = components$d['schemas'];
|
|
9620
|
-
type SharedComponents$1 = components$
|
|
9871
|
+
type SharedComponents$1 = components$q['schemas'];
|
|
9621
9872
|
type Api = paths$c['/api/v1/canvas'];
|
|
9622
9873
|
type HistoryApi = paths$b['/api/v1/canvas-history'];
|
|
9623
9874
|
/** Query parameter options for GET /api/v1/canvas */
|
|
@@ -9758,6 +10009,7 @@ type CanvasDefinitions = {
|
|
|
9758
10009
|
entries?: Array<Entry>;
|
|
9759
10010
|
entryPatterns?: Array<Entry>;
|
|
9760
10011
|
prompts?: Array<Prompt>;
|
|
10012
|
+
labels?: Array<Label>;
|
|
9761
10013
|
assets?: Array<AssetGetResponseSingle>;
|
|
9762
10014
|
locales?: Array<Locale>;
|
|
9763
10015
|
workflows?: Array<WorkflowDefinition>;
|
|
@@ -9873,8 +10125,8 @@ type RouteGetResponseRedirect = components$e['schemas']['RouteResponseRedirect']
|
|
|
9873
10125
|
type RouteGetResponseNotFound = components$e['schemas']['RouteResponseNotFound'];
|
|
9874
10126
|
type RouteDynamicInputs = components$e['schemas']['RouteDynamicInputs'];
|
|
9875
10127
|
/** The GET response from /api/v1/entries */
|
|
9876
|
-
type EntriesGetParameters = paths$
|
|
9877
|
-
type EntriesGetResponse = components$
|
|
10128
|
+
type EntriesGetParameters = paths$k['/api/v1/entries']['get']['parameters']['query'] & DataResolutionParameters;
|
|
10129
|
+
type EntriesGetResponse = components$o['schemas']['EntryListResponse'];
|
|
9878
10130
|
type EntriesResolvedListResponse = components$b['schemas']['EntryResolvedListResponse'];
|
|
9879
10131
|
/** GET response from uniform.global/api/v1/route when result is a composition */
|
|
9880
10132
|
type RouteGetResponseEdgehancedComposition = Omit<RouteGetResponseComposition, 'compositionApiResponse'> & {
|
|
@@ -10381,6 +10633,8 @@ interface AssetParamConfig extends ParamTypeConfigConventions {
|
|
|
10381
10633
|
min?: number;
|
|
10382
10634
|
max?: number;
|
|
10383
10635
|
allowedTypes?: AssetDefinitionType[];
|
|
10636
|
+
/** Array of label public IDs to assign by default to assets uploaded through this parameter */
|
|
10637
|
+
defaultLabels?: string[];
|
|
10384
10638
|
}
|
|
10385
10639
|
|
|
10386
10640
|
/**
|
|
@@ -11909,7 +12163,7 @@ interface components$3 {
|
|
|
11909
12163
|
}
|
|
11910
12164
|
|
|
11911
12165
|
type WorkflowsApi = paths$3['/api/v1/workflows'];
|
|
11912
|
-
type SharedComponents = components$
|
|
12166
|
+
type SharedComponents = components$q['schemas'];
|
|
11913
12167
|
type WorkflowDefinition = SharedComponents['WorkflowDefinition'];
|
|
11914
12168
|
type WorkflowStage = SharedComponents['WorkflowStage'];
|
|
11915
12169
|
type WorkflowStagePermission = SharedComponents['WorkflowStagePermission'];
|
|
@@ -11968,7 +12222,7 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
|
|
|
11968
12222
|
getCompositionHistory(options: ExceptProject<ComponentInstanceHistoryGetParameters>): Promise<{
|
|
11969
12223
|
cursor?: string;
|
|
11970
12224
|
truncated?: boolean;
|
|
11971
|
-
results?: components$
|
|
12225
|
+
results?: components$q["schemas"]["HistoryEntry"][];
|
|
11972
12226
|
}>;
|
|
11973
12227
|
private getOneComposition;
|
|
11974
12228
|
/** Updates or creates a Canvas component definition */
|
|
@@ -11979,7 +12233,7 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
|
|
|
11979
12233
|
removeComposition(body: Omit<CompositionDeleteParameters, 'projectId'>): Promise<void>;
|
|
11980
12234
|
/** Fetches all Canvas component definitions */
|
|
11981
12235
|
getComponentDefinitions(options?: Omit<ComponentDefinitionGetParameters, 'projectId'>): Promise<{
|
|
11982
|
-
componentDefinitions: components$
|
|
12236
|
+
componentDefinitions: components$r["schemas"]["ComponentDefinition"][];
|
|
11983
12237
|
}>;
|
|
11984
12238
|
/** Updates or creates a Canvas component definition */
|
|
11985
12239
|
updateComponentDefinition(body: Omit<ComponentDefinitionPutParameters, 'projectId'>): Promise<void>;
|
|
@@ -11994,7 +12248,7 @@ declare class CategoryClient extends ApiClient {
|
|
|
11994
12248
|
constructor(options: ClientOptions);
|
|
11995
12249
|
/** Fetches all categories created in given project */
|
|
11996
12250
|
getCategories(options?: Omit<CategoriesGetParameters, 'projectId'>): Promise<{
|
|
11997
|
-
categories: components$
|
|
12251
|
+
categories: components$p["schemas"]["Category"][];
|
|
11998
12252
|
}>;
|
|
11999
12253
|
/** Updates or creates a category, also used to re-order them */
|
|
12000
12254
|
upsertCategories(categories: CategoriesPutParameters['categories']): Promise<unknown>;
|
|
@@ -12024,7 +12278,7 @@ declare class ContentClient extends ApiClient<ContentClientOptions> {
|
|
|
12024
12278
|
getEntryHistory(options: ExceptProject<EntriesHistoryGetParameters>): Promise<{
|
|
12025
12279
|
cursor?: string;
|
|
12026
12280
|
truncated?: boolean;
|
|
12027
|
-
results?: components$
|
|
12281
|
+
results?: components$q["schemas"]["HistoryEntry"][];
|
|
12028
12282
|
}>;
|
|
12029
12283
|
upsertContentType(body: ExceptProject<PutContentTypeBody>, opts?: {
|
|
12030
12284
|
autogenerateDataTypes?: boolean;
|
|
@@ -12045,11 +12299,11 @@ declare class DataSourceClient extends ApiClient {
|
|
|
12045
12299
|
constructor(options: ClientOptions);
|
|
12046
12300
|
/** Fetches all DataSources for a project */
|
|
12047
12301
|
get(options?: ExceptProject<DataSourceGetParameters>): Promise<{
|
|
12048
|
-
result: components$
|
|
12302
|
+
result: components$k["schemas"]["DataSource"];
|
|
12049
12303
|
}>;
|
|
12050
12304
|
/** Fetches all DataSources for a project */
|
|
12051
12305
|
getList(options?: ExceptProject<DataSourcesGetParameters>): Promise<{
|
|
12052
|
-
results: components$
|
|
12306
|
+
results: components$j["schemas"]["DataSource"][];
|
|
12053
12307
|
}>;
|
|
12054
12308
|
/** Updates or creates (based on id) a DataSource */
|
|
12055
12309
|
upsert(body: ExceptProject<DataSourcePutParameters>): Promise<void>;
|
|
@@ -12407,9 +12661,9 @@ type VisibilityParameterValue = {
|
|
|
12407
12661
|
/** Criteria for the visibility of the component. If these evaluate to false, the component is hidden. */
|
|
12408
12662
|
criteria?: VisibilityCriteriaGroup;
|
|
12409
12663
|
};
|
|
12410
|
-
type VisibilityCriteriaGroup = components$
|
|
12411
|
-
type VisibilityCriteria = components$
|
|
12412
|
-
type ComponentParameterConditionalValue<TValue = unknown> = Omit<components$
|
|
12664
|
+
type VisibilityCriteriaGroup = components$q['schemas']['VisibilityCriteriaGroup'];
|
|
12665
|
+
type VisibilityCriteria = components$q['schemas']['VisibilityCriteria'];
|
|
12666
|
+
type ComponentParameterConditionalValue<TValue = unknown> = Omit<components$q['schemas']['ComponentParameterConditionalValue'], 'value'> & {
|
|
12413
12667
|
value: TValue;
|
|
12414
12668
|
};
|
|
12415
12669
|
/**
|
|
@@ -12608,6 +12862,36 @@ declare class IntegrationPropertyEditorsClient extends ApiClient<IntegrationProp
|
|
|
12608
12862
|
delete(body: ExceptTeam<IntegrationPropertyEditorsDeleteParameters>): Promise<void>;
|
|
12609
12863
|
}
|
|
12610
12864
|
|
|
12865
|
+
declare class LabelClient extends ApiClient {
|
|
12866
|
+
/** Fetches labels for the current project. */
|
|
12867
|
+
getLabels(options?: Omit<LabelsQuery, 'projectId'>): Promise<{
|
|
12868
|
+
labels: {
|
|
12869
|
+
projectId: string;
|
|
12870
|
+
label: {
|
|
12871
|
+
publicId: string;
|
|
12872
|
+
displayName: string;
|
|
12873
|
+
isGroup: boolean;
|
|
12874
|
+
parent?: string;
|
|
12875
|
+
color: string;
|
|
12876
|
+
description?: string;
|
|
12877
|
+
scope: string[];
|
|
12878
|
+
};
|
|
12879
|
+
created: string;
|
|
12880
|
+
modified: string;
|
|
12881
|
+
createdBy?: string;
|
|
12882
|
+
modifiedBy?: string;
|
|
12883
|
+
}[];
|
|
12884
|
+
totalCount: number;
|
|
12885
|
+
}>;
|
|
12886
|
+
/** Updates or creates a label. */
|
|
12887
|
+
upsertLabel(body: Omit<LabelPut, 'projectId'>): Promise<void>;
|
|
12888
|
+
/** Deletes a label by id. */
|
|
12889
|
+
removeLabel(options: Omit<LabelDelete, 'projectId'>): Promise<void>;
|
|
12890
|
+
}
|
|
12891
|
+
declare class UncachedLabelClient extends LabelClient {
|
|
12892
|
+
constructor(options: Omit<ClientOptions, 'bypassCache'>);
|
|
12893
|
+
}
|
|
12894
|
+
|
|
12611
12895
|
/** API client to enable managing project locales */
|
|
12612
12896
|
declare class LocaleClient extends ApiClient {
|
|
12613
12897
|
constructor(options: ClientOptions);
|
|
@@ -13209,6 +13493,7 @@ interface paths$1 {
|
|
|
13209
13493
|
parameters: {
|
|
13210
13494
|
query?: {
|
|
13211
13495
|
teamId?: string;
|
|
13496
|
+
orderBy?: "name_ASC" | "name_DESC" | "createdAt_ASC" | "createdAt_DESC";
|
|
13212
13497
|
};
|
|
13213
13498
|
header?: never;
|
|
13214
13499
|
path?: never;
|
|
@@ -13605,12 +13890,12 @@ declare const createUniformApiEnhancer: ({ apiUrl }: {
|
|
|
13605
13890
|
}) => (message: Pick<UpdateCompositionMessage, "composition" | "hash">) => Promise<{
|
|
13606
13891
|
type: string;
|
|
13607
13892
|
parameters?: {
|
|
13608
|
-
[key: string]: components$
|
|
13893
|
+
[key: string]: components$q["schemas"]["ComponentParameter"];
|
|
13609
13894
|
};
|
|
13610
13895
|
variant?: string;
|
|
13611
|
-
projectMapNodes?: components$
|
|
13896
|
+
projectMapNodes?: components$q["schemas"]["CompositionProjectMapNodeInfo"][];
|
|
13612
13897
|
slots?: {
|
|
13613
|
-
[key: string]: components$
|
|
13898
|
+
[key: string]: components$q["schemas"]["ComponentInstance"][];
|
|
13614
13899
|
};
|
|
13615
13900
|
_id: string;
|
|
13616
13901
|
_slug?: string | null;
|
|
@@ -13621,17 +13906,17 @@ declare const createUniformApiEnhancer: ({ apiUrl }: {
|
|
|
13621
13906
|
_creatorSubject?: string;
|
|
13622
13907
|
_pattern?: string;
|
|
13623
13908
|
_patternDataResources?: {
|
|
13624
|
-
[key: string]: components$
|
|
13909
|
+
[key: string]: components$q["schemas"]["DataResourceDefinition"];
|
|
13625
13910
|
};
|
|
13626
|
-
_dataResources?: components$
|
|
13627
|
-
_patternError?: components$
|
|
13911
|
+
_dataResources?: components$q["schemas"]["DataResourceDefinitions"];
|
|
13912
|
+
_patternError?: components$q["schemas"]["PatternError"];
|
|
13628
13913
|
_overrides?: {
|
|
13629
|
-
[key: string]: components$
|
|
13914
|
+
[key: string]: components$q["schemas"]["ComponentOverride"];
|
|
13630
13915
|
};
|
|
13631
13916
|
_patternOverrides?: {
|
|
13632
|
-
[key: string]: components$
|
|
13917
|
+
[key: string]: components$q["schemas"]["ComponentOverride"];
|
|
13633
13918
|
};
|
|
13634
|
-
_overridability?: components$
|
|
13919
|
+
_overridability?: components$q["schemas"]["ComponentOverridability"];
|
|
13635
13920
|
_locales?: string[];
|
|
13636
13921
|
}>;
|
|
13637
13922
|
|
|
@@ -13858,7 +14143,7 @@ declare function hasReferencedVariables(value: string | undefined): number;
|
|
|
13858
14143
|
*/
|
|
13859
14144
|
declare function parseVariableExpression(serialized: string, onToken?: (token: string, type: 'text' | 'variable') => void | false): number;
|
|
13860
14145
|
|
|
13861
|
-
declare const version = "20.
|
|
14146
|
+
declare const version = "20.51.0";
|
|
13862
14147
|
|
|
13863
14148
|
/** API client to enable managing workflow definitions */
|
|
13864
14149
|
declare class WorkflowClient extends ApiClient {
|
|
@@ -13875,4 +14160,4 @@ declare class WorkflowClient extends ApiClient {
|
|
|
13875
14160
|
|
|
13876
14161
|
declare const CanvasClientError: typeof ApiClientError;
|
|
13877
14162
|
|
|
13878
|
-
export { ASSETS_SOURCE_CUSTOM_URL, ASSETS_SOURCE_UNIFORM, ASSET_PARAMETER_TYPE, ATTRIBUTE_COMPONENT_ID, ATTRIBUTE_MULTILINE, ATTRIBUTE_PARAMETER_ID, ATTRIBUTE_PARAMETER_TYPE, ATTRIBUTE_PARAMETER_VALUE, ATTRIBUTE_PLACEHOLDER, type AddComponentMessage, type AiAction, type AssetParamConfig, type BatchEnhancer, BatchEntry, type BatchInvalidationPayload, type BindVariablesOptions, type BindVariablesResult, type BindVariablesToObjectOptions, BlockFormatError, type BlockLocationReference, type BlockValue, CANVAS_BLOCK_PARAM_TYPE, CANVAS_COMPONENT_DISPLAY_NAME_PARAM, CANVAS_CONTEXTUAL_EDITING_PARAM, CANVAS_DRAFT_STATE, CANVAS_EDITOR_STATE, CANVAS_ENRICHMENT_TAG_PARAM, CANVAS_HYPOTHESIS_PARAM, CANVAS_INTENT_TAG_PARAM, CANVAS_INTERNAL_PARAM_PREFIX, CANVAS_LOCALE_TAG_PARAM, CANVAS_LOCALIZATION_SLOT, CANVAS_LOCALIZATION_TYPE, CANVAS_PERSONALIZATION_ALGORITHM_PARAM, CANVAS_PERSONALIZATION_ALGORITHM_TYPE, CANVAS_PERSONALIZATION_EVENT_NAME_PARAM, CANVAS_PERSONALIZATION_PARAM, CANVAS_PERSONALIZATION_TAKE_PARAM, CANVAS_PERSONALIZE_SLOT, CANVAS_PERSONALIZE_TYPE, CANVAS_PUBLISHED_STATE, CANVAS_SLOT_SECTION_GROUP_TYPE_PARAM, CANVAS_SLOT_SECTION_MAX_PARAM, CANVAS_SLOT_SECTION_MIN_PARAM, CANVAS_SLOT_SECTION_NAME_PARAM, CANVAS_SLOT_SECTION_SLOT, CANVAS_SLOT_SECTION_SPECIFIC_PARAM, CANVAS_SLOT_SECTION_TYPE, CANVAS_TEST_SLOT, CANVAS_TEST_TYPE, CANVAS_TEST_VARIANT_PARAM, CANVAS_VIZ_CONTROL_PARAM, CANVAS_VIZ_DI_RULE, CANVAS_VIZ_DYNAMIC_TOKEN_RULE, CANVAS_VIZ_LOCALE_RULE, CANVAS_VIZ_QUIRKS_RULE, CanvasClient, CanvasClientError, type CanvasDefinitions, type CategoriesDeleteParameters, type CategoriesGetParameters, type CategoriesGetResponse, type CategoriesPutParameters, type Category, CategoryClient, type Channel, type ChannelMessage, ChildEnhancerBuilder, type ComponentDefinition, type ComponentDefinitionDeleteParameters, type ComponentDefinitionGetParameters, type ComponentDefinitionGetResponse, type ComponentDefinitionParameter, type ComponentDefinitionPermission, type ComponentDefinitionPutParameters, type ComponentDefinitionSlot, type ComponentDefinitionSlugSettings, type ComponentDefinitionVariant, type ComponentEnhancer, type ComponentEnhancerFunction, type ComponentEnhancerOptions, type ComponentInstance, type ComponentInstanceContextualEditing, type ComponentInstanceHistoryEntry, type ComponentInstanceHistoryGetParameters, type ComponentInstanceHistoryGetResponse, type ComponentLocationReference, type ComponentOverridability, type ComponentOverride, type ComponentOverrides, type ComponentParameter, type ComponentParameterBlock, type ComponentParameterConditionalValue, type ComponentParameterContextualEditing, type ComponentParameterEnhancer, type ComponentParameterEnhancerFunction, type ComponentParameterEnhancerOptions, type CompositionDeleteParameters, type CompositionFilters, type CompositionGetByComponentIdParameters, type CompositionGetByIdParameters, type CompositionGetByNodeIdParameters, type CompositionGetByNodePathParameters, type CompositionGetBySlugParameters, type CompositionGetListResponse, type CompositionGetParameters, type CompositionGetResponse, type CompositionGetValidResponses, type CompositionPutParameters, type CompositionResolvedGetResponse, type CompositionResolvedListResponse, type CompositionUIStatus, ContentClient, type ContentType, type ContentTypeField, type ContentTypePreviewConfiguration, type ContextStorageUpdatedMessage, type ContextualEditingComponentReference, type ContextualEditingValue, type CopiedComponentSubtree, type DataDiagnostic, type DataElementBindingIssue, type DataElementConnectionDefinition, type DataElementConnectionFailureAction, type DataElementConnectionFailureLogLevel, type DataResolutionConfigIssue, type DataResolutionIssue, type DataResolutionOption, type DataResolutionOptionNegative, type DataResolutionOptionPositive, type DataResolutionParameters, type DataResourceDefinition, type DataResourceDefinitions, type DataResourceIssue, type DataResourceVariables, type DataSource, DataSourceClient, type DataSourceDeleteParameters, type DataSourceGetParameters, type DataSourceGetResponse, type DataSourcePutParameters, type DataSourceVariantData, type DataSourceVariantsKeys, type DataSourcesGetParameters, type DataSourcesGetResponse, type DataType, DataTypeClient, type DataTypeDeleteParameters, type DataTypeGetParameters, type DataTypeGetResponse, type DataTypePutParameters, type DataVariableDefinition, type DataWithProperties, type DateParamConfig, type DateParamValue, type DatetimeParamConfig, type DeleteContentTypeOptions, type DeleteEntryOptions, type DismissPlaceholderMessage, type DynamicInputIssue, EDGE_CACHE_DISABLED, EDGE_DEFAULT_CACHE_TTL, EDGE_MAX_CACHE_TTL, EDGE_MIN_CACHE_TTL, EMPTY_COMPOSITION, type EdgehancersDiagnostics, type EdgehancersWholeResponseCacheDiagnostics, type EditorStateUpdatedMessage, EnhancerBuilder, type EnhancerContext, type EnhancerError, EntityReleasesClient, type EntityReleasesGetParameters, type EntityReleasesGetResponse, type EntriesGetParameters, type EntriesGetResponse, type EntriesHistoryGetParameters, type EntriesHistoryGetResponse, type EntriesResolvedListResponse, type Entry, type EntryData, type EntryFilters, type EntryList, type EvaluateCriteriaGroupOptions, type EvaluateNodeTreeVisibilityOptions, type EvaluateNodeVisibilityParameterOptions, type EvaluatePropertyCriteriaOptions, type EvaluateWalkTreePropertyCriteriaOptions, type Filters, type FindInNodeTreeReference, type FlattenProperty, type FlattenValues, type FlattenValuesOptions, type GetContentTypesOptions, type GetContentTypesResponse, type GetEffectivePropertyValueOptions, type GetEntriesOptions, type GetEntriesResponse, type GetParameterAttributesProps, IN_CONTEXT_EDITOR_COMPONENT_END_ROLE, IN_CONTEXT_EDITOR_COMPONENT_START_ROLE, IN_CONTEXT_EDITOR_CONFIG_CHECK_QUERY_STRING_PARAM, IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID, IN_CONTEXT_EDITOR_FORCED_SETTINGS_QUERY_STRING_PARAM, IN_CONTEXT_EDITOR_PLAYGROUND_QUERY_STRING_PARAM, IN_CONTEXT_EDITOR_QUERY_STRING_PARAM, IS_RENDERED_BY_UNIFORM_ATTRIBUTE, IntegrationPropertyEditorsClient, type IntegrationPropertyEditorsDeleteParameters, type IntegrationPropertyEditorsGetParameters, type IntegrationPropertyEditorsGetResponse, type paths$9 as IntegrationPropertyEditorsPaths, type IntegrationPropertyEditorsPutParameters, type InvalidationPayload, LOCALE_DYNAMIC_INPUT_NAME, type LimitPolicy, type LinkParamConfiguration, type LinkParamValue, type LinkParameterType, type LinkTypeConfiguration, type Locale, LocaleClient, type LocaleDeleteParameters, type LocalePutParameters, type LocalesGetParameters, type LocalesGetResponse, type LocalizeOptions, type MaxDepthExceededIssue, type MessageHandler, type MoveComponentMessage, type MultiSelectParamConfiguration, type MultiSelectParamEditorType, type MultiSelectParamValue, type NodeLocationReference, type NonProjectMapLinkParamValue, type NumberParamConfig, type NumberParamEditorType, type NumberParamValue, type OpenParameterEditorMessage, type OverrideOptions, PLACEHOLDER_ID, type ParamTypeConfigConventions, type PatternIssue, PreviewClient, type PreviewPanelSettings, type PreviewUrl, type PreviewUrlDeleteParameters, type PreviewUrlDeleteResponse, type PreviewUrlPutParameters, type PreviewUrlPutResponse, type PreviewUrlsGetParameters, type PreviewUrlsGetResponse, type PreviewViewport, type PreviewViewportDeleteParameters, type PreviewViewportDeleteResponse, type PreviewViewportPutParameters, type PreviewViewportPutResponse, type PreviewViewportsGetParameters, type PreviewViewportsGetResponse, type Project, ProjectClient, type ProjectDeleteParameters, type ProjectGetParameters, type ProjectGetResponse, type ProjectMapLinkParamValue, type ProjectPutParameters, type ProjectPutResponse, type 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, type ReadyMessage, RelationshipClient, type RelationshipResultInstance, type Release, ReleaseClient, type ReleaseContent, ReleaseContentsClient, type ReleaseContentsDeleteBody, type ReleaseContentsGetParameters, type ReleaseContentsGetResponse, type ReleaseDeleteParameters, type ReleasePatchParameters, type ReleasePutParameters, type ReleaseState, type ReleasesGetParameters, type ReleasesGetResponse, type ReportRenderedCompositionsMessage, type RequestComponentSuggestionMessage, type RequestPageHtmlMessage, type ResolvedRouteGetResponse, type RichTextBuiltInElement, type RichTextBuiltInFormat, type RichTextParamConfiguration, type RichTextParamValue, type RootComponentInstance, type RootEntryReference, type RootLocationReference, RouteClient, type RouteDynamicInputs, type RouteGetParameters, type RouteGetResponse, type RouteGetResponseComposition, type RouteGetResponseEdgehancedComposition, type RouteGetResponseEdgehancedNotFound, type RouteGetResponseNotFound, type RouteGetResponseRedirect, SECRET_QUERY_STRING_PARAM, type SelectComponentMessage, type SelectParamConfiguration, type SelectParamEditorType, type SelectParamOption, type SelectParamValue, type SelectParameterMessage, type SendPageHtmlMessage, type SpecificProjectMap, type StringOperators, type SuggestComponentMessage, type TextParamConfig, type TextParamValue, type TreeNodeInfoTypes, type TriggerComponentActionMessage, type TriggerCompositionActionMessage, UncachedCanvasClient, UncachedCategoryClient, UncachedContentClient, UniqueBatchEntries, type UpdateAiActionsMessage, type UpdateComponentParameterMessage, type UpdateComponentReferencesMessage, type UpdateCompositionInternalMessage, type UpdateCompositionMessage, type UpdateCompositionOptions, type UpdateContextualEditingStateInternalMessage, type UpdateFeatureFlagsMessage, type UpdatePreviewSettingsMessage, type UpsertEntryOptions, type VisibilityCriteria, type VisibilityCriteriaEvaluationResult, type VisibilityCriteriaGroup, type VisibilityParameterValue, type VisibilityRule, type VisibilityRules, type WalkNodeTreeActions, type WalkNodeTreeOptions, type WebhookDefinition, WorkflowClient, type WorkflowDefinition, type WorkflowStage, type WorkflowStagePermission, type WorkflowStageTransition, type WorkflowStageTransitionPermission, type WorkflowsDeleteParameters, type WorkflowsGetParameters, type WorkflowsGetResponse, type WorkflowsPutParameters, autoFixParameterGroups, bindExpressionEscapeChars, bindExpressionPrefix, bindVariables, bindVariablesToObject, compose, convertEntryToPutEntry, convertToBindExpression, createBatchEnhancer, createCanvasChannel, createDynamicInputVisibilityRule, createDynamicTokenVisibilityRule, createLimitPolicy, createLocaleVisibilityRule, createQuirksVisibilityRule, createUniformApiEnhancer, createVariableReference, enhance, escapeBindExpressionDefaultValue, evaluateNodeVisibilityParameter, evaluatePropertyCriteria, evaluateVisibilityCriteriaGroup, evaluateWalkTreeNodeVisibility, evaluateWalkTreePropertyCriteria, extractLocales, findParameterInNodeTree, flattenValues, generateComponentPlaceholderId, generateHash, getBlockValue, getComponentJsonPointer, getComponentPath, getDataSourceVariantFromRouteGetParams, getEffectivePropertyValue, getLocalizedPropertyValues, getNounForLocation, getNounForNode, getParameterAttributes, getPropertiesValue, hasReferencedVariables, isAddComponentMessage, isAllowedReferrer, isAssetParamValue, isAssetParamValueItem, isComponentActionMessage, isComponentPlaceholderId, isContextStorageUpdatedMessage, isDismissPlaceholderMessage, isEntryData, isLinkParamValue, isMovingComponentMessage, isNestedNodeType, isOpenParameterEditorMessage, isReadyMessage, isReportRenderedCompositionsMessage, isRequestComponentSuggestionMessage, isRootEntryReference, isSelectComponentMessage, isSelectParameterMessage, isSuggestComponentMessage, isSystemComponentDefinition, isTriggerCompositionActionMessage, isUpdateAiActionsMessage, isUpdateComponentParameterMessage, isUpdateComponentReferencesMessage, isUpdateCompositionInternalMessage, isUpdateCompositionMessage, isUpdateContextualEditingStateInternalMessage, isUpdateFeatureFlagsMessage, isUpdatePreviewSettingsMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, mergeAssetConfigWithDefaults, nullLimitPolicy, parseComponentPlaceholderId, parseVariableExpression, version, walkNodeTree, walkPropertyValues };
|
|
14163
|
+
export { ASSETS_SOURCE_CUSTOM_URL, ASSETS_SOURCE_UNIFORM, ASSET_PARAMETER_TYPE, ATTRIBUTE_COMPONENT_ID, ATTRIBUTE_MULTILINE, ATTRIBUTE_PARAMETER_ID, ATTRIBUTE_PARAMETER_TYPE, ATTRIBUTE_PARAMETER_VALUE, ATTRIBUTE_PLACEHOLDER, type AddComponentMessage, type AiAction, type AssetParamConfig, type BatchEnhancer, BatchEntry, type BatchInvalidationPayload, type BindVariablesOptions, type BindVariablesResult, type BindVariablesToObjectOptions, BlockFormatError, type BlockLocationReference, type BlockValue, CANVAS_BLOCK_PARAM_TYPE, CANVAS_COMPONENT_DISPLAY_NAME_PARAM, CANVAS_CONTEXTUAL_EDITING_PARAM, CANVAS_DRAFT_STATE, CANVAS_EDITOR_STATE, CANVAS_ENRICHMENT_TAG_PARAM, CANVAS_HYPOTHESIS_PARAM, CANVAS_INTENT_TAG_PARAM, CANVAS_INTERNAL_PARAM_PREFIX, CANVAS_LOCALE_TAG_PARAM, CANVAS_LOCALIZATION_SLOT, CANVAS_LOCALIZATION_TYPE, CANVAS_PERSONALIZATION_ALGORITHM_PARAM, CANVAS_PERSONALIZATION_ALGORITHM_TYPE, CANVAS_PERSONALIZATION_EVENT_NAME_PARAM, CANVAS_PERSONALIZATION_PARAM, CANVAS_PERSONALIZATION_TAKE_PARAM, CANVAS_PERSONALIZE_SLOT, CANVAS_PERSONALIZE_TYPE, CANVAS_PUBLISHED_STATE, CANVAS_SLOT_SECTION_GROUP_TYPE_PARAM, CANVAS_SLOT_SECTION_MAX_PARAM, CANVAS_SLOT_SECTION_MIN_PARAM, CANVAS_SLOT_SECTION_NAME_PARAM, CANVAS_SLOT_SECTION_SLOT, CANVAS_SLOT_SECTION_SPECIFIC_PARAM, CANVAS_SLOT_SECTION_TYPE, CANVAS_TEST_SLOT, CANVAS_TEST_TYPE, CANVAS_TEST_VARIANT_PARAM, CANVAS_VIZ_CONTROL_PARAM, CANVAS_VIZ_DI_RULE, CANVAS_VIZ_DYNAMIC_TOKEN_RULE, CANVAS_VIZ_LOCALE_RULE, CANVAS_VIZ_QUIRKS_RULE, CanvasClient, CanvasClientError, type CanvasDefinitions, type CategoriesDeleteParameters, type CategoriesGetParameters, type CategoriesGetResponse, type CategoriesPutParameters, type Category, CategoryClient, type Channel, type ChannelMessage, ChildEnhancerBuilder, type ComponentDefinition, type ComponentDefinitionDeleteParameters, type ComponentDefinitionGetParameters, type ComponentDefinitionGetResponse, type ComponentDefinitionParameter, type ComponentDefinitionPermission, type ComponentDefinitionPutParameters, type ComponentDefinitionSlot, type ComponentDefinitionSlugSettings, type ComponentDefinitionVariant, type ComponentEnhancer, type ComponentEnhancerFunction, type ComponentEnhancerOptions, type ComponentInstance, type ComponentInstanceContextualEditing, type ComponentInstanceHistoryEntry, type ComponentInstanceHistoryGetParameters, type ComponentInstanceHistoryGetResponse, type ComponentLocationReference, type ComponentOverridability, type ComponentOverride, type ComponentOverrides, type ComponentParameter, type ComponentParameterBlock, type ComponentParameterConditionalValue, type ComponentParameterContextualEditing, type ComponentParameterEnhancer, type ComponentParameterEnhancerFunction, type ComponentParameterEnhancerOptions, type CompositionDeleteParameters, type CompositionFilters, type CompositionGetByComponentIdParameters, type CompositionGetByIdParameters, type CompositionGetByNodeIdParameters, type CompositionGetByNodePathParameters, type CompositionGetBySlugParameters, type CompositionGetListResponse, type CompositionGetParameters, type CompositionGetResponse, type CompositionGetValidResponses, type CompositionPutParameters, type CompositionResolvedGetResponse, type CompositionResolvedListResponse, type CompositionUIStatus, ContentClient, type ContentType, type ContentTypeField, type ContentTypePreviewConfiguration, type ContextStorageUpdatedMessage, type ContextualEditingComponentReference, type ContextualEditingValue, type CopiedComponentSubtree, type DataDiagnostic, type DataElementBindingIssue, type DataElementConnectionDefinition, type DataElementConnectionFailureAction, type DataElementConnectionFailureLogLevel, type DataResolutionConfigIssue, type DataResolutionIssue, type DataResolutionOption, type DataResolutionOptionNegative, type DataResolutionOptionPositive, type DataResolutionParameters, type DataResourceDefinition, type DataResourceDefinitions, type DataResourceIssue, type DataResourceVariables, type DataSource, DataSourceClient, type DataSourceDeleteParameters, type DataSourceGetParameters, type DataSourceGetResponse, type DataSourcePutParameters, type DataSourceVariantData, type DataSourceVariantsKeys, type DataSourcesGetParameters, type DataSourcesGetResponse, type DataType, DataTypeClient, type DataTypeDeleteParameters, type DataTypeGetParameters, type DataTypeGetResponse, type DataTypePutParameters, type DataVariableDefinition, type DataWithProperties, type DateParamConfig, type DateParamValue, type DatetimeParamConfig, type DeleteContentTypeOptions, type DeleteEntryOptions, type DismissPlaceholderMessage, type DynamicInputIssue, EDGE_CACHE_DISABLED, EDGE_DEFAULT_CACHE_TTL, EDGE_MAX_CACHE_TTL, EDGE_MIN_CACHE_TTL, EMPTY_COMPOSITION, type EdgehancersDiagnostics, type EdgehancersWholeResponseCacheDiagnostics, type EditorStateUpdatedMessage, EnhancerBuilder, type EnhancerContext, type EnhancerError, EntityReleasesClient, type EntityReleasesGetParameters, type EntityReleasesGetResponse, type EntriesGetParameters, type EntriesGetResponse, type EntriesHistoryGetParameters, type EntriesHistoryGetResponse, type EntriesResolvedListResponse, type Entry, type EntryData, type EntryFilters, type EntryList, type EvaluateCriteriaGroupOptions, type EvaluateNodeTreeVisibilityOptions, type EvaluateNodeVisibilityParameterOptions, type EvaluatePropertyCriteriaOptions, type EvaluateWalkTreePropertyCriteriaOptions, type Filters, type FindInNodeTreeReference, type FlattenProperty, type FlattenValues, type FlattenValuesOptions, type GetContentTypesOptions, type GetContentTypesResponse, type GetEffectivePropertyValueOptions, type GetEntriesOptions, type GetEntriesResponse, type GetParameterAttributesProps, IN_CONTEXT_EDITOR_COMPONENT_END_ROLE, IN_CONTEXT_EDITOR_COMPONENT_START_ROLE, IN_CONTEXT_EDITOR_CONFIG_CHECK_QUERY_STRING_PARAM, IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID, IN_CONTEXT_EDITOR_FORCED_SETTINGS_QUERY_STRING_PARAM, IN_CONTEXT_EDITOR_PLAYGROUND_QUERY_STRING_PARAM, IN_CONTEXT_EDITOR_QUERY_STRING_PARAM, IS_RENDERED_BY_UNIFORM_ATTRIBUTE, IntegrationPropertyEditorsClient, type IntegrationPropertyEditorsDeleteParameters, type IntegrationPropertyEditorsGetParameters, type IntegrationPropertyEditorsGetResponse, type paths$9 as IntegrationPropertyEditorsPaths, type IntegrationPropertyEditorsPutParameters, type InvalidationPayload, LOCALE_DYNAMIC_INPUT_NAME, type Label, LabelClient, type LabelDelete, type LabelPut, type LabelsQuery, type LabelsResponse, type LimitPolicy, type LinkParamConfiguration, type LinkParamValue, type LinkParameterType, type LinkTypeConfiguration, type Locale, LocaleClient, type LocaleDeleteParameters, type LocalePutParameters, type LocalesGetParameters, type LocalesGetResponse, type LocalizeOptions, type MaxDepthExceededIssue, type MessageHandler, type MoveComponentMessage, type MultiSelectParamConfiguration, type MultiSelectParamEditorType, type MultiSelectParamValue, type NodeLocationReference, type NonProjectMapLinkParamValue, type NumberParamConfig, type NumberParamEditorType, type NumberParamValue, type OpenParameterEditorMessage, type OverrideOptions, PLACEHOLDER_ID, type ParamTypeConfigConventions, type PatternIssue, PreviewClient, type PreviewPanelSettings, type PreviewUrl, type PreviewUrlDeleteParameters, type PreviewUrlDeleteResponse, type PreviewUrlPutParameters, type PreviewUrlPutResponse, type PreviewUrlsGetParameters, type PreviewUrlsGetResponse, type PreviewViewport, type PreviewViewportDeleteParameters, type PreviewViewportDeleteResponse, type PreviewViewportPutParameters, type PreviewViewportPutResponse, type PreviewViewportsGetParameters, type PreviewViewportsGetResponse, type Project, ProjectClient, type ProjectDeleteParameters, type ProjectGetParameters, type ProjectGetResponse, type ProjectMapLinkParamValue, type ProjectPutParameters, type ProjectPutResponse, type 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, type ReadyMessage, RelationshipClient, type RelationshipResultInstance, type Release, ReleaseClient, type ReleaseContent, ReleaseContentsClient, type ReleaseContentsDeleteBody, type ReleaseContentsGetParameters, type ReleaseContentsGetResponse, type ReleaseDeleteParameters, type ReleasePatchParameters, type ReleasePutParameters, type ReleaseState, type ReleasesGetParameters, type ReleasesGetResponse, type ReportRenderedCompositionsMessage, type RequestComponentSuggestionMessage, type RequestPageHtmlMessage, type ResolvedRouteGetResponse, type RichTextBuiltInElement, type RichTextBuiltInFormat, type RichTextParamConfiguration, type RichTextParamValue, type RootComponentInstance, type RootEntryReference, type RootLocationReference, RouteClient, type RouteDynamicInputs, type RouteGetParameters, type RouteGetResponse, type RouteGetResponseComposition, type RouteGetResponseEdgehancedComposition, type RouteGetResponseEdgehancedNotFound, type RouteGetResponseNotFound, type RouteGetResponseRedirect, SECRET_QUERY_STRING_PARAM, type SelectComponentMessage, type SelectParamConfiguration, type SelectParamEditorType, type SelectParamOption, type SelectParamValue, type SelectParameterMessage, type SendPageHtmlMessage, type SpecificProjectMap, type StringOperators, type SuggestComponentMessage, type TextParamConfig, type TextParamValue, type TreeNodeInfoTypes, type TriggerComponentActionMessage, type TriggerCompositionActionMessage, UncachedCanvasClient, UncachedCategoryClient, UncachedContentClient, UncachedLabelClient, UniqueBatchEntries, type UpdateAiActionsMessage, type UpdateComponentParameterMessage, type UpdateComponentReferencesMessage, type UpdateCompositionInternalMessage, type UpdateCompositionMessage, type UpdateCompositionOptions, type UpdateContextualEditingStateInternalMessage, type UpdateFeatureFlagsMessage, type UpdatePreviewSettingsMessage, type UpsertEntryOptions, type VisibilityCriteria, type VisibilityCriteriaEvaluationResult, type VisibilityCriteriaGroup, type VisibilityParameterValue, type VisibilityRule, type VisibilityRules, type WalkNodeTreeActions, type WalkNodeTreeOptions, type WebhookDefinition, WorkflowClient, type WorkflowDefinition, type WorkflowStage, type WorkflowStagePermission, type WorkflowStageTransition, type WorkflowStageTransitionPermission, type WorkflowsDeleteParameters, type WorkflowsGetParameters, type WorkflowsGetResponse, type WorkflowsPutParameters, autoFixParameterGroups, bindExpressionEscapeChars, bindExpressionPrefix, bindVariables, bindVariablesToObject, compose, convertEntryToPutEntry, convertToBindExpression, createBatchEnhancer, createCanvasChannel, createDynamicInputVisibilityRule, createDynamicTokenVisibilityRule, createLimitPolicy, createLocaleVisibilityRule, createQuirksVisibilityRule, createUniformApiEnhancer, createVariableReference, enhance, escapeBindExpressionDefaultValue, evaluateNodeVisibilityParameter, evaluatePropertyCriteria, evaluateVisibilityCriteriaGroup, evaluateWalkTreeNodeVisibility, evaluateWalkTreePropertyCriteria, extractLocales, findParameterInNodeTree, flattenValues, generateComponentPlaceholderId, generateHash, getBlockValue, getComponentJsonPointer, getComponentPath, getDataSourceVariantFromRouteGetParams, getEffectivePropertyValue, getLocalizedPropertyValues, getNounForLocation, getNounForNode, getParameterAttributes, getPropertiesValue, hasReferencedVariables, isAddComponentMessage, isAllowedReferrer, isAssetParamValue, isAssetParamValueItem, isComponentActionMessage, isComponentPlaceholderId, isContextStorageUpdatedMessage, isDismissPlaceholderMessage, isEntryData, isLinkParamValue, isMovingComponentMessage, isNestedNodeType, isOpenParameterEditorMessage, isReadyMessage, isReportRenderedCompositionsMessage, isRequestComponentSuggestionMessage, isRootEntryReference, isSelectComponentMessage, isSelectParameterMessage, isSuggestComponentMessage, isSystemComponentDefinition, isTriggerCompositionActionMessage, isUpdateAiActionsMessage, isUpdateComponentParameterMessage, isUpdateComponentReferencesMessage, isUpdateCompositionInternalMessage, isUpdateCompositionMessage, isUpdateContextualEditingStateInternalMessage, isUpdateFeatureFlagsMessage, isUpdatePreviewSettingsMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, mergeAssetConfigWithDefaults, nullLimitPolicy, parseComponentPlaceholderId, parseVariableExpression, version, walkNodeTree, walkPropertyValues };
|