@gooddata/api-client-tiger 10.21.0-alpha.40 → 10.21.0-alpha.42
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/esm/__version.d.ts +1 -1
- package/esm/__version.js +1 -1
- package/esm/api-client-tiger.d.ts +790 -598
- package/esm/generated/afm-rest-api/api.d.ts +6 -0
- package/esm/generated/afm-rest-api/api.d.ts.map +1 -1
- package/esm/generated/afm-rest-api/api.js.map +1 -1
- package/esm/generated/afm-rest-api/openapi-spec.json +5 -1
- package/esm/generated/export-json-api/api.d.ts +447 -0
- package/esm/generated/export-json-api/api.d.ts.map +1 -1
- package/esm/generated/export-json-api/api.js +490 -0
- package/esm/generated/export-json-api/api.js.map +1 -1
- package/esm/generated/export-json-api/openapi-spec.json +174 -0
- package/esm/generated/metadata-json-api/api.d.ts +645 -592
- package/esm/generated/metadata-json-api/api.d.ts.map +1 -1
- package/esm/generated/metadata-json-api/api.js +52 -34
- package/esm/generated/metadata-json-api/api.js.map +1 -1
- package/esm/generated/metadata-json-api/openapi-spec.json +2840 -2821
- package/esm/index.d.ts +1 -1
- package/esm/index.d.ts.map +1 -1
- package/esm/index.js.map +1 -1
- package/package.json +3 -3
|
@@ -90,6 +90,10 @@ export const SimpleMeasureDefinitionMeasureAggregationEnum = {
|
|
|
90
90
|
RUNSUM: "RUNSUM",
|
|
91
91
|
APPROXIMATE_COUNT: "APPROXIMATE_COUNT",
|
|
92
92
|
};
|
|
93
|
+
export const SlideshowExportRequestFormatEnum = {
|
|
94
|
+
PDF: "PDF",
|
|
95
|
+
PPTX: "PPTX",
|
|
96
|
+
};
|
|
93
97
|
export const TabularExportRequestFormatEnum = {
|
|
94
98
|
CSV: "CSV",
|
|
95
99
|
XLSX: "XLSX",
|
|
@@ -221,6 +225,47 @@ export const ActionsApiAxiosParamCreator = function (configuration) {
|
|
|
221
225
|
options: localVarRequestOptions,
|
|
222
226
|
};
|
|
223
227
|
},
|
|
228
|
+
/**
|
|
229
|
+
* Note: This API is an experimental and is going to change. Please, use it accordingly. A slideshow 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.
|
|
230
|
+
* @summary (EXPERIMENTAL) Create slideshow export request
|
|
231
|
+
* @param {string} workspaceId
|
|
232
|
+
* @param {SlideshowExportRequest} slideshowExportRequest
|
|
233
|
+
* @param {*} [options] Override http request option.
|
|
234
|
+
* @throws {RequiredError}
|
|
235
|
+
*/
|
|
236
|
+
createSlideshowExport: async (workspaceId, slideshowExportRequest, options = {}) => {
|
|
237
|
+
// verify required parameter 'workspaceId' is not null or undefined
|
|
238
|
+
assertParamExists("createSlideshowExport", "workspaceId", workspaceId);
|
|
239
|
+
// verify required parameter 'slideshowExportRequest' is not null or undefined
|
|
240
|
+
assertParamExists("createSlideshowExport", "slideshowExportRequest", slideshowExportRequest);
|
|
241
|
+
const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/export/slideshow`.replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)));
|
|
242
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
243
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
244
|
+
let baseOptions;
|
|
245
|
+
if (configuration) {
|
|
246
|
+
baseOptions = configuration.baseOptions;
|
|
247
|
+
}
|
|
248
|
+
const localVarRequestOptions = { method: "POST", ...baseOptions, ...options };
|
|
249
|
+
const localVarHeaderParameter = {};
|
|
250
|
+
const localVarQueryParameter = {};
|
|
251
|
+
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
252
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
253
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
254
|
+
localVarRequestOptions.headers = {
|
|
255
|
+
...localVarHeaderParameter,
|
|
256
|
+
...headersFromBaseOptions,
|
|
257
|
+
...options.headers,
|
|
258
|
+
};
|
|
259
|
+
const needsSerialization = typeof slideshowExportRequest !== "string" ||
|
|
260
|
+
localVarRequestOptions.headers["Content-Type"] === "application/json";
|
|
261
|
+
localVarRequestOptions.data = needsSerialization
|
|
262
|
+
? JSON.stringify(slideshowExportRequest !== undefined ? slideshowExportRequest : {})
|
|
263
|
+
: slideshowExportRequest || "";
|
|
264
|
+
return {
|
|
265
|
+
url: toPathString(localVarUrlObj),
|
|
266
|
+
options: localVarRequestOptions,
|
|
267
|
+
};
|
|
268
|
+
},
|
|
224
269
|
/**
|
|
225
270
|
* An tabular 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.
|
|
226
271
|
* @summary Create tabular export request
|
|
@@ -336,6 +381,43 @@ export const ActionsApiAxiosParamCreator = function (configuration) {
|
|
|
336
381
|
options: localVarRequestOptions,
|
|
337
382
|
};
|
|
338
383
|
},
|
|
384
|
+
/**
|
|
385
|
+
* Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoints serves as a cache for user defined metadata for the front end ui to retrieve them, if one was created using the POST ../export/slideshow endpoint. The metadata structure is not verified. If metadata for given {exportId} has been found, endpoint returns the value 200 else 404.
|
|
386
|
+
* @summary (EXPERIMENTAL) Retrieve metadata context
|
|
387
|
+
* @param {string} workspaceId
|
|
388
|
+
* @param {string} exportId
|
|
389
|
+
* @param {*} [options] Override http request option.
|
|
390
|
+
* @throws {RequiredError}
|
|
391
|
+
*/
|
|
392
|
+
getMetadata1: async (workspaceId, exportId, options = {}) => {
|
|
393
|
+
// verify required parameter 'workspaceId' is not null or undefined
|
|
394
|
+
assertParamExists("getMetadata1", "workspaceId", workspaceId);
|
|
395
|
+
// verify required parameter 'exportId' is not null or undefined
|
|
396
|
+
assertParamExists("getMetadata1", "exportId", exportId);
|
|
397
|
+
const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/export/slideshow/{exportId}/metadata`
|
|
398
|
+
.replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)))
|
|
399
|
+
.replace(`{${"exportId"}}`, encodeURIComponent(String(exportId)));
|
|
400
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
401
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
402
|
+
let baseOptions;
|
|
403
|
+
if (configuration) {
|
|
404
|
+
baseOptions = configuration.baseOptions;
|
|
405
|
+
}
|
|
406
|
+
const localVarRequestOptions = { method: "GET", ...baseOptions, ...options };
|
|
407
|
+
const localVarHeaderParameter = {};
|
|
408
|
+
const localVarQueryParameter = {};
|
|
409
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
410
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
411
|
+
localVarRequestOptions.headers = {
|
|
412
|
+
...localVarHeaderParameter,
|
|
413
|
+
...headersFromBaseOptions,
|
|
414
|
+
...options.headers,
|
|
415
|
+
};
|
|
416
|
+
return {
|
|
417
|
+
url: toPathString(localVarUrlObj),
|
|
418
|
+
options: localVarRequestOptions,
|
|
419
|
+
};
|
|
420
|
+
},
|
|
339
421
|
/**
|
|
340
422
|
* 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.
|
|
341
423
|
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
@@ -373,6 +455,43 @@ export const ActionsApiAxiosParamCreator = function (configuration) {
|
|
|
373
455
|
options: localVarRequestOptions,
|
|
374
456
|
};
|
|
375
457
|
},
|
|
458
|
+
/**
|
|
459
|
+
* 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.
|
|
460
|
+
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
461
|
+
* @param {string} workspaceId
|
|
462
|
+
* @param {string} exportId
|
|
463
|
+
* @param {*} [options] Override http request option.
|
|
464
|
+
* @throws {RequiredError}
|
|
465
|
+
*/
|
|
466
|
+
getSlideshowExport: async (workspaceId, exportId, options = {}) => {
|
|
467
|
+
// verify required parameter 'workspaceId' is not null or undefined
|
|
468
|
+
assertParamExists("getSlideshowExport", "workspaceId", workspaceId);
|
|
469
|
+
// verify required parameter 'exportId' is not null or undefined
|
|
470
|
+
assertParamExists("getSlideshowExport", "exportId", exportId);
|
|
471
|
+
const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/export/slideshow/{exportId}`
|
|
472
|
+
.replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)))
|
|
473
|
+
.replace(`{${"exportId"}}`, encodeURIComponent(String(exportId)));
|
|
474
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
475
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
476
|
+
let baseOptions;
|
|
477
|
+
if (configuration) {
|
|
478
|
+
baseOptions = configuration.baseOptions;
|
|
479
|
+
}
|
|
480
|
+
const localVarRequestOptions = { method: "GET", ...baseOptions, ...options };
|
|
481
|
+
const localVarHeaderParameter = {};
|
|
482
|
+
const localVarQueryParameter = {};
|
|
483
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
484
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
485
|
+
localVarRequestOptions.headers = {
|
|
486
|
+
...localVarHeaderParameter,
|
|
487
|
+
...headersFromBaseOptions,
|
|
488
|
+
...options.headers,
|
|
489
|
+
};
|
|
490
|
+
return {
|
|
491
|
+
url: toPathString(localVarUrlObj),
|
|
492
|
+
options: localVarRequestOptions,
|
|
493
|
+
};
|
|
494
|
+
},
|
|
376
495
|
/**
|
|
377
496
|
* 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.
|
|
378
497
|
* @summary Retrieve exported files
|
|
@@ -455,6 +574,18 @@ export const ActionsApiFp = function (configuration) {
|
|
|
455
574
|
const localVarAxiosArgs = await localVarAxiosParamCreator.createRawExport(workspaceId, rawExportRequest, options);
|
|
456
575
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
457
576
|
},
|
|
577
|
+
/**
|
|
578
|
+
* Note: This API is an experimental and is going to change. Please, use it accordingly. A slideshow 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.
|
|
579
|
+
* @summary (EXPERIMENTAL) Create slideshow export request
|
|
580
|
+
* @param {string} workspaceId
|
|
581
|
+
* @param {SlideshowExportRequest} slideshowExportRequest
|
|
582
|
+
* @param {*} [options] Override http request option.
|
|
583
|
+
* @throws {RequiredError}
|
|
584
|
+
*/
|
|
585
|
+
async createSlideshowExport(workspaceId, slideshowExportRequest, options) {
|
|
586
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createSlideshowExport(workspaceId, slideshowExportRequest, options);
|
|
587
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
588
|
+
},
|
|
458
589
|
/**
|
|
459
590
|
* An tabular 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.
|
|
460
591
|
* @summary Create tabular export request
|
|
@@ -491,6 +622,18 @@ export const ActionsApiFp = function (configuration) {
|
|
|
491
622
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getMetadata(workspaceId, exportId, options);
|
|
492
623
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
493
624
|
},
|
|
625
|
+
/**
|
|
626
|
+
* Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoints serves as a cache for user defined metadata for the front end ui to retrieve them, if one was created using the POST ../export/slideshow endpoint. The metadata structure is not verified. If metadata for given {exportId} has been found, endpoint returns the value 200 else 404.
|
|
627
|
+
* @summary (EXPERIMENTAL) Retrieve metadata context
|
|
628
|
+
* @param {string} workspaceId
|
|
629
|
+
* @param {string} exportId
|
|
630
|
+
* @param {*} [options] Override http request option.
|
|
631
|
+
* @throws {RequiredError}
|
|
632
|
+
*/
|
|
633
|
+
async getMetadata1(workspaceId, exportId, options) {
|
|
634
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getMetadata1(workspaceId, exportId, options);
|
|
635
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
636
|
+
},
|
|
494
637
|
/**
|
|
495
638
|
* 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.
|
|
496
639
|
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
@@ -503,6 +646,18 @@ export const ActionsApiFp = function (configuration) {
|
|
|
503
646
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getRawExport(workspaceId, exportId, options);
|
|
504
647
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
505
648
|
},
|
|
649
|
+
/**
|
|
650
|
+
* 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.
|
|
651
|
+
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
652
|
+
* @param {string} workspaceId
|
|
653
|
+
* @param {string} exportId
|
|
654
|
+
* @param {*} [options] Override http request option.
|
|
655
|
+
* @throws {RequiredError}
|
|
656
|
+
*/
|
|
657
|
+
async getSlideshowExport(workspaceId, exportId, options) {
|
|
658
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getSlideshowExport(workspaceId, exportId, options);
|
|
659
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
660
|
+
},
|
|
506
661
|
/**
|
|
507
662
|
* 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.
|
|
508
663
|
* @summary Retrieve exported files
|
|
@@ -560,6 +715,18 @@ export const ActionsApiFactory = function (configuration, basePath, axios) {
|
|
|
560
715
|
.createRawExport(requestParameters.workspaceId, requestParameters.rawExportRequest, options)
|
|
561
716
|
.then((request) => request(axios, basePath));
|
|
562
717
|
},
|
|
718
|
+
/**
|
|
719
|
+
* Note: This API is an experimental and is going to change. Please, use it accordingly. A slideshow 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.
|
|
720
|
+
* @summary (EXPERIMENTAL) Create slideshow export request
|
|
721
|
+
* @param {ActionsApiCreateSlideshowExportRequest} requestParameters Request parameters.
|
|
722
|
+
* @param {*} [options] Override http request option.
|
|
723
|
+
* @throws {RequiredError}
|
|
724
|
+
*/
|
|
725
|
+
createSlideshowExport(requestParameters, options) {
|
|
726
|
+
return localVarFp
|
|
727
|
+
.createSlideshowExport(requestParameters.workspaceId, requestParameters.slideshowExportRequest, options)
|
|
728
|
+
.then((request) => request(axios, basePath));
|
|
729
|
+
},
|
|
563
730
|
/**
|
|
564
731
|
* An tabular 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.
|
|
565
732
|
* @summary Create tabular export request
|
|
@@ -596,6 +763,18 @@ export const ActionsApiFactory = function (configuration, basePath, axios) {
|
|
|
596
763
|
.getMetadata(requestParameters.workspaceId, requestParameters.exportId, options)
|
|
597
764
|
.then((request) => request(axios, basePath));
|
|
598
765
|
},
|
|
766
|
+
/**
|
|
767
|
+
* Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoints serves as a cache for user defined metadata for the front end ui to retrieve them, if one was created using the POST ../export/slideshow endpoint. The metadata structure is not verified. If metadata for given {exportId} has been found, endpoint returns the value 200 else 404.
|
|
768
|
+
* @summary (EXPERIMENTAL) Retrieve metadata context
|
|
769
|
+
* @param {ActionsApiGetMetadata1Request} requestParameters Request parameters.
|
|
770
|
+
* @param {*} [options] Override http request option.
|
|
771
|
+
* @throws {RequiredError}
|
|
772
|
+
*/
|
|
773
|
+
getMetadata1(requestParameters, options) {
|
|
774
|
+
return localVarFp
|
|
775
|
+
.getMetadata1(requestParameters.workspaceId, requestParameters.exportId, options)
|
|
776
|
+
.then((request) => request(axios, basePath));
|
|
777
|
+
},
|
|
599
778
|
/**
|
|
600
779
|
* 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.
|
|
601
780
|
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
@@ -608,6 +787,18 @@ export const ActionsApiFactory = function (configuration, basePath, axios) {
|
|
|
608
787
|
.getRawExport(requestParameters.workspaceId, requestParameters.exportId, options)
|
|
609
788
|
.then((request) => request(axios, basePath));
|
|
610
789
|
},
|
|
790
|
+
/**
|
|
791
|
+
* 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.
|
|
792
|
+
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
793
|
+
* @param {ActionsApiGetSlideshowExportRequest} requestParameters Request parameters.
|
|
794
|
+
* @param {*} [options] Override http request option.
|
|
795
|
+
* @throws {RequiredError}
|
|
796
|
+
*/
|
|
797
|
+
getSlideshowExport(requestParameters, options) {
|
|
798
|
+
return localVarFp
|
|
799
|
+
.getSlideshowExport(requestParameters.workspaceId, requestParameters.exportId, options)
|
|
800
|
+
.then((request) => request(axios, basePath));
|
|
801
|
+
},
|
|
611
802
|
/**
|
|
612
803
|
* 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.
|
|
613
804
|
* @summary Retrieve exported files
|
|
@@ -668,6 +859,19 @@ export class ActionsApi extends BaseAPI {
|
|
|
668
859
|
.createRawExport(requestParameters.workspaceId, requestParameters.rawExportRequest, options)
|
|
669
860
|
.then((request) => request(this.axios, this.basePath));
|
|
670
861
|
}
|
|
862
|
+
/**
|
|
863
|
+
* Note: This API is an experimental and is going to change. Please, use it accordingly. A slideshow 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.
|
|
864
|
+
* @summary (EXPERIMENTAL) Create slideshow export request
|
|
865
|
+
* @param {ActionsApiCreateSlideshowExportRequest} requestParameters Request parameters.
|
|
866
|
+
* @param {*} [options] Override http request option.
|
|
867
|
+
* @throws {RequiredError}
|
|
868
|
+
* @memberof ActionsApi
|
|
869
|
+
*/
|
|
870
|
+
createSlideshowExport(requestParameters, options) {
|
|
871
|
+
return ActionsApiFp(this.configuration)
|
|
872
|
+
.createSlideshowExport(requestParameters.workspaceId, requestParameters.slideshowExportRequest, options)
|
|
873
|
+
.then((request) => request(this.axios, this.basePath));
|
|
874
|
+
}
|
|
671
875
|
/**
|
|
672
876
|
* An tabular 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.
|
|
673
877
|
* @summary Create tabular export request
|
|
@@ -707,6 +911,19 @@ export class ActionsApi extends BaseAPI {
|
|
|
707
911
|
.getMetadata(requestParameters.workspaceId, requestParameters.exportId, options)
|
|
708
912
|
.then((request) => request(this.axios, this.basePath));
|
|
709
913
|
}
|
|
914
|
+
/**
|
|
915
|
+
* Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoints serves as a cache for user defined metadata for the front end ui to retrieve them, if one was created using the POST ../export/slideshow endpoint. The metadata structure is not verified. If metadata for given {exportId} has been found, endpoint returns the value 200 else 404.
|
|
916
|
+
* @summary (EXPERIMENTAL) Retrieve metadata context
|
|
917
|
+
* @param {ActionsApiGetMetadata1Request} requestParameters Request parameters.
|
|
918
|
+
* @param {*} [options] Override http request option.
|
|
919
|
+
* @throws {RequiredError}
|
|
920
|
+
* @memberof ActionsApi
|
|
921
|
+
*/
|
|
922
|
+
getMetadata1(requestParameters, options) {
|
|
923
|
+
return ActionsApiFp(this.configuration)
|
|
924
|
+
.getMetadata1(requestParameters.workspaceId, requestParameters.exportId, options)
|
|
925
|
+
.then((request) => request(this.axios, this.basePath));
|
|
926
|
+
}
|
|
710
927
|
/**
|
|
711
928
|
* 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.
|
|
712
929
|
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
@@ -720,6 +937,19 @@ export class ActionsApi extends BaseAPI {
|
|
|
720
937
|
.getRawExport(requestParameters.workspaceId, requestParameters.exportId, options)
|
|
721
938
|
.then((request) => request(this.axios, this.basePath));
|
|
722
939
|
}
|
|
940
|
+
/**
|
|
941
|
+
* 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.
|
|
942
|
+
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
943
|
+
* @param {ActionsApiGetSlideshowExportRequest} requestParameters Request parameters.
|
|
944
|
+
* @param {*} [options] Override http request option.
|
|
945
|
+
* @throws {RequiredError}
|
|
946
|
+
* @memberof ActionsApi
|
|
947
|
+
*/
|
|
948
|
+
getSlideshowExport(requestParameters, options) {
|
|
949
|
+
return ActionsApiFp(this.configuration)
|
|
950
|
+
.getSlideshowExport(requestParameters.workspaceId, requestParameters.exportId, options)
|
|
951
|
+
.then((request) => request(this.axios, this.basePath));
|
|
952
|
+
}
|
|
723
953
|
/**
|
|
724
954
|
* 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.
|
|
725
955
|
* @summary Retrieve exported files
|
|
@@ -920,6 +1150,266 @@ export class RawExportApi extends BaseAPI {
|
|
|
920
1150
|
.then((request) => request(this.axios, this.basePath));
|
|
921
1151
|
}
|
|
922
1152
|
}
|
|
1153
|
+
/**
|
|
1154
|
+
* SlideshowExportApi - axios parameter creator
|
|
1155
|
+
* @export
|
|
1156
|
+
*/
|
|
1157
|
+
export const SlideshowExportApiAxiosParamCreator = function (configuration) {
|
|
1158
|
+
return {
|
|
1159
|
+
/**
|
|
1160
|
+
* Note: This API is an experimental and is going to change. Please, use it accordingly. A slideshow 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.
|
|
1161
|
+
* @summary (EXPERIMENTAL) Create slideshow export request
|
|
1162
|
+
* @param {string} workspaceId
|
|
1163
|
+
* @param {SlideshowExportRequest} slideshowExportRequest
|
|
1164
|
+
* @param {*} [options] Override http request option.
|
|
1165
|
+
* @throws {RequiredError}
|
|
1166
|
+
*/
|
|
1167
|
+
createSlideshowExport: async (workspaceId, slideshowExportRequest, options = {}) => {
|
|
1168
|
+
// verify required parameter 'workspaceId' is not null or undefined
|
|
1169
|
+
assertParamExists("createSlideshowExport", "workspaceId", workspaceId);
|
|
1170
|
+
// verify required parameter 'slideshowExportRequest' is not null or undefined
|
|
1171
|
+
assertParamExists("createSlideshowExport", "slideshowExportRequest", slideshowExportRequest);
|
|
1172
|
+
const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/export/slideshow`.replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)));
|
|
1173
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1174
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1175
|
+
let baseOptions;
|
|
1176
|
+
if (configuration) {
|
|
1177
|
+
baseOptions = configuration.baseOptions;
|
|
1178
|
+
}
|
|
1179
|
+
const localVarRequestOptions = { method: "POST", ...baseOptions, ...options };
|
|
1180
|
+
const localVarHeaderParameter = {};
|
|
1181
|
+
const localVarQueryParameter = {};
|
|
1182
|
+
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
1183
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1184
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1185
|
+
localVarRequestOptions.headers = {
|
|
1186
|
+
...localVarHeaderParameter,
|
|
1187
|
+
...headersFromBaseOptions,
|
|
1188
|
+
...options.headers,
|
|
1189
|
+
};
|
|
1190
|
+
const needsSerialization = typeof slideshowExportRequest !== "string" ||
|
|
1191
|
+
localVarRequestOptions.headers["Content-Type"] === "application/json";
|
|
1192
|
+
localVarRequestOptions.data = needsSerialization
|
|
1193
|
+
? JSON.stringify(slideshowExportRequest !== undefined ? slideshowExportRequest : {})
|
|
1194
|
+
: slideshowExportRequest || "";
|
|
1195
|
+
return {
|
|
1196
|
+
url: toPathString(localVarUrlObj),
|
|
1197
|
+
options: localVarRequestOptions,
|
|
1198
|
+
};
|
|
1199
|
+
},
|
|
1200
|
+
/**
|
|
1201
|
+
* Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoints serves as a cache for user defined metadata for the front end ui to retrieve them, if one was created using the POST ../export/slideshow endpoint. The metadata structure is not verified. If metadata for given {exportId} has been found, endpoint returns the value 200 else 404.
|
|
1202
|
+
* @summary (EXPERIMENTAL) Retrieve metadata context
|
|
1203
|
+
* @param {string} workspaceId
|
|
1204
|
+
* @param {string} exportId
|
|
1205
|
+
* @param {*} [options] Override http request option.
|
|
1206
|
+
* @throws {RequiredError}
|
|
1207
|
+
*/
|
|
1208
|
+
getMetadata1: async (workspaceId, exportId, options = {}) => {
|
|
1209
|
+
// verify required parameter 'workspaceId' is not null or undefined
|
|
1210
|
+
assertParamExists("getMetadata1", "workspaceId", workspaceId);
|
|
1211
|
+
// verify required parameter 'exportId' is not null or undefined
|
|
1212
|
+
assertParamExists("getMetadata1", "exportId", exportId);
|
|
1213
|
+
const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/export/slideshow/{exportId}/metadata`
|
|
1214
|
+
.replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)))
|
|
1215
|
+
.replace(`{${"exportId"}}`, encodeURIComponent(String(exportId)));
|
|
1216
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1217
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1218
|
+
let baseOptions;
|
|
1219
|
+
if (configuration) {
|
|
1220
|
+
baseOptions = configuration.baseOptions;
|
|
1221
|
+
}
|
|
1222
|
+
const localVarRequestOptions = { method: "GET", ...baseOptions, ...options };
|
|
1223
|
+
const localVarHeaderParameter = {};
|
|
1224
|
+
const localVarQueryParameter = {};
|
|
1225
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1226
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1227
|
+
localVarRequestOptions.headers = {
|
|
1228
|
+
...localVarHeaderParameter,
|
|
1229
|
+
...headersFromBaseOptions,
|
|
1230
|
+
...options.headers,
|
|
1231
|
+
};
|
|
1232
|
+
return {
|
|
1233
|
+
url: toPathString(localVarUrlObj),
|
|
1234
|
+
options: localVarRequestOptions,
|
|
1235
|
+
};
|
|
1236
|
+
},
|
|
1237
|
+
/**
|
|
1238
|
+
* 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.
|
|
1239
|
+
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
1240
|
+
* @param {string} workspaceId
|
|
1241
|
+
* @param {string} exportId
|
|
1242
|
+
* @param {*} [options] Override http request option.
|
|
1243
|
+
* @throws {RequiredError}
|
|
1244
|
+
*/
|
|
1245
|
+
getSlideshowExport: async (workspaceId, exportId, options = {}) => {
|
|
1246
|
+
// verify required parameter 'workspaceId' is not null or undefined
|
|
1247
|
+
assertParamExists("getSlideshowExport", "workspaceId", workspaceId);
|
|
1248
|
+
// verify required parameter 'exportId' is not null or undefined
|
|
1249
|
+
assertParamExists("getSlideshowExport", "exportId", exportId);
|
|
1250
|
+
const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/export/slideshow/{exportId}`
|
|
1251
|
+
.replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)))
|
|
1252
|
+
.replace(`{${"exportId"}}`, encodeURIComponent(String(exportId)));
|
|
1253
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1254
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1255
|
+
let baseOptions;
|
|
1256
|
+
if (configuration) {
|
|
1257
|
+
baseOptions = configuration.baseOptions;
|
|
1258
|
+
}
|
|
1259
|
+
const localVarRequestOptions = { method: "GET", ...baseOptions, ...options };
|
|
1260
|
+
const localVarHeaderParameter = {};
|
|
1261
|
+
const localVarQueryParameter = {};
|
|
1262
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1263
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1264
|
+
localVarRequestOptions.headers = {
|
|
1265
|
+
...localVarHeaderParameter,
|
|
1266
|
+
...headersFromBaseOptions,
|
|
1267
|
+
...options.headers,
|
|
1268
|
+
};
|
|
1269
|
+
return {
|
|
1270
|
+
url: toPathString(localVarUrlObj),
|
|
1271
|
+
options: localVarRequestOptions,
|
|
1272
|
+
};
|
|
1273
|
+
},
|
|
1274
|
+
};
|
|
1275
|
+
};
|
|
1276
|
+
/**
|
|
1277
|
+
* SlideshowExportApi - functional programming interface
|
|
1278
|
+
* @export
|
|
1279
|
+
*/
|
|
1280
|
+
export const SlideshowExportApiFp = function (configuration) {
|
|
1281
|
+
const localVarAxiosParamCreator = SlideshowExportApiAxiosParamCreator(configuration);
|
|
1282
|
+
return {
|
|
1283
|
+
/**
|
|
1284
|
+
* Note: This API is an experimental and is going to change. Please, use it accordingly. A slideshow 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.
|
|
1285
|
+
* @summary (EXPERIMENTAL) Create slideshow export request
|
|
1286
|
+
* @param {string} workspaceId
|
|
1287
|
+
* @param {SlideshowExportRequest} slideshowExportRequest
|
|
1288
|
+
* @param {*} [options] Override http request option.
|
|
1289
|
+
* @throws {RequiredError}
|
|
1290
|
+
*/
|
|
1291
|
+
async createSlideshowExport(workspaceId, slideshowExportRequest, options) {
|
|
1292
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createSlideshowExport(workspaceId, slideshowExportRequest, options);
|
|
1293
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1294
|
+
},
|
|
1295
|
+
/**
|
|
1296
|
+
* Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoints serves as a cache for user defined metadata for the front end ui to retrieve them, if one was created using the POST ../export/slideshow endpoint. The metadata structure is not verified. If metadata for given {exportId} has been found, endpoint returns the value 200 else 404.
|
|
1297
|
+
* @summary (EXPERIMENTAL) Retrieve metadata context
|
|
1298
|
+
* @param {string} workspaceId
|
|
1299
|
+
* @param {string} exportId
|
|
1300
|
+
* @param {*} [options] Override http request option.
|
|
1301
|
+
* @throws {RequiredError}
|
|
1302
|
+
*/
|
|
1303
|
+
async getMetadata1(workspaceId, exportId, options) {
|
|
1304
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getMetadata1(workspaceId, exportId, options);
|
|
1305
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1306
|
+
},
|
|
1307
|
+
/**
|
|
1308
|
+
* 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.
|
|
1309
|
+
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
1310
|
+
* @param {string} workspaceId
|
|
1311
|
+
* @param {string} exportId
|
|
1312
|
+
* @param {*} [options] Override http request option.
|
|
1313
|
+
* @throws {RequiredError}
|
|
1314
|
+
*/
|
|
1315
|
+
async getSlideshowExport(workspaceId, exportId, options) {
|
|
1316
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getSlideshowExport(workspaceId, exportId, options);
|
|
1317
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1318
|
+
},
|
|
1319
|
+
};
|
|
1320
|
+
};
|
|
1321
|
+
/**
|
|
1322
|
+
* SlideshowExportApi - factory interface
|
|
1323
|
+
* @export
|
|
1324
|
+
*/
|
|
1325
|
+
export const SlideshowExportApiFactory = function (configuration, basePath, axios) {
|
|
1326
|
+
const localVarFp = SlideshowExportApiFp(configuration);
|
|
1327
|
+
return {
|
|
1328
|
+
/**
|
|
1329
|
+
* Note: This API is an experimental and is going to change. Please, use it accordingly. A slideshow 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.
|
|
1330
|
+
* @summary (EXPERIMENTAL) Create slideshow export request
|
|
1331
|
+
* @param {SlideshowExportApiCreateSlideshowExportRequest} requestParameters Request parameters.
|
|
1332
|
+
* @param {*} [options] Override http request option.
|
|
1333
|
+
* @throws {RequiredError}
|
|
1334
|
+
*/
|
|
1335
|
+
createSlideshowExport(requestParameters, options) {
|
|
1336
|
+
return localVarFp
|
|
1337
|
+
.createSlideshowExport(requestParameters.workspaceId, requestParameters.slideshowExportRequest, options)
|
|
1338
|
+
.then((request) => request(axios, basePath));
|
|
1339
|
+
},
|
|
1340
|
+
/**
|
|
1341
|
+
* Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoints serves as a cache for user defined metadata for the front end ui to retrieve them, if one was created using the POST ../export/slideshow endpoint. The metadata structure is not verified. If metadata for given {exportId} has been found, endpoint returns the value 200 else 404.
|
|
1342
|
+
* @summary (EXPERIMENTAL) Retrieve metadata context
|
|
1343
|
+
* @param {SlideshowExportApiGetMetadata1Request} requestParameters Request parameters.
|
|
1344
|
+
* @param {*} [options] Override http request option.
|
|
1345
|
+
* @throws {RequiredError}
|
|
1346
|
+
*/
|
|
1347
|
+
getMetadata1(requestParameters, options) {
|
|
1348
|
+
return localVarFp
|
|
1349
|
+
.getMetadata1(requestParameters.workspaceId, requestParameters.exportId, options)
|
|
1350
|
+
.then((request) => request(axios, basePath));
|
|
1351
|
+
},
|
|
1352
|
+
/**
|
|
1353
|
+
* 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.
|
|
1354
|
+
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
1355
|
+
* @param {SlideshowExportApiGetSlideshowExportRequest} requestParameters Request parameters.
|
|
1356
|
+
* @param {*} [options] Override http request option.
|
|
1357
|
+
* @throws {RequiredError}
|
|
1358
|
+
*/
|
|
1359
|
+
getSlideshowExport(requestParameters, options) {
|
|
1360
|
+
return localVarFp
|
|
1361
|
+
.getSlideshowExport(requestParameters.workspaceId, requestParameters.exportId, options)
|
|
1362
|
+
.then((request) => request(axios, basePath));
|
|
1363
|
+
},
|
|
1364
|
+
};
|
|
1365
|
+
};
|
|
1366
|
+
/**
|
|
1367
|
+
* SlideshowExportApi - object-oriented interface
|
|
1368
|
+
* @export
|
|
1369
|
+
* @class SlideshowExportApi
|
|
1370
|
+
* @extends {BaseAPI}
|
|
1371
|
+
*/
|
|
1372
|
+
export class SlideshowExportApi extends BaseAPI {
|
|
1373
|
+
/**
|
|
1374
|
+
* Note: This API is an experimental and is going to change. Please, use it accordingly. A slideshow 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.
|
|
1375
|
+
* @summary (EXPERIMENTAL) Create slideshow export request
|
|
1376
|
+
* @param {SlideshowExportApiCreateSlideshowExportRequest} requestParameters Request parameters.
|
|
1377
|
+
* @param {*} [options] Override http request option.
|
|
1378
|
+
* @throws {RequiredError}
|
|
1379
|
+
* @memberof SlideshowExportApi
|
|
1380
|
+
*/
|
|
1381
|
+
createSlideshowExport(requestParameters, options) {
|
|
1382
|
+
return SlideshowExportApiFp(this.configuration)
|
|
1383
|
+
.createSlideshowExport(requestParameters.workspaceId, requestParameters.slideshowExportRequest, options)
|
|
1384
|
+
.then((request) => request(this.axios, this.basePath));
|
|
1385
|
+
}
|
|
1386
|
+
/**
|
|
1387
|
+
* Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoints serves as a cache for user defined metadata for the front end ui to retrieve them, if one was created using the POST ../export/slideshow endpoint. The metadata structure is not verified. If metadata for given {exportId} has been found, endpoint returns the value 200 else 404.
|
|
1388
|
+
* @summary (EXPERIMENTAL) Retrieve metadata context
|
|
1389
|
+
* @param {SlideshowExportApiGetMetadata1Request} requestParameters Request parameters.
|
|
1390
|
+
* @param {*} [options] Override http request option.
|
|
1391
|
+
* @throws {RequiredError}
|
|
1392
|
+
* @memberof SlideshowExportApi
|
|
1393
|
+
*/
|
|
1394
|
+
getMetadata1(requestParameters, options) {
|
|
1395
|
+
return SlideshowExportApiFp(this.configuration)
|
|
1396
|
+
.getMetadata1(requestParameters.workspaceId, requestParameters.exportId, options)
|
|
1397
|
+
.then((request) => request(this.axios, this.basePath));
|
|
1398
|
+
}
|
|
1399
|
+
/**
|
|
1400
|
+
* 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.
|
|
1401
|
+
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
1402
|
+
* @param {SlideshowExportApiGetSlideshowExportRequest} requestParameters Request parameters.
|
|
1403
|
+
* @param {*} [options] Override http request option.
|
|
1404
|
+
* @throws {RequiredError}
|
|
1405
|
+
* @memberof SlideshowExportApi
|
|
1406
|
+
*/
|
|
1407
|
+
getSlideshowExport(requestParameters, options) {
|
|
1408
|
+
return SlideshowExportApiFp(this.configuration)
|
|
1409
|
+
.getSlideshowExport(requestParameters.workspaceId, requestParameters.exportId, options)
|
|
1410
|
+
.then((request) => request(this.axios, this.basePath));
|
|
1411
|
+
}
|
|
1412
|
+
}
|
|
923
1413
|
/**
|
|
924
1414
|
* TabularExportApi - axios parameter creator
|
|
925
1415
|
* @export
|