@gooddata/api-client-tiger 10.21.0-alpha.8 → 10.21.0-beta.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/esm/__version.d.ts +1 -1
- package/esm/__version.d.ts.map +1 -1
- package/esm/__version.js +1 -1
- package/esm/__version.js.map +1 -1
- package/esm/api-client-tiger.d.ts +2689 -1313
- package/esm/client.d.ts +3 -3
- package/esm/client.d.ts.map +1 -1
- package/esm/client.js +3 -3
- package/esm/client.js.map +1 -1
- package/esm/export.d.ts +3 -3
- package/esm/export.d.ts.map +1 -1
- package/esm/export.js +2 -2
- package/esm/export.js.map +1 -1
- 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 +1 -1
- package/esm/generated/afm-rest-api/api.js.map +1 -1
- package/esm/generated/afm-rest-api/openapi-spec.json +6 -2
- package/esm/generated/auth-json-api/api.js +1 -1
- package/esm/generated/automation-json-api/api.js +1 -1
- package/esm/generated/automation-json-api/api.js.map +1 -1
- package/esm/generated/automation-json-api/base.js +1 -1
- package/esm/generated/automation-json-api/common.js +1 -1
- package/esm/generated/automation-json-api/configuration.js +1 -1
- package/esm/generated/automation-json-api/index.js +1 -1
- package/esm/generated/export-json-api/api.d.ts +2257 -345
- package/esm/generated/export-json-api/api.d.ts.map +1 -1
- package/esm/generated/export-json-api/api.js +1251 -193
- package/esm/generated/export-json-api/api.js.map +1 -1
- package/esm/generated/export-json-api/openapi-spec.json +1261 -87
- package/esm/generated/metadata-json-api/api.d.ts +1309 -1277
- package/esm/generated/metadata-json-api/api.d.ts.map +1 -1
- package/esm/generated/metadata-json-api/api.js +52 -31
- package/esm/generated/metadata-json-api/api.js.map +1 -1
- package/esm/generated/metadata-json-api/openapi-spec.json +6188 -6182
- package/esm/generated/scan-json-api/api.js +1 -1
- 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
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// (C)
|
|
1
|
+
// (C) 2025 GoodData Corporation
|
|
2
2
|
import globalAxios from "axios";
|
|
3
3
|
// Some imports not used depending on template conditions, we also need prettier-ignore so that the import does not get split and ts-ignore still works
|
|
4
4
|
// prettier-ignore
|
|
@@ -8,6 +8,92 @@ import { DUMMY_BASE_URL, assertParamExists, setSearchParams, toPathString, creat
|
|
|
8
8
|
// prettier-ignore
|
|
9
9
|
// @ts-ignore
|
|
10
10
|
import { BASE_PATH, BaseAPI } from './base.js';
|
|
11
|
+
export const AfmObjectIdentifierAttributeIdentifierTypeEnum = {
|
|
12
|
+
ATTRIBUTE: "attribute",
|
|
13
|
+
};
|
|
14
|
+
export const AfmObjectIdentifierCoreIdentifierTypeEnum = {
|
|
15
|
+
ATTRIBUTE: "attribute",
|
|
16
|
+
LABEL: "label",
|
|
17
|
+
FACT: "fact",
|
|
18
|
+
METRIC: "metric",
|
|
19
|
+
};
|
|
20
|
+
export const AfmObjectIdentifierDatasetIdentifierTypeEnum = {
|
|
21
|
+
DATASET: "dataset",
|
|
22
|
+
};
|
|
23
|
+
export const AfmObjectIdentifierIdentifierTypeEnum = {
|
|
24
|
+
ANALYTICAL_DASHBOARD: "analyticalDashboard",
|
|
25
|
+
ATTRIBUTE: "attribute",
|
|
26
|
+
DASHBOARD_PLUGIN: "dashboardPlugin",
|
|
27
|
+
DATASET: "dataset",
|
|
28
|
+
FACT: "fact",
|
|
29
|
+
LABEL: "label",
|
|
30
|
+
METRIC: "metric",
|
|
31
|
+
PROMPT: "prompt",
|
|
32
|
+
VISUALIZATION_OBJECT: "visualizationObject",
|
|
33
|
+
FILTER_CONTEXT: "filterContext",
|
|
34
|
+
};
|
|
35
|
+
export const AfmObjectIdentifierLabelIdentifierTypeEnum = {
|
|
36
|
+
LABEL: "label",
|
|
37
|
+
};
|
|
38
|
+
export const ArithmeticMeasureDefinitionArithmeticMeasureOperatorEnum = {
|
|
39
|
+
SUM: "SUM",
|
|
40
|
+
DIFFERENCE: "DIFFERENCE",
|
|
41
|
+
MULTIPLICATION: "MULTIPLICATION",
|
|
42
|
+
RATIO: "RATIO",
|
|
43
|
+
CHANGE: "CHANGE",
|
|
44
|
+
};
|
|
45
|
+
export const ComparisonMeasureValueFilterComparisonMeasureValueFilterOperatorEnum = {
|
|
46
|
+
GREATER_THAN: "GREATER_THAN",
|
|
47
|
+
GREATER_THAN_OR_EQUAL_TO: "GREATER_THAN_OR_EQUAL_TO",
|
|
48
|
+
LESS_THAN: "LESS_THAN",
|
|
49
|
+
LESS_THAN_OR_EQUAL_TO: "LESS_THAN_OR_EQUAL_TO",
|
|
50
|
+
EQUAL_TO: "EQUAL_TO",
|
|
51
|
+
NOT_EQUAL_TO: "NOT_EQUAL_TO",
|
|
52
|
+
};
|
|
53
|
+
export const RangeMeasureValueFilterRangeMeasureValueFilterOperatorEnum = {
|
|
54
|
+
BETWEEN: "BETWEEN",
|
|
55
|
+
NOT_BETWEEN: "NOT_BETWEEN",
|
|
56
|
+
};
|
|
57
|
+
export const RankingFilterRankingFilterOperatorEnum = {
|
|
58
|
+
TOP: "TOP",
|
|
59
|
+
BOTTOM: "BOTTOM",
|
|
60
|
+
};
|
|
61
|
+
export const RawExportRequestFormatEnum = {
|
|
62
|
+
ARROW_FILE: "ARROW_FILE",
|
|
63
|
+
ARROW_STREAM: "ARROW_STREAM",
|
|
64
|
+
CSV: "CSV",
|
|
65
|
+
};
|
|
66
|
+
export const RelativeDateFilterRelativeDateFilterGranularityEnum = {
|
|
67
|
+
MINUTE: "MINUTE",
|
|
68
|
+
HOUR: "HOUR",
|
|
69
|
+
DAY: "DAY",
|
|
70
|
+
WEEK: "WEEK",
|
|
71
|
+
MONTH: "MONTH",
|
|
72
|
+
QUARTER: "QUARTER",
|
|
73
|
+
YEAR: "YEAR",
|
|
74
|
+
MINUTE_OF_HOUR: "MINUTE_OF_HOUR",
|
|
75
|
+
HOUR_OF_DAY: "HOUR_OF_DAY",
|
|
76
|
+
DAY_OF_WEEK: "DAY_OF_WEEK",
|
|
77
|
+
DAY_OF_MONTH: "DAY_OF_MONTH",
|
|
78
|
+
DAY_OF_YEAR: "DAY_OF_YEAR",
|
|
79
|
+
WEEK_OF_YEAR: "WEEK_OF_YEAR",
|
|
80
|
+
MONTH_OF_YEAR: "MONTH_OF_YEAR",
|
|
81
|
+
QUARTER_OF_YEAR: "QUARTER_OF_YEAR",
|
|
82
|
+
};
|
|
83
|
+
export const SimpleMeasureDefinitionMeasureAggregationEnum = {
|
|
84
|
+
SUM: "SUM",
|
|
85
|
+
COUNT: "COUNT",
|
|
86
|
+
AVG: "AVG",
|
|
87
|
+
MIN: "MIN",
|
|
88
|
+
MAX: "MAX",
|
|
89
|
+
MEDIAN: "MEDIAN",
|
|
90
|
+
RUNSUM: "RUNSUM",
|
|
91
|
+
APPROXIMATE_COUNT: "APPROXIMATE_COUNT",
|
|
92
|
+
};
|
|
93
|
+
export const SlideshowExportRequestFormatEnum = {
|
|
94
|
+
PDF: "PDF",
|
|
95
|
+
PPTX: "PPTX",
|
|
96
|
+
};
|
|
11
97
|
export const TabularExportRequestFormatEnum = {
|
|
12
98
|
CSV: "CSV",
|
|
13
99
|
XLSX: "XLSX",
|
|
@@ -20,6 +106,43 @@ export const TabularExportRequestFormatEnum = {
|
|
|
20
106
|
*/
|
|
21
107
|
export const ActionsApiAxiosParamCreator = function (configuration) {
|
|
22
108
|
return {
|
|
109
|
+
/**
|
|
110
|
+
* Note: This API is an experimental and is going to change. Please, use it accordingly.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.
|
|
111
|
+
* @summary (EXPERIMENTAL) Create dashboard tabular export request
|
|
112
|
+
* @param {string} workspaceId
|
|
113
|
+
* @param {string} dashboardId
|
|
114
|
+
* @param {*} [options] Override http request option.
|
|
115
|
+
* @throws {RequiredError}
|
|
116
|
+
*/
|
|
117
|
+
createDashboardExportRequest: async (workspaceId, dashboardId, options = {}) => {
|
|
118
|
+
// verify required parameter 'workspaceId' is not null or undefined
|
|
119
|
+
assertParamExists("createDashboardExportRequest", "workspaceId", workspaceId);
|
|
120
|
+
// verify required parameter 'dashboardId' is not null or undefined
|
|
121
|
+
assertParamExists("createDashboardExportRequest", "dashboardId", dashboardId);
|
|
122
|
+
const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/export/tabular`
|
|
123
|
+
.replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)))
|
|
124
|
+
.replace(`{${"dashboardId"}}`, encodeURIComponent(String(dashboardId)));
|
|
125
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
126
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
127
|
+
let baseOptions;
|
|
128
|
+
if (configuration) {
|
|
129
|
+
baseOptions = configuration.baseOptions;
|
|
130
|
+
}
|
|
131
|
+
const localVarRequestOptions = { method: "POST", ...baseOptions, ...options };
|
|
132
|
+
const localVarHeaderParameter = {};
|
|
133
|
+
const localVarQueryParameter = {};
|
|
134
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
135
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
136
|
+
localVarRequestOptions.headers = {
|
|
137
|
+
...localVarHeaderParameter,
|
|
138
|
+
...headersFromBaseOptions,
|
|
139
|
+
...options.headers,
|
|
140
|
+
};
|
|
141
|
+
return {
|
|
142
|
+
url: toPathString(localVarUrlObj),
|
|
143
|
+
options: localVarRequestOptions,
|
|
144
|
+
};
|
|
145
|
+
},
|
|
23
146
|
/**
|
|
24
147
|
* An visual 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.
|
|
25
148
|
* @summary Create visual - pdf export request
|
|
@@ -62,19 +185,991 @@ export const ActionsApiAxiosParamCreator = function (configuration) {
|
|
|
62
185
|
};
|
|
63
186
|
},
|
|
64
187
|
/**
|
|
65
|
-
* An
|
|
66
|
-
* @summary Create
|
|
188
|
+
* Note: This API is an experimental and is going to change. Please, use it accordingly.An raw 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.
|
|
189
|
+
* @summary (EXPERIMENTAL) Create raw export request
|
|
190
|
+
* @param {string} workspaceId
|
|
191
|
+
* @param {RawExportRequest} rawExportRequest
|
|
192
|
+
* @param {*} [options] Override http request option.
|
|
193
|
+
* @throws {RequiredError}
|
|
194
|
+
*/
|
|
195
|
+
createRawExport: async (workspaceId, rawExportRequest, options = {}) => {
|
|
196
|
+
// verify required parameter 'workspaceId' is not null or undefined
|
|
197
|
+
assertParamExists("createRawExport", "workspaceId", workspaceId);
|
|
198
|
+
// verify required parameter 'rawExportRequest' is not null or undefined
|
|
199
|
+
assertParamExists("createRawExport", "rawExportRequest", rawExportRequest);
|
|
200
|
+
const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/export/raw`.replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)));
|
|
201
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
202
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
203
|
+
let baseOptions;
|
|
204
|
+
if (configuration) {
|
|
205
|
+
baseOptions = configuration.baseOptions;
|
|
206
|
+
}
|
|
207
|
+
const localVarRequestOptions = { method: "POST", ...baseOptions, ...options };
|
|
208
|
+
const localVarHeaderParameter = {};
|
|
209
|
+
const localVarQueryParameter = {};
|
|
210
|
+
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
211
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
212
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
213
|
+
localVarRequestOptions.headers = {
|
|
214
|
+
...localVarHeaderParameter,
|
|
215
|
+
...headersFromBaseOptions,
|
|
216
|
+
...options.headers,
|
|
217
|
+
};
|
|
218
|
+
const needsSerialization = typeof rawExportRequest !== "string" ||
|
|
219
|
+
localVarRequestOptions.headers["Content-Type"] === "application/json";
|
|
220
|
+
localVarRequestOptions.data = needsSerialization
|
|
221
|
+
? JSON.stringify(rawExportRequest !== undefined ? rawExportRequest : {})
|
|
222
|
+
: rawExportRequest || "";
|
|
223
|
+
return {
|
|
224
|
+
url: toPathString(localVarUrlObj),
|
|
225
|
+
options: localVarRequestOptions,
|
|
226
|
+
};
|
|
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
|
+
},
|
|
269
|
+
/**
|
|
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.
|
|
271
|
+
* @summary Create tabular export request
|
|
272
|
+
* @param {string} workspaceId
|
|
273
|
+
* @param {TabularExportRequest} tabularExportRequest
|
|
274
|
+
* @param {*} [options] Override http request option.
|
|
275
|
+
* @throws {RequiredError}
|
|
276
|
+
*/
|
|
277
|
+
createTabularExport: async (workspaceId, tabularExportRequest, options = {}) => {
|
|
278
|
+
// verify required parameter 'workspaceId' is not null or undefined
|
|
279
|
+
assertParamExists("createTabularExport", "workspaceId", workspaceId);
|
|
280
|
+
// verify required parameter 'tabularExportRequest' is not null or undefined
|
|
281
|
+
assertParamExists("createTabularExport", "tabularExportRequest", tabularExportRequest);
|
|
282
|
+
const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/export/tabular`.replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)));
|
|
283
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
284
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
285
|
+
let baseOptions;
|
|
286
|
+
if (configuration) {
|
|
287
|
+
baseOptions = configuration.baseOptions;
|
|
288
|
+
}
|
|
289
|
+
const localVarRequestOptions = { method: "POST", ...baseOptions, ...options };
|
|
290
|
+
const localVarHeaderParameter = {};
|
|
291
|
+
const localVarQueryParameter = {};
|
|
292
|
+
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
293
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
294
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
295
|
+
localVarRequestOptions.headers = {
|
|
296
|
+
...localVarHeaderParameter,
|
|
297
|
+
...headersFromBaseOptions,
|
|
298
|
+
...options.headers,
|
|
299
|
+
};
|
|
300
|
+
const needsSerialization = typeof tabularExportRequest !== "string" ||
|
|
301
|
+
localVarRequestOptions.headers["Content-Type"] === "application/json";
|
|
302
|
+
localVarRequestOptions.data = needsSerialization
|
|
303
|
+
? JSON.stringify(tabularExportRequest !== undefined ? tabularExportRequest : {})
|
|
304
|
+
: tabularExportRequest || "";
|
|
305
|
+
return {
|
|
306
|
+
url: toPathString(localVarUrlObj),
|
|
307
|
+
options: localVarRequestOptions,
|
|
308
|
+
};
|
|
309
|
+
},
|
|
310
|
+
/**
|
|
311
|
+
* Returns 202 until original POST export request is not processed.Returns 200 with exported data once the export is done.
|
|
312
|
+
* @summary Retrieve exported files
|
|
313
|
+
* @param {string} workspaceId
|
|
314
|
+
* @param {string} exportId
|
|
315
|
+
* @param {*} [options] Override http request option.
|
|
316
|
+
* @throws {RequiredError}
|
|
317
|
+
*/
|
|
318
|
+
getExportedFile: async (workspaceId, exportId, options = {}) => {
|
|
319
|
+
// verify required parameter 'workspaceId' is not null or undefined
|
|
320
|
+
assertParamExists("getExportedFile", "workspaceId", workspaceId);
|
|
321
|
+
// verify required parameter 'exportId' is not null or undefined
|
|
322
|
+
assertParamExists("getExportedFile", "exportId", exportId);
|
|
323
|
+
const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/export/visual/{exportId}`
|
|
324
|
+
.replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)))
|
|
325
|
+
.replace(`{${"exportId"}}`, encodeURIComponent(String(exportId)));
|
|
326
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
327
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
328
|
+
let baseOptions;
|
|
329
|
+
if (configuration) {
|
|
330
|
+
baseOptions = configuration.baseOptions;
|
|
331
|
+
}
|
|
332
|
+
const localVarRequestOptions = { method: "GET", ...baseOptions, ...options };
|
|
333
|
+
const localVarHeaderParameter = {};
|
|
334
|
+
const localVarQueryParameter = {};
|
|
335
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
336
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
337
|
+
localVarRequestOptions.headers = {
|
|
338
|
+
...localVarHeaderParameter,
|
|
339
|
+
...headersFromBaseOptions,
|
|
340
|
+
...options.headers,
|
|
341
|
+
};
|
|
342
|
+
return {
|
|
343
|
+
url: toPathString(localVarUrlObj),
|
|
344
|
+
options: localVarRequestOptions,
|
|
345
|
+
};
|
|
346
|
+
},
|
|
347
|
+
/**
|
|
348
|
+
* 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/visual endpoint. The metadata structure is not verified. If metadata for given {exportId} has been found, endpoint returns the value 200 else 404.
|
|
349
|
+
* @summary Retrieve metadata context
|
|
350
|
+
* @param {string} workspaceId
|
|
351
|
+
* @param {string} exportId
|
|
352
|
+
* @param {*} [options] Override http request option.
|
|
353
|
+
* @throws {RequiredError}
|
|
354
|
+
*/
|
|
355
|
+
getMetadata: async (workspaceId, exportId, options = {}) => {
|
|
356
|
+
// verify required parameter 'workspaceId' is not null or undefined
|
|
357
|
+
assertParamExists("getMetadata", "workspaceId", workspaceId);
|
|
358
|
+
// verify required parameter 'exportId' is not null or undefined
|
|
359
|
+
assertParamExists("getMetadata", "exportId", exportId);
|
|
360
|
+
const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/export/visual/{exportId}/metadata`
|
|
361
|
+
.replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)))
|
|
362
|
+
.replace(`{${"exportId"}}`, encodeURIComponent(String(exportId)));
|
|
363
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
364
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
365
|
+
let baseOptions;
|
|
366
|
+
if (configuration) {
|
|
367
|
+
baseOptions = configuration.baseOptions;
|
|
368
|
+
}
|
|
369
|
+
const localVarRequestOptions = { method: "GET", ...baseOptions, ...options };
|
|
370
|
+
const localVarHeaderParameter = {};
|
|
371
|
+
const localVarQueryParameter = {};
|
|
372
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
373
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
374
|
+
localVarRequestOptions.headers = {
|
|
375
|
+
...localVarHeaderParameter,
|
|
376
|
+
...headersFromBaseOptions,
|
|
377
|
+
...options.headers,
|
|
378
|
+
};
|
|
379
|
+
return {
|
|
380
|
+
url: toPathString(localVarUrlObj),
|
|
381
|
+
options: localVarRequestOptions,
|
|
382
|
+
};
|
|
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
|
+
},
|
|
421
|
+
/**
|
|
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.
|
|
423
|
+
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
424
|
+
* @param {string} workspaceId
|
|
425
|
+
* @param {string} exportId
|
|
426
|
+
* @param {*} [options] Override http request option.
|
|
427
|
+
* @throws {RequiredError}
|
|
428
|
+
*/
|
|
429
|
+
getRawExport: async (workspaceId, exportId, options = {}) => {
|
|
430
|
+
// verify required parameter 'workspaceId' is not null or undefined
|
|
431
|
+
assertParamExists("getRawExport", "workspaceId", workspaceId);
|
|
432
|
+
// verify required parameter 'exportId' is not null or undefined
|
|
433
|
+
assertParamExists("getRawExport", "exportId", exportId);
|
|
434
|
+
const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/export/raw/{exportId}`
|
|
435
|
+
.replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)))
|
|
436
|
+
.replace(`{${"exportId"}}`, encodeURIComponent(String(exportId)));
|
|
437
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
438
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
439
|
+
let baseOptions;
|
|
440
|
+
if (configuration) {
|
|
441
|
+
baseOptions = configuration.baseOptions;
|
|
442
|
+
}
|
|
443
|
+
const localVarRequestOptions = { method: "GET", ...baseOptions, ...options };
|
|
444
|
+
const localVarHeaderParameter = {};
|
|
445
|
+
const localVarQueryParameter = {};
|
|
446
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
447
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
448
|
+
localVarRequestOptions.headers = {
|
|
449
|
+
...localVarHeaderParameter,
|
|
450
|
+
...headersFromBaseOptions,
|
|
451
|
+
...options.headers,
|
|
452
|
+
};
|
|
453
|
+
return {
|
|
454
|
+
url: toPathString(localVarUrlObj),
|
|
455
|
+
options: localVarRequestOptions,
|
|
456
|
+
};
|
|
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
|
+
},
|
|
495
|
+
/**
|
|
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.
|
|
497
|
+
* @summary Retrieve exported files
|
|
498
|
+
* @param {string} workspaceId
|
|
499
|
+
* @param {string} exportId
|
|
500
|
+
* @param {*} [options] Override http request option.
|
|
501
|
+
* @throws {RequiredError}
|
|
502
|
+
*/
|
|
503
|
+
getTabularExport: async (workspaceId, exportId, options = {}) => {
|
|
504
|
+
// verify required parameter 'workspaceId' is not null or undefined
|
|
505
|
+
assertParamExists("getTabularExport", "workspaceId", workspaceId);
|
|
506
|
+
// verify required parameter 'exportId' is not null or undefined
|
|
507
|
+
assertParamExists("getTabularExport", "exportId", exportId);
|
|
508
|
+
const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/export/tabular/{exportId}`
|
|
509
|
+
.replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)))
|
|
510
|
+
.replace(`{${"exportId"}}`, encodeURIComponent(String(exportId)));
|
|
511
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
512
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
513
|
+
let baseOptions;
|
|
514
|
+
if (configuration) {
|
|
515
|
+
baseOptions = configuration.baseOptions;
|
|
516
|
+
}
|
|
517
|
+
const localVarRequestOptions = { method: "GET", ...baseOptions, ...options };
|
|
518
|
+
const localVarHeaderParameter = {};
|
|
519
|
+
const localVarQueryParameter = {};
|
|
520
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
521
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
522
|
+
localVarRequestOptions.headers = {
|
|
523
|
+
...localVarHeaderParameter,
|
|
524
|
+
...headersFromBaseOptions,
|
|
525
|
+
...options.headers,
|
|
526
|
+
};
|
|
527
|
+
return {
|
|
528
|
+
url: toPathString(localVarUrlObj),
|
|
529
|
+
options: localVarRequestOptions,
|
|
530
|
+
};
|
|
531
|
+
},
|
|
532
|
+
};
|
|
533
|
+
};
|
|
534
|
+
/**
|
|
535
|
+
* ActionsApi - functional programming interface
|
|
536
|
+
* @export
|
|
537
|
+
*/
|
|
538
|
+
export const ActionsApiFp = function (configuration) {
|
|
539
|
+
const localVarAxiosParamCreator = ActionsApiAxiosParamCreator(configuration);
|
|
540
|
+
return {
|
|
541
|
+
/**
|
|
542
|
+
* Note: This API is an experimental and is going to change. Please, use it accordingly.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.
|
|
543
|
+
* @summary (EXPERIMENTAL) Create dashboard tabular export request
|
|
544
|
+
* @param {string} workspaceId
|
|
545
|
+
* @param {string} dashboardId
|
|
546
|
+
* @param {*} [options] Override http request option.
|
|
547
|
+
* @throws {RequiredError}
|
|
548
|
+
*/
|
|
549
|
+
async createDashboardExportRequest(workspaceId, dashboardId, options) {
|
|
550
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createDashboardExportRequest(workspaceId, dashboardId, options);
|
|
551
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
552
|
+
},
|
|
553
|
+
/**
|
|
554
|
+
* An visual 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.
|
|
555
|
+
* @summary Create visual - pdf export request
|
|
556
|
+
* @param {string} workspaceId
|
|
557
|
+
* @param {VisualExportRequest} visualExportRequest
|
|
558
|
+
* @param {*} [options] Override http request option.
|
|
559
|
+
* @throws {RequiredError}
|
|
560
|
+
*/
|
|
561
|
+
async createPdfExport(workspaceId, visualExportRequest, options) {
|
|
562
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createPdfExport(workspaceId, visualExportRequest, options);
|
|
563
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
564
|
+
},
|
|
565
|
+
/**
|
|
566
|
+
* Note: This API is an experimental and is going to change. Please, use it accordingly.An raw 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.
|
|
567
|
+
* @summary (EXPERIMENTAL) Create raw export request
|
|
568
|
+
* @param {string} workspaceId
|
|
569
|
+
* @param {RawExportRequest} rawExportRequest
|
|
570
|
+
* @param {*} [options] Override http request option.
|
|
571
|
+
* @throws {RequiredError}
|
|
572
|
+
*/
|
|
573
|
+
async createRawExport(workspaceId, rawExportRequest, options) {
|
|
574
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createRawExport(workspaceId, rawExportRequest, options);
|
|
575
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
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
|
+
},
|
|
589
|
+
/**
|
|
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.
|
|
591
|
+
* @summary Create tabular export request
|
|
592
|
+
* @param {string} workspaceId
|
|
593
|
+
* @param {TabularExportRequest} tabularExportRequest
|
|
594
|
+
* @param {*} [options] Override http request option.
|
|
595
|
+
* @throws {RequiredError}
|
|
596
|
+
*/
|
|
597
|
+
async createTabularExport(workspaceId, tabularExportRequest, options) {
|
|
598
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createTabularExport(workspaceId, tabularExportRequest, options);
|
|
599
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
600
|
+
},
|
|
601
|
+
/**
|
|
602
|
+
* Returns 202 until original POST export request is not processed.Returns 200 with exported data once the export is done.
|
|
603
|
+
* @summary Retrieve exported files
|
|
604
|
+
* @param {string} workspaceId
|
|
605
|
+
* @param {string} exportId
|
|
606
|
+
* @param {*} [options] Override http request option.
|
|
607
|
+
* @throws {RequiredError}
|
|
608
|
+
*/
|
|
609
|
+
async getExportedFile(workspaceId, exportId, options) {
|
|
610
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getExportedFile(workspaceId, exportId, options);
|
|
611
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
612
|
+
},
|
|
613
|
+
/**
|
|
614
|
+
* 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/visual endpoint. The metadata structure is not verified. If metadata for given {exportId} has been found, endpoint returns the value 200 else 404.
|
|
615
|
+
* @summary Retrieve metadata context
|
|
616
|
+
* @param {string} workspaceId
|
|
617
|
+
* @param {string} exportId
|
|
618
|
+
* @param {*} [options] Override http request option.
|
|
619
|
+
* @throws {RequiredError}
|
|
620
|
+
*/
|
|
621
|
+
async getMetadata(workspaceId, exportId, options) {
|
|
622
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getMetadata(workspaceId, exportId, options);
|
|
623
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
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
|
+
},
|
|
637
|
+
/**
|
|
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.
|
|
639
|
+
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
640
|
+
* @param {string} workspaceId
|
|
641
|
+
* @param {string} exportId
|
|
642
|
+
* @param {*} [options] Override http request option.
|
|
643
|
+
* @throws {RequiredError}
|
|
644
|
+
*/
|
|
645
|
+
async getRawExport(workspaceId, exportId, options) {
|
|
646
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getRawExport(workspaceId, exportId, options);
|
|
647
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
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
|
+
},
|
|
661
|
+
/**
|
|
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.
|
|
663
|
+
* @summary Retrieve exported files
|
|
664
|
+
* @param {string} workspaceId
|
|
665
|
+
* @param {string} exportId
|
|
666
|
+
* @param {*} [options] Override http request option.
|
|
667
|
+
* @throws {RequiredError}
|
|
668
|
+
*/
|
|
669
|
+
async getTabularExport(workspaceId, exportId, options) {
|
|
670
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getTabularExport(workspaceId, exportId, options);
|
|
671
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
672
|
+
},
|
|
673
|
+
};
|
|
674
|
+
};
|
|
675
|
+
/**
|
|
676
|
+
* ActionsApi - factory interface
|
|
677
|
+
* @export
|
|
678
|
+
*/
|
|
679
|
+
export const ActionsApiFactory = function (configuration, basePath, axios) {
|
|
680
|
+
const localVarFp = ActionsApiFp(configuration);
|
|
681
|
+
return {
|
|
682
|
+
/**
|
|
683
|
+
* Note: This API is an experimental and is going to change. Please, use it accordingly.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.
|
|
684
|
+
* @summary (EXPERIMENTAL) Create dashboard tabular export request
|
|
685
|
+
* @param {ActionsApiCreateDashboardExportRequestRequest} requestParameters Request parameters.
|
|
686
|
+
* @param {*} [options] Override http request option.
|
|
687
|
+
* @throws {RequiredError}
|
|
688
|
+
*/
|
|
689
|
+
createDashboardExportRequest(requestParameters, options) {
|
|
690
|
+
return localVarFp
|
|
691
|
+
.createDashboardExportRequest(requestParameters.workspaceId, requestParameters.dashboardId, options)
|
|
692
|
+
.then((request) => request(axios, basePath));
|
|
693
|
+
},
|
|
694
|
+
/**
|
|
695
|
+
* An visual 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.
|
|
696
|
+
* @summary Create visual - pdf export request
|
|
697
|
+
* @param {ActionsApiCreatePdfExportRequest} requestParameters Request parameters.
|
|
698
|
+
* @param {*} [options] Override http request option.
|
|
699
|
+
* @throws {RequiredError}
|
|
700
|
+
*/
|
|
701
|
+
createPdfExport(requestParameters, options) {
|
|
702
|
+
return localVarFp
|
|
703
|
+
.createPdfExport(requestParameters.workspaceId, requestParameters.visualExportRequest, options)
|
|
704
|
+
.then((request) => request(axios, basePath));
|
|
705
|
+
},
|
|
706
|
+
/**
|
|
707
|
+
* Note: This API is an experimental and is going to change. Please, use it accordingly.An raw 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.
|
|
708
|
+
* @summary (EXPERIMENTAL) Create raw export request
|
|
709
|
+
* @param {ActionsApiCreateRawExportRequest} requestParameters Request parameters.
|
|
710
|
+
* @param {*} [options] Override http request option.
|
|
711
|
+
* @throws {RequiredError}
|
|
712
|
+
*/
|
|
713
|
+
createRawExport(requestParameters, options) {
|
|
714
|
+
return localVarFp
|
|
715
|
+
.createRawExport(requestParameters.workspaceId, requestParameters.rawExportRequest, options)
|
|
716
|
+
.then((request) => request(axios, basePath));
|
|
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
|
+
},
|
|
730
|
+
/**
|
|
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.
|
|
732
|
+
* @summary Create tabular export request
|
|
733
|
+
* @param {ActionsApiCreateTabularExportRequest} requestParameters Request parameters.
|
|
734
|
+
* @param {*} [options] Override http request option.
|
|
735
|
+
* @throws {RequiredError}
|
|
736
|
+
*/
|
|
737
|
+
createTabularExport(requestParameters, options) {
|
|
738
|
+
return localVarFp
|
|
739
|
+
.createTabularExport(requestParameters.workspaceId, requestParameters.tabularExportRequest, options)
|
|
740
|
+
.then((request) => request(axios, basePath));
|
|
741
|
+
},
|
|
742
|
+
/**
|
|
743
|
+
* Returns 202 until original POST export request is not processed.Returns 200 with exported data once the export is done.
|
|
744
|
+
* @summary Retrieve exported files
|
|
745
|
+
* @param {ActionsApiGetExportedFileRequest} requestParameters Request parameters.
|
|
746
|
+
* @param {*} [options] Override http request option.
|
|
747
|
+
* @throws {RequiredError}
|
|
748
|
+
*/
|
|
749
|
+
getExportedFile(requestParameters, options) {
|
|
750
|
+
return localVarFp
|
|
751
|
+
.getExportedFile(requestParameters.workspaceId, requestParameters.exportId, options)
|
|
752
|
+
.then((request) => request(axios, basePath));
|
|
753
|
+
},
|
|
754
|
+
/**
|
|
755
|
+
* 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/visual endpoint. The metadata structure is not verified. If metadata for given {exportId} has been found, endpoint returns the value 200 else 404.
|
|
756
|
+
* @summary Retrieve metadata context
|
|
757
|
+
* @param {ActionsApiGetMetadataRequest} requestParameters Request parameters.
|
|
758
|
+
* @param {*} [options] Override http request option.
|
|
759
|
+
* @throws {RequiredError}
|
|
760
|
+
*/
|
|
761
|
+
getMetadata(requestParameters, options) {
|
|
762
|
+
return localVarFp
|
|
763
|
+
.getMetadata(requestParameters.workspaceId, requestParameters.exportId, options)
|
|
764
|
+
.then((request) => request(axios, basePath));
|
|
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
|
+
},
|
|
778
|
+
/**
|
|
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.
|
|
780
|
+
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
781
|
+
* @param {ActionsApiGetRawExportRequest} requestParameters Request parameters.
|
|
782
|
+
* @param {*} [options] Override http request option.
|
|
783
|
+
* @throws {RequiredError}
|
|
784
|
+
*/
|
|
785
|
+
getRawExport(requestParameters, options) {
|
|
786
|
+
return localVarFp
|
|
787
|
+
.getRawExport(requestParameters.workspaceId, requestParameters.exportId, options)
|
|
788
|
+
.then((request) => request(axios, basePath));
|
|
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
|
+
},
|
|
802
|
+
/**
|
|
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.
|
|
804
|
+
* @summary Retrieve exported files
|
|
805
|
+
* @param {ActionsApiGetTabularExportRequest} requestParameters Request parameters.
|
|
806
|
+
* @param {*} [options] Override http request option.
|
|
807
|
+
* @throws {RequiredError}
|
|
808
|
+
*/
|
|
809
|
+
getTabularExport(requestParameters, options) {
|
|
810
|
+
return localVarFp
|
|
811
|
+
.getTabularExport(requestParameters.workspaceId, requestParameters.exportId, options)
|
|
812
|
+
.then((request) => request(axios, basePath));
|
|
813
|
+
},
|
|
814
|
+
};
|
|
815
|
+
};
|
|
816
|
+
/**
|
|
817
|
+
* ActionsApi - object-oriented interface
|
|
818
|
+
* @export
|
|
819
|
+
* @class ActionsApi
|
|
820
|
+
* @extends {BaseAPI}
|
|
821
|
+
*/
|
|
822
|
+
export class ActionsApi extends BaseAPI {
|
|
823
|
+
/**
|
|
824
|
+
* Note: This API is an experimental and is going to change. Please, use it accordingly.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.
|
|
825
|
+
* @summary (EXPERIMENTAL) Create dashboard tabular export request
|
|
826
|
+
* @param {ActionsApiCreateDashboardExportRequestRequest} requestParameters Request parameters.
|
|
827
|
+
* @param {*} [options] Override http request option.
|
|
828
|
+
* @throws {RequiredError}
|
|
829
|
+
* @memberof ActionsApi
|
|
830
|
+
*/
|
|
831
|
+
createDashboardExportRequest(requestParameters, options) {
|
|
832
|
+
return ActionsApiFp(this.configuration)
|
|
833
|
+
.createDashboardExportRequest(requestParameters.workspaceId, requestParameters.dashboardId, options)
|
|
834
|
+
.then((request) => request(this.axios, this.basePath));
|
|
835
|
+
}
|
|
836
|
+
/**
|
|
837
|
+
* An visual 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.
|
|
838
|
+
* @summary Create visual - pdf export request
|
|
839
|
+
* @param {ActionsApiCreatePdfExportRequest} requestParameters Request parameters.
|
|
840
|
+
* @param {*} [options] Override http request option.
|
|
841
|
+
* @throws {RequiredError}
|
|
842
|
+
* @memberof ActionsApi
|
|
843
|
+
*/
|
|
844
|
+
createPdfExport(requestParameters, options) {
|
|
845
|
+
return ActionsApiFp(this.configuration)
|
|
846
|
+
.createPdfExport(requestParameters.workspaceId, requestParameters.visualExportRequest, options)
|
|
847
|
+
.then((request) => request(this.axios, this.basePath));
|
|
848
|
+
}
|
|
849
|
+
/**
|
|
850
|
+
* Note: This API is an experimental and is going to change. Please, use it accordingly.An raw 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.
|
|
851
|
+
* @summary (EXPERIMENTAL) Create raw export request
|
|
852
|
+
* @param {ActionsApiCreateRawExportRequest} requestParameters Request parameters.
|
|
853
|
+
* @param {*} [options] Override http request option.
|
|
854
|
+
* @throws {RequiredError}
|
|
855
|
+
* @memberof ActionsApi
|
|
856
|
+
*/
|
|
857
|
+
createRawExport(requestParameters, options) {
|
|
858
|
+
return ActionsApiFp(this.configuration)
|
|
859
|
+
.createRawExport(requestParameters.workspaceId, requestParameters.rawExportRequest, options)
|
|
860
|
+
.then((request) => request(this.axios, this.basePath));
|
|
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
|
+
}
|
|
875
|
+
/**
|
|
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.
|
|
877
|
+
* @summary Create tabular export request
|
|
878
|
+
* @param {ActionsApiCreateTabularExportRequest} requestParameters Request parameters.
|
|
879
|
+
* @param {*} [options] Override http request option.
|
|
880
|
+
* @throws {RequiredError}
|
|
881
|
+
* @memberof ActionsApi
|
|
882
|
+
*/
|
|
883
|
+
createTabularExport(requestParameters, options) {
|
|
884
|
+
return ActionsApiFp(this.configuration)
|
|
885
|
+
.createTabularExport(requestParameters.workspaceId, requestParameters.tabularExportRequest, options)
|
|
886
|
+
.then((request) => request(this.axios, this.basePath));
|
|
887
|
+
}
|
|
888
|
+
/**
|
|
889
|
+
* Returns 202 until original POST export request is not processed.Returns 200 with exported data once the export is done.
|
|
890
|
+
* @summary Retrieve exported files
|
|
891
|
+
* @param {ActionsApiGetExportedFileRequest} requestParameters Request parameters.
|
|
892
|
+
* @param {*} [options] Override http request option.
|
|
893
|
+
* @throws {RequiredError}
|
|
894
|
+
* @memberof ActionsApi
|
|
895
|
+
*/
|
|
896
|
+
getExportedFile(requestParameters, options) {
|
|
897
|
+
return ActionsApiFp(this.configuration)
|
|
898
|
+
.getExportedFile(requestParameters.workspaceId, requestParameters.exportId, options)
|
|
899
|
+
.then((request) => request(this.axios, this.basePath));
|
|
900
|
+
}
|
|
901
|
+
/**
|
|
902
|
+
* 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/visual endpoint. The metadata structure is not verified. If metadata for given {exportId} has been found, endpoint returns the value 200 else 404.
|
|
903
|
+
* @summary Retrieve metadata context
|
|
904
|
+
* @param {ActionsApiGetMetadataRequest} requestParameters Request parameters.
|
|
905
|
+
* @param {*} [options] Override http request option.
|
|
906
|
+
* @throws {RequiredError}
|
|
907
|
+
* @memberof ActionsApi
|
|
908
|
+
*/
|
|
909
|
+
getMetadata(requestParameters, options) {
|
|
910
|
+
return ActionsApiFp(this.configuration)
|
|
911
|
+
.getMetadata(requestParameters.workspaceId, requestParameters.exportId, options)
|
|
912
|
+
.then((request) => request(this.axios, this.basePath));
|
|
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
|
+
}
|
|
927
|
+
/**
|
|
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.
|
|
929
|
+
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
930
|
+
* @param {ActionsApiGetRawExportRequest} requestParameters Request parameters.
|
|
931
|
+
* @param {*} [options] Override http request option.
|
|
932
|
+
* @throws {RequiredError}
|
|
933
|
+
* @memberof ActionsApi
|
|
934
|
+
*/
|
|
935
|
+
getRawExport(requestParameters, options) {
|
|
936
|
+
return ActionsApiFp(this.configuration)
|
|
937
|
+
.getRawExport(requestParameters.workspaceId, requestParameters.exportId, options)
|
|
938
|
+
.then((request) => request(this.axios, this.basePath));
|
|
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
|
+
}
|
|
953
|
+
/**
|
|
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.
|
|
955
|
+
* @summary Retrieve exported files
|
|
956
|
+
* @param {ActionsApiGetTabularExportRequest} requestParameters Request parameters.
|
|
957
|
+
* @param {*} [options] Override http request option.
|
|
958
|
+
* @throws {RequiredError}
|
|
959
|
+
* @memberof ActionsApi
|
|
960
|
+
*/
|
|
961
|
+
getTabularExport(requestParameters, options) {
|
|
962
|
+
return ActionsApiFp(this.configuration)
|
|
963
|
+
.getTabularExport(requestParameters.workspaceId, requestParameters.exportId, options)
|
|
964
|
+
.then((request) => request(this.axios, this.basePath));
|
|
965
|
+
}
|
|
966
|
+
}
|
|
967
|
+
/**
|
|
968
|
+
* RawExportApi - axios parameter creator
|
|
969
|
+
* @export
|
|
970
|
+
*/
|
|
971
|
+
export const RawExportApiAxiosParamCreator = function (configuration) {
|
|
972
|
+
return {
|
|
973
|
+
/**
|
|
974
|
+
* Note: This API is an experimental and is going to change. Please, use it accordingly.An raw 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.
|
|
975
|
+
* @summary (EXPERIMENTAL) Create raw export request
|
|
976
|
+
* @param {string} workspaceId
|
|
977
|
+
* @param {RawExportRequest} rawExportRequest
|
|
978
|
+
* @param {*} [options] Override http request option.
|
|
979
|
+
* @throws {RequiredError}
|
|
980
|
+
*/
|
|
981
|
+
createRawExport: async (workspaceId, rawExportRequest, options = {}) => {
|
|
982
|
+
// verify required parameter 'workspaceId' is not null or undefined
|
|
983
|
+
assertParamExists("createRawExport", "workspaceId", workspaceId);
|
|
984
|
+
// verify required parameter 'rawExportRequest' is not null or undefined
|
|
985
|
+
assertParamExists("createRawExport", "rawExportRequest", rawExportRequest);
|
|
986
|
+
const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/export/raw`.replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)));
|
|
987
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
988
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
989
|
+
let baseOptions;
|
|
990
|
+
if (configuration) {
|
|
991
|
+
baseOptions = configuration.baseOptions;
|
|
992
|
+
}
|
|
993
|
+
const localVarRequestOptions = { method: "POST", ...baseOptions, ...options };
|
|
994
|
+
const localVarHeaderParameter = {};
|
|
995
|
+
const localVarQueryParameter = {};
|
|
996
|
+
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
997
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
998
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
999
|
+
localVarRequestOptions.headers = {
|
|
1000
|
+
...localVarHeaderParameter,
|
|
1001
|
+
...headersFromBaseOptions,
|
|
1002
|
+
...options.headers,
|
|
1003
|
+
};
|
|
1004
|
+
const needsSerialization = typeof rawExportRequest !== "string" ||
|
|
1005
|
+
localVarRequestOptions.headers["Content-Type"] === "application/json";
|
|
1006
|
+
localVarRequestOptions.data = needsSerialization
|
|
1007
|
+
? JSON.stringify(rawExportRequest !== undefined ? rawExportRequest : {})
|
|
1008
|
+
: rawExportRequest || "";
|
|
1009
|
+
return {
|
|
1010
|
+
url: toPathString(localVarUrlObj),
|
|
1011
|
+
options: localVarRequestOptions,
|
|
1012
|
+
};
|
|
1013
|
+
},
|
|
1014
|
+
/**
|
|
1015
|
+
* 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.
|
|
1016
|
+
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
1017
|
+
* @param {string} workspaceId
|
|
1018
|
+
* @param {string} exportId
|
|
1019
|
+
* @param {*} [options] Override http request option.
|
|
1020
|
+
* @throws {RequiredError}
|
|
1021
|
+
*/
|
|
1022
|
+
getRawExport: async (workspaceId, exportId, options = {}) => {
|
|
1023
|
+
// verify required parameter 'workspaceId' is not null or undefined
|
|
1024
|
+
assertParamExists("getRawExport", "workspaceId", workspaceId);
|
|
1025
|
+
// verify required parameter 'exportId' is not null or undefined
|
|
1026
|
+
assertParamExists("getRawExport", "exportId", exportId);
|
|
1027
|
+
const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/export/raw/{exportId}`
|
|
1028
|
+
.replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)))
|
|
1029
|
+
.replace(`{${"exportId"}}`, encodeURIComponent(String(exportId)));
|
|
1030
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1031
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1032
|
+
let baseOptions;
|
|
1033
|
+
if (configuration) {
|
|
1034
|
+
baseOptions = configuration.baseOptions;
|
|
1035
|
+
}
|
|
1036
|
+
const localVarRequestOptions = { method: "GET", ...baseOptions, ...options };
|
|
1037
|
+
const localVarHeaderParameter = {};
|
|
1038
|
+
const localVarQueryParameter = {};
|
|
1039
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1040
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1041
|
+
localVarRequestOptions.headers = {
|
|
1042
|
+
...localVarHeaderParameter,
|
|
1043
|
+
...headersFromBaseOptions,
|
|
1044
|
+
...options.headers,
|
|
1045
|
+
};
|
|
1046
|
+
return {
|
|
1047
|
+
url: toPathString(localVarUrlObj),
|
|
1048
|
+
options: localVarRequestOptions,
|
|
1049
|
+
};
|
|
1050
|
+
},
|
|
1051
|
+
};
|
|
1052
|
+
};
|
|
1053
|
+
/**
|
|
1054
|
+
* RawExportApi - functional programming interface
|
|
1055
|
+
* @export
|
|
1056
|
+
*/
|
|
1057
|
+
export const RawExportApiFp = function (configuration) {
|
|
1058
|
+
const localVarAxiosParamCreator = RawExportApiAxiosParamCreator(configuration);
|
|
1059
|
+
return {
|
|
1060
|
+
/**
|
|
1061
|
+
* Note: This API is an experimental and is going to change. Please, use it accordingly.An raw 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.
|
|
1062
|
+
* @summary (EXPERIMENTAL) Create raw export request
|
|
1063
|
+
* @param {string} workspaceId
|
|
1064
|
+
* @param {RawExportRequest} rawExportRequest
|
|
1065
|
+
* @param {*} [options] Override http request option.
|
|
1066
|
+
* @throws {RequiredError}
|
|
1067
|
+
*/
|
|
1068
|
+
async createRawExport(workspaceId, rawExportRequest, options) {
|
|
1069
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createRawExport(workspaceId, rawExportRequest, options);
|
|
1070
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1071
|
+
},
|
|
1072
|
+
/**
|
|
1073
|
+
* 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.
|
|
1074
|
+
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
1075
|
+
* @param {string} workspaceId
|
|
1076
|
+
* @param {string} exportId
|
|
1077
|
+
* @param {*} [options] Override http request option.
|
|
1078
|
+
* @throws {RequiredError}
|
|
1079
|
+
*/
|
|
1080
|
+
async getRawExport(workspaceId, exportId, options) {
|
|
1081
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getRawExport(workspaceId, exportId, options);
|
|
1082
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1083
|
+
},
|
|
1084
|
+
};
|
|
1085
|
+
};
|
|
1086
|
+
/**
|
|
1087
|
+
* RawExportApi - factory interface
|
|
1088
|
+
* @export
|
|
1089
|
+
*/
|
|
1090
|
+
export const RawExportApiFactory = function (configuration, basePath, axios) {
|
|
1091
|
+
const localVarFp = RawExportApiFp(configuration);
|
|
1092
|
+
return {
|
|
1093
|
+
/**
|
|
1094
|
+
* Note: This API is an experimental and is going to change. Please, use it accordingly.An raw 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.
|
|
1095
|
+
* @summary (EXPERIMENTAL) Create raw export request
|
|
1096
|
+
* @param {RawExportApiCreateRawExportRequest} requestParameters Request parameters.
|
|
1097
|
+
* @param {*} [options] Override http request option.
|
|
1098
|
+
* @throws {RequiredError}
|
|
1099
|
+
*/
|
|
1100
|
+
createRawExport(requestParameters, options) {
|
|
1101
|
+
return localVarFp
|
|
1102
|
+
.createRawExport(requestParameters.workspaceId, requestParameters.rawExportRequest, options)
|
|
1103
|
+
.then((request) => request(axios, basePath));
|
|
1104
|
+
},
|
|
1105
|
+
/**
|
|
1106
|
+
* 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.
|
|
1107
|
+
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
1108
|
+
* @param {RawExportApiGetRawExportRequest} requestParameters Request parameters.
|
|
1109
|
+
* @param {*} [options] Override http request option.
|
|
1110
|
+
* @throws {RequiredError}
|
|
1111
|
+
*/
|
|
1112
|
+
getRawExport(requestParameters, options) {
|
|
1113
|
+
return localVarFp
|
|
1114
|
+
.getRawExport(requestParameters.workspaceId, requestParameters.exportId, options)
|
|
1115
|
+
.then((request) => request(axios, basePath));
|
|
1116
|
+
},
|
|
1117
|
+
};
|
|
1118
|
+
};
|
|
1119
|
+
/**
|
|
1120
|
+
* RawExportApi - object-oriented interface
|
|
1121
|
+
* @export
|
|
1122
|
+
* @class RawExportApi
|
|
1123
|
+
* @extends {BaseAPI}
|
|
1124
|
+
*/
|
|
1125
|
+
export class RawExportApi extends BaseAPI {
|
|
1126
|
+
/**
|
|
1127
|
+
* Note: This API is an experimental and is going to change. Please, use it accordingly.An raw 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.
|
|
1128
|
+
* @summary (EXPERIMENTAL) Create raw export request
|
|
1129
|
+
* @param {RawExportApiCreateRawExportRequest} requestParameters Request parameters.
|
|
1130
|
+
* @param {*} [options] Override http request option.
|
|
1131
|
+
* @throws {RequiredError}
|
|
1132
|
+
* @memberof RawExportApi
|
|
1133
|
+
*/
|
|
1134
|
+
createRawExport(requestParameters, options) {
|
|
1135
|
+
return RawExportApiFp(this.configuration)
|
|
1136
|
+
.createRawExport(requestParameters.workspaceId, requestParameters.rawExportRequest, options)
|
|
1137
|
+
.then((request) => request(this.axios, this.basePath));
|
|
1138
|
+
}
|
|
1139
|
+
/**
|
|
1140
|
+
* 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.
|
|
1141
|
+
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
1142
|
+
* @param {RawExportApiGetRawExportRequest} requestParameters Request parameters.
|
|
1143
|
+
* @param {*} [options] Override http request option.
|
|
1144
|
+
* @throws {RequiredError}
|
|
1145
|
+
* @memberof RawExportApi
|
|
1146
|
+
*/
|
|
1147
|
+
getRawExport(requestParameters, options) {
|
|
1148
|
+
return RawExportApiFp(this.configuration)
|
|
1149
|
+
.getRawExport(requestParameters.workspaceId, requestParameters.exportId, options)
|
|
1150
|
+
.then((request) => request(this.axios, this.basePath));
|
|
1151
|
+
}
|
|
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
|
|
67
1162
|
* @param {string} workspaceId
|
|
68
|
-
* @param {
|
|
1163
|
+
* @param {SlideshowExportRequest} slideshowExportRequest
|
|
69
1164
|
* @param {*} [options] Override http request option.
|
|
70
1165
|
* @throws {RequiredError}
|
|
71
1166
|
*/
|
|
72
|
-
|
|
1167
|
+
createSlideshowExport: async (workspaceId, slideshowExportRequest, options = {}) => {
|
|
73
1168
|
// verify required parameter 'workspaceId' is not null or undefined
|
|
74
|
-
assertParamExists("
|
|
75
|
-
// verify required parameter '
|
|
76
|
-
assertParamExists("
|
|
77
|
-
const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/export/
|
|
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)));
|
|
78
1173
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
79
1174
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
80
1175
|
let baseOptions;
|
|
@@ -92,67 +1187,30 @@ export const ActionsApiAxiosParamCreator = function (configuration) {
|
|
|
92
1187
|
...headersFromBaseOptions,
|
|
93
1188
|
...options.headers,
|
|
94
1189
|
};
|
|
95
|
-
const needsSerialization = typeof
|
|
1190
|
+
const needsSerialization = typeof slideshowExportRequest !== "string" ||
|
|
96
1191
|
localVarRequestOptions.headers["Content-Type"] === "application/json";
|
|
97
1192
|
localVarRequestOptions.data = needsSerialization
|
|
98
|
-
? JSON.stringify(
|
|
99
|
-
:
|
|
100
|
-
return {
|
|
101
|
-
url: toPathString(localVarUrlObj),
|
|
102
|
-
options: localVarRequestOptions,
|
|
103
|
-
};
|
|
104
|
-
},
|
|
105
|
-
/**
|
|
106
|
-
* Returns 202 until original POST export request is not processed.Returns 200 with exported data once the export is done.
|
|
107
|
-
* @summary Retrieve exported files
|
|
108
|
-
* @param {string} workspaceId
|
|
109
|
-
* @param {string} exportId
|
|
110
|
-
* @param {*} [options] Override http request option.
|
|
111
|
-
* @throws {RequiredError}
|
|
112
|
-
*/
|
|
113
|
-
getExportedFile: async (workspaceId, exportId, options = {}) => {
|
|
114
|
-
// verify required parameter 'workspaceId' is not null or undefined
|
|
115
|
-
assertParamExists("getExportedFile", "workspaceId", workspaceId);
|
|
116
|
-
// verify required parameter 'exportId' is not null or undefined
|
|
117
|
-
assertParamExists("getExportedFile", "exportId", exportId);
|
|
118
|
-
const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/export/visual/{exportId}`
|
|
119
|
-
.replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)))
|
|
120
|
-
.replace(`{${"exportId"}}`, encodeURIComponent(String(exportId)));
|
|
121
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
122
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
123
|
-
let baseOptions;
|
|
124
|
-
if (configuration) {
|
|
125
|
-
baseOptions = configuration.baseOptions;
|
|
126
|
-
}
|
|
127
|
-
const localVarRequestOptions = { method: "GET", ...baseOptions, ...options };
|
|
128
|
-
const localVarHeaderParameter = {};
|
|
129
|
-
const localVarQueryParameter = {};
|
|
130
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
131
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
132
|
-
localVarRequestOptions.headers = {
|
|
133
|
-
...localVarHeaderParameter,
|
|
134
|
-
...headersFromBaseOptions,
|
|
135
|
-
...options.headers,
|
|
136
|
-
};
|
|
1193
|
+
? JSON.stringify(slideshowExportRequest !== undefined ? slideshowExportRequest : {})
|
|
1194
|
+
: slideshowExportRequest || "";
|
|
137
1195
|
return {
|
|
138
1196
|
url: toPathString(localVarUrlObj),
|
|
139
1197
|
options: localVarRequestOptions,
|
|
140
1198
|
};
|
|
141
1199
|
},
|
|
142
1200
|
/**
|
|
143
|
-
* 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/
|
|
144
|
-
* @summary Retrieve metadata context
|
|
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
|
|
145
1203
|
* @param {string} workspaceId
|
|
146
1204
|
* @param {string} exportId
|
|
147
1205
|
* @param {*} [options] Override http request option.
|
|
148
1206
|
* @throws {RequiredError}
|
|
149
1207
|
*/
|
|
150
|
-
|
|
1208
|
+
getMetadata1: async (workspaceId, exportId, options = {}) => {
|
|
151
1209
|
// verify required parameter 'workspaceId' is not null or undefined
|
|
152
|
-
assertParamExists("
|
|
1210
|
+
assertParamExists("getMetadata1", "workspaceId", workspaceId);
|
|
153
1211
|
// verify required parameter 'exportId' is not null or undefined
|
|
154
|
-
assertParamExists("
|
|
155
|
-
const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/export/
|
|
1212
|
+
assertParamExists("getMetadata1", "exportId", exportId);
|
|
1213
|
+
const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/export/slideshow/{exportId}/metadata`
|
|
156
1214
|
.replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)))
|
|
157
1215
|
.replace(`{${"exportId"}}`, encodeURIComponent(String(exportId)));
|
|
158
1216
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -177,19 +1235,19 @@ export const ActionsApiAxiosParamCreator = function (configuration) {
|
|
|
177
1235
|
};
|
|
178
1236
|
},
|
|
179
1237
|
/**
|
|
180
|
-
* 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.
|
|
181
|
-
* @summary Retrieve exported files
|
|
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
|
|
182
1240
|
* @param {string} workspaceId
|
|
183
1241
|
* @param {string} exportId
|
|
184
1242
|
* @param {*} [options] Override http request option.
|
|
185
1243
|
* @throws {RequiredError}
|
|
186
1244
|
*/
|
|
187
|
-
|
|
1245
|
+
getSlideshowExport: async (workspaceId, exportId, options = {}) => {
|
|
188
1246
|
// verify required parameter 'workspaceId' is not null or undefined
|
|
189
|
-
assertParamExists("
|
|
1247
|
+
assertParamExists("getSlideshowExport", "workspaceId", workspaceId);
|
|
190
1248
|
// verify required parameter 'exportId' is not null or undefined
|
|
191
|
-
assertParamExists("
|
|
192
|
-
const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/export/
|
|
1249
|
+
assertParamExists("getSlideshowExport", "exportId", exportId);
|
|
1250
|
+
const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/export/slideshow/{exportId}`
|
|
193
1251
|
.replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)))
|
|
194
1252
|
.replace(`{${"exportId"}}`, encodeURIComponent(String(exportId)));
|
|
195
1253
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -216,213 +1274,139 @@ export const ActionsApiAxiosParamCreator = function (configuration) {
|
|
|
216
1274
|
};
|
|
217
1275
|
};
|
|
218
1276
|
/**
|
|
219
|
-
*
|
|
1277
|
+
* SlideshowExportApi - functional programming interface
|
|
220
1278
|
* @export
|
|
221
1279
|
*/
|
|
222
|
-
export const
|
|
223
|
-
const localVarAxiosParamCreator =
|
|
1280
|
+
export const SlideshowExportApiFp = function (configuration) {
|
|
1281
|
+
const localVarAxiosParamCreator = SlideshowExportApiAxiosParamCreator(configuration);
|
|
224
1282
|
return {
|
|
225
1283
|
/**
|
|
226
|
-
*
|
|
227
|
-
* @summary Create
|
|
228
|
-
* @param {string} workspaceId
|
|
229
|
-
* @param {VisualExportRequest} visualExportRequest
|
|
230
|
-
* @param {*} [options] Override http request option.
|
|
231
|
-
* @throws {RequiredError}
|
|
232
|
-
*/
|
|
233
|
-
async createPdfExport(workspaceId, visualExportRequest, options) {
|
|
234
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.createPdfExport(workspaceId, visualExportRequest, options);
|
|
235
|
-
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
236
|
-
},
|
|
237
|
-
/**
|
|
238
|
-
* 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.
|
|
239
|
-
* @summary Create tabular export request
|
|
240
|
-
* @param {string} workspaceId
|
|
241
|
-
* @param {TabularExportRequest} tabularExportRequest
|
|
242
|
-
* @param {*} [options] Override http request option.
|
|
243
|
-
* @throws {RequiredError}
|
|
244
|
-
*/
|
|
245
|
-
async createTabularExport(workspaceId, tabularExportRequest, options) {
|
|
246
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.createTabularExport(workspaceId, tabularExportRequest, options);
|
|
247
|
-
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
248
|
-
},
|
|
249
|
-
/**
|
|
250
|
-
* Returns 202 until original POST export request is not processed.Returns 200 with exported data once the export is done.
|
|
251
|
-
* @summary Retrieve exported files
|
|
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
|
|
252
1286
|
* @param {string} workspaceId
|
|
253
|
-
* @param {
|
|
1287
|
+
* @param {SlideshowExportRequest} slideshowExportRequest
|
|
254
1288
|
* @param {*} [options] Override http request option.
|
|
255
1289
|
* @throws {RequiredError}
|
|
256
1290
|
*/
|
|
257
|
-
async
|
|
258
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
1291
|
+
async createSlideshowExport(workspaceId, slideshowExportRequest, options) {
|
|
1292
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createSlideshowExport(workspaceId, slideshowExportRequest, options);
|
|
259
1293
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
260
1294
|
},
|
|
261
1295
|
/**
|
|
262
|
-
* 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/
|
|
263
|
-
* @summary Retrieve metadata context
|
|
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
|
|
264
1298
|
* @param {string} workspaceId
|
|
265
1299
|
* @param {string} exportId
|
|
266
1300
|
* @param {*} [options] Override http request option.
|
|
267
1301
|
* @throws {RequiredError}
|
|
268
1302
|
*/
|
|
269
|
-
async
|
|
270
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
1303
|
+
async getMetadata1(workspaceId, exportId, options) {
|
|
1304
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getMetadata1(workspaceId, exportId, options);
|
|
271
1305
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
272
1306
|
},
|
|
273
1307
|
/**
|
|
274
|
-
* 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.
|
|
275
|
-
* @summary Retrieve exported files
|
|
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
|
|
276
1310
|
* @param {string} workspaceId
|
|
277
1311
|
* @param {string} exportId
|
|
278
1312
|
* @param {*} [options] Override http request option.
|
|
279
1313
|
* @throws {RequiredError}
|
|
280
1314
|
*/
|
|
281
|
-
async
|
|
282
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
1315
|
+
async getSlideshowExport(workspaceId, exportId, options) {
|
|
1316
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getSlideshowExport(workspaceId, exportId, options);
|
|
283
1317
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
284
1318
|
},
|
|
285
1319
|
};
|
|
286
1320
|
};
|
|
287
1321
|
/**
|
|
288
|
-
*
|
|
1322
|
+
* SlideshowExportApi - factory interface
|
|
289
1323
|
* @export
|
|
290
1324
|
*/
|
|
291
|
-
export const
|
|
292
|
-
const localVarFp =
|
|
1325
|
+
export const SlideshowExportApiFactory = function (configuration, basePath, axios) {
|
|
1326
|
+
const localVarFp = SlideshowExportApiFp(configuration);
|
|
293
1327
|
return {
|
|
294
1328
|
/**
|
|
295
|
-
*
|
|
296
|
-
* @summary Create
|
|
297
|
-
* @param {
|
|
298
|
-
* @param {*} [options] Override http request option.
|
|
299
|
-
* @throws {RequiredError}
|
|
300
|
-
*/
|
|
301
|
-
createPdfExport(requestParameters, options) {
|
|
302
|
-
return localVarFp
|
|
303
|
-
.createPdfExport(requestParameters.workspaceId, requestParameters.visualExportRequest, options)
|
|
304
|
-
.then((request) => request(axios, basePath));
|
|
305
|
-
},
|
|
306
|
-
/**
|
|
307
|
-
* 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.
|
|
308
|
-
* @summary Create tabular export request
|
|
309
|
-
* @param {ActionsApiCreateTabularExportRequest} requestParameters Request parameters.
|
|
310
|
-
* @param {*} [options] Override http request option.
|
|
311
|
-
* @throws {RequiredError}
|
|
312
|
-
*/
|
|
313
|
-
createTabularExport(requestParameters, options) {
|
|
314
|
-
return localVarFp
|
|
315
|
-
.createTabularExport(requestParameters.workspaceId, requestParameters.tabularExportRequest, options)
|
|
316
|
-
.then((request) => request(axios, basePath));
|
|
317
|
-
},
|
|
318
|
-
/**
|
|
319
|
-
* Returns 202 until original POST export request is not processed.Returns 200 with exported data once the export is done.
|
|
320
|
-
* @summary Retrieve exported files
|
|
321
|
-
* @param {ActionsApiGetExportedFileRequest} requestParameters Request parameters.
|
|
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.
|
|
322
1332
|
* @param {*} [options] Override http request option.
|
|
323
1333
|
* @throws {RequiredError}
|
|
324
1334
|
*/
|
|
325
|
-
|
|
1335
|
+
createSlideshowExport(requestParameters, options) {
|
|
326
1336
|
return localVarFp
|
|
327
|
-
.
|
|
1337
|
+
.createSlideshowExport(requestParameters.workspaceId, requestParameters.slideshowExportRequest, options)
|
|
328
1338
|
.then((request) => request(axios, basePath));
|
|
329
1339
|
},
|
|
330
1340
|
/**
|
|
331
|
-
* 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/
|
|
332
|
-
* @summary Retrieve metadata context
|
|
333
|
-
* @param {
|
|
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.
|
|
334
1344
|
* @param {*} [options] Override http request option.
|
|
335
1345
|
* @throws {RequiredError}
|
|
336
1346
|
*/
|
|
337
|
-
|
|
1347
|
+
getMetadata1(requestParameters, options) {
|
|
338
1348
|
return localVarFp
|
|
339
|
-
.
|
|
1349
|
+
.getMetadata1(requestParameters.workspaceId, requestParameters.exportId, options)
|
|
340
1350
|
.then((request) => request(axios, basePath));
|
|
341
1351
|
},
|
|
342
1352
|
/**
|
|
343
|
-
* 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.
|
|
344
|
-
* @summary Retrieve exported files
|
|
345
|
-
* @param {
|
|
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.
|
|
346
1356
|
* @param {*} [options] Override http request option.
|
|
347
1357
|
* @throws {RequiredError}
|
|
348
1358
|
*/
|
|
349
|
-
|
|
1359
|
+
getSlideshowExport(requestParameters, options) {
|
|
350
1360
|
return localVarFp
|
|
351
|
-
.
|
|
1361
|
+
.getSlideshowExport(requestParameters.workspaceId, requestParameters.exportId, options)
|
|
352
1362
|
.then((request) => request(axios, basePath));
|
|
353
1363
|
},
|
|
354
1364
|
};
|
|
355
1365
|
};
|
|
356
1366
|
/**
|
|
357
|
-
*
|
|
1367
|
+
* SlideshowExportApi - object-oriented interface
|
|
358
1368
|
* @export
|
|
359
|
-
* @class
|
|
1369
|
+
* @class SlideshowExportApi
|
|
360
1370
|
* @extends {BaseAPI}
|
|
361
1371
|
*/
|
|
362
|
-
export class
|
|
363
|
-
/**
|
|
364
|
-
* An visual 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.
|
|
365
|
-
* @summary Create visual - pdf export request
|
|
366
|
-
* @param {ActionsApiCreatePdfExportRequest} requestParameters Request parameters.
|
|
367
|
-
* @param {*} [options] Override http request option.
|
|
368
|
-
* @throws {RequiredError}
|
|
369
|
-
* @memberof ActionsApi
|
|
370
|
-
*/
|
|
371
|
-
createPdfExport(requestParameters, options) {
|
|
372
|
-
return ActionsApiFp(this.configuration)
|
|
373
|
-
.createPdfExport(requestParameters.workspaceId, requestParameters.visualExportRequest, options)
|
|
374
|
-
.then((request) => request(this.axios, this.basePath));
|
|
375
|
-
}
|
|
376
|
-
/**
|
|
377
|
-
* 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.
|
|
378
|
-
* @summary Create tabular export request
|
|
379
|
-
* @param {ActionsApiCreateTabularExportRequest} requestParameters Request parameters.
|
|
380
|
-
* @param {*} [options] Override http request option.
|
|
381
|
-
* @throws {RequiredError}
|
|
382
|
-
* @memberof ActionsApi
|
|
383
|
-
*/
|
|
384
|
-
createTabularExport(requestParameters, options) {
|
|
385
|
-
return ActionsApiFp(this.configuration)
|
|
386
|
-
.createTabularExport(requestParameters.workspaceId, requestParameters.tabularExportRequest, options)
|
|
387
|
-
.then((request) => request(this.axios, this.basePath));
|
|
388
|
-
}
|
|
1372
|
+
export class SlideshowExportApi extends BaseAPI {
|
|
389
1373
|
/**
|
|
390
|
-
*
|
|
391
|
-
* @summary
|
|
392
|
-
* @param {
|
|
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.
|
|
393
1377
|
* @param {*} [options] Override http request option.
|
|
394
1378
|
* @throws {RequiredError}
|
|
395
|
-
* @memberof
|
|
1379
|
+
* @memberof SlideshowExportApi
|
|
396
1380
|
*/
|
|
397
|
-
|
|
398
|
-
return
|
|
399
|
-
.
|
|
1381
|
+
createSlideshowExport(requestParameters, options) {
|
|
1382
|
+
return SlideshowExportApiFp(this.configuration)
|
|
1383
|
+
.createSlideshowExport(requestParameters.workspaceId, requestParameters.slideshowExportRequest, options)
|
|
400
1384
|
.then((request) => request(this.axios, this.basePath));
|
|
401
1385
|
}
|
|
402
1386
|
/**
|
|
403
|
-
* 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/
|
|
404
|
-
* @summary Retrieve metadata context
|
|
405
|
-
* @param {
|
|
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.
|
|
406
1390
|
* @param {*} [options] Override http request option.
|
|
407
1391
|
* @throws {RequiredError}
|
|
408
|
-
* @memberof
|
|
1392
|
+
* @memberof SlideshowExportApi
|
|
409
1393
|
*/
|
|
410
|
-
|
|
411
|
-
return
|
|
412
|
-
.
|
|
1394
|
+
getMetadata1(requestParameters, options) {
|
|
1395
|
+
return SlideshowExportApiFp(this.configuration)
|
|
1396
|
+
.getMetadata1(requestParameters.workspaceId, requestParameters.exportId, options)
|
|
413
1397
|
.then((request) => request(this.axios, this.basePath));
|
|
414
1398
|
}
|
|
415
1399
|
/**
|
|
416
|
-
* 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.
|
|
417
|
-
* @summary Retrieve exported files
|
|
418
|
-
* @param {
|
|
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.
|
|
419
1403
|
* @param {*} [options] Override http request option.
|
|
420
1404
|
* @throws {RequiredError}
|
|
421
|
-
* @memberof
|
|
1405
|
+
* @memberof SlideshowExportApi
|
|
422
1406
|
*/
|
|
423
|
-
|
|
424
|
-
return
|
|
425
|
-
.
|
|
1407
|
+
getSlideshowExport(requestParameters, options) {
|
|
1408
|
+
return SlideshowExportApiFp(this.configuration)
|
|
1409
|
+
.getSlideshowExport(requestParameters.workspaceId, requestParameters.exportId, options)
|
|
426
1410
|
.then((request) => request(this.axios, this.basePath));
|
|
427
1411
|
}
|
|
428
1412
|
}
|
|
@@ -432,6 +1416,43 @@ export class ActionsApi extends BaseAPI {
|
|
|
432
1416
|
*/
|
|
433
1417
|
export const TabularExportApiAxiosParamCreator = function (configuration) {
|
|
434
1418
|
return {
|
|
1419
|
+
/**
|
|
1420
|
+
* Note: This API is an experimental and is going to change. Please, use it accordingly.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.
|
|
1421
|
+
* @summary (EXPERIMENTAL) Create dashboard tabular export request
|
|
1422
|
+
* @param {string} workspaceId
|
|
1423
|
+
* @param {string} dashboardId
|
|
1424
|
+
* @param {*} [options] Override http request option.
|
|
1425
|
+
* @throws {RequiredError}
|
|
1426
|
+
*/
|
|
1427
|
+
createDashboardExportRequest: async (workspaceId, dashboardId, options = {}) => {
|
|
1428
|
+
// verify required parameter 'workspaceId' is not null or undefined
|
|
1429
|
+
assertParamExists("createDashboardExportRequest", "workspaceId", workspaceId);
|
|
1430
|
+
// verify required parameter 'dashboardId' is not null or undefined
|
|
1431
|
+
assertParamExists("createDashboardExportRequest", "dashboardId", dashboardId);
|
|
1432
|
+
const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/export/tabular`
|
|
1433
|
+
.replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)))
|
|
1434
|
+
.replace(`{${"dashboardId"}}`, encodeURIComponent(String(dashboardId)));
|
|
1435
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1436
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1437
|
+
let baseOptions;
|
|
1438
|
+
if (configuration) {
|
|
1439
|
+
baseOptions = configuration.baseOptions;
|
|
1440
|
+
}
|
|
1441
|
+
const localVarRequestOptions = { method: "POST", ...baseOptions, ...options };
|
|
1442
|
+
const localVarHeaderParameter = {};
|
|
1443
|
+
const localVarQueryParameter = {};
|
|
1444
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1445
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1446
|
+
localVarRequestOptions.headers = {
|
|
1447
|
+
...localVarHeaderParameter,
|
|
1448
|
+
...headersFromBaseOptions,
|
|
1449
|
+
...options.headers,
|
|
1450
|
+
};
|
|
1451
|
+
return {
|
|
1452
|
+
url: toPathString(localVarUrlObj),
|
|
1453
|
+
options: localVarRequestOptions,
|
|
1454
|
+
};
|
|
1455
|
+
},
|
|
435
1456
|
/**
|
|
436
1457
|
* 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.
|
|
437
1458
|
* @summary Create tabular export request
|
|
@@ -519,6 +1540,18 @@ export const TabularExportApiAxiosParamCreator = function (configuration) {
|
|
|
519
1540
|
export const TabularExportApiFp = function (configuration) {
|
|
520
1541
|
const localVarAxiosParamCreator = TabularExportApiAxiosParamCreator(configuration);
|
|
521
1542
|
return {
|
|
1543
|
+
/**
|
|
1544
|
+
* Note: This API is an experimental and is going to change. Please, use it accordingly.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.
|
|
1545
|
+
* @summary (EXPERIMENTAL) Create dashboard tabular export request
|
|
1546
|
+
* @param {string} workspaceId
|
|
1547
|
+
* @param {string} dashboardId
|
|
1548
|
+
* @param {*} [options] Override http request option.
|
|
1549
|
+
* @throws {RequiredError}
|
|
1550
|
+
*/
|
|
1551
|
+
async createDashboardExportRequest(workspaceId, dashboardId, options) {
|
|
1552
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createDashboardExportRequest(workspaceId, dashboardId, options);
|
|
1553
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1554
|
+
},
|
|
522
1555
|
/**
|
|
523
1556
|
* 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.
|
|
524
1557
|
* @summary Create tabular export request
|
|
@@ -552,6 +1585,18 @@ export const TabularExportApiFp = function (configuration) {
|
|
|
552
1585
|
export const TabularExportApiFactory = function (configuration, basePath, axios) {
|
|
553
1586
|
const localVarFp = TabularExportApiFp(configuration);
|
|
554
1587
|
return {
|
|
1588
|
+
/**
|
|
1589
|
+
* Note: This API is an experimental and is going to change. Please, use it accordingly.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.
|
|
1590
|
+
* @summary (EXPERIMENTAL) Create dashboard tabular export request
|
|
1591
|
+
* @param {TabularExportApiCreateDashboardExportRequestRequest} requestParameters Request parameters.
|
|
1592
|
+
* @param {*} [options] Override http request option.
|
|
1593
|
+
* @throws {RequiredError}
|
|
1594
|
+
*/
|
|
1595
|
+
createDashboardExportRequest(requestParameters, options) {
|
|
1596
|
+
return localVarFp
|
|
1597
|
+
.createDashboardExportRequest(requestParameters.workspaceId, requestParameters.dashboardId, options)
|
|
1598
|
+
.then((request) => request(axios, basePath));
|
|
1599
|
+
},
|
|
555
1600
|
/**
|
|
556
1601
|
* 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.
|
|
557
1602
|
* @summary Create tabular export request
|
|
@@ -585,6 +1630,19 @@ export const TabularExportApiFactory = function (configuration, basePath, axios)
|
|
|
585
1630
|
* @extends {BaseAPI}
|
|
586
1631
|
*/
|
|
587
1632
|
export class TabularExportApi extends BaseAPI {
|
|
1633
|
+
/**
|
|
1634
|
+
* Note: This API is an experimental and is going to change. Please, use it accordingly.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.
|
|
1635
|
+
* @summary (EXPERIMENTAL) Create dashboard tabular export request
|
|
1636
|
+
* @param {TabularExportApiCreateDashboardExportRequestRequest} requestParameters Request parameters.
|
|
1637
|
+
* @param {*} [options] Override http request option.
|
|
1638
|
+
* @throws {RequiredError}
|
|
1639
|
+
* @memberof TabularExportApi
|
|
1640
|
+
*/
|
|
1641
|
+
createDashboardExportRequest(requestParameters, options) {
|
|
1642
|
+
return TabularExportApiFp(this.configuration)
|
|
1643
|
+
.createDashboardExportRequest(requestParameters.workspaceId, requestParameters.dashboardId, options)
|
|
1644
|
+
.then((request) => request(this.axios, this.basePath));
|
|
1645
|
+
}
|
|
588
1646
|
/**
|
|
589
1647
|
* 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.
|
|
590
1648
|
* @summary Create tabular export request
|