@connectreport/connectreport-js 2.79.0 → 2.79.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.
- package/README.md +1 -1
- package/api.ts +1 -1
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/index.cjs +624 -2
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +1546 -165
- package/dist/index.d.ts +1546 -165
- package/dist/index.js +579 -1
- package/dist/index.js.map +1 -1
- package/index.ts +3 -1
- package/package.json +1 -1
package/dist/index.js
CHANGED
|
@@ -140,6 +140,74 @@ var createRequestFunction = function(axiosArgs, globalAxios3, BASE_PATH2, config
|
|
|
140
140
|
};
|
|
141
141
|
|
|
142
142
|
// api.ts
|
|
143
|
+
var FilterCycleFrequencyEnum = /* @__PURE__ */ ((FilterCycleFrequencyEnum2) => {
|
|
144
|
+
FilterCycleFrequencyEnum2["Monthly"] = "Monthly";
|
|
145
|
+
FilterCycleFrequencyEnum2["OnceNow"] = "Once - now";
|
|
146
|
+
FilterCycleFrequencyEnum2["OnceScheduled"] = "Once - scheduled";
|
|
147
|
+
FilterCycleFrequencyEnum2["Annually"] = "Annually";
|
|
148
|
+
FilterCycleFrequencyEnum2["Daily"] = "Daily";
|
|
149
|
+
FilterCycleFrequencyEnum2["Weekly"] = "Weekly";
|
|
150
|
+
FilterCycleFrequencyEnum2["UponTrigger"] = "Upon trigger";
|
|
151
|
+
return FilterCycleFrequencyEnum2;
|
|
152
|
+
})(FilterCycleFrequencyEnum || {});
|
|
153
|
+
var FilterCycleEmailEnum = /* @__PURE__ */ ((FilterCycleEmailEnum2) => {
|
|
154
|
+
FilterCycleEmailEnum2["Pdf"] = "pdf";
|
|
155
|
+
FilterCycleEmailEnum2["Pptx"] = "pptx";
|
|
156
|
+
FilterCycleEmailEnum2["Xlsx"] = "xlsx";
|
|
157
|
+
FilterCycleEmailEnum2["Csv"] = "csv";
|
|
158
|
+
return FilterCycleEmailEnum2;
|
|
159
|
+
})(FilterCycleEmailEnum || {});
|
|
160
|
+
var ReportTaskFrequencyEnum = /* @__PURE__ */ ((ReportTaskFrequencyEnum2) => {
|
|
161
|
+
ReportTaskFrequencyEnum2["Monthly"] = "Monthly";
|
|
162
|
+
ReportTaskFrequencyEnum2["OnceNow"] = "Once - now";
|
|
163
|
+
ReportTaskFrequencyEnum2["OnceScheduled"] = "Once - scheduled";
|
|
164
|
+
ReportTaskFrequencyEnum2["Annually"] = "Annually";
|
|
165
|
+
ReportTaskFrequencyEnum2["Daily"] = "Daily";
|
|
166
|
+
ReportTaskFrequencyEnum2["Weekly"] = "Weekly";
|
|
167
|
+
ReportTaskFrequencyEnum2["UponTrigger"] = "Upon trigger";
|
|
168
|
+
return ReportTaskFrequencyEnum2;
|
|
169
|
+
})(ReportTaskFrequencyEnum || {});
|
|
170
|
+
var ReportTaskEmailEnum = /* @__PURE__ */ ((ReportTaskEmailEnum2) => {
|
|
171
|
+
ReportTaskEmailEnum2["Pdf"] = "pdf";
|
|
172
|
+
ReportTaskEmailEnum2["Pptx"] = "pptx";
|
|
173
|
+
ReportTaskEmailEnum2["Xlsx"] = "xlsx";
|
|
174
|
+
ReportTaskEmailEnum2["Csv"] = "csv";
|
|
175
|
+
return ReportTaskEmailEnum2;
|
|
176
|
+
})(ReportTaskEmailEnum || {});
|
|
177
|
+
var ReportTaskRequestFrequencyEnum = /* @__PURE__ */ ((ReportTaskRequestFrequencyEnum2) => {
|
|
178
|
+
ReportTaskRequestFrequencyEnum2["Monthly"] = "Monthly";
|
|
179
|
+
ReportTaskRequestFrequencyEnum2["OnceNow"] = "Once - now";
|
|
180
|
+
ReportTaskRequestFrequencyEnum2["OnceScheduled"] = "Once - scheduled";
|
|
181
|
+
ReportTaskRequestFrequencyEnum2["Annually"] = "Annually";
|
|
182
|
+
ReportTaskRequestFrequencyEnum2["Daily"] = "Daily";
|
|
183
|
+
ReportTaskRequestFrequencyEnum2["Weekly"] = "Weekly";
|
|
184
|
+
ReportTaskRequestFrequencyEnum2["UponTrigger"] = "Upon trigger";
|
|
185
|
+
return ReportTaskRequestFrequencyEnum2;
|
|
186
|
+
})(ReportTaskRequestFrequencyEnum || {});
|
|
187
|
+
var ReportTaskRequestEmailEnum = /* @__PURE__ */ ((ReportTaskRequestEmailEnum2) => {
|
|
188
|
+
ReportTaskRequestEmailEnum2["Pdf"] = "pdf";
|
|
189
|
+
ReportTaskRequestEmailEnum2["Pptx"] = "pptx";
|
|
190
|
+
ReportTaskRequestEmailEnum2["Xlsx"] = "xlsx";
|
|
191
|
+
ReportTaskRequestEmailEnum2["Csv"] = "csv";
|
|
192
|
+
return ReportTaskRequestEmailEnum2;
|
|
193
|
+
})(ReportTaskRequestEmailEnum || {});
|
|
194
|
+
var ReportTaskResponseFrequencyEnum = /* @__PURE__ */ ((ReportTaskResponseFrequencyEnum2) => {
|
|
195
|
+
ReportTaskResponseFrequencyEnum2["Monthly"] = "Monthly";
|
|
196
|
+
ReportTaskResponseFrequencyEnum2["OnceNow"] = "Once - now";
|
|
197
|
+
ReportTaskResponseFrequencyEnum2["OnceScheduled"] = "Once - scheduled";
|
|
198
|
+
ReportTaskResponseFrequencyEnum2["Annually"] = "Annually";
|
|
199
|
+
ReportTaskResponseFrequencyEnum2["Daily"] = "Daily";
|
|
200
|
+
ReportTaskResponseFrequencyEnum2["Weekly"] = "Weekly";
|
|
201
|
+
ReportTaskResponseFrequencyEnum2["UponTrigger"] = "Upon trigger";
|
|
202
|
+
return ReportTaskResponseFrequencyEnum2;
|
|
203
|
+
})(ReportTaskResponseFrequencyEnum || {});
|
|
204
|
+
var ReportTaskResponseEmailEnum = /* @__PURE__ */ ((ReportTaskResponseEmailEnum2) => {
|
|
205
|
+
ReportTaskResponseEmailEnum2["Pdf"] = "pdf";
|
|
206
|
+
ReportTaskResponseEmailEnum2["Pptx"] = "pptx";
|
|
207
|
+
ReportTaskResponseEmailEnum2["Xlsx"] = "xlsx";
|
|
208
|
+
ReportTaskResponseEmailEnum2["Csv"] = "csv";
|
|
209
|
+
return ReportTaskResponseEmailEnum2;
|
|
210
|
+
})(ReportTaskResponseEmailEnum || {});
|
|
143
211
|
var BaseTemplatesApiAxiosParamCreator = function(configuration) {
|
|
144
212
|
return {
|
|
145
213
|
/**
|
|
@@ -236,6 +304,32 @@ var BaseTemplatesApiFp = function(configuration) {
|
|
|
236
304
|
}
|
|
237
305
|
};
|
|
238
306
|
};
|
|
307
|
+
var BaseTemplatesApiFactory = function(configuration, basePath, axios2) {
|
|
308
|
+
const localVarFp = BaseTemplatesApiFp(configuration);
|
|
309
|
+
return {
|
|
310
|
+
/**
|
|
311
|
+
* Duplicate a base template by its ID
|
|
312
|
+
* @summary Duplicate a base template
|
|
313
|
+
* @param {string} id
|
|
314
|
+
* @param {*} [options] Override http request option.
|
|
315
|
+
* @throws {RequiredError}
|
|
316
|
+
*/
|
|
317
|
+
duplicateBaseTemplate(id, options) {
|
|
318
|
+
return localVarFp.duplicateBaseTemplate(id, options).then((request) => request(axios2, basePath));
|
|
319
|
+
},
|
|
320
|
+
/**
|
|
321
|
+
*
|
|
322
|
+
* @summary List base templates
|
|
323
|
+
* @param {number} [pageNum]
|
|
324
|
+
* @param {number} [page]
|
|
325
|
+
* @param {*} [options] Override http request option.
|
|
326
|
+
* @throws {RequiredError}
|
|
327
|
+
*/
|
|
328
|
+
getBaseTemplates(pageNum, page, options) {
|
|
329
|
+
return localVarFp.getBaseTemplates(pageNum, page, options).then((request) => request(axios2, basePath));
|
|
330
|
+
}
|
|
331
|
+
};
|
|
332
|
+
};
|
|
239
333
|
var BaseTemplatesApi = class extends BaseAPI {
|
|
240
334
|
/**
|
|
241
335
|
* Duplicate a base template by its ID
|
|
@@ -318,6 +412,23 @@ var DocumentsApiFp = function(configuration) {
|
|
|
318
412
|
}
|
|
319
413
|
};
|
|
320
414
|
};
|
|
415
|
+
var DocumentsApiFactory = function(configuration, basePath, axios2) {
|
|
416
|
+
const localVarFp = DocumentsApiFp(configuration);
|
|
417
|
+
return {
|
|
418
|
+
/**
|
|
419
|
+
*
|
|
420
|
+
* @summary Retrieve a generated document
|
|
421
|
+
* @param {string} fileName
|
|
422
|
+
* @param {'pdf' | 'pptx' | 'xlsx' | 'csv'} fileType
|
|
423
|
+
* @param {string} [attachmentName] A document file title. This value is reflected back to the client in the fileName header.
|
|
424
|
+
* @param {*} [options] Override http request option.
|
|
425
|
+
* @throws {RequiredError}
|
|
426
|
+
*/
|
|
427
|
+
getDocument(fileName, fileType, attachmentName, options) {
|
|
428
|
+
return localVarFp.getDocument(fileName, fileType, attachmentName, options).then((request) => request(axios2, basePath));
|
|
429
|
+
}
|
|
430
|
+
};
|
|
431
|
+
};
|
|
321
432
|
var DocumentsApi = class extends BaseAPI {
|
|
322
433
|
/**
|
|
323
434
|
*
|
|
@@ -632,6 +743,82 @@ var FilterCyclesApiFp = function(configuration) {
|
|
|
632
743
|
}
|
|
633
744
|
};
|
|
634
745
|
};
|
|
746
|
+
var FilterCyclesApiFactory = function(configuration, basePath, axios2) {
|
|
747
|
+
const localVarFp = FilterCyclesApiFp(configuration);
|
|
748
|
+
return {
|
|
749
|
+
/**
|
|
750
|
+
*
|
|
751
|
+
* @summary Create a filter cycle
|
|
752
|
+
* @param {FilterCycle} filterCycle
|
|
753
|
+
* @param {*} [options] Override http request option.
|
|
754
|
+
* @throws {RequiredError}
|
|
755
|
+
*/
|
|
756
|
+
createFilterCycle(filterCycle, options) {
|
|
757
|
+
return localVarFp.createFilterCycle(filterCycle, options).then((request) => request(axios2, basePath));
|
|
758
|
+
},
|
|
759
|
+
/**
|
|
760
|
+
*
|
|
761
|
+
* @summary Delete a filter cycle
|
|
762
|
+
* @param {string} id
|
|
763
|
+
* @param {*} [options] Override http request option.
|
|
764
|
+
* @throws {RequiredError}
|
|
765
|
+
*/
|
|
766
|
+
deleteFilterCycle(id, options) {
|
|
767
|
+
return localVarFp.deleteFilterCycle(id, options).then((request) => request(axios2, basePath));
|
|
768
|
+
},
|
|
769
|
+
/**
|
|
770
|
+
*
|
|
771
|
+
* @summary Disable all report tasks in a cycle
|
|
772
|
+
* @param {string} id
|
|
773
|
+
* @param {*} [options] Override http request option.
|
|
774
|
+
* @throws {RequiredError}
|
|
775
|
+
*/
|
|
776
|
+
disableAllInCycle(id, options) {
|
|
777
|
+
return localVarFp.disableAllInCycle(id, options).then((request) => request(axios2, basePath));
|
|
778
|
+
},
|
|
779
|
+
/**
|
|
780
|
+
*
|
|
781
|
+
* @summary Enable all report tasks in a cycle
|
|
782
|
+
* @param {string} id
|
|
783
|
+
* @param {*} [options] Override http request option.
|
|
784
|
+
* @throws {RequiredError}
|
|
785
|
+
*/
|
|
786
|
+
enableAllInCycle(id, options) {
|
|
787
|
+
return localVarFp.enableAllInCycle(id, options).then((request) => request(axios2, basePath));
|
|
788
|
+
},
|
|
789
|
+
/**
|
|
790
|
+
*
|
|
791
|
+
* @summary Get a filter cycle
|
|
792
|
+
* @param {string} id
|
|
793
|
+
* @param {*} [options] Override http request option.
|
|
794
|
+
* @throws {RequiredError}
|
|
795
|
+
*/
|
|
796
|
+
getFilterCycle(id, options) {
|
|
797
|
+
return localVarFp.getFilterCycle(id, options).then((request) => request(axios2, basePath));
|
|
798
|
+
},
|
|
799
|
+
/**
|
|
800
|
+
*
|
|
801
|
+
* @summary List filter cycles
|
|
802
|
+
* @param {string} templateId
|
|
803
|
+
* @param {*} [options] Override http request option.
|
|
804
|
+
* @throws {RequiredError}
|
|
805
|
+
*/
|
|
806
|
+
getFilterCycles(templateId, options) {
|
|
807
|
+
return localVarFp.getFilterCycles(templateId, options).then((request) => request(axios2, basePath));
|
|
808
|
+
},
|
|
809
|
+
/**
|
|
810
|
+
*
|
|
811
|
+
* @summary Update a filter cycle
|
|
812
|
+
* @param {string} id
|
|
813
|
+
* @param {FilterCycle} filterCycle
|
|
814
|
+
* @param {*} [options] Override http request option.
|
|
815
|
+
* @throws {RequiredError}
|
|
816
|
+
*/
|
|
817
|
+
updateFilterCycle(id, filterCycle, options) {
|
|
818
|
+
return localVarFp.updateFilterCycle(id, filterCycle, options).then((request) => request(axios2, basePath));
|
|
819
|
+
}
|
|
820
|
+
};
|
|
821
|
+
};
|
|
635
822
|
var FilterCyclesApi = class extends BaseAPI {
|
|
636
823
|
/**
|
|
637
824
|
*
|
|
@@ -809,6 +996,31 @@ var ImagesApiFp = function(configuration) {
|
|
|
809
996
|
}
|
|
810
997
|
};
|
|
811
998
|
};
|
|
999
|
+
var ImagesApiFactory = function(configuration, basePath, axios2) {
|
|
1000
|
+
const localVarFp = ImagesApiFp(configuration);
|
|
1001
|
+
return {
|
|
1002
|
+
/**
|
|
1003
|
+
*
|
|
1004
|
+
* @summary Retrieves a user uploaded image for use in a template
|
|
1005
|
+
* @param {string} title
|
|
1006
|
+
* @param {*} [options] Override http request option.
|
|
1007
|
+
* @throws {RequiredError}
|
|
1008
|
+
*/
|
|
1009
|
+
getImage(title, options) {
|
|
1010
|
+
return localVarFp.getImage(title, options).then((request) => request(axios2, basePath));
|
|
1011
|
+
},
|
|
1012
|
+
/**
|
|
1013
|
+
* Uploads an image to the server for use in templates
|
|
1014
|
+
* @summary Upload an image for use in a template
|
|
1015
|
+
* @param {any} [image]
|
|
1016
|
+
* @param {*} [options] Override http request option.
|
|
1017
|
+
* @throws {RequiredError}
|
|
1018
|
+
*/
|
|
1019
|
+
uploadImage(image, options) {
|
|
1020
|
+
return localVarFp.uploadImage(image, options).then((request) => request(axios2, basePath));
|
|
1021
|
+
}
|
|
1022
|
+
};
|
|
1023
|
+
};
|
|
812
1024
|
var ImagesApi = class extends BaseAPI {
|
|
813
1025
|
/**
|
|
814
1026
|
*
|
|
@@ -882,6 +1094,21 @@ var JobsApiFp = function(configuration) {
|
|
|
882
1094
|
}
|
|
883
1095
|
};
|
|
884
1096
|
};
|
|
1097
|
+
var JobsApiFactory = function(configuration, basePath, axios2) {
|
|
1098
|
+
const localVarFp = JobsApiFp(configuration);
|
|
1099
|
+
return {
|
|
1100
|
+
/**
|
|
1101
|
+
* Get the status of a queued job, including its status and result if available.
|
|
1102
|
+
* @summary Get job
|
|
1103
|
+
* @param {string} id
|
|
1104
|
+
* @param {*} [options] Override http request option.
|
|
1105
|
+
* @throws {RequiredError}
|
|
1106
|
+
*/
|
|
1107
|
+
getJob(id, options) {
|
|
1108
|
+
return localVarFp.getJob(id, options).then((request) => request(axios2, basePath));
|
|
1109
|
+
}
|
|
1110
|
+
};
|
|
1111
|
+
};
|
|
885
1112
|
var JobsApi = class extends BaseAPI {
|
|
886
1113
|
/**
|
|
887
1114
|
* Get the status of a queued job, including its status and result if available.
|
|
@@ -1188,6 +1415,79 @@ var ReportTasksApiFp = function(configuration) {
|
|
|
1188
1415
|
}
|
|
1189
1416
|
};
|
|
1190
1417
|
};
|
|
1418
|
+
var ReportTasksApiFactory = function(configuration, basePath, axios2) {
|
|
1419
|
+
const localVarFp = ReportTasksApiFp(configuration);
|
|
1420
|
+
return {
|
|
1421
|
+
/**
|
|
1422
|
+
*
|
|
1423
|
+
* @summary Create report task
|
|
1424
|
+
* @param {ReportTaskRequest} reportTaskRequest
|
|
1425
|
+
* @param {*} [options] Override http request option.
|
|
1426
|
+
* @throws {RequiredError}
|
|
1427
|
+
*/
|
|
1428
|
+
createReportTask(reportTaskRequest, options) {
|
|
1429
|
+
return localVarFp.createReportTask(reportTaskRequest, options).then((request) => request(axios2, basePath));
|
|
1430
|
+
},
|
|
1431
|
+
/**
|
|
1432
|
+
* Delete a report task by its ID
|
|
1433
|
+
* @summary Delete report task
|
|
1434
|
+
* @param {string} id
|
|
1435
|
+
* @param {boolean} [deleteAssociatedReports]
|
|
1436
|
+
* @param {*} [options] Override http request option.
|
|
1437
|
+
* @throws {RequiredError}
|
|
1438
|
+
*/
|
|
1439
|
+
deleteReportTask(id, deleteAssociatedReports, options) {
|
|
1440
|
+
return localVarFp.deleteReportTask(id, deleteAssociatedReports, options).then((request) => request(axios2, basePath));
|
|
1441
|
+
},
|
|
1442
|
+
/**
|
|
1443
|
+
* Read a report task by its ID
|
|
1444
|
+
* @summary Read report task
|
|
1445
|
+
* @param {string} id
|
|
1446
|
+
* @param {*} [options] Override http request option.
|
|
1447
|
+
* @throws {RequiredError}
|
|
1448
|
+
*/
|
|
1449
|
+
getReportTask(id, options) {
|
|
1450
|
+
return localVarFp.getReportTask(id, options).then((request) => request(axios2, basePath));
|
|
1451
|
+
},
|
|
1452
|
+
/**
|
|
1453
|
+
*
|
|
1454
|
+
* @summary List report tasks
|
|
1455
|
+
* @param {number} [pageNum]
|
|
1456
|
+
* @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
|
+
* @param {string} [templateId]
|
|
1458
|
+
* @param {number} [perPage]
|
|
1459
|
+
* @param {'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId'} [orderBy]
|
|
1460
|
+
* @param {'asc' | 'desc'} [order] The order to retrieve the logs in
|
|
1461
|
+
* @param {object} [filter] Filters for report tasks. JSON encoded object in the form of `{ field: string, query: string}`, or for date range fields (including \"startOn\" and \"endOn\"), `{ field: string, query: { start: Date, end: Date }}`. ### Examples: Filter on \"startOn\": ``` { \"field\": \"startOn\", \"query\": { \"start\": \"2020-01-01T00:00:00.000Z\", \"end\": \"2020-01-02T00:00:00.000Z\" } } ``` Filter on \"enabled\" ``` { \"field\": \"enabled\", \"query\": \"True\" } ``` Filter on \"frequency\": ``` { \"field\": \"frequency\", \"query\": \"Monthly\" } ```
|
|
1462
|
+
* @param {*} [options] Override http request option.
|
|
1463
|
+
* @throws {RequiredError}
|
|
1464
|
+
*/
|
|
1465
|
+
getReportTasks(pageNum, meta, templateId, perPage, orderBy, order, filter, options) {
|
|
1466
|
+
return localVarFp.getReportTasks(pageNum, meta, templateId, perPage, orderBy, order, filter, options).then((request) => request(axios2, basePath));
|
|
1467
|
+
},
|
|
1468
|
+
/**
|
|
1469
|
+
* Duplicates the task and runs it as \"Once - Now\"
|
|
1470
|
+
* @summary Run task now
|
|
1471
|
+
* @param {string} id
|
|
1472
|
+
* @param {*} [options] Override http request option.
|
|
1473
|
+
* @throws {RequiredError}
|
|
1474
|
+
*/
|
|
1475
|
+
runReportTaskNow(id, options) {
|
|
1476
|
+
return localVarFp.runReportTaskNow(id, options).then((request) => request(axios2, basePath));
|
|
1477
|
+
},
|
|
1478
|
+
/**
|
|
1479
|
+
* Accepts partial updates
|
|
1480
|
+
* @summary Update report task by ID
|
|
1481
|
+
* @param {string} id
|
|
1482
|
+
* @param {ReportTaskRequest} reportTaskRequest
|
|
1483
|
+
* @param {*} [options] Override http request option.
|
|
1484
|
+
* @throws {RequiredError}
|
|
1485
|
+
*/
|
|
1486
|
+
updateReportTask(id, reportTaskRequest, options) {
|
|
1487
|
+
return localVarFp.updateReportTask(id, reportTaskRequest, options).then((request) => request(axios2, basePath));
|
|
1488
|
+
}
|
|
1489
|
+
};
|
|
1490
|
+
};
|
|
1191
1491
|
var ReportTasksApi = class extends BaseAPI {
|
|
1192
1492
|
/**
|
|
1193
1493
|
*
|
|
@@ -1466,6 +1766,57 @@ var ReportsApiFp = function(configuration) {
|
|
|
1466
1766
|
}
|
|
1467
1767
|
};
|
|
1468
1768
|
};
|
|
1769
|
+
var ReportsApiFactory = function(configuration, basePath, axios2) {
|
|
1770
|
+
const localVarFp = ReportsApiFp(configuration);
|
|
1771
|
+
return {
|
|
1772
|
+
/**
|
|
1773
|
+
*
|
|
1774
|
+
* @summary Delete a published report
|
|
1775
|
+
* @param {string} id
|
|
1776
|
+
* @param {*} [options] Override http request option.
|
|
1777
|
+
* @throws {RequiredError}
|
|
1778
|
+
*/
|
|
1779
|
+
deleteReport(id, options) {
|
|
1780
|
+
return localVarFp.deleteReport(id, options).then((request) => request(axios2, basePath));
|
|
1781
|
+
},
|
|
1782
|
+
/**
|
|
1783
|
+
*
|
|
1784
|
+
* @summary Get a published report
|
|
1785
|
+
* @param {string} id
|
|
1786
|
+
* @param {*} [options] Override http request option.
|
|
1787
|
+
* @throws {RequiredError}
|
|
1788
|
+
*/
|
|
1789
|
+
getReport(id, options) {
|
|
1790
|
+
return localVarFp.getReport(id, options).then((request) => request(axios2, basePath));
|
|
1791
|
+
},
|
|
1792
|
+
/**
|
|
1793
|
+
*
|
|
1794
|
+
* @summary List reports
|
|
1795
|
+
* @param {number} [pageNum]
|
|
1796
|
+
* @param {number} [perPage]
|
|
1797
|
+
* @param {'title' | 'createdAt'} [orderBy] The field to order the list of reports on
|
|
1798
|
+
* @param {'asc' | 'desc'} [order] The order to sort the list of reports on
|
|
1799
|
+
* @param {string} [tagId] A tagId to filter the list of reports on
|
|
1800
|
+
* @param {string} [reportTaskId] A reportId to filter the list of reports on
|
|
1801
|
+
* @param {*} [options] Override http request option.
|
|
1802
|
+
* @throws {RequiredError}
|
|
1803
|
+
*/
|
|
1804
|
+
getReports(pageNum, perPage, orderBy, order, tagId, reportTaskId, options) {
|
|
1805
|
+
return localVarFp.getReports(pageNum, perPage, orderBy, order, tagId, reportTaskId, options).then((request) => request(axios2, basePath));
|
|
1806
|
+
},
|
|
1807
|
+
/**
|
|
1808
|
+
*
|
|
1809
|
+
* @summary Render a published report
|
|
1810
|
+
* @param {string} id
|
|
1811
|
+
* @param {'pdf' | 'pptx' | 'xlsx' | 'csv'} format
|
|
1812
|
+
* @param {*} [options] Override http request option.
|
|
1813
|
+
* @throws {RequiredError}
|
|
1814
|
+
*/
|
|
1815
|
+
renderReport(id, format, options) {
|
|
1816
|
+
return localVarFp.renderReport(id, format, options).then((request) => request(axios2, basePath));
|
|
1817
|
+
}
|
|
1818
|
+
};
|
|
1819
|
+
};
|
|
1469
1820
|
var ReportsApi = class extends BaseAPI {
|
|
1470
1821
|
/**
|
|
1471
1822
|
*
|
|
@@ -1910,6 +2261,103 @@ var TemplatesApiFp = function(configuration) {
|
|
|
1910
2261
|
}
|
|
1911
2262
|
};
|
|
1912
2263
|
};
|
|
2264
|
+
var TemplatesApiFactory = function(configuration, basePath, axios2) {
|
|
2265
|
+
const localVarFp = TemplatesApiFp(configuration);
|
|
2266
|
+
return {
|
|
2267
|
+
/**
|
|
2268
|
+
*
|
|
2269
|
+
* @summary Create report template by ID
|
|
2270
|
+
* @param {Template} template
|
|
2271
|
+
* @param {*} [options] Override http request option.
|
|
2272
|
+
* @throws {RequiredError}
|
|
2273
|
+
*/
|
|
2274
|
+
createTemplate(template, options) {
|
|
2275
|
+
return localVarFp.createTemplate(template, options).then((request) => request(axios2, basePath));
|
|
2276
|
+
},
|
|
2277
|
+
/**
|
|
2278
|
+
* Delete a report template by its ID
|
|
2279
|
+
* @summary Delete report template
|
|
2280
|
+
* @param {string} id
|
|
2281
|
+
* @param {*} [options] Override http request option.
|
|
2282
|
+
* @throws {RequiredError}
|
|
2283
|
+
*/
|
|
2284
|
+
deleteTemplate(id, options) {
|
|
2285
|
+
return localVarFp.deleteTemplate(id, options).then((request) => request(axios2, basePath));
|
|
2286
|
+
},
|
|
2287
|
+
/**
|
|
2288
|
+
* Duplicate a report template by its ID
|
|
2289
|
+
* @summary Duplicate a report template
|
|
2290
|
+
* @param {string} id
|
|
2291
|
+
* @param {*} [options] Override http request option.
|
|
2292
|
+
* @throws {RequiredError}
|
|
2293
|
+
*/
|
|
2294
|
+
duplicateTemplate(id, options) {
|
|
2295
|
+
return localVarFp.duplicateTemplate(id, options).then((request) => request(axios2, basePath));
|
|
2296
|
+
},
|
|
2297
|
+
/**
|
|
2298
|
+
* Export a report template to a .CRPT file
|
|
2299
|
+
* @summary Export a report template
|
|
2300
|
+
* @param {string} id
|
|
2301
|
+
* @param {*} [options] Override http request option.
|
|
2302
|
+
* @throws {RequiredError}
|
|
2303
|
+
*/
|
|
2304
|
+
exportTemplate(id, options) {
|
|
2305
|
+
return localVarFp.exportTemplate(id, options).then((request) => request(axios2, basePath));
|
|
2306
|
+
},
|
|
2307
|
+
/**
|
|
2308
|
+
* Read a report template by its ID
|
|
2309
|
+
* @summary Read report template
|
|
2310
|
+
* @param {string} id
|
|
2311
|
+
* @param {*} [options] Override http request option.
|
|
2312
|
+
* @throws {RequiredError}
|
|
2313
|
+
*/
|
|
2314
|
+
getTemplate(id, options) {
|
|
2315
|
+
return localVarFp.getTemplate(id, options).then((request) => request(axios2, basePath));
|
|
2316
|
+
},
|
|
2317
|
+
/**
|
|
2318
|
+
*
|
|
2319
|
+
* @summary List report templates
|
|
2320
|
+
* @param {number} [pageNum]
|
|
2321
|
+
* @param {*} [options] Override http request option.
|
|
2322
|
+
* @throws {RequiredError}
|
|
2323
|
+
*/
|
|
2324
|
+
getTemplates(pageNum, options) {
|
|
2325
|
+
return localVarFp.getTemplates(pageNum, options).then((request) => request(axios2, basePath));
|
|
2326
|
+
},
|
|
2327
|
+
/**
|
|
2328
|
+
* Imports an exported .CRPT file
|
|
2329
|
+
* @summary Import a template
|
|
2330
|
+
* @param {any} [template]
|
|
2331
|
+
* @param {*} [options] Override http request option.
|
|
2332
|
+
* @throws {RequiredError}
|
|
2333
|
+
*/
|
|
2334
|
+
importTemplate(template, options) {
|
|
2335
|
+
return localVarFp.importTemplate(template, options).then((request) => request(axios2, basePath));
|
|
2336
|
+
},
|
|
2337
|
+
/**
|
|
2338
|
+
* Render a report template to PDF, PPTX, or XLSX. Responds with a job entity.
|
|
2339
|
+
* @summary Render a report template
|
|
2340
|
+
* @param {string} id
|
|
2341
|
+
* @param {'pdf' | 'pptx' | 'xlsx' | 'csv'} format
|
|
2342
|
+
* @param {*} [options] Override http request option.
|
|
2343
|
+
* @throws {RequiredError}
|
|
2344
|
+
*/
|
|
2345
|
+
renderTemplate(id, format, options) {
|
|
2346
|
+
return localVarFp.renderTemplate(id, format, options).then((request) => request(axios2, basePath));
|
|
2347
|
+
},
|
|
2348
|
+
/**
|
|
2349
|
+
* Accepts partial updates
|
|
2350
|
+
* @summary Update report template by ID
|
|
2351
|
+
* @param {string} id
|
|
2352
|
+
* @param {Template} template
|
|
2353
|
+
* @param {*} [options] Override http request option.
|
|
2354
|
+
* @throws {RequiredError}
|
|
2355
|
+
*/
|
|
2356
|
+
updateTemplate(id, template, options) {
|
|
2357
|
+
return localVarFp.updateTemplate(id, template, options).then((request) => request(axios2, basePath));
|
|
2358
|
+
}
|
|
2359
|
+
};
|
|
2360
|
+
};
|
|
1913
2361
|
var TemplatesApi = class extends BaseAPI {
|
|
1914
2362
|
/**
|
|
1915
2363
|
*
|
|
@@ -2013,6 +2461,92 @@ var TemplatesApi = class extends BaseAPI {
|
|
|
2013
2461
|
return TemplatesApiFp(this.configuration).updateTemplate(id, template, options).then((request) => request(this.axios, this.basePath));
|
|
2014
2462
|
}
|
|
2015
2463
|
};
|
|
2464
|
+
var VisualizationApiAxiosParamCreator = function(configuration) {
|
|
2465
|
+
return {
|
|
2466
|
+
/**
|
|
2467
|
+
*
|
|
2468
|
+
* @summary Create an image from a visualization
|
|
2469
|
+
* @param {Visualization} visualization
|
|
2470
|
+
* @param {'high' | 'low'} [priority] Priority of the visualization image request
|
|
2471
|
+
* @param {*} [options] Override http request option.
|
|
2472
|
+
* @throws {RequiredError}
|
|
2473
|
+
*/
|
|
2474
|
+
createVisualization: async (visualization, priority, options = {}) => {
|
|
2475
|
+
assertParamExists("createVisualization", "visualization", visualization);
|
|
2476
|
+
const localVarPath = `/visualizations`;
|
|
2477
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2478
|
+
let baseOptions;
|
|
2479
|
+
if (configuration) {
|
|
2480
|
+
baseOptions = configuration.baseOptions;
|
|
2481
|
+
}
|
|
2482
|
+
const localVarRequestOptions = { method: "POST", ...baseOptions, ...options };
|
|
2483
|
+
const localVarHeaderParameter = {};
|
|
2484
|
+
const localVarQueryParameter = {};
|
|
2485
|
+
await setApiKeyToObject(localVarHeaderParameter, "X-API-KEY", configuration);
|
|
2486
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2487
|
+
if (priority !== void 0) {
|
|
2488
|
+
localVarQueryParameter["priority"] = priority;
|
|
2489
|
+
}
|
|
2490
|
+
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
2491
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);
|
|
2492
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2493
|
+
let formHeaders = {};
|
|
2494
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...formHeaders, ...options.headers };
|
|
2495
|
+
localVarRequestOptions.data = serializeDataIfNeeded(visualization, localVarRequestOptions, configuration);
|
|
2496
|
+
return {
|
|
2497
|
+
url: toPathString(localVarUrlObj),
|
|
2498
|
+
options: localVarRequestOptions
|
|
2499
|
+
};
|
|
2500
|
+
}
|
|
2501
|
+
};
|
|
2502
|
+
};
|
|
2503
|
+
var VisualizationApiFp = function(configuration) {
|
|
2504
|
+
const localVarAxiosParamCreator = VisualizationApiAxiosParamCreator(configuration);
|
|
2505
|
+
return {
|
|
2506
|
+
/**
|
|
2507
|
+
*
|
|
2508
|
+
* @summary Create an image from a visualization
|
|
2509
|
+
* @param {Visualization} visualization
|
|
2510
|
+
* @param {'high' | 'low'} [priority] Priority of the visualization image request
|
|
2511
|
+
* @param {*} [options] Override http request option.
|
|
2512
|
+
* @throws {RequiredError}
|
|
2513
|
+
*/
|
|
2514
|
+
async createVisualization(visualization, priority, options) {
|
|
2515
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createVisualization(visualization, priority, options);
|
|
2516
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios2, BASE_PATH, configuration);
|
|
2517
|
+
}
|
|
2518
|
+
};
|
|
2519
|
+
};
|
|
2520
|
+
var VisualizationApiFactory = function(configuration, basePath, axios2) {
|
|
2521
|
+
const localVarFp = VisualizationApiFp(configuration);
|
|
2522
|
+
return {
|
|
2523
|
+
/**
|
|
2524
|
+
*
|
|
2525
|
+
* @summary Create an image from a visualization
|
|
2526
|
+
* @param {Visualization} visualization
|
|
2527
|
+
* @param {'high' | 'low'} [priority] Priority of the visualization image request
|
|
2528
|
+
* @param {*} [options] Override http request option.
|
|
2529
|
+
* @throws {RequiredError}
|
|
2530
|
+
*/
|
|
2531
|
+
createVisualization(visualization, priority, options) {
|
|
2532
|
+
return localVarFp.createVisualization(visualization, priority, options).then((request) => request(axios2, basePath));
|
|
2533
|
+
}
|
|
2534
|
+
};
|
|
2535
|
+
};
|
|
2536
|
+
var VisualizationApi = class extends BaseAPI {
|
|
2537
|
+
/**
|
|
2538
|
+
*
|
|
2539
|
+
* @summary Create an image from a visualization
|
|
2540
|
+
* @param {Visualization} visualization
|
|
2541
|
+
* @param {'high' | 'low'} [priority] Priority of the visualization image request
|
|
2542
|
+
* @param {*} [options] Override http request option.
|
|
2543
|
+
* @throws {RequiredError}
|
|
2544
|
+
* @memberof VisualizationApi
|
|
2545
|
+
*/
|
|
2546
|
+
createVisualization(visualization, priority, options) {
|
|
2547
|
+
return VisualizationApiFp(this.configuration).createVisualization(visualization, priority, options).then((request) => request(this.axios, this.basePath));
|
|
2548
|
+
}
|
|
2549
|
+
};
|
|
2016
2550
|
|
|
2017
2551
|
// configuration.ts
|
|
2018
2552
|
var Configuration = class {
|
|
@@ -2268,6 +2802,50 @@ var ConnectReport = class {
|
|
|
2268
2802
|
};
|
|
2269
2803
|
globalThis.ConnectReport = ConnectReport;
|
|
2270
2804
|
export {
|
|
2271
|
-
|
|
2805
|
+
BaseTemplatesApi,
|
|
2806
|
+
BaseTemplatesApiAxiosParamCreator,
|
|
2807
|
+
BaseTemplatesApiFactory,
|
|
2808
|
+
BaseTemplatesApiFp,
|
|
2809
|
+
ConnectReport,
|
|
2810
|
+
DocumentsApi,
|
|
2811
|
+
DocumentsApiAxiosParamCreator,
|
|
2812
|
+
DocumentsApiFactory,
|
|
2813
|
+
DocumentsApiFp,
|
|
2814
|
+
FilterCycleEmailEnum,
|
|
2815
|
+
FilterCycleFrequencyEnum,
|
|
2816
|
+
FilterCyclesApi,
|
|
2817
|
+
FilterCyclesApiAxiosParamCreator,
|
|
2818
|
+
FilterCyclesApiFactory,
|
|
2819
|
+
FilterCyclesApiFp,
|
|
2820
|
+
ImagesApi,
|
|
2821
|
+
ImagesApiAxiosParamCreator,
|
|
2822
|
+
ImagesApiFactory,
|
|
2823
|
+
ImagesApiFp,
|
|
2824
|
+
JobsApi,
|
|
2825
|
+
JobsApiAxiosParamCreator,
|
|
2826
|
+
JobsApiFactory,
|
|
2827
|
+
JobsApiFp,
|
|
2828
|
+
ReportTaskEmailEnum,
|
|
2829
|
+
ReportTaskFrequencyEnum,
|
|
2830
|
+
ReportTaskRequestEmailEnum,
|
|
2831
|
+
ReportTaskRequestFrequencyEnum,
|
|
2832
|
+
ReportTaskResponseEmailEnum,
|
|
2833
|
+
ReportTaskResponseFrequencyEnum,
|
|
2834
|
+
ReportTasksApi,
|
|
2835
|
+
ReportTasksApiAxiosParamCreator,
|
|
2836
|
+
ReportTasksApiFactory,
|
|
2837
|
+
ReportTasksApiFp,
|
|
2838
|
+
ReportsApi,
|
|
2839
|
+
ReportsApiAxiosParamCreator,
|
|
2840
|
+
ReportsApiFactory,
|
|
2841
|
+
ReportsApiFp,
|
|
2842
|
+
TemplatesApi,
|
|
2843
|
+
TemplatesApiAxiosParamCreator,
|
|
2844
|
+
TemplatesApiFactory,
|
|
2845
|
+
TemplatesApiFp,
|
|
2846
|
+
VisualizationApi,
|
|
2847
|
+
VisualizationApiAxiosParamCreator,
|
|
2848
|
+
VisualizationApiFactory,
|
|
2849
|
+
VisualizationApiFp
|
|
2272
2850
|
};
|
|
2273
2851
|
//# sourceMappingURL=index.js.map
|