@emilgroup/tenant-sdk-node 1.34.1-beta.15 → 1.34.1-beta.17

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.
Files changed (63) hide show
  1. package/.openapi-generator/FILES +17 -0
  2. package/README.md +2 -2
  3. package/api/dashboard-api.ts +103 -0
  4. package/api/report-schedule-api.ts +697 -0
  5. package/api/report-schedule-logs-api.ts +250 -0
  6. package/api.ts +4 -0
  7. package/dist/api/dashboard-api.d.ts +56 -0
  8. package/dist/api/dashboard-api.js +92 -0
  9. package/dist/api/report-schedule-api.d.ts +394 -0
  10. package/dist/api/report-schedule-api.js +646 -0
  11. package/dist/api/report-schedule-logs-api.d.ts +150 -0
  12. package/dist/api/report-schedule-logs-api.js +264 -0
  13. package/dist/api.d.ts +2 -0
  14. package/dist/api.js +2 -0
  15. package/dist/models/create-report-schedule-request-dto.d.ts +115 -0
  16. package/dist/models/create-report-schedule-request-dto.js +15 -0
  17. package/dist/models/create-report-schedule-response-class.d.ts +25 -0
  18. package/dist/models/create-report-schedule-response-class.js +15 -0
  19. package/dist/models/dashboard-metadata-class.d.ts +43 -0
  20. package/dist/models/dashboard-metadata-class.js +15 -0
  21. package/dist/models/get-dashboard-metadata-response-class.d.ts +25 -0
  22. package/dist/models/get-dashboard-metadata-response-class.js +15 -0
  23. package/dist/models/get-report-schedule-response-class.d.ts +25 -0
  24. package/dist/models/get-report-schedule-response-class.js +15 -0
  25. package/dist/models/index.d.ts +15 -0
  26. package/dist/models/index.js +15 -0
  27. package/dist/models/list-report-schedule-logs-response-class.d.ts +43 -0
  28. package/dist/models/list-report-schedule-logs-response-class.js +15 -0
  29. package/dist/models/list-report-schedules-response-class.d.ts +43 -0
  30. package/dist/models/list-report-schedules-response-class.js +15 -0
  31. package/dist/models/quick-sight-analysis-parameter-class.d.ts +36 -0
  32. package/dist/models/quick-sight-analysis-parameter-class.js +15 -0
  33. package/dist/models/report-schedule-class.d.ts +157 -0
  34. package/dist/models/report-schedule-class.js +15 -0
  35. package/dist/models/report-schedule-log-class.d.ts +133 -0
  36. package/dist/models/report-schedule-log-class.js +15 -0
  37. package/dist/models/report-schedule-parameter-class.d.ts +42 -0
  38. package/dist/models/report-schedule-parameter-class.js +15 -0
  39. package/dist/models/report-schedule-parameter-dto.d.ts +42 -0
  40. package/dist/models/report-schedule-parameter-dto.js +15 -0
  41. package/dist/models/report-schedule-parameter-value-class.d.ts +30 -0
  42. package/dist/models/report-schedule-parameter-value-class.js +15 -0
  43. package/dist/models/update-report-schedule-request-dto.d.ts +121 -0
  44. package/dist/models/update-report-schedule-request-dto.js +15 -0
  45. package/dist/models/update-report-schedule-response-class.d.ts +25 -0
  46. package/dist/models/update-report-schedule-response-class.js +15 -0
  47. package/models/create-report-schedule-request-dto.ts +121 -0
  48. package/models/create-report-schedule-response-class.ts +31 -0
  49. package/models/dashboard-metadata-class.ts +49 -0
  50. package/models/get-dashboard-metadata-response-class.ts +31 -0
  51. package/models/get-report-schedule-response-class.ts +31 -0
  52. package/models/index.ts +15 -0
  53. package/models/list-report-schedule-logs-response-class.ts +49 -0
  54. package/models/list-report-schedules-response-class.ts +49 -0
  55. package/models/quick-sight-analysis-parameter-class.ts +42 -0
  56. package/models/report-schedule-class.ts +163 -0
  57. package/models/report-schedule-log-class.ts +139 -0
  58. package/models/report-schedule-parameter-class.ts +48 -0
  59. package/models/report-schedule-parameter-dto.ts +48 -0
  60. package/models/report-schedule-parameter-value-class.ts +36 -0
  61. package/models/update-report-schedule-request-dto.ts +127 -0
  62. package/models/update-report-schedule-response-class.ts +31 -0
  63. package/package.json +1 -1
@@ -0,0 +1,250 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * EMIL Tenant Service
5
+ * The EMIL TenantService API description
6
+ *
7
+ * The version of the OpenAPI document: 1.0
8
+ * Contact: kontakt@emil.de
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+ import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
17
+ import { Configuration } from '../configuration';
18
+ // Some imports not used depending on template conditions
19
+ // @ts-ignore
20
+ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
21
+ // @ts-ignore
22
+ import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
23
+ // @ts-ignore
24
+ import { ListReportScheduleLogsResponseClass } from '../models';
25
+ // URLSearchParams not necessarily used
26
+ // @ts-ignore
27
+ import { URL, URLSearchParams } from 'url';
28
+ const FormData = require('form-data');
29
+ /**
30
+ * ReportScheduleLogsApi - axios parameter creator
31
+ * @export
32
+ */
33
+ export const ReportScheduleLogsApiAxiosParamCreator = function (configuration?: Configuration) {
34
+ return {
35
+ /**
36
+ * Lists execution logs for scheduled reports **Required Permissions** \"reporting.dashboards.view\"
37
+ * @summary List report-schedule-logs
38
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
39
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
40
+ * @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.
41
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
42
+ * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
43
+ * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
44
+ * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
45
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
46
+ * @param {*} [options] Override http request option.
47
+ * @throws {RequiredError}
48
+ */
49
+ listReportScheduleLogs: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
50
+ const localVarPath = `/tenantservice/v1/report-schedule-logs`;
51
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
52
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
53
+ let baseOptions;
54
+ let baseAccessToken;
55
+ if (configuration) {
56
+ baseOptions = configuration.baseOptions;
57
+ baseAccessToken = configuration.accessToken;
58
+ }
59
+
60
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
61
+ const localVarHeaderParameter = {} as any;
62
+ const localVarQueryParameter = {} as any;
63
+
64
+ // authentication bearer required
65
+ // http bearer authentication required
66
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
67
+
68
+ if (pageSize !== undefined) {
69
+ localVarQueryParameter['pageSize'] = pageSize;
70
+ }
71
+
72
+ if (pageToken !== undefined) {
73
+ localVarQueryParameter['pageToken'] = pageToken;
74
+ }
75
+
76
+ if (filter !== undefined) {
77
+ localVarQueryParameter['filter'] = filter;
78
+ }
79
+
80
+ if (search !== undefined) {
81
+ localVarQueryParameter['search'] = search;
82
+ }
83
+
84
+ if (order !== undefined) {
85
+ localVarQueryParameter['order'] = order;
86
+ }
87
+
88
+ if (expand !== undefined) {
89
+ localVarQueryParameter['expand'] = expand;
90
+ }
91
+
92
+ if (filters !== undefined) {
93
+ localVarQueryParameter['filters'] = filters;
94
+ }
95
+
96
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
97
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
98
+ }
99
+
100
+
101
+
102
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
103
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
104
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
105
+
106
+ return {
107
+ url: toPathString(localVarUrlObj),
108
+ options: localVarRequestOptions,
109
+ };
110
+ },
111
+ }
112
+ };
113
+
114
+ /**
115
+ * ReportScheduleLogsApi - functional programming interface
116
+ * @export
117
+ */
118
+ export const ReportScheduleLogsApiFp = function(configuration?: Configuration) {
119
+ const localVarAxiosParamCreator = ReportScheduleLogsApiAxiosParamCreator(configuration)
120
+ return {
121
+ /**
122
+ * Lists execution logs for scheduled reports **Required Permissions** \"reporting.dashboards.view\"
123
+ * @summary List report-schedule-logs
124
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
125
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
126
+ * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
127
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
128
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
129
+ * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
130
+ * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
131
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
132
+ * @param {*} [options] Override http request option.
133
+ * @throws {RequiredError}
134
+ */
135
+ async listReportScheduleLogs(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListReportScheduleLogsResponseClass>> {
136
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listReportScheduleLogs(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
137
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
138
+ },
139
+ }
140
+ };
141
+
142
+ /**
143
+ * ReportScheduleLogsApi - factory interface
144
+ * @export
145
+ */
146
+ export const ReportScheduleLogsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
147
+ const localVarFp = ReportScheduleLogsApiFp(configuration)
148
+ return {
149
+ /**
150
+ * Lists execution logs for scheduled reports **Required Permissions** \"reporting.dashboards.view\"
151
+ * @summary List report-schedule-logs
152
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
153
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
154
+ * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
155
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
156
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
157
+ * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
158
+ * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
159
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
160
+ * @param {*} [options] Override http request option.
161
+ * @throws {RequiredError}
162
+ */
163
+ listReportScheduleLogs(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListReportScheduleLogsResponseClass> {
164
+ return localVarFp.listReportScheduleLogs(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
165
+ },
166
+ };
167
+ };
168
+
169
+ /**
170
+ * Request parameters for listReportScheduleLogs operation in ReportScheduleLogsApi.
171
+ * @export
172
+ * @interface ReportScheduleLogsApiListReportScheduleLogsRequest
173
+ */
174
+ export interface ReportScheduleLogsApiListReportScheduleLogsRequest {
175
+ /**
176
+ * Bearer Token: provided by the login endpoint under the name accessToken.
177
+ * @type {string}
178
+ * @memberof ReportScheduleLogsApiListReportScheduleLogs
179
+ */
180
+ readonly authorization?: string
181
+
182
+ /**
183
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
184
+ * @type {number}
185
+ * @memberof ReportScheduleLogsApiListReportScheduleLogs
186
+ */
187
+ readonly pageSize?: number
188
+
189
+ /**
190
+ * A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
191
+ * @type {string}
192
+ * @memberof ReportScheduleLogsApiListReportScheduleLogs
193
+ */
194
+ readonly pageToken?: string
195
+
196
+ /**
197
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
198
+ * @type {string}
199
+ * @memberof ReportScheduleLogsApiListReportScheduleLogs
200
+ */
201
+ readonly filter?: string
202
+
203
+ /**
204
+ * To search the list by any field, pass search&#x3D;xxx to fetch the result.
205
+ * @type {string}
206
+ * @memberof ReportScheduleLogsApiListReportScheduleLogs
207
+ */
208
+ readonly search?: string
209
+
210
+ /**
211
+ * The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
212
+ * @type {string}
213
+ * @memberof ReportScheduleLogsApiListReportScheduleLogs
214
+ */
215
+ readonly order?: string
216
+
217
+ /**
218
+ * Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
219
+ * @type {string}
220
+ * @memberof ReportScheduleLogsApiListReportScheduleLogs
221
+ */
222
+ readonly expand?: string
223
+
224
+ /**
225
+ * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
226
+ * @type {string}
227
+ * @memberof ReportScheduleLogsApiListReportScheduleLogs
228
+ */
229
+ readonly filters?: string
230
+ }
231
+
232
+ /**
233
+ * ReportScheduleLogsApi - object-oriented interface
234
+ * @export
235
+ * @class ReportScheduleLogsApi
236
+ * @extends {BaseAPI}
237
+ */
238
+ export class ReportScheduleLogsApi extends BaseAPI {
239
+ /**
240
+ * Lists execution logs for scheduled reports **Required Permissions** \"reporting.dashboards.view\"
241
+ * @summary List report-schedule-logs
242
+ * @param {ReportScheduleLogsApiListReportScheduleLogsRequest} requestParameters Request parameters.
243
+ * @param {*} [options] Override http request option.
244
+ * @throws {RequiredError}
245
+ * @memberof ReportScheduleLogsApi
246
+ */
247
+ public listReportScheduleLogs(requestParameters: ReportScheduleLogsApiListReportScheduleLogsRequest = {}, options?: AxiosRequestConfig) {
248
+ return ReportScheduleLogsApiFp(this.configuration).listReportScheduleLogs(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
249
+ }
250
+ }
package/api.ts CHANGED
@@ -38,6 +38,8 @@ import { ListOrganizationInvitationsApi } from './api';
38
38
  import { OrganizationMigrationApi } from './api';
39
39
  import { OrganizationsApi } from './api';
40
40
  import { ReInviteAnOrganizationApi } from './api';
41
+ import { ReportScheduleApi } from './api';
42
+ import { ReportScheduleLogsApi } from './api';
41
43
  import { RolesApi } from './api';
42
44
  import { SettingsApi } from './api';
43
45
  import { UserControllerRestApi } from './api';
@@ -59,6 +61,8 @@ export * from './api/list-organization-invitations-api';
59
61
  export * from './api/organization-migration-api';
60
62
  export * from './api/organizations-api';
61
63
  export * from './api/re-invite-an-organization-api';
64
+ export * from './api/report-schedule-api';
65
+ export * from './api/report-schedule-logs-api';
62
66
  export * from './api/roles-api';
63
67
  export * from './api/settings-api';
64
68
  export * from './api/user-controller-rest-api';
@@ -18,6 +18,7 @@ import { CreateDashboardV2RequestDto } from '../models';
18
18
  import { CreateDashboardV2ResponseClass } from '../models';
19
19
  import { DeleteResponseClass } from '../models';
20
20
  import { DuplicateDashboardResponseClass } from '../models';
21
+ import { GetDashboardMetadataResponseClass } from '../models';
21
22
  import { GetDashboardResponseClass } from '../models';
22
23
  import { GetEmbeddedUrlResponseClass } from '../models';
23
24
  import { ListDashboardsResponseClass } from '../models';
@@ -94,6 +95,15 @@ export declare const DashboardApiAxiosParamCreator: (configuration?: Configurati
94
95
  * @throws {RequiredError}
95
96
  */
96
97
  getDashboardEmbeddedUrl: (providerDashboardId: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
98
+ /**
99
+ * Returns sheet names and parameter definitions for the dashboard analysis backing this record. **Required Permissions** \"reporting.dashboards.view\"
100
+ * @summary Retrieves QuickSight analysis metadata for a dashboard
101
+ * @param {string} code
102
+ * @param {string} [authorization] Bearer Token
103
+ * @param {*} [options] Override http request option.
104
+ * @throws {RequiredError}
105
+ */
106
+ getDashboardMetadata: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
97
107
  /**
98
108
  * Fetches a paginated list of dashboards with optional filtering and sorting capabilities. **Required Permissions** \"reporting.dashboards.view\"
99
109
  * @summary Retrieves a list of dashboards
@@ -207,6 +217,15 @@ export declare const DashboardApiFp: (configuration?: Configuration) => {
207
217
  * @throws {RequiredError}
208
218
  */
209
219
  getDashboardEmbeddedUrl(providerDashboardId: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEmbeddedUrlResponseClass>>;
220
+ /**
221
+ * Returns sheet names and parameter definitions for the dashboard analysis backing this record. **Required Permissions** \"reporting.dashboards.view\"
222
+ * @summary Retrieves QuickSight analysis metadata for a dashboard
223
+ * @param {string} code
224
+ * @param {string} [authorization] Bearer Token
225
+ * @param {*} [options] Override http request option.
226
+ * @throws {RequiredError}
227
+ */
228
+ getDashboardMetadata(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetDashboardMetadataResponseClass>>;
210
229
  /**
211
230
  * Fetches a paginated list of dashboards with optional filtering and sorting capabilities. **Required Permissions** \"reporting.dashboards.view\"
212
231
  * @summary Retrieves a list of dashboards
@@ -320,6 +339,15 @@ export declare const DashboardApiFactory: (configuration?: Configuration, basePa
320
339
  * @throws {RequiredError}
321
340
  */
322
341
  getDashboardEmbeddedUrl(providerDashboardId: string, authorization?: string, options?: any): AxiosPromise<GetEmbeddedUrlResponseClass>;
342
+ /**
343
+ * Returns sheet names and parameter definitions for the dashboard analysis backing this record. **Required Permissions** \"reporting.dashboards.view\"
344
+ * @summary Retrieves QuickSight analysis metadata for a dashboard
345
+ * @param {string} code
346
+ * @param {string} [authorization] Bearer Token
347
+ * @param {*} [options] Override http request option.
348
+ * @throws {RequiredError}
349
+ */
350
+ getDashboardMetadata(code: string, authorization?: string, options?: any): AxiosPromise<GetDashboardMetadataResponseClass>;
323
351
  /**
324
352
  * Fetches a paginated list of dashboards with optional filtering and sorting capabilities. **Required Permissions** \"reporting.dashboards.view\"
325
353
  * @summary Retrieves a list of dashboards
@@ -497,6 +525,25 @@ export interface DashboardApiGetDashboardEmbeddedUrlRequest {
497
525
  */
498
526
  readonly authorization?: string;
499
527
  }
528
+ /**
529
+ * Request parameters for getDashboardMetadata operation in DashboardApi.
530
+ * @export
531
+ * @interface DashboardApiGetDashboardMetadataRequest
532
+ */
533
+ export interface DashboardApiGetDashboardMetadataRequest {
534
+ /**
535
+ *
536
+ * @type {string}
537
+ * @memberof DashboardApiGetDashboardMetadata
538
+ */
539
+ readonly code: string;
540
+ /**
541
+ * Bearer Token
542
+ * @type {string}
543
+ * @memberof DashboardApiGetDashboardMetadata
544
+ */
545
+ readonly authorization?: string;
546
+ }
500
547
  /**
501
548
  * Request parameters for listDashboards operation in DashboardApi.
502
549
  * @export
@@ -686,6 +733,15 @@ export declare class DashboardApi extends BaseAPI {
686
733
  * @memberof DashboardApi
687
734
  */
688
735
  getDashboardEmbeddedUrl(requestParameters: DashboardApiGetDashboardEmbeddedUrlRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetEmbeddedUrlResponseClass, any, {}>>;
736
+ /**
737
+ * Returns sheet names and parameter definitions for the dashboard analysis backing this record. **Required Permissions** \"reporting.dashboards.view\"
738
+ * @summary Retrieves QuickSight analysis metadata for a dashboard
739
+ * @param {DashboardApiGetDashboardMetadataRequest} requestParameters Request parameters.
740
+ * @param {*} [options] Override http request option.
741
+ * @throws {RequiredError}
742
+ * @memberof DashboardApi
743
+ */
744
+ getDashboardMetadata(requestParameters: DashboardApiGetDashboardMetadataRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetDashboardMetadataResponseClass, any, {}>>;
689
745
  /**
690
746
  * Fetches a paginated list of dashboards with optional filtering and sorting capabilities. **Required Permissions** \"reporting.dashboards.view\"
691
747
  * @summary Retrieves a list of dashboards
@@ -435,6 +435,54 @@ var DashboardApiAxiosParamCreator = function (configuration) {
435
435
  });
436
436
  });
437
437
  },
438
+ /**
439
+ * Returns sheet names and parameter definitions for the dashboard analysis backing this record. **Required Permissions** \"reporting.dashboards.view\"
440
+ * @summary Retrieves QuickSight analysis metadata for a dashboard
441
+ * @param {string} code
442
+ * @param {string} [authorization] Bearer Token
443
+ * @param {*} [options] Override http request option.
444
+ * @throws {RequiredError}
445
+ */
446
+ getDashboardMetadata: function (code, authorization, options) {
447
+ if (options === void 0) { options = {}; }
448
+ return __awaiter(_this, void 0, void 0, function () {
449
+ var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
450
+ return __generator(this, function (_a) {
451
+ switch (_a.label) {
452
+ case 0:
453
+ // verify required parameter 'code' is not null or undefined
454
+ (0, common_1.assertParamExists)('getDashboardMetadata', 'code', code);
455
+ localVarPath = "/tenantservice/v1/dashboards/{code}/metadata"
456
+ .replace("{".concat("code", "}"), encodeURIComponent(String(code)));
457
+ localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
458
+ if (configuration) {
459
+ baseOptions = configuration.baseOptions;
460
+ baseAccessToken = configuration.accessToken;
461
+ }
462
+ localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
463
+ localVarHeaderParameter = {};
464
+ localVarQueryParameter = {};
465
+ // authentication bearer required
466
+ // http bearer authentication required
467
+ return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
468
+ case 1:
469
+ // authentication bearer required
470
+ // http bearer authentication required
471
+ _a.sent();
472
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
473
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
474
+ }
475
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
476
+ headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
477
+ localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
478
+ return [2 /*return*/, {
479
+ url: (0, common_1.toPathString)(localVarUrlObj),
480
+ options: localVarRequestOptions,
481
+ }];
482
+ }
483
+ });
484
+ });
485
+ },
438
486
  /**
439
487
  * Fetches a paginated list of dashboards with optional filtering and sorting capabilities. **Required Permissions** \"reporting.dashboards.view\"
440
488
  * @summary Retrieves a list of dashboards
@@ -816,6 +864,27 @@ var DashboardApiFp = function (configuration) {
816
864
  });
817
865
  });
818
866
  },
867
+ /**
868
+ * Returns sheet names and parameter definitions for the dashboard analysis backing this record. **Required Permissions** \"reporting.dashboards.view\"
869
+ * @summary Retrieves QuickSight analysis metadata for a dashboard
870
+ * @param {string} code
871
+ * @param {string} [authorization] Bearer Token
872
+ * @param {*} [options] Override http request option.
873
+ * @throws {RequiredError}
874
+ */
875
+ getDashboardMetadata: function (code, authorization, options) {
876
+ return __awaiter(this, void 0, void 0, function () {
877
+ var localVarAxiosArgs;
878
+ return __generator(this, function (_a) {
879
+ switch (_a.label) {
880
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.getDashboardMetadata(code, authorization, options)];
881
+ case 1:
882
+ localVarAxiosArgs = _a.sent();
883
+ return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
884
+ }
885
+ });
886
+ });
887
+ },
819
888
  /**
820
889
  * Fetches a paginated list of dashboards with optional filtering and sorting capabilities. **Required Permissions** \"reporting.dashboards.view\"
821
890
  * @summary Retrieves a list of dashboards
@@ -995,6 +1064,17 @@ var DashboardApiFactory = function (configuration, basePath, axios) {
995
1064
  getDashboardEmbeddedUrl: function (providerDashboardId, authorization, options) {
996
1065
  return localVarFp.getDashboardEmbeddedUrl(providerDashboardId, authorization, options).then(function (request) { return request(axios, basePath); });
997
1066
  },
1067
+ /**
1068
+ * Returns sheet names and parameter definitions for the dashboard analysis backing this record. **Required Permissions** \"reporting.dashboards.view\"
1069
+ * @summary Retrieves QuickSight analysis metadata for a dashboard
1070
+ * @param {string} code
1071
+ * @param {string} [authorization] Bearer Token
1072
+ * @param {*} [options] Override http request option.
1073
+ * @throws {RequiredError}
1074
+ */
1075
+ getDashboardMetadata: function (code, authorization, options) {
1076
+ return localVarFp.getDashboardMetadata(code, authorization, options).then(function (request) { return request(axios, basePath); });
1077
+ },
998
1078
  /**
999
1079
  * Fetches a paginated list of dashboards with optional filtering and sorting capabilities. **Required Permissions** \"reporting.dashboards.view\"
1000
1080
  * @summary Retrieves a list of dashboards
@@ -1145,6 +1225,18 @@ var DashboardApi = /** @class */ (function (_super) {
1145
1225
  var _this = this;
1146
1226
  return (0, exports.DashboardApiFp)(this.configuration).getDashboardEmbeddedUrl(requestParameters.providerDashboardId, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
1147
1227
  };
1228
+ /**
1229
+ * Returns sheet names and parameter definitions for the dashboard analysis backing this record. **Required Permissions** \"reporting.dashboards.view\"
1230
+ * @summary Retrieves QuickSight analysis metadata for a dashboard
1231
+ * @param {DashboardApiGetDashboardMetadataRequest} requestParameters Request parameters.
1232
+ * @param {*} [options] Override http request option.
1233
+ * @throws {RequiredError}
1234
+ * @memberof DashboardApi
1235
+ */
1236
+ DashboardApi.prototype.getDashboardMetadata = function (requestParameters, options) {
1237
+ var _this = this;
1238
+ return (0, exports.DashboardApiFp)(this.configuration).getDashboardMetadata(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
1239
+ };
1148
1240
  /**
1149
1241
  * Fetches a paginated list of dashboards with optional filtering and sorting capabilities. **Required Permissions** \"reporting.dashboards.view\"
1150
1242
  * @summary Retrieves a list of dashboards