@connectreport/connectreport-js 2.80.3 → 2.81.0-beta.1

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 +220 -22
  4. package/base.ts +2 -2
  5. package/common.ts +1 -1
  6. package/configuration.ts +1 -1
  7. package/dist/index.cjs +12 -5
  8. package/dist/index.cjs.map +1 -1
  9. package/dist/index.d.cts +220 -24
  10. package/dist/index.d.ts +220 -24
  11. package/dist/index.js +11 -5
  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.3
8
+ * The version of the OpenAPI document: 2.80.0
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.3
94
+ * The version of the OpenAPI document: 2.80.0
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}
@@ -729,11 +729,11 @@ interface ReportTask {
729
729
  */
730
730
  nextRunAt?: string;
731
731
  /**
732
- * The error object from the last report task execution, if applicable
733
- * @type {string}
732
+ *
733
+ * @type {Array<ReportTaskErrors>}
734
734
  * @memberof ReportTask
735
735
  */
736
- error?: string;
736
+ errors?: Array<ReportTaskErrors>;
737
737
  /**
738
738
  * The average time to run the report task, in minutes
739
739
  * @type {number}
@@ -851,6 +851,31 @@ interface ReportTaskCustomSelection {
851
851
  */
852
852
  fieldValues?: Array<ReportTaskFieldValues>;
853
853
  }
854
+ /**
855
+ *
856
+ * @export
857
+ * @interface ReportTaskErrors
858
+ */
859
+ interface ReportTaskErrors {
860
+ /**
861
+ *
862
+ * @type {string}
863
+ * @memberof ReportTaskErrors
864
+ */
865
+ err: string;
866
+ /**
867
+ *
868
+ * @type {string}
869
+ * @memberof ReportTaskErrors
870
+ */
871
+ culpritGuid?: string;
872
+ /**
873
+ *
874
+ * @type {string}
875
+ * @memberof ReportTaskErrors
876
+ */
877
+ page?: string;
878
+ }
854
879
  /**
855
880
  *
856
881
  * @export
@@ -975,11 +1000,11 @@ interface ReportTaskRequest {
975
1000
  */
976
1001
  nextRunAt?: string;
977
1002
  /**
978
- * The error object from the last report task execution, if applicable
979
- * @type {string}
1003
+ *
1004
+ * @type {Array<ReportTaskErrors>}
980
1005
  * @memberof ReportTaskRequest
981
1006
  */
982
- error?: string;
1007
+ errors?: Array<ReportTaskErrors>;
983
1008
  /**
984
1009
  * The average time to run the report task, in minutes
985
1010
  * @type {number}
@@ -1114,6 +1139,12 @@ interface ReportTaskRequestAllOf {
1114
1139
  * @memberof ReportTaskRequestAllOf
1115
1140
  */
1116
1141
  usersToShareWith?: Array<ReportTaskRequestAllOfUsersToShareWith>;
1142
+ /**
1143
+ * Groups to share the published report with. This field will be updated entirely if provided
1144
+ * @type {Array<ReportTaskGroupsToShareWith>}
1145
+ * @memberof ReportTaskRequestAllOf
1146
+ */
1147
+ groupsToShareWith?: Array<ReportTaskGroupsToShareWith>;
1117
1148
  }
1118
1149
  /**
1119
1150
  *
@@ -1139,7 +1170,7 @@ interface ReportTaskResponse {
1139
1170
  * @type {string}
1140
1171
  * @memberof ReportTaskResponse
1141
1172
  */
1142
- id?: string;
1173
+ id: string;
1143
1174
  /**
1144
1175
  * Title of the report task
1145
1176
  * @type {string}
@@ -1201,11 +1232,11 @@ interface ReportTaskResponse {
1201
1232
  */
1202
1233
  nextRunAt?: string;
1203
1234
  /**
1204
- * The error object from the last report task execution, if applicable
1205
- * @type {string}
1235
+ *
1236
+ * @type {Array<ReportTaskErrors>}
1206
1237
  * @memberof ReportTaskResponse
1207
1238
  */
1208
- error?: string;
1239
+ errors?: Array<ReportTaskErrors>;
1209
1240
  /**
1210
1241
  * The average time to run the report task, in minutes
1211
1242
  * @type {number}
@@ -1280,6 +1311,72 @@ interface ReportTaskResponse {
1280
1311
  * @memberof ReportTaskResponse
1281
1312
  */
1282
1313
  usersToShareWith?: Array<ReportTaskResponseAllOfUsersToShareWith>;
1314
+ /**
1315
+ * Datetime in UTC when the report task was created
1316
+ * @type {string}
1317
+ * @memberof ReportTaskResponse
1318
+ */
1319
+ createdAt?: string;
1320
+ /**
1321
+ * Datetime in UTC when the report task was last saved
1322
+ * @type {string}
1323
+ * @memberof ReportTaskResponse
1324
+ */
1325
+ lastSavedAt?: string;
1326
+ /**
1327
+ * Field value information
1328
+ * @type {string}
1329
+ * @memberof ReportTaskResponse
1330
+ */
1331
+ fieldValue?: string;
1332
+ /**
1333
+ * Field information
1334
+ * @type {string}
1335
+ * @memberof ReportTaskResponse
1336
+ */
1337
+ fieldInfo?: string;
1338
+ /**
1339
+ * Title of the filter cycle this report task belongs to
1340
+ * @type {string}
1341
+ * @memberof ReportTaskResponse
1342
+ */
1343
+ filterCycleTitle?: string;
1344
+ /**
1345
+ * Datetime in UTC when the report task last started execution
1346
+ * @type {string}
1347
+ * @memberof ReportTaskResponse
1348
+ */
1349
+ lastRunAt?: string;
1350
+ /**
1351
+ * Datetime in UTC when the report task last finished execution
1352
+ * @type {string}
1353
+ * @memberof ReportTaskResponse
1354
+ */
1355
+ lastFinishedAt?: string;
1356
+ /**
1357
+ * Datetime in UTC when the report task last failed
1358
+ * @type {string}
1359
+ * @memberof ReportTaskResponse
1360
+ */
1361
+ failedAt?: string;
1362
+ /**
1363
+ * Reason for the last failure, if applicable
1364
+ * @type {string}
1365
+ * @memberof ReportTaskResponse
1366
+ */
1367
+ failReason?: string;
1368
+ /**
1369
+ * Datetime in UTC when the report task was locked for execution
1370
+ * @type {string}
1371
+ * @memberof ReportTaskResponse
1372
+ */
1373
+ lockedAt?: string;
1374
+ /**
1375
+ * Groups this report is shared with (read-only view of groupsToShareWith)
1376
+ * @type {Array<ReportTaskResponseAllOfGroupsSharedWith>}
1377
+ * @memberof ReportTaskResponse
1378
+ */
1379
+ groupsSharedWith?: Array<ReportTaskResponseAllOfGroupsSharedWith>;
1283
1380
  }
1284
1381
  /**
1285
1382
  * @export
@@ -1316,6 +1413,91 @@ interface ReportTaskResponseAllOf {
1316
1413
  * @memberof ReportTaskResponseAllOf
1317
1414
  */
1318
1415
  usersToShareWith?: Array<ReportTaskResponseAllOfUsersToShareWith>;
1416
+ /**
1417
+ * Datetime in UTC when the report task was created
1418
+ * @type {string}
1419
+ * @memberof ReportTaskResponseAllOf
1420
+ */
1421
+ createdAt?: string;
1422
+ /**
1423
+ * Datetime in UTC when the report task was last saved
1424
+ * @type {string}
1425
+ * @memberof ReportTaskResponseAllOf
1426
+ */
1427
+ lastSavedAt?: string;
1428
+ /**
1429
+ * Field value information
1430
+ * @type {string}
1431
+ * @memberof ReportTaskResponseAllOf
1432
+ */
1433
+ fieldValue?: string;
1434
+ /**
1435
+ * Field information
1436
+ * @type {string}
1437
+ * @memberof ReportTaskResponseAllOf
1438
+ */
1439
+ fieldInfo?: string;
1440
+ /**
1441
+ * Title of the filter cycle this report task belongs to
1442
+ * @type {string}
1443
+ * @memberof ReportTaskResponseAllOf
1444
+ */
1445
+ filterCycleTitle?: string;
1446
+ /**
1447
+ * Datetime in UTC when the report task last started execution
1448
+ * @type {string}
1449
+ * @memberof ReportTaskResponseAllOf
1450
+ */
1451
+ lastRunAt?: string;
1452
+ /**
1453
+ * Datetime in UTC when the report task last finished execution
1454
+ * @type {string}
1455
+ * @memberof ReportTaskResponseAllOf
1456
+ */
1457
+ lastFinishedAt?: string;
1458
+ /**
1459
+ * Datetime in UTC when the report task last failed
1460
+ * @type {string}
1461
+ * @memberof ReportTaskResponseAllOf
1462
+ */
1463
+ failedAt?: string;
1464
+ /**
1465
+ * Reason for the last failure, if applicable
1466
+ * @type {string}
1467
+ * @memberof ReportTaskResponseAllOf
1468
+ */
1469
+ failReason?: string;
1470
+ /**
1471
+ * Datetime in UTC when the report task was locked for execution
1472
+ * @type {string}
1473
+ * @memberof ReportTaskResponseAllOf
1474
+ */
1475
+ lockedAt?: string;
1476
+ /**
1477
+ * Groups this report is shared with (read-only view of groupsToShareWith)
1478
+ * @type {Array<ReportTaskResponseAllOfGroupsSharedWith>}
1479
+ * @memberof ReportTaskResponseAllOf
1480
+ */
1481
+ groupsSharedWith?: Array<ReportTaskResponseAllOfGroupsSharedWith>;
1482
+ }
1483
+ /**
1484
+ *
1485
+ * @export
1486
+ * @interface ReportTaskResponseAllOfGroupsSharedWith
1487
+ */
1488
+ interface ReportTaskResponseAllOfGroupsSharedWith {
1489
+ /**
1490
+ *
1491
+ * @type {string}
1492
+ * @memberof ReportTaskResponseAllOfGroupsSharedWith
1493
+ */
1494
+ groupId?: string;
1495
+ /**
1496
+ *
1497
+ * @type {string}
1498
+ * @memberof ReportTaskResponseAllOfGroupsSharedWith
1499
+ */
1500
+ name?: string;
1319
1501
  }
1320
1502
  /**
1321
1503
  *
@@ -1410,6 +1592,20 @@ interface Template {
1410
1592
  * @memberof Template
1411
1593
  */
1412
1594
  pageHeight: number;
1595
+ /**
1596
+ * Type of the template
1597
+ * @type {string}
1598
+ * @memberof Template
1599
+ */
1600
+ type: TemplateTypeEnum;
1601
+ }
1602
+ /**
1603
+ * @export
1604
+ * @enum {string}
1605
+ */
1606
+ declare enum TemplateTypeEnum {
1607
+ PixelPerfect = "pixel-perfect",
1608
+ Excel = "excel"
1413
1609
  }
1414
1610
  /**
1415
1611
  *
@@ -2090,7 +2286,7 @@ declare const ReportTasksApiAxiosParamCreator: (configuration?: Configuration) =
2090
2286
  * @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
2287
  * @param {string} [templateId]
2092
2288
  * @param {number} [perPage]
2093
- * @param {'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId'} [orderBy]
2289
+ * @param {'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId' | 'report.createdAt'} [orderBy]
2094
2290
  * @param {'asc' | 'desc'} [order] The order to retrieve the logs in
2095
2291
  * @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
2292
  * @param {*} [options] Override http request option.
@@ -2098,7 +2294,7 @@ declare const ReportTasksApiAxiosParamCreator: (configuration?: Configuration) =
2098
2294
  */
2099
2295
  getReportTasks: (pageNum?: number, meta?: {
2100
2296
  [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>;
2297
+ }, 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
2298
  /**
2103
2299
  * Duplicates the task and runs it as \"Once - Now\"
2104
2300
  * @summary Run task now
@@ -2154,7 +2350,7 @@ declare const ReportTasksApiFp: (configuration?: Configuration) => {
2154
2350
  * @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
2351
  * @param {string} [templateId]
2156
2352
  * @param {number} [perPage]
2157
- * @param {'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId'} [orderBy]
2353
+ * @param {'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId' | 'report.createdAt'} [orderBy]
2158
2354
  * @param {'asc' | 'desc'} [order] The order to retrieve the logs in
2159
2355
  * @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
2356
  * @param {*} [options] Override http request option.
@@ -2162,7 +2358,7 @@ declare const ReportTasksApiFp: (configuration?: Configuration) => {
2162
2358
  */
2163
2359
  getReportTasks(pageNum?: number, meta?: {
2164
2360
  [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>>;
2361
+ }, 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<InlineResponse2002>>;
2166
2362
  /**
2167
2363
  * Duplicates the task and runs it as \"Once - Now\"
2168
2364
  * @summary Run task now
@@ -2218,7 +2414,7 @@ declare const ReportTasksApiFactory: (configuration?: Configuration, basePath?:
2218
2414
  * @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
2415
  * @param {string} [templateId]
2220
2416
  * @param {number} [perPage]
2221
- * @param {'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId'} [orderBy]
2417
+ * @param {'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId' | 'report.createdAt'} [orderBy]
2222
2418
  * @param {'asc' | 'desc'} [order] The order to retrieve the logs in
2223
2419
  * @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
2420
  * @param {*} [options] Override http request option.
@@ -2226,7 +2422,7 @@ declare const ReportTasksApiFactory: (configuration?: Configuration, basePath?:
2226
2422
  */
2227
2423
  getReportTasks(pageNum?: number, meta?: {
2228
2424
  [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>;
2425
+ }, 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<InlineResponse2002>;
2230
2426
  /**
2231
2427
  * Duplicates the task and runs it as \"Once - Now\"
2232
2428
  * @summary Run task now
@@ -2287,7 +2483,7 @@ declare class ReportTasksApi extends BaseAPI {
2287
2483
  * @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
2484
  * @param {string} [templateId]
2289
2485
  * @param {number} [perPage]
2290
- * @param {'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId'} [orderBy]
2486
+ * @param {'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId' | 'report.createdAt'} [orderBy]
2291
2487
  * @param {'asc' | 'desc'} [order] The order to retrieve the logs in
2292
2488
  * @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
2489
  * @param {*} [options] Override http request option.
@@ -2296,7 +2492,7 @@ declare class ReportTasksApi extends BaseAPI {
2296
2492
  */
2297
2493
  getReportTasks(pageNum?: number, meta?: {
2298
2494
  [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>>;
2495
+ }, 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<InlineResponse2002, any>>;
2300
2496
  /**
2301
2497
  * Duplicates the task and runs it as \"Once - Now\"
2302
2498
  * @summary Run task now
@@ -2908,4 +3104,4 @@ declare class ConnectReport {
2908
3104
  constructor(config: Pick<Configuration, "apiKey" | "basePath" | "formDataCtor" | "httpsAgent">);
2909
3105
  }
2910
3106
 
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 };
3107
+ 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, ReportsApi, ReportsApiAxiosParamCreator, ReportsApiFactory, ReportsApiFp, type Template, TemplateTypeEnum, TemplatesApi, TemplatesApiAxiosParamCreator, TemplatesApiFactory, TemplatesApiFp, type Visualization, VisualizationApi, VisualizationApiAxiosParamCreator, VisualizationApiFactory, VisualizationApiFp };
package/dist/index.js CHANGED
@@ -70,7 +70,7 @@ import globalAxios2 from "axios";
70
70
 
71
71
  // base.ts
72
72
  import globalAxios from "axios";
73
- var BASE_PATH = "https://connectreport.s3.us-east-2.amazonaws.com/api/v1".replace(/\/+$/, "");
73
+ var BASE_PATH = "http://localhost/api/v1".replace(/\/+$/, "");
74
74
  var BaseAPI = class {
75
75
  constructor(configuration, basePath = BASE_PATH, axios2 = globalAxios) {
76
76
  this.basePath = basePath;
@@ -208,6 +208,11 @@ var ReportTaskResponseEmailEnum = /* @__PURE__ */ ((ReportTaskResponseEmailEnum2
208
208
  ReportTaskResponseEmailEnum2["Csv"] = "csv";
209
209
  return ReportTaskResponseEmailEnum2;
210
210
  })(ReportTaskResponseEmailEnum || {});
211
+ var TemplateTypeEnum = /* @__PURE__ */ ((TemplateTypeEnum2) => {
212
+ TemplateTypeEnum2["PixelPerfect"] = "pixel-perfect";
213
+ TemplateTypeEnum2["Excel"] = "excel";
214
+ return TemplateTypeEnum2;
215
+ })(TemplateTypeEnum || {});
211
216
  var BaseTemplatesApiAxiosParamCreator = function(configuration) {
212
217
  return {
213
218
  /**
@@ -1224,7 +1229,7 @@ var ReportTasksApiAxiosParamCreator = function(configuration) {
1224
1229
  * @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.
1225
1230
  * @param {string} [templateId]
1226
1231
  * @param {number} [perPage]
1227
- * @param {'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId'} [orderBy]
1232
+ * @param {'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId' | 'report.createdAt'} [orderBy]
1228
1233
  * @param {'asc' | 'desc'} [order] The order to retrieve the logs in
1229
1234
  * @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;
1230
1235
  * @param {*} [options] Override http request option.
@@ -1380,7 +1385,7 @@ var ReportTasksApiFp = function(configuration) {
1380
1385
  * @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.
1381
1386
  * @param {string} [templateId]
1382
1387
  * @param {number} [perPage]
1383
- * @param {'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId'} [orderBy]
1388
+ * @param {'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId' | 'report.createdAt'} [orderBy]
1384
1389
  * @param {'asc' | 'desc'} [order] The order to retrieve the logs in
1385
1390
  * @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;
1386
1391
  * @param {*} [options] Override http request option.
@@ -1456,7 +1461,7 @@ var ReportTasksApiFactory = function(configuration, basePath, axios2) {
1456
1461
  * @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.
1457
1462
  * @param {string} [templateId]
1458
1463
  * @param {number} [perPage]
1459
- * @param {'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId'} [orderBy]
1464
+ * @param {'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId' | 'report.createdAt'} [orderBy]
1460
1465
  * @param {'asc' | 'desc'} [order] The order to retrieve the logs in
1461
1466
  * @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;
1462
1467
  * @param {*} [options] Override http request option.
@@ -1530,7 +1535,7 @@ var ReportTasksApi = class extends BaseAPI {
1530
1535
  * @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.
1531
1536
  * @param {string} [templateId]
1532
1537
  * @param {number} [perPage]
1533
- * @param {'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId'} [orderBy]
1538
+ * @param {'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId' | 'report.createdAt'} [orderBy]
1534
1539
  * @param {'asc' | 'desc'} [order] The order to retrieve the logs in
1535
1540
  * @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;
1536
1541
  * @param {*} [options] Override http request option.
@@ -2839,6 +2844,7 @@ export {
2839
2844
  ReportsApiAxiosParamCreator,
2840
2845
  ReportsApiFactory,
2841
2846
  ReportsApiFp,
2847
+ TemplateTypeEnum,
2842
2848
  TemplatesApi,
2843
2849
  TemplatesApiAxiosParamCreator,
2844
2850
  TemplatesApiFactory,