@gooddata/sdk-code-schemas 11.56.0-alpha.6 → 11.56.0-alpha.7

package/esm/sdk-code-schemas.d.ts

@@ -62,7 +62,7 @@ declare interface All1 {
     /**
      * Optional array of attribute or label references or local identifiers to apply dimensionality to the filter.
      */
-    dimensionality?: (LabelIdentifier10 | string)[];
+    dimensionality?: (LabelIdentifier10 | ComputedAttributeIdentifier10 | string)[];
 }
 
 declare type AllNoCondition = AllNoCondition1;
@@ -196,10 +196,7 @@ declare interface Attribute {
      * Deprecated. Use 'show_in_ai_results' instead.
      */
     is_hidden?: boolean;
-    /**
-     * Locale string in BCP 47 format used for default label sorting.
-     */
-    locale?: string;
+    locale?: Locale;
     /**
      * Optional flag to indicate if the attribute can contain null values.
      */
@@ -225,7 +222,7 @@ declare interface AttributeField {
     /**
      * Attribute or label identifier to use for this field.
      */
-    using: (AttributeIdentifier8 | LabelIdentifier6 | FactIdentifier) & string;
+    using: (AttributeIdentifier8 | LabelIdentifier6 | ComputedAttributeIdentifier6 | FactIdentifier) & string;
 }
 
 declare type AttributeFieldGuard = AttributeField | AttributeFieldGuard1;
@@ -266,7 +263,7 @@ declare interface AttributeFilter {
     /**
      * Attribute or label to use in this filter.
      */
-    using: AttributeIdentifier9 | LabelIdentifier7;
+    using: AttributeIdentifier9 | LabelIdentifier7 | ComputedAttributeIdentifier7;
     display_as?: DisplayAsLabelIdentifier4;
     state?: State;
 }
@@ -276,7 +273,7 @@ declare interface AttributeFilter1 {
     /**
      * Attribute or label to use in this filter.
      */
-    using: AttributeIdentifier9 | LabelIdentifier7;
+    using: AttributeIdentifier9 | LabelIdentifier7 | ComputedAttributeIdentifier7;
     display_as?: DisplayAsLabelIdentifier4;
     state?: State;
 }
@@ -379,7 +376,7 @@ declare interface AttributeSort {
     /**
      * Local attribute or label to use in this sort.
      */
-    by: string | AttributeIdentifier13 | LabelIdentifier14;
+    by: string | AttributeIdentifier13 | LabelIdentifier14 | ComputedAttributeIdentifier13;
     /**
      * Sort direction.
      */
@@ -481,7 +478,7 @@ declare interface BOTTOM {
     /**
      * Label reference or local identifier to use for this filter.
      */
-    attribute?: LabelIdentifier11;
+    attribute?: LabelIdentifier11 | ComputedAttributeIdentifier11;
     /**
      * Number of bottom N values to use in this filter.
      */
@@ -778,7 +775,7 @@ declare interface Comparison1 {
     /**
      * Optional array of attribute or label references or local identifiers to apply dimensionality to the filter.
      */
-    dimensionality?: (LabelIdentifier10 | string)[];
+    dimensionality?: (LabelIdentifier10 | ComputedAttributeIdentifier10 | string)[];
 }
 
 declare type ComparisonCondition = ComparisonCondition1;
@@ -846,11 +843,111 @@ declare interface ComputedAttribute {
      */
     maql: string;
     /**
-     * An optional locale whose collation order the computed values are sorted by.
+     * An optional Excel-like format string applied to the computed values.
+     */
+    format?: string;
+    /**
+     * An optional categorization of the computed values semantics, for example currency.
+     */
+    metric_type?: "UNSPECIFIED" | "CURRENCY";
+    /**
+     * An optional data type of the computed values. Defaults to STRING on the backend.
+     */
+    data_type?: "INT" | "STRING" | "DATE" | "NUMERIC" | "TIMESTAMP" | "TIMESTAMP_TZ" | "BOOLEAN" | "HLL";
+    /**
+     * An optional specific type of the computed values. Defaults to TEXT on the backend.
+     */
+    value_type?: "TEXT" | "HYPERLINK" | "GEO" | "GEO_LONGITUDE" | "GEO_LATITUDE" | "GEO_AREA" | "GEO_ICON" | "IMAGE" | "HYPERLOGLOG";
+    /**
+     * Optional flag to indicate if the computed attribute can contain null values.
+     */
+    is_nullable?: boolean;
+    /**
+     * Optional value which can be used as replacement for NULL in join conditions.
      */
-    locale?: string;
+    null_value_join_replacement?: string;
+    /**
+     * Optional flag to indicate if the computed attribute should be shown in AI results. When omitted, the computed attribute is visible.
+     */
+    show_in_ai_results?: boolean;
+    locale?: Locale3;
 }
 
+/**
+ * An ID of the attribute that holds the url to be opened on interaction
+ */
+declare type ComputedAttributeIdentifier = string;
+
+/**
+ * An id of the attribute that holds the label for the url to be opened on interaction
+ */
+declare type ComputedAttributeIdentifier1 = string;
+
+/**
+ * A computed attribute identifier in the form of computed_attribute/\{id\}.
+ */
+declare type ComputedAttributeIdentifier10 = string;
+
+/**
+ * A computed attribute identifier in the form of computed_attribute/\{id\}.
+ */
+declare type ComputedAttributeIdentifier11 = string;
+
+/**
+ * A computed attribute identifier in the form of computed_attribute/\{id\}.
+ */
+declare type ComputedAttributeIdentifier12 = string;
+
+/**
+ * Local attribute or label to use in this sort.
+ */
+declare type ComputedAttributeIdentifier13 = string;
+
+/**
+ * Local attribute or label to use in this sort.
+ */
+declare type ComputedAttributeIdentifier14 = string;
+
+/**
+ * Attribute or label to use in this filter.
+ */
+declare type ComputedAttributeIdentifier2 = string;
+
+/**
+ * Attribute or label to use in this filter.
+ */
+declare type ComputedAttributeIdentifier3 = string;
+
+/**
+ * Attribute or label to use in this filter.
+ */
+declare type ComputedAttributeIdentifier4 = string;
+
+/**
+ * Attribute or label to use in this filter.
+ */
+declare type ComputedAttributeIdentifier5 = string;
+
+/**
+ * Attribute or label identifier to use for this field.
+ */
+declare type ComputedAttributeIdentifier6 = string;
+
+/**
+ * Attribute or label to use in this filter.
+ */
+declare type ComputedAttributeIdentifier7 = string;
+
+/**
+ * Attribute or label to use in this filter.
+ */
+declare type ComputedAttributeIdentifier8 = string;
+
+/**
+ * Attribute or label to use in this filter.
+ */
+declare type ComputedAttributeIdentifier9 = string;
+
 declare interface ContainerWidget {
     container: Id14;
     /**
@@ -985,7 +1082,7 @@ declare type DashboardAttributeFilter1 = {
     /**
      * Attribute or label to use in this filter.
      */
-    using?: AttributeIdentifier2 | LabelIdentifier2;
+    using?: AttributeIdentifier2 | LabelIdentifier2 | ComputedAttributeIdentifier2;
     /**
      * Whether the filter should allow multiple selection
      */
@@ -1020,7 +1117,7 @@ declare type DashboardAttributeFilter1 = {
     /**
      * Attribute or label to use in this filter.
      */
-    using?: AttributeIdentifier3 | LabelIdentifier3;
+    using?: AttributeIdentifier3 | LabelIdentifier3 | ComputedAttributeIdentifier3;
     /**
      * Whether the filter should allow multiple selection
      */
@@ -1111,7 +1208,7 @@ declare interface DashboardTextFilter1 {
     /**
      * Attribute or label to use in this filter.
      */
-    using: AttributeIdentifier4 | LabelIdentifier4;
+    using: AttributeIdentifier4 | LabelIdentifier4 | ComputedAttributeIdentifier4;
     condition: "is" | "isNot";
     values: (string | null)[];
     case_sensitive?: boolean;
@@ -1147,7 +1244,7 @@ declare interface DashboardTextFilter2 {
     /**
      * Attribute or label to use in this filter.
      */
-    using: AttributeIdentifier5 | LabelIdentifier5;
+    using: AttributeIdentifier5 | LabelIdentifier5 | ComputedAttributeIdentifier5;
     condition: "contains" | "doesNotContain" | "startsWith" | "doesNotStartWith" | "endsWith" | "doesNotEndWith";
     value: string;
     case_sensitive?: boolean;
@@ -1379,7 +1476,7 @@ declare type FactIdentifier1 = string;
  * This interface was referenced by `Fields3`'s JSON-Schema definition
  * via the `patternProperty` "^(?!\.)[.A-Za-z0-9_-]\{1,255\}$".
  */
-declare type Field = AttributeIdentifier7 | Field1 | Field2 | Field3 | StructuredField;
+declare type Field = AttributeIdentifier7 | Field1 | Field2 | Field3 | Field4 | StructuredField;
 
 /**
  * A label identifier in the form of label/\{id\}.
@@ -1387,15 +1484,20 @@ declare type Field = AttributeIdentifier7 | Field1 | Field2 | Field3 | Structure
 declare type Field1 = string;
 
 /**
- * A metric identifier in the form of metric/\{id\}.
+ * A computed attribute identifier in the form of computed_attribute/\{id\}.
  */
 declare type Field2 = string;
 
 /**
- * A fact identifier in the form of fact/\{id\}.
+ * A metric identifier in the form of metric/\{id\}.
  */
 declare type Field3 = string;
 
+/**
+ * A fact identifier in the form of fact/\{id\}.
+ */
+declare type Field4 = string;
+
 /**
  * A list of fields in this dataset.
  */
@@ -2110,11 +2212,11 @@ declare interface InteractionOpenParamUrl {
         /**
          * An ID of the attribute that holds the url to be opened on interaction
          */
-        href?: AttributeIdentifier | LabelIdentifier;
+        href?: AttributeIdentifier | LabelIdentifier | ComputedAttributeIdentifier;
         /**
          * An id of the attribute that holds the label for the url to be opened on interaction
          */
-        label?: AttributeIdentifier1 | LabelIdentifier1;
+        label?: AttributeIdentifier1 | LabelIdentifier1 | ComputedAttributeIdentifier1;
         [k: string]: unknown;
     };
     ignored_intersection_attributes?: InteractionIgnoredIntersectionAttributes;
@@ -2174,10 +2276,7 @@ declare interface Label {
      * Deprecated. Use 'show_in_ai_results' instead.
      */
     is_hidden?: boolean;
-    /**
-     * Locale string in BCP 47 format used for default label sorting.
-     */
-    locale?: string;
+    locale?: Locale1;
     /**
      * Optional list of localized source columns for this label.
      */
@@ -2277,10 +2376,7 @@ declare interface LabelTranslation {
      * Column that stores the localized label values.
      */
     source_column: string;
-    /**
-     * Locale string in BCP 47 format that identifies the translation.
-     */
-    locale: string;
+    locale: Locale2;
 }
 
 declare type LayerItem = VisualizationDataLayer | ({
@@ -2429,6 +2525,26 @@ declare interface LocalDateFilter2 {
     [k: string]: unknown;
 }
 
+/**
+ * Locale string in BCP 47 format used for default label sorting.
+ */
+declare type Locale = string;
+
+/**
+ * Locale string in BCP 47 format used for default label sorting.
+ */
+declare type Locale1 = string;
+
+/**
+ * Locale string in BCP 47 format that identifies the translation.
+ */
+declare type Locale2 = string;
+
+/**
+ * An optional locale in BCP 47 format (for example en-US) whose collation order the computed values are sorted by.
+ */
+declare type Locale3 = string;
+
 declare type LocationBucket = string;
 
 /**
@@ -2955,10 +3071,41 @@ export declare const metadata_v1: {
                             type: string;
                         };
                     };
-                    locale: {
+                    format: {
+                        type: string;
+                        description: string;
+                    };
+                    metric_type: {
+                        type: string;
+                        enum: string[];
+                        description: string;
+                    };
+                    data_type: {
+                        type: string;
+                        enum: string[];
+                        description: string;
+                    };
+                    value_type: {
+                        type: string;
+                        enum: string[];
+                        description: string;
+                    };
+                    is_nullable: {
+                        type: string;
+                        description: string;
+                    };
+                    null_value_join_replacement: {
+                        type: string;
+                        description: string;
+                    };
+                    show_in_ai_results: {
                         type: string;
                         description: string;
                     };
+                    locale: {
+                        $ref: string;
+                        description: string;
+                    };
                 };
                 $semantic: {
                     type: string;
@@ -4496,6 +4643,12 @@ export declare const metadata_v1: {
                     typePrefix: boolean;
                 };
             };
+            locale: {
+                title: string;
+                type: string;
+                pattern: string;
+                description: string;
+            };
             dashboardFilters: {
                 title: string;
                 type: string;
@@ -4602,6 +4755,17 @@ export declare const metadata_v1: {
                     typePrefix: boolean;
                 };
             };
+            computedAttributeIdentifier: {
+                title: string;
+                description: string;
+                type: string;
+                pattern: string;
+                $semantic: {
+                    type: string;
+                    source: string;
+                    typePrefix: boolean;
+                };
+            };
             queryFilters: {
                 title: string;
                 type: string;
@@ -5449,6 +5613,17 @@ export declare const metadata_v1: {
                 typePrefix: boolean;
             };
         };
+        computedAttributeIdentifier: {
+            title: string;
+            description: string;
+            type: string;
+            pattern: string;
+            $semantic: {
+                type: string;
+                source: string;
+                typePrefix: boolean;
+            };
+        };
         displayAsLabelIdentifier: {
             title: string;
             description: string;
@@ -6266,7 +6441,9 @@ export declare const metadata_v1: {
                     type: string;
                     description: string;
                     items: {
-                        $ref: string;
+                        oneOf: {
+                            $ref: string;
+                        }[];
                     };
                 };
                 null_values_as_zero: {
@@ -7259,10 +7436,41 @@ export declare const metadata_v1: {
                         type: string;
                     };
                 };
-                locale: {
+                format: {
+                    type: string;
+                    description: string;
+                };
+                metric_type: {
+                    type: string;
+                    enum: string[];
+                    description: string;
+                };
+                data_type: {
+                    type: string;
+                    enum: string[];
+                    description: string;
+                };
+                value_type: {
+                    type: string;
+                    enum: string[];
+                    description: string;
+                };
+                is_nullable: {
+                    type: string;
+                    description: string;
+                };
+                null_value_join_replacement: {
+                    type: string;
+                    description: string;
+                };
+                show_in_ai_results: {
                     type: string;
                     description: string;
                 };
+                locale: {
+                    $ref: string;
+                    description: string;
+                };
             };
             $semantic: {
                 type: string;
@@ -8918,11 +9126,6 @@ export declare const metadata_v1: {
                 code: string;
             };
         };
-        locale: {
-            type: string;
-            pattern: string;
-            description: string;
-        };
         label: {
             title: string;
             type: string;
@@ -9244,6 +9447,42 @@ export declare const metadata_v1: {
                 type: string;
             };
         };
+        numberParameterDefinition: {
+            title: string;
+            description: string;
+            type: string;
+            additionalProperties: boolean;
+            properties: {
+                type: {
+                    type: string;
+                    enum: string[];
+                };
+                defaultValue: {
+                    type: string;
+                    description: string;
+                };
+                constraints: {
+                    title: string;
+                    type: string;
+                    additionalProperties: boolean;
+                    description: string;
+                    properties: {
+                        min: {
+                            type: string;
+                            description: string;
+                        };
+                        max: {
+                            type: string;
+                            description: string;
+                        };
+                    };
+                };
+            };
+            required: string[];
+            $semantic: {
+                type: string;
+            };
+        };
         parameterAllowedValue: {
             title: string;
             type: string;
@@ -10310,7 +10549,7 @@ declare interface MetricSort {
         /**
          * Local attribute or label to use in this sort.
          */
-        by: string | AttributeIdentifier14 | LabelIdentifier15;
+        by: string | AttributeIdentifier14 | LabelIdentifier15 | ComputedAttributeIdentifier14;
         /**
          * Value of attribute or label to use for this sort.
          */
@@ -10324,7 +10563,7 @@ declare interface MetricSort {
         /**
          * Local attribute or label to use in this sort.
          */
-        by: string | AttributeIdentifier14 | LabelIdentifier15;
+        by: string | AttributeIdentifier14 | LabelIdentifier15 | ComputedAttributeIdentifier14;
         /**
          * Value of attribute or label to use for this sort.
          */
@@ -10360,7 +10599,7 @@ declare interface MultipleConditions1 {
     /**
      * Optional array of attribute or label references or local identifiers to apply dimensionality to the filter.
      */
-    dimensionality?: (LabelIdentifier10 | string)[];
+    dimensionality?: (LabelIdentifier10 | ComputedAttributeIdentifier10 | string)[];
 }
 
 declare interface NormalDataset {
@@ -10409,6 +10648,32 @@ declare interface NormalDataset {
     dataset_type?: "standard" | "auxiliary";
 }
 
+/**
+ * Optional bounds the parameter value must satisfy.
+ */
+declare interface NumberParameterConstraints {
+    /**
+     * The smallest accepted value, inclusive.
+     */
+    min?: number;
+    /**
+     * The largest accepted value, inclusive.
+     */
+    max?: number;
+}
+
+/**
+ * A numeric parameter definition. Without 'constraints' the parameter accepts any number.
+ */
+declare interface NumberParameterDefinition {
+    type: "NUMBER";
+    /**
+     * The value used whenever the parameter is not overridden.
+     */
+    defaultValue: number;
+    constraints?: NumberParameterConstraints;
+}
+
 declare interface Parameter {
     id: Id20;
     type: "parameter";
@@ -10438,13 +10703,18 @@ declare interface ParameterAllowedValue {
 /**
  * The typed definition of the parameter - its data type, default value and constraints.
  */
-declare type ParameterDefinition = ParameterDefinition1;
+declare type ParameterDefinition = ParameterDefinition1 | ParameterDefinition2;
 
 /**
- * A typed parameter definition. Only textual parameters are supported as code.
+ * A typed parameter definition: textual or numeric.
  */
 declare type ParameterDefinition1 = StringParameterDefinition;
 
+/**
+ * A typed parameter definition: textual or numeric.
+ */
+declare type ParameterDefinition2 = NumberParameterDefinition;
+
 /**
  * A permission object
  */
@@ -10999,7 +11269,7 @@ declare interface Range1 {
     /**
      * Optional array of attribute or label references or local identifiers to apply dimensionality to the filter.
      */
-    dimensionality?: (LabelIdentifier10 | string)[];
+    dimensionality?: (LabelIdentifier10 | ComputedAttributeIdentifier10 | string)[];
 }
 
 declare type Range_2 = Range1;
@@ -11566,7 +11836,7 @@ declare interface TextFilter1 {
     /**
      * Attribute or label to use in this filter.
      */
-    using: AttributeIdentifier10 | LabelIdentifier8;
+    using: AttributeIdentifier10 | LabelIdentifier8 | ComputedAttributeIdentifier8;
     condition: "is" | "isNot";
     values: (string | null)[];
     case_sensitive?: boolean;
@@ -11579,7 +11849,7 @@ declare interface TextFilter2 {
     /**
      * Attribute or label to use in this filter.
      */
-    using: AttributeIdentifier11 | LabelIdentifier9;
+    using: AttributeIdentifier11 | LabelIdentifier9 | ComputedAttributeIdentifier9;
     condition: "contains" | "doesNotContain" | "startsWith" | "doesNotStartWith" | "endsWith" | "doesNotEndWith";
     value: string;
     case_sensitive?: boolean;
@@ -11614,7 +11884,7 @@ declare interface TOP {
     /**
      * Label reference or local identifier to use for this filter.
      */
-    attribute?: LabelIdentifier12;
+    attribute?: LabelIdentifier12 | ComputedAttributeIdentifier12;
     /**
      * Number of bottom N values to use in this filter.
      */
@@ -11703,7 +11973,10 @@ export declare namespace v1 {
         Id1,
         CompositePrimaryKey,
         Tags1,
+        Locale,
         Tags2,
+        Locale1,
+        Locale2,
         Tags3,
         Tags4,
         SourceColumn,
@@ -11729,6 +12002,7 @@ export declare namespace v1 {
         Metadata14,
         Id8,
         Tags9,
+        Locale3,
         Metadata15,
         Metadata17,
         Id9,
@@ -11744,8 +12018,10 @@ export declare namespace v1 {
         Interaction2,
         AttributeIdentifier,
         LabelIdentifier,
+        ComputedAttributeIdentifier,
         AttributeIdentifier1,
         LabelIdentifier1,
+        ComputedAttributeIdentifier1,
         Interaction3,
         InteractionIgnoredDashboardFilters,
         InteractionIncludedSourceInsightFilters,
@@ -11765,19 +12041,23 @@ export declare namespace v1 {
         DashboardAttributeFilter1,
         AttributeIdentifier2,
         LabelIdentifier2,
+        ComputedAttributeIdentifier2,
         DisplayAsLabelIdentifier,
         LocalAttributeFilter,
         AttributeIdentifier3,
         LabelIdentifier3,
+        ComputedAttributeIdentifier3,
         DisplayAsLabelIdentifier1,
         LocalAttributeFilter1,
         DashboardTextFilter,
         AttributeIdentifier4,
         LabelIdentifier4,
+        ComputedAttributeIdentifier4,
         DisplayAsLabelIdentifier2,
         LocalAttributeFilter2,
         AttributeIdentifier5,
         LabelIdentifier5,
+        ComputedAttributeIdentifier5,
         DisplayAsLabelIdentifier3,
         Id15,
         Id16,
@@ -11797,6 +12077,7 @@ export declare namespace v1 {
         Tags13,
         ParameterDefinition,
         ParameterDefinition1,
+        ParameterDefinition2,
         Metadata27,
         Metadata29,
         Visualisation,
@@ -11808,10 +12089,12 @@ export declare namespace v1 {
         Field1,
         Field2,
         Field3,
+        Field4,
         StructuredField,
         AttributeFieldGuard,
         AttributeIdentifier8,
         LabelIdentifier6,
+        ComputedAttributeIdentifier6,
         FactIdentifier,
         MetricFieldGuard,
         Filter,
@@ -11820,6 +12103,7 @@ export declare namespace v1 {
         DateFilter1,
         AttributeIdentifier9,
         LabelIdentifier7,
+        ComputedAttributeIdentifier7,
         DisplayAsLabelIdentifier4,
         DateFilter2,
         Filter2,
@@ -11827,9 +12111,11 @@ export declare namespace v1 {
         TextFilter,
         AttributeIdentifier10,
         LabelIdentifier8,
+        ComputedAttributeIdentifier8,
         DisplayAsLabelIdentifier5,
         AttributeIdentifier11,
         LabelIdentifier9,
+        ComputedAttributeIdentifier9,
         DisplayAsLabelIdentifier6,
         Filter4,
         MetricValueFilter,
@@ -11840,6 +12126,7 @@ export declare namespace v1 {
         ComparisonCondition,
         RangeCondition,
         LabelIdentifier10,
+        ComputedAttributeIdentifier10,
         Comparison,
         MetricIdentifier1,
         Range_2 as Range,
@@ -11850,8 +12137,10 @@ export declare namespace v1 {
         RankingFilter,
         MetricIdentifier4,
         LabelIdentifier11,
+        ComputedAttributeIdentifier11,
         MetricIdentifier5,
         LabelIdentifier12,
+        ComputedAttributeIdentifier12,
         Filter6,
         MetricIdentifier6,
         CalculatedMetricFieldGuard,
@@ -11866,9 +12155,11 @@ export declare namespace v1 {
         Sort1,
         AttributeIdentifier13,
         LabelIdentifier14,
+        ComputedAttributeIdentifier13,
         Sort2,
         AttributeIdentifier14,
         LabelIdentifier15,
+        ComputedAttributeIdentifier14,
         Sort3,
         Sorts,
         WidthValueOrAuto,
@@ -12023,6 +12314,8 @@ export declare namespace v1 {
         StringParameterDefinition,
         StringParameterConstraints,
         ParameterAllowedValue,
+        NumberParameterDefinition,
+        NumberParameterConstraints,
         Metadata28,
         Table,
         Query,