@emilgroup/tenant-sdk 1.42.1-beta.63 → 1.42.1-beta.64

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 (93) hide show
  1. package/.openapi-generator/FILES +18 -0
  2. package/README.md +2 -2
  3. package/api/dashboard-api.ts +103 -0
  4. package/api/invite-users-api.ts +8 -8
  5. package/api/report-schedule-api.ts +693 -0
  6. package/api/report-schedule-logs-api.ts +246 -0
  7. package/api/ssoid-pgroups-api.ts +20 -20
  8. package/api/user-controller-rest-api.ts +8 -8
  9. package/api.ts +4 -0
  10. package/dist/api/dashboard-api.d.ts +56 -0
  11. package/dist/api/dashboard-api.js +92 -0
  12. package/dist/api/invite-users-api.d.ts +8 -8
  13. package/dist/api/invite-users-api.js +6 -6
  14. package/dist/api/report-schedule-api.d.ts +394 -0
  15. package/dist/api/report-schedule-api.js +642 -0
  16. package/dist/api/report-schedule-logs-api.d.ts +150 -0
  17. package/dist/api/report-schedule-logs-api.js +260 -0
  18. package/dist/api/ssoid-pgroups-api.d.ts +20 -20
  19. package/dist/api/ssoid-pgroups-api.js +18 -18
  20. package/dist/api/user-controller-rest-api.d.ts +8 -8
  21. package/dist/api/user-controller-rest-api.js +6 -6
  22. package/dist/api.d.ts +2 -0
  23. package/dist/api.js +2 -0
  24. package/dist/models/create-admin-tenant-request-dto.d.ts +11 -0
  25. package/dist/models/create-admin-tenant-request-dto.js +5 -0
  26. package/dist/models/create-report-schedule-request-dto.d.ts +115 -0
  27. package/dist/models/create-report-schedule-request-dto.js +15 -0
  28. package/dist/models/create-report-schedule-response-class.d.ts +25 -0
  29. package/dist/models/create-report-schedule-response-class.js +15 -0
  30. package/dist/models/create-sso-idp-group-request-dto.d.ts +4 -3
  31. package/dist/models/create-tenant-request-dto.d.ts +11 -0
  32. package/dist/models/create-tenant-request-dto.js +5 -0
  33. package/dist/models/dashboard-metadata-class.d.ts +43 -0
  34. package/dist/models/dashboard-metadata-class.js +15 -0
  35. package/dist/models/dbconfig-dto.d.ts +6 -0
  36. package/dist/models/delete-tenant-request-dto.d.ts +30 -0
  37. package/dist/models/delete-tenant-request-dto.js +15 -0
  38. package/dist/models/get-dashboard-metadata-response-class.d.ts +25 -0
  39. package/dist/models/get-dashboard-metadata-response-class.js +15 -0
  40. package/dist/models/get-report-schedule-response-class.d.ts +25 -0
  41. package/dist/models/get-report-schedule-response-class.js +15 -0
  42. package/dist/models/index.d.ts +16 -0
  43. package/dist/models/index.js +16 -0
  44. package/dist/models/invite-class.d.ts +6 -0
  45. package/dist/models/list-report-schedule-logs-response-class.d.ts +43 -0
  46. package/dist/models/list-report-schedule-logs-response-class.js +15 -0
  47. package/dist/models/list-report-schedules-response-class.d.ts +43 -0
  48. package/dist/models/list-report-schedules-response-class.js +15 -0
  49. package/dist/models/org-invitation-class.d.ts +6 -0
  50. package/dist/models/quick-sight-analysis-parameter-class.d.ts +36 -0
  51. package/dist/models/quick-sight-analysis-parameter-class.js +15 -0
  52. package/dist/models/report-schedule-class.d.ts +157 -0
  53. package/dist/models/report-schedule-class.js +15 -0
  54. package/dist/models/report-schedule-log-class.d.ts +133 -0
  55. package/dist/models/report-schedule-log-class.js +15 -0
  56. package/dist/models/report-schedule-parameter-class.d.ts +42 -0
  57. package/dist/models/report-schedule-parameter-class.js +15 -0
  58. package/dist/models/report-schedule-parameter-dto.d.ts +42 -0
  59. package/dist/models/report-schedule-parameter-dto.js +15 -0
  60. package/dist/models/report-schedule-parameter-value-class.d.ts +30 -0
  61. package/dist/models/report-schedule-parameter-value-class.js +15 -0
  62. package/dist/models/sso-idp-group-class.d.ts +3 -2
  63. package/dist/models/update-report-schedule-request-dto.d.ts +121 -0
  64. package/dist/models/update-report-schedule-request-dto.js +15 -0
  65. package/dist/models/update-report-schedule-response-class.d.ts +25 -0
  66. package/dist/models/update-report-schedule-response-class.js +15 -0
  67. package/dist/models/update-sso-idp-group-body-dto.d.ts +2 -1
  68. package/models/create-admin-tenant-request-dto.ts +14 -0
  69. package/models/create-report-schedule-request-dto.ts +121 -0
  70. package/models/create-report-schedule-response-class.ts +31 -0
  71. package/models/create-sso-idp-group-request-dto.ts +4 -3
  72. package/models/create-tenant-request-dto.ts +14 -0
  73. package/models/dashboard-metadata-class.ts +49 -0
  74. package/models/dbconfig-dto.ts +6 -0
  75. package/models/delete-tenant-request-dto.ts +36 -0
  76. package/models/get-dashboard-metadata-response-class.ts +31 -0
  77. package/models/get-report-schedule-response-class.ts +31 -0
  78. package/models/index.ts +16 -0
  79. package/models/invite-class.ts +6 -0
  80. package/models/list-report-schedule-logs-response-class.ts +49 -0
  81. package/models/list-report-schedules-response-class.ts +49 -0
  82. package/models/org-invitation-class.ts +6 -0
  83. package/models/quick-sight-analysis-parameter-class.ts +42 -0
  84. package/models/report-schedule-class.ts +163 -0
  85. package/models/report-schedule-log-class.ts +139 -0
  86. package/models/report-schedule-parameter-class.ts +48 -0
  87. package/models/report-schedule-parameter-dto.ts +48 -0
  88. package/models/report-schedule-parameter-value-class.ts +36 -0
  89. package/models/sso-idp-group-class.ts +3 -2
  90. package/models/update-report-schedule-request-dto.ts +127 -0
  91. package/models/update-report-schedule-response-class.ts +31 -0
  92. package/models/update-sso-idp-group-body-dto.ts +2 -1
  93. package/package.json +1 -1
@@ -0,0 +1,246 @@
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
+ /**
26
+ * ReportScheduleLogsApi - axios parameter creator
27
+ * @export
28
+ */
29
+ export const ReportScheduleLogsApiAxiosParamCreator = function (configuration?: Configuration) {
30
+ return {
31
+ /**
32
+ * Lists execution logs for scheduled reports **Required Permissions** \"reporting.dashboards.view\"
33
+ * @summary List report-schedule-logs
34
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
35
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
36
+ * @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.
37
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
38
+ * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
39
+ * @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.
40
+ * @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.
41
+ * @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.
42
+ * @param {*} [options] Override http request option.
43
+ * @throws {RequiredError}
44
+ */
45
+ listReportScheduleLogs: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
46
+ const localVarPath = `/tenantservice/v1/report-schedule-logs`;
47
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
48
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
49
+ let baseOptions;
50
+ let baseAccessToken;
51
+ if (configuration) {
52
+ baseOptions = configuration.baseOptions;
53
+ baseAccessToken = configuration.accessToken;
54
+ }
55
+
56
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
57
+ const localVarHeaderParameter = {} as any;
58
+ const localVarQueryParameter = {} as any;
59
+
60
+ // authentication bearer required
61
+ // http bearer authentication required
62
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
63
+
64
+ if (pageSize !== undefined) {
65
+ localVarQueryParameter['pageSize'] = pageSize;
66
+ }
67
+
68
+ if (pageToken !== undefined) {
69
+ localVarQueryParameter['pageToken'] = pageToken;
70
+ }
71
+
72
+ if (filter !== undefined) {
73
+ localVarQueryParameter['filter'] = filter;
74
+ }
75
+
76
+ if (search !== undefined) {
77
+ localVarQueryParameter['search'] = search;
78
+ }
79
+
80
+ if (order !== undefined) {
81
+ localVarQueryParameter['order'] = order;
82
+ }
83
+
84
+ if (expand !== undefined) {
85
+ localVarQueryParameter['expand'] = expand;
86
+ }
87
+
88
+ if (filters !== undefined) {
89
+ localVarQueryParameter['filters'] = filters;
90
+ }
91
+
92
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
93
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
94
+ }
95
+
96
+
97
+
98
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
99
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
100
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
101
+
102
+ return {
103
+ url: toPathString(localVarUrlObj),
104
+ options: localVarRequestOptions,
105
+ };
106
+ },
107
+ }
108
+ };
109
+
110
+ /**
111
+ * ReportScheduleLogsApi - functional programming interface
112
+ * @export
113
+ */
114
+ export const ReportScheduleLogsApiFp = function(configuration?: Configuration) {
115
+ const localVarAxiosParamCreator = ReportScheduleLogsApiAxiosParamCreator(configuration)
116
+ return {
117
+ /**
118
+ * Lists execution logs for scheduled reports **Required Permissions** \"reporting.dashboards.view\"
119
+ * @summary List report-schedule-logs
120
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
121
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
122
+ * @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.
123
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
124
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
125
+ * @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.
126
+ * @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.
127
+ * @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.
128
+ * @param {*} [options] Override http request option.
129
+ * @throws {RequiredError}
130
+ */
131
+ 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>> {
132
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listReportScheduleLogs(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
133
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
134
+ },
135
+ }
136
+ };
137
+
138
+ /**
139
+ * ReportScheduleLogsApi - factory interface
140
+ * @export
141
+ */
142
+ export const ReportScheduleLogsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
143
+ const localVarFp = ReportScheduleLogsApiFp(configuration)
144
+ return {
145
+ /**
146
+ * Lists execution logs for scheduled reports **Required Permissions** \"reporting.dashboards.view\"
147
+ * @summary List report-schedule-logs
148
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
149
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
150
+ * @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.
151
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
152
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
153
+ * @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.
154
+ * @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.
155
+ * @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.
156
+ * @param {*} [options] Override http request option.
157
+ * @throws {RequiredError}
158
+ */
159
+ listReportScheduleLogs(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListReportScheduleLogsResponseClass> {
160
+ return localVarFp.listReportScheduleLogs(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
161
+ },
162
+ };
163
+ };
164
+
165
+ /**
166
+ * Request parameters for listReportScheduleLogs operation in ReportScheduleLogsApi.
167
+ * @export
168
+ * @interface ReportScheduleLogsApiListReportScheduleLogsRequest
169
+ */
170
+ export interface ReportScheduleLogsApiListReportScheduleLogsRequest {
171
+ /**
172
+ * Bearer Token: provided by the login endpoint under the name accessToken.
173
+ * @type {string}
174
+ * @memberof ReportScheduleLogsApiListReportScheduleLogs
175
+ */
176
+ readonly authorization?: string
177
+
178
+ /**
179
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
180
+ * @type {number}
181
+ * @memberof ReportScheduleLogsApiListReportScheduleLogs
182
+ */
183
+ readonly pageSize?: number
184
+
185
+ /**
186
+ * 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.
187
+ * @type {string}
188
+ * @memberof ReportScheduleLogsApiListReportScheduleLogs
189
+ */
190
+ readonly pageToken?: string
191
+
192
+ /**
193
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
194
+ * @type {string}
195
+ * @memberof ReportScheduleLogsApiListReportScheduleLogs
196
+ */
197
+ readonly filter?: string
198
+
199
+ /**
200
+ * To search the list by any field, pass search&#x3D;xxx to fetch the result.
201
+ * @type {string}
202
+ * @memberof ReportScheduleLogsApiListReportScheduleLogs
203
+ */
204
+ readonly search?: string
205
+
206
+ /**
207
+ * 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.
208
+ * @type {string}
209
+ * @memberof ReportScheduleLogsApiListReportScheduleLogs
210
+ */
211
+ readonly order?: string
212
+
213
+ /**
214
+ * 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.
215
+ * @type {string}
216
+ * @memberof ReportScheduleLogsApiListReportScheduleLogs
217
+ */
218
+ readonly expand?: string
219
+
220
+ /**
221
+ * 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.
222
+ * @type {string}
223
+ * @memberof ReportScheduleLogsApiListReportScheduleLogs
224
+ */
225
+ readonly filters?: string
226
+ }
227
+
228
+ /**
229
+ * ReportScheduleLogsApi - object-oriented interface
230
+ * @export
231
+ * @class ReportScheduleLogsApi
232
+ * @extends {BaseAPI}
233
+ */
234
+ export class ReportScheduleLogsApi extends BaseAPI {
235
+ /**
236
+ * Lists execution logs for scheduled reports **Required Permissions** \"reporting.dashboards.view\"
237
+ * @summary List report-schedule-logs
238
+ * @param {ReportScheduleLogsApiListReportScheduleLogsRequest} requestParameters Request parameters.
239
+ * @param {*} [options] Override http request option.
240
+ * @throws {RequiredError}
241
+ * @memberof ReportScheduleLogsApi
242
+ */
243
+ public listReportScheduleLogs(requestParameters: ReportScheduleLogsApiListReportScheduleLogsRequest = {}, options?: AxiosRequestConfig) {
244
+ 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));
245
+ }
246
+ }
@@ -45,7 +45,7 @@ import { UpdateSsoIdpGroupStatusResponseClass } from '../models';
45
45
  export const SSOIdPGroupsApiAxiosParamCreator = function (configuration?: Configuration) {
46
46
  return {
47
47
  /**
48
- * Creates an inactive IdP group with at least one EIS user-group mapping. externalId must be a GUID and is immutable after create. **Required Permissions** \"tenant-management.settings.create\"
48
+ * Creates an inactive IdP group with at least one EIS user-group mapping. externalId is any text and is immutable after create. **Required Permissions** \"tenant-management.settings.create\"
49
49
  * @summary Register an IdP group and its EIS mappings
50
50
  * @param {CreateSsoIdpGroupRequestDto} createSsoIdpGroupRequestDto
51
51
  * @param {string} [authorization] Bearer Token
@@ -182,14 +182,14 @@ export const SSOIdPGroupsApiAxiosParamCreator = function (configuration?: Config
182
182
  };
183
183
  },
184
184
  /**
185
- * undefined **Required Permissions** \"tenant-management.settings.view\"
185
+ * name is deprecated; filtering or sorting by it is ignored. **Required Permissions** \"tenant-management.settings.view\"
186
186
  * @summary List registered IdP groups
187
187
  * @param {string} [authorization] Bearer Token
188
188
  * @param {number} [pageSize] Number of items per page.
189
189
  * @param {string} [pageToken] Opaque token for the next page (returned in a previous response).
190
- * @param {string} [filter] Filter IdP groups by one or more fields. Allowed: id, code, externalId, name, isActive, userGroup.code, createdAt, updatedAt.
190
+ * @param {string} [filter] Filter IdP groups by one or more fields. Allowed: id, code, externalId, isActive, userGroup.code, createdAt, updatedAt.
191
191
  * @param {string} [search] Free-text search over searchable columns.
192
- * @param {string} [order] Sort the response. Allowed columns: id, code, externalId, name, isActive, createdAt, updatedAt.
192
+ * @param {string} [order] Sort the response. Allowed columns: id, code, externalId, isActive, createdAt, updatedAt.
193
193
  * @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.
194
194
  * @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.
195
195
  * @param {*} [options] Override http request option.
@@ -259,7 +259,7 @@ export const SSOIdPGroupsApiAxiosParamCreator = function (configuration?: Config
259
259
  },
260
260
  /**
261
261
  * externalId is immutable. eisUserGroupCodes is set-replace when present. **Required Permissions** \"tenant-management.settings.update\"
262
- * @summary Update IdP group name and/or EIS mappings
262
+ * @summary Update the EIS mappings of an IdP group
263
263
  * @param {string} code IdP group code.
264
264
  * @param {UpdateSsoIdpGroupBodyDto} updateSsoIdpGroupBodyDto
265
265
  * @param {string} [authorization] Bearer Token
@@ -370,7 +370,7 @@ export const SSOIdPGroupsApiFp = function(configuration?: Configuration) {
370
370
  const localVarAxiosParamCreator = SSOIdPGroupsApiAxiosParamCreator(configuration)
371
371
  return {
372
372
  /**
373
- * Creates an inactive IdP group with at least one EIS user-group mapping. externalId must be a GUID and is immutable after create. **Required Permissions** \"tenant-management.settings.create\"
373
+ * Creates an inactive IdP group with at least one EIS user-group mapping. externalId is any text and is immutable after create. **Required Permissions** \"tenant-management.settings.create\"
374
374
  * @summary Register an IdP group and its EIS mappings
375
375
  * @param {CreateSsoIdpGroupRequestDto} createSsoIdpGroupRequestDto
376
376
  * @param {string} [authorization] Bearer Token
@@ -406,14 +406,14 @@ export const SSOIdPGroupsApiFp = function(configuration?: Configuration) {
406
406
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
407
407
  },
408
408
  /**
409
- * undefined **Required Permissions** \"tenant-management.settings.view\"
409
+ * name is deprecated; filtering or sorting by it is ignored. **Required Permissions** \"tenant-management.settings.view\"
410
410
  * @summary List registered IdP groups
411
411
  * @param {string} [authorization] Bearer Token
412
412
  * @param {number} [pageSize] Number of items per page.
413
413
  * @param {string} [pageToken] Opaque token for the next page (returned in a previous response).
414
- * @param {string} [filter] Filter IdP groups by one or more fields. Allowed: id, code, externalId, name, isActive, userGroup.code, createdAt, updatedAt.
414
+ * @param {string} [filter] Filter IdP groups by one or more fields. Allowed: id, code, externalId, isActive, userGroup.code, createdAt, updatedAt.
415
415
  * @param {string} [search] Free-text search over searchable columns.
416
- * @param {string} [order] Sort the response. Allowed columns: id, code, externalId, name, isActive, createdAt, updatedAt.
416
+ * @param {string} [order] Sort the response. Allowed columns: id, code, externalId, isActive, createdAt, updatedAt.
417
417
  * @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.
418
418
  * @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.
419
419
  * @param {*} [options] Override http request option.
@@ -425,7 +425,7 @@ export const SSOIdPGroupsApiFp = function(configuration?: Configuration) {
425
425
  },
426
426
  /**
427
427
  * externalId is immutable. eisUserGroupCodes is set-replace when present. **Required Permissions** \"tenant-management.settings.update\"
428
- * @summary Update IdP group name and/or EIS mappings
428
+ * @summary Update the EIS mappings of an IdP group
429
429
  * @param {string} code IdP group code.
430
430
  * @param {UpdateSsoIdpGroupBodyDto} updateSsoIdpGroupBodyDto
431
431
  * @param {string} [authorization] Bearer Token
@@ -460,7 +460,7 @@ export const SSOIdPGroupsApiFactory = function (configuration?: Configuration, b
460
460
  const localVarFp = SSOIdPGroupsApiFp(configuration)
461
461
  return {
462
462
  /**
463
- * Creates an inactive IdP group with at least one EIS user-group mapping. externalId must be a GUID and is immutable after create. **Required Permissions** \"tenant-management.settings.create\"
463
+ * Creates an inactive IdP group with at least one EIS user-group mapping. externalId is any text and is immutable after create. **Required Permissions** \"tenant-management.settings.create\"
464
464
  * @summary Register an IdP group and its EIS mappings
465
465
  * @param {CreateSsoIdpGroupRequestDto} createSsoIdpGroupRequestDto
466
466
  * @param {string} [authorization] Bearer Token
@@ -493,14 +493,14 @@ export const SSOIdPGroupsApiFactory = function (configuration?: Configuration, b
493
493
  return localVarFp.getSsoIdpGroup(code, authorization, options).then((request) => request(axios, basePath));
494
494
  },
495
495
  /**
496
- * undefined **Required Permissions** \"tenant-management.settings.view\"
496
+ * name is deprecated; filtering or sorting by it is ignored. **Required Permissions** \"tenant-management.settings.view\"
497
497
  * @summary List registered IdP groups
498
498
  * @param {string} [authorization] Bearer Token
499
499
  * @param {number} [pageSize] Number of items per page.
500
500
  * @param {string} [pageToken] Opaque token for the next page (returned in a previous response).
501
- * @param {string} [filter] Filter IdP groups by one or more fields. Allowed: id, code, externalId, name, isActive, userGroup.code, createdAt, updatedAt.
501
+ * @param {string} [filter] Filter IdP groups by one or more fields. Allowed: id, code, externalId, isActive, userGroup.code, createdAt, updatedAt.
502
502
  * @param {string} [search] Free-text search over searchable columns.
503
- * @param {string} [order] Sort the response. Allowed columns: id, code, externalId, name, isActive, createdAt, updatedAt.
503
+ * @param {string} [order] Sort the response. Allowed columns: id, code, externalId, isActive, createdAt, updatedAt.
504
504
  * @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.
505
505
  * @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.
506
506
  * @param {*} [options] Override http request option.
@@ -511,7 +511,7 @@ export const SSOIdPGroupsApiFactory = function (configuration?: Configuration, b
511
511
  },
512
512
  /**
513
513
  * externalId is immutable. eisUserGroupCodes is set-replace when present. **Required Permissions** \"tenant-management.settings.update\"
514
- * @summary Update IdP group name and/or EIS mappings
514
+ * @summary Update the EIS mappings of an IdP group
515
515
  * @param {string} code IdP group code.
516
516
  * @param {UpdateSsoIdpGroupBodyDto} updateSsoIdpGroupBodyDto
517
517
  * @param {string} [authorization] Bearer Token
@@ -627,7 +627,7 @@ export interface SSOIdPGroupsApiListSsoIdpGroupsRequest {
627
627
  readonly pageToken?: string
628
628
 
629
629
  /**
630
- * Filter IdP groups by one or more fields. Allowed: id, code, externalId, name, isActive, userGroup.code, createdAt, updatedAt.
630
+ * Filter IdP groups by one or more fields. Allowed: id, code, externalId, isActive, userGroup.code, createdAt, updatedAt.
631
631
  * @type {string}
632
632
  * @memberof SSOIdPGroupsApiListSsoIdpGroups
633
633
  */
@@ -641,7 +641,7 @@ export interface SSOIdPGroupsApiListSsoIdpGroupsRequest {
641
641
  readonly search?: string
642
642
 
643
643
  /**
644
- * Sort the response. Allowed columns: id, code, externalId, name, isActive, createdAt, updatedAt.
644
+ * Sort the response. Allowed columns: id, code, externalId, isActive, createdAt, updatedAt.
645
645
  * @type {string}
646
646
  * @memberof SSOIdPGroupsApiListSsoIdpGroups
647
647
  */
@@ -726,7 +726,7 @@ export interface SSOIdPGroupsApiUpdateSsoIdpGroupStatusRequest {
726
726
  */
727
727
  export class SSOIdPGroupsApi extends BaseAPI {
728
728
  /**
729
- * Creates an inactive IdP group with at least one EIS user-group mapping. externalId must be a GUID and is immutable after create. **Required Permissions** \"tenant-management.settings.create\"
729
+ * Creates an inactive IdP group with at least one EIS user-group mapping. externalId is any text and is immutable after create. **Required Permissions** \"tenant-management.settings.create\"
730
730
  * @summary Register an IdP group and its EIS mappings
731
731
  * @param {SSOIdPGroupsApiCreateSsoIdpGroupRequest} requestParameters Request parameters.
732
732
  * @param {*} [options] Override http request option.
@@ -762,7 +762,7 @@ export class SSOIdPGroupsApi extends BaseAPI {
762
762
  }
763
763
 
764
764
  /**
765
- * undefined **Required Permissions** \"tenant-management.settings.view\"
765
+ * name is deprecated; filtering or sorting by it is ignored. **Required Permissions** \"tenant-management.settings.view\"
766
766
  * @summary List registered IdP groups
767
767
  * @param {SSOIdPGroupsApiListSsoIdpGroupsRequest} requestParameters Request parameters.
768
768
  * @param {*} [options] Override http request option.
@@ -775,7 +775,7 @@ export class SSOIdPGroupsApi extends BaseAPI {
775
775
 
776
776
  /**
777
777
  * externalId is immutable. eisUserGroupCodes is set-replace when present. **Required Permissions** \"tenant-management.settings.update\"
778
- * @summary Update IdP group name and/or EIS mappings
778
+ * @summary Update the EIS mappings of an IdP group
779
779
  * @param {SSOIdPGroupsApiUpdateSsoIdpGroupRequest} requestParameters Request parameters.
780
780
  * @param {*} [options] Override http request option.
781
781
  * @throws {RequiredError}
@@ -495,11 +495,11 @@ export const UserControllerRestApiAxiosParamCreator = function (configuration?:
495
495
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
496
496
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
497
497
  * @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.
498
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, email, token, organizationId, ern, partnerCode&lt;/i&gt;
498
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, email, token, organizationId, ern, partnerCode&lt;/i&gt;
499
499
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
500
500
  * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, email, expiresOn&lt;/i&gt;
501
501
  * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: organizations&lt;i&gt;
502
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, email, token, organizationId, ern, partnerCode&lt;/i&gt;
502
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, email, token, organizationId, ern, partnerCode&lt;/i&gt;
503
503
  * @param {*} [options] Override http request option.
504
504
  * @throws {RequiredError}
505
505
  */
@@ -763,11 +763,11 @@ export const UserControllerRestApiFp = function(configuration?: Configuration) {
763
763
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
764
764
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
765
765
  * @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.
766
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, email, token, organizationId, ern, partnerCode&lt;/i&gt;
766
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, email, token, organizationId, ern, partnerCode&lt;/i&gt;
767
767
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
768
768
  * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, email, expiresOn&lt;/i&gt;
769
769
  * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: organizations&lt;i&gt;
770
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, email, token, organizationId, ern, partnerCode&lt;/i&gt;
770
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, email, token, organizationId, ern, partnerCode&lt;/i&gt;
771
771
  * @param {*} [options] Override http request option.
772
772
  * @throws {RequiredError}
773
773
  */
@@ -906,11 +906,11 @@ export const UserControllerRestApiFactory = function (configuration?: Configurat
906
906
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
907
907
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
908
908
  * @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.
909
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, email, token, organizationId, ern, partnerCode&lt;/i&gt;
909
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, email, token, organizationId, ern, partnerCode&lt;/i&gt;
910
910
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
911
911
  * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, email, expiresOn&lt;/i&gt;
912
912
  * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: organizations&lt;i&gt;
913
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, email, token, organizationId, ern, partnerCode&lt;/i&gt;
913
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, email, token, organizationId, ern, partnerCode&lt;/i&gt;
914
914
  * @param {*} [options] Override http request option.
915
915
  * @throws {RequiredError}
916
916
  */
@@ -1175,7 +1175,7 @@ export interface UserControllerRestApiListInvitesRequest {
1175
1175
  readonly pageToken?: string
1176
1176
 
1177
1177
  /**
1178
- * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, email, token, organizationId, ern, partnerCode&lt;/i&gt;
1178
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, email, token, organizationId, ern, partnerCode&lt;/i&gt;
1179
1179
  * @type {string}
1180
1180
  * @memberof UserControllerRestApiListInvites
1181
1181
  */
@@ -1203,7 +1203,7 @@ export interface UserControllerRestApiListInvitesRequest {
1203
1203
  readonly expand?: string
1204
1204
 
1205
1205
  /**
1206
- * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, email, token, organizationId, ern, partnerCode&lt;/i&gt;
1206
+ * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, email, token, organizationId, ern, partnerCode&lt;/i&gt;
1207
1207
  * @type {string}
1208
1208
  * @memberof UserControllerRestApiListInvites
1209
1209
  */
package/api.ts CHANGED
@@ -34,6 +34,8 @@ import { ListOrganizationInvitationsApi } from './api';
34
34
  import { OrganizationMigrationApi } from './api';
35
35
  import { OrganizationsApi } from './api';
36
36
  import { ReInviteAnOrganizationApi } from './api';
37
+ import { ReportScheduleApi } from './api';
38
+ import { ReportScheduleLogsApi } from './api';
37
39
  import { RolesApi } from './api';
38
40
  import { SSOConnectionApi } from './api';
39
41
  import { SSOIdPGroupsApi } from './api';
@@ -57,6 +59,8 @@ export * from './api/list-organization-invitations-api';
57
59
  export * from './api/organization-migration-api';
58
60
  export * from './api/organizations-api';
59
61
  export * from './api/re-invite-an-organization-api';
62
+ export * from './api/report-schedule-api';
63
+ export * from './api/report-schedule-logs-api';
60
64
  export * from './api/roles-api';
61
65
  export * from './api/ssoconnection-api';
62
66
  export * from './api/ssoid-pgroups-api';
@@ -19,6 +19,7 @@ import { CreateDashboardV2ResponseClass } from '../models';
19
19
  import { DeleteResponseClass } from '../models';
20
20
  import { DuplicateDashboardRequestDto } from '../models';
21
21
  import { DuplicateDashboardResponseClass } from '../models';
22
+ import { GetDashboardMetadataResponseClass } from '../models';
22
23
  import { GetDashboardResponseClass } from '../models';
23
24
  import { GetEmbeddedUrlResponseClass } from '../models';
24
25
  import { ListDashboardsResponseClass } from '../models';
@@ -96,6 +97,15 @@ export declare const DashboardApiAxiosParamCreator: (configuration?: Configurati
96
97
  * @throws {RequiredError}
97
98
  */
98
99
  getDashboardEmbeddedUrl: (providerDashboardId: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
100
+ /**
101
+ * Returns sheet names and parameter definitions for the dashboard analysis backing this record. **Required Permissions** \"reporting.dashboards.view\"
102
+ * @summary Retrieves QuickSight analysis metadata for a dashboard
103
+ * @param {string} code
104
+ * @param {string} [authorization] Bearer Token
105
+ * @param {*} [options] Override http request option.
106
+ * @throws {RequiredError}
107
+ */
108
+ getDashboardMetadata: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
99
109
  /**
100
110
  * Fetches a paginated list of dashboards with optional filtering and sorting capabilities. **Required Permissions** \"reporting.dashboards.view\"
101
111
  * @summary Retrieves a list of dashboards
@@ -210,6 +220,15 @@ export declare const DashboardApiFp: (configuration?: Configuration) => {
210
220
  * @throws {RequiredError}
211
221
  */
212
222
  getDashboardEmbeddedUrl(providerDashboardId: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEmbeddedUrlResponseClass>>;
223
+ /**
224
+ * Returns sheet names and parameter definitions for the dashboard analysis backing this record. **Required Permissions** \"reporting.dashboards.view\"
225
+ * @summary Retrieves QuickSight analysis metadata for a dashboard
226
+ * @param {string} code
227
+ * @param {string} [authorization] Bearer Token
228
+ * @param {*} [options] Override http request option.
229
+ * @throws {RequiredError}
230
+ */
231
+ getDashboardMetadata(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetDashboardMetadataResponseClass>>;
213
232
  /**
214
233
  * Fetches a paginated list of dashboards with optional filtering and sorting capabilities. **Required Permissions** \"reporting.dashboards.view\"
215
234
  * @summary Retrieves a list of dashboards
@@ -324,6 +343,15 @@ export declare const DashboardApiFactory: (configuration?: Configuration, basePa
324
343
  * @throws {RequiredError}
325
344
  */
326
345
  getDashboardEmbeddedUrl(providerDashboardId: string, authorization?: string, options?: any): AxiosPromise<GetEmbeddedUrlResponseClass>;
346
+ /**
347
+ * Returns sheet names and parameter definitions for the dashboard analysis backing this record. **Required Permissions** \"reporting.dashboards.view\"
348
+ * @summary Retrieves QuickSight analysis metadata for a dashboard
349
+ * @param {string} code
350
+ * @param {string} [authorization] Bearer Token
351
+ * @param {*} [options] Override http request option.
352
+ * @throws {RequiredError}
353
+ */
354
+ getDashboardMetadata(code: string, authorization?: string, options?: any): AxiosPromise<GetDashboardMetadataResponseClass>;
327
355
  /**
328
356
  * Fetches a paginated list of dashboards with optional filtering and sorting capabilities. **Required Permissions** \"reporting.dashboards.view\"
329
357
  * @summary Retrieves a list of dashboards
@@ -507,6 +535,25 @@ export interface DashboardApiGetDashboardEmbeddedUrlRequest {
507
535
  */
508
536
  readonly authorization?: string;
509
537
  }
538
+ /**
539
+ * Request parameters for getDashboardMetadata operation in DashboardApi.
540
+ * @export
541
+ * @interface DashboardApiGetDashboardMetadataRequest
542
+ */
543
+ export interface DashboardApiGetDashboardMetadataRequest {
544
+ /**
545
+ *
546
+ * @type {string}
547
+ * @memberof DashboardApiGetDashboardMetadata
548
+ */
549
+ readonly code: string;
550
+ /**
551
+ * Bearer Token
552
+ * @type {string}
553
+ * @memberof DashboardApiGetDashboardMetadata
554
+ */
555
+ readonly authorization?: string;
556
+ }
510
557
  /**
511
558
  * Request parameters for listDashboards operation in DashboardApi.
512
559
  * @export
@@ -696,6 +743,15 @@ export declare class DashboardApi extends BaseAPI {
696
743
  * @memberof DashboardApi
697
744
  */
698
745
  getDashboardEmbeddedUrl(requestParameters: DashboardApiGetDashboardEmbeddedUrlRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetEmbeddedUrlResponseClass, any, {}>>;
746
+ /**
747
+ * Returns sheet names and parameter definitions for the dashboard analysis backing this record. **Required Permissions** \"reporting.dashboards.view\"
748
+ * @summary Retrieves QuickSight analysis metadata for a dashboard
749
+ * @param {DashboardApiGetDashboardMetadataRequest} requestParameters Request parameters.
750
+ * @param {*} [options] Override http request option.
751
+ * @throws {RequiredError}
752
+ * @memberof DashboardApi
753
+ */
754
+ getDashboardMetadata(requestParameters: DashboardApiGetDashboardMetadataRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetDashboardMetadataResponseClass, any, {}>>;
699
755
  /**
700
756
  * Fetches a paginated list of dashboards with optional filtering and sorting capabilities. **Required Permissions** \"reporting.dashboards.view\"
701
757
  * @summary Retrieves a list of dashboards