@uniformdev/canvas 20.51.0 → 20.53.1-alpha.7
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 +813 -526
- package/dist/index.d.ts +813 -526
- package/dist/index.esm.js +64 -39
- package/dist/index.js +68 -40
- package/dist/index.mjs +64 -39
- package/package.json +5 -5
package/dist/index.d.ts
CHANGED
|
@@ -8,7 +8,7 @@ import { Options as Options$1 } from 'p-retry';
|
|
|
8
8
|
import { Options } from 'p-throttle';
|
|
9
9
|
import { 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 */
|
|
@@ -1905,8 +1905,10 @@ declare const ASSET_PARAMETER_TYPE = "asset";
|
|
|
1905
1905
|
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
|
+
/** The data type ID for internal content references (entry-to-entry relationships) */
|
|
1909
|
+
declare const REFERENCE_DATA_TYPE_ID = "uniformContentInternalReference";
|
|
1908
1910
|
|
|
1909
|
-
interface components$
|
|
1911
|
+
interface components$o {
|
|
1910
1912
|
schemas: {
|
|
1911
1913
|
/** @description Defines the shape of the entry */
|
|
1912
1914
|
Entry: {
|
|
@@ -1937,14 +1939,14 @@ interface components$n {
|
|
|
1937
1939
|
_locales?: string[];
|
|
1938
1940
|
/** @description Entry field values */
|
|
1939
1941
|
fields?: {
|
|
1940
|
-
[key: string]: components$
|
|
1942
|
+
[key: string]: components$o["schemas"]["ComponentParameter"];
|
|
1941
1943
|
};
|
|
1942
|
-
_dataResources?: components$
|
|
1944
|
+
_dataResources?: components$o["schemas"]["DataResourceDefinitions"];
|
|
1943
1945
|
/** @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
|
1944
1946
|
* Means nothing for PUTs; it will be ignored
|
|
1945
1947
|
* */
|
|
1946
1948
|
_patternDataResources?: {
|
|
1947
|
-
[key: string]: components$
|
|
1949
|
+
[key: string]: components$o["schemas"]["DataResourceDefinition"];
|
|
1948
1950
|
};
|
|
1949
1951
|
/**
|
|
1950
1952
|
* @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 +1969,7 @@ interface components$n {
|
|
|
1967
1969
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
1968
1970
|
* */
|
|
1969
1971
|
_overrides?: {
|
|
1970
|
-
[key: string]: components$
|
|
1972
|
+
[key: string]: components$o["schemas"]["ComponentOverride"];
|
|
1971
1973
|
};
|
|
1972
1974
|
/** @description When used on a pattern, defines how the pattern's parameters may be overridden
|
|
1973
1975
|
* by consumers of the pattern.
|
|
@@ -1975,7 +1977,7 @@ interface components$n {
|
|
|
1975
1977
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
1976
1978
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
1977
1979
|
* */
|
|
1978
|
-
_overridability?: components$
|
|
1980
|
+
_overridability?: components$o["schemas"]["ComponentOverridability"];
|
|
1979
1981
|
};
|
|
1980
1982
|
/** @description Defines the shape of the entry input */
|
|
1981
1983
|
EntryInput: {
|
|
@@ -2002,16 +2004,16 @@ interface components$n {
|
|
|
2002
2004
|
_creatorSubject?: string;
|
|
2003
2005
|
/** @description Entry field values */
|
|
2004
2006
|
fields?: {
|
|
2005
|
-
[key: string]: components$
|
|
2007
|
+
[key: string]: components$o["schemas"]["ComponentParameter"];
|
|
2006
2008
|
};
|
|
2007
|
-
_dataResources?: components$
|
|
2009
|
+
_dataResources?: components$o["schemas"]["DataResourceDefinitions"];
|
|
2008
2010
|
/** @description Indicates this content entry should be sourced from a pattern library pattern */
|
|
2009
2011
|
_pattern?: string;
|
|
2010
2012
|
/** @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
|
2011
2013
|
* Means nothing for PUTs; it will be ignored
|
|
2012
2014
|
* */
|
|
2013
2015
|
_patternDataResources?: {
|
|
2014
|
-
[key: string]: components$
|
|
2016
|
+
[key: string]: components$o["schemas"]["DataResourceDefinition"];
|
|
2015
2017
|
};
|
|
2016
2018
|
/**
|
|
2017
2019
|
* @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 +2031,7 @@ interface components$n {
|
|
|
2029
2031
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
2030
2032
|
* */
|
|
2031
2033
|
_overrides?: {
|
|
2032
|
-
[key: string]: components$
|
|
2034
|
+
[key: string]: components$o["schemas"]["ComponentOverride"];
|
|
2033
2035
|
};
|
|
2034
2036
|
/** @description When used on a pattern, defines how the pattern's fields may be overridden
|
|
2035
2037
|
* by consumers of the pattern.
|
|
@@ -2037,7 +2039,7 @@ interface components$n {
|
|
|
2037
2039
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
2038
2040
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
2039
2041
|
* */
|
|
2040
|
-
_overridability?: components$
|
|
2042
|
+
_overridability?: components$o["schemas"]["ComponentOverridability"];
|
|
2041
2043
|
/** @description Array of locales which have data defined on the entry. If empty, the current default locale implicitly has data */
|
|
2042
2044
|
_locales?: string[];
|
|
2043
2045
|
};
|
|
@@ -2075,7 +2077,7 @@ interface components$n {
|
|
|
2075
2077
|
* @default false
|
|
2076
2078
|
*/
|
|
2077
2079
|
pattern?: boolean;
|
|
2078
|
-
entry: components$
|
|
2080
|
+
entry: components$o["schemas"]["Entry"];
|
|
2079
2081
|
/**
|
|
2080
2082
|
* Format: uuid
|
|
2081
2083
|
* @description The workflow ID that this entry is assigned. Normally comes from the content type
|
|
@@ -2087,7 +2089,7 @@ interface components$n {
|
|
|
2087
2089
|
*/
|
|
2088
2090
|
workflowStageId?: string;
|
|
2089
2091
|
/** @description The full definition of the assigned workflow, if any, including stages, permissions, etc. Only returned when `withWorkflowDefinition` is true */
|
|
2090
|
-
workflowDefinition?: components$
|
|
2092
|
+
workflowDefinition?: components$o["schemas"]["WorkflowDefinition"];
|
|
2091
2093
|
/**
|
|
2092
2094
|
* @description Only present if an incomplete entry is returned; indicates reason for stubbing
|
|
2093
2095
|
* @enum {string}
|
|
@@ -2109,7 +2111,7 @@ interface components$n {
|
|
|
2109
2111
|
editionPriority?: number;
|
|
2110
2112
|
};
|
|
2111
2113
|
EntryListResponse: {
|
|
2112
|
-
entries: components$
|
|
2114
|
+
entries: components$o["schemas"]["EntryApiResponse"][];
|
|
2113
2115
|
/** @description Total number of entries that match the query. Only present when `withTotalCount` option is true */
|
|
2114
2116
|
totalCount?: number;
|
|
2115
2117
|
/** @description Per-field counts for distinct values */
|
|
@@ -2184,12 +2186,12 @@ interface components$n {
|
|
|
2184
2186
|
* @enum {string}
|
|
2185
2187
|
*/
|
|
2186
2188
|
op?: "&" | "|";
|
|
2187
|
-
clauses: (components$
|
|
2189
|
+
clauses: (components$o["schemas"]["VisibilityCriteria"] | components$o["schemas"]["VisibilityCriteriaGroup"])[];
|
|
2188
2190
|
};
|
|
2189
2191
|
/** @description Defines a conditional value for a component parameter
|
|
2190
2192
|
* */
|
|
2191
2193
|
ComponentParameterConditionalValue: {
|
|
2192
|
-
when: components$
|
|
2194
|
+
when: components$o["schemas"]["VisibilityCriteriaGroup"];
|
|
2193
2195
|
/** @description The value of the parameter. Any JSON-serializable value is acceptable.
|
|
2194
2196
|
* A value of `null` will cause the parameter value to be removed, if it matches.
|
|
2195
2197
|
* */
|
|
@@ -2208,7 +2210,7 @@ interface components$n {
|
|
|
2208
2210
|
*
|
|
2209
2211
|
* When no locale is passed to a non-route API, conditions are not processed and all conditions are returned.
|
|
2210
2212
|
* */
|
|
2211
|
-
ComponentParameterConditions: components$
|
|
2213
|
+
ComponentParameterConditions: components$o["schemas"]["ComponentParameterConditionalValue"][];
|
|
2212
2214
|
/** @description Defines an editable parameter on a component */
|
|
2213
2215
|
ComponentParameter: {
|
|
2214
2216
|
/** @description The value of the parameter. Any JSON-serializable value is acceptable */
|
|
@@ -2216,18 +2218,18 @@ interface components$n {
|
|
|
2216
2218
|
/** @description The type of the parameter. Determines how it is displayed when editing and tells the consumer how to process it */
|
|
2217
2219
|
type: string;
|
|
2218
2220
|
/** @deprecated */
|
|
2219
|
-
connectedData?: components$
|
|
2221
|
+
connectedData?: components$o["schemas"]["DataElementConnectionDefinition"];
|
|
2220
2222
|
/** @description Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
|
|
2221
2223
|
* Note that locales must be registered on the entry/composition `_locales` before being used
|
|
2222
2224
|
* */
|
|
2223
2225
|
locales?: {
|
|
2224
2226
|
[key: string]: unknown;
|
|
2225
2227
|
};
|
|
2226
|
-
conditions?: components$
|
|
2228
|
+
conditions?: components$o["schemas"]["ComponentParameterConditions"];
|
|
2227
2229
|
/** @description Locale-specific conditional values for this parameter. Keys are locale codes, and values are the `conditions` for that locale.
|
|
2228
2230
|
* */
|
|
2229
2231
|
localesConditions?: {
|
|
2230
|
-
[key: string]: components$
|
|
2232
|
+
[key: string]: components$o["schemas"]["ComponentParameterConditions"];
|
|
2231
2233
|
};
|
|
2232
2234
|
};
|
|
2233
2235
|
/** @description Variable values for a data resource */
|
|
@@ -2249,13 +2251,13 @@ interface components$n {
|
|
|
2249
2251
|
* If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
|
|
2250
2252
|
* */
|
|
2251
2253
|
optionalPatternParameter?: boolean;
|
|
2252
|
-
variables?: components$
|
|
2254
|
+
variables?: components$o["schemas"]["DataResourceVariables"];
|
|
2253
2255
|
};
|
|
2254
2256
|
/** @description Data definitions attached to this component. The property name is the key of the data in the data document.
|
|
2255
2257
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key)
|
|
2256
2258
|
* */
|
|
2257
2259
|
DataResourceDefinitions: {
|
|
2258
|
-
[key: string]: components$
|
|
2260
|
+
[key: string]: components$o["schemas"]["DataResourceDefinition"];
|
|
2259
2261
|
};
|
|
2260
2262
|
/** @description Defines the shape of a component instance served by the composition API */
|
|
2261
2263
|
ComponentInstance: {
|
|
@@ -2263,13 +2265,13 @@ interface components$n {
|
|
|
2263
2265
|
type: string;
|
|
2264
2266
|
/** @description Component parameter values for the component instance */
|
|
2265
2267
|
parameters?: {
|
|
2266
|
-
[key: string]: components$
|
|
2268
|
+
[key: string]: components$o["schemas"]["ComponentParameter"];
|
|
2267
2269
|
};
|
|
2268
2270
|
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
|
2269
2271
|
variant?: string;
|
|
2270
2272
|
/** @description Slots containing any child components */
|
|
2271
2273
|
slots?: {
|
|
2272
|
-
[key: string]: components$
|
|
2274
|
+
[key: string]: components$o["schemas"]["ComponentInstance"][];
|
|
2273
2275
|
};
|
|
2274
2276
|
/** @description Unique identifier of the component within the composition.
|
|
2275
2277
|
* No assumptions should be made about the format of this value other than "it will be unique."
|
|
@@ -2279,14 +2281,14 @@ interface components$n {
|
|
|
2279
2281
|
_id?: string;
|
|
2280
2282
|
/** @description Indicates this component instance should be sourced from a pattern library pattern */
|
|
2281
2283
|
_pattern?: string;
|
|
2282
|
-
_dataResources?: components$
|
|
2284
|
+
_dataResources?: components$o["schemas"]["DataResourceDefinitions"];
|
|
2283
2285
|
/** @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
|
2284
2286
|
* Means nothing for PUTs; it will be ignored
|
|
2285
2287
|
* */
|
|
2286
2288
|
_patternDataResources?: {
|
|
2287
|
-
[key: string]: components$
|
|
2289
|
+
[key: string]: components$o["schemas"]["DataResourceDefinition"];
|
|
2288
2290
|
};
|
|
2289
|
-
_patternError?: components$
|
|
2291
|
+
_patternError?: components$o["schemas"]["PatternError"];
|
|
2290
2292
|
/** @description Defines patch overrides to component IDs that live in the composition.
|
|
2291
2293
|
* This can be used to override parameters that are defined on patterns,
|
|
2292
2294
|
* including nested patterns, with values that are specific to this composition.
|
|
@@ -2299,13 +2301,13 @@ interface components$n {
|
|
|
2299
2301
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
2300
2302
|
* */
|
|
2301
2303
|
_overrides?: {
|
|
2302
|
-
[key: string]: components$
|
|
2304
|
+
[key: string]: components$o["schemas"]["ComponentOverride"];
|
|
2303
2305
|
};
|
|
2304
2306
|
/** @description Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
|
|
2305
2307
|
* Means nothing for PUTs; it will be ignored
|
|
2306
2308
|
* */
|
|
2307
2309
|
_patternOverrides?: {
|
|
2308
|
-
[key: string]: components$
|
|
2310
|
+
[key: string]: components$o["schemas"]["ComponentOverride"];
|
|
2309
2311
|
};
|
|
2310
2312
|
/** @description When used on a pattern, defines how the pattern's parameters may be overridden
|
|
2311
2313
|
* by consumers of the pattern.
|
|
@@ -2313,7 +2315,7 @@ interface components$n {
|
|
|
2313
2315
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
2314
2316
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
2315
2317
|
* */
|
|
2316
|
-
_overridability?: components$
|
|
2318
|
+
_overridability?: components$o["schemas"]["ComponentOverridability"];
|
|
2317
2319
|
/** @description Array of locales that have data defined. Only set for pattern references or composition defaults */
|
|
2318
2320
|
_locales?: string[];
|
|
2319
2321
|
};
|
|
@@ -2333,10 +2335,10 @@ interface components$n {
|
|
|
2333
2335
|
* */
|
|
2334
2336
|
ComponentOverride: {
|
|
2335
2337
|
parameters?: {
|
|
2336
|
-
[key: string]: components$
|
|
2338
|
+
[key: string]: components$o["schemas"]["ComponentParameter"];
|
|
2337
2339
|
};
|
|
2338
2340
|
slots?: {
|
|
2339
|
-
[key: string]: components$
|
|
2341
|
+
[key: string]: components$o["schemas"]["ComponentInstance"][];
|
|
2340
2342
|
};
|
|
2341
2343
|
variant?: string;
|
|
2342
2344
|
/** @description Overrides data resource definitions for a pattern component.
|
|
@@ -2344,7 +2346,7 @@ interface components$n {
|
|
|
2344
2346
|
* Overrides defined here replace values in either _dataResources or _patternDataResources on the target component.
|
|
2345
2347
|
* */
|
|
2346
2348
|
dataResources?: {
|
|
2347
|
-
[key: string]: components$
|
|
2349
|
+
[key: string]: components$o["schemas"]["DataResourceDefinition"];
|
|
2348
2350
|
};
|
|
2349
2351
|
};
|
|
2350
2352
|
/**
|
|
@@ -2365,7 +2367,7 @@ interface components$n {
|
|
|
2365
2367
|
ComponentOverridability: {
|
|
2366
2368
|
/** @description Defines component parameter value overrides. Keys are the parameter public ID */
|
|
2367
2369
|
parameters?: {
|
|
2368
|
-
[key: string]: components$
|
|
2370
|
+
[key: string]: components$o["schemas"]["OverrideOptions"];
|
|
2369
2371
|
};
|
|
2370
2372
|
/** @description Allows overriding a display variant is allowed if it is defined on the component the pattern is derived from. Default = false */
|
|
2371
2373
|
variants?: boolean;
|
|
@@ -2402,7 +2404,7 @@ interface components$n {
|
|
|
2402
2404
|
* NOTE: Users without membership in any role listed here will be unable to execute the transition unless they are team admins
|
|
2403
2405
|
* */
|
|
2404
2406
|
permissions: {
|
|
2405
|
-
[key: string]: components$
|
|
2407
|
+
[key: string]: components$o["schemas"]["WorkflowStageTransitionPermission"];
|
|
2406
2408
|
};
|
|
2407
2409
|
};
|
|
2408
2410
|
/** @description Definition of a stage in a workflow */
|
|
@@ -2415,7 +2417,7 @@ interface components$n {
|
|
|
2415
2417
|
* listed here, the stage is read-only and publishing is disabled
|
|
2416
2418
|
* */
|
|
2417
2419
|
permissions: {
|
|
2418
|
-
[key: string]: components$
|
|
2420
|
+
[key: string]: components$o["schemas"]["WorkflowStagePermission"];
|
|
2419
2421
|
};
|
|
2420
2422
|
/** @description When true, transitioning into this stage from a different stage will automatically publish the entity.
|
|
2421
2423
|
* 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 +2434,7 @@ interface components$n {
|
|
|
2432
2434
|
* Every stage must define at least one transition, to avoid creating a workflow that
|
|
2433
2435
|
* has a stage that can never be escaped
|
|
2434
2436
|
* */
|
|
2435
|
-
transitions: components$
|
|
2437
|
+
transitions: components$o["schemas"]["WorkflowStageTransition"][];
|
|
2436
2438
|
/**
|
|
2437
2439
|
* @description Icon name for the stage (e.g. 'chevron-double-right-o')
|
|
2438
2440
|
* @default chevron-double-right-o
|
|
@@ -2457,7 +2459,7 @@ interface components$n {
|
|
|
2457
2459
|
initialStage: string;
|
|
2458
2460
|
/** @description All stages of the workflow */
|
|
2459
2461
|
stages: {
|
|
2460
|
-
[key: string]: components$
|
|
2462
|
+
[key: string]: components$o["schemas"]["WorkflowStage"];
|
|
2461
2463
|
};
|
|
2462
2464
|
/** @description Last modified ISO date string for this definition (ignored for writes) */
|
|
2463
2465
|
modified?: string;
|
|
@@ -2605,7 +2607,7 @@ interface components$n {
|
|
|
2605
2607
|
pathItems: never;
|
|
2606
2608
|
}
|
|
2607
2609
|
|
|
2608
|
-
interface paths$
|
|
2610
|
+
interface paths$l {
|
|
2609
2611
|
"/api/v1/content-types": {
|
|
2610
2612
|
parameters: {
|
|
2611
2613
|
query?: never;
|
|
@@ -2639,15 +2641,15 @@ interface paths$k {
|
|
|
2639
2641
|
content: {
|
|
2640
2642
|
"application/json": {
|
|
2641
2643
|
/** @description Content types that match the query */
|
|
2642
|
-
contentTypes: components$
|
|
2644
|
+
contentTypes: components$n["schemas"]["ContentType"][];
|
|
2643
2645
|
};
|
|
2644
2646
|
};
|
|
2645
2647
|
};
|
|
2646
|
-
400: components$
|
|
2647
|
-
401: components$
|
|
2648
|
-
403: components$
|
|
2649
|
-
429: components$
|
|
2650
|
-
500: components$
|
|
2648
|
+
400: components$n["responses"]["BadRequestError"];
|
|
2649
|
+
401: components$n["responses"]["UnauthorizedError"];
|
|
2650
|
+
403: components$n["responses"]["ForbiddenError"];
|
|
2651
|
+
429: components$n["responses"]["RateLimitError"];
|
|
2652
|
+
500: components$n["responses"]["InternalServerError"];
|
|
2651
2653
|
};
|
|
2652
2654
|
};
|
|
2653
2655
|
/** @description Upserts a content type */
|
|
@@ -2666,7 +2668,7 @@ interface paths$k {
|
|
|
2666
2668
|
* @description The project ID to upsert the content type to
|
|
2667
2669
|
*/
|
|
2668
2670
|
projectId: string;
|
|
2669
|
-
contentType: components$
|
|
2671
|
+
contentType: components$n["schemas"]["ContentType"];
|
|
2670
2672
|
};
|
|
2671
2673
|
};
|
|
2672
2674
|
};
|
|
@@ -2678,11 +2680,11 @@ interface paths$k {
|
|
|
2678
2680
|
};
|
|
2679
2681
|
content?: never;
|
|
2680
2682
|
};
|
|
2681
|
-
400: components$
|
|
2682
|
-
401: components$
|
|
2683
|
-
403: components$
|
|
2684
|
-
429: components$
|
|
2685
|
-
500: components$
|
|
2683
|
+
400: components$n["responses"]["BadRequestError"];
|
|
2684
|
+
401: components$n["responses"]["UnauthorizedError"];
|
|
2685
|
+
403: components$n["responses"]["ForbiddenError"];
|
|
2686
|
+
429: components$n["responses"]["RateLimitError"];
|
|
2687
|
+
500: components$n["responses"]["InternalServerError"];
|
|
2686
2688
|
};
|
|
2687
2689
|
};
|
|
2688
2690
|
post?: never;
|
|
@@ -2715,11 +2717,11 @@ interface paths$k {
|
|
|
2715
2717
|
};
|
|
2716
2718
|
content?: never;
|
|
2717
2719
|
};
|
|
2718
|
-
400: components$
|
|
2719
|
-
401: components$
|
|
2720
|
-
403: components$
|
|
2721
|
-
429: components$
|
|
2722
|
-
500: components$
|
|
2720
|
+
400: components$n["responses"]["BadRequestError"];
|
|
2721
|
+
401: components$n["responses"]["UnauthorizedError"];
|
|
2722
|
+
403: components$n["responses"]["ForbiddenError"];
|
|
2723
|
+
429: components$n["responses"]["RateLimitError"];
|
|
2724
|
+
500: components$n["responses"]["InternalServerError"];
|
|
2723
2725
|
};
|
|
2724
2726
|
};
|
|
2725
2727
|
/** @description Handles preflight requests. This endpoint allows CORS */
|
|
@@ -2746,13 +2748,13 @@ interface paths$k {
|
|
|
2746
2748
|
trace?: never;
|
|
2747
2749
|
};
|
|
2748
2750
|
}
|
|
2749
|
-
interface components$
|
|
2751
|
+
interface components$n {
|
|
2750
2752
|
schemas: {
|
|
2751
2753
|
/** @description Public ID (used in code). Do not change after creation */
|
|
2752
2754
|
PublicIdProperty: string;
|
|
2753
2755
|
/** @description The definition of a component parameter */
|
|
2754
2756
|
ComponentDefinitionParameter: {
|
|
2755
|
-
id: components$
|
|
2757
|
+
id: components$n["schemas"]["PublicIdProperty"];
|
|
2756
2758
|
/** @description Friendly name of the parameter */
|
|
2757
2759
|
name: string;
|
|
2758
2760
|
/** @description Appears next to the parameter in the Composition editor */
|
|
@@ -2811,7 +2813,7 @@ interface components$m {
|
|
|
2811
2813
|
};
|
|
2812
2814
|
/** @description Permission set for a component definition */
|
|
2813
2815
|
ComponentDefinitionPermission: {
|
|
2814
|
-
roleId: components$
|
|
2816
|
+
roleId: components$n["schemas"]["PublicIdProperty"];
|
|
2815
2817
|
/**
|
|
2816
2818
|
* @description Permission type for this permission ComponentDefinition:
|
|
2817
2819
|
* read | write | create | delete
|
|
@@ -2843,7 +2845,7 @@ interface components$m {
|
|
|
2843
2845
|
};
|
|
2844
2846
|
/** @description Defines a content type */
|
|
2845
2847
|
ContentType: {
|
|
2846
|
-
id: components$
|
|
2848
|
+
id: components$n["schemas"]["PublicIdProperty"];
|
|
2847
2849
|
/** @description Friendly name of the content type */
|
|
2848
2850
|
name: string;
|
|
2849
2851
|
/** @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 +2859,7 @@ interface components$m {
|
|
|
2857
2859
|
*/
|
|
2858
2860
|
thumbnailField?: string | null;
|
|
2859
2861
|
/** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
|
|
2860
|
-
fields?: components$
|
|
2862
|
+
fields?: components$n["schemas"]["ComponentDefinitionParameter"][];
|
|
2861
2863
|
/** @description Description of the content type */
|
|
2862
2864
|
description?: string;
|
|
2863
2865
|
/**
|
|
@@ -2869,7 +2871,7 @@ interface components$m {
|
|
|
2869
2871
|
created?: string;
|
|
2870
2872
|
/** @description Last modified date string for this content type (ignored for writes) */
|
|
2871
2873
|
updated?: string;
|
|
2872
|
-
slugSettings?: components$
|
|
2874
|
+
slugSettings?: components$n["schemas"]["ComponentDefinitionSlugSettings"];
|
|
2873
2875
|
/**
|
|
2874
2876
|
* @description The definition type of this content type (block or content type)
|
|
2875
2877
|
* @default contentType
|
|
@@ -2882,14 +2884,14 @@ interface components$m {
|
|
|
2882
2884
|
*/
|
|
2883
2885
|
useTeamPermissions?: boolean;
|
|
2884
2886
|
/** @description Custom role permissions for this content type */
|
|
2885
|
-
permissions?: components$
|
|
2887
|
+
permissions?: components$n["schemas"]["ComponentDefinitionPermission"][];
|
|
2886
2888
|
/**
|
|
2887
2889
|
* Format: uuid
|
|
2888
2890
|
* @description ID of the workflow that instances of this content type will use by default. When not set, no workflow is attached
|
|
2889
2891
|
*/
|
|
2890
2892
|
workflowId?: string;
|
|
2891
2893
|
/** @description Configurations for previewing an entry on a consuming pattern or composition. */
|
|
2892
|
-
previewConfigurations?: components$
|
|
2894
|
+
previewConfigurations?: components$n["schemas"]["ContentTypePreviewConfiguration"][];
|
|
2893
2895
|
};
|
|
2894
2896
|
Error: {
|
|
2895
2897
|
/** @description Error message(s) that occurred while processing the request */
|
|
@@ -2903,7 +2905,7 @@ interface components$m {
|
|
|
2903
2905
|
[name: string]: unknown;
|
|
2904
2906
|
};
|
|
2905
2907
|
content: {
|
|
2906
|
-
"application/json": components$
|
|
2908
|
+
"application/json": components$n["schemas"]["Error"];
|
|
2907
2909
|
};
|
|
2908
2910
|
};
|
|
2909
2911
|
/** @description API key or token was not valid */
|
|
@@ -2912,7 +2914,7 @@ interface components$m {
|
|
|
2912
2914
|
[name: string]: unknown;
|
|
2913
2915
|
};
|
|
2914
2916
|
content: {
|
|
2915
|
-
"application/json": components$
|
|
2917
|
+
"application/json": components$n["schemas"]["Error"];
|
|
2916
2918
|
};
|
|
2917
2919
|
};
|
|
2918
2920
|
/** @description Permission was denied */
|
|
@@ -2921,7 +2923,7 @@ interface components$m {
|
|
|
2921
2923
|
[name: string]: unknown;
|
|
2922
2924
|
};
|
|
2923
2925
|
content: {
|
|
2924
|
-
"application/json": components$
|
|
2926
|
+
"application/json": components$n["schemas"]["Error"];
|
|
2925
2927
|
};
|
|
2926
2928
|
};
|
|
2927
2929
|
/** @description Too many requests in allowed time period */
|
|
@@ -2945,7 +2947,7 @@ interface components$m {
|
|
|
2945
2947
|
pathItems: never;
|
|
2946
2948
|
}
|
|
2947
2949
|
|
|
2948
|
-
interface paths$
|
|
2950
|
+
interface paths$k {
|
|
2949
2951
|
"/api/v1/entries": {
|
|
2950
2952
|
parameters: {
|
|
2951
2953
|
query?: never;
|
|
@@ -2960,86 +2962,86 @@ interface paths$j {
|
|
|
2960
2962
|
* When `editions=raw`, this matches on edition IDs or entry IDs and edition resolution is disabled.
|
|
2961
2963
|
* When `versionId` is passed, this parameter is required and must contain only one entry ID.
|
|
2962
2964
|
* */
|
|
2963
|
-
entryIDs?: components$
|
|
2965
|
+
entryIDs?: components$m["parameters"]["entryIDs"];
|
|
2964
2966
|
/** @description Specify a historical entry version ID to fetch (retrieved from the entries-history API).
|
|
2965
2967
|
* Must be used with the `entryIDs` parameter, and there must be only one entryID passed
|
|
2966
2968
|
* */
|
|
2967
|
-
versionId?: components$
|
|
2969
|
+
versionId?: components$m["parameters"]["versionId"];
|
|
2968
2970
|
/** @description Specify a single entry to fetch by slug */
|
|
2969
|
-
slug?: components$
|
|
2971
|
+
slug?: components$m["parameters"]["slug"];
|
|
2970
2972
|
/** @description Filters entry lists by the user who created them. The user is specified by their identity subject
|
|
2971
2973
|
* */
|
|
2972
|
-
createdBy?: components$
|
|
2974
|
+
createdBy?: components$m["parameters"]["createdBy"];
|
|
2973
2975
|
/** @description Max number of records to return */
|
|
2974
|
-
limit?: components$
|
|
2976
|
+
limit?: components$m["parameters"]["limit"];
|
|
2975
2977
|
/** @description Number of records to skip */
|
|
2976
|
-
offset?: components$
|
|
2978
|
+
offset?: components$m["parameters"]["offset"];
|
|
2977
2979
|
/** @description Sets the sorting of the results. If unspecified, results are sorted by modification date descending.
|
|
2978
2980
|
* Allowed values are: updated_at_DESC, updated_at_ASC, created_at_DESC, created_at_ASC, name_DESC, name_ASC, slug_DESC, slug_ASC
|
|
2979
2981
|
* */
|
|
2980
|
-
orderBy?: components$
|
|
2982
|
+
orderBy?: components$m["parameters"]["orderBy"];
|
|
2981
2983
|
/**
|
|
2982
2984
|
* @deprecated
|
|
2983
2985
|
* @description Returns counts for distinct values of the specified field or fields (provided as comma-separated IDs).
|
|
2984
2986
|
*/
|
|
2985
|
-
facetBy?: components$
|
|
2987
|
+
facetBy?: components$m["parameters"]["facetBy"];
|
|
2986
2988
|
/** @description Matches entries based on whether they are pattern entries or regular entries.
|
|
2987
2989
|
* If true, only pattern entries will be returned.
|
|
2988
2990
|
* If false (default), only regular entries will be returned
|
|
2989
2991
|
* */
|
|
2990
|
-
pattern?: components$
|
|
2992
|
+
pattern?: components$m["parameters"]["pattern"];
|
|
2991
2993
|
/** @description The project the entry/entries are on */
|
|
2992
|
-
projectId: components$
|
|
2994
|
+
projectId: components$m["parameters"]["projectId"];
|
|
2993
2995
|
/** @description Publishing state to fetch. 0 = draft, 64 = published */
|
|
2994
|
-
state?: components$
|
|
2996
|
+
state?: components$m["parameters"]["state"];
|
|
2995
2997
|
/** @description The content type ID to filter by */
|
|
2996
|
-
type?: components$
|
|
2998
|
+
type?: components$m["parameters"]["type"];
|
|
2997
2999
|
/**
|
|
2998
3000
|
* @deprecated
|
|
2999
3001
|
* @description Filters entries lists by the UI status of the entry.
|
|
3000
3002
|
* This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data
|
|
3001
3003
|
*
|
|
3002
3004
|
*/
|
|
3003
|
-
uiStatus?: components$
|
|
3005
|
+
uiStatus?: components$m["parameters"]["uiStatus"];
|
|
3004
3006
|
/** @description Filters entry lists by the user who last updated them. The user is specified by their identity subject
|
|
3005
3007
|
* */
|
|
3006
|
-
updatedBy?: components$
|
|
3008
|
+
updatedBy?: components$m["parameters"]["updatedBy"];
|
|
3007
3009
|
/** @description Controls whether the total count of results will be returned along with the current results page in a list.
|
|
3008
3010
|
* Has no effect when not fetching a list. This does impact performance when enabled
|
|
3009
3011
|
* */
|
|
3010
|
-
withTotalCount?: components$
|
|
3012
|
+
withTotalCount?: components$m["parameters"]["withTotalCount"];
|
|
3011
3013
|
/**
|
|
3012
3014
|
* @deprecated
|
|
3013
3015
|
* @description Returns the UI status string of the entry.
|
|
3014
3016
|
* This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data
|
|
3015
3017
|
*
|
|
3016
3018
|
*/
|
|
3017
|
-
withUIStatus?: components$
|
|
3019
|
+
withUIStatus?: components$m["parameters"]["withUIStatus"];
|
|
3018
3020
|
/** @description Returns the definition of any attached workflow along with the entry data
|
|
3019
3021
|
* */
|
|
3020
|
-
withWorkflowDefinition?: components$
|
|
3022
|
+
withWorkflowDefinition?: components$m["parameters"]["withWorkflowDefinition"];
|
|
3021
3023
|
/** @description If true the `_id` unique identifier of blocks will be part of the response data.
|
|
3022
3024
|
* If false, the `_id` will not be present in the API response
|
|
3023
3025
|
* */
|
|
3024
|
-
withComponentIDs?: components$
|
|
3026
|
+
withComponentIDs?: components$m["parameters"]["withComponentIDs"];
|
|
3025
3027
|
/** @description Performs keyword search on the entries */
|
|
3026
|
-
keyword?: components$
|
|
3028
|
+
keyword?: components$m["parameters"]["keyword"];
|
|
3027
3029
|
/** @description If true, any pattern references in the composition will be left unresolved.
|
|
3028
3030
|
* This is appropriate if you intend to serialize the composition without patterns
|
|
3029
3031
|
* embedded into it, and serialize the pattern data separately
|
|
3030
3032
|
* */
|
|
3031
|
-
skipPatternResolution?: components$
|
|
3033
|
+
skipPatternResolution?: components$m["parameters"]["skipPatternResolution"];
|
|
3032
3034
|
/**
|
|
3033
3035
|
* @deprecated
|
|
3034
3036
|
* @description This parameter is unused and has no effect. Passing this parameter will become an error in the future
|
|
3035
3037
|
*
|
|
3036
3038
|
*/
|
|
3037
|
-
skipParameterResolution?: components$
|
|
3039
|
+
skipParameterResolution?: components$m["parameters"]["skipParameterResolution"];
|
|
3038
3040
|
/** @description If true, any pattern override data is not resolved by the API.
|
|
3039
3041
|
* This is intended for internal use in the Canvas editor, and should not be used.
|
|
3040
3042
|
* Passing this parameter automatically implies withComponentIDs to be true
|
|
3041
3043
|
* */
|
|
3042
|
-
skipOverridesResolution?: components$
|
|
3044
|
+
skipOverridesResolution?: components$m["parameters"]["skipOverridesResolution"];
|
|
3043
3045
|
/** @description One or more locales to filter and localize by.
|
|
3044
3046
|
* Only entries that enable one of the specified locales _or enable no locales_ will be returned.
|
|
3045
3047
|
* The response will be localized to include only the first matching locale's data.
|
|
@@ -3051,7 +3053,7 @@ interface paths$j {
|
|
|
3051
3053
|
*
|
|
3052
3054
|
* When this parameter is not passed, all locales' data will be returned
|
|
3053
3055
|
* */
|
|
3054
|
-
locale?: components$
|
|
3056
|
+
locale?: components$m["parameters"]["locale"];
|
|
3055
3057
|
/** @description The ID of a release to fetch the content for.
|
|
3056
3058
|
*
|
|
3057
3059
|
* - When unspecified, all release content is excluded from the result(s).
|
|
@@ -3059,12 +3061,12 @@ interface paths$j {
|
|
|
3059
3061
|
*
|
|
3060
3062
|
* 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
3063
|
* */
|
|
3062
|
-
releaseId?: components$
|
|
3064
|
+
releaseId?: components$m["parameters"]["releaseId"];
|
|
3063
3065
|
/** @description Search on textual fields of an entry.
|
|
3064
3066
|
* Note: for long text fields the tail of the text is not guaranteed to be searchable.
|
|
3065
3067
|
* Example: ?search=hello
|
|
3066
3068
|
* */
|
|
3067
|
-
search?: components$
|
|
3069
|
+
search?: components$m["parameters"]["search"];
|
|
3068
3070
|
/** @description Controls the edition resolution behavior.
|
|
3069
3071
|
*
|
|
3070
3072
|
* auto: (default) Editions are evaluated automatically and the best matching edition is returned.
|
|
@@ -3077,7 +3079,7 @@ interface paths$j {
|
|
|
3077
3079
|
* entryIDs MUST be provided with this option.
|
|
3078
3080
|
* If versionId is passed, this is always enabled.
|
|
3079
3081
|
* */
|
|
3080
|
-
editions?: components$
|
|
3082
|
+
editions?: components$m["parameters"]["editions"];
|
|
3081
3083
|
};
|
|
3082
3084
|
header?: never;
|
|
3083
3085
|
path?: never;
|
|
@@ -3091,12 +3093,12 @@ interface paths$j {
|
|
|
3091
3093
|
[name: string]: unknown;
|
|
3092
3094
|
};
|
|
3093
3095
|
content: {
|
|
3094
|
-
"application/json": components$
|
|
3096
|
+
"application/json": components$m["schemas"]["EntryListResponse"];
|
|
3095
3097
|
};
|
|
3096
3098
|
};
|
|
3097
|
-
400: components$
|
|
3098
|
-
401: components$
|
|
3099
|
-
403: components$
|
|
3099
|
+
400: components$m["responses"]["BadRequestError"];
|
|
3100
|
+
401: components$m["responses"]["UnauthorizedError"];
|
|
3101
|
+
403: components$m["responses"]["ForbiddenError"];
|
|
3100
3102
|
/** @description Entry not found */
|
|
3101
3103
|
404: {
|
|
3102
3104
|
headers: {
|
|
@@ -3106,8 +3108,8 @@ interface paths$j {
|
|
|
3106
3108
|
"text/plain": string;
|
|
3107
3109
|
};
|
|
3108
3110
|
};
|
|
3109
|
-
429: components$
|
|
3110
|
-
500: components$
|
|
3111
|
+
429: components$m["responses"]["RateLimitError"];
|
|
3112
|
+
500: components$m["responses"]["InternalServerError"];
|
|
3111
3113
|
};
|
|
3112
3114
|
};
|
|
3113
3115
|
/** @description Upserts an entry */
|
|
@@ -3134,7 +3136,7 @@ interface paths$j {
|
|
|
3134
3136
|
projectId: string;
|
|
3135
3137
|
/** @description The publishing state to upsert into. 0 = draft, 64 = published */
|
|
3136
3138
|
state: number;
|
|
3137
|
-
entry: components$
|
|
3139
|
+
entry: components$m["schemas"]["EntryInput"];
|
|
3138
3140
|
/** @description Ignored if present */
|
|
3139
3141
|
created?: string;
|
|
3140
3142
|
/** @description Ignored if present */
|
|
@@ -3184,9 +3186,9 @@ interface paths$j {
|
|
|
3184
3186
|
};
|
|
3185
3187
|
content?: never;
|
|
3186
3188
|
};
|
|
3187
|
-
400: components$
|
|
3188
|
-
401: components$
|
|
3189
|
-
403: components$
|
|
3189
|
+
400: components$m["responses"]["BadRequestError"];
|
|
3190
|
+
401: components$m["responses"]["UnauthorizedError"];
|
|
3191
|
+
403: components$m["responses"]["ForbiddenError"];
|
|
3190
3192
|
/** @description Conflict - Entry has been changed since being loaded */
|
|
3191
3193
|
409: {
|
|
3192
3194
|
headers: {
|
|
@@ -3196,8 +3198,8 @@ interface paths$j {
|
|
|
3196
3198
|
"text/plain": string;
|
|
3197
3199
|
};
|
|
3198
3200
|
};
|
|
3199
|
-
429: components$
|
|
3200
|
-
500: components$
|
|
3201
|
+
429: components$m["responses"]["RateLimitError"];
|
|
3202
|
+
500: components$m["responses"]["InternalServerError"];
|
|
3201
3203
|
};
|
|
3202
3204
|
};
|
|
3203
3205
|
post?: never;
|
|
@@ -3253,11 +3255,11 @@ interface paths$j {
|
|
|
3253
3255
|
};
|
|
3254
3256
|
content?: never;
|
|
3255
3257
|
};
|
|
3256
|
-
400: components$
|
|
3257
|
-
401: components$
|
|
3258
|
-
403: components$
|
|
3259
|
-
429: components$
|
|
3260
|
-
500: components$
|
|
3258
|
+
400: components$m["responses"]["BadRequestError"];
|
|
3259
|
+
401: components$m["responses"]["UnauthorizedError"];
|
|
3260
|
+
403: components$m["responses"]["ForbiddenError"];
|
|
3261
|
+
429: components$m["responses"]["RateLimitError"];
|
|
3262
|
+
500: components$m["responses"]["InternalServerError"];
|
|
3261
3263
|
};
|
|
3262
3264
|
};
|
|
3263
3265
|
/** @description Handles preflight requests. This endpoint allows CORS */
|
|
@@ -3284,7 +3286,7 @@ interface paths$j {
|
|
|
3284
3286
|
trace?: never;
|
|
3285
3287
|
};
|
|
3286
3288
|
}
|
|
3287
|
-
interface components$
|
|
3289
|
+
interface components$m {
|
|
3288
3290
|
schemas: {
|
|
3289
3291
|
/** @description Defines a connection to a dynamic token on a data resource
|
|
3290
3292
|
* */
|
|
@@ -3351,12 +3353,12 @@ interface components$l {
|
|
|
3351
3353
|
* @enum {string}
|
|
3352
3354
|
*/
|
|
3353
3355
|
op?: "&" | "|";
|
|
3354
|
-
clauses: (components$
|
|
3356
|
+
clauses: (components$m["schemas"]["VisibilityCriteria"] | components$m["schemas"]["VisibilityCriteriaGroup"])[];
|
|
3355
3357
|
};
|
|
3356
3358
|
/** @description Defines a conditional value for a component parameter
|
|
3357
3359
|
* */
|
|
3358
3360
|
ComponentParameterConditionalValue: {
|
|
3359
|
-
when: components$
|
|
3361
|
+
when: components$m["schemas"]["VisibilityCriteriaGroup"];
|
|
3360
3362
|
/** @description The value of the parameter. Any JSON-serializable value is acceptable.
|
|
3361
3363
|
* A value of `null` will cause the parameter value to be removed, if it matches.
|
|
3362
3364
|
* */
|
|
@@ -3375,7 +3377,7 @@ interface components$l {
|
|
|
3375
3377
|
*
|
|
3376
3378
|
* When no locale is passed to a non-route API, conditions are not processed and all conditions are returned.
|
|
3377
3379
|
* */
|
|
3378
|
-
ComponentParameterConditions: components$
|
|
3380
|
+
ComponentParameterConditions: components$m["schemas"]["ComponentParameterConditionalValue"][];
|
|
3379
3381
|
/** @description Defines an editable parameter on a component */
|
|
3380
3382
|
ComponentParameter: {
|
|
3381
3383
|
/** @description The value of the parameter. Any JSON-serializable value is acceptable */
|
|
@@ -3383,18 +3385,18 @@ interface components$l {
|
|
|
3383
3385
|
/** @description The type of the parameter. Determines how it is displayed when editing and tells the consumer how to process it */
|
|
3384
3386
|
type: string;
|
|
3385
3387
|
/** @deprecated */
|
|
3386
|
-
connectedData?: components$
|
|
3388
|
+
connectedData?: components$m["schemas"]["DataElementConnectionDefinition"];
|
|
3387
3389
|
/** @description Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
|
|
3388
3390
|
* Note that locales must be registered on the entry/composition `_locales` before being used
|
|
3389
3391
|
* */
|
|
3390
3392
|
locales?: {
|
|
3391
3393
|
[key: string]: unknown;
|
|
3392
3394
|
};
|
|
3393
|
-
conditions?: components$
|
|
3395
|
+
conditions?: components$m["schemas"]["ComponentParameterConditions"];
|
|
3394
3396
|
/** @description Locale-specific conditional values for this parameter. Keys are locale codes, and values are the `conditions` for that locale.
|
|
3395
3397
|
* */
|
|
3396
3398
|
localesConditions?: {
|
|
3397
|
-
[key: string]: components$
|
|
3399
|
+
[key: string]: components$m["schemas"]["ComponentParameterConditions"];
|
|
3398
3400
|
};
|
|
3399
3401
|
};
|
|
3400
3402
|
/** @description Variable values for a data resource */
|
|
@@ -3416,13 +3418,13 @@ interface components$l {
|
|
|
3416
3418
|
* If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
|
|
3417
3419
|
* */
|
|
3418
3420
|
optionalPatternParameter?: boolean;
|
|
3419
|
-
variables?: components$
|
|
3421
|
+
variables?: components$m["schemas"]["DataResourceVariables"];
|
|
3420
3422
|
};
|
|
3421
3423
|
/** @description Data definitions attached to this component. The property name is the key of the data in the data document.
|
|
3422
3424
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key)
|
|
3423
3425
|
* */
|
|
3424
3426
|
DataResourceDefinitions: {
|
|
3425
|
-
[key: string]: components$
|
|
3427
|
+
[key: string]: components$m["schemas"]["DataResourceDefinition"];
|
|
3426
3428
|
};
|
|
3427
3429
|
/** @description Defines the shape of a component instance served by the composition API */
|
|
3428
3430
|
ComponentInstance: {
|
|
@@ -3430,13 +3432,13 @@ interface components$l {
|
|
|
3430
3432
|
type: string;
|
|
3431
3433
|
/** @description Component parameter values for the component instance */
|
|
3432
3434
|
parameters?: {
|
|
3433
|
-
[key: string]: components$
|
|
3435
|
+
[key: string]: components$m["schemas"]["ComponentParameter"];
|
|
3434
3436
|
};
|
|
3435
3437
|
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
|
3436
3438
|
variant?: string;
|
|
3437
3439
|
/** @description Slots containing any child components */
|
|
3438
3440
|
slots?: {
|
|
3439
|
-
[key: string]: components$
|
|
3441
|
+
[key: string]: components$m["schemas"]["ComponentInstance"][];
|
|
3440
3442
|
};
|
|
3441
3443
|
/** @description Unique identifier of the component within the composition.
|
|
3442
3444
|
* No assumptions should be made about the format of this value other than "it will be unique."
|
|
@@ -3446,14 +3448,14 @@ interface components$l {
|
|
|
3446
3448
|
_id?: string;
|
|
3447
3449
|
/** @description Indicates this component instance should be sourced from a pattern library pattern */
|
|
3448
3450
|
_pattern?: string;
|
|
3449
|
-
_dataResources?: components$
|
|
3451
|
+
_dataResources?: components$m["schemas"]["DataResourceDefinitions"];
|
|
3450
3452
|
/** @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
|
3451
3453
|
* Means nothing for PUTs; it will be ignored
|
|
3452
3454
|
* */
|
|
3453
3455
|
_patternDataResources?: {
|
|
3454
|
-
[key: string]: components$
|
|
3456
|
+
[key: string]: components$m["schemas"]["DataResourceDefinition"];
|
|
3455
3457
|
};
|
|
3456
|
-
_patternError?: components$
|
|
3458
|
+
_patternError?: components$m["schemas"]["PatternError"];
|
|
3457
3459
|
/** @description Defines patch overrides to component IDs that live in the composition.
|
|
3458
3460
|
* This can be used to override parameters that are defined on patterns,
|
|
3459
3461
|
* including nested patterns, with values that are specific to this composition.
|
|
@@ -3466,13 +3468,13 @@ interface components$l {
|
|
|
3466
3468
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
3467
3469
|
* */
|
|
3468
3470
|
_overrides?: {
|
|
3469
|
-
[key: string]: components$
|
|
3471
|
+
[key: string]: components$m["schemas"]["ComponentOverride"];
|
|
3470
3472
|
};
|
|
3471
3473
|
/** @description Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
|
|
3472
3474
|
* Means nothing for PUTs; it will be ignored
|
|
3473
3475
|
* */
|
|
3474
3476
|
_patternOverrides?: {
|
|
3475
|
-
[key: string]: components$
|
|
3477
|
+
[key: string]: components$m["schemas"]["ComponentOverride"];
|
|
3476
3478
|
};
|
|
3477
3479
|
/** @description When used on a pattern, defines how the pattern's parameters may be overridden
|
|
3478
3480
|
* by consumers of the pattern.
|
|
@@ -3480,7 +3482,7 @@ interface components$l {
|
|
|
3480
3482
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
3481
3483
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
3482
3484
|
* */
|
|
3483
|
-
_overridability?: components$
|
|
3485
|
+
_overridability?: components$m["schemas"]["ComponentOverridability"];
|
|
3484
3486
|
/** @description Array of locales that have data defined. Only set for pattern references or composition defaults */
|
|
3485
3487
|
_locales?: string[];
|
|
3486
3488
|
};
|
|
@@ -3500,10 +3502,10 @@ interface components$l {
|
|
|
3500
3502
|
* */
|
|
3501
3503
|
ComponentOverride: {
|
|
3502
3504
|
parameters?: {
|
|
3503
|
-
[key: string]: components$
|
|
3505
|
+
[key: string]: components$m["schemas"]["ComponentParameter"];
|
|
3504
3506
|
};
|
|
3505
3507
|
slots?: {
|
|
3506
|
-
[key: string]: components$
|
|
3508
|
+
[key: string]: components$m["schemas"]["ComponentInstance"][];
|
|
3507
3509
|
};
|
|
3508
3510
|
variant?: string;
|
|
3509
3511
|
/** @description Overrides data resource definitions for a pattern component.
|
|
@@ -3511,7 +3513,7 @@ interface components$l {
|
|
|
3511
3513
|
* Overrides defined here replace values in either _dataResources or _patternDataResources on the target component.
|
|
3512
3514
|
* */
|
|
3513
3515
|
dataResources?: {
|
|
3514
|
-
[key: string]: components$
|
|
3516
|
+
[key: string]: components$m["schemas"]["DataResourceDefinition"];
|
|
3515
3517
|
};
|
|
3516
3518
|
};
|
|
3517
3519
|
/**
|
|
@@ -3532,7 +3534,7 @@ interface components$l {
|
|
|
3532
3534
|
ComponentOverridability: {
|
|
3533
3535
|
/** @description Defines component parameter value overrides. Keys are the parameter public ID */
|
|
3534
3536
|
parameters?: {
|
|
3535
|
-
[key: string]: components$
|
|
3537
|
+
[key: string]: components$m["schemas"]["OverrideOptions"];
|
|
3536
3538
|
};
|
|
3537
3539
|
/** @description Allows overriding a display variant is allowed if it is defined on the component the pattern is derived from. Default = false */
|
|
3538
3540
|
variants?: boolean;
|
|
@@ -3571,14 +3573,14 @@ interface components$l {
|
|
|
3571
3573
|
_locales?: string[];
|
|
3572
3574
|
/** @description Entry field values */
|
|
3573
3575
|
fields?: {
|
|
3574
|
-
[key: string]: components$
|
|
3576
|
+
[key: string]: components$m["schemas"]["ComponentParameter"];
|
|
3575
3577
|
};
|
|
3576
|
-
_dataResources?: components$
|
|
3578
|
+
_dataResources?: components$m["schemas"]["DataResourceDefinitions"];
|
|
3577
3579
|
/** @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
|
3578
3580
|
* Means nothing for PUTs; it will be ignored
|
|
3579
3581
|
* */
|
|
3580
3582
|
_patternDataResources?: {
|
|
3581
|
-
[key: string]: components$
|
|
3583
|
+
[key: string]: components$m["schemas"]["DataResourceDefinition"];
|
|
3582
3584
|
};
|
|
3583
3585
|
/**
|
|
3584
3586
|
* @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 +3603,7 @@ interface components$l {
|
|
|
3601
3603
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
3602
3604
|
* */
|
|
3603
3605
|
_overrides?: {
|
|
3604
|
-
[key: string]: components$
|
|
3606
|
+
[key: string]: components$m["schemas"]["ComponentOverride"];
|
|
3605
3607
|
};
|
|
3606
3608
|
/** @description When used on a pattern, defines how the pattern's parameters may be overridden
|
|
3607
3609
|
* by consumers of the pattern.
|
|
@@ -3609,7 +3611,7 @@ interface components$l {
|
|
|
3609
3611
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
3610
3612
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
3611
3613
|
* */
|
|
3612
|
-
_overridability?: components$
|
|
3614
|
+
_overridability?: components$m["schemas"]["ComponentOverridability"];
|
|
3613
3615
|
};
|
|
3614
3616
|
/** @description Permissions for a workflow stage */
|
|
3615
3617
|
WorkflowStagePermission: {
|
|
@@ -3638,7 +3640,7 @@ interface components$l {
|
|
|
3638
3640
|
* NOTE: Users without membership in any role listed here will be unable to execute the transition unless they are team admins
|
|
3639
3641
|
* */
|
|
3640
3642
|
permissions: {
|
|
3641
|
-
[key: string]: components$
|
|
3643
|
+
[key: string]: components$m["schemas"]["WorkflowStageTransitionPermission"];
|
|
3642
3644
|
};
|
|
3643
3645
|
};
|
|
3644
3646
|
/** @description Definition of a stage in a workflow */
|
|
@@ -3651,7 +3653,7 @@ interface components$l {
|
|
|
3651
3653
|
* listed here, the stage is read-only and publishing is disabled
|
|
3652
3654
|
* */
|
|
3653
3655
|
permissions: {
|
|
3654
|
-
[key: string]: components$
|
|
3656
|
+
[key: string]: components$m["schemas"]["WorkflowStagePermission"];
|
|
3655
3657
|
};
|
|
3656
3658
|
/** @description When true, transitioning into this stage from a different stage will automatically publish the entity.
|
|
3657
3659
|
* 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 +3670,7 @@ interface components$l {
|
|
|
3668
3670
|
* Every stage must define at least one transition, to avoid creating a workflow that
|
|
3669
3671
|
* has a stage that can never be escaped
|
|
3670
3672
|
* */
|
|
3671
|
-
transitions: components$
|
|
3673
|
+
transitions: components$m["schemas"]["WorkflowStageTransition"][];
|
|
3672
3674
|
/**
|
|
3673
3675
|
* @description Icon name for the stage (e.g. 'chevron-double-right-o')
|
|
3674
3676
|
* @default chevron-double-right-o
|
|
@@ -3693,7 +3695,7 @@ interface components$l {
|
|
|
3693
3695
|
initialStage: string;
|
|
3694
3696
|
/** @description All stages of the workflow */
|
|
3695
3697
|
stages: {
|
|
3696
|
-
[key: string]: components$
|
|
3698
|
+
[key: string]: components$m["schemas"]["WorkflowStage"];
|
|
3697
3699
|
};
|
|
3698
3700
|
/** @description Last modified ISO date string for this definition (ignored for writes) */
|
|
3699
3701
|
modified?: string;
|
|
@@ -3744,7 +3746,7 @@ interface components$l {
|
|
|
3744
3746
|
* @default false
|
|
3745
3747
|
*/
|
|
3746
3748
|
pattern?: boolean;
|
|
3747
|
-
entry: components$
|
|
3749
|
+
entry: components$m["schemas"]["Entry"];
|
|
3748
3750
|
/**
|
|
3749
3751
|
* Format: uuid
|
|
3750
3752
|
* @description The workflow ID that this entry is assigned. Normally comes from the content type
|
|
@@ -3756,7 +3758,7 @@ interface components$l {
|
|
|
3756
3758
|
*/
|
|
3757
3759
|
workflowStageId?: string;
|
|
3758
3760
|
/** @description The full definition of the assigned workflow, if any, including stages, permissions, etc. Only returned when `withWorkflowDefinition` is true */
|
|
3759
|
-
workflowDefinition?: components$
|
|
3761
|
+
workflowDefinition?: components$m["schemas"]["WorkflowDefinition"];
|
|
3760
3762
|
/**
|
|
3761
3763
|
* @description Only present if an incomplete entry is returned; indicates reason for stubbing
|
|
3762
3764
|
* @enum {string}
|
|
@@ -3778,7 +3780,7 @@ interface components$l {
|
|
|
3778
3780
|
editionPriority?: number;
|
|
3779
3781
|
};
|
|
3780
3782
|
EntryListResponse: {
|
|
3781
|
-
entries: components$
|
|
3783
|
+
entries: components$m["schemas"]["EntryApiResponse"][];
|
|
3782
3784
|
/** @description Total number of entries that match the query. Only present when `withTotalCount` option is true */
|
|
3783
3785
|
totalCount?: number;
|
|
3784
3786
|
/** @description Per-field counts for distinct values */
|
|
@@ -3817,16 +3819,16 @@ interface components$l {
|
|
|
3817
3819
|
_creatorSubject?: string;
|
|
3818
3820
|
/** @description Entry field values */
|
|
3819
3821
|
fields?: {
|
|
3820
|
-
[key: string]: components$
|
|
3822
|
+
[key: string]: components$m["schemas"]["ComponentParameter"];
|
|
3821
3823
|
};
|
|
3822
|
-
_dataResources?: components$
|
|
3824
|
+
_dataResources?: components$m["schemas"]["DataResourceDefinitions"];
|
|
3823
3825
|
/** @description Indicates this content entry should be sourced from a pattern library pattern */
|
|
3824
3826
|
_pattern?: string;
|
|
3825
3827
|
/** @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
|
3826
3828
|
* Means nothing for PUTs; it will be ignored
|
|
3827
3829
|
* */
|
|
3828
3830
|
_patternDataResources?: {
|
|
3829
|
-
[key: string]: components$
|
|
3831
|
+
[key: string]: components$m["schemas"]["DataResourceDefinition"];
|
|
3830
3832
|
};
|
|
3831
3833
|
/**
|
|
3832
3834
|
* @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 +3846,7 @@ interface components$l {
|
|
|
3844
3846
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
3845
3847
|
* */
|
|
3846
3848
|
_overrides?: {
|
|
3847
|
-
[key: string]: components$
|
|
3849
|
+
[key: string]: components$m["schemas"]["ComponentOverride"];
|
|
3848
3850
|
};
|
|
3849
3851
|
/** @description When used on a pattern, defines how the pattern's fields may be overridden
|
|
3850
3852
|
* by consumers of the pattern.
|
|
@@ -3852,7 +3854,7 @@ interface components$l {
|
|
|
3852
3854
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
3853
3855
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
3854
3856
|
* */
|
|
3855
|
-
_overridability?: components$
|
|
3857
|
+
_overridability?: components$m["schemas"]["ComponentOverridability"];
|
|
3856
3858
|
/** @description Array of locales which have data defined on the entry. If empty, the current default locale implicitly has data */
|
|
3857
3859
|
_locales?: string[];
|
|
3858
3860
|
};
|
|
@@ -3864,7 +3866,7 @@ interface components$l {
|
|
|
3864
3866
|
[name: string]: unknown;
|
|
3865
3867
|
};
|
|
3866
3868
|
content: {
|
|
3867
|
-
"application/json": components$
|
|
3869
|
+
"application/json": components$m["schemas"]["Error"];
|
|
3868
3870
|
};
|
|
3869
3871
|
};
|
|
3870
3872
|
/** @description API key or token was not valid */
|
|
@@ -3873,7 +3875,7 @@ interface components$l {
|
|
|
3873
3875
|
[name: string]: unknown;
|
|
3874
3876
|
};
|
|
3875
3877
|
content: {
|
|
3876
|
-
"application/json": components$
|
|
3878
|
+
"application/json": components$m["schemas"]["Error"];
|
|
3877
3879
|
};
|
|
3878
3880
|
};
|
|
3879
3881
|
/** @description Permission was denied */
|
|
@@ -3882,7 +3884,7 @@ interface components$l {
|
|
|
3882
3884
|
[name: string]: unknown;
|
|
3883
3885
|
};
|
|
3884
3886
|
content: {
|
|
3885
|
-
"application/json": components$
|
|
3887
|
+
"application/json": components$m["schemas"]["Error"];
|
|
3886
3888
|
};
|
|
3887
3889
|
};
|
|
3888
3890
|
/** @description Too many requests in allowed time period */
|
|
@@ -4029,7 +4031,7 @@ interface components$l {
|
|
|
4029
4031
|
pathItems: never;
|
|
4030
4032
|
}
|
|
4031
4033
|
|
|
4032
|
-
interface paths$
|
|
4034
|
+
interface paths$j {
|
|
4033
4035
|
"/api/v1/entries-history": {
|
|
4034
4036
|
parameters: {
|
|
4035
4037
|
query?: never;
|
|
@@ -4067,12 +4069,12 @@ interface paths$i {
|
|
|
4067
4069
|
[name: string]: unknown;
|
|
4068
4070
|
};
|
|
4069
4071
|
content: {
|
|
4070
|
-
"application/json": components$
|
|
4072
|
+
"application/json": components$l["schemas"]["HistoryApiResponse"];
|
|
4071
4073
|
};
|
|
4072
4074
|
};
|
|
4073
|
-
400: components$
|
|
4074
|
-
401: components$
|
|
4075
|
-
403: components$
|
|
4075
|
+
400: components$l["responses"]["BadRequestError"];
|
|
4076
|
+
401: components$l["responses"]["UnauthorizedError"];
|
|
4077
|
+
403: components$l["responses"]["ForbiddenError"];
|
|
4076
4078
|
/** @description Entry not found */
|
|
4077
4079
|
404: {
|
|
4078
4080
|
headers: {
|
|
@@ -4082,8 +4084,8 @@ interface paths$i {
|
|
|
4082
4084
|
"text/plain": string;
|
|
4083
4085
|
};
|
|
4084
4086
|
};
|
|
4085
|
-
429: components$
|
|
4086
|
-
500: components$
|
|
4087
|
+
429: components$l["responses"]["RateLimitError"];
|
|
4088
|
+
500: components$l["responses"]["InternalServerError"];
|
|
4087
4089
|
};
|
|
4088
4090
|
};
|
|
4089
4091
|
put?: never;
|
|
@@ -4095,7 +4097,7 @@ interface paths$i {
|
|
|
4095
4097
|
trace?: never;
|
|
4096
4098
|
};
|
|
4097
4099
|
}
|
|
4098
|
-
interface components$
|
|
4100
|
+
interface components$l {
|
|
4099
4101
|
schemas: {
|
|
4100
4102
|
HistoryEntry: {
|
|
4101
4103
|
/** @description The version ID of the entity. This can be used to fetch the version's data via the entity API */
|
|
@@ -4116,7 +4118,7 @@ interface components$k {
|
|
|
4116
4118
|
/** @description If more history is available than your plan allows, and additional entries are available by upgrading, this will be true */
|
|
4117
4119
|
truncated?: boolean;
|
|
4118
4120
|
/** @description Version history entries */
|
|
4119
|
-
results?: components$
|
|
4121
|
+
results?: components$l["schemas"]["HistoryEntry"][];
|
|
4120
4122
|
};
|
|
4121
4123
|
Error: {
|
|
4122
4124
|
/** @description Error message(s) that occurred while processing the request */
|
|
@@ -4130,7 +4132,7 @@ interface components$k {
|
|
|
4130
4132
|
[name: string]: unknown;
|
|
4131
4133
|
};
|
|
4132
4134
|
content: {
|
|
4133
|
-
"application/json": components$
|
|
4135
|
+
"application/json": components$l["schemas"]["Error"];
|
|
4134
4136
|
};
|
|
4135
4137
|
};
|
|
4136
4138
|
/** @description API key or token was not valid */
|
|
@@ -4139,7 +4141,7 @@ interface components$k {
|
|
|
4139
4141
|
[name: string]: unknown;
|
|
4140
4142
|
};
|
|
4141
4143
|
content: {
|
|
4142
|
-
"application/json": components$
|
|
4144
|
+
"application/json": components$l["schemas"]["Error"];
|
|
4143
4145
|
};
|
|
4144
4146
|
};
|
|
4145
4147
|
/** @description Permission was denied */
|
|
@@ -4148,7 +4150,7 @@ interface components$k {
|
|
|
4148
4150
|
[name: string]: unknown;
|
|
4149
4151
|
};
|
|
4150
4152
|
content: {
|
|
4151
|
-
"application/json": components$
|
|
4153
|
+
"application/json": components$l["schemas"]["Error"];
|
|
4152
4154
|
};
|
|
4153
4155
|
};
|
|
4154
4156
|
/** @description Too many requests in allowed time period */
|
|
@@ -4172,27 +4174,27 @@ interface components$k {
|
|
|
4172
4174
|
pathItems: never;
|
|
4173
4175
|
}
|
|
4174
4176
|
|
|
4175
|
-
type HistoryApi$1 = paths$
|
|
4176
|
-
type ContentType = components$
|
|
4177
|
-
type ContentTypePreviewConfiguration = components$
|
|
4177
|
+
type HistoryApi$1 = paths$j['/api/v1/entries-history'];
|
|
4178
|
+
type ContentType = components$q['schemas']['ContentType'];
|
|
4179
|
+
type ContentTypePreviewConfiguration = components$q['schemas']['ContentTypePreviewConfiguration'];
|
|
4178
4180
|
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$
|
|
4181
|
+
type GetContentTypesOptions = paths$l['/api/v1/content-types']['get']['parameters']['query'];
|
|
4182
|
+
type DeleteContentTypeOptions = paths$l['/api/v1/content-types']['delete']['requestBody']['content']['application/json'];
|
|
4183
|
+
type PutContentTypeBody = paths$l['/api/v1/content-types']['put']['requestBody']['content']['application/json'];
|
|
4184
|
+
type GetContentTypesResponse = paths$l['/api/v1/content-types']['get']['responses']['200']['content']['application/json'];
|
|
4185
|
+
type Entry = components$o['schemas']['EntryApiResponse'];
|
|
4186
|
+
type EntryList = components$o['schemas']['EntryListResponse'];
|
|
4185
4187
|
type EntryData = Entry['entry'];
|
|
4186
|
-
type GetEntriesOptions = paths$
|
|
4187
|
-
type GetEntriesResponse = paths$
|
|
4188
|
-
type DeleteEntryOptions = paths$
|
|
4189
|
-
type PutEntryBody = paths$
|
|
4188
|
+
type GetEntriesOptions = paths$k['/api/v1/entries']['get']['parameters']['query'];
|
|
4189
|
+
type GetEntriesResponse = paths$k['/api/v1/entries']['get']['responses']['200']['content']['application/json'];
|
|
4190
|
+
type DeleteEntryOptions = paths$k['/api/v1/entries']['delete']['requestBody']['content']['application/json'];
|
|
4191
|
+
type PutEntryBody = paths$k['/api/v1/entries']['put']['requestBody']['content']['application/json'];
|
|
4190
4192
|
/** The GET response from /api/v1/entries-history (history for one entry) */
|
|
4191
4193
|
type EntriesHistoryGetParameters = HistoryApi$1['get']['parameters']['query'];
|
|
4192
4194
|
/** The GET response from /api/v1/entries-history */
|
|
4193
|
-
type EntriesHistoryGetResponse = components$
|
|
4195
|
+
type EntriesHistoryGetResponse = components$q['schemas']['HistoryApiResponse'];
|
|
4194
4196
|
|
|
4195
|
-
interface paths$
|
|
4197
|
+
interface paths$i {
|
|
4196
4198
|
"/api/v1/data-source": {
|
|
4197
4199
|
parameters: {
|
|
4198
4200
|
query?: never;
|
|
@@ -4219,15 +4221,15 @@ interface paths$h {
|
|
|
4219
4221
|
};
|
|
4220
4222
|
content: {
|
|
4221
4223
|
"application/json": {
|
|
4222
|
-
result: components$
|
|
4224
|
+
result: components$k["schemas"]["DataSource"];
|
|
4223
4225
|
};
|
|
4224
4226
|
};
|
|
4225
4227
|
};
|
|
4226
|
-
400: components$
|
|
4227
|
-
401: components$
|
|
4228
|
-
403: components$
|
|
4229
|
-
429: components$
|
|
4230
|
-
500: components$
|
|
4228
|
+
400: components$k["responses"]["BadRequestError"];
|
|
4229
|
+
401: components$k["responses"]["UnauthorizedError"];
|
|
4230
|
+
403: components$k["responses"]["ForbiddenError"];
|
|
4231
|
+
429: components$k["responses"]["RateLimitError"];
|
|
4232
|
+
500: components$k["responses"]["InternalServerError"];
|
|
4231
4233
|
};
|
|
4232
4234
|
};
|
|
4233
4235
|
put: {
|
|
@@ -4240,7 +4242,7 @@ interface paths$h {
|
|
|
4240
4242
|
requestBody: {
|
|
4241
4243
|
content: {
|
|
4242
4244
|
"application/json": {
|
|
4243
|
-
data: components$
|
|
4245
|
+
data: components$k["schemas"]["DataSource"];
|
|
4244
4246
|
/** Format: uuid */
|
|
4245
4247
|
projectId: string;
|
|
4246
4248
|
/**
|
|
@@ -4262,11 +4264,11 @@ interface paths$h {
|
|
|
4262
4264
|
};
|
|
4263
4265
|
content?: never;
|
|
4264
4266
|
};
|
|
4265
|
-
400: components$
|
|
4266
|
-
401: components$
|
|
4267
|
-
403: components$
|
|
4268
|
-
429: components$
|
|
4269
|
-
500: components$
|
|
4267
|
+
400: components$k["responses"]["BadRequestError"];
|
|
4268
|
+
401: components$k["responses"]["UnauthorizedError"];
|
|
4269
|
+
403: components$k["responses"]["ForbiddenError"];
|
|
4270
|
+
429: components$k["responses"]["RateLimitError"];
|
|
4271
|
+
500: components$k["responses"]["InternalServerError"];
|
|
4270
4272
|
};
|
|
4271
4273
|
};
|
|
4272
4274
|
post?: never;
|
|
@@ -4294,11 +4296,11 @@ interface paths$h {
|
|
|
4294
4296
|
};
|
|
4295
4297
|
content?: never;
|
|
4296
4298
|
};
|
|
4297
|
-
400: components$
|
|
4298
|
-
401: components$
|
|
4299
|
-
403: components$
|
|
4300
|
-
429: components$
|
|
4301
|
-
500: components$
|
|
4299
|
+
400: components$k["responses"]["BadRequestError"];
|
|
4300
|
+
401: components$k["responses"]["UnauthorizedError"];
|
|
4301
|
+
403: components$k["responses"]["ForbiddenError"];
|
|
4302
|
+
429: components$k["responses"]["RateLimitError"];
|
|
4303
|
+
500: components$k["responses"]["InternalServerError"];
|
|
4302
4304
|
};
|
|
4303
4305
|
};
|
|
4304
4306
|
options?: never;
|
|
@@ -4307,7 +4309,7 @@ interface paths$h {
|
|
|
4307
4309
|
trace?: never;
|
|
4308
4310
|
};
|
|
4309
4311
|
}
|
|
4310
|
-
interface components$
|
|
4312
|
+
interface components$k {
|
|
4311
4313
|
schemas: {
|
|
4312
4314
|
/** @description Defines the shape of a data variable on a Data Source or Data Type */
|
|
4313
4315
|
DataVariableDefinition: {
|
|
@@ -4348,7 +4350,7 @@ interface components$j {
|
|
|
4348
4350
|
}[];
|
|
4349
4351
|
/** @description Variables needed to make calls to the data source */
|
|
4350
4352
|
variables?: {
|
|
4351
|
-
[key: string]: components$
|
|
4353
|
+
[key: string]: components$k["schemas"]["DataVariableDefinition"];
|
|
4352
4354
|
};
|
|
4353
4355
|
};
|
|
4354
4356
|
/** @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
|
|
@@ -4377,7 +4379,7 @@ interface components$j {
|
|
|
4377
4379
|
}[];
|
|
4378
4380
|
/** @description Variables needed to make calls to the data source */
|
|
4379
4381
|
variables?: {
|
|
4380
|
-
[key: string]: components$
|
|
4382
|
+
[key: string]: components$k["schemas"]["DataVariableDefinition"];
|
|
4381
4383
|
};
|
|
4382
4384
|
/** @description Mapping of locale codes to data source locale codes. Keys are Uniform locale codes, values are data source locale codes.
|
|
4383
4385
|
* If a locale is not mapped, it will be passed through to the data source as-is
|
|
@@ -4399,7 +4401,7 @@ interface components$j {
|
|
|
4399
4401
|
};
|
|
4400
4402
|
/** @description Different connector detail variants to use in the different contexts like e.g. Unpublished Data */
|
|
4401
4403
|
variants?: {
|
|
4402
|
-
unpublished?: components$
|
|
4404
|
+
unpublished?: components$k["schemas"]["AlternativeDataSourceData"];
|
|
4403
4405
|
};
|
|
4404
4406
|
};
|
|
4405
4407
|
Error: {
|
|
@@ -4414,7 +4416,7 @@ interface components$j {
|
|
|
4414
4416
|
[name: string]: unknown;
|
|
4415
4417
|
};
|
|
4416
4418
|
content: {
|
|
4417
|
-
"application/json": components$
|
|
4419
|
+
"application/json": components$k["schemas"]["Error"];
|
|
4418
4420
|
};
|
|
4419
4421
|
};
|
|
4420
4422
|
/** @description API key or token was not valid */
|
|
@@ -4423,7 +4425,7 @@ interface components$j {
|
|
|
4423
4425
|
[name: string]: unknown;
|
|
4424
4426
|
};
|
|
4425
4427
|
content: {
|
|
4426
|
-
"application/json": components$
|
|
4428
|
+
"application/json": components$k["schemas"]["Error"];
|
|
4427
4429
|
};
|
|
4428
4430
|
};
|
|
4429
4431
|
/** @description Permission was denied */
|
|
@@ -4432,7 +4434,7 @@ interface components$j {
|
|
|
4432
4434
|
[name: string]: unknown;
|
|
4433
4435
|
};
|
|
4434
4436
|
content: {
|
|
4435
|
-
"application/json": components$
|
|
4437
|
+
"application/json": components$k["schemas"]["Error"];
|
|
4436
4438
|
};
|
|
4437
4439
|
};
|
|
4438
4440
|
/** @description Too many requests in allowed time period */
|
|
@@ -4456,7 +4458,7 @@ interface components$j {
|
|
|
4456
4458
|
pathItems: never;
|
|
4457
4459
|
}
|
|
4458
4460
|
|
|
4459
|
-
interface paths$
|
|
4461
|
+
interface paths$h {
|
|
4460
4462
|
"/api/v1/data-sources": {
|
|
4461
4463
|
parameters: {
|
|
4462
4464
|
query?: never;
|
|
@@ -4486,15 +4488,15 @@ interface paths$g {
|
|
|
4486
4488
|
};
|
|
4487
4489
|
content: {
|
|
4488
4490
|
"application/json": {
|
|
4489
|
-
results: components$
|
|
4491
|
+
results: components$j["schemas"]["DataSource"][];
|
|
4490
4492
|
};
|
|
4491
4493
|
};
|
|
4492
4494
|
};
|
|
4493
|
-
400: components$
|
|
4494
|
-
401: components$
|
|
4495
|
-
403: components$
|
|
4496
|
-
429: components$
|
|
4497
|
-
500: components$
|
|
4495
|
+
400: components$j["responses"]["BadRequestError"];
|
|
4496
|
+
401: components$j["responses"]["UnauthorizedError"];
|
|
4497
|
+
403: components$j["responses"]["ForbiddenError"];
|
|
4498
|
+
429: components$j["responses"]["RateLimitError"];
|
|
4499
|
+
500: components$j["responses"]["InternalServerError"];
|
|
4498
4500
|
};
|
|
4499
4501
|
};
|
|
4500
4502
|
put?: never;
|
|
@@ -4506,7 +4508,7 @@ interface paths$g {
|
|
|
4506
4508
|
trace?: never;
|
|
4507
4509
|
};
|
|
4508
4510
|
}
|
|
4509
|
-
interface components$
|
|
4511
|
+
interface components$j {
|
|
4510
4512
|
schemas: {
|
|
4511
4513
|
/** @description Defines the shape of a data variable on a Data Source or Data Type */
|
|
4512
4514
|
DataVariableDefinition: {
|
|
@@ -4547,7 +4549,7 @@ interface components$i {
|
|
|
4547
4549
|
}[];
|
|
4548
4550
|
/** @description Variables needed to make calls to the data source */
|
|
4549
4551
|
variables?: {
|
|
4550
|
-
[key: string]: components$
|
|
4552
|
+
[key: string]: components$j["schemas"]["DataVariableDefinition"];
|
|
4551
4553
|
};
|
|
4552
4554
|
};
|
|
4553
4555
|
/** @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
|
|
@@ -4576,7 +4578,7 @@ interface components$i {
|
|
|
4576
4578
|
}[];
|
|
4577
4579
|
/** @description Variables needed to make calls to the data source */
|
|
4578
4580
|
variables?: {
|
|
4579
|
-
[key: string]: components$
|
|
4581
|
+
[key: string]: components$j["schemas"]["DataVariableDefinition"];
|
|
4580
4582
|
};
|
|
4581
4583
|
/** @description Mapping of locale codes to data source locale codes. Keys are Uniform locale codes, values are data source locale codes.
|
|
4582
4584
|
* If a locale is not mapped, it will be passed through to the data source as-is
|
|
@@ -4592,14 +4594,247 @@ interface components$i {
|
|
|
4592
4594
|
customPublic?: {
|
|
4593
4595
|
[key: string]: unknown;
|
|
4594
4596
|
};
|
|
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 */
|
|
4597
|
+
/** @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 */
|
|
4598
|
+
custom?: {
|
|
4599
|
+
[key: string]: unknown;
|
|
4600
|
+
};
|
|
4601
|
+
/** @description Different connector detail variants to use in the different contexts like e.g. Unpublished Data */
|
|
4602
|
+
variants?: {
|
|
4603
|
+
unpublished?: components$j["schemas"]["AlternativeDataSourceData"];
|
|
4604
|
+
};
|
|
4605
|
+
};
|
|
4606
|
+
Error: {
|
|
4607
|
+
/** @description Error message(s) that occurred while processing the request */
|
|
4608
|
+
errorMessage?: string[] | string;
|
|
4609
|
+
};
|
|
4610
|
+
};
|
|
4611
|
+
responses: {
|
|
4612
|
+
/** @description Request input validation failed */
|
|
4613
|
+
BadRequestError: {
|
|
4614
|
+
headers: {
|
|
4615
|
+
[name: string]: unknown;
|
|
4616
|
+
};
|
|
4617
|
+
content: {
|
|
4618
|
+
"application/json": components$j["schemas"]["Error"];
|
|
4619
|
+
};
|
|
4620
|
+
};
|
|
4621
|
+
/** @description API key or token was not valid */
|
|
4622
|
+
UnauthorizedError: {
|
|
4623
|
+
headers: {
|
|
4624
|
+
[name: string]: unknown;
|
|
4625
|
+
};
|
|
4626
|
+
content: {
|
|
4627
|
+
"application/json": components$j["schemas"]["Error"];
|
|
4628
|
+
};
|
|
4629
|
+
};
|
|
4630
|
+
/** @description Permission was denied */
|
|
4631
|
+
ForbiddenError: {
|
|
4632
|
+
headers: {
|
|
4633
|
+
[name: string]: unknown;
|
|
4634
|
+
};
|
|
4635
|
+
content: {
|
|
4636
|
+
"application/json": components$j["schemas"]["Error"];
|
|
4637
|
+
};
|
|
4638
|
+
};
|
|
4639
|
+
/** @description Too many requests in allowed time period */
|
|
4640
|
+
RateLimitError: {
|
|
4641
|
+
headers: {
|
|
4642
|
+
[name: string]: unknown;
|
|
4643
|
+
};
|
|
4644
|
+
content?: never;
|
|
4645
|
+
};
|
|
4646
|
+
/** @description Execution error occurred */
|
|
4647
|
+
InternalServerError: {
|
|
4648
|
+
headers: {
|
|
4649
|
+
[name: string]: unknown;
|
|
4650
|
+
};
|
|
4651
|
+
content?: never;
|
|
4652
|
+
};
|
|
4653
|
+
};
|
|
4654
|
+
parameters: never;
|
|
4655
|
+
requestBodies: never;
|
|
4656
|
+
headers: never;
|
|
4657
|
+
pathItems: never;
|
|
4658
|
+
}
|
|
4659
|
+
|
|
4660
|
+
interface paths$g {
|
|
4661
|
+
"/api/v1/data-types": {
|
|
4662
|
+
parameters: {
|
|
4663
|
+
query?: never;
|
|
4664
|
+
header?: never;
|
|
4665
|
+
path?: never;
|
|
4666
|
+
cookie?: never;
|
|
4667
|
+
};
|
|
4668
|
+
get: {
|
|
4669
|
+
parameters: {
|
|
4670
|
+
query: {
|
|
4671
|
+
projectId: string;
|
|
4672
|
+
};
|
|
4673
|
+
header?: never;
|
|
4674
|
+
path?: never;
|
|
4675
|
+
cookie?: never;
|
|
4676
|
+
};
|
|
4677
|
+
requestBody?: never;
|
|
4678
|
+
responses: {
|
|
4679
|
+
/** @description OK */
|
|
4680
|
+
200: {
|
|
4681
|
+
headers: {
|
|
4682
|
+
[name: string]: unknown;
|
|
4683
|
+
};
|
|
4684
|
+
content: {
|
|
4685
|
+
"application/json": {
|
|
4686
|
+
results: components$i["schemas"]["DataType"][];
|
|
4687
|
+
};
|
|
4688
|
+
};
|
|
4689
|
+
};
|
|
4690
|
+
400: components$i["responses"]["BadRequestError"];
|
|
4691
|
+
401: components$i["responses"]["UnauthorizedError"];
|
|
4692
|
+
403: components$i["responses"]["ForbiddenError"];
|
|
4693
|
+
429: components$i["responses"]["RateLimitError"];
|
|
4694
|
+
500: components$i["responses"]["InternalServerError"];
|
|
4695
|
+
};
|
|
4696
|
+
};
|
|
4697
|
+
put: {
|
|
4698
|
+
parameters: {
|
|
4699
|
+
query?: never;
|
|
4700
|
+
header?: never;
|
|
4701
|
+
path?: never;
|
|
4702
|
+
cookie?: never;
|
|
4703
|
+
};
|
|
4704
|
+
requestBody: {
|
|
4705
|
+
content: {
|
|
4706
|
+
"application/json": {
|
|
4707
|
+
data: components$i["schemas"]["DataType"];
|
|
4708
|
+
/** Format: uuid */
|
|
4709
|
+
projectId: string;
|
|
4710
|
+
};
|
|
4711
|
+
};
|
|
4712
|
+
};
|
|
4713
|
+
responses: {
|
|
4714
|
+
/** @description OK */
|
|
4715
|
+
204: {
|
|
4716
|
+
headers: {
|
|
4717
|
+
[name: string]: unknown;
|
|
4718
|
+
};
|
|
4719
|
+
content?: never;
|
|
4720
|
+
};
|
|
4721
|
+
400: components$i["responses"]["BadRequestError"];
|
|
4722
|
+
401: components$i["responses"]["UnauthorizedError"];
|
|
4723
|
+
403: components$i["responses"]["ForbiddenError"];
|
|
4724
|
+
429: components$i["responses"]["RateLimitError"];
|
|
4725
|
+
500: components$i["responses"]["InternalServerError"];
|
|
4726
|
+
};
|
|
4727
|
+
};
|
|
4728
|
+
post?: never;
|
|
4729
|
+
delete: {
|
|
4730
|
+
parameters: {
|
|
4731
|
+
query?: never;
|
|
4732
|
+
header?: never;
|
|
4733
|
+
path?: never;
|
|
4734
|
+
cookie?: never;
|
|
4735
|
+
};
|
|
4736
|
+
requestBody: {
|
|
4737
|
+
content: {
|
|
4738
|
+
"application/json": {
|
|
4739
|
+
typeId: string;
|
|
4740
|
+
/** Format: uuid */
|
|
4741
|
+
projectId: string;
|
|
4742
|
+
};
|
|
4743
|
+
};
|
|
4744
|
+
};
|
|
4745
|
+
responses: {
|
|
4746
|
+
/** @description OK */
|
|
4747
|
+
204: {
|
|
4748
|
+
headers: {
|
|
4749
|
+
[name: string]: unknown;
|
|
4750
|
+
};
|
|
4751
|
+
content?: never;
|
|
4752
|
+
};
|
|
4753
|
+
400: components$i["responses"]["BadRequestError"];
|
|
4754
|
+
401: components$i["responses"]["UnauthorizedError"];
|
|
4755
|
+
403: components$i["responses"]["ForbiddenError"];
|
|
4756
|
+
429: components$i["responses"]["RateLimitError"];
|
|
4757
|
+
500: components$i["responses"]["InternalServerError"];
|
|
4758
|
+
};
|
|
4759
|
+
};
|
|
4760
|
+
options?: never;
|
|
4761
|
+
head?: never;
|
|
4762
|
+
patch?: never;
|
|
4763
|
+
trace?: never;
|
|
4764
|
+
};
|
|
4765
|
+
}
|
|
4766
|
+
interface components$i {
|
|
4767
|
+
schemas: {
|
|
4768
|
+
/** @description Defines the shape of a data variable on a Data Source or Data Type */
|
|
4769
|
+
DataVariableDefinition: {
|
|
4770
|
+
/** @description Display name of the data variable */
|
|
4771
|
+
displayName?: string;
|
|
4772
|
+
/** @description Explanatory text that is provided to the data resource editor to explain what this variable does */
|
|
4773
|
+
helpText?: string;
|
|
4774
|
+
/**
|
|
4775
|
+
* @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
|
|
4776
|
+
* @default text
|
|
4777
|
+
*/
|
|
4778
|
+
type?: string;
|
|
4779
|
+
/** @description Default value of the data variable */
|
|
4780
|
+
default: string;
|
|
4781
|
+
/** @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 */
|
|
4782
|
+
order?: number;
|
|
4783
|
+
/** @description An optional arbitrary human readable source identifier to describe where this variable is from.
|
|
4784
|
+
* Some user interfaces may group variables by source value, for example 'From URL' or 'My Integration'
|
|
4785
|
+
* */
|
|
4786
|
+
source?: string;
|
|
4787
|
+
};
|
|
4788
|
+
/** @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 */
|
|
4789
|
+
DataType: {
|
|
4790
|
+
/** @description Public ID of the data type */
|
|
4791
|
+
id: string;
|
|
4792
|
+
/** @description Display name of the data type */
|
|
4793
|
+
displayName: string;
|
|
4794
|
+
/** @description Public ID of the associated data source */
|
|
4795
|
+
dataSourceId: string;
|
|
4796
|
+
/** @description A connector-specific archetype for this data type; used to select UI as well as perform any
|
|
4797
|
+
* necessary post-processing on the response. e.g. 'cms-entry', 'cms-query'. Can be undefined if
|
|
4798
|
+
* no special UI or processing is required
|
|
4799
|
+
* */
|
|
4800
|
+
archetype?: string;
|
|
4801
|
+
allowedOnComponents?: string[];
|
|
4802
|
+
/** @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 */
|
|
4803
|
+
path: string;
|
|
4804
|
+
/** @description Time-to-live (in seconds) for the resource data cache */
|
|
4805
|
+
ttl?: number;
|
|
4806
|
+
/** @description A key for the resource data cache purging */
|
|
4807
|
+
purgeKey?: string;
|
|
4808
|
+
/** @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 */
|
|
4809
|
+
badgeIconUrl?: string;
|
|
4810
|
+
/** @description HTTP headers to pass with requests to the data type. Merged with headers from the data source, overriding identical keys */
|
|
4811
|
+
headers?: {
|
|
4812
|
+
key: string;
|
|
4813
|
+
value: string;
|
|
4814
|
+
omitIfEmpty?: boolean;
|
|
4815
|
+
}[];
|
|
4816
|
+
/** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys */
|
|
4817
|
+
parameters?: {
|
|
4818
|
+
key: string;
|
|
4819
|
+
value: string;
|
|
4820
|
+
omitIfEmpty?: boolean;
|
|
4821
|
+
}[];
|
|
4822
|
+
/** @description Body to pass with requests to the data type (ignored unless the method is POST) */
|
|
4823
|
+
body?: string;
|
|
4824
|
+
/**
|
|
4825
|
+
* @description HTTP method to use with requests to the data type
|
|
4826
|
+
* @default GET
|
|
4827
|
+
* @enum {string}
|
|
4828
|
+
*/
|
|
4829
|
+
method: "GET" | "POST" | "HEAD";
|
|
4830
|
+
/** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys */
|
|
4831
|
+
variables?: {
|
|
4832
|
+
[key: string]: components$i["schemas"]["DataVariableDefinition"];
|
|
4833
|
+
};
|
|
4834
|
+
/** @description Custom configuration specific to the data source being defined */
|
|
4596
4835
|
custom?: {
|
|
4597
4836
|
[key: string]: unknown;
|
|
4598
4837
|
};
|
|
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
4838
|
};
|
|
4604
4839
|
Error: {
|
|
4605
4840
|
/** @description Error message(s) that occurred while processing the request */
|
|
@@ -4656,16 +4891,18 @@ interface components$i {
|
|
|
4656
4891
|
}
|
|
4657
4892
|
|
|
4658
4893
|
interface paths$f {
|
|
4659
|
-
"/api/v1/
|
|
4894
|
+
"/api/v1/prompts": {
|
|
4660
4895
|
parameters: {
|
|
4661
4896
|
query?: never;
|
|
4662
4897
|
header?: never;
|
|
4663
4898
|
path?: never;
|
|
4664
4899
|
cookie?: never;
|
|
4665
4900
|
};
|
|
4901
|
+
/** @deprecated */
|
|
4666
4902
|
get: {
|
|
4667
4903
|
parameters: {
|
|
4668
4904
|
query: {
|
|
4905
|
+
promptId?: string;
|
|
4669
4906
|
projectId: string;
|
|
4670
4907
|
};
|
|
4671
4908
|
header?: never;
|
|
@@ -4680,9 +4917,7 @@ interface paths$f {
|
|
|
4680
4917
|
[name: string]: unknown;
|
|
4681
4918
|
};
|
|
4682
4919
|
content: {
|
|
4683
|
-
"application/json":
|
|
4684
|
-
results: components$h["schemas"]["DataType"][];
|
|
4685
|
-
};
|
|
4920
|
+
"application/json": components$h["schemas"]["Prompt"] | components$h["schemas"]["Prompt"][];
|
|
4686
4921
|
};
|
|
4687
4922
|
};
|
|
4688
4923
|
400: components$h["responses"]["BadRequestError"];
|
|
@@ -4692,6 +4927,7 @@ interface paths$f {
|
|
|
4692
4927
|
500: components$h["responses"]["InternalServerError"];
|
|
4693
4928
|
};
|
|
4694
4929
|
};
|
|
4930
|
+
/** @deprecated */
|
|
4695
4931
|
put: {
|
|
4696
4932
|
parameters: {
|
|
4697
4933
|
query?: never;
|
|
@@ -4702,7 +4938,7 @@ interface paths$f {
|
|
|
4702
4938
|
requestBody: {
|
|
4703
4939
|
content: {
|
|
4704
4940
|
"application/json": {
|
|
4705
|
-
data: components$h["schemas"]["
|
|
4941
|
+
data: components$h["schemas"]["Prompt"];
|
|
4706
4942
|
/** Format: uuid */
|
|
4707
4943
|
projectId: string;
|
|
4708
4944
|
};
|
|
@@ -4724,6 +4960,7 @@ interface paths$f {
|
|
|
4724
4960
|
};
|
|
4725
4961
|
};
|
|
4726
4962
|
post?: never;
|
|
4963
|
+
/** @deprecated */
|
|
4727
4964
|
delete: {
|
|
4728
4965
|
parameters: {
|
|
4729
4966
|
query?: never;
|
|
@@ -4734,9 +4971,10 @@ interface paths$f {
|
|
|
4734
4971
|
requestBody: {
|
|
4735
4972
|
content: {
|
|
4736
4973
|
"application/json": {
|
|
4737
|
-
typeId: string;
|
|
4738
4974
|
/** Format: uuid */
|
|
4739
4975
|
projectId: string;
|
|
4976
|
+
/** Format: uuid */
|
|
4977
|
+
promptId: string;
|
|
4740
4978
|
};
|
|
4741
4979
|
};
|
|
4742
4980
|
};
|
|
@@ -4763,76 +5001,29 @@ interface paths$f {
|
|
|
4763
5001
|
}
|
|
4764
5002
|
interface components$h {
|
|
4765
5003
|
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;
|
|
5004
|
+
/** @description AI Prompt definition */
|
|
5005
|
+
Prompt: {
|
|
4772
5006
|
/**
|
|
4773
|
-
*
|
|
4774
|
-
* @
|
|
5007
|
+
* Format: uuid
|
|
5008
|
+
* @description Unique identifier for the prompt
|
|
4775
5009
|
*/
|
|
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
5010
|
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?: {
|
|
5011
|
+
/** @description Unique identifier for the integration that this prompt belongs to */
|
|
5012
|
+
integrationType: string;
|
|
5013
|
+
/** @description Name for the prompt */
|
|
5014
|
+
name?: string | null;
|
|
5015
|
+
/** @description Text for the prompt */
|
|
5016
|
+
text?: string | null;
|
|
5017
|
+
/** @description Data for the prompt */
|
|
5018
|
+
data?: {
|
|
4834
5019
|
[key: string]: unknown;
|
|
4835
|
-
};
|
|
5020
|
+
} | null;
|
|
5021
|
+
/** @description Turn off/on prompt */
|
|
5022
|
+
enabled?: boolean | null;
|
|
5023
|
+
/** @description Integration default prompt */
|
|
5024
|
+
builtIn?: boolean | null;
|
|
5025
|
+
/** @description Supported parameter types */
|
|
5026
|
+
parameterTypes?: string[] | null;
|
|
4836
5027
|
};
|
|
4837
5028
|
Error: {
|
|
4838
5029
|
/** @description Error message(s) that occurred while processing the request */
|
|
@@ -4888,20 +5079,68 @@ interface components$h {
|
|
|
4888
5079
|
pathItems: never;
|
|
4889
5080
|
}
|
|
4890
5081
|
|
|
5082
|
+
type PromptsApi = paths$f['/api/v1/prompts'];
|
|
5083
|
+
type DataTypeApi = paths$g['/api/v1/data-types'];
|
|
5084
|
+
type DataSourcesApi = paths$h['/api/v1/data-sources'];
|
|
5085
|
+
type DataSourceApi = paths$i['/api/v1/data-source'];
|
|
5086
|
+
/** Query parameter options for GET /api/v1/data-types */
|
|
5087
|
+
type DataTypeGetParameters = DataTypeApi['get']['parameters']['query'];
|
|
5088
|
+
/** The GET response from /api/v1/data-types */
|
|
5089
|
+
type DataTypeGetResponse = DataTypeApi['get']['responses']['200']['content']['application/json'];
|
|
5090
|
+
/** The PUT request body for /api/v1/data-types */
|
|
5091
|
+
type DataTypePutParameters = DataTypeApi['put']['requestBody']['content']['application/json'];
|
|
5092
|
+
/** Shape of the DELETE request body for /api/v1/data-types */
|
|
5093
|
+
type DataTypeDeleteParameters = DataTypeApi['delete']['requestBody']['content']['application/json'];
|
|
5094
|
+
/** Query parameter options for GET /api/v1/data-source */
|
|
5095
|
+
type DataSourceGetParameters = DataSourceApi['get']['parameters']['query'];
|
|
5096
|
+
/** Query parameter options for GET /api/v1/data-sources */
|
|
5097
|
+
type DataSourcesGetParameters = DataSourcesApi['get']['parameters']['query'];
|
|
5098
|
+
/** The GET response from /api/v1/data-sources */
|
|
5099
|
+
type DataSourceGetResponse = DataSourceApi['get']['responses']['200']['content']['application/json'];
|
|
5100
|
+
/** The GET response from /api/v1/data-sources */
|
|
5101
|
+
type DataSourcesGetResponse = DataSourcesApi['get']['responses']['200']['content']['application/json'];
|
|
5102
|
+
/** The PUT request body for /api/v1/data-source */
|
|
5103
|
+
type DataSourcePutParameters = DataSourceApi['put']['requestBody']['content']['application/json'];
|
|
5104
|
+
/** Shape of the DELETE request body for /api/v1/data-source */
|
|
5105
|
+
type DataSourceDeleteParameters = DataSourceApi['delete']['requestBody']['content']['application/json'];
|
|
5106
|
+
/** Query parameter options for GET /api/v1/prompts */
|
|
5107
|
+
type PromptsGetParameters = PromptsApi['get']['parameters']['query'];
|
|
5108
|
+
/** The GET response from /api/v1/prompts */
|
|
5109
|
+
type PromptsGetResponse = PromptsApi['get']['responses']['200']['content']['application/json'];
|
|
5110
|
+
/** The PUT request body for /api/v1/prompts */
|
|
5111
|
+
type PromptsPutParameters = PromptsApi['put']['requestBody']['content']['application/json'];
|
|
5112
|
+
/** Shape of the DELETE request body for /api/v1/prompts */
|
|
5113
|
+
type PromptsDeleteParameters = PromptsApi['delete']['requestBody']['content']['application/json'];
|
|
5114
|
+
type DataType = components$q['schemas']['DataType'];
|
|
5115
|
+
type DataSource = components$q['schemas']['DataSource'];
|
|
5116
|
+
type DataVariableDefinition = components$q['schemas']['DataVariableDefinition'];
|
|
5117
|
+
type Prompt = components$q['schemas']['Prompt'];
|
|
5118
|
+
type DataSourceVariantsKeys = keyof NonNullable<DataSource['variants']>;
|
|
5119
|
+
type DataSourceVariantData = NonNullable<DataSource['variants']>['unpublished'];
|
|
5120
|
+
|
|
4891
5121
|
interface paths$e {
|
|
4892
|
-
"/api/v1/
|
|
5122
|
+
"/api/v1/labels": {
|
|
4893
5123
|
parameters: {
|
|
4894
5124
|
query?: never;
|
|
4895
5125
|
header?: never;
|
|
4896
5126
|
path?: never;
|
|
4897
5127
|
cookie?: never;
|
|
4898
5128
|
};
|
|
4899
|
-
/**
|
|
5129
|
+
/**
|
|
5130
|
+
* @deprecated
|
|
5131
|
+
* @description Gets labels for a project
|
|
5132
|
+
*/
|
|
4900
5133
|
get: {
|
|
4901
5134
|
parameters: {
|
|
4902
5135
|
query: {
|
|
4903
|
-
promptId?: string;
|
|
4904
5136
|
projectId: string;
|
|
5137
|
+
offset?: number | null;
|
|
5138
|
+
limit?: number;
|
|
5139
|
+
labelIds?: string;
|
|
5140
|
+
groupId?: string;
|
|
5141
|
+
isGroup?: boolean | null;
|
|
5142
|
+
idPrefix?: string;
|
|
5143
|
+
namePrefix?: string;
|
|
4905
5144
|
};
|
|
4906
5145
|
header?: never;
|
|
4907
5146
|
path?: never;
|
|
@@ -4915,7 +5154,35 @@ interface paths$e {
|
|
|
4915
5154
|
[name: string]: unknown;
|
|
4916
5155
|
};
|
|
4917
5156
|
content: {
|
|
4918
|
-
"application/json":
|
|
5157
|
+
"application/json": {
|
|
5158
|
+
labels: {
|
|
5159
|
+
/** Format: uuid */
|
|
5160
|
+
projectId: string;
|
|
5161
|
+
label: {
|
|
5162
|
+
/** @description Public ID of the label (cannot be changed after creation) */
|
|
5163
|
+
publicId: string;
|
|
5164
|
+
/** @description Human readable name of the label */
|
|
5165
|
+
displayName: string;
|
|
5166
|
+
/** @description Whether this label is a group label (cannot be changed after creation) */
|
|
5167
|
+
isGroup: boolean;
|
|
5168
|
+
/** @description Public ID of the parent group label */
|
|
5169
|
+
parent?: string;
|
|
5170
|
+
/** @description Human readable color identifier */
|
|
5171
|
+
color: string;
|
|
5172
|
+
/** @description Short description of what the label is about */
|
|
5173
|
+
description?: string;
|
|
5174
|
+
/** @description Scope of the label (currently unused) */
|
|
5175
|
+
scope: string[];
|
|
5176
|
+
};
|
|
5177
|
+
/** Format: date-time */
|
|
5178
|
+
created: string;
|
|
5179
|
+
/** Format: date-time */
|
|
5180
|
+
modified: string;
|
|
5181
|
+
createdBy?: string;
|
|
5182
|
+
modifiedBy?: string;
|
|
5183
|
+
}[];
|
|
5184
|
+
totalCount: number;
|
|
5185
|
+
};
|
|
4919
5186
|
};
|
|
4920
5187
|
};
|
|
4921
5188
|
400: components$g["responses"]["BadRequestError"];
|
|
@@ -4925,7 +5192,10 @@ interface paths$e {
|
|
|
4925
5192
|
500: components$g["responses"]["InternalServerError"];
|
|
4926
5193
|
};
|
|
4927
5194
|
};
|
|
4928
|
-
/**
|
|
5195
|
+
/**
|
|
5196
|
+
* @deprecated
|
|
5197
|
+
* @description Creates or updates a label
|
|
5198
|
+
*/
|
|
4929
5199
|
put: {
|
|
4930
5200
|
parameters: {
|
|
4931
5201
|
query?: never;
|
|
@@ -4936,9 +5206,20 @@ interface paths$e {
|
|
|
4936
5206
|
requestBody: {
|
|
4937
5207
|
content: {
|
|
4938
5208
|
"application/json": {
|
|
4939
|
-
data: components$g["schemas"]["Prompt"];
|
|
4940
5209
|
/** Format: uuid */
|
|
4941
5210
|
projectId: string;
|
|
5211
|
+
label: {
|
|
5212
|
+
/** @description Public ID of the label */
|
|
5213
|
+
publicId: string;
|
|
5214
|
+
displayName: string;
|
|
5215
|
+
/** @default false */
|
|
5216
|
+
isGroup?: boolean;
|
|
5217
|
+
parent?: string;
|
|
5218
|
+
color: string;
|
|
5219
|
+
description?: string;
|
|
5220
|
+
/** @description Ignored on PUT */
|
|
5221
|
+
scope?: string[];
|
|
5222
|
+
};
|
|
4942
5223
|
};
|
|
4943
5224
|
};
|
|
4944
5225
|
};
|
|
@@ -4948,7 +5229,9 @@ interface paths$e {
|
|
|
4948
5229
|
headers: {
|
|
4949
5230
|
[name: string]: unknown;
|
|
4950
5231
|
};
|
|
4951
|
-
content
|
|
5232
|
+
content: {
|
|
5233
|
+
"application/json": string;
|
|
5234
|
+
};
|
|
4952
5235
|
};
|
|
4953
5236
|
400: components$g["responses"]["BadRequestError"];
|
|
4954
5237
|
401: components$g["responses"]["UnauthorizedError"];
|
|
@@ -4958,7 +5241,10 @@ interface paths$e {
|
|
|
4958
5241
|
};
|
|
4959
5242
|
};
|
|
4960
5243
|
post?: never;
|
|
4961
|
-
/**
|
|
5244
|
+
/**
|
|
5245
|
+
* @deprecated
|
|
5246
|
+
* @description Deletes a label
|
|
5247
|
+
*/
|
|
4962
5248
|
delete: {
|
|
4963
5249
|
parameters: {
|
|
4964
5250
|
query?: never;
|
|
@@ -4969,10 +5255,13 @@ interface paths$e {
|
|
|
4969
5255
|
requestBody: {
|
|
4970
5256
|
content: {
|
|
4971
5257
|
"application/json": {
|
|
4972
|
-
/**
|
|
5258
|
+
/**
|
|
5259
|
+
* Format: uuid
|
|
5260
|
+
* @description The project ID
|
|
5261
|
+
*/
|
|
4973
5262
|
projectId: string;
|
|
4974
|
-
/**
|
|
4975
|
-
|
|
5263
|
+
/** @description Public ID of the label to delete */
|
|
5264
|
+
labelId: string;
|
|
4976
5265
|
};
|
|
4977
5266
|
};
|
|
4978
5267
|
};
|
|
@@ -4982,7 +5271,9 @@ interface paths$e {
|
|
|
4982
5271
|
headers: {
|
|
4983
5272
|
[name: string]: unknown;
|
|
4984
5273
|
};
|
|
4985
|
-
content
|
|
5274
|
+
content: {
|
|
5275
|
+
"application/json": string;
|
|
5276
|
+
};
|
|
4986
5277
|
};
|
|
4987
5278
|
400: components$g["responses"]["BadRequestError"];
|
|
4988
5279
|
401: components$g["responses"]["UnauthorizedError"];
|
|
@@ -4991,7 +5282,25 @@ interface paths$e {
|
|
|
4991
5282
|
500: components$g["responses"]["InternalServerError"];
|
|
4992
5283
|
};
|
|
4993
5284
|
};
|
|
4994
|
-
|
|
5285
|
+
/** @description Handles preflight requests. This endpoint allows CORS. */
|
|
5286
|
+
options: {
|
|
5287
|
+
parameters: {
|
|
5288
|
+
query?: never;
|
|
5289
|
+
header?: never;
|
|
5290
|
+
path?: never;
|
|
5291
|
+
cookie?: never;
|
|
5292
|
+
};
|
|
5293
|
+
requestBody?: never;
|
|
5294
|
+
responses: {
|
|
5295
|
+
/** @description ok */
|
|
5296
|
+
204: {
|
|
5297
|
+
headers: {
|
|
5298
|
+
[name: string]: unknown;
|
|
5299
|
+
};
|
|
5300
|
+
content?: never;
|
|
5301
|
+
};
|
|
5302
|
+
};
|
|
5303
|
+
};
|
|
4995
5304
|
head?: never;
|
|
4996
5305
|
patch?: never;
|
|
4997
5306
|
trace?: never;
|
|
@@ -4999,30 +5308,6 @@ interface paths$e {
|
|
|
4999
5308
|
}
|
|
5000
5309
|
interface components$g {
|
|
5001
5310
|
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
5311
|
Error: {
|
|
5027
5312
|
/** @description Error message(s) that occurred while processing the request */
|
|
5028
5313
|
errorMessage?: string[] | string;
|
|
@@ -5077,44 +5362,12 @@ interface components$g {
|
|
|
5077
5362
|
pathItems: never;
|
|
5078
5363
|
}
|
|
5079
5364
|
|
|
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'];
|
|
5365
|
+
type LabelsApi = paths$e['/api/v1/labels'];
|
|
5366
|
+
type LabelsQuery = LabelsApi['get']['parameters']['query'];
|
|
5367
|
+
type LabelPut = LabelsApi['put']['requestBody']['content']['application/json'];
|
|
5368
|
+
type LabelDelete = LabelsApi['delete']['requestBody']['content']['application/json'];
|
|
5369
|
+
type LabelsResponse = LabelsApi['get']['responses']['200']['content']['application/json'];
|
|
5370
|
+
type Label = LabelsResponse['labels'][number];
|
|
5118
5371
|
|
|
5119
5372
|
interface paths$d {
|
|
5120
5373
|
"/api/v1/locales": {
|
|
@@ -9617,7 +9870,7 @@ interface components$a {
|
|
|
9617
9870
|
}
|
|
9618
9871
|
|
|
9619
9872
|
type Components = components$d['schemas'];
|
|
9620
|
-
type SharedComponents$1 = components$
|
|
9873
|
+
type SharedComponents$1 = components$q['schemas'];
|
|
9621
9874
|
type Api = paths$c['/api/v1/canvas'];
|
|
9622
9875
|
type HistoryApi = paths$b['/api/v1/canvas-history'];
|
|
9623
9876
|
/** Query parameter options for GET /api/v1/canvas */
|
|
@@ -9758,6 +10011,7 @@ type CanvasDefinitions = {
|
|
|
9758
10011
|
entries?: Array<Entry>;
|
|
9759
10012
|
entryPatterns?: Array<Entry>;
|
|
9760
10013
|
prompts?: Array<Prompt>;
|
|
10014
|
+
labels?: Array<Label>;
|
|
9761
10015
|
assets?: Array<AssetGetResponseSingle>;
|
|
9762
10016
|
locales?: Array<Locale>;
|
|
9763
10017
|
workflows?: Array<WorkflowDefinition>;
|
|
@@ -9873,8 +10127,8 @@ type RouteGetResponseRedirect = components$e['schemas']['RouteResponseRedirect']
|
|
|
9873
10127
|
type RouteGetResponseNotFound = components$e['schemas']['RouteResponseNotFound'];
|
|
9874
10128
|
type RouteDynamicInputs = components$e['schemas']['RouteDynamicInputs'];
|
|
9875
10129
|
/** The GET response from /api/v1/entries */
|
|
9876
|
-
type EntriesGetParameters = paths$
|
|
9877
|
-
type EntriesGetResponse = components$
|
|
10130
|
+
type EntriesGetParameters = paths$k['/api/v1/entries']['get']['parameters']['query'] & DataResolutionParameters;
|
|
10131
|
+
type EntriesGetResponse = components$o['schemas']['EntryListResponse'];
|
|
9878
10132
|
type EntriesResolvedListResponse = components$b['schemas']['EntryResolvedListResponse'];
|
|
9879
10133
|
/** GET response from uniform.global/api/v1/route when result is a composition */
|
|
9880
10134
|
type RouteGetResponseEdgehancedComposition = Omit<RouteGetResponseComposition, 'compositionApiResponse'> & {
|
|
@@ -10381,6 +10635,8 @@ interface AssetParamConfig extends ParamTypeConfigConventions {
|
|
|
10381
10635
|
min?: number;
|
|
10382
10636
|
max?: number;
|
|
10383
10637
|
allowedTypes?: AssetDefinitionType[];
|
|
10638
|
+
/** Array of label public IDs to assign by default to assets uploaded through this parameter */
|
|
10639
|
+
defaultLabels?: string[];
|
|
10384
10640
|
}
|
|
10385
10641
|
|
|
10386
10642
|
/**
|
|
@@ -11909,7 +12165,7 @@ interface components$3 {
|
|
|
11909
12165
|
}
|
|
11910
12166
|
|
|
11911
12167
|
type WorkflowsApi = paths$3['/api/v1/workflows'];
|
|
11912
|
-
type SharedComponents = components$
|
|
12168
|
+
type SharedComponents = components$q['schemas'];
|
|
11913
12169
|
type WorkflowDefinition = SharedComponents['WorkflowDefinition'];
|
|
11914
12170
|
type WorkflowStage = SharedComponents['WorkflowStage'];
|
|
11915
12171
|
type WorkflowStagePermission = SharedComponents['WorkflowStagePermission'];
|
|
@@ -11968,7 +12224,7 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
|
|
|
11968
12224
|
getCompositionHistory(options: ExceptProject<ComponentInstanceHistoryGetParameters>): Promise<{
|
|
11969
12225
|
cursor?: string;
|
|
11970
12226
|
truncated?: boolean;
|
|
11971
|
-
results?: components$
|
|
12227
|
+
results?: components$q["schemas"]["HistoryEntry"][];
|
|
11972
12228
|
}>;
|
|
11973
12229
|
private getOneComposition;
|
|
11974
12230
|
/** Updates or creates a Canvas component definition */
|
|
@@ -11979,7 +12235,7 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
|
|
|
11979
12235
|
removeComposition(body: Omit<CompositionDeleteParameters, 'projectId'>): Promise<void>;
|
|
11980
12236
|
/** Fetches all Canvas component definitions */
|
|
11981
12237
|
getComponentDefinitions(options?: Omit<ComponentDefinitionGetParameters, 'projectId'>): Promise<{
|
|
11982
|
-
componentDefinitions: components$
|
|
12238
|
+
componentDefinitions: components$r["schemas"]["ComponentDefinition"][];
|
|
11983
12239
|
}>;
|
|
11984
12240
|
/** Updates or creates a Canvas component definition */
|
|
11985
12241
|
updateComponentDefinition(body: Omit<ComponentDefinitionPutParameters, 'projectId'>): Promise<void>;
|
|
@@ -11994,7 +12250,7 @@ declare class CategoryClient extends ApiClient {
|
|
|
11994
12250
|
constructor(options: ClientOptions);
|
|
11995
12251
|
/** Fetches all categories created in given project */
|
|
11996
12252
|
getCategories(options?: Omit<CategoriesGetParameters, 'projectId'>): Promise<{
|
|
11997
|
-
categories: components$
|
|
12253
|
+
categories: components$p["schemas"]["Category"][];
|
|
11998
12254
|
}>;
|
|
11999
12255
|
/** Updates or creates a category, also used to re-order them */
|
|
12000
12256
|
upsertCategories(categories: CategoriesPutParameters['categories']): Promise<unknown>;
|
|
@@ -12024,7 +12280,7 @@ declare class ContentClient extends ApiClient<ContentClientOptions> {
|
|
|
12024
12280
|
getEntryHistory(options: ExceptProject<EntriesHistoryGetParameters>): Promise<{
|
|
12025
12281
|
cursor?: string;
|
|
12026
12282
|
truncated?: boolean;
|
|
12027
|
-
results?: components$
|
|
12283
|
+
results?: components$q["schemas"]["HistoryEntry"][];
|
|
12028
12284
|
}>;
|
|
12029
12285
|
upsertContentType(body: ExceptProject<PutContentTypeBody>, opts?: {
|
|
12030
12286
|
autogenerateDataTypes?: boolean;
|
|
@@ -12045,11 +12301,11 @@ declare class DataSourceClient extends ApiClient {
|
|
|
12045
12301
|
constructor(options: ClientOptions);
|
|
12046
12302
|
/** Fetches all DataSources for a project */
|
|
12047
12303
|
get(options?: ExceptProject<DataSourceGetParameters>): Promise<{
|
|
12048
|
-
result: components$
|
|
12304
|
+
result: components$k["schemas"]["DataSource"];
|
|
12049
12305
|
}>;
|
|
12050
12306
|
/** Fetches all DataSources for a project */
|
|
12051
12307
|
getList(options?: ExceptProject<DataSourcesGetParameters>): Promise<{
|
|
12052
|
-
results: components$
|
|
12308
|
+
results: components$j["schemas"]["DataSource"][];
|
|
12053
12309
|
}>;
|
|
12054
12310
|
/** Updates or creates (based on id) a DataSource */
|
|
12055
12311
|
upsert(body: ExceptProject<DataSourcePutParameters>): Promise<void>;
|
|
@@ -12407,9 +12663,9 @@ type VisibilityParameterValue = {
|
|
|
12407
12663
|
/** Criteria for the visibility of the component. If these evaluate to false, the component is hidden. */
|
|
12408
12664
|
criteria?: VisibilityCriteriaGroup;
|
|
12409
12665
|
};
|
|
12410
|
-
type VisibilityCriteriaGroup = components$
|
|
12411
|
-
type VisibilityCriteria = components$
|
|
12412
|
-
type ComponentParameterConditionalValue<TValue = unknown> = Omit<components$
|
|
12666
|
+
type VisibilityCriteriaGroup = components$q['schemas']['VisibilityCriteriaGroup'];
|
|
12667
|
+
type VisibilityCriteria = components$q['schemas']['VisibilityCriteria'];
|
|
12668
|
+
type ComponentParameterConditionalValue<TValue = unknown> = Omit<components$q['schemas']['ComponentParameterConditionalValue'], 'value'> & {
|
|
12413
12669
|
value: TValue;
|
|
12414
12670
|
};
|
|
12415
12671
|
/**
|
|
@@ -12608,6 +12864,36 @@ declare class IntegrationPropertyEditorsClient extends ApiClient<IntegrationProp
|
|
|
12608
12864
|
delete(body: ExceptTeam<IntegrationPropertyEditorsDeleteParameters>): Promise<void>;
|
|
12609
12865
|
}
|
|
12610
12866
|
|
|
12867
|
+
declare class LabelClient extends ApiClient {
|
|
12868
|
+
/** Fetches labels for the current project. */
|
|
12869
|
+
getLabels(options?: Omit<LabelsQuery, 'projectId'>): Promise<{
|
|
12870
|
+
labels: {
|
|
12871
|
+
projectId: string;
|
|
12872
|
+
label: {
|
|
12873
|
+
publicId: string;
|
|
12874
|
+
displayName: string;
|
|
12875
|
+
isGroup: boolean;
|
|
12876
|
+
parent?: string;
|
|
12877
|
+
color: string;
|
|
12878
|
+
description?: string;
|
|
12879
|
+
scope: string[];
|
|
12880
|
+
};
|
|
12881
|
+
created: string;
|
|
12882
|
+
modified: string;
|
|
12883
|
+
createdBy?: string;
|
|
12884
|
+
modifiedBy?: string;
|
|
12885
|
+
}[];
|
|
12886
|
+
totalCount: number;
|
|
12887
|
+
}>;
|
|
12888
|
+
/** Updates or creates a label. */
|
|
12889
|
+
upsertLabel(body: Omit<LabelPut, 'projectId'>): Promise<void>;
|
|
12890
|
+
/** Deletes a label by id. */
|
|
12891
|
+
removeLabel(options: Omit<LabelDelete, 'projectId'>): Promise<void>;
|
|
12892
|
+
}
|
|
12893
|
+
declare class UncachedLabelClient extends LabelClient {
|
|
12894
|
+
constructor(options: Omit<ClientOptions, 'bypassCache'>);
|
|
12895
|
+
}
|
|
12896
|
+
|
|
12611
12897
|
/** API client to enable managing project locales */
|
|
12612
12898
|
declare class LocaleClient extends ApiClient {
|
|
12613
12899
|
constructor(options: ClientOptions);
|
|
@@ -13209,6 +13495,7 @@ interface paths$1 {
|
|
|
13209
13495
|
parameters: {
|
|
13210
13496
|
query?: {
|
|
13211
13497
|
teamId?: string;
|
|
13498
|
+
orderBy?: "name_ASC" | "name_DESC" | "createdAt_ASC" | "createdAt_DESC";
|
|
13212
13499
|
};
|
|
13213
13500
|
header?: never;
|
|
13214
13501
|
path?: never;
|
|
@@ -13605,12 +13892,12 @@ declare const createUniformApiEnhancer: ({ apiUrl }: {
|
|
|
13605
13892
|
}) => (message: Pick<UpdateCompositionMessage, "composition" | "hash">) => Promise<{
|
|
13606
13893
|
type: string;
|
|
13607
13894
|
parameters?: {
|
|
13608
|
-
[key: string]: components$
|
|
13895
|
+
[key: string]: components$q["schemas"]["ComponentParameter"];
|
|
13609
13896
|
};
|
|
13610
13897
|
variant?: string;
|
|
13611
|
-
projectMapNodes?: components$
|
|
13898
|
+
projectMapNodes?: components$q["schemas"]["CompositionProjectMapNodeInfo"][];
|
|
13612
13899
|
slots?: {
|
|
13613
|
-
[key: string]: components$
|
|
13900
|
+
[key: string]: components$q["schemas"]["ComponentInstance"][];
|
|
13614
13901
|
};
|
|
13615
13902
|
_id: string;
|
|
13616
13903
|
_slug?: string | null;
|
|
@@ -13621,17 +13908,17 @@ declare const createUniformApiEnhancer: ({ apiUrl }: {
|
|
|
13621
13908
|
_creatorSubject?: string;
|
|
13622
13909
|
_pattern?: string;
|
|
13623
13910
|
_patternDataResources?: {
|
|
13624
|
-
[key: string]: components$
|
|
13911
|
+
[key: string]: components$q["schemas"]["DataResourceDefinition"];
|
|
13625
13912
|
};
|
|
13626
|
-
_dataResources?: components$
|
|
13627
|
-
_patternError?: components$
|
|
13913
|
+
_dataResources?: components$q["schemas"]["DataResourceDefinitions"];
|
|
13914
|
+
_patternError?: components$q["schemas"]["PatternError"];
|
|
13628
13915
|
_overrides?: {
|
|
13629
|
-
[key: string]: components$
|
|
13916
|
+
[key: string]: components$q["schemas"]["ComponentOverride"];
|
|
13630
13917
|
};
|
|
13631
13918
|
_patternOverrides?: {
|
|
13632
|
-
[key: string]: components$
|
|
13919
|
+
[key: string]: components$q["schemas"]["ComponentOverride"];
|
|
13633
13920
|
};
|
|
13634
|
-
_overridability?: components$
|
|
13921
|
+
_overridability?: components$q["schemas"]["ComponentOverridability"];
|
|
13635
13922
|
_locales?: string[];
|
|
13636
13923
|
}>;
|
|
13637
13924
|
|
|
@@ -13858,7 +14145,7 @@ declare function hasReferencedVariables(value: string | undefined): number;
|
|
|
13858
14145
|
*/
|
|
13859
14146
|
declare function parseVariableExpression(serialized: string, onToken?: (token: string, type: 'text' | 'variable') => void | false): number;
|
|
13860
14147
|
|
|
13861
|
-
declare const version = "20.
|
|
14148
|
+
declare const version = "20.53.0";
|
|
13862
14149
|
|
|
13863
14150
|
/** API client to enable managing workflow definitions */
|
|
13864
14151
|
declare class WorkflowClient extends ApiClient {
|
|
@@ -13875,4 +14162,4 @@ declare class WorkflowClient extends ApiClient {
|
|
|
13875
14162
|
|
|
13876
14163
|
declare const CanvasClientError: typeof ApiClientError;
|
|
13877
14164
|
|
|
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 };
|
|
14165
|
+
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, REFERENCE_DATA_TYPE_ID, type ReadyMessage, RelationshipClient, type RelationshipResultInstance, type Release, ReleaseClient, type ReleaseContent, ReleaseContentsClient, type ReleaseContentsDeleteBody, type ReleaseContentsGetParameters, type ReleaseContentsGetResponse, type ReleaseDeleteParameters, type ReleasePatchParameters, type ReleasePutParameters, type ReleaseState, type ReleasesGetParameters, type ReleasesGetResponse, type ReportRenderedCompositionsMessage, type RequestComponentSuggestionMessage, type RequestPageHtmlMessage, type ResolvedRouteGetResponse, type RichTextBuiltInElement, type RichTextBuiltInFormat, type RichTextParamConfiguration, type RichTextParamValue, type RootComponentInstance, type RootEntryReference, type RootLocationReference, RouteClient, type RouteDynamicInputs, type RouteGetParameters, type RouteGetResponse, type RouteGetResponseComposition, type RouteGetResponseEdgehancedComposition, type RouteGetResponseEdgehancedNotFound, type RouteGetResponseNotFound, type RouteGetResponseRedirect, SECRET_QUERY_STRING_PARAM, 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 };
|