@uniformdev/canvas 19.17.0 → 19.19.0
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.ts +849 -425
- package/dist/index.esm.js +8 -0
- package/dist/index.js +8 -0
- package/dist/index.mjs +8 -0
- package/package.json +3 -3
package/dist/index.d.ts
CHANGED
@@ -1,4 +1,4 @@
|
|
1
|
-
import { ApiClient,
|
1
|
+
import { ApiClient, ExceptProject, ClientOptions, ApiClientError } from '@uniformdev/context/api';
|
2
2
|
export { ApiClientError } from '@uniformdev/context/api';
|
3
3
|
import Pusher from 'pusher-js';
|
4
4
|
import { Options as Options$1 } from 'p-retry';
|
@@ -6,13 +6,13 @@ import { Options } from 'p-throttle';
|
|
6
6
|
import { SerializedEditorState } from 'lexical';
|
7
7
|
import { PersonalizedVariant, TestVariant } from '@uniformdev/context';
|
8
8
|
|
9
|
-
interface components$
|
9
|
+
interface components$4 {
|
10
10
|
schemas: {
|
11
11
|
/** @description Public ID (used in code). Do not change after creation. */
|
12
12
|
PublicIdProperty: string;
|
13
13
|
/** @description The definition of a component parameter */
|
14
14
|
ComponentDefinitionParameter: {
|
15
|
-
id: components$
|
15
|
+
id: components$4["schemas"]["PublicIdProperty"];
|
16
16
|
/** @description Friendly name of the parameter */
|
17
17
|
name: string;
|
18
18
|
/** @description Appears next to the parameter in the Composition editor */
|
@@ -24,7 +24,7 @@ interface components$3 {
|
|
24
24
|
};
|
25
25
|
/** @description The definition of a named component slot that can contain other components */
|
26
26
|
ComponentDefinitionSlot: {
|
27
|
-
id: components$
|
27
|
+
id: components$4["schemas"]["PublicIdProperty"];
|
28
28
|
/** @description Friendly name of the slot */
|
29
29
|
name: string;
|
30
30
|
/** @description A list of component definition public IDs that are allowed in this named slot */
|
@@ -82,13 +82,13 @@ interface components$3 {
|
|
82
82
|
};
|
83
83
|
/** @description The definition of a component variant */
|
84
84
|
ComponentDefinitionVariant: {
|
85
|
-
id: components$
|
85
|
+
id: components$4["schemas"]["PublicIdProperty"];
|
86
86
|
/** @description Friendly name of the variant */
|
87
87
|
name: string;
|
88
88
|
};
|
89
89
|
/** @description Permission set for a component defintion */
|
90
90
|
ComponentDefinitionPermission: {
|
91
|
-
roleId: components$
|
91
|
+
roleId: components$4["schemas"]["PublicIdProperty"];
|
92
92
|
/**
|
93
93
|
* @description Permission type for this permission ComponentDefinition:
|
94
94
|
* read | write | create | delete
|
@@ -101,7 +101,7 @@ interface components$3 {
|
|
101
101
|
};
|
102
102
|
/** @description Defines a component type that can live on a Composition */
|
103
103
|
ComponentDefinition: {
|
104
|
-
id: components$
|
104
|
+
id: components$4["schemas"]["PublicIdProperty"];
|
105
105
|
/** @description Friendly name of the component definition */
|
106
106
|
name: string;
|
107
107
|
/**
|
@@ -120,21 +120,21 @@ interface components$3 {
|
|
120
120
|
*/
|
121
121
|
canBeComposition?: boolean;
|
122
122
|
/** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries. */
|
123
|
-
parameters?: components$
|
123
|
+
parameters?: components$4["schemas"]["ComponentDefinitionParameter"][];
|
124
124
|
/**
|
125
125
|
* @description if this component uses team permissions or custom permissions
|
126
126
|
* @default true
|
127
127
|
*/
|
128
128
|
useTeamPermissions?: boolean;
|
129
129
|
/** @description Custom role permissions for this component definition */
|
130
|
-
permissions?: components$
|
130
|
+
permissions?: components$4["schemas"]["ComponentDefinitionPermission"][];
|
131
131
|
/** @description The named slots for this component; placement areas where arrays of other components can be added. */
|
132
|
-
slots?: components$
|
133
|
-
slugSettings?: components$
|
132
|
+
slots?: components$4["schemas"]["ComponentDefinitionSlot"][];
|
133
|
+
slugSettings?: components$4["schemas"]["ComponentDefinitionSlugSettings"];
|
134
134
|
/** @description Default component instance value */
|
135
|
-
defaults?: components$
|
135
|
+
defaults?: components$4["schemas"]["ComponentInstance"] | null;
|
136
136
|
/** @description Named variants for this component; enables creation of visual variants that use the same parameter data */
|
137
|
-
variants?: components$
|
137
|
+
variants?: components$4["schemas"]["ComponentDefinitionVariant"][];
|
138
138
|
/** @description Created date string for this definition (ignored for writes) */
|
139
139
|
created?: string;
|
140
140
|
/** @description Last modified date string for this definition (ignored for writes) */
|
@@ -142,7 +142,7 @@ interface components$3 {
|
|
142
142
|
};
|
143
143
|
/** @description Defines a content type */
|
144
144
|
ContentType: {
|
145
|
-
id: components$
|
145
|
+
id: components$4["schemas"]["PublicIdProperty"];
|
146
146
|
/** @description Friendly name of the content type */
|
147
147
|
name: string;
|
148
148
|
/**
|
@@ -151,7 +151,7 @@ interface components$3 {
|
|
151
151
|
*/
|
152
152
|
titleField?: string | null;
|
153
153
|
/** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
|
154
|
-
fields?: components$
|
154
|
+
fields?: components$4["schemas"]["ComponentDefinitionParameter"][];
|
155
155
|
/** @description Created date string for this content type (ignored for writes) */
|
156
156
|
created?: string;
|
157
157
|
/** @description Last modified date string for this content type (ignored for writes) */
|
@@ -163,7 +163,7 @@ interface components$3 {
|
|
163
163
|
value: unknown;
|
164
164
|
/** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
|
165
165
|
type: string;
|
166
|
-
connectedData?: components$
|
166
|
+
connectedData?: components$4["schemas"]["DataElementConnectionDefinition"];
|
167
167
|
};
|
168
168
|
/**
|
169
169
|
* @description Defines a connection to a data element on a data resource.
|
@@ -186,13 +186,13 @@ interface components$3 {
|
|
186
186
|
type: string;
|
187
187
|
/** @description Component parameter values for the component instance */
|
188
188
|
parameters?: {
|
189
|
-
[key: string]: components$
|
189
|
+
[key: string]: components$4["schemas"]["ComponentParameter"];
|
190
190
|
};
|
191
191
|
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
192
192
|
variant?: string;
|
193
193
|
/** @description Slots containing any child components */
|
194
194
|
slots?: {
|
195
|
-
[key: string]: components$
|
195
|
+
[key: string]: components$4["schemas"]["ComponentInstance"][];
|
196
196
|
};
|
197
197
|
/**
|
198
198
|
* @description Unique identifier of the component within the composition.
|
@@ -202,13 +202,13 @@ interface components$3 {
|
|
202
202
|
_id?: string;
|
203
203
|
/** @description Indicates this component instance should be sourced from a pattern library pattern. */
|
204
204
|
_pattern?: string;
|
205
|
-
_dataResources?: components$
|
205
|
+
_dataResources?: components$4["schemas"]["DataResourceDefinitions"];
|
206
206
|
/**
|
207
207
|
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
208
208
|
* Means nothing for PUTs; it will be ignored.
|
209
209
|
*/
|
210
210
|
_patternDataResources?: {
|
211
|
-
[key: string]: components$
|
211
|
+
[key: string]: components$4["schemas"]["DataResourceDefinition"];
|
212
212
|
};
|
213
213
|
/**
|
214
214
|
* @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
@@ -232,7 +232,7 @@ interface components$3 {
|
|
232
232
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
233
233
|
*/
|
234
234
|
_overrides?: {
|
235
|
-
[key: string]: components$
|
235
|
+
[key: string]: components$4["schemas"]["ComponentOverride"];
|
236
236
|
};
|
237
237
|
/**
|
238
238
|
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
@@ -241,7 +241,7 @@ interface components$3 {
|
|
241
241
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
242
242
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
243
243
|
*/
|
244
|
-
_overridability?: components$
|
244
|
+
_overridability?: components$4["schemas"]["ComponentOverridability"];
|
245
245
|
};
|
246
246
|
/** @description Defines the shape of the root component in a composition */
|
247
247
|
RootComponentInstance: {
|
@@ -249,15 +249,15 @@ interface components$3 {
|
|
249
249
|
type: string;
|
250
250
|
/** @description Component parameter values for the component instance */
|
251
251
|
parameters?: {
|
252
|
-
[key: string]: components$
|
252
|
+
[key: string]: components$4["schemas"]["ComponentParameter"];
|
253
253
|
};
|
254
254
|
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
255
255
|
variant?: string;
|
256
256
|
/** @description Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated. */
|
257
|
-
projectMapNodes?: components$
|
257
|
+
projectMapNodes?: components$4["schemas"]["CompositionProjectMapNodeInfo"][];
|
258
258
|
/** @description Slots containing any child components */
|
259
259
|
slots?: {
|
260
|
-
[key: string]: components$
|
260
|
+
[key: string]: components$4["schemas"]["ComponentInstance"][];
|
261
261
|
};
|
262
262
|
/** @description The public UUID of the composition. */
|
263
263
|
_id: string;
|
@@ -265,7 +265,7 @@ interface components$3 {
|
|
265
265
|
_slug?: string | null;
|
266
266
|
/** @description Friendly name of this component. */
|
267
267
|
_name: string;
|
268
|
-
_dataResources?: components$
|
268
|
+
_dataResources?: components$4["schemas"]["DataResourceDefinitions"];
|
269
269
|
/**
|
270
270
|
* @description Defines patch overrides to component IDs that live in the composition.
|
271
271
|
* This can be used to override parameters that are defined on patterns,
|
@@ -279,7 +279,7 @@ interface components$3 {
|
|
279
279
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
280
280
|
*/
|
281
281
|
_overrides?: {
|
282
|
-
[key: string]: components$
|
282
|
+
[key: string]: components$4["schemas"]["ComponentOverride"];
|
283
283
|
};
|
284
284
|
/**
|
285
285
|
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
@@ -288,7 +288,7 @@ interface components$3 {
|
|
288
288
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
289
289
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
290
290
|
*/
|
291
|
-
_overridability?: components$
|
291
|
+
_overridability?: components$4["schemas"]["ComponentOverridability"];
|
292
292
|
};
|
293
293
|
/**
|
294
294
|
* @description Defines how to override a specific component.
|
@@ -298,7 +298,7 @@ interface components$3 {
|
|
298
298
|
*/
|
299
299
|
ComponentOverride: {
|
300
300
|
parameters?: {
|
301
|
-
[key: string]: components$
|
301
|
+
[key: string]: components$4["schemas"]["ComponentParameter"];
|
302
302
|
};
|
303
303
|
variant?: string;
|
304
304
|
};
|
@@ -312,7 +312,7 @@ interface components$3 {
|
|
312
312
|
ComponentOverridability: {
|
313
313
|
/** @description Defines component parameter value overrides. Keys are the parameter public ID. */
|
314
314
|
parameters?: {
|
315
|
-
[key: string]: components$
|
315
|
+
[key: string]: components$4["schemas"]["OverrideOptions"];
|
316
316
|
};
|
317
317
|
/** @description Allows overriding a display variant is allowed, if it is defined on the component the pattern is derived from. Default = false. */
|
318
318
|
variants?: boolean;
|
@@ -353,7 +353,7 @@ interface components$3 {
|
|
353
353
|
}[];
|
354
354
|
/** @description Variables needed to make calls to the data source */
|
355
355
|
variables?: {
|
356
|
-
[key: string]: components$
|
356
|
+
[key: string]: components$4["schemas"]["DataVariableDefinition"];
|
357
357
|
};
|
358
358
|
/** @description Custom configuration specific to the data source being defined (used to maintain UI state for custom integrations) */
|
359
359
|
custom?: {
|
@@ -410,7 +410,7 @@ interface components$3 {
|
|
410
410
|
method: "GET" | "POST" | "HEAD";
|
411
411
|
/** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys. */
|
412
412
|
variables?: {
|
413
|
-
[key: string]: components$
|
413
|
+
[key: string]: components$4["schemas"]["DataVariableDefinition"];
|
414
414
|
};
|
415
415
|
/** @description Custom configuration specific to the data source being defined */
|
416
416
|
custom?: {
|
@@ -438,7 +438,7 @@ interface components$3 {
|
|
438
438
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
439
439
|
*/
|
440
440
|
DataResourceDefinitions: {
|
441
|
-
[key: string]: components$
|
441
|
+
[key: string]: components$4["schemas"]["DataResourceDefinition"];
|
442
442
|
};
|
443
443
|
/** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
|
444
444
|
DataResourceDefinition: {
|
@@ -452,7 +452,7 @@ interface components$3 {
|
|
452
452
|
* If isPatternParameter is false or undefined, this has no meaning.
|
453
453
|
*/
|
454
454
|
ignorePatternParameterDefault?: boolean;
|
455
|
-
variables?: components$
|
455
|
+
variables?: components$4["schemas"]["DataResourceVariables"];
|
456
456
|
};
|
457
457
|
/** @description Variable values for a data resource. */
|
458
458
|
DataResourceVariables: {
|
@@ -480,7 +480,7 @@ interface components$3 {
|
|
480
480
|
* This file was auto-generated by openapi-typescript.
|
481
481
|
* Do not make direct changes to the file.
|
482
482
|
*/
|
483
|
-
interface paths$
|
483
|
+
interface paths$8 {
|
484
484
|
"/api/v1/canvas-definitions": {
|
485
485
|
get: {
|
486
486
|
parameters: {
|
@@ -503,15 +503,15 @@ interface paths$7 {
|
|
503
503
|
content: {
|
504
504
|
"application/json": {
|
505
505
|
/** @description Component definitions that match the query */
|
506
|
-
componentDefinitions: external$
|
506
|
+
componentDefinitions: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinition"][];
|
507
507
|
};
|
508
508
|
};
|
509
509
|
};
|
510
|
-
400: external$
|
511
|
-
401: external$
|
512
|
-
403: external$
|
513
|
-
429: external$
|
514
|
-
500: external$
|
510
|
+
400: external$9["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
511
|
+
401: external$9["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
512
|
+
403: external$9["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
513
|
+
429: external$9["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
514
|
+
500: external$9["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
515
515
|
};
|
516
516
|
};
|
517
517
|
/** Upserts a component definition */
|
@@ -519,11 +519,11 @@ interface paths$7 {
|
|
519
519
|
responses: {
|
520
520
|
/** OK */
|
521
521
|
204: never;
|
522
|
-
400: external$
|
523
|
-
401: external$
|
524
|
-
403: external$
|
525
|
-
429: external$
|
526
|
-
500: external$
|
522
|
+
400: external$9["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
523
|
+
401: external$9["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
524
|
+
403: external$9["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
525
|
+
429: external$9["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
526
|
+
500: external$9["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
527
527
|
};
|
528
528
|
requestBody: {
|
529
529
|
content: {
|
@@ -533,7 +533,7 @@ interface paths$7 {
|
|
533
533
|
* @description The project ID to upsert the component definition to
|
534
534
|
*/
|
535
535
|
projectId: string;
|
536
|
-
componentDefinition: external$
|
536
|
+
componentDefinition: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinition"];
|
537
537
|
};
|
538
538
|
};
|
539
539
|
};
|
@@ -543,11 +543,11 @@ interface paths$7 {
|
|
543
543
|
responses: {
|
544
544
|
/** OK */
|
545
545
|
204: never;
|
546
|
-
400: external$
|
547
|
-
401: external$
|
548
|
-
403: external$
|
549
|
-
429: external$
|
550
|
-
500: external$
|
546
|
+
400: external$9["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
547
|
+
401: external$9["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
548
|
+
403: external$9["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
549
|
+
429: external$9["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
550
|
+
500: external$9["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
551
551
|
};
|
552
552
|
requestBody: {
|
553
553
|
content: {
|
@@ -572,7 +572,7 @@ interface paths$7 {
|
|
572
572
|
};
|
573
573
|
};
|
574
574
|
}
|
575
|
-
interface external$
|
575
|
+
interface external$9 {
|
576
576
|
"swagger.yml": {
|
577
577
|
paths: {};
|
578
578
|
components: {
|
@@ -586,25 +586,25 @@ interface external$8 {
|
|
586
586
|
/** Request input validation failed */
|
587
587
|
BadRequestError: {
|
588
588
|
content: {
|
589
|
-
"application/json": external$
|
589
|
+
"application/json": external$9["swagger.yml"]["components"]["schemas"]["Error"];
|
590
590
|
};
|
591
591
|
};
|
592
592
|
/** API key or token was not valid */
|
593
593
|
UnauthorizedError: {
|
594
594
|
content: {
|
595
|
-
"application/json": external$
|
595
|
+
"application/json": external$9["swagger.yml"]["components"]["schemas"]["Error"];
|
596
596
|
};
|
597
597
|
};
|
598
598
|
/** Permission was denied */
|
599
599
|
ForbiddenError: {
|
600
600
|
content: {
|
601
|
-
"application/json": external$
|
601
|
+
"application/json": external$9["swagger.yml"]["components"]["schemas"]["Error"];
|
602
602
|
};
|
603
603
|
};
|
604
604
|
/** Resource not found */
|
605
605
|
NotFoundError: {
|
606
606
|
content: {
|
607
|
-
"application/json": external$
|
607
|
+
"application/json": external$9["swagger.yml"]["components"]["schemas"]["Error"];
|
608
608
|
};
|
609
609
|
};
|
610
610
|
/** Too many requests in allowed time period */
|
@@ -623,7 +623,7 @@ interface external$8 {
|
|
623
623
|
PublicIdProperty: string;
|
624
624
|
/** @description The definition of a component parameter */
|
625
625
|
ComponentDefinitionParameter: {
|
626
|
-
id: external$
|
626
|
+
id: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
627
627
|
/** @description Friendly name of the parameter */
|
628
628
|
name: string;
|
629
629
|
/** @description Appears next to the parameter in the Composition editor */
|
@@ -635,7 +635,7 @@ interface external$8 {
|
|
635
635
|
};
|
636
636
|
/** @description The definition of a named component slot that can contain other components */
|
637
637
|
ComponentDefinitionSlot: {
|
638
|
-
id: external$
|
638
|
+
id: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
639
639
|
/** @description Friendly name of the slot */
|
640
640
|
name: string;
|
641
641
|
/** @description A list of component definition public IDs that are allowed in this named slot */
|
@@ -693,13 +693,13 @@ interface external$8 {
|
|
693
693
|
};
|
694
694
|
/** @description The definition of a component variant */
|
695
695
|
ComponentDefinitionVariant: {
|
696
|
-
id: external$
|
696
|
+
id: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
697
697
|
/** @description Friendly name of the variant */
|
698
698
|
name: string;
|
699
699
|
};
|
700
700
|
/** @description Permission set for a component defintion */
|
701
701
|
ComponentDefinitionPermission: {
|
702
|
-
roleId: external$
|
702
|
+
roleId: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
703
703
|
/**
|
704
704
|
* @description Permission type for this permission ComponentDefinition:
|
705
705
|
* read | write | create | delete
|
@@ -712,7 +712,7 @@ interface external$8 {
|
|
712
712
|
};
|
713
713
|
/** @description Defines a component type that can live on a Composition */
|
714
714
|
ComponentDefinition: {
|
715
|
-
id: external$
|
715
|
+
id: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
716
716
|
/** @description Friendly name of the component definition */
|
717
717
|
name: string;
|
718
718
|
/**
|
@@ -731,21 +731,21 @@ interface external$8 {
|
|
731
731
|
*/
|
732
732
|
canBeComposition?: boolean;
|
733
733
|
/** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries. */
|
734
|
-
parameters?: external$
|
734
|
+
parameters?: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
|
735
735
|
/**
|
736
736
|
* @description if this component uses team permissions or custom permissions
|
737
737
|
* @default true
|
738
738
|
*/
|
739
739
|
useTeamPermissions?: boolean;
|
740
740
|
/** @description Custom role permissions for this component definition */
|
741
|
-
permissions?: external$
|
741
|
+
permissions?: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
|
742
742
|
/** @description The named slots for this component; placement areas where arrays of other components can be added. */
|
743
|
-
slots?: external$
|
744
|
-
slugSettings?: external$
|
743
|
+
slots?: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlot"][];
|
744
|
+
slugSettings?: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
745
745
|
/** @description Default component instance value */
|
746
|
-
defaults?: external$
|
746
|
+
defaults?: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"] | null;
|
747
747
|
/** @description Named variants for this component; enables creation of visual variants that use the same parameter data */
|
748
|
-
variants?: external$
|
748
|
+
variants?: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionVariant"][];
|
749
749
|
/** @description Created date string for this definition (ignored for writes) */
|
750
750
|
created?: string;
|
751
751
|
/** @description Last modified date string for this definition (ignored for writes) */
|
@@ -753,7 +753,7 @@ interface external$8 {
|
|
753
753
|
};
|
754
754
|
/** @description Defines a content type */
|
755
755
|
ContentType: {
|
756
|
-
id: external$
|
756
|
+
id: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
757
757
|
/** @description Friendly name of the content type */
|
758
758
|
name: string;
|
759
759
|
/**
|
@@ -762,7 +762,7 @@ interface external$8 {
|
|
762
762
|
*/
|
763
763
|
titleField?: string | null;
|
764
764
|
/** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
|
765
|
-
fields?: external$
|
765
|
+
fields?: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
|
766
766
|
/** @description Created date string for this content type (ignored for writes) */
|
767
767
|
created?: string;
|
768
768
|
/** @description Last modified date string for this content type (ignored for writes) */
|
@@ -774,7 +774,7 @@ interface external$8 {
|
|
774
774
|
value: unknown;
|
775
775
|
/** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
|
776
776
|
type: string;
|
777
|
-
connectedData?: external$
|
777
|
+
connectedData?: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
|
778
778
|
};
|
779
779
|
/**
|
780
780
|
* @description Defines a connection to a data element on a data resource.
|
@@ -797,13 +797,13 @@ interface external$8 {
|
|
797
797
|
type: string;
|
798
798
|
/** @description Component parameter values for the component instance */
|
799
799
|
parameters?: {
|
800
|
-
[key: string]: external$
|
800
|
+
[key: string]: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
801
801
|
};
|
802
802
|
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
803
803
|
variant?: string;
|
804
804
|
/** @description Slots containing any child components */
|
805
805
|
slots?: {
|
806
|
-
[key: string]: external$
|
806
|
+
[key: string]: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
|
807
807
|
};
|
808
808
|
/**
|
809
809
|
* @description Unique identifier of the component within the composition.
|
@@ -813,13 +813,13 @@ interface external$8 {
|
|
813
813
|
_id?: string;
|
814
814
|
/** @description Indicates this component instance should be sourced from a pattern library pattern. */
|
815
815
|
_pattern?: string;
|
816
|
-
_dataResources?: external$
|
816
|
+
_dataResources?: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
817
817
|
/**
|
818
818
|
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
819
819
|
* Means nothing for PUTs; it will be ignored.
|
820
820
|
*/
|
821
821
|
_patternDataResources?: {
|
822
|
-
[key: string]: external$
|
822
|
+
[key: string]: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
823
823
|
};
|
824
824
|
/**
|
825
825
|
* @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
@@ -843,7 +843,7 @@ interface external$8 {
|
|
843
843
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
844
844
|
*/
|
845
845
|
_overrides?: {
|
846
|
-
[key: string]: external$
|
846
|
+
[key: string]: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
847
847
|
};
|
848
848
|
/**
|
849
849
|
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
@@ -852,7 +852,7 @@ interface external$8 {
|
|
852
852
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
853
853
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
854
854
|
*/
|
855
|
-
_overridability?: external$
|
855
|
+
_overridability?: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
856
856
|
};
|
857
857
|
/** @description Defines the shape of the root component in a composition */
|
858
858
|
RootComponentInstance: {
|
@@ -860,15 +860,15 @@ interface external$8 {
|
|
860
860
|
type: string;
|
861
861
|
/** @description Component parameter values for the component instance */
|
862
862
|
parameters?: {
|
863
|
-
[key: string]: external$
|
863
|
+
[key: string]: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
864
864
|
};
|
865
865
|
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
866
866
|
variant?: string;
|
867
867
|
/** @description Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated. */
|
868
|
-
projectMapNodes?: external$
|
868
|
+
projectMapNodes?: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionProjectMapNodeInfo"][];
|
869
869
|
/** @description Slots containing any child components */
|
870
870
|
slots?: {
|
871
|
-
[key: string]: external$
|
871
|
+
[key: string]: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
|
872
872
|
};
|
873
873
|
/** @description The public UUID of the composition. */
|
874
874
|
_id: string;
|
@@ -876,7 +876,7 @@ interface external$8 {
|
|
876
876
|
_slug?: string | null;
|
877
877
|
/** @description Friendly name of this component. */
|
878
878
|
_name: string;
|
879
|
-
_dataResources?: external$
|
879
|
+
_dataResources?: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
880
880
|
/**
|
881
881
|
* @description Defines patch overrides to component IDs that live in the composition.
|
882
882
|
* This can be used to override parameters that are defined on patterns,
|
@@ -890,7 +890,7 @@ interface external$8 {
|
|
890
890
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
891
891
|
*/
|
892
892
|
_overrides?: {
|
893
|
-
[key: string]: external$
|
893
|
+
[key: string]: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
894
894
|
};
|
895
895
|
/**
|
896
896
|
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
@@ -899,7 +899,7 @@ interface external$8 {
|
|
899
899
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
900
900
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
901
901
|
*/
|
902
|
-
_overridability?: external$
|
902
|
+
_overridability?: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
903
903
|
};
|
904
904
|
/**
|
905
905
|
* @description Defines how to override a specific component.
|
@@ -909,7 +909,7 @@ interface external$8 {
|
|
909
909
|
*/
|
910
910
|
ComponentOverride: {
|
911
911
|
parameters?: {
|
912
|
-
[key: string]: external$
|
912
|
+
[key: string]: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
913
913
|
};
|
914
914
|
variant?: string;
|
915
915
|
};
|
@@ -923,7 +923,7 @@ interface external$8 {
|
|
923
923
|
ComponentOverridability: {
|
924
924
|
/** @description Defines component parameter value overrides. Keys are the parameter public ID. */
|
925
925
|
parameters?: {
|
926
|
-
[key: string]: external$
|
926
|
+
[key: string]: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["OverrideOptions"];
|
927
927
|
};
|
928
928
|
/** @description Allows overriding a display variant is allowed, if it is defined on the component the pattern is derived from. Default = false. */
|
929
929
|
variants?: boolean;
|
@@ -964,7 +964,7 @@ interface external$8 {
|
|
964
964
|
}[];
|
965
965
|
/** @description Variables needed to make calls to the data source */
|
966
966
|
variables?: {
|
967
|
-
[key: string]: external$
|
967
|
+
[key: string]: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
968
968
|
};
|
969
969
|
/** @description Custom configuration specific to the data source being defined (used to maintain UI state for custom integrations) */
|
970
970
|
custom?: {
|
@@ -1021,7 +1021,7 @@ interface external$8 {
|
|
1021
1021
|
method: "GET" | "POST" | "HEAD";
|
1022
1022
|
/** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys. */
|
1023
1023
|
variables?: {
|
1024
|
-
[key: string]: external$
|
1024
|
+
[key: string]: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
1025
1025
|
};
|
1026
1026
|
/** @description Custom configuration specific to the data source being defined */
|
1027
1027
|
custom?: {
|
@@ -1049,7 +1049,7 @@ interface external$8 {
|
|
1049
1049
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
1050
1050
|
*/
|
1051
1051
|
DataResourceDefinitions: {
|
1052
|
-
[key: string]: external$
|
1052
|
+
[key: string]: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
1053
1053
|
};
|
1054
1054
|
/** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
|
1055
1055
|
DataResourceDefinition: {
|
@@ -1063,7 +1063,7 @@ interface external$8 {
|
|
1063
1063
|
* If isPatternParameter is false or undefined, this has no meaning.
|
1064
1064
|
*/
|
1065
1065
|
ignorePatternParameterDefault?: boolean;
|
1066
|
-
variables?: external$
|
1066
|
+
variables?: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
1067
1067
|
};
|
1068
1068
|
/** @description Variable values for a data resource. */
|
1069
1069
|
DataResourceVariables: {
|
@@ -1090,8 +1090,8 @@ interface external$8 {
|
|
1090
1090
|
};
|
1091
1091
|
}
|
1092
1092
|
|
1093
|
-
type SharedComponents$1 = components$
|
1094
|
-
type Api$1 = paths$
|
1093
|
+
type SharedComponents$1 = components$4['schemas'];
|
1094
|
+
type Api$1 = paths$8['/api/v1/canvas-definitions'];
|
1095
1095
|
/** Shape of the GET response from /api/v1/canvas-definitions */
|
1096
1096
|
type ComponentDefinitionGetResponse = Api$1['get']['responses']['200']['content']['application/json'];
|
1097
1097
|
/** Shape of the PUT request body for /api/v1/canvas-definitions */
|
@@ -1101,7 +1101,7 @@ type ComponentDefinitionDeleteParameters = Api$1['delete']['requestBody']['conte
|
|
1101
1101
|
/** Query parameter options for GET /api/v1/canvas-definitions */
|
1102
1102
|
type ComponentDefinitionGetParameters = Api$1['get']['parameters']['query'];
|
1103
1103
|
/** The definition of a component parameter */
|
1104
|
-
type ComponentDefinitionParameter<TConfig = unknown> = Omit<components$
|
1104
|
+
type ComponentDefinitionParameter<TConfig = unknown> = Omit<components$4['schemas']['ComponentDefinitionParameter'], 'typeConfig'> & {
|
1105
1105
|
typeConfig?: TConfig;
|
1106
1106
|
};
|
1107
1107
|
/** The definition of a component visual variant */
|
@@ -1119,7 +1119,7 @@ type ComponentDefinition = SharedComponents$1['ComponentDefinition'];
|
|
1119
1119
|
* This file was auto-generated by openapi-typescript.
|
1120
1120
|
* Do not make direct changes to the file.
|
1121
1121
|
*/
|
1122
|
-
interface paths$
|
1122
|
+
interface paths$7 {
|
1123
1123
|
"/api/v1/data-source": {
|
1124
1124
|
get: {
|
1125
1125
|
parameters: {
|
@@ -1133,31 +1133,31 @@ interface paths$6 {
|
|
1133
1133
|
200: {
|
1134
1134
|
content: {
|
1135
1135
|
"application/json": {
|
1136
|
-
result: external$
|
1136
|
+
result: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataSource"];
|
1137
1137
|
};
|
1138
1138
|
};
|
1139
1139
|
};
|
1140
|
-
400: external$
|
1141
|
-
401: external$
|
1142
|
-
403: external$
|
1143
|
-
429: external$
|
1144
|
-
500: external$
|
1140
|
+
400: external$8["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
1141
|
+
401: external$8["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
1142
|
+
403: external$8["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
1143
|
+
429: external$8["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
1144
|
+
500: external$8["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
1145
1145
|
};
|
1146
1146
|
};
|
1147
1147
|
put: {
|
1148
1148
|
responses: {
|
1149
1149
|
/** OK */
|
1150
1150
|
204: never;
|
1151
|
-
400: external$
|
1152
|
-
401: external$
|
1153
|
-
403: external$
|
1154
|
-
429: external$
|
1155
|
-
500: external$
|
1151
|
+
400: external$8["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
1152
|
+
401: external$8["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
1153
|
+
403: external$8["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
1154
|
+
429: external$8["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
1155
|
+
500: external$8["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
1156
1156
|
};
|
1157
1157
|
requestBody: {
|
1158
1158
|
content: {
|
1159
1159
|
"application/json": {
|
1160
|
-
data: external$
|
1160
|
+
data: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataSource"];
|
1161
1161
|
/** Format: uuid */
|
1162
1162
|
projectId: string;
|
1163
1163
|
/**
|
@@ -1176,11 +1176,11 @@ interface paths$6 {
|
|
1176
1176
|
responses: {
|
1177
1177
|
/** OK */
|
1178
1178
|
204: never;
|
1179
|
-
400: external$
|
1180
|
-
401: external$
|
1181
|
-
403: external$
|
1182
|
-
429: external$
|
1183
|
-
500: external$
|
1179
|
+
400: external$8["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
1180
|
+
401: external$8["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
1181
|
+
403: external$8["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
1182
|
+
429: external$8["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
1183
|
+
500: external$8["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
1184
1184
|
};
|
1185
1185
|
requestBody: {
|
1186
1186
|
content: {
|
@@ -1194,7 +1194,7 @@ interface paths$6 {
|
|
1194
1194
|
};
|
1195
1195
|
};
|
1196
1196
|
}
|
1197
|
-
interface external$
|
1197
|
+
interface external$8 {
|
1198
1198
|
"swagger.yml": {
|
1199
1199
|
paths: {};
|
1200
1200
|
components: {
|
@@ -1208,25 +1208,25 @@ interface external$7 {
|
|
1208
1208
|
/** Request input validation failed */
|
1209
1209
|
BadRequestError: {
|
1210
1210
|
content: {
|
1211
|
-
"application/json": external$
|
1211
|
+
"application/json": external$8["swagger.yml"]["components"]["schemas"]["Error"];
|
1212
1212
|
};
|
1213
1213
|
};
|
1214
1214
|
/** API key or token was not valid */
|
1215
1215
|
UnauthorizedError: {
|
1216
1216
|
content: {
|
1217
|
-
"application/json": external$
|
1217
|
+
"application/json": external$8["swagger.yml"]["components"]["schemas"]["Error"];
|
1218
1218
|
};
|
1219
1219
|
};
|
1220
1220
|
/** Permission was denied */
|
1221
1221
|
ForbiddenError: {
|
1222
1222
|
content: {
|
1223
|
-
"application/json": external$
|
1223
|
+
"application/json": external$8["swagger.yml"]["components"]["schemas"]["Error"];
|
1224
1224
|
};
|
1225
1225
|
};
|
1226
1226
|
/** Resource not found */
|
1227
1227
|
NotFoundError: {
|
1228
1228
|
content: {
|
1229
|
-
"application/json": external$
|
1229
|
+
"application/json": external$8["swagger.yml"]["components"]["schemas"]["Error"];
|
1230
1230
|
};
|
1231
1231
|
};
|
1232
1232
|
/** Too many requests in allowed time period */
|
@@ -1245,7 +1245,7 @@ interface external$7 {
|
|
1245
1245
|
PublicIdProperty: string;
|
1246
1246
|
/** @description The definition of a component parameter */
|
1247
1247
|
ComponentDefinitionParameter: {
|
1248
|
-
id: external$
|
1248
|
+
id: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
1249
1249
|
/** @description Friendly name of the parameter */
|
1250
1250
|
name: string;
|
1251
1251
|
/** @description Appears next to the parameter in the Composition editor */
|
@@ -1257,7 +1257,7 @@ interface external$7 {
|
|
1257
1257
|
};
|
1258
1258
|
/** @description The definition of a named component slot that can contain other components */
|
1259
1259
|
ComponentDefinitionSlot: {
|
1260
|
-
id: external$
|
1260
|
+
id: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
1261
1261
|
/** @description Friendly name of the slot */
|
1262
1262
|
name: string;
|
1263
1263
|
/** @description A list of component definition public IDs that are allowed in this named slot */
|
@@ -1315,13 +1315,13 @@ interface external$7 {
|
|
1315
1315
|
};
|
1316
1316
|
/** @description The definition of a component variant */
|
1317
1317
|
ComponentDefinitionVariant: {
|
1318
|
-
id: external$
|
1318
|
+
id: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
1319
1319
|
/** @description Friendly name of the variant */
|
1320
1320
|
name: string;
|
1321
1321
|
};
|
1322
1322
|
/** @description Permission set for a component defintion */
|
1323
1323
|
ComponentDefinitionPermission: {
|
1324
|
-
roleId: external$
|
1324
|
+
roleId: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
1325
1325
|
/**
|
1326
1326
|
* @description Permission type for this permission ComponentDefinition:
|
1327
1327
|
* read | write | create | delete
|
@@ -1334,7 +1334,7 @@ interface external$7 {
|
|
1334
1334
|
};
|
1335
1335
|
/** @description Defines a component type that can live on a Composition */
|
1336
1336
|
ComponentDefinition: {
|
1337
|
-
id: external$
|
1337
|
+
id: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
1338
1338
|
/** @description Friendly name of the component definition */
|
1339
1339
|
name: string;
|
1340
1340
|
/**
|
@@ -1353,21 +1353,21 @@ interface external$7 {
|
|
1353
1353
|
*/
|
1354
1354
|
canBeComposition?: boolean;
|
1355
1355
|
/** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries. */
|
1356
|
-
parameters?: external$
|
1356
|
+
parameters?: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
|
1357
1357
|
/**
|
1358
1358
|
* @description if this component uses team permissions or custom permissions
|
1359
1359
|
* @default true
|
1360
1360
|
*/
|
1361
1361
|
useTeamPermissions?: boolean;
|
1362
1362
|
/** @description Custom role permissions for this component definition */
|
1363
|
-
permissions?: external$
|
1363
|
+
permissions?: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
|
1364
1364
|
/** @description The named slots for this component; placement areas where arrays of other components can be added. */
|
1365
|
-
slots?: external$
|
1366
|
-
slugSettings?: external$
|
1365
|
+
slots?: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlot"][];
|
1366
|
+
slugSettings?: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
1367
1367
|
/** @description Default component instance value */
|
1368
|
-
defaults?: external$
|
1368
|
+
defaults?: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"] | null;
|
1369
1369
|
/** @description Named variants for this component; enables creation of visual variants that use the same parameter data */
|
1370
|
-
variants?: external$
|
1370
|
+
variants?: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionVariant"][];
|
1371
1371
|
/** @description Created date string for this definition (ignored for writes) */
|
1372
1372
|
created?: string;
|
1373
1373
|
/** @description Last modified date string for this definition (ignored for writes) */
|
@@ -1375,7 +1375,7 @@ interface external$7 {
|
|
1375
1375
|
};
|
1376
1376
|
/** @description Defines a content type */
|
1377
1377
|
ContentType: {
|
1378
|
-
id: external$
|
1378
|
+
id: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
1379
1379
|
/** @description Friendly name of the content type */
|
1380
1380
|
name: string;
|
1381
1381
|
/**
|
@@ -1384,7 +1384,7 @@ interface external$7 {
|
|
1384
1384
|
*/
|
1385
1385
|
titleField?: string | null;
|
1386
1386
|
/** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
|
1387
|
-
fields?: external$
|
1387
|
+
fields?: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
|
1388
1388
|
/** @description Created date string for this content type (ignored for writes) */
|
1389
1389
|
created?: string;
|
1390
1390
|
/** @description Last modified date string for this content type (ignored for writes) */
|
@@ -1396,7 +1396,7 @@ interface external$7 {
|
|
1396
1396
|
value: unknown;
|
1397
1397
|
/** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
|
1398
1398
|
type: string;
|
1399
|
-
connectedData?: external$
|
1399
|
+
connectedData?: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
|
1400
1400
|
};
|
1401
1401
|
/**
|
1402
1402
|
* @description Defines a connection to a data element on a data resource.
|
@@ -1419,13 +1419,13 @@ interface external$7 {
|
|
1419
1419
|
type: string;
|
1420
1420
|
/** @description Component parameter values for the component instance */
|
1421
1421
|
parameters?: {
|
1422
|
-
[key: string]: external$
|
1422
|
+
[key: string]: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
1423
1423
|
};
|
1424
1424
|
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
1425
1425
|
variant?: string;
|
1426
1426
|
/** @description Slots containing any child components */
|
1427
1427
|
slots?: {
|
1428
|
-
[key: string]: external$
|
1428
|
+
[key: string]: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
|
1429
1429
|
};
|
1430
1430
|
/**
|
1431
1431
|
* @description Unique identifier of the component within the composition.
|
@@ -1435,13 +1435,13 @@ interface external$7 {
|
|
1435
1435
|
_id?: string;
|
1436
1436
|
/** @description Indicates this component instance should be sourced from a pattern library pattern. */
|
1437
1437
|
_pattern?: string;
|
1438
|
-
_dataResources?: external$
|
1438
|
+
_dataResources?: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
1439
1439
|
/**
|
1440
1440
|
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
1441
1441
|
* Means nothing for PUTs; it will be ignored.
|
1442
1442
|
*/
|
1443
1443
|
_patternDataResources?: {
|
1444
|
-
[key: string]: external$
|
1444
|
+
[key: string]: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
1445
1445
|
};
|
1446
1446
|
/**
|
1447
1447
|
* @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
@@ -1465,7 +1465,7 @@ interface external$7 {
|
|
1465
1465
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
1466
1466
|
*/
|
1467
1467
|
_overrides?: {
|
1468
|
-
[key: string]: external$
|
1468
|
+
[key: string]: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
1469
1469
|
};
|
1470
1470
|
/**
|
1471
1471
|
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
@@ -1474,7 +1474,7 @@ interface external$7 {
|
|
1474
1474
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
1475
1475
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
1476
1476
|
*/
|
1477
|
-
_overridability?: external$
|
1477
|
+
_overridability?: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
1478
1478
|
};
|
1479
1479
|
/** @description Defines the shape of the root component in a composition */
|
1480
1480
|
RootComponentInstance: {
|
@@ -1482,15 +1482,15 @@ interface external$7 {
|
|
1482
1482
|
type: string;
|
1483
1483
|
/** @description Component parameter values for the component instance */
|
1484
1484
|
parameters?: {
|
1485
|
-
[key: string]: external$
|
1485
|
+
[key: string]: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
1486
1486
|
};
|
1487
1487
|
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
1488
1488
|
variant?: string;
|
1489
1489
|
/** @description Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated. */
|
1490
|
-
projectMapNodes?: external$
|
1490
|
+
projectMapNodes?: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionProjectMapNodeInfo"][];
|
1491
1491
|
/** @description Slots containing any child components */
|
1492
1492
|
slots?: {
|
1493
|
-
[key: string]: external$
|
1493
|
+
[key: string]: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
|
1494
1494
|
};
|
1495
1495
|
/** @description The public UUID of the composition. */
|
1496
1496
|
_id: string;
|
@@ -1498,7 +1498,7 @@ interface external$7 {
|
|
1498
1498
|
_slug?: string | null;
|
1499
1499
|
/** @description Friendly name of this component. */
|
1500
1500
|
_name: string;
|
1501
|
-
_dataResources?: external$
|
1501
|
+
_dataResources?: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
1502
1502
|
/**
|
1503
1503
|
* @description Defines patch overrides to component IDs that live in the composition.
|
1504
1504
|
* This can be used to override parameters that are defined on patterns,
|
@@ -1512,7 +1512,7 @@ interface external$7 {
|
|
1512
1512
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
1513
1513
|
*/
|
1514
1514
|
_overrides?: {
|
1515
|
-
[key: string]: external$
|
1515
|
+
[key: string]: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
1516
1516
|
};
|
1517
1517
|
/**
|
1518
1518
|
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
@@ -1521,7 +1521,7 @@ interface external$7 {
|
|
1521
1521
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
1522
1522
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
1523
1523
|
*/
|
1524
|
-
_overridability?: external$
|
1524
|
+
_overridability?: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
1525
1525
|
};
|
1526
1526
|
/**
|
1527
1527
|
* @description Defines how to override a specific component.
|
@@ -1531,7 +1531,7 @@ interface external$7 {
|
|
1531
1531
|
*/
|
1532
1532
|
ComponentOverride: {
|
1533
1533
|
parameters?: {
|
1534
|
-
[key: string]: external$
|
1534
|
+
[key: string]: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
1535
1535
|
};
|
1536
1536
|
variant?: string;
|
1537
1537
|
};
|
@@ -1545,7 +1545,7 @@ interface external$7 {
|
|
1545
1545
|
ComponentOverridability: {
|
1546
1546
|
/** @description Defines component parameter value overrides. Keys are the parameter public ID. */
|
1547
1547
|
parameters?: {
|
1548
|
-
[key: string]: external$
|
1548
|
+
[key: string]: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["OverrideOptions"];
|
1549
1549
|
};
|
1550
1550
|
/** @description Allows overriding a display variant is allowed, if it is defined on the component the pattern is derived from. Default = false. */
|
1551
1551
|
variants?: boolean;
|
@@ -1586,7 +1586,7 @@ interface external$7 {
|
|
1586
1586
|
}[];
|
1587
1587
|
/** @description Variables needed to make calls to the data source */
|
1588
1588
|
variables?: {
|
1589
|
-
[key: string]: external$
|
1589
|
+
[key: string]: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
1590
1590
|
};
|
1591
1591
|
/** @description Custom configuration specific to the data source being defined (used to maintain UI state for custom integrations) */
|
1592
1592
|
custom?: {
|
@@ -1643,7 +1643,7 @@ interface external$7 {
|
|
1643
1643
|
method: "GET" | "POST" | "HEAD";
|
1644
1644
|
/** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys. */
|
1645
1645
|
variables?: {
|
1646
|
-
[key: string]: external$
|
1646
|
+
[key: string]: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
1647
1647
|
};
|
1648
1648
|
/** @description Custom configuration specific to the data source being defined */
|
1649
1649
|
custom?: {
|
@@ -1671,7 +1671,7 @@ interface external$7 {
|
|
1671
1671
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
1672
1672
|
*/
|
1673
1673
|
DataResourceDefinitions: {
|
1674
|
-
[key: string]: external$
|
1674
|
+
[key: string]: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
1675
1675
|
};
|
1676
1676
|
/** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
|
1677
1677
|
DataResourceDefinition: {
|
@@ -1685,7 +1685,7 @@ interface external$7 {
|
|
1685
1685
|
* If isPatternParameter is false or undefined, this has no meaning.
|
1686
1686
|
*/
|
1687
1687
|
ignorePatternParameterDefault?: boolean;
|
1688
|
-
variables?: external$
|
1688
|
+
variables?: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
1689
1689
|
};
|
1690
1690
|
/** @description Variable values for a data resource. */
|
1691
1691
|
DataResourceVariables: {
|
@@ -1716,7 +1716,7 @@ interface external$7 {
|
|
1716
1716
|
* This file was auto-generated by openapi-typescript.
|
1717
1717
|
* Do not make direct changes to the file.
|
1718
1718
|
*/
|
1719
|
-
interface paths$
|
1719
|
+
interface paths$6 {
|
1720
1720
|
"/api/v1/data-sources": {
|
1721
1721
|
get: {
|
1722
1722
|
parameters: {
|
@@ -1734,20 +1734,20 @@ interface paths$5 {
|
|
1734
1734
|
200: {
|
1735
1735
|
content: {
|
1736
1736
|
"application/json": {
|
1737
|
-
results: external$
|
1737
|
+
results: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataSource"][];
|
1738
1738
|
};
|
1739
1739
|
};
|
1740
1740
|
};
|
1741
|
-
400: external$
|
1742
|
-
401: external$
|
1743
|
-
403: external$
|
1744
|
-
429: external$
|
1745
|
-
500: external$
|
1741
|
+
400: external$7["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
1742
|
+
401: external$7["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
1743
|
+
403: external$7["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
1744
|
+
429: external$7["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
1745
|
+
500: external$7["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
1746
1746
|
};
|
1747
1747
|
};
|
1748
1748
|
};
|
1749
1749
|
}
|
1750
|
-
interface external$
|
1750
|
+
interface external$7 {
|
1751
1751
|
"swagger.yml": {
|
1752
1752
|
paths: {};
|
1753
1753
|
components: {
|
@@ -1761,25 +1761,25 @@ interface external$6 {
|
|
1761
1761
|
/** Request input validation failed */
|
1762
1762
|
BadRequestError: {
|
1763
1763
|
content: {
|
1764
|
-
"application/json": external$
|
1764
|
+
"application/json": external$7["swagger.yml"]["components"]["schemas"]["Error"];
|
1765
1765
|
};
|
1766
1766
|
};
|
1767
1767
|
/** API key or token was not valid */
|
1768
1768
|
UnauthorizedError: {
|
1769
1769
|
content: {
|
1770
|
-
"application/json": external$
|
1770
|
+
"application/json": external$7["swagger.yml"]["components"]["schemas"]["Error"];
|
1771
1771
|
};
|
1772
1772
|
};
|
1773
1773
|
/** Permission was denied */
|
1774
1774
|
ForbiddenError: {
|
1775
1775
|
content: {
|
1776
|
-
"application/json": external$
|
1776
|
+
"application/json": external$7["swagger.yml"]["components"]["schemas"]["Error"];
|
1777
1777
|
};
|
1778
1778
|
};
|
1779
1779
|
/** Resource not found */
|
1780
1780
|
NotFoundError: {
|
1781
1781
|
content: {
|
1782
|
-
"application/json": external$
|
1782
|
+
"application/json": external$7["swagger.yml"]["components"]["schemas"]["Error"];
|
1783
1783
|
};
|
1784
1784
|
};
|
1785
1785
|
/** Too many requests in allowed time period */
|
@@ -1798,7 +1798,7 @@ interface external$6 {
|
|
1798
1798
|
PublicIdProperty: string;
|
1799
1799
|
/** @description The definition of a component parameter */
|
1800
1800
|
ComponentDefinitionParameter: {
|
1801
|
-
id: external$
|
1801
|
+
id: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
1802
1802
|
/** @description Friendly name of the parameter */
|
1803
1803
|
name: string;
|
1804
1804
|
/** @description Appears next to the parameter in the Composition editor */
|
@@ -1810,7 +1810,7 @@ interface external$6 {
|
|
1810
1810
|
};
|
1811
1811
|
/** @description The definition of a named component slot that can contain other components */
|
1812
1812
|
ComponentDefinitionSlot: {
|
1813
|
-
id: external$
|
1813
|
+
id: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
1814
1814
|
/** @description Friendly name of the slot */
|
1815
1815
|
name: string;
|
1816
1816
|
/** @description A list of component definition public IDs that are allowed in this named slot */
|
@@ -1868,13 +1868,13 @@ interface external$6 {
|
|
1868
1868
|
};
|
1869
1869
|
/** @description The definition of a component variant */
|
1870
1870
|
ComponentDefinitionVariant: {
|
1871
|
-
id: external$
|
1871
|
+
id: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
1872
1872
|
/** @description Friendly name of the variant */
|
1873
1873
|
name: string;
|
1874
1874
|
};
|
1875
1875
|
/** @description Permission set for a component defintion */
|
1876
1876
|
ComponentDefinitionPermission: {
|
1877
|
-
roleId: external$
|
1877
|
+
roleId: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
1878
1878
|
/**
|
1879
1879
|
* @description Permission type for this permission ComponentDefinition:
|
1880
1880
|
* read | write | create | delete
|
@@ -1887,7 +1887,7 @@ interface external$6 {
|
|
1887
1887
|
};
|
1888
1888
|
/** @description Defines a component type that can live on a Composition */
|
1889
1889
|
ComponentDefinition: {
|
1890
|
-
id: external$
|
1890
|
+
id: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
1891
1891
|
/** @description Friendly name of the component definition */
|
1892
1892
|
name: string;
|
1893
1893
|
/**
|
@@ -1906,21 +1906,21 @@ interface external$6 {
|
|
1906
1906
|
*/
|
1907
1907
|
canBeComposition?: boolean;
|
1908
1908
|
/** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries. */
|
1909
|
-
parameters?: external$
|
1909
|
+
parameters?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
|
1910
1910
|
/**
|
1911
1911
|
* @description if this component uses team permissions or custom permissions
|
1912
1912
|
* @default true
|
1913
1913
|
*/
|
1914
1914
|
useTeamPermissions?: boolean;
|
1915
1915
|
/** @description Custom role permissions for this component definition */
|
1916
|
-
permissions?: external$
|
1916
|
+
permissions?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
|
1917
1917
|
/** @description The named slots for this component; placement areas where arrays of other components can be added. */
|
1918
|
-
slots?: external$
|
1919
|
-
slugSettings?: external$
|
1918
|
+
slots?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlot"][];
|
1919
|
+
slugSettings?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
1920
1920
|
/** @description Default component instance value */
|
1921
|
-
defaults?: external$
|
1921
|
+
defaults?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"] | null;
|
1922
1922
|
/** @description Named variants for this component; enables creation of visual variants that use the same parameter data */
|
1923
|
-
variants?: external$
|
1923
|
+
variants?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionVariant"][];
|
1924
1924
|
/** @description Created date string for this definition (ignored for writes) */
|
1925
1925
|
created?: string;
|
1926
1926
|
/** @description Last modified date string for this definition (ignored for writes) */
|
@@ -1928,7 +1928,7 @@ interface external$6 {
|
|
1928
1928
|
};
|
1929
1929
|
/** @description Defines a content type */
|
1930
1930
|
ContentType: {
|
1931
|
-
id: external$
|
1931
|
+
id: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
1932
1932
|
/** @description Friendly name of the content type */
|
1933
1933
|
name: string;
|
1934
1934
|
/**
|
@@ -1937,7 +1937,7 @@ interface external$6 {
|
|
1937
1937
|
*/
|
1938
1938
|
titleField?: string | null;
|
1939
1939
|
/** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
|
1940
|
-
fields?: external$
|
1940
|
+
fields?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
|
1941
1941
|
/** @description Created date string for this content type (ignored for writes) */
|
1942
1942
|
created?: string;
|
1943
1943
|
/** @description Last modified date string for this content type (ignored for writes) */
|
@@ -1949,7 +1949,7 @@ interface external$6 {
|
|
1949
1949
|
value: unknown;
|
1950
1950
|
/** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
|
1951
1951
|
type: string;
|
1952
|
-
connectedData?: external$
|
1952
|
+
connectedData?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
|
1953
1953
|
};
|
1954
1954
|
/**
|
1955
1955
|
* @description Defines a connection to a data element on a data resource.
|
@@ -1972,13 +1972,13 @@ interface external$6 {
|
|
1972
1972
|
type: string;
|
1973
1973
|
/** @description Component parameter values for the component instance */
|
1974
1974
|
parameters?: {
|
1975
|
-
[key: string]: external$
|
1975
|
+
[key: string]: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
1976
1976
|
};
|
1977
1977
|
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
1978
1978
|
variant?: string;
|
1979
1979
|
/** @description Slots containing any child components */
|
1980
1980
|
slots?: {
|
1981
|
-
[key: string]: external$
|
1981
|
+
[key: string]: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
|
1982
1982
|
};
|
1983
1983
|
/**
|
1984
1984
|
* @description Unique identifier of the component within the composition.
|
@@ -1988,13 +1988,13 @@ interface external$6 {
|
|
1988
1988
|
_id?: string;
|
1989
1989
|
/** @description Indicates this component instance should be sourced from a pattern library pattern. */
|
1990
1990
|
_pattern?: string;
|
1991
|
-
_dataResources?: external$
|
1991
|
+
_dataResources?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
1992
1992
|
/**
|
1993
1993
|
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
1994
1994
|
* Means nothing for PUTs; it will be ignored.
|
1995
1995
|
*/
|
1996
1996
|
_patternDataResources?: {
|
1997
|
-
[key: string]: external$
|
1997
|
+
[key: string]: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
1998
1998
|
};
|
1999
1999
|
/**
|
2000
2000
|
* @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
@@ -2018,7 +2018,7 @@ interface external$6 {
|
|
2018
2018
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
2019
2019
|
*/
|
2020
2020
|
_overrides?: {
|
2021
|
-
[key: string]: external$
|
2021
|
+
[key: string]: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
2022
2022
|
};
|
2023
2023
|
/**
|
2024
2024
|
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
@@ -2027,7 +2027,7 @@ interface external$6 {
|
|
2027
2027
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
2028
2028
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
2029
2029
|
*/
|
2030
|
-
_overridability?: external$
|
2030
|
+
_overridability?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
2031
2031
|
};
|
2032
2032
|
/** @description Defines the shape of the root component in a composition */
|
2033
2033
|
RootComponentInstance: {
|
@@ -2035,15 +2035,15 @@ interface external$6 {
|
|
2035
2035
|
type: string;
|
2036
2036
|
/** @description Component parameter values for the component instance */
|
2037
2037
|
parameters?: {
|
2038
|
-
[key: string]: external$
|
2038
|
+
[key: string]: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
2039
2039
|
};
|
2040
2040
|
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
2041
2041
|
variant?: string;
|
2042
2042
|
/** @description Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated. */
|
2043
|
-
projectMapNodes?: external$
|
2043
|
+
projectMapNodes?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionProjectMapNodeInfo"][];
|
2044
2044
|
/** @description Slots containing any child components */
|
2045
2045
|
slots?: {
|
2046
|
-
[key: string]: external$
|
2046
|
+
[key: string]: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
|
2047
2047
|
};
|
2048
2048
|
/** @description The public UUID of the composition. */
|
2049
2049
|
_id: string;
|
@@ -2051,7 +2051,7 @@ interface external$6 {
|
|
2051
2051
|
_slug?: string | null;
|
2052
2052
|
/** @description Friendly name of this component. */
|
2053
2053
|
_name: string;
|
2054
|
-
_dataResources?: external$
|
2054
|
+
_dataResources?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
2055
2055
|
/**
|
2056
2056
|
* @description Defines patch overrides to component IDs that live in the composition.
|
2057
2057
|
* This can be used to override parameters that are defined on patterns,
|
@@ -2065,7 +2065,7 @@ interface external$6 {
|
|
2065
2065
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
2066
2066
|
*/
|
2067
2067
|
_overrides?: {
|
2068
|
-
[key: string]: external$
|
2068
|
+
[key: string]: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
2069
2069
|
};
|
2070
2070
|
/**
|
2071
2071
|
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
@@ -2074,7 +2074,7 @@ interface external$6 {
|
|
2074
2074
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
2075
2075
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
2076
2076
|
*/
|
2077
|
-
_overridability?: external$
|
2077
|
+
_overridability?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
2078
2078
|
};
|
2079
2079
|
/**
|
2080
2080
|
* @description Defines how to override a specific component.
|
@@ -2084,7 +2084,7 @@ interface external$6 {
|
|
2084
2084
|
*/
|
2085
2085
|
ComponentOverride: {
|
2086
2086
|
parameters?: {
|
2087
|
-
[key: string]: external$
|
2087
|
+
[key: string]: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
2088
2088
|
};
|
2089
2089
|
variant?: string;
|
2090
2090
|
};
|
@@ -2098,7 +2098,7 @@ interface external$6 {
|
|
2098
2098
|
ComponentOverridability: {
|
2099
2099
|
/** @description Defines component parameter value overrides. Keys are the parameter public ID. */
|
2100
2100
|
parameters?: {
|
2101
|
-
[key: string]: external$
|
2101
|
+
[key: string]: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["OverrideOptions"];
|
2102
2102
|
};
|
2103
2103
|
/** @description Allows overriding a display variant is allowed, if it is defined on the component the pattern is derived from. Default = false. */
|
2104
2104
|
variants?: boolean;
|
@@ -2139,7 +2139,7 @@ interface external$6 {
|
|
2139
2139
|
}[];
|
2140
2140
|
/** @description Variables needed to make calls to the data source */
|
2141
2141
|
variables?: {
|
2142
|
-
[key: string]: external$
|
2142
|
+
[key: string]: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
2143
2143
|
};
|
2144
2144
|
/** @description Custom configuration specific to the data source being defined (used to maintain UI state for custom integrations) */
|
2145
2145
|
custom?: {
|
@@ -2196,7 +2196,7 @@ interface external$6 {
|
|
2196
2196
|
method: "GET" | "POST" | "HEAD";
|
2197
2197
|
/** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys. */
|
2198
2198
|
variables?: {
|
2199
|
-
[key: string]: external$
|
2199
|
+
[key: string]: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
2200
2200
|
};
|
2201
2201
|
/** @description Custom configuration specific to the data source being defined */
|
2202
2202
|
custom?: {
|
@@ -2224,7 +2224,7 @@ interface external$6 {
|
|
2224
2224
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
2225
2225
|
*/
|
2226
2226
|
DataResourceDefinitions: {
|
2227
|
-
[key: string]: external$
|
2227
|
+
[key: string]: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
2228
2228
|
};
|
2229
2229
|
/** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
|
2230
2230
|
DataResourceDefinition: {
|
@@ -2238,7 +2238,7 @@ interface external$6 {
|
|
2238
2238
|
* If isPatternParameter is false or undefined, this has no meaning.
|
2239
2239
|
*/
|
2240
2240
|
ignorePatternParameterDefault?: boolean;
|
2241
|
-
variables?: external$
|
2241
|
+
variables?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
2242
2242
|
};
|
2243
2243
|
/** @description Variable values for a data resource. */
|
2244
2244
|
DataResourceVariables: {
|
@@ -2269,7 +2269,7 @@ interface external$6 {
|
|
2269
2269
|
* This file was auto-generated by openapi-typescript.
|
2270
2270
|
* Do not make direct changes to the file.
|
2271
2271
|
*/
|
2272
|
-
interface paths$
|
2272
|
+
interface paths$5 {
|
2273
2273
|
"/api/v1/data-types": {
|
2274
2274
|
get: {
|
2275
2275
|
parameters: {
|
@@ -2282,31 +2282,31 @@ interface paths$4 {
|
|
2282
2282
|
200: {
|
2283
2283
|
content: {
|
2284
2284
|
"application/json": {
|
2285
|
-
results: external$
|
2285
|
+
results: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataType"][];
|
2286
2286
|
};
|
2287
2287
|
};
|
2288
2288
|
};
|
2289
|
-
400: external$
|
2290
|
-
401: external$
|
2291
|
-
403: external$
|
2292
|
-
429: external$
|
2293
|
-
500: external$
|
2289
|
+
400: external$6["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
2290
|
+
401: external$6["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
2291
|
+
403: external$6["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
2292
|
+
429: external$6["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
2293
|
+
500: external$6["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
2294
2294
|
};
|
2295
2295
|
};
|
2296
2296
|
put: {
|
2297
2297
|
responses: {
|
2298
2298
|
/** OK */
|
2299
2299
|
204: never;
|
2300
|
-
400: external$
|
2301
|
-
401: external$
|
2302
|
-
403: external$
|
2303
|
-
429: external$
|
2304
|
-
500: external$
|
2300
|
+
400: external$6["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
2301
|
+
401: external$6["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
2302
|
+
403: external$6["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
2303
|
+
429: external$6["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
2304
|
+
500: external$6["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
2305
2305
|
};
|
2306
2306
|
requestBody: {
|
2307
2307
|
content: {
|
2308
2308
|
"application/json": {
|
2309
|
-
data: external$
|
2309
|
+
data: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataType"];
|
2310
2310
|
/** Format: uuid */
|
2311
2311
|
projectId: string;
|
2312
2312
|
};
|
@@ -2317,11 +2317,11 @@ interface paths$4 {
|
|
2317
2317
|
responses: {
|
2318
2318
|
/** OK */
|
2319
2319
|
204: never;
|
2320
|
-
400: external$
|
2321
|
-
401: external$
|
2322
|
-
403: external$
|
2323
|
-
429: external$
|
2324
|
-
500: external$
|
2320
|
+
400: external$6["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
2321
|
+
401: external$6["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
2322
|
+
403: external$6["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
2323
|
+
429: external$6["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
2324
|
+
500: external$6["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
2325
2325
|
};
|
2326
2326
|
requestBody: {
|
2327
2327
|
content: {
|
@@ -2335,7 +2335,7 @@ interface paths$4 {
|
|
2335
2335
|
};
|
2336
2336
|
};
|
2337
2337
|
}
|
2338
|
-
interface external$
|
2338
|
+
interface external$6 {
|
2339
2339
|
"swagger.yml": {
|
2340
2340
|
paths: {};
|
2341
2341
|
components: {
|
@@ -2349,25 +2349,25 @@ interface external$5 {
|
|
2349
2349
|
/** Request input validation failed */
|
2350
2350
|
BadRequestError: {
|
2351
2351
|
content: {
|
2352
|
-
"application/json": external$
|
2352
|
+
"application/json": external$6["swagger.yml"]["components"]["schemas"]["Error"];
|
2353
2353
|
};
|
2354
2354
|
};
|
2355
2355
|
/** API key or token was not valid */
|
2356
2356
|
UnauthorizedError: {
|
2357
2357
|
content: {
|
2358
|
-
"application/json": external$
|
2358
|
+
"application/json": external$6["swagger.yml"]["components"]["schemas"]["Error"];
|
2359
2359
|
};
|
2360
2360
|
};
|
2361
2361
|
/** Permission was denied */
|
2362
2362
|
ForbiddenError: {
|
2363
2363
|
content: {
|
2364
|
-
"application/json": external$
|
2364
|
+
"application/json": external$6["swagger.yml"]["components"]["schemas"]["Error"];
|
2365
2365
|
};
|
2366
2366
|
};
|
2367
2367
|
/** Resource not found */
|
2368
2368
|
NotFoundError: {
|
2369
2369
|
content: {
|
2370
|
-
"application/json": external$
|
2370
|
+
"application/json": external$6["swagger.yml"]["components"]["schemas"]["Error"];
|
2371
2371
|
};
|
2372
2372
|
};
|
2373
2373
|
/** Too many requests in allowed time period */
|
@@ -2386,7 +2386,7 @@ interface external$5 {
|
|
2386
2386
|
PublicIdProperty: string;
|
2387
2387
|
/** @description The definition of a component parameter */
|
2388
2388
|
ComponentDefinitionParameter: {
|
2389
|
-
id: external$
|
2389
|
+
id: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
2390
2390
|
/** @description Friendly name of the parameter */
|
2391
2391
|
name: string;
|
2392
2392
|
/** @description Appears next to the parameter in the Composition editor */
|
@@ -2398,7 +2398,7 @@ interface external$5 {
|
|
2398
2398
|
};
|
2399
2399
|
/** @description The definition of a named component slot that can contain other components */
|
2400
2400
|
ComponentDefinitionSlot: {
|
2401
|
-
id: external$
|
2401
|
+
id: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
2402
2402
|
/** @description Friendly name of the slot */
|
2403
2403
|
name: string;
|
2404
2404
|
/** @description A list of component definition public IDs that are allowed in this named slot */
|
@@ -2456,13 +2456,13 @@ interface external$5 {
|
|
2456
2456
|
};
|
2457
2457
|
/** @description The definition of a component variant */
|
2458
2458
|
ComponentDefinitionVariant: {
|
2459
|
-
id: external$
|
2459
|
+
id: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
2460
2460
|
/** @description Friendly name of the variant */
|
2461
2461
|
name: string;
|
2462
2462
|
};
|
2463
2463
|
/** @description Permission set for a component defintion */
|
2464
2464
|
ComponentDefinitionPermission: {
|
2465
|
-
roleId: external$
|
2465
|
+
roleId: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
2466
2466
|
/**
|
2467
2467
|
* @description Permission type for this permission ComponentDefinition:
|
2468
2468
|
* read | write | create | delete
|
@@ -2475,7 +2475,7 @@ interface external$5 {
|
|
2475
2475
|
};
|
2476
2476
|
/** @description Defines a component type that can live on a Composition */
|
2477
2477
|
ComponentDefinition: {
|
2478
|
-
id: external$
|
2478
|
+
id: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
2479
2479
|
/** @description Friendly name of the component definition */
|
2480
2480
|
name: string;
|
2481
2481
|
/**
|
@@ -2494,21 +2494,21 @@ interface external$5 {
|
|
2494
2494
|
*/
|
2495
2495
|
canBeComposition?: boolean;
|
2496
2496
|
/** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries. */
|
2497
|
-
parameters?: external$
|
2497
|
+
parameters?: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
|
2498
2498
|
/**
|
2499
2499
|
* @description if this component uses team permissions or custom permissions
|
2500
2500
|
* @default true
|
2501
2501
|
*/
|
2502
2502
|
useTeamPermissions?: boolean;
|
2503
2503
|
/** @description Custom role permissions for this component definition */
|
2504
|
-
permissions?: external$
|
2504
|
+
permissions?: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
|
2505
2505
|
/** @description The named slots for this component; placement areas where arrays of other components can be added. */
|
2506
|
-
slots?: external$
|
2507
|
-
slugSettings?: external$
|
2506
|
+
slots?: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlot"][];
|
2507
|
+
slugSettings?: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
2508
2508
|
/** @description Default component instance value */
|
2509
|
-
defaults?: external$
|
2509
|
+
defaults?: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"] | null;
|
2510
2510
|
/** @description Named variants for this component; enables creation of visual variants that use the same parameter data */
|
2511
|
-
variants?: external$
|
2511
|
+
variants?: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionVariant"][];
|
2512
2512
|
/** @description Created date string for this definition (ignored for writes) */
|
2513
2513
|
created?: string;
|
2514
2514
|
/** @description Last modified date string for this definition (ignored for writes) */
|
@@ -2516,7 +2516,7 @@ interface external$5 {
|
|
2516
2516
|
};
|
2517
2517
|
/** @description Defines a content type */
|
2518
2518
|
ContentType: {
|
2519
|
-
id: external$
|
2519
|
+
id: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
2520
2520
|
/** @description Friendly name of the content type */
|
2521
2521
|
name: string;
|
2522
2522
|
/**
|
@@ -2525,7 +2525,7 @@ interface external$5 {
|
|
2525
2525
|
*/
|
2526
2526
|
titleField?: string | null;
|
2527
2527
|
/** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
|
2528
|
-
fields?: external$
|
2528
|
+
fields?: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
|
2529
2529
|
/** @description Created date string for this content type (ignored for writes) */
|
2530
2530
|
created?: string;
|
2531
2531
|
/** @description Last modified date string for this content type (ignored for writes) */
|
@@ -2537,7 +2537,7 @@ interface external$5 {
|
|
2537
2537
|
value: unknown;
|
2538
2538
|
/** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
|
2539
2539
|
type: string;
|
2540
|
-
connectedData?: external$
|
2540
|
+
connectedData?: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
|
2541
2541
|
};
|
2542
2542
|
/**
|
2543
2543
|
* @description Defines a connection to a data element on a data resource.
|
@@ -2560,13 +2560,13 @@ interface external$5 {
|
|
2560
2560
|
type: string;
|
2561
2561
|
/** @description Component parameter values for the component instance */
|
2562
2562
|
parameters?: {
|
2563
|
-
[key: string]: external$
|
2563
|
+
[key: string]: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
2564
2564
|
};
|
2565
2565
|
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
2566
2566
|
variant?: string;
|
2567
2567
|
/** @description Slots containing any child components */
|
2568
2568
|
slots?: {
|
2569
|
-
[key: string]: external$
|
2569
|
+
[key: string]: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
|
2570
2570
|
};
|
2571
2571
|
/**
|
2572
2572
|
* @description Unique identifier of the component within the composition.
|
@@ -2576,13 +2576,13 @@ interface external$5 {
|
|
2576
2576
|
_id?: string;
|
2577
2577
|
/** @description Indicates this component instance should be sourced from a pattern library pattern. */
|
2578
2578
|
_pattern?: string;
|
2579
|
-
_dataResources?: external$
|
2579
|
+
_dataResources?: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
2580
2580
|
/**
|
2581
2581
|
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
2582
2582
|
* Means nothing for PUTs; it will be ignored.
|
2583
2583
|
*/
|
2584
2584
|
_patternDataResources?: {
|
2585
|
-
[key: string]: external$
|
2585
|
+
[key: string]: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
2586
2586
|
};
|
2587
2587
|
/**
|
2588
2588
|
* @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
@@ -2606,7 +2606,7 @@ interface external$5 {
|
|
2606
2606
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
2607
2607
|
*/
|
2608
2608
|
_overrides?: {
|
2609
|
-
[key: string]: external$
|
2609
|
+
[key: string]: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
2610
2610
|
};
|
2611
2611
|
/**
|
2612
2612
|
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
@@ -2615,7 +2615,7 @@ interface external$5 {
|
|
2615
2615
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
2616
2616
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
2617
2617
|
*/
|
2618
|
-
_overridability?: external$
|
2618
|
+
_overridability?: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
2619
2619
|
};
|
2620
2620
|
/** @description Defines the shape of the root component in a composition */
|
2621
2621
|
RootComponentInstance: {
|
@@ -2623,15 +2623,15 @@ interface external$5 {
|
|
2623
2623
|
type: string;
|
2624
2624
|
/** @description Component parameter values for the component instance */
|
2625
2625
|
parameters?: {
|
2626
|
-
[key: string]: external$
|
2626
|
+
[key: string]: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
2627
2627
|
};
|
2628
2628
|
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
2629
2629
|
variant?: string;
|
2630
2630
|
/** @description Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated. */
|
2631
|
-
projectMapNodes?: external$
|
2631
|
+
projectMapNodes?: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionProjectMapNodeInfo"][];
|
2632
2632
|
/** @description Slots containing any child components */
|
2633
2633
|
slots?: {
|
2634
|
-
[key: string]: external$
|
2634
|
+
[key: string]: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
|
2635
2635
|
};
|
2636
2636
|
/** @description The public UUID of the composition. */
|
2637
2637
|
_id: string;
|
@@ -2639,7 +2639,7 @@ interface external$5 {
|
|
2639
2639
|
_slug?: string | null;
|
2640
2640
|
/** @description Friendly name of this component. */
|
2641
2641
|
_name: string;
|
2642
|
-
_dataResources?: external$
|
2642
|
+
_dataResources?: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
2643
2643
|
/**
|
2644
2644
|
* @description Defines patch overrides to component IDs that live in the composition.
|
2645
2645
|
* This can be used to override parameters that are defined on patterns,
|
@@ -2653,7 +2653,7 @@ interface external$5 {
|
|
2653
2653
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
2654
2654
|
*/
|
2655
2655
|
_overrides?: {
|
2656
|
-
[key: string]: external$
|
2656
|
+
[key: string]: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
2657
2657
|
};
|
2658
2658
|
/**
|
2659
2659
|
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
@@ -2662,7 +2662,7 @@ interface external$5 {
|
|
2662
2662
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
2663
2663
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
2664
2664
|
*/
|
2665
|
-
_overridability?: external$
|
2665
|
+
_overridability?: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
2666
2666
|
};
|
2667
2667
|
/**
|
2668
2668
|
* @description Defines how to override a specific component.
|
@@ -2672,7 +2672,7 @@ interface external$5 {
|
|
2672
2672
|
*/
|
2673
2673
|
ComponentOverride: {
|
2674
2674
|
parameters?: {
|
2675
|
-
[key: string]: external$
|
2675
|
+
[key: string]: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
2676
2676
|
};
|
2677
2677
|
variant?: string;
|
2678
2678
|
};
|
@@ -2686,7 +2686,7 @@ interface external$5 {
|
|
2686
2686
|
ComponentOverridability: {
|
2687
2687
|
/** @description Defines component parameter value overrides. Keys are the parameter public ID. */
|
2688
2688
|
parameters?: {
|
2689
|
-
[key: string]: external$
|
2689
|
+
[key: string]: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["OverrideOptions"];
|
2690
2690
|
};
|
2691
2691
|
/** @description Allows overriding a display variant is allowed, if it is defined on the component the pattern is derived from. Default = false. */
|
2692
2692
|
variants?: boolean;
|
@@ -2727,7 +2727,7 @@ interface external$5 {
|
|
2727
2727
|
}[];
|
2728
2728
|
/** @description Variables needed to make calls to the data source */
|
2729
2729
|
variables?: {
|
2730
|
-
[key: string]: external$
|
2730
|
+
[key: string]: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
2731
2731
|
};
|
2732
2732
|
/** @description Custom configuration specific to the data source being defined (used to maintain UI state for custom integrations) */
|
2733
2733
|
custom?: {
|
@@ -2784,7 +2784,7 @@ interface external$5 {
|
|
2784
2784
|
method: "GET" | "POST" | "HEAD";
|
2785
2785
|
/** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys. */
|
2786
2786
|
variables?: {
|
2787
|
-
[key: string]: external$
|
2787
|
+
[key: string]: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
2788
2788
|
};
|
2789
2789
|
/** @description Custom configuration specific to the data source being defined */
|
2790
2790
|
custom?: {
|
@@ -2812,7 +2812,7 @@ interface external$5 {
|
|
2812
2812
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
2813
2813
|
*/
|
2814
2814
|
DataResourceDefinitions: {
|
2815
|
-
[key: string]: external$
|
2815
|
+
[key: string]: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
2816
2816
|
};
|
2817
2817
|
/** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
|
2818
2818
|
DataResourceDefinition: {
|
@@ -2826,7 +2826,7 @@ interface external$5 {
|
|
2826
2826
|
* If isPatternParameter is false or undefined, this has no meaning.
|
2827
2827
|
*/
|
2828
2828
|
ignorePatternParameterDefault?: boolean;
|
2829
|
-
variables?: external$
|
2829
|
+
variables?: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
2830
2830
|
};
|
2831
2831
|
/** @description Variable values for a data resource. */
|
2832
2832
|
DataResourceVariables: {
|
@@ -2853,9 +2853,9 @@ interface external$5 {
|
|
2853
2853
|
};
|
2854
2854
|
}
|
2855
2855
|
|
2856
|
-
type DataTypeApi = paths$
|
2857
|
-
type DataSourcesApi = paths$
|
2858
|
-
type DataSourceApi = paths$
|
2856
|
+
type DataTypeApi = paths$5['/api/v1/data-types'];
|
2857
|
+
type DataSourcesApi = paths$6['/api/v1/data-sources'];
|
2858
|
+
type DataSourceApi = paths$7['/api/v1/data-source'];
|
2859
2859
|
/** Query parameter options for GET /api/v1/data-types */
|
2860
2860
|
type DataTypeGetParameters = DataTypeApi['get']['parameters']['query'];
|
2861
2861
|
/** The GET response from /api/v1/data-types */
|
@@ -2876,128 +2876,177 @@ type DataSourcesGetResponse = DataSourcesApi['get']['responses']['200']['content
|
|
2876
2876
|
type DataSourcePutParameters = DataSourceApi['put']['requestBody']['content']['application/json'];
|
2877
2877
|
/** Shape of the DELETE request body for /api/v1/data-source */
|
2878
2878
|
type DataSourceDeleteParameters = DataSourceApi['delete']['requestBody']['content']['application/json'];
|
2879
|
-
type DataType = components$
|
2880
|
-
type DataSource = components$
|
2881
|
-
type DataVariableDefinition = components$
|
2879
|
+
type DataType = components$4['schemas']['DataType'];
|
2880
|
+
type DataSource = components$4['schemas']['DataSource'];
|
2881
|
+
type DataVariableDefinition = components$4['schemas']['DataVariableDefinition'];
|
2882
2882
|
|
2883
2883
|
/**
|
2884
2884
|
* This file was auto-generated by openapi-typescript.
|
2885
2885
|
* Do not make direct changes to the file.
|
2886
2886
|
*/
|
2887
|
-
interface paths$
|
2887
|
+
interface paths$4 {
|
2888
2888
|
"/api/v1/canvas": {
|
2889
2889
|
get: {
|
2890
2890
|
parameters: {
|
2891
2891
|
query: {
|
2892
|
-
/**
|
2893
|
-
|
2894
|
-
|
2895
|
-
|
2896
|
-
|
2897
|
-
|
2892
|
+
/**
|
2893
|
+
* Specify a single composition ID to fetch. Response will be a single composition.
|
2894
|
+
* This is a primary query parameter, and cannot be used with any other primary query parameters.
|
2895
|
+
*/
|
2896
|
+
compositionId?: components$3["parameters"]["compositionId"];
|
2897
|
+
/**
|
2898
|
+
* Specify a historical composition version ID to fetch (retrieved from the canvas-history API).
|
2899
|
+
* Must be used with the `compositionId` parameter.
|
2900
|
+
*/
|
2901
|
+
versionId?: components$3["parameters"]["versionId"];
|
2902
|
+
/**
|
2903
|
+
* Specify multiple composition IDs to fetch. Response type will be a list.
|
2904
|
+
* This is a primary query parameter, and cannot be used with any other primary query parameters.
|
2905
|
+
*/
|
2906
|
+
compositionIDs?: components$3["parameters"]["compositionIDs"];
|
2907
|
+
/**
|
2908
|
+
* Filters composition lists by the user who created them. The user is specified by their identity subject.
|
2909
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
2910
|
+
*/
|
2911
|
+
createdBy?: components$3["parameters"]["createdBy"];
|
2898
2912
|
/**
|
2899
2913
|
* Matches compositions where their name, slug, or definition name contains the specified keyword.
|
2900
2914
|
* NOT a full text search; does not match composition contents.
|
2915
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
2901
2916
|
*/
|
2902
|
-
keyword?: components$
|
2903
|
-
/**
|
2904
|
-
|
2905
|
-
|
2906
|
-
|
2907
|
-
|
2908
|
-
|
2917
|
+
keyword?: components$3["parameters"]["keyword"];
|
2918
|
+
/**
|
2919
|
+
* Max number of records to return
|
2920
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
2921
|
+
*/
|
2922
|
+
limit?: components$3["parameters"]["limit"];
|
2923
|
+
/**
|
2924
|
+
* Number of records to skip
|
2925
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
2926
|
+
*/
|
2927
|
+
offset?: components$3["parameters"]["offset"];
|
2928
|
+
/**
|
2929
|
+
* Sets the sorting of the results. If unspecified, results are sorted by name ascending.
|
2930
|
+
* When using primary query parameters, this parameter is ignored.
|
2931
|
+
*/
|
2932
|
+
orderBy?: components$3["parameters"]["orderBy"];
|
2909
2933
|
/**
|
2910
2934
|
* Matches compositions based on whether they are a pattern composition or a regular composition.
|
2911
2935
|
* If true, only pattern compositions will be returned.
|
2912
2936
|
* If false, only regular compositions will be returned.
|
2913
2937
|
* If omitted, both pattern and regular compositions will be returned.
|
2938
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
2914
2939
|
*/
|
2915
|
-
pattern?: components$
|
2940
|
+
pattern?: components$3["parameters"]["pattern"];
|
2916
2941
|
/** The project the composition(s) are on. */
|
2917
|
-
projectId: components$
|
2918
|
-
/**
|
2919
|
-
|
2920
|
-
|
2921
|
-
|
2922
|
-
|
2923
|
-
|
2942
|
+
projectId: components$3["parameters"]["projectId"];
|
2943
|
+
/**
|
2944
|
+
* Specify a project map ID to fetch by path or node ID from.
|
2945
|
+
* If not specified, the default project map for the projectId is used.
|
2946
|
+
* Only used when fetching by projectMapNodeId or projectMapNodePath.
|
2947
|
+
*/
|
2948
|
+
projectMapId?: components$3["parameters"]["projectMapId"];
|
2949
|
+
/**
|
2950
|
+
* Specify a single composition to fetch by assodicated project map node ID. Response will be a single composition.
|
2951
|
+
* This is a primary query parameter, and cannot be used with any other primary query parameters.
|
2952
|
+
*/
|
2953
|
+
projectMapNodeId?: components$3["parameters"]["projectMapNodeId"];
|
2954
|
+
/**
|
2955
|
+
* Specify a single composition to fetch by assodicated project map node path. Response will be a single composition.
|
2956
|
+
* This is a primary query parameter, and cannot be used with any other primary query parameters.
|
2957
|
+
*/
|
2958
|
+
projectMapNodePath?: components$3["parameters"]["projectMapNodePath"];
|
2924
2959
|
/**
|
2925
2960
|
* @deprecated Signals an enhancer proxy to skip processing enhancements to the data and return raw data only.
|
2926
2961
|
* This improves performance if you do not require enhanced component data.
|
2927
2962
|
* If calling the Canvas API directly with no enhancer proxy, this has no effect.
|
2928
2963
|
*/
|
2929
|
-
skipEnhance?: components$
|
2964
|
+
skipEnhance?: components$3["parameters"]["skipEnhance"];
|
2930
2965
|
/**
|
2931
2966
|
* If true, any pattern references in the composition will be left unresolved.
|
2932
2967
|
* This is appropriate if you intend to serialize the composition without patterns
|
2933
2968
|
* embedded into it, and serialize the pattern data separately.
|
2934
2969
|
*/
|
2935
|
-
skipPatternResolution?: components$
|
2970
|
+
skipPatternResolution?: components$3["parameters"]["skipPatternResolution"];
|
2936
2971
|
/** @deprecated This parameter is unused and has no effect. Passing this parameter will become an error in the future. */
|
2937
|
-
skipParameterResolution?: components$
|
2972
|
+
skipParameterResolution?: components$3["parameters"]["skipParameterResolution"];
|
2938
2973
|
/**
|
2939
2974
|
* If true, any pattern override data is not resolved by the API.
|
2940
2975
|
* This is intended for internal use in the Canvas editor, and should not be used.
|
2941
2976
|
* Passing this parameter automatically implies withComponentIDs to be true.
|
2942
2977
|
*/
|
2943
|
-
skipOverridesResolution?: components$
|
2944
|
-
/**
|
2945
|
-
|
2946
|
-
|
2947
|
-
|
2948
|
-
|
2949
|
-
|
2978
|
+
skipOverridesResolution?: components$3["parameters"]["skipOverridesResolution"];
|
2979
|
+
/**
|
2980
|
+
* Specify a single composition to fetch by slug. Response will be a single composition.
|
2981
|
+
* This is a primary query parameter, and cannot be used with any other primary query parameters.
|
2982
|
+
*/
|
2983
|
+
slug?: components$3["parameters"]["slug"];
|
2984
|
+
/**
|
2985
|
+
* Publishing state to fetch. 0 = draft, 64 = published.
|
2986
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
2987
|
+
*/
|
2988
|
+
state?: components$3["parameters"]["state"];
|
2989
|
+
/**
|
2990
|
+
* The component type (by public ID) to filter by. Note that this filters the root composition type only; components in slots are not matched by this filter.
|
2991
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
2992
|
+
*/
|
2993
|
+
type?: components$3["parameters"]["type"];
|
2950
2994
|
/**
|
2951
2995
|
* @deprecated Filters composition lists by the UI status of the composition.
|
2952
2996
|
* This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
|
2997
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
2953
2998
|
*/
|
2954
|
-
uiStatus?: components$
|
2999
|
+
uiStatus?: components$3["parameters"]["uiStatus"];
|
2955
3000
|
/**
|
2956
3001
|
* Filters out compositions without attached node or filters out compositions with attached nodes
|
2957
3002
|
* in case of FALSE. If not specified - no filtration applied.
|
3003
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
2958
3004
|
*/
|
2959
|
-
attachedToProjectMap?: components$
|
2960
|
-
/**
|
2961
|
-
|
3005
|
+
attachedToProjectMap?: components$3["parameters"]["attachedToProjectMap"];
|
3006
|
+
/**
|
3007
|
+
* Filters composition lists by the user who last updated them. The user is specified by their identity subject.
|
3008
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
3009
|
+
*/
|
3010
|
+
updatedBy?: components$3["parameters"]["updatedBy"];
|
2962
3011
|
/**
|
2963
3012
|
* If true the `_id` unique identifier of each non-root component will be part of the response data.
|
2964
3013
|
* If false, the `_id` will not be present in the API response.
|
2965
3014
|
*/
|
2966
|
-
withComponentIDs?: components$
|
3015
|
+
withComponentIDs?: components$3["parameters"]["withComponentIDs"];
|
2967
3016
|
/**
|
2968
3017
|
* Controls whether the total count of results will be returned along with the current results page in a list.
|
2969
3018
|
* Has no effect when not fetching a list. This does impact performance when enabled.
|
2970
3019
|
*/
|
2971
|
-
withTotalCount?: components$
|
3020
|
+
withTotalCount?: components$3["parameters"]["withTotalCount"];
|
2972
3021
|
/**
|
2973
3022
|
* @deprecated Returns the UI status string of the composition.
|
2974
3023
|
* This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
|
2975
3024
|
*/
|
2976
|
-
withUIStatus?: components$
|
3025
|
+
withUIStatus?: components$3["parameters"]["withUIStatus"];
|
2977
3026
|
/** Includes project map node information in the composition results */
|
2978
|
-
withProjectMapNodes?: components$
|
3027
|
+
withProjectMapNodes?: components$3["parameters"]["withProjectMapNodes"];
|
2979
3028
|
/** @deprecated Includes content source map metadata on supported parameters */
|
2980
|
-
withContentSourceMap?: components$
|
3029
|
+
withContentSourceMap?: components$3["parameters"]["withContentSourceMap"];
|
2981
3030
|
};
|
2982
3031
|
};
|
2983
3032
|
responses: {
|
2984
3033
|
/** OK */
|
2985
3034
|
200: {
|
2986
3035
|
content: {
|
2987
|
-
"application/json": components$
|
3036
|
+
"application/json": components$3["schemas"]["CompositionListResponse"] | components$3["schemas"]["CompositionApiResponse"];
|
2988
3037
|
};
|
2989
3038
|
};
|
2990
|
-
400: external$
|
2991
|
-
401: external$
|
2992
|
-
403: external$
|
3039
|
+
400: external$5["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
3040
|
+
401: external$5["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
3041
|
+
403: external$5["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
2993
3042
|
/** Composition not found */
|
2994
3043
|
404: {
|
2995
3044
|
content: {
|
2996
3045
|
"text/plain": string;
|
2997
3046
|
};
|
2998
3047
|
};
|
2999
|
-
429: external$
|
3000
|
-
500: external$
|
3048
|
+
429: external$5["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
3049
|
+
500: external$5["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
3001
3050
|
};
|
3002
3051
|
};
|
3003
3052
|
/** Upserts a composition */
|
@@ -3005,11 +3054,11 @@ interface paths$3 {
|
|
3005
3054
|
responses: {
|
3006
3055
|
/** OK */
|
3007
3056
|
204: never;
|
3008
|
-
400: external$
|
3009
|
-
401: external$
|
3010
|
-
403: external$
|
3011
|
-
429: external$
|
3012
|
-
500: external$
|
3057
|
+
400: external$5["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
3058
|
+
401: external$5["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
3059
|
+
403: external$5["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
3060
|
+
429: external$5["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
3061
|
+
500: external$5["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
3013
3062
|
};
|
3014
3063
|
requestBody: {
|
3015
3064
|
content: {
|
@@ -3021,7 +3070,7 @@ interface paths$3 {
|
|
3021
3070
|
projectId: string;
|
3022
3071
|
/** @description The publishing state to upsert into. 0 = draft, 64 = published */
|
3023
3072
|
state: number;
|
3024
|
-
composition: external$
|
3073
|
+
composition: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["RootComponentInstance"];
|
3025
3074
|
/**
|
3026
3075
|
* @description True if the composition is a pattern (which can be referenced on other compositions)
|
3027
3076
|
* @default false
|
@@ -3040,11 +3089,11 @@ interface paths$3 {
|
|
3040
3089
|
responses: {
|
3041
3090
|
/** OK */
|
3042
3091
|
204: never;
|
3043
|
-
400: external$
|
3044
|
-
401: external$
|
3045
|
-
403: external$
|
3046
|
-
429: external$
|
3047
|
-
500: external$
|
3092
|
+
400: external$5["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
3093
|
+
401: external$5["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
3094
|
+
403: external$5["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
3095
|
+
429: external$5["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
3096
|
+
500: external$5["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
3048
3097
|
};
|
3049
3098
|
requestBody: {
|
3050
3099
|
content: {
|
@@ -3074,7 +3123,7 @@ interface paths$3 {
|
|
3074
3123
|
};
|
3075
3124
|
};
|
3076
3125
|
}
|
3077
|
-
interface components$
|
3126
|
+
interface components$3 {
|
3078
3127
|
schemas: {
|
3079
3128
|
CompositionApiResponse: {
|
3080
3129
|
/** @description Publishing state to fetch. 0 = draft, 64 = published. */
|
@@ -3084,7 +3133,7 @@ interface components$2 {
|
|
3084
3133
|
* @description UI status value. Subject to change without notice; do not rely on this value. Only present when `withUIStatus` option is true.
|
3085
3134
|
* @enum {string}
|
3086
3135
|
*/
|
3087
|
-
uiStatus?: "Draft" | "Modified" | "Published" | "Orphan";
|
3136
|
+
uiStatus?: "Draft" | "Modified" | "Published" | "Orphan" | "Previous";
|
3088
3137
|
/**
|
3089
3138
|
* Format: uuid
|
3090
3139
|
* @description The project ID that this layout data is part of
|
@@ -3102,10 +3151,10 @@ interface components$2 {
|
|
3102
3151
|
modified: string;
|
3103
3152
|
/** @description Whether this composition is a pattern (can be referenced by other compositions, not treated as a composition) */
|
3104
3153
|
pattern: boolean;
|
3105
|
-
composition: external$
|
3154
|
+
composition: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["RootComponentInstance"];
|
3106
3155
|
};
|
3107
3156
|
CompositionListResponse: {
|
3108
|
-
compositions: components$
|
3157
|
+
compositions: components$3["schemas"]["CompositionApiResponse"][];
|
3109
3158
|
/** @description Total number of compositions that match the query. Only present when `withTotalCount` option is true. */
|
3110
3159
|
totalCount?: number;
|
3111
3160
|
};
|
@@ -3113,25 +3162,61 @@ interface components$2 {
|
|
3113
3162
|
parameters: {
|
3114
3163
|
/** @description The project the composition(s) are on. */
|
3115
3164
|
projectId: string;
|
3116
|
-
/**
|
3165
|
+
/**
|
3166
|
+
* @description Specify a single composition ID to fetch. Response will be a single composition.
|
3167
|
+
* This is a primary query parameter, and cannot be used with any other primary query parameters.
|
3168
|
+
*/
|
3117
3169
|
compositionId: string;
|
3118
|
-
/**
|
3170
|
+
/**
|
3171
|
+
* @description Specify multiple composition IDs to fetch. Response type will be a list.
|
3172
|
+
* This is a primary query parameter, and cannot be used with any other primary query parameters.
|
3173
|
+
*/
|
3119
3174
|
compositionIDs: string[];
|
3120
|
-
/**
|
3175
|
+
/**
|
3176
|
+
* @description Specify a historical composition version ID to fetch (retrieved from the canvas-history API).
|
3177
|
+
* Must be used with the `compositionId` parameter.
|
3178
|
+
*/
|
3179
|
+
versionId: string;
|
3180
|
+
/**
|
3181
|
+
* @description Specify a single composition to fetch by slug. Response will be a single composition.
|
3182
|
+
* This is a primary query parameter, and cannot be used with any other primary query parameters.
|
3183
|
+
*/
|
3121
3184
|
slug: string;
|
3122
|
-
/**
|
3185
|
+
/**
|
3186
|
+
* @description Specify a single composition to fetch by assodicated project map node ID. Response will be a single composition.
|
3187
|
+
* This is a primary query parameter, and cannot be used with any other primary query parameters.
|
3188
|
+
*/
|
3123
3189
|
projectMapNodeId: string;
|
3124
|
-
/**
|
3190
|
+
/**
|
3191
|
+
* @description Specify a single composition to fetch by assodicated project map node path. Response will be a single composition.
|
3192
|
+
* This is a primary query parameter, and cannot be used with any other primary query parameters.
|
3193
|
+
*/
|
3125
3194
|
projectMapNodePath: string;
|
3126
|
-
/**
|
3195
|
+
/**
|
3196
|
+
* @description Specify a project map ID to fetch by path or node ID from.
|
3197
|
+
* If not specified, the default project map for the projectId is used.
|
3198
|
+
* Only used when fetching by projectMapNodeId or projectMapNodePath.
|
3199
|
+
*/
|
3127
3200
|
projectMapId: string;
|
3128
|
-
/**
|
3201
|
+
/**
|
3202
|
+
* @description The component type (by public ID) to filter by. Note that this filters the root composition type only; components in slots are not matched by this filter.
|
3203
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
3204
|
+
*/
|
3129
3205
|
type: string[];
|
3130
|
-
/**
|
3206
|
+
/**
|
3207
|
+
* @description Publishing state to fetch. 0 = draft, 64 = published.
|
3208
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
3209
|
+
*/
|
3131
3210
|
state: number;
|
3132
|
-
/**
|
3211
|
+
/**
|
3212
|
+
* @description Number of records to skip
|
3213
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
3214
|
+
*/
|
3133
3215
|
offset: number;
|
3134
|
-
/**
|
3216
|
+
/**
|
3217
|
+
* @description Max number of records to return
|
3218
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
3219
|
+
*/
|
3135
3220
|
limit: number;
|
3136
3221
|
/**
|
3137
3222
|
* @deprecated
|
@@ -3165,6 +3250,7 @@ interface components$2 {
|
|
3165
3250
|
/**
|
3166
3251
|
* @description Matches compositions where their name, slug, or definition name contains the specified keyword.
|
3167
3252
|
* NOT a full text search; does not match composition contents.
|
3253
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
3168
3254
|
*/
|
3169
3255
|
keyword: string;
|
3170
3256
|
/**
|
@@ -3172,9 +3258,13 @@ interface components$2 {
|
|
3172
3258
|
* If true, only pattern compositions will be returned.
|
3173
3259
|
* If false, only regular compositions will be returned.
|
3174
3260
|
* If omitted, both pattern and regular compositions will be returned.
|
3261
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
3175
3262
|
*/
|
3176
3263
|
pattern: boolean;
|
3177
|
-
/**
|
3264
|
+
/**
|
3265
|
+
* @description Sets the sorting of the results. If unspecified, results are sorted by name ascending.
|
3266
|
+
* When using primary query parameters, this parameter is ignored.
|
3267
|
+
*/
|
3178
3268
|
orderBy: ("updated_at_DESC" | "updated_at_ASC" | "created_at_DESC" | "created_at_ASC" | "name_DESC" | "name_ASC" | "slug_DESC" | "slug_ASC")[];
|
3179
3269
|
/**
|
3180
3270
|
* @deprecated
|
@@ -3186,11 +3276,13 @@ interface components$2 {
|
|
3186
3276
|
* @deprecated
|
3187
3277
|
* @description Filters composition lists by the UI status of the composition.
|
3188
3278
|
* This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
|
3279
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
3189
3280
|
*/
|
3190
3281
|
uiStatus: ("Draft" | "Modified" | "Published" | "Orphan")[];
|
3191
3282
|
/**
|
3192
3283
|
* @description Filters out compositions without attached node or filters out compositions with attached nodes
|
3193
3284
|
* in case of FALSE. If not specified - no filtration applied.
|
3285
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
3194
3286
|
*/
|
3195
3287
|
attachedToProjectMap: boolean;
|
3196
3288
|
/** @description Includes project map node information in the composition results */
|
@@ -3200,9 +3292,15 @@ interface components$2 {
|
|
3200
3292
|
* @description Includes content source map metadata on supported parameters
|
3201
3293
|
*/
|
3202
3294
|
withContentSourceMap: boolean;
|
3203
|
-
/**
|
3295
|
+
/**
|
3296
|
+
* @description Filters composition lists by the user who created them. The user is specified by their identity subject.
|
3297
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
3298
|
+
*/
|
3204
3299
|
createdBy: string;
|
3205
|
-
/**
|
3300
|
+
/**
|
3301
|
+
* @description Filters composition lists by the user who last updated them. The user is specified by their identity subject.
|
3302
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
3303
|
+
*/
|
3206
3304
|
updatedBy: string;
|
3207
3305
|
/**
|
3208
3306
|
* @description Controls whether the total count of results will be returned along with the current results page in a list.
|
@@ -3211,7 +3309,7 @@ interface components$2 {
|
|
3211
3309
|
withTotalCount: boolean;
|
3212
3310
|
};
|
3213
3311
|
}
|
3214
|
-
interface external$
|
3312
|
+
interface external$5 {
|
3215
3313
|
"swagger.yml": {
|
3216
3314
|
paths: {};
|
3217
3315
|
components: {
|
@@ -3225,25 +3323,25 @@ interface external$4 {
|
|
3225
3323
|
/** Request input validation failed */
|
3226
3324
|
BadRequestError: {
|
3227
3325
|
content: {
|
3228
|
-
"application/json": external$
|
3326
|
+
"application/json": external$5["swagger.yml"]["components"]["schemas"]["Error"];
|
3229
3327
|
};
|
3230
3328
|
};
|
3231
3329
|
/** API key or token was not valid */
|
3232
3330
|
UnauthorizedError: {
|
3233
3331
|
content: {
|
3234
|
-
"application/json": external$
|
3332
|
+
"application/json": external$5["swagger.yml"]["components"]["schemas"]["Error"];
|
3235
3333
|
};
|
3236
3334
|
};
|
3237
3335
|
/** Permission was denied */
|
3238
3336
|
ForbiddenError: {
|
3239
3337
|
content: {
|
3240
|
-
"application/json": external$
|
3338
|
+
"application/json": external$5["swagger.yml"]["components"]["schemas"]["Error"];
|
3241
3339
|
};
|
3242
3340
|
};
|
3243
3341
|
/** Resource not found */
|
3244
3342
|
NotFoundError: {
|
3245
3343
|
content: {
|
3246
|
-
"application/json": external$
|
3344
|
+
"application/json": external$5["swagger.yml"]["components"]["schemas"]["Error"];
|
3247
3345
|
};
|
3248
3346
|
};
|
3249
3347
|
/** Too many requests in allowed time period */
|
@@ -3262,7 +3360,7 @@ interface external$4 {
|
|
3262
3360
|
PublicIdProperty: string;
|
3263
3361
|
/** @description The definition of a component parameter */
|
3264
3362
|
ComponentDefinitionParameter: {
|
3265
|
-
id: external$
|
3363
|
+
id: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
3266
3364
|
/** @description Friendly name of the parameter */
|
3267
3365
|
name: string;
|
3268
3366
|
/** @description Appears next to the parameter in the Composition editor */
|
@@ -3274,7 +3372,7 @@ interface external$4 {
|
|
3274
3372
|
};
|
3275
3373
|
/** @description The definition of a named component slot that can contain other components */
|
3276
3374
|
ComponentDefinitionSlot: {
|
3277
|
-
id: external$
|
3375
|
+
id: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
3278
3376
|
/** @description Friendly name of the slot */
|
3279
3377
|
name: string;
|
3280
3378
|
/** @description A list of component definition public IDs that are allowed in this named slot */
|
@@ -3332,13 +3430,13 @@ interface external$4 {
|
|
3332
3430
|
};
|
3333
3431
|
/** @description The definition of a component variant */
|
3334
3432
|
ComponentDefinitionVariant: {
|
3335
|
-
id: external$
|
3433
|
+
id: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
3336
3434
|
/** @description Friendly name of the variant */
|
3337
3435
|
name: string;
|
3338
3436
|
};
|
3339
3437
|
/** @description Permission set for a component defintion */
|
3340
3438
|
ComponentDefinitionPermission: {
|
3341
|
-
roleId: external$
|
3439
|
+
roleId: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
3342
3440
|
/**
|
3343
3441
|
* @description Permission type for this permission ComponentDefinition:
|
3344
3442
|
* read | write | create | delete
|
@@ -3351,7 +3449,7 @@ interface external$4 {
|
|
3351
3449
|
};
|
3352
3450
|
/** @description Defines a component type that can live on a Composition */
|
3353
3451
|
ComponentDefinition: {
|
3354
|
-
id: external$
|
3452
|
+
id: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
3355
3453
|
/** @description Friendly name of the component definition */
|
3356
3454
|
name: string;
|
3357
3455
|
/**
|
@@ -3370,21 +3468,21 @@ interface external$4 {
|
|
3370
3468
|
*/
|
3371
3469
|
canBeComposition?: boolean;
|
3372
3470
|
/** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries. */
|
3373
|
-
parameters?: external$
|
3471
|
+
parameters?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
|
3374
3472
|
/**
|
3375
3473
|
* @description if this component uses team permissions or custom permissions
|
3376
3474
|
* @default true
|
3377
3475
|
*/
|
3378
3476
|
useTeamPermissions?: boolean;
|
3379
3477
|
/** @description Custom role permissions for this component definition */
|
3380
|
-
permissions?: external$
|
3478
|
+
permissions?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
|
3381
3479
|
/** @description The named slots for this component; placement areas where arrays of other components can be added. */
|
3382
|
-
slots?: external$
|
3383
|
-
slugSettings?: external$
|
3480
|
+
slots?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlot"][];
|
3481
|
+
slugSettings?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
3384
3482
|
/** @description Default component instance value */
|
3385
|
-
defaults?: external$
|
3483
|
+
defaults?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"] | null;
|
3386
3484
|
/** @description Named variants for this component; enables creation of visual variants that use the same parameter data */
|
3387
|
-
variants?: external$
|
3485
|
+
variants?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionVariant"][];
|
3388
3486
|
/** @description Created date string for this definition (ignored for writes) */
|
3389
3487
|
created?: string;
|
3390
3488
|
/** @description Last modified date string for this definition (ignored for writes) */
|
@@ -3392,7 +3490,7 @@ interface external$4 {
|
|
3392
3490
|
};
|
3393
3491
|
/** @description Defines a content type */
|
3394
3492
|
ContentType: {
|
3395
|
-
id: external$
|
3493
|
+
id: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
3396
3494
|
/** @description Friendly name of the content type */
|
3397
3495
|
name: string;
|
3398
3496
|
/**
|
@@ -3401,7 +3499,7 @@ interface external$4 {
|
|
3401
3499
|
*/
|
3402
3500
|
titleField?: string | null;
|
3403
3501
|
/** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
|
3404
|
-
fields?: external$
|
3502
|
+
fields?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
|
3405
3503
|
/** @description Created date string for this content type (ignored for writes) */
|
3406
3504
|
created?: string;
|
3407
3505
|
/** @description Last modified date string for this content type (ignored for writes) */
|
@@ -3413,7 +3511,7 @@ interface external$4 {
|
|
3413
3511
|
value: unknown;
|
3414
3512
|
/** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
|
3415
3513
|
type: string;
|
3416
|
-
connectedData?: external$
|
3514
|
+
connectedData?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
|
3417
3515
|
};
|
3418
3516
|
/**
|
3419
3517
|
* @description Defines a connection to a data element on a data resource.
|
@@ -3436,13 +3534,13 @@ interface external$4 {
|
|
3436
3534
|
type: string;
|
3437
3535
|
/** @description Component parameter values for the component instance */
|
3438
3536
|
parameters?: {
|
3439
|
-
[key: string]: external$
|
3537
|
+
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
3440
3538
|
};
|
3441
3539
|
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
3442
3540
|
variant?: string;
|
3443
3541
|
/** @description Slots containing any child components */
|
3444
3542
|
slots?: {
|
3445
|
-
[key: string]: external$
|
3543
|
+
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
|
3446
3544
|
};
|
3447
3545
|
/**
|
3448
3546
|
* @description Unique identifier of the component within the composition.
|
@@ -3452,13 +3550,13 @@ interface external$4 {
|
|
3452
3550
|
_id?: string;
|
3453
3551
|
/** @description Indicates this component instance should be sourced from a pattern library pattern. */
|
3454
3552
|
_pattern?: string;
|
3455
|
-
_dataResources?: external$
|
3553
|
+
_dataResources?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
3456
3554
|
/**
|
3457
3555
|
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
3458
3556
|
* Means nothing for PUTs; it will be ignored.
|
3459
3557
|
*/
|
3460
3558
|
_patternDataResources?: {
|
3461
|
-
[key: string]: external$
|
3559
|
+
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
3462
3560
|
};
|
3463
3561
|
/**
|
3464
3562
|
* @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
@@ -3482,7 +3580,7 @@ interface external$4 {
|
|
3482
3580
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
3483
3581
|
*/
|
3484
3582
|
_overrides?: {
|
3485
|
-
[key: string]: external$
|
3583
|
+
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
3486
3584
|
};
|
3487
3585
|
/**
|
3488
3586
|
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
@@ -3491,7 +3589,7 @@ interface external$4 {
|
|
3491
3589
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
3492
3590
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
3493
3591
|
*/
|
3494
|
-
_overridability?: external$
|
3592
|
+
_overridability?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
3495
3593
|
};
|
3496
3594
|
/** @description Defines the shape of the root component in a composition */
|
3497
3595
|
RootComponentInstance: {
|
@@ -3499,15 +3597,15 @@ interface external$4 {
|
|
3499
3597
|
type: string;
|
3500
3598
|
/** @description Component parameter values for the component instance */
|
3501
3599
|
parameters?: {
|
3502
|
-
[key: string]: external$
|
3600
|
+
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
3503
3601
|
};
|
3504
3602
|
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
3505
3603
|
variant?: string;
|
3506
3604
|
/** @description Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated. */
|
3507
|
-
projectMapNodes?: external$
|
3605
|
+
projectMapNodes?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionProjectMapNodeInfo"][];
|
3508
3606
|
/** @description Slots containing any child components */
|
3509
3607
|
slots?: {
|
3510
|
-
[key: string]: external$
|
3608
|
+
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
|
3511
3609
|
};
|
3512
3610
|
/** @description The public UUID of the composition. */
|
3513
3611
|
_id: string;
|
@@ -3515,7 +3613,7 @@ interface external$4 {
|
|
3515
3613
|
_slug?: string | null;
|
3516
3614
|
/** @description Friendly name of this component. */
|
3517
3615
|
_name: string;
|
3518
|
-
_dataResources?: external$
|
3616
|
+
_dataResources?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
3519
3617
|
/**
|
3520
3618
|
* @description Defines patch overrides to component IDs that live in the composition.
|
3521
3619
|
* This can be used to override parameters that are defined on patterns,
|
@@ -3529,7 +3627,7 @@ interface external$4 {
|
|
3529
3627
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
3530
3628
|
*/
|
3531
3629
|
_overrides?: {
|
3532
|
-
[key: string]: external$
|
3630
|
+
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
3533
3631
|
};
|
3534
3632
|
/**
|
3535
3633
|
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
@@ -3538,7 +3636,7 @@ interface external$4 {
|
|
3538
3636
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
3539
3637
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
3540
3638
|
*/
|
3541
|
-
_overridability?: external$
|
3639
|
+
_overridability?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
3542
3640
|
};
|
3543
3641
|
/**
|
3544
3642
|
* @description Defines how to override a specific component.
|
@@ -3548,7 +3646,7 @@ interface external$4 {
|
|
3548
3646
|
*/
|
3549
3647
|
ComponentOverride: {
|
3550
3648
|
parameters?: {
|
3551
|
-
[key: string]: external$
|
3649
|
+
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
3552
3650
|
};
|
3553
3651
|
variant?: string;
|
3554
3652
|
};
|
@@ -3562,7 +3660,7 @@ interface external$4 {
|
|
3562
3660
|
ComponentOverridability: {
|
3563
3661
|
/** @description Defines component parameter value overrides. Keys are the parameter public ID. */
|
3564
3662
|
parameters?: {
|
3565
|
-
[key: string]: external$
|
3663
|
+
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["OverrideOptions"];
|
3566
3664
|
};
|
3567
3665
|
/** @description Allows overriding a display variant is allowed, if it is defined on the component the pattern is derived from. Default = false. */
|
3568
3666
|
variants?: boolean;
|
@@ -3603,7 +3701,7 @@ interface external$4 {
|
|
3603
3701
|
}[];
|
3604
3702
|
/** @description Variables needed to make calls to the data source */
|
3605
3703
|
variables?: {
|
3606
|
-
[key: string]: external$
|
3704
|
+
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
3607
3705
|
};
|
3608
3706
|
/** @description Custom configuration specific to the data source being defined (used to maintain UI state for custom integrations) */
|
3609
3707
|
custom?: {
|
@@ -3660,7 +3758,7 @@ interface external$4 {
|
|
3660
3758
|
method: "GET" | "POST" | "HEAD";
|
3661
3759
|
/** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys. */
|
3662
3760
|
variables?: {
|
3663
|
-
[key: string]: external$
|
3761
|
+
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
3664
3762
|
};
|
3665
3763
|
/** @description Custom configuration specific to the data source being defined */
|
3666
3764
|
custom?: {
|
@@ -3688,7 +3786,7 @@ interface external$4 {
|
|
3688
3786
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
3689
3787
|
*/
|
3690
3788
|
DataResourceDefinitions: {
|
3691
|
-
[key: string]: external$
|
3789
|
+
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
3692
3790
|
};
|
3693
3791
|
/** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
|
3694
3792
|
DataResourceDefinition: {
|
@@ -3702,7 +3800,7 @@ interface external$4 {
|
|
3702
3800
|
* If isPatternParameter is false or undefined, this has no meaning.
|
3703
3801
|
*/
|
3704
3802
|
ignorePatternParameterDefault?: boolean;
|
3705
|
-
variables?: external$
|
3803
|
+
variables?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
3706
3804
|
};
|
3707
3805
|
/** @description Variable values for a data resource. */
|
3708
3806
|
DataResourceVariables: {
|
@@ -3729,6 +3827,116 @@ interface external$4 {
|
|
3729
3827
|
};
|
3730
3828
|
}
|
3731
3829
|
|
3830
|
+
/**
|
3831
|
+
* This file was auto-generated by openapi-typescript.
|
3832
|
+
* Do not make direct changes to the file.
|
3833
|
+
*/
|
3834
|
+
interface paths$3 {
|
3835
|
+
"/api/v1/canvas-history": {
|
3836
|
+
get: {
|
3837
|
+
parameters: {
|
3838
|
+
query: {
|
3839
|
+
/** Specify the composition ID to get history for */
|
3840
|
+
compositionId: string;
|
3841
|
+
/** The project the composition(s) are on. */
|
3842
|
+
projectId: string;
|
3843
|
+
/** If a request returns a cursor, pass it in this query parameter to get the next page of results. */
|
3844
|
+
cursor?: string;
|
3845
|
+
};
|
3846
|
+
};
|
3847
|
+
responses: {
|
3848
|
+
/** OK */
|
3849
|
+
200: {
|
3850
|
+
content: {
|
3851
|
+
"application/json": components$2["schemas"]["ComponentInstanceHistoryApiResponse"];
|
3852
|
+
};
|
3853
|
+
};
|
3854
|
+
400: external$4["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
3855
|
+
401: external$4["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
3856
|
+
403: external$4["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
3857
|
+
/** Composition not found */
|
3858
|
+
404: {
|
3859
|
+
content: {
|
3860
|
+
"text/plain": string;
|
3861
|
+
};
|
3862
|
+
};
|
3863
|
+
429: external$4["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
3864
|
+
500: external$4["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
3865
|
+
};
|
3866
|
+
};
|
3867
|
+
};
|
3868
|
+
}
|
3869
|
+
interface components$2 {
|
3870
|
+
schemas: {
|
3871
|
+
ComponentInstanceHistoryApiResponse: {
|
3872
|
+
/**
|
3873
|
+
* @description If there are more results, this will be populated with a token to pass in the next request to get the next page of results.
|
3874
|
+
* If this is undefined then no more results are available.
|
3875
|
+
*/
|
3876
|
+
cursor?: string;
|
3877
|
+
/** @description If more history is available than your plan allows, and additional entries are available by upgrading, this will be true */
|
3878
|
+
truncated?: boolean;
|
3879
|
+
/** @description Version history entries. */
|
3880
|
+
results?: components$2["schemas"]["ComponentInstanceHistoryEntry"][];
|
3881
|
+
};
|
3882
|
+
ComponentInstanceHistoryEntry: {
|
3883
|
+
/** @description The version ID of the component instance. This can be used to fetch the version's data via the composition API. */
|
3884
|
+
versionId: string;
|
3885
|
+
/** @description The timestamp when the version was created in epoch milliseconds. */
|
3886
|
+
timestamp: number;
|
3887
|
+
/** @description The name (full name) of the user who created the version. */
|
3888
|
+
authorName: string;
|
3889
|
+
authorIsApiKey: boolean;
|
3890
|
+
/** @description The state of the component instance when the history entry was made. */
|
3891
|
+
state: number;
|
3892
|
+
};
|
3893
|
+
};
|
3894
|
+
}
|
3895
|
+
interface external$4 {
|
3896
|
+
"swagger.yml": {
|
3897
|
+
paths: {};
|
3898
|
+
components: {
|
3899
|
+
schemas: {
|
3900
|
+
Error: {
|
3901
|
+
/** @description Error message(s) that occurred while processing the request */
|
3902
|
+
errorMessage?: string[] | string;
|
3903
|
+
};
|
3904
|
+
};
|
3905
|
+
responses: {
|
3906
|
+
/** Request input validation failed */
|
3907
|
+
BadRequestError: {
|
3908
|
+
content: {
|
3909
|
+
"application/json": external$4["swagger.yml"]["components"]["schemas"]["Error"];
|
3910
|
+
};
|
3911
|
+
};
|
3912
|
+
/** API key or token was not valid */
|
3913
|
+
UnauthorizedError: {
|
3914
|
+
content: {
|
3915
|
+
"application/json": external$4["swagger.yml"]["components"]["schemas"]["Error"];
|
3916
|
+
};
|
3917
|
+
};
|
3918
|
+
/** Permission was denied */
|
3919
|
+
ForbiddenError: {
|
3920
|
+
content: {
|
3921
|
+
"application/json": external$4["swagger.yml"]["components"]["schemas"]["Error"];
|
3922
|
+
};
|
3923
|
+
};
|
3924
|
+
/** Resource not found */
|
3925
|
+
NotFoundError: {
|
3926
|
+
content: {
|
3927
|
+
"application/json": external$4["swagger.yml"]["components"]["schemas"]["Error"];
|
3928
|
+
};
|
3929
|
+
};
|
3930
|
+
/** Too many requests in allowed time period */
|
3931
|
+
RateLimitError: unknown;
|
3932
|
+
/** Execution error occurred */
|
3933
|
+
InternalServerError: unknown;
|
3934
|
+
};
|
3935
|
+
};
|
3936
|
+
operations: {};
|
3937
|
+
};
|
3938
|
+
}
|
3939
|
+
|
3732
3940
|
interface components$1 {
|
3733
3941
|
schemas: {
|
3734
3942
|
CompositionResolvedGetResponse: components$1["schemas"]["EdgehancerResult"] & external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["schemas"]["CompositionApiResponse"];
|
@@ -4422,37 +4630,72 @@ interface external$3 {
|
|
4422
4630
|
get: {
|
4423
4631
|
parameters: {
|
4424
4632
|
query: {
|
4425
|
-
/**
|
4633
|
+
/**
|
4634
|
+
* Specify a single composition ID to fetch. Response will be a single composition.
|
4635
|
+
* This is a primary query parameter, and cannot be used with any other primary query parameters.
|
4636
|
+
*/
|
4426
4637
|
compositionId?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["compositionId"];
|
4427
|
-
/**
|
4638
|
+
/**
|
4639
|
+
* Specify a historical composition version ID to fetch (retrieved from the canvas-history API).
|
4640
|
+
* Must be used with the `compositionId` parameter.
|
4641
|
+
*/
|
4642
|
+
versionId?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["versionId"];
|
4643
|
+
/**
|
4644
|
+
* Specify multiple composition IDs to fetch. Response type will be a list.
|
4645
|
+
* This is a primary query parameter, and cannot be used with any other primary query parameters.
|
4646
|
+
*/
|
4428
4647
|
compositionIDs?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["compositionIDs"];
|
4429
|
-
/**
|
4648
|
+
/**
|
4649
|
+
* Filters composition lists by the user who created them. The user is specified by their identity subject.
|
4650
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
4651
|
+
*/
|
4430
4652
|
createdBy?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["createdBy"];
|
4431
4653
|
/**
|
4432
4654
|
* Matches compositions where their name, slug, or definition name contains the specified keyword.
|
4433
4655
|
* NOT a full text search; does not match composition contents.
|
4656
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
4434
4657
|
*/
|
4435
4658
|
keyword?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["keyword"];
|
4436
|
-
/**
|
4659
|
+
/**
|
4660
|
+
* Max number of records to return
|
4661
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
4662
|
+
*/
|
4437
4663
|
limit?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["limit"];
|
4438
|
-
/**
|
4664
|
+
/**
|
4665
|
+
* Number of records to skip
|
4666
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
4667
|
+
*/
|
4439
4668
|
offset?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["offset"];
|
4440
|
-
/**
|
4669
|
+
/**
|
4670
|
+
* Sets the sorting of the results. If unspecified, results are sorted by name ascending.
|
4671
|
+
* When using primary query parameters, this parameter is ignored.
|
4672
|
+
*/
|
4441
4673
|
orderBy?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["orderBy"];
|
4442
4674
|
/**
|
4443
4675
|
* Matches compositions based on whether they are a pattern composition or a regular composition.
|
4444
4676
|
* If true, only pattern compositions will be returned.
|
4445
4677
|
* If false, only regular compositions will be returned.
|
4446
4678
|
* If omitted, both pattern and regular compositions will be returned.
|
4679
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
4447
4680
|
*/
|
4448
4681
|
pattern?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["pattern"];
|
4449
4682
|
/** The project the composition(s) are on. */
|
4450
4683
|
projectId: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["projectId"];
|
4451
|
-
/**
|
4684
|
+
/**
|
4685
|
+
* Specify a project map ID to fetch by path or node ID from.
|
4686
|
+
* If not specified, the default project map for the projectId is used.
|
4687
|
+
* Only used when fetching by projectMapNodeId or projectMapNodePath.
|
4688
|
+
*/
|
4452
4689
|
projectMapId?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["projectMapId"];
|
4453
|
-
/**
|
4690
|
+
/**
|
4691
|
+
* Specify a single composition to fetch by assodicated project map node ID. Response will be a single composition.
|
4692
|
+
* This is a primary query parameter, and cannot be used with any other primary query parameters.
|
4693
|
+
*/
|
4454
4694
|
projectMapNodeId?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["projectMapNodeId"];
|
4455
|
-
/**
|
4695
|
+
/**
|
4696
|
+
* Specify a single composition to fetch by assodicated project map node path. Response will be a single composition.
|
4697
|
+
* This is a primary query parameter, and cannot be used with any other primary query parameters.
|
4698
|
+
*/
|
4456
4699
|
projectMapNodePath?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["projectMapNodePath"];
|
4457
4700
|
/**
|
4458
4701
|
* @deprecated Signals an enhancer proxy to skip processing enhancements to the data and return raw data only.
|
@@ -4474,23 +4717,37 @@ interface external$3 {
|
|
4474
4717
|
* Passing this parameter automatically implies withComponentIDs to be true.
|
4475
4718
|
*/
|
4476
4719
|
skipOverridesResolution?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["skipOverridesResolution"];
|
4477
|
-
/**
|
4720
|
+
/**
|
4721
|
+
* Specify a single composition to fetch by slug. Response will be a single composition.
|
4722
|
+
* This is a primary query parameter, and cannot be used with any other primary query parameters.
|
4723
|
+
*/
|
4478
4724
|
slug?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["slug"];
|
4479
|
-
/**
|
4725
|
+
/**
|
4726
|
+
* Publishing state to fetch. 0 = draft, 64 = published.
|
4727
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
4728
|
+
*/
|
4480
4729
|
state?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["state"];
|
4481
|
-
/**
|
4730
|
+
/**
|
4731
|
+
* The component type (by public ID) to filter by. Note that this filters the root composition type only; components in slots are not matched by this filter.
|
4732
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
4733
|
+
*/
|
4482
4734
|
type?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["type"];
|
4483
4735
|
/**
|
4484
4736
|
* @deprecated Filters composition lists by the UI status of the composition.
|
4485
4737
|
* This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
|
4738
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
4486
4739
|
*/
|
4487
4740
|
uiStatus?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["uiStatus"];
|
4488
4741
|
/**
|
4489
4742
|
* Filters out compositions without attached node or filters out compositions with attached nodes
|
4490
4743
|
* in case of FALSE. If not specified - no filtration applied.
|
4744
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
4491
4745
|
*/
|
4492
4746
|
attachedToProjectMap?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["attachedToProjectMap"];
|
4493
|
-
/**
|
4747
|
+
/**
|
4748
|
+
* Filters composition lists by the user who last updated them. The user is specified by their identity subject.
|
4749
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
4750
|
+
*/
|
4494
4751
|
updatedBy?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["updatedBy"];
|
4495
4752
|
/**
|
4496
4753
|
* If true the `_id` unique identifier of each non-root component will be part of the response data.
|
@@ -4617,7 +4874,7 @@ interface external$3 {
|
|
4617
4874
|
* @description UI status value. Subject to change without notice; do not rely on this value. Only present when `withUIStatus` option is true.
|
4618
4875
|
* @enum {string}
|
4619
4876
|
*/
|
4620
|
-
uiStatus?: "Draft" | "Modified" | "Published" | "Orphan";
|
4877
|
+
uiStatus?: "Draft" | "Modified" | "Published" | "Orphan" | "Previous";
|
4621
4878
|
/**
|
4622
4879
|
* Format: uuid
|
4623
4880
|
* @description The project ID that this layout data is part of
|
@@ -4646,25 +4903,61 @@ interface external$3 {
|
|
4646
4903
|
parameters: {
|
4647
4904
|
/** @description The project the composition(s) are on. */
|
4648
4905
|
projectId: string;
|
4649
|
-
/**
|
4906
|
+
/**
|
4907
|
+
* @description Specify a single composition ID to fetch. Response will be a single composition.
|
4908
|
+
* This is a primary query parameter, and cannot be used with any other primary query parameters.
|
4909
|
+
*/
|
4650
4910
|
compositionId: string;
|
4651
|
-
/**
|
4911
|
+
/**
|
4912
|
+
* @description Specify multiple composition IDs to fetch. Response type will be a list.
|
4913
|
+
* This is a primary query parameter, and cannot be used with any other primary query parameters.
|
4914
|
+
*/
|
4652
4915
|
compositionIDs: string[];
|
4653
|
-
/**
|
4916
|
+
/**
|
4917
|
+
* @description Specify a historical composition version ID to fetch (retrieved from the canvas-history API).
|
4918
|
+
* Must be used with the `compositionId` parameter.
|
4919
|
+
*/
|
4920
|
+
versionId: string;
|
4921
|
+
/**
|
4922
|
+
* @description Specify a single composition to fetch by slug. Response will be a single composition.
|
4923
|
+
* This is a primary query parameter, and cannot be used with any other primary query parameters.
|
4924
|
+
*/
|
4654
4925
|
slug: string;
|
4655
|
-
/**
|
4926
|
+
/**
|
4927
|
+
* @description Specify a single composition to fetch by assodicated project map node ID. Response will be a single composition.
|
4928
|
+
* This is a primary query parameter, and cannot be used with any other primary query parameters.
|
4929
|
+
*/
|
4656
4930
|
projectMapNodeId: string;
|
4657
|
-
/**
|
4931
|
+
/**
|
4932
|
+
* @description Specify a single composition to fetch by assodicated project map node path. Response will be a single composition.
|
4933
|
+
* This is a primary query parameter, and cannot be used with any other primary query parameters.
|
4934
|
+
*/
|
4658
4935
|
projectMapNodePath: string;
|
4659
|
-
/**
|
4936
|
+
/**
|
4937
|
+
* @description Specify a project map ID to fetch by path or node ID from.
|
4938
|
+
* If not specified, the default project map for the projectId is used.
|
4939
|
+
* Only used when fetching by projectMapNodeId or projectMapNodePath.
|
4940
|
+
*/
|
4660
4941
|
projectMapId: string;
|
4661
|
-
/**
|
4942
|
+
/**
|
4943
|
+
* @description The component type (by public ID) to filter by. Note that this filters the root composition type only; components in slots are not matched by this filter.
|
4944
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
4945
|
+
*/
|
4662
4946
|
type: string[];
|
4663
|
-
/**
|
4947
|
+
/**
|
4948
|
+
* @description Publishing state to fetch. 0 = draft, 64 = published.
|
4949
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
4950
|
+
*/
|
4664
4951
|
state: number;
|
4665
|
-
/**
|
4952
|
+
/**
|
4953
|
+
* @description Number of records to skip
|
4954
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
4955
|
+
*/
|
4666
4956
|
offset: number;
|
4667
|
-
/**
|
4957
|
+
/**
|
4958
|
+
* @description Max number of records to return
|
4959
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
4960
|
+
*/
|
4668
4961
|
limit: number;
|
4669
4962
|
/**
|
4670
4963
|
* @deprecated
|
@@ -4698,6 +4991,7 @@ interface external$3 {
|
|
4698
4991
|
/**
|
4699
4992
|
* @description Matches compositions where their name, slug, or definition name contains the specified keyword.
|
4700
4993
|
* NOT a full text search; does not match composition contents.
|
4994
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
4701
4995
|
*/
|
4702
4996
|
keyword: string;
|
4703
4997
|
/**
|
@@ -4705,9 +4999,13 @@ interface external$3 {
|
|
4705
4999
|
* If true, only pattern compositions will be returned.
|
4706
5000
|
* If false, only regular compositions will be returned.
|
4707
5001
|
* If omitted, both pattern and regular compositions will be returned.
|
5002
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
4708
5003
|
*/
|
4709
5004
|
pattern: boolean;
|
4710
|
-
/**
|
5005
|
+
/**
|
5006
|
+
* @description Sets the sorting of the results. If unspecified, results are sorted by name ascending.
|
5007
|
+
* When using primary query parameters, this parameter is ignored.
|
5008
|
+
*/
|
4711
5009
|
orderBy: ("updated_at_DESC" | "updated_at_ASC" | "created_at_DESC" | "created_at_ASC" | "name_DESC" | "name_ASC" | "slug_DESC" | "slug_ASC")[];
|
4712
5010
|
/**
|
4713
5011
|
* @deprecated
|
@@ -4719,11 +5017,13 @@ interface external$3 {
|
|
4719
5017
|
* @deprecated
|
4720
5018
|
* @description Filters composition lists by the UI status of the composition.
|
4721
5019
|
* This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
|
5020
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
4722
5021
|
*/
|
4723
5022
|
uiStatus: ("Draft" | "Modified" | "Published" | "Orphan")[];
|
4724
5023
|
/**
|
4725
5024
|
* @description Filters out compositions without attached node or filters out compositions with attached nodes
|
4726
5025
|
* in case of FALSE. If not specified - no filtration applied.
|
5026
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
4727
5027
|
*/
|
4728
5028
|
attachedToProjectMap: boolean;
|
4729
5029
|
/** @description Includes project map node information in the composition results */
|
@@ -4733,9 +5033,15 @@ interface external$3 {
|
|
4733
5033
|
* @description Includes content source map metadata on supported parameters
|
4734
5034
|
*/
|
4735
5035
|
withContentSourceMap: boolean;
|
4736
|
-
/**
|
5036
|
+
/**
|
5037
|
+
* @description Filters composition lists by the user who created them. The user is specified by their identity subject.
|
5038
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
5039
|
+
*/
|
4737
5040
|
createdBy: string;
|
4738
|
-
/**
|
5041
|
+
/**
|
5042
|
+
* @description Filters composition lists by the user who last updated them. The user is specified by their identity subject.
|
5043
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
5044
|
+
*/
|
4739
5045
|
updatedBy: string;
|
4740
5046
|
/**
|
4741
5047
|
* @description Controls whether the total count of results will be returned along with the current results page in a list.
|
@@ -5739,37 +6045,72 @@ interface external$2 {
|
|
5739
6045
|
get: {
|
5740
6046
|
parameters: {
|
5741
6047
|
query: {
|
5742
|
-
/**
|
6048
|
+
/**
|
6049
|
+
* Specify a single composition ID to fetch. Response will be a single composition.
|
6050
|
+
* This is a primary query parameter, and cannot be used with any other primary query parameters.
|
6051
|
+
*/
|
5743
6052
|
compositionId?: external$2["v1-canvas.swagger.yml"]["components"]["parameters"]["compositionId"];
|
5744
|
-
/**
|
6053
|
+
/**
|
6054
|
+
* Specify a historical composition version ID to fetch (retrieved from the canvas-history API).
|
6055
|
+
* Must be used with the `compositionId` parameter.
|
6056
|
+
*/
|
6057
|
+
versionId?: external$2["v1-canvas.swagger.yml"]["components"]["parameters"]["versionId"];
|
6058
|
+
/**
|
6059
|
+
* Specify multiple composition IDs to fetch. Response type will be a list.
|
6060
|
+
* This is a primary query parameter, and cannot be used with any other primary query parameters.
|
6061
|
+
*/
|
5745
6062
|
compositionIDs?: external$2["v1-canvas.swagger.yml"]["components"]["parameters"]["compositionIDs"];
|
5746
|
-
/**
|
6063
|
+
/**
|
6064
|
+
* Filters composition lists by the user who created them. The user is specified by their identity subject.
|
6065
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
6066
|
+
*/
|
5747
6067
|
createdBy?: external$2["v1-canvas.swagger.yml"]["components"]["parameters"]["createdBy"];
|
5748
6068
|
/**
|
5749
6069
|
* Matches compositions where their name, slug, or definition name contains the specified keyword.
|
5750
6070
|
* NOT a full text search; does not match composition contents.
|
6071
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
5751
6072
|
*/
|
5752
6073
|
keyword?: external$2["v1-canvas.swagger.yml"]["components"]["parameters"]["keyword"];
|
5753
|
-
/**
|
6074
|
+
/**
|
6075
|
+
* Max number of records to return
|
6076
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
6077
|
+
*/
|
5754
6078
|
limit?: external$2["v1-canvas.swagger.yml"]["components"]["parameters"]["limit"];
|
5755
|
-
/**
|
6079
|
+
/**
|
6080
|
+
* Number of records to skip
|
6081
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
6082
|
+
*/
|
5756
6083
|
offset?: external$2["v1-canvas.swagger.yml"]["components"]["parameters"]["offset"];
|
5757
|
-
/**
|
6084
|
+
/**
|
6085
|
+
* Sets the sorting of the results. If unspecified, results are sorted by name ascending.
|
6086
|
+
* When using primary query parameters, this parameter is ignored.
|
6087
|
+
*/
|
5758
6088
|
orderBy?: external$2["v1-canvas.swagger.yml"]["components"]["parameters"]["orderBy"];
|
5759
6089
|
/**
|
5760
6090
|
* Matches compositions based on whether they are a pattern composition or a regular composition.
|
5761
6091
|
* If true, only pattern compositions will be returned.
|
5762
6092
|
* If false, only regular compositions will be returned.
|
5763
6093
|
* If omitted, both pattern and regular compositions will be returned.
|
6094
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
5764
6095
|
*/
|
5765
6096
|
pattern?: external$2["v1-canvas.swagger.yml"]["components"]["parameters"]["pattern"];
|
5766
6097
|
/** The project the composition(s) are on. */
|
5767
6098
|
projectId: external$2["v1-canvas.swagger.yml"]["components"]["parameters"]["projectId"];
|
5768
|
-
/**
|
6099
|
+
/**
|
6100
|
+
* Specify a project map ID to fetch by path or node ID from.
|
6101
|
+
* If not specified, the default project map for the projectId is used.
|
6102
|
+
* Only used when fetching by projectMapNodeId or projectMapNodePath.
|
6103
|
+
*/
|
5769
6104
|
projectMapId?: external$2["v1-canvas.swagger.yml"]["components"]["parameters"]["projectMapId"];
|
5770
|
-
/**
|
6105
|
+
/**
|
6106
|
+
* Specify a single composition to fetch by assodicated project map node ID. Response will be a single composition.
|
6107
|
+
* This is a primary query parameter, and cannot be used with any other primary query parameters.
|
6108
|
+
*/
|
5771
6109
|
projectMapNodeId?: external$2["v1-canvas.swagger.yml"]["components"]["parameters"]["projectMapNodeId"];
|
5772
|
-
/**
|
6110
|
+
/**
|
6111
|
+
* Specify a single composition to fetch by assodicated project map node path. Response will be a single composition.
|
6112
|
+
* This is a primary query parameter, and cannot be used with any other primary query parameters.
|
6113
|
+
*/
|
5773
6114
|
projectMapNodePath?: external$2["v1-canvas.swagger.yml"]["components"]["parameters"]["projectMapNodePath"];
|
5774
6115
|
/**
|
5775
6116
|
* @deprecated Signals an enhancer proxy to skip processing enhancements to the data and return raw data only.
|
@@ -5791,23 +6132,37 @@ interface external$2 {
|
|
5791
6132
|
* Passing this parameter automatically implies withComponentIDs to be true.
|
5792
6133
|
*/
|
5793
6134
|
skipOverridesResolution?: external$2["v1-canvas.swagger.yml"]["components"]["parameters"]["skipOverridesResolution"];
|
5794
|
-
/**
|
6135
|
+
/**
|
6136
|
+
* Specify a single composition to fetch by slug. Response will be a single composition.
|
6137
|
+
* This is a primary query parameter, and cannot be used with any other primary query parameters.
|
6138
|
+
*/
|
5795
6139
|
slug?: external$2["v1-canvas.swagger.yml"]["components"]["parameters"]["slug"];
|
5796
|
-
/**
|
6140
|
+
/**
|
6141
|
+
* Publishing state to fetch. 0 = draft, 64 = published.
|
6142
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
6143
|
+
*/
|
5797
6144
|
state?: external$2["v1-canvas.swagger.yml"]["components"]["parameters"]["state"];
|
5798
|
-
/**
|
6145
|
+
/**
|
6146
|
+
* The component type (by public ID) to filter by. Note that this filters the root composition type only; components in slots are not matched by this filter.
|
6147
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
6148
|
+
*/
|
5799
6149
|
type?: external$2["v1-canvas.swagger.yml"]["components"]["parameters"]["type"];
|
5800
6150
|
/**
|
5801
6151
|
* @deprecated Filters composition lists by the UI status of the composition.
|
5802
6152
|
* This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
|
6153
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
5803
6154
|
*/
|
5804
6155
|
uiStatus?: external$2["v1-canvas.swagger.yml"]["components"]["parameters"]["uiStatus"];
|
5805
6156
|
/**
|
5806
6157
|
* Filters out compositions without attached node or filters out compositions with attached nodes
|
5807
6158
|
* in case of FALSE. If not specified - no filtration applied.
|
6159
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
5808
6160
|
*/
|
5809
6161
|
attachedToProjectMap?: external$2["v1-canvas.swagger.yml"]["components"]["parameters"]["attachedToProjectMap"];
|
5810
|
-
/**
|
6162
|
+
/**
|
6163
|
+
* Filters composition lists by the user who last updated them. The user is specified by their identity subject.
|
6164
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
6165
|
+
*/
|
5811
6166
|
updatedBy?: external$2["v1-canvas.swagger.yml"]["components"]["parameters"]["updatedBy"];
|
5812
6167
|
/**
|
5813
6168
|
* If true the `_id` unique identifier of each non-root component will be part of the response data.
|
@@ -5934,7 +6289,7 @@ interface external$2 {
|
|
5934
6289
|
* @description UI status value. Subject to change without notice; do not rely on this value. Only present when `withUIStatus` option is true.
|
5935
6290
|
* @enum {string}
|
5936
6291
|
*/
|
5937
|
-
uiStatus?: "Draft" | "Modified" | "Published" | "Orphan";
|
6292
|
+
uiStatus?: "Draft" | "Modified" | "Published" | "Orphan" | "Previous";
|
5938
6293
|
/**
|
5939
6294
|
* Format: uuid
|
5940
6295
|
* @description The project ID that this layout data is part of
|
@@ -5963,25 +6318,61 @@ interface external$2 {
|
|
5963
6318
|
parameters: {
|
5964
6319
|
/** @description The project the composition(s) are on. */
|
5965
6320
|
projectId: string;
|
5966
|
-
/**
|
6321
|
+
/**
|
6322
|
+
* @description Specify a single composition ID to fetch. Response will be a single composition.
|
6323
|
+
* This is a primary query parameter, and cannot be used with any other primary query parameters.
|
6324
|
+
*/
|
5967
6325
|
compositionId: string;
|
5968
|
-
/**
|
6326
|
+
/**
|
6327
|
+
* @description Specify multiple composition IDs to fetch. Response type will be a list.
|
6328
|
+
* This is a primary query parameter, and cannot be used with any other primary query parameters.
|
6329
|
+
*/
|
5969
6330
|
compositionIDs: string[];
|
5970
|
-
/**
|
6331
|
+
/**
|
6332
|
+
* @description Specify a historical composition version ID to fetch (retrieved from the canvas-history API).
|
6333
|
+
* Must be used with the `compositionId` parameter.
|
6334
|
+
*/
|
6335
|
+
versionId: string;
|
6336
|
+
/**
|
6337
|
+
* @description Specify a single composition to fetch by slug. Response will be a single composition.
|
6338
|
+
* This is a primary query parameter, and cannot be used with any other primary query parameters.
|
6339
|
+
*/
|
5971
6340
|
slug: string;
|
5972
|
-
/**
|
6341
|
+
/**
|
6342
|
+
* @description Specify a single composition to fetch by assodicated project map node ID. Response will be a single composition.
|
6343
|
+
* This is a primary query parameter, and cannot be used with any other primary query parameters.
|
6344
|
+
*/
|
5973
6345
|
projectMapNodeId: string;
|
5974
|
-
/**
|
6346
|
+
/**
|
6347
|
+
* @description Specify a single composition to fetch by assodicated project map node path. Response will be a single composition.
|
6348
|
+
* This is a primary query parameter, and cannot be used with any other primary query parameters.
|
6349
|
+
*/
|
5975
6350
|
projectMapNodePath: string;
|
5976
|
-
/**
|
6351
|
+
/**
|
6352
|
+
* @description Specify a project map ID to fetch by path or node ID from.
|
6353
|
+
* If not specified, the default project map for the projectId is used.
|
6354
|
+
* Only used when fetching by projectMapNodeId or projectMapNodePath.
|
6355
|
+
*/
|
5977
6356
|
projectMapId: string;
|
5978
|
-
/**
|
6357
|
+
/**
|
6358
|
+
* @description The component type (by public ID) to filter by. Note that this filters the root composition type only; components in slots are not matched by this filter.
|
6359
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
6360
|
+
*/
|
5979
6361
|
type: string[];
|
5980
|
-
/**
|
6362
|
+
/**
|
6363
|
+
* @description Publishing state to fetch. 0 = draft, 64 = published.
|
6364
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
6365
|
+
*/
|
5981
6366
|
state: number;
|
5982
|
-
/**
|
6367
|
+
/**
|
6368
|
+
* @description Number of records to skip
|
6369
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
6370
|
+
*/
|
5983
6371
|
offset: number;
|
5984
|
-
/**
|
6372
|
+
/**
|
6373
|
+
* @description Max number of records to return
|
6374
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
6375
|
+
*/
|
5985
6376
|
limit: number;
|
5986
6377
|
/**
|
5987
6378
|
* @deprecated
|
@@ -6015,6 +6406,7 @@ interface external$2 {
|
|
6015
6406
|
/**
|
6016
6407
|
* @description Matches compositions where their name, slug, or definition name contains the specified keyword.
|
6017
6408
|
* NOT a full text search; does not match composition contents.
|
6409
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
6018
6410
|
*/
|
6019
6411
|
keyword: string;
|
6020
6412
|
/**
|
@@ -6022,9 +6414,13 @@ interface external$2 {
|
|
6022
6414
|
* If true, only pattern compositions will be returned.
|
6023
6415
|
* If false, only regular compositions will be returned.
|
6024
6416
|
* If omitted, both pattern and regular compositions will be returned.
|
6417
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
6025
6418
|
*/
|
6026
6419
|
pattern: boolean;
|
6027
|
-
/**
|
6420
|
+
/**
|
6421
|
+
* @description Sets the sorting of the results. If unspecified, results are sorted by name ascending.
|
6422
|
+
* When using primary query parameters, this parameter is ignored.
|
6423
|
+
*/
|
6028
6424
|
orderBy: ("updated_at_DESC" | "updated_at_ASC" | "created_at_DESC" | "created_at_ASC" | "name_DESC" | "name_ASC" | "slug_DESC" | "slug_ASC")[];
|
6029
6425
|
/**
|
6030
6426
|
* @deprecated
|
@@ -6036,11 +6432,13 @@ interface external$2 {
|
|
6036
6432
|
* @deprecated
|
6037
6433
|
* @description Filters composition lists by the UI status of the composition.
|
6038
6434
|
* This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
|
6435
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
6039
6436
|
*/
|
6040
6437
|
uiStatus: ("Draft" | "Modified" | "Published" | "Orphan")[];
|
6041
6438
|
/**
|
6042
6439
|
* @description Filters out compositions without attached node or filters out compositions with attached nodes
|
6043
6440
|
* in case of FALSE. If not specified - no filtration applied.
|
6441
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
6044
6442
|
*/
|
6045
6443
|
attachedToProjectMap: boolean;
|
6046
6444
|
/** @description Includes project map node information in the composition results */
|
@@ -6050,9 +6448,15 @@ interface external$2 {
|
|
6050
6448
|
* @description Includes content source map metadata on supported parameters
|
6051
6449
|
*/
|
6052
6450
|
withContentSourceMap: boolean;
|
6053
|
-
/**
|
6451
|
+
/**
|
6452
|
+
* @description Filters composition lists by the user who created them. The user is specified by their identity subject.
|
6453
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
6454
|
+
*/
|
6054
6455
|
createdBy: string;
|
6055
|
-
/**
|
6456
|
+
/**
|
6457
|
+
* @description Filters composition lists by the user who last updated them. The user is specified by their identity subject.
|
6458
|
+
* This is a list query parameter, and cannot be used with any primary query parameters.
|
6459
|
+
*/
|
6056
6460
|
updatedBy: string;
|
6057
6461
|
/**
|
6058
6462
|
* @description Controls whether the total count of results will be returned along with the current results page in a list.
|
@@ -6261,9 +6665,11 @@ interface external$2 {
|
|
6261
6665
|
};
|
6262
6666
|
}
|
6263
6667
|
|
6264
|
-
type Components = components$
|
6265
|
-
type SharedComponents = components$
|
6266
|
-
type
|
6668
|
+
type Components = components$3['schemas'];
|
6669
|
+
type SharedComponents = components$4['schemas'];
|
6670
|
+
type HistoryComponents = components$2['schemas'];
|
6671
|
+
type Api = paths$4['/api/v1/canvas'];
|
6672
|
+
type HistoryApi = paths$3['/api/v1/canvas-history'];
|
6267
6673
|
/** Query parameter options for GET /api/v1/canvas */
|
6268
6674
|
type CompositionGetParameters = Omit<Api['get']['parameters']['query'], 'type'> & {
|
6269
6675
|
type?: string | string[];
|
@@ -6271,6 +6677,12 @@ type CompositionGetParameters = Omit<Api['get']['parameters']['query'], 'type'>
|
|
6271
6677
|
type CompositionGetOrderBy = NonNullable<Api['get']['parameters']['query']['orderBy']>[0];
|
6272
6678
|
/** The GET response from /api/v1/canvas when `component` or `slug` params are specified */
|
6273
6679
|
type CompositionGetResponse = Components['CompositionApiResponse'];
|
6680
|
+
/** The GET response from /api/v1/canvas-history (history for one composition) */
|
6681
|
+
type ComponentInstanceHistoryGetParameters = HistoryApi['get']['parameters']['query'];
|
6682
|
+
/** The GET response from /api/v1/canvas-history */
|
6683
|
+
type ComponentInstanceHistoryGetResponse = HistoryComponents['ComponentInstanceHistoryApiResponse'];
|
6684
|
+
/** A historical version of a composition */
|
6685
|
+
type ComponentInstanceHistoryEntry = HistoryComponents['ComponentInstanceHistoryEntry'];
|
6274
6686
|
/** @deprecated - internal use, do not rely on this value */
|
6275
6687
|
type CompositionUIStatus = NonNullable<Components['CompositionApiResponse']['uiStatus']>;
|
6276
6688
|
/** The GET response from /api/v1/canvas when `component` or `slug` are not specified */
|
@@ -6332,7 +6744,7 @@ type CanvasDefinitions = {
|
|
6332
6744
|
dataTypes?: Array<DataType>;
|
6333
6745
|
};
|
6334
6746
|
/** Defines shared parameters for requests getting a single composition */
|
6335
|
-
type CompositionGetOneSharedParameters = Pick<CompositionGetParameters, 'state' | 'skipEnhance' | 'skipPatternResolution' | 'withComponentIDs' | 'withUIStatus' | 'withTotalCount' | 'skipOverridesResolution' | 'withContentSourceMap'>;
|
6747
|
+
type CompositionGetOneSharedParameters = Pick<CompositionGetParameters, 'state' | 'skipEnhance' | 'skipPatternResolution' | 'withComponentIDs' | 'withUIStatus' | 'withTotalCount' | 'skipOverridesResolution' | 'withContentSourceMap' | 'versionId'>;
|
6336
6748
|
type CompositionGetBy<RequiredParameters extends keyof CompositionGetParameters> = CompositionGetOneSharedParameters & Required<Pick<CompositionGetParameters, RequiredParameters>>;
|
6337
6749
|
type SpecificProjectMap = {
|
6338
6750
|
projectMapId?: string;
|
@@ -6427,7 +6839,7 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
|
|
6427
6839
|
getCompositionList(options?: Omit<CompositionGetParameters, 'projectId' | 'compositionId' | 'slug'>): Promise<{
|
6428
6840
|
compositions: {
|
6429
6841
|
state: number;
|
6430
|
-
uiStatus?: "Draft" | "Modified" | "Published" | "Orphan" | undefined;
|
6842
|
+
uiStatus?: "Draft" | "Modified" | "Published" | "Orphan" | "Previous" | undefined;
|
6431
6843
|
projectId: string;
|
6432
6844
|
created: string;
|
6433
6845
|
modified: string;
|
@@ -6567,6 +6979,18 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
|
|
6567
6979
|
getCompositionById(options: CompositionGetByIdParameters & DataResolutionOptionNegative): Promise<CompositionGetResponse>;
|
6568
6980
|
getCompositionById(options: CompositionGetByIdParameters & DataResolutionOptionPositive & DataResolutionParameters): Promise<CompositionResolvedGetResponse>;
|
6569
6981
|
getCompositionById<T extends CompositionGetResponse = CompositionGetValidResponses>(options: CompositionGetByIdParameters & DataResolutionOption & DataResolutionParameters): Promise<T>;
|
6982
|
+
/** Fetches historical versions of a composition or pattern */
|
6983
|
+
unstable_getCompositionHistory(options: ExceptProject<ComponentInstanceHistoryGetParameters>): Promise<{
|
6984
|
+
cursor?: string | undefined;
|
6985
|
+
truncated?: boolean | undefined;
|
6986
|
+
results?: {
|
6987
|
+
versionId: string;
|
6988
|
+
timestamp: number;
|
6989
|
+
authorName: string;
|
6990
|
+
authorIsApiKey: boolean;
|
6991
|
+
state: number;
|
6992
|
+
}[] | undefined;
|
6993
|
+
}>;
|
6570
6994
|
private getOneComposition;
|
6571
6995
|
/** Updates or creates a Canvas component definition */
|
6572
6996
|
updateComposition(body: Omit<CompositionPutParameters, 'projectId'>): Promise<void>;
|
@@ -7054,7 +7478,7 @@ type ProjectMapLinkComponentParameterValue = ProjectMapLinkParamValue | undefine
|
|
7054
7478
|
type LinkComponentParameterValue = LinkParamValue;
|
7055
7479
|
|
7056
7480
|
type RichTextBuiltInFormat = 'code' | 'bold' | 'italic' | 'underline' | 'strikethrough' | 'superscript' | 'subscript';
|
7057
|
-
type RichTextBuiltInElement = 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | 'unorderedList' | 'orderedList' | 'link';
|
7481
|
+
type RichTextBuiltInElement = 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | 'unorderedList' | 'orderedList' | 'link' | 'quote' | 'code';
|
7058
7482
|
type RichTextParamConfiguration = {
|
7059
7483
|
required?: boolean;
|
7060
7484
|
formatting?: {
|
@@ -7752,4 +8176,4 @@ declare function mapSlotToTestVariations(slot: ComponentInstance[] | undefined):
|
|
7752
8176
|
|
7753
8177
|
declare const CanvasClientError: typeof ApiClientError;
|
7754
8178
|
|
7755
|
-
export { AddComponentMessage, BatchEnhancer, BatchEntry, BatchInvalidationPayload, BindVariablesOptions, BindVariablesResult, BindVariablesToObjectOptions, CANVAS_DRAFT_STATE, CANVAS_ENRICHMENT_TAG_PARAM, CANVAS_INTENT_TAG_PARAM, CANVAS_LOCALE_TAG_PARAM, CANVAS_LOCALIZATION_SLOT, CANVAS_LOCALIZATION_TYPE, CANVAS_PERSONALIZATION_PARAM, CANVAS_PERSONALIZE_SLOT, CANVAS_PERSONALIZE_TYPE, CANVAS_PUBLISHED_STATE, CANVAS_TEST_SLOT, CANVAS_TEST_TYPE, CANVAS_TEST_VARIANT_PARAM, CanvasClient, CanvasClientError, CanvasDefinitions, Channel, ChannelMessage, ChannelSubscription, ChildEnhancerBuilder, ComponentDefinition, ComponentDefinitionDeleteParameters, ComponentDefinitionGetParameters, ComponentDefinitionGetResponse, ComponentDefinitionParameter, ComponentDefinitionPermission, ComponentDefinitionPutParameters, ComponentDefinitionSlot, ComponentDefinitionSlugSettings, ComponentDefinitionVariant, ComponentEnhancer, ComponentEnhancerFunction, ComponentEnhancerOptions, ComponentInstance, ComponentLocationReference, ComponentOverridability, ComponentOverride, ComponentOverrides, ComponentParameter, ComponentParameterContextualEditing, ComponentParameterEnhancer, ComponentParameterEnhancerFunction, ComponentParameterEnhancerOptions, CompositionDataDiagnostic, CompositionDeleteParameters, CompositionDiagnostics, CompositionGetByIdParameters, CompositionGetByNodeIdParameters, CompositionGetByNodePathParameters, CompositionGetBySlugParameters, CompositionGetListResponse, CompositionGetOrderBy, CompositionGetParameters, CompositionGetResponse, CompositionGetValidResponses, CompositionIssue, CompositionPatternIssue, CompositionPutParameters, CompositionRelationshipsClientOptions, CompositionRelationshipsDDefinitionGetResponse, CompositionRelationshipsDefinitionApi, CompositionRelationshipsDefinitionGetParameters, CompositionResolvedGetResponse, CompositionUIStatus, DataElementBindingIssue, DataElementConnectionDefinition, DataResolutionConfigIssue, DataResolutionOption, DataResolutionOptionNegative, DataResolutionOptionPositive, DataResolutionParameters, DataResourceDefinition, DataResourceDefinitions, DataResourceInputIssue, DataResourceIssue, DataResourceVariables, DataSource, DataSourceClient, DataSourceDeleteParameters, DataSourceGetParameters, DataSourceGetResponse, DataSourcePutParameters, DataSourcesGetParameters, DataSourcesGetResponse, DataType, DataTypeClient, DataTypeDeleteParameters, DataTypeGetParameters, DataTypeGetResponse, DataTypePutParameters, DataVariableDefinition, DismissPlaceholderMessage, EDGE_CACHE_DISABLED, EDGE_DEFAULT_CACHE_TTL, EDGE_DEFAULT_L2_CACHE_TTL_IN_HOURS, EDGE_MAX_CACHE_TTL, EDGE_MAX_L2_CACHE_TTL_IN_HOURS, EDGE_MIN_CACHE_TTL, EDGE_MIN_L2_CACHE_TTL_IN_HOURS, EMPTY_COMPOSITION, EnhancerBuilder, EnhancerContext, EnhancerError, EventNames, IN_CONTEXT_EDITOR_COMPONENT_END_ROLE, IN_CONTEXT_EDITOR_COMPONENT_START_ROLE, IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID, IN_CONTEXT_EDITOR_QUERY_STRING_PARAM, IS_RENDERED_BY_UNIFORM_ATTRIBUTE, InvalidationPayload, InvalidationResult, LimitPolicy, LinkComponentParameterValue, LinkParamConfiguration, LinkParamValue, LinkParameterType, LinkTypeConfiguration, MessageHandler, MoveComponentMessage, NonProjectMapLinkParamValue, OverrideIssue, OverrideOptions, PLACEHOLDER_ID, PreviewEventBus, PreviewPanelSettings, ProjectMapLinkComponentParameterValue, ProjectMapLinkParamValue, ReadyMessage, ReportRenderedCompositionsMessage, ResolvedRouteGetResponse, RichTextBuiltInElement, RichTextBuiltInFormat, RichTextParamConfiguration, RichTextParamValue, RootComponentInstance, RouteDynamicInputs, RouteGetParameters, RouteGetResponse, RouteGetResponseComposition, RouteGetResponseEdgehancedComposition, RouteGetResponseNotFound, RouteGetResponseRedirect, SelectComponentMessage, SpecificProjectMap, SubscribeToCompositionOptions, TriggerCompositionActionMessage, UncachedCanvasClient, UniqueBatchEntries, UnsubscribeCallback, UpdateComponentParameterMessage, UpdateCompositionInternalMessage, UpdateCompositionMessage, UpdatePreviewSettingsMessage, UsageTrackingApi, UsageTrackingGetParameters, UsageTrackingGetResponse, UsageTrackingPostParameters, UsageTrackingPostResponse, WalkComponentTreeActions, bindVariables, bindVariablesToObject, compose, createBatchEnhancer, createCanvasChannel, createEventBus, createLimitPolicy, createUniformApiEnhancer, enhance, extractLocales, generateHash, getChannelName, getComponentJsonPointer, getComponentPath, isAddComponentMessage, isDismissPlaceholderMessage, isMovingComponentMessage, isReadyMessage, isReportRenderedCompositionsMessage, isSelectComponentMessage, isSystemComponentDefinition, isTriggerCompositionActionMessage, isUpdateComponentParameterMessage, isUpdateCompositionInternalMessage, isUpdateCompositionMessage, isUpdatePreviewSettingsMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, nullLimitPolicy, subscribeToComposition, unstable_CompositionRelationshipClient, unstable_RouteClient, walkComponentTree };
|
8179
|
+
export { AddComponentMessage, BatchEnhancer, BatchEntry, BatchInvalidationPayload, BindVariablesOptions, BindVariablesResult, BindVariablesToObjectOptions, CANVAS_DRAFT_STATE, CANVAS_ENRICHMENT_TAG_PARAM, CANVAS_INTENT_TAG_PARAM, CANVAS_LOCALE_TAG_PARAM, CANVAS_LOCALIZATION_SLOT, CANVAS_LOCALIZATION_TYPE, CANVAS_PERSONALIZATION_PARAM, CANVAS_PERSONALIZE_SLOT, CANVAS_PERSONALIZE_TYPE, CANVAS_PUBLISHED_STATE, CANVAS_TEST_SLOT, CANVAS_TEST_TYPE, CANVAS_TEST_VARIANT_PARAM, CanvasClient, CanvasClientError, CanvasDefinitions, Channel, ChannelMessage, ChannelSubscription, ChildEnhancerBuilder, ComponentDefinition, ComponentDefinitionDeleteParameters, ComponentDefinitionGetParameters, ComponentDefinitionGetResponse, ComponentDefinitionParameter, ComponentDefinitionPermission, ComponentDefinitionPutParameters, ComponentDefinitionSlot, ComponentDefinitionSlugSettings, ComponentDefinitionVariant, ComponentEnhancer, ComponentEnhancerFunction, ComponentEnhancerOptions, ComponentInstance, ComponentInstanceHistoryEntry, ComponentInstanceHistoryGetParameters, ComponentInstanceHistoryGetResponse, ComponentLocationReference, ComponentOverridability, ComponentOverride, ComponentOverrides, ComponentParameter, ComponentParameterContextualEditing, ComponentParameterEnhancer, ComponentParameterEnhancerFunction, ComponentParameterEnhancerOptions, CompositionDataDiagnostic, CompositionDeleteParameters, CompositionDiagnostics, CompositionGetByIdParameters, CompositionGetByNodeIdParameters, CompositionGetByNodePathParameters, CompositionGetBySlugParameters, CompositionGetListResponse, CompositionGetOrderBy, CompositionGetParameters, CompositionGetResponse, CompositionGetValidResponses, CompositionIssue, CompositionPatternIssue, CompositionPutParameters, CompositionRelationshipsClientOptions, CompositionRelationshipsDDefinitionGetResponse, CompositionRelationshipsDefinitionApi, CompositionRelationshipsDefinitionGetParameters, CompositionResolvedGetResponse, CompositionUIStatus, DataElementBindingIssue, DataElementConnectionDefinition, DataResolutionConfigIssue, DataResolutionOption, DataResolutionOptionNegative, DataResolutionOptionPositive, DataResolutionParameters, DataResourceDefinition, DataResourceDefinitions, DataResourceInputIssue, DataResourceIssue, DataResourceVariables, DataSource, DataSourceClient, DataSourceDeleteParameters, DataSourceGetParameters, DataSourceGetResponse, DataSourcePutParameters, DataSourcesGetParameters, DataSourcesGetResponse, DataType, DataTypeClient, DataTypeDeleteParameters, DataTypeGetParameters, DataTypeGetResponse, DataTypePutParameters, DataVariableDefinition, DismissPlaceholderMessage, EDGE_CACHE_DISABLED, EDGE_DEFAULT_CACHE_TTL, EDGE_DEFAULT_L2_CACHE_TTL_IN_HOURS, EDGE_MAX_CACHE_TTL, EDGE_MAX_L2_CACHE_TTL_IN_HOURS, EDGE_MIN_CACHE_TTL, EDGE_MIN_L2_CACHE_TTL_IN_HOURS, EMPTY_COMPOSITION, EnhancerBuilder, EnhancerContext, EnhancerError, EventNames, IN_CONTEXT_EDITOR_COMPONENT_END_ROLE, IN_CONTEXT_EDITOR_COMPONENT_START_ROLE, IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID, IN_CONTEXT_EDITOR_QUERY_STRING_PARAM, IS_RENDERED_BY_UNIFORM_ATTRIBUTE, InvalidationPayload, InvalidationResult, LimitPolicy, LinkComponentParameterValue, LinkParamConfiguration, LinkParamValue, LinkParameterType, LinkTypeConfiguration, MessageHandler, MoveComponentMessage, NonProjectMapLinkParamValue, OverrideIssue, OverrideOptions, PLACEHOLDER_ID, PreviewEventBus, PreviewPanelSettings, ProjectMapLinkComponentParameterValue, ProjectMapLinkParamValue, ReadyMessage, ReportRenderedCompositionsMessage, ResolvedRouteGetResponse, RichTextBuiltInElement, RichTextBuiltInFormat, RichTextParamConfiguration, RichTextParamValue, RootComponentInstance, RouteDynamicInputs, RouteGetParameters, RouteGetResponse, RouteGetResponseComposition, RouteGetResponseEdgehancedComposition, RouteGetResponseNotFound, RouteGetResponseRedirect, SelectComponentMessage, SpecificProjectMap, SubscribeToCompositionOptions, TriggerCompositionActionMessage, UncachedCanvasClient, UniqueBatchEntries, UnsubscribeCallback, UpdateComponentParameterMessage, UpdateCompositionInternalMessage, UpdateCompositionMessage, UpdatePreviewSettingsMessage, UsageTrackingApi, UsageTrackingGetParameters, UsageTrackingGetResponse, UsageTrackingPostParameters, UsageTrackingPostResponse, WalkComponentTreeActions, bindVariables, bindVariablesToObject, compose, createBatchEnhancer, createCanvasChannel, createEventBus, createLimitPolicy, createUniformApiEnhancer, enhance, extractLocales, generateHash, getChannelName, getComponentJsonPointer, getComponentPath, isAddComponentMessage, isDismissPlaceholderMessage, isMovingComponentMessage, isReadyMessage, isReportRenderedCompositionsMessage, isSelectComponentMessage, isSystemComponentDefinition, isTriggerCompositionActionMessage, isUpdateComponentParameterMessage, isUpdateCompositionInternalMessage, isUpdateCompositionMessage, isUpdatePreviewSettingsMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, nullLimitPolicy, subscribeToComposition, unstable_CompositionRelationshipClient, unstable_RouteClient, walkComponentTree };
|