@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,165 @@
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 { RunDataReportRequestDto } from '../models';
25
+ // @ts-ignore
26
+ import { RunDataReportResponseClass } from '../models';
27
+ // URLSearchParams not necessarily used
28
+ // @ts-ignore
29
+ import { URL, URLSearchParams } from 'url';
30
+ const FormData = require('form-data');
31
+ /**
32
+ * DataReportExecutorApi - axios parameter creator
33
+ * @export
34
+ */
35
+ export const DataReportExecutorApiAxiosParamCreator = function (configuration?: Configuration) {
36
+ return {
37
+ /**
38
+ *
39
+ * @param {RunDataReportRequestDto} runDataReportRequestDto
40
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
41
+ * @param {*} [options] Override http request option.
42
+ * @throws {RequiredError}
43
+ */
44
+ runDataReport: async (runDataReportRequestDto: RunDataReportRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
45
+ // verify required parameter 'runDataReportRequestDto' is not null or undefined
46
+ assertParamExists('runDataReport', 'runDataReportRequestDto', runDataReportRequestDto)
47
+ const localVarPath = `/tenantservice/v1/data-report-executor`;
48
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
49
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
50
+ let baseOptions;
51
+ let baseAccessToken;
52
+ if (configuration) {
53
+ baseOptions = configuration.baseOptions;
54
+ baseAccessToken = configuration.accessToken;
55
+ }
56
+
57
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
58
+ const localVarHeaderParameter = {} as any;
59
+ const localVarQueryParameter = {} as any;
60
+
61
+ // authentication bearer required
62
+ // http bearer authentication required
63
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
64
+
65
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
66
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
67
+ }
68
+
69
+
70
+
71
+ localVarHeaderParameter['Content-Type'] = 'application/json';
72
+
73
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
74
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
75
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
76
+ localVarRequestOptions.data = serializeDataIfNeeded(runDataReportRequestDto, localVarRequestOptions, configuration)
77
+
78
+ return {
79
+ url: toPathString(localVarUrlObj),
80
+ options: localVarRequestOptions,
81
+ };
82
+ },
83
+ }
84
+ };
85
+
86
+ /**
87
+ * DataReportExecutorApi - functional programming interface
88
+ * @export
89
+ */
90
+ export const DataReportExecutorApiFp = function(configuration?: Configuration) {
91
+ const localVarAxiosParamCreator = DataReportExecutorApiAxiosParamCreator(configuration)
92
+ return {
93
+ /**
94
+ *
95
+ * @param {RunDataReportRequestDto} runDataReportRequestDto
96
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
97
+ * @param {*} [options] Override http request option.
98
+ * @throws {RequiredError}
99
+ */
100
+ async runDataReport(runDataReportRequestDto: RunDataReportRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RunDataReportResponseClass>> {
101
+ const localVarAxiosArgs = await localVarAxiosParamCreator.runDataReport(runDataReportRequestDto, authorization, options);
102
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
103
+ },
104
+ }
105
+ };
106
+
107
+ /**
108
+ * DataReportExecutorApi - factory interface
109
+ * @export
110
+ */
111
+ export const DataReportExecutorApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
112
+ const localVarFp = DataReportExecutorApiFp(configuration)
113
+ return {
114
+ /**
115
+ *
116
+ * @param {RunDataReportRequestDto} runDataReportRequestDto
117
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
118
+ * @param {*} [options] Override http request option.
119
+ * @throws {RequiredError}
120
+ */
121
+ runDataReport(runDataReportRequestDto: RunDataReportRequestDto, authorization?: string, options?: any): AxiosPromise<RunDataReportResponseClass> {
122
+ return localVarFp.runDataReport(runDataReportRequestDto, authorization, options).then((request) => request(axios, basePath));
123
+ },
124
+ };
125
+ };
126
+
127
+ /**
128
+ * Request parameters for runDataReport operation in DataReportExecutorApi.
129
+ * @export
130
+ * @interface DataReportExecutorApiRunDataReportRequest
131
+ */
132
+ export interface DataReportExecutorApiRunDataReportRequest {
133
+ /**
134
+ *
135
+ * @type {RunDataReportRequestDto}
136
+ * @memberof DataReportExecutorApiRunDataReport
137
+ */
138
+ readonly runDataReportRequestDto: RunDataReportRequestDto
139
+
140
+ /**
141
+ * Bearer Token: provided by the login endpoint under the name accessToken.
142
+ * @type {string}
143
+ * @memberof DataReportExecutorApiRunDataReport
144
+ */
145
+ readonly authorization?: string
146
+ }
147
+
148
+ /**
149
+ * DataReportExecutorApi - object-oriented interface
150
+ * @export
151
+ * @class DataReportExecutorApi
152
+ * @extends {BaseAPI}
153
+ */
154
+ export class DataReportExecutorApi extends BaseAPI {
155
+ /**
156
+ *
157
+ * @param {DataReportExecutorApiRunDataReportRequest} requestParameters Request parameters.
158
+ * @param {*} [options] Override http request option.
159
+ * @throws {RequiredError}
160
+ * @memberof DataReportExecutorApi
161
+ */
162
+ public runDataReport(requestParameters: DataReportExecutorApiRunDataReportRequest, options?: AxiosRequestConfig) {
163
+ return DataReportExecutorApiFp(this.configuration).runDataReport(requestParameters.runDataReportRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
164
+ }
165
+ }
package/api.ts CHANGED
@@ -25,6 +25,8 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj
25
25
  // @ts-ignore
26
26
  import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from './base';
27
27
  import { CustomSchemaApi } from './api';
28
+ import { DataReportApi } from './api';
29
+ import { DataReportExecutorApi } from './api';
28
30
  import { InviteOrganizationsApi } from './api';
29
31
  import { InviteUsersApi } from './api';
30
32
  import { ListOrganizationInvitationsApi } from './api';
@@ -36,6 +38,8 @@ import { UsersApi } from './api';
36
38
 
37
39
 
38
40
  export * from './api/custom-schema-api';
41
+ export * from './api/data-report-api';
42
+ export * from './api/data-report-executor-api';
39
43
  export * from './api/invite-organizations-api';
40
44
  export * from './api/invite-users-api';
41
45
  export * from './api/list-organization-invitations-api';
@@ -0,0 +1,380 @@
1
+ /**
2
+ * EMIL Tenant Service
3
+ * The EMIL TenantService API description
4
+ *
5
+ * The version of the OpenAPI document: 1.0
6
+ * Contact: kontakt@emil.de
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
13
+ import { Configuration } from '../configuration';
14
+ import { RequestArgs, BaseAPI } from '../base';
15
+ import { CreateDataReportRequestDto } from '../models';
16
+ import { CreateDataReportResponseClass } from '../models';
17
+ import { GetDataReportResponseClass } from '../models';
18
+ import { ListDataReportsResponseClass } from '../models';
19
+ import { UpdateDataReportRequestDto } from '../models';
20
+ import { UpdateDataReportResponseClass } from '../models';
21
+ /**
22
+ * DataReportApi - axios parameter creator
23
+ * @export
24
+ */
25
+ export declare const DataReportApiAxiosParamCreator: (configuration?: Configuration) => {
26
+ /**
27
+ * This will create a data report for tenant in the database
28
+ * @summary Create the data-report
29
+ * @param {CreateDataReportRequestDto} createDataReportRequestDto
30
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
31
+ * @param {*} [options] Override http request option.
32
+ * @throws {RequiredError}
33
+ */
34
+ createCustomSchema: (createDataReportRequestDto: CreateDataReportRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
35
+ /**
36
+ *
37
+ * @param {string} id
38
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
39
+ * @param {*} [options] Override http request option.
40
+ * @throws {RequiredError}
41
+ */
42
+ deleteAlert: (id: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
43
+ /**
44
+ * 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.
45
+ * @summary Retrieve the data-report
46
+ * @param {string} code Unique identifier for the object.
47
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
48
+ * @param {string} [expand] Fields to expand response by
49
+ * @param {*} [options] Override http request option.
50
+ * @throws {RequiredError}
51
+ */
52
+ getDataReport: (code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
53
+ /**
54
+ * 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.
55
+ * @summary List data-reports
56
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
57
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
58
+ * @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.
59
+ * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
60
+ * @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.
61
+ * @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.
62
+ * @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.
63
+ * @param {*} [options] Override http request option.
64
+ * @throws {RequiredError}
65
+ */
66
+ listDataReports: (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
67
+ /**
68
+ * Updates the specified data-report by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
69
+ * @summary Update the data-report
70
+ * @param {string} code
71
+ * @param {UpdateDataReportRequestDto} updateDataReportRequestDto
72
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
73
+ * @param {*} [options] Override http request option.
74
+ * @throws {RequiredError}
75
+ */
76
+ updateDataReport: (code: string, updateDataReportRequestDto: UpdateDataReportRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
77
+ };
78
+ /**
79
+ * DataReportApi - functional programming interface
80
+ * @export
81
+ */
82
+ export declare const DataReportApiFp: (configuration?: Configuration) => {
83
+ /**
84
+ * This will create a data report for tenant in the database
85
+ * @summary Create the data-report
86
+ * @param {CreateDataReportRequestDto} createDataReportRequestDto
87
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
88
+ * @param {*} [options] Override http request option.
89
+ * @throws {RequiredError}
90
+ */
91
+ createCustomSchema(createDataReportRequestDto: CreateDataReportRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateDataReportResponseClass>>;
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(id: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
100
+ /**
101
+ * 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.
102
+ * @summary Retrieve the data-report
103
+ * @param {string} code Unique identifier for the object.
104
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
105
+ * @param {string} [expand] Fields to expand response by
106
+ * @param {*} [options] Override http request option.
107
+ * @throws {RequiredError}
108
+ */
109
+ getDataReport(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetDataReportResponseClass>>;
110
+ /**
111
+ * 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.
112
+ * @summary List data-reports
113
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
114
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
115
+ * @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.
116
+ * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
117
+ * @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.
118
+ * @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.
119
+ * @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.
120
+ * @param {*} [options] Override http request option.
121
+ * @throws {RequiredError}
122
+ */
123
+ listDataReports(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListDataReportsResponseClass>>;
124
+ /**
125
+ * Updates the specified data-report by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
126
+ * @summary Update the data-report
127
+ * @param {string} code
128
+ * @param {UpdateDataReportRequestDto} updateDataReportRequestDto
129
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
130
+ * @param {*} [options] Override http request option.
131
+ * @throws {RequiredError}
132
+ */
133
+ updateDataReport(code: string, updateDataReportRequestDto: UpdateDataReportRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateDataReportResponseClass>>;
134
+ };
135
+ /**
136
+ * DataReportApi - factory interface
137
+ * @export
138
+ */
139
+ export declare const DataReportApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
140
+ /**
141
+ * This will create a data report for tenant in the database
142
+ * @summary Create the data-report
143
+ * @param {CreateDataReportRequestDto} createDataReportRequestDto
144
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
145
+ * @param {*} [options] Override http request option.
146
+ * @throws {RequiredError}
147
+ */
148
+ createCustomSchema(createDataReportRequestDto: CreateDataReportRequestDto, authorization?: string, options?: any): AxiosPromise<CreateDataReportResponseClass>;
149
+ /**
150
+ *
151
+ * @param {string} id
152
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
153
+ * @param {*} [options] Override http request option.
154
+ * @throws {RequiredError}
155
+ */
156
+ deleteAlert(id: string, authorization?: string, options?: any): AxiosPromise<void>;
157
+ /**
158
+ * 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.
159
+ * @summary Retrieve the data-report
160
+ * @param {string} code Unique identifier for the object.
161
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
162
+ * @param {string} [expand] Fields to expand response by
163
+ * @param {*} [options] Override http request option.
164
+ * @throws {RequiredError}
165
+ */
166
+ getDataReport(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetDataReportResponseClass>;
167
+ /**
168
+ * 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.
169
+ * @summary List data-reports
170
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
171
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
172
+ * @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.
173
+ * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
174
+ * @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.
175
+ * @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.
176
+ * @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.
177
+ * @param {*} [options] Override http request option.
178
+ * @throws {RequiredError}
179
+ */
180
+ listDataReports(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: any): AxiosPromise<ListDataReportsResponseClass>;
181
+ /**
182
+ * Updates the specified data-report by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
183
+ * @summary Update the data-report
184
+ * @param {string} code
185
+ * @param {UpdateDataReportRequestDto} updateDataReportRequestDto
186
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
187
+ * @param {*} [options] Override http request option.
188
+ * @throws {RequiredError}
189
+ */
190
+ updateDataReport(code: string, updateDataReportRequestDto: UpdateDataReportRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateDataReportResponseClass>;
191
+ };
192
+ /**
193
+ * Request parameters for createCustomSchema operation in DataReportApi.
194
+ * @export
195
+ * @interface DataReportApiCreateCustomSchemaRequest
196
+ */
197
+ export interface DataReportApiCreateCustomSchemaRequest {
198
+ /**
199
+ *
200
+ * @type {CreateDataReportRequestDto}
201
+ * @memberof DataReportApiCreateCustomSchema
202
+ */
203
+ readonly createDataReportRequestDto: CreateDataReportRequestDto;
204
+ /**
205
+ * Bearer Token: provided by the login endpoint under the name accessToken.
206
+ * @type {string}
207
+ * @memberof DataReportApiCreateCustomSchema
208
+ */
209
+ readonly authorization?: string;
210
+ }
211
+ /**
212
+ * Request parameters for deleteAlert operation in DataReportApi.
213
+ * @export
214
+ * @interface DataReportApiDeleteAlertRequest
215
+ */
216
+ export interface DataReportApiDeleteAlertRequest {
217
+ /**
218
+ *
219
+ * @type {string}
220
+ * @memberof DataReportApiDeleteAlert
221
+ */
222
+ readonly id: string;
223
+ /**
224
+ * Bearer Token: provided by the login endpoint under the name accessToken.
225
+ * @type {string}
226
+ * @memberof DataReportApiDeleteAlert
227
+ */
228
+ readonly authorization?: string;
229
+ }
230
+ /**
231
+ * Request parameters for getDataReport operation in DataReportApi.
232
+ * @export
233
+ * @interface DataReportApiGetDataReportRequest
234
+ */
235
+ export interface DataReportApiGetDataReportRequest {
236
+ /**
237
+ * Unique identifier for the object.
238
+ * @type {string}
239
+ * @memberof DataReportApiGetDataReport
240
+ */
241
+ readonly code: string;
242
+ /**
243
+ * Bearer Token: provided by the login endpoint under the name accessToken.
244
+ * @type {string}
245
+ * @memberof DataReportApiGetDataReport
246
+ */
247
+ readonly authorization?: string;
248
+ /**
249
+ * Fields to expand response by
250
+ * @type {string}
251
+ * @memberof DataReportApiGetDataReport
252
+ */
253
+ readonly expand?: string;
254
+ }
255
+ /**
256
+ * Request parameters for listDataReports operation in DataReportApi.
257
+ * @export
258
+ * @interface DataReportApiListDataReportsRequest
259
+ */
260
+ export interface DataReportApiListDataReportsRequest {
261
+ /**
262
+ * Bearer Token: provided by the login endpoint under the name accessToken.
263
+ * @type {string}
264
+ * @memberof DataReportApiListDataReports
265
+ */
266
+ readonly authorization?: string;
267
+ /**
268
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
269
+ * @type {any}
270
+ * @memberof DataReportApiListDataReports
271
+ */
272
+ readonly pageSize?: any;
273
+ /**
274
+ * 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.
275
+ * @type {any}
276
+ * @memberof DataReportApiListDataReports
277
+ */
278
+ readonly pageToken?: any;
279
+ /**
280
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
281
+ * @type {any}
282
+ * @memberof DataReportApiListDataReports
283
+ */
284
+ readonly filter?: any;
285
+ /**
286
+ * 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.
287
+ * @type {any}
288
+ * @memberof DataReportApiListDataReports
289
+ */
290
+ readonly search?: any;
291
+ /**
292
+ * 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.
293
+ * @type {any}
294
+ * @memberof DataReportApiListDataReports
295
+ */
296
+ readonly order?: any;
297
+ /**
298
+ * 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.
299
+ * @type {any}
300
+ * @memberof DataReportApiListDataReports
301
+ */
302
+ readonly expand?: any;
303
+ }
304
+ /**
305
+ * Request parameters for updateDataReport operation in DataReportApi.
306
+ * @export
307
+ * @interface DataReportApiUpdateDataReportRequest
308
+ */
309
+ export interface DataReportApiUpdateDataReportRequest {
310
+ /**
311
+ *
312
+ * @type {string}
313
+ * @memberof DataReportApiUpdateDataReport
314
+ */
315
+ readonly code: string;
316
+ /**
317
+ *
318
+ * @type {UpdateDataReportRequestDto}
319
+ * @memberof DataReportApiUpdateDataReport
320
+ */
321
+ readonly updateDataReportRequestDto: UpdateDataReportRequestDto;
322
+ /**
323
+ * Bearer Token: provided by the login endpoint under the name accessToken.
324
+ * @type {string}
325
+ * @memberof DataReportApiUpdateDataReport
326
+ */
327
+ readonly authorization?: string;
328
+ }
329
+ /**
330
+ * DataReportApi - object-oriented interface
331
+ * @export
332
+ * @class DataReportApi
333
+ * @extends {BaseAPI}
334
+ */
335
+ export declare class DataReportApi extends BaseAPI {
336
+ /**
337
+ * This will create a data report for tenant in the database
338
+ * @summary Create the data-report
339
+ * @param {DataReportApiCreateCustomSchemaRequest} requestParameters Request parameters.
340
+ * @param {*} [options] Override http request option.
341
+ * @throws {RequiredError}
342
+ * @memberof DataReportApi
343
+ */
344
+ createCustomSchema(requestParameters: DataReportApiCreateCustomSchemaRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateDataReportResponseClass, any>>;
345
+ /**
346
+ *
347
+ * @param {DataReportApiDeleteAlertRequest} requestParameters Request parameters.
348
+ * @param {*} [options] Override http request option.
349
+ * @throws {RequiredError}
350
+ * @memberof DataReportApi
351
+ */
352
+ deleteAlert(requestParameters: DataReportApiDeleteAlertRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
353
+ /**
354
+ * 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.
355
+ * @summary Retrieve the data-report
356
+ * @param {DataReportApiGetDataReportRequest} requestParameters Request parameters.
357
+ * @param {*} [options] Override http request option.
358
+ * @throws {RequiredError}
359
+ * @memberof DataReportApi
360
+ */
361
+ getDataReport(requestParameters: DataReportApiGetDataReportRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetDataReportResponseClass, any>>;
362
+ /**
363
+ * 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.
364
+ * @summary List data-reports
365
+ * @param {DataReportApiListDataReportsRequest} requestParameters Request parameters.
366
+ * @param {*} [options] Override http request option.
367
+ * @throws {RequiredError}
368
+ * @memberof DataReportApi
369
+ */
370
+ listDataReports(requestParameters?: DataReportApiListDataReportsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListDataReportsResponseClass, any>>;
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 {DataReportApiUpdateDataReportRequest} requestParameters Request parameters.
375
+ * @param {*} [options] Override http request option.
376
+ * @throws {RequiredError}
377
+ * @memberof DataReportApi
378
+ */
379
+ updateDataReport(requestParameters: DataReportApiUpdateDataReportRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateDataReportResponseClass, any>>;
380
+ }