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