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

package/esm/v1/metadata.d.ts

@@ -32,10 +32,22 @@ export type Id1 = string;
  */
 export type CompositePrimaryKey = Id1[];
 export type Tags1 = string[];
+/**
+ * Locale string in BCP 47 format used for default label sorting.
+ */
+export type Locale = string;
 /**
  * A list of strings - metadata tags of this label.
  */
 export type Tags2 = string[];
+/**
+ * Locale string in BCP 47 format used for default label sorting.
+ */
+export type Locale1 = string;
+/**
+ * Locale string in BCP 47 format that identifies the translation.
+ */
+export type Locale2 = string;
 export type Tags3 = string[];
 export type Tags4 = string[];
 export type SourceColumn = string;
@@ -112,6 +124,10 @@ export type Id8 = string;
  * A list of strings - metadata tags of this computed attribute.
  */
 export type Tags9 = string[];
+/**
+ * An optional locale in BCP 47 format (for example en-US) whose collation order the computed values are sorted by.
+ */
+export type Locale3 = string;
 /**
  * JSON schema for Gooddata Analytics
  */
@@ -167,6 +183,10 @@ export type AttributeIdentifier = string;
  * An ID of the attribute that holds the url to be opened on interaction
  */
 export type LabelIdentifier = string;
+/**
+ * An ID of the attribute that holds the url to be opened on interaction
+ */
+export type ComputedAttributeIdentifier = string;
 /**
  * An id of the attribute that holds the label for the url to be opened on interaction
  */
@@ -175,6 +195,10 @@ export type AttributeIdentifier1 = string;
  * An id of the attribute that holds the label for the url to be opened on interaction
  */
 export type LabelIdentifier1 = string;
+/**
+ * An id of the attribute that holds the label for the url to be opened on interaction
+ */
+export type ComputedAttributeIdentifier1 = string;
 /**
  * An interaction for current widget.
  */
@@ -266,7 +290,7 @@ export type DashboardAttributeFilter1 = {
     /**
      * Attribute or label to use in this filter.
      */
-    using?: AttributeIdentifier2 | LabelIdentifier2;
+    using?: AttributeIdentifier2 | LabelIdentifier2 | ComputedAttributeIdentifier2;
     /**
      * Whether the filter should allow multiple selection
      */
@@ -301,7 +325,7 @@ export type DashboardAttributeFilter1 = {
     /**
      * Attribute or label to use in this filter.
      */
-    using?: AttributeIdentifier3 | LabelIdentifier3;
+    using?: AttributeIdentifier3 | LabelIdentifier3 | ComputedAttributeIdentifier3;
     /**
      * Whether the filter should allow multiple selection
      */
@@ -336,6 +360,10 @@ export type AttributeIdentifier2 = string;
  * Attribute or label to use in this filter.
  */
 export type LabelIdentifier2 = string;
+/**
+ * Attribute or label to use in this filter.
+ */
+export type ComputedAttributeIdentifier2 = string;
 /**
  * Configures the label used for representing attribute filter elements in UI.
  */
@@ -352,6 +380,10 @@ export type AttributeIdentifier3 = string;
  * Attribute or label to use in this filter.
  */
 export type LabelIdentifier3 = string;
+/**
+ * Attribute or label to use in this filter.
+ */
+export type ComputedAttributeIdentifier3 = string;
 /**
  * If specified, the attribute filter will display the elements in selected label form.
  */
@@ -372,6 +404,10 @@ export type AttributeIdentifier4 = string;
  * Attribute or label to use in this filter.
  */
 export type LabelIdentifier4 = string;
+/**
+ * Attribute or label to use in this filter.
+ */
+export type ComputedAttributeIdentifier4 = string;
 /**
  * Configures the label used for representing attribute filter elements in UI.
  */
@@ -388,6 +424,10 @@ export type AttributeIdentifier5 = string;
  * Attribute or label to use in this filter.
  */
 export type LabelIdentifier5 = string;
+/**
+ * Attribute or label to use in this filter.
+ */
+export type ComputedAttributeIdentifier5 = string;
 /**
  * Configures the label used for representing attribute filter elements in UI.
  */
@@ -450,11 +490,15 @@ export type Tags13 = string[];
 /**
  * The typed definition of the parameter - its data type, default value and constraints.
  */
-export type ParameterDefinition = ParameterDefinition1;
+export type ParameterDefinition = ParameterDefinition1 | ParameterDefinition2;
 /**
- * A typed parameter definition. Only textual parameters are supported as code.
+ * A typed parameter definition: textual or numeric.
  */
 export type ParameterDefinition1 = StringParameterDefinition;
+/**
+ * A typed parameter definition: textual or numeric.
+ */
+export type ParameterDefinition2 = NumberParameterDefinition;
 /**
  * JSON schema for Gooddata Analytics
  */
@@ -480,7 +524,7 @@ export type Tags14 = string[];
  * This interface was referenced by `Fields3`'s JSON-Schema definition
  * via the `patternProperty` "^(?!\.)[.A-Za-z0-9_-]\{1,255\}$".
  */
-export type Field = AttributeIdentifier7 | Field1 | Field2 | Field3 | StructuredField;
+export type Field = AttributeIdentifier7 | Field1 | Field2 | Field3 | Field4 | StructuredField;
 /**
  * A attribute identifier in the form of attribute/\{id\}.
  */
@@ -490,13 +534,17 @@ export type AttributeIdentifier7 = string;
  */
 export type Field1 = string;
 /**
- * A metric identifier in the form of metric/\{id\}.
+ * A computed attribute identifier in the form of computed_attribute/\{id\}.
  */
 export type Field2 = string;
 /**
- * A fact identifier in the form of fact/\{id\}.
+ * A metric identifier in the form of metric/\{id\}.
  */
 export type Field3 = string;
+/**
+ * A fact identifier in the form of fact/\{id\}.
+ */
+export type Field4 = string;
 export type StructuredField = AttributeFieldGuard | MetricFieldGuard | CalculatedMetricFieldGuard | InlineMetricFieldGuard | ArithmeticMetricFieldGuard | PoPMetricFieldGuard | PreviousPeriodMetricFieldGuard;
 export type AttributeFieldGuard = AttributeField | AttributeFieldGuard1;
 /**
@@ -507,6 +555,10 @@ export type AttributeIdentifier8 = string;
  * Attribute or label identifier to use for this field.
  */
 export type LabelIdentifier6 = string;
+/**
+ * Attribute or label identifier to use for this field.
+ */
+export type ComputedAttributeIdentifier6 = string;
 /**
  * Attribute or label identifier to use for this field.
  */
@@ -561,6 +613,10 @@ export type AttributeIdentifier9 = string;
  * Attribute or label to use in this filter.
  */
 export type LabelIdentifier7 = string;
+/**
+ * Attribute or label to use in this filter.
+ */
+export type ComputedAttributeIdentifier7 = string;
 /**
  * Configures the label used for representing attribute filter elements in UI.
  */
@@ -602,6 +658,10 @@ export type AttributeIdentifier10 = string;
  * Attribute or label to use in this filter.
  */
 export type LabelIdentifier8 = string;
+/**
+ * Attribute or label to use in this filter.
+ */
+export type ComputedAttributeIdentifier8 = string;
 /**
  * Configures the label used for representing attribute filter elements in UI.
  */
@@ -614,6 +674,10 @@ export type AttributeIdentifier11 = string;
  * Attribute or label to use in this filter.
  */
 export type LabelIdentifier9 = string;
+/**
+ * Attribute or label to use in this filter.
+ */
+export type ComputedAttributeIdentifier9 = string;
 /**
  * Configures the label used for representing attribute filter elements in UI.
  */
@@ -633,6 +697,10 @@ export type RangeCondition = RangeCondition1;
  * A label identifier in the form of label/\{id\}.
  */
 export type LabelIdentifier10 = string;
+/**
+ * A computed attribute identifier in the form of computed_attribute/\{id\}.
+ */
+export type ComputedAttributeIdentifier10 = string;
 export type Comparison = Comparison1;
 /**
  * Metric or local metric to use in this filter.
@@ -661,6 +729,10 @@ export type MetricIdentifier4 = string;
  * A label identifier in the form of label/\{id\}.
  */
 export type LabelIdentifier11 = string;
+/**
+ * A computed attribute identifier in the form of computed_attribute/\{id\}.
+ */
+export type ComputedAttributeIdentifier11 = string;
 /**
  * Metric identifier to use for this filter.
  */
@@ -669,6 +741,10 @@ export type MetricIdentifier5 = string;
  * A label identifier in the form of label/\{id\}.
  */
 export type LabelIdentifier12 = string;
+/**
+ * A computed attribute identifier in the form of computed_attribute/\{id\}.
+ */
+export type ComputedAttributeIdentifier12 = string;
 export type Filter6 = {
     [k: string]: unknown;
 };
@@ -703,6 +779,10 @@ export type AttributeIdentifier13 = string;
  * Local attribute or label to use in this sort.
  */
 export type LabelIdentifier14 = string;
+/**
+ * Local attribute or label to use in this sort.
+ */
+export type ComputedAttributeIdentifier13 = string;
 export type Sort2 = MetricSort;
 /**
  * A attribute identifier in the form of attribute/\{id\}.
@@ -712,6 +792,10 @@ export type AttributeIdentifier14 = string;
  * Local attribute or label to use in this sort.
  */
 export type LabelIdentifier15 = string;
+/**
+ * Local attribute or label to use in this sort.
+ */
+export type ComputedAttributeIdentifier14 = string;
 export type Sort3 = {
     [k: string]: unknown;
 };
@@ -1147,10 +1231,7 @@ export 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.
      */
@@ -1196,10 +1277,7 @@ export 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.
      */
@@ -1229,10 +1307,7 @@ export 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;
 }
 export interface Fact {
     type: "fact";
@@ -1538,9 +1613,34 @@ export 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.
      */
-    locale?: string;
+    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.
+     */
+    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;
 }
 export interface Metadata16 {
     type: "dataset" | "date" | "metric" | "computed_attribute" | "dashboard" | "plugin" | "table" | "bar_chart" | "column_chart" | "line_chart" | "area_chart" | "scatter_chart" | "bubble_chart" | "pie_chart" | "donut_chart" | "treemap_chart" | "pyramid_chart" | "funnel_chart" | "heatmap_chart" | "bullet_chart" | "waterfall_chart" | "dependency_wheel_chart" | "sankey_chart" | "headline_chart" | "combo_chart" | "geo_chart" | "geo_area_chart" | "repeater_chart" | "radar_chart" | "attribute_hierarchy" | "parameter";
@@ -1702,11 +1802,11 @@ export 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;
@@ -1930,7 +2030,7 @@ export 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;
@@ -1980,7 +2080,7 @@ export 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;
@@ -2139,6 +2239,30 @@ export interface ParameterAllowedValue {
      */
     title?: string;
 }
+/**
+ * A numeric parameter definition. Without 'constraints' the parameter accepts any number.
+ */
+export interface NumberParameterDefinition {
+    type: "NUMBER";
+    /**
+     * The value used whenever the parameter is not overridden.
+     */
+    defaultValue: number;
+    constraints?: NumberParameterConstraints;
+}
+/**
+ * Optional bounds the parameter value must satisfy.
+ */
+export interface NumberParameterConstraints {
+    /**
+     * The smallest accepted value, inclusive.
+     */
+    min?: number;
+    /**
+     * The largest accepted value, inclusive.
+     */
+    max?: number;
+}
 export interface Metadata28 {
     type: "dataset" | "date" | "metric" | "computed_attribute" | "dashboard" | "plugin" | "table" | "bar_chart" | "column_chart" | "line_chart" | "area_chart" | "scatter_chart" | "bubble_chart" | "pie_chart" | "donut_chart" | "treemap_chart" | "pyramid_chart" | "funnel_chart" | "heatmap_chart" | "bullet_chart" | "waterfall_chart" | "dependency_wheel_chart" | "sankey_chart" | "headline_chart" | "combo_chart" | "geo_chart" | "geo_area_chart" | "repeater_chart" | "radar_chart" | "attribute_hierarchy" | "parameter";
     [k: string]: unknown;
@@ -2216,7 +2340,7 @@ export interface AttributeField {
     /**
      * Attribute or label identifier to use for this field.
      */
-    using: (AttributeIdentifier8 | LabelIdentifier6 | FactIdentifier) & string;
+    using: (AttributeIdentifier8 | LabelIdentifier6 | ComputedAttributeIdentifier6 | FactIdentifier) & string;
 }
 export interface AttributeFieldGuard1 {
     /**
@@ -2271,7 +2395,7 @@ export interface AttributeFilter {
     /**
      * Attribute or label to use in this filter.
      */
-    using: AttributeIdentifier9 | LabelIdentifier7;
+    using: AttributeIdentifier9 | LabelIdentifier7 | ComputedAttributeIdentifier7;
     display_as?: DisplayAsLabelIdentifier4;
     state?: State;
 }
@@ -2284,7 +2408,7 @@ export interface AttributeFilter1 {
     /**
      * Attribute or label to use in this filter.
      */
-    using: AttributeIdentifier9 | LabelIdentifier7;
+    using: AttributeIdentifier9 | LabelIdentifier7 | ComputedAttributeIdentifier7;
     display_as?: DisplayAsLabelIdentifier4;
     state?: State;
 }
@@ -2293,7 +2417,7 @@ export 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;
@@ -2305,7 +2429,7 @@ export 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;
@@ -2329,7 +2453,7 @@ export 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)[];
 }
 export interface AllNoCondition1 {
 }
@@ -2372,7 +2496,7 @@ export 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)[];
 }
 export interface Range1 {
     type: "metric_value_filter";
@@ -2399,7 +2523,7 @@ export 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)[];
 }
 /**
  * For MVF with operator "All" (no filtering). Such filter can be present without a condition and is treated as a no-op.
@@ -2417,7 +2541,7 @@ export 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)[];
 }
 export interface BOTTOM {
     type: "ranking_filter";
@@ -2428,7 +2552,7 @@ export 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.
      */
@@ -2451,7 +2575,7 @@ export 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.
      */
@@ -2710,7 +2834,7 @@ export interface AttributeSort {
     /**
      * Local attribute or label to use in this sort.
      */
-    by: string | AttributeIdentifier13 | LabelIdentifier14;
+    by: string | AttributeIdentifier13 | LabelIdentifier14 | ComputedAttributeIdentifier13;
     /**
      * Sort direction.
      */
@@ -2734,7 +2858,7 @@ export 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.
              */
@@ -2748,7 +2872,7 @@ export 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.
              */