@gooddata/api-client-tiger 11.35.0-alpha.5 → 11.35.0-alpha.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -146,6 +146,10 @@ export interface AiConversationResponse {
146
146
  * Whether this is a preview conversation.
147
147
  */
148
148
  'isPreview'?: boolean;
149
+ /**
150
+ * Whether this conversation is pinned by the user.
151
+ */
152
+ 'pinned'?: boolean;
149
153
  /**
150
154
  * Conversation creation timestamp (ISO-8601 UTC).
151
155
  */
@@ -182,6 +186,7 @@ export interface AiConversationTurnResponse {
182
186
  */
183
187
  export interface AiConversationUpdateRequest {
184
188
  'title'?: string | null;
189
+ 'pinned'?: boolean | null;
185
190
  }
186
191
  export interface AiDateFilterAbsolute {
187
192
  'type': AiDateFilterAbsoluteTypeEnum;
@@ -666,6 +671,18 @@ export interface AiSkillResponse {
666
671
  'tags': Array<string>;
667
672
  'examples': Array<string>;
668
673
  }
674
+ export interface AiSummarizeRequest {
675
+ 'visualizations': Array<string>;
676
+ 'filterContext': Array<object>;
677
+ 'dashboardId': string;
678
+ }
679
+ export interface AiSummarizeResponse {
680
+ 'summary': string;
681
+ 'filterContext': Array<object>;
682
+ 'visualizationsIncluded': Array<AiVisualizationIncludedResponse>;
683
+ 'visualizationsExcluded': Array<AiVisualizationExcludedResponse>;
684
+ 'generatedAt': string;
685
+ }
669
686
  export interface AiTextFilterValue {
670
687
  'type': AiTextFilterValueTypeEnum;
671
688
  'using': string;
@@ -839,6 +856,11 @@ export interface AiVisualizationConfig {
839
856
  }
840
857
  export type AiVisualizationConfigAnomalyDetectionSensitivityEnum = 'low' | 'medium' | 'high';
841
858
  export type AiVisualizationConfigAnomalyDetectionSizeEnum = 'small' | 'medium' | 'large';
859
+ export interface AiVisualizationExcludedResponse {
860
+ 'visualizationId': string;
861
+ 'reason': string;
862
+ 'title'?: string | null;
863
+ }
842
864
  /**
843
865
  * @type AiVisualizationFilter
844
866
  */
@@ -849,6 +871,10 @@ export type AiVisualizationFilter = AiVisualizationAbsoluteDateFilter | AiVisual
849
871
  export interface AiVisualizationIdUpdateRequest {
850
872
  'id': string;
851
873
  }
874
+ export interface AiVisualizationIncludedResponse {
875
+ 'visualizationId': string;
876
+ 'title'?: string | null;
877
+ }
852
878
  export interface AiVisualizationMetricValueComparisonFilter {
853
879
  'type': AiVisualizationMetricValueComparisonFilterTypeEnum;
854
880
  'using': string;
@@ -2738,6 +2764,79 @@ export declare class ResponsesAi extends BaseAPI implements ResponsesAiInterface
2738
2764
  */
2739
2765
  patchResponseApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdResponsesResponseIdPatch(requestParameters: ResponsesAiPatchResponseApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdResponsesResponseIdPatchRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
2740
2766
  }
2767
+ /**
2768
+ *
2769
+ * @summary Post Summary
2770
+ * @param {string} workspaceId
2771
+ * @param {AiSummarizeRequest} aiSummarizeRequest
2772
+ * @param {*} [options] Override http request option.
2773
+ * @param {Configuration} [configuration] Optional configuration.
2774
+ * @throws {RequiredError}
2775
+ */
2776
+ export declare function SummaryAiAxiosParamCreator_SummarizeDashboard(workspaceId: string, aiSummarizeRequest: AiSummarizeRequest, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
2777
+ /**
2778
+ *
2779
+ * @summary Post Summary
2780
+ * @param {AxiosInstance} axios Axios instance.
2781
+ * @param {string} basePath Base path.
2782
+ * @param {SummaryAiSummarizeDashboardRequest} requestParameters Request parameters.
2783
+ * @param {*} [options] Override http request option.
2784
+ * @param {Configuration} [configuration] Optional configuration.
2785
+ * @throws {RequiredError}
2786
+ */
2787
+ export declare function SummaryAi_SummarizeDashboard(axios: AxiosInstance, basePath: string, requestParameters: SummaryAiSummarizeDashboardRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<AiSummarizeResponse>;
2788
+ /**
2789
+ * SummaryAi - interface
2790
+ * @export
2791
+ * @interface SummaryAi
2792
+ */
2793
+ export interface SummaryAiInterface {
2794
+ /**
2795
+ *
2796
+ * @summary Post Summary
2797
+ * @param {SummaryAiSummarizeDashboardRequest} requestParameters Request parameters.
2798
+ * @param {*} [options] Override http request option.
2799
+ * @throws {RequiredError}
2800
+ * @memberof SummaryAiInterface
2801
+ */
2802
+ summarizeDashboard(requestParameters: SummaryAiSummarizeDashboardRequest, options?: AxiosRequestConfig): AxiosPromise<AiSummarizeResponse>;
2803
+ }
2804
+ /**
2805
+ * Request parameters for summarizeDashboard operation in SummaryAi.
2806
+ * @export
2807
+ * @interface SummaryAiSummarizeDashboardRequest
2808
+ */
2809
+ export interface SummaryAiSummarizeDashboardRequest {
2810
+ /**
2811
+ *
2812
+ * @type {string}
2813
+ * @memberof SummaryAiSummarizeDashboard
2814
+ */
2815
+ readonly workspaceId: string;
2816
+ /**
2817
+ *
2818
+ * @type {AiSummarizeRequest}
2819
+ * @memberof SummaryAiSummarizeDashboard
2820
+ */
2821
+ readonly aiSummarizeRequest: AiSummarizeRequest;
2822
+ }
2823
+ /**
2824
+ * SummaryAi - object-oriented interface
2825
+ * @export
2826
+ * @class SummaryAi
2827
+ * @extends {BaseAPI}
2828
+ */
2829
+ export declare class SummaryAi extends BaseAPI implements SummaryAiInterface {
2830
+ /**
2831
+ *
2832
+ * @summary Post Summary
2833
+ * @param {SummaryAiSummarizeDashboardRequest} requestParameters Request parameters.
2834
+ * @param {*} [options] Override http request option.
2835
+ * @throws {RequiredError}
2836
+ * @memberof SummaryAi
2837
+ */
2838
+ summarizeDashboard(requestParameters: SummaryAiSummarizeDashboardRequest, options?: AxiosRequestConfig): AxiosPromise<AiSummarizeResponse>;
2839
+ }
2741
2840
  /**
2742
2841
  *
2743
2842
  * @summary Patch Visualization
@@ -2025,6 +2025,90 @@ export class ResponsesAi extends BaseAPI {
2025
2025
  return ResponsesAi_PatchResponseApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdResponsesResponseIdPatch(this.axios, this.basePath, requestParameters, options, this.configuration);
2026
2026
  }
2027
2027
  }
2028
+ // SummaryAi FP - SummaryAiAxiosParamCreator
2029
+ /**
2030
+ *
2031
+ * @summary Post Summary
2032
+ * @param {string} workspaceId
2033
+ * @param {AiSummarizeRequest} aiSummarizeRequest
2034
+ * @param {*} [options] Override http request option.
2035
+ * @param {Configuration} [configuration] Optional configuration.
2036
+ * @throws {RequiredError}
2037
+ */
2038
+ export async function SummaryAiAxiosParamCreator_SummarizeDashboard(workspaceId, aiSummarizeRequest, options = {}, configuration) {
2039
+ // verify required parameter 'workspaceId' is not null or undefined
2040
+ assertParamExists('summarizeDashboard', 'workspaceId', workspaceId);
2041
+ // verify required parameter 'aiSummarizeRequest' is not null or undefined
2042
+ assertParamExists('summarizeDashboard', 'aiSummarizeRequest', aiSummarizeRequest);
2043
+ const localVarPath = `/api/v1/ai/workspaces/{workspace_id}/summary`
2044
+ .replace(`{${"workspace_id"}}`, encodeURIComponent(String(workspaceId)));
2045
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
2046
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
2047
+ let baseOptions;
2048
+ if (configuration) {
2049
+ baseOptions = configuration.baseOptions;
2050
+ }
2051
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
2052
+ const localVarHeaderParameter = {};
2053
+ const localVarQueryParameter = {};
2054
+ const consumes = [
2055
+ 'application/json'
2056
+ ];
2057
+ // use application/json if present, otherwise fallback to the first one
2058
+ localVarHeaderParameter['Content-Type'] = consumes.includes('application/json')
2059
+ ? 'application/json'
2060
+ : consumes[0];
2061
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
2062
+ const headersFromBaseOptions = baseOptions?.headers ? baseOptions.headers : {};
2063
+ localVarRequestOptions.headers = {
2064
+ ...localVarHeaderParameter,
2065
+ ...headersFromBaseOptions,
2066
+ ...options.headers,
2067
+ };
2068
+ const needsSerialization = typeof aiSummarizeRequest !== "string" ||
2069
+ localVarRequestOptions.headers["Content-Type"] === "application/json";
2070
+ localVarRequestOptions.data = needsSerialization
2071
+ ? JSON.stringify(aiSummarizeRequest !== undefined ? aiSummarizeRequest : {})
2072
+ : aiSummarizeRequest || "";
2073
+ return {
2074
+ url: toPathString(localVarUrlObj),
2075
+ options: localVarRequestOptions,
2076
+ };
2077
+ }
2078
+ // SummaryAi Api FP
2079
+ /**
2080
+ *
2081
+ * @summary Post Summary
2082
+ * @param {AxiosInstance} axios Axios instance.
2083
+ * @param {string} basePath Base path.
2084
+ * @param {SummaryAiSummarizeDashboardRequest} requestParameters Request parameters.
2085
+ * @param {*} [options] Override http request option.
2086
+ * @param {Configuration} [configuration] Optional configuration.
2087
+ * @throws {RequiredError}
2088
+ */
2089
+ export async function SummaryAi_SummarizeDashboard(axios, basePath, requestParameters, options, configuration) {
2090
+ const localVarAxiosArgs = await SummaryAiAxiosParamCreator_SummarizeDashboard(requestParameters.workspaceId, requestParameters.aiSummarizeRequest, options || {}, configuration);
2091
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, basePath);
2092
+ }
2093
+ /**
2094
+ * SummaryAi - object-oriented interface
2095
+ * @export
2096
+ * @class SummaryAi
2097
+ * @extends {BaseAPI}
2098
+ */
2099
+ export class SummaryAi extends BaseAPI {
2100
+ /**
2101
+ *
2102
+ * @summary Post Summary
2103
+ * @param {SummaryAiSummarizeDashboardRequest} requestParameters Request parameters.
2104
+ * @param {*} [options] Override http request option.
2105
+ * @throws {RequiredError}
2106
+ * @memberof SummaryAi
2107
+ */
2108
+ summarizeDashboard(requestParameters, options) {
2109
+ return SummaryAi_SummarizeDashboard(this.axios, this.basePath, requestParameters, options, this.configuration);
2110
+ }
2111
+ }
2028
2112
  // VisualizationsAi FP - VisualizationsAiAxiosParamCreator
2029
2113
  /**
2030
2114
  *
@@ -535,6 +535,27 @@ export interface AutomationDashboardAttributeFilterAttributeFilter {
535
535
  'localIdentifier'?: string;
536
536
  }
537
537
  export type AutomationDashboardAttributeFilterAttributeFilterSelectionModeEnum = 'single' | 'multi';
538
+ export interface AutomationDashboardCompoundComparisonCondition {
539
+ 'comparison': AutomationDashboardCompoundComparisonConditionComparison;
540
+ }
541
+ export interface AutomationDashboardCompoundComparisonConditionComparison {
542
+ 'operator': AutomationDashboardCompoundComparisonConditionComparisonOperatorEnum;
543
+ 'value': number;
544
+ }
545
+ export type AutomationDashboardCompoundComparisonConditionComparisonOperatorEnum = 'GREATER_THAN' | 'GREATER_THAN_OR_EQUAL_TO' | 'LESS_THAN' | 'LESS_THAN_OR_EQUAL_TO' | 'EQUAL_TO' | 'NOT_EQUAL_TO';
546
+ /**
547
+ * @type AutomationDashboardCompoundConditionItem
548
+ */
549
+ export type AutomationDashboardCompoundConditionItem = AutomationDashboardCompoundComparisonCondition | AutomationDashboardCompoundRangeCondition;
550
+ export interface AutomationDashboardCompoundRangeCondition {
551
+ 'range': AutomationDashboardCompoundRangeConditionRange;
552
+ }
553
+ export interface AutomationDashboardCompoundRangeConditionRange {
554
+ 'operator': AutomationDashboardCompoundRangeConditionRangeOperatorEnum;
555
+ 'from': number;
556
+ 'to': number;
557
+ }
558
+ export type AutomationDashboardCompoundRangeConditionRangeOperatorEnum = 'BETWEEN' | 'NOT_BETWEEN';
538
559
  export interface AutomationDashboardDateFilter {
539
560
  'dateFilter': AutomationDashboardDateFilterDateFilter;
540
561
  }
@@ -582,7 +603,7 @@ export type AutomationDashboardExportSettingsPageOrientationEnum = 'PORTRAIT' |
582
603
  /**
583
604
  * @type AutomationDashboardFilter
584
605
  */
585
- export type AutomationDashboardFilter = AutomationDashboardArbitraryAttributeFilter | AutomationDashboardAttributeFilter | AutomationDashboardDateFilter | AutomationDashboardMatchAttributeFilter;
606
+ export type AutomationDashboardFilter = AutomationDashboardArbitraryAttributeFilter | AutomationDashboardAttributeFilter | AutomationDashboardDateFilter | AutomationDashboardMatchAttributeFilter | AutomationDashboardMeasureValueFilter;
586
607
  export interface AutomationDashboardMatchAttributeFilter {
587
608
  'matchAttributeFilter': AutomationDashboardMatchAttributeFilterMatchAttributeFilter;
588
609
  }
@@ -596,6 +617,15 @@ export interface AutomationDashboardMatchAttributeFilterMatchAttributeFilter {
596
617
  'localIdentifier'?: string;
597
618
  }
598
619
  export type AutomationDashboardMatchAttributeFilterMatchAttributeFilterOperatorEnum = 'contains' | 'startsWith' | 'endsWith';
620
+ export interface AutomationDashboardMeasureValueFilter {
621
+ 'dashboardMeasureValueFilter': AutomationDashboardMeasureValueFilterDashboardMeasureValueFilter;
622
+ }
623
+ export interface AutomationDashboardMeasureValueFilterDashboardMeasureValueFilter {
624
+ 'measure': AutomationIdentifierRef;
625
+ 'conditions': Array<AutomationDashboardCompoundConditionItem>;
626
+ 'title'?: string;
627
+ 'localIdentifier'?: string;
628
+ }
599
629
  /**
600
630
  * Export request object describing the export properties for dashboard tabular exports (v2 with dashboardId).
601
631
  */
@@ -362,6 +362,27 @@ export interface ExportDashboardAttributeFilterAttributeFilter {
362
362
  'localIdentifier'?: string;
363
363
  }
364
364
  export type ExportDashboardAttributeFilterAttributeFilterSelectionModeEnum = 'single' | 'multi';
365
+ export interface ExportDashboardCompoundComparisonCondition {
366
+ 'comparison': ExportDashboardCompoundComparisonConditionComparison;
367
+ }
368
+ export interface ExportDashboardCompoundComparisonConditionComparison {
369
+ 'operator': ExportDashboardCompoundComparisonConditionComparisonOperatorEnum;
370
+ 'value': number;
371
+ }
372
+ export type ExportDashboardCompoundComparisonConditionComparisonOperatorEnum = 'GREATER_THAN' | 'GREATER_THAN_OR_EQUAL_TO' | 'LESS_THAN' | 'LESS_THAN_OR_EQUAL_TO' | 'EQUAL_TO' | 'NOT_EQUAL_TO';
373
+ /**
374
+ * @type ExportDashboardCompoundConditionItem
375
+ */
376
+ export type ExportDashboardCompoundConditionItem = ExportDashboardCompoundComparisonCondition | ExportDashboardCompoundRangeCondition;
377
+ export interface ExportDashboardCompoundRangeCondition {
378
+ 'range': ExportDashboardCompoundRangeConditionRange;
379
+ }
380
+ export interface ExportDashboardCompoundRangeConditionRange {
381
+ 'operator': ExportDashboardCompoundRangeConditionRangeOperatorEnum;
382
+ 'from': number;
383
+ 'to': number;
384
+ }
385
+ export type ExportDashboardCompoundRangeConditionRangeOperatorEnum = 'BETWEEN' | 'NOT_BETWEEN';
365
386
  export interface ExportDashboardDateFilter {
366
387
  'dateFilter': ExportDashboardDateFilterDateFilter;
367
388
  }
@@ -409,7 +430,7 @@ export type ExportDashboardExportSettingsPageOrientationEnum = 'PORTRAIT' | 'LAN
409
430
  /**
410
431
  * @type ExportDashboardFilter
411
432
  */
412
- export type ExportDashboardFilter = ExportDashboardArbitraryAttributeFilter | ExportDashboardAttributeFilter | ExportDashboardDateFilter | ExportDashboardMatchAttributeFilter;
433
+ export type ExportDashboardFilter = ExportDashboardArbitraryAttributeFilter | ExportDashboardAttributeFilter | ExportDashboardDateFilter | ExportDashboardMatchAttributeFilter | ExportDashboardMeasureValueFilter;
413
434
  export interface ExportDashboardMatchAttributeFilter {
414
435
  'matchAttributeFilter': ExportDashboardMatchAttributeFilterMatchAttributeFilter;
415
436
  }
@@ -423,6 +444,15 @@ export interface ExportDashboardMatchAttributeFilterMatchAttributeFilter {
423
444
  'localIdentifier'?: string;
424
445
  }
425
446
  export type ExportDashboardMatchAttributeFilterMatchAttributeFilterOperatorEnum = 'contains' | 'startsWith' | 'endsWith';
447
+ export interface ExportDashboardMeasureValueFilter {
448
+ 'dashboardMeasureValueFilter': ExportDashboardMeasureValueFilterDashboardMeasureValueFilter;
449
+ }
450
+ export interface ExportDashboardMeasureValueFilterDashboardMeasureValueFilter {
451
+ 'measure': ExportIdentifierRef;
452
+ 'conditions': Array<ExportDashboardCompoundConditionItem>;
453
+ 'title'?: string;
454
+ 'localIdentifier'?: string;
455
+ }
426
456
  /**
427
457
  * Export request object describing the export properties for dashboard tabular exports.
428
458
  */