@emilgroup/tenant-sdk 1.4.0 → 1.5.1

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