@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/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.4
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).
@@ -94,11 +94,11 @@ export interface FilterCycle {
94
94
  */
95
95
  nextRunAt?: string;
96
96
  /**
97
- * The error object from the last report task execution, if applicable
98
- * @type {string}
97
+ *
98
+ * @type {Array<ReportTaskErrors>}
99
99
  * @memberof FilterCycle
100
100
  */
101
- error?: string;
101
+ errors?: Array<ReportTaskErrors>;
102
102
  /**
103
103
  * The average time to run the report task, in minutes
104
104
  * @type {number}
@@ -165,6 +165,12 @@ export interface FilterCycle {
165
165
  * @memberof FilterCycle
166
166
  */
167
167
  emailBody?: string;
168
+ /**
169
+ * The ID of the OneDrive folder to publish the report to
170
+ * @type {string}
171
+ * @memberof FilterCycle
172
+ */
173
+ onedriveParentFolderId?: string;
168
174
  /**
169
175
  *
170
176
  * @type {FilterCycleAllOfFieldInfo}
@@ -178,7 +184,7 @@ export interface FilterCycle {
178
184
  */
179
185
  fieldValues?: Array<FilterCycleAllOfFieldValues>;
180
186
  /**
181
- *
187
+ * This field is deprecated in favor of docId.
182
188
  * @type {string}
183
189
  * @memberof FilterCycle
184
190
  */
@@ -195,6 +201,18 @@ export interface FilterCycle {
195
201
  * @memberof FilterCycle
196
202
  */
197
203
  autotag?: boolean;
204
+ /**
205
+ *
206
+ * @type {string}
207
+ * @memberof FilterCycle
208
+ */
209
+ docId?: string;
210
+ /**
211
+ *
212
+ * @type {string}
213
+ * @memberof FilterCycle
214
+ */
215
+ connectorName?: string;
198
216
  }
199
217
 
200
218
  /**
@@ -240,7 +258,7 @@ export interface FilterCycleAllOf {
240
258
  */
241
259
  fieldValues?: Array<FilterCycleAllOfFieldValues>;
242
260
  /**
243
- *
261
+ * This field is deprecated in favor of docId.
244
262
  * @type {string}
245
263
  * @memberof FilterCycleAllOf
246
264
  */
@@ -257,6 +275,18 @@ export interface FilterCycleAllOf {
257
275
  * @memberof FilterCycleAllOf
258
276
  */
259
277
  autotag?: boolean;
278
+ /**
279
+ *
280
+ * @type {string}
281
+ * @memberof FilterCycleAllOf
282
+ */
283
+ docId?: string;
284
+ /**
285
+ *
286
+ * @type {string}
287
+ * @memberof FilterCycleAllOf
288
+ */
289
+ connectorName?: string;
260
290
  }
261
291
  /**
262
292
  *
@@ -335,10 +365,16 @@ export interface InlineResponse200 {
335
365
  export interface InlineResponse2001 {
336
366
  /**
337
367
  *
338
- * @type {string}
368
+ * @type {Array<ReportTaskResponse>}
339
369
  * @memberof InlineResponse2001
340
370
  */
341
- path?: string;
371
+ reportTasks?: Array<ReportTaskResponse>;
372
+ /**
373
+ *
374
+ * @type {number}
375
+ * @memberof InlineResponse2001
376
+ */
377
+ totalPages?: number;
342
378
  }
343
379
  /**
344
380
  *
@@ -348,16 +384,22 @@ export interface InlineResponse2001 {
348
384
  export interface InlineResponse2002 {
349
385
  /**
350
386
  *
351
- * @type {Array<ReportTaskResponse>}
387
+ * @type {Array<Report>}
352
388
  * @memberof InlineResponse2002
353
389
  */
354
- reportTasks?: Array<ReportTaskResponse>;
390
+ reports?: Array<Report>;
355
391
  /**
356
392
  *
357
393
  * @type {number}
358
394
  * @memberof InlineResponse2002
359
395
  */
360
396
  totalPages?: number;
397
+ /**
398
+ *
399
+ * @type {number}
400
+ * @memberof InlineResponse2002
401
+ */
402
+ totalItems?: number;
361
403
  }
362
404
  /**
363
405
  *
@@ -367,22 +409,16 @@ export interface InlineResponse2002 {
367
409
  export interface InlineResponse2003 {
368
410
  /**
369
411
  *
370
- * @type {Array<Report>}
412
+ * @type {Array<Template>}
371
413
  * @memberof InlineResponse2003
372
414
  */
373
- reports?: Array<Report>;
415
+ templates?: Array<Template>;
374
416
  /**
375
417
  *
376
418
  * @type {number}
377
419
  * @memberof InlineResponse2003
378
420
  */
379
421
  totalPages?: number;
380
- /**
381
- *
382
- * @type {number}
383
- * @memberof InlineResponse2003
384
- */
385
- totalItems?: number;
386
422
  }
387
423
  /**
388
424
  *
@@ -392,16 +428,10 @@ export interface InlineResponse2003 {
392
428
  export interface InlineResponse2004 {
393
429
  /**
394
430
  *
395
- * @type {Array<Template>}
396
- * @memberof InlineResponse2004
397
- */
398
- templates?: Array<Template>;
399
- /**
400
- *
401
- * @type {number}
431
+ * @type {string}
402
432
  * @memberof InlineResponse2004
403
433
  */
404
- totalPages?: number;
434
+ path?: string;
405
435
  }
406
436
  /**
407
437
  *
@@ -556,7 +586,23 @@ export interface Report {
556
586
  * @memberof Report
557
587
  */
558
588
  sizeBytes?: number;
589
+ /**
590
+ * The type of report
591
+ * @type {string}
592
+ * @memberof Report
593
+ */
594
+ type?: ReportTypeEnum;
595
+ }
596
+
597
+ /**
598
+ * @export
599
+ * @enum {string}
600
+ */
601
+ export enum ReportTypeEnum {
602
+ PixelPerfect = 'pixel-perfect',
603
+ Excel = 'excel'
559
604
  }
605
+
560
606
  /**
561
607
  *
562
608
  * @export
@@ -630,11 +676,11 @@ export interface ReportTask {
630
676
  */
631
677
  nextRunAt?: string;
632
678
  /**
633
- * The error object from the last report task execution, if applicable
634
- * @type {string}
679
+ *
680
+ * @type {Array<ReportTaskErrors>}
635
681
  * @memberof ReportTask
636
682
  */
637
- error?: string;
683
+ errors?: Array<ReportTaskErrors>;
638
684
  /**
639
685
  * The average time to run the report task, in minutes
640
686
  * @type {number}
@@ -701,6 +747,12 @@ export interface ReportTask {
701
747
  * @memberof ReportTask
702
748
  */
703
749
  emailBody?: string;
750
+ /**
751
+ * The ID of the OneDrive folder to publish the report to
752
+ * @type {string}
753
+ * @memberof ReportTask
754
+ */
755
+ onedriveParentFolderId?: string;
704
756
  }
705
757
 
706
758
  /**
@@ -752,6 +804,31 @@ export interface ReportTaskCustomSelection {
752
804
  */
753
805
  fieldValues?: Array<ReportTaskFieldValues>;
754
806
  }
807
+ /**
808
+ *
809
+ * @export
810
+ * @interface ReportTaskErrors
811
+ */
812
+ export interface ReportTaskErrors {
813
+ /**
814
+ *
815
+ * @type {string}
816
+ * @memberof ReportTaskErrors
817
+ */
818
+ err: string;
819
+ /**
820
+ *
821
+ * @type {string}
822
+ * @memberof ReportTaskErrors
823
+ */
824
+ culpritGuid?: string;
825
+ /**
826
+ *
827
+ * @type {string}
828
+ * @memberof ReportTaskErrors
829
+ */
830
+ page?: string;
831
+ }
755
832
  /**
756
833
  *
757
834
  * @export
@@ -876,11 +953,11 @@ export interface ReportTaskRequest {
876
953
  */
877
954
  nextRunAt?: string;
878
955
  /**
879
- * The error object from the last report task execution, if applicable
880
- * @type {string}
956
+ *
957
+ * @type {Array<ReportTaskErrors>}
881
958
  * @memberof ReportTaskRequest
882
959
  */
883
- error?: string;
960
+ errors?: Array<ReportTaskErrors>;
884
961
  /**
885
962
  * The average time to run the report task, in minutes
886
963
  * @type {number}
@@ -947,6 +1024,12 @@ export interface ReportTaskRequest {
947
1024
  * @memberof ReportTaskRequest
948
1025
  */
949
1026
  emailBody?: string;
1027
+ /**
1028
+ * The ID of the OneDrive folder to publish the report to
1029
+ * @type {string}
1030
+ * @memberof ReportTaskRequest
1031
+ */
1032
+ onedriveParentFolderId?: string;
950
1033
  /**
951
1034
  * Emails to send the report to. This is only allowed if \"Allow reports to be shared with any email\" is to true.
952
1035
  * @type {Array<string>}
@@ -1015,6 +1098,12 @@ export interface ReportTaskRequestAllOf {
1015
1098
  * @memberof ReportTaskRequestAllOf
1016
1099
  */
1017
1100
  usersToShareWith?: Array<ReportTaskRequestAllOfUsersToShareWith>;
1101
+ /**
1102
+ * Groups to share the published report with. This field will be updated entirely if provided
1103
+ * @type {Array<ReportTaskGroupsToShareWith>}
1104
+ * @memberof ReportTaskRequestAllOf
1105
+ */
1106
+ groupsToShareWith?: Array<ReportTaskGroupsToShareWith>;
1018
1107
  }
1019
1108
  /**
1020
1109
  *
@@ -1040,7 +1129,7 @@ export interface ReportTaskResponse {
1040
1129
  * @type {string}
1041
1130
  * @memberof ReportTaskResponse
1042
1131
  */
1043
- id?: string;
1132
+ id: string;
1044
1133
  /**
1045
1134
  * Title of the report task
1046
1135
  * @type {string}
@@ -1102,11 +1191,11 @@ export interface ReportTaskResponse {
1102
1191
  */
1103
1192
  nextRunAt?: string;
1104
1193
  /**
1105
- * The error object from the last report task execution, if applicable
1106
- * @type {string}
1194
+ *
1195
+ * @type {Array<ReportTaskErrors>}
1107
1196
  * @memberof ReportTaskResponse
1108
1197
  */
1109
- error?: string;
1198
+ errors?: Array<ReportTaskErrors>;
1110
1199
  /**
1111
1200
  * The average time to run the report task, in minutes
1112
1201
  * @type {number}
@@ -1173,12 +1262,84 @@ export interface ReportTaskResponse {
1173
1262
  * @memberof ReportTaskResponse
1174
1263
  */
1175
1264
  emailBody?: string;
1265
+ /**
1266
+ * The ID of the OneDrive folder to publish the report to
1267
+ * @type {string}
1268
+ * @memberof ReportTaskResponse
1269
+ */
1270
+ onedriveParentFolderId?: string;
1176
1271
  /**
1177
1272
  * Users to share the published report with. This field will be updated entirely if provided
1178
1273
  * @type {Array<ReportTaskResponseAllOfUsersToShareWith>}
1179
1274
  * @memberof ReportTaskResponse
1180
1275
  */
1181
1276
  usersToShareWith?: Array<ReportTaskResponseAllOfUsersToShareWith>;
1277
+ /**
1278
+ * Datetime in UTC when the report task was created
1279
+ * @type {string}
1280
+ * @memberof ReportTaskResponse
1281
+ */
1282
+ createdAt?: string;
1283
+ /**
1284
+ * Datetime in UTC when the report task was last saved
1285
+ * @type {string}
1286
+ * @memberof ReportTaskResponse
1287
+ */
1288
+ lastSavedAt?: string;
1289
+ /**
1290
+ * Field value information
1291
+ * @type {string}
1292
+ * @memberof ReportTaskResponse
1293
+ */
1294
+ fieldValue?: string;
1295
+ /**
1296
+ * Field information
1297
+ * @type {string}
1298
+ * @memberof ReportTaskResponse
1299
+ */
1300
+ fieldInfo?: string;
1301
+ /**
1302
+ * Title of the filter cycle this report task belongs to
1303
+ * @type {string}
1304
+ * @memberof ReportTaskResponse
1305
+ */
1306
+ filterCycleTitle?: string;
1307
+ /**
1308
+ * Datetime in UTC when the report task last started execution
1309
+ * @type {string}
1310
+ * @memberof ReportTaskResponse
1311
+ */
1312
+ lastRunAt?: string;
1313
+ /**
1314
+ * Datetime in UTC when the report task last finished execution
1315
+ * @type {string}
1316
+ * @memberof ReportTaskResponse
1317
+ */
1318
+ lastFinishedAt?: string;
1319
+ /**
1320
+ * Datetime in UTC when the report task last failed
1321
+ * @type {string}
1322
+ * @memberof ReportTaskResponse
1323
+ */
1324
+ failedAt?: string;
1325
+ /**
1326
+ * Reason for the last failure, if applicable
1327
+ * @type {string}
1328
+ * @memberof ReportTaskResponse
1329
+ */
1330
+ failReason?: string;
1331
+ /**
1332
+ * Datetime in UTC when the report task was locked for execution
1333
+ * @type {string}
1334
+ * @memberof ReportTaskResponse
1335
+ */
1336
+ lockedAt?: string;
1337
+ /**
1338
+ * Groups this report is shared with (read-only view of groupsToShareWith)
1339
+ * @type {Array<ReportTaskResponseAllOfGroupsSharedWith>}
1340
+ * @memberof ReportTaskResponse
1341
+ */
1342
+ groupsSharedWith?: Array<ReportTaskResponseAllOfGroupsSharedWith>;
1182
1343
  }
1183
1344
 
1184
1345
  /**
@@ -1217,6 +1378,91 @@ export interface ReportTaskResponseAllOf {
1217
1378
  * @memberof ReportTaskResponseAllOf
1218
1379
  */
1219
1380
  usersToShareWith?: Array<ReportTaskResponseAllOfUsersToShareWith>;
1381
+ /**
1382
+ * Datetime in UTC when the report task was created
1383
+ * @type {string}
1384
+ * @memberof ReportTaskResponseAllOf
1385
+ */
1386
+ createdAt?: string;
1387
+ /**
1388
+ * Datetime in UTC when the report task was last saved
1389
+ * @type {string}
1390
+ * @memberof ReportTaskResponseAllOf
1391
+ */
1392
+ lastSavedAt?: string;
1393
+ /**
1394
+ * Field value information
1395
+ * @type {string}
1396
+ * @memberof ReportTaskResponseAllOf
1397
+ */
1398
+ fieldValue?: string;
1399
+ /**
1400
+ * Field information
1401
+ * @type {string}
1402
+ * @memberof ReportTaskResponseAllOf
1403
+ */
1404
+ fieldInfo?: string;
1405
+ /**
1406
+ * Title of the filter cycle this report task belongs to
1407
+ * @type {string}
1408
+ * @memberof ReportTaskResponseAllOf
1409
+ */
1410
+ filterCycleTitle?: string;
1411
+ /**
1412
+ * Datetime in UTC when the report task last started execution
1413
+ * @type {string}
1414
+ * @memberof ReportTaskResponseAllOf
1415
+ */
1416
+ lastRunAt?: string;
1417
+ /**
1418
+ * Datetime in UTC when the report task last finished execution
1419
+ * @type {string}
1420
+ * @memberof ReportTaskResponseAllOf
1421
+ */
1422
+ lastFinishedAt?: string;
1423
+ /**
1424
+ * Datetime in UTC when the report task last failed
1425
+ * @type {string}
1426
+ * @memberof ReportTaskResponseAllOf
1427
+ */
1428
+ failedAt?: string;
1429
+ /**
1430
+ * Reason for the last failure, if applicable
1431
+ * @type {string}
1432
+ * @memberof ReportTaskResponseAllOf
1433
+ */
1434
+ failReason?: string;
1435
+ /**
1436
+ * Datetime in UTC when the report task was locked for execution
1437
+ * @type {string}
1438
+ * @memberof ReportTaskResponseAllOf
1439
+ */
1440
+ lockedAt?: string;
1441
+ /**
1442
+ * Groups this report is shared with (read-only view of groupsToShareWith)
1443
+ * @type {Array<ReportTaskResponseAllOfGroupsSharedWith>}
1444
+ * @memberof ReportTaskResponseAllOf
1445
+ */
1446
+ groupsSharedWith?: Array<ReportTaskResponseAllOfGroupsSharedWith>;
1447
+ }
1448
+ /**
1449
+ *
1450
+ * @export
1451
+ * @interface ReportTaskResponseAllOfGroupsSharedWith
1452
+ */
1453
+ export interface ReportTaskResponseAllOfGroupsSharedWith {
1454
+ /**
1455
+ *
1456
+ * @type {string}
1457
+ * @memberof ReportTaskResponseAllOfGroupsSharedWith
1458
+ */
1459
+ groupId?: string;
1460
+ /**
1461
+ *
1462
+ * @type {string}
1463
+ * @memberof ReportTaskResponseAllOfGroupsSharedWith
1464
+ */
1465
+ name?: string;
1220
1466
  }
1221
1467
  /**
1222
1468
  *
@@ -1311,7 +1557,23 @@ export interface Template {
1311
1557
  * @memberof Template
1312
1558
  */
1313
1559
  pageHeight: number;
1560
+ /**
1561
+ * Type of the template
1562
+ * @type {string}
1563
+ * @memberof Template
1564
+ */
1565
+ type?: TemplateTypeEnum;
1314
1566
  }
1567
+
1568
+ /**
1569
+ * @export
1570
+ * @enum {string}
1571
+ */
1572
+ export enum TemplateTypeEnum {
1573
+ PixelPerfect = 'pixel-perfect',
1574
+ Excel = 'excel'
1575
+ }
1576
+
1315
1577
  /**
1316
1578
  *
1317
1579
  * @export
@@ -1380,24 +1642,68 @@ export interface Visualization {
1380
1642
  variables?: Array<ReportTaskVariables>;
1381
1643
  }
1382
1644
 
1383
- /**
1384
- * BaseTemplatesApi - axios parameter creator
1385
- * @export
1386
- */
1387
- export const BaseTemplatesApiAxiosParamCreator = function (configuration?: Configuration) {
1388
- return {
1645
+ /**
1646
+ * BaseTemplatesApi - axios parameter creator
1647
+ * @export
1648
+ */
1649
+ export const BaseTemplatesApiAxiosParamCreator = function (configuration?: Configuration) {
1650
+ return {
1651
+ /**
1652
+ * Duplicate a base template by its ID
1653
+ * @summary Duplicate a base template
1654
+ * @param {string} id
1655
+ * @param {*} [options] Override http request option.
1656
+ * @throws {RequiredError}
1657
+ */
1658
+ duplicateBaseTemplate: async (id: string, options: any = {}): Promise<RequestArgs> => {
1659
+ // verify required parameter 'id' is not null or undefined
1660
+ assertParamExists('duplicateBaseTemplate', 'id', id)
1661
+ const localVarPath = `/base-templates/{Id}/duplicate`
1662
+ .replace(`{${"Id"}}`, encodeURIComponent(String(id)));
1663
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1664
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1665
+ let baseOptions;
1666
+ if (configuration) {
1667
+ baseOptions = configuration.baseOptions;
1668
+ }
1669
+
1670
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
1671
+ const localVarHeaderParameter = {} as any;
1672
+ const localVarQueryParameter = {} as any;
1673
+
1674
+ // authentication ApiKeyAuth required
1675
+ await setApiKeyToObject(localVarHeaderParameter, "X-API-KEY", configuration)
1676
+
1677
+ // authentication BearerAuth required
1678
+ // http bearer authentication required
1679
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
1680
+
1681
+ // authentication CookieAuth required
1682
+
1683
+
1684
+
1685
+ setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);
1686
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1687
+ let formHeaders = {};
1688
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...formHeaders, ...options.headers};
1689
+
1690
+ return {
1691
+ url: toPathString(localVarUrlObj),
1692
+ options: localVarRequestOptions,
1693
+ };
1694
+ },
1389
1695
  /**
1390
- * Duplicate a base template by its ID
1391
- * @summary Duplicate a base template
1696
+ *
1697
+ * @summary Get base template thumbnail
1392
1698
  * @param {string} id
1393
1699
  * @param {*} [options] Override http request option.
1394
1700
  * @throws {RequiredError}
1395
1701
  */
1396
- duplicateBaseTemplate: async (id: string, options: any = {}): Promise<RequestArgs> => {
1702
+ getBaseTemplateThumbnail: async (id: string, options: any = {}): Promise<RequestArgs> => {
1397
1703
  // verify required parameter 'id' is not null or undefined
1398
- assertParamExists('duplicateBaseTemplate', 'id', id)
1399
- const localVarPath = `/base-templates/{Id}/duplicate`
1400
- .replace(`{${"Id"}}`, encodeURIComponent(String(id)));
1704
+ assertParamExists('getBaseTemplateThumbnail', 'id', id)
1705
+ const localVarPath = `/base-templates/{id}/thumbnail`
1706
+ .replace(`{${"id"}}`, encodeURIComponent(String(id)));
1401
1707
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
1402
1708
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1403
1709
  let baseOptions;
@@ -1501,6 +1807,17 @@ export const BaseTemplatesApiFp = function(configuration?: Configuration) {
1501
1807
  const localVarAxiosArgs = await localVarAxiosParamCreator.duplicateBaseTemplate(id, options);
1502
1808
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
1503
1809
  },
1810
+ /**
1811
+ *
1812
+ * @summary Get base template thumbnail
1813
+ * @param {string} id
1814
+ * @param {*} [options] Override http request option.
1815
+ * @throws {RequiredError}
1816
+ */
1817
+ async getBaseTemplateThumbnail(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>> {
1818
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getBaseTemplateThumbnail(id, options);
1819
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
1820
+ },
1504
1821
  /**
1505
1822
  *
1506
1823
  * @summary List base templates
@@ -1533,6 +1850,16 @@ export const BaseTemplatesApiFactory = function (configuration?: Configuration,
1533
1850
  duplicateBaseTemplate(id: string, options?: any): AxiosPromise<Template> {
1534
1851
  return localVarFp.duplicateBaseTemplate(id, options).then((request) => request(axios, basePath));
1535
1852
  },
1853
+ /**
1854
+ *
1855
+ * @summary Get base template thumbnail
1856
+ * @param {string} id
1857
+ * @param {*} [options] Override http request option.
1858
+ * @throws {RequiredError}
1859
+ */
1860
+ getBaseTemplateThumbnail(id: string, options?: any): AxiosPromise<any> {
1861
+ return localVarFp.getBaseTemplateThumbnail(id, options).then((request) => request(axios, basePath));
1862
+ },
1536
1863
  /**
1537
1864
  *
1538
1865
  * @summary List base templates
@@ -1566,6 +1893,18 @@ export class BaseTemplatesApi extends BaseAPI {
1566
1893
  return BaseTemplatesApiFp(this.configuration).duplicateBaseTemplate(id, options).then((request) => request(this.axios, this.basePath));
1567
1894
  }
1568
1895
 
1896
+ /**
1897
+ *
1898
+ * @summary Get base template thumbnail
1899
+ * @param {string} id
1900
+ * @param {*} [options] Override http request option.
1901
+ * @throws {RequiredError}
1902
+ * @memberof BaseTemplatesApi
1903
+ */
1904
+ public getBaseTemplateThumbnail(id: string, options?: any) {
1905
+ return BaseTemplatesApiFp(this.configuration).getBaseTemplateThumbnail(id, options).then((request) => request(this.axios, this.basePath));
1906
+ }
1907
+
1569
1908
  /**
1570
1909
  *
1571
1910
  * @summary List base templates
@@ -1590,19 +1929,19 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
1590
1929
  /**
1591
1930
  *
1592
1931
  * @summary Retrieve a generated document
1593
- * @param {string} fileName
1932
+ * @param {string} id
1594
1933
  * @param {'pdf' | 'pptx' | 'xlsx' | 'csv'} fileType
1595
1934
  * @param {string} [attachmentName] A document file title. This value is reflected back to the client in the fileName header.
1596
1935
  * @param {*} [options] Override http request option.
1597
1936
  * @throws {RequiredError}
1598
1937
  */
1599
- getDocument: async (fileName: string, fileType: 'pdf' | 'pptx' | 'xlsx' | 'csv', attachmentName?: string, options: any = {}): Promise<RequestArgs> => {
1600
- // verify required parameter 'fileName' is not null or undefined
1601
- assertParamExists('getDocument', 'fileName', fileName)
1938
+ getDocument: async (id: string, fileType: 'pdf' | 'pptx' | 'xlsx' | 'csv', attachmentName?: string, options: any = {}): Promise<RequestArgs> => {
1939
+ // verify required parameter 'id' is not null or undefined
1940
+ assertParamExists('getDocument', 'id', id)
1602
1941
  // verify required parameter 'fileType' is not null or undefined
1603
1942
  assertParamExists('getDocument', 'fileType', fileType)
1604
- const localVarPath = `/documents/{fileType}/{fileName}`
1605
- .replace(`{${"fileName"}}`, encodeURIComponent(String(fileName)))
1943
+ const localVarPath = `/documents/{fileType}/{id}`
1944
+ .replace(`{${"id"}}`, encodeURIComponent(String(id)))
1606
1945
  .replace(`{${"fileType"}}`, encodeURIComponent(String(fileType)));
1607
1946
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
1608
1947
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -1630,6 +1969,55 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
1630
1969
 
1631
1970
 
1632
1971
 
1972
+ setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);
1973
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1974
+ let formHeaders = {};
1975
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...formHeaders, ...options.headers};
1976
+
1977
+ return {
1978
+ url: toPathString(localVarUrlObj),
1979
+ options: localVarRequestOptions,
1980
+ };
1981
+ },
1982
+ /**
1983
+ *
1984
+ * @summary Retrieve a generated document
1985
+ * @param {string} id
1986
+ * @param {string} [attachmentName] A document file title. This value is reflected back to the client in the fileName header.
1987
+ * @param {*} [options] Override http request option.
1988
+ * @throws {RequiredError}
1989
+ */
1990
+ getDocumentById: async (id: string, attachmentName?: string, options: any = {}): Promise<RequestArgs> => {
1991
+ // verify required parameter 'id' is not null or undefined
1992
+ assertParamExists('getDocumentById', 'id', id)
1993
+ const localVarPath = `/documents/{id}`
1994
+ .replace(`{${"id"}}`, encodeURIComponent(String(id)));
1995
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1996
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1997
+ let baseOptions;
1998
+ if (configuration) {
1999
+ baseOptions = configuration.baseOptions;
2000
+ }
2001
+
2002
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
2003
+ const localVarHeaderParameter = {} as any;
2004
+ const localVarQueryParameter = {} as any;
2005
+
2006
+ // authentication ApiKeyAuth required
2007
+ await setApiKeyToObject(localVarHeaderParameter, "X-API-KEY", configuration)
2008
+
2009
+ // authentication BearerAuth required
2010
+ // http bearer authentication required
2011
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
2012
+
2013
+ // authentication CookieAuth required
2014
+
2015
+ if (attachmentName !== undefined) {
2016
+ localVarQueryParameter['attachmentName'] = attachmentName;
2017
+ }
2018
+
2019
+
2020
+
1633
2021
  setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);
1634
2022
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1635
2023
  let formHeaders = {};
@@ -1653,14 +2041,26 @@ export const DocumentsApiFp = function(configuration?: Configuration) {
1653
2041
  /**
1654
2042
  *
1655
2043
  * @summary Retrieve a generated document
1656
- * @param {string} fileName
2044
+ * @param {string} id
1657
2045
  * @param {'pdf' | 'pptx' | 'xlsx' | 'csv'} fileType
1658
2046
  * @param {string} [attachmentName] A document file title. This value is reflected back to the client in the fileName header.
1659
2047
  * @param {*} [options] Override http request option.
1660
2048
  * @throws {RequiredError}
1661
2049
  */
1662
- async getDocument(fileName: string, fileType: 'pdf' | 'pptx' | 'xlsx' | 'csv', attachmentName?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>> {
1663
- const localVarAxiosArgs = await localVarAxiosParamCreator.getDocument(fileName, fileType, attachmentName, options);
2050
+ async getDocument(id: string, fileType: 'pdf' | 'pptx' | 'xlsx' | 'csv', attachmentName?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>> {
2051
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getDocument(id, fileType, attachmentName, options);
2052
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
2053
+ },
2054
+ /**
2055
+ *
2056
+ * @summary Retrieve a generated document
2057
+ * @param {string} id
2058
+ * @param {string} [attachmentName] A document file title. This value is reflected back to the client in the fileName header.
2059
+ * @param {*} [options] Override http request option.
2060
+ * @throws {RequiredError}
2061
+ */
2062
+ async getDocumentById(id: string, attachmentName?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>> {
2063
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getDocumentById(id, attachmentName, options);
1664
2064
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
1665
2065
  },
1666
2066
  }
@@ -1676,14 +2076,25 @@ export const DocumentsApiFactory = function (configuration?: Configuration, base
1676
2076
  /**
1677
2077
  *
1678
2078
  * @summary Retrieve a generated document
1679
- * @param {string} fileName
2079
+ * @param {string} id
1680
2080
  * @param {'pdf' | 'pptx' | 'xlsx' | 'csv'} fileType
1681
2081
  * @param {string} [attachmentName] A document file title. This value is reflected back to the client in the fileName header.
1682
2082
  * @param {*} [options] Override http request option.
1683
2083
  * @throws {RequiredError}
1684
2084
  */
1685
- getDocument(fileName: string, fileType: 'pdf' | 'pptx' | 'xlsx' | 'csv', attachmentName?: string, options?: any): AxiosPromise<any> {
1686
- return localVarFp.getDocument(fileName, fileType, attachmentName, options).then((request) => request(axios, basePath));
2085
+ getDocument(id: string, fileType: 'pdf' | 'pptx' | 'xlsx' | 'csv', attachmentName?: string, options?: any): AxiosPromise<any> {
2086
+ return localVarFp.getDocument(id, fileType, attachmentName, options).then((request) => request(axios, basePath));
2087
+ },
2088
+ /**
2089
+ *
2090
+ * @summary Retrieve a generated document
2091
+ * @param {string} id
2092
+ * @param {string} [attachmentName] A document file title. This value is reflected back to the client in the fileName header.
2093
+ * @param {*} [options] Override http request option.
2094
+ * @throws {RequiredError}
2095
+ */
2096
+ getDocumentById(id: string, attachmentName?: string, options?: any): AxiosPromise<any> {
2097
+ return localVarFp.getDocumentById(id, attachmentName, options).then((request) => request(axios, basePath));
1687
2098
  },
1688
2099
  };
1689
2100
  };
@@ -1698,15 +2109,28 @@ export class DocumentsApi extends BaseAPI {
1698
2109
  /**
1699
2110
  *
1700
2111
  * @summary Retrieve a generated document
1701
- * @param {string} fileName
2112
+ * @param {string} id
1702
2113
  * @param {'pdf' | 'pptx' | 'xlsx' | 'csv'} fileType
1703
2114
  * @param {string} [attachmentName] A document file title. This value is reflected back to the client in the fileName header.
1704
2115
  * @param {*} [options] Override http request option.
1705
2116
  * @throws {RequiredError}
1706
2117
  * @memberof DocumentsApi
1707
2118
  */
1708
- public getDocument(fileName: string, fileType: 'pdf' | 'pptx' | 'xlsx' | 'csv', attachmentName?: string, options?: any) {
1709
- return DocumentsApiFp(this.configuration).getDocument(fileName, fileType, attachmentName, options).then((request) => request(this.axios, this.basePath));
2119
+ public getDocument(id: string, fileType: 'pdf' | 'pptx' | 'xlsx' | 'csv', attachmentName?: string, options?: any) {
2120
+ return DocumentsApiFp(this.configuration).getDocument(id, fileType, attachmentName, options).then((request) => request(this.axios, this.basePath));
2121
+ }
2122
+
2123
+ /**
2124
+ *
2125
+ * @summary Retrieve a generated document
2126
+ * @param {string} id
2127
+ * @param {string} [attachmentName] A document file title. This value is reflected back to the client in the fileName header.
2128
+ * @param {*} [options] Override http request option.
2129
+ * @throws {RequiredError}
2130
+ * @memberof DocumentsApi
2131
+ */
2132
+ public getDocumentById(id: string, attachmentName?: string, options?: any) {
2133
+ return DocumentsApiFp(this.configuration).getDocumentById(id, attachmentName, options).then((request) => request(this.axios, this.basePath));
1710
2134
  }
1711
2135
  }
1712
2136
 
@@ -2311,15 +2735,15 @@ export const ImagesApiAxiosParamCreator = function (configuration?: Configuratio
2311
2735
  /**
2312
2736
  *
2313
2737
  * @summary Retrieves a user uploaded image for use in a template
2314
- * @param {string} title
2738
+ * @param {string} id
2315
2739
  * @param {*} [options] Override http request option.
2316
2740
  * @throws {RequiredError}
2317
2741
  */
2318
- getImage: async (title: string, options: any = {}): Promise<RequestArgs> => {
2319
- // verify required parameter 'title' is not null or undefined
2320
- assertParamExists('getImage', 'title', title)
2321
- const localVarPath = `/images/{title}`
2322
- .replace(`{${"title"}}`, encodeURIComponent(String(title)));
2742
+ getImage: async (id: string, options: any = {}): Promise<RequestArgs> => {
2743
+ // verify required parameter 'id' is not null or undefined
2744
+ assertParamExists('getImage', 'id', id)
2745
+ const localVarPath = `/images/{id}`
2746
+ .replace(`{${"id"}}`, encodeURIComponent(String(id)));
2323
2747
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
2324
2748
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
2325
2749
  let baseOptions;
@@ -2417,12 +2841,12 @@ export const ImagesApiFp = function(configuration?: Configuration) {
2417
2841
  /**
2418
2842
  *
2419
2843
  * @summary Retrieves a user uploaded image for use in a template
2420
- * @param {string} title
2844
+ * @param {string} id
2421
2845
  * @param {*} [options] Override http request option.
2422
2846
  * @throws {RequiredError}
2423
2847
  */
2424
- async getImage(title: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>> {
2425
- const localVarAxiosArgs = await localVarAxiosParamCreator.getImage(title, options);
2848
+ async getImage(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>> {
2849
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getImage(id, options);
2426
2850
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
2427
2851
  },
2428
2852
  /**
@@ -2432,7 +2856,7 @@ export const ImagesApiFp = function(configuration?: Configuration) {
2432
2856
  * @param {*} [options] Override http request option.
2433
2857
  * @throws {RequiredError}
2434
2858
  */
2435
- async uploadImage(image?: any, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2001>> {
2859
+ async uploadImage(image?: any, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2004>> {
2436
2860
  const localVarAxiosArgs = await localVarAxiosParamCreator.uploadImage(image, options);
2437
2861
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
2438
2862
  },
@@ -2449,12 +2873,12 @@ export const ImagesApiFactory = function (configuration?: Configuration, basePat
2449
2873
  /**
2450
2874
  *
2451
2875
  * @summary Retrieves a user uploaded image for use in a template
2452
- * @param {string} title
2876
+ * @param {string} id
2453
2877
  * @param {*} [options] Override http request option.
2454
2878
  * @throws {RequiredError}
2455
2879
  */
2456
- getImage(title: string, options?: any): AxiosPromise<any> {
2457
- return localVarFp.getImage(title, options).then((request) => request(axios, basePath));
2880
+ getImage(id: string, options?: any): AxiosPromise<any> {
2881
+ return localVarFp.getImage(id, options).then((request) => request(axios, basePath));
2458
2882
  },
2459
2883
  /**
2460
2884
  * Uploads an image to the server for use in templates
@@ -2463,7 +2887,7 @@ export const ImagesApiFactory = function (configuration?: Configuration, basePat
2463
2887
  * @param {*} [options] Override http request option.
2464
2888
  * @throws {RequiredError}
2465
2889
  */
2466
- uploadImage(image?: any, options?: any): AxiosPromise<InlineResponse2001> {
2890
+ uploadImage(image?: any, options?: any): AxiosPromise<InlineResponse2004> {
2467
2891
  return localVarFp.uploadImage(image, options).then((request) => request(axios, basePath));
2468
2892
  },
2469
2893
  };
@@ -2479,13 +2903,13 @@ export class ImagesApi extends BaseAPI {
2479
2903
  /**
2480
2904
  *
2481
2905
  * @summary Retrieves a user uploaded image for use in a template
2482
- * @param {string} title
2906
+ * @param {string} id
2483
2907
  * @param {*} [options] Override http request option.
2484
2908
  * @throws {RequiredError}
2485
2909
  * @memberof ImagesApi
2486
2910
  */
2487
- public getImage(title: string, options?: any) {
2488
- return ImagesApiFp(this.configuration).getImage(title, options).then((request) => request(this.axios, this.basePath));
2911
+ public getImage(id: string, options?: any) {
2912
+ return ImagesApiFp(this.configuration).getImage(id, options).then((request) => request(this.axios, this.basePath));
2489
2913
  }
2490
2914
 
2491
2915
  /**
@@ -2769,13 +3193,13 @@ export const ReportTasksApiAxiosParamCreator = function (configuration?: Configu
2769
3193
  * @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.
2770
3194
  * @param {string} [templateId]
2771
3195
  * @param {number} [perPage]
2772
- * @param {'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId'} [orderBy]
3196
+ * @param {'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId' | 'report.createdAt'} [orderBy]
2773
3197
  * @param {'asc' | 'desc'} [order] The order to retrieve the logs in
2774
3198
  * @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;
2775
3199
  * @param {*} [options] Override http request option.
2776
3200
  * @throws {RequiredError}
2777
3201
  */
2778
- getReportTasks: async (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', order?: 'asc' | 'desc', filter?: object, options: any = {}): Promise<RequestArgs> => {
3202
+ getReportTasks: async (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<RequestArgs> => {
2779
3203
  const localVarPath = `/report-tasks`;
2780
3204
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
2781
3205
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -2982,13 +3406,13 @@ export const ReportTasksApiFp = function(configuration?: Configuration) {
2982
3406
  * @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.
2983
3407
  * @param {string} [templateId]
2984
3408
  * @param {number} [perPage]
2985
- * @param {'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId'} [orderBy]
3409
+ * @param {'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId' | 'report.createdAt'} [orderBy]
2986
3410
  * @param {'asc' | 'desc'} [order] The order to retrieve the logs in
2987
3411
  * @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;
2988
3412
  * @param {*} [options] Override http request option.
2989
3413
  * @throws {RequiredError}
2990
3414
  */
2991
- 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', order?: 'asc' | 'desc', filter?: object, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2002>> {
3415
+ 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>> {
2992
3416
  const localVarAxiosArgs = await localVarAxiosParamCreator.getReportTasks(pageNum, meta, templateId, perPage, orderBy, order, filter, options);
2993
3417
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
2994
3418
  },
@@ -3063,13 +3487,13 @@ export const ReportTasksApiFactory = function (configuration?: Configuration, ba
3063
3487
  * @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.
3064
3488
  * @param {string} [templateId]
3065
3489
  * @param {number} [perPage]
3066
- * @param {'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId'} [orderBy]
3490
+ * @param {'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId' | 'report.createdAt'} [orderBy]
3067
3491
  * @param {'asc' | 'desc'} [order] The order to retrieve the logs in
3068
3492
  * @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;
3069
3493
  * @param {*} [options] Override http request option.
3070
3494
  * @throws {RequiredError}
3071
3495
  */
3072
- 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', order?: 'asc' | 'desc', filter?: object, options?: any): AxiosPromise<InlineResponse2002> {
3496
+ 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> {
3073
3497
  return localVarFp.getReportTasks(pageNum, meta, templateId, perPage, orderBy, order, filter, options).then((request) => request(axios, basePath));
3074
3498
  },
3075
3499
  /**
@@ -3147,14 +3571,14 @@ export class ReportTasksApi extends BaseAPI {
3147
3571
  * @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.
3148
3572
  * @param {string} [templateId]
3149
3573
  * @param {number} [perPage]
3150
- * @param {'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId'} [orderBy]
3574
+ * @param {'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId' | 'report.createdAt'} [orderBy]
3151
3575
  * @param {'asc' | 'desc'} [order] The order to retrieve the logs in
3152
3576
  * @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;
3153
3577
  * @param {*} [options] Override http request option.
3154
3578
  * @throws {RequiredError}
3155
3579
  * @memberof ReportTasksApi
3156
3580
  */
3157
- public 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', order?: 'asc' | 'desc', filter?: object, options?: any) {
3581
+ public 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) {
3158
3582
  return ReportTasksApiFp(this.configuration).getReportTasks(pageNum, meta, templateId, perPage, orderBy, order, filter, options).then((request) => request(this.axios, this.basePath));
3159
3583
  }
3160
3584
 
@@ -3269,6 +3693,50 @@ export const ReportsApiAxiosParamCreator = function (configuration?: Configurati
3269
3693
 
3270
3694
 
3271
3695
 
3696
+ setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);
3697
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
3698
+ let formHeaders = {};
3699
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...formHeaders, ...options.headers};
3700
+
3701
+ return {
3702
+ url: toPathString(localVarUrlObj),
3703
+ options: localVarRequestOptions,
3704
+ };
3705
+ },
3706
+ /**
3707
+ *
3708
+ * @summary Get report thumbnail
3709
+ * @param {string} id
3710
+ * @param {*} [options] Override http request option.
3711
+ * @throws {RequiredError}
3712
+ */
3713
+ getReportThumbnail: async (id: string, options: any = {}): Promise<RequestArgs> => {
3714
+ // verify required parameter 'id' is not null or undefined
3715
+ assertParamExists('getReportThumbnail', 'id', id)
3716
+ const localVarPath = `/reports/{id}/thumbnail`
3717
+ .replace(`{${"id"}}`, encodeURIComponent(String(id)));
3718
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
3719
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
3720
+ let baseOptions;
3721
+ if (configuration) {
3722
+ baseOptions = configuration.baseOptions;
3723
+ }
3724
+
3725
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
3726
+ const localVarHeaderParameter = {} as any;
3727
+ const localVarQueryParameter = {} as any;
3728
+
3729
+ // authentication ApiKeyAuth required
3730
+ await setApiKeyToObject(localVarHeaderParameter, "X-API-KEY", configuration)
3731
+
3732
+ // authentication BearerAuth required
3733
+ // http bearer authentication required
3734
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
3735
+
3736
+ // authentication CookieAuth required
3737
+
3738
+
3739
+
3272
3740
  setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);
3273
3741
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
3274
3742
  let formHeaders = {};
@@ -3432,6 +3900,17 @@ export const ReportsApiFp = function(configuration?: Configuration) {
3432
3900
  const localVarAxiosArgs = await localVarAxiosParamCreator.getReport(id, options);
3433
3901
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
3434
3902
  },
3903
+ /**
3904
+ *
3905
+ * @summary Get report thumbnail
3906
+ * @param {string} id
3907
+ * @param {*} [options] Override http request option.
3908
+ * @throws {RequiredError}
3909
+ */
3910
+ async getReportThumbnail(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>> {
3911
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getReportThumbnail(id, options);
3912
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
3913
+ },
3435
3914
  /**
3436
3915
  *
3437
3916
  * @summary List reports
@@ -3444,7 +3923,7 @@ export const ReportsApiFp = function(configuration?: Configuration) {
3444
3923
  * @param {*} [options] Override http request option.
3445
3924
  * @throws {RequiredError}
3446
3925
  */
3447
- async getReports(pageNum?: number, perPage?: number, orderBy?: 'title' | 'createdAt', order?: 'asc' | 'desc', tagId?: string, reportTaskId?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2003>> {
3926
+ 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>> {
3448
3927
  const localVarAxiosArgs = await localVarAxiosParamCreator.getReports(pageNum, perPage, orderBy, order, tagId, reportTaskId, options);
3449
3928
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
3450
3929
  },
@@ -3490,6 +3969,16 @@ export const ReportsApiFactory = function (configuration?: Configuration, basePa
3490
3969
  getReport(id: string, options?: any): AxiosPromise<Report> {
3491
3970
  return localVarFp.getReport(id, options).then((request) => request(axios, basePath));
3492
3971
  },
3972
+ /**
3973
+ *
3974
+ * @summary Get report thumbnail
3975
+ * @param {string} id
3976
+ * @param {*} [options] Override http request option.
3977
+ * @throws {RequiredError}
3978
+ */
3979
+ getReportThumbnail(id: string, options?: any): AxiosPromise<any> {
3980
+ return localVarFp.getReportThumbnail(id, options).then((request) => request(axios, basePath));
3981
+ },
3493
3982
  /**
3494
3983
  *
3495
3984
  * @summary List reports
@@ -3502,7 +3991,7 @@ export const ReportsApiFactory = function (configuration?: Configuration, basePa
3502
3991
  * @param {*} [options] Override http request option.
3503
3992
  * @throws {RequiredError}
3504
3993
  */
3505
- getReports(pageNum?: number, perPage?: number, orderBy?: 'title' | 'createdAt', order?: 'asc' | 'desc', tagId?: string, reportTaskId?: string, options?: any): AxiosPromise<InlineResponse2003> {
3994
+ getReports(pageNum?: number, perPage?: number, orderBy?: 'title' | 'createdAt', order?: 'asc' | 'desc', tagId?: string, reportTaskId?: string, options?: any): AxiosPromise<InlineResponse2002> {
3506
3995
  return localVarFp.getReports(pageNum, perPage, orderBy, order, tagId, reportTaskId, options).then((request) => request(axios, basePath));
3507
3996
  },
3508
3997
  /**
@@ -3550,6 +4039,18 @@ export class ReportsApi extends BaseAPI {
3550
4039
  return ReportsApiFp(this.configuration).getReport(id, options).then((request) => request(this.axios, this.basePath));
3551
4040
  }
3552
4041
 
4042
+ /**
4043
+ *
4044
+ * @summary Get report thumbnail
4045
+ * @param {string} id
4046
+ * @param {*} [options] Override http request option.
4047
+ * @throws {RequiredError}
4048
+ * @memberof ReportsApi
4049
+ */
4050
+ public getReportThumbnail(id: string, options?: any) {
4051
+ return ReportsApiFp(this.configuration).getReportThumbnail(id, options).then((request) => request(this.axios, this.basePath));
4052
+ }
4053
+
3553
4054
  /**
3554
4055
  *
3555
4056
  * @summary List reports
@@ -3800,6 +4301,50 @@ export const TemplatesApiAxiosParamCreator = function (configuration?: Configura
3800
4301
 
3801
4302
 
3802
4303
 
4304
+ setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);
4305
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
4306
+ let formHeaders = {};
4307
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...formHeaders, ...options.headers};
4308
+
4309
+ return {
4310
+ url: toPathString(localVarUrlObj),
4311
+ options: localVarRequestOptions,
4312
+ };
4313
+ },
4314
+ /**
4315
+ *
4316
+ * @summary Get template thumbnail
4317
+ * @param {string} id
4318
+ * @param {*} [options] Override http request option.
4319
+ * @throws {RequiredError}
4320
+ */
4321
+ getTemplateThumbnail: async (id: string, options: any = {}): Promise<RequestArgs> => {
4322
+ // verify required parameter 'id' is not null or undefined
4323
+ assertParamExists('getTemplateThumbnail', 'id', id)
4324
+ const localVarPath = `/templates/{id}/thumbnail`
4325
+ .replace(`{${"id"}}`, encodeURIComponent(String(id)));
4326
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
4327
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
4328
+ let baseOptions;
4329
+ if (configuration) {
4330
+ baseOptions = configuration.baseOptions;
4331
+ }
4332
+
4333
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
4334
+ const localVarHeaderParameter = {} as any;
4335
+ const localVarQueryParameter = {} as any;
4336
+
4337
+ // authentication ApiKeyAuth required
4338
+ await setApiKeyToObject(localVarHeaderParameter, "X-API-KEY", configuration)
4339
+
4340
+ // authentication BearerAuth required
4341
+ // http bearer authentication required
4342
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
4343
+
4344
+ // authentication CookieAuth required
4345
+
4346
+
4347
+
3803
4348
  setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);
3804
4349
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
3805
4350
  let formHeaders = {};
@@ -4073,6 +4618,17 @@ export const TemplatesApiFp = function(configuration?: Configuration) {
4073
4618
  const localVarAxiosArgs = await localVarAxiosParamCreator.getTemplate(id, options);
4074
4619
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
4075
4620
  },
4621
+ /**
4622
+ *
4623
+ * @summary Get template thumbnail
4624
+ * @param {string} id
4625
+ * @param {*} [options] Override http request option.
4626
+ * @throws {RequiredError}
4627
+ */
4628
+ async getTemplateThumbnail(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>> {
4629
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getTemplateThumbnail(id, options);
4630
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
4631
+ },
4076
4632
  /**
4077
4633
  *
4078
4634
  * @summary List report templates
@@ -4080,7 +4636,7 @@ export const TemplatesApiFp = function(configuration?: Configuration) {
4080
4636
  * @param {*} [options] Override http request option.
4081
4637
  * @throws {RequiredError}
4082
4638
  */
4083
- async getTemplates(pageNum?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2004>> {
4639
+ async getTemplates(pageNum?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2003>> {
4084
4640
  const localVarAxiosArgs = await localVarAxiosParamCreator.getTemplates(pageNum, options);
4085
4641
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
4086
4642
  },
@@ -4179,6 +4735,16 @@ export const TemplatesApiFactory = function (configuration?: Configuration, base
4179
4735
  getTemplate(id: string, options?: any): AxiosPromise<Template> {
4180
4736
  return localVarFp.getTemplate(id, options).then((request) => request(axios, basePath));
4181
4737
  },
4738
+ /**
4739
+ *
4740
+ * @summary Get template thumbnail
4741
+ * @param {string} id
4742
+ * @param {*} [options] Override http request option.
4743
+ * @throws {RequiredError}
4744
+ */
4745
+ getTemplateThumbnail(id: string, options?: any): AxiosPromise<any> {
4746
+ return localVarFp.getTemplateThumbnail(id, options).then((request) => request(axios, basePath));
4747
+ },
4182
4748
  /**
4183
4749
  *
4184
4750
  * @summary List report templates
@@ -4186,7 +4752,7 @@ export const TemplatesApiFactory = function (configuration?: Configuration, base
4186
4752
  * @param {*} [options] Override http request option.
4187
4753
  * @throws {RequiredError}
4188
4754
  */
4189
- getTemplates(pageNum?: number, options?: any): AxiosPromise<InlineResponse2004> {
4755
+ getTemplates(pageNum?: number, options?: any): AxiosPromise<InlineResponse2003> {
4190
4756
  return localVarFp.getTemplates(pageNum, options).then((request) => request(axios, basePath));
4191
4757
  },
4192
4758
  /**
@@ -4291,6 +4857,18 @@ export class TemplatesApi extends BaseAPI {
4291
4857
  return TemplatesApiFp(this.configuration).getTemplate(id, options).then((request) => request(this.axios, this.basePath));
4292
4858
  }
4293
4859
 
4860
+ /**
4861
+ *
4862
+ * @summary Get template thumbnail
4863
+ * @param {string} id
4864
+ * @param {*} [options] Override http request option.
4865
+ * @throws {RequiredError}
4866
+ * @memberof TemplatesApi
4867
+ */
4868
+ public getTemplateThumbnail(id: string, options?: any) {
4869
+ return TemplatesApiFp(this.configuration).getTemplateThumbnail(id, options).then((request) => request(this.axios, this.basePath));
4870
+ }
4871
+
4294
4872
  /**
4295
4873
  *
4296
4874
  * @summary List report templates