@gooddata/api-client-tiger 10.33.0-alpha.8 → 10.33.0-alpha.81

package/esm/generated/automation-json-api/openapi-spec.json

@@ -476,6 +476,13 @@
                             "$ref": "#/components/schemas/AutomationSlidesExport"
                         }
                     },
+                    "dashboardTabularExports": {
+                        "uniqueItems": true,
+                        "type": "array",
+                        "items": {
+                            "$ref": "#/components/schemas/AutomationDashboardTabularExport"
+                        }
+                    },
                     "externalRecipients": {
                         "uniqueItems": true,
                         "type": "array",
@@ -750,6 +757,45 @@
                 },
                 "description": "Metric representing arithmetics between other metrics."
             },
+            "AttributeElements": {
+                "type": "object",
+                "oneOf": [
+                    {
+                        "$ref": "#/components/schemas/AttributeElementsByRef"
+                    },
+                    {
+                        "$ref": "#/components/schemas/AttributeElementsByValue"
+                    }
+                ]
+            },
+            "AttributeElementsByRef": {
+                "required": ["uris"],
+                "type": "object",
+                "properties": {
+                    "uris": {
+                        "type": "array",
+                        "description": "List of attribute elements by reference",
+                        "items": {
+                            "type": "string",
+                            "nullable": true
+                        }
+                    }
+                }
+            },
+            "AttributeElementsByValue": {
+                "required": ["values"],
+                "type": "object",
+                "properties": {
+                    "values": {
+                        "type": "array",
+                        "description": "List of attribute elements by value",
+                        "items": {
+                            "type": "string",
+                            "nullable": true
+                        }
+                    }
+                }
+            },
             "AttributeFilter": {
                 "type": "object",
                 "description": "Abstract filter definition type attributes",
@@ -762,6 +808,18 @@
                     }
                 ]
             },
+            "AttributeFilterByDate": {
+                "required": ["filterLocalIdentifier", "isCommonDate"],
+                "type": "object",
+                "properties": {
+                    "filterLocalIdentifier": {
+                        "type": "string"
+                    },
+                    "isCommonDate": {
+                        "type": "boolean"
+                    }
+                }
+            },
             "AttributeFilterElements": {
                 "required": ["values"],
                 "type": "object",
@@ -779,6 +837,18 @@
                 },
                 "description": "Filter on specific set of label values."
             },
+            "AttributeFilterParent": {
+                "required": ["filterLocalIdentifier", "over"],
+                "type": "object",
+                "properties": {
+                    "filterLocalIdentifier": {
+                        "type": "string"
+                    },
+                    "over": {
+                        "$ref": "#/components/schemas/Over"
+                    }
+                }
+            },
             "AttributeItem": {
                 "required": ["label", "localIdentifier"],
                 "type": "object",
@@ -827,6 +897,15 @@
                     }
                 }
             },
+            "AutomationDashboardTabularExport": {
+                "required": ["requestPayload"],
+                "type": "object",
+                "properties": {
+                    "requestPayload": {
+                        "$ref": "#/components/schemas/DashboardTabularExportRequestV2"
+                    }
+                }
+            },
             "AutomationExternalRecipient": {
                 "required": ["email"],
                 "type": "object",
@@ -900,6 +979,52 @@
                     }
                 }
             },
+            "BoundedFilter": {
+                "required": ["dataset", "granularity"],
+                "type": "object",
+                "properties": {
+                    "dataset": {
+                        "$ref": "#/components/schemas/AfmObjectIdentifierDataset"
+                    },
+                    "granularity": {
+                        "type": "string",
+                        "description": "Date granularity specifying particular date attribute in given dimension.",
+                        "example": "DAY",
+                        "enum": [
+                            "MINUTE",
+                            "HOUR",
+                            "DAY",
+                            "WEEK",
+                            "MONTH",
+                            "QUARTER",
+                            "YEAR",
+                            "MINUTE_OF_HOUR",
+                            "HOUR_OF_DAY",
+                            "DAY_OF_WEEK",
+                            "DAY_OF_MONTH",
+                            "DAY_OF_YEAR",
+                            "WEEK_OF_YEAR",
+                            "MONTH_OF_YEAR",
+                            "QUARTER_OF_YEAR"
+                        ]
+                    },
+                    "from": {
+                        "type": "integer",
+                        "description": "Start of the filtering interval. Specified by number of periods (with respect to given granularity). Typically negative (historical time interval like -2 for '2 days/weeks, ... ago'). If null, then start of the range is unbounded.",
+                        "format": "int32",
+                        "nullable": true,
+                        "example": -6
+                    },
+                    "to": {
+                        "type": "integer",
+                        "description": "End of the filtering interval. Specified by number of periods (with respect to given granularity). Value 'O' is representing current time-interval (current day, week, ...). If null, then end of the range is unbounded.",
+                        "format": "int32",
+                        "nullable": true,
+                        "example": 0
+                    }
+                },
+                "description": "Bounding filter for this relative date filter. This can be used to limit the range of the relative date filter to a specific date range."
+            },
             "Comparison": {
                 "required": ["left", "operator", "right"],
                 "type": "object",
@@ -1028,6 +1153,201 @@
                 },
                 "description": "Custom cell value overrides (IDs will be replaced with specified values)."
             },
+            "DashboardAttributeFilter": {
+                "required": ["attributeFilter"],
+                "type": "object",
+                "properties": {
+                    "attributeFilter": {
+                        "required": ["attributeElements", "displayForm", "negativeSelection"],
+                        "type": "object",
+                        "properties": {
+                            "displayForm": {
+                                "$ref": "#/components/schemas/IdentifierRef"
+                            },
+                            "negativeSelection": {
+                                "type": "boolean"
+                            },
+                            "attributeElements": {
+                                "$ref": "#/components/schemas/AttributeElements"
+                            },
+                            "filterElementsBy": {
+                                "type": "array",
+                                "items": {
+                                    "$ref": "#/components/schemas/AttributeFilterParent"
+                                }
+                            },
+                            "filterElementsByDate": {
+                                "type": "array",
+                                "items": {
+                                    "$ref": "#/components/schemas/AttributeFilterByDate"
+                                }
+                            },
+                            "validateElementsBy": {
+                                "type": "array",
+                                "items": {
+                                    "$ref": "#/components/schemas/IdentifierRef"
+                                }
+                            },
+                            "title": {
+                                "type": "string"
+                            },
+                            "selectionMode": {
+                                "type": "string",
+                                "enum": ["single", "multi"]
+                            },
+                            "localIdentifier": {
+                                "type": "string"
+                            }
+                        }
+                    }
+                }
+            },
+            "DashboardDateFilter": {
+                "required": ["dateFilter"],
+                "type": "object",
+                "properties": {
+                    "dateFilter": {
+                        "required": ["granularity", "type"],
+                        "type": "object",
+                        "properties": {
+                            "type": {
+                                "type": "string",
+                                "enum": ["relative", "absolute"]
+                            },
+                            "granularity": {
+                                "type": "string",
+                                "enum": [
+                                    "ALL_TIME_GRANULARITY",
+                                    "GDC.time.year",
+                                    "GDC.time.week_us",
+                                    "GDC.time.week_in_year",
+                                    "GDC.time.week_in_quarter",
+                                    "GDC.time.week",
+                                    "GDC.time.euweek_in_year",
+                                    "GDC.time.euweek_in_quarter",
+                                    "GDC.time.quarter",
+                                    "GDC.time.quarter_in_year",
+                                    "GDC.time.month",
+                                    "GDC.time.month_in_quarter",
+                                    "GDC.time.month_in_year",
+                                    "GDC.time.day_in_year",
+                                    "GDC.time.day_in_quarter",
+                                    "GDC.time.day_in_month",
+                                    "GDC.time.day_in_week",
+                                    "GDC.time.day_in_euweek",
+                                    "GDC.time.date",
+                                    "GDC.time.hour",
+                                    "GDC.time.hour_in_day",
+                                    "GDC.time.minute",
+                                    "GDC.time.minute_in_hour"
+                                ]
+                            },
+                            "from": {
+                                "oneOf": [
+                                    {
+                                        "type": "string"
+                                    },
+                                    {
+                                        "type": "integer",
+                                        "format": "int32"
+                                    }
+                                ]
+                            },
+                            "to": {
+                                "oneOf": [
+                                    {
+                                        "type": "string"
+                                    },
+                                    {
+                                        "type": "integer",
+                                        "format": "int32"
+                                    }
+                                ]
+                            },
+                            "dataSet": {
+                                "$ref": "#/components/schemas/IdentifierRef"
+                            },
+                            "attribute": {
+                                "$ref": "#/components/schemas/IdentifierRef"
+                            },
+                            "localIdentifier": {
+                                "type": "string"
+                            }
+                        }
+                    }
+                }
+            },
+            "DashboardExportSettings": {
+                "type": "object",
+                "properties": {
+                    "exportInfo": {
+                        "type": "boolean",
+                        "description": "If true, the export will contain the information about the exported date and dashboard filters.",
+                        "example": true,
+                        "default": false
+                    },
+                    "mergeHeaders": {
+                        "type": "boolean",
+                        "description": "Merge equal headers in neighbouring cells. Used for [XLSX] format only.",
+                        "example": true,
+                        "default": false
+                    }
+                },
+                "description": "Additional settings."
+            },
+            "DashboardFilter": {
+                "type": "object",
+                "oneOf": [
+                    {
+                        "$ref": "#/components/schemas/DashboardAttributeFilter"
+                    },
+                    {
+                        "$ref": "#/components/schemas/DashboardDateFilter"
+                    }
+                ]
+            },
+            "DashboardTabularExportRequestV2": {
+                "required": ["dashboardId", "fileName", "format"],
+                "type": "object",
+                "properties": {
+                    "format": {
+                        "type": "string",
+                        "description": "Requested tabular export type.",
+                        "example": "XLSX",
+                        "enum": ["XLSX"]
+                    },
+                    "fileName": {
+                        "type": "string",
+                        "description": "Filename of downloaded file without extension.",
+                        "example": "result"
+                    },
+                    "dashboardFiltersOverride": {
+                        "type": "array",
+                        "description": "List of filters that will be used instead of the default dashboard filters.",
+                        "items": {
+                            "$ref": "#/components/schemas/DashboardFilter"
+                        }
+                    },
+                    "dashboardId": {
+                        "type": "string",
+                        "description": "Dashboard identifier",
+                        "example": "761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0"
+                    },
+                    "widgetIds": {
+                        "maxItems": 1,
+                        "uniqueItems": true,
+                        "type": "array",
+                        "description": "List of widget identifiers to be exported. Note that only one widget is currently supported.",
+                        "items": {
+                            "type": "string"
+                        }
+                    },
+                    "settings": {
+                        "$ref": "#/components/schemas/DashboardExportSettings"
+                    }
+                },
+                "description": "Export request object describing the export properties for dashboard tabular exports (v2 with dashboardId)."
+            },
             "DateFilter": {
                 "type": "object",
                 "description": "Abstract filter definition type for dates.",
@@ -1040,6 +1360,15 @@
                     }
                 ]
             },
+            "DateValue": {
+                "required": ["value"],
+                "type": "object",
+                "properties": {
+                    "value": {
+                        "type": "string"
+                    }
+                }
+            },
             "DeclarativeAnalyticalDashboardIdentifier": {
                 "required": ["id", "type"],
                 "type": "object",
@@ -1159,6 +1488,44 @@
                     }
                 ]
             },
+            "IdentifierRef": {
+                "type": "object",
+                "properties": {
+                    "identifier": {
+                        "required": ["id", "type"],
+                        "type": "object",
+                        "properties": {
+                            "id": {
+                                "type": "string"
+                            },
+                            "type": {
+                                "type": "string",
+                                "enum": [
+                                    "analyticalDashboard",
+                                    "attribute",
+                                    "attributeHierarchy",
+                                    "dashboardPlugin",
+                                    "dataset",
+                                    "fact",
+                                    "label",
+                                    "metric",
+                                    "userDataFilter",
+                                    "exportDefinition",
+                                    "automation",
+                                    "prompt",
+                                    "visualizationObject",
+                                    "filterContext",
+                                    "workspaceSettings",
+                                    "customApplicationSetting",
+                                    "workspaceDataFilter",
+                                    "workspaceDataFilterSetting",
+                                    "filterView"
+                                ]
+                            }
+                        }
+                    }
+                }
+            },
             "ImageExportRequest": {
                 "required": ["dashboardId", "fileName", "format", "widgetIds"],
                 "type": "object",
@@ -1360,6 +1727,18 @@
                 },
                 "description": "Filter able to limit element values by label and related selected negated elements."
             },
+            "Over": {
+                "required": ["attributes"],
+                "type": "object",
+                "properties": {
+                    "attributes": {
+                        "type": "array",
+                        "items": {
+                            "$ref": "#/components/schemas/IdentifierRef"
+                        }
+                    }
+                }
+            },
             "PdfTableStyle": {
                 "required": ["selector"],
                 "type": "object",
@@ -1771,13 +2150,16 @@
                             "applyOnResult": {
                                 "type": "boolean"
                             },
+                            "boundedFilter": {
+                                "$ref": "#/components/schemas/BoundedFilter"
+                            },
                             "dataset": {
                                 "$ref": "#/components/schemas/AfmObjectIdentifierDataset"
                             }
                         }
                     }
                 },
-                "description": "A date filter specifying a time interval that is relative to the current date. For example, last week, next month, and so on. Field dataset is representing qualifier of date dimension."
+                "description": "A date filter specifying a time interval that is relative to the current date. For example, last week, next month, and so on. Field dataset is representing qualifier of date dimension. The 'from' and 'to' properties mark the boundaries of the interval. If 'from' is omitted, all values earlier than 'to' are included. If 'to' is omitted, all values later than 'from' are included. It is not allowed to omit both."
             },
             "RelativeWrapper": {
                 "required": ["relative"],
@@ -2519,7 +2901,8 @@
                 "type": "object",
                 "properties": {
                     "timestamp": {
-                        "type": "string"
+                        "type": "string",
+                        "format": "date-time"
                     },
                     "data": {
                         "$ref": "#/components/schemas/WebhookMessageData"
@@ -2583,6 +2966,12 @@
                             "$ref": "#/components/schemas/ExportResult"
                         }
                     },
+                    "dashboardTabularExports": {
+                        "type": "array",
+                        "items": {
+                            "$ref": "#/components/schemas/ExportResult"
+                        }
+                    },
                     "alert": {
                         "$ref": "#/components/schemas/AlertDescription"
                     },