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