@gooddata/api-client-tiger 10.27.0-alpha.9 → 10.27.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.
Files changed (46) hide show
  1. package/esm/__version.d.ts +1 -1
  2. package/esm/__version.d.ts.map +1 -1
  3. package/esm/__version.js +1 -1
  4. package/esm/__version.js.map +1 -1
  5. package/esm/api-client-tiger.d.ts +4347 -1738
  6. package/esm/automation.d.ts +2 -3
  7. package/esm/automation.d.ts.map +1 -1
  8. package/esm/automation.js +2 -2
  9. package/esm/automation.js.map +1 -1
  10. package/esm/client.d.ts +2 -2
  11. package/esm/client.d.ts.map +1 -1
  12. package/esm/client.js +1 -1
  13. package/esm/client.js.map +1 -1
  14. package/esm/generated/afm-rest-api/api.d.ts +60 -8
  15. package/esm/generated/afm-rest-api/api.d.ts.map +1 -1
  16. package/esm/generated/afm-rest-api/api.js +4 -4
  17. package/esm/generated/afm-rest-api/api.js.map +1 -1
  18. package/esm/generated/afm-rest-api/openapi-spec.json +51 -10
  19. package/esm/generated/automation-json-api/api.d.ts +1984 -705
  20. package/esm/generated/automation-json-api/api.d.ts.map +1 -1
  21. package/esm/generated/automation-json-api/api.js +275 -169
  22. package/esm/generated/automation-json-api/api.js.map +1 -1
  23. package/esm/generated/automation-json-api/openapi-spec.json +1046 -7
  24. package/esm/generated/export-json-api/api.d.ts +591 -4
  25. package/esm/generated/export-json-api/api.d.ts.map +1 -1
  26. package/esm/generated/export-json-api/api.js +522 -10
  27. package/esm/generated/export-json-api/api.js.map +1 -1
  28. package/esm/generated/export-json-api/openapi-spec.json +417 -1
  29. package/esm/generated/metadata-json-api/api.d.ts +1209 -1183
  30. package/esm/generated/metadata-json-api/api.d.ts.map +1 -1
  31. package/esm/generated/metadata-json-api/api.js +76 -57
  32. package/esm/generated/metadata-json-api/api.js.map +1 -1
  33. package/esm/generated/metadata-json-api/openapi-spec.json +7953 -7935
  34. package/esm/generated/result-json-api/base.d.ts.map +1 -1
  35. package/esm/generated/result-json-api/base.js +1 -13
  36. package/esm/generated/result-json-api/base.js.map +1 -1
  37. package/esm/generated/scan-json-api/api.d.ts +2 -1
  38. package/esm/generated/scan-json-api/api.d.ts.map +1 -1
  39. package/esm/generated/scan-json-api/api.js +2 -1
  40. package/esm/generated/scan-json-api/api.js.map +1 -1
  41. package/esm/generated/scan-json-api/openapi-spec.json +3 -2
  42. package/esm/index.d.ts +5 -2
  43. package/esm/index.d.ts.map +1 -1
  44. package/esm/index.js +1 -0
  45. package/esm/index.js.map +1 -1
  46. package/package.json +4 -4
@@ -50,6 +50,12 @@ export const ComparisonMeasureValueFilterComparisonMeasureValueFilterOperatorEnu
50
50
  EQUAL_TO: "EQUAL_TO",
51
51
  NOT_EQUAL_TO: "NOT_EQUAL_TO",
52
52
  };
53
+ export const DashboardTabularExportRequestFormatEnum = {
54
+ XLSX: "XLSX",
55
+ };
56
+ export const ImageExportRequestFormatEnum = {
57
+ PNG: "PNG",
58
+ };
53
59
  export const RangeMeasureValueFilterRangeMeasureValueFilterOperatorEnum = {
54
60
  BETWEEN: "BETWEEN",
55
61
  NOT_BETWEEN: "NOT_BETWEEN",
@@ -111,14 +117,17 @@ export const ActionsApiAxiosParamCreator = function (configuration) {
111
117
  * @summary (EXPERIMENTAL) Create dashboard tabular export request
112
118
  * @param {string} workspaceId
113
119
  * @param {string} dashboardId
120
+ * @param {DashboardTabularExportRequest} dashboardTabularExportRequest
114
121
  * @param {*} [options] Override http request option.
115
122
  * @throws {RequiredError}
116
123
  */
117
- createDashboardExportRequest: async (workspaceId, dashboardId, options = {}) => {
124
+ createDashboardExportRequest: async (workspaceId, dashboardId, dashboardTabularExportRequest, options = {}) => {
118
125
  // verify required parameter 'workspaceId' is not null or undefined
119
126
  assertParamExists("createDashboardExportRequest", "workspaceId", workspaceId);
120
127
  // verify required parameter 'dashboardId' is not null or undefined
121
128
  assertParamExists("createDashboardExportRequest", "dashboardId", dashboardId);
129
+ // verify required parameter 'dashboardTabularExportRequest' is not null or undefined
130
+ assertParamExists("createDashboardExportRequest", "dashboardTabularExportRequest", dashboardTabularExportRequest);
122
131
  const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/export/tabular`
123
132
  .replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)))
124
133
  .replace(`{${"dashboardId"}}`, encodeURIComponent(String(dashboardId)));
@@ -131,6 +140,7 @@ export const ActionsApiAxiosParamCreator = function (configuration) {
131
140
  const localVarRequestOptions = { method: "POST", ...baseOptions, ...options };
132
141
  const localVarHeaderParameter = {};
133
142
  const localVarQueryParameter = {};
143
+ localVarHeaderParameter["Content-Type"] = "application/json";
134
144
  setSearchParams(localVarUrlObj, localVarQueryParameter);
135
145
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
136
146
  localVarRequestOptions.headers = {
@@ -138,6 +148,52 @@ export const ActionsApiAxiosParamCreator = function (configuration) {
138
148
  ...headersFromBaseOptions,
139
149
  ...options.headers,
140
150
  };
151
+ const needsSerialization = typeof dashboardTabularExportRequest !== "string" ||
152
+ localVarRequestOptions.headers["Content-Type"] === "application/json";
153
+ localVarRequestOptions.data = needsSerialization
154
+ ? JSON.stringify(dashboardTabularExportRequest !== undefined ? dashboardTabularExportRequest : {})
155
+ : dashboardTabularExportRequest || "";
156
+ return {
157
+ url: toPathString(localVarUrlObj),
158
+ options: localVarRequestOptions,
159
+ };
160
+ },
161
+ /**
162
+ * 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.
163
+ * @summary (EXPERIMENTAL) Create image export request
164
+ * @param {string} workspaceId
165
+ * @param {ImageExportRequest} imageExportRequest
166
+ * @param {*} [options] Override http request option.
167
+ * @throws {RequiredError}
168
+ */
169
+ createImageExport: async (workspaceId, imageExportRequest, options = {}) => {
170
+ // verify required parameter 'workspaceId' is not null or undefined
171
+ assertParamExists("createImageExport", "workspaceId", workspaceId);
172
+ // verify required parameter 'imageExportRequest' is not null or undefined
173
+ assertParamExists("createImageExport", "imageExportRequest", imageExportRequest);
174
+ const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/export/image`.replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)));
175
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
176
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
177
+ let baseOptions;
178
+ if (configuration) {
179
+ baseOptions = configuration.baseOptions;
180
+ }
181
+ const localVarRequestOptions = { method: "POST", ...baseOptions, ...options };
182
+ const localVarHeaderParameter = {};
183
+ const localVarQueryParameter = {};
184
+ localVarHeaderParameter["Content-Type"] = "application/json";
185
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
186
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
187
+ localVarRequestOptions.headers = {
188
+ ...localVarHeaderParameter,
189
+ ...headersFromBaseOptions,
190
+ ...options.headers,
191
+ };
192
+ const needsSerialization = typeof imageExportRequest !== "string" ||
193
+ localVarRequestOptions.headers["Content-Type"] === "application/json";
194
+ localVarRequestOptions.data = needsSerialization
195
+ ? JSON.stringify(imageExportRequest !== undefined ? imageExportRequest : {})
196
+ : imageExportRequest || "";
141
197
  return {
142
198
  url: toPathString(localVarUrlObj),
143
199
  options: localVarRequestOptions,
@@ -344,6 +400,80 @@ export const ActionsApiAxiosParamCreator = function (configuration) {
344
400
  options: localVarRequestOptions,
345
401
  };
346
402
  },
403
+ /**
404
+ * 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.
405
+ * @summary (EXPERIMENTAL) Retrieve exported files
406
+ * @param {string} workspaceId
407
+ * @param {string} exportId
408
+ * @param {*} [options] Override http request option.
409
+ * @throws {RequiredError}
410
+ */
411
+ getImageExport: async (workspaceId, exportId, options = {}) => {
412
+ // verify required parameter 'workspaceId' is not null or undefined
413
+ assertParamExists("getImageExport", "workspaceId", workspaceId);
414
+ // verify required parameter 'exportId' is not null or undefined
415
+ assertParamExists("getImageExport", "exportId", exportId);
416
+ const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/export/image/{exportId}`
417
+ .replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)))
418
+ .replace(`{${"exportId"}}`, encodeURIComponent(String(exportId)));
419
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
420
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
421
+ let baseOptions;
422
+ if (configuration) {
423
+ baseOptions = configuration.baseOptions;
424
+ }
425
+ const localVarRequestOptions = { method: "GET", ...baseOptions, ...options };
426
+ const localVarHeaderParameter = {};
427
+ const localVarQueryParameter = {};
428
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
429
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
430
+ localVarRequestOptions.headers = {
431
+ ...localVarHeaderParameter,
432
+ ...headersFromBaseOptions,
433
+ ...options.headers,
434
+ };
435
+ return {
436
+ url: toPathString(localVarUrlObj),
437
+ options: localVarRequestOptions,
438
+ };
439
+ },
440
+ /**
441
+ * 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/image endpoint. The metadata structure is not verified.
442
+ * @summary (EXPERIMENTAL) Retrieve metadata context
443
+ * @param {string} workspaceId
444
+ * @param {string} exportId
445
+ * @param {*} [options] Override http request option.
446
+ * @throws {RequiredError}
447
+ */
448
+ getImageExportMetadata: async (workspaceId, exportId, options = {}) => {
449
+ // verify required parameter 'workspaceId' is not null or undefined
450
+ assertParamExists("getImageExportMetadata", "workspaceId", workspaceId);
451
+ // verify required parameter 'exportId' is not null or undefined
452
+ assertParamExists("getImageExportMetadata", "exportId", exportId);
453
+ const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/export/image/{exportId}/metadata`
454
+ .replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)))
455
+ .replace(`{${"exportId"}}`, encodeURIComponent(String(exportId)));
456
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
457
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
458
+ let baseOptions;
459
+ if (configuration) {
460
+ baseOptions = configuration.baseOptions;
461
+ }
462
+ const localVarRequestOptions = { method: "GET", ...baseOptions, ...options };
463
+ const localVarHeaderParameter = {};
464
+ const localVarQueryParameter = {};
465
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
466
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
467
+ localVarRequestOptions.headers = {
468
+ ...localVarHeaderParameter,
469
+ ...headersFromBaseOptions,
470
+ ...options.headers,
471
+ };
472
+ return {
473
+ url: toPathString(localVarUrlObj),
474
+ options: localVarRequestOptions,
475
+ };
476
+ },
347
477
  /**
348
478
  * 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/visual endpoint. The metadata structure is not verified.
349
479
  * @summary Retrieve metadata context
@@ -543,11 +673,24 @@ export const ActionsApiFp = function (configuration) {
543
673
  * @summary (EXPERIMENTAL) Create dashboard tabular export request
544
674
  * @param {string} workspaceId
545
675
  * @param {string} dashboardId
676
+ * @param {DashboardTabularExportRequest} dashboardTabularExportRequest
546
677
  * @param {*} [options] Override http request option.
547
678
  * @throws {RequiredError}
548
679
  */
549
- async createDashboardExportRequest(workspaceId, dashboardId, options) {
550
- const localVarAxiosArgs = await localVarAxiosParamCreator.createDashboardExportRequest(workspaceId, dashboardId, options);
680
+ async createDashboardExportRequest(workspaceId, dashboardId, dashboardTabularExportRequest, options) {
681
+ const localVarAxiosArgs = await localVarAxiosParamCreator.createDashboardExportRequest(workspaceId, dashboardId, dashboardTabularExportRequest, options);
682
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
683
+ },
684
+ /**
685
+ * 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.
686
+ * @summary (EXPERIMENTAL) Create image export request
687
+ * @param {string} workspaceId
688
+ * @param {ImageExportRequest} imageExportRequest
689
+ * @param {*} [options] Override http request option.
690
+ * @throws {RequiredError}
691
+ */
692
+ async createImageExport(workspaceId, imageExportRequest, options) {
693
+ const localVarAxiosArgs = await localVarAxiosParamCreator.createImageExport(workspaceId, imageExportRequest, options);
551
694
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
552
695
  },
553
696
  /**
@@ -610,6 +753,30 @@ export const ActionsApiFp = function (configuration) {
610
753
  const localVarAxiosArgs = await localVarAxiosParamCreator.getExportedFile(workspaceId, exportId, options);
611
754
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
612
755
  },
756
+ /**
757
+ * 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.
758
+ * @summary (EXPERIMENTAL) Retrieve exported files
759
+ * @param {string} workspaceId
760
+ * @param {string} exportId
761
+ * @param {*} [options] Override http request option.
762
+ * @throws {RequiredError}
763
+ */
764
+ async getImageExport(workspaceId, exportId, options) {
765
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getImageExport(workspaceId, exportId, options);
766
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
767
+ },
768
+ /**
769
+ * 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/image endpoint. The metadata structure is not verified.
770
+ * @summary (EXPERIMENTAL) Retrieve metadata context
771
+ * @param {string} workspaceId
772
+ * @param {string} exportId
773
+ * @param {*} [options] Override http request option.
774
+ * @throws {RequiredError}
775
+ */
776
+ async getImageExportMetadata(workspaceId, exportId, options) {
777
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getImageExportMetadata(workspaceId, exportId, options);
778
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
779
+ },
613
780
  /**
614
781
  * 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/visual endpoint. The metadata structure is not verified.
615
782
  * @summary Retrieve metadata context
@@ -688,7 +855,19 @@ export const ActionsApiFactory = function (configuration, basePath, axios) {
688
855
  */
689
856
  createDashboardExportRequest(requestParameters, options) {
690
857
  return localVarFp
691
- .createDashboardExportRequest(requestParameters.workspaceId, requestParameters.dashboardId, options)
858
+ .createDashboardExportRequest(requestParameters.workspaceId, requestParameters.dashboardId, requestParameters.dashboardTabularExportRequest, options)
859
+ .then((request) => request(axios, basePath));
860
+ },
861
+ /**
862
+ * 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.
863
+ * @summary (EXPERIMENTAL) Create image export request
864
+ * @param {ActionsApiCreateImageExportRequest} requestParameters Request parameters.
865
+ * @param {*} [options] Override http request option.
866
+ * @throws {RequiredError}
867
+ */
868
+ createImageExport(requestParameters, options) {
869
+ return localVarFp
870
+ .createImageExport(requestParameters.workspaceId, requestParameters.imageExportRequest, options)
692
871
  .then((request) => request(axios, basePath));
693
872
  },
694
873
  /**
@@ -751,6 +930,30 @@ export const ActionsApiFactory = function (configuration, basePath, axios) {
751
930
  .getExportedFile(requestParameters.workspaceId, requestParameters.exportId, options)
752
931
  .then((request) => request(axios, basePath));
753
932
  },
933
+ /**
934
+ * 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.
935
+ * @summary (EXPERIMENTAL) Retrieve exported files
936
+ * @param {ActionsApiGetImageExportRequest} requestParameters Request parameters.
937
+ * @param {*} [options] Override http request option.
938
+ * @throws {RequiredError}
939
+ */
940
+ getImageExport(requestParameters, options) {
941
+ return localVarFp
942
+ .getImageExport(requestParameters.workspaceId, requestParameters.exportId, options)
943
+ .then((request) => request(axios, basePath));
944
+ },
945
+ /**
946
+ * 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/image endpoint. The metadata structure is not verified.
947
+ * @summary (EXPERIMENTAL) Retrieve metadata context
948
+ * @param {ActionsApiGetImageExportMetadataRequest} requestParameters Request parameters.
949
+ * @param {*} [options] Override http request option.
950
+ * @throws {RequiredError}
951
+ */
952
+ getImageExportMetadata(requestParameters, options) {
953
+ return localVarFp
954
+ .getImageExportMetadata(requestParameters.workspaceId, requestParameters.exportId, options)
955
+ .then((request) => request(axios, basePath));
956
+ },
754
957
  /**
755
958
  * 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/visual endpoint. The metadata structure is not verified.
756
959
  * @summary Retrieve metadata context
@@ -830,7 +1033,20 @@ export class ActionsApi extends BaseAPI {
830
1033
  */
831
1034
  createDashboardExportRequest(requestParameters, options) {
832
1035
  return ActionsApiFp(this.configuration)
833
- .createDashboardExportRequest(requestParameters.workspaceId, requestParameters.dashboardId, options)
1036
+ .createDashboardExportRequest(requestParameters.workspaceId, requestParameters.dashboardId, requestParameters.dashboardTabularExportRequest, options)
1037
+ .then((request) => request(this.axios, this.basePath));
1038
+ }
1039
+ /**
1040
+ * 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.
1041
+ * @summary (EXPERIMENTAL) Create image export request
1042
+ * @param {ActionsApiCreateImageExportRequest} requestParameters Request parameters.
1043
+ * @param {*} [options] Override http request option.
1044
+ * @throws {RequiredError}
1045
+ * @memberof ActionsApi
1046
+ */
1047
+ createImageExport(requestParameters, options) {
1048
+ return ActionsApiFp(this.configuration)
1049
+ .createImageExport(requestParameters.workspaceId, requestParameters.imageExportRequest, options)
834
1050
  .then((request) => request(this.axios, this.basePath));
835
1051
  }
836
1052
  /**
@@ -898,6 +1114,32 @@ export class ActionsApi extends BaseAPI {
898
1114
  .getExportedFile(requestParameters.workspaceId, requestParameters.exportId, options)
899
1115
  .then((request) => request(this.axios, this.basePath));
900
1116
  }
1117
+ /**
1118
+ * 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.
1119
+ * @summary (EXPERIMENTAL) Retrieve exported files
1120
+ * @param {ActionsApiGetImageExportRequest} requestParameters Request parameters.
1121
+ * @param {*} [options] Override http request option.
1122
+ * @throws {RequiredError}
1123
+ * @memberof ActionsApi
1124
+ */
1125
+ getImageExport(requestParameters, options) {
1126
+ return ActionsApiFp(this.configuration)
1127
+ .getImageExport(requestParameters.workspaceId, requestParameters.exportId, options)
1128
+ .then((request) => request(this.axios, this.basePath));
1129
+ }
1130
+ /**
1131
+ * 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/image endpoint. The metadata structure is not verified.
1132
+ * @summary (EXPERIMENTAL) Retrieve metadata context
1133
+ * @param {ActionsApiGetImageExportMetadataRequest} requestParameters Request parameters.
1134
+ * @param {*} [options] Override http request option.
1135
+ * @throws {RequiredError}
1136
+ * @memberof ActionsApi
1137
+ */
1138
+ getImageExportMetadata(requestParameters, options) {
1139
+ return ActionsApiFp(this.configuration)
1140
+ .getImageExportMetadata(requestParameters.workspaceId, requestParameters.exportId, options)
1141
+ .then((request) => request(this.axios, this.basePath));
1142
+ }
901
1143
  /**
902
1144
  * 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/visual endpoint. The metadata structure is not verified.
903
1145
  * @summary Retrieve metadata context
@@ -964,6 +1206,266 @@ export class ActionsApi extends BaseAPI {
964
1206
  .then((request) => request(this.axios, this.basePath));
965
1207
  }
966
1208
  }
1209
+ /**
1210
+ * ImageExportApi - axios parameter creator
1211
+ * @export
1212
+ */
1213
+ export const ImageExportApiAxiosParamCreator = function (configuration) {
1214
+ return {
1215
+ /**
1216
+ * 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.
1217
+ * @summary (EXPERIMENTAL) Create image export request
1218
+ * @param {string} workspaceId
1219
+ * @param {ImageExportRequest} imageExportRequest
1220
+ * @param {*} [options] Override http request option.
1221
+ * @throws {RequiredError}
1222
+ */
1223
+ createImageExport: async (workspaceId, imageExportRequest, options = {}) => {
1224
+ // verify required parameter 'workspaceId' is not null or undefined
1225
+ assertParamExists("createImageExport", "workspaceId", workspaceId);
1226
+ // verify required parameter 'imageExportRequest' is not null or undefined
1227
+ assertParamExists("createImageExport", "imageExportRequest", imageExportRequest);
1228
+ const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/export/image`.replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)));
1229
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1230
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1231
+ let baseOptions;
1232
+ if (configuration) {
1233
+ baseOptions = configuration.baseOptions;
1234
+ }
1235
+ const localVarRequestOptions = { method: "POST", ...baseOptions, ...options };
1236
+ const localVarHeaderParameter = {};
1237
+ const localVarQueryParameter = {};
1238
+ localVarHeaderParameter["Content-Type"] = "application/json";
1239
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1240
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1241
+ localVarRequestOptions.headers = {
1242
+ ...localVarHeaderParameter,
1243
+ ...headersFromBaseOptions,
1244
+ ...options.headers,
1245
+ };
1246
+ const needsSerialization = typeof imageExportRequest !== "string" ||
1247
+ localVarRequestOptions.headers["Content-Type"] === "application/json";
1248
+ localVarRequestOptions.data = needsSerialization
1249
+ ? JSON.stringify(imageExportRequest !== undefined ? imageExportRequest : {})
1250
+ : imageExportRequest || "";
1251
+ return {
1252
+ url: toPathString(localVarUrlObj),
1253
+ options: localVarRequestOptions,
1254
+ };
1255
+ },
1256
+ /**
1257
+ * 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.
1258
+ * @summary (EXPERIMENTAL) Retrieve exported files
1259
+ * @param {string} workspaceId
1260
+ * @param {string} exportId
1261
+ * @param {*} [options] Override http request option.
1262
+ * @throws {RequiredError}
1263
+ */
1264
+ getImageExport: async (workspaceId, exportId, options = {}) => {
1265
+ // verify required parameter 'workspaceId' is not null or undefined
1266
+ assertParamExists("getImageExport", "workspaceId", workspaceId);
1267
+ // verify required parameter 'exportId' is not null or undefined
1268
+ assertParamExists("getImageExport", "exportId", exportId);
1269
+ const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/export/image/{exportId}`
1270
+ .replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)))
1271
+ .replace(`{${"exportId"}}`, encodeURIComponent(String(exportId)));
1272
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1273
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1274
+ let baseOptions;
1275
+ if (configuration) {
1276
+ baseOptions = configuration.baseOptions;
1277
+ }
1278
+ const localVarRequestOptions = { method: "GET", ...baseOptions, ...options };
1279
+ const localVarHeaderParameter = {};
1280
+ const localVarQueryParameter = {};
1281
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1282
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1283
+ localVarRequestOptions.headers = {
1284
+ ...localVarHeaderParameter,
1285
+ ...headersFromBaseOptions,
1286
+ ...options.headers,
1287
+ };
1288
+ return {
1289
+ url: toPathString(localVarUrlObj),
1290
+ options: localVarRequestOptions,
1291
+ };
1292
+ },
1293
+ /**
1294
+ * 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/image endpoint. The metadata structure is not verified.
1295
+ * @summary (EXPERIMENTAL) Retrieve metadata context
1296
+ * @param {string} workspaceId
1297
+ * @param {string} exportId
1298
+ * @param {*} [options] Override http request option.
1299
+ * @throws {RequiredError}
1300
+ */
1301
+ getImageExportMetadata: async (workspaceId, exportId, options = {}) => {
1302
+ // verify required parameter 'workspaceId' is not null or undefined
1303
+ assertParamExists("getImageExportMetadata", "workspaceId", workspaceId);
1304
+ // verify required parameter 'exportId' is not null or undefined
1305
+ assertParamExists("getImageExportMetadata", "exportId", exportId);
1306
+ const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/export/image/{exportId}/metadata`
1307
+ .replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)))
1308
+ .replace(`{${"exportId"}}`, encodeURIComponent(String(exportId)));
1309
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1310
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1311
+ let baseOptions;
1312
+ if (configuration) {
1313
+ baseOptions = configuration.baseOptions;
1314
+ }
1315
+ const localVarRequestOptions = { method: "GET", ...baseOptions, ...options };
1316
+ const localVarHeaderParameter = {};
1317
+ const localVarQueryParameter = {};
1318
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1319
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1320
+ localVarRequestOptions.headers = {
1321
+ ...localVarHeaderParameter,
1322
+ ...headersFromBaseOptions,
1323
+ ...options.headers,
1324
+ };
1325
+ return {
1326
+ url: toPathString(localVarUrlObj),
1327
+ options: localVarRequestOptions,
1328
+ };
1329
+ },
1330
+ };
1331
+ };
1332
+ /**
1333
+ * ImageExportApi - functional programming interface
1334
+ * @export
1335
+ */
1336
+ export const ImageExportApiFp = function (configuration) {
1337
+ const localVarAxiosParamCreator = ImageExportApiAxiosParamCreator(configuration);
1338
+ return {
1339
+ /**
1340
+ * 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.
1341
+ * @summary (EXPERIMENTAL) Create image export request
1342
+ * @param {string} workspaceId
1343
+ * @param {ImageExportRequest} imageExportRequest
1344
+ * @param {*} [options] Override http request option.
1345
+ * @throws {RequiredError}
1346
+ */
1347
+ async createImageExport(workspaceId, imageExportRequest, options) {
1348
+ const localVarAxiosArgs = await localVarAxiosParamCreator.createImageExport(workspaceId, imageExportRequest, options);
1349
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
1350
+ },
1351
+ /**
1352
+ * 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.
1353
+ * @summary (EXPERIMENTAL) Retrieve exported files
1354
+ * @param {string} workspaceId
1355
+ * @param {string} exportId
1356
+ * @param {*} [options] Override http request option.
1357
+ * @throws {RequiredError}
1358
+ */
1359
+ async getImageExport(workspaceId, exportId, options) {
1360
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getImageExport(workspaceId, exportId, options);
1361
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
1362
+ },
1363
+ /**
1364
+ * 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/image endpoint. The metadata structure is not verified.
1365
+ * @summary (EXPERIMENTAL) Retrieve metadata context
1366
+ * @param {string} workspaceId
1367
+ * @param {string} exportId
1368
+ * @param {*} [options] Override http request option.
1369
+ * @throws {RequiredError}
1370
+ */
1371
+ async getImageExportMetadata(workspaceId, exportId, options) {
1372
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getImageExportMetadata(workspaceId, exportId, options);
1373
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
1374
+ },
1375
+ };
1376
+ };
1377
+ /**
1378
+ * ImageExportApi - factory interface
1379
+ * @export
1380
+ */
1381
+ export const ImageExportApiFactory = function (configuration, basePath, axios) {
1382
+ const localVarFp = ImageExportApiFp(configuration);
1383
+ return {
1384
+ /**
1385
+ * 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.
1386
+ * @summary (EXPERIMENTAL) Create image export request
1387
+ * @param {ImageExportApiCreateImageExportRequest} requestParameters Request parameters.
1388
+ * @param {*} [options] Override http request option.
1389
+ * @throws {RequiredError}
1390
+ */
1391
+ createImageExport(requestParameters, options) {
1392
+ return localVarFp
1393
+ .createImageExport(requestParameters.workspaceId, requestParameters.imageExportRequest, options)
1394
+ .then((request) => request(axios, basePath));
1395
+ },
1396
+ /**
1397
+ * 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.
1398
+ * @summary (EXPERIMENTAL) Retrieve exported files
1399
+ * @param {ImageExportApiGetImageExportRequest} requestParameters Request parameters.
1400
+ * @param {*} [options] Override http request option.
1401
+ * @throws {RequiredError}
1402
+ */
1403
+ getImageExport(requestParameters, options) {
1404
+ return localVarFp
1405
+ .getImageExport(requestParameters.workspaceId, requestParameters.exportId, options)
1406
+ .then((request) => request(axios, basePath));
1407
+ },
1408
+ /**
1409
+ * 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/image endpoint. The metadata structure is not verified.
1410
+ * @summary (EXPERIMENTAL) Retrieve metadata context
1411
+ * @param {ImageExportApiGetImageExportMetadataRequest} requestParameters Request parameters.
1412
+ * @param {*} [options] Override http request option.
1413
+ * @throws {RequiredError}
1414
+ */
1415
+ getImageExportMetadata(requestParameters, options) {
1416
+ return localVarFp
1417
+ .getImageExportMetadata(requestParameters.workspaceId, requestParameters.exportId, options)
1418
+ .then((request) => request(axios, basePath));
1419
+ },
1420
+ };
1421
+ };
1422
+ /**
1423
+ * ImageExportApi - object-oriented interface
1424
+ * @export
1425
+ * @class ImageExportApi
1426
+ * @extends {BaseAPI}
1427
+ */
1428
+ export class ImageExportApi extends BaseAPI {
1429
+ /**
1430
+ * 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.
1431
+ * @summary (EXPERIMENTAL) Create image export request
1432
+ * @param {ImageExportApiCreateImageExportRequest} requestParameters Request parameters.
1433
+ * @param {*} [options] Override http request option.
1434
+ * @throws {RequiredError}
1435
+ * @memberof ImageExportApi
1436
+ */
1437
+ createImageExport(requestParameters, options) {
1438
+ return ImageExportApiFp(this.configuration)
1439
+ .createImageExport(requestParameters.workspaceId, requestParameters.imageExportRequest, options)
1440
+ .then((request) => request(this.axios, this.basePath));
1441
+ }
1442
+ /**
1443
+ * 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.
1444
+ * @summary (EXPERIMENTAL) Retrieve exported files
1445
+ * @param {ImageExportApiGetImageExportRequest} requestParameters Request parameters.
1446
+ * @param {*} [options] Override http request option.
1447
+ * @throws {RequiredError}
1448
+ * @memberof ImageExportApi
1449
+ */
1450
+ getImageExport(requestParameters, options) {
1451
+ return ImageExportApiFp(this.configuration)
1452
+ .getImageExport(requestParameters.workspaceId, requestParameters.exportId, options)
1453
+ .then((request) => request(this.axios, this.basePath));
1454
+ }
1455
+ /**
1456
+ * 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/image endpoint. The metadata structure is not verified.
1457
+ * @summary (EXPERIMENTAL) Retrieve metadata context
1458
+ * @param {ImageExportApiGetImageExportMetadataRequest} requestParameters Request parameters.
1459
+ * @param {*} [options] Override http request option.
1460
+ * @throws {RequiredError}
1461
+ * @memberof ImageExportApi
1462
+ */
1463
+ getImageExportMetadata(requestParameters, options) {
1464
+ return ImageExportApiFp(this.configuration)
1465
+ .getImageExportMetadata(requestParameters.workspaceId, requestParameters.exportId, options)
1466
+ .then((request) => request(this.axios, this.basePath));
1467
+ }
1468
+ }
967
1469
  /**
968
1470
  * RawExportApi - axios parameter creator
969
1471
  * @export
@@ -1421,14 +1923,17 @@ export const TabularExportApiAxiosParamCreator = function (configuration) {
1421
1923
  * @summary (EXPERIMENTAL) Create dashboard tabular export request
1422
1924
  * @param {string} workspaceId
1423
1925
  * @param {string} dashboardId
1926
+ * @param {DashboardTabularExportRequest} dashboardTabularExportRequest
1424
1927
  * @param {*} [options] Override http request option.
1425
1928
  * @throws {RequiredError}
1426
1929
  */
1427
- createDashboardExportRequest: async (workspaceId, dashboardId, options = {}) => {
1930
+ createDashboardExportRequest: async (workspaceId, dashboardId, dashboardTabularExportRequest, options = {}) => {
1428
1931
  // verify required parameter 'workspaceId' is not null or undefined
1429
1932
  assertParamExists("createDashboardExportRequest", "workspaceId", workspaceId);
1430
1933
  // verify required parameter 'dashboardId' is not null or undefined
1431
1934
  assertParamExists("createDashboardExportRequest", "dashboardId", dashboardId);
1935
+ // verify required parameter 'dashboardTabularExportRequest' is not null or undefined
1936
+ assertParamExists("createDashboardExportRequest", "dashboardTabularExportRequest", dashboardTabularExportRequest);
1432
1937
  const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/export/tabular`
1433
1938
  .replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)))
1434
1939
  .replace(`{${"dashboardId"}}`, encodeURIComponent(String(dashboardId)));
@@ -1441,6 +1946,7 @@ export const TabularExportApiAxiosParamCreator = function (configuration) {
1441
1946
  const localVarRequestOptions = { method: "POST", ...baseOptions, ...options };
1442
1947
  const localVarHeaderParameter = {};
1443
1948
  const localVarQueryParameter = {};
1949
+ localVarHeaderParameter["Content-Type"] = "application/json";
1444
1950
  setSearchParams(localVarUrlObj, localVarQueryParameter);
1445
1951
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1446
1952
  localVarRequestOptions.headers = {
@@ -1448,6 +1954,11 @@ export const TabularExportApiAxiosParamCreator = function (configuration) {
1448
1954
  ...headersFromBaseOptions,
1449
1955
  ...options.headers,
1450
1956
  };
1957
+ const needsSerialization = typeof dashboardTabularExportRequest !== "string" ||
1958
+ localVarRequestOptions.headers["Content-Type"] === "application/json";
1959
+ localVarRequestOptions.data = needsSerialization
1960
+ ? JSON.stringify(dashboardTabularExportRequest !== undefined ? dashboardTabularExportRequest : {})
1961
+ : dashboardTabularExportRequest || "";
1451
1962
  return {
1452
1963
  url: toPathString(localVarUrlObj),
1453
1964
  options: localVarRequestOptions,
@@ -1545,11 +2056,12 @@ export const TabularExportApiFp = function (configuration) {
1545
2056
  * @summary (EXPERIMENTAL) Create dashboard tabular export request
1546
2057
  * @param {string} workspaceId
1547
2058
  * @param {string} dashboardId
2059
+ * @param {DashboardTabularExportRequest} dashboardTabularExportRequest
1548
2060
  * @param {*} [options] Override http request option.
1549
2061
  * @throws {RequiredError}
1550
2062
  */
1551
- async createDashboardExportRequest(workspaceId, dashboardId, options) {
1552
- const localVarAxiosArgs = await localVarAxiosParamCreator.createDashboardExportRequest(workspaceId, dashboardId, options);
2063
+ async createDashboardExportRequest(workspaceId, dashboardId, dashboardTabularExportRequest, options) {
2064
+ const localVarAxiosArgs = await localVarAxiosParamCreator.createDashboardExportRequest(workspaceId, dashboardId, dashboardTabularExportRequest, options);
1553
2065
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
1554
2066
  },
1555
2067
  /**
@@ -1594,7 +2106,7 @@ export const TabularExportApiFactory = function (configuration, basePath, axios)
1594
2106
  */
1595
2107
  createDashboardExportRequest(requestParameters, options) {
1596
2108
  return localVarFp
1597
- .createDashboardExportRequest(requestParameters.workspaceId, requestParameters.dashboardId, options)
2109
+ .createDashboardExportRequest(requestParameters.workspaceId, requestParameters.dashboardId, requestParameters.dashboardTabularExportRequest, options)
1598
2110
  .then((request) => request(axios, basePath));
1599
2111
  },
1600
2112
  /**
@@ -1640,7 +2152,7 @@ export class TabularExportApi extends BaseAPI {
1640
2152
  */
1641
2153
  createDashboardExportRequest(requestParameters, options) {
1642
2154
  return TabularExportApiFp(this.configuration)
1643
- .createDashboardExportRequest(requestParameters.workspaceId, requestParameters.dashboardId, options)
2155
+ .createDashboardExportRequest(requestParameters.workspaceId, requestParameters.dashboardId, requestParameters.dashboardTabularExportRequest, options)
1644
2156
  .then((request) => request(this.axios, this.basePath));
1645
2157
  }
1646
2158
  /**