@emilgroup/tenant-sdk-node 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 +18 -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/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/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
|
@@ -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.
|
|
@@ -104,7 +104,7 @@ var DataReportApiAxiosParamCreator = function (configuration) {
|
|
|
104
104
|
* @param {*} [options] Override http request option.
|
|
105
105
|
* @throws {RequiredError}
|
|
106
106
|
*/
|
|
107
|
-
|
|
107
|
+
createDataReport: function (createDataReportRequestDto, authorization, options) {
|
|
108
108
|
if (options === void 0) { options = {}; }
|
|
109
109
|
return __awaiter(_this, void 0, void 0, function () {
|
|
110
110
|
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
@@ -112,7 +112,7 @@ var DataReportApiAxiosParamCreator = function (configuration) {
|
|
|
112
112
|
switch (_a.label) {
|
|
113
113
|
case 0:
|
|
114
114
|
// verify required parameter 'createDataReportRequestDto' is not null or undefined
|
|
115
|
-
(0, common_1.assertParamExists)('
|
|
115
|
+
(0, common_1.assertParamExists)('createDataReport', 'createDataReportRequestDto', createDataReportRequestDto);
|
|
116
116
|
localVarPath = "/tenantservice/v1/data-reports";
|
|
117
117
|
localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
118
118
|
if (configuration) {
|
|
@@ -193,7 +193,7 @@ var DataReportApiAxiosParamCreator = function (configuration) {
|
|
|
193
193
|
});
|
|
194
194
|
},
|
|
195
195
|
/**
|
|
196
|
-
* Retrieves the details of the data-report that was previously created. Supply the unique data-report code
|
|
196
|
+
* 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.
|
|
197
197
|
* @summary Retrieve the data-report
|
|
198
198
|
* @param {string} code Unique identifier for the object.
|
|
199
199
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -245,19 +245,20 @@ var DataReportApiAxiosParamCreator = function (configuration) {
|
|
|
245
245
|
});
|
|
246
246
|
},
|
|
247
247
|
/**
|
|
248
|
-
* Returns a list of data-reports you have previously created.
|
|
248
|
+
* 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.
|
|
249
249
|
* @summary List data-reports
|
|
250
250
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
251
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
251
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
252
252
|
* @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.
|
|
253
253
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
254
|
-
* @param {any} [search]
|
|
254
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
255
255
|
* @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.
|
|
256
256
|
* @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.
|
|
257
|
+
* @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.
|
|
257
258
|
* @param {*} [options] Override http request option.
|
|
258
259
|
* @throws {RequiredError}
|
|
259
260
|
*/
|
|
260
|
-
listDataReports: function (authorization, pageSize, pageToken, filter, search, order, expand, options) {
|
|
261
|
+
listDataReports: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
261
262
|
if (options === void 0) { options = {}; }
|
|
262
263
|
return __awaiter(_this, void 0, void 0, function () {
|
|
263
264
|
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
@@ -298,6 +299,9 @@ var DataReportApiAxiosParamCreator = function (configuration) {
|
|
|
298
299
|
if (expand !== undefined) {
|
|
299
300
|
localVarQueryParameter['expand'] = expand;
|
|
300
301
|
}
|
|
302
|
+
if (filters !== undefined) {
|
|
303
|
+
localVarQueryParameter['filters'] = filters;
|
|
304
|
+
}
|
|
301
305
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
302
306
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
303
307
|
}
|
|
@@ -383,12 +387,12 @@ var DataReportApiFp = function (configuration) {
|
|
|
383
387
|
* @param {*} [options] Override http request option.
|
|
384
388
|
* @throws {RequiredError}
|
|
385
389
|
*/
|
|
386
|
-
|
|
390
|
+
createDataReport: function (createDataReportRequestDto, authorization, options) {
|
|
387
391
|
return __awaiter(this, void 0, void 0, function () {
|
|
388
392
|
var localVarAxiosArgs;
|
|
389
393
|
return __generator(this, function (_a) {
|
|
390
394
|
switch (_a.label) {
|
|
391
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.
|
|
395
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.createDataReport(createDataReportRequestDto, authorization, options)];
|
|
392
396
|
case 1:
|
|
393
397
|
localVarAxiosArgs = _a.sent();
|
|
394
398
|
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
@@ -417,7 +421,7 @@ var DataReportApiFp = function (configuration) {
|
|
|
417
421
|
});
|
|
418
422
|
},
|
|
419
423
|
/**
|
|
420
|
-
* Retrieves the details of the data-report that was previously created. Supply the unique data-report code
|
|
424
|
+
* 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.
|
|
421
425
|
* @summary Retrieve the data-report
|
|
422
426
|
* @param {string} code Unique identifier for the object.
|
|
423
427
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -439,24 +443,25 @@ var DataReportApiFp = function (configuration) {
|
|
|
439
443
|
});
|
|
440
444
|
},
|
|
441
445
|
/**
|
|
442
|
-
* Returns a list of data-reports you have previously created.
|
|
446
|
+
* 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.
|
|
443
447
|
* @summary List data-reports
|
|
444
448
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
445
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
449
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
446
450
|
* @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.
|
|
447
451
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
448
|
-
* @param {any} [search]
|
|
452
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
449
453
|
* @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.
|
|
450
454
|
* @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.
|
|
455
|
+
* @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.
|
|
451
456
|
* @param {*} [options] Override http request option.
|
|
452
457
|
* @throws {RequiredError}
|
|
453
458
|
*/
|
|
454
|
-
listDataReports: function (authorization, pageSize, pageToken, filter, search, order, expand, options) {
|
|
459
|
+
listDataReports: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
455
460
|
return __awaiter(this, void 0, void 0, function () {
|
|
456
461
|
var localVarAxiosArgs;
|
|
457
462
|
return __generator(this, function (_a) {
|
|
458
463
|
switch (_a.label) {
|
|
459
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.listDataReports(authorization, pageSize, pageToken, filter, search, order, expand, options)];
|
|
464
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.listDataReports(authorization, pageSize, pageToken, filter, search, order, expand, filters, options)];
|
|
460
465
|
case 1:
|
|
461
466
|
localVarAxiosArgs = _a.sent();
|
|
462
467
|
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
@@ -504,8 +509,8 @@ var DataReportApiFactory = function (configuration, basePath, axios) {
|
|
|
504
509
|
* @param {*} [options] Override http request option.
|
|
505
510
|
* @throws {RequiredError}
|
|
506
511
|
*/
|
|
507
|
-
|
|
508
|
-
return localVarFp.
|
|
512
|
+
createDataReport: function (createDataReportRequestDto, authorization, options) {
|
|
513
|
+
return localVarFp.createDataReport(createDataReportRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
509
514
|
},
|
|
510
515
|
/**
|
|
511
516
|
*
|
|
@@ -518,7 +523,7 @@ var DataReportApiFactory = function (configuration, basePath, axios) {
|
|
|
518
523
|
return localVarFp.deleteAlert(id, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
519
524
|
},
|
|
520
525
|
/**
|
|
521
|
-
* Retrieves the details of the data-report that was previously created. Supply the unique data-report code
|
|
526
|
+
* 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.
|
|
522
527
|
* @summary Retrieve the data-report
|
|
523
528
|
* @param {string} code Unique identifier for the object.
|
|
524
529
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -530,20 +535,21 @@ var DataReportApiFactory = function (configuration, basePath, axios) {
|
|
|
530
535
|
return localVarFp.getDataReport(code, authorization, expand, options).then(function (request) { return request(axios, basePath); });
|
|
531
536
|
},
|
|
532
537
|
/**
|
|
533
|
-
* Returns a list of data-reports you have previously created.
|
|
538
|
+
* 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.
|
|
534
539
|
* @summary List data-reports
|
|
535
540
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
536
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
541
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
537
542
|
* @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.
|
|
538
543
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
539
|
-
* @param {any} [search]
|
|
544
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
540
545
|
* @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.
|
|
541
546
|
* @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.
|
|
547
|
+
* @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.
|
|
542
548
|
* @param {*} [options] Override http request option.
|
|
543
549
|
* @throws {RequiredError}
|
|
544
550
|
*/
|
|
545
|
-
listDataReports: function (authorization, pageSize, pageToken, filter, search, order, expand, options) {
|
|
546
|
-
return localVarFp.listDataReports(authorization, pageSize, pageToken, filter, search, order, expand, options).then(function (request) { return request(axios, basePath); });
|
|
551
|
+
listDataReports: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
552
|
+
return localVarFp.listDataReports(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
|
|
547
553
|
},
|
|
548
554
|
/**
|
|
549
555
|
* Updates the specified data-report by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
@@ -574,14 +580,14 @@ var DataReportApi = /** @class */ (function (_super) {
|
|
|
574
580
|
/**
|
|
575
581
|
* This will create a data report for tenant in the database
|
|
576
582
|
* @summary Create the data-report
|
|
577
|
-
* @param {
|
|
583
|
+
* @param {DataReportApiCreateDataReportRequest} requestParameters Request parameters.
|
|
578
584
|
* @param {*} [options] Override http request option.
|
|
579
585
|
* @throws {RequiredError}
|
|
580
586
|
* @memberof DataReportApi
|
|
581
587
|
*/
|
|
582
|
-
DataReportApi.prototype.
|
|
588
|
+
DataReportApi.prototype.createDataReport = function (requestParameters, options) {
|
|
583
589
|
var _this = this;
|
|
584
|
-
return (0, exports.DataReportApiFp)(this.configuration).
|
|
590
|
+
return (0, exports.DataReportApiFp)(this.configuration).createDataReport(requestParameters.createDataReportRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
585
591
|
};
|
|
586
592
|
/**
|
|
587
593
|
*
|
|
@@ -595,7 +601,7 @@ var DataReportApi = /** @class */ (function (_super) {
|
|
|
595
601
|
return (0, exports.DataReportApiFp)(this.configuration).deleteAlert(requestParameters.id, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
596
602
|
};
|
|
597
603
|
/**
|
|
598
|
-
* Retrieves the details of the data-report that was previously created. Supply the unique data-report code
|
|
604
|
+
* 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.
|
|
599
605
|
* @summary Retrieve the data-report
|
|
600
606
|
* @param {DataReportApiGetDataReportRequest} requestParameters Request parameters.
|
|
601
607
|
* @param {*} [options] Override http request option.
|
|
@@ -607,7 +613,7 @@ var DataReportApi = /** @class */ (function (_super) {
|
|
|
607
613
|
return (0, exports.DataReportApiFp)(this.configuration).getDataReport(requestParameters.code, requestParameters.authorization, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
608
614
|
};
|
|
609
615
|
/**
|
|
610
|
-
* Returns a list of data-reports you have previously created.
|
|
616
|
+
* 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.
|
|
611
617
|
* @summary List data-reports
|
|
612
618
|
* @param {DataReportApiListDataReportsRequest} requestParameters Request parameters.
|
|
613
619
|
* @param {*} [options] Override http request option.
|
|
@@ -617,7 +623,7 @@ var DataReportApi = /** @class */ (function (_super) {
|
|
|
617
623
|
DataReportApi.prototype.listDataReports = function (requestParameters, options) {
|
|
618
624
|
var _this = this;
|
|
619
625
|
if (requestParameters === void 0) { requestParameters = {}; }
|
|
620
|
-
return (0, exports.DataReportApiFp)(this.configuration).listDataReports(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
626
|
+
return (0, exports.DataReportApiFp)(this.configuration).listDataReports(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); });
|
|
621
627
|
};
|
|
622
628
|
/**
|
|
623
629
|
* Updates the specified data-report by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
@@ -62,19 +62,20 @@ export declare const InviteUsersApiAxiosParamCreator: (configuration?: Configura
|
|
|
62
62
|
*/
|
|
63
63
|
inviteUsers: (inviteUsersRequestDto: InviteUsersRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
64
64
|
/**
|
|
65
|
-
* Returns a list of invited users you have previously created.
|
|
65
|
+
* Returns a list of invited users you have previously created. The invited users are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
66
66
|
* @summary List invited users
|
|
67
67
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
68
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
68
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
69
69
|
* @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.
|
|
70
70
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
71
|
-
* @param {any} [search]
|
|
71
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
72
72
|
* @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.
|
|
73
73
|
* @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.
|
|
74
|
+
* @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.
|
|
74
75
|
* @param {*} [options] Override http request option.
|
|
75
76
|
* @throws {RequiredError}
|
|
76
77
|
*/
|
|
77
|
-
listInvites: (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
78
|
+
listInvites: (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
78
79
|
};
|
|
79
80
|
/**
|
|
80
81
|
* InviteUsersApi - functional programming interface
|
|
@@ -118,19 +119,20 @@ export declare const InviteUsersApiFp: (configuration?: Configuration) => {
|
|
|
118
119
|
*/
|
|
119
120
|
inviteUsers(inviteUsersRequestDto: InviteUsersRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InviteUsersResponseClass>>;
|
|
120
121
|
/**
|
|
121
|
-
* Returns a list of invited users you have previously created.
|
|
122
|
+
* Returns a list of invited users you have previously created. The invited users are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
122
123
|
* @summary List invited users
|
|
123
124
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
124
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
125
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
125
126
|
* @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.
|
|
126
127
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
127
|
-
* @param {any} [search]
|
|
128
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
128
129
|
* @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.
|
|
129
130
|
* @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.
|
|
131
|
+
* @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.
|
|
130
132
|
* @param {*} [options] Override http request option.
|
|
131
133
|
* @throws {RequiredError}
|
|
132
134
|
*/
|
|
133
|
-
listInvites(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListInvitesResponseClass>>;
|
|
135
|
+
listInvites(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListInvitesResponseClass>>;
|
|
134
136
|
};
|
|
135
137
|
/**
|
|
136
138
|
* InviteUsersApi - factory interface
|
|
@@ -174,19 +176,20 @@ export declare const InviteUsersApiFactory: (configuration?: Configuration, base
|
|
|
174
176
|
*/
|
|
175
177
|
inviteUsers(inviteUsersRequestDto: InviteUsersRequestDto, authorization?: string, options?: any): AxiosPromise<InviteUsersResponseClass>;
|
|
176
178
|
/**
|
|
177
|
-
* Returns a list of invited users you have previously created.
|
|
179
|
+
* Returns a list of invited users you have previously created. The invited users are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
178
180
|
* @summary List invited users
|
|
179
181
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
180
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
182
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
181
183
|
* @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.
|
|
182
184
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
183
|
-
* @param {any} [search]
|
|
185
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
184
186
|
* @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.
|
|
185
187
|
* @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.
|
|
188
|
+
* @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.
|
|
186
189
|
* @param {*} [options] Override http request option.
|
|
187
190
|
* @throws {RequiredError}
|
|
188
191
|
*/
|
|
189
|
-
listInvites(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: any): AxiosPromise<ListInvitesResponseClass>;
|
|
192
|
+
listInvites(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: any): AxiosPromise<ListInvitesResponseClass>;
|
|
190
193
|
};
|
|
191
194
|
/**
|
|
192
195
|
* Request parameters for deleteInvite operation in InviteUsersApi.
|
|
@@ -277,7 +280,7 @@ export interface InviteUsersApiListInvitesRequest {
|
|
|
277
280
|
*/
|
|
278
281
|
readonly authorization?: string;
|
|
279
282
|
/**
|
|
280
|
-
* A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
283
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
281
284
|
* @type {any}
|
|
282
285
|
* @memberof InviteUsersApiListInvites
|
|
283
286
|
*/
|
|
@@ -295,7 +298,7 @@ export interface InviteUsersApiListInvitesRequest {
|
|
|
295
298
|
*/
|
|
296
299
|
readonly filter?: any;
|
|
297
300
|
/**
|
|
298
|
-
*
|
|
301
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
299
302
|
* @type {any}
|
|
300
303
|
* @memberof InviteUsersApiListInvites
|
|
301
304
|
*/
|
|
@@ -312,6 +315,12 @@ export interface InviteUsersApiListInvitesRequest {
|
|
|
312
315
|
* @memberof InviteUsersApiListInvites
|
|
313
316
|
*/
|
|
314
317
|
readonly expand?: any;
|
|
318
|
+
/**
|
|
319
|
+
* 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.
|
|
320
|
+
* @type {any}
|
|
321
|
+
* @memberof InviteUsersApiListInvites
|
|
322
|
+
*/
|
|
323
|
+
readonly filters?: any;
|
|
315
324
|
}
|
|
316
325
|
/**
|
|
317
326
|
* InviteUsersApi - object-oriented interface
|
|
@@ -357,7 +366,7 @@ export declare class InviteUsersApi extends BaseAPI {
|
|
|
357
366
|
*/
|
|
358
367
|
inviteUsers(requestParameters: InviteUsersApiInviteUsersRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<InviteUsersResponseClass, any>>;
|
|
359
368
|
/**
|
|
360
|
-
* Returns a list of invited users you have previously created.
|
|
369
|
+
* Returns a list of invited users you have previously created. The invited users are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
361
370
|
* @summary List invited users
|
|
362
371
|
* @param {InviteUsersApiListInvitesRequest} requestParameters Request parameters.
|
|
363
372
|
* @param {*} [options] Override http request option.
|