@emilgroup/tenant-sdk 1.36.1-beta.21 → 1.36.1-beta.22

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 (105) hide show
  1. package/.openapi-generator/FILES +0 -30
  2. package/README.md +2 -2
  3. package/api/dashboard-api.ts +0 -103
  4. package/api.ts +0 -6
  5. package/base.ts +0 -1
  6. package/dist/api/dashboard-api.d.ts +0 -56
  7. package/dist/api/dashboard-api.js +0 -92
  8. package/dist/api.d.ts +0 -3
  9. package/dist/api.js +0 -3
  10. package/dist/base.d.ts +1 -2
  11. package/dist/base.js +0 -1
  12. package/dist/models/index.d.ts +0 -27
  13. package/dist/models/index.js +0 -27
  14. package/models/index.ts +0 -27
  15. package/package.json +2 -2
  16. package/api/report-schedule-api.ts +0 -693
  17. package/api/report-schedule-logs-api.ts +0 -246
  18. package/api/user-group-api.ts +0 -1086
  19. package/dist/api/report-schedule-api.d.ts +0 -394
  20. package/dist/api/report-schedule-api.js +0 -642
  21. package/dist/api/report-schedule-logs-api.d.ts +0 -150
  22. package/dist/api/report-schedule-logs-api.js +0 -260
  23. package/dist/api/user-group-api.d.ts +0 -603
  24. package/dist/api/user-group-api.js +0 -936
  25. package/dist/models/add-users-to-group-request-dto.d.ts +0 -24
  26. package/dist/models/add-users-to-group-request-dto.js +0 -15
  27. package/dist/models/add-users-to-group-response-class.d.ts +0 -25
  28. package/dist/models/add-users-to-group-response-class.js +0 -15
  29. package/dist/models/create-report-schedule-request-dto.d.ts +0 -115
  30. package/dist/models/create-report-schedule-request-dto.js +0 -15
  31. package/dist/models/create-report-schedule-response-class.d.ts +0 -25
  32. package/dist/models/create-report-schedule-response-class.js +0 -15
  33. package/dist/models/create-user-group-request-dto.d.ts +0 -36
  34. package/dist/models/create-user-group-request-dto.js +0 -15
  35. package/dist/models/create-user-group-response-class.d.ts +0 -25
  36. package/dist/models/create-user-group-response-class.js +0 -15
  37. package/dist/models/dashboard-metadata-class.d.ts +0 -43
  38. package/dist/models/dashboard-metadata-class.js +0 -15
  39. package/dist/models/get-dashboard-metadata-response-class.d.ts +0 -25
  40. package/dist/models/get-dashboard-metadata-response-class.js +0 -15
  41. package/dist/models/get-report-schedule-response-class.d.ts +0 -25
  42. package/dist/models/get-report-schedule-response-class.js +0 -15
  43. package/dist/models/get-user-group-response-class.d.ts +0 -25
  44. package/dist/models/get-user-group-response-class.js +0 -15
  45. package/dist/models/list-report-schedule-logs-response-class.d.ts +0 -43
  46. package/dist/models/list-report-schedule-logs-response-class.js +0 -15
  47. package/dist/models/list-report-schedules-response-class.d.ts +0 -43
  48. package/dist/models/list-report-schedules-response-class.js +0 -15
  49. package/dist/models/list-user-group-members-response-class.d.ts +0 -43
  50. package/dist/models/list-user-group-members-response-class.js +0 -15
  51. package/dist/models/list-user-groups-response-class.d.ts +0 -43
  52. package/dist/models/list-user-groups-response-class.js +0 -15
  53. package/dist/models/quick-sight-analysis-parameter-class.d.ts +0 -36
  54. package/dist/models/quick-sight-analysis-parameter-class.js +0 -15
  55. package/dist/models/remove-users-from-group-request-dto.d.ts +0 -24
  56. package/dist/models/remove-users-from-group-request-dto.js +0 -15
  57. package/dist/models/report-schedule-class.d.ts +0 -157
  58. package/dist/models/report-schedule-class.js +0 -15
  59. package/dist/models/report-schedule-log-class.d.ts +0 -133
  60. package/dist/models/report-schedule-log-class.js +0 -15
  61. package/dist/models/report-schedule-parameter-class.d.ts +0 -42
  62. package/dist/models/report-schedule-parameter-class.js +0 -15
  63. package/dist/models/report-schedule-parameter-dto.d.ts +0 -42
  64. package/dist/models/report-schedule-parameter-dto.js +0 -15
  65. package/dist/models/report-schedule-parameter-value-class.d.ts +0 -30
  66. package/dist/models/report-schedule-parameter-value-class.js +0 -15
  67. package/dist/models/update-report-schedule-request-dto.d.ts +0 -121
  68. package/dist/models/update-report-schedule-request-dto.js +0 -15
  69. package/dist/models/update-report-schedule-response-class.d.ts +0 -25
  70. package/dist/models/update-report-schedule-response-class.js +0 -15
  71. package/dist/models/update-user-group-request-dto.d.ts +0 -36
  72. package/dist/models/update-user-group-request-dto.js +0 -15
  73. package/dist/models/update-user-group-response-class.d.ts +0 -25
  74. package/dist/models/update-user-group-response-class.js +0 -15
  75. package/dist/models/user-group-class.d.ts +0 -72
  76. package/dist/models/user-group-class.js +0 -15
  77. package/dist/models/user-group-member-class.d.ts +0 -42
  78. package/dist/models/user-group-member-class.js +0 -15
  79. package/models/add-users-to-group-request-dto.ts +0 -30
  80. package/models/add-users-to-group-response-class.ts +0 -31
  81. package/models/create-report-schedule-request-dto.ts +0 -121
  82. package/models/create-report-schedule-response-class.ts +0 -31
  83. package/models/create-user-group-request-dto.ts +0 -42
  84. package/models/create-user-group-response-class.ts +0 -31
  85. package/models/dashboard-metadata-class.ts +0 -49
  86. package/models/get-dashboard-metadata-response-class.ts +0 -31
  87. package/models/get-report-schedule-response-class.ts +0 -31
  88. package/models/get-user-group-response-class.ts +0 -31
  89. package/models/list-report-schedule-logs-response-class.ts +0 -49
  90. package/models/list-report-schedules-response-class.ts +0 -49
  91. package/models/list-user-group-members-response-class.ts +0 -49
  92. package/models/list-user-groups-response-class.ts +0 -49
  93. package/models/quick-sight-analysis-parameter-class.ts +0 -42
  94. package/models/remove-users-from-group-request-dto.ts +0 -30
  95. package/models/report-schedule-class.ts +0 -163
  96. package/models/report-schedule-log-class.ts +0 -139
  97. package/models/report-schedule-parameter-class.ts +0 -48
  98. package/models/report-schedule-parameter-dto.ts +0 -48
  99. package/models/report-schedule-parameter-value-class.ts +0 -36
  100. package/models/update-report-schedule-request-dto.ts +0 -127
  101. package/models/update-report-schedule-response-class.ts +0 -31
  102. package/models/update-user-group-request-dto.ts +0 -42
  103. package/models/update-user-group-response-class.ts +0 -31
  104. package/models/user-group-class.ts +0 -78
  105. package/models/user-group-member-class.ts +0 -48
@@ -1,693 +0,0 @@
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 { CreateReportScheduleRequestDto } from '../models';
25
- // @ts-ignore
26
- import { CreateReportScheduleResponseClass } from '../models';
27
- // @ts-ignore
28
- import { DeleteResponseClass } from '../models';
29
- // @ts-ignore
30
- import { GetReportScheduleResponseClass } from '../models';
31
- // @ts-ignore
32
- import { ListReportSchedulesResponseClass } from '../models';
33
- // @ts-ignore
34
- import { UpdateReportScheduleRequestDto } from '../models';
35
- // @ts-ignore
36
- import { UpdateReportScheduleResponseClass } from '../models';
37
- /**
38
- * ReportScheduleApi - axios parameter creator
39
- * @export
40
- */
41
- export const ReportScheduleApiAxiosParamCreator = function (configuration?: Configuration) {
42
- return {
43
- /**
44
- * Creates a scheduled report configuration for the tenant **Required Permissions** \"reporting.dashboards.view\"
45
- * @summary Create the report-schedule
46
- * @param {CreateReportScheduleRequestDto} createReportScheduleRequestDto
47
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
48
- * @param {*} [options] Override http request option.
49
- * @throws {RequiredError}
50
- */
51
- createReportSchedule: async (createReportScheduleRequestDto: CreateReportScheduleRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
52
- // verify required parameter 'createReportScheduleRequestDto' is not null or undefined
53
- assertParamExists('createReportSchedule', 'createReportScheduleRequestDto', createReportScheduleRequestDto)
54
- const localVarPath = `/tenantservice/v1/report-schedules`;
55
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
56
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
57
- let baseOptions;
58
- let baseAccessToken;
59
- if (configuration) {
60
- baseOptions = configuration.baseOptions;
61
- baseAccessToken = configuration.accessToken;
62
- }
63
-
64
- const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
65
- const localVarHeaderParameter = {} as any;
66
- const localVarQueryParameter = {} as any;
67
-
68
- // authentication bearer required
69
- // http bearer authentication required
70
- await setBearerAuthToObject(localVarHeaderParameter, configuration)
71
-
72
- if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
73
- localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
74
- }
75
-
76
-
77
-
78
- localVarHeaderParameter['Content-Type'] = 'application/json';
79
-
80
- setSearchParams(localVarUrlObj, localVarQueryParameter);
81
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
82
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
83
- localVarRequestOptions.data = serializeDataIfNeeded(createReportScheduleRequestDto, localVarRequestOptions, configuration)
84
-
85
- return {
86
- url: toPathString(localVarUrlObj),
87
- options: localVarRequestOptions,
88
- };
89
- },
90
- /**
91
- * Permanently deletes the report-schedule. Supply the unique code that was returned when you created the report-schedule and this will delete it. **Required Permissions** \"reporting.dashboards.view\"
92
- * @summary Delete the report-schedule
93
- * @param {string} code Unique identifier for the object.
94
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
95
- * @param {*} [options] Override http request option.
96
- * @throws {RequiredError}
97
- */
98
- deleteReportSchedule: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
99
- // verify required parameter 'code' is not null or undefined
100
- assertParamExists('deleteReportSchedule', 'code', code)
101
- const localVarPath = `/tenantservice/v1/report-schedules/{code}`
102
- .replace(`{${"code"}}`, encodeURIComponent(String(code)));
103
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
104
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
105
- let baseOptions;
106
- let baseAccessToken;
107
- if (configuration) {
108
- baseOptions = configuration.baseOptions;
109
- baseAccessToken = configuration.accessToken;
110
- }
111
-
112
- const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
113
- const localVarHeaderParameter = {} as any;
114
- const localVarQueryParameter = {} as any;
115
-
116
- // authentication bearer required
117
- // http bearer authentication required
118
- await setBearerAuthToObject(localVarHeaderParameter, configuration)
119
-
120
- if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
121
- localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
122
- }
123
-
124
-
125
-
126
- setSearchParams(localVarUrlObj, localVarQueryParameter);
127
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
128
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
129
-
130
- return {
131
- url: toPathString(localVarUrlObj),
132
- options: localVarRequestOptions,
133
- };
134
- },
135
- /**
136
- * Retrieves the details of the report-schedule that was previously created. Supply the unique report-schedule code that was returned when you created it and Emil Api will return the corresponding report-schedule information. **Required Permissions** \"reporting.dashboards.view\"
137
- * @summary Retrieve the report-schedule
138
- * @param {string} code Unique identifier for the object.
139
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
140
- * @param {string} [expand] Fields to expand response by
141
- * @param {*} [options] Override http request option.
142
- * @throws {RequiredError}
143
- */
144
- getReportSchedule: async (code: string, authorization?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
145
- // verify required parameter 'code' is not null or undefined
146
- assertParamExists('getReportSchedule', 'code', code)
147
- const localVarPath = `/tenantservice/v1/report-schedules/{code}`
148
- .replace(`{${"code"}}`, encodeURIComponent(String(code)));
149
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
150
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
151
- let baseOptions;
152
- let baseAccessToken;
153
- if (configuration) {
154
- baseOptions = configuration.baseOptions;
155
- baseAccessToken = configuration.accessToken;
156
- }
157
-
158
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
159
- const localVarHeaderParameter = {} as any;
160
- const localVarQueryParameter = {} as any;
161
-
162
- // authentication bearer required
163
- // http bearer authentication required
164
- await setBearerAuthToObject(localVarHeaderParameter, configuration)
165
-
166
- if (expand !== undefined) {
167
- localVarQueryParameter['expand'] = expand;
168
- }
169
-
170
- if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
171
- localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
172
- }
173
-
174
-
175
-
176
- setSearchParams(localVarUrlObj, localVarQueryParameter);
177
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
178
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
179
-
180
- return {
181
- url: toPathString(localVarUrlObj),
182
- options: localVarRequestOptions,
183
- };
184
- },
185
- /**
186
- * Returns a list of report-schedules you have previously created. The report-schedules are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"reporting.dashboards.view\"
187
- * @summary List report-schedules
188
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
189
- * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
190
- * @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.
191
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
192
- * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
193
- * @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.
194
- * @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.
195
- * @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.
196
- * @param {*} [options] Override http request option.
197
- * @throws {RequiredError}
198
- */
199
- listReportSchedules: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
200
- const localVarPath = `/tenantservice/v1/report-schedules`;
201
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
202
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
203
- let baseOptions;
204
- let baseAccessToken;
205
- if (configuration) {
206
- baseOptions = configuration.baseOptions;
207
- baseAccessToken = configuration.accessToken;
208
- }
209
-
210
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
211
- const localVarHeaderParameter = {} as any;
212
- const localVarQueryParameter = {} as any;
213
-
214
- // authentication bearer required
215
- // http bearer authentication required
216
- await setBearerAuthToObject(localVarHeaderParameter, configuration)
217
-
218
- if (pageSize !== undefined) {
219
- localVarQueryParameter['pageSize'] = pageSize;
220
- }
221
-
222
- if (pageToken !== undefined) {
223
- localVarQueryParameter['pageToken'] = pageToken;
224
- }
225
-
226
- if (filter !== undefined) {
227
- localVarQueryParameter['filter'] = filter;
228
- }
229
-
230
- if (search !== undefined) {
231
- localVarQueryParameter['search'] = search;
232
- }
233
-
234
- if (order !== undefined) {
235
- localVarQueryParameter['order'] = order;
236
- }
237
-
238
- if (expand !== undefined) {
239
- localVarQueryParameter['expand'] = expand;
240
- }
241
-
242
- if (filters !== undefined) {
243
- localVarQueryParameter['filters'] = filters;
244
- }
245
-
246
- if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
247
- localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
248
- }
249
-
250
-
251
-
252
- setSearchParams(localVarUrlObj, localVarQueryParameter);
253
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
254
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
255
-
256
- return {
257
- url: toPathString(localVarUrlObj),
258
- options: localVarRequestOptions,
259
- };
260
- },
261
- /**
262
- * Updates the specified report-schedule by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"reporting.dashboards.view\"
263
- * @summary Update the report-schedule
264
- * @param {string} code
265
- * @param {UpdateReportScheduleRequestDto} updateReportScheduleRequestDto
266
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
267
- * @param {*} [options] Override http request option.
268
- * @throws {RequiredError}
269
- */
270
- updateReportSchedule: async (code: string, updateReportScheduleRequestDto: UpdateReportScheduleRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
271
- // verify required parameter 'code' is not null or undefined
272
- assertParamExists('updateReportSchedule', 'code', code)
273
- // verify required parameter 'updateReportScheduleRequestDto' is not null or undefined
274
- assertParamExists('updateReportSchedule', 'updateReportScheduleRequestDto', updateReportScheduleRequestDto)
275
- const localVarPath = `/tenantservice/v1/report-schedules/{code}`
276
- .replace(`{${"code"}}`, encodeURIComponent(String(code)));
277
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
278
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
279
- let baseOptions;
280
- let baseAccessToken;
281
- if (configuration) {
282
- baseOptions = configuration.baseOptions;
283
- baseAccessToken = configuration.accessToken;
284
- }
285
-
286
- const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
287
- const localVarHeaderParameter = {} as any;
288
- const localVarQueryParameter = {} as any;
289
-
290
- // authentication bearer required
291
- // http bearer authentication required
292
- await setBearerAuthToObject(localVarHeaderParameter, configuration)
293
-
294
- if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
295
- localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
296
- }
297
-
298
-
299
-
300
- localVarHeaderParameter['Content-Type'] = 'application/json';
301
-
302
- setSearchParams(localVarUrlObj, localVarQueryParameter);
303
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
304
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
305
- localVarRequestOptions.data = serializeDataIfNeeded(updateReportScheduleRequestDto, localVarRequestOptions, configuration)
306
-
307
- return {
308
- url: toPathString(localVarUrlObj),
309
- options: localVarRequestOptions,
310
- };
311
- },
312
- }
313
- };
314
-
315
- /**
316
- * ReportScheduleApi - functional programming interface
317
- * @export
318
- */
319
- export const ReportScheduleApiFp = function(configuration?: Configuration) {
320
- const localVarAxiosParamCreator = ReportScheduleApiAxiosParamCreator(configuration)
321
- return {
322
- /**
323
- * Creates a scheduled report configuration for the tenant **Required Permissions** \"reporting.dashboards.view\"
324
- * @summary Create the report-schedule
325
- * @param {CreateReportScheduleRequestDto} createReportScheduleRequestDto
326
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
327
- * @param {*} [options] Override http request option.
328
- * @throws {RequiredError}
329
- */
330
- async createReportSchedule(createReportScheduleRequestDto: CreateReportScheduleRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateReportScheduleResponseClass>> {
331
- const localVarAxiosArgs = await localVarAxiosParamCreator.createReportSchedule(createReportScheduleRequestDto, authorization, options);
332
- return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
333
- },
334
- /**
335
- * Permanently deletes the report-schedule. Supply the unique code that was returned when you created the report-schedule and this will delete it. **Required Permissions** \"reporting.dashboards.view\"
336
- * @summary Delete the report-schedule
337
- * @param {string} code Unique identifier for the object.
338
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
339
- * @param {*} [options] Override http request option.
340
- * @throws {RequiredError}
341
- */
342
- async deleteReportSchedule(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponseClass>> {
343
- const localVarAxiosArgs = await localVarAxiosParamCreator.deleteReportSchedule(code, authorization, options);
344
- return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
345
- },
346
- /**
347
- * Retrieves the details of the report-schedule that was previously created. Supply the unique report-schedule code that was returned when you created it and Emil Api will return the corresponding report-schedule information. **Required Permissions** \"reporting.dashboards.view\"
348
- * @summary Retrieve the report-schedule
349
- * @param {string} code Unique identifier for the object.
350
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
351
- * @param {string} [expand] Fields to expand response by
352
- * @param {*} [options] Override http request option.
353
- * @throws {RequiredError}
354
- */
355
- async getReportSchedule(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetReportScheduleResponseClass>> {
356
- const localVarAxiosArgs = await localVarAxiosParamCreator.getReportSchedule(code, authorization, expand, options);
357
- return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
358
- },
359
- /**
360
- * Returns a list of report-schedules you have previously created. The report-schedules are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"reporting.dashboards.view\"
361
- * @summary List report-schedules
362
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
363
- * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
364
- * @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.
365
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
366
- * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
367
- * @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.
368
- * @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.
369
- * @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.
370
- * @param {*} [options] Override http request option.
371
- * @throws {RequiredError}
372
- */
373
- async listReportSchedules(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListReportSchedulesResponseClass>> {
374
- const localVarAxiosArgs = await localVarAxiosParamCreator.listReportSchedules(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
375
- return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
376
- },
377
- /**
378
- * Updates the specified report-schedule by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"reporting.dashboards.view\"
379
- * @summary Update the report-schedule
380
- * @param {string} code
381
- * @param {UpdateReportScheduleRequestDto} updateReportScheduleRequestDto
382
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
383
- * @param {*} [options] Override http request option.
384
- * @throws {RequiredError}
385
- */
386
- async updateReportSchedule(code: string, updateReportScheduleRequestDto: UpdateReportScheduleRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateReportScheduleResponseClass>> {
387
- const localVarAxiosArgs = await localVarAxiosParamCreator.updateReportSchedule(code, updateReportScheduleRequestDto, authorization, options);
388
- return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
389
- },
390
- }
391
- };
392
-
393
- /**
394
- * ReportScheduleApi - factory interface
395
- * @export
396
- */
397
- export const ReportScheduleApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
398
- const localVarFp = ReportScheduleApiFp(configuration)
399
- return {
400
- /**
401
- * Creates a scheduled report configuration for the tenant **Required Permissions** \"reporting.dashboards.view\"
402
- * @summary Create the report-schedule
403
- * @param {CreateReportScheduleRequestDto} createReportScheduleRequestDto
404
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
405
- * @param {*} [options] Override http request option.
406
- * @throws {RequiredError}
407
- */
408
- createReportSchedule(createReportScheduleRequestDto: CreateReportScheduleRequestDto, authorization?: string, options?: any): AxiosPromise<CreateReportScheduleResponseClass> {
409
- return localVarFp.createReportSchedule(createReportScheduleRequestDto, authorization, options).then((request) => request(axios, basePath));
410
- },
411
- /**
412
- * Permanently deletes the report-schedule. Supply the unique code that was returned when you created the report-schedule and this will delete it. **Required Permissions** \"reporting.dashboards.view\"
413
- * @summary Delete the report-schedule
414
- * @param {string} code Unique identifier for the object.
415
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
416
- * @param {*} [options] Override http request option.
417
- * @throws {RequiredError}
418
- */
419
- deleteReportSchedule(code: string, authorization?: string, options?: any): AxiosPromise<DeleteResponseClass> {
420
- return localVarFp.deleteReportSchedule(code, authorization, options).then((request) => request(axios, basePath));
421
- },
422
- /**
423
- * Retrieves the details of the report-schedule that was previously created. Supply the unique report-schedule code that was returned when you created it and Emil Api will return the corresponding report-schedule information. **Required Permissions** \"reporting.dashboards.view\"
424
- * @summary Retrieve the report-schedule
425
- * @param {string} code Unique identifier for the object.
426
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
427
- * @param {string} [expand] Fields to expand response by
428
- * @param {*} [options] Override http request option.
429
- * @throws {RequiredError}
430
- */
431
- getReportSchedule(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetReportScheduleResponseClass> {
432
- return localVarFp.getReportSchedule(code, authorization, expand, options).then((request) => request(axios, basePath));
433
- },
434
- /**
435
- * Returns a list of report-schedules you have previously created. The report-schedules are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"reporting.dashboards.view\"
436
- * @summary List report-schedules
437
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
438
- * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
439
- * @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.
440
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
441
- * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
442
- * @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.
443
- * @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.
444
- * @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.
445
- * @param {*} [options] Override http request option.
446
- * @throws {RequiredError}
447
- */
448
- listReportSchedules(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListReportSchedulesResponseClass> {
449
- return localVarFp.listReportSchedules(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
450
- },
451
- /**
452
- * Updates the specified report-schedule by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"reporting.dashboards.view\"
453
- * @summary Update the report-schedule
454
- * @param {string} code
455
- * @param {UpdateReportScheduleRequestDto} updateReportScheduleRequestDto
456
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
457
- * @param {*} [options] Override http request option.
458
- * @throws {RequiredError}
459
- */
460
- updateReportSchedule(code: string, updateReportScheduleRequestDto: UpdateReportScheduleRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateReportScheduleResponseClass> {
461
- return localVarFp.updateReportSchedule(code, updateReportScheduleRequestDto, authorization, options).then((request) => request(axios, basePath));
462
- },
463
- };
464
- };
465
-
466
- /**
467
- * Request parameters for createReportSchedule operation in ReportScheduleApi.
468
- * @export
469
- * @interface ReportScheduleApiCreateReportScheduleRequest
470
- */
471
- export interface ReportScheduleApiCreateReportScheduleRequest {
472
- /**
473
- *
474
- * @type {CreateReportScheduleRequestDto}
475
- * @memberof ReportScheduleApiCreateReportSchedule
476
- */
477
- readonly createReportScheduleRequestDto: CreateReportScheduleRequestDto
478
-
479
- /**
480
- * Bearer Token: provided by the login endpoint under the name accessToken.
481
- * @type {string}
482
- * @memberof ReportScheduleApiCreateReportSchedule
483
- */
484
- readonly authorization?: string
485
- }
486
-
487
- /**
488
- * Request parameters for deleteReportSchedule operation in ReportScheduleApi.
489
- * @export
490
- * @interface ReportScheduleApiDeleteReportScheduleRequest
491
- */
492
- export interface ReportScheduleApiDeleteReportScheduleRequest {
493
- /**
494
- * Unique identifier for the object.
495
- * @type {string}
496
- * @memberof ReportScheduleApiDeleteReportSchedule
497
- */
498
- readonly code: string
499
-
500
- /**
501
- * Bearer Token: provided by the login endpoint under the name accessToken.
502
- * @type {string}
503
- * @memberof ReportScheduleApiDeleteReportSchedule
504
- */
505
- readonly authorization?: string
506
- }
507
-
508
- /**
509
- * Request parameters for getReportSchedule operation in ReportScheduleApi.
510
- * @export
511
- * @interface ReportScheduleApiGetReportScheduleRequest
512
- */
513
- export interface ReportScheduleApiGetReportScheduleRequest {
514
- /**
515
- * Unique identifier for the object.
516
- * @type {string}
517
- * @memberof ReportScheduleApiGetReportSchedule
518
- */
519
- readonly code: string
520
-
521
- /**
522
- * Bearer Token: provided by the login endpoint under the name accessToken.
523
- * @type {string}
524
- * @memberof ReportScheduleApiGetReportSchedule
525
- */
526
- readonly authorization?: string
527
-
528
- /**
529
- * Fields to expand response by
530
- * @type {string}
531
- * @memberof ReportScheduleApiGetReportSchedule
532
- */
533
- readonly expand?: string
534
- }
535
-
536
- /**
537
- * Request parameters for listReportSchedules operation in ReportScheduleApi.
538
- * @export
539
- * @interface ReportScheduleApiListReportSchedulesRequest
540
- */
541
- export interface ReportScheduleApiListReportSchedulesRequest {
542
- /**
543
- * Bearer Token: provided by the login endpoint under the name accessToken.
544
- * @type {string}
545
- * @memberof ReportScheduleApiListReportSchedules
546
- */
547
- readonly authorization?: string
548
-
549
- /**
550
- * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
551
- * @type {number}
552
- * @memberof ReportScheduleApiListReportSchedules
553
- */
554
- readonly pageSize?: number
555
-
556
- /**
557
- * 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.
558
- * @type {string}
559
- * @memberof ReportScheduleApiListReportSchedules
560
- */
561
- readonly pageToken?: string
562
-
563
- /**
564
- * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
565
- * @type {string}
566
- * @memberof ReportScheduleApiListReportSchedules
567
- */
568
- readonly filter?: string
569
-
570
- /**
571
- * To search the list by any field, pass search&#x3D;xxx to fetch the result.
572
- * @type {string}
573
- * @memberof ReportScheduleApiListReportSchedules
574
- */
575
- readonly search?: string
576
-
577
- /**
578
- * 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.
579
- * @type {string}
580
- * @memberof ReportScheduleApiListReportSchedules
581
- */
582
- readonly order?: string
583
-
584
- /**
585
- * 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.
586
- * @type {string}
587
- * @memberof ReportScheduleApiListReportSchedules
588
- */
589
- readonly expand?: string
590
-
591
- /**
592
- * 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.
593
- * @type {string}
594
- * @memberof ReportScheduleApiListReportSchedules
595
- */
596
- readonly filters?: string
597
- }
598
-
599
- /**
600
- * Request parameters for updateReportSchedule operation in ReportScheduleApi.
601
- * @export
602
- * @interface ReportScheduleApiUpdateReportScheduleRequest
603
- */
604
- export interface ReportScheduleApiUpdateReportScheduleRequest {
605
- /**
606
- *
607
- * @type {string}
608
- * @memberof ReportScheduleApiUpdateReportSchedule
609
- */
610
- readonly code: string
611
-
612
- /**
613
- *
614
- * @type {UpdateReportScheduleRequestDto}
615
- * @memberof ReportScheduleApiUpdateReportSchedule
616
- */
617
- readonly updateReportScheduleRequestDto: UpdateReportScheduleRequestDto
618
-
619
- /**
620
- * Bearer Token: provided by the login endpoint under the name accessToken.
621
- * @type {string}
622
- * @memberof ReportScheduleApiUpdateReportSchedule
623
- */
624
- readonly authorization?: string
625
- }
626
-
627
- /**
628
- * ReportScheduleApi - object-oriented interface
629
- * @export
630
- * @class ReportScheduleApi
631
- * @extends {BaseAPI}
632
- */
633
- export class ReportScheduleApi extends BaseAPI {
634
- /**
635
- * Creates a scheduled report configuration for the tenant **Required Permissions** \"reporting.dashboards.view\"
636
- * @summary Create the report-schedule
637
- * @param {ReportScheduleApiCreateReportScheduleRequest} requestParameters Request parameters.
638
- * @param {*} [options] Override http request option.
639
- * @throws {RequiredError}
640
- * @memberof ReportScheduleApi
641
- */
642
- public createReportSchedule(requestParameters: ReportScheduleApiCreateReportScheduleRequest, options?: AxiosRequestConfig) {
643
- return ReportScheduleApiFp(this.configuration).createReportSchedule(requestParameters.createReportScheduleRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
644
- }
645
-
646
- /**
647
- * Permanently deletes the report-schedule. Supply the unique code that was returned when you created the report-schedule and this will delete it. **Required Permissions** \"reporting.dashboards.view\"
648
- * @summary Delete the report-schedule
649
- * @param {ReportScheduleApiDeleteReportScheduleRequest} requestParameters Request parameters.
650
- * @param {*} [options] Override http request option.
651
- * @throws {RequiredError}
652
- * @memberof ReportScheduleApi
653
- */
654
- public deleteReportSchedule(requestParameters: ReportScheduleApiDeleteReportScheduleRequest, options?: AxiosRequestConfig) {
655
- return ReportScheduleApiFp(this.configuration).deleteReportSchedule(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
656
- }
657
-
658
- /**
659
- * Retrieves the details of the report-schedule that was previously created. Supply the unique report-schedule code that was returned when you created it and Emil Api will return the corresponding report-schedule information. **Required Permissions** \"reporting.dashboards.view\"
660
- * @summary Retrieve the report-schedule
661
- * @param {ReportScheduleApiGetReportScheduleRequest} requestParameters Request parameters.
662
- * @param {*} [options] Override http request option.
663
- * @throws {RequiredError}
664
- * @memberof ReportScheduleApi
665
- */
666
- public getReportSchedule(requestParameters: ReportScheduleApiGetReportScheduleRequest, options?: AxiosRequestConfig) {
667
- return ReportScheduleApiFp(this.configuration).getReportSchedule(requestParameters.code, requestParameters.authorization, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
668
- }
669
-
670
- /**
671
- * Returns a list of report-schedules you have previously created. The report-schedules are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"reporting.dashboards.view\"
672
- * @summary List report-schedules
673
- * @param {ReportScheduleApiListReportSchedulesRequest} requestParameters Request parameters.
674
- * @param {*} [options] Override http request option.
675
- * @throws {RequiredError}
676
- * @memberof ReportScheduleApi
677
- */
678
- public listReportSchedules(requestParameters: ReportScheduleApiListReportSchedulesRequest = {}, options?: AxiosRequestConfig) {
679
- return ReportScheduleApiFp(this.configuration).listReportSchedules(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
680
- }
681
-
682
- /**
683
- * Updates the specified report-schedule by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"reporting.dashboards.view\"
684
- * @summary Update the report-schedule
685
- * @param {ReportScheduleApiUpdateReportScheduleRequest} requestParameters Request parameters.
686
- * @param {*} [options] Override http request option.
687
- * @throws {RequiredError}
688
- * @memberof ReportScheduleApi
689
- */
690
- public updateReportSchedule(requestParameters: ReportScheduleApiUpdateReportScheduleRequest, options?: AxiosRequestConfig) {
691
- return ReportScheduleApiFp(this.configuration).updateReportSchedule(requestParameters.code, requestParameters.updateReportScheduleRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
692
- }
693
- }