@emilgroup/tenant-sdk 1.9.0 → 1.15.1-beta.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 +1 -2
- package/README.md +2 -2
- package/api/custom-schema-api.ts +36 -22
- package/api/data-report-api.ts +50 -36
- package/api/delete-organization-invitations-api.ts +161 -0
- 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/api.ts +2 -0
- package/base.ts +1 -0
- 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/delete-organization-invitations-api.d.ts +96 -0
- package/dist/api/delete-organization-invitations-api.js +223 -0
- 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/api.d.ts +1 -0
- package/dist/api.js +1 -0
- package/dist/base.js +1 -0
- 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 +43 -11
- 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 -2
- package/dist/models/index.js +0 -2
- 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/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 +44 -12
- 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 -2
- 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/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 -2
- package/dist/models/custom-field-option-dto.d.ts +0 -30
- package/dist/models/custom-field-option-dto.js +0 -15
- 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/custom-field-option-dto.ts +0 -36
- package/models/set-user-setting-response-class.ts +0 -42
package/.openapi-generator/FILES
CHANGED
|
@@ -7,6 +7,7 @@ api/custom-schema-api.ts
|
|
|
7
7
|
api/data-report-api.ts
|
|
8
8
|
api/data-report-executor-api.ts
|
|
9
9
|
api/default-api.ts
|
|
10
|
+
api/delete-organization-invitations-api.ts
|
|
10
11
|
api/invite-organizations-api.ts
|
|
11
12
|
api/invite-users-api.ts
|
|
12
13
|
api/list-organization-invitations-api.ts
|
|
@@ -32,7 +33,6 @@ models/create-permission-request-dto.ts
|
|
|
32
33
|
models/create-role-request-dto.ts
|
|
33
34
|
models/create-tenant-request-dto.ts
|
|
34
35
|
models/custom-field-dto.ts
|
|
35
|
-
models/custom-field-option-dto.ts
|
|
36
36
|
models/custom-schema-class.ts
|
|
37
37
|
models/data-report-class.ts
|
|
38
38
|
models/data-report-filter-class.ts
|
|
@@ -79,7 +79,6 @@ models/role-class.ts
|
|
|
79
79
|
models/run-data-report-request-dto.ts
|
|
80
80
|
models/run-data-report-response-class.ts
|
|
81
81
|
models/set-setting-request-dto.ts
|
|
82
|
-
models/set-user-setting-response-class.ts
|
|
83
82
|
models/subscription-class.ts
|
|
84
83
|
models/tenant-admin-user-dto.ts
|
|
85
84
|
models/tenant-settings-class.ts
|
package/README.md
CHANGED
|
@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
|
|
|
17
17
|
Navigate to the folder of your consuming project and run one of the following commands:
|
|
18
18
|
|
|
19
19
|
```
|
|
20
|
-
npm install @emilgroup/tenant-sdk@1.
|
|
20
|
+
npm install @emilgroup/tenant-sdk@1.15.1-beta.0 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/tenant-sdk@1.
|
|
24
|
+
yarn add @emilgroup/tenant-sdk@1.15.1-beta.0
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import `UsersApi`.
|
package/api/custom-schema-api.ts
CHANGED
|
@@ -86,7 +86,7 @@ export const CustomSchemaApiAxiosParamCreator = function (configuration?: Config
|
|
|
86
86
|
};
|
|
87
87
|
},
|
|
88
88
|
/**
|
|
89
|
-
* Retrieves the details of the custom-schema that was previously created. Supply the unique custom-schema code
|
|
89
|
+
* 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.
|
|
90
90
|
* @summary Retrieve the custom-schema
|
|
91
91
|
* @param {string} code Unique identifier for the object.
|
|
92
92
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -136,19 +136,20 @@ export const CustomSchemaApiAxiosParamCreator = function (configuration?: Config
|
|
|
136
136
|
};
|
|
137
137
|
},
|
|
138
138
|
/**
|
|
139
|
-
* Returns a list of custom-schemas you have previously created.
|
|
139
|
+
* 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.
|
|
140
140
|
* @summary List custom-schemas
|
|
141
141
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
142
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
142
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
143
143
|
* @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.
|
|
144
144
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
145
|
-
* @param {any} [search]
|
|
145
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
146
146
|
* @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.
|
|
147
147
|
* @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.
|
|
148
|
+
* @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.
|
|
148
149
|
* @param {*} [options] Override http request option.
|
|
149
150
|
* @throws {RequiredError}
|
|
150
151
|
*/
|
|
151
|
-
listCustomSchemas: async (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
152
|
+
listCustomSchemas: async (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
152
153
|
const localVarPath = `/tenantservice/v1/custom-schemas`;
|
|
153
154
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
154
155
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -191,6 +192,10 @@ export const CustomSchemaApiAxiosParamCreator = function (configuration?: Config
|
|
|
191
192
|
localVarQueryParameter['expand'] = expand;
|
|
192
193
|
}
|
|
193
194
|
|
|
195
|
+
if (filters !== undefined) {
|
|
196
|
+
localVarQueryParameter['filters'] = filters;
|
|
197
|
+
}
|
|
198
|
+
|
|
194
199
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
195
200
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
196
201
|
}
|
|
@@ -280,7 +285,7 @@ export const CustomSchemaApiFp = function(configuration?: Configuration) {
|
|
|
280
285
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
281
286
|
},
|
|
282
287
|
/**
|
|
283
|
-
* Retrieves the details of the custom-schema that was previously created. Supply the unique custom-schema code
|
|
288
|
+
* 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.
|
|
284
289
|
* @summary Retrieve the custom-schema
|
|
285
290
|
* @param {string} code Unique identifier for the object.
|
|
286
291
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -293,20 +298,21 @@ export const CustomSchemaApiFp = function(configuration?: Configuration) {
|
|
|
293
298
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
294
299
|
},
|
|
295
300
|
/**
|
|
296
|
-
* Returns a list of custom-schemas you have previously created.
|
|
301
|
+
* 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.
|
|
297
302
|
* @summary List custom-schemas
|
|
298
303
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
299
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
304
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
300
305
|
* @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.
|
|
301
306
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
302
|
-
* @param {any} [search]
|
|
307
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
303
308
|
* @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.
|
|
304
309
|
* @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.
|
|
310
|
+
* @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.
|
|
305
311
|
* @param {*} [options] Override http request option.
|
|
306
312
|
* @throws {RequiredError}
|
|
307
313
|
*/
|
|
308
|
-
async listCustomSchemas(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCustomSchemasResponseClass>> {
|
|
309
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listCustomSchemas(authorization, pageSize, pageToken, filter, search, order, expand, options);
|
|
314
|
+
async 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>> {
|
|
315
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listCustomSchemas(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
310
316
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
311
317
|
},
|
|
312
318
|
/**
|
|
@@ -344,7 +350,7 @@ export const CustomSchemaApiFactory = function (configuration?: Configuration, b
|
|
|
344
350
|
return localVarFp.createCustomSchema(createCustomSchemaRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
345
351
|
},
|
|
346
352
|
/**
|
|
347
|
-
* 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.
|
|
348
354
|
* @summary Retrieve the custom-schema
|
|
349
355
|
* @param {string} code Unique identifier for the object.
|
|
350
356
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -356,20 +362,21 @@ export const CustomSchemaApiFactory = function (configuration?: Configuration, b
|
|
|
356
362
|
return localVarFp.getCustomSchema(code, authorization, expand, options).then((request) => request(axios, basePath));
|
|
357
363
|
},
|
|
358
364
|
/**
|
|
359
|
-
* Returns a list of custom-schemas you have previously created.
|
|
365
|
+
* 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.
|
|
360
366
|
* @summary List custom-schemas
|
|
361
367
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
362
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
368
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
363
369
|
* @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.
|
|
364
370
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
365
|
-
* @param {any} [search]
|
|
371
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
366
372
|
* @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.
|
|
367
373
|
* @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.
|
|
374
|
+
* @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.
|
|
368
375
|
* @param {*} [options] Override http request option.
|
|
369
376
|
* @throws {RequiredError}
|
|
370
377
|
*/
|
|
371
|
-
listCustomSchemas(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: any): AxiosPromise<ListCustomSchemasResponseClass> {
|
|
372
|
-
return localVarFp.listCustomSchemas(authorization, pageSize, pageToken, filter, search, order, expand, options).then((request) => request(axios, basePath));
|
|
378
|
+
listCustomSchemas(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: any): AxiosPromise<ListCustomSchemasResponseClass> {
|
|
379
|
+
return localVarFp.listCustomSchemas(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
373
380
|
},
|
|
374
381
|
/**
|
|
375
382
|
* Updates the specified custom-schema by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
@@ -449,7 +456,7 @@ export interface CustomSchemaApiListCustomSchemasRequest {
|
|
|
449
456
|
readonly authorization?: string
|
|
450
457
|
|
|
451
458
|
/**
|
|
452
|
-
* A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
459
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
453
460
|
* @type {any}
|
|
454
461
|
* @memberof CustomSchemaApiListCustomSchemas
|
|
455
462
|
*/
|
|
@@ -470,7 +477,7 @@ export interface CustomSchemaApiListCustomSchemasRequest {
|
|
|
470
477
|
readonly filter?: any
|
|
471
478
|
|
|
472
479
|
/**
|
|
473
|
-
*
|
|
480
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
474
481
|
* @type {any}
|
|
475
482
|
* @memberof CustomSchemaApiListCustomSchemas
|
|
476
483
|
*/
|
|
@@ -489,6 +496,13 @@ export interface CustomSchemaApiListCustomSchemasRequest {
|
|
|
489
496
|
* @memberof CustomSchemaApiListCustomSchemas
|
|
490
497
|
*/
|
|
491
498
|
readonly expand?: any
|
|
499
|
+
|
|
500
|
+
/**
|
|
501
|
+
* 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.
|
|
502
|
+
* @type {any}
|
|
503
|
+
* @memberof CustomSchemaApiListCustomSchemas
|
|
504
|
+
*/
|
|
505
|
+
readonly filters?: any
|
|
492
506
|
}
|
|
493
507
|
|
|
494
508
|
/**
|
|
@@ -539,7 +553,7 @@ export class CustomSchemaApi extends BaseAPI {
|
|
|
539
553
|
}
|
|
540
554
|
|
|
541
555
|
/**
|
|
542
|
-
* Retrieves the details of the custom-schema that was previously created. Supply the unique custom-schema code
|
|
556
|
+
* 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.
|
|
543
557
|
* @summary Retrieve the custom-schema
|
|
544
558
|
* @param {CustomSchemaApiGetCustomSchemaRequest} requestParameters Request parameters.
|
|
545
559
|
* @param {*} [options] Override http request option.
|
|
@@ -551,7 +565,7 @@ export class CustomSchemaApi extends BaseAPI {
|
|
|
551
565
|
}
|
|
552
566
|
|
|
553
567
|
/**
|
|
554
|
-
* Returns a list of custom-schemas you have previously created.
|
|
568
|
+
* 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.
|
|
555
569
|
* @summary List custom-schemas
|
|
556
570
|
* @param {CustomSchemaApiListCustomSchemasRequest} requestParameters Request parameters.
|
|
557
571
|
* @param {*} [options] Override http request option.
|
|
@@ -559,7 +573,7 @@ export class CustomSchemaApi extends BaseAPI {
|
|
|
559
573
|
* @memberof CustomSchemaApi
|
|
560
574
|
*/
|
|
561
575
|
public listCustomSchemas(requestParameters: CustomSchemaApiListCustomSchemasRequest = {}, options?: AxiosRequestConfig) {
|
|
562
|
-
return CustomSchemaApiFp(this.configuration).listCustomSchemas(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
|
|
576
|
+
return CustomSchemaApiFp(this.configuration).listCustomSchemas(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
|
|
563
577
|
}
|
|
564
578
|
|
|
565
579
|
/**
|
package/api/data-report-api.ts
CHANGED
|
@@ -46,9 +46,9 @@ export const DataReportApiAxiosParamCreator = function (configuration?: Configur
|
|
|
46
46
|
* @param {*} [options] Override http request option.
|
|
47
47
|
* @throws {RequiredError}
|
|
48
48
|
*/
|
|
49
|
-
|
|
49
|
+
createDataReport: async (createDataReportRequestDto: CreateDataReportRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
50
50
|
// verify required parameter 'createDataReportRequestDto' is not null or undefined
|
|
51
|
-
assertParamExists('
|
|
51
|
+
assertParamExists('createDataReport', 'createDataReportRequestDto', createDataReportRequestDto)
|
|
52
52
|
const localVarPath = `/tenantservice/v1/data-reports`;
|
|
53
53
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
54
54
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -130,7 +130,7 @@ export const DataReportApiAxiosParamCreator = function (configuration?: Configur
|
|
|
130
130
|
};
|
|
131
131
|
},
|
|
132
132
|
/**
|
|
133
|
-
* Retrieves the details of the data-report that was previously created. Supply the unique data-report code
|
|
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
134
|
* @summary Retrieve the data-report
|
|
135
135
|
* @param {string} code Unique identifier for the object.
|
|
136
136
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -180,19 +180,20 @@ export const DataReportApiAxiosParamCreator = function (configuration?: Configur
|
|
|
180
180
|
};
|
|
181
181
|
},
|
|
182
182
|
/**
|
|
183
|
-
* Returns a list of data-reports you have previously created.
|
|
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
184
|
* @summary List data-reports
|
|
185
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
|
|
186
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
187
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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
188
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]
|
|
189
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
190
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
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 {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.
|
|
192
193
|
* @param {*} [options] Override http request option.
|
|
193
194
|
* @throws {RequiredError}
|
|
194
195
|
*/
|
|
195
|
-
listDataReports: async (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
196
|
+
listDataReports: async (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
196
197
|
const localVarPath = `/tenantservice/v1/data-reports`;
|
|
197
198
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
198
199
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -235,6 +236,10 @@ export const DataReportApiAxiosParamCreator = function (configuration?: Configur
|
|
|
235
236
|
localVarQueryParameter['expand'] = expand;
|
|
236
237
|
}
|
|
237
238
|
|
|
239
|
+
if (filters !== undefined) {
|
|
240
|
+
localVarQueryParameter['filters'] = filters;
|
|
241
|
+
}
|
|
242
|
+
|
|
238
243
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
239
244
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
240
245
|
}
|
|
@@ -319,8 +324,8 @@ export const DataReportApiFp = function(configuration?: Configuration) {
|
|
|
319
324
|
* @param {*} [options] Override http request option.
|
|
320
325
|
* @throws {RequiredError}
|
|
321
326
|
*/
|
|
322
|
-
async
|
|
323
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
327
|
+
async createDataReport(createDataReportRequestDto: CreateDataReportRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateDataReportResponseClass>> {
|
|
328
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createDataReport(createDataReportRequestDto, authorization, options);
|
|
324
329
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
325
330
|
},
|
|
326
331
|
/**
|
|
@@ -335,7 +340,7 @@ export const DataReportApiFp = function(configuration?: Configuration) {
|
|
|
335
340
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
336
341
|
},
|
|
337
342
|
/**
|
|
338
|
-
* Retrieves the details of the data-report that was previously created. Supply the unique data-report code
|
|
343
|
+
* 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
344
|
* @summary Retrieve the data-report
|
|
340
345
|
* @param {string} code Unique identifier for the object.
|
|
341
346
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -348,20 +353,21 @@ export const DataReportApiFp = function(configuration?: Configuration) {
|
|
|
348
353
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
349
354
|
},
|
|
350
355
|
/**
|
|
351
|
-
* Returns a list of data-reports you have previously created.
|
|
356
|
+
* 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
357
|
* @summary List data-reports
|
|
353
358
|
* @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
|
|
359
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
355
360
|
* @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.
|
|
356
361
|
* @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]
|
|
362
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
358
363
|
* @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
364
|
* @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.
|
|
365
|
+
* @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.
|
|
360
366
|
* @param {*} [options] Override http request option.
|
|
361
367
|
* @throws {RequiredError}
|
|
362
368
|
*/
|
|
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);
|
|
369
|
+
async 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>> {
|
|
370
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listDataReports(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
365
371
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
366
372
|
},
|
|
367
373
|
/**
|
|
@@ -395,8 +401,8 @@ export const DataReportApiFactory = function (configuration?: Configuration, bas
|
|
|
395
401
|
* @param {*} [options] Override http request option.
|
|
396
402
|
* @throws {RequiredError}
|
|
397
403
|
*/
|
|
398
|
-
|
|
399
|
-
return localVarFp.
|
|
404
|
+
createDataReport(createDataReportRequestDto: CreateDataReportRequestDto, authorization?: string, options?: any): AxiosPromise<CreateDataReportResponseClass> {
|
|
405
|
+
return localVarFp.createDataReport(createDataReportRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
400
406
|
},
|
|
401
407
|
/**
|
|
402
408
|
*
|
|
@@ -409,7 +415,7 @@ export const DataReportApiFactory = function (configuration?: Configuration, bas
|
|
|
409
415
|
return localVarFp.deleteAlert(id, authorization, options).then((request) => request(axios, basePath));
|
|
410
416
|
},
|
|
411
417
|
/**
|
|
412
|
-
* Retrieves the details of the data-report that was previously created. Supply the unique data-report code
|
|
418
|
+
* 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
419
|
* @summary Retrieve the data-report
|
|
414
420
|
* @param {string} code Unique identifier for the object.
|
|
415
421
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -421,20 +427,21 @@ export const DataReportApiFactory = function (configuration?: Configuration, bas
|
|
|
421
427
|
return localVarFp.getDataReport(code, authorization, expand, options).then((request) => request(axios, basePath));
|
|
422
428
|
},
|
|
423
429
|
/**
|
|
424
|
-
* Returns a list of data-reports you have previously created.
|
|
430
|
+
* 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
431
|
* @summary List data-reports
|
|
426
432
|
* @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
|
|
433
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
428
434
|
* @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.
|
|
429
435
|
* @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]
|
|
436
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
431
437
|
* @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
438
|
* @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.
|
|
439
|
+
* @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.
|
|
433
440
|
* @param {*} [options] Override http request option.
|
|
434
441
|
* @throws {RequiredError}
|
|
435
442
|
*/
|
|
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));
|
|
443
|
+
listDataReports(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: any): AxiosPromise<ListDataReportsResponseClass> {
|
|
444
|
+
return localVarFp.listDataReports(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
438
445
|
},
|
|
439
446
|
/**
|
|
440
447
|
* Updates the specified data-report by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
@@ -452,22 +459,22 @@ export const DataReportApiFactory = function (configuration?: Configuration, bas
|
|
|
452
459
|
};
|
|
453
460
|
|
|
454
461
|
/**
|
|
455
|
-
* Request parameters for
|
|
462
|
+
* Request parameters for createDataReport operation in DataReportApi.
|
|
456
463
|
* @export
|
|
457
|
-
* @interface
|
|
464
|
+
* @interface DataReportApiCreateDataReportRequest
|
|
458
465
|
*/
|
|
459
|
-
export interface
|
|
466
|
+
export interface DataReportApiCreateDataReportRequest {
|
|
460
467
|
/**
|
|
461
468
|
*
|
|
462
469
|
* @type {CreateDataReportRequestDto}
|
|
463
|
-
* @memberof
|
|
470
|
+
* @memberof DataReportApiCreateDataReport
|
|
464
471
|
*/
|
|
465
472
|
readonly createDataReportRequestDto: CreateDataReportRequestDto
|
|
466
473
|
|
|
467
474
|
/**
|
|
468
475
|
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
469
476
|
* @type {string}
|
|
470
|
-
* @memberof
|
|
477
|
+
* @memberof DataReportApiCreateDataReport
|
|
471
478
|
*/
|
|
472
479
|
readonly authorization?: string
|
|
473
480
|
}
|
|
@@ -535,7 +542,7 @@ export interface DataReportApiListDataReportsRequest {
|
|
|
535
542
|
readonly authorization?: string
|
|
536
543
|
|
|
537
544
|
/**
|
|
538
|
-
* A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
545
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
539
546
|
* @type {any}
|
|
540
547
|
* @memberof DataReportApiListDataReports
|
|
541
548
|
*/
|
|
@@ -556,7 +563,7 @@ export interface DataReportApiListDataReportsRequest {
|
|
|
556
563
|
readonly filter?: any
|
|
557
564
|
|
|
558
565
|
/**
|
|
559
|
-
*
|
|
566
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
560
567
|
* @type {any}
|
|
561
568
|
* @memberof DataReportApiListDataReports
|
|
562
569
|
*/
|
|
@@ -575,6 +582,13 @@ export interface DataReportApiListDataReportsRequest {
|
|
|
575
582
|
* @memberof DataReportApiListDataReports
|
|
576
583
|
*/
|
|
577
584
|
readonly expand?: any
|
|
585
|
+
|
|
586
|
+
/**
|
|
587
|
+
* 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.
|
|
588
|
+
* @type {any}
|
|
589
|
+
* @memberof DataReportApiListDataReports
|
|
590
|
+
*/
|
|
591
|
+
readonly filters?: any
|
|
578
592
|
}
|
|
579
593
|
|
|
580
594
|
/**
|
|
@@ -615,13 +629,13 @@ export class DataReportApi extends BaseAPI {
|
|
|
615
629
|
/**
|
|
616
630
|
* This will create a data report for tenant in the database
|
|
617
631
|
* @summary Create the data-report
|
|
618
|
-
* @param {
|
|
632
|
+
* @param {DataReportApiCreateDataReportRequest} requestParameters Request parameters.
|
|
619
633
|
* @param {*} [options] Override http request option.
|
|
620
634
|
* @throws {RequiredError}
|
|
621
635
|
* @memberof DataReportApi
|
|
622
636
|
*/
|
|
623
|
-
public
|
|
624
|
-
return DataReportApiFp(this.configuration).
|
|
637
|
+
public createDataReport(requestParameters: DataReportApiCreateDataReportRequest, options?: AxiosRequestConfig) {
|
|
638
|
+
return DataReportApiFp(this.configuration).createDataReport(requestParameters.createDataReportRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
625
639
|
}
|
|
626
640
|
|
|
627
641
|
/**
|
|
@@ -636,7 +650,7 @@ export class DataReportApi extends BaseAPI {
|
|
|
636
650
|
}
|
|
637
651
|
|
|
638
652
|
/**
|
|
639
|
-
* Retrieves the details of the data-report that was previously created. Supply the unique data-report code
|
|
653
|
+
* 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
654
|
* @summary Retrieve the data-report
|
|
641
655
|
* @param {DataReportApiGetDataReportRequest} requestParameters Request parameters.
|
|
642
656
|
* @param {*} [options] Override http request option.
|
|
@@ -648,7 +662,7 @@ export class DataReportApi extends BaseAPI {
|
|
|
648
662
|
}
|
|
649
663
|
|
|
650
664
|
/**
|
|
651
|
-
* Returns a list of data-reports you have previously created.
|
|
665
|
+
* 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
666
|
* @summary List data-reports
|
|
653
667
|
* @param {DataReportApiListDataReportsRequest} requestParameters Request parameters.
|
|
654
668
|
* @param {*} [options] Override http request option.
|
|
@@ -656,7 +670,7 @@ export class DataReportApi extends BaseAPI {
|
|
|
656
670
|
* @memberof DataReportApi
|
|
657
671
|
*/
|
|
658
672
|
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));
|
|
673
|
+
return DataReportApiFp(this.configuration).listDataReports(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
|
|
660
674
|
}
|
|
661
675
|
|
|
662
676
|
/**
|