import { type DashboardFiltersApplyMode, type IActiveCalendars, type IAiRateLimit, type IAlertDefault, type IDefaultExportTemplate, type IFiscalYear, type IMetricFormatOverrideSetting, type IOpenAiConfig, type ISeparators, type ISettings, type IWhiteLabeling } from "@gooddata/sdk-model"; /** * This service provides access to organization settings * * @public */ export interface IOrganizationSettingsService { /** * Sets whiteLabeling for organization. * * @param whiteLabeling - describes whitelabeling setting for logoUrl, faviconUrl etc. * * @returns promise */ setWhiteLabeling(whiteLabeling: IWhiteLabeling): Promise; /** * Sets locale for organization. * * @param locale - IETF BCP 47 Code locale ID, for example "en-US", "cs-CZ", etc. * * @returns promise */ setLocale(locale: string): Promise; /** * Sets metadata locale for organization. * * @param locale - IETF BCP 47 Code locale ID, for example "en-US", "cs-CZ", etc. * * @returns promise */ setMetadataLocale(locale: string): Promise; /** * Sets format locale for organization. * * @param locale - IETF BCP 47 Code locale ID, for example "en-US", "cs-CZ", etc. * * @returns promise */ setFormatLocale(locale: string): Promise; /** * Set separators for the organization * * @param separators - separators for the organization * * @returns promise */ setSeparators(separators: ISeparators): Promise; /** * Set active LLM endpoint for the organization. * * @param endpoint - id of the LLM endpoint to set as active for the organization. * * @returns promise */ setActiveLlmEndpoint(endpoint: string): Promise; /** * Deletes active LLM endpoint for the organization. * * @returns promise */ deleteActiveLlmEndpoint(): Promise; /** * Set active LLM provider for the organization. * * @param provider - id of the LLM provider to set as active for the organization. * @param defaultModelId - id of the default model to use for the provider. */ setActiveLlmProvider(provider: string, defaultModelId: string): Promise; /** * Deletes active LLM provider for the organization. */ deleteActiveLlmProvider(): Promise; /** * Sets timezone for organization. * * @param timezone - the value based on IANA time zone database naming convention. * for example: "America/Los_Angeles", etc. * * @returns promise */ setTimezone(timezone: string): Promise; /** * Sets whether end users may change the timezone in Analytical Designer and, by default, on dashboards. * * @param enabled - whether end users may change the timezone * * @returns promise * @alpha */ setEnableTimezoneChange(enabled: boolean): Promise; /** * Sets date format for organization. * * @param dateFormat - the format based on the ICU standard, for example: "en-US", "cs-CZ", etc. * * @returns promise */ setDateFormat(dateFormat: string): Promise; /** * Sets attachment size limit sent to email for organization. * * @param size - the size in bytes. * * @returns promise */ setAttachmentSizeLimit(size: number): Promise; /** * Sets the default CSV delimiter for exports in the organization. * * @param delimiter - single character delimiter to use for CSV exports. * * @returns promise * @alpha */ setExportCsvCustomDelimiter(delimiter: string): Promise; /** * Clears the organization CSV delimiter configuration so the default (comma) is used. * * @returns promise * @alpha */ deleteExportCsvCustomDelimiter(): Promise; /** * Sets first day of week for organization. * * @param weekStart - "Sunday | "Monday" * * @returns promise */ setWeekStart(weekStart: string): Promise; /** * Sets fiscal calendar for organization. * * @param fiscalYear - fiscal year configuration including month offset and optional prefixes. * * @returns promise */ setFiscalCalendar(fiscalYear: IFiscalYear): Promise; /** * Sets active calendars configuration for organization. * * @param calendars - configuration for which calendars are enabled and which is the default. * * @returns promise */ setActiveCalendars(calendars: IActiveCalendars): Promise; /** * Sets theme for organization. * * @param themeId - ID of the theme to apply to workspaces in organization. * * @returns promise */ setTheme(themeId: string): Promise; /** * Sets alert default * * @param value - describes parameters for alerting. * * @returns promise */ setAlertDefault(value: IAlertDefault): Promise; /** * Sets color palette for organization. * * @param colorPaletteId - ID of the color palette to apply to charts in organization. * * @returns promise */ setColorPalette(colorPaletteId: string): Promise; /** * Sets OpenAI configuration for organization. * * @param config - describes parameters for OpenAI integration. * * @returns promise * @alpha */ setOpenAiConfig(config: IOpenAiConfig): Promise; /** * Sets DashboardFiltersApplyMode configuration for organization. * * @param dashboardFiltersApplyMode - describes new mode for applying dashboard filters. * * @returns promise * @alpha */ setDashboardFiltersApplyMode(dashboardFiltersApplyMode: DashboardFiltersApplyMode): Promise; /** * Sets the default export template applied to slide exports when none is explicitly requested. * * @param value - identifier and scope of the export template to use as the default. * * @returns promise * @beta */ setDefaultExportTemplate(value: IDefaultExportTemplate): Promise; /** * Deletes the default export template setting from the organization, reverting to the built-in default. * * @returns promise * @beta */ deleteDefaultExportTemplate(): Promise; /** * Sets enable AI on data setting for organization. * * @param enabled - whether to enable sending aggregated data to LLM. * * @returns promise * @alpha */ setEnableAiOnData(enabled: boolean): Promise; /** * Sets AI rate limit for the organization. * * @param value - max interactions and rolling time window for AI chat. * * @returns promise * @alpha */ setAiRateLimit(value: IAiRateLimit): Promise; /** * Deletes AI rate limit override for the organization, reverting to the platform default. * * @returns promise * @alpha */ deleteAiRateLimit(): Promise; /** * Returns the AI rate limit value owned by the organization (without resolving inherited defaults). * Returns `undefined` when the organization has no override. * * @returns promise * @alpha */ getAiRateLimit(): Promise; /** * Sets enable drill to URL by default configuration for organization. * * @param enabled - whether to enable drill to URL by default for dashboard widgets. * * @returns promise * @alpha */ setEnableDrillToUrlByDefault(enabled: boolean): Promise; /** * Sets enable partial data results configuration for organization. * * @remarks * When enabled, executions that reach a row/column/cell limit return partial data (with limit-break * metadata) instead of failing. Workspaces inherit this value unless they override it. * * @param enabled - whether to allow partial data results for executions. * * @returns promise * @alpha */ setEnablePartialDataResults(enabled: boolean): Promise; /** * Sets enable null joins configuration for organization. * * @remarks * When enabled, generated SQL joins coalesce null values before comparing join keys. Workspaces inherit * this value unless they override it. * * @param enabled - whether to enable null value matching in SQL joins. * * @returns promise * @alpha */ setEnableNullJoins(enabled: boolean): Promise; /** * Sets enable query tags setting for organization. * * @param enabled - whether to enable query tags for this organization. * * @returns promise * @alpha */ setEnableQueryTags(enabled: boolean): Promise; /** * Deletes theme from organization settings returning workspace styling to default. * * @returns promise */ deleteTheme(): Promise; /** * Deletes color palette from organization settings returning chart colors to default. * * @returns promise */ deleteColorPalette(): Promise; /** * Sets metric format override for organization. * * @param override - mapping of metric types to custom format strings. * * @returns promise */ setMetricFormatOverride(override: IMetricFormatOverrideSetting): Promise; /** * Sets the maximum zoom level allowed for geo visualizations in the organization. * * @param level - maximum zoom level, or null to clear the limit. * * @returns promise */ setMaxZoomLevel(level: number | null): Promise; /** * Sets the geo icon sprite sheet URL for the organization. * * @param url - URL of the Mapbox sprite sheet (without file extension). * * @returns promise * @alpha */ setGeoIconSheet(url: string): Promise; /** * Deletes the geo icon sprite sheet setting from the organization. * * @returns promise * @alpha */ deleteGeoIconSheet(): Promise; /** * Returns effective organization settings with all defaults resolved. * * @remarks * The returned settings include system defaults, not just those directly set * at the organization level. User-specific overrides are excluded. * User has to have an organization level permission to access them. * * @returns promise of resolved settings */ getSettings(): Promise; } //# sourceMappingURL=index.d.ts.map