@gooddata/sdk-model 11.64.0-alpha.0 → 11.64.0-alpha.2

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.
  *
@@ -3023,6 +3065,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.
@@ -3669,6 +3722,27 @@ export declare interface IAnthropicProviderConfig {
     baseUrl?: string;
 }
 
+/**
+ * API token of a user.
+ *
+ * @alpha
+ */
+export declare interface IApiToken {
+    id: string;
+}
+
+/**
+ * API token returned right after it is created.
+ *
+ * @remarks
+ * The backend returns the secret only once, at creation time.
+ *
+ * @alpha
+ */
+export declare interface IApiTokenWithSecret extends IApiToken {
+    bearerToken: string;
+}
+
 /**
  * Arbitrary attribute filter - allows filtering by custom string values that may not exist as attribute elements.
  *
@@ -5346,6 +5420,211 @@ export declare interface ICrossFiltering extends IDrill {
     type: "crossFiltering";
 }
 
+/**
+ * Content Security Policy directive of the organization.
+ *
+ * @alpha
+ */
+export declare interface ICspDirective {
+    /**
+     * Name of the directive, for example `script-src` or `img-src`.
+     */
+    id: string;
+    /**
+     * Sources allowed by the directive, for example `'self'`, `https://example.com` or `*.example.com`.
+     */
+    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;
+}
+
 /**
  * @beta
  */
@@ -6694,6 +6973,121 @@ export declare interface IDatasetUser {
     fullName: string;
 }
 
+/**
+ * Connection details of a data source to test, before or after the data source is saved.
+ *
+ * @alpha
+ */
+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;
+}
+
+/**
+ * Result of a data source connection test.
+ *
+ * @alpha
+ */
+export declare interface IDataSourceConnectionTestResult {
+    successful: boolean;
+    /**
+     * Reason of the failure, when the test is not successful.
+     */
+    error?: string;
+}
+
+/**
+ * Full definition of a data source used to create it or to replace it.
+ *
+ * @alpha
+ */
+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
  */
@@ -6704,6 +7098,60 @@ export declare interface IDataSourceIdentifierDescriptor {
     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.
  *
@@ -6720,6 +7168,32 @@ export declare interface IDataSourcePermissionAssignment {
     accessSource?: DataSourceAccessSource;
 }
 
+/**
+ * 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.
  *
@@ -8782,6 +9256,46 @@ export declare interface IGenAIChatRouting {
     reasoning: string;
 }
 
+/**
+ * @alpha
+ *
+ * Represents an answer to a clarifying question for an AI chat response.
+ */
+export declare interface IGenAiClarifyingAnswer {
+    /**
+     * Selected answer definition.
+     */
+    answer: IGenAiClarifyingAnswerItem;
+    /**
+     * Zero-based index of the question.
+     */
+    questionIndex: number;
+    /**
+     * Text of the question as presented to the user.
+     */
+    questionText: string;
+}
+
+/**
+ * @alpha
+ *
+ * Represents a selected option for a clarifying answer.
+ */
+export declare interface IGenAiClarifyingAnswerItem {
+    /**
+     * Zero-based index of the selected option.
+     */
+    optionIndex: number;
+    /**
+     * Text of the selected option as presented to the user.
+     */
+    optionText: string;
+    /**
+     * Type of the answer.
+     */
+    type: "singleChoice";
+}
+
 /**
  * @alpha
  *
@@ -11858,6 +12372,12 @@ export declare interface IOrganizationDescriptor {
     identityProviderType?: string;
     region?: string;
     dataCenter?: string;
+    /**
+     * Origins that can embed the organization content or call its API from a browser (CORS).
+     *
+     * @alpha
+     */
+    allowedOrigins?: string[];
 }
 
 /**
@@ -11874,6 +12394,10 @@ export declare interface IOrganizationDescriptorUpdate {
      */
     earlyAccess?: string | null;
     earlyAccessValues?: string[] | null;
+    /**
+     * @alpha
+     */
+    allowedOrigins?: string[];
 }
 
 /**
@@ -12100,6 +12624,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.
      */
@@ -12124,6 +12654,19 @@ export declare interface IPermanentSettings {
     restrictBaseUi?: boolean;
 }
 
+/**
+ * Current usage of a platform resource that the organization license can limit.
+ *
+ * @alpha
+ */
+export declare interface IPlatformUsage {
+    name: PlatformUsageName;
+    /**
+     * The backend can omit the count.
+     */
+    count?: number;
+}
+
 /**
  * Pluggable application meta-information, v1.
  *
@@ -14836,6 +15379,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.
  *
@@ -19082,6 +19707,22 @@ export declare interface IUserGroupDataFilterDefinition extends IUserDataFilterD
  */
 export declare type IUserGroupWorkspaceAccessGrantee = IWorkspaceAccess & IGranularUserGroupAccessGrantee;
 
+/**
+ * Invitation of a user to the organization.
+ *
+ * @alpha
+ */
+export declare interface IUserInvitation {
+    userId: string;
+    email: string;
+    firstName?: string;
+    lastName?: string;
+    /**
+     * Send the invitation email again even if a pending invitation exists.
+     */
+    forceSend?: boolean;
+}
+
 /**
  * Settings for a particular user.
  *
@@ -19538,6 +20179,7 @@ export declare interface IWorkspaceDataFilter {
     id: string;
     ref: ObjRef;
     title?: string;
+    description?: string;
     columnName?: string;
     settings: IWorkspaceDataFilterSetting[];
     isInherited: boolean;
@@ -19551,6 +20193,7 @@ export declare interface IWorkspaceDataFilter {
 export declare interface IWorkspaceDataFilterDefinition {
     id?: string;
     title: string;
+    description?: string;
     columnName: string;
 }
 
@@ -19566,10 +20209,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.
  *
@@ -21320,6 +21980,13 @@ export declare type PermissionSource = "direct" | "indirect";
  */
 export declare type PlatformEdition = "free" | "growth" | "enterprise";
 
+/**
+ * Name of a measured platform usage item.
+ *
+ * @alpha
+ */
+export declare type PlatformUsageName = "UserCount" | "WorkspaceCount" | "AiWorkspaceCount";
+
 /**
  * Pluggable application meta-information.
  *
@@ -22032,6 +22699,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}`.
  *
@@ -22135,6 +22823,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}.
  *