@uniformdev/assets 20.50.2-alpha.146 → 20.50.2-alpha.167
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.mts +221 -173
- package/dist/index.d.ts +221 -173
- package/dist/index.esm.js +24 -2
- package/dist/index.js +27 -5
- package/dist/index.mjs +24 -2
- package/package.json +4 -4
package/dist/index.d.mts
CHANGED
|
@@ -16,22 +16,25 @@ interface components$1 {
|
|
|
16
16
|
guidance?: string;
|
|
17
17
|
/** @description Type name of the parameter (provided by a Uniform integration) */
|
|
18
18
|
type: string;
|
|
19
|
-
/**
|
|
19
|
+
/**
|
|
20
|
+
* @description If true, this property can have locale-specific values. If false or not defined,
|
|
20
21
|
* this property will have a single value that is shared for all locales
|
|
21
|
-
|
|
22
|
+
*/
|
|
22
23
|
localizable?: boolean;
|
|
23
|
-
/**
|
|
24
|
+
/**
|
|
25
|
+
* @description When `localizable` is true, this property controls the default localizability of the property.
|
|
24
26
|
* true - when the property has no existing value, it will be in 'single value' mode and not store locale specific values
|
|
25
27
|
* false/undefined - when the property has no existing value, it will store separate values for each enabled locale
|
|
26
28
|
*
|
|
27
29
|
* If `localized` is false, this has no effect.
|
|
28
|
-
|
|
30
|
+
*/
|
|
29
31
|
notLocalizedByDefault?: boolean;
|
|
30
|
-
/**
|
|
32
|
+
/**
|
|
33
|
+
* @description Enables creating additional conditional values for the parameter based on criteria such as dynamic inputs.
|
|
31
34
|
* When combined with a localized value, each locale has independent conditional values.
|
|
32
35
|
*
|
|
33
36
|
* When not defined, conditional values are not allowed.
|
|
34
|
-
|
|
37
|
+
*/
|
|
35
38
|
allowConditionalValues?: boolean;
|
|
36
39
|
/** @description The configuration object for the type (type-specific) */
|
|
37
40
|
typeConfig?: unknown;
|
|
@@ -46,17 +49,18 @@ interface components$1 {
|
|
|
46
49
|
/**
|
|
47
50
|
* @description Whether this slot inherits its allowed components from the parent slot it lives in. If true, `allowedComponents` is irrelevant.
|
|
48
51
|
* If `allowAllComponents` is true, this value is ignored
|
|
49
|
-
*
|
|
50
52
|
* @default false
|
|
51
53
|
*/
|
|
52
54
|
inheritAllowedComponents: boolean;
|
|
53
|
-
/**
|
|
55
|
+
/**
|
|
56
|
+
* @description When false or not defined, only components in `allowedComponents` may be added to this slot - and if `allowedComponents` is empty, nothing can be added.
|
|
54
57
|
* When true, every component and pattern that is defined may be added to this slot regardless of any other setting including `inheritAllowedComponents`
|
|
55
|
-
|
|
58
|
+
*/
|
|
56
59
|
allowAllComponents?: boolean;
|
|
57
|
-
/**
|
|
60
|
+
/**
|
|
61
|
+
* @description When not defined, or false: all patterns for components listed in `allowedComponents` are automatically allowed in the slot.
|
|
58
62
|
* When true: patterns for components listed in `allowedComponents` are not allowed in the slot unless explicitly added to `allowedComponents` as `$p:<patternid>`
|
|
59
|
-
|
|
63
|
+
*/
|
|
60
64
|
patternsInAllowedComponents?: boolean;
|
|
61
65
|
/** @description Minimum valid number of components in this slot */
|
|
62
66
|
minComponents?: number;
|
|
@@ -70,7 +74,6 @@ interface components$1 {
|
|
|
70
74
|
* no: slug is optional
|
|
71
75
|
* yes: slug is required
|
|
72
76
|
* disabled: slug is disabled and will not be shown in the editor
|
|
73
|
-
*
|
|
74
77
|
* @default no
|
|
75
78
|
* @enum {string}
|
|
76
79
|
*/
|
|
@@ -80,15 +83,15 @@ interface components$1 {
|
|
|
80
83
|
* no = no unique constraint
|
|
81
84
|
* local = must be unique within this component type
|
|
82
85
|
* global = must be unique across all component types
|
|
83
|
-
*
|
|
84
86
|
* @enum {string}
|
|
85
87
|
*/
|
|
86
88
|
unique?: "no" | "local" | "global";
|
|
87
89
|
/** @description Regular expression slugs must match */
|
|
88
90
|
regularExpression?: string;
|
|
89
|
-
/**
|
|
91
|
+
/**
|
|
92
|
+
* @description Custom error message when regular expression validation fails.
|
|
90
93
|
* Has no effect if `regularExpression` is not set
|
|
91
|
-
|
|
94
|
+
*/
|
|
92
95
|
regularExpressionMessage?: string;
|
|
93
96
|
};
|
|
94
97
|
/** @description The definition of a component variant */
|
|
@@ -103,7 +106,6 @@ interface components$1 {
|
|
|
103
106
|
/**
|
|
104
107
|
* @description Permission type for this permission ComponentDefinition:
|
|
105
108
|
* read | write | create | delete
|
|
106
|
-
*
|
|
107
109
|
* @enum {string}
|
|
108
110
|
*/
|
|
109
111
|
permission: "read" | "write" | "create" | "delete";
|
|
@@ -123,13 +125,11 @@ interface components$1 {
|
|
|
123
125
|
/**
|
|
124
126
|
* @description The public ID of the parameter whose value should be used to create a display title for this component in the UI.
|
|
125
127
|
* The parameter type must support being used as a title parameter for this to work
|
|
126
|
-
*
|
|
127
128
|
* @default null
|
|
128
129
|
*/
|
|
129
130
|
titleParameter?: string | null;
|
|
130
131
|
/**
|
|
131
132
|
* @description The public ID of the parameter whose value should be used as a thumbnail for compositions of this component in the UI
|
|
132
|
-
*
|
|
133
133
|
* @default null
|
|
134
134
|
*/
|
|
135
135
|
thumbnailParameter?: string | null;
|
|
@@ -179,13 +179,13 @@ interface components$1 {
|
|
|
179
179
|
id: components$1["schemas"]["PublicIdProperty"];
|
|
180
180
|
/** @description Friendly name of the content type */
|
|
181
181
|
name: string;
|
|
182
|
-
/**
|
|
182
|
+
/**
|
|
183
|
+
* @description The public ID of the field whose value should be used to create a display name for entries of this content type in the UI.
|
|
183
184
|
* The field type must support being used as an entry name for this to work
|
|
184
|
-
|
|
185
|
+
*/
|
|
185
186
|
entryName?: string | null;
|
|
186
187
|
/**
|
|
187
188
|
* @description The public ID of the field whose value should be used as a thumbnail for entries of this content type in the UI
|
|
188
|
-
*
|
|
189
189
|
* @default null
|
|
190
190
|
*/
|
|
191
191
|
thumbnailField?: string | null;
|
|
@@ -251,20 +251,21 @@ interface components$1 {
|
|
|
251
251
|
type: string;
|
|
252
252
|
/** @deprecated */
|
|
253
253
|
connectedData?: components$1["schemas"]["DataElementConnectionDefinition"];
|
|
254
|
-
/**
|
|
254
|
+
/**
|
|
255
|
+
* @description Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
|
|
255
256
|
* Note that locales must be registered on the entry/composition `_locales` before being used
|
|
256
|
-
|
|
257
|
+
*/
|
|
257
258
|
locales?: {
|
|
258
259
|
[key: string]: unknown;
|
|
259
260
|
};
|
|
260
261
|
conditions?: components$1["schemas"]["ComponentParameterConditions"];
|
|
261
|
-
/** @description Locale-specific conditional values for this parameter. Keys are locale codes, and values are the `conditions` for that locale.
|
|
262
|
-
* */
|
|
262
|
+
/** @description Locale-specific conditional values for this parameter. Keys are locale codes, and values are the `conditions` for that locale. */
|
|
263
263
|
localesConditions?: {
|
|
264
264
|
[key: string]: components$1["schemas"]["ComponentParameterConditions"];
|
|
265
265
|
};
|
|
266
266
|
};
|
|
267
|
-
/**
|
|
267
|
+
/**
|
|
268
|
+
* @description Array of alternate values which are based on conditions.
|
|
268
269
|
*
|
|
269
270
|
* When requested with an explicit locale parameter, or via the route API:
|
|
270
271
|
* * Conditions are evaluated sequentially and the first match is used. If a match is found, the conditions are eliminated.
|
|
@@ -272,19 +273,20 @@ interface components$1 {
|
|
|
272
273
|
* * If a condition cannot be evaluated yet (i.e. a client-side criteria), it is left alone.
|
|
273
274
|
*
|
|
274
275
|
* When no locale is passed to a non-route API, conditions are not processed and all conditions are returned.
|
|
275
|
-
|
|
276
|
+
*/
|
|
276
277
|
ComponentParameterConditions: components$1["schemas"]["ComponentParameterConditionalValue"][];
|
|
277
|
-
/** @description Defines a conditional value for a component parameter
|
|
278
|
-
* */
|
|
278
|
+
/** @description Defines a conditional value for a component parameter */
|
|
279
279
|
ComponentParameterConditionalValue: {
|
|
280
280
|
when: components$1["schemas"]["VisibilityCriteriaGroup"];
|
|
281
|
-
/**
|
|
281
|
+
/**
|
|
282
|
+
* @description The value of the parameter. Any JSON-serializable value is acceptable.
|
|
282
283
|
* A value of `null` will cause the parameter value to be removed, if it matches.
|
|
283
|
-
|
|
284
|
+
*/
|
|
284
285
|
value: unknown;
|
|
285
|
-
/**
|
|
286
|
+
/**
|
|
287
|
+
* @description Unique sequence identifier of the conditional value within the component parameter.
|
|
286
288
|
* This value must be unique within the conditional values array, and it should not change after a condition is created.
|
|
287
|
-
|
|
289
|
+
*/
|
|
288
290
|
id: number;
|
|
289
291
|
};
|
|
290
292
|
/**
|
|
@@ -306,17 +308,17 @@ interface components$1 {
|
|
|
306
308
|
VisibilityCriteria: {
|
|
307
309
|
/** @description The rule type to execute */
|
|
308
310
|
rule: string;
|
|
309
|
-
/**
|
|
311
|
+
/**
|
|
312
|
+
* @description The source value of the rule.
|
|
310
313
|
* For rules which have multiple classes of match, for example a dynamic input matches on a named DI, the rule is dynamic input and the DI name is the source.
|
|
311
|
-
|
|
314
|
+
*/
|
|
312
315
|
source?: string;
|
|
313
316
|
/** @description The rule-definition-specific operator to test against */
|
|
314
317
|
op: string;
|
|
315
318
|
/** @description The value, or if an array several potential values, to test against. In most rules, multiple values are OR'd together ('any of') but this is not a hard requirement. */
|
|
316
319
|
value: string | string[];
|
|
317
320
|
};
|
|
318
|
-
/** @description Defines a connection to a dynamic token on a data resource
|
|
319
|
-
* */
|
|
321
|
+
/** @description Defines a connection to a dynamic token on a data resource */
|
|
320
322
|
DataElementConnectionDefinition: {
|
|
321
323
|
/** @description A JSON Pointer expression that defines the data resource dynamic token value */
|
|
322
324
|
pointer: string;
|
|
@@ -336,7 +338,6 @@ interface components$1 {
|
|
|
336
338
|
* NOTE: If a 'component' failure occurs on the root component of a composition, or an entry,
|
|
337
339
|
* it is treated as an 'a' failure because removing the root means we must remove all
|
|
338
340
|
* - a: ALL: Fails the whole entry or composition. This will result in the item returning a 404 from APIs, and being removed from API list responses
|
|
339
|
-
*
|
|
340
341
|
* @enum {string}
|
|
341
342
|
*/
|
|
342
343
|
failureAction?: "t" | "p" | "c" | "a";
|
|
@@ -345,13 +346,13 @@ interface components$1 {
|
|
|
345
346
|
* - e: ERROR: Report an error message (this will prevent publishing)
|
|
346
347
|
* - w: WARNING: Report a warning message [default]
|
|
347
348
|
* - i: INFO: Log an informative message (failure is expected/normal, i.e. optional data)
|
|
348
|
-
*
|
|
349
349
|
* @enum {string}
|
|
350
350
|
*/
|
|
351
351
|
failureLogLevel?: "e" | "w" | "i";
|
|
352
|
-
/**
|
|
352
|
+
/**
|
|
353
|
+
* @description The default value to use if the dynamic token cannot be resolved.
|
|
353
354
|
* This is only used if the failureAction is the default (undefined, or explicitly token)
|
|
354
|
-
|
|
355
|
+
*/
|
|
355
356
|
failureDefault?: string;
|
|
356
357
|
};
|
|
357
358
|
/** @description Defines the shape of a component instance served by the composition API */
|
|
@@ -368,23 +369,26 @@ interface components$1 {
|
|
|
368
369
|
slots?: {
|
|
369
370
|
[key: string]: components$1["schemas"]["ComponentInstance"][];
|
|
370
371
|
};
|
|
371
|
-
/**
|
|
372
|
+
/**
|
|
373
|
+
* @description Unique identifier of the component within the composition.
|
|
372
374
|
* No assumptions should be made about the format of this value other than "it will be unique."
|
|
373
375
|
* This is not returned in GET replies unless specifically requested via `withComponentIDs` API parameter.
|
|
374
376
|
* When updating or creating a composition, if you do not specify an _id for each component, one will be created and stored for you
|
|
375
|
-
|
|
377
|
+
*/
|
|
376
378
|
_id?: string;
|
|
377
379
|
/** @description Indicates this component instance should be sourced from a pattern library pattern */
|
|
378
380
|
_pattern?: string;
|
|
379
381
|
_dataResources?: components$1["schemas"]["DataResourceDefinitions"];
|
|
380
|
-
/**
|
|
382
|
+
/**
|
|
383
|
+
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
|
381
384
|
* Means nothing for PUTs; it will be ignored
|
|
382
|
-
|
|
385
|
+
*/
|
|
383
386
|
_patternDataResources?: {
|
|
384
387
|
[key: string]: components$1["schemas"]["DataResourceDefinition"];
|
|
385
388
|
};
|
|
386
389
|
_patternError?: components$1["schemas"]["PatternError"];
|
|
387
|
-
/**
|
|
390
|
+
/**
|
|
391
|
+
* @description Defines patch overrides to component IDs that live in the composition.
|
|
388
392
|
* This can be used to override parameters that are defined on patterns,
|
|
389
393
|
* including nested patterns, with values that are specific to this composition.
|
|
390
394
|
* The keys in this object are component IDs.
|
|
@@ -394,22 +398,24 @@ interface components$1 {
|
|
|
394
398
|
*
|
|
395
399
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
396
400
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
397
|
-
|
|
401
|
+
*/
|
|
398
402
|
_overrides?: {
|
|
399
403
|
[key: string]: components$1["schemas"]["ComponentOverride"];
|
|
400
404
|
};
|
|
401
|
-
/**
|
|
405
|
+
/**
|
|
406
|
+
* @description Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
|
|
402
407
|
* Means nothing for PUTs; it will be ignored
|
|
403
|
-
|
|
408
|
+
*/
|
|
404
409
|
_patternOverrides?: {
|
|
405
410
|
[key: string]: components$1["schemas"]["ComponentOverride"];
|
|
406
411
|
};
|
|
407
|
-
/**
|
|
412
|
+
/**
|
|
413
|
+
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
|
408
414
|
* by consumers of the pattern.
|
|
409
415
|
*
|
|
410
416
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
411
417
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
412
|
-
|
|
418
|
+
*/
|
|
413
419
|
_overridability?: components$1["schemas"]["ComponentOverridability"];
|
|
414
420
|
/** @description Array of locales that have data defined. Only set for pattern references or composition defaults */
|
|
415
421
|
_locales?: string[];
|
|
@@ -446,15 +452,17 @@ interface components$1 {
|
|
|
446
452
|
_creatorSubject?: string;
|
|
447
453
|
/** @description Indicates this component instance should be sourced from a pattern library pattern */
|
|
448
454
|
_pattern?: string;
|
|
449
|
-
/**
|
|
455
|
+
/**
|
|
456
|
+
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
|
450
457
|
* Means nothing for PUTs; it will be ignored
|
|
451
|
-
|
|
458
|
+
*/
|
|
452
459
|
_patternDataResources?: {
|
|
453
460
|
[key: string]: components$1["schemas"]["DataResourceDefinition"];
|
|
454
461
|
};
|
|
455
462
|
_dataResources?: components$1["schemas"]["DataResourceDefinitions"];
|
|
456
463
|
_patternError?: components$1["schemas"]["PatternError"];
|
|
457
|
-
/**
|
|
464
|
+
/**
|
|
465
|
+
* @description Defines patch overrides to component IDs that live in the composition.
|
|
458
466
|
* This can be used to override parameters that are defined on patterns,
|
|
459
467
|
* including nested patterns, with values that are specific to this composition.
|
|
460
468
|
* The keys in this object are component IDs.
|
|
@@ -464,31 +472,34 @@ interface components$1 {
|
|
|
464
472
|
*
|
|
465
473
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
466
474
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
467
|
-
|
|
475
|
+
*/
|
|
468
476
|
_overrides?: {
|
|
469
477
|
[key: string]: components$1["schemas"]["ComponentOverride"];
|
|
470
478
|
};
|
|
471
|
-
/**
|
|
479
|
+
/**
|
|
480
|
+
* @description Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
|
|
472
481
|
* Means nothing for PUTs; it will be ignored
|
|
473
|
-
|
|
482
|
+
*/
|
|
474
483
|
_patternOverrides?: {
|
|
475
484
|
[key: string]: components$1["schemas"]["ComponentOverride"];
|
|
476
485
|
};
|
|
477
|
-
/**
|
|
486
|
+
/**
|
|
487
|
+
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
|
478
488
|
* by consumers of the pattern.
|
|
479
489
|
*
|
|
480
490
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
481
491
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
482
|
-
|
|
492
|
+
*/
|
|
483
493
|
_overridability?: components$1["schemas"]["ComponentOverridability"];
|
|
484
494
|
/** @description Array of locales which have data defined on the composition. If empty, the current default locale implicitly has data */
|
|
485
495
|
_locales?: string[];
|
|
486
496
|
};
|
|
487
|
-
/**
|
|
497
|
+
/**
|
|
498
|
+
* @description Defines how to override a specific component.
|
|
488
499
|
*
|
|
489
500
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
490
501
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
491
|
-
|
|
502
|
+
*/
|
|
492
503
|
ComponentOverride: {
|
|
493
504
|
parameters?: {
|
|
494
505
|
[key: string]: components$1["schemas"]["ComponentParameter"];
|
|
@@ -497,20 +508,22 @@ interface components$1 {
|
|
|
497
508
|
[key: string]: components$1["schemas"]["ComponentInstance"][];
|
|
498
509
|
};
|
|
499
510
|
variant?: string;
|
|
500
|
-
/**
|
|
511
|
+
/**
|
|
512
|
+
* @description Overrides data resource definitions for a pattern component.
|
|
501
513
|
* Object keys defined under this property override the corresponding keys in the pattern's data resources.
|
|
502
514
|
* Overrides defined here replace values in either _dataResources or _patternDataResources on the target component.
|
|
503
|
-
|
|
515
|
+
*/
|
|
504
516
|
dataResources?: {
|
|
505
517
|
[key: string]: components$1["schemas"]["DataResourceDefinition"];
|
|
506
518
|
};
|
|
507
519
|
};
|
|
508
|
-
/**
|
|
520
|
+
/**
|
|
521
|
+
* @description Defines how a component on a pattern may have its values overridden.
|
|
509
522
|
* NOTE: Data resources' overridability is defined in the data resource definition, not here.
|
|
510
523
|
*
|
|
511
524
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
512
525
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
513
|
-
|
|
526
|
+
*/
|
|
514
527
|
ComponentOverridability: {
|
|
515
528
|
/** @description Defines component parameter value overrides. Keys are the parameter public ID */
|
|
516
529
|
parameters?: {
|
|
@@ -518,10 +531,11 @@ interface components$1 {
|
|
|
518
531
|
};
|
|
519
532
|
/** @description Allows overriding a display variant is allowed if it is defined on the component the pattern is derived from. Default = false */
|
|
520
533
|
variants?: boolean;
|
|
521
|
-
/**
|
|
534
|
+
/**
|
|
535
|
+
* @description If true, parameters that are not overridable will be hidden by default on pattern instances' editors.
|
|
522
536
|
* If false, all parameters will be shown on pattern instances' editors, but locked parameters will be read-only.
|
|
523
537
|
* If not set, the default is false
|
|
524
|
-
|
|
538
|
+
*/
|
|
525
539
|
hideLockedParameters?: boolean;
|
|
526
540
|
};
|
|
527
541
|
/**
|
|
@@ -529,12 +543,10 @@ interface components$1 {
|
|
|
529
543
|
*
|
|
530
544
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
|
531
545
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice
|
|
532
|
-
*
|
|
533
546
|
* @enum {string}
|
|
534
547
|
*/
|
|
535
548
|
OverrideOptions: "yes" | "no";
|
|
536
|
-
/** @description Additional set of headers, parameters, variables, etc to be used for data resolving in the context like e.g. Unpublished Data.
|
|
537
|
-
* */
|
|
549
|
+
/** @description Additional set of headers, parameters, variables, etc to be used for data resolving in the context like e.g. Unpublished Data. */
|
|
538
550
|
AlternativeDataSourceData: {
|
|
539
551
|
/** @description Base resource URL of the data source. No trailing slash */
|
|
540
552
|
baseUrl: string;
|
|
@@ -555,11 +567,12 @@ interface components$1 {
|
|
|
555
567
|
[key: string]: components$1["schemas"]["DataVariableDefinition"];
|
|
556
568
|
};
|
|
557
569
|
};
|
|
558
|
-
/**
|
|
570
|
+
/**
|
|
571
|
+
* @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
|
|
559
572
|
* These are created in the UI and shared across a whole project.
|
|
560
573
|
* NOTE: If you acquire a list of data sources or do not have manage permissions, you will receive "SECRET"
|
|
561
574
|
* for all header, parameter, and variable values to obscure the actual encrypted secret value
|
|
562
|
-
|
|
575
|
+
*/
|
|
563
576
|
DataSource: {
|
|
564
577
|
/** @description Public ID of the data source */
|
|
565
578
|
id: string;
|
|
@@ -583,15 +596,17 @@ interface components$1 {
|
|
|
583
596
|
variables?: {
|
|
584
597
|
[key: string]: components$1["schemas"]["DataVariableDefinition"];
|
|
585
598
|
};
|
|
586
|
-
/**
|
|
599
|
+
/**
|
|
600
|
+
* @description Mapping of locale codes to data source locale codes. Keys are Uniform locale codes, values are data source locale codes.
|
|
587
601
|
* If a locale is not mapped, it will be passed through to the data source as-is
|
|
588
|
-
|
|
602
|
+
*/
|
|
589
603
|
localeMapping?: {
|
|
590
604
|
[key: string]: string;
|
|
591
605
|
};
|
|
592
|
-
/**
|
|
606
|
+
/**
|
|
607
|
+
* @description If true, data source will require additional credentials to access unpublished data.
|
|
593
608
|
* If false, no additional data source credentials are required and data resources of this data source won't be able to access unpublished data.
|
|
594
|
-
|
|
609
|
+
*/
|
|
595
610
|
enableUnpublishedMode?: boolean;
|
|
596
611
|
/** @description Custom configuration accessible to all data connector UIs (data source, data type, and data resource editors) and custom edgehancers. This data should not contain secrets */
|
|
597
612
|
customPublic?: {
|
|
@@ -622,10 +637,11 @@ interface components$1 {
|
|
|
622
637
|
displayName: string;
|
|
623
638
|
/** @description Public ID of the associated data source */
|
|
624
639
|
dataSourceId: string;
|
|
625
|
-
/**
|
|
640
|
+
/**
|
|
641
|
+
* @description A connector-specific archetype for this data type; used to select UI as well as perform any
|
|
626
642
|
* necessary post-processing on the response. e.g. 'cms-entry', 'cms-query'. Can be undefined if
|
|
627
643
|
* no special UI or processing is required
|
|
628
|
-
|
|
644
|
+
*/
|
|
629
645
|
archetype?: string;
|
|
630
646
|
allowedOnComponents?: string[];
|
|
631
647
|
/** @description Resource path, appended to the data source's baseUrl (e.g. baseUrl = https://base.url, path = /v1/endpoint -> final URL https://base.url/v1/endpoint). Must have a leading slash */
|
|
@@ -688,14 +704,16 @@ interface components$1 {
|
|
|
688
704
|
default: string;
|
|
689
705
|
/** @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 */
|
|
690
706
|
order?: number;
|
|
691
|
-
/**
|
|
707
|
+
/**
|
|
708
|
+
* @description An optional arbitrary human readable source identifier to describe where this variable is from.
|
|
692
709
|
* Some user interfaces may group variables by source value, for example 'From URL' or 'My Integration'
|
|
693
|
-
|
|
710
|
+
*/
|
|
694
711
|
source?: string;
|
|
695
712
|
};
|
|
696
|
-
/**
|
|
713
|
+
/**
|
|
714
|
+
* @description Data definitions attached to this component. The property name is the key of the data in the data document.
|
|
697
715
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key)
|
|
698
|
-
|
|
716
|
+
*/
|
|
699
717
|
DataResourceDefinitions: {
|
|
700
718
|
[key: string]: components$1["schemas"]["DataResourceDefinition"];
|
|
701
719
|
};
|
|
@@ -705,14 +723,16 @@ interface components$1 {
|
|
|
705
723
|
type: string;
|
|
706
724
|
/** @description Whether this data is a pattern data resource that can 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 */
|
|
707
725
|
isPatternParameter?: boolean;
|
|
708
|
-
/**
|
|
726
|
+
/**
|
|
727
|
+
* @description When true, the default data resource of a pattern data parameter (isPatternParameter=true) will be ignored when the pattern is referenced.
|
|
709
728
|
* Unless specifically overridden, the pattern data parameter will be provided with a null default value - leaving any data connections to it unresolvable.
|
|
710
729
|
* If isPatternParameter is false or undefined, this has no meaning
|
|
711
|
-
|
|
730
|
+
*/
|
|
712
731
|
ignorePatternParameterDefault?: boolean;
|
|
713
|
-
/**
|
|
732
|
+
/**
|
|
733
|
+
* @description When true, the data resource does not create an error forcing the choosing of override value when there is no default.
|
|
714
734
|
* If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
|
|
715
|
-
|
|
735
|
+
*/
|
|
716
736
|
optionalPatternParameter?: boolean;
|
|
717
737
|
variables?: components$1["schemas"]["DataResourceVariables"];
|
|
718
738
|
};
|
|
@@ -725,14 +745,14 @@ interface components$1 {
|
|
|
725
745
|
* CYCLIC: A cyclic pattern graph was detected, which could not be resolved because it would cause an infinite loop.
|
|
726
746
|
* NOTFOUND: The pattern ID referenced could not be found. It may have been deleted, en published yet.
|
|
727
747
|
* Means nothing for PUTs; it will be ignored
|
|
728
|
-
*
|
|
729
748
|
* @enum {string}
|
|
730
749
|
*/
|
|
731
750
|
PatternError: "NOTFOUND" | "CYCLIC";
|
|
732
751
|
HistoryApiResponse: {
|
|
733
|
-
/**
|
|
752
|
+
/**
|
|
753
|
+
* @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.
|
|
734
754
|
* If this is undefined then no more results are available
|
|
735
|
-
|
|
755
|
+
*/
|
|
736
756
|
cursor?: string;
|
|
737
757
|
/** @description If more history is available than your plan allows, and additional entries are available by upgrading, this will be true */
|
|
738
758
|
truncated?: boolean;
|
|
@@ -744,9 +764,11 @@ interface components$1 {
|
|
|
744
764
|
versionId: string;
|
|
745
765
|
/** @description The timestamp when the version was created in epoch milliseconds */
|
|
746
766
|
timestamp: number;
|
|
747
|
-
/** @description The name (full name) of the user who created the version */
|
|
767
|
+
/** @description The name (full name) of the user who created the version, or "Unknown user" if the author can no longer be resolved */
|
|
748
768
|
authorName: string;
|
|
749
769
|
authorIsApiKey: boolean;
|
|
770
|
+
/** @description The identity who created the version; absent on old history entries. */
|
|
771
|
+
authorSubject?: string;
|
|
750
772
|
/** @description The state of the entity when the history entry was made */
|
|
751
773
|
state: number;
|
|
752
774
|
};
|
|
@@ -772,9 +794,10 @@ interface components$1 {
|
|
|
772
794
|
* @description Unique identifier for the project map node
|
|
773
795
|
*/
|
|
774
796
|
id: string;
|
|
775
|
-
/**
|
|
797
|
+
/**
|
|
798
|
+
* @description Fallback path of the project map node.
|
|
776
799
|
* Note that the node may have matched via a locale-specific path which is in the `locales` object
|
|
777
|
-
|
|
800
|
+
*/
|
|
778
801
|
path: string;
|
|
779
802
|
/**
|
|
780
803
|
* Format: uuid
|
|
@@ -782,15 +805,15 @@ interface components$1 {
|
|
|
782
805
|
*/
|
|
783
806
|
projectMapId: string;
|
|
784
807
|
data?: components$1["schemas"]["ProjectMapNodeData"];
|
|
785
|
-
/**
|
|
808
|
+
/**
|
|
809
|
+
* @description Locale-specific paths of the project map node.
|
|
786
810
|
* Keys are locale codes
|
|
787
|
-
|
|
811
|
+
*/
|
|
788
812
|
locales?: {
|
|
789
813
|
[key: string]: {
|
|
790
814
|
/** @description Locale-specific path of the project map node */
|
|
791
815
|
path: string;
|
|
792
|
-
/** @description Whether the path is inherited from a parent node which defined a path segment in this locale
|
|
793
|
-
* */
|
|
816
|
+
/** @description Whether the path is inherited from a parent node which defined a path segment in this locale */
|
|
794
817
|
inherited: boolean;
|
|
795
818
|
};
|
|
796
819
|
};
|
|
@@ -841,44 +864,50 @@ interface components$1 {
|
|
|
841
864
|
modified?: string;
|
|
842
865
|
/** @description Created ISO date string for this definition (ignored for writes) */
|
|
843
866
|
created?: string;
|
|
844
|
-
/**
|
|
867
|
+
/**
|
|
868
|
+
* @description Name of the original creator of the workflow.
|
|
845
869
|
* If undefined, the user has been removed from the team.
|
|
846
870
|
* Ignored for writes
|
|
847
|
-
|
|
871
|
+
*/
|
|
848
872
|
createdBy?: string;
|
|
849
|
-
/**
|
|
873
|
+
/**
|
|
874
|
+
* @description Name of the last modifier of the workflow.
|
|
850
875
|
* If undefined, the user has been removed from the team.
|
|
851
876
|
* Ignored for writes
|
|
852
|
-
|
|
877
|
+
*/
|
|
853
878
|
modifiedBy?: string;
|
|
854
879
|
};
|
|
855
880
|
/** @description Definition of a stage in a workflow */
|
|
856
881
|
WorkflowStage: {
|
|
857
882
|
/** @description Name of the stage */
|
|
858
883
|
name: string;
|
|
859
|
-
/**
|
|
884
|
+
/**
|
|
885
|
+
* @description Defines roles which have permissions to this workflow stage
|
|
860
886
|
* NOTE: Being able to write or publish to entities in a workflow stage requires both core write or publish permissions,
|
|
861
887
|
* as well as membership in a role which grants the explicit rights to the stage. If a user is not a member of any role
|
|
862
888
|
* listed here, the stage is read-only and publishing is disabled
|
|
863
|
-
|
|
889
|
+
*/
|
|
864
890
|
permissions: {
|
|
865
891
|
[key: string]: components$1["schemas"]["WorkflowStagePermission"];
|
|
866
892
|
};
|
|
867
|
-
/**
|
|
893
|
+
/**
|
|
894
|
+
* @description When true, transitioning into this stage from a different stage will automatically publish the entity.
|
|
868
895
|
* If the user making the transition does not have publish permissions to the stage as well as publish permission on the entity, the action will not run.
|
|
869
896
|
* Setting this to true is equivalent to setting requireValidity to true, as publishing cannot be performed with validation errors.
|
|
870
897
|
* NOTE: This is not executed by direct API calls. Only the Uniform UI performs this action
|
|
871
|
-
|
|
898
|
+
*/
|
|
872
899
|
autoPublish?: boolean;
|
|
873
|
-
/**
|
|
900
|
+
/**
|
|
901
|
+
* @description When true, transitioning into this stage from a different stage will require the entity to have no validation errors.
|
|
874
902
|
* If the entity is not valid, the transition will not be allowed.
|
|
875
903
|
* NOTE: This is not executed by direct API calls. Only the Uniform UI performs this action
|
|
876
|
-
|
|
904
|
+
*/
|
|
877
905
|
requireValidity?: boolean;
|
|
878
|
-
/**
|
|
906
|
+
/**
|
|
907
|
+
* @description Defines transitions to other stages
|
|
879
908
|
* Every stage must define at least one transition, to avoid creating a workflow that
|
|
880
909
|
* has a stage that can never be escaped
|
|
881
|
-
|
|
910
|
+
*/
|
|
882
911
|
transitions: components$1["schemas"]["WorkflowStageTransition"][];
|
|
883
912
|
/**
|
|
884
913
|
* @description Icon name for the stage (e.g. 'chevron-double-right-o')
|
|
@@ -895,13 +924,15 @@ interface components$1 {
|
|
|
895
924
|
* @description The target stage to transition to
|
|
896
925
|
*/
|
|
897
926
|
to: string;
|
|
898
|
-
/**
|
|
927
|
+
/**
|
|
928
|
+
* @description Name shown to the user when they execute this transition.
|
|
899
929
|
* If not provided, a default name will be assigned automatically based on the target stage
|
|
900
|
-
|
|
930
|
+
*/
|
|
901
931
|
name: string;
|
|
902
|
-
/**
|
|
932
|
+
/**
|
|
933
|
+
* @description Permissions for the stage transition.
|
|
903
934
|
* NOTE: Users without membership in any role listed here will be unable to execute the transition unless they are team admins
|
|
904
|
-
|
|
935
|
+
*/
|
|
905
936
|
permissions: {
|
|
906
937
|
[key: string]: components$1["schemas"]["WorkflowStageTransitionPermission"];
|
|
907
938
|
};
|
|
@@ -949,10 +980,11 @@ interface components$1 {
|
|
|
949
980
|
isSearchHit?: boolean;
|
|
950
981
|
/** @description Query strings that are allowed to be passed to the node */
|
|
951
982
|
queryStrings?: components$1["schemas"]["ProjectMapNodeAllowedQueryString"][];
|
|
952
|
-
/**
|
|
983
|
+
/**
|
|
984
|
+
* @description For dynamic nodes, this is the preview value for the dynamic value.
|
|
953
985
|
* The preview value is used when editing a connected composition, and is the default
|
|
954
986
|
* dynamic node value unless the author has explicitly chosen a different value
|
|
955
|
-
|
|
987
|
+
*/
|
|
956
988
|
previewValue?: string;
|
|
957
989
|
};
|
|
958
990
|
};
|
|
@@ -978,28 +1010,28 @@ interface paths {
|
|
|
978
1010
|
assetId?: components["parameters"]["assetId"];
|
|
979
1011
|
/** @description Specify multiple asset IDs to fetch. Response type will be a list */
|
|
980
1012
|
assetIDs?: components["parameters"]["assetIDs"];
|
|
981
|
-
/** @description Filters asset lists by the user who created them. The user is specified by their identity subject
|
|
982
|
-
* */
|
|
1013
|
+
/** @description Filters asset lists by the user who created them. The user is specified by their identity subject */
|
|
983
1014
|
createdBy?: components["parameters"]["createdBy"];
|
|
984
|
-
/**
|
|
1015
|
+
/**
|
|
1016
|
+
* @description Matches assets where their name or description contains the specified keyword.
|
|
985
1017
|
* This is a list query parameter, and cannot be used with any primary query parameters
|
|
986
|
-
|
|
1018
|
+
*/
|
|
987
1019
|
keyword?: components["parameters"]["keyword"];
|
|
988
1020
|
/**
|
|
989
1021
|
* @deprecated
|
|
990
1022
|
* @description BETA: Semantic search using vector similarity to find assets by meaning.
|
|
991
1023
|
* Use this for "images of mountains" style queries.
|
|
992
1024
|
* Requires AI credits.
|
|
993
|
-
*
|
|
994
1025
|
*/
|
|
995
1026
|
searchSemantic?: components["parameters"]["searchSemantic"];
|
|
996
1027
|
/** @description Max number of records to return */
|
|
997
1028
|
limit?: components["parameters"]["limit"];
|
|
998
1029
|
/** @description Number of records to skip */
|
|
999
1030
|
offset?: components["parameters"]["offset"];
|
|
1000
|
-
/**
|
|
1031
|
+
/**
|
|
1032
|
+
* @description Sets the sorting of the results. If unspecified, results are sorted by creation date ascending.
|
|
1001
1033
|
* Allowed values are: updated_at_DESC, updated_at_ASC, created_at_DESC, created_at_ASC, name_DESC, name_ASC, slug_DESC, slug_ASC, relevance_DESC (when searching).
|
|
1002
|
-
|
|
1034
|
+
*/
|
|
1003
1035
|
orderBy?: components["parameters"]["orderBy"];
|
|
1004
1036
|
/**
|
|
1005
1037
|
* @deprecated
|
|
@@ -1010,31 +1042,32 @@ interface paths {
|
|
|
1010
1042
|
projectId: components["parameters"]["projectId"];
|
|
1011
1043
|
/** @description The asset type ID to filter by */
|
|
1012
1044
|
type?: components["parameters"]["type"];
|
|
1013
|
-
/** @description Filters asset lists by the user who last updated them. The user is specified by their identity subject
|
|
1014
|
-
* */
|
|
1045
|
+
/** @description Filters asset lists by the user who last updated them. The user is specified by their identity subject */
|
|
1015
1046
|
updatedBy?: components["parameters"]["updatedBy"];
|
|
1016
|
-
/**
|
|
1047
|
+
/**
|
|
1048
|
+
* @description Controls whether the total count of results will be returned along with the current results page in a list.
|
|
1017
1049
|
* Has no effect when not fetching a list. This does impact performance when enabled
|
|
1018
|
-
|
|
1050
|
+
*/
|
|
1019
1051
|
withTotalCount?: components["parameters"]["withTotalCount"];
|
|
1020
|
-
/**
|
|
1052
|
+
/**
|
|
1053
|
+
* @description The ID of a release to fetch the content for.
|
|
1021
1054
|
*
|
|
1022
1055
|
* - When unspecified, all release content is excluded from the result(s).
|
|
1023
1056
|
* - When specified, all content is returned as it would appear in the release if it was released now. This includes both content copied to the release and changed, as well as content that is not part of the release.
|
|
1024
1057
|
*
|
|
1025
1058
|
* Content copied to a release can be differentiated from base content by the `releaseId` property on the content. If the content is not copied to the release, this property will be undefined
|
|
1026
|
-
|
|
1059
|
+
*/
|
|
1027
1060
|
releaseId?: components["parameters"]["releaseId"];
|
|
1028
|
-
/**
|
|
1061
|
+
/**
|
|
1062
|
+
* @description When true, includes full label entities in the response for UI rendering.
|
|
1029
1063
|
* The assignedLabels array includes the label and its parent group (if any).
|
|
1030
1064
|
* This parameter is not supported with uniform.global.
|
|
1031
|
-
|
|
1065
|
+
*/
|
|
1032
1066
|
withAssignedLabels?: components["parameters"]["withAssignedLabels"];
|
|
1033
1067
|
/**
|
|
1034
1068
|
* @deprecated
|
|
1035
1069
|
* @description Returns additional author and creator metadata for the asset.
|
|
1036
1070
|
* This internal status is subject to change without notice and is thus marked deprecated to discourage use of internal data
|
|
1037
|
-
*
|
|
1038
1071
|
*/
|
|
1039
1072
|
withUIStatus?: components["parameters"]["withUIStatus"];
|
|
1040
1073
|
};
|
|
@@ -1139,7 +1172,6 @@ interface paths {
|
|
|
1139
1172
|
* Format: uuid
|
|
1140
1173
|
* @description The ID of the release the asset to delete belongs to. If unspecified the asset belongs to the base.
|
|
1141
1174
|
* Note: deleting an asset from a release will not delete the asset from the base
|
|
1142
|
-
*
|
|
1143
1175
|
*/
|
|
1144
1176
|
releaseId?: string;
|
|
1145
1177
|
};
|
|
@@ -1368,8 +1400,7 @@ interface components {
|
|
|
1368
1400
|
};
|
|
1369
1401
|
};
|
|
1370
1402
|
};
|
|
1371
|
-
/** @description Defines a connection to a dynamic token on a data resource
|
|
1372
|
-
* */
|
|
1403
|
+
/** @description Defines a connection to a dynamic token on a data resource */
|
|
1373
1404
|
DataElementConnectionDefinition: {
|
|
1374
1405
|
/** @description A JSON Pointer expression that defines the data resource dynamic token value */
|
|
1375
1406
|
pointer: string;
|
|
@@ -1389,7 +1420,6 @@ interface components {
|
|
|
1389
1420
|
* NOTE: If a 'component' failure occurs on the root component of a composition, or an entry,
|
|
1390
1421
|
* it is treated as an 'a' failure because removing the root means we must remove all
|
|
1391
1422
|
* - a: ALL: Fails the whole entry or composition. This will result in the item returning a 404 from APIs, and being removed from API list responses
|
|
1392
|
-
*
|
|
1393
1423
|
* @enum {string}
|
|
1394
1424
|
*/
|
|
1395
1425
|
failureAction?: "t" | "p" | "c" | "a";
|
|
@@ -1398,13 +1428,13 @@ interface components {
|
|
|
1398
1428
|
* - e: ERROR: Report an error message (this will prevent publishing)
|
|
1399
1429
|
* - w: WARNING: Report a warning message [default]
|
|
1400
1430
|
* - i: INFO: Log an informative message (failure is expected/normal, i.e. optional data)
|
|
1401
|
-
*
|
|
1402
1431
|
* @enum {string}
|
|
1403
1432
|
*/
|
|
1404
1433
|
failureLogLevel?: "e" | "w" | "i";
|
|
1405
|
-
/**
|
|
1434
|
+
/**
|
|
1435
|
+
* @description The default value to use if the dynamic token cannot be resolved.
|
|
1406
1436
|
* This is only used if the failureAction is the default (undefined, or explicitly token)
|
|
1407
|
-
|
|
1437
|
+
*/
|
|
1408
1438
|
failureDefault?: string;
|
|
1409
1439
|
};
|
|
1410
1440
|
/**
|
|
@@ -1414,9 +1444,10 @@ interface components {
|
|
|
1414
1444
|
VisibilityCriteria: {
|
|
1415
1445
|
/** @description The rule type to execute */
|
|
1416
1446
|
rule: string;
|
|
1417
|
-
/**
|
|
1447
|
+
/**
|
|
1448
|
+
* @description The source value of the rule.
|
|
1418
1449
|
* For rules which have multiple classes of match, for example a dynamic input matches on a named DI, the rule is dynamic input and the DI name is the source.
|
|
1419
|
-
|
|
1450
|
+
*/
|
|
1420
1451
|
source?: string;
|
|
1421
1452
|
/** @description The rule-definition-specific operator to test against */
|
|
1422
1453
|
op: string;
|
|
@@ -1435,20 +1466,22 @@ interface components {
|
|
|
1435
1466
|
op?: "&" | "|";
|
|
1436
1467
|
clauses: (components["schemas"]["VisibilityCriteria"] | components["schemas"]["VisibilityCriteriaGroup"])[];
|
|
1437
1468
|
};
|
|
1438
|
-
/** @description Defines a conditional value for a component parameter
|
|
1439
|
-
* */
|
|
1469
|
+
/** @description Defines a conditional value for a component parameter */
|
|
1440
1470
|
ComponentParameterConditionalValue: {
|
|
1441
1471
|
when: components["schemas"]["VisibilityCriteriaGroup"];
|
|
1442
|
-
/**
|
|
1472
|
+
/**
|
|
1473
|
+
* @description The value of the parameter. Any JSON-serializable value is acceptable.
|
|
1443
1474
|
* A value of `null` will cause the parameter value to be removed, if it matches.
|
|
1444
|
-
|
|
1475
|
+
*/
|
|
1445
1476
|
value: unknown;
|
|
1446
|
-
/**
|
|
1477
|
+
/**
|
|
1478
|
+
* @description Unique sequence identifier of the conditional value within the component parameter.
|
|
1447
1479
|
* This value must be unique within the conditional values array, and it should not change after a condition is created.
|
|
1448
|
-
|
|
1480
|
+
*/
|
|
1449
1481
|
id: number;
|
|
1450
1482
|
};
|
|
1451
|
-
/**
|
|
1483
|
+
/**
|
|
1484
|
+
* @description Array of alternate values which are based on conditions.
|
|
1452
1485
|
*
|
|
1453
1486
|
* When requested with an explicit locale parameter, or via the route API:
|
|
1454
1487
|
* * Conditions are evaluated sequentially and the first match is used. If a match is found, the conditions are eliminated.
|
|
@@ -1456,7 +1489,7 @@ interface components {
|
|
|
1456
1489
|
* * If a condition cannot be evaluated yet (i.e. a client-side criteria), it is left alone.
|
|
1457
1490
|
*
|
|
1458
1491
|
* When no locale is passed to a non-route API, conditions are not processed and all conditions are returned.
|
|
1459
|
-
|
|
1492
|
+
*/
|
|
1460
1493
|
ComponentParameterConditions: components["schemas"]["ComponentParameterConditionalValue"][];
|
|
1461
1494
|
/** @description Defines an editable parameter on a component */
|
|
1462
1495
|
ComponentParameter: {
|
|
@@ -1466,15 +1499,15 @@ interface components {
|
|
|
1466
1499
|
type: string;
|
|
1467
1500
|
/** @deprecated */
|
|
1468
1501
|
connectedData?: components["schemas"]["DataElementConnectionDefinition"];
|
|
1469
|
-
/**
|
|
1502
|
+
/**
|
|
1503
|
+
* @description Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
|
|
1470
1504
|
* Note that locales must be registered on the entry/composition `_locales` before being used
|
|
1471
|
-
|
|
1505
|
+
*/
|
|
1472
1506
|
locales?: {
|
|
1473
1507
|
[key: string]: unknown;
|
|
1474
1508
|
};
|
|
1475
1509
|
conditions?: components["schemas"]["ComponentParameterConditions"];
|
|
1476
|
-
/** @description Locale-specific conditional values for this parameter. Keys are locale codes, and values are the `conditions` for that locale.
|
|
1477
|
-
* */
|
|
1510
|
+
/** @description Locale-specific conditional values for this parameter. Keys are locale codes, and values are the `conditions` for that locale. */
|
|
1478
1511
|
localesConditions?: {
|
|
1479
1512
|
[key: string]: components["schemas"]["ComponentParameterConditions"];
|
|
1480
1513
|
};
|
|
@@ -1489,20 +1522,23 @@ interface components {
|
|
|
1489
1522
|
type: string;
|
|
1490
1523
|
/** @description Whether this data is a pattern data resource that can 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 */
|
|
1491
1524
|
isPatternParameter?: boolean;
|
|
1492
|
-
/**
|
|
1525
|
+
/**
|
|
1526
|
+
* @description When true, the default data resource of a pattern data parameter (isPatternParameter=true) will be ignored when the pattern is referenced.
|
|
1493
1527
|
* Unless specifically overridden, the pattern data parameter will be provided with a null default value - leaving any data connections to it unresolvable.
|
|
1494
1528
|
* If isPatternParameter is false or undefined, this has no meaning
|
|
1495
|
-
|
|
1529
|
+
*/
|
|
1496
1530
|
ignorePatternParameterDefault?: boolean;
|
|
1497
|
-
/**
|
|
1531
|
+
/**
|
|
1532
|
+
* @description When true, the data resource does not create an error forcing the choosing of override value when there is no default.
|
|
1498
1533
|
* If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
|
|
1499
|
-
|
|
1534
|
+
*/
|
|
1500
1535
|
optionalPatternParameter?: boolean;
|
|
1501
1536
|
variables?: components["schemas"]["DataResourceVariables"];
|
|
1502
1537
|
};
|
|
1503
|
-
/**
|
|
1538
|
+
/**
|
|
1539
|
+
* @description Data definitions attached to this component. The property name is the key of the data in the data document.
|
|
1504
1540
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key)
|
|
1505
|
-
|
|
1541
|
+
*/
|
|
1506
1542
|
DataResourceDefinitions: {
|
|
1507
1543
|
[key: string]: components["schemas"]["DataResourceDefinition"];
|
|
1508
1544
|
};
|
|
@@ -1567,55 +1603,56 @@ interface components {
|
|
|
1567
1603
|
offset: number;
|
|
1568
1604
|
/** @description Max number of records to return */
|
|
1569
1605
|
limit: number;
|
|
1570
|
-
/**
|
|
1606
|
+
/**
|
|
1607
|
+
* @description Matches assets where their name or description contains the specified keyword.
|
|
1571
1608
|
* This is a list query parameter, and cannot be used with any primary query parameters
|
|
1572
|
-
|
|
1609
|
+
*/
|
|
1573
1610
|
keyword: string;
|
|
1574
1611
|
/**
|
|
1575
1612
|
* @deprecated
|
|
1576
1613
|
* @description BETA: Semantic search using vector similarity to find assets by meaning.
|
|
1577
1614
|
* Use this for "images of mountains" style queries.
|
|
1578
1615
|
* Requires AI credits.
|
|
1579
|
-
*
|
|
1580
1616
|
*/
|
|
1581
1617
|
searchSemantic: string;
|
|
1582
|
-
/**
|
|
1618
|
+
/**
|
|
1619
|
+
* @description Sets the sorting of the results. If unspecified, results are sorted by creation date ascending.
|
|
1583
1620
|
* Allowed values are: updated_at_DESC, updated_at_ASC, created_at_DESC, created_at_ASC, name_DESC, name_ASC, slug_DESC, slug_ASC, relevance_DESC (when searching).
|
|
1584
|
-
|
|
1621
|
+
*/
|
|
1585
1622
|
orderBy: string[];
|
|
1586
1623
|
/**
|
|
1587
1624
|
* @deprecated
|
|
1588
1625
|
* @description Returns counts for distinct values of the specified field or fields (provided as comma-separated IDs).
|
|
1589
1626
|
*/
|
|
1590
1627
|
facetBy: string;
|
|
1591
|
-
/** @description Filters asset lists by the user who created them. The user is specified by their identity subject
|
|
1592
|
-
* */
|
|
1628
|
+
/** @description Filters asset lists by the user who created them. The user is specified by their identity subject */
|
|
1593
1629
|
createdBy: string;
|
|
1594
|
-
/** @description Filters asset lists by the user who last updated them. The user is specified by their identity subject
|
|
1595
|
-
* */
|
|
1630
|
+
/** @description Filters asset lists by the user who last updated them. The user is specified by their identity subject */
|
|
1596
1631
|
updatedBy: string;
|
|
1597
|
-
/**
|
|
1632
|
+
/**
|
|
1633
|
+
* @description Controls whether the total count of results will be returned along with the current results page in a list.
|
|
1598
1634
|
* Has no effect when not fetching a list. This does impact performance when enabled
|
|
1599
|
-
|
|
1635
|
+
*/
|
|
1600
1636
|
withTotalCount: boolean;
|
|
1601
|
-
/**
|
|
1637
|
+
/**
|
|
1638
|
+
* @description The ID of a release to fetch the content for.
|
|
1602
1639
|
*
|
|
1603
1640
|
* - When unspecified, all release content is excluded from the result(s).
|
|
1604
1641
|
* - When specified, all content is returned as it would appear in the release if it was released now. This includes both content copied to the release and changed, as well as content that is not part of the release.
|
|
1605
1642
|
*
|
|
1606
1643
|
* Content copied to a release can be differentiated from base content by the `releaseId` property on the content. If the content is not copied to the release, this property will be undefined
|
|
1607
|
-
|
|
1644
|
+
*/
|
|
1608
1645
|
releaseId: string;
|
|
1609
|
-
/**
|
|
1646
|
+
/**
|
|
1647
|
+
* @description When true, includes full label entities in the response for UI rendering.
|
|
1610
1648
|
* The assignedLabels array includes the label and its parent group (if any).
|
|
1611
1649
|
* This parameter is not supported with uniform.global.
|
|
1612
|
-
|
|
1650
|
+
*/
|
|
1613
1651
|
withAssignedLabels: boolean;
|
|
1614
1652
|
/**
|
|
1615
1653
|
* @deprecated
|
|
1616
1654
|
* @description Returns additional author and creator metadata for the asset.
|
|
1617
1655
|
* This internal status is subject to change without notice and is thus marked deprecated to discourage use of internal data
|
|
1618
|
-
*
|
|
1619
1656
|
*/
|
|
1620
1657
|
withUIStatus: boolean;
|
|
1621
1658
|
};
|
|
@@ -1722,9 +1759,20 @@ declare class AssetClient extends ApiClient {
|
|
|
1722
1759
|
get(options: WithoutProjectId<AssetGetRequestList> & {
|
|
1723
1760
|
filters?: Record<string, unknown>;
|
|
1724
1761
|
}): Promise<AssetGetResponseList>;
|
|
1762
|
+
/**
|
|
1763
|
+
* Fetches a list of assets
|
|
1764
|
+
*/
|
|
1765
|
+
list(options?: WithoutProjectId<AssetGetRequestList> & {
|
|
1766
|
+
filters?: Record<string, unknown>;
|
|
1767
|
+
}): Promise<AssetGetResponseList>;
|
|
1768
|
+
save(options: WithoutProjectId<AssetUpsertRequest>): Promise<void>;
|
|
1769
|
+
/** @deprecated Use {@link save} instead. */
|
|
1725
1770
|
upsert(options: WithoutProjectId<AssetUpsertRequest>): Promise<void>;
|
|
1771
|
+
remove(options: WithoutProjectId<AssetDeleteRequest>): Promise<void>;
|
|
1772
|
+
/** @deprecated Use {@link remove} instead. */
|
|
1726
1773
|
delete(options: WithoutProjectId<AssetDeleteRequest>): Promise<void>;
|
|
1727
1774
|
}
|
|
1775
|
+
/** @deprecated Pass `bypassCache: true` to {@link AssetClient} instead. */
|
|
1728
1776
|
declare class UncachedAssetClient extends AssetClient {
|
|
1729
1777
|
constructor(options: Omit<ClientOptions & {
|
|
1730
1778
|
projectId: NonNullable<ClientOptions['projectId']>;
|