@emilgroup/tenant-sdk 1.32.0 → 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/api/organization-migration-api.ts +12 -9
- package/dist/api/dashboard-api.d.ts +195 -42
- package/dist/api/dashboard-api.js +269 -44
- package/dist/api/organization-migration-api.d.ts +8 -8
- package/dist/api/organization-migration-api.js +6 -4
- 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
|
@@ -137,17 +137,16 @@ export const OrganizationMigrationApiAxiosParamCreator = function (configuration
|
|
|
137
137
|
/**
|
|
138
138
|
* Retrieves an organization migration by its code. **Required Permissions** \"tenant-management.organizations.view\"
|
|
139
139
|
* @summary Get organization migration
|
|
140
|
-
* @param {
|
|
140
|
+
* @param {string} code Unique identifier for the object.
|
|
141
141
|
* @param {string} [expand] Fields to expand response by
|
|
142
142
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
143
143
|
* @param {*} [options] Override http request option.
|
|
144
144
|
* @throws {RequiredError}
|
|
145
145
|
*/
|
|
146
|
-
getOrganizationMigration: async (code:
|
|
146
|
+
getOrganizationMigration: async (code: string, expand?: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
147
147
|
// verify required parameter 'code' is not null or undefined
|
|
148
148
|
assertParamExists('getOrganizationMigration', 'code', code)
|
|
149
149
|
const localVarPath = `/tenantservice/v1/organization-migrations/{code}`
|
|
150
|
-
.replace(`{${"expand"}}`, encodeURIComponent(String(expand)))
|
|
151
150
|
.replace(`{${"code"}}`, encodeURIComponent(String(code)));
|
|
152
151
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
153
152
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -166,6 +165,10 @@ export const OrganizationMigrationApiAxiosParamCreator = function (configuration
|
|
|
166
165
|
// http bearer authentication required
|
|
167
166
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
168
167
|
|
|
168
|
+
if (expand !== undefined) {
|
|
169
|
+
localVarQueryParameter['expand'] = expand;
|
|
170
|
+
}
|
|
171
|
+
|
|
169
172
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
170
173
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
171
174
|
}
|
|
@@ -341,13 +344,13 @@ export const OrganizationMigrationApiFp = function(configuration?: Configuration
|
|
|
341
344
|
/**
|
|
342
345
|
* Retrieves an organization migration by its code. **Required Permissions** \"tenant-management.organizations.view\"
|
|
343
346
|
* @summary Get organization migration
|
|
344
|
-
* @param {
|
|
347
|
+
* @param {string} code Unique identifier for the object.
|
|
345
348
|
* @param {string} [expand] Fields to expand response by
|
|
346
349
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
347
350
|
* @param {*} [options] Override http request option.
|
|
348
351
|
* @throws {RequiredError}
|
|
349
352
|
*/
|
|
350
|
-
async getOrganizationMigration(code:
|
|
353
|
+
async getOrganizationMigration(code: string, expand?: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrganizationMigrationResponseClass>> {
|
|
351
354
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getOrganizationMigration(code, expand, authorization, options);
|
|
352
355
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
353
356
|
},
|
|
@@ -416,13 +419,13 @@ export const OrganizationMigrationApiFactory = function (configuration?: Configu
|
|
|
416
419
|
/**
|
|
417
420
|
* Retrieves an organization migration by its code. **Required Permissions** \"tenant-management.organizations.view\"
|
|
418
421
|
* @summary Get organization migration
|
|
419
|
-
* @param {
|
|
422
|
+
* @param {string} code Unique identifier for the object.
|
|
420
423
|
* @param {string} [expand] Fields to expand response by
|
|
421
424
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
422
425
|
* @param {*} [options] Override http request option.
|
|
423
426
|
* @throws {RequiredError}
|
|
424
427
|
*/
|
|
425
|
-
getOrganizationMigration(code:
|
|
428
|
+
getOrganizationMigration(code: string, expand?: string, authorization?: string, options?: any): AxiosPromise<GetOrganizationMigrationResponseClass> {
|
|
426
429
|
return localVarFp.getOrganizationMigration(code, expand, authorization, options).then((request) => request(axios, basePath));
|
|
427
430
|
},
|
|
428
431
|
/**
|
|
@@ -506,10 +509,10 @@ export interface OrganizationMigrationApiCreateResourcesMigrationRequest {
|
|
|
506
509
|
export interface OrganizationMigrationApiGetOrganizationMigrationRequest {
|
|
507
510
|
/**
|
|
508
511
|
* Unique identifier for the object.
|
|
509
|
-
* @type {
|
|
512
|
+
* @type {string}
|
|
510
513
|
* @memberof OrganizationMigrationApiGetOrganizationMigration
|
|
511
514
|
*/
|
|
512
|
-
readonly code:
|
|
515
|
+
readonly code: string
|
|
513
516
|
|
|
514
517
|
/**
|
|
515
518
|
* Fields to expand response by
|
|
@@ -14,7 +14,10 @@ import { Configuration } from '../configuration';
|
|
|
14
14
|
import { RequestArgs, BaseAPI } from '../base';
|
|
15
15
|
import { CreateDashboardRequestDto } from '../models';
|
|
16
16
|
import { CreateDashboardResponseClass } from '../models';
|
|
17
|
+
import { CreateDashboardV2RequestDto } from '../models';
|
|
18
|
+
import { CreateDashboardV2ResponseClass } from '../models';
|
|
17
19
|
import { DeleteResponseClass } from '../models';
|
|
20
|
+
import { DuplicateDashboardResponseClass } from '../models';
|
|
18
21
|
import { GetDashboardResponseClass } from '../models';
|
|
19
22
|
import { GetEmbeddedUrlResponseClass } from '../models';
|
|
20
23
|
import { ListDashboardsResponseClass } from '../models';
|
|
@@ -28,15 +31,27 @@ import { UpdateDashboardResponseClass } from '../models';
|
|
|
28
31
|
*/
|
|
29
32
|
export declare const DashboardApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
30
33
|
/**
|
|
31
|
-
*
|
|
34
|
+
* Creates a new dashboard using the preconfigured analysis id **Required Permissions** \"reporting.dashboards.create\"
|
|
35
|
+
* @summary Creates a new dashboard
|
|
36
|
+
* @param {CreateDashboardV2RequestDto} createDashboardV2RequestDto
|
|
37
|
+
* @param {string} [authorization] Bearer Token
|
|
38
|
+
* @param {*} [options] Override http request option.
|
|
39
|
+
* @throws {RequiredError}
|
|
40
|
+
*/
|
|
41
|
+
createDashboard: (createDashboardV2RequestDto: CreateDashboardV2RequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
42
|
+
/**
|
|
43
|
+
* Creates a new dashboard from a preconfigured analysis id and dashboard id. Use POST /tenantservice/v1/dashboards instead. **Required Permissions** \"reporting.dashboards.create\"
|
|
44
|
+
* @summary Creates a new dashboard (DEPRECATED)
|
|
32
45
|
* @param {CreateDashboardRequestDto} createDashboardRequestDto
|
|
33
46
|
* @param {string} [authorization] Bearer Token
|
|
34
47
|
* @param {*} [options] Override http request option.
|
|
48
|
+
* @deprecated
|
|
35
49
|
* @throws {RequiredError}
|
|
36
50
|
*/
|
|
37
|
-
|
|
51
|
+
createDashboardLegacy: (createDashboardRequestDto: CreateDashboardRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
38
52
|
/**
|
|
39
|
-
*
|
|
53
|
+
* Permanently removes a dashboard and all associated data by dashboard code. **Required Permissions** \"reporting.dashboards.delete\"
|
|
54
|
+
* @summary Deletes an existing dashboard
|
|
40
55
|
* @param {string} code
|
|
41
56
|
* @param {string} [authorization] Bearer Token
|
|
42
57
|
* @param {*} [options] Override http request option.
|
|
@@ -44,7 +59,17 @@ export declare const DashboardApiAxiosParamCreator: (configuration?: Configurati
|
|
|
44
59
|
*/
|
|
45
60
|
deleteDashboard: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
46
61
|
/**
|
|
47
|
-
*
|
|
62
|
+
* Creates a copy of the specified dashboard with all its configurations and settings. **Required Permissions** \"reporting.dashboards.create\"
|
|
63
|
+
* @summary Creates a duplicate of an existing dashboard
|
|
64
|
+
* @param {string} code
|
|
65
|
+
* @param {string} [authorization] Bearer Token
|
|
66
|
+
* @param {*} [options] Override http request option.
|
|
67
|
+
* @throws {RequiredError}
|
|
68
|
+
*/
|
|
69
|
+
duplicateDashboard: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
70
|
+
/**
|
|
71
|
+
* Creates a secure embedded URL that allows dashboard analysis and editing within external applications. **Required Permissions** \"reporting.dashboards.update\"
|
|
72
|
+
* @summary Generates an embedded URL for dashboard editing
|
|
48
73
|
* @param {string} providerDashboardId
|
|
49
74
|
* @param {string} [authorization] Bearer Token
|
|
50
75
|
* @param {*} [options] Override http request option.
|
|
@@ -52,7 +77,8 @@ export declare const DashboardApiAxiosParamCreator: (configuration?: Configurati
|
|
|
52
77
|
*/
|
|
53
78
|
getAnalysisEmbeddedUrl: (providerDashboardId: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
54
79
|
/**
|
|
55
|
-
*
|
|
80
|
+
* Fetches dashboard details by code including configuration and metadata. **Required Permissions** \"reporting.dashboards.view\"
|
|
81
|
+
* @summary Retrieves a specific dashboard
|
|
56
82
|
* @param {string} code
|
|
57
83
|
* @param {string} [authorization] Bearer Token
|
|
58
84
|
* @param {*} [options] Override http request option.
|
|
@@ -60,7 +86,8 @@ export declare const DashboardApiAxiosParamCreator: (configuration?: Configurati
|
|
|
60
86
|
*/
|
|
61
87
|
getDashboard: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
62
88
|
/**
|
|
63
|
-
*
|
|
89
|
+
* Creates a secure embedded URL that allows dashboard content to be displayed within external applications. **Required Permissions** \"reporting.dashboards.view\"
|
|
90
|
+
* @summary Generates an embedded URL for dashboard viewing
|
|
64
91
|
* @param {string} providerDashboardId
|
|
65
92
|
* @param {string} [authorization] Bearer Token
|
|
66
93
|
* @param {*} [options] Override http request option.
|
|
@@ -68,7 +95,8 @@ export declare const DashboardApiAxiosParamCreator: (configuration?: Configurati
|
|
|
68
95
|
*/
|
|
69
96
|
getDashboardEmbeddedUrl: (providerDashboardId: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
70
97
|
/**
|
|
71
|
-
*
|
|
98
|
+
* Fetches a paginated list of dashboards with optional filtering and sorting capabilities. **Required Permissions** \"reporting.dashboards.view\"
|
|
99
|
+
* @summary Retrieves a list of dashboards
|
|
72
100
|
* @param {string} [authorization] Bearer Token
|
|
73
101
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
74
102
|
* @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.
|
|
@@ -82,7 +110,8 @@ export declare const DashboardApiAxiosParamCreator: (configuration?: Configurati
|
|
|
82
110
|
*/
|
|
83
111
|
listDashboards: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
84
112
|
/**
|
|
85
|
-
*
|
|
113
|
+
* Makes a dashboard publicly available by publishing it from draft or analysis state. **Required Permissions** \"reporting.dashboards.update\"
|
|
114
|
+
* @summary Publishes a dashboard for general access
|
|
86
115
|
* @param {PublishDashboardRequestDto} publishDashboardRequestDto
|
|
87
116
|
* @param {string} [authorization] Bearer Token
|
|
88
117
|
* @param {*} [options] Override http request option.
|
|
@@ -90,7 +119,8 @@ export declare const DashboardApiAxiosParamCreator: (configuration?: Configurati
|
|
|
90
119
|
*/
|
|
91
120
|
publishDashboard: (publishDashboardRequestDto: PublishDashboardRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
92
121
|
/**
|
|
93
|
-
*
|
|
122
|
+
* Rolls back dashboard analysis changes to restore the previous version or state. **Required Permissions** \"reporting.dashboards.update\"
|
|
123
|
+
* @summary Reverts dashboard analysis to previous state
|
|
94
124
|
* @param {RevertAnalysisRequestDto} revertAnalysisRequestDto
|
|
95
125
|
* @param {string} [authorization] Bearer Token
|
|
96
126
|
* @param {*} [options] Override http request option.
|
|
@@ -98,7 +128,8 @@ export declare const DashboardApiAxiosParamCreator: (configuration?: Configurati
|
|
|
98
128
|
*/
|
|
99
129
|
revertAnalysis: (revertAnalysisRequestDto: RevertAnalysisRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
100
130
|
/**
|
|
101
|
-
*
|
|
131
|
+
* Modifies dashboard properties, configuration, or metadata by dashboard code. **Required Permissions** \"reporting.dashboards.update\"
|
|
132
|
+
* @summary Updates an existing dashboard
|
|
102
133
|
* @param {string} code
|
|
103
134
|
* @param {UpdateDashboardRequestDto} updateDashboardRequestDto
|
|
104
135
|
* @param {string} [authorization] Bearer Token
|
|
@@ -113,15 +144,27 @@ export declare const DashboardApiAxiosParamCreator: (configuration?: Configurati
|
|
|
113
144
|
*/
|
|
114
145
|
export declare const DashboardApiFp: (configuration?: Configuration) => {
|
|
115
146
|
/**
|
|
116
|
-
*
|
|
147
|
+
* Creates a new dashboard using the preconfigured analysis id **Required Permissions** \"reporting.dashboards.create\"
|
|
148
|
+
* @summary Creates a new dashboard
|
|
149
|
+
* @param {CreateDashboardV2RequestDto} createDashboardV2RequestDto
|
|
150
|
+
* @param {string} [authorization] Bearer Token
|
|
151
|
+
* @param {*} [options] Override http request option.
|
|
152
|
+
* @throws {RequiredError}
|
|
153
|
+
*/
|
|
154
|
+
createDashboard(createDashboardV2RequestDto: CreateDashboardV2RequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateDashboardV2ResponseClass>>;
|
|
155
|
+
/**
|
|
156
|
+
* Creates a new dashboard from a preconfigured analysis id and dashboard id. Use POST /tenantservice/v1/dashboards instead. **Required Permissions** \"reporting.dashboards.create\"
|
|
157
|
+
* @summary Creates a new dashboard (DEPRECATED)
|
|
117
158
|
* @param {CreateDashboardRequestDto} createDashboardRequestDto
|
|
118
159
|
* @param {string} [authorization] Bearer Token
|
|
119
160
|
* @param {*} [options] Override http request option.
|
|
161
|
+
* @deprecated
|
|
120
162
|
* @throws {RequiredError}
|
|
121
163
|
*/
|
|
122
|
-
|
|
164
|
+
createDashboardLegacy(createDashboardRequestDto: CreateDashboardRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateDashboardResponseClass>>;
|
|
123
165
|
/**
|
|
124
|
-
*
|
|
166
|
+
* Permanently removes a dashboard and all associated data by dashboard code. **Required Permissions** \"reporting.dashboards.delete\"
|
|
167
|
+
* @summary Deletes an existing dashboard
|
|
125
168
|
* @param {string} code
|
|
126
169
|
* @param {string} [authorization] Bearer Token
|
|
127
170
|
* @param {*} [options] Override http request option.
|
|
@@ -129,7 +172,17 @@ export declare const DashboardApiFp: (configuration?: Configuration) => {
|
|
|
129
172
|
*/
|
|
130
173
|
deleteDashboard(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponseClass>>;
|
|
131
174
|
/**
|
|
132
|
-
*
|
|
175
|
+
* Creates a copy of the specified dashboard with all its configurations and settings. **Required Permissions** \"reporting.dashboards.create\"
|
|
176
|
+
* @summary Creates a duplicate of an existing dashboard
|
|
177
|
+
* @param {string} code
|
|
178
|
+
* @param {string} [authorization] Bearer Token
|
|
179
|
+
* @param {*} [options] Override http request option.
|
|
180
|
+
* @throws {RequiredError}
|
|
181
|
+
*/
|
|
182
|
+
duplicateDashboard(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DuplicateDashboardResponseClass>>;
|
|
183
|
+
/**
|
|
184
|
+
* Creates a secure embedded URL that allows dashboard analysis and editing within external applications. **Required Permissions** \"reporting.dashboards.update\"
|
|
185
|
+
* @summary Generates an embedded URL for dashboard editing
|
|
133
186
|
* @param {string} providerDashboardId
|
|
134
187
|
* @param {string} [authorization] Bearer Token
|
|
135
188
|
* @param {*} [options] Override http request option.
|
|
@@ -137,7 +190,8 @@ export declare const DashboardApiFp: (configuration?: Configuration) => {
|
|
|
137
190
|
*/
|
|
138
191
|
getAnalysisEmbeddedUrl(providerDashboardId: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEmbeddedUrlResponseClass>>;
|
|
139
192
|
/**
|
|
140
|
-
*
|
|
193
|
+
* Fetches dashboard details by code including configuration and metadata. **Required Permissions** \"reporting.dashboards.view\"
|
|
194
|
+
* @summary Retrieves a specific dashboard
|
|
141
195
|
* @param {string} code
|
|
142
196
|
* @param {string} [authorization] Bearer Token
|
|
143
197
|
* @param {*} [options] Override http request option.
|
|
@@ -145,7 +199,8 @@ export declare const DashboardApiFp: (configuration?: Configuration) => {
|
|
|
145
199
|
*/
|
|
146
200
|
getDashboard(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetDashboardResponseClass>>;
|
|
147
201
|
/**
|
|
148
|
-
*
|
|
202
|
+
* Creates a secure embedded URL that allows dashboard content to be displayed within external applications. **Required Permissions** \"reporting.dashboards.view\"
|
|
203
|
+
* @summary Generates an embedded URL for dashboard viewing
|
|
149
204
|
* @param {string} providerDashboardId
|
|
150
205
|
* @param {string} [authorization] Bearer Token
|
|
151
206
|
* @param {*} [options] Override http request option.
|
|
@@ -153,7 +208,8 @@ export declare const DashboardApiFp: (configuration?: Configuration) => {
|
|
|
153
208
|
*/
|
|
154
209
|
getDashboardEmbeddedUrl(providerDashboardId: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEmbeddedUrlResponseClass>>;
|
|
155
210
|
/**
|
|
156
|
-
*
|
|
211
|
+
* Fetches a paginated list of dashboards with optional filtering and sorting capabilities. **Required Permissions** \"reporting.dashboards.view\"
|
|
212
|
+
* @summary Retrieves a list of dashboards
|
|
157
213
|
* @param {string} [authorization] Bearer Token
|
|
158
214
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
159
215
|
* @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.
|
|
@@ -167,7 +223,8 @@ export declare const DashboardApiFp: (configuration?: Configuration) => {
|
|
|
167
223
|
*/
|
|
168
224
|
listDashboards(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListDashboardsResponseClass>>;
|
|
169
225
|
/**
|
|
170
|
-
*
|
|
226
|
+
* Makes a dashboard publicly available by publishing it from draft or analysis state. **Required Permissions** \"reporting.dashboards.update\"
|
|
227
|
+
* @summary Publishes a dashboard for general access
|
|
171
228
|
* @param {PublishDashboardRequestDto} publishDashboardRequestDto
|
|
172
229
|
* @param {string} [authorization] Bearer Token
|
|
173
230
|
* @param {*} [options] Override http request option.
|
|
@@ -175,7 +232,8 @@ export declare const DashboardApiFp: (configuration?: Configuration) => {
|
|
|
175
232
|
*/
|
|
176
233
|
publishDashboard(publishDashboardRequestDto: PublishDashboardRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
177
234
|
/**
|
|
178
|
-
*
|
|
235
|
+
* Rolls back dashboard analysis changes to restore the previous version or state. **Required Permissions** \"reporting.dashboards.update\"
|
|
236
|
+
* @summary Reverts dashboard analysis to previous state
|
|
179
237
|
* @param {RevertAnalysisRequestDto} revertAnalysisRequestDto
|
|
180
238
|
* @param {string} [authorization] Bearer Token
|
|
181
239
|
* @param {*} [options] Override http request option.
|
|
@@ -183,7 +241,8 @@ export declare const DashboardApiFp: (configuration?: Configuration) => {
|
|
|
183
241
|
*/
|
|
184
242
|
revertAnalysis(revertAnalysisRequestDto: RevertAnalysisRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
185
243
|
/**
|
|
186
|
-
*
|
|
244
|
+
* Modifies dashboard properties, configuration, or metadata by dashboard code. **Required Permissions** \"reporting.dashboards.update\"
|
|
245
|
+
* @summary Updates an existing dashboard
|
|
187
246
|
* @param {string} code
|
|
188
247
|
* @param {UpdateDashboardRequestDto} updateDashboardRequestDto
|
|
189
248
|
* @param {string} [authorization] Bearer Token
|
|
@@ -198,15 +257,27 @@ export declare const DashboardApiFp: (configuration?: Configuration) => {
|
|
|
198
257
|
*/
|
|
199
258
|
export declare const DashboardApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
200
259
|
/**
|
|
201
|
-
*
|
|
260
|
+
* Creates a new dashboard using the preconfigured analysis id **Required Permissions** \"reporting.dashboards.create\"
|
|
261
|
+
* @summary Creates a new dashboard
|
|
262
|
+
* @param {CreateDashboardV2RequestDto} createDashboardV2RequestDto
|
|
263
|
+
* @param {string} [authorization] Bearer Token
|
|
264
|
+
* @param {*} [options] Override http request option.
|
|
265
|
+
* @throws {RequiredError}
|
|
266
|
+
*/
|
|
267
|
+
createDashboard(createDashboardV2RequestDto: CreateDashboardV2RequestDto, authorization?: string, options?: any): AxiosPromise<CreateDashboardV2ResponseClass>;
|
|
268
|
+
/**
|
|
269
|
+
* Creates a new dashboard from a preconfigured analysis id and dashboard id. Use POST /tenantservice/v1/dashboards instead. **Required Permissions** \"reporting.dashboards.create\"
|
|
270
|
+
* @summary Creates a new dashboard (DEPRECATED)
|
|
202
271
|
* @param {CreateDashboardRequestDto} createDashboardRequestDto
|
|
203
272
|
* @param {string} [authorization] Bearer Token
|
|
204
273
|
* @param {*} [options] Override http request option.
|
|
274
|
+
* @deprecated
|
|
205
275
|
* @throws {RequiredError}
|
|
206
276
|
*/
|
|
207
|
-
|
|
277
|
+
createDashboardLegacy(createDashboardRequestDto: CreateDashboardRequestDto, authorization?: string, options?: any): AxiosPromise<CreateDashboardResponseClass>;
|
|
208
278
|
/**
|
|
209
|
-
*
|
|
279
|
+
* Permanently removes a dashboard and all associated data by dashboard code. **Required Permissions** \"reporting.dashboards.delete\"
|
|
280
|
+
* @summary Deletes an existing dashboard
|
|
210
281
|
* @param {string} code
|
|
211
282
|
* @param {string} [authorization] Bearer Token
|
|
212
283
|
* @param {*} [options] Override http request option.
|
|
@@ -214,7 +285,17 @@ export declare const DashboardApiFactory: (configuration?: Configuration, basePa
|
|
|
214
285
|
*/
|
|
215
286
|
deleteDashboard(code: string, authorization?: string, options?: any): AxiosPromise<DeleteResponseClass>;
|
|
216
287
|
/**
|
|
217
|
-
*
|
|
288
|
+
* Creates a copy of the specified dashboard with all its configurations and settings. **Required Permissions** \"reporting.dashboards.create\"
|
|
289
|
+
* @summary Creates a duplicate of an existing dashboard
|
|
290
|
+
* @param {string} code
|
|
291
|
+
* @param {string} [authorization] Bearer Token
|
|
292
|
+
* @param {*} [options] Override http request option.
|
|
293
|
+
* @throws {RequiredError}
|
|
294
|
+
*/
|
|
295
|
+
duplicateDashboard(code: string, authorization?: string, options?: any): AxiosPromise<DuplicateDashboardResponseClass>;
|
|
296
|
+
/**
|
|
297
|
+
* Creates a secure embedded URL that allows dashboard analysis and editing within external applications. **Required Permissions** \"reporting.dashboards.update\"
|
|
298
|
+
* @summary Generates an embedded URL for dashboard editing
|
|
218
299
|
* @param {string} providerDashboardId
|
|
219
300
|
* @param {string} [authorization] Bearer Token
|
|
220
301
|
* @param {*} [options] Override http request option.
|
|
@@ -222,7 +303,8 @@ export declare const DashboardApiFactory: (configuration?: Configuration, basePa
|
|
|
222
303
|
*/
|
|
223
304
|
getAnalysisEmbeddedUrl(providerDashboardId: string, authorization?: string, options?: any): AxiosPromise<GetEmbeddedUrlResponseClass>;
|
|
224
305
|
/**
|
|
225
|
-
*
|
|
306
|
+
* Fetches dashboard details by code including configuration and metadata. **Required Permissions** \"reporting.dashboards.view\"
|
|
307
|
+
* @summary Retrieves a specific dashboard
|
|
226
308
|
* @param {string} code
|
|
227
309
|
* @param {string} [authorization] Bearer Token
|
|
228
310
|
* @param {*} [options] Override http request option.
|
|
@@ -230,7 +312,8 @@ export declare const DashboardApiFactory: (configuration?: Configuration, basePa
|
|
|
230
312
|
*/
|
|
231
313
|
getDashboard(code: string, authorization?: string, options?: any): AxiosPromise<GetDashboardResponseClass>;
|
|
232
314
|
/**
|
|
233
|
-
*
|
|
315
|
+
* Creates a secure embedded URL that allows dashboard content to be displayed within external applications. **Required Permissions** \"reporting.dashboards.view\"
|
|
316
|
+
* @summary Generates an embedded URL for dashboard viewing
|
|
234
317
|
* @param {string} providerDashboardId
|
|
235
318
|
* @param {string} [authorization] Bearer Token
|
|
236
319
|
* @param {*} [options] Override http request option.
|
|
@@ -238,7 +321,8 @@ export declare const DashboardApiFactory: (configuration?: Configuration, basePa
|
|
|
238
321
|
*/
|
|
239
322
|
getDashboardEmbeddedUrl(providerDashboardId: string, authorization?: string, options?: any): AxiosPromise<GetEmbeddedUrlResponseClass>;
|
|
240
323
|
/**
|
|
241
|
-
*
|
|
324
|
+
* Fetches a paginated list of dashboards with optional filtering and sorting capabilities. **Required Permissions** \"reporting.dashboards.view\"
|
|
325
|
+
* @summary Retrieves a list of dashboards
|
|
242
326
|
* @param {string} [authorization] Bearer Token
|
|
243
327
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
244
328
|
* @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.
|
|
@@ -252,7 +336,8 @@ export declare const DashboardApiFactory: (configuration?: Configuration, basePa
|
|
|
252
336
|
*/
|
|
253
337
|
listDashboards(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListDashboardsResponseClass>;
|
|
254
338
|
/**
|
|
255
|
-
*
|
|
339
|
+
* Makes a dashboard publicly available by publishing it from draft or analysis state. **Required Permissions** \"reporting.dashboards.update\"
|
|
340
|
+
* @summary Publishes a dashboard for general access
|
|
256
341
|
* @param {PublishDashboardRequestDto} publishDashboardRequestDto
|
|
257
342
|
* @param {string} [authorization] Bearer Token
|
|
258
343
|
* @param {*} [options] Override http request option.
|
|
@@ -260,7 +345,8 @@ export declare const DashboardApiFactory: (configuration?: Configuration, basePa
|
|
|
260
345
|
*/
|
|
261
346
|
publishDashboard(publishDashboardRequestDto: PublishDashboardRequestDto, authorization?: string, options?: any): AxiosPromise<void>;
|
|
262
347
|
/**
|
|
263
|
-
*
|
|
348
|
+
* Rolls back dashboard analysis changes to restore the previous version or state. **Required Permissions** \"reporting.dashboards.update\"
|
|
349
|
+
* @summary Reverts dashboard analysis to previous state
|
|
264
350
|
* @param {RevertAnalysisRequestDto} revertAnalysisRequestDto
|
|
265
351
|
* @param {string} [authorization] Bearer Token
|
|
266
352
|
* @param {*} [options] Override http request option.
|
|
@@ -268,7 +354,8 @@ export declare const DashboardApiFactory: (configuration?: Configuration, basePa
|
|
|
268
354
|
*/
|
|
269
355
|
revertAnalysis(revertAnalysisRequestDto: RevertAnalysisRequestDto, authorization?: string, options?: any): AxiosPromise<void>;
|
|
270
356
|
/**
|
|
271
|
-
*
|
|
357
|
+
* Modifies dashboard properties, configuration, or metadata by dashboard code. **Required Permissions** \"reporting.dashboards.update\"
|
|
358
|
+
* @summary Updates an existing dashboard
|
|
272
359
|
* @param {string} code
|
|
273
360
|
* @param {UpdateDashboardRequestDto} updateDashboardRequestDto
|
|
274
361
|
* @param {string} [authorization] Bearer Token
|
|
@@ -285,10 +372,10 @@ export declare const DashboardApiFactory: (configuration?: Configuration, basePa
|
|
|
285
372
|
export interface DashboardApiCreateDashboardRequest {
|
|
286
373
|
/**
|
|
287
374
|
*
|
|
288
|
-
* @type {
|
|
375
|
+
* @type {CreateDashboardV2RequestDto}
|
|
289
376
|
* @memberof DashboardApiCreateDashboard
|
|
290
377
|
*/
|
|
291
|
-
readonly
|
|
378
|
+
readonly createDashboardV2RequestDto: CreateDashboardV2RequestDto;
|
|
292
379
|
/**
|
|
293
380
|
* Bearer Token
|
|
294
381
|
* @type {string}
|
|
@@ -296,6 +383,25 @@ export interface DashboardApiCreateDashboardRequest {
|
|
|
296
383
|
*/
|
|
297
384
|
readonly authorization?: string;
|
|
298
385
|
}
|
|
386
|
+
/**
|
|
387
|
+
* Request parameters for createDashboardLegacy operation in DashboardApi.
|
|
388
|
+
* @export
|
|
389
|
+
* @interface DashboardApiCreateDashboardLegacyRequest
|
|
390
|
+
*/
|
|
391
|
+
export interface DashboardApiCreateDashboardLegacyRequest {
|
|
392
|
+
/**
|
|
393
|
+
*
|
|
394
|
+
* @type {CreateDashboardRequestDto}
|
|
395
|
+
* @memberof DashboardApiCreateDashboardLegacy
|
|
396
|
+
*/
|
|
397
|
+
readonly createDashboardRequestDto: CreateDashboardRequestDto;
|
|
398
|
+
/**
|
|
399
|
+
* Bearer Token
|
|
400
|
+
* @type {string}
|
|
401
|
+
* @memberof DashboardApiCreateDashboardLegacy
|
|
402
|
+
*/
|
|
403
|
+
readonly authorization?: string;
|
|
404
|
+
}
|
|
299
405
|
/**
|
|
300
406
|
* Request parameters for deleteDashboard operation in DashboardApi.
|
|
301
407
|
* @export
|
|
@@ -315,6 +421,25 @@ export interface DashboardApiDeleteDashboardRequest {
|
|
|
315
421
|
*/
|
|
316
422
|
readonly authorization?: string;
|
|
317
423
|
}
|
|
424
|
+
/**
|
|
425
|
+
* Request parameters for duplicateDashboard operation in DashboardApi.
|
|
426
|
+
* @export
|
|
427
|
+
* @interface DashboardApiDuplicateDashboardRequest
|
|
428
|
+
*/
|
|
429
|
+
export interface DashboardApiDuplicateDashboardRequest {
|
|
430
|
+
/**
|
|
431
|
+
*
|
|
432
|
+
* @type {string}
|
|
433
|
+
* @memberof DashboardApiDuplicateDashboard
|
|
434
|
+
*/
|
|
435
|
+
readonly code: string;
|
|
436
|
+
/**
|
|
437
|
+
* Bearer Token
|
|
438
|
+
* @type {string}
|
|
439
|
+
* @memberof DashboardApiDuplicateDashboard
|
|
440
|
+
*/
|
|
441
|
+
readonly authorization?: string;
|
|
442
|
+
}
|
|
318
443
|
/**
|
|
319
444
|
* Request parameters for getAnalysisEmbeddedUrl operation in DashboardApi.
|
|
320
445
|
* @export
|
|
@@ -498,15 +623,27 @@ export interface DashboardApiUpdateDashboardRequest {
|
|
|
498
623
|
*/
|
|
499
624
|
export declare class DashboardApi extends BaseAPI {
|
|
500
625
|
/**
|
|
501
|
-
*
|
|
626
|
+
* Creates a new dashboard using the preconfigured analysis id **Required Permissions** \"reporting.dashboards.create\"
|
|
627
|
+
* @summary Creates a new dashboard
|
|
502
628
|
* @param {DashboardApiCreateDashboardRequest} requestParameters Request parameters.
|
|
503
629
|
* @param {*} [options] Override http request option.
|
|
504
630
|
* @throws {RequiredError}
|
|
505
631
|
* @memberof DashboardApi
|
|
506
632
|
*/
|
|
507
|
-
createDashboard(requestParameters: DashboardApiCreateDashboardRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
633
|
+
createDashboard(requestParameters: DashboardApiCreateDashboardRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateDashboardV2ResponseClass, any>>;
|
|
634
|
+
/**
|
|
635
|
+
* Creates a new dashboard from a preconfigured analysis id and dashboard id. Use POST /tenantservice/v1/dashboards instead. **Required Permissions** \"reporting.dashboards.create\"
|
|
636
|
+
* @summary Creates a new dashboard (DEPRECATED)
|
|
637
|
+
* @param {DashboardApiCreateDashboardLegacyRequest} requestParameters Request parameters.
|
|
638
|
+
* @param {*} [options] Override http request option.
|
|
639
|
+
* @deprecated
|
|
640
|
+
* @throws {RequiredError}
|
|
641
|
+
* @memberof DashboardApi
|
|
642
|
+
*/
|
|
643
|
+
createDashboardLegacy(requestParameters: DashboardApiCreateDashboardLegacyRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateDashboardResponseClass, any>>;
|
|
508
644
|
/**
|
|
509
|
-
*
|
|
645
|
+
* Permanently removes a dashboard and all associated data by dashboard code. **Required Permissions** \"reporting.dashboards.delete\"
|
|
646
|
+
* @summary Deletes an existing dashboard
|
|
510
647
|
* @param {DashboardApiDeleteDashboardRequest} requestParameters Request parameters.
|
|
511
648
|
* @param {*} [options] Override http request option.
|
|
512
649
|
* @throws {RequiredError}
|
|
@@ -514,7 +651,17 @@ export declare class DashboardApi extends BaseAPI {
|
|
|
514
651
|
*/
|
|
515
652
|
deleteDashboard(requestParameters: DashboardApiDeleteDashboardRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteResponseClass, any>>;
|
|
516
653
|
/**
|
|
517
|
-
*
|
|
654
|
+
* Creates a copy of the specified dashboard with all its configurations and settings. **Required Permissions** \"reporting.dashboards.create\"
|
|
655
|
+
* @summary Creates a duplicate of an existing dashboard
|
|
656
|
+
* @param {DashboardApiDuplicateDashboardRequest} requestParameters Request parameters.
|
|
657
|
+
* @param {*} [options] Override http request option.
|
|
658
|
+
* @throws {RequiredError}
|
|
659
|
+
* @memberof DashboardApi
|
|
660
|
+
*/
|
|
661
|
+
duplicateDashboard(requestParameters: DashboardApiDuplicateDashboardRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DuplicateDashboardResponseClass, any>>;
|
|
662
|
+
/**
|
|
663
|
+
* Creates a secure embedded URL that allows dashboard analysis and editing within external applications. **Required Permissions** \"reporting.dashboards.update\"
|
|
664
|
+
* @summary Generates an embedded URL for dashboard editing
|
|
518
665
|
* @param {DashboardApiGetAnalysisEmbeddedUrlRequest} requestParameters Request parameters.
|
|
519
666
|
* @param {*} [options] Override http request option.
|
|
520
667
|
* @throws {RequiredError}
|
|
@@ -522,7 +669,8 @@ export declare class DashboardApi extends BaseAPI {
|
|
|
522
669
|
*/
|
|
523
670
|
getAnalysisEmbeddedUrl(requestParameters: DashboardApiGetAnalysisEmbeddedUrlRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetEmbeddedUrlResponseClass, any>>;
|
|
524
671
|
/**
|
|
525
|
-
*
|
|
672
|
+
* Fetches dashboard details by code including configuration and metadata. **Required Permissions** \"reporting.dashboards.view\"
|
|
673
|
+
* @summary Retrieves a specific dashboard
|
|
526
674
|
* @param {DashboardApiGetDashboardRequest} requestParameters Request parameters.
|
|
527
675
|
* @param {*} [options] Override http request option.
|
|
528
676
|
* @throws {RequiredError}
|
|
@@ -530,7 +678,8 @@ export declare class DashboardApi extends BaseAPI {
|
|
|
530
678
|
*/
|
|
531
679
|
getDashboard(requestParameters: DashboardApiGetDashboardRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetDashboardResponseClass, any>>;
|
|
532
680
|
/**
|
|
533
|
-
*
|
|
681
|
+
* Creates a secure embedded URL that allows dashboard content to be displayed within external applications. **Required Permissions** \"reporting.dashboards.view\"
|
|
682
|
+
* @summary Generates an embedded URL for dashboard viewing
|
|
534
683
|
* @param {DashboardApiGetDashboardEmbeddedUrlRequest} requestParameters Request parameters.
|
|
535
684
|
* @param {*} [options] Override http request option.
|
|
536
685
|
* @throws {RequiredError}
|
|
@@ -538,7 +687,8 @@ export declare class DashboardApi extends BaseAPI {
|
|
|
538
687
|
*/
|
|
539
688
|
getDashboardEmbeddedUrl(requestParameters: DashboardApiGetDashboardEmbeddedUrlRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetEmbeddedUrlResponseClass, any>>;
|
|
540
689
|
/**
|
|
541
|
-
*
|
|
690
|
+
* Fetches a paginated list of dashboards with optional filtering and sorting capabilities. **Required Permissions** \"reporting.dashboards.view\"
|
|
691
|
+
* @summary Retrieves a list of dashboards
|
|
542
692
|
* @param {DashboardApiListDashboardsRequest} requestParameters Request parameters.
|
|
543
693
|
* @param {*} [options] Override http request option.
|
|
544
694
|
* @throws {RequiredError}
|
|
@@ -546,7 +696,8 @@ export declare class DashboardApi extends BaseAPI {
|
|
|
546
696
|
*/
|
|
547
697
|
listDashboards(requestParameters?: DashboardApiListDashboardsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListDashboardsResponseClass, any>>;
|
|
548
698
|
/**
|
|
549
|
-
*
|
|
699
|
+
* Makes a dashboard publicly available by publishing it from draft or analysis state. **Required Permissions** \"reporting.dashboards.update\"
|
|
700
|
+
* @summary Publishes a dashboard for general access
|
|
550
701
|
* @param {DashboardApiPublishDashboardRequest} requestParameters Request parameters.
|
|
551
702
|
* @param {*} [options] Override http request option.
|
|
552
703
|
* @throws {RequiredError}
|
|
@@ -554,7 +705,8 @@ export declare class DashboardApi extends BaseAPI {
|
|
|
554
705
|
*/
|
|
555
706
|
publishDashboard(requestParameters: DashboardApiPublishDashboardRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
556
707
|
/**
|
|
557
|
-
*
|
|
708
|
+
* Rolls back dashboard analysis changes to restore the previous version or state. **Required Permissions** \"reporting.dashboards.update\"
|
|
709
|
+
* @summary Reverts dashboard analysis to previous state
|
|
558
710
|
* @param {DashboardApiRevertAnalysisRequest} requestParameters Request parameters.
|
|
559
711
|
* @param {*} [options] Override http request option.
|
|
560
712
|
* @throws {RequiredError}
|
|
@@ -562,7 +714,8 @@ export declare class DashboardApi extends BaseAPI {
|
|
|
562
714
|
*/
|
|
563
715
|
revertAnalysis(requestParameters: DashboardApiRevertAnalysisRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
564
716
|
/**
|
|
565
|
-
*
|
|
717
|
+
* Modifies dashboard properties, configuration, or metadata by dashboard code. **Required Permissions** \"reporting.dashboards.update\"
|
|
718
|
+
* @summary Updates an existing dashboard
|
|
566
719
|
* @param {DashboardApiUpdateDashboardRequest} requestParameters Request parameters.
|
|
567
720
|
* @param {*} [options] Override http request option.
|
|
568
721
|
* @throws {RequiredError}
|