@emilgroup/tenant-sdk 1.31.1-beta.0 → 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
|
@@ -14,6 +14,8 @@ 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';
|
|
18
20
|
import { GetDashboardResponseClass } from '../models';
|
|
19
21
|
import { GetEmbeddedUrlResponseClass } from '../models';
|
|
@@ -28,15 +30,27 @@ import { UpdateDashboardResponseClass } from '../models';
|
|
|
28
30
|
*/
|
|
29
31
|
export declare const DashboardApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
30
32
|
/**
|
|
31
|
-
*
|
|
33
|
+
* Creates a new dashboard using the preconfigured analysis id **Required Permissions** \"reporting.dashboards.create\"
|
|
34
|
+
* @summary Creates a new dashboard
|
|
35
|
+
* @param {CreateDashboardV2RequestDto} createDashboardV2RequestDto
|
|
36
|
+
* @param {string} [authorization] Bearer Token
|
|
37
|
+
* @param {*} [options] Override http request option.
|
|
38
|
+
* @throws {RequiredError}
|
|
39
|
+
*/
|
|
40
|
+
createDashboard: (createDashboardV2RequestDto: CreateDashboardV2RequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
41
|
+
/**
|
|
42
|
+
* Creates a new dashboard from a preconfigured analysis id and dashboard id. Use POST /tenantservice/v1/dashboards instead. **Required Permissions** \"reporting.dashboards.create\"
|
|
43
|
+
* @summary Creates a new dashboard (DEPRECATED)
|
|
32
44
|
* @param {CreateDashboardRequestDto} createDashboardRequestDto
|
|
33
45
|
* @param {string} [authorization] Bearer Token
|
|
34
46
|
* @param {*} [options] Override http request option.
|
|
47
|
+
* @deprecated
|
|
35
48
|
* @throws {RequiredError}
|
|
36
49
|
*/
|
|
37
|
-
|
|
50
|
+
createDashboardLegacy: (createDashboardRequestDto: CreateDashboardRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
38
51
|
/**
|
|
39
|
-
*
|
|
52
|
+
* Permanently removes a dashboard and all associated data by dashboard code. **Required Permissions** \"reporting.dashboards.delete\"
|
|
53
|
+
* @summary Deletes an existing dashboard
|
|
40
54
|
* @param {string} code
|
|
41
55
|
* @param {string} [authorization] Bearer Token
|
|
42
56
|
* @param {*} [options] Override http request option.
|
|
@@ -44,7 +58,8 @@ export declare const DashboardApiAxiosParamCreator: (configuration?: Configurati
|
|
|
44
58
|
*/
|
|
45
59
|
deleteDashboard: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
46
60
|
/**
|
|
47
|
-
*
|
|
61
|
+
* Creates a secure embedded URL that allows dashboard analysis and editing within external applications. **Required Permissions** \"reporting.dashboards.update\"
|
|
62
|
+
* @summary Generates an embedded URL for dashboard editing
|
|
48
63
|
* @param {string} providerDashboardId
|
|
49
64
|
* @param {string} [authorization] Bearer Token
|
|
50
65
|
* @param {*} [options] Override http request option.
|
|
@@ -52,7 +67,8 @@ export declare const DashboardApiAxiosParamCreator: (configuration?: Configurati
|
|
|
52
67
|
*/
|
|
53
68
|
getAnalysisEmbeddedUrl: (providerDashboardId: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
54
69
|
/**
|
|
55
|
-
*
|
|
70
|
+
* Fetches dashboard details by code including configuration and metadata. **Required Permissions** \"reporting.dashboards.view\"
|
|
71
|
+
* @summary Retrieves a specific dashboard
|
|
56
72
|
* @param {string} code
|
|
57
73
|
* @param {string} [authorization] Bearer Token
|
|
58
74
|
* @param {*} [options] Override http request option.
|
|
@@ -60,7 +76,8 @@ export declare const DashboardApiAxiosParamCreator: (configuration?: Configurati
|
|
|
60
76
|
*/
|
|
61
77
|
getDashboard: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
62
78
|
/**
|
|
63
|
-
*
|
|
79
|
+
* Creates a secure embedded URL that allows dashboard content to be displayed within external applications. **Required Permissions** \"reporting.dashboards.view\"
|
|
80
|
+
* @summary Generates an embedded URL for dashboard viewing
|
|
64
81
|
* @param {string} providerDashboardId
|
|
65
82
|
* @param {string} [authorization] Bearer Token
|
|
66
83
|
* @param {*} [options] Override http request option.
|
|
@@ -68,7 +85,8 @@ export declare const DashboardApiAxiosParamCreator: (configuration?: Configurati
|
|
|
68
85
|
*/
|
|
69
86
|
getDashboardEmbeddedUrl: (providerDashboardId: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
70
87
|
/**
|
|
71
|
-
*
|
|
88
|
+
* Fetches a paginated list of dashboards with optional filtering and sorting capabilities. **Required Permissions** \"reporting.dashboards.view\"
|
|
89
|
+
* @summary Retrieves a list of dashboards
|
|
72
90
|
* @param {string} [authorization] Bearer Token
|
|
73
91
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
74
92
|
* @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 +100,8 @@ export declare const DashboardApiAxiosParamCreator: (configuration?: Configurati
|
|
|
82
100
|
*/
|
|
83
101
|
listDashboards: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
84
102
|
/**
|
|
85
|
-
*
|
|
103
|
+
* Makes a dashboard publicly available by publishing it from draft or analysis state. **Required Permissions** \"reporting.dashboards.update\"
|
|
104
|
+
* @summary Publishes a dashboard for general access
|
|
86
105
|
* @param {PublishDashboardRequestDto} publishDashboardRequestDto
|
|
87
106
|
* @param {string} [authorization] Bearer Token
|
|
88
107
|
* @param {*} [options] Override http request option.
|
|
@@ -90,7 +109,8 @@ export declare const DashboardApiAxiosParamCreator: (configuration?: Configurati
|
|
|
90
109
|
*/
|
|
91
110
|
publishDashboard: (publishDashboardRequestDto: PublishDashboardRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
92
111
|
/**
|
|
93
|
-
*
|
|
112
|
+
* Rolls back dashboard analysis changes to restore the previous version or state. **Required Permissions** \"reporting.dashboards.update\"
|
|
113
|
+
* @summary Reverts dashboard analysis to previous state
|
|
94
114
|
* @param {RevertAnalysisRequestDto} revertAnalysisRequestDto
|
|
95
115
|
* @param {string} [authorization] Bearer Token
|
|
96
116
|
* @param {*} [options] Override http request option.
|
|
@@ -98,7 +118,8 @@ export declare const DashboardApiAxiosParamCreator: (configuration?: Configurati
|
|
|
98
118
|
*/
|
|
99
119
|
revertAnalysis: (revertAnalysisRequestDto: RevertAnalysisRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
100
120
|
/**
|
|
101
|
-
*
|
|
121
|
+
* Modifies dashboard properties, configuration, or metadata by dashboard code. **Required Permissions** \"reporting.dashboards.update\"
|
|
122
|
+
* @summary Updates an existing dashboard
|
|
102
123
|
* @param {string} code
|
|
103
124
|
* @param {UpdateDashboardRequestDto} updateDashboardRequestDto
|
|
104
125
|
* @param {string} [authorization] Bearer Token
|
|
@@ -113,15 +134,27 @@ export declare const DashboardApiAxiosParamCreator: (configuration?: Configurati
|
|
|
113
134
|
*/
|
|
114
135
|
export declare const DashboardApiFp: (configuration?: Configuration) => {
|
|
115
136
|
/**
|
|
116
|
-
*
|
|
137
|
+
* Creates a new dashboard using the preconfigured analysis id **Required Permissions** \"reporting.dashboards.create\"
|
|
138
|
+
* @summary Creates a new dashboard
|
|
139
|
+
* @param {CreateDashboardV2RequestDto} createDashboardV2RequestDto
|
|
140
|
+
* @param {string} [authorization] Bearer Token
|
|
141
|
+
* @param {*} [options] Override http request option.
|
|
142
|
+
* @throws {RequiredError}
|
|
143
|
+
*/
|
|
144
|
+
createDashboard(createDashboardV2RequestDto: CreateDashboardV2RequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateDashboardV2ResponseClass>>;
|
|
145
|
+
/**
|
|
146
|
+
* Creates a new dashboard from a preconfigured analysis id and dashboard id. Use POST /tenantservice/v1/dashboards instead. **Required Permissions** \"reporting.dashboards.create\"
|
|
147
|
+
* @summary Creates a new dashboard (DEPRECATED)
|
|
117
148
|
* @param {CreateDashboardRequestDto} createDashboardRequestDto
|
|
118
149
|
* @param {string} [authorization] Bearer Token
|
|
119
150
|
* @param {*} [options] Override http request option.
|
|
151
|
+
* @deprecated
|
|
120
152
|
* @throws {RequiredError}
|
|
121
153
|
*/
|
|
122
|
-
|
|
154
|
+
createDashboardLegacy(createDashboardRequestDto: CreateDashboardRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateDashboardResponseClass>>;
|
|
123
155
|
/**
|
|
124
|
-
*
|
|
156
|
+
* Permanently removes a dashboard and all associated data by dashboard code. **Required Permissions** \"reporting.dashboards.delete\"
|
|
157
|
+
* @summary Deletes an existing dashboard
|
|
125
158
|
* @param {string} code
|
|
126
159
|
* @param {string} [authorization] Bearer Token
|
|
127
160
|
* @param {*} [options] Override http request option.
|
|
@@ -129,7 +162,8 @@ export declare const DashboardApiFp: (configuration?: Configuration) => {
|
|
|
129
162
|
*/
|
|
130
163
|
deleteDashboard(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponseClass>>;
|
|
131
164
|
/**
|
|
132
|
-
*
|
|
165
|
+
* Creates a secure embedded URL that allows dashboard analysis and editing within external applications. **Required Permissions** \"reporting.dashboards.update\"
|
|
166
|
+
* @summary Generates an embedded URL for dashboard editing
|
|
133
167
|
* @param {string} providerDashboardId
|
|
134
168
|
* @param {string} [authorization] Bearer Token
|
|
135
169
|
* @param {*} [options] Override http request option.
|
|
@@ -137,7 +171,8 @@ export declare const DashboardApiFp: (configuration?: Configuration) => {
|
|
|
137
171
|
*/
|
|
138
172
|
getAnalysisEmbeddedUrl(providerDashboardId: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEmbeddedUrlResponseClass>>;
|
|
139
173
|
/**
|
|
140
|
-
*
|
|
174
|
+
* Fetches dashboard details by code including configuration and metadata. **Required Permissions** \"reporting.dashboards.view\"
|
|
175
|
+
* @summary Retrieves a specific dashboard
|
|
141
176
|
* @param {string} code
|
|
142
177
|
* @param {string} [authorization] Bearer Token
|
|
143
178
|
* @param {*} [options] Override http request option.
|
|
@@ -145,7 +180,8 @@ export declare const DashboardApiFp: (configuration?: Configuration) => {
|
|
|
145
180
|
*/
|
|
146
181
|
getDashboard(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetDashboardResponseClass>>;
|
|
147
182
|
/**
|
|
148
|
-
*
|
|
183
|
+
* Creates a secure embedded URL that allows dashboard content to be displayed within external applications. **Required Permissions** \"reporting.dashboards.view\"
|
|
184
|
+
* @summary Generates an embedded URL for dashboard viewing
|
|
149
185
|
* @param {string} providerDashboardId
|
|
150
186
|
* @param {string} [authorization] Bearer Token
|
|
151
187
|
* @param {*} [options] Override http request option.
|
|
@@ -153,7 +189,8 @@ export declare const DashboardApiFp: (configuration?: Configuration) => {
|
|
|
153
189
|
*/
|
|
154
190
|
getDashboardEmbeddedUrl(providerDashboardId: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEmbeddedUrlResponseClass>>;
|
|
155
191
|
/**
|
|
156
|
-
*
|
|
192
|
+
* Fetches a paginated list of dashboards with optional filtering and sorting capabilities. **Required Permissions** \"reporting.dashboards.view\"
|
|
193
|
+
* @summary Retrieves a list of dashboards
|
|
157
194
|
* @param {string} [authorization] Bearer Token
|
|
158
195
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
159
196
|
* @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 +204,8 @@ export declare const DashboardApiFp: (configuration?: Configuration) => {
|
|
|
167
204
|
*/
|
|
168
205
|
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
206
|
/**
|
|
170
|
-
*
|
|
207
|
+
* Makes a dashboard publicly available by publishing it from draft or analysis state. **Required Permissions** \"reporting.dashboards.update\"
|
|
208
|
+
* @summary Publishes a dashboard for general access
|
|
171
209
|
* @param {PublishDashboardRequestDto} publishDashboardRequestDto
|
|
172
210
|
* @param {string} [authorization] Bearer Token
|
|
173
211
|
* @param {*} [options] Override http request option.
|
|
@@ -175,7 +213,8 @@ export declare const DashboardApiFp: (configuration?: Configuration) => {
|
|
|
175
213
|
*/
|
|
176
214
|
publishDashboard(publishDashboardRequestDto: PublishDashboardRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
177
215
|
/**
|
|
178
|
-
*
|
|
216
|
+
* Rolls back dashboard analysis changes to restore the previous version or state. **Required Permissions** \"reporting.dashboards.update\"
|
|
217
|
+
* @summary Reverts dashboard analysis to previous state
|
|
179
218
|
* @param {RevertAnalysisRequestDto} revertAnalysisRequestDto
|
|
180
219
|
* @param {string} [authorization] Bearer Token
|
|
181
220
|
* @param {*} [options] Override http request option.
|
|
@@ -183,7 +222,8 @@ export declare const DashboardApiFp: (configuration?: Configuration) => {
|
|
|
183
222
|
*/
|
|
184
223
|
revertAnalysis(revertAnalysisRequestDto: RevertAnalysisRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
185
224
|
/**
|
|
186
|
-
*
|
|
225
|
+
* Modifies dashboard properties, configuration, or metadata by dashboard code. **Required Permissions** \"reporting.dashboards.update\"
|
|
226
|
+
* @summary Updates an existing dashboard
|
|
187
227
|
* @param {string} code
|
|
188
228
|
* @param {UpdateDashboardRequestDto} updateDashboardRequestDto
|
|
189
229
|
* @param {string} [authorization] Bearer Token
|
|
@@ -198,15 +238,27 @@ export declare const DashboardApiFp: (configuration?: Configuration) => {
|
|
|
198
238
|
*/
|
|
199
239
|
export declare const DashboardApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
200
240
|
/**
|
|
201
|
-
*
|
|
241
|
+
* Creates a new dashboard using the preconfigured analysis id **Required Permissions** \"reporting.dashboards.create\"
|
|
242
|
+
* @summary Creates a new dashboard
|
|
243
|
+
* @param {CreateDashboardV2RequestDto} createDashboardV2RequestDto
|
|
244
|
+
* @param {string} [authorization] Bearer Token
|
|
245
|
+
* @param {*} [options] Override http request option.
|
|
246
|
+
* @throws {RequiredError}
|
|
247
|
+
*/
|
|
248
|
+
createDashboard(createDashboardV2RequestDto: CreateDashboardV2RequestDto, authorization?: string, options?: any): AxiosPromise<CreateDashboardV2ResponseClass>;
|
|
249
|
+
/**
|
|
250
|
+
* Creates a new dashboard from a preconfigured analysis id and dashboard id. Use POST /tenantservice/v1/dashboards instead. **Required Permissions** \"reporting.dashboards.create\"
|
|
251
|
+
* @summary Creates a new dashboard (DEPRECATED)
|
|
202
252
|
* @param {CreateDashboardRequestDto} createDashboardRequestDto
|
|
203
253
|
* @param {string} [authorization] Bearer Token
|
|
204
254
|
* @param {*} [options] Override http request option.
|
|
255
|
+
* @deprecated
|
|
205
256
|
* @throws {RequiredError}
|
|
206
257
|
*/
|
|
207
|
-
|
|
258
|
+
createDashboardLegacy(createDashboardRequestDto: CreateDashboardRequestDto, authorization?: string, options?: any): AxiosPromise<CreateDashboardResponseClass>;
|
|
208
259
|
/**
|
|
209
|
-
*
|
|
260
|
+
* Permanently removes a dashboard and all associated data by dashboard code. **Required Permissions** \"reporting.dashboards.delete\"
|
|
261
|
+
* @summary Deletes an existing dashboard
|
|
210
262
|
* @param {string} code
|
|
211
263
|
* @param {string} [authorization] Bearer Token
|
|
212
264
|
* @param {*} [options] Override http request option.
|
|
@@ -214,7 +266,8 @@ export declare const DashboardApiFactory: (configuration?: Configuration, basePa
|
|
|
214
266
|
*/
|
|
215
267
|
deleteDashboard(code: string, authorization?: string, options?: any): AxiosPromise<DeleteResponseClass>;
|
|
216
268
|
/**
|
|
217
|
-
*
|
|
269
|
+
* Creates a secure embedded URL that allows dashboard analysis and editing within external applications. **Required Permissions** \"reporting.dashboards.update\"
|
|
270
|
+
* @summary Generates an embedded URL for dashboard editing
|
|
218
271
|
* @param {string} providerDashboardId
|
|
219
272
|
* @param {string} [authorization] Bearer Token
|
|
220
273
|
* @param {*} [options] Override http request option.
|
|
@@ -222,7 +275,8 @@ export declare const DashboardApiFactory: (configuration?: Configuration, basePa
|
|
|
222
275
|
*/
|
|
223
276
|
getAnalysisEmbeddedUrl(providerDashboardId: string, authorization?: string, options?: any): AxiosPromise<GetEmbeddedUrlResponseClass>;
|
|
224
277
|
/**
|
|
225
|
-
*
|
|
278
|
+
* Fetches dashboard details by code including configuration and metadata. **Required Permissions** \"reporting.dashboards.view\"
|
|
279
|
+
* @summary Retrieves a specific dashboard
|
|
226
280
|
* @param {string} code
|
|
227
281
|
* @param {string} [authorization] Bearer Token
|
|
228
282
|
* @param {*} [options] Override http request option.
|
|
@@ -230,7 +284,8 @@ export declare const DashboardApiFactory: (configuration?: Configuration, basePa
|
|
|
230
284
|
*/
|
|
231
285
|
getDashboard(code: string, authorization?: string, options?: any): AxiosPromise<GetDashboardResponseClass>;
|
|
232
286
|
/**
|
|
233
|
-
*
|
|
287
|
+
* Creates a secure embedded URL that allows dashboard content to be displayed within external applications. **Required Permissions** \"reporting.dashboards.view\"
|
|
288
|
+
* @summary Generates an embedded URL for dashboard viewing
|
|
234
289
|
* @param {string} providerDashboardId
|
|
235
290
|
* @param {string} [authorization] Bearer Token
|
|
236
291
|
* @param {*} [options] Override http request option.
|
|
@@ -238,7 +293,8 @@ export declare const DashboardApiFactory: (configuration?: Configuration, basePa
|
|
|
238
293
|
*/
|
|
239
294
|
getDashboardEmbeddedUrl(providerDashboardId: string, authorization?: string, options?: any): AxiosPromise<GetEmbeddedUrlResponseClass>;
|
|
240
295
|
/**
|
|
241
|
-
*
|
|
296
|
+
* Fetches a paginated list of dashboards with optional filtering and sorting capabilities. **Required Permissions** \"reporting.dashboards.view\"
|
|
297
|
+
* @summary Retrieves a list of dashboards
|
|
242
298
|
* @param {string} [authorization] Bearer Token
|
|
243
299
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
244
300
|
* @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 +308,8 @@ export declare const DashboardApiFactory: (configuration?: Configuration, basePa
|
|
|
252
308
|
*/
|
|
253
309
|
listDashboards(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListDashboardsResponseClass>;
|
|
254
310
|
/**
|
|
255
|
-
*
|
|
311
|
+
* Makes a dashboard publicly available by publishing it from draft or analysis state. **Required Permissions** \"reporting.dashboards.update\"
|
|
312
|
+
* @summary Publishes a dashboard for general access
|
|
256
313
|
* @param {PublishDashboardRequestDto} publishDashboardRequestDto
|
|
257
314
|
* @param {string} [authorization] Bearer Token
|
|
258
315
|
* @param {*} [options] Override http request option.
|
|
@@ -260,7 +317,8 @@ export declare const DashboardApiFactory: (configuration?: Configuration, basePa
|
|
|
260
317
|
*/
|
|
261
318
|
publishDashboard(publishDashboardRequestDto: PublishDashboardRequestDto, authorization?: string, options?: any): AxiosPromise<void>;
|
|
262
319
|
/**
|
|
263
|
-
*
|
|
320
|
+
* Rolls back dashboard analysis changes to restore the previous version or state. **Required Permissions** \"reporting.dashboards.update\"
|
|
321
|
+
* @summary Reverts dashboard analysis to previous state
|
|
264
322
|
* @param {RevertAnalysisRequestDto} revertAnalysisRequestDto
|
|
265
323
|
* @param {string} [authorization] Bearer Token
|
|
266
324
|
* @param {*} [options] Override http request option.
|
|
@@ -268,7 +326,8 @@ export declare const DashboardApiFactory: (configuration?: Configuration, basePa
|
|
|
268
326
|
*/
|
|
269
327
|
revertAnalysis(revertAnalysisRequestDto: RevertAnalysisRequestDto, authorization?: string, options?: any): AxiosPromise<void>;
|
|
270
328
|
/**
|
|
271
|
-
*
|
|
329
|
+
* Modifies dashboard properties, configuration, or metadata by dashboard code. **Required Permissions** \"reporting.dashboards.update\"
|
|
330
|
+
* @summary Updates an existing dashboard
|
|
272
331
|
* @param {string} code
|
|
273
332
|
* @param {UpdateDashboardRequestDto} updateDashboardRequestDto
|
|
274
333
|
* @param {string} [authorization] Bearer Token
|
|
@@ -285,10 +344,10 @@ export declare const DashboardApiFactory: (configuration?: Configuration, basePa
|
|
|
285
344
|
export interface DashboardApiCreateDashboardRequest {
|
|
286
345
|
/**
|
|
287
346
|
*
|
|
288
|
-
* @type {
|
|
347
|
+
* @type {CreateDashboardV2RequestDto}
|
|
289
348
|
* @memberof DashboardApiCreateDashboard
|
|
290
349
|
*/
|
|
291
|
-
readonly
|
|
350
|
+
readonly createDashboardV2RequestDto: CreateDashboardV2RequestDto;
|
|
292
351
|
/**
|
|
293
352
|
* Bearer Token
|
|
294
353
|
* @type {string}
|
|
@@ -296,6 +355,25 @@ export interface DashboardApiCreateDashboardRequest {
|
|
|
296
355
|
*/
|
|
297
356
|
readonly authorization?: string;
|
|
298
357
|
}
|
|
358
|
+
/**
|
|
359
|
+
* Request parameters for createDashboardLegacy operation in DashboardApi.
|
|
360
|
+
* @export
|
|
361
|
+
* @interface DashboardApiCreateDashboardLegacyRequest
|
|
362
|
+
*/
|
|
363
|
+
export interface DashboardApiCreateDashboardLegacyRequest {
|
|
364
|
+
/**
|
|
365
|
+
*
|
|
366
|
+
* @type {CreateDashboardRequestDto}
|
|
367
|
+
* @memberof DashboardApiCreateDashboardLegacy
|
|
368
|
+
*/
|
|
369
|
+
readonly createDashboardRequestDto: CreateDashboardRequestDto;
|
|
370
|
+
/**
|
|
371
|
+
* Bearer Token
|
|
372
|
+
* @type {string}
|
|
373
|
+
* @memberof DashboardApiCreateDashboardLegacy
|
|
374
|
+
*/
|
|
375
|
+
readonly authorization?: string;
|
|
376
|
+
}
|
|
299
377
|
/**
|
|
300
378
|
* Request parameters for deleteDashboard operation in DashboardApi.
|
|
301
379
|
* @export
|
|
@@ -498,15 +576,27 @@ export interface DashboardApiUpdateDashboardRequest {
|
|
|
498
576
|
*/
|
|
499
577
|
export declare class DashboardApi extends BaseAPI {
|
|
500
578
|
/**
|
|
501
|
-
*
|
|
579
|
+
* Creates a new dashboard using the preconfigured analysis id **Required Permissions** \"reporting.dashboards.create\"
|
|
580
|
+
* @summary Creates a new dashboard
|
|
502
581
|
* @param {DashboardApiCreateDashboardRequest} requestParameters Request parameters.
|
|
503
582
|
* @param {*} [options] Override http request option.
|
|
504
583
|
* @throws {RequiredError}
|
|
505
584
|
* @memberof DashboardApi
|
|
506
585
|
*/
|
|
507
|
-
createDashboard(requestParameters: DashboardApiCreateDashboardRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
586
|
+
createDashboard(requestParameters: DashboardApiCreateDashboardRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateDashboardV2ResponseClass, any>>;
|
|
587
|
+
/**
|
|
588
|
+
* Creates a new dashboard from a preconfigured analysis id and dashboard id. Use POST /tenantservice/v1/dashboards instead. **Required Permissions** \"reporting.dashboards.create\"
|
|
589
|
+
* @summary Creates a new dashboard (DEPRECATED)
|
|
590
|
+
* @param {DashboardApiCreateDashboardLegacyRequest} requestParameters Request parameters.
|
|
591
|
+
* @param {*} [options] Override http request option.
|
|
592
|
+
* @deprecated
|
|
593
|
+
* @throws {RequiredError}
|
|
594
|
+
* @memberof DashboardApi
|
|
595
|
+
*/
|
|
596
|
+
createDashboardLegacy(requestParameters: DashboardApiCreateDashboardLegacyRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateDashboardResponseClass, any>>;
|
|
508
597
|
/**
|
|
509
|
-
*
|
|
598
|
+
* Permanently removes a dashboard and all associated data by dashboard code. **Required Permissions** \"reporting.dashboards.delete\"
|
|
599
|
+
* @summary Deletes an existing dashboard
|
|
510
600
|
* @param {DashboardApiDeleteDashboardRequest} requestParameters Request parameters.
|
|
511
601
|
* @param {*} [options] Override http request option.
|
|
512
602
|
* @throws {RequiredError}
|
|
@@ -514,7 +604,8 @@ export declare class DashboardApi extends BaseAPI {
|
|
|
514
604
|
*/
|
|
515
605
|
deleteDashboard(requestParameters: DashboardApiDeleteDashboardRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteResponseClass, any>>;
|
|
516
606
|
/**
|
|
517
|
-
*
|
|
607
|
+
* Creates a secure embedded URL that allows dashboard analysis and editing within external applications. **Required Permissions** \"reporting.dashboards.update\"
|
|
608
|
+
* @summary Generates an embedded URL for dashboard editing
|
|
518
609
|
* @param {DashboardApiGetAnalysisEmbeddedUrlRequest} requestParameters Request parameters.
|
|
519
610
|
* @param {*} [options] Override http request option.
|
|
520
611
|
* @throws {RequiredError}
|
|
@@ -522,7 +613,8 @@ export declare class DashboardApi extends BaseAPI {
|
|
|
522
613
|
*/
|
|
523
614
|
getAnalysisEmbeddedUrl(requestParameters: DashboardApiGetAnalysisEmbeddedUrlRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetEmbeddedUrlResponseClass, any>>;
|
|
524
615
|
/**
|
|
525
|
-
*
|
|
616
|
+
* Fetches dashboard details by code including configuration and metadata. **Required Permissions** \"reporting.dashboards.view\"
|
|
617
|
+
* @summary Retrieves a specific dashboard
|
|
526
618
|
* @param {DashboardApiGetDashboardRequest} requestParameters Request parameters.
|
|
527
619
|
* @param {*} [options] Override http request option.
|
|
528
620
|
* @throws {RequiredError}
|
|
@@ -530,7 +622,8 @@ export declare class DashboardApi extends BaseAPI {
|
|
|
530
622
|
*/
|
|
531
623
|
getDashboard(requestParameters: DashboardApiGetDashboardRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetDashboardResponseClass, any>>;
|
|
532
624
|
/**
|
|
533
|
-
*
|
|
625
|
+
* Creates a secure embedded URL that allows dashboard content to be displayed within external applications. **Required Permissions** \"reporting.dashboards.view\"
|
|
626
|
+
* @summary Generates an embedded URL for dashboard viewing
|
|
534
627
|
* @param {DashboardApiGetDashboardEmbeddedUrlRequest} requestParameters Request parameters.
|
|
535
628
|
* @param {*} [options] Override http request option.
|
|
536
629
|
* @throws {RequiredError}
|
|
@@ -538,7 +631,8 @@ export declare class DashboardApi extends BaseAPI {
|
|
|
538
631
|
*/
|
|
539
632
|
getDashboardEmbeddedUrl(requestParameters: DashboardApiGetDashboardEmbeddedUrlRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetEmbeddedUrlResponseClass, any>>;
|
|
540
633
|
/**
|
|
541
|
-
*
|
|
634
|
+
* Fetches a paginated list of dashboards with optional filtering and sorting capabilities. **Required Permissions** \"reporting.dashboards.view\"
|
|
635
|
+
* @summary Retrieves a list of dashboards
|
|
542
636
|
* @param {DashboardApiListDashboardsRequest} requestParameters Request parameters.
|
|
543
637
|
* @param {*} [options] Override http request option.
|
|
544
638
|
* @throws {RequiredError}
|
|
@@ -546,7 +640,8 @@ export declare class DashboardApi extends BaseAPI {
|
|
|
546
640
|
*/
|
|
547
641
|
listDashboards(requestParameters?: DashboardApiListDashboardsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListDashboardsResponseClass, any>>;
|
|
548
642
|
/**
|
|
549
|
-
*
|
|
643
|
+
* Makes a dashboard publicly available by publishing it from draft or analysis state. **Required Permissions** \"reporting.dashboards.update\"
|
|
644
|
+
* @summary Publishes a dashboard for general access
|
|
550
645
|
* @param {DashboardApiPublishDashboardRequest} requestParameters Request parameters.
|
|
551
646
|
* @param {*} [options] Override http request option.
|
|
552
647
|
* @throws {RequiredError}
|
|
@@ -554,7 +649,8 @@ export declare class DashboardApi extends BaseAPI {
|
|
|
554
649
|
*/
|
|
555
650
|
publishDashboard(requestParameters: DashboardApiPublishDashboardRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
556
651
|
/**
|
|
557
|
-
*
|
|
652
|
+
* Rolls back dashboard analysis changes to restore the previous version or state. **Required Permissions** \"reporting.dashboards.update\"
|
|
653
|
+
* @summary Reverts dashboard analysis to previous state
|
|
558
654
|
* @param {DashboardApiRevertAnalysisRequest} requestParameters Request parameters.
|
|
559
655
|
* @param {*} [options] Override http request option.
|
|
560
656
|
* @throws {RequiredError}
|
|
@@ -562,7 +658,8 @@ export declare class DashboardApi extends BaseAPI {
|
|
|
562
658
|
*/
|
|
563
659
|
revertAnalysis(requestParameters: DashboardApiRevertAnalysisRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
564
660
|
/**
|
|
565
|
-
*
|
|
661
|
+
* Modifies dashboard properties, configuration, or metadata by dashboard code. **Required Permissions** \"reporting.dashboards.update\"
|
|
662
|
+
* @summary Updates an existing dashboard
|
|
566
663
|
* @param {DashboardApiUpdateDashboardRequest} requestParameters Request parameters.
|
|
567
664
|
* @param {*} [options] Override http request option.
|
|
568
665
|
* @throws {RequiredError}
|