@gooddata/api-client-tiger 11.58.0-alpha.5 → 11.58.0
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 +436 -0
- package/esm/endpoints/export/index.d.ts +1 -1
- package/esm/endpoints/export/index.d.ts.map +1 -1
- package/esm/endpoints/export/index.js +1 -1
- package/esm/generated/export-json-api/api.d.ts +413 -0
- package/esm/generated/export-json-api/api.d.ts.map +1 -1
- package/esm/generated/export-json-api/api.js +428 -0
- package/package.json +4 -4
|
@@ -217,6 +217,60 @@ export async function ActionsExportAxiosParamCreator_CreateRawExport(workspaceId
|
|
|
217
217
|
};
|
|
218
218
|
}
|
|
219
219
|
// ActionsExport FP - ActionsExportAxiosParamCreator
|
|
220
|
+
/**
|
|
221
|
+
* Note: This API is an experimental and is going to change. Please, use it accordingly. A report export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
|
|
222
|
+
* @summary (EXPERIMENTAL) Create report export request
|
|
223
|
+
* @param {string} workspaceId
|
|
224
|
+
* @param {ExportReportExportRequest} exportReportExportRequest
|
|
225
|
+
* @param {boolean} [xGdcDebug]
|
|
226
|
+
* @param {*} [options] Override http request option.
|
|
227
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
228
|
+
* @throws {RequiredError}
|
|
229
|
+
*/
|
|
230
|
+
export async function ActionsExportAxiosParamCreator_CreateReportExport(workspaceId, exportReportExportRequest, xGdcDebug, options = {}, configuration) {
|
|
231
|
+
// verify required parameter 'workspaceId' is not null or undefined
|
|
232
|
+
assertParamExists('createReportExport', 'workspaceId', workspaceId);
|
|
233
|
+
// verify required parameter 'exportReportExportRequest' is not null or undefined
|
|
234
|
+
assertParamExists('createReportExport', 'exportReportExportRequest', exportReportExportRequest);
|
|
235
|
+
const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/export/report`
|
|
236
|
+
.replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)));
|
|
237
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
238
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
239
|
+
let baseOptions;
|
|
240
|
+
if (configuration) {
|
|
241
|
+
baseOptions = configuration.baseOptions;
|
|
242
|
+
}
|
|
243
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
244
|
+
const localVarHeaderParameter = {};
|
|
245
|
+
const localVarQueryParameter = {};
|
|
246
|
+
if (xGdcDebug !== undefined && xGdcDebug !== null) {
|
|
247
|
+
localVarHeaderParameter['X-Gdc-Debug'] = String(JSON.stringify(xGdcDebug));
|
|
248
|
+
}
|
|
249
|
+
const consumes = [
|
|
250
|
+
'application/json'
|
|
251
|
+
];
|
|
252
|
+
// use application/json if present, otherwise fallback to the first one
|
|
253
|
+
localVarHeaderParameter['Content-Type'] = consumes.includes('application/json')
|
|
254
|
+
? 'application/json'
|
|
255
|
+
: consumes[0];
|
|
256
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
257
|
+
const headersFromBaseOptions = baseOptions?.headers ? baseOptions.headers : {};
|
|
258
|
+
localVarRequestOptions.headers = {
|
|
259
|
+
...localVarHeaderParameter,
|
|
260
|
+
...headersFromBaseOptions,
|
|
261
|
+
...options.headers,
|
|
262
|
+
};
|
|
263
|
+
const needsSerialization = typeof exportReportExportRequest !== "string" ||
|
|
264
|
+
localVarRequestOptions.headers["Content-Type"] === "application/json";
|
|
265
|
+
localVarRequestOptions.data = needsSerialization
|
|
266
|
+
? JSON.stringify(exportReportExportRequest !== undefined ? exportReportExportRequest : {})
|
|
267
|
+
: exportReportExportRequest || "";
|
|
268
|
+
return {
|
|
269
|
+
url: toPathString(localVarUrlObj),
|
|
270
|
+
options: localVarRequestOptions,
|
|
271
|
+
};
|
|
272
|
+
}
|
|
273
|
+
// ActionsExport FP - ActionsExportAxiosParamCreator
|
|
220
274
|
/**
|
|
221
275
|
* Note: This API is an experimental and is going to change. Please, use it accordingly. A slides export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
|
|
222
276
|
* @summary (EXPERIMENTAL) Create slides export request
|
|
@@ -516,6 +570,84 @@ export async function ActionsExportAxiosParamCreator_GetRawExport(workspaceId, e
|
|
|
516
570
|
};
|
|
517
571
|
}
|
|
518
572
|
// ActionsExport FP - ActionsExportAxiosParamCreator
|
|
573
|
+
/**
|
|
574
|
+
* Note: This API is an experimental and is going to change. Please, use it accordingly. After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn\'t ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename.
|
|
575
|
+
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
576
|
+
* @param {string} workspaceId
|
|
577
|
+
* @param {string} exportId
|
|
578
|
+
* @param {*} [options] Override http request option.
|
|
579
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
580
|
+
* @throws {RequiredError}
|
|
581
|
+
*/
|
|
582
|
+
export async function ActionsExportAxiosParamCreator_GetReportExport(workspaceId, exportId, options = {}, configuration) {
|
|
583
|
+
// verify required parameter 'workspaceId' is not null or undefined
|
|
584
|
+
assertParamExists('getReportExport', 'workspaceId', workspaceId);
|
|
585
|
+
// verify required parameter 'exportId' is not null or undefined
|
|
586
|
+
assertParamExists('getReportExport', 'exportId', exportId);
|
|
587
|
+
const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/export/report/{exportId}`
|
|
588
|
+
.replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)))
|
|
589
|
+
.replace(`{${"exportId"}}`, encodeURIComponent(String(exportId)));
|
|
590
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
591
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
592
|
+
let baseOptions;
|
|
593
|
+
if (configuration) {
|
|
594
|
+
baseOptions = configuration.baseOptions;
|
|
595
|
+
}
|
|
596
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
597
|
+
const localVarHeaderParameter = {};
|
|
598
|
+
const localVarQueryParameter = {};
|
|
599
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
600
|
+
const headersFromBaseOptions = baseOptions?.headers ? baseOptions.headers : {};
|
|
601
|
+
localVarRequestOptions.headers = {
|
|
602
|
+
...localVarHeaderParameter,
|
|
603
|
+
...headersFromBaseOptions,
|
|
604
|
+
...options.headers,
|
|
605
|
+
};
|
|
606
|
+
return {
|
|
607
|
+
url: toPathString(localVarUrlObj),
|
|
608
|
+
options: localVarRequestOptions,
|
|
609
|
+
};
|
|
610
|
+
}
|
|
611
|
+
// ActionsExport FP - ActionsExportAxiosParamCreator
|
|
612
|
+
/**
|
|
613
|
+
* Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/report endpoint. The metadata structure is not verified.
|
|
614
|
+
* @summary (EXPERIMENTAL) Retrieve metadata context
|
|
615
|
+
* @param {string} workspaceId
|
|
616
|
+
* @param {string} exportId
|
|
617
|
+
* @param {*} [options] Override http request option.
|
|
618
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
619
|
+
* @throws {RequiredError}
|
|
620
|
+
*/
|
|
621
|
+
export async function ActionsExportAxiosParamCreator_GetReportExportMetadata(workspaceId, exportId, options = {}, configuration) {
|
|
622
|
+
// verify required parameter 'workspaceId' is not null or undefined
|
|
623
|
+
assertParamExists('getReportExportMetadata', 'workspaceId', workspaceId);
|
|
624
|
+
// verify required parameter 'exportId' is not null or undefined
|
|
625
|
+
assertParamExists('getReportExportMetadata', 'exportId', exportId);
|
|
626
|
+
const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/export/report/{exportId}/metadata`
|
|
627
|
+
.replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)))
|
|
628
|
+
.replace(`{${"exportId"}}`, encodeURIComponent(String(exportId)));
|
|
629
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
630
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
631
|
+
let baseOptions;
|
|
632
|
+
if (configuration) {
|
|
633
|
+
baseOptions = configuration.baseOptions;
|
|
634
|
+
}
|
|
635
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
636
|
+
const localVarHeaderParameter = {};
|
|
637
|
+
const localVarQueryParameter = {};
|
|
638
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
639
|
+
const headersFromBaseOptions = baseOptions?.headers ? baseOptions.headers : {};
|
|
640
|
+
localVarRequestOptions.headers = {
|
|
641
|
+
...localVarHeaderParameter,
|
|
642
|
+
...headersFromBaseOptions,
|
|
643
|
+
...options.headers,
|
|
644
|
+
};
|
|
645
|
+
return {
|
|
646
|
+
url: toPathString(localVarUrlObj),
|
|
647
|
+
options: localVarRequestOptions,
|
|
648
|
+
};
|
|
649
|
+
}
|
|
650
|
+
// ActionsExport FP - ActionsExportAxiosParamCreator
|
|
519
651
|
/**
|
|
520
652
|
* Note: This API is an experimental and is going to change. Please, use it accordingly. After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn\'t ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename.
|
|
521
653
|
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
@@ -693,6 +825,21 @@ export async function ActionsExport_CreateRawExport(axios, basePath, requestPara
|
|
|
693
825
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, basePath);
|
|
694
826
|
}
|
|
695
827
|
// ActionsExport Api FP
|
|
828
|
+
/**
|
|
829
|
+
* Note: This API is an experimental and is going to change. Please, use it accordingly. A report export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
|
|
830
|
+
* @summary (EXPERIMENTAL) Create report export request
|
|
831
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
832
|
+
* @param {string} basePath Base path.
|
|
833
|
+
* @param {ActionsExportCreateReportExportRequest} requestParameters Request parameters.
|
|
834
|
+
* @param {*} [options] Override http request option.
|
|
835
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
836
|
+
* @throws {RequiredError}
|
|
837
|
+
*/
|
|
838
|
+
export async function ActionsExport_CreateReportExport(axios, basePath, requestParameters, options, configuration) {
|
|
839
|
+
const localVarAxiosArgs = await ActionsExportAxiosParamCreator_CreateReportExport(requestParameters.workspaceId, requestParameters.exportReportExportRequest, requestParameters.xGdcDebug, options || {}, configuration);
|
|
840
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, basePath);
|
|
841
|
+
}
|
|
842
|
+
// ActionsExport Api FP
|
|
696
843
|
/**
|
|
697
844
|
* Note: This API is an experimental and is going to change. Please, use it accordingly. A slides export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
|
|
698
845
|
* @summary (EXPERIMENTAL) Create slides export request
|
|
@@ -798,6 +945,36 @@ export async function ActionsExport_GetRawExport(axios, basePath, requestParamet
|
|
|
798
945
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, basePath);
|
|
799
946
|
}
|
|
800
947
|
// ActionsExport Api FP
|
|
948
|
+
/**
|
|
949
|
+
* Note: This API is an experimental and is going to change. Please, use it accordingly. After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn\'t ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename.
|
|
950
|
+
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
951
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
952
|
+
* @param {string} basePath Base path.
|
|
953
|
+
* @param {ActionsExportGetReportExportRequest} requestParameters Request parameters.
|
|
954
|
+
* @param {*} [options] Override http request option.
|
|
955
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
956
|
+
* @throws {RequiredError}
|
|
957
|
+
*/
|
|
958
|
+
export async function ActionsExport_GetReportExport(axios, basePath, requestParameters, options, configuration) {
|
|
959
|
+
const localVarAxiosArgs = await ActionsExportAxiosParamCreator_GetReportExport(requestParameters.workspaceId, requestParameters.exportId, options || {}, configuration);
|
|
960
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, basePath);
|
|
961
|
+
}
|
|
962
|
+
// ActionsExport Api FP
|
|
963
|
+
/**
|
|
964
|
+
* Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/report endpoint. The metadata structure is not verified.
|
|
965
|
+
* @summary (EXPERIMENTAL) Retrieve metadata context
|
|
966
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
967
|
+
* @param {string} basePath Base path.
|
|
968
|
+
* @param {ActionsExportGetReportExportMetadataRequest} requestParameters Request parameters.
|
|
969
|
+
* @param {*} [options] Override http request option.
|
|
970
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
971
|
+
* @throws {RequiredError}
|
|
972
|
+
*/
|
|
973
|
+
export async function ActionsExport_GetReportExportMetadata(axios, basePath, requestParameters, options, configuration) {
|
|
974
|
+
const localVarAxiosArgs = await ActionsExportAxiosParamCreator_GetReportExportMetadata(requestParameters.workspaceId, requestParameters.exportId, options || {}, configuration);
|
|
975
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, basePath);
|
|
976
|
+
}
|
|
977
|
+
// ActionsExport Api FP
|
|
801
978
|
/**
|
|
802
979
|
* Note: This API is an experimental and is going to change. Please, use it accordingly. After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn\'t ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename.
|
|
803
980
|
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
@@ -893,6 +1070,17 @@ export class ActionsExport extends BaseAPI {
|
|
|
893
1070
|
createRawExport(requestParameters, options) {
|
|
894
1071
|
return ActionsExport_CreateRawExport(this.axios, this.basePath, requestParameters, options, this.configuration);
|
|
895
1072
|
}
|
|
1073
|
+
/**
|
|
1074
|
+
* Note: This API is an experimental and is going to change. Please, use it accordingly. A report export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
|
|
1075
|
+
* @summary (EXPERIMENTAL) Create report export request
|
|
1076
|
+
* @param {ActionsExportCreateReportExportRequest} requestParameters Request parameters.
|
|
1077
|
+
* @param {*} [options] Override http request option.
|
|
1078
|
+
* @throws {RequiredError}
|
|
1079
|
+
* @memberof ActionsExport
|
|
1080
|
+
*/
|
|
1081
|
+
createReportExport(requestParameters, options) {
|
|
1082
|
+
return ActionsExport_CreateReportExport(this.axios, this.basePath, requestParameters, options, this.configuration);
|
|
1083
|
+
}
|
|
896
1084
|
/**
|
|
897
1085
|
* Note: This API is an experimental and is going to change. Please, use it accordingly. A slides export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
|
|
898
1086
|
* @summary (EXPERIMENTAL) Create slides export request
|
|
@@ -970,6 +1158,28 @@ export class ActionsExport extends BaseAPI {
|
|
|
970
1158
|
getRawExport(requestParameters, options) {
|
|
971
1159
|
return ActionsExport_GetRawExport(this.axios, this.basePath, requestParameters, options, this.configuration);
|
|
972
1160
|
}
|
|
1161
|
+
/**
|
|
1162
|
+
* Note: This API is an experimental and is going to change. Please, use it accordingly. After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn\'t ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename.
|
|
1163
|
+
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
1164
|
+
* @param {ActionsExportGetReportExportRequest} requestParameters Request parameters.
|
|
1165
|
+
* @param {*} [options] Override http request option.
|
|
1166
|
+
* @throws {RequiredError}
|
|
1167
|
+
* @memberof ActionsExport
|
|
1168
|
+
*/
|
|
1169
|
+
getReportExport(requestParameters, options) {
|
|
1170
|
+
return ActionsExport_GetReportExport(this.axios, this.basePath, requestParameters, options, this.configuration);
|
|
1171
|
+
}
|
|
1172
|
+
/**
|
|
1173
|
+
* Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/report endpoint. The metadata structure is not verified.
|
|
1174
|
+
* @summary (EXPERIMENTAL) Retrieve metadata context
|
|
1175
|
+
* @param {ActionsExportGetReportExportMetadataRequest} requestParameters Request parameters.
|
|
1176
|
+
* @param {*} [options] Override http request option.
|
|
1177
|
+
* @throws {RequiredError}
|
|
1178
|
+
* @memberof ActionsExport
|
|
1179
|
+
*/
|
|
1180
|
+
getReportExportMetadata(requestParameters, options) {
|
|
1181
|
+
return ActionsExport_GetReportExportMetadata(this.axios, this.basePath, requestParameters, options, this.configuration);
|
|
1182
|
+
}
|
|
973
1183
|
/**
|
|
974
1184
|
* Note: This API is an experimental and is going to change. Please, use it accordingly. After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn\'t ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename.
|
|
975
1185
|
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
@@ -1371,6 +1581,224 @@ export class RawExportExport extends BaseAPI {
|
|
|
1371
1581
|
return RawExportExport_GetRawExport(this.axios, this.basePath, requestParameters, options, this.configuration);
|
|
1372
1582
|
}
|
|
1373
1583
|
}
|
|
1584
|
+
// ReportExportExport FP - ReportExportExportAxiosParamCreator
|
|
1585
|
+
/**
|
|
1586
|
+
* Note: This API is an experimental and is going to change. Please, use it accordingly. A report export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
|
|
1587
|
+
* @summary (EXPERIMENTAL) Create report export request
|
|
1588
|
+
* @param {string} workspaceId
|
|
1589
|
+
* @param {ExportReportExportRequest} exportReportExportRequest
|
|
1590
|
+
* @param {boolean} [xGdcDebug]
|
|
1591
|
+
* @param {*} [options] Override http request option.
|
|
1592
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
1593
|
+
* @throws {RequiredError}
|
|
1594
|
+
*/
|
|
1595
|
+
export async function ReportExportExportAxiosParamCreator_CreateReportExport(workspaceId, exportReportExportRequest, xGdcDebug, options = {}, configuration) {
|
|
1596
|
+
// verify required parameter 'workspaceId' is not null or undefined
|
|
1597
|
+
assertParamExists('createReportExport', 'workspaceId', workspaceId);
|
|
1598
|
+
// verify required parameter 'exportReportExportRequest' is not null or undefined
|
|
1599
|
+
assertParamExists('createReportExport', 'exportReportExportRequest', exportReportExportRequest);
|
|
1600
|
+
const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/export/report`
|
|
1601
|
+
.replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)));
|
|
1602
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1603
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1604
|
+
let baseOptions;
|
|
1605
|
+
if (configuration) {
|
|
1606
|
+
baseOptions = configuration.baseOptions;
|
|
1607
|
+
}
|
|
1608
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
1609
|
+
const localVarHeaderParameter = {};
|
|
1610
|
+
const localVarQueryParameter = {};
|
|
1611
|
+
if (xGdcDebug !== undefined && xGdcDebug !== null) {
|
|
1612
|
+
localVarHeaderParameter['X-Gdc-Debug'] = String(JSON.stringify(xGdcDebug));
|
|
1613
|
+
}
|
|
1614
|
+
const consumes = [
|
|
1615
|
+
'application/json'
|
|
1616
|
+
];
|
|
1617
|
+
// use application/json if present, otherwise fallback to the first one
|
|
1618
|
+
localVarHeaderParameter['Content-Type'] = consumes.includes('application/json')
|
|
1619
|
+
? 'application/json'
|
|
1620
|
+
: consumes[0];
|
|
1621
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1622
|
+
const headersFromBaseOptions = baseOptions?.headers ? baseOptions.headers : {};
|
|
1623
|
+
localVarRequestOptions.headers = {
|
|
1624
|
+
...localVarHeaderParameter,
|
|
1625
|
+
...headersFromBaseOptions,
|
|
1626
|
+
...options.headers,
|
|
1627
|
+
};
|
|
1628
|
+
const needsSerialization = typeof exportReportExportRequest !== "string" ||
|
|
1629
|
+
localVarRequestOptions.headers["Content-Type"] === "application/json";
|
|
1630
|
+
localVarRequestOptions.data = needsSerialization
|
|
1631
|
+
? JSON.stringify(exportReportExportRequest !== undefined ? exportReportExportRequest : {})
|
|
1632
|
+
: exportReportExportRequest || "";
|
|
1633
|
+
return {
|
|
1634
|
+
url: toPathString(localVarUrlObj),
|
|
1635
|
+
options: localVarRequestOptions,
|
|
1636
|
+
};
|
|
1637
|
+
}
|
|
1638
|
+
// ReportExportExport FP - ReportExportExportAxiosParamCreator
|
|
1639
|
+
/**
|
|
1640
|
+
* Note: This API is an experimental and is going to change. Please, use it accordingly. After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn\'t ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename.
|
|
1641
|
+
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
1642
|
+
* @param {string} workspaceId
|
|
1643
|
+
* @param {string} exportId
|
|
1644
|
+
* @param {*} [options] Override http request option.
|
|
1645
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
1646
|
+
* @throws {RequiredError}
|
|
1647
|
+
*/
|
|
1648
|
+
export async function ReportExportExportAxiosParamCreator_GetReportExport(workspaceId, exportId, options = {}, configuration) {
|
|
1649
|
+
// verify required parameter 'workspaceId' is not null or undefined
|
|
1650
|
+
assertParamExists('getReportExport', 'workspaceId', workspaceId);
|
|
1651
|
+
// verify required parameter 'exportId' is not null or undefined
|
|
1652
|
+
assertParamExists('getReportExport', 'exportId', exportId);
|
|
1653
|
+
const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/export/report/{exportId}`
|
|
1654
|
+
.replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)))
|
|
1655
|
+
.replace(`{${"exportId"}}`, encodeURIComponent(String(exportId)));
|
|
1656
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1657
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1658
|
+
let baseOptions;
|
|
1659
|
+
if (configuration) {
|
|
1660
|
+
baseOptions = configuration.baseOptions;
|
|
1661
|
+
}
|
|
1662
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
1663
|
+
const localVarHeaderParameter = {};
|
|
1664
|
+
const localVarQueryParameter = {};
|
|
1665
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1666
|
+
const headersFromBaseOptions = baseOptions?.headers ? baseOptions.headers : {};
|
|
1667
|
+
localVarRequestOptions.headers = {
|
|
1668
|
+
...localVarHeaderParameter,
|
|
1669
|
+
...headersFromBaseOptions,
|
|
1670
|
+
...options.headers,
|
|
1671
|
+
};
|
|
1672
|
+
return {
|
|
1673
|
+
url: toPathString(localVarUrlObj),
|
|
1674
|
+
options: localVarRequestOptions,
|
|
1675
|
+
};
|
|
1676
|
+
}
|
|
1677
|
+
// ReportExportExport FP - ReportExportExportAxiosParamCreator
|
|
1678
|
+
/**
|
|
1679
|
+
* Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/report endpoint. The metadata structure is not verified.
|
|
1680
|
+
* @summary (EXPERIMENTAL) Retrieve metadata context
|
|
1681
|
+
* @param {string} workspaceId
|
|
1682
|
+
* @param {string} exportId
|
|
1683
|
+
* @param {*} [options] Override http request option.
|
|
1684
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
1685
|
+
* @throws {RequiredError}
|
|
1686
|
+
*/
|
|
1687
|
+
export async function ReportExportExportAxiosParamCreator_GetReportExportMetadata(workspaceId, exportId, options = {}, configuration) {
|
|
1688
|
+
// verify required parameter 'workspaceId' is not null or undefined
|
|
1689
|
+
assertParamExists('getReportExportMetadata', 'workspaceId', workspaceId);
|
|
1690
|
+
// verify required parameter 'exportId' is not null or undefined
|
|
1691
|
+
assertParamExists('getReportExportMetadata', 'exportId', exportId);
|
|
1692
|
+
const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/export/report/{exportId}/metadata`
|
|
1693
|
+
.replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)))
|
|
1694
|
+
.replace(`{${"exportId"}}`, encodeURIComponent(String(exportId)));
|
|
1695
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1696
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1697
|
+
let baseOptions;
|
|
1698
|
+
if (configuration) {
|
|
1699
|
+
baseOptions = configuration.baseOptions;
|
|
1700
|
+
}
|
|
1701
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
1702
|
+
const localVarHeaderParameter = {};
|
|
1703
|
+
const localVarQueryParameter = {};
|
|
1704
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1705
|
+
const headersFromBaseOptions = baseOptions?.headers ? baseOptions.headers : {};
|
|
1706
|
+
localVarRequestOptions.headers = {
|
|
1707
|
+
...localVarHeaderParameter,
|
|
1708
|
+
...headersFromBaseOptions,
|
|
1709
|
+
...options.headers,
|
|
1710
|
+
};
|
|
1711
|
+
return {
|
|
1712
|
+
url: toPathString(localVarUrlObj),
|
|
1713
|
+
options: localVarRequestOptions,
|
|
1714
|
+
};
|
|
1715
|
+
}
|
|
1716
|
+
// ReportExportExport Api FP
|
|
1717
|
+
/**
|
|
1718
|
+
* Note: This API is an experimental and is going to change. Please, use it accordingly. A report export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
|
|
1719
|
+
* @summary (EXPERIMENTAL) Create report export request
|
|
1720
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
1721
|
+
* @param {string} basePath Base path.
|
|
1722
|
+
* @param {ReportExportExportCreateReportExportRequest} requestParameters Request parameters.
|
|
1723
|
+
* @param {*} [options] Override http request option.
|
|
1724
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
1725
|
+
* @throws {RequiredError}
|
|
1726
|
+
*/
|
|
1727
|
+
export async function ReportExportExport_CreateReportExport(axios, basePath, requestParameters, options, configuration) {
|
|
1728
|
+
const localVarAxiosArgs = await ReportExportExportAxiosParamCreator_CreateReportExport(requestParameters.workspaceId, requestParameters.exportReportExportRequest, requestParameters.xGdcDebug, options || {}, configuration);
|
|
1729
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, basePath);
|
|
1730
|
+
}
|
|
1731
|
+
// ReportExportExport Api FP
|
|
1732
|
+
/**
|
|
1733
|
+
* Note: This API is an experimental and is going to change. Please, use it accordingly. After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn\'t ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename.
|
|
1734
|
+
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
1735
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
1736
|
+
* @param {string} basePath Base path.
|
|
1737
|
+
* @param {ReportExportExportGetReportExportRequest} requestParameters Request parameters.
|
|
1738
|
+
* @param {*} [options] Override http request option.
|
|
1739
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
1740
|
+
* @throws {RequiredError}
|
|
1741
|
+
*/
|
|
1742
|
+
export async function ReportExportExport_GetReportExport(axios, basePath, requestParameters, options, configuration) {
|
|
1743
|
+
const localVarAxiosArgs = await ReportExportExportAxiosParamCreator_GetReportExport(requestParameters.workspaceId, requestParameters.exportId, options || {}, configuration);
|
|
1744
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, basePath);
|
|
1745
|
+
}
|
|
1746
|
+
// ReportExportExport Api FP
|
|
1747
|
+
/**
|
|
1748
|
+
* Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/report endpoint. The metadata structure is not verified.
|
|
1749
|
+
* @summary (EXPERIMENTAL) Retrieve metadata context
|
|
1750
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
1751
|
+
* @param {string} basePath Base path.
|
|
1752
|
+
* @param {ReportExportExportGetReportExportMetadataRequest} requestParameters Request parameters.
|
|
1753
|
+
* @param {*} [options] Override http request option.
|
|
1754
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
1755
|
+
* @throws {RequiredError}
|
|
1756
|
+
*/
|
|
1757
|
+
export async function ReportExportExport_GetReportExportMetadata(axios, basePath, requestParameters, options, configuration) {
|
|
1758
|
+
const localVarAxiosArgs = await ReportExportExportAxiosParamCreator_GetReportExportMetadata(requestParameters.workspaceId, requestParameters.exportId, options || {}, configuration);
|
|
1759
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, basePath);
|
|
1760
|
+
}
|
|
1761
|
+
/**
|
|
1762
|
+
* ReportExportExport - object-oriented interface
|
|
1763
|
+
* @export
|
|
1764
|
+
* @class ReportExportExport
|
|
1765
|
+
* @extends {BaseAPI}
|
|
1766
|
+
*/
|
|
1767
|
+
export class ReportExportExport extends BaseAPI {
|
|
1768
|
+
/**
|
|
1769
|
+
* Note: This API is an experimental and is going to change. Please, use it accordingly. A report export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
|
|
1770
|
+
* @summary (EXPERIMENTAL) Create report export request
|
|
1771
|
+
* @param {ReportExportExportCreateReportExportRequest} requestParameters Request parameters.
|
|
1772
|
+
* @param {*} [options] Override http request option.
|
|
1773
|
+
* @throws {RequiredError}
|
|
1774
|
+
* @memberof ReportExportExport
|
|
1775
|
+
*/
|
|
1776
|
+
createReportExport(requestParameters, options) {
|
|
1777
|
+
return ReportExportExport_CreateReportExport(this.axios, this.basePath, requestParameters, options, this.configuration);
|
|
1778
|
+
}
|
|
1779
|
+
/**
|
|
1780
|
+
* Note: This API is an experimental and is going to change. Please, use it accordingly. After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn\'t ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename.
|
|
1781
|
+
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
1782
|
+
* @param {ReportExportExportGetReportExportRequest} requestParameters Request parameters.
|
|
1783
|
+
* @param {*} [options] Override http request option.
|
|
1784
|
+
* @throws {RequiredError}
|
|
1785
|
+
* @memberof ReportExportExport
|
|
1786
|
+
*/
|
|
1787
|
+
getReportExport(requestParameters, options) {
|
|
1788
|
+
return ReportExportExport_GetReportExport(this.axios, this.basePath, requestParameters, options, this.configuration);
|
|
1789
|
+
}
|
|
1790
|
+
/**
|
|
1791
|
+
* Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/report endpoint. The metadata structure is not verified.
|
|
1792
|
+
* @summary (EXPERIMENTAL) Retrieve metadata context
|
|
1793
|
+
* @param {ReportExportExportGetReportExportMetadataRequest} requestParameters Request parameters.
|
|
1794
|
+
* @param {*} [options] Override http request option.
|
|
1795
|
+
* @throws {RequiredError}
|
|
1796
|
+
* @memberof ReportExportExport
|
|
1797
|
+
*/
|
|
1798
|
+
getReportExportMetadata(requestParameters, options) {
|
|
1799
|
+
return ReportExportExport_GetReportExportMetadata(this.axios, this.basePath, requestParameters, options, this.configuration);
|
|
1800
|
+
}
|
|
1801
|
+
}
|
|
1374
1802
|
// SlidesExportExport FP - SlidesExportExportAxiosParamCreator
|
|
1375
1803
|
/**
|
|
1376
1804
|
* Note: This API is an experimental and is going to change. Please, use it accordingly. A slides export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@gooddata/api-client-tiger",
|
|
3
|
-
"version": "11.58.0
|
|
3
|
+
"version": "11.58.0",
|
|
4
4
|
"description": "API Client for GoodData Cloud and GoodData.CN",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"author": "GoodData",
|
|
@@ -46,7 +46,7 @@
|
|
|
46
46
|
"axios-cache-interceptor": "1.12.0",
|
|
47
47
|
"lodash-es": "^4.17.23",
|
|
48
48
|
"tslib": "2.8.1",
|
|
49
|
-
"@gooddata/sdk-model": "11.58.0
|
|
49
|
+
"@gooddata/sdk-model": "11.58.0"
|
|
50
50
|
},
|
|
51
51
|
"devDependencies": {
|
|
52
52
|
"@microsoft/api-documenter": "7.30.10",
|
|
@@ -73,8 +73,8 @@
|
|
|
73
73
|
"oxlint-tsgolint": "7.0.2001",
|
|
74
74
|
"typescript": "7.0.2",
|
|
75
75
|
"vitest": "4.1.11",
|
|
76
|
-
"@gooddata/eslint-config": "11.58.0
|
|
77
|
-
"@gooddata/oxlint-config": "11.58.0
|
|
76
|
+
"@gooddata/eslint-config": "11.58.0",
|
|
77
|
+
"@gooddata/oxlint-config": "11.58.0"
|
|
78
78
|
},
|
|
79
79
|
"scripts": {
|
|
80
80
|
"_phase:build": "npm run build",
|