@emilgroup/tenant-sdk 1.32.1 → 1.33.0
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 +3 -0
- package/README.md +2 -2
- package/api/dashboard-api.ts +296 -46
- package/dist/api/dashboard-api.d.ts +195 -42
- package/dist/api/dashboard-api.js +269 -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/create-organization-migration-request-dto.d.ts +6 -0
- package/dist/models/create-resources-migration-request-dto.d.ts +6 -0
- package/dist/models/duplicate-dashboard-response-class.d.ts +25 -0
- package/dist/models/duplicate-dashboard-response-class.js +15 -0
- package/dist/models/index.d.ts +3 -0
- package/dist/models/index.js +3 -0
- package/dist/models/revert-organization-migration-request-dto.d.ts +6 -0
- package/models/create-dashboard-v2-request-dto.ts +42 -0
- package/models/create-dashboard-v2-response-class.ts +31 -0
- package/models/create-organization-migration-request-dto.ts +6 -0
- package/models/create-resources-migration-request-dto.ts +6 -0
- package/models/duplicate-dashboard-response-class.ts +31 -0
- package/models/index.ts +3 -0
- package/models/revert-organization-migration-request-dto.ts +6 -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,56 @@ var DashboardApiAxiosParamCreator = function (configuration) {
|
|
|
188
240
|
});
|
|
189
241
|
},
|
|
190
242
|
/**
|
|
191
|
-
*
|
|
243
|
+
* Creates a copy of the specified dashboard with all its configurations and settings. **Required Permissions** \"reporting.dashboards.create\"
|
|
244
|
+
* @summary Creates a duplicate of an existing dashboard
|
|
245
|
+
* @param {string} code
|
|
246
|
+
* @param {string} [authorization] Bearer Token
|
|
247
|
+
* @param {*} [options] Override http request option.
|
|
248
|
+
* @throws {RequiredError}
|
|
249
|
+
*/
|
|
250
|
+
duplicateDashboard: function (code, authorization, options) {
|
|
251
|
+
if (options === void 0) { options = {}; }
|
|
252
|
+
return __awaiter(_this, void 0, void 0, function () {
|
|
253
|
+
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
254
|
+
return __generator(this, function (_a) {
|
|
255
|
+
switch (_a.label) {
|
|
256
|
+
case 0:
|
|
257
|
+
// verify required parameter 'code' is not null or undefined
|
|
258
|
+
(0, common_1.assertParamExists)('duplicateDashboard', 'code', code);
|
|
259
|
+
localVarPath = "/tenantservice/v1/dashboards/{code}/duplicate"
|
|
260
|
+
.replace("{".concat("code", "}"), encodeURIComponent(String(code)));
|
|
261
|
+
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
262
|
+
if (configuration) {
|
|
263
|
+
baseOptions = configuration.baseOptions;
|
|
264
|
+
baseAccessToken = configuration.accessToken;
|
|
265
|
+
}
|
|
266
|
+
localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
|
|
267
|
+
localVarHeaderParameter = {};
|
|
268
|
+
localVarQueryParameter = {};
|
|
269
|
+
// authentication bearer required
|
|
270
|
+
// http bearer authentication required
|
|
271
|
+
return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
|
|
272
|
+
case 1:
|
|
273
|
+
// authentication bearer required
|
|
274
|
+
// http bearer authentication required
|
|
275
|
+
_a.sent();
|
|
276
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
277
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
278
|
+
}
|
|
279
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
280
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
281
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
282
|
+
return [2 /*return*/, {
|
|
283
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
284
|
+
options: localVarRequestOptions,
|
|
285
|
+
}];
|
|
286
|
+
}
|
|
287
|
+
});
|
|
288
|
+
});
|
|
289
|
+
},
|
|
290
|
+
/**
|
|
291
|
+
* Creates a secure embedded URL that allows dashboard analysis and editing within external applications. **Required Permissions** \"reporting.dashboards.update\"
|
|
292
|
+
* @summary Generates an embedded URL for dashboard editing
|
|
192
293
|
* @param {string} providerDashboardId
|
|
193
294
|
* @param {string} [authorization] Bearer Token
|
|
194
295
|
* @param {*} [options] Override http request option.
|
|
@@ -235,7 +336,8 @@ var DashboardApiAxiosParamCreator = function (configuration) {
|
|
|
235
336
|
});
|
|
236
337
|
},
|
|
237
338
|
/**
|
|
238
|
-
*
|
|
339
|
+
* Fetches dashboard details by code including configuration and metadata. **Required Permissions** \"reporting.dashboards.view\"
|
|
340
|
+
* @summary Retrieves a specific dashboard
|
|
239
341
|
* @param {string} code
|
|
240
342
|
* @param {string} [authorization] Bearer Token
|
|
241
343
|
* @param {*} [options] Override http request option.
|
|
@@ -282,7 +384,8 @@ var DashboardApiAxiosParamCreator = function (configuration) {
|
|
|
282
384
|
});
|
|
283
385
|
},
|
|
284
386
|
/**
|
|
285
|
-
*
|
|
387
|
+
* Creates a secure embedded URL that allows dashboard content to be displayed within external applications. **Required Permissions** \"reporting.dashboards.view\"
|
|
388
|
+
* @summary Generates an embedded URL for dashboard viewing
|
|
286
389
|
* @param {string} providerDashboardId
|
|
287
390
|
* @param {string} [authorization] Bearer Token
|
|
288
391
|
* @param {*} [options] Override http request option.
|
|
@@ -329,7 +432,8 @@ var DashboardApiAxiosParamCreator = function (configuration) {
|
|
|
329
432
|
});
|
|
330
433
|
},
|
|
331
434
|
/**
|
|
332
|
-
*
|
|
435
|
+
* Fetches a paginated list of dashboards with optional filtering and sorting capabilities. **Required Permissions** \"reporting.dashboards.view\"
|
|
436
|
+
* @summary Retrieves a list of dashboards
|
|
333
437
|
* @param {string} [authorization] Bearer Token
|
|
334
438
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
335
439
|
* @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 +504,8 @@ var DashboardApiAxiosParamCreator = function (configuration) {
|
|
|
400
504
|
});
|
|
401
505
|
},
|
|
402
506
|
/**
|
|
403
|
-
*
|
|
507
|
+
* Makes a dashboard publicly available by publishing it from draft or analysis state. **Required Permissions** \"reporting.dashboards.update\"
|
|
508
|
+
* @summary Publishes a dashboard for general access
|
|
404
509
|
* @param {PublishDashboardRequestDto} publishDashboardRequestDto
|
|
405
510
|
* @param {string} [authorization] Bearer Token
|
|
406
511
|
* @param {*} [options] Override http request option.
|
|
@@ -448,7 +553,8 @@ var DashboardApiAxiosParamCreator = function (configuration) {
|
|
|
448
553
|
});
|
|
449
554
|
},
|
|
450
555
|
/**
|
|
451
|
-
*
|
|
556
|
+
* Rolls back dashboard analysis changes to restore the previous version or state. **Required Permissions** \"reporting.dashboards.update\"
|
|
557
|
+
* @summary Reverts dashboard analysis to previous state
|
|
452
558
|
* @param {RevertAnalysisRequestDto} revertAnalysisRequestDto
|
|
453
559
|
* @param {string} [authorization] Bearer Token
|
|
454
560
|
* @param {*} [options] Override http request option.
|
|
@@ -496,7 +602,8 @@ var DashboardApiAxiosParamCreator = function (configuration) {
|
|
|
496
602
|
});
|
|
497
603
|
},
|
|
498
604
|
/**
|
|
499
|
-
*
|
|
605
|
+
* Modifies dashboard properties, configuration, or metadata by dashboard code. **Required Permissions** \"reporting.dashboards.update\"
|
|
606
|
+
* @summary Updates an existing dashboard
|
|
500
607
|
* @param {string} code
|
|
501
608
|
* @param {UpdateDashboardRequestDto} updateDashboardRequestDto
|
|
502
609
|
* @param {string} [authorization] Bearer Token
|
|
@@ -558,18 +665,41 @@ var DashboardApiFp = function (configuration) {
|
|
|
558
665
|
var localVarAxiosParamCreator = (0, exports.DashboardApiAxiosParamCreator)(configuration);
|
|
559
666
|
return {
|
|
560
667
|
/**
|
|
561
|
-
*
|
|
668
|
+
* Creates a new dashboard using the preconfigured analysis id **Required Permissions** \"reporting.dashboards.create\"
|
|
669
|
+
* @summary Creates a new dashboard
|
|
670
|
+
* @param {CreateDashboardV2RequestDto} createDashboardV2RequestDto
|
|
671
|
+
* @param {string} [authorization] Bearer Token
|
|
672
|
+
* @param {*} [options] Override http request option.
|
|
673
|
+
* @throws {RequiredError}
|
|
674
|
+
*/
|
|
675
|
+
createDashboard: function (createDashboardV2RequestDto, authorization, options) {
|
|
676
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
677
|
+
var localVarAxiosArgs;
|
|
678
|
+
return __generator(this, function (_a) {
|
|
679
|
+
switch (_a.label) {
|
|
680
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.createDashboard(createDashboardV2RequestDto, authorization, options)];
|
|
681
|
+
case 1:
|
|
682
|
+
localVarAxiosArgs = _a.sent();
|
|
683
|
+
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
684
|
+
}
|
|
685
|
+
});
|
|
686
|
+
});
|
|
687
|
+
},
|
|
688
|
+
/**
|
|
689
|
+
* Creates a new dashboard from a preconfigured analysis id and dashboard id. Use POST /tenantservice/v1/dashboards instead. **Required Permissions** \"reporting.dashboards.create\"
|
|
690
|
+
* @summary Creates a new dashboard (DEPRECATED)
|
|
562
691
|
* @param {CreateDashboardRequestDto} createDashboardRequestDto
|
|
563
692
|
* @param {string} [authorization] Bearer Token
|
|
564
693
|
* @param {*} [options] Override http request option.
|
|
694
|
+
* @deprecated
|
|
565
695
|
* @throws {RequiredError}
|
|
566
696
|
*/
|
|
567
|
-
|
|
697
|
+
createDashboardLegacy: function (createDashboardRequestDto, authorization, options) {
|
|
568
698
|
return __awaiter(this, void 0, void 0, function () {
|
|
569
699
|
var localVarAxiosArgs;
|
|
570
700
|
return __generator(this, function (_a) {
|
|
571
701
|
switch (_a.label) {
|
|
572
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.
|
|
702
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.createDashboardLegacy(createDashboardRequestDto, authorization, options)];
|
|
573
703
|
case 1:
|
|
574
704
|
localVarAxiosArgs = _a.sent();
|
|
575
705
|
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
@@ -578,7 +708,8 @@ var DashboardApiFp = function (configuration) {
|
|
|
578
708
|
});
|
|
579
709
|
},
|
|
580
710
|
/**
|
|
581
|
-
*
|
|
711
|
+
* Permanently removes a dashboard and all associated data by dashboard code. **Required Permissions** \"reporting.dashboards.delete\"
|
|
712
|
+
* @summary Deletes an existing dashboard
|
|
582
713
|
* @param {string} code
|
|
583
714
|
* @param {string} [authorization] Bearer Token
|
|
584
715
|
* @param {*} [options] Override http request option.
|
|
@@ -598,7 +729,29 @@ var DashboardApiFp = function (configuration) {
|
|
|
598
729
|
});
|
|
599
730
|
},
|
|
600
731
|
/**
|
|
601
|
-
*
|
|
732
|
+
* Creates a copy of the specified dashboard with all its configurations and settings. **Required Permissions** \"reporting.dashboards.create\"
|
|
733
|
+
* @summary Creates a duplicate of an existing dashboard
|
|
734
|
+
* @param {string} code
|
|
735
|
+
* @param {string} [authorization] Bearer Token
|
|
736
|
+
* @param {*} [options] Override http request option.
|
|
737
|
+
* @throws {RequiredError}
|
|
738
|
+
*/
|
|
739
|
+
duplicateDashboard: function (code, authorization, options) {
|
|
740
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
741
|
+
var localVarAxiosArgs;
|
|
742
|
+
return __generator(this, function (_a) {
|
|
743
|
+
switch (_a.label) {
|
|
744
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.duplicateDashboard(code, authorization, options)];
|
|
745
|
+
case 1:
|
|
746
|
+
localVarAxiosArgs = _a.sent();
|
|
747
|
+
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
748
|
+
}
|
|
749
|
+
});
|
|
750
|
+
});
|
|
751
|
+
},
|
|
752
|
+
/**
|
|
753
|
+
* Creates a secure embedded URL that allows dashboard analysis and editing within external applications. **Required Permissions** \"reporting.dashboards.update\"
|
|
754
|
+
* @summary Generates an embedded URL for dashboard editing
|
|
602
755
|
* @param {string} providerDashboardId
|
|
603
756
|
* @param {string} [authorization] Bearer Token
|
|
604
757
|
* @param {*} [options] Override http request option.
|
|
@@ -618,7 +771,8 @@ var DashboardApiFp = function (configuration) {
|
|
|
618
771
|
});
|
|
619
772
|
},
|
|
620
773
|
/**
|
|
621
|
-
*
|
|
774
|
+
* Fetches dashboard details by code including configuration and metadata. **Required Permissions** \"reporting.dashboards.view\"
|
|
775
|
+
* @summary Retrieves a specific dashboard
|
|
622
776
|
* @param {string} code
|
|
623
777
|
* @param {string} [authorization] Bearer Token
|
|
624
778
|
* @param {*} [options] Override http request option.
|
|
@@ -638,7 +792,8 @@ var DashboardApiFp = function (configuration) {
|
|
|
638
792
|
});
|
|
639
793
|
},
|
|
640
794
|
/**
|
|
641
|
-
*
|
|
795
|
+
* Creates a secure embedded URL that allows dashboard content to be displayed within external applications. **Required Permissions** \"reporting.dashboards.view\"
|
|
796
|
+
* @summary Generates an embedded URL for dashboard viewing
|
|
642
797
|
* @param {string} providerDashboardId
|
|
643
798
|
* @param {string} [authorization] Bearer Token
|
|
644
799
|
* @param {*} [options] Override http request option.
|
|
@@ -658,7 +813,8 @@ var DashboardApiFp = function (configuration) {
|
|
|
658
813
|
});
|
|
659
814
|
},
|
|
660
815
|
/**
|
|
661
|
-
*
|
|
816
|
+
* Fetches a paginated list of dashboards with optional filtering and sorting capabilities. **Required Permissions** \"reporting.dashboards.view\"
|
|
817
|
+
* @summary Retrieves a list of dashboards
|
|
662
818
|
* @param {string} [authorization] Bearer Token
|
|
663
819
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
664
820
|
* @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 +840,8 @@ var DashboardApiFp = function (configuration) {
|
|
|
684
840
|
});
|
|
685
841
|
},
|
|
686
842
|
/**
|
|
687
|
-
*
|
|
843
|
+
* Makes a dashboard publicly available by publishing it from draft or analysis state. **Required Permissions** \"reporting.dashboards.update\"
|
|
844
|
+
* @summary Publishes a dashboard for general access
|
|
688
845
|
* @param {PublishDashboardRequestDto} publishDashboardRequestDto
|
|
689
846
|
* @param {string} [authorization] Bearer Token
|
|
690
847
|
* @param {*} [options] Override http request option.
|
|
@@ -704,7 +861,8 @@ var DashboardApiFp = function (configuration) {
|
|
|
704
861
|
});
|
|
705
862
|
},
|
|
706
863
|
/**
|
|
707
|
-
*
|
|
864
|
+
* Rolls back dashboard analysis changes to restore the previous version or state. **Required Permissions** \"reporting.dashboards.update\"
|
|
865
|
+
* @summary Reverts dashboard analysis to previous state
|
|
708
866
|
* @param {RevertAnalysisRequestDto} revertAnalysisRequestDto
|
|
709
867
|
* @param {string} [authorization] Bearer Token
|
|
710
868
|
* @param {*} [options] Override http request option.
|
|
@@ -724,7 +882,8 @@ var DashboardApiFp = function (configuration) {
|
|
|
724
882
|
});
|
|
725
883
|
},
|
|
726
884
|
/**
|
|
727
|
-
*
|
|
885
|
+
* Modifies dashboard properties, configuration, or metadata by dashboard code. **Required Permissions** \"reporting.dashboards.update\"
|
|
886
|
+
* @summary Updates an existing dashboard
|
|
728
887
|
* @param {string} code
|
|
729
888
|
* @param {UpdateDashboardRequestDto} updateDashboardRequestDto
|
|
730
889
|
* @param {string} [authorization] Bearer Token
|
|
@@ -755,17 +914,31 @@ var DashboardApiFactory = function (configuration, basePath, axios) {
|
|
|
755
914
|
var localVarFp = (0, exports.DashboardApiFp)(configuration);
|
|
756
915
|
return {
|
|
757
916
|
/**
|
|
758
|
-
*
|
|
917
|
+
* Creates a new dashboard using the preconfigured analysis id **Required Permissions** \"reporting.dashboards.create\"
|
|
918
|
+
* @summary Creates a new dashboard
|
|
919
|
+
* @param {CreateDashboardV2RequestDto} createDashboardV2RequestDto
|
|
920
|
+
* @param {string} [authorization] Bearer Token
|
|
921
|
+
* @param {*} [options] Override http request option.
|
|
922
|
+
* @throws {RequiredError}
|
|
923
|
+
*/
|
|
924
|
+
createDashboard: function (createDashboardV2RequestDto, authorization, options) {
|
|
925
|
+
return localVarFp.createDashboard(createDashboardV2RequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
926
|
+
},
|
|
927
|
+
/**
|
|
928
|
+
* Creates a new dashboard from a preconfigured analysis id and dashboard id. Use POST /tenantservice/v1/dashboards instead. **Required Permissions** \"reporting.dashboards.create\"
|
|
929
|
+
* @summary Creates a new dashboard (DEPRECATED)
|
|
759
930
|
* @param {CreateDashboardRequestDto} createDashboardRequestDto
|
|
760
931
|
* @param {string} [authorization] Bearer Token
|
|
761
932
|
* @param {*} [options] Override http request option.
|
|
933
|
+
* @deprecated
|
|
762
934
|
* @throws {RequiredError}
|
|
763
935
|
*/
|
|
764
|
-
|
|
765
|
-
return localVarFp.
|
|
936
|
+
createDashboardLegacy: function (createDashboardRequestDto, authorization, options) {
|
|
937
|
+
return localVarFp.createDashboardLegacy(createDashboardRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
766
938
|
},
|
|
767
939
|
/**
|
|
768
|
-
*
|
|
940
|
+
* Permanently removes a dashboard and all associated data by dashboard code. **Required Permissions** \"reporting.dashboards.delete\"
|
|
941
|
+
* @summary Deletes an existing dashboard
|
|
769
942
|
* @param {string} code
|
|
770
943
|
* @param {string} [authorization] Bearer Token
|
|
771
944
|
* @param {*} [options] Override http request option.
|
|
@@ -775,7 +948,19 @@ var DashboardApiFactory = function (configuration, basePath, axios) {
|
|
|
775
948
|
return localVarFp.deleteDashboard(code, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
776
949
|
},
|
|
777
950
|
/**
|
|
778
|
-
*
|
|
951
|
+
* Creates a copy of the specified dashboard with all its configurations and settings. **Required Permissions** \"reporting.dashboards.create\"
|
|
952
|
+
* @summary Creates a duplicate of an existing dashboard
|
|
953
|
+
* @param {string} code
|
|
954
|
+
* @param {string} [authorization] Bearer Token
|
|
955
|
+
* @param {*} [options] Override http request option.
|
|
956
|
+
* @throws {RequiredError}
|
|
957
|
+
*/
|
|
958
|
+
duplicateDashboard: function (code, authorization, options) {
|
|
959
|
+
return localVarFp.duplicateDashboard(code, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
960
|
+
},
|
|
961
|
+
/**
|
|
962
|
+
* Creates a secure embedded URL that allows dashboard analysis and editing within external applications. **Required Permissions** \"reporting.dashboards.update\"
|
|
963
|
+
* @summary Generates an embedded URL for dashboard editing
|
|
779
964
|
* @param {string} providerDashboardId
|
|
780
965
|
* @param {string} [authorization] Bearer Token
|
|
781
966
|
* @param {*} [options] Override http request option.
|
|
@@ -785,7 +970,8 @@ var DashboardApiFactory = function (configuration, basePath, axios) {
|
|
|
785
970
|
return localVarFp.getAnalysisEmbeddedUrl(providerDashboardId, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
786
971
|
},
|
|
787
972
|
/**
|
|
788
|
-
*
|
|
973
|
+
* Fetches dashboard details by code including configuration and metadata. **Required Permissions** \"reporting.dashboards.view\"
|
|
974
|
+
* @summary Retrieves a specific dashboard
|
|
789
975
|
* @param {string} code
|
|
790
976
|
* @param {string} [authorization] Bearer Token
|
|
791
977
|
* @param {*} [options] Override http request option.
|
|
@@ -795,7 +981,8 @@ var DashboardApiFactory = function (configuration, basePath, axios) {
|
|
|
795
981
|
return localVarFp.getDashboard(code, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
796
982
|
},
|
|
797
983
|
/**
|
|
798
|
-
*
|
|
984
|
+
* Creates a secure embedded URL that allows dashboard content to be displayed within external applications. **Required Permissions** \"reporting.dashboards.view\"
|
|
985
|
+
* @summary Generates an embedded URL for dashboard viewing
|
|
799
986
|
* @param {string} providerDashboardId
|
|
800
987
|
* @param {string} [authorization] Bearer Token
|
|
801
988
|
* @param {*} [options] Override http request option.
|
|
@@ -805,7 +992,8 @@ var DashboardApiFactory = function (configuration, basePath, axios) {
|
|
|
805
992
|
return localVarFp.getDashboardEmbeddedUrl(providerDashboardId, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
806
993
|
},
|
|
807
994
|
/**
|
|
808
|
-
*
|
|
995
|
+
* Fetches a paginated list of dashboards with optional filtering and sorting capabilities. **Required Permissions** \"reporting.dashboards.view\"
|
|
996
|
+
* @summary Retrieves a list of dashboards
|
|
809
997
|
* @param {string} [authorization] Bearer Token
|
|
810
998
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
811
999
|
* @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 +1009,8 @@ var DashboardApiFactory = function (configuration, basePath, axios) {
|
|
|
821
1009
|
return localVarFp.listDashboards(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
|
|
822
1010
|
},
|
|
823
1011
|
/**
|
|
824
|
-
*
|
|
1012
|
+
* Makes a dashboard publicly available by publishing it from draft or analysis state. **Required Permissions** \"reporting.dashboards.update\"
|
|
1013
|
+
* @summary Publishes a dashboard for general access
|
|
825
1014
|
* @param {PublishDashboardRequestDto} publishDashboardRequestDto
|
|
826
1015
|
* @param {string} [authorization] Bearer Token
|
|
827
1016
|
* @param {*} [options] Override http request option.
|
|
@@ -831,7 +1020,8 @@ var DashboardApiFactory = function (configuration, basePath, axios) {
|
|
|
831
1020
|
return localVarFp.publishDashboard(publishDashboardRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
832
1021
|
},
|
|
833
1022
|
/**
|
|
834
|
-
*
|
|
1023
|
+
* Rolls back dashboard analysis changes to restore the previous version or state. **Required Permissions** \"reporting.dashboards.update\"
|
|
1024
|
+
* @summary Reverts dashboard analysis to previous state
|
|
835
1025
|
* @param {RevertAnalysisRequestDto} revertAnalysisRequestDto
|
|
836
1026
|
* @param {string} [authorization] Bearer Token
|
|
837
1027
|
* @param {*} [options] Override http request option.
|
|
@@ -841,7 +1031,8 @@ var DashboardApiFactory = function (configuration, basePath, axios) {
|
|
|
841
1031
|
return localVarFp.revertAnalysis(revertAnalysisRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
842
1032
|
},
|
|
843
1033
|
/**
|
|
844
|
-
*
|
|
1034
|
+
* Modifies dashboard properties, configuration, or metadata by dashboard code. **Required Permissions** \"reporting.dashboards.update\"
|
|
1035
|
+
* @summary Updates an existing dashboard
|
|
845
1036
|
* @param {string} code
|
|
846
1037
|
* @param {UpdateDashboardRequestDto} updateDashboardRequestDto
|
|
847
1038
|
* @param {string} [authorization] Bearer Token
|
|
@@ -866,7 +1057,8 @@ var DashboardApi = /** @class */ (function (_super) {
|
|
|
866
1057
|
return _super !== null && _super.apply(this, arguments) || this;
|
|
867
1058
|
}
|
|
868
1059
|
/**
|
|
869
|
-
*
|
|
1060
|
+
* Creates a new dashboard using the preconfigured analysis id **Required Permissions** \"reporting.dashboards.create\"
|
|
1061
|
+
* @summary Creates a new dashboard
|
|
870
1062
|
* @param {DashboardApiCreateDashboardRequest} requestParameters Request parameters.
|
|
871
1063
|
* @param {*} [options] Override http request option.
|
|
872
1064
|
* @throws {RequiredError}
|
|
@@ -874,10 +1066,24 @@ var DashboardApi = /** @class */ (function (_super) {
|
|
|
874
1066
|
*/
|
|
875
1067
|
DashboardApi.prototype.createDashboard = function (requestParameters, options) {
|
|
876
1068
|
var _this = this;
|
|
877
|
-
return (0, exports.DashboardApiFp)(this.configuration).createDashboard(requestParameters.
|
|
1069
|
+
return (0, exports.DashboardApiFp)(this.configuration).createDashboard(requestParameters.createDashboardV2RequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
1070
|
+
};
|
|
1071
|
+
/**
|
|
1072
|
+
* Creates a new dashboard from a preconfigured analysis id and dashboard id. Use POST /tenantservice/v1/dashboards instead. **Required Permissions** \"reporting.dashboards.create\"
|
|
1073
|
+
* @summary Creates a new dashboard (DEPRECATED)
|
|
1074
|
+
* @param {DashboardApiCreateDashboardLegacyRequest} requestParameters Request parameters.
|
|
1075
|
+
* @param {*} [options] Override http request option.
|
|
1076
|
+
* @deprecated
|
|
1077
|
+
* @throws {RequiredError}
|
|
1078
|
+
* @memberof DashboardApi
|
|
1079
|
+
*/
|
|
1080
|
+
DashboardApi.prototype.createDashboardLegacy = function (requestParameters, options) {
|
|
1081
|
+
var _this = this;
|
|
1082
|
+
return (0, exports.DashboardApiFp)(this.configuration).createDashboardLegacy(requestParameters.createDashboardRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
878
1083
|
};
|
|
879
1084
|
/**
|
|
880
|
-
*
|
|
1085
|
+
* Permanently removes a dashboard and all associated data by dashboard code. **Required Permissions** \"reporting.dashboards.delete\"
|
|
1086
|
+
* @summary Deletes an existing dashboard
|
|
881
1087
|
* @param {DashboardApiDeleteDashboardRequest} requestParameters Request parameters.
|
|
882
1088
|
* @param {*} [options] Override http request option.
|
|
883
1089
|
* @throws {RequiredError}
|
|
@@ -888,7 +1094,20 @@ var DashboardApi = /** @class */ (function (_super) {
|
|
|
888
1094
|
return (0, exports.DashboardApiFp)(this.configuration).deleteDashboard(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
889
1095
|
};
|
|
890
1096
|
/**
|
|
891
|
-
*
|
|
1097
|
+
* Creates a copy of the specified dashboard with all its configurations and settings. **Required Permissions** \"reporting.dashboards.create\"
|
|
1098
|
+
* @summary Creates a duplicate of an existing dashboard
|
|
1099
|
+
* @param {DashboardApiDuplicateDashboardRequest} requestParameters Request parameters.
|
|
1100
|
+
* @param {*} [options] Override http request option.
|
|
1101
|
+
* @throws {RequiredError}
|
|
1102
|
+
* @memberof DashboardApi
|
|
1103
|
+
*/
|
|
1104
|
+
DashboardApi.prototype.duplicateDashboard = function (requestParameters, options) {
|
|
1105
|
+
var _this = this;
|
|
1106
|
+
return (0, exports.DashboardApiFp)(this.configuration).duplicateDashboard(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
1107
|
+
};
|
|
1108
|
+
/**
|
|
1109
|
+
* Creates a secure embedded URL that allows dashboard analysis and editing within external applications. **Required Permissions** \"reporting.dashboards.update\"
|
|
1110
|
+
* @summary Generates an embedded URL for dashboard editing
|
|
892
1111
|
* @param {DashboardApiGetAnalysisEmbeddedUrlRequest} requestParameters Request parameters.
|
|
893
1112
|
* @param {*} [options] Override http request option.
|
|
894
1113
|
* @throws {RequiredError}
|
|
@@ -899,7 +1118,8 @@ var DashboardApi = /** @class */ (function (_super) {
|
|
|
899
1118
|
return (0, exports.DashboardApiFp)(this.configuration).getAnalysisEmbeddedUrl(requestParameters.providerDashboardId, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
900
1119
|
};
|
|
901
1120
|
/**
|
|
902
|
-
*
|
|
1121
|
+
* Fetches dashboard details by code including configuration and metadata. **Required Permissions** \"reporting.dashboards.view\"
|
|
1122
|
+
* @summary Retrieves a specific dashboard
|
|
903
1123
|
* @param {DashboardApiGetDashboardRequest} requestParameters Request parameters.
|
|
904
1124
|
* @param {*} [options] Override http request option.
|
|
905
1125
|
* @throws {RequiredError}
|
|
@@ -910,7 +1130,8 @@ var DashboardApi = /** @class */ (function (_super) {
|
|
|
910
1130
|
return (0, exports.DashboardApiFp)(this.configuration).getDashboard(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
911
1131
|
};
|
|
912
1132
|
/**
|
|
913
|
-
*
|
|
1133
|
+
* Creates a secure embedded URL that allows dashboard content to be displayed within external applications. **Required Permissions** \"reporting.dashboards.view\"
|
|
1134
|
+
* @summary Generates an embedded URL for dashboard viewing
|
|
914
1135
|
* @param {DashboardApiGetDashboardEmbeddedUrlRequest} requestParameters Request parameters.
|
|
915
1136
|
* @param {*} [options] Override http request option.
|
|
916
1137
|
* @throws {RequiredError}
|
|
@@ -921,7 +1142,8 @@ var DashboardApi = /** @class */ (function (_super) {
|
|
|
921
1142
|
return (0, exports.DashboardApiFp)(this.configuration).getDashboardEmbeddedUrl(requestParameters.providerDashboardId, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
922
1143
|
};
|
|
923
1144
|
/**
|
|
924
|
-
*
|
|
1145
|
+
* Fetches a paginated list of dashboards with optional filtering and sorting capabilities. **Required Permissions** \"reporting.dashboards.view\"
|
|
1146
|
+
* @summary Retrieves a list of dashboards
|
|
925
1147
|
* @param {DashboardApiListDashboardsRequest} requestParameters Request parameters.
|
|
926
1148
|
* @param {*} [options] Override http request option.
|
|
927
1149
|
* @throws {RequiredError}
|
|
@@ -933,7 +1155,8 @@ var DashboardApi = /** @class */ (function (_super) {
|
|
|
933
1155
|
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
1156
|
};
|
|
935
1157
|
/**
|
|
936
|
-
*
|
|
1158
|
+
* Makes a dashboard publicly available by publishing it from draft or analysis state. **Required Permissions** \"reporting.dashboards.update\"
|
|
1159
|
+
* @summary Publishes a dashboard for general access
|
|
937
1160
|
* @param {DashboardApiPublishDashboardRequest} requestParameters Request parameters.
|
|
938
1161
|
* @param {*} [options] Override http request option.
|
|
939
1162
|
* @throws {RequiredError}
|
|
@@ -944,7 +1167,8 @@ var DashboardApi = /** @class */ (function (_super) {
|
|
|
944
1167
|
return (0, exports.DashboardApiFp)(this.configuration).publishDashboard(requestParameters.publishDashboardRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
945
1168
|
};
|
|
946
1169
|
/**
|
|
947
|
-
*
|
|
1170
|
+
* Rolls back dashboard analysis changes to restore the previous version or state. **Required Permissions** \"reporting.dashboards.update\"
|
|
1171
|
+
* @summary Reverts dashboard analysis to previous state
|
|
948
1172
|
* @param {DashboardApiRevertAnalysisRequest} requestParameters Request parameters.
|
|
949
1173
|
* @param {*} [options] Override http request option.
|
|
950
1174
|
* @throws {RequiredError}
|
|
@@ -955,7 +1179,8 @@ var DashboardApi = /** @class */ (function (_super) {
|
|
|
955
1179
|
return (0, exports.DashboardApiFp)(this.configuration).revertAnalysis(requestParameters.revertAnalysisRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
956
1180
|
};
|
|
957
1181
|
/**
|
|
958
|
-
*
|
|
1182
|
+
* Modifies dashboard properties, configuration, or metadata by dashboard code. **Required Permissions** \"reporting.dashboards.update\"
|
|
1183
|
+
* @summary Updates an existing dashboard
|
|
959
1184
|
* @param {DashboardApiUpdateDashboardRequest} requestParameters Request parameters.
|
|
960
1185
|
* @param {*} [options] Override http request option.
|
|
961
1186
|
* @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 });
|