@emilgroup/tenant-sdk 1.15.0 → 1.16.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.
- package/.openapi-generator/FILES +0 -1
- package/README.md +2 -2
- package/api/custom-schema-api.ts +36 -22
- package/api/data-report-api.ts +50 -36
- package/api/invite-users-api.ts +32 -18
- package/api/list-organization-invitations-api.ts +32 -18
- package/api/organizations-api.ts +28 -14
- package/api/roles-api.ts +22 -22
- package/api/settings-api.ts +4 -4
- package/api/users-api.ts +32 -18
- package/base.ts +6 -1
- package/configuration.ts +1 -1
- package/dist/api/custom-schema-api.d.ts +28 -19
- package/dist/api/custom-schema-api.js +26 -20
- package/dist/api/data-report-api.d.ts +38 -29
- package/dist/api/data-report-api.js +35 -29
- package/dist/api/invite-users-api.d.ts +24 -15
- package/dist/api/invite-users-api.js +22 -16
- package/dist/api/list-organization-invitations-api.d.ts +24 -15
- package/dist/api/list-organization-invitations-api.js +22 -16
- package/dist/api/organizations-api.d.ts +20 -11
- package/dist/api/organizations-api.js +18 -12
- package/dist/api/roles-api.d.ts +22 -22
- package/dist/api/roles-api.js +13 -13
- package/dist/api/settings-api.d.ts +4 -4
- package/dist/api/settings-api.js +4 -4
- package/dist/api/users-api.d.ts +24 -15
- package/dist/api/users-api.js +22 -16
- package/dist/base.d.ts +1 -0
- package/dist/base.js +5 -1
- package/dist/configuration.js +0 -7
- package/dist/models/batch-delete-request-dto.d.ts +2 -2
- package/dist/models/create-data-report-request-dto.d.ts +1 -1
- package/dist/models/create-role-request-dto.d.ts +2 -2
- package/dist/models/custom-field-dto.d.ts +37 -4
- package/dist/models/custom-field-dto.js +5 -2
- package/dist/models/data-report-class.d.ts +1 -1
- package/dist/models/disable-users-request-dto.d.ts +2 -2
- package/dist/models/enable-users-request-dto.d.ts +2 -2
- package/dist/models/index.d.ts +0 -1
- package/dist/models/index.js +0 -1
- package/dist/models/inline-response200.d.ts +6 -6
- package/dist/models/inline-response503.d.ts +6 -6
- package/dist/models/invite-class.d.ts +7 -0
- package/dist/models/invite-org-request-dto.d.ts +1 -1
- package/dist/models/invite-users-request-dto.d.ts +6 -0
- package/dist/models/organization-class.d.ts +6 -0
- package/dist/models/run-data-report-response-class.d.ts +2 -2
- package/dist/models/update-data-report-request-dto.d.ts +1 -1
- package/dist/models/update-role-request-dto.d.ts +2 -2
- package/dist/models/user-class.d.ts +7 -6
- package/models/batch-delete-request-dto.ts +2 -2
- package/models/create-data-report-request-dto.ts +1 -1
- package/models/create-role-request-dto.ts +2 -2
- package/models/custom-field-dto.ts +38 -5
- package/models/data-report-class.ts +1 -1
- package/models/disable-users-request-dto.ts +2 -2
- package/models/enable-users-request-dto.ts +2 -2
- package/models/index.ts +0 -1
- package/models/inline-response200.ts +6 -6
- package/models/inline-response503.ts +6 -6
- package/models/invite-class.ts +7 -0
- package/models/invite-org-request-dto.ts +1 -1
- package/models/invite-users-request-dto.ts +6 -0
- package/models/organization-class.ts +6 -0
- package/models/run-data-report-response-class.ts +2 -2
- package/models/update-data-report-request-dto.ts +1 -1
- package/models/update-role-request-dto.ts +2 -2
- package/models/user-class.ts +7 -6
- package/package.json +1 -1
- package/dist/models/set-user-setting-response-class.d.ts +0 -36
- package/dist/models/set-user-setting-response-class.js +0 -15
- package/models/set-user-setting-response-class.ts +0 -42
|
@@ -33,7 +33,7 @@ export declare const CustomSchemaApiAxiosParamCreator: (configuration?: Configur
|
|
|
33
33
|
*/
|
|
34
34
|
createCustomSchema: (createCustomSchemaRequestDto: CreateCustomSchemaRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
35
35
|
/**
|
|
36
|
-
* Retrieves the details of the custom-schema that was previously created. Supply the unique custom-schema code
|
|
36
|
+
* Retrieves the details of the custom-schema that was previously created. Supply the unique custom-schema code that was returned when you created it and Emil Api will return the corresponding custom-schema information.
|
|
37
37
|
* @summary Retrieve the custom-schema
|
|
38
38
|
* @param {string} code Unique identifier for the object.
|
|
39
39
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -43,19 +43,20 @@ export declare const CustomSchemaApiAxiosParamCreator: (configuration?: Configur
|
|
|
43
43
|
*/
|
|
44
44
|
getCustomSchema: (code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
45
45
|
/**
|
|
46
|
-
* Returns a list of custom-schemas you have previously created.
|
|
46
|
+
* Returns a list of custom-schemas you have previously created. The custom-schemas are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
47
47
|
* @summary List custom-schemas
|
|
48
48
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
49
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
49
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
50
50
|
* @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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
51
51
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
52
|
-
* @param {any} [search]
|
|
52
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
53
53
|
* @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.
|
|
54
54
|
* @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.
|
|
55
|
+
* @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
55
56
|
* @param {*} [options] Override http request option.
|
|
56
57
|
* @throws {RequiredError}
|
|
57
58
|
*/
|
|
58
|
-
listCustomSchemas: (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
59
|
+
listCustomSchemas: (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
59
60
|
/**
|
|
60
61
|
* Updates the specified custom-schema by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
61
62
|
* @summary Update the custom-schema
|
|
@@ -82,7 +83,7 @@ export declare const CustomSchemaApiFp: (configuration?: Configuration) => {
|
|
|
82
83
|
*/
|
|
83
84
|
createCustomSchema(createCustomSchemaRequestDto: CreateCustomSchemaRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateCustomSchemaResponseClass>>;
|
|
84
85
|
/**
|
|
85
|
-
* Retrieves the details of the custom-schema that was previously created. Supply the unique custom-schema code
|
|
86
|
+
* Retrieves the details of the custom-schema that was previously created. Supply the unique custom-schema code that was returned when you created it and Emil Api will return the corresponding custom-schema information.
|
|
86
87
|
* @summary Retrieve the custom-schema
|
|
87
88
|
* @param {string} code Unique identifier for the object.
|
|
88
89
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -92,19 +93,20 @@ export declare const CustomSchemaApiFp: (configuration?: Configuration) => {
|
|
|
92
93
|
*/
|
|
93
94
|
getCustomSchema(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetCustomSchemaResponseClass>>;
|
|
94
95
|
/**
|
|
95
|
-
* Returns a list of custom-schemas you have previously created.
|
|
96
|
+
* Returns a list of custom-schemas you have previously created. The custom-schemas are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
96
97
|
* @summary List custom-schemas
|
|
97
98
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
98
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
99
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
99
100
|
* @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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
100
101
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
101
|
-
* @param {any} [search]
|
|
102
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
102
103
|
* @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.
|
|
103
104
|
* @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.
|
|
105
|
+
* @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
104
106
|
* @param {*} [options] Override http request option.
|
|
105
107
|
* @throws {RequiredError}
|
|
106
108
|
*/
|
|
107
|
-
listCustomSchemas(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCustomSchemasResponseClass>>;
|
|
109
|
+
listCustomSchemas(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCustomSchemasResponseClass>>;
|
|
108
110
|
/**
|
|
109
111
|
* Updates the specified custom-schema by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
110
112
|
* @summary Update the custom-schema
|
|
@@ -131,7 +133,7 @@ export declare const CustomSchemaApiFactory: (configuration?: Configuration, bas
|
|
|
131
133
|
*/
|
|
132
134
|
createCustomSchema(createCustomSchemaRequestDto: CreateCustomSchemaRequestDto, authorization?: string, options?: any): AxiosPromise<CreateCustomSchemaResponseClass>;
|
|
133
135
|
/**
|
|
134
|
-
* Retrieves the details of the custom-schema that was previously created. Supply the unique custom-schema code
|
|
136
|
+
* Retrieves the details of the custom-schema that was previously created. Supply the unique custom-schema code that was returned when you created it and Emil Api will return the corresponding custom-schema information.
|
|
135
137
|
* @summary Retrieve the custom-schema
|
|
136
138
|
* @param {string} code Unique identifier for the object.
|
|
137
139
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -141,19 +143,20 @@ export declare const CustomSchemaApiFactory: (configuration?: Configuration, bas
|
|
|
141
143
|
*/
|
|
142
144
|
getCustomSchema(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetCustomSchemaResponseClass>;
|
|
143
145
|
/**
|
|
144
|
-
* Returns a list of custom-schemas you have previously created.
|
|
146
|
+
* Returns a list of custom-schemas you have previously created. The custom-schemas are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
145
147
|
* @summary List custom-schemas
|
|
146
148
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
147
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
149
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
148
150
|
* @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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
149
151
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
150
|
-
* @param {any} [search]
|
|
152
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
151
153
|
* @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.
|
|
152
154
|
* @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.
|
|
155
|
+
* @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
153
156
|
* @param {*} [options] Override http request option.
|
|
154
157
|
* @throws {RequiredError}
|
|
155
158
|
*/
|
|
156
|
-
listCustomSchemas(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: any): AxiosPromise<ListCustomSchemasResponseClass>;
|
|
159
|
+
listCustomSchemas(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: any): AxiosPromise<ListCustomSchemasResponseClass>;
|
|
157
160
|
/**
|
|
158
161
|
* Updates the specified custom-schema by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
159
162
|
* @summary Update the custom-schema
|
|
@@ -222,7 +225,7 @@ export interface CustomSchemaApiListCustomSchemasRequest {
|
|
|
222
225
|
*/
|
|
223
226
|
readonly authorization?: string;
|
|
224
227
|
/**
|
|
225
|
-
* A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
228
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
226
229
|
* @type {any}
|
|
227
230
|
* @memberof CustomSchemaApiListCustomSchemas
|
|
228
231
|
*/
|
|
@@ -240,7 +243,7 @@ export interface CustomSchemaApiListCustomSchemasRequest {
|
|
|
240
243
|
*/
|
|
241
244
|
readonly filter?: any;
|
|
242
245
|
/**
|
|
243
|
-
*
|
|
246
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
244
247
|
* @type {any}
|
|
245
248
|
* @memberof CustomSchemaApiListCustomSchemas
|
|
246
249
|
*/
|
|
@@ -257,6 +260,12 @@ export interface CustomSchemaApiListCustomSchemasRequest {
|
|
|
257
260
|
* @memberof CustomSchemaApiListCustomSchemas
|
|
258
261
|
*/
|
|
259
262
|
readonly expand?: any;
|
|
263
|
+
/**
|
|
264
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
265
|
+
* @type {any}
|
|
266
|
+
* @memberof CustomSchemaApiListCustomSchemas
|
|
267
|
+
*/
|
|
268
|
+
readonly filters?: any;
|
|
260
269
|
}
|
|
261
270
|
/**
|
|
262
271
|
* Request parameters for updateCustomSchema operation in CustomSchemaApi.
|
|
@@ -300,7 +309,7 @@ export declare class CustomSchemaApi extends BaseAPI {
|
|
|
300
309
|
*/
|
|
301
310
|
createCustomSchema(requestParameters: CustomSchemaApiCreateCustomSchemaRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateCustomSchemaResponseClass, any>>;
|
|
302
311
|
/**
|
|
303
|
-
* Retrieves the details of the custom-schema that was previously created. Supply the unique custom-schema code
|
|
312
|
+
* Retrieves the details of the custom-schema that was previously created. Supply the unique custom-schema code that was returned when you created it and Emil Api will return the corresponding custom-schema information.
|
|
304
313
|
* @summary Retrieve the custom-schema
|
|
305
314
|
* @param {CustomSchemaApiGetCustomSchemaRequest} requestParameters Request parameters.
|
|
306
315
|
* @param {*} [options] Override http request option.
|
|
@@ -309,7 +318,7 @@ export declare class CustomSchemaApi extends BaseAPI {
|
|
|
309
318
|
*/
|
|
310
319
|
getCustomSchema(requestParameters: CustomSchemaApiGetCustomSchemaRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetCustomSchemaResponseClass, any>>;
|
|
311
320
|
/**
|
|
312
|
-
* Returns a list of custom-schemas you have previously created.
|
|
321
|
+
* Returns a list of custom-schemas you have previously created. The custom-schemas are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
313
322
|
* @summary List custom-schemas
|
|
314
323
|
* @param {CustomSchemaApiListCustomSchemasRequest} requestParameters Request parameters.
|
|
315
324
|
* @param {*} [options] Override http request option.
|
|
@@ -142,7 +142,7 @@ var CustomSchemaApiAxiosParamCreator = function (configuration) {
|
|
|
142
142
|
});
|
|
143
143
|
},
|
|
144
144
|
/**
|
|
145
|
-
* Retrieves the details of the custom-schema that was previously created. Supply the unique custom-schema code
|
|
145
|
+
* Retrieves the details of the custom-schema that was previously created. Supply the unique custom-schema code that was returned when you created it and Emil Api will return the corresponding custom-schema information.
|
|
146
146
|
* @summary Retrieve the custom-schema
|
|
147
147
|
* @param {string} code Unique identifier for the object.
|
|
148
148
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -194,19 +194,20 @@ var CustomSchemaApiAxiosParamCreator = function (configuration) {
|
|
|
194
194
|
});
|
|
195
195
|
},
|
|
196
196
|
/**
|
|
197
|
-
* Returns a list of custom-schemas you have previously created.
|
|
197
|
+
* Returns a list of custom-schemas you have previously created. The custom-schemas are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
198
198
|
* @summary List custom-schemas
|
|
199
199
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
200
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
200
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
201
201
|
* @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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
202
202
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
203
|
-
* @param {any} [search]
|
|
203
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
204
204
|
* @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.
|
|
205
205
|
* @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.
|
|
206
|
+
* @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
206
207
|
* @param {*} [options] Override http request option.
|
|
207
208
|
* @throws {RequiredError}
|
|
208
209
|
*/
|
|
209
|
-
listCustomSchemas: function (authorization, pageSize, pageToken, filter, search, order, expand, options) {
|
|
210
|
+
listCustomSchemas: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
210
211
|
if (options === void 0) { options = {}; }
|
|
211
212
|
return __awaiter(_this, void 0, void 0, function () {
|
|
212
213
|
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
@@ -247,6 +248,9 @@ var CustomSchemaApiAxiosParamCreator = function (configuration) {
|
|
|
247
248
|
if (expand !== undefined) {
|
|
248
249
|
localVarQueryParameter['expand'] = expand;
|
|
249
250
|
}
|
|
251
|
+
if (filters !== undefined) {
|
|
252
|
+
localVarQueryParameter['filters'] = filters;
|
|
253
|
+
}
|
|
250
254
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
251
255
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
252
256
|
}
|
|
@@ -346,7 +350,7 @@ var CustomSchemaApiFp = function (configuration) {
|
|
|
346
350
|
});
|
|
347
351
|
},
|
|
348
352
|
/**
|
|
349
|
-
* Retrieves the details of the custom-schema that was previously created. Supply the unique custom-schema code
|
|
353
|
+
* Retrieves the details of the custom-schema that was previously created. Supply the unique custom-schema code that was returned when you created it and Emil Api will return the corresponding custom-schema information.
|
|
350
354
|
* @summary Retrieve the custom-schema
|
|
351
355
|
* @param {string} code Unique identifier for the object.
|
|
352
356
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -368,24 +372,25 @@ var CustomSchemaApiFp = function (configuration) {
|
|
|
368
372
|
});
|
|
369
373
|
},
|
|
370
374
|
/**
|
|
371
|
-
* Returns a list of custom-schemas you have previously created.
|
|
375
|
+
* Returns a list of custom-schemas you have previously created. The custom-schemas are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
372
376
|
* @summary List custom-schemas
|
|
373
377
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
374
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
378
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
375
379
|
* @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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
376
380
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
377
|
-
* @param {any} [search]
|
|
381
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
378
382
|
* @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.
|
|
379
383
|
* @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.
|
|
384
|
+
* @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
380
385
|
* @param {*} [options] Override http request option.
|
|
381
386
|
* @throws {RequiredError}
|
|
382
387
|
*/
|
|
383
|
-
listCustomSchemas: function (authorization, pageSize, pageToken, filter, search, order, expand, options) {
|
|
388
|
+
listCustomSchemas: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
384
389
|
return __awaiter(this, void 0, void 0, function () {
|
|
385
390
|
var localVarAxiosArgs;
|
|
386
391
|
return __generator(this, function (_a) {
|
|
387
392
|
switch (_a.label) {
|
|
388
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.listCustomSchemas(authorization, pageSize, pageToken, filter, search, order, expand, options)];
|
|
393
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.listCustomSchemas(authorization, pageSize, pageToken, filter, search, order, expand, filters, options)];
|
|
389
394
|
case 1:
|
|
390
395
|
localVarAxiosArgs = _a.sent();
|
|
391
396
|
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
@@ -437,7 +442,7 @@ var CustomSchemaApiFactory = function (configuration, basePath, axios) {
|
|
|
437
442
|
return localVarFp.createCustomSchema(createCustomSchemaRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
438
443
|
},
|
|
439
444
|
/**
|
|
440
|
-
* Retrieves the details of the custom-schema that was previously created. Supply the unique custom-schema code
|
|
445
|
+
* Retrieves the details of the custom-schema that was previously created. Supply the unique custom-schema code that was returned when you created it and Emil Api will return the corresponding custom-schema information.
|
|
441
446
|
* @summary Retrieve the custom-schema
|
|
442
447
|
* @param {string} code Unique identifier for the object.
|
|
443
448
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -449,20 +454,21 @@ var CustomSchemaApiFactory = function (configuration, basePath, axios) {
|
|
|
449
454
|
return localVarFp.getCustomSchema(code, authorization, expand, options).then(function (request) { return request(axios, basePath); });
|
|
450
455
|
},
|
|
451
456
|
/**
|
|
452
|
-
* Returns a list of custom-schemas you have previously created.
|
|
457
|
+
* Returns a list of custom-schemas you have previously created. The custom-schemas are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
453
458
|
* @summary List custom-schemas
|
|
454
459
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
455
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
460
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
456
461
|
* @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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
457
462
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
458
|
-
* @param {any} [search]
|
|
463
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
459
464
|
* @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.
|
|
460
465
|
* @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.
|
|
466
|
+
* @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
461
467
|
* @param {*} [options] Override http request option.
|
|
462
468
|
* @throws {RequiredError}
|
|
463
469
|
*/
|
|
464
|
-
listCustomSchemas: function (authorization, pageSize, pageToken, filter, search, order, expand, options) {
|
|
465
|
-
return localVarFp.listCustomSchemas(authorization, pageSize, pageToken, filter, search, order, expand, options).then(function (request) { return request(axios, basePath); });
|
|
470
|
+
listCustomSchemas: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
471
|
+
return localVarFp.listCustomSchemas(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
|
|
466
472
|
},
|
|
467
473
|
/**
|
|
468
474
|
* Updates the specified custom-schema by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
@@ -503,7 +509,7 @@ var CustomSchemaApi = /** @class */ (function (_super) {
|
|
|
503
509
|
return (0, exports.CustomSchemaApiFp)(this.configuration).createCustomSchema(requestParameters.createCustomSchemaRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
504
510
|
};
|
|
505
511
|
/**
|
|
506
|
-
* Retrieves the details of the custom-schema that was previously created. Supply the unique custom-schema code
|
|
512
|
+
* Retrieves the details of the custom-schema that was previously created. Supply the unique custom-schema code that was returned when you created it and Emil Api will return the corresponding custom-schema information.
|
|
507
513
|
* @summary Retrieve the custom-schema
|
|
508
514
|
* @param {CustomSchemaApiGetCustomSchemaRequest} requestParameters Request parameters.
|
|
509
515
|
* @param {*} [options] Override http request option.
|
|
@@ -515,7 +521,7 @@ var CustomSchemaApi = /** @class */ (function (_super) {
|
|
|
515
521
|
return (0, exports.CustomSchemaApiFp)(this.configuration).getCustomSchema(requestParameters.code, requestParameters.authorization, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
516
522
|
};
|
|
517
523
|
/**
|
|
518
|
-
* Returns a list of custom-schemas you have previously created.
|
|
524
|
+
* Returns a list of custom-schemas you have previously created. The custom-schemas are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
519
525
|
* @summary List custom-schemas
|
|
520
526
|
* @param {CustomSchemaApiListCustomSchemasRequest} requestParameters Request parameters.
|
|
521
527
|
* @param {*} [options] Override http request option.
|
|
@@ -525,7 +531,7 @@ var CustomSchemaApi = /** @class */ (function (_super) {
|
|
|
525
531
|
CustomSchemaApi.prototype.listCustomSchemas = function (requestParameters, options) {
|
|
526
532
|
var _this = this;
|
|
527
533
|
if (requestParameters === void 0) { requestParameters = {}; }
|
|
528
|
-
return (0, exports.CustomSchemaApiFp)(this.configuration).listCustomSchemas(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
534
|
+
return (0, exports.CustomSchemaApiFp)(this.configuration).listCustomSchemas(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
529
535
|
};
|
|
530
536
|
/**
|
|
531
537
|
* Updates the specified custom-schema by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
@@ -31,7 +31,7 @@ export declare const DataReportApiAxiosParamCreator: (configuration?: Configurat
|
|
|
31
31
|
* @param {*} [options] Override http request option.
|
|
32
32
|
* @throws {RequiredError}
|
|
33
33
|
*/
|
|
34
|
-
|
|
34
|
+
createDataReport: (createDataReportRequestDto: CreateDataReportRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
35
35
|
/**
|
|
36
36
|
*
|
|
37
37
|
* @param {string} id
|
|
@@ -41,7 +41,7 @@ export declare const DataReportApiAxiosParamCreator: (configuration?: Configurat
|
|
|
41
41
|
*/
|
|
42
42
|
deleteAlert: (id: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
43
43
|
/**
|
|
44
|
-
* Retrieves the details of the data-report that was previously created. Supply the unique data-report code
|
|
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
45
|
* @summary Retrieve the data-report
|
|
46
46
|
* @param {string} code Unique identifier for the object.
|
|
47
47
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -51,19 +51,20 @@ export declare const DataReportApiAxiosParamCreator: (configuration?: Configurat
|
|
|
51
51
|
*/
|
|
52
52
|
getDataReport: (code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
53
53
|
/**
|
|
54
|
-
* Returns a list of data-reports you have previously created.
|
|
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
55
|
* @summary List data-reports
|
|
56
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
|
|
57
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
58
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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
59
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]
|
|
60
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
61
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
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 {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
63
64
|
* @param {*} [options] Override http request option.
|
|
64
65
|
* @throws {RequiredError}
|
|
65
66
|
*/
|
|
66
|
-
listDataReports: (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
67
|
+
listDataReports: (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
67
68
|
/**
|
|
68
69
|
* Updates the specified data-report by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
69
70
|
* @summary Update the data-report
|
|
@@ -88,7 +89,7 @@ export declare const DataReportApiFp: (configuration?: Configuration) => {
|
|
|
88
89
|
* @param {*} [options] Override http request option.
|
|
89
90
|
* @throws {RequiredError}
|
|
90
91
|
*/
|
|
91
|
-
|
|
92
|
+
createDataReport(createDataReportRequestDto: CreateDataReportRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateDataReportResponseClass>>;
|
|
92
93
|
/**
|
|
93
94
|
*
|
|
94
95
|
* @param {string} id
|
|
@@ -98,7 +99,7 @@ export declare const DataReportApiFp: (configuration?: Configuration) => {
|
|
|
98
99
|
*/
|
|
99
100
|
deleteAlert(id: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
100
101
|
/**
|
|
101
|
-
* Retrieves the details of the data-report that was previously created. Supply the unique data-report code
|
|
102
|
+
* 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
103
|
* @summary Retrieve the data-report
|
|
103
104
|
* @param {string} code Unique identifier for the object.
|
|
104
105
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -108,19 +109,20 @@ export declare const DataReportApiFp: (configuration?: Configuration) => {
|
|
|
108
109
|
*/
|
|
109
110
|
getDataReport(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetDataReportResponseClass>>;
|
|
110
111
|
/**
|
|
111
|
-
* Returns a list of data-reports you have previously created.
|
|
112
|
+
* 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
113
|
* @summary List data-reports
|
|
113
114
|
* @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
|
|
115
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
115
116
|
* @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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
116
117
|
* @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]
|
|
118
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
118
119
|
* @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
120
|
* @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.
|
|
121
|
+
* @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
120
122
|
* @param {*} [options] Override http request option.
|
|
121
123
|
* @throws {RequiredError}
|
|
122
124
|
*/
|
|
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>>;
|
|
125
|
+
listDataReports(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListDataReportsResponseClass>>;
|
|
124
126
|
/**
|
|
125
127
|
* Updates the specified data-report by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
126
128
|
* @summary Update the data-report
|
|
@@ -145,7 +147,7 @@ export declare const DataReportApiFactory: (configuration?: Configuration, baseP
|
|
|
145
147
|
* @param {*} [options] Override http request option.
|
|
146
148
|
* @throws {RequiredError}
|
|
147
149
|
*/
|
|
148
|
-
|
|
150
|
+
createDataReport(createDataReportRequestDto: CreateDataReportRequestDto, authorization?: string, options?: any): AxiosPromise<CreateDataReportResponseClass>;
|
|
149
151
|
/**
|
|
150
152
|
*
|
|
151
153
|
* @param {string} id
|
|
@@ -155,7 +157,7 @@ export declare const DataReportApiFactory: (configuration?: Configuration, baseP
|
|
|
155
157
|
*/
|
|
156
158
|
deleteAlert(id: string, authorization?: string, options?: any): AxiosPromise<void>;
|
|
157
159
|
/**
|
|
158
|
-
* Retrieves the details of the data-report that was previously created. Supply the unique data-report code
|
|
160
|
+
* 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
161
|
* @summary Retrieve the data-report
|
|
160
162
|
* @param {string} code Unique identifier for the object.
|
|
161
163
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -165,19 +167,20 @@ export declare const DataReportApiFactory: (configuration?: Configuration, baseP
|
|
|
165
167
|
*/
|
|
166
168
|
getDataReport(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetDataReportResponseClass>;
|
|
167
169
|
/**
|
|
168
|
-
* Returns a list of data-reports you have previously created.
|
|
170
|
+
* 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
171
|
* @summary List data-reports
|
|
170
172
|
* @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
|
|
173
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
172
174
|
* @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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
173
175
|
* @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]
|
|
176
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
175
177
|
* @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
178
|
* @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.
|
|
179
|
+
* @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
177
180
|
* @param {*} [options] Override http request option.
|
|
178
181
|
* @throws {RequiredError}
|
|
179
182
|
*/
|
|
180
|
-
listDataReports(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: any): AxiosPromise<ListDataReportsResponseClass>;
|
|
183
|
+
listDataReports(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: any): AxiosPromise<ListDataReportsResponseClass>;
|
|
181
184
|
/**
|
|
182
185
|
* Updates the specified data-report by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
183
186
|
* @summary Update the data-report
|
|
@@ -190,21 +193,21 @@ export declare const DataReportApiFactory: (configuration?: Configuration, baseP
|
|
|
190
193
|
updateDataReport(code: string, updateDataReportRequestDto: UpdateDataReportRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateDataReportResponseClass>;
|
|
191
194
|
};
|
|
192
195
|
/**
|
|
193
|
-
* Request parameters for
|
|
196
|
+
* Request parameters for createDataReport operation in DataReportApi.
|
|
194
197
|
* @export
|
|
195
|
-
* @interface
|
|
198
|
+
* @interface DataReportApiCreateDataReportRequest
|
|
196
199
|
*/
|
|
197
|
-
export interface
|
|
200
|
+
export interface DataReportApiCreateDataReportRequest {
|
|
198
201
|
/**
|
|
199
202
|
*
|
|
200
203
|
* @type {CreateDataReportRequestDto}
|
|
201
|
-
* @memberof
|
|
204
|
+
* @memberof DataReportApiCreateDataReport
|
|
202
205
|
*/
|
|
203
206
|
readonly createDataReportRequestDto: CreateDataReportRequestDto;
|
|
204
207
|
/**
|
|
205
208
|
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
206
209
|
* @type {string}
|
|
207
|
-
* @memberof
|
|
210
|
+
* @memberof DataReportApiCreateDataReport
|
|
208
211
|
*/
|
|
209
212
|
readonly authorization?: string;
|
|
210
213
|
}
|
|
@@ -265,7 +268,7 @@ export interface DataReportApiListDataReportsRequest {
|
|
|
265
268
|
*/
|
|
266
269
|
readonly authorization?: string;
|
|
267
270
|
/**
|
|
268
|
-
* A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
271
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
269
272
|
* @type {any}
|
|
270
273
|
* @memberof DataReportApiListDataReports
|
|
271
274
|
*/
|
|
@@ -283,7 +286,7 @@ export interface DataReportApiListDataReportsRequest {
|
|
|
283
286
|
*/
|
|
284
287
|
readonly filter?: any;
|
|
285
288
|
/**
|
|
286
|
-
*
|
|
289
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
287
290
|
* @type {any}
|
|
288
291
|
* @memberof DataReportApiListDataReports
|
|
289
292
|
*/
|
|
@@ -300,6 +303,12 @@ export interface DataReportApiListDataReportsRequest {
|
|
|
300
303
|
* @memberof DataReportApiListDataReports
|
|
301
304
|
*/
|
|
302
305
|
readonly expand?: any;
|
|
306
|
+
/**
|
|
307
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
308
|
+
* @type {any}
|
|
309
|
+
* @memberof DataReportApiListDataReports
|
|
310
|
+
*/
|
|
311
|
+
readonly filters?: any;
|
|
303
312
|
}
|
|
304
313
|
/**
|
|
305
314
|
* Request parameters for updateDataReport operation in DataReportApi.
|
|
@@ -336,12 +345,12 @@ export declare class DataReportApi extends BaseAPI {
|
|
|
336
345
|
/**
|
|
337
346
|
* This will create a data report for tenant in the database
|
|
338
347
|
* @summary Create the data-report
|
|
339
|
-
* @param {
|
|
348
|
+
* @param {DataReportApiCreateDataReportRequest} requestParameters Request parameters.
|
|
340
349
|
* @param {*} [options] Override http request option.
|
|
341
350
|
* @throws {RequiredError}
|
|
342
351
|
* @memberof DataReportApi
|
|
343
352
|
*/
|
|
344
|
-
|
|
353
|
+
createDataReport(requestParameters: DataReportApiCreateDataReportRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateDataReportResponseClass, any>>;
|
|
345
354
|
/**
|
|
346
355
|
*
|
|
347
356
|
* @param {DataReportApiDeleteAlertRequest} requestParameters Request parameters.
|
|
@@ -351,7 +360,7 @@ export declare class DataReportApi extends BaseAPI {
|
|
|
351
360
|
*/
|
|
352
361
|
deleteAlert(requestParameters: DataReportApiDeleteAlertRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
353
362
|
/**
|
|
354
|
-
* Retrieves the details of the data-report that was previously created. Supply the unique data-report code
|
|
363
|
+
* 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
364
|
* @summary Retrieve the data-report
|
|
356
365
|
* @param {DataReportApiGetDataReportRequest} requestParameters Request parameters.
|
|
357
366
|
* @param {*} [options] Override http request option.
|
|
@@ -360,7 +369,7 @@ export declare class DataReportApi extends BaseAPI {
|
|
|
360
369
|
*/
|
|
361
370
|
getDataReport(requestParameters: DataReportApiGetDataReportRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetDataReportResponseClass, any>>;
|
|
362
371
|
/**
|
|
363
|
-
* Returns a list of data-reports you have previously created.
|
|
372
|
+
* 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
373
|
* @summary List data-reports
|
|
365
374
|
* @param {DataReportApiListDataReportsRequest} requestParameters Request parameters.
|
|
366
375
|
* @param {*} [options] Override http request option.
|