@emilgroup/tenant-sdk 1.9.0 → 1.15.1-beta.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +1 -2
- package/README.md +2 -2
- package/api/custom-schema-api.ts +36 -22
- package/api/data-report-api.ts +50 -36
- package/api/delete-organization-invitations-api.ts +161 -0
- package/api/invite-users-api.ts +32 -18
- package/api/list-organization-invitations-api.ts +32 -18
- package/api/organizations-api.ts +28 -14
- package/api/roles-api.ts +22 -22
- package/api/settings-api.ts +4 -4
- package/api/users-api.ts +32 -18
- package/api.ts +2 -0
- package/base.ts +1 -0
- package/dist/api/custom-schema-api.d.ts +28 -19
- package/dist/api/custom-schema-api.js +26 -20
- package/dist/api/data-report-api.d.ts +38 -29
- package/dist/api/data-report-api.js +35 -29
- package/dist/api/delete-organization-invitations-api.d.ts +96 -0
- package/dist/api/delete-organization-invitations-api.js +223 -0
- package/dist/api/invite-users-api.d.ts +24 -15
- package/dist/api/invite-users-api.js +22 -16
- package/dist/api/list-organization-invitations-api.d.ts +24 -15
- package/dist/api/list-organization-invitations-api.js +22 -16
- package/dist/api/organizations-api.d.ts +20 -11
- package/dist/api/organizations-api.js +18 -12
- package/dist/api/roles-api.d.ts +22 -22
- package/dist/api/roles-api.js +13 -13
- package/dist/api/settings-api.d.ts +4 -4
- package/dist/api/settings-api.js +4 -4
- package/dist/api/users-api.d.ts +24 -15
- package/dist/api/users-api.js +22 -16
- package/dist/api.d.ts +1 -0
- package/dist/api.js +1 -0
- package/dist/base.js +1 -0
- package/dist/models/batch-delete-request-dto.d.ts +2 -2
- package/dist/models/create-data-report-request-dto.d.ts +1 -1
- package/dist/models/create-role-request-dto.d.ts +2 -2
- package/dist/models/custom-field-dto.d.ts +43 -11
- package/dist/models/custom-field-dto.js +5 -2
- package/dist/models/data-report-class.d.ts +1 -1
- package/dist/models/disable-users-request-dto.d.ts +2 -2
- package/dist/models/enable-users-request-dto.d.ts +2 -2
- package/dist/models/index.d.ts +0 -2
- package/dist/models/index.js +0 -2
- package/dist/models/inline-response200.d.ts +6 -6
- package/dist/models/inline-response503.d.ts +6 -6
- package/dist/models/invite-class.d.ts +7 -0
- package/dist/models/invite-org-request-dto.d.ts +1 -1
- package/dist/models/invite-users-request-dto.d.ts +6 -0
- package/dist/models/run-data-report-response-class.d.ts +2 -2
- package/dist/models/update-data-report-request-dto.d.ts +1 -1
- package/dist/models/update-role-request-dto.d.ts +2 -2
- package/dist/models/user-class.d.ts +7 -6
- package/models/batch-delete-request-dto.ts +2 -2
- package/models/create-data-report-request-dto.ts +1 -1
- package/models/create-role-request-dto.ts +2 -2
- package/models/custom-field-dto.ts +44 -12
- package/models/data-report-class.ts +1 -1
- package/models/disable-users-request-dto.ts +2 -2
- package/models/enable-users-request-dto.ts +2 -2
- package/models/index.ts +0 -2
- package/models/inline-response200.ts +6 -6
- package/models/inline-response503.ts +6 -6
- package/models/invite-class.ts +7 -0
- package/models/invite-org-request-dto.ts +1 -1
- package/models/invite-users-request-dto.ts +6 -0
- package/models/run-data-report-response-class.ts +2 -2
- package/models/update-data-report-request-dto.ts +1 -1
- package/models/update-role-request-dto.ts +2 -2
- package/models/user-class.ts +7 -6
- package/package.json +1 -2
- package/dist/models/custom-field-option-dto.d.ts +0 -30
- package/dist/models/custom-field-option-dto.js +0 -15
- package/dist/models/set-user-setting-response-class.d.ts +0 -36
- package/dist/models/set-user-setting-response-class.js +0 -15
- package/models/custom-field-option-dto.ts +0 -36
- package/models/set-user-setting-response-class.ts +0 -42
|
@@ -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.
|
|
@@ -93,19 +93,20 @@ var ListOrganizationInvitationsApiAxiosParamCreator = function (configuration) {
|
|
|
93
93
|
var _this = this;
|
|
94
94
|
return {
|
|
95
95
|
/**
|
|
96
|
-
* Returns a list of organization invitations you have previously created.
|
|
96
|
+
* 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.
|
|
97
97
|
* @summary List organization invitations
|
|
98
98
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
99
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
99
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
100
100
|
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
101
101
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
102
|
-
* @param {any} [search]
|
|
102
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
103
103
|
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
104
104
|
* @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
105
|
+
* @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
105
106
|
* @param {*} [options] Override http request option.
|
|
106
107
|
* @throws {RequiredError}
|
|
107
108
|
*/
|
|
108
|
-
listOrgInvitations: function (authorization, pageSize, pageToken, filter, search, order, expand, options) {
|
|
109
|
+
listOrgInvitations: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
109
110
|
if (options === void 0) { options = {}; }
|
|
110
111
|
return __awaiter(_this, void 0, void 0, function () {
|
|
111
112
|
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
@@ -146,6 +147,9 @@ var ListOrganizationInvitationsApiAxiosParamCreator = function (configuration) {
|
|
|
146
147
|
if (expand !== undefined) {
|
|
147
148
|
localVarQueryParameter['expand'] = expand;
|
|
148
149
|
}
|
|
150
|
+
if (filters !== undefined) {
|
|
151
|
+
localVarQueryParameter['filters'] = filters;
|
|
152
|
+
}
|
|
149
153
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
150
154
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
151
155
|
}
|
|
@@ -171,24 +175,25 @@ var ListOrganizationInvitationsApiFp = function (configuration) {
|
|
|
171
175
|
var localVarAxiosParamCreator = (0, exports.ListOrganizationInvitationsApiAxiosParamCreator)(configuration);
|
|
172
176
|
return {
|
|
173
177
|
/**
|
|
174
|
-
* Returns a list of organization invitations you have previously created.
|
|
178
|
+
* 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.
|
|
175
179
|
* @summary List organization invitations
|
|
176
180
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
177
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
181
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
178
182
|
* @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.
|
|
179
183
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
180
|
-
* @param {any} [search]
|
|
184
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
181
185
|
* @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.
|
|
182
186
|
* @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.
|
|
187
|
+
* @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.
|
|
183
188
|
* @param {*} [options] Override http request option.
|
|
184
189
|
* @throws {RequiredError}
|
|
185
190
|
*/
|
|
186
|
-
listOrgInvitations: function (authorization, pageSize, pageToken, filter, search, order, expand, options) {
|
|
191
|
+
listOrgInvitations: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
187
192
|
return __awaiter(this, void 0, void 0, function () {
|
|
188
193
|
var localVarAxiosArgs;
|
|
189
194
|
return __generator(this, function (_a) {
|
|
190
195
|
switch (_a.label) {
|
|
191
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.listOrgInvitations(authorization, pageSize, pageToken, filter, search, order, expand, options)];
|
|
196
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.listOrgInvitations(authorization, pageSize, pageToken, filter, search, order, expand, filters, options)];
|
|
192
197
|
case 1:
|
|
193
198
|
localVarAxiosArgs = _a.sent();
|
|
194
199
|
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
@@ -207,20 +212,21 @@ var ListOrganizationInvitationsApiFactory = function (configuration, basePath, a
|
|
|
207
212
|
var localVarFp = (0, exports.ListOrganizationInvitationsApiFp)(configuration);
|
|
208
213
|
return {
|
|
209
214
|
/**
|
|
210
|
-
* Returns a list of organization invitations you have previously created.
|
|
215
|
+
* 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.
|
|
211
216
|
* @summary List organization invitations
|
|
212
217
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
213
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
218
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
214
219
|
* @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.
|
|
215
220
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
216
|
-
* @param {any} [search]
|
|
221
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
217
222
|
* @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.
|
|
218
223
|
* @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.
|
|
224
|
+
* @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.
|
|
219
225
|
* @param {*} [options] Override http request option.
|
|
220
226
|
* @throws {RequiredError}
|
|
221
227
|
*/
|
|
222
|
-
listOrgInvitations: function (authorization, pageSize, pageToken, filter, search, order, expand, options) {
|
|
223
|
-
return localVarFp.listOrgInvitations(authorization, pageSize, pageToken, filter, search, order, expand, options).then(function (request) { return request(axios, basePath); });
|
|
228
|
+
listOrgInvitations: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
229
|
+
return localVarFp.listOrgInvitations(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
|
|
224
230
|
},
|
|
225
231
|
};
|
|
226
232
|
};
|
|
@@ -237,7 +243,7 @@ var ListOrganizationInvitationsApi = /** @class */ (function (_super) {
|
|
|
237
243
|
return _super !== null && _super.apply(this, arguments) || this;
|
|
238
244
|
}
|
|
239
245
|
/**
|
|
240
|
-
* Returns a list of organization invitations you have previously created.
|
|
246
|
+
* 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.
|
|
241
247
|
* @summary List organization invitations
|
|
242
248
|
* @param {ListOrganizationInvitationsApiListOrgInvitationsRequest} requestParameters Request parameters.
|
|
243
249
|
* @param {*} [options] Override http request option.
|
|
@@ -247,7 +253,7 @@ var ListOrganizationInvitationsApi = /** @class */ (function (_super) {
|
|
|
247
253
|
ListOrganizationInvitationsApi.prototype.listOrgInvitations = function (requestParameters, options) {
|
|
248
254
|
var _this = this;
|
|
249
255
|
if (requestParameters === void 0) { requestParameters = {}; }
|
|
250
|
-
return (0, exports.ListOrganizationInvitationsApiFp)(this.configuration).listOrgInvitations(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
256
|
+
return (0, exports.ListOrganizationInvitationsApiFp)(this.configuration).listOrgInvitations(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); });
|
|
251
257
|
};
|
|
252
258
|
return ListOrganizationInvitationsApi;
|
|
253
259
|
}(base_1.BaseAPI));
|
|
@@ -34,16 +34,17 @@ export declare const OrganizationsApiAxiosParamCreator: (configuration?: Configu
|
|
|
34
34
|
* This will fetch list of organizations
|
|
35
35
|
* @summary List organizations
|
|
36
36
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
37
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
37
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
38
38
|
* @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.
|
|
39
39
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
40
|
-
* @param {any} [search]
|
|
40
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
41
41
|
* @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.
|
|
42
42
|
* @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.
|
|
43
|
+
* @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.
|
|
43
44
|
* @param {*} [options] Override http request option.
|
|
44
45
|
* @throws {RequiredError}
|
|
45
46
|
*/
|
|
46
|
-
listOrganizations: (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
47
|
+
listOrganizations: (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
47
48
|
/**
|
|
48
49
|
* Update organization data
|
|
49
50
|
* @summary Update the Organization
|
|
@@ -73,16 +74,17 @@ export declare const OrganizationsApiFp: (configuration?: Configuration) => {
|
|
|
73
74
|
* This will fetch list of organizations
|
|
74
75
|
* @summary List organizations
|
|
75
76
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
76
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
77
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
77
78
|
* @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.
|
|
78
79
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
79
|
-
* @param {any} [search]
|
|
80
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
80
81
|
* @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.
|
|
81
82
|
* @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.
|
|
83
|
+
* @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.
|
|
82
84
|
* @param {*} [options] Override http request option.
|
|
83
85
|
* @throws {RequiredError}
|
|
84
86
|
*/
|
|
85
|
-
listOrganizations(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListOrganizationsResponseClass>>;
|
|
87
|
+
listOrganizations(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListOrganizationsResponseClass>>;
|
|
86
88
|
/**
|
|
87
89
|
* Update organization data
|
|
88
90
|
* @summary Update the Organization
|
|
@@ -112,16 +114,17 @@ export declare const OrganizationsApiFactory: (configuration?: Configuration, ba
|
|
|
112
114
|
* This will fetch list of organizations
|
|
113
115
|
* @summary List organizations
|
|
114
116
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
115
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
117
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
116
118
|
* @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.
|
|
117
119
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
118
|
-
* @param {any} [search]
|
|
120
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
119
121
|
* @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.
|
|
120
122
|
* @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.
|
|
123
|
+
* @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.
|
|
121
124
|
* @param {*} [options] Override http request option.
|
|
122
125
|
* @throws {RequiredError}
|
|
123
126
|
*/
|
|
124
|
-
listOrganizations(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: any): AxiosPromise<ListOrganizationsResponseClass>;
|
|
127
|
+
listOrganizations(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: any): AxiosPromise<ListOrganizationsResponseClass>;
|
|
125
128
|
/**
|
|
126
129
|
* Update organization data
|
|
127
130
|
* @summary Update the Organization
|
|
@@ -165,7 +168,7 @@ export interface OrganizationsApiListOrganizationsRequest {
|
|
|
165
168
|
*/
|
|
166
169
|
readonly authorization?: string;
|
|
167
170
|
/**
|
|
168
|
-
* A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
171
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
169
172
|
* @type {any}
|
|
170
173
|
* @memberof OrganizationsApiListOrganizations
|
|
171
174
|
*/
|
|
@@ -183,7 +186,7 @@ export interface OrganizationsApiListOrganizationsRequest {
|
|
|
183
186
|
*/
|
|
184
187
|
readonly filter?: any;
|
|
185
188
|
/**
|
|
186
|
-
*
|
|
189
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
187
190
|
* @type {any}
|
|
188
191
|
* @memberof OrganizationsApiListOrganizations
|
|
189
192
|
*/
|
|
@@ -200,6 +203,12 @@ export interface OrganizationsApiListOrganizationsRequest {
|
|
|
200
203
|
* @memberof OrganizationsApiListOrganizations
|
|
201
204
|
*/
|
|
202
205
|
readonly expand?: any;
|
|
206
|
+
/**
|
|
207
|
+
* 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.
|
|
208
|
+
* @type {any}
|
|
209
|
+
* @memberof OrganizationsApiListOrganizations
|
|
210
|
+
*/
|
|
211
|
+
readonly filters?: any;
|
|
203
212
|
}
|
|
204
213
|
/**
|
|
205
214
|
* Request parameters for updateOrganization operation in OrganizationsApi.
|
|
@@ -144,16 +144,17 @@ var OrganizationsApiAxiosParamCreator = function (configuration) {
|
|
|
144
144
|
* This will fetch list of organizations
|
|
145
145
|
* @summary List organizations
|
|
146
146
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
147
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
147
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
148
148
|
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
149
149
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
150
|
-
* @param {any} [search]
|
|
150
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
151
151
|
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
152
152
|
* @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.
|
|
153
|
+
* @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
153
154
|
* @param {*} [options] Override http request option.
|
|
154
155
|
* @throws {RequiredError}
|
|
155
156
|
*/
|
|
156
|
-
listOrganizations: function (authorization, pageSize, pageToken, filter, search, order, expand, options) {
|
|
157
|
+
listOrganizations: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
157
158
|
if (options === void 0) { options = {}; }
|
|
158
159
|
return __awaiter(_this, void 0, void 0, function () {
|
|
159
160
|
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
@@ -194,6 +195,9 @@ var OrganizationsApiAxiosParamCreator = function (configuration) {
|
|
|
194
195
|
if (expand !== undefined) {
|
|
195
196
|
localVarQueryParameter['expand'] = expand;
|
|
196
197
|
}
|
|
198
|
+
if (filters !== undefined) {
|
|
199
|
+
localVarQueryParameter['filters'] = filters;
|
|
200
|
+
}
|
|
197
201
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
198
202
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
199
203
|
}
|
|
@@ -296,21 +300,22 @@ var OrganizationsApiFp = function (configuration) {
|
|
|
296
300
|
* This will fetch list of organizations
|
|
297
301
|
* @summary List organizations
|
|
298
302
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
299
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
303
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
300
304
|
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
301
305
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
302
|
-
* @param {any} [search]
|
|
306
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
303
307
|
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
304
308
|
* @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.
|
|
309
|
+
* @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
305
310
|
* @param {*} [options] Override http request option.
|
|
306
311
|
* @throws {RequiredError}
|
|
307
312
|
*/
|
|
308
|
-
listOrganizations: function (authorization, pageSize, pageToken, filter, search, order, expand, options) {
|
|
313
|
+
listOrganizations: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
309
314
|
return __awaiter(this, void 0, void 0, function () {
|
|
310
315
|
var localVarAxiosArgs;
|
|
311
316
|
return __generator(this, function (_a) {
|
|
312
317
|
switch (_a.label) {
|
|
313
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.listOrganizations(authorization, pageSize, pageToken, filter, search, order, expand, options)];
|
|
318
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.listOrganizations(authorization, pageSize, pageToken, filter, search, order, expand, filters, options)];
|
|
314
319
|
case 1:
|
|
315
320
|
localVarAxiosArgs = _a.sent();
|
|
316
321
|
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
@@ -365,17 +370,18 @@ var OrganizationsApiFactory = function (configuration, basePath, axios) {
|
|
|
365
370
|
* This will fetch list of organizations
|
|
366
371
|
* @summary List organizations
|
|
367
372
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
368
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
373
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
369
374
|
* @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.
|
|
370
375
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
371
|
-
* @param {any} [search]
|
|
376
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
372
377
|
* @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.
|
|
373
378
|
* @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.
|
|
379
|
+
* @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.
|
|
374
380
|
* @param {*} [options] Override http request option.
|
|
375
381
|
* @throws {RequiredError}
|
|
376
382
|
*/
|
|
377
|
-
listOrganizations: function (authorization, pageSize, pageToken, filter, search, order, expand, options) {
|
|
378
|
-
return localVarFp.listOrganizations(authorization, pageSize, pageToken, filter, search, order, expand, options).then(function (request) { return request(axios, basePath); });
|
|
383
|
+
listOrganizations: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
384
|
+
return localVarFp.listOrganizations(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
|
|
379
385
|
},
|
|
380
386
|
/**
|
|
381
387
|
* Update organization data
|
|
@@ -426,7 +432,7 @@ var OrganizationsApi = /** @class */ (function (_super) {
|
|
|
426
432
|
OrganizationsApi.prototype.listOrganizations = function (requestParameters, options) {
|
|
427
433
|
var _this = this;
|
|
428
434
|
if (requestParameters === void 0) { requestParameters = {}; }
|
|
429
|
-
return (0, exports.OrganizationsApiFp)(this.configuration).listOrganizations(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
435
|
+
return (0, exports.OrganizationsApiFp)(this.configuration).listOrganizations(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); });
|
|
430
436
|
};
|
|
431
437
|
/**
|
|
432
438
|
* Update organization data
|
package/dist/api/roles-api.d.ts
CHANGED
|
@@ -19,19 +19,19 @@ import { ListRolesResponseClass } from '../models';
|
|
|
19
19
|
*/
|
|
20
20
|
export declare const RolesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
21
21
|
/**
|
|
22
|
-
* Returns a list of roles you have previously created.
|
|
22
|
+
* Returns a list of roles you have previously created. The roles are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
23
23
|
* @summary List roles
|
|
24
24
|
* @param {string} [authorization] Bearer Token
|
|
25
25
|
* @param {number} [pageSize] Page size
|
|
26
26
|
* @param {string} [pageToken] Page token
|
|
27
|
-
* @param {
|
|
27
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
28
28
|
* @param {string} [search] Search query
|
|
29
|
-
* @param {
|
|
30
|
-
* @param {
|
|
29
|
+
* @param {string} [order] Order allowing you to specify the desired order of entities retrieved from the server.
|
|
30
|
+
* @param {string} [expand] You can expand roles in this endpoint. By default, permissions will be an empty array.
|
|
31
31
|
* @param {*} [options] Override http request option.
|
|
32
32
|
* @throws {RequiredError}
|
|
33
33
|
*/
|
|
34
|
-
listRoles: (authorization?: string, pageSize?: number, pageToken?: string, filter?:
|
|
34
|
+
listRoles: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
35
35
|
};
|
|
36
36
|
/**
|
|
37
37
|
* RolesApi - functional programming interface
|
|
@@ -39,19 +39,19 @@ export declare const RolesApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
39
39
|
*/
|
|
40
40
|
export declare const RolesApiFp: (configuration?: Configuration) => {
|
|
41
41
|
/**
|
|
42
|
-
* Returns a list of roles you have previously created.
|
|
42
|
+
* Returns a list of roles you have previously created. The roles are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
43
43
|
* @summary List roles
|
|
44
44
|
* @param {string} [authorization] Bearer Token
|
|
45
45
|
* @param {number} [pageSize] Page size
|
|
46
46
|
* @param {string} [pageToken] Page token
|
|
47
|
-
* @param {
|
|
47
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
48
48
|
* @param {string} [search] Search query
|
|
49
|
-
* @param {
|
|
50
|
-
* @param {
|
|
49
|
+
* @param {string} [order] Order allowing you to specify the desired order of entities retrieved from the server.
|
|
50
|
+
* @param {string} [expand] You can expand roles in this endpoint. By default, permissions will be an empty array.
|
|
51
51
|
* @param {*} [options] Override http request option.
|
|
52
52
|
* @throws {RequiredError}
|
|
53
53
|
*/
|
|
54
|
-
listRoles(authorization?: string, pageSize?: number, pageToken?: string, filter?:
|
|
54
|
+
listRoles(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListRolesResponseClass>>;
|
|
55
55
|
};
|
|
56
56
|
/**
|
|
57
57
|
* RolesApi - factory interface
|
|
@@ -59,19 +59,19 @@ export declare const RolesApiFp: (configuration?: Configuration) => {
|
|
|
59
59
|
*/
|
|
60
60
|
export declare const RolesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
61
61
|
/**
|
|
62
|
-
* Returns a list of roles you have previously created.
|
|
62
|
+
* Returns a list of roles you have previously created. The roles are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
63
63
|
* @summary List roles
|
|
64
64
|
* @param {string} [authorization] Bearer Token
|
|
65
65
|
* @param {number} [pageSize] Page size
|
|
66
66
|
* @param {string} [pageToken] Page token
|
|
67
|
-
* @param {
|
|
67
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
68
68
|
* @param {string} [search] Search query
|
|
69
|
-
* @param {
|
|
70
|
-
* @param {
|
|
69
|
+
* @param {string} [order] Order allowing you to specify the desired order of entities retrieved from the server.
|
|
70
|
+
* @param {string} [expand] You can expand roles in this endpoint. By default, permissions will be an empty array.
|
|
71
71
|
* @param {*} [options] Override http request option.
|
|
72
72
|
* @throws {RequiredError}
|
|
73
73
|
*/
|
|
74
|
-
listRoles(authorization?: string, pageSize?: number, pageToken?: string, filter?:
|
|
74
|
+
listRoles(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListRolesResponseClass>;
|
|
75
75
|
};
|
|
76
76
|
/**
|
|
77
77
|
* Request parameters for listRoles operation in RolesApi.
|
|
@@ -99,10 +99,10 @@ export interface RolesApiListRolesRequest {
|
|
|
99
99
|
readonly pageToken?: string;
|
|
100
100
|
/**
|
|
101
101
|
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
102
|
-
* @type {
|
|
102
|
+
* @type {string}
|
|
103
103
|
* @memberof RolesApiListRoles
|
|
104
104
|
*/
|
|
105
|
-
readonly filter?:
|
|
105
|
+
readonly filter?: string;
|
|
106
106
|
/**
|
|
107
107
|
* Search query
|
|
108
108
|
* @type {string}
|
|
@@ -111,16 +111,16 @@ export interface RolesApiListRolesRequest {
|
|
|
111
111
|
readonly search?: string;
|
|
112
112
|
/**
|
|
113
113
|
* Order allowing you to specify the desired order of entities retrieved from the server.
|
|
114
|
-
* @type {
|
|
114
|
+
* @type {string}
|
|
115
115
|
* @memberof RolesApiListRoles
|
|
116
116
|
*/
|
|
117
|
-
readonly order?:
|
|
117
|
+
readonly order?: string;
|
|
118
118
|
/**
|
|
119
119
|
* You can expand roles in this endpoint. By default, permissions will be an empty array.
|
|
120
|
-
* @type {
|
|
120
|
+
* @type {string}
|
|
121
121
|
* @memberof RolesApiListRoles
|
|
122
122
|
*/
|
|
123
|
-
readonly expand?:
|
|
123
|
+
readonly expand?: string;
|
|
124
124
|
}
|
|
125
125
|
/**
|
|
126
126
|
* RolesApi - object-oriented interface
|
|
@@ -130,7 +130,7 @@ export interface RolesApiListRolesRequest {
|
|
|
130
130
|
*/
|
|
131
131
|
export declare class RolesApi extends BaseAPI {
|
|
132
132
|
/**
|
|
133
|
-
* Returns a list of roles you have previously created.
|
|
133
|
+
* Returns a list of roles you have previously created. The roles are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
134
134
|
* @summary List roles
|
|
135
135
|
* @param {RolesApiListRolesRequest} requestParameters Request parameters.
|
|
136
136
|
* @param {*} [options] Override http request option.
|