@connectreport/connectreport-js 2.81.0-beta.1 → 2.81.0-beta.3
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/README.md +1 -1
- package/api.ts +667 -62
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/index.cjs +291 -26
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +475 -54
- package/dist/index.d.ts +475 -54
- package/dist/index.js +289 -26
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/api.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* ConnectReport Core API
|
|
5
5
|
* Leverage core reporting, templating, and document automation capabilities of ConnectReport Server.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 2.80.
|
|
7
|
+
* The version of the OpenAPI document: 2.80.5
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -21,6 +21,150 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj
|
|
|
21
21
|
// @ts-ignore
|
|
22
22
|
import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from './base';
|
|
23
23
|
|
|
24
|
+
/**
|
|
25
|
+
* Configuration for data-driven report cycles where each row in a data source creates a child report task
|
|
26
|
+
* @export
|
|
27
|
+
* @interface CycleConfig
|
|
28
|
+
*/
|
|
29
|
+
export interface CycleConfig {
|
|
30
|
+
/**
|
|
31
|
+
* Type of cycle configuration - \'filters\' for Dynamic Filters, \'recipients\' for Dynamic Recipients
|
|
32
|
+
* @type {string}
|
|
33
|
+
* @memberof CycleConfig
|
|
34
|
+
*/
|
|
35
|
+
configType: CycleConfigConfigTypeEnum;
|
|
36
|
+
/**
|
|
37
|
+
* Data connector name (case-insensitive)
|
|
38
|
+
* @type {string}
|
|
39
|
+
* @memberof CycleConfig
|
|
40
|
+
*/
|
|
41
|
+
connector: string;
|
|
42
|
+
/**
|
|
43
|
+
* Data source document ID
|
|
44
|
+
* @type {string}
|
|
45
|
+
* @memberof CycleConfig
|
|
46
|
+
*/
|
|
47
|
+
docId: string;
|
|
48
|
+
/**
|
|
49
|
+
* Columns to query - defines what data to fetch (each row creates a child task)
|
|
50
|
+
* @type {Array<FieldInfo>}
|
|
51
|
+
* @memberof CycleConfig
|
|
52
|
+
*/
|
|
53
|
+
tableColumns: Array<FieldInfo>;
|
|
54
|
+
/**
|
|
55
|
+
*
|
|
56
|
+
* @type {RowExclusion}
|
|
57
|
+
* @memberof CycleConfig
|
|
58
|
+
*/
|
|
59
|
+
excludedValues?: RowExclusion;
|
|
60
|
+
/**
|
|
61
|
+
* Map source fields to report filter fields
|
|
62
|
+
* @type {Array<FilterMapping>}
|
|
63
|
+
* @memberof CycleConfig
|
|
64
|
+
*/
|
|
65
|
+
filterMappings?: Array<FilterMapping>;
|
|
66
|
+
/**
|
|
67
|
+
*
|
|
68
|
+
* @type {FieldInfo}
|
|
69
|
+
* @memberof CycleConfig
|
|
70
|
+
*/
|
|
71
|
+
recipientsFieldInfo?: FieldInfo;
|
|
72
|
+
/**
|
|
73
|
+
*
|
|
74
|
+
* @type {FieldInfo}
|
|
75
|
+
* @memberof CycleConfig
|
|
76
|
+
*/
|
|
77
|
+
emailSubjectFieldInfo?: FieldInfo;
|
|
78
|
+
/**
|
|
79
|
+
*
|
|
80
|
+
* @type {FieldInfo}
|
|
81
|
+
* @memberof CycleConfig
|
|
82
|
+
*/
|
|
83
|
+
emailBodyFieldInfo?: FieldInfo;
|
|
84
|
+
/**
|
|
85
|
+
*
|
|
86
|
+
* @type {FieldInfo}
|
|
87
|
+
* @memberof CycleConfig
|
|
88
|
+
*/
|
|
89
|
+
titleFieldInfo?: FieldInfo;
|
|
90
|
+
/**
|
|
91
|
+
*
|
|
92
|
+
* @type {FieldInfo}
|
|
93
|
+
* @memberof CycleConfig
|
|
94
|
+
*/
|
|
95
|
+
oneDriveParentFolderIdFieldInfo?: FieldInfo;
|
|
96
|
+
/**
|
|
97
|
+
*
|
|
98
|
+
* @type {FieldInfo}
|
|
99
|
+
* @memberof CycleConfig
|
|
100
|
+
*/
|
|
101
|
+
tagsFieldInfo?: FieldInfo;
|
|
102
|
+
/**
|
|
103
|
+
*
|
|
104
|
+
* @type {FieldInfo}
|
|
105
|
+
* @memberof CycleConfig
|
|
106
|
+
*/
|
|
107
|
+
groupsToShareWithFieldInfo?: FieldInfo;
|
|
108
|
+
/**
|
|
109
|
+
*
|
|
110
|
+
* @type {FieldInfo}
|
|
111
|
+
* @memberof CycleConfig
|
|
112
|
+
*/
|
|
113
|
+
emailFieldInfo?: FieldInfo;
|
|
114
|
+
/**
|
|
115
|
+
* Automatically tag child reports with first column value
|
|
116
|
+
* @type {boolean}
|
|
117
|
+
* @memberof CycleConfig
|
|
118
|
+
*/
|
|
119
|
+
autotag?: boolean;
|
|
120
|
+
}
|
|
121
|
+
|
|
122
|
+
/**
|
|
123
|
+
* @export
|
|
124
|
+
* @enum {string}
|
|
125
|
+
*/
|
|
126
|
+
export enum CycleConfigConfigTypeEnum {
|
|
127
|
+
Filters = 'filters',
|
|
128
|
+
Recipients = 'recipients'
|
|
129
|
+
}
|
|
130
|
+
|
|
131
|
+
/**
|
|
132
|
+
* Field metadata from data source
|
|
133
|
+
* @export
|
|
134
|
+
* @interface FieldInfo
|
|
135
|
+
*/
|
|
136
|
+
export interface FieldInfo {
|
|
137
|
+
/**
|
|
138
|
+
* Display name of the field
|
|
139
|
+
* @type {string}
|
|
140
|
+
* @memberof FieldInfo
|
|
141
|
+
*/
|
|
142
|
+
fieldName?: string;
|
|
143
|
+
/**
|
|
144
|
+
* Definition/expression of the field
|
|
145
|
+
* @type {string}
|
|
146
|
+
* @memberof FieldInfo
|
|
147
|
+
*/
|
|
148
|
+
fieldDef: string;
|
|
149
|
+
/**
|
|
150
|
+
* Unique identifier of the field
|
|
151
|
+
* @type {string}
|
|
152
|
+
* @memberof FieldInfo
|
|
153
|
+
*/
|
|
154
|
+
id?: string;
|
|
155
|
+
/**
|
|
156
|
+
* Table identifier
|
|
157
|
+
* @type {string}
|
|
158
|
+
* @memberof FieldInfo
|
|
159
|
+
*/
|
|
160
|
+
table?: string;
|
|
161
|
+
/**
|
|
162
|
+
* Display name of the table
|
|
163
|
+
* @type {string}
|
|
164
|
+
* @memberof FieldInfo
|
|
165
|
+
*/
|
|
166
|
+
tableName?: string;
|
|
167
|
+
}
|
|
24
168
|
/**
|
|
25
169
|
*
|
|
26
170
|
* @export
|
|
@@ -165,6 +309,18 @@ export interface FilterCycle {
|
|
|
165
309
|
* @memberof FilterCycle
|
|
166
310
|
*/
|
|
167
311
|
emailBody?: string;
|
|
312
|
+
/**
|
|
313
|
+
* The ID of the OneDrive folder to publish the report to
|
|
314
|
+
* @type {string}
|
|
315
|
+
* @memberof FilterCycle
|
|
316
|
+
*/
|
|
317
|
+
onedriveParentFolderId?: string;
|
|
318
|
+
/**
|
|
319
|
+
*
|
|
320
|
+
* @type {CycleConfig}
|
|
321
|
+
* @memberof FilterCycle
|
|
322
|
+
*/
|
|
323
|
+
cycle?: CycleConfig;
|
|
168
324
|
/**
|
|
169
325
|
*
|
|
170
326
|
* @type {FilterCycleAllOfFieldInfo}
|
|
@@ -178,7 +334,7 @@ export interface FilterCycle {
|
|
|
178
334
|
*/
|
|
179
335
|
fieldValues?: Array<FilterCycleAllOfFieldValues>;
|
|
180
336
|
/**
|
|
181
|
-
*
|
|
337
|
+
* This field is deprecated in favor of docId.
|
|
182
338
|
* @type {string}
|
|
183
339
|
* @memberof FilterCycle
|
|
184
340
|
*/
|
|
@@ -195,6 +351,18 @@ export interface FilterCycle {
|
|
|
195
351
|
* @memberof FilterCycle
|
|
196
352
|
*/
|
|
197
353
|
autotag?: boolean;
|
|
354
|
+
/**
|
|
355
|
+
*
|
|
356
|
+
* @type {string}
|
|
357
|
+
* @memberof FilterCycle
|
|
358
|
+
*/
|
|
359
|
+
docId?: string;
|
|
360
|
+
/**
|
|
361
|
+
*
|
|
362
|
+
* @type {string}
|
|
363
|
+
* @memberof FilterCycle
|
|
364
|
+
*/
|
|
365
|
+
connectorName?: string;
|
|
198
366
|
}
|
|
199
367
|
|
|
200
368
|
/**
|
|
@@ -240,7 +408,7 @@ export interface FilterCycleAllOf {
|
|
|
240
408
|
*/
|
|
241
409
|
fieldValues?: Array<FilterCycleAllOfFieldValues>;
|
|
242
410
|
/**
|
|
243
|
-
*
|
|
411
|
+
* This field is deprecated in favor of docId.
|
|
244
412
|
* @type {string}
|
|
245
413
|
* @memberof FilterCycleAllOf
|
|
246
414
|
*/
|
|
@@ -257,6 +425,18 @@ export interface FilterCycleAllOf {
|
|
|
257
425
|
* @memberof FilterCycleAllOf
|
|
258
426
|
*/
|
|
259
427
|
autotag?: boolean;
|
|
428
|
+
/**
|
|
429
|
+
*
|
|
430
|
+
* @type {string}
|
|
431
|
+
* @memberof FilterCycleAllOf
|
|
432
|
+
*/
|
|
433
|
+
docId?: string;
|
|
434
|
+
/**
|
|
435
|
+
*
|
|
436
|
+
* @type {string}
|
|
437
|
+
* @memberof FilterCycleAllOf
|
|
438
|
+
*/
|
|
439
|
+
connectorName?: string;
|
|
260
440
|
}
|
|
261
441
|
/**
|
|
262
442
|
*
|
|
@@ -308,6 +488,25 @@ export interface FilterCycleAllOfFieldValues {
|
|
|
308
488
|
*/
|
|
309
489
|
number?: number;
|
|
310
490
|
}
|
|
491
|
+
/**
|
|
492
|
+
* Maps a source table field to a report filter field
|
|
493
|
+
* @export
|
|
494
|
+
* @interface FilterMapping
|
|
495
|
+
*/
|
|
496
|
+
export interface FilterMapping {
|
|
497
|
+
/**
|
|
498
|
+
*
|
|
499
|
+
* @type {FieldInfo}
|
|
500
|
+
* @memberof FilterMapping
|
|
501
|
+
*/
|
|
502
|
+
from: FieldInfo;
|
|
503
|
+
/**
|
|
504
|
+
*
|
|
505
|
+
* @type {FieldInfo}
|
|
506
|
+
* @memberof FilterMapping
|
|
507
|
+
*/
|
|
508
|
+
to: FieldInfo;
|
|
509
|
+
}
|
|
311
510
|
/**
|
|
312
511
|
*
|
|
313
512
|
* @export
|
|
@@ -335,10 +534,16 @@ export interface InlineResponse200 {
|
|
|
335
534
|
export interface InlineResponse2001 {
|
|
336
535
|
/**
|
|
337
536
|
*
|
|
338
|
-
* @type {
|
|
537
|
+
* @type {Array<ReportTaskResponse>}
|
|
339
538
|
* @memberof InlineResponse2001
|
|
340
539
|
*/
|
|
341
|
-
|
|
540
|
+
reportTasks?: Array<ReportTaskResponse>;
|
|
541
|
+
/**
|
|
542
|
+
*
|
|
543
|
+
* @type {number}
|
|
544
|
+
* @memberof InlineResponse2001
|
|
545
|
+
*/
|
|
546
|
+
totalPages?: number;
|
|
342
547
|
}
|
|
343
548
|
/**
|
|
344
549
|
*
|
|
@@ -348,16 +553,22 @@ export interface InlineResponse2001 {
|
|
|
348
553
|
export interface InlineResponse2002 {
|
|
349
554
|
/**
|
|
350
555
|
*
|
|
351
|
-
* @type {Array<
|
|
556
|
+
* @type {Array<Report>}
|
|
352
557
|
* @memberof InlineResponse2002
|
|
353
558
|
*/
|
|
354
|
-
|
|
559
|
+
reports?: Array<Report>;
|
|
355
560
|
/**
|
|
356
561
|
*
|
|
357
562
|
* @type {number}
|
|
358
563
|
* @memberof InlineResponse2002
|
|
359
564
|
*/
|
|
360
565
|
totalPages?: number;
|
|
566
|
+
/**
|
|
567
|
+
*
|
|
568
|
+
* @type {number}
|
|
569
|
+
* @memberof InlineResponse2002
|
|
570
|
+
*/
|
|
571
|
+
totalItems?: number;
|
|
361
572
|
}
|
|
362
573
|
/**
|
|
363
574
|
*
|
|
@@ -367,22 +578,16 @@ export interface InlineResponse2002 {
|
|
|
367
578
|
export interface InlineResponse2003 {
|
|
368
579
|
/**
|
|
369
580
|
*
|
|
370
|
-
* @type {Array<
|
|
581
|
+
* @type {Array<Template>}
|
|
371
582
|
* @memberof InlineResponse2003
|
|
372
583
|
*/
|
|
373
|
-
|
|
584
|
+
templates?: Array<Template>;
|
|
374
585
|
/**
|
|
375
586
|
*
|
|
376
587
|
* @type {number}
|
|
377
588
|
* @memberof InlineResponse2003
|
|
378
589
|
*/
|
|
379
590
|
totalPages?: number;
|
|
380
|
-
/**
|
|
381
|
-
*
|
|
382
|
-
* @type {number}
|
|
383
|
-
* @memberof InlineResponse2003
|
|
384
|
-
*/
|
|
385
|
-
totalItems?: number;
|
|
386
591
|
}
|
|
387
592
|
/**
|
|
388
593
|
*
|
|
@@ -392,16 +597,10 @@ export interface InlineResponse2003 {
|
|
|
392
597
|
export interface InlineResponse2004 {
|
|
393
598
|
/**
|
|
394
599
|
*
|
|
395
|
-
* @type {
|
|
396
|
-
* @memberof InlineResponse2004
|
|
397
|
-
*/
|
|
398
|
-
templates?: Array<Template>;
|
|
399
|
-
/**
|
|
400
|
-
*
|
|
401
|
-
* @type {number}
|
|
600
|
+
* @type {string}
|
|
402
601
|
* @memberof InlineResponse2004
|
|
403
602
|
*/
|
|
404
|
-
|
|
603
|
+
path?: string;
|
|
405
604
|
}
|
|
406
605
|
/**
|
|
407
606
|
*
|
|
@@ -556,7 +755,23 @@ export interface Report {
|
|
|
556
755
|
* @memberof Report
|
|
557
756
|
*/
|
|
558
757
|
sizeBytes?: number;
|
|
758
|
+
/**
|
|
759
|
+
* The type of report
|
|
760
|
+
* @type {string}
|
|
761
|
+
* @memberof Report
|
|
762
|
+
*/
|
|
763
|
+
type?: ReportTypeEnum;
|
|
764
|
+
}
|
|
765
|
+
|
|
766
|
+
/**
|
|
767
|
+
* @export
|
|
768
|
+
* @enum {string}
|
|
769
|
+
*/
|
|
770
|
+
export enum ReportTypeEnum {
|
|
771
|
+
PixelPerfect = 'pixel-perfect',
|
|
772
|
+
Excel = 'excel'
|
|
559
773
|
}
|
|
774
|
+
|
|
560
775
|
/**
|
|
561
776
|
*
|
|
562
777
|
* @export
|
|
@@ -701,6 +916,18 @@ export interface ReportTask {
|
|
|
701
916
|
* @memberof ReportTask
|
|
702
917
|
*/
|
|
703
918
|
emailBody?: string;
|
|
919
|
+
/**
|
|
920
|
+
* The ID of the OneDrive folder to publish the report to
|
|
921
|
+
* @type {string}
|
|
922
|
+
* @memberof ReportTask
|
|
923
|
+
*/
|
|
924
|
+
onedriveParentFolderId?: string;
|
|
925
|
+
/**
|
|
926
|
+
*
|
|
927
|
+
* @type {CycleConfig}
|
|
928
|
+
* @memberof ReportTask
|
|
929
|
+
*/
|
|
930
|
+
cycle?: CycleConfig;
|
|
704
931
|
}
|
|
705
932
|
|
|
706
933
|
/**
|
|
@@ -972,6 +1199,18 @@ export interface ReportTaskRequest {
|
|
|
972
1199
|
* @memberof ReportTaskRequest
|
|
973
1200
|
*/
|
|
974
1201
|
emailBody?: string;
|
|
1202
|
+
/**
|
|
1203
|
+
* The ID of the OneDrive folder to publish the report to
|
|
1204
|
+
* @type {string}
|
|
1205
|
+
* @memberof ReportTaskRequest
|
|
1206
|
+
*/
|
|
1207
|
+
onedriveParentFolderId?: string;
|
|
1208
|
+
/**
|
|
1209
|
+
*
|
|
1210
|
+
* @type {CycleConfig}
|
|
1211
|
+
* @memberof ReportTaskRequest
|
|
1212
|
+
*/
|
|
1213
|
+
cycle?: CycleConfig;
|
|
975
1214
|
/**
|
|
976
1215
|
* Emails to send the report to. This is only allowed if \"Allow reports to be shared with any email\" is to true.
|
|
977
1216
|
* @type {Array<string>}
|
|
@@ -1204,6 +1443,18 @@ export interface ReportTaskResponse {
|
|
|
1204
1443
|
* @memberof ReportTaskResponse
|
|
1205
1444
|
*/
|
|
1206
1445
|
emailBody?: string;
|
|
1446
|
+
/**
|
|
1447
|
+
* The ID of the OneDrive folder to publish the report to
|
|
1448
|
+
* @type {string}
|
|
1449
|
+
* @memberof ReportTaskResponse
|
|
1450
|
+
*/
|
|
1451
|
+
onedriveParentFolderId?: string;
|
|
1452
|
+
/**
|
|
1453
|
+
*
|
|
1454
|
+
* @type {CycleConfig}
|
|
1455
|
+
* @memberof ReportTaskResponse
|
|
1456
|
+
*/
|
|
1457
|
+
cycle?: CycleConfig;
|
|
1207
1458
|
/**
|
|
1208
1459
|
* Users to share the published report with. This field will be updated entirely if provided
|
|
1209
1460
|
* @type {Array<ReportTaskResponseAllOfUsersToShareWith>}
|
|
@@ -1457,6 +1708,44 @@ export interface ReportTaskVariables {
|
|
|
1457
1708
|
*/
|
|
1458
1709
|
value?: string;
|
|
1459
1710
|
}
|
|
1711
|
+
/**
|
|
1712
|
+
* Filter out rows where field matches specified values
|
|
1713
|
+
* @export
|
|
1714
|
+
* @interface RowExclusion
|
|
1715
|
+
*/
|
|
1716
|
+
export interface RowExclusion {
|
|
1717
|
+
/**
|
|
1718
|
+
*
|
|
1719
|
+
* @type {FieldInfo}
|
|
1720
|
+
* @memberof RowExclusion
|
|
1721
|
+
*/
|
|
1722
|
+
exclusionFieldInfo: FieldInfo;
|
|
1723
|
+
/**
|
|
1724
|
+
*
|
|
1725
|
+
* @type {Array<RowExclusionFieldValues>}
|
|
1726
|
+
* @memberof RowExclusion
|
|
1727
|
+
*/
|
|
1728
|
+
fieldValues: Array<RowExclusionFieldValues>;
|
|
1729
|
+
}
|
|
1730
|
+
/**
|
|
1731
|
+
*
|
|
1732
|
+
* @export
|
|
1733
|
+
* @interface RowExclusionFieldValues
|
|
1734
|
+
*/
|
|
1735
|
+
export interface RowExclusionFieldValues {
|
|
1736
|
+
/**
|
|
1737
|
+
*
|
|
1738
|
+
* @type {string}
|
|
1739
|
+
* @memberof RowExclusionFieldValues
|
|
1740
|
+
*/
|
|
1741
|
+
text: string;
|
|
1742
|
+
/**
|
|
1743
|
+
*
|
|
1744
|
+
* @type {number}
|
|
1745
|
+
* @memberof RowExclusionFieldValues
|
|
1746
|
+
*/
|
|
1747
|
+
number?: number;
|
|
1748
|
+
}
|
|
1460
1749
|
/**
|
|
1461
1750
|
*
|
|
1462
1751
|
* @export
|
|
@@ -1498,7 +1787,7 @@ export interface Template {
|
|
|
1498
1787
|
* @type {string}
|
|
1499
1788
|
* @memberof Template
|
|
1500
1789
|
*/
|
|
1501
|
-
type
|
|
1790
|
+
type?: TemplateTypeEnum;
|
|
1502
1791
|
}
|
|
1503
1792
|
|
|
1504
1793
|
/**
|
|
@@ -1618,6 +1907,50 @@ export const BaseTemplatesApiAxiosParamCreator = function (configuration?: Confi
|
|
|
1618
1907
|
|
|
1619
1908
|
|
|
1620
1909
|
|
|
1910
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);
|
|
1911
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1912
|
+
let formHeaders = {};
|
|
1913
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...formHeaders, ...options.headers};
|
|
1914
|
+
|
|
1915
|
+
return {
|
|
1916
|
+
url: toPathString(localVarUrlObj),
|
|
1917
|
+
options: localVarRequestOptions,
|
|
1918
|
+
};
|
|
1919
|
+
},
|
|
1920
|
+
/**
|
|
1921
|
+
*
|
|
1922
|
+
* @summary Get base template thumbnail
|
|
1923
|
+
* @param {string} id
|
|
1924
|
+
* @param {*} [options] Override http request option.
|
|
1925
|
+
* @throws {RequiredError}
|
|
1926
|
+
*/
|
|
1927
|
+
getBaseTemplateThumbnail: async (id: string, options: any = {}): Promise<RequestArgs> => {
|
|
1928
|
+
// verify required parameter 'id' is not null or undefined
|
|
1929
|
+
assertParamExists('getBaseTemplateThumbnail', 'id', id)
|
|
1930
|
+
const localVarPath = `/base-templates/{id}/thumbnail`
|
|
1931
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
1932
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1933
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1934
|
+
let baseOptions;
|
|
1935
|
+
if (configuration) {
|
|
1936
|
+
baseOptions = configuration.baseOptions;
|
|
1937
|
+
}
|
|
1938
|
+
|
|
1939
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
1940
|
+
const localVarHeaderParameter = {} as any;
|
|
1941
|
+
const localVarQueryParameter = {} as any;
|
|
1942
|
+
|
|
1943
|
+
// authentication ApiKeyAuth required
|
|
1944
|
+
await setApiKeyToObject(localVarHeaderParameter, "X-API-KEY", configuration)
|
|
1945
|
+
|
|
1946
|
+
// authentication BearerAuth required
|
|
1947
|
+
// http bearer authentication required
|
|
1948
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
1949
|
+
|
|
1950
|
+
// authentication CookieAuth required
|
|
1951
|
+
|
|
1952
|
+
|
|
1953
|
+
|
|
1621
1954
|
setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);
|
|
1622
1955
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1623
1956
|
let formHeaders = {};
|
|
@@ -1699,6 +2032,17 @@ export const BaseTemplatesApiFp = function(configuration?: Configuration) {
|
|
|
1699
2032
|
const localVarAxiosArgs = await localVarAxiosParamCreator.duplicateBaseTemplate(id, options);
|
|
1700
2033
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1701
2034
|
},
|
|
2035
|
+
/**
|
|
2036
|
+
*
|
|
2037
|
+
* @summary Get base template thumbnail
|
|
2038
|
+
* @param {string} id
|
|
2039
|
+
* @param {*} [options] Override http request option.
|
|
2040
|
+
* @throws {RequiredError}
|
|
2041
|
+
*/
|
|
2042
|
+
async getBaseTemplateThumbnail(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>> {
|
|
2043
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getBaseTemplateThumbnail(id, options);
|
|
2044
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
2045
|
+
},
|
|
1702
2046
|
/**
|
|
1703
2047
|
*
|
|
1704
2048
|
* @summary List base templates
|
|
@@ -1731,6 +2075,16 @@ export const BaseTemplatesApiFactory = function (configuration?: Configuration,
|
|
|
1731
2075
|
duplicateBaseTemplate(id: string, options?: any): AxiosPromise<Template> {
|
|
1732
2076
|
return localVarFp.duplicateBaseTemplate(id, options).then((request) => request(axios, basePath));
|
|
1733
2077
|
},
|
|
2078
|
+
/**
|
|
2079
|
+
*
|
|
2080
|
+
* @summary Get base template thumbnail
|
|
2081
|
+
* @param {string} id
|
|
2082
|
+
* @param {*} [options] Override http request option.
|
|
2083
|
+
* @throws {RequiredError}
|
|
2084
|
+
*/
|
|
2085
|
+
getBaseTemplateThumbnail(id: string, options?: any): AxiosPromise<any> {
|
|
2086
|
+
return localVarFp.getBaseTemplateThumbnail(id, options).then((request) => request(axios, basePath));
|
|
2087
|
+
},
|
|
1734
2088
|
/**
|
|
1735
2089
|
*
|
|
1736
2090
|
* @summary List base templates
|
|
@@ -1764,6 +2118,18 @@ export class BaseTemplatesApi extends BaseAPI {
|
|
|
1764
2118
|
return BaseTemplatesApiFp(this.configuration).duplicateBaseTemplate(id, options).then((request) => request(this.axios, this.basePath));
|
|
1765
2119
|
}
|
|
1766
2120
|
|
|
2121
|
+
/**
|
|
2122
|
+
*
|
|
2123
|
+
* @summary Get base template thumbnail
|
|
2124
|
+
* @param {string} id
|
|
2125
|
+
* @param {*} [options] Override http request option.
|
|
2126
|
+
* @throws {RequiredError}
|
|
2127
|
+
* @memberof BaseTemplatesApi
|
|
2128
|
+
*/
|
|
2129
|
+
public getBaseTemplateThumbnail(id: string, options?: any) {
|
|
2130
|
+
return BaseTemplatesApiFp(this.configuration).getBaseTemplateThumbnail(id, options).then((request) => request(this.axios, this.basePath));
|
|
2131
|
+
}
|
|
2132
|
+
|
|
1767
2133
|
/**
|
|
1768
2134
|
*
|
|
1769
2135
|
* @summary List base templates
|
|
@@ -1788,19 +2154,19 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
1788
2154
|
/**
|
|
1789
2155
|
*
|
|
1790
2156
|
* @summary Retrieve a generated document
|
|
1791
|
-
* @param {string}
|
|
2157
|
+
* @param {string} id
|
|
1792
2158
|
* @param {'pdf' | 'pptx' | 'xlsx' | 'csv'} fileType
|
|
1793
2159
|
* @param {string} [attachmentName] A document file title. This value is reflected back to the client in the fileName header.
|
|
1794
2160
|
* @param {*} [options] Override http request option.
|
|
1795
2161
|
* @throws {RequiredError}
|
|
1796
2162
|
*/
|
|
1797
|
-
getDocument: async (
|
|
1798
|
-
// verify required parameter '
|
|
1799
|
-
assertParamExists('getDocument', '
|
|
2163
|
+
getDocument: async (id: string, fileType: 'pdf' | 'pptx' | 'xlsx' | 'csv', attachmentName?: string, options: any = {}): Promise<RequestArgs> => {
|
|
2164
|
+
// verify required parameter 'id' is not null or undefined
|
|
2165
|
+
assertParamExists('getDocument', 'id', id)
|
|
1800
2166
|
// verify required parameter 'fileType' is not null or undefined
|
|
1801
2167
|
assertParamExists('getDocument', 'fileType', fileType)
|
|
1802
|
-
const localVarPath = `/documents/{fileType}/{
|
|
1803
|
-
.replace(`{${"
|
|
2168
|
+
const localVarPath = `/documents/{fileType}/{id}`
|
|
2169
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)))
|
|
1804
2170
|
.replace(`{${"fileType"}}`, encodeURIComponent(String(fileType)));
|
|
1805
2171
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1806
2172
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -1828,6 +2194,55 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
1828
2194
|
|
|
1829
2195
|
|
|
1830
2196
|
|
|
2197
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);
|
|
2198
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2199
|
+
let formHeaders = {};
|
|
2200
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...formHeaders, ...options.headers};
|
|
2201
|
+
|
|
2202
|
+
return {
|
|
2203
|
+
url: toPathString(localVarUrlObj),
|
|
2204
|
+
options: localVarRequestOptions,
|
|
2205
|
+
};
|
|
2206
|
+
},
|
|
2207
|
+
/**
|
|
2208
|
+
*
|
|
2209
|
+
* @summary Retrieve a generated document
|
|
2210
|
+
* @param {string} id
|
|
2211
|
+
* @param {string} [attachmentName] A document file title. This value is reflected back to the client in the fileName header.
|
|
2212
|
+
* @param {*} [options] Override http request option.
|
|
2213
|
+
* @throws {RequiredError}
|
|
2214
|
+
*/
|
|
2215
|
+
getDocumentById: async (id: string, attachmentName?: string, options: any = {}): Promise<RequestArgs> => {
|
|
2216
|
+
// verify required parameter 'id' is not null or undefined
|
|
2217
|
+
assertParamExists('getDocumentById', 'id', id)
|
|
2218
|
+
const localVarPath = `/documents/{id}`
|
|
2219
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
2220
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2221
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2222
|
+
let baseOptions;
|
|
2223
|
+
if (configuration) {
|
|
2224
|
+
baseOptions = configuration.baseOptions;
|
|
2225
|
+
}
|
|
2226
|
+
|
|
2227
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
2228
|
+
const localVarHeaderParameter = {} as any;
|
|
2229
|
+
const localVarQueryParameter = {} as any;
|
|
2230
|
+
|
|
2231
|
+
// authentication ApiKeyAuth required
|
|
2232
|
+
await setApiKeyToObject(localVarHeaderParameter, "X-API-KEY", configuration)
|
|
2233
|
+
|
|
2234
|
+
// authentication BearerAuth required
|
|
2235
|
+
// http bearer authentication required
|
|
2236
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
2237
|
+
|
|
2238
|
+
// authentication CookieAuth required
|
|
2239
|
+
|
|
2240
|
+
if (attachmentName !== undefined) {
|
|
2241
|
+
localVarQueryParameter['attachmentName'] = attachmentName;
|
|
2242
|
+
}
|
|
2243
|
+
|
|
2244
|
+
|
|
2245
|
+
|
|
1831
2246
|
setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);
|
|
1832
2247
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1833
2248
|
let formHeaders = {};
|
|
@@ -1851,14 +2266,26 @@ export const DocumentsApiFp = function(configuration?: Configuration) {
|
|
|
1851
2266
|
/**
|
|
1852
2267
|
*
|
|
1853
2268
|
* @summary Retrieve a generated document
|
|
1854
|
-
* @param {string}
|
|
2269
|
+
* @param {string} id
|
|
1855
2270
|
* @param {'pdf' | 'pptx' | 'xlsx' | 'csv'} fileType
|
|
1856
2271
|
* @param {string} [attachmentName] A document file title. This value is reflected back to the client in the fileName header.
|
|
1857
2272
|
* @param {*} [options] Override http request option.
|
|
1858
2273
|
* @throws {RequiredError}
|
|
1859
2274
|
*/
|
|
1860
|
-
async getDocument(
|
|
1861
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getDocument(
|
|
2275
|
+
async getDocument(id: string, fileType: 'pdf' | 'pptx' | 'xlsx' | 'csv', attachmentName?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>> {
|
|
2276
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getDocument(id, fileType, attachmentName, options);
|
|
2277
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
2278
|
+
},
|
|
2279
|
+
/**
|
|
2280
|
+
*
|
|
2281
|
+
* @summary Retrieve a generated document
|
|
2282
|
+
* @param {string} id
|
|
2283
|
+
* @param {string} [attachmentName] A document file title. This value is reflected back to the client in the fileName header.
|
|
2284
|
+
* @param {*} [options] Override http request option.
|
|
2285
|
+
* @throws {RequiredError}
|
|
2286
|
+
*/
|
|
2287
|
+
async getDocumentById(id: string, attachmentName?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>> {
|
|
2288
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getDocumentById(id, attachmentName, options);
|
|
1862
2289
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1863
2290
|
},
|
|
1864
2291
|
}
|
|
@@ -1874,14 +2301,25 @@ export const DocumentsApiFactory = function (configuration?: Configuration, base
|
|
|
1874
2301
|
/**
|
|
1875
2302
|
*
|
|
1876
2303
|
* @summary Retrieve a generated document
|
|
1877
|
-
* @param {string}
|
|
2304
|
+
* @param {string} id
|
|
1878
2305
|
* @param {'pdf' | 'pptx' | 'xlsx' | 'csv'} fileType
|
|
1879
2306
|
* @param {string} [attachmentName] A document file title. This value is reflected back to the client in the fileName header.
|
|
1880
2307
|
* @param {*} [options] Override http request option.
|
|
1881
2308
|
* @throws {RequiredError}
|
|
1882
2309
|
*/
|
|
1883
|
-
getDocument(
|
|
1884
|
-
return localVarFp.getDocument(
|
|
2310
|
+
getDocument(id: string, fileType: 'pdf' | 'pptx' | 'xlsx' | 'csv', attachmentName?: string, options?: any): AxiosPromise<any> {
|
|
2311
|
+
return localVarFp.getDocument(id, fileType, attachmentName, options).then((request) => request(axios, basePath));
|
|
2312
|
+
},
|
|
2313
|
+
/**
|
|
2314
|
+
*
|
|
2315
|
+
* @summary Retrieve a generated document
|
|
2316
|
+
* @param {string} id
|
|
2317
|
+
* @param {string} [attachmentName] A document file title. This value is reflected back to the client in the fileName header.
|
|
2318
|
+
* @param {*} [options] Override http request option.
|
|
2319
|
+
* @throws {RequiredError}
|
|
2320
|
+
*/
|
|
2321
|
+
getDocumentById(id: string, attachmentName?: string, options?: any): AxiosPromise<any> {
|
|
2322
|
+
return localVarFp.getDocumentById(id, attachmentName, options).then((request) => request(axios, basePath));
|
|
1885
2323
|
},
|
|
1886
2324
|
};
|
|
1887
2325
|
};
|
|
@@ -1896,15 +2334,28 @@ export class DocumentsApi extends BaseAPI {
|
|
|
1896
2334
|
/**
|
|
1897
2335
|
*
|
|
1898
2336
|
* @summary Retrieve a generated document
|
|
1899
|
-
* @param {string}
|
|
2337
|
+
* @param {string} id
|
|
1900
2338
|
* @param {'pdf' | 'pptx' | 'xlsx' | 'csv'} fileType
|
|
1901
2339
|
* @param {string} [attachmentName] A document file title. This value is reflected back to the client in the fileName header.
|
|
1902
2340
|
* @param {*} [options] Override http request option.
|
|
1903
2341
|
* @throws {RequiredError}
|
|
1904
2342
|
* @memberof DocumentsApi
|
|
1905
2343
|
*/
|
|
1906
|
-
public getDocument(
|
|
1907
|
-
return DocumentsApiFp(this.configuration).getDocument(
|
|
2344
|
+
public getDocument(id: string, fileType: 'pdf' | 'pptx' | 'xlsx' | 'csv', attachmentName?: string, options?: any) {
|
|
2345
|
+
return DocumentsApiFp(this.configuration).getDocument(id, fileType, attachmentName, options).then((request) => request(this.axios, this.basePath));
|
|
2346
|
+
}
|
|
2347
|
+
|
|
2348
|
+
/**
|
|
2349
|
+
*
|
|
2350
|
+
* @summary Retrieve a generated document
|
|
2351
|
+
* @param {string} id
|
|
2352
|
+
* @param {string} [attachmentName] A document file title. This value is reflected back to the client in the fileName header.
|
|
2353
|
+
* @param {*} [options] Override http request option.
|
|
2354
|
+
* @throws {RequiredError}
|
|
2355
|
+
* @memberof DocumentsApi
|
|
2356
|
+
*/
|
|
2357
|
+
public getDocumentById(id: string, attachmentName?: string, options?: any) {
|
|
2358
|
+
return DocumentsApiFp(this.configuration).getDocumentById(id, attachmentName, options).then((request) => request(this.axios, this.basePath));
|
|
1908
2359
|
}
|
|
1909
2360
|
}
|
|
1910
2361
|
|
|
@@ -2509,15 +2960,15 @@ export const ImagesApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
2509
2960
|
/**
|
|
2510
2961
|
*
|
|
2511
2962
|
* @summary Retrieves a user uploaded image for use in a template
|
|
2512
|
-
* @param {string}
|
|
2963
|
+
* @param {string} id
|
|
2513
2964
|
* @param {*} [options] Override http request option.
|
|
2514
2965
|
* @throws {RequiredError}
|
|
2515
2966
|
*/
|
|
2516
|
-
getImage: async (
|
|
2517
|
-
// verify required parameter '
|
|
2518
|
-
assertParamExists('getImage', '
|
|
2519
|
-
const localVarPath = `/images/{
|
|
2520
|
-
.replace(`{${"
|
|
2967
|
+
getImage: async (id: string, options: any = {}): Promise<RequestArgs> => {
|
|
2968
|
+
// verify required parameter 'id' is not null or undefined
|
|
2969
|
+
assertParamExists('getImage', 'id', id)
|
|
2970
|
+
const localVarPath = `/images/{id}`
|
|
2971
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
2521
2972
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2522
2973
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2523
2974
|
let baseOptions;
|
|
@@ -2615,12 +3066,12 @@ export const ImagesApiFp = function(configuration?: Configuration) {
|
|
|
2615
3066
|
/**
|
|
2616
3067
|
*
|
|
2617
3068
|
* @summary Retrieves a user uploaded image for use in a template
|
|
2618
|
-
* @param {string}
|
|
3069
|
+
* @param {string} id
|
|
2619
3070
|
* @param {*} [options] Override http request option.
|
|
2620
3071
|
* @throws {RequiredError}
|
|
2621
3072
|
*/
|
|
2622
|
-
async getImage(
|
|
2623
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getImage(
|
|
3073
|
+
async getImage(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>> {
|
|
3074
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getImage(id, options);
|
|
2624
3075
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
2625
3076
|
},
|
|
2626
3077
|
/**
|
|
@@ -2630,7 +3081,7 @@ export const ImagesApiFp = function(configuration?: Configuration) {
|
|
|
2630
3081
|
* @param {*} [options] Override http request option.
|
|
2631
3082
|
* @throws {RequiredError}
|
|
2632
3083
|
*/
|
|
2633
|
-
async uploadImage(image?: any, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
3084
|
+
async uploadImage(image?: any, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2004>> {
|
|
2634
3085
|
const localVarAxiosArgs = await localVarAxiosParamCreator.uploadImage(image, options);
|
|
2635
3086
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
2636
3087
|
},
|
|
@@ -2647,12 +3098,12 @@ export const ImagesApiFactory = function (configuration?: Configuration, basePat
|
|
|
2647
3098
|
/**
|
|
2648
3099
|
*
|
|
2649
3100
|
* @summary Retrieves a user uploaded image for use in a template
|
|
2650
|
-
* @param {string}
|
|
3101
|
+
* @param {string} id
|
|
2651
3102
|
* @param {*} [options] Override http request option.
|
|
2652
3103
|
* @throws {RequiredError}
|
|
2653
3104
|
*/
|
|
2654
|
-
getImage(
|
|
2655
|
-
return localVarFp.getImage(
|
|
3105
|
+
getImage(id: string, options?: any): AxiosPromise<any> {
|
|
3106
|
+
return localVarFp.getImage(id, options).then((request) => request(axios, basePath));
|
|
2656
3107
|
},
|
|
2657
3108
|
/**
|
|
2658
3109
|
* Uploads an image to the server for use in templates
|
|
@@ -2661,7 +3112,7 @@ export const ImagesApiFactory = function (configuration?: Configuration, basePat
|
|
|
2661
3112
|
* @param {*} [options] Override http request option.
|
|
2662
3113
|
* @throws {RequiredError}
|
|
2663
3114
|
*/
|
|
2664
|
-
uploadImage(image?: any, options?: any): AxiosPromise<
|
|
3115
|
+
uploadImage(image?: any, options?: any): AxiosPromise<InlineResponse2004> {
|
|
2665
3116
|
return localVarFp.uploadImage(image, options).then((request) => request(axios, basePath));
|
|
2666
3117
|
},
|
|
2667
3118
|
};
|
|
@@ -2677,13 +3128,13 @@ export class ImagesApi extends BaseAPI {
|
|
|
2677
3128
|
/**
|
|
2678
3129
|
*
|
|
2679
3130
|
* @summary Retrieves a user uploaded image for use in a template
|
|
2680
|
-
* @param {string}
|
|
3131
|
+
* @param {string} id
|
|
2681
3132
|
* @param {*} [options] Override http request option.
|
|
2682
3133
|
* @throws {RequiredError}
|
|
2683
3134
|
* @memberof ImagesApi
|
|
2684
3135
|
*/
|
|
2685
|
-
public getImage(
|
|
2686
|
-
return ImagesApiFp(this.configuration).getImage(
|
|
3136
|
+
public getImage(id: string, options?: any) {
|
|
3137
|
+
return ImagesApiFp(this.configuration).getImage(id, options).then((request) => request(this.axios, this.basePath));
|
|
2687
3138
|
}
|
|
2688
3139
|
|
|
2689
3140
|
/**
|
|
@@ -3186,7 +3637,7 @@ export const ReportTasksApiFp = function(configuration?: Configuration) {
|
|
|
3186
3637
|
* @param {*} [options] Override http request option.
|
|
3187
3638
|
* @throws {RequiredError}
|
|
3188
3639
|
*/
|
|
3189
|
-
async getReportTasks(pageNum?: number, meta?: { [key: string]: string; }, templateId?: string, perPage?: number, orderBy?: 'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId' | 'report.createdAt', order?: 'asc' | 'desc', filter?: object, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
3640
|
+
async getReportTasks(pageNum?: number, meta?: { [key: string]: string; }, templateId?: string, perPage?: number, orderBy?: 'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId' | 'report.createdAt', order?: 'asc' | 'desc', filter?: object, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2001>> {
|
|
3190
3641
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getReportTasks(pageNum, meta, templateId, perPage, orderBy, order, filter, options);
|
|
3191
3642
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
3192
3643
|
},
|
|
@@ -3267,7 +3718,7 @@ export const ReportTasksApiFactory = function (configuration?: Configuration, ba
|
|
|
3267
3718
|
* @param {*} [options] Override http request option.
|
|
3268
3719
|
* @throws {RequiredError}
|
|
3269
3720
|
*/
|
|
3270
|
-
getReportTasks(pageNum?: number, meta?: { [key: string]: string; }, templateId?: string, perPage?: number, orderBy?: 'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId' | 'report.createdAt', order?: 'asc' | 'desc', filter?: object, options?: any): AxiosPromise<
|
|
3721
|
+
getReportTasks(pageNum?: number, meta?: { [key: string]: string; }, templateId?: string, perPage?: number, orderBy?: 'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId' | 'report.createdAt', order?: 'asc' | 'desc', filter?: object, options?: any): AxiosPromise<InlineResponse2001> {
|
|
3271
3722
|
return localVarFp.getReportTasks(pageNum, meta, templateId, perPage, orderBy, order, filter, options).then((request) => request(axios, basePath));
|
|
3272
3723
|
},
|
|
3273
3724
|
/**
|
|
@@ -3467,6 +3918,50 @@ export const ReportsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
3467
3918
|
|
|
3468
3919
|
|
|
3469
3920
|
|
|
3921
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);
|
|
3922
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3923
|
+
let formHeaders = {};
|
|
3924
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...formHeaders, ...options.headers};
|
|
3925
|
+
|
|
3926
|
+
return {
|
|
3927
|
+
url: toPathString(localVarUrlObj),
|
|
3928
|
+
options: localVarRequestOptions,
|
|
3929
|
+
};
|
|
3930
|
+
},
|
|
3931
|
+
/**
|
|
3932
|
+
*
|
|
3933
|
+
* @summary Get report thumbnail
|
|
3934
|
+
* @param {string} id
|
|
3935
|
+
* @param {*} [options] Override http request option.
|
|
3936
|
+
* @throws {RequiredError}
|
|
3937
|
+
*/
|
|
3938
|
+
getReportThumbnail: async (id: string, options: any = {}): Promise<RequestArgs> => {
|
|
3939
|
+
// verify required parameter 'id' is not null or undefined
|
|
3940
|
+
assertParamExists('getReportThumbnail', 'id', id)
|
|
3941
|
+
const localVarPath = `/reports/{id}/thumbnail`
|
|
3942
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
3943
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3944
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
3945
|
+
let baseOptions;
|
|
3946
|
+
if (configuration) {
|
|
3947
|
+
baseOptions = configuration.baseOptions;
|
|
3948
|
+
}
|
|
3949
|
+
|
|
3950
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
3951
|
+
const localVarHeaderParameter = {} as any;
|
|
3952
|
+
const localVarQueryParameter = {} as any;
|
|
3953
|
+
|
|
3954
|
+
// authentication ApiKeyAuth required
|
|
3955
|
+
await setApiKeyToObject(localVarHeaderParameter, "X-API-KEY", configuration)
|
|
3956
|
+
|
|
3957
|
+
// authentication BearerAuth required
|
|
3958
|
+
// http bearer authentication required
|
|
3959
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
3960
|
+
|
|
3961
|
+
// authentication CookieAuth required
|
|
3962
|
+
|
|
3963
|
+
|
|
3964
|
+
|
|
3470
3965
|
setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);
|
|
3471
3966
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3472
3967
|
let formHeaders = {};
|
|
@@ -3630,6 +4125,17 @@ export const ReportsApiFp = function(configuration?: Configuration) {
|
|
|
3630
4125
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getReport(id, options);
|
|
3631
4126
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
3632
4127
|
},
|
|
4128
|
+
/**
|
|
4129
|
+
*
|
|
4130
|
+
* @summary Get report thumbnail
|
|
4131
|
+
* @param {string} id
|
|
4132
|
+
* @param {*} [options] Override http request option.
|
|
4133
|
+
* @throws {RequiredError}
|
|
4134
|
+
*/
|
|
4135
|
+
async getReportThumbnail(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>> {
|
|
4136
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getReportThumbnail(id, options);
|
|
4137
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
4138
|
+
},
|
|
3633
4139
|
/**
|
|
3634
4140
|
*
|
|
3635
4141
|
* @summary List reports
|
|
@@ -3642,7 +4148,7 @@ export const ReportsApiFp = function(configuration?: Configuration) {
|
|
|
3642
4148
|
* @param {*} [options] Override http request option.
|
|
3643
4149
|
* @throws {RequiredError}
|
|
3644
4150
|
*/
|
|
3645
|
-
async getReports(pageNum?: number, perPage?: number, orderBy?: 'title' | 'createdAt', order?: 'asc' | 'desc', tagId?: string, reportTaskId?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
4151
|
+
async getReports(pageNum?: number, perPage?: number, orderBy?: 'title' | 'createdAt', order?: 'asc' | 'desc', tagId?: string, reportTaskId?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2002>> {
|
|
3646
4152
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getReports(pageNum, perPage, orderBy, order, tagId, reportTaskId, options);
|
|
3647
4153
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
3648
4154
|
},
|
|
@@ -3688,6 +4194,16 @@ export const ReportsApiFactory = function (configuration?: Configuration, basePa
|
|
|
3688
4194
|
getReport(id: string, options?: any): AxiosPromise<Report> {
|
|
3689
4195
|
return localVarFp.getReport(id, options).then((request) => request(axios, basePath));
|
|
3690
4196
|
},
|
|
4197
|
+
/**
|
|
4198
|
+
*
|
|
4199
|
+
* @summary Get report thumbnail
|
|
4200
|
+
* @param {string} id
|
|
4201
|
+
* @param {*} [options] Override http request option.
|
|
4202
|
+
* @throws {RequiredError}
|
|
4203
|
+
*/
|
|
4204
|
+
getReportThumbnail(id: string, options?: any): AxiosPromise<any> {
|
|
4205
|
+
return localVarFp.getReportThumbnail(id, options).then((request) => request(axios, basePath));
|
|
4206
|
+
},
|
|
3691
4207
|
/**
|
|
3692
4208
|
*
|
|
3693
4209
|
* @summary List reports
|
|
@@ -3700,7 +4216,7 @@ export const ReportsApiFactory = function (configuration?: Configuration, basePa
|
|
|
3700
4216
|
* @param {*} [options] Override http request option.
|
|
3701
4217
|
* @throws {RequiredError}
|
|
3702
4218
|
*/
|
|
3703
|
-
getReports(pageNum?: number, perPage?: number, orderBy?: 'title' | 'createdAt', order?: 'asc' | 'desc', tagId?: string, reportTaskId?: string, options?: any): AxiosPromise<
|
|
4219
|
+
getReports(pageNum?: number, perPage?: number, orderBy?: 'title' | 'createdAt', order?: 'asc' | 'desc', tagId?: string, reportTaskId?: string, options?: any): AxiosPromise<InlineResponse2002> {
|
|
3704
4220
|
return localVarFp.getReports(pageNum, perPage, orderBy, order, tagId, reportTaskId, options).then((request) => request(axios, basePath));
|
|
3705
4221
|
},
|
|
3706
4222
|
/**
|
|
@@ -3748,6 +4264,18 @@ export class ReportsApi extends BaseAPI {
|
|
|
3748
4264
|
return ReportsApiFp(this.configuration).getReport(id, options).then((request) => request(this.axios, this.basePath));
|
|
3749
4265
|
}
|
|
3750
4266
|
|
|
4267
|
+
/**
|
|
4268
|
+
*
|
|
4269
|
+
* @summary Get report thumbnail
|
|
4270
|
+
* @param {string} id
|
|
4271
|
+
* @param {*} [options] Override http request option.
|
|
4272
|
+
* @throws {RequiredError}
|
|
4273
|
+
* @memberof ReportsApi
|
|
4274
|
+
*/
|
|
4275
|
+
public getReportThumbnail(id: string, options?: any) {
|
|
4276
|
+
return ReportsApiFp(this.configuration).getReportThumbnail(id, options).then((request) => request(this.axios, this.basePath));
|
|
4277
|
+
}
|
|
4278
|
+
|
|
3751
4279
|
/**
|
|
3752
4280
|
*
|
|
3753
4281
|
* @summary List reports
|
|
@@ -3998,6 +4526,50 @@ export const TemplatesApiAxiosParamCreator = function (configuration?: Configura
|
|
|
3998
4526
|
|
|
3999
4527
|
|
|
4000
4528
|
|
|
4529
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);
|
|
4530
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
4531
|
+
let formHeaders = {};
|
|
4532
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...formHeaders, ...options.headers};
|
|
4533
|
+
|
|
4534
|
+
return {
|
|
4535
|
+
url: toPathString(localVarUrlObj),
|
|
4536
|
+
options: localVarRequestOptions,
|
|
4537
|
+
};
|
|
4538
|
+
},
|
|
4539
|
+
/**
|
|
4540
|
+
*
|
|
4541
|
+
* @summary Get template thumbnail
|
|
4542
|
+
* @param {string} id
|
|
4543
|
+
* @param {*} [options] Override http request option.
|
|
4544
|
+
* @throws {RequiredError}
|
|
4545
|
+
*/
|
|
4546
|
+
getTemplateThumbnail: async (id: string, options: any = {}): Promise<RequestArgs> => {
|
|
4547
|
+
// verify required parameter 'id' is not null or undefined
|
|
4548
|
+
assertParamExists('getTemplateThumbnail', 'id', id)
|
|
4549
|
+
const localVarPath = `/templates/{id}/thumbnail`
|
|
4550
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
4551
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
4552
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
4553
|
+
let baseOptions;
|
|
4554
|
+
if (configuration) {
|
|
4555
|
+
baseOptions = configuration.baseOptions;
|
|
4556
|
+
}
|
|
4557
|
+
|
|
4558
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
4559
|
+
const localVarHeaderParameter = {} as any;
|
|
4560
|
+
const localVarQueryParameter = {} as any;
|
|
4561
|
+
|
|
4562
|
+
// authentication ApiKeyAuth required
|
|
4563
|
+
await setApiKeyToObject(localVarHeaderParameter, "X-API-KEY", configuration)
|
|
4564
|
+
|
|
4565
|
+
// authentication BearerAuth required
|
|
4566
|
+
// http bearer authentication required
|
|
4567
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
4568
|
+
|
|
4569
|
+
// authentication CookieAuth required
|
|
4570
|
+
|
|
4571
|
+
|
|
4572
|
+
|
|
4001
4573
|
setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);
|
|
4002
4574
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
4003
4575
|
let formHeaders = {};
|
|
@@ -4271,6 +4843,17 @@ export const TemplatesApiFp = function(configuration?: Configuration) {
|
|
|
4271
4843
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getTemplate(id, options);
|
|
4272
4844
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
4273
4845
|
},
|
|
4846
|
+
/**
|
|
4847
|
+
*
|
|
4848
|
+
* @summary Get template thumbnail
|
|
4849
|
+
* @param {string} id
|
|
4850
|
+
* @param {*} [options] Override http request option.
|
|
4851
|
+
* @throws {RequiredError}
|
|
4852
|
+
*/
|
|
4853
|
+
async getTemplateThumbnail(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>> {
|
|
4854
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getTemplateThumbnail(id, options);
|
|
4855
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
4856
|
+
},
|
|
4274
4857
|
/**
|
|
4275
4858
|
*
|
|
4276
4859
|
* @summary List report templates
|
|
@@ -4278,7 +4861,7 @@ export const TemplatesApiFp = function(configuration?: Configuration) {
|
|
|
4278
4861
|
* @param {*} [options] Override http request option.
|
|
4279
4862
|
* @throws {RequiredError}
|
|
4280
4863
|
*/
|
|
4281
|
-
async getTemplates(pageNum?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
4864
|
+
async getTemplates(pageNum?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2003>> {
|
|
4282
4865
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getTemplates(pageNum, options);
|
|
4283
4866
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
4284
4867
|
},
|
|
@@ -4377,6 +4960,16 @@ export const TemplatesApiFactory = function (configuration?: Configuration, base
|
|
|
4377
4960
|
getTemplate(id: string, options?: any): AxiosPromise<Template> {
|
|
4378
4961
|
return localVarFp.getTemplate(id, options).then((request) => request(axios, basePath));
|
|
4379
4962
|
},
|
|
4963
|
+
/**
|
|
4964
|
+
*
|
|
4965
|
+
* @summary Get template thumbnail
|
|
4966
|
+
* @param {string} id
|
|
4967
|
+
* @param {*} [options] Override http request option.
|
|
4968
|
+
* @throws {RequiredError}
|
|
4969
|
+
*/
|
|
4970
|
+
getTemplateThumbnail(id: string, options?: any): AxiosPromise<any> {
|
|
4971
|
+
return localVarFp.getTemplateThumbnail(id, options).then((request) => request(axios, basePath));
|
|
4972
|
+
},
|
|
4380
4973
|
/**
|
|
4381
4974
|
*
|
|
4382
4975
|
* @summary List report templates
|
|
@@ -4384,7 +4977,7 @@ export const TemplatesApiFactory = function (configuration?: Configuration, base
|
|
|
4384
4977
|
* @param {*} [options] Override http request option.
|
|
4385
4978
|
* @throws {RequiredError}
|
|
4386
4979
|
*/
|
|
4387
|
-
getTemplates(pageNum?: number, options?: any): AxiosPromise<
|
|
4980
|
+
getTemplates(pageNum?: number, options?: any): AxiosPromise<InlineResponse2003> {
|
|
4388
4981
|
return localVarFp.getTemplates(pageNum, options).then((request) => request(axios, basePath));
|
|
4389
4982
|
},
|
|
4390
4983
|
/**
|
|
@@ -4489,6 +5082,18 @@ export class TemplatesApi extends BaseAPI {
|
|
|
4489
5082
|
return TemplatesApiFp(this.configuration).getTemplate(id, options).then((request) => request(this.axios, this.basePath));
|
|
4490
5083
|
}
|
|
4491
5084
|
|
|
5085
|
+
/**
|
|
5086
|
+
*
|
|
5087
|
+
* @summary Get template thumbnail
|
|
5088
|
+
* @param {string} id
|
|
5089
|
+
* @param {*} [options] Override http request option.
|
|
5090
|
+
* @throws {RequiredError}
|
|
5091
|
+
* @memberof TemplatesApi
|
|
5092
|
+
*/
|
|
5093
|
+
public getTemplateThumbnail(id: string, options?: any) {
|
|
5094
|
+
return TemplatesApiFp(this.configuration).getTemplateThumbnail(id, options).then((request) => request(this.axios, this.basePath));
|
|
5095
|
+
}
|
|
5096
|
+
|
|
4492
5097
|
/**
|
|
4493
5098
|
*
|
|
4494
5099
|
* @summary List report templates
|