@gooddata/api-client-tiger 11.63.0-alpha.0 → 11.63.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.
@@ -59,6 +59,60 @@ export async function ActionsExportAxiosParamCreator_CreateDashboardExportReques
59
59
  };
60
60
  }
61
61
  // ActionsExport FP - ActionsExportAxiosParamCreator
62
+ /**
63
+ * Note: This API is an experimental and is going to change. Please, use it accordingly. A document 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.
64
+ * @summary (EXPERIMENTAL) Create document export request
65
+ * @param {string} workspaceId
66
+ * @param {ExportReportExportRequest} exportReportExportRequest
67
+ * @param {boolean} [xGdcDebug]
68
+ * @param {*} [options] Override http request option.
69
+ * @param {Configuration} [configuration] Optional configuration.
70
+ * @throws {RequiredError}
71
+ */
72
+ export async function ActionsExportAxiosParamCreator_CreateDocumentExport(workspaceId, exportReportExportRequest, xGdcDebug, options = {}, configuration) {
73
+ // verify required parameter 'workspaceId' is not null or undefined
74
+ assertParamExists('createDocumentExport', 'workspaceId', workspaceId);
75
+ // verify required parameter 'exportReportExportRequest' is not null or undefined
76
+ assertParamExists('createDocumentExport', 'exportReportExportRequest', exportReportExportRequest);
77
+ const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/export/document`
78
+ .replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)));
79
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
80
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
81
+ let baseOptions;
82
+ if (configuration) {
83
+ baseOptions = configuration.baseOptions;
84
+ }
85
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
86
+ const localVarHeaderParameter = {};
87
+ const localVarQueryParameter = {};
88
+ if (xGdcDebug !== undefined && xGdcDebug !== null) {
89
+ localVarHeaderParameter['X-Gdc-Debug'] = String(JSON.stringify(xGdcDebug));
90
+ }
91
+ const consumes = [
92
+ 'application/json'
93
+ ];
94
+ // use application/json if present, otherwise fallback to the first one
95
+ localVarHeaderParameter['Content-Type'] = consumes.includes('application/json')
96
+ ? 'application/json'
97
+ : consumes[0];
98
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
99
+ const headersFromBaseOptions = baseOptions?.headers ? baseOptions.headers : {};
100
+ localVarRequestOptions.headers = {
101
+ ...localVarHeaderParameter,
102
+ ...headersFromBaseOptions,
103
+ ...options.headers,
104
+ };
105
+ const needsSerialization = typeof exportReportExportRequest !== "string" ||
106
+ localVarRequestOptions.headers["Content-Type"] === "application/json";
107
+ localVarRequestOptions.data = needsSerialization
108
+ ? JSON.stringify(exportReportExportRequest !== undefined ? exportReportExportRequest : {})
109
+ : exportReportExportRequest || "";
110
+ return {
111
+ url: toPathString(localVarUrlObj),
112
+ options: localVarRequestOptions,
113
+ };
114
+ }
115
+ // ActionsExport FP - ActionsExportAxiosParamCreator
62
116
  /**
63
117
  * Note: This API is an experimental and is going to change. Please, use it accordingly. An image 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.
64
118
  * @summary (EXPERIMENTAL) Create image export request
@@ -218,7 +272,7 @@ export async function ActionsExportAxiosParamCreator_CreateRawExport(workspaceId
218
272
  }
219
273
  // ActionsExport FP - ActionsExportAxiosParamCreator
220
274
  /**
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.
275
+ * Deprecated, use createDocumentExport. 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
276
  * @summary (EXPERIMENTAL) Create report export request
223
277
  * @param {string} workspaceId
224
278
  * @param {ExportReportExportRequest} exportReportExportRequest
@@ -375,6 +429,84 @@ export async function ActionsExportAxiosParamCreator_CreateTabularExport(workspa
375
429
  };
376
430
  }
377
431
  // ActionsExport FP - ActionsExportAxiosParamCreator
432
+ /**
433
+ * 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.
434
+ * @summary (EXPERIMENTAL) Retrieve exported document
435
+ * @param {string} workspaceId
436
+ * @param {string} exportId
437
+ * @param {*} [options] Override http request option.
438
+ * @param {Configuration} [configuration] Optional configuration.
439
+ * @throws {RequiredError}
440
+ */
441
+ export async function ActionsExportAxiosParamCreator_GetDocumentExport(workspaceId, exportId, options = {}, configuration) {
442
+ // verify required parameter 'workspaceId' is not null or undefined
443
+ assertParamExists('getDocumentExport', 'workspaceId', workspaceId);
444
+ // verify required parameter 'exportId' is not null or undefined
445
+ assertParamExists('getDocumentExport', 'exportId', exportId);
446
+ const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/export/document/{exportId}`
447
+ .replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)))
448
+ .replace(`{${"exportId"}}`, encodeURIComponent(String(exportId)));
449
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
450
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
451
+ let baseOptions;
452
+ if (configuration) {
453
+ baseOptions = configuration.baseOptions;
454
+ }
455
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
456
+ const localVarHeaderParameter = {};
457
+ const localVarQueryParameter = {};
458
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
459
+ const headersFromBaseOptions = baseOptions?.headers ? baseOptions.headers : {};
460
+ localVarRequestOptions.headers = {
461
+ ...localVarHeaderParameter,
462
+ ...headersFromBaseOptions,
463
+ ...options.headers,
464
+ };
465
+ return {
466
+ url: toPathString(localVarUrlObj),
467
+ options: localVarRequestOptions,
468
+ };
469
+ }
470
+ // ActionsExport FP - ActionsExportAxiosParamCreator
471
+ /**
472
+ * 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/document endpoint. The metadata structure is not verified.
473
+ * @summary (EXPERIMENTAL) Retrieve document export metadata
474
+ * @param {string} workspaceId
475
+ * @param {string} exportId
476
+ * @param {*} [options] Override http request option.
477
+ * @param {Configuration} [configuration] Optional configuration.
478
+ * @throws {RequiredError}
479
+ */
480
+ export async function ActionsExportAxiosParamCreator_GetDocumentExportMetadata(workspaceId, exportId, options = {}, configuration) {
481
+ // verify required parameter 'workspaceId' is not null or undefined
482
+ assertParamExists('getDocumentExportMetadata', 'workspaceId', workspaceId);
483
+ // verify required parameter 'exportId' is not null or undefined
484
+ assertParamExists('getDocumentExportMetadata', 'exportId', exportId);
485
+ const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/export/document/{exportId}/metadata`
486
+ .replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)))
487
+ .replace(`{${"exportId"}}`, encodeURIComponent(String(exportId)));
488
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
489
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
490
+ let baseOptions;
491
+ if (configuration) {
492
+ baseOptions = configuration.baseOptions;
493
+ }
494
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
495
+ const localVarHeaderParameter = {};
496
+ const localVarQueryParameter = {};
497
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
498
+ const headersFromBaseOptions = baseOptions?.headers ? baseOptions.headers : {};
499
+ localVarRequestOptions.headers = {
500
+ ...localVarHeaderParameter,
501
+ ...headersFromBaseOptions,
502
+ ...options.headers,
503
+ };
504
+ return {
505
+ url: toPathString(localVarUrlObj),
506
+ options: localVarRequestOptions,
507
+ };
508
+ }
509
+ // ActionsExport FP - ActionsExportAxiosParamCreator
378
510
  /**
379
511
  * Returns 202 until original POST export request is not processed.Returns 200 with exported data once the export is done.
380
512
  * @summary Retrieve exported files
@@ -571,7 +703,7 @@ export async function ActionsExportAxiosParamCreator_GetRawExport(workspaceId, e
571
703
  }
572
704
  // ActionsExport FP - ActionsExportAxiosParamCreator
573
705
  /**
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.
706
+ * Deprecated, use getDocumentExport. 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
707
  * @summary (EXPERIMENTAL) Retrieve exported files
576
708
  * @param {string} workspaceId
577
709
  * @param {string} exportId
@@ -610,7 +742,7 @@ export async function ActionsExportAxiosParamCreator_GetReportExport(workspaceId
610
742
  }
611
743
  // ActionsExport FP - ActionsExportAxiosParamCreator
612
744
  /**
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.
745
+ * Deprecated, use getDocumentExportMetadata. 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
746
  * @summary (EXPERIMENTAL) Retrieve metadata context
615
747
  * @param {string} workspaceId
616
748
  * @param {string} exportId
@@ -780,6 +912,21 @@ export async function ActionsExport_CreateDashboardExportRequest(axios, basePath
780
912
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, basePath);
781
913
  }
782
914
  // ActionsExport Api FP
915
+ /**
916
+ * Note: This API is an experimental and is going to change. Please, use it accordingly. A document 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.
917
+ * @summary (EXPERIMENTAL) Create document export request
918
+ * @param {AxiosInstance} axios Axios instance.
919
+ * @param {string} basePath Base path.
920
+ * @param {ActionsExportCreateDocumentExportRequest} requestParameters Request parameters.
921
+ * @param {*} [options] Override http request option.
922
+ * @param {Configuration} [configuration] Optional configuration.
923
+ * @throws {RequiredError}
924
+ */
925
+ export async function ActionsExport_CreateDocumentExport(axios, basePath, requestParameters, options, configuration) {
926
+ const localVarAxiosArgs = await ActionsExportAxiosParamCreator_CreateDocumentExport(requestParameters.workspaceId, requestParameters.exportReportExportRequest, requestParameters.xGdcDebug, options || {}, configuration);
927
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, basePath);
928
+ }
929
+ // ActionsExport Api FP
783
930
  /**
784
931
  * Note: This API is an experimental and is going to change. Please, use it accordingly. An image 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.
785
932
  * @summary (EXPERIMENTAL) Create image export request
@@ -826,7 +973,7 @@ export async function ActionsExport_CreateRawExport(axios, basePath, requestPara
826
973
  }
827
974
  // ActionsExport Api FP
828
975
  /**
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.
976
+ * Deprecated, use createDocumentExport. 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
977
  * @summary (EXPERIMENTAL) Create report export request
831
978
  * @param {AxiosInstance} axios Axios instance.
832
979
  * @param {string} basePath Base path.
@@ -870,6 +1017,36 @@ export async function ActionsExport_CreateTabularExport(axios, basePath, request
870
1017
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, basePath);
871
1018
  }
872
1019
  // ActionsExport Api FP
1020
+ /**
1021
+ * 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.
1022
+ * @summary (EXPERIMENTAL) Retrieve exported document
1023
+ * @param {AxiosInstance} axios Axios instance.
1024
+ * @param {string} basePath Base path.
1025
+ * @param {ActionsExportGetDocumentExportRequest} requestParameters Request parameters.
1026
+ * @param {*} [options] Override http request option.
1027
+ * @param {Configuration} [configuration] Optional configuration.
1028
+ * @throws {RequiredError}
1029
+ */
1030
+ export async function ActionsExport_GetDocumentExport(axios, basePath, requestParameters, options, configuration) {
1031
+ const localVarAxiosArgs = await ActionsExportAxiosParamCreator_GetDocumentExport(requestParameters.workspaceId, requestParameters.exportId, options || {}, configuration);
1032
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, basePath);
1033
+ }
1034
+ // ActionsExport Api FP
1035
+ /**
1036
+ * 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/document endpoint. The metadata structure is not verified.
1037
+ * @summary (EXPERIMENTAL) Retrieve document export metadata
1038
+ * @param {AxiosInstance} axios Axios instance.
1039
+ * @param {string} basePath Base path.
1040
+ * @param {ActionsExportGetDocumentExportMetadataRequest} requestParameters Request parameters.
1041
+ * @param {*} [options] Override http request option.
1042
+ * @param {Configuration} [configuration] Optional configuration.
1043
+ * @throws {RequiredError}
1044
+ */
1045
+ export async function ActionsExport_GetDocumentExportMetadata(axios, basePath, requestParameters, options, configuration) {
1046
+ const localVarAxiosArgs = await ActionsExportAxiosParamCreator_GetDocumentExportMetadata(requestParameters.workspaceId, requestParameters.exportId, options || {}, configuration);
1047
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, basePath);
1048
+ }
1049
+ // ActionsExport Api FP
873
1050
  /**
874
1051
  * Returns 202 until original POST export request is not processed.Returns 200 with exported data once the export is done.
875
1052
  * @summary Retrieve exported files
@@ -946,7 +1123,7 @@ export async function ActionsExport_GetRawExport(axios, basePath, requestParamet
946
1123
  }
947
1124
  // ActionsExport Api FP
948
1125
  /**
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.
1126
+ * Deprecated, use getDocumentExport. 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
1127
  * @summary (EXPERIMENTAL) Retrieve exported files
951
1128
  * @param {AxiosInstance} axios Axios instance.
952
1129
  * @param {string} basePath Base path.
@@ -961,7 +1138,7 @@ export async function ActionsExport_GetReportExport(axios, basePath, requestPara
961
1138
  }
962
1139
  // ActionsExport Api FP
963
1140
  /**
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.
1141
+ * Deprecated, use getDocumentExportMetadata. 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
1142
  * @summary (EXPERIMENTAL) Retrieve metadata context
966
1143
  * @param {AxiosInstance} axios Axios instance.
967
1144
  * @param {string} basePath Base path.
@@ -1037,6 +1214,17 @@ export class ActionsExport extends BaseAPI {
1037
1214
  createDashboardExportRequest(requestParameters, options) {
1038
1215
  return ActionsExport_CreateDashboardExportRequest(this.axios, this.basePath, requestParameters, options, this.configuration);
1039
1216
  }
1217
+ /**
1218
+ * Note: This API is an experimental and is going to change. Please, use it accordingly. A document 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.
1219
+ * @summary (EXPERIMENTAL) Create document export request
1220
+ * @param {ActionsExportCreateDocumentExportRequest} requestParameters Request parameters.
1221
+ * @param {*} [options] Override http request option.
1222
+ * @throws {RequiredError}
1223
+ * @memberof ActionsExport
1224
+ */
1225
+ createDocumentExport(requestParameters, options) {
1226
+ return ActionsExport_CreateDocumentExport(this.axios, this.basePath, requestParameters, options, this.configuration);
1227
+ }
1040
1228
  /**
1041
1229
  * Note: This API is an experimental and is going to change. Please, use it accordingly. An image 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.
1042
1230
  * @summary (EXPERIMENTAL) Create image export request
@@ -1071,10 +1259,11 @@ export class ActionsExport extends BaseAPI {
1071
1259
  return ActionsExport_CreateRawExport(this.axios, this.basePath, requestParameters, options, this.configuration);
1072
1260
  }
1073
1261
  /**
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.
1262
+ * Deprecated, use createDocumentExport. 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
1263
  * @summary (EXPERIMENTAL) Create report export request
1076
1264
  * @param {ActionsExportCreateReportExportRequest} requestParameters Request parameters.
1077
1265
  * @param {*} [options] Override http request option.
1266
+ * @deprecated
1078
1267
  * @throws {RequiredError}
1079
1268
  * @memberof ActionsExport
1080
1269
  */
@@ -1103,6 +1292,28 @@ export class ActionsExport extends BaseAPI {
1103
1292
  createTabularExport(requestParameters, options) {
1104
1293
  return ActionsExport_CreateTabularExport(this.axios, this.basePath, requestParameters, options, this.configuration);
1105
1294
  }
1295
+ /**
1296
+ * 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.
1297
+ * @summary (EXPERIMENTAL) Retrieve exported document
1298
+ * @param {ActionsExportGetDocumentExportRequest} requestParameters Request parameters.
1299
+ * @param {*} [options] Override http request option.
1300
+ * @throws {RequiredError}
1301
+ * @memberof ActionsExport
1302
+ */
1303
+ getDocumentExport(requestParameters, options) {
1304
+ return ActionsExport_GetDocumentExport(this.axios, this.basePath, requestParameters, options, this.configuration);
1305
+ }
1306
+ /**
1307
+ * 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/document endpoint. The metadata structure is not verified.
1308
+ * @summary (EXPERIMENTAL) Retrieve document export metadata
1309
+ * @param {ActionsExportGetDocumentExportMetadataRequest} requestParameters Request parameters.
1310
+ * @param {*} [options] Override http request option.
1311
+ * @throws {RequiredError}
1312
+ * @memberof ActionsExport
1313
+ */
1314
+ getDocumentExportMetadata(requestParameters, options) {
1315
+ return ActionsExport_GetDocumentExportMetadata(this.axios, this.basePath, requestParameters, options, this.configuration);
1316
+ }
1106
1317
  /**
1107
1318
  * Returns 202 until original POST export request is not processed.Returns 200 with exported data once the export is done.
1108
1319
  * @summary Retrieve exported files
@@ -1159,10 +1370,11 @@ export class ActionsExport extends BaseAPI {
1159
1370
  return ActionsExport_GetRawExport(this.axios, this.basePath, requestParameters, options, this.configuration);
1160
1371
  }
1161
1372
  /**
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.
1373
+ * Deprecated, use getDocumentExport. 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
1374
  * @summary (EXPERIMENTAL) Retrieve exported files
1164
1375
  * @param {ActionsExportGetReportExportRequest} requestParameters Request parameters.
1165
1376
  * @param {*} [options] Override http request option.
1377
+ * @deprecated
1166
1378
  * @throws {RequiredError}
1167
1379
  * @memberof ActionsExport
1168
1380
  */
@@ -1170,10 +1382,11 @@ export class ActionsExport extends BaseAPI {
1170
1382
  return ActionsExport_GetReportExport(this.axios, this.basePath, requestParameters, options, this.configuration);
1171
1383
  }
1172
1384
  /**
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.
1385
+ * Deprecated, use getDocumentExportMetadata. 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
1386
  * @summary (EXPERIMENTAL) Retrieve metadata context
1175
1387
  * @param {ActionsExportGetReportExportMetadataRequest} requestParameters Request parameters.
1176
1388
  * @param {*} [options] Override http request option.
1389
+ * @deprecated
1177
1390
  * @throws {RequiredError}
1178
1391
  * @memberof ActionsExport
1179
1392
  */
@@ -1583,7 +1796,61 @@ export class RawExportExport extends BaseAPI {
1583
1796
  }
1584
1797
  // ReportExportExport FP - ReportExportExportAxiosParamCreator
1585
1798
  /**
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.
1799
+ * Note: This API is an experimental and is going to change. Please, use it accordingly. A document 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.
1800
+ * @summary (EXPERIMENTAL) Create document export request
1801
+ * @param {string} workspaceId
1802
+ * @param {ExportReportExportRequest} exportReportExportRequest
1803
+ * @param {boolean} [xGdcDebug]
1804
+ * @param {*} [options] Override http request option.
1805
+ * @param {Configuration} [configuration] Optional configuration.
1806
+ * @throws {RequiredError}
1807
+ */
1808
+ export async function ReportExportExportAxiosParamCreator_CreateDocumentExport(workspaceId, exportReportExportRequest, xGdcDebug, options = {}, configuration) {
1809
+ // verify required parameter 'workspaceId' is not null or undefined
1810
+ assertParamExists('createDocumentExport', 'workspaceId', workspaceId);
1811
+ // verify required parameter 'exportReportExportRequest' is not null or undefined
1812
+ assertParamExists('createDocumentExport', 'exportReportExportRequest', exportReportExportRequest);
1813
+ const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/export/document`
1814
+ .replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)));
1815
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1816
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1817
+ let baseOptions;
1818
+ if (configuration) {
1819
+ baseOptions = configuration.baseOptions;
1820
+ }
1821
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
1822
+ const localVarHeaderParameter = {};
1823
+ const localVarQueryParameter = {};
1824
+ if (xGdcDebug !== undefined && xGdcDebug !== null) {
1825
+ localVarHeaderParameter['X-Gdc-Debug'] = String(JSON.stringify(xGdcDebug));
1826
+ }
1827
+ const consumes = [
1828
+ 'application/json'
1829
+ ];
1830
+ // use application/json if present, otherwise fallback to the first one
1831
+ localVarHeaderParameter['Content-Type'] = consumes.includes('application/json')
1832
+ ? 'application/json'
1833
+ : consumes[0];
1834
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1835
+ const headersFromBaseOptions = baseOptions?.headers ? baseOptions.headers : {};
1836
+ localVarRequestOptions.headers = {
1837
+ ...localVarHeaderParameter,
1838
+ ...headersFromBaseOptions,
1839
+ ...options.headers,
1840
+ };
1841
+ const needsSerialization = typeof exportReportExportRequest !== "string" ||
1842
+ localVarRequestOptions.headers["Content-Type"] === "application/json";
1843
+ localVarRequestOptions.data = needsSerialization
1844
+ ? JSON.stringify(exportReportExportRequest !== undefined ? exportReportExportRequest : {})
1845
+ : exportReportExportRequest || "";
1846
+ return {
1847
+ url: toPathString(localVarUrlObj),
1848
+ options: localVarRequestOptions,
1849
+ };
1850
+ }
1851
+ // ReportExportExport FP - ReportExportExportAxiosParamCreator
1852
+ /**
1853
+ * Deprecated, use createDocumentExport. 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
1854
  * @summary (EXPERIMENTAL) Create report export request
1588
1855
  * @param {string} workspaceId
1589
1856
  * @param {ExportReportExportRequest} exportReportExportRequest
@@ -1638,6 +1905,84 @@ export async function ReportExportExportAxiosParamCreator_CreateReportExport(wor
1638
1905
  // ReportExportExport FP - ReportExportExportAxiosParamCreator
1639
1906
  /**
1640
1907
  * 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.
1908
+ * @summary (EXPERIMENTAL) Retrieve exported document
1909
+ * @param {string} workspaceId
1910
+ * @param {string} exportId
1911
+ * @param {*} [options] Override http request option.
1912
+ * @param {Configuration} [configuration] Optional configuration.
1913
+ * @throws {RequiredError}
1914
+ */
1915
+ export async function ReportExportExportAxiosParamCreator_GetDocumentExport(workspaceId, exportId, options = {}, configuration) {
1916
+ // verify required parameter 'workspaceId' is not null or undefined
1917
+ assertParamExists('getDocumentExport', 'workspaceId', workspaceId);
1918
+ // verify required parameter 'exportId' is not null or undefined
1919
+ assertParamExists('getDocumentExport', 'exportId', exportId);
1920
+ const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/export/document/{exportId}`
1921
+ .replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)))
1922
+ .replace(`{${"exportId"}}`, encodeURIComponent(String(exportId)));
1923
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1924
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1925
+ let baseOptions;
1926
+ if (configuration) {
1927
+ baseOptions = configuration.baseOptions;
1928
+ }
1929
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
1930
+ const localVarHeaderParameter = {};
1931
+ const localVarQueryParameter = {};
1932
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1933
+ const headersFromBaseOptions = baseOptions?.headers ? baseOptions.headers : {};
1934
+ localVarRequestOptions.headers = {
1935
+ ...localVarHeaderParameter,
1936
+ ...headersFromBaseOptions,
1937
+ ...options.headers,
1938
+ };
1939
+ return {
1940
+ url: toPathString(localVarUrlObj),
1941
+ options: localVarRequestOptions,
1942
+ };
1943
+ }
1944
+ // ReportExportExport FP - ReportExportExportAxiosParamCreator
1945
+ /**
1946
+ * 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/document endpoint. The metadata structure is not verified.
1947
+ * @summary (EXPERIMENTAL) Retrieve document export metadata
1948
+ * @param {string} workspaceId
1949
+ * @param {string} exportId
1950
+ * @param {*} [options] Override http request option.
1951
+ * @param {Configuration} [configuration] Optional configuration.
1952
+ * @throws {RequiredError}
1953
+ */
1954
+ export async function ReportExportExportAxiosParamCreator_GetDocumentExportMetadata(workspaceId, exportId, options = {}, configuration) {
1955
+ // verify required parameter 'workspaceId' is not null or undefined
1956
+ assertParamExists('getDocumentExportMetadata', 'workspaceId', workspaceId);
1957
+ // verify required parameter 'exportId' is not null or undefined
1958
+ assertParamExists('getDocumentExportMetadata', 'exportId', exportId);
1959
+ const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/export/document/{exportId}/metadata`
1960
+ .replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)))
1961
+ .replace(`{${"exportId"}}`, encodeURIComponent(String(exportId)));
1962
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1963
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1964
+ let baseOptions;
1965
+ if (configuration) {
1966
+ baseOptions = configuration.baseOptions;
1967
+ }
1968
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
1969
+ const localVarHeaderParameter = {};
1970
+ const localVarQueryParameter = {};
1971
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1972
+ const headersFromBaseOptions = baseOptions?.headers ? baseOptions.headers : {};
1973
+ localVarRequestOptions.headers = {
1974
+ ...localVarHeaderParameter,
1975
+ ...headersFromBaseOptions,
1976
+ ...options.headers,
1977
+ };
1978
+ return {
1979
+ url: toPathString(localVarUrlObj),
1980
+ options: localVarRequestOptions,
1981
+ };
1982
+ }
1983
+ // ReportExportExport FP - ReportExportExportAxiosParamCreator
1984
+ /**
1985
+ * Deprecated, use getDocumentExport. 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
1986
  * @summary (EXPERIMENTAL) Retrieve exported files
1642
1987
  * @param {string} workspaceId
1643
1988
  * @param {string} exportId
@@ -1676,7 +2021,7 @@ export async function ReportExportExportAxiosParamCreator_GetReportExport(worksp
1676
2021
  }
1677
2022
  // ReportExportExport FP - ReportExportExportAxiosParamCreator
1678
2023
  /**
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.
2024
+ * Deprecated, use getDocumentExportMetadata. 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
2025
  * @summary (EXPERIMENTAL) Retrieve metadata context
1681
2026
  * @param {string} workspaceId
1682
2027
  * @param {string} exportId
@@ -1715,7 +2060,22 @@ export async function ReportExportExportAxiosParamCreator_GetReportExportMetadat
1715
2060
  }
1716
2061
  // ReportExportExport Api FP
1717
2062
  /**
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.
2063
+ * Note: This API is an experimental and is going to change. Please, use it accordingly. A document 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.
2064
+ * @summary (EXPERIMENTAL) Create document export request
2065
+ * @param {AxiosInstance} axios Axios instance.
2066
+ * @param {string} basePath Base path.
2067
+ * @param {ReportExportExportCreateDocumentExportRequest} requestParameters Request parameters.
2068
+ * @param {*} [options] Override http request option.
2069
+ * @param {Configuration} [configuration] Optional configuration.
2070
+ * @throws {RequiredError}
2071
+ */
2072
+ export async function ReportExportExport_CreateDocumentExport(axios, basePath, requestParameters, options, configuration) {
2073
+ const localVarAxiosArgs = await ReportExportExportAxiosParamCreator_CreateDocumentExport(requestParameters.workspaceId, requestParameters.exportReportExportRequest, requestParameters.xGdcDebug, options || {}, configuration);
2074
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, basePath);
2075
+ }
2076
+ // ReportExportExport Api FP
2077
+ /**
2078
+ * Deprecated, use createDocumentExport. 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
2079
  * @summary (EXPERIMENTAL) Create report export request
1720
2080
  * @param {AxiosInstance} axios Axios instance.
1721
2081
  * @param {string} basePath Base path.
@@ -1731,6 +2091,36 @@ export async function ReportExportExport_CreateReportExport(axios, basePath, req
1731
2091
  // ReportExportExport Api FP
1732
2092
  /**
1733
2093
  * 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.
2094
+ * @summary (EXPERIMENTAL) Retrieve exported document
2095
+ * @param {AxiosInstance} axios Axios instance.
2096
+ * @param {string} basePath Base path.
2097
+ * @param {ReportExportExportGetDocumentExportRequest} requestParameters Request parameters.
2098
+ * @param {*} [options] Override http request option.
2099
+ * @param {Configuration} [configuration] Optional configuration.
2100
+ * @throws {RequiredError}
2101
+ */
2102
+ export async function ReportExportExport_GetDocumentExport(axios, basePath, requestParameters, options, configuration) {
2103
+ const localVarAxiosArgs = await ReportExportExportAxiosParamCreator_GetDocumentExport(requestParameters.workspaceId, requestParameters.exportId, options || {}, configuration);
2104
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, basePath);
2105
+ }
2106
+ // ReportExportExport Api FP
2107
+ /**
2108
+ * 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/document endpoint. The metadata structure is not verified.
2109
+ * @summary (EXPERIMENTAL) Retrieve document export metadata
2110
+ * @param {AxiosInstance} axios Axios instance.
2111
+ * @param {string} basePath Base path.
2112
+ * @param {ReportExportExportGetDocumentExportMetadataRequest} requestParameters Request parameters.
2113
+ * @param {*} [options] Override http request option.
2114
+ * @param {Configuration} [configuration] Optional configuration.
2115
+ * @throws {RequiredError}
2116
+ */
2117
+ export async function ReportExportExport_GetDocumentExportMetadata(axios, basePath, requestParameters, options, configuration) {
2118
+ const localVarAxiosArgs = await ReportExportExportAxiosParamCreator_GetDocumentExportMetadata(requestParameters.workspaceId, requestParameters.exportId, options || {}, configuration);
2119
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, basePath);
2120
+ }
2121
+ // ReportExportExport Api FP
2122
+ /**
2123
+ * Deprecated, use getDocumentExport. 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
2124
  * @summary (EXPERIMENTAL) Retrieve exported files
1735
2125
  * @param {AxiosInstance} axios Axios instance.
1736
2126
  * @param {string} basePath Base path.
@@ -1745,7 +2135,7 @@ export async function ReportExportExport_GetReportExport(axios, basePath, reques
1745
2135
  }
1746
2136
  // ReportExportExport Api FP
1747
2137
  /**
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.
2138
+ * Deprecated, use getDocumentExportMetadata. 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
2139
  * @summary (EXPERIMENTAL) Retrieve metadata context
1750
2140
  * @param {AxiosInstance} axios Axios instance.
1751
2141
  * @param {string} basePath Base path.
@@ -1766,10 +2156,22 @@ export async function ReportExportExport_GetReportExportMetadata(axios, basePath
1766
2156
  */
1767
2157
  export class ReportExportExport extends BaseAPI {
1768
2158
  /**
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.
2159
+ * Note: This API is an experimental and is going to change. Please, use it accordingly. A document 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.
2160
+ * @summary (EXPERIMENTAL) Create document export request
2161
+ * @param {ReportExportExportCreateDocumentExportRequest} requestParameters Request parameters.
2162
+ * @param {*} [options] Override http request option.
2163
+ * @throws {RequiredError}
2164
+ * @memberof ReportExportExport
2165
+ */
2166
+ createDocumentExport(requestParameters, options) {
2167
+ return ReportExportExport_CreateDocumentExport(this.axios, this.basePath, requestParameters, options, this.configuration);
2168
+ }
2169
+ /**
2170
+ * Deprecated, use createDocumentExport. 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
2171
  * @summary (EXPERIMENTAL) Create report export request
1771
2172
  * @param {ReportExportExportCreateReportExportRequest} requestParameters Request parameters.
1772
2173
  * @param {*} [options] Override http request option.
2174
+ * @deprecated
1773
2175
  * @throws {RequiredError}
1774
2176
  * @memberof ReportExportExport
1775
2177
  */
@@ -1778,9 +2180,32 @@ export class ReportExportExport extends BaseAPI {
1778
2180
  }
1779
2181
  /**
1780
2182
  * 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.
2183
+ * @summary (EXPERIMENTAL) Retrieve exported document
2184
+ * @param {ReportExportExportGetDocumentExportRequest} requestParameters Request parameters.
2185
+ * @param {*} [options] Override http request option.
2186
+ * @throws {RequiredError}
2187
+ * @memberof ReportExportExport
2188
+ */
2189
+ getDocumentExport(requestParameters, options) {
2190
+ return ReportExportExport_GetDocumentExport(this.axios, this.basePath, requestParameters, options, this.configuration);
2191
+ }
2192
+ /**
2193
+ * 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/document endpoint. The metadata structure is not verified.
2194
+ * @summary (EXPERIMENTAL) Retrieve document export metadata
2195
+ * @param {ReportExportExportGetDocumentExportMetadataRequest} requestParameters Request parameters.
2196
+ * @param {*} [options] Override http request option.
2197
+ * @throws {RequiredError}
2198
+ * @memberof ReportExportExport
2199
+ */
2200
+ getDocumentExportMetadata(requestParameters, options) {
2201
+ return ReportExportExport_GetDocumentExportMetadata(this.axios, this.basePath, requestParameters, options, this.configuration);
2202
+ }
2203
+ /**
2204
+ * Deprecated, use getDocumentExport. 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
2205
  * @summary (EXPERIMENTAL) Retrieve exported files
1782
2206
  * @param {ReportExportExportGetReportExportRequest} requestParameters Request parameters.
1783
2207
  * @param {*} [options] Override http request option.
2208
+ * @deprecated
1784
2209
  * @throws {RequiredError}
1785
2210
  * @memberof ReportExportExport
1786
2211
  */
@@ -1788,10 +2213,11 @@ export class ReportExportExport extends BaseAPI {
1788
2213
  return ReportExportExport_GetReportExport(this.axios, this.basePath, requestParameters, options, this.configuration);
1789
2214
  }
1790
2215
  /**
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.
2216
+ * Deprecated, use getDocumentExportMetadata. 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
2217
  * @summary (EXPERIMENTAL) Retrieve metadata context
1793
2218
  * @param {ReportExportExportGetReportExportMetadataRequest} requestParameters Request parameters.
1794
2219
  * @param {*} [options] Override http request option.
2220
+ * @deprecated
1795
2221
  * @throws {RequiredError}
1796
2222
  * @memberof ReportExportExport
1797
2223
  */