@emilgroup/tenant-sdk-node 1.31.1 → 1.32.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.
@@ -97,13 +97,64 @@ var DashboardApiAxiosParamCreator = function (configuration) {
97
97
  var _this = this;
98
98
  return {
99
99
  /**
100
- * undefined **Required Permissions** \"reporting.dashboards.create\"
100
+ * Creates a new dashboard using the preconfigured analysis id **Required Permissions** \"reporting.dashboards.create\"
101
+ * @summary Creates a new dashboard
102
+ * @param {CreateDashboardV2RequestDto} createDashboardV2RequestDto
103
+ * @param {string} [authorization] Bearer Token
104
+ * @param {*} [options] Override http request option.
105
+ * @throws {RequiredError}
106
+ */
107
+ createDashboard: function (createDashboardV2RequestDto, authorization, options) {
108
+ if (options === void 0) { options = {}; }
109
+ return __awaiter(_this, void 0, void 0, function () {
110
+ var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
111
+ return __generator(this, function (_a) {
112
+ switch (_a.label) {
113
+ case 0:
114
+ // verify required parameter 'createDashboardV2RequestDto' is not null or undefined
115
+ (0, common_1.assertParamExists)('createDashboard', 'createDashboardV2RequestDto', createDashboardV2RequestDto);
116
+ localVarPath = "/tenantservice/v1/dashboards";
117
+ localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
118
+ if (configuration) {
119
+ baseOptions = configuration.baseOptions;
120
+ baseAccessToken = configuration.accessToken;
121
+ }
122
+ localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
123
+ localVarHeaderParameter = {};
124
+ localVarQueryParameter = {};
125
+ // authentication bearer required
126
+ // http bearer authentication required
127
+ return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
128
+ case 1:
129
+ // authentication bearer required
130
+ // http bearer authentication required
131
+ _a.sent();
132
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
133
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
134
+ }
135
+ localVarHeaderParameter['Content-Type'] = 'application/json';
136
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
137
+ headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
138
+ localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
139
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(createDashboardV2RequestDto, localVarRequestOptions, configuration);
140
+ return [2 /*return*/, {
141
+ url: (0, common_1.toPathString)(localVarUrlObj),
142
+ options: localVarRequestOptions,
143
+ }];
144
+ }
145
+ });
146
+ });
147
+ },
148
+ /**
149
+ * Creates a new dashboard from a preconfigured analysis id and dashboard id. Use POST /tenantservice/v1/dashboards instead. **Required Permissions** \"reporting.dashboards.create\"
150
+ * @summary Creates a new dashboard (DEPRECATED)
101
151
  * @param {CreateDashboardRequestDto} createDashboardRequestDto
102
152
  * @param {string} [authorization] Bearer Token
103
153
  * @param {*} [options] Override http request option.
154
+ * @deprecated
104
155
  * @throws {RequiredError}
105
156
  */
106
- createDashboard: function (createDashboardRequestDto, authorization, options) {
157
+ createDashboardLegacy: function (createDashboardRequestDto, authorization, options) {
107
158
  if (options === void 0) { options = {}; }
108
159
  return __awaiter(_this, void 0, void 0, function () {
109
160
  var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
@@ -111,8 +162,8 @@ var DashboardApiAxiosParamCreator = function (configuration) {
111
162
  switch (_a.label) {
112
163
  case 0:
113
164
  // verify required parameter 'createDashboardRequestDto' is not null or undefined
114
- (0, common_1.assertParamExists)('createDashboard', 'createDashboardRequestDto', createDashboardRequestDto);
115
- localVarPath = "/tenantservice/v1/dashboards";
165
+ (0, common_1.assertParamExists)('createDashboardLegacy', 'createDashboardRequestDto', createDashboardRequestDto);
166
+ localVarPath = "/tenantservice/v1/dashboards/legacy";
116
167
  localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
117
168
  if (configuration) {
118
169
  baseOptions = configuration.baseOptions;
@@ -145,7 +196,8 @@ var DashboardApiAxiosParamCreator = function (configuration) {
145
196
  });
146
197
  },
147
198
  /**
148
- * undefined **Required Permissions** \"reporting.dashboards.delete\"
199
+ * Permanently removes a dashboard and all associated data by dashboard code. **Required Permissions** \"reporting.dashboards.delete\"
200
+ * @summary Deletes an existing dashboard
149
201
  * @param {string} code
150
202
  * @param {string} [authorization] Bearer Token
151
203
  * @param {*} [options] Override http request option.
@@ -192,7 +244,56 @@ var DashboardApiAxiosParamCreator = function (configuration) {
192
244
  });
193
245
  },
194
246
  /**
195
- * undefined **Required Permissions** \"reporting.dashboards.update\"
247
+ * Creates a copy of the specified dashboard with all its configurations and settings. **Required Permissions** \"reporting.dashboards.create\"
248
+ * @summary Creates a duplicate of an existing dashboard
249
+ * @param {string} code
250
+ * @param {string} [authorization] Bearer Token
251
+ * @param {*} [options] Override http request option.
252
+ * @throws {RequiredError}
253
+ */
254
+ duplicateDashboard: function (code, authorization, options) {
255
+ if (options === void 0) { options = {}; }
256
+ return __awaiter(_this, void 0, void 0, function () {
257
+ var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
258
+ return __generator(this, function (_a) {
259
+ switch (_a.label) {
260
+ case 0:
261
+ // verify required parameter 'code' is not null or undefined
262
+ (0, common_1.assertParamExists)('duplicateDashboard', 'code', code);
263
+ localVarPath = "/tenantservice/v1/dashboards/{code}/duplicate"
264
+ .replace("{".concat("code", "}"), encodeURIComponent(String(code)));
265
+ localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
266
+ if (configuration) {
267
+ baseOptions = configuration.baseOptions;
268
+ baseAccessToken = configuration.accessToken;
269
+ }
270
+ localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
271
+ localVarHeaderParameter = {};
272
+ localVarQueryParameter = {};
273
+ // authentication bearer required
274
+ // http bearer authentication required
275
+ return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
276
+ case 1:
277
+ // authentication bearer required
278
+ // http bearer authentication required
279
+ _a.sent();
280
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
281
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
282
+ }
283
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
284
+ headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
285
+ localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
286
+ return [2 /*return*/, {
287
+ url: (0, common_1.toPathString)(localVarUrlObj),
288
+ options: localVarRequestOptions,
289
+ }];
290
+ }
291
+ });
292
+ });
293
+ },
294
+ /**
295
+ * Creates a secure embedded URL that allows dashboard analysis and editing within external applications. **Required Permissions** \"reporting.dashboards.update\"
296
+ * @summary Generates an embedded URL for dashboard editing
196
297
  * @param {string} providerDashboardId
197
298
  * @param {string} [authorization] Bearer Token
198
299
  * @param {*} [options] Override http request option.
@@ -239,7 +340,8 @@ var DashboardApiAxiosParamCreator = function (configuration) {
239
340
  });
240
341
  },
241
342
  /**
242
- * undefined **Required Permissions** \"reporting.dashboards.view\"
343
+ * Fetches dashboard details by code including configuration and metadata. **Required Permissions** \"reporting.dashboards.view\"
344
+ * @summary Retrieves a specific dashboard
243
345
  * @param {string} code
244
346
  * @param {string} [authorization] Bearer Token
245
347
  * @param {*} [options] Override http request option.
@@ -286,7 +388,8 @@ var DashboardApiAxiosParamCreator = function (configuration) {
286
388
  });
287
389
  },
288
390
  /**
289
- * undefined **Required Permissions** \"reporting.dashboards.view\"
391
+ * Creates a secure embedded URL that allows dashboard content to be displayed within external applications. **Required Permissions** \"reporting.dashboards.view\"
392
+ * @summary Generates an embedded URL for dashboard viewing
290
393
  * @param {string} providerDashboardId
291
394
  * @param {string} [authorization] Bearer Token
292
395
  * @param {*} [options] Override http request option.
@@ -333,7 +436,8 @@ var DashboardApiAxiosParamCreator = function (configuration) {
333
436
  });
334
437
  },
335
438
  /**
336
- * undefined **Required Permissions** \"reporting.dashboards.view\"
439
+ * Fetches a paginated list of dashboards with optional filtering and sorting capabilities. **Required Permissions** \"reporting.dashboards.view\"
440
+ * @summary Retrieves a list of dashboards
337
441
  * @param {string} [authorization] Bearer Token
338
442
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
339
443
  * @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.
@@ -404,7 +508,8 @@ var DashboardApiAxiosParamCreator = function (configuration) {
404
508
  });
405
509
  },
406
510
  /**
407
- * undefined **Required Permissions** \"reporting.dashboards.update\"
511
+ * Makes a dashboard publicly available by publishing it from draft or analysis state. **Required Permissions** \"reporting.dashboards.update\"
512
+ * @summary Publishes a dashboard for general access
408
513
  * @param {PublishDashboardRequestDto} publishDashboardRequestDto
409
514
  * @param {string} [authorization] Bearer Token
410
515
  * @param {*} [options] Override http request option.
@@ -452,7 +557,8 @@ var DashboardApiAxiosParamCreator = function (configuration) {
452
557
  });
453
558
  },
454
559
  /**
455
- * undefined **Required Permissions** \"reporting.dashboards.update\"
560
+ * Rolls back dashboard analysis changes to restore the previous version or state. **Required Permissions** \"reporting.dashboards.update\"
561
+ * @summary Reverts dashboard analysis to previous state
456
562
  * @param {RevertAnalysisRequestDto} revertAnalysisRequestDto
457
563
  * @param {string} [authorization] Bearer Token
458
564
  * @param {*} [options] Override http request option.
@@ -500,7 +606,8 @@ var DashboardApiAxiosParamCreator = function (configuration) {
500
606
  });
501
607
  },
502
608
  /**
503
- * undefined **Required Permissions** \"reporting.dashboards.update\"
609
+ * Modifies dashboard properties, configuration, or metadata by dashboard code. **Required Permissions** \"reporting.dashboards.update\"
610
+ * @summary Updates an existing dashboard
504
611
  * @param {string} code
505
612
  * @param {UpdateDashboardRequestDto} updateDashboardRequestDto
506
613
  * @param {string} [authorization] Bearer Token
@@ -562,18 +669,41 @@ var DashboardApiFp = function (configuration) {
562
669
  var localVarAxiosParamCreator = (0, exports.DashboardApiAxiosParamCreator)(configuration);
563
670
  return {
564
671
  /**
565
- * undefined **Required Permissions** \"reporting.dashboards.create\"
672
+ * Creates a new dashboard using the preconfigured analysis id **Required Permissions** \"reporting.dashboards.create\"
673
+ * @summary Creates a new dashboard
674
+ * @param {CreateDashboardV2RequestDto} createDashboardV2RequestDto
675
+ * @param {string} [authorization] Bearer Token
676
+ * @param {*} [options] Override http request option.
677
+ * @throws {RequiredError}
678
+ */
679
+ createDashboard: function (createDashboardV2RequestDto, authorization, options) {
680
+ return __awaiter(this, void 0, void 0, function () {
681
+ var localVarAxiosArgs;
682
+ return __generator(this, function (_a) {
683
+ switch (_a.label) {
684
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.createDashboard(createDashboardV2RequestDto, authorization, options)];
685
+ case 1:
686
+ localVarAxiosArgs = _a.sent();
687
+ return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
688
+ }
689
+ });
690
+ });
691
+ },
692
+ /**
693
+ * Creates a new dashboard from a preconfigured analysis id and dashboard id. Use POST /tenantservice/v1/dashboards instead. **Required Permissions** \"reporting.dashboards.create\"
694
+ * @summary Creates a new dashboard (DEPRECATED)
566
695
  * @param {CreateDashboardRequestDto} createDashboardRequestDto
567
696
  * @param {string} [authorization] Bearer Token
568
697
  * @param {*} [options] Override http request option.
698
+ * @deprecated
569
699
  * @throws {RequiredError}
570
700
  */
571
- createDashboard: function (createDashboardRequestDto, authorization, options) {
701
+ createDashboardLegacy: function (createDashboardRequestDto, authorization, options) {
572
702
  return __awaiter(this, void 0, void 0, function () {
573
703
  var localVarAxiosArgs;
574
704
  return __generator(this, function (_a) {
575
705
  switch (_a.label) {
576
- case 0: return [4 /*yield*/, localVarAxiosParamCreator.createDashboard(createDashboardRequestDto, authorization, options)];
706
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.createDashboardLegacy(createDashboardRequestDto, authorization, options)];
577
707
  case 1:
578
708
  localVarAxiosArgs = _a.sent();
579
709
  return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
@@ -582,7 +712,8 @@ var DashboardApiFp = function (configuration) {
582
712
  });
583
713
  },
584
714
  /**
585
- * undefined **Required Permissions** \"reporting.dashboards.delete\"
715
+ * Permanently removes a dashboard and all associated data by dashboard code. **Required Permissions** \"reporting.dashboards.delete\"
716
+ * @summary Deletes an existing dashboard
586
717
  * @param {string} code
587
718
  * @param {string} [authorization] Bearer Token
588
719
  * @param {*} [options] Override http request option.
@@ -602,7 +733,29 @@ var DashboardApiFp = function (configuration) {
602
733
  });
603
734
  },
604
735
  /**
605
- * undefined **Required Permissions** \"reporting.dashboards.update\"
736
+ * Creates a copy of the specified dashboard with all its configurations and settings. **Required Permissions** \"reporting.dashboards.create\"
737
+ * @summary Creates a duplicate of an existing dashboard
738
+ * @param {string} code
739
+ * @param {string} [authorization] Bearer Token
740
+ * @param {*} [options] Override http request option.
741
+ * @throws {RequiredError}
742
+ */
743
+ duplicateDashboard: function (code, authorization, options) {
744
+ return __awaiter(this, void 0, void 0, function () {
745
+ var localVarAxiosArgs;
746
+ return __generator(this, function (_a) {
747
+ switch (_a.label) {
748
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.duplicateDashboard(code, authorization, options)];
749
+ case 1:
750
+ localVarAxiosArgs = _a.sent();
751
+ return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
752
+ }
753
+ });
754
+ });
755
+ },
756
+ /**
757
+ * Creates a secure embedded URL that allows dashboard analysis and editing within external applications. **Required Permissions** \"reporting.dashboards.update\"
758
+ * @summary Generates an embedded URL for dashboard editing
606
759
  * @param {string} providerDashboardId
607
760
  * @param {string} [authorization] Bearer Token
608
761
  * @param {*} [options] Override http request option.
@@ -622,7 +775,8 @@ var DashboardApiFp = function (configuration) {
622
775
  });
623
776
  },
624
777
  /**
625
- * undefined **Required Permissions** \"reporting.dashboards.view\"
778
+ * Fetches dashboard details by code including configuration and metadata. **Required Permissions** \"reporting.dashboards.view\"
779
+ * @summary Retrieves a specific dashboard
626
780
  * @param {string} code
627
781
  * @param {string} [authorization] Bearer Token
628
782
  * @param {*} [options] Override http request option.
@@ -642,7 +796,8 @@ var DashboardApiFp = function (configuration) {
642
796
  });
643
797
  },
644
798
  /**
645
- * undefined **Required Permissions** \"reporting.dashboards.view\"
799
+ * Creates a secure embedded URL that allows dashboard content to be displayed within external applications. **Required Permissions** \"reporting.dashboards.view\"
800
+ * @summary Generates an embedded URL for dashboard viewing
646
801
  * @param {string} providerDashboardId
647
802
  * @param {string} [authorization] Bearer Token
648
803
  * @param {*} [options] Override http request option.
@@ -662,7 +817,8 @@ var DashboardApiFp = function (configuration) {
662
817
  });
663
818
  },
664
819
  /**
665
- * undefined **Required Permissions** \"reporting.dashboards.view\"
820
+ * Fetches a paginated list of dashboards with optional filtering and sorting capabilities. **Required Permissions** \"reporting.dashboards.view\"
821
+ * @summary Retrieves a list of dashboards
666
822
  * @param {string} [authorization] Bearer Token
667
823
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
668
824
  * @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.
@@ -688,7 +844,8 @@ var DashboardApiFp = function (configuration) {
688
844
  });
689
845
  },
690
846
  /**
691
- * undefined **Required Permissions** \"reporting.dashboards.update\"
847
+ * Makes a dashboard publicly available by publishing it from draft or analysis state. **Required Permissions** \"reporting.dashboards.update\"
848
+ * @summary Publishes a dashboard for general access
692
849
  * @param {PublishDashboardRequestDto} publishDashboardRequestDto
693
850
  * @param {string} [authorization] Bearer Token
694
851
  * @param {*} [options] Override http request option.
@@ -708,7 +865,8 @@ var DashboardApiFp = function (configuration) {
708
865
  });
709
866
  },
710
867
  /**
711
- * undefined **Required Permissions** \"reporting.dashboards.update\"
868
+ * Rolls back dashboard analysis changes to restore the previous version or state. **Required Permissions** \"reporting.dashboards.update\"
869
+ * @summary Reverts dashboard analysis to previous state
712
870
  * @param {RevertAnalysisRequestDto} revertAnalysisRequestDto
713
871
  * @param {string} [authorization] Bearer Token
714
872
  * @param {*} [options] Override http request option.
@@ -728,7 +886,8 @@ var DashboardApiFp = function (configuration) {
728
886
  });
729
887
  },
730
888
  /**
731
- * undefined **Required Permissions** \"reporting.dashboards.update\"
889
+ * Modifies dashboard properties, configuration, or metadata by dashboard code. **Required Permissions** \"reporting.dashboards.update\"
890
+ * @summary Updates an existing dashboard
732
891
  * @param {string} code
733
892
  * @param {UpdateDashboardRequestDto} updateDashboardRequestDto
734
893
  * @param {string} [authorization] Bearer Token
@@ -759,17 +918,31 @@ var DashboardApiFactory = function (configuration, basePath, axios) {
759
918
  var localVarFp = (0, exports.DashboardApiFp)(configuration);
760
919
  return {
761
920
  /**
762
- * undefined **Required Permissions** \"reporting.dashboards.create\"
921
+ * Creates a new dashboard using the preconfigured analysis id **Required Permissions** \"reporting.dashboards.create\"
922
+ * @summary Creates a new dashboard
923
+ * @param {CreateDashboardV2RequestDto} createDashboardV2RequestDto
924
+ * @param {string} [authorization] Bearer Token
925
+ * @param {*} [options] Override http request option.
926
+ * @throws {RequiredError}
927
+ */
928
+ createDashboard: function (createDashboardV2RequestDto, authorization, options) {
929
+ return localVarFp.createDashboard(createDashboardV2RequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
930
+ },
931
+ /**
932
+ * Creates a new dashboard from a preconfigured analysis id and dashboard id. Use POST /tenantservice/v1/dashboards instead. **Required Permissions** \"reporting.dashboards.create\"
933
+ * @summary Creates a new dashboard (DEPRECATED)
763
934
  * @param {CreateDashboardRequestDto} createDashboardRequestDto
764
935
  * @param {string} [authorization] Bearer Token
765
936
  * @param {*} [options] Override http request option.
937
+ * @deprecated
766
938
  * @throws {RequiredError}
767
939
  */
768
- createDashboard: function (createDashboardRequestDto, authorization, options) {
769
- return localVarFp.createDashboard(createDashboardRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
940
+ createDashboardLegacy: function (createDashboardRequestDto, authorization, options) {
941
+ return localVarFp.createDashboardLegacy(createDashboardRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
770
942
  },
771
943
  /**
772
- * undefined **Required Permissions** \"reporting.dashboards.delete\"
944
+ * Permanently removes a dashboard and all associated data by dashboard code. **Required Permissions** \"reporting.dashboards.delete\"
945
+ * @summary Deletes an existing dashboard
773
946
  * @param {string} code
774
947
  * @param {string} [authorization] Bearer Token
775
948
  * @param {*} [options] Override http request option.
@@ -779,7 +952,19 @@ var DashboardApiFactory = function (configuration, basePath, axios) {
779
952
  return localVarFp.deleteDashboard(code, authorization, options).then(function (request) { return request(axios, basePath); });
780
953
  },
781
954
  /**
782
- * undefined **Required Permissions** \"reporting.dashboards.update\"
955
+ * Creates a copy of the specified dashboard with all its configurations and settings. **Required Permissions** \"reporting.dashboards.create\"
956
+ * @summary Creates a duplicate of an existing dashboard
957
+ * @param {string} code
958
+ * @param {string} [authorization] Bearer Token
959
+ * @param {*} [options] Override http request option.
960
+ * @throws {RequiredError}
961
+ */
962
+ duplicateDashboard: function (code, authorization, options) {
963
+ return localVarFp.duplicateDashboard(code, authorization, options).then(function (request) { return request(axios, basePath); });
964
+ },
965
+ /**
966
+ * Creates a secure embedded URL that allows dashboard analysis and editing within external applications. **Required Permissions** \"reporting.dashboards.update\"
967
+ * @summary Generates an embedded URL for dashboard editing
783
968
  * @param {string} providerDashboardId
784
969
  * @param {string} [authorization] Bearer Token
785
970
  * @param {*} [options] Override http request option.
@@ -789,7 +974,8 @@ var DashboardApiFactory = function (configuration, basePath, axios) {
789
974
  return localVarFp.getAnalysisEmbeddedUrl(providerDashboardId, authorization, options).then(function (request) { return request(axios, basePath); });
790
975
  },
791
976
  /**
792
- * undefined **Required Permissions** \"reporting.dashboards.view\"
977
+ * Fetches dashboard details by code including configuration and metadata. **Required Permissions** \"reporting.dashboards.view\"
978
+ * @summary Retrieves a specific dashboard
793
979
  * @param {string} code
794
980
  * @param {string} [authorization] Bearer Token
795
981
  * @param {*} [options] Override http request option.
@@ -799,7 +985,8 @@ var DashboardApiFactory = function (configuration, basePath, axios) {
799
985
  return localVarFp.getDashboard(code, authorization, options).then(function (request) { return request(axios, basePath); });
800
986
  },
801
987
  /**
802
- * undefined **Required Permissions** \"reporting.dashboards.view\"
988
+ * Creates a secure embedded URL that allows dashboard content to be displayed within external applications. **Required Permissions** \"reporting.dashboards.view\"
989
+ * @summary Generates an embedded URL for dashboard viewing
803
990
  * @param {string} providerDashboardId
804
991
  * @param {string} [authorization] Bearer Token
805
992
  * @param {*} [options] Override http request option.
@@ -809,7 +996,8 @@ var DashboardApiFactory = function (configuration, basePath, axios) {
809
996
  return localVarFp.getDashboardEmbeddedUrl(providerDashboardId, authorization, options).then(function (request) { return request(axios, basePath); });
810
997
  },
811
998
  /**
812
- * undefined **Required Permissions** \"reporting.dashboards.view\"
999
+ * Fetches a paginated list of dashboards with optional filtering and sorting capabilities. **Required Permissions** \"reporting.dashboards.view\"
1000
+ * @summary Retrieves a list of dashboards
813
1001
  * @param {string} [authorization] Bearer Token
814
1002
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
815
1003
  * @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.
@@ -825,7 +1013,8 @@ var DashboardApiFactory = function (configuration, basePath, axios) {
825
1013
  return localVarFp.listDashboards(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
826
1014
  },
827
1015
  /**
828
- * undefined **Required Permissions** \"reporting.dashboards.update\"
1016
+ * Makes a dashboard publicly available by publishing it from draft or analysis state. **Required Permissions** \"reporting.dashboards.update\"
1017
+ * @summary Publishes a dashboard for general access
829
1018
  * @param {PublishDashboardRequestDto} publishDashboardRequestDto
830
1019
  * @param {string} [authorization] Bearer Token
831
1020
  * @param {*} [options] Override http request option.
@@ -835,7 +1024,8 @@ var DashboardApiFactory = function (configuration, basePath, axios) {
835
1024
  return localVarFp.publishDashboard(publishDashboardRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
836
1025
  },
837
1026
  /**
838
- * undefined **Required Permissions** \"reporting.dashboards.update\"
1027
+ * Rolls back dashboard analysis changes to restore the previous version or state. **Required Permissions** \"reporting.dashboards.update\"
1028
+ * @summary Reverts dashboard analysis to previous state
839
1029
  * @param {RevertAnalysisRequestDto} revertAnalysisRequestDto
840
1030
  * @param {string} [authorization] Bearer Token
841
1031
  * @param {*} [options] Override http request option.
@@ -845,7 +1035,8 @@ var DashboardApiFactory = function (configuration, basePath, axios) {
845
1035
  return localVarFp.revertAnalysis(revertAnalysisRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
846
1036
  },
847
1037
  /**
848
- * undefined **Required Permissions** \"reporting.dashboards.update\"
1038
+ * Modifies dashboard properties, configuration, or metadata by dashboard code. **Required Permissions** \"reporting.dashboards.update\"
1039
+ * @summary Updates an existing dashboard
849
1040
  * @param {string} code
850
1041
  * @param {UpdateDashboardRequestDto} updateDashboardRequestDto
851
1042
  * @param {string} [authorization] Bearer Token
@@ -870,7 +1061,8 @@ var DashboardApi = /** @class */ (function (_super) {
870
1061
  return _super !== null && _super.apply(this, arguments) || this;
871
1062
  }
872
1063
  /**
873
- * undefined **Required Permissions** \"reporting.dashboards.create\"
1064
+ * Creates a new dashboard using the preconfigured analysis id **Required Permissions** \"reporting.dashboards.create\"
1065
+ * @summary Creates a new dashboard
874
1066
  * @param {DashboardApiCreateDashboardRequest} requestParameters Request parameters.
875
1067
  * @param {*} [options] Override http request option.
876
1068
  * @throws {RequiredError}
@@ -878,10 +1070,24 @@ var DashboardApi = /** @class */ (function (_super) {
878
1070
  */
879
1071
  DashboardApi.prototype.createDashboard = function (requestParameters, options) {
880
1072
  var _this = this;
881
- return (0, exports.DashboardApiFp)(this.configuration).createDashboard(requestParameters.createDashboardRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
1073
+ return (0, exports.DashboardApiFp)(this.configuration).createDashboard(requestParameters.createDashboardV2RequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
1074
+ };
1075
+ /**
1076
+ * Creates a new dashboard from a preconfigured analysis id and dashboard id. Use POST /tenantservice/v1/dashboards instead. **Required Permissions** \"reporting.dashboards.create\"
1077
+ * @summary Creates a new dashboard (DEPRECATED)
1078
+ * @param {DashboardApiCreateDashboardLegacyRequest} requestParameters Request parameters.
1079
+ * @param {*} [options] Override http request option.
1080
+ * @deprecated
1081
+ * @throws {RequiredError}
1082
+ * @memberof DashboardApi
1083
+ */
1084
+ DashboardApi.prototype.createDashboardLegacy = function (requestParameters, options) {
1085
+ var _this = this;
1086
+ return (0, exports.DashboardApiFp)(this.configuration).createDashboardLegacy(requestParameters.createDashboardRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
882
1087
  };
883
1088
  /**
884
- * undefined **Required Permissions** \"reporting.dashboards.delete\"
1089
+ * Permanently removes a dashboard and all associated data by dashboard code. **Required Permissions** \"reporting.dashboards.delete\"
1090
+ * @summary Deletes an existing dashboard
885
1091
  * @param {DashboardApiDeleteDashboardRequest} requestParameters Request parameters.
886
1092
  * @param {*} [options] Override http request option.
887
1093
  * @throws {RequiredError}
@@ -892,7 +1098,20 @@ var DashboardApi = /** @class */ (function (_super) {
892
1098
  return (0, exports.DashboardApiFp)(this.configuration).deleteDashboard(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
893
1099
  };
894
1100
  /**
895
- * undefined **Required Permissions** \"reporting.dashboards.update\"
1101
+ * Creates a copy of the specified dashboard with all its configurations and settings. **Required Permissions** \"reporting.dashboards.create\"
1102
+ * @summary Creates a duplicate of an existing dashboard
1103
+ * @param {DashboardApiDuplicateDashboardRequest} requestParameters Request parameters.
1104
+ * @param {*} [options] Override http request option.
1105
+ * @throws {RequiredError}
1106
+ * @memberof DashboardApi
1107
+ */
1108
+ DashboardApi.prototype.duplicateDashboard = function (requestParameters, options) {
1109
+ var _this = this;
1110
+ return (0, exports.DashboardApiFp)(this.configuration).duplicateDashboard(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
1111
+ };
1112
+ /**
1113
+ * Creates a secure embedded URL that allows dashboard analysis and editing within external applications. **Required Permissions** \"reporting.dashboards.update\"
1114
+ * @summary Generates an embedded URL for dashboard editing
896
1115
  * @param {DashboardApiGetAnalysisEmbeddedUrlRequest} requestParameters Request parameters.
897
1116
  * @param {*} [options] Override http request option.
898
1117
  * @throws {RequiredError}
@@ -903,7 +1122,8 @@ var DashboardApi = /** @class */ (function (_super) {
903
1122
  return (0, exports.DashboardApiFp)(this.configuration).getAnalysisEmbeddedUrl(requestParameters.providerDashboardId, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
904
1123
  };
905
1124
  /**
906
- * undefined **Required Permissions** \"reporting.dashboards.view\"
1125
+ * Fetches dashboard details by code including configuration and metadata. **Required Permissions** \"reporting.dashboards.view\"
1126
+ * @summary Retrieves a specific dashboard
907
1127
  * @param {DashboardApiGetDashboardRequest} requestParameters Request parameters.
908
1128
  * @param {*} [options] Override http request option.
909
1129
  * @throws {RequiredError}
@@ -914,7 +1134,8 @@ var DashboardApi = /** @class */ (function (_super) {
914
1134
  return (0, exports.DashboardApiFp)(this.configuration).getDashboard(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
915
1135
  };
916
1136
  /**
917
- * undefined **Required Permissions** \"reporting.dashboards.view\"
1137
+ * Creates a secure embedded URL that allows dashboard content to be displayed within external applications. **Required Permissions** \"reporting.dashboards.view\"
1138
+ * @summary Generates an embedded URL for dashboard viewing
918
1139
  * @param {DashboardApiGetDashboardEmbeddedUrlRequest} requestParameters Request parameters.
919
1140
  * @param {*} [options] Override http request option.
920
1141
  * @throws {RequiredError}
@@ -925,7 +1146,8 @@ var DashboardApi = /** @class */ (function (_super) {
925
1146
  return (0, exports.DashboardApiFp)(this.configuration).getDashboardEmbeddedUrl(requestParameters.providerDashboardId, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
926
1147
  };
927
1148
  /**
928
- * undefined **Required Permissions** \"reporting.dashboards.view\"
1149
+ * Fetches a paginated list of dashboards with optional filtering and sorting capabilities. **Required Permissions** \"reporting.dashboards.view\"
1150
+ * @summary Retrieves a list of dashboards
929
1151
  * @param {DashboardApiListDashboardsRequest} requestParameters Request parameters.
930
1152
  * @param {*} [options] Override http request option.
931
1153
  * @throws {RequiredError}
@@ -937,7 +1159,8 @@ var DashboardApi = /** @class */ (function (_super) {
937
1159
  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); });
938
1160
  };
939
1161
  /**
940
- * undefined **Required Permissions** \"reporting.dashboards.update\"
1162
+ * Makes a dashboard publicly available by publishing it from draft or analysis state. **Required Permissions** \"reporting.dashboards.update\"
1163
+ * @summary Publishes a dashboard for general access
941
1164
  * @param {DashboardApiPublishDashboardRequest} requestParameters Request parameters.
942
1165
  * @param {*} [options] Override http request option.
943
1166
  * @throws {RequiredError}
@@ -948,7 +1171,8 @@ var DashboardApi = /** @class */ (function (_super) {
948
1171
  return (0, exports.DashboardApiFp)(this.configuration).publishDashboard(requestParameters.publishDashboardRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
949
1172
  };
950
1173
  /**
951
- * undefined **Required Permissions** \"reporting.dashboards.update\"
1174
+ * Rolls back dashboard analysis changes to restore the previous version or state. **Required Permissions** \"reporting.dashboards.update\"
1175
+ * @summary Reverts dashboard analysis to previous state
952
1176
  * @param {DashboardApiRevertAnalysisRequest} requestParameters Request parameters.
953
1177
  * @param {*} [options] Override http request option.
954
1178
  * @throws {RequiredError}
@@ -959,7 +1183,8 @@ var DashboardApi = /** @class */ (function (_super) {
959
1183
  return (0, exports.DashboardApiFp)(this.configuration).revertAnalysis(requestParameters.revertAnalysisRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
960
1184
  };
961
1185
  /**
962
- * undefined **Required Permissions** \"reporting.dashboards.update\"
1186
+ * Modifies dashboard properties, configuration, or metadata by dashboard code. **Required Permissions** \"reporting.dashboards.update\"
1187
+ * @summary Updates an existing dashboard
963
1188
  * @param {DashboardApiUpdateDashboardRequest} requestParameters Request parameters.
964
1189
  * @param {*} [options] Override http request option.
965
1190
  * @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 });