@gooddata/api-client-tiger 11.35.0-alpha.6 → 11.35.0

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

@@ -671,6 +671,18 @@ export interface AiSkillResponse {
     'tags': Array<string>;
     'examples': Array<string>;
 }
+export interface AiSummarizeRequest {
+    'visualizations': Array<string>;
+    'filterContext': Array<object>;
+    'dashboardId': string;
+}
+export interface AiSummarizeResponse {
+    'summary': string;
+    'filterContext': Array<object>;
+    'visualizationsIncluded': Array<AiVisualizationIncludedResponse>;
+    'visualizationsExcluded': Array<AiVisualizationExcludedResponse>;
+    'generatedAt': string;
+}
 export interface AiTextFilterValue {
     'type': AiTextFilterValueTypeEnum;
     'using': string;
@@ -844,6 +856,11 @@ export interface AiVisualizationConfig {
 }
 export type AiVisualizationConfigAnomalyDetectionSensitivityEnum = 'low' | 'medium' | 'high';
 export type AiVisualizationConfigAnomalyDetectionSizeEnum = 'small' | 'medium' | 'large';
+export interface AiVisualizationExcludedResponse {
+    'visualizationId': string;
+    'reason': string;
+    'title'?: string | null;
+}
 /**
  * @type AiVisualizationFilter
  */
@@ -854,6 +871,10 @@ export type AiVisualizationFilter = AiVisualizationAbsoluteDateFilter | AiVisual
 export interface AiVisualizationIdUpdateRequest {
     'id': string;
 }
+export interface AiVisualizationIncludedResponse {
+    'visualizationId': string;
+    'title'?: string | null;
+}
 export interface AiVisualizationMetricValueComparisonFilter {
     'type': AiVisualizationMetricValueComparisonFilterTypeEnum;
     'using': string;
@@ -2743,6 +2764,79 @@ export declare class ResponsesAi extends BaseAPI implements ResponsesAiInterface
      */
     patchResponseApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdResponsesResponseIdPatch(requestParameters: ResponsesAiPatchResponseApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdResponsesResponseIdPatchRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
 }
+/**
+ *
+ * @summary Post Summary
+ * @param {string} workspaceId
+ * @param {AiSummarizeRequest} aiSummarizeRequest
+ * @param {*} [options] Override http request option.
+ * @param {Configuration} [configuration] Optional configuration.
+ * @throws {RequiredError}
+ */
+export declare function SummaryAiAxiosParamCreator_SummarizeDashboard(workspaceId: string, aiSummarizeRequest: AiSummarizeRequest, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
+/**
+ *
+ * @summary Post Summary
+ * @param {AxiosInstance} axios Axios instance.
+ * @param {string} basePath Base path.
+ * @param {SummaryAiSummarizeDashboardRequest} requestParameters Request parameters.
+ * @param {*} [options] Override http request option.
+ * @param {Configuration} [configuration] Optional configuration.
+ * @throws {RequiredError}
+ */
+export declare function SummaryAi_SummarizeDashboard(axios: AxiosInstance, basePath: string, requestParameters: SummaryAiSummarizeDashboardRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<AiSummarizeResponse>;
+/**
+ * SummaryAi - interface
+ * @export
+ * @interface SummaryAi
+ */
+export interface SummaryAiInterface {
+    /**
+     *
+     * @summary Post Summary
+     * @param {SummaryAiSummarizeDashboardRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SummaryAiInterface
+     */
+    summarizeDashboard(requestParameters: SummaryAiSummarizeDashboardRequest, options?: AxiosRequestConfig): AxiosPromise<AiSummarizeResponse>;
+}
+/**
+ * Request parameters for summarizeDashboard operation in SummaryAi.
+ * @export
+ * @interface SummaryAiSummarizeDashboardRequest
+ */
+export interface SummaryAiSummarizeDashboardRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof SummaryAiSummarizeDashboard
+     */
+    readonly workspaceId: string;
+    /**
+     *
+     * @type {AiSummarizeRequest}
+     * @memberof SummaryAiSummarizeDashboard
+     */
+    readonly aiSummarizeRequest: AiSummarizeRequest;
+}
+/**
+ * SummaryAi - object-oriented interface
+ * @export
+ * @class SummaryAi
+ * @extends {BaseAPI}
+ */
+export declare class SummaryAi extends BaseAPI implements SummaryAiInterface {
+    /**
+     *
+     * @summary Post Summary
+     * @param {SummaryAiSummarizeDashboardRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SummaryAi
+     */
+    summarizeDashboard(requestParameters: SummaryAiSummarizeDashboardRequest, options?: AxiosRequestConfig): AxiosPromise<AiSummarizeResponse>;
+}
 /**
  *
  * @summary Patch Visualization

package/esm/generated/ai-json-api/api.js

@@ -2025,6 +2025,90 @@ export class ResponsesAi extends BaseAPI {
         return ResponsesAi_PatchResponseApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdResponsesResponseIdPatch(this.axios, this.basePath, requestParameters, options, this.configuration);
     }
 }
+// SummaryAi FP - SummaryAiAxiosParamCreator
+/**
+ *
+ * @summary Post Summary
+ * @param {string} workspaceId
+ * @param {AiSummarizeRequest} aiSummarizeRequest
+ * @param {*} [options] Override http request option.
+ * @param {Configuration} [configuration] Optional configuration.
+ * @throws {RequiredError}
+ */
+export async function SummaryAiAxiosParamCreator_SummarizeDashboard(workspaceId, aiSummarizeRequest, options = {}, configuration) {
+    // verify required parameter 'workspaceId' is not null or undefined
+    assertParamExists('summarizeDashboard', 'workspaceId', workspaceId);
+    // verify required parameter 'aiSummarizeRequest' is not null or undefined
+    assertParamExists('summarizeDashboard', 'aiSummarizeRequest', aiSummarizeRequest);
+    const localVarPath = `/api/v1/ai/workspaces/{workspace_id}/summary`
+        .replace(`{${"workspace_id"}}`, encodeURIComponent(String(workspaceId)));
+    // use dummy base URL string because the URL constructor only accepts absolute URLs.
+    const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+    let baseOptions;
+    if (configuration) {
+        baseOptions = configuration.baseOptions;
+    }
+    const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
+    const localVarHeaderParameter = {};
+    const localVarQueryParameter = {};
+    const consumes = [
+        'application/json'
+    ];
+    // use application/json if present, otherwise fallback to the first one
+    localVarHeaderParameter['Content-Type'] = consumes.includes('application/json')
+        ? 'application/json'
+        : consumes[0];
+    setSearchParams(localVarUrlObj, localVarQueryParameter);
+    const headersFromBaseOptions = baseOptions?.headers ? baseOptions.headers : {};
+    localVarRequestOptions.headers = {
+        ...localVarHeaderParameter,
+        ...headersFromBaseOptions,
+        ...options.headers,
+    };
+    const needsSerialization = typeof aiSummarizeRequest !== "string" ||
+        localVarRequestOptions.headers["Content-Type"] === "application/json";
+    localVarRequestOptions.data = needsSerialization
+        ? JSON.stringify(aiSummarizeRequest !== undefined ? aiSummarizeRequest : {})
+        : aiSummarizeRequest || "";
+    return {
+        url: toPathString(localVarUrlObj),
+        options: localVarRequestOptions,
+    };
+}
+// SummaryAi Api FP
+/**
+ *
+ * @summary Post Summary
+ * @param {AxiosInstance} axios Axios instance.
+ * @param {string} basePath Base path.
+ * @param {SummaryAiSummarizeDashboardRequest} requestParameters Request parameters.
+ * @param {*} [options] Override http request option.
+ * @param {Configuration} [configuration] Optional configuration.
+ * @throws {RequiredError}
+ */
+export async function SummaryAi_SummarizeDashboard(axios, basePath, requestParameters, options, configuration) {
+    const localVarAxiosArgs = await SummaryAiAxiosParamCreator_SummarizeDashboard(requestParameters.workspaceId, requestParameters.aiSummarizeRequest, options || {}, configuration);
+    return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, basePath);
+}
+/**
+ * SummaryAi - object-oriented interface
+ * @export
+ * @class SummaryAi
+ * @extends {BaseAPI}
+ */
+export class SummaryAi extends BaseAPI {
+    /**
+     *
+     * @summary Post Summary
+     * @param {SummaryAiSummarizeDashboardRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SummaryAi
+     */
+    summarizeDashboard(requestParameters, options) {
+        return SummaryAi_SummarizeDashboard(this.axios, this.basePath, requestParameters, options, this.configuration);
+    }
+}
 // VisualizationsAi FP - VisualizationsAiAxiosParamCreator
 /**
  *

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

@@ -535,6 +535,27 @@ export interface AutomationDashboardAttributeFilterAttributeFilter {
     'localIdentifier'?: string;
 }
 export type AutomationDashboardAttributeFilterAttributeFilterSelectionModeEnum = 'single' | 'multi';
+export interface AutomationDashboardCompoundComparisonCondition {
+    'comparison': AutomationDashboardCompoundComparisonConditionComparison;
+}
+export interface AutomationDashboardCompoundComparisonConditionComparison {
+    'operator': AutomationDashboardCompoundComparisonConditionComparisonOperatorEnum;
+    'value': number;
+}
+export type AutomationDashboardCompoundComparisonConditionComparisonOperatorEnum = 'GREATER_THAN' | 'GREATER_THAN_OR_EQUAL_TO' | 'LESS_THAN' | 'LESS_THAN_OR_EQUAL_TO' | 'EQUAL_TO' | 'NOT_EQUAL_TO';
+/**
+ * @type AutomationDashboardCompoundConditionItem
+ */
+export type AutomationDashboardCompoundConditionItem = AutomationDashboardCompoundComparisonCondition | AutomationDashboardCompoundRangeCondition;
+export interface AutomationDashboardCompoundRangeCondition {
+    'range': AutomationDashboardCompoundRangeConditionRange;
+}
+export interface AutomationDashboardCompoundRangeConditionRange {
+    'operator': AutomationDashboardCompoundRangeConditionRangeOperatorEnum;
+    'from': number;
+    'to': number;
+}
+export type AutomationDashboardCompoundRangeConditionRangeOperatorEnum = 'BETWEEN' | 'NOT_BETWEEN';
 export interface AutomationDashboardDateFilter {
     'dateFilter': AutomationDashboardDateFilterDateFilter;
 }
@@ -582,7 +603,7 @@ export type AutomationDashboardExportSettingsPageOrientationEnum = 'PORTRAIT' |
 /**
  * @type AutomationDashboardFilter
  */
-export type AutomationDashboardFilter = AutomationDashboardArbitraryAttributeFilter | AutomationDashboardAttributeFilter | AutomationDashboardDateFilter | AutomationDashboardMatchAttributeFilter;
+export type AutomationDashboardFilter = AutomationDashboardArbitraryAttributeFilter | AutomationDashboardAttributeFilter | AutomationDashboardDateFilter | AutomationDashboardMatchAttributeFilter | AutomationDashboardMeasureValueFilter;
 export interface AutomationDashboardMatchAttributeFilter {
     'matchAttributeFilter': AutomationDashboardMatchAttributeFilterMatchAttributeFilter;
 }
@@ -596,6 +617,15 @@ export interface AutomationDashboardMatchAttributeFilterMatchAttributeFilter {
     'localIdentifier'?: string;
 }
 export type AutomationDashboardMatchAttributeFilterMatchAttributeFilterOperatorEnum = 'contains' | 'startsWith' | 'endsWith';
+export interface AutomationDashboardMeasureValueFilter {
+    'dashboardMeasureValueFilter': AutomationDashboardMeasureValueFilterDashboardMeasureValueFilter;
+}
+export interface AutomationDashboardMeasureValueFilterDashboardMeasureValueFilter {
+    'measure': AutomationIdentifierRef;
+    'conditions': Array<AutomationDashboardCompoundConditionItem>;
+    'title'?: string;
+    'localIdentifier'?: string;
+}
 /**
  * Export request object describing the export properties for dashboard tabular exports (v2 with dashboardId).
  */

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

@@ -362,6 +362,27 @@ export interface ExportDashboardAttributeFilterAttributeFilter {
     'localIdentifier'?: string;
 }
 export type ExportDashboardAttributeFilterAttributeFilterSelectionModeEnum = 'single' | 'multi';
+export interface ExportDashboardCompoundComparisonCondition {
+    'comparison': ExportDashboardCompoundComparisonConditionComparison;
+}
+export interface ExportDashboardCompoundComparisonConditionComparison {
+    'operator': ExportDashboardCompoundComparisonConditionComparisonOperatorEnum;
+    'value': number;
+}
+export type ExportDashboardCompoundComparisonConditionComparisonOperatorEnum = 'GREATER_THAN' | 'GREATER_THAN_OR_EQUAL_TO' | 'LESS_THAN' | 'LESS_THAN_OR_EQUAL_TO' | 'EQUAL_TO' | 'NOT_EQUAL_TO';
+/**
+ * @type ExportDashboardCompoundConditionItem
+ */
+export type ExportDashboardCompoundConditionItem = ExportDashboardCompoundComparisonCondition | ExportDashboardCompoundRangeCondition;
+export interface ExportDashboardCompoundRangeCondition {
+    'range': ExportDashboardCompoundRangeConditionRange;
+}
+export interface ExportDashboardCompoundRangeConditionRange {
+    'operator': ExportDashboardCompoundRangeConditionRangeOperatorEnum;
+    'from': number;
+    'to': number;
+}
+export type ExportDashboardCompoundRangeConditionRangeOperatorEnum = 'BETWEEN' | 'NOT_BETWEEN';
 export interface ExportDashboardDateFilter {
     'dateFilter': ExportDashboardDateFilterDateFilter;
 }
@@ -409,7 +430,7 @@ export type ExportDashboardExportSettingsPageOrientationEnum = 'PORTRAIT' | 'LAN
 /**
  * @type ExportDashboardFilter
  */
-export type ExportDashboardFilter = ExportDashboardArbitraryAttributeFilter | ExportDashboardAttributeFilter | ExportDashboardDateFilter | ExportDashboardMatchAttributeFilter;
+export type ExportDashboardFilter = ExportDashboardArbitraryAttributeFilter | ExportDashboardAttributeFilter | ExportDashboardDateFilter | ExportDashboardMatchAttributeFilter | ExportDashboardMeasureValueFilter;
 export interface ExportDashboardMatchAttributeFilter {
     'matchAttributeFilter': ExportDashboardMatchAttributeFilterMatchAttributeFilter;
 }
@@ -423,6 +444,15 @@ export interface ExportDashboardMatchAttributeFilterMatchAttributeFilter {
     'localIdentifier'?: string;
 }
 export type ExportDashboardMatchAttributeFilterMatchAttributeFilterOperatorEnum = 'contains' | 'startsWith' | 'endsWith';
+export interface ExportDashboardMeasureValueFilter {
+    'dashboardMeasureValueFilter': ExportDashboardMeasureValueFilterDashboardMeasureValueFilter;
+}
+export interface ExportDashboardMeasureValueFilterDashboardMeasureValueFilter {
+    'measure': ExportIdentifierRef;
+    'conditions': Array<ExportDashboardCompoundConditionItem>;
+    'title'?: string;
+    'localIdentifier'?: string;
+}
 /**
  * Export request object describing the export properties for dashboard tabular exports.
  */