@emilgroup/tenant-sdk 1.31.1-beta.0 → 1.31.1-beta.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/.openapi-generator/FILES +2 -0
- package/README.md +2 -2
- package/api/dashboard-api.ts +193 -46
- package/dist/api/dashboard-api.d.ts +139 -42
- package/dist/api/dashboard-api.js +177 -44
- package/dist/models/create-dashboard-v2-request-dto.d.ts +36 -0
- package/dist/models/create-dashboard-v2-request-dto.js +15 -0
- package/dist/models/create-dashboard-v2-response-class.d.ts +25 -0
- package/dist/models/create-dashboard-v2-response-class.js +15 -0
- package/dist/models/index.d.ts +2 -0
- package/dist/models/index.js +2 -0
- package/models/create-dashboard-v2-request-dto.ts +42 -0
- package/models/create-dashboard-v2-response-class.ts +31 -0
- package/models/index.ts +2 -0
- package/package.json +1 -1
|
@@ -93,13 +93,64 @@ var DashboardApiAxiosParamCreator = function (configuration) {
|
|
|
93
93
|
var _this = this;
|
|
94
94
|
return {
|
|
95
95
|
/**
|
|
96
|
-
*
|
|
96
|
+
* Creates a new dashboard using the preconfigured analysis id **Required Permissions** \"reporting.dashboards.create\"
|
|
97
|
+
* @summary Creates a new dashboard
|
|
98
|
+
* @param {CreateDashboardV2RequestDto} createDashboardV2RequestDto
|
|
99
|
+
* @param {string} [authorization] Bearer Token
|
|
100
|
+
* @param {*} [options] Override http request option.
|
|
101
|
+
* @throws {RequiredError}
|
|
102
|
+
*/
|
|
103
|
+
createDashboard: function (createDashboardV2RequestDto, authorization, options) {
|
|
104
|
+
if (options === void 0) { options = {}; }
|
|
105
|
+
return __awaiter(_this, void 0, void 0, function () {
|
|
106
|
+
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
107
|
+
return __generator(this, function (_a) {
|
|
108
|
+
switch (_a.label) {
|
|
109
|
+
case 0:
|
|
110
|
+
// verify required parameter 'createDashboardV2RequestDto' is not null or undefined
|
|
111
|
+
(0, common_1.assertParamExists)('createDashboard', 'createDashboardV2RequestDto', createDashboardV2RequestDto);
|
|
112
|
+
localVarPath = "/tenantservice/v1/dashboards";
|
|
113
|
+
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
114
|
+
if (configuration) {
|
|
115
|
+
baseOptions = configuration.baseOptions;
|
|
116
|
+
baseAccessToken = configuration.accessToken;
|
|
117
|
+
}
|
|
118
|
+
localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
|
|
119
|
+
localVarHeaderParameter = {};
|
|
120
|
+
localVarQueryParameter = {};
|
|
121
|
+
// authentication bearer required
|
|
122
|
+
// http bearer authentication required
|
|
123
|
+
return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
|
|
124
|
+
case 1:
|
|
125
|
+
// authentication bearer required
|
|
126
|
+
// http bearer authentication required
|
|
127
|
+
_a.sent();
|
|
128
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
129
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
130
|
+
}
|
|
131
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
132
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
133
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
134
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
135
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(createDashboardV2RequestDto, localVarRequestOptions, configuration);
|
|
136
|
+
return [2 /*return*/, {
|
|
137
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
138
|
+
options: localVarRequestOptions,
|
|
139
|
+
}];
|
|
140
|
+
}
|
|
141
|
+
});
|
|
142
|
+
});
|
|
143
|
+
},
|
|
144
|
+
/**
|
|
145
|
+
* Creates a new dashboard from a preconfigured analysis id and dashboard id. Use POST /tenantservice/v1/dashboards instead. **Required Permissions** \"reporting.dashboards.create\"
|
|
146
|
+
* @summary Creates a new dashboard (DEPRECATED)
|
|
97
147
|
* @param {CreateDashboardRequestDto} createDashboardRequestDto
|
|
98
148
|
* @param {string} [authorization] Bearer Token
|
|
99
149
|
* @param {*} [options] Override http request option.
|
|
150
|
+
* @deprecated
|
|
100
151
|
* @throws {RequiredError}
|
|
101
152
|
*/
|
|
102
|
-
|
|
153
|
+
createDashboardLegacy: function (createDashboardRequestDto, authorization, options) {
|
|
103
154
|
if (options === void 0) { options = {}; }
|
|
104
155
|
return __awaiter(_this, void 0, void 0, function () {
|
|
105
156
|
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
@@ -107,8 +158,8 @@ var DashboardApiAxiosParamCreator = function (configuration) {
|
|
|
107
158
|
switch (_a.label) {
|
|
108
159
|
case 0:
|
|
109
160
|
// verify required parameter 'createDashboardRequestDto' is not null or undefined
|
|
110
|
-
(0, common_1.assertParamExists)('
|
|
111
|
-
localVarPath = "/tenantservice/v1/dashboards";
|
|
161
|
+
(0, common_1.assertParamExists)('createDashboardLegacy', 'createDashboardRequestDto', createDashboardRequestDto);
|
|
162
|
+
localVarPath = "/tenantservice/v1/dashboards/legacy";
|
|
112
163
|
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
113
164
|
if (configuration) {
|
|
114
165
|
baseOptions = configuration.baseOptions;
|
|
@@ -141,7 +192,8 @@ var DashboardApiAxiosParamCreator = function (configuration) {
|
|
|
141
192
|
});
|
|
142
193
|
},
|
|
143
194
|
/**
|
|
144
|
-
*
|
|
195
|
+
* Permanently removes a dashboard and all associated data by dashboard code. **Required Permissions** \"reporting.dashboards.delete\"
|
|
196
|
+
* @summary Deletes an existing dashboard
|
|
145
197
|
* @param {string} code
|
|
146
198
|
* @param {string} [authorization] Bearer Token
|
|
147
199
|
* @param {*} [options] Override http request option.
|
|
@@ -188,7 +240,8 @@ var DashboardApiAxiosParamCreator = function (configuration) {
|
|
|
188
240
|
});
|
|
189
241
|
},
|
|
190
242
|
/**
|
|
191
|
-
*
|
|
243
|
+
* Creates a secure embedded URL that allows dashboard analysis and editing within external applications. **Required Permissions** \"reporting.dashboards.update\"
|
|
244
|
+
* @summary Generates an embedded URL for dashboard editing
|
|
192
245
|
* @param {string} providerDashboardId
|
|
193
246
|
* @param {string} [authorization] Bearer Token
|
|
194
247
|
* @param {*} [options] Override http request option.
|
|
@@ -235,7 +288,8 @@ var DashboardApiAxiosParamCreator = function (configuration) {
|
|
|
235
288
|
});
|
|
236
289
|
},
|
|
237
290
|
/**
|
|
238
|
-
*
|
|
291
|
+
* Fetches dashboard details by code including configuration and metadata. **Required Permissions** \"reporting.dashboards.view\"
|
|
292
|
+
* @summary Retrieves a specific dashboard
|
|
239
293
|
* @param {string} code
|
|
240
294
|
* @param {string} [authorization] Bearer Token
|
|
241
295
|
* @param {*} [options] Override http request option.
|
|
@@ -282,7 +336,8 @@ var DashboardApiAxiosParamCreator = function (configuration) {
|
|
|
282
336
|
});
|
|
283
337
|
},
|
|
284
338
|
/**
|
|
285
|
-
*
|
|
339
|
+
* Creates a secure embedded URL that allows dashboard content to be displayed within external applications. **Required Permissions** \"reporting.dashboards.view\"
|
|
340
|
+
* @summary Generates an embedded URL for dashboard viewing
|
|
286
341
|
* @param {string} providerDashboardId
|
|
287
342
|
* @param {string} [authorization] Bearer Token
|
|
288
343
|
* @param {*} [options] Override http request option.
|
|
@@ -329,7 +384,8 @@ var DashboardApiAxiosParamCreator = function (configuration) {
|
|
|
329
384
|
});
|
|
330
385
|
},
|
|
331
386
|
/**
|
|
332
|
-
*
|
|
387
|
+
* Fetches a paginated list of dashboards with optional filtering and sorting capabilities. **Required Permissions** \"reporting.dashboards.view\"
|
|
388
|
+
* @summary Retrieves a list of dashboards
|
|
333
389
|
* @param {string} [authorization] Bearer Token
|
|
334
390
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
335
391
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
@@ -400,7 +456,8 @@ var DashboardApiAxiosParamCreator = function (configuration) {
|
|
|
400
456
|
});
|
|
401
457
|
},
|
|
402
458
|
/**
|
|
403
|
-
*
|
|
459
|
+
* Makes a dashboard publicly available by publishing it from draft or analysis state. **Required Permissions** \"reporting.dashboards.update\"
|
|
460
|
+
* @summary Publishes a dashboard for general access
|
|
404
461
|
* @param {PublishDashboardRequestDto} publishDashboardRequestDto
|
|
405
462
|
* @param {string} [authorization] Bearer Token
|
|
406
463
|
* @param {*} [options] Override http request option.
|
|
@@ -448,7 +505,8 @@ var DashboardApiAxiosParamCreator = function (configuration) {
|
|
|
448
505
|
});
|
|
449
506
|
},
|
|
450
507
|
/**
|
|
451
|
-
*
|
|
508
|
+
* Rolls back dashboard analysis changes to restore the previous version or state. **Required Permissions** \"reporting.dashboards.update\"
|
|
509
|
+
* @summary Reverts dashboard analysis to previous state
|
|
452
510
|
* @param {RevertAnalysisRequestDto} revertAnalysisRequestDto
|
|
453
511
|
* @param {string} [authorization] Bearer Token
|
|
454
512
|
* @param {*} [options] Override http request option.
|
|
@@ -496,7 +554,8 @@ var DashboardApiAxiosParamCreator = function (configuration) {
|
|
|
496
554
|
});
|
|
497
555
|
},
|
|
498
556
|
/**
|
|
499
|
-
*
|
|
557
|
+
* Modifies dashboard properties, configuration, or metadata by dashboard code. **Required Permissions** \"reporting.dashboards.update\"
|
|
558
|
+
* @summary Updates an existing dashboard
|
|
500
559
|
* @param {string} code
|
|
501
560
|
* @param {UpdateDashboardRequestDto} updateDashboardRequestDto
|
|
502
561
|
* @param {string} [authorization] Bearer Token
|
|
@@ -558,18 +617,41 @@ var DashboardApiFp = function (configuration) {
|
|
|
558
617
|
var localVarAxiosParamCreator = (0, exports.DashboardApiAxiosParamCreator)(configuration);
|
|
559
618
|
return {
|
|
560
619
|
/**
|
|
561
|
-
*
|
|
620
|
+
* Creates a new dashboard using the preconfigured analysis id **Required Permissions** \"reporting.dashboards.create\"
|
|
621
|
+
* @summary Creates a new dashboard
|
|
622
|
+
* @param {CreateDashboardV2RequestDto} createDashboardV2RequestDto
|
|
623
|
+
* @param {string} [authorization] Bearer Token
|
|
624
|
+
* @param {*} [options] Override http request option.
|
|
625
|
+
* @throws {RequiredError}
|
|
626
|
+
*/
|
|
627
|
+
createDashboard: function (createDashboardV2RequestDto, authorization, options) {
|
|
628
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
629
|
+
var localVarAxiosArgs;
|
|
630
|
+
return __generator(this, function (_a) {
|
|
631
|
+
switch (_a.label) {
|
|
632
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.createDashboard(createDashboardV2RequestDto, authorization, options)];
|
|
633
|
+
case 1:
|
|
634
|
+
localVarAxiosArgs = _a.sent();
|
|
635
|
+
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
636
|
+
}
|
|
637
|
+
});
|
|
638
|
+
});
|
|
639
|
+
},
|
|
640
|
+
/**
|
|
641
|
+
* Creates a new dashboard from a preconfigured analysis id and dashboard id. Use POST /tenantservice/v1/dashboards instead. **Required Permissions** \"reporting.dashboards.create\"
|
|
642
|
+
* @summary Creates a new dashboard (DEPRECATED)
|
|
562
643
|
* @param {CreateDashboardRequestDto} createDashboardRequestDto
|
|
563
644
|
* @param {string} [authorization] Bearer Token
|
|
564
645
|
* @param {*} [options] Override http request option.
|
|
646
|
+
* @deprecated
|
|
565
647
|
* @throws {RequiredError}
|
|
566
648
|
*/
|
|
567
|
-
|
|
649
|
+
createDashboardLegacy: function (createDashboardRequestDto, authorization, options) {
|
|
568
650
|
return __awaiter(this, void 0, void 0, function () {
|
|
569
651
|
var localVarAxiosArgs;
|
|
570
652
|
return __generator(this, function (_a) {
|
|
571
653
|
switch (_a.label) {
|
|
572
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.
|
|
654
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.createDashboardLegacy(createDashboardRequestDto, authorization, options)];
|
|
573
655
|
case 1:
|
|
574
656
|
localVarAxiosArgs = _a.sent();
|
|
575
657
|
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
@@ -578,7 +660,8 @@ var DashboardApiFp = function (configuration) {
|
|
|
578
660
|
});
|
|
579
661
|
},
|
|
580
662
|
/**
|
|
581
|
-
*
|
|
663
|
+
* Permanently removes a dashboard and all associated data by dashboard code. **Required Permissions** \"reporting.dashboards.delete\"
|
|
664
|
+
* @summary Deletes an existing dashboard
|
|
582
665
|
* @param {string} code
|
|
583
666
|
* @param {string} [authorization] Bearer Token
|
|
584
667
|
* @param {*} [options] Override http request option.
|
|
@@ -598,7 +681,8 @@ var DashboardApiFp = function (configuration) {
|
|
|
598
681
|
});
|
|
599
682
|
},
|
|
600
683
|
/**
|
|
601
|
-
*
|
|
684
|
+
* Creates a secure embedded URL that allows dashboard analysis and editing within external applications. **Required Permissions** \"reporting.dashboards.update\"
|
|
685
|
+
* @summary Generates an embedded URL for dashboard editing
|
|
602
686
|
* @param {string} providerDashboardId
|
|
603
687
|
* @param {string} [authorization] Bearer Token
|
|
604
688
|
* @param {*} [options] Override http request option.
|
|
@@ -618,7 +702,8 @@ var DashboardApiFp = function (configuration) {
|
|
|
618
702
|
});
|
|
619
703
|
},
|
|
620
704
|
/**
|
|
621
|
-
*
|
|
705
|
+
* Fetches dashboard details by code including configuration and metadata. **Required Permissions** \"reporting.dashboards.view\"
|
|
706
|
+
* @summary Retrieves a specific dashboard
|
|
622
707
|
* @param {string} code
|
|
623
708
|
* @param {string} [authorization] Bearer Token
|
|
624
709
|
* @param {*} [options] Override http request option.
|
|
@@ -638,7 +723,8 @@ var DashboardApiFp = function (configuration) {
|
|
|
638
723
|
});
|
|
639
724
|
},
|
|
640
725
|
/**
|
|
641
|
-
*
|
|
726
|
+
* Creates a secure embedded URL that allows dashboard content to be displayed within external applications. **Required Permissions** \"reporting.dashboards.view\"
|
|
727
|
+
* @summary Generates an embedded URL for dashboard viewing
|
|
642
728
|
* @param {string} providerDashboardId
|
|
643
729
|
* @param {string} [authorization] Bearer Token
|
|
644
730
|
* @param {*} [options] Override http request option.
|
|
@@ -658,7 +744,8 @@ var DashboardApiFp = function (configuration) {
|
|
|
658
744
|
});
|
|
659
745
|
},
|
|
660
746
|
/**
|
|
661
|
-
*
|
|
747
|
+
* Fetches a paginated list of dashboards with optional filtering and sorting capabilities. **Required Permissions** \"reporting.dashboards.view\"
|
|
748
|
+
* @summary Retrieves a list of dashboards
|
|
662
749
|
* @param {string} [authorization] Bearer Token
|
|
663
750
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
664
751
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
@@ -684,7 +771,8 @@ var DashboardApiFp = function (configuration) {
|
|
|
684
771
|
});
|
|
685
772
|
},
|
|
686
773
|
/**
|
|
687
|
-
*
|
|
774
|
+
* Makes a dashboard publicly available by publishing it from draft or analysis state. **Required Permissions** \"reporting.dashboards.update\"
|
|
775
|
+
* @summary Publishes a dashboard for general access
|
|
688
776
|
* @param {PublishDashboardRequestDto} publishDashboardRequestDto
|
|
689
777
|
* @param {string} [authorization] Bearer Token
|
|
690
778
|
* @param {*} [options] Override http request option.
|
|
@@ -704,7 +792,8 @@ var DashboardApiFp = function (configuration) {
|
|
|
704
792
|
});
|
|
705
793
|
},
|
|
706
794
|
/**
|
|
707
|
-
*
|
|
795
|
+
* Rolls back dashboard analysis changes to restore the previous version or state. **Required Permissions** \"reporting.dashboards.update\"
|
|
796
|
+
* @summary Reverts dashboard analysis to previous state
|
|
708
797
|
* @param {RevertAnalysisRequestDto} revertAnalysisRequestDto
|
|
709
798
|
* @param {string} [authorization] Bearer Token
|
|
710
799
|
* @param {*} [options] Override http request option.
|
|
@@ -724,7 +813,8 @@ var DashboardApiFp = function (configuration) {
|
|
|
724
813
|
});
|
|
725
814
|
},
|
|
726
815
|
/**
|
|
727
|
-
*
|
|
816
|
+
* Modifies dashboard properties, configuration, or metadata by dashboard code. **Required Permissions** \"reporting.dashboards.update\"
|
|
817
|
+
* @summary Updates an existing dashboard
|
|
728
818
|
* @param {string} code
|
|
729
819
|
* @param {UpdateDashboardRequestDto} updateDashboardRequestDto
|
|
730
820
|
* @param {string} [authorization] Bearer Token
|
|
@@ -755,17 +845,31 @@ var DashboardApiFactory = function (configuration, basePath, axios) {
|
|
|
755
845
|
var localVarFp = (0, exports.DashboardApiFp)(configuration);
|
|
756
846
|
return {
|
|
757
847
|
/**
|
|
758
|
-
*
|
|
848
|
+
* Creates a new dashboard using the preconfigured analysis id **Required Permissions** \"reporting.dashboards.create\"
|
|
849
|
+
* @summary Creates a new dashboard
|
|
850
|
+
* @param {CreateDashboardV2RequestDto} createDashboardV2RequestDto
|
|
851
|
+
* @param {string} [authorization] Bearer Token
|
|
852
|
+
* @param {*} [options] Override http request option.
|
|
853
|
+
* @throws {RequiredError}
|
|
854
|
+
*/
|
|
855
|
+
createDashboard: function (createDashboardV2RequestDto, authorization, options) {
|
|
856
|
+
return localVarFp.createDashboard(createDashboardV2RequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
857
|
+
},
|
|
858
|
+
/**
|
|
859
|
+
* Creates a new dashboard from a preconfigured analysis id and dashboard id. Use POST /tenantservice/v1/dashboards instead. **Required Permissions** \"reporting.dashboards.create\"
|
|
860
|
+
* @summary Creates a new dashboard (DEPRECATED)
|
|
759
861
|
* @param {CreateDashboardRequestDto} createDashboardRequestDto
|
|
760
862
|
* @param {string} [authorization] Bearer Token
|
|
761
863
|
* @param {*} [options] Override http request option.
|
|
864
|
+
* @deprecated
|
|
762
865
|
* @throws {RequiredError}
|
|
763
866
|
*/
|
|
764
|
-
|
|
765
|
-
return localVarFp.
|
|
867
|
+
createDashboardLegacy: function (createDashboardRequestDto, authorization, options) {
|
|
868
|
+
return localVarFp.createDashboardLegacy(createDashboardRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
766
869
|
},
|
|
767
870
|
/**
|
|
768
|
-
*
|
|
871
|
+
* Permanently removes a dashboard and all associated data by dashboard code. **Required Permissions** \"reporting.dashboards.delete\"
|
|
872
|
+
* @summary Deletes an existing dashboard
|
|
769
873
|
* @param {string} code
|
|
770
874
|
* @param {string} [authorization] Bearer Token
|
|
771
875
|
* @param {*} [options] Override http request option.
|
|
@@ -775,7 +879,8 @@ var DashboardApiFactory = function (configuration, basePath, axios) {
|
|
|
775
879
|
return localVarFp.deleteDashboard(code, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
776
880
|
},
|
|
777
881
|
/**
|
|
778
|
-
*
|
|
882
|
+
* Creates a secure embedded URL that allows dashboard analysis and editing within external applications. **Required Permissions** \"reporting.dashboards.update\"
|
|
883
|
+
* @summary Generates an embedded URL for dashboard editing
|
|
779
884
|
* @param {string} providerDashboardId
|
|
780
885
|
* @param {string} [authorization] Bearer Token
|
|
781
886
|
* @param {*} [options] Override http request option.
|
|
@@ -785,7 +890,8 @@ var DashboardApiFactory = function (configuration, basePath, axios) {
|
|
|
785
890
|
return localVarFp.getAnalysisEmbeddedUrl(providerDashboardId, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
786
891
|
},
|
|
787
892
|
/**
|
|
788
|
-
*
|
|
893
|
+
* Fetches dashboard details by code including configuration and metadata. **Required Permissions** \"reporting.dashboards.view\"
|
|
894
|
+
* @summary Retrieves a specific dashboard
|
|
789
895
|
* @param {string} code
|
|
790
896
|
* @param {string} [authorization] Bearer Token
|
|
791
897
|
* @param {*} [options] Override http request option.
|
|
@@ -795,7 +901,8 @@ var DashboardApiFactory = function (configuration, basePath, axios) {
|
|
|
795
901
|
return localVarFp.getDashboard(code, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
796
902
|
},
|
|
797
903
|
/**
|
|
798
|
-
*
|
|
904
|
+
* Creates a secure embedded URL that allows dashboard content to be displayed within external applications. **Required Permissions** \"reporting.dashboards.view\"
|
|
905
|
+
* @summary Generates an embedded URL for dashboard viewing
|
|
799
906
|
* @param {string} providerDashboardId
|
|
800
907
|
* @param {string} [authorization] Bearer Token
|
|
801
908
|
* @param {*} [options] Override http request option.
|
|
@@ -805,7 +912,8 @@ var DashboardApiFactory = function (configuration, basePath, axios) {
|
|
|
805
912
|
return localVarFp.getDashboardEmbeddedUrl(providerDashboardId, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
806
913
|
},
|
|
807
914
|
/**
|
|
808
|
-
*
|
|
915
|
+
* Fetches a paginated list of dashboards with optional filtering and sorting capabilities. **Required Permissions** \"reporting.dashboards.view\"
|
|
916
|
+
* @summary Retrieves a list of dashboards
|
|
809
917
|
* @param {string} [authorization] Bearer Token
|
|
810
918
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
811
919
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
@@ -821,7 +929,8 @@ var DashboardApiFactory = function (configuration, basePath, axios) {
|
|
|
821
929
|
return localVarFp.listDashboards(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
|
|
822
930
|
},
|
|
823
931
|
/**
|
|
824
|
-
*
|
|
932
|
+
* Makes a dashboard publicly available by publishing it from draft or analysis state. **Required Permissions** \"reporting.dashboards.update\"
|
|
933
|
+
* @summary Publishes a dashboard for general access
|
|
825
934
|
* @param {PublishDashboardRequestDto} publishDashboardRequestDto
|
|
826
935
|
* @param {string} [authorization] Bearer Token
|
|
827
936
|
* @param {*} [options] Override http request option.
|
|
@@ -831,7 +940,8 @@ var DashboardApiFactory = function (configuration, basePath, axios) {
|
|
|
831
940
|
return localVarFp.publishDashboard(publishDashboardRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
832
941
|
},
|
|
833
942
|
/**
|
|
834
|
-
*
|
|
943
|
+
* Rolls back dashboard analysis changes to restore the previous version or state. **Required Permissions** \"reporting.dashboards.update\"
|
|
944
|
+
* @summary Reverts dashboard analysis to previous state
|
|
835
945
|
* @param {RevertAnalysisRequestDto} revertAnalysisRequestDto
|
|
836
946
|
* @param {string} [authorization] Bearer Token
|
|
837
947
|
* @param {*} [options] Override http request option.
|
|
@@ -841,7 +951,8 @@ var DashboardApiFactory = function (configuration, basePath, axios) {
|
|
|
841
951
|
return localVarFp.revertAnalysis(revertAnalysisRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
842
952
|
},
|
|
843
953
|
/**
|
|
844
|
-
*
|
|
954
|
+
* Modifies dashboard properties, configuration, or metadata by dashboard code. **Required Permissions** \"reporting.dashboards.update\"
|
|
955
|
+
* @summary Updates an existing dashboard
|
|
845
956
|
* @param {string} code
|
|
846
957
|
* @param {UpdateDashboardRequestDto} updateDashboardRequestDto
|
|
847
958
|
* @param {string} [authorization] Bearer Token
|
|
@@ -866,7 +977,8 @@ var DashboardApi = /** @class */ (function (_super) {
|
|
|
866
977
|
return _super !== null && _super.apply(this, arguments) || this;
|
|
867
978
|
}
|
|
868
979
|
/**
|
|
869
|
-
*
|
|
980
|
+
* Creates a new dashboard using the preconfigured analysis id **Required Permissions** \"reporting.dashboards.create\"
|
|
981
|
+
* @summary Creates a new dashboard
|
|
870
982
|
* @param {DashboardApiCreateDashboardRequest} requestParameters Request parameters.
|
|
871
983
|
* @param {*} [options] Override http request option.
|
|
872
984
|
* @throws {RequiredError}
|
|
@@ -874,10 +986,24 @@ var DashboardApi = /** @class */ (function (_super) {
|
|
|
874
986
|
*/
|
|
875
987
|
DashboardApi.prototype.createDashboard = function (requestParameters, options) {
|
|
876
988
|
var _this = this;
|
|
877
|
-
return (0, exports.DashboardApiFp)(this.configuration).createDashboard(requestParameters.
|
|
989
|
+
return (0, exports.DashboardApiFp)(this.configuration).createDashboard(requestParameters.createDashboardV2RequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
990
|
+
};
|
|
991
|
+
/**
|
|
992
|
+
* Creates a new dashboard from a preconfigured analysis id and dashboard id. Use POST /tenantservice/v1/dashboards instead. **Required Permissions** \"reporting.dashboards.create\"
|
|
993
|
+
* @summary Creates a new dashboard (DEPRECATED)
|
|
994
|
+
* @param {DashboardApiCreateDashboardLegacyRequest} requestParameters Request parameters.
|
|
995
|
+
* @param {*} [options] Override http request option.
|
|
996
|
+
* @deprecated
|
|
997
|
+
* @throws {RequiredError}
|
|
998
|
+
* @memberof DashboardApi
|
|
999
|
+
*/
|
|
1000
|
+
DashboardApi.prototype.createDashboardLegacy = function (requestParameters, options) {
|
|
1001
|
+
var _this = this;
|
|
1002
|
+
return (0, exports.DashboardApiFp)(this.configuration).createDashboardLegacy(requestParameters.createDashboardRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
878
1003
|
};
|
|
879
1004
|
/**
|
|
880
|
-
*
|
|
1005
|
+
* Permanently removes a dashboard and all associated data by dashboard code. **Required Permissions** \"reporting.dashboards.delete\"
|
|
1006
|
+
* @summary Deletes an existing dashboard
|
|
881
1007
|
* @param {DashboardApiDeleteDashboardRequest} requestParameters Request parameters.
|
|
882
1008
|
* @param {*} [options] Override http request option.
|
|
883
1009
|
* @throws {RequiredError}
|
|
@@ -888,7 +1014,8 @@ var DashboardApi = /** @class */ (function (_super) {
|
|
|
888
1014
|
return (0, exports.DashboardApiFp)(this.configuration).deleteDashboard(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
889
1015
|
};
|
|
890
1016
|
/**
|
|
891
|
-
*
|
|
1017
|
+
* Creates a secure embedded URL that allows dashboard analysis and editing within external applications. **Required Permissions** \"reporting.dashboards.update\"
|
|
1018
|
+
* @summary Generates an embedded URL for dashboard editing
|
|
892
1019
|
* @param {DashboardApiGetAnalysisEmbeddedUrlRequest} requestParameters Request parameters.
|
|
893
1020
|
* @param {*} [options] Override http request option.
|
|
894
1021
|
* @throws {RequiredError}
|
|
@@ -899,7 +1026,8 @@ var DashboardApi = /** @class */ (function (_super) {
|
|
|
899
1026
|
return (0, exports.DashboardApiFp)(this.configuration).getAnalysisEmbeddedUrl(requestParameters.providerDashboardId, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
900
1027
|
};
|
|
901
1028
|
/**
|
|
902
|
-
*
|
|
1029
|
+
* Fetches dashboard details by code including configuration and metadata. **Required Permissions** \"reporting.dashboards.view\"
|
|
1030
|
+
* @summary Retrieves a specific dashboard
|
|
903
1031
|
* @param {DashboardApiGetDashboardRequest} requestParameters Request parameters.
|
|
904
1032
|
* @param {*} [options] Override http request option.
|
|
905
1033
|
* @throws {RequiredError}
|
|
@@ -910,7 +1038,8 @@ var DashboardApi = /** @class */ (function (_super) {
|
|
|
910
1038
|
return (0, exports.DashboardApiFp)(this.configuration).getDashboard(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
911
1039
|
};
|
|
912
1040
|
/**
|
|
913
|
-
*
|
|
1041
|
+
* Creates a secure embedded URL that allows dashboard content to be displayed within external applications. **Required Permissions** \"reporting.dashboards.view\"
|
|
1042
|
+
* @summary Generates an embedded URL for dashboard viewing
|
|
914
1043
|
* @param {DashboardApiGetDashboardEmbeddedUrlRequest} requestParameters Request parameters.
|
|
915
1044
|
* @param {*} [options] Override http request option.
|
|
916
1045
|
* @throws {RequiredError}
|
|
@@ -921,7 +1050,8 @@ var DashboardApi = /** @class */ (function (_super) {
|
|
|
921
1050
|
return (0, exports.DashboardApiFp)(this.configuration).getDashboardEmbeddedUrl(requestParameters.providerDashboardId, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
922
1051
|
};
|
|
923
1052
|
/**
|
|
924
|
-
*
|
|
1053
|
+
* Fetches a paginated list of dashboards with optional filtering and sorting capabilities. **Required Permissions** \"reporting.dashboards.view\"
|
|
1054
|
+
* @summary Retrieves a list of dashboards
|
|
925
1055
|
* @param {DashboardApiListDashboardsRequest} requestParameters Request parameters.
|
|
926
1056
|
* @param {*} [options] Override http request option.
|
|
927
1057
|
* @throws {RequiredError}
|
|
@@ -933,7 +1063,8 @@ var DashboardApi = /** @class */ (function (_super) {
|
|
|
933
1063
|
return (0, exports.DashboardApiFp)(this.configuration).listDashboards(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
934
1064
|
};
|
|
935
1065
|
/**
|
|
936
|
-
*
|
|
1066
|
+
* Makes a dashboard publicly available by publishing it from draft or analysis state. **Required Permissions** \"reporting.dashboards.update\"
|
|
1067
|
+
* @summary Publishes a dashboard for general access
|
|
937
1068
|
* @param {DashboardApiPublishDashboardRequest} requestParameters Request parameters.
|
|
938
1069
|
* @param {*} [options] Override http request option.
|
|
939
1070
|
* @throws {RequiredError}
|
|
@@ -944,7 +1075,8 @@ var DashboardApi = /** @class */ (function (_super) {
|
|
|
944
1075
|
return (0, exports.DashboardApiFp)(this.configuration).publishDashboard(requestParameters.publishDashboardRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
945
1076
|
};
|
|
946
1077
|
/**
|
|
947
|
-
*
|
|
1078
|
+
* Rolls back dashboard analysis changes to restore the previous version or state. **Required Permissions** \"reporting.dashboards.update\"
|
|
1079
|
+
* @summary Reverts dashboard analysis to previous state
|
|
948
1080
|
* @param {DashboardApiRevertAnalysisRequest} requestParameters Request parameters.
|
|
949
1081
|
* @param {*} [options] Override http request option.
|
|
950
1082
|
* @throws {RequiredError}
|
|
@@ -955,7 +1087,8 @@ var DashboardApi = /** @class */ (function (_super) {
|
|
|
955
1087
|
return (0, exports.DashboardApiFp)(this.configuration).revertAnalysis(requestParameters.revertAnalysisRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
956
1088
|
};
|
|
957
1089
|
/**
|
|
958
|
-
*
|
|
1090
|
+
* Modifies dashboard properties, configuration, or metadata by dashboard code. **Required Permissions** \"reporting.dashboards.update\"
|
|
1091
|
+
* @summary Updates an existing dashboard
|
|
959
1092
|
* @param {DashboardApiUpdateDashboardRequest} requestParameters Request parameters.
|
|
960
1093
|
* @param {*} [options] Override http request option.
|
|
961
1094
|
* @throws {RequiredError}
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* EMIL Tenant Service
|
|
3
|
+
* The EMIL TenantService API description
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0
|
|
6
|
+
* Contact: kontakt@emil.de
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
*
|
|
14
|
+
* @export
|
|
15
|
+
* @interface CreateDashboardV2RequestDto
|
|
16
|
+
*/
|
|
17
|
+
export interface CreateDashboardV2RequestDto {
|
|
18
|
+
/**
|
|
19
|
+
* Dashboard name
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof CreateDashboardV2RequestDto
|
|
22
|
+
*/
|
|
23
|
+
'dashboardName': string;
|
|
24
|
+
/**
|
|
25
|
+
* Dashboard description
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof CreateDashboardV2RequestDto
|
|
28
|
+
*/
|
|
29
|
+
'description': string;
|
|
30
|
+
/**
|
|
31
|
+
* Dashboard group id
|
|
32
|
+
* @type {number}
|
|
33
|
+
* @memberof CreateDashboardV2RequestDto
|
|
34
|
+
*/
|
|
35
|
+
'dashboardGroupId'?: number;
|
|
36
|
+
}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* EMIL Tenant Service
|
|
6
|
+
* The EMIL TenantService API description
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0
|
|
9
|
+
* Contact: kontakt@emil.de
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* EMIL Tenant Service
|
|
3
|
+
* The EMIL TenantService API description
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0
|
|
6
|
+
* Contact: kontakt@emil.de
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import { DashboardClass } from './dashboard-class';
|
|
13
|
+
/**
|
|
14
|
+
*
|
|
15
|
+
* @export
|
|
16
|
+
* @interface CreateDashboardV2ResponseClass
|
|
17
|
+
*/
|
|
18
|
+
export interface CreateDashboardV2ResponseClass {
|
|
19
|
+
/**
|
|
20
|
+
* Dashboard
|
|
21
|
+
* @type {DashboardClass}
|
|
22
|
+
* @memberof CreateDashboardV2ResponseClass
|
|
23
|
+
*/
|
|
24
|
+
'dashboard': DashboardClass;
|
|
25
|
+
}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* EMIL Tenant Service
|
|
6
|
+
* The EMIL TenantService API description
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0
|
|
9
|
+
* Contact: kontakt@emil.de
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
package/dist/models/index.d.ts
CHANGED
|
@@ -8,6 +8,8 @@ export * from './create-dashboard-group-request-dto';
|
|
|
8
8
|
export * from './create-dashboard-group-response-class';
|
|
9
9
|
export * from './create-dashboard-request-dto';
|
|
10
10
|
export * from './create-dashboard-response-class';
|
|
11
|
+
export * from './create-dashboard-v2-request-dto';
|
|
12
|
+
export * from './create-dashboard-v2-response-class';
|
|
11
13
|
export * from './create-data-report-request-dto';
|
|
12
14
|
export * from './create-data-report-response-class';
|
|
13
15
|
export * from './create-organization-migration-request-dto';
|
package/dist/models/index.js
CHANGED
|
@@ -24,6 +24,8 @@ __exportStar(require("./create-dashboard-group-request-dto"), exports);
|
|
|
24
24
|
__exportStar(require("./create-dashboard-group-response-class"), exports);
|
|
25
25
|
__exportStar(require("./create-dashboard-request-dto"), exports);
|
|
26
26
|
__exportStar(require("./create-dashboard-response-class"), exports);
|
|
27
|
+
__exportStar(require("./create-dashboard-v2-request-dto"), exports);
|
|
28
|
+
__exportStar(require("./create-dashboard-v2-response-class"), exports);
|
|
27
29
|
__exportStar(require("./create-data-report-request-dto"), exports);
|
|
28
30
|
__exportStar(require("./create-data-report-response-class"), exports);
|
|
29
31
|
__exportStar(require("./create-organization-migration-request-dto"), exports);
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* EMIL Tenant Service
|
|
5
|
+
* The EMIL TenantService API description
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0
|
|
8
|
+
* Contact: kontakt@emil.de
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
/**
|
|
18
|
+
*
|
|
19
|
+
* @export
|
|
20
|
+
* @interface CreateDashboardV2RequestDto
|
|
21
|
+
*/
|
|
22
|
+
export interface CreateDashboardV2RequestDto {
|
|
23
|
+
/**
|
|
24
|
+
* Dashboard name
|
|
25
|
+
* @type {string}
|
|
26
|
+
* @memberof CreateDashboardV2RequestDto
|
|
27
|
+
*/
|
|
28
|
+
'dashboardName': string;
|
|
29
|
+
/**
|
|
30
|
+
* Dashboard description
|
|
31
|
+
* @type {string}
|
|
32
|
+
* @memberof CreateDashboardV2RequestDto
|
|
33
|
+
*/
|
|
34
|
+
'description': string;
|
|
35
|
+
/**
|
|
36
|
+
* Dashboard group id
|
|
37
|
+
* @type {number}
|
|
38
|
+
* @memberof CreateDashboardV2RequestDto
|
|
39
|
+
*/
|
|
40
|
+
'dashboardGroupId'?: number;
|
|
41
|
+
}
|
|
42
|
+
|