@emilgroup/tenant-sdk-node 1.33.1-beta.8 → 1.34.1-beta.14
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 +5 -0
- package/README.md +2 -2
- package/api/invitation-controller-rest-api.ts +561 -0
- package/api/invite-users-api.ts +12 -12
- package/api/settings-api.ts +304 -0
- package/api/user-controller-rest-api.ts +1413 -0
- package/api/users-api.ts +12 -12
- package/api.ts +4 -0
- package/base.ts +1 -0
- package/dist/api/invitation-controller-rest-api.d.ts +315 -0
- package/dist/api/invitation-controller-rest-api.js +538 -0
- package/dist/api/invite-users-api.d.ts +12 -12
- package/dist/api/invite-users-api.js +10 -10
- package/dist/api/settings-api.d.ts +156 -0
- package/dist/api/settings-api.js +268 -0
- package/dist/api/user-controller-rest-api.d.ts +777 -0
- package/dist/api/user-controller-rest-api.js +1227 -0
- package/dist/api/users-api.d.ts +12 -12
- package/dist/api/users-api.js +10 -10
- package/dist/api.d.ts +2 -0
- package/dist/api.js +2 -0
- package/dist/base.d.ts +2 -1
- package/dist/base.js +1 -0
- package/dist/models/get-settings-response-class.d.ts +5 -3
- package/dist/models/index.d.ts +3 -0
- package/dist/models/index.js +3 -0
- package/dist/models/set-setting-grpc-request-dto.d.ts +42 -0
- package/dist/models/set-setting-grpc-request-dto.js +15 -0
- package/dist/models/set-setting-request-dto.d.ts +6 -6
- package/dist/models/set-tenant-setting-response-class.d.ts +36 -0
- package/dist/models/set-tenant-setting-response-class.js +15 -0
- package/dist/models/set-user-setting-response-class.d.ts +36 -0
- package/dist/models/set-user-setting-response-class.js +15 -0
- package/dist/models/tenant-settings-class.d.ts +6 -0
- package/models/get-settings-response-class.ts +3 -3
- package/models/index.ts +3 -0
- package/models/set-setting-grpc-request-dto.ts +48 -0
- package/models/set-setting-request-dto.ts +6 -6
- package/models/set-tenant-setting-response-class.ts +42 -0
- package/models/set-user-setting-response-class.ts +42 -0
- package/models/tenant-settings-class.ts +6 -0
- package/package.json +2 -2
|
@@ -0,0 +1,538 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* EMIL Tenant Service
|
|
6
|
+
* The EMIL TenantService API description
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0
|
|
9
|
+
* Contact: kontakt@emil.de
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
var __extends = (this && this.__extends) || (function () {
|
|
16
|
+
var extendStatics = function (d, b) {
|
|
17
|
+
extendStatics = Object.setPrototypeOf ||
|
|
18
|
+
({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
|
|
19
|
+
function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
|
|
20
|
+
return extendStatics(d, b);
|
|
21
|
+
};
|
|
22
|
+
return function (d, b) {
|
|
23
|
+
if (typeof b !== "function" && b !== null)
|
|
24
|
+
throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
|
|
25
|
+
extendStatics(d, b);
|
|
26
|
+
function __() { this.constructor = d; }
|
|
27
|
+
d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
|
|
28
|
+
};
|
|
29
|
+
})();
|
|
30
|
+
var __assign = (this && this.__assign) || function () {
|
|
31
|
+
__assign = Object.assign || function(t) {
|
|
32
|
+
for (var s, i = 1, n = arguments.length; i < n; i++) {
|
|
33
|
+
s = arguments[i];
|
|
34
|
+
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
|
|
35
|
+
t[p] = s[p];
|
|
36
|
+
}
|
|
37
|
+
return t;
|
|
38
|
+
};
|
|
39
|
+
return __assign.apply(this, arguments);
|
|
40
|
+
};
|
|
41
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
42
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
43
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
44
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
45
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
46
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
47
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
48
|
+
});
|
|
49
|
+
};
|
|
50
|
+
var __generator = (this && this.__generator) || function (thisArg, body) {
|
|
51
|
+
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
|
|
52
|
+
return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
|
|
53
|
+
function verb(n) { return function (v) { return step([n, v]); }; }
|
|
54
|
+
function step(op) {
|
|
55
|
+
if (f) throw new TypeError("Generator is already executing.");
|
|
56
|
+
while (g && (g = 0, op[0] && (_ = 0)), _) try {
|
|
57
|
+
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
|
|
58
|
+
if (y = 0, t) op = [op[0] & 2, t.value];
|
|
59
|
+
switch (op[0]) {
|
|
60
|
+
case 0: case 1: t = op; break;
|
|
61
|
+
case 4: _.label++; return { value: op[1], done: false };
|
|
62
|
+
case 5: _.label++; y = op[1]; op = [0]; continue;
|
|
63
|
+
case 7: op = _.ops.pop(); _.trys.pop(); continue;
|
|
64
|
+
default:
|
|
65
|
+
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
|
|
66
|
+
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
|
|
67
|
+
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
|
|
68
|
+
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
|
|
69
|
+
if (t[2]) _.ops.pop();
|
|
70
|
+
_.trys.pop(); continue;
|
|
71
|
+
}
|
|
72
|
+
op = body.call(thisArg, _);
|
|
73
|
+
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
|
|
74
|
+
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
|
|
75
|
+
}
|
|
76
|
+
};
|
|
77
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
78
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
79
|
+
};
|
|
80
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
81
|
+
exports.InvitationControllerRestApi = exports.InvitationControllerRestApiFactory = exports.InvitationControllerRestApiFp = exports.InvitationControllerRestApiAxiosParamCreator = void 0;
|
|
82
|
+
var axios_1 = __importDefault(require("axios"));
|
|
83
|
+
// Some imports not used depending on template conditions
|
|
84
|
+
// @ts-ignore
|
|
85
|
+
var common_1 = require("../common");
|
|
86
|
+
// @ts-ignore
|
|
87
|
+
var base_1 = require("../base");
|
|
88
|
+
// URLSearchParams not necessarily used
|
|
89
|
+
// @ts-ignore
|
|
90
|
+
var url_1 = require("url");
|
|
91
|
+
var FormData = require('form-data');
|
|
92
|
+
/**
|
|
93
|
+
* InvitationControllerRestApi - axios parameter creator
|
|
94
|
+
* @export
|
|
95
|
+
*/
|
|
96
|
+
var InvitationControllerRestApiAxiosParamCreator = function (configuration) {
|
|
97
|
+
var _this = this;
|
|
98
|
+
return {
|
|
99
|
+
/**
|
|
100
|
+
* Permanently deletes the organization invitation. Supply the unique id that was returned when you created the organization invitation and this will delete it. **Required Permissions** \"tenant-management.organizations.delete\"
|
|
101
|
+
* @summary Delete the organization invitation
|
|
102
|
+
* @param {number} id
|
|
103
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
104
|
+
* @param {*} [options] Override http request option.
|
|
105
|
+
* @throws {RequiredError}
|
|
106
|
+
*/
|
|
107
|
+
deleteOrgInvitation: function (id, authorization, options) {
|
|
108
|
+
if (options === void 0) { options = {}; }
|
|
109
|
+
return __awaiter(_this, void 0, void 0, function () {
|
|
110
|
+
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
111
|
+
return __generator(this, function (_a) {
|
|
112
|
+
switch (_a.label) {
|
|
113
|
+
case 0:
|
|
114
|
+
// verify required parameter 'id' is not null or undefined
|
|
115
|
+
(0, common_1.assertParamExists)('deleteOrgInvitation', 'id', id);
|
|
116
|
+
localVarPath = "/tenantservice/v1/invitations/organizations/{id}"
|
|
117
|
+
.replace("{".concat("id", "}"), encodeURIComponent(String(id)));
|
|
118
|
+
localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
119
|
+
if (configuration) {
|
|
120
|
+
baseOptions = configuration.baseOptions;
|
|
121
|
+
baseAccessToken = configuration.accessToken;
|
|
122
|
+
}
|
|
123
|
+
localVarRequestOptions = __assign(__assign({ method: 'DELETE' }, baseOptions), options);
|
|
124
|
+
localVarHeaderParameter = {};
|
|
125
|
+
localVarQueryParameter = {};
|
|
126
|
+
// authentication bearer required
|
|
127
|
+
// http bearer authentication required
|
|
128
|
+
return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
|
|
129
|
+
case 1:
|
|
130
|
+
// authentication bearer required
|
|
131
|
+
// http bearer authentication required
|
|
132
|
+
_a.sent();
|
|
133
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
134
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
135
|
+
}
|
|
136
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
137
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
138
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
139
|
+
return [2 /*return*/, {
|
|
140
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
141
|
+
options: localVarRequestOptions,
|
|
142
|
+
}];
|
|
143
|
+
}
|
|
144
|
+
});
|
|
145
|
+
});
|
|
146
|
+
},
|
|
147
|
+
/**
|
|
148
|
+
* This sends an email to invite an organization. **Required Permissions** \"tenant-management.organizations.create\"
|
|
149
|
+
* @summary Invite an organization
|
|
150
|
+
* @param {InviteOrgRequestDtoRest} inviteOrgRequestDtoRest
|
|
151
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
152
|
+
* @param {*} [options] Override http request option.
|
|
153
|
+
* @throws {RequiredError}
|
|
154
|
+
*/
|
|
155
|
+
inviteOrg: function (inviteOrgRequestDtoRest, authorization, options) {
|
|
156
|
+
if (options === void 0) { options = {}; }
|
|
157
|
+
return __awaiter(_this, void 0, void 0, function () {
|
|
158
|
+
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
159
|
+
return __generator(this, function (_a) {
|
|
160
|
+
switch (_a.label) {
|
|
161
|
+
case 0:
|
|
162
|
+
// verify required parameter 'inviteOrgRequestDtoRest' is not null or undefined
|
|
163
|
+
(0, common_1.assertParamExists)('inviteOrg', 'inviteOrgRequestDtoRest', inviteOrgRequestDtoRest);
|
|
164
|
+
localVarPath = "/tenantservice/v1/invitations/organizations";
|
|
165
|
+
localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
166
|
+
if (configuration) {
|
|
167
|
+
baseOptions = configuration.baseOptions;
|
|
168
|
+
baseAccessToken = configuration.accessToken;
|
|
169
|
+
}
|
|
170
|
+
localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
|
|
171
|
+
localVarHeaderParameter = {};
|
|
172
|
+
localVarQueryParameter = {};
|
|
173
|
+
// authentication bearer required
|
|
174
|
+
// http bearer authentication required
|
|
175
|
+
return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
|
|
176
|
+
case 1:
|
|
177
|
+
// authentication bearer required
|
|
178
|
+
// http bearer authentication required
|
|
179
|
+
_a.sent();
|
|
180
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
181
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
182
|
+
}
|
|
183
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
184
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
185
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
186
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
187
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(inviteOrgRequestDtoRest, localVarRequestOptions, configuration);
|
|
188
|
+
return [2 /*return*/, {
|
|
189
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
190
|
+
options: localVarRequestOptions,
|
|
191
|
+
}];
|
|
192
|
+
}
|
|
193
|
+
});
|
|
194
|
+
});
|
|
195
|
+
},
|
|
196
|
+
/**
|
|
197
|
+
* 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. **Required Permissions** \"tenant-management.organizations.view\"
|
|
198
|
+
* @summary List organization invitations
|
|
199
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
200
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
201
|
+
* @param {string} [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.
|
|
202
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
203
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
204
|
+
* @param {string} [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.
|
|
205
|
+
* @param {string} [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.
|
|
206
|
+
* @param {string} [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.
|
|
207
|
+
* @param {*} [options] Override http request option.
|
|
208
|
+
* @throws {RequiredError}
|
|
209
|
+
*/
|
|
210
|
+
listOrgInvitations: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
211
|
+
if (options === void 0) { options = {}; }
|
|
212
|
+
return __awaiter(_this, void 0, void 0, function () {
|
|
213
|
+
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
214
|
+
return __generator(this, function (_a) {
|
|
215
|
+
switch (_a.label) {
|
|
216
|
+
case 0:
|
|
217
|
+
localVarPath = "/tenantservice/v1/invitations/organizations";
|
|
218
|
+
localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
219
|
+
if (configuration) {
|
|
220
|
+
baseOptions = configuration.baseOptions;
|
|
221
|
+
baseAccessToken = configuration.accessToken;
|
|
222
|
+
}
|
|
223
|
+
localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
|
|
224
|
+
localVarHeaderParameter = {};
|
|
225
|
+
localVarQueryParameter = {};
|
|
226
|
+
// authentication bearer required
|
|
227
|
+
// http bearer authentication required
|
|
228
|
+
return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
|
|
229
|
+
case 1:
|
|
230
|
+
// authentication bearer required
|
|
231
|
+
// http bearer authentication required
|
|
232
|
+
_a.sent();
|
|
233
|
+
if (pageSize !== undefined) {
|
|
234
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
235
|
+
}
|
|
236
|
+
if (pageToken !== undefined) {
|
|
237
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
238
|
+
}
|
|
239
|
+
if (filter !== undefined) {
|
|
240
|
+
localVarQueryParameter['filter'] = filter;
|
|
241
|
+
}
|
|
242
|
+
if (search !== undefined) {
|
|
243
|
+
localVarQueryParameter['search'] = search;
|
|
244
|
+
}
|
|
245
|
+
if (order !== undefined) {
|
|
246
|
+
localVarQueryParameter['order'] = order;
|
|
247
|
+
}
|
|
248
|
+
if (expand !== undefined) {
|
|
249
|
+
localVarQueryParameter['expand'] = expand;
|
|
250
|
+
}
|
|
251
|
+
if (filters !== undefined) {
|
|
252
|
+
localVarQueryParameter['filters'] = filters;
|
|
253
|
+
}
|
|
254
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
255
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
256
|
+
}
|
|
257
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
258
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
259
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
260
|
+
return [2 /*return*/, {
|
|
261
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
262
|
+
options: localVarRequestOptions,
|
|
263
|
+
}];
|
|
264
|
+
}
|
|
265
|
+
});
|
|
266
|
+
});
|
|
267
|
+
},
|
|
268
|
+
/**
|
|
269
|
+
* This re-sends an email to invite an organization. **Required Permissions** \"tenant-management.organizations.create\"
|
|
270
|
+
* @param {ReInviteOrgRequestDto} reInviteOrgRequestDto
|
|
271
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
272
|
+
* @param {*} [options] Override http request option.
|
|
273
|
+
* @throws {RequiredError}
|
|
274
|
+
*/
|
|
275
|
+
reInviteOrganization: function (reInviteOrgRequestDto, authorization, options) {
|
|
276
|
+
if (options === void 0) { options = {}; }
|
|
277
|
+
return __awaiter(_this, void 0, void 0, function () {
|
|
278
|
+
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
279
|
+
return __generator(this, function (_a) {
|
|
280
|
+
switch (_a.label) {
|
|
281
|
+
case 0:
|
|
282
|
+
// verify required parameter 'reInviteOrgRequestDto' is not null or undefined
|
|
283
|
+
(0, common_1.assertParamExists)('reInviteOrganization', 'reInviteOrgRequestDto', reInviteOrgRequestDto);
|
|
284
|
+
localVarPath = "/tenantservice/v1/invitations/organizations";
|
|
285
|
+
localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
286
|
+
if (configuration) {
|
|
287
|
+
baseOptions = configuration.baseOptions;
|
|
288
|
+
baseAccessToken = configuration.accessToken;
|
|
289
|
+
}
|
|
290
|
+
localVarRequestOptions = __assign(__assign({ method: 'PATCH' }, baseOptions), options);
|
|
291
|
+
localVarHeaderParameter = {};
|
|
292
|
+
localVarQueryParameter = {};
|
|
293
|
+
// authentication bearer required
|
|
294
|
+
// http bearer authentication required
|
|
295
|
+
return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
|
|
296
|
+
case 1:
|
|
297
|
+
// authentication bearer required
|
|
298
|
+
// http bearer authentication required
|
|
299
|
+
_a.sent();
|
|
300
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
301
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
302
|
+
}
|
|
303
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
304
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
305
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
306
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
307
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(reInviteOrgRequestDto, localVarRequestOptions, configuration);
|
|
308
|
+
return [2 /*return*/, {
|
|
309
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
310
|
+
options: localVarRequestOptions,
|
|
311
|
+
}];
|
|
312
|
+
}
|
|
313
|
+
});
|
|
314
|
+
});
|
|
315
|
+
},
|
|
316
|
+
};
|
|
317
|
+
};
|
|
318
|
+
exports.InvitationControllerRestApiAxiosParamCreator = InvitationControllerRestApiAxiosParamCreator;
|
|
319
|
+
/**
|
|
320
|
+
* InvitationControllerRestApi - functional programming interface
|
|
321
|
+
* @export
|
|
322
|
+
*/
|
|
323
|
+
var InvitationControllerRestApiFp = function (configuration) {
|
|
324
|
+
var localVarAxiosParamCreator = (0, exports.InvitationControllerRestApiAxiosParamCreator)(configuration);
|
|
325
|
+
return {
|
|
326
|
+
/**
|
|
327
|
+
* Permanently deletes the organization invitation. Supply the unique id that was returned when you created the organization invitation and this will delete it. **Required Permissions** \"tenant-management.organizations.delete\"
|
|
328
|
+
* @summary Delete the organization invitation
|
|
329
|
+
* @param {number} id
|
|
330
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
331
|
+
* @param {*} [options] Override http request option.
|
|
332
|
+
* @throws {RequiredError}
|
|
333
|
+
*/
|
|
334
|
+
deleteOrgInvitation: function (id, authorization, options) {
|
|
335
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
336
|
+
var localVarAxiosArgs;
|
|
337
|
+
return __generator(this, function (_a) {
|
|
338
|
+
switch (_a.label) {
|
|
339
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.deleteOrgInvitation(id, authorization, options)];
|
|
340
|
+
case 1:
|
|
341
|
+
localVarAxiosArgs = _a.sent();
|
|
342
|
+
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
343
|
+
}
|
|
344
|
+
});
|
|
345
|
+
});
|
|
346
|
+
},
|
|
347
|
+
/**
|
|
348
|
+
* This sends an email to invite an organization. **Required Permissions** \"tenant-management.organizations.create\"
|
|
349
|
+
* @summary Invite an organization
|
|
350
|
+
* @param {InviteOrgRequestDtoRest} inviteOrgRequestDtoRest
|
|
351
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
352
|
+
* @param {*} [options] Override http request option.
|
|
353
|
+
* @throws {RequiredError}
|
|
354
|
+
*/
|
|
355
|
+
inviteOrg: function (inviteOrgRequestDtoRest, authorization, options) {
|
|
356
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
357
|
+
var localVarAxiosArgs;
|
|
358
|
+
return __generator(this, function (_a) {
|
|
359
|
+
switch (_a.label) {
|
|
360
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.inviteOrg(inviteOrgRequestDtoRest, authorization, options)];
|
|
361
|
+
case 1:
|
|
362
|
+
localVarAxiosArgs = _a.sent();
|
|
363
|
+
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
364
|
+
}
|
|
365
|
+
});
|
|
366
|
+
});
|
|
367
|
+
},
|
|
368
|
+
/**
|
|
369
|
+
* 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. **Required Permissions** \"tenant-management.organizations.view\"
|
|
370
|
+
* @summary List organization invitations
|
|
371
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
372
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
373
|
+
* @param {string} [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.
|
|
374
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
375
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
376
|
+
* @param {string} [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.
|
|
377
|
+
* @param {string} [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.
|
|
378
|
+
* @param {string} [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.
|
|
379
|
+
* @param {*} [options] Override http request option.
|
|
380
|
+
* @throws {RequiredError}
|
|
381
|
+
*/
|
|
382
|
+
listOrgInvitations: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
383
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
384
|
+
var localVarAxiosArgs;
|
|
385
|
+
return __generator(this, function (_a) {
|
|
386
|
+
switch (_a.label) {
|
|
387
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.listOrgInvitations(authorization, pageSize, pageToken, filter, search, order, expand, filters, options)];
|
|
388
|
+
case 1:
|
|
389
|
+
localVarAxiosArgs = _a.sent();
|
|
390
|
+
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
391
|
+
}
|
|
392
|
+
});
|
|
393
|
+
});
|
|
394
|
+
},
|
|
395
|
+
/**
|
|
396
|
+
* This re-sends an email to invite an organization. **Required Permissions** \"tenant-management.organizations.create\"
|
|
397
|
+
* @param {ReInviteOrgRequestDto} reInviteOrgRequestDto
|
|
398
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
399
|
+
* @param {*} [options] Override http request option.
|
|
400
|
+
* @throws {RequiredError}
|
|
401
|
+
*/
|
|
402
|
+
reInviteOrganization: function (reInviteOrgRequestDto, authorization, options) {
|
|
403
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
404
|
+
var localVarAxiosArgs;
|
|
405
|
+
return __generator(this, function (_a) {
|
|
406
|
+
switch (_a.label) {
|
|
407
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.reInviteOrganization(reInviteOrgRequestDto, authorization, options)];
|
|
408
|
+
case 1:
|
|
409
|
+
localVarAxiosArgs = _a.sent();
|
|
410
|
+
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
411
|
+
}
|
|
412
|
+
});
|
|
413
|
+
});
|
|
414
|
+
},
|
|
415
|
+
};
|
|
416
|
+
};
|
|
417
|
+
exports.InvitationControllerRestApiFp = InvitationControllerRestApiFp;
|
|
418
|
+
/**
|
|
419
|
+
* InvitationControllerRestApi - factory interface
|
|
420
|
+
* @export
|
|
421
|
+
*/
|
|
422
|
+
var InvitationControllerRestApiFactory = function (configuration, basePath, axios) {
|
|
423
|
+
var localVarFp = (0, exports.InvitationControllerRestApiFp)(configuration);
|
|
424
|
+
return {
|
|
425
|
+
/**
|
|
426
|
+
* Permanently deletes the organization invitation. Supply the unique id that was returned when you created the organization invitation and this will delete it. **Required Permissions** \"tenant-management.organizations.delete\"
|
|
427
|
+
* @summary Delete the organization invitation
|
|
428
|
+
* @param {number} id
|
|
429
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
430
|
+
* @param {*} [options] Override http request option.
|
|
431
|
+
* @throws {RequiredError}
|
|
432
|
+
*/
|
|
433
|
+
deleteOrgInvitation: function (id, authorization, options) {
|
|
434
|
+
return localVarFp.deleteOrgInvitation(id, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
435
|
+
},
|
|
436
|
+
/**
|
|
437
|
+
* This sends an email to invite an organization. **Required Permissions** \"tenant-management.organizations.create\"
|
|
438
|
+
* @summary Invite an organization
|
|
439
|
+
* @param {InviteOrgRequestDtoRest} inviteOrgRequestDtoRest
|
|
440
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
441
|
+
* @param {*} [options] Override http request option.
|
|
442
|
+
* @throws {RequiredError}
|
|
443
|
+
*/
|
|
444
|
+
inviteOrg: function (inviteOrgRequestDtoRest, authorization, options) {
|
|
445
|
+
return localVarFp.inviteOrg(inviteOrgRequestDtoRest, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
446
|
+
},
|
|
447
|
+
/**
|
|
448
|
+
* 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. **Required Permissions** \"tenant-management.organizations.view\"
|
|
449
|
+
* @summary List organization invitations
|
|
450
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
451
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
452
|
+
* @param {string} [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.
|
|
453
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
454
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
455
|
+
* @param {string} [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.
|
|
456
|
+
* @param {string} [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.
|
|
457
|
+
* @param {string} [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.
|
|
458
|
+
* @param {*} [options] Override http request option.
|
|
459
|
+
* @throws {RequiredError}
|
|
460
|
+
*/
|
|
461
|
+
listOrgInvitations: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
462
|
+
return localVarFp.listOrgInvitations(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
|
|
463
|
+
},
|
|
464
|
+
/**
|
|
465
|
+
* This re-sends an email to invite an organization. **Required Permissions** \"tenant-management.organizations.create\"
|
|
466
|
+
* @param {ReInviteOrgRequestDto} reInviteOrgRequestDto
|
|
467
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
468
|
+
* @param {*} [options] Override http request option.
|
|
469
|
+
* @throws {RequiredError}
|
|
470
|
+
*/
|
|
471
|
+
reInviteOrganization: function (reInviteOrgRequestDto, authorization, options) {
|
|
472
|
+
return localVarFp.reInviteOrganization(reInviteOrgRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
473
|
+
},
|
|
474
|
+
};
|
|
475
|
+
};
|
|
476
|
+
exports.InvitationControllerRestApiFactory = InvitationControllerRestApiFactory;
|
|
477
|
+
/**
|
|
478
|
+
* InvitationControllerRestApi - object-oriented interface
|
|
479
|
+
* @export
|
|
480
|
+
* @class InvitationControllerRestApi
|
|
481
|
+
* @extends {BaseAPI}
|
|
482
|
+
*/
|
|
483
|
+
var InvitationControllerRestApi = /** @class */ (function (_super) {
|
|
484
|
+
__extends(InvitationControllerRestApi, _super);
|
|
485
|
+
function InvitationControllerRestApi() {
|
|
486
|
+
return _super !== null && _super.apply(this, arguments) || this;
|
|
487
|
+
}
|
|
488
|
+
/**
|
|
489
|
+
* Permanently deletes the organization invitation. Supply the unique id that was returned when you created the organization invitation and this will delete it. **Required Permissions** \"tenant-management.organizations.delete\"
|
|
490
|
+
* @summary Delete the organization invitation
|
|
491
|
+
* @param {InvitationControllerRestApiDeleteOrgInvitationRequest} requestParameters Request parameters.
|
|
492
|
+
* @param {*} [options] Override http request option.
|
|
493
|
+
* @throws {RequiredError}
|
|
494
|
+
* @memberof InvitationControllerRestApi
|
|
495
|
+
*/
|
|
496
|
+
InvitationControllerRestApi.prototype.deleteOrgInvitation = function (requestParameters, options) {
|
|
497
|
+
var _this = this;
|
|
498
|
+
return (0, exports.InvitationControllerRestApiFp)(this.configuration).deleteOrgInvitation(requestParameters.id, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
499
|
+
};
|
|
500
|
+
/**
|
|
501
|
+
* This sends an email to invite an organization. **Required Permissions** \"tenant-management.organizations.create\"
|
|
502
|
+
* @summary Invite an organization
|
|
503
|
+
* @param {InvitationControllerRestApiInviteOrgRequest} requestParameters Request parameters.
|
|
504
|
+
* @param {*} [options] Override http request option.
|
|
505
|
+
* @throws {RequiredError}
|
|
506
|
+
* @memberof InvitationControllerRestApi
|
|
507
|
+
*/
|
|
508
|
+
InvitationControllerRestApi.prototype.inviteOrg = function (requestParameters, options) {
|
|
509
|
+
var _this = this;
|
|
510
|
+
return (0, exports.InvitationControllerRestApiFp)(this.configuration).inviteOrg(requestParameters.inviteOrgRequestDtoRest, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
511
|
+
};
|
|
512
|
+
/**
|
|
513
|
+
* 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. **Required Permissions** \"tenant-management.organizations.view\"
|
|
514
|
+
* @summary List organization invitations
|
|
515
|
+
* @param {InvitationControllerRestApiListOrgInvitationsRequest} requestParameters Request parameters.
|
|
516
|
+
* @param {*} [options] Override http request option.
|
|
517
|
+
* @throws {RequiredError}
|
|
518
|
+
* @memberof InvitationControllerRestApi
|
|
519
|
+
*/
|
|
520
|
+
InvitationControllerRestApi.prototype.listOrgInvitations = function (requestParameters, options) {
|
|
521
|
+
var _this = this;
|
|
522
|
+
if (requestParameters === void 0) { requestParameters = {}; }
|
|
523
|
+
return (0, exports.InvitationControllerRestApiFp)(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); });
|
|
524
|
+
};
|
|
525
|
+
/**
|
|
526
|
+
* This re-sends an email to invite an organization. **Required Permissions** \"tenant-management.organizations.create\"
|
|
527
|
+
* @param {InvitationControllerRestApiReInviteOrganizationRequest} requestParameters Request parameters.
|
|
528
|
+
* @param {*} [options] Override http request option.
|
|
529
|
+
* @throws {RequiredError}
|
|
530
|
+
* @memberof InvitationControllerRestApi
|
|
531
|
+
*/
|
|
532
|
+
InvitationControllerRestApi.prototype.reInviteOrganization = function (requestParameters, options) {
|
|
533
|
+
var _this = this;
|
|
534
|
+
return (0, exports.InvitationControllerRestApiFp)(this.configuration).reInviteOrganization(requestParameters.reInviteOrgRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
535
|
+
};
|
|
536
|
+
return InvitationControllerRestApi;
|
|
537
|
+
}(base_1.BaseAPI));
|
|
538
|
+
exports.InvitationControllerRestApi = InvitationControllerRestApi;
|
|
@@ -52,16 +52,16 @@ export declare const InviteUsersApiAxiosParamCreator: (configuration?: Configura
|
|
|
52
52
|
*/
|
|
53
53
|
inviteUsers: (inviteUsersRequestDtoRest: InviteUsersRequestDtoRest, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
54
54
|
/**
|
|
55
|
-
* Returns a list of invited users you have previously created.
|
|
55
|
+
* 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. **Required Permissions** \"tenant-management.users.view\"
|
|
56
56
|
* @summary List invited users
|
|
57
57
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
58
58
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
59
59
|
* @param {string} [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.
|
|
60
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
60
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, email, token, organizationId, ern, partnerCode</i>
|
|
61
61
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
62
62
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, email, expiresOn</i>
|
|
63
63
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: organizations<i>
|
|
64
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
64
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, email, token, organizationId, ern, partnerCode</i>
|
|
65
65
|
* @param {*} [options] Override http request option.
|
|
66
66
|
* @throws {RequiredError}
|
|
67
67
|
*/
|
|
@@ -100,16 +100,16 @@ export declare const InviteUsersApiFp: (configuration?: Configuration) => {
|
|
|
100
100
|
*/
|
|
101
101
|
inviteUsers(inviteUsersRequestDtoRest: InviteUsersRequestDtoRest, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InviteUsersResponseClass>>;
|
|
102
102
|
/**
|
|
103
|
-
* Returns a list of invited users you have previously created.
|
|
103
|
+
* 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. **Required Permissions** \"tenant-management.users.view\"
|
|
104
104
|
* @summary List invited users
|
|
105
105
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
106
106
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
107
107
|
* @param {string} [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.
|
|
108
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
108
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, email, token, organizationId, ern, partnerCode</i>
|
|
109
109
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
110
110
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, email, expiresOn</i>
|
|
111
111
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: organizations<i>
|
|
112
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
112
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, email, token, organizationId, ern, partnerCode</i>
|
|
113
113
|
* @param {*} [options] Override http request option.
|
|
114
114
|
* @throws {RequiredError}
|
|
115
115
|
*/
|
|
@@ -148,16 +148,16 @@ export declare const InviteUsersApiFactory: (configuration?: Configuration, base
|
|
|
148
148
|
*/
|
|
149
149
|
inviteUsers(inviteUsersRequestDtoRest: InviteUsersRequestDtoRest, authorization?: string, options?: any): AxiosPromise<InviteUsersResponseClass>;
|
|
150
150
|
/**
|
|
151
|
-
* Returns a list of invited users you have previously created.
|
|
151
|
+
* 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. **Required Permissions** \"tenant-management.users.view\"
|
|
152
152
|
* @summary List invited users
|
|
153
153
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
154
154
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
155
155
|
* @param {string} [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.
|
|
156
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
156
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, email, token, organizationId, ern, partnerCode</i>
|
|
157
157
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
158
158
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, email, expiresOn</i>
|
|
159
159
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: organizations<i>
|
|
160
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
160
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, email, token, organizationId, ern, partnerCode</i>
|
|
161
161
|
* @param {*} [options] Override http request option.
|
|
162
162
|
* @throws {RequiredError}
|
|
163
163
|
*/
|
|
@@ -245,7 +245,7 @@ export interface InviteUsersApiListInvitesRequest {
|
|
|
245
245
|
*/
|
|
246
246
|
readonly pageToken?: string;
|
|
247
247
|
/**
|
|
248
|
-
* Filter the response by one or multiple fields.
|
|
248
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, email, token, organizationId, ern, partnerCode</i>
|
|
249
249
|
* @type {string}
|
|
250
250
|
* @memberof InviteUsersApiListInvites
|
|
251
251
|
*/
|
|
@@ -269,7 +269,7 @@ export interface InviteUsersApiListInvitesRequest {
|
|
|
269
269
|
*/
|
|
270
270
|
readonly expand?: string;
|
|
271
271
|
/**
|
|
272
|
-
* Filters the response by one or multiple fields.
|
|
272
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, email, token, organizationId, ern, partnerCode</i>
|
|
273
273
|
* @type {string}
|
|
274
274
|
* @memberof InviteUsersApiListInvites
|
|
275
275
|
*/
|
|
@@ -310,7 +310,7 @@ export declare class InviteUsersApi extends BaseAPI {
|
|
|
310
310
|
*/
|
|
311
311
|
inviteUsers(requestParameters: InviteUsersApiInviteUsersRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<InviteUsersResponseClass, any, {}>>;
|
|
312
312
|
/**
|
|
313
|
-
* Returns a list of invited users you have previously created.
|
|
313
|
+
* 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. **Required Permissions** \"tenant-management.users.view\"
|
|
314
314
|
* @summary List invited users
|
|
315
315
|
* @param {InviteUsersApiListInvitesRequest} requestParameters Request parameters.
|
|
316
316
|
* @param {*} [options] Override http request option.
|