@gooddata/sdk-model 11.64.0-alpha.1 → 11.64.0-alpha.3

package/esm/sdk-model.d.ts

@@ -1680,11 +1680,53 @@ export declare const DataSourceAccessSourceValue: {
     readonly GROUP: "GROUP";
 };
 
+/**
+ * Method that the backend uses to authenticate to a data source.
+ *
+ * @alpha
+ */
+export declare type DataSourceAuthenticationType = "USERNAME_PASSWORD" | "TOKEN" | "KEY_PAIR" | "CLIENT_SECRET" | "OIDC_PASSTHROUGH";
+
+/**
+ * Determines when the cached results of a data source expire. Narrow it by the `type` property.
+ *
+ * @alpha
+ */
+export declare type DataSourceCacheRetention = IDataSourceIndefiniteCacheRetention | IDataSourceScheduleCacheRetention | IDataSourceValidityPeriodCacheRetention;
+
+/**
+ * Strategy that the backend uses to cache results of a data source.
+ *
+ * @alpha
+ */
+export declare type DataSourceCacheStrategy = "ALWAYS" | "NEVER";
+
+/**
+ * Determines how the backend interprets date and time values of a data source.
+ *
+ * @alpha
+ */
+export declare type DataSourceDateTimeSemantics = "LOCAL" | "UTC";
+
+/**
+ * Format of a file stored in a data source that keeps its data in files.
+ *
+ * @alpha
+ */
+export declare type DataSourceFileType = "CSV" | "SAV";
+
 /**
  * @alpha
  */
 export declare type DataSourceType = "POSTGRESQL" | "REDSHIFT" | "VERTICA" | "SNOWFLAKE" | "ADS" | "BIGQUERY" | "MSSQL" | "PRESTO" | "DREMIO" | "AZURESQL" | "SYNAPSESQL" | "DATABRICKS" | "GDSTORAGE" | "CLICKHOUSE" | "CRATEDB" | "MYSQL" | "MARIADB" | "ORACLE" | "PINOT" | "DENODO" | "STARROCKS" | "ATHENA" | "SINGLESTORE" | "MOTHERDUCK" | "MONGODB" | "FLEXCONNECT" | "AILAKEHOUSE" | "DRILL" | "TRINO";
 
+/**
+ * Permission of the current user to a data source.
+ *
+ * @alpha
+ */
+export declare type DataSourceUserPermission = "MANAGE" | "USE";
+
 /**
  * Single calculated data value.
  *
@@ -1790,6 +1832,90 @@ export declare const DateGranularity: {
  */
 export declare type DateString = string;
 
+/**
+ * Operation that an aggregated fact applies to its source.
+ *
+ * @alpha
+ */
+export declare type DeclarativeAggregationOperation = "SUM" | "MIN" | "MAX" | "APPROXIMATE_COUNT";
+
+/**
+ * Sort direction of attribute elements.
+ *
+ * @alpha
+ */
+export declare type DeclarativeAttributeSortDirection = "ASC" | "DESC";
+
+/**
+ * Definition of a calendar.
+ *
+ * @alpha
+ */
+export declare type DeclarativeCalendarDefinition = IDeclarativeCustomCalendarDefinition | IDeclarativeFiscalYearCalendarDefinition;
+
+/**
+ * Data type of a source column.
+ *
+ * @alpha
+ */
+export declare type DeclarativeColumnDataType = "INT" | "STRING" | "DATE" | "NUMERIC" | "TIMESTAMP" | "TIMESTAMP_TZ" | "BOOLEAN" | "HLL";
+
+/**
+ * Operand of a conditional formatting condition in the declarative model.
+ *
+ * @remarks
+ * Relative date values use the {@link DeclarativeDateGranularity} vocabulary.
+ *
+ * @alpha
+ */
+export declare type DeclarativeConditionalFormattingValue = {
+    kind: "none";
+} | {
+    kind: "literal";
+    value: string | number;
+} | {
+    kind: "literalRange";
+    from: number;
+    to: number;
+} | {
+    kind: "absoluteDate";
+    from: string;
+    to: string;
+} | {
+    kind: "relativeDate";
+    granularity: DeclarativeDateGranularity;
+    from: number;
+    to: number;
+};
+
+/**
+ * Type of a dataset.
+ *
+ * @alpha
+ */
+export declare type DeclarativeDatasetType = "NORMAL" | "AUXILIARY";
+
+/**
+ * Granularity of a date dataset or a calendar, in the vocabulary of the declarative model.
+ *
+ * @alpha
+ */
+export declare type DeclarativeDateGranularity = "SECOND" | "SECOND_OF_MINUTE" | "SECOND_OF_DAY" | "MINUTE" | "MINUTE_OF_HOUR" | "MINUTE_OF_DAY" | "HOUR" | "HOUR_OF_DAY" | "DAY" | "DAY_OF_WEEK" | "DAY_OF_MONTH" | "DAY_OF_QUARTER" | "DAY_OF_YEAR" | "WEEK" | "WEEK_OF_YEAR" | "MONTH" | "MONTH_OF_YEAR" | "QUARTER" | "QUARTER_OF_YEAR" | "YEAR" | "FISCAL_DAY_OF_FISCAL_WEEK" | "FISCAL_DAY_OF_FISCAL_MONTH" | "FISCAL_DAY_OF_FISCAL_QUARTER" | "FISCAL_DAY_OF_FISCAL_SEMESTER" | "FISCAL_DAY_OF_FISCAL_YEAR" | "FISCAL_WEEK" | "FISCAL_WEEK_OF_FISCAL_MONTH" | "FISCAL_WEEK_OF_FISCAL_QUARTER" | "FISCAL_WEEK_OF_FISCAL_SEMESTER" | "FISCAL_WEEK_OF_FISCAL_YEAR" | "FISCAL_MONTH" | "FISCAL_MONTH_OF_FISCAL_QUARTER" | "FISCAL_MONTH_OF_FISCAL_SEMESTER" | "FISCAL_MONTH_OF_FISCAL_YEAR" | "FISCAL_QUARTER" | "FISCAL_QUARTER_OF_FISCAL_SEMESTER" | "FISCAL_QUARTER_OF_FISCAL_YEAR" | "FISCAL_SEMESTER" | "FISCAL_SEMESTER_OF_FISCAL_YEAR" | "FISCAL_YEAR";
+
+/**
+ * Type of the object that is a part of a dataset grain or a target of a reference source.
+ *
+ * @alpha
+ */
+export declare type DeclarativeGrainType = "attribute" | "date";
+
+/**
+ * Value type of a label.
+ *
+ * @alpha
+ */
+export declare type DeclarativeLabelValueType = "TEXT" | "HYPERLINK" | "GEO" | "GEO_LONGITUDE" | "GEO_LATITUDE" | "GEO_AREA" | "GEO_ICON" | "IMAGE" | "HYPERLOGLOG";
+
 /**
  * Standard-calendar granularities that an absolute (static) date filter can be configured with.
  * @alpha
@@ -3023,6 +3149,17 @@ export declare function getPublisherTextPlaceholdersV1(text: string): string[];
  */
 export declare function getPublisherTextPlaceholdersV2(text: string): string[];
 
+/**
+ * The theme image an image source references, such as `{theme.assets.logos.main}`; undefined when the
+ * source is not a theme image reference.
+ *
+ * @remarks
+ * Image references resolve only as an image source or a background image, never in text.
+ *
+ * @alpha
+ */
+export declare function getPublisherThemeImageReferenceV2(source: unknown): PublisherThemeImageReferenceV2 | undefined;
+
 /**
  * The path of a theme reference such as `{theme.colors.texts.muted}`, as
  * `["colors", "texts", "muted"]`; undefined when the value is not one.
@@ -5383,6 +5520,214 @@ export declare interface ICspDirective {
     sources: string[];
 }
 
+/**
+ * Result of a CSV file analysis.
+ *
+ * @alpha
+ */
+export declare interface ICsvAnalysis {
+    location: string;
+    columns: ICsvAnalysisColumn[];
+    /**
+     * Options that the backend detected for the file. Use them to import the file.
+     */
+    config?: ICsvFileConfig;
+    /**
+     * First rows of the file.
+     */
+    previewData: unknown[][];
+}
+
+/**
+ * Column of an analyzed CSV file.
+ *
+ * @alpha
+ */
+export declare interface ICsvAnalysisColumn {
+    name: string;
+    /**
+     * Data type that the backend detected for the column.
+     */
+    type: string;
+    detectedDateFormats?: string[];
+}
+
+/**
+ * Request to analyze a CSV file that is uploaded to the staging area.
+ *
+ * @alpha
+ */
+export declare interface ICsvAnalysisRequest {
+    /**
+     * Location of the uploaded file, as returned by the upload.
+     */
+    location: string;
+    config?: {
+        delimiters?: string[];
+        headerDetectMaxRows?: number;
+        /**
+         * Number of header rows. When not set, the backend detects the header.
+         */
+        headerRowCount?: number;
+        /**
+         * Number of rows to return in the preview data.
+         */
+        resultRows?: number;
+    };
+}
+
+/**
+ * Type of a CSV column that the backend uses when it converts the CSV data.
+ *
+ * @alpha
+ */
+export declare interface ICsvColumnType {
+    name?: string;
+    type?: string;
+    nullable?: boolean;
+}
+
+/**
+ * Options that control how the backend converts values of CSV columns.
+ *
+ * @alpha
+ */
+export declare interface ICsvConvertOptions {
+    autoDictEncode?: boolean;
+    autoDictMaxCardinality?: number;
+    checkUtf8?: boolean;
+    columnTypes?: ICsvColumnType[];
+    decimalPoint?: string;
+    falseValues?: string[];
+    includeColumns?: string[];
+    includeMissingColumns?: boolean;
+    nullValues?: string[];
+    quotedStringsCanBeNull?: boolean;
+    stringsCanBeNull?: boolean;
+    timestampParsers?: string[];
+    trueValues?: string[];
+}
+
+/**
+ * Options that the backend uses to read, parse and convert a CSV file.
+ *
+ * @alpha
+ */
+export declare interface ICsvFileConfig {
+    convertOptions?: ICsvConvertOptions;
+    parseOptions?: ICsvParseOptions;
+    readOptions?: ICsvReadOptions;
+}
+
+/**
+ * Options that the backend used when it imported a CSV file into a data source.
+ *
+ * @alpha
+ */
+export declare interface ICsvFileManifest {
+    /**
+     * Name of the file in the data source.
+     */
+    name: string;
+    version: number;
+    readMethod?: string;
+    readOptions?: ICsvReadOptions;
+    parseOptions?: ICsvParseOptions;
+    convertOptions?: ICsvConvertOptions;
+    /**
+     * Date format of each date column, by column name.
+     */
+    columnDateFormats?: Record<string, string>;
+}
+
+/**
+ * Table that the backend created or updated from a CSV file.
+ *
+ * @alpha
+ */
+export declare interface ICsvImportResult {
+    name: string;
+    version: number;
+}
+
+/**
+ * Table to create from a CSV file that is uploaded to the staging area.
+ *
+ * @alpha
+ */
+export declare interface ICsvImportTable {
+    /**
+     * Name of the table in the data source.
+     */
+    name: string;
+    source: {
+        /**
+         * Location of the uploaded file, as returned by the upload.
+         */
+        location: string;
+        config: ICsvFileConfig & {
+            /**
+             * Date format of each date column, by column name.
+             */
+            columnDateFormats?: Record<string, string>;
+        };
+    };
+}
+
+/**
+ * Options that control how the backend parses a CSV file.
+ *
+ * @alpha
+ */
+export declare interface ICsvParseOptions {
+    delimiter?: string;
+    doubleQuote?: boolean;
+    /**
+     * Escape character, or `false` when the file does not use escaping.
+     */
+    escapeChar?: string | false;
+    ignoreEmptyLines?: boolean;
+    newlinesInValues?: boolean;
+    /**
+     * Quote character, or `false` when the file does not use quoting.
+     */
+    quoteChar?: string | false;
+}
+
+/**
+ * Options that control how the backend reads a CSV file.
+ *
+ * @alpha
+ */
+export declare interface ICsvReadOptions {
+    autoGenerateColumnNames?: boolean;
+    blockSize?: number;
+    columnNames?: string[];
+    encoding?: string;
+    skipRows?: number;
+    skipRowsAfterNames?: number;
+    useThreads?: boolean;
+}
+
+/**
+ * Setting that an application stores in a workspace.
+ *
+ * @alpha
+ */
+export declare interface ICustomApplicationSetting {
+    id: string;
+    /**
+     * Name of the application that owns the setting.
+     */
+    applicationName: string;
+    /**
+     * Content of the setting. The application defines its structure.
+     */
+    content: {
+        [key: string]: unknown;
+    };
+}
+
 /**
  * @beta
  */
@@ -6732,119 +7077,784 @@ export declare interface IDatasetUser {
 }
 
 /**
+ * Connection details of a data source to test, before or after the data source is saved.
+ *
  * @alpha
  */
-export declare interface IDataSourceIdentifierDescriptor {
-    id: string;
-    name: string;
-    schema: string;
+export declare interface IDataSourceConnectionTest {
     type: DataSourceType;
+    url: string;
+    schema: string;
+    username?: string;
+    password?: string;
+    token?: string;
+    parameters?: IDataSourceParameter[];
+    privateKey?: string;
+    privateKeyPassphrase?: string;
+    clientId?: string;
+    clientSecret?: string;
+    authenticationType?: DataSourceAuthenticationType | null;
 }
 
 /**
- * Descriptor contains details about data source permission of organization user or user group.
+ * Result of a data source connection test.
  *
  * @alpha
  */
-export declare interface IDataSourcePermissionAssignment {
-    assigneeIdentifier: IOrganizationAssignee;
-    dataSource: IAssignedDataSource;
-    permissions: AssignedDataSourcePermission[];
+export declare interface IDataSourceConnectionTestResult {
+    successful: boolean;
     /**
-     * How the subject gains access to the data source. Present only when effective (inherited-aware)
-     * permissions were requested; absent for direct-only listings.
+     * Reason of the failure, when the test is not successful.
      */
-    accessSource?: DataSourceAccessSource;
+    error?: string;
 }
 
 /**
- * Date filters limit the range of results to data within relative or absolute date range.
+ * Full definition of a data source used to create it or to replace it.
  *
- * @public
+ * @alpha
  */
-export declare type IDateFilter = IRelativeDateFilter | IAbsoluteDateFilter;
+export declare interface IDataSourceDefinition {
+    id: string;
+    name: string;
+    schema: string;
+    type: DataSourceType;
+    url?: string;
+    username?: string;
+    password?: string;
+    token?: string;
+    parameters?: IDataSourceParameter[];
+    cacheStrategy?: DataSourceCacheStrategy;
+    /**
+     * Use `null` to remove the cache retention policy of the data source.
+     */
+    cacheRetention?: DataSourceCacheRetention | null;
+    privateKey?: string;
+    privateKeyPassphrase?: string;
+    clientId?: string;
+    clientSecret?: string;
+    dateTimeSemantics?: DataSourceDateTimeSemantics | null;
+    authenticationType?: DataSourceAuthenticationType | null;
+    /**
+     * Identifier of the data source that the backend uses instead of this one.
+     */
+    alternativeDataSourceId?: string | null;
+    disableStatistics?: boolean | null;
+    /**
+     * Skip the audience check of JWT tokens in the OIDC authentication.
+     */
+    ignoreJwtAud?: boolean | null;
+}
+
+/**
+ * Data source with its connection details. Secrets, such as passwords or tokens, are never included.
+ *
+ * @alpha
+ */
+export declare interface IDataSourceDescriptor extends IDataSourceIdentifierDescriptor {
+    username?: string;
+    clientId?: string;
+    url?: string | null;
+    permissions?: DataSourceUserPermission[];
+    parameters?: IDataSourceParameter[] | null;
+    decodedParameters?: IDataSourceParameter[] | null;
+    cacheStrategy?: DataSourceCacheStrategy | null;
+    cacheRetention?: DataSourceCacheRetention | null;
+    authenticationType?: DataSourceAuthenticationType | null;
+    dateTimeSemantics?: DataSourceDateTimeSemantics | null;
+    /**
+     * Identifier of the data source that the backend uses instead of this one.
+     */
+    alternativeDataSourceId?: string | null;
+    disableStatistics?: boolean | null;
+    /**
+     * Skip the audience check of JWT tokens in the OIDC authentication.
+     */
+    ignoreJwtAud?: boolean | null;
+}
+
+/**
+ * File stored in a data source that keeps its data in files, for example a CSV data source.
+ *
+ * @alpha
+ */
+export declare interface IDataSourceFile {
+    name: string;
+    /**
+     * Size of the file in bytes.
+     */
+    size: number;
+    /**
+     * Date and time of the last change, as an ISO-8601 string.
+     */
+    modifiedAt: string;
+    type: DataSourceFileType;
+}
+
+/**
+ * @alpha
+ */
+export declare interface IDataSourceIdentifierDescriptor {
+    id: string;
+    name: string;
+    schema: string;
+    type: DataSourceType;
+}
+
+/**
+ * Cached results of the data source never expire on their own.
+ *
+ * @alpha
+ */
+export declare interface IDataSourceIndefiniteCacheRetention {
+    type: "INDEFINITE";
+}
+
+/**
+ * Additional connection parameter of a data source.
+ *
+ * @alpha
+ */
+export declare interface IDataSourceParameter {
+    name: string;
+    value: string;
+}
+
+/**
+ * Partial update of a data source. Properties that are `undefined` keep their current value.
+ * Use `null` to remove a value.
+ *
+ * @alpha
+ */
+export declare interface IDataSourcePatch {
+    id: string;
+    name?: string;
+    schema?: string;
+    type?: DataSourceType;
+    url?: string | null;
+    username?: string | null;
+    password?: string | null;
+    token?: string | null;
+    parameters?: IDataSourceParameter[] | null;
+    cacheStrategy?: DataSourceCacheStrategy | null;
+    cacheRetention?: DataSourceCacheRetention | null;
+    privateKey?: string | null;
+    privateKeyPassphrase?: string | null;
+    clientId?: string | null;
+    clientSecret?: string | null;
+    dateTimeSemantics?: DataSourceDateTimeSemantics | null;
+    authenticationType?: DataSourceAuthenticationType | null;
+    /**
+     * Identifier of the data source that the backend uses instead of this one.
+     */
+    alternativeDataSourceId?: string | null;
+    disableStatistics?: boolean | null;
+    /**
+     * Skip the audience check of JWT tokens in the OIDC authentication.
+     */
+    ignoreJwtAud?: boolean | null;
+}
+
+/**
+ * Descriptor contains details about data source permission of organization user or user group.
+ *
+ * @alpha
+ */
+export declare interface IDataSourcePermissionAssignment {
+    assigneeIdentifier: IOrganizationAssignee;
+    dataSource: IAssignedDataSource;
+    permissions: AssignedDataSourcePermission[];
+    /**
+     * How the subject gains access to the data source. Present only when effective (inherited-aware)
+     * permissions were requested; absent for direct-only listings.
+     */
+    accessSource?: DataSourceAccessSource;
+}
+
+/**
+ * Problem with a column that the scan found.
+ *
+ * @alpha
+ */
+export declare interface IDataSourceScanColumnWarning {
+    message: string;
+    name: string;
+}
+
+/**
+ * Options of a data source scan.
+ *
+ * @alpha
+ */
+export declare interface IDataSourceScanRequest {
+    scanTables: boolean;
+    scanViews: boolean;
+    /**
+     * Schemata to scan. When not set, the backend scans the schema of the data source.
+     */
+    schemata?: string[];
+    /**
+     * Separator of the parts of table and column names that the backend uses to detect LDM objects.
+     */
+    separator: string;
+    tablePrefix?: string;
+    viewPrefix?: string;
+}
+
+/**
+ * Result of a data source scan.
+ *
+ * @alpha
+ */
+export declare interface IDataSourceScanResult {
+    pdm: IPhysicalDataModel;
+    warnings: IDataSourceScanTableWarning[];
+}
+
+/**
+ * Problem with a table that the scan found.
+ *
+ * @alpha
+ */
+export declare interface IDataSourceScanTableWarning {
+    columns: IDataSourceScanColumnWarning[];
+    message?: string;
+    name: string;
+}
+
+/**
+ * Cached results of the data source expire according to a cron schedule.
+ *
+ * @alpha
+ */
+export declare interface IDataSourceScheduleCacheRetention {
+    type: "SCHEDULE";
+    schedule: {
+        cron: string;
+        timezone?: string | null;
+    };
+}
+
+/**
+ * Cached results of the data source expire when the validity period elapses.
+ *
+ * @alpha
+ */
+export declare interface IDataSourceValidityPeriodCacheRetention {
+    type: "VALIDITY_PERIOD";
+    /**
+     * ISO-8601 duration, for example `PT1H`.
+     */
+    validityPeriod: string;
+}
+
+/**
+ * Date filters limit the range of results to data within relative or absolute date range.
+ *
+ * @public
+ */
+export declare type IDateFilter = IRelativeDateFilter | IAbsoluteDateFilter;
+
+/**
+ * Date filter configs allow to define your own date filter options, that appear in the date filter.
+ *
+ * @alpha
+ */
+export declare interface IDateFilterConfig {
+    /**
+     * Extended date filter config reference
+     */
+    ref: ObjRef;
+    /**
+     * Local identifier of the default selected date filter preset
+     */
+    selectedOption: Identifier;
+    /**
+     * Options to customize displaying of the global all time date filter
+     */
+    allTime?: IAllTimeDateFilterOption;
+    /**
+     * Options to customize displaying of the empty values date filter preset
+     */
+    emptyValues?: IEmptyValuesDateFilterOption;
+    /**
+     * Options to customize displaying of the global absolute date filter
+     */
+    absoluteForm?: IAbsoluteDateFilterForm;
+    /**
+     * Options to customize displaying of the global relative date filter
+     */
+    relativeForm?: IRelativeDateFilterForm;
+    /**
+     * Custom absolute date filter presets (options to display in the extended date filter dropdown)
+     */
+    absolutePresets?: IAbsoluteDateFilterPreset[];
+    /**
+     * Custom relative date filter presets (options to display in the extended date filter dropdown)
+     */
+    relativePresets?: IRelativeDateFilterPreset[];
+}
+
+/**
+ * Common props for date filter options
+ * @alpha
+ */
+export declare interface IDateFilterOption {
+    /**
+     * Local identifier of the option
+     */
+    localIdentifier: Identifier;
+    /**
+     * Customized name of the option to display in the dropdown
+     */
+    name?: string;
+    /**
+     * Option type
+     */
+    type: DateFilterOptionType;
+    /**
+     * Sets whether this option will be visible in the dropdown
+     */
+    visible: boolean;
+}
+
+/**
+ *
+ * @alpha
+ */
+export declare interface IDateHierarchyReference {
+    type: "dateHierarchyReference";
+    dateHierarchyTemplate: ObjRef;
+    dateDatasetAttribute: ObjRef;
+}
+
+/**
+ * Hierarchy template for date dataset
+ *
+ * @alpha
+ */
+export declare interface IDateHierarchyTemplate extends IMetadataObjectIdentity, IMetadataObjectBase {
+    type: "dateHierarchyTemplate";
+    granularities: DateAttributeGranularity[];
+}
+
+/**
+ * Fact that aggregates a fact or an attribute of another dataset.
+ *
+ * @alpha
+ */
+export declare interface IDeclarativeAggregatedFact {
+    description?: string;
+    id: string;
+    isNullable?: boolean;
+    nullValue?: string;
+    sourceColumn?: string;
+    sourceColumnDataType?: DeclarativeColumnDataType;
+    sourceFactReference: IDeclarativeSourceFactReference;
+    tags?: string[];
+}
+
+/**
+ * Attribute of a dataset.
+ *
+ * @alpha
+ */
+export declare interface IDeclarativeAttribute {
+    conditionalFormatting?: IDeclarativeConditionalFormatting | null;
+    defaultView?: IDeclarativeLabelIdentifier;
+    description?: string;
+    id: string;
+    isHidden?: boolean;
+    isNullable?: boolean;
+    labels: IDeclarativeLabel[];
+    locale?: string;
+    nullValue?: string;
+    sortColumn?: string;
+    sortDirection?: DeclarativeAttributeSortDirection;
+    sourceColumn?: string;
+    sourceColumnDataType?: DeclarativeColumnDataType;
+    tags?: string[];
+    title: string;
+}
+
+/**
+ * Calendar of the logical data model.
+ *
+ * @alpha
+ */
+export declare interface IDeclarativeCalendar {
+    definition: DeclarativeCalendarDefinition;
+    description?: string;
+    enabledGranularities: IDeclarativeCalendarGranularity[];
+    name: string;
+}
+
+/**
+ * Granularity that a calendar enables.
+ *
+ * @alpha
+ */
+export declare interface IDeclarativeCalendarGranularity {
+    granularity: DeclarativeDateGranularity;
+    prefix: string;
+}
+
+/**
+ * Data source table that a custom calendar reads.
+ *
+ * @alpha
+ */
+export declare interface IDeclarativeCalendarTableReference {
+    path: string[];
+    version: string;
+}
+
+/**
+ * Conditional formatting of an attribute, a label or a date dataset.
+ *
+ * @alpha
+ */
+export declare interface IDeclarativeConditionalFormatting {
+    conditions: IDeclarativeConditionalFormattingCondition[];
+    enabled: boolean;
+}
+
+/**
+ * Condition of a conditional formatting in the declarative model.
+ *
+ * @alpha
+ */
+export declare interface IDeclarativeConditionalFormattingCondition {
+    format: IConditionalFormattingFormat;
+    id?: string;
+    operator: ConditionalFormattingOperator;
+    value: DeclarativeConditionalFormattingValue;
+}
+
+/**
+ * Calendar that reads its periods from data source tables.
+ *
+ * @alpha
+ */
+export declare interface IDeclarativeCustomCalendarDefinition {
+    type: "custom";
+    dataSourceTables: {
+        [id: string]: IDeclarativeCalendarTableReference;
+    };
+}
+
+/**
+ * Dataset of the logical data model.
+ *
+ * @alpha
+ */
+export declare interface IDeclarativeDataset {
+    aggregatedFacts?: IDeclarativeAggregatedFact[];
+    attributes?: IDeclarativeAttribute[];
+    /**
+     * Data source table that the dataset maps to. A dataset maps to a table or to an SQL statement.
+     */
+    dataSourceTableId?: IDeclarativeDataSourceTableIdentifier;
+    description?: string;
+    facts?: IDeclarativeFact[];
+    grain: IDeclarativeGrainIdentifier[];
+    id: string;
+    precedence?: number;
+    references: IDeclarativeReference[];
+    /**
+     * SQL statement that the dataset maps to. A dataset maps to a table or to an SQL statement.
+     */
+    sql?: IDeclarativeDatasetSql;
+    tags?: string[];
+    title: string;
+    type?: DeclarativeDatasetType;
+    workspaceDataFilterColumns?: IDeclarativeWorkspaceDataFilterColumn[];
+    workspaceDataFilterReferences?: IDeclarativeWorkspaceDataFilterReference[];
+}
+
+/**
+ * Extension of a dataset inherited from a parent workspace.
+ *
+ * @alpha
+ */
+export declare interface IDeclarativeDatasetExtension {
+    id: string;
+    workspaceDataFilterReferences?: IDeclarativeWorkspaceDataFilterReference[];
+}
+
+/**
+ * Identifier of a dataset or a date dataset.
+ *
+ * @alpha
+ */
+export declare interface IDeclarativeDatasetIdentifier {
+    id: string;
+    type: "dataset";
+}
+
+/**
+ * SQL statement that a dataset maps to.
+ *
+ * @alpha
+ */
+export declare interface IDeclarativeDatasetSql {
+    dataSourceId: string;
+    statement: string;
+}
+
+/**
+ * Identifier of a data source table.
+ *
+ * @alpha
+ */
+export declare interface IDeclarativeDataSourceTableIdentifier {
+    dataSourceId: string;
+    id: string;
+    path?: string[] | null;
+    type: "dataSource";
+}
+
+/**
+ * Date dataset of the logical data model.
+ *
+ * @alpha
+ */
+export declare interface IDeclarativeDateDataset {
+    conditionalFormatting?: IDeclarativeConditionalFormatting | null;
+    description?: string;
+    granularities: DeclarativeDateGranularity[];
+    granularitiesFormatting: IDeclarativeGranularitiesFormatting;
+    id: string;
+    tags?: string[];
+    title: string;
+}
+
+/**
+ * Fact of a dataset.
+ *
+ * @alpha
+ */
+export declare interface IDeclarativeFact {
+    description?: string;
+    id: string;
+    isHidden?: boolean;
+    isNullable?: boolean;
+    nullValue?: string;
+    sourceColumn?: string;
+    sourceColumnDataType?: DeclarativeColumnDataType;
+    tags?: string[];
+    title: string;
+}
+
+/**
+ * Calendar with a fiscal year that starts with an offset from the calendar year.
+ *
+ * @alpha
+ */
+export declare interface IDeclarativeFiscalYearCalendarDefinition {
+    type: "fiscalYear";
+    monthOffset: number;
+}
+
+/**
+ * Geo area configuration of a label.
+ *
+ * @alpha
+ */
+export declare interface IDeclarativeGeoAreaConfig {
+    collection: IDeclarativeGeoCollectionIdentifier;
+}
+
+/**
+ * Identifier of a geo collection.
+ *
+ * @alpha
+ */
+export declare interface IDeclarativeGeoCollectionIdentifier {
+    id: string;
+    kind?: "STATIC" | "CUSTOM";
+}
+
+/**
+ * Identifier of an attribute or a date dataset.
+ *
+ * @alpha
+ */
+export declare interface IDeclarativeGrainIdentifier {
+    id: string;
+    type: DeclarativeGrainType;
+}
+
+/**
+ * Title formatting of the attributes of a date dataset.
+ *
+ * @alpha
+ */
+export declare interface IDeclarativeGranularitiesFormatting {
+    titleBase: string;
+    titlePattern: string;
+}
+
+/**
+ * Label of an attribute.
+ *
+ * @alpha
+ */
+export declare interface IDeclarativeLabel {
+    conditionalFormatting?: IDeclarativeConditionalFormatting | null;
+    description?: string;
+    geoAreaConfig?: IDeclarativeGeoAreaConfig;
+    id: string;
+    isHidden?: boolean;
+    isNullable?: boolean;
+    locale?: string;
+    nullValue?: string;
+    sourceColumn?: string;
+    sourceColumnDataType?: DeclarativeColumnDataType;
+    tags?: string[];
+    title: string;
+    translations?: IDeclarativeLabelTranslation[];
+    valueType?: DeclarativeLabelValueType;
+}
+
+/**
+ * Identifier of a label.
+ *
+ * @alpha
+ */
+export declare interface IDeclarativeLabelIdentifier {
+    id: string;
+    type: "label";
+}
+
+/**
+ * Source column of a label value in one locale.
+ *
+ * @alpha
+ */
+export declare interface IDeclarativeLabelTranslation {
+    locale: string;
+    sourceColumn: string;
+}
+
+/**
+ * Logical data model of a workspace in the declarative form.
+ *
+ * @remarks
+ * The model has the same form as the declarative logical model document of the backend, so it can be
+ * exported to JSON and imported back without changes.
+ *
+ * @alpha
+ */
+export declare interface IDeclarativeLogicalModel {
+    /**
+     * Calendars by their identifier.
+     */
+    calendars?: {
+        [id: string]: IDeclarativeCalendar;
+    };
+    /**
+     * Extensions of datasets that the workspace inherits from its parents.
+     */
+    datasetExtensions?: IDeclarativeDatasetExtension[];
+    datasets?: IDeclarativeDataset[];
+    /**
+     * Date datasets.
+     */
+    dateInstances?: IDeclarativeDateDataset[];
+}
+
+/**
+ * Reference from a dataset to another dataset or a date dataset.
+ *
+ * @alpha
+ */
+export declare interface IDeclarativeReference {
+    identifier: IDeclarativeDatasetIdentifier;
+    multivalue: boolean;
+    sourceColumnDataTypes?: DeclarativeColumnDataType[];
+    sourceColumns?: string[];
+    sources?: IDeclarativeReferenceSource[];
+}
+
+/**
+ * Source column of a reference and the grain object of the referenced dataset that it maps to.
+ *
+ * @alpha
+ */
+export declare interface IDeclarativeReferenceSource {
+    column?: string;
+    dataType?: DeclarativeColumnDataType;
+    isNullable?: boolean;
+    nullValue?: string;
+    target: IDeclarativeGrainIdentifier;
+}
+
+/**
+ * Source of an aggregated fact.
+ *
+ * @alpha
+ */
+export declare interface IDeclarativeSourceFactReference {
+    operation: DeclarativeAggregationOperation;
+    reference: IDeclarativeSourceReferenceIdentifier;
+}
+
+/**
+ * Identifier of the fact or attribute that an aggregated fact aggregates.
+ *
+ * @alpha
+ */
+export declare interface IDeclarativeSourceReferenceIdentifier {
+    id: string;
+    type: "fact" | "attribute";
+}
 
 /**
- * Date filter configs allow to define your own date filter options, that appear in the date filter.
+ * Column of a dataset that workspace data filters use.
  *
  * @alpha
  */
-export declare interface IDateFilterConfig {
-    /**
-     * Extended date filter config reference
-     */
-    ref: ObjRef;
-    /**
-     * Local identifier of the default selected date filter preset
-     */
-    selectedOption: Identifier;
-    /**
-     * Options to customize displaying of the global all time date filter
-     */
-    allTime?: IAllTimeDateFilterOption;
-    /**
-     * Options to customize displaying of the empty values date filter preset
-     */
-    emptyValues?: IEmptyValuesDateFilterOption;
-    /**
-     * Options to customize displaying of the global absolute date filter
-     */
-    absoluteForm?: IAbsoluteDateFilterForm;
-    /**
-     * Options to customize displaying of the global relative date filter
-     */
-    relativeForm?: IRelativeDateFilterForm;
-    /**
-     * Custom absolute date filter presets (options to display in the extended date filter dropdown)
-     */
-    absolutePresets?: IAbsoluteDateFilterPreset[];
-    /**
-     * Custom relative date filter presets (options to display in the extended date filter dropdown)
-     */
-    relativePresets?: IRelativeDateFilterPreset[];
+export declare interface IDeclarativeWorkspaceDataFilterColumn {
+    dataType: DeclarativeColumnDataType;
+    name: string;
 }
 
 /**
- * Common props for date filter options
+ * Identifier of a workspace data filter.
+ *
  * @alpha
  */
-export declare interface IDateFilterOption {
-    /**
-     * Local identifier of the option
-     */
-    localIdentifier: Identifier;
-    /**
-     * Customized name of the option to display in the dropdown
-     */
-    name?: string;
-    /**
-     * Option type
-     */
-    type: DateFilterOptionType;
-    /**
-     * Sets whether this option will be visible in the dropdown
-     */
-    visible: boolean;
+export declare interface IDeclarativeWorkspaceDataFilterIdentifier {
+    id: string;
+    type: "workspaceDataFilter";
 }
 
 /**
+ * Reference from a dataset column to a workspace data filter.
  *
  * @alpha
  */
-export declare interface IDateHierarchyReference {
-    type: "dateHierarchyReference";
-    dateHierarchyTemplate: ObjRef;
-    dateDatasetAttribute: ObjRef;
+export declare interface IDeclarativeWorkspaceDataFilterReference {
+    filterColumn: string;
+    filterColumnDataType: DeclarativeColumnDataType;
+    filterId: IDeclarativeWorkspaceDataFilterIdentifier;
 }
 
 /**
- * Hierarchy template for date dataset
+ * Logical data model and analytical objects of a workspace.
  *
  * @alpha
  */
-export declare interface IDateHierarchyTemplate extends IMetadataObjectIdentity, IMetadataObjectBase {
-    type: "dateHierarchyTemplate";
-    granularities: DateAttributeGranularity[];
+export declare interface IDeclarativeWorkspaceLayout {
+    ldm: IDeclarativeLogicalModel;
+    /**
+     * Analytical objects in the declarative analytics document of the backend.
+     *
+     * @remarks
+     * The model does not describe this document. Use a document that the backend exported.
+     */
+    analytics: object;
 }
 
 /**
@@ -8512,6 +9522,13 @@ export declare interface IFeatureFlags {
      * Enable Publisher v2.
      */
     enablePublisherV2?: boolean;
+    /**
+     * Enable AI takeaways in the Business Briefing reports application: generating them and their instructions.
+     *
+     * @remarks
+     * Disabled by default.
+     */
+    enableGenAiReportTakeaways?: boolean;
     /**
      * Enable the write and export postMessage commands for embedded dashboards and Analytical Designer.
      *
@@ -9386,6 +10403,98 @@ export declare interface IGenAIWidgetDescriptor {
     content?: string;
 }
 
+/**
+ * Change of the LDM object type that the generation detects for a column.
+ *
+ * @alpha
+ */
+export declare interface IGenerateLogicalModelColumnOverride {
+    labelTargetColumn?: string;
+    labelType?: DeclarativeLabelValueType;
+    ldmTypeOverride?: "FACT" | "LABEL";
+    name: string;
+}
+
+/**
+ * Physical data model that the logical data model generation uses.
+ *
+ * @alpha
+ */
+export declare interface IGenerateLogicalModelPdm {
+    sqls?: IGenerateLogicalModelSql[];
+    tableOverrides?: IGenerateLogicalModelTableOverride[];
+    tables?: IPhysicalTable[];
+}
+
+/**
+ * Options of the logical data model generation from a data source.
+ *
+ * @remarks
+ * The prefixes and the separator tell the backend how to detect LDM objects from table and column names.
+ *
+ * @alpha
+ */
+export declare interface IGenerateLogicalModelRequest {
+    aggregatedFactPrefix?: string;
+    dateGranularities?: string;
+    dateReferencePrefix?: string;
+    denormPrefix?: string;
+    factPrefix?: string;
+    generateLongIds?: boolean;
+    grainMultivalueReferencePrefix?: string;
+    grainPrefix?: string;
+    grainReferencePrefix?: string;
+    multivalueReferencePrefix?: string;
+    /**
+     * Physical data model to generate the logical data model from. When not set, the backend scans the data source.
+     */
+    pdm?: IGenerateLogicalModelPdm;
+    primaryLabelPrefix?: string;
+    referencePrefix?: string;
+    secondaryLabelPrefix?: string;
+    separator?: string;
+    tablePrefix?: string;
+    translationPrefix?: string;
+    viewPrefix?: string;
+    wdfPrefix?: string;
+    /**
+     * Workspace whose logical data model the backend uses to keep the existing identifiers.
+     */
+    workspaceId?: string;
+}
+
+/**
+ * SQL statement that the logical data model generation makes a dataset from.
+ *
+ * @alpha
+ */
+export declare interface IGenerateLogicalModelSql {
+    columns?: IGenerateLogicalModelSqlColumn[];
+    statement: string;
+    title: string;
+}
+
+/**
+ * Column of an SQL statement that the logical data model generation uses.
+ *
+ * @alpha
+ */
+export declare interface IGenerateLogicalModelSqlColumn {
+    dataType: DeclarativeColumnDataType;
+    name: string;
+    nullValue?: string;
+}
+
+/**
+ * Change of the LDM object types that the generation detects for the columns of a table.
+ *
+ * @alpha
+ */
+export declare interface IGenerateLogicalModelTableOverride {
+    columns: IGenerateLogicalModelColumnOverride[];
+    path: string[];
+}
+
 /**
  * Represents a custom geo collection stored at the organization level.
  *
@@ -12187,6 +13296,12 @@ export declare interface IPermanentSettings {
      * @alpha
      */
     defaultVisualizationVisibility?: ObjectVisibility;
+    /**
+     * When true, granting ANALYZE on the workspace also grants the MANAGE_VISUALIZATIONS workspace
+     * permission, and revoking ANALYZE revokes it. Changing the setting leaves stored grants as they are.
+     * @alpha
+     */
+    grantManageVisualizationsWithAnalyze?: boolean;
     /**
      * Headline component will not be underlined when it is set up with drilling.
      */
@@ -12211,6 +13326,55 @@ export declare interface IPermanentSettings {
     restrictBaseUi?: boolean;
 }
 
+/**
+ * Column of a data source table.
+ *
+ * @alpha
+ */
+export declare interface IPhysicalColumn {
+    dataType: DeclarativeColumnDataType;
+    /**
+     * Name of the column whose values this column labels.
+     * Logical model generation makes this column the default label of the attribute on that column.
+     */
+    defaultLabelOf?: string;
+    description?: string;
+    isNullable?: boolean;
+    isPrimaryKey?: boolean;
+    name: string;
+    nullValue?: string;
+    referencedTableColumn?: string;
+    referencedTableId?: string;
+}
+
+/**
+ * Physical data model of a data source: its tables and their columns.
+ *
+ * @alpha
+ */
+export declare interface IPhysicalDataModel {
+    tables: IPhysicalTable[];
+}
+
+/**
+ * Table or view of a data source.
+ *
+ * @alpha
+ */
+export declare interface IPhysicalTable {
+    columns: IPhysicalColumn[];
+    id: string;
+    namePrefix?: string;
+    /**
+     * Path to the table, for example the schema and the table name.
+     */
+    path: string[];
+    /**
+     * Type of the table, for example TABLE or VIEW.
+     */
+    type: string;
+}
+
 /**
  * Current usage of a platform resource that the organization license can limit.
  *
@@ -14936,6 +16100,88 @@ export declare const isAvailableUserAccessGrantee: (obj: unknown) => obj is IAva
  */
 export declare const isAvailableUserGroupAccessGrantee: (obj: unknown) => obj is IAvailableUserGroupAccessGrantee;
 
+/**
+ * Result of the analysis of an SPSS (.sav) file.
+ *
+ * @alpha
+ */
+export declare interface ISavAnalysis {
+    location: string;
+    columns: ISavAnalysisColumn[];
+    previewData: unknown[][];
+}
+
+/**
+ * Column of an analyzed SPSS (.sav) file.
+ *
+ * @alpha
+ */
+export declare interface ISavAnalysisColumn {
+    name: string;
+    /**
+     * Arrow type name of the column, for example "float64" or "date32[day]".
+     */
+    type: string;
+    label?: string;
+    valueLabels?: ISavValueLabel[];
+}
+
+/**
+ * SPSS (.sav) file in the staging area to analyze.
+ *
+ * @alpha
+ */
+export declare interface ISavAnalysisRequest {
+    /**
+     * Location of the uploaded file, as returned by the upload.
+     */
+    location: string;
+    config?: {
+        /**
+         * Number of rows in the preview data.
+         */
+        resultRows?: number;
+    };
+}
+
+/**
+ * Table that the backend created or updated from an SPSS (.sav) file.
+ *
+ * @alpha
+ */
+export declare interface ISavImportResult {
+    name: string;
+    version: number;
+}
+
+/**
+ * Table to create or update from an SPSS (.sav) file.
+ *
+ * @alpha
+ */
+export declare interface ISavImportTable {
+    /**
+     * Name of the table in the data source.
+     */
+    name: string;
+    source: {
+        /**
+         * Location of the uploaded file, as returned by the upload.
+         */
+        location: string;
+    };
+}
+
+/**
+ * Label of one value of an SPSS column.
+ *
+ * @alpha
+ */
+export declare interface ISavValueLabel {
+    value: unknown;
+    label: string;
+}
+
 /**
  * Tests whether the provided timezone value is the {@link BROWSER_DETECTED} sentinel.
  *
@@ -16794,6 +18040,31 @@ export declare function isPublisherVisualizationWidgetV2(obj: unknown): obj is I
  */
 export declare function isPublisherWidgetV2(obj: unknown): obj is PublisherWidgetV2;
 
+/**
+ * Column of the result of an SQL statement.
+ *
+ * @alpha
+ */
+export declare interface ISqlScanColumn {
+    dataType: DeclarativeColumnDataType;
+    description?: string;
+    name: string;
+    nullValue?: string;
+}
+
+/**
+ * Result of an SQL statement scan.
+ *
+ * @alpha
+ */
+export declare interface ISqlScanResult {
+    columns: ISqlScanColumn[];
+    /**
+     * First rows of the result of the statement.
+     */
+    dataPreview?: (string | null)[][];
+}
+
 /**
  * Type guard checking whether the provided object is a measure value filter's range condition.
  *
@@ -19654,6 +20925,7 @@ export declare interface IWorkspaceDataFilter {
     id: string;
     ref: ObjRef;
     title?: string;
+    description?: string;
     columnName?: string;
     settings: IWorkspaceDataFilterSetting[];
     isInherited: boolean;
@@ -19667,6 +20939,7 @@ export declare interface IWorkspaceDataFilter {
 export declare interface IWorkspaceDataFilterDefinition {
     id?: string;
     title: string;
+    description?: string;
     columnName: string;
 }
 
@@ -19682,10 +20955,27 @@ export declare interface IWorkspaceDataFilterSetting {
     id: string;
     ref: ObjRef;
     title?: string;
+    description?: string;
     filterValues: string[];
     isInherited: boolean;
 }
 
+/**
+ * Entity that contains data necessary to create a new Workspace Data Filter setting
+ *
+ * @alpha
+ */
+export declare interface IWorkspaceDataFilterSettingDefinition {
+    /**
+     * Identifier of the new setting. A random identifier is used when it is not set.
+     */
+    id?: string;
+    dataFilter: ObjRef;
+    title?: string;
+    description?: string;
+    filterValues: string[];
+}
+
 /**
  * Descriptor contains details about workspace permission of organization user or user group.
  *
@@ -22155,6 +23445,27 @@ export declare const PublisherTextVariablesV2: readonly PublisherTextVariableV2[
  */
 export declare type PublisherTextVariableV2 = "documentName" | "documentDescription" | "documentDateRange" | "documentAttributeFilters" | "periodStart" | "periodEnd" | "lastModifiedAt" | "lastModifiedBy" | "exportedAt" | "exportedBy" | "workspaceName" | "workspaceId" | "currentPageNumber" | "totalPages";
 
+/**
+ * A theme image that an image source names in place of a url.
+ *
+ * @remarks
+ * `{theme.logo}` is the logo asset with the id `logo`, else the first logo asset, then the theme's
+ * `images.logo`, then the organization's white-labeling logo. `{theme.coverImage}` is the theme's
+ * `images.coverImage`. `{theme.assets.logos.<id>}` and `{theme.assets.images.<id>}` are the asset with
+ * that id in that list.
+ *
+ * @alpha
+ */
+export declare type PublisherThemeImageReferenceV2 = {
+    type: "logo";
+} | {
+    type: "coverImage";
+} | {
+    type: "asset";
+    list: "logos" | "images";
+    id: string;
+};
+
 /**
  * The theme reference to the path, such as `{theme.assets.images.cover}`.
  *
@@ -22258,6 +23569,14 @@ export declare type RequiredSettings = Condition<Partial<IPermanentSettings | IF
  */
 export declare type RequiredWorkspacePermissions = Condition<Partial<IPluggableApplicationWorkspacePermissions>>;
 
+/**
+ * An https image url with its text variables replaced, each value percent-encoded so that it stays one
+ * part of the url. A marker without a value stays as typed. Undefined when the result is not an https url.
+ *
+ * @alpha
+ */
+export declare function resolvePublisherImageUrlV2(url: string, values: Partial<Record<PublisherTextVariableV2, string>>): string | undefined;
+
 /**
  * Current version of {@link resolvePublisherTextPlaceholdersV1}.
  *