@emilgroup/tenant-sdk 1.15.0 → 1.16.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +0 -1
- package/README.md +2 -2
- package/api/custom-schema-api.ts +36 -22
- package/api/data-report-api.ts +50 -36
- package/api/invite-users-api.ts +32 -18
- package/api/list-organization-invitations-api.ts +32 -18
- package/api/organizations-api.ts +28 -14
- package/api/roles-api.ts +22 -22
- package/api/settings-api.ts +4 -4
- package/api/users-api.ts +32 -18
- package/base.ts +6 -1
- package/configuration.ts +1 -1
- package/dist/api/custom-schema-api.d.ts +28 -19
- package/dist/api/custom-schema-api.js +26 -20
- package/dist/api/data-report-api.d.ts +38 -29
- package/dist/api/data-report-api.js +35 -29
- package/dist/api/invite-users-api.d.ts +24 -15
- package/dist/api/invite-users-api.js +22 -16
- package/dist/api/list-organization-invitations-api.d.ts +24 -15
- package/dist/api/list-organization-invitations-api.js +22 -16
- package/dist/api/organizations-api.d.ts +20 -11
- package/dist/api/organizations-api.js +18 -12
- package/dist/api/roles-api.d.ts +22 -22
- package/dist/api/roles-api.js +13 -13
- package/dist/api/settings-api.d.ts +4 -4
- package/dist/api/settings-api.js +4 -4
- package/dist/api/users-api.d.ts +24 -15
- package/dist/api/users-api.js +22 -16
- package/dist/base.d.ts +1 -0
- package/dist/base.js +5 -1
- package/dist/configuration.js +0 -7
- package/dist/models/batch-delete-request-dto.d.ts +2 -2
- package/dist/models/create-data-report-request-dto.d.ts +1 -1
- package/dist/models/create-role-request-dto.d.ts +2 -2
- package/dist/models/custom-field-dto.d.ts +37 -4
- package/dist/models/custom-field-dto.js +5 -2
- package/dist/models/data-report-class.d.ts +1 -1
- package/dist/models/disable-users-request-dto.d.ts +2 -2
- package/dist/models/enable-users-request-dto.d.ts +2 -2
- package/dist/models/index.d.ts +0 -1
- package/dist/models/index.js +0 -1
- package/dist/models/inline-response200.d.ts +6 -6
- package/dist/models/inline-response503.d.ts +6 -6
- package/dist/models/invite-class.d.ts +7 -0
- package/dist/models/invite-org-request-dto.d.ts +1 -1
- package/dist/models/invite-users-request-dto.d.ts +6 -0
- package/dist/models/organization-class.d.ts +6 -0
- package/dist/models/run-data-report-response-class.d.ts +2 -2
- package/dist/models/update-data-report-request-dto.d.ts +1 -1
- package/dist/models/update-role-request-dto.d.ts +2 -2
- package/dist/models/user-class.d.ts +7 -6
- package/models/batch-delete-request-dto.ts +2 -2
- package/models/create-data-report-request-dto.ts +1 -1
- package/models/create-role-request-dto.ts +2 -2
- package/models/custom-field-dto.ts +38 -5
- package/models/data-report-class.ts +1 -1
- package/models/disable-users-request-dto.ts +2 -2
- package/models/enable-users-request-dto.ts +2 -2
- package/models/index.ts +0 -1
- package/models/inline-response200.ts +6 -6
- package/models/inline-response503.ts +6 -6
- package/models/invite-class.ts +7 -0
- package/models/invite-org-request-dto.ts +1 -1
- package/models/invite-users-request-dto.ts +6 -0
- package/models/organization-class.ts +6 -0
- package/models/run-data-report-response-class.ts +2 -2
- package/models/update-data-report-request-dto.ts +1 -1
- package/models/update-role-request-dto.ts +2 -2
- package/models/user-class.ts +7 -6
- package/package.json +1 -1
- package/dist/models/set-user-setting-response-class.d.ts +0 -36
- package/dist/models/set-user-setting-response-class.js +0 -15
- package/models/set-user-setting-response-class.ts +0 -42
|
@@ -100,7 +100,7 @@ var DataReportApiAxiosParamCreator = function (configuration) {
|
|
|
100
100
|
* @param {*} [options] Override http request option.
|
|
101
101
|
* @throws {RequiredError}
|
|
102
102
|
*/
|
|
103
|
-
|
|
103
|
+
createDataReport: function (createDataReportRequestDto, authorization, options) {
|
|
104
104
|
if (options === void 0) { options = {}; }
|
|
105
105
|
return __awaiter(_this, void 0, void 0, function () {
|
|
106
106
|
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
@@ -108,7 +108,7 @@ var DataReportApiAxiosParamCreator = function (configuration) {
|
|
|
108
108
|
switch (_a.label) {
|
|
109
109
|
case 0:
|
|
110
110
|
// verify required parameter 'createDataReportRequestDto' is not null or undefined
|
|
111
|
-
(0, common_1.assertParamExists)('
|
|
111
|
+
(0, common_1.assertParamExists)('createDataReport', 'createDataReportRequestDto', createDataReportRequestDto);
|
|
112
112
|
localVarPath = "/tenantservice/v1/data-reports";
|
|
113
113
|
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
114
114
|
if (configuration) {
|
|
@@ -189,7 +189,7 @@ var DataReportApiAxiosParamCreator = function (configuration) {
|
|
|
189
189
|
});
|
|
190
190
|
},
|
|
191
191
|
/**
|
|
192
|
-
* Retrieves the details of the data-report that was previously created. Supply the unique data-report code
|
|
192
|
+
* 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.
|
|
193
193
|
* @summary Retrieve the data-report
|
|
194
194
|
* @param {string} code Unique identifier for the object.
|
|
195
195
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -241,19 +241,20 @@ var DataReportApiAxiosParamCreator = function (configuration) {
|
|
|
241
241
|
});
|
|
242
242
|
},
|
|
243
243
|
/**
|
|
244
|
-
* Returns a list of data-reports you have previously created.
|
|
244
|
+
* 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.
|
|
245
245
|
* @summary List data-reports
|
|
246
246
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
247
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
247
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
248
248
|
* @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.
|
|
249
249
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
250
|
-
* @param {any} [search]
|
|
250
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
251
251
|
* @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.
|
|
252
252
|
* @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.
|
|
253
|
+
* @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.
|
|
253
254
|
* @param {*} [options] Override http request option.
|
|
254
255
|
* @throws {RequiredError}
|
|
255
256
|
*/
|
|
256
|
-
listDataReports: function (authorization, pageSize, pageToken, filter, search, order, expand, options) {
|
|
257
|
+
listDataReports: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
257
258
|
if (options === void 0) { options = {}; }
|
|
258
259
|
return __awaiter(_this, void 0, void 0, function () {
|
|
259
260
|
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
@@ -294,6 +295,9 @@ var DataReportApiAxiosParamCreator = function (configuration) {
|
|
|
294
295
|
if (expand !== undefined) {
|
|
295
296
|
localVarQueryParameter['expand'] = expand;
|
|
296
297
|
}
|
|
298
|
+
if (filters !== undefined) {
|
|
299
|
+
localVarQueryParameter['filters'] = filters;
|
|
300
|
+
}
|
|
297
301
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
298
302
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
299
303
|
}
|
|
@@ -379,12 +383,12 @@ var DataReportApiFp = function (configuration) {
|
|
|
379
383
|
* @param {*} [options] Override http request option.
|
|
380
384
|
* @throws {RequiredError}
|
|
381
385
|
*/
|
|
382
|
-
|
|
386
|
+
createDataReport: function (createDataReportRequestDto, authorization, options) {
|
|
383
387
|
return __awaiter(this, void 0, void 0, function () {
|
|
384
388
|
var localVarAxiosArgs;
|
|
385
389
|
return __generator(this, function (_a) {
|
|
386
390
|
switch (_a.label) {
|
|
387
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.
|
|
391
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.createDataReport(createDataReportRequestDto, authorization, options)];
|
|
388
392
|
case 1:
|
|
389
393
|
localVarAxiosArgs = _a.sent();
|
|
390
394
|
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
@@ -413,7 +417,7 @@ var DataReportApiFp = function (configuration) {
|
|
|
413
417
|
});
|
|
414
418
|
},
|
|
415
419
|
/**
|
|
416
|
-
* Retrieves the details of the data-report that was previously created. Supply the unique data-report code
|
|
420
|
+
* 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.
|
|
417
421
|
* @summary Retrieve the data-report
|
|
418
422
|
* @param {string} code Unique identifier for the object.
|
|
419
423
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -435,24 +439,25 @@ var DataReportApiFp = function (configuration) {
|
|
|
435
439
|
});
|
|
436
440
|
},
|
|
437
441
|
/**
|
|
438
|
-
* Returns a list of data-reports you have previously created.
|
|
442
|
+
* 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.
|
|
439
443
|
* @summary List data-reports
|
|
440
444
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
441
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
445
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
442
446
|
* @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.
|
|
443
447
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
444
|
-
* @param {any} [search]
|
|
448
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
445
449
|
* @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.
|
|
446
450
|
* @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.
|
|
451
|
+
* @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.
|
|
447
452
|
* @param {*} [options] Override http request option.
|
|
448
453
|
* @throws {RequiredError}
|
|
449
454
|
*/
|
|
450
|
-
listDataReports: function (authorization, pageSize, pageToken, filter, search, order, expand, options) {
|
|
455
|
+
listDataReports: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
451
456
|
return __awaiter(this, void 0, void 0, function () {
|
|
452
457
|
var localVarAxiosArgs;
|
|
453
458
|
return __generator(this, function (_a) {
|
|
454
459
|
switch (_a.label) {
|
|
455
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.listDataReports(authorization, pageSize, pageToken, filter, search, order, expand, options)];
|
|
460
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.listDataReports(authorization, pageSize, pageToken, filter, search, order, expand, filters, options)];
|
|
456
461
|
case 1:
|
|
457
462
|
localVarAxiosArgs = _a.sent();
|
|
458
463
|
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
@@ -500,8 +505,8 @@ var DataReportApiFactory = function (configuration, basePath, axios) {
|
|
|
500
505
|
* @param {*} [options] Override http request option.
|
|
501
506
|
* @throws {RequiredError}
|
|
502
507
|
*/
|
|
503
|
-
|
|
504
|
-
return localVarFp.
|
|
508
|
+
createDataReport: function (createDataReportRequestDto, authorization, options) {
|
|
509
|
+
return localVarFp.createDataReport(createDataReportRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
505
510
|
},
|
|
506
511
|
/**
|
|
507
512
|
*
|
|
@@ -514,7 +519,7 @@ var DataReportApiFactory = function (configuration, basePath, axios) {
|
|
|
514
519
|
return localVarFp.deleteAlert(id, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
515
520
|
},
|
|
516
521
|
/**
|
|
517
|
-
* Retrieves the details of the data-report that was previously created. Supply the unique data-report code
|
|
522
|
+
* 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.
|
|
518
523
|
* @summary Retrieve the data-report
|
|
519
524
|
* @param {string} code Unique identifier for the object.
|
|
520
525
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -526,20 +531,21 @@ var DataReportApiFactory = function (configuration, basePath, axios) {
|
|
|
526
531
|
return localVarFp.getDataReport(code, authorization, expand, options).then(function (request) { return request(axios, basePath); });
|
|
527
532
|
},
|
|
528
533
|
/**
|
|
529
|
-
* Returns a list of data-reports you have previously created.
|
|
534
|
+
* 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.
|
|
530
535
|
* @summary List data-reports
|
|
531
536
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
532
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
537
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
533
538
|
* @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.
|
|
534
539
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
535
|
-
* @param {any} [search]
|
|
540
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
536
541
|
* @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.
|
|
537
542
|
* @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.
|
|
543
|
+
* @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.
|
|
538
544
|
* @param {*} [options] Override http request option.
|
|
539
545
|
* @throws {RequiredError}
|
|
540
546
|
*/
|
|
541
|
-
listDataReports: function (authorization, pageSize, pageToken, filter, search, order, expand, options) {
|
|
542
|
-
return localVarFp.listDataReports(authorization, pageSize, pageToken, filter, search, order, expand, options).then(function (request) { return request(axios, basePath); });
|
|
547
|
+
listDataReports: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
548
|
+
return localVarFp.listDataReports(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
|
|
543
549
|
},
|
|
544
550
|
/**
|
|
545
551
|
* Updates the specified data-report by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
@@ -570,14 +576,14 @@ var DataReportApi = /** @class */ (function (_super) {
|
|
|
570
576
|
/**
|
|
571
577
|
* This will create a data report for tenant in the database
|
|
572
578
|
* @summary Create the data-report
|
|
573
|
-
* @param {
|
|
579
|
+
* @param {DataReportApiCreateDataReportRequest} requestParameters Request parameters.
|
|
574
580
|
* @param {*} [options] Override http request option.
|
|
575
581
|
* @throws {RequiredError}
|
|
576
582
|
* @memberof DataReportApi
|
|
577
583
|
*/
|
|
578
|
-
DataReportApi.prototype.
|
|
584
|
+
DataReportApi.prototype.createDataReport = function (requestParameters, options) {
|
|
579
585
|
var _this = this;
|
|
580
|
-
return (0, exports.DataReportApiFp)(this.configuration).
|
|
586
|
+
return (0, exports.DataReportApiFp)(this.configuration).createDataReport(requestParameters.createDataReportRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
581
587
|
};
|
|
582
588
|
/**
|
|
583
589
|
*
|
|
@@ -591,7 +597,7 @@ var DataReportApi = /** @class */ (function (_super) {
|
|
|
591
597
|
return (0, exports.DataReportApiFp)(this.configuration).deleteAlert(requestParameters.id, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
592
598
|
};
|
|
593
599
|
/**
|
|
594
|
-
* Retrieves the details of the data-report that was previously created. Supply the unique data-report code
|
|
600
|
+
* 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.
|
|
595
601
|
* @summary Retrieve the data-report
|
|
596
602
|
* @param {DataReportApiGetDataReportRequest} requestParameters Request parameters.
|
|
597
603
|
* @param {*} [options] Override http request option.
|
|
@@ -603,7 +609,7 @@ var DataReportApi = /** @class */ (function (_super) {
|
|
|
603
609
|
return (0, exports.DataReportApiFp)(this.configuration).getDataReport(requestParameters.code, requestParameters.authorization, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
604
610
|
};
|
|
605
611
|
/**
|
|
606
|
-
* Returns a list of data-reports you have previously created.
|
|
612
|
+
* 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.
|
|
607
613
|
* @summary List data-reports
|
|
608
614
|
* @param {DataReportApiListDataReportsRequest} requestParameters Request parameters.
|
|
609
615
|
* @param {*} [options] Override http request option.
|
|
@@ -613,7 +619,7 @@ var DataReportApi = /** @class */ (function (_super) {
|
|
|
613
619
|
DataReportApi.prototype.listDataReports = function (requestParameters, options) {
|
|
614
620
|
var _this = this;
|
|
615
621
|
if (requestParameters === void 0) { requestParameters = {}; }
|
|
616
|
-
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); });
|
|
622
|
+
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); });
|
|
617
623
|
};
|
|
618
624
|
/**
|
|
619
625
|
* 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.
|
|
@@ -288,19 +288,20 @@ var InviteUsersApiAxiosParamCreator = function (configuration) {
|
|
|
288
288
|
});
|
|
289
289
|
},
|
|
290
290
|
/**
|
|
291
|
-
* Returns a list of invited users you have previously created.
|
|
291
|
+
* 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.
|
|
292
292
|
* @summary List invited users
|
|
293
293
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
294
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
294
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
295
295
|
* @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.
|
|
296
296
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
297
|
-
* @param {any} [search]
|
|
297
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
298
298
|
* @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.
|
|
299
299
|
* @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.
|
|
300
|
+
* @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.
|
|
300
301
|
* @param {*} [options] Override http request option.
|
|
301
302
|
* @throws {RequiredError}
|
|
302
303
|
*/
|
|
303
|
-
listInvites: function (authorization, pageSize, pageToken, filter, search, order, expand, options) {
|
|
304
|
+
listInvites: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
304
305
|
if (options === void 0) { options = {}; }
|
|
305
306
|
return __awaiter(_this, void 0, void 0, function () {
|
|
306
307
|
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
@@ -341,6 +342,9 @@ var InviteUsersApiAxiosParamCreator = function (configuration) {
|
|
|
341
342
|
if (expand !== undefined) {
|
|
342
343
|
localVarQueryParameter['expand'] = expand;
|
|
343
344
|
}
|
|
345
|
+
if (filters !== undefined) {
|
|
346
|
+
localVarQueryParameter['filters'] = filters;
|
|
347
|
+
}
|
|
344
348
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
345
349
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
346
350
|
}
|
|
@@ -450,24 +454,25 @@ var InviteUsersApiFp = function (configuration) {
|
|
|
450
454
|
});
|
|
451
455
|
},
|
|
452
456
|
/**
|
|
453
|
-
* Returns a list of invited users you have previously created.
|
|
457
|
+
* 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.
|
|
454
458
|
* @summary List invited users
|
|
455
459
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
456
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
460
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
457
461
|
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
458
462
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
459
|
-
* @param {any} [search]
|
|
463
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
460
464
|
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
461
465
|
* @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
466
|
+
* @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
462
467
|
* @param {*} [options] Override http request option.
|
|
463
468
|
* @throws {RequiredError}
|
|
464
469
|
*/
|
|
465
|
-
listInvites: function (authorization, pageSize, pageToken, filter, search, order, expand, options) {
|
|
470
|
+
listInvites: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
466
471
|
return __awaiter(this, void 0, void 0, function () {
|
|
467
472
|
var localVarAxiosArgs;
|
|
468
473
|
return __generator(this, function (_a) {
|
|
469
474
|
switch (_a.label) {
|
|
470
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.listInvites(authorization, pageSize, pageToken, filter, search, order, expand, options)];
|
|
475
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.listInvites(authorization, pageSize, pageToken, filter, search, order, expand, filters, options)];
|
|
471
476
|
case 1:
|
|
472
477
|
localVarAxiosArgs = _a.sent();
|
|
473
478
|
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
@@ -530,20 +535,21 @@ var InviteUsersApiFactory = function (configuration, basePath, axios) {
|
|
|
530
535
|
return localVarFp.inviteUsers(inviteUsersRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
531
536
|
},
|
|
532
537
|
/**
|
|
533
|
-
* Returns a list of invited users you have previously created.
|
|
538
|
+
* 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.
|
|
534
539
|
* @summary List invited users
|
|
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
|
-
listInvites: function (authorization, pageSize, pageToken, filter, search, order, expand, options) {
|
|
546
|
-
return localVarFp.listInvites(authorization, pageSize, pageToken, filter, search, order, expand, options).then(function (request) { return request(axios, basePath); });
|
|
551
|
+
listInvites: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
552
|
+
return localVarFp.listInvites(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
|
|
547
553
|
},
|
|
548
554
|
};
|
|
549
555
|
};
|
|
@@ -608,7 +614,7 @@ var InviteUsersApi = /** @class */ (function (_super) {
|
|
|
608
614
|
return (0, exports.InviteUsersApiFp)(this.configuration).inviteUsers(requestParameters.inviteUsersRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
609
615
|
};
|
|
610
616
|
/**
|
|
611
|
-
* Returns a list of invited users you have previously created.
|
|
617
|
+
* 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.
|
|
612
618
|
* @summary List invited users
|
|
613
619
|
* @param {InviteUsersApiListInvitesRequest} requestParameters Request parameters.
|
|
614
620
|
* @param {*} [options] Override http request option.
|
|
@@ -618,7 +624,7 @@ var InviteUsersApi = /** @class */ (function (_super) {
|
|
|
618
624
|
InviteUsersApi.prototype.listInvites = function (requestParameters, options) {
|
|
619
625
|
var _this = this;
|
|
620
626
|
if (requestParameters === void 0) { requestParameters = {}; }
|
|
621
|
-
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); });
|
|
627
|
+
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); });
|
|
622
628
|
};
|
|
623
629
|
return InviteUsersApi;
|
|
624
630
|
}(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.
|