@gooddata/api-client-tiger 11.67.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.d.ts.map +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
|
@@ -2915,7 +2915,7 @@ export async function ActionsApiAxiosParamCreator_ExecuteFlow(workspaceId, flowR
|
|
|
2915
2915
|
* @summary AFM explain resource.
|
|
2916
2916
|
* @param {string} workspaceId Workspace identifier
|
|
2917
2917
|
* @param {AfmExecution} afmExecution
|
|
2918
|
-
* @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
|
|
2918
|
+
* @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
|
|
2919
2919
|
* @param {*} [options] Override http request option.
|
|
2920
2920
|
* @param {Configuration} [configuration] Optional configuration.
|
|
2921
2921
|
* @throws {RequiredError}
|
|
@@ -5937,7 +5937,7 @@ export async function ComputationApiAxiosParamCreator_ComputeValidObjects(worksp
|
|
|
5937
5937
|
* @summary AFM explain resource.
|
|
5938
5938
|
* @param {string} workspaceId Workspace identifier
|
|
5939
5939
|
* @param {AfmExecution} afmExecution
|
|
5940
|
-
* @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
|
|
5940
|
+
* @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
|
|
5941
5941
|
* @param {*} [options] Override http request option.
|
|
5942
5942
|
* @param {Configuration} [configuration] Optional configuration.
|
|
5943
5943
|
* @throws {RequiredError}
|
|
@@ -652,6 +652,39 @@ export interface AiChartFill {
|
|
|
652
652
|
} | null;
|
|
653
653
|
'type'?: AiType67 | null;
|
|
654
654
|
}
|
|
655
|
+
export interface AiClarifyingAnswer {
|
|
656
|
+
'answer': AiSingleChoiceAnswer;
|
|
657
|
+
/**
|
|
658
|
+
* Position of the question on the questions item, from zero.
|
|
659
|
+
*/
|
|
660
|
+
'questionIndex': number;
|
|
661
|
+
/**
|
|
662
|
+
* The question, as stored on the questions item.
|
|
663
|
+
*/
|
|
664
|
+
'questionText': string;
|
|
665
|
+
}
|
|
666
|
+
/**
|
|
667
|
+
* A user\'s answers to the clarifying questions on item ``questionsItemId``. A question with no entry in ``answers`` is a skipped question. An empty list means the user skipped every question. Data obfuscation can mask the question and option text.
|
|
668
|
+
*/
|
|
669
|
+
export interface AiClarifyingAnswersContent {
|
|
670
|
+
/**
|
|
671
|
+
* One entry per answered question.
|
|
672
|
+
*/
|
|
673
|
+
'answers': Array<AiClarifyingAnswer>;
|
|
674
|
+
/**
|
|
675
|
+
* Item ID of the assistant item that asked the questions.
|
|
676
|
+
*/
|
|
677
|
+
'questionsItemId': string;
|
|
678
|
+
/**
|
|
679
|
+
* The answers as the plain text the model read.
|
|
680
|
+
*/
|
|
681
|
+
'text': string;
|
|
682
|
+
/**
|
|
683
|
+
* Type of item content.
|
|
684
|
+
*/
|
|
685
|
+
'type'?: AiClarifyingAnswersContentTypeEnum;
|
|
686
|
+
}
|
|
687
|
+
export type AiClarifyingAnswersContentTypeEnum = 'clarifyingAnswers';
|
|
655
688
|
export interface AiClarifyingChoiceOption {
|
|
656
689
|
/**
|
|
657
690
|
* The answer itself, rendered as the option and submitted verbatim, e.g. `Net Sales`.
|
|
@@ -1014,6 +1047,8 @@ export interface AiConfig {
|
|
|
1014
1047
|
* Conversation item content payload.
|
|
1015
1048
|
*/
|
|
1016
1049
|
export type AiContent = ({
|
|
1050
|
+
type: 'clarifyingAnswers';
|
|
1051
|
+
} & AiClarifyingAnswersContent) | ({
|
|
1017
1052
|
type: 'multipart';
|
|
1018
1053
|
} & AiMultipartContent) | ({
|
|
1019
1054
|
type: 'reasoning';
|
|
@@ -2487,6 +2522,7 @@ export declare const AiObjectType: {
|
|
|
2487
2522
|
readonly ATTRIBUTE: 'attribute';
|
|
2488
2523
|
readonly DATE_ATTRIBUTE: 'date_attribute';
|
|
2489
2524
|
readonly LABEL: 'label';
|
|
2525
|
+
readonly COMPUTED_ATTRIBUTE: 'computed_attribute';
|
|
2490
2526
|
readonly VISUALIZATION: 'visualization';
|
|
2491
2527
|
readonly DASHBOARD: 'dashboard';
|
|
2492
2528
|
readonly FILTER_CONTEXT: 'filter_context';
|
|
@@ -3843,6 +3879,21 @@ export declare const AiShapeType: {
|
|
|
3843
3879
|
export type AiShapeType = typeof AiShapeType[keyof typeof AiShapeType];
|
|
3844
3880
|
export interface AiSimpleColorItem {
|
|
3845
3881
|
}
|
|
3882
|
+
export interface AiSingleChoiceAnswer {
|
|
3883
|
+
/**
|
|
3884
|
+
* Position of the picked option in the question\'s `control.options`, from zero.
|
|
3885
|
+
*/
|
|
3886
|
+
'optionIndex': number;
|
|
3887
|
+
/**
|
|
3888
|
+
* The picked option, as stored on the questions item.
|
|
3889
|
+
*/
|
|
3890
|
+
'optionText': string;
|
|
3891
|
+
/**
|
|
3892
|
+
* Type of answer.
|
|
3893
|
+
*/
|
|
3894
|
+
'type': AiSingleChoiceAnswerTypeEnum;
|
|
3895
|
+
}
|
|
3896
|
+
export type AiSingleChoiceAnswerTypeEnum = 'singleChoice';
|
|
3846
3897
|
/**
|
|
3847
3898
|
* Pick exactly one option — radio buttons, or rows that submit on click. The only control there is for now; a later one (multiple choice, a date range, a catalog object picker) becomes another member of ``ClarifyingQuestionControl`` without changing any payload a client has already seen.
|
|
3848
3899
|
*/
|