@gooddata/sdk-code-schemas 11.29.0-alpha.6 → 11.29.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?: (LabelIdentifier6 | string)[];
+    dimensionality?: (LabelIdentifier10 | string)[];
 }
 
 declare type AllNoCondition = AllNoCondition1;
@@ -225,7 +225,7 @@ declare interface AttributeField {
     /**
      * Attribute or label identifier to use for this field.
      */
-    using: (AttributeIdentifier6 | LabelIdentifier4 | FactIdentifier) & string;
+    using: (AttributeIdentifier8 | LabelIdentifier6 | FactIdentifier) & string;
 }
 
 declare type AttributeFieldGuard = AttributeField | AttributeFieldGuard1;
@@ -266,8 +266,8 @@ declare interface AttributeFilter {
     /**
      * Attribute or label to use in this filter.
      */
-    using: AttributeIdentifier7 | LabelIdentifier5;
-    display_as?: DisplayAsLabelIdentifier2;
+    using: AttributeIdentifier9 | LabelIdentifier7;
+    display_as?: DisplayAsLabelIdentifier4;
     state?: State;
 }
 
@@ -276,8 +276,8 @@ declare interface AttributeFilter1 {
     /**
      * Attribute or label to use in this filter.
      */
-    using: AttributeIdentifier7 | LabelIdentifier5;
-    display_as?: DisplayAsLabelIdentifier2;
+    using: AttributeIdentifier9 | LabelIdentifier7;
+    display_as?: DisplayAsLabelIdentifier4;
     state?: State;
 }
 
@@ -296,7 +296,7 @@ declare interface AttributeHierarchy {
     /**
      * A list of sorted attributes use in attribute hierarchy. The first attribute is the top level attribute.
      */
-    attributes: [AttributeIdentifier4, ...AttributeIdentifier4[]];
+    attributes: [AttributeIdentifier6, ...AttributeIdentifier6[]];
 }
 
 /**
@@ -310,20 +310,40 @@ declare type AttributeIdentifier = string;
 declare type AttributeIdentifier1 = string;
 
 /**
- * A attribute identifier in the form of attribute/\{id\}.
+ * Attribute or label to use in this filter.
  */
 declare type AttributeIdentifier10 = string;
 
 /**
- * A attribute identifier in the form of attribute/\{id\}.
+ * Attribute or label to use in this filter.
  */
 declare type AttributeIdentifier11 = string;
 
 /**
- * A attribute identifier in the form of attribute/\{id\}.
+ * Attribute identifier to use for this filter.
  */
 declare type AttributeIdentifier12 = string;
 
+/**
+ * Attribute identifier to use for this filter.
+ */
+declare type AttributeIdentifier13 = string;
+
+/**
+ * A attribute identifier in the form of attribute/\{id\}.
+ */
+declare type AttributeIdentifier14 = string;
+
+/**
+ * A attribute identifier in the form of attribute/\{id\}.
+ */
+declare type AttributeIdentifier15 = string;
+
+/**
+ * A attribute identifier in the form of attribute/\{id\}.
+ */
+declare type AttributeIdentifier16 = string;
+
 /**
  * Attribute or label to use in this filter.
  */
@@ -335,12 +355,12 @@ declare type AttributeIdentifier2 = string;
 declare type AttributeIdentifier3 = string;
 
 /**
- * A attribute identifier in the form of attribute/\{id\}.
+ * Attribute or label to use in this filter.
  */
 declare type AttributeIdentifier4 = string;
 
 /**
- * A attribute identifier in the form of attribute/\{id\}.
+ * Attribute or label to use in this filter.
  */
 declare type AttributeIdentifier5 = string;
 
@@ -350,17 +370,17 @@ declare type AttributeIdentifier5 = string;
 declare type AttributeIdentifier6 = string;
 
 /**
- * Attribute or label to use in this filter.
+ * A attribute identifier in the form of attribute/\{id\}.
  */
 declare type AttributeIdentifier7 = string;
 
 /**
- * Attribute identifier to use for this filter.
+ * A attribute identifier in the form of attribute/\{id\}.
  */
 declare type AttributeIdentifier8 = string;
 
 /**
- * Attribute identifier to use for this filter.
+ * Attribute or label to use in this filter.
  */
 declare type AttributeIdentifier9 = string;
 
@@ -369,7 +389,7 @@ declare interface AttributeSort {
     /**
      * Local attribute or label to use in this sort.
      */
-    by: string | AttributeIdentifier11 | LabelIdentifier8;
+    by: string | AttributeIdentifier15 | LabelIdentifier12;
     /**
      * Sort direction.
      */
@@ -437,7 +457,7 @@ declare interface BOTTOM {
     /**
      * Attribute identifier to use for this filter.
      */
-    attribute?: AttributeIdentifier8;
+    attribute?: AttributeIdentifier12;
     /**
      * Number of bottom N values to use in this filter.
      */
@@ -571,7 +591,7 @@ declare interface CalculatedMetricField {
     /**
      * Attribute identifier to use for this field.
      */
-    using: (AttributeIdentifier10 | FactIdentifier1 | LabelIdentifier7) & string;
+    using: (AttributeIdentifier14 | FactIdentifier1 | LabelIdentifier11) & string;
 }
 
 declare type CalculatedMetricFieldGuard = CalculatedMetricField | CalculatedMetricFieldGuard1;
@@ -730,7 +750,7 @@ declare interface Comparison1 {
     /**
      * Optional array of attribute or label references or local identifiers to apply dimensionality to the filter.
      */
-    dimensionality?: (LabelIdentifier6 | string)[];
+    dimensionality?: (LabelIdentifier10 | string)[];
 }
 
 declare type ComparisonCondition = ComparisonCondition1;
@@ -1002,16 +1022,56 @@ declare type DashboardTextFilter = DashboardTextFilter1 | DashboardTextFilter2;
 /**
  * A dashboard text filter
  */
-declare type DashboardTextFilter1 = {
-    [k: string]: unknown;
-};
+declare interface DashboardTextFilter1 {
+    /**
+     * Optional title of the filter
+     */
+    title?: string;
+    type: "text_filter";
+    /**
+     * Attribute or label to use in this filter.
+     */
+    using: AttributeIdentifier4 | LabelIdentifier4;
+    condition: "is" | "isNot";
+    values: (string | null)[];
+    case_sensitive?: boolean;
+    display_as?: DisplayAsLabelIdentifier2;
+    /**
+     * Setting filter mode to readonly will disable the filter. Setting it to hidden will hide the filter from the dashboard. Setting it to active will enable the filter.
+     */
+    mode?: "readonly" | "hidden" | "active";
+    /**
+     * An ids of the parent local attribute, text, or date filter
+     */
+    parents?: (LocalAttributeFilter2 | LocalDateFilter2)[];
+    /**
+     * An id of the attributes, labels, facts or metrics to validate the filter by
+     */
+    metric_filters?: string[];
+}
 
 /**
  * A dashboard text filter
  */
-declare type DashboardTextFilter2 = {
-    [k: string]: unknown;
-};
+declare interface DashboardTextFilter2 {
+    /**
+     * Optional title of the filter
+     */
+    title?: string;
+    type: "text_filter";
+    /**
+     * Attribute or label to use in this filter.
+     */
+    using: AttributeIdentifier5 | LabelIdentifier5;
+    condition: "contains" | "doesNotContain" | "startsWith" | "doesNotStartWith" | "endsWith" | "doesNotEndWith";
+    value: string;
+    case_sensitive?: boolean;
+    display_as?: DisplayAsLabelIdentifier3;
+    /**
+     * Setting filter mode to readonly will disable the filter. Setting it to hidden will hide the filter from the dashboard. Setting it to active will enable the filter.
+     */
+    mode?: "readonly" | "hidden" | "active";
+}
 
 declare type Dataset = NormalDataset | SQLDataset;
 
@@ -1155,6 +1215,26 @@ declare type DisplayAsLabelIdentifier1 = string;
  */
 declare type DisplayAsLabelIdentifier2 = string;
 
+/**
+ * Configures the label used for representing attribute filter elements in UI.
+ */
+declare type DisplayAsLabelIdentifier3 = string;
+
+/**
+ * Configures the label used for representing attribute filter elements in UI.
+ */
+declare type DisplayAsLabelIdentifier4 = string;
+
+/**
+ * Configures the label used for representing attribute filter elements in UI.
+ */
+declare type DisplayAsLabelIdentifier5 = string;
+
+/**
+ * Configures the label used for representing attribute filter elements in UI.
+ */
+declare type DisplayAsLabelIdentifier6 = string;
+
 declare type EmptyBucket = null;
 
 declare interface Fact {
@@ -1209,7 +1289,7 @@ declare type FactIdentifier1 = string;
  * This interface was referenced by `Fields2`'s JSON-Schema definition
  * via the `patternProperty` "^(?!\.)[.A-Za-z0-9_-]\{1,255\}$".
  */
-declare type Field = AttributeIdentifier5 | Field1 | Field2 | Field3 | StructuredField;
+declare type Field = AttributeIdentifier7 | Field1 | Field2 | Field3 | StructuredField;
 
 /**
  * A label identifier in the form of label/\{id\}.
@@ -1989,6 +2069,26 @@ declare type LabelIdentifier = string;
  */
 declare type LabelIdentifier1 = string;
 
+/**
+ * A label identifier in the form of label/\{id\}.
+ */
+declare type LabelIdentifier10 = string;
+
+/**
+ * Attribute identifier to use for this field.
+ */
+declare type LabelIdentifier11 = string;
+
+/**
+ * Local attribute or label to use in this sort.
+ */
+declare type LabelIdentifier12 = string;
+
+/**
+ * Local attribute or label to use in this sort.
+ */
+declare type LabelIdentifier13 = string;
+
 /**
  * Attribute or label to use in this filter.
  */
@@ -2000,7 +2100,7 @@ declare type LabelIdentifier2 = string;
 declare type LabelIdentifier3 = string;
 
 /**
- * Attribute or label identifier to use for this field.
+ * Attribute or label to use in this filter.
  */
 declare type LabelIdentifier4 = string;
 
@@ -2010,22 +2110,22 @@ declare type LabelIdentifier4 = string;
 declare type LabelIdentifier5 = string;
 
 /**
- * A label identifier in the form of label/\{id\}.
+ * Attribute or label identifier to use for this field.
  */
 declare type LabelIdentifier6 = string;
 
 /**
- * Attribute identifier to use for this field.
+ * Attribute or label to use in this filter.
  */
 declare type LabelIdentifier7 = string;
 
 /**
- * Local attribute or label to use in this sort.
+ * Attribute or label to use in this filter.
  */
 declare type LabelIdentifier8 = string;
 
 /**
- * Local attribute or label to use in this sort.
+ * Attribute or label to use in this filter.
  */
 declare type LabelIdentifier9 = string;
 
@@ -2117,6 +2217,11 @@ declare type LocalAttributeFilter = string;
  */
 declare type LocalAttributeFilter1 = string;
 
+/**
+ * Local attribute, text, or date filter to use as parent
+ */
+declare type LocalAttributeFilter2 = string;
+
 declare interface LocalDateFilter {
     /**
      * Local date filter to use as parent
@@ -2141,6 +2246,18 @@ declare interface LocalDateFilter1 {
     [k: string]: unknown;
 }
 
+declare interface LocalDateFilter2 {
+    /**
+     * Local date filter to use as parent
+     */
+    using: string;
+    /**
+     * Whether the parent filter is common date or special date
+     */
+    common: boolean;
+    [k: string]: unknown;
+}
+
 declare type LocationBucket = string;
 
 /**
@@ -5261,10 +5378,6 @@ export declare const metadata_v1: {
                     type: string;
                     description: string;
                 };
-                type: {
-                    type: string;
-                    enum: string[];
-                };
                 using: {
                     description: string;
                     oneOf: {
@@ -5274,21 +5387,13 @@ export declare const metadata_v1: {
                         type: string;
                     };
                 };
-                condition: {
-                    type: string;
-                    enum: string[];
-                };
-                values: {
-                    type: string;
-                    items: {
-                        type: string[];
-                    };
-                };
-                value: {
+                case_sensitive: {
                     type: string;
                 };
-                case_sensitive: {
+                display_as: {
                     type: string;
+                    description: string;
+                    $ref: string;
                 };
                 mode: {
                     type: string;
@@ -5347,19 +5452,145 @@ export declare const metadata_v1: {
                     };
                 };
             };
-            allOf: {
-                if: {
-                    properties: {
-                        condition: {
-                            enum: string[];
+            oneOf: ({
+                properties: {
+                    title: {
+                        type: string;
+                        description: string;
+                    };
+                    type: {
+                        type: string;
+                        enum: string[];
+                    };
+                    using: {
+                        description: string;
+                        oneOf: {
+                            $ref: string;
+                        }[];
+                        $semantic: {
+                            type: string;
                         };
                     };
-                    required: string[];
+                    condition: {
+                        enum: string[];
+                    };
+                    values: {
+                        type: string;
+                        items: {
+                            type: string[];
+                        };
+                    };
+                    case_sensitive: {
+                        type: string;
+                    };
+                    display_as: {
+                        type: string;
+                        description: string;
+                        $ref: string;
+                    };
+                    mode: {
+                        type: string;
+                        enum: string[];
+                        description: string;
+                    };
+                    parents: {
+                        type: string;
+                        description: string;
+                        uniqueItems: boolean;
+                        items: {
+                            oneOf: ({
+                                properties?: undefined;
+                                required?: undefined;
+                                type: string;
+                                title: string;
+                                description: string;
+                                $semantic: {
+                                    type: string;
+                                    sources: string[];
+                                };
+                            } | {
+                                $semantic?: undefined;
+                                description?: undefined;
+                                type: string;
+                                title: string;
+                                properties: {
+                                    using: {
+                                        type: string;
+                                        description: string;
+                                        $semantic: {
+                                            type: string;
+                                            source: string;
+                                        };
+                                    };
+                                    common: {
+                                        type: string;
+                                        description: string;
+                                    };
+                                };
+                                required: string[];
+                            })[];
+                        };
+                    };
+                    metric_filters: {
+                        type: string;
+                        description: string;
+                        uniqueItems: boolean;
+                        items: {
+                            type: string;
+                            $semantic: {
+                                type: string;
+                                sources: string[];
+                                typePrefix: boolean;
+                            };
+                        };
+                    };
+                    value?: undefined;
                 };
-                then: {
-                    required: string[];
+                required: string[];
+            } | {
+                properties: {
+                    values?: undefined;
+                    parents?: undefined;
+                    metric_filters?: undefined;
+                    title: {
+                        type: string;
+                        description: string;
+                    };
+                    type: {
+                        type: string;
+                        enum: string[];
+                    };
+                    using: {
+                        description: string;
+                        oneOf: {
+                            $ref: string;
+                        }[];
+                        $semantic: {
+                            type: string;
+                        };
+                    };
+                    condition: {
+                        enum: string[];
+                    };
+                    value: {
+                        type: string;
+                    };
+                    case_sensitive: {
+                        type: string;
+                    };
+                    display_as: {
+                        type: string;
+                        description: string;
+                        $ref: string;
+                    };
+                    mode: {
+                        type: string;
+                        enum: string[];
+                        description: string;
+                    };
                 };
-            }[];
+                required: string[];
+            })[];
             required: string[];
             $semantic: {
                 type: string;
@@ -5755,36 +5986,77 @@ export declare const metadata_v1: {
                         $ref: string;
                     }[];
                 };
-                condition: {
-                    type: string;
-                    enum: string[];
-                };
-                values: {
-                    type: string;
-                    items: {
-                        type: string[];
-                    };
-                };
-                value: {
+                case_sensitive: {
                     type: string;
                 };
-                case_sensitive: {
+                display_as: {
                     type: string;
+                    description: string;
+                    $ref: string;
                 };
             };
-            allOf: {
-                if: {
-                    properties: {
-                        condition: {
-                            enum: string[];
+            oneOf: ({
+                properties: {
+                    value?: undefined;
+                    type: {
+                        type: string;
+                        enum: string[];
+                    };
+                    using: {
+                        description: string;
+                        oneOf: {
+                            $ref: string;
+                        }[];
+                    };
+                    condition: {
+                        enum: string[];
+                    };
+                    values: {
+                        type: string;
+                        items: {
+                            type: string[];
                         };
                     };
-                    required: string[];
+                    case_sensitive: {
+                        type: string;
+                    };
+                    display_as: {
+                        type: string;
+                        description: string;
+                        $ref: string;
+                    };
                 };
-                then: {
-                    required: string[];
+                required: string[];
+            } | {
+                properties: {
+                    values?: undefined;
+                    type: {
+                        type: string;
+                        enum: string[];
+                    };
+                    using: {
+                        description: string;
+                        oneOf: {
+                            $ref: string;
+                        }[];
+                    };
+                    condition: {
+                        enum: string[];
+                    };
+                    value: {
+                        type: string;
+                    };
+                    case_sensitive: {
+                        type: string;
+                    };
+                    display_as: {
+                        type: string;
+                        description: string;
+                        $ref: string;
+                    };
                 };
-            }[];
+                required: string[];
+            })[];
             required: string[];
             $semantic: {
                 type: string;
@@ -5831,6 +6103,7 @@ export declare const metadata_v1: {
                     properties: {
                         from?: undefined;
                         to?: undefined;
+                        value?: undefined;
                         type: {
                             type: string;
                             enum: string[];
@@ -5880,7 +6153,6 @@ export declare const metadata_v1: {
                                 })[];
                             };
                         };
-                        value?: undefined;
                         condition?: undefined;
                     };
                     required: string[];
@@ -5973,8 +6245,8 @@ export declare const metadata_v1: {
                 then: {
                     additionalProperties: boolean;
                     properties: {
-                        conditions?: undefined;
                         value?: undefined;
+                        conditions?: undefined;
                         type: {
                             type: string;
                             enum: string[];
@@ -9066,7 +9338,7 @@ declare interface MetricSort {
         /**
          * Local attribute or label to use in this sort.
          */
-        by: string | AttributeIdentifier12 | LabelIdentifier9;
+        by: string | AttributeIdentifier16 | LabelIdentifier13;
         /**
          * Value of attribute or label to use for this sort.
          */
@@ -9080,7 +9352,7 @@ declare interface MetricSort {
         /**
          * Local attribute or label to use in this sort.
          */
-        by: string | AttributeIdentifier12 | LabelIdentifier9;
+        by: string | AttributeIdentifier16 | LabelIdentifier13;
         /**
          * Value of attribute or label to use for this sort.
          */
@@ -9116,7 +9388,7 @@ declare interface MultipleConditions1 {
     /**
      * Optional array of attribute or label references or local identifiers to apply dimensionality to the filter.
      */
-    dimensionality?: (LabelIdentifier6 | string)[];
+    dimensionality?: (LabelIdentifier10 | string)[];
 }
 
 declare interface NormalDataset {
@@ -9661,7 +9933,7 @@ declare interface Range1 {
     /**
      * Optional array of attribute or label references or local identifiers to apply dimensionality to the filter.
      */
-    dimensionality?: (LabelIdentifier6 | string)[];
+    dimensionality?: (LabelIdentifier10 | string)[];
 }
 
 declare type Range_2 = Range1;
@@ -10169,13 +10441,29 @@ declare type Tags9 = string[];
 
 declare type TextFilter = TextFilter1 | TextFilter2;
 
-declare type TextFilter1 = {
-    [k: string]: unknown;
-};
+declare interface TextFilter1 {
+    type: "text_filter";
+    /**
+     * Attribute or label to use in this filter.
+     */
+    using: AttributeIdentifier10 | LabelIdentifier8;
+    condition: "is" | "isNot";
+    values: (string | null)[];
+    case_sensitive?: boolean;
+    display_as?: DisplayAsLabelIdentifier5;
+}
 
-declare type TextFilter2 = {
-    [k: string]: unknown;
-};
+declare interface TextFilter2 {
+    type: "text_filter";
+    /**
+     * Attribute or label to use in this filter.
+     */
+    using: AttributeIdentifier11 | LabelIdentifier9;
+    condition: "contains" | "doesNotContain" | "startsWith" | "doesNotStartWith" | "endsWith" | "doesNotEndWith";
+    value: string;
+    case_sensitive?: boolean;
+    display_as?: DisplayAsLabelIdentifier6;
+}
 
 declare interface TOP {
     type: "ranking_filter";
@@ -10186,7 +10474,7 @@ declare interface TOP {
     /**
      * Attribute identifier to use for this filter.
      */
-    attribute?: AttributeIdentifier9;
+    attribute?: AttributeIdentifier13;
     /**
      * Number of bottom N values to use in this filter.
      */
@@ -10331,8 +10619,13 @@ export declare namespace v1 {
         DisplayAsLabelIdentifier1,
         LocalAttributeFilter1,
         DashboardTextFilter,
-        DashboardTextFilter1,
-        DashboardTextFilter2,
+        AttributeIdentifier4,
+        LabelIdentifier4,
+        DisplayAsLabelIdentifier2,
+        LocalAttributeFilter2,
+        AttributeIdentifier5,
+        LabelIdentifier5,
+        DisplayAsLabelIdentifier3,
         Id12,
         Id13,
         Id14,
@@ -10344,7 +10637,7 @@ export declare namespace v1 {
         Metadata20,
         Id16,
         Tags10,
-        AttributeIdentifier4,
+        AttributeIdentifier6,
         Metadata21,
         Metadata23,
         Visualisation,
@@ -10352,29 +10645,33 @@ export declare namespace v1 {
         Id17,
         Tags11,
         Field,
-        AttributeIdentifier5,
+        AttributeIdentifier7,
         Field1,
         Field2,
         Field3,
         StructuredField,
         AttributeFieldGuard,
-        AttributeIdentifier6,
-        LabelIdentifier4,
+        AttributeIdentifier8,
+        LabelIdentifier6,
         FactIdentifier,
         MetricFieldGuard,
         Filter,
         Filter1,
         DateFilter,
         DateFilter1,
-        AttributeIdentifier7,
-        LabelIdentifier5,
-        DisplayAsLabelIdentifier2,
+        AttributeIdentifier9,
+        LabelIdentifier7,
+        DisplayAsLabelIdentifier4,
         DateFilter2,
         Filter2,
         Filter3,
         TextFilter,
-        TextFilter1,
-        TextFilter2,
+        AttributeIdentifier10,
+        LabelIdentifier8,
+        DisplayAsLabelIdentifier5,
+        AttributeIdentifier11,
+        LabelIdentifier9,
+        DisplayAsLabelIdentifier6,
         Filter4,
         MetricValueFilter,
         MultipleConditions,
@@ -10383,7 +10680,7 @@ export declare namespace v1 {
         AllNoCondition,
         ComparisonCondition,
         RangeCondition,
-        LabelIdentifier6,
+        LabelIdentifier10,
         Comparison,
         MetricIdentifier1,
         Range_2 as Range,
@@ -10393,26 +10690,26 @@ export declare namespace v1 {
         Filter5,
         RankingFilter,
         MetricIdentifier4,
-        AttributeIdentifier8,
+        AttributeIdentifier12,
         MetricIdentifier5,
-        AttributeIdentifier9,
+        AttributeIdentifier13,
         Filter6,
         MetricIdentifier6,
         CalculatedMetricFieldGuard,
-        AttributeIdentifier10,
+        AttributeIdentifier14,
         FactIdentifier1,
-        LabelIdentifier7,
+        LabelIdentifier11,
         InlineMetricFieldGuard,
         ArithmeticMetricFieldGuard,
         PoPMetricFieldGuard,
         PreviousPeriodMetricFieldGuard,
         Sort,
         Sort1,
-        AttributeIdentifier11,
-        LabelIdentifier8,
+        AttributeIdentifier15,
+        LabelIdentifier12,
         Sort2,
-        AttributeIdentifier12,
-        LabelIdentifier9,
+        AttributeIdentifier16,
+        LabelIdentifier13,
         Sort3,
         Sorts,
         WidthValueOrAuto,
@@ -10542,6 +10839,9 @@ export declare namespace v1 {
         DashboardRelativeDateFilter,
         LocalDateFilter,
         LocalDateFilter1,
+        DashboardTextFilter1,
+        LocalDateFilter2,
+        DashboardTextFilter2,
         DashboardFilterGroup,
         Tab,
         DashboardFilters1,
@@ -10561,6 +10861,8 @@ export declare namespace v1 {
         AttributeFilter,
         State,
         AttributeFilter1,
+        TextFilter1,
+        TextFilter2,
         MultipleConditions1,
         AllNoCondition1,
         ComparisonCondition1,