@connectreport/connectreport-js 2.71.4 → 2.78.6
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 +49 -1
- package/base.ts +1 -1
- package/common.ts +2 -4
- package/configuration.ts +3 -3
- package/dist/api.d.ts +82 -34
- package/dist/api.js +338 -309
- package/dist/base.d.ts +1 -1
- package/dist/base.js +4 -2
- package/dist/common.d.ts +2 -2
- package/dist/common.js +29 -28
- package/dist/configuration.d.ts +3 -3
- package/dist/configuration.js +1 -1
- package/dist/index.js +6 -3
- package/index.ts +9 -3
- package/package.json +4 -4
package/README.md
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
## @connectreport/connectreport-js@2.
|
|
1
|
+
## @connectreport/connectreport-js@2.78.6
|
|
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.78.6/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.78.6 --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.78.6
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -153,6 +153,18 @@ export interface FilterCycle {
|
|
|
153
153
|
* @memberof FilterCycle
|
|
154
154
|
*/
|
|
155
155
|
trigger?: string;
|
|
156
|
+
/**
|
|
157
|
+
* The customized subject of the email to be sent if the report task is configured to email
|
|
158
|
+
* @type {string}
|
|
159
|
+
* @memberof FilterCycle
|
|
160
|
+
*/
|
|
161
|
+
emailSubject?: string;
|
|
162
|
+
/**
|
|
163
|
+
* The customized body of the email to be sent if the report task is configured to email
|
|
164
|
+
* @type {string}
|
|
165
|
+
* @memberof FilterCycle
|
|
166
|
+
*/
|
|
167
|
+
emailBody?: string;
|
|
156
168
|
/**
|
|
157
169
|
*
|
|
158
170
|
* @type {FilterCycleAllOfFieldInfo}
|
|
@@ -677,6 +689,18 @@ export interface ReportTask {
|
|
|
677
689
|
* @memberof ReportTask
|
|
678
690
|
*/
|
|
679
691
|
trigger?: string;
|
|
692
|
+
/**
|
|
693
|
+
* The customized subject of the email to be sent if the report task is configured to email
|
|
694
|
+
* @type {string}
|
|
695
|
+
* @memberof ReportTask
|
|
696
|
+
*/
|
|
697
|
+
emailSubject?: string;
|
|
698
|
+
/**
|
|
699
|
+
* The customized body of the email to be sent if the report task is configured to email
|
|
700
|
+
* @type {string}
|
|
701
|
+
* @memberof ReportTask
|
|
702
|
+
*/
|
|
703
|
+
emailBody?: string;
|
|
680
704
|
}
|
|
681
705
|
|
|
682
706
|
/**
|
|
@@ -911,6 +935,18 @@ export interface ReportTaskRequest {
|
|
|
911
935
|
* @memberof ReportTaskRequest
|
|
912
936
|
*/
|
|
913
937
|
trigger?: string;
|
|
938
|
+
/**
|
|
939
|
+
* The customized subject of the email to be sent if the report task is configured to email
|
|
940
|
+
* @type {string}
|
|
941
|
+
* @memberof ReportTaskRequest
|
|
942
|
+
*/
|
|
943
|
+
emailSubject?: string;
|
|
944
|
+
/**
|
|
945
|
+
* The customized body of the email to be sent if the report task is configured to email
|
|
946
|
+
* @type {string}
|
|
947
|
+
* @memberof ReportTaskRequest
|
|
948
|
+
*/
|
|
949
|
+
emailBody?: string;
|
|
914
950
|
/**
|
|
915
951
|
* Emails to send the report to. This is only allowed if \"Allow reports to be shared with any email\" is to true.
|
|
916
952
|
* @type {Array<string>}
|
|
@@ -1125,6 +1161,18 @@ export interface ReportTaskResponse {
|
|
|
1125
1161
|
* @memberof ReportTaskResponse
|
|
1126
1162
|
*/
|
|
1127
1163
|
trigger?: string;
|
|
1164
|
+
/**
|
|
1165
|
+
* The customized subject of the email to be sent if the report task is configured to email
|
|
1166
|
+
* @type {string}
|
|
1167
|
+
* @memberof ReportTaskResponse
|
|
1168
|
+
*/
|
|
1169
|
+
emailSubject?: string;
|
|
1170
|
+
/**
|
|
1171
|
+
* The customized body of the email to be sent if the report task is configured to email
|
|
1172
|
+
* @type {string}
|
|
1173
|
+
* @memberof ReportTaskResponse
|
|
1174
|
+
*/
|
|
1175
|
+
emailBody?: string;
|
|
1128
1176
|
/**
|
|
1129
1177
|
* Users to share the published report with. This field will be updated entirely if provided
|
|
1130
1178
|
* @type {Array<ReportTaskResponseAllOfUsersToShareWith>}
|
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.78.6
|
|
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.78.6
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -40,9 +40,7 @@ export const assertParamExists = function (functionName: string, paramName: stri
|
|
|
40
40
|
*/
|
|
41
41
|
export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) {
|
|
42
42
|
if (configuration && configuration.apiKey) {
|
|
43
|
-
const localVarApiKeyValue =
|
|
44
|
-
? await configuration.apiKey(keyParamName)
|
|
45
|
-
: await configuration.apiKey;
|
|
43
|
+
const localVarApiKeyValue = await configuration.apiKey;
|
|
46
44
|
object[keyParamName] = localVarApiKeyValue;
|
|
47
45
|
}
|
|
48
46
|
}
|
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.78.6
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -14,7 +14,7 @@
|
|
|
14
14
|
|
|
15
15
|
|
|
16
16
|
export interface ConfigurationParameters {
|
|
17
|
-
apiKey?: string
|
|
17
|
+
apiKey?: string;
|
|
18
18
|
httpsAgent?: any;
|
|
19
19
|
username?: string;
|
|
20
20
|
password?: string;
|
|
@@ -30,7 +30,7 @@ export class Configuration {
|
|
|
30
30
|
* @param name security name
|
|
31
31
|
* @memberof Configuration
|
|
32
32
|
*/
|
|
33
|
-
apiKey?: string
|
|
33
|
+
apiKey?: string;
|
|
34
34
|
/**
|
|
35
35
|
* parameter for basic security
|
|
36
36
|
*
|
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.78.6
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -146,6 +146,18 @@ export interface FilterCycle {
|
|
|
146
146
|
* @memberof FilterCycle
|
|
147
147
|
*/
|
|
148
148
|
trigger?: string;
|
|
149
|
+
/**
|
|
150
|
+
* The customized subject of the email to be sent if the report task is configured to email
|
|
151
|
+
* @type {string}
|
|
152
|
+
* @memberof FilterCycle
|
|
153
|
+
*/
|
|
154
|
+
emailSubject?: string;
|
|
155
|
+
/**
|
|
156
|
+
* The customized body of the email to be sent if the report task is configured to email
|
|
157
|
+
* @type {string}
|
|
158
|
+
* @memberof FilterCycle
|
|
159
|
+
*/
|
|
160
|
+
emailBody?: string;
|
|
149
161
|
/**
|
|
150
162
|
*
|
|
151
163
|
* @type {FilterCycleAllOfFieldInfo}
|
|
@@ -670,6 +682,18 @@ export interface ReportTask {
|
|
|
670
682
|
* @memberof ReportTask
|
|
671
683
|
*/
|
|
672
684
|
trigger?: string;
|
|
685
|
+
/**
|
|
686
|
+
* The customized subject of the email to be sent if the report task is configured to email
|
|
687
|
+
* @type {string}
|
|
688
|
+
* @memberof ReportTask
|
|
689
|
+
*/
|
|
690
|
+
emailSubject?: string;
|
|
691
|
+
/**
|
|
692
|
+
* The customized body of the email to be sent if the report task is configured to email
|
|
693
|
+
* @type {string}
|
|
694
|
+
* @memberof ReportTask
|
|
695
|
+
*/
|
|
696
|
+
emailBody?: string;
|
|
673
697
|
}
|
|
674
698
|
/**
|
|
675
699
|
* @export
|
|
@@ -904,6 +928,18 @@ export interface ReportTaskRequest {
|
|
|
904
928
|
* @memberof ReportTaskRequest
|
|
905
929
|
*/
|
|
906
930
|
trigger?: string;
|
|
931
|
+
/**
|
|
932
|
+
* The customized subject of the email to be sent if the report task is configured to email
|
|
933
|
+
* @type {string}
|
|
934
|
+
* @memberof ReportTaskRequest
|
|
935
|
+
*/
|
|
936
|
+
emailSubject?: string;
|
|
937
|
+
/**
|
|
938
|
+
* The customized body of the email to be sent if the report task is configured to email
|
|
939
|
+
* @type {string}
|
|
940
|
+
* @memberof ReportTaskRequest
|
|
941
|
+
*/
|
|
942
|
+
emailBody?: string;
|
|
907
943
|
/**
|
|
908
944
|
* Emails to send the report to. This is only allowed if \"Allow reports to be shared with any email\" is to true.
|
|
909
945
|
* @type {Array<string>}
|
|
@@ -1118,6 +1154,18 @@ export interface ReportTaskResponse {
|
|
|
1118
1154
|
* @memberof ReportTaskResponse
|
|
1119
1155
|
*/
|
|
1120
1156
|
trigger?: string;
|
|
1157
|
+
/**
|
|
1158
|
+
* The customized subject of the email to be sent if the report task is configured to email
|
|
1159
|
+
* @type {string}
|
|
1160
|
+
* @memberof ReportTaskResponse
|
|
1161
|
+
*/
|
|
1162
|
+
emailSubject?: string;
|
|
1163
|
+
/**
|
|
1164
|
+
* The customized body of the email to be sent if the report task is configured to email
|
|
1165
|
+
* @type {string}
|
|
1166
|
+
* @memberof ReportTaskResponse
|
|
1167
|
+
*/
|
|
1168
|
+
emailBody?: string;
|
|
1121
1169
|
/**
|
|
1122
1170
|
* Users to share the published report with. This field will be updated entirely if provided
|
|
1123
1171
|
* @type {Array<ReportTaskResponseAllOfUsersToShareWith>}
|
|
@@ -1406,7 +1454,7 @@ export declare class BaseTemplatesApi extends BaseAPI {
|
|
|
1406
1454
|
* @throws {RequiredError}
|
|
1407
1455
|
* @memberof BaseTemplatesApi
|
|
1408
1456
|
*/
|
|
1409
|
-
duplicateBaseTemplate(id: string, options?: any): Promise<import("axios").AxiosResponse<Template>>;
|
|
1457
|
+
duplicateBaseTemplate(id: string, options?: any): Promise<import("axios").AxiosResponse<Template, any>>;
|
|
1410
1458
|
/**
|
|
1411
1459
|
*
|
|
1412
1460
|
* @summary List base templates
|
|
@@ -1416,7 +1464,7 @@ export declare class BaseTemplatesApi extends BaseAPI {
|
|
|
1416
1464
|
* @throws {RequiredError}
|
|
1417
1465
|
* @memberof BaseTemplatesApi
|
|
1418
1466
|
*/
|
|
1419
|
-
getBaseTemplates(pageNum?: number, page?: number, options?: any): Promise<import("axios").AxiosResponse<InlineResponse200>>;
|
|
1467
|
+
getBaseTemplates(pageNum?: number, page?: number, options?: any): Promise<import("axios").AxiosResponse<InlineResponse200, any>>;
|
|
1420
1468
|
}
|
|
1421
1469
|
/**
|
|
1422
1470
|
* DocumentsApi - axios parameter creator
|
|
@@ -1483,7 +1531,7 @@ export declare class DocumentsApi extends BaseAPI {
|
|
|
1483
1531
|
* @throws {RequiredError}
|
|
1484
1532
|
* @memberof DocumentsApi
|
|
1485
1533
|
*/
|
|
1486
|
-
getDocument(fileName: string, fileType: 'pdf' | 'pptx' | 'xlsx' | 'csv', attachmentName?: string, options?: any): Promise<import("axios").AxiosResponse<any>>;
|
|
1534
|
+
getDocument(fileName: string, fileType: 'pdf' | 'pptx' | 'xlsx' | 'csv', attachmentName?: string, options?: any): Promise<import("axios").AxiosResponse<any, any>>;
|
|
1487
1535
|
}
|
|
1488
1536
|
/**
|
|
1489
1537
|
* FilterCyclesApi - axios parameter creator
|
|
@@ -1689,7 +1737,7 @@ export declare class FilterCyclesApi extends BaseAPI {
|
|
|
1689
1737
|
* @throws {RequiredError}
|
|
1690
1738
|
* @memberof FilterCyclesApi
|
|
1691
1739
|
*/
|
|
1692
|
-
createFilterCycle(filterCycle: FilterCycle, options?: any): Promise<import("axios").AxiosResponse<FilterCycle>>;
|
|
1740
|
+
createFilterCycle(filterCycle: FilterCycle, options?: any): Promise<import("axios").AxiosResponse<FilterCycle, any>>;
|
|
1693
1741
|
/**
|
|
1694
1742
|
*
|
|
1695
1743
|
* @summary Delete a filter cycle
|
|
@@ -1698,7 +1746,7 @@ export declare class FilterCyclesApi extends BaseAPI {
|
|
|
1698
1746
|
* @throws {RequiredError}
|
|
1699
1747
|
* @memberof FilterCyclesApi
|
|
1700
1748
|
*/
|
|
1701
|
-
deleteFilterCycle(id: string, options?: any): Promise<import("axios").AxiosResponse<FilterCycle>>;
|
|
1749
|
+
deleteFilterCycle(id: string, options?: any): Promise<import("axios").AxiosResponse<FilterCycle, any>>;
|
|
1702
1750
|
/**
|
|
1703
1751
|
*
|
|
1704
1752
|
* @summary Disable all report tasks in a cycle
|
|
@@ -1707,7 +1755,7 @@ export declare class FilterCyclesApi extends BaseAPI {
|
|
|
1707
1755
|
* @throws {RequiredError}
|
|
1708
1756
|
* @memberof FilterCyclesApi
|
|
1709
1757
|
*/
|
|
1710
|
-
disableAllInCycle(id: string, options?: any): Promise<import("axios").AxiosResponse<void>>;
|
|
1758
|
+
disableAllInCycle(id: string, options?: any): Promise<import("axios").AxiosResponse<void, any>>;
|
|
1711
1759
|
/**
|
|
1712
1760
|
*
|
|
1713
1761
|
* @summary Enable all report tasks in a cycle
|
|
@@ -1716,7 +1764,7 @@ export declare class FilterCyclesApi extends BaseAPI {
|
|
|
1716
1764
|
* @throws {RequiredError}
|
|
1717
1765
|
* @memberof FilterCyclesApi
|
|
1718
1766
|
*/
|
|
1719
|
-
enableAllInCycle(id: string, options?: any): Promise<import("axios").AxiosResponse<void>>;
|
|
1767
|
+
enableAllInCycle(id: string, options?: any): Promise<import("axios").AxiosResponse<void, any>>;
|
|
1720
1768
|
/**
|
|
1721
1769
|
*
|
|
1722
1770
|
* @summary Get a filter cycle
|
|
@@ -1725,7 +1773,7 @@ export declare class FilterCyclesApi extends BaseAPI {
|
|
|
1725
1773
|
* @throws {RequiredError}
|
|
1726
1774
|
* @memberof FilterCyclesApi
|
|
1727
1775
|
*/
|
|
1728
|
-
getFilterCycle(id: string, options?: any): Promise<import("axios").AxiosResponse<FilterCycle>>;
|
|
1776
|
+
getFilterCycle(id: string, options?: any): Promise<import("axios").AxiosResponse<FilterCycle, any>>;
|
|
1729
1777
|
/**
|
|
1730
1778
|
*
|
|
1731
1779
|
* @summary List filter cycles
|
|
@@ -1734,7 +1782,7 @@ export declare class FilterCyclesApi extends BaseAPI {
|
|
|
1734
1782
|
* @throws {RequiredError}
|
|
1735
1783
|
* @memberof FilterCyclesApi
|
|
1736
1784
|
*/
|
|
1737
|
-
getFilterCycles(templateId: string, options?: any): Promise<import("axios").AxiosResponse<FilterCycle[]>>;
|
|
1785
|
+
getFilterCycles(templateId: string, options?: any): Promise<import("axios").AxiosResponse<FilterCycle[], any>>;
|
|
1738
1786
|
/**
|
|
1739
1787
|
*
|
|
1740
1788
|
* @summary Update a filter cycle
|
|
@@ -1744,7 +1792,7 @@ export declare class FilterCyclesApi extends BaseAPI {
|
|
|
1744
1792
|
* @throws {RequiredError}
|
|
1745
1793
|
* @memberof FilterCyclesApi
|
|
1746
1794
|
*/
|
|
1747
|
-
updateFilterCycle(id: string, filterCycle: FilterCycle, options?: any): Promise<import("axios").AxiosResponse<FilterCycle>>;
|
|
1795
|
+
updateFilterCycle(id: string, filterCycle: FilterCycle, options?: any): Promise<import("axios").AxiosResponse<FilterCycle, any>>;
|
|
1748
1796
|
}
|
|
1749
1797
|
/**
|
|
1750
1798
|
* ImagesApi - axios parameter creator
|
|
@@ -1827,7 +1875,7 @@ export declare class ImagesApi extends BaseAPI {
|
|
|
1827
1875
|
* @throws {RequiredError}
|
|
1828
1876
|
* @memberof ImagesApi
|
|
1829
1877
|
*/
|
|
1830
|
-
getImage(title: string, options?: any): Promise<import("axios").AxiosResponse<any>>;
|
|
1878
|
+
getImage(title: string, options?: any): Promise<import("axios").AxiosResponse<any, any>>;
|
|
1831
1879
|
/**
|
|
1832
1880
|
* Uploads an image to the server for use in templates
|
|
1833
1881
|
* @summary Upload an image for use in a template
|
|
@@ -1836,7 +1884,7 @@ export declare class ImagesApi extends BaseAPI {
|
|
|
1836
1884
|
* @throws {RequiredError}
|
|
1837
1885
|
* @memberof ImagesApi
|
|
1838
1886
|
*/
|
|
1839
|
-
uploadImage(image?: any, options?: any): Promise<import("axios").AxiosResponse<InlineResponse2001>>;
|
|
1887
|
+
uploadImage(image?: any, options?: any): Promise<import("axios").AxiosResponse<InlineResponse2001, any>>;
|
|
1840
1888
|
}
|
|
1841
1889
|
/**
|
|
1842
1890
|
* JobsApi - axios parameter creator
|
|
@@ -1895,7 +1943,7 @@ export declare class JobsApi extends BaseAPI {
|
|
|
1895
1943
|
* @throws {RequiredError}
|
|
1896
1944
|
* @memberof JobsApi
|
|
1897
1945
|
*/
|
|
1898
|
-
getJob(id: string, options?: any): Promise<import("axios").AxiosResponse<Job>>;
|
|
1946
|
+
getJob(id: string, options?: any): Promise<import("axios").AxiosResponse<Job, any>>;
|
|
1899
1947
|
}
|
|
1900
1948
|
/**
|
|
1901
1949
|
* ReportTasksApi - axios parameter creator
|
|
@@ -2104,7 +2152,7 @@ export declare class ReportTasksApi extends BaseAPI {
|
|
|
2104
2152
|
* @throws {RequiredError}
|
|
2105
2153
|
* @memberof ReportTasksApi
|
|
2106
2154
|
*/
|
|
2107
|
-
createReportTask(reportTaskRequest: ReportTaskRequest, options?: any): Promise<import("axios").AxiosResponse<ReportTaskResponse>>;
|
|
2155
|
+
createReportTask(reportTaskRequest: ReportTaskRequest, options?: any): Promise<import("axios").AxiosResponse<ReportTaskResponse, any>>;
|
|
2108
2156
|
/**
|
|
2109
2157
|
* Delete a report task by its ID
|
|
2110
2158
|
* @summary Delete report task
|
|
@@ -2114,7 +2162,7 @@ export declare class ReportTasksApi extends BaseAPI {
|
|
|
2114
2162
|
* @throws {RequiredError}
|
|
2115
2163
|
* @memberof ReportTasksApi
|
|
2116
2164
|
*/
|
|
2117
|
-
deleteReportTask(id: string, deleteAssociatedReports?: boolean, options?: any): Promise<import("axios").AxiosResponse<void>>;
|
|
2165
|
+
deleteReportTask(id: string, deleteAssociatedReports?: boolean, options?: any): Promise<import("axios").AxiosResponse<void, any>>;
|
|
2118
2166
|
/**
|
|
2119
2167
|
* Read a report task by its ID
|
|
2120
2168
|
* @summary Read report task
|
|
@@ -2123,7 +2171,7 @@ export declare class ReportTasksApi extends BaseAPI {
|
|
|
2123
2171
|
* @throws {RequiredError}
|
|
2124
2172
|
* @memberof ReportTasksApi
|
|
2125
2173
|
*/
|
|
2126
|
-
getReportTask(id: string, options?: any): Promise<import("axios").AxiosResponse<ReportTaskResponse>>;
|
|
2174
|
+
getReportTask(id: string, options?: any): Promise<import("axios").AxiosResponse<ReportTaskResponse, any>>;
|
|
2127
2175
|
/**
|
|
2128
2176
|
*
|
|
2129
2177
|
* @summary List report tasks
|
|
@@ -2140,7 +2188,7 @@ export declare class ReportTasksApi extends BaseAPI {
|
|
|
2140
2188
|
*/
|
|
2141
2189
|
getReportTasks(pageNum?: number, meta?: {
|
|
2142
2190
|
[key: string]: string;
|
|
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>>;
|
|
2191
|
+
}, 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, any>>;
|
|
2144
2192
|
/**
|
|
2145
2193
|
* Duplicates the task and runs it as \"Once - Now\"
|
|
2146
2194
|
* @summary Run task now
|
|
@@ -2149,7 +2197,7 @@ export declare class ReportTasksApi extends BaseAPI {
|
|
|
2149
2197
|
* @throws {RequiredError}
|
|
2150
2198
|
* @memberof ReportTasksApi
|
|
2151
2199
|
*/
|
|
2152
|
-
runReportTaskNow(id: string, options?: any): Promise<import("axios").AxiosResponse<ReportTaskResponse>>;
|
|
2200
|
+
runReportTaskNow(id: string, options?: any): Promise<import("axios").AxiosResponse<ReportTaskResponse, any>>;
|
|
2153
2201
|
/**
|
|
2154
2202
|
* Accepts partial updates
|
|
2155
2203
|
* @summary Update report task by ID
|
|
@@ -2159,7 +2207,7 @@ export declare class ReportTasksApi extends BaseAPI {
|
|
|
2159
2207
|
* @throws {RequiredError}
|
|
2160
2208
|
* @memberof ReportTasksApi
|
|
2161
2209
|
*/
|
|
2162
|
-
updateReportTask(id: string, reportTaskRequest: ReportTaskRequest, options?: any): Promise<import("axios").AxiosResponse<ReportTaskResponse>>;
|
|
2210
|
+
updateReportTask(id: string, reportTaskRequest: ReportTaskRequest, options?: any): Promise<import("axios").AxiosResponse<ReportTaskResponse, any>>;
|
|
2163
2211
|
}
|
|
2164
2212
|
/**
|
|
2165
2213
|
* ReportsApi - axios parameter creator
|
|
@@ -2308,7 +2356,7 @@ export declare class ReportsApi extends BaseAPI {
|
|
|
2308
2356
|
* @throws {RequiredError}
|
|
2309
2357
|
* @memberof ReportsApi
|
|
2310
2358
|
*/
|
|
2311
|
-
deleteReport(id: string, options?: any): Promise<import("axios").AxiosResponse<Report>>;
|
|
2359
|
+
deleteReport(id: string, options?: any): Promise<import("axios").AxiosResponse<Report, any>>;
|
|
2312
2360
|
/**
|
|
2313
2361
|
*
|
|
2314
2362
|
* @summary Get a published report
|
|
@@ -2317,7 +2365,7 @@ export declare class ReportsApi extends BaseAPI {
|
|
|
2317
2365
|
* @throws {RequiredError}
|
|
2318
2366
|
* @memberof ReportsApi
|
|
2319
2367
|
*/
|
|
2320
|
-
getReport(id: string, options?: any): Promise<import("axios").AxiosResponse<Report>>;
|
|
2368
|
+
getReport(id: string, options?: any): Promise<import("axios").AxiosResponse<Report, any>>;
|
|
2321
2369
|
/**
|
|
2322
2370
|
*
|
|
2323
2371
|
* @summary List reports
|
|
@@ -2331,7 +2379,7 @@ export declare class ReportsApi extends BaseAPI {
|
|
|
2331
2379
|
* @throws {RequiredError}
|
|
2332
2380
|
* @memberof ReportsApi
|
|
2333
2381
|
*/
|
|
2334
|
-
getReports(pageNum?: number, perPage?: number, orderBy?: 'title' | 'createdAt', order?: 'asc' | 'desc', tagId?: string, reportTaskId?: string, options?: any): Promise<import("axios").AxiosResponse<InlineResponse2003>>;
|
|
2382
|
+
getReports(pageNum?: number, perPage?: number, orderBy?: 'title' | 'createdAt', order?: 'asc' | 'desc', tagId?: string, reportTaskId?: string, options?: any): Promise<import("axios").AxiosResponse<InlineResponse2003, any>>;
|
|
2335
2383
|
/**
|
|
2336
2384
|
*
|
|
2337
2385
|
* @summary Render a published report
|
|
@@ -2341,7 +2389,7 @@ export declare class ReportsApi extends BaseAPI {
|
|
|
2341
2389
|
* @throws {RequiredError}
|
|
2342
2390
|
* @memberof ReportsApi
|
|
2343
2391
|
*/
|
|
2344
|
-
renderReport(id: string, format: 'pdf' | 'pptx' | 'xlsx' | 'csv', options?: any): Promise<import("axios").AxiosResponse<Job>>;
|
|
2392
|
+
renderReport(id: string, format: 'pdf' | 'pptx' | 'xlsx' | 'csv', options?: any): Promise<import("axios").AxiosResponse<Job, any>>;
|
|
2345
2393
|
}
|
|
2346
2394
|
/**
|
|
2347
2395
|
* TemplatesApi - axios parameter creator
|
|
@@ -2598,7 +2646,7 @@ export declare class TemplatesApi extends BaseAPI {
|
|
|
2598
2646
|
* @throws {RequiredError}
|
|
2599
2647
|
* @memberof TemplatesApi
|
|
2600
2648
|
*/
|
|
2601
|
-
createTemplate(template: Template, options?: any): Promise<import("axios").AxiosResponse<Template>>;
|
|
2649
|
+
createTemplate(template: Template, options?: any): Promise<import("axios").AxiosResponse<Template, any>>;
|
|
2602
2650
|
/**
|
|
2603
2651
|
* Delete a report template by its ID
|
|
2604
2652
|
* @summary Delete report template
|
|
@@ -2607,7 +2655,7 @@ export declare class TemplatesApi extends BaseAPI {
|
|
|
2607
2655
|
* @throws {RequiredError}
|
|
2608
2656
|
* @memberof TemplatesApi
|
|
2609
2657
|
*/
|
|
2610
|
-
deleteTemplate(id: string, options?: any): Promise<import("axios").AxiosResponse<Template>>;
|
|
2658
|
+
deleteTemplate(id: string, options?: any): Promise<import("axios").AxiosResponse<Template, any>>;
|
|
2611
2659
|
/**
|
|
2612
2660
|
* Duplicate a report template by its ID
|
|
2613
2661
|
* @summary Duplicate a report template
|
|
@@ -2616,7 +2664,7 @@ export declare class TemplatesApi extends BaseAPI {
|
|
|
2616
2664
|
* @throws {RequiredError}
|
|
2617
2665
|
* @memberof TemplatesApi
|
|
2618
2666
|
*/
|
|
2619
|
-
duplicateTemplate(id: string, options?: any): Promise<import("axios").AxiosResponse<Template>>;
|
|
2667
|
+
duplicateTemplate(id: string, options?: any): Promise<import("axios").AxiosResponse<Template, any>>;
|
|
2620
2668
|
/**
|
|
2621
2669
|
* Export a report template to a .CRPT file
|
|
2622
2670
|
* @summary Export a report template
|
|
@@ -2625,7 +2673,7 @@ export declare class TemplatesApi extends BaseAPI {
|
|
|
2625
2673
|
* @throws {RequiredError}
|
|
2626
2674
|
* @memberof TemplatesApi
|
|
2627
2675
|
*/
|
|
2628
|
-
exportTemplate(id: string, options?: any): Promise<import("axios").AxiosResponse<any>>;
|
|
2676
|
+
exportTemplate(id: string, options?: any): Promise<import("axios").AxiosResponse<any, any>>;
|
|
2629
2677
|
/**
|
|
2630
2678
|
* Read a report template by its ID
|
|
2631
2679
|
* @summary Read report template
|
|
@@ -2634,7 +2682,7 @@ export declare class TemplatesApi extends BaseAPI {
|
|
|
2634
2682
|
* @throws {RequiredError}
|
|
2635
2683
|
* @memberof TemplatesApi
|
|
2636
2684
|
*/
|
|
2637
|
-
getTemplate(id: string, options?: any): Promise<import("axios").AxiosResponse<Template>>;
|
|
2685
|
+
getTemplate(id: string, options?: any): Promise<import("axios").AxiosResponse<Template, any>>;
|
|
2638
2686
|
/**
|
|
2639
2687
|
*
|
|
2640
2688
|
* @summary List report templates
|
|
@@ -2643,7 +2691,7 @@ export declare class TemplatesApi extends BaseAPI {
|
|
|
2643
2691
|
* @throws {RequiredError}
|
|
2644
2692
|
* @memberof TemplatesApi
|
|
2645
2693
|
*/
|
|
2646
|
-
getTemplates(pageNum?: number, options?: any): Promise<import("axios").AxiosResponse<InlineResponse2004>>;
|
|
2694
|
+
getTemplates(pageNum?: number, options?: any): Promise<import("axios").AxiosResponse<InlineResponse2004, any>>;
|
|
2647
2695
|
/**
|
|
2648
2696
|
* Imports an exported .CRPT file
|
|
2649
2697
|
* @summary Import a template
|
|
@@ -2652,7 +2700,7 @@ export declare class TemplatesApi extends BaseAPI {
|
|
|
2652
2700
|
* @throws {RequiredError}
|
|
2653
2701
|
* @memberof TemplatesApi
|
|
2654
2702
|
*/
|
|
2655
|
-
importTemplate(template?: any, options?: any): Promise<import("axios").AxiosResponse<Template>>;
|
|
2703
|
+
importTemplate(template?: any, options?: any): Promise<import("axios").AxiosResponse<Template, any>>;
|
|
2656
2704
|
/**
|
|
2657
2705
|
* Render a report template to PDF, PPTX, or XLSX. Responds with a job entity.
|
|
2658
2706
|
* @summary Render a report template
|
|
@@ -2662,7 +2710,7 @@ export declare class TemplatesApi extends BaseAPI {
|
|
|
2662
2710
|
* @throws {RequiredError}
|
|
2663
2711
|
* @memberof TemplatesApi
|
|
2664
2712
|
*/
|
|
2665
|
-
renderTemplate(id: string, format: 'pdf' | 'pptx' | 'xlsx' | 'csv', options?: any): Promise<import("axios").AxiosResponse<JobResponse>>;
|
|
2713
|
+
renderTemplate(id: string, format: 'pdf' | 'pptx' | 'xlsx' | 'csv', options?: any): Promise<import("axios").AxiosResponse<JobResponse, any>>;
|
|
2666
2714
|
/**
|
|
2667
2715
|
* Accepts partial updates
|
|
2668
2716
|
* @summary Update report template by ID
|
|
@@ -2672,7 +2720,7 @@ export declare class TemplatesApi extends BaseAPI {
|
|
|
2672
2720
|
* @throws {RequiredError}
|
|
2673
2721
|
* @memberof TemplatesApi
|
|
2674
2722
|
*/
|
|
2675
|
-
updateTemplate(id: string, template: Template, options?: any): Promise<import("axios").AxiosResponse<Template>>;
|
|
2723
|
+
updateTemplate(id: string, template: Template, options?: any): Promise<import("axios").AxiosResponse<Template, any>>;
|
|
2676
2724
|
}
|
|
2677
2725
|
/**
|
|
2678
2726
|
* VisualizationApi - axios parameter creator
|
|
@@ -2735,5 +2783,5 @@ export declare class VisualizationApi extends BaseAPI {
|
|
|
2735
2783
|
* @throws {RequiredError}
|
|
2736
2784
|
* @memberof VisualizationApi
|
|
2737
2785
|
*/
|
|
2738
|
-
createVisualization(visualization: Visualization, priority?: 'high' | 'low', options?: any): Promise<import("axios").AxiosResponse<void>>;
|
|
2786
|
+
createVisualization(visualization: Visualization, priority?: 'high' | 'low', options?: any): Promise<import("axios").AxiosResponse<void, any>>;
|
|
2739
2787
|
}
|