@emilgroup/tenant-sdk-node 1.31.0 → 1.31.2-beta.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.
@@ -34,6 +34,8 @@ models/create-dashboard-group-request-dto.ts
34
34
  models/create-dashboard-group-response-class.ts
35
35
  models/create-dashboard-request-dto.ts
36
36
  models/create-dashboard-response-class.ts
37
+ models/create-dashboard-v2-request-dto.ts
38
+ models/create-dashboard-v2-response-class.ts
37
39
  models/create-data-report-request-dto.ts
38
40
  models/create-data-report-response-class.ts
39
41
  models/create-organization-migration-request-dto.ts
@@ -53,6 +55,7 @@ models/dbconfig-dto.ts
53
55
  models/delete-response-class.ts
54
56
  models/disable-users-request-dto.ts
55
57
  models/disable-users-response-class.ts
58
+ models/duplicate-dashboard-response-class.ts
56
59
  models/enable-users-request-dto.ts
57
60
  models/enable-users-response-class.ts
58
61
  models/format-tenant-settings-class.ts
package/README.md CHANGED
@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
17
17
  Navigate to the folder of your consuming project and run one of the following commands:
18
18
 
19
19
  ```
20
- npm install @emilgroup/tenant-sdk-node@1.31.0 --save
20
+ npm install @emilgroup/tenant-sdk-node@1.31.2-beta.0 --save
21
21
  ```
22
22
  or
23
23
  ```
24
- yarn add @emilgroup/tenant-sdk-node@1.31.0
24
+ yarn add @emilgroup/tenant-sdk-node@1.31.2-beta.0
25
25
  ```
26
26
 
27
27
  And then you can import `UsersApi`.
@@ -25,8 +25,14 @@ import { CreateDashboardRequestDto } from '../models';
25
25
  // @ts-ignore
26
26
  import { CreateDashboardResponseClass } from '../models';
27
27
  // @ts-ignore
28
+ import { CreateDashboardV2RequestDto } from '../models';
29
+ // @ts-ignore
30
+ import { CreateDashboardV2ResponseClass } from '../models';
31
+ // @ts-ignore
28
32
  import { DeleteResponseClass } from '../models';
29
33
  // @ts-ignore
34
+ import { DuplicateDashboardResponseClass } from '../models';
35
+ // @ts-ignore
30
36
  import { GetDashboardResponseClass } from '../models';
31
37
  // @ts-ignore
32
38
  import { GetEmbeddedUrlResponseClass } from '../models';
@@ -51,16 +57,65 @@ const FormData = require('form-data');
51
57
  export const DashboardApiAxiosParamCreator = function (configuration?: Configuration) {
52
58
  return {
53
59
  /**
54
- * undefined **Required Permissions** \"reporting.dashboards.create\"
60
+ * Creates a new dashboard using the preconfigured analysis id **Required Permissions** \"reporting.dashboards.create\"
61
+ * @summary Creates a new dashboard
62
+ * @param {CreateDashboardV2RequestDto} createDashboardV2RequestDto
63
+ * @param {string} [authorization] Bearer Token
64
+ * @param {*} [options] Override http request option.
65
+ * @throws {RequiredError}
66
+ */
67
+ createDashboard: async (createDashboardV2RequestDto: CreateDashboardV2RequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
68
+ // verify required parameter 'createDashboardV2RequestDto' is not null or undefined
69
+ assertParamExists('createDashboard', 'createDashboardV2RequestDto', createDashboardV2RequestDto)
70
+ const localVarPath = `/tenantservice/v1/dashboards`;
71
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
72
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
73
+ let baseOptions;
74
+ let baseAccessToken;
75
+ if (configuration) {
76
+ baseOptions = configuration.baseOptions;
77
+ baseAccessToken = configuration.accessToken;
78
+ }
79
+
80
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
81
+ const localVarHeaderParameter = {} as any;
82
+ const localVarQueryParameter = {} as any;
83
+
84
+ // authentication bearer required
85
+ // http bearer authentication required
86
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
87
+
88
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
89
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
90
+ }
91
+
92
+
93
+
94
+ localVarHeaderParameter['Content-Type'] = 'application/json';
95
+
96
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
97
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
98
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
99
+ localVarRequestOptions.data = serializeDataIfNeeded(createDashboardV2RequestDto, localVarRequestOptions, configuration)
100
+
101
+ return {
102
+ url: toPathString(localVarUrlObj),
103
+ options: localVarRequestOptions,
104
+ };
105
+ },
106
+ /**
107
+ * Creates a new dashboard from a preconfigured analysis id and dashboard id. Use POST /tenantservice/v1/dashboards instead. **Required Permissions** \"reporting.dashboards.create\"
108
+ * @summary Creates a new dashboard (DEPRECATED)
55
109
  * @param {CreateDashboardRequestDto} createDashboardRequestDto
56
110
  * @param {string} [authorization] Bearer Token
57
111
  * @param {*} [options] Override http request option.
112
+ * @deprecated
58
113
  * @throws {RequiredError}
59
114
  */
60
- createDashboard: async (createDashboardRequestDto: CreateDashboardRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
115
+ createDashboardLegacy: async (createDashboardRequestDto: CreateDashboardRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
61
116
  // verify required parameter 'createDashboardRequestDto' is not null or undefined
62
- assertParamExists('createDashboard', 'createDashboardRequestDto', createDashboardRequestDto)
63
- const localVarPath = `/tenantservice/v1/dashboards`;
117
+ assertParamExists('createDashboardLegacy', 'createDashboardRequestDto', createDashboardRequestDto)
118
+ const localVarPath = `/tenantservice/v1/dashboards/legacy`;
64
119
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
65
120
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
66
121
  let baseOptions;
@@ -97,7 +152,8 @@ export const DashboardApiAxiosParamCreator = function (configuration?: Configura
97
152
  };
98
153
  },
99
154
  /**
100
- * undefined **Required Permissions** \"reporting.dashboards.delete\"
155
+ * Permanently removes a dashboard and all associated data by dashboard code. **Required Permissions** \"reporting.dashboards.delete\"
156
+ * @summary Deletes an existing dashboard
101
157
  * @param {string} code
102
158
  * @param {string} [authorization] Bearer Token
103
159
  * @param {*} [options] Override http request option.
@@ -141,7 +197,53 @@ export const DashboardApiAxiosParamCreator = function (configuration?: Configura
141
197
  };
142
198
  },
143
199
  /**
144
- * undefined **Required Permissions** \"reporting.dashboards.update\"
200
+ * Creates a copy of the specified dashboard with all its configurations and settings. **Required Permissions** \"reporting.dashboards.create\"
201
+ * @summary Creates a duplicate of an existing dashboard
202
+ * @param {string} code
203
+ * @param {string} [authorization] Bearer Token
204
+ * @param {*} [options] Override http request option.
205
+ * @throws {RequiredError}
206
+ */
207
+ duplicateDashboard: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
208
+ // verify required parameter 'code' is not null or undefined
209
+ assertParamExists('duplicateDashboard', 'code', code)
210
+ const localVarPath = `/tenantservice/v1/dashboards/{code}/duplicate`
211
+ .replace(`{${"code"}}`, encodeURIComponent(String(code)));
212
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
213
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
214
+ let baseOptions;
215
+ let baseAccessToken;
216
+ if (configuration) {
217
+ baseOptions = configuration.baseOptions;
218
+ baseAccessToken = configuration.accessToken;
219
+ }
220
+
221
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
222
+ const localVarHeaderParameter = {} as any;
223
+ const localVarQueryParameter = {} as any;
224
+
225
+ // authentication bearer required
226
+ // http bearer authentication required
227
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
228
+
229
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
230
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
231
+ }
232
+
233
+
234
+
235
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
236
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
237
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
238
+
239
+ return {
240
+ url: toPathString(localVarUrlObj),
241
+ options: localVarRequestOptions,
242
+ };
243
+ },
244
+ /**
245
+ * Creates a secure embedded URL that allows dashboard analysis and editing within external applications. **Required Permissions** \"reporting.dashboards.update\"
246
+ * @summary Generates an embedded URL for dashboard editing
145
247
  * @param {string} providerDashboardId
146
248
  * @param {string} [authorization] Bearer Token
147
249
  * @param {*} [options] Override http request option.
@@ -185,7 +287,8 @@ export const DashboardApiAxiosParamCreator = function (configuration?: Configura
185
287
  };
186
288
  },
187
289
  /**
188
- * undefined **Required Permissions** \"reporting.dashboards.view\"
290
+ * Fetches dashboard details by code including configuration and metadata. **Required Permissions** \"reporting.dashboards.view\"
291
+ * @summary Retrieves a specific dashboard
189
292
  * @param {string} code
190
293
  * @param {string} [authorization] Bearer Token
191
294
  * @param {*} [options] Override http request option.
@@ -229,7 +332,8 @@ export const DashboardApiAxiosParamCreator = function (configuration?: Configura
229
332
  };
230
333
  },
231
334
  /**
232
- * undefined **Required Permissions** \"reporting.dashboards.view\"
335
+ * Creates a secure embedded URL that allows dashboard content to be displayed within external applications. **Required Permissions** \"reporting.dashboards.view\"
336
+ * @summary Generates an embedded URL for dashboard viewing
233
337
  * @param {string} providerDashboardId
234
338
  * @param {string} [authorization] Bearer Token
235
339
  * @param {*} [options] Override http request option.
@@ -273,7 +377,8 @@ export const DashboardApiAxiosParamCreator = function (configuration?: Configura
273
377
  };
274
378
  },
275
379
  /**
276
- * undefined **Required Permissions** \"reporting.dashboards.view\"
380
+ * Fetches a paginated list of dashboards with optional filtering and sorting capabilities. **Required Permissions** \"reporting.dashboards.view\"
381
+ * @summary Retrieves a list of dashboards
277
382
  * @param {string} [authorization] Bearer Token
278
383
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
279
384
  * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
@@ -348,7 +453,8 @@ export const DashboardApiAxiosParamCreator = function (configuration?: Configura
348
453
  };
349
454
  },
350
455
  /**
351
- * undefined **Required Permissions** \"reporting.dashboards.update\"
456
+ * Makes a dashboard publicly available by publishing it from draft or analysis state. **Required Permissions** \"reporting.dashboards.update\"
457
+ * @summary Publishes a dashboard for general access
352
458
  * @param {PublishDashboardRequestDto} publishDashboardRequestDto
353
459
  * @param {string} [authorization] Bearer Token
354
460
  * @param {*} [options] Override http request option.
@@ -394,7 +500,8 @@ export const DashboardApiAxiosParamCreator = function (configuration?: Configura
394
500
  };
395
501
  },
396
502
  /**
397
- * undefined **Required Permissions** \"reporting.dashboards.update\"
503
+ * Rolls back dashboard analysis changes to restore the previous version or state. **Required Permissions** \"reporting.dashboards.update\"
504
+ * @summary Reverts dashboard analysis to previous state
398
505
  * @param {RevertAnalysisRequestDto} revertAnalysisRequestDto
399
506
  * @param {string} [authorization] Bearer Token
400
507
  * @param {*} [options] Override http request option.
@@ -440,7 +547,8 @@ export const DashboardApiAxiosParamCreator = function (configuration?: Configura
440
547
  };
441
548
  },
442
549
  /**
443
- * undefined **Required Permissions** \"reporting.dashboards.update\"
550
+ * Modifies dashboard properties, configuration, or metadata by dashboard code. **Required Permissions** \"reporting.dashboards.update\"
551
+ * @summary Updates an existing dashboard
444
552
  * @param {string} code
445
553
  * @param {UpdateDashboardRequestDto} updateDashboardRequestDto
446
554
  * @param {string} [authorization] Bearer Token
@@ -500,18 +608,33 @@ export const DashboardApiFp = function(configuration?: Configuration) {
500
608
  const localVarAxiosParamCreator = DashboardApiAxiosParamCreator(configuration)
501
609
  return {
502
610
  /**
503
- * undefined **Required Permissions** \"reporting.dashboards.create\"
611
+ * Creates a new dashboard using the preconfigured analysis id **Required Permissions** \"reporting.dashboards.create\"
612
+ * @summary Creates a new dashboard
613
+ * @param {CreateDashboardV2RequestDto} createDashboardV2RequestDto
614
+ * @param {string} [authorization] Bearer Token
615
+ * @param {*} [options] Override http request option.
616
+ * @throws {RequiredError}
617
+ */
618
+ async createDashboard(createDashboardV2RequestDto: CreateDashboardV2RequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateDashboardV2ResponseClass>> {
619
+ const localVarAxiosArgs = await localVarAxiosParamCreator.createDashboard(createDashboardV2RequestDto, authorization, options);
620
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
621
+ },
622
+ /**
623
+ * Creates a new dashboard from a preconfigured analysis id and dashboard id. Use POST /tenantservice/v1/dashboards instead. **Required Permissions** \"reporting.dashboards.create\"
624
+ * @summary Creates a new dashboard (DEPRECATED)
504
625
  * @param {CreateDashboardRequestDto} createDashboardRequestDto
505
626
  * @param {string} [authorization] Bearer Token
506
627
  * @param {*} [options] Override http request option.
628
+ * @deprecated
507
629
  * @throws {RequiredError}
508
630
  */
509
- async createDashboard(createDashboardRequestDto: CreateDashboardRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateDashboardResponseClass>> {
510
- const localVarAxiosArgs = await localVarAxiosParamCreator.createDashboard(createDashboardRequestDto, authorization, options);
631
+ async createDashboardLegacy(createDashboardRequestDto: CreateDashboardRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateDashboardResponseClass>> {
632
+ const localVarAxiosArgs = await localVarAxiosParamCreator.createDashboardLegacy(createDashboardRequestDto, authorization, options);
511
633
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
512
634
  },
513
635
  /**
514
- * undefined **Required Permissions** \"reporting.dashboards.delete\"
636
+ * Permanently removes a dashboard and all associated data by dashboard code. **Required Permissions** \"reporting.dashboards.delete\"
637
+ * @summary Deletes an existing dashboard
515
638
  * @param {string} code
516
639
  * @param {string} [authorization] Bearer Token
517
640
  * @param {*} [options] Override http request option.
@@ -522,7 +645,20 @@ export const DashboardApiFp = function(configuration?: Configuration) {
522
645
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
523
646
  },
524
647
  /**
525
- * undefined **Required Permissions** \"reporting.dashboards.update\"
648
+ * Creates a copy of the specified dashboard with all its configurations and settings. **Required Permissions** \"reporting.dashboards.create\"
649
+ * @summary Creates a duplicate of an existing dashboard
650
+ * @param {string} code
651
+ * @param {string} [authorization] Bearer Token
652
+ * @param {*} [options] Override http request option.
653
+ * @throws {RequiredError}
654
+ */
655
+ async duplicateDashboard(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DuplicateDashboardResponseClass>> {
656
+ const localVarAxiosArgs = await localVarAxiosParamCreator.duplicateDashboard(code, authorization, options);
657
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
658
+ },
659
+ /**
660
+ * Creates a secure embedded URL that allows dashboard analysis and editing within external applications. **Required Permissions** \"reporting.dashboards.update\"
661
+ * @summary Generates an embedded URL for dashboard editing
526
662
  * @param {string} providerDashboardId
527
663
  * @param {string} [authorization] Bearer Token
528
664
  * @param {*} [options] Override http request option.
@@ -533,7 +669,8 @@ export const DashboardApiFp = function(configuration?: Configuration) {
533
669
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
534
670
  },
535
671
  /**
536
- * undefined **Required Permissions** \"reporting.dashboards.view\"
672
+ * Fetches dashboard details by code including configuration and metadata. **Required Permissions** \"reporting.dashboards.view\"
673
+ * @summary Retrieves a specific dashboard
537
674
  * @param {string} code
538
675
  * @param {string} [authorization] Bearer Token
539
676
  * @param {*} [options] Override http request option.
@@ -544,7 +681,8 @@ export const DashboardApiFp = function(configuration?: Configuration) {
544
681
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
545
682
  },
546
683
  /**
547
- * undefined **Required Permissions** \"reporting.dashboards.view\"
684
+ * Creates a secure embedded URL that allows dashboard content to be displayed within external applications. **Required Permissions** \"reporting.dashboards.view\"
685
+ * @summary Generates an embedded URL for dashboard viewing
548
686
  * @param {string} providerDashboardId
549
687
  * @param {string} [authorization] Bearer Token
550
688
  * @param {*} [options] Override http request option.
@@ -555,7 +693,8 @@ export const DashboardApiFp = function(configuration?: Configuration) {
555
693
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
556
694
  },
557
695
  /**
558
- * undefined **Required Permissions** \"reporting.dashboards.view\"
696
+ * Fetches a paginated list of dashboards with optional filtering and sorting capabilities. **Required Permissions** \"reporting.dashboards.view\"
697
+ * @summary Retrieves a list of dashboards
559
698
  * @param {string} [authorization] Bearer Token
560
699
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
561
700
  * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
@@ -572,7 +711,8 @@ export const DashboardApiFp = function(configuration?: Configuration) {
572
711
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
573
712
  },
574
713
  /**
575
- * undefined **Required Permissions** \"reporting.dashboards.update\"
714
+ * Makes a dashboard publicly available by publishing it from draft or analysis state. **Required Permissions** \"reporting.dashboards.update\"
715
+ * @summary Publishes a dashboard for general access
576
716
  * @param {PublishDashboardRequestDto} publishDashboardRequestDto
577
717
  * @param {string} [authorization] Bearer Token
578
718
  * @param {*} [options] Override http request option.
@@ -583,7 +723,8 @@ export const DashboardApiFp = function(configuration?: Configuration) {
583
723
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
584
724
  },
585
725
  /**
586
- * undefined **Required Permissions** \"reporting.dashboards.update\"
726
+ * Rolls back dashboard analysis changes to restore the previous version or state. **Required Permissions** \"reporting.dashboards.update\"
727
+ * @summary Reverts dashboard analysis to previous state
587
728
  * @param {RevertAnalysisRequestDto} revertAnalysisRequestDto
588
729
  * @param {string} [authorization] Bearer Token
589
730
  * @param {*} [options] Override http request option.
@@ -594,7 +735,8 @@ export const DashboardApiFp = function(configuration?: Configuration) {
594
735
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
595
736
  },
596
737
  /**
597
- * undefined **Required Permissions** \"reporting.dashboards.update\"
738
+ * Modifies dashboard properties, configuration, or metadata by dashboard code. **Required Permissions** \"reporting.dashboards.update\"
739
+ * @summary Updates an existing dashboard
598
740
  * @param {string} code
599
741
  * @param {UpdateDashboardRequestDto} updateDashboardRequestDto
600
742
  * @param {string} [authorization] Bearer Token
@@ -616,17 +758,31 @@ export const DashboardApiFactory = function (configuration?: Configuration, base
616
758
  const localVarFp = DashboardApiFp(configuration)
617
759
  return {
618
760
  /**
619
- * undefined **Required Permissions** \"reporting.dashboards.create\"
761
+ * Creates a new dashboard using the preconfigured analysis id **Required Permissions** \"reporting.dashboards.create\"
762
+ * @summary Creates a new dashboard
763
+ * @param {CreateDashboardV2RequestDto} createDashboardV2RequestDto
764
+ * @param {string} [authorization] Bearer Token
765
+ * @param {*} [options] Override http request option.
766
+ * @throws {RequiredError}
767
+ */
768
+ createDashboard(createDashboardV2RequestDto: CreateDashboardV2RequestDto, authorization?: string, options?: any): AxiosPromise<CreateDashboardV2ResponseClass> {
769
+ return localVarFp.createDashboard(createDashboardV2RequestDto, authorization, options).then((request) => request(axios, basePath));
770
+ },
771
+ /**
772
+ * Creates a new dashboard from a preconfigured analysis id and dashboard id. Use POST /tenantservice/v1/dashboards instead. **Required Permissions** \"reporting.dashboards.create\"
773
+ * @summary Creates a new dashboard (DEPRECATED)
620
774
  * @param {CreateDashboardRequestDto} createDashboardRequestDto
621
775
  * @param {string} [authorization] Bearer Token
622
776
  * @param {*} [options] Override http request option.
777
+ * @deprecated
623
778
  * @throws {RequiredError}
624
779
  */
625
- createDashboard(createDashboardRequestDto: CreateDashboardRequestDto, authorization?: string, options?: any): AxiosPromise<CreateDashboardResponseClass> {
626
- return localVarFp.createDashboard(createDashboardRequestDto, authorization, options).then((request) => request(axios, basePath));
780
+ createDashboardLegacy(createDashboardRequestDto: CreateDashboardRequestDto, authorization?: string, options?: any): AxiosPromise<CreateDashboardResponseClass> {
781
+ return localVarFp.createDashboardLegacy(createDashboardRequestDto, authorization, options).then((request) => request(axios, basePath));
627
782
  },
628
783
  /**
629
- * undefined **Required Permissions** \"reporting.dashboards.delete\"
784
+ * Permanently removes a dashboard and all associated data by dashboard code. **Required Permissions** \"reporting.dashboards.delete\"
785
+ * @summary Deletes an existing dashboard
630
786
  * @param {string} code
631
787
  * @param {string} [authorization] Bearer Token
632
788
  * @param {*} [options] Override http request option.
@@ -636,7 +792,19 @@ export const DashboardApiFactory = function (configuration?: Configuration, base
636
792
  return localVarFp.deleteDashboard(code, authorization, options).then((request) => request(axios, basePath));
637
793
  },
638
794
  /**
639
- * undefined **Required Permissions** \"reporting.dashboards.update\"
795
+ * Creates a copy of the specified dashboard with all its configurations and settings. **Required Permissions** \"reporting.dashboards.create\"
796
+ * @summary Creates a duplicate of an existing dashboard
797
+ * @param {string} code
798
+ * @param {string} [authorization] Bearer Token
799
+ * @param {*} [options] Override http request option.
800
+ * @throws {RequiredError}
801
+ */
802
+ duplicateDashboard(code: string, authorization?: string, options?: any): AxiosPromise<DuplicateDashboardResponseClass> {
803
+ return localVarFp.duplicateDashboard(code, authorization, options).then((request) => request(axios, basePath));
804
+ },
805
+ /**
806
+ * Creates a secure embedded URL that allows dashboard analysis and editing within external applications. **Required Permissions** \"reporting.dashboards.update\"
807
+ * @summary Generates an embedded URL for dashboard editing
640
808
  * @param {string} providerDashboardId
641
809
  * @param {string} [authorization] Bearer Token
642
810
  * @param {*} [options] Override http request option.
@@ -646,7 +814,8 @@ export const DashboardApiFactory = function (configuration?: Configuration, base
646
814
  return localVarFp.getAnalysisEmbeddedUrl(providerDashboardId, authorization, options).then((request) => request(axios, basePath));
647
815
  },
648
816
  /**
649
- * undefined **Required Permissions** \"reporting.dashboards.view\"
817
+ * Fetches dashboard details by code including configuration and metadata. **Required Permissions** \"reporting.dashboards.view\"
818
+ * @summary Retrieves a specific dashboard
650
819
  * @param {string} code
651
820
  * @param {string} [authorization] Bearer Token
652
821
  * @param {*} [options] Override http request option.
@@ -656,7 +825,8 @@ export const DashboardApiFactory = function (configuration?: Configuration, base
656
825
  return localVarFp.getDashboard(code, authorization, options).then((request) => request(axios, basePath));
657
826
  },
658
827
  /**
659
- * undefined **Required Permissions** \"reporting.dashboards.view\"
828
+ * Creates a secure embedded URL that allows dashboard content to be displayed within external applications. **Required Permissions** \"reporting.dashboards.view\"
829
+ * @summary Generates an embedded URL for dashboard viewing
660
830
  * @param {string} providerDashboardId
661
831
  * @param {string} [authorization] Bearer Token
662
832
  * @param {*} [options] Override http request option.
@@ -666,7 +836,8 @@ export const DashboardApiFactory = function (configuration?: Configuration, base
666
836
  return localVarFp.getDashboardEmbeddedUrl(providerDashboardId, authorization, options).then((request) => request(axios, basePath));
667
837
  },
668
838
  /**
669
- * undefined **Required Permissions** \"reporting.dashboards.view\"
839
+ * Fetches a paginated list of dashboards with optional filtering and sorting capabilities. **Required Permissions** \"reporting.dashboards.view\"
840
+ * @summary Retrieves a list of dashboards
670
841
  * @param {string} [authorization] Bearer Token
671
842
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
672
843
  * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
@@ -682,7 +853,8 @@ export const DashboardApiFactory = function (configuration?: Configuration, base
682
853
  return localVarFp.listDashboards(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
683
854
  },
684
855
  /**
685
- * undefined **Required Permissions** \"reporting.dashboards.update\"
856
+ * Makes a dashboard publicly available by publishing it from draft or analysis state. **Required Permissions** \"reporting.dashboards.update\"
857
+ * @summary Publishes a dashboard for general access
686
858
  * @param {PublishDashboardRequestDto} publishDashboardRequestDto
687
859
  * @param {string} [authorization] Bearer Token
688
860
  * @param {*} [options] Override http request option.
@@ -692,7 +864,8 @@ export const DashboardApiFactory = function (configuration?: Configuration, base
692
864
  return localVarFp.publishDashboard(publishDashboardRequestDto, authorization, options).then((request) => request(axios, basePath));
693
865
  },
694
866
  /**
695
- * undefined **Required Permissions** \"reporting.dashboards.update\"
867
+ * Rolls back dashboard analysis changes to restore the previous version or state. **Required Permissions** \"reporting.dashboards.update\"
868
+ * @summary Reverts dashboard analysis to previous state
696
869
  * @param {RevertAnalysisRequestDto} revertAnalysisRequestDto
697
870
  * @param {string} [authorization] Bearer Token
698
871
  * @param {*} [options] Override http request option.
@@ -702,7 +875,8 @@ export const DashboardApiFactory = function (configuration?: Configuration, base
702
875
  return localVarFp.revertAnalysis(revertAnalysisRequestDto, authorization, options).then((request) => request(axios, basePath));
703
876
  },
704
877
  /**
705
- * undefined **Required Permissions** \"reporting.dashboards.update\"
878
+ * Modifies dashboard properties, configuration, or metadata by dashboard code. **Required Permissions** \"reporting.dashboards.update\"
879
+ * @summary Updates an existing dashboard
706
880
  * @param {string} code
707
881
  * @param {UpdateDashboardRequestDto} updateDashboardRequestDto
708
882
  * @param {string} [authorization] Bearer Token
@@ -723,10 +897,10 @@ export const DashboardApiFactory = function (configuration?: Configuration, base
723
897
  export interface DashboardApiCreateDashboardRequest {
724
898
  /**
725
899
  *
726
- * @type {CreateDashboardRequestDto}
900
+ * @type {CreateDashboardV2RequestDto}
727
901
  * @memberof DashboardApiCreateDashboard
728
902
  */
729
- readonly createDashboardRequestDto: CreateDashboardRequestDto
903
+ readonly createDashboardV2RequestDto: CreateDashboardV2RequestDto
730
904
 
731
905
  /**
732
906
  * Bearer Token
@@ -736,6 +910,27 @@ export interface DashboardApiCreateDashboardRequest {
736
910
  readonly authorization?: string
737
911
  }
738
912
 
913
+ /**
914
+ * Request parameters for createDashboardLegacy operation in DashboardApi.
915
+ * @export
916
+ * @interface DashboardApiCreateDashboardLegacyRequest
917
+ */
918
+ export interface DashboardApiCreateDashboardLegacyRequest {
919
+ /**
920
+ *
921
+ * @type {CreateDashboardRequestDto}
922
+ * @memberof DashboardApiCreateDashboardLegacy
923
+ */
924
+ readonly createDashboardRequestDto: CreateDashboardRequestDto
925
+
926
+ /**
927
+ * Bearer Token
928
+ * @type {string}
929
+ * @memberof DashboardApiCreateDashboardLegacy
930
+ */
931
+ readonly authorization?: string
932
+ }
933
+
739
934
  /**
740
935
  * Request parameters for deleteDashboard operation in DashboardApi.
741
936
  * @export
@@ -757,6 +952,27 @@ export interface DashboardApiDeleteDashboardRequest {
757
952
  readonly authorization?: string
758
953
  }
759
954
 
955
+ /**
956
+ * Request parameters for duplicateDashboard operation in DashboardApi.
957
+ * @export
958
+ * @interface DashboardApiDuplicateDashboardRequest
959
+ */
960
+ export interface DashboardApiDuplicateDashboardRequest {
961
+ /**
962
+ *
963
+ * @type {string}
964
+ * @memberof DashboardApiDuplicateDashboard
965
+ */
966
+ readonly code: string
967
+
968
+ /**
969
+ * Bearer Token
970
+ * @type {string}
971
+ * @memberof DashboardApiDuplicateDashboard
972
+ */
973
+ readonly authorization?: string
974
+ }
975
+
760
976
  /**
761
977
  * Request parameters for getAnalysisEmbeddedUrl operation in DashboardApi.
762
978
  * @export
@@ -961,18 +1177,33 @@ export interface DashboardApiUpdateDashboardRequest {
961
1177
  */
962
1178
  export class DashboardApi extends BaseAPI {
963
1179
  /**
964
- * undefined **Required Permissions** \"reporting.dashboards.create\"
1180
+ * Creates a new dashboard using the preconfigured analysis id **Required Permissions** \"reporting.dashboards.create\"
1181
+ * @summary Creates a new dashboard
965
1182
  * @param {DashboardApiCreateDashboardRequest} requestParameters Request parameters.
966
1183
  * @param {*} [options] Override http request option.
967
1184
  * @throws {RequiredError}
968
1185
  * @memberof DashboardApi
969
1186
  */
970
1187
  public createDashboard(requestParameters: DashboardApiCreateDashboardRequest, options?: AxiosRequestConfig) {
971
- return DashboardApiFp(this.configuration).createDashboard(requestParameters.createDashboardRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
1188
+ return DashboardApiFp(this.configuration).createDashboard(requestParameters.createDashboardV2RequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
1189
+ }
1190
+
1191
+ /**
1192
+ * Creates a new dashboard from a preconfigured analysis id and dashboard id. Use POST /tenantservice/v1/dashboards instead. **Required Permissions** \"reporting.dashboards.create\"
1193
+ * @summary Creates a new dashboard (DEPRECATED)
1194
+ * @param {DashboardApiCreateDashboardLegacyRequest} requestParameters Request parameters.
1195
+ * @param {*} [options] Override http request option.
1196
+ * @deprecated
1197
+ * @throws {RequiredError}
1198
+ * @memberof DashboardApi
1199
+ */
1200
+ public createDashboardLegacy(requestParameters: DashboardApiCreateDashboardLegacyRequest, options?: AxiosRequestConfig) {
1201
+ return DashboardApiFp(this.configuration).createDashboardLegacy(requestParameters.createDashboardRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
972
1202
  }
973
1203
 
974
1204
  /**
975
- * undefined **Required Permissions** \"reporting.dashboards.delete\"
1205
+ * Permanently removes a dashboard and all associated data by dashboard code. **Required Permissions** \"reporting.dashboards.delete\"
1206
+ * @summary Deletes an existing dashboard
976
1207
  * @param {DashboardApiDeleteDashboardRequest} requestParameters Request parameters.
977
1208
  * @param {*} [options] Override http request option.
978
1209
  * @throws {RequiredError}
@@ -983,7 +1214,20 @@ export class DashboardApi extends BaseAPI {
983
1214
  }
984
1215
 
985
1216
  /**
986
- * undefined **Required Permissions** \"reporting.dashboards.update\"
1217
+ * Creates a copy of the specified dashboard with all its configurations and settings. **Required Permissions** \"reporting.dashboards.create\"
1218
+ * @summary Creates a duplicate of an existing dashboard
1219
+ * @param {DashboardApiDuplicateDashboardRequest} requestParameters Request parameters.
1220
+ * @param {*} [options] Override http request option.
1221
+ * @throws {RequiredError}
1222
+ * @memberof DashboardApi
1223
+ */
1224
+ public duplicateDashboard(requestParameters: DashboardApiDuplicateDashboardRequest, options?: AxiosRequestConfig) {
1225
+ return DashboardApiFp(this.configuration).duplicateDashboard(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
1226
+ }
1227
+
1228
+ /**
1229
+ * Creates a secure embedded URL that allows dashboard analysis and editing within external applications. **Required Permissions** \"reporting.dashboards.update\"
1230
+ * @summary Generates an embedded URL for dashboard editing
987
1231
  * @param {DashboardApiGetAnalysisEmbeddedUrlRequest} requestParameters Request parameters.
988
1232
  * @param {*} [options] Override http request option.
989
1233
  * @throws {RequiredError}
@@ -994,7 +1238,8 @@ export class DashboardApi extends BaseAPI {
994
1238
  }
995
1239
 
996
1240
  /**
997
- * undefined **Required Permissions** \"reporting.dashboards.view\"
1241
+ * Fetches dashboard details by code including configuration and metadata. **Required Permissions** \"reporting.dashboards.view\"
1242
+ * @summary Retrieves a specific dashboard
998
1243
  * @param {DashboardApiGetDashboardRequest} requestParameters Request parameters.
999
1244
  * @param {*} [options] Override http request option.
1000
1245
  * @throws {RequiredError}
@@ -1005,7 +1250,8 @@ export class DashboardApi extends BaseAPI {
1005
1250
  }
1006
1251
 
1007
1252
  /**
1008
- * undefined **Required Permissions** \"reporting.dashboards.view\"
1253
+ * Creates a secure embedded URL that allows dashboard content to be displayed within external applications. **Required Permissions** \"reporting.dashboards.view\"
1254
+ * @summary Generates an embedded URL for dashboard viewing
1009
1255
  * @param {DashboardApiGetDashboardEmbeddedUrlRequest} requestParameters Request parameters.
1010
1256
  * @param {*} [options] Override http request option.
1011
1257
  * @throws {RequiredError}
@@ -1016,7 +1262,8 @@ export class DashboardApi extends BaseAPI {
1016
1262
  }
1017
1263
 
1018
1264
  /**
1019
- * undefined **Required Permissions** \"reporting.dashboards.view\"
1265
+ * Fetches a paginated list of dashboards with optional filtering and sorting capabilities. **Required Permissions** \"reporting.dashboards.view\"
1266
+ * @summary Retrieves a list of dashboards
1020
1267
  * @param {DashboardApiListDashboardsRequest} requestParameters Request parameters.
1021
1268
  * @param {*} [options] Override http request option.
1022
1269
  * @throws {RequiredError}
@@ -1027,7 +1274,8 @@ export class DashboardApi extends BaseAPI {
1027
1274
  }
1028
1275
 
1029
1276
  /**
1030
- * undefined **Required Permissions** \"reporting.dashboards.update\"
1277
+ * Makes a dashboard publicly available by publishing it from draft or analysis state. **Required Permissions** \"reporting.dashboards.update\"
1278
+ * @summary Publishes a dashboard for general access
1031
1279
  * @param {DashboardApiPublishDashboardRequest} requestParameters Request parameters.
1032
1280
  * @param {*} [options] Override http request option.
1033
1281
  * @throws {RequiredError}
@@ -1038,7 +1286,8 @@ export class DashboardApi extends BaseAPI {
1038
1286
  }
1039
1287
 
1040
1288
  /**
1041
- * undefined **Required Permissions** \"reporting.dashboards.update\"
1289
+ * Rolls back dashboard analysis changes to restore the previous version or state. **Required Permissions** \"reporting.dashboards.update\"
1290
+ * @summary Reverts dashboard analysis to previous state
1042
1291
  * @param {DashboardApiRevertAnalysisRequest} requestParameters Request parameters.
1043
1292
  * @param {*} [options] Override http request option.
1044
1293
  * @throws {RequiredError}
@@ -1049,7 +1298,8 @@ export class DashboardApi extends BaseAPI {
1049
1298
  }
1050
1299
 
1051
1300
  /**
1052
- * undefined **Required Permissions** \"reporting.dashboards.update\"
1301
+ * Modifies dashboard properties, configuration, or metadata by dashboard code. **Required Permissions** \"reporting.dashboards.update\"
1302
+ * @summary Updates an existing dashboard
1053
1303
  * @param {DashboardApiUpdateDashboardRequest} requestParameters Request parameters.
1054
1304
  * @param {*} [options] Override http request option.
1055
1305
  * @throws {RequiredError}