@emilgroup/tenant-sdk 1.42.0 → 1.42.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.
Files changed (65) 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 +693 -0
  5. package/api/report-schedule-logs-api.ts +246 -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 +642 -0
  11. package/dist/api/report-schedule-logs-api.d.ts +150 -0
  12. package/dist/api/report-schedule-logs-api.js +260 -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/dbconfig-dto.d.ts +6 -0
  22. package/dist/models/get-dashboard-metadata-response-class.d.ts +25 -0
  23. package/dist/models/get-dashboard-metadata-response-class.js +15 -0
  24. package/dist/models/get-report-schedule-response-class.d.ts +25 -0
  25. package/dist/models/get-report-schedule-response-class.js +15 -0
  26. package/dist/models/index.d.ts +15 -0
  27. package/dist/models/index.js +15 -0
  28. package/dist/models/list-report-schedule-logs-response-class.d.ts +43 -0
  29. package/dist/models/list-report-schedule-logs-response-class.js +15 -0
  30. package/dist/models/list-report-schedules-response-class.d.ts +43 -0
  31. package/dist/models/list-report-schedules-response-class.js +15 -0
  32. package/dist/models/quick-sight-analysis-parameter-class.d.ts +36 -0
  33. package/dist/models/quick-sight-analysis-parameter-class.js +15 -0
  34. package/dist/models/report-schedule-class.d.ts +157 -0
  35. package/dist/models/report-schedule-class.js +15 -0
  36. package/dist/models/report-schedule-log-class.d.ts +133 -0
  37. package/dist/models/report-schedule-log-class.js +15 -0
  38. package/dist/models/report-schedule-parameter-class.d.ts +42 -0
  39. package/dist/models/report-schedule-parameter-class.js +15 -0
  40. package/dist/models/report-schedule-parameter-dto.d.ts +42 -0
  41. package/dist/models/report-schedule-parameter-dto.js +15 -0
  42. package/dist/models/report-schedule-parameter-value-class.d.ts +30 -0
  43. package/dist/models/report-schedule-parameter-value-class.js +15 -0
  44. package/dist/models/update-report-schedule-request-dto.d.ts +121 -0
  45. package/dist/models/update-report-schedule-request-dto.js +15 -0
  46. package/dist/models/update-report-schedule-response-class.d.ts +25 -0
  47. package/dist/models/update-report-schedule-response-class.js +15 -0
  48. package/models/create-report-schedule-request-dto.ts +121 -0
  49. package/models/create-report-schedule-response-class.ts +31 -0
  50. package/models/dashboard-metadata-class.ts +49 -0
  51. package/models/dbconfig-dto.ts +6 -0
  52. package/models/get-dashboard-metadata-response-class.ts +31 -0
  53. package/models/get-report-schedule-response-class.ts +31 -0
  54. package/models/index.ts +15 -0
  55. package/models/list-report-schedule-logs-response-class.ts +49 -0
  56. package/models/list-report-schedules-response-class.ts +49 -0
  57. package/models/quick-sight-analysis-parameter-class.ts +42 -0
  58. package/models/report-schedule-class.ts +163 -0
  59. package/models/report-schedule-log-class.ts +139 -0
  60. package/models/report-schedule-parameter-class.ts +48 -0
  61. package/models/report-schedule-parameter-dto.ts +48 -0
  62. package/models/report-schedule-parameter-value-class.ts +36 -0
  63. package/models/update-report-schedule-request-dto.ts +127 -0
  64. package/models/update-report-schedule-response-class.ts +31 -0
  65. 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
+ }
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 { SettingsApi } from './api';
39
41
  import { UserControllerRestApi } from './api';
@@ -55,6 +57,8 @@ export * from './api/list-organization-invitations-api';
55
57
  export * from './api/organization-migration-api';
56
58
  export * from './api/organizations-api';
57
59
  export * from './api/re-invite-an-organization-api';
60
+ export * from './api/report-schedule-api';
61
+ export * from './api/report-schedule-logs-api';
58
62
  export * from './api/roles-api';
59
63
  export * from './api/settings-api';
60
64
  export * from './api/user-controller-rest-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
@@ -436,6 +436,54 @@ var DashboardApiAxiosParamCreator = function (configuration) {
436
436
  });
437
437
  });
438
438
  },
439
+ /**
440
+ * Returns sheet names and parameter definitions for the dashboard analysis backing this record. **Required Permissions** \"reporting.dashboards.view\"
441
+ * @summary Retrieves QuickSight analysis metadata for a dashboard
442
+ * @param {string} code
443
+ * @param {string} [authorization] Bearer Token
444
+ * @param {*} [options] Override http request option.
445
+ * @throws {RequiredError}
446
+ */
447
+ getDashboardMetadata: function (code, authorization, options) {
448
+ if (options === void 0) { options = {}; }
449
+ return __awaiter(_this, void 0, void 0, function () {
450
+ var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
451
+ return __generator(this, function (_a) {
452
+ switch (_a.label) {
453
+ case 0:
454
+ // verify required parameter 'code' is not null or undefined
455
+ (0, common_1.assertParamExists)('getDashboardMetadata', 'code', code);
456
+ localVarPath = "/tenantservice/v1/dashboards/{code}/metadata"
457
+ .replace("{".concat("code", "}"), encodeURIComponent(String(code)));
458
+ localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
459
+ if (configuration) {
460
+ baseOptions = configuration.baseOptions;
461
+ baseAccessToken = configuration.accessToken;
462
+ }
463
+ localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
464
+ localVarHeaderParameter = {};
465
+ localVarQueryParameter = {};
466
+ // authentication bearer required
467
+ // http bearer authentication required
468
+ return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
469
+ case 1:
470
+ // authentication bearer required
471
+ // http bearer authentication required
472
+ _a.sent();
473
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
474
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
475
+ }
476
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
477
+ headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
478
+ localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
479
+ return [2 /*return*/, {
480
+ url: (0, common_1.toPathString)(localVarUrlObj),
481
+ options: localVarRequestOptions,
482
+ }];
483
+ }
484
+ });
485
+ });
486
+ },
439
487
  /**
440
488
  * Fetches a paginated list of dashboards with optional filtering and sorting capabilities. **Required Permissions** \"reporting.dashboards.view\"
441
489
  * @summary Retrieves a list of dashboards
@@ -818,6 +866,27 @@ var DashboardApiFp = function (configuration) {
818
866
  });
819
867
  });
820
868
  },
869
+ /**
870
+ * Returns sheet names and parameter definitions for the dashboard analysis backing this record. **Required Permissions** \"reporting.dashboards.view\"
871
+ * @summary Retrieves QuickSight analysis metadata for a dashboard
872
+ * @param {string} code
873
+ * @param {string} [authorization] Bearer Token
874
+ * @param {*} [options] Override http request option.
875
+ * @throws {RequiredError}
876
+ */
877
+ getDashboardMetadata: function (code, authorization, options) {
878
+ return __awaiter(this, void 0, void 0, function () {
879
+ var localVarAxiosArgs;
880
+ return __generator(this, function (_a) {
881
+ switch (_a.label) {
882
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.getDashboardMetadata(code, authorization, options)];
883
+ case 1:
884
+ localVarAxiosArgs = _a.sent();
885
+ return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
886
+ }
887
+ });
888
+ });
889
+ },
821
890
  /**
822
891
  * Fetches a paginated list of dashboards with optional filtering and sorting capabilities. **Required Permissions** \"reporting.dashboards.view\"
823
892
  * @summary Retrieves a list of dashboards
@@ -998,6 +1067,17 @@ var DashboardApiFactory = function (configuration, basePath, axios) {
998
1067
  getDashboardEmbeddedUrl: function (providerDashboardId, authorization, options) {
999
1068
  return localVarFp.getDashboardEmbeddedUrl(providerDashboardId, authorization, options).then(function (request) { return request(axios, basePath); });
1000
1069
  },
1070
+ /**
1071
+ * Returns sheet names and parameter definitions for the dashboard analysis backing this record. **Required Permissions** \"reporting.dashboards.view\"
1072
+ * @summary Retrieves QuickSight analysis metadata for a dashboard
1073
+ * @param {string} code
1074
+ * @param {string} [authorization] Bearer Token
1075
+ * @param {*} [options] Override http request option.
1076
+ * @throws {RequiredError}
1077
+ */
1078
+ getDashboardMetadata: function (code, authorization, options) {
1079
+ return localVarFp.getDashboardMetadata(code, authorization, options).then(function (request) { return request(axios, basePath); });
1080
+ },
1001
1081
  /**
1002
1082
  * Fetches a paginated list of dashboards with optional filtering and sorting capabilities. **Required Permissions** \"reporting.dashboards.view\"
1003
1083
  * @summary Retrieves a list of dashboards
@@ -1148,6 +1228,18 @@ var DashboardApi = /** @class */ (function (_super) {
1148
1228
  var _this = this;
1149
1229
  return (0, exports.DashboardApiFp)(this.configuration).getDashboardEmbeddedUrl(requestParameters.providerDashboardId, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
1150
1230
  };
1231
+ /**
1232
+ * Returns sheet names and parameter definitions for the dashboard analysis backing this record. **Required Permissions** \"reporting.dashboards.view\"
1233
+ * @summary Retrieves QuickSight analysis metadata for a dashboard
1234
+ * @param {DashboardApiGetDashboardMetadataRequest} requestParameters Request parameters.
1235
+ * @param {*} [options] Override http request option.
1236
+ * @throws {RequiredError}
1237
+ * @memberof DashboardApi
1238
+ */
1239
+ DashboardApi.prototype.getDashboardMetadata = function (requestParameters, options) {
1240
+ var _this = this;
1241
+ return (0, exports.DashboardApiFp)(this.configuration).getDashboardMetadata(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
1242
+ };
1151
1243
  /**
1152
1244
  * Fetches a paginated list of dashboards with optional filtering and sorting capabilities. **Required Permissions** \"reporting.dashboards.view\"
1153
1245
  * @summary Retrieves a list of dashboards