@gooddata/api-client-tiger 11.3.0-alpha.1 → 11.3.0-alpha.3

package/esm/generated/afm-rest-api/api.d.ts

@@ -439,6 +439,46 @@ export declare const BoundedFilterGranularityEnum: {
     readonly QUARTER_OF_YEAR: "QUARTER_OF_YEAR";
 };
 export type BoundedFilterGranularityEnum = (typeof BoundedFilterGranularityEnum)[keyof typeof BoundedFilterGranularityEnum];
+/**
+ * Request for change analysis computation
+ */
+export interface ChangeAnalysisRequest {
+    metricIdentifier: ObjectIdentifier;
+    dateAttributeIdentifier: ObjectIdentifier;
+    /**
+     * The reference time period (e.g., \'2025-01\')
+     */
+    referencePeriod: string;
+    /**
+     * The analyzed time period (e.g., \'2025-02\')
+     */
+    analyzedPeriod: string;
+    /**
+     * The attributes to analyze for significant changes. If empty, valid attributes will be automatically discovered.
+     */
+    attributeIdentifiers: Array<ObjectIdentifier>;
+    /**
+     * The significance threshold for changes (default: 2.0 standard deviations)
+     */
+    significanceThreshold?: number;
+}
+/**
+ * Response for change analysis computation
+ */
+export interface ChangeAnalysisResponse {
+    links: ExecutionLinks;
+}
+/**
+ * Result of a change analysis execution.
+ */
+export interface ChangeAnalysisResult {
+    /**
+     * The change analysis result data containing significant changes.
+     */
+    data: {
+        [key: string]: object;
+    };
+}
 /**
  * List of chat history interactions.
  */
@@ -1386,6 +1426,38 @@ export interface NegativeAttributeFilterNegativeAttributeFilter {
     applyOnResult?: boolean;
     label: AfmIdentifier;
 }
+/**
+ * The attributes to analyze for significant changes. If empty, valid attributes will be automatically discovered.
+ */
+export interface ObjectIdentifier {
+    type: ObjectIdentifierTypeEnum;
+    space: string;
+    id: string;
+}
+export declare const ObjectIdentifierTypeEnum: {
+    readonly ANALYTICAL_DASHBOARD: "analyticalDashboard";
+    readonly ATTRIBUTE: "attribute";
+    readonly ATTRIBUTE_HIERARCHY: "attributeHierarchy";
+    readonly DASHBOARD_PLUGIN: "dashboardPlugin";
+    readonly DATASET: "dataset";
+    readonly FACT: "fact";
+    readonly AGGREGATED_FACT: "aggregatedFact";
+    readonly LABEL: "label";
+    readonly METRIC: "metric";
+    readonly USER_DATA_FILTER: "userDataFilter";
+    readonly EXPORT_DEFINITION: "exportDefinition";
+    readonly AUTOMATION: "automation";
+    readonly AUTOMATION_RESULT: "automationResult";
+    readonly PROMPT: "prompt";
+    readonly VISUALIZATION_OBJECT: "visualizationObject";
+    readonly FILTER_CONTEXT: "filterContext";
+    readonly WORKSPACE_SETTINGS: "workspaceSettings";
+    readonly CUSTOM_APPLICATION_SETTING: "customApplicationSetting";
+    readonly WORKSPACE_DATA_FILTER: "workspaceDataFilter";
+    readonly WORKSPACE_DATA_FILTER_SETTING: "workspaceDataFilterSetting";
+    readonly FILTER_VIEW: "filterView";
+};
+export type ObjectIdentifierTypeEnum = (typeof ObjectIdentifierTypeEnum)[keyof typeof ObjectIdentifierTypeEnum];
 /**
  * Current page description.
  */
@@ -2129,6 +2201,24 @@ export declare const ActionsApiAxiosParamCreator: (configuration?: Configuration
      * @throws {RequiredError}
      */
     cancelExecutions: (workspaceId: string, afmCancelTokens: AfmCancelTokens, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Computes change analysis for the provided execution definition.
+     * @summary Compute change analysis
+     * @param {string} workspaceId Workspace identifier
+     * @param {ChangeAnalysisRequest} changeAnalysisRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    changeAnalysis: (workspaceId: string, changeAnalysisRequest: ChangeAnalysisRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Gets change analysis result.
+     * @summary Get change analysis result
+     * @param {string} workspaceId Workspace identifier
+     * @param {string} resultId Result ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    changeAnalysisResult: (workspaceId: string, resultId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * (EXPERIMENTAL) Computes clusters for data points from the provided execution result and parameters.
      * @summary (EXPERIMENTAL) Smart functions - Clustering
@@ -2442,6 +2532,24 @@ export declare const ActionsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     cancelExecutions(workspaceId: string, afmCancelTokens: AfmCancelTokens, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AfmCancelTokens>>;
+    /**
+     * Computes change analysis for the provided execution definition.
+     * @summary Compute change analysis
+     * @param {string} workspaceId Workspace identifier
+     * @param {ChangeAnalysisRequest} changeAnalysisRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    changeAnalysis(workspaceId: string, changeAnalysisRequest: ChangeAnalysisRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ChangeAnalysisResponse>>;
+    /**
+     * Gets change analysis result.
+     * @summary Get change analysis result
+     * @param {string} workspaceId Workspace identifier
+     * @param {string} resultId Result ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    changeAnalysisResult(workspaceId: string, resultId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ChangeAnalysisResult>>;
     /**
      * (EXPERIMENTAL) Computes clusters for data points from the provided execution result and parameters.
      * @summary (EXPERIMENTAL) Smart functions - Clustering
@@ -2744,6 +2852,22 @@ export declare const ActionsApiFactory: (configuration?: Configuration, basePath
      * @throws {RequiredError}
      */
     cancelExecutions(requestParameters: ActionsApiCancelExecutionsRequest, options?: AxiosRequestConfig): AxiosPromise<AfmCancelTokens>;
+    /**
+     * Computes change analysis for the provided execution definition.
+     * @summary Compute change analysis
+     * @param {ActionsApiChangeAnalysisRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    changeAnalysis(requestParameters: ActionsApiChangeAnalysisRequest, options?: AxiosRequestConfig): AxiosPromise<ChangeAnalysisResponse>;
+    /**
+     * Gets change analysis result.
+     * @summary Get change analysis result
+     * @param {ActionsApiChangeAnalysisResultRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    changeAnalysisResult(requestParameters: ActionsApiChangeAnalysisResultRequest, options?: AxiosRequestConfig): AxiosPromise<ChangeAnalysisResult>;
     /**
      * (EXPERIMENTAL) Computes clusters for data points from the provided execution result and parameters.
      * @summary (EXPERIMENTAL) Smart functions - Clustering
@@ -3015,6 +3139,24 @@ export interface ActionsApiInterface {
      * @memberof ActionsApiInterface
      */
     cancelExecutions(requestParameters: ActionsApiCancelExecutionsRequest, options?: AxiosRequestConfig): AxiosPromise<AfmCancelTokens>;
+    /**
+     * Computes change analysis for the provided execution definition.
+     * @summary Compute change analysis
+     * @param {ActionsApiChangeAnalysisRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ActionsApiInterface
+     */
+    changeAnalysis(requestParameters: ActionsApiChangeAnalysisRequest, options?: AxiosRequestConfig): AxiosPromise<ChangeAnalysisResponse>;
+    /**
+     * Gets change analysis result.
+     * @summary Get change analysis result
+     * @param {ActionsApiChangeAnalysisResultRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ActionsApiInterface
+     */
+    changeAnalysisResult(requestParameters: ActionsApiChangeAnalysisResultRequest, options?: AxiosRequestConfig): AxiosPromise<ChangeAnalysisResult>;
     /**
      * (EXPERIMENTAL) Computes clusters for data points from the provided execution result and parameters.
      * @summary (EXPERIMENTAL) Smart functions - Clustering
@@ -3402,6 +3544,44 @@ export interface ActionsApiCancelExecutionsRequest {
      */
     readonly afmCancelTokens: AfmCancelTokens;
 }
+/**
+ * Request parameters for changeAnalysis operation in ActionsApi.
+ * @export
+ * @interface ActionsApiChangeAnalysisRequest
+ */
+export interface ActionsApiChangeAnalysisRequest {
+    /**
+     * Workspace identifier
+     * @type {string}
+     * @memberof ActionsApiChangeAnalysis
+     */
+    readonly workspaceId: string;
+    /**
+     *
+     * @type {ChangeAnalysisRequest}
+     * @memberof ActionsApiChangeAnalysis
+     */
+    readonly changeAnalysisRequest: ChangeAnalysisRequest;
+}
+/**
+ * Request parameters for changeAnalysisResult operation in ActionsApi.
+ * @export
+ * @interface ActionsApiChangeAnalysisResultRequest
+ */
+export interface ActionsApiChangeAnalysisResultRequest {
+    /**
+     * Workspace identifier
+     * @type {string}
+     * @memberof ActionsApiChangeAnalysisResult
+     */
+    readonly workspaceId: string;
+    /**
+     * Result ID
+     * @type {string}
+     * @memberof ActionsApiChangeAnalysisResult
+     */
+    readonly resultId: string;
+}
 /**
  * Request parameters for clustering operation in ActionsApi.
  * @export
@@ -4033,6 +4213,24 @@ export declare class ActionsApi extends BaseAPI implements ActionsApiInterface {
      * @memberof ActionsApi
      */
     cancelExecutions(requestParameters: ActionsApiCancelExecutionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AfmCancelTokens, any, {}>>;
+    /**
+     * Computes change analysis for the provided execution definition.
+     * @summary Compute change analysis
+     * @param {ActionsApiChangeAnalysisRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ActionsApi
+     */
+    changeAnalysis(requestParameters: ActionsApiChangeAnalysisRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ChangeAnalysisResponse, any, {}>>;
+    /**
+     * Gets change analysis result.
+     * @summary Get change analysis result
+     * @param {ActionsApiChangeAnalysisResultRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ActionsApi
+     */
+    changeAnalysisResult(requestParameters: ActionsApiChangeAnalysisResultRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ChangeAnalysisResult, any, {}>>;
     /**
      * (EXPERIMENTAL) Computes clusters for data points from the provided execution result and parameters.
      * @summary (EXPERIMENTAL) Smart functions - Clustering
@@ -4255,6 +4453,24 @@ export declare class ActionsApi extends BaseAPI implements ActionsApiInterface {
  * @export
  */
 export declare const ComputationApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Computes change analysis for the provided execution definition.
+     * @summary Compute change analysis
+     * @param {string} workspaceId Workspace identifier
+     * @param {ChangeAnalysisRequest} changeAnalysisRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    changeAnalysis: (workspaceId: string, changeAnalysisRequest: ChangeAnalysisRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Gets change analysis result.
+     * @summary Get change analysis result
+     * @param {string} workspaceId Workspace identifier
+     * @param {string} resultId Result ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    changeAnalysisResult: (workspaceId: string, resultId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Returns paged list of elements (values) of given label satisfying given filtering criteria.
      * @summary Listing of label values. The resulting data are limited by the static platform limit to the maximum of 10000 rows.
@@ -4355,6 +4571,24 @@ export declare const ComputationApiAxiosParamCreator: (configuration?: Configura
  * @export
  */
 export declare const ComputationApiFp: (configuration?: Configuration) => {
+    /**
+     * Computes change analysis for the provided execution definition.
+     * @summary Compute change analysis
+     * @param {string} workspaceId Workspace identifier
+     * @param {ChangeAnalysisRequest} changeAnalysisRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    changeAnalysis(workspaceId: string, changeAnalysisRequest: ChangeAnalysisRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ChangeAnalysisResponse>>;
+    /**
+     * Gets change analysis result.
+     * @summary Get change analysis result
+     * @param {string} workspaceId Workspace identifier
+     * @param {string} resultId Result ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    changeAnalysisResult(workspaceId: string, resultId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ChangeAnalysisResult>>;
     /**
      * Returns paged list of elements (values) of given label satisfying given filtering criteria.
      * @summary Listing of label values. The resulting data are limited by the static platform limit to the maximum of 10000 rows.
@@ -4455,6 +4689,22 @@ export declare const ComputationApiFp: (configuration?: Configuration) => {
  * @export
  */
 export declare const ComputationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Computes change analysis for the provided execution definition.
+     * @summary Compute change analysis
+     * @param {ComputationApiChangeAnalysisRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    changeAnalysis(requestParameters: ComputationApiChangeAnalysisRequest, options?: AxiosRequestConfig): AxiosPromise<ChangeAnalysisResponse>;
+    /**
+     * Gets change analysis result.
+     * @summary Get change analysis result
+     * @param {ComputationApiChangeAnalysisResultRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    changeAnalysisResult(requestParameters: ComputationApiChangeAnalysisResultRequest, options?: AxiosRequestConfig): AxiosPromise<ChangeAnalysisResult>;
     /**
      * Returns paged list of elements (values) of given label satisfying given filtering criteria.
      * @summary Listing of label values. The resulting data are limited by the static platform limit to the maximum of 10000 rows.
@@ -4534,6 +4784,24 @@ export declare const ComputationApiFactory: (configuration?: Configuration, base
  * @interface ComputationApi
  */
 export interface ComputationApiInterface {
+    /**
+     * Computes change analysis for the provided execution definition.
+     * @summary Compute change analysis
+     * @param {ComputationApiChangeAnalysisRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ComputationApiInterface
+     */
+    changeAnalysis(requestParameters: ComputationApiChangeAnalysisRequest, options?: AxiosRequestConfig): AxiosPromise<ChangeAnalysisResponse>;
+    /**
+     * Gets change analysis result.
+     * @summary Get change analysis result
+     * @param {ComputationApiChangeAnalysisResultRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ComputationApiInterface
+     */
+    changeAnalysisResult(requestParameters: ComputationApiChangeAnalysisResultRequest, options?: AxiosRequestConfig): AxiosPromise<ChangeAnalysisResult>;
     /**
      * Returns paged list of elements (values) of given label satisfying given filtering criteria.
      * @summary Listing of label values. The resulting data are limited by the static platform limit to the maximum of 10000 rows.
@@ -4616,6 +4884,44 @@ export interface ComputationApiInterface {
      */
     retrieveResult(requestParameters: ComputationApiRetrieveResultRequest, options?: AxiosRequestConfig): AxiosPromise<ExecutionResult>;
 }
+/**
+ * Request parameters for changeAnalysis operation in ComputationApi.
+ * @export
+ * @interface ComputationApiChangeAnalysisRequest
+ */
+export interface ComputationApiChangeAnalysisRequest {
+    /**
+     * Workspace identifier
+     * @type {string}
+     * @memberof ComputationApiChangeAnalysis
+     */
+    readonly workspaceId: string;
+    /**
+     *
+     * @type {ChangeAnalysisRequest}
+     * @memberof ComputationApiChangeAnalysis
+     */
+    readonly changeAnalysisRequest: ChangeAnalysisRequest;
+}
+/**
+ * Request parameters for changeAnalysisResult operation in ComputationApi.
+ * @export
+ * @interface ComputationApiChangeAnalysisResultRequest
+ */
+export interface ComputationApiChangeAnalysisResultRequest {
+    /**
+     * Workspace identifier
+     * @type {string}
+     * @memberof ComputationApiChangeAnalysisResult
+     */
+    readonly workspaceId: string;
+    /**
+     * Result ID
+     * @type {string}
+     * @memberof ComputationApiChangeAnalysisResult
+     */
+    readonly resultId: string;
+}
 /**
  * Request parameters for computeLabelElementsPost operation in ComputationApi.
  * @export
@@ -4872,6 +5178,24 @@ export interface ComputationApiRetrieveResultRequest {
  * @extends {BaseAPI}
  */
 export declare class ComputationApi extends BaseAPI implements ComputationApiInterface {
+    /**
+     * Computes change analysis for the provided execution definition.
+     * @summary Compute change analysis
+     * @param {ComputationApiChangeAnalysisRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ComputationApi
+     */
+    changeAnalysis(requestParameters: ComputationApiChangeAnalysisRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ChangeAnalysisResponse, any, {}>>;
+    /**
+     * Gets change analysis result.
+     * @summary Get change analysis result
+     * @param {ComputationApiChangeAnalysisResultRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ComputationApi
+     */
+    changeAnalysisResult(requestParameters: ComputationApiChangeAnalysisResultRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ChangeAnalysisResult, any, {}>>;
     /**
      * Returns paged list of elements (values) of given label satisfying given filtering criteria.
      * @summary Listing of label values. The resulting data are limited by the static platform limit to the maximum of 10000 rows.