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