@gooddata/api-client-tiger 9.10.0-alpha.9 → 10.0.0-alpha.10

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.
@@ -564,6 +564,12 @@ export interface AttributeHeaderOutAttributeHeader {
564
564
  * @memberof AttributeHeaderOutAttributeHeader
565
565
  */
566
566
  format?: AttributeFormat;
567
+ /**
568
+ *
569
+ * @type {string}
570
+ * @memberof AttributeHeaderOutAttributeHeader
571
+ */
572
+ valueType?: AttributeHeaderOutAttributeHeaderValueTypeEnum;
567
573
  }
568
574
  export declare const AttributeHeaderOutAttributeHeaderGranularityEnum: {
569
575
  readonly MINUTE: "MINUTE";
@@ -583,6 +589,15 @@ export declare const AttributeHeaderOutAttributeHeaderGranularityEnum: {
583
589
  readonly QUARTER_OF_YEAR: "QUARTER_OF_YEAR";
584
590
  };
585
591
  export type AttributeHeaderOutAttributeHeaderGranularityEnum = typeof AttributeHeaderOutAttributeHeaderGranularityEnum[keyof typeof AttributeHeaderOutAttributeHeaderGranularityEnum];
592
+ export declare const AttributeHeaderOutAttributeHeaderValueTypeEnum: {
593
+ readonly TEXT: "TEXT";
594
+ readonly HYPERLINK: "HYPERLINK";
595
+ readonly GEO: "GEO";
596
+ readonly GEO_LONGITUDE: "GEO_LONGITUDE";
597
+ readonly GEO_LATITUDE: "GEO_LATITUDE";
598
+ readonly IMAGE: "IMAGE";
599
+ };
600
+ export type AttributeHeaderOutAttributeHeaderValueTypeEnum = typeof AttributeHeaderOutAttributeHeaderValueTypeEnum[keyof typeof AttributeHeaderOutAttributeHeaderValueTypeEnum];
586
601
  /**
587
602
  *
588
603
  * @export
@@ -627,6 +642,62 @@ export interface AttributeResultHeader {
627
642
  */
628
643
  primaryLabelValue: string;
629
644
  }
645
+ /**
646
+ *
647
+ * @export
648
+ * @interface ClusteringRequest
649
+ */
650
+ export interface ClusteringRequest {
651
+ /**
652
+ * Number of clusters to create
653
+ * @type {number}
654
+ * @memberof ClusteringRequest
655
+ */
656
+ numberOfClusters: number;
657
+ }
658
+ /**
659
+ *
660
+ * @export
661
+ * @interface ClusteringResult
662
+ */
663
+ export interface ClusteringResult {
664
+ /**
665
+ *
666
+ * @type {Array<object>}
667
+ * @memberof ClusteringResult
668
+ */
669
+ attribute: Array<object>;
670
+ /**
671
+ *
672
+ * @type {Array<number>}
673
+ * @memberof ClusteringResult
674
+ */
675
+ xCoord?: Array<number>;
676
+ /**
677
+ *
678
+ * @type {Array<number>}
679
+ * @memberof ClusteringResult
680
+ */
681
+ yCoord?: Array<number>;
682
+ /**
683
+ *
684
+ * @type {Array<number>}
685
+ * @memberof ClusteringResult
686
+ */
687
+ clusters: Array<number>;
688
+ /**
689
+ *
690
+ * @type {Array<number>}
691
+ * @memberof ClusteringResult
692
+ */
693
+ ycoord: Array<number>;
694
+ /**
695
+ *
696
+ * @type {Array<number>}
697
+ * @memberof ClusteringResult
698
+ */
699
+ xcoord: Array<number>;
700
+ }
630
701
  /**
631
702
  * Filter the result by comparing specified metric to given constant value, using given comparison operator.
632
703
  * @export
@@ -1157,6 +1228,68 @@ export type FilterDefinition = AbsoluteDateFilter | ComparisonMeasureValueFilter
1157
1228
  * @export
1158
1229
  */
1159
1230
  export type FilterDefinitionForSimpleMeasure = AttributeFilter | DateFilter;
1231
+ /**
1232
+ *
1233
+ * @export
1234
+ * @interface ForecastRequest
1235
+ */
1236
+ export interface ForecastRequest {
1237
+ /**
1238
+ * Number of future periods that should be forecasted
1239
+ * @type {number}
1240
+ * @memberof ForecastRequest
1241
+ */
1242
+ forecastPeriod: number;
1243
+ /**
1244
+ * Confidence interval boundary value.
1245
+ * @type {number}
1246
+ * @memberof ForecastRequest
1247
+ */
1248
+ confidenceLevel?: number;
1249
+ /**
1250
+ * Whether the input data is seasonal
1251
+ * @type {boolean}
1252
+ * @memberof ForecastRequest
1253
+ */
1254
+ seasonal?: boolean;
1255
+ }
1256
+ /**
1257
+ *
1258
+ * @export
1259
+ * @interface ForecastResult
1260
+ */
1261
+ export interface ForecastResult {
1262
+ /**
1263
+ *
1264
+ * @type {Array<string>}
1265
+ * @memberof ForecastResult
1266
+ */
1267
+ attribute: Array<string>;
1268
+ /**
1269
+ *
1270
+ * @type {Array<number>}
1271
+ * @memberof ForecastResult
1272
+ */
1273
+ origin: Array<number>;
1274
+ /**
1275
+ *
1276
+ * @type {Array<number>}
1277
+ * @memberof ForecastResult
1278
+ */
1279
+ prediction: Array<number>;
1280
+ /**
1281
+ *
1282
+ * @type {Array<number>}
1283
+ * @memberof ForecastResult
1284
+ */
1285
+ lowerBound: Array<number>;
1286
+ /**
1287
+ *
1288
+ * @type {Array<number>}
1289
+ * @memberof ForecastResult
1290
+ */
1291
+ upperBound: Array<number>;
1292
+ }
1160
1293
  /**
1161
1294
  * Contains the information specific for a group of headers. These groups correlate to attributes and metric groups.
1162
1295
  * @export
@@ -1863,6 +1996,19 @@ export declare const SimpleMeasureDefinitionMeasureAggregationEnum: {
1863
1996
  readonly APPROXIMATE_COUNT: "APPROXIMATE_COUNT";
1864
1997
  };
1865
1998
  export type SimpleMeasureDefinitionMeasureAggregationEnum = typeof SimpleMeasureDefinitionMeasureAggregationEnum[keyof typeof SimpleMeasureDefinitionMeasureAggregationEnum];
1999
+ /**
2000
+ *
2001
+ * @export
2002
+ * @interface SmartFunctionResponse
2003
+ */
2004
+ export interface SmartFunctionResponse {
2005
+ /**
2006
+ *
2007
+ * @type {ExecutionLinks}
2008
+ * @memberof SmartFunctionResponse
2009
+ */
2010
+ links: ExecutionLinks;
2011
+ }
1866
2012
  /**
1867
2013
  * @type SortKey
1868
2014
  * @export
@@ -2106,6 +2252,28 @@ export interface ValidateByItem {
2106
2252
  * @export
2107
2253
  */
2108
2254
  export declare const ActionsApiAxiosParamCreator: (configuration?: Configuration) => {
2255
+ /**
2256
+ * (EXPERIMENTAL) Computes clusters for data points from the provided execution result and parameters.
2257
+ * @summary (EXPERIMENTAL) Smart functions - Clustering
2258
+ * @param {string} workspaceId Workspace identifier
2259
+ * @param {string} resultId Input result ID to be used in the computation
2260
+ * @param {ClusteringRequest} clusteringRequest
2261
+ * @param {boolean} [skipCache] Ignore all caches during execution of current request.
2262
+ * @param {*} [options] Override http request option.
2263
+ * @throws {RequiredError}
2264
+ */
2265
+ clustering: (workspaceId: string, resultId: string, clusteringRequest: ClusteringRequest, skipCache?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
2266
+ /**
2267
+ * (EXPERIMENTAL) Gets clustering result.
2268
+ * @summary (EXPERIMENTAL) Smart functions - Clustering Result
2269
+ * @param {string} workspaceId Workspace identifier
2270
+ * @param {string} resultId Result ID
2271
+ * @param {number} [offset]
2272
+ * @param {number} [limit]
2273
+ * @param {*} [options] Override http request option.
2274
+ * @throws {RequiredError}
2275
+ */
2276
+ clusteringResult: (workspaceId: string, resultId: string, offset?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
2109
2277
  /**
2110
2278
  * Returns paged list of elements (values) of given label satisfying given filtering criteria.
2111
2279
  * @summary Listing of label values. The resulting data are limited by the static platform limit to the maximum of 10000 rows.
@@ -2157,6 +2325,28 @@ export declare const ActionsApiAxiosParamCreator: (configuration?: Configuration
2157
2325
  * @throws {RequiredError}
2158
2326
  */
2159
2327
  explainAFM: (workspaceId: string, afmExecution: AfmExecution, explainType?: "MAQL" | "GRPC_MODEL" | "GRPC_MODEL_SVG" | "WDF" | "QT" | "QT_SVG" | "OPT_QT" | "OPT_QT_SVG" | "SQL" | "SETTINGS", options?: AxiosRequestConfig) => Promise<RequestArgs>;
2328
+ /**
2329
+ * (BETA) Computes forecasted data points from the provided execution result and parameters.
2330
+ * @summary (BETA) Smart functions - Forecast
2331
+ * @param {string} workspaceId Workspace identifier
2332
+ * @param {string} resultId Input result ID to be used in the computation
2333
+ * @param {ForecastRequest} forecastRequest
2334
+ * @param {boolean} [skipCache] Ignore all caches during execution of current request.
2335
+ * @param {*} [options] Override http request option.
2336
+ * @throws {RequiredError}
2337
+ */
2338
+ forecast: (workspaceId: string, resultId: string, forecastRequest: ForecastRequest, skipCache?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
2339
+ /**
2340
+ * (BETA) Gets forecast result.
2341
+ * @summary (BETA) Smart functions - Forecast Result
2342
+ * @param {string} workspaceId Workspace identifier
2343
+ * @param {string} resultId Result ID
2344
+ * @param {number} [offset]
2345
+ * @param {number} [limit]
2346
+ * @param {*} [options] Override http request option.
2347
+ * @throws {RequiredError}
2348
+ */
2349
+ forecastResult: (workspaceId: string, resultId: string, offset?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
2160
2350
  /**
2161
2351
  * The resource provides execution result\'s metadata as AFM and resultSpec used in execution request and an executionResponse
2162
2352
  * @summary Get a single execution result\'s metadata.
@@ -2184,6 +2374,28 @@ export declare const ActionsApiAxiosParamCreator: (configuration?: Configuration
2184
2374
  * @export
2185
2375
  */
2186
2376
  export declare const ActionsApiFp: (configuration?: Configuration) => {
2377
+ /**
2378
+ * (EXPERIMENTAL) Computes clusters for data points from the provided execution result and parameters.
2379
+ * @summary (EXPERIMENTAL) Smart functions - Clustering
2380
+ * @param {string} workspaceId Workspace identifier
2381
+ * @param {string} resultId Input result ID to be used in the computation
2382
+ * @param {ClusteringRequest} clusteringRequest
2383
+ * @param {boolean} [skipCache] Ignore all caches during execution of current request.
2384
+ * @param {*} [options] Override http request option.
2385
+ * @throws {RequiredError}
2386
+ */
2387
+ clustering(workspaceId: string, resultId: string, clusteringRequest: ClusteringRequest, skipCache?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SmartFunctionResponse>>;
2388
+ /**
2389
+ * (EXPERIMENTAL) Gets clustering result.
2390
+ * @summary (EXPERIMENTAL) Smart functions - Clustering Result
2391
+ * @param {string} workspaceId Workspace identifier
2392
+ * @param {string} resultId Result ID
2393
+ * @param {number} [offset]
2394
+ * @param {number} [limit]
2395
+ * @param {*} [options] Override http request option.
2396
+ * @throws {RequiredError}
2397
+ */
2398
+ clusteringResult(workspaceId: string, resultId: string, offset?: number, limit?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ClusteringResult>>;
2187
2399
  /**
2188
2400
  * Returns paged list of elements (values) of given label satisfying given filtering criteria.
2189
2401
  * @summary Listing of label values. The resulting data are limited by the static platform limit to the maximum of 10000 rows.
@@ -2235,6 +2447,28 @@ export declare const ActionsApiFp: (configuration?: Configuration) => {
2235
2447
  * @throws {RequiredError}
2236
2448
  */
2237
2449
  explainAFM(workspaceId: string, afmExecution: AfmExecution, explainType?: "MAQL" | "GRPC_MODEL" | "GRPC_MODEL_SVG" | "WDF" | "QT" | "QT_SVG" | "OPT_QT" | "OPT_QT_SVG" | "SQL" | "SETTINGS", options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
2450
+ /**
2451
+ * (BETA) Computes forecasted data points from the provided execution result and parameters.
2452
+ * @summary (BETA) Smart functions - Forecast
2453
+ * @param {string} workspaceId Workspace identifier
2454
+ * @param {string} resultId Input result ID to be used in the computation
2455
+ * @param {ForecastRequest} forecastRequest
2456
+ * @param {boolean} [skipCache] Ignore all caches during execution of current request.
2457
+ * @param {*} [options] Override http request option.
2458
+ * @throws {RequiredError}
2459
+ */
2460
+ forecast(workspaceId: string, resultId: string, forecastRequest: ForecastRequest, skipCache?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SmartFunctionResponse>>;
2461
+ /**
2462
+ * (BETA) Gets forecast result.
2463
+ * @summary (BETA) Smart functions - Forecast Result
2464
+ * @param {string} workspaceId Workspace identifier
2465
+ * @param {string} resultId Result ID
2466
+ * @param {number} [offset]
2467
+ * @param {number} [limit]
2468
+ * @param {*} [options] Override http request option.
2469
+ * @throws {RequiredError}
2470
+ */
2471
+ forecastResult(workspaceId: string, resultId: string, offset?: number, limit?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ForecastResult>>;
2238
2472
  /**
2239
2473
  * The resource provides execution result\'s metadata as AFM and resultSpec used in execution request and an executionResponse
2240
2474
  * @summary Get a single execution result\'s metadata.
@@ -2262,6 +2496,22 @@ export declare const ActionsApiFp: (configuration?: Configuration) => {
2262
2496
  * @export
2263
2497
  */
2264
2498
  export declare const ActionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
2499
+ /**
2500
+ * (EXPERIMENTAL) Computes clusters for data points from the provided execution result and parameters.
2501
+ * @summary (EXPERIMENTAL) Smart functions - Clustering
2502
+ * @param {ActionsApiClusteringRequest} requestParameters Request parameters.
2503
+ * @param {*} [options] Override http request option.
2504
+ * @throws {RequiredError}
2505
+ */
2506
+ clustering(requestParameters: ActionsApiClusteringRequest, options?: AxiosRequestConfig): AxiosPromise<SmartFunctionResponse>;
2507
+ /**
2508
+ * (EXPERIMENTAL) Gets clustering result.
2509
+ * @summary (EXPERIMENTAL) Smart functions - Clustering Result
2510
+ * @param {ActionsApiClusteringResultRequest} requestParameters Request parameters.
2511
+ * @param {*} [options] Override http request option.
2512
+ * @throws {RequiredError}
2513
+ */
2514
+ clusteringResult(requestParameters: ActionsApiClusteringResultRequest, options?: AxiosRequestConfig): AxiosPromise<ClusteringResult>;
2265
2515
  /**
2266
2516
  * Returns paged list of elements (values) of given label satisfying given filtering criteria.
2267
2517
  * @summary Listing of label values. The resulting data are limited by the static platform limit to the maximum of 10000 rows.
@@ -2302,6 +2552,22 @@ export declare const ActionsApiFactory: (configuration?: Configuration, basePath
2302
2552
  * @throws {RequiredError}
2303
2553
  */
2304
2554
  explainAFM(requestParameters: ActionsApiExplainAFMRequest, options?: AxiosRequestConfig): AxiosPromise<any>;
2555
+ /**
2556
+ * (BETA) Computes forecasted data points from the provided execution result and parameters.
2557
+ * @summary (BETA) Smart functions - Forecast
2558
+ * @param {ActionsApiForecastRequest} requestParameters Request parameters.
2559
+ * @param {*} [options] Override http request option.
2560
+ * @throws {RequiredError}
2561
+ */
2562
+ forecast(requestParameters: ActionsApiForecastRequest, options?: AxiosRequestConfig): AxiosPromise<SmartFunctionResponse>;
2563
+ /**
2564
+ * (BETA) Gets forecast result.
2565
+ * @summary (BETA) Smart functions - Forecast Result
2566
+ * @param {ActionsApiForecastResultRequest} requestParameters Request parameters.
2567
+ * @param {*} [options] Override http request option.
2568
+ * @throws {RequiredError}
2569
+ */
2570
+ forecastResult(requestParameters: ActionsApiForecastResultRequest, options?: AxiosRequestConfig): AxiosPromise<ForecastResult>;
2305
2571
  /**
2306
2572
  * The resource provides execution result\'s metadata as AFM and resultSpec used in execution request and an executionResponse
2307
2573
  * @summary Get a single execution result\'s metadata.
@@ -2325,6 +2591,24 @@ export declare const ActionsApiFactory: (configuration?: Configuration, basePath
2325
2591
  * @interface ActionsApi
2326
2592
  */
2327
2593
  export interface ActionsApiInterface {
2594
+ /**
2595
+ * (EXPERIMENTAL) Computes clusters for data points from the provided execution result and parameters.
2596
+ * @summary (EXPERIMENTAL) Smart functions - Clustering
2597
+ * @param {ActionsApiClusteringRequest} requestParameters Request parameters.
2598
+ * @param {*} [options] Override http request option.
2599
+ * @throws {RequiredError}
2600
+ * @memberof ActionsApiInterface
2601
+ */
2602
+ clustering(requestParameters: ActionsApiClusteringRequest, options?: AxiosRequestConfig): AxiosPromise<SmartFunctionResponse>;
2603
+ /**
2604
+ * (EXPERIMENTAL) Gets clustering result.
2605
+ * @summary (EXPERIMENTAL) Smart functions - Clustering Result
2606
+ * @param {ActionsApiClusteringResultRequest} requestParameters Request parameters.
2607
+ * @param {*} [options] Override http request option.
2608
+ * @throws {RequiredError}
2609
+ * @memberof ActionsApiInterface
2610
+ */
2611
+ clusteringResult(requestParameters: ActionsApiClusteringResultRequest, options?: AxiosRequestConfig): AxiosPromise<ClusteringResult>;
2328
2612
  /**
2329
2613
  * Returns paged list of elements (values) of given label satisfying given filtering criteria.
2330
2614
  * @summary Listing of label values. The resulting data are limited by the static platform limit to the maximum of 10000 rows.
@@ -2370,6 +2654,24 @@ export interface ActionsApiInterface {
2370
2654
  * @memberof ActionsApiInterface
2371
2655
  */
2372
2656
  explainAFM(requestParameters: ActionsApiExplainAFMRequest, options?: AxiosRequestConfig): AxiosPromise<any>;
2657
+ /**
2658
+ * (BETA) Computes forecasted data points from the provided execution result and parameters.
2659
+ * @summary (BETA) Smart functions - Forecast
2660
+ * @param {ActionsApiForecastRequest} requestParameters Request parameters.
2661
+ * @param {*} [options] Override http request option.
2662
+ * @throws {RequiredError}
2663
+ * @memberof ActionsApiInterface
2664
+ */
2665
+ forecast(requestParameters: ActionsApiForecastRequest, options?: AxiosRequestConfig): AxiosPromise<SmartFunctionResponse>;
2666
+ /**
2667
+ * (BETA) Gets forecast result.
2668
+ * @summary (BETA) Smart functions - Forecast Result
2669
+ * @param {ActionsApiForecastResultRequest} requestParameters Request parameters.
2670
+ * @param {*} [options] Override http request option.
2671
+ * @throws {RequiredError}
2672
+ * @memberof ActionsApiInterface
2673
+ */
2674
+ forecastResult(requestParameters: ActionsApiForecastResultRequest, options?: AxiosRequestConfig): AxiosPromise<ForecastResult>;
2373
2675
  /**
2374
2676
  * The resource provides execution result\'s metadata as AFM and resultSpec used in execution request and an executionResponse
2375
2677
  * @summary Get a single execution result\'s metadata.
@@ -2389,6 +2691,68 @@ export interface ActionsApiInterface {
2389
2691
  */
2390
2692
  retrieveResult(requestParameters: ActionsApiRetrieveResultRequest, options?: AxiosRequestConfig): AxiosPromise<ExecutionResult>;
2391
2693
  }
2694
+ /**
2695
+ * Request parameters for clustering operation in ActionsApi.
2696
+ * @export
2697
+ * @interface ActionsApiClusteringRequest
2698
+ */
2699
+ export interface ActionsApiClusteringRequest {
2700
+ /**
2701
+ * Workspace identifier
2702
+ * @type {string}
2703
+ * @memberof ActionsApiClustering
2704
+ */
2705
+ readonly workspaceId: string;
2706
+ /**
2707
+ * Input result ID to be used in the computation
2708
+ * @type {string}
2709
+ * @memberof ActionsApiClustering
2710
+ */
2711
+ readonly resultId: string;
2712
+ /**
2713
+ *
2714
+ * @type {ClusteringRequest}
2715
+ * @memberof ActionsApiClustering
2716
+ */
2717
+ readonly clusteringRequest: ClusteringRequest;
2718
+ /**
2719
+ * Ignore all caches during execution of current request.
2720
+ * @type {boolean}
2721
+ * @memberof ActionsApiClustering
2722
+ */
2723
+ readonly skipCache?: boolean;
2724
+ }
2725
+ /**
2726
+ * Request parameters for clusteringResult operation in ActionsApi.
2727
+ * @export
2728
+ * @interface ActionsApiClusteringResultRequest
2729
+ */
2730
+ export interface ActionsApiClusteringResultRequest {
2731
+ /**
2732
+ * Workspace identifier
2733
+ * @type {string}
2734
+ * @memberof ActionsApiClusteringResult
2735
+ */
2736
+ readonly workspaceId: string;
2737
+ /**
2738
+ * Result ID
2739
+ * @type {string}
2740
+ * @memberof ActionsApiClusteringResult
2741
+ */
2742
+ readonly resultId: string;
2743
+ /**
2744
+ *
2745
+ * @type {number}
2746
+ * @memberof ActionsApiClusteringResult
2747
+ */
2748
+ readonly offset?: number;
2749
+ /**
2750
+ *
2751
+ * @type {number}
2752
+ * @memberof ActionsApiClusteringResult
2753
+ */
2754
+ readonly limit?: number;
2755
+ }
2392
2756
  /**
2393
2757
  * Request parameters for computeLabelElementsPost operation in ActionsApi.
2394
2758
  * @export
@@ -2520,6 +2884,68 @@ export interface ActionsApiExplainAFMRequest {
2520
2884
  */
2521
2885
  readonly explainType?: "MAQL" | "GRPC_MODEL" | "GRPC_MODEL_SVG" | "WDF" | "QT" | "QT_SVG" | "OPT_QT" | "OPT_QT_SVG" | "SQL" | "SETTINGS";
2522
2886
  }
2887
+ /**
2888
+ * Request parameters for forecast operation in ActionsApi.
2889
+ * @export
2890
+ * @interface ActionsApiForecastRequest
2891
+ */
2892
+ export interface ActionsApiForecastRequest {
2893
+ /**
2894
+ * Workspace identifier
2895
+ * @type {string}
2896
+ * @memberof ActionsApiForecast
2897
+ */
2898
+ readonly workspaceId: string;
2899
+ /**
2900
+ * Input result ID to be used in the computation
2901
+ * @type {string}
2902
+ * @memberof ActionsApiForecast
2903
+ */
2904
+ readonly resultId: string;
2905
+ /**
2906
+ *
2907
+ * @type {ForecastRequest}
2908
+ * @memberof ActionsApiForecast
2909
+ */
2910
+ readonly forecastRequest: ForecastRequest;
2911
+ /**
2912
+ * Ignore all caches during execution of current request.
2913
+ * @type {boolean}
2914
+ * @memberof ActionsApiForecast
2915
+ */
2916
+ readonly skipCache?: boolean;
2917
+ }
2918
+ /**
2919
+ * Request parameters for forecastResult operation in ActionsApi.
2920
+ * @export
2921
+ * @interface ActionsApiForecastResultRequest
2922
+ */
2923
+ export interface ActionsApiForecastResultRequest {
2924
+ /**
2925
+ * Workspace identifier
2926
+ * @type {string}
2927
+ * @memberof ActionsApiForecastResult
2928
+ */
2929
+ readonly workspaceId: string;
2930
+ /**
2931
+ * Result ID
2932
+ * @type {string}
2933
+ * @memberof ActionsApiForecastResult
2934
+ */
2935
+ readonly resultId: string;
2936
+ /**
2937
+ *
2938
+ * @type {number}
2939
+ * @memberof ActionsApiForecastResult
2940
+ */
2941
+ readonly offset?: number;
2942
+ /**
2943
+ *
2944
+ * @type {number}
2945
+ * @memberof ActionsApiForecastResult
2946
+ */
2947
+ readonly limit?: number;
2948
+ }
2523
2949
  /**
2524
2950
  * Request parameters for retrieveExecutionMetadata operation in ActionsApi.
2525
2951
  * @export
@@ -2583,6 +3009,24 @@ export interface ActionsApiRetrieveResultRequest {
2583
3009
  * @extends {BaseAPI}
2584
3010
  */
2585
3011
  export declare class ActionsApi extends BaseAPI implements ActionsApiInterface {
3012
+ /**
3013
+ * (EXPERIMENTAL) Computes clusters for data points from the provided execution result and parameters.
3014
+ * @summary (EXPERIMENTAL) Smart functions - Clustering
3015
+ * @param {ActionsApiClusteringRequest} requestParameters Request parameters.
3016
+ * @param {*} [options] Override http request option.
3017
+ * @throws {RequiredError}
3018
+ * @memberof ActionsApi
3019
+ */
3020
+ clustering(requestParameters: ActionsApiClusteringRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SmartFunctionResponse, any>>;
3021
+ /**
3022
+ * (EXPERIMENTAL) Gets clustering result.
3023
+ * @summary (EXPERIMENTAL) Smart functions - Clustering Result
3024
+ * @param {ActionsApiClusteringResultRequest} requestParameters Request parameters.
3025
+ * @param {*} [options] Override http request option.
3026
+ * @throws {RequiredError}
3027
+ * @memberof ActionsApi
3028
+ */
3029
+ clusteringResult(requestParameters: ActionsApiClusteringResultRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ClusteringResult, any>>;
2586
3030
  /**
2587
3031
  * Returns paged list of elements (values) of given label satisfying given filtering criteria.
2588
3032
  * @summary Listing of label values. The resulting data are limited by the static platform limit to the maximum of 10000 rows.
@@ -2628,6 +3072,24 @@ export declare class ActionsApi extends BaseAPI implements ActionsApiInterface {
2628
3072
  * @memberof ActionsApi
2629
3073
  */
2630
3074
  explainAFM(requestParameters: ActionsApiExplainAFMRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<any, any>>;
3075
+ /**
3076
+ * (BETA) Computes forecasted data points from the provided execution result and parameters.
3077
+ * @summary (BETA) Smart functions - Forecast
3078
+ * @param {ActionsApiForecastRequest} requestParameters Request parameters.
3079
+ * @param {*} [options] Override http request option.
3080
+ * @throws {RequiredError}
3081
+ * @memberof ActionsApi
3082
+ */
3083
+ forecast(requestParameters: ActionsApiForecastRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SmartFunctionResponse, any>>;
3084
+ /**
3085
+ * (BETA) Gets forecast result.
3086
+ * @summary (BETA) Smart functions - Forecast Result
3087
+ * @param {ActionsApiForecastResultRequest} requestParameters Request parameters.
3088
+ * @param {*} [options] Override http request option.
3089
+ * @throws {RequiredError}
3090
+ * @memberof ActionsApi
3091
+ */
3092
+ forecastResult(requestParameters: ActionsApiForecastResultRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ForecastResult, any>>;
2631
3093
  /**
2632
3094
  * The resource provides execution result\'s metadata as AFM and resultSpec used in execution request and an executionResponse
2633
3095
  * @summary Get a single execution result\'s metadata.
@@ -3193,4 +3655,353 @@ export declare class ComputationApi extends BaseAPI implements ComputationApiInt
3193
3655
  */
3194
3656
  retrieveResult(requestParameters: ComputationApiRetrieveResultRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ExecutionResult, any>>;
3195
3657
  }
3658
+ /**
3659
+ * SmartFunctionsApi - axios parameter creator
3660
+ * @export
3661
+ */
3662
+ export declare const SmartFunctionsApiAxiosParamCreator: (configuration?: Configuration) => {
3663
+ /**
3664
+ * (EXPERIMENTAL) Computes clusters for data points from the provided execution result and parameters.
3665
+ * @summary (EXPERIMENTAL) Smart functions - Clustering
3666
+ * @param {string} workspaceId Workspace identifier
3667
+ * @param {string} resultId Input result ID to be used in the computation
3668
+ * @param {ClusteringRequest} clusteringRequest
3669
+ * @param {boolean} [skipCache] Ignore all caches during execution of current request.
3670
+ * @param {*} [options] Override http request option.
3671
+ * @throws {RequiredError}
3672
+ */
3673
+ clustering: (workspaceId: string, resultId: string, clusteringRequest: ClusteringRequest, skipCache?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3674
+ /**
3675
+ * (EXPERIMENTAL) Gets clustering result.
3676
+ * @summary (EXPERIMENTAL) Smart functions - Clustering Result
3677
+ * @param {string} workspaceId Workspace identifier
3678
+ * @param {string} resultId Result ID
3679
+ * @param {number} [offset]
3680
+ * @param {number} [limit]
3681
+ * @param {*} [options] Override http request option.
3682
+ * @throws {RequiredError}
3683
+ */
3684
+ clusteringResult: (workspaceId: string, resultId: string, offset?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3685
+ /**
3686
+ * (BETA) Computes forecasted data points from the provided execution result and parameters.
3687
+ * @summary (BETA) Smart functions - Forecast
3688
+ * @param {string} workspaceId Workspace identifier
3689
+ * @param {string} resultId Input result ID to be used in the computation
3690
+ * @param {ForecastRequest} forecastRequest
3691
+ * @param {boolean} [skipCache] Ignore all caches during execution of current request.
3692
+ * @param {*} [options] Override http request option.
3693
+ * @throws {RequiredError}
3694
+ */
3695
+ forecast: (workspaceId: string, resultId: string, forecastRequest: ForecastRequest, skipCache?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3696
+ /**
3697
+ * (BETA) Gets forecast result.
3698
+ * @summary (BETA) Smart functions - Forecast Result
3699
+ * @param {string} workspaceId Workspace identifier
3700
+ * @param {string} resultId Result ID
3701
+ * @param {number} [offset]
3702
+ * @param {number} [limit]
3703
+ * @param {*} [options] Override http request option.
3704
+ * @throws {RequiredError}
3705
+ */
3706
+ forecastResult: (workspaceId: string, resultId: string, offset?: number, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3707
+ };
3708
+ /**
3709
+ * SmartFunctionsApi - functional programming interface
3710
+ * @export
3711
+ */
3712
+ export declare const SmartFunctionsApiFp: (configuration?: Configuration) => {
3713
+ /**
3714
+ * (EXPERIMENTAL) Computes clusters for data points from the provided execution result and parameters.
3715
+ * @summary (EXPERIMENTAL) Smart functions - Clustering
3716
+ * @param {string} workspaceId Workspace identifier
3717
+ * @param {string} resultId Input result ID to be used in the computation
3718
+ * @param {ClusteringRequest} clusteringRequest
3719
+ * @param {boolean} [skipCache] Ignore all caches during execution of current request.
3720
+ * @param {*} [options] Override http request option.
3721
+ * @throws {RequiredError}
3722
+ */
3723
+ clustering(workspaceId: string, resultId: string, clusteringRequest: ClusteringRequest, skipCache?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SmartFunctionResponse>>;
3724
+ /**
3725
+ * (EXPERIMENTAL) Gets clustering result.
3726
+ * @summary (EXPERIMENTAL) Smart functions - Clustering Result
3727
+ * @param {string} workspaceId Workspace identifier
3728
+ * @param {string} resultId Result ID
3729
+ * @param {number} [offset]
3730
+ * @param {number} [limit]
3731
+ * @param {*} [options] Override http request option.
3732
+ * @throws {RequiredError}
3733
+ */
3734
+ clusteringResult(workspaceId: string, resultId: string, offset?: number, limit?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ClusteringResult>>;
3735
+ /**
3736
+ * (BETA) Computes forecasted data points from the provided execution result and parameters.
3737
+ * @summary (BETA) Smart functions - Forecast
3738
+ * @param {string} workspaceId Workspace identifier
3739
+ * @param {string} resultId Input result ID to be used in the computation
3740
+ * @param {ForecastRequest} forecastRequest
3741
+ * @param {boolean} [skipCache] Ignore all caches during execution of current request.
3742
+ * @param {*} [options] Override http request option.
3743
+ * @throws {RequiredError}
3744
+ */
3745
+ forecast(workspaceId: string, resultId: string, forecastRequest: ForecastRequest, skipCache?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SmartFunctionResponse>>;
3746
+ /**
3747
+ * (BETA) Gets forecast result.
3748
+ * @summary (BETA) Smart functions - Forecast Result
3749
+ * @param {string} workspaceId Workspace identifier
3750
+ * @param {string} resultId Result ID
3751
+ * @param {number} [offset]
3752
+ * @param {number} [limit]
3753
+ * @param {*} [options] Override http request option.
3754
+ * @throws {RequiredError}
3755
+ */
3756
+ forecastResult(workspaceId: string, resultId: string, offset?: number, limit?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ForecastResult>>;
3757
+ };
3758
+ /**
3759
+ * SmartFunctionsApi - factory interface
3760
+ * @export
3761
+ */
3762
+ export declare const SmartFunctionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
3763
+ /**
3764
+ * (EXPERIMENTAL) Computes clusters for data points from the provided execution result and parameters.
3765
+ * @summary (EXPERIMENTAL) Smart functions - Clustering
3766
+ * @param {SmartFunctionsApiClusteringRequest} requestParameters Request parameters.
3767
+ * @param {*} [options] Override http request option.
3768
+ * @throws {RequiredError}
3769
+ */
3770
+ clustering(requestParameters: SmartFunctionsApiClusteringRequest, options?: AxiosRequestConfig): AxiosPromise<SmartFunctionResponse>;
3771
+ /**
3772
+ * (EXPERIMENTAL) Gets clustering result.
3773
+ * @summary (EXPERIMENTAL) Smart functions - Clustering Result
3774
+ * @param {SmartFunctionsApiClusteringResultRequest} requestParameters Request parameters.
3775
+ * @param {*} [options] Override http request option.
3776
+ * @throws {RequiredError}
3777
+ */
3778
+ clusteringResult(requestParameters: SmartFunctionsApiClusteringResultRequest, options?: AxiosRequestConfig): AxiosPromise<ClusteringResult>;
3779
+ /**
3780
+ * (BETA) Computes forecasted data points from the provided execution result and parameters.
3781
+ * @summary (BETA) Smart functions - Forecast
3782
+ * @param {SmartFunctionsApiForecastRequest} requestParameters Request parameters.
3783
+ * @param {*} [options] Override http request option.
3784
+ * @throws {RequiredError}
3785
+ */
3786
+ forecast(requestParameters: SmartFunctionsApiForecastRequest, options?: AxiosRequestConfig): AxiosPromise<SmartFunctionResponse>;
3787
+ /**
3788
+ * (BETA) Gets forecast result.
3789
+ * @summary (BETA) Smart functions - Forecast Result
3790
+ * @param {SmartFunctionsApiForecastResultRequest} requestParameters Request parameters.
3791
+ * @param {*} [options] Override http request option.
3792
+ * @throws {RequiredError}
3793
+ */
3794
+ forecastResult(requestParameters: SmartFunctionsApiForecastResultRequest, options?: AxiosRequestConfig): AxiosPromise<ForecastResult>;
3795
+ };
3796
+ /**
3797
+ * SmartFunctionsApi - interface
3798
+ * @export
3799
+ * @interface SmartFunctionsApi
3800
+ */
3801
+ export interface SmartFunctionsApiInterface {
3802
+ /**
3803
+ * (EXPERIMENTAL) Computes clusters for data points from the provided execution result and parameters.
3804
+ * @summary (EXPERIMENTAL) Smart functions - Clustering
3805
+ * @param {SmartFunctionsApiClusteringRequest} requestParameters Request parameters.
3806
+ * @param {*} [options] Override http request option.
3807
+ * @throws {RequiredError}
3808
+ * @memberof SmartFunctionsApiInterface
3809
+ */
3810
+ clustering(requestParameters: SmartFunctionsApiClusteringRequest, options?: AxiosRequestConfig): AxiosPromise<SmartFunctionResponse>;
3811
+ /**
3812
+ * (EXPERIMENTAL) Gets clustering result.
3813
+ * @summary (EXPERIMENTAL) Smart functions - Clustering Result
3814
+ * @param {SmartFunctionsApiClusteringResultRequest} requestParameters Request parameters.
3815
+ * @param {*} [options] Override http request option.
3816
+ * @throws {RequiredError}
3817
+ * @memberof SmartFunctionsApiInterface
3818
+ */
3819
+ clusteringResult(requestParameters: SmartFunctionsApiClusteringResultRequest, options?: AxiosRequestConfig): AxiosPromise<ClusteringResult>;
3820
+ /**
3821
+ * (BETA) Computes forecasted data points from the provided execution result and parameters.
3822
+ * @summary (BETA) Smart functions - Forecast
3823
+ * @param {SmartFunctionsApiForecastRequest} requestParameters Request parameters.
3824
+ * @param {*} [options] Override http request option.
3825
+ * @throws {RequiredError}
3826
+ * @memberof SmartFunctionsApiInterface
3827
+ */
3828
+ forecast(requestParameters: SmartFunctionsApiForecastRequest, options?: AxiosRequestConfig): AxiosPromise<SmartFunctionResponse>;
3829
+ /**
3830
+ * (BETA) Gets forecast result.
3831
+ * @summary (BETA) Smart functions - Forecast Result
3832
+ * @param {SmartFunctionsApiForecastResultRequest} requestParameters Request parameters.
3833
+ * @param {*} [options] Override http request option.
3834
+ * @throws {RequiredError}
3835
+ * @memberof SmartFunctionsApiInterface
3836
+ */
3837
+ forecastResult(requestParameters: SmartFunctionsApiForecastResultRequest, options?: AxiosRequestConfig): AxiosPromise<ForecastResult>;
3838
+ }
3839
+ /**
3840
+ * Request parameters for clustering operation in SmartFunctionsApi.
3841
+ * @export
3842
+ * @interface SmartFunctionsApiClusteringRequest
3843
+ */
3844
+ export interface SmartFunctionsApiClusteringRequest {
3845
+ /**
3846
+ * Workspace identifier
3847
+ * @type {string}
3848
+ * @memberof SmartFunctionsApiClustering
3849
+ */
3850
+ readonly workspaceId: string;
3851
+ /**
3852
+ * Input result ID to be used in the computation
3853
+ * @type {string}
3854
+ * @memberof SmartFunctionsApiClustering
3855
+ */
3856
+ readonly resultId: string;
3857
+ /**
3858
+ *
3859
+ * @type {ClusteringRequest}
3860
+ * @memberof SmartFunctionsApiClustering
3861
+ */
3862
+ readonly clusteringRequest: ClusteringRequest;
3863
+ /**
3864
+ * Ignore all caches during execution of current request.
3865
+ * @type {boolean}
3866
+ * @memberof SmartFunctionsApiClustering
3867
+ */
3868
+ readonly skipCache?: boolean;
3869
+ }
3870
+ /**
3871
+ * Request parameters for clusteringResult operation in SmartFunctionsApi.
3872
+ * @export
3873
+ * @interface SmartFunctionsApiClusteringResultRequest
3874
+ */
3875
+ export interface SmartFunctionsApiClusteringResultRequest {
3876
+ /**
3877
+ * Workspace identifier
3878
+ * @type {string}
3879
+ * @memberof SmartFunctionsApiClusteringResult
3880
+ */
3881
+ readonly workspaceId: string;
3882
+ /**
3883
+ * Result ID
3884
+ * @type {string}
3885
+ * @memberof SmartFunctionsApiClusteringResult
3886
+ */
3887
+ readonly resultId: string;
3888
+ /**
3889
+ *
3890
+ * @type {number}
3891
+ * @memberof SmartFunctionsApiClusteringResult
3892
+ */
3893
+ readonly offset?: number;
3894
+ /**
3895
+ *
3896
+ * @type {number}
3897
+ * @memberof SmartFunctionsApiClusteringResult
3898
+ */
3899
+ readonly limit?: number;
3900
+ }
3901
+ /**
3902
+ * Request parameters for forecast operation in SmartFunctionsApi.
3903
+ * @export
3904
+ * @interface SmartFunctionsApiForecastRequest
3905
+ */
3906
+ export interface SmartFunctionsApiForecastRequest {
3907
+ /**
3908
+ * Workspace identifier
3909
+ * @type {string}
3910
+ * @memberof SmartFunctionsApiForecast
3911
+ */
3912
+ readonly workspaceId: string;
3913
+ /**
3914
+ * Input result ID to be used in the computation
3915
+ * @type {string}
3916
+ * @memberof SmartFunctionsApiForecast
3917
+ */
3918
+ readonly resultId: string;
3919
+ /**
3920
+ *
3921
+ * @type {ForecastRequest}
3922
+ * @memberof SmartFunctionsApiForecast
3923
+ */
3924
+ readonly forecastRequest: ForecastRequest;
3925
+ /**
3926
+ * Ignore all caches during execution of current request.
3927
+ * @type {boolean}
3928
+ * @memberof SmartFunctionsApiForecast
3929
+ */
3930
+ readonly skipCache?: boolean;
3931
+ }
3932
+ /**
3933
+ * Request parameters for forecastResult operation in SmartFunctionsApi.
3934
+ * @export
3935
+ * @interface SmartFunctionsApiForecastResultRequest
3936
+ */
3937
+ export interface SmartFunctionsApiForecastResultRequest {
3938
+ /**
3939
+ * Workspace identifier
3940
+ * @type {string}
3941
+ * @memberof SmartFunctionsApiForecastResult
3942
+ */
3943
+ readonly workspaceId: string;
3944
+ /**
3945
+ * Result ID
3946
+ * @type {string}
3947
+ * @memberof SmartFunctionsApiForecastResult
3948
+ */
3949
+ readonly resultId: string;
3950
+ /**
3951
+ *
3952
+ * @type {number}
3953
+ * @memberof SmartFunctionsApiForecastResult
3954
+ */
3955
+ readonly offset?: number;
3956
+ /**
3957
+ *
3958
+ * @type {number}
3959
+ * @memberof SmartFunctionsApiForecastResult
3960
+ */
3961
+ readonly limit?: number;
3962
+ }
3963
+ /**
3964
+ * SmartFunctionsApi - object-oriented interface
3965
+ * @export
3966
+ * @class SmartFunctionsApi
3967
+ * @extends {BaseAPI}
3968
+ */
3969
+ export declare class SmartFunctionsApi extends BaseAPI implements SmartFunctionsApiInterface {
3970
+ /**
3971
+ * (EXPERIMENTAL) Computes clusters for data points from the provided execution result and parameters.
3972
+ * @summary (EXPERIMENTAL) Smart functions - Clustering
3973
+ * @param {SmartFunctionsApiClusteringRequest} requestParameters Request parameters.
3974
+ * @param {*} [options] Override http request option.
3975
+ * @throws {RequiredError}
3976
+ * @memberof SmartFunctionsApi
3977
+ */
3978
+ clustering(requestParameters: SmartFunctionsApiClusteringRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SmartFunctionResponse, any>>;
3979
+ /**
3980
+ * (EXPERIMENTAL) Gets clustering result.
3981
+ * @summary (EXPERIMENTAL) Smart functions - Clustering Result
3982
+ * @param {SmartFunctionsApiClusteringResultRequest} requestParameters Request parameters.
3983
+ * @param {*} [options] Override http request option.
3984
+ * @throws {RequiredError}
3985
+ * @memberof SmartFunctionsApi
3986
+ */
3987
+ clusteringResult(requestParameters: SmartFunctionsApiClusteringResultRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ClusteringResult, any>>;
3988
+ /**
3989
+ * (BETA) Computes forecasted data points from the provided execution result and parameters.
3990
+ * @summary (BETA) Smart functions - Forecast
3991
+ * @param {SmartFunctionsApiForecastRequest} requestParameters Request parameters.
3992
+ * @param {*} [options] Override http request option.
3993
+ * @throws {RequiredError}
3994
+ * @memberof SmartFunctionsApi
3995
+ */
3996
+ forecast(requestParameters: SmartFunctionsApiForecastRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SmartFunctionResponse, any>>;
3997
+ /**
3998
+ * (BETA) Gets forecast result.
3999
+ * @summary (BETA) Smart functions - Forecast Result
4000
+ * @param {SmartFunctionsApiForecastResultRequest} requestParameters Request parameters.
4001
+ * @param {*} [options] Override http request option.
4002
+ * @throws {RequiredError}
4003
+ * @memberof SmartFunctionsApi
4004
+ */
4005
+ forecastResult(requestParameters: SmartFunctionsApiForecastResultRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ForecastResult, any>>;
4006
+ }
3196
4007
  //# sourceMappingURL=api.d.ts.map