@uniformdev/canvas 17.5.1-alpha.7 → 17.6.1-alpha.106
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/chunk-PVRSC7Y6.mjs +4 -0
- package/dist/cli/cli.d.ts +1 -1
- package/dist/cli/cli.js +41 -41
- package/dist/cli/cli.mjs +36 -36
- package/dist/{createEventBus-ae757f10.d.ts → createEventBus-bb2f5866.d.ts} +758 -781
- package/dist/index.d.ts +464 -426
- package/dist/index.esm.js +1 -1
- package/dist/index.js +2 -2
- package/dist/index.mjs +1 -1
- package/package.json +6 -6
- package/dist/chunk-3DNK2OLJ.mjs +0 -4
|
@@ -1,592 +1,85 @@
|
|
|
1
1
|
import Pusher from 'pusher-js';
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
/** Max number of records to return */
|
|
19
|
-
limit?: number;
|
|
20
|
-
/** Whether to fetch system meta-component definitions (personalize, test, etc) */
|
|
21
|
-
includeSystem?: boolean;
|
|
22
|
-
};
|
|
23
|
-
};
|
|
24
|
-
responses: {
|
|
25
|
-
/** OK */
|
|
26
|
-
200: {
|
|
27
|
-
content: {
|
|
28
|
-
"application/json": {
|
|
29
|
-
/** @description Component definitions that match the query */
|
|
30
|
-
componentDefinitions: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinition"][];
|
|
31
|
-
};
|
|
32
|
-
};
|
|
33
|
-
};
|
|
34
|
-
400: external$5["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
|
35
|
-
401: external$5["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
|
36
|
-
403: external$5["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
|
37
|
-
429: external$5["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
|
38
|
-
500: external$5["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
|
39
|
-
};
|
|
3
|
+
interface components$2 {
|
|
4
|
+
schemas: {
|
|
5
|
+
/** @description Public ID (used in code). Do not change after creation. */
|
|
6
|
+
PublicIdProperty: string;
|
|
7
|
+
/** @description The definition of a component parameter */
|
|
8
|
+
ComponentDefinitionParameter: {
|
|
9
|
+
id: components$2["schemas"]["PublicIdProperty"];
|
|
10
|
+
/** @description Friendly name of the parameter */
|
|
11
|
+
name: string;
|
|
12
|
+
/** @description Appears next to the parameter in the Composition editor */
|
|
13
|
+
helpText?: string;
|
|
14
|
+
/** @description Type name of the parameter (provided by a Uniform integration) */
|
|
15
|
+
type: string;
|
|
16
|
+
/** @description The configuration object for the type (type-specific) */
|
|
17
|
+
typeConfig?: unknown;
|
|
40
18
|
};
|
|
41
|
-
/**
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
* @description The project ID to upsert the component definition to
|
|
58
|
-
*/
|
|
59
|
-
projectId: string;
|
|
60
|
-
componentDefinition: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinition"];
|
|
61
|
-
};
|
|
62
|
-
};
|
|
63
|
-
};
|
|
19
|
+
/** @description The definition of a named component slot that can contain other components */
|
|
20
|
+
ComponentDefinitionSlot: {
|
|
21
|
+
id: components$2["schemas"]["PublicIdProperty"];
|
|
22
|
+
/** @description Friendly name of the slot */
|
|
23
|
+
name: string;
|
|
24
|
+
/** @description A list of component definition public IDs that are allowed in this named slot */
|
|
25
|
+
allowedComponents: string[];
|
|
26
|
+
/**
|
|
27
|
+
* @description Whether this slot inherits its allowed components from the parent slot it lives in. If true, allowedComponents is irrelevant.
|
|
28
|
+
* @default false
|
|
29
|
+
*/
|
|
30
|
+
inheritAllowedComponents: boolean;
|
|
31
|
+
/** @description Minimum valid number of components in this slot */
|
|
32
|
+
minComponents?: number;
|
|
33
|
+
/** @description Maximum valid number of components in this slot */
|
|
34
|
+
maxComponents?: number;
|
|
64
35
|
};
|
|
65
|
-
/**
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
36
|
+
/** @description The definition of a composition's slug settings */
|
|
37
|
+
ComponentDefinitionSlugSettings: {
|
|
38
|
+
/**
|
|
39
|
+
* @description Whether the slug is required
|
|
40
|
+
* no: slug is optional
|
|
41
|
+
* yes: slug is required
|
|
42
|
+
* disabled: slug is disabled and will not be shown in the editor
|
|
43
|
+
*
|
|
44
|
+
* @default no
|
|
45
|
+
* @enum {string}
|
|
46
|
+
*/
|
|
47
|
+
required?: "no" | "yes" | "disabled";
|
|
48
|
+
/**
|
|
49
|
+
* @description Slug uniqueness configuration.
|
|
50
|
+
* no = no unique constraint
|
|
51
|
+
* local = must be unique within this component type
|
|
52
|
+
* global = must be unique across all component types
|
|
53
|
+
*
|
|
54
|
+
* @enum {string}
|
|
55
|
+
*/
|
|
56
|
+
unique?: "no" | "local" | "global";
|
|
57
|
+
/** @description Regular expression slugs must match */
|
|
58
|
+
regularExpression?: string;
|
|
59
|
+
/**
|
|
60
|
+
* @description Custom error message when regular expression validation fails.
|
|
61
|
+
* Has no effect if `regularExpression` is not set.
|
|
62
|
+
*/
|
|
63
|
+
regularExpressionMessage?: string;
|
|
89
64
|
};
|
|
90
|
-
/**
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
};
|
|
65
|
+
/** @description The definition of a component variant */
|
|
66
|
+
ComponentDefinitionVariant: {
|
|
67
|
+
id: components$2["schemas"]["PublicIdProperty"];
|
|
68
|
+
/** @description Friendly name of the variant */
|
|
69
|
+
name: string;
|
|
96
70
|
};
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
responses: {
|
|
110
|
-
/** Request input validation failed */
|
|
111
|
-
BadRequestError: {
|
|
112
|
-
content: {
|
|
113
|
-
"application/json": external$5["swagger.yml"]["components"]["schemas"]["Error"];
|
|
114
|
-
};
|
|
115
|
-
};
|
|
116
|
-
/** API key or token was not valid */
|
|
117
|
-
UnauthorizedError: {
|
|
118
|
-
content: {
|
|
119
|
-
"application/json": external$5["swagger.yml"]["components"]["schemas"]["Error"];
|
|
120
|
-
};
|
|
121
|
-
};
|
|
122
|
-
/** Permission was denied */
|
|
123
|
-
ForbiddenError: {
|
|
124
|
-
content: {
|
|
125
|
-
"application/json": external$5["swagger.yml"]["components"]["schemas"]["Error"];
|
|
126
|
-
};
|
|
127
|
-
};
|
|
128
|
-
/** Resource not found */
|
|
129
|
-
NotFoundError: {
|
|
130
|
-
content: {
|
|
131
|
-
"application/json": external$5["swagger.yml"]["components"]["schemas"]["Error"];
|
|
132
|
-
};
|
|
133
|
-
};
|
|
134
|
-
/** Too many requests in allowed time period */
|
|
135
|
-
RateLimitError: unknown;
|
|
136
|
-
/** Execution error occurred */
|
|
137
|
-
InternalServerError: unknown;
|
|
138
|
-
};
|
|
139
|
-
};
|
|
140
|
-
operations: {};
|
|
141
|
-
};
|
|
142
|
-
"uniform-canvas-types.swagger.yml": {
|
|
143
|
-
paths: {};
|
|
144
|
-
components: {
|
|
145
|
-
schemas: {
|
|
146
|
-
/** @description Public ID (used in code). Do not change after creation. */
|
|
147
|
-
PublicIdProperty: string;
|
|
148
|
-
/** @description The definition of a component parameter */
|
|
149
|
-
ComponentDefinitionParameter: {
|
|
150
|
-
id: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
|
151
|
-
/** @description Friendly name of the parameter */
|
|
152
|
-
name: string;
|
|
153
|
-
/** @description Appears next to the parameter in the Composition editor */
|
|
154
|
-
helpText?: string;
|
|
155
|
-
/** @description Type name of the parameter (provided by a Uniform integration) */
|
|
156
|
-
type: string;
|
|
157
|
-
/** @description The configuration object for the type (type-specific) */
|
|
158
|
-
typeConfig?: unknown;
|
|
159
|
-
};
|
|
160
|
-
/** @description The definition of a named component slot that can contain other components */
|
|
161
|
-
ComponentDefinitionSlot: {
|
|
162
|
-
id: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
|
163
|
-
/** @description Friendly name of the slot */
|
|
164
|
-
name: string;
|
|
165
|
-
/** @description A list of component definition public IDs that are allowed in this named slot */
|
|
166
|
-
allowedComponents: string[];
|
|
167
|
-
/**
|
|
168
|
-
* @description Whether this slot inherits its allowed components from the parent slot it lives in. If true, allowedComponents is irrelevant.
|
|
169
|
-
* @default false
|
|
170
|
-
*/
|
|
171
|
-
inheritAllowedComponents: boolean;
|
|
172
|
-
/** @description Minimum valid number of components in this slot */
|
|
173
|
-
minComponents?: number;
|
|
174
|
-
/** @description Maximum valid number of components in this slot */
|
|
175
|
-
maxComponents?: number;
|
|
176
|
-
};
|
|
177
|
-
/** @description The definition of a composition's slug settings */
|
|
178
|
-
ComponentDefinitionSlugSettings: {
|
|
179
|
-
/**
|
|
180
|
-
* @description Whether the slug is required
|
|
181
|
-
* no: slug is optional
|
|
182
|
-
* yes: slug is required
|
|
183
|
-
* disabled: slug is disabled and will not be shown in the editor
|
|
184
|
-
*
|
|
185
|
-
* @default no
|
|
186
|
-
* @enum {string}
|
|
187
|
-
*/
|
|
188
|
-
required?: "no" | "yes" | "disabled";
|
|
189
|
-
/**
|
|
190
|
-
* @description Slug uniqueness configuration.
|
|
191
|
-
* no = no unique constraint
|
|
192
|
-
* local = must be unique within this component type
|
|
193
|
-
* global = must be unique across all component types
|
|
194
|
-
*
|
|
195
|
-
* @enum {string}
|
|
196
|
-
*/
|
|
197
|
-
unique?: "no" | "local" | "global";
|
|
198
|
-
/** @description Regular expression slugs must match */
|
|
199
|
-
regularExpression?: string;
|
|
200
|
-
/**
|
|
201
|
-
* @description Custom error message when regular expression validation fails.
|
|
202
|
-
* Has no effect if `regularExpression` is not set.
|
|
203
|
-
*/
|
|
204
|
-
regularExpressionMessage?: string;
|
|
205
|
-
};
|
|
206
|
-
/** @description The definition of a component variant */
|
|
207
|
-
ComponentDefinitionVariant: {
|
|
208
|
-
id: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
|
209
|
-
/** @description Friendly name of the variant */
|
|
210
|
-
name: string;
|
|
211
|
-
};
|
|
212
|
-
/** @description Permission set for a component defintion */
|
|
213
|
-
ComponentDefinitionPermission: {
|
|
214
|
-
roleId: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
|
215
|
-
/**
|
|
216
|
-
* @description Permission type for this permission ComponentDefinition:
|
|
217
|
-
* read | write | create | delete
|
|
218
|
-
*
|
|
219
|
-
* @enum {string}
|
|
220
|
-
*/
|
|
221
|
-
permission: "read" | "write" | "create" | "delete";
|
|
222
|
-
/** @description State of the component that this permission applies to */
|
|
223
|
-
state: number;
|
|
224
|
-
};
|
|
225
|
-
/** @description Defines a component type that can live on a Composition */
|
|
226
|
-
ComponentDefinition: {
|
|
227
|
-
id: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
|
228
|
-
/** @description Friendly name of the component definition */
|
|
229
|
-
name: string;
|
|
230
|
-
/**
|
|
231
|
-
* @description Icon name or URL for the component definition (e.g. 'screen' or 'https://s3/my-component.jpg')
|
|
232
|
-
* @default screen
|
|
233
|
-
*/
|
|
234
|
-
icon?: string;
|
|
235
|
-
/**
|
|
236
|
-
* @description The public ID of the parameter whose value should be used to create a display title for this component in the UI.
|
|
237
|
-
* The parameter type must support being used as a title parameter for this to work.
|
|
238
|
-
*/
|
|
239
|
-
titleParameter?: string | null;
|
|
240
|
-
/**
|
|
241
|
-
* @description Whether this component type can be the root of a composition. If false, this component is only used within slots on other components.
|
|
242
|
-
* @default false
|
|
243
|
-
*/
|
|
244
|
-
canBeComposition?: boolean;
|
|
245
|
-
/** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries. */
|
|
246
|
-
parameters?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
|
|
247
|
-
/**
|
|
248
|
-
* @description if this component uses team permissions or custom permissions
|
|
249
|
-
* @default true
|
|
250
|
-
*/
|
|
251
|
-
useTeamPermissions?: boolean;
|
|
252
|
-
/** @description Custom role permissions for this component definition */
|
|
253
|
-
permissions?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
|
|
254
|
-
/** @description The named slots for this component; placement areas where arrays of other components can be added. */
|
|
255
|
-
slots?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlot"][];
|
|
256
|
-
slugSettings?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
|
257
|
-
/** @description Default component instance value */
|
|
258
|
-
defaults?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"] | null;
|
|
259
|
-
/** @description Named variants for this component; enables creation of visual variants that use the same parameter data */
|
|
260
|
-
variants?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionVariant"][];
|
|
261
|
-
/** @description Created date string for this definition (ignored for writes) */
|
|
262
|
-
created?: string;
|
|
263
|
-
/** @description Last modified date string for this definition (ignored for writes) */
|
|
264
|
-
updated?: string;
|
|
265
|
-
};
|
|
266
|
-
/** @description Defines an editable parameter on a component. */
|
|
267
|
-
ComponentParameter: {
|
|
268
|
-
/** @description The value of the parameter. Any JSON-serializable value is acceptable. */
|
|
269
|
-
value: unknown;
|
|
270
|
-
/** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
|
|
271
|
-
type: string;
|
|
272
|
-
connectedData?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
|
|
273
|
-
};
|
|
274
|
-
/**
|
|
275
|
-
* @deprecated
|
|
276
|
-
* @description Defines a connection to a data element on a data resource. Do not use.
|
|
277
|
-
*/
|
|
278
|
-
DataElementConnectionDefinition: {
|
|
279
|
-
/** @description A JSON Pointer expression that defines the data element to connect the parameter to. */
|
|
280
|
-
pointer: string;
|
|
281
|
-
/**
|
|
282
|
-
* @description The syntax used to select the data element to bind to
|
|
283
|
-
* @enum {string}
|
|
284
|
-
*/
|
|
285
|
-
syntax: "jptr";
|
|
286
|
-
/**
|
|
287
|
-
* @description Whether an error should occur if the connected data element cannot be resolved (i.e. a missing property in the data resource).
|
|
288
|
-
* In all cases the binding process will remove the parameter data for the unresolvable data element.
|
|
289
|
-
* When this is true, and the data element failed to bind, the warning entry returned from the binding process will be changed to an error entry.
|
|
290
|
-
*
|
|
291
|
-
* @default false
|
|
292
|
-
*/
|
|
293
|
-
required?: boolean;
|
|
294
|
-
};
|
|
295
|
-
/** @description Defines the shape of a component instance served by the composition API. */
|
|
296
|
-
ComponentInstance: {
|
|
297
|
-
/** @description Type of the component instance (public_id of its definition) */
|
|
298
|
-
type: string;
|
|
299
|
-
/** @description Component parameter values for the component instance */
|
|
300
|
-
parameters?: {
|
|
301
|
-
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
|
302
|
-
};
|
|
303
|
-
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
|
304
|
-
variant?: string;
|
|
305
|
-
/** @description Slots containing any child components */
|
|
306
|
-
slots?: {
|
|
307
|
-
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
|
|
308
|
-
};
|
|
309
|
-
/** @description Unique identifier of the component within the composition. This is not set unless specifically requested via `withComponentIDs` API parameter. */
|
|
310
|
-
_id?: string;
|
|
311
|
-
/** @description Indicates this component instance should be sourced from a pattern library pattern. */
|
|
312
|
-
_pattern?: string;
|
|
313
|
-
_dataResources?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
|
314
|
-
/**
|
|
315
|
-
* @deprecated
|
|
316
|
-
* @description Data definitions coming from a pattern resolved for this component. Merged with _data during resolution.
|
|
317
|
-
* Means nothing for PUTs; it will be ignored.
|
|
318
|
-
*/
|
|
319
|
-
_patternDataResources?: {
|
|
320
|
-
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
|
321
|
-
};
|
|
322
|
-
/**
|
|
323
|
-
* @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
|
324
|
-
* CYCLIC: A cyclic pattern graph was detected, which could not be resolved because it would cause an infinite loop.
|
|
325
|
-
* NOTFOUND: The pattern ID referenced could not be found. It may have been deleted, or not be published yet.
|
|
326
|
-
* Means nothing for PUTs; it will be ignored.
|
|
327
|
-
*
|
|
328
|
-
* @enum {string}
|
|
329
|
-
*/
|
|
330
|
-
_patternError?: "NOTFOUND" | "CYCLIC";
|
|
331
|
-
};
|
|
332
|
-
/** @description Defines the shape of the root component in a composition */
|
|
333
|
-
RootComponentInstance: {
|
|
334
|
-
/** @description Type of the component instance (public_id of its definition) */
|
|
335
|
-
type: string;
|
|
336
|
-
/** @description Component parameter values for the component instance */
|
|
337
|
-
parameters?: {
|
|
338
|
-
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
|
339
|
-
};
|
|
340
|
-
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
|
341
|
-
variant?: string;
|
|
342
|
-
/** @description Slots containing any child components */
|
|
343
|
-
slots?: {
|
|
344
|
-
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
|
|
345
|
-
};
|
|
346
|
-
/** @description The public UUID of the composition. */
|
|
347
|
-
_id: string;
|
|
348
|
-
/** @description Slug pattern of this component. */
|
|
349
|
-
_slug?: string | null;
|
|
350
|
-
/** @description Friendly name of this component. */
|
|
351
|
-
_name: string;
|
|
352
|
-
_dataResources?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
|
353
|
-
};
|
|
354
|
-
/**
|
|
355
|
-
* @deprecated
|
|
356
|
-
* @description Basic information about a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset"). This data is provided to list responses.
|
|
357
|
-
*/
|
|
358
|
-
DataSourceInfo: {
|
|
359
|
-
/** @description Public ID of the data source */
|
|
360
|
-
id: string;
|
|
361
|
-
/** @description Display name of the data source */
|
|
362
|
-
displayName: string;
|
|
363
|
-
/** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
|
|
364
|
-
connectorType: string;
|
|
365
|
-
/** @description Base resource URL of the data source. No trailing slash. */
|
|
366
|
-
baseUrl: string;
|
|
367
|
-
};
|
|
368
|
-
/**
|
|
369
|
-
* @deprecated
|
|
370
|
-
* @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset"). These are created in the UI and shared across a whole project.
|
|
371
|
-
*/
|
|
372
|
-
DataSource: {
|
|
373
|
-
/** @description Public ID of the data source */
|
|
374
|
-
id: string;
|
|
375
|
-
/** @description Display name of the data source */
|
|
376
|
-
displayName: string;
|
|
377
|
-
/** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
|
|
378
|
-
connectorType: string;
|
|
379
|
-
/** @description Base resource URL of the data source. No trailing slash. */
|
|
380
|
-
baseUrl: string;
|
|
381
|
-
headers?: {
|
|
382
|
-
[key: string]: string;
|
|
383
|
-
} | {
|
|
384
|
-
key: string;
|
|
385
|
-
value: string;
|
|
386
|
-
}[];
|
|
387
|
-
parameters?: {
|
|
388
|
-
[key: string]: string;
|
|
389
|
-
} | {
|
|
390
|
-
key: string;
|
|
391
|
-
value: string;
|
|
392
|
-
}[];
|
|
393
|
-
/** @description Variables needed to make calls to the data source */
|
|
394
|
-
variables?: {
|
|
395
|
-
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
|
396
|
-
};
|
|
397
|
-
/** @description Custom configuration specific to the data source being defined (used to maintain UI state for custom integrations) */
|
|
398
|
-
custom?: {
|
|
399
|
-
[key: string]: unknown;
|
|
400
|
-
};
|
|
401
|
-
};
|
|
402
|
-
/**
|
|
403
|
-
* @deprecated
|
|
404
|
-
* @description A specific type of data that a Data Source can provide (i.e. "Recipe", "Recipes List by Tag", "Yelp Reviews of My Restaurant"). These are created in the UI and shared a whole project.
|
|
405
|
-
*/
|
|
406
|
-
DataType: {
|
|
407
|
-
/** @description Public ID of the data type */
|
|
408
|
-
id: string;
|
|
409
|
-
/** @description Display name of the data type */
|
|
410
|
-
displayName: string;
|
|
411
|
-
/** @description Public ID of the associated data source */
|
|
412
|
-
dataSourceId: string;
|
|
413
|
-
/**
|
|
414
|
-
* @description A connector-specific archetype for this data type; used to select UI as well as perform any
|
|
415
|
-
* necessary post-processing on the response. e.g. 'cms-entry', 'cms-query'. Can be undefined if
|
|
416
|
-
* no special UI or processing is required.
|
|
417
|
-
*/
|
|
418
|
-
archetype?: string;
|
|
419
|
-
allowedOnComponents?: string[];
|
|
420
|
-
/** @description Resource path, appended to the data source's baseUrl (e.g. baseUrl = https://base.url, path = /v1/endpoint -> final URL https://base.url/v1/endpoint). Must have leading slash. */
|
|
421
|
-
path: string;
|
|
422
|
-
/** @description Time-to-live for the resource data cache. */
|
|
423
|
-
ttl?: number;
|
|
424
|
-
/** @description A key for the resource data cache purging. */
|
|
425
|
-
purgeKey?: string;
|
|
426
|
-
/** @description URL to a custom badge icon for the Uniform dashboard for this data type. If not set falls back to the data connector or integration icons. */
|
|
427
|
-
badgeIconUrl?: string;
|
|
428
|
-
/** @description HTTP headers to pass with requests to the data type. Merged with headers from the data source, overriding identical keys. */
|
|
429
|
-
headers?: {
|
|
430
|
-
[key: string]: string;
|
|
431
|
-
} | {
|
|
432
|
-
key: string;
|
|
433
|
-
value: string;
|
|
434
|
-
}[];
|
|
435
|
-
/** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys. */
|
|
436
|
-
parameters?: {
|
|
437
|
-
[key: string]: string;
|
|
438
|
-
} | {
|
|
439
|
-
key: string;
|
|
440
|
-
value: string;
|
|
441
|
-
}[];
|
|
442
|
-
/** @description Body to pass with requests to the data type (ignored unless method is POST) */
|
|
443
|
-
body?: string;
|
|
444
|
-
/**
|
|
445
|
-
* @description HTTP method to use with requests to the data type.
|
|
446
|
-
* @default GET
|
|
447
|
-
* @enum {string}
|
|
448
|
-
*/
|
|
449
|
-
method: "GET" | "POST" | "HEAD";
|
|
450
|
-
/** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys. */
|
|
451
|
-
variables?: {
|
|
452
|
-
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
|
453
|
-
};
|
|
454
|
-
/** @description Custom configuration specific to the data source being defined */
|
|
455
|
-
custom?: {
|
|
456
|
-
[key: string]: unknown;
|
|
457
|
-
};
|
|
458
|
-
};
|
|
459
|
-
/**
|
|
460
|
-
* @deprecated
|
|
461
|
-
* @description Defines the shape of a data variable on a Data Source or Data Type
|
|
462
|
-
*/
|
|
463
|
-
DataVariableDefinition: {
|
|
464
|
-
/** @description Display name of the data variable */
|
|
465
|
-
displayName?: string;
|
|
466
|
-
/** @description Explanatory text that is provided to the data resource editor to explain what this variable does. */
|
|
467
|
-
helpText?: string;
|
|
468
|
-
/**
|
|
469
|
-
* @description Type of the data variable. Optionally used as a point of reference for custom integrations to decide how to render an editor for a variable.
|
|
470
|
-
* @default text
|
|
471
|
-
*/
|
|
472
|
-
type?: string;
|
|
473
|
-
/** @description Default value of the data variable */
|
|
474
|
-
default: string;
|
|
475
|
-
/** @description Sets the order of the variable when displayed in a list with other variables. If not set, the order defaults to alphabetical with any explicitly set orders first in the list. */
|
|
476
|
-
order?: number;
|
|
477
|
-
};
|
|
478
|
-
/**
|
|
479
|
-
* @deprecated
|
|
480
|
-
* @description Data definitions attached to this component. The property name is the key of the data in the data document.
|
|
481
|
-
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
|
482
|
-
*/
|
|
483
|
-
DataResourceDefinitions: {
|
|
484
|
-
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
|
485
|
-
};
|
|
486
|
-
/**
|
|
487
|
-
* @deprecated
|
|
488
|
-
* @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters
|
|
489
|
-
*/
|
|
490
|
-
DataResourceDefinition: {
|
|
491
|
-
/** @description Public ID of the data type that provides this data */
|
|
492
|
-
type: string;
|
|
493
|
-
/** @description Whether this data is a pattern parameter that has to be overridden when a pattern is referenced on another composition. If this is not a pattern composition, this has no meaning and should not be used. If unspecified, the default is false. */
|
|
494
|
-
isPatternParameter?: boolean;
|
|
495
|
-
variables?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
|
496
|
-
};
|
|
497
|
-
/**
|
|
498
|
-
* @deprecated
|
|
499
|
-
* @description Variable values for a data resource.
|
|
500
|
-
*/
|
|
501
|
-
DataResourceVariables: {
|
|
502
|
-
[key: string]: string;
|
|
503
|
-
};
|
|
504
|
-
};
|
|
505
|
-
};
|
|
506
|
-
operations: {};
|
|
507
|
-
};
|
|
508
|
-
}
|
|
509
|
-
|
|
510
|
-
interface components$2 {
|
|
511
|
-
schemas: {
|
|
512
|
-
/** @description Public ID (used in code). Do not change after creation. */
|
|
513
|
-
PublicIdProperty: string;
|
|
514
|
-
/** @description The definition of a component parameter */
|
|
515
|
-
ComponentDefinitionParameter: {
|
|
516
|
-
id: components$2["schemas"]["PublicIdProperty"];
|
|
517
|
-
/** @description Friendly name of the parameter */
|
|
518
|
-
name: string;
|
|
519
|
-
/** @description Appears next to the parameter in the Composition editor */
|
|
520
|
-
helpText?: string;
|
|
521
|
-
/** @description Type name of the parameter (provided by a Uniform integration) */
|
|
522
|
-
type: string;
|
|
523
|
-
/** @description The configuration object for the type (type-specific) */
|
|
524
|
-
typeConfig?: unknown;
|
|
525
|
-
};
|
|
526
|
-
/** @description The definition of a named component slot that can contain other components */
|
|
527
|
-
ComponentDefinitionSlot: {
|
|
528
|
-
id: components$2["schemas"]["PublicIdProperty"];
|
|
529
|
-
/** @description Friendly name of the slot */
|
|
530
|
-
name: string;
|
|
531
|
-
/** @description A list of component definition public IDs that are allowed in this named slot */
|
|
532
|
-
allowedComponents: string[];
|
|
533
|
-
/**
|
|
534
|
-
* @description Whether this slot inherits its allowed components from the parent slot it lives in. If true, allowedComponents is irrelevant.
|
|
535
|
-
* @default false
|
|
536
|
-
*/
|
|
537
|
-
inheritAllowedComponents: boolean;
|
|
538
|
-
/** @description Minimum valid number of components in this slot */
|
|
539
|
-
minComponents?: number;
|
|
540
|
-
/** @description Maximum valid number of components in this slot */
|
|
541
|
-
maxComponents?: number;
|
|
542
|
-
};
|
|
543
|
-
/** @description The definition of a composition's slug settings */
|
|
544
|
-
ComponentDefinitionSlugSettings: {
|
|
545
|
-
/**
|
|
546
|
-
* @description Whether the slug is required
|
|
547
|
-
* no: slug is optional
|
|
548
|
-
* yes: slug is required
|
|
549
|
-
* disabled: slug is disabled and will not be shown in the editor
|
|
550
|
-
*
|
|
551
|
-
* @default no
|
|
552
|
-
* @enum {string}
|
|
553
|
-
*/
|
|
554
|
-
required?: "no" | "yes" | "disabled";
|
|
555
|
-
/**
|
|
556
|
-
* @description Slug uniqueness configuration.
|
|
557
|
-
* no = no unique constraint
|
|
558
|
-
* local = must be unique within this component type
|
|
559
|
-
* global = must be unique across all component types
|
|
560
|
-
*
|
|
561
|
-
* @enum {string}
|
|
562
|
-
*/
|
|
563
|
-
unique?: "no" | "local" | "global";
|
|
564
|
-
/** @description Regular expression slugs must match */
|
|
565
|
-
regularExpression?: string;
|
|
566
|
-
/**
|
|
567
|
-
* @description Custom error message when regular expression validation fails.
|
|
568
|
-
* Has no effect if `regularExpression` is not set.
|
|
569
|
-
*/
|
|
570
|
-
regularExpressionMessage?: string;
|
|
571
|
-
};
|
|
572
|
-
/** @description The definition of a component variant */
|
|
573
|
-
ComponentDefinitionVariant: {
|
|
574
|
-
id: components$2["schemas"]["PublicIdProperty"];
|
|
575
|
-
/** @description Friendly name of the variant */
|
|
576
|
-
name: string;
|
|
577
|
-
};
|
|
578
|
-
/** @description Permission set for a component defintion */
|
|
579
|
-
ComponentDefinitionPermission: {
|
|
580
|
-
roleId: components$2["schemas"]["PublicIdProperty"];
|
|
581
|
-
/**
|
|
582
|
-
* @description Permission type for this permission ComponentDefinition:
|
|
583
|
-
* read | write | create | delete
|
|
584
|
-
*
|
|
585
|
-
* @enum {string}
|
|
586
|
-
*/
|
|
587
|
-
permission: "read" | "write" | "create" | "delete";
|
|
588
|
-
/** @description State of the component that this permission applies to */
|
|
589
|
-
state: number;
|
|
71
|
+
/** @description Permission set for a component defintion */
|
|
72
|
+
ComponentDefinitionPermission: {
|
|
73
|
+
roleId: components$2["schemas"]["PublicIdProperty"];
|
|
74
|
+
/**
|
|
75
|
+
* @description Permission type for this permission ComponentDefinition:
|
|
76
|
+
* read | write | create | delete
|
|
77
|
+
*
|
|
78
|
+
* @enum {string}
|
|
79
|
+
*/
|
|
80
|
+
permission: "read" | "write" | "create" | "delete";
|
|
81
|
+
/** @description State of the component that this permission applies to */
|
|
82
|
+
state: number;
|
|
590
83
|
};
|
|
591
84
|
/** @description Defines a component type that can live on a Composition */
|
|
592
85
|
ComponentDefinition: {
|
|
@@ -719,21 +212,10 @@ interface components$2 {
|
|
|
719
212
|
};
|
|
720
213
|
/**
|
|
721
214
|
* @deprecated
|
|
722
|
-
* @description
|
|
723
|
-
|
|
724
|
-
|
|
725
|
-
|
|
726
|
-
id: string;
|
|
727
|
-
/** @description Display name of the data source */
|
|
728
|
-
displayName: string;
|
|
729
|
-
/** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
|
|
730
|
-
connectorType: string;
|
|
731
|
-
/** @description Base resource URL of the data source. No trailing slash. */
|
|
732
|
-
baseUrl: string;
|
|
733
|
-
};
|
|
734
|
-
/**
|
|
735
|
-
* @deprecated
|
|
736
|
-
* @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset"). These are created in the UI and shared across a whole project.
|
|
215
|
+
* @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
|
|
216
|
+
* These are created in the UI and shared across a whole project.
|
|
217
|
+
* NOTE: if you acquire a list of data sources or do not have manage permissions, you will receive "SECRET"
|
|
218
|
+
* for all header, parameter, and variable values to obscure the actual encrypted secret value.
|
|
737
219
|
*/
|
|
738
220
|
DataSource: {
|
|
739
221
|
/** @description Public ID of the data source */
|
|
@@ -785,8 +267,15 @@ interface components$2 {
|
|
|
785
267
|
allowedOnComponents?: string[];
|
|
786
268
|
/** @description Resource path, appended to the data source's baseUrl (e.g. baseUrl = https://base.url, path = /v1/endpoint -> final URL https://base.url/v1/endpoint). Must have leading slash. */
|
|
787
269
|
path: string;
|
|
788
|
-
/** @description Time-to-live for the resource data cache. */
|
|
270
|
+
/** @description Time-to-live (in seconds) for the primary resource data cache. */
|
|
789
271
|
ttl?: number;
|
|
272
|
+
/** @description Long term data resource cache configuration. */
|
|
273
|
+
longTermCache?: {
|
|
274
|
+
/** @description A flag to turn the long term cache on. */
|
|
275
|
+
enabled: boolean;
|
|
276
|
+
/** @description Time-to-live (in hours) for the long term resource data cache. */
|
|
277
|
+
ttlInHours?: number;
|
|
278
|
+
};
|
|
790
279
|
/** @description A key for the resource data cache purging. */
|
|
791
280
|
purgeKey?: string;
|
|
792
281
|
/** @description URL to a custom badge icon for the Uniform dashboard for this data type. If not set falls back to the data connector or integration icons. */
|
|
@@ -822,51 +311,554 @@ interface components$2 {
|
|
|
822
311
|
[key: string]: unknown;
|
|
823
312
|
};
|
|
824
313
|
};
|
|
825
|
-
/**
|
|
826
|
-
* @deprecated
|
|
827
|
-
* @description Defines the shape of a data variable on a Data Source or Data Type
|
|
828
|
-
*/
|
|
829
|
-
DataVariableDefinition: {
|
|
830
|
-
/** @description Display name of the data variable */
|
|
831
|
-
displayName?: string;
|
|
832
|
-
/** @description Explanatory text that is provided to the data resource editor to explain what this variable does. */
|
|
833
|
-
helpText?: string;
|
|
834
|
-
/**
|
|
835
|
-
* @description Type of the data variable. Optionally used as a point of reference for custom integrations to decide how to render an editor for a variable.
|
|
836
|
-
* @default text
|
|
837
|
-
*/
|
|
838
|
-
type?: string;
|
|
839
|
-
/** @description Default value of the data variable */
|
|
840
|
-
default: string;
|
|
841
|
-
/** @description Sets the order of the variable when displayed in a list with other variables. If not set, the order defaults to alphabetical with any explicitly set orders first in the list. */
|
|
842
|
-
order?: number;
|
|
843
|
-
};
|
|
844
|
-
/**
|
|
845
|
-
* @deprecated
|
|
846
|
-
* @description Data definitions attached to this component. The property name is the key of the data in the data document.
|
|
847
|
-
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
|
848
|
-
*/
|
|
849
|
-
DataResourceDefinitions: {
|
|
850
|
-
[key: string]: components$2["schemas"]["DataResourceDefinition"];
|
|
851
|
-
};
|
|
852
|
-
/**
|
|
853
|
-
* @deprecated
|
|
854
|
-
* @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters
|
|
855
|
-
*/
|
|
856
|
-
DataResourceDefinition: {
|
|
857
|
-
/** @description Public ID of the data type that provides this data */
|
|
858
|
-
type: string;
|
|
859
|
-
/** @description Whether this data is a pattern parameter that has to be overridden when a pattern is referenced on another composition. If this is not a pattern composition, this has no meaning and should not be used. If unspecified, the default is false. */
|
|
860
|
-
isPatternParameter?: boolean;
|
|
861
|
-
variables?: components$2["schemas"]["DataResourceVariables"];
|
|
862
|
-
};
|
|
863
|
-
/**
|
|
864
|
-
* @deprecated
|
|
865
|
-
* @description Variable values for a data resource.
|
|
866
|
-
*/
|
|
867
|
-
DataResourceVariables: {
|
|
868
|
-
[key: string]: string;
|
|
869
|
-
};
|
|
314
|
+
/**
|
|
315
|
+
* @deprecated
|
|
316
|
+
* @description Defines the shape of a data variable on a Data Source or Data Type
|
|
317
|
+
*/
|
|
318
|
+
DataVariableDefinition: {
|
|
319
|
+
/** @description Display name of the data variable */
|
|
320
|
+
displayName?: string;
|
|
321
|
+
/** @description Explanatory text that is provided to the data resource editor to explain what this variable does. */
|
|
322
|
+
helpText?: string;
|
|
323
|
+
/**
|
|
324
|
+
* @description Type of the data variable. Optionally used as a point of reference for custom integrations to decide how to render an editor for a variable.
|
|
325
|
+
* @default text
|
|
326
|
+
*/
|
|
327
|
+
type?: string;
|
|
328
|
+
/** @description Default value of the data variable */
|
|
329
|
+
default: string;
|
|
330
|
+
/** @description Sets the order of the variable when displayed in a list with other variables. If not set, the order defaults to alphabetical with any explicitly set orders first in the list. */
|
|
331
|
+
order?: number;
|
|
332
|
+
};
|
|
333
|
+
/**
|
|
334
|
+
* @deprecated
|
|
335
|
+
* @description Data definitions attached to this component. The property name is the key of the data in the data document.
|
|
336
|
+
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
|
337
|
+
*/
|
|
338
|
+
DataResourceDefinitions: {
|
|
339
|
+
[key: string]: components$2["schemas"]["DataResourceDefinition"];
|
|
340
|
+
};
|
|
341
|
+
/**
|
|
342
|
+
* @deprecated
|
|
343
|
+
* @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters
|
|
344
|
+
*/
|
|
345
|
+
DataResourceDefinition: {
|
|
346
|
+
/** @description Public ID of the data type that provides this data */
|
|
347
|
+
type: string;
|
|
348
|
+
/** @description Whether this data is a pattern parameter that has to be overridden when a pattern is referenced on another composition. If this is not a pattern composition, this has no meaning and should not be used. If unspecified, the default is false. */
|
|
349
|
+
isPatternParameter?: boolean;
|
|
350
|
+
variables?: components$2["schemas"]["DataResourceVariables"];
|
|
351
|
+
};
|
|
352
|
+
/**
|
|
353
|
+
* @deprecated
|
|
354
|
+
* @description Variable values for a data resource.
|
|
355
|
+
*/
|
|
356
|
+
DataResourceVariables: {
|
|
357
|
+
[key: string]: string;
|
|
358
|
+
};
|
|
359
|
+
};
|
|
360
|
+
}
|
|
361
|
+
|
|
362
|
+
/**
|
|
363
|
+
* This file was auto-generated by openapi-typescript.
|
|
364
|
+
* Do not make direct changes to the file.
|
|
365
|
+
*/
|
|
366
|
+
interface paths$4 {
|
|
367
|
+
"/api/v1/canvas-definitions": {
|
|
368
|
+
get: {
|
|
369
|
+
parameters: {
|
|
370
|
+
query: {
|
|
371
|
+
/** The project ID to get component definitions for. */
|
|
372
|
+
projectId: string;
|
|
373
|
+
/** Limit list to one result by ID (response remains an array). */
|
|
374
|
+
componentId?: string;
|
|
375
|
+
/** Number of records to skip */
|
|
376
|
+
offset?: number;
|
|
377
|
+
/** Max number of records to return */
|
|
378
|
+
limit?: number;
|
|
379
|
+
/** Whether to fetch system meta-component definitions (personalize, test, etc) */
|
|
380
|
+
includeSystem?: boolean;
|
|
381
|
+
};
|
|
382
|
+
};
|
|
383
|
+
responses: {
|
|
384
|
+
/** OK */
|
|
385
|
+
200: {
|
|
386
|
+
content: {
|
|
387
|
+
"application/json": {
|
|
388
|
+
/** @description Component definitions that match the query */
|
|
389
|
+
componentDefinitions: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinition"][];
|
|
390
|
+
};
|
|
391
|
+
};
|
|
392
|
+
};
|
|
393
|
+
400: external$5["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
|
394
|
+
401: external$5["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
|
395
|
+
403: external$5["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
|
396
|
+
429: external$5["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
|
397
|
+
500: external$5["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
|
398
|
+
};
|
|
399
|
+
};
|
|
400
|
+
/** Upserts a component definition */
|
|
401
|
+
put: {
|
|
402
|
+
responses: {
|
|
403
|
+
/** OK */
|
|
404
|
+
204: never;
|
|
405
|
+
400: external$5["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
|
406
|
+
401: external$5["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
|
407
|
+
403: external$5["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
|
408
|
+
429: external$5["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
|
409
|
+
500: external$5["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
|
410
|
+
};
|
|
411
|
+
requestBody: {
|
|
412
|
+
content: {
|
|
413
|
+
"application/json": {
|
|
414
|
+
/**
|
|
415
|
+
* Format: uuid
|
|
416
|
+
* @description The project ID to upsert the component definition to
|
|
417
|
+
*/
|
|
418
|
+
projectId: string;
|
|
419
|
+
componentDefinition: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinition"];
|
|
420
|
+
};
|
|
421
|
+
};
|
|
422
|
+
};
|
|
423
|
+
};
|
|
424
|
+
/** Deletes a component definition */
|
|
425
|
+
delete: {
|
|
426
|
+
responses: {
|
|
427
|
+
/** OK */
|
|
428
|
+
204: never;
|
|
429
|
+
400: external$5["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
|
430
|
+
401: external$5["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
|
431
|
+
403: external$5["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
|
432
|
+
429: external$5["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
|
433
|
+
500: external$5["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
|
434
|
+
};
|
|
435
|
+
requestBody: {
|
|
436
|
+
content: {
|
|
437
|
+
"application/json": {
|
|
438
|
+
/** @description The public ID of the component definition to delete */
|
|
439
|
+
componentId: string;
|
|
440
|
+
/**
|
|
441
|
+
* Format: uuid
|
|
442
|
+
* @description The ID of the project the composition to delete belongs to
|
|
443
|
+
*/
|
|
444
|
+
projectId: string;
|
|
445
|
+
};
|
|
446
|
+
};
|
|
447
|
+
};
|
|
448
|
+
};
|
|
449
|
+
/** Handles preflight requests. This endpoint allows CORS. */
|
|
450
|
+
options: {
|
|
451
|
+
responses: {
|
|
452
|
+
/** OK */
|
|
453
|
+
204: never;
|
|
454
|
+
};
|
|
455
|
+
};
|
|
456
|
+
};
|
|
457
|
+
}
|
|
458
|
+
interface external$5 {
|
|
459
|
+
"swagger.yml": {
|
|
460
|
+
paths: {};
|
|
461
|
+
components: {
|
|
462
|
+
schemas: {
|
|
463
|
+
Error: {
|
|
464
|
+
/** @description Error message(s) that occurred while processing the request */
|
|
465
|
+
errorMessage?: string[] | string;
|
|
466
|
+
};
|
|
467
|
+
};
|
|
468
|
+
responses: {
|
|
469
|
+
/** Request input validation failed */
|
|
470
|
+
BadRequestError: {
|
|
471
|
+
content: {
|
|
472
|
+
"application/json": external$5["swagger.yml"]["components"]["schemas"]["Error"];
|
|
473
|
+
};
|
|
474
|
+
};
|
|
475
|
+
/** API key or token was not valid */
|
|
476
|
+
UnauthorizedError: {
|
|
477
|
+
content: {
|
|
478
|
+
"application/json": external$5["swagger.yml"]["components"]["schemas"]["Error"];
|
|
479
|
+
};
|
|
480
|
+
};
|
|
481
|
+
/** Permission was denied */
|
|
482
|
+
ForbiddenError: {
|
|
483
|
+
content: {
|
|
484
|
+
"application/json": external$5["swagger.yml"]["components"]["schemas"]["Error"];
|
|
485
|
+
};
|
|
486
|
+
};
|
|
487
|
+
/** Resource not found */
|
|
488
|
+
NotFoundError: {
|
|
489
|
+
content: {
|
|
490
|
+
"application/json": external$5["swagger.yml"]["components"]["schemas"]["Error"];
|
|
491
|
+
};
|
|
492
|
+
};
|
|
493
|
+
/** Too many requests in allowed time period */
|
|
494
|
+
RateLimitError: unknown;
|
|
495
|
+
/** Execution error occurred */
|
|
496
|
+
InternalServerError: unknown;
|
|
497
|
+
};
|
|
498
|
+
};
|
|
499
|
+
operations: {};
|
|
500
|
+
};
|
|
501
|
+
"uniform-canvas-types.swagger.yml": {
|
|
502
|
+
paths: {};
|
|
503
|
+
components: {
|
|
504
|
+
schemas: {
|
|
505
|
+
/** @description Public ID (used in code). Do not change after creation. */
|
|
506
|
+
PublicIdProperty: string;
|
|
507
|
+
/** @description The definition of a component parameter */
|
|
508
|
+
ComponentDefinitionParameter: {
|
|
509
|
+
id: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
|
510
|
+
/** @description Friendly name of the parameter */
|
|
511
|
+
name: string;
|
|
512
|
+
/** @description Appears next to the parameter in the Composition editor */
|
|
513
|
+
helpText?: string;
|
|
514
|
+
/** @description Type name of the parameter (provided by a Uniform integration) */
|
|
515
|
+
type: string;
|
|
516
|
+
/** @description The configuration object for the type (type-specific) */
|
|
517
|
+
typeConfig?: unknown;
|
|
518
|
+
};
|
|
519
|
+
/** @description The definition of a named component slot that can contain other components */
|
|
520
|
+
ComponentDefinitionSlot: {
|
|
521
|
+
id: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
|
522
|
+
/** @description Friendly name of the slot */
|
|
523
|
+
name: string;
|
|
524
|
+
/** @description A list of component definition public IDs that are allowed in this named slot */
|
|
525
|
+
allowedComponents: string[];
|
|
526
|
+
/**
|
|
527
|
+
* @description Whether this slot inherits its allowed components from the parent slot it lives in. If true, allowedComponents is irrelevant.
|
|
528
|
+
* @default false
|
|
529
|
+
*/
|
|
530
|
+
inheritAllowedComponents: boolean;
|
|
531
|
+
/** @description Minimum valid number of components in this slot */
|
|
532
|
+
minComponents?: number;
|
|
533
|
+
/** @description Maximum valid number of components in this slot */
|
|
534
|
+
maxComponents?: number;
|
|
535
|
+
};
|
|
536
|
+
/** @description The definition of a composition's slug settings */
|
|
537
|
+
ComponentDefinitionSlugSettings: {
|
|
538
|
+
/**
|
|
539
|
+
* @description Whether the slug is required
|
|
540
|
+
* no: slug is optional
|
|
541
|
+
* yes: slug is required
|
|
542
|
+
* disabled: slug is disabled and will not be shown in the editor
|
|
543
|
+
*
|
|
544
|
+
* @default no
|
|
545
|
+
* @enum {string}
|
|
546
|
+
*/
|
|
547
|
+
required?: "no" | "yes" | "disabled";
|
|
548
|
+
/**
|
|
549
|
+
* @description Slug uniqueness configuration.
|
|
550
|
+
* no = no unique constraint
|
|
551
|
+
* local = must be unique within this component type
|
|
552
|
+
* global = must be unique across all component types
|
|
553
|
+
*
|
|
554
|
+
* @enum {string}
|
|
555
|
+
*/
|
|
556
|
+
unique?: "no" | "local" | "global";
|
|
557
|
+
/** @description Regular expression slugs must match */
|
|
558
|
+
regularExpression?: string;
|
|
559
|
+
/**
|
|
560
|
+
* @description Custom error message when regular expression validation fails.
|
|
561
|
+
* Has no effect if `regularExpression` is not set.
|
|
562
|
+
*/
|
|
563
|
+
regularExpressionMessage?: string;
|
|
564
|
+
};
|
|
565
|
+
/** @description The definition of a component variant */
|
|
566
|
+
ComponentDefinitionVariant: {
|
|
567
|
+
id: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
|
568
|
+
/** @description Friendly name of the variant */
|
|
569
|
+
name: string;
|
|
570
|
+
};
|
|
571
|
+
/** @description Permission set for a component defintion */
|
|
572
|
+
ComponentDefinitionPermission: {
|
|
573
|
+
roleId: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
|
574
|
+
/**
|
|
575
|
+
* @description Permission type for this permission ComponentDefinition:
|
|
576
|
+
* read | write | create | delete
|
|
577
|
+
*
|
|
578
|
+
* @enum {string}
|
|
579
|
+
*/
|
|
580
|
+
permission: "read" | "write" | "create" | "delete";
|
|
581
|
+
/** @description State of the component that this permission applies to */
|
|
582
|
+
state: number;
|
|
583
|
+
};
|
|
584
|
+
/** @description Defines a component type that can live on a Composition */
|
|
585
|
+
ComponentDefinition: {
|
|
586
|
+
id: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
|
587
|
+
/** @description Friendly name of the component definition */
|
|
588
|
+
name: string;
|
|
589
|
+
/**
|
|
590
|
+
* @description Icon name or URL for the component definition (e.g. 'screen' or 'https://s3/my-component.jpg')
|
|
591
|
+
* @default screen
|
|
592
|
+
*/
|
|
593
|
+
icon?: string;
|
|
594
|
+
/**
|
|
595
|
+
* @description The public ID of the parameter whose value should be used to create a display title for this component in the UI.
|
|
596
|
+
* The parameter type must support being used as a title parameter for this to work.
|
|
597
|
+
*/
|
|
598
|
+
titleParameter?: string | null;
|
|
599
|
+
/**
|
|
600
|
+
* @description Whether this component type can be the root of a composition. If false, this component is only used within slots on other components.
|
|
601
|
+
* @default false
|
|
602
|
+
*/
|
|
603
|
+
canBeComposition?: boolean;
|
|
604
|
+
/** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries. */
|
|
605
|
+
parameters?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
|
|
606
|
+
/**
|
|
607
|
+
* @description if this component uses team permissions or custom permissions
|
|
608
|
+
* @default true
|
|
609
|
+
*/
|
|
610
|
+
useTeamPermissions?: boolean;
|
|
611
|
+
/** @description Custom role permissions for this component definition */
|
|
612
|
+
permissions?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
|
|
613
|
+
/** @description The named slots for this component; placement areas where arrays of other components can be added. */
|
|
614
|
+
slots?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlot"][];
|
|
615
|
+
slugSettings?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
|
616
|
+
/** @description Default component instance value */
|
|
617
|
+
defaults?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"] | null;
|
|
618
|
+
/** @description Named variants for this component; enables creation of visual variants that use the same parameter data */
|
|
619
|
+
variants?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionVariant"][];
|
|
620
|
+
/** @description Created date string for this definition (ignored for writes) */
|
|
621
|
+
created?: string;
|
|
622
|
+
/** @description Last modified date string for this definition (ignored for writes) */
|
|
623
|
+
updated?: string;
|
|
624
|
+
};
|
|
625
|
+
/** @description Defines an editable parameter on a component. */
|
|
626
|
+
ComponentParameter: {
|
|
627
|
+
/** @description The value of the parameter. Any JSON-serializable value is acceptable. */
|
|
628
|
+
value: unknown;
|
|
629
|
+
/** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
|
|
630
|
+
type: string;
|
|
631
|
+
connectedData?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
|
|
632
|
+
};
|
|
633
|
+
/**
|
|
634
|
+
* @deprecated
|
|
635
|
+
* @description Defines a connection to a data element on a data resource. Do not use.
|
|
636
|
+
*/
|
|
637
|
+
DataElementConnectionDefinition: {
|
|
638
|
+
/** @description A JSON Pointer expression that defines the data element to connect the parameter to. */
|
|
639
|
+
pointer: string;
|
|
640
|
+
/**
|
|
641
|
+
* @description The syntax used to select the data element to bind to
|
|
642
|
+
* @enum {string}
|
|
643
|
+
*/
|
|
644
|
+
syntax: "jptr";
|
|
645
|
+
/**
|
|
646
|
+
* @description Whether an error should occur if the connected data element cannot be resolved (i.e. a missing property in the data resource).
|
|
647
|
+
* In all cases the binding process will remove the parameter data for the unresolvable data element.
|
|
648
|
+
* When this is true, and the data element failed to bind, the warning entry returned from the binding process will be changed to an error entry.
|
|
649
|
+
*
|
|
650
|
+
* @default false
|
|
651
|
+
*/
|
|
652
|
+
required?: boolean;
|
|
653
|
+
};
|
|
654
|
+
/** @description Defines the shape of a component instance served by the composition API. */
|
|
655
|
+
ComponentInstance: {
|
|
656
|
+
/** @description Type of the component instance (public_id of its definition) */
|
|
657
|
+
type: string;
|
|
658
|
+
/** @description Component parameter values for the component instance */
|
|
659
|
+
parameters?: {
|
|
660
|
+
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
|
661
|
+
};
|
|
662
|
+
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
|
663
|
+
variant?: string;
|
|
664
|
+
/** @description Slots containing any child components */
|
|
665
|
+
slots?: {
|
|
666
|
+
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
|
|
667
|
+
};
|
|
668
|
+
/** @description Unique identifier of the component within the composition. This is not set unless specifically requested via `withComponentIDs` API parameter. */
|
|
669
|
+
_id?: string;
|
|
670
|
+
/** @description Indicates this component instance should be sourced from a pattern library pattern. */
|
|
671
|
+
_pattern?: string;
|
|
672
|
+
_dataResources?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
|
673
|
+
/**
|
|
674
|
+
* @deprecated
|
|
675
|
+
* @description Data definitions coming from a pattern resolved for this component. Merged with _data during resolution.
|
|
676
|
+
* Means nothing for PUTs; it will be ignored.
|
|
677
|
+
*/
|
|
678
|
+
_patternDataResources?: {
|
|
679
|
+
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
|
680
|
+
};
|
|
681
|
+
/**
|
|
682
|
+
* @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
|
683
|
+
* CYCLIC: A cyclic pattern graph was detected, which could not be resolved because it would cause an infinite loop.
|
|
684
|
+
* NOTFOUND: The pattern ID referenced could not be found. It may have been deleted, or not be published yet.
|
|
685
|
+
* Means nothing for PUTs; it will be ignored.
|
|
686
|
+
*
|
|
687
|
+
* @enum {string}
|
|
688
|
+
*/
|
|
689
|
+
_patternError?: "NOTFOUND" | "CYCLIC";
|
|
690
|
+
};
|
|
691
|
+
/** @description Defines the shape of the root component in a composition */
|
|
692
|
+
RootComponentInstance: {
|
|
693
|
+
/** @description Type of the component instance (public_id of its definition) */
|
|
694
|
+
type: string;
|
|
695
|
+
/** @description Component parameter values for the component instance */
|
|
696
|
+
parameters?: {
|
|
697
|
+
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
|
698
|
+
};
|
|
699
|
+
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
|
700
|
+
variant?: string;
|
|
701
|
+
/** @description Slots containing any child components */
|
|
702
|
+
slots?: {
|
|
703
|
+
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
|
|
704
|
+
};
|
|
705
|
+
/** @description The public UUID of the composition. */
|
|
706
|
+
_id: string;
|
|
707
|
+
/** @description Slug pattern of this component. */
|
|
708
|
+
_slug?: string | null;
|
|
709
|
+
/** @description Friendly name of this component. */
|
|
710
|
+
_name: string;
|
|
711
|
+
_dataResources?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
|
712
|
+
};
|
|
713
|
+
/**
|
|
714
|
+
* @deprecated
|
|
715
|
+
* @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
|
|
716
|
+
* These are created in the UI and shared across a whole project.
|
|
717
|
+
* NOTE: if you acquire a list of data sources or do not have manage permissions, you will receive "SECRET"
|
|
718
|
+
* for all header, parameter, and variable values to obscure the actual encrypted secret value.
|
|
719
|
+
*/
|
|
720
|
+
DataSource: {
|
|
721
|
+
/** @description Public ID of the data source */
|
|
722
|
+
id: string;
|
|
723
|
+
/** @description Display name of the data source */
|
|
724
|
+
displayName: string;
|
|
725
|
+
/** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
|
|
726
|
+
connectorType: string;
|
|
727
|
+
/** @description Base resource URL of the data source. No trailing slash. */
|
|
728
|
+
baseUrl: string;
|
|
729
|
+
headers?: {
|
|
730
|
+
[key: string]: string;
|
|
731
|
+
} | {
|
|
732
|
+
key: string;
|
|
733
|
+
value: string;
|
|
734
|
+
}[];
|
|
735
|
+
parameters?: {
|
|
736
|
+
[key: string]: string;
|
|
737
|
+
} | {
|
|
738
|
+
key: string;
|
|
739
|
+
value: string;
|
|
740
|
+
}[];
|
|
741
|
+
/** @description Variables needed to make calls to the data source */
|
|
742
|
+
variables?: {
|
|
743
|
+
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
|
744
|
+
};
|
|
745
|
+
/** @description Custom configuration specific to the data source being defined (used to maintain UI state for custom integrations) */
|
|
746
|
+
custom?: {
|
|
747
|
+
[key: string]: unknown;
|
|
748
|
+
};
|
|
749
|
+
};
|
|
750
|
+
/**
|
|
751
|
+
* @deprecated
|
|
752
|
+
* @description A specific type of data that a Data Source can provide (i.e. "Recipe", "Recipes List by Tag", "Yelp Reviews of My Restaurant"). These are created in the UI and shared a whole project.
|
|
753
|
+
*/
|
|
754
|
+
DataType: {
|
|
755
|
+
/** @description Public ID of the data type */
|
|
756
|
+
id: string;
|
|
757
|
+
/** @description Display name of the data type */
|
|
758
|
+
displayName: string;
|
|
759
|
+
/** @description Public ID of the associated data source */
|
|
760
|
+
dataSourceId: string;
|
|
761
|
+
/**
|
|
762
|
+
* @description A connector-specific archetype for this data type; used to select UI as well as perform any
|
|
763
|
+
* necessary post-processing on the response. e.g. 'cms-entry', 'cms-query'. Can be undefined if
|
|
764
|
+
* no special UI or processing is required.
|
|
765
|
+
*/
|
|
766
|
+
archetype?: string;
|
|
767
|
+
allowedOnComponents?: string[];
|
|
768
|
+
/** @description Resource path, appended to the data source's baseUrl (e.g. baseUrl = https://base.url, path = /v1/endpoint -> final URL https://base.url/v1/endpoint). Must have leading slash. */
|
|
769
|
+
path: string;
|
|
770
|
+
/** @description Time-to-live (in seconds) for the primary resource data cache. */
|
|
771
|
+
ttl?: number;
|
|
772
|
+
/** @description Long term data resource cache configuration. */
|
|
773
|
+
longTermCache?: {
|
|
774
|
+
/** @description A flag to turn the long term cache on. */
|
|
775
|
+
enabled: boolean;
|
|
776
|
+
/** @description Time-to-live (in hours) for the long term resource data cache. */
|
|
777
|
+
ttlInHours?: number;
|
|
778
|
+
};
|
|
779
|
+
/** @description A key for the resource data cache purging. */
|
|
780
|
+
purgeKey?: string;
|
|
781
|
+
/** @description URL to a custom badge icon for the Uniform dashboard for this data type. If not set falls back to the data connector or integration icons. */
|
|
782
|
+
badgeIconUrl?: string;
|
|
783
|
+
/** @description HTTP headers to pass with requests to the data type. Merged with headers from the data source, overriding identical keys. */
|
|
784
|
+
headers?: {
|
|
785
|
+
[key: string]: string;
|
|
786
|
+
} | {
|
|
787
|
+
key: string;
|
|
788
|
+
value: string;
|
|
789
|
+
}[];
|
|
790
|
+
/** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys. */
|
|
791
|
+
parameters?: {
|
|
792
|
+
[key: string]: string;
|
|
793
|
+
} | {
|
|
794
|
+
key: string;
|
|
795
|
+
value: string;
|
|
796
|
+
}[];
|
|
797
|
+
/** @description Body to pass with requests to the data type (ignored unless method is POST) */
|
|
798
|
+
body?: string;
|
|
799
|
+
/**
|
|
800
|
+
* @description HTTP method to use with requests to the data type.
|
|
801
|
+
* @default GET
|
|
802
|
+
* @enum {string}
|
|
803
|
+
*/
|
|
804
|
+
method: "GET" | "POST" | "HEAD";
|
|
805
|
+
/** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys. */
|
|
806
|
+
variables?: {
|
|
807
|
+
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
|
808
|
+
};
|
|
809
|
+
/** @description Custom configuration specific to the data source being defined */
|
|
810
|
+
custom?: {
|
|
811
|
+
[key: string]: unknown;
|
|
812
|
+
};
|
|
813
|
+
};
|
|
814
|
+
/**
|
|
815
|
+
* @deprecated
|
|
816
|
+
* @description Defines the shape of a data variable on a Data Source or Data Type
|
|
817
|
+
*/
|
|
818
|
+
DataVariableDefinition: {
|
|
819
|
+
/** @description Display name of the data variable */
|
|
820
|
+
displayName?: string;
|
|
821
|
+
/** @description Explanatory text that is provided to the data resource editor to explain what this variable does. */
|
|
822
|
+
helpText?: string;
|
|
823
|
+
/**
|
|
824
|
+
* @description Type of the data variable. Optionally used as a point of reference for custom integrations to decide how to render an editor for a variable.
|
|
825
|
+
* @default text
|
|
826
|
+
*/
|
|
827
|
+
type?: string;
|
|
828
|
+
/** @description Default value of the data variable */
|
|
829
|
+
default: string;
|
|
830
|
+
/** @description Sets the order of the variable when displayed in a list with other variables. If not set, the order defaults to alphabetical with any explicitly set orders first in the list. */
|
|
831
|
+
order?: number;
|
|
832
|
+
};
|
|
833
|
+
/**
|
|
834
|
+
* @deprecated
|
|
835
|
+
* @description Data definitions attached to this component. The property name is the key of the data in the data document.
|
|
836
|
+
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
|
837
|
+
*/
|
|
838
|
+
DataResourceDefinitions: {
|
|
839
|
+
[key: string]: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
|
840
|
+
};
|
|
841
|
+
/**
|
|
842
|
+
* @deprecated
|
|
843
|
+
* @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters
|
|
844
|
+
*/
|
|
845
|
+
DataResourceDefinition: {
|
|
846
|
+
/** @description Public ID of the data type that provides this data */
|
|
847
|
+
type: string;
|
|
848
|
+
/** @description Whether this data is a pattern parameter that has to be overridden when a pattern is referenced on another composition. If this is not a pattern composition, this has no meaning and should not be used. If unspecified, the default is false. */
|
|
849
|
+
isPatternParameter?: boolean;
|
|
850
|
+
variables?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
|
851
|
+
};
|
|
852
|
+
/**
|
|
853
|
+
* @deprecated
|
|
854
|
+
* @description Variable values for a data resource.
|
|
855
|
+
*/
|
|
856
|
+
DataResourceVariables: {
|
|
857
|
+
[key: string]: string;
|
|
858
|
+
};
|
|
859
|
+
};
|
|
860
|
+
};
|
|
861
|
+
operations: {};
|
|
870
862
|
};
|
|
871
863
|
}
|
|
872
864
|
|
|
@@ -1453,21 +1445,10 @@ interface external$4 {
|
|
|
1453
1445
|
};
|
|
1454
1446
|
/**
|
|
1455
1447
|
* @deprecated
|
|
1456
|
-
* @description
|
|
1457
|
-
|
|
1458
|
-
|
|
1459
|
-
|
|
1460
|
-
id: string;
|
|
1461
|
-
/** @description Display name of the data source */
|
|
1462
|
-
displayName: string;
|
|
1463
|
-
/** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
|
|
1464
|
-
connectorType: string;
|
|
1465
|
-
/** @description Base resource URL of the data source. No trailing slash. */
|
|
1466
|
-
baseUrl: string;
|
|
1467
|
-
};
|
|
1468
|
-
/**
|
|
1469
|
-
* @deprecated
|
|
1470
|
-
* @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset"). These are created in the UI and shared across a whole project.
|
|
1448
|
+
* @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
|
|
1449
|
+
* These are created in the UI and shared across a whole project.
|
|
1450
|
+
* NOTE: if you acquire a list of data sources or do not have manage permissions, you will receive "SECRET"
|
|
1451
|
+
* for all header, parameter, and variable values to obscure the actual encrypted secret value.
|
|
1471
1452
|
*/
|
|
1472
1453
|
DataSource: {
|
|
1473
1454
|
/** @description Public ID of the data source */
|
|
@@ -1519,8 +1500,15 @@ interface external$4 {
|
|
|
1519
1500
|
allowedOnComponents?: string[];
|
|
1520
1501
|
/** @description Resource path, appended to the data source's baseUrl (e.g. baseUrl = https://base.url, path = /v1/endpoint -> final URL https://base.url/v1/endpoint). Must have leading slash. */
|
|
1521
1502
|
path: string;
|
|
1522
|
-
/** @description Time-to-live for the resource data cache. */
|
|
1503
|
+
/** @description Time-to-live (in seconds) for the primary resource data cache. */
|
|
1523
1504
|
ttl?: number;
|
|
1505
|
+
/** @description Long term data resource cache configuration. */
|
|
1506
|
+
longTermCache?: {
|
|
1507
|
+
/** @description A flag to turn the long term cache on. */
|
|
1508
|
+
enabled: boolean;
|
|
1509
|
+
/** @description Time-to-live (in hours) for the long term resource data cache. */
|
|
1510
|
+
ttlInHours?: number;
|
|
1511
|
+
};
|
|
1524
1512
|
/** @description A key for the resource data cache purging. */
|
|
1525
1513
|
purgeKey?: string;
|
|
1526
1514
|
/** @description URL to a custom badge icon for the Uniform dashboard for this data type. If not set falls back to the data connector or integration icons. */
|
|
@@ -1630,6 +1618,7 @@ interface components {
|
|
|
1630
1618
|
total: number;
|
|
1631
1619
|
retryCount: number;
|
|
1632
1620
|
retryDelay: number;
|
|
1621
|
+
sourceCache?: string;
|
|
1633
1622
|
};
|
|
1634
1623
|
data: unknown;
|
|
1635
1624
|
};
|
|
@@ -1973,21 +1962,10 @@ interface external$3 {
|
|
|
1973
1962
|
};
|
|
1974
1963
|
/**
|
|
1975
1964
|
* @deprecated
|
|
1976
|
-
* @description
|
|
1977
|
-
|
|
1978
|
-
|
|
1979
|
-
|
|
1980
|
-
id: string;
|
|
1981
|
-
/** @description Display name of the data source */
|
|
1982
|
-
displayName: string;
|
|
1983
|
-
/** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
|
|
1984
|
-
connectorType: string;
|
|
1985
|
-
/** @description Base resource URL of the data source. No trailing slash. */
|
|
1986
|
-
baseUrl: string;
|
|
1987
|
-
};
|
|
1988
|
-
/**
|
|
1989
|
-
* @deprecated
|
|
1990
|
-
* @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset"). These are created in the UI and shared across a whole project.
|
|
1965
|
+
* @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
|
|
1966
|
+
* These are created in the UI and shared across a whole project.
|
|
1967
|
+
* NOTE: if you acquire a list of data sources or do not have manage permissions, you will receive "SECRET"
|
|
1968
|
+
* for all header, parameter, and variable values to obscure the actual encrypted secret value.
|
|
1991
1969
|
*/
|
|
1992
1970
|
DataSource: {
|
|
1993
1971
|
/** @description Public ID of the data source */
|
|
@@ -2039,8 +2017,15 @@ interface external$3 {
|
|
|
2039
2017
|
allowedOnComponents?: string[];
|
|
2040
2018
|
/** @description Resource path, appended to the data source's baseUrl (e.g. baseUrl = https://base.url, path = /v1/endpoint -> final URL https://base.url/v1/endpoint). Must have leading slash. */
|
|
2041
2019
|
path: string;
|
|
2042
|
-
/** @description Time-to-live for the resource data cache. */
|
|
2020
|
+
/** @description Time-to-live (in seconds) for the primary resource data cache. */
|
|
2043
2021
|
ttl?: number;
|
|
2022
|
+
/** @description Long term data resource cache configuration. */
|
|
2023
|
+
longTermCache?: {
|
|
2024
|
+
/** @description A flag to turn the long term cache on. */
|
|
2025
|
+
enabled: boolean;
|
|
2026
|
+
/** @description Time-to-live (in hours) for the long term resource data cache. */
|
|
2027
|
+
ttlInHours?: number;
|
|
2028
|
+
};
|
|
2044
2029
|
/** @description A key for the resource data cache purging. */
|
|
2045
2030
|
purgeKey?: string;
|
|
2046
2031
|
/** @description URL to a custom badge icon for the Uniform dashboard for this data type. If not set falls back to the data connector or integration icons. */
|
|
@@ -2559,10 +2544,11 @@ declare type CompositionGetValidResponses = CompositionGetResponse | Composition
|
|
|
2559
2544
|
* Do not make direct changes to the file.
|
|
2560
2545
|
*/
|
|
2561
2546
|
interface paths$2 {
|
|
2562
|
-
"/api/v1/data-
|
|
2547
|
+
"/api/v1/data-source": {
|
|
2563
2548
|
get: {
|
|
2564
2549
|
parameters: {
|
|
2565
2550
|
query: {
|
|
2551
|
+
dataSourceId: string;
|
|
2566
2552
|
projectId: string;
|
|
2567
2553
|
};
|
|
2568
2554
|
};
|
|
@@ -2571,7 +2557,7 @@ interface paths$2 {
|
|
|
2571
2557
|
200: {
|
|
2572
2558
|
content: {
|
|
2573
2559
|
"application/json": {
|
|
2574
|
-
|
|
2560
|
+
result: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataSource"];
|
|
2575
2561
|
};
|
|
2576
2562
|
};
|
|
2577
2563
|
};
|
|
@@ -2595,9 +2581,11 @@ interface paths$2 {
|
|
|
2595
2581
|
requestBody: {
|
|
2596
2582
|
content: {
|
|
2597
2583
|
"application/json": {
|
|
2598
|
-
data: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
|
2584
|
+
data: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataSource"];
|
|
2599
2585
|
/** Format: uuid */
|
|
2600
2586
|
projectId: string;
|
|
2587
|
+
/** Format: uuid */
|
|
2588
|
+
integrationId: string;
|
|
2601
2589
|
};
|
|
2602
2590
|
};
|
|
2603
2591
|
};
|
|
@@ -2615,7 +2603,7 @@ interface paths$2 {
|
|
|
2615
2603
|
requestBody: {
|
|
2616
2604
|
content: {
|
|
2617
2605
|
"application/json": {
|
|
2618
|
-
|
|
2606
|
+
dataSourceId: string;
|
|
2619
2607
|
/** Format: uuid */
|
|
2620
2608
|
projectId: string;
|
|
2621
2609
|
};
|
|
@@ -2881,21 +2869,10 @@ interface external$2 {
|
|
|
2881
2869
|
};
|
|
2882
2870
|
/**
|
|
2883
2871
|
* @deprecated
|
|
2884
|
-
* @description
|
|
2885
|
-
|
|
2886
|
-
|
|
2887
|
-
|
|
2888
|
-
id: string;
|
|
2889
|
-
/** @description Display name of the data source */
|
|
2890
|
-
displayName: string;
|
|
2891
|
-
/** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
|
|
2892
|
-
connectorType: string;
|
|
2893
|
-
/** @description Base resource URL of the data source. No trailing slash. */
|
|
2894
|
-
baseUrl: string;
|
|
2895
|
-
};
|
|
2896
|
-
/**
|
|
2897
|
-
* @deprecated
|
|
2898
|
-
* @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset"). These are created in the UI and shared across a whole project.
|
|
2872
|
+
* @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
|
|
2873
|
+
* These are created in the UI and shared across a whole project.
|
|
2874
|
+
* NOTE: if you acquire a list of data sources or do not have manage permissions, you will receive "SECRET"
|
|
2875
|
+
* for all header, parameter, and variable values to obscure the actual encrypted secret value.
|
|
2899
2876
|
*/
|
|
2900
2877
|
DataSource: {
|
|
2901
2878
|
/** @description Public ID of the data source */
|
|
@@ -2947,8 +2924,15 @@ interface external$2 {
|
|
|
2947
2924
|
allowedOnComponents?: string[];
|
|
2948
2925
|
/** @description Resource path, appended to the data source's baseUrl (e.g. baseUrl = https://base.url, path = /v1/endpoint -> final URL https://base.url/v1/endpoint). Must have leading slash. */
|
|
2949
2926
|
path: string;
|
|
2950
|
-
/** @description Time-to-live for the resource data cache. */
|
|
2927
|
+
/** @description Time-to-live (in seconds) for the primary resource data cache. */
|
|
2951
2928
|
ttl?: number;
|
|
2929
|
+
/** @description Long term data resource cache configuration. */
|
|
2930
|
+
longTermCache?: {
|
|
2931
|
+
/** @description A flag to turn the long term cache on. */
|
|
2932
|
+
enabled: boolean;
|
|
2933
|
+
/** @description Time-to-live (in hours) for the long term resource data cache. */
|
|
2934
|
+
ttlInHours?: number;
|
|
2935
|
+
};
|
|
2952
2936
|
/** @description A key for the resource data cache purging. */
|
|
2953
2937
|
purgeKey?: string;
|
|
2954
2938
|
/** @description URL to a custom badge icon for the Uniform dashboard for this data type. If not set falls back to the data connector or integration icons. */
|
|
@@ -3040,20 +3024,24 @@ interface external$2 {
|
|
|
3040
3024
|
* Do not make direct changes to the file.
|
|
3041
3025
|
*/
|
|
3042
3026
|
interface paths$1 {
|
|
3043
|
-
"/api/v1/data-
|
|
3027
|
+
"/api/v1/data-sources": {
|
|
3044
3028
|
get: {
|
|
3045
3029
|
parameters: {
|
|
3046
3030
|
query: {
|
|
3047
|
-
dataSourceId: string;
|
|
3048
3031
|
projectId: string;
|
|
3049
3032
|
};
|
|
3050
3033
|
};
|
|
3051
3034
|
responses: {
|
|
3052
|
-
/**
|
|
3035
|
+
/**
|
|
3036
|
+
* Gets a list of data sources.
|
|
3037
|
+
* Note that all parameters, headers, and variables will have the value 'SECRET', as this endpoint
|
|
3038
|
+
* requires minimal permissions. To decrypt secrets, you must be an admin or manage-data-sources privileged
|
|
3039
|
+
* user, and fetch using the `data-source` endpoint for each data source.
|
|
3040
|
+
*/
|
|
3053
3041
|
200: {
|
|
3054
3042
|
content: {
|
|
3055
3043
|
"application/json": {
|
|
3056
|
-
|
|
3044
|
+
results: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataSource"][];
|
|
3057
3045
|
};
|
|
3058
3046
|
};
|
|
3059
3047
|
};
|
|
@@ -3064,48 +3052,6 @@ interface paths$1 {
|
|
|
3064
3052
|
500: external$1["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
|
3065
3053
|
};
|
|
3066
3054
|
};
|
|
3067
|
-
put: {
|
|
3068
|
-
responses: {
|
|
3069
|
-
/** OK */
|
|
3070
|
-
204: never;
|
|
3071
|
-
400: external$1["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
|
3072
|
-
401: external$1["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
|
3073
|
-
403: external$1["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
|
3074
|
-
429: external$1["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
|
3075
|
-
500: external$1["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
|
3076
|
-
};
|
|
3077
|
-
requestBody: {
|
|
3078
|
-
content: {
|
|
3079
|
-
"application/json": {
|
|
3080
|
-
data: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataSource"];
|
|
3081
|
-
/** Format: uuid */
|
|
3082
|
-
projectId: string;
|
|
3083
|
-
/** Format: uuid */
|
|
3084
|
-
integrationId: string;
|
|
3085
|
-
};
|
|
3086
|
-
};
|
|
3087
|
-
};
|
|
3088
|
-
};
|
|
3089
|
-
delete: {
|
|
3090
|
-
responses: {
|
|
3091
|
-
/** OK */
|
|
3092
|
-
204: never;
|
|
3093
|
-
400: external$1["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
|
3094
|
-
401: external$1["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
|
3095
|
-
403: external$1["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
|
3096
|
-
429: external$1["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
|
3097
|
-
500: external$1["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
|
3098
|
-
};
|
|
3099
|
-
requestBody: {
|
|
3100
|
-
content: {
|
|
3101
|
-
"application/json": {
|
|
3102
|
-
dataSourceId: string;
|
|
3103
|
-
/** Format: uuid */
|
|
3104
|
-
projectId: string;
|
|
3105
|
-
};
|
|
3106
|
-
};
|
|
3107
|
-
};
|
|
3108
|
-
};
|
|
3109
3055
|
};
|
|
3110
3056
|
}
|
|
3111
3057
|
interface external$1 {
|
|
@@ -3365,21 +3311,10 @@ interface external$1 {
|
|
|
3365
3311
|
};
|
|
3366
3312
|
/**
|
|
3367
3313
|
* @deprecated
|
|
3368
|
-
* @description
|
|
3369
|
-
|
|
3370
|
-
|
|
3371
|
-
|
|
3372
|
-
id: string;
|
|
3373
|
-
/** @description Display name of the data source */
|
|
3374
|
-
displayName: string;
|
|
3375
|
-
/** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
|
|
3376
|
-
connectorType: string;
|
|
3377
|
-
/** @description Base resource URL of the data source. No trailing slash. */
|
|
3378
|
-
baseUrl: string;
|
|
3379
|
-
};
|
|
3380
|
-
/**
|
|
3381
|
-
* @deprecated
|
|
3382
|
-
* @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset"). These are created in the UI and shared across a whole project.
|
|
3314
|
+
* @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
|
|
3315
|
+
* These are created in the UI and shared across a whole project.
|
|
3316
|
+
* NOTE: if you acquire a list of data sources or do not have manage permissions, you will receive "SECRET"
|
|
3317
|
+
* for all header, parameter, and variable values to obscure the actual encrypted secret value.
|
|
3383
3318
|
*/
|
|
3384
3319
|
DataSource: {
|
|
3385
3320
|
/** @description Public ID of the data source */
|
|
@@ -3431,8 +3366,15 @@ interface external$1 {
|
|
|
3431
3366
|
allowedOnComponents?: string[];
|
|
3432
3367
|
/** @description Resource path, appended to the data source's baseUrl (e.g. baseUrl = https://base.url, path = /v1/endpoint -> final URL https://base.url/v1/endpoint). Must have leading slash. */
|
|
3433
3368
|
path: string;
|
|
3434
|
-
/** @description Time-to-live for the resource data cache. */
|
|
3369
|
+
/** @description Time-to-live (in seconds) for the primary resource data cache. */
|
|
3435
3370
|
ttl?: number;
|
|
3371
|
+
/** @description Long term data resource cache configuration. */
|
|
3372
|
+
longTermCache?: {
|
|
3373
|
+
/** @description A flag to turn the long term cache on. */
|
|
3374
|
+
enabled: boolean;
|
|
3375
|
+
/** @description Time-to-live (in hours) for the long term resource data cache. */
|
|
3376
|
+
ttlInHours?: number;
|
|
3377
|
+
};
|
|
3436
3378
|
/** @description A key for the resource data cache purging. */
|
|
3437
3379
|
purgeKey?: string;
|
|
3438
3380
|
/** @description URL to a custom badge icon for the Uniform dashboard for this data type. If not set falls back to the data connector or integration icons. */
|
|
@@ -3524,7 +3466,7 @@ interface external$1 {
|
|
|
3524
3466
|
* Do not make direct changes to the file.
|
|
3525
3467
|
*/
|
|
3526
3468
|
interface paths {
|
|
3527
|
-
"/api/v1/data-
|
|
3469
|
+
"/api/v1/data-types": {
|
|
3528
3470
|
get: {
|
|
3529
3471
|
parameters: {
|
|
3530
3472
|
query: {
|
|
@@ -3536,7 +3478,7 @@ interface paths {
|
|
|
3536
3478
|
200: {
|
|
3537
3479
|
content: {
|
|
3538
3480
|
"application/json": {
|
|
3539
|
-
results: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
|
3481
|
+
results: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataType"][];
|
|
3540
3482
|
};
|
|
3541
3483
|
};
|
|
3542
3484
|
};
|
|
@@ -3547,6 +3489,46 @@ interface paths {
|
|
|
3547
3489
|
500: external["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
|
3548
3490
|
};
|
|
3549
3491
|
};
|
|
3492
|
+
put: {
|
|
3493
|
+
responses: {
|
|
3494
|
+
/** OK */
|
|
3495
|
+
204: never;
|
|
3496
|
+
400: external["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
|
3497
|
+
401: external["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
|
3498
|
+
403: external["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
|
3499
|
+
429: external["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
|
3500
|
+
500: external["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
|
3501
|
+
};
|
|
3502
|
+
requestBody: {
|
|
3503
|
+
content: {
|
|
3504
|
+
"application/json": {
|
|
3505
|
+
data: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataType"];
|
|
3506
|
+
/** Format: uuid */
|
|
3507
|
+
projectId: string;
|
|
3508
|
+
};
|
|
3509
|
+
};
|
|
3510
|
+
};
|
|
3511
|
+
};
|
|
3512
|
+
delete: {
|
|
3513
|
+
responses: {
|
|
3514
|
+
/** OK */
|
|
3515
|
+
204: never;
|
|
3516
|
+
400: external["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
|
3517
|
+
401: external["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
|
3518
|
+
403: external["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
|
3519
|
+
429: external["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
|
3520
|
+
500: external["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
|
3521
|
+
};
|
|
3522
|
+
requestBody: {
|
|
3523
|
+
content: {
|
|
3524
|
+
"application/json": {
|
|
3525
|
+
typeId: string;
|
|
3526
|
+
/** Format: uuid */
|
|
3527
|
+
projectId: string;
|
|
3528
|
+
};
|
|
3529
|
+
};
|
|
3530
|
+
};
|
|
3531
|
+
};
|
|
3550
3532
|
};
|
|
3551
3533
|
}
|
|
3552
3534
|
interface external {
|
|
@@ -3806,21 +3788,10 @@ interface external {
|
|
|
3806
3788
|
};
|
|
3807
3789
|
/**
|
|
3808
3790
|
* @deprecated
|
|
3809
|
-
* @description
|
|
3810
|
-
|
|
3811
|
-
|
|
3812
|
-
|
|
3813
|
-
id: string;
|
|
3814
|
-
/** @description Display name of the data source */
|
|
3815
|
-
displayName: string;
|
|
3816
|
-
/** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
|
|
3817
|
-
connectorType: string;
|
|
3818
|
-
/** @description Base resource URL of the data source. No trailing slash. */
|
|
3819
|
-
baseUrl: string;
|
|
3820
|
-
};
|
|
3821
|
-
/**
|
|
3822
|
-
* @deprecated
|
|
3823
|
-
* @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset"). These are created in the UI and shared across a whole project.
|
|
3791
|
+
* @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
|
|
3792
|
+
* These are created in the UI and shared across a whole project.
|
|
3793
|
+
* NOTE: if you acquire a list of data sources or do not have manage permissions, you will receive "SECRET"
|
|
3794
|
+
* for all header, parameter, and variable values to obscure the actual encrypted secret value.
|
|
3824
3795
|
*/
|
|
3825
3796
|
DataSource: {
|
|
3826
3797
|
/** @description Public ID of the data source */
|
|
@@ -3872,8 +3843,15 @@ interface external {
|
|
|
3872
3843
|
allowedOnComponents?: string[];
|
|
3873
3844
|
/** @description Resource path, appended to the data source's baseUrl (e.g. baseUrl = https://base.url, path = /v1/endpoint -> final URL https://base.url/v1/endpoint). Must have leading slash. */
|
|
3874
3845
|
path: string;
|
|
3875
|
-
/** @description Time-to-live for the resource data cache. */
|
|
3846
|
+
/** @description Time-to-live (in seconds) for the primary resource data cache. */
|
|
3876
3847
|
ttl?: number;
|
|
3848
|
+
/** @description Long term data resource cache configuration. */
|
|
3849
|
+
longTermCache?: {
|
|
3850
|
+
/** @description A flag to turn the long term cache on. */
|
|
3851
|
+
enabled: boolean;
|
|
3852
|
+
/** @description Time-to-live (in hours) for the long term resource data cache. */
|
|
3853
|
+
ttlInHours?: number;
|
|
3854
|
+
};
|
|
3877
3855
|
/** @description A key for the resource data cache purging. */
|
|
3878
3856
|
purgeKey?: string;
|
|
3879
3857
|
/** @description URL to a custom badge icon for the Uniform dashboard for this data type. If not set falls back to the data connector or integration icons. */
|
|
@@ -3960,9 +3938,9 @@ interface external {
|
|
|
3960
3938
|
};
|
|
3961
3939
|
}
|
|
3962
3940
|
|
|
3963
|
-
declare type DataTypeApi = paths
|
|
3964
|
-
declare type DataSourcesApi = paths['/api/v1/data-sources'];
|
|
3965
|
-
declare type DataSourceApi = paths$
|
|
3941
|
+
declare type DataTypeApi = paths['/api/v1/data-types'];
|
|
3942
|
+
declare type DataSourcesApi = paths$1['/api/v1/data-sources'];
|
|
3943
|
+
declare type DataSourceApi = paths$2['/api/v1/data-source'];
|
|
3966
3944
|
/** Query parameter options for GET /api/v1/data-types */
|
|
3967
3945
|
declare type DataTypeGetParameters = DataTypeApi['get']['parameters']['query'];
|
|
3968
3946
|
/** The GET response from /api/v1/data-types */
|
|
@@ -3985,7 +3963,6 @@ declare type DataSourcePutParameters = DataSourceApi['put']['requestBody']['cont
|
|
|
3985
3963
|
declare type DataSourceDeleteParameters = DataSourceApi['delete']['requestBody']['content']['application/json'];
|
|
3986
3964
|
declare type DataType = components$2['schemas']['DataType'];
|
|
3987
3965
|
declare type DataSource = components$2['schemas']['DataSource'];
|
|
3988
|
-
declare type DataSourceInfo = components$2['schemas']['DataSourceInfo'];
|
|
3989
3966
|
declare type DataVariableDefinition = components$2['schemas']['DataVariableDefinition'];
|
|
3990
3967
|
|
|
3991
3968
|
/**
|
|
@@ -4013,4 +3990,4 @@ declare global {
|
|
|
4013
3990
|
*/
|
|
4014
3991
|
declare function createEventBus(): Promise<PreviewEventBus | undefined>;
|
|
4015
3992
|
|
|
4016
|
-
export {
|
|
3993
|
+
export { DataResourceDefinitions as $, ChannelSubscription as A, createEventBus as B, CompositionGetParameters as C, DataResolutionOptionNegative as D, ComponentDefinitionGetResponse as E, ComponentDefinitionAPIResponse as F, ComponentDefinitionAPIPutRequest as G, ComponentDefinitionAPIDeleteRequest as H, ComponentDefinitionListAPIOptions as I, ComponentDefinitionParameter as J, ComponentDefinitionVariant as K, ComponentDefinitionSlugSettings as L, ComponentDefinitionSlot as M, ComponentDefinitionPermission as N, ComponentDefinition as O, PreviewEventBus as P, CreatingComponentDefinition as Q, RootComponentInstance as R, CompositionGetOrderBy as S, CompositionUIStatus as T, CompositionGetListResponse as U, CompositionAPIResponse as V, CompositionAPIDeleteRequest as W, CompositionListAPIResponse as X, CompositionAPIOptions as Y, DataElementConnectionDefinition as Z, DataResourceVariables as _, CompositionGetByNodePathParameters as a, DataResourceDefinition as a0, CanvasDefinitions as a1, CompositionIssue as a2, CompositionPatternIssue as a3, DataElementBindingIssue as a4, DataResourceIssue as a5, DataResourceVariableIssue as a6, DataResolutionConfigIssue as a7, CompositionDataDiagnostic as a8, DataSourceGetResponse as a9, DataSourcesGetResponse as aa, DataType as ab, DataSource as ac, DataVariableDefinition as ad, CompositionGetResponse as b, DataResolutionOptionPositive as c, DataResolutionParameters as d, CompositionResolvedGetResponse as e, CompositionGetValidResponses as f, DataResolutionOption as g, CompositionGetByNodeIdParameters as h, CompositionGetBySlugParameters as i, CompositionGetByIdParameters as j, CompositionPutParameters as k, CompositionDeleteParameters as l, ComponentDefinitionGetParameters as m, ComponentDefinitionPutParameters as n, ComponentDefinitionDeleteParameters as o, ComponentInstance as p, ComponentParameter as q, components as r, DataSourceGetParameters as s, DataSourcesGetParameters as t, DataSourcePutParameters as u, DataSourceDeleteParameters as v, DataTypeGetParameters as w, DataTypeGetResponse as x, DataTypePutParameters as y, DataTypeDeleteParameters as z };
|