@uniformdev/assets 20.70.0 → 20.71.0

package/dist/index.d.ts

@@ -16,22 +16,25 @@ interface components$1 {
             guidance?: string;
             /** @description Type name of the parameter (provided by a Uniform integration) */
             type: string;
-            /** @description If true, this property can have locale-specific values. If false or not defined,
+            /**
+             * @description If true, this property can have locale-specific values. If false or not defined,
              *     this property will have a single value that is shared for all locales
-             *      */
+             */
             localizable?: boolean;
-            /** @description When `localizable` is true, this property controls the default localizability of the property.
+            /**
+             * @description When `localizable` is true, this property controls the default localizability of the property.
              *     true - when the property has no existing value, it will be in 'single value' mode and not store locale specific values
              *     false/undefined - when the property has no existing value, it will store separate values for each enabled locale
              *
              *     If `localized` is false, this has no effect.
-             *      */
+             */
             notLocalizedByDefault?: boolean;
-            /** @description Enables creating additional conditional values for the parameter based on criteria such as dynamic inputs.
+            /**
+             * @description Enables creating additional conditional values for the parameter based on criteria such as dynamic inputs.
              *     When combined with a localized value, each locale has independent conditional values.
              *
              *     When not defined, conditional values are not allowed.
-             *      */
+             */
             allowConditionalValues?: boolean;
             /** @description The configuration object for the type (type-specific) */
             typeConfig?: unknown;
@@ -46,17 +49,18 @@ interface components$1 {
             /**
              * @description Whether this slot inherits its allowed components from the parent slot it lives in. If true, `allowedComponents` is irrelevant.
              *     If `allowAllComponents` is true, this value is ignored
-             *
              * @default false
              */
             inheritAllowedComponents: boolean;
-            /** @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.
+            /**
+             * @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.
              *     When true, every component and pattern that is defined may be added to this slot regardless of any other setting including `inheritAllowedComponents`
-             *      */
+             */
             allowAllComponents?: boolean;
-            /** @description When not defined, or false: all patterns for components listed in `allowedComponents` are automatically allowed in the slot.
+            /**
+             * @description When not defined, or false: all patterns for components listed in `allowedComponents` are automatically allowed in the slot.
              *     When true: patterns for components listed in `allowedComponents` are not allowed in the slot unless explicitly added to `allowedComponents` as `$p:<patternid>`
-             *      */
+             */
             patternsInAllowedComponents?: boolean;
             /** @description Minimum valid number of components in this slot */
             minComponents?: number;
@@ -70,7 +74,6 @@ interface components$1 {
              *     no: slug is optional
              *     yes: slug is required
              *     disabled: slug is disabled and will not be shown in the editor
-             *
              * @default no
              * @enum {string}
              */
@@ -80,15 +83,15 @@ interface components$1 {
              *     no = no unique constraint
              *     local = must be unique within this component type
              *     global = must be unique across all component types
-             *
              * @enum {string}
              */
             unique?: "no" | "local" | "global";
             /** @description Regular expression slugs must match */
             regularExpression?: string;
-            /** @description Custom error message when regular expression validation fails.
+            /**
+             * @description Custom error message when regular expression validation fails.
              *     Has no effect if `regularExpression` is not set
-             *      */
+             */
             regularExpressionMessage?: string;
         };
         /** @description The definition of a component variant */
@@ -103,7 +106,6 @@ interface components$1 {
             /**
              * @description Permission type for this permission ComponentDefinition:
              *     read | write | create | delete
-             *
              * @enum {string}
              */
             permission: "read" | "write" | "create" | "delete";
@@ -123,13 +125,11 @@ interface components$1 {
             /**
              * @description The public ID of the parameter whose value should be used to create a display title for this component in the UI.
              *     The parameter type must support being used as a title parameter for this to work
-             *
              * @default null
              */
             titleParameter?: string | null;
             /**
              * @description The public ID of the parameter whose value should be used as a thumbnail for compositions of this component in the UI
-             *
              * @default null
              */
             thumbnailParameter?: string | null;
@@ -179,13 +179,13 @@ interface components$1 {
             id: components$1["schemas"]["PublicIdProperty"];
             /** @description Friendly name of the content type */
             name: string;
-            /** @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.
+            /**
+             * @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.
              *     The field type must support being used as an entry name for this to work
-             *      */
+             */
             entryName?: string | null;
             /**
              * @description The public ID of the field whose value should be used as a thumbnail for entries of this content type in the UI
-             *
              * @default null
              */
             thumbnailField?: string | null;
@@ -251,20 +251,21 @@ interface components$1 {
             type: string;
             /** @deprecated */
             connectedData?: components$1["schemas"]["DataElementConnectionDefinition"];
-            /** @description Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
+            /**
+             * @description Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
              *     Note that locales must be registered on the entry/composition `_locales` before being used
-             *      */
+             */
             locales?: {
                 [key: string]: unknown;
             };
             conditions?: components$1["schemas"]["ComponentParameterConditions"];
-            /** @description Locale-specific conditional values for this parameter. Keys are locale codes, and values are the `conditions` for that locale.
-             *      */
+            /** @description Locale-specific conditional values for this parameter. Keys are locale codes, and values are the `conditions` for that locale. */
             localesConditions?: {
                 [key: string]: components$1["schemas"]["ComponentParameterConditions"];
             };
         };
-        /** @description Array of alternate values which are based on conditions.
+        /**
+         * @description Array of alternate values which are based on conditions.
          *
          *     When requested with an explicit locale parameter, or via the route API:
          *     * 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 {
          *     * If a condition cannot be evaluated yet (i.e. a client-side criteria), it is left alone.
          *
          *     When no locale is passed to a non-route API, conditions are not processed and all conditions are returned.
-         *      */
+         */
         ComponentParameterConditions: components$1["schemas"]["ComponentParameterConditionalValue"][];
-        /** @description Defines a conditional value for a component parameter
-         *      */
+        /** @description Defines a conditional value for a component parameter */
         ComponentParameterConditionalValue: {
             when: components$1["schemas"]["VisibilityCriteriaGroup"];
-            /** @description The value of the parameter. Any JSON-serializable value is acceptable.
+            /**
+             * @description The value of the parameter. Any JSON-serializable value is acceptable.
              *     A value of `null` will cause the parameter value to be removed, if it matches.
-             *      */
+             */
             value: unknown;
-            /** @description Unique sequence identifier of the conditional value within the component parameter.
+            /**
+             * @description Unique sequence identifier of the conditional value within the component parameter.
              *     This value must be unique within the conditional values array, and it should not change after a condition is created.
-             *      */
+             */
             id: number;
         };
         /**
@@ -306,17 +308,17 @@ interface components$1 {
         VisibilityCriteria: {
             /** @description The rule type to execute */
             rule: string;
-            /** @description The source value of the rule.
+            /**
+             * @description The source value of the rule.
              *     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.
-             *      */
+             */
             source?: string;
             /** @description The rule-definition-specific operator to test against */
             op: string;
             /** @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. */
             value: string | string[];
         };
-        /** @description Defines a connection to a dynamic token on a data resource
-         *      */
+        /** @description Defines a connection to a dynamic token on a data resource */
         DataElementConnectionDefinition: {
             /** @description A JSON Pointer expression that defines the data resource dynamic token value */
             pointer: string;
@@ -336,7 +338,6 @@ interface components$1 {
              *             NOTE: If a 'component' failure occurs on the root component of a composition, or an entry,
              *             it is treated as an 'a' failure because removing the root means we must remove all
              *     - 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
-             *
              * @enum {string}
              */
             failureAction?: "t" | "p" | "c" | "a";
@@ -345,13 +346,13 @@ interface components$1 {
              *     - e: ERROR: Report an error message (this will prevent publishing)
              *     - w: WARNING: Report a warning message [default]
              *     - i: INFO: Log an informative message (failure is expected/normal, i.e. optional data)
-             *
              * @enum {string}
              */
             failureLogLevel?: "e" | "w" | "i";
-            /** @description The default value to use if the dynamic token cannot be resolved.
+            /**
+             * @description The default value to use if the dynamic token cannot be resolved.
              *     This is only used if the failureAction is the default (undefined, or explicitly token)
-             *      */
+             */
             failureDefault?: string;
         };
         /** @description Defines the shape of a component instance served by the composition API */
@@ -368,23 +369,26 @@ interface components$1 {
             slots?: {
                 [key: string]: components$1["schemas"]["ComponentInstance"][];
             };
-            /** @description Unique identifier of the component within the composition.
+            /**
+             * @description Unique identifier of the component within the composition.
              *     No assumptions should be made about the format of this value other than "it will be unique."
              *     This is not returned in GET replies unless specifically requested via `withComponentIDs` API parameter.
              *     When updating or creating a composition, if you do not specify an _id for each component, one will be created and stored for you
-             *      */
+             */
             _id?: string;
             /** @description Indicates this component instance should be sourced from a pattern library pattern */
             _pattern?: string;
             _dataResources?: components$1["schemas"]["DataResourceDefinitions"];
-            /** @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
+            /**
+             * @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
              *     Means nothing for PUTs; it will be ignored
-             *      */
+             */
             _patternDataResources?: {
                 [key: string]: components$1["schemas"]["DataResourceDefinition"];
             };
             _patternError?: components$1["schemas"]["PatternError"];
-            /** @description Defines patch overrides to component IDs that live in the composition.
+            /**
+             * @description Defines patch overrides to component IDs that live in the composition.
              *     This can be used to override parameters that are defined on patterns,
              *     including nested patterns, with values that are specific to this composition.
              *     The keys in this object are component IDs.
@@ -394,22 +398,24 @@ interface components$1 {
              *
              *     NOTE: This is considered an internal data structure and is not guaranteed to be stable.
              *     Future updates that do not break the overrides-applied state of a composition may be made without notice
-             *      */
+             */
             _overrides?: {
                 [key: string]: components$1["schemas"]["ComponentOverride"];
             };
-            /** @description Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
+            /**
+             * @description Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
              *     Means nothing for PUTs; it will be ignored
-             *      */
+             */
             _patternOverrides?: {
                 [key: string]: components$1["schemas"]["ComponentOverride"];
             };
-            /** @description When used on a pattern, defines how the pattern's parameters may be overridden
+            /**
+             * @description When used on a pattern, defines how the pattern's parameters may be overridden
              *     by consumers of the pattern.
              *
              *     NOTE: This is considered an internal data structure and is not guaranteed to be stable.
              *     Future updates that do not break the overrides-applied state of a composition may be made without notice
-             *      */
+             */
             _overridability?: components$1["schemas"]["ComponentOverridability"];
             /** @description Array of locales that have data defined. Only set for pattern references or composition defaults */
             _locales?: string[];
@@ -446,15 +452,17 @@ interface components$1 {
             _creatorSubject?: string;
             /** @description Indicates this component instance should be sourced from a pattern library pattern */
             _pattern?: string;
-            /** @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
+            /**
+             * @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
              *     Means nothing for PUTs; it will be ignored
-             *      */
+             */
             _patternDataResources?: {
                 [key: string]: components$1["schemas"]["DataResourceDefinition"];
             };
             _dataResources?: components$1["schemas"]["DataResourceDefinitions"];
             _patternError?: components$1["schemas"]["PatternError"];
-            /** @description Defines patch overrides to component IDs that live in the composition.
+            /**
+             * @description Defines patch overrides to component IDs that live in the composition.
              *     This can be used to override parameters that are defined on patterns,
              *     including nested patterns, with values that are specific to this composition.
              *     The keys in this object are component IDs.
@@ -464,31 +472,34 @@ interface components$1 {
              *
              *     NOTE: This is considered an internal data structure and is not guaranteed to be stable.
              *     Future updates that do not break the overrides-applied state of a composition may be made without notice
-             *      */
+             */
             _overrides?: {
                 [key: string]: components$1["schemas"]["ComponentOverride"];
             };
-            /** @description Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
+            /**
+             * @description Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
              *     Means nothing for PUTs; it will be ignored
-             *      */
+             */
             _patternOverrides?: {
                 [key: string]: components$1["schemas"]["ComponentOverride"];
             };
-            /** @description When used on a pattern, defines how the pattern's parameters may be overridden
+            /**
+             * @description When used on a pattern, defines how the pattern's parameters may be overridden
              *     by consumers of the pattern.
              *
              *     NOTE: This is considered an internal data structure and is not guaranteed to be stable.
              *     Future updates that do not break the overrides-applied state of a composition may be made without notice
-             *      */
+             */
             _overridability?: components$1["schemas"]["ComponentOverridability"];
             /** @description Array of locales which have data defined on the composition. If empty, the current default locale implicitly has data */
             _locales?: string[];
         };
-        /** @description Defines how to override a specific component.
+        /**
+         * @description Defines how to override a specific component.
          *
          *     NOTE: This is considered an internal data structure and is not guaranteed to be stable.
          *     Future updates that do not break the overrides-applied state of a composition may be made without notice
-         *      */
+         */
         ComponentOverride: {
             parameters?: {
                 [key: string]: components$1["schemas"]["ComponentParameter"];
@@ -497,20 +508,22 @@ interface components$1 {
                 [key: string]: components$1["schemas"]["ComponentInstance"][];
             };
             variant?: string;
-            /** @description Overrides data resource definitions for a pattern component.
+            /**
+             * @description Overrides data resource definitions for a pattern component.
              *     Object keys defined under this property override the corresponding keys in the pattern's data resources.
              *     Overrides defined here replace values in either _dataResources or _patternDataResources on the target component.
-             *      */
+             */
             dataResources?: {
                 [key: string]: components$1["schemas"]["DataResourceDefinition"];
             };
         };
-        /** @description Defines how a component on a pattern may have its values overridden.
+        /**
+         * @description Defines how a component on a pattern may have its values overridden.
          *     NOTE: Data resources' overridability is defined in the data resource definition, not here.
          *
          *     NOTE: This is considered an internal data structure and is not guaranteed to be stable.
          *     Future updates that do not break the overrides-applied state of a composition may be made without notice
-         *      */
+         */
         ComponentOverridability: {
             /** @description Defines component parameter value overrides. Keys are the parameter public ID */
             parameters?: {
@@ -518,10 +531,11 @@ interface components$1 {
             };
             /** @description Allows overriding a display variant is allowed if it is defined on the component the pattern is derived from. Default = false */
             variants?: boolean;
-            /** @description If true, parameters that are not overridable will be hidden by default on pattern instances' editors.
+            /**
+             * @description If true, parameters that are not overridable will be hidden by default on pattern instances' editors.
              *     If false, all parameters will be shown on pattern instances' editors, but locked parameters will be read-only.
              *     If not set, the default is false
-             *      */
+             */
             hideLockedParameters?: boolean;
         };
         /**
@@ -529,12 +543,10 @@ interface components$1 {
          *
          *     NOTE: This is considered an internal data structure and is not guaranteed to be stable.
          *     Future updates that do not break the overrides-applied state of a composition may be made without notice
-         *
          * @enum {string}
          */
         OverrideOptions: "yes" | "no";
-        /** @description Additional set of headers, parameters, variables, etc to be used for data resolving in the context like e.g. Unpublished Data.
-         *      */
+        /** @description Additional set of headers, parameters, variables, etc to be used for data resolving in the context like e.g. Unpublished Data. */
         AlternativeDataSourceData: {
             /** @description Base resource URL of the data source. No trailing slash */
             baseUrl: string;
@@ -555,11 +567,12 @@ interface components$1 {
                 [key: string]: components$1["schemas"]["DataVariableDefinition"];
             };
         };
-        /** @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
+        /**
+         * @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
          *     These are created in the UI and shared across a whole project.
          *     NOTE: If you acquire a list of data sources or do not have manage permissions, you will receive "SECRET"
          *     for all header, parameter, and variable values to obscure the actual encrypted secret value
-         *      */
+         */
         DataSource: {
             /** @description Public ID of the data source */
             id: string;
@@ -583,15 +596,17 @@ interface components$1 {
             variables?: {
                 [key: string]: components$1["schemas"]["DataVariableDefinition"];
             };
-            /** @description Mapping of locale codes to data source locale codes. Keys are Uniform locale codes, values are data source locale codes.
+            /**
+             * @description Mapping of locale codes to data source locale codes. Keys are Uniform locale codes, values are data source locale codes.
              *     If a locale is not mapped, it will be passed through to the data source as-is
-             *      */
+             */
             localeMapping?: {
                 [key: string]: string;
             };
-            /** @description If true, data source will require additional credentials to access unpublished data.
+            /**
+             * @description If true, data source will require additional credentials to access unpublished data.
              *     If false, no additional data source credentials are required and data resources of this data source won't be able to access unpublished data.
-             *      */
+             */
             enableUnpublishedMode?: boolean;
             /** @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 */
             customPublic?: {
@@ -622,10 +637,11 @@ interface components$1 {
             displayName: string;
             /** @description Public ID of the associated data source */
             dataSourceId: string;
-            /** @description A connector-specific archetype for this data type; used to select UI as well as perform any
+            /**
+             * @description A connector-specific archetype for this data type; used to select UI as well as perform any
              *     necessary post-processing on the response. e.g. 'cms-entry', 'cms-query'. Can be undefined if
              *     no special UI or processing is required
-             *      */
+             */
             archetype?: string;
             allowedOnComponents?: string[];
             /** @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 {
             default: string;
             /** @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 */
             order?: number;
-            /** @description An optional arbitrary human readable source identifier to describe where this variable is from.
+            /**
+             * @description An optional arbitrary human readable source identifier to describe where this variable is from.
              *     Some user interfaces may group variables by source value, for example 'From URL' or 'My Integration'
-             *      */
+             */
             source?: string;
         };
-        /** @description Data definitions attached to this component. The property name is the key of the data in the data document.
+        /**
+         * @description Data definitions attached to this component. The property name is the key of the data in the data document.
          *     Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key)
-         *      */
+         */
         DataResourceDefinitions: {
             [key: string]: components$1["schemas"]["DataResourceDefinition"];
         };
@@ -705,14 +723,16 @@ interface components$1 {
             type: string;
             /** @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 */
             isPatternParameter?: boolean;
-            /** @description When true, the default data resource of a pattern data parameter (isPatternParameter=true) will be ignored when the pattern is referenced.
+            /**
+             * @description When true, the default data resource of a pattern data parameter (isPatternParameter=true) will be ignored when the pattern is referenced.
              *     Unless specifically overridden, the pattern data parameter will be provided with a null default value - leaving any data connections to it unresolvable.
              *     If isPatternParameter is false or undefined, this has no meaning
-             *      */
+             */
             ignorePatternParameterDefault?: boolean;
-            /** @description When true, the data resource does not create an error forcing the choosing of override value when there is no default.
+            /**
+             * @description When true, the data resource does not create an error forcing the choosing of override value when there is no default.
              *     If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
-             *      */
+             */
             optionalPatternParameter?: boolean;
             variables?: components$1["schemas"]["DataResourceVariables"];
         };
@@ -725,14 +745,14 @@ interface components$1 {
          *     CYCLIC: A cyclic pattern graph was detected, which could not be resolved because it would cause an infinite loop.
          *     NOTFOUND: The pattern ID referenced could not be found. It may have been deleted, en published yet.
          *     Means nothing for PUTs; it will be ignored
-         *
          * @enum {string}
          */
         PatternError: "NOTFOUND" | "CYCLIC";
         HistoryApiResponse: {
-            /** @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.
+            /**
+             * @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.
              *     If this is undefined then no more results are available
-             *      */
+             */
             cursor?: string;
             /** @description If more history is available than your plan allows, and additional entries are available by upgrading, this will be true */
             truncated?: boolean;
@@ -772,9 +792,10 @@ interface components$1 {
              * @description Unique identifier for the project map node
              */
             id: string;
-            /** @description Fallback path of the project map node.
+            /**
+             * @description Fallback path of the project map node.
              *     Note that the node may have matched via a locale-specific path which is in the `locales` object
-             *      */
+             */
             path: string;
             /**
              * Format: uuid
@@ -782,15 +803,15 @@ interface components$1 {
              */
             projectMapId: string;
             data?: components$1["schemas"]["ProjectMapNodeData"];
-            /** @description Locale-specific paths of the project map node.
+            /**
+             * @description Locale-specific paths of the project map node.
              *     Keys are locale codes
-             *      */
+             */
             locales?: {
                 [key: string]: {
                     /** @description Locale-specific path of the project map node */
                     path: string;
-                    /** @description Whether the path is inherited from a parent node which defined a path segment in this locale
-                     *      */
+                    /** @description Whether the path is inherited from a parent node which defined a path segment in this locale */
                     inherited: boolean;
                 };
             };
@@ -841,44 +862,50 @@ interface components$1 {
             modified?: string;
             /** @description Created ISO date string for this definition (ignored for writes) */
             created?: string;
-            /** @description Name of the original creator of the workflow.
+            /**
+             * @description Name of the original creator of the workflow.
              *     If undefined, the user has been removed from the team.
              *     Ignored for writes
-             *      */
+             */
             createdBy?: string;
-            /** @description Name of the last modifier of the workflow.
+            /**
+             * @description Name of the last modifier of the workflow.
              *     If undefined, the user has been removed from the team.
              *     Ignored for writes
-             *      */
+             */
             modifiedBy?: string;
         };
         /** @description Definition of a stage in a workflow */
         WorkflowStage: {
             /** @description Name of the stage */
             name: string;
-            /** @description Defines roles which have permissions to this workflow stage
+            /**
+             * @description Defines roles which have permissions to this workflow stage
              *     NOTE: Being able to write or publish to entities in a workflow stage requires both core write or publish permissions,
              *     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
              *     listed here, the stage is read-only and publishing is disabled
-             *      */
+             */
             permissions: {
                 [key: string]: components$1["schemas"]["WorkflowStagePermission"];
             };
-            /** @description When true, transitioning into this stage from a different stage will automatically publish the entity.
+            /**
+             * @description When true, transitioning into this stage from a different stage will automatically publish the entity.
              *     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.
              *     Setting this to true is equivalent to setting requireValidity to true, as publishing cannot be performed with validation errors.
              *     NOTE: This is not executed by direct API calls. Only the Uniform UI performs this action
-             *      */
+             */
             autoPublish?: boolean;
-            /** @description When true, transitioning into this stage from a different stage will require the entity to have no validation errors.
+            /**
+             * @description When true, transitioning into this stage from a different stage will require the entity to have no validation errors.
              *     If the entity is not valid, the transition will not be allowed.
              *     NOTE: This is not executed by direct API calls. Only the Uniform UI performs this action
-             *      */
+             */
             requireValidity?: boolean;
-            /** @description Defines transitions to other stages
+            /**
+             * @description Defines transitions to other stages
              *     Every stage must define at least one transition, to avoid creating a workflow that
              *     has a stage that can never be escaped
-             *      */
+             */
             transitions: components$1["schemas"]["WorkflowStageTransition"][];
             /**
              * @description Icon name for the stage (e.g. 'chevron-double-right-o')
@@ -895,13 +922,15 @@ interface components$1 {
              * @description The target stage to transition to
              */
             to: string;
-            /** @description Name shown to the user when they execute this transition.
+            /**
+             * @description Name shown to the user when they execute this transition.
              *     If not provided, a default name will be assigned automatically based on the target stage
-             *      */
+             */
             name: string;
-            /** @description Permissions for the stage transition.
+            /**
+             * @description Permissions for the stage transition.
              *     NOTE: Users without membership in any role listed here will be unable to execute the transition unless they are team admins
-             *      */
+             */
             permissions: {
                 [key: string]: components$1["schemas"]["WorkflowStageTransitionPermission"];
             };
@@ -949,10 +978,11 @@ interface components$1 {
             isSearchHit?: boolean;
             /** @description Query strings that are allowed to be passed to the node */
             queryStrings?: components$1["schemas"]["ProjectMapNodeAllowedQueryString"][];
-            /** @description For dynamic nodes, this is the preview value for the dynamic value.
+            /**
+             * @description For dynamic nodes, this is the preview value for the dynamic value.
              *     The preview value is used when editing a connected composition, and is the default
              *     dynamic node value unless the author has explicitly chosen a different value
-             *      */
+             */
             previewValue?: string;
         };
     };
@@ -978,28 +1008,28 @@ interface paths {
                     assetId?: components["parameters"]["assetId"];
                     /** @description Specify multiple asset IDs to fetch. Response type will be a list */
                     assetIDs?: components["parameters"]["assetIDs"];
-                    /** @description Filters asset lists by the user who created them. The user is specified by their identity subject
-                     *      */
+                    /** @description Filters asset lists by the user who created them. The user is specified by their identity subject */
                     createdBy?: components["parameters"]["createdBy"];
-                    /** @description Matches assets where their name or description contains the specified keyword.
+                    /**
+                     * @description Matches assets where their name or description contains the specified keyword.
                      *     This is a list query parameter, and cannot be used with any primary query parameters
-                     *      */
+                     */
                     keyword?: components["parameters"]["keyword"];
                     /**
                      * @deprecated
                      * @description BETA: Semantic search using vector similarity to find assets by meaning.
                      *     Use this for "images of mountains" style queries.
                      *     Requires AI credits.
-                     *
                      */
                     searchSemantic?: components["parameters"]["searchSemantic"];
                     /** @description Max number of records to return */
                     limit?: components["parameters"]["limit"];
                     /** @description Number of records to skip */
                     offset?: components["parameters"]["offset"];
-                    /** @description Sets the sorting of the results. If unspecified, results are sorted by creation date ascending.
+                    /**
+                     * @description Sets the sorting of the results. If unspecified, results are sorted by creation date ascending.
                      *     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).
-                     *      */
+                     */
                     orderBy?: components["parameters"]["orderBy"];
                     /**
                      * @deprecated
@@ -1010,31 +1040,32 @@ interface paths {
                     projectId: components["parameters"]["projectId"];
                     /** @description The asset type ID to filter by */
                     type?: components["parameters"]["type"];
-                    /** @description Filters asset lists by the user who last updated them. The user is specified by their identity subject
-                     *      */
+                    /** @description Filters asset lists by the user who last updated them. The user is specified by their identity subject */
                     updatedBy?: components["parameters"]["updatedBy"];
-                    /** @description Controls whether the total count of results will be returned along with the current results page in a list.
+                    /**
+                     * @description Controls whether the total count of results will be returned along with the current results page in a list.
                      *     Has no effect when not fetching a list. This does impact performance when enabled
-                     *      */
+                     */
                     withTotalCount?: components["parameters"]["withTotalCount"];
-                    /** @description The ID of a release to fetch the content for.
+                    /**
+                     * @description The ID of a release to fetch the content for.
                      *
                      *     - When unspecified, all release content is excluded from the result(s).
                      *     - 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.
                      *
                      *     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
-                     *      */
+                     */
                     releaseId?: components["parameters"]["releaseId"];
-                    /** @description When true, includes full label entities in the response for UI rendering.
+                    /**
+                     * @description When true, includes full label entities in the response for UI rendering.
                      *     The assignedLabels array includes the label and its parent group (if any).
                      *     This parameter is not supported with uniform.global.
-                     *      */
+                     */
                     withAssignedLabels?: components["parameters"]["withAssignedLabels"];
                     /**
                      * @deprecated
                      * @description Returns additional author and creator metadata for the asset.
                      *     This internal status is subject to change without notice and is thus marked deprecated to discourage use of internal data
-                     *
                      */
                     withUIStatus?: components["parameters"]["withUIStatus"];
                 };
@@ -1139,7 +1170,6 @@ interface paths {
                          * Format: uuid
                          * @description The ID of the release the asset to delete belongs to. If unspecified the asset belongs to the base.
                          *     Note: deleting an asset from a release will not delete the asset from the base
-                         *
                          */
                         releaseId?: string;
                     };
@@ -1368,8 +1398,7 @@ interface components {
                 };
             };
         };
-        /** @description Defines a connection to a dynamic token on a data resource
-         *      */
+        /** @description Defines a connection to a dynamic token on a data resource */
         DataElementConnectionDefinition: {
             /** @description A JSON Pointer expression that defines the data resource dynamic token value */
             pointer: string;
@@ -1389,7 +1418,6 @@ interface components {
              *             NOTE: If a 'component' failure occurs on the root component of a composition, or an entry,
              *             it is treated as an 'a' failure because removing the root means we must remove all
              *     - 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
-             *
              * @enum {string}
              */
             failureAction?: "t" | "p" | "c" | "a";
@@ -1398,13 +1426,13 @@ interface components {
              *     - e: ERROR: Report an error message (this will prevent publishing)
              *     - w: WARNING: Report a warning message [default]
              *     - i: INFO: Log an informative message (failure is expected/normal, i.e. optional data)
-             *
              * @enum {string}
              */
             failureLogLevel?: "e" | "w" | "i";
-            /** @description The default value to use if the dynamic token cannot be resolved.
+            /**
+             * @description The default value to use if the dynamic token cannot be resolved.
              *     This is only used if the failureAction is the default (undefined, or explicitly token)
-             *      */
+             */
             failureDefault?: string;
         };
         /**
@@ -1414,9 +1442,10 @@ interface components {
         VisibilityCriteria: {
             /** @description The rule type to execute */
             rule: string;
-            /** @description The source value of the rule.
+            /**
+             * @description The source value of the rule.
              *     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.
-             *      */
+             */
             source?: string;
             /** @description The rule-definition-specific operator to test against */
             op: string;
@@ -1435,20 +1464,22 @@ interface components {
             op?: "&" | "|";
             clauses: (components["schemas"]["VisibilityCriteria"] | components["schemas"]["VisibilityCriteriaGroup"])[];
         };
-        /** @description Defines a conditional value for a component parameter
-         *      */
+        /** @description Defines a conditional value for a component parameter */
         ComponentParameterConditionalValue: {
             when: components["schemas"]["VisibilityCriteriaGroup"];
-            /** @description The value of the parameter. Any JSON-serializable value is acceptable.
+            /**
+             * @description The value of the parameter. Any JSON-serializable value is acceptable.
              *     A value of `null` will cause the parameter value to be removed, if it matches.
-             *      */
+             */
             value: unknown;
-            /** @description Unique sequence identifier of the conditional value within the component parameter.
+            /**
+             * @description Unique sequence identifier of the conditional value within the component parameter.
              *     This value must be unique within the conditional values array, and it should not change after a condition is created.
-             *      */
+             */
             id: number;
         };
-        /** @description Array of alternate values which are based on conditions.
+        /**
+         * @description Array of alternate values which are based on conditions.
          *
          *     When requested with an explicit locale parameter, or via the route API:
          *     * Conditions are evaluated sequentially and the first match is used. If a match is found, the conditions are eliminated.
@@ -1456,7 +1487,7 @@ interface components {
          *     * If a condition cannot be evaluated yet (i.e. a client-side criteria), it is left alone.
          *
          *     When no locale is passed to a non-route API, conditions are not processed and all conditions are returned.
-         *      */
+         */
         ComponentParameterConditions: components["schemas"]["ComponentParameterConditionalValue"][];
         /** @description Defines an editable parameter on a component */
         ComponentParameter: {
@@ -1466,15 +1497,15 @@ interface components {
             type: string;
             /** @deprecated */
             connectedData?: components["schemas"]["DataElementConnectionDefinition"];
-            /** @description Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
+            /**
+             * @description Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
              *     Note that locales must be registered on the entry/composition `_locales` before being used
-             *      */
+             */
             locales?: {
                 [key: string]: unknown;
             };
             conditions?: components["schemas"]["ComponentParameterConditions"];
-            /** @description Locale-specific conditional values for this parameter. Keys are locale codes, and values are the `conditions` for that locale.
-             *      */
+            /** @description Locale-specific conditional values for this parameter. Keys are locale codes, and values are the `conditions` for that locale. */
             localesConditions?: {
                 [key: string]: components["schemas"]["ComponentParameterConditions"];
             };
@@ -1489,20 +1520,23 @@ interface components {
             type: string;
             /** @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 */
             isPatternParameter?: boolean;
-            /** @description When true, the default data resource of a pattern data parameter (isPatternParameter=true) will be ignored when the pattern is referenced.
+            /**
+             * @description When true, the default data resource of a pattern data parameter (isPatternParameter=true) will be ignored when the pattern is referenced.
              *     Unless specifically overridden, the pattern data parameter will be provided with a null default value - leaving any data connections to it unresolvable.
              *     If isPatternParameter is false or undefined, this has no meaning
-             *      */
+             */
             ignorePatternParameterDefault?: boolean;
-            /** @description When true, the data resource does not create an error forcing the choosing of override value when there is no default.
+            /**
+             * @description When true, the data resource does not create an error forcing the choosing of override value when there is no default.
              *     If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
-             *      */
+             */
             optionalPatternParameter?: boolean;
             variables?: components["schemas"]["DataResourceVariables"];
         };
-        /** @description Data definitions attached to this component. The property name is the key of the data in the data document.
+        /**
+         * @description Data definitions attached to this component. The property name is the key of the data in the data document.
          *     Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key)
-         *      */
+         */
         DataResourceDefinitions: {
             [key: string]: components["schemas"]["DataResourceDefinition"];
         };
@@ -1567,55 +1601,56 @@ interface components {
         offset: number;
         /** @description Max number of records to return */
         limit: number;
-        /** @description Matches assets where their name or description contains the specified keyword.
+        /**
+         * @description Matches assets where their name or description contains the specified keyword.
          *     This is a list query parameter, and cannot be used with any primary query parameters
-         *      */
+         */
         keyword: string;
         /**
          * @deprecated
          * @description BETA: Semantic search using vector similarity to find assets by meaning.
          *     Use this for "images of mountains" style queries.
          *     Requires AI credits.
-         *
          */
         searchSemantic: string;
-        /** @description Sets the sorting of the results. If unspecified, results are sorted by creation date ascending.
+        /**
+         * @description Sets the sorting of the results. If unspecified, results are sorted by creation date ascending.
          *     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).
-         *      */
+         */
         orderBy: string[];
         /**
          * @deprecated
          * @description Returns counts for distinct values of the specified field or fields (provided as comma-separated IDs).
          */
         facetBy: string;
-        /** @description Filters asset lists by the user who created them. The user is specified by their identity subject
-         *      */
+        /** @description Filters asset lists by the user who created them. The user is specified by their identity subject */
         createdBy: string;
-        /** @description Filters asset lists by the user who last updated them. The user is specified by their identity subject
-         *      */
+        /** @description Filters asset lists by the user who last updated them. The user is specified by their identity subject */
         updatedBy: string;
-        /** @description Controls whether the total count of results will be returned along with the current results page in a list.
+        /**
+         * @description Controls whether the total count of results will be returned along with the current results page in a list.
          *     Has no effect when not fetching a list. This does impact performance when enabled
-         *      */
+         */
         withTotalCount: boolean;
-        /** @description The ID of a release to fetch the content for.
+        /**
+         * @description The ID of a release to fetch the content for.
          *
          *     - When unspecified, all release content is excluded from the result(s).
          *     - 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.
          *
          *     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
-         *      */
+         */
         releaseId: string;
-        /** @description When true, includes full label entities in the response for UI rendering.
+        /**
+         * @description When true, includes full label entities in the response for UI rendering.
          *     The assignedLabels array includes the label and its parent group (if any).
          *     This parameter is not supported with uniform.global.
-         *      */
+         */
         withAssignedLabels: boolean;
         /**
          * @deprecated
          * @description Returns additional author and creator metadata for the asset.
          *     This internal status is subject to change without notice and is thus marked deprecated to discourage use of internal data
-         *
          */
         withUIStatus: boolean;
     };