@connectreport/connectreport-js 2.80.4 → 2.81.0-beta.2

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.
Files changed (63) hide show
  1. package/.openapi-generator/FILES +0 -1
  2. package/README.md +1 -1
  3. package/api.ts +670 -92
  4. package/base.ts +2 -2
  5. package/common.ts +1 -1
  6. package/configuration.ts +1 -1
  7. package/dist/index.cjs +296 -31
  8. package/dist/index.cjs.map +1 -1
  9. package/dist/index.d.cts +465 -71
  10. package/dist/index.d.ts +465 -71
  11. package/dist/index.js +294 -31
  12. package/dist/index.js.map +1 -1
  13. package/docs/assets/css/main.css +2679 -0
  14. package/docs/assets/images/icons.png +0 -0
  15. package/docs/assets/images/icons@2x.png +0 -0
  16. package/docs/assets/images/widgets.png +0 -0
  17. package/docs/assets/images/widgets@2x.png +0 -0
  18. package/docs/assets/js/main.js +1 -0
  19. package/docs/assets/js/search.json +1 -0
  20. package/docs/classes/_api_.basetemplatesapi.html +351 -0
  21. package/docs/classes/_api_.documentsapi.html +314 -0
  22. package/docs/classes/_api_.filtercyclesapi.html +483 -0
  23. package/docs/classes/_api_.imagesapi.html +354 -0
  24. package/docs/classes/_api_.jobsapi.html +311 -0
  25. package/docs/classes/_api_.reportsapi.html +400 -0
  26. package/docs/classes/_api_.reporttasksapi.html +503 -0
  27. package/docs/classes/_api_.templatesapi.html +676 -0
  28. package/docs/classes/_base_.baseapi.html +283 -0
  29. package/docs/classes/_base_.requirederror.html +291 -0
  30. package/docs/classes/_configuration_.configuration.html +345 -0
  31. package/docs/classes/_index_.connectreport.html +317 -0
  32. package/docs/enums/_api_.filtercycleemailenum.html +196 -0
  33. package/docs/enums/_api_.filtercyclefrequencyenum.html +238 -0
  34. package/docs/enums/_api_.reporttaskemailenum.html +196 -0
  35. package/docs/enums/_api_.reporttaskfrequencyenum.html +238 -0
  36. package/docs/enums/_api_.templateplatformenum.html +182 -0
  37. package/docs/globals.html +132 -0
  38. package/docs/index.html +145 -0
  39. package/docs/interfaces/_api_.filtercycle.html +791 -0
  40. package/docs/interfaces/_api_.filtercycleallof.html +273 -0
  41. package/docs/interfaces/_api_.filtercyclealloffieldinfo.html +228 -0
  42. package/docs/interfaces/_api_.filtercyclealloffieldvalues.html +228 -0
  43. package/docs/interfaces/_api_.inlineresponse200.html +186 -0
  44. package/docs/interfaces/_api_.inlineresponse2001.html +207 -0
  45. package/docs/interfaces/_api_.job.html +270 -0
  46. package/docs/interfaces/_api_.modelerror.html +207 -0
  47. package/docs/interfaces/_api_.report.html +348 -0
  48. package/docs/interfaces/_api_.reporttask.html +683 -0
  49. package/docs/interfaces/_api_.reporttaskcustomselection.html +234 -0
  50. package/docs/interfaces/_api_.reporttaskfieldvalues.html +207 -0
  51. package/docs/interfaces/_api_.reporttaskfiltersets.html +207 -0
  52. package/docs/interfaces/_api_.reporttaskgroupstosharewith.html +186 -0
  53. package/docs/interfaces/_api_.reporttasktags.html +207 -0
  54. package/docs/interfaces/_api_.reporttaskuserstosharewith.html +186 -0
  55. package/docs/interfaces/_api_.reporttaskvariables.html +207 -0
  56. package/docs/interfaces/_api_.template.html +291 -0
  57. package/docs/interfaces/_base_.requestargs.html +205 -0
  58. package/docs/interfaces/_configuration_.configurationparameters.html +253 -0
  59. package/docs/modules/_api_.html +4377 -0
  60. package/docs/modules/_base_.html +238 -0
  61. package/docs/modules/_configuration_.html +144 -0
  62. package/docs/modules/_index_.html +135 -0
  63. package/package.json +1 -1
package/dist/index.d.ts CHANGED
@@ -5,7 +5,7 @@ import { AxiosInstance, AxiosPromise } from 'axios';
5
5
  * ConnectReport Core API
6
6
  * Leverage core reporting, templating, and document automation capabilities of ConnectReport Server.
7
7
  *
8
- * The version of the OpenAPI document: 2.80.4
8
+ * The version of the OpenAPI document: 2.80.5
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -91,7 +91,7 @@ declare class Configuration {
91
91
  * ConnectReport Core API
92
92
  * Leverage core reporting, templating, and document automation capabilities of ConnectReport Server.
93
93
  *
94
- * The version of the OpenAPI document: 2.80.4
94
+ * The version of the OpenAPI document: 2.80.5
95
95
  *
96
96
  *
97
97
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -193,11 +193,11 @@ interface FilterCycle {
193
193
  */
194
194
  nextRunAt?: string;
195
195
  /**
196
- * The error object from the last report task execution, if applicable
197
- * @type {string}
196
+ *
197
+ * @type {Array<ReportTaskErrors>}
198
198
  * @memberof FilterCycle
199
199
  */
200
- error?: string;
200
+ errors?: Array<ReportTaskErrors>;
201
201
  /**
202
202
  * The average time to run the report task, in minutes
203
203
  * @type {number}
@@ -266,6 +266,12 @@ interface FilterCycle {
266
266
  * @memberof FilterCycle
267
267
  */
268
268
  emailBody?: string;
269
+ /**
270
+ * The ID of the OneDrive folder to publish the report to
271
+ * @type {string}
272
+ * @memberof FilterCycle
273
+ */
274
+ onedriveParentFolderId?: string;
269
275
  /**
270
276
  *
271
277
  * @type {FilterCycleAllOfFieldInfo}
@@ -279,7 +285,7 @@ interface FilterCycle {
279
285
  */
280
286
  fieldValues?: Array<FilterCycleAllOfFieldValues>;
281
287
  /**
282
- *
288
+ * This field is deprecated in favor of docId.
283
289
  * @type {string}
284
290
  * @memberof FilterCycle
285
291
  */
@@ -296,6 +302,18 @@ interface FilterCycle {
296
302
  * @memberof FilterCycle
297
303
  */
298
304
  autotag?: boolean;
305
+ /**
306
+ *
307
+ * @type {string}
308
+ * @memberof FilterCycle
309
+ */
310
+ docId?: string;
311
+ /**
312
+ *
313
+ * @type {string}
314
+ * @memberof FilterCycle
315
+ */
316
+ connectorName?: string;
299
317
  }
300
318
  /**
301
319
  * @export
@@ -339,7 +357,7 @@ interface FilterCycleAllOf {
339
357
  */
340
358
  fieldValues?: Array<FilterCycleAllOfFieldValues>;
341
359
  /**
342
- *
360
+ * This field is deprecated in favor of docId.
343
361
  * @type {string}
344
362
  * @memberof FilterCycleAllOf
345
363
  */
@@ -356,6 +374,18 @@ interface FilterCycleAllOf {
356
374
  * @memberof FilterCycleAllOf
357
375
  */
358
376
  autotag?: boolean;
377
+ /**
378
+ *
379
+ * @type {string}
380
+ * @memberof FilterCycleAllOf
381
+ */
382
+ docId?: string;
383
+ /**
384
+ *
385
+ * @type {string}
386
+ * @memberof FilterCycleAllOf
387
+ */
388
+ connectorName?: string;
359
389
  }
360
390
  /**
361
391
  *
@@ -434,10 +464,16 @@ interface InlineResponse200 {
434
464
  interface InlineResponse2001 {
435
465
  /**
436
466
  *
437
- * @type {string}
467
+ * @type {Array<ReportTaskResponse>}
438
468
  * @memberof InlineResponse2001
439
469
  */
440
- path?: string;
470
+ reportTasks?: Array<ReportTaskResponse>;
471
+ /**
472
+ *
473
+ * @type {number}
474
+ * @memberof InlineResponse2001
475
+ */
476
+ totalPages?: number;
441
477
  }
442
478
  /**
443
479
  *
@@ -447,16 +483,22 @@ interface InlineResponse2001 {
447
483
  interface InlineResponse2002 {
448
484
  /**
449
485
  *
450
- * @type {Array<ReportTaskResponse>}
486
+ * @type {Array<Report>}
451
487
  * @memberof InlineResponse2002
452
488
  */
453
- reportTasks?: Array<ReportTaskResponse>;
489
+ reports?: Array<Report>;
454
490
  /**
455
491
  *
456
492
  * @type {number}
457
493
  * @memberof InlineResponse2002
458
494
  */
459
495
  totalPages?: number;
496
+ /**
497
+ *
498
+ * @type {number}
499
+ * @memberof InlineResponse2002
500
+ */
501
+ totalItems?: number;
460
502
  }
461
503
  /**
462
504
  *
@@ -466,22 +508,16 @@ interface InlineResponse2002 {
466
508
  interface InlineResponse2003 {
467
509
  /**
468
510
  *
469
- * @type {Array<Report>}
511
+ * @type {Array<Template>}
470
512
  * @memberof InlineResponse2003
471
513
  */
472
- reports?: Array<Report>;
514
+ templates?: Array<Template>;
473
515
  /**
474
516
  *
475
517
  * @type {number}
476
518
  * @memberof InlineResponse2003
477
519
  */
478
520
  totalPages?: number;
479
- /**
480
- *
481
- * @type {number}
482
- * @memberof InlineResponse2003
483
- */
484
- totalItems?: number;
485
521
  }
486
522
  /**
487
523
  *
@@ -491,16 +527,10 @@ interface InlineResponse2003 {
491
527
  interface InlineResponse2004 {
492
528
  /**
493
529
  *
494
- * @type {Array<Template>}
495
- * @memberof InlineResponse2004
496
- */
497
- templates?: Array<Template>;
498
- /**
499
- *
500
- * @type {number}
530
+ * @type {string}
501
531
  * @memberof InlineResponse2004
502
532
  */
503
- totalPages?: number;
533
+ path?: string;
504
534
  }
505
535
  /**
506
536
  *
@@ -655,6 +685,20 @@ interface Report {
655
685
  * @memberof Report
656
686
  */
657
687
  sizeBytes?: number;
688
+ /**
689
+ * The type of report
690
+ * @type {string}
691
+ * @memberof Report
692
+ */
693
+ type?: ReportTypeEnum;
694
+ }
695
+ /**
696
+ * @export
697
+ * @enum {string}
698
+ */
699
+ declare enum ReportTypeEnum {
700
+ PixelPerfect = "pixel-perfect",
701
+ Excel = "excel"
658
702
  }
659
703
  /**
660
704
  *
@@ -729,11 +773,11 @@ interface ReportTask {
729
773
  */
730
774
  nextRunAt?: string;
731
775
  /**
732
- * The error object from the last report task execution, if applicable
733
- * @type {string}
776
+ *
777
+ * @type {Array<ReportTaskErrors>}
734
778
  * @memberof ReportTask
735
779
  */
736
- error?: string;
780
+ errors?: Array<ReportTaskErrors>;
737
781
  /**
738
782
  * The average time to run the report task, in minutes
739
783
  * @type {number}
@@ -802,6 +846,12 @@ interface ReportTask {
802
846
  * @memberof ReportTask
803
847
  */
804
848
  emailBody?: string;
849
+ /**
850
+ * The ID of the OneDrive folder to publish the report to
851
+ * @type {string}
852
+ * @memberof ReportTask
853
+ */
854
+ onedriveParentFolderId?: string;
805
855
  }
806
856
  /**
807
857
  * @export
@@ -851,6 +901,31 @@ interface ReportTaskCustomSelection {
851
901
  */
852
902
  fieldValues?: Array<ReportTaskFieldValues>;
853
903
  }
904
+ /**
905
+ *
906
+ * @export
907
+ * @interface ReportTaskErrors
908
+ */
909
+ interface ReportTaskErrors {
910
+ /**
911
+ *
912
+ * @type {string}
913
+ * @memberof ReportTaskErrors
914
+ */
915
+ err: string;
916
+ /**
917
+ *
918
+ * @type {string}
919
+ * @memberof ReportTaskErrors
920
+ */
921
+ culpritGuid?: string;
922
+ /**
923
+ *
924
+ * @type {string}
925
+ * @memberof ReportTaskErrors
926
+ */
927
+ page?: string;
928
+ }
854
929
  /**
855
930
  *
856
931
  * @export
@@ -975,11 +1050,11 @@ interface ReportTaskRequest {
975
1050
  */
976
1051
  nextRunAt?: string;
977
1052
  /**
978
- * The error object from the last report task execution, if applicable
979
- * @type {string}
1053
+ *
1054
+ * @type {Array<ReportTaskErrors>}
980
1055
  * @memberof ReportTaskRequest
981
1056
  */
982
- error?: string;
1057
+ errors?: Array<ReportTaskErrors>;
983
1058
  /**
984
1059
  * The average time to run the report task, in minutes
985
1060
  * @type {number}
@@ -1048,6 +1123,12 @@ interface ReportTaskRequest {
1048
1123
  * @memberof ReportTaskRequest
1049
1124
  */
1050
1125
  emailBody?: string;
1126
+ /**
1127
+ * The ID of the OneDrive folder to publish the report to
1128
+ * @type {string}
1129
+ * @memberof ReportTaskRequest
1130
+ */
1131
+ onedriveParentFolderId?: string;
1051
1132
  /**
1052
1133
  * Emails to send the report to. This is only allowed if \"Allow reports to be shared with any email\" is to true.
1053
1134
  * @type {Array<string>}
@@ -1114,6 +1195,12 @@ interface ReportTaskRequestAllOf {
1114
1195
  * @memberof ReportTaskRequestAllOf
1115
1196
  */
1116
1197
  usersToShareWith?: Array<ReportTaskRequestAllOfUsersToShareWith>;
1198
+ /**
1199
+ * Groups to share the published report with. This field will be updated entirely if provided
1200
+ * @type {Array<ReportTaskGroupsToShareWith>}
1201
+ * @memberof ReportTaskRequestAllOf
1202
+ */
1203
+ groupsToShareWith?: Array<ReportTaskGroupsToShareWith>;
1117
1204
  }
1118
1205
  /**
1119
1206
  *
@@ -1139,7 +1226,7 @@ interface ReportTaskResponse {
1139
1226
  * @type {string}
1140
1227
  * @memberof ReportTaskResponse
1141
1228
  */
1142
- id?: string;
1229
+ id: string;
1143
1230
  /**
1144
1231
  * Title of the report task
1145
1232
  * @type {string}
@@ -1201,11 +1288,11 @@ interface ReportTaskResponse {
1201
1288
  */
1202
1289
  nextRunAt?: string;
1203
1290
  /**
1204
- * The error object from the last report task execution, if applicable
1205
- * @type {string}
1291
+ *
1292
+ * @type {Array<ReportTaskErrors>}
1206
1293
  * @memberof ReportTaskResponse
1207
1294
  */
1208
- error?: string;
1295
+ errors?: Array<ReportTaskErrors>;
1209
1296
  /**
1210
1297
  * The average time to run the report task, in minutes
1211
1298
  * @type {number}
@@ -1274,12 +1361,84 @@ interface ReportTaskResponse {
1274
1361
  * @memberof ReportTaskResponse
1275
1362
  */
1276
1363
  emailBody?: string;
1364
+ /**
1365
+ * The ID of the OneDrive folder to publish the report to
1366
+ * @type {string}
1367
+ * @memberof ReportTaskResponse
1368
+ */
1369
+ onedriveParentFolderId?: string;
1277
1370
  /**
1278
1371
  * Users to share the published report with. This field will be updated entirely if provided
1279
1372
  * @type {Array<ReportTaskResponseAllOfUsersToShareWith>}
1280
1373
  * @memberof ReportTaskResponse
1281
1374
  */
1282
1375
  usersToShareWith?: Array<ReportTaskResponseAllOfUsersToShareWith>;
1376
+ /**
1377
+ * Datetime in UTC when the report task was created
1378
+ * @type {string}
1379
+ * @memberof ReportTaskResponse
1380
+ */
1381
+ createdAt?: string;
1382
+ /**
1383
+ * Datetime in UTC when the report task was last saved
1384
+ * @type {string}
1385
+ * @memberof ReportTaskResponse
1386
+ */
1387
+ lastSavedAt?: string;
1388
+ /**
1389
+ * Field value information
1390
+ * @type {string}
1391
+ * @memberof ReportTaskResponse
1392
+ */
1393
+ fieldValue?: string;
1394
+ /**
1395
+ * Field information
1396
+ * @type {string}
1397
+ * @memberof ReportTaskResponse
1398
+ */
1399
+ fieldInfo?: string;
1400
+ /**
1401
+ * Title of the filter cycle this report task belongs to
1402
+ * @type {string}
1403
+ * @memberof ReportTaskResponse
1404
+ */
1405
+ filterCycleTitle?: string;
1406
+ /**
1407
+ * Datetime in UTC when the report task last started execution
1408
+ * @type {string}
1409
+ * @memberof ReportTaskResponse
1410
+ */
1411
+ lastRunAt?: string;
1412
+ /**
1413
+ * Datetime in UTC when the report task last finished execution
1414
+ * @type {string}
1415
+ * @memberof ReportTaskResponse
1416
+ */
1417
+ lastFinishedAt?: string;
1418
+ /**
1419
+ * Datetime in UTC when the report task last failed
1420
+ * @type {string}
1421
+ * @memberof ReportTaskResponse
1422
+ */
1423
+ failedAt?: string;
1424
+ /**
1425
+ * Reason for the last failure, if applicable
1426
+ * @type {string}
1427
+ * @memberof ReportTaskResponse
1428
+ */
1429
+ failReason?: string;
1430
+ /**
1431
+ * Datetime in UTC when the report task was locked for execution
1432
+ * @type {string}
1433
+ * @memberof ReportTaskResponse
1434
+ */
1435
+ lockedAt?: string;
1436
+ /**
1437
+ * Groups this report is shared with (read-only view of groupsToShareWith)
1438
+ * @type {Array<ReportTaskResponseAllOfGroupsSharedWith>}
1439
+ * @memberof ReportTaskResponse
1440
+ */
1441
+ groupsSharedWith?: Array<ReportTaskResponseAllOfGroupsSharedWith>;
1283
1442
  }
1284
1443
  /**
1285
1444
  * @export
@@ -1316,6 +1475,91 @@ interface ReportTaskResponseAllOf {
1316
1475
  * @memberof ReportTaskResponseAllOf
1317
1476
  */
1318
1477
  usersToShareWith?: Array<ReportTaskResponseAllOfUsersToShareWith>;
1478
+ /**
1479
+ * Datetime in UTC when the report task was created
1480
+ * @type {string}
1481
+ * @memberof ReportTaskResponseAllOf
1482
+ */
1483
+ createdAt?: string;
1484
+ /**
1485
+ * Datetime in UTC when the report task was last saved
1486
+ * @type {string}
1487
+ * @memberof ReportTaskResponseAllOf
1488
+ */
1489
+ lastSavedAt?: string;
1490
+ /**
1491
+ * Field value information
1492
+ * @type {string}
1493
+ * @memberof ReportTaskResponseAllOf
1494
+ */
1495
+ fieldValue?: string;
1496
+ /**
1497
+ * Field information
1498
+ * @type {string}
1499
+ * @memberof ReportTaskResponseAllOf
1500
+ */
1501
+ fieldInfo?: string;
1502
+ /**
1503
+ * Title of the filter cycle this report task belongs to
1504
+ * @type {string}
1505
+ * @memberof ReportTaskResponseAllOf
1506
+ */
1507
+ filterCycleTitle?: string;
1508
+ /**
1509
+ * Datetime in UTC when the report task last started execution
1510
+ * @type {string}
1511
+ * @memberof ReportTaskResponseAllOf
1512
+ */
1513
+ lastRunAt?: string;
1514
+ /**
1515
+ * Datetime in UTC when the report task last finished execution
1516
+ * @type {string}
1517
+ * @memberof ReportTaskResponseAllOf
1518
+ */
1519
+ lastFinishedAt?: string;
1520
+ /**
1521
+ * Datetime in UTC when the report task last failed
1522
+ * @type {string}
1523
+ * @memberof ReportTaskResponseAllOf
1524
+ */
1525
+ failedAt?: string;
1526
+ /**
1527
+ * Reason for the last failure, if applicable
1528
+ * @type {string}
1529
+ * @memberof ReportTaskResponseAllOf
1530
+ */
1531
+ failReason?: string;
1532
+ /**
1533
+ * Datetime in UTC when the report task was locked for execution
1534
+ * @type {string}
1535
+ * @memberof ReportTaskResponseAllOf
1536
+ */
1537
+ lockedAt?: string;
1538
+ /**
1539
+ * Groups this report is shared with (read-only view of groupsToShareWith)
1540
+ * @type {Array<ReportTaskResponseAllOfGroupsSharedWith>}
1541
+ * @memberof ReportTaskResponseAllOf
1542
+ */
1543
+ groupsSharedWith?: Array<ReportTaskResponseAllOfGroupsSharedWith>;
1544
+ }
1545
+ /**
1546
+ *
1547
+ * @export
1548
+ * @interface ReportTaskResponseAllOfGroupsSharedWith
1549
+ */
1550
+ interface ReportTaskResponseAllOfGroupsSharedWith {
1551
+ /**
1552
+ *
1553
+ * @type {string}
1554
+ * @memberof ReportTaskResponseAllOfGroupsSharedWith
1555
+ */
1556
+ groupId?: string;
1557
+ /**
1558
+ *
1559
+ * @type {string}
1560
+ * @memberof ReportTaskResponseAllOfGroupsSharedWith
1561
+ */
1562
+ name?: string;
1319
1563
  }
1320
1564
  /**
1321
1565
  *
@@ -1410,6 +1654,20 @@ interface Template {
1410
1654
  * @memberof Template
1411
1655
  */
1412
1656
  pageHeight: number;
1657
+ /**
1658
+ * Type of the template
1659
+ * @type {string}
1660
+ * @memberof Template
1661
+ */
1662
+ type?: TemplateTypeEnum;
1663
+ }
1664
+ /**
1665
+ * @export
1666
+ * @enum {string}
1667
+ */
1668
+ declare enum TemplateTypeEnum {
1669
+ PixelPerfect = "pixel-perfect",
1670
+ Excel = "excel"
1413
1671
  }
1414
1672
  /**
1415
1673
  *
@@ -1491,6 +1749,14 @@ declare const BaseTemplatesApiAxiosParamCreator: (configuration?: Configuration)
1491
1749
  * @throws {RequiredError}
1492
1750
  */
1493
1751
  duplicateBaseTemplate: (id: string, options?: any) => Promise<RequestArgs>;
1752
+ /**
1753
+ *
1754
+ * @summary Get base template thumbnail
1755
+ * @param {string} id
1756
+ * @param {*} [options] Override http request option.
1757
+ * @throws {RequiredError}
1758
+ */
1759
+ getBaseTemplateThumbnail: (id: string, options?: any) => Promise<RequestArgs>;
1494
1760
  /**
1495
1761
  *
1496
1762
  * @summary List base templates
@@ -1514,6 +1780,14 @@ declare const BaseTemplatesApiFp: (configuration?: Configuration) => {
1514
1780
  * @throws {RequiredError}
1515
1781
  */
1516
1782
  duplicateBaseTemplate(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Template>>;
1783
+ /**
1784
+ *
1785
+ * @summary Get base template thumbnail
1786
+ * @param {string} id
1787
+ * @param {*} [options] Override http request option.
1788
+ * @throws {RequiredError}
1789
+ */
1790
+ getBaseTemplateThumbnail(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
1517
1791
  /**
1518
1792
  *
1519
1793
  * @summary List base templates
@@ -1537,6 +1811,14 @@ declare const BaseTemplatesApiFactory: (configuration?: Configuration, basePath?
1537
1811
  * @throws {RequiredError}
1538
1812
  */
1539
1813
  duplicateBaseTemplate(id: string, options?: any): AxiosPromise<Template>;
1814
+ /**
1815
+ *
1816
+ * @summary Get base template thumbnail
1817
+ * @param {string} id
1818
+ * @param {*} [options] Override http request option.
1819
+ * @throws {RequiredError}
1820
+ */
1821
+ getBaseTemplateThumbnail(id: string, options?: any): AxiosPromise<any>;
1540
1822
  /**
1541
1823
  *
1542
1824
  * @summary List base templates
@@ -1563,6 +1845,15 @@ declare class BaseTemplatesApi extends BaseAPI {
1563
1845
  * @memberof BaseTemplatesApi
1564
1846
  */
1565
1847
  duplicateBaseTemplate(id: string, options?: any): Promise<axios.AxiosResponse<Template, any>>;
1848
+ /**
1849
+ *
1850
+ * @summary Get base template thumbnail
1851
+ * @param {string} id
1852
+ * @param {*} [options] Override http request option.
1853
+ * @throws {RequiredError}
1854
+ * @memberof BaseTemplatesApi
1855
+ */
1856
+ getBaseTemplateThumbnail(id: string, options?: any): Promise<axios.AxiosResponse<any, any>>;
1566
1857
  /**
1567
1858
  *
1568
1859
  * @summary List base templates
@@ -1582,13 +1873,22 @@ declare const DocumentsApiAxiosParamCreator: (configuration?: Configuration) =>
1582
1873
  /**
1583
1874
  *
1584
1875
  * @summary Retrieve a generated document
1585
- * @param {string} fileName
1876
+ * @param {string} id
1586
1877
  * @param {'pdf' | 'pptx' | 'xlsx' | 'csv'} fileType
1587
1878
  * @param {string} [attachmentName] A document file title. This value is reflected back to the client in the fileName header.
1588
1879
  * @param {*} [options] Override http request option.
1589
1880
  * @throws {RequiredError}
1590
1881
  */
1591
- getDocument: (fileName: string, fileType: 'pdf' | 'pptx' | 'xlsx' | 'csv', attachmentName?: string, options?: any) => Promise<RequestArgs>;
1882
+ getDocument: (id: string, fileType: 'pdf' | 'pptx' | 'xlsx' | 'csv', attachmentName?: string, options?: any) => Promise<RequestArgs>;
1883
+ /**
1884
+ *
1885
+ * @summary Retrieve a generated document
1886
+ * @param {string} id
1887
+ * @param {string} [attachmentName] A document file title. This value is reflected back to the client in the fileName header.
1888
+ * @param {*} [options] Override http request option.
1889
+ * @throws {RequiredError}
1890
+ */
1891
+ getDocumentById: (id: string, attachmentName?: string, options?: any) => Promise<RequestArgs>;
1592
1892
  };
1593
1893
  /**
1594
1894
  * DocumentsApi - functional programming interface
@@ -1598,13 +1898,22 @@ declare const DocumentsApiFp: (configuration?: Configuration) => {
1598
1898
  /**
1599
1899
  *
1600
1900
  * @summary Retrieve a generated document
1601
- * @param {string} fileName
1901
+ * @param {string} id
1602
1902
  * @param {'pdf' | 'pptx' | 'xlsx' | 'csv'} fileType
1603
1903
  * @param {string} [attachmentName] A document file title. This value is reflected back to the client in the fileName header.
1604
1904
  * @param {*} [options] Override http request option.
1605
1905
  * @throws {RequiredError}
1606
1906
  */
1607
- getDocument(fileName: string, fileType: 'pdf' | 'pptx' | 'xlsx' | 'csv', attachmentName?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
1907
+ getDocument(id: string, fileType: 'pdf' | 'pptx' | 'xlsx' | 'csv', attachmentName?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
1908
+ /**
1909
+ *
1910
+ * @summary Retrieve a generated document
1911
+ * @param {string} id
1912
+ * @param {string} [attachmentName] A document file title. This value is reflected back to the client in the fileName header.
1913
+ * @param {*} [options] Override http request option.
1914
+ * @throws {RequiredError}
1915
+ */
1916
+ getDocumentById(id: string, attachmentName?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
1608
1917
  };
1609
1918
  /**
1610
1919
  * DocumentsApi - factory interface
@@ -1614,13 +1923,22 @@ declare const DocumentsApiFactory: (configuration?: Configuration, basePath?: st
1614
1923
  /**
1615
1924
  *
1616
1925
  * @summary Retrieve a generated document
1617
- * @param {string} fileName
1926
+ * @param {string} id
1618
1927
  * @param {'pdf' | 'pptx' | 'xlsx' | 'csv'} fileType
1619
1928
  * @param {string} [attachmentName] A document file title. This value is reflected back to the client in the fileName header.
1620
1929
  * @param {*} [options] Override http request option.
1621
1930
  * @throws {RequiredError}
1622
1931
  */
1623
- getDocument(fileName: string, fileType: 'pdf' | 'pptx' | 'xlsx' | 'csv', attachmentName?: string, options?: any): AxiosPromise<any>;
1932
+ getDocument(id: string, fileType: 'pdf' | 'pptx' | 'xlsx' | 'csv', attachmentName?: string, options?: any): AxiosPromise<any>;
1933
+ /**
1934
+ *
1935
+ * @summary Retrieve a generated document
1936
+ * @param {string} id
1937
+ * @param {string} [attachmentName] A document file title. This value is reflected back to the client in the fileName header.
1938
+ * @param {*} [options] Override http request option.
1939
+ * @throws {RequiredError}
1940
+ */
1941
+ getDocumentById(id: string, attachmentName?: string, options?: any): AxiosPromise<any>;
1624
1942
  };
1625
1943
  /**
1626
1944
  * DocumentsApi - object-oriented interface
@@ -1632,14 +1950,24 @@ declare class DocumentsApi extends BaseAPI {
1632
1950
  /**
1633
1951
  *
1634
1952
  * @summary Retrieve a generated document
1635
- * @param {string} fileName
1953
+ * @param {string} id
1636
1954
  * @param {'pdf' | 'pptx' | 'xlsx' | 'csv'} fileType
1637
1955
  * @param {string} [attachmentName] A document file title. This value is reflected back to the client in the fileName header.
1638
1956
  * @param {*} [options] Override http request option.
1639
1957
  * @throws {RequiredError}
1640
1958
  * @memberof DocumentsApi
1641
1959
  */
1642
- getDocument(fileName: string, fileType: 'pdf' | 'pptx' | 'xlsx' | 'csv', attachmentName?: string, options?: any): Promise<axios.AxiosResponse<any, any>>;
1960
+ getDocument(id: string, fileType: 'pdf' | 'pptx' | 'xlsx' | 'csv', attachmentName?: string, options?: any): Promise<axios.AxiosResponse<any, any>>;
1961
+ /**
1962
+ *
1963
+ * @summary Retrieve a generated document
1964
+ * @param {string} id
1965
+ * @param {string} [attachmentName] A document file title. This value is reflected back to the client in the fileName header.
1966
+ * @param {*} [options] Override http request option.
1967
+ * @throws {RequiredError}
1968
+ * @memberof DocumentsApi
1969
+ */
1970
+ getDocumentById(id: string, attachmentName?: string, options?: any): Promise<axios.AxiosResponse<any, any>>;
1643
1971
  }
1644
1972
  /**
1645
1973
  * FilterCyclesApi - axios parameter creator
@@ -1910,11 +2238,11 @@ declare const ImagesApiAxiosParamCreator: (configuration?: Configuration) => {
1910
2238
  /**
1911
2239
  *
1912
2240
  * @summary Retrieves a user uploaded image for use in a template
1913
- * @param {string} title
2241
+ * @param {string} id
1914
2242
  * @param {*} [options] Override http request option.
1915
2243
  * @throws {RequiredError}
1916
2244
  */
1917
- getImage: (title: string, options?: any) => Promise<RequestArgs>;
2245
+ getImage: (id: string, options?: any) => Promise<RequestArgs>;
1918
2246
  /**
1919
2247
  * Uploads an image to the server for use in templates
1920
2248
  * @summary Upload an image for use in a template
@@ -1932,11 +2260,11 @@ declare const ImagesApiFp: (configuration?: Configuration) => {
1932
2260
  /**
1933
2261
  *
1934
2262
  * @summary Retrieves a user uploaded image for use in a template
1935
- * @param {string} title
2263
+ * @param {string} id
1936
2264
  * @param {*} [options] Override http request option.
1937
2265
  * @throws {RequiredError}
1938
2266
  */
1939
- getImage(title: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
2267
+ getImage(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
1940
2268
  /**
1941
2269
  * Uploads an image to the server for use in templates
1942
2270
  * @summary Upload an image for use in a template
@@ -1944,7 +2272,7 @@ declare const ImagesApiFp: (configuration?: Configuration) => {
1944
2272
  * @param {*} [options] Override http request option.
1945
2273
  * @throws {RequiredError}
1946
2274
  */
1947
- uploadImage(image?: any, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2001>>;
2275
+ uploadImage(image?: any, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2004>>;
1948
2276
  };
1949
2277
  /**
1950
2278
  * ImagesApi - factory interface
@@ -1954,11 +2282,11 @@ declare const ImagesApiFactory: (configuration?: Configuration, basePath?: strin
1954
2282
  /**
1955
2283
  *
1956
2284
  * @summary Retrieves a user uploaded image for use in a template
1957
- * @param {string} title
2285
+ * @param {string} id
1958
2286
  * @param {*} [options] Override http request option.
1959
2287
  * @throws {RequiredError}
1960
2288
  */
1961
- getImage(title: string, options?: any): AxiosPromise<any>;
2289
+ getImage(id: string, options?: any): AxiosPromise<any>;
1962
2290
  /**
1963
2291
  * Uploads an image to the server for use in templates
1964
2292
  * @summary Upload an image for use in a template
@@ -1966,7 +2294,7 @@ declare const ImagesApiFactory: (configuration?: Configuration, basePath?: strin
1966
2294
  * @param {*} [options] Override http request option.
1967
2295
  * @throws {RequiredError}
1968
2296
  */
1969
- uploadImage(image?: any, options?: any): AxiosPromise<InlineResponse2001>;
2297
+ uploadImage(image?: any, options?: any): AxiosPromise<InlineResponse2004>;
1970
2298
  };
1971
2299
  /**
1972
2300
  * ImagesApi - object-oriented interface
@@ -1978,12 +2306,12 @@ declare class ImagesApi extends BaseAPI {
1978
2306
  /**
1979
2307
  *
1980
2308
  * @summary Retrieves a user uploaded image for use in a template
1981
- * @param {string} title
2309
+ * @param {string} id
1982
2310
  * @param {*} [options] Override http request option.
1983
2311
  * @throws {RequiredError}
1984
2312
  * @memberof ImagesApi
1985
2313
  */
1986
- getImage(title: string, options?: any): Promise<axios.AxiosResponse<any, any>>;
2314
+ getImage(id: string, options?: any): Promise<axios.AxiosResponse<any, any>>;
1987
2315
  /**
1988
2316
  * Uploads an image to the server for use in templates
1989
2317
  * @summary Upload an image for use in a template
@@ -1992,7 +2320,7 @@ declare class ImagesApi extends BaseAPI {
1992
2320
  * @throws {RequiredError}
1993
2321
  * @memberof ImagesApi
1994
2322
  */
1995
- uploadImage(image?: any, options?: any): Promise<axios.AxiosResponse<InlineResponse2001, any>>;
2323
+ uploadImage(image?: any, options?: any): Promise<axios.AxiosResponse<InlineResponse2004, any>>;
1996
2324
  }
1997
2325
  /**
1998
2326
  * JobsApi - axios parameter creator
@@ -2090,7 +2418,7 @@ declare const ReportTasksApiAxiosParamCreator: (configuration?: Configuration) =
2090
2418
  * @param {{ [key: string]: string; }} [meta] When you list report tasks you can filter the list given one or metadata key/value pairs. Only items that contain all of the given metadata properties are returned.
2091
2419
  * @param {string} [templateId]
2092
2420
  * @param {number} [perPage]
2093
- * @param {'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId'} [orderBy]
2421
+ * @param {'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId' | 'report.createdAt'} [orderBy]
2094
2422
  * @param {'asc' | 'desc'} [order] The order to retrieve the logs in
2095
2423
  * @param {object} [filter] Filters for report tasks. JSON encoded object in the form of &#x60;{ field: string, query: string}&#x60;, or for date range fields (including \&quot;startOn\&quot; and \&quot;endOn\&quot;), &#x60;{ field: string, query: { start: Date, end: Date }}&#x60;. ### Examples: Filter on \&quot;startOn\&quot;: &#x60;&#x60;&#x60; { \&quot;field\&quot;: \&quot;startOn\&quot;, \&quot;query\&quot;: { \&quot;start\&quot;: \&quot;2020-01-01T00:00:00.000Z\&quot;, \&quot;end\&quot;: \&quot;2020-01-02T00:00:00.000Z\&quot; } } &#x60;&#x60;&#x60; Filter on \&quot;enabled\&quot; &#x60;&#x60;&#x60; { \&quot;field\&quot;: \&quot;enabled\&quot;, \&quot;query\&quot;: \&quot;True\&quot; } &#x60;&#x60;&#x60; Filter on \&quot;frequency\&quot;: &#x60;&#x60;&#x60; { \&quot;field\&quot;: \&quot;frequency\&quot;, \&quot;query\&quot;: \&quot;Monthly\&quot; } &#x60;&#x60;&#x60;
2096
2424
  * @param {*} [options] Override http request option.
@@ -2098,7 +2426,7 @@ declare const ReportTasksApiAxiosParamCreator: (configuration?: Configuration) =
2098
2426
  */
2099
2427
  getReportTasks: (pageNum?: number, meta?: {
2100
2428
  [key: string]: string;
2101
- }, templateId?: string, perPage?: number, orderBy?: 'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId', order?: 'asc' | 'desc', filter?: object, options?: any) => Promise<RequestArgs>;
2429
+ }, 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<RequestArgs>;
2102
2430
  /**
2103
2431
  * Duplicates the task and runs it as \"Once - Now\"
2104
2432
  * @summary Run task now
@@ -2154,7 +2482,7 @@ declare const ReportTasksApiFp: (configuration?: Configuration) => {
2154
2482
  * @param {{ [key: string]: string; }} [meta] When you list report tasks you can filter the list given one or metadata key/value pairs. Only items that contain all of the given metadata properties are returned.
2155
2483
  * @param {string} [templateId]
2156
2484
  * @param {number} [perPage]
2157
- * @param {'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId'} [orderBy]
2485
+ * @param {'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId' | 'report.createdAt'} [orderBy]
2158
2486
  * @param {'asc' | 'desc'} [order] The order to retrieve the logs in
2159
2487
  * @param {object} [filter] Filters for report tasks. JSON encoded object in the form of &#x60;{ field: string, query: string}&#x60;, or for date range fields (including \&quot;startOn\&quot; and \&quot;endOn\&quot;), &#x60;{ field: string, query: { start: Date, end: Date }}&#x60;. ### Examples: Filter on \&quot;startOn\&quot;: &#x60;&#x60;&#x60; { \&quot;field\&quot;: \&quot;startOn\&quot;, \&quot;query\&quot;: { \&quot;start\&quot;: \&quot;2020-01-01T00:00:00.000Z\&quot;, \&quot;end\&quot;: \&quot;2020-01-02T00:00:00.000Z\&quot; } } &#x60;&#x60;&#x60; Filter on \&quot;enabled\&quot; &#x60;&#x60;&#x60; { \&quot;field\&quot;: \&quot;enabled\&quot;, \&quot;query\&quot;: \&quot;True\&quot; } &#x60;&#x60;&#x60; Filter on \&quot;frequency\&quot;: &#x60;&#x60;&#x60; { \&quot;field\&quot;: \&quot;frequency\&quot;, \&quot;query\&quot;: \&quot;Monthly\&quot; } &#x60;&#x60;&#x60;
2160
2488
  * @param {*} [options] Override http request option.
@@ -2162,7 +2490,7 @@ declare const ReportTasksApiFp: (configuration?: Configuration) => {
2162
2490
  */
2163
2491
  getReportTasks(pageNum?: number, meta?: {
2164
2492
  [key: string]: string;
2165
- }, templateId?: string, perPage?: number, orderBy?: 'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId', order?: 'asc' | 'desc', filter?: object, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2002>>;
2493
+ }, 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>>;
2166
2494
  /**
2167
2495
  * Duplicates the task and runs it as \"Once - Now\"
2168
2496
  * @summary Run task now
@@ -2218,7 +2546,7 @@ declare const ReportTasksApiFactory: (configuration?: Configuration, basePath?:
2218
2546
  * @param {{ [key: string]: string; }} [meta] When you list report tasks you can filter the list given one or metadata key/value pairs. Only items that contain all of the given metadata properties are returned.
2219
2547
  * @param {string} [templateId]
2220
2548
  * @param {number} [perPage]
2221
- * @param {'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId'} [orderBy]
2549
+ * @param {'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId' | 'report.createdAt'} [orderBy]
2222
2550
  * @param {'asc' | 'desc'} [order] The order to retrieve the logs in
2223
2551
  * @param {object} [filter] Filters for report tasks. JSON encoded object in the form of &#x60;{ field: string, query: string}&#x60;, or for date range fields (including \&quot;startOn\&quot; and \&quot;endOn\&quot;), &#x60;{ field: string, query: { start: Date, end: Date }}&#x60;. ### Examples: Filter on \&quot;startOn\&quot;: &#x60;&#x60;&#x60; { \&quot;field\&quot;: \&quot;startOn\&quot;, \&quot;query\&quot;: { \&quot;start\&quot;: \&quot;2020-01-01T00:00:00.000Z\&quot;, \&quot;end\&quot;: \&quot;2020-01-02T00:00:00.000Z\&quot; } } &#x60;&#x60;&#x60; Filter on \&quot;enabled\&quot; &#x60;&#x60;&#x60; { \&quot;field\&quot;: \&quot;enabled\&quot;, \&quot;query\&quot;: \&quot;True\&quot; } &#x60;&#x60;&#x60; Filter on \&quot;frequency\&quot;: &#x60;&#x60;&#x60; { \&quot;field\&quot;: \&quot;frequency\&quot;, \&quot;query\&quot;: \&quot;Monthly\&quot; } &#x60;&#x60;&#x60;
2224
2552
  * @param {*} [options] Override http request option.
@@ -2226,7 +2554,7 @@ declare const ReportTasksApiFactory: (configuration?: Configuration, basePath?:
2226
2554
  */
2227
2555
  getReportTasks(pageNum?: number, meta?: {
2228
2556
  [key: string]: string;
2229
- }, templateId?: string, perPage?: number, orderBy?: 'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId', order?: 'asc' | 'desc', filter?: object, options?: any): AxiosPromise<InlineResponse2002>;
2557
+ }, 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>;
2230
2558
  /**
2231
2559
  * Duplicates the task and runs it as \"Once - Now\"
2232
2560
  * @summary Run task now
@@ -2287,7 +2615,7 @@ declare class ReportTasksApi extends BaseAPI {
2287
2615
  * @param {{ [key: string]: string; }} [meta] When you list report tasks you can filter the list given one or metadata key/value pairs. Only items that contain all of the given metadata properties are returned.
2288
2616
  * @param {string} [templateId]
2289
2617
  * @param {number} [perPage]
2290
- * @param {'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId'} [orderBy]
2618
+ * @param {'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId' | 'report.createdAt'} [orderBy]
2291
2619
  * @param {'asc' | 'desc'} [order] The order to retrieve the logs in
2292
2620
  * @param {object} [filter] Filters for report tasks. JSON encoded object in the form of &#x60;{ field: string, query: string}&#x60;, or for date range fields (including \&quot;startOn\&quot; and \&quot;endOn\&quot;), &#x60;{ field: string, query: { start: Date, end: Date }}&#x60;. ### Examples: Filter on \&quot;startOn\&quot;: &#x60;&#x60;&#x60; { \&quot;field\&quot;: \&quot;startOn\&quot;, \&quot;query\&quot;: { \&quot;start\&quot;: \&quot;2020-01-01T00:00:00.000Z\&quot;, \&quot;end\&quot;: \&quot;2020-01-02T00:00:00.000Z\&quot; } } &#x60;&#x60;&#x60; Filter on \&quot;enabled\&quot; &#x60;&#x60;&#x60; { \&quot;field\&quot;: \&quot;enabled\&quot;, \&quot;query\&quot;: \&quot;True\&quot; } &#x60;&#x60;&#x60; Filter on \&quot;frequency\&quot;: &#x60;&#x60;&#x60; { \&quot;field\&quot;: \&quot;frequency\&quot;, \&quot;query\&quot;: \&quot;Monthly\&quot; } &#x60;&#x60;&#x60;
2293
2621
  * @param {*} [options] Override http request option.
@@ -2296,7 +2624,7 @@ declare class ReportTasksApi extends BaseAPI {
2296
2624
  */
2297
2625
  getReportTasks(pageNum?: number, meta?: {
2298
2626
  [key: string]: string;
2299
- }, templateId?: string, perPage?: number, orderBy?: 'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId', order?: 'asc' | 'desc', filter?: object, options?: any): Promise<axios.AxiosResponse<InlineResponse2002, any>>;
2627
+ }, 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.AxiosResponse<InlineResponse2001, any>>;
2300
2628
  /**
2301
2629
  * Duplicates the task and runs it as \"Once - Now\"
2302
2630
  * @summary Run task now
@@ -2338,6 +2666,14 @@ declare const ReportsApiAxiosParamCreator: (configuration?: Configuration) => {
2338
2666
  * @throws {RequiredError}
2339
2667
  */
2340
2668
  getReport: (id: string, options?: any) => Promise<RequestArgs>;
2669
+ /**
2670
+ *
2671
+ * @summary Get report thumbnail
2672
+ * @param {string} id
2673
+ * @param {*} [options] Override http request option.
2674
+ * @throws {RequiredError}
2675
+ */
2676
+ getReportThumbnail: (id: string, options?: any) => Promise<RequestArgs>;
2341
2677
  /**
2342
2678
  *
2343
2679
  * @summary List reports
@@ -2382,6 +2718,14 @@ declare const ReportsApiFp: (configuration?: Configuration) => {
2382
2718
  * @throws {RequiredError}
2383
2719
  */
2384
2720
  getReport(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Report>>;
2721
+ /**
2722
+ *
2723
+ * @summary Get report thumbnail
2724
+ * @param {string} id
2725
+ * @param {*} [options] Override http request option.
2726
+ * @throws {RequiredError}
2727
+ */
2728
+ getReportThumbnail(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
2385
2729
  /**
2386
2730
  *
2387
2731
  * @summary List reports
@@ -2394,7 +2738,7 @@ declare const ReportsApiFp: (configuration?: Configuration) => {
2394
2738
  * @param {*} [options] Override http request option.
2395
2739
  * @throws {RequiredError}
2396
2740
  */
2397
- getReports(pageNum?: number, perPage?: number, orderBy?: 'title' | 'createdAt', order?: 'asc' | 'desc', tagId?: string, reportTaskId?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2003>>;
2741
+ getReports(pageNum?: number, perPage?: number, orderBy?: 'title' | 'createdAt', order?: 'asc' | 'desc', tagId?: string, reportTaskId?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2002>>;
2398
2742
  /**
2399
2743
  *
2400
2744
  * @summary Render a published report
@@ -2426,6 +2770,14 @@ declare const ReportsApiFactory: (configuration?: Configuration, basePath?: stri
2426
2770
  * @throws {RequiredError}
2427
2771
  */
2428
2772
  getReport(id: string, options?: any): AxiosPromise<Report>;
2773
+ /**
2774
+ *
2775
+ * @summary Get report thumbnail
2776
+ * @param {string} id
2777
+ * @param {*} [options] Override http request option.
2778
+ * @throws {RequiredError}
2779
+ */
2780
+ getReportThumbnail(id: string, options?: any): AxiosPromise<any>;
2429
2781
  /**
2430
2782
  *
2431
2783
  * @summary List reports
@@ -2438,7 +2790,7 @@ declare const ReportsApiFactory: (configuration?: Configuration, basePath?: stri
2438
2790
  * @param {*} [options] Override http request option.
2439
2791
  * @throws {RequiredError}
2440
2792
  */
2441
- getReports(pageNum?: number, perPage?: number, orderBy?: 'title' | 'createdAt', order?: 'asc' | 'desc', tagId?: string, reportTaskId?: string, options?: any): AxiosPromise<InlineResponse2003>;
2793
+ getReports(pageNum?: number, perPage?: number, orderBy?: 'title' | 'createdAt', order?: 'asc' | 'desc', tagId?: string, reportTaskId?: string, options?: any): AxiosPromise<InlineResponse2002>;
2442
2794
  /**
2443
2795
  *
2444
2796
  * @summary Render a published report
@@ -2474,6 +2826,15 @@ declare class ReportsApi extends BaseAPI {
2474
2826
  * @memberof ReportsApi
2475
2827
  */
2476
2828
  getReport(id: string, options?: any): Promise<axios.AxiosResponse<Report, any>>;
2829
+ /**
2830
+ *
2831
+ * @summary Get report thumbnail
2832
+ * @param {string} id
2833
+ * @param {*} [options] Override http request option.
2834
+ * @throws {RequiredError}
2835
+ * @memberof ReportsApi
2836
+ */
2837
+ getReportThumbnail(id: string, options?: any): Promise<axios.AxiosResponse<any, any>>;
2477
2838
  /**
2478
2839
  *
2479
2840
  * @summary List reports
@@ -2487,7 +2848,7 @@ declare class ReportsApi extends BaseAPI {
2487
2848
  * @throws {RequiredError}
2488
2849
  * @memberof ReportsApi
2489
2850
  */
2490
- getReports(pageNum?: number, perPage?: number, orderBy?: 'title' | 'createdAt', order?: 'asc' | 'desc', tagId?: string, reportTaskId?: string, options?: any): Promise<axios.AxiosResponse<InlineResponse2003, any>>;
2851
+ getReports(pageNum?: number, perPage?: number, orderBy?: 'title' | 'createdAt', order?: 'asc' | 'desc', tagId?: string, reportTaskId?: string, options?: any): Promise<axios.AxiosResponse<InlineResponse2002, any>>;
2491
2852
  /**
2492
2853
  *
2493
2854
  * @summary Render a published report
@@ -2544,6 +2905,14 @@ declare const TemplatesApiAxiosParamCreator: (configuration?: Configuration) =>
2544
2905
  * @throws {RequiredError}
2545
2906
  */
2546
2907
  getTemplate: (id: string, options?: any) => Promise<RequestArgs>;
2908
+ /**
2909
+ *
2910
+ * @summary Get template thumbnail
2911
+ * @param {string} id
2912
+ * @param {*} [options] Override http request option.
2913
+ * @throws {RequiredError}
2914
+ */
2915
+ getTemplateThumbnail: (id: string, options?: any) => Promise<RequestArgs>;
2547
2916
  /**
2548
2917
  *
2549
2918
  * @summary List report templates
@@ -2624,6 +2993,14 @@ declare const TemplatesApiFp: (configuration?: Configuration) => {
2624
2993
  * @throws {RequiredError}
2625
2994
  */
2626
2995
  getTemplate(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Template>>;
2996
+ /**
2997
+ *
2998
+ * @summary Get template thumbnail
2999
+ * @param {string} id
3000
+ * @param {*} [options] Override http request option.
3001
+ * @throws {RequiredError}
3002
+ */
3003
+ getTemplateThumbnail(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
2627
3004
  /**
2628
3005
  *
2629
3006
  * @summary List report templates
@@ -2631,7 +3008,7 @@ declare const TemplatesApiFp: (configuration?: Configuration) => {
2631
3008
  * @param {*} [options] Override http request option.
2632
3009
  * @throws {RequiredError}
2633
3010
  */
2634
- getTemplates(pageNum?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2004>>;
3011
+ getTemplates(pageNum?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2003>>;
2635
3012
  /**
2636
3013
  * Imports an exported .CRPT file
2637
3014
  * @summary Import a template
@@ -2704,6 +3081,14 @@ declare const TemplatesApiFactory: (configuration?: Configuration, basePath?: st
2704
3081
  * @throws {RequiredError}
2705
3082
  */
2706
3083
  getTemplate(id: string, options?: any): AxiosPromise<Template>;
3084
+ /**
3085
+ *
3086
+ * @summary Get template thumbnail
3087
+ * @param {string} id
3088
+ * @param {*} [options] Override http request option.
3089
+ * @throws {RequiredError}
3090
+ */
3091
+ getTemplateThumbnail(id: string, options?: any): AxiosPromise<any>;
2707
3092
  /**
2708
3093
  *
2709
3094
  * @summary List report templates
@@ -2711,7 +3096,7 @@ declare const TemplatesApiFactory: (configuration?: Configuration, basePath?: st
2711
3096
  * @param {*} [options] Override http request option.
2712
3097
  * @throws {RequiredError}
2713
3098
  */
2714
- getTemplates(pageNum?: number, options?: any): AxiosPromise<InlineResponse2004>;
3099
+ getTemplates(pageNum?: number, options?: any): AxiosPromise<InlineResponse2003>;
2715
3100
  /**
2716
3101
  * Imports an exported .CRPT file
2717
3102
  * @summary Import a template
@@ -2791,6 +3176,15 @@ declare class TemplatesApi extends BaseAPI {
2791
3176
  * @memberof TemplatesApi
2792
3177
  */
2793
3178
  getTemplate(id: string, options?: any): Promise<axios.AxiosResponse<Template, any>>;
3179
+ /**
3180
+ *
3181
+ * @summary Get template thumbnail
3182
+ * @param {string} id
3183
+ * @param {*} [options] Override http request option.
3184
+ * @throws {RequiredError}
3185
+ * @memberof TemplatesApi
3186
+ */
3187
+ getTemplateThumbnail(id: string, options?: any): Promise<axios.AxiosResponse<any, any>>;
2794
3188
  /**
2795
3189
  *
2796
3190
  * @summary List report templates
@@ -2799,7 +3193,7 @@ declare class TemplatesApi extends BaseAPI {
2799
3193
  * @throws {RequiredError}
2800
3194
  * @memberof TemplatesApi
2801
3195
  */
2802
- getTemplates(pageNum?: number, options?: any): Promise<axios.AxiosResponse<InlineResponse2004, any>>;
3196
+ getTemplates(pageNum?: number, options?: any): Promise<axios.AxiosResponse<InlineResponse2003, any>>;
2803
3197
  /**
2804
3198
  * Imports an exported .CRPT file
2805
3199
  * @summary Import a template
@@ -2908,4 +3302,4 @@ declare class ConnectReport {
2908
3302
  constructor(config: Pick<Configuration, "apiKey" | "basePath" | "formDataCtor" | "httpsAgent">);
2909
3303
  }
2910
3304
 
2911
- export { BaseTemplatesApi, BaseTemplatesApiAxiosParamCreator, BaseTemplatesApiFactory, BaseTemplatesApiFp, ConnectReport, DocumentsApi, DocumentsApiAxiosParamCreator, DocumentsApiFactory, DocumentsApiFp, type FilterCycle, type FilterCycleAllOf, type FilterCycleAllOfFieldInfo, type FilterCycleAllOfFieldValues, FilterCycleEmailEnum, FilterCycleFrequencyEnum, FilterCyclesApi, FilterCyclesApiAxiosParamCreator, FilterCyclesApiFactory, FilterCyclesApiFp, ImagesApi, ImagesApiAxiosParamCreator, ImagesApiFactory, ImagesApiFp, type InlineResponse200, type InlineResponse2001, type InlineResponse2002, type InlineResponse2003, type InlineResponse2004, type Job, type JobResponse, JobsApi, JobsApiAxiosParamCreator, JobsApiFactory, JobsApiFp, type ModelError, type Report, type ReportTask, type ReportTaskCustomSelection, ReportTaskEmailEnum, type ReportTaskFieldValues, type ReportTaskFilterSets, ReportTaskFrequencyEnum, type ReportTaskGroupsToShareWith, type ReportTaskRequest, type ReportTaskRequestAllOf, type ReportTaskRequestAllOfUsersToShareWith, ReportTaskRequestEmailEnum, ReportTaskRequestFrequencyEnum, type ReportTaskResponse, type ReportTaskResponseAllOf, type ReportTaskResponseAllOfUsersToShareWith, ReportTaskResponseEmailEnum, ReportTaskResponseFrequencyEnum, type ReportTaskTags, type ReportTaskVariables, ReportTasksApi, ReportTasksApiAxiosParamCreator, ReportTasksApiFactory, ReportTasksApiFp, ReportsApi, ReportsApiAxiosParamCreator, ReportsApiFactory, ReportsApiFp, type Template, TemplatesApi, TemplatesApiAxiosParamCreator, TemplatesApiFactory, TemplatesApiFp, type Visualization, VisualizationApi, VisualizationApiAxiosParamCreator, VisualizationApiFactory, VisualizationApiFp };
3305
+ export { BaseTemplatesApi, BaseTemplatesApiAxiosParamCreator, BaseTemplatesApiFactory, BaseTemplatesApiFp, ConnectReport, DocumentsApi, DocumentsApiAxiosParamCreator, DocumentsApiFactory, DocumentsApiFp, type FilterCycle, type FilterCycleAllOf, type FilterCycleAllOfFieldInfo, type FilterCycleAllOfFieldValues, FilterCycleEmailEnum, FilterCycleFrequencyEnum, FilterCyclesApi, FilterCyclesApiAxiosParamCreator, FilterCyclesApiFactory, FilterCyclesApiFp, ImagesApi, ImagesApiAxiosParamCreator, ImagesApiFactory, ImagesApiFp, type InlineResponse200, type InlineResponse2001, type InlineResponse2002, type InlineResponse2003, type InlineResponse2004, type Job, type JobResponse, JobsApi, JobsApiAxiosParamCreator, JobsApiFactory, JobsApiFp, type ModelError, type Report, type ReportTask, type ReportTaskCustomSelection, ReportTaskEmailEnum, type ReportTaskErrors, type ReportTaskFieldValues, type ReportTaskFilterSets, ReportTaskFrequencyEnum, type ReportTaskGroupsToShareWith, type ReportTaskRequest, type ReportTaskRequestAllOf, type ReportTaskRequestAllOfUsersToShareWith, ReportTaskRequestEmailEnum, ReportTaskRequestFrequencyEnum, type ReportTaskResponse, type ReportTaskResponseAllOf, type ReportTaskResponseAllOfGroupsSharedWith, type ReportTaskResponseAllOfUsersToShareWith, ReportTaskResponseEmailEnum, ReportTaskResponseFrequencyEnum, type ReportTaskTags, type ReportTaskVariables, ReportTasksApi, ReportTasksApiAxiosParamCreator, ReportTasksApiFactory, ReportTasksApiFp, ReportTypeEnum, ReportsApi, ReportsApiAxiosParamCreator, ReportsApiFactory, ReportsApiFp, type Template, TemplateTypeEnum, TemplatesApi, TemplatesApiAxiosParamCreator, TemplatesApiFactory, TemplatesApiFp, type Visualization, VisualizationApi, VisualizationApiAxiosParamCreator, VisualizationApiFactory, VisualizationApiFp };