@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.cjs
CHANGED
|
@@ -73,7 +73,51 @@ var require_is_retry_allowed = __commonJS({
|
|
|
73
73
|
// index.ts
|
|
74
74
|
var index_exports = {};
|
|
75
75
|
__export(index_exports, {
|
|
76
|
-
|
|
76
|
+
BaseTemplatesApi: () => BaseTemplatesApi,
|
|
77
|
+
BaseTemplatesApiAxiosParamCreator: () => BaseTemplatesApiAxiosParamCreator,
|
|
78
|
+
BaseTemplatesApiFactory: () => BaseTemplatesApiFactory,
|
|
79
|
+
BaseTemplatesApiFp: () => BaseTemplatesApiFp,
|
|
80
|
+
ConnectReport: () => ConnectReport,
|
|
81
|
+
DocumentsApi: () => DocumentsApi,
|
|
82
|
+
DocumentsApiAxiosParamCreator: () => DocumentsApiAxiosParamCreator,
|
|
83
|
+
DocumentsApiFactory: () => DocumentsApiFactory,
|
|
84
|
+
DocumentsApiFp: () => DocumentsApiFp,
|
|
85
|
+
FilterCycleEmailEnum: () => FilterCycleEmailEnum,
|
|
86
|
+
FilterCycleFrequencyEnum: () => FilterCycleFrequencyEnum,
|
|
87
|
+
FilterCyclesApi: () => FilterCyclesApi,
|
|
88
|
+
FilterCyclesApiAxiosParamCreator: () => FilterCyclesApiAxiosParamCreator,
|
|
89
|
+
FilterCyclesApiFactory: () => FilterCyclesApiFactory,
|
|
90
|
+
FilterCyclesApiFp: () => FilterCyclesApiFp,
|
|
91
|
+
ImagesApi: () => ImagesApi,
|
|
92
|
+
ImagesApiAxiosParamCreator: () => ImagesApiAxiosParamCreator,
|
|
93
|
+
ImagesApiFactory: () => ImagesApiFactory,
|
|
94
|
+
ImagesApiFp: () => ImagesApiFp,
|
|
95
|
+
JobsApi: () => JobsApi,
|
|
96
|
+
JobsApiAxiosParamCreator: () => JobsApiAxiosParamCreator,
|
|
97
|
+
JobsApiFactory: () => JobsApiFactory,
|
|
98
|
+
JobsApiFp: () => JobsApiFp,
|
|
99
|
+
ReportTaskEmailEnum: () => ReportTaskEmailEnum,
|
|
100
|
+
ReportTaskFrequencyEnum: () => ReportTaskFrequencyEnum,
|
|
101
|
+
ReportTaskRequestEmailEnum: () => ReportTaskRequestEmailEnum,
|
|
102
|
+
ReportTaskRequestFrequencyEnum: () => ReportTaskRequestFrequencyEnum,
|
|
103
|
+
ReportTaskResponseEmailEnum: () => ReportTaskResponseEmailEnum,
|
|
104
|
+
ReportTaskResponseFrequencyEnum: () => ReportTaskResponseFrequencyEnum,
|
|
105
|
+
ReportTasksApi: () => ReportTasksApi,
|
|
106
|
+
ReportTasksApiAxiosParamCreator: () => ReportTasksApiAxiosParamCreator,
|
|
107
|
+
ReportTasksApiFactory: () => ReportTasksApiFactory,
|
|
108
|
+
ReportTasksApiFp: () => ReportTasksApiFp,
|
|
109
|
+
ReportsApi: () => ReportsApi,
|
|
110
|
+
ReportsApiAxiosParamCreator: () => ReportsApiAxiosParamCreator,
|
|
111
|
+
ReportsApiFactory: () => ReportsApiFactory,
|
|
112
|
+
ReportsApiFp: () => ReportsApiFp,
|
|
113
|
+
TemplatesApi: () => TemplatesApi,
|
|
114
|
+
TemplatesApiAxiosParamCreator: () => TemplatesApiAxiosParamCreator,
|
|
115
|
+
TemplatesApiFactory: () => TemplatesApiFactory,
|
|
116
|
+
TemplatesApiFp: () => TemplatesApiFp,
|
|
117
|
+
VisualizationApi: () => VisualizationApi,
|
|
118
|
+
VisualizationApiAxiosParamCreator: () => VisualizationApiAxiosParamCreator,
|
|
119
|
+
VisualizationApiFactory: () => VisualizationApiFactory,
|
|
120
|
+
VisualizationApiFp: () => VisualizationApiFp
|
|
77
121
|
});
|
|
78
122
|
module.exports = __toCommonJS(index_exports);
|
|
79
123
|
|
|
@@ -152,6 +196,74 @@ var createRequestFunction = function(axiosArgs, globalAxios3, BASE_PATH2, config
|
|
|
152
196
|
};
|
|
153
197
|
|
|
154
198
|
// api.ts
|
|
199
|
+
var FilterCycleFrequencyEnum = /* @__PURE__ */ ((FilterCycleFrequencyEnum2) => {
|
|
200
|
+
FilterCycleFrequencyEnum2["Monthly"] = "Monthly";
|
|
201
|
+
FilterCycleFrequencyEnum2["OnceNow"] = "Once - now";
|
|
202
|
+
FilterCycleFrequencyEnum2["OnceScheduled"] = "Once - scheduled";
|
|
203
|
+
FilterCycleFrequencyEnum2["Annually"] = "Annually";
|
|
204
|
+
FilterCycleFrequencyEnum2["Daily"] = "Daily";
|
|
205
|
+
FilterCycleFrequencyEnum2["Weekly"] = "Weekly";
|
|
206
|
+
FilterCycleFrequencyEnum2["UponTrigger"] = "Upon trigger";
|
|
207
|
+
return FilterCycleFrequencyEnum2;
|
|
208
|
+
})(FilterCycleFrequencyEnum || {});
|
|
209
|
+
var FilterCycleEmailEnum = /* @__PURE__ */ ((FilterCycleEmailEnum2) => {
|
|
210
|
+
FilterCycleEmailEnum2["Pdf"] = "pdf";
|
|
211
|
+
FilterCycleEmailEnum2["Pptx"] = "pptx";
|
|
212
|
+
FilterCycleEmailEnum2["Xlsx"] = "xlsx";
|
|
213
|
+
FilterCycleEmailEnum2["Csv"] = "csv";
|
|
214
|
+
return FilterCycleEmailEnum2;
|
|
215
|
+
})(FilterCycleEmailEnum || {});
|
|
216
|
+
var ReportTaskFrequencyEnum = /* @__PURE__ */ ((ReportTaskFrequencyEnum2) => {
|
|
217
|
+
ReportTaskFrequencyEnum2["Monthly"] = "Monthly";
|
|
218
|
+
ReportTaskFrequencyEnum2["OnceNow"] = "Once - now";
|
|
219
|
+
ReportTaskFrequencyEnum2["OnceScheduled"] = "Once - scheduled";
|
|
220
|
+
ReportTaskFrequencyEnum2["Annually"] = "Annually";
|
|
221
|
+
ReportTaskFrequencyEnum2["Daily"] = "Daily";
|
|
222
|
+
ReportTaskFrequencyEnum2["Weekly"] = "Weekly";
|
|
223
|
+
ReportTaskFrequencyEnum2["UponTrigger"] = "Upon trigger";
|
|
224
|
+
return ReportTaskFrequencyEnum2;
|
|
225
|
+
})(ReportTaskFrequencyEnum || {});
|
|
226
|
+
var ReportTaskEmailEnum = /* @__PURE__ */ ((ReportTaskEmailEnum2) => {
|
|
227
|
+
ReportTaskEmailEnum2["Pdf"] = "pdf";
|
|
228
|
+
ReportTaskEmailEnum2["Pptx"] = "pptx";
|
|
229
|
+
ReportTaskEmailEnum2["Xlsx"] = "xlsx";
|
|
230
|
+
ReportTaskEmailEnum2["Csv"] = "csv";
|
|
231
|
+
return ReportTaskEmailEnum2;
|
|
232
|
+
})(ReportTaskEmailEnum || {});
|
|
233
|
+
var ReportTaskRequestFrequencyEnum = /* @__PURE__ */ ((ReportTaskRequestFrequencyEnum2) => {
|
|
234
|
+
ReportTaskRequestFrequencyEnum2["Monthly"] = "Monthly";
|
|
235
|
+
ReportTaskRequestFrequencyEnum2["OnceNow"] = "Once - now";
|
|
236
|
+
ReportTaskRequestFrequencyEnum2["OnceScheduled"] = "Once - scheduled";
|
|
237
|
+
ReportTaskRequestFrequencyEnum2["Annually"] = "Annually";
|
|
238
|
+
ReportTaskRequestFrequencyEnum2["Daily"] = "Daily";
|
|
239
|
+
ReportTaskRequestFrequencyEnum2["Weekly"] = "Weekly";
|
|
240
|
+
ReportTaskRequestFrequencyEnum2["UponTrigger"] = "Upon trigger";
|
|
241
|
+
return ReportTaskRequestFrequencyEnum2;
|
|
242
|
+
})(ReportTaskRequestFrequencyEnum || {});
|
|
243
|
+
var ReportTaskRequestEmailEnum = /* @__PURE__ */ ((ReportTaskRequestEmailEnum2) => {
|
|
244
|
+
ReportTaskRequestEmailEnum2["Pdf"] = "pdf";
|
|
245
|
+
ReportTaskRequestEmailEnum2["Pptx"] = "pptx";
|
|
246
|
+
ReportTaskRequestEmailEnum2["Xlsx"] = "xlsx";
|
|
247
|
+
ReportTaskRequestEmailEnum2["Csv"] = "csv";
|
|
248
|
+
return ReportTaskRequestEmailEnum2;
|
|
249
|
+
})(ReportTaskRequestEmailEnum || {});
|
|
250
|
+
var ReportTaskResponseFrequencyEnum = /* @__PURE__ */ ((ReportTaskResponseFrequencyEnum2) => {
|
|
251
|
+
ReportTaskResponseFrequencyEnum2["Monthly"] = "Monthly";
|
|
252
|
+
ReportTaskResponseFrequencyEnum2["OnceNow"] = "Once - now";
|
|
253
|
+
ReportTaskResponseFrequencyEnum2["OnceScheduled"] = "Once - scheduled";
|
|
254
|
+
ReportTaskResponseFrequencyEnum2["Annually"] = "Annually";
|
|
255
|
+
ReportTaskResponseFrequencyEnum2["Daily"] = "Daily";
|
|
256
|
+
ReportTaskResponseFrequencyEnum2["Weekly"] = "Weekly";
|
|
257
|
+
ReportTaskResponseFrequencyEnum2["UponTrigger"] = "Upon trigger";
|
|
258
|
+
return ReportTaskResponseFrequencyEnum2;
|
|
259
|
+
})(ReportTaskResponseFrequencyEnum || {});
|
|
260
|
+
var ReportTaskResponseEmailEnum = /* @__PURE__ */ ((ReportTaskResponseEmailEnum2) => {
|
|
261
|
+
ReportTaskResponseEmailEnum2["Pdf"] = "pdf";
|
|
262
|
+
ReportTaskResponseEmailEnum2["Pptx"] = "pptx";
|
|
263
|
+
ReportTaskResponseEmailEnum2["Xlsx"] = "xlsx";
|
|
264
|
+
ReportTaskResponseEmailEnum2["Csv"] = "csv";
|
|
265
|
+
return ReportTaskResponseEmailEnum2;
|
|
266
|
+
})(ReportTaskResponseEmailEnum || {});
|
|
155
267
|
var BaseTemplatesApiAxiosParamCreator = function(configuration) {
|
|
156
268
|
return {
|
|
157
269
|
/**
|
|
@@ -248,6 +360,32 @@ var BaseTemplatesApiFp = function(configuration) {
|
|
|
248
360
|
}
|
|
249
361
|
};
|
|
250
362
|
};
|
|
363
|
+
var BaseTemplatesApiFactory = function(configuration, basePath, axios2) {
|
|
364
|
+
const localVarFp = BaseTemplatesApiFp(configuration);
|
|
365
|
+
return {
|
|
366
|
+
/**
|
|
367
|
+
* Duplicate a base template by its ID
|
|
368
|
+
* @summary Duplicate a base template
|
|
369
|
+
* @param {string} id
|
|
370
|
+
* @param {*} [options] Override http request option.
|
|
371
|
+
* @throws {RequiredError}
|
|
372
|
+
*/
|
|
373
|
+
duplicateBaseTemplate(id, options) {
|
|
374
|
+
return localVarFp.duplicateBaseTemplate(id, options).then((request) => request(axios2, basePath));
|
|
375
|
+
},
|
|
376
|
+
/**
|
|
377
|
+
*
|
|
378
|
+
* @summary List base templates
|
|
379
|
+
* @param {number} [pageNum]
|
|
380
|
+
* @param {number} [page]
|
|
381
|
+
* @param {*} [options] Override http request option.
|
|
382
|
+
* @throws {RequiredError}
|
|
383
|
+
*/
|
|
384
|
+
getBaseTemplates(pageNum, page, options) {
|
|
385
|
+
return localVarFp.getBaseTemplates(pageNum, page, options).then((request) => request(axios2, basePath));
|
|
386
|
+
}
|
|
387
|
+
};
|
|
388
|
+
};
|
|
251
389
|
var BaseTemplatesApi = class extends BaseAPI {
|
|
252
390
|
/**
|
|
253
391
|
* Duplicate a base template by its ID
|
|
@@ -330,6 +468,23 @@ var DocumentsApiFp = function(configuration) {
|
|
|
330
468
|
}
|
|
331
469
|
};
|
|
332
470
|
};
|
|
471
|
+
var DocumentsApiFactory = function(configuration, basePath, axios2) {
|
|
472
|
+
const localVarFp = DocumentsApiFp(configuration);
|
|
473
|
+
return {
|
|
474
|
+
/**
|
|
475
|
+
*
|
|
476
|
+
* @summary Retrieve a generated document
|
|
477
|
+
* @param {string} fileName
|
|
478
|
+
* @param {'pdf' | 'pptx' | 'xlsx' | 'csv'} fileType
|
|
479
|
+
* @param {string} [attachmentName] A document file title. This value is reflected back to the client in the fileName header.
|
|
480
|
+
* @param {*} [options] Override http request option.
|
|
481
|
+
* @throws {RequiredError}
|
|
482
|
+
*/
|
|
483
|
+
getDocument(fileName, fileType, attachmentName, options) {
|
|
484
|
+
return localVarFp.getDocument(fileName, fileType, attachmentName, options).then((request) => request(axios2, basePath));
|
|
485
|
+
}
|
|
486
|
+
};
|
|
487
|
+
};
|
|
333
488
|
var DocumentsApi = class extends BaseAPI {
|
|
334
489
|
/**
|
|
335
490
|
*
|
|
@@ -644,6 +799,82 @@ var FilterCyclesApiFp = function(configuration) {
|
|
|
644
799
|
}
|
|
645
800
|
};
|
|
646
801
|
};
|
|
802
|
+
var FilterCyclesApiFactory = function(configuration, basePath, axios2) {
|
|
803
|
+
const localVarFp = FilterCyclesApiFp(configuration);
|
|
804
|
+
return {
|
|
805
|
+
/**
|
|
806
|
+
*
|
|
807
|
+
* @summary Create a filter cycle
|
|
808
|
+
* @param {FilterCycle} filterCycle
|
|
809
|
+
* @param {*} [options] Override http request option.
|
|
810
|
+
* @throws {RequiredError}
|
|
811
|
+
*/
|
|
812
|
+
createFilterCycle(filterCycle, options) {
|
|
813
|
+
return localVarFp.createFilterCycle(filterCycle, options).then((request) => request(axios2, basePath));
|
|
814
|
+
},
|
|
815
|
+
/**
|
|
816
|
+
*
|
|
817
|
+
* @summary Delete a filter cycle
|
|
818
|
+
* @param {string} id
|
|
819
|
+
* @param {*} [options] Override http request option.
|
|
820
|
+
* @throws {RequiredError}
|
|
821
|
+
*/
|
|
822
|
+
deleteFilterCycle(id, options) {
|
|
823
|
+
return localVarFp.deleteFilterCycle(id, options).then((request) => request(axios2, basePath));
|
|
824
|
+
},
|
|
825
|
+
/**
|
|
826
|
+
*
|
|
827
|
+
* @summary Disable all report tasks in a cycle
|
|
828
|
+
* @param {string} id
|
|
829
|
+
* @param {*} [options] Override http request option.
|
|
830
|
+
* @throws {RequiredError}
|
|
831
|
+
*/
|
|
832
|
+
disableAllInCycle(id, options) {
|
|
833
|
+
return localVarFp.disableAllInCycle(id, options).then((request) => request(axios2, basePath));
|
|
834
|
+
},
|
|
835
|
+
/**
|
|
836
|
+
*
|
|
837
|
+
* @summary Enable all report tasks in a cycle
|
|
838
|
+
* @param {string} id
|
|
839
|
+
* @param {*} [options] Override http request option.
|
|
840
|
+
* @throws {RequiredError}
|
|
841
|
+
*/
|
|
842
|
+
enableAllInCycle(id, options) {
|
|
843
|
+
return localVarFp.enableAllInCycle(id, options).then((request) => request(axios2, basePath));
|
|
844
|
+
},
|
|
845
|
+
/**
|
|
846
|
+
*
|
|
847
|
+
* @summary Get a filter cycle
|
|
848
|
+
* @param {string} id
|
|
849
|
+
* @param {*} [options] Override http request option.
|
|
850
|
+
* @throws {RequiredError}
|
|
851
|
+
*/
|
|
852
|
+
getFilterCycle(id, options) {
|
|
853
|
+
return localVarFp.getFilterCycle(id, options).then((request) => request(axios2, basePath));
|
|
854
|
+
},
|
|
855
|
+
/**
|
|
856
|
+
*
|
|
857
|
+
* @summary List filter cycles
|
|
858
|
+
* @param {string} templateId
|
|
859
|
+
* @param {*} [options] Override http request option.
|
|
860
|
+
* @throws {RequiredError}
|
|
861
|
+
*/
|
|
862
|
+
getFilterCycles(templateId, options) {
|
|
863
|
+
return localVarFp.getFilterCycles(templateId, options).then((request) => request(axios2, basePath));
|
|
864
|
+
},
|
|
865
|
+
/**
|
|
866
|
+
*
|
|
867
|
+
* @summary Update a filter cycle
|
|
868
|
+
* @param {string} id
|
|
869
|
+
* @param {FilterCycle} filterCycle
|
|
870
|
+
* @param {*} [options] Override http request option.
|
|
871
|
+
* @throws {RequiredError}
|
|
872
|
+
*/
|
|
873
|
+
updateFilterCycle(id, filterCycle, options) {
|
|
874
|
+
return localVarFp.updateFilterCycle(id, filterCycle, options).then((request) => request(axios2, basePath));
|
|
875
|
+
}
|
|
876
|
+
};
|
|
877
|
+
};
|
|
647
878
|
var FilterCyclesApi = class extends BaseAPI {
|
|
648
879
|
/**
|
|
649
880
|
*
|
|
@@ -821,6 +1052,31 @@ var ImagesApiFp = function(configuration) {
|
|
|
821
1052
|
}
|
|
822
1053
|
};
|
|
823
1054
|
};
|
|
1055
|
+
var ImagesApiFactory = function(configuration, basePath, axios2) {
|
|
1056
|
+
const localVarFp = ImagesApiFp(configuration);
|
|
1057
|
+
return {
|
|
1058
|
+
/**
|
|
1059
|
+
*
|
|
1060
|
+
* @summary Retrieves a user uploaded image for use in a template
|
|
1061
|
+
* @param {string} title
|
|
1062
|
+
* @param {*} [options] Override http request option.
|
|
1063
|
+
* @throws {RequiredError}
|
|
1064
|
+
*/
|
|
1065
|
+
getImage(title, options) {
|
|
1066
|
+
return localVarFp.getImage(title, options).then((request) => request(axios2, basePath));
|
|
1067
|
+
},
|
|
1068
|
+
/**
|
|
1069
|
+
* Uploads an image to the server for use in templates
|
|
1070
|
+
* @summary Upload an image for use in a template
|
|
1071
|
+
* @param {any} [image]
|
|
1072
|
+
* @param {*} [options] Override http request option.
|
|
1073
|
+
* @throws {RequiredError}
|
|
1074
|
+
*/
|
|
1075
|
+
uploadImage(image, options) {
|
|
1076
|
+
return localVarFp.uploadImage(image, options).then((request) => request(axios2, basePath));
|
|
1077
|
+
}
|
|
1078
|
+
};
|
|
1079
|
+
};
|
|
824
1080
|
var ImagesApi = class extends BaseAPI {
|
|
825
1081
|
/**
|
|
826
1082
|
*
|
|
@@ -894,6 +1150,21 @@ var JobsApiFp = function(configuration) {
|
|
|
894
1150
|
}
|
|
895
1151
|
};
|
|
896
1152
|
};
|
|
1153
|
+
var JobsApiFactory = function(configuration, basePath, axios2) {
|
|
1154
|
+
const localVarFp = JobsApiFp(configuration);
|
|
1155
|
+
return {
|
|
1156
|
+
/**
|
|
1157
|
+
* Get the status of a queued job, including its status and result if available.
|
|
1158
|
+
* @summary Get job
|
|
1159
|
+
* @param {string} id
|
|
1160
|
+
* @param {*} [options] Override http request option.
|
|
1161
|
+
* @throws {RequiredError}
|
|
1162
|
+
*/
|
|
1163
|
+
getJob(id, options) {
|
|
1164
|
+
return localVarFp.getJob(id, options).then((request) => request(axios2, basePath));
|
|
1165
|
+
}
|
|
1166
|
+
};
|
|
1167
|
+
};
|
|
897
1168
|
var JobsApi = class extends BaseAPI {
|
|
898
1169
|
/**
|
|
899
1170
|
* Get the status of a queued job, including its status and result if available.
|
|
@@ -1200,6 +1471,79 @@ var ReportTasksApiFp = function(configuration) {
|
|
|
1200
1471
|
}
|
|
1201
1472
|
};
|
|
1202
1473
|
};
|
|
1474
|
+
var ReportTasksApiFactory = function(configuration, basePath, axios2) {
|
|
1475
|
+
const localVarFp = ReportTasksApiFp(configuration);
|
|
1476
|
+
return {
|
|
1477
|
+
/**
|
|
1478
|
+
*
|
|
1479
|
+
* @summary Create report task
|
|
1480
|
+
* @param {ReportTaskRequest} reportTaskRequest
|
|
1481
|
+
* @param {*} [options] Override http request option.
|
|
1482
|
+
* @throws {RequiredError}
|
|
1483
|
+
*/
|
|
1484
|
+
createReportTask(reportTaskRequest, options) {
|
|
1485
|
+
return localVarFp.createReportTask(reportTaskRequest, options).then((request) => request(axios2, basePath));
|
|
1486
|
+
},
|
|
1487
|
+
/**
|
|
1488
|
+
* Delete a report task by its ID
|
|
1489
|
+
* @summary Delete report task
|
|
1490
|
+
* @param {string} id
|
|
1491
|
+
* @param {boolean} [deleteAssociatedReports]
|
|
1492
|
+
* @param {*} [options] Override http request option.
|
|
1493
|
+
* @throws {RequiredError}
|
|
1494
|
+
*/
|
|
1495
|
+
deleteReportTask(id, deleteAssociatedReports, options) {
|
|
1496
|
+
return localVarFp.deleteReportTask(id, deleteAssociatedReports, options).then((request) => request(axios2, basePath));
|
|
1497
|
+
},
|
|
1498
|
+
/**
|
|
1499
|
+
* Read a report task by its ID
|
|
1500
|
+
* @summary Read report task
|
|
1501
|
+
* @param {string} id
|
|
1502
|
+
* @param {*} [options] Override http request option.
|
|
1503
|
+
* @throws {RequiredError}
|
|
1504
|
+
*/
|
|
1505
|
+
getReportTask(id, options) {
|
|
1506
|
+
return localVarFp.getReportTask(id, options).then((request) => request(axios2, basePath));
|
|
1507
|
+
},
|
|
1508
|
+
/**
|
|
1509
|
+
*
|
|
1510
|
+
* @summary List report tasks
|
|
1511
|
+
* @param {number} [pageNum]
|
|
1512
|
+
* @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
|
+
* @param {string} [templateId]
|
|
1514
|
+
* @param {number} [perPage]
|
|
1515
|
+
* @param {'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId'} [orderBy]
|
|
1516
|
+
* @param {'asc' | 'desc'} [order] The order to retrieve the logs in
|
|
1517
|
+
* @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\" } ```
|
|
1518
|
+
* @param {*} [options] Override http request option.
|
|
1519
|
+
* @throws {RequiredError}
|
|
1520
|
+
*/
|
|
1521
|
+
getReportTasks(pageNum, meta, templateId, perPage, orderBy, order, filter, options) {
|
|
1522
|
+
return localVarFp.getReportTasks(pageNum, meta, templateId, perPage, orderBy, order, filter, options).then((request) => request(axios2, basePath));
|
|
1523
|
+
},
|
|
1524
|
+
/**
|
|
1525
|
+
* Duplicates the task and runs it as \"Once - Now\"
|
|
1526
|
+
* @summary Run task now
|
|
1527
|
+
* @param {string} id
|
|
1528
|
+
* @param {*} [options] Override http request option.
|
|
1529
|
+
* @throws {RequiredError}
|
|
1530
|
+
*/
|
|
1531
|
+
runReportTaskNow(id, options) {
|
|
1532
|
+
return localVarFp.runReportTaskNow(id, options).then((request) => request(axios2, basePath));
|
|
1533
|
+
},
|
|
1534
|
+
/**
|
|
1535
|
+
* Accepts partial updates
|
|
1536
|
+
* @summary Update report task by ID
|
|
1537
|
+
* @param {string} id
|
|
1538
|
+
* @param {ReportTaskRequest} reportTaskRequest
|
|
1539
|
+
* @param {*} [options] Override http request option.
|
|
1540
|
+
* @throws {RequiredError}
|
|
1541
|
+
*/
|
|
1542
|
+
updateReportTask(id, reportTaskRequest, options) {
|
|
1543
|
+
return localVarFp.updateReportTask(id, reportTaskRequest, options).then((request) => request(axios2, basePath));
|
|
1544
|
+
}
|
|
1545
|
+
};
|
|
1546
|
+
};
|
|
1203
1547
|
var ReportTasksApi = class extends BaseAPI {
|
|
1204
1548
|
/**
|
|
1205
1549
|
*
|
|
@@ -1478,6 +1822,57 @@ var ReportsApiFp = function(configuration) {
|
|
|
1478
1822
|
}
|
|
1479
1823
|
};
|
|
1480
1824
|
};
|
|
1825
|
+
var ReportsApiFactory = function(configuration, basePath, axios2) {
|
|
1826
|
+
const localVarFp = ReportsApiFp(configuration);
|
|
1827
|
+
return {
|
|
1828
|
+
/**
|
|
1829
|
+
*
|
|
1830
|
+
* @summary Delete a published report
|
|
1831
|
+
* @param {string} id
|
|
1832
|
+
* @param {*} [options] Override http request option.
|
|
1833
|
+
* @throws {RequiredError}
|
|
1834
|
+
*/
|
|
1835
|
+
deleteReport(id, options) {
|
|
1836
|
+
return localVarFp.deleteReport(id, options).then((request) => request(axios2, basePath));
|
|
1837
|
+
},
|
|
1838
|
+
/**
|
|
1839
|
+
*
|
|
1840
|
+
* @summary Get a published report
|
|
1841
|
+
* @param {string} id
|
|
1842
|
+
* @param {*} [options] Override http request option.
|
|
1843
|
+
* @throws {RequiredError}
|
|
1844
|
+
*/
|
|
1845
|
+
getReport(id, options) {
|
|
1846
|
+
return localVarFp.getReport(id, options).then((request) => request(axios2, basePath));
|
|
1847
|
+
},
|
|
1848
|
+
/**
|
|
1849
|
+
*
|
|
1850
|
+
* @summary List reports
|
|
1851
|
+
* @param {number} [pageNum]
|
|
1852
|
+
* @param {number} [perPage]
|
|
1853
|
+
* @param {'title' | 'createdAt'} [orderBy] The field to order the list of reports on
|
|
1854
|
+
* @param {'asc' | 'desc'} [order] The order to sort the list of reports on
|
|
1855
|
+
* @param {string} [tagId] A tagId to filter the list of reports on
|
|
1856
|
+
* @param {string} [reportTaskId] A reportId to filter the list of reports on
|
|
1857
|
+
* @param {*} [options] Override http request option.
|
|
1858
|
+
* @throws {RequiredError}
|
|
1859
|
+
*/
|
|
1860
|
+
getReports(pageNum, perPage, orderBy, order, tagId, reportTaskId, options) {
|
|
1861
|
+
return localVarFp.getReports(pageNum, perPage, orderBy, order, tagId, reportTaskId, options).then((request) => request(axios2, basePath));
|
|
1862
|
+
},
|
|
1863
|
+
/**
|
|
1864
|
+
*
|
|
1865
|
+
* @summary Render a published report
|
|
1866
|
+
* @param {string} id
|
|
1867
|
+
* @param {'pdf' | 'pptx' | 'xlsx' | 'csv'} format
|
|
1868
|
+
* @param {*} [options] Override http request option.
|
|
1869
|
+
* @throws {RequiredError}
|
|
1870
|
+
*/
|
|
1871
|
+
renderReport(id, format, options) {
|
|
1872
|
+
return localVarFp.renderReport(id, format, options).then((request) => request(axios2, basePath));
|
|
1873
|
+
}
|
|
1874
|
+
};
|
|
1875
|
+
};
|
|
1481
1876
|
var ReportsApi = class extends BaseAPI {
|
|
1482
1877
|
/**
|
|
1483
1878
|
*
|
|
@@ -1922,6 +2317,103 @@ var TemplatesApiFp = function(configuration) {
|
|
|
1922
2317
|
}
|
|
1923
2318
|
};
|
|
1924
2319
|
};
|
|
2320
|
+
var TemplatesApiFactory = function(configuration, basePath, axios2) {
|
|
2321
|
+
const localVarFp = TemplatesApiFp(configuration);
|
|
2322
|
+
return {
|
|
2323
|
+
/**
|
|
2324
|
+
*
|
|
2325
|
+
* @summary Create report template by ID
|
|
2326
|
+
* @param {Template} template
|
|
2327
|
+
* @param {*} [options] Override http request option.
|
|
2328
|
+
* @throws {RequiredError}
|
|
2329
|
+
*/
|
|
2330
|
+
createTemplate(template, options) {
|
|
2331
|
+
return localVarFp.createTemplate(template, options).then((request) => request(axios2, basePath));
|
|
2332
|
+
},
|
|
2333
|
+
/**
|
|
2334
|
+
* Delete a report template by its ID
|
|
2335
|
+
* @summary Delete report template
|
|
2336
|
+
* @param {string} id
|
|
2337
|
+
* @param {*} [options] Override http request option.
|
|
2338
|
+
* @throws {RequiredError}
|
|
2339
|
+
*/
|
|
2340
|
+
deleteTemplate(id, options) {
|
|
2341
|
+
return localVarFp.deleteTemplate(id, options).then((request) => request(axios2, basePath));
|
|
2342
|
+
},
|
|
2343
|
+
/**
|
|
2344
|
+
* Duplicate a report template by its ID
|
|
2345
|
+
* @summary Duplicate a report template
|
|
2346
|
+
* @param {string} id
|
|
2347
|
+
* @param {*} [options] Override http request option.
|
|
2348
|
+
* @throws {RequiredError}
|
|
2349
|
+
*/
|
|
2350
|
+
duplicateTemplate(id, options) {
|
|
2351
|
+
return localVarFp.duplicateTemplate(id, options).then((request) => request(axios2, basePath));
|
|
2352
|
+
},
|
|
2353
|
+
/**
|
|
2354
|
+
* Export a report template to a .CRPT file
|
|
2355
|
+
* @summary Export a report template
|
|
2356
|
+
* @param {string} id
|
|
2357
|
+
* @param {*} [options] Override http request option.
|
|
2358
|
+
* @throws {RequiredError}
|
|
2359
|
+
*/
|
|
2360
|
+
exportTemplate(id, options) {
|
|
2361
|
+
return localVarFp.exportTemplate(id, options).then((request) => request(axios2, basePath));
|
|
2362
|
+
},
|
|
2363
|
+
/**
|
|
2364
|
+
* Read a report template by its ID
|
|
2365
|
+
* @summary Read report template
|
|
2366
|
+
* @param {string} id
|
|
2367
|
+
* @param {*} [options] Override http request option.
|
|
2368
|
+
* @throws {RequiredError}
|
|
2369
|
+
*/
|
|
2370
|
+
getTemplate(id, options) {
|
|
2371
|
+
return localVarFp.getTemplate(id, options).then((request) => request(axios2, basePath));
|
|
2372
|
+
},
|
|
2373
|
+
/**
|
|
2374
|
+
*
|
|
2375
|
+
* @summary List report templates
|
|
2376
|
+
* @param {number} [pageNum]
|
|
2377
|
+
* @param {*} [options] Override http request option.
|
|
2378
|
+
* @throws {RequiredError}
|
|
2379
|
+
*/
|
|
2380
|
+
getTemplates(pageNum, options) {
|
|
2381
|
+
return localVarFp.getTemplates(pageNum, options).then((request) => request(axios2, basePath));
|
|
2382
|
+
},
|
|
2383
|
+
/**
|
|
2384
|
+
* Imports an exported .CRPT file
|
|
2385
|
+
* @summary Import a template
|
|
2386
|
+
* @param {any} [template]
|
|
2387
|
+
* @param {*} [options] Override http request option.
|
|
2388
|
+
* @throws {RequiredError}
|
|
2389
|
+
*/
|
|
2390
|
+
importTemplate(template, options) {
|
|
2391
|
+
return localVarFp.importTemplate(template, options).then((request) => request(axios2, basePath));
|
|
2392
|
+
},
|
|
2393
|
+
/**
|
|
2394
|
+
* Render a report template to PDF, PPTX, or XLSX. Responds with a job entity.
|
|
2395
|
+
* @summary Render a report template
|
|
2396
|
+
* @param {string} id
|
|
2397
|
+
* @param {'pdf' | 'pptx' | 'xlsx' | 'csv'} format
|
|
2398
|
+
* @param {*} [options] Override http request option.
|
|
2399
|
+
* @throws {RequiredError}
|
|
2400
|
+
*/
|
|
2401
|
+
renderTemplate(id, format, options) {
|
|
2402
|
+
return localVarFp.renderTemplate(id, format, options).then((request) => request(axios2, basePath));
|
|
2403
|
+
},
|
|
2404
|
+
/**
|
|
2405
|
+
* Accepts partial updates
|
|
2406
|
+
* @summary Update report template by ID
|
|
2407
|
+
* @param {string} id
|
|
2408
|
+
* @param {Template} template
|
|
2409
|
+
* @param {*} [options] Override http request option.
|
|
2410
|
+
* @throws {RequiredError}
|
|
2411
|
+
*/
|
|
2412
|
+
updateTemplate(id, template, options) {
|
|
2413
|
+
return localVarFp.updateTemplate(id, template, options).then((request) => request(axios2, basePath));
|
|
2414
|
+
}
|
|
2415
|
+
};
|
|
2416
|
+
};
|
|
1925
2417
|
var TemplatesApi = class extends BaseAPI {
|
|
1926
2418
|
/**
|
|
1927
2419
|
*
|
|
@@ -2025,6 +2517,92 @@ var TemplatesApi = class extends BaseAPI {
|
|
|
2025
2517
|
return TemplatesApiFp(this.configuration).updateTemplate(id, template, options).then((request) => request(this.axios, this.basePath));
|
|
2026
2518
|
}
|
|
2027
2519
|
};
|
|
2520
|
+
var VisualizationApiAxiosParamCreator = function(configuration) {
|
|
2521
|
+
return {
|
|
2522
|
+
/**
|
|
2523
|
+
*
|
|
2524
|
+
* @summary Create an image from a visualization
|
|
2525
|
+
* @param {Visualization} visualization
|
|
2526
|
+
* @param {'high' | 'low'} [priority] Priority of the visualization image request
|
|
2527
|
+
* @param {*} [options] Override http request option.
|
|
2528
|
+
* @throws {RequiredError}
|
|
2529
|
+
*/
|
|
2530
|
+
createVisualization: async (visualization, priority, options = {}) => {
|
|
2531
|
+
assertParamExists("createVisualization", "visualization", visualization);
|
|
2532
|
+
const localVarPath = `/visualizations`;
|
|
2533
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2534
|
+
let baseOptions;
|
|
2535
|
+
if (configuration) {
|
|
2536
|
+
baseOptions = configuration.baseOptions;
|
|
2537
|
+
}
|
|
2538
|
+
const localVarRequestOptions = { method: "POST", ...baseOptions, ...options };
|
|
2539
|
+
const localVarHeaderParameter = {};
|
|
2540
|
+
const localVarQueryParameter = {};
|
|
2541
|
+
await setApiKeyToObject(localVarHeaderParameter, "X-API-KEY", configuration);
|
|
2542
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2543
|
+
if (priority !== void 0) {
|
|
2544
|
+
localVarQueryParameter["priority"] = priority;
|
|
2545
|
+
}
|
|
2546
|
+
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
2547
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);
|
|
2548
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2549
|
+
let formHeaders = {};
|
|
2550
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...formHeaders, ...options.headers };
|
|
2551
|
+
localVarRequestOptions.data = serializeDataIfNeeded(visualization, localVarRequestOptions, configuration);
|
|
2552
|
+
return {
|
|
2553
|
+
url: toPathString(localVarUrlObj),
|
|
2554
|
+
options: localVarRequestOptions
|
|
2555
|
+
};
|
|
2556
|
+
}
|
|
2557
|
+
};
|
|
2558
|
+
};
|
|
2559
|
+
var VisualizationApiFp = function(configuration) {
|
|
2560
|
+
const localVarAxiosParamCreator = VisualizationApiAxiosParamCreator(configuration);
|
|
2561
|
+
return {
|
|
2562
|
+
/**
|
|
2563
|
+
*
|
|
2564
|
+
* @summary Create an image from a visualization
|
|
2565
|
+
* @param {Visualization} visualization
|
|
2566
|
+
* @param {'high' | 'low'} [priority] Priority of the visualization image request
|
|
2567
|
+
* @param {*} [options] Override http request option.
|
|
2568
|
+
* @throws {RequiredError}
|
|
2569
|
+
*/
|
|
2570
|
+
async createVisualization(visualization, priority, options) {
|
|
2571
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createVisualization(visualization, priority, options);
|
|
2572
|
+
return createRequestFunction(localVarAxiosArgs, import_axios2.default, BASE_PATH, configuration);
|
|
2573
|
+
}
|
|
2574
|
+
};
|
|
2575
|
+
};
|
|
2576
|
+
var VisualizationApiFactory = function(configuration, basePath, axios2) {
|
|
2577
|
+
const localVarFp = VisualizationApiFp(configuration);
|
|
2578
|
+
return {
|
|
2579
|
+
/**
|
|
2580
|
+
*
|
|
2581
|
+
* @summary Create an image from a visualization
|
|
2582
|
+
* @param {Visualization} visualization
|
|
2583
|
+
* @param {'high' | 'low'} [priority] Priority of the visualization image request
|
|
2584
|
+
* @param {*} [options] Override http request option.
|
|
2585
|
+
* @throws {RequiredError}
|
|
2586
|
+
*/
|
|
2587
|
+
createVisualization(visualization, priority, options) {
|
|
2588
|
+
return localVarFp.createVisualization(visualization, priority, options).then((request) => request(axios2, basePath));
|
|
2589
|
+
}
|
|
2590
|
+
};
|
|
2591
|
+
};
|
|
2592
|
+
var VisualizationApi = class extends BaseAPI {
|
|
2593
|
+
/**
|
|
2594
|
+
*
|
|
2595
|
+
* @summary Create an image from a visualization
|
|
2596
|
+
* @param {Visualization} visualization
|
|
2597
|
+
* @param {'high' | 'low'} [priority] Priority of the visualization image request
|
|
2598
|
+
* @param {*} [options] Override http request option.
|
|
2599
|
+
* @throws {RequiredError}
|
|
2600
|
+
* @memberof VisualizationApi
|
|
2601
|
+
*/
|
|
2602
|
+
createVisualization(visualization, priority, options) {
|
|
2603
|
+
return VisualizationApiFp(this.configuration).createVisualization(visualization, priority, options).then((request) => request(this.axios, this.basePath));
|
|
2604
|
+
}
|
|
2605
|
+
};
|
|
2028
2606
|
|
|
2029
2607
|
// configuration.ts
|
|
2030
2608
|
var Configuration = class {
|
|
@@ -2281,6 +2859,50 @@ var ConnectReport = class {
|
|
|
2281
2859
|
globalThis.ConnectReport = ConnectReport;
|
|
2282
2860
|
// Annotate the CommonJS export names for ESM import in node:
|
|
2283
2861
|
0 && (module.exports = {
|
|
2284
|
-
|
|
2862
|
+
BaseTemplatesApi,
|
|
2863
|
+
BaseTemplatesApiAxiosParamCreator,
|
|
2864
|
+
BaseTemplatesApiFactory,
|
|
2865
|
+
BaseTemplatesApiFp,
|
|
2866
|
+
ConnectReport,
|
|
2867
|
+
DocumentsApi,
|
|
2868
|
+
DocumentsApiAxiosParamCreator,
|
|
2869
|
+
DocumentsApiFactory,
|
|
2870
|
+
DocumentsApiFp,
|
|
2871
|
+
FilterCycleEmailEnum,
|
|
2872
|
+
FilterCycleFrequencyEnum,
|
|
2873
|
+
FilterCyclesApi,
|
|
2874
|
+
FilterCyclesApiAxiosParamCreator,
|
|
2875
|
+
FilterCyclesApiFactory,
|
|
2876
|
+
FilterCyclesApiFp,
|
|
2877
|
+
ImagesApi,
|
|
2878
|
+
ImagesApiAxiosParamCreator,
|
|
2879
|
+
ImagesApiFactory,
|
|
2880
|
+
ImagesApiFp,
|
|
2881
|
+
JobsApi,
|
|
2882
|
+
JobsApiAxiosParamCreator,
|
|
2883
|
+
JobsApiFactory,
|
|
2884
|
+
JobsApiFp,
|
|
2885
|
+
ReportTaskEmailEnum,
|
|
2886
|
+
ReportTaskFrequencyEnum,
|
|
2887
|
+
ReportTaskRequestEmailEnum,
|
|
2888
|
+
ReportTaskRequestFrequencyEnum,
|
|
2889
|
+
ReportTaskResponseEmailEnum,
|
|
2890
|
+
ReportTaskResponseFrequencyEnum,
|
|
2891
|
+
ReportTasksApi,
|
|
2892
|
+
ReportTasksApiAxiosParamCreator,
|
|
2893
|
+
ReportTasksApiFactory,
|
|
2894
|
+
ReportTasksApiFp,
|
|
2895
|
+
ReportsApi,
|
|
2896
|
+
ReportsApiAxiosParamCreator,
|
|
2897
|
+
ReportsApiFactory,
|
|
2898
|
+
ReportsApiFp,
|
|
2899
|
+
TemplatesApi,
|
|
2900
|
+
TemplatesApiAxiosParamCreator,
|
|
2901
|
+
TemplatesApiFactory,
|
|
2902
|
+
TemplatesApiFp,
|
|
2903
|
+
VisualizationApi,
|
|
2904
|
+
VisualizationApiAxiosParamCreator,
|
|
2905
|
+
VisualizationApiFactory,
|
|
2906
|
+
VisualizationApiFp
|
|
2285
2907
|
});
|
|
2286
2908
|
//# sourceMappingURL=index.cjs.map
|