@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
@@ -1,6 +1,5 @@
1
1
  .gitignore
2
2
  .npmignore
3
- .openapi-generator-ignore
4
3
  README.md
5
4
  api.ts
6
5
  base.ts
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- ## @connectreport/connectreport-js@2.80.3
1
+ ## @connectreport/connectreport-js@2.80.0
2
2
 
3
3
  - View the [Library Docs](https://connectreport.com/docs/classes/_index_.connectreport.html)
4
4
  - View the [ConnectReport HTTP API Reference](https://connectreport.com/api-reference.html)
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.3
7
+ * The version of the OpenAPI document: 2.80.0
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}
@@ -630,11 +630,11 @@ export interface ReportTask {
630
630
  */
631
631
  nextRunAt?: string;
632
632
  /**
633
- * The error object from the last report task execution, if applicable
634
- * @type {string}
633
+ *
634
+ * @type {Array<ReportTaskErrors>}
635
635
  * @memberof ReportTask
636
636
  */
637
- error?: string;
637
+ errors?: Array<ReportTaskErrors>;
638
638
  /**
639
639
  * The average time to run the report task, in minutes
640
640
  * @type {number}
@@ -752,6 +752,31 @@ export interface ReportTaskCustomSelection {
752
752
  */
753
753
  fieldValues?: Array<ReportTaskFieldValues>;
754
754
  }
755
+ /**
756
+ *
757
+ * @export
758
+ * @interface ReportTaskErrors
759
+ */
760
+ export interface ReportTaskErrors {
761
+ /**
762
+ *
763
+ * @type {string}
764
+ * @memberof ReportTaskErrors
765
+ */
766
+ err: string;
767
+ /**
768
+ *
769
+ * @type {string}
770
+ * @memberof ReportTaskErrors
771
+ */
772
+ culpritGuid?: string;
773
+ /**
774
+ *
775
+ * @type {string}
776
+ * @memberof ReportTaskErrors
777
+ */
778
+ page?: string;
779
+ }
755
780
  /**
756
781
  *
757
782
  * @export
@@ -876,11 +901,11 @@ export interface ReportTaskRequest {
876
901
  */
877
902
  nextRunAt?: string;
878
903
  /**
879
- * The error object from the last report task execution, if applicable
880
- * @type {string}
904
+ *
905
+ * @type {Array<ReportTaskErrors>}
881
906
  * @memberof ReportTaskRequest
882
907
  */
883
- error?: string;
908
+ errors?: Array<ReportTaskErrors>;
884
909
  /**
885
910
  * The average time to run the report task, in minutes
886
911
  * @type {number}
@@ -1015,6 +1040,12 @@ export interface ReportTaskRequestAllOf {
1015
1040
  * @memberof ReportTaskRequestAllOf
1016
1041
  */
1017
1042
  usersToShareWith?: Array<ReportTaskRequestAllOfUsersToShareWith>;
1043
+ /**
1044
+ * Groups to share the published report with. This field will be updated entirely if provided
1045
+ * @type {Array<ReportTaskGroupsToShareWith>}
1046
+ * @memberof ReportTaskRequestAllOf
1047
+ */
1048
+ groupsToShareWith?: Array<ReportTaskGroupsToShareWith>;
1018
1049
  }
1019
1050
  /**
1020
1051
  *
@@ -1040,7 +1071,7 @@ export interface ReportTaskResponse {
1040
1071
  * @type {string}
1041
1072
  * @memberof ReportTaskResponse
1042
1073
  */
1043
- id?: string;
1074
+ id: string;
1044
1075
  /**
1045
1076
  * Title of the report task
1046
1077
  * @type {string}
@@ -1102,11 +1133,11 @@ export interface ReportTaskResponse {
1102
1133
  */
1103
1134
  nextRunAt?: string;
1104
1135
  /**
1105
- * The error object from the last report task execution, if applicable
1106
- * @type {string}
1136
+ *
1137
+ * @type {Array<ReportTaskErrors>}
1107
1138
  * @memberof ReportTaskResponse
1108
1139
  */
1109
- error?: string;
1140
+ errors?: Array<ReportTaskErrors>;
1110
1141
  /**
1111
1142
  * The average time to run the report task, in minutes
1112
1143
  * @type {number}
@@ -1179,6 +1210,72 @@ export interface ReportTaskResponse {
1179
1210
  * @memberof ReportTaskResponse
1180
1211
  */
1181
1212
  usersToShareWith?: Array<ReportTaskResponseAllOfUsersToShareWith>;
1213
+ /**
1214
+ * Datetime in UTC when the report task was created
1215
+ * @type {string}
1216
+ * @memberof ReportTaskResponse
1217
+ */
1218
+ createdAt?: string;
1219
+ /**
1220
+ * Datetime in UTC when the report task was last saved
1221
+ * @type {string}
1222
+ * @memberof ReportTaskResponse
1223
+ */
1224
+ lastSavedAt?: string;
1225
+ /**
1226
+ * Field value information
1227
+ * @type {string}
1228
+ * @memberof ReportTaskResponse
1229
+ */
1230
+ fieldValue?: string;
1231
+ /**
1232
+ * Field information
1233
+ * @type {string}
1234
+ * @memberof ReportTaskResponse
1235
+ */
1236
+ fieldInfo?: string;
1237
+ /**
1238
+ * Title of the filter cycle this report task belongs to
1239
+ * @type {string}
1240
+ * @memberof ReportTaskResponse
1241
+ */
1242
+ filterCycleTitle?: string;
1243
+ /**
1244
+ * Datetime in UTC when the report task last started execution
1245
+ * @type {string}
1246
+ * @memberof ReportTaskResponse
1247
+ */
1248
+ lastRunAt?: string;
1249
+ /**
1250
+ * Datetime in UTC when the report task last finished execution
1251
+ * @type {string}
1252
+ * @memberof ReportTaskResponse
1253
+ */
1254
+ lastFinishedAt?: string;
1255
+ /**
1256
+ * Datetime in UTC when the report task last failed
1257
+ * @type {string}
1258
+ * @memberof ReportTaskResponse
1259
+ */
1260
+ failedAt?: string;
1261
+ /**
1262
+ * Reason for the last failure, if applicable
1263
+ * @type {string}
1264
+ * @memberof ReportTaskResponse
1265
+ */
1266
+ failReason?: string;
1267
+ /**
1268
+ * Datetime in UTC when the report task was locked for execution
1269
+ * @type {string}
1270
+ * @memberof ReportTaskResponse
1271
+ */
1272
+ lockedAt?: string;
1273
+ /**
1274
+ * Groups this report is shared with (read-only view of groupsToShareWith)
1275
+ * @type {Array<ReportTaskResponseAllOfGroupsSharedWith>}
1276
+ * @memberof ReportTaskResponse
1277
+ */
1278
+ groupsSharedWith?: Array<ReportTaskResponseAllOfGroupsSharedWith>;
1182
1279
  }
1183
1280
 
1184
1281
  /**
@@ -1217,6 +1314,91 @@ export interface ReportTaskResponseAllOf {
1217
1314
  * @memberof ReportTaskResponseAllOf
1218
1315
  */
1219
1316
  usersToShareWith?: Array<ReportTaskResponseAllOfUsersToShareWith>;
1317
+ /**
1318
+ * Datetime in UTC when the report task was created
1319
+ * @type {string}
1320
+ * @memberof ReportTaskResponseAllOf
1321
+ */
1322
+ createdAt?: string;
1323
+ /**
1324
+ * Datetime in UTC when the report task was last saved
1325
+ * @type {string}
1326
+ * @memberof ReportTaskResponseAllOf
1327
+ */
1328
+ lastSavedAt?: string;
1329
+ /**
1330
+ * Field value information
1331
+ * @type {string}
1332
+ * @memberof ReportTaskResponseAllOf
1333
+ */
1334
+ fieldValue?: string;
1335
+ /**
1336
+ * Field information
1337
+ * @type {string}
1338
+ * @memberof ReportTaskResponseAllOf
1339
+ */
1340
+ fieldInfo?: string;
1341
+ /**
1342
+ * Title of the filter cycle this report task belongs to
1343
+ * @type {string}
1344
+ * @memberof ReportTaskResponseAllOf
1345
+ */
1346
+ filterCycleTitle?: string;
1347
+ /**
1348
+ * Datetime in UTC when the report task last started execution
1349
+ * @type {string}
1350
+ * @memberof ReportTaskResponseAllOf
1351
+ */
1352
+ lastRunAt?: string;
1353
+ /**
1354
+ * Datetime in UTC when the report task last finished execution
1355
+ * @type {string}
1356
+ * @memberof ReportTaskResponseAllOf
1357
+ */
1358
+ lastFinishedAt?: string;
1359
+ /**
1360
+ * Datetime in UTC when the report task last failed
1361
+ * @type {string}
1362
+ * @memberof ReportTaskResponseAllOf
1363
+ */
1364
+ failedAt?: string;
1365
+ /**
1366
+ * Reason for the last failure, if applicable
1367
+ * @type {string}
1368
+ * @memberof ReportTaskResponseAllOf
1369
+ */
1370
+ failReason?: string;
1371
+ /**
1372
+ * Datetime in UTC when the report task was locked for execution
1373
+ * @type {string}
1374
+ * @memberof ReportTaskResponseAllOf
1375
+ */
1376
+ lockedAt?: string;
1377
+ /**
1378
+ * Groups this report is shared with (read-only view of groupsToShareWith)
1379
+ * @type {Array<ReportTaskResponseAllOfGroupsSharedWith>}
1380
+ * @memberof ReportTaskResponseAllOf
1381
+ */
1382
+ groupsSharedWith?: Array<ReportTaskResponseAllOfGroupsSharedWith>;
1383
+ }
1384
+ /**
1385
+ *
1386
+ * @export
1387
+ * @interface ReportTaskResponseAllOfGroupsSharedWith
1388
+ */
1389
+ export interface ReportTaskResponseAllOfGroupsSharedWith {
1390
+ /**
1391
+ *
1392
+ * @type {string}
1393
+ * @memberof ReportTaskResponseAllOfGroupsSharedWith
1394
+ */
1395
+ groupId?: string;
1396
+ /**
1397
+ *
1398
+ * @type {string}
1399
+ * @memberof ReportTaskResponseAllOfGroupsSharedWith
1400
+ */
1401
+ name?: string;
1220
1402
  }
1221
1403
  /**
1222
1404
  *
@@ -1311,7 +1493,23 @@ export interface Template {
1311
1493
  * @memberof Template
1312
1494
  */
1313
1495
  pageHeight: number;
1496
+ /**
1497
+ * Type of the template
1498
+ * @type {string}
1499
+ * @memberof Template
1500
+ */
1501
+ type: TemplateTypeEnum;
1314
1502
  }
1503
+
1504
+ /**
1505
+ * @export
1506
+ * @enum {string}
1507
+ */
1508
+ export enum TemplateTypeEnum {
1509
+ PixelPerfect = 'pixel-perfect',
1510
+ Excel = 'excel'
1511
+ }
1512
+
1315
1513
  /**
1316
1514
  *
1317
1515
  * @export
@@ -2769,13 +2967,13 @@ export const ReportTasksApiAxiosParamCreator = function (configuration?: Configu
2769
2967
  * @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
2968
  * @param {string} [templateId]
2771
2969
  * @param {number} [perPage]
2772
- * @param {'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId'} [orderBy]
2970
+ * @param {'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId' | 'report.createdAt'} [orderBy]
2773
2971
  * @param {'asc' | 'desc'} [order] The order to retrieve the logs in
2774
2972
  * @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
2973
  * @param {*} [options] Override http request option.
2776
2974
  * @throws {RequiredError}
2777
2975
  */
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> => {
2976
+ 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
2977
  const localVarPath = `/report-tasks`;
2780
2978
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
2781
2979
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -2982,13 +3180,13 @@ export const ReportTasksApiFp = function(configuration?: Configuration) {
2982
3180
  * @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
3181
  * @param {string} [templateId]
2984
3182
  * @param {number} [perPage]
2985
- * @param {'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId'} [orderBy]
3183
+ * @param {'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId' | 'report.createdAt'} [orderBy]
2986
3184
  * @param {'asc' | 'desc'} [order] The order to retrieve the logs in
2987
3185
  * @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
3186
  * @param {*} [options] Override http request option.
2989
3187
  * @throws {RequiredError}
2990
3188
  */
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>> {
3189
+ async getReportTasks(pageNum?: number, meta?: { [key: string]: string; }, templateId?: string, perPage?: number, orderBy?: 'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId' | 'report.createdAt', order?: 'asc' | 'desc', filter?: object, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2002>> {
2992
3190
  const localVarAxiosArgs = await localVarAxiosParamCreator.getReportTasks(pageNum, meta, templateId, perPage, orderBy, order, filter, options);
2993
3191
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
2994
3192
  },
@@ -3063,13 +3261,13 @@ export const ReportTasksApiFactory = function (configuration?: Configuration, ba
3063
3261
  * @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
3262
  * @param {string} [templateId]
3065
3263
  * @param {number} [perPage]
3066
- * @param {'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId'} [orderBy]
3264
+ * @param {'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId' | 'report.createdAt'} [orderBy]
3067
3265
  * @param {'asc' | 'desc'} [order] The order to retrieve the logs in
3068
3266
  * @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
3267
  * @param {*} [options] Override http request option.
3070
3268
  * @throws {RequiredError}
3071
3269
  */
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> {
3270
+ getReportTasks(pageNum?: number, meta?: { [key: string]: string; }, templateId?: string, perPage?: number, orderBy?: 'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId' | 'report.createdAt', order?: 'asc' | 'desc', filter?: object, options?: any): AxiosPromise<InlineResponse2002> {
3073
3271
  return localVarFp.getReportTasks(pageNum, meta, templateId, perPage, orderBy, order, filter, options).then((request) => request(axios, basePath));
3074
3272
  },
3075
3273
  /**
@@ -3147,14 +3345,14 @@ export class ReportTasksApi extends BaseAPI {
3147
3345
  * @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
3346
  * @param {string} [templateId]
3149
3347
  * @param {number} [perPage]
3150
- * @param {'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId'} [orderBy]
3348
+ * @param {'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId' | 'report.createdAt'} [orderBy]
3151
3349
  * @param {'asc' | 'desc'} [order] The order to retrieve the logs in
3152
3350
  * @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
3351
  * @param {*} [options] Override http request option.
3154
3352
  * @throws {RequiredError}
3155
3353
  * @memberof ReportTasksApi
3156
3354
  */
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) {
3355
+ 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
3356
  return ReportTasksApiFp(this.configuration).getReportTasks(pageNum, meta, templateId, perPage, orderBy, order, filter, options).then((request) => request(this.axios, this.basePath));
3159
3357
  }
3160
3358
 
package/base.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.3
7
+ * The version of the OpenAPI document: 2.80.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -18,7 +18,7 @@ import { Configuration } from "./configuration";
18
18
  // @ts-ignore
19
19
  import globalAxios, { AxiosPromise, AxiosInstance } from 'axios';
20
20
 
21
- export const BASE_PATH = "https://connectreport.s3.us-east-2.amazonaws.com/api/v1".replace(/\/+$/, "");
21
+ export const BASE_PATH = "http://localhost/api/v1".replace(/\/+$/, "");
22
22
 
23
23
  /**
24
24
  *
package/common.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.3
7
+ * The version of the OpenAPI document: 2.80.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/configuration.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.3
7
+ * The version of the OpenAPI document: 2.80.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/index.cjs CHANGED
@@ -110,6 +110,7 @@ __export(index_exports, {
110
110
  ReportsApiAxiosParamCreator: () => ReportsApiAxiosParamCreator,
111
111
  ReportsApiFactory: () => ReportsApiFactory,
112
112
  ReportsApiFp: () => ReportsApiFp,
113
+ TemplateTypeEnum: () => TemplateTypeEnum,
113
114
  TemplatesApi: () => TemplatesApi,
114
115
  TemplatesApiAxiosParamCreator: () => TemplatesApiAxiosParamCreator,
115
116
  TemplatesApiFactory: () => TemplatesApiFactory,
@@ -126,7 +127,7 @@ var import_axios2 = __toESM(require("axios"), 1);
126
127
 
127
128
  // base.ts
128
129
  var import_axios = __toESM(require("axios"), 1);
129
- var BASE_PATH = "https://connectreport.s3.us-east-2.amazonaws.com/api/v1".replace(/\/+$/, "");
130
+ var BASE_PATH = "http://localhost/api/v1".replace(/\/+$/, "");
130
131
  var BaseAPI = class {
131
132
  constructor(configuration, basePath = BASE_PATH, axios2 = import_axios.default) {
132
133
  this.basePath = basePath;
@@ -264,6 +265,11 @@ var ReportTaskResponseEmailEnum = /* @__PURE__ */ ((ReportTaskResponseEmailEnum2
264
265
  ReportTaskResponseEmailEnum2["Csv"] = "csv";
265
266
  return ReportTaskResponseEmailEnum2;
266
267
  })(ReportTaskResponseEmailEnum || {});
268
+ var TemplateTypeEnum = /* @__PURE__ */ ((TemplateTypeEnum2) => {
269
+ TemplateTypeEnum2["PixelPerfect"] = "pixel-perfect";
270
+ TemplateTypeEnum2["Excel"] = "excel";
271
+ return TemplateTypeEnum2;
272
+ })(TemplateTypeEnum || {});
267
273
  var BaseTemplatesApiAxiosParamCreator = function(configuration) {
268
274
  return {
269
275
  /**
@@ -1280,7 +1286,7 @@ var ReportTasksApiAxiosParamCreator = function(configuration) {
1280
1286
  * @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.
1281
1287
  * @param {string} [templateId]
1282
1288
  * @param {number} [perPage]
1283
- * @param {'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId'} [orderBy]
1289
+ * @param {'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId' | 'report.createdAt'} [orderBy]
1284
1290
  * @param {'asc' | 'desc'} [order] The order to retrieve the logs in
1285
1291
  * @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;
1286
1292
  * @param {*} [options] Override http request option.
@@ -1436,7 +1442,7 @@ var ReportTasksApiFp = function(configuration) {
1436
1442
  * @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.
1437
1443
  * @param {string} [templateId]
1438
1444
  * @param {number} [perPage]
1439
- * @param {'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId'} [orderBy]
1445
+ * @param {'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId' | 'report.createdAt'} [orderBy]
1440
1446
  * @param {'asc' | 'desc'} [order] The order to retrieve the logs in
1441
1447
  * @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;
1442
1448
  * @param {*} [options] Override http request option.
@@ -1512,7 +1518,7 @@ var ReportTasksApiFactory = function(configuration, basePath, axios2) {
1512
1518
  * @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.
1513
1519
  * @param {string} [templateId]
1514
1520
  * @param {number} [perPage]
1515
- * @param {'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId'} [orderBy]
1521
+ * @param {'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId' | 'report.createdAt'} [orderBy]
1516
1522
  * @param {'asc' | 'desc'} [order] The order to retrieve the logs in
1517
1523
  * @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;
1518
1524
  * @param {*} [options] Override http request option.
@@ -1586,7 +1592,7 @@ var ReportTasksApi = class extends BaseAPI {
1586
1592
  * @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.
1587
1593
  * @param {string} [templateId]
1588
1594
  * @param {number} [perPage]
1589
- * @param {'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId'} [orderBy]
1595
+ * @param {'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId' | 'report.createdAt'} [orderBy]
1590
1596
  * @param {'asc' | 'desc'} [order] The order to retrieve the logs in
1591
1597
  * @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;
1592
1598
  * @param {*} [options] Override http request option.
@@ -2896,6 +2902,7 @@ globalThis.ConnectReport = ConnectReport;
2896
2902
  ReportsApiAxiosParamCreator,
2897
2903
  ReportsApiFactory,
2898
2904
  ReportsApiFp,
2905
+ TemplateTypeEnum,
2899
2906
  TemplatesApi,
2900
2907
  TemplatesApiAxiosParamCreator,
2901
2908
  TemplatesApiFactory,