@gooddata/api-client-tiger 10.33.0-alpha.2 → 10.33.0-alpha.21
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 +12623 -9742
- package/esm/client.d.ts +3 -3
- package/esm/client.d.ts.map +1 -1
- package/esm/client.js +2 -2
- package/esm/client.js.map +1 -1
- package/esm/export.d.ts +2 -4
- package/esm/export.d.ts.map +1 -1
- package/esm/export.js +2 -3
- package/esm/export.js.map +1 -1
- package/esm/generated/automation-json-api/api.d.ts +417 -0
- package/esm/generated/automation-json-api/api.d.ts.map +1 -1
- package/esm/generated/automation-json-api/api.js +57 -0
- package/esm/generated/automation-json-api/api.js.map +1 -1
- package/esm/generated/automation-json-api/openapi-spec.json +341 -1
- package/esm/generated/export-json-api/api.d.ts +1073 -1073
- package/esm/generated/export-json-api/api.d.ts.map +1 -1
- package/esm/generated/export-json-api/api.js +346 -342
- package/esm/generated/export-json-api/api.js.map +1 -1
- package/esm/generated/metadata-json-api/api.d.ts +1183 -588
- package/esm/generated/metadata-json-api/api.d.ts.map +1 -1
- package/esm/generated/metadata-json-api/api.js +250 -8
- package/esm/generated/metadata-json-api/api.js.map +1 -1
- package/esm/generated/metadata-json-api/openapi-spec.json +8918 -8515
- package/esm/index.d.ts +3 -1
- package/esm/index.d.ts.map +1 -1
- package/esm/index.js +1 -0
- package/esm/index.js.map +1 -1
- package/package.json +3 -3
|
@@ -8,19 +8,19 @@ 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
|
|
11
|
+
export const ExportAfmObjectIdentifierAttributeIdentifierTypeEnum = {
|
|
12
12
|
ATTRIBUTE: "attribute",
|
|
13
13
|
};
|
|
14
|
-
export const
|
|
14
|
+
export const ExportAfmObjectIdentifierCoreIdentifierTypeEnum = {
|
|
15
15
|
ATTRIBUTE: "attribute",
|
|
16
16
|
LABEL: "label",
|
|
17
17
|
FACT: "fact",
|
|
18
18
|
METRIC: "metric",
|
|
19
19
|
};
|
|
20
|
-
export const
|
|
20
|
+
export const ExportAfmObjectIdentifierDatasetIdentifierTypeEnum = {
|
|
21
21
|
DATASET: "dataset",
|
|
22
22
|
};
|
|
23
|
-
export const
|
|
23
|
+
export const ExportAfmObjectIdentifierIdentifierTypeEnum = {
|
|
24
24
|
ANALYTICAL_DASHBOARD: "analyticalDashboard",
|
|
25
25
|
ATTRIBUTE: "attribute",
|
|
26
26
|
DASHBOARD_PLUGIN: "dashboardPlugin",
|
|
@@ -32,17 +32,17 @@ export const AfmObjectIdentifierIdentifierTypeEnum = {
|
|
|
32
32
|
VISUALIZATION_OBJECT: "visualizationObject",
|
|
33
33
|
FILTER_CONTEXT: "filterContext",
|
|
34
34
|
};
|
|
35
|
-
export const
|
|
35
|
+
export const ExportAfmObjectIdentifierLabelIdentifierTypeEnum = {
|
|
36
36
|
LABEL: "label",
|
|
37
37
|
};
|
|
38
|
-
export const
|
|
38
|
+
export const ExportArithmeticMeasureDefinitionArithmeticMeasureOperatorEnum = {
|
|
39
39
|
SUM: "SUM",
|
|
40
40
|
DIFFERENCE: "DIFFERENCE",
|
|
41
41
|
MULTIPLICATION: "MULTIPLICATION",
|
|
42
42
|
RATIO: "RATIO",
|
|
43
43
|
CHANGE: "CHANGE",
|
|
44
44
|
};
|
|
45
|
-
export const
|
|
45
|
+
export const ExportComparisonMeasureValueFilterComparisonMeasureValueFilterOperatorEnum = {
|
|
46
46
|
GREATER_THAN: "GREATER_THAN",
|
|
47
47
|
GREATER_THAN_OR_EQUAL_TO: "GREATER_THAN_OR_EQUAL_TO",
|
|
48
48
|
LESS_THAN: "LESS_THAN",
|
|
@@ -50,15 +50,15 @@ export const ComparisonMeasureValueFilterComparisonMeasureValueFilterOperatorEnu
|
|
|
50
50
|
EQUAL_TO: "EQUAL_TO",
|
|
51
51
|
NOT_EQUAL_TO: "NOT_EQUAL_TO",
|
|
52
52
|
};
|
|
53
|
-
export const
|
|
53
|
+
export const ExportDashboardAttributeFilterAttributeFilterSelectionModeEnum = {
|
|
54
54
|
SINGLE: "single",
|
|
55
55
|
MULTI: "multi",
|
|
56
56
|
};
|
|
57
|
-
export const
|
|
57
|
+
export const ExportDashboardDateFilterDateFilterTypeEnum = {
|
|
58
58
|
RELATIVE: "relative",
|
|
59
59
|
ABSOLUTE: "absolute",
|
|
60
60
|
};
|
|
61
|
-
export const
|
|
61
|
+
export const ExportDashboardDateFilterDateFilterGranularityEnum = {
|
|
62
62
|
ALL_TIME_GRANULARITY: "ALL_TIME_GRANULARITY",
|
|
63
63
|
GDC_TIME_YEAR: "GDC.time.year",
|
|
64
64
|
GDC_TIME_WEEK_US: "GDC.time.week_us",
|
|
@@ -83,10 +83,10 @@ export const DashboardDateFilterDateFilterGranularityEnum = {
|
|
|
83
83
|
GDC_TIME_MINUTE: "GDC.time.minute",
|
|
84
84
|
GDC_TIME_MINUTE_IN_HOUR: "GDC.time.minute_in_hour",
|
|
85
85
|
};
|
|
86
|
-
export const
|
|
86
|
+
export const ExportDashboardTabularExportRequestFormatEnum = {
|
|
87
87
|
XLSX: "XLSX",
|
|
88
88
|
};
|
|
89
|
-
export const
|
|
89
|
+
export const ExportIdentifierRefIdentifierTypeEnum = {
|
|
90
90
|
ANALYTICAL_DASHBOARD: "analyticalDashboard",
|
|
91
91
|
ATTRIBUTE: "attribute",
|
|
92
92
|
ATTRIBUTE_HIERARCHY: "attributeHierarchy",
|
|
@@ -107,23 +107,23 @@ export const IdentifierRefIdentifierTypeEnum = {
|
|
|
107
107
|
WORKSPACE_DATA_FILTER_SETTING: "workspaceDataFilterSetting",
|
|
108
108
|
FILTER_VIEW: "filterView",
|
|
109
109
|
};
|
|
110
|
-
export const
|
|
110
|
+
export const ExportImageExportRequestFormatEnum = {
|
|
111
111
|
PNG: "PNG",
|
|
112
112
|
};
|
|
113
|
-
export const
|
|
113
|
+
export const ExportRangeMeasureValueFilterRangeMeasureValueFilterOperatorEnum = {
|
|
114
114
|
BETWEEN: "BETWEEN",
|
|
115
115
|
NOT_BETWEEN: "NOT_BETWEEN",
|
|
116
116
|
};
|
|
117
|
-
export const
|
|
117
|
+
export const ExportRankingFilterRankingFilterOperatorEnum = {
|
|
118
118
|
TOP: "TOP",
|
|
119
119
|
BOTTOM: "BOTTOM",
|
|
120
120
|
};
|
|
121
|
-
export const
|
|
121
|
+
export const ExportRawExportRequestFormatEnum = {
|
|
122
122
|
ARROW_FILE: "ARROW_FILE",
|
|
123
123
|
ARROW_STREAM: "ARROW_STREAM",
|
|
124
124
|
CSV: "CSV",
|
|
125
125
|
};
|
|
126
|
-
export const
|
|
126
|
+
export const ExportRelativeDateFilterRelativeDateFilterGranularityEnum = {
|
|
127
127
|
MINUTE: "MINUTE",
|
|
128
128
|
HOUR: "HOUR",
|
|
129
129
|
DAY: "DAY",
|
|
@@ -140,7 +140,7 @@ export const RelativeDateFilterRelativeDateFilterGranularityEnum = {
|
|
|
140
140
|
MONTH_OF_YEAR: "MONTH_OF_YEAR",
|
|
141
141
|
QUARTER_OF_YEAR: "QUARTER_OF_YEAR",
|
|
142
142
|
};
|
|
143
|
-
export const
|
|
143
|
+
export const ExportSimpleMeasureDefinitionMeasureAggregationEnum = {
|
|
144
144
|
SUM: "SUM",
|
|
145
145
|
COUNT: "COUNT",
|
|
146
146
|
AVG: "AVG",
|
|
@@ -150,38 +150,38 @@ export const SimpleMeasureDefinitionMeasureAggregationEnum = {
|
|
|
150
150
|
RUNSUM: "RUNSUM",
|
|
151
151
|
APPROXIMATE_COUNT: "APPROXIMATE_COUNT",
|
|
152
152
|
};
|
|
153
|
-
export const
|
|
153
|
+
export const ExportSlidesExportRequestFormatEnum = {
|
|
154
154
|
PDF: "PDF",
|
|
155
155
|
PPTX: "PPTX",
|
|
156
156
|
};
|
|
157
|
-
export const
|
|
157
|
+
export const ExportTabularExportRequestFormatEnum = {
|
|
158
158
|
CSV: "CSV",
|
|
159
159
|
XLSX: "XLSX",
|
|
160
160
|
HTML: "HTML",
|
|
161
161
|
PDF: "PDF",
|
|
162
162
|
};
|
|
163
163
|
/**
|
|
164
|
-
*
|
|
164
|
+
* ActionsExport - axios parameter creator
|
|
165
165
|
* @export
|
|
166
166
|
*/
|
|
167
|
-
export const
|
|
167
|
+
export const ActionsExportAxiosParamCreator = function (configuration) {
|
|
168
168
|
return {
|
|
169
169
|
/**
|
|
170
170
|
* 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.
|
|
171
171
|
* @summary (EXPERIMENTAL) Create dashboard tabular export request
|
|
172
172
|
* @param {string} workspaceId
|
|
173
173
|
* @param {string} dashboardId
|
|
174
|
-
* @param {
|
|
174
|
+
* @param {ExportDashboardTabularExportRequest} exportDashboardTabularExportRequest
|
|
175
175
|
* @param {*} [options] Override http request option.
|
|
176
176
|
* @throws {RequiredError}
|
|
177
177
|
*/
|
|
178
|
-
createDashboardExportRequest: async (workspaceId, dashboardId,
|
|
178
|
+
createDashboardExportRequest: async (workspaceId, dashboardId, exportDashboardTabularExportRequest, options = {}) => {
|
|
179
179
|
// verify required parameter 'workspaceId' is not null or undefined
|
|
180
180
|
assertParamExists("createDashboardExportRequest", "workspaceId", workspaceId);
|
|
181
181
|
// verify required parameter 'dashboardId' is not null or undefined
|
|
182
182
|
assertParamExists("createDashboardExportRequest", "dashboardId", dashboardId);
|
|
183
|
-
// verify required parameter '
|
|
184
|
-
assertParamExists("createDashboardExportRequest", "
|
|
183
|
+
// verify required parameter 'exportDashboardTabularExportRequest' is not null or undefined
|
|
184
|
+
assertParamExists("createDashboardExportRequest", "exportDashboardTabularExportRequest", exportDashboardTabularExportRequest);
|
|
185
185
|
const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/export/tabular`
|
|
186
186
|
.replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)))
|
|
187
187
|
.replace(`{${"dashboardId"}}`, encodeURIComponent(String(dashboardId)));
|
|
@@ -202,11 +202,13 @@ export const ActionsApiAxiosParamCreator = function (configuration) {
|
|
|
202
202
|
...headersFromBaseOptions,
|
|
203
203
|
...options.headers,
|
|
204
204
|
};
|
|
205
|
-
const needsSerialization = typeof
|
|
205
|
+
const needsSerialization = typeof exportDashboardTabularExportRequest !== "string" ||
|
|
206
206
|
localVarRequestOptions.headers["Content-Type"] === "application/json";
|
|
207
207
|
localVarRequestOptions.data = needsSerialization
|
|
208
|
-
? JSON.stringify(
|
|
209
|
-
|
|
208
|
+
? JSON.stringify(exportDashboardTabularExportRequest !== undefined
|
|
209
|
+
? exportDashboardTabularExportRequest
|
|
210
|
+
: {})
|
|
211
|
+
: exportDashboardTabularExportRequest || "";
|
|
210
212
|
return {
|
|
211
213
|
url: toPathString(localVarUrlObj),
|
|
212
214
|
options: localVarRequestOptions,
|
|
@@ -216,15 +218,15 @@ export const ActionsApiAxiosParamCreator = function (configuration) {
|
|
|
216
218
|
* Note: This API is an experimental and is going to change. Please, use it accordingly. An image export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
|
|
217
219
|
* @summary (EXPERIMENTAL) Create image export request
|
|
218
220
|
* @param {string} workspaceId
|
|
219
|
-
* @param {
|
|
221
|
+
* @param {ExportImageExportRequest} exportImageExportRequest
|
|
220
222
|
* @param {*} [options] Override http request option.
|
|
221
223
|
* @throws {RequiredError}
|
|
222
224
|
*/
|
|
223
|
-
createImageExport: async (workspaceId,
|
|
225
|
+
createImageExport: async (workspaceId, exportImageExportRequest, options = {}) => {
|
|
224
226
|
// verify required parameter 'workspaceId' is not null or undefined
|
|
225
227
|
assertParamExists("createImageExport", "workspaceId", workspaceId);
|
|
226
|
-
// verify required parameter '
|
|
227
|
-
assertParamExists("createImageExport", "
|
|
228
|
+
// verify required parameter 'exportImageExportRequest' is not null or undefined
|
|
229
|
+
assertParamExists("createImageExport", "exportImageExportRequest", exportImageExportRequest);
|
|
228
230
|
const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/export/image`.replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)));
|
|
229
231
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
230
232
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -243,11 +245,11 @@ export const ActionsApiAxiosParamCreator = function (configuration) {
|
|
|
243
245
|
...headersFromBaseOptions,
|
|
244
246
|
...options.headers,
|
|
245
247
|
};
|
|
246
|
-
const needsSerialization = typeof
|
|
248
|
+
const needsSerialization = typeof exportImageExportRequest !== "string" ||
|
|
247
249
|
localVarRequestOptions.headers["Content-Type"] === "application/json";
|
|
248
250
|
localVarRequestOptions.data = needsSerialization
|
|
249
|
-
? JSON.stringify(
|
|
250
|
-
:
|
|
251
|
+
? JSON.stringify(exportImageExportRequest !== undefined ? exportImageExportRequest : {})
|
|
252
|
+
: exportImageExportRequest || "";
|
|
251
253
|
return {
|
|
252
254
|
url: toPathString(localVarUrlObj),
|
|
253
255
|
options: localVarRequestOptions,
|
|
@@ -257,15 +259,15 @@ export const ActionsApiAxiosParamCreator = function (configuration) {
|
|
|
257
259
|
* 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.
|
|
258
260
|
* @summary Create visual - pdf export request
|
|
259
261
|
* @param {string} workspaceId
|
|
260
|
-
* @param {
|
|
262
|
+
* @param {ExportVisualExportRequest} exportVisualExportRequest
|
|
261
263
|
* @param {*} [options] Override http request option.
|
|
262
264
|
* @throws {RequiredError}
|
|
263
265
|
*/
|
|
264
|
-
createPdfExport: async (workspaceId,
|
|
266
|
+
createPdfExport: async (workspaceId, exportVisualExportRequest, options = {}) => {
|
|
265
267
|
// verify required parameter 'workspaceId' is not null or undefined
|
|
266
268
|
assertParamExists("createPdfExport", "workspaceId", workspaceId);
|
|
267
|
-
// verify required parameter '
|
|
268
|
-
assertParamExists("createPdfExport", "
|
|
269
|
+
// verify required parameter 'exportVisualExportRequest' is not null or undefined
|
|
270
|
+
assertParamExists("createPdfExport", "exportVisualExportRequest", exportVisualExportRequest);
|
|
269
271
|
const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/export/visual`.replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)));
|
|
270
272
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
271
273
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -284,11 +286,11 @@ export const ActionsApiAxiosParamCreator = function (configuration) {
|
|
|
284
286
|
...headersFromBaseOptions,
|
|
285
287
|
...options.headers,
|
|
286
288
|
};
|
|
287
|
-
const needsSerialization = typeof
|
|
289
|
+
const needsSerialization = typeof exportVisualExportRequest !== "string" ||
|
|
288
290
|
localVarRequestOptions.headers["Content-Type"] === "application/json";
|
|
289
291
|
localVarRequestOptions.data = needsSerialization
|
|
290
|
-
? JSON.stringify(
|
|
291
|
-
:
|
|
292
|
+
? JSON.stringify(exportVisualExportRequest !== undefined ? exportVisualExportRequest : {})
|
|
293
|
+
: exportVisualExportRequest || "";
|
|
292
294
|
return {
|
|
293
295
|
url: toPathString(localVarUrlObj),
|
|
294
296
|
options: localVarRequestOptions,
|
|
@@ -298,15 +300,15 @@ export const ActionsApiAxiosParamCreator = function (configuration) {
|
|
|
298
300
|
* 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.
|
|
299
301
|
* @summary (EXPERIMENTAL) Create raw export request
|
|
300
302
|
* @param {string} workspaceId
|
|
301
|
-
* @param {
|
|
303
|
+
* @param {ExportRawExportRequest} exportRawExportRequest
|
|
302
304
|
* @param {*} [options] Override http request option.
|
|
303
305
|
* @throws {RequiredError}
|
|
304
306
|
*/
|
|
305
|
-
createRawExport: async (workspaceId,
|
|
307
|
+
createRawExport: async (workspaceId, exportRawExportRequest, options = {}) => {
|
|
306
308
|
// verify required parameter 'workspaceId' is not null or undefined
|
|
307
309
|
assertParamExists("createRawExport", "workspaceId", workspaceId);
|
|
308
|
-
// verify required parameter '
|
|
309
|
-
assertParamExists("createRawExport", "
|
|
310
|
+
// verify required parameter 'exportRawExportRequest' is not null or undefined
|
|
311
|
+
assertParamExists("createRawExport", "exportRawExportRequest", exportRawExportRequest);
|
|
310
312
|
const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/export/raw`.replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)));
|
|
311
313
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
312
314
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -325,11 +327,11 @@ export const ActionsApiAxiosParamCreator = function (configuration) {
|
|
|
325
327
|
...headersFromBaseOptions,
|
|
326
328
|
...options.headers,
|
|
327
329
|
};
|
|
328
|
-
const needsSerialization = typeof
|
|
330
|
+
const needsSerialization = typeof exportRawExportRequest !== "string" ||
|
|
329
331
|
localVarRequestOptions.headers["Content-Type"] === "application/json";
|
|
330
332
|
localVarRequestOptions.data = needsSerialization
|
|
331
|
-
? JSON.stringify(
|
|
332
|
-
:
|
|
333
|
+
? JSON.stringify(exportRawExportRequest !== undefined ? exportRawExportRequest : {})
|
|
334
|
+
: exportRawExportRequest || "";
|
|
333
335
|
return {
|
|
334
336
|
url: toPathString(localVarUrlObj),
|
|
335
337
|
options: localVarRequestOptions,
|
|
@@ -339,15 +341,15 @@ export const ActionsApiAxiosParamCreator = function (configuration) {
|
|
|
339
341
|
* Note: This API is an experimental and is going to change. Please, use it accordingly. A slides export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
|
|
340
342
|
* @summary (EXPERIMENTAL) Create slides export request
|
|
341
343
|
* @param {string} workspaceId
|
|
342
|
-
* @param {
|
|
344
|
+
* @param {ExportSlidesExportRequest} exportSlidesExportRequest
|
|
343
345
|
* @param {*} [options] Override http request option.
|
|
344
346
|
* @throws {RequiredError}
|
|
345
347
|
*/
|
|
346
|
-
createSlidesExport: async (workspaceId,
|
|
348
|
+
createSlidesExport: async (workspaceId, exportSlidesExportRequest, options = {}) => {
|
|
347
349
|
// verify required parameter 'workspaceId' is not null or undefined
|
|
348
350
|
assertParamExists("createSlidesExport", "workspaceId", workspaceId);
|
|
349
|
-
// verify required parameter '
|
|
350
|
-
assertParamExists("createSlidesExport", "
|
|
351
|
+
// verify required parameter 'exportSlidesExportRequest' is not null or undefined
|
|
352
|
+
assertParamExists("createSlidesExport", "exportSlidesExportRequest", exportSlidesExportRequest);
|
|
351
353
|
const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/export/slides`.replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)));
|
|
352
354
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
353
355
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -366,11 +368,11 @@ export const ActionsApiAxiosParamCreator = function (configuration) {
|
|
|
366
368
|
...headersFromBaseOptions,
|
|
367
369
|
...options.headers,
|
|
368
370
|
};
|
|
369
|
-
const needsSerialization = typeof
|
|
371
|
+
const needsSerialization = typeof exportSlidesExportRequest !== "string" ||
|
|
370
372
|
localVarRequestOptions.headers["Content-Type"] === "application/json";
|
|
371
373
|
localVarRequestOptions.data = needsSerialization
|
|
372
|
-
? JSON.stringify(
|
|
373
|
-
:
|
|
374
|
+
? JSON.stringify(exportSlidesExportRequest !== undefined ? exportSlidesExportRequest : {})
|
|
375
|
+
: exportSlidesExportRequest || "";
|
|
374
376
|
return {
|
|
375
377
|
url: toPathString(localVarUrlObj),
|
|
376
378
|
options: localVarRequestOptions,
|
|
@@ -380,15 +382,15 @@ export const ActionsApiAxiosParamCreator = function (configuration) {
|
|
|
380
382
|
* 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.
|
|
381
383
|
* @summary Create tabular export request
|
|
382
384
|
* @param {string} workspaceId
|
|
383
|
-
* @param {
|
|
385
|
+
* @param {ExportTabularExportRequest} exportTabularExportRequest
|
|
384
386
|
* @param {*} [options] Override http request option.
|
|
385
387
|
* @throws {RequiredError}
|
|
386
388
|
*/
|
|
387
|
-
createTabularExport: async (workspaceId,
|
|
389
|
+
createTabularExport: async (workspaceId, exportTabularExportRequest, options = {}) => {
|
|
388
390
|
// verify required parameter 'workspaceId' is not null or undefined
|
|
389
391
|
assertParamExists("createTabularExport", "workspaceId", workspaceId);
|
|
390
|
-
// verify required parameter '
|
|
391
|
-
assertParamExists("createTabularExport", "
|
|
392
|
+
// verify required parameter 'exportTabularExportRequest' is not null or undefined
|
|
393
|
+
assertParamExists("createTabularExport", "exportTabularExportRequest", exportTabularExportRequest);
|
|
392
394
|
const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/export/tabular`.replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)));
|
|
393
395
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
394
396
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -407,11 +409,11 @@ export const ActionsApiAxiosParamCreator = function (configuration) {
|
|
|
407
409
|
...headersFromBaseOptions,
|
|
408
410
|
...options.headers,
|
|
409
411
|
};
|
|
410
|
-
const needsSerialization = typeof
|
|
412
|
+
const needsSerialization = typeof exportTabularExportRequest !== "string" ||
|
|
411
413
|
localVarRequestOptions.headers["Content-Type"] === "application/json";
|
|
412
414
|
localVarRequestOptions.data = needsSerialization
|
|
413
|
-
? JSON.stringify(
|
|
414
|
-
:
|
|
415
|
+
? JSON.stringify(exportTabularExportRequest !== undefined ? exportTabularExportRequest : {})
|
|
416
|
+
: exportTabularExportRequest || "";
|
|
415
417
|
return {
|
|
416
418
|
url: toPathString(localVarUrlObj),
|
|
417
419
|
options: localVarRequestOptions,
|
|
@@ -716,83 +718,83 @@ export const ActionsApiAxiosParamCreator = function (configuration) {
|
|
|
716
718
|
};
|
|
717
719
|
};
|
|
718
720
|
/**
|
|
719
|
-
*
|
|
721
|
+
* ActionsExport - functional programming interface
|
|
720
722
|
* @export
|
|
721
723
|
*/
|
|
722
|
-
export const
|
|
723
|
-
const localVarAxiosParamCreator =
|
|
724
|
+
export const ActionsExportFp = function (configuration) {
|
|
725
|
+
const localVarAxiosParamCreator = ActionsExportAxiosParamCreator(configuration);
|
|
724
726
|
return {
|
|
725
727
|
/**
|
|
726
728
|
* 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.
|
|
727
729
|
* @summary (EXPERIMENTAL) Create dashboard tabular export request
|
|
728
730
|
* @param {string} workspaceId
|
|
729
731
|
* @param {string} dashboardId
|
|
730
|
-
* @param {
|
|
732
|
+
* @param {ExportDashboardTabularExportRequest} exportDashboardTabularExportRequest
|
|
731
733
|
* @param {*} [options] Override http request option.
|
|
732
734
|
* @throws {RequiredError}
|
|
733
735
|
*/
|
|
734
|
-
async createDashboardExportRequest(workspaceId, dashboardId,
|
|
735
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.createDashboardExportRequest(workspaceId, dashboardId,
|
|
736
|
+
async createDashboardExportRequest(workspaceId, dashboardId, exportDashboardTabularExportRequest, options) {
|
|
737
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createDashboardExportRequest(workspaceId, dashboardId, exportDashboardTabularExportRequest, options);
|
|
736
738
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
737
739
|
},
|
|
738
740
|
/**
|
|
739
741
|
* Note: This API is an experimental and is going to change. Please, use it accordingly. An image export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
|
|
740
742
|
* @summary (EXPERIMENTAL) Create image export request
|
|
741
743
|
* @param {string} workspaceId
|
|
742
|
-
* @param {
|
|
744
|
+
* @param {ExportImageExportRequest} exportImageExportRequest
|
|
743
745
|
* @param {*} [options] Override http request option.
|
|
744
746
|
* @throws {RequiredError}
|
|
745
747
|
*/
|
|
746
|
-
async createImageExport(workspaceId,
|
|
747
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.createImageExport(workspaceId,
|
|
748
|
+
async createImageExport(workspaceId, exportImageExportRequest, options) {
|
|
749
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createImageExport(workspaceId, exportImageExportRequest, options);
|
|
748
750
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
749
751
|
},
|
|
750
752
|
/**
|
|
751
753
|
* 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.
|
|
752
754
|
* @summary Create visual - pdf export request
|
|
753
755
|
* @param {string} workspaceId
|
|
754
|
-
* @param {
|
|
756
|
+
* @param {ExportVisualExportRequest} exportVisualExportRequest
|
|
755
757
|
* @param {*} [options] Override http request option.
|
|
756
758
|
* @throws {RequiredError}
|
|
757
759
|
*/
|
|
758
|
-
async createPdfExport(workspaceId,
|
|
759
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.createPdfExport(workspaceId,
|
|
760
|
+
async createPdfExport(workspaceId, exportVisualExportRequest, options) {
|
|
761
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createPdfExport(workspaceId, exportVisualExportRequest, options);
|
|
760
762
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
761
763
|
},
|
|
762
764
|
/**
|
|
763
765
|
* 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.
|
|
764
766
|
* @summary (EXPERIMENTAL) Create raw export request
|
|
765
767
|
* @param {string} workspaceId
|
|
766
|
-
* @param {
|
|
768
|
+
* @param {ExportRawExportRequest} exportRawExportRequest
|
|
767
769
|
* @param {*} [options] Override http request option.
|
|
768
770
|
* @throws {RequiredError}
|
|
769
771
|
*/
|
|
770
|
-
async createRawExport(workspaceId,
|
|
771
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.createRawExport(workspaceId,
|
|
772
|
+
async createRawExport(workspaceId, exportRawExportRequest, options) {
|
|
773
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createRawExport(workspaceId, exportRawExportRequest, options);
|
|
772
774
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
773
775
|
},
|
|
774
776
|
/**
|
|
775
777
|
* Note: This API is an experimental and is going to change. Please, use it accordingly. A slides export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
|
|
776
778
|
* @summary (EXPERIMENTAL) Create slides export request
|
|
777
779
|
* @param {string} workspaceId
|
|
778
|
-
* @param {
|
|
780
|
+
* @param {ExportSlidesExportRequest} exportSlidesExportRequest
|
|
779
781
|
* @param {*} [options] Override http request option.
|
|
780
782
|
* @throws {RequiredError}
|
|
781
783
|
*/
|
|
782
|
-
async createSlidesExport(workspaceId,
|
|
783
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.createSlidesExport(workspaceId,
|
|
784
|
+
async createSlidesExport(workspaceId, exportSlidesExportRequest, options) {
|
|
785
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createSlidesExport(workspaceId, exportSlidesExportRequest, options);
|
|
784
786
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
785
787
|
},
|
|
786
788
|
/**
|
|
787
789
|
* 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.
|
|
788
790
|
* @summary Create tabular export request
|
|
789
791
|
* @param {string} workspaceId
|
|
790
|
-
* @param {
|
|
792
|
+
* @param {ExportTabularExportRequest} exportTabularExportRequest
|
|
791
793
|
* @param {*} [options] Override http request option.
|
|
792
794
|
* @throws {RequiredError}
|
|
793
795
|
*/
|
|
794
|
-
async createTabularExport(workspaceId,
|
|
795
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.createTabularExport(workspaceId,
|
|
796
|
+
async createTabularExport(workspaceId, exportTabularExportRequest, options) {
|
|
797
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createTabularExport(workspaceId, exportTabularExportRequest, options);
|
|
796
798
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
797
799
|
},
|
|
798
800
|
/**
|
|
@@ -894,88 +896,88 @@ export const ActionsApiFp = function (configuration) {
|
|
|
894
896
|
};
|
|
895
897
|
};
|
|
896
898
|
/**
|
|
897
|
-
*
|
|
899
|
+
* ActionsExport - factory interface
|
|
898
900
|
* @export
|
|
899
901
|
*/
|
|
900
|
-
export const
|
|
901
|
-
const localVarFp =
|
|
902
|
+
export const ActionsExportFactory = function (configuration, basePath, axios) {
|
|
903
|
+
const localVarFp = ActionsExportFp(configuration);
|
|
902
904
|
return {
|
|
903
905
|
/**
|
|
904
906
|
* 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.
|
|
905
907
|
* @summary (EXPERIMENTAL) Create dashboard tabular export request
|
|
906
|
-
* @param {
|
|
908
|
+
* @param {ActionsExportCreateDashboardExportRequestRequest} requestParameters Request parameters.
|
|
907
909
|
* @param {*} [options] Override http request option.
|
|
908
910
|
* @throws {RequiredError}
|
|
909
911
|
*/
|
|
910
912
|
createDashboardExportRequest(requestParameters, options) {
|
|
911
913
|
return localVarFp
|
|
912
|
-
.createDashboardExportRequest(requestParameters.workspaceId, requestParameters.dashboardId, requestParameters.
|
|
914
|
+
.createDashboardExportRequest(requestParameters.workspaceId, requestParameters.dashboardId, requestParameters.exportDashboardTabularExportRequest, options)
|
|
913
915
|
.then((request) => request(axios, basePath));
|
|
914
916
|
},
|
|
915
917
|
/**
|
|
916
918
|
* Note: This API is an experimental and is going to change. Please, use it accordingly. An image export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
|
|
917
919
|
* @summary (EXPERIMENTAL) Create image export request
|
|
918
|
-
* @param {
|
|
920
|
+
* @param {ActionsExportCreateImageExportRequest} requestParameters Request parameters.
|
|
919
921
|
* @param {*} [options] Override http request option.
|
|
920
922
|
* @throws {RequiredError}
|
|
921
923
|
*/
|
|
922
924
|
createImageExport(requestParameters, options) {
|
|
923
925
|
return localVarFp
|
|
924
|
-
.createImageExport(requestParameters.workspaceId, requestParameters.
|
|
926
|
+
.createImageExport(requestParameters.workspaceId, requestParameters.exportImageExportRequest, options)
|
|
925
927
|
.then((request) => request(axios, basePath));
|
|
926
928
|
},
|
|
927
929
|
/**
|
|
928
930
|
* 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.
|
|
929
931
|
* @summary Create visual - pdf export request
|
|
930
|
-
* @param {
|
|
932
|
+
* @param {ActionsExportCreatePdfExportRequest} requestParameters Request parameters.
|
|
931
933
|
* @param {*} [options] Override http request option.
|
|
932
934
|
* @throws {RequiredError}
|
|
933
935
|
*/
|
|
934
936
|
createPdfExport(requestParameters, options) {
|
|
935
937
|
return localVarFp
|
|
936
|
-
.createPdfExport(requestParameters.workspaceId, requestParameters.
|
|
938
|
+
.createPdfExport(requestParameters.workspaceId, requestParameters.exportVisualExportRequest, options)
|
|
937
939
|
.then((request) => request(axios, basePath));
|
|
938
940
|
},
|
|
939
941
|
/**
|
|
940
942
|
* 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.
|
|
941
943
|
* @summary (EXPERIMENTAL) Create raw export request
|
|
942
|
-
* @param {
|
|
944
|
+
* @param {ActionsExportCreateRawExportRequest} requestParameters Request parameters.
|
|
943
945
|
* @param {*} [options] Override http request option.
|
|
944
946
|
* @throws {RequiredError}
|
|
945
947
|
*/
|
|
946
948
|
createRawExport(requestParameters, options) {
|
|
947
949
|
return localVarFp
|
|
948
|
-
.createRawExport(requestParameters.workspaceId, requestParameters.
|
|
950
|
+
.createRawExport(requestParameters.workspaceId, requestParameters.exportRawExportRequest, options)
|
|
949
951
|
.then((request) => request(axios, basePath));
|
|
950
952
|
},
|
|
951
953
|
/**
|
|
952
954
|
* Note: This API is an experimental and is going to change. Please, use it accordingly. A slides export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
|
|
953
955
|
* @summary (EXPERIMENTAL) Create slides export request
|
|
954
|
-
* @param {
|
|
956
|
+
* @param {ActionsExportCreateSlidesExportRequest} requestParameters Request parameters.
|
|
955
957
|
* @param {*} [options] Override http request option.
|
|
956
958
|
* @throws {RequiredError}
|
|
957
959
|
*/
|
|
958
960
|
createSlidesExport(requestParameters, options) {
|
|
959
961
|
return localVarFp
|
|
960
|
-
.createSlidesExport(requestParameters.workspaceId, requestParameters.
|
|
962
|
+
.createSlidesExport(requestParameters.workspaceId, requestParameters.exportSlidesExportRequest, options)
|
|
961
963
|
.then((request) => request(axios, basePath));
|
|
962
964
|
},
|
|
963
965
|
/**
|
|
964
966
|
* 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.
|
|
965
967
|
* @summary Create tabular export request
|
|
966
|
-
* @param {
|
|
968
|
+
* @param {ActionsExportCreateTabularExportRequest} requestParameters Request parameters.
|
|
967
969
|
* @param {*} [options] Override http request option.
|
|
968
970
|
* @throws {RequiredError}
|
|
969
971
|
*/
|
|
970
972
|
createTabularExport(requestParameters, options) {
|
|
971
973
|
return localVarFp
|
|
972
|
-
.createTabularExport(requestParameters.workspaceId, requestParameters.
|
|
974
|
+
.createTabularExport(requestParameters.workspaceId, requestParameters.exportTabularExportRequest, options)
|
|
973
975
|
.then((request) => request(axios, basePath));
|
|
974
976
|
},
|
|
975
977
|
/**
|
|
976
978
|
* Returns 202 until original POST export request is not processed.Returns 200 with exported data once the export is done.
|
|
977
979
|
* @summary Retrieve exported files
|
|
978
|
-
* @param {
|
|
980
|
+
* @param {ActionsExportGetExportedFileRequest} requestParameters Request parameters.
|
|
979
981
|
* @param {*} [options] Override http request option.
|
|
980
982
|
* @throws {RequiredError}
|
|
981
983
|
*/
|
|
@@ -987,7 +989,7 @@ export const ActionsApiFactory = function (configuration, basePath, axios) {
|
|
|
987
989
|
/**
|
|
988
990
|
* 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.
|
|
989
991
|
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
990
|
-
* @param {
|
|
992
|
+
* @param {ActionsExportGetImageExportRequest} requestParameters Request parameters.
|
|
991
993
|
* @param {*} [options] Override http request option.
|
|
992
994
|
* @throws {RequiredError}
|
|
993
995
|
*/
|
|
@@ -999,7 +1001,7 @@ export const ActionsApiFactory = function (configuration, basePath, axios) {
|
|
|
999
1001
|
/**
|
|
1000
1002
|
* Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/image endpoint. The metadata structure is not verified.
|
|
1001
1003
|
* @summary (EXPERIMENTAL) Retrieve metadata context
|
|
1002
|
-
* @param {
|
|
1004
|
+
* @param {ActionsExportGetImageExportMetadataRequest} requestParameters Request parameters.
|
|
1003
1005
|
* @param {*} [options] Override http request option.
|
|
1004
1006
|
* @throws {RequiredError}
|
|
1005
1007
|
*/
|
|
@@ -1011,7 +1013,7 @@ export const ActionsApiFactory = function (configuration, basePath, axios) {
|
|
|
1011
1013
|
/**
|
|
1012
1014
|
* This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/visual endpoint. The metadata structure is not verified.
|
|
1013
1015
|
* @summary Retrieve metadata context
|
|
1014
|
-
* @param {
|
|
1016
|
+
* @param {ActionsExportGetMetadataRequest} requestParameters Request parameters.
|
|
1015
1017
|
* @param {*} [options] Override http request option.
|
|
1016
1018
|
* @throws {RequiredError}
|
|
1017
1019
|
*/
|
|
@@ -1023,7 +1025,7 @@ export const ActionsApiFactory = function (configuration, basePath, axios) {
|
|
|
1023
1025
|
/**
|
|
1024
1026
|
* 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.
|
|
1025
1027
|
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
1026
|
-
* @param {
|
|
1028
|
+
* @param {ActionsExportGetRawExportRequest} requestParameters Request parameters.
|
|
1027
1029
|
* @param {*} [options] Override http request option.
|
|
1028
1030
|
* @throws {RequiredError}
|
|
1029
1031
|
*/
|
|
@@ -1035,7 +1037,7 @@ export const ActionsApiFactory = function (configuration, basePath, axios) {
|
|
|
1035
1037
|
/**
|
|
1036
1038
|
* 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.
|
|
1037
1039
|
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
1038
|
-
* @param {
|
|
1040
|
+
* @param {ActionsExportGetSlidesExportRequest} requestParameters Request parameters.
|
|
1039
1041
|
* @param {*} [options] Override http request option.
|
|
1040
1042
|
* @throws {RequiredError}
|
|
1041
1043
|
*/
|
|
@@ -1047,7 +1049,7 @@ export const ActionsApiFactory = function (configuration, basePath, axios) {
|
|
|
1047
1049
|
/**
|
|
1048
1050
|
* Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/slides endpoint. The metadata structure is not verified.
|
|
1049
1051
|
* @summary (EXPERIMENTAL) Retrieve metadata context
|
|
1050
|
-
* @param {
|
|
1052
|
+
* @param {ActionsExportGetSlidesExportMetadataRequest} requestParameters Request parameters.
|
|
1051
1053
|
* @param {*} [options] Override http request option.
|
|
1052
1054
|
* @throws {RequiredError}
|
|
1053
1055
|
*/
|
|
@@ -1059,7 +1061,7 @@ export const ActionsApiFactory = function (configuration, basePath, axios) {
|
|
|
1059
1061
|
/**
|
|
1060
1062
|
* 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.
|
|
1061
1063
|
* @summary Retrieve exported files
|
|
1062
|
-
* @param {
|
|
1064
|
+
* @param {ActionsExportGetTabularExportRequest} requestParameters Request parameters.
|
|
1063
1065
|
* @param {*} [options] Override http request option.
|
|
1064
1066
|
* @throws {RequiredError}
|
|
1065
1067
|
*/
|
|
@@ -1071,214 +1073,214 @@ export const ActionsApiFactory = function (configuration, basePath, axios) {
|
|
|
1071
1073
|
};
|
|
1072
1074
|
};
|
|
1073
1075
|
/**
|
|
1074
|
-
*
|
|
1076
|
+
* ActionsExport - object-oriented interface
|
|
1075
1077
|
* @export
|
|
1076
|
-
* @class
|
|
1078
|
+
* @class ActionsExport
|
|
1077
1079
|
* @extends {BaseAPI}
|
|
1078
1080
|
*/
|
|
1079
|
-
export class
|
|
1081
|
+
export class ActionsExport extends BaseAPI {
|
|
1080
1082
|
/**
|
|
1081
1083
|
* 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.
|
|
1082
1084
|
* @summary (EXPERIMENTAL) Create dashboard tabular export request
|
|
1083
|
-
* @param {
|
|
1085
|
+
* @param {ActionsExportCreateDashboardExportRequestRequest} requestParameters Request parameters.
|
|
1084
1086
|
* @param {*} [options] Override http request option.
|
|
1085
1087
|
* @throws {RequiredError}
|
|
1086
|
-
* @memberof
|
|
1088
|
+
* @memberof ActionsExport
|
|
1087
1089
|
*/
|
|
1088
1090
|
createDashboardExportRequest(requestParameters, options) {
|
|
1089
|
-
return
|
|
1090
|
-
.createDashboardExportRequest(requestParameters.workspaceId, requestParameters.dashboardId, requestParameters.
|
|
1091
|
+
return ActionsExportFp(this.configuration)
|
|
1092
|
+
.createDashboardExportRequest(requestParameters.workspaceId, requestParameters.dashboardId, requestParameters.exportDashboardTabularExportRequest, options)
|
|
1091
1093
|
.then((request) => request(this.axios, this.basePath));
|
|
1092
1094
|
}
|
|
1093
1095
|
/**
|
|
1094
1096
|
* Note: This API is an experimental and is going to change. Please, use it accordingly. An image export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
|
|
1095
1097
|
* @summary (EXPERIMENTAL) Create image export request
|
|
1096
|
-
* @param {
|
|
1098
|
+
* @param {ActionsExportCreateImageExportRequest} requestParameters Request parameters.
|
|
1097
1099
|
* @param {*} [options] Override http request option.
|
|
1098
1100
|
* @throws {RequiredError}
|
|
1099
|
-
* @memberof
|
|
1101
|
+
* @memberof ActionsExport
|
|
1100
1102
|
*/
|
|
1101
1103
|
createImageExport(requestParameters, options) {
|
|
1102
|
-
return
|
|
1103
|
-
.createImageExport(requestParameters.workspaceId, requestParameters.
|
|
1104
|
+
return ActionsExportFp(this.configuration)
|
|
1105
|
+
.createImageExport(requestParameters.workspaceId, requestParameters.exportImageExportRequest, options)
|
|
1104
1106
|
.then((request) => request(this.axios, this.basePath));
|
|
1105
1107
|
}
|
|
1106
1108
|
/**
|
|
1107
1109
|
* 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.
|
|
1108
1110
|
* @summary Create visual - pdf export request
|
|
1109
|
-
* @param {
|
|
1111
|
+
* @param {ActionsExportCreatePdfExportRequest} requestParameters Request parameters.
|
|
1110
1112
|
* @param {*} [options] Override http request option.
|
|
1111
1113
|
* @throws {RequiredError}
|
|
1112
|
-
* @memberof
|
|
1114
|
+
* @memberof ActionsExport
|
|
1113
1115
|
*/
|
|
1114
1116
|
createPdfExport(requestParameters, options) {
|
|
1115
|
-
return
|
|
1116
|
-
.createPdfExport(requestParameters.workspaceId, requestParameters.
|
|
1117
|
+
return ActionsExportFp(this.configuration)
|
|
1118
|
+
.createPdfExport(requestParameters.workspaceId, requestParameters.exportVisualExportRequest, options)
|
|
1117
1119
|
.then((request) => request(this.axios, this.basePath));
|
|
1118
1120
|
}
|
|
1119
1121
|
/**
|
|
1120
1122
|
* 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.
|
|
1121
1123
|
* @summary (EXPERIMENTAL) Create raw export request
|
|
1122
|
-
* @param {
|
|
1124
|
+
* @param {ActionsExportCreateRawExportRequest} requestParameters Request parameters.
|
|
1123
1125
|
* @param {*} [options] Override http request option.
|
|
1124
1126
|
* @throws {RequiredError}
|
|
1125
|
-
* @memberof
|
|
1127
|
+
* @memberof ActionsExport
|
|
1126
1128
|
*/
|
|
1127
1129
|
createRawExport(requestParameters, options) {
|
|
1128
|
-
return
|
|
1129
|
-
.createRawExport(requestParameters.workspaceId, requestParameters.
|
|
1130
|
+
return ActionsExportFp(this.configuration)
|
|
1131
|
+
.createRawExport(requestParameters.workspaceId, requestParameters.exportRawExportRequest, options)
|
|
1130
1132
|
.then((request) => request(this.axios, this.basePath));
|
|
1131
1133
|
}
|
|
1132
1134
|
/**
|
|
1133
1135
|
* Note: This API is an experimental and is going to change. Please, use it accordingly. A slides export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
|
|
1134
1136
|
* @summary (EXPERIMENTAL) Create slides export request
|
|
1135
|
-
* @param {
|
|
1137
|
+
* @param {ActionsExportCreateSlidesExportRequest} requestParameters Request parameters.
|
|
1136
1138
|
* @param {*} [options] Override http request option.
|
|
1137
1139
|
* @throws {RequiredError}
|
|
1138
|
-
* @memberof
|
|
1140
|
+
* @memberof ActionsExport
|
|
1139
1141
|
*/
|
|
1140
1142
|
createSlidesExport(requestParameters, options) {
|
|
1141
|
-
return
|
|
1142
|
-
.createSlidesExport(requestParameters.workspaceId, requestParameters.
|
|
1143
|
+
return ActionsExportFp(this.configuration)
|
|
1144
|
+
.createSlidesExport(requestParameters.workspaceId, requestParameters.exportSlidesExportRequest, options)
|
|
1143
1145
|
.then((request) => request(this.axios, this.basePath));
|
|
1144
1146
|
}
|
|
1145
1147
|
/**
|
|
1146
1148
|
* 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.
|
|
1147
1149
|
* @summary Create tabular export request
|
|
1148
|
-
* @param {
|
|
1150
|
+
* @param {ActionsExportCreateTabularExportRequest} requestParameters Request parameters.
|
|
1149
1151
|
* @param {*} [options] Override http request option.
|
|
1150
1152
|
* @throws {RequiredError}
|
|
1151
|
-
* @memberof
|
|
1153
|
+
* @memberof ActionsExport
|
|
1152
1154
|
*/
|
|
1153
1155
|
createTabularExport(requestParameters, options) {
|
|
1154
|
-
return
|
|
1155
|
-
.createTabularExport(requestParameters.workspaceId, requestParameters.
|
|
1156
|
+
return ActionsExportFp(this.configuration)
|
|
1157
|
+
.createTabularExport(requestParameters.workspaceId, requestParameters.exportTabularExportRequest, options)
|
|
1156
1158
|
.then((request) => request(this.axios, this.basePath));
|
|
1157
1159
|
}
|
|
1158
1160
|
/**
|
|
1159
1161
|
* Returns 202 until original POST export request is not processed.Returns 200 with exported data once the export is done.
|
|
1160
1162
|
* @summary Retrieve exported files
|
|
1161
|
-
* @param {
|
|
1163
|
+
* @param {ActionsExportGetExportedFileRequest} requestParameters Request parameters.
|
|
1162
1164
|
* @param {*} [options] Override http request option.
|
|
1163
1165
|
* @throws {RequiredError}
|
|
1164
|
-
* @memberof
|
|
1166
|
+
* @memberof ActionsExport
|
|
1165
1167
|
*/
|
|
1166
1168
|
getExportedFile(requestParameters, options) {
|
|
1167
|
-
return
|
|
1169
|
+
return ActionsExportFp(this.configuration)
|
|
1168
1170
|
.getExportedFile(requestParameters.workspaceId, requestParameters.exportId, options)
|
|
1169
1171
|
.then((request) => request(this.axios, this.basePath));
|
|
1170
1172
|
}
|
|
1171
1173
|
/**
|
|
1172
1174
|
* 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.
|
|
1173
1175
|
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
1174
|
-
* @param {
|
|
1176
|
+
* @param {ActionsExportGetImageExportRequest} requestParameters Request parameters.
|
|
1175
1177
|
* @param {*} [options] Override http request option.
|
|
1176
1178
|
* @throws {RequiredError}
|
|
1177
|
-
* @memberof
|
|
1179
|
+
* @memberof ActionsExport
|
|
1178
1180
|
*/
|
|
1179
1181
|
getImageExport(requestParameters, options) {
|
|
1180
|
-
return
|
|
1182
|
+
return ActionsExportFp(this.configuration)
|
|
1181
1183
|
.getImageExport(requestParameters.workspaceId, requestParameters.exportId, options)
|
|
1182
1184
|
.then((request) => request(this.axios, this.basePath));
|
|
1183
1185
|
}
|
|
1184
1186
|
/**
|
|
1185
1187
|
* Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/image endpoint. The metadata structure is not verified.
|
|
1186
1188
|
* @summary (EXPERIMENTAL) Retrieve metadata context
|
|
1187
|
-
* @param {
|
|
1189
|
+
* @param {ActionsExportGetImageExportMetadataRequest} requestParameters Request parameters.
|
|
1188
1190
|
* @param {*} [options] Override http request option.
|
|
1189
1191
|
* @throws {RequiredError}
|
|
1190
|
-
* @memberof
|
|
1192
|
+
* @memberof ActionsExport
|
|
1191
1193
|
*/
|
|
1192
1194
|
getImageExportMetadata(requestParameters, options) {
|
|
1193
|
-
return
|
|
1195
|
+
return ActionsExportFp(this.configuration)
|
|
1194
1196
|
.getImageExportMetadata(requestParameters.workspaceId, requestParameters.exportId, options)
|
|
1195
1197
|
.then((request) => request(this.axios, this.basePath));
|
|
1196
1198
|
}
|
|
1197
1199
|
/**
|
|
1198
1200
|
* This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/visual endpoint. The metadata structure is not verified.
|
|
1199
1201
|
* @summary Retrieve metadata context
|
|
1200
|
-
* @param {
|
|
1202
|
+
* @param {ActionsExportGetMetadataRequest} requestParameters Request parameters.
|
|
1201
1203
|
* @param {*} [options] Override http request option.
|
|
1202
1204
|
* @throws {RequiredError}
|
|
1203
|
-
* @memberof
|
|
1205
|
+
* @memberof ActionsExport
|
|
1204
1206
|
*/
|
|
1205
1207
|
getMetadata(requestParameters, options) {
|
|
1206
|
-
return
|
|
1208
|
+
return ActionsExportFp(this.configuration)
|
|
1207
1209
|
.getMetadata(requestParameters.workspaceId, requestParameters.exportId, options)
|
|
1208
1210
|
.then((request) => request(this.axios, this.basePath));
|
|
1209
1211
|
}
|
|
1210
1212
|
/**
|
|
1211
1213
|
* 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.
|
|
1212
1214
|
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
1213
|
-
* @param {
|
|
1215
|
+
* @param {ActionsExportGetRawExportRequest} requestParameters Request parameters.
|
|
1214
1216
|
* @param {*} [options] Override http request option.
|
|
1215
1217
|
* @throws {RequiredError}
|
|
1216
|
-
* @memberof
|
|
1218
|
+
* @memberof ActionsExport
|
|
1217
1219
|
*/
|
|
1218
1220
|
getRawExport(requestParameters, options) {
|
|
1219
|
-
return
|
|
1221
|
+
return ActionsExportFp(this.configuration)
|
|
1220
1222
|
.getRawExport(requestParameters.workspaceId, requestParameters.exportId, options)
|
|
1221
1223
|
.then((request) => request(this.axios, this.basePath));
|
|
1222
1224
|
}
|
|
1223
1225
|
/**
|
|
1224
1226
|
* 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.
|
|
1225
1227
|
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
1226
|
-
* @param {
|
|
1228
|
+
* @param {ActionsExportGetSlidesExportRequest} requestParameters Request parameters.
|
|
1227
1229
|
* @param {*} [options] Override http request option.
|
|
1228
1230
|
* @throws {RequiredError}
|
|
1229
|
-
* @memberof
|
|
1231
|
+
* @memberof ActionsExport
|
|
1230
1232
|
*/
|
|
1231
1233
|
getSlidesExport(requestParameters, options) {
|
|
1232
|
-
return
|
|
1234
|
+
return ActionsExportFp(this.configuration)
|
|
1233
1235
|
.getSlidesExport(requestParameters.workspaceId, requestParameters.exportId, options)
|
|
1234
1236
|
.then((request) => request(this.axios, this.basePath));
|
|
1235
1237
|
}
|
|
1236
1238
|
/**
|
|
1237
1239
|
* Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/slides endpoint. The metadata structure is not verified.
|
|
1238
1240
|
* @summary (EXPERIMENTAL) Retrieve metadata context
|
|
1239
|
-
* @param {
|
|
1241
|
+
* @param {ActionsExportGetSlidesExportMetadataRequest} requestParameters Request parameters.
|
|
1240
1242
|
* @param {*} [options] Override http request option.
|
|
1241
1243
|
* @throws {RequiredError}
|
|
1242
|
-
* @memberof
|
|
1244
|
+
* @memberof ActionsExport
|
|
1243
1245
|
*/
|
|
1244
1246
|
getSlidesExportMetadata(requestParameters, options) {
|
|
1245
|
-
return
|
|
1247
|
+
return ActionsExportFp(this.configuration)
|
|
1246
1248
|
.getSlidesExportMetadata(requestParameters.workspaceId, requestParameters.exportId, options)
|
|
1247
1249
|
.then((request) => request(this.axios, this.basePath));
|
|
1248
1250
|
}
|
|
1249
1251
|
/**
|
|
1250
1252
|
* 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.
|
|
1251
1253
|
* @summary Retrieve exported files
|
|
1252
|
-
* @param {
|
|
1254
|
+
* @param {ActionsExportGetTabularExportRequest} requestParameters Request parameters.
|
|
1253
1255
|
* @param {*} [options] Override http request option.
|
|
1254
1256
|
* @throws {RequiredError}
|
|
1255
|
-
* @memberof
|
|
1257
|
+
* @memberof ActionsExport
|
|
1256
1258
|
*/
|
|
1257
1259
|
getTabularExport(requestParameters, options) {
|
|
1258
|
-
return
|
|
1260
|
+
return ActionsExportFp(this.configuration)
|
|
1259
1261
|
.getTabularExport(requestParameters.workspaceId, requestParameters.exportId, options)
|
|
1260
1262
|
.then((request) => request(this.axios, this.basePath));
|
|
1261
1263
|
}
|
|
1262
1264
|
}
|
|
1263
1265
|
/**
|
|
1264
|
-
*
|
|
1266
|
+
* ImageExportExport - axios parameter creator
|
|
1265
1267
|
* @export
|
|
1266
1268
|
*/
|
|
1267
|
-
export const
|
|
1269
|
+
export const ImageExportExportAxiosParamCreator = function (configuration) {
|
|
1268
1270
|
return {
|
|
1269
1271
|
/**
|
|
1270
1272
|
* Note: This API is an experimental and is going to change. Please, use it accordingly. An image export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
|
|
1271
1273
|
* @summary (EXPERIMENTAL) Create image export request
|
|
1272
1274
|
* @param {string} workspaceId
|
|
1273
|
-
* @param {
|
|
1275
|
+
* @param {ExportImageExportRequest} exportImageExportRequest
|
|
1274
1276
|
* @param {*} [options] Override http request option.
|
|
1275
1277
|
* @throws {RequiredError}
|
|
1276
1278
|
*/
|
|
1277
|
-
createImageExport: async (workspaceId,
|
|
1279
|
+
createImageExport: async (workspaceId, exportImageExportRequest, options = {}) => {
|
|
1278
1280
|
// verify required parameter 'workspaceId' is not null or undefined
|
|
1279
1281
|
assertParamExists("createImageExport", "workspaceId", workspaceId);
|
|
1280
|
-
// verify required parameter '
|
|
1281
|
-
assertParamExists("createImageExport", "
|
|
1282
|
+
// verify required parameter 'exportImageExportRequest' is not null or undefined
|
|
1283
|
+
assertParamExists("createImageExport", "exportImageExportRequest", exportImageExportRequest);
|
|
1282
1284
|
const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/export/image`.replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)));
|
|
1283
1285
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1284
1286
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -1297,11 +1299,11 @@ export const ImageExportApiAxiosParamCreator = function (configuration) {
|
|
|
1297
1299
|
...headersFromBaseOptions,
|
|
1298
1300
|
...options.headers,
|
|
1299
1301
|
};
|
|
1300
|
-
const needsSerialization = typeof
|
|
1302
|
+
const needsSerialization = typeof exportImageExportRequest !== "string" ||
|
|
1301
1303
|
localVarRequestOptions.headers["Content-Type"] === "application/json";
|
|
1302
1304
|
localVarRequestOptions.data = needsSerialization
|
|
1303
|
-
? JSON.stringify(
|
|
1304
|
-
:
|
|
1305
|
+
? JSON.stringify(exportImageExportRequest !== undefined ? exportImageExportRequest : {})
|
|
1306
|
+
: exportImageExportRequest || "";
|
|
1305
1307
|
return {
|
|
1306
1308
|
url: toPathString(localVarUrlObj),
|
|
1307
1309
|
options: localVarRequestOptions,
|
|
@@ -1384,22 +1386,22 @@ export const ImageExportApiAxiosParamCreator = function (configuration) {
|
|
|
1384
1386
|
};
|
|
1385
1387
|
};
|
|
1386
1388
|
/**
|
|
1387
|
-
*
|
|
1389
|
+
* ImageExportExport - functional programming interface
|
|
1388
1390
|
* @export
|
|
1389
1391
|
*/
|
|
1390
|
-
export const
|
|
1391
|
-
const localVarAxiosParamCreator =
|
|
1392
|
+
export const ImageExportExportFp = function (configuration) {
|
|
1393
|
+
const localVarAxiosParamCreator = ImageExportExportAxiosParamCreator(configuration);
|
|
1392
1394
|
return {
|
|
1393
1395
|
/**
|
|
1394
1396
|
* Note: This API is an experimental and is going to change. Please, use it accordingly. An image export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
|
|
1395
1397
|
* @summary (EXPERIMENTAL) Create image export request
|
|
1396
1398
|
* @param {string} workspaceId
|
|
1397
|
-
* @param {
|
|
1399
|
+
* @param {ExportImageExportRequest} exportImageExportRequest
|
|
1398
1400
|
* @param {*} [options] Override http request option.
|
|
1399
1401
|
* @throws {RequiredError}
|
|
1400
1402
|
*/
|
|
1401
|
-
async createImageExport(workspaceId,
|
|
1402
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.createImageExport(workspaceId,
|
|
1403
|
+
async createImageExport(workspaceId, exportImageExportRequest, options) {
|
|
1404
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createImageExport(workspaceId, exportImageExportRequest, options);
|
|
1403
1405
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1404
1406
|
},
|
|
1405
1407
|
/**
|
|
@@ -1429,28 +1431,28 @@ export const ImageExportApiFp = function (configuration) {
|
|
|
1429
1431
|
};
|
|
1430
1432
|
};
|
|
1431
1433
|
/**
|
|
1432
|
-
*
|
|
1434
|
+
* ImageExportExport - factory interface
|
|
1433
1435
|
* @export
|
|
1434
1436
|
*/
|
|
1435
|
-
export const
|
|
1436
|
-
const localVarFp =
|
|
1437
|
+
export const ImageExportExportFactory = function (configuration, basePath, axios) {
|
|
1438
|
+
const localVarFp = ImageExportExportFp(configuration);
|
|
1437
1439
|
return {
|
|
1438
1440
|
/**
|
|
1439
1441
|
* Note: This API is an experimental and is going to change. Please, use it accordingly. An image export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
|
|
1440
1442
|
* @summary (EXPERIMENTAL) Create image export request
|
|
1441
|
-
* @param {
|
|
1443
|
+
* @param {ImageExportExportCreateImageExportRequest} requestParameters Request parameters.
|
|
1442
1444
|
* @param {*} [options] Override http request option.
|
|
1443
1445
|
* @throws {RequiredError}
|
|
1444
1446
|
*/
|
|
1445
1447
|
createImageExport(requestParameters, options) {
|
|
1446
1448
|
return localVarFp
|
|
1447
|
-
.createImageExport(requestParameters.workspaceId, requestParameters.
|
|
1449
|
+
.createImageExport(requestParameters.workspaceId, requestParameters.exportImageExportRequest, options)
|
|
1448
1450
|
.then((request) => request(axios, basePath));
|
|
1449
1451
|
},
|
|
1450
1452
|
/**
|
|
1451
1453
|
* 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.
|
|
1452
1454
|
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
1453
|
-
* @param {
|
|
1455
|
+
* @param {ImageExportExportGetImageExportRequest} requestParameters Request parameters.
|
|
1454
1456
|
* @param {*} [options] Override http request option.
|
|
1455
1457
|
* @throws {RequiredError}
|
|
1456
1458
|
*/
|
|
@@ -1462,7 +1464,7 @@ export const ImageExportApiFactory = function (configuration, basePath, axios) {
|
|
|
1462
1464
|
/**
|
|
1463
1465
|
* Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/image endpoint. The metadata structure is not verified.
|
|
1464
1466
|
* @summary (EXPERIMENTAL) Retrieve metadata context
|
|
1465
|
-
* @param {
|
|
1467
|
+
* @param {ImageExportExportGetImageExportMetadataRequest} requestParameters Request parameters.
|
|
1466
1468
|
* @param {*} [options] Override http request option.
|
|
1467
1469
|
* @throws {RequiredError}
|
|
1468
1470
|
*/
|
|
@@ -1474,71 +1476,71 @@ export const ImageExportApiFactory = function (configuration, basePath, axios) {
|
|
|
1474
1476
|
};
|
|
1475
1477
|
};
|
|
1476
1478
|
/**
|
|
1477
|
-
*
|
|
1479
|
+
* ImageExportExport - object-oriented interface
|
|
1478
1480
|
* @export
|
|
1479
|
-
* @class
|
|
1481
|
+
* @class ImageExportExport
|
|
1480
1482
|
* @extends {BaseAPI}
|
|
1481
1483
|
*/
|
|
1482
|
-
export class
|
|
1484
|
+
export class ImageExportExport extends BaseAPI {
|
|
1483
1485
|
/**
|
|
1484
1486
|
* Note: This API is an experimental and is going to change. Please, use it accordingly. An image export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
|
|
1485
1487
|
* @summary (EXPERIMENTAL) Create image export request
|
|
1486
|
-
* @param {
|
|
1488
|
+
* @param {ImageExportExportCreateImageExportRequest} requestParameters Request parameters.
|
|
1487
1489
|
* @param {*} [options] Override http request option.
|
|
1488
1490
|
* @throws {RequiredError}
|
|
1489
|
-
* @memberof
|
|
1491
|
+
* @memberof ImageExportExport
|
|
1490
1492
|
*/
|
|
1491
1493
|
createImageExport(requestParameters, options) {
|
|
1492
|
-
return
|
|
1493
|
-
.createImageExport(requestParameters.workspaceId, requestParameters.
|
|
1494
|
+
return ImageExportExportFp(this.configuration)
|
|
1495
|
+
.createImageExport(requestParameters.workspaceId, requestParameters.exportImageExportRequest, options)
|
|
1494
1496
|
.then((request) => request(this.axios, this.basePath));
|
|
1495
1497
|
}
|
|
1496
1498
|
/**
|
|
1497
1499
|
* 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.
|
|
1498
1500
|
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
1499
|
-
* @param {
|
|
1501
|
+
* @param {ImageExportExportGetImageExportRequest} requestParameters Request parameters.
|
|
1500
1502
|
* @param {*} [options] Override http request option.
|
|
1501
1503
|
* @throws {RequiredError}
|
|
1502
|
-
* @memberof
|
|
1504
|
+
* @memberof ImageExportExport
|
|
1503
1505
|
*/
|
|
1504
1506
|
getImageExport(requestParameters, options) {
|
|
1505
|
-
return
|
|
1507
|
+
return ImageExportExportFp(this.configuration)
|
|
1506
1508
|
.getImageExport(requestParameters.workspaceId, requestParameters.exportId, options)
|
|
1507
1509
|
.then((request) => request(this.axios, this.basePath));
|
|
1508
1510
|
}
|
|
1509
1511
|
/**
|
|
1510
1512
|
* Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/image endpoint. The metadata structure is not verified.
|
|
1511
1513
|
* @summary (EXPERIMENTAL) Retrieve metadata context
|
|
1512
|
-
* @param {
|
|
1514
|
+
* @param {ImageExportExportGetImageExportMetadataRequest} requestParameters Request parameters.
|
|
1513
1515
|
* @param {*} [options] Override http request option.
|
|
1514
1516
|
* @throws {RequiredError}
|
|
1515
|
-
* @memberof
|
|
1517
|
+
* @memberof ImageExportExport
|
|
1516
1518
|
*/
|
|
1517
1519
|
getImageExportMetadata(requestParameters, options) {
|
|
1518
|
-
return
|
|
1520
|
+
return ImageExportExportFp(this.configuration)
|
|
1519
1521
|
.getImageExportMetadata(requestParameters.workspaceId, requestParameters.exportId, options)
|
|
1520
1522
|
.then((request) => request(this.axios, this.basePath));
|
|
1521
1523
|
}
|
|
1522
1524
|
}
|
|
1523
1525
|
/**
|
|
1524
|
-
*
|
|
1526
|
+
* RawExportExport - axios parameter creator
|
|
1525
1527
|
* @export
|
|
1526
1528
|
*/
|
|
1527
|
-
export const
|
|
1529
|
+
export const RawExportExportAxiosParamCreator = function (configuration) {
|
|
1528
1530
|
return {
|
|
1529
1531
|
/**
|
|
1530
1532
|
* 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.
|
|
1531
1533
|
* @summary (EXPERIMENTAL) Create raw export request
|
|
1532
1534
|
* @param {string} workspaceId
|
|
1533
|
-
* @param {
|
|
1535
|
+
* @param {ExportRawExportRequest} exportRawExportRequest
|
|
1534
1536
|
* @param {*} [options] Override http request option.
|
|
1535
1537
|
* @throws {RequiredError}
|
|
1536
1538
|
*/
|
|
1537
|
-
createRawExport: async (workspaceId,
|
|
1539
|
+
createRawExport: async (workspaceId, exportRawExportRequest, options = {}) => {
|
|
1538
1540
|
// verify required parameter 'workspaceId' is not null or undefined
|
|
1539
1541
|
assertParamExists("createRawExport", "workspaceId", workspaceId);
|
|
1540
|
-
// verify required parameter '
|
|
1541
|
-
assertParamExists("createRawExport", "
|
|
1542
|
+
// verify required parameter 'exportRawExportRequest' is not null or undefined
|
|
1543
|
+
assertParamExists("createRawExport", "exportRawExportRequest", exportRawExportRequest);
|
|
1542
1544
|
const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/export/raw`.replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)));
|
|
1543
1545
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1544
1546
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -1557,11 +1559,11 @@ export const RawExportApiAxiosParamCreator = function (configuration) {
|
|
|
1557
1559
|
...headersFromBaseOptions,
|
|
1558
1560
|
...options.headers,
|
|
1559
1561
|
};
|
|
1560
|
-
const needsSerialization = typeof
|
|
1562
|
+
const needsSerialization = typeof exportRawExportRequest !== "string" ||
|
|
1561
1563
|
localVarRequestOptions.headers["Content-Type"] === "application/json";
|
|
1562
1564
|
localVarRequestOptions.data = needsSerialization
|
|
1563
|
-
? JSON.stringify(
|
|
1564
|
-
:
|
|
1565
|
+
? JSON.stringify(exportRawExportRequest !== undefined ? exportRawExportRequest : {})
|
|
1566
|
+
: exportRawExportRequest || "";
|
|
1565
1567
|
return {
|
|
1566
1568
|
url: toPathString(localVarUrlObj),
|
|
1567
1569
|
options: localVarRequestOptions,
|
|
@@ -1607,22 +1609,22 @@ export const RawExportApiAxiosParamCreator = function (configuration) {
|
|
|
1607
1609
|
};
|
|
1608
1610
|
};
|
|
1609
1611
|
/**
|
|
1610
|
-
*
|
|
1612
|
+
* RawExportExport - functional programming interface
|
|
1611
1613
|
* @export
|
|
1612
1614
|
*/
|
|
1613
|
-
export const
|
|
1614
|
-
const localVarAxiosParamCreator =
|
|
1615
|
+
export const RawExportExportFp = function (configuration) {
|
|
1616
|
+
const localVarAxiosParamCreator = RawExportExportAxiosParamCreator(configuration);
|
|
1615
1617
|
return {
|
|
1616
1618
|
/**
|
|
1617
1619
|
* 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.
|
|
1618
1620
|
* @summary (EXPERIMENTAL) Create raw export request
|
|
1619
1621
|
* @param {string} workspaceId
|
|
1620
|
-
* @param {
|
|
1622
|
+
* @param {ExportRawExportRequest} exportRawExportRequest
|
|
1621
1623
|
* @param {*} [options] Override http request option.
|
|
1622
1624
|
* @throws {RequiredError}
|
|
1623
1625
|
*/
|
|
1624
|
-
async createRawExport(workspaceId,
|
|
1625
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.createRawExport(workspaceId,
|
|
1626
|
+
async createRawExport(workspaceId, exportRawExportRequest, options) {
|
|
1627
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createRawExport(workspaceId, exportRawExportRequest, options);
|
|
1626
1628
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1627
1629
|
},
|
|
1628
1630
|
/**
|
|
@@ -1640,28 +1642,28 @@ export const RawExportApiFp = function (configuration) {
|
|
|
1640
1642
|
};
|
|
1641
1643
|
};
|
|
1642
1644
|
/**
|
|
1643
|
-
*
|
|
1645
|
+
* RawExportExport - factory interface
|
|
1644
1646
|
* @export
|
|
1645
1647
|
*/
|
|
1646
|
-
export const
|
|
1647
|
-
const localVarFp =
|
|
1648
|
+
export const RawExportExportFactory = function (configuration, basePath, axios) {
|
|
1649
|
+
const localVarFp = RawExportExportFp(configuration);
|
|
1648
1650
|
return {
|
|
1649
1651
|
/**
|
|
1650
1652
|
* 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.
|
|
1651
1653
|
* @summary (EXPERIMENTAL) Create raw export request
|
|
1652
|
-
* @param {
|
|
1654
|
+
* @param {RawExportExportCreateRawExportRequest} requestParameters Request parameters.
|
|
1653
1655
|
* @param {*} [options] Override http request option.
|
|
1654
1656
|
* @throws {RequiredError}
|
|
1655
1657
|
*/
|
|
1656
1658
|
createRawExport(requestParameters, options) {
|
|
1657
1659
|
return localVarFp
|
|
1658
|
-
.createRawExport(requestParameters.workspaceId, requestParameters.
|
|
1660
|
+
.createRawExport(requestParameters.workspaceId, requestParameters.exportRawExportRequest, options)
|
|
1659
1661
|
.then((request) => request(axios, basePath));
|
|
1660
1662
|
},
|
|
1661
1663
|
/**
|
|
1662
1664
|
* 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.
|
|
1663
1665
|
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
1664
|
-
* @param {
|
|
1666
|
+
* @param {RawExportExportGetRawExportRequest} requestParameters Request parameters.
|
|
1665
1667
|
* @param {*} [options] Override http request option.
|
|
1666
1668
|
* @throws {RequiredError}
|
|
1667
1669
|
*/
|
|
@@ -1673,58 +1675,58 @@ export const RawExportApiFactory = function (configuration, basePath, axios) {
|
|
|
1673
1675
|
};
|
|
1674
1676
|
};
|
|
1675
1677
|
/**
|
|
1676
|
-
*
|
|
1678
|
+
* RawExportExport - object-oriented interface
|
|
1677
1679
|
* @export
|
|
1678
|
-
* @class
|
|
1680
|
+
* @class RawExportExport
|
|
1679
1681
|
* @extends {BaseAPI}
|
|
1680
1682
|
*/
|
|
1681
|
-
export class
|
|
1683
|
+
export class RawExportExport extends BaseAPI {
|
|
1682
1684
|
/**
|
|
1683
1685
|
* 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.
|
|
1684
1686
|
* @summary (EXPERIMENTAL) Create raw export request
|
|
1685
|
-
* @param {
|
|
1687
|
+
* @param {RawExportExportCreateRawExportRequest} requestParameters Request parameters.
|
|
1686
1688
|
* @param {*} [options] Override http request option.
|
|
1687
1689
|
* @throws {RequiredError}
|
|
1688
|
-
* @memberof
|
|
1690
|
+
* @memberof RawExportExport
|
|
1689
1691
|
*/
|
|
1690
1692
|
createRawExport(requestParameters, options) {
|
|
1691
|
-
return
|
|
1692
|
-
.createRawExport(requestParameters.workspaceId, requestParameters.
|
|
1693
|
+
return RawExportExportFp(this.configuration)
|
|
1694
|
+
.createRawExport(requestParameters.workspaceId, requestParameters.exportRawExportRequest, options)
|
|
1693
1695
|
.then((request) => request(this.axios, this.basePath));
|
|
1694
1696
|
}
|
|
1695
1697
|
/**
|
|
1696
1698
|
* 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.
|
|
1697
1699
|
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
1698
|
-
* @param {
|
|
1700
|
+
* @param {RawExportExportGetRawExportRequest} requestParameters Request parameters.
|
|
1699
1701
|
* @param {*} [options] Override http request option.
|
|
1700
1702
|
* @throws {RequiredError}
|
|
1701
|
-
* @memberof
|
|
1703
|
+
* @memberof RawExportExport
|
|
1702
1704
|
*/
|
|
1703
1705
|
getRawExport(requestParameters, options) {
|
|
1704
|
-
return
|
|
1706
|
+
return RawExportExportFp(this.configuration)
|
|
1705
1707
|
.getRawExport(requestParameters.workspaceId, requestParameters.exportId, options)
|
|
1706
1708
|
.then((request) => request(this.axios, this.basePath));
|
|
1707
1709
|
}
|
|
1708
1710
|
}
|
|
1709
1711
|
/**
|
|
1710
|
-
*
|
|
1712
|
+
* SlidesExportExport - axios parameter creator
|
|
1711
1713
|
* @export
|
|
1712
1714
|
*/
|
|
1713
|
-
export const
|
|
1715
|
+
export const SlidesExportExportAxiosParamCreator = function (configuration) {
|
|
1714
1716
|
return {
|
|
1715
1717
|
/**
|
|
1716
1718
|
* Note: This API is an experimental and is going to change. Please, use it accordingly. A slides export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
|
|
1717
1719
|
* @summary (EXPERIMENTAL) Create slides export request
|
|
1718
1720
|
* @param {string} workspaceId
|
|
1719
|
-
* @param {
|
|
1721
|
+
* @param {ExportSlidesExportRequest} exportSlidesExportRequest
|
|
1720
1722
|
* @param {*} [options] Override http request option.
|
|
1721
1723
|
* @throws {RequiredError}
|
|
1722
1724
|
*/
|
|
1723
|
-
createSlidesExport: async (workspaceId,
|
|
1725
|
+
createSlidesExport: async (workspaceId, exportSlidesExportRequest, options = {}) => {
|
|
1724
1726
|
// verify required parameter 'workspaceId' is not null or undefined
|
|
1725
1727
|
assertParamExists("createSlidesExport", "workspaceId", workspaceId);
|
|
1726
|
-
// verify required parameter '
|
|
1727
|
-
assertParamExists("createSlidesExport", "
|
|
1728
|
+
// verify required parameter 'exportSlidesExportRequest' is not null or undefined
|
|
1729
|
+
assertParamExists("createSlidesExport", "exportSlidesExportRequest", exportSlidesExportRequest);
|
|
1728
1730
|
const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/export/slides`.replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)));
|
|
1729
1731
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1730
1732
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -1743,11 +1745,11 @@ export const SlidesExportApiAxiosParamCreator = function (configuration) {
|
|
|
1743
1745
|
...headersFromBaseOptions,
|
|
1744
1746
|
...options.headers,
|
|
1745
1747
|
};
|
|
1746
|
-
const needsSerialization = typeof
|
|
1748
|
+
const needsSerialization = typeof exportSlidesExportRequest !== "string" ||
|
|
1747
1749
|
localVarRequestOptions.headers["Content-Type"] === "application/json";
|
|
1748
1750
|
localVarRequestOptions.data = needsSerialization
|
|
1749
|
-
? JSON.stringify(
|
|
1750
|
-
:
|
|
1751
|
+
? JSON.stringify(exportSlidesExportRequest !== undefined ? exportSlidesExportRequest : {})
|
|
1752
|
+
: exportSlidesExportRequest || "";
|
|
1751
1753
|
return {
|
|
1752
1754
|
url: toPathString(localVarUrlObj),
|
|
1753
1755
|
options: localVarRequestOptions,
|
|
@@ -1830,22 +1832,22 @@ export const SlidesExportApiAxiosParamCreator = function (configuration) {
|
|
|
1830
1832
|
};
|
|
1831
1833
|
};
|
|
1832
1834
|
/**
|
|
1833
|
-
*
|
|
1835
|
+
* SlidesExportExport - functional programming interface
|
|
1834
1836
|
* @export
|
|
1835
1837
|
*/
|
|
1836
|
-
export const
|
|
1837
|
-
const localVarAxiosParamCreator =
|
|
1838
|
+
export const SlidesExportExportFp = function (configuration) {
|
|
1839
|
+
const localVarAxiosParamCreator = SlidesExportExportAxiosParamCreator(configuration);
|
|
1838
1840
|
return {
|
|
1839
1841
|
/**
|
|
1840
1842
|
* Note: This API is an experimental and is going to change. Please, use it accordingly. A slides export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
|
|
1841
1843
|
* @summary (EXPERIMENTAL) Create slides export request
|
|
1842
1844
|
* @param {string} workspaceId
|
|
1843
|
-
* @param {
|
|
1845
|
+
* @param {ExportSlidesExportRequest} exportSlidesExportRequest
|
|
1844
1846
|
* @param {*} [options] Override http request option.
|
|
1845
1847
|
* @throws {RequiredError}
|
|
1846
1848
|
*/
|
|
1847
|
-
async createSlidesExport(workspaceId,
|
|
1848
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.createSlidesExport(workspaceId,
|
|
1849
|
+
async createSlidesExport(workspaceId, exportSlidesExportRequest, options) {
|
|
1850
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createSlidesExport(workspaceId, exportSlidesExportRequest, options);
|
|
1849
1851
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1850
1852
|
},
|
|
1851
1853
|
/**
|
|
@@ -1875,28 +1877,28 @@ export const SlidesExportApiFp = function (configuration) {
|
|
|
1875
1877
|
};
|
|
1876
1878
|
};
|
|
1877
1879
|
/**
|
|
1878
|
-
*
|
|
1880
|
+
* SlidesExportExport - factory interface
|
|
1879
1881
|
* @export
|
|
1880
1882
|
*/
|
|
1881
|
-
export const
|
|
1882
|
-
const localVarFp =
|
|
1883
|
+
export const SlidesExportExportFactory = function (configuration, basePath, axios) {
|
|
1884
|
+
const localVarFp = SlidesExportExportFp(configuration);
|
|
1883
1885
|
return {
|
|
1884
1886
|
/**
|
|
1885
1887
|
* Note: This API is an experimental and is going to change. Please, use it accordingly. A slides export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
|
|
1886
1888
|
* @summary (EXPERIMENTAL) Create slides export request
|
|
1887
|
-
* @param {
|
|
1889
|
+
* @param {SlidesExportExportCreateSlidesExportRequest} requestParameters Request parameters.
|
|
1888
1890
|
* @param {*} [options] Override http request option.
|
|
1889
1891
|
* @throws {RequiredError}
|
|
1890
1892
|
*/
|
|
1891
1893
|
createSlidesExport(requestParameters, options) {
|
|
1892
1894
|
return localVarFp
|
|
1893
|
-
.createSlidesExport(requestParameters.workspaceId, requestParameters.
|
|
1895
|
+
.createSlidesExport(requestParameters.workspaceId, requestParameters.exportSlidesExportRequest, options)
|
|
1894
1896
|
.then((request) => request(axios, basePath));
|
|
1895
1897
|
},
|
|
1896
1898
|
/**
|
|
1897
1899
|
* 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.
|
|
1898
1900
|
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
1899
|
-
* @param {
|
|
1901
|
+
* @param {SlidesExportExportGetSlidesExportRequest} requestParameters Request parameters.
|
|
1900
1902
|
* @param {*} [options] Override http request option.
|
|
1901
1903
|
* @throws {RequiredError}
|
|
1902
1904
|
*/
|
|
@@ -1908,7 +1910,7 @@ export const SlidesExportApiFactory = function (configuration, basePath, axios)
|
|
|
1908
1910
|
/**
|
|
1909
1911
|
* Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/slides endpoint. The metadata structure is not verified.
|
|
1910
1912
|
* @summary (EXPERIMENTAL) Retrieve metadata context
|
|
1911
|
-
* @param {
|
|
1913
|
+
* @param {SlidesExportExportGetSlidesExportMetadataRequest} requestParameters Request parameters.
|
|
1912
1914
|
* @param {*} [options] Override http request option.
|
|
1913
1915
|
* @throws {RequiredError}
|
|
1914
1916
|
*/
|
|
@@ -1920,74 +1922,74 @@ export const SlidesExportApiFactory = function (configuration, basePath, axios)
|
|
|
1920
1922
|
};
|
|
1921
1923
|
};
|
|
1922
1924
|
/**
|
|
1923
|
-
*
|
|
1925
|
+
* SlidesExportExport - object-oriented interface
|
|
1924
1926
|
* @export
|
|
1925
|
-
* @class
|
|
1927
|
+
* @class SlidesExportExport
|
|
1926
1928
|
* @extends {BaseAPI}
|
|
1927
1929
|
*/
|
|
1928
|
-
export class
|
|
1930
|
+
export class SlidesExportExport extends BaseAPI {
|
|
1929
1931
|
/**
|
|
1930
1932
|
* Note: This API is an experimental and is going to change. Please, use it accordingly. A slides export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
|
|
1931
1933
|
* @summary (EXPERIMENTAL) Create slides export request
|
|
1932
|
-
* @param {
|
|
1934
|
+
* @param {SlidesExportExportCreateSlidesExportRequest} requestParameters Request parameters.
|
|
1933
1935
|
* @param {*} [options] Override http request option.
|
|
1934
1936
|
* @throws {RequiredError}
|
|
1935
|
-
* @memberof
|
|
1937
|
+
* @memberof SlidesExportExport
|
|
1936
1938
|
*/
|
|
1937
1939
|
createSlidesExport(requestParameters, options) {
|
|
1938
|
-
return
|
|
1939
|
-
.createSlidesExport(requestParameters.workspaceId, requestParameters.
|
|
1940
|
+
return SlidesExportExportFp(this.configuration)
|
|
1941
|
+
.createSlidesExport(requestParameters.workspaceId, requestParameters.exportSlidesExportRequest, options)
|
|
1940
1942
|
.then((request) => request(this.axios, this.basePath));
|
|
1941
1943
|
}
|
|
1942
1944
|
/**
|
|
1943
1945
|
* 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.
|
|
1944
1946
|
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
1945
|
-
* @param {
|
|
1947
|
+
* @param {SlidesExportExportGetSlidesExportRequest} requestParameters Request parameters.
|
|
1946
1948
|
* @param {*} [options] Override http request option.
|
|
1947
1949
|
* @throws {RequiredError}
|
|
1948
|
-
* @memberof
|
|
1950
|
+
* @memberof SlidesExportExport
|
|
1949
1951
|
*/
|
|
1950
1952
|
getSlidesExport(requestParameters, options) {
|
|
1951
|
-
return
|
|
1953
|
+
return SlidesExportExportFp(this.configuration)
|
|
1952
1954
|
.getSlidesExport(requestParameters.workspaceId, requestParameters.exportId, options)
|
|
1953
1955
|
.then((request) => request(this.axios, this.basePath));
|
|
1954
1956
|
}
|
|
1955
1957
|
/**
|
|
1956
1958
|
* Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/slides endpoint. The metadata structure is not verified.
|
|
1957
1959
|
* @summary (EXPERIMENTAL) Retrieve metadata context
|
|
1958
|
-
* @param {
|
|
1960
|
+
* @param {SlidesExportExportGetSlidesExportMetadataRequest} requestParameters Request parameters.
|
|
1959
1961
|
* @param {*} [options] Override http request option.
|
|
1960
1962
|
* @throws {RequiredError}
|
|
1961
|
-
* @memberof
|
|
1963
|
+
* @memberof SlidesExportExport
|
|
1962
1964
|
*/
|
|
1963
1965
|
getSlidesExportMetadata(requestParameters, options) {
|
|
1964
|
-
return
|
|
1966
|
+
return SlidesExportExportFp(this.configuration)
|
|
1965
1967
|
.getSlidesExportMetadata(requestParameters.workspaceId, requestParameters.exportId, options)
|
|
1966
1968
|
.then((request) => request(this.axios, this.basePath));
|
|
1967
1969
|
}
|
|
1968
1970
|
}
|
|
1969
1971
|
/**
|
|
1970
|
-
*
|
|
1972
|
+
* TabularExportExport - axios parameter creator
|
|
1971
1973
|
* @export
|
|
1972
1974
|
*/
|
|
1973
|
-
export const
|
|
1975
|
+
export const TabularExportExportAxiosParamCreator = function (configuration) {
|
|
1974
1976
|
return {
|
|
1975
1977
|
/**
|
|
1976
1978
|
* 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.
|
|
1977
1979
|
* @summary (EXPERIMENTAL) Create dashboard tabular export request
|
|
1978
1980
|
* @param {string} workspaceId
|
|
1979
1981
|
* @param {string} dashboardId
|
|
1980
|
-
* @param {
|
|
1982
|
+
* @param {ExportDashboardTabularExportRequest} exportDashboardTabularExportRequest
|
|
1981
1983
|
* @param {*} [options] Override http request option.
|
|
1982
1984
|
* @throws {RequiredError}
|
|
1983
1985
|
*/
|
|
1984
|
-
createDashboardExportRequest: async (workspaceId, dashboardId,
|
|
1986
|
+
createDashboardExportRequest: async (workspaceId, dashboardId, exportDashboardTabularExportRequest, options = {}) => {
|
|
1985
1987
|
// verify required parameter 'workspaceId' is not null or undefined
|
|
1986
1988
|
assertParamExists("createDashboardExportRequest", "workspaceId", workspaceId);
|
|
1987
1989
|
// verify required parameter 'dashboardId' is not null or undefined
|
|
1988
1990
|
assertParamExists("createDashboardExportRequest", "dashboardId", dashboardId);
|
|
1989
|
-
// verify required parameter '
|
|
1990
|
-
assertParamExists("createDashboardExportRequest", "
|
|
1991
|
+
// verify required parameter 'exportDashboardTabularExportRequest' is not null or undefined
|
|
1992
|
+
assertParamExists("createDashboardExportRequest", "exportDashboardTabularExportRequest", exportDashboardTabularExportRequest);
|
|
1991
1993
|
const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/export/tabular`
|
|
1992
1994
|
.replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)))
|
|
1993
1995
|
.replace(`{${"dashboardId"}}`, encodeURIComponent(String(dashboardId)));
|
|
@@ -2008,11 +2010,13 @@ export const TabularExportApiAxiosParamCreator = function (configuration) {
|
|
|
2008
2010
|
...headersFromBaseOptions,
|
|
2009
2011
|
...options.headers,
|
|
2010
2012
|
};
|
|
2011
|
-
const needsSerialization = typeof
|
|
2013
|
+
const needsSerialization = typeof exportDashboardTabularExportRequest !== "string" ||
|
|
2012
2014
|
localVarRequestOptions.headers["Content-Type"] === "application/json";
|
|
2013
2015
|
localVarRequestOptions.data = needsSerialization
|
|
2014
|
-
? JSON.stringify(
|
|
2015
|
-
|
|
2016
|
+
? JSON.stringify(exportDashboardTabularExportRequest !== undefined
|
|
2017
|
+
? exportDashboardTabularExportRequest
|
|
2018
|
+
: {})
|
|
2019
|
+
: exportDashboardTabularExportRequest || "";
|
|
2016
2020
|
return {
|
|
2017
2021
|
url: toPathString(localVarUrlObj),
|
|
2018
2022
|
options: localVarRequestOptions,
|
|
@@ -2022,15 +2026,15 @@ export const TabularExportApiAxiosParamCreator = function (configuration) {
|
|
|
2022
2026
|
* 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.
|
|
2023
2027
|
* @summary Create tabular export request
|
|
2024
2028
|
* @param {string} workspaceId
|
|
2025
|
-
* @param {
|
|
2029
|
+
* @param {ExportTabularExportRequest} exportTabularExportRequest
|
|
2026
2030
|
* @param {*} [options] Override http request option.
|
|
2027
2031
|
* @throws {RequiredError}
|
|
2028
2032
|
*/
|
|
2029
|
-
createTabularExport: async (workspaceId,
|
|
2033
|
+
createTabularExport: async (workspaceId, exportTabularExportRequest, options = {}) => {
|
|
2030
2034
|
// verify required parameter 'workspaceId' is not null or undefined
|
|
2031
2035
|
assertParamExists("createTabularExport", "workspaceId", workspaceId);
|
|
2032
|
-
// verify required parameter '
|
|
2033
|
-
assertParamExists("createTabularExport", "
|
|
2036
|
+
// verify required parameter 'exportTabularExportRequest' is not null or undefined
|
|
2037
|
+
assertParamExists("createTabularExport", "exportTabularExportRequest", exportTabularExportRequest);
|
|
2034
2038
|
const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/export/tabular`.replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)));
|
|
2035
2039
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2036
2040
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -2049,11 +2053,11 @@ export const TabularExportApiAxiosParamCreator = function (configuration) {
|
|
|
2049
2053
|
...headersFromBaseOptions,
|
|
2050
2054
|
...options.headers,
|
|
2051
2055
|
};
|
|
2052
|
-
const needsSerialization = typeof
|
|
2056
|
+
const needsSerialization = typeof exportTabularExportRequest !== "string" ||
|
|
2053
2057
|
localVarRequestOptions.headers["Content-Type"] === "application/json";
|
|
2054
2058
|
localVarRequestOptions.data = needsSerialization
|
|
2055
|
-
? JSON.stringify(
|
|
2056
|
-
:
|
|
2059
|
+
? JSON.stringify(exportTabularExportRequest !== undefined ? exportTabularExportRequest : {})
|
|
2060
|
+
: exportTabularExportRequest || "";
|
|
2057
2061
|
return {
|
|
2058
2062
|
url: toPathString(localVarUrlObj),
|
|
2059
2063
|
options: localVarRequestOptions,
|
|
@@ -2099,35 +2103,35 @@ export const TabularExportApiAxiosParamCreator = function (configuration) {
|
|
|
2099
2103
|
};
|
|
2100
2104
|
};
|
|
2101
2105
|
/**
|
|
2102
|
-
*
|
|
2106
|
+
* TabularExportExport - functional programming interface
|
|
2103
2107
|
* @export
|
|
2104
2108
|
*/
|
|
2105
|
-
export const
|
|
2106
|
-
const localVarAxiosParamCreator =
|
|
2109
|
+
export const TabularExportExportFp = function (configuration) {
|
|
2110
|
+
const localVarAxiosParamCreator = TabularExportExportAxiosParamCreator(configuration);
|
|
2107
2111
|
return {
|
|
2108
2112
|
/**
|
|
2109
2113
|
* 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.
|
|
2110
2114
|
* @summary (EXPERIMENTAL) Create dashboard tabular export request
|
|
2111
2115
|
* @param {string} workspaceId
|
|
2112
2116
|
* @param {string} dashboardId
|
|
2113
|
-
* @param {
|
|
2117
|
+
* @param {ExportDashboardTabularExportRequest} exportDashboardTabularExportRequest
|
|
2114
2118
|
* @param {*} [options] Override http request option.
|
|
2115
2119
|
* @throws {RequiredError}
|
|
2116
2120
|
*/
|
|
2117
|
-
async createDashboardExportRequest(workspaceId, dashboardId,
|
|
2118
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.createDashboardExportRequest(workspaceId, dashboardId,
|
|
2121
|
+
async createDashboardExportRequest(workspaceId, dashboardId, exportDashboardTabularExportRequest, options) {
|
|
2122
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createDashboardExportRequest(workspaceId, dashboardId, exportDashboardTabularExportRequest, options);
|
|
2119
2123
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
2120
2124
|
},
|
|
2121
2125
|
/**
|
|
2122
2126
|
* 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.
|
|
2123
2127
|
* @summary Create tabular export request
|
|
2124
2128
|
* @param {string} workspaceId
|
|
2125
|
-
* @param {
|
|
2129
|
+
* @param {ExportTabularExportRequest} exportTabularExportRequest
|
|
2126
2130
|
* @param {*} [options] Override http request option.
|
|
2127
2131
|
* @throws {RequiredError}
|
|
2128
2132
|
*/
|
|
2129
|
-
async createTabularExport(workspaceId,
|
|
2130
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.createTabularExport(workspaceId,
|
|
2133
|
+
async createTabularExport(workspaceId, exportTabularExportRequest, options) {
|
|
2134
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createTabularExport(workspaceId, exportTabularExportRequest, options);
|
|
2131
2135
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
2132
2136
|
},
|
|
2133
2137
|
/**
|
|
@@ -2145,40 +2149,40 @@ export const TabularExportApiFp = function (configuration) {
|
|
|
2145
2149
|
};
|
|
2146
2150
|
};
|
|
2147
2151
|
/**
|
|
2148
|
-
*
|
|
2152
|
+
* TabularExportExport - factory interface
|
|
2149
2153
|
* @export
|
|
2150
2154
|
*/
|
|
2151
|
-
export const
|
|
2152
|
-
const localVarFp =
|
|
2155
|
+
export const TabularExportExportFactory = function (configuration, basePath, axios) {
|
|
2156
|
+
const localVarFp = TabularExportExportFp(configuration);
|
|
2153
2157
|
return {
|
|
2154
2158
|
/**
|
|
2155
2159
|
* 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.
|
|
2156
2160
|
* @summary (EXPERIMENTAL) Create dashboard tabular export request
|
|
2157
|
-
* @param {
|
|
2161
|
+
* @param {TabularExportExportCreateDashboardExportRequestRequest} requestParameters Request parameters.
|
|
2158
2162
|
* @param {*} [options] Override http request option.
|
|
2159
2163
|
* @throws {RequiredError}
|
|
2160
2164
|
*/
|
|
2161
2165
|
createDashboardExportRequest(requestParameters, options) {
|
|
2162
2166
|
return localVarFp
|
|
2163
|
-
.createDashboardExportRequest(requestParameters.workspaceId, requestParameters.dashboardId, requestParameters.
|
|
2167
|
+
.createDashboardExportRequest(requestParameters.workspaceId, requestParameters.dashboardId, requestParameters.exportDashboardTabularExportRequest, options)
|
|
2164
2168
|
.then((request) => request(axios, basePath));
|
|
2165
2169
|
},
|
|
2166
2170
|
/**
|
|
2167
2171
|
* 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.
|
|
2168
2172
|
* @summary Create tabular export request
|
|
2169
|
-
* @param {
|
|
2173
|
+
* @param {TabularExportExportCreateTabularExportRequest} requestParameters Request parameters.
|
|
2170
2174
|
* @param {*} [options] Override http request option.
|
|
2171
2175
|
* @throws {RequiredError}
|
|
2172
2176
|
*/
|
|
2173
2177
|
createTabularExport(requestParameters, options) {
|
|
2174
2178
|
return localVarFp
|
|
2175
|
-
.createTabularExport(requestParameters.workspaceId, requestParameters.
|
|
2179
|
+
.createTabularExport(requestParameters.workspaceId, requestParameters.exportTabularExportRequest, options)
|
|
2176
2180
|
.then((request) => request(axios, basePath));
|
|
2177
2181
|
},
|
|
2178
2182
|
/**
|
|
2179
2183
|
* 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.
|
|
2180
2184
|
* @summary Retrieve exported files
|
|
2181
|
-
* @param {
|
|
2185
|
+
* @param {TabularExportExportGetTabularExportRequest} requestParameters Request parameters.
|
|
2182
2186
|
* @param {*} [options] Override http request option.
|
|
2183
2187
|
* @throws {RequiredError}
|
|
2184
2188
|
*/
|
|
@@ -2190,71 +2194,71 @@ export const TabularExportApiFactory = function (configuration, basePath, axios)
|
|
|
2190
2194
|
};
|
|
2191
2195
|
};
|
|
2192
2196
|
/**
|
|
2193
|
-
*
|
|
2197
|
+
* TabularExportExport - object-oriented interface
|
|
2194
2198
|
* @export
|
|
2195
|
-
* @class
|
|
2199
|
+
* @class TabularExportExport
|
|
2196
2200
|
* @extends {BaseAPI}
|
|
2197
2201
|
*/
|
|
2198
|
-
export class
|
|
2202
|
+
export class TabularExportExport extends BaseAPI {
|
|
2199
2203
|
/**
|
|
2200
2204
|
* 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.
|
|
2201
2205
|
* @summary (EXPERIMENTAL) Create dashboard tabular export request
|
|
2202
|
-
* @param {
|
|
2206
|
+
* @param {TabularExportExportCreateDashboardExportRequestRequest} requestParameters Request parameters.
|
|
2203
2207
|
* @param {*} [options] Override http request option.
|
|
2204
2208
|
* @throws {RequiredError}
|
|
2205
|
-
* @memberof
|
|
2209
|
+
* @memberof TabularExportExport
|
|
2206
2210
|
*/
|
|
2207
2211
|
createDashboardExportRequest(requestParameters, options) {
|
|
2208
|
-
return
|
|
2209
|
-
.createDashboardExportRequest(requestParameters.workspaceId, requestParameters.dashboardId, requestParameters.
|
|
2212
|
+
return TabularExportExportFp(this.configuration)
|
|
2213
|
+
.createDashboardExportRequest(requestParameters.workspaceId, requestParameters.dashboardId, requestParameters.exportDashboardTabularExportRequest, options)
|
|
2210
2214
|
.then((request) => request(this.axios, this.basePath));
|
|
2211
2215
|
}
|
|
2212
2216
|
/**
|
|
2213
2217
|
* 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.
|
|
2214
2218
|
* @summary Create tabular export request
|
|
2215
|
-
* @param {
|
|
2219
|
+
* @param {TabularExportExportCreateTabularExportRequest} requestParameters Request parameters.
|
|
2216
2220
|
* @param {*} [options] Override http request option.
|
|
2217
2221
|
* @throws {RequiredError}
|
|
2218
|
-
* @memberof
|
|
2222
|
+
* @memberof TabularExportExport
|
|
2219
2223
|
*/
|
|
2220
2224
|
createTabularExport(requestParameters, options) {
|
|
2221
|
-
return
|
|
2222
|
-
.createTabularExport(requestParameters.workspaceId, requestParameters.
|
|
2225
|
+
return TabularExportExportFp(this.configuration)
|
|
2226
|
+
.createTabularExport(requestParameters.workspaceId, requestParameters.exportTabularExportRequest, options)
|
|
2223
2227
|
.then((request) => request(this.axios, this.basePath));
|
|
2224
2228
|
}
|
|
2225
2229
|
/**
|
|
2226
2230
|
* 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.
|
|
2227
2231
|
* @summary Retrieve exported files
|
|
2228
|
-
* @param {
|
|
2232
|
+
* @param {TabularExportExportGetTabularExportRequest} requestParameters Request parameters.
|
|
2229
2233
|
* @param {*} [options] Override http request option.
|
|
2230
2234
|
* @throws {RequiredError}
|
|
2231
|
-
* @memberof
|
|
2235
|
+
* @memberof TabularExportExport
|
|
2232
2236
|
*/
|
|
2233
2237
|
getTabularExport(requestParameters, options) {
|
|
2234
|
-
return
|
|
2238
|
+
return TabularExportExportFp(this.configuration)
|
|
2235
2239
|
.getTabularExport(requestParameters.workspaceId, requestParameters.exportId, options)
|
|
2236
2240
|
.then((request) => request(this.axios, this.basePath));
|
|
2237
2241
|
}
|
|
2238
2242
|
}
|
|
2239
2243
|
/**
|
|
2240
|
-
*
|
|
2244
|
+
* VisualExportExport - axios parameter creator
|
|
2241
2245
|
* @export
|
|
2242
2246
|
*/
|
|
2243
|
-
export const
|
|
2247
|
+
export const VisualExportExportAxiosParamCreator = function (configuration) {
|
|
2244
2248
|
return {
|
|
2245
2249
|
/**
|
|
2246
2250
|
* 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.
|
|
2247
2251
|
* @summary Create visual - pdf export request
|
|
2248
2252
|
* @param {string} workspaceId
|
|
2249
|
-
* @param {
|
|
2253
|
+
* @param {ExportVisualExportRequest} exportVisualExportRequest
|
|
2250
2254
|
* @param {*} [options] Override http request option.
|
|
2251
2255
|
* @throws {RequiredError}
|
|
2252
2256
|
*/
|
|
2253
|
-
createPdfExport: async (workspaceId,
|
|
2257
|
+
createPdfExport: async (workspaceId, exportVisualExportRequest, options = {}) => {
|
|
2254
2258
|
// verify required parameter 'workspaceId' is not null or undefined
|
|
2255
2259
|
assertParamExists("createPdfExport", "workspaceId", workspaceId);
|
|
2256
|
-
// verify required parameter '
|
|
2257
|
-
assertParamExists("createPdfExport", "
|
|
2260
|
+
// verify required parameter 'exportVisualExportRequest' is not null or undefined
|
|
2261
|
+
assertParamExists("createPdfExport", "exportVisualExportRequest", exportVisualExportRequest);
|
|
2258
2262
|
const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/export/visual`.replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)));
|
|
2259
2263
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2260
2264
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -2273,11 +2277,11 @@ export const VisualExportApiAxiosParamCreator = function (configuration) {
|
|
|
2273
2277
|
...headersFromBaseOptions,
|
|
2274
2278
|
...options.headers,
|
|
2275
2279
|
};
|
|
2276
|
-
const needsSerialization = typeof
|
|
2280
|
+
const needsSerialization = typeof exportVisualExportRequest !== "string" ||
|
|
2277
2281
|
localVarRequestOptions.headers["Content-Type"] === "application/json";
|
|
2278
2282
|
localVarRequestOptions.data = needsSerialization
|
|
2279
|
-
? JSON.stringify(
|
|
2280
|
-
:
|
|
2283
|
+
? JSON.stringify(exportVisualExportRequest !== undefined ? exportVisualExportRequest : {})
|
|
2284
|
+
: exportVisualExportRequest || "";
|
|
2281
2285
|
return {
|
|
2282
2286
|
url: toPathString(localVarUrlObj),
|
|
2283
2287
|
options: localVarRequestOptions,
|
|
@@ -2360,22 +2364,22 @@ export const VisualExportApiAxiosParamCreator = function (configuration) {
|
|
|
2360
2364
|
};
|
|
2361
2365
|
};
|
|
2362
2366
|
/**
|
|
2363
|
-
*
|
|
2367
|
+
* VisualExportExport - functional programming interface
|
|
2364
2368
|
* @export
|
|
2365
2369
|
*/
|
|
2366
|
-
export const
|
|
2367
|
-
const localVarAxiosParamCreator =
|
|
2370
|
+
export const VisualExportExportFp = function (configuration) {
|
|
2371
|
+
const localVarAxiosParamCreator = VisualExportExportAxiosParamCreator(configuration);
|
|
2368
2372
|
return {
|
|
2369
2373
|
/**
|
|
2370
2374
|
* 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.
|
|
2371
2375
|
* @summary Create visual - pdf export request
|
|
2372
2376
|
* @param {string} workspaceId
|
|
2373
|
-
* @param {
|
|
2377
|
+
* @param {ExportVisualExportRequest} exportVisualExportRequest
|
|
2374
2378
|
* @param {*} [options] Override http request option.
|
|
2375
2379
|
* @throws {RequiredError}
|
|
2376
2380
|
*/
|
|
2377
|
-
async createPdfExport(workspaceId,
|
|
2378
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.createPdfExport(workspaceId,
|
|
2381
|
+
async createPdfExport(workspaceId, exportVisualExportRequest, options) {
|
|
2382
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createPdfExport(workspaceId, exportVisualExportRequest, options);
|
|
2379
2383
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
2380
2384
|
},
|
|
2381
2385
|
/**
|
|
@@ -2405,28 +2409,28 @@ export const VisualExportApiFp = function (configuration) {
|
|
|
2405
2409
|
};
|
|
2406
2410
|
};
|
|
2407
2411
|
/**
|
|
2408
|
-
*
|
|
2412
|
+
* VisualExportExport - factory interface
|
|
2409
2413
|
* @export
|
|
2410
2414
|
*/
|
|
2411
|
-
export const
|
|
2412
|
-
const localVarFp =
|
|
2415
|
+
export const VisualExportExportFactory = function (configuration, basePath, axios) {
|
|
2416
|
+
const localVarFp = VisualExportExportFp(configuration);
|
|
2413
2417
|
return {
|
|
2414
2418
|
/**
|
|
2415
2419
|
* 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.
|
|
2416
2420
|
* @summary Create visual - pdf export request
|
|
2417
|
-
* @param {
|
|
2421
|
+
* @param {VisualExportExportCreatePdfExportRequest} requestParameters Request parameters.
|
|
2418
2422
|
* @param {*} [options] Override http request option.
|
|
2419
2423
|
* @throws {RequiredError}
|
|
2420
2424
|
*/
|
|
2421
2425
|
createPdfExport(requestParameters, options) {
|
|
2422
2426
|
return localVarFp
|
|
2423
|
-
.createPdfExport(requestParameters.workspaceId, requestParameters.
|
|
2427
|
+
.createPdfExport(requestParameters.workspaceId, requestParameters.exportVisualExportRequest, options)
|
|
2424
2428
|
.then((request) => request(axios, basePath));
|
|
2425
2429
|
},
|
|
2426
2430
|
/**
|
|
2427
2431
|
* Returns 202 until original POST export request is not processed.Returns 200 with exported data once the export is done.
|
|
2428
2432
|
* @summary Retrieve exported files
|
|
2429
|
-
* @param {
|
|
2433
|
+
* @param {VisualExportExportGetExportedFileRequest} requestParameters Request parameters.
|
|
2430
2434
|
* @param {*} [options] Override http request option.
|
|
2431
2435
|
* @throws {RequiredError}
|
|
2432
2436
|
*/
|
|
@@ -2438,7 +2442,7 @@ export const VisualExportApiFactory = function (configuration, basePath, axios)
|
|
|
2438
2442
|
/**
|
|
2439
2443
|
* This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/visual endpoint. The metadata structure is not verified.
|
|
2440
2444
|
* @summary Retrieve metadata context
|
|
2441
|
-
* @param {
|
|
2445
|
+
* @param {VisualExportExportGetMetadataRequest} requestParameters Request parameters.
|
|
2442
2446
|
* @param {*} [options] Override http request option.
|
|
2443
2447
|
* @throws {RequiredError}
|
|
2444
2448
|
*/
|
|
@@ -2450,48 +2454,48 @@ export const VisualExportApiFactory = function (configuration, basePath, axios)
|
|
|
2450
2454
|
};
|
|
2451
2455
|
};
|
|
2452
2456
|
/**
|
|
2453
|
-
*
|
|
2457
|
+
* VisualExportExport - object-oriented interface
|
|
2454
2458
|
* @export
|
|
2455
|
-
* @class
|
|
2459
|
+
* @class VisualExportExport
|
|
2456
2460
|
* @extends {BaseAPI}
|
|
2457
2461
|
*/
|
|
2458
|
-
export class
|
|
2462
|
+
export class VisualExportExport extends BaseAPI {
|
|
2459
2463
|
/**
|
|
2460
2464
|
* 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.
|
|
2461
2465
|
* @summary Create visual - pdf export request
|
|
2462
|
-
* @param {
|
|
2466
|
+
* @param {VisualExportExportCreatePdfExportRequest} requestParameters Request parameters.
|
|
2463
2467
|
* @param {*} [options] Override http request option.
|
|
2464
2468
|
* @throws {RequiredError}
|
|
2465
|
-
* @memberof
|
|
2469
|
+
* @memberof VisualExportExport
|
|
2466
2470
|
*/
|
|
2467
2471
|
createPdfExport(requestParameters, options) {
|
|
2468
|
-
return
|
|
2469
|
-
.createPdfExport(requestParameters.workspaceId, requestParameters.
|
|
2472
|
+
return VisualExportExportFp(this.configuration)
|
|
2473
|
+
.createPdfExport(requestParameters.workspaceId, requestParameters.exportVisualExportRequest, options)
|
|
2470
2474
|
.then((request) => request(this.axios, this.basePath));
|
|
2471
2475
|
}
|
|
2472
2476
|
/**
|
|
2473
2477
|
* Returns 202 until original POST export request is not processed.Returns 200 with exported data once the export is done.
|
|
2474
2478
|
* @summary Retrieve exported files
|
|
2475
|
-
* @param {
|
|
2479
|
+
* @param {VisualExportExportGetExportedFileRequest} requestParameters Request parameters.
|
|
2476
2480
|
* @param {*} [options] Override http request option.
|
|
2477
2481
|
* @throws {RequiredError}
|
|
2478
|
-
* @memberof
|
|
2482
|
+
* @memberof VisualExportExport
|
|
2479
2483
|
*/
|
|
2480
2484
|
getExportedFile(requestParameters, options) {
|
|
2481
|
-
return
|
|
2485
|
+
return VisualExportExportFp(this.configuration)
|
|
2482
2486
|
.getExportedFile(requestParameters.workspaceId, requestParameters.exportId, options)
|
|
2483
2487
|
.then((request) => request(this.axios, this.basePath));
|
|
2484
2488
|
}
|
|
2485
2489
|
/**
|
|
2486
2490
|
* This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/visual endpoint. The metadata structure is not verified.
|
|
2487
2491
|
* @summary Retrieve metadata context
|
|
2488
|
-
* @param {
|
|
2492
|
+
* @param {VisualExportExportGetMetadataRequest} requestParameters Request parameters.
|
|
2489
2493
|
* @param {*} [options] Override http request option.
|
|
2490
2494
|
* @throws {RequiredError}
|
|
2491
|
-
* @memberof
|
|
2495
|
+
* @memberof VisualExportExport
|
|
2492
2496
|
*/
|
|
2493
2497
|
getMetadata(requestParameters, options) {
|
|
2494
|
-
return
|
|
2498
|
+
return VisualExportExportFp(this.configuration)
|
|
2495
2499
|
.getMetadata(requestParameters.workspaceId, requestParameters.exportId, options)
|
|
2496
2500
|
.then((request) => request(this.axios, this.basePath));
|
|
2497
2501
|
}
|