@connectreport/connectreport-js 2.55.1 → 2.71.4
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 +462 -23
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +180 -17
- package/dist/api.js +685 -48
- 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/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.71.4
|
|
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.71.4
|
|
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.71.4
|
|
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.71.4
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -140,6 +140,12 @@ export interface FilterCycle {
|
|
|
140
140
|
* @memberof FilterCycle
|
|
141
141
|
*/
|
|
142
142
|
tags?: Array<ReportTaskTags>;
|
|
143
|
+
/**
|
|
144
|
+
* The trigger name for the report task. Used to execute tasks on a trigger
|
|
145
|
+
* @type {string}
|
|
146
|
+
* @memberof FilterCycle
|
|
147
|
+
*/
|
|
148
|
+
trigger?: string;
|
|
143
149
|
/**
|
|
144
150
|
*
|
|
145
151
|
* @type {FilterCycleAllOfFieldInfo}
|
|
@@ -178,10 +184,11 @@ export interface FilterCycle {
|
|
|
178
184
|
export declare enum FilterCycleFrequencyEnum {
|
|
179
185
|
Monthly = "Monthly",
|
|
180
186
|
OnceNow = "Once - now",
|
|
181
|
-
OnceScheduled = "Once -
|
|
187
|
+
OnceScheduled = "Once - scheduled",
|
|
182
188
|
Annually = "Annually",
|
|
183
189
|
Daily = "Daily",
|
|
184
|
-
Weekly = "Weekly"
|
|
190
|
+
Weekly = "Weekly",
|
|
191
|
+
UponTrigger = "Upon trigger"
|
|
185
192
|
}
|
|
186
193
|
/**
|
|
187
194
|
* @export
|
|
@@ -349,6 +356,12 @@ export interface InlineResponse2003 {
|
|
|
349
356
|
* @memberof InlineResponse2003
|
|
350
357
|
*/
|
|
351
358
|
totalPages?: number;
|
|
359
|
+
/**
|
|
360
|
+
*
|
|
361
|
+
* @type {number}
|
|
362
|
+
* @memberof InlineResponse2003
|
|
363
|
+
*/
|
|
364
|
+
totalItems?: number;
|
|
352
365
|
}
|
|
353
366
|
/**
|
|
354
367
|
*
|
|
@@ -516,6 +529,12 @@ export interface Report {
|
|
|
516
529
|
* @memberof Report
|
|
517
530
|
*/
|
|
518
531
|
thumbnailPath?: string;
|
|
532
|
+
/**
|
|
533
|
+
* The size in bytes of the report HTML contents
|
|
534
|
+
* @type {number}
|
|
535
|
+
* @memberof Report
|
|
536
|
+
*/
|
|
537
|
+
sizeBytes?: number;
|
|
519
538
|
}
|
|
520
539
|
/**
|
|
521
540
|
*
|
|
@@ -645,6 +664,12 @@ export interface ReportTask {
|
|
|
645
664
|
* @memberof ReportTask
|
|
646
665
|
*/
|
|
647
666
|
tags?: Array<ReportTaskTags>;
|
|
667
|
+
/**
|
|
668
|
+
* The trigger name for the report task. Used to execute tasks on a trigger
|
|
669
|
+
* @type {string}
|
|
670
|
+
* @memberof ReportTask
|
|
671
|
+
*/
|
|
672
|
+
trigger?: string;
|
|
648
673
|
}
|
|
649
674
|
/**
|
|
650
675
|
* @export
|
|
@@ -653,10 +678,11 @@ export interface ReportTask {
|
|
|
653
678
|
export declare enum ReportTaskFrequencyEnum {
|
|
654
679
|
Monthly = "Monthly",
|
|
655
680
|
OnceNow = "Once - now",
|
|
656
|
-
OnceScheduled = "Once -
|
|
681
|
+
OnceScheduled = "Once - scheduled",
|
|
657
682
|
Annually = "Annually",
|
|
658
683
|
Daily = "Daily",
|
|
659
|
-
Weekly = "Weekly"
|
|
684
|
+
Weekly = "Weekly",
|
|
685
|
+
UponTrigger = "Upon trigger"
|
|
660
686
|
}
|
|
661
687
|
/**
|
|
662
688
|
* @export
|
|
@@ -872,6 +898,12 @@ export interface ReportTaskRequest {
|
|
|
872
898
|
* @memberof ReportTaskRequest
|
|
873
899
|
*/
|
|
874
900
|
tags?: Array<ReportTaskTags>;
|
|
901
|
+
/**
|
|
902
|
+
* The trigger name for the report task. Used to execute tasks on a trigger
|
|
903
|
+
* @type {string}
|
|
904
|
+
* @memberof ReportTaskRequest
|
|
905
|
+
*/
|
|
906
|
+
trigger?: string;
|
|
875
907
|
/**
|
|
876
908
|
* Emails to send the report to. This is only allowed if \"Allow reports to be shared with any email\" is to true.
|
|
877
909
|
* @type {Array<string>}
|
|
@@ -898,10 +930,11 @@ export interface ReportTaskRequest {
|
|
|
898
930
|
export declare enum ReportTaskRequestFrequencyEnum {
|
|
899
931
|
Monthly = "Monthly",
|
|
900
932
|
OnceNow = "Once - now",
|
|
901
|
-
OnceScheduled = "Once -
|
|
933
|
+
OnceScheduled = "Once - scheduled",
|
|
902
934
|
Annually = "Annually",
|
|
903
935
|
Daily = "Daily",
|
|
904
|
-
Weekly = "Weekly"
|
|
936
|
+
Weekly = "Weekly",
|
|
937
|
+
UponTrigger = "Upon trigger"
|
|
905
938
|
}
|
|
906
939
|
/**
|
|
907
940
|
* @export
|
|
@@ -1079,6 +1112,12 @@ export interface ReportTaskResponse {
|
|
|
1079
1112
|
* @memberof ReportTaskResponse
|
|
1080
1113
|
*/
|
|
1081
1114
|
tags?: Array<ReportTaskTags>;
|
|
1115
|
+
/**
|
|
1116
|
+
* The trigger name for the report task. Used to execute tasks on a trigger
|
|
1117
|
+
* @type {string}
|
|
1118
|
+
* @memberof ReportTaskResponse
|
|
1119
|
+
*/
|
|
1120
|
+
trigger?: string;
|
|
1082
1121
|
/**
|
|
1083
1122
|
* Users to share the published report with. This field will be updated entirely if provided
|
|
1084
1123
|
* @type {Array<ReportTaskResponseAllOfUsersToShareWith>}
|
|
@@ -1093,10 +1132,11 @@ export interface ReportTaskResponse {
|
|
|
1093
1132
|
export declare enum ReportTaskResponseFrequencyEnum {
|
|
1094
1133
|
Monthly = "Monthly",
|
|
1095
1134
|
OnceNow = "Once - now",
|
|
1096
|
-
OnceScheduled = "Once -
|
|
1135
|
+
OnceScheduled = "Once - scheduled",
|
|
1097
1136
|
Annually = "Annually",
|
|
1098
1137
|
Daily = "Daily",
|
|
1099
|
-
Weekly = "Weekly"
|
|
1138
|
+
Weekly = "Weekly",
|
|
1139
|
+
UponTrigger = "Upon trigger"
|
|
1100
1140
|
}
|
|
1101
1141
|
/**
|
|
1102
1142
|
* @export
|
|
@@ -1466,6 +1506,22 @@ export declare const FilterCyclesApiAxiosParamCreator: (configuration?: Configur
|
|
|
1466
1506
|
* @throws {RequiredError}
|
|
1467
1507
|
*/
|
|
1468
1508
|
deleteFilterCycle: (id: string, options?: any) => Promise<RequestArgs>;
|
|
1509
|
+
/**
|
|
1510
|
+
*
|
|
1511
|
+
* @summary Disable all report tasks in a cycle
|
|
1512
|
+
* @param {string} id
|
|
1513
|
+
* @param {*} [options] Override http request option.
|
|
1514
|
+
* @throws {RequiredError}
|
|
1515
|
+
*/
|
|
1516
|
+
disableAllInCycle: (id: string, options?: any) => Promise<RequestArgs>;
|
|
1517
|
+
/**
|
|
1518
|
+
*
|
|
1519
|
+
* @summary Enable all report tasks in a cycle
|
|
1520
|
+
* @param {string} id
|
|
1521
|
+
* @param {*} [options] Override http request option.
|
|
1522
|
+
* @throws {RequiredError}
|
|
1523
|
+
*/
|
|
1524
|
+
enableAllInCycle: (id: string, options?: any) => Promise<RequestArgs>;
|
|
1469
1525
|
/**
|
|
1470
1526
|
*
|
|
1471
1527
|
* @summary Get a filter cycle
|
|
@@ -1513,6 +1569,22 @@ export declare const FilterCyclesApiFp: (configuration?: Configuration) => {
|
|
|
1513
1569
|
* @throws {RequiredError}
|
|
1514
1570
|
*/
|
|
1515
1571
|
deleteFilterCycle(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FilterCycle>>;
|
|
1572
|
+
/**
|
|
1573
|
+
*
|
|
1574
|
+
* @summary Disable all report tasks in a cycle
|
|
1575
|
+
* @param {string} id
|
|
1576
|
+
* @param {*} [options] Override http request option.
|
|
1577
|
+
* @throws {RequiredError}
|
|
1578
|
+
*/
|
|
1579
|
+
disableAllInCycle(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
1580
|
+
/**
|
|
1581
|
+
*
|
|
1582
|
+
* @summary Enable all report tasks in a cycle
|
|
1583
|
+
* @param {string} id
|
|
1584
|
+
* @param {*} [options] Override http request option.
|
|
1585
|
+
* @throws {RequiredError}
|
|
1586
|
+
*/
|
|
1587
|
+
enableAllInCycle(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
1516
1588
|
/**
|
|
1517
1589
|
*
|
|
1518
1590
|
* @summary Get a filter cycle
|
|
@@ -1560,6 +1632,22 @@ export declare const FilterCyclesApiFactory: (configuration?: Configuration, bas
|
|
|
1560
1632
|
* @throws {RequiredError}
|
|
1561
1633
|
*/
|
|
1562
1634
|
deleteFilterCycle(id: string, options?: any): AxiosPromise<FilterCycle>;
|
|
1635
|
+
/**
|
|
1636
|
+
*
|
|
1637
|
+
* @summary Disable all report tasks in a cycle
|
|
1638
|
+
* @param {string} id
|
|
1639
|
+
* @param {*} [options] Override http request option.
|
|
1640
|
+
* @throws {RequiredError}
|
|
1641
|
+
*/
|
|
1642
|
+
disableAllInCycle(id: string, options?: any): AxiosPromise<void>;
|
|
1643
|
+
/**
|
|
1644
|
+
*
|
|
1645
|
+
* @summary Enable all report tasks in a cycle
|
|
1646
|
+
* @param {string} id
|
|
1647
|
+
* @param {*} [options] Override http request option.
|
|
1648
|
+
* @throws {RequiredError}
|
|
1649
|
+
*/
|
|
1650
|
+
enableAllInCycle(id: string, options?: any): AxiosPromise<void>;
|
|
1563
1651
|
/**
|
|
1564
1652
|
*
|
|
1565
1653
|
* @summary Get a filter cycle
|
|
@@ -1611,6 +1699,24 @@ export declare class FilterCyclesApi extends BaseAPI {
|
|
|
1611
1699
|
* @memberof FilterCyclesApi
|
|
1612
1700
|
*/
|
|
1613
1701
|
deleteFilterCycle(id: string, options?: any): Promise<import("axios").AxiosResponse<FilterCycle>>;
|
|
1702
|
+
/**
|
|
1703
|
+
*
|
|
1704
|
+
* @summary Disable all report tasks in a cycle
|
|
1705
|
+
* @param {string} id
|
|
1706
|
+
* @param {*} [options] Override http request option.
|
|
1707
|
+
* @throws {RequiredError}
|
|
1708
|
+
* @memberof FilterCyclesApi
|
|
1709
|
+
*/
|
|
1710
|
+
disableAllInCycle(id: string, options?: any): Promise<import("axios").AxiosResponse<void>>;
|
|
1711
|
+
/**
|
|
1712
|
+
*
|
|
1713
|
+
* @summary Enable all report tasks in a cycle
|
|
1714
|
+
* @param {string} id
|
|
1715
|
+
* @param {*} [options] Override http request option.
|
|
1716
|
+
* @throws {RequiredError}
|
|
1717
|
+
* @memberof FilterCyclesApi
|
|
1718
|
+
*/
|
|
1719
|
+
enableAllInCycle(id: string, options?: any): Promise<import("axios").AxiosResponse<void>>;
|
|
1614
1720
|
/**
|
|
1615
1721
|
*
|
|
1616
1722
|
* @summary Get a filter cycle
|
|
@@ -1828,12 +1934,23 @@ export declare const ReportTasksApiAxiosParamCreator: (configuration?: Configura
|
|
|
1828
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.
|
|
1829
1935
|
* @param {string} [templateId]
|
|
1830
1936
|
* @param {number} [perPage]
|
|
1937
|
+
* @param {'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId'} [orderBy]
|
|
1938
|
+
* @param {'asc' | 'desc'} [order] The order to retrieve the logs in
|
|
1939
|
+
* @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\" } ```
|
|
1831
1940
|
* @param {*} [options] Override http request option.
|
|
1832
1941
|
* @throws {RequiredError}
|
|
1833
1942
|
*/
|
|
1834
1943
|
getReportTasks: (pageNum?: number, meta?: {
|
|
1835
1944
|
[key: string]: string;
|
|
1836
|
-
}, templateId?: string, perPage?: number, options?: any) => Promise<RequestArgs>;
|
|
1945
|
+
}, templateId?: string, perPage?: number, orderBy?: 'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId', order?: 'asc' | 'desc', filter?: object, options?: any) => Promise<RequestArgs>;
|
|
1946
|
+
/**
|
|
1947
|
+
* Duplicates the task and runs it as \"Once - Now\"
|
|
1948
|
+
* @summary Run task now
|
|
1949
|
+
* @param {string} id
|
|
1950
|
+
* @param {*} [options] Override http request option.
|
|
1951
|
+
* @throws {RequiredError}
|
|
1952
|
+
*/
|
|
1953
|
+
runReportTaskNow: (id: string, options?: any) => Promise<RequestArgs>;
|
|
1837
1954
|
/**
|
|
1838
1955
|
* Accepts partial updates
|
|
1839
1956
|
* @summary Update report task by ID
|
|
@@ -1881,12 +1998,23 @@ export declare const ReportTasksApiFp: (configuration?: Configuration) => {
|
|
|
1881
1998
|
* @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.
|
|
1882
1999
|
* @param {string} [templateId]
|
|
1883
2000
|
* @param {number} [perPage]
|
|
2001
|
+
* @param {'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId'} [orderBy]
|
|
2002
|
+
* @param {'asc' | 'desc'} [order] The order to retrieve the logs in
|
|
2003
|
+
* @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\" } ```
|
|
1884
2004
|
* @param {*} [options] Override http request option.
|
|
1885
2005
|
* @throws {RequiredError}
|
|
1886
2006
|
*/
|
|
1887
2007
|
getReportTasks(pageNum?: number, meta?: {
|
|
1888
2008
|
[key: string]: string;
|
|
1889
|
-
}, templateId?: string, perPage?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2002>>;
|
|
2009
|
+
}, templateId?: string, perPage?: number, orderBy?: 'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId', order?: 'asc' | 'desc', filter?: object, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2002>>;
|
|
2010
|
+
/**
|
|
2011
|
+
* Duplicates the task and runs it as \"Once - Now\"
|
|
2012
|
+
* @summary Run task now
|
|
2013
|
+
* @param {string} id
|
|
2014
|
+
* @param {*} [options] Override http request option.
|
|
2015
|
+
* @throws {RequiredError}
|
|
2016
|
+
*/
|
|
2017
|
+
runReportTaskNow(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReportTaskResponse>>;
|
|
1890
2018
|
/**
|
|
1891
2019
|
* Accepts partial updates
|
|
1892
2020
|
* @summary Update report task by ID
|
|
@@ -1934,12 +2062,23 @@ export declare const ReportTasksApiFactory: (configuration?: Configuration, base
|
|
|
1934
2062
|
* @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.
|
|
1935
2063
|
* @param {string} [templateId]
|
|
1936
2064
|
* @param {number} [perPage]
|
|
2065
|
+
* @param {'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId'} [orderBy]
|
|
2066
|
+
* @param {'asc' | 'desc'} [order] The order to retrieve the logs in
|
|
2067
|
+
* @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\" } ```
|
|
1937
2068
|
* @param {*} [options] Override http request option.
|
|
1938
2069
|
* @throws {RequiredError}
|
|
1939
2070
|
*/
|
|
1940
2071
|
getReportTasks(pageNum?: number, meta?: {
|
|
1941
2072
|
[key: string]: string;
|
|
1942
|
-
}, templateId?: string, perPage?: number, options?: any): AxiosPromise<InlineResponse2002>;
|
|
2073
|
+
}, templateId?: string, perPage?: number, orderBy?: 'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId', order?: 'asc' | 'desc', filter?: object, options?: any): AxiosPromise<InlineResponse2002>;
|
|
2074
|
+
/**
|
|
2075
|
+
* Duplicates the task and runs it as \"Once - Now\"
|
|
2076
|
+
* @summary Run task now
|
|
2077
|
+
* @param {string} id
|
|
2078
|
+
* @param {*} [options] Override http request option.
|
|
2079
|
+
* @throws {RequiredError}
|
|
2080
|
+
*/
|
|
2081
|
+
runReportTaskNow(id: string, options?: any): AxiosPromise<ReportTaskResponse>;
|
|
1943
2082
|
/**
|
|
1944
2083
|
* Accepts partial updates
|
|
1945
2084
|
* @summary Update report task by ID
|
|
@@ -1992,13 +2131,25 @@ export declare class ReportTasksApi extends BaseAPI {
|
|
|
1992
2131
|
* @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.
|
|
1993
2132
|
* @param {string} [templateId]
|
|
1994
2133
|
* @param {number} [perPage]
|
|
2134
|
+
* @param {'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId'} [orderBy]
|
|
2135
|
+
* @param {'asc' | 'desc'} [order] The order to retrieve the logs in
|
|
2136
|
+
* @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\" } ```
|
|
1995
2137
|
* @param {*} [options] Override http request option.
|
|
1996
2138
|
* @throws {RequiredError}
|
|
1997
2139
|
* @memberof ReportTasksApi
|
|
1998
2140
|
*/
|
|
1999
2141
|
getReportTasks(pageNum?: number, meta?: {
|
|
2000
2142
|
[key: string]: string;
|
|
2001
|
-
}, templateId?: string, perPage?: number, options?: any): Promise<import("axios").AxiosResponse<InlineResponse2002>>;
|
|
2143
|
+
}, templateId?: string, perPage?: number, orderBy?: 'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId', order?: 'asc' | 'desc', filter?: object, options?: any): Promise<import("axios").AxiosResponse<InlineResponse2002>>;
|
|
2144
|
+
/**
|
|
2145
|
+
* Duplicates the task and runs it as \"Once - Now\"
|
|
2146
|
+
* @summary Run task now
|
|
2147
|
+
* @param {string} id
|
|
2148
|
+
* @param {*} [options] Override http request option.
|
|
2149
|
+
* @throws {RequiredError}
|
|
2150
|
+
* @memberof ReportTasksApi
|
|
2151
|
+
*/
|
|
2152
|
+
runReportTaskNow(id: string, options?: any): Promise<import("axios").AxiosResponse<ReportTaskResponse>>;
|
|
2002
2153
|
/**
|
|
2003
2154
|
* Accepts partial updates
|
|
2004
2155
|
* @summary Update report task by ID
|
|
@@ -2035,12 +2186,15 @@ export declare const ReportsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
2035
2186
|
*
|
|
2036
2187
|
* @summary List reports
|
|
2037
2188
|
* @param {number} [pageNum]
|
|
2189
|
+
* @param {number} [perPage]
|
|
2190
|
+
* @param {'title' | 'createdAt'} [orderBy] The field to order the list of reports on
|
|
2191
|
+
* @param {'asc' | 'desc'} [order] The order to sort the list of reports on
|
|
2038
2192
|
* @param {string} [tagId] A tagId to filter the list of reports on
|
|
2039
2193
|
* @param {string} [reportTaskId] A reportId to filter the list of reports on
|
|
2040
2194
|
* @param {*} [options] Override http request option.
|
|
2041
2195
|
* @throws {RequiredError}
|
|
2042
2196
|
*/
|
|
2043
|
-
getReports: (pageNum?: number, tagId?: string, reportTaskId?: string, options?: any) => Promise<RequestArgs>;
|
|
2197
|
+
getReports: (pageNum?: number, perPage?: number, orderBy?: 'title' | 'createdAt', order?: 'asc' | 'desc', tagId?: string, reportTaskId?: string, options?: any) => Promise<RequestArgs>;
|
|
2044
2198
|
/**
|
|
2045
2199
|
*
|
|
2046
2200
|
* @summary Render a published report
|
|
@@ -2076,12 +2230,15 @@ export declare const ReportsApiFp: (configuration?: Configuration) => {
|
|
|
2076
2230
|
*
|
|
2077
2231
|
* @summary List reports
|
|
2078
2232
|
* @param {number} [pageNum]
|
|
2233
|
+
* @param {number} [perPage]
|
|
2234
|
+
* @param {'title' | 'createdAt'} [orderBy] The field to order the list of reports on
|
|
2235
|
+
* @param {'asc' | 'desc'} [order] The order to sort the list of reports on
|
|
2079
2236
|
* @param {string} [tagId] A tagId to filter the list of reports on
|
|
2080
2237
|
* @param {string} [reportTaskId] A reportId to filter the list of reports on
|
|
2081
2238
|
* @param {*} [options] Override http request option.
|
|
2082
2239
|
* @throws {RequiredError}
|
|
2083
2240
|
*/
|
|
2084
|
-
getReports(pageNum?: number, tagId?: string, reportTaskId?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2003>>;
|
|
2241
|
+
getReports(pageNum?: number, perPage?: number, orderBy?: 'title' | 'createdAt', order?: 'asc' | 'desc', tagId?: string, reportTaskId?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2003>>;
|
|
2085
2242
|
/**
|
|
2086
2243
|
*
|
|
2087
2244
|
* @summary Render a published report
|
|
@@ -2117,12 +2274,15 @@ export declare const ReportsApiFactory: (configuration?: Configuration, basePath
|
|
|
2117
2274
|
*
|
|
2118
2275
|
* @summary List reports
|
|
2119
2276
|
* @param {number} [pageNum]
|
|
2277
|
+
* @param {number} [perPage]
|
|
2278
|
+
* @param {'title' | 'createdAt'} [orderBy] The field to order the list of reports on
|
|
2279
|
+
* @param {'asc' | 'desc'} [order] The order to sort the list of reports on
|
|
2120
2280
|
* @param {string} [tagId] A tagId to filter the list of reports on
|
|
2121
2281
|
* @param {string} [reportTaskId] A reportId to filter the list of reports on
|
|
2122
2282
|
* @param {*} [options] Override http request option.
|
|
2123
2283
|
* @throws {RequiredError}
|
|
2124
2284
|
*/
|
|
2125
|
-
getReports(pageNum?: number, tagId?: string, reportTaskId?: string, options?: any): AxiosPromise<InlineResponse2003>;
|
|
2285
|
+
getReports(pageNum?: number, perPage?: number, orderBy?: 'title' | 'createdAt', order?: 'asc' | 'desc', tagId?: string, reportTaskId?: string, options?: any): AxiosPromise<InlineResponse2003>;
|
|
2126
2286
|
/**
|
|
2127
2287
|
*
|
|
2128
2288
|
* @summary Render a published report
|
|
@@ -2162,13 +2322,16 @@ export declare class ReportsApi extends BaseAPI {
|
|
|
2162
2322
|
*
|
|
2163
2323
|
* @summary List reports
|
|
2164
2324
|
* @param {number} [pageNum]
|
|
2325
|
+
* @param {number} [perPage]
|
|
2326
|
+
* @param {'title' | 'createdAt'} [orderBy] The field to order the list of reports on
|
|
2327
|
+
* @param {'asc' | 'desc'} [order] The order to sort the list of reports on
|
|
2165
2328
|
* @param {string} [tagId] A tagId to filter the list of reports on
|
|
2166
2329
|
* @param {string} [reportTaskId] A reportId to filter the list of reports on
|
|
2167
2330
|
* @param {*} [options] Override http request option.
|
|
2168
2331
|
* @throws {RequiredError}
|
|
2169
2332
|
* @memberof ReportsApi
|
|
2170
2333
|
*/
|
|
2171
|
-
getReports(pageNum?: number, tagId?: string, reportTaskId?: string, options?: any): Promise<import("axios").AxiosResponse<InlineResponse2003>>;
|
|
2334
|
+
getReports(pageNum?: number, perPage?: number, orderBy?: 'title' | 'createdAt', order?: 'asc' | 'desc', tagId?: string, reportTaskId?: string, options?: any): Promise<import("axios").AxiosResponse<InlineResponse2003>>;
|
|
2172
2335
|
/**
|
|
2173
2336
|
*
|
|
2174
2337
|
* @summary Render a published report
|