@gooddata/sdk-backend-spi 11.62.0-alpha.0 → 11.62.0-alpha.2

package/esm/sdk-backend-spi.d.ts

@@ -139,13 +139,13 @@ import { IOrganizationUser } from '@gooddata/sdk-model';
 import { IOrganizationUserGroup } from '@gooddata/sdk-model';
 import { IParameterMetadataObject } from '@gooddata/sdk-model';
 import { IParameterMetadataObjectDefinition } from '@gooddata/sdk-model';
+import { IPublisherDocument } from '@gooddata/sdk-model';
+import { IPublisherDocumentDefinition } from '@gooddata/sdk-model';
+import { IPublisherDocumentTemplate } from '@gooddata/sdk-model';
+import { IPublisherDocumentTemplateDefinition } from '@gooddata/sdk-model';
+import { IPublisherPageLayout } from '@gooddata/sdk-model';
+import { IPublisherPageLayoutDefinition } from '@gooddata/sdk-model';
 import { IRelativeDateFilter } from '@gooddata/sdk-model';
-import { IReport } from '@gooddata/sdk-model';
-import { IReportDefinition } from '@gooddata/sdk-model';
-import { IReportPageLayout } from '@gooddata/sdk-model';
-import { IReportPageLayoutDefinition } from '@gooddata/sdk-model';
-import { IReportTemplate } from '@gooddata/sdk-model';
-import { IReportTemplateDefinition } from '@gooddata/sdk-model';
 import { IResultHeader } from '@gooddata/sdk-model';
 import { IResultWarning } from '@gooddata/sdk-model';
 import type { IScheduledMail } from '@gooddata/sdk-model';
@@ -919,11 +919,17 @@ export declare interface IAnalyticalWorkspace {
      */
     exportTemplates(): IWorkspaceExportTemplatesService;
     /**
-     * Returns service that can be used to manage report page layouts, report templates and reports.
+     * Returns service that can be used to manage page layouts, document templates and documents.
      *
      * @alpha
      */
-    reports(): IWorkspaceReportsService;
+    publisher(): IWorkspacePublisherService;
+    /**
+     * Returns service that reports how languages and translations are used in the workspace.
+     *
+     * @alpha
+     */
+    localization(): IWorkspaceLocalizationService;
 }
 
 /**
@@ -1485,6 +1491,8 @@ export declare interface IBackendCapabilities {
     canExecuteByReference?: boolean;
     /**
      * Indicates whether backend supports adding CSV datasets and switching between them.
+     *
+     * @deprecated No backend supports the CSV uploader any more. The capability is not read.
      */
     supportsCsvUploader?: boolean;
     /**
@@ -2146,48 +2154,48 @@ export declare type IChatConversationMultipartContent = {
  * GenAI Chat Conversation multipart content
  * @internal
  */
-export declare type IChatConversationMultipartPart = IChatConversationTextContent | IChatConversationVisualisationContent | IChatConversationAlertProposalContent | IChatConversationKeyDriverAnalysisContent | IChatConversationClarifyingQuestionsContent | IChatConversationWhatIfContent | IChatConversationSearchContent | IChatConversationDashboardContent | IChatConversationReportContent;
-
-/**
- * GenAI Chat Conversation reasoning content
- * @internal
- */
-export declare type IChatConversationReasoningContent = {
-    type: "reasoning";
-    summary: string;
-};
+export declare type IChatConversationMultipartPart = IChatConversationTextContent | IChatConversationVisualisationContent | IChatConversationAlertProposalContent | IChatConversationKeyDriverAnalysisContent | IChatConversationClarifyingQuestionsContent | IChatConversationWhatIfContent | IChatConversationSearchContent | IChatConversationDashboardContent | IChatConversationPublisherDocumentContent;
 
 /**
- * GenAI Chat Conversation report content
+ * GenAI Chat Conversation publisher document content
  * @internal
  */
-export declare type IChatConversationReportContent = {
-    type: "report";
+export declare type IChatConversationPublisherDocumentContent = {
+    type: "publisherDocument";
     /**
-     * Snapshot of the whole report, not a change to apply to an earlier one.
+     * Snapshot of the whole document, not a change to apply to an earlier one.
      */
-    report: IReportDefinition | null;
+    publisherDocument: IPublisherDocumentDefinition | null;
     /**
-     * Id of the report this version of the draft was saved as. Absent until it is saved.
+     * Id of the document this version of the draft was saved as. Absent until it is saved.
      */
     saved?: string | null;
     /**
-     * Name of the draft in the conversation, needed to record the report it is saved as.
+     * Name of the draft in the conversation, needed to record the document it is saved as.
      */
     ref?: string | null;
     /**
-     * Id of the saved report the draft edits. Saving the draft updates that report. Absent when the
-     * draft is a new report.
+     * Id of the saved document the draft edits. Saving the draft updates that document. Absent when the
+     * draft is a new document.
      */
-    baseReportId?: string | null;
+    baseDocumentId?: string | null;
     /**
      * Name of the draft version this one reworks. Absent for a first draft.
      */
     refines?: string | null;
     /**
-     * Whether this version was written from the report open in the editor, so the editor can apply it.
+     * Whether this version was written from the document open in the editor, so the editor can apply it.
      */
-    reworksOpenReport?: boolean;
+    reworksOpenDocument?: boolean;
+};
+
+/**
+ * GenAI Chat Conversation reasoning content
+ * @internal
+ */
+export declare type IChatConversationReasoningContent = {
+    type: "reasoning";
+    summary: string;
 };
 
 /**
@@ -2298,12 +2306,16 @@ export declare interface IChatConversationThread {
      */
     resaveVisualisation(oldVisualizationId: string, newVisualizationId: string): Promise<void>;
     /**
-     * Records the saved report that a report drafted in the conversation became.
+     * Save the user dashboard for the interaction.
+     */
+    resaveDashboard(dashboardId: string, newDashboardId: string): Promise<void>;
+    /**
+     * Records the saved document that a document drafted in the conversation became.
      *
-     * @param reportRef - name of the draft in the conversation
-     * @param savedReportId - id of the report it was saved as
+     * @param documentRef - name of the draft in the conversation
+     * @param savedDocumentId - id of the document it was saved as
      */
-    resaveReport(reportRef: string, savedReportId: string): Promise<void>;
+    resavePublisherDocument(documentRef: string, savedDocumentId: string): Promise<void>;
     /**
      * Add a user message to the chat thread.
      */
@@ -5343,6 +5355,224 @@ export declare interface ILlmProvidersQuery {
  */
 export declare type ILlmProvidersQueryResult = IPagedResource<ILlmProvider>;
 
+/**
+ * The value a workspace gets when neither it nor its ancestors set one.
+ *
+ * @alpha
+ */
+export declare interface ILocalizationDefault {
+    content: ILocalizationValueContent;
+    source: LocalizationUsageSource;
+}
+
+/**
+ * Paging of the localization lists.
+ *
+ * @alpha
+ */
+export declare interface ILocalizationPageQuery {
+    page?: number;
+    size?: number;
+}
+
+/**
+ * Resolved value of one setting in a usage list row.
+ *
+ * @alpha
+ */
+export declare interface ILocalizationResolvedValue {
+    content: ILocalizationValueContent;
+    source: LocalizationUsageSource;
+    /**
+     * Workspace the value is inherited from. Set only when `source` is `PARENT`.
+     */
+    originId?: string;
+}
+
+/**
+ * Workspaces and people that use a value for one setting.
+ *
+ * @alpha
+ */
+export declare interface ILocalizationSettingUsage {
+    workspaces: ILocalizationUsageCount;
+    users: ILocalizationUsageCount;
+}
+
+/**
+ * Languages with metadata or data-label translations in scope.
+ *
+ * @alpha
+ */
+export declare interface ILocalizationStatistics {
+    metadata: {
+        locales: ILocalizationTranslatedLocale[];
+    };
+    data: {
+        locales: ILocalizationTranslatedLocale[];
+    };
+}
+
+/**
+ * Translation coverage of what one workspace owns.
+ *
+ * @alpha
+ */
+export declare interface ILocalizationStatisticsWorkspace {
+    id: string;
+    name: string;
+    parentId: string | null;
+    sourceLanguage: string | null;
+    metadata: ILocalizationTranslationCoverage;
+    data: ILocalizationTranslationCoverage;
+}
+
+/**
+ * One page of the translation coverage per workspace.
+ *
+ * @alpha
+ */
+export declare interface ILocalizationStatisticsWorkspacesPage {
+    workspaces: ILocalizationStatisticsWorkspace[];
+    totalCount: number;
+}
+
+/**
+ * A language that has translations.
+ *
+ * @alpha
+ */
+export declare interface ILocalizationTranslatedLocale {
+    locale: string;
+}
+
+/**
+ * Translation coverage of one kind in one workspace.
+ *
+ * @remarks
+ * Metadata counts translatable texts; data counts labels.
+ *
+ * @alpha
+ */
+export declare interface ILocalizationTranslationCoverage {
+    total: number;
+    locales: Array<ILocalizationTranslatedLocale & {
+        translated: number;
+    }>;
+}
+
+/**
+ * Language usage summary of the localization overview.
+ *
+ * @alpha
+ */
+export declare interface ILocalizationUsage {
+    /**
+     * Defaults per setting. `null` when the setting has no default.
+     */
+    defaults: Record<LocalizationSettingType, ILocalizationDefault | null>;
+    /**
+     * One entry per language.
+     */
+    values: ILocalizationValueUsage[];
+}
+
+/**
+ * A count, split by the source of the value.
+ *
+ * @alpha
+ */
+export declare interface ILocalizationUsageCount {
+    total: number;
+    bySource: Partial<Record<LocalizationUsageSource, number>>;
+}
+
+/**
+ * Filters of the workspaces and people behind a usage count. All filters are optional.
+ *
+ * @alpha
+ */
+export declare interface ILocalizationUsageListQuery extends ILocalizationPageQuery {
+    value?: string;
+    setting?: LocalizationSettingType;
+    source?: LocalizationUsageSource;
+}
+
+/**
+ * One person behind a usage count.
+ *
+ * @alpha
+ */
+export declare interface ILocalizationUsageUser {
+    id: string;
+    name?: string;
+    email?: string;
+    source: LocalizationUsageSource;
+    bySetting: Partial<Record<LocalizationSettingType, ILocalizationResolvedValue>>;
+}
+
+/**
+ * One page of the people behind a usage count.
+ *
+ * @alpha
+ */
+export declare interface ILocalizationUsageUsersPage {
+    users: ILocalizationUsageUser[];
+    totalCount: number;
+}
+
+/**
+ * One workspace behind a usage count.
+ *
+ * @alpha
+ */
+export declare interface ILocalizationUsageWorkspace {
+    id: string;
+    name: string;
+    parentId: string | null;
+    childrenCount: number;
+    source: LocalizationUsageSource;
+    bySetting: Partial<Record<LocalizationSettingType, ILocalizationResolvedValue>>;
+}
+
+/**
+ * One page of the workspaces behind a usage count.
+ *
+ * @alpha
+ */
+export declare interface ILocalizationUsageWorkspacesPage {
+    workspaces: ILocalizationUsageWorkspace[];
+    totalCount: number;
+}
+
+/**
+ * Locale value. A `null` value means no value.
+ *
+ * @alpha
+ */
+export declare interface ILocalizationValueContent {
+    value: string | null;
+}
+
+/**
+ * Usage of one language across the three locale settings.
+ *
+ * @remarks
+ * The top-level counts include each workspace and person once, under the strongest source.
+ * At organization level, people count only under a value they set themselves.
+ *
+ * @alpha
+ */
+export declare interface ILocalizationValueUsage {
+    content: ILocalizationValueContent;
+    workspaces: ILocalizationUsageCount;
+    users: ILocalizationUsageCount;
+    /**
+     * The same counts per setting. Settings that nothing uses the value for are left out.
+     */
+    bySetting: Partial<Record<LocalizationSettingType, ILocalizationSettingUsage>>;
+}
+
 /**
  * Token representing part of parsed MAQL measure expression.
  *
@@ -5891,6 +6121,12 @@ export declare interface IOrganization {
      * @alpha
      */
     ipAllowlists(): IOrganizationIpAllowlistService;
+    /**
+     * Returns service that reports how languages and translations are used across the organization.
+     *
+     * @alpha
+     */
+    localization(): IOrganizationLocalizationService;
 }
 
 /**
@@ -6457,6 +6693,34 @@ export declare interface IOrganizationLlmProvidersService {
     listLlmProviderModels(provider: Partial<LlmProviderPatch>): Promise<LlmProviderListModelsResults>;
 }
 
+/**
+ * Reads how languages and translations are used across the organization.
+ *
+ * @alpha
+ */
+export declare interface IOrganizationLocalizationService {
+    /**
+     * Summarize language usage across all workspaces and people.
+     */
+    getUsage(): Promise<ILocalizationUsage>;
+    /**
+     * List the workspaces behind a usage count, sorted by name.
+     */
+    getUsageWorkspaces(query?: ILocalizationUsageListQuery): Promise<ILocalizationUsageWorkspacesPage>;
+    /**
+     * List the people behind a usage count, sorted by name.
+     */
+    getUsageUsers(query?: ILocalizationUsageListQuery): Promise<ILocalizationUsageUsersPage>;
+    /**
+     * List the languages with translations in the organization.
+     */
+    getStatistics(): Promise<ILocalizationStatistics>;
+    /**
+     * List translation coverage per workspace.
+     */
+    getStatisticsWorkspaces(query?: ILocalizationPageQuery): Promise<ILocalizationStatisticsWorkspacesPage>;
+}
+
 /**
  * This service provides access to organization notifications channels.
  *
@@ -6835,6 +7099,22 @@ export declare interface IOrganizationSettingsService {
      * @alpha
      */
     getAiRateLimit(): Promise<IAiRateLimit | undefined>;
+    /**
+     * Returns the metadata locale set on the organization (without resolving inherited defaults).
+     * Returns `undefined` when the organization has none.
+     *
+     * @returns promise
+     * @alpha
+     */
+    getMetadataLocale(): Promise<string | undefined>;
+    /**
+     * Returns the data locale set on the organization (without resolving inherited defaults).
+     * Returns `undefined` when the organization has none.
+     *
+     * @returns promise
+     * @alpha
+     */
+    getDataLocale(): Promise<string | undefined>;
     /**
      * Sets enable drill to URL by default configuration for organization.
      *
@@ -7592,6 +7872,25 @@ export declare interface IPreparedExecutionOptions {
     context?: IExecutionContext;
 }
 
+/**
+ * Options for exporting a document to PDF.
+ *
+ * @alpha
+ */
+export declare interface IPublisherDocumentExportPdfOptions {
+    /**
+     * File name for the export, without the extension.
+     */
+    filename?: string;
+    /**
+     * Override the default export result polling timeout (in milliseconds).
+     *
+     * @remarks
+     * If not specified, there is still a default timeout applied.
+     */
+    timeout?: number;
+}
+
 /**
  * Custom title override for raw exports.
  *
@@ -7648,25 +7947,6 @@ export declare interface IReferencesService {
     getReferences(root: IdentifierRef | IdentifierRef[], opts?: IReferencesOption): Promise<IReferencesResult>;
 }
 
-/**
- * Options for exporting a report to PDF.
- *
- * @alpha
- */
-export declare interface IReportExportPdfOptions {
-    /**
-     * File name for the export, without the extension.
-     */
-    filename?: string;
-    /**
-     * Override the default export result polling timeout (in milliseconds).
-     *
-     * @remarks
-     * If not specified, there is still a default timeout applied.
-     */
-    timeout?: number;
-}
-
 /**
  * Correlation metadata that will be included in HTTP requests.
  * The exact mechanism for including correlation metadata in requests
@@ -7765,16 +8045,16 @@ export declare function isChatConversationKeyDriverAnalysisContent(content: ICha
 export declare function isChatConversationMultipartContent(content: IChatConversationContent): content is IChatConversationMultipartContent;
 
 /**
- * Is chat conversation reasoning content
+ * Is chat conversation publisher document content
  * @internal
  */
-export declare function isChatConversationReasoningContent(content: IChatConversationContent): content is IChatConversationReasoningContent;
+export declare function isChatConversationPublisherDocumentContent(content: IChatConversationMultipartPart): content is IChatConversationPublisherDocumentContent;
 
 /**
- * Is chat conversation report content
+ * Is chat conversation reasoning content
  * @internal
  */
-export declare function isChatConversationReportContent(content: IChatConversationMultipartPart): content is IChatConversationReportContent;
+export declare function isChatConversationReasoningContent(content: IChatConversationContent): content is IChatConversationReasoningContent;
 
 /**
  * Is chat conversation search content
@@ -9694,6 +9974,37 @@ export declare interface IWorkspaceKeyDriverAnalysisService {
     cancelChangeAnalysis(): Promise<void>;
 }
 
+/**
+ * Reads how languages and translations are used in one workspace.
+ *
+ * @remarks
+ * Usage covers the workspace alone. Statistics cover the workspace and its ancestors.
+ *
+ * @alpha
+ */
+export declare interface IWorkspaceLocalizationService {
+    /**
+     * Summarize language usage in the workspace and among the people with access to it.
+     */
+    getUsage(): Promise<ILocalizationUsage>;
+    /**
+     * List the workspaces behind a usage count, sorted by name.
+     */
+    getUsageWorkspaces(query?: ILocalizationUsageListQuery): Promise<ILocalizationUsageWorkspacesPage>;
+    /**
+     * List the people behind a usage count, sorted by name.
+     */
+    getUsageUsers(query?: ILocalizationUsageListQuery): Promise<ILocalizationUsageUsersPage>;
+    /**
+     * List the languages with translations in the workspace and its ancestors.
+     */
+    getStatistics(): Promise<ILocalizationStatistics>;
+    /**
+     * List translation coverage of the workspace and its ancestors.
+     */
+    getStatisticsWorkspaces(query?: ILocalizationPageQuery): Promise<ILocalizationStatisticsWorkspacesPage>;
+}
+
 /**
  * Service for querying information about logical data model.
  *
@@ -9912,83 +10223,83 @@ export declare interface IWorkspacePermissionsService {
 }
 
 /**
- * Service for managing report page layouts, report templates and reports.
+ * Service for managing page layouts, document templates and documents.
  *
  * @remarks
- * Report page layouts returned by this service include the built-in layouts shipped with the
- * product ({@link @gooddata/sdk-model#BuiltInReportPageLayouts}). Built-ins carry
+ * Page layouts returned by this service include the built-in layouts shipped with the
+ * product ({@link @gooddata/sdk-model#BuiltInPublisherPageLayouts}). Built-ins carry
  * `isBuiltIn: true`, are never persisted on the backend, and reject update and delete.
  *
  * @alpha
  */
-export declare interface IWorkspaceReportsService {
+export declare interface IWorkspacePublisherService {
     /**
-     * Get the list of report page layouts available in the workspace, built-in layouts first.
+     * Get the list of page layouts available in the workspace, built-in layouts first.
      */
-    getReportPageLayouts(): Promise<IReportPageLayout[]>;
+    getPageLayouts(): Promise<IPublisherPageLayout[]>;
     /**
-     * Get a single report page layout by its reference.
+     * Get a single page layout by its reference.
      */
-    getReportPageLayout(ref: ObjRef): Promise<IReportPageLayout>;
+    getPageLayout(ref: ObjRef): Promise<IPublisherPageLayout>;
     /**
-     * Create a new report page layout.
+     * Create a new page layout.
      */
-    createReportPageLayout(page: IReportPageLayoutDefinition): Promise<IReportPageLayout>;
+    createPageLayout(page: IPublisherPageLayoutDefinition): Promise<IPublisherPageLayout>;
     /**
-     * Update an existing report page layout. Rejects built-in and locked layouts.
+     * Update an existing page layout. Rejects built-in and locked layouts.
      */
-    updateReportPageLayout(page: IReportPageLayout): Promise<IReportPageLayout>;
+    updatePageLayout(page: IPublisherPageLayout): Promise<IPublisherPageLayout>;
     /**
-     * Delete an existing report page layout. Rejects built-in and locked layouts.
+     * Delete an existing page layout. Rejects built-in and locked layouts.
      */
-    deleteReportPageLayout(ref: ObjRef): Promise<void>;
+    deletePageLayout(ref: ObjRef): Promise<void>;
     /**
-     * Get the list of report templates available in the workspace.
+     * Get the list of document templates available in the workspace.
      */
-    getReportTemplates(): Promise<IReportTemplate[]>;
+    getDocumentTemplates(): Promise<IPublisherDocumentTemplate[]>;
     /**
-     * Get a single report template by its reference.
+     * Get a single document template by its reference.
      */
-    getReportTemplate(ref: ObjRef): Promise<IReportTemplate>;
+    getDocumentTemplate(ref: ObjRef): Promise<IPublisherDocumentTemplate>;
     /**
-     * Create a new report template.
+     * Create a new document template.
      */
-    createReportTemplate(template: IReportTemplateDefinition): Promise<IReportTemplate>;
+    createDocumentTemplate(template: IPublisherDocumentTemplateDefinition): Promise<IPublisherDocumentTemplate>;
     /**
-     * Update an existing report template. Rejects locked templates.
+     * Update an existing document template. Rejects locked templates.
      */
-    updateReportTemplate(template: IReportTemplate): Promise<IReportTemplate>;
+    updateDocumentTemplate(template: IPublisherDocumentTemplate): Promise<IPublisherDocumentTemplate>;
     /**
-     * Delete an existing report template.
+     * Delete an existing document template.
      */
-    deleteReportTemplate(ref: ObjRef): Promise<void>;
+    deleteDocumentTemplate(ref: ObjRef): Promise<void>;
     /**
-     * Get the list of reports available in the workspace.
+     * Get the list of documents available in the workspace.
      */
-    getReports(): Promise<IReport[]>;
+    getDocuments(): Promise<IPublisherDocument[]>;
     /**
-     * Get a single report by its reference.
+     * Get a single document by its reference.
      */
-    getReport(ref: ObjRef): Promise<IReport>;
+    getDocument(ref: ObjRef): Promise<IPublisherDocument>;
     /**
-     * Create a new report.
+     * Create a new document.
      */
-    createReport(report: IReportDefinition): Promise<IReport>;
+    createDocument(publisherDocument: IPublisherDocumentDefinition): Promise<IPublisherDocument>;
     /**
-     * Update an existing report. Rejects locked reports.
+     * Update an existing document. Rejects locked documents.
      */
-    updateReport(report: IReport): Promise<IReport>;
+    updateDocument(publisherDocument: IPublisherDocument): Promise<IPublisherDocument>;
     /**
-     * Delete an existing report.
+     * Delete an existing document.
      */
-    deleteReport(ref: ObjRef): Promise<void>;
+    deleteDocument(ref: ObjRef): Promise<void>;
     /**
-     * Export a report to PDF.
+     * Export a document to PDF.
      *
      * @remarks
-     * The backend renders the report as it is saved, so unsaved changes are not part of the export.
+     * The backend renders the document as it is saved, so unsaved changes are not part of the export.
      */
-    exportReportToPdf(ref: ObjRef, options?: IReportExportPdfOptions): Promise<IExportResult>;
+    exportDocumentToPdf(ref: ObjRef, options?: IPublisherDocumentExportPdfOptions): Promise<IExportResult>;
 }
 
 export { IWorkspaceSettings }
@@ -10760,6 +11071,23 @@ export declare class LimitReached extends AnalyticalBackendError {
     constructor(message: string, cause?: Error);
 }
 
+/**
+ * Locale setting covered by the localization overview.
+ *
+ * @alpha
+ */
+export declare type LocalizationSettingType = "LOCALE" | "METADATA_LOCALE" | "DATA_LOCALE";
+
+/**
+ * Where a locale value comes from.
+ *
+ * @remarks
+ * `PARENT` means the value is inherited from an ancestor workspace; see `originId`.
+ *
+ * @alpha
+ */
+export declare type LocalizationUsageSource = "USER" | "WORKSPACE" | "PARENT" | "ORGANIZATION" | "ENVIRONMENT" | "DEFAULT";
+
 /**
  * This exception MUST be thrown when the backend execution identifies that there is no data to
  * calculate.