@gooddata/api-client-tiger 10.33.0-alpha.8 → 10.33.0-alpha.81
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 +12630 -9311
- 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/afm-rest-api/api.d.ts +376 -13
- package/esm/generated/afm-rest-api/api.d.ts.map +1 -1
- package/esm/generated/afm-rest-api/api.js +305 -4
- package/esm/generated/afm-rest-api/api.js.map +1 -1
- package/esm/generated/afm-rest-api/openapi-spec.json +180 -2
- package/esm/generated/automation-json-api/api.d.ts +473 -1
- package/esm/generated/automation-json-api/api.d.ts.map +1 -1
- package/esm/generated/automation-json-api/api.js +74 -0
- package/esm/generated/automation-json-api/api.js.map +1 -1
- package/esm/generated/automation-json-api/openapi-spec.json +391 -2
- package/esm/generated/export-json-api/api.d.ts +1129 -1074
- package/esm/generated/export-json-api/api.d.ts.map +1 -1
- package/esm/generated/export-json-api/api.js +363 -342
- package/esm/generated/export-json-api/api.js.map +1 -1
- package/esm/generated/export-json-api/openapi-spec.json +50 -1
- package/esm/generated/metadata-json-api/api.d.ts +1874 -1222
- package/esm/generated/metadata-json-api/api.d.ts.map +1 -1
- package/esm/generated/metadata-json-api/api.js +307 -46
- package/esm/generated/metadata-json-api/api.js.map +1 -1
- package/esm/generated/metadata-json-api/openapi-spec.json +8012 -7558
- package/esm/index.d.ts +5 -3
- package/esm/index.d.ts.map +1 -1
- package/esm/index.js +2 -1
- 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,34 @@ 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 ExportBoundedFilterGranularityEnum = {
|
|
46
|
+
MINUTE: "MINUTE",
|
|
47
|
+
HOUR: "HOUR",
|
|
48
|
+
DAY: "DAY",
|
|
49
|
+
WEEK: "WEEK",
|
|
50
|
+
MONTH: "MONTH",
|
|
51
|
+
QUARTER: "QUARTER",
|
|
52
|
+
YEAR: "YEAR",
|
|
53
|
+
MINUTE_OF_HOUR: "MINUTE_OF_HOUR",
|
|
54
|
+
HOUR_OF_DAY: "HOUR_OF_DAY",
|
|
55
|
+
DAY_OF_WEEK: "DAY_OF_WEEK",
|
|
56
|
+
DAY_OF_MONTH: "DAY_OF_MONTH",
|
|
57
|
+
DAY_OF_YEAR: "DAY_OF_YEAR",
|
|
58
|
+
WEEK_OF_YEAR: "WEEK_OF_YEAR",
|
|
59
|
+
MONTH_OF_YEAR: "MONTH_OF_YEAR",
|
|
60
|
+
QUARTER_OF_YEAR: "QUARTER_OF_YEAR",
|
|
61
|
+
};
|
|
62
|
+
export const ExportComparisonMeasureValueFilterComparisonMeasureValueFilterOperatorEnum = {
|
|
46
63
|
GREATER_THAN: "GREATER_THAN",
|
|
47
64
|
GREATER_THAN_OR_EQUAL_TO: "GREATER_THAN_OR_EQUAL_TO",
|
|
48
65
|
LESS_THAN: "LESS_THAN",
|
|
@@ -50,15 +67,15 @@ export const ComparisonMeasureValueFilterComparisonMeasureValueFilterOperatorEnu
|
|
|
50
67
|
EQUAL_TO: "EQUAL_TO",
|
|
51
68
|
NOT_EQUAL_TO: "NOT_EQUAL_TO",
|
|
52
69
|
};
|
|
53
|
-
export const
|
|
70
|
+
export const ExportDashboardAttributeFilterAttributeFilterSelectionModeEnum = {
|
|
54
71
|
SINGLE: "single",
|
|
55
72
|
MULTI: "multi",
|
|
56
73
|
};
|
|
57
|
-
export const
|
|
74
|
+
export const ExportDashboardDateFilterDateFilterTypeEnum = {
|
|
58
75
|
RELATIVE: "relative",
|
|
59
76
|
ABSOLUTE: "absolute",
|
|
60
77
|
};
|
|
61
|
-
export const
|
|
78
|
+
export const ExportDashboardDateFilterDateFilterGranularityEnum = {
|
|
62
79
|
ALL_TIME_GRANULARITY: "ALL_TIME_GRANULARITY",
|
|
63
80
|
GDC_TIME_YEAR: "GDC.time.year",
|
|
64
81
|
GDC_TIME_WEEK_US: "GDC.time.week_us",
|
|
@@ -83,10 +100,10 @@ export const DashboardDateFilterDateFilterGranularityEnum = {
|
|
|
83
100
|
GDC_TIME_MINUTE: "GDC.time.minute",
|
|
84
101
|
GDC_TIME_MINUTE_IN_HOUR: "GDC.time.minute_in_hour",
|
|
85
102
|
};
|
|
86
|
-
export const
|
|
103
|
+
export const ExportDashboardTabularExportRequestFormatEnum = {
|
|
87
104
|
XLSX: "XLSX",
|
|
88
105
|
};
|
|
89
|
-
export const
|
|
106
|
+
export const ExportIdentifierRefIdentifierTypeEnum = {
|
|
90
107
|
ANALYTICAL_DASHBOARD: "analyticalDashboard",
|
|
91
108
|
ATTRIBUTE: "attribute",
|
|
92
109
|
ATTRIBUTE_HIERARCHY: "attributeHierarchy",
|
|
@@ -107,23 +124,23 @@ export const IdentifierRefIdentifierTypeEnum = {
|
|
|
107
124
|
WORKSPACE_DATA_FILTER_SETTING: "workspaceDataFilterSetting",
|
|
108
125
|
FILTER_VIEW: "filterView",
|
|
109
126
|
};
|
|
110
|
-
export const
|
|
127
|
+
export const ExportImageExportRequestFormatEnum = {
|
|
111
128
|
PNG: "PNG",
|
|
112
129
|
};
|
|
113
|
-
export const
|
|
130
|
+
export const ExportRangeMeasureValueFilterRangeMeasureValueFilterOperatorEnum = {
|
|
114
131
|
BETWEEN: "BETWEEN",
|
|
115
132
|
NOT_BETWEEN: "NOT_BETWEEN",
|
|
116
133
|
};
|
|
117
|
-
export const
|
|
134
|
+
export const ExportRankingFilterRankingFilterOperatorEnum = {
|
|
118
135
|
TOP: "TOP",
|
|
119
136
|
BOTTOM: "BOTTOM",
|
|
120
137
|
};
|
|
121
|
-
export const
|
|
138
|
+
export const ExportRawExportRequestFormatEnum = {
|
|
122
139
|
ARROW_FILE: "ARROW_FILE",
|
|
123
140
|
ARROW_STREAM: "ARROW_STREAM",
|
|
124
141
|
CSV: "CSV",
|
|
125
142
|
};
|
|
126
|
-
export const
|
|
143
|
+
export const ExportRelativeDateFilterRelativeDateFilterGranularityEnum = {
|
|
127
144
|
MINUTE: "MINUTE",
|
|
128
145
|
HOUR: "HOUR",
|
|
129
146
|
DAY: "DAY",
|
|
@@ -140,7 +157,7 @@ export const RelativeDateFilterRelativeDateFilterGranularityEnum = {
|
|
|
140
157
|
MONTH_OF_YEAR: "MONTH_OF_YEAR",
|
|
141
158
|
QUARTER_OF_YEAR: "QUARTER_OF_YEAR",
|
|
142
159
|
};
|
|
143
|
-
export const
|
|
160
|
+
export const ExportSimpleMeasureDefinitionMeasureAggregationEnum = {
|
|
144
161
|
SUM: "SUM",
|
|
145
162
|
COUNT: "COUNT",
|
|
146
163
|
AVG: "AVG",
|
|
@@ -150,38 +167,38 @@ export const SimpleMeasureDefinitionMeasureAggregationEnum = {
|
|
|
150
167
|
RUNSUM: "RUNSUM",
|
|
151
168
|
APPROXIMATE_COUNT: "APPROXIMATE_COUNT",
|
|
152
169
|
};
|
|
153
|
-
export const
|
|
170
|
+
export const ExportSlidesExportRequestFormatEnum = {
|
|
154
171
|
PDF: "PDF",
|
|
155
172
|
PPTX: "PPTX",
|
|
156
173
|
};
|
|
157
|
-
export const
|
|
174
|
+
export const ExportTabularExportRequestFormatEnum = {
|
|
158
175
|
CSV: "CSV",
|
|
159
176
|
XLSX: "XLSX",
|
|
160
177
|
HTML: "HTML",
|
|
161
178
|
PDF: "PDF",
|
|
162
179
|
};
|
|
163
180
|
/**
|
|
164
|
-
*
|
|
181
|
+
* ActionsExport - axios parameter creator
|
|
165
182
|
* @export
|
|
166
183
|
*/
|
|
167
|
-
export const
|
|
184
|
+
export const ActionsExportAxiosParamCreator = function (configuration) {
|
|
168
185
|
return {
|
|
169
186
|
/**
|
|
170
187
|
* 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
188
|
* @summary (EXPERIMENTAL) Create dashboard tabular export request
|
|
172
189
|
* @param {string} workspaceId
|
|
173
190
|
* @param {string} dashboardId
|
|
174
|
-
* @param {
|
|
191
|
+
* @param {ExportDashboardTabularExportRequest} exportDashboardTabularExportRequest
|
|
175
192
|
* @param {*} [options] Override http request option.
|
|
176
193
|
* @throws {RequiredError}
|
|
177
194
|
*/
|
|
178
|
-
createDashboardExportRequest: async (workspaceId, dashboardId,
|
|
195
|
+
createDashboardExportRequest: async (workspaceId, dashboardId, exportDashboardTabularExportRequest, options = {}) => {
|
|
179
196
|
// verify required parameter 'workspaceId' is not null or undefined
|
|
180
197
|
assertParamExists("createDashboardExportRequest", "workspaceId", workspaceId);
|
|
181
198
|
// verify required parameter 'dashboardId' is not null or undefined
|
|
182
199
|
assertParamExists("createDashboardExportRequest", "dashboardId", dashboardId);
|
|
183
|
-
// verify required parameter '
|
|
184
|
-
assertParamExists("createDashboardExportRequest", "
|
|
200
|
+
// verify required parameter 'exportDashboardTabularExportRequest' is not null or undefined
|
|
201
|
+
assertParamExists("createDashboardExportRequest", "exportDashboardTabularExportRequest", exportDashboardTabularExportRequest);
|
|
185
202
|
const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/export/tabular`
|
|
186
203
|
.replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)))
|
|
187
204
|
.replace(`{${"dashboardId"}}`, encodeURIComponent(String(dashboardId)));
|
|
@@ -202,11 +219,13 @@ export const ActionsApiAxiosParamCreator = function (configuration) {
|
|
|
202
219
|
...headersFromBaseOptions,
|
|
203
220
|
...options.headers,
|
|
204
221
|
};
|
|
205
|
-
const needsSerialization = typeof
|
|
222
|
+
const needsSerialization = typeof exportDashboardTabularExportRequest !== "string" ||
|
|
206
223
|
localVarRequestOptions.headers["Content-Type"] === "application/json";
|
|
207
224
|
localVarRequestOptions.data = needsSerialization
|
|
208
|
-
? JSON.stringify(
|
|
209
|
-
|
|
225
|
+
? JSON.stringify(exportDashboardTabularExportRequest !== undefined
|
|
226
|
+
? exportDashboardTabularExportRequest
|
|
227
|
+
: {})
|
|
228
|
+
: exportDashboardTabularExportRequest || "";
|
|
210
229
|
return {
|
|
211
230
|
url: toPathString(localVarUrlObj),
|
|
212
231
|
options: localVarRequestOptions,
|
|
@@ -216,15 +235,15 @@ export const ActionsApiAxiosParamCreator = function (configuration) {
|
|
|
216
235
|
* 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
236
|
* @summary (EXPERIMENTAL) Create image export request
|
|
218
237
|
* @param {string} workspaceId
|
|
219
|
-
* @param {
|
|
238
|
+
* @param {ExportImageExportRequest} exportImageExportRequest
|
|
220
239
|
* @param {*} [options] Override http request option.
|
|
221
240
|
* @throws {RequiredError}
|
|
222
241
|
*/
|
|
223
|
-
createImageExport: async (workspaceId,
|
|
242
|
+
createImageExport: async (workspaceId, exportImageExportRequest, options = {}) => {
|
|
224
243
|
// verify required parameter 'workspaceId' is not null or undefined
|
|
225
244
|
assertParamExists("createImageExport", "workspaceId", workspaceId);
|
|
226
|
-
// verify required parameter '
|
|
227
|
-
assertParamExists("createImageExport", "
|
|
245
|
+
// verify required parameter 'exportImageExportRequest' is not null or undefined
|
|
246
|
+
assertParamExists("createImageExport", "exportImageExportRequest", exportImageExportRequest);
|
|
228
247
|
const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/export/image`.replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)));
|
|
229
248
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
230
249
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -243,11 +262,11 @@ export const ActionsApiAxiosParamCreator = function (configuration) {
|
|
|
243
262
|
...headersFromBaseOptions,
|
|
244
263
|
...options.headers,
|
|
245
264
|
};
|
|
246
|
-
const needsSerialization = typeof
|
|
265
|
+
const needsSerialization = typeof exportImageExportRequest !== "string" ||
|
|
247
266
|
localVarRequestOptions.headers["Content-Type"] === "application/json";
|
|
248
267
|
localVarRequestOptions.data = needsSerialization
|
|
249
|
-
? JSON.stringify(
|
|
250
|
-
:
|
|
268
|
+
? JSON.stringify(exportImageExportRequest !== undefined ? exportImageExportRequest : {})
|
|
269
|
+
: exportImageExportRequest || "";
|
|
251
270
|
return {
|
|
252
271
|
url: toPathString(localVarUrlObj),
|
|
253
272
|
options: localVarRequestOptions,
|
|
@@ -257,15 +276,15 @@ export const ActionsApiAxiosParamCreator = function (configuration) {
|
|
|
257
276
|
* 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
277
|
* @summary Create visual - pdf export request
|
|
259
278
|
* @param {string} workspaceId
|
|
260
|
-
* @param {
|
|
279
|
+
* @param {ExportVisualExportRequest} exportVisualExportRequest
|
|
261
280
|
* @param {*} [options] Override http request option.
|
|
262
281
|
* @throws {RequiredError}
|
|
263
282
|
*/
|
|
264
|
-
createPdfExport: async (workspaceId,
|
|
283
|
+
createPdfExport: async (workspaceId, exportVisualExportRequest, options = {}) => {
|
|
265
284
|
// verify required parameter 'workspaceId' is not null or undefined
|
|
266
285
|
assertParamExists("createPdfExport", "workspaceId", workspaceId);
|
|
267
|
-
// verify required parameter '
|
|
268
|
-
assertParamExists("createPdfExport", "
|
|
286
|
+
// verify required parameter 'exportVisualExportRequest' is not null or undefined
|
|
287
|
+
assertParamExists("createPdfExport", "exportVisualExportRequest", exportVisualExportRequest);
|
|
269
288
|
const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/export/visual`.replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)));
|
|
270
289
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
271
290
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -284,11 +303,11 @@ export const ActionsApiAxiosParamCreator = function (configuration) {
|
|
|
284
303
|
...headersFromBaseOptions,
|
|
285
304
|
...options.headers,
|
|
286
305
|
};
|
|
287
|
-
const needsSerialization = typeof
|
|
306
|
+
const needsSerialization = typeof exportVisualExportRequest !== "string" ||
|
|
288
307
|
localVarRequestOptions.headers["Content-Type"] === "application/json";
|
|
289
308
|
localVarRequestOptions.data = needsSerialization
|
|
290
|
-
? JSON.stringify(
|
|
291
|
-
:
|
|
309
|
+
? JSON.stringify(exportVisualExportRequest !== undefined ? exportVisualExportRequest : {})
|
|
310
|
+
: exportVisualExportRequest || "";
|
|
292
311
|
return {
|
|
293
312
|
url: toPathString(localVarUrlObj),
|
|
294
313
|
options: localVarRequestOptions,
|
|
@@ -298,15 +317,15 @@ export const ActionsApiAxiosParamCreator = function (configuration) {
|
|
|
298
317
|
* 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
318
|
* @summary (EXPERIMENTAL) Create raw export request
|
|
300
319
|
* @param {string} workspaceId
|
|
301
|
-
* @param {
|
|
320
|
+
* @param {ExportRawExportRequest} exportRawExportRequest
|
|
302
321
|
* @param {*} [options] Override http request option.
|
|
303
322
|
* @throws {RequiredError}
|
|
304
323
|
*/
|
|
305
|
-
createRawExport: async (workspaceId,
|
|
324
|
+
createRawExport: async (workspaceId, exportRawExportRequest, options = {}) => {
|
|
306
325
|
// verify required parameter 'workspaceId' is not null or undefined
|
|
307
326
|
assertParamExists("createRawExport", "workspaceId", workspaceId);
|
|
308
|
-
// verify required parameter '
|
|
309
|
-
assertParamExists("createRawExport", "
|
|
327
|
+
// verify required parameter 'exportRawExportRequest' is not null or undefined
|
|
328
|
+
assertParamExists("createRawExport", "exportRawExportRequest", exportRawExportRequest);
|
|
310
329
|
const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/export/raw`.replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)));
|
|
311
330
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
312
331
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -325,11 +344,11 @@ export const ActionsApiAxiosParamCreator = function (configuration) {
|
|
|
325
344
|
...headersFromBaseOptions,
|
|
326
345
|
...options.headers,
|
|
327
346
|
};
|
|
328
|
-
const needsSerialization = typeof
|
|
347
|
+
const needsSerialization = typeof exportRawExportRequest !== "string" ||
|
|
329
348
|
localVarRequestOptions.headers["Content-Type"] === "application/json";
|
|
330
349
|
localVarRequestOptions.data = needsSerialization
|
|
331
|
-
? JSON.stringify(
|
|
332
|
-
:
|
|
350
|
+
? JSON.stringify(exportRawExportRequest !== undefined ? exportRawExportRequest : {})
|
|
351
|
+
: exportRawExportRequest || "";
|
|
333
352
|
return {
|
|
334
353
|
url: toPathString(localVarUrlObj),
|
|
335
354
|
options: localVarRequestOptions,
|
|
@@ -339,15 +358,15 @@ export const ActionsApiAxiosParamCreator = function (configuration) {
|
|
|
339
358
|
* 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
359
|
* @summary (EXPERIMENTAL) Create slides export request
|
|
341
360
|
* @param {string} workspaceId
|
|
342
|
-
* @param {
|
|
361
|
+
* @param {ExportSlidesExportRequest} exportSlidesExportRequest
|
|
343
362
|
* @param {*} [options] Override http request option.
|
|
344
363
|
* @throws {RequiredError}
|
|
345
364
|
*/
|
|
346
|
-
createSlidesExport: async (workspaceId,
|
|
365
|
+
createSlidesExport: async (workspaceId, exportSlidesExportRequest, options = {}) => {
|
|
347
366
|
// verify required parameter 'workspaceId' is not null or undefined
|
|
348
367
|
assertParamExists("createSlidesExport", "workspaceId", workspaceId);
|
|
349
|
-
// verify required parameter '
|
|
350
|
-
assertParamExists("createSlidesExport", "
|
|
368
|
+
// verify required parameter 'exportSlidesExportRequest' is not null or undefined
|
|
369
|
+
assertParamExists("createSlidesExport", "exportSlidesExportRequest", exportSlidesExportRequest);
|
|
351
370
|
const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/export/slides`.replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)));
|
|
352
371
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
353
372
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -366,11 +385,11 @@ export const ActionsApiAxiosParamCreator = function (configuration) {
|
|
|
366
385
|
...headersFromBaseOptions,
|
|
367
386
|
...options.headers,
|
|
368
387
|
};
|
|
369
|
-
const needsSerialization = typeof
|
|
388
|
+
const needsSerialization = typeof exportSlidesExportRequest !== "string" ||
|
|
370
389
|
localVarRequestOptions.headers["Content-Type"] === "application/json";
|
|
371
390
|
localVarRequestOptions.data = needsSerialization
|
|
372
|
-
? JSON.stringify(
|
|
373
|
-
:
|
|
391
|
+
? JSON.stringify(exportSlidesExportRequest !== undefined ? exportSlidesExportRequest : {})
|
|
392
|
+
: exportSlidesExportRequest || "";
|
|
374
393
|
return {
|
|
375
394
|
url: toPathString(localVarUrlObj),
|
|
376
395
|
options: localVarRequestOptions,
|
|
@@ -380,15 +399,15 @@ export const ActionsApiAxiosParamCreator = function (configuration) {
|
|
|
380
399
|
* 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
400
|
* @summary Create tabular export request
|
|
382
401
|
* @param {string} workspaceId
|
|
383
|
-
* @param {
|
|
402
|
+
* @param {ExportTabularExportRequest} exportTabularExportRequest
|
|
384
403
|
* @param {*} [options] Override http request option.
|
|
385
404
|
* @throws {RequiredError}
|
|
386
405
|
*/
|
|
387
|
-
createTabularExport: async (workspaceId,
|
|
406
|
+
createTabularExport: async (workspaceId, exportTabularExportRequest, options = {}) => {
|
|
388
407
|
// verify required parameter 'workspaceId' is not null or undefined
|
|
389
408
|
assertParamExists("createTabularExport", "workspaceId", workspaceId);
|
|
390
|
-
// verify required parameter '
|
|
391
|
-
assertParamExists("createTabularExport", "
|
|
409
|
+
// verify required parameter 'exportTabularExportRequest' is not null or undefined
|
|
410
|
+
assertParamExists("createTabularExport", "exportTabularExportRequest", exportTabularExportRequest);
|
|
392
411
|
const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/export/tabular`.replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)));
|
|
393
412
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
394
413
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -407,11 +426,11 @@ export const ActionsApiAxiosParamCreator = function (configuration) {
|
|
|
407
426
|
...headersFromBaseOptions,
|
|
408
427
|
...options.headers,
|
|
409
428
|
};
|
|
410
|
-
const needsSerialization = typeof
|
|
429
|
+
const needsSerialization = typeof exportTabularExportRequest !== "string" ||
|
|
411
430
|
localVarRequestOptions.headers["Content-Type"] === "application/json";
|
|
412
431
|
localVarRequestOptions.data = needsSerialization
|
|
413
|
-
? JSON.stringify(
|
|
414
|
-
:
|
|
432
|
+
? JSON.stringify(exportTabularExportRequest !== undefined ? exportTabularExportRequest : {})
|
|
433
|
+
: exportTabularExportRequest || "";
|
|
415
434
|
return {
|
|
416
435
|
url: toPathString(localVarUrlObj),
|
|
417
436
|
options: localVarRequestOptions,
|
|
@@ -716,83 +735,83 @@ export const ActionsApiAxiosParamCreator = function (configuration) {
|
|
|
716
735
|
};
|
|
717
736
|
};
|
|
718
737
|
/**
|
|
719
|
-
*
|
|
738
|
+
* ActionsExport - functional programming interface
|
|
720
739
|
* @export
|
|
721
740
|
*/
|
|
722
|
-
export const
|
|
723
|
-
const localVarAxiosParamCreator =
|
|
741
|
+
export const ActionsExportFp = function (configuration) {
|
|
742
|
+
const localVarAxiosParamCreator = ActionsExportAxiosParamCreator(configuration);
|
|
724
743
|
return {
|
|
725
744
|
/**
|
|
726
745
|
* 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
746
|
* @summary (EXPERIMENTAL) Create dashboard tabular export request
|
|
728
747
|
* @param {string} workspaceId
|
|
729
748
|
* @param {string} dashboardId
|
|
730
|
-
* @param {
|
|
749
|
+
* @param {ExportDashboardTabularExportRequest} exportDashboardTabularExportRequest
|
|
731
750
|
* @param {*} [options] Override http request option.
|
|
732
751
|
* @throws {RequiredError}
|
|
733
752
|
*/
|
|
734
|
-
async createDashboardExportRequest(workspaceId, dashboardId,
|
|
735
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.createDashboardExportRequest(workspaceId, dashboardId,
|
|
753
|
+
async createDashboardExportRequest(workspaceId, dashboardId, exportDashboardTabularExportRequest, options) {
|
|
754
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createDashboardExportRequest(workspaceId, dashboardId, exportDashboardTabularExportRequest, options);
|
|
736
755
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
737
756
|
},
|
|
738
757
|
/**
|
|
739
758
|
* 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
759
|
* @summary (EXPERIMENTAL) Create image export request
|
|
741
760
|
* @param {string} workspaceId
|
|
742
|
-
* @param {
|
|
761
|
+
* @param {ExportImageExportRequest} exportImageExportRequest
|
|
743
762
|
* @param {*} [options] Override http request option.
|
|
744
763
|
* @throws {RequiredError}
|
|
745
764
|
*/
|
|
746
|
-
async createImageExport(workspaceId,
|
|
747
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.createImageExport(workspaceId,
|
|
765
|
+
async createImageExport(workspaceId, exportImageExportRequest, options) {
|
|
766
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createImageExport(workspaceId, exportImageExportRequest, options);
|
|
748
767
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
749
768
|
},
|
|
750
769
|
/**
|
|
751
770
|
* 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
771
|
* @summary Create visual - pdf export request
|
|
753
772
|
* @param {string} workspaceId
|
|
754
|
-
* @param {
|
|
773
|
+
* @param {ExportVisualExportRequest} exportVisualExportRequest
|
|
755
774
|
* @param {*} [options] Override http request option.
|
|
756
775
|
* @throws {RequiredError}
|
|
757
776
|
*/
|
|
758
|
-
async createPdfExport(workspaceId,
|
|
759
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.createPdfExport(workspaceId,
|
|
777
|
+
async createPdfExport(workspaceId, exportVisualExportRequest, options) {
|
|
778
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createPdfExport(workspaceId, exportVisualExportRequest, options);
|
|
760
779
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
761
780
|
},
|
|
762
781
|
/**
|
|
763
782
|
* 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
783
|
* @summary (EXPERIMENTAL) Create raw export request
|
|
765
784
|
* @param {string} workspaceId
|
|
766
|
-
* @param {
|
|
785
|
+
* @param {ExportRawExportRequest} exportRawExportRequest
|
|
767
786
|
* @param {*} [options] Override http request option.
|
|
768
787
|
* @throws {RequiredError}
|
|
769
788
|
*/
|
|
770
|
-
async createRawExport(workspaceId,
|
|
771
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.createRawExport(workspaceId,
|
|
789
|
+
async createRawExport(workspaceId, exportRawExportRequest, options) {
|
|
790
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createRawExport(workspaceId, exportRawExportRequest, options);
|
|
772
791
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
773
792
|
},
|
|
774
793
|
/**
|
|
775
794
|
* 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
795
|
* @summary (EXPERIMENTAL) Create slides export request
|
|
777
796
|
* @param {string} workspaceId
|
|
778
|
-
* @param {
|
|
797
|
+
* @param {ExportSlidesExportRequest} exportSlidesExportRequest
|
|
779
798
|
* @param {*} [options] Override http request option.
|
|
780
799
|
* @throws {RequiredError}
|
|
781
800
|
*/
|
|
782
|
-
async createSlidesExport(workspaceId,
|
|
783
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.createSlidesExport(workspaceId,
|
|
801
|
+
async createSlidesExport(workspaceId, exportSlidesExportRequest, options) {
|
|
802
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createSlidesExport(workspaceId, exportSlidesExportRequest, options);
|
|
784
803
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
785
804
|
},
|
|
786
805
|
/**
|
|
787
806
|
* 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
807
|
* @summary Create tabular export request
|
|
789
808
|
* @param {string} workspaceId
|
|
790
|
-
* @param {
|
|
809
|
+
* @param {ExportTabularExportRequest} exportTabularExportRequest
|
|
791
810
|
* @param {*} [options] Override http request option.
|
|
792
811
|
* @throws {RequiredError}
|
|
793
812
|
*/
|
|
794
|
-
async createTabularExport(workspaceId,
|
|
795
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.createTabularExport(workspaceId,
|
|
813
|
+
async createTabularExport(workspaceId, exportTabularExportRequest, options) {
|
|
814
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createTabularExport(workspaceId, exportTabularExportRequest, options);
|
|
796
815
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
797
816
|
},
|
|
798
817
|
/**
|
|
@@ -894,88 +913,88 @@ export const ActionsApiFp = function (configuration) {
|
|
|
894
913
|
};
|
|
895
914
|
};
|
|
896
915
|
/**
|
|
897
|
-
*
|
|
916
|
+
* ActionsExport - factory interface
|
|
898
917
|
* @export
|
|
899
918
|
*/
|
|
900
|
-
export const
|
|
901
|
-
const localVarFp =
|
|
919
|
+
export const ActionsExportFactory = function (configuration, basePath, axios) {
|
|
920
|
+
const localVarFp = ActionsExportFp(configuration);
|
|
902
921
|
return {
|
|
903
922
|
/**
|
|
904
923
|
* 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
924
|
* @summary (EXPERIMENTAL) Create dashboard tabular export request
|
|
906
|
-
* @param {
|
|
925
|
+
* @param {ActionsExportCreateDashboardExportRequestRequest} requestParameters Request parameters.
|
|
907
926
|
* @param {*} [options] Override http request option.
|
|
908
927
|
* @throws {RequiredError}
|
|
909
928
|
*/
|
|
910
929
|
createDashboardExportRequest(requestParameters, options) {
|
|
911
930
|
return localVarFp
|
|
912
|
-
.createDashboardExportRequest(requestParameters.workspaceId, requestParameters.dashboardId, requestParameters.
|
|
931
|
+
.createDashboardExportRequest(requestParameters.workspaceId, requestParameters.dashboardId, requestParameters.exportDashboardTabularExportRequest, options)
|
|
913
932
|
.then((request) => request(axios, basePath));
|
|
914
933
|
},
|
|
915
934
|
/**
|
|
916
935
|
* 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
936
|
* @summary (EXPERIMENTAL) Create image export request
|
|
918
|
-
* @param {
|
|
937
|
+
* @param {ActionsExportCreateImageExportRequest} requestParameters Request parameters.
|
|
919
938
|
* @param {*} [options] Override http request option.
|
|
920
939
|
* @throws {RequiredError}
|
|
921
940
|
*/
|
|
922
941
|
createImageExport(requestParameters, options) {
|
|
923
942
|
return localVarFp
|
|
924
|
-
.createImageExport(requestParameters.workspaceId, requestParameters.
|
|
943
|
+
.createImageExport(requestParameters.workspaceId, requestParameters.exportImageExportRequest, options)
|
|
925
944
|
.then((request) => request(axios, basePath));
|
|
926
945
|
},
|
|
927
946
|
/**
|
|
928
947
|
* 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
948
|
* @summary Create visual - pdf export request
|
|
930
|
-
* @param {
|
|
949
|
+
* @param {ActionsExportCreatePdfExportRequest} requestParameters Request parameters.
|
|
931
950
|
* @param {*} [options] Override http request option.
|
|
932
951
|
* @throws {RequiredError}
|
|
933
952
|
*/
|
|
934
953
|
createPdfExport(requestParameters, options) {
|
|
935
954
|
return localVarFp
|
|
936
|
-
.createPdfExport(requestParameters.workspaceId, requestParameters.
|
|
955
|
+
.createPdfExport(requestParameters.workspaceId, requestParameters.exportVisualExportRequest, options)
|
|
937
956
|
.then((request) => request(axios, basePath));
|
|
938
957
|
},
|
|
939
958
|
/**
|
|
940
959
|
* 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
960
|
* @summary (EXPERIMENTAL) Create raw export request
|
|
942
|
-
* @param {
|
|
961
|
+
* @param {ActionsExportCreateRawExportRequest} requestParameters Request parameters.
|
|
943
962
|
* @param {*} [options] Override http request option.
|
|
944
963
|
* @throws {RequiredError}
|
|
945
964
|
*/
|
|
946
965
|
createRawExport(requestParameters, options) {
|
|
947
966
|
return localVarFp
|
|
948
|
-
.createRawExport(requestParameters.workspaceId, requestParameters.
|
|
967
|
+
.createRawExport(requestParameters.workspaceId, requestParameters.exportRawExportRequest, options)
|
|
949
968
|
.then((request) => request(axios, basePath));
|
|
950
969
|
},
|
|
951
970
|
/**
|
|
952
971
|
* 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
972
|
* @summary (EXPERIMENTAL) Create slides export request
|
|
954
|
-
* @param {
|
|
973
|
+
* @param {ActionsExportCreateSlidesExportRequest} requestParameters Request parameters.
|
|
955
974
|
* @param {*} [options] Override http request option.
|
|
956
975
|
* @throws {RequiredError}
|
|
957
976
|
*/
|
|
958
977
|
createSlidesExport(requestParameters, options) {
|
|
959
978
|
return localVarFp
|
|
960
|
-
.createSlidesExport(requestParameters.workspaceId, requestParameters.
|
|
979
|
+
.createSlidesExport(requestParameters.workspaceId, requestParameters.exportSlidesExportRequest, options)
|
|
961
980
|
.then((request) => request(axios, basePath));
|
|
962
981
|
},
|
|
963
982
|
/**
|
|
964
983
|
* 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
984
|
* @summary Create tabular export request
|
|
966
|
-
* @param {
|
|
985
|
+
* @param {ActionsExportCreateTabularExportRequest} requestParameters Request parameters.
|
|
967
986
|
* @param {*} [options] Override http request option.
|
|
968
987
|
* @throws {RequiredError}
|
|
969
988
|
*/
|
|
970
989
|
createTabularExport(requestParameters, options) {
|
|
971
990
|
return localVarFp
|
|
972
|
-
.createTabularExport(requestParameters.workspaceId, requestParameters.
|
|
991
|
+
.createTabularExport(requestParameters.workspaceId, requestParameters.exportTabularExportRequest, options)
|
|
973
992
|
.then((request) => request(axios, basePath));
|
|
974
993
|
},
|
|
975
994
|
/**
|
|
976
995
|
* Returns 202 until original POST export request is not processed.Returns 200 with exported data once the export is done.
|
|
977
996
|
* @summary Retrieve exported files
|
|
978
|
-
* @param {
|
|
997
|
+
* @param {ActionsExportGetExportedFileRequest} requestParameters Request parameters.
|
|
979
998
|
* @param {*} [options] Override http request option.
|
|
980
999
|
* @throws {RequiredError}
|
|
981
1000
|
*/
|
|
@@ -987,7 +1006,7 @@ export const ActionsApiFactory = function (configuration, basePath, axios) {
|
|
|
987
1006
|
/**
|
|
988
1007
|
* 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
1008
|
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
990
|
-
* @param {
|
|
1009
|
+
* @param {ActionsExportGetImageExportRequest} requestParameters Request parameters.
|
|
991
1010
|
* @param {*} [options] Override http request option.
|
|
992
1011
|
* @throws {RequiredError}
|
|
993
1012
|
*/
|
|
@@ -999,7 +1018,7 @@ export const ActionsApiFactory = function (configuration, basePath, axios) {
|
|
|
999
1018
|
/**
|
|
1000
1019
|
* 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
1020
|
* @summary (EXPERIMENTAL) Retrieve metadata context
|
|
1002
|
-
* @param {
|
|
1021
|
+
* @param {ActionsExportGetImageExportMetadataRequest} requestParameters Request parameters.
|
|
1003
1022
|
* @param {*} [options] Override http request option.
|
|
1004
1023
|
* @throws {RequiredError}
|
|
1005
1024
|
*/
|
|
@@ -1011,7 +1030,7 @@ export const ActionsApiFactory = function (configuration, basePath, axios) {
|
|
|
1011
1030
|
/**
|
|
1012
1031
|
* 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
1032
|
* @summary Retrieve metadata context
|
|
1014
|
-
* @param {
|
|
1033
|
+
* @param {ActionsExportGetMetadataRequest} requestParameters Request parameters.
|
|
1015
1034
|
* @param {*} [options] Override http request option.
|
|
1016
1035
|
* @throws {RequiredError}
|
|
1017
1036
|
*/
|
|
@@ -1023,7 +1042,7 @@ export const ActionsApiFactory = function (configuration, basePath, axios) {
|
|
|
1023
1042
|
/**
|
|
1024
1043
|
* 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
1044
|
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
1026
|
-
* @param {
|
|
1045
|
+
* @param {ActionsExportGetRawExportRequest} requestParameters Request parameters.
|
|
1027
1046
|
* @param {*} [options] Override http request option.
|
|
1028
1047
|
* @throws {RequiredError}
|
|
1029
1048
|
*/
|
|
@@ -1035,7 +1054,7 @@ export const ActionsApiFactory = function (configuration, basePath, axios) {
|
|
|
1035
1054
|
/**
|
|
1036
1055
|
* 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
1056
|
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
1038
|
-
* @param {
|
|
1057
|
+
* @param {ActionsExportGetSlidesExportRequest} requestParameters Request parameters.
|
|
1039
1058
|
* @param {*} [options] Override http request option.
|
|
1040
1059
|
* @throws {RequiredError}
|
|
1041
1060
|
*/
|
|
@@ -1047,7 +1066,7 @@ export const ActionsApiFactory = function (configuration, basePath, axios) {
|
|
|
1047
1066
|
/**
|
|
1048
1067
|
* 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
1068
|
* @summary (EXPERIMENTAL) Retrieve metadata context
|
|
1050
|
-
* @param {
|
|
1069
|
+
* @param {ActionsExportGetSlidesExportMetadataRequest} requestParameters Request parameters.
|
|
1051
1070
|
* @param {*} [options] Override http request option.
|
|
1052
1071
|
* @throws {RequiredError}
|
|
1053
1072
|
*/
|
|
@@ -1059,7 +1078,7 @@ export const ActionsApiFactory = function (configuration, basePath, axios) {
|
|
|
1059
1078
|
/**
|
|
1060
1079
|
* 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
1080
|
* @summary Retrieve exported files
|
|
1062
|
-
* @param {
|
|
1081
|
+
* @param {ActionsExportGetTabularExportRequest} requestParameters Request parameters.
|
|
1063
1082
|
* @param {*} [options] Override http request option.
|
|
1064
1083
|
* @throws {RequiredError}
|
|
1065
1084
|
*/
|
|
@@ -1071,214 +1090,214 @@ export const ActionsApiFactory = function (configuration, basePath, axios) {
|
|
|
1071
1090
|
};
|
|
1072
1091
|
};
|
|
1073
1092
|
/**
|
|
1074
|
-
*
|
|
1093
|
+
* ActionsExport - object-oriented interface
|
|
1075
1094
|
* @export
|
|
1076
|
-
* @class
|
|
1095
|
+
* @class ActionsExport
|
|
1077
1096
|
* @extends {BaseAPI}
|
|
1078
1097
|
*/
|
|
1079
|
-
export class
|
|
1098
|
+
export class ActionsExport extends BaseAPI {
|
|
1080
1099
|
/**
|
|
1081
1100
|
* 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
1101
|
* @summary (EXPERIMENTAL) Create dashboard tabular export request
|
|
1083
|
-
* @param {
|
|
1102
|
+
* @param {ActionsExportCreateDashboardExportRequestRequest} requestParameters Request parameters.
|
|
1084
1103
|
* @param {*} [options] Override http request option.
|
|
1085
1104
|
* @throws {RequiredError}
|
|
1086
|
-
* @memberof
|
|
1105
|
+
* @memberof ActionsExport
|
|
1087
1106
|
*/
|
|
1088
1107
|
createDashboardExportRequest(requestParameters, options) {
|
|
1089
|
-
return
|
|
1090
|
-
.createDashboardExportRequest(requestParameters.workspaceId, requestParameters.dashboardId, requestParameters.
|
|
1108
|
+
return ActionsExportFp(this.configuration)
|
|
1109
|
+
.createDashboardExportRequest(requestParameters.workspaceId, requestParameters.dashboardId, requestParameters.exportDashboardTabularExportRequest, options)
|
|
1091
1110
|
.then((request) => request(this.axios, this.basePath));
|
|
1092
1111
|
}
|
|
1093
1112
|
/**
|
|
1094
1113
|
* 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
1114
|
* @summary (EXPERIMENTAL) Create image export request
|
|
1096
|
-
* @param {
|
|
1115
|
+
* @param {ActionsExportCreateImageExportRequest} requestParameters Request parameters.
|
|
1097
1116
|
* @param {*} [options] Override http request option.
|
|
1098
1117
|
* @throws {RequiredError}
|
|
1099
|
-
* @memberof
|
|
1118
|
+
* @memberof ActionsExport
|
|
1100
1119
|
*/
|
|
1101
1120
|
createImageExport(requestParameters, options) {
|
|
1102
|
-
return
|
|
1103
|
-
.createImageExport(requestParameters.workspaceId, requestParameters.
|
|
1121
|
+
return ActionsExportFp(this.configuration)
|
|
1122
|
+
.createImageExport(requestParameters.workspaceId, requestParameters.exportImageExportRequest, options)
|
|
1104
1123
|
.then((request) => request(this.axios, this.basePath));
|
|
1105
1124
|
}
|
|
1106
1125
|
/**
|
|
1107
1126
|
* 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
1127
|
* @summary Create visual - pdf export request
|
|
1109
|
-
* @param {
|
|
1128
|
+
* @param {ActionsExportCreatePdfExportRequest} requestParameters Request parameters.
|
|
1110
1129
|
* @param {*} [options] Override http request option.
|
|
1111
1130
|
* @throws {RequiredError}
|
|
1112
|
-
* @memberof
|
|
1131
|
+
* @memberof ActionsExport
|
|
1113
1132
|
*/
|
|
1114
1133
|
createPdfExport(requestParameters, options) {
|
|
1115
|
-
return
|
|
1116
|
-
.createPdfExport(requestParameters.workspaceId, requestParameters.
|
|
1134
|
+
return ActionsExportFp(this.configuration)
|
|
1135
|
+
.createPdfExport(requestParameters.workspaceId, requestParameters.exportVisualExportRequest, options)
|
|
1117
1136
|
.then((request) => request(this.axios, this.basePath));
|
|
1118
1137
|
}
|
|
1119
1138
|
/**
|
|
1120
1139
|
* 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
1140
|
* @summary (EXPERIMENTAL) Create raw export request
|
|
1122
|
-
* @param {
|
|
1141
|
+
* @param {ActionsExportCreateRawExportRequest} requestParameters Request parameters.
|
|
1123
1142
|
* @param {*} [options] Override http request option.
|
|
1124
1143
|
* @throws {RequiredError}
|
|
1125
|
-
* @memberof
|
|
1144
|
+
* @memberof ActionsExport
|
|
1126
1145
|
*/
|
|
1127
1146
|
createRawExport(requestParameters, options) {
|
|
1128
|
-
return
|
|
1129
|
-
.createRawExport(requestParameters.workspaceId, requestParameters.
|
|
1147
|
+
return ActionsExportFp(this.configuration)
|
|
1148
|
+
.createRawExport(requestParameters.workspaceId, requestParameters.exportRawExportRequest, options)
|
|
1130
1149
|
.then((request) => request(this.axios, this.basePath));
|
|
1131
1150
|
}
|
|
1132
1151
|
/**
|
|
1133
1152
|
* 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
1153
|
* @summary (EXPERIMENTAL) Create slides export request
|
|
1135
|
-
* @param {
|
|
1154
|
+
* @param {ActionsExportCreateSlidesExportRequest} requestParameters Request parameters.
|
|
1136
1155
|
* @param {*} [options] Override http request option.
|
|
1137
1156
|
* @throws {RequiredError}
|
|
1138
|
-
* @memberof
|
|
1157
|
+
* @memberof ActionsExport
|
|
1139
1158
|
*/
|
|
1140
1159
|
createSlidesExport(requestParameters, options) {
|
|
1141
|
-
return
|
|
1142
|
-
.createSlidesExport(requestParameters.workspaceId, requestParameters.
|
|
1160
|
+
return ActionsExportFp(this.configuration)
|
|
1161
|
+
.createSlidesExport(requestParameters.workspaceId, requestParameters.exportSlidesExportRequest, options)
|
|
1143
1162
|
.then((request) => request(this.axios, this.basePath));
|
|
1144
1163
|
}
|
|
1145
1164
|
/**
|
|
1146
1165
|
* 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
1166
|
* @summary Create tabular export request
|
|
1148
|
-
* @param {
|
|
1167
|
+
* @param {ActionsExportCreateTabularExportRequest} requestParameters Request parameters.
|
|
1149
1168
|
* @param {*} [options] Override http request option.
|
|
1150
1169
|
* @throws {RequiredError}
|
|
1151
|
-
* @memberof
|
|
1170
|
+
* @memberof ActionsExport
|
|
1152
1171
|
*/
|
|
1153
1172
|
createTabularExport(requestParameters, options) {
|
|
1154
|
-
return
|
|
1155
|
-
.createTabularExport(requestParameters.workspaceId, requestParameters.
|
|
1173
|
+
return ActionsExportFp(this.configuration)
|
|
1174
|
+
.createTabularExport(requestParameters.workspaceId, requestParameters.exportTabularExportRequest, options)
|
|
1156
1175
|
.then((request) => request(this.axios, this.basePath));
|
|
1157
1176
|
}
|
|
1158
1177
|
/**
|
|
1159
1178
|
* Returns 202 until original POST export request is not processed.Returns 200 with exported data once the export is done.
|
|
1160
1179
|
* @summary Retrieve exported files
|
|
1161
|
-
* @param {
|
|
1180
|
+
* @param {ActionsExportGetExportedFileRequest} requestParameters Request parameters.
|
|
1162
1181
|
* @param {*} [options] Override http request option.
|
|
1163
1182
|
* @throws {RequiredError}
|
|
1164
|
-
* @memberof
|
|
1183
|
+
* @memberof ActionsExport
|
|
1165
1184
|
*/
|
|
1166
1185
|
getExportedFile(requestParameters, options) {
|
|
1167
|
-
return
|
|
1186
|
+
return ActionsExportFp(this.configuration)
|
|
1168
1187
|
.getExportedFile(requestParameters.workspaceId, requestParameters.exportId, options)
|
|
1169
1188
|
.then((request) => request(this.axios, this.basePath));
|
|
1170
1189
|
}
|
|
1171
1190
|
/**
|
|
1172
1191
|
* 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
1192
|
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
1174
|
-
* @param {
|
|
1193
|
+
* @param {ActionsExportGetImageExportRequest} requestParameters Request parameters.
|
|
1175
1194
|
* @param {*} [options] Override http request option.
|
|
1176
1195
|
* @throws {RequiredError}
|
|
1177
|
-
* @memberof
|
|
1196
|
+
* @memberof ActionsExport
|
|
1178
1197
|
*/
|
|
1179
1198
|
getImageExport(requestParameters, options) {
|
|
1180
|
-
return
|
|
1199
|
+
return ActionsExportFp(this.configuration)
|
|
1181
1200
|
.getImageExport(requestParameters.workspaceId, requestParameters.exportId, options)
|
|
1182
1201
|
.then((request) => request(this.axios, this.basePath));
|
|
1183
1202
|
}
|
|
1184
1203
|
/**
|
|
1185
1204
|
* 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
1205
|
* @summary (EXPERIMENTAL) Retrieve metadata context
|
|
1187
|
-
* @param {
|
|
1206
|
+
* @param {ActionsExportGetImageExportMetadataRequest} requestParameters Request parameters.
|
|
1188
1207
|
* @param {*} [options] Override http request option.
|
|
1189
1208
|
* @throws {RequiredError}
|
|
1190
|
-
* @memberof
|
|
1209
|
+
* @memberof ActionsExport
|
|
1191
1210
|
*/
|
|
1192
1211
|
getImageExportMetadata(requestParameters, options) {
|
|
1193
|
-
return
|
|
1212
|
+
return ActionsExportFp(this.configuration)
|
|
1194
1213
|
.getImageExportMetadata(requestParameters.workspaceId, requestParameters.exportId, options)
|
|
1195
1214
|
.then((request) => request(this.axios, this.basePath));
|
|
1196
1215
|
}
|
|
1197
1216
|
/**
|
|
1198
1217
|
* 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
1218
|
* @summary Retrieve metadata context
|
|
1200
|
-
* @param {
|
|
1219
|
+
* @param {ActionsExportGetMetadataRequest} requestParameters Request parameters.
|
|
1201
1220
|
* @param {*} [options] Override http request option.
|
|
1202
1221
|
* @throws {RequiredError}
|
|
1203
|
-
* @memberof
|
|
1222
|
+
* @memberof ActionsExport
|
|
1204
1223
|
*/
|
|
1205
1224
|
getMetadata(requestParameters, options) {
|
|
1206
|
-
return
|
|
1225
|
+
return ActionsExportFp(this.configuration)
|
|
1207
1226
|
.getMetadata(requestParameters.workspaceId, requestParameters.exportId, options)
|
|
1208
1227
|
.then((request) => request(this.axios, this.basePath));
|
|
1209
1228
|
}
|
|
1210
1229
|
/**
|
|
1211
1230
|
* 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
1231
|
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
1213
|
-
* @param {
|
|
1232
|
+
* @param {ActionsExportGetRawExportRequest} requestParameters Request parameters.
|
|
1214
1233
|
* @param {*} [options] Override http request option.
|
|
1215
1234
|
* @throws {RequiredError}
|
|
1216
|
-
* @memberof
|
|
1235
|
+
* @memberof ActionsExport
|
|
1217
1236
|
*/
|
|
1218
1237
|
getRawExport(requestParameters, options) {
|
|
1219
|
-
return
|
|
1238
|
+
return ActionsExportFp(this.configuration)
|
|
1220
1239
|
.getRawExport(requestParameters.workspaceId, requestParameters.exportId, options)
|
|
1221
1240
|
.then((request) => request(this.axios, this.basePath));
|
|
1222
1241
|
}
|
|
1223
1242
|
/**
|
|
1224
1243
|
* 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
1244
|
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
1226
|
-
* @param {
|
|
1245
|
+
* @param {ActionsExportGetSlidesExportRequest} requestParameters Request parameters.
|
|
1227
1246
|
* @param {*} [options] Override http request option.
|
|
1228
1247
|
* @throws {RequiredError}
|
|
1229
|
-
* @memberof
|
|
1248
|
+
* @memberof ActionsExport
|
|
1230
1249
|
*/
|
|
1231
1250
|
getSlidesExport(requestParameters, options) {
|
|
1232
|
-
return
|
|
1251
|
+
return ActionsExportFp(this.configuration)
|
|
1233
1252
|
.getSlidesExport(requestParameters.workspaceId, requestParameters.exportId, options)
|
|
1234
1253
|
.then((request) => request(this.axios, this.basePath));
|
|
1235
1254
|
}
|
|
1236
1255
|
/**
|
|
1237
1256
|
* 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
1257
|
* @summary (EXPERIMENTAL) Retrieve metadata context
|
|
1239
|
-
* @param {
|
|
1258
|
+
* @param {ActionsExportGetSlidesExportMetadataRequest} requestParameters Request parameters.
|
|
1240
1259
|
* @param {*} [options] Override http request option.
|
|
1241
1260
|
* @throws {RequiredError}
|
|
1242
|
-
* @memberof
|
|
1261
|
+
* @memberof ActionsExport
|
|
1243
1262
|
*/
|
|
1244
1263
|
getSlidesExportMetadata(requestParameters, options) {
|
|
1245
|
-
return
|
|
1264
|
+
return ActionsExportFp(this.configuration)
|
|
1246
1265
|
.getSlidesExportMetadata(requestParameters.workspaceId, requestParameters.exportId, options)
|
|
1247
1266
|
.then((request) => request(this.axios, this.basePath));
|
|
1248
1267
|
}
|
|
1249
1268
|
/**
|
|
1250
1269
|
* 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
1270
|
* @summary Retrieve exported files
|
|
1252
|
-
* @param {
|
|
1271
|
+
* @param {ActionsExportGetTabularExportRequest} requestParameters Request parameters.
|
|
1253
1272
|
* @param {*} [options] Override http request option.
|
|
1254
1273
|
* @throws {RequiredError}
|
|
1255
|
-
* @memberof
|
|
1274
|
+
* @memberof ActionsExport
|
|
1256
1275
|
*/
|
|
1257
1276
|
getTabularExport(requestParameters, options) {
|
|
1258
|
-
return
|
|
1277
|
+
return ActionsExportFp(this.configuration)
|
|
1259
1278
|
.getTabularExport(requestParameters.workspaceId, requestParameters.exportId, options)
|
|
1260
1279
|
.then((request) => request(this.axios, this.basePath));
|
|
1261
1280
|
}
|
|
1262
1281
|
}
|
|
1263
1282
|
/**
|
|
1264
|
-
*
|
|
1283
|
+
* ImageExportExport - axios parameter creator
|
|
1265
1284
|
* @export
|
|
1266
1285
|
*/
|
|
1267
|
-
export const
|
|
1286
|
+
export const ImageExportExportAxiosParamCreator = function (configuration) {
|
|
1268
1287
|
return {
|
|
1269
1288
|
/**
|
|
1270
1289
|
* 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
1290
|
* @summary (EXPERIMENTAL) Create image export request
|
|
1272
1291
|
* @param {string} workspaceId
|
|
1273
|
-
* @param {
|
|
1292
|
+
* @param {ExportImageExportRequest} exportImageExportRequest
|
|
1274
1293
|
* @param {*} [options] Override http request option.
|
|
1275
1294
|
* @throws {RequiredError}
|
|
1276
1295
|
*/
|
|
1277
|
-
createImageExport: async (workspaceId,
|
|
1296
|
+
createImageExport: async (workspaceId, exportImageExportRequest, options = {}) => {
|
|
1278
1297
|
// verify required parameter 'workspaceId' is not null or undefined
|
|
1279
1298
|
assertParamExists("createImageExport", "workspaceId", workspaceId);
|
|
1280
|
-
// verify required parameter '
|
|
1281
|
-
assertParamExists("createImageExport", "
|
|
1299
|
+
// verify required parameter 'exportImageExportRequest' is not null or undefined
|
|
1300
|
+
assertParamExists("createImageExport", "exportImageExportRequest", exportImageExportRequest);
|
|
1282
1301
|
const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/export/image`.replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)));
|
|
1283
1302
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1284
1303
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -1297,11 +1316,11 @@ export const ImageExportApiAxiosParamCreator = function (configuration) {
|
|
|
1297
1316
|
...headersFromBaseOptions,
|
|
1298
1317
|
...options.headers,
|
|
1299
1318
|
};
|
|
1300
|
-
const needsSerialization = typeof
|
|
1319
|
+
const needsSerialization = typeof exportImageExportRequest !== "string" ||
|
|
1301
1320
|
localVarRequestOptions.headers["Content-Type"] === "application/json";
|
|
1302
1321
|
localVarRequestOptions.data = needsSerialization
|
|
1303
|
-
? JSON.stringify(
|
|
1304
|
-
:
|
|
1322
|
+
? JSON.stringify(exportImageExportRequest !== undefined ? exportImageExportRequest : {})
|
|
1323
|
+
: exportImageExportRequest || "";
|
|
1305
1324
|
return {
|
|
1306
1325
|
url: toPathString(localVarUrlObj),
|
|
1307
1326
|
options: localVarRequestOptions,
|
|
@@ -1384,22 +1403,22 @@ export const ImageExportApiAxiosParamCreator = function (configuration) {
|
|
|
1384
1403
|
};
|
|
1385
1404
|
};
|
|
1386
1405
|
/**
|
|
1387
|
-
*
|
|
1406
|
+
* ImageExportExport - functional programming interface
|
|
1388
1407
|
* @export
|
|
1389
1408
|
*/
|
|
1390
|
-
export const
|
|
1391
|
-
const localVarAxiosParamCreator =
|
|
1409
|
+
export const ImageExportExportFp = function (configuration) {
|
|
1410
|
+
const localVarAxiosParamCreator = ImageExportExportAxiosParamCreator(configuration);
|
|
1392
1411
|
return {
|
|
1393
1412
|
/**
|
|
1394
1413
|
* 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
1414
|
* @summary (EXPERIMENTAL) Create image export request
|
|
1396
1415
|
* @param {string} workspaceId
|
|
1397
|
-
* @param {
|
|
1416
|
+
* @param {ExportImageExportRequest} exportImageExportRequest
|
|
1398
1417
|
* @param {*} [options] Override http request option.
|
|
1399
1418
|
* @throws {RequiredError}
|
|
1400
1419
|
*/
|
|
1401
|
-
async createImageExport(workspaceId,
|
|
1402
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.createImageExport(workspaceId,
|
|
1420
|
+
async createImageExport(workspaceId, exportImageExportRequest, options) {
|
|
1421
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createImageExport(workspaceId, exportImageExportRequest, options);
|
|
1403
1422
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1404
1423
|
},
|
|
1405
1424
|
/**
|
|
@@ -1429,28 +1448,28 @@ export const ImageExportApiFp = function (configuration) {
|
|
|
1429
1448
|
};
|
|
1430
1449
|
};
|
|
1431
1450
|
/**
|
|
1432
|
-
*
|
|
1451
|
+
* ImageExportExport - factory interface
|
|
1433
1452
|
* @export
|
|
1434
1453
|
*/
|
|
1435
|
-
export const
|
|
1436
|
-
const localVarFp =
|
|
1454
|
+
export const ImageExportExportFactory = function (configuration, basePath, axios) {
|
|
1455
|
+
const localVarFp = ImageExportExportFp(configuration);
|
|
1437
1456
|
return {
|
|
1438
1457
|
/**
|
|
1439
1458
|
* 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
1459
|
* @summary (EXPERIMENTAL) Create image export request
|
|
1441
|
-
* @param {
|
|
1460
|
+
* @param {ImageExportExportCreateImageExportRequest} requestParameters Request parameters.
|
|
1442
1461
|
* @param {*} [options] Override http request option.
|
|
1443
1462
|
* @throws {RequiredError}
|
|
1444
1463
|
*/
|
|
1445
1464
|
createImageExport(requestParameters, options) {
|
|
1446
1465
|
return localVarFp
|
|
1447
|
-
.createImageExport(requestParameters.workspaceId, requestParameters.
|
|
1466
|
+
.createImageExport(requestParameters.workspaceId, requestParameters.exportImageExportRequest, options)
|
|
1448
1467
|
.then((request) => request(axios, basePath));
|
|
1449
1468
|
},
|
|
1450
1469
|
/**
|
|
1451
1470
|
* 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
1471
|
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
1453
|
-
* @param {
|
|
1472
|
+
* @param {ImageExportExportGetImageExportRequest} requestParameters Request parameters.
|
|
1454
1473
|
* @param {*} [options] Override http request option.
|
|
1455
1474
|
* @throws {RequiredError}
|
|
1456
1475
|
*/
|
|
@@ -1462,7 +1481,7 @@ export const ImageExportApiFactory = function (configuration, basePath, axios) {
|
|
|
1462
1481
|
/**
|
|
1463
1482
|
* 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
1483
|
* @summary (EXPERIMENTAL) Retrieve metadata context
|
|
1465
|
-
* @param {
|
|
1484
|
+
* @param {ImageExportExportGetImageExportMetadataRequest} requestParameters Request parameters.
|
|
1466
1485
|
* @param {*} [options] Override http request option.
|
|
1467
1486
|
* @throws {RequiredError}
|
|
1468
1487
|
*/
|
|
@@ -1474,71 +1493,71 @@ export const ImageExportApiFactory = function (configuration, basePath, axios) {
|
|
|
1474
1493
|
};
|
|
1475
1494
|
};
|
|
1476
1495
|
/**
|
|
1477
|
-
*
|
|
1496
|
+
* ImageExportExport - object-oriented interface
|
|
1478
1497
|
* @export
|
|
1479
|
-
* @class
|
|
1498
|
+
* @class ImageExportExport
|
|
1480
1499
|
* @extends {BaseAPI}
|
|
1481
1500
|
*/
|
|
1482
|
-
export class
|
|
1501
|
+
export class ImageExportExport extends BaseAPI {
|
|
1483
1502
|
/**
|
|
1484
1503
|
* 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
1504
|
* @summary (EXPERIMENTAL) Create image export request
|
|
1486
|
-
* @param {
|
|
1505
|
+
* @param {ImageExportExportCreateImageExportRequest} requestParameters Request parameters.
|
|
1487
1506
|
* @param {*} [options] Override http request option.
|
|
1488
1507
|
* @throws {RequiredError}
|
|
1489
|
-
* @memberof
|
|
1508
|
+
* @memberof ImageExportExport
|
|
1490
1509
|
*/
|
|
1491
1510
|
createImageExport(requestParameters, options) {
|
|
1492
|
-
return
|
|
1493
|
-
.createImageExport(requestParameters.workspaceId, requestParameters.
|
|
1511
|
+
return ImageExportExportFp(this.configuration)
|
|
1512
|
+
.createImageExport(requestParameters.workspaceId, requestParameters.exportImageExportRequest, options)
|
|
1494
1513
|
.then((request) => request(this.axios, this.basePath));
|
|
1495
1514
|
}
|
|
1496
1515
|
/**
|
|
1497
1516
|
* 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
1517
|
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
1499
|
-
* @param {
|
|
1518
|
+
* @param {ImageExportExportGetImageExportRequest} requestParameters Request parameters.
|
|
1500
1519
|
* @param {*} [options] Override http request option.
|
|
1501
1520
|
* @throws {RequiredError}
|
|
1502
|
-
* @memberof
|
|
1521
|
+
* @memberof ImageExportExport
|
|
1503
1522
|
*/
|
|
1504
1523
|
getImageExport(requestParameters, options) {
|
|
1505
|
-
return
|
|
1524
|
+
return ImageExportExportFp(this.configuration)
|
|
1506
1525
|
.getImageExport(requestParameters.workspaceId, requestParameters.exportId, options)
|
|
1507
1526
|
.then((request) => request(this.axios, this.basePath));
|
|
1508
1527
|
}
|
|
1509
1528
|
/**
|
|
1510
1529
|
* 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
1530
|
* @summary (EXPERIMENTAL) Retrieve metadata context
|
|
1512
|
-
* @param {
|
|
1531
|
+
* @param {ImageExportExportGetImageExportMetadataRequest} requestParameters Request parameters.
|
|
1513
1532
|
* @param {*} [options] Override http request option.
|
|
1514
1533
|
* @throws {RequiredError}
|
|
1515
|
-
* @memberof
|
|
1534
|
+
* @memberof ImageExportExport
|
|
1516
1535
|
*/
|
|
1517
1536
|
getImageExportMetadata(requestParameters, options) {
|
|
1518
|
-
return
|
|
1537
|
+
return ImageExportExportFp(this.configuration)
|
|
1519
1538
|
.getImageExportMetadata(requestParameters.workspaceId, requestParameters.exportId, options)
|
|
1520
1539
|
.then((request) => request(this.axios, this.basePath));
|
|
1521
1540
|
}
|
|
1522
1541
|
}
|
|
1523
1542
|
/**
|
|
1524
|
-
*
|
|
1543
|
+
* RawExportExport - axios parameter creator
|
|
1525
1544
|
* @export
|
|
1526
1545
|
*/
|
|
1527
|
-
export const
|
|
1546
|
+
export const RawExportExportAxiosParamCreator = function (configuration) {
|
|
1528
1547
|
return {
|
|
1529
1548
|
/**
|
|
1530
1549
|
* 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
1550
|
* @summary (EXPERIMENTAL) Create raw export request
|
|
1532
1551
|
* @param {string} workspaceId
|
|
1533
|
-
* @param {
|
|
1552
|
+
* @param {ExportRawExportRequest} exportRawExportRequest
|
|
1534
1553
|
* @param {*} [options] Override http request option.
|
|
1535
1554
|
* @throws {RequiredError}
|
|
1536
1555
|
*/
|
|
1537
|
-
createRawExport: async (workspaceId,
|
|
1556
|
+
createRawExport: async (workspaceId, exportRawExportRequest, options = {}) => {
|
|
1538
1557
|
// verify required parameter 'workspaceId' is not null or undefined
|
|
1539
1558
|
assertParamExists("createRawExport", "workspaceId", workspaceId);
|
|
1540
|
-
// verify required parameter '
|
|
1541
|
-
assertParamExists("createRawExport", "
|
|
1559
|
+
// verify required parameter 'exportRawExportRequest' is not null or undefined
|
|
1560
|
+
assertParamExists("createRawExport", "exportRawExportRequest", exportRawExportRequest);
|
|
1542
1561
|
const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/export/raw`.replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)));
|
|
1543
1562
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1544
1563
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -1557,11 +1576,11 @@ export const RawExportApiAxiosParamCreator = function (configuration) {
|
|
|
1557
1576
|
...headersFromBaseOptions,
|
|
1558
1577
|
...options.headers,
|
|
1559
1578
|
};
|
|
1560
|
-
const needsSerialization = typeof
|
|
1579
|
+
const needsSerialization = typeof exportRawExportRequest !== "string" ||
|
|
1561
1580
|
localVarRequestOptions.headers["Content-Type"] === "application/json";
|
|
1562
1581
|
localVarRequestOptions.data = needsSerialization
|
|
1563
|
-
? JSON.stringify(
|
|
1564
|
-
:
|
|
1582
|
+
? JSON.stringify(exportRawExportRequest !== undefined ? exportRawExportRequest : {})
|
|
1583
|
+
: exportRawExportRequest || "";
|
|
1565
1584
|
return {
|
|
1566
1585
|
url: toPathString(localVarUrlObj),
|
|
1567
1586
|
options: localVarRequestOptions,
|
|
@@ -1607,22 +1626,22 @@ export const RawExportApiAxiosParamCreator = function (configuration) {
|
|
|
1607
1626
|
};
|
|
1608
1627
|
};
|
|
1609
1628
|
/**
|
|
1610
|
-
*
|
|
1629
|
+
* RawExportExport - functional programming interface
|
|
1611
1630
|
* @export
|
|
1612
1631
|
*/
|
|
1613
|
-
export const
|
|
1614
|
-
const localVarAxiosParamCreator =
|
|
1632
|
+
export const RawExportExportFp = function (configuration) {
|
|
1633
|
+
const localVarAxiosParamCreator = RawExportExportAxiosParamCreator(configuration);
|
|
1615
1634
|
return {
|
|
1616
1635
|
/**
|
|
1617
1636
|
* 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
1637
|
* @summary (EXPERIMENTAL) Create raw export request
|
|
1619
1638
|
* @param {string} workspaceId
|
|
1620
|
-
* @param {
|
|
1639
|
+
* @param {ExportRawExportRequest} exportRawExportRequest
|
|
1621
1640
|
* @param {*} [options] Override http request option.
|
|
1622
1641
|
* @throws {RequiredError}
|
|
1623
1642
|
*/
|
|
1624
|
-
async createRawExport(workspaceId,
|
|
1625
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.createRawExport(workspaceId,
|
|
1643
|
+
async createRawExport(workspaceId, exportRawExportRequest, options) {
|
|
1644
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createRawExport(workspaceId, exportRawExportRequest, options);
|
|
1626
1645
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1627
1646
|
},
|
|
1628
1647
|
/**
|
|
@@ -1640,28 +1659,28 @@ export const RawExportApiFp = function (configuration) {
|
|
|
1640
1659
|
};
|
|
1641
1660
|
};
|
|
1642
1661
|
/**
|
|
1643
|
-
*
|
|
1662
|
+
* RawExportExport - factory interface
|
|
1644
1663
|
* @export
|
|
1645
1664
|
*/
|
|
1646
|
-
export const
|
|
1647
|
-
const localVarFp =
|
|
1665
|
+
export const RawExportExportFactory = function (configuration, basePath, axios) {
|
|
1666
|
+
const localVarFp = RawExportExportFp(configuration);
|
|
1648
1667
|
return {
|
|
1649
1668
|
/**
|
|
1650
1669
|
* 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
1670
|
* @summary (EXPERIMENTAL) Create raw export request
|
|
1652
|
-
* @param {
|
|
1671
|
+
* @param {RawExportExportCreateRawExportRequest} requestParameters Request parameters.
|
|
1653
1672
|
* @param {*} [options] Override http request option.
|
|
1654
1673
|
* @throws {RequiredError}
|
|
1655
1674
|
*/
|
|
1656
1675
|
createRawExport(requestParameters, options) {
|
|
1657
1676
|
return localVarFp
|
|
1658
|
-
.createRawExport(requestParameters.workspaceId, requestParameters.
|
|
1677
|
+
.createRawExport(requestParameters.workspaceId, requestParameters.exportRawExportRequest, options)
|
|
1659
1678
|
.then((request) => request(axios, basePath));
|
|
1660
1679
|
},
|
|
1661
1680
|
/**
|
|
1662
1681
|
* 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
1682
|
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
1664
|
-
* @param {
|
|
1683
|
+
* @param {RawExportExportGetRawExportRequest} requestParameters Request parameters.
|
|
1665
1684
|
* @param {*} [options] Override http request option.
|
|
1666
1685
|
* @throws {RequiredError}
|
|
1667
1686
|
*/
|
|
@@ -1673,58 +1692,58 @@ export const RawExportApiFactory = function (configuration, basePath, axios) {
|
|
|
1673
1692
|
};
|
|
1674
1693
|
};
|
|
1675
1694
|
/**
|
|
1676
|
-
*
|
|
1695
|
+
* RawExportExport - object-oriented interface
|
|
1677
1696
|
* @export
|
|
1678
|
-
* @class
|
|
1697
|
+
* @class RawExportExport
|
|
1679
1698
|
* @extends {BaseAPI}
|
|
1680
1699
|
*/
|
|
1681
|
-
export class
|
|
1700
|
+
export class RawExportExport extends BaseAPI {
|
|
1682
1701
|
/**
|
|
1683
1702
|
* 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
1703
|
* @summary (EXPERIMENTAL) Create raw export request
|
|
1685
|
-
* @param {
|
|
1704
|
+
* @param {RawExportExportCreateRawExportRequest} requestParameters Request parameters.
|
|
1686
1705
|
* @param {*} [options] Override http request option.
|
|
1687
1706
|
* @throws {RequiredError}
|
|
1688
|
-
* @memberof
|
|
1707
|
+
* @memberof RawExportExport
|
|
1689
1708
|
*/
|
|
1690
1709
|
createRawExport(requestParameters, options) {
|
|
1691
|
-
return
|
|
1692
|
-
.createRawExport(requestParameters.workspaceId, requestParameters.
|
|
1710
|
+
return RawExportExportFp(this.configuration)
|
|
1711
|
+
.createRawExport(requestParameters.workspaceId, requestParameters.exportRawExportRequest, options)
|
|
1693
1712
|
.then((request) => request(this.axios, this.basePath));
|
|
1694
1713
|
}
|
|
1695
1714
|
/**
|
|
1696
1715
|
* 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
1716
|
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
1698
|
-
* @param {
|
|
1717
|
+
* @param {RawExportExportGetRawExportRequest} requestParameters Request parameters.
|
|
1699
1718
|
* @param {*} [options] Override http request option.
|
|
1700
1719
|
* @throws {RequiredError}
|
|
1701
|
-
* @memberof
|
|
1720
|
+
* @memberof RawExportExport
|
|
1702
1721
|
*/
|
|
1703
1722
|
getRawExport(requestParameters, options) {
|
|
1704
|
-
return
|
|
1723
|
+
return RawExportExportFp(this.configuration)
|
|
1705
1724
|
.getRawExport(requestParameters.workspaceId, requestParameters.exportId, options)
|
|
1706
1725
|
.then((request) => request(this.axios, this.basePath));
|
|
1707
1726
|
}
|
|
1708
1727
|
}
|
|
1709
1728
|
/**
|
|
1710
|
-
*
|
|
1729
|
+
* SlidesExportExport - axios parameter creator
|
|
1711
1730
|
* @export
|
|
1712
1731
|
*/
|
|
1713
|
-
export const
|
|
1732
|
+
export const SlidesExportExportAxiosParamCreator = function (configuration) {
|
|
1714
1733
|
return {
|
|
1715
1734
|
/**
|
|
1716
1735
|
* 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
1736
|
* @summary (EXPERIMENTAL) Create slides export request
|
|
1718
1737
|
* @param {string} workspaceId
|
|
1719
|
-
* @param {
|
|
1738
|
+
* @param {ExportSlidesExportRequest} exportSlidesExportRequest
|
|
1720
1739
|
* @param {*} [options] Override http request option.
|
|
1721
1740
|
* @throws {RequiredError}
|
|
1722
1741
|
*/
|
|
1723
|
-
createSlidesExport: async (workspaceId,
|
|
1742
|
+
createSlidesExport: async (workspaceId, exportSlidesExportRequest, options = {}) => {
|
|
1724
1743
|
// verify required parameter 'workspaceId' is not null or undefined
|
|
1725
1744
|
assertParamExists("createSlidesExport", "workspaceId", workspaceId);
|
|
1726
|
-
// verify required parameter '
|
|
1727
|
-
assertParamExists("createSlidesExport", "
|
|
1745
|
+
// verify required parameter 'exportSlidesExportRequest' is not null or undefined
|
|
1746
|
+
assertParamExists("createSlidesExport", "exportSlidesExportRequest", exportSlidesExportRequest);
|
|
1728
1747
|
const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/export/slides`.replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)));
|
|
1729
1748
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1730
1749
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -1743,11 +1762,11 @@ export const SlidesExportApiAxiosParamCreator = function (configuration) {
|
|
|
1743
1762
|
...headersFromBaseOptions,
|
|
1744
1763
|
...options.headers,
|
|
1745
1764
|
};
|
|
1746
|
-
const needsSerialization = typeof
|
|
1765
|
+
const needsSerialization = typeof exportSlidesExportRequest !== "string" ||
|
|
1747
1766
|
localVarRequestOptions.headers["Content-Type"] === "application/json";
|
|
1748
1767
|
localVarRequestOptions.data = needsSerialization
|
|
1749
|
-
? JSON.stringify(
|
|
1750
|
-
:
|
|
1768
|
+
? JSON.stringify(exportSlidesExportRequest !== undefined ? exportSlidesExportRequest : {})
|
|
1769
|
+
: exportSlidesExportRequest || "";
|
|
1751
1770
|
return {
|
|
1752
1771
|
url: toPathString(localVarUrlObj),
|
|
1753
1772
|
options: localVarRequestOptions,
|
|
@@ -1830,22 +1849,22 @@ export const SlidesExportApiAxiosParamCreator = function (configuration) {
|
|
|
1830
1849
|
};
|
|
1831
1850
|
};
|
|
1832
1851
|
/**
|
|
1833
|
-
*
|
|
1852
|
+
* SlidesExportExport - functional programming interface
|
|
1834
1853
|
* @export
|
|
1835
1854
|
*/
|
|
1836
|
-
export const
|
|
1837
|
-
const localVarAxiosParamCreator =
|
|
1855
|
+
export const SlidesExportExportFp = function (configuration) {
|
|
1856
|
+
const localVarAxiosParamCreator = SlidesExportExportAxiosParamCreator(configuration);
|
|
1838
1857
|
return {
|
|
1839
1858
|
/**
|
|
1840
1859
|
* 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
1860
|
* @summary (EXPERIMENTAL) Create slides export request
|
|
1842
1861
|
* @param {string} workspaceId
|
|
1843
|
-
* @param {
|
|
1862
|
+
* @param {ExportSlidesExportRequest} exportSlidesExportRequest
|
|
1844
1863
|
* @param {*} [options] Override http request option.
|
|
1845
1864
|
* @throws {RequiredError}
|
|
1846
1865
|
*/
|
|
1847
|
-
async createSlidesExport(workspaceId,
|
|
1848
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.createSlidesExport(workspaceId,
|
|
1866
|
+
async createSlidesExport(workspaceId, exportSlidesExportRequest, options) {
|
|
1867
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createSlidesExport(workspaceId, exportSlidesExportRequest, options);
|
|
1849
1868
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1850
1869
|
},
|
|
1851
1870
|
/**
|
|
@@ -1875,28 +1894,28 @@ export const SlidesExportApiFp = function (configuration) {
|
|
|
1875
1894
|
};
|
|
1876
1895
|
};
|
|
1877
1896
|
/**
|
|
1878
|
-
*
|
|
1897
|
+
* SlidesExportExport - factory interface
|
|
1879
1898
|
* @export
|
|
1880
1899
|
*/
|
|
1881
|
-
export const
|
|
1882
|
-
const localVarFp =
|
|
1900
|
+
export const SlidesExportExportFactory = function (configuration, basePath, axios) {
|
|
1901
|
+
const localVarFp = SlidesExportExportFp(configuration);
|
|
1883
1902
|
return {
|
|
1884
1903
|
/**
|
|
1885
1904
|
* 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
1905
|
* @summary (EXPERIMENTAL) Create slides export request
|
|
1887
|
-
* @param {
|
|
1906
|
+
* @param {SlidesExportExportCreateSlidesExportRequest} requestParameters Request parameters.
|
|
1888
1907
|
* @param {*} [options] Override http request option.
|
|
1889
1908
|
* @throws {RequiredError}
|
|
1890
1909
|
*/
|
|
1891
1910
|
createSlidesExport(requestParameters, options) {
|
|
1892
1911
|
return localVarFp
|
|
1893
|
-
.createSlidesExport(requestParameters.workspaceId, requestParameters.
|
|
1912
|
+
.createSlidesExport(requestParameters.workspaceId, requestParameters.exportSlidesExportRequest, options)
|
|
1894
1913
|
.then((request) => request(axios, basePath));
|
|
1895
1914
|
},
|
|
1896
1915
|
/**
|
|
1897
1916
|
* 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
1917
|
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
1899
|
-
* @param {
|
|
1918
|
+
* @param {SlidesExportExportGetSlidesExportRequest} requestParameters Request parameters.
|
|
1900
1919
|
* @param {*} [options] Override http request option.
|
|
1901
1920
|
* @throws {RequiredError}
|
|
1902
1921
|
*/
|
|
@@ -1908,7 +1927,7 @@ export const SlidesExportApiFactory = function (configuration, basePath, axios)
|
|
|
1908
1927
|
/**
|
|
1909
1928
|
* 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
1929
|
* @summary (EXPERIMENTAL) Retrieve metadata context
|
|
1911
|
-
* @param {
|
|
1930
|
+
* @param {SlidesExportExportGetSlidesExportMetadataRequest} requestParameters Request parameters.
|
|
1912
1931
|
* @param {*} [options] Override http request option.
|
|
1913
1932
|
* @throws {RequiredError}
|
|
1914
1933
|
*/
|
|
@@ -1920,74 +1939,74 @@ export const SlidesExportApiFactory = function (configuration, basePath, axios)
|
|
|
1920
1939
|
};
|
|
1921
1940
|
};
|
|
1922
1941
|
/**
|
|
1923
|
-
*
|
|
1942
|
+
* SlidesExportExport - object-oriented interface
|
|
1924
1943
|
* @export
|
|
1925
|
-
* @class
|
|
1944
|
+
* @class SlidesExportExport
|
|
1926
1945
|
* @extends {BaseAPI}
|
|
1927
1946
|
*/
|
|
1928
|
-
export class
|
|
1947
|
+
export class SlidesExportExport extends BaseAPI {
|
|
1929
1948
|
/**
|
|
1930
1949
|
* 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
1950
|
* @summary (EXPERIMENTAL) Create slides export request
|
|
1932
|
-
* @param {
|
|
1951
|
+
* @param {SlidesExportExportCreateSlidesExportRequest} requestParameters Request parameters.
|
|
1933
1952
|
* @param {*} [options] Override http request option.
|
|
1934
1953
|
* @throws {RequiredError}
|
|
1935
|
-
* @memberof
|
|
1954
|
+
* @memberof SlidesExportExport
|
|
1936
1955
|
*/
|
|
1937
1956
|
createSlidesExport(requestParameters, options) {
|
|
1938
|
-
return
|
|
1939
|
-
.createSlidesExport(requestParameters.workspaceId, requestParameters.
|
|
1957
|
+
return SlidesExportExportFp(this.configuration)
|
|
1958
|
+
.createSlidesExport(requestParameters.workspaceId, requestParameters.exportSlidesExportRequest, options)
|
|
1940
1959
|
.then((request) => request(this.axios, this.basePath));
|
|
1941
1960
|
}
|
|
1942
1961
|
/**
|
|
1943
1962
|
* 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
1963
|
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
1945
|
-
* @param {
|
|
1964
|
+
* @param {SlidesExportExportGetSlidesExportRequest} requestParameters Request parameters.
|
|
1946
1965
|
* @param {*} [options] Override http request option.
|
|
1947
1966
|
* @throws {RequiredError}
|
|
1948
|
-
* @memberof
|
|
1967
|
+
* @memberof SlidesExportExport
|
|
1949
1968
|
*/
|
|
1950
1969
|
getSlidesExport(requestParameters, options) {
|
|
1951
|
-
return
|
|
1970
|
+
return SlidesExportExportFp(this.configuration)
|
|
1952
1971
|
.getSlidesExport(requestParameters.workspaceId, requestParameters.exportId, options)
|
|
1953
1972
|
.then((request) => request(this.axios, this.basePath));
|
|
1954
1973
|
}
|
|
1955
1974
|
/**
|
|
1956
1975
|
* 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
1976
|
* @summary (EXPERIMENTAL) Retrieve metadata context
|
|
1958
|
-
* @param {
|
|
1977
|
+
* @param {SlidesExportExportGetSlidesExportMetadataRequest} requestParameters Request parameters.
|
|
1959
1978
|
* @param {*} [options] Override http request option.
|
|
1960
1979
|
* @throws {RequiredError}
|
|
1961
|
-
* @memberof
|
|
1980
|
+
* @memberof SlidesExportExport
|
|
1962
1981
|
*/
|
|
1963
1982
|
getSlidesExportMetadata(requestParameters, options) {
|
|
1964
|
-
return
|
|
1983
|
+
return SlidesExportExportFp(this.configuration)
|
|
1965
1984
|
.getSlidesExportMetadata(requestParameters.workspaceId, requestParameters.exportId, options)
|
|
1966
1985
|
.then((request) => request(this.axios, this.basePath));
|
|
1967
1986
|
}
|
|
1968
1987
|
}
|
|
1969
1988
|
/**
|
|
1970
|
-
*
|
|
1989
|
+
* TabularExportExport - axios parameter creator
|
|
1971
1990
|
* @export
|
|
1972
1991
|
*/
|
|
1973
|
-
export const
|
|
1992
|
+
export const TabularExportExportAxiosParamCreator = function (configuration) {
|
|
1974
1993
|
return {
|
|
1975
1994
|
/**
|
|
1976
1995
|
* 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
1996
|
* @summary (EXPERIMENTAL) Create dashboard tabular export request
|
|
1978
1997
|
* @param {string} workspaceId
|
|
1979
1998
|
* @param {string} dashboardId
|
|
1980
|
-
* @param {
|
|
1999
|
+
* @param {ExportDashboardTabularExportRequest} exportDashboardTabularExportRequest
|
|
1981
2000
|
* @param {*} [options] Override http request option.
|
|
1982
2001
|
* @throws {RequiredError}
|
|
1983
2002
|
*/
|
|
1984
|
-
createDashboardExportRequest: async (workspaceId, dashboardId,
|
|
2003
|
+
createDashboardExportRequest: async (workspaceId, dashboardId, exportDashboardTabularExportRequest, options = {}) => {
|
|
1985
2004
|
// verify required parameter 'workspaceId' is not null or undefined
|
|
1986
2005
|
assertParamExists("createDashboardExportRequest", "workspaceId", workspaceId);
|
|
1987
2006
|
// verify required parameter 'dashboardId' is not null or undefined
|
|
1988
2007
|
assertParamExists("createDashboardExportRequest", "dashboardId", dashboardId);
|
|
1989
|
-
// verify required parameter '
|
|
1990
|
-
assertParamExists("createDashboardExportRequest", "
|
|
2008
|
+
// verify required parameter 'exportDashboardTabularExportRequest' is not null or undefined
|
|
2009
|
+
assertParamExists("createDashboardExportRequest", "exportDashboardTabularExportRequest", exportDashboardTabularExportRequest);
|
|
1991
2010
|
const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/export/tabular`
|
|
1992
2011
|
.replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)))
|
|
1993
2012
|
.replace(`{${"dashboardId"}}`, encodeURIComponent(String(dashboardId)));
|
|
@@ -2008,11 +2027,13 @@ export const TabularExportApiAxiosParamCreator = function (configuration) {
|
|
|
2008
2027
|
...headersFromBaseOptions,
|
|
2009
2028
|
...options.headers,
|
|
2010
2029
|
};
|
|
2011
|
-
const needsSerialization = typeof
|
|
2030
|
+
const needsSerialization = typeof exportDashboardTabularExportRequest !== "string" ||
|
|
2012
2031
|
localVarRequestOptions.headers["Content-Type"] === "application/json";
|
|
2013
2032
|
localVarRequestOptions.data = needsSerialization
|
|
2014
|
-
? JSON.stringify(
|
|
2015
|
-
|
|
2033
|
+
? JSON.stringify(exportDashboardTabularExportRequest !== undefined
|
|
2034
|
+
? exportDashboardTabularExportRequest
|
|
2035
|
+
: {})
|
|
2036
|
+
: exportDashboardTabularExportRequest || "";
|
|
2016
2037
|
return {
|
|
2017
2038
|
url: toPathString(localVarUrlObj),
|
|
2018
2039
|
options: localVarRequestOptions,
|
|
@@ -2022,15 +2043,15 @@ export const TabularExportApiAxiosParamCreator = function (configuration) {
|
|
|
2022
2043
|
* 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
2044
|
* @summary Create tabular export request
|
|
2024
2045
|
* @param {string} workspaceId
|
|
2025
|
-
* @param {
|
|
2046
|
+
* @param {ExportTabularExportRequest} exportTabularExportRequest
|
|
2026
2047
|
* @param {*} [options] Override http request option.
|
|
2027
2048
|
* @throws {RequiredError}
|
|
2028
2049
|
*/
|
|
2029
|
-
createTabularExport: async (workspaceId,
|
|
2050
|
+
createTabularExport: async (workspaceId, exportTabularExportRequest, options = {}) => {
|
|
2030
2051
|
// verify required parameter 'workspaceId' is not null or undefined
|
|
2031
2052
|
assertParamExists("createTabularExport", "workspaceId", workspaceId);
|
|
2032
|
-
// verify required parameter '
|
|
2033
|
-
assertParamExists("createTabularExport", "
|
|
2053
|
+
// verify required parameter 'exportTabularExportRequest' is not null or undefined
|
|
2054
|
+
assertParamExists("createTabularExport", "exportTabularExportRequest", exportTabularExportRequest);
|
|
2034
2055
|
const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/export/tabular`.replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)));
|
|
2035
2056
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2036
2057
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -2049,11 +2070,11 @@ export const TabularExportApiAxiosParamCreator = function (configuration) {
|
|
|
2049
2070
|
...headersFromBaseOptions,
|
|
2050
2071
|
...options.headers,
|
|
2051
2072
|
};
|
|
2052
|
-
const needsSerialization = typeof
|
|
2073
|
+
const needsSerialization = typeof exportTabularExportRequest !== "string" ||
|
|
2053
2074
|
localVarRequestOptions.headers["Content-Type"] === "application/json";
|
|
2054
2075
|
localVarRequestOptions.data = needsSerialization
|
|
2055
|
-
? JSON.stringify(
|
|
2056
|
-
:
|
|
2076
|
+
? JSON.stringify(exportTabularExportRequest !== undefined ? exportTabularExportRequest : {})
|
|
2077
|
+
: exportTabularExportRequest || "";
|
|
2057
2078
|
return {
|
|
2058
2079
|
url: toPathString(localVarUrlObj),
|
|
2059
2080
|
options: localVarRequestOptions,
|
|
@@ -2099,35 +2120,35 @@ export const TabularExportApiAxiosParamCreator = function (configuration) {
|
|
|
2099
2120
|
};
|
|
2100
2121
|
};
|
|
2101
2122
|
/**
|
|
2102
|
-
*
|
|
2123
|
+
* TabularExportExport - functional programming interface
|
|
2103
2124
|
* @export
|
|
2104
2125
|
*/
|
|
2105
|
-
export const
|
|
2106
|
-
const localVarAxiosParamCreator =
|
|
2126
|
+
export const TabularExportExportFp = function (configuration) {
|
|
2127
|
+
const localVarAxiosParamCreator = TabularExportExportAxiosParamCreator(configuration);
|
|
2107
2128
|
return {
|
|
2108
2129
|
/**
|
|
2109
2130
|
* 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
2131
|
* @summary (EXPERIMENTAL) Create dashboard tabular export request
|
|
2111
2132
|
* @param {string} workspaceId
|
|
2112
2133
|
* @param {string} dashboardId
|
|
2113
|
-
* @param {
|
|
2134
|
+
* @param {ExportDashboardTabularExportRequest} exportDashboardTabularExportRequest
|
|
2114
2135
|
* @param {*} [options] Override http request option.
|
|
2115
2136
|
* @throws {RequiredError}
|
|
2116
2137
|
*/
|
|
2117
|
-
async createDashboardExportRequest(workspaceId, dashboardId,
|
|
2118
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.createDashboardExportRequest(workspaceId, dashboardId,
|
|
2138
|
+
async createDashboardExportRequest(workspaceId, dashboardId, exportDashboardTabularExportRequest, options) {
|
|
2139
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createDashboardExportRequest(workspaceId, dashboardId, exportDashboardTabularExportRequest, options);
|
|
2119
2140
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
2120
2141
|
},
|
|
2121
2142
|
/**
|
|
2122
2143
|
* 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
2144
|
* @summary Create tabular export request
|
|
2124
2145
|
* @param {string} workspaceId
|
|
2125
|
-
* @param {
|
|
2146
|
+
* @param {ExportTabularExportRequest} exportTabularExportRequest
|
|
2126
2147
|
* @param {*} [options] Override http request option.
|
|
2127
2148
|
* @throws {RequiredError}
|
|
2128
2149
|
*/
|
|
2129
|
-
async createTabularExport(workspaceId,
|
|
2130
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.createTabularExport(workspaceId,
|
|
2150
|
+
async createTabularExport(workspaceId, exportTabularExportRequest, options) {
|
|
2151
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createTabularExport(workspaceId, exportTabularExportRequest, options);
|
|
2131
2152
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
2132
2153
|
},
|
|
2133
2154
|
/**
|
|
@@ -2145,40 +2166,40 @@ export const TabularExportApiFp = function (configuration) {
|
|
|
2145
2166
|
};
|
|
2146
2167
|
};
|
|
2147
2168
|
/**
|
|
2148
|
-
*
|
|
2169
|
+
* TabularExportExport - factory interface
|
|
2149
2170
|
* @export
|
|
2150
2171
|
*/
|
|
2151
|
-
export const
|
|
2152
|
-
const localVarFp =
|
|
2172
|
+
export const TabularExportExportFactory = function (configuration, basePath, axios) {
|
|
2173
|
+
const localVarFp = TabularExportExportFp(configuration);
|
|
2153
2174
|
return {
|
|
2154
2175
|
/**
|
|
2155
2176
|
* 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
2177
|
* @summary (EXPERIMENTAL) Create dashboard tabular export request
|
|
2157
|
-
* @param {
|
|
2178
|
+
* @param {TabularExportExportCreateDashboardExportRequestRequest} requestParameters Request parameters.
|
|
2158
2179
|
* @param {*} [options] Override http request option.
|
|
2159
2180
|
* @throws {RequiredError}
|
|
2160
2181
|
*/
|
|
2161
2182
|
createDashboardExportRequest(requestParameters, options) {
|
|
2162
2183
|
return localVarFp
|
|
2163
|
-
.createDashboardExportRequest(requestParameters.workspaceId, requestParameters.dashboardId, requestParameters.
|
|
2184
|
+
.createDashboardExportRequest(requestParameters.workspaceId, requestParameters.dashboardId, requestParameters.exportDashboardTabularExportRequest, options)
|
|
2164
2185
|
.then((request) => request(axios, basePath));
|
|
2165
2186
|
},
|
|
2166
2187
|
/**
|
|
2167
2188
|
* 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
2189
|
* @summary Create tabular export request
|
|
2169
|
-
* @param {
|
|
2190
|
+
* @param {TabularExportExportCreateTabularExportRequest} requestParameters Request parameters.
|
|
2170
2191
|
* @param {*} [options] Override http request option.
|
|
2171
2192
|
* @throws {RequiredError}
|
|
2172
2193
|
*/
|
|
2173
2194
|
createTabularExport(requestParameters, options) {
|
|
2174
2195
|
return localVarFp
|
|
2175
|
-
.createTabularExport(requestParameters.workspaceId, requestParameters.
|
|
2196
|
+
.createTabularExport(requestParameters.workspaceId, requestParameters.exportTabularExportRequest, options)
|
|
2176
2197
|
.then((request) => request(axios, basePath));
|
|
2177
2198
|
},
|
|
2178
2199
|
/**
|
|
2179
2200
|
* 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
2201
|
* @summary Retrieve exported files
|
|
2181
|
-
* @param {
|
|
2202
|
+
* @param {TabularExportExportGetTabularExportRequest} requestParameters Request parameters.
|
|
2182
2203
|
* @param {*} [options] Override http request option.
|
|
2183
2204
|
* @throws {RequiredError}
|
|
2184
2205
|
*/
|
|
@@ -2190,71 +2211,71 @@ export const TabularExportApiFactory = function (configuration, basePath, axios)
|
|
|
2190
2211
|
};
|
|
2191
2212
|
};
|
|
2192
2213
|
/**
|
|
2193
|
-
*
|
|
2214
|
+
* TabularExportExport - object-oriented interface
|
|
2194
2215
|
* @export
|
|
2195
|
-
* @class
|
|
2216
|
+
* @class TabularExportExport
|
|
2196
2217
|
* @extends {BaseAPI}
|
|
2197
2218
|
*/
|
|
2198
|
-
export class
|
|
2219
|
+
export class TabularExportExport extends BaseAPI {
|
|
2199
2220
|
/**
|
|
2200
2221
|
* 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
2222
|
* @summary (EXPERIMENTAL) Create dashboard tabular export request
|
|
2202
|
-
* @param {
|
|
2223
|
+
* @param {TabularExportExportCreateDashboardExportRequestRequest} requestParameters Request parameters.
|
|
2203
2224
|
* @param {*} [options] Override http request option.
|
|
2204
2225
|
* @throws {RequiredError}
|
|
2205
|
-
* @memberof
|
|
2226
|
+
* @memberof TabularExportExport
|
|
2206
2227
|
*/
|
|
2207
2228
|
createDashboardExportRequest(requestParameters, options) {
|
|
2208
|
-
return
|
|
2209
|
-
.createDashboardExportRequest(requestParameters.workspaceId, requestParameters.dashboardId, requestParameters.
|
|
2229
|
+
return TabularExportExportFp(this.configuration)
|
|
2230
|
+
.createDashboardExportRequest(requestParameters.workspaceId, requestParameters.dashboardId, requestParameters.exportDashboardTabularExportRequest, options)
|
|
2210
2231
|
.then((request) => request(this.axios, this.basePath));
|
|
2211
2232
|
}
|
|
2212
2233
|
/**
|
|
2213
2234
|
* 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
2235
|
* @summary Create tabular export request
|
|
2215
|
-
* @param {
|
|
2236
|
+
* @param {TabularExportExportCreateTabularExportRequest} requestParameters Request parameters.
|
|
2216
2237
|
* @param {*} [options] Override http request option.
|
|
2217
2238
|
* @throws {RequiredError}
|
|
2218
|
-
* @memberof
|
|
2239
|
+
* @memberof TabularExportExport
|
|
2219
2240
|
*/
|
|
2220
2241
|
createTabularExport(requestParameters, options) {
|
|
2221
|
-
return
|
|
2222
|
-
.createTabularExport(requestParameters.workspaceId, requestParameters.
|
|
2242
|
+
return TabularExportExportFp(this.configuration)
|
|
2243
|
+
.createTabularExport(requestParameters.workspaceId, requestParameters.exportTabularExportRequest, options)
|
|
2223
2244
|
.then((request) => request(this.axios, this.basePath));
|
|
2224
2245
|
}
|
|
2225
2246
|
/**
|
|
2226
2247
|
* 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
2248
|
* @summary Retrieve exported files
|
|
2228
|
-
* @param {
|
|
2249
|
+
* @param {TabularExportExportGetTabularExportRequest} requestParameters Request parameters.
|
|
2229
2250
|
* @param {*} [options] Override http request option.
|
|
2230
2251
|
* @throws {RequiredError}
|
|
2231
|
-
* @memberof
|
|
2252
|
+
* @memberof TabularExportExport
|
|
2232
2253
|
*/
|
|
2233
2254
|
getTabularExport(requestParameters, options) {
|
|
2234
|
-
return
|
|
2255
|
+
return TabularExportExportFp(this.configuration)
|
|
2235
2256
|
.getTabularExport(requestParameters.workspaceId, requestParameters.exportId, options)
|
|
2236
2257
|
.then((request) => request(this.axios, this.basePath));
|
|
2237
2258
|
}
|
|
2238
2259
|
}
|
|
2239
2260
|
/**
|
|
2240
|
-
*
|
|
2261
|
+
* VisualExportExport - axios parameter creator
|
|
2241
2262
|
* @export
|
|
2242
2263
|
*/
|
|
2243
|
-
export const
|
|
2264
|
+
export const VisualExportExportAxiosParamCreator = function (configuration) {
|
|
2244
2265
|
return {
|
|
2245
2266
|
/**
|
|
2246
2267
|
* 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
2268
|
* @summary Create visual - pdf export request
|
|
2248
2269
|
* @param {string} workspaceId
|
|
2249
|
-
* @param {
|
|
2270
|
+
* @param {ExportVisualExportRequest} exportVisualExportRequest
|
|
2250
2271
|
* @param {*} [options] Override http request option.
|
|
2251
2272
|
* @throws {RequiredError}
|
|
2252
2273
|
*/
|
|
2253
|
-
createPdfExport: async (workspaceId,
|
|
2274
|
+
createPdfExport: async (workspaceId, exportVisualExportRequest, options = {}) => {
|
|
2254
2275
|
// verify required parameter 'workspaceId' is not null or undefined
|
|
2255
2276
|
assertParamExists("createPdfExport", "workspaceId", workspaceId);
|
|
2256
|
-
// verify required parameter '
|
|
2257
|
-
assertParamExists("createPdfExport", "
|
|
2277
|
+
// verify required parameter 'exportVisualExportRequest' is not null or undefined
|
|
2278
|
+
assertParamExists("createPdfExport", "exportVisualExportRequest", exportVisualExportRequest);
|
|
2258
2279
|
const localVarPath = `/api/v1/actions/workspaces/{workspaceId}/export/visual`.replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)));
|
|
2259
2280
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2260
2281
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -2273,11 +2294,11 @@ export const VisualExportApiAxiosParamCreator = function (configuration) {
|
|
|
2273
2294
|
...headersFromBaseOptions,
|
|
2274
2295
|
...options.headers,
|
|
2275
2296
|
};
|
|
2276
|
-
const needsSerialization = typeof
|
|
2297
|
+
const needsSerialization = typeof exportVisualExportRequest !== "string" ||
|
|
2277
2298
|
localVarRequestOptions.headers["Content-Type"] === "application/json";
|
|
2278
2299
|
localVarRequestOptions.data = needsSerialization
|
|
2279
|
-
? JSON.stringify(
|
|
2280
|
-
:
|
|
2300
|
+
? JSON.stringify(exportVisualExportRequest !== undefined ? exportVisualExportRequest : {})
|
|
2301
|
+
: exportVisualExportRequest || "";
|
|
2281
2302
|
return {
|
|
2282
2303
|
url: toPathString(localVarUrlObj),
|
|
2283
2304
|
options: localVarRequestOptions,
|
|
@@ -2360,22 +2381,22 @@ export const VisualExportApiAxiosParamCreator = function (configuration) {
|
|
|
2360
2381
|
};
|
|
2361
2382
|
};
|
|
2362
2383
|
/**
|
|
2363
|
-
*
|
|
2384
|
+
* VisualExportExport - functional programming interface
|
|
2364
2385
|
* @export
|
|
2365
2386
|
*/
|
|
2366
|
-
export const
|
|
2367
|
-
const localVarAxiosParamCreator =
|
|
2387
|
+
export const VisualExportExportFp = function (configuration) {
|
|
2388
|
+
const localVarAxiosParamCreator = VisualExportExportAxiosParamCreator(configuration);
|
|
2368
2389
|
return {
|
|
2369
2390
|
/**
|
|
2370
2391
|
* 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
2392
|
* @summary Create visual - pdf export request
|
|
2372
2393
|
* @param {string} workspaceId
|
|
2373
|
-
* @param {
|
|
2394
|
+
* @param {ExportVisualExportRequest} exportVisualExportRequest
|
|
2374
2395
|
* @param {*} [options] Override http request option.
|
|
2375
2396
|
* @throws {RequiredError}
|
|
2376
2397
|
*/
|
|
2377
|
-
async createPdfExport(workspaceId,
|
|
2378
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.createPdfExport(workspaceId,
|
|
2398
|
+
async createPdfExport(workspaceId, exportVisualExportRequest, options) {
|
|
2399
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createPdfExport(workspaceId, exportVisualExportRequest, options);
|
|
2379
2400
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
2380
2401
|
},
|
|
2381
2402
|
/**
|
|
@@ -2405,28 +2426,28 @@ export const VisualExportApiFp = function (configuration) {
|
|
|
2405
2426
|
};
|
|
2406
2427
|
};
|
|
2407
2428
|
/**
|
|
2408
|
-
*
|
|
2429
|
+
* VisualExportExport - factory interface
|
|
2409
2430
|
* @export
|
|
2410
2431
|
*/
|
|
2411
|
-
export const
|
|
2412
|
-
const localVarFp =
|
|
2432
|
+
export const VisualExportExportFactory = function (configuration, basePath, axios) {
|
|
2433
|
+
const localVarFp = VisualExportExportFp(configuration);
|
|
2413
2434
|
return {
|
|
2414
2435
|
/**
|
|
2415
2436
|
* 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
2437
|
* @summary Create visual - pdf export request
|
|
2417
|
-
* @param {
|
|
2438
|
+
* @param {VisualExportExportCreatePdfExportRequest} requestParameters Request parameters.
|
|
2418
2439
|
* @param {*} [options] Override http request option.
|
|
2419
2440
|
* @throws {RequiredError}
|
|
2420
2441
|
*/
|
|
2421
2442
|
createPdfExport(requestParameters, options) {
|
|
2422
2443
|
return localVarFp
|
|
2423
|
-
.createPdfExport(requestParameters.workspaceId, requestParameters.
|
|
2444
|
+
.createPdfExport(requestParameters.workspaceId, requestParameters.exportVisualExportRequest, options)
|
|
2424
2445
|
.then((request) => request(axios, basePath));
|
|
2425
2446
|
},
|
|
2426
2447
|
/**
|
|
2427
2448
|
* Returns 202 until original POST export request is not processed.Returns 200 with exported data once the export is done.
|
|
2428
2449
|
* @summary Retrieve exported files
|
|
2429
|
-
* @param {
|
|
2450
|
+
* @param {VisualExportExportGetExportedFileRequest} requestParameters Request parameters.
|
|
2430
2451
|
* @param {*} [options] Override http request option.
|
|
2431
2452
|
* @throws {RequiredError}
|
|
2432
2453
|
*/
|
|
@@ -2438,7 +2459,7 @@ export const VisualExportApiFactory = function (configuration, basePath, axios)
|
|
|
2438
2459
|
/**
|
|
2439
2460
|
* 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
2461
|
* @summary Retrieve metadata context
|
|
2441
|
-
* @param {
|
|
2462
|
+
* @param {VisualExportExportGetMetadataRequest} requestParameters Request parameters.
|
|
2442
2463
|
* @param {*} [options] Override http request option.
|
|
2443
2464
|
* @throws {RequiredError}
|
|
2444
2465
|
*/
|
|
@@ -2450,48 +2471,48 @@ export const VisualExportApiFactory = function (configuration, basePath, axios)
|
|
|
2450
2471
|
};
|
|
2451
2472
|
};
|
|
2452
2473
|
/**
|
|
2453
|
-
*
|
|
2474
|
+
* VisualExportExport - object-oriented interface
|
|
2454
2475
|
* @export
|
|
2455
|
-
* @class
|
|
2476
|
+
* @class VisualExportExport
|
|
2456
2477
|
* @extends {BaseAPI}
|
|
2457
2478
|
*/
|
|
2458
|
-
export class
|
|
2479
|
+
export class VisualExportExport extends BaseAPI {
|
|
2459
2480
|
/**
|
|
2460
2481
|
* 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
2482
|
* @summary Create visual - pdf export request
|
|
2462
|
-
* @param {
|
|
2483
|
+
* @param {VisualExportExportCreatePdfExportRequest} requestParameters Request parameters.
|
|
2463
2484
|
* @param {*} [options] Override http request option.
|
|
2464
2485
|
* @throws {RequiredError}
|
|
2465
|
-
* @memberof
|
|
2486
|
+
* @memberof VisualExportExport
|
|
2466
2487
|
*/
|
|
2467
2488
|
createPdfExport(requestParameters, options) {
|
|
2468
|
-
return
|
|
2469
|
-
.createPdfExport(requestParameters.workspaceId, requestParameters.
|
|
2489
|
+
return VisualExportExportFp(this.configuration)
|
|
2490
|
+
.createPdfExport(requestParameters.workspaceId, requestParameters.exportVisualExportRequest, options)
|
|
2470
2491
|
.then((request) => request(this.axios, this.basePath));
|
|
2471
2492
|
}
|
|
2472
2493
|
/**
|
|
2473
2494
|
* Returns 202 until original POST export request is not processed.Returns 200 with exported data once the export is done.
|
|
2474
2495
|
* @summary Retrieve exported files
|
|
2475
|
-
* @param {
|
|
2496
|
+
* @param {VisualExportExportGetExportedFileRequest} requestParameters Request parameters.
|
|
2476
2497
|
* @param {*} [options] Override http request option.
|
|
2477
2498
|
* @throws {RequiredError}
|
|
2478
|
-
* @memberof
|
|
2499
|
+
* @memberof VisualExportExport
|
|
2479
2500
|
*/
|
|
2480
2501
|
getExportedFile(requestParameters, options) {
|
|
2481
|
-
return
|
|
2502
|
+
return VisualExportExportFp(this.configuration)
|
|
2482
2503
|
.getExportedFile(requestParameters.workspaceId, requestParameters.exportId, options)
|
|
2483
2504
|
.then((request) => request(this.axios, this.basePath));
|
|
2484
2505
|
}
|
|
2485
2506
|
/**
|
|
2486
2507
|
* 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
2508
|
* @summary Retrieve metadata context
|
|
2488
|
-
* @param {
|
|
2509
|
+
* @param {VisualExportExportGetMetadataRequest} requestParameters Request parameters.
|
|
2489
2510
|
* @param {*} [options] Override http request option.
|
|
2490
2511
|
* @throws {RequiredError}
|
|
2491
|
-
* @memberof
|
|
2512
|
+
* @memberof VisualExportExport
|
|
2492
2513
|
*/
|
|
2493
2514
|
getMetadata(requestParameters, options) {
|
|
2494
|
-
return
|
|
2515
|
+
return VisualExportExportFp(this.configuration)
|
|
2495
2516
|
.getMetadata(requestParameters.workspaceId, requestParameters.exportId, options)
|
|
2496
2517
|
.then((request) => request(this.axios, this.basePath));
|
|
2497
2518
|
}
|