@gooddata/api-client-tiger 11.63.0-alpha.3 → 11.63.0-alpha.5

package/esm/generated/metadata-json-api/api.d.ts

@@ -1386,7 +1386,7 @@ export interface DeclarativeAgent {
      */
     'userGroups'?: Array<DeclarativeUserGroupIdentifier>;
 }
-export type DeclarativeAgentCustomSkillsEnum = 'alert' | 'anomaly_detection' | 'clustering' | 'forecasting' | 'key_driver_analysis' | 'metric' | 'schedule_export' | 'visualization' | 'visualization_summary' | 'dashboard_summary' | 'what_if_analysis' | 'knowledge' | 'dashboard_builder' | 'dashboard_editor' | 'report_builder';
+export type DeclarativeAgentCustomSkillsEnum = 'alert' | 'anomaly_detection' | 'clustering' | 'forecasting' | 'key_driver_analysis' | 'metric' | 'schedule_export' | 'visualization' | 'visualization_summary' | 'dashboard_summary' | 'what_if_analysis' | 'knowledge' | 'dashboard_builder' | 'dashboard_editor' | 'report_builder' | 'document_builder';
 export type DeclarativeAgentSkillsModeEnum = 'all' | 'custom';
 /**
  * AI agent configurations.
@@ -1466,7 +1466,7 @@ export interface DeclarativeAnalyticalDashboard {
     'modifiedAt'?: string | null;
     'modifiedBy'?: DeclarativeUserIdentifier;
     /**
-     * A list of permissions.
+     * A list of permissions. A PUT without this property removes all existing permissions.
      */
     'permissions'?: Array<DeclarativeAnalyticalDashboardPermissionsInner>;
     /**
@@ -2632,6 +2632,10 @@ export interface DeclarativeMetric {
      */
     'modifiedAt'?: string | null;
     'modifiedBy'?: DeclarativeUserIdentifier;
+    /**
+     * A list of permissions. A PUT without this property keeps the existing permissions. An empty list removes all of them.
+     */
+    'permissions'?: Array<DeclarativeMetricPermissionsInner> | null;
     /**
      * A list of tags.
      */
@@ -2642,6 +2646,42 @@ export interface DeclarativeMetric {
     'title': string;
 }
 export type DeclarativeMetricCertificationEnum = 'CERTIFIED';
+/**
+ * Metric permission.
+ */
+export interface DeclarativeMetricPermissionAssignment {
+    /**
+     * Permission name.
+     */
+    'name': DeclarativeMetricPermissionAssignmentNameEnum;
+}
+export type DeclarativeMetricPermissionAssignmentNameEnum = 'EDIT' | 'SHARE' | 'VIEW';
+/**
+ * Metric permission for an assignee.
+ */
+export interface DeclarativeMetricPermissionForAssignee {
+    /**
+     * Permission name.
+     */
+    'name': DeclarativeMetricPermissionForAssigneeNameEnum;
+    'assignee': AssigneeIdentifier;
+}
+export type DeclarativeMetricPermissionForAssigneeNameEnum = 'EDIT' | 'SHARE' | 'VIEW';
+/**
+ * Metric permission for a collection of assignees identified by a rule.
+ */
+export interface DeclarativeMetricPermissionForAssigneeRule {
+    /**
+     * Permission name.
+     */
+    'name': DeclarativeMetricPermissionForAssigneeRuleNameEnum;
+    'assigneeRule': AssigneeRule;
+}
+export type DeclarativeMetricPermissionForAssigneeRuleNameEnum = 'EDIT' | 'SHARE' | 'VIEW';
+/**
+ * @type DeclarativeMetricPermissionsInner
+ */
+export type DeclarativeMetricPermissionsInner = DeclarativeMetricPermissionForAssignee | DeclarativeMetricPermissionForAssigneeRule;
 /**
  * A data model structured as a set of its attributes.
  */
@@ -3251,6 +3291,10 @@ export interface DeclarativeVisualizationObject {
      */
     'modifiedAt'?: string | null;
     'modifiedBy'?: DeclarativeUserIdentifier;
+    /**
+     * A list of permissions. A PUT without this property keeps the existing permissions. An empty list removes all of them.
+     */
+    'permissions'?: Array<DeclarativeVisualizationObjectPermissionsInner> | null;
     /**
      * A list of tags.
      */
@@ -3261,6 +3305,42 @@ export interface DeclarativeVisualizationObject {
     'title': string;
 }
 export type DeclarativeVisualizationObjectCertificationEnum = 'CERTIFIED';
+/**
+ * Visualization object permission.
+ */
+export interface DeclarativeVisualizationObjectPermissionAssignment {
+    /**
+     * Permission name.
+     */
+    'name': DeclarativeVisualizationObjectPermissionAssignmentNameEnum;
+}
+export type DeclarativeVisualizationObjectPermissionAssignmentNameEnum = 'EDIT' | 'SHARE' | 'VIEW';
+/**
+ * Visualization object permission for an assignee.
+ */
+export interface DeclarativeVisualizationObjectPermissionForAssignee {
+    /**
+     * Permission name.
+     */
+    'name': DeclarativeVisualizationObjectPermissionForAssigneeNameEnum;
+    'assignee': AssigneeIdentifier;
+}
+export type DeclarativeVisualizationObjectPermissionForAssigneeNameEnum = 'EDIT' | 'SHARE' | 'VIEW';
+/**
+ * Visualization object permission for a collection of assignees identified by a rule.
+ */
+export interface DeclarativeVisualizationObjectPermissionForAssigneeRule {
+    /**
+     * Permission name.
+     */
+    'name': DeclarativeVisualizationObjectPermissionForAssigneeRuleNameEnum;
+    'assigneeRule': AssigneeRule;
+}
+export type DeclarativeVisualizationObjectPermissionForAssigneeRuleNameEnum = 'EDIT' | 'SHARE' | 'VIEW';
+/**
+ * @type DeclarativeVisualizationObjectPermissionsInner
+ */
+export type DeclarativeVisualizationObjectPermissionsInner = DeclarativeVisualizationObjectPermissionForAssignee | DeclarativeVisualizationObjectPermissionForAssigneeRule;
 /**
  * A declarative form of a particular workspace.
  */
@@ -3994,7 +4074,7 @@ export interface JsonApiAgentInAttributes {
     'personality'?: string | null;
     'skillsMode'?: JsonApiAgentInAttributesSkillsModeEnum;
 }
-export type JsonApiAgentInAttributesCustomSkillsEnum = 'alert' | 'anomaly_detection' | 'clustering' | 'forecasting' | 'key_driver_analysis' | 'metric' | 'schedule_export' | 'visualization' | 'visualization_summary' | 'dashboard_summary' | 'what_if_analysis' | 'knowledge' | 'dashboard_builder' | 'dashboard_editor' | 'report_builder';
+export type JsonApiAgentInAttributesCustomSkillsEnum = 'alert' | 'anomaly_detection' | 'clustering' | 'forecasting' | 'key_driver_analysis' | 'metric' | 'schedule_export' | 'visualization' | 'visualization_summary' | 'dashboard_summary' | 'what_if_analysis' | 'knowledge' | 'dashboard_builder' | 'dashboard_editor' | 'report_builder' | 'document_builder';
 export type JsonApiAgentInAttributesSkillsModeEnum = 'all' | 'custom';
 /**
  * Rule that an agent follows when answering.
@@ -4063,7 +4143,7 @@ export interface JsonApiAgentOutAttributes {
     'personality'?: string | null;
     'skillsMode'?: JsonApiAgentOutAttributesSkillsModeEnum;
 }
-export type JsonApiAgentOutAttributesCustomSkillsEnum = 'alert' | 'anomaly_detection' | 'clustering' | 'forecasting' | 'key_driver_analysis' | 'metric' | 'schedule_export' | 'visualization' | 'visualization_summary' | 'dashboard_summary' | 'what_if_analysis' | 'knowledge' | 'dashboard_builder' | 'dashboard_editor' | 'report_builder';
+export type JsonApiAgentOutAttributesCustomSkillsEnum = 'alert' | 'anomaly_detection' | 'clustering' | 'forecasting' | 'key_driver_analysis' | 'metric' | 'schedule_export' | 'visualization' | 'visualization_summary' | 'dashboard_summary' | 'what_if_analysis' | 'knowledge' | 'dashboard_builder' | 'dashboard_editor' | 'report_builder' | 'document_builder';
 export type JsonApiAgentOutAttributesSkillsModeEnum = 'all' | 'custom';
 /**
  * Rule that an agent follows when answering.
@@ -4187,7 +4267,7 @@ export interface JsonApiAgentPatchAttributes {
     'personality'?: string | null;
     'skillsMode'?: JsonApiAgentPatchAttributesSkillsModeEnum;
 }
-export type JsonApiAgentPatchAttributesCustomSkillsEnum = 'alert' | 'anomaly_detection' | 'clustering' | 'forecasting' | 'key_driver_analysis' | 'metric' | 'schedule_export' | 'visualization' | 'visualization_summary' | 'dashboard_summary' | 'what_if_analysis' | 'knowledge' | 'dashboard_builder' | 'dashboard_editor' | 'report_builder';
+export type JsonApiAgentPatchAttributesCustomSkillsEnum = 'alert' | 'anomaly_detection' | 'clustering' | 'forecasting' | 'key_driver_analysis' | 'metric' | 'schedule_export' | 'visualization' | 'visualization_summary' | 'dashboard_summary' | 'what_if_analysis' | 'knowledge' | 'dashboard_builder' | 'dashboard_editor' | 'report_builder' | 'document_builder';
 export type JsonApiAgentPatchAttributesSkillsModeEnum = 'all' | 'custom';
 /**
  * Rule that an agent follows when answering.
@@ -14762,6 +14842,12 @@ export interface LocalizationCount {
     'bySource': LocalizationSourceCounts;
     'total': number;
 }
+/**
+ * Translations of labels in the logical data model. `locales` lists the languages with at least one label translation, sorted. Language tags do not include extensions.
+ */
+export interface LocalizationDataStatistics {
+    'locales': Array<LocalizationStatisticsLocale>;
+}
 export interface LocalizationDefault {
     'content': LocalizationContent;
     /**
@@ -14778,6 +14864,12 @@ export interface LocalizationDefaults {
     'LOCALE'?: LocalizationDefault | null;
     'METADATA_LOCALE'?: LocalizationDefault | null;
 }
+/**
+ * Translations of titles, descriptions, tags and free-form texts of workspace objects. `locales` lists the languages that have stored translations, sorted. A language counts once translations for it are uploaded, even when they are empty.
+ */
+export interface LocalizationMetadataStatistics {
+    'locales': Array<LocalizationStatisticsLocale>;
+}
 export interface LocalizationResolvedValue {
     'content': LocalizationContent;
     /**
@@ -14821,6 +14913,16 @@ export interface LocalizationSourceCounts {
     'USER'?: number;
     'WORKSPACE'?: number;
 }
+export interface LocalizationStatistics {
+    'data': LocalizationDataStatistics;
+    'metadata': LocalizationMetadataStatistics;
+}
+export interface LocalizationStatisticsLocale {
+    /**
+     * Language tag.
+     */
+    'locale': string;
+}
 export interface LocalizationUsage {
     'defaults': LocalizationDefaults;
     'values': Array<LocalizationUsageValue>;
@@ -17116,6 +17218,14 @@ export declare function ActionsApiAxiosParamCreator_ManageWorkspacePermissions(w
  * @throws {RequiredError}
  */
 export declare function ActionsApiAxiosParamCreator_MetricPermissions(workspaceId: string, metricId: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
+/**
+ * (BETA) Lists the languages that have at least one translation, separately for each kind of translation.
+ * @summary (BETA) Languages with translations in the organization.
+ * @param {*} [options] Override http request option.
+ * @param {Configuration} [configuration] Optional configuration.
+ * @throws {RequiredError}
+ */
+export declare function ActionsApiAxiosParamCreator_OrganizationLocalizationStatistics(options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
 /**
  * (BETA) Counts workspaces and users per language of the display, metadata and data language settings. Users count only under the languages they set themselves.
  * @summary (BETA) Languages used in the organization.
@@ -17769,6 +17879,16 @@ export declare function ActionsApi_ManageWorkspacePermissions(axios: AxiosInstan
  * @throws {RequiredError}
  */
 export declare function ActionsApi_MetricPermissions(axios: AxiosInstance, basePath: string, requestParameters: ActionsApiMetricPermissionsRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<MetricPermissions>;
+/**
+ * (BETA) Lists the languages that have at least one translation, separately for each kind of translation.
+ * @summary (BETA) Languages with translations in the organization.
+ * @param {AxiosInstance} axios Axios instance.
+ * @param {string} basePath Base path.
+ * @param {*} [options] Override http request option.
+ * @param {Configuration} [configuration] Optional configuration.
+ * @throws {RequiredError}
+ */
+export declare function ActionsApi_OrganizationLocalizationStatistics(axios: AxiosInstance, basePath: string, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<LocalizationStatistics>;
 /**
  * (BETA) Counts workspaces and users per language of the display, metadata and data language settings. Users count only under the languages they set themselves.
  * @summary (BETA) Languages used in the organization.
@@ -18407,6 +18527,14 @@ export interface ActionsApiInterface {
      * @memberof ActionsApiInterface
      */
     metricPermissions(requestParameters: ActionsApiMetricPermissionsRequest, options?: AxiosRequestConfig): AxiosPromise<MetricPermissions>;
+    /**
+     * (BETA) Lists the languages that have at least one translation, separately for each kind of translation.
+     * @summary (BETA) Languages with translations in the organization.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ActionsApiInterface
+     */
+    organizationLocalizationStatistics(options?: AxiosRequestConfig): AxiosPromise<LocalizationStatistics>;
     /**
      * (BETA) Counts workspaces and users per language of the display, metadata and data language settings. Users count only under the languages they set themselves.
      * @summary (BETA) Languages used in the organization.
@@ -20073,6 +20201,14 @@ export declare class ActionsApi extends BaseAPI implements ActionsApiInterface {
      * @memberof ActionsApi
      */
     metricPermissions(requestParameters: ActionsApiMetricPermissionsRequest, options?: AxiosRequestConfig): AxiosPromise<MetricPermissions>;
+    /**
+     * (BETA) Lists the languages that have at least one translation, separately for each kind of translation.
+     * @summary (BETA) Languages with translations in the organization.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ActionsApi
+     */
+    organizationLocalizationStatistics(options?: AxiosRequestConfig): AxiosPromise<LocalizationStatistics>;
     /**
      * (BETA) Counts workspaces and users per language of the display, metadata and data language settings. Users count only under the languages they set themselves.
      * @summary (BETA) Languages used in the organization.
@@ -75568,6 +75704,14 @@ export declare class LlmProviderControllerApi extends BaseAPI implements LlmProv
      */
     updateEntityLlmProviders(requestParameters: LlmProviderControllerApiUpdateEntityLlmProvidersRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiLlmProviderOutDocument>;
 }
+/**
+ * (BETA) Lists the languages that have at least one translation, separately for each kind of translation.
+ * @summary (BETA) Languages with translations in the organization.
+ * @param {*} [options] Override http request option.
+ * @param {Configuration} [configuration] Optional configuration.
+ * @throws {RequiredError}
+ */
+export declare function LocalizationApiAxiosParamCreator_OrganizationLocalizationStatistics(options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
 /**
  * (BETA) Counts workspaces and users per language of the display, metadata and data language settings. Users count only under the languages they set themselves.
  * @summary (BETA) Languages used in the organization.
@@ -75602,6 +75746,16 @@ export declare function LocalizationApiAxiosParamCreator_OrganizationLocalizatio
  * @throws {RequiredError}
  */
 export declare function LocalizationApiAxiosParamCreator_OrganizationLocalizationUsageWorkspaces(value?: string, setting?: 'LOCALE' | 'METADATA_LOCALE' | 'DATA_LOCALE', source?: 'USER' | 'WORKSPACE' | 'PARENT' | 'ORGANIZATION' | 'ENVIRONMENT' | 'DEFAULT', page?: number, size?: number, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
+/**
+ * (BETA) Lists the languages that have at least one translation, separately for each kind of translation.
+ * @summary (BETA) Languages with translations in the organization.
+ * @param {AxiosInstance} axios Axios instance.
+ * @param {string} basePath Base path.
+ * @param {*} [options] Override http request option.
+ * @param {Configuration} [configuration] Optional configuration.
+ * @throws {RequiredError}
+ */
+export declare function LocalizationApi_OrganizationLocalizationStatistics(axios: AxiosInstance, basePath: string, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<LocalizationStatistics>;
 /**
  * (BETA) Counts workspaces and users per language of the display, metadata and data language settings. Users count only under the languages they set themselves.
  * @summary (BETA) Languages used in the organization.
@@ -75640,6 +75794,14 @@ export declare function LocalizationApi_OrganizationLocalizationUsageWorkspaces(
  * @interface LocalizationApi
  */
 export interface LocalizationApiInterface {
+    /**
+     * (BETA) Lists the languages that have at least one translation, separately for each kind of translation.
+     * @summary (BETA) Languages with translations in the organization.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof LocalizationApiInterface
+     */
+    organizationLocalizationStatistics(options?: AxiosRequestConfig): AxiosPromise<LocalizationStatistics>;
     /**
      * (BETA) Counts workspaces and users per language of the display, metadata and data language settings. Users count only under the languages they set themselves.
      * @summary (BETA) Languages used in the organization.
@@ -75748,6 +75910,14 @@ export interface LocalizationApiOrganizationLocalizationUsageWorkspacesRequest {
  * @extends {BaseAPI}
  */
 export declare class LocalizationApi extends BaseAPI implements LocalizationApiInterface {
+    /**
+     * (BETA) Lists the languages that have at least one translation, separately for each kind of translation.
+     * @summary (BETA) Languages with translations in the organization.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof LocalizationApi
+     */
+    organizationLocalizationStatistics(options?: AxiosRequestConfig): AxiosPromise<LocalizationStatistics>;
     /**
      * (BETA) Counts workspaces and users per language of the display, metadata and data language settings. Users count only under the languages they set themselves.
      * @summary (BETA) Languages used in the organization.