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