@gooddata/api-client-tiger 10.33.0-alpha.2 → 10.33.0-alpha.21
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/esm/__version.d.ts +1 -1
- package/esm/__version.d.ts.map +1 -1
- package/esm/__version.js +1 -1
- package/esm/__version.js.map +1 -1
- package/esm/api-client-tiger.d.ts +12623 -9742
- package/esm/client.d.ts +3 -3
- package/esm/client.d.ts.map +1 -1
- package/esm/client.js +2 -2
- package/esm/client.js.map +1 -1
- package/esm/export.d.ts +2 -4
- package/esm/export.d.ts.map +1 -1
- package/esm/export.js +2 -3
- package/esm/export.js.map +1 -1
- package/esm/generated/automation-json-api/api.d.ts +417 -0
- package/esm/generated/automation-json-api/api.d.ts.map +1 -1
- package/esm/generated/automation-json-api/api.js +57 -0
- package/esm/generated/automation-json-api/api.js.map +1 -1
- package/esm/generated/automation-json-api/openapi-spec.json +341 -1
- package/esm/generated/export-json-api/api.d.ts +1073 -1073
- package/esm/generated/export-json-api/api.d.ts.map +1 -1
- package/esm/generated/export-json-api/api.js +346 -342
- package/esm/generated/export-json-api/api.js.map +1 -1
- package/esm/generated/metadata-json-api/api.d.ts +1183 -588
- package/esm/generated/metadata-json-api/api.d.ts.map +1 -1
- package/esm/generated/metadata-json-api/api.js +250 -8
- package/esm/generated/metadata-json-api/api.js.map +1 -1
- package/esm/generated/metadata-json-api/openapi-spec.json +8918 -8515
- package/esm/index.d.ts +3 -1
- package/esm/index.d.ts.map +1 -1
- package/esm/index.js +1 -0
- package/esm/index.js.map +1 -1
- package/package.json +3 -3
|
@@ -15,252 +15,252 @@ import { RequestArgs, BaseAPI } from './base.js';
|
|
|
15
15
|
/**
|
|
16
16
|
* Top level executable entity. Combination of [A]ttributes, [F]ilters & [M]etrics.
|
|
17
17
|
* @export
|
|
18
|
-
* @interface
|
|
18
|
+
* @interface ExportAFM
|
|
19
19
|
*/
|
|
20
|
-
export interface
|
|
20
|
+
export interface ExportAFM {
|
|
21
21
|
/**
|
|
22
22
|
* Attributes to be used in the computation.
|
|
23
|
-
* @type {Array<
|
|
24
|
-
* @memberof
|
|
23
|
+
* @type {Array<ExportAttributeItem>}
|
|
24
|
+
* @memberof ExportAFM
|
|
25
25
|
*/
|
|
26
|
-
attributes: Array<
|
|
26
|
+
attributes: Array<ExportAttributeItem>;
|
|
27
27
|
/**
|
|
28
28
|
* Various filter types to filter the execution result.
|
|
29
|
-
* @type {Array<
|
|
30
|
-
* @memberof
|
|
29
|
+
* @type {Array<ExportFilterDefinition>}
|
|
30
|
+
* @memberof ExportAFM
|
|
31
31
|
*/
|
|
32
|
-
filters: Array<
|
|
32
|
+
filters: Array<ExportFilterDefinition>;
|
|
33
33
|
/**
|
|
34
34
|
* Metrics to be computed.
|
|
35
|
-
* @type {Array<
|
|
36
|
-
* @memberof
|
|
35
|
+
* @type {Array<ExportMeasureItem>}
|
|
36
|
+
* @memberof ExportAFM
|
|
37
37
|
*/
|
|
38
|
-
measures: Array<
|
|
38
|
+
measures: Array<ExportMeasureItem>;
|
|
39
39
|
/**
|
|
40
40
|
* Metrics to be referenced from other AFM objects (e.g. filters) but not included in the result.
|
|
41
|
-
* @type {Array<
|
|
42
|
-
* @memberof
|
|
41
|
+
* @type {Array<ExportMeasureItem>}
|
|
42
|
+
* @memberof ExportAFM
|
|
43
43
|
*/
|
|
44
|
-
auxMeasures?: Array<
|
|
44
|
+
auxMeasures?: Array<ExportMeasureItem>;
|
|
45
45
|
}
|
|
46
46
|
/**
|
|
47
47
|
* A datetime filter specifying exact from and to values.
|
|
48
48
|
* @export
|
|
49
|
-
* @interface
|
|
49
|
+
* @interface ExportAbsoluteDateFilter
|
|
50
50
|
*/
|
|
51
|
-
export interface
|
|
51
|
+
export interface ExportAbsoluteDateFilter {
|
|
52
52
|
/**
|
|
53
53
|
*
|
|
54
|
-
* @type {
|
|
55
|
-
* @memberof
|
|
54
|
+
* @type {ExportAbsoluteDateFilterAbsoluteDateFilter}
|
|
55
|
+
* @memberof ExportAbsoluteDateFilter
|
|
56
56
|
*/
|
|
57
|
-
absoluteDateFilter:
|
|
57
|
+
absoluteDateFilter: ExportAbsoluteDateFilterAbsoluteDateFilter;
|
|
58
58
|
}
|
|
59
59
|
/**
|
|
60
60
|
*
|
|
61
61
|
* @export
|
|
62
|
-
* @interface
|
|
62
|
+
* @interface ExportAbsoluteDateFilterAbsoluteDateFilter
|
|
63
63
|
*/
|
|
64
|
-
export interface
|
|
64
|
+
export interface ExportAbsoluteDateFilterAbsoluteDateFilter {
|
|
65
65
|
/**
|
|
66
66
|
*
|
|
67
67
|
* @type {string}
|
|
68
|
-
* @memberof
|
|
68
|
+
* @memberof ExportAbsoluteDateFilterAbsoluteDateFilter
|
|
69
69
|
*/
|
|
70
70
|
from: string;
|
|
71
71
|
/**
|
|
72
72
|
*
|
|
73
73
|
* @type {string}
|
|
74
|
-
* @memberof
|
|
74
|
+
* @memberof ExportAbsoluteDateFilterAbsoluteDateFilter
|
|
75
75
|
*/
|
|
76
76
|
to: string;
|
|
77
77
|
/**
|
|
78
78
|
*
|
|
79
79
|
* @type {string}
|
|
80
|
-
* @memberof
|
|
80
|
+
* @memberof ExportAbsoluteDateFilterAbsoluteDateFilter
|
|
81
81
|
*/
|
|
82
82
|
localIdentifier?: string;
|
|
83
83
|
/**
|
|
84
84
|
*
|
|
85
85
|
* @type {boolean}
|
|
86
|
-
* @memberof
|
|
86
|
+
* @memberof ExportAbsoluteDateFilterAbsoluteDateFilter
|
|
87
87
|
*/
|
|
88
88
|
applyOnResult?: boolean;
|
|
89
89
|
/**
|
|
90
90
|
*
|
|
91
|
-
* @type {
|
|
92
|
-
* @memberof
|
|
91
|
+
* @type {ExportAfmObjectIdentifierDataset}
|
|
92
|
+
* @memberof ExportAbsoluteDateFilterAbsoluteDateFilter
|
|
93
93
|
*/
|
|
94
|
-
dataset:
|
|
94
|
+
dataset: ExportAfmObjectIdentifierDataset;
|
|
95
95
|
}
|
|
96
96
|
/**
|
|
97
|
-
* @type
|
|
97
|
+
* @type ExportAbstractMeasureValueFilter
|
|
98
98
|
* @export
|
|
99
99
|
*/
|
|
100
|
-
export type
|
|
100
|
+
export type ExportAbstractMeasureValueFilter = ExportComparisonMeasureValueFilter | ExportRangeMeasureValueFilter | ExportRankingFilter;
|
|
101
101
|
/**
|
|
102
|
-
* @type
|
|
102
|
+
* @type ExportAfmIdentifier
|
|
103
103
|
* Reference to the attribute label to which the filter should be applied.
|
|
104
104
|
* @export
|
|
105
105
|
*/
|
|
106
|
-
export type
|
|
106
|
+
export type ExportAfmIdentifier = ExportAfmLocalIdentifier | ExportAfmObjectIdentifier;
|
|
107
107
|
/**
|
|
108
108
|
*
|
|
109
109
|
* @export
|
|
110
|
-
* @interface
|
|
110
|
+
* @interface ExportAfmLocalIdentifier
|
|
111
111
|
*/
|
|
112
|
-
export interface
|
|
112
|
+
export interface ExportAfmLocalIdentifier {
|
|
113
113
|
/**
|
|
114
114
|
*
|
|
115
115
|
* @type {string}
|
|
116
|
-
* @memberof
|
|
116
|
+
* @memberof ExportAfmLocalIdentifier
|
|
117
117
|
*/
|
|
118
118
|
localIdentifier: string;
|
|
119
119
|
}
|
|
120
120
|
/**
|
|
121
121
|
* ObjectIdentifier with `identifier` wrapper. This serves to distinguish MD object identifiers in AFM request from local identifiers.
|
|
122
122
|
* @export
|
|
123
|
-
* @interface
|
|
123
|
+
* @interface ExportAfmObjectIdentifier
|
|
124
124
|
*/
|
|
125
|
-
export interface
|
|
125
|
+
export interface ExportAfmObjectIdentifier {
|
|
126
126
|
/**
|
|
127
127
|
*
|
|
128
|
-
* @type {
|
|
129
|
-
* @memberof
|
|
128
|
+
* @type {ExportAfmObjectIdentifierIdentifier}
|
|
129
|
+
* @memberof ExportAfmObjectIdentifier
|
|
130
130
|
*/
|
|
131
|
-
identifier:
|
|
131
|
+
identifier: ExportAfmObjectIdentifierIdentifier;
|
|
132
132
|
}
|
|
133
133
|
/**
|
|
134
134
|
* Reference to the date attribute to use.
|
|
135
135
|
* @export
|
|
136
|
-
* @interface
|
|
136
|
+
* @interface ExportAfmObjectIdentifierAttribute
|
|
137
137
|
*/
|
|
138
|
-
export interface
|
|
138
|
+
export interface ExportAfmObjectIdentifierAttribute {
|
|
139
139
|
/**
|
|
140
140
|
*
|
|
141
|
-
* @type {
|
|
142
|
-
* @memberof
|
|
141
|
+
* @type {ExportAfmObjectIdentifierAttributeIdentifier}
|
|
142
|
+
* @memberof ExportAfmObjectIdentifierAttribute
|
|
143
143
|
*/
|
|
144
|
-
identifier:
|
|
144
|
+
identifier: ExportAfmObjectIdentifierAttributeIdentifier;
|
|
145
145
|
}
|
|
146
146
|
/**
|
|
147
147
|
*
|
|
148
148
|
* @export
|
|
149
|
-
* @interface
|
|
149
|
+
* @interface ExportAfmObjectIdentifierAttributeIdentifier
|
|
150
150
|
*/
|
|
151
|
-
export interface
|
|
151
|
+
export interface ExportAfmObjectIdentifierAttributeIdentifier {
|
|
152
152
|
/**
|
|
153
153
|
*
|
|
154
154
|
* @type {string}
|
|
155
|
-
* @memberof
|
|
155
|
+
* @memberof ExportAfmObjectIdentifierAttributeIdentifier
|
|
156
156
|
*/
|
|
157
157
|
id: string;
|
|
158
158
|
/**
|
|
159
159
|
*
|
|
160
160
|
* @type {string}
|
|
161
|
-
* @memberof
|
|
161
|
+
* @memberof ExportAfmObjectIdentifierAttributeIdentifier
|
|
162
162
|
*/
|
|
163
|
-
type:
|
|
163
|
+
type: ExportAfmObjectIdentifierAttributeIdentifierTypeEnum;
|
|
164
164
|
}
|
|
165
|
-
export declare const
|
|
165
|
+
export declare const ExportAfmObjectIdentifierAttributeIdentifierTypeEnum: {
|
|
166
166
|
readonly ATTRIBUTE: "attribute";
|
|
167
167
|
};
|
|
168
|
-
export type
|
|
168
|
+
export type ExportAfmObjectIdentifierAttributeIdentifierTypeEnum = typeof ExportAfmObjectIdentifierAttributeIdentifierTypeEnum[keyof typeof ExportAfmObjectIdentifierAttributeIdentifierTypeEnum];
|
|
169
169
|
/**
|
|
170
170
|
* Reference to the metric, fact or attribute object to use for the metric.
|
|
171
171
|
* @export
|
|
172
|
-
* @interface
|
|
172
|
+
* @interface ExportAfmObjectIdentifierCore
|
|
173
173
|
*/
|
|
174
|
-
export interface
|
|
174
|
+
export interface ExportAfmObjectIdentifierCore {
|
|
175
175
|
/**
|
|
176
176
|
*
|
|
177
|
-
* @type {
|
|
178
|
-
* @memberof
|
|
177
|
+
* @type {ExportAfmObjectIdentifierCoreIdentifier}
|
|
178
|
+
* @memberof ExportAfmObjectIdentifierCore
|
|
179
179
|
*/
|
|
180
|
-
identifier:
|
|
180
|
+
identifier: ExportAfmObjectIdentifierCoreIdentifier;
|
|
181
181
|
}
|
|
182
182
|
/**
|
|
183
183
|
*
|
|
184
184
|
* @export
|
|
185
|
-
* @interface
|
|
185
|
+
* @interface ExportAfmObjectIdentifierCoreIdentifier
|
|
186
186
|
*/
|
|
187
|
-
export interface
|
|
187
|
+
export interface ExportAfmObjectIdentifierCoreIdentifier {
|
|
188
188
|
/**
|
|
189
189
|
*
|
|
190
190
|
* @type {string}
|
|
191
|
-
* @memberof
|
|
191
|
+
* @memberof ExportAfmObjectIdentifierCoreIdentifier
|
|
192
192
|
*/
|
|
193
193
|
id: string;
|
|
194
194
|
/**
|
|
195
195
|
*
|
|
196
196
|
* @type {string}
|
|
197
|
-
* @memberof
|
|
197
|
+
* @memberof ExportAfmObjectIdentifierCoreIdentifier
|
|
198
198
|
*/
|
|
199
|
-
type:
|
|
199
|
+
type: ExportAfmObjectIdentifierCoreIdentifierTypeEnum;
|
|
200
200
|
}
|
|
201
|
-
export declare const
|
|
201
|
+
export declare const ExportAfmObjectIdentifierCoreIdentifierTypeEnum: {
|
|
202
202
|
readonly ATTRIBUTE: "attribute";
|
|
203
203
|
readonly LABEL: "label";
|
|
204
204
|
readonly FACT: "fact";
|
|
205
205
|
readonly METRIC: "metric";
|
|
206
206
|
};
|
|
207
|
-
export type
|
|
207
|
+
export type ExportAfmObjectIdentifierCoreIdentifierTypeEnum = typeof ExportAfmObjectIdentifierCoreIdentifierTypeEnum[keyof typeof ExportAfmObjectIdentifierCoreIdentifierTypeEnum];
|
|
208
208
|
/**
|
|
209
209
|
* Reference to the date dataset to which the filter should be applied.
|
|
210
210
|
* @export
|
|
211
|
-
* @interface
|
|
211
|
+
* @interface ExportAfmObjectIdentifierDataset
|
|
212
212
|
*/
|
|
213
|
-
export interface
|
|
213
|
+
export interface ExportAfmObjectIdentifierDataset {
|
|
214
214
|
/**
|
|
215
215
|
*
|
|
216
|
-
* @type {
|
|
217
|
-
* @memberof
|
|
216
|
+
* @type {ExportAfmObjectIdentifierDatasetIdentifier}
|
|
217
|
+
* @memberof ExportAfmObjectIdentifierDataset
|
|
218
218
|
*/
|
|
219
|
-
identifier:
|
|
219
|
+
identifier: ExportAfmObjectIdentifierDatasetIdentifier;
|
|
220
220
|
}
|
|
221
221
|
/**
|
|
222
222
|
*
|
|
223
223
|
* @export
|
|
224
|
-
* @interface
|
|
224
|
+
* @interface ExportAfmObjectIdentifierDatasetIdentifier
|
|
225
225
|
*/
|
|
226
|
-
export interface
|
|
226
|
+
export interface ExportAfmObjectIdentifierDatasetIdentifier {
|
|
227
227
|
/**
|
|
228
228
|
*
|
|
229
229
|
* @type {string}
|
|
230
|
-
* @memberof
|
|
230
|
+
* @memberof ExportAfmObjectIdentifierDatasetIdentifier
|
|
231
231
|
*/
|
|
232
232
|
id: string;
|
|
233
233
|
/**
|
|
234
234
|
*
|
|
235
235
|
* @type {string}
|
|
236
|
-
* @memberof
|
|
236
|
+
* @memberof ExportAfmObjectIdentifierDatasetIdentifier
|
|
237
237
|
*/
|
|
238
|
-
type:
|
|
238
|
+
type: ExportAfmObjectIdentifierDatasetIdentifierTypeEnum;
|
|
239
239
|
}
|
|
240
|
-
export declare const
|
|
240
|
+
export declare const ExportAfmObjectIdentifierDatasetIdentifierTypeEnum: {
|
|
241
241
|
readonly DATASET: "dataset";
|
|
242
242
|
};
|
|
243
|
-
export type
|
|
243
|
+
export type ExportAfmObjectIdentifierDatasetIdentifierTypeEnum = typeof ExportAfmObjectIdentifierDatasetIdentifierTypeEnum[keyof typeof ExportAfmObjectIdentifierDatasetIdentifierTypeEnum];
|
|
244
244
|
/**
|
|
245
245
|
*
|
|
246
246
|
* @export
|
|
247
|
-
* @interface
|
|
247
|
+
* @interface ExportAfmObjectIdentifierIdentifier
|
|
248
248
|
*/
|
|
249
|
-
export interface
|
|
249
|
+
export interface ExportAfmObjectIdentifierIdentifier {
|
|
250
250
|
/**
|
|
251
251
|
*
|
|
252
252
|
* @type {string}
|
|
253
|
-
* @memberof
|
|
253
|
+
* @memberof ExportAfmObjectIdentifierIdentifier
|
|
254
254
|
*/
|
|
255
|
-
type:
|
|
255
|
+
type: ExportAfmObjectIdentifierIdentifierTypeEnum;
|
|
256
256
|
/**
|
|
257
257
|
*
|
|
258
258
|
* @type {string}
|
|
259
|
-
* @memberof
|
|
259
|
+
* @memberof ExportAfmObjectIdentifierIdentifier
|
|
260
260
|
*/
|
|
261
261
|
id: string;
|
|
262
262
|
}
|
|
263
|
-
export declare const
|
|
263
|
+
export declare const ExportAfmObjectIdentifierIdentifierTypeEnum: {
|
|
264
264
|
readonly ANALYTICAL_DASHBOARD: "analyticalDashboard";
|
|
265
265
|
readonly ATTRIBUTE: "attribute";
|
|
266
266
|
readonly DASHBOARD_PLUGIN: "dashboardPlugin";
|
|
@@ -272,259 +272,259 @@ export declare const AfmObjectIdentifierIdentifierTypeEnum: {
|
|
|
272
272
|
readonly VISUALIZATION_OBJECT: "visualizationObject";
|
|
273
273
|
readonly FILTER_CONTEXT: "filterContext";
|
|
274
274
|
};
|
|
275
|
-
export type
|
|
275
|
+
export type ExportAfmObjectIdentifierIdentifierTypeEnum = typeof ExportAfmObjectIdentifierIdentifierTypeEnum[keyof typeof ExportAfmObjectIdentifierIdentifierTypeEnum];
|
|
276
276
|
/**
|
|
277
277
|
*
|
|
278
278
|
* @export
|
|
279
|
-
* @interface
|
|
279
|
+
* @interface ExportAfmObjectIdentifierLabel
|
|
280
280
|
*/
|
|
281
|
-
export interface
|
|
281
|
+
export interface ExportAfmObjectIdentifierLabel {
|
|
282
282
|
/**
|
|
283
283
|
*
|
|
284
|
-
* @type {
|
|
285
|
-
* @memberof
|
|
284
|
+
* @type {ExportAfmObjectIdentifierLabelIdentifier}
|
|
285
|
+
* @memberof ExportAfmObjectIdentifierLabel
|
|
286
286
|
*/
|
|
287
|
-
identifier:
|
|
287
|
+
identifier: ExportAfmObjectIdentifierLabelIdentifier;
|
|
288
288
|
}
|
|
289
289
|
/**
|
|
290
290
|
*
|
|
291
291
|
* @export
|
|
292
|
-
* @interface
|
|
292
|
+
* @interface ExportAfmObjectIdentifierLabelIdentifier
|
|
293
293
|
*/
|
|
294
|
-
export interface
|
|
294
|
+
export interface ExportAfmObjectIdentifierLabelIdentifier {
|
|
295
295
|
/**
|
|
296
296
|
*
|
|
297
297
|
* @type {string}
|
|
298
|
-
* @memberof
|
|
298
|
+
* @memberof ExportAfmObjectIdentifierLabelIdentifier
|
|
299
299
|
*/
|
|
300
|
-
type:
|
|
300
|
+
type: ExportAfmObjectIdentifierLabelIdentifierTypeEnum;
|
|
301
301
|
/**
|
|
302
302
|
*
|
|
303
303
|
* @type {string}
|
|
304
|
-
* @memberof
|
|
304
|
+
* @memberof ExportAfmObjectIdentifierLabelIdentifier
|
|
305
305
|
*/
|
|
306
306
|
id: string;
|
|
307
307
|
}
|
|
308
|
-
export declare const
|
|
308
|
+
export declare const ExportAfmObjectIdentifierLabelIdentifierTypeEnum: {
|
|
309
309
|
readonly LABEL: "label";
|
|
310
310
|
};
|
|
311
|
-
export type
|
|
311
|
+
export type ExportAfmObjectIdentifierLabelIdentifierTypeEnum = typeof ExportAfmObjectIdentifierLabelIdentifierTypeEnum[keyof typeof ExportAfmObjectIdentifierLabelIdentifierTypeEnum];
|
|
312
312
|
/**
|
|
313
313
|
* Metric representing arithmetics between other metrics.
|
|
314
314
|
* @export
|
|
315
|
-
* @interface
|
|
315
|
+
* @interface ExportArithmeticMeasureDefinition
|
|
316
316
|
*/
|
|
317
|
-
export interface
|
|
317
|
+
export interface ExportArithmeticMeasureDefinition {
|
|
318
318
|
/**
|
|
319
319
|
*
|
|
320
|
-
* @type {
|
|
321
|
-
* @memberof
|
|
320
|
+
* @type {ExportArithmeticMeasureDefinitionArithmeticMeasure}
|
|
321
|
+
* @memberof ExportArithmeticMeasureDefinition
|
|
322
322
|
*/
|
|
323
|
-
arithmeticMeasure:
|
|
323
|
+
arithmeticMeasure: ExportArithmeticMeasureDefinitionArithmeticMeasure;
|
|
324
324
|
}
|
|
325
325
|
/**
|
|
326
326
|
*
|
|
327
327
|
* @export
|
|
328
|
-
* @interface
|
|
328
|
+
* @interface ExportArithmeticMeasureDefinitionArithmeticMeasure
|
|
329
329
|
*/
|
|
330
|
-
export interface
|
|
330
|
+
export interface ExportArithmeticMeasureDefinitionArithmeticMeasure {
|
|
331
331
|
/**
|
|
332
332
|
* List of metrics to apply arithmetic operation by chosen operator.
|
|
333
|
-
* @type {Array<
|
|
334
|
-
* @memberof
|
|
333
|
+
* @type {Array<ExportAfmLocalIdentifier>}
|
|
334
|
+
* @memberof ExportArithmeticMeasureDefinitionArithmeticMeasure
|
|
335
335
|
*/
|
|
336
|
-
measureIdentifiers: Array<
|
|
336
|
+
measureIdentifiers: Array<ExportAfmLocalIdentifier>;
|
|
337
337
|
/**
|
|
338
338
|
* Arithmetic operator describing operation between metrics.
|
|
339
339
|
* @type {string}
|
|
340
|
-
* @memberof
|
|
340
|
+
* @memberof ExportArithmeticMeasureDefinitionArithmeticMeasure
|
|
341
341
|
*/
|
|
342
|
-
operator:
|
|
342
|
+
operator: ExportArithmeticMeasureDefinitionArithmeticMeasureOperatorEnum;
|
|
343
343
|
}
|
|
344
|
-
export declare const
|
|
344
|
+
export declare const ExportArithmeticMeasureDefinitionArithmeticMeasureOperatorEnum: {
|
|
345
345
|
readonly SUM: "SUM";
|
|
346
346
|
readonly DIFFERENCE: "DIFFERENCE";
|
|
347
347
|
readonly MULTIPLICATION: "MULTIPLICATION";
|
|
348
348
|
readonly RATIO: "RATIO";
|
|
349
349
|
readonly CHANGE: "CHANGE";
|
|
350
350
|
};
|
|
351
|
-
export type
|
|
351
|
+
export type ExportArithmeticMeasureDefinitionArithmeticMeasureOperatorEnum = typeof ExportArithmeticMeasureDefinitionArithmeticMeasureOperatorEnum[keyof typeof ExportArithmeticMeasureDefinitionArithmeticMeasureOperatorEnum];
|
|
352
352
|
/**
|
|
353
|
-
* @type
|
|
353
|
+
* @type ExportAttributeElements
|
|
354
354
|
* @export
|
|
355
355
|
*/
|
|
356
|
-
export type
|
|
356
|
+
export type ExportAttributeElements = ExportAttributeElementsByRef | ExportAttributeElementsByValue;
|
|
357
357
|
/**
|
|
358
358
|
*
|
|
359
359
|
* @export
|
|
360
|
-
* @interface
|
|
360
|
+
* @interface ExportAttributeElementsByRef
|
|
361
361
|
*/
|
|
362
|
-
export interface
|
|
362
|
+
export interface ExportAttributeElementsByRef {
|
|
363
363
|
/**
|
|
364
364
|
* List of attribute elements by reference
|
|
365
365
|
* @type {Array<string>}
|
|
366
|
-
* @memberof
|
|
366
|
+
* @memberof ExportAttributeElementsByRef
|
|
367
367
|
*/
|
|
368
368
|
uris: Array<string>;
|
|
369
369
|
}
|
|
370
370
|
/**
|
|
371
371
|
*
|
|
372
372
|
* @export
|
|
373
|
-
* @interface
|
|
373
|
+
* @interface ExportAttributeElementsByValue
|
|
374
374
|
*/
|
|
375
|
-
export interface
|
|
375
|
+
export interface ExportAttributeElementsByValue {
|
|
376
376
|
/**
|
|
377
377
|
* List of attribute elements by value
|
|
378
378
|
* @type {Array<string>}
|
|
379
|
-
* @memberof
|
|
379
|
+
* @memberof ExportAttributeElementsByValue
|
|
380
380
|
*/
|
|
381
381
|
values: Array<string>;
|
|
382
382
|
}
|
|
383
383
|
/**
|
|
384
|
-
* @type
|
|
384
|
+
* @type ExportAttributeFilter
|
|
385
385
|
* Abstract filter definition type attributes
|
|
386
386
|
* @export
|
|
387
387
|
*/
|
|
388
|
-
export type
|
|
388
|
+
export type ExportAttributeFilter = ExportNegativeAttributeFilter | ExportPositiveAttributeFilter;
|
|
389
389
|
/**
|
|
390
390
|
*
|
|
391
391
|
* @export
|
|
392
|
-
* @interface
|
|
392
|
+
* @interface ExportAttributeFilterByDate
|
|
393
393
|
*/
|
|
394
|
-
export interface
|
|
394
|
+
export interface ExportAttributeFilterByDate {
|
|
395
395
|
/**
|
|
396
396
|
*
|
|
397
397
|
* @type {string}
|
|
398
|
-
* @memberof
|
|
398
|
+
* @memberof ExportAttributeFilterByDate
|
|
399
399
|
*/
|
|
400
400
|
filterLocalIdentifier: string;
|
|
401
401
|
/**
|
|
402
402
|
*
|
|
403
403
|
* @type {boolean}
|
|
404
|
-
* @memberof
|
|
404
|
+
* @memberof ExportAttributeFilterByDate
|
|
405
405
|
*/
|
|
406
406
|
isCommonDate: boolean;
|
|
407
407
|
}
|
|
408
408
|
/**
|
|
409
409
|
* Filter on specific set of label values.
|
|
410
410
|
* @export
|
|
411
|
-
* @interface
|
|
411
|
+
* @interface ExportAttributeFilterElements
|
|
412
412
|
*/
|
|
413
|
-
export interface
|
|
413
|
+
export interface ExportAttributeFilterElements {
|
|
414
414
|
/**
|
|
415
415
|
* Set of label values.
|
|
416
416
|
* @type {Array<string>}
|
|
417
|
-
* @memberof
|
|
417
|
+
* @memberof ExportAttributeFilterElements
|
|
418
418
|
*/
|
|
419
419
|
values: Array<string>;
|
|
420
420
|
}
|
|
421
421
|
/**
|
|
422
422
|
*
|
|
423
423
|
* @export
|
|
424
|
-
* @interface
|
|
424
|
+
* @interface ExportAttributeFilterParent
|
|
425
425
|
*/
|
|
426
|
-
export interface
|
|
426
|
+
export interface ExportAttributeFilterParent {
|
|
427
427
|
/**
|
|
428
428
|
*
|
|
429
429
|
* @type {string}
|
|
430
|
-
* @memberof
|
|
430
|
+
* @memberof ExportAttributeFilterParent
|
|
431
431
|
*/
|
|
432
432
|
filterLocalIdentifier: string;
|
|
433
433
|
/**
|
|
434
434
|
*
|
|
435
|
-
* @type {
|
|
436
|
-
* @memberof
|
|
435
|
+
* @type {ExportOver}
|
|
436
|
+
* @memberof ExportAttributeFilterParent
|
|
437
437
|
*/
|
|
438
|
-
over:
|
|
438
|
+
over: ExportOver;
|
|
439
439
|
}
|
|
440
440
|
/**
|
|
441
441
|
*
|
|
442
442
|
* @export
|
|
443
|
-
* @interface
|
|
443
|
+
* @interface ExportAttributeItem
|
|
444
444
|
*/
|
|
445
|
-
export interface
|
|
445
|
+
export interface ExportAttributeItem {
|
|
446
446
|
/**
|
|
447
447
|
* Local identifier of the attribute. This can be used to reference the attribute in other parts of the execution definition.
|
|
448
448
|
* @type {string}
|
|
449
|
-
* @memberof
|
|
449
|
+
* @memberof ExportAttributeItem
|
|
450
450
|
*/
|
|
451
451
|
localIdentifier: string;
|
|
452
452
|
/**
|
|
453
453
|
*
|
|
454
|
-
* @type {
|
|
455
|
-
* @memberof
|
|
454
|
+
* @type {ExportAfmObjectIdentifierLabel}
|
|
455
|
+
* @memberof ExportAttributeItem
|
|
456
456
|
*/
|
|
457
|
-
label:
|
|
457
|
+
label: ExportAfmObjectIdentifierLabel;
|
|
458
458
|
/**
|
|
459
459
|
* Indicates whether to show all values of given attribute even if the data bound to those values is not available.
|
|
460
460
|
* @type {boolean}
|
|
461
|
-
* @memberof
|
|
461
|
+
* @memberof ExportAttributeItem
|
|
462
462
|
*/
|
|
463
463
|
showAllValues?: boolean;
|
|
464
464
|
}
|
|
465
465
|
/**
|
|
466
466
|
* Filter the result by comparing specified metric to given constant value, using given comparison operator.
|
|
467
467
|
* @export
|
|
468
|
-
* @interface
|
|
468
|
+
* @interface ExportComparisonMeasureValueFilter
|
|
469
469
|
*/
|
|
470
|
-
export interface
|
|
470
|
+
export interface ExportComparisonMeasureValueFilter {
|
|
471
471
|
/**
|
|
472
472
|
*
|
|
473
|
-
* @type {
|
|
474
|
-
* @memberof
|
|
473
|
+
* @type {ExportComparisonMeasureValueFilterComparisonMeasureValueFilter}
|
|
474
|
+
* @memberof ExportComparisonMeasureValueFilter
|
|
475
475
|
*/
|
|
476
|
-
comparisonMeasureValueFilter:
|
|
476
|
+
comparisonMeasureValueFilter: ExportComparisonMeasureValueFilterComparisonMeasureValueFilter;
|
|
477
477
|
}
|
|
478
478
|
/**
|
|
479
479
|
*
|
|
480
480
|
* @export
|
|
481
|
-
* @interface
|
|
481
|
+
* @interface ExportComparisonMeasureValueFilterComparisonMeasureValueFilter
|
|
482
482
|
*/
|
|
483
|
-
export interface
|
|
483
|
+
export interface ExportComparisonMeasureValueFilterComparisonMeasureValueFilter {
|
|
484
484
|
/**
|
|
485
485
|
* References to the attributes to be used when filtering.
|
|
486
|
-
* @type {Array<
|
|
487
|
-
* @memberof
|
|
486
|
+
* @type {Array<ExportAfmIdentifier>}
|
|
487
|
+
* @memberof ExportComparisonMeasureValueFilterComparisonMeasureValueFilter
|
|
488
488
|
*/
|
|
489
|
-
dimensionality?: Array<
|
|
489
|
+
dimensionality?: Array<ExportAfmIdentifier>;
|
|
490
490
|
/**
|
|
491
491
|
* A value that will be substituted for null values in the metric for the comparisons.
|
|
492
492
|
* @type {number}
|
|
493
|
-
* @memberof
|
|
493
|
+
* @memberof ExportComparisonMeasureValueFilterComparisonMeasureValueFilter
|
|
494
494
|
*/
|
|
495
495
|
treatNullValuesAs?: number;
|
|
496
496
|
/**
|
|
497
497
|
*
|
|
498
498
|
* @type {string}
|
|
499
|
-
* @memberof
|
|
499
|
+
* @memberof ExportComparisonMeasureValueFilterComparisonMeasureValueFilter
|
|
500
500
|
*/
|
|
501
|
-
operator:
|
|
501
|
+
operator: ExportComparisonMeasureValueFilterComparisonMeasureValueFilterOperatorEnum;
|
|
502
502
|
/**
|
|
503
503
|
*
|
|
504
504
|
* @type {number}
|
|
505
|
-
* @memberof
|
|
505
|
+
* @memberof ExportComparisonMeasureValueFilterComparisonMeasureValueFilter
|
|
506
506
|
*/
|
|
507
507
|
value: number;
|
|
508
508
|
/**
|
|
509
509
|
*
|
|
510
510
|
* @type {string}
|
|
511
|
-
* @memberof
|
|
511
|
+
* @memberof ExportComparisonMeasureValueFilterComparisonMeasureValueFilter
|
|
512
512
|
*/
|
|
513
513
|
localIdentifier?: string;
|
|
514
514
|
/**
|
|
515
515
|
*
|
|
516
516
|
* @type {boolean}
|
|
517
|
-
* @memberof
|
|
517
|
+
* @memberof ExportComparisonMeasureValueFilterComparisonMeasureValueFilter
|
|
518
518
|
*/
|
|
519
519
|
applyOnResult?: boolean;
|
|
520
520
|
/**
|
|
521
521
|
*
|
|
522
|
-
* @type {
|
|
523
|
-
* @memberof
|
|
522
|
+
* @type {ExportAfmIdentifier}
|
|
523
|
+
* @memberof ExportComparisonMeasureValueFilterComparisonMeasureValueFilter
|
|
524
524
|
*/
|
|
525
|
-
measure:
|
|
525
|
+
measure: ExportAfmIdentifier;
|
|
526
526
|
}
|
|
527
|
-
export declare const
|
|
527
|
+
export declare const ExportComparisonMeasureValueFilterComparisonMeasureValueFilterOperatorEnum: {
|
|
528
528
|
readonly GREATER_THAN: "GREATER_THAN";
|
|
529
529
|
readonly GREATER_THAN_OR_EQUAL_TO: "GREATER_THAN_OR_EQUAL_TO";
|
|
530
530
|
readonly LESS_THAN: "LESS_THAN";
|
|
@@ -532,209 +532,209 @@ export declare const ComparisonMeasureValueFilterComparisonMeasureValueFilterOpe
|
|
|
532
532
|
readonly EQUAL_TO: "EQUAL_TO";
|
|
533
533
|
readonly NOT_EQUAL_TO: "NOT_EQUAL_TO";
|
|
534
534
|
};
|
|
535
|
-
export type
|
|
535
|
+
export type ExportComparisonMeasureValueFilterComparisonMeasureValueFilterOperatorEnum = typeof ExportComparisonMeasureValueFilterComparisonMeasureValueFilterOperatorEnum[keyof typeof ExportComparisonMeasureValueFilterComparisonMeasureValueFilterOperatorEnum];
|
|
536
536
|
/**
|
|
537
537
|
* Custom label object override.
|
|
538
538
|
* @export
|
|
539
|
-
* @interface
|
|
539
|
+
* @interface ExportCustomLabel
|
|
540
540
|
*/
|
|
541
|
-
export interface
|
|
541
|
+
export interface ExportCustomLabel {
|
|
542
542
|
/**
|
|
543
543
|
* Override value.
|
|
544
544
|
* @type {string}
|
|
545
|
-
* @memberof
|
|
545
|
+
* @memberof ExportCustomLabel
|
|
546
546
|
*/
|
|
547
547
|
title: string;
|
|
548
548
|
}
|
|
549
549
|
/**
|
|
550
550
|
* Custom metric object override.
|
|
551
551
|
* @export
|
|
552
|
-
* @interface
|
|
552
|
+
* @interface ExportCustomMetric
|
|
553
553
|
*/
|
|
554
|
-
export interface
|
|
554
|
+
export interface ExportCustomMetric {
|
|
555
555
|
/**
|
|
556
556
|
* Metric title override.
|
|
557
557
|
* @type {string}
|
|
558
|
-
* @memberof
|
|
558
|
+
* @memberof ExportCustomMetric
|
|
559
559
|
*/
|
|
560
560
|
title: string;
|
|
561
561
|
/**
|
|
562
562
|
* Format override.
|
|
563
563
|
* @type {string}
|
|
564
|
-
* @memberof
|
|
564
|
+
* @memberof ExportCustomMetric
|
|
565
565
|
*/
|
|
566
566
|
format: string;
|
|
567
567
|
}
|
|
568
568
|
/**
|
|
569
569
|
* Custom cell value overrides (IDs will be replaced with specified values).
|
|
570
570
|
* @export
|
|
571
|
-
* @interface
|
|
571
|
+
* @interface ExportCustomOverride
|
|
572
572
|
*/
|
|
573
|
-
export interface
|
|
573
|
+
export interface ExportCustomOverride {
|
|
574
574
|
/**
|
|
575
575
|
* Map of CustomLabels with keys used as placeholders in document.
|
|
576
|
-
* @type {{ [key: string]:
|
|
577
|
-
* @memberof
|
|
576
|
+
* @type {{ [key: string]: ExportCustomLabel; }}
|
|
577
|
+
* @memberof ExportCustomOverride
|
|
578
578
|
*/
|
|
579
579
|
labels?: {
|
|
580
|
-
[key: string]:
|
|
580
|
+
[key: string]: ExportCustomLabel;
|
|
581
581
|
};
|
|
582
582
|
/**
|
|
583
583
|
* Map of CustomMetrics with keys used as placeholders in document.
|
|
584
|
-
* @type {{ [key: string]:
|
|
585
|
-
* @memberof
|
|
584
|
+
* @type {{ [key: string]: ExportCustomMetric; }}
|
|
585
|
+
* @memberof ExportCustomOverride
|
|
586
586
|
*/
|
|
587
587
|
metrics?: {
|
|
588
|
-
[key: string]:
|
|
588
|
+
[key: string]: ExportCustomMetric;
|
|
589
589
|
};
|
|
590
590
|
}
|
|
591
591
|
/**
|
|
592
592
|
*
|
|
593
593
|
* @export
|
|
594
|
-
* @interface
|
|
594
|
+
* @interface ExportDashboardAttributeFilter
|
|
595
595
|
*/
|
|
596
|
-
export interface
|
|
596
|
+
export interface ExportDashboardAttributeFilter {
|
|
597
597
|
/**
|
|
598
598
|
*
|
|
599
|
-
* @type {
|
|
600
|
-
* @memberof
|
|
599
|
+
* @type {ExportDashboardAttributeFilterAttributeFilter}
|
|
600
|
+
* @memberof ExportDashboardAttributeFilter
|
|
601
601
|
*/
|
|
602
|
-
attributeFilter:
|
|
602
|
+
attributeFilter: ExportDashboardAttributeFilterAttributeFilter;
|
|
603
603
|
}
|
|
604
604
|
/**
|
|
605
605
|
*
|
|
606
606
|
* @export
|
|
607
|
-
* @interface
|
|
607
|
+
* @interface ExportDashboardAttributeFilterAttributeFilter
|
|
608
608
|
*/
|
|
609
|
-
export interface
|
|
609
|
+
export interface ExportDashboardAttributeFilterAttributeFilter {
|
|
610
610
|
/**
|
|
611
611
|
*
|
|
612
|
-
* @type {
|
|
613
|
-
* @memberof
|
|
612
|
+
* @type {ExportIdentifierRef}
|
|
613
|
+
* @memberof ExportDashboardAttributeFilterAttributeFilter
|
|
614
614
|
*/
|
|
615
|
-
displayForm:
|
|
615
|
+
displayForm: ExportIdentifierRef;
|
|
616
616
|
/**
|
|
617
617
|
*
|
|
618
618
|
* @type {boolean}
|
|
619
|
-
* @memberof
|
|
619
|
+
* @memberof ExportDashboardAttributeFilterAttributeFilter
|
|
620
620
|
*/
|
|
621
621
|
negativeSelection: boolean;
|
|
622
622
|
/**
|
|
623
623
|
*
|
|
624
|
-
* @type {
|
|
625
|
-
* @memberof
|
|
624
|
+
* @type {ExportAttributeElements}
|
|
625
|
+
* @memberof ExportDashboardAttributeFilterAttributeFilter
|
|
626
626
|
*/
|
|
627
|
-
attributeElements:
|
|
627
|
+
attributeElements: ExportAttributeElements;
|
|
628
628
|
/**
|
|
629
629
|
*
|
|
630
|
-
* @type {Array<
|
|
631
|
-
* @memberof
|
|
630
|
+
* @type {Array<ExportAttributeFilterParent>}
|
|
631
|
+
* @memberof ExportDashboardAttributeFilterAttributeFilter
|
|
632
632
|
*/
|
|
633
|
-
filterElementsBy?: Array<
|
|
633
|
+
filterElementsBy?: Array<ExportAttributeFilterParent>;
|
|
634
634
|
/**
|
|
635
635
|
*
|
|
636
|
-
* @type {Array<
|
|
637
|
-
* @memberof
|
|
636
|
+
* @type {Array<ExportAttributeFilterByDate>}
|
|
637
|
+
* @memberof ExportDashboardAttributeFilterAttributeFilter
|
|
638
638
|
*/
|
|
639
|
-
filterElementsByDate?: Array<
|
|
639
|
+
filterElementsByDate?: Array<ExportAttributeFilterByDate>;
|
|
640
640
|
/**
|
|
641
641
|
*
|
|
642
|
-
* @type {Array<
|
|
643
|
-
* @memberof
|
|
642
|
+
* @type {Array<ExportIdentifierRef>}
|
|
643
|
+
* @memberof ExportDashboardAttributeFilterAttributeFilter
|
|
644
644
|
*/
|
|
645
|
-
validateElementsBy?: Array<
|
|
645
|
+
validateElementsBy?: Array<ExportIdentifierRef>;
|
|
646
646
|
/**
|
|
647
647
|
*
|
|
648
648
|
* @type {string}
|
|
649
|
-
* @memberof
|
|
649
|
+
* @memberof ExportDashboardAttributeFilterAttributeFilter
|
|
650
650
|
*/
|
|
651
651
|
title?: string;
|
|
652
652
|
/**
|
|
653
653
|
*
|
|
654
654
|
* @type {string}
|
|
655
|
-
* @memberof
|
|
655
|
+
* @memberof ExportDashboardAttributeFilterAttributeFilter
|
|
656
656
|
*/
|
|
657
|
-
selectionMode?:
|
|
657
|
+
selectionMode?: ExportDashboardAttributeFilterAttributeFilterSelectionModeEnum;
|
|
658
658
|
/**
|
|
659
659
|
*
|
|
660
660
|
* @type {string}
|
|
661
|
-
* @memberof
|
|
661
|
+
* @memberof ExportDashboardAttributeFilterAttributeFilter
|
|
662
662
|
*/
|
|
663
663
|
localIdentifier?: string;
|
|
664
664
|
}
|
|
665
|
-
export declare const
|
|
665
|
+
export declare const ExportDashboardAttributeFilterAttributeFilterSelectionModeEnum: {
|
|
666
666
|
readonly SINGLE: "single";
|
|
667
667
|
readonly MULTI: "multi";
|
|
668
668
|
};
|
|
669
|
-
export type
|
|
669
|
+
export type ExportDashboardAttributeFilterAttributeFilterSelectionModeEnum = typeof ExportDashboardAttributeFilterAttributeFilterSelectionModeEnum[keyof typeof ExportDashboardAttributeFilterAttributeFilterSelectionModeEnum];
|
|
670
670
|
/**
|
|
671
671
|
*
|
|
672
672
|
* @export
|
|
673
|
-
* @interface
|
|
673
|
+
* @interface ExportDashboardDateFilter
|
|
674
674
|
*/
|
|
675
|
-
export interface
|
|
675
|
+
export interface ExportDashboardDateFilter {
|
|
676
676
|
/**
|
|
677
677
|
*
|
|
678
|
-
* @type {
|
|
679
|
-
* @memberof
|
|
678
|
+
* @type {ExportDashboardDateFilterDateFilter}
|
|
679
|
+
* @memberof ExportDashboardDateFilter
|
|
680
680
|
*/
|
|
681
|
-
dateFilter:
|
|
681
|
+
dateFilter: ExportDashboardDateFilterDateFilter;
|
|
682
682
|
}
|
|
683
683
|
/**
|
|
684
684
|
*
|
|
685
685
|
* @export
|
|
686
|
-
* @interface
|
|
686
|
+
* @interface ExportDashboardDateFilterDateFilter
|
|
687
687
|
*/
|
|
688
|
-
export interface
|
|
688
|
+
export interface ExportDashboardDateFilterDateFilter {
|
|
689
689
|
/**
|
|
690
690
|
*
|
|
691
691
|
* @type {string}
|
|
692
|
-
* @memberof
|
|
692
|
+
* @memberof ExportDashboardDateFilterDateFilter
|
|
693
693
|
*/
|
|
694
|
-
type:
|
|
694
|
+
type: ExportDashboardDateFilterDateFilterTypeEnum;
|
|
695
695
|
/**
|
|
696
696
|
*
|
|
697
697
|
* @type {string}
|
|
698
|
-
* @memberof
|
|
698
|
+
* @memberof ExportDashboardDateFilterDateFilter
|
|
699
699
|
*/
|
|
700
|
-
granularity:
|
|
700
|
+
granularity: ExportDashboardDateFilterDateFilterGranularityEnum;
|
|
701
701
|
/**
|
|
702
702
|
*
|
|
703
703
|
* @type {string | number}
|
|
704
|
-
* @memberof
|
|
704
|
+
* @memberof ExportDashboardDateFilterDateFilter
|
|
705
705
|
*/
|
|
706
706
|
from?: string | number;
|
|
707
707
|
/**
|
|
708
708
|
*
|
|
709
709
|
* @type {string | number}
|
|
710
|
-
* @memberof
|
|
710
|
+
* @memberof ExportDashboardDateFilterDateFilter
|
|
711
711
|
*/
|
|
712
712
|
to?: string | number;
|
|
713
713
|
/**
|
|
714
714
|
*
|
|
715
|
-
* @type {
|
|
716
|
-
* @memberof
|
|
715
|
+
* @type {ExportIdentifierRef}
|
|
716
|
+
* @memberof ExportDashboardDateFilterDateFilter
|
|
717
717
|
*/
|
|
718
|
-
dataSet?:
|
|
718
|
+
dataSet?: ExportIdentifierRef;
|
|
719
719
|
/**
|
|
720
720
|
*
|
|
721
|
-
* @type {
|
|
722
|
-
* @memberof
|
|
721
|
+
* @type {ExportIdentifierRef}
|
|
722
|
+
* @memberof ExportDashboardDateFilterDateFilter
|
|
723
723
|
*/
|
|
724
|
-
attribute?:
|
|
724
|
+
attribute?: ExportIdentifierRef;
|
|
725
725
|
/**
|
|
726
726
|
*
|
|
727
727
|
* @type {string}
|
|
728
|
-
* @memberof
|
|
728
|
+
* @memberof ExportDashboardDateFilterDateFilter
|
|
729
729
|
*/
|
|
730
730
|
localIdentifier?: string;
|
|
731
731
|
}
|
|
732
|
-
export declare const
|
|
732
|
+
export declare const ExportDashboardDateFilterDateFilterTypeEnum: {
|
|
733
733
|
readonly RELATIVE: "relative";
|
|
734
734
|
readonly ABSOLUTE: "absolute";
|
|
735
735
|
};
|
|
736
|
-
export type
|
|
737
|
-
export declare const
|
|
736
|
+
export type ExportDashboardDateFilterDateFilterTypeEnum = typeof ExportDashboardDateFilterDateFilterTypeEnum[keyof typeof ExportDashboardDateFilterDateFilterTypeEnum];
|
|
737
|
+
export declare const ExportDashboardDateFilterDateFilterGranularityEnum: {
|
|
738
738
|
readonly ALL_TIME_GRANULARITY: "ALL_TIME_GRANULARITY";
|
|
739
739
|
readonly GDC_TIME_YEAR: "GDC.time.year";
|
|
740
740
|
readonly GDC_TIME_WEEK_US: "GDC.time.week_us";
|
|
@@ -759,168 +759,168 @@ export declare const DashboardDateFilterDateFilterGranularityEnum: {
|
|
|
759
759
|
readonly GDC_TIME_MINUTE: "GDC.time.minute";
|
|
760
760
|
readonly GDC_TIME_MINUTE_IN_HOUR: "GDC.time.minute_in_hour";
|
|
761
761
|
};
|
|
762
|
-
export type
|
|
762
|
+
export type ExportDashboardDateFilterDateFilterGranularityEnum = typeof ExportDashboardDateFilterDateFilterGranularityEnum[keyof typeof ExportDashboardDateFilterDateFilterGranularityEnum];
|
|
763
763
|
/**
|
|
764
764
|
* Additional settings.
|
|
765
765
|
* @export
|
|
766
|
-
* @interface
|
|
766
|
+
* @interface ExportDashboardExportSettings
|
|
767
767
|
*/
|
|
768
|
-
export interface
|
|
768
|
+
export interface ExportDashboardExportSettings {
|
|
769
769
|
/**
|
|
770
770
|
* If true, the export will contain the information about the exported date and dashboard filters.
|
|
771
771
|
* @type {boolean}
|
|
772
|
-
* @memberof
|
|
772
|
+
* @memberof ExportDashboardExportSettings
|
|
773
773
|
*/
|
|
774
774
|
exportInfo?: boolean;
|
|
775
775
|
/**
|
|
776
776
|
* Merge equal headers in neighbouring cells. Used for [XLSX] format only.
|
|
777
777
|
* @type {boolean}
|
|
778
|
-
* @memberof
|
|
778
|
+
* @memberof ExportDashboardExportSettings
|
|
779
779
|
*/
|
|
780
780
|
mergeHeaders?: boolean;
|
|
781
781
|
}
|
|
782
782
|
/**
|
|
783
|
-
* @type
|
|
783
|
+
* @type ExportDashboardFilter
|
|
784
784
|
* @export
|
|
785
785
|
*/
|
|
786
|
-
export type
|
|
786
|
+
export type ExportDashboardFilter = ExportDashboardAttributeFilter | ExportDashboardDateFilter;
|
|
787
787
|
/**
|
|
788
788
|
* Export request object describing the export properties for dashboard tabular exports.
|
|
789
789
|
* @export
|
|
790
|
-
* @interface
|
|
790
|
+
* @interface ExportDashboardTabularExportRequest
|
|
791
791
|
*/
|
|
792
|
-
export interface
|
|
792
|
+
export interface ExportDashboardTabularExportRequest {
|
|
793
793
|
/**
|
|
794
794
|
* Requested tabular export type.
|
|
795
795
|
* @type {string}
|
|
796
|
-
* @memberof
|
|
796
|
+
* @memberof ExportDashboardTabularExportRequest
|
|
797
797
|
*/
|
|
798
|
-
format:
|
|
798
|
+
format: ExportDashboardTabularExportRequestFormatEnum;
|
|
799
799
|
/**
|
|
800
800
|
* Filename of downloaded file without extension.
|
|
801
801
|
* @type {string}
|
|
802
|
-
* @memberof
|
|
802
|
+
* @memberof ExportDashboardTabularExportRequest
|
|
803
803
|
*/
|
|
804
804
|
fileName: string;
|
|
805
805
|
/**
|
|
806
806
|
* List of filters that will be used instead of the default dashboard filters.
|
|
807
|
-
* @type {Array<
|
|
808
|
-
* @memberof
|
|
807
|
+
* @type {Array<ExportDashboardFilter>}
|
|
808
|
+
* @memberof ExportDashboardTabularExportRequest
|
|
809
809
|
*/
|
|
810
|
-
dashboardFiltersOverride?: Array<
|
|
810
|
+
dashboardFiltersOverride?: Array<ExportDashboardFilter>;
|
|
811
811
|
/**
|
|
812
812
|
* List of widget identifiers to be exported. Note that only one widget is currently supported.
|
|
813
813
|
* @type {Array<string>}
|
|
814
|
-
* @memberof
|
|
814
|
+
* @memberof ExportDashboardTabularExportRequest
|
|
815
815
|
*/
|
|
816
816
|
widgetIds?: Array<string>;
|
|
817
817
|
/**
|
|
818
818
|
*
|
|
819
|
-
* @type {
|
|
820
|
-
* @memberof
|
|
819
|
+
* @type {ExportDashboardExportSettings}
|
|
820
|
+
* @memberof ExportDashboardTabularExportRequest
|
|
821
821
|
*/
|
|
822
|
-
settings?:
|
|
822
|
+
settings?: ExportDashboardExportSettings;
|
|
823
823
|
}
|
|
824
|
-
export declare const
|
|
824
|
+
export declare const ExportDashboardTabularExportRequestFormatEnum: {
|
|
825
825
|
readonly XLSX: "XLSX";
|
|
826
826
|
};
|
|
827
|
-
export type
|
|
827
|
+
export type ExportDashboardTabularExportRequestFormatEnum = typeof ExportDashboardTabularExportRequestFormatEnum[keyof typeof ExportDashboardTabularExportRequestFormatEnum];
|
|
828
828
|
/**
|
|
829
|
-
* @type
|
|
829
|
+
* @type ExportDateFilter
|
|
830
830
|
* Abstract filter definition type for dates.
|
|
831
831
|
* @export
|
|
832
832
|
*/
|
|
833
|
-
export type
|
|
833
|
+
export type ExportDateFilter = ExportAbsoluteDateFilter | ExportRelativeDateFilter;
|
|
834
834
|
/**
|
|
835
835
|
*
|
|
836
836
|
* @export
|
|
837
|
-
* @interface
|
|
837
|
+
* @interface ExportDateValue
|
|
838
838
|
*/
|
|
839
|
-
export interface
|
|
839
|
+
export interface ExportDateValue {
|
|
840
840
|
/**
|
|
841
841
|
*
|
|
842
842
|
* @type {string}
|
|
843
|
-
* @memberof
|
|
843
|
+
* @memberof ExportDateValue
|
|
844
844
|
*/
|
|
845
845
|
value: string;
|
|
846
846
|
}
|
|
847
847
|
/**
|
|
848
848
|
* Various settings affecting the process of AFM execution or its result
|
|
849
849
|
* @export
|
|
850
|
-
* @interface
|
|
850
|
+
* @interface ExportExecutionSettings
|
|
851
851
|
*/
|
|
852
|
-
export interface
|
|
852
|
+
export interface ExportExecutionSettings {
|
|
853
853
|
/**
|
|
854
854
|
* Specifies the percentage of rows from fact datasets to use during computation. This feature is available only for workspaces that use a Vertica Data Source without table views.
|
|
855
855
|
* @type {number}
|
|
856
|
-
* @memberof
|
|
856
|
+
* @memberof ExportExecutionSettings
|
|
857
857
|
*/
|
|
858
858
|
dataSamplingPercentage?: number;
|
|
859
859
|
/**
|
|
860
860
|
* Specifies the timestamp of the execution from which relative filters are resolved. If not set, the current time is used.
|
|
861
861
|
* @type {string}
|
|
862
|
-
* @memberof
|
|
862
|
+
* @memberof ExportExecutionSettings
|
|
863
863
|
*/
|
|
864
864
|
timestamp?: string;
|
|
865
865
|
}
|
|
866
866
|
/**
|
|
867
867
|
*
|
|
868
868
|
* @export
|
|
869
|
-
* @interface
|
|
869
|
+
* @interface ExportExportResponse
|
|
870
870
|
*/
|
|
871
|
-
export interface
|
|
871
|
+
export interface ExportExportResponse {
|
|
872
872
|
/**
|
|
873
873
|
*
|
|
874
874
|
* @type {string}
|
|
875
|
-
* @memberof
|
|
875
|
+
* @memberof ExportExportResponse
|
|
876
876
|
*/
|
|
877
877
|
exportResult: string;
|
|
878
878
|
}
|
|
879
879
|
/**
|
|
880
|
-
* @type
|
|
880
|
+
* @type ExportFilterDefinition
|
|
881
881
|
* Abstract filter definition type
|
|
882
882
|
* @export
|
|
883
883
|
*/
|
|
884
|
-
export type
|
|
884
|
+
export type ExportFilterDefinition = ExportAbsoluteDateFilter | ExportComparisonMeasureValueFilter | ExportInlineFilterDefinition | ExportNegativeAttributeFilter | ExportPositiveAttributeFilter | ExportRangeMeasureValueFilter | ExportRankingFilter | ExportRelativeDateFilter;
|
|
885
885
|
/**
|
|
886
|
-
* @type
|
|
886
|
+
* @type ExportFilterDefinitionForSimpleMeasure
|
|
887
887
|
* Abstract filter definition type for simple metric.
|
|
888
888
|
* @export
|
|
889
889
|
*/
|
|
890
|
-
export type
|
|
890
|
+
export type ExportFilterDefinitionForSimpleMeasure = ExportAttributeFilter | ExportDateFilter;
|
|
891
891
|
/**
|
|
892
892
|
*
|
|
893
893
|
* @export
|
|
894
|
-
* @interface
|
|
894
|
+
* @interface ExportIdentifierRef
|
|
895
895
|
*/
|
|
896
|
-
export interface
|
|
896
|
+
export interface ExportIdentifierRef {
|
|
897
897
|
/**
|
|
898
898
|
*
|
|
899
|
-
* @type {
|
|
900
|
-
* @memberof
|
|
899
|
+
* @type {ExportIdentifierRefIdentifier}
|
|
900
|
+
* @memberof ExportIdentifierRef
|
|
901
901
|
*/
|
|
902
|
-
identifier?:
|
|
902
|
+
identifier?: ExportIdentifierRefIdentifier;
|
|
903
903
|
}
|
|
904
904
|
/**
|
|
905
905
|
*
|
|
906
906
|
* @export
|
|
907
|
-
* @interface
|
|
907
|
+
* @interface ExportIdentifierRefIdentifier
|
|
908
908
|
*/
|
|
909
|
-
export interface
|
|
909
|
+
export interface ExportIdentifierRefIdentifier {
|
|
910
910
|
/**
|
|
911
911
|
*
|
|
912
912
|
* @type {string}
|
|
913
|
-
* @memberof
|
|
913
|
+
* @memberof ExportIdentifierRefIdentifier
|
|
914
914
|
*/
|
|
915
915
|
id: string;
|
|
916
916
|
/**
|
|
917
917
|
*
|
|
918
918
|
* @type {string}
|
|
919
|
-
* @memberof
|
|
919
|
+
* @memberof ExportIdentifierRefIdentifier
|
|
920
920
|
*/
|
|
921
|
-
type:
|
|
921
|
+
type: ExportIdentifierRefIdentifierTypeEnum;
|
|
922
922
|
}
|
|
923
|
-
export declare const
|
|
923
|
+
export declare const ExportIdentifierRefIdentifierTypeEnum: {
|
|
924
924
|
readonly ANALYTICAL_DASHBOARD: "analyticalDashboard";
|
|
925
925
|
readonly ATTRIBUTE: "attribute";
|
|
926
926
|
readonly ATTRIBUTE_HIERARCHY: "attributeHierarchy";
|
|
@@ -941,727 +941,727 @@ export declare const IdentifierRefIdentifierTypeEnum: {
|
|
|
941
941
|
readonly WORKSPACE_DATA_FILTER_SETTING: "workspaceDataFilterSetting";
|
|
942
942
|
readonly FILTER_VIEW: "filterView";
|
|
943
943
|
};
|
|
944
|
-
export type
|
|
944
|
+
export type ExportIdentifierRefIdentifierTypeEnum = typeof ExportIdentifierRefIdentifierTypeEnum[keyof typeof ExportIdentifierRefIdentifierTypeEnum];
|
|
945
945
|
/**
|
|
946
946
|
* Export request object describing the export properties and metadata for image exports.
|
|
947
947
|
* @export
|
|
948
|
-
* @interface
|
|
948
|
+
* @interface ExportImageExportRequest
|
|
949
949
|
*/
|
|
950
|
-
export interface
|
|
950
|
+
export interface ExportImageExportRequest {
|
|
951
951
|
/**
|
|
952
952
|
* Requested resulting file type.
|
|
953
953
|
* @type {string}
|
|
954
|
-
* @memberof
|
|
954
|
+
* @memberof ExportImageExportRequest
|
|
955
955
|
*/
|
|
956
|
-
format:
|
|
956
|
+
format: ExportImageExportRequestFormatEnum;
|
|
957
957
|
/**
|
|
958
958
|
* File name to be used for retrieving the image document.
|
|
959
959
|
* @type {string}
|
|
960
|
-
* @memberof
|
|
960
|
+
* @memberof ExportImageExportRequest
|
|
961
961
|
*/
|
|
962
962
|
fileName: string;
|
|
963
963
|
/**
|
|
964
964
|
* Dashboard identifier
|
|
965
965
|
* @type {string}
|
|
966
|
-
* @memberof
|
|
966
|
+
* @memberof ExportImageExportRequest
|
|
967
967
|
*/
|
|
968
968
|
dashboardId: string;
|
|
969
969
|
/**
|
|
970
970
|
* List of widget identifiers to be exported. Note that only one widget is currently supported.
|
|
971
971
|
* @type {Array<string>}
|
|
972
|
-
* @memberof
|
|
972
|
+
* @memberof ExportImageExportRequest
|
|
973
973
|
*/
|
|
974
974
|
widgetIds: Array<string>;
|
|
975
975
|
/**
|
|
976
976
|
* Metadata definition in free-form JSON format.
|
|
977
977
|
* @type {object}
|
|
978
|
-
* @memberof
|
|
978
|
+
* @memberof ExportImageExportRequest
|
|
979
979
|
*/
|
|
980
980
|
metadata?: object | null;
|
|
981
981
|
}
|
|
982
|
-
export declare const
|
|
982
|
+
export declare const ExportImageExportRequestFormatEnum: {
|
|
983
983
|
readonly PNG: "PNG";
|
|
984
984
|
};
|
|
985
|
-
export type
|
|
985
|
+
export type ExportImageExportRequestFormatEnum = typeof ExportImageExportRequestFormatEnum[keyof typeof ExportImageExportRequestFormatEnum];
|
|
986
986
|
/**
|
|
987
987
|
* Filter in form of direct MAQL query.
|
|
988
988
|
* @export
|
|
989
|
-
* @interface
|
|
989
|
+
* @interface ExportInlineFilterDefinition
|
|
990
990
|
*/
|
|
991
|
-
export interface
|
|
991
|
+
export interface ExportInlineFilterDefinition {
|
|
992
992
|
/**
|
|
993
993
|
*
|
|
994
|
-
* @type {
|
|
995
|
-
* @memberof
|
|
994
|
+
* @type {ExportInlineFilterDefinitionInline}
|
|
995
|
+
* @memberof ExportInlineFilterDefinition
|
|
996
996
|
*/
|
|
997
|
-
inline:
|
|
997
|
+
inline: ExportInlineFilterDefinitionInline;
|
|
998
998
|
}
|
|
999
999
|
/**
|
|
1000
1000
|
*
|
|
1001
1001
|
* @export
|
|
1002
|
-
* @interface
|
|
1002
|
+
* @interface ExportInlineFilterDefinitionInline
|
|
1003
1003
|
*/
|
|
1004
|
-
export interface
|
|
1004
|
+
export interface ExportInlineFilterDefinitionInline {
|
|
1005
1005
|
/**
|
|
1006
1006
|
* MAQL query representing the filter.
|
|
1007
1007
|
* @type {string}
|
|
1008
|
-
* @memberof
|
|
1008
|
+
* @memberof ExportInlineFilterDefinitionInline
|
|
1009
1009
|
*/
|
|
1010
1010
|
filter: string;
|
|
1011
1011
|
/**
|
|
1012
1012
|
*
|
|
1013
1013
|
* @type {string}
|
|
1014
|
-
* @memberof
|
|
1014
|
+
* @memberof ExportInlineFilterDefinitionInline
|
|
1015
1015
|
*/
|
|
1016
1016
|
localIdentifier?: string;
|
|
1017
1017
|
/**
|
|
1018
1018
|
*
|
|
1019
1019
|
* @type {boolean}
|
|
1020
|
-
* @memberof
|
|
1020
|
+
* @memberof ExportInlineFilterDefinitionInline
|
|
1021
1021
|
*/
|
|
1022
1022
|
applyOnResult?: boolean;
|
|
1023
1023
|
}
|
|
1024
1024
|
/**
|
|
1025
1025
|
* Metric defined by the raw MAQL query.
|
|
1026
1026
|
* @export
|
|
1027
|
-
* @interface
|
|
1027
|
+
* @interface ExportInlineMeasureDefinition
|
|
1028
1028
|
*/
|
|
1029
|
-
export interface
|
|
1029
|
+
export interface ExportInlineMeasureDefinition {
|
|
1030
1030
|
/**
|
|
1031
1031
|
*
|
|
1032
|
-
* @type {
|
|
1033
|
-
* @memberof
|
|
1032
|
+
* @type {ExportInlineMeasureDefinitionInline}
|
|
1033
|
+
* @memberof ExportInlineMeasureDefinition
|
|
1034
1034
|
*/
|
|
1035
|
-
inline:
|
|
1035
|
+
inline: ExportInlineMeasureDefinitionInline;
|
|
1036
1036
|
}
|
|
1037
1037
|
/**
|
|
1038
1038
|
*
|
|
1039
1039
|
* @export
|
|
1040
|
-
* @interface
|
|
1040
|
+
* @interface ExportInlineMeasureDefinitionInline
|
|
1041
1041
|
*/
|
|
1042
|
-
export interface
|
|
1042
|
+
export interface ExportInlineMeasureDefinitionInline {
|
|
1043
1043
|
/**
|
|
1044
1044
|
* MAQL query defining the metric.
|
|
1045
1045
|
* @type {string}
|
|
1046
|
-
* @memberof
|
|
1046
|
+
* @memberof ExportInlineMeasureDefinitionInline
|
|
1047
1047
|
*/
|
|
1048
1048
|
maql: string;
|
|
1049
1049
|
}
|
|
1050
1050
|
/**
|
|
1051
1051
|
*
|
|
1052
1052
|
* @export
|
|
1053
|
-
* @interface
|
|
1053
|
+
* @interface ExportInlineResponse202
|
|
1054
1054
|
*/
|
|
1055
|
-
export interface
|
|
1055
|
+
export interface ExportInlineResponse202 {
|
|
1056
1056
|
/**
|
|
1057
1057
|
*
|
|
1058
1058
|
* @type {number}
|
|
1059
|
-
* @memberof
|
|
1059
|
+
* @memberof ExportInlineResponse202
|
|
1060
1060
|
*/
|
|
1061
1061
|
short?: number;
|
|
1062
1062
|
/**
|
|
1063
1063
|
*
|
|
1064
1064
|
* @type {string}
|
|
1065
|
-
* @memberof
|
|
1065
|
+
* @memberof ExportInlineResponse202
|
|
1066
1066
|
*/
|
|
1067
1067
|
char?: string;
|
|
1068
1068
|
/**
|
|
1069
1069
|
*
|
|
1070
1070
|
* @type {number}
|
|
1071
|
-
* @memberof
|
|
1071
|
+
* @memberof ExportInlineResponse202
|
|
1072
1072
|
*/
|
|
1073
1073
|
int?: number;
|
|
1074
1074
|
/**
|
|
1075
1075
|
*
|
|
1076
1076
|
* @type {number}
|
|
1077
|
-
* @memberof
|
|
1077
|
+
* @memberof ExportInlineResponse202
|
|
1078
1078
|
*/
|
|
1079
1079
|
long?: number;
|
|
1080
1080
|
/**
|
|
1081
1081
|
*
|
|
1082
1082
|
* @type {number}
|
|
1083
|
-
* @memberof
|
|
1083
|
+
* @memberof ExportInlineResponse202
|
|
1084
1084
|
*/
|
|
1085
1085
|
float?: number;
|
|
1086
1086
|
/**
|
|
1087
1087
|
*
|
|
1088
1088
|
* @type {number}
|
|
1089
|
-
* @memberof
|
|
1089
|
+
* @memberof ExportInlineResponse202
|
|
1090
1090
|
*/
|
|
1091
1091
|
double?: number;
|
|
1092
1092
|
/**
|
|
1093
1093
|
*
|
|
1094
1094
|
* @type {boolean}
|
|
1095
|
-
* @memberof
|
|
1095
|
+
* @memberof ExportInlineResponse202
|
|
1096
1096
|
*/
|
|
1097
1097
|
direct?: boolean;
|
|
1098
1098
|
/**
|
|
1099
1099
|
*
|
|
1100
1100
|
* @type {boolean}
|
|
1101
|
-
* @memberof
|
|
1101
|
+
* @memberof ExportInlineResponse202
|
|
1102
1102
|
*/
|
|
1103
1103
|
readOnly?: boolean;
|
|
1104
1104
|
}
|
|
1105
1105
|
/**
|
|
1106
|
-
* @type
|
|
1106
|
+
* @type ExportMeasureDefinition
|
|
1107
1107
|
* Abstract metric definition type
|
|
1108
1108
|
* @export
|
|
1109
1109
|
*/
|
|
1110
|
-
export type
|
|
1110
|
+
export type ExportMeasureDefinition = ExportArithmeticMeasureDefinition | ExportInlineMeasureDefinition | ExportPopMeasureDefinition | ExportSimpleMeasureDefinition;
|
|
1111
1111
|
/**
|
|
1112
1112
|
* Metric is a quantity that is calculated from the data.
|
|
1113
1113
|
* @export
|
|
1114
|
-
* @interface
|
|
1114
|
+
* @interface ExportMeasureItem
|
|
1115
1115
|
*/
|
|
1116
|
-
export interface
|
|
1116
|
+
export interface ExportMeasureItem {
|
|
1117
1117
|
/**
|
|
1118
1118
|
* Local identifier of the metric. This can be used to reference the metric in other parts of the execution definition.
|
|
1119
1119
|
* @type {string}
|
|
1120
|
-
* @memberof
|
|
1120
|
+
* @memberof ExportMeasureItem
|
|
1121
1121
|
*/
|
|
1122
1122
|
localIdentifier: string;
|
|
1123
1123
|
/**
|
|
1124
1124
|
*
|
|
1125
|
-
* @type {
|
|
1126
|
-
* @memberof
|
|
1125
|
+
* @type {ExportMeasureDefinition}
|
|
1126
|
+
* @memberof ExportMeasureItem
|
|
1127
1127
|
*/
|
|
1128
|
-
definition:
|
|
1128
|
+
definition: ExportMeasureDefinition;
|
|
1129
1129
|
}
|
|
1130
1130
|
/**
|
|
1131
|
-
* @type
|
|
1131
|
+
* @type ExportMeasureValueFilter
|
|
1132
1132
|
* Abstract filter definition type filtering by the value of the metric.
|
|
1133
1133
|
* @export
|
|
1134
1134
|
*/
|
|
1135
|
-
export type
|
|
1135
|
+
export type ExportMeasureValueFilter = ExportComparisonMeasureValueFilter | ExportRangeMeasureValueFilter;
|
|
1136
1136
|
/**
|
|
1137
1137
|
* Filter able to limit element values by label and related selected negated elements.
|
|
1138
1138
|
* @export
|
|
1139
|
-
* @interface
|
|
1139
|
+
* @interface ExportNegativeAttributeFilter
|
|
1140
1140
|
*/
|
|
1141
|
-
export interface
|
|
1141
|
+
export interface ExportNegativeAttributeFilter {
|
|
1142
1142
|
/**
|
|
1143
1143
|
*
|
|
1144
|
-
* @type {
|
|
1145
|
-
* @memberof
|
|
1144
|
+
* @type {ExportNegativeAttributeFilterNegativeAttributeFilter}
|
|
1145
|
+
* @memberof ExportNegativeAttributeFilter
|
|
1146
1146
|
*/
|
|
1147
|
-
negativeAttributeFilter:
|
|
1147
|
+
negativeAttributeFilter: ExportNegativeAttributeFilterNegativeAttributeFilter;
|
|
1148
1148
|
}
|
|
1149
1149
|
/**
|
|
1150
1150
|
*
|
|
1151
1151
|
* @export
|
|
1152
|
-
* @interface
|
|
1152
|
+
* @interface ExportNegativeAttributeFilterNegativeAttributeFilter
|
|
1153
1153
|
*/
|
|
1154
|
-
export interface
|
|
1154
|
+
export interface ExportNegativeAttributeFilterNegativeAttributeFilter {
|
|
1155
1155
|
/**
|
|
1156
1156
|
*
|
|
1157
|
-
* @type {
|
|
1158
|
-
* @memberof
|
|
1157
|
+
* @type {ExportAttributeFilterElements}
|
|
1158
|
+
* @memberof ExportNegativeAttributeFilterNegativeAttributeFilter
|
|
1159
1159
|
*/
|
|
1160
|
-
notIn:
|
|
1160
|
+
notIn: ExportAttributeFilterElements;
|
|
1161
1161
|
/**
|
|
1162
1162
|
*
|
|
1163
1163
|
* @type {string}
|
|
1164
|
-
* @memberof
|
|
1164
|
+
* @memberof ExportNegativeAttributeFilterNegativeAttributeFilter
|
|
1165
1165
|
*/
|
|
1166
1166
|
localIdentifier?: string;
|
|
1167
1167
|
/**
|
|
1168
1168
|
*
|
|
1169
1169
|
* @type {boolean}
|
|
1170
|
-
* @memberof
|
|
1170
|
+
* @memberof ExportNegativeAttributeFilterNegativeAttributeFilter
|
|
1171
1171
|
*/
|
|
1172
1172
|
applyOnResult?: boolean;
|
|
1173
1173
|
/**
|
|
1174
1174
|
*
|
|
1175
|
-
* @type {
|
|
1176
|
-
* @memberof
|
|
1175
|
+
* @type {ExportAfmIdentifier}
|
|
1176
|
+
* @memberof ExportNegativeAttributeFilterNegativeAttributeFilter
|
|
1177
1177
|
*/
|
|
1178
|
-
label:
|
|
1178
|
+
label: ExportAfmIdentifier;
|
|
1179
1179
|
}
|
|
1180
1180
|
/**
|
|
1181
1181
|
*
|
|
1182
1182
|
* @export
|
|
1183
|
-
* @interface
|
|
1183
|
+
* @interface ExportOver
|
|
1184
1184
|
*/
|
|
1185
|
-
export interface
|
|
1185
|
+
export interface ExportOver {
|
|
1186
1186
|
/**
|
|
1187
1187
|
*
|
|
1188
|
-
* @type {Array<
|
|
1189
|
-
* @memberof
|
|
1188
|
+
* @type {Array<ExportIdentifierRef>}
|
|
1189
|
+
* @memberof ExportOver
|
|
1190
1190
|
*/
|
|
1191
|
-
attributes: Array<
|
|
1191
|
+
attributes: Array<ExportIdentifierRef>;
|
|
1192
1192
|
}
|
|
1193
1193
|
/**
|
|
1194
1194
|
* Custom CSS styles for the table. (PDF, HTML)
|
|
1195
1195
|
* @export
|
|
1196
|
-
* @interface
|
|
1196
|
+
* @interface ExportPdfTableStyle
|
|
1197
1197
|
*/
|
|
1198
|
-
export interface
|
|
1198
|
+
export interface ExportPdfTableStyle {
|
|
1199
1199
|
/**
|
|
1200
1200
|
* CSS selector where to apply given properties.
|
|
1201
1201
|
* @type {string}
|
|
1202
|
-
* @memberof
|
|
1202
|
+
* @memberof ExportPdfTableStyle
|
|
1203
1203
|
*/
|
|
1204
1204
|
selector: string;
|
|
1205
1205
|
/**
|
|
1206
1206
|
* List of CSS properties.
|
|
1207
|
-
* @type {Array<
|
|
1208
|
-
* @memberof
|
|
1207
|
+
* @type {Array<ExportPdfTableStyleProperty>}
|
|
1208
|
+
* @memberof ExportPdfTableStyle
|
|
1209
1209
|
*/
|
|
1210
|
-
properties?: Array<
|
|
1210
|
+
properties?: Array<ExportPdfTableStyleProperty>;
|
|
1211
1211
|
}
|
|
1212
1212
|
/**
|
|
1213
1213
|
* CSS property.
|
|
1214
1214
|
* @export
|
|
1215
|
-
* @interface
|
|
1215
|
+
* @interface ExportPdfTableStyleProperty
|
|
1216
1216
|
*/
|
|
1217
|
-
export interface
|
|
1217
|
+
export interface ExportPdfTableStyleProperty {
|
|
1218
1218
|
/**
|
|
1219
1219
|
* CSS property key.
|
|
1220
1220
|
* @type {string}
|
|
1221
|
-
* @memberof
|
|
1221
|
+
* @memberof ExportPdfTableStyleProperty
|
|
1222
1222
|
*/
|
|
1223
1223
|
key: string;
|
|
1224
1224
|
/**
|
|
1225
1225
|
* CSS property value.
|
|
1226
1226
|
* @type {string}
|
|
1227
|
-
* @memberof
|
|
1227
|
+
* @memberof ExportPdfTableStyleProperty
|
|
1228
1228
|
*/
|
|
1229
1229
|
value: string;
|
|
1230
1230
|
}
|
|
1231
1231
|
/**
|
|
1232
1232
|
* Combination of the date data set to use and how many periods ago to calculate the previous period for.
|
|
1233
1233
|
* @export
|
|
1234
|
-
* @interface
|
|
1234
|
+
* @interface ExportPopDataset
|
|
1235
1235
|
*/
|
|
1236
|
-
export interface
|
|
1236
|
+
export interface ExportPopDataset {
|
|
1237
1237
|
/**
|
|
1238
1238
|
*
|
|
1239
|
-
* @type {
|
|
1240
|
-
* @memberof
|
|
1239
|
+
* @type {ExportAfmObjectIdentifierDataset}
|
|
1240
|
+
* @memberof ExportPopDataset
|
|
1241
1241
|
*/
|
|
1242
|
-
dataset:
|
|
1242
|
+
dataset: ExportAfmObjectIdentifierDataset;
|
|
1243
1243
|
/**
|
|
1244
1244
|
* Number of periods ago to calculate the previous period for.
|
|
1245
1245
|
* @type {number}
|
|
1246
|
-
* @memberof
|
|
1246
|
+
* @memberof ExportPopDataset
|
|
1247
1247
|
*/
|
|
1248
1248
|
periodsAgo: number;
|
|
1249
1249
|
}
|
|
1250
1250
|
/**
|
|
1251
1251
|
* Previous period type of metric.
|
|
1252
1252
|
* @export
|
|
1253
|
-
* @interface
|
|
1253
|
+
* @interface ExportPopDatasetMeasureDefinition
|
|
1254
1254
|
*/
|
|
1255
|
-
export interface
|
|
1255
|
+
export interface ExportPopDatasetMeasureDefinition {
|
|
1256
1256
|
/**
|
|
1257
1257
|
*
|
|
1258
|
-
* @type {
|
|
1259
|
-
* @memberof
|
|
1258
|
+
* @type {ExportPopDatasetMeasureDefinitionPreviousPeriodMeasure}
|
|
1259
|
+
* @memberof ExportPopDatasetMeasureDefinition
|
|
1260
1260
|
*/
|
|
1261
|
-
previousPeriodMeasure:
|
|
1261
|
+
previousPeriodMeasure: ExportPopDatasetMeasureDefinitionPreviousPeriodMeasure;
|
|
1262
1262
|
}
|
|
1263
1263
|
/**
|
|
1264
1264
|
*
|
|
1265
1265
|
* @export
|
|
1266
|
-
* @interface
|
|
1266
|
+
* @interface ExportPopDatasetMeasureDefinitionPreviousPeriodMeasure
|
|
1267
1267
|
*/
|
|
1268
|
-
export interface
|
|
1268
|
+
export interface ExportPopDatasetMeasureDefinitionPreviousPeriodMeasure {
|
|
1269
1269
|
/**
|
|
1270
1270
|
*
|
|
1271
|
-
* @type {
|
|
1272
|
-
* @memberof
|
|
1271
|
+
* @type {ExportAfmLocalIdentifier}
|
|
1272
|
+
* @memberof ExportPopDatasetMeasureDefinitionPreviousPeriodMeasure
|
|
1273
1273
|
*/
|
|
1274
|
-
measureIdentifier:
|
|
1274
|
+
measureIdentifier: ExportAfmLocalIdentifier;
|
|
1275
1275
|
/**
|
|
1276
1276
|
* Specification of which date data sets to use for determining the period to calculate the previous period for.
|
|
1277
|
-
* @type {Array<
|
|
1278
|
-
* @memberof
|
|
1277
|
+
* @type {Array<ExportPopDataset>}
|
|
1278
|
+
* @memberof ExportPopDatasetMeasureDefinitionPreviousPeriodMeasure
|
|
1279
1279
|
*/
|
|
1280
|
-
dateDatasets: Array<
|
|
1280
|
+
dateDatasets: Array<ExportPopDataset>;
|
|
1281
1281
|
}
|
|
1282
1282
|
/**
|
|
1283
1283
|
* Combination of the date attribute to use and how many periods ago to calculate the PoP for.
|
|
1284
1284
|
* @export
|
|
1285
|
-
* @interface
|
|
1285
|
+
* @interface ExportPopDate
|
|
1286
1286
|
*/
|
|
1287
|
-
export interface
|
|
1287
|
+
export interface ExportPopDate {
|
|
1288
1288
|
/**
|
|
1289
1289
|
*
|
|
1290
|
-
* @type {
|
|
1291
|
-
* @memberof
|
|
1290
|
+
* @type {ExportAfmObjectIdentifierAttribute}
|
|
1291
|
+
* @memberof ExportPopDate
|
|
1292
1292
|
*/
|
|
1293
|
-
attribute:
|
|
1293
|
+
attribute: ExportAfmObjectIdentifierAttribute;
|
|
1294
1294
|
/**
|
|
1295
1295
|
* Number of periods ago to calculate the previous period for.
|
|
1296
1296
|
* @type {number}
|
|
1297
|
-
* @memberof
|
|
1297
|
+
* @memberof ExportPopDate
|
|
1298
1298
|
*/
|
|
1299
1299
|
periodsAgo: number;
|
|
1300
1300
|
}
|
|
1301
1301
|
/**
|
|
1302
1302
|
* Period over period type of metric.
|
|
1303
1303
|
* @export
|
|
1304
|
-
* @interface
|
|
1304
|
+
* @interface ExportPopDateMeasureDefinition
|
|
1305
1305
|
*/
|
|
1306
|
-
export interface
|
|
1306
|
+
export interface ExportPopDateMeasureDefinition {
|
|
1307
1307
|
/**
|
|
1308
1308
|
*
|
|
1309
|
-
* @type {
|
|
1310
|
-
* @memberof
|
|
1309
|
+
* @type {ExportPopDateMeasureDefinitionOverPeriodMeasure}
|
|
1310
|
+
* @memberof ExportPopDateMeasureDefinition
|
|
1311
1311
|
*/
|
|
1312
|
-
overPeriodMeasure:
|
|
1312
|
+
overPeriodMeasure: ExportPopDateMeasureDefinitionOverPeriodMeasure;
|
|
1313
1313
|
}
|
|
1314
1314
|
/**
|
|
1315
1315
|
*
|
|
1316
1316
|
* @export
|
|
1317
|
-
* @interface
|
|
1317
|
+
* @interface ExportPopDateMeasureDefinitionOverPeriodMeasure
|
|
1318
1318
|
*/
|
|
1319
|
-
export interface
|
|
1319
|
+
export interface ExportPopDateMeasureDefinitionOverPeriodMeasure {
|
|
1320
1320
|
/**
|
|
1321
1321
|
*
|
|
1322
|
-
* @type {
|
|
1323
|
-
* @memberof
|
|
1322
|
+
* @type {ExportAfmLocalIdentifier}
|
|
1323
|
+
* @memberof ExportPopDateMeasureDefinitionOverPeriodMeasure
|
|
1324
1324
|
*/
|
|
1325
|
-
measureIdentifier:
|
|
1325
|
+
measureIdentifier: ExportAfmLocalIdentifier;
|
|
1326
1326
|
/**
|
|
1327
1327
|
* Attributes to use for determining the period to calculate the PoP for.
|
|
1328
|
-
* @type {Array<
|
|
1329
|
-
* @memberof
|
|
1328
|
+
* @type {Array<ExportPopDate>}
|
|
1329
|
+
* @memberof ExportPopDateMeasureDefinitionOverPeriodMeasure
|
|
1330
1330
|
*/
|
|
1331
|
-
dateAttributes: Array<
|
|
1331
|
+
dateAttributes: Array<ExportPopDate>;
|
|
1332
1332
|
}
|
|
1333
1333
|
/**
|
|
1334
|
-
* @type
|
|
1334
|
+
* @type ExportPopMeasureDefinition
|
|
1335
1335
|
* @export
|
|
1336
1336
|
*/
|
|
1337
|
-
export type
|
|
1337
|
+
export type ExportPopMeasureDefinition = ExportPopDatasetMeasureDefinition | ExportPopDateMeasureDefinition;
|
|
1338
1338
|
/**
|
|
1339
1339
|
* Filter able to limit element values by label and related selected elements.
|
|
1340
1340
|
* @export
|
|
1341
|
-
* @interface
|
|
1341
|
+
* @interface ExportPositiveAttributeFilter
|
|
1342
1342
|
*/
|
|
1343
|
-
export interface
|
|
1343
|
+
export interface ExportPositiveAttributeFilter {
|
|
1344
1344
|
/**
|
|
1345
1345
|
*
|
|
1346
|
-
* @type {
|
|
1347
|
-
* @memberof
|
|
1346
|
+
* @type {ExportPositiveAttributeFilterPositiveAttributeFilter}
|
|
1347
|
+
* @memberof ExportPositiveAttributeFilter
|
|
1348
1348
|
*/
|
|
1349
|
-
positiveAttributeFilter:
|
|
1349
|
+
positiveAttributeFilter: ExportPositiveAttributeFilterPositiveAttributeFilter;
|
|
1350
1350
|
}
|
|
1351
1351
|
/**
|
|
1352
1352
|
*
|
|
1353
1353
|
* @export
|
|
1354
|
-
* @interface
|
|
1354
|
+
* @interface ExportPositiveAttributeFilterPositiveAttributeFilter
|
|
1355
1355
|
*/
|
|
1356
|
-
export interface
|
|
1356
|
+
export interface ExportPositiveAttributeFilterPositiveAttributeFilter {
|
|
1357
1357
|
/**
|
|
1358
1358
|
*
|
|
1359
|
-
* @type {
|
|
1360
|
-
* @memberof
|
|
1359
|
+
* @type {ExportAttributeFilterElements}
|
|
1360
|
+
* @memberof ExportPositiveAttributeFilterPositiveAttributeFilter
|
|
1361
1361
|
*/
|
|
1362
|
-
in:
|
|
1362
|
+
in: ExportAttributeFilterElements;
|
|
1363
1363
|
/**
|
|
1364
1364
|
*
|
|
1365
1365
|
* @type {string}
|
|
1366
|
-
* @memberof
|
|
1366
|
+
* @memberof ExportPositiveAttributeFilterPositiveAttributeFilter
|
|
1367
1367
|
*/
|
|
1368
1368
|
localIdentifier?: string;
|
|
1369
1369
|
/**
|
|
1370
1370
|
*
|
|
1371
1371
|
* @type {boolean}
|
|
1372
|
-
* @memberof
|
|
1372
|
+
* @memberof ExportPositiveAttributeFilterPositiveAttributeFilter
|
|
1373
1373
|
*/
|
|
1374
1374
|
applyOnResult?: boolean;
|
|
1375
1375
|
/**
|
|
1376
1376
|
*
|
|
1377
|
-
* @type {
|
|
1378
|
-
* @memberof
|
|
1377
|
+
* @type {ExportAfmIdentifier}
|
|
1378
|
+
* @memberof ExportPositiveAttributeFilterPositiveAttributeFilter
|
|
1379
1379
|
*/
|
|
1380
|
-
label:
|
|
1380
|
+
label: ExportAfmIdentifier;
|
|
1381
1381
|
}
|
|
1382
1382
|
/**
|
|
1383
1383
|
* Filter the result by comparing specified metric to given range of values.
|
|
1384
1384
|
* @export
|
|
1385
|
-
* @interface
|
|
1385
|
+
* @interface ExportRangeMeasureValueFilter
|
|
1386
1386
|
*/
|
|
1387
|
-
export interface
|
|
1387
|
+
export interface ExportRangeMeasureValueFilter {
|
|
1388
1388
|
/**
|
|
1389
1389
|
*
|
|
1390
|
-
* @type {
|
|
1391
|
-
* @memberof
|
|
1390
|
+
* @type {ExportRangeMeasureValueFilterRangeMeasureValueFilter}
|
|
1391
|
+
* @memberof ExportRangeMeasureValueFilter
|
|
1392
1392
|
*/
|
|
1393
|
-
rangeMeasureValueFilter:
|
|
1393
|
+
rangeMeasureValueFilter: ExportRangeMeasureValueFilterRangeMeasureValueFilter;
|
|
1394
1394
|
}
|
|
1395
1395
|
/**
|
|
1396
1396
|
*
|
|
1397
1397
|
* @export
|
|
1398
|
-
* @interface
|
|
1398
|
+
* @interface ExportRangeMeasureValueFilterRangeMeasureValueFilter
|
|
1399
1399
|
*/
|
|
1400
|
-
export interface
|
|
1400
|
+
export interface ExportRangeMeasureValueFilterRangeMeasureValueFilter {
|
|
1401
1401
|
/**
|
|
1402
1402
|
* References to the attributes to be used when filtering.
|
|
1403
|
-
* @type {Array<
|
|
1404
|
-
* @memberof
|
|
1403
|
+
* @type {Array<ExportAfmIdentifier>}
|
|
1404
|
+
* @memberof ExportRangeMeasureValueFilterRangeMeasureValueFilter
|
|
1405
1405
|
*/
|
|
1406
|
-
dimensionality?: Array<
|
|
1406
|
+
dimensionality?: Array<ExportAfmIdentifier>;
|
|
1407
1407
|
/**
|
|
1408
1408
|
* A value that will be substituted for null values in the metric for the comparisons.
|
|
1409
1409
|
* @type {number}
|
|
1410
|
-
* @memberof
|
|
1410
|
+
* @memberof ExportRangeMeasureValueFilterRangeMeasureValueFilter
|
|
1411
1411
|
*/
|
|
1412
1412
|
treatNullValuesAs?: number;
|
|
1413
1413
|
/**
|
|
1414
1414
|
*
|
|
1415
1415
|
* @type {string}
|
|
1416
|
-
* @memberof
|
|
1416
|
+
* @memberof ExportRangeMeasureValueFilterRangeMeasureValueFilter
|
|
1417
1417
|
*/
|
|
1418
|
-
operator:
|
|
1418
|
+
operator: ExportRangeMeasureValueFilterRangeMeasureValueFilterOperatorEnum;
|
|
1419
1419
|
/**
|
|
1420
1420
|
*
|
|
1421
1421
|
* @type {number}
|
|
1422
|
-
* @memberof
|
|
1422
|
+
* @memberof ExportRangeMeasureValueFilterRangeMeasureValueFilter
|
|
1423
1423
|
*/
|
|
1424
1424
|
from: number;
|
|
1425
1425
|
/**
|
|
1426
1426
|
*
|
|
1427
1427
|
* @type {number}
|
|
1428
|
-
* @memberof
|
|
1428
|
+
* @memberof ExportRangeMeasureValueFilterRangeMeasureValueFilter
|
|
1429
1429
|
*/
|
|
1430
1430
|
to: number;
|
|
1431
1431
|
/**
|
|
1432
1432
|
*
|
|
1433
1433
|
* @type {string}
|
|
1434
|
-
* @memberof
|
|
1434
|
+
* @memberof ExportRangeMeasureValueFilterRangeMeasureValueFilter
|
|
1435
1435
|
*/
|
|
1436
1436
|
localIdentifier?: string;
|
|
1437
1437
|
/**
|
|
1438
1438
|
*
|
|
1439
1439
|
* @type {boolean}
|
|
1440
|
-
* @memberof
|
|
1440
|
+
* @memberof ExportRangeMeasureValueFilterRangeMeasureValueFilter
|
|
1441
1441
|
*/
|
|
1442
1442
|
applyOnResult?: boolean;
|
|
1443
1443
|
/**
|
|
1444
1444
|
*
|
|
1445
|
-
* @type {
|
|
1446
|
-
* @memberof
|
|
1445
|
+
* @type {ExportAfmIdentifier}
|
|
1446
|
+
* @memberof ExportRangeMeasureValueFilterRangeMeasureValueFilter
|
|
1447
1447
|
*/
|
|
1448
|
-
measure:
|
|
1448
|
+
measure: ExportAfmIdentifier;
|
|
1449
1449
|
}
|
|
1450
|
-
export declare const
|
|
1450
|
+
export declare const ExportRangeMeasureValueFilterRangeMeasureValueFilterOperatorEnum: {
|
|
1451
1451
|
readonly BETWEEN: "BETWEEN";
|
|
1452
1452
|
readonly NOT_BETWEEN: "NOT_BETWEEN";
|
|
1453
1453
|
};
|
|
1454
|
-
export type
|
|
1454
|
+
export type ExportRangeMeasureValueFilterRangeMeasureValueFilterOperatorEnum = typeof ExportRangeMeasureValueFilterRangeMeasureValueFilterOperatorEnum[keyof typeof ExportRangeMeasureValueFilterRangeMeasureValueFilterOperatorEnum];
|
|
1455
1455
|
/**
|
|
1456
1456
|
* Filter the result on top/bottom N values according to given metric(s).
|
|
1457
1457
|
* @export
|
|
1458
|
-
* @interface
|
|
1458
|
+
* @interface ExportRankingFilter
|
|
1459
1459
|
*/
|
|
1460
|
-
export interface
|
|
1460
|
+
export interface ExportRankingFilter {
|
|
1461
1461
|
/**
|
|
1462
1462
|
*
|
|
1463
|
-
* @type {
|
|
1464
|
-
* @memberof
|
|
1463
|
+
* @type {ExportRankingFilterRankingFilter}
|
|
1464
|
+
* @memberof ExportRankingFilter
|
|
1465
1465
|
*/
|
|
1466
|
-
rankingFilter:
|
|
1466
|
+
rankingFilter: ExportRankingFilterRankingFilter;
|
|
1467
1467
|
}
|
|
1468
1468
|
/**
|
|
1469
1469
|
*
|
|
1470
1470
|
* @export
|
|
1471
|
-
* @interface
|
|
1471
|
+
* @interface ExportRankingFilterRankingFilter
|
|
1472
1472
|
*/
|
|
1473
|
-
export interface
|
|
1473
|
+
export interface ExportRankingFilterRankingFilter {
|
|
1474
1474
|
/**
|
|
1475
1475
|
* References to the attributes to be used when filtering.
|
|
1476
|
-
* @type {Array<
|
|
1477
|
-
* @memberof
|
|
1476
|
+
* @type {Array<ExportAfmIdentifier>}
|
|
1477
|
+
* @memberof ExportRankingFilterRankingFilter
|
|
1478
1478
|
*/
|
|
1479
|
-
dimensionality?: Array<
|
|
1479
|
+
dimensionality?: Array<ExportAfmIdentifier>;
|
|
1480
1480
|
/**
|
|
1481
1481
|
* References to the metrics to be used when filtering.
|
|
1482
|
-
* @type {Array<
|
|
1483
|
-
* @memberof
|
|
1482
|
+
* @type {Array<ExportAfmIdentifier>}
|
|
1483
|
+
* @memberof ExportRankingFilterRankingFilter
|
|
1484
1484
|
*/
|
|
1485
|
-
measures: Array<
|
|
1485
|
+
measures: Array<ExportAfmIdentifier>;
|
|
1486
1486
|
/**
|
|
1487
1487
|
* The type of ranking to use, TOP or BOTTOM.
|
|
1488
1488
|
* @type {string}
|
|
1489
|
-
* @memberof
|
|
1489
|
+
* @memberof ExportRankingFilterRankingFilter
|
|
1490
1490
|
*/
|
|
1491
|
-
operator:
|
|
1491
|
+
operator: ExportRankingFilterRankingFilterOperatorEnum;
|
|
1492
1492
|
/**
|
|
1493
1493
|
* Number of top/bottom values to filter.
|
|
1494
1494
|
* @type {number}
|
|
1495
|
-
* @memberof
|
|
1495
|
+
* @memberof ExportRankingFilterRankingFilter
|
|
1496
1496
|
*/
|
|
1497
1497
|
value: number;
|
|
1498
1498
|
/**
|
|
1499
1499
|
*
|
|
1500
1500
|
* @type {string}
|
|
1501
|
-
* @memberof
|
|
1501
|
+
* @memberof ExportRankingFilterRankingFilter
|
|
1502
1502
|
*/
|
|
1503
1503
|
localIdentifier?: string;
|
|
1504
1504
|
/**
|
|
1505
1505
|
*
|
|
1506
1506
|
* @type {boolean}
|
|
1507
|
-
* @memberof
|
|
1507
|
+
* @memberof ExportRankingFilterRankingFilter
|
|
1508
1508
|
*/
|
|
1509
1509
|
applyOnResult?: boolean;
|
|
1510
1510
|
}
|
|
1511
|
-
export declare const
|
|
1511
|
+
export declare const ExportRankingFilterRankingFilterOperatorEnum: {
|
|
1512
1512
|
readonly TOP: "TOP";
|
|
1513
1513
|
readonly BOTTOM: "BOTTOM";
|
|
1514
1514
|
};
|
|
1515
|
-
export type
|
|
1515
|
+
export type ExportRankingFilterRankingFilterOperatorEnum = typeof ExportRankingFilterRankingFilterOperatorEnum[keyof typeof ExportRankingFilterRankingFilterOperatorEnum];
|
|
1516
1516
|
/**
|
|
1517
1517
|
* Custom label object override.
|
|
1518
1518
|
* @export
|
|
1519
|
-
* @interface
|
|
1519
|
+
* @interface ExportRawCustomLabel
|
|
1520
1520
|
*/
|
|
1521
|
-
export interface
|
|
1521
|
+
export interface ExportRawCustomLabel {
|
|
1522
1522
|
/**
|
|
1523
1523
|
* Override value.
|
|
1524
1524
|
* @type {string}
|
|
1525
|
-
* @memberof
|
|
1525
|
+
* @memberof ExportRawCustomLabel
|
|
1526
1526
|
*/
|
|
1527
1527
|
title: string;
|
|
1528
1528
|
}
|
|
1529
1529
|
/**
|
|
1530
1530
|
* Custom metric object override.
|
|
1531
1531
|
* @export
|
|
1532
|
-
* @interface
|
|
1532
|
+
* @interface ExportRawCustomMetric
|
|
1533
1533
|
*/
|
|
1534
|
-
export interface
|
|
1534
|
+
export interface ExportRawCustomMetric {
|
|
1535
1535
|
/**
|
|
1536
1536
|
* Metric title override.
|
|
1537
1537
|
* @type {string}
|
|
1538
|
-
* @memberof
|
|
1538
|
+
* @memberof ExportRawCustomMetric
|
|
1539
1539
|
*/
|
|
1540
1540
|
title: string;
|
|
1541
1541
|
}
|
|
1542
1542
|
/**
|
|
1543
1543
|
* Custom cell value overrides (IDs will be replaced with specified values).
|
|
1544
1544
|
* @export
|
|
1545
|
-
* @interface
|
|
1545
|
+
* @interface ExportRawCustomOverride
|
|
1546
1546
|
*/
|
|
1547
|
-
export interface
|
|
1547
|
+
export interface ExportRawCustomOverride {
|
|
1548
1548
|
/**
|
|
1549
1549
|
* Map of CustomLabels with keys used as placeholders in export result.
|
|
1550
|
-
* @type {{ [key: string]:
|
|
1551
|
-
* @memberof
|
|
1550
|
+
* @type {{ [key: string]: ExportRawCustomLabel; }}
|
|
1551
|
+
* @memberof ExportRawCustomOverride
|
|
1552
1552
|
*/
|
|
1553
1553
|
labels?: {
|
|
1554
|
-
[key: string]:
|
|
1554
|
+
[key: string]: ExportRawCustomLabel;
|
|
1555
1555
|
};
|
|
1556
1556
|
/**
|
|
1557
1557
|
* Map of CustomMetrics with keys used as placeholders in export result.
|
|
1558
|
-
* @type {{ [key: string]:
|
|
1559
|
-
* @memberof
|
|
1558
|
+
* @type {{ [key: string]: ExportRawCustomMetric; }}
|
|
1559
|
+
* @memberof ExportRawCustomOverride
|
|
1560
1560
|
*/
|
|
1561
1561
|
metrics?: {
|
|
1562
|
-
[key: string]:
|
|
1562
|
+
[key: string]: ExportRawCustomMetric;
|
|
1563
1563
|
};
|
|
1564
1564
|
}
|
|
1565
1565
|
/**
|
|
1566
1566
|
* Export request object describing the export properties and overrides for raw exports.
|
|
1567
1567
|
* @export
|
|
1568
|
-
* @interface
|
|
1568
|
+
* @interface ExportRawExportRequest
|
|
1569
1569
|
*/
|
|
1570
|
-
export interface
|
|
1570
|
+
export interface ExportRawExportRequest {
|
|
1571
1571
|
/**
|
|
1572
1572
|
* Requested resulting file type.
|
|
1573
1573
|
* @type {string}
|
|
1574
|
-
* @memberof
|
|
1574
|
+
* @memberof ExportRawExportRequest
|
|
1575
1575
|
*/
|
|
1576
|
-
format:
|
|
1576
|
+
format: ExportRawExportRequestFormatEnum;
|
|
1577
1577
|
/**
|
|
1578
1578
|
*
|
|
1579
|
-
* @type {
|
|
1580
|
-
* @memberof
|
|
1579
|
+
* @type {ExportAFM}
|
|
1580
|
+
* @memberof ExportRawExportRequest
|
|
1581
1581
|
*/
|
|
1582
|
-
execution:
|
|
1582
|
+
execution: ExportAFM;
|
|
1583
1583
|
/**
|
|
1584
1584
|
* Filename of downloaded file without extension.
|
|
1585
1585
|
* @type {string}
|
|
1586
|
-
* @memberof
|
|
1586
|
+
* @memberof ExportRawExportRequest
|
|
1587
1587
|
*/
|
|
1588
1588
|
fileName: string;
|
|
1589
1589
|
/**
|
|
1590
1590
|
*
|
|
1591
|
-
* @type {
|
|
1592
|
-
* @memberof
|
|
1591
|
+
* @type {ExportRawCustomOverride}
|
|
1592
|
+
* @memberof ExportRawExportRequest
|
|
1593
1593
|
*/
|
|
1594
|
-
customOverride?:
|
|
1594
|
+
customOverride?: ExportRawCustomOverride;
|
|
1595
1595
|
/**
|
|
1596
1596
|
*
|
|
1597
|
-
* @type {
|
|
1598
|
-
* @memberof
|
|
1597
|
+
* @type {ExportExecutionSettings}
|
|
1598
|
+
* @memberof ExportRawExportRequest
|
|
1599
1599
|
*/
|
|
1600
|
-
executionSettings?:
|
|
1600
|
+
executionSettings?: ExportExecutionSettings;
|
|
1601
1601
|
}
|
|
1602
|
-
export declare const
|
|
1602
|
+
export declare const ExportRawExportRequestFormatEnum: {
|
|
1603
1603
|
readonly ARROW_FILE: "ARROW_FILE";
|
|
1604
1604
|
readonly ARROW_STREAM: "ARROW_STREAM";
|
|
1605
1605
|
readonly CSV: "CSV";
|
|
1606
1606
|
};
|
|
1607
|
-
export type
|
|
1607
|
+
export type ExportRawExportRequestFormatEnum = typeof ExportRawExportRequestFormatEnum[keyof typeof ExportRawExportRequestFormatEnum];
|
|
1608
1608
|
/**
|
|
1609
1609
|
* A date filter specifying a time interval that is relative to the current date. For example, last week, next month, and so on. Field dataset is representing qualifier of date dimension.
|
|
1610
1610
|
* @export
|
|
1611
|
-
* @interface
|
|
1611
|
+
* @interface ExportRelativeDateFilter
|
|
1612
1612
|
*/
|
|
1613
|
-
export interface
|
|
1613
|
+
export interface ExportRelativeDateFilter {
|
|
1614
1614
|
/**
|
|
1615
1615
|
*
|
|
1616
|
-
* @type {
|
|
1617
|
-
* @memberof
|
|
1616
|
+
* @type {ExportRelativeDateFilterRelativeDateFilter}
|
|
1617
|
+
* @memberof ExportRelativeDateFilter
|
|
1618
1618
|
*/
|
|
1619
|
-
relativeDateFilter:
|
|
1619
|
+
relativeDateFilter: ExportRelativeDateFilterRelativeDateFilter;
|
|
1620
1620
|
}
|
|
1621
1621
|
/**
|
|
1622
1622
|
*
|
|
1623
1623
|
* @export
|
|
1624
|
-
* @interface
|
|
1624
|
+
* @interface ExportRelativeDateFilterRelativeDateFilter
|
|
1625
1625
|
*/
|
|
1626
|
-
export interface
|
|
1626
|
+
export interface ExportRelativeDateFilterRelativeDateFilter {
|
|
1627
1627
|
/**
|
|
1628
1628
|
* Date granularity specifying particular date attribute in given dimension.
|
|
1629
1629
|
* @type {string}
|
|
1630
|
-
* @memberof
|
|
1630
|
+
* @memberof ExportRelativeDateFilterRelativeDateFilter
|
|
1631
1631
|
*/
|
|
1632
|
-
granularity:
|
|
1632
|
+
granularity: ExportRelativeDateFilterRelativeDateFilterGranularityEnum;
|
|
1633
1633
|
/**
|
|
1634
1634
|
* Start of the filtering interval. Specified by number of periods (with respect to given granularity). Typically negative (historical time interval like -2 for \'2 days/weeks, ... ago\').
|
|
1635
1635
|
* @type {number}
|
|
1636
|
-
* @memberof
|
|
1636
|
+
* @memberof ExportRelativeDateFilterRelativeDateFilter
|
|
1637
1637
|
*/
|
|
1638
1638
|
from: number;
|
|
1639
1639
|
/**
|
|
1640
1640
|
* End of the filtering interval. Specified by number of periods (with respect to given granularity). Value \'O\' is representing current time-interval (current day, week, ...).
|
|
1641
1641
|
* @type {number}
|
|
1642
|
-
* @memberof
|
|
1642
|
+
* @memberof ExportRelativeDateFilterRelativeDateFilter
|
|
1643
1643
|
*/
|
|
1644
1644
|
to: number;
|
|
1645
1645
|
/**
|
|
1646
1646
|
*
|
|
1647
1647
|
* @type {string}
|
|
1648
|
-
* @memberof
|
|
1648
|
+
* @memberof ExportRelativeDateFilterRelativeDateFilter
|
|
1649
1649
|
*/
|
|
1650
1650
|
localIdentifier?: string;
|
|
1651
1651
|
/**
|
|
1652
1652
|
*
|
|
1653
1653
|
* @type {boolean}
|
|
1654
|
-
* @memberof
|
|
1654
|
+
* @memberof ExportRelativeDateFilterRelativeDateFilter
|
|
1655
1655
|
*/
|
|
1656
1656
|
applyOnResult?: boolean;
|
|
1657
1657
|
/**
|
|
1658
1658
|
*
|
|
1659
|
-
* @type {
|
|
1660
|
-
* @memberof
|
|
1659
|
+
* @type {ExportAfmObjectIdentifierDataset}
|
|
1660
|
+
* @memberof ExportRelativeDateFilterRelativeDateFilter
|
|
1661
1661
|
*/
|
|
1662
|
-
dataset:
|
|
1662
|
+
dataset: ExportAfmObjectIdentifierDataset;
|
|
1663
1663
|
}
|
|
1664
|
-
export declare const
|
|
1664
|
+
export declare const ExportRelativeDateFilterRelativeDateFilterGranularityEnum: {
|
|
1665
1665
|
readonly MINUTE: "MINUTE";
|
|
1666
1666
|
readonly HOUR: "HOUR";
|
|
1667
1667
|
readonly DAY: "DAY";
|
|
@@ -1678,101 +1678,101 @@ export declare const RelativeDateFilterRelativeDateFilterGranularityEnum: {
|
|
|
1678
1678
|
readonly MONTH_OF_YEAR: "MONTH_OF_YEAR";
|
|
1679
1679
|
readonly QUARTER_OF_YEAR: "QUARTER_OF_YEAR";
|
|
1680
1680
|
};
|
|
1681
|
-
export type
|
|
1681
|
+
export type ExportRelativeDateFilterRelativeDateFilterGranularityEnum = typeof ExportRelativeDateFilterRelativeDateFilterGranularityEnum[keyof typeof ExportRelativeDateFilterRelativeDateFilterGranularityEnum];
|
|
1682
1682
|
/**
|
|
1683
1683
|
* Additional settings.
|
|
1684
1684
|
* @export
|
|
1685
|
-
* @interface
|
|
1685
|
+
* @interface ExportSettings
|
|
1686
1686
|
*/
|
|
1687
|
-
export interface
|
|
1687
|
+
export interface ExportSettings {
|
|
1688
1688
|
/**
|
|
1689
1689
|
* Include export info sheet in the exported file. Works only with `visualizationObject`. (XLSX)
|
|
1690
1690
|
* @type {boolean}
|
|
1691
|
-
* @memberof
|
|
1691
|
+
* @memberof ExportSettings
|
|
1692
1692
|
*/
|
|
1693
1693
|
exportInfo?: boolean;
|
|
1694
1694
|
/**
|
|
1695
1695
|
* Merge equal headers in neighbouring cells. (XLSX)
|
|
1696
1696
|
* @type {boolean}
|
|
1697
|
-
* @memberof
|
|
1697
|
+
* @memberof ExportSettings
|
|
1698
1698
|
*/
|
|
1699
1699
|
mergeHeaders?: boolean;
|
|
1700
1700
|
/**
|
|
1701
1701
|
* Print applied filters on top of the document. (PDF/HTML when visualizationObject is given)
|
|
1702
1702
|
* @type {boolean}
|
|
1703
|
-
* @memberof
|
|
1703
|
+
* @memberof ExportSettings
|
|
1704
1704
|
*/
|
|
1705
1705
|
showFilters?: boolean;
|
|
1706
1706
|
/**
|
|
1707
1707
|
* Page size and orientation. (PDF)
|
|
1708
1708
|
* @type {string}
|
|
1709
|
-
* @memberof
|
|
1709
|
+
* @memberof ExportSettings
|
|
1710
1710
|
*/
|
|
1711
1711
|
pdfPageSize?: string;
|
|
1712
1712
|
/**
|
|
1713
1713
|
* Custom CSS styles for the table. (PDF, HTML)
|
|
1714
|
-
* @type {Array<
|
|
1715
|
-
* @memberof
|
|
1714
|
+
* @type {Array<ExportPdfTableStyle>}
|
|
1715
|
+
* @memberof ExportSettings
|
|
1716
1716
|
*/
|
|
1717
|
-
pdfTableStyle?: Array<
|
|
1717
|
+
pdfTableStyle?: Array<ExportPdfTableStyle>;
|
|
1718
1718
|
/**
|
|
1719
1719
|
* Top left header content. (PDF)
|
|
1720
1720
|
* @type {string}
|
|
1721
|
-
* @memberof
|
|
1721
|
+
* @memberof ExportSettings
|
|
1722
1722
|
*/
|
|
1723
1723
|
pdfTopLeftContent?: string;
|
|
1724
1724
|
/**
|
|
1725
1725
|
* Top right header content. (PDF)
|
|
1726
1726
|
* @type {string}
|
|
1727
|
-
* @memberof
|
|
1727
|
+
* @memberof ExportSettings
|
|
1728
1728
|
*/
|
|
1729
1729
|
pdfTopRightContent?: string;
|
|
1730
1730
|
}
|
|
1731
1731
|
/**
|
|
1732
1732
|
* Metric defined by referencing a MAQL metric or an LDM fact object with aggregation.
|
|
1733
1733
|
* @export
|
|
1734
|
-
* @interface
|
|
1734
|
+
* @interface ExportSimpleMeasureDefinition
|
|
1735
1735
|
*/
|
|
1736
|
-
export interface
|
|
1736
|
+
export interface ExportSimpleMeasureDefinition {
|
|
1737
1737
|
/**
|
|
1738
1738
|
*
|
|
1739
|
-
* @type {
|
|
1740
|
-
* @memberof
|
|
1739
|
+
* @type {ExportSimpleMeasureDefinitionMeasure}
|
|
1740
|
+
* @memberof ExportSimpleMeasureDefinition
|
|
1741
1741
|
*/
|
|
1742
|
-
measure:
|
|
1742
|
+
measure: ExportSimpleMeasureDefinitionMeasure;
|
|
1743
1743
|
}
|
|
1744
1744
|
/**
|
|
1745
1745
|
*
|
|
1746
1746
|
* @export
|
|
1747
|
-
* @interface
|
|
1747
|
+
* @interface ExportSimpleMeasureDefinitionMeasure
|
|
1748
1748
|
*/
|
|
1749
|
-
export interface
|
|
1749
|
+
export interface ExportSimpleMeasureDefinitionMeasure {
|
|
1750
1750
|
/**
|
|
1751
1751
|
*
|
|
1752
|
-
* @type {
|
|
1753
|
-
* @memberof
|
|
1752
|
+
* @type {ExportAfmObjectIdentifierCore}
|
|
1753
|
+
* @memberof ExportSimpleMeasureDefinitionMeasure
|
|
1754
1754
|
*/
|
|
1755
|
-
item:
|
|
1755
|
+
item: ExportAfmObjectIdentifierCore;
|
|
1756
1756
|
/**
|
|
1757
1757
|
* Definition of aggregation type of the metric.
|
|
1758
1758
|
* @type {string}
|
|
1759
|
-
* @memberof
|
|
1759
|
+
* @memberof ExportSimpleMeasureDefinitionMeasure
|
|
1760
1760
|
*/
|
|
1761
|
-
aggregation?:
|
|
1761
|
+
aggregation?: ExportSimpleMeasureDefinitionMeasureAggregationEnum;
|
|
1762
1762
|
/**
|
|
1763
1763
|
* If true, compute the percentage of given metric values (broken down by AFM attributes) to the total (not broken down).
|
|
1764
1764
|
* @type {boolean}
|
|
1765
|
-
* @memberof
|
|
1765
|
+
* @memberof ExportSimpleMeasureDefinitionMeasure
|
|
1766
1766
|
*/
|
|
1767
1767
|
computeRatio?: boolean;
|
|
1768
1768
|
/**
|
|
1769
1769
|
* Metrics can be filtered by attribute filters with the same interface as ones for global AFM. Note that only one DateFilter is allowed.
|
|
1770
|
-
* @type {Array<
|
|
1771
|
-
* @memberof
|
|
1770
|
+
* @type {Array<ExportFilterDefinitionForSimpleMeasure>}
|
|
1771
|
+
* @memberof ExportSimpleMeasureDefinitionMeasure
|
|
1772
1772
|
*/
|
|
1773
|
-
filters?: Array<
|
|
1773
|
+
filters?: Array<ExportFilterDefinitionForSimpleMeasure>;
|
|
1774
1774
|
}
|
|
1775
|
-
export declare const
|
|
1775
|
+
export declare const ExportSimpleMeasureDefinitionMeasureAggregationEnum: {
|
|
1776
1776
|
readonly SUM: "SUM";
|
|
1777
1777
|
readonly COUNT: "COUNT";
|
|
1778
1778
|
readonly AVG: "AVG";
|
|
@@ -1782,214 +1782,214 @@ export declare const SimpleMeasureDefinitionMeasureAggregationEnum: {
|
|
|
1782
1782
|
readonly RUNSUM: "RUNSUM";
|
|
1783
1783
|
readonly APPROXIMATE_COUNT: "APPROXIMATE_COUNT";
|
|
1784
1784
|
};
|
|
1785
|
-
export type
|
|
1785
|
+
export type ExportSimpleMeasureDefinitionMeasureAggregationEnum = typeof ExportSimpleMeasureDefinitionMeasureAggregationEnum[keyof typeof ExportSimpleMeasureDefinitionMeasureAggregationEnum];
|
|
1786
1786
|
/**
|
|
1787
1787
|
* Export request object describing the export properties and metadata for slides exports.
|
|
1788
1788
|
* @export
|
|
1789
|
-
* @interface
|
|
1789
|
+
* @interface ExportSlidesExportRequest
|
|
1790
1790
|
*/
|
|
1791
|
-
export interface
|
|
1791
|
+
export interface ExportSlidesExportRequest {
|
|
1792
1792
|
/**
|
|
1793
1793
|
* Requested resulting file type.
|
|
1794
1794
|
* @type {string}
|
|
1795
|
-
* @memberof
|
|
1795
|
+
* @memberof ExportSlidesExportRequest
|
|
1796
1796
|
*/
|
|
1797
|
-
format:
|
|
1797
|
+
format: ExportSlidesExportRequestFormatEnum;
|
|
1798
1798
|
/**
|
|
1799
1799
|
* File name to be used for retrieving the pdf document.
|
|
1800
1800
|
* @type {string}
|
|
1801
|
-
* @memberof
|
|
1801
|
+
* @memberof ExportSlidesExportRequest
|
|
1802
1802
|
*/
|
|
1803
1803
|
fileName: string;
|
|
1804
1804
|
/**
|
|
1805
1805
|
* Dashboard identifier
|
|
1806
1806
|
* @type {string}
|
|
1807
|
-
* @memberof
|
|
1807
|
+
* @memberof ExportSlidesExportRequest
|
|
1808
1808
|
*/
|
|
1809
1809
|
dashboardId?: string;
|
|
1810
1810
|
/**
|
|
1811
1811
|
* List of widget identifiers to be exported. Note that only one widget is currently supported.
|
|
1812
1812
|
* @type {Array<string>}
|
|
1813
|
-
* @memberof
|
|
1813
|
+
* @memberof ExportSlidesExportRequest
|
|
1814
1814
|
*/
|
|
1815
1815
|
widgetIds?: Array<string>;
|
|
1816
1816
|
/**
|
|
1817
1817
|
* List of visualization ids to be exported. Note that only one visualization is currently supported.
|
|
1818
1818
|
* @type {Array<string>}
|
|
1819
|
-
* @memberof
|
|
1819
|
+
* @memberof ExportSlidesExportRequest
|
|
1820
1820
|
*/
|
|
1821
1821
|
visualizationIds?: Array<string>;
|
|
1822
1822
|
/**
|
|
1823
1823
|
* Metadata definition in free-form JSON format.
|
|
1824
1824
|
* @type {object}
|
|
1825
|
-
* @memberof
|
|
1825
|
+
* @memberof ExportSlidesExportRequest
|
|
1826
1826
|
*/
|
|
1827
1827
|
metadata?: object | null;
|
|
1828
1828
|
/**
|
|
1829
1829
|
* Export template identifier.
|
|
1830
1830
|
* @type {string}
|
|
1831
|
-
* @memberof
|
|
1831
|
+
* @memberof ExportSlidesExportRequest
|
|
1832
1832
|
*/
|
|
1833
1833
|
templateId?: string | null;
|
|
1834
1834
|
}
|
|
1835
|
-
export declare const
|
|
1835
|
+
export declare const ExportSlidesExportRequestFormatEnum: {
|
|
1836
1836
|
readonly PDF: "PDF";
|
|
1837
1837
|
readonly PPTX: "PPTX";
|
|
1838
1838
|
};
|
|
1839
|
-
export type
|
|
1839
|
+
export type ExportSlidesExportRequestFormatEnum = typeof ExportSlidesExportRequestFormatEnum[keyof typeof ExportSlidesExportRequestFormatEnum];
|
|
1840
1840
|
/**
|
|
1841
1841
|
* Export request object describing the export properties and overrides for tabular exports.
|
|
1842
1842
|
* @export
|
|
1843
|
-
* @interface
|
|
1843
|
+
* @interface ExportTabularExportRequest
|
|
1844
1844
|
*/
|
|
1845
|
-
export interface
|
|
1845
|
+
export interface ExportTabularExportRequest {
|
|
1846
1846
|
/**
|
|
1847
1847
|
* Expected file format.
|
|
1848
1848
|
* @type {string}
|
|
1849
|
-
* @memberof
|
|
1849
|
+
* @memberof ExportTabularExportRequest
|
|
1850
1850
|
*/
|
|
1851
|
-
format:
|
|
1851
|
+
format: ExportTabularExportRequestFormatEnum;
|
|
1852
1852
|
/**
|
|
1853
1853
|
* Execution result identifier.
|
|
1854
1854
|
* @type {string}
|
|
1855
|
-
* @memberof
|
|
1855
|
+
* @memberof ExportTabularExportRequest
|
|
1856
1856
|
*/
|
|
1857
1857
|
executionResult?: string;
|
|
1858
1858
|
/**
|
|
1859
1859
|
* Filename of downloaded file without extension.
|
|
1860
1860
|
* @type {string}
|
|
1861
|
-
* @memberof
|
|
1861
|
+
* @memberof ExportTabularExportRequest
|
|
1862
1862
|
*/
|
|
1863
1863
|
fileName: string;
|
|
1864
1864
|
/**
|
|
1865
1865
|
*
|
|
1866
|
-
* @type {
|
|
1867
|
-
* @memberof
|
|
1866
|
+
* @type {ExportSettings}
|
|
1867
|
+
* @memberof ExportTabularExportRequest
|
|
1868
1868
|
*/
|
|
1869
|
-
settings?:
|
|
1869
|
+
settings?: ExportSettings;
|
|
1870
1870
|
/**
|
|
1871
1871
|
*
|
|
1872
|
-
* @type {
|
|
1873
|
-
* @memberof
|
|
1872
|
+
* @type {ExportCustomOverride}
|
|
1873
|
+
* @memberof ExportTabularExportRequest
|
|
1874
1874
|
*/
|
|
1875
|
-
customOverride?:
|
|
1875
|
+
customOverride?: ExportCustomOverride;
|
|
1876
1876
|
/**
|
|
1877
1877
|
* Visualization object identifier. Alternative to executionResult property.
|
|
1878
1878
|
* @type {string}
|
|
1879
|
-
* @memberof
|
|
1879
|
+
* @memberof ExportTabularExportRequest
|
|
1880
1880
|
*/
|
|
1881
1881
|
visualizationObject?: string;
|
|
1882
1882
|
/**
|
|
1883
1883
|
* Optional custom filters (as array of IFilter objects defined in UI SDK) to be applied when visualizationObject is given.
|
|
1884
1884
|
* @type {Array<object>}
|
|
1885
|
-
* @memberof
|
|
1885
|
+
* @memberof ExportTabularExportRequest
|
|
1886
1886
|
*/
|
|
1887
1887
|
visualizationObjectCustomFilters?: Array<object>;
|
|
1888
1888
|
/**
|
|
1889
1889
|
* Analytical dashboard identifier. Optional identifier, which informs the system that the export is related to a specific dashboard.
|
|
1890
1890
|
* @type {string}
|
|
1891
|
-
* @memberof
|
|
1891
|
+
* @memberof ExportTabularExportRequest
|
|
1892
1892
|
*/
|
|
1893
1893
|
relatedDashboardId?: string;
|
|
1894
1894
|
/**
|
|
1895
1895
|
* Metadata definition in free-form JSON format.
|
|
1896
1896
|
* @type {object}
|
|
1897
|
-
* @memberof
|
|
1897
|
+
* @memberof ExportTabularExportRequest
|
|
1898
1898
|
*/
|
|
1899
1899
|
metadata?: object | null;
|
|
1900
1900
|
}
|
|
1901
|
-
export declare const
|
|
1901
|
+
export declare const ExportTabularExportRequestFormatEnum: {
|
|
1902
1902
|
readonly CSV: "CSV";
|
|
1903
1903
|
readonly XLSX: "XLSX";
|
|
1904
1904
|
readonly HTML: "HTML";
|
|
1905
1905
|
readonly PDF: "PDF";
|
|
1906
1906
|
};
|
|
1907
|
-
export type
|
|
1907
|
+
export type ExportTabularExportRequestFormatEnum = typeof ExportTabularExportRequestFormatEnum[keyof typeof ExportTabularExportRequestFormatEnum];
|
|
1908
1908
|
/**
|
|
1909
1909
|
* Export request object describing the export properties and metadata for dashboard PDF exports.
|
|
1910
1910
|
* @export
|
|
1911
|
-
* @interface
|
|
1911
|
+
* @interface ExportVisualExportRequest
|
|
1912
1912
|
*/
|
|
1913
|
-
export interface
|
|
1913
|
+
export interface ExportVisualExportRequest {
|
|
1914
1914
|
/**
|
|
1915
1915
|
* File name to be used for retrieving the pdf document.
|
|
1916
1916
|
* @type {string}
|
|
1917
|
-
* @memberof
|
|
1917
|
+
* @memberof ExportVisualExportRequest
|
|
1918
1918
|
*/
|
|
1919
1919
|
fileName: string;
|
|
1920
1920
|
/**
|
|
1921
1921
|
* Dashboard identifier
|
|
1922
1922
|
* @type {string}
|
|
1923
|
-
* @memberof
|
|
1923
|
+
* @memberof ExportVisualExportRequest
|
|
1924
1924
|
*/
|
|
1925
1925
|
dashboardId: string;
|
|
1926
1926
|
/**
|
|
1927
1927
|
* Metadata definition in free-form JSON format.
|
|
1928
1928
|
* @type {object}
|
|
1929
|
-
* @memberof
|
|
1929
|
+
* @memberof ExportVisualExportRequest
|
|
1930
1930
|
*/
|
|
1931
1931
|
metadata?: object;
|
|
1932
1932
|
}
|
|
1933
1933
|
/**
|
|
1934
|
-
*
|
|
1934
|
+
* ActionsExport - axios parameter creator
|
|
1935
1935
|
* @export
|
|
1936
1936
|
*/
|
|
1937
|
-
export declare const
|
|
1937
|
+
export declare const ActionsExportAxiosParamCreator: (configuration?: Configuration) => {
|
|
1938
1938
|
/**
|
|
1939
1939
|
* 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.
|
|
1940
1940
|
* @summary (EXPERIMENTAL) Create dashboard tabular export request
|
|
1941
1941
|
* @param {string} workspaceId
|
|
1942
1942
|
* @param {string} dashboardId
|
|
1943
|
-
* @param {
|
|
1943
|
+
* @param {ExportDashboardTabularExportRequest} exportDashboardTabularExportRequest
|
|
1944
1944
|
* @param {*} [options] Override http request option.
|
|
1945
1945
|
* @throws {RequiredError}
|
|
1946
1946
|
*/
|
|
1947
|
-
createDashboardExportRequest: (workspaceId: string, dashboardId: string,
|
|
1947
|
+
createDashboardExportRequest: (workspaceId: string, dashboardId: string, exportDashboardTabularExportRequest: ExportDashboardTabularExportRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
1948
1948
|
/**
|
|
1949
1949
|
* 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.
|
|
1950
1950
|
* @summary (EXPERIMENTAL) Create image export request
|
|
1951
1951
|
* @param {string} workspaceId
|
|
1952
|
-
* @param {
|
|
1952
|
+
* @param {ExportImageExportRequest} exportImageExportRequest
|
|
1953
1953
|
* @param {*} [options] Override http request option.
|
|
1954
1954
|
* @throws {RequiredError}
|
|
1955
1955
|
*/
|
|
1956
|
-
createImageExport: (workspaceId: string,
|
|
1956
|
+
createImageExport: (workspaceId: string, exportImageExportRequest: ExportImageExportRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
1957
1957
|
/**
|
|
1958
1958
|
* 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.
|
|
1959
1959
|
* @summary Create visual - pdf export request
|
|
1960
1960
|
* @param {string} workspaceId
|
|
1961
|
-
* @param {
|
|
1961
|
+
* @param {ExportVisualExportRequest} exportVisualExportRequest
|
|
1962
1962
|
* @param {*} [options] Override http request option.
|
|
1963
1963
|
* @throws {RequiredError}
|
|
1964
1964
|
*/
|
|
1965
|
-
createPdfExport: (workspaceId: string,
|
|
1965
|
+
createPdfExport: (workspaceId: string, exportVisualExportRequest: ExportVisualExportRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
1966
1966
|
/**
|
|
1967
1967
|
* 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.
|
|
1968
1968
|
* @summary (EXPERIMENTAL) Create raw export request
|
|
1969
1969
|
* @param {string} workspaceId
|
|
1970
|
-
* @param {
|
|
1970
|
+
* @param {ExportRawExportRequest} exportRawExportRequest
|
|
1971
1971
|
* @param {*} [options] Override http request option.
|
|
1972
1972
|
* @throws {RequiredError}
|
|
1973
1973
|
*/
|
|
1974
|
-
createRawExport: (workspaceId: string,
|
|
1974
|
+
createRawExport: (workspaceId: string, exportRawExportRequest: ExportRawExportRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
1975
1975
|
/**
|
|
1976
1976
|
* 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.
|
|
1977
1977
|
* @summary (EXPERIMENTAL) Create slides export request
|
|
1978
1978
|
* @param {string} workspaceId
|
|
1979
|
-
* @param {
|
|
1979
|
+
* @param {ExportSlidesExportRequest} exportSlidesExportRequest
|
|
1980
1980
|
* @param {*} [options] Override http request option.
|
|
1981
1981
|
* @throws {RequiredError}
|
|
1982
1982
|
*/
|
|
1983
|
-
createSlidesExport: (workspaceId: string,
|
|
1983
|
+
createSlidesExport: (workspaceId: string, exportSlidesExportRequest: ExportSlidesExportRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
1984
1984
|
/**
|
|
1985
1985
|
* 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.
|
|
1986
1986
|
* @summary Create tabular export request
|
|
1987
1987
|
* @param {string} workspaceId
|
|
1988
|
-
* @param {
|
|
1988
|
+
* @param {ExportTabularExportRequest} exportTabularExportRequest
|
|
1989
1989
|
* @param {*} [options] Override http request option.
|
|
1990
1990
|
* @throws {RequiredError}
|
|
1991
1991
|
*/
|
|
1992
|
-
createTabularExport: (workspaceId: string,
|
|
1992
|
+
createTabularExport: (workspaceId: string, exportTabularExportRequest: ExportTabularExportRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
1993
1993
|
/**
|
|
1994
1994
|
* Returns 202 until original POST export request is not processed.Returns 200 with exported data once the export is done.
|
|
1995
1995
|
* @summary Retrieve exported files
|
|
@@ -2064,65 +2064,65 @@ export declare const ActionsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
2064
2064
|
getTabularExport: (workspaceId: string, exportId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
2065
2065
|
};
|
|
2066
2066
|
/**
|
|
2067
|
-
*
|
|
2067
|
+
* ActionsExport - functional programming interface
|
|
2068
2068
|
* @export
|
|
2069
2069
|
*/
|
|
2070
|
-
export declare const
|
|
2070
|
+
export declare const ActionsExportFp: (configuration?: Configuration) => {
|
|
2071
2071
|
/**
|
|
2072
2072
|
* 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.
|
|
2073
2073
|
* @summary (EXPERIMENTAL) Create dashboard tabular export request
|
|
2074
2074
|
* @param {string} workspaceId
|
|
2075
2075
|
* @param {string} dashboardId
|
|
2076
|
-
* @param {
|
|
2076
|
+
* @param {ExportDashboardTabularExportRequest} exportDashboardTabularExportRequest
|
|
2077
2077
|
* @param {*} [options] Override http request option.
|
|
2078
2078
|
* @throws {RequiredError}
|
|
2079
2079
|
*/
|
|
2080
|
-
createDashboardExportRequest(workspaceId: string, dashboardId: string,
|
|
2080
|
+
createDashboardExportRequest(workspaceId: string, dashboardId: string, exportDashboardTabularExportRequest: ExportDashboardTabularExportRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExportExportResponse>>;
|
|
2081
2081
|
/**
|
|
2082
2082
|
* 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.
|
|
2083
2083
|
* @summary (EXPERIMENTAL) Create image export request
|
|
2084
2084
|
* @param {string} workspaceId
|
|
2085
|
-
* @param {
|
|
2085
|
+
* @param {ExportImageExportRequest} exportImageExportRequest
|
|
2086
2086
|
* @param {*} [options] Override http request option.
|
|
2087
2087
|
* @throws {RequiredError}
|
|
2088
2088
|
*/
|
|
2089
|
-
createImageExport(workspaceId: string,
|
|
2089
|
+
createImageExport(workspaceId: string, exportImageExportRequest: ExportImageExportRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExportExportResponse>>;
|
|
2090
2090
|
/**
|
|
2091
2091
|
* 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.
|
|
2092
2092
|
* @summary Create visual - pdf export request
|
|
2093
2093
|
* @param {string} workspaceId
|
|
2094
|
-
* @param {
|
|
2094
|
+
* @param {ExportVisualExportRequest} exportVisualExportRequest
|
|
2095
2095
|
* @param {*} [options] Override http request option.
|
|
2096
2096
|
* @throws {RequiredError}
|
|
2097
2097
|
*/
|
|
2098
|
-
createPdfExport(workspaceId: string,
|
|
2098
|
+
createPdfExport(workspaceId: string, exportVisualExportRequest: ExportVisualExportRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExportExportResponse>>;
|
|
2099
2099
|
/**
|
|
2100
2100
|
* 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.
|
|
2101
2101
|
* @summary (EXPERIMENTAL) Create raw export request
|
|
2102
2102
|
* @param {string} workspaceId
|
|
2103
|
-
* @param {
|
|
2103
|
+
* @param {ExportRawExportRequest} exportRawExportRequest
|
|
2104
2104
|
* @param {*} [options] Override http request option.
|
|
2105
2105
|
* @throws {RequiredError}
|
|
2106
2106
|
*/
|
|
2107
|
-
createRawExport(workspaceId: string,
|
|
2107
|
+
createRawExport(workspaceId: string, exportRawExportRequest: ExportRawExportRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExportExportResponse>>;
|
|
2108
2108
|
/**
|
|
2109
2109
|
* 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.
|
|
2110
2110
|
* @summary (EXPERIMENTAL) Create slides export request
|
|
2111
2111
|
* @param {string} workspaceId
|
|
2112
|
-
* @param {
|
|
2112
|
+
* @param {ExportSlidesExportRequest} exportSlidesExportRequest
|
|
2113
2113
|
* @param {*} [options] Override http request option.
|
|
2114
2114
|
* @throws {RequiredError}
|
|
2115
2115
|
*/
|
|
2116
|
-
createSlidesExport(workspaceId: string,
|
|
2116
|
+
createSlidesExport(workspaceId: string, exportSlidesExportRequest: ExportSlidesExportRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExportExportResponse>>;
|
|
2117
2117
|
/**
|
|
2118
2118
|
* 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.
|
|
2119
2119
|
* @summary Create tabular export request
|
|
2120
2120
|
* @param {string} workspaceId
|
|
2121
|
-
* @param {
|
|
2121
|
+
* @param {ExportTabularExportRequest} exportTabularExportRequest
|
|
2122
2122
|
* @param {*} [options] Override http request option.
|
|
2123
2123
|
* @throws {RequiredError}
|
|
2124
2124
|
*/
|
|
2125
|
-
createTabularExport(workspaceId: string,
|
|
2125
|
+
createTabularExport(workspaceId: string, exportTabularExportRequest: ExportTabularExportRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExportExportResponse>>;
|
|
2126
2126
|
/**
|
|
2127
2127
|
* Returns 202 until original POST export request is not processed.Returns 200 with exported data once the export is done.
|
|
2128
2128
|
* @summary Retrieve exported files
|
|
@@ -2197,676 +2197,676 @@ export declare const ActionsApiFp: (configuration?: Configuration) => {
|
|
|
2197
2197
|
getTabularExport(workspaceId: string, exportId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
2198
2198
|
};
|
|
2199
2199
|
/**
|
|
2200
|
-
*
|
|
2200
|
+
* ActionsExport - factory interface
|
|
2201
2201
|
* @export
|
|
2202
2202
|
*/
|
|
2203
|
-
export declare const
|
|
2203
|
+
export declare const ActionsExportFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
2204
2204
|
/**
|
|
2205
2205
|
* 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.
|
|
2206
2206
|
* @summary (EXPERIMENTAL) Create dashboard tabular export request
|
|
2207
|
-
* @param {
|
|
2207
|
+
* @param {ActionsExportCreateDashboardExportRequestRequest} requestParameters Request parameters.
|
|
2208
2208
|
* @param {*} [options] Override http request option.
|
|
2209
2209
|
* @throws {RequiredError}
|
|
2210
2210
|
*/
|
|
2211
|
-
createDashboardExportRequest(requestParameters:
|
|
2211
|
+
createDashboardExportRequest(requestParameters: ActionsExportCreateDashboardExportRequestRequest, options?: AxiosRequestConfig): AxiosPromise<ExportExportResponse>;
|
|
2212
2212
|
/**
|
|
2213
2213
|
* 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.
|
|
2214
2214
|
* @summary (EXPERIMENTAL) Create image export request
|
|
2215
|
-
* @param {
|
|
2215
|
+
* @param {ActionsExportCreateImageExportRequest} requestParameters Request parameters.
|
|
2216
2216
|
* @param {*} [options] Override http request option.
|
|
2217
2217
|
* @throws {RequiredError}
|
|
2218
2218
|
*/
|
|
2219
|
-
createImageExport(requestParameters:
|
|
2219
|
+
createImageExport(requestParameters: ActionsExportCreateImageExportRequest, options?: AxiosRequestConfig): AxiosPromise<ExportExportResponse>;
|
|
2220
2220
|
/**
|
|
2221
2221
|
* 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.
|
|
2222
2222
|
* @summary Create visual - pdf export request
|
|
2223
|
-
* @param {
|
|
2223
|
+
* @param {ActionsExportCreatePdfExportRequest} requestParameters Request parameters.
|
|
2224
2224
|
* @param {*} [options] Override http request option.
|
|
2225
2225
|
* @throws {RequiredError}
|
|
2226
2226
|
*/
|
|
2227
|
-
createPdfExport(requestParameters:
|
|
2227
|
+
createPdfExport(requestParameters: ActionsExportCreatePdfExportRequest, options?: AxiosRequestConfig): AxiosPromise<ExportExportResponse>;
|
|
2228
2228
|
/**
|
|
2229
2229
|
* 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.
|
|
2230
2230
|
* @summary (EXPERIMENTAL) Create raw export request
|
|
2231
|
-
* @param {
|
|
2231
|
+
* @param {ActionsExportCreateRawExportRequest} requestParameters Request parameters.
|
|
2232
2232
|
* @param {*} [options] Override http request option.
|
|
2233
2233
|
* @throws {RequiredError}
|
|
2234
2234
|
*/
|
|
2235
|
-
createRawExport(requestParameters:
|
|
2235
|
+
createRawExport(requestParameters: ActionsExportCreateRawExportRequest, options?: AxiosRequestConfig): AxiosPromise<ExportExportResponse>;
|
|
2236
2236
|
/**
|
|
2237
2237
|
* 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.
|
|
2238
2238
|
* @summary (EXPERIMENTAL) Create slides export request
|
|
2239
|
-
* @param {
|
|
2239
|
+
* @param {ActionsExportCreateSlidesExportRequest} requestParameters Request parameters.
|
|
2240
2240
|
* @param {*} [options] Override http request option.
|
|
2241
2241
|
* @throws {RequiredError}
|
|
2242
2242
|
*/
|
|
2243
|
-
createSlidesExport(requestParameters:
|
|
2243
|
+
createSlidesExport(requestParameters: ActionsExportCreateSlidesExportRequest, options?: AxiosRequestConfig): AxiosPromise<ExportExportResponse>;
|
|
2244
2244
|
/**
|
|
2245
2245
|
* 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.
|
|
2246
2246
|
* @summary Create tabular export request
|
|
2247
|
-
* @param {
|
|
2247
|
+
* @param {ActionsExportCreateTabularExportRequest} requestParameters Request parameters.
|
|
2248
2248
|
* @param {*} [options] Override http request option.
|
|
2249
2249
|
* @throws {RequiredError}
|
|
2250
2250
|
*/
|
|
2251
|
-
createTabularExport(requestParameters:
|
|
2251
|
+
createTabularExport(requestParameters: ActionsExportCreateTabularExportRequest, options?: AxiosRequestConfig): AxiosPromise<ExportExportResponse>;
|
|
2252
2252
|
/**
|
|
2253
2253
|
* Returns 202 until original POST export request is not processed.Returns 200 with exported data once the export is done.
|
|
2254
2254
|
* @summary Retrieve exported files
|
|
2255
|
-
* @param {
|
|
2255
|
+
* @param {ActionsExportGetExportedFileRequest} requestParameters Request parameters.
|
|
2256
2256
|
* @param {*} [options] Override http request option.
|
|
2257
2257
|
* @throws {RequiredError}
|
|
2258
2258
|
*/
|
|
2259
|
-
getExportedFile(requestParameters:
|
|
2259
|
+
getExportedFile(requestParameters: ActionsExportGetExportedFileRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
2260
2260
|
/**
|
|
2261
2261
|
* 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.
|
|
2262
2262
|
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
2263
|
-
* @param {
|
|
2263
|
+
* @param {ActionsExportGetImageExportRequest} requestParameters Request parameters.
|
|
2264
2264
|
* @param {*} [options] Override http request option.
|
|
2265
2265
|
* @throws {RequiredError}
|
|
2266
2266
|
*/
|
|
2267
|
-
getImageExport(requestParameters:
|
|
2267
|
+
getImageExport(requestParameters: ActionsExportGetImageExportRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
2268
2268
|
/**
|
|
2269
2269
|
* 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.
|
|
2270
2270
|
* @summary (EXPERIMENTAL) Retrieve metadata context
|
|
2271
|
-
* @param {
|
|
2271
|
+
* @param {ActionsExportGetImageExportMetadataRequest} requestParameters Request parameters.
|
|
2272
2272
|
* @param {*} [options] Override http request option.
|
|
2273
2273
|
* @throws {RequiredError}
|
|
2274
2274
|
*/
|
|
2275
|
-
getImageExportMetadata(requestParameters:
|
|
2275
|
+
getImageExportMetadata(requestParameters: ActionsExportGetImageExportMetadataRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
2276
2276
|
/**
|
|
2277
2277
|
* 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.
|
|
2278
2278
|
* @summary Retrieve metadata context
|
|
2279
|
-
* @param {
|
|
2279
|
+
* @param {ActionsExportGetMetadataRequest} requestParameters Request parameters.
|
|
2280
2280
|
* @param {*} [options] Override http request option.
|
|
2281
2281
|
* @throws {RequiredError}
|
|
2282
2282
|
*/
|
|
2283
|
-
getMetadata(requestParameters:
|
|
2283
|
+
getMetadata(requestParameters: ActionsExportGetMetadataRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
2284
2284
|
/**
|
|
2285
2285
|
* 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.
|
|
2286
2286
|
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
2287
|
-
* @param {
|
|
2287
|
+
* @param {ActionsExportGetRawExportRequest} requestParameters Request parameters.
|
|
2288
2288
|
* @param {*} [options] Override http request option.
|
|
2289
2289
|
* @throws {RequiredError}
|
|
2290
2290
|
*/
|
|
2291
|
-
getRawExport(requestParameters:
|
|
2291
|
+
getRawExport(requestParameters: ActionsExportGetRawExportRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
2292
2292
|
/**
|
|
2293
2293
|
* 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.
|
|
2294
2294
|
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
2295
|
-
* @param {
|
|
2295
|
+
* @param {ActionsExportGetSlidesExportRequest} requestParameters Request parameters.
|
|
2296
2296
|
* @param {*} [options] Override http request option.
|
|
2297
2297
|
* @throws {RequiredError}
|
|
2298
2298
|
*/
|
|
2299
|
-
getSlidesExport(requestParameters:
|
|
2299
|
+
getSlidesExport(requestParameters: ActionsExportGetSlidesExportRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
2300
2300
|
/**
|
|
2301
2301
|
* 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.
|
|
2302
2302
|
* @summary (EXPERIMENTAL) Retrieve metadata context
|
|
2303
|
-
* @param {
|
|
2303
|
+
* @param {ActionsExportGetSlidesExportMetadataRequest} requestParameters Request parameters.
|
|
2304
2304
|
* @param {*} [options] Override http request option.
|
|
2305
2305
|
* @throws {RequiredError}
|
|
2306
2306
|
*/
|
|
2307
|
-
getSlidesExportMetadata(requestParameters:
|
|
2307
|
+
getSlidesExportMetadata(requestParameters: ActionsExportGetSlidesExportMetadataRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
2308
2308
|
/**
|
|
2309
2309
|
* 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.
|
|
2310
2310
|
* @summary Retrieve exported files
|
|
2311
|
-
* @param {
|
|
2311
|
+
* @param {ActionsExportGetTabularExportRequest} requestParameters Request parameters.
|
|
2312
2312
|
* @param {*} [options] Override http request option.
|
|
2313
2313
|
* @throws {RequiredError}
|
|
2314
2314
|
*/
|
|
2315
|
-
getTabularExport(requestParameters:
|
|
2315
|
+
getTabularExport(requestParameters: ActionsExportGetTabularExportRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
2316
2316
|
};
|
|
2317
2317
|
/**
|
|
2318
|
-
*
|
|
2318
|
+
* ActionsExport - interface
|
|
2319
2319
|
* @export
|
|
2320
|
-
* @interface
|
|
2320
|
+
* @interface ActionsExport
|
|
2321
2321
|
*/
|
|
2322
|
-
export interface
|
|
2322
|
+
export interface ActionsExportInterface {
|
|
2323
2323
|
/**
|
|
2324
2324
|
* 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.
|
|
2325
2325
|
* @summary (EXPERIMENTAL) Create dashboard tabular export request
|
|
2326
|
-
* @param {
|
|
2326
|
+
* @param {ActionsExportCreateDashboardExportRequestRequest} requestParameters Request parameters.
|
|
2327
2327
|
* @param {*} [options] Override http request option.
|
|
2328
2328
|
* @throws {RequiredError}
|
|
2329
|
-
* @memberof
|
|
2329
|
+
* @memberof ActionsExportInterface
|
|
2330
2330
|
*/
|
|
2331
|
-
createDashboardExportRequest(requestParameters:
|
|
2331
|
+
createDashboardExportRequest(requestParameters: ActionsExportCreateDashboardExportRequestRequest, options?: AxiosRequestConfig): AxiosPromise<ExportExportResponse>;
|
|
2332
2332
|
/**
|
|
2333
2333
|
* 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.
|
|
2334
2334
|
* @summary (EXPERIMENTAL) Create image export request
|
|
2335
|
-
* @param {
|
|
2335
|
+
* @param {ActionsExportCreateImageExportRequest} requestParameters Request parameters.
|
|
2336
2336
|
* @param {*} [options] Override http request option.
|
|
2337
2337
|
* @throws {RequiredError}
|
|
2338
|
-
* @memberof
|
|
2338
|
+
* @memberof ActionsExportInterface
|
|
2339
2339
|
*/
|
|
2340
|
-
createImageExport(requestParameters:
|
|
2340
|
+
createImageExport(requestParameters: ActionsExportCreateImageExportRequest, options?: AxiosRequestConfig): AxiosPromise<ExportExportResponse>;
|
|
2341
2341
|
/**
|
|
2342
2342
|
* 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.
|
|
2343
2343
|
* @summary Create visual - pdf export request
|
|
2344
|
-
* @param {
|
|
2344
|
+
* @param {ActionsExportCreatePdfExportRequest} requestParameters Request parameters.
|
|
2345
2345
|
* @param {*} [options] Override http request option.
|
|
2346
2346
|
* @throws {RequiredError}
|
|
2347
|
-
* @memberof
|
|
2347
|
+
* @memberof ActionsExportInterface
|
|
2348
2348
|
*/
|
|
2349
|
-
createPdfExport(requestParameters:
|
|
2349
|
+
createPdfExport(requestParameters: ActionsExportCreatePdfExportRequest, options?: AxiosRequestConfig): AxiosPromise<ExportExportResponse>;
|
|
2350
2350
|
/**
|
|
2351
2351
|
* 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.
|
|
2352
2352
|
* @summary (EXPERIMENTAL) Create raw export request
|
|
2353
|
-
* @param {
|
|
2353
|
+
* @param {ActionsExportCreateRawExportRequest} requestParameters Request parameters.
|
|
2354
2354
|
* @param {*} [options] Override http request option.
|
|
2355
2355
|
* @throws {RequiredError}
|
|
2356
|
-
* @memberof
|
|
2356
|
+
* @memberof ActionsExportInterface
|
|
2357
2357
|
*/
|
|
2358
|
-
createRawExport(requestParameters:
|
|
2358
|
+
createRawExport(requestParameters: ActionsExportCreateRawExportRequest, options?: AxiosRequestConfig): AxiosPromise<ExportExportResponse>;
|
|
2359
2359
|
/**
|
|
2360
2360
|
* 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.
|
|
2361
2361
|
* @summary (EXPERIMENTAL) Create slides export request
|
|
2362
|
-
* @param {
|
|
2362
|
+
* @param {ActionsExportCreateSlidesExportRequest} requestParameters Request parameters.
|
|
2363
2363
|
* @param {*} [options] Override http request option.
|
|
2364
2364
|
* @throws {RequiredError}
|
|
2365
|
-
* @memberof
|
|
2365
|
+
* @memberof ActionsExportInterface
|
|
2366
2366
|
*/
|
|
2367
|
-
createSlidesExport(requestParameters:
|
|
2367
|
+
createSlidesExport(requestParameters: ActionsExportCreateSlidesExportRequest, options?: AxiosRequestConfig): AxiosPromise<ExportExportResponse>;
|
|
2368
2368
|
/**
|
|
2369
2369
|
* 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.
|
|
2370
2370
|
* @summary Create tabular export request
|
|
2371
|
-
* @param {
|
|
2371
|
+
* @param {ActionsExportCreateTabularExportRequest} requestParameters Request parameters.
|
|
2372
2372
|
* @param {*} [options] Override http request option.
|
|
2373
2373
|
* @throws {RequiredError}
|
|
2374
|
-
* @memberof
|
|
2374
|
+
* @memberof ActionsExportInterface
|
|
2375
2375
|
*/
|
|
2376
|
-
createTabularExport(requestParameters:
|
|
2376
|
+
createTabularExport(requestParameters: ActionsExportCreateTabularExportRequest, options?: AxiosRequestConfig): AxiosPromise<ExportExportResponse>;
|
|
2377
2377
|
/**
|
|
2378
2378
|
* Returns 202 until original POST export request is not processed.Returns 200 with exported data once the export is done.
|
|
2379
2379
|
* @summary Retrieve exported files
|
|
2380
|
-
* @param {
|
|
2380
|
+
* @param {ActionsExportGetExportedFileRequest} requestParameters Request parameters.
|
|
2381
2381
|
* @param {*} [options] Override http request option.
|
|
2382
2382
|
* @throws {RequiredError}
|
|
2383
|
-
* @memberof
|
|
2383
|
+
* @memberof ActionsExportInterface
|
|
2384
2384
|
*/
|
|
2385
|
-
getExportedFile(requestParameters:
|
|
2385
|
+
getExportedFile(requestParameters: ActionsExportGetExportedFileRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
2386
2386
|
/**
|
|
2387
2387
|
* 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.
|
|
2388
2388
|
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
2389
|
-
* @param {
|
|
2389
|
+
* @param {ActionsExportGetImageExportRequest} requestParameters Request parameters.
|
|
2390
2390
|
* @param {*} [options] Override http request option.
|
|
2391
2391
|
* @throws {RequiredError}
|
|
2392
|
-
* @memberof
|
|
2392
|
+
* @memberof ActionsExportInterface
|
|
2393
2393
|
*/
|
|
2394
|
-
getImageExport(requestParameters:
|
|
2394
|
+
getImageExport(requestParameters: ActionsExportGetImageExportRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
2395
2395
|
/**
|
|
2396
2396
|
* 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.
|
|
2397
2397
|
* @summary (EXPERIMENTAL) Retrieve metadata context
|
|
2398
|
-
* @param {
|
|
2398
|
+
* @param {ActionsExportGetImageExportMetadataRequest} requestParameters Request parameters.
|
|
2399
2399
|
* @param {*} [options] Override http request option.
|
|
2400
2400
|
* @throws {RequiredError}
|
|
2401
|
-
* @memberof
|
|
2401
|
+
* @memberof ActionsExportInterface
|
|
2402
2402
|
*/
|
|
2403
|
-
getImageExportMetadata(requestParameters:
|
|
2403
|
+
getImageExportMetadata(requestParameters: ActionsExportGetImageExportMetadataRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
2404
2404
|
/**
|
|
2405
2405
|
* 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.
|
|
2406
2406
|
* @summary Retrieve metadata context
|
|
2407
|
-
* @param {
|
|
2407
|
+
* @param {ActionsExportGetMetadataRequest} requestParameters Request parameters.
|
|
2408
2408
|
* @param {*} [options] Override http request option.
|
|
2409
2409
|
* @throws {RequiredError}
|
|
2410
|
-
* @memberof
|
|
2410
|
+
* @memberof ActionsExportInterface
|
|
2411
2411
|
*/
|
|
2412
|
-
getMetadata(requestParameters:
|
|
2412
|
+
getMetadata(requestParameters: ActionsExportGetMetadataRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
2413
2413
|
/**
|
|
2414
2414
|
* 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.
|
|
2415
2415
|
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
2416
|
-
* @param {
|
|
2416
|
+
* @param {ActionsExportGetRawExportRequest} requestParameters Request parameters.
|
|
2417
2417
|
* @param {*} [options] Override http request option.
|
|
2418
2418
|
* @throws {RequiredError}
|
|
2419
|
-
* @memberof
|
|
2419
|
+
* @memberof ActionsExportInterface
|
|
2420
2420
|
*/
|
|
2421
|
-
getRawExport(requestParameters:
|
|
2421
|
+
getRawExport(requestParameters: ActionsExportGetRawExportRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
2422
2422
|
/**
|
|
2423
2423
|
* 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.
|
|
2424
2424
|
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
2425
|
-
* @param {
|
|
2425
|
+
* @param {ActionsExportGetSlidesExportRequest} requestParameters Request parameters.
|
|
2426
2426
|
* @param {*} [options] Override http request option.
|
|
2427
2427
|
* @throws {RequiredError}
|
|
2428
|
-
* @memberof
|
|
2428
|
+
* @memberof ActionsExportInterface
|
|
2429
2429
|
*/
|
|
2430
|
-
getSlidesExport(requestParameters:
|
|
2430
|
+
getSlidesExport(requestParameters: ActionsExportGetSlidesExportRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
2431
2431
|
/**
|
|
2432
2432
|
* 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.
|
|
2433
2433
|
* @summary (EXPERIMENTAL) Retrieve metadata context
|
|
2434
|
-
* @param {
|
|
2434
|
+
* @param {ActionsExportGetSlidesExportMetadataRequest} requestParameters Request parameters.
|
|
2435
2435
|
* @param {*} [options] Override http request option.
|
|
2436
2436
|
* @throws {RequiredError}
|
|
2437
|
-
* @memberof
|
|
2437
|
+
* @memberof ActionsExportInterface
|
|
2438
2438
|
*/
|
|
2439
|
-
getSlidesExportMetadata(requestParameters:
|
|
2439
|
+
getSlidesExportMetadata(requestParameters: ActionsExportGetSlidesExportMetadataRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
2440
2440
|
/**
|
|
2441
2441
|
* 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.
|
|
2442
2442
|
* @summary Retrieve exported files
|
|
2443
|
-
* @param {
|
|
2443
|
+
* @param {ActionsExportGetTabularExportRequest} requestParameters Request parameters.
|
|
2444
2444
|
* @param {*} [options] Override http request option.
|
|
2445
2445
|
* @throws {RequiredError}
|
|
2446
|
-
* @memberof
|
|
2446
|
+
* @memberof ActionsExportInterface
|
|
2447
2447
|
*/
|
|
2448
|
-
getTabularExport(requestParameters:
|
|
2448
|
+
getTabularExport(requestParameters: ActionsExportGetTabularExportRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
2449
2449
|
}
|
|
2450
2450
|
/**
|
|
2451
|
-
* Request parameters for createDashboardExportRequest operation in
|
|
2451
|
+
* Request parameters for createDashboardExportRequest operation in ActionsExport.
|
|
2452
2452
|
* @export
|
|
2453
|
-
* @interface
|
|
2453
|
+
* @interface ActionsExportCreateDashboardExportRequestRequest
|
|
2454
2454
|
*/
|
|
2455
|
-
export interface
|
|
2455
|
+
export interface ActionsExportCreateDashboardExportRequestRequest {
|
|
2456
2456
|
/**
|
|
2457
2457
|
*
|
|
2458
2458
|
* @type {string}
|
|
2459
|
-
* @memberof
|
|
2459
|
+
* @memberof ActionsExportCreateDashboardExportRequest
|
|
2460
2460
|
*/
|
|
2461
2461
|
readonly workspaceId: string;
|
|
2462
2462
|
/**
|
|
2463
2463
|
*
|
|
2464
2464
|
* @type {string}
|
|
2465
|
-
* @memberof
|
|
2465
|
+
* @memberof ActionsExportCreateDashboardExportRequest
|
|
2466
2466
|
*/
|
|
2467
2467
|
readonly dashboardId: string;
|
|
2468
2468
|
/**
|
|
2469
2469
|
*
|
|
2470
|
-
* @type {
|
|
2471
|
-
* @memberof
|
|
2470
|
+
* @type {ExportDashboardTabularExportRequest}
|
|
2471
|
+
* @memberof ActionsExportCreateDashboardExportRequest
|
|
2472
2472
|
*/
|
|
2473
|
-
readonly
|
|
2473
|
+
readonly exportDashboardTabularExportRequest: ExportDashboardTabularExportRequest;
|
|
2474
2474
|
}
|
|
2475
2475
|
/**
|
|
2476
|
-
* Request parameters for createImageExport operation in
|
|
2476
|
+
* Request parameters for createImageExport operation in ActionsExport.
|
|
2477
2477
|
* @export
|
|
2478
|
-
* @interface
|
|
2478
|
+
* @interface ActionsExportCreateImageExportRequest
|
|
2479
2479
|
*/
|
|
2480
|
-
export interface
|
|
2480
|
+
export interface ActionsExportCreateImageExportRequest {
|
|
2481
2481
|
/**
|
|
2482
2482
|
*
|
|
2483
2483
|
* @type {string}
|
|
2484
|
-
* @memberof
|
|
2484
|
+
* @memberof ActionsExportCreateImageExport
|
|
2485
2485
|
*/
|
|
2486
2486
|
readonly workspaceId: string;
|
|
2487
2487
|
/**
|
|
2488
2488
|
*
|
|
2489
|
-
* @type {
|
|
2490
|
-
* @memberof
|
|
2489
|
+
* @type {ExportImageExportRequest}
|
|
2490
|
+
* @memberof ActionsExportCreateImageExport
|
|
2491
2491
|
*/
|
|
2492
|
-
readonly
|
|
2492
|
+
readonly exportImageExportRequest: ExportImageExportRequest;
|
|
2493
2493
|
}
|
|
2494
2494
|
/**
|
|
2495
|
-
* Request parameters for createPdfExport operation in
|
|
2495
|
+
* Request parameters for createPdfExport operation in ActionsExport.
|
|
2496
2496
|
* @export
|
|
2497
|
-
* @interface
|
|
2497
|
+
* @interface ActionsExportCreatePdfExportRequest
|
|
2498
2498
|
*/
|
|
2499
|
-
export interface
|
|
2499
|
+
export interface ActionsExportCreatePdfExportRequest {
|
|
2500
2500
|
/**
|
|
2501
2501
|
*
|
|
2502
2502
|
* @type {string}
|
|
2503
|
-
* @memberof
|
|
2503
|
+
* @memberof ActionsExportCreatePdfExport
|
|
2504
2504
|
*/
|
|
2505
2505
|
readonly workspaceId: string;
|
|
2506
2506
|
/**
|
|
2507
2507
|
*
|
|
2508
|
-
* @type {
|
|
2509
|
-
* @memberof
|
|
2508
|
+
* @type {ExportVisualExportRequest}
|
|
2509
|
+
* @memberof ActionsExportCreatePdfExport
|
|
2510
2510
|
*/
|
|
2511
|
-
readonly
|
|
2511
|
+
readonly exportVisualExportRequest: ExportVisualExportRequest;
|
|
2512
2512
|
}
|
|
2513
2513
|
/**
|
|
2514
|
-
* Request parameters for createRawExport operation in
|
|
2514
|
+
* Request parameters for createRawExport operation in ActionsExport.
|
|
2515
2515
|
* @export
|
|
2516
|
-
* @interface
|
|
2516
|
+
* @interface ActionsExportCreateRawExportRequest
|
|
2517
2517
|
*/
|
|
2518
|
-
export interface
|
|
2518
|
+
export interface ActionsExportCreateRawExportRequest {
|
|
2519
2519
|
/**
|
|
2520
2520
|
*
|
|
2521
2521
|
* @type {string}
|
|
2522
|
-
* @memberof
|
|
2522
|
+
* @memberof ActionsExportCreateRawExport
|
|
2523
2523
|
*/
|
|
2524
2524
|
readonly workspaceId: string;
|
|
2525
2525
|
/**
|
|
2526
2526
|
*
|
|
2527
|
-
* @type {
|
|
2528
|
-
* @memberof
|
|
2527
|
+
* @type {ExportRawExportRequest}
|
|
2528
|
+
* @memberof ActionsExportCreateRawExport
|
|
2529
2529
|
*/
|
|
2530
|
-
readonly
|
|
2530
|
+
readonly exportRawExportRequest: ExportRawExportRequest;
|
|
2531
2531
|
}
|
|
2532
2532
|
/**
|
|
2533
|
-
* Request parameters for createSlidesExport operation in
|
|
2533
|
+
* Request parameters for createSlidesExport operation in ActionsExport.
|
|
2534
2534
|
* @export
|
|
2535
|
-
* @interface
|
|
2535
|
+
* @interface ActionsExportCreateSlidesExportRequest
|
|
2536
2536
|
*/
|
|
2537
|
-
export interface
|
|
2537
|
+
export interface ActionsExportCreateSlidesExportRequest {
|
|
2538
2538
|
/**
|
|
2539
2539
|
*
|
|
2540
2540
|
* @type {string}
|
|
2541
|
-
* @memberof
|
|
2541
|
+
* @memberof ActionsExportCreateSlidesExport
|
|
2542
2542
|
*/
|
|
2543
2543
|
readonly workspaceId: string;
|
|
2544
2544
|
/**
|
|
2545
2545
|
*
|
|
2546
|
-
* @type {
|
|
2547
|
-
* @memberof
|
|
2546
|
+
* @type {ExportSlidesExportRequest}
|
|
2547
|
+
* @memberof ActionsExportCreateSlidesExport
|
|
2548
2548
|
*/
|
|
2549
|
-
readonly
|
|
2549
|
+
readonly exportSlidesExportRequest: ExportSlidesExportRequest;
|
|
2550
2550
|
}
|
|
2551
2551
|
/**
|
|
2552
|
-
* Request parameters for createTabularExport operation in
|
|
2552
|
+
* Request parameters for createTabularExport operation in ActionsExport.
|
|
2553
2553
|
* @export
|
|
2554
|
-
* @interface
|
|
2554
|
+
* @interface ActionsExportCreateTabularExportRequest
|
|
2555
2555
|
*/
|
|
2556
|
-
export interface
|
|
2556
|
+
export interface ActionsExportCreateTabularExportRequest {
|
|
2557
2557
|
/**
|
|
2558
2558
|
*
|
|
2559
2559
|
* @type {string}
|
|
2560
|
-
* @memberof
|
|
2560
|
+
* @memberof ActionsExportCreateTabularExport
|
|
2561
2561
|
*/
|
|
2562
2562
|
readonly workspaceId: string;
|
|
2563
2563
|
/**
|
|
2564
2564
|
*
|
|
2565
|
-
* @type {
|
|
2566
|
-
* @memberof
|
|
2565
|
+
* @type {ExportTabularExportRequest}
|
|
2566
|
+
* @memberof ActionsExportCreateTabularExport
|
|
2567
2567
|
*/
|
|
2568
|
-
readonly
|
|
2568
|
+
readonly exportTabularExportRequest: ExportTabularExportRequest;
|
|
2569
2569
|
}
|
|
2570
2570
|
/**
|
|
2571
|
-
* Request parameters for getExportedFile operation in
|
|
2571
|
+
* Request parameters for getExportedFile operation in ActionsExport.
|
|
2572
2572
|
* @export
|
|
2573
|
-
* @interface
|
|
2573
|
+
* @interface ActionsExportGetExportedFileRequest
|
|
2574
2574
|
*/
|
|
2575
|
-
export interface
|
|
2575
|
+
export interface ActionsExportGetExportedFileRequest {
|
|
2576
2576
|
/**
|
|
2577
2577
|
*
|
|
2578
2578
|
* @type {string}
|
|
2579
|
-
* @memberof
|
|
2579
|
+
* @memberof ActionsExportGetExportedFile
|
|
2580
2580
|
*/
|
|
2581
2581
|
readonly workspaceId: string;
|
|
2582
2582
|
/**
|
|
2583
2583
|
*
|
|
2584
2584
|
* @type {string}
|
|
2585
|
-
* @memberof
|
|
2585
|
+
* @memberof ActionsExportGetExportedFile
|
|
2586
2586
|
*/
|
|
2587
2587
|
readonly exportId: string;
|
|
2588
2588
|
}
|
|
2589
2589
|
/**
|
|
2590
|
-
* Request parameters for getImageExport operation in
|
|
2590
|
+
* Request parameters for getImageExport operation in ActionsExport.
|
|
2591
2591
|
* @export
|
|
2592
|
-
* @interface
|
|
2592
|
+
* @interface ActionsExportGetImageExportRequest
|
|
2593
2593
|
*/
|
|
2594
|
-
export interface
|
|
2594
|
+
export interface ActionsExportGetImageExportRequest {
|
|
2595
2595
|
/**
|
|
2596
2596
|
*
|
|
2597
2597
|
* @type {string}
|
|
2598
|
-
* @memberof
|
|
2598
|
+
* @memberof ActionsExportGetImageExport
|
|
2599
2599
|
*/
|
|
2600
2600
|
readonly workspaceId: string;
|
|
2601
2601
|
/**
|
|
2602
2602
|
*
|
|
2603
2603
|
* @type {string}
|
|
2604
|
-
* @memberof
|
|
2604
|
+
* @memberof ActionsExportGetImageExport
|
|
2605
2605
|
*/
|
|
2606
2606
|
readonly exportId: string;
|
|
2607
2607
|
}
|
|
2608
2608
|
/**
|
|
2609
|
-
* Request parameters for getImageExportMetadata operation in
|
|
2609
|
+
* Request parameters for getImageExportMetadata operation in ActionsExport.
|
|
2610
2610
|
* @export
|
|
2611
|
-
* @interface
|
|
2611
|
+
* @interface ActionsExportGetImageExportMetadataRequest
|
|
2612
2612
|
*/
|
|
2613
|
-
export interface
|
|
2613
|
+
export interface ActionsExportGetImageExportMetadataRequest {
|
|
2614
2614
|
/**
|
|
2615
2615
|
*
|
|
2616
2616
|
* @type {string}
|
|
2617
|
-
* @memberof
|
|
2617
|
+
* @memberof ActionsExportGetImageExportMetadata
|
|
2618
2618
|
*/
|
|
2619
2619
|
readonly workspaceId: string;
|
|
2620
2620
|
/**
|
|
2621
2621
|
*
|
|
2622
2622
|
* @type {string}
|
|
2623
|
-
* @memberof
|
|
2623
|
+
* @memberof ActionsExportGetImageExportMetadata
|
|
2624
2624
|
*/
|
|
2625
2625
|
readonly exportId: string;
|
|
2626
2626
|
}
|
|
2627
2627
|
/**
|
|
2628
|
-
* Request parameters for getMetadata operation in
|
|
2628
|
+
* Request parameters for getMetadata operation in ActionsExport.
|
|
2629
2629
|
* @export
|
|
2630
|
-
* @interface
|
|
2630
|
+
* @interface ActionsExportGetMetadataRequest
|
|
2631
2631
|
*/
|
|
2632
|
-
export interface
|
|
2632
|
+
export interface ActionsExportGetMetadataRequest {
|
|
2633
2633
|
/**
|
|
2634
2634
|
*
|
|
2635
2635
|
* @type {string}
|
|
2636
|
-
* @memberof
|
|
2636
|
+
* @memberof ActionsExportGetMetadata
|
|
2637
2637
|
*/
|
|
2638
2638
|
readonly workspaceId: string;
|
|
2639
2639
|
/**
|
|
2640
2640
|
*
|
|
2641
2641
|
* @type {string}
|
|
2642
|
-
* @memberof
|
|
2642
|
+
* @memberof ActionsExportGetMetadata
|
|
2643
2643
|
*/
|
|
2644
2644
|
readonly exportId: string;
|
|
2645
2645
|
}
|
|
2646
2646
|
/**
|
|
2647
|
-
* Request parameters for getRawExport operation in
|
|
2647
|
+
* Request parameters for getRawExport operation in ActionsExport.
|
|
2648
2648
|
* @export
|
|
2649
|
-
* @interface
|
|
2649
|
+
* @interface ActionsExportGetRawExportRequest
|
|
2650
2650
|
*/
|
|
2651
|
-
export interface
|
|
2651
|
+
export interface ActionsExportGetRawExportRequest {
|
|
2652
2652
|
/**
|
|
2653
2653
|
*
|
|
2654
2654
|
* @type {string}
|
|
2655
|
-
* @memberof
|
|
2655
|
+
* @memberof ActionsExportGetRawExport
|
|
2656
2656
|
*/
|
|
2657
2657
|
readonly workspaceId: string;
|
|
2658
2658
|
/**
|
|
2659
2659
|
*
|
|
2660
2660
|
* @type {string}
|
|
2661
|
-
* @memberof
|
|
2661
|
+
* @memberof ActionsExportGetRawExport
|
|
2662
2662
|
*/
|
|
2663
2663
|
readonly exportId: string;
|
|
2664
2664
|
}
|
|
2665
2665
|
/**
|
|
2666
|
-
* Request parameters for getSlidesExport operation in
|
|
2666
|
+
* Request parameters for getSlidesExport operation in ActionsExport.
|
|
2667
2667
|
* @export
|
|
2668
|
-
* @interface
|
|
2668
|
+
* @interface ActionsExportGetSlidesExportRequest
|
|
2669
2669
|
*/
|
|
2670
|
-
export interface
|
|
2670
|
+
export interface ActionsExportGetSlidesExportRequest {
|
|
2671
2671
|
/**
|
|
2672
2672
|
*
|
|
2673
2673
|
* @type {string}
|
|
2674
|
-
* @memberof
|
|
2674
|
+
* @memberof ActionsExportGetSlidesExport
|
|
2675
2675
|
*/
|
|
2676
2676
|
readonly workspaceId: string;
|
|
2677
2677
|
/**
|
|
2678
2678
|
*
|
|
2679
2679
|
* @type {string}
|
|
2680
|
-
* @memberof
|
|
2680
|
+
* @memberof ActionsExportGetSlidesExport
|
|
2681
2681
|
*/
|
|
2682
2682
|
readonly exportId: string;
|
|
2683
2683
|
}
|
|
2684
2684
|
/**
|
|
2685
|
-
* Request parameters for getSlidesExportMetadata operation in
|
|
2685
|
+
* Request parameters for getSlidesExportMetadata operation in ActionsExport.
|
|
2686
2686
|
* @export
|
|
2687
|
-
* @interface
|
|
2687
|
+
* @interface ActionsExportGetSlidesExportMetadataRequest
|
|
2688
2688
|
*/
|
|
2689
|
-
export interface
|
|
2689
|
+
export interface ActionsExportGetSlidesExportMetadataRequest {
|
|
2690
2690
|
/**
|
|
2691
2691
|
*
|
|
2692
2692
|
* @type {string}
|
|
2693
|
-
* @memberof
|
|
2693
|
+
* @memberof ActionsExportGetSlidesExportMetadata
|
|
2694
2694
|
*/
|
|
2695
2695
|
readonly workspaceId: string;
|
|
2696
2696
|
/**
|
|
2697
2697
|
*
|
|
2698
2698
|
* @type {string}
|
|
2699
|
-
* @memberof
|
|
2699
|
+
* @memberof ActionsExportGetSlidesExportMetadata
|
|
2700
2700
|
*/
|
|
2701
2701
|
readonly exportId: string;
|
|
2702
2702
|
}
|
|
2703
2703
|
/**
|
|
2704
|
-
* Request parameters for getTabularExport operation in
|
|
2704
|
+
* Request parameters for getTabularExport operation in ActionsExport.
|
|
2705
2705
|
* @export
|
|
2706
|
-
* @interface
|
|
2706
|
+
* @interface ActionsExportGetTabularExportRequest
|
|
2707
2707
|
*/
|
|
2708
|
-
export interface
|
|
2708
|
+
export interface ActionsExportGetTabularExportRequest {
|
|
2709
2709
|
/**
|
|
2710
2710
|
*
|
|
2711
2711
|
* @type {string}
|
|
2712
|
-
* @memberof
|
|
2712
|
+
* @memberof ActionsExportGetTabularExport
|
|
2713
2713
|
*/
|
|
2714
2714
|
readonly workspaceId: string;
|
|
2715
2715
|
/**
|
|
2716
2716
|
*
|
|
2717
2717
|
* @type {string}
|
|
2718
|
-
* @memberof
|
|
2718
|
+
* @memberof ActionsExportGetTabularExport
|
|
2719
2719
|
*/
|
|
2720
2720
|
readonly exportId: string;
|
|
2721
2721
|
}
|
|
2722
2722
|
/**
|
|
2723
|
-
*
|
|
2723
|
+
* ActionsExport - object-oriented interface
|
|
2724
2724
|
* @export
|
|
2725
|
-
* @class
|
|
2725
|
+
* @class ActionsExport
|
|
2726
2726
|
* @extends {BaseAPI}
|
|
2727
2727
|
*/
|
|
2728
|
-
export declare class
|
|
2728
|
+
export declare class ActionsExport extends BaseAPI implements ActionsExportInterface {
|
|
2729
2729
|
/**
|
|
2730
2730
|
* 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.
|
|
2731
2731
|
* @summary (EXPERIMENTAL) Create dashboard tabular export request
|
|
2732
|
-
* @param {
|
|
2732
|
+
* @param {ActionsExportCreateDashboardExportRequestRequest} requestParameters Request parameters.
|
|
2733
2733
|
* @param {*} [options] Override http request option.
|
|
2734
2734
|
* @throws {RequiredError}
|
|
2735
|
-
* @memberof
|
|
2735
|
+
* @memberof ActionsExport
|
|
2736
2736
|
*/
|
|
2737
|
-
createDashboardExportRequest(requestParameters:
|
|
2737
|
+
createDashboardExportRequest(requestParameters: ActionsExportCreateDashboardExportRequestRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ExportExportResponse, any>>;
|
|
2738
2738
|
/**
|
|
2739
2739
|
* 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.
|
|
2740
2740
|
* @summary (EXPERIMENTAL) Create image export request
|
|
2741
|
-
* @param {
|
|
2741
|
+
* @param {ActionsExportCreateImageExportRequest} requestParameters Request parameters.
|
|
2742
2742
|
* @param {*} [options] Override http request option.
|
|
2743
2743
|
* @throws {RequiredError}
|
|
2744
|
-
* @memberof
|
|
2744
|
+
* @memberof ActionsExport
|
|
2745
2745
|
*/
|
|
2746
|
-
createImageExport(requestParameters:
|
|
2746
|
+
createImageExport(requestParameters: ActionsExportCreateImageExportRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ExportExportResponse, any>>;
|
|
2747
2747
|
/**
|
|
2748
2748
|
* 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.
|
|
2749
2749
|
* @summary Create visual - pdf export request
|
|
2750
|
-
* @param {
|
|
2750
|
+
* @param {ActionsExportCreatePdfExportRequest} requestParameters Request parameters.
|
|
2751
2751
|
* @param {*} [options] Override http request option.
|
|
2752
2752
|
* @throws {RequiredError}
|
|
2753
|
-
* @memberof
|
|
2753
|
+
* @memberof ActionsExport
|
|
2754
2754
|
*/
|
|
2755
|
-
createPdfExport(requestParameters:
|
|
2755
|
+
createPdfExport(requestParameters: ActionsExportCreatePdfExportRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ExportExportResponse, any>>;
|
|
2756
2756
|
/**
|
|
2757
2757
|
* 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.
|
|
2758
2758
|
* @summary (EXPERIMENTAL) Create raw export request
|
|
2759
|
-
* @param {
|
|
2759
|
+
* @param {ActionsExportCreateRawExportRequest} requestParameters Request parameters.
|
|
2760
2760
|
* @param {*} [options] Override http request option.
|
|
2761
2761
|
* @throws {RequiredError}
|
|
2762
|
-
* @memberof
|
|
2762
|
+
* @memberof ActionsExport
|
|
2763
2763
|
*/
|
|
2764
|
-
createRawExport(requestParameters:
|
|
2764
|
+
createRawExport(requestParameters: ActionsExportCreateRawExportRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ExportExportResponse, any>>;
|
|
2765
2765
|
/**
|
|
2766
2766
|
* 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.
|
|
2767
2767
|
* @summary (EXPERIMENTAL) Create slides export request
|
|
2768
|
-
* @param {
|
|
2768
|
+
* @param {ActionsExportCreateSlidesExportRequest} requestParameters Request parameters.
|
|
2769
2769
|
* @param {*} [options] Override http request option.
|
|
2770
2770
|
* @throws {RequiredError}
|
|
2771
|
-
* @memberof
|
|
2771
|
+
* @memberof ActionsExport
|
|
2772
2772
|
*/
|
|
2773
|
-
createSlidesExport(requestParameters:
|
|
2773
|
+
createSlidesExport(requestParameters: ActionsExportCreateSlidesExportRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ExportExportResponse, any>>;
|
|
2774
2774
|
/**
|
|
2775
2775
|
* 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.
|
|
2776
2776
|
* @summary Create tabular export request
|
|
2777
|
-
* @param {
|
|
2777
|
+
* @param {ActionsExportCreateTabularExportRequest} requestParameters Request parameters.
|
|
2778
2778
|
* @param {*} [options] Override http request option.
|
|
2779
2779
|
* @throws {RequiredError}
|
|
2780
|
-
* @memberof
|
|
2780
|
+
* @memberof ActionsExport
|
|
2781
2781
|
*/
|
|
2782
|
-
createTabularExport(requestParameters:
|
|
2782
|
+
createTabularExport(requestParameters: ActionsExportCreateTabularExportRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ExportExportResponse, any>>;
|
|
2783
2783
|
/**
|
|
2784
2784
|
* Returns 202 until original POST export request is not processed.Returns 200 with exported data once the export is done.
|
|
2785
2785
|
* @summary Retrieve exported files
|
|
2786
|
-
* @param {
|
|
2786
|
+
* @param {ActionsExportGetExportedFileRequest} requestParameters Request parameters.
|
|
2787
2787
|
* @param {*} [options] Override http request option.
|
|
2788
2788
|
* @throws {RequiredError}
|
|
2789
|
-
* @memberof
|
|
2789
|
+
* @memberof ActionsExport
|
|
2790
2790
|
*/
|
|
2791
|
-
getExportedFile(requestParameters:
|
|
2791
|
+
getExportedFile(requestParameters: ActionsExportGetExportedFileRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
2792
2792
|
/**
|
|
2793
2793
|
* 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.
|
|
2794
2794
|
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
2795
|
-
* @param {
|
|
2795
|
+
* @param {ActionsExportGetImageExportRequest} requestParameters Request parameters.
|
|
2796
2796
|
* @param {*} [options] Override http request option.
|
|
2797
2797
|
* @throws {RequiredError}
|
|
2798
|
-
* @memberof
|
|
2798
|
+
* @memberof ActionsExport
|
|
2799
2799
|
*/
|
|
2800
|
-
getImageExport(requestParameters:
|
|
2800
|
+
getImageExport(requestParameters: ActionsExportGetImageExportRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
2801
2801
|
/**
|
|
2802
2802
|
* 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.
|
|
2803
2803
|
* @summary (EXPERIMENTAL) Retrieve metadata context
|
|
2804
|
-
* @param {
|
|
2804
|
+
* @param {ActionsExportGetImageExportMetadataRequest} requestParameters Request parameters.
|
|
2805
2805
|
* @param {*} [options] Override http request option.
|
|
2806
2806
|
* @throws {RequiredError}
|
|
2807
|
-
* @memberof
|
|
2807
|
+
* @memberof ActionsExport
|
|
2808
2808
|
*/
|
|
2809
|
-
getImageExportMetadata(requestParameters:
|
|
2809
|
+
getImageExportMetadata(requestParameters: ActionsExportGetImageExportMetadataRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
2810
2810
|
/**
|
|
2811
2811
|
* 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.
|
|
2812
2812
|
* @summary Retrieve metadata context
|
|
2813
|
-
* @param {
|
|
2813
|
+
* @param {ActionsExportGetMetadataRequest} requestParameters Request parameters.
|
|
2814
2814
|
* @param {*} [options] Override http request option.
|
|
2815
2815
|
* @throws {RequiredError}
|
|
2816
|
-
* @memberof
|
|
2816
|
+
* @memberof ActionsExport
|
|
2817
2817
|
*/
|
|
2818
|
-
getMetadata(requestParameters:
|
|
2818
|
+
getMetadata(requestParameters: ActionsExportGetMetadataRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
2819
2819
|
/**
|
|
2820
2820
|
* 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.
|
|
2821
2821
|
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
2822
|
-
* @param {
|
|
2822
|
+
* @param {ActionsExportGetRawExportRequest} requestParameters Request parameters.
|
|
2823
2823
|
* @param {*} [options] Override http request option.
|
|
2824
2824
|
* @throws {RequiredError}
|
|
2825
|
-
* @memberof
|
|
2825
|
+
* @memberof ActionsExport
|
|
2826
2826
|
*/
|
|
2827
|
-
getRawExport(requestParameters:
|
|
2827
|
+
getRawExport(requestParameters: ActionsExportGetRawExportRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
2828
2828
|
/**
|
|
2829
2829
|
* 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.
|
|
2830
2830
|
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
2831
|
-
* @param {
|
|
2831
|
+
* @param {ActionsExportGetSlidesExportRequest} requestParameters Request parameters.
|
|
2832
2832
|
* @param {*} [options] Override http request option.
|
|
2833
2833
|
* @throws {RequiredError}
|
|
2834
|
-
* @memberof
|
|
2834
|
+
* @memberof ActionsExport
|
|
2835
2835
|
*/
|
|
2836
|
-
getSlidesExport(requestParameters:
|
|
2836
|
+
getSlidesExport(requestParameters: ActionsExportGetSlidesExportRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
2837
2837
|
/**
|
|
2838
2838
|
* 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.
|
|
2839
2839
|
* @summary (EXPERIMENTAL) Retrieve metadata context
|
|
2840
|
-
* @param {
|
|
2840
|
+
* @param {ActionsExportGetSlidesExportMetadataRequest} requestParameters Request parameters.
|
|
2841
2841
|
* @param {*} [options] Override http request option.
|
|
2842
2842
|
* @throws {RequiredError}
|
|
2843
|
-
* @memberof
|
|
2843
|
+
* @memberof ActionsExport
|
|
2844
2844
|
*/
|
|
2845
|
-
getSlidesExportMetadata(requestParameters:
|
|
2845
|
+
getSlidesExportMetadata(requestParameters: ActionsExportGetSlidesExportMetadataRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
2846
2846
|
/**
|
|
2847
2847
|
* 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.
|
|
2848
2848
|
* @summary Retrieve exported files
|
|
2849
|
-
* @param {
|
|
2849
|
+
* @param {ActionsExportGetTabularExportRequest} requestParameters Request parameters.
|
|
2850
2850
|
* @param {*} [options] Override http request option.
|
|
2851
2851
|
* @throws {RequiredError}
|
|
2852
|
-
* @memberof
|
|
2852
|
+
* @memberof ActionsExport
|
|
2853
2853
|
*/
|
|
2854
|
-
getTabularExport(requestParameters:
|
|
2854
|
+
getTabularExport(requestParameters: ActionsExportGetTabularExportRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
2855
2855
|
}
|
|
2856
2856
|
/**
|
|
2857
|
-
*
|
|
2857
|
+
* ImageExportExport - axios parameter creator
|
|
2858
2858
|
* @export
|
|
2859
2859
|
*/
|
|
2860
|
-
export declare const
|
|
2860
|
+
export declare const ImageExportExportAxiosParamCreator: (configuration?: Configuration) => {
|
|
2861
2861
|
/**
|
|
2862
2862
|
* 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.
|
|
2863
2863
|
* @summary (EXPERIMENTAL) Create image export request
|
|
2864
2864
|
* @param {string} workspaceId
|
|
2865
|
-
* @param {
|
|
2865
|
+
* @param {ExportImageExportRequest} exportImageExportRequest
|
|
2866
2866
|
* @param {*} [options] Override http request option.
|
|
2867
2867
|
* @throws {RequiredError}
|
|
2868
2868
|
*/
|
|
2869
|
-
createImageExport: (workspaceId: string,
|
|
2869
|
+
createImageExport: (workspaceId: string, exportImageExportRequest: ExportImageExportRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
2870
2870
|
/**
|
|
2871
2871
|
* 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.
|
|
2872
2872
|
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
@@ -2887,19 +2887,19 @@ export declare const ImageExportApiAxiosParamCreator: (configuration?: Configura
|
|
|
2887
2887
|
getImageExportMetadata: (workspaceId: string, exportId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
2888
2888
|
};
|
|
2889
2889
|
/**
|
|
2890
|
-
*
|
|
2890
|
+
* ImageExportExport - functional programming interface
|
|
2891
2891
|
* @export
|
|
2892
2892
|
*/
|
|
2893
|
-
export declare const
|
|
2893
|
+
export declare const ImageExportExportFp: (configuration?: Configuration) => {
|
|
2894
2894
|
/**
|
|
2895
2895
|
* 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.
|
|
2896
2896
|
* @summary (EXPERIMENTAL) Create image export request
|
|
2897
2897
|
* @param {string} workspaceId
|
|
2898
|
-
* @param {
|
|
2898
|
+
* @param {ExportImageExportRequest} exportImageExportRequest
|
|
2899
2899
|
* @param {*} [options] Override http request option.
|
|
2900
2900
|
* @throws {RequiredError}
|
|
2901
2901
|
*/
|
|
2902
|
-
createImageExport(workspaceId: string,
|
|
2902
|
+
createImageExport(workspaceId: string, exportImageExportRequest: ExportImageExportRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExportExportResponse>>;
|
|
2903
2903
|
/**
|
|
2904
2904
|
* 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.
|
|
2905
2905
|
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
@@ -2920,175 +2920,175 @@ export declare const ImageExportApiFp: (configuration?: Configuration) => {
|
|
|
2920
2920
|
getImageExportMetadata(workspaceId: string, exportId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
2921
2921
|
};
|
|
2922
2922
|
/**
|
|
2923
|
-
*
|
|
2923
|
+
* ImageExportExport - factory interface
|
|
2924
2924
|
* @export
|
|
2925
2925
|
*/
|
|
2926
|
-
export declare const
|
|
2926
|
+
export declare const ImageExportExportFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
2927
2927
|
/**
|
|
2928
2928
|
* 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.
|
|
2929
2929
|
* @summary (EXPERIMENTAL) Create image export request
|
|
2930
|
-
* @param {
|
|
2930
|
+
* @param {ImageExportExportCreateImageExportRequest} requestParameters Request parameters.
|
|
2931
2931
|
* @param {*} [options] Override http request option.
|
|
2932
2932
|
* @throws {RequiredError}
|
|
2933
2933
|
*/
|
|
2934
|
-
createImageExport(requestParameters:
|
|
2934
|
+
createImageExport(requestParameters: ImageExportExportCreateImageExportRequest, options?: AxiosRequestConfig): AxiosPromise<ExportExportResponse>;
|
|
2935
2935
|
/**
|
|
2936
2936
|
* 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.
|
|
2937
2937
|
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
2938
|
-
* @param {
|
|
2938
|
+
* @param {ImageExportExportGetImageExportRequest} requestParameters Request parameters.
|
|
2939
2939
|
* @param {*} [options] Override http request option.
|
|
2940
2940
|
* @throws {RequiredError}
|
|
2941
2941
|
*/
|
|
2942
|
-
getImageExport(requestParameters:
|
|
2942
|
+
getImageExport(requestParameters: ImageExportExportGetImageExportRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
2943
2943
|
/**
|
|
2944
2944
|
* 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.
|
|
2945
2945
|
* @summary (EXPERIMENTAL) Retrieve metadata context
|
|
2946
|
-
* @param {
|
|
2946
|
+
* @param {ImageExportExportGetImageExportMetadataRequest} requestParameters Request parameters.
|
|
2947
2947
|
* @param {*} [options] Override http request option.
|
|
2948
2948
|
* @throws {RequiredError}
|
|
2949
2949
|
*/
|
|
2950
|
-
getImageExportMetadata(requestParameters:
|
|
2950
|
+
getImageExportMetadata(requestParameters: ImageExportExportGetImageExportMetadataRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
2951
2951
|
};
|
|
2952
2952
|
/**
|
|
2953
|
-
*
|
|
2953
|
+
* ImageExportExport - interface
|
|
2954
2954
|
* @export
|
|
2955
|
-
* @interface
|
|
2955
|
+
* @interface ImageExportExport
|
|
2956
2956
|
*/
|
|
2957
|
-
export interface
|
|
2957
|
+
export interface ImageExportExportInterface {
|
|
2958
2958
|
/**
|
|
2959
2959
|
* 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.
|
|
2960
2960
|
* @summary (EXPERIMENTAL) Create image export request
|
|
2961
|
-
* @param {
|
|
2961
|
+
* @param {ImageExportExportCreateImageExportRequest} requestParameters Request parameters.
|
|
2962
2962
|
* @param {*} [options] Override http request option.
|
|
2963
2963
|
* @throws {RequiredError}
|
|
2964
|
-
* @memberof
|
|
2964
|
+
* @memberof ImageExportExportInterface
|
|
2965
2965
|
*/
|
|
2966
|
-
createImageExport(requestParameters:
|
|
2966
|
+
createImageExport(requestParameters: ImageExportExportCreateImageExportRequest, options?: AxiosRequestConfig): AxiosPromise<ExportExportResponse>;
|
|
2967
2967
|
/**
|
|
2968
2968
|
* 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.
|
|
2969
2969
|
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
2970
|
-
* @param {
|
|
2970
|
+
* @param {ImageExportExportGetImageExportRequest} requestParameters Request parameters.
|
|
2971
2971
|
* @param {*} [options] Override http request option.
|
|
2972
2972
|
* @throws {RequiredError}
|
|
2973
|
-
* @memberof
|
|
2973
|
+
* @memberof ImageExportExportInterface
|
|
2974
2974
|
*/
|
|
2975
|
-
getImageExport(requestParameters:
|
|
2975
|
+
getImageExport(requestParameters: ImageExportExportGetImageExportRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
2976
2976
|
/**
|
|
2977
2977
|
* 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.
|
|
2978
2978
|
* @summary (EXPERIMENTAL) Retrieve metadata context
|
|
2979
|
-
* @param {
|
|
2979
|
+
* @param {ImageExportExportGetImageExportMetadataRequest} requestParameters Request parameters.
|
|
2980
2980
|
* @param {*} [options] Override http request option.
|
|
2981
2981
|
* @throws {RequiredError}
|
|
2982
|
-
* @memberof
|
|
2982
|
+
* @memberof ImageExportExportInterface
|
|
2983
2983
|
*/
|
|
2984
|
-
getImageExportMetadata(requestParameters:
|
|
2984
|
+
getImageExportMetadata(requestParameters: ImageExportExportGetImageExportMetadataRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
2985
2985
|
}
|
|
2986
2986
|
/**
|
|
2987
|
-
* Request parameters for createImageExport operation in
|
|
2987
|
+
* Request parameters for createImageExport operation in ImageExportExport.
|
|
2988
2988
|
* @export
|
|
2989
|
-
* @interface
|
|
2989
|
+
* @interface ImageExportExportCreateImageExportRequest
|
|
2990
2990
|
*/
|
|
2991
|
-
export interface
|
|
2991
|
+
export interface ImageExportExportCreateImageExportRequest {
|
|
2992
2992
|
/**
|
|
2993
2993
|
*
|
|
2994
2994
|
* @type {string}
|
|
2995
|
-
* @memberof
|
|
2995
|
+
* @memberof ImageExportExportCreateImageExport
|
|
2996
2996
|
*/
|
|
2997
2997
|
readonly workspaceId: string;
|
|
2998
2998
|
/**
|
|
2999
2999
|
*
|
|
3000
|
-
* @type {
|
|
3001
|
-
* @memberof
|
|
3000
|
+
* @type {ExportImageExportRequest}
|
|
3001
|
+
* @memberof ImageExportExportCreateImageExport
|
|
3002
3002
|
*/
|
|
3003
|
-
readonly
|
|
3003
|
+
readonly exportImageExportRequest: ExportImageExportRequest;
|
|
3004
3004
|
}
|
|
3005
3005
|
/**
|
|
3006
|
-
* Request parameters for getImageExport operation in
|
|
3006
|
+
* Request parameters for getImageExport operation in ImageExportExport.
|
|
3007
3007
|
* @export
|
|
3008
|
-
* @interface
|
|
3008
|
+
* @interface ImageExportExportGetImageExportRequest
|
|
3009
3009
|
*/
|
|
3010
|
-
export interface
|
|
3010
|
+
export interface ImageExportExportGetImageExportRequest {
|
|
3011
3011
|
/**
|
|
3012
3012
|
*
|
|
3013
3013
|
* @type {string}
|
|
3014
|
-
* @memberof
|
|
3014
|
+
* @memberof ImageExportExportGetImageExport
|
|
3015
3015
|
*/
|
|
3016
3016
|
readonly workspaceId: string;
|
|
3017
3017
|
/**
|
|
3018
3018
|
*
|
|
3019
3019
|
* @type {string}
|
|
3020
|
-
* @memberof
|
|
3020
|
+
* @memberof ImageExportExportGetImageExport
|
|
3021
3021
|
*/
|
|
3022
3022
|
readonly exportId: string;
|
|
3023
3023
|
}
|
|
3024
3024
|
/**
|
|
3025
|
-
* Request parameters for getImageExportMetadata operation in
|
|
3025
|
+
* Request parameters for getImageExportMetadata operation in ImageExportExport.
|
|
3026
3026
|
* @export
|
|
3027
|
-
* @interface
|
|
3027
|
+
* @interface ImageExportExportGetImageExportMetadataRequest
|
|
3028
3028
|
*/
|
|
3029
|
-
export interface
|
|
3029
|
+
export interface ImageExportExportGetImageExportMetadataRequest {
|
|
3030
3030
|
/**
|
|
3031
3031
|
*
|
|
3032
3032
|
* @type {string}
|
|
3033
|
-
* @memberof
|
|
3033
|
+
* @memberof ImageExportExportGetImageExportMetadata
|
|
3034
3034
|
*/
|
|
3035
3035
|
readonly workspaceId: string;
|
|
3036
3036
|
/**
|
|
3037
3037
|
*
|
|
3038
3038
|
* @type {string}
|
|
3039
|
-
* @memberof
|
|
3039
|
+
* @memberof ImageExportExportGetImageExportMetadata
|
|
3040
3040
|
*/
|
|
3041
3041
|
readonly exportId: string;
|
|
3042
3042
|
}
|
|
3043
3043
|
/**
|
|
3044
|
-
*
|
|
3044
|
+
* ImageExportExport - object-oriented interface
|
|
3045
3045
|
* @export
|
|
3046
|
-
* @class
|
|
3046
|
+
* @class ImageExportExport
|
|
3047
3047
|
* @extends {BaseAPI}
|
|
3048
3048
|
*/
|
|
3049
|
-
export declare class
|
|
3049
|
+
export declare class ImageExportExport extends BaseAPI implements ImageExportExportInterface {
|
|
3050
3050
|
/**
|
|
3051
3051
|
* 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.
|
|
3052
3052
|
* @summary (EXPERIMENTAL) Create image export request
|
|
3053
|
-
* @param {
|
|
3053
|
+
* @param {ImageExportExportCreateImageExportRequest} requestParameters Request parameters.
|
|
3054
3054
|
* @param {*} [options] Override http request option.
|
|
3055
3055
|
* @throws {RequiredError}
|
|
3056
|
-
* @memberof
|
|
3056
|
+
* @memberof ImageExportExport
|
|
3057
3057
|
*/
|
|
3058
|
-
createImageExport(requestParameters:
|
|
3058
|
+
createImageExport(requestParameters: ImageExportExportCreateImageExportRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ExportExportResponse, any>>;
|
|
3059
3059
|
/**
|
|
3060
3060
|
* 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.
|
|
3061
3061
|
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
3062
|
-
* @param {
|
|
3062
|
+
* @param {ImageExportExportGetImageExportRequest} requestParameters Request parameters.
|
|
3063
3063
|
* @param {*} [options] Override http request option.
|
|
3064
3064
|
* @throws {RequiredError}
|
|
3065
|
-
* @memberof
|
|
3065
|
+
* @memberof ImageExportExport
|
|
3066
3066
|
*/
|
|
3067
|
-
getImageExport(requestParameters:
|
|
3067
|
+
getImageExport(requestParameters: ImageExportExportGetImageExportRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
3068
3068
|
/**
|
|
3069
3069
|
* 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.
|
|
3070
3070
|
* @summary (EXPERIMENTAL) Retrieve metadata context
|
|
3071
|
-
* @param {
|
|
3071
|
+
* @param {ImageExportExportGetImageExportMetadataRequest} requestParameters Request parameters.
|
|
3072
3072
|
* @param {*} [options] Override http request option.
|
|
3073
3073
|
* @throws {RequiredError}
|
|
3074
|
-
* @memberof
|
|
3074
|
+
* @memberof ImageExportExport
|
|
3075
3075
|
*/
|
|
3076
|
-
getImageExportMetadata(requestParameters:
|
|
3076
|
+
getImageExportMetadata(requestParameters: ImageExportExportGetImageExportMetadataRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
3077
3077
|
}
|
|
3078
3078
|
/**
|
|
3079
|
-
*
|
|
3079
|
+
* RawExportExport - axios parameter creator
|
|
3080
3080
|
* @export
|
|
3081
3081
|
*/
|
|
3082
|
-
export declare const
|
|
3082
|
+
export declare const RawExportExportAxiosParamCreator: (configuration?: Configuration) => {
|
|
3083
3083
|
/**
|
|
3084
3084
|
* 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.
|
|
3085
3085
|
* @summary (EXPERIMENTAL) Create raw export request
|
|
3086
3086
|
* @param {string} workspaceId
|
|
3087
|
-
* @param {
|
|
3087
|
+
* @param {ExportRawExportRequest} exportRawExportRequest
|
|
3088
3088
|
* @param {*} [options] Override http request option.
|
|
3089
3089
|
* @throws {RequiredError}
|
|
3090
3090
|
*/
|
|
3091
|
-
createRawExport: (workspaceId: string,
|
|
3091
|
+
createRawExport: (workspaceId: string, exportRawExportRequest: ExportRawExportRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3092
3092
|
/**
|
|
3093
3093
|
* 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.
|
|
3094
3094
|
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
@@ -3100,19 +3100,19 @@ export declare const RawExportApiAxiosParamCreator: (configuration?: Configurati
|
|
|
3100
3100
|
getRawExport: (workspaceId: string, exportId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3101
3101
|
};
|
|
3102
3102
|
/**
|
|
3103
|
-
*
|
|
3103
|
+
* RawExportExport - functional programming interface
|
|
3104
3104
|
* @export
|
|
3105
3105
|
*/
|
|
3106
|
-
export declare const
|
|
3106
|
+
export declare const RawExportExportFp: (configuration?: Configuration) => {
|
|
3107
3107
|
/**
|
|
3108
3108
|
* 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.
|
|
3109
3109
|
* @summary (EXPERIMENTAL) Create raw export request
|
|
3110
3110
|
* @param {string} workspaceId
|
|
3111
|
-
* @param {
|
|
3111
|
+
* @param {ExportRawExportRequest} exportRawExportRequest
|
|
3112
3112
|
* @param {*} [options] Override http request option.
|
|
3113
3113
|
* @throws {RequiredError}
|
|
3114
3114
|
*/
|
|
3115
|
-
createRawExport(workspaceId: string,
|
|
3115
|
+
createRawExport(workspaceId: string, exportRawExportRequest: ExportRawExportRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExportExportResponse>>;
|
|
3116
3116
|
/**
|
|
3117
3117
|
* 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.
|
|
3118
3118
|
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
@@ -3124,130 +3124,130 @@ export declare const RawExportApiFp: (configuration?: Configuration) => {
|
|
|
3124
3124
|
getRawExport(workspaceId: string, exportId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
3125
3125
|
};
|
|
3126
3126
|
/**
|
|
3127
|
-
*
|
|
3127
|
+
* RawExportExport - factory interface
|
|
3128
3128
|
* @export
|
|
3129
3129
|
*/
|
|
3130
|
-
export declare const
|
|
3130
|
+
export declare const RawExportExportFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
3131
3131
|
/**
|
|
3132
3132
|
* 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.
|
|
3133
3133
|
* @summary (EXPERIMENTAL) Create raw export request
|
|
3134
|
-
* @param {
|
|
3134
|
+
* @param {RawExportExportCreateRawExportRequest} requestParameters Request parameters.
|
|
3135
3135
|
* @param {*} [options] Override http request option.
|
|
3136
3136
|
* @throws {RequiredError}
|
|
3137
3137
|
*/
|
|
3138
|
-
createRawExport(requestParameters:
|
|
3138
|
+
createRawExport(requestParameters: RawExportExportCreateRawExportRequest, options?: AxiosRequestConfig): AxiosPromise<ExportExportResponse>;
|
|
3139
3139
|
/**
|
|
3140
3140
|
* 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.
|
|
3141
3141
|
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
3142
|
-
* @param {
|
|
3142
|
+
* @param {RawExportExportGetRawExportRequest} requestParameters Request parameters.
|
|
3143
3143
|
* @param {*} [options] Override http request option.
|
|
3144
3144
|
* @throws {RequiredError}
|
|
3145
3145
|
*/
|
|
3146
|
-
getRawExport(requestParameters:
|
|
3146
|
+
getRawExport(requestParameters: RawExportExportGetRawExportRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
3147
3147
|
};
|
|
3148
3148
|
/**
|
|
3149
|
-
*
|
|
3149
|
+
* RawExportExport - interface
|
|
3150
3150
|
* @export
|
|
3151
|
-
* @interface
|
|
3151
|
+
* @interface RawExportExport
|
|
3152
3152
|
*/
|
|
3153
|
-
export interface
|
|
3153
|
+
export interface RawExportExportInterface {
|
|
3154
3154
|
/**
|
|
3155
3155
|
* 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.
|
|
3156
3156
|
* @summary (EXPERIMENTAL) Create raw export request
|
|
3157
|
-
* @param {
|
|
3157
|
+
* @param {RawExportExportCreateRawExportRequest} requestParameters Request parameters.
|
|
3158
3158
|
* @param {*} [options] Override http request option.
|
|
3159
3159
|
* @throws {RequiredError}
|
|
3160
|
-
* @memberof
|
|
3160
|
+
* @memberof RawExportExportInterface
|
|
3161
3161
|
*/
|
|
3162
|
-
createRawExport(requestParameters:
|
|
3162
|
+
createRawExport(requestParameters: RawExportExportCreateRawExportRequest, options?: AxiosRequestConfig): AxiosPromise<ExportExportResponse>;
|
|
3163
3163
|
/**
|
|
3164
3164
|
* 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.
|
|
3165
3165
|
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
3166
|
-
* @param {
|
|
3166
|
+
* @param {RawExportExportGetRawExportRequest} requestParameters Request parameters.
|
|
3167
3167
|
* @param {*} [options] Override http request option.
|
|
3168
3168
|
* @throws {RequiredError}
|
|
3169
|
-
* @memberof
|
|
3169
|
+
* @memberof RawExportExportInterface
|
|
3170
3170
|
*/
|
|
3171
|
-
getRawExport(requestParameters:
|
|
3171
|
+
getRawExport(requestParameters: RawExportExportGetRawExportRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
3172
3172
|
}
|
|
3173
3173
|
/**
|
|
3174
|
-
* Request parameters for createRawExport operation in
|
|
3174
|
+
* Request parameters for createRawExport operation in RawExportExport.
|
|
3175
3175
|
* @export
|
|
3176
|
-
* @interface
|
|
3176
|
+
* @interface RawExportExportCreateRawExportRequest
|
|
3177
3177
|
*/
|
|
3178
|
-
export interface
|
|
3178
|
+
export interface RawExportExportCreateRawExportRequest {
|
|
3179
3179
|
/**
|
|
3180
3180
|
*
|
|
3181
3181
|
* @type {string}
|
|
3182
|
-
* @memberof
|
|
3182
|
+
* @memberof RawExportExportCreateRawExport
|
|
3183
3183
|
*/
|
|
3184
3184
|
readonly workspaceId: string;
|
|
3185
3185
|
/**
|
|
3186
3186
|
*
|
|
3187
|
-
* @type {
|
|
3188
|
-
* @memberof
|
|
3187
|
+
* @type {ExportRawExportRequest}
|
|
3188
|
+
* @memberof RawExportExportCreateRawExport
|
|
3189
3189
|
*/
|
|
3190
|
-
readonly
|
|
3190
|
+
readonly exportRawExportRequest: ExportRawExportRequest;
|
|
3191
3191
|
}
|
|
3192
3192
|
/**
|
|
3193
|
-
* Request parameters for getRawExport operation in
|
|
3193
|
+
* Request parameters for getRawExport operation in RawExportExport.
|
|
3194
3194
|
* @export
|
|
3195
|
-
* @interface
|
|
3195
|
+
* @interface RawExportExportGetRawExportRequest
|
|
3196
3196
|
*/
|
|
3197
|
-
export interface
|
|
3197
|
+
export interface RawExportExportGetRawExportRequest {
|
|
3198
3198
|
/**
|
|
3199
3199
|
*
|
|
3200
3200
|
* @type {string}
|
|
3201
|
-
* @memberof
|
|
3201
|
+
* @memberof RawExportExportGetRawExport
|
|
3202
3202
|
*/
|
|
3203
3203
|
readonly workspaceId: string;
|
|
3204
3204
|
/**
|
|
3205
3205
|
*
|
|
3206
3206
|
* @type {string}
|
|
3207
|
-
* @memberof
|
|
3207
|
+
* @memberof RawExportExportGetRawExport
|
|
3208
3208
|
*/
|
|
3209
3209
|
readonly exportId: string;
|
|
3210
3210
|
}
|
|
3211
3211
|
/**
|
|
3212
|
-
*
|
|
3212
|
+
* RawExportExport - object-oriented interface
|
|
3213
3213
|
* @export
|
|
3214
|
-
* @class
|
|
3214
|
+
* @class RawExportExport
|
|
3215
3215
|
* @extends {BaseAPI}
|
|
3216
3216
|
*/
|
|
3217
|
-
export declare class
|
|
3217
|
+
export declare class RawExportExport extends BaseAPI implements RawExportExportInterface {
|
|
3218
3218
|
/**
|
|
3219
3219
|
* 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.
|
|
3220
3220
|
* @summary (EXPERIMENTAL) Create raw export request
|
|
3221
|
-
* @param {
|
|
3221
|
+
* @param {RawExportExportCreateRawExportRequest} requestParameters Request parameters.
|
|
3222
3222
|
* @param {*} [options] Override http request option.
|
|
3223
3223
|
* @throws {RequiredError}
|
|
3224
|
-
* @memberof
|
|
3224
|
+
* @memberof RawExportExport
|
|
3225
3225
|
*/
|
|
3226
|
-
createRawExport(requestParameters:
|
|
3226
|
+
createRawExport(requestParameters: RawExportExportCreateRawExportRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ExportExportResponse, any>>;
|
|
3227
3227
|
/**
|
|
3228
3228
|
* 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.
|
|
3229
3229
|
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
3230
|
-
* @param {
|
|
3230
|
+
* @param {RawExportExportGetRawExportRequest} requestParameters Request parameters.
|
|
3231
3231
|
* @param {*} [options] Override http request option.
|
|
3232
3232
|
* @throws {RequiredError}
|
|
3233
|
-
* @memberof
|
|
3233
|
+
* @memberof RawExportExport
|
|
3234
3234
|
*/
|
|
3235
|
-
getRawExport(requestParameters:
|
|
3235
|
+
getRawExport(requestParameters: RawExportExportGetRawExportRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
3236
3236
|
}
|
|
3237
3237
|
/**
|
|
3238
|
-
*
|
|
3238
|
+
* SlidesExportExport - axios parameter creator
|
|
3239
3239
|
* @export
|
|
3240
3240
|
*/
|
|
3241
|
-
export declare const
|
|
3241
|
+
export declare const SlidesExportExportAxiosParamCreator: (configuration?: Configuration) => {
|
|
3242
3242
|
/**
|
|
3243
3243
|
* 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.
|
|
3244
3244
|
* @summary (EXPERIMENTAL) Create slides export request
|
|
3245
3245
|
* @param {string} workspaceId
|
|
3246
|
-
* @param {
|
|
3246
|
+
* @param {ExportSlidesExportRequest} exportSlidesExportRequest
|
|
3247
3247
|
* @param {*} [options] Override http request option.
|
|
3248
3248
|
* @throws {RequiredError}
|
|
3249
3249
|
*/
|
|
3250
|
-
createSlidesExport: (workspaceId: string,
|
|
3250
|
+
createSlidesExport: (workspaceId: string, exportSlidesExportRequest: ExportSlidesExportRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3251
3251
|
/**
|
|
3252
3252
|
* 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.
|
|
3253
3253
|
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
@@ -3268,19 +3268,19 @@ export declare const SlidesExportApiAxiosParamCreator: (configuration?: Configur
|
|
|
3268
3268
|
getSlidesExportMetadata: (workspaceId: string, exportId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3269
3269
|
};
|
|
3270
3270
|
/**
|
|
3271
|
-
*
|
|
3271
|
+
* SlidesExportExport - functional programming interface
|
|
3272
3272
|
* @export
|
|
3273
3273
|
*/
|
|
3274
|
-
export declare const
|
|
3274
|
+
export declare const SlidesExportExportFp: (configuration?: Configuration) => {
|
|
3275
3275
|
/**
|
|
3276
3276
|
* 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.
|
|
3277
3277
|
* @summary (EXPERIMENTAL) Create slides export request
|
|
3278
3278
|
* @param {string} workspaceId
|
|
3279
|
-
* @param {
|
|
3279
|
+
* @param {ExportSlidesExportRequest} exportSlidesExportRequest
|
|
3280
3280
|
* @param {*} [options] Override http request option.
|
|
3281
3281
|
* @throws {RequiredError}
|
|
3282
3282
|
*/
|
|
3283
|
-
createSlidesExport(workspaceId: string,
|
|
3283
|
+
createSlidesExport(workspaceId: string, exportSlidesExportRequest: ExportSlidesExportRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExportExportResponse>>;
|
|
3284
3284
|
/**
|
|
3285
3285
|
* 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.
|
|
3286
3286
|
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
@@ -3301,185 +3301,185 @@ export declare const SlidesExportApiFp: (configuration?: Configuration) => {
|
|
|
3301
3301
|
getSlidesExportMetadata(workspaceId: string, exportId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
3302
3302
|
};
|
|
3303
3303
|
/**
|
|
3304
|
-
*
|
|
3304
|
+
* SlidesExportExport - factory interface
|
|
3305
3305
|
* @export
|
|
3306
3306
|
*/
|
|
3307
|
-
export declare const
|
|
3307
|
+
export declare const SlidesExportExportFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
3308
3308
|
/**
|
|
3309
3309
|
* 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.
|
|
3310
3310
|
* @summary (EXPERIMENTAL) Create slides export request
|
|
3311
|
-
* @param {
|
|
3311
|
+
* @param {SlidesExportExportCreateSlidesExportRequest} requestParameters Request parameters.
|
|
3312
3312
|
* @param {*} [options] Override http request option.
|
|
3313
3313
|
* @throws {RequiredError}
|
|
3314
3314
|
*/
|
|
3315
|
-
createSlidesExport(requestParameters:
|
|
3315
|
+
createSlidesExport(requestParameters: SlidesExportExportCreateSlidesExportRequest, options?: AxiosRequestConfig): AxiosPromise<ExportExportResponse>;
|
|
3316
3316
|
/**
|
|
3317
3317
|
* 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.
|
|
3318
3318
|
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
3319
|
-
* @param {
|
|
3319
|
+
* @param {SlidesExportExportGetSlidesExportRequest} requestParameters Request parameters.
|
|
3320
3320
|
* @param {*} [options] Override http request option.
|
|
3321
3321
|
* @throws {RequiredError}
|
|
3322
3322
|
*/
|
|
3323
|
-
getSlidesExport(requestParameters:
|
|
3323
|
+
getSlidesExport(requestParameters: SlidesExportExportGetSlidesExportRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
3324
3324
|
/**
|
|
3325
3325
|
* 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.
|
|
3326
3326
|
* @summary (EXPERIMENTAL) Retrieve metadata context
|
|
3327
|
-
* @param {
|
|
3327
|
+
* @param {SlidesExportExportGetSlidesExportMetadataRequest} requestParameters Request parameters.
|
|
3328
3328
|
* @param {*} [options] Override http request option.
|
|
3329
3329
|
* @throws {RequiredError}
|
|
3330
3330
|
*/
|
|
3331
|
-
getSlidesExportMetadata(requestParameters:
|
|
3331
|
+
getSlidesExportMetadata(requestParameters: SlidesExportExportGetSlidesExportMetadataRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
3332
3332
|
};
|
|
3333
3333
|
/**
|
|
3334
|
-
*
|
|
3334
|
+
* SlidesExportExport - interface
|
|
3335
3335
|
* @export
|
|
3336
|
-
* @interface
|
|
3336
|
+
* @interface SlidesExportExport
|
|
3337
3337
|
*/
|
|
3338
|
-
export interface
|
|
3338
|
+
export interface SlidesExportExportInterface {
|
|
3339
3339
|
/**
|
|
3340
3340
|
* 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.
|
|
3341
3341
|
* @summary (EXPERIMENTAL) Create slides export request
|
|
3342
|
-
* @param {
|
|
3342
|
+
* @param {SlidesExportExportCreateSlidesExportRequest} requestParameters Request parameters.
|
|
3343
3343
|
* @param {*} [options] Override http request option.
|
|
3344
3344
|
* @throws {RequiredError}
|
|
3345
|
-
* @memberof
|
|
3345
|
+
* @memberof SlidesExportExportInterface
|
|
3346
3346
|
*/
|
|
3347
|
-
createSlidesExport(requestParameters:
|
|
3347
|
+
createSlidesExport(requestParameters: SlidesExportExportCreateSlidesExportRequest, options?: AxiosRequestConfig): AxiosPromise<ExportExportResponse>;
|
|
3348
3348
|
/**
|
|
3349
3349
|
* 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.
|
|
3350
3350
|
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
3351
|
-
* @param {
|
|
3351
|
+
* @param {SlidesExportExportGetSlidesExportRequest} requestParameters Request parameters.
|
|
3352
3352
|
* @param {*} [options] Override http request option.
|
|
3353
3353
|
* @throws {RequiredError}
|
|
3354
|
-
* @memberof
|
|
3354
|
+
* @memberof SlidesExportExportInterface
|
|
3355
3355
|
*/
|
|
3356
|
-
getSlidesExport(requestParameters:
|
|
3356
|
+
getSlidesExport(requestParameters: SlidesExportExportGetSlidesExportRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
3357
3357
|
/**
|
|
3358
3358
|
* 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.
|
|
3359
3359
|
* @summary (EXPERIMENTAL) Retrieve metadata context
|
|
3360
|
-
* @param {
|
|
3360
|
+
* @param {SlidesExportExportGetSlidesExportMetadataRequest} requestParameters Request parameters.
|
|
3361
3361
|
* @param {*} [options] Override http request option.
|
|
3362
3362
|
* @throws {RequiredError}
|
|
3363
|
-
* @memberof
|
|
3363
|
+
* @memberof SlidesExportExportInterface
|
|
3364
3364
|
*/
|
|
3365
|
-
getSlidesExportMetadata(requestParameters:
|
|
3365
|
+
getSlidesExportMetadata(requestParameters: SlidesExportExportGetSlidesExportMetadataRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
3366
3366
|
}
|
|
3367
3367
|
/**
|
|
3368
|
-
* Request parameters for createSlidesExport operation in
|
|
3368
|
+
* Request parameters for createSlidesExport operation in SlidesExportExport.
|
|
3369
3369
|
* @export
|
|
3370
|
-
* @interface
|
|
3370
|
+
* @interface SlidesExportExportCreateSlidesExportRequest
|
|
3371
3371
|
*/
|
|
3372
|
-
export interface
|
|
3372
|
+
export interface SlidesExportExportCreateSlidesExportRequest {
|
|
3373
3373
|
/**
|
|
3374
3374
|
*
|
|
3375
3375
|
* @type {string}
|
|
3376
|
-
* @memberof
|
|
3376
|
+
* @memberof SlidesExportExportCreateSlidesExport
|
|
3377
3377
|
*/
|
|
3378
3378
|
readonly workspaceId: string;
|
|
3379
3379
|
/**
|
|
3380
3380
|
*
|
|
3381
|
-
* @type {
|
|
3382
|
-
* @memberof
|
|
3381
|
+
* @type {ExportSlidesExportRequest}
|
|
3382
|
+
* @memberof SlidesExportExportCreateSlidesExport
|
|
3383
3383
|
*/
|
|
3384
|
-
readonly
|
|
3384
|
+
readonly exportSlidesExportRequest: ExportSlidesExportRequest;
|
|
3385
3385
|
}
|
|
3386
3386
|
/**
|
|
3387
|
-
* Request parameters for getSlidesExport operation in
|
|
3387
|
+
* Request parameters for getSlidesExport operation in SlidesExportExport.
|
|
3388
3388
|
* @export
|
|
3389
|
-
* @interface
|
|
3389
|
+
* @interface SlidesExportExportGetSlidesExportRequest
|
|
3390
3390
|
*/
|
|
3391
|
-
export interface
|
|
3391
|
+
export interface SlidesExportExportGetSlidesExportRequest {
|
|
3392
3392
|
/**
|
|
3393
3393
|
*
|
|
3394
3394
|
* @type {string}
|
|
3395
|
-
* @memberof
|
|
3395
|
+
* @memberof SlidesExportExportGetSlidesExport
|
|
3396
3396
|
*/
|
|
3397
3397
|
readonly workspaceId: string;
|
|
3398
3398
|
/**
|
|
3399
3399
|
*
|
|
3400
3400
|
* @type {string}
|
|
3401
|
-
* @memberof
|
|
3401
|
+
* @memberof SlidesExportExportGetSlidesExport
|
|
3402
3402
|
*/
|
|
3403
3403
|
readonly exportId: string;
|
|
3404
3404
|
}
|
|
3405
3405
|
/**
|
|
3406
|
-
* Request parameters for getSlidesExportMetadata operation in
|
|
3406
|
+
* Request parameters for getSlidesExportMetadata operation in SlidesExportExport.
|
|
3407
3407
|
* @export
|
|
3408
|
-
* @interface
|
|
3408
|
+
* @interface SlidesExportExportGetSlidesExportMetadataRequest
|
|
3409
3409
|
*/
|
|
3410
|
-
export interface
|
|
3410
|
+
export interface SlidesExportExportGetSlidesExportMetadataRequest {
|
|
3411
3411
|
/**
|
|
3412
3412
|
*
|
|
3413
3413
|
* @type {string}
|
|
3414
|
-
* @memberof
|
|
3414
|
+
* @memberof SlidesExportExportGetSlidesExportMetadata
|
|
3415
3415
|
*/
|
|
3416
3416
|
readonly workspaceId: string;
|
|
3417
3417
|
/**
|
|
3418
3418
|
*
|
|
3419
3419
|
* @type {string}
|
|
3420
|
-
* @memberof
|
|
3420
|
+
* @memberof SlidesExportExportGetSlidesExportMetadata
|
|
3421
3421
|
*/
|
|
3422
3422
|
readonly exportId: string;
|
|
3423
3423
|
}
|
|
3424
3424
|
/**
|
|
3425
|
-
*
|
|
3425
|
+
* SlidesExportExport - object-oriented interface
|
|
3426
3426
|
* @export
|
|
3427
|
-
* @class
|
|
3427
|
+
* @class SlidesExportExport
|
|
3428
3428
|
* @extends {BaseAPI}
|
|
3429
3429
|
*/
|
|
3430
|
-
export declare class
|
|
3430
|
+
export declare class SlidesExportExport extends BaseAPI implements SlidesExportExportInterface {
|
|
3431
3431
|
/**
|
|
3432
3432
|
* 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.
|
|
3433
3433
|
* @summary (EXPERIMENTAL) Create slides export request
|
|
3434
|
-
* @param {
|
|
3434
|
+
* @param {SlidesExportExportCreateSlidesExportRequest} requestParameters Request parameters.
|
|
3435
3435
|
* @param {*} [options] Override http request option.
|
|
3436
3436
|
* @throws {RequiredError}
|
|
3437
|
-
* @memberof
|
|
3437
|
+
* @memberof SlidesExportExport
|
|
3438
3438
|
*/
|
|
3439
|
-
createSlidesExport(requestParameters:
|
|
3439
|
+
createSlidesExport(requestParameters: SlidesExportExportCreateSlidesExportRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ExportExportResponse, any>>;
|
|
3440
3440
|
/**
|
|
3441
3441
|
* 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.
|
|
3442
3442
|
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
3443
|
-
* @param {
|
|
3443
|
+
* @param {SlidesExportExportGetSlidesExportRequest} requestParameters Request parameters.
|
|
3444
3444
|
* @param {*} [options] Override http request option.
|
|
3445
3445
|
* @throws {RequiredError}
|
|
3446
|
-
* @memberof
|
|
3446
|
+
* @memberof SlidesExportExport
|
|
3447
3447
|
*/
|
|
3448
|
-
getSlidesExport(requestParameters:
|
|
3448
|
+
getSlidesExport(requestParameters: SlidesExportExportGetSlidesExportRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
3449
3449
|
/**
|
|
3450
3450
|
* 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.
|
|
3451
3451
|
* @summary (EXPERIMENTAL) Retrieve metadata context
|
|
3452
|
-
* @param {
|
|
3452
|
+
* @param {SlidesExportExportGetSlidesExportMetadataRequest} requestParameters Request parameters.
|
|
3453
3453
|
* @param {*} [options] Override http request option.
|
|
3454
3454
|
* @throws {RequiredError}
|
|
3455
|
-
* @memberof
|
|
3455
|
+
* @memberof SlidesExportExport
|
|
3456
3456
|
*/
|
|
3457
|
-
getSlidesExportMetadata(requestParameters:
|
|
3457
|
+
getSlidesExportMetadata(requestParameters: SlidesExportExportGetSlidesExportMetadataRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
3458
3458
|
}
|
|
3459
3459
|
/**
|
|
3460
|
-
*
|
|
3460
|
+
* TabularExportExport - axios parameter creator
|
|
3461
3461
|
* @export
|
|
3462
3462
|
*/
|
|
3463
|
-
export declare const
|
|
3463
|
+
export declare const TabularExportExportAxiosParamCreator: (configuration?: Configuration) => {
|
|
3464
3464
|
/**
|
|
3465
3465
|
* 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.
|
|
3466
3466
|
* @summary (EXPERIMENTAL) Create dashboard tabular export request
|
|
3467
3467
|
* @param {string} workspaceId
|
|
3468
3468
|
* @param {string} dashboardId
|
|
3469
|
-
* @param {
|
|
3469
|
+
* @param {ExportDashboardTabularExportRequest} exportDashboardTabularExportRequest
|
|
3470
3470
|
* @param {*} [options] Override http request option.
|
|
3471
3471
|
* @throws {RequiredError}
|
|
3472
3472
|
*/
|
|
3473
|
-
createDashboardExportRequest: (workspaceId: string, dashboardId: string,
|
|
3473
|
+
createDashboardExportRequest: (workspaceId: string, dashboardId: string, exportDashboardTabularExportRequest: ExportDashboardTabularExportRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3474
3474
|
/**
|
|
3475
3475
|
* 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.
|
|
3476
3476
|
* @summary Create tabular export request
|
|
3477
3477
|
* @param {string} workspaceId
|
|
3478
|
-
* @param {
|
|
3478
|
+
* @param {ExportTabularExportRequest} exportTabularExportRequest
|
|
3479
3479
|
* @param {*} [options] Override http request option.
|
|
3480
3480
|
* @throws {RequiredError}
|
|
3481
3481
|
*/
|
|
3482
|
-
createTabularExport: (workspaceId: string,
|
|
3482
|
+
createTabularExport: (workspaceId: string, exportTabularExportRequest: ExportTabularExportRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3483
3483
|
/**
|
|
3484
3484
|
* 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.
|
|
3485
3485
|
* @summary Retrieve exported files
|
|
@@ -3491,29 +3491,29 @@ export declare const TabularExportApiAxiosParamCreator: (configuration?: Configu
|
|
|
3491
3491
|
getTabularExport: (workspaceId: string, exportId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3492
3492
|
};
|
|
3493
3493
|
/**
|
|
3494
|
-
*
|
|
3494
|
+
* TabularExportExport - functional programming interface
|
|
3495
3495
|
* @export
|
|
3496
3496
|
*/
|
|
3497
|
-
export declare const
|
|
3497
|
+
export declare const TabularExportExportFp: (configuration?: Configuration) => {
|
|
3498
3498
|
/**
|
|
3499
3499
|
* 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.
|
|
3500
3500
|
* @summary (EXPERIMENTAL) Create dashboard tabular export request
|
|
3501
3501
|
* @param {string} workspaceId
|
|
3502
3502
|
* @param {string} dashboardId
|
|
3503
|
-
* @param {
|
|
3503
|
+
* @param {ExportDashboardTabularExportRequest} exportDashboardTabularExportRequest
|
|
3504
3504
|
* @param {*} [options] Override http request option.
|
|
3505
3505
|
* @throws {RequiredError}
|
|
3506
3506
|
*/
|
|
3507
|
-
createDashboardExportRequest(workspaceId: string, dashboardId: string,
|
|
3507
|
+
createDashboardExportRequest(workspaceId: string, dashboardId: string, exportDashboardTabularExportRequest: ExportDashboardTabularExportRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExportExportResponse>>;
|
|
3508
3508
|
/**
|
|
3509
3509
|
* 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.
|
|
3510
3510
|
* @summary Create tabular export request
|
|
3511
3511
|
* @param {string} workspaceId
|
|
3512
|
-
* @param {
|
|
3512
|
+
* @param {ExportTabularExportRequest} exportTabularExportRequest
|
|
3513
3513
|
* @param {*} [options] Override http request option.
|
|
3514
3514
|
* @throws {RequiredError}
|
|
3515
3515
|
*/
|
|
3516
|
-
createTabularExport(workspaceId: string,
|
|
3516
|
+
createTabularExport(workspaceId: string, exportTabularExportRequest: ExportTabularExportRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExportExportResponse>>;
|
|
3517
3517
|
/**
|
|
3518
3518
|
* 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.
|
|
3519
3519
|
* @summary Retrieve exported files
|
|
@@ -3525,181 +3525,181 @@ export declare const TabularExportApiFp: (configuration?: Configuration) => {
|
|
|
3525
3525
|
getTabularExport(workspaceId: string, exportId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
3526
3526
|
};
|
|
3527
3527
|
/**
|
|
3528
|
-
*
|
|
3528
|
+
* TabularExportExport - factory interface
|
|
3529
3529
|
* @export
|
|
3530
3530
|
*/
|
|
3531
|
-
export declare const
|
|
3531
|
+
export declare const TabularExportExportFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
3532
3532
|
/**
|
|
3533
3533
|
* 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.
|
|
3534
3534
|
* @summary (EXPERIMENTAL) Create dashboard tabular export request
|
|
3535
|
-
* @param {
|
|
3535
|
+
* @param {TabularExportExportCreateDashboardExportRequestRequest} requestParameters Request parameters.
|
|
3536
3536
|
* @param {*} [options] Override http request option.
|
|
3537
3537
|
* @throws {RequiredError}
|
|
3538
3538
|
*/
|
|
3539
|
-
createDashboardExportRequest(requestParameters:
|
|
3539
|
+
createDashboardExportRequest(requestParameters: TabularExportExportCreateDashboardExportRequestRequest, options?: AxiosRequestConfig): AxiosPromise<ExportExportResponse>;
|
|
3540
3540
|
/**
|
|
3541
3541
|
* 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.
|
|
3542
3542
|
* @summary Create tabular export request
|
|
3543
|
-
* @param {
|
|
3543
|
+
* @param {TabularExportExportCreateTabularExportRequest} requestParameters Request parameters.
|
|
3544
3544
|
* @param {*} [options] Override http request option.
|
|
3545
3545
|
* @throws {RequiredError}
|
|
3546
3546
|
*/
|
|
3547
|
-
createTabularExport(requestParameters:
|
|
3547
|
+
createTabularExport(requestParameters: TabularExportExportCreateTabularExportRequest, options?: AxiosRequestConfig): AxiosPromise<ExportExportResponse>;
|
|
3548
3548
|
/**
|
|
3549
3549
|
* 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.
|
|
3550
3550
|
* @summary Retrieve exported files
|
|
3551
|
-
* @param {
|
|
3551
|
+
* @param {TabularExportExportGetTabularExportRequest} requestParameters Request parameters.
|
|
3552
3552
|
* @param {*} [options] Override http request option.
|
|
3553
3553
|
* @throws {RequiredError}
|
|
3554
3554
|
*/
|
|
3555
|
-
getTabularExport(requestParameters:
|
|
3555
|
+
getTabularExport(requestParameters: TabularExportExportGetTabularExportRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
3556
3556
|
};
|
|
3557
3557
|
/**
|
|
3558
|
-
*
|
|
3558
|
+
* TabularExportExport - interface
|
|
3559
3559
|
* @export
|
|
3560
|
-
* @interface
|
|
3560
|
+
* @interface TabularExportExport
|
|
3561
3561
|
*/
|
|
3562
|
-
export interface
|
|
3562
|
+
export interface TabularExportExportInterface {
|
|
3563
3563
|
/**
|
|
3564
3564
|
* 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.
|
|
3565
3565
|
* @summary (EXPERIMENTAL) Create dashboard tabular export request
|
|
3566
|
-
* @param {
|
|
3566
|
+
* @param {TabularExportExportCreateDashboardExportRequestRequest} requestParameters Request parameters.
|
|
3567
3567
|
* @param {*} [options] Override http request option.
|
|
3568
3568
|
* @throws {RequiredError}
|
|
3569
|
-
* @memberof
|
|
3569
|
+
* @memberof TabularExportExportInterface
|
|
3570
3570
|
*/
|
|
3571
|
-
createDashboardExportRequest(requestParameters:
|
|
3571
|
+
createDashboardExportRequest(requestParameters: TabularExportExportCreateDashboardExportRequestRequest, options?: AxiosRequestConfig): AxiosPromise<ExportExportResponse>;
|
|
3572
3572
|
/**
|
|
3573
3573
|
* 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.
|
|
3574
3574
|
* @summary Create tabular export request
|
|
3575
|
-
* @param {
|
|
3575
|
+
* @param {TabularExportExportCreateTabularExportRequest} requestParameters Request parameters.
|
|
3576
3576
|
* @param {*} [options] Override http request option.
|
|
3577
3577
|
* @throws {RequiredError}
|
|
3578
|
-
* @memberof
|
|
3578
|
+
* @memberof TabularExportExportInterface
|
|
3579
3579
|
*/
|
|
3580
|
-
createTabularExport(requestParameters:
|
|
3580
|
+
createTabularExport(requestParameters: TabularExportExportCreateTabularExportRequest, options?: AxiosRequestConfig): AxiosPromise<ExportExportResponse>;
|
|
3581
3581
|
/**
|
|
3582
3582
|
* 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.
|
|
3583
3583
|
* @summary Retrieve exported files
|
|
3584
|
-
* @param {
|
|
3584
|
+
* @param {TabularExportExportGetTabularExportRequest} requestParameters Request parameters.
|
|
3585
3585
|
* @param {*} [options] Override http request option.
|
|
3586
3586
|
* @throws {RequiredError}
|
|
3587
|
-
* @memberof
|
|
3587
|
+
* @memberof TabularExportExportInterface
|
|
3588
3588
|
*/
|
|
3589
|
-
getTabularExport(requestParameters:
|
|
3589
|
+
getTabularExport(requestParameters: TabularExportExportGetTabularExportRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
3590
3590
|
}
|
|
3591
3591
|
/**
|
|
3592
|
-
* Request parameters for createDashboardExportRequest operation in
|
|
3592
|
+
* Request parameters for createDashboardExportRequest operation in TabularExportExport.
|
|
3593
3593
|
* @export
|
|
3594
|
-
* @interface
|
|
3594
|
+
* @interface TabularExportExportCreateDashboardExportRequestRequest
|
|
3595
3595
|
*/
|
|
3596
|
-
export interface
|
|
3596
|
+
export interface TabularExportExportCreateDashboardExportRequestRequest {
|
|
3597
3597
|
/**
|
|
3598
3598
|
*
|
|
3599
3599
|
* @type {string}
|
|
3600
|
-
* @memberof
|
|
3600
|
+
* @memberof TabularExportExportCreateDashboardExportRequest
|
|
3601
3601
|
*/
|
|
3602
3602
|
readonly workspaceId: string;
|
|
3603
3603
|
/**
|
|
3604
3604
|
*
|
|
3605
3605
|
* @type {string}
|
|
3606
|
-
* @memberof
|
|
3606
|
+
* @memberof TabularExportExportCreateDashboardExportRequest
|
|
3607
3607
|
*/
|
|
3608
3608
|
readonly dashboardId: string;
|
|
3609
3609
|
/**
|
|
3610
3610
|
*
|
|
3611
|
-
* @type {
|
|
3612
|
-
* @memberof
|
|
3611
|
+
* @type {ExportDashboardTabularExportRequest}
|
|
3612
|
+
* @memberof TabularExportExportCreateDashboardExportRequest
|
|
3613
3613
|
*/
|
|
3614
|
-
readonly
|
|
3614
|
+
readonly exportDashboardTabularExportRequest: ExportDashboardTabularExportRequest;
|
|
3615
3615
|
}
|
|
3616
3616
|
/**
|
|
3617
|
-
* Request parameters for createTabularExport operation in
|
|
3617
|
+
* Request parameters for createTabularExport operation in TabularExportExport.
|
|
3618
3618
|
* @export
|
|
3619
|
-
* @interface
|
|
3619
|
+
* @interface TabularExportExportCreateTabularExportRequest
|
|
3620
3620
|
*/
|
|
3621
|
-
export interface
|
|
3621
|
+
export interface TabularExportExportCreateTabularExportRequest {
|
|
3622
3622
|
/**
|
|
3623
3623
|
*
|
|
3624
3624
|
* @type {string}
|
|
3625
|
-
* @memberof
|
|
3625
|
+
* @memberof TabularExportExportCreateTabularExport
|
|
3626
3626
|
*/
|
|
3627
3627
|
readonly workspaceId: string;
|
|
3628
3628
|
/**
|
|
3629
3629
|
*
|
|
3630
|
-
* @type {
|
|
3631
|
-
* @memberof
|
|
3630
|
+
* @type {ExportTabularExportRequest}
|
|
3631
|
+
* @memberof TabularExportExportCreateTabularExport
|
|
3632
3632
|
*/
|
|
3633
|
-
readonly
|
|
3633
|
+
readonly exportTabularExportRequest: ExportTabularExportRequest;
|
|
3634
3634
|
}
|
|
3635
3635
|
/**
|
|
3636
|
-
* Request parameters for getTabularExport operation in
|
|
3636
|
+
* Request parameters for getTabularExport operation in TabularExportExport.
|
|
3637
3637
|
* @export
|
|
3638
|
-
* @interface
|
|
3638
|
+
* @interface TabularExportExportGetTabularExportRequest
|
|
3639
3639
|
*/
|
|
3640
|
-
export interface
|
|
3640
|
+
export interface TabularExportExportGetTabularExportRequest {
|
|
3641
3641
|
/**
|
|
3642
3642
|
*
|
|
3643
3643
|
* @type {string}
|
|
3644
|
-
* @memberof
|
|
3644
|
+
* @memberof TabularExportExportGetTabularExport
|
|
3645
3645
|
*/
|
|
3646
3646
|
readonly workspaceId: string;
|
|
3647
3647
|
/**
|
|
3648
3648
|
*
|
|
3649
3649
|
* @type {string}
|
|
3650
|
-
* @memberof
|
|
3650
|
+
* @memberof TabularExportExportGetTabularExport
|
|
3651
3651
|
*/
|
|
3652
3652
|
readonly exportId: string;
|
|
3653
3653
|
}
|
|
3654
3654
|
/**
|
|
3655
|
-
*
|
|
3655
|
+
* TabularExportExport - object-oriented interface
|
|
3656
3656
|
* @export
|
|
3657
|
-
* @class
|
|
3657
|
+
* @class TabularExportExport
|
|
3658
3658
|
* @extends {BaseAPI}
|
|
3659
3659
|
*/
|
|
3660
|
-
export declare class
|
|
3660
|
+
export declare class TabularExportExport extends BaseAPI implements TabularExportExportInterface {
|
|
3661
3661
|
/**
|
|
3662
3662
|
* 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.
|
|
3663
3663
|
* @summary (EXPERIMENTAL) Create dashboard tabular export request
|
|
3664
|
-
* @param {
|
|
3664
|
+
* @param {TabularExportExportCreateDashboardExportRequestRequest} requestParameters Request parameters.
|
|
3665
3665
|
* @param {*} [options] Override http request option.
|
|
3666
3666
|
* @throws {RequiredError}
|
|
3667
|
-
* @memberof
|
|
3667
|
+
* @memberof TabularExportExport
|
|
3668
3668
|
*/
|
|
3669
|
-
createDashboardExportRequest(requestParameters:
|
|
3669
|
+
createDashboardExportRequest(requestParameters: TabularExportExportCreateDashboardExportRequestRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ExportExportResponse, any>>;
|
|
3670
3670
|
/**
|
|
3671
3671
|
* 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.
|
|
3672
3672
|
* @summary Create tabular export request
|
|
3673
|
-
* @param {
|
|
3673
|
+
* @param {TabularExportExportCreateTabularExportRequest} requestParameters Request parameters.
|
|
3674
3674
|
* @param {*} [options] Override http request option.
|
|
3675
3675
|
* @throws {RequiredError}
|
|
3676
|
-
* @memberof
|
|
3676
|
+
* @memberof TabularExportExport
|
|
3677
3677
|
*/
|
|
3678
|
-
createTabularExport(requestParameters:
|
|
3678
|
+
createTabularExport(requestParameters: TabularExportExportCreateTabularExportRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ExportExportResponse, any>>;
|
|
3679
3679
|
/**
|
|
3680
3680
|
* 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.
|
|
3681
3681
|
* @summary Retrieve exported files
|
|
3682
|
-
* @param {
|
|
3682
|
+
* @param {TabularExportExportGetTabularExportRequest} requestParameters Request parameters.
|
|
3683
3683
|
* @param {*} [options] Override http request option.
|
|
3684
3684
|
* @throws {RequiredError}
|
|
3685
|
-
* @memberof
|
|
3685
|
+
* @memberof TabularExportExport
|
|
3686
3686
|
*/
|
|
3687
|
-
getTabularExport(requestParameters:
|
|
3687
|
+
getTabularExport(requestParameters: TabularExportExportGetTabularExportRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
3688
3688
|
}
|
|
3689
3689
|
/**
|
|
3690
|
-
*
|
|
3690
|
+
* VisualExportExport - axios parameter creator
|
|
3691
3691
|
* @export
|
|
3692
3692
|
*/
|
|
3693
|
-
export declare const
|
|
3693
|
+
export declare const VisualExportExportAxiosParamCreator: (configuration?: Configuration) => {
|
|
3694
3694
|
/**
|
|
3695
3695
|
* 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.
|
|
3696
3696
|
* @summary Create visual - pdf export request
|
|
3697
3697
|
* @param {string} workspaceId
|
|
3698
|
-
* @param {
|
|
3698
|
+
* @param {ExportVisualExportRequest} exportVisualExportRequest
|
|
3699
3699
|
* @param {*} [options] Override http request option.
|
|
3700
3700
|
* @throws {RequiredError}
|
|
3701
3701
|
*/
|
|
3702
|
-
createPdfExport: (workspaceId: string,
|
|
3702
|
+
createPdfExport: (workspaceId: string, exportVisualExportRequest: ExportVisualExportRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3703
3703
|
/**
|
|
3704
3704
|
* Returns 202 until original POST export request is not processed.Returns 200 with exported data once the export is done.
|
|
3705
3705
|
* @summary Retrieve exported files
|
|
@@ -3720,19 +3720,19 @@ export declare const VisualExportApiAxiosParamCreator: (configuration?: Configur
|
|
|
3720
3720
|
getMetadata: (workspaceId: string, exportId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3721
3721
|
};
|
|
3722
3722
|
/**
|
|
3723
|
-
*
|
|
3723
|
+
* VisualExportExport - functional programming interface
|
|
3724
3724
|
* @export
|
|
3725
3725
|
*/
|
|
3726
|
-
export declare const
|
|
3726
|
+
export declare const VisualExportExportFp: (configuration?: Configuration) => {
|
|
3727
3727
|
/**
|
|
3728
3728
|
* 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.
|
|
3729
3729
|
* @summary Create visual - pdf export request
|
|
3730
3730
|
* @param {string} workspaceId
|
|
3731
|
-
* @param {
|
|
3731
|
+
* @param {ExportVisualExportRequest} exportVisualExportRequest
|
|
3732
3732
|
* @param {*} [options] Override http request option.
|
|
3733
3733
|
* @throws {RequiredError}
|
|
3734
3734
|
*/
|
|
3735
|
-
createPdfExport(workspaceId: string,
|
|
3735
|
+
createPdfExport(workspaceId: string, exportVisualExportRequest: ExportVisualExportRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExportExportResponse>>;
|
|
3736
3736
|
/**
|
|
3737
3737
|
* Returns 202 until original POST export request is not processed.Returns 200 with exported data once the export is done.
|
|
3738
3738
|
* @summary Retrieve exported files
|
|
@@ -3753,159 +3753,159 @@ export declare const VisualExportApiFp: (configuration?: Configuration) => {
|
|
|
3753
3753
|
getMetadata(workspaceId: string, exportId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
3754
3754
|
};
|
|
3755
3755
|
/**
|
|
3756
|
-
*
|
|
3756
|
+
* VisualExportExport - factory interface
|
|
3757
3757
|
* @export
|
|
3758
3758
|
*/
|
|
3759
|
-
export declare const
|
|
3759
|
+
export declare const VisualExportExportFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
3760
3760
|
/**
|
|
3761
3761
|
* 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.
|
|
3762
3762
|
* @summary Create visual - pdf export request
|
|
3763
|
-
* @param {
|
|
3763
|
+
* @param {VisualExportExportCreatePdfExportRequest} requestParameters Request parameters.
|
|
3764
3764
|
* @param {*} [options] Override http request option.
|
|
3765
3765
|
* @throws {RequiredError}
|
|
3766
3766
|
*/
|
|
3767
|
-
createPdfExport(requestParameters:
|
|
3767
|
+
createPdfExport(requestParameters: VisualExportExportCreatePdfExportRequest, options?: AxiosRequestConfig): AxiosPromise<ExportExportResponse>;
|
|
3768
3768
|
/**
|
|
3769
3769
|
* Returns 202 until original POST export request is not processed.Returns 200 with exported data once the export is done.
|
|
3770
3770
|
* @summary Retrieve exported files
|
|
3771
|
-
* @param {
|
|
3771
|
+
* @param {VisualExportExportGetExportedFileRequest} requestParameters Request parameters.
|
|
3772
3772
|
* @param {*} [options] Override http request option.
|
|
3773
3773
|
* @throws {RequiredError}
|
|
3774
3774
|
*/
|
|
3775
|
-
getExportedFile(requestParameters:
|
|
3775
|
+
getExportedFile(requestParameters: VisualExportExportGetExportedFileRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
3776
3776
|
/**
|
|
3777
3777
|
* 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.
|
|
3778
3778
|
* @summary Retrieve metadata context
|
|
3779
|
-
* @param {
|
|
3779
|
+
* @param {VisualExportExportGetMetadataRequest} requestParameters Request parameters.
|
|
3780
3780
|
* @param {*} [options] Override http request option.
|
|
3781
3781
|
* @throws {RequiredError}
|
|
3782
3782
|
*/
|
|
3783
|
-
getMetadata(requestParameters:
|
|
3783
|
+
getMetadata(requestParameters: VisualExportExportGetMetadataRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
3784
3784
|
};
|
|
3785
3785
|
/**
|
|
3786
|
-
*
|
|
3786
|
+
* VisualExportExport - interface
|
|
3787
3787
|
* @export
|
|
3788
|
-
* @interface
|
|
3788
|
+
* @interface VisualExportExport
|
|
3789
3789
|
*/
|
|
3790
|
-
export interface
|
|
3790
|
+
export interface VisualExportExportInterface {
|
|
3791
3791
|
/**
|
|
3792
3792
|
* 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.
|
|
3793
3793
|
* @summary Create visual - pdf export request
|
|
3794
|
-
* @param {
|
|
3794
|
+
* @param {VisualExportExportCreatePdfExportRequest} requestParameters Request parameters.
|
|
3795
3795
|
* @param {*} [options] Override http request option.
|
|
3796
3796
|
* @throws {RequiredError}
|
|
3797
|
-
* @memberof
|
|
3797
|
+
* @memberof VisualExportExportInterface
|
|
3798
3798
|
*/
|
|
3799
|
-
createPdfExport(requestParameters:
|
|
3799
|
+
createPdfExport(requestParameters: VisualExportExportCreatePdfExportRequest, options?: AxiosRequestConfig): AxiosPromise<ExportExportResponse>;
|
|
3800
3800
|
/**
|
|
3801
3801
|
* Returns 202 until original POST export request is not processed.Returns 200 with exported data once the export is done.
|
|
3802
3802
|
* @summary Retrieve exported files
|
|
3803
|
-
* @param {
|
|
3803
|
+
* @param {VisualExportExportGetExportedFileRequest} requestParameters Request parameters.
|
|
3804
3804
|
* @param {*} [options] Override http request option.
|
|
3805
3805
|
* @throws {RequiredError}
|
|
3806
|
-
* @memberof
|
|
3806
|
+
* @memberof VisualExportExportInterface
|
|
3807
3807
|
*/
|
|
3808
|
-
getExportedFile(requestParameters:
|
|
3808
|
+
getExportedFile(requestParameters: VisualExportExportGetExportedFileRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
3809
3809
|
/**
|
|
3810
3810
|
* 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.
|
|
3811
3811
|
* @summary Retrieve metadata context
|
|
3812
|
-
* @param {
|
|
3812
|
+
* @param {VisualExportExportGetMetadataRequest} requestParameters Request parameters.
|
|
3813
3813
|
* @param {*} [options] Override http request option.
|
|
3814
3814
|
* @throws {RequiredError}
|
|
3815
|
-
* @memberof
|
|
3815
|
+
* @memberof VisualExportExportInterface
|
|
3816
3816
|
*/
|
|
3817
|
-
getMetadata(requestParameters:
|
|
3817
|
+
getMetadata(requestParameters: VisualExportExportGetMetadataRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
3818
3818
|
}
|
|
3819
3819
|
/**
|
|
3820
|
-
* Request parameters for createPdfExport operation in
|
|
3820
|
+
* Request parameters for createPdfExport operation in VisualExportExport.
|
|
3821
3821
|
* @export
|
|
3822
|
-
* @interface
|
|
3822
|
+
* @interface VisualExportExportCreatePdfExportRequest
|
|
3823
3823
|
*/
|
|
3824
|
-
export interface
|
|
3824
|
+
export interface VisualExportExportCreatePdfExportRequest {
|
|
3825
3825
|
/**
|
|
3826
3826
|
*
|
|
3827
3827
|
* @type {string}
|
|
3828
|
-
* @memberof
|
|
3828
|
+
* @memberof VisualExportExportCreatePdfExport
|
|
3829
3829
|
*/
|
|
3830
3830
|
readonly workspaceId: string;
|
|
3831
3831
|
/**
|
|
3832
3832
|
*
|
|
3833
|
-
* @type {
|
|
3834
|
-
* @memberof
|
|
3833
|
+
* @type {ExportVisualExportRequest}
|
|
3834
|
+
* @memberof VisualExportExportCreatePdfExport
|
|
3835
3835
|
*/
|
|
3836
|
-
readonly
|
|
3836
|
+
readonly exportVisualExportRequest: ExportVisualExportRequest;
|
|
3837
3837
|
}
|
|
3838
3838
|
/**
|
|
3839
|
-
* Request parameters for getExportedFile operation in
|
|
3839
|
+
* Request parameters for getExportedFile operation in VisualExportExport.
|
|
3840
3840
|
* @export
|
|
3841
|
-
* @interface
|
|
3841
|
+
* @interface VisualExportExportGetExportedFileRequest
|
|
3842
3842
|
*/
|
|
3843
|
-
export interface
|
|
3843
|
+
export interface VisualExportExportGetExportedFileRequest {
|
|
3844
3844
|
/**
|
|
3845
3845
|
*
|
|
3846
3846
|
* @type {string}
|
|
3847
|
-
* @memberof
|
|
3847
|
+
* @memberof VisualExportExportGetExportedFile
|
|
3848
3848
|
*/
|
|
3849
3849
|
readonly workspaceId: string;
|
|
3850
3850
|
/**
|
|
3851
3851
|
*
|
|
3852
3852
|
* @type {string}
|
|
3853
|
-
* @memberof
|
|
3853
|
+
* @memberof VisualExportExportGetExportedFile
|
|
3854
3854
|
*/
|
|
3855
3855
|
readonly exportId: string;
|
|
3856
3856
|
}
|
|
3857
3857
|
/**
|
|
3858
|
-
* Request parameters for getMetadata operation in
|
|
3858
|
+
* Request parameters for getMetadata operation in VisualExportExport.
|
|
3859
3859
|
* @export
|
|
3860
|
-
* @interface
|
|
3860
|
+
* @interface VisualExportExportGetMetadataRequest
|
|
3861
3861
|
*/
|
|
3862
|
-
export interface
|
|
3862
|
+
export interface VisualExportExportGetMetadataRequest {
|
|
3863
3863
|
/**
|
|
3864
3864
|
*
|
|
3865
3865
|
* @type {string}
|
|
3866
|
-
* @memberof
|
|
3866
|
+
* @memberof VisualExportExportGetMetadata
|
|
3867
3867
|
*/
|
|
3868
3868
|
readonly workspaceId: string;
|
|
3869
3869
|
/**
|
|
3870
3870
|
*
|
|
3871
3871
|
* @type {string}
|
|
3872
|
-
* @memberof
|
|
3872
|
+
* @memberof VisualExportExportGetMetadata
|
|
3873
3873
|
*/
|
|
3874
3874
|
readonly exportId: string;
|
|
3875
3875
|
}
|
|
3876
3876
|
/**
|
|
3877
|
-
*
|
|
3877
|
+
* VisualExportExport - object-oriented interface
|
|
3878
3878
|
* @export
|
|
3879
|
-
* @class
|
|
3879
|
+
* @class VisualExportExport
|
|
3880
3880
|
* @extends {BaseAPI}
|
|
3881
3881
|
*/
|
|
3882
|
-
export declare class
|
|
3882
|
+
export declare class VisualExportExport extends BaseAPI implements VisualExportExportInterface {
|
|
3883
3883
|
/**
|
|
3884
3884
|
* 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.
|
|
3885
3885
|
* @summary Create visual - pdf export request
|
|
3886
|
-
* @param {
|
|
3886
|
+
* @param {VisualExportExportCreatePdfExportRequest} requestParameters Request parameters.
|
|
3887
3887
|
* @param {*} [options] Override http request option.
|
|
3888
3888
|
* @throws {RequiredError}
|
|
3889
|
-
* @memberof
|
|
3889
|
+
* @memberof VisualExportExport
|
|
3890
3890
|
*/
|
|
3891
|
-
createPdfExport(requestParameters:
|
|
3891
|
+
createPdfExport(requestParameters: VisualExportExportCreatePdfExportRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ExportExportResponse, any>>;
|
|
3892
3892
|
/**
|
|
3893
3893
|
* Returns 202 until original POST export request is not processed.Returns 200 with exported data once the export is done.
|
|
3894
3894
|
* @summary Retrieve exported files
|
|
3895
|
-
* @param {
|
|
3895
|
+
* @param {VisualExportExportGetExportedFileRequest} requestParameters Request parameters.
|
|
3896
3896
|
* @param {*} [options] Override http request option.
|
|
3897
3897
|
* @throws {RequiredError}
|
|
3898
|
-
* @memberof
|
|
3898
|
+
* @memberof VisualExportExport
|
|
3899
3899
|
*/
|
|
3900
|
-
getExportedFile(requestParameters:
|
|
3900
|
+
getExportedFile(requestParameters: VisualExportExportGetExportedFileRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
3901
3901
|
/**
|
|
3902
3902
|
* 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.
|
|
3903
3903
|
* @summary Retrieve metadata context
|
|
3904
|
-
* @param {
|
|
3904
|
+
* @param {VisualExportExportGetMetadataRequest} requestParameters Request parameters.
|
|
3905
3905
|
* @param {*} [options] Override http request option.
|
|
3906
3906
|
* @throws {RequiredError}
|
|
3907
|
-
* @memberof
|
|
3907
|
+
* @memberof VisualExportExport
|
|
3908
3908
|
*/
|
|
3909
|
-
getMetadata(requestParameters:
|
|
3909
|
+
getMetadata(requestParameters: VisualExportExportGetMetadataRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
3910
3910
|
}
|
|
3911
3911
|
//# sourceMappingURL=api.d.ts.map
|