@connectreport/connectreport-js 2.79.0 → 2.79.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/api.ts +1 -1
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/index.cjs +624 -2
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +1546 -165
- package/dist/index.d.ts +1546 -165
- package/dist/index.js +579 -1
- package/dist/index.js.map +1 -1
- package/index.ts +3 -1
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
import * as axios from 'axios';
|
|
2
|
-
import { AxiosInstance } from 'axios';
|
|
2
|
+
import { AxiosInstance, AxiosPromise } from 'axios';
|
|
3
3
|
|
|
4
4
|
/**
|
|
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.79.
|
|
8
|
+
* The version of the OpenAPI document: 2.79.1
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -91,7 +91,7 @@ declare class Configuration {
|
|
|
91
91
|
* ConnectReport Core API
|
|
92
92
|
* Leverage core reporting, templating, and document automation capabilities of ConnectReport Server.
|
|
93
93
|
*
|
|
94
|
-
* The version of the OpenAPI document: 2.79.
|
|
94
|
+
* The version of the OpenAPI document: 2.79.1
|
|
95
95
|
*
|
|
96
96
|
*
|
|
97
97
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -99,6 +99,15 @@ declare class Configuration {
|
|
|
99
99
|
* Do not edit the class manually.
|
|
100
100
|
*/
|
|
101
101
|
|
|
102
|
+
/**
|
|
103
|
+
*
|
|
104
|
+
* @export
|
|
105
|
+
* @interface RequestArgs
|
|
106
|
+
*/
|
|
107
|
+
interface RequestArgs {
|
|
108
|
+
url: string;
|
|
109
|
+
options: any;
|
|
110
|
+
}
|
|
102
111
|
/**
|
|
103
112
|
*
|
|
104
113
|
* @export
|
|
@@ -311,6 +320,43 @@ declare enum FilterCycleEmailEnum {
|
|
|
311
320
|
Xlsx = "xlsx",
|
|
312
321
|
Csv = "csv"
|
|
313
322
|
}
|
|
323
|
+
/**
|
|
324
|
+
*
|
|
325
|
+
* @export
|
|
326
|
+
* @interface FilterCycleAllOf
|
|
327
|
+
*/
|
|
328
|
+
interface FilterCycleAllOf {
|
|
329
|
+
/**
|
|
330
|
+
*
|
|
331
|
+
* @type {FilterCycleAllOfFieldInfo}
|
|
332
|
+
* @memberof FilterCycleAllOf
|
|
333
|
+
*/
|
|
334
|
+
fieldInfo?: FilterCycleAllOfFieldInfo;
|
|
335
|
+
/**
|
|
336
|
+
* This field will be updated entirely if provided and will result in removing any existing report tasks associated with the filter cycle.
|
|
337
|
+
* @type {Array<FilterCycleAllOfFieldValues>}
|
|
338
|
+
* @memberof FilterCycleAllOf
|
|
339
|
+
*/
|
|
340
|
+
fieldValues?: Array<FilterCycleAllOfFieldValues>;
|
|
341
|
+
/**
|
|
342
|
+
*
|
|
343
|
+
* @type {string}
|
|
344
|
+
* @memberof FilterCycleAllOf
|
|
345
|
+
*/
|
|
346
|
+
connectionId?: string;
|
|
347
|
+
/**
|
|
348
|
+
*
|
|
349
|
+
* @type {boolean}
|
|
350
|
+
* @memberof FilterCycleAllOf
|
|
351
|
+
*/
|
|
352
|
+
selectAll?: boolean;
|
|
353
|
+
/**
|
|
354
|
+
*
|
|
355
|
+
* @type {boolean}
|
|
356
|
+
* @memberof FilterCycleAllOf
|
|
357
|
+
*/
|
|
358
|
+
autotag?: boolean;
|
|
359
|
+
}
|
|
314
360
|
/**
|
|
315
361
|
*
|
|
316
362
|
* @export
|
|
@@ -530,6 +576,25 @@ interface JobResponse {
|
|
|
530
576
|
*/
|
|
531
577
|
userId?: string;
|
|
532
578
|
}
|
|
579
|
+
/**
|
|
580
|
+
*
|
|
581
|
+
* @export
|
|
582
|
+
* @interface ModelError
|
|
583
|
+
*/
|
|
584
|
+
interface ModelError {
|
|
585
|
+
/**
|
|
586
|
+
*
|
|
587
|
+
* @type {string}
|
|
588
|
+
* @memberof ModelError
|
|
589
|
+
*/
|
|
590
|
+
code?: string;
|
|
591
|
+
/**
|
|
592
|
+
*
|
|
593
|
+
* @type {string}
|
|
594
|
+
* @memberof ModelError
|
|
595
|
+
*/
|
|
596
|
+
message: string;
|
|
597
|
+
}
|
|
533
598
|
/**
|
|
534
599
|
*
|
|
535
600
|
* @export
|
|
@@ -591,6 +656,176 @@ interface Report {
|
|
|
591
656
|
*/
|
|
592
657
|
sizeBytes?: number;
|
|
593
658
|
}
|
|
659
|
+
/**
|
|
660
|
+
*
|
|
661
|
+
* @export
|
|
662
|
+
* @interface ReportTask
|
|
663
|
+
*/
|
|
664
|
+
interface ReportTask {
|
|
665
|
+
/**
|
|
666
|
+
*
|
|
667
|
+
* @type {string}
|
|
668
|
+
* @memberof ReportTask
|
|
669
|
+
*/
|
|
670
|
+
id?: string;
|
|
671
|
+
/**
|
|
672
|
+
* Title of the report task
|
|
673
|
+
* @type {string}
|
|
674
|
+
* @memberof ReportTask
|
|
675
|
+
*/
|
|
676
|
+
title: string;
|
|
677
|
+
/**
|
|
678
|
+
*
|
|
679
|
+
* @type {string}
|
|
680
|
+
* @memberof ReportTask
|
|
681
|
+
*/
|
|
682
|
+
templateId: string;
|
|
683
|
+
/**
|
|
684
|
+
* Datetime in UTC when report task\'s schedule will execute
|
|
685
|
+
* @type {string}
|
|
686
|
+
* @memberof ReportTask
|
|
687
|
+
*/
|
|
688
|
+
startOn: string;
|
|
689
|
+
/**
|
|
690
|
+
* Datetime in UTC when report task schedule will end
|
|
691
|
+
* @type {string}
|
|
692
|
+
* @memberof ReportTask
|
|
693
|
+
*/
|
|
694
|
+
endOn?: string;
|
|
695
|
+
/**
|
|
696
|
+
* Describes the frequency of the report task\'s schedule
|
|
697
|
+
* @type {string}
|
|
698
|
+
* @memberof ReportTask
|
|
699
|
+
*/
|
|
700
|
+
frequency: ReportTaskFrequencyEnum;
|
|
701
|
+
/**
|
|
702
|
+
*
|
|
703
|
+
* @type {number | string}
|
|
704
|
+
* @memberof ReportTask
|
|
705
|
+
*/
|
|
706
|
+
every?: number | string;
|
|
707
|
+
/**
|
|
708
|
+
* Denotes whether the report task will go into the report processing queue
|
|
709
|
+
* @type {boolean}
|
|
710
|
+
* @memberof ReportTask
|
|
711
|
+
*/
|
|
712
|
+
enabled?: boolean;
|
|
713
|
+
/**
|
|
714
|
+
* Array of objects denoting filter sets to apply to the report task
|
|
715
|
+
* @type {Array<ReportTaskFilterSets>}
|
|
716
|
+
* @memberof ReportTask
|
|
717
|
+
*/
|
|
718
|
+
filterSets?: Array<ReportTaskFilterSets>;
|
|
719
|
+
/**
|
|
720
|
+
*
|
|
721
|
+
* @type {string}
|
|
722
|
+
* @memberof ReportTask
|
|
723
|
+
*/
|
|
724
|
+
filterCycleId?: string;
|
|
725
|
+
/**
|
|
726
|
+
* Calculated datetime in UTC when the report task will run next, if applicable
|
|
727
|
+
* @type {string}
|
|
728
|
+
* @memberof ReportTask
|
|
729
|
+
*/
|
|
730
|
+
nextRunAt?: string;
|
|
731
|
+
/**
|
|
732
|
+
* The error object from the last report task execution, if applicable
|
|
733
|
+
* @type {string}
|
|
734
|
+
* @memberof ReportTask
|
|
735
|
+
*/
|
|
736
|
+
error?: string;
|
|
737
|
+
/**
|
|
738
|
+
* The average time to run the report task, in minutes
|
|
739
|
+
* @type {number}
|
|
740
|
+
* @memberof ReportTask
|
|
741
|
+
*/
|
|
742
|
+
averageTimeToGenerate?: number;
|
|
743
|
+
/**
|
|
744
|
+
* Custom filters to apply. This field will be updated entirely if provided
|
|
745
|
+
* @type {Array<ReportTaskCustomSelection>}
|
|
746
|
+
* @memberof ReportTask
|
|
747
|
+
*/
|
|
748
|
+
customSelection?: Array<ReportTaskCustomSelection>;
|
|
749
|
+
/**
|
|
750
|
+
*
|
|
751
|
+
* @type {Array<ReportTaskVariables>}
|
|
752
|
+
* @memberof ReportTask
|
|
753
|
+
*/
|
|
754
|
+
variables?: Array<ReportTaskVariables>;
|
|
755
|
+
/**
|
|
756
|
+
*
|
|
757
|
+
* @type {{ [key: string]: string; }}
|
|
758
|
+
* @memberof ReportTask
|
|
759
|
+
*/
|
|
760
|
+
meta?: {
|
|
761
|
+
[key: string]: string;
|
|
762
|
+
};
|
|
763
|
+
/**
|
|
764
|
+
* The time spent waiting on data platform responses during the last report task execution, in minutes
|
|
765
|
+
* @type {number}
|
|
766
|
+
* @memberof ReportTask
|
|
767
|
+
*/
|
|
768
|
+
dataPlatformWaitTime?: number;
|
|
769
|
+
/**
|
|
770
|
+
* Denotes whether the generated report should be emailed to its users or groups after a successful run
|
|
771
|
+
* @type {string}
|
|
772
|
+
* @memberof ReportTask
|
|
773
|
+
*/
|
|
774
|
+
email?: ReportTaskEmailEnum;
|
|
775
|
+
/**
|
|
776
|
+
* Groups to share the published report with. This field will be updated entirely if provided
|
|
777
|
+
* @type {Array<ReportTaskGroupsToShareWith>}
|
|
778
|
+
* @memberof ReportTask
|
|
779
|
+
*/
|
|
780
|
+
groupsToShareWith?: Array<ReportTaskGroupsToShareWith>;
|
|
781
|
+
/**
|
|
782
|
+
*
|
|
783
|
+
* @type {Array<ReportTaskTags>}
|
|
784
|
+
* @memberof ReportTask
|
|
785
|
+
*/
|
|
786
|
+
tags?: Array<ReportTaskTags>;
|
|
787
|
+
/**
|
|
788
|
+
* The trigger name for the report task. Used to execute tasks on a trigger
|
|
789
|
+
* @type {string}
|
|
790
|
+
* @memberof ReportTask
|
|
791
|
+
*/
|
|
792
|
+
trigger?: string;
|
|
793
|
+
/**
|
|
794
|
+
* The customized subject of the email to be sent if the report task is configured to email
|
|
795
|
+
* @type {string}
|
|
796
|
+
* @memberof ReportTask
|
|
797
|
+
*/
|
|
798
|
+
emailSubject?: string;
|
|
799
|
+
/**
|
|
800
|
+
* The customized body of the email to be sent if the report task is configured to email
|
|
801
|
+
* @type {string}
|
|
802
|
+
* @memberof ReportTask
|
|
803
|
+
*/
|
|
804
|
+
emailBody?: string;
|
|
805
|
+
}
|
|
806
|
+
/**
|
|
807
|
+
* @export
|
|
808
|
+
* @enum {string}
|
|
809
|
+
*/
|
|
810
|
+
declare enum ReportTaskFrequencyEnum {
|
|
811
|
+
Monthly = "Monthly",
|
|
812
|
+
OnceNow = "Once - now",
|
|
813
|
+
OnceScheduled = "Once - scheduled",
|
|
814
|
+
Annually = "Annually",
|
|
815
|
+
Daily = "Daily",
|
|
816
|
+
Weekly = "Weekly",
|
|
817
|
+
UponTrigger = "Upon trigger"
|
|
818
|
+
}
|
|
819
|
+
/**
|
|
820
|
+
* @export
|
|
821
|
+
* @enum {string}
|
|
822
|
+
*/
|
|
823
|
+
declare enum ReportTaskEmailEnum {
|
|
824
|
+
Pdf = "pdf",
|
|
825
|
+
Pptx = "pptx",
|
|
826
|
+
Xlsx = "xlsx",
|
|
827
|
+
Csv = "csv"
|
|
828
|
+
}
|
|
594
829
|
/**
|
|
595
830
|
*
|
|
596
831
|
* @export
|
|
@@ -855,6 +1090,31 @@ declare enum ReportTaskRequestEmailEnum {
|
|
|
855
1090
|
Xlsx = "xlsx",
|
|
856
1091
|
Csv = "csv"
|
|
857
1092
|
}
|
|
1093
|
+
/**
|
|
1094
|
+
*
|
|
1095
|
+
* @export
|
|
1096
|
+
* @interface ReportTaskRequestAllOf
|
|
1097
|
+
*/
|
|
1098
|
+
interface ReportTaskRequestAllOf {
|
|
1099
|
+
/**
|
|
1100
|
+
* Emails to send the report to. This is only allowed if \"Allow reports to be shared with any email\" is to true.
|
|
1101
|
+
* @type {Array<string>}
|
|
1102
|
+
* @memberof ReportTaskRequestAllOf
|
|
1103
|
+
*/
|
|
1104
|
+
emailRecipients?: Array<string>;
|
|
1105
|
+
/**
|
|
1106
|
+
* Denotes whether the email recipient list is confirmed. Value required to be true if emailRecipients is defined.
|
|
1107
|
+
* @type {boolean}
|
|
1108
|
+
* @memberof ReportTaskRequestAllOf
|
|
1109
|
+
*/
|
|
1110
|
+
confirmedEmailRecipients?: boolean;
|
|
1111
|
+
/**
|
|
1112
|
+
* Users to share the published report with. This field will be updated entirely if provided
|
|
1113
|
+
* @type {Array<ReportTaskRequestAllOfUsersToShareWith>}
|
|
1114
|
+
* @memberof ReportTaskRequestAllOf
|
|
1115
|
+
*/
|
|
1116
|
+
usersToShareWith?: Array<ReportTaskRequestAllOfUsersToShareWith>;
|
|
1117
|
+
}
|
|
858
1118
|
/**
|
|
859
1119
|
*
|
|
860
1120
|
* @export
|
|
@@ -1044,6 +1304,19 @@ declare enum ReportTaskResponseEmailEnum {
|
|
|
1044
1304
|
Xlsx = "xlsx",
|
|
1045
1305
|
Csv = "csv"
|
|
1046
1306
|
}
|
|
1307
|
+
/**
|
|
1308
|
+
*
|
|
1309
|
+
* @export
|
|
1310
|
+
* @interface ReportTaskResponseAllOf
|
|
1311
|
+
*/
|
|
1312
|
+
interface ReportTaskResponseAllOf {
|
|
1313
|
+
/**
|
|
1314
|
+
* Users to share the published report with. This field will be updated entirely if provided
|
|
1315
|
+
* @type {Array<ReportTaskResponseAllOfUsersToShareWith>}
|
|
1316
|
+
* @memberof ReportTaskResponseAllOf
|
|
1317
|
+
*/
|
|
1318
|
+
usersToShareWith?: Array<ReportTaskResponseAllOfUsersToShareWith>;
|
|
1319
|
+
}
|
|
1047
1320
|
/**
|
|
1048
1321
|
*
|
|
1049
1322
|
* @export
|
|
@@ -1139,288 +1412,1333 @@ interface Template {
|
|
|
1139
1412
|
pageHeight: number;
|
|
1140
1413
|
}
|
|
1141
1414
|
/**
|
|
1142
|
-
*
|
|
1415
|
+
*
|
|
1143
1416
|
* @export
|
|
1144
|
-
* @
|
|
1145
|
-
* @extends {BaseAPI}
|
|
1417
|
+
* @interface Visualization
|
|
1146
1418
|
*/
|
|
1147
|
-
|
|
1419
|
+
interface Visualization {
|
|
1148
1420
|
/**
|
|
1149
|
-
*
|
|
1150
|
-
* @
|
|
1151
|
-
* @
|
|
1152
|
-
* @param {*} [options] Override http request option.
|
|
1153
|
-
* @throws {RequiredError}
|
|
1154
|
-
* @memberof BaseTemplatesApi
|
|
1421
|
+
* The identifier of the visualization\'s parent document (e.g. Qlik Sense app, Sisense dashboard) in the data platform
|
|
1422
|
+
* @type {string}
|
|
1423
|
+
* @memberof Visualization
|
|
1155
1424
|
*/
|
|
1156
|
-
|
|
1425
|
+
docId?: string;
|
|
1157
1426
|
/**
|
|
1158
|
-
*
|
|
1159
|
-
* @
|
|
1160
|
-
* @
|
|
1161
|
-
* @param {number} [page]
|
|
1162
|
-
* @param {*} [options] Override http request option.
|
|
1163
|
-
* @throws {RequiredError}
|
|
1164
|
-
* @memberof BaseTemplatesApi
|
|
1427
|
+
* The identifier of the visualization in the data platform
|
|
1428
|
+
* @type {string}
|
|
1429
|
+
* @memberof Visualization
|
|
1165
1430
|
*/
|
|
1166
|
-
|
|
1167
|
-
}
|
|
1168
|
-
/**
|
|
1169
|
-
* DocumentsApi - object-oriented interface
|
|
1170
|
-
* @export
|
|
1171
|
-
* @class DocumentsApi
|
|
1172
|
-
* @extends {BaseAPI}
|
|
1173
|
-
*/
|
|
1174
|
-
declare class DocumentsApi extends BaseAPI {
|
|
1431
|
+
vizId?: string;
|
|
1175
1432
|
/**
|
|
1176
|
-
*
|
|
1177
|
-
* @
|
|
1178
|
-
* @
|
|
1179
|
-
|
|
1180
|
-
|
|
1181
|
-
|
|
1182
|
-
*
|
|
1433
|
+
* The target height of the returned image
|
|
1434
|
+
* @type {number}
|
|
1435
|
+
* @memberof Visualization
|
|
1436
|
+
*/
|
|
1437
|
+
height?: number;
|
|
1438
|
+
/**
|
|
1439
|
+
* The target width of the returned image
|
|
1440
|
+
* @type {number}
|
|
1441
|
+
* @memberof Visualization
|
|
1442
|
+
*/
|
|
1443
|
+
width?: number;
|
|
1444
|
+
/**
|
|
1445
|
+
* Indicates whether the visualization is a sheet (Qlik Sense specific)
|
|
1446
|
+
* @type {boolean}
|
|
1447
|
+
* @memberof Visualization
|
|
1448
|
+
*/
|
|
1449
|
+
isSheet?: boolean;
|
|
1450
|
+
/**
|
|
1451
|
+
* The data connector to use (e.g. \'qlikSense\')
|
|
1452
|
+
* @type {string}
|
|
1453
|
+
* @memberof Visualization
|
|
1454
|
+
*/
|
|
1455
|
+
connector?: string;
|
|
1456
|
+
/**
|
|
1457
|
+
* Returns a PNG visualization image with a transparent background if supported by the connector
|
|
1458
|
+
* @type {boolean}
|
|
1459
|
+
* @memberof Visualization
|
|
1460
|
+
*/
|
|
1461
|
+
isTransparent?: boolean;
|
|
1462
|
+
/**
|
|
1463
|
+
* Array of objects denoting filter sets to apply to the report task
|
|
1464
|
+
* @type {Array<ReportTaskFilterSets>}
|
|
1465
|
+
* @memberof Visualization
|
|
1466
|
+
*/
|
|
1467
|
+
filterSets?: Array<ReportTaskFilterSets>;
|
|
1468
|
+
/**
|
|
1469
|
+
* Custom filters to apply. This field will be updated entirely if provided
|
|
1470
|
+
* @type {Array<ReportTaskCustomSelection>}
|
|
1471
|
+
* @memberof Visualization
|
|
1472
|
+
*/
|
|
1473
|
+
selections?: Array<ReportTaskCustomSelection>;
|
|
1474
|
+
/**
|
|
1475
|
+
*
|
|
1476
|
+
* @type {Array<ReportTaskVariables>}
|
|
1477
|
+
* @memberof Visualization
|
|
1478
|
+
*/
|
|
1479
|
+
variables?: Array<ReportTaskVariables>;
|
|
1480
|
+
}
|
|
1481
|
+
/**
|
|
1482
|
+
* BaseTemplatesApi - axios parameter creator
|
|
1483
|
+
* @export
|
|
1484
|
+
*/
|
|
1485
|
+
declare const BaseTemplatesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
1486
|
+
/**
|
|
1487
|
+
* Duplicate a base template by its ID
|
|
1488
|
+
* @summary Duplicate a base template
|
|
1489
|
+
* @param {string} id
|
|
1490
|
+
* @param {*} [options] Override http request option.
|
|
1491
|
+
* @throws {RequiredError}
|
|
1492
|
+
*/
|
|
1493
|
+
duplicateBaseTemplate: (id: string, options?: any) => Promise<RequestArgs>;
|
|
1494
|
+
/**
|
|
1495
|
+
*
|
|
1496
|
+
* @summary List base templates
|
|
1497
|
+
* @param {number} [pageNum]
|
|
1498
|
+
* @param {number} [page]
|
|
1499
|
+
* @param {*} [options] Override http request option.
|
|
1500
|
+
* @throws {RequiredError}
|
|
1501
|
+
*/
|
|
1502
|
+
getBaseTemplates: (pageNum?: number, page?: number, options?: any) => Promise<RequestArgs>;
|
|
1503
|
+
};
|
|
1504
|
+
/**
|
|
1505
|
+
* BaseTemplatesApi - functional programming interface
|
|
1506
|
+
* @export
|
|
1507
|
+
*/
|
|
1508
|
+
declare const BaseTemplatesApiFp: (configuration?: Configuration) => {
|
|
1509
|
+
/**
|
|
1510
|
+
* Duplicate a base template by its ID
|
|
1511
|
+
* @summary Duplicate a base template
|
|
1512
|
+
* @param {string} id
|
|
1513
|
+
* @param {*} [options] Override http request option.
|
|
1514
|
+
* @throws {RequiredError}
|
|
1515
|
+
*/
|
|
1516
|
+
duplicateBaseTemplate(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Template>>;
|
|
1517
|
+
/**
|
|
1518
|
+
*
|
|
1519
|
+
* @summary List base templates
|
|
1520
|
+
* @param {number} [pageNum]
|
|
1521
|
+
* @param {number} [page]
|
|
1522
|
+
* @param {*} [options] Override http request option.
|
|
1523
|
+
* @throws {RequiredError}
|
|
1524
|
+
*/
|
|
1525
|
+
getBaseTemplates(pageNum?: number, page?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse200>>;
|
|
1526
|
+
};
|
|
1527
|
+
/**
|
|
1528
|
+
* BaseTemplatesApi - factory interface
|
|
1529
|
+
* @export
|
|
1530
|
+
*/
|
|
1531
|
+
declare const BaseTemplatesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
1532
|
+
/**
|
|
1533
|
+
* Duplicate a base template by its ID
|
|
1534
|
+
* @summary Duplicate a base template
|
|
1535
|
+
* @param {string} id
|
|
1536
|
+
* @param {*} [options] Override http request option.
|
|
1537
|
+
* @throws {RequiredError}
|
|
1538
|
+
*/
|
|
1539
|
+
duplicateBaseTemplate(id: string, options?: any): AxiosPromise<Template>;
|
|
1540
|
+
/**
|
|
1541
|
+
*
|
|
1542
|
+
* @summary List base templates
|
|
1543
|
+
* @param {number} [pageNum]
|
|
1544
|
+
* @param {number} [page]
|
|
1545
|
+
* @param {*} [options] Override http request option.
|
|
1546
|
+
* @throws {RequiredError}
|
|
1547
|
+
*/
|
|
1548
|
+
getBaseTemplates(pageNum?: number, page?: number, options?: any): AxiosPromise<InlineResponse200>;
|
|
1549
|
+
};
|
|
1550
|
+
/**
|
|
1551
|
+
* BaseTemplatesApi - object-oriented interface
|
|
1552
|
+
* @export
|
|
1553
|
+
* @class BaseTemplatesApi
|
|
1554
|
+
* @extends {BaseAPI}
|
|
1555
|
+
*/
|
|
1556
|
+
declare class BaseTemplatesApi extends BaseAPI {
|
|
1557
|
+
/**
|
|
1558
|
+
* Duplicate a base template by its ID
|
|
1559
|
+
* @summary Duplicate a base template
|
|
1560
|
+
* @param {string} id
|
|
1561
|
+
* @param {*} [options] Override http request option.
|
|
1562
|
+
* @throws {RequiredError}
|
|
1563
|
+
* @memberof BaseTemplatesApi
|
|
1564
|
+
*/
|
|
1565
|
+
duplicateBaseTemplate(id: string, options?: any): Promise<axios.AxiosResponse<Template, any>>;
|
|
1566
|
+
/**
|
|
1567
|
+
*
|
|
1568
|
+
* @summary List base templates
|
|
1569
|
+
* @param {number} [pageNum]
|
|
1570
|
+
* @param {number} [page]
|
|
1571
|
+
* @param {*} [options] Override http request option.
|
|
1572
|
+
* @throws {RequiredError}
|
|
1573
|
+
* @memberof BaseTemplatesApi
|
|
1574
|
+
*/
|
|
1575
|
+
getBaseTemplates(pageNum?: number, page?: number, options?: any): Promise<axios.AxiosResponse<InlineResponse200, any>>;
|
|
1576
|
+
}
|
|
1577
|
+
/**
|
|
1578
|
+
* DocumentsApi - axios parameter creator
|
|
1579
|
+
* @export
|
|
1580
|
+
*/
|
|
1581
|
+
declare const DocumentsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
1582
|
+
/**
|
|
1583
|
+
*
|
|
1584
|
+
* @summary Retrieve a generated document
|
|
1585
|
+
* @param {string} fileName
|
|
1586
|
+
* @param {'pdf' | 'pptx' | 'xlsx' | 'csv'} fileType
|
|
1587
|
+
* @param {string} [attachmentName] A document file title. This value is reflected back to the client in the fileName header.
|
|
1588
|
+
* @param {*} [options] Override http request option.
|
|
1589
|
+
* @throws {RequiredError}
|
|
1590
|
+
*/
|
|
1591
|
+
getDocument: (fileName: string, fileType: 'pdf' | 'pptx' | 'xlsx' | 'csv', attachmentName?: string, options?: any) => Promise<RequestArgs>;
|
|
1592
|
+
};
|
|
1593
|
+
/**
|
|
1594
|
+
* DocumentsApi - functional programming interface
|
|
1595
|
+
* @export
|
|
1596
|
+
*/
|
|
1597
|
+
declare const DocumentsApiFp: (configuration?: Configuration) => {
|
|
1598
|
+
/**
|
|
1599
|
+
*
|
|
1600
|
+
* @summary Retrieve a generated document
|
|
1601
|
+
* @param {string} fileName
|
|
1602
|
+
* @param {'pdf' | 'pptx' | 'xlsx' | 'csv'} fileType
|
|
1603
|
+
* @param {string} [attachmentName] A document file title. This value is reflected back to the client in the fileName header.
|
|
1604
|
+
* @param {*} [options] Override http request option.
|
|
1605
|
+
* @throws {RequiredError}
|
|
1606
|
+
*/
|
|
1607
|
+
getDocument(fileName: string, fileType: 'pdf' | 'pptx' | 'xlsx' | 'csv', attachmentName?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
|
|
1608
|
+
};
|
|
1609
|
+
/**
|
|
1610
|
+
* DocumentsApi - factory interface
|
|
1611
|
+
* @export
|
|
1612
|
+
*/
|
|
1613
|
+
declare const DocumentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
1614
|
+
/**
|
|
1615
|
+
*
|
|
1616
|
+
* @summary Retrieve a generated document
|
|
1617
|
+
* @param {string} fileName
|
|
1618
|
+
* @param {'pdf' | 'pptx' | 'xlsx' | 'csv'} fileType
|
|
1619
|
+
* @param {string} [attachmentName] A document file title. This value is reflected back to the client in the fileName header.
|
|
1620
|
+
* @param {*} [options] Override http request option.
|
|
1621
|
+
* @throws {RequiredError}
|
|
1622
|
+
*/
|
|
1623
|
+
getDocument(fileName: string, fileType: 'pdf' | 'pptx' | 'xlsx' | 'csv', attachmentName?: string, options?: any): AxiosPromise<any>;
|
|
1624
|
+
};
|
|
1625
|
+
/**
|
|
1626
|
+
* DocumentsApi - object-oriented interface
|
|
1627
|
+
* @export
|
|
1628
|
+
* @class DocumentsApi
|
|
1629
|
+
* @extends {BaseAPI}
|
|
1630
|
+
*/
|
|
1631
|
+
declare class DocumentsApi extends BaseAPI {
|
|
1632
|
+
/**
|
|
1633
|
+
*
|
|
1634
|
+
* @summary Retrieve a generated document
|
|
1635
|
+
* @param {string} fileName
|
|
1636
|
+
* @param {'pdf' | 'pptx' | 'xlsx' | 'csv'} fileType
|
|
1637
|
+
* @param {string} [attachmentName] A document file title. This value is reflected back to the client in the fileName header.
|
|
1638
|
+
* @param {*} [options] Override http request option.
|
|
1639
|
+
* @throws {RequiredError}
|
|
1183
1640
|
* @memberof DocumentsApi
|
|
1184
1641
|
*/
|
|
1185
1642
|
getDocument(fileName: string, fileType: 'pdf' | 'pptx' | 'xlsx' | 'csv', attachmentName?: string, options?: any): Promise<axios.AxiosResponse<any, any>>;
|
|
1186
1643
|
}
|
|
1187
1644
|
/**
|
|
1188
|
-
* FilterCyclesApi -
|
|
1645
|
+
* FilterCyclesApi - axios parameter creator
|
|
1646
|
+
* @export
|
|
1647
|
+
*/
|
|
1648
|
+
declare const FilterCyclesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
1649
|
+
/**
|
|
1650
|
+
*
|
|
1651
|
+
* @summary Create a filter cycle
|
|
1652
|
+
* @param {FilterCycle} filterCycle
|
|
1653
|
+
* @param {*} [options] Override http request option.
|
|
1654
|
+
* @throws {RequiredError}
|
|
1655
|
+
*/
|
|
1656
|
+
createFilterCycle: (filterCycle: FilterCycle, options?: any) => Promise<RequestArgs>;
|
|
1657
|
+
/**
|
|
1658
|
+
*
|
|
1659
|
+
* @summary Delete a filter cycle
|
|
1660
|
+
* @param {string} id
|
|
1661
|
+
* @param {*} [options] Override http request option.
|
|
1662
|
+
* @throws {RequiredError}
|
|
1663
|
+
*/
|
|
1664
|
+
deleteFilterCycle: (id: string, options?: any) => Promise<RequestArgs>;
|
|
1665
|
+
/**
|
|
1666
|
+
*
|
|
1667
|
+
* @summary Disable all report tasks in a cycle
|
|
1668
|
+
* @param {string} id
|
|
1669
|
+
* @param {*} [options] Override http request option.
|
|
1670
|
+
* @throws {RequiredError}
|
|
1671
|
+
*/
|
|
1672
|
+
disableAllInCycle: (id: string, options?: any) => Promise<RequestArgs>;
|
|
1673
|
+
/**
|
|
1674
|
+
*
|
|
1675
|
+
* @summary Enable all report tasks in a cycle
|
|
1676
|
+
* @param {string} id
|
|
1677
|
+
* @param {*} [options] Override http request option.
|
|
1678
|
+
* @throws {RequiredError}
|
|
1679
|
+
*/
|
|
1680
|
+
enableAllInCycle: (id: string, options?: any) => Promise<RequestArgs>;
|
|
1681
|
+
/**
|
|
1682
|
+
*
|
|
1683
|
+
* @summary Get a filter cycle
|
|
1684
|
+
* @param {string} id
|
|
1685
|
+
* @param {*} [options] Override http request option.
|
|
1686
|
+
* @throws {RequiredError}
|
|
1687
|
+
*/
|
|
1688
|
+
getFilterCycle: (id: string, options?: any) => Promise<RequestArgs>;
|
|
1689
|
+
/**
|
|
1690
|
+
*
|
|
1691
|
+
* @summary List filter cycles
|
|
1692
|
+
* @param {string} templateId
|
|
1693
|
+
* @param {*} [options] Override http request option.
|
|
1694
|
+
* @throws {RequiredError}
|
|
1695
|
+
*/
|
|
1696
|
+
getFilterCycles: (templateId: string, options?: any) => Promise<RequestArgs>;
|
|
1697
|
+
/**
|
|
1698
|
+
*
|
|
1699
|
+
* @summary Update a filter cycle
|
|
1700
|
+
* @param {string} id
|
|
1701
|
+
* @param {FilterCycle} filterCycle
|
|
1702
|
+
* @param {*} [options] Override http request option.
|
|
1703
|
+
* @throws {RequiredError}
|
|
1704
|
+
*/
|
|
1705
|
+
updateFilterCycle: (id: string, filterCycle: FilterCycle, options?: any) => Promise<RequestArgs>;
|
|
1706
|
+
};
|
|
1707
|
+
/**
|
|
1708
|
+
* FilterCyclesApi - functional programming interface
|
|
1709
|
+
* @export
|
|
1710
|
+
*/
|
|
1711
|
+
declare const FilterCyclesApiFp: (configuration?: Configuration) => {
|
|
1712
|
+
/**
|
|
1713
|
+
*
|
|
1714
|
+
* @summary Create a filter cycle
|
|
1715
|
+
* @param {FilterCycle} filterCycle
|
|
1716
|
+
* @param {*} [options] Override http request option.
|
|
1717
|
+
* @throws {RequiredError}
|
|
1718
|
+
*/
|
|
1719
|
+
createFilterCycle(filterCycle: FilterCycle, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FilterCycle>>;
|
|
1720
|
+
/**
|
|
1721
|
+
*
|
|
1722
|
+
* @summary Delete a filter cycle
|
|
1723
|
+
* @param {string} id
|
|
1724
|
+
* @param {*} [options] Override http request option.
|
|
1725
|
+
* @throws {RequiredError}
|
|
1726
|
+
*/
|
|
1727
|
+
deleteFilterCycle(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FilterCycle>>;
|
|
1728
|
+
/**
|
|
1729
|
+
*
|
|
1730
|
+
* @summary Disable all report tasks in a cycle
|
|
1731
|
+
* @param {string} id
|
|
1732
|
+
* @param {*} [options] Override http request option.
|
|
1733
|
+
* @throws {RequiredError}
|
|
1734
|
+
*/
|
|
1735
|
+
disableAllInCycle(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
1736
|
+
/**
|
|
1737
|
+
*
|
|
1738
|
+
* @summary Enable all report tasks in a cycle
|
|
1739
|
+
* @param {string} id
|
|
1740
|
+
* @param {*} [options] Override http request option.
|
|
1741
|
+
* @throws {RequiredError}
|
|
1742
|
+
*/
|
|
1743
|
+
enableAllInCycle(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
1744
|
+
/**
|
|
1745
|
+
*
|
|
1746
|
+
* @summary Get a filter cycle
|
|
1747
|
+
* @param {string} id
|
|
1748
|
+
* @param {*} [options] Override http request option.
|
|
1749
|
+
* @throws {RequiredError}
|
|
1750
|
+
*/
|
|
1751
|
+
getFilterCycle(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FilterCycle>>;
|
|
1752
|
+
/**
|
|
1753
|
+
*
|
|
1754
|
+
* @summary List filter cycles
|
|
1755
|
+
* @param {string} templateId
|
|
1756
|
+
* @param {*} [options] Override http request option.
|
|
1757
|
+
* @throws {RequiredError}
|
|
1758
|
+
*/
|
|
1759
|
+
getFilterCycles(templateId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<FilterCycle>>>;
|
|
1760
|
+
/**
|
|
1761
|
+
*
|
|
1762
|
+
* @summary Update a filter cycle
|
|
1763
|
+
* @param {string} id
|
|
1764
|
+
* @param {FilterCycle} filterCycle
|
|
1765
|
+
* @param {*} [options] Override http request option.
|
|
1766
|
+
* @throws {RequiredError}
|
|
1767
|
+
*/
|
|
1768
|
+
updateFilterCycle(id: string, filterCycle: FilterCycle, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FilterCycle>>;
|
|
1769
|
+
};
|
|
1770
|
+
/**
|
|
1771
|
+
* FilterCyclesApi - factory interface
|
|
1772
|
+
* @export
|
|
1773
|
+
*/
|
|
1774
|
+
declare const FilterCyclesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
1775
|
+
/**
|
|
1776
|
+
*
|
|
1777
|
+
* @summary Create a filter cycle
|
|
1778
|
+
* @param {FilterCycle} filterCycle
|
|
1779
|
+
* @param {*} [options] Override http request option.
|
|
1780
|
+
* @throws {RequiredError}
|
|
1781
|
+
*/
|
|
1782
|
+
createFilterCycle(filterCycle: FilterCycle, options?: any): AxiosPromise<FilterCycle>;
|
|
1783
|
+
/**
|
|
1784
|
+
*
|
|
1785
|
+
* @summary Delete a filter cycle
|
|
1786
|
+
* @param {string} id
|
|
1787
|
+
* @param {*} [options] Override http request option.
|
|
1788
|
+
* @throws {RequiredError}
|
|
1789
|
+
*/
|
|
1790
|
+
deleteFilterCycle(id: string, options?: any): AxiosPromise<FilterCycle>;
|
|
1791
|
+
/**
|
|
1792
|
+
*
|
|
1793
|
+
* @summary Disable all report tasks in a cycle
|
|
1794
|
+
* @param {string} id
|
|
1795
|
+
* @param {*} [options] Override http request option.
|
|
1796
|
+
* @throws {RequiredError}
|
|
1797
|
+
*/
|
|
1798
|
+
disableAllInCycle(id: string, options?: any): AxiosPromise<void>;
|
|
1799
|
+
/**
|
|
1800
|
+
*
|
|
1801
|
+
* @summary Enable all report tasks in a cycle
|
|
1802
|
+
* @param {string} id
|
|
1803
|
+
* @param {*} [options] Override http request option.
|
|
1804
|
+
* @throws {RequiredError}
|
|
1805
|
+
*/
|
|
1806
|
+
enableAllInCycle(id: string, options?: any): AxiosPromise<void>;
|
|
1807
|
+
/**
|
|
1808
|
+
*
|
|
1809
|
+
* @summary Get a filter cycle
|
|
1810
|
+
* @param {string} id
|
|
1811
|
+
* @param {*} [options] Override http request option.
|
|
1812
|
+
* @throws {RequiredError}
|
|
1813
|
+
*/
|
|
1814
|
+
getFilterCycle(id: string, options?: any): AxiosPromise<FilterCycle>;
|
|
1815
|
+
/**
|
|
1816
|
+
*
|
|
1817
|
+
* @summary List filter cycles
|
|
1818
|
+
* @param {string} templateId
|
|
1819
|
+
* @param {*} [options] Override http request option.
|
|
1820
|
+
* @throws {RequiredError}
|
|
1821
|
+
*/
|
|
1822
|
+
getFilterCycles(templateId: string, options?: any): AxiosPromise<Array<FilterCycle>>;
|
|
1823
|
+
/**
|
|
1824
|
+
*
|
|
1825
|
+
* @summary Update a filter cycle
|
|
1826
|
+
* @param {string} id
|
|
1827
|
+
* @param {FilterCycle} filterCycle
|
|
1828
|
+
* @param {*} [options] Override http request option.
|
|
1829
|
+
* @throws {RequiredError}
|
|
1830
|
+
*/
|
|
1831
|
+
updateFilterCycle(id: string, filterCycle: FilterCycle, options?: any): AxiosPromise<FilterCycle>;
|
|
1832
|
+
};
|
|
1833
|
+
/**
|
|
1834
|
+
* FilterCyclesApi - object-oriented interface
|
|
1835
|
+
* @export
|
|
1836
|
+
* @class FilterCyclesApi
|
|
1837
|
+
* @extends {BaseAPI}
|
|
1838
|
+
*/
|
|
1839
|
+
declare class FilterCyclesApi extends BaseAPI {
|
|
1840
|
+
/**
|
|
1841
|
+
*
|
|
1842
|
+
* @summary Create a filter cycle
|
|
1843
|
+
* @param {FilterCycle} filterCycle
|
|
1844
|
+
* @param {*} [options] Override http request option.
|
|
1845
|
+
* @throws {RequiredError}
|
|
1846
|
+
* @memberof FilterCyclesApi
|
|
1847
|
+
*/
|
|
1848
|
+
createFilterCycle(filterCycle: FilterCycle, options?: any): Promise<axios.AxiosResponse<FilterCycle, any>>;
|
|
1849
|
+
/**
|
|
1850
|
+
*
|
|
1851
|
+
* @summary Delete a filter cycle
|
|
1852
|
+
* @param {string} id
|
|
1853
|
+
* @param {*} [options] Override http request option.
|
|
1854
|
+
* @throws {RequiredError}
|
|
1855
|
+
* @memberof FilterCyclesApi
|
|
1856
|
+
*/
|
|
1857
|
+
deleteFilterCycle(id: string, options?: any): Promise<axios.AxiosResponse<FilterCycle, any>>;
|
|
1858
|
+
/**
|
|
1859
|
+
*
|
|
1860
|
+
* @summary Disable all report tasks in a cycle
|
|
1861
|
+
* @param {string} id
|
|
1862
|
+
* @param {*} [options] Override http request option.
|
|
1863
|
+
* @throws {RequiredError}
|
|
1864
|
+
* @memberof FilterCyclesApi
|
|
1865
|
+
*/
|
|
1866
|
+
disableAllInCycle(id: string, options?: any): Promise<axios.AxiosResponse<void, any>>;
|
|
1867
|
+
/**
|
|
1868
|
+
*
|
|
1869
|
+
* @summary Enable all report tasks in a cycle
|
|
1870
|
+
* @param {string} id
|
|
1871
|
+
* @param {*} [options] Override http request option.
|
|
1872
|
+
* @throws {RequiredError}
|
|
1873
|
+
* @memberof FilterCyclesApi
|
|
1874
|
+
*/
|
|
1875
|
+
enableAllInCycle(id: string, options?: any): Promise<axios.AxiosResponse<void, any>>;
|
|
1876
|
+
/**
|
|
1877
|
+
*
|
|
1878
|
+
* @summary Get a filter cycle
|
|
1879
|
+
* @param {string} id
|
|
1880
|
+
* @param {*} [options] Override http request option.
|
|
1881
|
+
* @throws {RequiredError}
|
|
1882
|
+
* @memberof FilterCyclesApi
|
|
1883
|
+
*/
|
|
1884
|
+
getFilterCycle(id: string, options?: any): Promise<axios.AxiosResponse<FilterCycle, any>>;
|
|
1885
|
+
/**
|
|
1886
|
+
*
|
|
1887
|
+
* @summary List filter cycles
|
|
1888
|
+
* @param {string} templateId
|
|
1889
|
+
* @param {*} [options] Override http request option.
|
|
1890
|
+
* @throws {RequiredError}
|
|
1891
|
+
* @memberof FilterCyclesApi
|
|
1892
|
+
*/
|
|
1893
|
+
getFilterCycles(templateId: string, options?: any): Promise<axios.AxiosResponse<FilterCycle[], any>>;
|
|
1894
|
+
/**
|
|
1895
|
+
*
|
|
1896
|
+
* @summary Update a filter cycle
|
|
1897
|
+
* @param {string} id
|
|
1898
|
+
* @param {FilterCycle} filterCycle
|
|
1899
|
+
* @param {*} [options] Override http request option.
|
|
1900
|
+
* @throws {RequiredError}
|
|
1901
|
+
* @memberof FilterCyclesApi
|
|
1902
|
+
*/
|
|
1903
|
+
updateFilterCycle(id: string, filterCycle: FilterCycle, options?: any): Promise<axios.AxiosResponse<FilterCycle, any>>;
|
|
1904
|
+
}
|
|
1905
|
+
/**
|
|
1906
|
+
* ImagesApi - axios parameter creator
|
|
1907
|
+
* @export
|
|
1908
|
+
*/
|
|
1909
|
+
declare const ImagesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
1910
|
+
/**
|
|
1911
|
+
*
|
|
1912
|
+
* @summary Retrieves a user uploaded image for use in a template
|
|
1913
|
+
* @param {string} title
|
|
1914
|
+
* @param {*} [options] Override http request option.
|
|
1915
|
+
* @throws {RequiredError}
|
|
1916
|
+
*/
|
|
1917
|
+
getImage: (title: string, options?: any) => Promise<RequestArgs>;
|
|
1918
|
+
/**
|
|
1919
|
+
* Uploads an image to the server for use in templates
|
|
1920
|
+
* @summary Upload an image for use in a template
|
|
1921
|
+
* @param {any} [image]
|
|
1922
|
+
* @param {*} [options] Override http request option.
|
|
1923
|
+
* @throws {RequiredError}
|
|
1924
|
+
*/
|
|
1925
|
+
uploadImage: (image?: any, options?: any) => Promise<RequestArgs>;
|
|
1926
|
+
};
|
|
1927
|
+
/**
|
|
1928
|
+
* ImagesApi - functional programming interface
|
|
1929
|
+
* @export
|
|
1930
|
+
*/
|
|
1931
|
+
declare const ImagesApiFp: (configuration?: Configuration) => {
|
|
1932
|
+
/**
|
|
1933
|
+
*
|
|
1934
|
+
* @summary Retrieves a user uploaded image for use in a template
|
|
1935
|
+
* @param {string} title
|
|
1936
|
+
* @param {*} [options] Override http request option.
|
|
1937
|
+
* @throws {RequiredError}
|
|
1938
|
+
*/
|
|
1939
|
+
getImage(title: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
|
|
1940
|
+
/**
|
|
1941
|
+
* Uploads an image to the server for use in templates
|
|
1942
|
+
* @summary Upload an image for use in a template
|
|
1943
|
+
* @param {any} [image]
|
|
1944
|
+
* @param {*} [options] Override http request option.
|
|
1945
|
+
* @throws {RequiredError}
|
|
1946
|
+
*/
|
|
1947
|
+
uploadImage(image?: any, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2001>>;
|
|
1948
|
+
};
|
|
1949
|
+
/**
|
|
1950
|
+
* ImagesApi - factory interface
|
|
1951
|
+
* @export
|
|
1952
|
+
*/
|
|
1953
|
+
declare const ImagesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
1954
|
+
/**
|
|
1955
|
+
*
|
|
1956
|
+
* @summary Retrieves a user uploaded image for use in a template
|
|
1957
|
+
* @param {string} title
|
|
1958
|
+
* @param {*} [options] Override http request option.
|
|
1959
|
+
* @throws {RequiredError}
|
|
1960
|
+
*/
|
|
1961
|
+
getImage(title: string, options?: any): AxiosPromise<any>;
|
|
1962
|
+
/**
|
|
1963
|
+
* Uploads an image to the server for use in templates
|
|
1964
|
+
* @summary Upload an image for use in a template
|
|
1965
|
+
* @param {any} [image]
|
|
1966
|
+
* @param {*} [options] Override http request option.
|
|
1967
|
+
* @throws {RequiredError}
|
|
1968
|
+
*/
|
|
1969
|
+
uploadImage(image?: any, options?: any): AxiosPromise<InlineResponse2001>;
|
|
1970
|
+
};
|
|
1971
|
+
/**
|
|
1972
|
+
* ImagesApi - object-oriented interface
|
|
1973
|
+
* @export
|
|
1974
|
+
* @class ImagesApi
|
|
1975
|
+
* @extends {BaseAPI}
|
|
1976
|
+
*/
|
|
1977
|
+
declare class ImagesApi extends BaseAPI {
|
|
1978
|
+
/**
|
|
1979
|
+
*
|
|
1980
|
+
* @summary Retrieves a user uploaded image for use in a template
|
|
1981
|
+
* @param {string} title
|
|
1982
|
+
* @param {*} [options] Override http request option.
|
|
1983
|
+
* @throws {RequiredError}
|
|
1984
|
+
* @memberof ImagesApi
|
|
1985
|
+
*/
|
|
1986
|
+
getImage(title: string, options?: any): Promise<axios.AxiosResponse<any, any>>;
|
|
1987
|
+
/**
|
|
1988
|
+
* Uploads an image to the server for use in templates
|
|
1989
|
+
* @summary Upload an image for use in a template
|
|
1990
|
+
* @param {any} [image]
|
|
1991
|
+
* @param {*} [options] Override http request option.
|
|
1992
|
+
* @throws {RequiredError}
|
|
1993
|
+
* @memberof ImagesApi
|
|
1994
|
+
*/
|
|
1995
|
+
uploadImage(image?: any, options?: any): Promise<axios.AxiosResponse<InlineResponse2001, any>>;
|
|
1996
|
+
}
|
|
1997
|
+
/**
|
|
1998
|
+
* JobsApi - axios parameter creator
|
|
1999
|
+
* @export
|
|
2000
|
+
*/
|
|
2001
|
+
declare const JobsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
2002
|
+
/**
|
|
2003
|
+
* Get the status of a queued job, including its status and result if available.
|
|
2004
|
+
* @summary Get job
|
|
2005
|
+
* @param {string} id
|
|
2006
|
+
* @param {*} [options] Override http request option.
|
|
2007
|
+
* @throws {RequiredError}
|
|
2008
|
+
*/
|
|
2009
|
+
getJob: (id: string, options?: any) => Promise<RequestArgs>;
|
|
2010
|
+
};
|
|
2011
|
+
/**
|
|
2012
|
+
* JobsApi - functional programming interface
|
|
2013
|
+
* @export
|
|
2014
|
+
*/
|
|
2015
|
+
declare const JobsApiFp: (configuration?: Configuration) => {
|
|
2016
|
+
/**
|
|
2017
|
+
* Get the status of a queued job, including its status and result if available.
|
|
2018
|
+
* @summary Get job
|
|
2019
|
+
* @param {string} id
|
|
2020
|
+
* @param {*} [options] Override http request option.
|
|
2021
|
+
* @throws {RequiredError}
|
|
2022
|
+
*/
|
|
2023
|
+
getJob(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Job>>;
|
|
2024
|
+
};
|
|
2025
|
+
/**
|
|
2026
|
+
* JobsApi - factory interface
|
|
2027
|
+
* @export
|
|
2028
|
+
*/
|
|
2029
|
+
declare const JobsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
2030
|
+
/**
|
|
2031
|
+
* Get the status of a queued job, including its status and result if available.
|
|
2032
|
+
* @summary Get job
|
|
2033
|
+
* @param {string} id
|
|
2034
|
+
* @param {*} [options] Override http request option.
|
|
2035
|
+
* @throws {RequiredError}
|
|
2036
|
+
*/
|
|
2037
|
+
getJob(id: string, options?: any): AxiosPromise<Job>;
|
|
2038
|
+
};
|
|
2039
|
+
/**
|
|
2040
|
+
* JobsApi - object-oriented interface
|
|
2041
|
+
* @export
|
|
2042
|
+
* @class JobsApi
|
|
2043
|
+
* @extends {BaseAPI}
|
|
2044
|
+
*/
|
|
2045
|
+
declare class JobsApi extends BaseAPI {
|
|
2046
|
+
/**
|
|
2047
|
+
* Get the status of a queued job, including its status and result if available.
|
|
2048
|
+
* @summary Get job
|
|
2049
|
+
* @param {string} id
|
|
2050
|
+
* @param {*} [options] Override http request option.
|
|
2051
|
+
* @throws {RequiredError}
|
|
2052
|
+
* @memberof JobsApi
|
|
2053
|
+
*/
|
|
2054
|
+
getJob(id: string, options?: any): Promise<axios.AxiosResponse<Job, any>>;
|
|
2055
|
+
}
|
|
2056
|
+
/**
|
|
2057
|
+
* ReportTasksApi - axios parameter creator
|
|
2058
|
+
* @export
|
|
2059
|
+
*/
|
|
2060
|
+
declare const ReportTasksApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
2061
|
+
/**
|
|
2062
|
+
*
|
|
2063
|
+
* @summary Create report task
|
|
2064
|
+
* @param {ReportTaskRequest} reportTaskRequest
|
|
2065
|
+
* @param {*} [options] Override http request option.
|
|
2066
|
+
* @throws {RequiredError}
|
|
2067
|
+
*/
|
|
2068
|
+
createReportTask: (reportTaskRequest: ReportTaskRequest, options?: any) => Promise<RequestArgs>;
|
|
2069
|
+
/**
|
|
2070
|
+
* Delete a report task by its ID
|
|
2071
|
+
* @summary Delete report task
|
|
2072
|
+
* @param {string} id
|
|
2073
|
+
* @param {boolean} [deleteAssociatedReports]
|
|
2074
|
+
* @param {*} [options] Override http request option.
|
|
2075
|
+
* @throws {RequiredError}
|
|
2076
|
+
*/
|
|
2077
|
+
deleteReportTask: (id: string, deleteAssociatedReports?: boolean, options?: any) => Promise<RequestArgs>;
|
|
2078
|
+
/**
|
|
2079
|
+
* Read a report task by its ID
|
|
2080
|
+
* @summary Read report task
|
|
2081
|
+
* @param {string} id
|
|
2082
|
+
* @param {*} [options] Override http request option.
|
|
2083
|
+
* @throws {RequiredError}
|
|
2084
|
+
*/
|
|
2085
|
+
getReportTask: (id: string, options?: any) => Promise<RequestArgs>;
|
|
2086
|
+
/**
|
|
2087
|
+
*
|
|
2088
|
+
* @summary List report tasks
|
|
2089
|
+
* @param {number} [pageNum]
|
|
2090
|
+
* @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.
|
|
2091
|
+
* @param {string} [templateId]
|
|
2092
|
+
* @param {number} [perPage]
|
|
2093
|
+
* @param {'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId'} [orderBy]
|
|
2094
|
+
* @param {'asc' | 'desc'} [order] The order to retrieve the logs in
|
|
2095
|
+
* @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\" } ```
|
|
2096
|
+
* @param {*} [options] Override http request option.
|
|
2097
|
+
* @throws {RequiredError}
|
|
2098
|
+
*/
|
|
2099
|
+
getReportTasks: (pageNum?: number, meta?: {
|
|
2100
|
+
[key: string]: string;
|
|
2101
|
+
}, 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>;
|
|
2102
|
+
/**
|
|
2103
|
+
* Duplicates the task and runs it as \"Once - Now\"
|
|
2104
|
+
* @summary Run task now
|
|
2105
|
+
* @param {string} id
|
|
2106
|
+
* @param {*} [options] Override http request option.
|
|
2107
|
+
* @throws {RequiredError}
|
|
2108
|
+
*/
|
|
2109
|
+
runReportTaskNow: (id: string, options?: any) => Promise<RequestArgs>;
|
|
2110
|
+
/**
|
|
2111
|
+
* Accepts partial updates
|
|
2112
|
+
* @summary Update report task by ID
|
|
2113
|
+
* @param {string} id
|
|
2114
|
+
* @param {ReportTaskRequest} reportTaskRequest
|
|
2115
|
+
* @param {*} [options] Override http request option.
|
|
2116
|
+
* @throws {RequiredError}
|
|
2117
|
+
*/
|
|
2118
|
+
updateReportTask: (id: string, reportTaskRequest: ReportTaskRequest, options?: any) => Promise<RequestArgs>;
|
|
2119
|
+
};
|
|
2120
|
+
/**
|
|
2121
|
+
* ReportTasksApi - functional programming interface
|
|
2122
|
+
* @export
|
|
2123
|
+
*/
|
|
2124
|
+
declare const ReportTasksApiFp: (configuration?: Configuration) => {
|
|
2125
|
+
/**
|
|
2126
|
+
*
|
|
2127
|
+
* @summary Create report task
|
|
2128
|
+
* @param {ReportTaskRequest} reportTaskRequest
|
|
2129
|
+
* @param {*} [options] Override http request option.
|
|
2130
|
+
* @throws {RequiredError}
|
|
2131
|
+
*/
|
|
2132
|
+
createReportTask(reportTaskRequest: ReportTaskRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReportTaskResponse>>;
|
|
2133
|
+
/**
|
|
2134
|
+
* Delete a report task by its ID
|
|
2135
|
+
* @summary Delete report task
|
|
2136
|
+
* @param {string} id
|
|
2137
|
+
* @param {boolean} [deleteAssociatedReports]
|
|
2138
|
+
* @param {*} [options] Override http request option.
|
|
2139
|
+
* @throws {RequiredError}
|
|
2140
|
+
*/
|
|
2141
|
+
deleteReportTask(id: string, deleteAssociatedReports?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
2142
|
+
/**
|
|
2143
|
+
* Read a report task by its ID
|
|
2144
|
+
* @summary Read report task
|
|
2145
|
+
* @param {string} id
|
|
2146
|
+
* @param {*} [options] Override http request option.
|
|
2147
|
+
* @throws {RequiredError}
|
|
2148
|
+
*/
|
|
2149
|
+
getReportTask(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReportTaskResponse>>;
|
|
2150
|
+
/**
|
|
2151
|
+
*
|
|
2152
|
+
* @summary List report tasks
|
|
2153
|
+
* @param {number} [pageNum]
|
|
2154
|
+
* @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.
|
|
2155
|
+
* @param {string} [templateId]
|
|
2156
|
+
* @param {number} [perPage]
|
|
2157
|
+
* @param {'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId'} [orderBy]
|
|
2158
|
+
* @param {'asc' | 'desc'} [order] The order to retrieve the logs in
|
|
2159
|
+
* @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\" } ```
|
|
2160
|
+
* @param {*} [options] Override http request option.
|
|
2161
|
+
* @throws {RequiredError}
|
|
2162
|
+
*/
|
|
2163
|
+
getReportTasks(pageNum?: number, meta?: {
|
|
2164
|
+
[key: string]: string;
|
|
2165
|
+
}, 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>>;
|
|
2166
|
+
/**
|
|
2167
|
+
* Duplicates the task and runs it as \"Once - Now\"
|
|
2168
|
+
* @summary Run task now
|
|
2169
|
+
* @param {string} id
|
|
2170
|
+
* @param {*} [options] Override http request option.
|
|
2171
|
+
* @throws {RequiredError}
|
|
2172
|
+
*/
|
|
2173
|
+
runReportTaskNow(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReportTaskResponse>>;
|
|
2174
|
+
/**
|
|
2175
|
+
* Accepts partial updates
|
|
2176
|
+
* @summary Update report task by ID
|
|
2177
|
+
* @param {string} id
|
|
2178
|
+
* @param {ReportTaskRequest} reportTaskRequest
|
|
2179
|
+
* @param {*} [options] Override http request option.
|
|
2180
|
+
* @throws {RequiredError}
|
|
2181
|
+
*/
|
|
2182
|
+
updateReportTask(id: string, reportTaskRequest: ReportTaskRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReportTaskResponse>>;
|
|
2183
|
+
};
|
|
2184
|
+
/**
|
|
2185
|
+
* ReportTasksApi - factory interface
|
|
2186
|
+
* @export
|
|
2187
|
+
*/
|
|
2188
|
+
declare const ReportTasksApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
2189
|
+
/**
|
|
2190
|
+
*
|
|
2191
|
+
* @summary Create report task
|
|
2192
|
+
* @param {ReportTaskRequest} reportTaskRequest
|
|
2193
|
+
* @param {*} [options] Override http request option.
|
|
2194
|
+
* @throws {RequiredError}
|
|
2195
|
+
*/
|
|
2196
|
+
createReportTask(reportTaskRequest: ReportTaskRequest, options?: any): AxiosPromise<ReportTaskResponse>;
|
|
2197
|
+
/**
|
|
2198
|
+
* Delete a report task by its ID
|
|
2199
|
+
* @summary Delete report task
|
|
2200
|
+
* @param {string} id
|
|
2201
|
+
* @param {boolean} [deleteAssociatedReports]
|
|
2202
|
+
* @param {*} [options] Override http request option.
|
|
2203
|
+
* @throws {RequiredError}
|
|
2204
|
+
*/
|
|
2205
|
+
deleteReportTask(id: string, deleteAssociatedReports?: boolean, options?: any): AxiosPromise<void>;
|
|
2206
|
+
/**
|
|
2207
|
+
* Read a report task by its ID
|
|
2208
|
+
* @summary Read report task
|
|
2209
|
+
* @param {string} id
|
|
2210
|
+
* @param {*} [options] Override http request option.
|
|
2211
|
+
* @throws {RequiredError}
|
|
2212
|
+
*/
|
|
2213
|
+
getReportTask(id: string, options?: any): AxiosPromise<ReportTaskResponse>;
|
|
2214
|
+
/**
|
|
2215
|
+
*
|
|
2216
|
+
* @summary List report tasks
|
|
2217
|
+
* @param {number} [pageNum]
|
|
2218
|
+
* @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.
|
|
2219
|
+
* @param {string} [templateId]
|
|
2220
|
+
* @param {number} [perPage]
|
|
2221
|
+
* @param {'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId'} [orderBy]
|
|
2222
|
+
* @param {'asc' | 'desc'} [order] The order to retrieve the logs in
|
|
2223
|
+
* @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\" } ```
|
|
2224
|
+
* @param {*} [options] Override http request option.
|
|
2225
|
+
* @throws {RequiredError}
|
|
2226
|
+
*/
|
|
2227
|
+
getReportTasks(pageNum?: number, meta?: {
|
|
2228
|
+
[key: string]: string;
|
|
2229
|
+
}, 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>;
|
|
2230
|
+
/**
|
|
2231
|
+
* Duplicates the task and runs it as \"Once - Now\"
|
|
2232
|
+
* @summary Run task now
|
|
2233
|
+
* @param {string} id
|
|
2234
|
+
* @param {*} [options] Override http request option.
|
|
2235
|
+
* @throws {RequiredError}
|
|
2236
|
+
*/
|
|
2237
|
+
runReportTaskNow(id: string, options?: any): AxiosPromise<ReportTaskResponse>;
|
|
2238
|
+
/**
|
|
2239
|
+
* Accepts partial updates
|
|
2240
|
+
* @summary Update report task by ID
|
|
2241
|
+
* @param {string} id
|
|
2242
|
+
* @param {ReportTaskRequest} reportTaskRequest
|
|
2243
|
+
* @param {*} [options] Override http request option.
|
|
2244
|
+
* @throws {RequiredError}
|
|
2245
|
+
*/
|
|
2246
|
+
updateReportTask(id: string, reportTaskRequest: ReportTaskRequest, options?: any): AxiosPromise<ReportTaskResponse>;
|
|
2247
|
+
};
|
|
2248
|
+
/**
|
|
2249
|
+
* ReportTasksApi - object-oriented interface
|
|
2250
|
+
* @export
|
|
2251
|
+
* @class ReportTasksApi
|
|
2252
|
+
* @extends {BaseAPI}
|
|
2253
|
+
*/
|
|
2254
|
+
declare class ReportTasksApi extends BaseAPI {
|
|
2255
|
+
/**
|
|
2256
|
+
*
|
|
2257
|
+
* @summary Create report task
|
|
2258
|
+
* @param {ReportTaskRequest} reportTaskRequest
|
|
2259
|
+
* @param {*} [options] Override http request option.
|
|
2260
|
+
* @throws {RequiredError}
|
|
2261
|
+
* @memberof ReportTasksApi
|
|
2262
|
+
*/
|
|
2263
|
+
createReportTask(reportTaskRequest: ReportTaskRequest, options?: any): Promise<axios.AxiosResponse<ReportTaskResponse, any>>;
|
|
2264
|
+
/**
|
|
2265
|
+
* Delete a report task by its ID
|
|
2266
|
+
* @summary Delete report task
|
|
2267
|
+
* @param {string} id
|
|
2268
|
+
* @param {boolean} [deleteAssociatedReports]
|
|
2269
|
+
* @param {*} [options] Override http request option.
|
|
2270
|
+
* @throws {RequiredError}
|
|
2271
|
+
* @memberof ReportTasksApi
|
|
2272
|
+
*/
|
|
2273
|
+
deleteReportTask(id: string, deleteAssociatedReports?: boolean, options?: any): Promise<axios.AxiosResponse<void, any>>;
|
|
2274
|
+
/**
|
|
2275
|
+
* Read a report task by its ID
|
|
2276
|
+
* @summary Read report task
|
|
2277
|
+
* @param {string} id
|
|
2278
|
+
* @param {*} [options] Override http request option.
|
|
2279
|
+
* @throws {RequiredError}
|
|
2280
|
+
* @memberof ReportTasksApi
|
|
2281
|
+
*/
|
|
2282
|
+
getReportTask(id: string, options?: any): Promise<axios.AxiosResponse<ReportTaskResponse, any>>;
|
|
2283
|
+
/**
|
|
2284
|
+
*
|
|
2285
|
+
* @summary List report tasks
|
|
2286
|
+
* @param {number} [pageNum]
|
|
2287
|
+
* @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.
|
|
2288
|
+
* @param {string} [templateId]
|
|
2289
|
+
* @param {number} [perPage]
|
|
2290
|
+
* @param {'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId'} [orderBy]
|
|
2291
|
+
* @param {'asc' | 'desc'} [order] The order to retrieve the logs in
|
|
2292
|
+
* @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\" } ```
|
|
2293
|
+
* @param {*} [options] Override http request option.
|
|
2294
|
+
* @throws {RequiredError}
|
|
2295
|
+
* @memberof ReportTasksApi
|
|
2296
|
+
*/
|
|
2297
|
+
getReportTasks(pageNum?: number, meta?: {
|
|
2298
|
+
[key: string]: string;
|
|
2299
|
+
}, 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.AxiosResponse<InlineResponse2002, any>>;
|
|
2300
|
+
/**
|
|
2301
|
+
* Duplicates the task and runs it as \"Once - Now\"
|
|
2302
|
+
* @summary Run task now
|
|
2303
|
+
* @param {string} id
|
|
2304
|
+
* @param {*} [options] Override http request option.
|
|
2305
|
+
* @throws {RequiredError}
|
|
2306
|
+
* @memberof ReportTasksApi
|
|
2307
|
+
*/
|
|
2308
|
+
runReportTaskNow(id: string, options?: any): Promise<axios.AxiosResponse<ReportTaskResponse, any>>;
|
|
2309
|
+
/**
|
|
2310
|
+
* Accepts partial updates
|
|
2311
|
+
* @summary Update report task by ID
|
|
2312
|
+
* @param {string} id
|
|
2313
|
+
* @param {ReportTaskRequest} reportTaskRequest
|
|
2314
|
+
* @param {*} [options] Override http request option.
|
|
2315
|
+
* @throws {RequiredError}
|
|
2316
|
+
* @memberof ReportTasksApi
|
|
2317
|
+
*/
|
|
2318
|
+
updateReportTask(id: string, reportTaskRequest: ReportTaskRequest, options?: any): Promise<axios.AxiosResponse<ReportTaskResponse, any>>;
|
|
2319
|
+
}
|
|
2320
|
+
/**
|
|
2321
|
+
* ReportsApi - axios parameter creator
|
|
2322
|
+
* @export
|
|
2323
|
+
*/
|
|
2324
|
+
declare const ReportsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
2325
|
+
/**
|
|
2326
|
+
*
|
|
2327
|
+
* @summary Delete a published report
|
|
2328
|
+
* @param {string} id
|
|
2329
|
+
* @param {*} [options] Override http request option.
|
|
2330
|
+
* @throws {RequiredError}
|
|
2331
|
+
*/
|
|
2332
|
+
deleteReport: (id: string, options?: any) => Promise<RequestArgs>;
|
|
2333
|
+
/**
|
|
2334
|
+
*
|
|
2335
|
+
* @summary Get a published report
|
|
2336
|
+
* @param {string} id
|
|
2337
|
+
* @param {*} [options] Override http request option.
|
|
2338
|
+
* @throws {RequiredError}
|
|
2339
|
+
*/
|
|
2340
|
+
getReport: (id: string, options?: any) => Promise<RequestArgs>;
|
|
2341
|
+
/**
|
|
2342
|
+
*
|
|
2343
|
+
* @summary List reports
|
|
2344
|
+
* @param {number} [pageNum]
|
|
2345
|
+
* @param {number} [perPage]
|
|
2346
|
+
* @param {'title' | 'createdAt'} [orderBy] The field to order the list of reports on
|
|
2347
|
+
* @param {'asc' | 'desc'} [order] The order to sort the list of reports on
|
|
2348
|
+
* @param {string} [tagId] A tagId to filter the list of reports on
|
|
2349
|
+
* @param {string} [reportTaskId] A reportId to filter the list of reports on
|
|
2350
|
+
* @param {*} [options] Override http request option.
|
|
2351
|
+
* @throws {RequiredError}
|
|
2352
|
+
*/
|
|
2353
|
+
getReports: (pageNum?: number, perPage?: number, orderBy?: 'title' | 'createdAt', order?: 'asc' | 'desc', tagId?: string, reportTaskId?: string, options?: any) => Promise<RequestArgs>;
|
|
2354
|
+
/**
|
|
2355
|
+
*
|
|
2356
|
+
* @summary Render a published report
|
|
2357
|
+
* @param {string} id
|
|
2358
|
+
* @param {'pdf' | 'pptx' | 'xlsx' | 'csv'} format
|
|
2359
|
+
* @param {*} [options] Override http request option.
|
|
2360
|
+
* @throws {RequiredError}
|
|
2361
|
+
*/
|
|
2362
|
+
renderReport: (id: string, format: 'pdf' | 'pptx' | 'xlsx' | 'csv', options?: any) => Promise<RequestArgs>;
|
|
2363
|
+
};
|
|
2364
|
+
/**
|
|
2365
|
+
* ReportsApi - functional programming interface
|
|
2366
|
+
* @export
|
|
2367
|
+
*/
|
|
2368
|
+
declare const ReportsApiFp: (configuration?: Configuration) => {
|
|
2369
|
+
/**
|
|
2370
|
+
*
|
|
2371
|
+
* @summary Delete a published report
|
|
2372
|
+
* @param {string} id
|
|
2373
|
+
* @param {*} [options] Override http request option.
|
|
2374
|
+
* @throws {RequiredError}
|
|
2375
|
+
*/
|
|
2376
|
+
deleteReport(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Report>>;
|
|
2377
|
+
/**
|
|
2378
|
+
*
|
|
2379
|
+
* @summary Get a published report
|
|
2380
|
+
* @param {string} id
|
|
2381
|
+
* @param {*} [options] Override http request option.
|
|
2382
|
+
* @throws {RequiredError}
|
|
2383
|
+
*/
|
|
2384
|
+
getReport(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Report>>;
|
|
2385
|
+
/**
|
|
2386
|
+
*
|
|
2387
|
+
* @summary List reports
|
|
2388
|
+
* @param {number} [pageNum]
|
|
2389
|
+
* @param {number} [perPage]
|
|
2390
|
+
* @param {'title' | 'createdAt'} [orderBy] The field to order the list of reports on
|
|
2391
|
+
* @param {'asc' | 'desc'} [order] The order to sort the list of reports on
|
|
2392
|
+
* @param {string} [tagId] A tagId to filter the list of reports on
|
|
2393
|
+
* @param {string} [reportTaskId] A reportId to filter the list of reports on
|
|
2394
|
+
* @param {*} [options] Override http request option.
|
|
2395
|
+
* @throws {RequiredError}
|
|
2396
|
+
*/
|
|
2397
|
+
getReports(pageNum?: number, perPage?: number, orderBy?: 'title' | 'createdAt', order?: 'asc' | 'desc', tagId?: string, reportTaskId?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2003>>;
|
|
2398
|
+
/**
|
|
2399
|
+
*
|
|
2400
|
+
* @summary Render a published report
|
|
2401
|
+
* @param {string} id
|
|
2402
|
+
* @param {'pdf' | 'pptx' | 'xlsx' | 'csv'} format
|
|
2403
|
+
* @param {*} [options] Override http request option.
|
|
2404
|
+
* @throws {RequiredError}
|
|
2405
|
+
*/
|
|
2406
|
+
renderReport(id: string, format: 'pdf' | 'pptx' | 'xlsx' | 'csv', options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Job>>;
|
|
2407
|
+
};
|
|
2408
|
+
/**
|
|
2409
|
+
* ReportsApi - factory interface
|
|
2410
|
+
* @export
|
|
2411
|
+
*/
|
|
2412
|
+
declare const ReportsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
2413
|
+
/**
|
|
2414
|
+
*
|
|
2415
|
+
* @summary Delete a published report
|
|
2416
|
+
* @param {string} id
|
|
2417
|
+
* @param {*} [options] Override http request option.
|
|
2418
|
+
* @throws {RequiredError}
|
|
2419
|
+
*/
|
|
2420
|
+
deleteReport(id: string, options?: any): AxiosPromise<Report>;
|
|
2421
|
+
/**
|
|
2422
|
+
*
|
|
2423
|
+
* @summary Get a published report
|
|
2424
|
+
* @param {string} id
|
|
2425
|
+
* @param {*} [options] Override http request option.
|
|
2426
|
+
* @throws {RequiredError}
|
|
2427
|
+
*/
|
|
2428
|
+
getReport(id: string, options?: any): AxiosPromise<Report>;
|
|
2429
|
+
/**
|
|
2430
|
+
*
|
|
2431
|
+
* @summary List reports
|
|
2432
|
+
* @param {number} [pageNum]
|
|
2433
|
+
* @param {number} [perPage]
|
|
2434
|
+
* @param {'title' | 'createdAt'} [orderBy] The field to order the list of reports on
|
|
2435
|
+
* @param {'asc' | 'desc'} [order] The order to sort the list of reports on
|
|
2436
|
+
* @param {string} [tagId] A tagId to filter the list of reports on
|
|
2437
|
+
* @param {string} [reportTaskId] A reportId to filter the list of reports on
|
|
2438
|
+
* @param {*} [options] Override http request option.
|
|
2439
|
+
* @throws {RequiredError}
|
|
2440
|
+
*/
|
|
2441
|
+
getReports(pageNum?: number, perPage?: number, orderBy?: 'title' | 'createdAt', order?: 'asc' | 'desc', tagId?: string, reportTaskId?: string, options?: any): AxiosPromise<InlineResponse2003>;
|
|
2442
|
+
/**
|
|
2443
|
+
*
|
|
2444
|
+
* @summary Render a published report
|
|
2445
|
+
* @param {string} id
|
|
2446
|
+
* @param {'pdf' | 'pptx' | 'xlsx' | 'csv'} format
|
|
2447
|
+
* @param {*} [options] Override http request option.
|
|
2448
|
+
* @throws {RequiredError}
|
|
2449
|
+
*/
|
|
2450
|
+
renderReport(id: string, format: 'pdf' | 'pptx' | 'xlsx' | 'csv', options?: any): AxiosPromise<Job>;
|
|
2451
|
+
};
|
|
2452
|
+
/**
|
|
2453
|
+
* ReportsApi - object-oriented interface
|
|
2454
|
+
* @export
|
|
2455
|
+
* @class ReportsApi
|
|
2456
|
+
* @extends {BaseAPI}
|
|
2457
|
+
*/
|
|
2458
|
+
declare class ReportsApi extends BaseAPI {
|
|
2459
|
+
/**
|
|
2460
|
+
*
|
|
2461
|
+
* @summary Delete a published report
|
|
2462
|
+
* @param {string} id
|
|
2463
|
+
* @param {*} [options] Override http request option.
|
|
2464
|
+
* @throws {RequiredError}
|
|
2465
|
+
* @memberof ReportsApi
|
|
2466
|
+
*/
|
|
2467
|
+
deleteReport(id: string, options?: any): Promise<axios.AxiosResponse<Report, any>>;
|
|
2468
|
+
/**
|
|
2469
|
+
*
|
|
2470
|
+
* @summary Get a published report
|
|
2471
|
+
* @param {string} id
|
|
2472
|
+
* @param {*} [options] Override http request option.
|
|
2473
|
+
* @throws {RequiredError}
|
|
2474
|
+
* @memberof ReportsApi
|
|
2475
|
+
*/
|
|
2476
|
+
getReport(id: string, options?: any): Promise<axios.AxiosResponse<Report, any>>;
|
|
2477
|
+
/**
|
|
2478
|
+
*
|
|
2479
|
+
* @summary List reports
|
|
2480
|
+
* @param {number} [pageNum]
|
|
2481
|
+
* @param {number} [perPage]
|
|
2482
|
+
* @param {'title' | 'createdAt'} [orderBy] The field to order the list of reports on
|
|
2483
|
+
* @param {'asc' | 'desc'} [order] The order to sort the list of reports on
|
|
2484
|
+
* @param {string} [tagId] A tagId to filter the list of reports on
|
|
2485
|
+
* @param {string} [reportTaskId] A reportId to filter the list of reports on
|
|
2486
|
+
* @param {*} [options] Override http request option.
|
|
2487
|
+
* @throws {RequiredError}
|
|
2488
|
+
* @memberof ReportsApi
|
|
2489
|
+
*/
|
|
2490
|
+
getReports(pageNum?: number, perPage?: number, orderBy?: 'title' | 'createdAt', order?: 'asc' | 'desc', tagId?: string, reportTaskId?: string, options?: any): Promise<axios.AxiosResponse<InlineResponse2003, any>>;
|
|
2491
|
+
/**
|
|
2492
|
+
*
|
|
2493
|
+
* @summary Render a published report
|
|
2494
|
+
* @param {string} id
|
|
2495
|
+
* @param {'pdf' | 'pptx' | 'xlsx' | 'csv'} format
|
|
2496
|
+
* @param {*} [options] Override http request option.
|
|
2497
|
+
* @throws {RequiredError}
|
|
2498
|
+
* @memberof ReportsApi
|
|
2499
|
+
*/
|
|
2500
|
+
renderReport(id: string, format: 'pdf' | 'pptx' | 'xlsx' | 'csv', options?: any): Promise<axios.AxiosResponse<Job, any>>;
|
|
2501
|
+
}
|
|
2502
|
+
/**
|
|
2503
|
+
* TemplatesApi - axios parameter creator
|
|
1189
2504
|
* @export
|
|
1190
|
-
* @class FilterCyclesApi
|
|
1191
|
-
* @extends {BaseAPI}
|
|
1192
2505
|
*/
|
|
1193
|
-
declare
|
|
2506
|
+
declare const TemplatesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
1194
2507
|
/**
|
|
1195
2508
|
*
|
|
1196
|
-
* @summary Create
|
|
1197
|
-
* @param {
|
|
2509
|
+
* @summary Create report template by ID
|
|
2510
|
+
* @param {Template} template
|
|
1198
2511
|
* @param {*} [options] Override http request option.
|
|
1199
2512
|
* @throws {RequiredError}
|
|
1200
|
-
* @memberof FilterCyclesApi
|
|
1201
2513
|
*/
|
|
1202
|
-
|
|
2514
|
+
createTemplate: (template: Template, options?: any) => Promise<RequestArgs>;
|
|
1203
2515
|
/**
|
|
1204
|
-
*
|
|
1205
|
-
* @summary Delete
|
|
2516
|
+
* Delete a report template by its ID
|
|
2517
|
+
* @summary Delete report template
|
|
1206
2518
|
* @param {string} id
|
|
1207
2519
|
* @param {*} [options] Override http request option.
|
|
1208
2520
|
* @throws {RequiredError}
|
|
1209
|
-
* @memberof FilterCyclesApi
|
|
1210
2521
|
*/
|
|
1211
|
-
|
|
2522
|
+
deleteTemplate: (id: string, options?: any) => Promise<RequestArgs>;
|
|
1212
2523
|
/**
|
|
1213
|
-
*
|
|
1214
|
-
* @summary
|
|
2524
|
+
* Duplicate a report template by its ID
|
|
2525
|
+
* @summary Duplicate a report template
|
|
1215
2526
|
* @param {string} id
|
|
1216
2527
|
* @param {*} [options] Override http request option.
|
|
1217
2528
|
* @throws {RequiredError}
|
|
1218
|
-
* @memberof FilterCyclesApi
|
|
1219
2529
|
*/
|
|
1220
|
-
|
|
2530
|
+
duplicateTemplate: (id: string, options?: any) => Promise<RequestArgs>;
|
|
1221
2531
|
/**
|
|
1222
|
-
*
|
|
1223
|
-
* @summary
|
|
2532
|
+
* Export a report template to a .CRPT file
|
|
2533
|
+
* @summary Export a report template
|
|
1224
2534
|
* @param {string} id
|
|
1225
2535
|
* @param {*} [options] Override http request option.
|
|
1226
2536
|
* @throws {RequiredError}
|
|
1227
|
-
* @memberof FilterCyclesApi
|
|
1228
2537
|
*/
|
|
1229
|
-
|
|
2538
|
+
exportTemplate: (id: string, options?: any) => Promise<RequestArgs>;
|
|
1230
2539
|
/**
|
|
1231
|
-
*
|
|
1232
|
-
* @summary
|
|
2540
|
+
* Read a report template by its ID
|
|
2541
|
+
* @summary Read report template
|
|
1233
2542
|
* @param {string} id
|
|
1234
2543
|
* @param {*} [options] Override http request option.
|
|
1235
2544
|
* @throws {RequiredError}
|
|
1236
|
-
* @memberof FilterCyclesApi
|
|
1237
2545
|
*/
|
|
1238
|
-
|
|
2546
|
+
getTemplate: (id: string, options?: any) => Promise<RequestArgs>;
|
|
1239
2547
|
/**
|
|
1240
2548
|
*
|
|
1241
|
-
* @summary List
|
|
1242
|
-
* @param {
|
|
2549
|
+
* @summary List report templates
|
|
2550
|
+
* @param {number} [pageNum]
|
|
1243
2551
|
* @param {*} [options] Override http request option.
|
|
1244
2552
|
* @throws {RequiredError}
|
|
1245
|
-
* @memberof FilterCyclesApi
|
|
1246
2553
|
*/
|
|
1247
|
-
|
|
2554
|
+
getTemplates: (pageNum?: number, options?: any) => Promise<RequestArgs>;
|
|
1248
2555
|
/**
|
|
1249
|
-
*
|
|
1250
|
-
* @summary
|
|
1251
|
-
* @param {
|
|
1252
|
-
* @param {FilterCycle} filterCycle
|
|
2556
|
+
* Imports an exported .CRPT file
|
|
2557
|
+
* @summary Import a template
|
|
2558
|
+
* @param {any} [template]
|
|
1253
2559
|
* @param {*} [options] Override http request option.
|
|
1254
2560
|
* @throws {RequiredError}
|
|
1255
|
-
* @memberof FilterCyclesApi
|
|
1256
2561
|
*/
|
|
1257
|
-
|
|
1258
|
-
}
|
|
1259
|
-
/**
|
|
1260
|
-
* ImagesApi - object-oriented interface
|
|
1261
|
-
* @export
|
|
1262
|
-
* @class ImagesApi
|
|
1263
|
-
* @extends {BaseAPI}
|
|
1264
|
-
*/
|
|
1265
|
-
declare class ImagesApi extends BaseAPI {
|
|
2562
|
+
importTemplate: (template?: any, options?: any) => Promise<RequestArgs>;
|
|
1266
2563
|
/**
|
|
1267
|
-
*
|
|
1268
|
-
* @summary
|
|
1269
|
-
* @param {string}
|
|
2564
|
+
* Render a report template to PDF, PPTX, or XLSX. Responds with a job entity.
|
|
2565
|
+
* @summary Render a report template
|
|
2566
|
+
* @param {string} id
|
|
2567
|
+
* @param {'pdf' | 'pptx' | 'xlsx' | 'csv'} format
|
|
1270
2568
|
* @param {*} [options] Override http request option.
|
|
1271
2569
|
* @throws {RequiredError}
|
|
1272
|
-
* @memberof ImagesApi
|
|
1273
2570
|
*/
|
|
1274
|
-
|
|
2571
|
+
renderTemplate: (id: string, format: 'pdf' | 'pptx' | 'xlsx' | 'csv', options?: any) => Promise<RequestArgs>;
|
|
1275
2572
|
/**
|
|
1276
|
-
*
|
|
1277
|
-
* @summary
|
|
1278
|
-
* @param {
|
|
2573
|
+
* Accepts partial updates
|
|
2574
|
+
* @summary Update report template by ID
|
|
2575
|
+
* @param {string} id
|
|
2576
|
+
* @param {Template} template
|
|
1279
2577
|
* @param {*} [options] Override http request option.
|
|
1280
2578
|
* @throws {RequiredError}
|
|
1281
|
-
* @memberof ImagesApi
|
|
1282
2579
|
*/
|
|
1283
|
-
|
|
1284
|
-
}
|
|
2580
|
+
updateTemplate: (id: string, template: Template, options?: any) => Promise<RequestArgs>;
|
|
2581
|
+
};
|
|
1285
2582
|
/**
|
|
1286
|
-
*
|
|
2583
|
+
* TemplatesApi - functional programming interface
|
|
1287
2584
|
* @export
|
|
1288
|
-
* @class JobsApi
|
|
1289
|
-
* @extends {BaseAPI}
|
|
1290
2585
|
*/
|
|
1291
|
-
declare
|
|
2586
|
+
declare const TemplatesApiFp: (configuration?: Configuration) => {
|
|
1292
2587
|
/**
|
|
1293
|
-
*
|
|
1294
|
-
* @summary
|
|
2588
|
+
*
|
|
2589
|
+
* @summary Create report template by ID
|
|
2590
|
+
* @param {Template} template
|
|
2591
|
+
* @param {*} [options] Override http request option.
|
|
2592
|
+
* @throws {RequiredError}
|
|
2593
|
+
*/
|
|
2594
|
+
createTemplate(template: Template, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Template>>;
|
|
2595
|
+
/**
|
|
2596
|
+
* Delete a report template by its ID
|
|
2597
|
+
* @summary Delete report template
|
|
1295
2598
|
* @param {string} id
|
|
1296
2599
|
* @param {*} [options] Override http request option.
|
|
1297
2600
|
* @throws {RequiredError}
|
|
1298
|
-
* @memberof JobsApi
|
|
1299
2601
|
*/
|
|
1300
|
-
|
|
1301
|
-
}
|
|
1302
|
-
/**
|
|
1303
|
-
* ReportTasksApi - object-oriented interface
|
|
1304
|
-
* @export
|
|
1305
|
-
* @class ReportTasksApi
|
|
1306
|
-
* @extends {BaseAPI}
|
|
1307
|
-
*/
|
|
1308
|
-
declare class ReportTasksApi extends BaseAPI {
|
|
2602
|
+
deleteTemplate(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Template>>;
|
|
1309
2603
|
/**
|
|
1310
|
-
*
|
|
1311
|
-
* @summary
|
|
1312
|
-
* @param {
|
|
2604
|
+
* Duplicate a report template by its ID
|
|
2605
|
+
* @summary Duplicate a report template
|
|
2606
|
+
* @param {string} id
|
|
1313
2607
|
* @param {*} [options] Override http request option.
|
|
1314
2608
|
* @throws {RequiredError}
|
|
1315
|
-
* @memberof ReportTasksApi
|
|
1316
2609
|
*/
|
|
1317
|
-
|
|
2610
|
+
duplicateTemplate(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Template>>;
|
|
1318
2611
|
/**
|
|
1319
|
-
*
|
|
1320
|
-
* @summary
|
|
2612
|
+
* Export a report template to a .CRPT file
|
|
2613
|
+
* @summary Export a report template
|
|
1321
2614
|
* @param {string} id
|
|
1322
|
-
* @param {boolean} [deleteAssociatedReports]
|
|
1323
2615
|
* @param {*} [options] Override http request option.
|
|
1324
2616
|
* @throws {RequiredError}
|
|
1325
|
-
* @memberof ReportTasksApi
|
|
1326
2617
|
*/
|
|
1327
|
-
|
|
2618
|
+
exportTemplate(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
|
|
1328
2619
|
/**
|
|
1329
|
-
* Read a report
|
|
1330
|
-
* @summary Read report
|
|
2620
|
+
* Read a report template by its ID
|
|
2621
|
+
* @summary Read report template
|
|
1331
2622
|
* @param {string} id
|
|
1332
2623
|
* @param {*} [options] Override http request option.
|
|
1333
2624
|
* @throws {RequiredError}
|
|
1334
|
-
* @memberof ReportTasksApi
|
|
1335
2625
|
*/
|
|
1336
|
-
|
|
2626
|
+
getTemplate(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Template>>;
|
|
1337
2627
|
/**
|
|
1338
2628
|
*
|
|
1339
|
-
* @summary List report
|
|
2629
|
+
* @summary List report templates
|
|
1340
2630
|
* @param {number} [pageNum]
|
|
1341
|
-
* @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.
|
|
1342
|
-
* @param {string} [templateId]
|
|
1343
|
-
* @param {number} [perPage]
|
|
1344
|
-
* @param {'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId'} [orderBy]
|
|
1345
|
-
* @param {'asc' | 'desc'} [order] The order to retrieve the logs in
|
|
1346
|
-
* @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\" } ```
|
|
1347
2631
|
* @param {*} [options] Override http request option.
|
|
1348
2632
|
* @throws {RequiredError}
|
|
1349
|
-
* @memberof ReportTasksApi
|
|
1350
2633
|
*/
|
|
1351
|
-
|
|
1352
|
-
[key: string]: string;
|
|
1353
|
-
}, 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.AxiosResponse<InlineResponse2002, any>>;
|
|
2634
|
+
getTemplates(pageNum?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse2004>>;
|
|
1354
2635
|
/**
|
|
1355
|
-
*
|
|
1356
|
-
* @summary
|
|
2636
|
+
* Imports an exported .CRPT file
|
|
2637
|
+
* @summary Import a template
|
|
2638
|
+
* @param {any} [template]
|
|
2639
|
+
* @param {*} [options] Override http request option.
|
|
2640
|
+
* @throws {RequiredError}
|
|
2641
|
+
*/
|
|
2642
|
+
importTemplate(template?: any, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Template>>;
|
|
2643
|
+
/**
|
|
2644
|
+
* Render a report template to PDF, PPTX, or XLSX. Responds with a job entity.
|
|
2645
|
+
* @summary Render a report template
|
|
1357
2646
|
* @param {string} id
|
|
2647
|
+
* @param {'pdf' | 'pptx' | 'xlsx' | 'csv'} format
|
|
1358
2648
|
* @param {*} [options] Override http request option.
|
|
1359
2649
|
* @throws {RequiredError}
|
|
1360
|
-
* @memberof ReportTasksApi
|
|
1361
2650
|
*/
|
|
1362
|
-
|
|
2651
|
+
renderTemplate(id: string, format: 'pdf' | 'pptx' | 'xlsx' | 'csv', options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JobResponse>>;
|
|
1363
2652
|
/**
|
|
1364
2653
|
* Accepts partial updates
|
|
1365
|
-
* @summary Update report
|
|
2654
|
+
* @summary Update report template by ID
|
|
1366
2655
|
* @param {string} id
|
|
1367
|
-
* @param {
|
|
2656
|
+
* @param {Template} template
|
|
1368
2657
|
* @param {*} [options] Override http request option.
|
|
1369
2658
|
* @throws {RequiredError}
|
|
1370
|
-
* @memberof ReportTasksApi
|
|
1371
2659
|
*/
|
|
1372
|
-
|
|
1373
|
-
}
|
|
2660
|
+
updateTemplate(id: string, template: Template, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Template>>;
|
|
2661
|
+
};
|
|
1374
2662
|
/**
|
|
1375
|
-
*
|
|
2663
|
+
* TemplatesApi - factory interface
|
|
1376
2664
|
* @export
|
|
1377
|
-
* @class ReportsApi
|
|
1378
|
-
* @extends {BaseAPI}
|
|
1379
2665
|
*/
|
|
1380
|
-
declare
|
|
2666
|
+
declare const TemplatesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
1381
2667
|
/**
|
|
1382
2668
|
*
|
|
1383
|
-
* @summary
|
|
2669
|
+
* @summary Create report template by ID
|
|
2670
|
+
* @param {Template} template
|
|
2671
|
+
* @param {*} [options] Override http request option.
|
|
2672
|
+
* @throws {RequiredError}
|
|
2673
|
+
*/
|
|
2674
|
+
createTemplate(template: Template, options?: any): AxiosPromise<Template>;
|
|
2675
|
+
/**
|
|
2676
|
+
* Delete a report template by its ID
|
|
2677
|
+
* @summary Delete report template
|
|
1384
2678
|
* @param {string} id
|
|
1385
2679
|
* @param {*} [options] Override http request option.
|
|
1386
2680
|
* @throws {RequiredError}
|
|
1387
|
-
* @memberof ReportsApi
|
|
1388
2681
|
*/
|
|
1389
|
-
|
|
2682
|
+
deleteTemplate(id: string, options?: any): AxiosPromise<Template>;
|
|
1390
2683
|
/**
|
|
1391
|
-
*
|
|
1392
|
-
* @summary
|
|
2684
|
+
* Duplicate a report template by its ID
|
|
2685
|
+
* @summary Duplicate a report template
|
|
1393
2686
|
* @param {string} id
|
|
1394
2687
|
* @param {*} [options] Override http request option.
|
|
1395
2688
|
* @throws {RequiredError}
|
|
1396
|
-
* @memberof ReportsApi
|
|
1397
2689
|
*/
|
|
1398
|
-
|
|
2690
|
+
duplicateTemplate(id: string, options?: any): AxiosPromise<Template>;
|
|
2691
|
+
/**
|
|
2692
|
+
* Export a report template to a .CRPT file
|
|
2693
|
+
* @summary Export a report template
|
|
2694
|
+
* @param {string} id
|
|
2695
|
+
* @param {*} [options] Override http request option.
|
|
2696
|
+
* @throws {RequiredError}
|
|
2697
|
+
*/
|
|
2698
|
+
exportTemplate(id: string, options?: any): AxiosPromise<any>;
|
|
2699
|
+
/**
|
|
2700
|
+
* Read a report template by its ID
|
|
2701
|
+
* @summary Read report template
|
|
2702
|
+
* @param {string} id
|
|
2703
|
+
* @param {*} [options] Override http request option.
|
|
2704
|
+
* @throws {RequiredError}
|
|
2705
|
+
*/
|
|
2706
|
+
getTemplate(id: string, options?: any): AxiosPromise<Template>;
|
|
1399
2707
|
/**
|
|
1400
2708
|
*
|
|
1401
|
-
* @summary List
|
|
2709
|
+
* @summary List report templates
|
|
1402
2710
|
* @param {number} [pageNum]
|
|
1403
|
-
* @param {number} [perPage]
|
|
1404
|
-
* @param {'title' | 'createdAt'} [orderBy] The field to order the list of reports on
|
|
1405
|
-
* @param {'asc' | 'desc'} [order] The order to sort the list of reports on
|
|
1406
|
-
* @param {string} [tagId] A tagId to filter the list of reports on
|
|
1407
|
-
* @param {string} [reportTaskId] A reportId to filter the list of reports on
|
|
1408
2711
|
* @param {*} [options] Override http request option.
|
|
1409
2712
|
* @throws {RequiredError}
|
|
1410
|
-
* @memberof ReportsApi
|
|
1411
2713
|
*/
|
|
1412
|
-
|
|
2714
|
+
getTemplates(pageNum?: number, options?: any): AxiosPromise<InlineResponse2004>;
|
|
1413
2715
|
/**
|
|
1414
|
-
*
|
|
1415
|
-
* @summary
|
|
2716
|
+
* Imports an exported .CRPT file
|
|
2717
|
+
* @summary Import a template
|
|
2718
|
+
* @param {any} [template]
|
|
2719
|
+
* @param {*} [options] Override http request option.
|
|
2720
|
+
* @throws {RequiredError}
|
|
2721
|
+
*/
|
|
2722
|
+
importTemplate(template?: any, options?: any): AxiosPromise<Template>;
|
|
2723
|
+
/**
|
|
2724
|
+
* Render a report template to PDF, PPTX, or XLSX. Responds with a job entity.
|
|
2725
|
+
* @summary Render a report template
|
|
1416
2726
|
* @param {string} id
|
|
1417
2727
|
* @param {'pdf' | 'pptx' | 'xlsx' | 'csv'} format
|
|
1418
2728
|
* @param {*} [options] Override http request option.
|
|
1419
2729
|
* @throws {RequiredError}
|
|
1420
|
-
* @memberof ReportsApi
|
|
1421
2730
|
*/
|
|
1422
|
-
|
|
1423
|
-
|
|
2731
|
+
renderTemplate(id: string, format: 'pdf' | 'pptx' | 'xlsx' | 'csv', options?: any): AxiosPromise<JobResponse>;
|
|
2732
|
+
/**
|
|
2733
|
+
* Accepts partial updates
|
|
2734
|
+
* @summary Update report template by ID
|
|
2735
|
+
* @param {string} id
|
|
2736
|
+
* @param {Template} template
|
|
2737
|
+
* @param {*} [options] Override http request option.
|
|
2738
|
+
* @throws {RequiredError}
|
|
2739
|
+
*/
|
|
2740
|
+
updateTemplate(id: string, template: Template, options?: any): AxiosPromise<Template>;
|
|
2741
|
+
};
|
|
1424
2742
|
/**
|
|
1425
2743
|
* TemplatesApi - object-oriented interface
|
|
1426
2744
|
* @export
|
|
@@ -1512,6 +2830,69 @@ declare class TemplatesApi extends BaseAPI {
|
|
|
1512
2830
|
*/
|
|
1513
2831
|
updateTemplate(id: string, template: Template, options?: any): Promise<axios.AxiosResponse<Template, any>>;
|
|
1514
2832
|
}
|
|
2833
|
+
/**
|
|
2834
|
+
* VisualizationApi - axios parameter creator
|
|
2835
|
+
* @export
|
|
2836
|
+
*/
|
|
2837
|
+
declare const VisualizationApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
2838
|
+
/**
|
|
2839
|
+
*
|
|
2840
|
+
* @summary Create an image from a visualization
|
|
2841
|
+
* @param {Visualization} visualization
|
|
2842
|
+
* @param {'high' | 'low'} [priority] Priority of the visualization image request
|
|
2843
|
+
* @param {*} [options] Override http request option.
|
|
2844
|
+
* @throws {RequiredError}
|
|
2845
|
+
*/
|
|
2846
|
+
createVisualization: (visualization: Visualization, priority?: 'high' | 'low', options?: any) => Promise<RequestArgs>;
|
|
2847
|
+
};
|
|
2848
|
+
/**
|
|
2849
|
+
* VisualizationApi - functional programming interface
|
|
2850
|
+
* @export
|
|
2851
|
+
*/
|
|
2852
|
+
declare const VisualizationApiFp: (configuration?: Configuration) => {
|
|
2853
|
+
/**
|
|
2854
|
+
*
|
|
2855
|
+
* @summary Create an image from a visualization
|
|
2856
|
+
* @param {Visualization} visualization
|
|
2857
|
+
* @param {'high' | 'low'} [priority] Priority of the visualization image request
|
|
2858
|
+
* @param {*} [options] Override http request option.
|
|
2859
|
+
* @throws {RequiredError}
|
|
2860
|
+
*/
|
|
2861
|
+
createVisualization(visualization: Visualization, priority?: 'high' | 'low', options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
2862
|
+
};
|
|
2863
|
+
/**
|
|
2864
|
+
* VisualizationApi - factory interface
|
|
2865
|
+
* @export
|
|
2866
|
+
*/
|
|
2867
|
+
declare const VisualizationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
2868
|
+
/**
|
|
2869
|
+
*
|
|
2870
|
+
* @summary Create an image from a visualization
|
|
2871
|
+
* @param {Visualization} visualization
|
|
2872
|
+
* @param {'high' | 'low'} [priority] Priority of the visualization image request
|
|
2873
|
+
* @param {*} [options] Override http request option.
|
|
2874
|
+
* @throws {RequiredError}
|
|
2875
|
+
*/
|
|
2876
|
+
createVisualization(visualization: Visualization, priority?: 'high' | 'low', options?: any): AxiosPromise<void>;
|
|
2877
|
+
};
|
|
2878
|
+
/**
|
|
2879
|
+
* VisualizationApi - object-oriented interface
|
|
2880
|
+
* @export
|
|
2881
|
+
* @class VisualizationApi
|
|
2882
|
+
* @extends {BaseAPI}
|
|
2883
|
+
*/
|
|
2884
|
+
declare class VisualizationApi extends BaseAPI {
|
|
2885
|
+
/**
|
|
2886
|
+
*
|
|
2887
|
+
* @summary Create an image from a visualization
|
|
2888
|
+
* @param {Visualization} visualization
|
|
2889
|
+
* @param {'high' | 'low'} [priority] Priority of the visualization image request
|
|
2890
|
+
* @param {*} [options] Override http request option.
|
|
2891
|
+
* @throws {RequiredError}
|
|
2892
|
+
* @memberof VisualizationApi
|
|
2893
|
+
*/
|
|
2894
|
+
createVisualization(visualization: Visualization, priority?: 'high' | 'low', options?: any): Promise<axios.AxiosResponse<void, any>>;
|
|
2895
|
+
}
|
|
1515
2896
|
|
|
1516
2897
|
declare class ConnectReport {
|
|
1517
2898
|
templates: TemplatesApi;
|
|
@@ -1527,4 +2908,4 @@ declare class ConnectReport {
|
|
|
1527
2908
|
constructor(config: Pick<Configuration, "apiKey" | "basePath" | "formDataCtor" | "httpsAgent">);
|
|
1528
2909
|
}
|
|
1529
2910
|
|
|
1530
|
-
export { ConnectReport };
|
|
2911
|
+
export { BaseTemplatesApi, BaseTemplatesApiAxiosParamCreator, BaseTemplatesApiFactory, BaseTemplatesApiFp, ConnectReport, DocumentsApi, DocumentsApiAxiosParamCreator, DocumentsApiFactory, DocumentsApiFp, type FilterCycle, type FilterCycleAllOf, type FilterCycleAllOfFieldInfo, type FilterCycleAllOfFieldValues, FilterCycleEmailEnum, FilterCycleFrequencyEnum, FilterCyclesApi, FilterCyclesApiAxiosParamCreator, FilterCyclesApiFactory, FilterCyclesApiFp, ImagesApi, ImagesApiAxiosParamCreator, ImagesApiFactory, ImagesApiFp, type InlineResponse200, type InlineResponse2001, type InlineResponse2002, type InlineResponse2003, type InlineResponse2004, type Job, type JobResponse, JobsApi, JobsApiAxiosParamCreator, JobsApiFactory, JobsApiFp, type ModelError, type Report, type ReportTask, type ReportTaskCustomSelection, ReportTaskEmailEnum, type ReportTaskFieldValues, type ReportTaskFilterSets, ReportTaskFrequencyEnum, type ReportTaskGroupsToShareWith, type ReportTaskRequest, type ReportTaskRequestAllOf, type ReportTaskRequestAllOfUsersToShareWith, ReportTaskRequestEmailEnum, ReportTaskRequestFrequencyEnum, type ReportTaskResponse, type ReportTaskResponseAllOf, type ReportTaskResponseAllOfUsersToShareWith, ReportTaskResponseEmailEnum, ReportTaskResponseFrequencyEnum, type ReportTaskTags, type ReportTaskVariables, ReportTasksApi, ReportTasksApiAxiosParamCreator, ReportTasksApiFactory, ReportTasksApiFp, ReportsApi, ReportsApiAxiosParamCreator, ReportsApiFactory, ReportsApiFp, type Template, TemplatesApi, TemplatesApiAxiosParamCreator, TemplatesApiFactory, TemplatesApiFp, type Visualization, VisualizationApi, VisualizationApiAxiosParamCreator, VisualizationApiFactory, VisualizationApiFp };
|