@emilgroup/tenant-sdk 1.31.1-beta.1 → 1.31.1-beta.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +2 -0
- package/README.md +2 -2
- package/api/dashboard-api.ts +193 -46
- package/dist/api/dashboard-api.d.ts +139 -42
- package/dist/api/dashboard-api.js +177 -44
- package/dist/models/create-dashboard-v2-request-dto.d.ts +36 -0
- package/dist/models/create-dashboard-v2-request-dto.js +15 -0
- package/dist/models/create-dashboard-v2-response-class.d.ts +25 -0
- package/dist/models/create-dashboard-v2-response-class.js +15 -0
- package/dist/models/index.d.ts +2 -0
- package/dist/models/index.js +2 -0
- package/models/create-dashboard-v2-request-dto.ts +42 -0
- package/models/create-dashboard-v2-response-class.ts +31 -0
- package/models/index.ts +2 -0
- package/package.json +1 -1
package/.openapi-generator/FILES
CHANGED
|
@@ -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
|
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@1.31.1-beta.
|
|
20
|
+
npm install @emilgroup/tenant-sdk@1.31.1-beta.2 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/tenant-sdk@1.31.1-beta.
|
|
24
|
+
yarn add @emilgroup/tenant-sdk@1.31.1-beta.2
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import `UsersApi`.
|
package/api/dashboard-api.ts
CHANGED
|
@@ -25,6 +25,10 @@ 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
|
|
30
34
|
import { GetDashboardResponseClass } from '../models';
|
|
@@ -47,16 +51,65 @@ import { UpdateDashboardResponseClass } from '../models';
|
|
|
47
51
|
export const DashboardApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
48
52
|
return {
|
|
49
53
|
/**
|
|
50
|
-
*
|
|
54
|
+
* Creates a new dashboard using the preconfigured analysis id **Required Permissions** \"reporting.dashboards.create\"
|
|
55
|
+
* @summary Creates a new dashboard
|
|
56
|
+
* @param {CreateDashboardV2RequestDto} createDashboardV2RequestDto
|
|
57
|
+
* @param {string} [authorization] Bearer Token
|
|
58
|
+
* @param {*} [options] Override http request option.
|
|
59
|
+
* @throws {RequiredError}
|
|
60
|
+
*/
|
|
61
|
+
createDashboard: async (createDashboardV2RequestDto: CreateDashboardV2RequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
62
|
+
// verify required parameter 'createDashboardV2RequestDto' is not null or undefined
|
|
63
|
+
assertParamExists('createDashboard', 'createDashboardV2RequestDto', createDashboardV2RequestDto)
|
|
64
|
+
const localVarPath = `/tenantservice/v1/dashboards`;
|
|
65
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
66
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
67
|
+
let baseOptions;
|
|
68
|
+
let baseAccessToken;
|
|
69
|
+
if (configuration) {
|
|
70
|
+
baseOptions = configuration.baseOptions;
|
|
71
|
+
baseAccessToken = configuration.accessToken;
|
|
72
|
+
}
|
|
73
|
+
|
|
74
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
75
|
+
const localVarHeaderParameter = {} as any;
|
|
76
|
+
const localVarQueryParameter = {} as any;
|
|
77
|
+
|
|
78
|
+
// authentication bearer required
|
|
79
|
+
// http bearer authentication required
|
|
80
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
81
|
+
|
|
82
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
83
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
84
|
+
}
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
89
|
+
|
|
90
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
91
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
92
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
93
|
+
localVarRequestOptions.data = serializeDataIfNeeded(createDashboardV2RequestDto, localVarRequestOptions, configuration)
|
|
94
|
+
|
|
95
|
+
return {
|
|
96
|
+
url: toPathString(localVarUrlObj),
|
|
97
|
+
options: localVarRequestOptions,
|
|
98
|
+
};
|
|
99
|
+
},
|
|
100
|
+
/**
|
|
101
|
+
* Creates a new dashboard from a preconfigured analysis id and dashboard id. Use POST /tenantservice/v1/dashboards instead. **Required Permissions** \"reporting.dashboards.create\"
|
|
102
|
+
* @summary Creates a new dashboard (DEPRECATED)
|
|
51
103
|
* @param {CreateDashboardRequestDto} createDashboardRequestDto
|
|
52
104
|
* @param {string} [authorization] Bearer Token
|
|
53
105
|
* @param {*} [options] Override http request option.
|
|
106
|
+
* @deprecated
|
|
54
107
|
* @throws {RequiredError}
|
|
55
108
|
*/
|
|
56
|
-
|
|
109
|
+
createDashboardLegacy: async (createDashboardRequestDto: CreateDashboardRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
57
110
|
// verify required parameter 'createDashboardRequestDto' is not null or undefined
|
|
58
|
-
assertParamExists('
|
|
59
|
-
const localVarPath = `/tenantservice/v1/dashboards`;
|
|
111
|
+
assertParamExists('createDashboardLegacy', 'createDashboardRequestDto', createDashboardRequestDto)
|
|
112
|
+
const localVarPath = `/tenantservice/v1/dashboards/legacy`;
|
|
60
113
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
61
114
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
62
115
|
let baseOptions;
|
|
@@ -93,7 +146,8 @@ export const DashboardApiAxiosParamCreator = function (configuration?: Configura
|
|
|
93
146
|
};
|
|
94
147
|
},
|
|
95
148
|
/**
|
|
96
|
-
*
|
|
149
|
+
* Permanently removes a dashboard and all associated data by dashboard code. **Required Permissions** \"reporting.dashboards.delete\"
|
|
150
|
+
* @summary Deletes an existing dashboard
|
|
97
151
|
* @param {string} code
|
|
98
152
|
* @param {string} [authorization] Bearer Token
|
|
99
153
|
* @param {*} [options] Override http request option.
|
|
@@ -137,7 +191,8 @@ export const DashboardApiAxiosParamCreator = function (configuration?: Configura
|
|
|
137
191
|
};
|
|
138
192
|
},
|
|
139
193
|
/**
|
|
140
|
-
*
|
|
194
|
+
* Creates a secure embedded URL that allows dashboard analysis and editing within external applications. **Required Permissions** \"reporting.dashboards.update\"
|
|
195
|
+
* @summary Generates an embedded URL for dashboard editing
|
|
141
196
|
* @param {string} providerDashboardId
|
|
142
197
|
* @param {string} [authorization] Bearer Token
|
|
143
198
|
* @param {*} [options] Override http request option.
|
|
@@ -181,7 +236,8 @@ export const DashboardApiAxiosParamCreator = function (configuration?: Configura
|
|
|
181
236
|
};
|
|
182
237
|
},
|
|
183
238
|
/**
|
|
184
|
-
*
|
|
239
|
+
* Fetches dashboard details by code including configuration and metadata. **Required Permissions** \"reporting.dashboards.view\"
|
|
240
|
+
* @summary Retrieves a specific dashboard
|
|
185
241
|
* @param {string} code
|
|
186
242
|
* @param {string} [authorization] Bearer Token
|
|
187
243
|
* @param {*} [options] Override http request option.
|
|
@@ -225,7 +281,8 @@ export const DashboardApiAxiosParamCreator = function (configuration?: Configura
|
|
|
225
281
|
};
|
|
226
282
|
},
|
|
227
283
|
/**
|
|
228
|
-
*
|
|
284
|
+
* Creates a secure embedded URL that allows dashboard content to be displayed within external applications. **Required Permissions** \"reporting.dashboards.view\"
|
|
285
|
+
* @summary Generates an embedded URL for dashboard viewing
|
|
229
286
|
* @param {string} providerDashboardId
|
|
230
287
|
* @param {string} [authorization] Bearer Token
|
|
231
288
|
* @param {*} [options] Override http request option.
|
|
@@ -269,7 +326,8 @@ export const DashboardApiAxiosParamCreator = function (configuration?: Configura
|
|
|
269
326
|
};
|
|
270
327
|
},
|
|
271
328
|
/**
|
|
272
|
-
*
|
|
329
|
+
* Fetches a paginated list of dashboards with optional filtering and sorting capabilities. **Required Permissions** \"reporting.dashboards.view\"
|
|
330
|
+
* @summary Retrieves a list of dashboards
|
|
273
331
|
* @param {string} [authorization] Bearer Token
|
|
274
332
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
275
333
|
* @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.
|
|
@@ -344,7 +402,8 @@ export const DashboardApiAxiosParamCreator = function (configuration?: Configura
|
|
|
344
402
|
};
|
|
345
403
|
},
|
|
346
404
|
/**
|
|
347
|
-
*
|
|
405
|
+
* Makes a dashboard publicly available by publishing it from draft or analysis state. **Required Permissions** \"reporting.dashboards.update\"
|
|
406
|
+
* @summary Publishes a dashboard for general access
|
|
348
407
|
* @param {PublishDashboardRequestDto} publishDashboardRequestDto
|
|
349
408
|
* @param {string} [authorization] Bearer Token
|
|
350
409
|
* @param {*} [options] Override http request option.
|
|
@@ -390,7 +449,8 @@ export const DashboardApiAxiosParamCreator = function (configuration?: Configura
|
|
|
390
449
|
};
|
|
391
450
|
},
|
|
392
451
|
/**
|
|
393
|
-
*
|
|
452
|
+
* Rolls back dashboard analysis changes to restore the previous version or state. **Required Permissions** \"reporting.dashboards.update\"
|
|
453
|
+
* @summary Reverts dashboard analysis to previous state
|
|
394
454
|
* @param {RevertAnalysisRequestDto} revertAnalysisRequestDto
|
|
395
455
|
* @param {string} [authorization] Bearer Token
|
|
396
456
|
* @param {*} [options] Override http request option.
|
|
@@ -436,7 +496,8 @@ export const DashboardApiAxiosParamCreator = function (configuration?: Configura
|
|
|
436
496
|
};
|
|
437
497
|
},
|
|
438
498
|
/**
|
|
439
|
-
*
|
|
499
|
+
* Modifies dashboard properties, configuration, or metadata by dashboard code. **Required Permissions** \"reporting.dashboards.update\"
|
|
500
|
+
* @summary Updates an existing dashboard
|
|
440
501
|
* @param {string} code
|
|
441
502
|
* @param {UpdateDashboardRequestDto} updateDashboardRequestDto
|
|
442
503
|
* @param {string} [authorization] Bearer Token
|
|
@@ -496,18 +557,33 @@ export const DashboardApiFp = function(configuration?: Configuration) {
|
|
|
496
557
|
const localVarAxiosParamCreator = DashboardApiAxiosParamCreator(configuration)
|
|
497
558
|
return {
|
|
498
559
|
/**
|
|
499
|
-
*
|
|
560
|
+
* Creates a new dashboard using the preconfigured analysis id **Required Permissions** \"reporting.dashboards.create\"
|
|
561
|
+
* @summary Creates a new dashboard
|
|
562
|
+
* @param {CreateDashboardV2RequestDto} createDashboardV2RequestDto
|
|
563
|
+
* @param {string} [authorization] Bearer Token
|
|
564
|
+
* @param {*} [options] Override http request option.
|
|
565
|
+
* @throws {RequiredError}
|
|
566
|
+
*/
|
|
567
|
+
async createDashboard(createDashboardV2RequestDto: CreateDashboardV2RequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateDashboardV2ResponseClass>> {
|
|
568
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createDashboard(createDashboardV2RequestDto, authorization, options);
|
|
569
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
570
|
+
},
|
|
571
|
+
/**
|
|
572
|
+
* Creates a new dashboard from a preconfigured analysis id and dashboard id. Use POST /tenantservice/v1/dashboards instead. **Required Permissions** \"reporting.dashboards.create\"
|
|
573
|
+
* @summary Creates a new dashboard (DEPRECATED)
|
|
500
574
|
* @param {CreateDashboardRequestDto} createDashboardRequestDto
|
|
501
575
|
* @param {string} [authorization] Bearer Token
|
|
502
576
|
* @param {*} [options] Override http request option.
|
|
577
|
+
* @deprecated
|
|
503
578
|
* @throws {RequiredError}
|
|
504
579
|
*/
|
|
505
|
-
async
|
|
506
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
580
|
+
async createDashboardLegacy(createDashboardRequestDto: CreateDashboardRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateDashboardResponseClass>> {
|
|
581
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createDashboardLegacy(createDashboardRequestDto, authorization, options);
|
|
507
582
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
508
583
|
},
|
|
509
584
|
/**
|
|
510
|
-
*
|
|
585
|
+
* Permanently removes a dashboard and all associated data by dashboard code. **Required Permissions** \"reporting.dashboards.delete\"
|
|
586
|
+
* @summary Deletes an existing dashboard
|
|
511
587
|
* @param {string} code
|
|
512
588
|
* @param {string} [authorization] Bearer Token
|
|
513
589
|
* @param {*} [options] Override http request option.
|
|
@@ -518,7 +594,8 @@ export const DashboardApiFp = function(configuration?: Configuration) {
|
|
|
518
594
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
519
595
|
},
|
|
520
596
|
/**
|
|
521
|
-
*
|
|
597
|
+
* Creates a secure embedded URL that allows dashboard analysis and editing within external applications. **Required Permissions** \"reporting.dashboards.update\"
|
|
598
|
+
* @summary Generates an embedded URL for dashboard editing
|
|
522
599
|
* @param {string} providerDashboardId
|
|
523
600
|
* @param {string} [authorization] Bearer Token
|
|
524
601
|
* @param {*} [options] Override http request option.
|
|
@@ -529,7 +606,8 @@ export const DashboardApiFp = function(configuration?: Configuration) {
|
|
|
529
606
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
530
607
|
},
|
|
531
608
|
/**
|
|
532
|
-
*
|
|
609
|
+
* Fetches dashboard details by code including configuration and metadata. **Required Permissions** \"reporting.dashboards.view\"
|
|
610
|
+
* @summary Retrieves a specific dashboard
|
|
533
611
|
* @param {string} code
|
|
534
612
|
* @param {string} [authorization] Bearer Token
|
|
535
613
|
* @param {*} [options] Override http request option.
|
|
@@ -540,7 +618,8 @@ export const DashboardApiFp = function(configuration?: Configuration) {
|
|
|
540
618
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
541
619
|
},
|
|
542
620
|
/**
|
|
543
|
-
*
|
|
621
|
+
* Creates a secure embedded URL that allows dashboard content to be displayed within external applications. **Required Permissions** \"reporting.dashboards.view\"
|
|
622
|
+
* @summary Generates an embedded URL for dashboard viewing
|
|
544
623
|
* @param {string} providerDashboardId
|
|
545
624
|
* @param {string} [authorization] Bearer Token
|
|
546
625
|
* @param {*} [options] Override http request option.
|
|
@@ -551,7 +630,8 @@ export const DashboardApiFp = function(configuration?: Configuration) {
|
|
|
551
630
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
552
631
|
},
|
|
553
632
|
/**
|
|
554
|
-
*
|
|
633
|
+
* Fetches a paginated list of dashboards with optional filtering and sorting capabilities. **Required Permissions** \"reporting.dashboards.view\"
|
|
634
|
+
* @summary Retrieves a list of dashboards
|
|
555
635
|
* @param {string} [authorization] Bearer Token
|
|
556
636
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
557
637
|
* @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.
|
|
@@ -568,7 +648,8 @@ export const DashboardApiFp = function(configuration?: Configuration) {
|
|
|
568
648
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
569
649
|
},
|
|
570
650
|
/**
|
|
571
|
-
*
|
|
651
|
+
* Makes a dashboard publicly available by publishing it from draft or analysis state. **Required Permissions** \"reporting.dashboards.update\"
|
|
652
|
+
* @summary Publishes a dashboard for general access
|
|
572
653
|
* @param {PublishDashboardRequestDto} publishDashboardRequestDto
|
|
573
654
|
* @param {string} [authorization] Bearer Token
|
|
574
655
|
* @param {*} [options] Override http request option.
|
|
@@ -579,7 +660,8 @@ export const DashboardApiFp = function(configuration?: Configuration) {
|
|
|
579
660
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
580
661
|
},
|
|
581
662
|
/**
|
|
582
|
-
*
|
|
663
|
+
* Rolls back dashboard analysis changes to restore the previous version or state. **Required Permissions** \"reporting.dashboards.update\"
|
|
664
|
+
* @summary Reverts dashboard analysis to previous state
|
|
583
665
|
* @param {RevertAnalysisRequestDto} revertAnalysisRequestDto
|
|
584
666
|
* @param {string} [authorization] Bearer Token
|
|
585
667
|
* @param {*} [options] Override http request option.
|
|
@@ -590,7 +672,8 @@ export const DashboardApiFp = function(configuration?: Configuration) {
|
|
|
590
672
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
591
673
|
},
|
|
592
674
|
/**
|
|
593
|
-
*
|
|
675
|
+
* Modifies dashboard properties, configuration, or metadata by dashboard code. **Required Permissions** \"reporting.dashboards.update\"
|
|
676
|
+
* @summary Updates an existing dashboard
|
|
594
677
|
* @param {string} code
|
|
595
678
|
* @param {UpdateDashboardRequestDto} updateDashboardRequestDto
|
|
596
679
|
* @param {string} [authorization] Bearer Token
|
|
@@ -612,17 +695,31 @@ export const DashboardApiFactory = function (configuration?: Configuration, base
|
|
|
612
695
|
const localVarFp = DashboardApiFp(configuration)
|
|
613
696
|
return {
|
|
614
697
|
/**
|
|
615
|
-
*
|
|
698
|
+
* Creates a new dashboard using the preconfigured analysis id **Required Permissions** \"reporting.dashboards.create\"
|
|
699
|
+
* @summary Creates a new dashboard
|
|
700
|
+
* @param {CreateDashboardV2RequestDto} createDashboardV2RequestDto
|
|
701
|
+
* @param {string} [authorization] Bearer Token
|
|
702
|
+
* @param {*} [options] Override http request option.
|
|
703
|
+
* @throws {RequiredError}
|
|
704
|
+
*/
|
|
705
|
+
createDashboard(createDashboardV2RequestDto: CreateDashboardV2RequestDto, authorization?: string, options?: any): AxiosPromise<CreateDashboardV2ResponseClass> {
|
|
706
|
+
return localVarFp.createDashboard(createDashboardV2RequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
707
|
+
},
|
|
708
|
+
/**
|
|
709
|
+
* Creates a new dashboard from a preconfigured analysis id and dashboard id. Use POST /tenantservice/v1/dashboards instead. **Required Permissions** \"reporting.dashboards.create\"
|
|
710
|
+
* @summary Creates a new dashboard (DEPRECATED)
|
|
616
711
|
* @param {CreateDashboardRequestDto} createDashboardRequestDto
|
|
617
712
|
* @param {string} [authorization] Bearer Token
|
|
618
713
|
* @param {*} [options] Override http request option.
|
|
714
|
+
* @deprecated
|
|
619
715
|
* @throws {RequiredError}
|
|
620
716
|
*/
|
|
621
|
-
|
|
622
|
-
return localVarFp.
|
|
717
|
+
createDashboardLegacy(createDashboardRequestDto: CreateDashboardRequestDto, authorization?: string, options?: any): AxiosPromise<CreateDashboardResponseClass> {
|
|
718
|
+
return localVarFp.createDashboardLegacy(createDashboardRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
623
719
|
},
|
|
624
720
|
/**
|
|
625
|
-
*
|
|
721
|
+
* Permanently removes a dashboard and all associated data by dashboard code. **Required Permissions** \"reporting.dashboards.delete\"
|
|
722
|
+
* @summary Deletes an existing dashboard
|
|
626
723
|
* @param {string} code
|
|
627
724
|
* @param {string} [authorization] Bearer Token
|
|
628
725
|
* @param {*} [options] Override http request option.
|
|
@@ -632,7 +729,8 @@ export const DashboardApiFactory = function (configuration?: Configuration, base
|
|
|
632
729
|
return localVarFp.deleteDashboard(code, authorization, options).then((request) => request(axios, basePath));
|
|
633
730
|
},
|
|
634
731
|
/**
|
|
635
|
-
*
|
|
732
|
+
* Creates a secure embedded URL that allows dashboard analysis and editing within external applications. **Required Permissions** \"reporting.dashboards.update\"
|
|
733
|
+
* @summary Generates an embedded URL for dashboard editing
|
|
636
734
|
* @param {string} providerDashboardId
|
|
637
735
|
* @param {string} [authorization] Bearer Token
|
|
638
736
|
* @param {*} [options] Override http request option.
|
|
@@ -642,7 +740,8 @@ export const DashboardApiFactory = function (configuration?: Configuration, base
|
|
|
642
740
|
return localVarFp.getAnalysisEmbeddedUrl(providerDashboardId, authorization, options).then((request) => request(axios, basePath));
|
|
643
741
|
},
|
|
644
742
|
/**
|
|
645
|
-
*
|
|
743
|
+
* Fetches dashboard details by code including configuration and metadata. **Required Permissions** \"reporting.dashboards.view\"
|
|
744
|
+
* @summary Retrieves a specific dashboard
|
|
646
745
|
* @param {string} code
|
|
647
746
|
* @param {string} [authorization] Bearer Token
|
|
648
747
|
* @param {*} [options] Override http request option.
|
|
@@ -652,7 +751,8 @@ export const DashboardApiFactory = function (configuration?: Configuration, base
|
|
|
652
751
|
return localVarFp.getDashboard(code, authorization, options).then((request) => request(axios, basePath));
|
|
653
752
|
},
|
|
654
753
|
/**
|
|
655
|
-
*
|
|
754
|
+
* Creates a secure embedded URL that allows dashboard content to be displayed within external applications. **Required Permissions** \"reporting.dashboards.view\"
|
|
755
|
+
* @summary Generates an embedded URL for dashboard viewing
|
|
656
756
|
* @param {string} providerDashboardId
|
|
657
757
|
* @param {string} [authorization] Bearer Token
|
|
658
758
|
* @param {*} [options] Override http request option.
|
|
@@ -662,7 +762,8 @@ export const DashboardApiFactory = function (configuration?: Configuration, base
|
|
|
662
762
|
return localVarFp.getDashboardEmbeddedUrl(providerDashboardId, authorization, options).then((request) => request(axios, basePath));
|
|
663
763
|
},
|
|
664
764
|
/**
|
|
665
|
-
*
|
|
765
|
+
* Fetches a paginated list of dashboards with optional filtering and sorting capabilities. **Required Permissions** \"reporting.dashboards.view\"
|
|
766
|
+
* @summary Retrieves a list of dashboards
|
|
666
767
|
* @param {string} [authorization] Bearer Token
|
|
667
768
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
668
769
|
* @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.
|
|
@@ -678,7 +779,8 @@ export const DashboardApiFactory = function (configuration?: Configuration, base
|
|
|
678
779
|
return localVarFp.listDashboards(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
679
780
|
},
|
|
680
781
|
/**
|
|
681
|
-
*
|
|
782
|
+
* Makes a dashboard publicly available by publishing it from draft or analysis state. **Required Permissions** \"reporting.dashboards.update\"
|
|
783
|
+
* @summary Publishes a dashboard for general access
|
|
682
784
|
* @param {PublishDashboardRequestDto} publishDashboardRequestDto
|
|
683
785
|
* @param {string} [authorization] Bearer Token
|
|
684
786
|
* @param {*} [options] Override http request option.
|
|
@@ -688,7 +790,8 @@ export const DashboardApiFactory = function (configuration?: Configuration, base
|
|
|
688
790
|
return localVarFp.publishDashboard(publishDashboardRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
689
791
|
},
|
|
690
792
|
/**
|
|
691
|
-
*
|
|
793
|
+
* Rolls back dashboard analysis changes to restore the previous version or state. **Required Permissions** \"reporting.dashboards.update\"
|
|
794
|
+
* @summary Reverts dashboard analysis to previous state
|
|
692
795
|
* @param {RevertAnalysisRequestDto} revertAnalysisRequestDto
|
|
693
796
|
* @param {string} [authorization] Bearer Token
|
|
694
797
|
* @param {*} [options] Override http request option.
|
|
@@ -698,7 +801,8 @@ export const DashboardApiFactory = function (configuration?: Configuration, base
|
|
|
698
801
|
return localVarFp.revertAnalysis(revertAnalysisRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
699
802
|
},
|
|
700
803
|
/**
|
|
701
|
-
*
|
|
804
|
+
* Modifies dashboard properties, configuration, or metadata by dashboard code. **Required Permissions** \"reporting.dashboards.update\"
|
|
805
|
+
* @summary Updates an existing dashboard
|
|
702
806
|
* @param {string} code
|
|
703
807
|
* @param {UpdateDashboardRequestDto} updateDashboardRequestDto
|
|
704
808
|
* @param {string} [authorization] Bearer Token
|
|
@@ -719,10 +823,10 @@ export const DashboardApiFactory = function (configuration?: Configuration, base
|
|
|
719
823
|
export interface DashboardApiCreateDashboardRequest {
|
|
720
824
|
/**
|
|
721
825
|
*
|
|
722
|
-
* @type {
|
|
826
|
+
* @type {CreateDashboardV2RequestDto}
|
|
723
827
|
* @memberof DashboardApiCreateDashboard
|
|
724
828
|
*/
|
|
725
|
-
readonly
|
|
829
|
+
readonly createDashboardV2RequestDto: CreateDashboardV2RequestDto
|
|
726
830
|
|
|
727
831
|
/**
|
|
728
832
|
* Bearer Token
|
|
@@ -732,6 +836,27 @@ export interface DashboardApiCreateDashboardRequest {
|
|
|
732
836
|
readonly authorization?: string
|
|
733
837
|
}
|
|
734
838
|
|
|
839
|
+
/**
|
|
840
|
+
* Request parameters for createDashboardLegacy operation in DashboardApi.
|
|
841
|
+
* @export
|
|
842
|
+
* @interface DashboardApiCreateDashboardLegacyRequest
|
|
843
|
+
*/
|
|
844
|
+
export interface DashboardApiCreateDashboardLegacyRequest {
|
|
845
|
+
/**
|
|
846
|
+
*
|
|
847
|
+
* @type {CreateDashboardRequestDto}
|
|
848
|
+
* @memberof DashboardApiCreateDashboardLegacy
|
|
849
|
+
*/
|
|
850
|
+
readonly createDashboardRequestDto: CreateDashboardRequestDto
|
|
851
|
+
|
|
852
|
+
/**
|
|
853
|
+
* Bearer Token
|
|
854
|
+
* @type {string}
|
|
855
|
+
* @memberof DashboardApiCreateDashboardLegacy
|
|
856
|
+
*/
|
|
857
|
+
readonly authorization?: string
|
|
858
|
+
}
|
|
859
|
+
|
|
735
860
|
/**
|
|
736
861
|
* Request parameters for deleteDashboard operation in DashboardApi.
|
|
737
862
|
* @export
|
|
@@ -957,18 +1082,33 @@ export interface DashboardApiUpdateDashboardRequest {
|
|
|
957
1082
|
*/
|
|
958
1083
|
export class DashboardApi extends BaseAPI {
|
|
959
1084
|
/**
|
|
960
|
-
*
|
|
1085
|
+
* Creates a new dashboard using the preconfigured analysis id **Required Permissions** \"reporting.dashboards.create\"
|
|
1086
|
+
* @summary Creates a new dashboard
|
|
961
1087
|
* @param {DashboardApiCreateDashboardRequest} requestParameters Request parameters.
|
|
962
1088
|
* @param {*} [options] Override http request option.
|
|
963
1089
|
* @throws {RequiredError}
|
|
964
1090
|
* @memberof DashboardApi
|
|
965
1091
|
*/
|
|
966
1092
|
public createDashboard(requestParameters: DashboardApiCreateDashboardRequest, options?: AxiosRequestConfig) {
|
|
967
|
-
return DashboardApiFp(this.configuration).createDashboard(requestParameters.
|
|
1093
|
+
return DashboardApiFp(this.configuration).createDashboard(requestParameters.createDashboardV2RequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
1094
|
+
}
|
|
1095
|
+
|
|
1096
|
+
/**
|
|
1097
|
+
* Creates a new dashboard from a preconfigured analysis id and dashboard id. Use POST /tenantservice/v1/dashboards instead. **Required Permissions** \"reporting.dashboards.create\"
|
|
1098
|
+
* @summary Creates a new dashboard (DEPRECATED)
|
|
1099
|
+
* @param {DashboardApiCreateDashboardLegacyRequest} requestParameters Request parameters.
|
|
1100
|
+
* @param {*} [options] Override http request option.
|
|
1101
|
+
* @deprecated
|
|
1102
|
+
* @throws {RequiredError}
|
|
1103
|
+
* @memberof DashboardApi
|
|
1104
|
+
*/
|
|
1105
|
+
public createDashboardLegacy(requestParameters: DashboardApiCreateDashboardLegacyRequest, options?: AxiosRequestConfig) {
|
|
1106
|
+
return DashboardApiFp(this.configuration).createDashboardLegacy(requestParameters.createDashboardRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
968
1107
|
}
|
|
969
1108
|
|
|
970
1109
|
/**
|
|
971
|
-
*
|
|
1110
|
+
* Permanently removes a dashboard and all associated data by dashboard code. **Required Permissions** \"reporting.dashboards.delete\"
|
|
1111
|
+
* @summary Deletes an existing dashboard
|
|
972
1112
|
* @param {DashboardApiDeleteDashboardRequest} requestParameters Request parameters.
|
|
973
1113
|
* @param {*} [options] Override http request option.
|
|
974
1114
|
* @throws {RequiredError}
|
|
@@ -979,7 +1119,8 @@ export class DashboardApi extends BaseAPI {
|
|
|
979
1119
|
}
|
|
980
1120
|
|
|
981
1121
|
/**
|
|
982
|
-
*
|
|
1122
|
+
* Creates a secure embedded URL that allows dashboard analysis and editing within external applications. **Required Permissions** \"reporting.dashboards.update\"
|
|
1123
|
+
* @summary Generates an embedded URL for dashboard editing
|
|
983
1124
|
* @param {DashboardApiGetAnalysisEmbeddedUrlRequest} requestParameters Request parameters.
|
|
984
1125
|
* @param {*} [options] Override http request option.
|
|
985
1126
|
* @throws {RequiredError}
|
|
@@ -990,7 +1131,8 @@ export class DashboardApi extends BaseAPI {
|
|
|
990
1131
|
}
|
|
991
1132
|
|
|
992
1133
|
/**
|
|
993
|
-
*
|
|
1134
|
+
* Fetches dashboard details by code including configuration and metadata. **Required Permissions** \"reporting.dashboards.view\"
|
|
1135
|
+
* @summary Retrieves a specific dashboard
|
|
994
1136
|
* @param {DashboardApiGetDashboardRequest} requestParameters Request parameters.
|
|
995
1137
|
* @param {*} [options] Override http request option.
|
|
996
1138
|
* @throws {RequiredError}
|
|
@@ -1001,7 +1143,8 @@ export class DashboardApi extends BaseAPI {
|
|
|
1001
1143
|
}
|
|
1002
1144
|
|
|
1003
1145
|
/**
|
|
1004
|
-
*
|
|
1146
|
+
* Creates a secure embedded URL that allows dashboard content to be displayed within external applications. **Required Permissions** \"reporting.dashboards.view\"
|
|
1147
|
+
* @summary Generates an embedded URL for dashboard viewing
|
|
1005
1148
|
* @param {DashboardApiGetDashboardEmbeddedUrlRequest} requestParameters Request parameters.
|
|
1006
1149
|
* @param {*} [options] Override http request option.
|
|
1007
1150
|
* @throws {RequiredError}
|
|
@@ -1012,7 +1155,8 @@ export class DashboardApi extends BaseAPI {
|
|
|
1012
1155
|
}
|
|
1013
1156
|
|
|
1014
1157
|
/**
|
|
1015
|
-
*
|
|
1158
|
+
* Fetches a paginated list of dashboards with optional filtering and sorting capabilities. **Required Permissions** \"reporting.dashboards.view\"
|
|
1159
|
+
* @summary Retrieves a list of dashboards
|
|
1016
1160
|
* @param {DashboardApiListDashboardsRequest} requestParameters Request parameters.
|
|
1017
1161
|
* @param {*} [options] Override http request option.
|
|
1018
1162
|
* @throws {RequiredError}
|
|
@@ -1023,7 +1167,8 @@ export class DashboardApi extends BaseAPI {
|
|
|
1023
1167
|
}
|
|
1024
1168
|
|
|
1025
1169
|
/**
|
|
1026
|
-
*
|
|
1170
|
+
* Makes a dashboard publicly available by publishing it from draft or analysis state. **Required Permissions** \"reporting.dashboards.update\"
|
|
1171
|
+
* @summary Publishes a dashboard for general access
|
|
1027
1172
|
* @param {DashboardApiPublishDashboardRequest} requestParameters Request parameters.
|
|
1028
1173
|
* @param {*} [options] Override http request option.
|
|
1029
1174
|
* @throws {RequiredError}
|
|
@@ -1034,7 +1179,8 @@ export class DashboardApi extends BaseAPI {
|
|
|
1034
1179
|
}
|
|
1035
1180
|
|
|
1036
1181
|
/**
|
|
1037
|
-
*
|
|
1182
|
+
* Rolls back dashboard analysis changes to restore the previous version or state. **Required Permissions** \"reporting.dashboards.update\"
|
|
1183
|
+
* @summary Reverts dashboard analysis to previous state
|
|
1038
1184
|
* @param {DashboardApiRevertAnalysisRequest} requestParameters Request parameters.
|
|
1039
1185
|
* @param {*} [options] Override http request option.
|
|
1040
1186
|
* @throws {RequiredError}
|
|
@@ -1045,7 +1191,8 @@ export class DashboardApi extends BaseAPI {
|
|
|
1045
1191
|
}
|
|
1046
1192
|
|
|
1047
1193
|
/**
|
|
1048
|
-
*
|
|
1194
|
+
* Modifies dashboard properties, configuration, or metadata by dashboard code. **Required Permissions** \"reporting.dashboards.update\"
|
|
1195
|
+
* @summary Updates an existing dashboard
|
|
1049
1196
|
* @param {DashboardApiUpdateDashboardRequest} requestParameters Request parameters.
|
|
1050
1197
|
* @param {*} [options] Override http request option.
|
|
1051
1198
|
* @throws {RequiredError}
|