@gooddata/api-client-tiger 11.68.0-alpha.0 → 11.68.0-alpha.1
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.
- package/esm/__version.d.ts +1 -1
- package/esm/__version.js +1 -1
- package/esm/api-client-tiger.d.ts +2170 -84
- package/esm/generated/afm-rest-api/api.d.ts +35 -14
- package/esm/generated/afm-rest-api/api.d.ts.map +1 -1
- package/esm/generated/afm-rest-api/api.js +2 -2
- package/esm/generated/ai-json-api/api.d.ts +51 -0
- package/esm/generated/ai-json-api/api.d.ts.map +1 -1
- package/esm/generated/ai-json-api/api.js +1 -0
- package/esm/generated/metadata-json-api/api.d.ts +1953 -127
- package/esm/generated/metadata-json-api/api.d.ts.map +1 -1
- package/esm/generated/metadata-json-api/api.js +201 -49
- package/esm/generated/scan-json-api/api.d.ts +6 -0
- package/esm/generated/scan-json-api/api.d.ts.map +1 -1
- package/esm/index.d.ts +1 -1
- package/esm/index.d.ts.map +1 -1
- package/package.json +4 -4
|
@@ -397,7 +397,7 @@ export interface AttributeHeaderAttributeHeader {
|
|
|
397
397
|
*/
|
|
398
398
|
'localIdentifier': string;
|
|
399
399
|
/**
|
|
400
|
-
* Format to be used to format the attribute values, the same kind of format string as the measure format. Only filled for computed attributes with a format.
|
|
400
|
+
* Format to be used to format the attribute values, the same kind of format string as the measure format. Only filled for computed attributes with a format and INT or NUMERIC data type.
|
|
401
401
|
*/
|
|
402
402
|
'numberFormat'?: string;
|
|
403
403
|
'primaryLabel': RestApiIdentifier;
|
|
@@ -564,6 +564,10 @@ export interface ChangeAnalysisResult {
|
|
|
564
564
|
* The change analysis result data containing significant changes.
|
|
565
565
|
*/
|
|
566
566
|
'data': Array<MetricValueChange>;
|
|
567
|
+
/**
|
|
568
|
+
* Number of attributes and computed attributes left out of the analysis because the user has no access to them.
|
|
569
|
+
*/
|
|
570
|
+
'restrictedCount': number;
|
|
567
571
|
}
|
|
568
572
|
export interface ClusteringRequest {
|
|
569
573
|
/**
|
|
@@ -693,9 +697,13 @@ export interface DatabaseInstance {
|
|
|
693
697
|
*/
|
|
694
698
|
'name': string;
|
|
695
699
|
/**
|
|
696
|
-
* Set of
|
|
700
|
+
* Set of names of the storage instances this database instance accesses. Kept for backward compatibility; use `storages` for the storage ids.
|
|
697
701
|
*/
|
|
698
702
|
'storageIds': Array<string>;
|
|
703
|
+
/**
|
|
704
|
+
* Storage instances this database instance accesses.
|
|
705
|
+
*/
|
|
706
|
+
'storages': Array<ObjectStorageRef>;
|
|
699
707
|
}
|
|
700
708
|
/**
|
|
701
709
|
* @type DateFilter
|
|
@@ -855,7 +863,7 @@ export interface ElementsResponse {
|
|
|
855
863
|
*/
|
|
856
864
|
'granularity'?: ElementsResponseGranularityEnum;
|
|
857
865
|
/**
|
|
858
|
-
* Format to be used to format the element values, the same kind of format string as the measure format. Only filled for computed attributes with a format.
|
|
866
|
+
* Format to be used to format the element values, the same kind of format string as the measure format. Only filled for computed attributes with a format and INT or NUMERIC data type.
|
|
859
867
|
*/
|
|
860
868
|
'numberFormat'?: string;
|
|
861
869
|
'paging': Paging;
|
|
@@ -1820,6 +1828,19 @@ export interface ObjectStorageInfo {
|
|
|
1820
1828
|
*/
|
|
1821
1829
|
'storageType': string;
|
|
1822
1830
|
}
|
|
1831
|
+
/**
|
|
1832
|
+
* Reference to a registered ObjectStorage.
|
|
1833
|
+
*/
|
|
1834
|
+
export interface ObjectStorageRef {
|
|
1835
|
+
/**
|
|
1836
|
+
* Human-readable name of the storage.
|
|
1837
|
+
*/
|
|
1838
|
+
'name': string;
|
|
1839
|
+
/**
|
|
1840
|
+
* Stable identifier of the storage, as returned by the ObjectStorages listing.
|
|
1841
|
+
*/
|
|
1842
|
+
'storageId': string;
|
|
1843
|
+
}
|
|
1823
1844
|
/**
|
|
1824
1845
|
* Configuration for OpenAI provider.
|
|
1825
1846
|
*/
|
|
@@ -2044,7 +2065,7 @@ export interface ProvisionDatabaseInstanceRequest {
|
|
|
2044
2065
|
*/
|
|
2045
2066
|
'name': string;
|
|
2046
2067
|
/**
|
|
2047
|
-
* Set of ids of the storage instances this database instance should access.
|
|
2068
|
+
* Set of ids of the storage instances this database instance should access. Each entry is a `storageId` from the ObjectStorages listing or, for backward compatibility, a storage name. Must contain exactly one entry.
|
|
2048
2069
|
*/
|
|
2049
2070
|
'storageIds': Array<string>;
|
|
2050
2071
|
}
|
|
@@ -4578,12 +4599,12 @@ export declare function ActionsApiAxiosParamCreator_ExecuteFlow(workspaceId: str
|
|
|
4578
4599
|
* @summary AFM explain resource.
|
|
4579
4600
|
* @param {string} workspaceId Workspace identifier
|
|
4580
4601
|
* @param {AfmExecution} afmExecution
|
|
4581
|
-
* @param {'MAQL' | 'GRPC_MODEL' | 'GRPC_MODEL_SVG' | 'WDF' | 'QT' | 'QT_SVG' | 'OPT_QT' | 'OPT_QT_SVG' | 'SQL' | 'SETTINGS' | 'COMPRESSED_SQL' | 'COMPRESSED_GRPC_MODEL_SVG' | 'GIT'} [explainType] Requested explain type. If not specified all types are bundled in a ZIP archive. `MAQL` - MAQL Abstract Syntax Tree, execution dimensions and related info `GRPC_MODEL` - Datasets used in execution `GRPC_MODEL_SVG` - Generated SVG image of the datasets `COMPRESSED_GRPC_MODEL_SVG` - Generated SVG image of the model fragment used in the query `WDF` - Workspace data filters in execution workspace context `QT` - Query Tree, created from MAQL AST using Logical Data Model, contains all information needed to generate SQL `QT_SVG` - Generated SVG image of the Query Tree `OPT_QT` - Optimized Query Tree `OPT_QT_SVG` - Generated SVG image of the Optimized Query Tree `SQL` - Final SQL to be executed `COMPRESSED_SQL` - Final SQL to be executed with rolled SQL datasets `SETTINGS` - Settings used to execute explain request `GIT` - Git properties of current build
|
|
4602
|
+
* @param {'MAQL' | 'GRPC_MODEL' | 'MODEL_STATISTICS' | 'GRPC_MODEL_SVG' | 'WDF' | 'QT' | 'QT_SVG' | 'OPT_QT' | 'OPT_QT_SVG' | 'SQL' | 'SETTINGS' | 'COMPRESSED_SQL' | 'COMPRESSED_GRPC_MODEL_SVG' | 'GIT'} [explainType] Requested explain type. If not specified all types are bundled in a ZIP archive. `MAQL` - MAQL Abstract Syntax Tree, execution dimensions and related info `GRPC_MODEL` - Datasets used in execution `MODEL_STATISTICS` - Physical table statistics of the datasets used in execution `GRPC_MODEL_SVG` - Generated SVG image of the datasets `COMPRESSED_GRPC_MODEL_SVG` - Generated SVG image of the model fragment used in the query `WDF` - Workspace data filters in execution workspace context `QT` - Query Tree, created from MAQL AST using Logical Data Model, contains all information needed to generate SQL `QT_SVG` - Generated SVG image of the Query Tree `OPT_QT` - Optimized Query Tree `OPT_QT_SVG` - Generated SVG image of the Optimized Query Tree `SQL` - Final SQL to be executed `COMPRESSED_SQL` - Final SQL to be executed with rolled SQL datasets `SETTINGS` - Settings used to execute explain request `GIT` - Git properties of current build
|
|
4582
4603
|
* @param {*} [options] Override http request option.
|
|
4583
4604
|
* @param {Configuration} [configuration] Optional configuration.
|
|
4584
4605
|
* @throws {RequiredError}
|
|
4585
4606
|
*/
|
|
4586
|
-
export declare function ActionsApiAxiosParamCreator_ExplainAFM(workspaceId: string, afmExecution: AfmExecution, explainType?: 'MAQL' | 'GRPC_MODEL' | 'GRPC_MODEL_SVG' | 'WDF' | 'QT' | 'QT_SVG' | 'OPT_QT' | 'OPT_QT_SVG' | 'SQL' | 'SETTINGS' | 'COMPRESSED_SQL' | 'COMPRESSED_GRPC_MODEL_SVG' | 'GIT', options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
4607
|
+
export declare function ActionsApiAxiosParamCreator_ExplainAFM(workspaceId: string, afmExecution: AfmExecution, explainType?: 'MAQL' | 'GRPC_MODEL' | 'MODEL_STATISTICS' | 'GRPC_MODEL_SVG' | 'WDF' | 'QT' | 'QT_SVG' | 'OPT_QT' | 'OPT_QT_SVG' | 'SQL' | 'SETTINGS' | 'COMPRESSED_SQL' | 'COMPRESSED_GRPC_MODEL_SVG' | 'GIT', options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
4587
4608
|
/**
|
|
4588
4609
|
* Computes forecasted data points from the provided execution result and parameters.
|
|
4589
4610
|
* @summary Smart functions - Forecast
|
|
@@ -6321,11 +6342,11 @@ export interface ActionsApiExplainAFMRequest {
|
|
|
6321
6342
|
*/
|
|
6322
6343
|
readonly afmExecution: AfmExecution;
|
|
6323
6344
|
/**
|
|
6324
|
-
* Requested explain type. If not specified all types are bundled in a ZIP archive. `MAQL` - MAQL Abstract Syntax Tree, execution dimensions and related info `GRPC_MODEL` - Datasets used in execution `GRPC_MODEL_SVG` - Generated SVG image of the datasets `COMPRESSED_GRPC_MODEL_SVG` - Generated SVG image of the model fragment used in the query `WDF` - Workspace data filters in execution workspace context `QT` - Query Tree, created from MAQL AST using Logical Data Model, contains all information needed to generate SQL `QT_SVG` - Generated SVG image of the Query Tree `OPT_QT` - Optimized Query Tree `OPT_QT_SVG` - Generated SVG image of the Optimized Query Tree `SQL` - Final SQL to be executed `COMPRESSED_SQL` - Final SQL to be executed with rolled SQL datasets `SETTINGS` - Settings used to execute explain request `GIT` - Git properties of current build
|
|
6325
|
-
* @type {'MAQL' | 'GRPC_MODEL' | 'GRPC_MODEL_SVG' | 'WDF' | 'QT' | 'QT_SVG' | 'OPT_QT' | 'OPT_QT_SVG' | 'SQL' | 'SETTINGS' | 'COMPRESSED_SQL' | 'COMPRESSED_GRPC_MODEL_SVG' | 'GIT'}
|
|
6345
|
+
* Requested explain type. If not specified all types are bundled in a ZIP archive. `MAQL` - MAQL Abstract Syntax Tree, execution dimensions and related info `GRPC_MODEL` - Datasets used in execution `MODEL_STATISTICS` - Physical table statistics of the datasets used in execution `GRPC_MODEL_SVG` - Generated SVG image of the datasets `COMPRESSED_GRPC_MODEL_SVG` - Generated SVG image of the model fragment used in the query `WDF` - Workspace data filters in execution workspace context `QT` - Query Tree, created from MAQL AST using Logical Data Model, contains all information needed to generate SQL `QT_SVG` - Generated SVG image of the Query Tree `OPT_QT` - Optimized Query Tree `OPT_QT_SVG` - Generated SVG image of the Optimized Query Tree `SQL` - Final SQL to be executed `COMPRESSED_SQL` - Final SQL to be executed with rolled SQL datasets `SETTINGS` - Settings used to execute explain request `GIT` - Git properties of current build
|
|
6346
|
+
* @type {'MAQL' | 'GRPC_MODEL' | 'MODEL_STATISTICS' | 'GRPC_MODEL_SVG' | 'WDF' | 'QT' | 'QT_SVG' | 'OPT_QT' | 'OPT_QT_SVG' | 'SQL' | 'SETTINGS' | 'COMPRESSED_SQL' | 'COMPRESSED_GRPC_MODEL_SVG' | 'GIT'}
|
|
6326
6347
|
* @memberof ActionsApiExplainAFM
|
|
6327
6348
|
*/
|
|
6328
|
-
readonly explainType?: 'MAQL' | 'GRPC_MODEL' | 'GRPC_MODEL_SVG' | 'WDF' | 'QT' | 'QT_SVG' | 'OPT_QT' | 'OPT_QT_SVG' | 'SQL' | 'SETTINGS' | 'COMPRESSED_SQL' | 'COMPRESSED_GRPC_MODEL_SVG' | 'GIT';
|
|
6349
|
+
readonly explainType?: 'MAQL' | 'GRPC_MODEL' | 'MODEL_STATISTICS' | 'GRPC_MODEL_SVG' | 'WDF' | 'QT' | 'QT_SVG' | 'OPT_QT' | 'OPT_QT_SVG' | 'SQL' | 'SETTINGS' | 'COMPRESSED_SQL' | 'COMPRESSED_GRPC_MODEL_SVG' | 'GIT';
|
|
6329
6350
|
}
|
|
6330
6351
|
/**
|
|
6331
6352
|
* Request parameters for forecast operation in ActionsApi.
|
|
@@ -7485,12 +7506,12 @@ export declare function ComputationApiAxiosParamCreator_ComputeValidObjects(work
|
|
|
7485
7506
|
* @summary AFM explain resource.
|
|
7486
7507
|
* @param {string} workspaceId Workspace identifier
|
|
7487
7508
|
* @param {AfmExecution} afmExecution
|
|
7488
|
-
* @param {'MAQL' | 'GRPC_MODEL' | 'GRPC_MODEL_SVG' | 'WDF' | 'QT' | 'QT_SVG' | 'OPT_QT' | 'OPT_QT_SVG' | 'SQL' | 'SETTINGS' | 'COMPRESSED_SQL' | 'COMPRESSED_GRPC_MODEL_SVG' | 'GIT'} [explainType] Requested explain type. If not specified all types are bundled in a ZIP archive. `MAQL` - MAQL Abstract Syntax Tree, execution dimensions and related info `GRPC_MODEL` - Datasets used in execution `GRPC_MODEL_SVG` - Generated SVG image of the datasets `COMPRESSED_GRPC_MODEL_SVG` - Generated SVG image of the model fragment used in the query `WDF` - Workspace data filters in execution workspace context `QT` - Query Tree, created from MAQL AST using Logical Data Model, contains all information needed to generate SQL `QT_SVG` - Generated SVG image of the Query Tree `OPT_QT` - Optimized Query Tree `OPT_QT_SVG` - Generated SVG image of the Optimized Query Tree `SQL` - Final SQL to be executed `COMPRESSED_SQL` - Final SQL to be executed with rolled SQL datasets `SETTINGS` - Settings used to execute explain request `GIT` - Git properties of current build
|
|
7509
|
+
* @param {'MAQL' | 'GRPC_MODEL' | 'MODEL_STATISTICS' | 'GRPC_MODEL_SVG' | 'WDF' | 'QT' | 'QT_SVG' | 'OPT_QT' | 'OPT_QT_SVG' | 'SQL' | 'SETTINGS' | 'COMPRESSED_SQL' | 'COMPRESSED_GRPC_MODEL_SVG' | 'GIT'} [explainType] Requested explain type. If not specified all types are bundled in a ZIP archive. `MAQL` - MAQL Abstract Syntax Tree, execution dimensions and related info `GRPC_MODEL` - Datasets used in execution `MODEL_STATISTICS` - Physical table statistics of the datasets used in execution `GRPC_MODEL_SVG` - Generated SVG image of the datasets `COMPRESSED_GRPC_MODEL_SVG` - Generated SVG image of the model fragment used in the query `WDF` - Workspace data filters in execution workspace context `QT` - Query Tree, created from MAQL AST using Logical Data Model, contains all information needed to generate SQL `QT_SVG` - Generated SVG image of the Query Tree `OPT_QT` - Optimized Query Tree `OPT_QT_SVG` - Generated SVG image of the Optimized Query Tree `SQL` - Final SQL to be executed `COMPRESSED_SQL` - Final SQL to be executed with rolled SQL datasets `SETTINGS` - Settings used to execute explain request `GIT` - Git properties of current build
|
|
7489
7510
|
* @param {*} [options] Override http request option.
|
|
7490
7511
|
* @param {Configuration} [configuration] Optional configuration.
|
|
7491
7512
|
* @throws {RequiredError}
|
|
7492
7513
|
*/
|
|
7493
|
-
export declare function ComputationApiAxiosParamCreator_ExplainAFM(workspaceId: string, afmExecution: AfmExecution, explainType?: 'MAQL' | 'GRPC_MODEL' | 'GRPC_MODEL_SVG' | 'WDF' | 'QT' | 'QT_SVG' | 'OPT_QT' | 'OPT_QT_SVG' | 'SQL' | 'SETTINGS' | 'COMPRESSED_SQL' | 'COMPRESSED_GRPC_MODEL_SVG' | 'GIT', options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
7514
|
+
export declare function ComputationApiAxiosParamCreator_ExplainAFM(workspaceId: string, afmExecution: AfmExecution, explainType?: 'MAQL' | 'GRPC_MODEL' | 'MODEL_STATISTICS' | 'GRPC_MODEL_SVG' | 'WDF' | 'QT' | 'QT_SVG' | 'OPT_QT' | 'OPT_QT_SVG' | 'SQL' | 'SETTINGS' | 'COMPRESSED_SQL' | 'COMPRESSED_GRPC_MODEL_SVG' | 'GIT', options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
7494
7515
|
/**
|
|
7495
7516
|
* (EXPERIMENTAL) Computes key driver analysis for the provided execution definition.
|
|
7496
7517
|
* @summary (EXPERIMENTAL) Compute key driver analysis
|
|
@@ -8112,11 +8133,11 @@ export interface ComputationApiExplainAFMRequest {
|
|
|
8112
8133
|
*/
|
|
8113
8134
|
readonly afmExecution: AfmExecution;
|
|
8114
8135
|
/**
|
|
8115
|
-
* Requested explain type. If not specified all types are bundled in a ZIP archive. `MAQL` - MAQL Abstract Syntax Tree, execution dimensions and related info `GRPC_MODEL` - Datasets used in execution `GRPC_MODEL_SVG` - Generated SVG image of the datasets `COMPRESSED_GRPC_MODEL_SVG` - Generated SVG image of the model fragment used in the query `WDF` - Workspace data filters in execution workspace context `QT` - Query Tree, created from MAQL AST using Logical Data Model, contains all information needed to generate SQL `QT_SVG` - Generated SVG image of the Query Tree `OPT_QT` - Optimized Query Tree `OPT_QT_SVG` - Generated SVG image of the Optimized Query Tree `SQL` - Final SQL to be executed `COMPRESSED_SQL` - Final SQL to be executed with rolled SQL datasets `SETTINGS` - Settings used to execute explain request `GIT` - Git properties of current build
|
|
8116
|
-
* @type {'MAQL' | 'GRPC_MODEL' | 'GRPC_MODEL_SVG' | 'WDF' | 'QT' | 'QT_SVG' | 'OPT_QT' | 'OPT_QT_SVG' | 'SQL' | 'SETTINGS' | 'COMPRESSED_SQL' | 'COMPRESSED_GRPC_MODEL_SVG' | 'GIT'}
|
|
8136
|
+
* Requested explain type. If not specified all types are bundled in a ZIP archive. `MAQL` - MAQL Abstract Syntax Tree, execution dimensions and related info `GRPC_MODEL` - Datasets used in execution `MODEL_STATISTICS` - Physical table statistics of the datasets used in execution `GRPC_MODEL_SVG` - Generated SVG image of the datasets `COMPRESSED_GRPC_MODEL_SVG` - Generated SVG image of the model fragment used in the query `WDF` - Workspace data filters in execution workspace context `QT` - Query Tree, created from MAQL AST using Logical Data Model, contains all information needed to generate SQL `QT_SVG` - Generated SVG image of the Query Tree `OPT_QT` - Optimized Query Tree `OPT_QT_SVG` - Generated SVG image of the Optimized Query Tree `SQL` - Final SQL to be executed `COMPRESSED_SQL` - Final SQL to be executed with rolled SQL datasets `SETTINGS` - Settings used to execute explain request `GIT` - Git properties of current build
|
|
8137
|
+
* @type {'MAQL' | 'GRPC_MODEL' | 'MODEL_STATISTICS' | 'GRPC_MODEL_SVG' | 'WDF' | 'QT' | 'QT_SVG' | 'OPT_QT' | 'OPT_QT_SVG' | 'SQL' | 'SETTINGS' | 'COMPRESSED_SQL' | 'COMPRESSED_GRPC_MODEL_SVG' | 'GIT'}
|
|
8117
8138
|
* @memberof ComputationApiExplainAFM
|
|
8118
8139
|
*/
|
|
8119
|
-
readonly explainType?: 'MAQL' | 'GRPC_MODEL' | 'GRPC_MODEL_SVG' | 'WDF' | 'QT' | 'QT_SVG' | 'OPT_QT' | 'OPT_QT_SVG' | 'SQL' | 'SETTINGS' | 'COMPRESSED_SQL' | 'COMPRESSED_GRPC_MODEL_SVG' | 'GIT';
|
|
8140
|
+
readonly explainType?: 'MAQL' | 'GRPC_MODEL' | 'MODEL_STATISTICS' | 'GRPC_MODEL_SVG' | 'WDF' | 'QT' | 'QT_SVG' | 'OPT_QT' | 'OPT_QT_SVG' | 'SQL' | 'SETTINGS' | 'COMPRESSED_SQL' | 'COMPRESSED_GRPC_MODEL_SVG' | 'GIT';
|
|
8120
8141
|
}
|
|
8121
8142
|
/**
|
|
8122
8143
|
* Request parameters for keyDriverAnalysis operation in ComputationApi.
|