@emilgroup/tenant-sdk-node 1.15.0 → 1.15.1-beta.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +0 -1
- package/README.md +2 -2
- package/api/custom-schema-api.ts +36 -22
- package/api/data-report-api.ts +50 -36
- package/api/invite-users-api.ts +32 -18
- package/api/list-organization-invitations-api.ts +32 -18
- package/api/organizations-api.ts +28 -14
- package/api/roles-api.ts +22 -22
- package/api/settings-api.ts +4 -4
- package/api/users-api.ts +32 -18
- package/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/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/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
|
@@ -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.
|
|
@@ -292,19 +292,20 @@ var InviteUsersApiAxiosParamCreator = function (configuration) {
|
|
|
292
292
|
});
|
|
293
293
|
},
|
|
294
294
|
/**
|
|
295
|
-
* Returns a list of invited users you have previously created.
|
|
295
|
+
* 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.
|
|
296
296
|
* @summary List invited users
|
|
297
297
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
298
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
298
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
299
299
|
* @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.
|
|
300
300
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
301
|
-
* @param {any} [search]
|
|
301
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
302
302
|
* @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.
|
|
303
303
|
* @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.
|
|
304
|
+
* @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.
|
|
304
305
|
* @param {*} [options] Override http request option.
|
|
305
306
|
* @throws {RequiredError}
|
|
306
307
|
*/
|
|
307
|
-
listInvites: function (authorization, pageSize, pageToken, filter, search, order, expand, options) {
|
|
308
|
+
listInvites: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
308
309
|
if (options === void 0) { options = {}; }
|
|
309
310
|
return __awaiter(_this, void 0, void 0, function () {
|
|
310
311
|
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
@@ -345,6 +346,9 @@ var InviteUsersApiAxiosParamCreator = function (configuration) {
|
|
|
345
346
|
if (expand !== undefined) {
|
|
346
347
|
localVarQueryParameter['expand'] = expand;
|
|
347
348
|
}
|
|
349
|
+
if (filters !== undefined) {
|
|
350
|
+
localVarQueryParameter['filters'] = filters;
|
|
351
|
+
}
|
|
348
352
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
349
353
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
350
354
|
}
|
|
@@ -454,24 +458,25 @@ var InviteUsersApiFp = function (configuration) {
|
|
|
454
458
|
});
|
|
455
459
|
},
|
|
456
460
|
/**
|
|
457
|
-
* Returns a list of invited users you have previously created.
|
|
461
|
+
* 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.
|
|
458
462
|
* @summary List invited users
|
|
459
463
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
460
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
464
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
461
465
|
* @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.
|
|
462
466
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
463
|
-
* @param {any} [search]
|
|
467
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
464
468
|
* @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.
|
|
465
469
|
* @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.
|
|
470
|
+
* @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.
|
|
466
471
|
* @param {*} [options] Override http request option.
|
|
467
472
|
* @throws {RequiredError}
|
|
468
473
|
*/
|
|
469
|
-
listInvites: function (authorization, pageSize, pageToken, filter, search, order, expand, options) {
|
|
474
|
+
listInvites: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
470
475
|
return __awaiter(this, void 0, void 0, function () {
|
|
471
476
|
var localVarAxiosArgs;
|
|
472
477
|
return __generator(this, function (_a) {
|
|
473
478
|
switch (_a.label) {
|
|
474
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.listInvites(authorization, pageSize, pageToken, filter, search, order, expand, options)];
|
|
479
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.listInvites(authorization, pageSize, pageToken, filter, search, order, expand, filters, options)];
|
|
475
480
|
case 1:
|
|
476
481
|
localVarAxiosArgs = _a.sent();
|
|
477
482
|
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
@@ -534,20 +539,21 @@ var InviteUsersApiFactory = function (configuration, basePath, axios) {
|
|
|
534
539
|
return localVarFp.inviteUsers(inviteUsersRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
535
540
|
},
|
|
536
541
|
/**
|
|
537
|
-
* Returns a list of invited users you have previously created.
|
|
542
|
+
* 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.
|
|
538
543
|
* @summary List invited users
|
|
539
544
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
540
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
545
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
541
546
|
* @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.
|
|
542
547
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
543
|
-
* @param {any} [search]
|
|
548
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
544
549
|
* @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.
|
|
545
550
|
* @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.
|
|
551
|
+
* @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.
|
|
546
552
|
* @param {*} [options] Override http request option.
|
|
547
553
|
* @throws {RequiredError}
|
|
548
554
|
*/
|
|
549
|
-
listInvites: function (authorization, pageSize, pageToken, filter, search, order, expand, options) {
|
|
550
|
-
return localVarFp.listInvites(authorization, pageSize, pageToken, filter, search, order, expand, options).then(function (request) { return request(axios, basePath); });
|
|
555
|
+
listInvites: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
556
|
+
return localVarFp.listInvites(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
|
|
551
557
|
},
|
|
552
558
|
};
|
|
553
559
|
};
|
|
@@ -612,7 +618,7 @@ var InviteUsersApi = /** @class */ (function (_super) {
|
|
|
612
618
|
return (0, exports.InviteUsersApiFp)(this.configuration).inviteUsers(requestParameters.inviteUsersRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
613
619
|
};
|
|
614
620
|
/**
|
|
615
|
-
* Returns a list of invited users you have previously created.
|
|
621
|
+
* 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.
|
|
616
622
|
* @summary List invited users
|
|
617
623
|
* @param {InviteUsersApiListInvitesRequest} requestParameters Request parameters.
|
|
618
624
|
* @param {*} [options] Override http request option.
|
|
@@ -622,7 +628,7 @@ var InviteUsersApi = /** @class */ (function (_super) {
|
|
|
622
628
|
InviteUsersApi.prototype.listInvites = function (requestParameters, options) {
|
|
623
629
|
var _this = this;
|
|
624
630
|
if (requestParameters === void 0) { requestParameters = {}; }
|
|
625
|
-
return (0, exports.InviteUsersApiFp)(this.configuration).listInvites(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
631
|
+
return (0, exports.InviteUsersApiFp)(this.configuration).listInvites(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); });
|
|
626
632
|
};
|
|
627
633
|
return InviteUsersApi;
|
|
628
634
|
}(base_1.BaseAPI));
|
|
@@ -19,19 +19,20 @@ import { ListOrgInvitationsResponseClass } from '../models';
|
|
|
19
19
|
*/
|
|
20
20
|
export declare const ListOrganizationInvitationsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
21
21
|
/**
|
|
22
|
-
* Returns a list of organization invitations you have previously created.
|
|
22
|
+
* Returns a list of organization invitations you have previously created. The organization invitations are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
23
23
|
* @summary List organization invitations
|
|
24
24
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
25
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
25
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
26
26
|
* @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.
|
|
27
27
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
28
|
-
* @param {any} [search]
|
|
28
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
29
29
|
* @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.
|
|
30
30
|
* @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.
|
|
31
|
+
* @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.
|
|
31
32
|
* @param {*} [options] Override http request option.
|
|
32
33
|
* @throws {RequiredError}
|
|
33
34
|
*/
|
|
34
|
-
listOrgInvitations: (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
35
|
+
listOrgInvitations: (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
35
36
|
};
|
|
36
37
|
/**
|
|
37
38
|
* ListOrganizationInvitationsApi - functional programming interface
|
|
@@ -39,19 +40,20 @@ export declare const ListOrganizationInvitationsApiAxiosParamCreator: (configura
|
|
|
39
40
|
*/
|
|
40
41
|
export declare const ListOrganizationInvitationsApiFp: (configuration?: Configuration) => {
|
|
41
42
|
/**
|
|
42
|
-
* Returns a list of organization invitations you have previously created.
|
|
43
|
+
* Returns a list of organization invitations you have previously created. The organization invitations are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
43
44
|
* @summary List organization invitations
|
|
44
45
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
45
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
46
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
46
47
|
* @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.
|
|
47
48
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
48
|
-
* @param {any} [search]
|
|
49
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
49
50
|
* @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.
|
|
50
51
|
* @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.
|
|
52
|
+
* @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.
|
|
51
53
|
* @param {*} [options] Override http request option.
|
|
52
54
|
* @throws {RequiredError}
|
|
53
55
|
*/
|
|
54
|
-
listOrgInvitations(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListOrgInvitationsResponseClass>>;
|
|
56
|
+
listOrgInvitations(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListOrgInvitationsResponseClass>>;
|
|
55
57
|
};
|
|
56
58
|
/**
|
|
57
59
|
* ListOrganizationInvitationsApi - factory interface
|
|
@@ -59,19 +61,20 @@ export declare const ListOrganizationInvitationsApiFp: (configuration?: Configur
|
|
|
59
61
|
*/
|
|
60
62
|
export declare const ListOrganizationInvitationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
61
63
|
/**
|
|
62
|
-
* Returns a list of organization invitations you have previously created.
|
|
64
|
+
* Returns a list of organization invitations you have previously created. The organization invitations are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
63
65
|
* @summary List organization invitations
|
|
64
66
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
65
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
67
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
66
68
|
* @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.
|
|
67
69
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
68
|
-
* @param {any} [search]
|
|
70
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
69
71
|
* @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.
|
|
70
72
|
* @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.
|
|
73
|
+
* @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.
|
|
71
74
|
* @param {*} [options] Override http request option.
|
|
72
75
|
* @throws {RequiredError}
|
|
73
76
|
*/
|
|
74
|
-
listOrgInvitations(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: any): AxiosPromise<ListOrgInvitationsResponseClass>;
|
|
77
|
+
listOrgInvitations(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: any): AxiosPromise<ListOrgInvitationsResponseClass>;
|
|
75
78
|
};
|
|
76
79
|
/**
|
|
77
80
|
* Request parameters for listOrgInvitations operation in ListOrganizationInvitationsApi.
|
|
@@ -86,7 +89,7 @@ export interface ListOrganizationInvitationsApiListOrgInvitationsRequest {
|
|
|
86
89
|
*/
|
|
87
90
|
readonly authorization?: string;
|
|
88
91
|
/**
|
|
89
|
-
* A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
92
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
90
93
|
* @type {any}
|
|
91
94
|
* @memberof ListOrganizationInvitationsApiListOrgInvitations
|
|
92
95
|
*/
|
|
@@ -104,7 +107,7 @@ export interface ListOrganizationInvitationsApiListOrgInvitationsRequest {
|
|
|
104
107
|
*/
|
|
105
108
|
readonly filter?: any;
|
|
106
109
|
/**
|
|
107
|
-
*
|
|
110
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
108
111
|
* @type {any}
|
|
109
112
|
* @memberof ListOrganizationInvitationsApiListOrgInvitations
|
|
110
113
|
*/
|
|
@@ -121,6 +124,12 @@ export interface ListOrganizationInvitationsApiListOrgInvitationsRequest {
|
|
|
121
124
|
* @memberof ListOrganizationInvitationsApiListOrgInvitations
|
|
122
125
|
*/
|
|
123
126
|
readonly expand?: any;
|
|
127
|
+
/**
|
|
128
|
+
* 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.
|
|
129
|
+
* @type {any}
|
|
130
|
+
* @memberof ListOrganizationInvitationsApiListOrgInvitations
|
|
131
|
+
*/
|
|
132
|
+
readonly filters?: any;
|
|
124
133
|
}
|
|
125
134
|
/**
|
|
126
135
|
* ListOrganizationInvitationsApi - object-oriented interface
|
|
@@ -130,7 +139,7 @@ export interface ListOrganizationInvitationsApiListOrgInvitationsRequest {
|
|
|
130
139
|
*/
|
|
131
140
|
export declare class ListOrganizationInvitationsApi extends BaseAPI {
|
|
132
141
|
/**
|
|
133
|
-
* Returns a list of organization invitations you have previously created.
|
|
142
|
+
* Returns a list of organization invitations you have previously created. The organization invitations are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
134
143
|
* @summary List organization invitations
|
|
135
144
|
* @param {ListOrganizationInvitationsApiListOrgInvitationsRequest} requestParameters Request parameters.
|
|
136
145
|
* @param {*} [options] Override http request option.
|