@emilgroup/tenant-sdk 1.32.1 → 1.32.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.
- package/.openapi-generator/FILES +3 -0
- package/README.md +2 -2
- package/api/dashboard-api.ts +296 -46
- package/dist/api/dashboard-api.d.ts +195 -42
- package/dist/api/dashboard-api.js +269 -44
- package/dist/models/create-dashboard-v2-request-dto.d.ts +36 -0
- package/dist/models/create-dashboard-v2-request-dto.js +15 -0
- package/dist/models/create-dashboard-v2-response-class.d.ts +25 -0
- package/dist/models/create-dashboard-v2-response-class.js +15 -0
- package/dist/models/create-organization-migration-request-dto.d.ts +6 -0
- package/dist/models/create-resources-migration-request-dto.d.ts +6 -0
- package/dist/models/duplicate-dashboard-response-class.d.ts +25 -0
- package/dist/models/duplicate-dashboard-response-class.js +15 -0
- package/dist/models/index.d.ts +3 -0
- package/dist/models/index.js +3 -0
- package/dist/models/revert-organization-migration-request-dto.d.ts +6 -0
- package/models/create-dashboard-v2-request-dto.ts +42 -0
- package/models/create-dashboard-v2-response-class.ts +31 -0
- package/models/create-organization-migration-request-dto.ts +6 -0
- package/models/create-resources-migration-request-dto.ts +6 -0
- package/models/duplicate-dashboard-response-class.ts +31 -0
- package/models/index.ts +3 -0
- package/models/revert-organization-migration-request-dto.ts +6 -0
- package/package.json +1 -1
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
|
|
@@ -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@1.32.
|
|
20
|
+
npm install @emilgroup/tenant-sdk@1.32.2-beta.0 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/tenant-sdk@1.32.
|
|
24
|
+
yarn add @emilgroup/tenant-sdk@1.32.2-beta.0
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import `UsersApi`.
|
package/api/dashboard-api.ts
CHANGED
|
@@ -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';
|
|
@@ -47,16 +53,65 @@ import { UpdateDashboardResponseClass } from '../models';
|
|
|
47
53
|
export const DashboardApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
48
54
|
return {
|
|
49
55
|
/**
|
|
50
|
-
*
|
|
56
|
+
* Creates a new dashboard using the preconfigured analysis id **Required Permissions** \"reporting.dashboards.create\"
|
|
57
|
+
* @summary Creates a new dashboard
|
|
58
|
+
* @param {CreateDashboardV2RequestDto} createDashboardV2RequestDto
|
|
59
|
+
* @param {string} [authorization] Bearer Token
|
|
60
|
+
* @param {*} [options] Override http request option.
|
|
61
|
+
* @throws {RequiredError}
|
|
62
|
+
*/
|
|
63
|
+
createDashboard: async (createDashboardV2RequestDto: CreateDashboardV2RequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
64
|
+
// verify required parameter 'createDashboardV2RequestDto' is not null or undefined
|
|
65
|
+
assertParamExists('createDashboard', 'createDashboardV2RequestDto', createDashboardV2RequestDto)
|
|
66
|
+
const localVarPath = `/tenantservice/v1/dashboards`;
|
|
67
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
68
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
69
|
+
let baseOptions;
|
|
70
|
+
let baseAccessToken;
|
|
71
|
+
if (configuration) {
|
|
72
|
+
baseOptions = configuration.baseOptions;
|
|
73
|
+
baseAccessToken = configuration.accessToken;
|
|
74
|
+
}
|
|
75
|
+
|
|
76
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
77
|
+
const localVarHeaderParameter = {} as any;
|
|
78
|
+
const localVarQueryParameter = {} as any;
|
|
79
|
+
|
|
80
|
+
// authentication bearer required
|
|
81
|
+
// http bearer authentication required
|
|
82
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
83
|
+
|
|
84
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
85
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
86
|
+
}
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
91
|
+
|
|
92
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
93
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
94
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
95
|
+
localVarRequestOptions.data = serializeDataIfNeeded(createDashboardV2RequestDto, localVarRequestOptions, configuration)
|
|
96
|
+
|
|
97
|
+
return {
|
|
98
|
+
url: toPathString(localVarUrlObj),
|
|
99
|
+
options: localVarRequestOptions,
|
|
100
|
+
};
|
|
101
|
+
},
|
|
102
|
+
/**
|
|
103
|
+
* Creates a new dashboard from a preconfigured analysis id and dashboard id. Use POST /tenantservice/v1/dashboards instead. **Required Permissions** \"reporting.dashboards.create\"
|
|
104
|
+
* @summary Creates a new dashboard (DEPRECATED)
|
|
51
105
|
* @param {CreateDashboardRequestDto} createDashboardRequestDto
|
|
52
106
|
* @param {string} [authorization] Bearer Token
|
|
53
107
|
* @param {*} [options] Override http request option.
|
|
108
|
+
* @deprecated
|
|
54
109
|
* @throws {RequiredError}
|
|
55
110
|
*/
|
|
56
|
-
|
|
111
|
+
createDashboardLegacy: async (createDashboardRequestDto: CreateDashboardRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
57
112
|
// verify required parameter 'createDashboardRequestDto' is not null or undefined
|
|
58
|
-
assertParamExists('
|
|
59
|
-
const localVarPath = `/tenantservice/v1/dashboards`;
|
|
113
|
+
assertParamExists('createDashboardLegacy', 'createDashboardRequestDto', createDashboardRequestDto)
|
|
114
|
+
const localVarPath = `/tenantservice/v1/dashboards/legacy`;
|
|
60
115
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
61
116
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
62
117
|
let baseOptions;
|
|
@@ -93,7 +148,8 @@ export const DashboardApiAxiosParamCreator = function (configuration?: Configura
|
|
|
93
148
|
};
|
|
94
149
|
},
|
|
95
150
|
/**
|
|
96
|
-
*
|
|
151
|
+
* Permanently removes a dashboard and all associated data by dashboard code. **Required Permissions** \"reporting.dashboards.delete\"
|
|
152
|
+
* @summary Deletes an existing dashboard
|
|
97
153
|
* @param {string} code
|
|
98
154
|
* @param {string} [authorization] Bearer Token
|
|
99
155
|
* @param {*} [options] Override http request option.
|
|
@@ -137,7 +193,53 @@ export const DashboardApiAxiosParamCreator = function (configuration?: Configura
|
|
|
137
193
|
};
|
|
138
194
|
},
|
|
139
195
|
/**
|
|
140
|
-
*
|
|
196
|
+
* Creates a copy of the specified dashboard with all its configurations and settings. **Required Permissions** \"reporting.dashboards.create\"
|
|
197
|
+
* @summary Creates a duplicate of an existing dashboard
|
|
198
|
+
* @param {string} code
|
|
199
|
+
* @param {string} [authorization] Bearer Token
|
|
200
|
+
* @param {*} [options] Override http request option.
|
|
201
|
+
* @throws {RequiredError}
|
|
202
|
+
*/
|
|
203
|
+
duplicateDashboard: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
204
|
+
// verify required parameter 'code' is not null or undefined
|
|
205
|
+
assertParamExists('duplicateDashboard', 'code', code)
|
|
206
|
+
const localVarPath = `/tenantservice/v1/dashboards/{code}/duplicate`
|
|
207
|
+
.replace(`{${"code"}}`, encodeURIComponent(String(code)));
|
|
208
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
209
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
210
|
+
let baseOptions;
|
|
211
|
+
let baseAccessToken;
|
|
212
|
+
if (configuration) {
|
|
213
|
+
baseOptions = configuration.baseOptions;
|
|
214
|
+
baseAccessToken = configuration.accessToken;
|
|
215
|
+
}
|
|
216
|
+
|
|
217
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
218
|
+
const localVarHeaderParameter = {} as any;
|
|
219
|
+
const localVarQueryParameter = {} as any;
|
|
220
|
+
|
|
221
|
+
// authentication bearer required
|
|
222
|
+
// http bearer authentication required
|
|
223
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
224
|
+
|
|
225
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
226
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
227
|
+
}
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
232
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
233
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
234
|
+
|
|
235
|
+
return {
|
|
236
|
+
url: toPathString(localVarUrlObj),
|
|
237
|
+
options: localVarRequestOptions,
|
|
238
|
+
};
|
|
239
|
+
},
|
|
240
|
+
/**
|
|
241
|
+
* Creates a secure embedded URL that allows dashboard analysis and editing within external applications. **Required Permissions** \"reporting.dashboards.update\"
|
|
242
|
+
* @summary Generates an embedded URL for dashboard editing
|
|
141
243
|
* @param {string} providerDashboardId
|
|
142
244
|
* @param {string} [authorization] Bearer Token
|
|
143
245
|
* @param {*} [options] Override http request option.
|
|
@@ -181,7 +283,8 @@ export const DashboardApiAxiosParamCreator = function (configuration?: Configura
|
|
|
181
283
|
};
|
|
182
284
|
},
|
|
183
285
|
/**
|
|
184
|
-
*
|
|
286
|
+
* Fetches dashboard details by code including configuration and metadata. **Required Permissions** \"reporting.dashboards.view\"
|
|
287
|
+
* @summary Retrieves a specific dashboard
|
|
185
288
|
* @param {string} code
|
|
186
289
|
* @param {string} [authorization] Bearer Token
|
|
187
290
|
* @param {*} [options] Override http request option.
|
|
@@ -225,7 +328,8 @@ export const DashboardApiAxiosParamCreator = function (configuration?: Configura
|
|
|
225
328
|
};
|
|
226
329
|
},
|
|
227
330
|
/**
|
|
228
|
-
*
|
|
331
|
+
* Creates a secure embedded URL that allows dashboard content to be displayed within external applications. **Required Permissions** \"reporting.dashboards.view\"
|
|
332
|
+
* @summary Generates an embedded URL for dashboard viewing
|
|
229
333
|
* @param {string} providerDashboardId
|
|
230
334
|
* @param {string} [authorization] Bearer Token
|
|
231
335
|
* @param {*} [options] Override http request option.
|
|
@@ -269,7 +373,8 @@ export const DashboardApiAxiosParamCreator = function (configuration?: Configura
|
|
|
269
373
|
};
|
|
270
374
|
},
|
|
271
375
|
/**
|
|
272
|
-
*
|
|
376
|
+
* Fetches a paginated list of dashboards with optional filtering and sorting capabilities. **Required Permissions** \"reporting.dashboards.view\"
|
|
377
|
+
* @summary Retrieves a list of dashboards
|
|
273
378
|
* @param {string} [authorization] Bearer Token
|
|
274
379
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
275
380
|
* @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 +449,8 @@ export const DashboardApiAxiosParamCreator = function (configuration?: Configura
|
|
|
344
449
|
};
|
|
345
450
|
},
|
|
346
451
|
/**
|
|
347
|
-
*
|
|
452
|
+
* Makes a dashboard publicly available by publishing it from draft or analysis state. **Required Permissions** \"reporting.dashboards.update\"
|
|
453
|
+
* @summary Publishes a dashboard for general access
|
|
348
454
|
* @param {PublishDashboardRequestDto} publishDashboardRequestDto
|
|
349
455
|
* @param {string} [authorization] Bearer Token
|
|
350
456
|
* @param {*} [options] Override http request option.
|
|
@@ -390,7 +496,8 @@ export const DashboardApiAxiosParamCreator = function (configuration?: Configura
|
|
|
390
496
|
};
|
|
391
497
|
},
|
|
392
498
|
/**
|
|
393
|
-
*
|
|
499
|
+
* Rolls back dashboard analysis changes to restore the previous version or state. **Required Permissions** \"reporting.dashboards.update\"
|
|
500
|
+
* @summary Reverts dashboard analysis to previous state
|
|
394
501
|
* @param {RevertAnalysisRequestDto} revertAnalysisRequestDto
|
|
395
502
|
* @param {string} [authorization] Bearer Token
|
|
396
503
|
* @param {*} [options] Override http request option.
|
|
@@ -436,7 +543,8 @@ export const DashboardApiAxiosParamCreator = function (configuration?: Configura
|
|
|
436
543
|
};
|
|
437
544
|
},
|
|
438
545
|
/**
|
|
439
|
-
*
|
|
546
|
+
* Modifies dashboard properties, configuration, or metadata by dashboard code. **Required Permissions** \"reporting.dashboards.update\"
|
|
547
|
+
* @summary Updates an existing dashboard
|
|
440
548
|
* @param {string} code
|
|
441
549
|
* @param {UpdateDashboardRequestDto} updateDashboardRequestDto
|
|
442
550
|
* @param {string} [authorization] Bearer Token
|
|
@@ -496,18 +604,33 @@ export const DashboardApiFp = function(configuration?: Configuration) {
|
|
|
496
604
|
const localVarAxiosParamCreator = DashboardApiAxiosParamCreator(configuration)
|
|
497
605
|
return {
|
|
498
606
|
/**
|
|
499
|
-
*
|
|
607
|
+
* Creates a new dashboard using the preconfigured analysis id **Required Permissions** \"reporting.dashboards.create\"
|
|
608
|
+
* @summary Creates a new dashboard
|
|
609
|
+
* @param {CreateDashboardV2RequestDto} createDashboardV2RequestDto
|
|
610
|
+
* @param {string} [authorization] Bearer Token
|
|
611
|
+
* @param {*} [options] Override http request option.
|
|
612
|
+
* @throws {RequiredError}
|
|
613
|
+
*/
|
|
614
|
+
async createDashboard(createDashboardV2RequestDto: CreateDashboardV2RequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateDashboardV2ResponseClass>> {
|
|
615
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createDashboard(createDashboardV2RequestDto, authorization, options);
|
|
616
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
617
|
+
},
|
|
618
|
+
/**
|
|
619
|
+
* Creates a new dashboard from a preconfigured analysis id and dashboard id. Use POST /tenantservice/v1/dashboards instead. **Required Permissions** \"reporting.dashboards.create\"
|
|
620
|
+
* @summary Creates a new dashboard (DEPRECATED)
|
|
500
621
|
* @param {CreateDashboardRequestDto} createDashboardRequestDto
|
|
501
622
|
* @param {string} [authorization] Bearer Token
|
|
502
623
|
* @param {*} [options] Override http request option.
|
|
624
|
+
* @deprecated
|
|
503
625
|
* @throws {RequiredError}
|
|
504
626
|
*/
|
|
505
|
-
async
|
|
506
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
627
|
+
async createDashboardLegacy(createDashboardRequestDto: CreateDashboardRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateDashboardResponseClass>> {
|
|
628
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createDashboardLegacy(createDashboardRequestDto, authorization, options);
|
|
507
629
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
508
630
|
},
|
|
509
631
|
/**
|
|
510
|
-
*
|
|
632
|
+
* Permanently removes a dashboard and all associated data by dashboard code. **Required Permissions** \"reporting.dashboards.delete\"
|
|
633
|
+
* @summary Deletes an existing dashboard
|
|
511
634
|
* @param {string} code
|
|
512
635
|
* @param {string} [authorization] Bearer Token
|
|
513
636
|
* @param {*} [options] Override http request option.
|
|
@@ -518,7 +641,20 @@ export const DashboardApiFp = function(configuration?: Configuration) {
|
|
|
518
641
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
519
642
|
},
|
|
520
643
|
/**
|
|
521
|
-
*
|
|
644
|
+
* Creates a copy of the specified dashboard with all its configurations and settings. **Required Permissions** \"reporting.dashboards.create\"
|
|
645
|
+
* @summary Creates a duplicate of an existing dashboard
|
|
646
|
+
* @param {string} code
|
|
647
|
+
* @param {string} [authorization] Bearer Token
|
|
648
|
+
* @param {*} [options] Override http request option.
|
|
649
|
+
* @throws {RequiredError}
|
|
650
|
+
*/
|
|
651
|
+
async duplicateDashboard(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DuplicateDashboardResponseClass>> {
|
|
652
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.duplicateDashboard(code, authorization, options);
|
|
653
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
654
|
+
},
|
|
655
|
+
/**
|
|
656
|
+
* Creates a secure embedded URL that allows dashboard analysis and editing within external applications. **Required Permissions** \"reporting.dashboards.update\"
|
|
657
|
+
* @summary Generates an embedded URL for dashboard editing
|
|
522
658
|
* @param {string} providerDashboardId
|
|
523
659
|
* @param {string} [authorization] Bearer Token
|
|
524
660
|
* @param {*} [options] Override http request option.
|
|
@@ -529,7 +665,8 @@ export const DashboardApiFp = function(configuration?: Configuration) {
|
|
|
529
665
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
530
666
|
},
|
|
531
667
|
/**
|
|
532
|
-
*
|
|
668
|
+
* Fetches dashboard details by code including configuration and metadata. **Required Permissions** \"reporting.dashboards.view\"
|
|
669
|
+
* @summary Retrieves a specific dashboard
|
|
533
670
|
* @param {string} code
|
|
534
671
|
* @param {string} [authorization] Bearer Token
|
|
535
672
|
* @param {*} [options] Override http request option.
|
|
@@ -540,7 +677,8 @@ export const DashboardApiFp = function(configuration?: Configuration) {
|
|
|
540
677
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
541
678
|
},
|
|
542
679
|
/**
|
|
543
|
-
*
|
|
680
|
+
* Creates a secure embedded URL that allows dashboard content to be displayed within external applications. **Required Permissions** \"reporting.dashboards.view\"
|
|
681
|
+
* @summary Generates an embedded URL for dashboard viewing
|
|
544
682
|
* @param {string} providerDashboardId
|
|
545
683
|
* @param {string} [authorization] Bearer Token
|
|
546
684
|
* @param {*} [options] Override http request option.
|
|
@@ -551,7 +689,8 @@ export const DashboardApiFp = function(configuration?: Configuration) {
|
|
|
551
689
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
552
690
|
},
|
|
553
691
|
/**
|
|
554
|
-
*
|
|
692
|
+
* Fetches a paginated list of dashboards with optional filtering and sorting capabilities. **Required Permissions** \"reporting.dashboards.view\"
|
|
693
|
+
* @summary Retrieves a list of dashboards
|
|
555
694
|
* @param {string} [authorization] Bearer Token
|
|
556
695
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
557
696
|
* @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 +707,8 @@ export const DashboardApiFp = function(configuration?: Configuration) {
|
|
|
568
707
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
569
708
|
},
|
|
570
709
|
/**
|
|
571
|
-
*
|
|
710
|
+
* Makes a dashboard publicly available by publishing it from draft or analysis state. **Required Permissions** \"reporting.dashboards.update\"
|
|
711
|
+
* @summary Publishes a dashboard for general access
|
|
572
712
|
* @param {PublishDashboardRequestDto} publishDashboardRequestDto
|
|
573
713
|
* @param {string} [authorization] Bearer Token
|
|
574
714
|
* @param {*} [options] Override http request option.
|
|
@@ -579,7 +719,8 @@ export const DashboardApiFp = function(configuration?: Configuration) {
|
|
|
579
719
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
580
720
|
},
|
|
581
721
|
/**
|
|
582
|
-
*
|
|
722
|
+
* Rolls back dashboard analysis changes to restore the previous version or state. **Required Permissions** \"reporting.dashboards.update\"
|
|
723
|
+
* @summary Reverts dashboard analysis to previous state
|
|
583
724
|
* @param {RevertAnalysisRequestDto} revertAnalysisRequestDto
|
|
584
725
|
* @param {string} [authorization] Bearer Token
|
|
585
726
|
* @param {*} [options] Override http request option.
|
|
@@ -590,7 +731,8 @@ export const DashboardApiFp = function(configuration?: Configuration) {
|
|
|
590
731
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
591
732
|
},
|
|
592
733
|
/**
|
|
593
|
-
*
|
|
734
|
+
* Modifies dashboard properties, configuration, or metadata by dashboard code. **Required Permissions** \"reporting.dashboards.update\"
|
|
735
|
+
* @summary Updates an existing dashboard
|
|
594
736
|
* @param {string} code
|
|
595
737
|
* @param {UpdateDashboardRequestDto} updateDashboardRequestDto
|
|
596
738
|
* @param {string} [authorization] Bearer Token
|
|
@@ -612,17 +754,31 @@ export const DashboardApiFactory = function (configuration?: Configuration, base
|
|
|
612
754
|
const localVarFp = DashboardApiFp(configuration)
|
|
613
755
|
return {
|
|
614
756
|
/**
|
|
615
|
-
*
|
|
757
|
+
* Creates a new dashboard using the preconfigured analysis id **Required Permissions** \"reporting.dashboards.create\"
|
|
758
|
+
* @summary Creates a new dashboard
|
|
759
|
+
* @param {CreateDashboardV2RequestDto} createDashboardV2RequestDto
|
|
760
|
+
* @param {string} [authorization] Bearer Token
|
|
761
|
+
* @param {*} [options] Override http request option.
|
|
762
|
+
* @throws {RequiredError}
|
|
763
|
+
*/
|
|
764
|
+
createDashboard(createDashboardV2RequestDto: CreateDashboardV2RequestDto, authorization?: string, options?: any): AxiosPromise<CreateDashboardV2ResponseClass> {
|
|
765
|
+
return localVarFp.createDashboard(createDashboardV2RequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
766
|
+
},
|
|
767
|
+
/**
|
|
768
|
+
* Creates a new dashboard from a preconfigured analysis id and dashboard id. Use POST /tenantservice/v1/dashboards instead. **Required Permissions** \"reporting.dashboards.create\"
|
|
769
|
+
* @summary Creates a new dashboard (DEPRECATED)
|
|
616
770
|
* @param {CreateDashboardRequestDto} createDashboardRequestDto
|
|
617
771
|
* @param {string} [authorization] Bearer Token
|
|
618
772
|
* @param {*} [options] Override http request option.
|
|
773
|
+
* @deprecated
|
|
619
774
|
* @throws {RequiredError}
|
|
620
775
|
*/
|
|
621
|
-
|
|
622
|
-
return localVarFp.
|
|
776
|
+
createDashboardLegacy(createDashboardRequestDto: CreateDashboardRequestDto, authorization?: string, options?: any): AxiosPromise<CreateDashboardResponseClass> {
|
|
777
|
+
return localVarFp.createDashboardLegacy(createDashboardRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
623
778
|
},
|
|
624
779
|
/**
|
|
625
|
-
*
|
|
780
|
+
* Permanently removes a dashboard and all associated data by dashboard code. **Required Permissions** \"reporting.dashboards.delete\"
|
|
781
|
+
* @summary Deletes an existing dashboard
|
|
626
782
|
* @param {string} code
|
|
627
783
|
* @param {string} [authorization] Bearer Token
|
|
628
784
|
* @param {*} [options] Override http request option.
|
|
@@ -632,7 +788,19 @@ export const DashboardApiFactory = function (configuration?: Configuration, base
|
|
|
632
788
|
return localVarFp.deleteDashboard(code, authorization, options).then((request) => request(axios, basePath));
|
|
633
789
|
},
|
|
634
790
|
/**
|
|
635
|
-
*
|
|
791
|
+
* Creates a copy of the specified dashboard with all its configurations and settings. **Required Permissions** \"reporting.dashboards.create\"
|
|
792
|
+
* @summary Creates a duplicate of an existing dashboard
|
|
793
|
+
* @param {string} code
|
|
794
|
+
* @param {string} [authorization] Bearer Token
|
|
795
|
+
* @param {*} [options] Override http request option.
|
|
796
|
+
* @throws {RequiredError}
|
|
797
|
+
*/
|
|
798
|
+
duplicateDashboard(code: string, authorization?: string, options?: any): AxiosPromise<DuplicateDashboardResponseClass> {
|
|
799
|
+
return localVarFp.duplicateDashboard(code, authorization, options).then((request) => request(axios, basePath));
|
|
800
|
+
},
|
|
801
|
+
/**
|
|
802
|
+
* Creates a secure embedded URL that allows dashboard analysis and editing within external applications. **Required Permissions** \"reporting.dashboards.update\"
|
|
803
|
+
* @summary Generates an embedded URL for dashboard editing
|
|
636
804
|
* @param {string} providerDashboardId
|
|
637
805
|
* @param {string} [authorization] Bearer Token
|
|
638
806
|
* @param {*} [options] Override http request option.
|
|
@@ -642,7 +810,8 @@ export const DashboardApiFactory = function (configuration?: Configuration, base
|
|
|
642
810
|
return localVarFp.getAnalysisEmbeddedUrl(providerDashboardId, authorization, options).then((request) => request(axios, basePath));
|
|
643
811
|
},
|
|
644
812
|
/**
|
|
645
|
-
*
|
|
813
|
+
* Fetches dashboard details by code including configuration and metadata. **Required Permissions** \"reporting.dashboards.view\"
|
|
814
|
+
* @summary Retrieves a specific dashboard
|
|
646
815
|
* @param {string} code
|
|
647
816
|
* @param {string} [authorization] Bearer Token
|
|
648
817
|
* @param {*} [options] Override http request option.
|
|
@@ -652,7 +821,8 @@ export const DashboardApiFactory = function (configuration?: Configuration, base
|
|
|
652
821
|
return localVarFp.getDashboard(code, authorization, options).then((request) => request(axios, basePath));
|
|
653
822
|
},
|
|
654
823
|
/**
|
|
655
|
-
*
|
|
824
|
+
* Creates a secure embedded URL that allows dashboard content to be displayed within external applications. **Required Permissions** \"reporting.dashboards.view\"
|
|
825
|
+
* @summary Generates an embedded URL for dashboard viewing
|
|
656
826
|
* @param {string} providerDashboardId
|
|
657
827
|
* @param {string} [authorization] Bearer Token
|
|
658
828
|
* @param {*} [options] Override http request option.
|
|
@@ -662,7 +832,8 @@ export const DashboardApiFactory = function (configuration?: Configuration, base
|
|
|
662
832
|
return localVarFp.getDashboardEmbeddedUrl(providerDashboardId, authorization, options).then((request) => request(axios, basePath));
|
|
663
833
|
},
|
|
664
834
|
/**
|
|
665
|
-
*
|
|
835
|
+
* Fetches a paginated list of dashboards with optional filtering and sorting capabilities. **Required Permissions** \"reporting.dashboards.view\"
|
|
836
|
+
* @summary Retrieves a list of dashboards
|
|
666
837
|
* @param {string} [authorization] Bearer Token
|
|
667
838
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
668
839
|
* @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 +849,8 @@ export const DashboardApiFactory = function (configuration?: Configuration, base
|
|
|
678
849
|
return localVarFp.listDashboards(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
679
850
|
},
|
|
680
851
|
/**
|
|
681
|
-
*
|
|
852
|
+
* Makes a dashboard publicly available by publishing it from draft or analysis state. **Required Permissions** \"reporting.dashboards.update\"
|
|
853
|
+
* @summary Publishes a dashboard for general access
|
|
682
854
|
* @param {PublishDashboardRequestDto} publishDashboardRequestDto
|
|
683
855
|
* @param {string} [authorization] Bearer Token
|
|
684
856
|
* @param {*} [options] Override http request option.
|
|
@@ -688,7 +860,8 @@ export const DashboardApiFactory = function (configuration?: Configuration, base
|
|
|
688
860
|
return localVarFp.publishDashboard(publishDashboardRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
689
861
|
},
|
|
690
862
|
/**
|
|
691
|
-
*
|
|
863
|
+
* Rolls back dashboard analysis changes to restore the previous version or state. **Required Permissions** \"reporting.dashboards.update\"
|
|
864
|
+
* @summary Reverts dashboard analysis to previous state
|
|
692
865
|
* @param {RevertAnalysisRequestDto} revertAnalysisRequestDto
|
|
693
866
|
* @param {string} [authorization] Bearer Token
|
|
694
867
|
* @param {*} [options] Override http request option.
|
|
@@ -698,7 +871,8 @@ export const DashboardApiFactory = function (configuration?: Configuration, base
|
|
|
698
871
|
return localVarFp.revertAnalysis(revertAnalysisRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
699
872
|
},
|
|
700
873
|
/**
|
|
701
|
-
*
|
|
874
|
+
* Modifies dashboard properties, configuration, or metadata by dashboard code. **Required Permissions** \"reporting.dashboards.update\"
|
|
875
|
+
* @summary Updates an existing dashboard
|
|
702
876
|
* @param {string} code
|
|
703
877
|
* @param {UpdateDashboardRequestDto} updateDashboardRequestDto
|
|
704
878
|
* @param {string} [authorization] Bearer Token
|
|
@@ -719,10 +893,10 @@ export const DashboardApiFactory = function (configuration?: Configuration, base
|
|
|
719
893
|
export interface DashboardApiCreateDashboardRequest {
|
|
720
894
|
/**
|
|
721
895
|
*
|
|
722
|
-
* @type {
|
|
896
|
+
* @type {CreateDashboardV2RequestDto}
|
|
723
897
|
* @memberof DashboardApiCreateDashboard
|
|
724
898
|
*/
|
|
725
|
-
readonly
|
|
899
|
+
readonly createDashboardV2RequestDto: CreateDashboardV2RequestDto
|
|
726
900
|
|
|
727
901
|
/**
|
|
728
902
|
* Bearer Token
|
|
@@ -732,6 +906,27 @@ export interface DashboardApiCreateDashboardRequest {
|
|
|
732
906
|
readonly authorization?: string
|
|
733
907
|
}
|
|
734
908
|
|
|
909
|
+
/**
|
|
910
|
+
* Request parameters for createDashboardLegacy operation in DashboardApi.
|
|
911
|
+
* @export
|
|
912
|
+
* @interface DashboardApiCreateDashboardLegacyRequest
|
|
913
|
+
*/
|
|
914
|
+
export interface DashboardApiCreateDashboardLegacyRequest {
|
|
915
|
+
/**
|
|
916
|
+
*
|
|
917
|
+
* @type {CreateDashboardRequestDto}
|
|
918
|
+
* @memberof DashboardApiCreateDashboardLegacy
|
|
919
|
+
*/
|
|
920
|
+
readonly createDashboardRequestDto: CreateDashboardRequestDto
|
|
921
|
+
|
|
922
|
+
/**
|
|
923
|
+
* Bearer Token
|
|
924
|
+
* @type {string}
|
|
925
|
+
* @memberof DashboardApiCreateDashboardLegacy
|
|
926
|
+
*/
|
|
927
|
+
readonly authorization?: string
|
|
928
|
+
}
|
|
929
|
+
|
|
735
930
|
/**
|
|
736
931
|
* Request parameters for deleteDashboard operation in DashboardApi.
|
|
737
932
|
* @export
|
|
@@ -753,6 +948,27 @@ export interface DashboardApiDeleteDashboardRequest {
|
|
|
753
948
|
readonly authorization?: string
|
|
754
949
|
}
|
|
755
950
|
|
|
951
|
+
/**
|
|
952
|
+
* Request parameters for duplicateDashboard operation in DashboardApi.
|
|
953
|
+
* @export
|
|
954
|
+
* @interface DashboardApiDuplicateDashboardRequest
|
|
955
|
+
*/
|
|
956
|
+
export interface DashboardApiDuplicateDashboardRequest {
|
|
957
|
+
/**
|
|
958
|
+
*
|
|
959
|
+
* @type {string}
|
|
960
|
+
* @memberof DashboardApiDuplicateDashboard
|
|
961
|
+
*/
|
|
962
|
+
readonly code: string
|
|
963
|
+
|
|
964
|
+
/**
|
|
965
|
+
* Bearer Token
|
|
966
|
+
* @type {string}
|
|
967
|
+
* @memberof DashboardApiDuplicateDashboard
|
|
968
|
+
*/
|
|
969
|
+
readonly authorization?: string
|
|
970
|
+
}
|
|
971
|
+
|
|
756
972
|
/**
|
|
757
973
|
* Request parameters for getAnalysisEmbeddedUrl operation in DashboardApi.
|
|
758
974
|
* @export
|
|
@@ -957,18 +1173,33 @@ export interface DashboardApiUpdateDashboardRequest {
|
|
|
957
1173
|
*/
|
|
958
1174
|
export class DashboardApi extends BaseAPI {
|
|
959
1175
|
/**
|
|
960
|
-
*
|
|
1176
|
+
* Creates a new dashboard using the preconfigured analysis id **Required Permissions** \"reporting.dashboards.create\"
|
|
1177
|
+
* @summary Creates a new dashboard
|
|
961
1178
|
* @param {DashboardApiCreateDashboardRequest} requestParameters Request parameters.
|
|
962
1179
|
* @param {*} [options] Override http request option.
|
|
963
1180
|
* @throws {RequiredError}
|
|
964
1181
|
* @memberof DashboardApi
|
|
965
1182
|
*/
|
|
966
1183
|
public createDashboard(requestParameters: DashboardApiCreateDashboardRequest, options?: AxiosRequestConfig) {
|
|
967
|
-
return DashboardApiFp(this.configuration).createDashboard(requestParameters.
|
|
1184
|
+
return DashboardApiFp(this.configuration).createDashboard(requestParameters.createDashboardV2RequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
1185
|
+
}
|
|
1186
|
+
|
|
1187
|
+
/**
|
|
1188
|
+
* Creates a new dashboard from a preconfigured analysis id and dashboard id. Use POST /tenantservice/v1/dashboards instead. **Required Permissions** \"reporting.dashboards.create\"
|
|
1189
|
+
* @summary Creates a new dashboard (DEPRECATED)
|
|
1190
|
+
* @param {DashboardApiCreateDashboardLegacyRequest} requestParameters Request parameters.
|
|
1191
|
+
* @param {*} [options] Override http request option.
|
|
1192
|
+
* @deprecated
|
|
1193
|
+
* @throws {RequiredError}
|
|
1194
|
+
* @memberof DashboardApi
|
|
1195
|
+
*/
|
|
1196
|
+
public createDashboardLegacy(requestParameters: DashboardApiCreateDashboardLegacyRequest, options?: AxiosRequestConfig) {
|
|
1197
|
+
return DashboardApiFp(this.configuration).createDashboardLegacy(requestParameters.createDashboardRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
968
1198
|
}
|
|
969
1199
|
|
|
970
1200
|
/**
|
|
971
|
-
*
|
|
1201
|
+
* Permanently removes a dashboard and all associated data by dashboard code. **Required Permissions** \"reporting.dashboards.delete\"
|
|
1202
|
+
* @summary Deletes an existing dashboard
|
|
972
1203
|
* @param {DashboardApiDeleteDashboardRequest} requestParameters Request parameters.
|
|
973
1204
|
* @param {*} [options] Override http request option.
|
|
974
1205
|
* @throws {RequiredError}
|
|
@@ -979,7 +1210,20 @@ export class DashboardApi extends BaseAPI {
|
|
|
979
1210
|
}
|
|
980
1211
|
|
|
981
1212
|
/**
|
|
982
|
-
*
|
|
1213
|
+
* Creates a copy of the specified dashboard with all its configurations and settings. **Required Permissions** \"reporting.dashboards.create\"
|
|
1214
|
+
* @summary Creates a duplicate of an existing dashboard
|
|
1215
|
+
* @param {DashboardApiDuplicateDashboardRequest} requestParameters Request parameters.
|
|
1216
|
+
* @param {*} [options] Override http request option.
|
|
1217
|
+
* @throws {RequiredError}
|
|
1218
|
+
* @memberof DashboardApi
|
|
1219
|
+
*/
|
|
1220
|
+
public duplicateDashboard(requestParameters: DashboardApiDuplicateDashboardRequest, options?: AxiosRequestConfig) {
|
|
1221
|
+
return DashboardApiFp(this.configuration).duplicateDashboard(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
1222
|
+
}
|
|
1223
|
+
|
|
1224
|
+
/**
|
|
1225
|
+
* Creates a secure embedded URL that allows dashboard analysis and editing within external applications. **Required Permissions** \"reporting.dashboards.update\"
|
|
1226
|
+
* @summary Generates an embedded URL for dashboard editing
|
|
983
1227
|
* @param {DashboardApiGetAnalysisEmbeddedUrlRequest} requestParameters Request parameters.
|
|
984
1228
|
* @param {*} [options] Override http request option.
|
|
985
1229
|
* @throws {RequiredError}
|
|
@@ -990,7 +1234,8 @@ export class DashboardApi extends BaseAPI {
|
|
|
990
1234
|
}
|
|
991
1235
|
|
|
992
1236
|
/**
|
|
993
|
-
*
|
|
1237
|
+
* Fetches dashboard details by code including configuration and metadata. **Required Permissions** \"reporting.dashboards.view\"
|
|
1238
|
+
* @summary Retrieves a specific dashboard
|
|
994
1239
|
* @param {DashboardApiGetDashboardRequest} requestParameters Request parameters.
|
|
995
1240
|
* @param {*} [options] Override http request option.
|
|
996
1241
|
* @throws {RequiredError}
|
|
@@ -1001,7 +1246,8 @@ export class DashboardApi extends BaseAPI {
|
|
|
1001
1246
|
}
|
|
1002
1247
|
|
|
1003
1248
|
/**
|
|
1004
|
-
*
|
|
1249
|
+
* Creates a secure embedded URL that allows dashboard content to be displayed within external applications. **Required Permissions** \"reporting.dashboards.view\"
|
|
1250
|
+
* @summary Generates an embedded URL for dashboard viewing
|
|
1005
1251
|
* @param {DashboardApiGetDashboardEmbeddedUrlRequest} requestParameters Request parameters.
|
|
1006
1252
|
* @param {*} [options] Override http request option.
|
|
1007
1253
|
* @throws {RequiredError}
|
|
@@ -1012,7 +1258,8 @@ export class DashboardApi extends BaseAPI {
|
|
|
1012
1258
|
}
|
|
1013
1259
|
|
|
1014
1260
|
/**
|
|
1015
|
-
*
|
|
1261
|
+
* Fetches a paginated list of dashboards with optional filtering and sorting capabilities. **Required Permissions** \"reporting.dashboards.view\"
|
|
1262
|
+
* @summary Retrieves a list of dashboards
|
|
1016
1263
|
* @param {DashboardApiListDashboardsRequest} requestParameters Request parameters.
|
|
1017
1264
|
* @param {*} [options] Override http request option.
|
|
1018
1265
|
* @throws {RequiredError}
|
|
@@ -1023,7 +1270,8 @@ export class DashboardApi extends BaseAPI {
|
|
|
1023
1270
|
}
|
|
1024
1271
|
|
|
1025
1272
|
/**
|
|
1026
|
-
*
|
|
1273
|
+
* Makes a dashboard publicly available by publishing it from draft or analysis state. **Required Permissions** \"reporting.dashboards.update\"
|
|
1274
|
+
* @summary Publishes a dashboard for general access
|
|
1027
1275
|
* @param {DashboardApiPublishDashboardRequest} requestParameters Request parameters.
|
|
1028
1276
|
* @param {*} [options] Override http request option.
|
|
1029
1277
|
* @throws {RequiredError}
|
|
@@ -1034,7 +1282,8 @@ export class DashboardApi extends BaseAPI {
|
|
|
1034
1282
|
}
|
|
1035
1283
|
|
|
1036
1284
|
/**
|
|
1037
|
-
*
|
|
1285
|
+
* Rolls back dashboard analysis changes to restore the previous version or state. **Required Permissions** \"reporting.dashboards.update\"
|
|
1286
|
+
* @summary Reverts dashboard analysis to previous state
|
|
1038
1287
|
* @param {DashboardApiRevertAnalysisRequest} requestParameters Request parameters.
|
|
1039
1288
|
* @param {*} [options] Override http request option.
|
|
1040
1289
|
* @throws {RequiredError}
|
|
@@ -1045,7 +1294,8 @@ export class DashboardApi extends BaseAPI {
|
|
|
1045
1294
|
}
|
|
1046
1295
|
|
|
1047
1296
|
/**
|
|
1048
|
-
*
|
|
1297
|
+
* Modifies dashboard properties, configuration, or metadata by dashboard code. **Required Permissions** \"reporting.dashboards.update\"
|
|
1298
|
+
* @summary Updates an existing dashboard
|
|
1049
1299
|
* @param {DashboardApiUpdateDashboardRequest} requestParameters Request parameters.
|
|
1050
1300
|
* @param {*} [options] Override http request option.
|
|
1051
1301
|
* @throws {RequiredError}
|