@gooddata/api-client-tiger 11.48.0 → 11.49.0-alpha.1

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

@@ -10033,6 +10033,10 @@ export type ManageDashboardPermissionsRequestInner = PermissionsForAssignee | Pe
  * @type ManageLabelPermissionsRequestInner
  */
 export type ManageLabelPermissionsRequestInner = LdmObjectPermissionsForAssignee | LdmObjectPermissionsForAssigneeRule;
+/**
+ * @type ManageMetricPermissionsRequestInner
+ */
+export type ManageMetricPermissionsRequestInner = MetricPermissionsForAssignee | MetricPermissionsForAssigneeRule;
 /**
  * Filter via label with given match type and literal value.
  */
@@ -10110,6 +10114,43 @@ export interface MetricDefinitionOverride {
     'item': AfmObjectIdentifierCore;
     'definition': InlineMeasureDefinition;
 }
+export interface MetricPermissions {
+    /**
+     * List of rules
+     */
+    'rules': Array<RulePermission>;
+    /**
+     * List of users
+     */
+    'users': Array<UserPermission>;
+    /**
+     * List of user groups
+     */
+    'userGroups': Array<UserGroupPermission>;
+}
+/**
+ * Desired levels of permissions on a metric for an assignee.
+ */
+export interface MetricPermissionsAssignment {
+    'permissions': Array<MetricPermissionsAssignmentPermissionsEnum>;
+}
+export type MetricPermissionsAssignmentPermissionsEnum = 'EDIT' | 'SHARE' | 'VIEW';
+/**
+ * Desired levels of metric permissions for an assignee identified by an identifier.
+ */
+export interface MetricPermissionsForAssignee {
+    'permissions': Array<MetricPermissionsForAssigneePermissionsEnum>;
+    'assigneeIdentifier': AssigneeIdentifier;
+}
+export type MetricPermissionsForAssigneePermissionsEnum = 'EDIT' | 'SHARE' | 'VIEW';
+/**
+ * Desired levels of metric permissions for a collection of assignees identified by a rule.
+ */
+export interface MetricPermissionsForAssigneeRule {
+    'permissions': Array<MetricPermissionsForAssigneeRulePermissionsEnum>;
+    'assigneeRule': AssigneeRule;
+}
+export type MetricPermissionsForAssigneeRulePermissionsEnum = 'EDIT' | 'SHARE' | 'VIEW';
 export interface ModelFile {
     'skeleton'?: Skeleton;
     'any'?: Array<object>;
@@ -13971,6 +14012,17 @@ export declare function ActionsApiAxiosParamCreator_ManageFactPermissions(worksp
  * @throws {RequiredError}
  */
 export declare function ActionsApiAxiosParamCreator_ManageLabelPermissions(workspaceId: string, labelId: string, manageLabelPermissionsRequestInner: Array<ManageLabelPermissionsRequestInner>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
+/**
+ *
+ * @summary (BETA) Manage Permissions for a Metric
+ * @param {string} workspaceId
+ * @param {string} metricId
+ * @param {Array<ManageMetricPermissionsRequestInner>} manageMetricPermissionsRequestInner
+ * @param {*} [options] Override http request option.
+ * @param {Configuration} [configuration] Optional configuration.
+ * @throws {RequiredError}
+ */
+export declare function ActionsApiAxiosParamCreator_ManageMetricPermissions(workspaceId: string, metricId: string, manageMetricPermissionsRequestInner: Array<ManageMetricPermissionsRequestInner>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
 /**
  * Manage Permissions for a Organization
  * @summary Manage Permissions for a Organization
@@ -13990,6 +14042,16 @@ export declare function ActionsApiAxiosParamCreator_ManageOrganizationPermission
  * @throws {RequiredError}
  */
 export declare function ActionsApiAxiosParamCreator_ManageWorkspacePermissions(workspaceId: string, workspacePermissionAssignment: Array<WorkspacePermissionAssignment>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
+/**
+ *
+ * @summary (BETA) Get Metric Permissions
+ * @param {string} workspaceId
+ * @param {string} metricId
+ * @param {*} [options] Override http request option.
+ * @param {Configuration} [configuration] Optional configuration.
+ * @throws {RequiredError}
+ */
+export declare function ActionsApiAxiosParamCreator_MetricPermissions(workspaceId: string, metricId: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
 /**
  * Finds API identifier overrides in given workspace hierarchy.
  * @summary Finds identifier overrides in workspace hierarchy.
@@ -14505,6 +14567,17 @@ export declare function ActionsApi_ManageFactPermissions(axios: AxiosInstance, b
  * @throws {RequiredError}
  */
 export declare function ActionsApi_ManageLabelPermissions(axios: AxiosInstance, basePath: string, requestParameters: ActionsApiManageLabelPermissionsRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<void>;
+/**
+ *
+ * @summary (BETA) Manage Permissions for a Metric
+ * @param {AxiosInstance} axios Axios instance.
+ * @param {string} basePath Base path.
+ * @param {ActionsApiManageMetricPermissionsRequest} requestParameters Request parameters.
+ * @param {*} [options] Override http request option.
+ * @param {Configuration} [configuration] Optional configuration.
+ * @throws {RequiredError}
+ */
+export declare function ActionsApi_ManageMetricPermissions(axios: AxiosInstance, basePath: string, requestParameters: ActionsApiManageMetricPermissionsRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<void>;
 /**
  * Manage Permissions for a Organization
  * @summary Manage Permissions for a Organization
@@ -14527,6 +14600,17 @@ export declare function ActionsApi_ManageOrganizationPermissions(axios: AxiosIns
  * @throws {RequiredError}
  */
 export declare function ActionsApi_ManageWorkspacePermissions(axios: AxiosInstance, basePath: string, requestParameters: ActionsApiManageWorkspacePermissionsRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<void>;
+/**
+ *
+ * @summary (BETA) Get Metric Permissions
+ * @param {AxiosInstance} axios Axios instance.
+ * @param {string} basePath Base path.
+ * @param {ActionsApiMetricPermissionsRequest} requestParameters Request parameters.
+ * @param {*} [options] Override http request option.
+ * @param {Configuration} [configuration] Optional configuration.
+ * @throws {RequiredError}
+ */
+export declare function ActionsApi_MetricPermissions(axios: AxiosInstance, basePath: string, requestParameters: ActionsApiMetricPermissionsRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<MetricPermissions>;
 /**
  * Finds API identifier overrides in given workspace hierarchy.
  * @summary Finds identifier overrides in workspace hierarchy.
@@ -15038,6 +15122,15 @@ export interface ActionsApiInterface {
      * @memberof ActionsApiInterface
      */
     manageLabelPermissions(requestParameters: ActionsApiManageLabelPermissionsRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @summary (BETA) Manage Permissions for a Metric
+     * @param {ActionsApiManageMetricPermissionsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ActionsApiInterface
+     */
+    manageMetricPermissions(requestParameters: ActionsApiManageMetricPermissionsRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
     /**
      * Manage Permissions for a Organization
      * @summary Manage Permissions for a Organization
@@ -15056,6 +15149,15 @@ export interface ActionsApiInterface {
      * @memberof ActionsApiInterface
      */
     manageWorkspacePermissions(requestParameters: ActionsApiManageWorkspacePermissionsRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @summary (BETA) Get Metric Permissions
+     * @param {ActionsApiMetricPermissionsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ActionsApiInterface
+     */
+    metricPermissions(requestParameters: ActionsApiMetricPermissionsRequest, options?: AxiosRequestConfig): AxiosPromise<MetricPermissions>;
     /**
      * Finds API identifier overrides in given workspace hierarchy.
      * @summary Finds identifier overrides in workspace hierarchy.
@@ -15756,6 +15858,31 @@ export interface ActionsApiManageLabelPermissionsRequest {
      */
     readonly manageLabelPermissionsRequestInner: Array<ManageLabelPermissionsRequestInner>;
 }
+/**
+ * Request parameters for manageMetricPermissions operation in ActionsApi.
+ * @export
+ * @interface ActionsApiManageMetricPermissionsRequest
+ */
+export interface ActionsApiManageMetricPermissionsRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof ActionsApiManageMetricPermissions
+     */
+    readonly workspaceId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ActionsApiManageMetricPermissions
+     */
+    readonly metricId: string;
+    /**
+     *
+     * @type {Array<ManageMetricPermissionsRequestInner>}
+     * @memberof ActionsApiManageMetricPermissions
+     */
+    readonly manageMetricPermissionsRequestInner: Array<ManageMetricPermissionsRequestInner>;
+}
 /**
  * Request parameters for manageOrganizationPermissions operation in ActionsApi.
  * @export
@@ -15788,6 +15915,25 @@ export interface ActionsApiManageWorkspacePermissionsRequest {
      */
     readonly workspacePermissionAssignment: Array<WorkspacePermissionAssignment>;
 }
+/**
+ * Request parameters for metricPermissions operation in ActionsApi.
+ * @export
+ * @interface ActionsApiMetricPermissionsRequest
+ */
+export interface ActionsApiMetricPermissionsRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof ActionsApiMetricPermissions
+     */
+    readonly workspaceId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ActionsApiMetricPermissions
+     */
+    readonly metricId: string;
+}
 /**
  * Request parameters for overriddenChildEntities operation in ActionsApi.
  * @export
@@ -16388,6 +16534,15 @@ export declare class ActionsApi extends BaseAPI implements ActionsApiInterface {
      * @memberof ActionsApi
      */
     manageLabelPermissions(requestParameters: ActionsApiManageLabelPermissionsRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @summary (BETA) Manage Permissions for a Metric
+     * @param {ActionsApiManageMetricPermissionsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ActionsApi
+     */
+    manageMetricPermissions(requestParameters: ActionsApiManageMetricPermissionsRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
     /**
      * Manage Permissions for a Organization
      * @summary Manage Permissions for a Organization
@@ -16406,6 +16561,15 @@ export declare class ActionsApi extends BaseAPI implements ActionsApiInterface {
      * @memberof ActionsApi
      */
     manageWorkspacePermissions(requestParameters: ActionsApiManageWorkspacePermissionsRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @summary (BETA) Get Metric Permissions
+     * @param {ActionsApiMetricPermissionsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ActionsApi
+     */
+    metricPermissions(requestParameters: ActionsApiMetricPermissionsRequest, options?: AxiosRequestConfig): AxiosPromise<MetricPermissions>;
     /**
      * Finds API identifier overrides in given workspace hierarchy.
      * @summary Finds identifier overrides in workspace hierarchy.
@@ -74041,6 +74205,17 @@ export declare function PermissionsApiAxiosParamCreator_ManageFactPermissions(wo
  * @throws {RequiredError}
  */
 export declare function PermissionsApiAxiosParamCreator_ManageLabelPermissions(workspaceId: string, labelId: string, manageLabelPermissionsRequestInner: Array<ManageLabelPermissionsRequestInner>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
+/**
+ *
+ * @summary (BETA) Manage Permissions for a Metric
+ * @param {string} workspaceId
+ * @param {string} metricId
+ * @param {Array<ManageMetricPermissionsRequestInner>} manageMetricPermissionsRequestInner
+ * @param {*} [options] Override http request option.
+ * @param {Configuration} [configuration] Optional configuration.
+ * @throws {RequiredError}
+ */
+export declare function PermissionsApiAxiosParamCreator_ManageMetricPermissions(workspaceId: string, metricId: string, manageMetricPermissionsRequestInner: Array<ManageMetricPermissionsRequestInner>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
 /**
  * Manage Permissions for a Organization
  * @summary Manage Permissions for a Organization
@@ -74060,6 +74235,16 @@ export declare function PermissionsApiAxiosParamCreator_ManageOrganizationPermis
  * @throws {RequiredError}
  */
 export declare function PermissionsApiAxiosParamCreator_ManageWorkspacePermissions(workspaceId: string, workspacePermissionAssignment: Array<WorkspacePermissionAssignment>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
+/**
+ *
+ * @summary (BETA) Get Metric Permissions
+ * @param {string} workspaceId
+ * @param {string} metricId
+ * @param {*} [options] Override http request option.
+ * @param {Configuration} [configuration] Optional configuration.
+ * @throws {RequiredError}
+ */
+export declare function PermissionsApiAxiosParamCreator_MetricPermissions(workspaceId: string, metricId: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
 /**
  * Sets organization permissions
  * @summary Set organization permissions
@@ -74252,6 +74437,17 @@ export declare function PermissionsApi_ManageFactPermissions(axios: AxiosInstanc
  * @throws {RequiredError}
  */
 export declare function PermissionsApi_ManageLabelPermissions(axios: AxiosInstance, basePath: string, requestParameters: PermissionsApiManageLabelPermissionsRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<void>;
+/**
+ *
+ * @summary (BETA) Manage Permissions for a Metric
+ * @param {AxiosInstance} axios Axios instance.
+ * @param {string} basePath Base path.
+ * @param {PermissionsApiManageMetricPermissionsRequest} requestParameters Request parameters.
+ * @param {*} [options] Override http request option.
+ * @param {Configuration} [configuration] Optional configuration.
+ * @throws {RequiredError}
+ */
+export declare function PermissionsApi_ManageMetricPermissions(axios: AxiosInstance, basePath: string, requestParameters: PermissionsApiManageMetricPermissionsRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<void>;
 /**
  * Manage Permissions for a Organization
  * @summary Manage Permissions for a Organization
@@ -74274,6 +74470,17 @@ export declare function PermissionsApi_ManageOrganizationPermissions(axios: Axio
  * @throws {RequiredError}
  */
 export declare function PermissionsApi_ManageWorkspacePermissions(axios: AxiosInstance, basePath: string, requestParameters: PermissionsApiManageWorkspacePermissionsRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<void>;
+/**
+ *
+ * @summary (BETA) Get Metric Permissions
+ * @param {AxiosInstance} axios Axios instance.
+ * @param {string} basePath Base path.
+ * @param {PermissionsApiMetricPermissionsRequest} requestParameters Request parameters.
+ * @param {*} [options] Override http request option.
+ * @param {Configuration} [configuration] Optional configuration.
+ * @throws {RequiredError}
+ */
+export declare function PermissionsApi_MetricPermissions(axios: AxiosInstance, basePath: string, requestParameters: PermissionsApiMetricPermissionsRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<MetricPermissions>;
 /**
  * Sets organization permissions
  * @summary Set organization permissions
@@ -74449,6 +74656,15 @@ export interface PermissionsApiInterface {
      * @memberof PermissionsApiInterface
      */
     manageLabelPermissions(requestParameters: PermissionsApiManageLabelPermissionsRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @summary (BETA) Manage Permissions for a Metric
+     * @param {PermissionsApiManageMetricPermissionsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PermissionsApiInterface
+     */
+    manageMetricPermissions(requestParameters: PermissionsApiManageMetricPermissionsRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
     /**
      * Manage Permissions for a Organization
      * @summary Manage Permissions for a Organization
@@ -74467,6 +74683,15 @@ export interface PermissionsApiInterface {
      * @memberof PermissionsApiInterface
      */
     manageWorkspacePermissions(requestParameters: PermissionsApiManageWorkspacePermissionsRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @summary (BETA) Get Metric Permissions
+     * @param {PermissionsApiMetricPermissionsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PermissionsApiInterface
+     */
+    metricPermissions(requestParameters: PermissionsApiMetricPermissionsRequest, options?: AxiosRequestConfig): AxiosPromise<MetricPermissions>;
     /**
      * Sets organization permissions
      * @summary Set organization permissions
@@ -74757,6 +74982,31 @@ export interface PermissionsApiManageLabelPermissionsRequest {
      */
     readonly manageLabelPermissionsRequestInner: Array<ManageLabelPermissionsRequestInner>;
 }
+/**
+ * Request parameters for manageMetricPermissions operation in PermissionsApi.
+ * @export
+ * @interface PermissionsApiManageMetricPermissionsRequest
+ */
+export interface PermissionsApiManageMetricPermissionsRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof PermissionsApiManageMetricPermissions
+     */
+    readonly workspaceId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PermissionsApiManageMetricPermissions
+     */
+    readonly metricId: string;
+    /**
+     *
+     * @type {Array<ManageMetricPermissionsRequestInner>}
+     * @memberof PermissionsApiManageMetricPermissions
+     */
+    readonly manageMetricPermissionsRequestInner: Array<ManageMetricPermissionsRequestInner>;
+}
 /**
  * Request parameters for manageOrganizationPermissions operation in PermissionsApi.
  * @export
@@ -74789,6 +75039,25 @@ export interface PermissionsApiManageWorkspacePermissionsRequest {
      */
     readonly workspacePermissionAssignment: Array<WorkspacePermissionAssignment>;
 }
+/**
+ * Request parameters for metricPermissions operation in PermissionsApi.
+ * @export
+ * @interface PermissionsApiMetricPermissionsRequest
+ */
+export interface PermissionsApiMetricPermissionsRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof PermissionsApiMetricPermissions
+     */
+    readonly workspaceId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PermissionsApiMetricPermissions
+     */
+    readonly metricId: string;
+}
 /**
  * Request parameters for setOrganizationPermissions operation in PermissionsApi.
  * @export
@@ -74991,6 +75260,15 @@ export declare class PermissionsApi extends BaseAPI implements PermissionsApiInt
      * @memberof PermissionsApi
      */
     manageLabelPermissions(requestParameters: PermissionsApiManageLabelPermissionsRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @summary (BETA) Manage Permissions for a Metric
+     * @param {PermissionsApiManageMetricPermissionsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PermissionsApi
+     */
+    manageMetricPermissions(requestParameters: PermissionsApiManageMetricPermissionsRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
     /**
      * Manage Permissions for a Organization
      * @summary Manage Permissions for a Organization
@@ -75009,6 +75287,15 @@ export declare class PermissionsApi extends BaseAPI implements PermissionsApiInt
      * @memberof PermissionsApi
      */
     manageWorkspacePermissions(requestParameters: PermissionsApiManageWorkspacePermissionsRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @summary (BETA) Get Metric Permissions
+     * @param {PermissionsApiMetricPermissionsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PermissionsApi
+     */
+    metricPermissions(requestParameters: PermissionsApiMetricPermissionsRequest, options?: AxiosRequestConfig): AxiosPromise<MetricPermissions>;
     /**
      * Sets organization permissions
      * @summary Set organization permissions