@connectreport/connectreport-js 2.53.3 → 2.54.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 +3 -3
- package/api.ts +82 -98
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +64 -90
- package/dist/api.js +41 -29
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
## @connectreport/connectreport-js@2.
|
|
1
|
+
## @connectreport/connectreport-js@2.54.2
|
|
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)
|
|
5
|
-
- [Download bundle](https://connectreport.com/docs/assets/2.
|
|
5
|
+
- [Download bundle](https://connectreport.com/docs/assets/2.54.2/connectreport.js) for use in client side applications
|
|
6
6
|
|
|
7
7
|
Environment
|
|
8
8
|
* Node.js
|
|
@@ -38,7 +38,7 @@ navigate to the folder of your consuming project and run one of the following co
|
|
|
38
38
|
_published:_
|
|
39
39
|
|
|
40
40
|
```
|
|
41
|
-
npm install @connectreport/connectreport-js@2.
|
|
41
|
+
npm install @connectreport/connectreport-js@2.54.2 --save
|
|
42
42
|
```
|
|
43
43
|
|
|
44
44
|
_unPublished (not recommended):_
|
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.
|
|
7
|
+
* The version of the OpenAPI document: 2.54.2
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -38,19 +38,19 @@ export interface FilterCycle {
|
|
|
38
38
|
* @type {string}
|
|
39
39
|
* @memberof FilterCycle
|
|
40
40
|
*/
|
|
41
|
-
title
|
|
41
|
+
title: string;
|
|
42
42
|
/**
|
|
43
43
|
*
|
|
44
44
|
* @type {string}
|
|
45
45
|
* @memberof FilterCycle
|
|
46
46
|
*/
|
|
47
|
-
templateId
|
|
47
|
+
templateId: string;
|
|
48
48
|
/**
|
|
49
|
-
* Datetime in UTC when report task\'s schedule will
|
|
49
|
+
* Datetime in UTC when report task\'s schedule will execute
|
|
50
50
|
* @type {string}
|
|
51
51
|
* @memberof FilterCycle
|
|
52
52
|
*/
|
|
53
|
-
startOn
|
|
53
|
+
startOn: string;
|
|
54
54
|
/**
|
|
55
55
|
* Datetime in UTC when report task schedule will end
|
|
56
56
|
* @type {string}
|
|
@@ -62,19 +62,13 @@ export interface FilterCycle {
|
|
|
62
62
|
* @type {string}
|
|
63
63
|
* @memberof FilterCycle
|
|
64
64
|
*/
|
|
65
|
-
frequency
|
|
65
|
+
frequency: FilterCycleFrequencyEnum;
|
|
66
66
|
/**
|
|
67
|
-
*
|
|
68
|
-
* @type {string}
|
|
69
|
-
* @memberof FilterCycle
|
|
70
|
-
*/
|
|
71
|
-
every?: string;
|
|
72
|
-
/**
|
|
73
|
-
* Datetime in UTC when the report task will execute
|
|
74
|
-
* @type {string}
|
|
67
|
+
*
|
|
68
|
+
* @type {number | string}
|
|
75
69
|
* @memberof FilterCycle
|
|
76
70
|
*/
|
|
77
|
-
|
|
71
|
+
every?: number | string;
|
|
78
72
|
/**
|
|
79
73
|
* Denotes whether the report task will go into the report processing queue
|
|
80
74
|
* @type {boolean}
|
|
@@ -549,19 +543,19 @@ export interface ReportTask {
|
|
|
549
543
|
* @type {string}
|
|
550
544
|
* @memberof ReportTask
|
|
551
545
|
*/
|
|
552
|
-
title
|
|
546
|
+
title: string;
|
|
553
547
|
/**
|
|
554
548
|
*
|
|
555
549
|
* @type {string}
|
|
556
550
|
* @memberof ReportTask
|
|
557
551
|
*/
|
|
558
|
-
templateId
|
|
552
|
+
templateId: string;
|
|
559
553
|
/**
|
|
560
|
-
* Datetime in UTC when report task\'s schedule will
|
|
554
|
+
* Datetime in UTC when report task\'s schedule will execute
|
|
561
555
|
* @type {string}
|
|
562
556
|
* @memberof ReportTask
|
|
563
557
|
*/
|
|
564
|
-
startOn
|
|
558
|
+
startOn: string;
|
|
565
559
|
/**
|
|
566
560
|
* Datetime in UTC when report task schedule will end
|
|
567
561
|
* @type {string}
|
|
@@ -573,19 +567,13 @@ export interface ReportTask {
|
|
|
573
567
|
* @type {string}
|
|
574
568
|
* @memberof ReportTask
|
|
575
569
|
*/
|
|
576
|
-
frequency
|
|
570
|
+
frequency: ReportTaskFrequencyEnum;
|
|
577
571
|
/**
|
|
578
|
-
*
|
|
579
|
-
* @type {string}
|
|
580
|
-
* @memberof ReportTask
|
|
581
|
-
*/
|
|
582
|
-
every?: string;
|
|
583
|
-
/**
|
|
584
|
-
* Datetime in UTC when the report task will execute
|
|
585
|
-
* @type {string}
|
|
572
|
+
*
|
|
573
|
+
* @type {number | string}
|
|
586
574
|
* @memberof ReportTask
|
|
587
575
|
*/
|
|
588
|
-
|
|
576
|
+
every?: number | string;
|
|
589
577
|
/**
|
|
590
578
|
* Denotes whether the report task will go into the report processing queue
|
|
591
579
|
* @type {boolean}
|
|
@@ -782,19 +770,19 @@ export interface ReportTaskRequest {
|
|
|
782
770
|
* @type {string}
|
|
783
771
|
* @memberof ReportTaskRequest
|
|
784
772
|
*/
|
|
785
|
-
title
|
|
773
|
+
title: string;
|
|
786
774
|
/**
|
|
787
775
|
*
|
|
788
776
|
* @type {string}
|
|
789
777
|
* @memberof ReportTaskRequest
|
|
790
778
|
*/
|
|
791
|
-
templateId
|
|
779
|
+
templateId: string;
|
|
792
780
|
/**
|
|
793
|
-
* Datetime in UTC when report task\'s schedule will
|
|
781
|
+
* Datetime in UTC when report task\'s schedule will execute
|
|
794
782
|
* @type {string}
|
|
795
783
|
* @memberof ReportTaskRequest
|
|
796
784
|
*/
|
|
797
|
-
startOn
|
|
785
|
+
startOn: string;
|
|
798
786
|
/**
|
|
799
787
|
* Datetime in UTC when report task schedule will end
|
|
800
788
|
* @type {string}
|
|
@@ -806,19 +794,13 @@ export interface ReportTaskRequest {
|
|
|
806
794
|
* @type {string}
|
|
807
795
|
* @memberof ReportTaskRequest
|
|
808
796
|
*/
|
|
809
|
-
frequency
|
|
797
|
+
frequency: ReportTaskRequestFrequencyEnum;
|
|
810
798
|
/**
|
|
811
|
-
*
|
|
812
|
-
* @type {string}
|
|
813
|
-
* @memberof ReportTaskRequest
|
|
814
|
-
*/
|
|
815
|
-
every?: string;
|
|
816
|
-
/**
|
|
817
|
-
* Datetime in UTC when the report task will execute
|
|
818
|
-
* @type {string}
|
|
799
|
+
*
|
|
800
|
+
* @type {number | string}
|
|
819
801
|
* @memberof ReportTaskRequest
|
|
820
802
|
*/
|
|
821
|
-
|
|
803
|
+
every?: number | string;
|
|
822
804
|
/**
|
|
823
805
|
* Denotes whether the report task will go into the report processing queue
|
|
824
806
|
* @type {boolean}
|
|
@@ -995,19 +977,19 @@ export interface ReportTaskResponse {
|
|
|
995
977
|
* @type {string}
|
|
996
978
|
* @memberof ReportTaskResponse
|
|
997
979
|
*/
|
|
998
|
-
title
|
|
980
|
+
title: string;
|
|
999
981
|
/**
|
|
1000
982
|
*
|
|
1001
983
|
* @type {string}
|
|
1002
984
|
* @memberof ReportTaskResponse
|
|
1003
985
|
*/
|
|
1004
|
-
templateId
|
|
986
|
+
templateId: string;
|
|
1005
987
|
/**
|
|
1006
|
-
* Datetime in UTC when report task\'s schedule will
|
|
988
|
+
* Datetime in UTC when report task\'s schedule will execute
|
|
1007
989
|
* @type {string}
|
|
1008
990
|
* @memberof ReportTaskResponse
|
|
1009
991
|
*/
|
|
1010
|
-
startOn
|
|
992
|
+
startOn: string;
|
|
1011
993
|
/**
|
|
1012
994
|
* Datetime in UTC when report task schedule will end
|
|
1013
995
|
* @type {string}
|
|
@@ -1019,19 +1001,13 @@ export interface ReportTaskResponse {
|
|
|
1019
1001
|
* @type {string}
|
|
1020
1002
|
* @memberof ReportTaskResponse
|
|
1021
1003
|
*/
|
|
1022
|
-
frequency
|
|
1004
|
+
frequency: ReportTaskResponseFrequencyEnum;
|
|
1023
1005
|
/**
|
|
1024
|
-
*
|
|
1025
|
-
* @type {string}
|
|
1026
|
-
* @memberof ReportTaskResponse
|
|
1027
|
-
*/
|
|
1028
|
-
every?: string;
|
|
1029
|
-
/**
|
|
1030
|
-
* Datetime in UTC when the report task will execute
|
|
1031
|
-
* @type {string}
|
|
1006
|
+
*
|
|
1007
|
+
* @type {number | string}
|
|
1032
1008
|
* @memberof ReportTaskResponse
|
|
1033
1009
|
*/
|
|
1034
|
-
|
|
1010
|
+
every?: number | string;
|
|
1035
1011
|
/**
|
|
1036
1012
|
* Denotes whether the report task will go into the report processing queue
|
|
1037
1013
|
* @type {boolean}
|
|
@@ -1228,42 +1204,26 @@ export interface Template {
|
|
|
1228
1204
|
* @type {string}
|
|
1229
1205
|
* @memberof Template
|
|
1230
1206
|
*/
|
|
1231
|
-
title
|
|
1207
|
+
title: string;
|
|
1232
1208
|
/**
|
|
1233
|
-
*
|
|
1234
|
-
* @type {string}
|
|
1235
|
-
* @memberof Template
|
|
1236
|
-
*/
|
|
1237
|
-
htmlContent?: string;
|
|
1238
|
-
/**
|
|
1239
|
-
*
|
|
1209
|
+
* HTML content of the template
|
|
1240
1210
|
* @type {string}
|
|
1241
1211
|
* @memberof Template
|
|
1242
1212
|
*/
|
|
1243
|
-
|
|
1213
|
+
htmlContent: string;
|
|
1244
1214
|
/**
|
|
1245
|
-
*
|
|
1215
|
+
* Width of the template in pixels
|
|
1246
1216
|
* @type {number}
|
|
1247
1217
|
* @memberof Template
|
|
1248
1218
|
*/
|
|
1249
|
-
pageWidth
|
|
1219
|
+
pageWidth: number;
|
|
1250
1220
|
/**
|
|
1251
|
-
*
|
|
1221
|
+
* Height of the template in pixels
|
|
1252
1222
|
* @type {number}
|
|
1253
1223
|
* @memberof Template
|
|
1254
1224
|
*/
|
|
1255
|
-
pageHeight
|
|
1256
|
-
}
|
|
1257
|
-
|
|
1258
|
-
/**
|
|
1259
|
-
* @export
|
|
1260
|
-
* @enum {string}
|
|
1261
|
-
*/
|
|
1262
|
-
export enum TemplatePlatformEnum {
|
|
1263
|
-
QlikSense = 'qlikSense',
|
|
1264
|
-
Tableau = 'tableau'
|
|
1225
|
+
pageHeight: number;
|
|
1265
1226
|
}
|
|
1266
|
-
|
|
1267
1227
|
/**
|
|
1268
1228
|
*
|
|
1269
1229
|
* @export
|
|
@@ -1381,10 +1341,12 @@ export const BaseTemplatesApiAxiosParamCreator = function (configuration?: Confi
|
|
|
1381
1341
|
/**
|
|
1382
1342
|
*
|
|
1383
1343
|
* @summary List base templates
|
|
1344
|
+
* @param {number} [pageNum]
|
|
1345
|
+
* @param {number} [page]
|
|
1384
1346
|
* @param {*} [options] Override http request option.
|
|
1385
1347
|
* @throws {RequiredError}
|
|
1386
1348
|
*/
|
|
1387
|
-
getBaseTemplates: async (options: any = {}): Promise<RequestArgs> => {
|
|
1349
|
+
getBaseTemplates: async (pageNum?: number, page?: number, options: any = {}): Promise<RequestArgs> => {
|
|
1388
1350
|
const localVarPath = `/base-templates`;
|
|
1389
1351
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1390
1352
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -1402,6 +1364,14 @@ export const BaseTemplatesApiAxiosParamCreator = function (configuration?: Confi
|
|
|
1402
1364
|
|
|
1403
1365
|
// authentication CookieAuth required
|
|
1404
1366
|
|
|
1367
|
+
if (pageNum !== undefined) {
|
|
1368
|
+
localVarQueryParameter['pageNum'] = pageNum;
|
|
1369
|
+
}
|
|
1370
|
+
|
|
1371
|
+
if (page !== undefined) {
|
|
1372
|
+
localVarQueryParameter['page'] = page;
|
|
1373
|
+
}
|
|
1374
|
+
|
|
1405
1375
|
|
|
1406
1376
|
|
|
1407
1377
|
setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);
|
|
@@ -1438,11 +1408,13 @@ export const BaseTemplatesApiFp = function(configuration?: Configuration) {
|
|
|
1438
1408
|
/**
|
|
1439
1409
|
*
|
|
1440
1410
|
* @summary List base templates
|
|
1411
|
+
* @param {number} [pageNum]
|
|
1412
|
+
* @param {number} [page]
|
|
1441
1413
|
* @param {*} [options] Override http request option.
|
|
1442
1414
|
* @throws {RequiredError}
|
|
1443
1415
|
*/
|
|
1444
|
-
async getBaseTemplates(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse200>> {
|
|
1445
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getBaseTemplates(options);
|
|
1416
|
+
async getBaseTemplates(pageNum?: number, page?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse200>> {
|
|
1417
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getBaseTemplates(pageNum, page, options);
|
|
1446
1418
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1447
1419
|
},
|
|
1448
1420
|
}
|
|
@@ -1468,11 +1440,13 @@ export const BaseTemplatesApiFactory = function (configuration?: Configuration,
|
|
|
1468
1440
|
/**
|
|
1469
1441
|
*
|
|
1470
1442
|
* @summary List base templates
|
|
1443
|
+
* @param {number} [pageNum]
|
|
1444
|
+
* @param {number} [page]
|
|
1471
1445
|
* @param {*} [options] Override http request option.
|
|
1472
1446
|
* @throws {RequiredError}
|
|
1473
1447
|
*/
|
|
1474
|
-
getBaseTemplates(options?: any): AxiosPromise<InlineResponse200> {
|
|
1475
|
-
return localVarFp.getBaseTemplates(options).then((request) => request(axios, basePath));
|
|
1448
|
+
getBaseTemplates(pageNum?: number, page?: number, options?: any): AxiosPromise<InlineResponse200> {
|
|
1449
|
+
return localVarFp.getBaseTemplates(pageNum, page, options).then((request) => request(axios, basePath));
|
|
1476
1450
|
},
|
|
1477
1451
|
};
|
|
1478
1452
|
};
|
|
@@ -1499,12 +1473,14 @@ export class BaseTemplatesApi extends BaseAPI {
|
|
|
1499
1473
|
/**
|
|
1500
1474
|
*
|
|
1501
1475
|
* @summary List base templates
|
|
1476
|
+
* @param {number} [pageNum]
|
|
1477
|
+
* @param {number} [page]
|
|
1502
1478
|
* @param {*} [options] Override http request option.
|
|
1503
1479
|
* @throws {RequiredError}
|
|
1504
1480
|
* @memberof BaseTemplatesApi
|
|
1505
1481
|
*/
|
|
1506
|
-
public getBaseTemplates(options?: any) {
|
|
1507
|
-
return BaseTemplatesApiFp(this.configuration).getBaseTemplates(options).then((request) => request(this.axios, this.basePath));
|
|
1482
|
+
public getBaseTemplates(pageNum?: number, page?: number, options?: any) {
|
|
1483
|
+
return BaseTemplatesApiFp(this.configuration).getBaseTemplates(pageNum, page, options).then((request) => request(this.axios, this.basePath));
|
|
1508
1484
|
}
|
|
1509
1485
|
}
|
|
1510
1486
|
|
|
@@ -2492,7 +2468,7 @@ export const ReportTasksApiAxiosParamCreator = function (configuration?: Configu
|
|
|
2492
2468
|
*
|
|
2493
2469
|
* @summary List report tasks
|
|
2494
2470
|
* @param {number} [pageNum]
|
|
2495
|
-
* @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.
|
|
2471
|
+
* @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.
|
|
2496
2472
|
* @param {string} [templateId]
|
|
2497
2473
|
* @param {number} [perPage]
|
|
2498
2474
|
* @param {*} [options] Override http request option.
|
|
@@ -2638,7 +2614,7 @@ export const ReportTasksApiFp = function(configuration?: Configuration) {
|
|
|
2638
2614
|
*
|
|
2639
2615
|
* @summary List report tasks
|
|
2640
2616
|
* @param {number} [pageNum]
|
|
2641
|
-
* @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.
|
|
2617
|
+
* @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.
|
|
2642
2618
|
* @param {string} [templateId]
|
|
2643
2619
|
* @param {number} [perPage]
|
|
2644
2620
|
* @param {*} [options] Override http request option.
|
|
@@ -2705,7 +2681,7 @@ export const ReportTasksApiFactory = function (configuration?: Configuration, ba
|
|
|
2705
2681
|
*
|
|
2706
2682
|
* @summary List report tasks
|
|
2707
2683
|
* @param {number} [pageNum]
|
|
2708
|
-
* @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.
|
|
2684
|
+
* @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.
|
|
2709
2685
|
* @param {string} [templateId]
|
|
2710
2686
|
* @param {number} [perPage]
|
|
2711
2687
|
* @param {*} [options] Override http request option.
|
|
@@ -2776,7 +2752,7 @@ export class ReportTasksApi extends BaseAPI {
|
|
|
2776
2752
|
*
|
|
2777
2753
|
* @summary List report tasks
|
|
2778
2754
|
* @param {number} [pageNum]
|
|
2779
|
-
* @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.
|
|
2755
|
+
* @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.
|
|
2780
2756
|
* @param {string} [templateId]
|
|
2781
2757
|
* @param {number} [perPage]
|
|
2782
2758
|
* @param {*} [options] Override http request option.
|
|
@@ -3894,10 +3870,11 @@ export const VisualizationApiAxiosParamCreator = function (configuration?: Confi
|
|
|
3894
3870
|
*
|
|
3895
3871
|
* @summary Create an image from a visualization
|
|
3896
3872
|
* @param {Visualization} visualization
|
|
3873
|
+
* @param {'high' | 'low'} [priority] Priority of the visualization image request
|
|
3897
3874
|
* @param {*} [options] Override http request option.
|
|
3898
3875
|
* @throws {RequiredError}
|
|
3899
3876
|
*/
|
|
3900
|
-
createVisualization: async (visualization: Visualization, options: any = {}): Promise<RequestArgs> => {
|
|
3877
|
+
createVisualization: async (visualization: Visualization, priority?: 'high' | 'low', options: any = {}): Promise<RequestArgs> => {
|
|
3901
3878
|
// verify required parameter 'visualization' is not null or undefined
|
|
3902
3879
|
assertParamExists('createVisualization', 'visualization', visualization)
|
|
3903
3880
|
const localVarPath = `/visualizations`;
|
|
@@ -3917,6 +3894,10 @@ export const VisualizationApiAxiosParamCreator = function (configuration?: Confi
|
|
|
3917
3894
|
|
|
3918
3895
|
// authentication CookieAuth required
|
|
3919
3896
|
|
|
3897
|
+
if (priority !== undefined) {
|
|
3898
|
+
localVarQueryParameter['priority'] = priority;
|
|
3899
|
+
}
|
|
3900
|
+
|
|
3920
3901
|
|
|
3921
3902
|
|
|
3922
3903
|
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
@@ -3946,11 +3927,12 @@ export const VisualizationApiFp = function(configuration?: Configuration) {
|
|
|
3946
3927
|
*
|
|
3947
3928
|
* @summary Create an image from a visualization
|
|
3948
3929
|
* @param {Visualization} visualization
|
|
3930
|
+
* @param {'high' | 'low'} [priority] Priority of the visualization image request
|
|
3949
3931
|
* @param {*} [options] Override http request option.
|
|
3950
3932
|
* @throws {RequiredError}
|
|
3951
3933
|
*/
|
|
3952
|
-
async createVisualization(visualization: Visualization, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
3953
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.createVisualization(visualization, options);
|
|
3934
|
+
async createVisualization(visualization: Visualization, priority?: 'high' | 'low', options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
3935
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createVisualization(visualization, priority, options);
|
|
3954
3936
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
3955
3937
|
},
|
|
3956
3938
|
}
|
|
@@ -3967,11 +3949,12 @@ export const VisualizationApiFactory = function (configuration?: Configuration,
|
|
|
3967
3949
|
*
|
|
3968
3950
|
* @summary Create an image from a visualization
|
|
3969
3951
|
* @param {Visualization} visualization
|
|
3952
|
+
* @param {'high' | 'low'} [priority] Priority of the visualization image request
|
|
3970
3953
|
* @param {*} [options] Override http request option.
|
|
3971
3954
|
* @throws {RequiredError}
|
|
3972
3955
|
*/
|
|
3973
|
-
createVisualization(visualization: Visualization, options?: any): AxiosPromise<void> {
|
|
3974
|
-
return localVarFp.createVisualization(visualization, options).then((request) => request(axios, basePath));
|
|
3956
|
+
createVisualization(visualization: Visualization, priority?: 'high' | 'low', options?: any): AxiosPromise<void> {
|
|
3957
|
+
return localVarFp.createVisualization(visualization, priority, options).then((request) => request(axios, basePath));
|
|
3975
3958
|
},
|
|
3976
3959
|
};
|
|
3977
3960
|
};
|
|
@@ -3987,12 +3970,13 @@ export class VisualizationApi extends BaseAPI {
|
|
|
3987
3970
|
*
|
|
3988
3971
|
* @summary Create an image from a visualization
|
|
3989
3972
|
* @param {Visualization} visualization
|
|
3973
|
+
* @param {'high' | 'low'} [priority] Priority of the visualization image request
|
|
3990
3974
|
* @param {*} [options] Override http request option.
|
|
3991
3975
|
* @throws {RequiredError}
|
|
3992
3976
|
* @memberof VisualizationApi
|
|
3993
3977
|
*/
|
|
3994
|
-
public createVisualization(visualization: Visualization, options?: any) {
|
|
3995
|
-
return VisualizationApiFp(this.configuration).createVisualization(visualization, options).then((request) => request(this.axios, this.basePath));
|
|
3978
|
+
public createVisualization(visualization: Visualization, priority?: 'high' | 'low', options?: any) {
|
|
3979
|
+
return VisualizationApiFp(this.configuration).createVisualization(visualization, priority, options).then((request) => request(this.axios, this.basePath));
|
|
3996
3980
|
}
|
|
3997
3981
|
}
|
|
3998
3982
|
|
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.
|
|
7
|
+
* The version of the OpenAPI document: 2.54.2
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
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.
|
|
7
|
+
* The version of the OpenAPI document: 2.54.2
|
|
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.
|
|
7
|
+
* The version of the OpenAPI document: 2.54.2
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* ConnectReport Core API
|
|
3
3
|
* Leverage core reporting, templating, and document automation capabilities of ConnectReport Server.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 2.
|
|
5
|
+
* The version of the OpenAPI document: 2.54.2
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -29,19 +29,19 @@ export interface FilterCycle {
|
|
|
29
29
|
* @type {string}
|
|
30
30
|
* @memberof FilterCycle
|
|
31
31
|
*/
|
|
32
|
-
title
|
|
32
|
+
title: string;
|
|
33
33
|
/**
|
|
34
34
|
*
|
|
35
35
|
* @type {string}
|
|
36
36
|
* @memberof FilterCycle
|
|
37
37
|
*/
|
|
38
|
-
templateId
|
|
38
|
+
templateId: string;
|
|
39
39
|
/**
|
|
40
|
-
* Datetime in UTC when report task\'s schedule will
|
|
40
|
+
* Datetime in UTC when report task\'s schedule will execute
|
|
41
41
|
* @type {string}
|
|
42
42
|
* @memberof FilterCycle
|
|
43
43
|
*/
|
|
44
|
-
startOn
|
|
44
|
+
startOn: string;
|
|
45
45
|
/**
|
|
46
46
|
* Datetime in UTC when report task schedule will end
|
|
47
47
|
* @type {string}
|
|
@@ -53,19 +53,13 @@ export interface FilterCycle {
|
|
|
53
53
|
* @type {string}
|
|
54
54
|
* @memberof FilterCycle
|
|
55
55
|
*/
|
|
56
|
-
frequency
|
|
57
|
-
/**
|
|
58
|
-
* The interval of the report task\'s schedule
|
|
59
|
-
* @type {string}
|
|
60
|
-
* @memberof FilterCycle
|
|
61
|
-
*/
|
|
62
|
-
every?: string;
|
|
56
|
+
frequency: FilterCycleFrequencyEnum;
|
|
63
57
|
/**
|
|
64
|
-
*
|
|
65
|
-
* @type {string}
|
|
58
|
+
*
|
|
59
|
+
* @type {number | string}
|
|
66
60
|
* @memberof FilterCycle
|
|
67
61
|
*/
|
|
68
|
-
|
|
62
|
+
every?: number | string;
|
|
69
63
|
/**
|
|
70
64
|
* Denotes whether the report task will go into the report processing queue
|
|
71
65
|
* @type {boolean}
|
|
@@ -540,19 +534,19 @@ export interface ReportTask {
|
|
|
540
534
|
* @type {string}
|
|
541
535
|
* @memberof ReportTask
|
|
542
536
|
*/
|
|
543
|
-
title
|
|
537
|
+
title: string;
|
|
544
538
|
/**
|
|
545
539
|
*
|
|
546
540
|
* @type {string}
|
|
547
541
|
* @memberof ReportTask
|
|
548
542
|
*/
|
|
549
|
-
templateId
|
|
543
|
+
templateId: string;
|
|
550
544
|
/**
|
|
551
|
-
* Datetime in UTC when report task\'s schedule will
|
|
545
|
+
* Datetime in UTC when report task\'s schedule will execute
|
|
552
546
|
* @type {string}
|
|
553
547
|
* @memberof ReportTask
|
|
554
548
|
*/
|
|
555
|
-
startOn
|
|
549
|
+
startOn: string;
|
|
556
550
|
/**
|
|
557
551
|
* Datetime in UTC when report task schedule will end
|
|
558
552
|
* @type {string}
|
|
@@ -564,19 +558,13 @@ export interface ReportTask {
|
|
|
564
558
|
* @type {string}
|
|
565
559
|
* @memberof ReportTask
|
|
566
560
|
*/
|
|
567
|
-
frequency
|
|
568
|
-
/**
|
|
569
|
-
* The interval of the report task\'s schedule
|
|
570
|
-
* @type {string}
|
|
571
|
-
* @memberof ReportTask
|
|
572
|
-
*/
|
|
573
|
-
every?: string;
|
|
561
|
+
frequency: ReportTaskFrequencyEnum;
|
|
574
562
|
/**
|
|
575
|
-
*
|
|
576
|
-
* @type {string}
|
|
563
|
+
*
|
|
564
|
+
* @type {number | string}
|
|
577
565
|
* @memberof ReportTask
|
|
578
566
|
*/
|
|
579
|
-
|
|
567
|
+
every?: number | string;
|
|
580
568
|
/**
|
|
581
569
|
* Denotes whether the report task will go into the report processing queue
|
|
582
570
|
* @type {boolean}
|
|
@@ -773,19 +761,19 @@ export interface ReportTaskRequest {
|
|
|
773
761
|
* @type {string}
|
|
774
762
|
* @memberof ReportTaskRequest
|
|
775
763
|
*/
|
|
776
|
-
title
|
|
764
|
+
title: string;
|
|
777
765
|
/**
|
|
778
766
|
*
|
|
779
767
|
* @type {string}
|
|
780
768
|
* @memberof ReportTaskRequest
|
|
781
769
|
*/
|
|
782
|
-
templateId
|
|
770
|
+
templateId: string;
|
|
783
771
|
/**
|
|
784
|
-
* Datetime in UTC when report task\'s schedule will
|
|
772
|
+
* Datetime in UTC when report task\'s schedule will execute
|
|
785
773
|
* @type {string}
|
|
786
774
|
* @memberof ReportTaskRequest
|
|
787
775
|
*/
|
|
788
|
-
startOn
|
|
776
|
+
startOn: string;
|
|
789
777
|
/**
|
|
790
778
|
* Datetime in UTC when report task schedule will end
|
|
791
779
|
* @type {string}
|
|
@@ -797,19 +785,13 @@ export interface ReportTaskRequest {
|
|
|
797
785
|
* @type {string}
|
|
798
786
|
* @memberof ReportTaskRequest
|
|
799
787
|
*/
|
|
800
|
-
frequency
|
|
788
|
+
frequency: ReportTaskRequestFrequencyEnum;
|
|
801
789
|
/**
|
|
802
|
-
*
|
|
803
|
-
* @type {string}
|
|
804
|
-
* @memberof ReportTaskRequest
|
|
805
|
-
*/
|
|
806
|
-
every?: string;
|
|
807
|
-
/**
|
|
808
|
-
* Datetime in UTC when the report task will execute
|
|
809
|
-
* @type {string}
|
|
790
|
+
*
|
|
791
|
+
* @type {number | string}
|
|
810
792
|
* @memberof ReportTaskRequest
|
|
811
793
|
*/
|
|
812
|
-
|
|
794
|
+
every?: number | string;
|
|
813
795
|
/**
|
|
814
796
|
* Denotes whether the report task will go into the report processing queue
|
|
815
797
|
* @type {boolean}
|
|
@@ -986,19 +968,19 @@ export interface ReportTaskResponse {
|
|
|
986
968
|
* @type {string}
|
|
987
969
|
* @memberof ReportTaskResponse
|
|
988
970
|
*/
|
|
989
|
-
title
|
|
971
|
+
title: string;
|
|
990
972
|
/**
|
|
991
973
|
*
|
|
992
974
|
* @type {string}
|
|
993
975
|
* @memberof ReportTaskResponse
|
|
994
976
|
*/
|
|
995
|
-
templateId
|
|
977
|
+
templateId: string;
|
|
996
978
|
/**
|
|
997
|
-
* Datetime in UTC when report task\'s schedule will
|
|
979
|
+
* Datetime in UTC when report task\'s schedule will execute
|
|
998
980
|
* @type {string}
|
|
999
981
|
* @memberof ReportTaskResponse
|
|
1000
982
|
*/
|
|
1001
|
-
startOn
|
|
983
|
+
startOn: string;
|
|
1002
984
|
/**
|
|
1003
985
|
* Datetime in UTC when report task schedule will end
|
|
1004
986
|
* @type {string}
|
|
@@ -1010,19 +992,13 @@ export interface ReportTaskResponse {
|
|
|
1010
992
|
* @type {string}
|
|
1011
993
|
* @memberof ReportTaskResponse
|
|
1012
994
|
*/
|
|
1013
|
-
frequency
|
|
1014
|
-
/**
|
|
1015
|
-
* The interval of the report task\'s schedule
|
|
1016
|
-
* @type {string}
|
|
1017
|
-
* @memberof ReportTaskResponse
|
|
1018
|
-
*/
|
|
1019
|
-
every?: string;
|
|
995
|
+
frequency: ReportTaskResponseFrequencyEnum;
|
|
1020
996
|
/**
|
|
1021
|
-
*
|
|
1022
|
-
* @type {string}
|
|
997
|
+
*
|
|
998
|
+
* @type {number | string}
|
|
1023
999
|
* @memberof ReportTaskResponse
|
|
1024
1000
|
*/
|
|
1025
|
-
|
|
1001
|
+
every?: number | string;
|
|
1026
1002
|
/**
|
|
1027
1003
|
* Denotes whether the report task will go into the report processing queue
|
|
1028
1004
|
* @type {boolean}
|
|
@@ -1219,39 +1195,25 @@ export interface Template {
|
|
|
1219
1195
|
* @type {string}
|
|
1220
1196
|
* @memberof Template
|
|
1221
1197
|
*/
|
|
1222
|
-
title
|
|
1223
|
-
/**
|
|
1224
|
-
*
|
|
1225
|
-
* @type {string}
|
|
1226
|
-
* @memberof Template
|
|
1227
|
-
*/
|
|
1228
|
-
htmlContent?: string;
|
|
1198
|
+
title: string;
|
|
1229
1199
|
/**
|
|
1230
|
-
*
|
|
1200
|
+
* HTML content of the template
|
|
1231
1201
|
* @type {string}
|
|
1232
1202
|
* @memberof Template
|
|
1233
1203
|
*/
|
|
1234
|
-
|
|
1204
|
+
htmlContent: string;
|
|
1235
1205
|
/**
|
|
1236
|
-
*
|
|
1206
|
+
* Width of the template in pixels
|
|
1237
1207
|
* @type {number}
|
|
1238
1208
|
* @memberof Template
|
|
1239
1209
|
*/
|
|
1240
|
-
pageWidth
|
|
1210
|
+
pageWidth: number;
|
|
1241
1211
|
/**
|
|
1242
|
-
*
|
|
1212
|
+
* Height of the template in pixels
|
|
1243
1213
|
* @type {number}
|
|
1244
1214
|
* @memberof Template
|
|
1245
1215
|
*/
|
|
1246
|
-
pageHeight
|
|
1247
|
-
}
|
|
1248
|
-
/**
|
|
1249
|
-
* @export
|
|
1250
|
-
* @enum {string}
|
|
1251
|
-
*/
|
|
1252
|
-
export declare enum TemplatePlatformEnum {
|
|
1253
|
-
QlikSense = "qlikSense",
|
|
1254
|
-
Tableau = "tableau"
|
|
1216
|
+
pageHeight: number;
|
|
1255
1217
|
}
|
|
1256
1218
|
/**
|
|
1257
1219
|
*
|
|
@@ -1336,10 +1298,12 @@ export declare const BaseTemplatesApiAxiosParamCreator: (configuration?: Configu
|
|
|
1336
1298
|
/**
|
|
1337
1299
|
*
|
|
1338
1300
|
* @summary List base templates
|
|
1301
|
+
* @param {number} [pageNum]
|
|
1302
|
+
* @param {number} [page]
|
|
1339
1303
|
* @param {*} [options] Override http request option.
|
|
1340
1304
|
* @throws {RequiredError}
|
|
1341
1305
|
*/
|
|
1342
|
-
getBaseTemplates: (options?: any) => Promise<RequestArgs>;
|
|
1306
|
+
getBaseTemplates: (pageNum?: number, page?: number, options?: any) => Promise<RequestArgs>;
|
|
1343
1307
|
};
|
|
1344
1308
|
/**
|
|
1345
1309
|
* BaseTemplatesApi - functional programming interface
|
|
@@ -1357,10 +1321,12 @@ export declare const BaseTemplatesApiFp: (configuration?: Configuration) => {
|
|
|
1357
1321
|
/**
|
|
1358
1322
|
*
|
|
1359
1323
|
* @summary List base templates
|
|
1324
|
+
* @param {number} [pageNum]
|
|
1325
|
+
* @param {number} [page]
|
|
1360
1326
|
* @param {*} [options] Override http request option.
|
|
1361
1327
|
* @throws {RequiredError}
|
|
1362
1328
|
*/
|
|
1363
|
-
getBaseTemplates(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse200>>;
|
|
1329
|
+
getBaseTemplates(pageNum?: number, page?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse200>>;
|
|
1364
1330
|
};
|
|
1365
1331
|
/**
|
|
1366
1332
|
* BaseTemplatesApi - factory interface
|
|
@@ -1378,10 +1344,12 @@ export declare const BaseTemplatesApiFactory: (configuration?: Configuration, ba
|
|
|
1378
1344
|
/**
|
|
1379
1345
|
*
|
|
1380
1346
|
* @summary List base templates
|
|
1347
|
+
* @param {number} [pageNum]
|
|
1348
|
+
* @param {number} [page]
|
|
1381
1349
|
* @param {*} [options] Override http request option.
|
|
1382
1350
|
* @throws {RequiredError}
|
|
1383
1351
|
*/
|
|
1384
|
-
getBaseTemplates(options?: any): AxiosPromise<InlineResponse200>;
|
|
1352
|
+
getBaseTemplates(pageNum?: number, page?: number, options?: any): AxiosPromise<InlineResponse200>;
|
|
1385
1353
|
};
|
|
1386
1354
|
/**
|
|
1387
1355
|
* BaseTemplatesApi - object-oriented interface
|
|
@@ -1402,11 +1370,13 @@ export declare class BaseTemplatesApi extends BaseAPI {
|
|
|
1402
1370
|
/**
|
|
1403
1371
|
*
|
|
1404
1372
|
* @summary List base templates
|
|
1373
|
+
* @param {number} [pageNum]
|
|
1374
|
+
* @param {number} [page]
|
|
1405
1375
|
* @param {*} [options] Override http request option.
|
|
1406
1376
|
* @throws {RequiredError}
|
|
1407
1377
|
* @memberof BaseTemplatesApi
|
|
1408
1378
|
*/
|
|
1409
|
-
getBaseTemplates(options?: any): Promise<import("axios").AxiosResponse<InlineResponse200>>;
|
|
1379
|
+
getBaseTemplates(pageNum?: number, page?: number, options?: any): Promise<import("axios").AxiosResponse<InlineResponse200>>;
|
|
1410
1380
|
}
|
|
1411
1381
|
/**
|
|
1412
1382
|
* DocumentsApi - axios parameter creator
|
|
@@ -1855,7 +1825,7 @@ export declare const ReportTasksApiAxiosParamCreator: (configuration?: Configura
|
|
|
1855
1825
|
*
|
|
1856
1826
|
* @summary List report tasks
|
|
1857
1827
|
* @param {number} [pageNum]
|
|
1858
|
-
* @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.
|
|
1828
|
+
* @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.
|
|
1859
1829
|
* @param {string} [templateId]
|
|
1860
1830
|
* @param {number} [perPage]
|
|
1861
1831
|
* @param {*} [options] Override http request option.
|
|
@@ -1908,7 +1878,7 @@ export declare const ReportTasksApiFp: (configuration?: Configuration) => {
|
|
|
1908
1878
|
*
|
|
1909
1879
|
* @summary List report tasks
|
|
1910
1880
|
* @param {number} [pageNum]
|
|
1911
|
-
* @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.
|
|
1881
|
+
* @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.
|
|
1912
1882
|
* @param {string} [templateId]
|
|
1913
1883
|
* @param {number} [perPage]
|
|
1914
1884
|
* @param {*} [options] Override http request option.
|
|
@@ -1961,7 +1931,7 @@ export declare const ReportTasksApiFactory: (configuration?: Configuration, base
|
|
|
1961
1931
|
*
|
|
1962
1932
|
* @summary List report tasks
|
|
1963
1933
|
* @param {number} [pageNum]
|
|
1964
|
-
* @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.
|
|
1934
|
+
* @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.
|
|
1965
1935
|
* @param {string} [templateId]
|
|
1966
1936
|
* @param {number} [perPage]
|
|
1967
1937
|
* @param {*} [options] Override http request option.
|
|
@@ -2019,7 +1989,7 @@ export declare class ReportTasksApi extends BaseAPI {
|
|
|
2019
1989
|
*
|
|
2020
1990
|
* @summary List report tasks
|
|
2021
1991
|
* @param {number} [pageNum]
|
|
2022
|
-
* @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.
|
|
1992
|
+
* @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.
|
|
2023
1993
|
* @param {string} [templateId]
|
|
2024
1994
|
* @param {number} [perPage]
|
|
2025
1995
|
* @param {*} [options] Override http request option.
|
|
@@ -2550,10 +2520,11 @@ export declare const VisualizationApiAxiosParamCreator: (configuration?: Configu
|
|
|
2550
2520
|
*
|
|
2551
2521
|
* @summary Create an image from a visualization
|
|
2552
2522
|
* @param {Visualization} visualization
|
|
2523
|
+
* @param {'high' | 'low'} [priority] Priority of the visualization image request
|
|
2553
2524
|
* @param {*} [options] Override http request option.
|
|
2554
2525
|
* @throws {RequiredError}
|
|
2555
2526
|
*/
|
|
2556
|
-
createVisualization: (visualization: Visualization, options?: any) => Promise<RequestArgs>;
|
|
2527
|
+
createVisualization: (visualization: Visualization, priority?: 'high' | 'low', options?: any) => Promise<RequestArgs>;
|
|
2557
2528
|
};
|
|
2558
2529
|
/**
|
|
2559
2530
|
* VisualizationApi - functional programming interface
|
|
@@ -2564,10 +2535,11 @@ export declare const VisualizationApiFp: (configuration?: Configuration) => {
|
|
|
2564
2535
|
*
|
|
2565
2536
|
* @summary Create an image from a visualization
|
|
2566
2537
|
* @param {Visualization} visualization
|
|
2538
|
+
* @param {'high' | 'low'} [priority] Priority of the visualization image request
|
|
2567
2539
|
* @param {*} [options] Override http request option.
|
|
2568
2540
|
* @throws {RequiredError}
|
|
2569
2541
|
*/
|
|
2570
|
-
createVisualization(visualization: Visualization, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
2542
|
+
createVisualization(visualization: Visualization, priority?: 'high' | 'low', options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
2571
2543
|
};
|
|
2572
2544
|
/**
|
|
2573
2545
|
* VisualizationApi - factory interface
|
|
@@ -2578,10 +2550,11 @@ export declare const VisualizationApiFactory: (configuration?: Configuration, ba
|
|
|
2578
2550
|
*
|
|
2579
2551
|
* @summary Create an image from a visualization
|
|
2580
2552
|
* @param {Visualization} visualization
|
|
2553
|
+
* @param {'high' | 'low'} [priority] Priority of the visualization image request
|
|
2581
2554
|
* @param {*} [options] Override http request option.
|
|
2582
2555
|
* @throws {RequiredError}
|
|
2583
2556
|
*/
|
|
2584
|
-
createVisualization(visualization: Visualization, options?: any): AxiosPromise<void>;
|
|
2557
|
+
createVisualization(visualization: Visualization, priority?: 'high' | 'low', options?: any): AxiosPromise<void>;
|
|
2585
2558
|
};
|
|
2586
2559
|
/**
|
|
2587
2560
|
* VisualizationApi - object-oriented interface
|
|
@@ -2594,9 +2567,10 @@ export declare class VisualizationApi extends BaseAPI {
|
|
|
2594
2567
|
*
|
|
2595
2568
|
* @summary Create an image from a visualization
|
|
2596
2569
|
* @param {Visualization} visualization
|
|
2570
|
+
* @param {'high' | 'low'} [priority] Priority of the visualization image request
|
|
2597
2571
|
* @param {*} [options] Override http request option.
|
|
2598
2572
|
* @throws {RequiredError}
|
|
2599
2573
|
* @memberof VisualizationApi
|
|
2600
2574
|
*/
|
|
2601
|
-
createVisualization(visualization: Visualization, options?: any): Promise<import("axios").AxiosResponse<void>>;
|
|
2575
|
+
createVisualization(visualization: Visualization, priority?: 'high' | 'low', options?: any): Promise<import("axios").AxiosResponse<void>>;
|
|
2602
2576
|
}
|
package/dist/api.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* ConnectReport Core API
|
|
6
6
|
* Leverage core reporting, templating, and document automation capabilities of ConnectReport Server.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 2.
|
|
8
|
+
* The version of the OpenAPI document: 2.54.2
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -73,7 +73,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
|
|
|
73
73
|
}
|
|
74
74
|
};
|
|
75
75
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
76
|
-
exports.VisualizationApi = exports.VisualizationApiFactory = exports.VisualizationApiFp = exports.VisualizationApiAxiosParamCreator = exports.TemplatesApi = exports.TemplatesApiFactory = exports.TemplatesApiFp = exports.TemplatesApiAxiosParamCreator = exports.ReportsApi = exports.ReportsApiFactory = exports.ReportsApiFp = exports.ReportsApiAxiosParamCreator = exports.ReportTasksApi = exports.ReportTasksApiFactory = exports.ReportTasksApiFp = exports.ReportTasksApiAxiosParamCreator = exports.JobsApi = exports.JobsApiFactory = exports.JobsApiFp = exports.JobsApiAxiosParamCreator = exports.ImagesApi = exports.ImagesApiFactory = exports.ImagesApiFp = exports.ImagesApiAxiosParamCreator = exports.FilterCyclesApi = exports.FilterCyclesApiFactory = exports.FilterCyclesApiFp = exports.FilterCyclesApiAxiosParamCreator = exports.DocumentsApi = exports.DocumentsApiFactory = exports.DocumentsApiFp = exports.DocumentsApiAxiosParamCreator = exports.BaseTemplatesApi = exports.BaseTemplatesApiFactory = exports.BaseTemplatesApiFp = exports.BaseTemplatesApiAxiosParamCreator = exports.
|
|
76
|
+
exports.VisualizationApi = exports.VisualizationApiFactory = exports.VisualizationApiFp = exports.VisualizationApiAxiosParamCreator = exports.TemplatesApi = exports.TemplatesApiFactory = exports.TemplatesApiFp = exports.TemplatesApiAxiosParamCreator = exports.ReportsApi = exports.ReportsApiFactory = exports.ReportsApiFp = exports.ReportsApiAxiosParamCreator = exports.ReportTasksApi = exports.ReportTasksApiFactory = exports.ReportTasksApiFp = exports.ReportTasksApiAxiosParamCreator = exports.JobsApi = exports.JobsApiFactory = exports.JobsApiFp = exports.JobsApiAxiosParamCreator = exports.ImagesApi = exports.ImagesApiFactory = exports.ImagesApiFp = exports.ImagesApiAxiosParamCreator = exports.FilterCyclesApi = exports.FilterCyclesApiFactory = exports.FilterCyclesApiFp = exports.FilterCyclesApiAxiosParamCreator = exports.DocumentsApi = exports.DocumentsApiFactory = exports.DocumentsApiFp = exports.DocumentsApiAxiosParamCreator = exports.BaseTemplatesApi = exports.BaseTemplatesApiFactory = exports.BaseTemplatesApiFp = exports.BaseTemplatesApiAxiosParamCreator = exports.ReportTaskResponseEmailEnum = exports.ReportTaskResponseFrequencyEnum = exports.ReportTaskRequestEmailEnum = exports.ReportTaskRequestFrequencyEnum = exports.ReportTaskEmailEnum = exports.ReportTaskFrequencyEnum = exports.FilterCycleEmailEnum = exports.FilterCycleFrequencyEnum = void 0;
|
|
77
77
|
var axios_1 = require("axios");
|
|
78
78
|
// Some imports not used depending on template conditions
|
|
79
79
|
// @ts-ignore
|
|
@@ -176,15 +176,6 @@ var ReportTaskResponseEmailEnum;
|
|
|
176
176
|
ReportTaskResponseEmailEnum["Xlsx"] = "xlsx";
|
|
177
177
|
ReportTaskResponseEmailEnum["Csv"] = "csv";
|
|
178
178
|
})(ReportTaskResponseEmailEnum = exports.ReportTaskResponseEmailEnum || (exports.ReportTaskResponseEmailEnum = {}));
|
|
179
|
-
/**
|
|
180
|
-
* @export
|
|
181
|
-
* @enum {string}
|
|
182
|
-
*/
|
|
183
|
-
var TemplatePlatformEnum;
|
|
184
|
-
(function (TemplatePlatformEnum) {
|
|
185
|
-
TemplatePlatformEnum["QlikSense"] = "qlikSense";
|
|
186
|
-
TemplatePlatformEnum["Tableau"] = "tableau";
|
|
187
|
-
})(TemplatePlatformEnum = exports.TemplatePlatformEnum || (exports.TemplatePlatformEnum = {}));
|
|
188
179
|
/**
|
|
189
180
|
* BaseTemplatesApi - axios parameter creator
|
|
190
181
|
* @export
|
|
@@ -240,10 +231,12 @@ exports.BaseTemplatesApiAxiosParamCreator = function (configuration) {
|
|
|
240
231
|
/**
|
|
241
232
|
*
|
|
242
233
|
* @summary List base templates
|
|
234
|
+
* @param {number} [pageNum]
|
|
235
|
+
* @param {number} [page]
|
|
243
236
|
* @param {*} [options] Override http request option.
|
|
244
237
|
* @throws {RequiredError}
|
|
245
238
|
*/
|
|
246
|
-
getBaseTemplates: function (options) {
|
|
239
|
+
getBaseTemplates: function (pageNum, page, options) {
|
|
247
240
|
if (options === void 0) { options = {}; }
|
|
248
241
|
return __awaiter(_this, void 0, void 0, function () {
|
|
249
242
|
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions, formHeaders;
|
|
@@ -266,6 +259,12 @@ exports.BaseTemplatesApiAxiosParamCreator = function (configuration) {
|
|
|
266
259
|
// authentication ApiKeyAuth required
|
|
267
260
|
_a.sent();
|
|
268
261
|
// authentication CookieAuth required
|
|
262
|
+
if (pageNum !== undefined) {
|
|
263
|
+
localVarQueryParameter['pageNum'] = pageNum;
|
|
264
|
+
}
|
|
265
|
+
if (page !== undefined) {
|
|
266
|
+
localVarQueryParameter['page'] = page;
|
|
267
|
+
}
|
|
269
268
|
common_1.setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);
|
|
270
269
|
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
271
270
|
formHeaders = {};
|
|
@@ -310,15 +309,17 @@ exports.BaseTemplatesApiFp = function (configuration) {
|
|
|
310
309
|
/**
|
|
311
310
|
*
|
|
312
311
|
* @summary List base templates
|
|
312
|
+
* @param {number} [pageNum]
|
|
313
|
+
* @param {number} [page]
|
|
313
314
|
* @param {*} [options] Override http request option.
|
|
314
315
|
* @throws {RequiredError}
|
|
315
316
|
*/
|
|
316
|
-
getBaseTemplates: function (options) {
|
|
317
|
+
getBaseTemplates: function (pageNum, page, options) {
|
|
317
318
|
return __awaiter(this, void 0, void 0, function () {
|
|
318
319
|
var localVarAxiosArgs;
|
|
319
320
|
return __generator(this, function (_a) {
|
|
320
321
|
switch (_a.label) {
|
|
321
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.getBaseTemplates(options)];
|
|
322
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.getBaseTemplates(pageNum, page, options)];
|
|
322
323
|
case 1:
|
|
323
324
|
localVarAxiosArgs = _a.sent();
|
|
324
325
|
return [2 /*return*/, common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
@@ -348,11 +349,13 @@ exports.BaseTemplatesApiFactory = function (configuration, basePath, axios) {
|
|
|
348
349
|
/**
|
|
349
350
|
*
|
|
350
351
|
* @summary List base templates
|
|
352
|
+
* @param {number} [pageNum]
|
|
353
|
+
* @param {number} [page]
|
|
351
354
|
* @param {*} [options] Override http request option.
|
|
352
355
|
* @throws {RequiredError}
|
|
353
356
|
*/
|
|
354
|
-
getBaseTemplates: function (options) {
|
|
355
|
-
return localVarFp.getBaseTemplates(options).then(function (request) { return request(axios, basePath); });
|
|
357
|
+
getBaseTemplates: function (pageNum, page, options) {
|
|
358
|
+
return localVarFp.getBaseTemplates(pageNum, page, options).then(function (request) { return request(axios, basePath); });
|
|
356
359
|
},
|
|
357
360
|
};
|
|
358
361
|
};
|
|
@@ -382,13 +385,15 @@ var BaseTemplatesApi = /** @class */ (function (_super) {
|
|
|
382
385
|
/**
|
|
383
386
|
*
|
|
384
387
|
* @summary List base templates
|
|
388
|
+
* @param {number} [pageNum]
|
|
389
|
+
* @param {number} [page]
|
|
385
390
|
* @param {*} [options] Override http request option.
|
|
386
391
|
* @throws {RequiredError}
|
|
387
392
|
* @memberof BaseTemplatesApi
|
|
388
393
|
*/
|
|
389
|
-
BaseTemplatesApi.prototype.getBaseTemplates = function (options) {
|
|
394
|
+
BaseTemplatesApi.prototype.getBaseTemplates = function (pageNum, page, options) {
|
|
390
395
|
var _this = this;
|
|
391
|
-
return exports.BaseTemplatesApiFp(this.configuration).getBaseTemplates(options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
396
|
+
return exports.BaseTemplatesApiFp(this.configuration).getBaseTemplates(pageNum, page, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
392
397
|
};
|
|
393
398
|
return BaseTemplatesApi;
|
|
394
399
|
}(base_1.BaseAPI));
|
|
@@ -1522,7 +1527,7 @@ exports.ReportTasksApiAxiosParamCreator = function (configuration) {
|
|
|
1522
1527
|
*
|
|
1523
1528
|
* @summary List report tasks
|
|
1524
1529
|
* @param {number} [pageNum]
|
|
1525
|
-
* @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.
|
|
1530
|
+
* @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.
|
|
1526
1531
|
* @param {string} [templateId]
|
|
1527
1532
|
* @param {number} [perPage]
|
|
1528
1533
|
* @param {*} [options] Override http request option.
|
|
@@ -1699,7 +1704,7 @@ exports.ReportTasksApiFp = function (configuration) {
|
|
|
1699
1704
|
*
|
|
1700
1705
|
* @summary List report tasks
|
|
1701
1706
|
* @param {number} [pageNum]
|
|
1702
|
-
* @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.
|
|
1707
|
+
* @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.
|
|
1703
1708
|
* @param {string} [templateId]
|
|
1704
1709
|
* @param {number} [perPage]
|
|
1705
1710
|
* @param {*} [options] Override http request option.
|
|
@@ -1783,7 +1788,7 @@ exports.ReportTasksApiFactory = function (configuration, basePath, axios) {
|
|
|
1783
1788
|
*
|
|
1784
1789
|
* @summary List report tasks
|
|
1785
1790
|
* @param {number} [pageNum]
|
|
1786
|
-
* @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.
|
|
1791
|
+
* @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.
|
|
1787
1792
|
* @param {string} [templateId]
|
|
1788
1793
|
* @param {number} [perPage]
|
|
1789
1794
|
* @param {*} [options] Override http request option.
|
|
@@ -1857,7 +1862,7 @@ var ReportTasksApi = /** @class */ (function (_super) {
|
|
|
1857
1862
|
*
|
|
1858
1863
|
* @summary List report tasks
|
|
1859
1864
|
* @param {number} [pageNum]
|
|
1860
|
-
* @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.
|
|
1865
|
+
* @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.
|
|
1861
1866
|
* @param {string} [templateId]
|
|
1862
1867
|
* @param {number} [perPage]
|
|
1863
1868
|
* @param {*} [options] Override http request option.
|
|
@@ -3155,10 +3160,11 @@ exports.VisualizationApiAxiosParamCreator = function (configuration) {
|
|
|
3155
3160
|
*
|
|
3156
3161
|
* @summary Create an image from a visualization
|
|
3157
3162
|
* @param {Visualization} visualization
|
|
3163
|
+
* @param {'high' | 'low'} [priority] Priority of the visualization image request
|
|
3158
3164
|
* @param {*} [options] Override http request option.
|
|
3159
3165
|
* @throws {RequiredError}
|
|
3160
3166
|
*/
|
|
3161
|
-
createVisualization: function (visualization, options) {
|
|
3167
|
+
createVisualization: function (visualization, priority, options) {
|
|
3162
3168
|
if (options === void 0) { options = {}; }
|
|
3163
3169
|
return __awaiter(_this, void 0, void 0, function () {
|
|
3164
3170
|
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions, formHeaders;
|
|
@@ -3183,6 +3189,9 @@ exports.VisualizationApiAxiosParamCreator = function (configuration) {
|
|
|
3183
3189
|
// authentication ApiKeyAuth required
|
|
3184
3190
|
_a.sent();
|
|
3185
3191
|
// authentication CookieAuth required
|
|
3192
|
+
if (priority !== undefined) {
|
|
3193
|
+
localVarQueryParameter['priority'] = priority;
|
|
3194
|
+
}
|
|
3186
3195
|
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
3187
3196
|
common_1.setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);
|
|
3188
3197
|
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -3210,15 +3219,16 @@ exports.VisualizationApiFp = function (configuration) {
|
|
|
3210
3219
|
*
|
|
3211
3220
|
* @summary Create an image from a visualization
|
|
3212
3221
|
* @param {Visualization} visualization
|
|
3222
|
+
* @param {'high' | 'low'} [priority] Priority of the visualization image request
|
|
3213
3223
|
* @param {*} [options] Override http request option.
|
|
3214
3224
|
* @throws {RequiredError}
|
|
3215
3225
|
*/
|
|
3216
|
-
createVisualization: function (visualization, options) {
|
|
3226
|
+
createVisualization: function (visualization, priority, options) {
|
|
3217
3227
|
return __awaiter(this, void 0, void 0, function () {
|
|
3218
3228
|
var localVarAxiosArgs;
|
|
3219
3229
|
return __generator(this, function (_a) {
|
|
3220
3230
|
switch (_a.label) {
|
|
3221
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.createVisualization(visualization, options)];
|
|
3231
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.createVisualization(visualization, priority, options)];
|
|
3222
3232
|
case 1:
|
|
3223
3233
|
localVarAxiosArgs = _a.sent();
|
|
3224
3234
|
return [2 /*return*/, common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
@@ -3239,11 +3249,12 @@ exports.VisualizationApiFactory = function (configuration, basePath, axios) {
|
|
|
3239
3249
|
*
|
|
3240
3250
|
* @summary Create an image from a visualization
|
|
3241
3251
|
* @param {Visualization} visualization
|
|
3252
|
+
* @param {'high' | 'low'} [priority] Priority of the visualization image request
|
|
3242
3253
|
* @param {*} [options] Override http request option.
|
|
3243
3254
|
* @throws {RequiredError}
|
|
3244
3255
|
*/
|
|
3245
|
-
createVisualization: function (visualization, options) {
|
|
3246
|
-
return localVarFp.createVisualization(visualization, options).then(function (request) { return request(axios, basePath); });
|
|
3256
|
+
createVisualization: function (visualization, priority, options) {
|
|
3257
|
+
return localVarFp.createVisualization(visualization, priority, options).then(function (request) { return request(axios, basePath); });
|
|
3247
3258
|
},
|
|
3248
3259
|
};
|
|
3249
3260
|
};
|
|
@@ -3262,13 +3273,14 @@ var VisualizationApi = /** @class */ (function (_super) {
|
|
|
3262
3273
|
*
|
|
3263
3274
|
* @summary Create an image from a visualization
|
|
3264
3275
|
* @param {Visualization} visualization
|
|
3276
|
+
* @param {'high' | 'low'} [priority] Priority of the visualization image request
|
|
3265
3277
|
* @param {*} [options] Override http request option.
|
|
3266
3278
|
* @throws {RequiredError}
|
|
3267
3279
|
* @memberof VisualizationApi
|
|
3268
3280
|
*/
|
|
3269
|
-
VisualizationApi.prototype.createVisualization = function (visualization, options) {
|
|
3281
|
+
VisualizationApi.prototype.createVisualization = function (visualization, priority, options) {
|
|
3270
3282
|
var _this = this;
|
|
3271
|
-
return exports.VisualizationApiFp(this.configuration).createVisualization(visualization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
3283
|
+
return exports.VisualizationApiFp(this.configuration).createVisualization(visualization, priority, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
3272
3284
|
};
|
|
3273
3285
|
return VisualizationApi;
|
|
3274
3286
|
}(base_1.BaseAPI));
|
package/dist/base.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* ConnectReport Core API
|
|
3
3
|
* Leverage core reporting, templating, and document automation capabilities of ConnectReport Server.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 2.
|
|
5
|
+
* The version of the OpenAPI document: 2.54.2
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/base.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* ConnectReport Core API
|
|
6
6
|
* Leverage core reporting, templating, and document automation capabilities of ConnectReport Server.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 2.
|
|
8
|
+
* The version of the OpenAPI document: 2.54.2
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/common.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* ConnectReport Core API
|
|
3
3
|
* Leverage core reporting, templating, and document automation capabilities of ConnectReport Server.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 2.
|
|
5
|
+
* The version of the OpenAPI document: 2.54.2
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/common.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* ConnectReport Core API
|
|
6
6
|
* Leverage core reporting, templating, and document automation capabilities of ConnectReport Server.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 2.
|
|
8
|
+
* The version of the OpenAPI document: 2.54.2
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/configuration.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* ConnectReport Core API
|
|
3
3
|
* Leverage core reporting, templating, and document automation capabilities of ConnectReport Server.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 2.
|
|
5
|
+
* The version of the OpenAPI document: 2.54.2
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/configuration.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* ConnectReport Core API
|
|
6
6
|
* Leverage core reporting, templating, and document automation capabilities of ConnectReport Server.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 2.
|
|
8
|
+
* The version of the OpenAPI document: 2.54.2
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|