@emilgroup/tenant-sdk 1.4.0 → 1.5.0

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