@connectreport/connectreport-js 2.42.3 → 2.48.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -3
- package/api.ts +466 -105
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +456 -95
- package/dist/api.js +92 -42
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/package.json +1 -1
package/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.48.2
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -143,12 +143,6 @@ export interface FilterCycle {
|
|
|
143
143
|
email?: FilterCycleEmailEnum;
|
|
144
144
|
/**
|
|
145
145
|
* Groups to share the published report with. This field will be updated entirely if provided
|
|
146
|
-
* @type {Array<ReportTaskUsersToShareWith>}
|
|
147
|
-
* @memberof FilterCycle
|
|
148
|
-
*/
|
|
149
|
-
usersToShareWith?: Array<ReportTaskUsersToShareWith>;
|
|
150
|
-
/**
|
|
151
|
-
* Users to share the published report with. This field will be updated entirely if provided
|
|
152
146
|
* @type {Array<ReportTaskGroupsToShareWith>}
|
|
153
147
|
* @memberof FilterCycle
|
|
154
148
|
*/
|
|
@@ -159,18 +153,6 @@ export interface FilterCycle {
|
|
|
159
153
|
* @memberof FilterCycle
|
|
160
154
|
*/
|
|
161
155
|
tags?: Array<ReportTaskTags>;
|
|
162
|
-
/**
|
|
163
|
-
* Emails to send the report to. This is only allowed if \"Allow reports to be shared with any email\" is to true.
|
|
164
|
-
* @type {Array<string>}
|
|
165
|
-
* @memberof FilterCycle
|
|
166
|
-
*/
|
|
167
|
-
emailRecipients?: Array<string>;
|
|
168
|
-
/**
|
|
169
|
-
* Denotes whether the email recipient list is confirmed. Value required to be true if emailRecipients is defined.
|
|
170
|
-
* @type {boolean}
|
|
171
|
-
* @memberof FilterCycle
|
|
172
|
-
*/
|
|
173
|
-
confirmedEmailRecipients?: boolean;
|
|
174
156
|
/**
|
|
175
157
|
*
|
|
176
158
|
* @type {FilterCycleAllOfFieldInfo}
|
|
@@ -222,7 +204,8 @@ export enum FilterCycleFrequencyEnum {
|
|
|
222
204
|
export enum FilterCycleEmailEnum {
|
|
223
205
|
Pdf = 'pdf',
|
|
224
206
|
Pptx = 'pptx',
|
|
225
|
-
Xlsx = 'xlsx'
|
|
207
|
+
Xlsx = 'xlsx',
|
|
208
|
+
Csv = 'csv'
|
|
226
209
|
}
|
|
227
210
|
|
|
228
211
|
/**
|
|
@@ -352,10 +335,10 @@ export interface InlineResponse2001 {
|
|
|
352
335
|
export interface InlineResponse2002 {
|
|
353
336
|
/**
|
|
354
337
|
*
|
|
355
|
-
* @type {Array<
|
|
338
|
+
* @type {Array<ReportTaskResponse>}
|
|
356
339
|
* @memberof InlineResponse2002
|
|
357
340
|
*/
|
|
358
|
-
reportTasks?: Array<
|
|
341
|
+
reportTasks?: Array<ReportTaskResponse>;
|
|
359
342
|
/**
|
|
360
343
|
*
|
|
361
344
|
* @type {number}
|
|
@@ -671,12 +654,6 @@ export interface ReportTask {
|
|
|
671
654
|
email?: ReportTaskEmailEnum;
|
|
672
655
|
/**
|
|
673
656
|
* Groups to share the published report with. This field will be updated entirely if provided
|
|
674
|
-
* @type {Array<ReportTaskUsersToShareWith>}
|
|
675
|
-
* @memberof ReportTask
|
|
676
|
-
*/
|
|
677
|
-
usersToShareWith?: Array<ReportTaskUsersToShareWith>;
|
|
678
|
-
/**
|
|
679
|
-
* Users to share the published report with. This field will be updated entirely if provided
|
|
680
657
|
* @type {Array<ReportTaskGroupsToShareWith>}
|
|
681
658
|
* @memberof ReportTask
|
|
682
659
|
*/
|
|
@@ -687,18 +664,6 @@ export interface ReportTask {
|
|
|
687
664
|
* @memberof ReportTask
|
|
688
665
|
*/
|
|
689
666
|
tags?: Array<ReportTaskTags>;
|
|
690
|
-
/**
|
|
691
|
-
* Emails to send the report to. This is only allowed if \"Allow reports to be shared with any email\" is to true.
|
|
692
|
-
* @type {Array<string>}
|
|
693
|
-
* @memberof ReportTask
|
|
694
|
-
*/
|
|
695
|
-
emailRecipients?: Array<string>;
|
|
696
|
-
/**
|
|
697
|
-
* Denotes whether the email recipient list is confirmed. Value required to be true if emailRecipients is defined.
|
|
698
|
-
* @type {boolean}
|
|
699
|
-
* @memberof ReportTask
|
|
700
|
-
*/
|
|
701
|
-
confirmedEmailRecipients?: boolean;
|
|
702
667
|
}
|
|
703
668
|
|
|
704
669
|
/**
|
|
@@ -720,7 +685,8 @@ export enum ReportTaskFrequencyEnum {
|
|
|
720
685
|
export enum ReportTaskEmailEnum {
|
|
721
686
|
Pdf = 'pdf',
|
|
722
687
|
Pptx = 'pptx',
|
|
723
|
-
Xlsx = 'xlsx'
|
|
688
|
+
Xlsx = 'xlsx',
|
|
689
|
+
Csv = 'csv'
|
|
724
690
|
}
|
|
725
691
|
|
|
726
692
|
/**
|
|
@@ -802,35 +768,430 @@ export interface ReportTaskGroupsToShareWith {
|
|
|
802
768
|
/**
|
|
803
769
|
*
|
|
804
770
|
* @export
|
|
805
|
-
* @interface
|
|
771
|
+
* @interface ReportTaskRequest
|
|
806
772
|
*/
|
|
807
|
-
export interface
|
|
773
|
+
export interface ReportTaskRequest {
|
|
808
774
|
/**
|
|
809
775
|
*
|
|
810
776
|
* @type {string}
|
|
811
|
-
* @memberof
|
|
777
|
+
* @memberof ReportTaskRequest
|
|
812
778
|
*/
|
|
813
779
|
id?: string;
|
|
780
|
+
/**
|
|
781
|
+
* Title of the report task
|
|
782
|
+
* @type {string}
|
|
783
|
+
* @memberof ReportTaskRequest
|
|
784
|
+
*/
|
|
785
|
+
title?: string;
|
|
814
786
|
/**
|
|
815
787
|
*
|
|
816
788
|
* @type {string}
|
|
817
|
-
* @memberof
|
|
789
|
+
* @memberof ReportTaskRequest
|
|
818
790
|
*/
|
|
819
|
-
|
|
791
|
+
templateId?: string;
|
|
792
|
+
/**
|
|
793
|
+
* Datetime in UTC when report task\'s schedule will start
|
|
794
|
+
* @type {string}
|
|
795
|
+
* @memberof ReportTaskRequest
|
|
796
|
+
*/
|
|
797
|
+
startOn?: string;
|
|
798
|
+
/**
|
|
799
|
+
* Datetime in UTC when report task schedule will end
|
|
800
|
+
* @type {string}
|
|
801
|
+
* @memberof ReportTaskRequest
|
|
802
|
+
*/
|
|
803
|
+
endOn?: string;
|
|
804
|
+
/**
|
|
805
|
+
* Describes the frequency of the report task\'s schedule
|
|
806
|
+
* @type {string}
|
|
807
|
+
* @memberof ReportTaskRequest
|
|
808
|
+
*/
|
|
809
|
+
frequency?: ReportTaskRequestFrequencyEnum;
|
|
810
|
+
/**
|
|
811
|
+
* The interval of the report task\'s schedule
|
|
812
|
+
* @type {string}
|
|
813
|
+
* @memberof ReportTaskRequest
|
|
814
|
+
*/
|
|
815
|
+
every?: string;
|
|
816
|
+
/**
|
|
817
|
+
* Datetime in UTC when the report task will execute
|
|
818
|
+
* @type {string}
|
|
819
|
+
* @memberof ReportTaskRequest
|
|
820
|
+
*/
|
|
821
|
+
at?: string;
|
|
822
|
+
/**
|
|
823
|
+
* Denotes whether the report task will go into the report processing queue
|
|
824
|
+
* @type {boolean}
|
|
825
|
+
* @memberof ReportTaskRequest
|
|
826
|
+
*/
|
|
827
|
+
enabled?: boolean;
|
|
828
|
+
/**
|
|
829
|
+
* Array of objects denoting filter sets to apply to the report task
|
|
830
|
+
* @type {Array<ReportTaskFilterSets>}
|
|
831
|
+
* @memberof ReportTaskRequest
|
|
832
|
+
*/
|
|
833
|
+
filterSets?: Array<ReportTaskFilterSets>;
|
|
834
|
+
/**
|
|
835
|
+
*
|
|
836
|
+
* @type {string}
|
|
837
|
+
* @memberof ReportTaskRequest
|
|
838
|
+
*/
|
|
839
|
+
filterCycleId?: string;
|
|
840
|
+
/**
|
|
841
|
+
* Calculated datetime in UTC when the report task will run next, if applicable
|
|
842
|
+
* @type {string}
|
|
843
|
+
* @memberof ReportTaskRequest
|
|
844
|
+
*/
|
|
845
|
+
nextRunAt?: string;
|
|
846
|
+
/**
|
|
847
|
+
* The error object from the last report task execution, if applicable
|
|
848
|
+
* @type {string}
|
|
849
|
+
* @memberof ReportTaskRequest
|
|
850
|
+
*/
|
|
851
|
+
error?: string;
|
|
852
|
+
/**
|
|
853
|
+
* The average time to run the report task, in minutes
|
|
854
|
+
* @type {number}
|
|
855
|
+
* @memberof ReportTaskRequest
|
|
856
|
+
*/
|
|
857
|
+
averageTimeToGenerate?: number;
|
|
858
|
+
/**
|
|
859
|
+
* Custom filters to apply. This field will be updated entirely if provided
|
|
860
|
+
* @type {Array<ReportTaskCustomSelection>}
|
|
861
|
+
* @memberof ReportTaskRequest
|
|
862
|
+
*/
|
|
863
|
+
customSelection?: Array<ReportTaskCustomSelection>;
|
|
864
|
+
/**
|
|
865
|
+
*
|
|
866
|
+
* @type {Array<ReportTaskVariables>}
|
|
867
|
+
* @memberof ReportTaskRequest
|
|
868
|
+
*/
|
|
869
|
+
variables?: Array<ReportTaskVariables>;
|
|
870
|
+
/**
|
|
871
|
+
*
|
|
872
|
+
* @type {{ [key: string]: string; }}
|
|
873
|
+
* @memberof ReportTaskRequest
|
|
874
|
+
*/
|
|
875
|
+
meta?: { [key: string]: string; };
|
|
876
|
+
/**
|
|
877
|
+
* The time spent waiting on data platform responses during the last report task execution, in minutes
|
|
878
|
+
* @type {number}
|
|
879
|
+
* @memberof ReportTaskRequest
|
|
880
|
+
*/
|
|
881
|
+
dataPlatformWaitTime?: number;
|
|
882
|
+
/**
|
|
883
|
+
* Denotes whether the generated report should be emailed to its users or groups after a successful run
|
|
884
|
+
* @type {string}
|
|
885
|
+
* @memberof ReportTaskRequest
|
|
886
|
+
*/
|
|
887
|
+
email?: ReportTaskRequestEmailEnum;
|
|
888
|
+
/**
|
|
889
|
+
* Groups to share the published report with. This field will be updated entirely if provided
|
|
890
|
+
* @type {Array<ReportTaskGroupsToShareWith>}
|
|
891
|
+
* @memberof ReportTaskRequest
|
|
892
|
+
*/
|
|
893
|
+
groupsToShareWith?: Array<ReportTaskGroupsToShareWith>;
|
|
894
|
+
/**
|
|
895
|
+
*
|
|
896
|
+
* @type {Array<ReportTaskTags>}
|
|
897
|
+
* @memberof ReportTaskRequest
|
|
898
|
+
*/
|
|
899
|
+
tags?: Array<ReportTaskTags>;
|
|
900
|
+
/**
|
|
901
|
+
* Emails to send the report to. This is only allowed if \"Allow reports to be shared with any email\" is to true.
|
|
902
|
+
* @type {Array<string>}
|
|
903
|
+
* @memberof ReportTaskRequest
|
|
904
|
+
*/
|
|
905
|
+
emailRecipients?: Array<string>;
|
|
906
|
+
/**
|
|
907
|
+
* Denotes whether the email recipient list is confirmed. Value required to be true if emailRecipients is defined.
|
|
908
|
+
* @type {boolean}
|
|
909
|
+
* @memberof ReportTaskRequest
|
|
910
|
+
*/
|
|
911
|
+
confirmedEmailRecipients?: boolean;
|
|
912
|
+
/**
|
|
913
|
+
* Users to share the published report with. This field will be updated entirely if provided
|
|
914
|
+
* @type {Array<ReportTaskRequestAllOfUsersToShareWith>}
|
|
915
|
+
* @memberof ReportTaskRequest
|
|
916
|
+
*/
|
|
917
|
+
usersToShareWith?: Array<ReportTaskRequestAllOfUsersToShareWith>;
|
|
918
|
+
}
|
|
919
|
+
|
|
920
|
+
/**
|
|
921
|
+
* @export
|
|
922
|
+
* @enum {string}
|
|
923
|
+
*/
|
|
924
|
+
export enum ReportTaskRequestFrequencyEnum {
|
|
925
|
+
Monthly = 'Monthly',
|
|
926
|
+
OnceNow = 'Once - now',
|
|
927
|
+
OnceScheduled = 'Once - Scheduled',
|
|
928
|
+
Annually = 'Annually',
|
|
929
|
+
Daily = 'Daily',
|
|
930
|
+
Weekly = 'Weekly'
|
|
931
|
+
}
|
|
932
|
+
/**
|
|
933
|
+
* @export
|
|
934
|
+
* @enum {string}
|
|
935
|
+
*/
|
|
936
|
+
export enum ReportTaskRequestEmailEnum {
|
|
937
|
+
Pdf = 'pdf',
|
|
938
|
+
Pptx = 'pptx',
|
|
939
|
+
Xlsx = 'xlsx',
|
|
940
|
+
Csv = 'csv'
|
|
941
|
+
}
|
|
942
|
+
|
|
943
|
+
/**
|
|
944
|
+
*
|
|
945
|
+
* @export
|
|
946
|
+
* @interface ReportTaskRequestAllOf
|
|
947
|
+
*/
|
|
948
|
+
export interface ReportTaskRequestAllOf {
|
|
949
|
+
/**
|
|
950
|
+
* Emails to send the report to. This is only allowed if \"Allow reports to be shared with any email\" is to true.
|
|
951
|
+
* @type {Array<string>}
|
|
952
|
+
* @memberof ReportTaskRequestAllOf
|
|
953
|
+
*/
|
|
954
|
+
emailRecipients?: Array<string>;
|
|
955
|
+
/**
|
|
956
|
+
* Denotes whether the email recipient list is confirmed. Value required to be true if emailRecipients is defined.
|
|
957
|
+
* @type {boolean}
|
|
958
|
+
* @memberof ReportTaskRequestAllOf
|
|
959
|
+
*/
|
|
960
|
+
confirmedEmailRecipients?: boolean;
|
|
961
|
+
/**
|
|
962
|
+
* Users to share the published report with. This field will be updated entirely if provided
|
|
963
|
+
* @type {Array<ReportTaskRequestAllOfUsersToShareWith>}
|
|
964
|
+
* @memberof ReportTaskRequestAllOf
|
|
965
|
+
*/
|
|
966
|
+
usersToShareWith?: Array<ReportTaskRequestAllOfUsersToShareWith>;
|
|
820
967
|
}
|
|
821
968
|
/**
|
|
822
969
|
*
|
|
823
970
|
* @export
|
|
824
|
-
* @interface
|
|
971
|
+
* @interface ReportTaskRequestAllOfUsersToShareWith
|
|
825
972
|
*/
|
|
826
|
-
export interface
|
|
973
|
+
export interface ReportTaskRequestAllOfUsersToShareWith {
|
|
827
974
|
/**
|
|
828
975
|
*
|
|
829
976
|
* @type {string}
|
|
830
|
-
* @memberof
|
|
977
|
+
* @memberof ReportTaskRequestAllOfUsersToShareWith
|
|
831
978
|
*/
|
|
832
979
|
userId?: string;
|
|
833
980
|
}
|
|
981
|
+
/**
|
|
982
|
+
*
|
|
983
|
+
* @export
|
|
984
|
+
* @interface ReportTaskResponse
|
|
985
|
+
*/
|
|
986
|
+
export interface ReportTaskResponse {
|
|
987
|
+
/**
|
|
988
|
+
*
|
|
989
|
+
* @type {string}
|
|
990
|
+
* @memberof ReportTaskResponse
|
|
991
|
+
*/
|
|
992
|
+
id?: string;
|
|
993
|
+
/**
|
|
994
|
+
* Title of the report task
|
|
995
|
+
* @type {string}
|
|
996
|
+
* @memberof ReportTaskResponse
|
|
997
|
+
*/
|
|
998
|
+
title?: string;
|
|
999
|
+
/**
|
|
1000
|
+
*
|
|
1001
|
+
* @type {string}
|
|
1002
|
+
* @memberof ReportTaskResponse
|
|
1003
|
+
*/
|
|
1004
|
+
templateId?: string;
|
|
1005
|
+
/**
|
|
1006
|
+
* Datetime in UTC when report task\'s schedule will start
|
|
1007
|
+
* @type {string}
|
|
1008
|
+
* @memberof ReportTaskResponse
|
|
1009
|
+
*/
|
|
1010
|
+
startOn?: string;
|
|
1011
|
+
/**
|
|
1012
|
+
* Datetime in UTC when report task schedule will end
|
|
1013
|
+
* @type {string}
|
|
1014
|
+
* @memberof ReportTaskResponse
|
|
1015
|
+
*/
|
|
1016
|
+
endOn?: string;
|
|
1017
|
+
/**
|
|
1018
|
+
* Describes the frequency of the report task\'s schedule
|
|
1019
|
+
* @type {string}
|
|
1020
|
+
* @memberof ReportTaskResponse
|
|
1021
|
+
*/
|
|
1022
|
+
frequency?: ReportTaskResponseFrequencyEnum;
|
|
1023
|
+
/**
|
|
1024
|
+
* The interval of the report task\'s schedule
|
|
1025
|
+
* @type {string}
|
|
1026
|
+
* @memberof ReportTaskResponse
|
|
1027
|
+
*/
|
|
1028
|
+
every?: string;
|
|
1029
|
+
/**
|
|
1030
|
+
* Datetime in UTC when the report task will execute
|
|
1031
|
+
* @type {string}
|
|
1032
|
+
* @memberof ReportTaskResponse
|
|
1033
|
+
*/
|
|
1034
|
+
at?: string;
|
|
1035
|
+
/**
|
|
1036
|
+
* Denotes whether the report task will go into the report processing queue
|
|
1037
|
+
* @type {boolean}
|
|
1038
|
+
* @memberof ReportTaskResponse
|
|
1039
|
+
*/
|
|
1040
|
+
enabled?: boolean;
|
|
1041
|
+
/**
|
|
1042
|
+
* Array of objects denoting filter sets to apply to the report task
|
|
1043
|
+
* @type {Array<ReportTaskFilterSets>}
|
|
1044
|
+
* @memberof ReportTaskResponse
|
|
1045
|
+
*/
|
|
1046
|
+
filterSets?: Array<ReportTaskFilterSets>;
|
|
1047
|
+
/**
|
|
1048
|
+
*
|
|
1049
|
+
* @type {string}
|
|
1050
|
+
* @memberof ReportTaskResponse
|
|
1051
|
+
*/
|
|
1052
|
+
filterCycleId?: string;
|
|
1053
|
+
/**
|
|
1054
|
+
* Calculated datetime in UTC when the report task will run next, if applicable
|
|
1055
|
+
* @type {string}
|
|
1056
|
+
* @memberof ReportTaskResponse
|
|
1057
|
+
*/
|
|
1058
|
+
nextRunAt?: string;
|
|
1059
|
+
/**
|
|
1060
|
+
* The error object from the last report task execution, if applicable
|
|
1061
|
+
* @type {string}
|
|
1062
|
+
* @memberof ReportTaskResponse
|
|
1063
|
+
*/
|
|
1064
|
+
error?: string;
|
|
1065
|
+
/**
|
|
1066
|
+
* The average time to run the report task, in minutes
|
|
1067
|
+
* @type {number}
|
|
1068
|
+
* @memberof ReportTaskResponse
|
|
1069
|
+
*/
|
|
1070
|
+
averageTimeToGenerate?: number;
|
|
1071
|
+
/**
|
|
1072
|
+
* Custom filters to apply. This field will be updated entirely if provided
|
|
1073
|
+
* @type {Array<ReportTaskCustomSelection>}
|
|
1074
|
+
* @memberof ReportTaskResponse
|
|
1075
|
+
*/
|
|
1076
|
+
customSelection?: Array<ReportTaskCustomSelection>;
|
|
1077
|
+
/**
|
|
1078
|
+
*
|
|
1079
|
+
* @type {Array<ReportTaskVariables>}
|
|
1080
|
+
* @memberof ReportTaskResponse
|
|
1081
|
+
*/
|
|
1082
|
+
variables?: Array<ReportTaskVariables>;
|
|
1083
|
+
/**
|
|
1084
|
+
*
|
|
1085
|
+
* @type {{ [key: string]: string; }}
|
|
1086
|
+
* @memberof ReportTaskResponse
|
|
1087
|
+
*/
|
|
1088
|
+
meta?: { [key: string]: string; };
|
|
1089
|
+
/**
|
|
1090
|
+
* The time spent waiting on data platform responses during the last report task execution, in minutes
|
|
1091
|
+
* @type {number}
|
|
1092
|
+
* @memberof ReportTaskResponse
|
|
1093
|
+
*/
|
|
1094
|
+
dataPlatformWaitTime?: number;
|
|
1095
|
+
/**
|
|
1096
|
+
* Denotes whether the generated report should be emailed to its users or groups after a successful run
|
|
1097
|
+
* @type {string}
|
|
1098
|
+
* @memberof ReportTaskResponse
|
|
1099
|
+
*/
|
|
1100
|
+
email?: ReportTaskResponseEmailEnum;
|
|
1101
|
+
/**
|
|
1102
|
+
* Groups to share the published report with. This field will be updated entirely if provided
|
|
1103
|
+
* @type {Array<ReportTaskGroupsToShareWith>}
|
|
1104
|
+
* @memberof ReportTaskResponse
|
|
1105
|
+
*/
|
|
1106
|
+
groupsToShareWith?: Array<ReportTaskGroupsToShareWith>;
|
|
1107
|
+
/**
|
|
1108
|
+
*
|
|
1109
|
+
* @type {Array<ReportTaskTags>}
|
|
1110
|
+
* @memberof ReportTaskResponse
|
|
1111
|
+
*/
|
|
1112
|
+
tags?: Array<ReportTaskTags>;
|
|
1113
|
+
/**
|
|
1114
|
+
* Users to share the published report with. This field will be updated entirely if provided
|
|
1115
|
+
* @type {Array<ReportTaskResponseAllOfUsersToShareWith>}
|
|
1116
|
+
* @memberof ReportTaskResponse
|
|
1117
|
+
*/
|
|
1118
|
+
usersToShareWith?: Array<ReportTaskResponseAllOfUsersToShareWith>;
|
|
1119
|
+
}
|
|
1120
|
+
|
|
1121
|
+
/**
|
|
1122
|
+
* @export
|
|
1123
|
+
* @enum {string}
|
|
1124
|
+
*/
|
|
1125
|
+
export enum ReportTaskResponseFrequencyEnum {
|
|
1126
|
+
Monthly = 'Monthly',
|
|
1127
|
+
OnceNow = 'Once - now',
|
|
1128
|
+
OnceScheduled = 'Once - Scheduled',
|
|
1129
|
+
Annually = 'Annually',
|
|
1130
|
+
Daily = 'Daily',
|
|
1131
|
+
Weekly = 'Weekly'
|
|
1132
|
+
}
|
|
1133
|
+
/**
|
|
1134
|
+
* @export
|
|
1135
|
+
* @enum {string}
|
|
1136
|
+
*/
|
|
1137
|
+
export enum ReportTaskResponseEmailEnum {
|
|
1138
|
+
Pdf = 'pdf',
|
|
1139
|
+
Pptx = 'pptx',
|
|
1140
|
+
Xlsx = 'xlsx',
|
|
1141
|
+
Csv = 'csv'
|
|
1142
|
+
}
|
|
1143
|
+
|
|
1144
|
+
/**
|
|
1145
|
+
*
|
|
1146
|
+
* @export
|
|
1147
|
+
* @interface ReportTaskResponseAllOf
|
|
1148
|
+
*/
|
|
1149
|
+
export interface ReportTaskResponseAllOf {
|
|
1150
|
+
/**
|
|
1151
|
+
* Users to share the published report with. This field will be updated entirely if provided
|
|
1152
|
+
* @type {Array<ReportTaskResponseAllOfUsersToShareWith>}
|
|
1153
|
+
* @memberof ReportTaskResponseAllOf
|
|
1154
|
+
*/
|
|
1155
|
+
usersToShareWith?: Array<ReportTaskResponseAllOfUsersToShareWith>;
|
|
1156
|
+
}
|
|
1157
|
+
/**
|
|
1158
|
+
*
|
|
1159
|
+
* @export
|
|
1160
|
+
* @interface ReportTaskResponseAllOfUsersToShareWith
|
|
1161
|
+
*/
|
|
1162
|
+
export interface ReportTaskResponseAllOfUsersToShareWith {
|
|
1163
|
+
/**
|
|
1164
|
+
*
|
|
1165
|
+
* @type {string}
|
|
1166
|
+
* @memberof ReportTaskResponseAllOfUsersToShareWith
|
|
1167
|
+
*/
|
|
1168
|
+
userId?: string;
|
|
1169
|
+
/**
|
|
1170
|
+
*
|
|
1171
|
+
* @type {string}
|
|
1172
|
+
* @memberof ReportTaskResponseAllOfUsersToShareWith
|
|
1173
|
+
*/
|
|
1174
|
+
email?: string;
|
|
1175
|
+
}
|
|
1176
|
+
/**
|
|
1177
|
+
*
|
|
1178
|
+
* @export
|
|
1179
|
+
* @interface ReportTaskTags
|
|
1180
|
+
*/
|
|
1181
|
+
export interface ReportTaskTags {
|
|
1182
|
+
/**
|
|
1183
|
+
*
|
|
1184
|
+
* @type {string}
|
|
1185
|
+
* @memberof ReportTaskTags
|
|
1186
|
+
*/
|
|
1187
|
+
id?: string;
|
|
1188
|
+
/**
|
|
1189
|
+
*
|
|
1190
|
+
* @type {string}
|
|
1191
|
+
* @memberof ReportTaskTags
|
|
1192
|
+
*/
|
|
1193
|
+
name?: string;
|
|
1194
|
+
}
|
|
834
1195
|
/**
|
|
835
1196
|
*
|
|
836
1197
|
* @export
|
|
@@ -1158,12 +1519,12 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
1158
1519
|
*
|
|
1159
1520
|
* @summary Retrieve a generated document
|
|
1160
1521
|
* @param {string} fileName
|
|
1161
|
-
* @param {'pdf' | 'pptx' | '
|
|
1522
|
+
* @param {'pdf' | 'pptx' | 'xlsx' | 'csv'} fileType
|
|
1162
1523
|
* @param {string} [attachmentName] A document file title. This value is reflected back to the client in the fileName header.
|
|
1163
1524
|
* @param {*} [options] Override http request option.
|
|
1164
1525
|
* @throws {RequiredError}
|
|
1165
1526
|
*/
|
|
1166
|
-
getDocument: async (fileName: string, fileType: 'pdf' | 'pptx' | '
|
|
1527
|
+
getDocument: async (fileName: string, fileType: 'pdf' | 'pptx' | 'xlsx' | 'csv', attachmentName?: string, options: any = {}): Promise<RequestArgs> => {
|
|
1167
1528
|
// verify required parameter 'fileName' is not null or undefined
|
|
1168
1529
|
assertParamExists('getDocument', 'fileName', fileName)
|
|
1169
1530
|
// verify required parameter 'fileType' is not null or undefined
|
|
@@ -1217,12 +1578,12 @@ export const DocumentsApiFp = function(configuration?: Configuration) {
|
|
|
1217
1578
|
*
|
|
1218
1579
|
* @summary Retrieve a generated document
|
|
1219
1580
|
* @param {string} fileName
|
|
1220
|
-
* @param {'pdf' | 'pptx' | '
|
|
1581
|
+
* @param {'pdf' | 'pptx' | 'xlsx' | 'csv'} fileType
|
|
1221
1582
|
* @param {string} [attachmentName] A document file title. This value is reflected back to the client in the fileName header.
|
|
1222
1583
|
* @param {*} [options] Override http request option.
|
|
1223
1584
|
* @throws {RequiredError}
|
|
1224
1585
|
*/
|
|
1225
|
-
async getDocument(fileName: string, fileType: 'pdf' | 'pptx' | '
|
|
1586
|
+
async getDocument(fileName: string, fileType: 'pdf' | 'pptx' | 'xlsx' | 'csv', attachmentName?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>> {
|
|
1226
1587
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getDocument(fileName, fileType, attachmentName, options);
|
|
1227
1588
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
1228
1589
|
},
|
|
@@ -1240,12 +1601,12 @@ export const DocumentsApiFactory = function (configuration?: Configuration, base
|
|
|
1240
1601
|
*
|
|
1241
1602
|
* @summary Retrieve a generated document
|
|
1242
1603
|
* @param {string} fileName
|
|
1243
|
-
* @param {'pdf' | 'pptx' | '
|
|
1604
|
+
* @param {'pdf' | 'pptx' | 'xlsx' | 'csv'} fileType
|
|
1244
1605
|
* @param {string} [attachmentName] A document file title. This value is reflected back to the client in the fileName header.
|
|
1245
1606
|
* @param {*} [options] Override http request option.
|
|
1246
1607
|
* @throws {RequiredError}
|
|
1247
1608
|
*/
|
|
1248
|
-
getDocument(fileName: string, fileType: 'pdf' | 'pptx' | '
|
|
1609
|
+
getDocument(fileName: string, fileType: 'pdf' | 'pptx' | 'xlsx' | 'csv', attachmentName?: string, options?: any): AxiosPromise<any> {
|
|
1249
1610
|
return localVarFp.getDocument(fileName, fileType, attachmentName, options).then((request) => request(axios, basePath));
|
|
1250
1611
|
},
|
|
1251
1612
|
};
|
|
@@ -1262,13 +1623,13 @@ export class DocumentsApi extends BaseAPI {
|
|
|
1262
1623
|
*
|
|
1263
1624
|
* @summary Retrieve a generated document
|
|
1264
1625
|
* @param {string} fileName
|
|
1265
|
-
* @param {'pdf' | 'pptx' | '
|
|
1626
|
+
* @param {'pdf' | 'pptx' | 'xlsx' | 'csv'} fileType
|
|
1266
1627
|
* @param {string} [attachmentName] A document file title. This value is reflected back to the client in the fileName header.
|
|
1267
1628
|
* @param {*} [options] Override http request option.
|
|
1268
1629
|
* @throws {RequiredError}
|
|
1269
1630
|
* @memberof DocumentsApi
|
|
1270
1631
|
*/
|
|
1271
|
-
public getDocument(fileName: string, fileType: 'pdf' | 'pptx' | '
|
|
1632
|
+
public getDocument(fileName: string, fileType: 'pdf' | 'pptx' | 'xlsx' | 'csv', attachmentName?: string, options?: any) {
|
|
1272
1633
|
return DocumentsApiFp(this.configuration).getDocument(fileName, fileType, attachmentName, options).then((request) => request(this.axios, this.basePath));
|
|
1273
1634
|
}
|
|
1274
1635
|
}
|
|
@@ -2003,13 +2364,13 @@ export const ReportTasksApiAxiosParamCreator = function (configuration?: Configu
|
|
|
2003
2364
|
/**
|
|
2004
2365
|
*
|
|
2005
2366
|
* @summary Create report task
|
|
2006
|
-
* @param {
|
|
2367
|
+
* @param {ReportTaskRequest} reportTaskRequest
|
|
2007
2368
|
* @param {*} [options] Override http request option.
|
|
2008
2369
|
* @throws {RequiredError}
|
|
2009
2370
|
*/
|
|
2010
|
-
createReportTask: async (
|
|
2011
|
-
// verify required parameter '
|
|
2012
|
-
assertParamExists('createReportTask', '
|
|
2371
|
+
createReportTask: async (reportTaskRequest: ReportTaskRequest, options: any = {}): Promise<RequestArgs> => {
|
|
2372
|
+
// verify required parameter 'reportTaskRequest' is not null or undefined
|
|
2373
|
+
assertParamExists('createReportTask', 'reportTaskRequest', reportTaskRequest)
|
|
2013
2374
|
const localVarPath = `/report-tasks`;
|
|
2014
2375
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2015
2376
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -2035,7 +2396,7 @@ export const ReportTasksApiAxiosParamCreator = function (configuration?: Configu
|
|
|
2035
2396
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2036
2397
|
let formHeaders = {};
|
|
2037
2398
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...formHeaders, ...options.headers};
|
|
2038
|
-
localVarRequestOptions.data = serializeDataIfNeeded(
|
|
2399
|
+
localVarRequestOptions.data = serializeDataIfNeeded(reportTaskRequest, localVarRequestOptions, configuration)
|
|
2039
2400
|
|
|
2040
2401
|
return {
|
|
2041
2402
|
url: toPathString(localVarUrlObj),
|
|
@@ -2187,15 +2548,15 @@ export const ReportTasksApiAxiosParamCreator = function (configuration?: Configu
|
|
|
2187
2548
|
* Accepts partial updates
|
|
2188
2549
|
* @summary Update report task by ID
|
|
2189
2550
|
* @param {string} id
|
|
2190
|
-
* @param {
|
|
2551
|
+
* @param {ReportTaskRequest} reportTaskRequest
|
|
2191
2552
|
* @param {*} [options] Override http request option.
|
|
2192
2553
|
* @throws {RequiredError}
|
|
2193
2554
|
*/
|
|
2194
|
-
updateReportTask: async (id: string,
|
|
2555
|
+
updateReportTask: async (id: string, reportTaskRequest: ReportTaskRequest, options: any = {}): Promise<RequestArgs> => {
|
|
2195
2556
|
// verify required parameter 'id' is not null or undefined
|
|
2196
2557
|
assertParamExists('updateReportTask', 'id', id)
|
|
2197
|
-
// verify required parameter '
|
|
2198
|
-
assertParamExists('updateReportTask', '
|
|
2558
|
+
// verify required parameter 'reportTaskRequest' is not null or undefined
|
|
2559
|
+
assertParamExists('updateReportTask', 'reportTaskRequest', reportTaskRequest)
|
|
2199
2560
|
const localVarPath = `/report-tasks/{Id}`
|
|
2200
2561
|
.replace(`{${"Id"}}`, encodeURIComponent(String(id)));
|
|
2201
2562
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -2222,7 +2583,7 @@ export const ReportTasksApiAxiosParamCreator = function (configuration?: Configu
|
|
|
2222
2583
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2223
2584
|
let formHeaders = {};
|
|
2224
2585
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...formHeaders, ...options.headers};
|
|
2225
|
-
localVarRequestOptions.data = serializeDataIfNeeded(
|
|
2586
|
+
localVarRequestOptions.data = serializeDataIfNeeded(reportTaskRequest, localVarRequestOptions, configuration)
|
|
2226
2587
|
|
|
2227
2588
|
return {
|
|
2228
2589
|
url: toPathString(localVarUrlObj),
|
|
@@ -2242,12 +2603,12 @@ export const ReportTasksApiFp = function(configuration?: Configuration) {
|
|
|
2242
2603
|
/**
|
|
2243
2604
|
*
|
|
2244
2605
|
* @summary Create report task
|
|
2245
|
-
* @param {
|
|
2606
|
+
* @param {ReportTaskRequest} reportTaskRequest
|
|
2246
2607
|
* @param {*} [options] Override http request option.
|
|
2247
2608
|
* @throws {RequiredError}
|
|
2248
2609
|
*/
|
|
2249
|
-
async createReportTask(
|
|
2250
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.createReportTask(
|
|
2610
|
+
async createReportTask(reportTaskRequest: ReportTaskRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReportTaskResponse>> {
|
|
2611
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createReportTask(reportTaskRequest, options);
|
|
2251
2612
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
2252
2613
|
},
|
|
2253
2614
|
/**
|
|
@@ -2258,7 +2619,7 @@ export const ReportTasksApiFp = function(configuration?: Configuration) {
|
|
|
2258
2619
|
* @param {*} [options] Override http request option.
|
|
2259
2620
|
* @throws {RequiredError}
|
|
2260
2621
|
*/
|
|
2261
|
-
async deleteReportTask(id: string, deleteAssociatedReports?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
2622
|
+
async deleteReportTask(id: string, deleteAssociatedReports?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
2262
2623
|
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteReportTask(id, deleteAssociatedReports, options);
|
|
2263
2624
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
2264
2625
|
},
|
|
@@ -2269,7 +2630,7 @@ export const ReportTasksApiFp = function(configuration?: Configuration) {
|
|
|
2269
2630
|
* @param {*} [options] Override http request option.
|
|
2270
2631
|
* @throws {RequiredError}
|
|
2271
2632
|
*/
|
|
2272
|
-
async getReportTask(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
2633
|
+
async getReportTask(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReportTaskResponse>> {
|
|
2273
2634
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getReportTask(id, options);
|
|
2274
2635
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
2275
2636
|
},
|
|
@@ -2291,12 +2652,12 @@ export const ReportTasksApiFp = function(configuration?: Configuration) {
|
|
|
2291
2652
|
* Accepts partial updates
|
|
2292
2653
|
* @summary Update report task by ID
|
|
2293
2654
|
* @param {string} id
|
|
2294
|
-
* @param {
|
|
2655
|
+
* @param {ReportTaskRequest} reportTaskRequest
|
|
2295
2656
|
* @param {*} [options] Override http request option.
|
|
2296
2657
|
* @throws {RequiredError}
|
|
2297
2658
|
*/
|
|
2298
|
-
async updateReportTask(id: string,
|
|
2299
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.updateReportTask(id,
|
|
2659
|
+
async updateReportTask(id: string, reportTaskRequest: ReportTaskRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReportTaskResponse>> {
|
|
2660
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.updateReportTask(id, reportTaskRequest, options);
|
|
2300
2661
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
2301
2662
|
},
|
|
2302
2663
|
}
|
|
@@ -2312,12 +2673,12 @@ export const ReportTasksApiFactory = function (configuration?: Configuration, ba
|
|
|
2312
2673
|
/**
|
|
2313
2674
|
*
|
|
2314
2675
|
* @summary Create report task
|
|
2315
|
-
* @param {
|
|
2676
|
+
* @param {ReportTaskRequest} reportTaskRequest
|
|
2316
2677
|
* @param {*} [options] Override http request option.
|
|
2317
2678
|
* @throws {RequiredError}
|
|
2318
2679
|
*/
|
|
2319
|
-
createReportTask(
|
|
2320
|
-
return localVarFp.createReportTask(
|
|
2680
|
+
createReportTask(reportTaskRequest: ReportTaskRequest, options?: any): AxiosPromise<ReportTaskResponse> {
|
|
2681
|
+
return localVarFp.createReportTask(reportTaskRequest, options).then((request) => request(axios, basePath));
|
|
2321
2682
|
},
|
|
2322
2683
|
/**
|
|
2323
2684
|
* Delete a report task by its ID
|
|
@@ -2327,7 +2688,7 @@ export const ReportTasksApiFactory = function (configuration?: Configuration, ba
|
|
|
2327
2688
|
* @param {*} [options] Override http request option.
|
|
2328
2689
|
* @throws {RequiredError}
|
|
2329
2690
|
*/
|
|
2330
|
-
deleteReportTask(id: string, deleteAssociatedReports?: boolean, options?: any): AxiosPromise<
|
|
2691
|
+
deleteReportTask(id: string, deleteAssociatedReports?: boolean, options?: any): AxiosPromise<void> {
|
|
2331
2692
|
return localVarFp.deleteReportTask(id, deleteAssociatedReports, options).then((request) => request(axios, basePath));
|
|
2332
2693
|
},
|
|
2333
2694
|
/**
|
|
@@ -2337,7 +2698,7 @@ export const ReportTasksApiFactory = function (configuration?: Configuration, ba
|
|
|
2337
2698
|
* @param {*} [options] Override http request option.
|
|
2338
2699
|
* @throws {RequiredError}
|
|
2339
2700
|
*/
|
|
2340
|
-
getReportTask(id: string, options?: any): AxiosPromise<
|
|
2701
|
+
getReportTask(id: string, options?: any): AxiosPromise<ReportTaskResponse> {
|
|
2341
2702
|
return localVarFp.getReportTask(id, options).then((request) => request(axios, basePath));
|
|
2342
2703
|
},
|
|
2343
2704
|
/**
|
|
@@ -2357,12 +2718,12 @@ export const ReportTasksApiFactory = function (configuration?: Configuration, ba
|
|
|
2357
2718
|
* Accepts partial updates
|
|
2358
2719
|
* @summary Update report task by ID
|
|
2359
2720
|
* @param {string} id
|
|
2360
|
-
* @param {
|
|
2721
|
+
* @param {ReportTaskRequest} reportTaskRequest
|
|
2361
2722
|
* @param {*} [options] Override http request option.
|
|
2362
2723
|
* @throws {RequiredError}
|
|
2363
2724
|
*/
|
|
2364
|
-
updateReportTask(id: string,
|
|
2365
|
-
return localVarFp.updateReportTask(id,
|
|
2725
|
+
updateReportTask(id: string, reportTaskRequest: ReportTaskRequest, options?: any): AxiosPromise<ReportTaskResponse> {
|
|
2726
|
+
return localVarFp.updateReportTask(id, reportTaskRequest, options).then((request) => request(axios, basePath));
|
|
2366
2727
|
},
|
|
2367
2728
|
};
|
|
2368
2729
|
};
|
|
@@ -2377,13 +2738,13 @@ export class ReportTasksApi extends BaseAPI {
|
|
|
2377
2738
|
/**
|
|
2378
2739
|
*
|
|
2379
2740
|
* @summary Create report task
|
|
2380
|
-
* @param {
|
|
2741
|
+
* @param {ReportTaskRequest} reportTaskRequest
|
|
2381
2742
|
* @param {*} [options] Override http request option.
|
|
2382
2743
|
* @throws {RequiredError}
|
|
2383
2744
|
* @memberof ReportTasksApi
|
|
2384
2745
|
*/
|
|
2385
|
-
public createReportTask(
|
|
2386
|
-
return ReportTasksApiFp(this.configuration).createReportTask(
|
|
2746
|
+
public createReportTask(reportTaskRequest: ReportTaskRequest, options?: any) {
|
|
2747
|
+
return ReportTasksApiFp(this.configuration).createReportTask(reportTaskRequest, options).then((request) => request(this.axios, this.basePath));
|
|
2387
2748
|
}
|
|
2388
2749
|
|
|
2389
2750
|
/**
|
|
@@ -2430,13 +2791,13 @@ export class ReportTasksApi extends BaseAPI {
|
|
|
2430
2791
|
* Accepts partial updates
|
|
2431
2792
|
* @summary Update report task by ID
|
|
2432
2793
|
* @param {string} id
|
|
2433
|
-
* @param {
|
|
2794
|
+
* @param {ReportTaskRequest} reportTaskRequest
|
|
2434
2795
|
* @param {*} [options] Override http request option.
|
|
2435
2796
|
* @throws {RequiredError}
|
|
2436
2797
|
* @memberof ReportTasksApi
|
|
2437
2798
|
*/
|
|
2438
|
-
public updateReportTask(id: string,
|
|
2439
|
-
return ReportTasksApiFp(this.configuration).updateReportTask(id,
|
|
2799
|
+
public updateReportTask(id: string, reportTaskRequest: ReportTaskRequest, options?: any) {
|
|
2800
|
+
return ReportTasksApiFp(this.configuration).updateReportTask(id, reportTaskRequest, options).then((request) => request(this.axios, this.basePath));
|
|
2440
2801
|
}
|
|
2441
2802
|
}
|
|
2442
2803
|
|
|
@@ -2582,11 +2943,11 @@ export const ReportsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
2582
2943
|
*
|
|
2583
2944
|
* @summary Render a published report
|
|
2584
2945
|
* @param {string} id
|
|
2585
|
-
* @param {'pdf' | 'pptx' | '
|
|
2946
|
+
* @param {'pdf' | 'pptx' | 'xlsx' | 'csv'} format
|
|
2586
2947
|
* @param {*} [options] Override http request option.
|
|
2587
2948
|
* @throws {RequiredError}
|
|
2588
2949
|
*/
|
|
2589
|
-
renderReport: async (id: string, format: 'pdf' | 'pptx' | '
|
|
2950
|
+
renderReport: async (id: string, format: 'pdf' | 'pptx' | 'xlsx' | 'csv', options: any = {}): Promise<RequestArgs> => {
|
|
2590
2951
|
// verify required parameter 'id' is not null or undefined
|
|
2591
2952
|
assertParamExists('renderReport', 'id', id)
|
|
2592
2953
|
// verify required parameter 'format' is not null or undefined
|
|
@@ -2674,11 +3035,11 @@ export const ReportsApiFp = function(configuration?: Configuration) {
|
|
|
2674
3035
|
*
|
|
2675
3036
|
* @summary Render a published report
|
|
2676
3037
|
* @param {string} id
|
|
2677
|
-
* @param {'pdf' | 'pptx' | '
|
|
3038
|
+
* @param {'pdf' | 'pptx' | 'xlsx' | 'csv'} format
|
|
2678
3039
|
* @param {*} [options] Override http request option.
|
|
2679
3040
|
* @throws {RequiredError}
|
|
2680
3041
|
*/
|
|
2681
|
-
async renderReport(id: string, format: 'pdf' | 'pptx' | '
|
|
3042
|
+
async renderReport(id: string, format: 'pdf' | 'pptx' | 'xlsx' | 'csv', options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Job>> {
|
|
2682
3043
|
const localVarAxiosArgs = await localVarAxiosParamCreator.renderReport(id, format, options);
|
|
2683
3044
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
2684
3045
|
},
|
|
@@ -2728,11 +3089,11 @@ export const ReportsApiFactory = function (configuration?: Configuration, basePa
|
|
|
2728
3089
|
*
|
|
2729
3090
|
* @summary Render a published report
|
|
2730
3091
|
* @param {string} id
|
|
2731
|
-
* @param {'pdf' | 'pptx' | '
|
|
3092
|
+
* @param {'pdf' | 'pptx' | 'xlsx' | 'csv'} format
|
|
2732
3093
|
* @param {*} [options] Override http request option.
|
|
2733
3094
|
* @throws {RequiredError}
|
|
2734
3095
|
*/
|
|
2735
|
-
renderReport(id: string, format: 'pdf' | 'pptx' | '
|
|
3096
|
+
renderReport(id: string, format: 'pdf' | 'pptx' | 'xlsx' | 'csv', options?: any): AxiosPromise<Job> {
|
|
2736
3097
|
return localVarFp.renderReport(id, format, options).then((request) => request(axios, basePath));
|
|
2737
3098
|
},
|
|
2738
3099
|
};
|
|
@@ -2787,12 +3148,12 @@ export class ReportsApi extends BaseAPI {
|
|
|
2787
3148
|
*
|
|
2788
3149
|
* @summary Render a published report
|
|
2789
3150
|
* @param {string} id
|
|
2790
|
-
* @param {'pdf' | 'pptx' | '
|
|
3151
|
+
* @param {'pdf' | 'pptx' | 'xlsx' | 'csv'} format
|
|
2791
3152
|
* @param {*} [options] Override http request option.
|
|
2792
3153
|
* @throws {RequiredError}
|
|
2793
3154
|
* @memberof ReportsApi
|
|
2794
3155
|
*/
|
|
2795
|
-
public renderReport(id: string, format: 'pdf' | 'pptx' | '
|
|
3156
|
+
public renderReport(id: string, format: 'pdf' | 'pptx' | 'xlsx' | 'csv', options?: any) {
|
|
2796
3157
|
return ReportsApiFp(this.configuration).renderReport(id, format, options).then((request) => request(this.axios, this.basePath));
|
|
2797
3158
|
}
|
|
2798
3159
|
}
|
|
@@ -3099,11 +3460,11 @@ export const TemplatesApiAxiosParamCreator = function (configuration?: Configura
|
|
|
3099
3460
|
* Render a report template to PDF, PPTX, or XLSX. Responds with a job entity.
|
|
3100
3461
|
* @summary Render a report template
|
|
3101
3462
|
* @param {string} id
|
|
3102
|
-
* @param {'pdf' | 'pptx' | '
|
|
3463
|
+
* @param {'pdf' | 'pptx' | 'xlsx' | 'csv'} format
|
|
3103
3464
|
* @param {*} [options] Override http request option.
|
|
3104
3465
|
* @throws {RequiredError}
|
|
3105
3466
|
*/
|
|
3106
|
-
renderTemplate: async (id: string, format: 'pdf' | 'pptx' | '
|
|
3467
|
+
renderTemplate: async (id: string, format: 'pdf' | 'pptx' | 'xlsx' | 'csv', options: any = {}): Promise<RequestArgs> => {
|
|
3107
3468
|
// verify required parameter 'id' is not null or undefined
|
|
3108
3469
|
assertParamExists('renderTemplate', 'id', id)
|
|
3109
3470
|
// verify required parameter 'format' is not null or undefined
|
|
@@ -3279,11 +3640,11 @@ export const TemplatesApiFp = function(configuration?: Configuration) {
|
|
|
3279
3640
|
* Render a report template to PDF, PPTX, or XLSX. Responds with a job entity.
|
|
3280
3641
|
* @summary Render a report template
|
|
3281
3642
|
* @param {string} id
|
|
3282
|
-
* @param {'pdf' | 'pptx' | '
|
|
3643
|
+
* @param {'pdf' | 'pptx' | 'xlsx' | 'csv'} format
|
|
3283
3644
|
* @param {*} [options] Override http request option.
|
|
3284
3645
|
* @throws {RequiredError}
|
|
3285
3646
|
*/
|
|
3286
|
-
async renderTemplate(id: string, format: 'pdf' | 'pptx' | '
|
|
3647
|
+
async renderTemplate(id: string, format: 'pdf' | 'pptx' | 'xlsx' | 'csv', options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JobResponse>> {
|
|
3287
3648
|
const localVarAxiosArgs = await localVarAxiosParamCreator.renderTemplate(id, format, options);
|
|
3288
3649
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
3289
3650
|
},
|
|
@@ -3383,11 +3744,11 @@ export const TemplatesApiFactory = function (configuration?: Configuration, base
|
|
|
3383
3744
|
* Render a report template to PDF, PPTX, or XLSX. Responds with a job entity.
|
|
3384
3745
|
* @summary Render a report template
|
|
3385
3746
|
* @param {string} id
|
|
3386
|
-
* @param {'pdf' | 'pptx' | '
|
|
3747
|
+
* @param {'pdf' | 'pptx' | 'xlsx' | 'csv'} format
|
|
3387
3748
|
* @param {*} [options] Override http request option.
|
|
3388
3749
|
* @throws {RequiredError}
|
|
3389
3750
|
*/
|
|
3390
|
-
renderTemplate(id: string, format: 'pdf' | 'pptx' | '
|
|
3751
|
+
renderTemplate(id: string, format: 'pdf' | 'pptx' | 'xlsx' | 'csv', options?: any): AxiosPromise<JobResponse> {
|
|
3391
3752
|
return localVarFp.renderTemplate(id, format, options).then((request) => request(axios, basePath));
|
|
3392
3753
|
},
|
|
3393
3754
|
/**
|
|
@@ -3499,12 +3860,12 @@ export class TemplatesApi extends BaseAPI {
|
|
|
3499
3860
|
* Render a report template to PDF, PPTX, or XLSX. Responds with a job entity.
|
|
3500
3861
|
* @summary Render a report template
|
|
3501
3862
|
* @param {string} id
|
|
3502
|
-
* @param {'pdf' | 'pptx' | '
|
|
3863
|
+
* @param {'pdf' | 'pptx' | 'xlsx' | 'csv'} format
|
|
3503
3864
|
* @param {*} [options] Override http request option.
|
|
3504
3865
|
* @throws {RequiredError}
|
|
3505
3866
|
* @memberof TemplatesApi
|
|
3506
3867
|
*/
|
|
3507
|
-
public renderTemplate(id: string, format: 'pdf' | 'pptx' | '
|
|
3868
|
+
public renderTemplate(id: string, format: 'pdf' | 'pptx' | 'xlsx' | 'csv', options?: any) {
|
|
3508
3869
|
return TemplatesApiFp(this.configuration).renderTemplate(id, format, options).then((request) => request(this.axios, this.basePath));
|
|
3509
3870
|
}
|
|
3510
3871
|
|