import { type IReport, type IReportDefinition, type IReportPageLayout, type IReportPageLayoutDefinition, type IReportTemplate, type IReportTemplateDefinition, type IReportsBrandKit, type ObjRef } from "@gooddata/sdk-model"; /** * Service for managing report page layouts, report templates and reports. * * @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 * `isBuiltIn: true`, are never persisted on the backend, and reject update and delete. * * @alpha */ export interface IWorkspaceReportsService { /** * Get the list of report page layouts available in the workspace, built-in layouts first. */ getReportPageLayouts(): Promise; /** * Get a single report page layout by its reference. */ getReportPageLayout(ref: ObjRef): Promise; /** * Create a new report page layout. */ createReportPageLayout(page: IReportPageLayoutDefinition): Promise; /** * Update an existing report page layout. Rejects built-in and locked layouts. */ updateReportPageLayout(page: IReportPageLayout): Promise; /** * Delete an existing report page layout. Rejects built-in and locked layouts. */ deleteReportPageLayout(ref: ObjRef): Promise; /** * Get the list of report templates available in the workspace. */ getReportTemplates(): Promise; /** * Get a single report template by its reference. */ getReportTemplate(ref: ObjRef): Promise; /** * Create a new report template. */ createReportTemplate(template: IReportTemplateDefinition): Promise; /** * Update an existing report template. Rejects locked templates. */ updateReportTemplate(template: IReportTemplate): Promise; /** * Delete an existing report template. */ deleteReportTemplate(ref: ObjRef): Promise; /** * Get the list of reports available in the workspace. */ getReports(): Promise; /** * Get a single report by its reference. */ getReport(ref: ObjRef): Promise; /** * Create a new report. */ createReport(report: IReportDefinition): Promise; /** * Update an existing report. Rejects locked reports. */ updateReport(report: IReport): Promise; /** * Delete an existing report. */ deleteReport(ref: ObjRef): Promise; /** * Get the workspace brand kit, or undefined when none is set. * * @remarks * Backed by the `reportsBrandKit` workspace setting. The stored content is free-form JSON; * implementations sanitize it ({@link @gooddata/sdk-model#sanitizeReportsBrandKit}) so the * result is always a valid kit. */ getBrandKit(): Promise; /** * Set the workspace brand kit. */ setBrandKit(brandKit: IReportsBrandKit): Promise; /** * Delete the workspace brand kit. */ deleteBrandKit(): Promise; } //# sourceMappingURL=index.d.ts.map