@uniformdev/assets 20.49.2 → 20.49.3-alpha.47

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 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
- /** @description If true, this property can have locale-specific values. If false or not defined,
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
- /** @description When `localizable` is true, this property controls the default localizability of the property.
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
- /** @description Enables creating additional conditional values for the parameter based on criteria such as dynamic inputs.
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
- /** @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.
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
- /** @description When not defined, or false: all patterns for components listed in `allowedComponents` are automatically allowed in the slot.
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
- /** @description Custom error message when regular expression validation fails.
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
- /** @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.
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
- /** @description Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
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
- /** @description Array of alternate values which are based on conditions.
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
- /** @description The value of the parameter. Any JSON-serializable value is acceptable.
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
- /** @description Unique sequence identifier of the conditional value within the component parameter.
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
- /** @description The source value of the rule.
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
- /** @description The default value to use if the dynamic token cannot be resolved.
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
- /** @description Unique identifier of the component within the composition.
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
- /** @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
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
- /** @description Defines patch overrides to component IDs that live in the composition.
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
- /** @description Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
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
- /** @description When used on a pattern, defines how the pattern's parameters may be overridden
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
- /** @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
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
- /** @description Defines patch overrides to component IDs that live in the composition.
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
- /** @description Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
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
- /** @description When used on a pattern, defines how the pattern's parameters may be overridden
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
- /** @description Defines how to override a specific component.
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
- /** @description Overrides data resource definitions for a pattern component.
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
- /** @description Defines how a component on a pattern may have its values overridden.
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
- /** @description If true, parameters that are not overridable will be hidden by default on pattern instances' editors.
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
- /** @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
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
- /** @description Mapping of locale codes to data source locale codes. Keys are Uniform locale codes, values are data source locale codes.
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
- /** @description If true, data source will require additional credentials to access unpublished data.
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?: {
@@ -605,6 +620,14 @@ interface components$1 {
605
620
  variants?: {
606
621
  unpublished?: components$1["schemas"]["AlternativeDataSourceData"];
607
622
  };
623
+ /** @description Created date of the data source in ISO 8601 format (ignored for writes) */
624
+ created?: string;
625
+ /** @description Last modified date of the data source in ISO 8601 format (ignored for writes) */
626
+ modified?: string;
627
+ /** @description User or API key ID that created the data source (ignored for writes) */
628
+ createdBy?: string;
629
+ /** @description User or API key ID that last modified the data source (ignored for writes) */
630
+ modifiedBy?: string;
608
631
  };
609
632
  /** @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 */
610
633
  DataType: {
@@ -614,10 +637,11 @@ interface components$1 {
614
637
  displayName: string;
615
638
  /** @description Public ID of the associated data source */
616
639
  dataSourceId: string;
617
- /** @description A connector-specific archetype for this data type; used to select UI as well as perform any
640
+ /**
641
+ * @description A connector-specific archetype for this data type; used to select UI as well as perform any
618
642
  * necessary post-processing on the response. e.g. 'cms-entry', 'cms-query'. Can be undefined if
619
643
  * no special UI or processing is required
620
- * */
644
+ */
621
645
  archetype?: string;
622
646
  allowedOnComponents?: string[];
623
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 */
@@ -656,6 +680,14 @@ interface components$1 {
656
680
  custom?: {
657
681
  [key: string]: unknown;
658
682
  };
683
+ /** @description Created date of the data type in ISO 8601 format (ignored for writes) */
684
+ created?: string;
685
+ /** @description Last modified date of the data type in ISO 8601 format (ignored for writes) */
686
+ modified?: string;
687
+ /** @description User or API key ID that created the data type (ignored for writes) */
688
+ createdBy?: string;
689
+ /** @description User or API key ID that last modified the data type (ignored for writes) */
690
+ modifiedBy?: string;
659
691
  };
660
692
  /** @description Defines the shape of a data variable on a Data Source or Data Type */
661
693
  DataVariableDefinition: {
@@ -672,14 +704,16 @@ interface components$1 {
672
704
  default: string;
673
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 */
674
706
  order?: number;
675
- /** @description An optional arbitrary human readable source identifier to describe where this variable is from.
707
+ /**
708
+ * @description An optional arbitrary human readable source identifier to describe where this variable is from.
676
709
  * Some user interfaces may group variables by source value, for example 'From URL' or 'My Integration'
677
- * */
710
+ */
678
711
  source?: string;
679
712
  };
680
- /** @description Data definitions attached to this component. The property name is the key of the data in the data document.
713
+ /**
714
+ * @description Data definitions attached to this component. The property name is the key of the data in the data document.
681
715
  * Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key)
682
- * */
716
+ */
683
717
  DataResourceDefinitions: {
684
718
  [key: string]: components$1["schemas"]["DataResourceDefinition"];
685
719
  };
@@ -689,14 +723,16 @@ interface components$1 {
689
723
  type: string;
690
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 */
691
725
  isPatternParameter?: boolean;
692
- /** @description When true, the default data resource of a pattern data parameter (isPatternParameter=true) will be ignored when the pattern is referenced.
726
+ /**
727
+ * @description When true, the default data resource of a pattern data parameter (isPatternParameter=true) will be ignored when the pattern is referenced.
693
728
  * Unless specifically overridden, the pattern data parameter will be provided with a null default value - leaving any data connections to it unresolvable.
694
729
  * If isPatternParameter is false or undefined, this has no meaning
695
- * */
730
+ */
696
731
  ignorePatternParameterDefault?: boolean;
697
- /** @description When true, the data resource does not create an error forcing the choosing of override value when there is no default.
732
+ /**
733
+ * @description When true, the data resource does not create an error forcing the choosing of override value when there is no default.
698
734
  * If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
699
- * */
735
+ */
700
736
  optionalPatternParameter?: boolean;
701
737
  variables?: components$1["schemas"]["DataResourceVariables"];
702
738
  };
@@ -709,14 +745,14 @@ interface components$1 {
709
745
  * CYCLIC: A cyclic pattern graph was detected, which could not be resolved because it would cause an infinite loop.
710
746
  * NOTFOUND: The pattern ID referenced could not be found. It may have been deleted, en published yet.
711
747
  * Means nothing for PUTs; it will be ignored
712
- *
713
748
  * @enum {string}
714
749
  */
715
750
  PatternError: "NOTFOUND" | "CYCLIC";
716
751
  HistoryApiResponse: {
717
- /** @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.
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.
718
754
  * If this is undefined then no more results are available
719
- * */
755
+ */
720
756
  cursor?: string;
721
757
  /** @description If more history is available than your plan allows, and additional entries are available by upgrading, this will be true */
722
758
  truncated?: boolean;
@@ -756,9 +792,10 @@ interface components$1 {
756
792
  * @description Unique identifier for the project map node
757
793
  */
758
794
  id: string;
759
- /** @description Fallback path of the project map node.
795
+ /**
796
+ * @description Fallback path of the project map node.
760
797
  * Note that the node may have matched via a locale-specific path which is in the `locales` object
761
- * */
798
+ */
762
799
  path: string;
763
800
  /**
764
801
  * Format: uuid
@@ -766,15 +803,15 @@ interface components$1 {
766
803
  */
767
804
  projectMapId: string;
768
805
  data?: components$1["schemas"]["ProjectMapNodeData"];
769
- /** @description Locale-specific paths of the project map node.
806
+ /**
807
+ * @description Locale-specific paths of the project map node.
770
808
  * Keys are locale codes
771
- * */
809
+ */
772
810
  locales?: {
773
811
  [key: string]: {
774
812
  /** @description Locale-specific path of the project map node */
775
813
  path: string;
776
- /** @description Whether the path is inherited from a parent node which defined a path segment in this locale
777
- * */
814
+ /** @description Whether the path is inherited from a parent node which defined a path segment in this locale */
778
815
  inherited: boolean;
779
816
  };
780
817
  };
@@ -825,44 +862,50 @@ interface components$1 {
825
862
  modified?: string;
826
863
  /** @description Created ISO date string for this definition (ignored for writes) */
827
864
  created?: string;
828
- /** @description Name of the original creator of the workflow.
865
+ /**
866
+ * @description Name of the original creator of the workflow.
829
867
  * If undefined, the user has been removed from the team.
830
868
  * Ignored for writes
831
- * */
869
+ */
832
870
  createdBy?: string;
833
- /** @description Name of the last modifier of the workflow.
871
+ /**
872
+ * @description Name of the last modifier of the workflow.
834
873
  * If undefined, the user has been removed from the team.
835
874
  * Ignored for writes
836
- * */
875
+ */
837
876
  modifiedBy?: string;
838
877
  };
839
878
  /** @description Definition of a stage in a workflow */
840
879
  WorkflowStage: {
841
880
  /** @description Name of the stage */
842
881
  name: string;
843
- /** @description Defines roles which have permissions to this workflow stage
882
+ /**
883
+ * @description Defines roles which have permissions to this workflow stage
844
884
  * NOTE: Being able to write or publish to entities in a workflow stage requires both core write or publish permissions,
845
885
  * 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
846
886
  * listed here, the stage is read-only and publishing is disabled
847
- * */
887
+ */
848
888
  permissions: {
849
889
  [key: string]: components$1["schemas"]["WorkflowStagePermission"];
850
890
  };
851
- /** @description When true, transitioning into this stage from a different stage will automatically publish the entity.
891
+ /**
892
+ * @description When true, transitioning into this stage from a different stage will automatically publish the entity.
852
893
  * 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.
853
894
  * Setting this to true is equivalent to setting requireValidity to true, as publishing cannot be performed with validation errors.
854
895
  * NOTE: This is not executed by direct API calls. Only the Uniform UI performs this action
855
- * */
896
+ */
856
897
  autoPublish?: boolean;
857
- /** @description When true, transitioning into this stage from a different stage will require the entity to have no validation errors.
898
+ /**
899
+ * @description When true, transitioning into this stage from a different stage will require the entity to have no validation errors.
858
900
  * If the entity is not valid, the transition will not be allowed.
859
901
  * NOTE: This is not executed by direct API calls. Only the Uniform UI performs this action
860
- * */
902
+ */
861
903
  requireValidity?: boolean;
862
- /** @description Defines transitions to other stages
904
+ /**
905
+ * @description Defines transitions to other stages
863
906
  * Every stage must define at least one transition, to avoid creating a workflow that
864
907
  * has a stage that can never be escaped
865
- * */
908
+ */
866
909
  transitions: components$1["schemas"]["WorkflowStageTransition"][];
867
910
  /**
868
911
  * @description Icon name for the stage (e.g. 'chevron-double-right-o')
@@ -879,13 +922,15 @@ interface components$1 {
879
922
  * @description The target stage to transition to
880
923
  */
881
924
  to: string;
882
- /** @description Name shown to the user when they execute this transition.
925
+ /**
926
+ * @description Name shown to the user when they execute this transition.
883
927
  * If not provided, a default name will be assigned automatically based on the target stage
884
- * */
928
+ */
885
929
  name: string;
886
- /** @description Permissions for the stage transition.
930
+ /**
931
+ * @description Permissions for the stage transition.
887
932
  * NOTE: Users without membership in any role listed here will be unable to execute the transition unless they are team admins
888
- * */
933
+ */
889
934
  permissions: {
890
935
  [key: string]: components$1["schemas"]["WorkflowStageTransitionPermission"];
891
936
  };
@@ -904,6 +949,8 @@ interface components$1 {
904
949
  };
905
950
  /** @enum {string} */
906
951
  ReleaseState: "open" | "locked" | "queued" | "launching" | "launched" | "deleting";
952
+ /** @enum {string} */
953
+ ReleaseScheduleState: "scheduled" | "unscheduled";
907
954
  ProjectMapNodeAllowedQueryString: {
908
955
  /** @description The name of the query string parameter */
909
956
  name: string;
@@ -931,10 +978,11 @@ interface components$1 {
931
978
  isSearchHit?: boolean;
932
979
  /** @description Query strings that are allowed to be passed to the node */
933
980
  queryStrings?: components$1["schemas"]["ProjectMapNodeAllowedQueryString"][];
934
- /** @description For dynamic nodes, this is the preview value for the dynamic value.
981
+ /**
982
+ * @description For dynamic nodes, this is the preview value for the dynamic value.
935
983
  * The preview value is used when editing a connected composition, and is the default
936
984
  * dynamic node value unless the author has explicitly chosen a different value
937
- * */
985
+ */
938
986
  previewValue?: string;
939
987
  };
940
988
  };
@@ -953,6 +1001,58 @@ interface paths {
953
1001
  path?: never;
954
1002
  cookie?: never;
955
1003
  };
1004
+ /**
1005
+ * @description In addition to the named parameters below, this endpoint accepts the
1006
+ * following query parameter convention which is pattern-validated and
1007
+ * therefore not declared as named parameters:
1008
+ *
1009
+ * * `filters.<field>[<op>]` — content filtering (documented below).
1010
+ *
1011
+ * #### Content filtering (`filters.*`)
1012
+ *
1013
+ * Filtering narrows list results to assets matching field values. The
1014
+ * allowed field names are project-specific — they come from the project's
1015
+ * asset definitions — which is why `filters.*` parameters are
1016
+ * pattern-validated rather than declared as named parameters.
1017
+ *
1018
+ * Syntax: `filters.<field>[<operator>]=<value>`. `<field>` is one of:
1019
+ *
1020
+ * * A system field such as `name`, `type`, `created`, `modified`,
1021
+ * `entityId`, `creator`, `creatorSubject`, `author`, `authorSubject`,
1022
+ * `categoryId`, `labels`, `labelGroups`, or `uiStatus`.
1023
+ * * An asset field, addressed as `fields.<fieldId>`. Unlike entries and
1024
+ * compositions, asset field filters do not require a single-type
1025
+ * filter — but if the same field ID has differing types across asset
1026
+ * types, HTTP 400 is returned and a single asset type must be
1027
+ * filtered.
1028
+ *
1029
+ * | Operator | Effect |
1030
+ * |---|---|
1031
+ * | `[eq]` / `[neq]` | Exact equality / inequality. |
1032
+ * | `[match]` | Contains (text search) match; text-like fields only. |
1033
+ * | `[starts]` | Prefix match. Value limited to letters, numbers, `_`, `.`, `-`, and spaces. |
1034
+ * | `[lt]` / `[lte]` / `[gt]` / `[gte]` | Comparisons for number, date, and datetime fields (including `created` / `modified`). |
1035
+ * | `[in]` / `[nin]` | Comma-separated list; matches any (OR) / none of the values. |
1036
+ * | `[all]` | Comma-separated list; list-valued fields (e.g. `labels`, multi-selects) must contain every value (AND). |
1037
+ * | `[def]` | `true` or `false`; whether the field has a value at all. |
1038
+ *
1039
+ * Behavior:
1040
+ *
1041
+ * * Values are single strings, or comma-separated lists for `[in]`,
1042
+ * `[nin]`, and `[all]`. Dates accept `YYYY-MM-DD` or a full datetime
1043
+ * string. An empty value is rejected — use `[def]` to test presence.
1044
+ * * Not every operator is valid for every field; the allowed set depends
1045
+ * on the field's type. An unsupported combination returns HTTP 400
1046
+ * with the supported operators listed.
1047
+ * * Malformed keys, unknown operators, and unknown field names return
1048
+ * HTTP 400.
1049
+ *
1050
+ * Examples:
1051
+ *
1052
+ * * `filters.type[eq]=productImage` — only assets of type `productImage`.
1053
+ * * `filters.modified[gte]=2026-01-01` — modified this year.
1054
+ * * `filters.fields.altText[def]=false` — assets missing alt text.
1055
+ */
956
1056
  get: {
957
1057
  parameters: {
958
1058
  query: {
@@ -960,39 +1060,74 @@ interface paths {
960
1060
  assetId?: components["parameters"]["assetId"];
961
1061
  /** @description Specify multiple asset IDs to fetch. Response type will be a list */
962
1062
  assetIDs?: components["parameters"]["assetIDs"];
963
- /** @description Filters asset lists by the user who created them. The user is specified by their identity subject
964
- * */
1063
+ /** @description Filters asset lists by the user who created them. The user is specified by their identity subject */
965
1064
  createdBy?: components["parameters"]["createdBy"];
966
- /** @description Matches assets where their name or description contains the specified keyword.
1065
+ /**
1066
+ * @description Matches assets where their name or description contains the specified keyword.
967
1067
  * This is a list query parameter, and cannot be used with any primary query parameters
968
- * */
1068
+ */
969
1069
  keyword?: components["parameters"]["keyword"];
1070
+ /**
1071
+ * @deprecated
1072
+ * @description BETA: Semantic search using vector similarity to find assets by meaning.
1073
+ * Use this for "images of mountains" style queries.
1074
+ * Requires AI credits.
1075
+ */
1076
+ searchSemantic?: components["parameters"]["searchSemantic"];
970
1077
  /** @description Max number of records to return */
971
1078
  limit?: components["parameters"]["limit"];
972
1079
  /** @description Number of records to skip */
973
1080
  offset?: components["parameters"]["offset"];
974
- /** @description Sets the sorting of the results. If unspecified, results are sorted by name ascending
975
- * */
1081
+ /**
1082
+ * @description Sets the sorting of the results. If unspecified, results are sorted by creation date ascending.
1083
+ * 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).
1084
+ */
976
1085
  orderBy?: components["parameters"]["orderBy"];
1086
+ /**
1087
+ * @deprecated
1088
+ * @description Returns counts for distinct values of the specified field or fields (provided as comma-separated IDs).
1089
+ */
1090
+ facetBy?: components["parameters"]["facetBy"];
977
1091
  /** @description The project the asset/assets are on */
978
1092
  projectId: components["parameters"]["projectId"];
979
1093
  /** @description The asset type ID to filter by */
980
1094
  type?: components["parameters"]["type"];
981
- /** @description Filters asset lists by the user who last updated them. The user is specified by their identity subject
982
- * */
1095
+ /** @description Filters asset lists by the user who last updated them. The user is specified by their identity subject */
983
1096
  updatedBy?: components["parameters"]["updatedBy"];
984
- /** @description Controls whether the total count of results will be returned along with the current results page in a list.
1097
+ /**
1098
+ * @description Controls whether the total count of results will be returned along with the current results page in a list.
985
1099
  * Has no effect when not fetching a list. This does impact performance when enabled
986
- * */
1100
+ */
987
1101
  withTotalCount?: components["parameters"]["withTotalCount"];
988
- /** @description The ID of a release to fetch the content for.
1102
+ /**
1103
+ * @description The ID of a release to fetch the content for.
989
1104
  *
990
1105
  * - When unspecified, all release content is excluded from the result(s).
991
1106
  * - 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.
992
1107
  *
993
1108
  * 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
994
- * */
1109
+ */
995
1110
  releaseId?: components["parameters"]["releaseId"];
1111
+ /**
1112
+ * @description When true, includes full label entities in the response for UI rendering.
1113
+ * The assignedLabels array includes the label and its parent group (if any).
1114
+ * This parameter is not supported with uniform.global.
1115
+ */
1116
+ withAssignedLabels?: components["parameters"]["withAssignedLabels"];
1117
+ /**
1118
+ * @deprecated
1119
+ * @description Returns additional author and creator metadata for the asset.
1120
+ * This internal status is subject to change without notice and is thus marked deprecated to discourage use of internal data
1121
+ */
1122
+ withUIStatus?: components["parameters"]["withUIStatus"];
1123
+ /**
1124
+ * @description Controls filtering of trashed items.
1125
+ *
1126
+ * exclude: (default) Only return items not in trash.
1127
+ * only: Only return trashed items (for trash view).
1128
+ * include: Return both trashed and non-trashed items.
1129
+ */
1130
+ deleted?: components["parameters"]["deleted"];
996
1131
  };
997
1132
  header?: never;
998
1133
  path?: never;
@@ -1028,7 +1163,10 @@ interface paths {
1028
1163
  500: components["responses"]["InternalServerError"];
1029
1164
  };
1030
1165
  };
1031
- /** @description Upserts an asset */
1166
+ /**
1167
+ * @description Creates or updates assets. Submitting the ID of a trashed asset restores it.
1168
+ * A file-backed asset must include its original file reference when restored.
1169
+ */
1032
1170
  put: {
1033
1171
  parameters: {
1034
1172
  query?: never;
@@ -1070,7 +1208,10 @@ interface paths {
1070
1208
  };
1071
1209
  };
1072
1210
  post?: never;
1073
- /** @description Deletes or unpublishes an asset */
1211
+ /**
1212
+ * @description Moves an asset to trash. Trashed assets are omitted from default GET results and
1213
+ * permanently deleted after the configured retention period.
1214
+ */
1074
1215
  delete: {
1075
1216
  parameters: {
1076
1217
  query?: never;
@@ -1083,19 +1224,18 @@ interface paths {
1083
1224
  "application/json": {
1084
1225
  /**
1085
1226
  * Format: uuid
1086
- * @description The ID of the asset to delete
1227
+ * @description The ID of the asset to move to trash
1087
1228
  */
1088
1229
  assetId: string;
1089
1230
  /**
1090
1231
  * Format: uuid
1091
- * @description The ID of the project the asset to delete belongs to
1232
+ * @description The ID of the project the asset belongs to
1092
1233
  */
1093
1234
  projectId: string;
1094
1235
  /**
1095
1236
  * Format: uuid
1096
1237
  * @description The ID of the release the asset to delete belongs to. If unspecified the asset belongs to the base.
1097
1238
  * Note: deleting an asset from a release will not delete the asset from the base
1098
- *
1099
1239
  */
1100
1240
  releaseId?: string;
1101
1241
  };
@@ -1155,6 +1295,12 @@ interface components {
1155
1295
  _name: string;
1156
1296
  /** @description Name of the author of the most recent change */
1157
1297
  _author?: string;
1298
+ /** @description Identity subject of the author of the most recent change */
1299
+ _authorSubject?: string;
1300
+ /** @description Name of the original creator */
1301
+ _creator?: string;
1302
+ /** @description Identity subject of the original creator */
1303
+ _creatorSubject?: string;
1158
1304
  fields?: {
1159
1305
  title?: {
1160
1306
  value: string;
@@ -1166,8 +1312,12 @@ interface components {
1166
1312
  /** @constant */
1167
1313
  type: "text";
1168
1314
  };
1315
+ /** @description An asset can reference at most one file. A file can be attached to only one asset. */
1169
1316
  file?: {
1170
- /** Format: uuid */
1317
+ /**
1318
+ * Format: uuid
1319
+ * @description File ID to attach. A trashed file cannot be attached to an active asset.
1320
+ */
1171
1321
  value: string;
1172
1322
  /** @constant */
1173
1323
  type: "file";
@@ -1211,6 +1361,8 @@ interface components {
1211
1361
  };
1212
1362
  };
1213
1363
  _dataResources?: components["schemas"]["DataResourceDefinitions"];
1364
+ /** @description Array of label public IDs assigned to this asset (max 30) */
1365
+ labels?: string[];
1214
1366
  };
1215
1367
  /** @description Defines the shape of the asset input */
1216
1368
  AssetInput: {
@@ -1234,8 +1386,12 @@ interface components {
1234
1386
  /** @constant */
1235
1387
  type: "text";
1236
1388
  };
1389
+ /** @description An asset can reference at most one file. A file can be attached to only one asset. */
1237
1390
  file?: {
1238
- /** Format: uuid */
1391
+ /**
1392
+ * Format: uuid
1393
+ * @description File ID to attach. A trashed file cannot be attached to an active asset.
1394
+ */
1239
1395
  value: string;
1240
1396
  /** @constant */
1241
1397
  type: "file";
@@ -1250,6 +1406,8 @@ interface components {
1250
1406
  };
1251
1407
  };
1252
1408
  _dataResources?: components["schemas"]["DataResourceDefinitions"];
1409
+ /** @description Array of label public IDs assigned to this asset (max 30) */
1410
+ labels?: string[];
1253
1411
  };
1254
1412
  AssetApiResponse: {
1255
1413
  /**
@@ -1267,20 +1425,59 @@ interface components {
1267
1425
  * @description Modified date string for this definition
1268
1426
  */
1269
1427
  modified: string;
1428
+ /**
1429
+ * Format: date-time
1430
+ * @description Timestamp when the item was moved to trash. Omitted if not in trash.
1431
+ */
1432
+ deletedAt?: string;
1270
1433
  /**
1271
1434
  * Format: uuid
1272
1435
  * @description The release this asset belongs to. If not set, the asset belongs to the base
1273
1436
  */
1274
1437
  releaseId?: string;
1275
1438
  asset: components["schemas"]["Asset"];
1439
+ /** @description Full label entities for UI rendering (only present when withAssignedLabels=true). Read-only. */
1440
+ assignedLabels?: {
1441
+ [key: string]: {
1442
+ /** Format: uuid */
1443
+ projectId: string;
1444
+ label: {
1445
+ /** @description Public ID of the label (cannot be changed after creation) */
1446
+ publicId: string;
1447
+ /** @description Human readable name of the label */
1448
+ displayName: string;
1449
+ /** @description Whether this label is a group label (cannot be changed after creation) */
1450
+ isGroup: boolean;
1451
+ /** @description Public ID of the parent group label */
1452
+ parent?: string;
1453
+ /** @description Human readable color identifier */
1454
+ color: string;
1455
+ /** @description Short description of what the label is about */
1456
+ description?: string;
1457
+ /** @description Scope of the label (currently unused) */
1458
+ scope: string[];
1459
+ };
1460
+ /** Format: date-time */
1461
+ created: string;
1462
+ /** Format: date-time */
1463
+ modified: string;
1464
+ createdBy?: string;
1465
+ modifiedBy?: string;
1466
+ };
1467
+ };
1276
1468
  };
1277
1469
  AssetListResponse: {
1278
1470
  assets: components["schemas"]["AssetApiResponse"][];
1279
1471
  /** @description Total number of assets that match the query. Only present when `withTotalCount` option is true */
1280
1472
  totalCount?: number;
1473
+ /** @description Per-field counts for distinct values */
1474
+ facets?: {
1475
+ [key: string]: {
1476
+ [key: string]: number;
1477
+ };
1478
+ };
1281
1479
  };
1282
- /** @description Defines a connection to a dynamic token on a data resource
1283
- * */
1480
+ /** @description Defines a connection to a dynamic token on a data resource */
1284
1481
  DataElementConnectionDefinition: {
1285
1482
  /** @description A JSON Pointer expression that defines the data resource dynamic token value */
1286
1483
  pointer: string;
@@ -1300,7 +1497,6 @@ interface components {
1300
1497
  * NOTE: If a 'component' failure occurs on the root component of a composition, or an entry,
1301
1498
  * it is treated as an 'a' failure because removing the root means we must remove all
1302
1499
  * - 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
1303
- *
1304
1500
  * @enum {string}
1305
1501
  */
1306
1502
  failureAction?: "t" | "p" | "c" | "a";
@@ -1309,13 +1505,13 @@ interface components {
1309
1505
  * - e: ERROR: Report an error message (this will prevent publishing)
1310
1506
  * - w: WARNING: Report a warning message [default]
1311
1507
  * - i: INFO: Log an informative message (failure is expected/normal, i.e. optional data)
1312
- *
1313
1508
  * @enum {string}
1314
1509
  */
1315
1510
  failureLogLevel?: "e" | "w" | "i";
1316
- /** @description The default value to use if the dynamic token cannot be resolved.
1511
+ /**
1512
+ * @description The default value to use if the dynamic token cannot be resolved.
1317
1513
  * This is only used if the failureAction is the default (undefined, or explicitly token)
1318
- * */
1514
+ */
1319
1515
  failureDefault?: string;
1320
1516
  };
1321
1517
  /**
@@ -1325,9 +1521,10 @@ interface components {
1325
1521
  VisibilityCriteria: {
1326
1522
  /** @description The rule type to execute */
1327
1523
  rule: string;
1328
- /** @description The source value of the rule.
1524
+ /**
1525
+ * @description The source value of the rule.
1329
1526
  * 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.
1330
- * */
1527
+ */
1331
1528
  source?: string;
1332
1529
  /** @description The rule-definition-specific operator to test against */
1333
1530
  op: string;
@@ -1346,20 +1543,22 @@ interface components {
1346
1543
  op?: "&" | "|";
1347
1544
  clauses: (components["schemas"]["VisibilityCriteria"] | components["schemas"]["VisibilityCriteriaGroup"])[];
1348
1545
  };
1349
- /** @description Defines a conditional value for a component parameter
1350
- * */
1546
+ /** @description Defines a conditional value for a component parameter */
1351
1547
  ComponentParameterConditionalValue: {
1352
1548
  when: components["schemas"]["VisibilityCriteriaGroup"];
1353
- /** @description The value of the parameter. Any JSON-serializable value is acceptable.
1549
+ /**
1550
+ * @description The value of the parameter. Any JSON-serializable value is acceptable.
1354
1551
  * A value of `null` will cause the parameter value to be removed, if it matches.
1355
- * */
1552
+ */
1356
1553
  value: unknown;
1357
- /** @description Unique sequence identifier of the conditional value within the component parameter.
1554
+ /**
1555
+ * @description Unique sequence identifier of the conditional value within the component parameter.
1358
1556
  * This value must be unique within the conditional values array, and it should not change after a condition is created.
1359
- * */
1557
+ */
1360
1558
  id: number;
1361
1559
  };
1362
- /** @description Array of alternate values which are based on conditions.
1560
+ /**
1561
+ * @description Array of alternate values which are based on conditions.
1363
1562
  *
1364
1563
  * When requested with an explicit locale parameter, or via the route API:
1365
1564
  * * Conditions are evaluated sequentially and the first match is used. If a match is found, the conditions are eliminated.
@@ -1367,7 +1566,7 @@ interface components {
1367
1566
  * * If a condition cannot be evaluated yet (i.e. a client-side criteria), it is left alone.
1368
1567
  *
1369
1568
  * When no locale is passed to a non-route API, conditions are not processed and all conditions are returned.
1370
- * */
1569
+ */
1371
1570
  ComponentParameterConditions: components["schemas"]["ComponentParameterConditionalValue"][];
1372
1571
  /** @description Defines an editable parameter on a component */
1373
1572
  ComponentParameter: {
@@ -1377,15 +1576,15 @@ interface components {
1377
1576
  type: string;
1378
1577
  /** @deprecated */
1379
1578
  connectedData?: components["schemas"]["DataElementConnectionDefinition"];
1380
- /** @description Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
1579
+ /**
1580
+ * @description Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
1381
1581
  * Note that locales must be registered on the entry/composition `_locales` before being used
1382
- * */
1582
+ */
1383
1583
  locales?: {
1384
1584
  [key: string]: unknown;
1385
1585
  };
1386
1586
  conditions?: components["schemas"]["ComponentParameterConditions"];
1387
- /** @description Locale-specific conditional values for this parameter. Keys are locale codes, and values are the `conditions` for that locale.
1388
- * */
1587
+ /** @description Locale-specific conditional values for this parameter. Keys are locale codes, and values are the `conditions` for that locale. */
1389
1588
  localesConditions?: {
1390
1589
  [key: string]: components["schemas"]["ComponentParameterConditions"];
1391
1590
  };
@@ -1400,20 +1599,23 @@ interface components {
1400
1599
  type: string;
1401
1600
  /** @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 */
1402
1601
  isPatternParameter?: boolean;
1403
- /** @description When true, the default data resource of a pattern data parameter (isPatternParameter=true) will be ignored when the pattern is referenced.
1602
+ /**
1603
+ * @description When true, the default data resource of a pattern data parameter (isPatternParameter=true) will be ignored when the pattern is referenced.
1404
1604
  * Unless specifically overridden, the pattern data parameter will be provided with a null default value - leaving any data connections to it unresolvable.
1405
1605
  * If isPatternParameter is false or undefined, this has no meaning
1406
- * */
1606
+ */
1407
1607
  ignorePatternParameterDefault?: boolean;
1408
- /** @description When true, the data resource does not create an error forcing the choosing of override value when there is no default.
1608
+ /**
1609
+ * @description When true, the data resource does not create an error forcing the choosing of override value when there is no default.
1409
1610
  * If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
1410
- * */
1611
+ */
1411
1612
  optionalPatternParameter?: boolean;
1412
1613
  variables?: components["schemas"]["DataResourceVariables"];
1413
1614
  };
1414
- /** @description Data definitions attached to this component. The property name is the key of the data in the data document.
1615
+ /**
1616
+ * @description Data definitions attached to this component. The property name is the key of the data in the data document.
1415
1617
  * Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key)
1416
- * */
1618
+ */
1417
1619
  DataResourceDefinitions: {
1418
1620
  [key: string]: components["schemas"]["DataResourceDefinition"];
1419
1621
  };
@@ -1478,31 +1680,66 @@ interface components {
1478
1680
  offset: number;
1479
1681
  /** @description Max number of records to return */
1480
1682
  limit: number;
1481
- /** @description Matches assets where their name or description contains the specified keyword.
1683
+ /**
1684
+ * @description Matches assets where their name or description contains the specified keyword.
1482
1685
  * This is a list query parameter, and cannot be used with any primary query parameters
1483
- * */
1686
+ */
1484
1687
  keyword: string;
1485
- /** @description Sets the sorting of the results. If unspecified, results are sorted by name ascending
1486
- * */
1487
- orderBy: ("updated_at_DESC" | "updated_at_ASC" | "created_at_DESC" | "created_at_ASC" | "name_DESC" | "name_ASC")[];
1488
- /** @description Filters asset lists by the user who created them. The user is specified by their identity subject
1489
- * */
1688
+ /**
1689
+ * @deprecated
1690
+ * @description BETA: Semantic search using vector similarity to find assets by meaning.
1691
+ * Use this for "images of mountains" style queries.
1692
+ * Requires AI credits.
1693
+ */
1694
+ searchSemantic: string;
1695
+ /**
1696
+ * @description Sets the sorting of the results. If unspecified, results are sorted by creation date ascending.
1697
+ * 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).
1698
+ */
1699
+ orderBy: string[];
1700
+ /**
1701
+ * @deprecated
1702
+ * @description Returns counts for distinct values of the specified field or fields (provided as comma-separated IDs).
1703
+ */
1704
+ facetBy: string;
1705
+ /** @description Filters asset lists by the user who created them. The user is specified by their identity subject */
1490
1706
  createdBy: string;
1491
- /** @description Filters asset lists by the user who last updated them. The user is specified by their identity subject
1492
- * */
1707
+ /** @description Filters asset lists by the user who last updated them. The user is specified by their identity subject */
1493
1708
  updatedBy: string;
1494
- /** @description Controls whether the total count of results will be returned along with the current results page in a list.
1709
+ /**
1710
+ * @description Controls whether the total count of results will be returned along with the current results page in a list.
1495
1711
  * Has no effect when not fetching a list. This does impact performance when enabled
1496
- * */
1712
+ */
1497
1713
  withTotalCount: boolean;
1498
- /** @description The ID of a release to fetch the content for.
1714
+ /**
1715
+ * @description The ID of a release to fetch the content for.
1499
1716
  *
1500
1717
  * - When unspecified, all release content is excluded from the result(s).
1501
1718
  * - 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.
1502
1719
  *
1503
1720
  * 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
1504
- * */
1721
+ */
1505
1722
  releaseId: string;
1723
+ /**
1724
+ * @description When true, includes full label entities in the response for UI rendering.
1725
+ * The assignedLabels array includes the label and its parent group (if any).
1726
+ * This parameter is not supported with uniform.global.
1727
+ */
1728
+ withAssignedLabels: boolean;
1729
+ /**
1730
+ * @deprecated
1731
+ * @description Returns additional author and creator metadata for the asset.
1732
+ * This internal status is subject to change without notice and is thus marked deprecated to discourage use of internal data
1733
+ */
1734
+ withUIStatus: boolean;
1735
+ /**
1736
+ * @description Controls filtering of trashed items.
1737
+ *
1738
+ * exclude: (default) Only return items not in trash.
1739
+ * only: Only return trashed items (for trash view).
1740
+ * include: Return both trashed and non-trashed items.
1741
+ */
1742
+ deleted: "exclude" | "only" | "include";
1506
1743
  };
1507
1744
  requestBodies: never;
1508
1745
  headers: never;
@@ -1601,8 +1838,12 @@ declare class AssetClient extends ApiClient {
1601
1838
  constructor(options: ClientOptions & {
1602
1839
  projectId: NonNullable<ClientOptions['projectId']>;
1603
1840
  });
1604
- get(options: WithoutProjectId<AssetGetRequestSingle>): Promise<AssetGetResponseSingle>;
1605
- get(options: WithoutProjectId<AssetGetRequestList>): Promise<AssetGetResponseList>;
1841
+ get(options: WithoutProjectId<AssetGetRequestSingle> & {
1842
+ filters?: never;
1843
+ }): Promise<AssetGetResponseSingle>;
1844
+ get(options: WithoutProjectId<AssetGetRequestList> & {
1845
+ filters?: Record<string, unknown>;
1846
+ }): Promise<AssetGetResponseList>;
1606
1847
  upsert(options: WithoutProjectId<AssetUpsertRequest>): Promise<void>;
1607
1848
  delete(options: WithoutProjectId<AssetDeleteRequest>): Promise<void>;
1608
1849
  }
@@ -1619,6 +1860,7 @@ type AssetDefinition = {
1619
1860
  namePlural: string;
1620
1861
  };
1621
1862
  declare const assetDefinitions: Record<AssetDefinitionType, AssetDefinition>;
1863
+ declare const getAssetDefinitionType: (mimeType: string) => AssetDefinitionType;
1622
1864
 
1623
1865
  /**
1624
1866
  * A union type of possible query parameters for the image delivery API.
@@ -1663,19 +1905,28 @@ type ImageFromTransformProps = XOR<{
1663
1905
  y: number;
1664
1906
  };
1665
1907
  }>;
1908
+ /**
1909
+ * Fluent API for reading and transforming an asset image URL.
1910
+ */
1911
+ interface ImageFromApi {
1912
+ /** Returns the image URL with the current transformations applied. */
1913
+ url: () => string;
1914
+ /** Applies image transformations and returns the same fluent API. */
1915
+ transform: (transformProps: ImageFromTransformProps) => ImageFromApi;
1916
+ }
1666
1917
  /**
1667
1918
  * A helper function for extracting the image URL from an asset and optionally
1668
1919
  * applying transformation URL query parameters.
1669
1920
  */
1670
- declare const imageFrom: (asset: Asset | AssetParamValueItem | string) => {
1671
- url: () => string;
1672
- transform: (transformProps: ImageFromTransformProps) => /*elided*/ any;
1673
- };
1921
+ declare const imageFrom: (asset: Asset | AssetParamValueItem | string) => ImageFromApi;
1674
1922
 
1675
1923
  /**
1676
1924
  * Converts a content asset to a put content asset body that has only the properties expected to the PUT API.
1677
1925
  * Removes things like author, stats, etc.
1678
1926
  */
1679
- declare function convertAssetToPutAsset(asset: AssetGetResponseSingle): AssetUpsertRequest;
1927
+ declare function convertAssetToPutAsset(asset: {
1928
+ asset: Pick<AssetGetResponseSingle['asset'], '_id' | '_dataResources' | '_name' | 'type' | 'labels' | 'fields'>;
1929
+ projectId: string;
1930
+ }): AssetUpsertRequest;
1680
1931
 
1681
- export { type Asset, AssetClient, type AssetDefinitionType, type AssetDeleteRequest, type AssetGetRequest, type AssetGetRequestList, type AssetGetRequestSingle, type AssetGetResponse, type AssetGetResponseList, type AssetGetResponseSingle, type AssetParamValue, type AssetParamValueItem, type AssetUpsertRequest, type ImageDeliveryParams, type ImageFromTransformProps, UncachedAssetClient, assetDefinitions, convertAssetToPutAsset, imageFrom };
1932
+ export { type Asset, AssetClient, type AssetDefinitionType, type AssetDeleteRequest, type AssetGetRequest, type AssetGetRequestList, type AssetGetRequestSingle, type AssetGetResponse, type AssetGetResponseList, type AssetGetResponseSingle, type AssetParamValue, type AssetParamValueItem, type AssetUpsertRequest, type ImageDeliveryParams, type ImageFromApi, type ImageFromTransformProps, UncachedAssetClient, assetDefinitions, convertAssetToPutAsset, getAssetDefinitionType, imageFrom };