@emilgroup/tenant-sdk-node 1.21.0 → 1.22.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 +6 -12
- package/README.md +2 -2
- package/api/dashboard-api.ts +99 -0
- package/api/data-report-api.ts +0 -97
- package/api/{default-api.ts → health-check-api.ts} +21 -17
- package/api/invite-organizations-api.ts +15 -15
- package/api/invite-users-api.ts +34 -137
- package/api/roles-api.ts +4 -0
- package/api/users-api.ts +18 -447
- package/api.ts +2 -2
- package/dist/api/dashboard-api.d.ts +52 -0
- package/dist/api/dashboard-api.js +88 -0
- package/dist/api/data-report-api.d.ts +0 -51
- package/dist/api/data-report-api.js +0 -88
- package/dist/api/health-check-api.d.ts +70 -0
- package/dist/api/{default-api.js → health-check-api.js} +30 -26
- package/dist/api/invite-organizations-api.d.ts +9 -9
- package/dist/api/invite-organizations-api.js +12 -12
- package/dist/api/invite-users-api.d.ts +22 -78
- package/dist/api/invite-users-api.js +27 -119
- package/dist/api/roles-api.d.ts +4 -0
- package/dist/api/roles-api.js +4 -0
- package/dist/api/users-api.d.ts +15 -242
- package/dist/api/users-api.js +15 -382
- package/dist/api.d.ts +1 -1
- package/dist/api.js +1 -1
- package/dist/models/{assign-user-roles-request-dto.d.ts → create-tenant-db-config-request-dto.d.ts} +10 -10
- package/dist/models/custom-schema-class.d.ts +12 -0
- package/dist/models/data-report-class.d.ts +12 -0
- package/dist/models/data-report-filter-class.d.ts +12 -0
- package/dist/models/{enable-user-response-class.d.ts → get-embedded-url-response-class.d.ts} +6 -7
- package/dist/models/index.d.ts +5 -11
- package/dist/models/index.js +5 -11
- package/dist/models/invite-class.d.ts +12 -0
- package/dist/models/{invite-org-request-dto.d.ts → invite-org-request-dto-rest.d.ts} +27 -14
- package/dist/models/invite-user-request-dto-rest.d.ts +49 -0
- package/dist/models/invite-users-request-dto-rest.d.ts +49 -0
- package/dist/models/org-invitation-class.d.ts +12 -0
- package/dist/models/organization-class.d.ts +12 -0
- package/dist/models/permission-class.d.ts +12 -0
- package/dist/models/role-class.d.ts +12 -0
- package/dist/models/subscription-class.d.ts +12 -0
- package/dist/models/user-class.d.ts +12 -0
- package/models/{assign-user-roles-request-dto.ts → create-tenant-db-config-request-dto.ts} +10 -10
- package/models/custom-schema-class.ts +12 -0
- package/models/data-report-class.ts +12 -0
- package/models/data-report-filter-class.ts +12 -0
- package/models/{enable-user-response-class.ts → get-embedded-url-response-class.ts} +6 -7
- package/models/index.ts +5 -11
- package/models/invite-class.ts +12 -0
- package/models/{invite-org-request-dto.ts → invite-org-request-dto-rest.ts} +27 -14
- package/models/invite-user-request-dto-rest.ts +55 -0
- package/models/invite-users-request-dto-rest.ts +55 -0
- package/models/org-invitation-class.ts +12 -0
- package/models/organization-class.ts +12 -0
- package/models/permission-class.ts +12 -0
- package/models/role-class.ts +12 -0
- package/models/subscription-class.ts +12 -0
- package/models/user-class.ts +12 -0
- package/package.json +1 -1
- package/dist/api/default-api.d.ts +0 -66
- package/dist/models/assign-user-roles-response-class.d.ts +0 -25
- package/dist/models/create-permission-request-dto.d.ts +0 -42
- package/dist/models/create-role-request-dto.d.ts +0 -36
- package/dist/models/disable-user-response-class.d.ts +0 -25
- package/dist/models/enable-user-response-class.js +0 -15
- package/dist/models/invite-org-request-dto.js +0 -15
- package/dist/models/invite-user-request-dto.d.ts +0 -43
- package/dist/models/invite-user-request-dto.js +0 -15
- package/dist/models/invite-users-request-dto.d.ts +0 -36
- package/dist/models/invite-users-request-dto.js +0 -15
- package/dist/models/partner-invitation-data-dto.d.ts +0 -36
- package/dist/models/partner-invitation-data-dto.js +0 -15
- package/dist/models/update-role-request-dto.d.ts +0 -42
- package/dist/models/update-role-request-dto.js +0 -15
- package/models/assign-user-roles-response-class.ts +0 -31
- package/models/create-permission-request-dto.ts +0 -48
- package/models/create-role-request-dto.ts +0 -42
- package/models/disable-user-response-class.ts +0 -31
- package/models/invite-user-request-dto.ts +0 -49
- package/models/invite-users-request-dto.ts +0 -42
- package/models/partner-invitation-data-dto.ts +0 -42
- package/models/update-role-request-dto.ts +0 -48
- /package/dist/models/{assign-user-roles-request-dto.js → create-tenant-db-config-request-dto.js} +0 -0
- /package/dist/models/{assign-user-roles-response-class.js → get-embedded-url-response-class.js} +0 -0
- /package/dist/models/{create-permission-request-dto.js → invite-org-request-dto-rest.js} +0 -0
- /package/dist/models/{create-role-request-dto.js → invite-user-request-dto-rest.js} +0 -0
- /package/dist/models/{disable-user-response-class.js → invite-users-request-dto-rest.js} +0 -0
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
13
13
|
import { Configuration } from '../configuration';
|
|
14
14
|
import { RequestArgs, BaseAPI } from '../base';
|
|
15
|
-
import {
|
|
15
|
+
import { InviteOrgRequestDtoRest } from '../models';
|
|
16
16
|
import { OrgInvitationResponseClass } from '../models';
|
|
17
17
|
/**
|
|
18
18
|
* InviteOrganizationsApi - axios parameter creator
|
|
@@ -22,12 +22,12 @@ export declare const InviteOrganizationsApiAxiosParamCreator: (configuration?: C
|
|
|
22
22
|
/**
|
|
23
23
|
* This sends an email to invite an organization.
|
|
24
24
|
* @summary Invite an organization
|
|
25
|
-
* @param {
|
|
25
|
+
* @param {InviteOrgRequestDtoRest} inviteOrgRequestDtoRest
|
|
26
26
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
27
27
|
* @param {*} [options] Override http request option.
|
|
28
28
|
* @throws {RequiredError}
|
|
29
29
|
*/
|
|
30
|
-
inviteOrg: (
|
|
30
|
+
inviteOrg: (inviteOrgRequestDtoRest: InviteOrgRequestDtoRest, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
31
31
|
};
|
|
32
32
|
/**
|
|
33
33
|
* InviteOrganizationsApi - functional programming interface
|
|
@@ -37,12 +37,12 @@ export declare const InviteOrganizationsApiFp: (configuration?: Configuration) =
|
|
|
37
37
|
/**
|
|
38
38
|
* This sends an email to invite an organization.
|
|
39
39
|
* @summary Invite an organization
|
|
40
|
-
* @param {
|
|
40
|
+
* @param {InviteOrgRequestDtoRest} inviteOrgRequestDtoRest
|
|
41
41
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
42
42
|
* @param {*} [options] Override http request option.
|
|
43
43
|
* @throws {RequiredError}
|
|
44
44
|
*/
|
|
45
|
-
inviteOrg(
|
|
45
|
+
inviteOrg(inviteOrgRequestDtoRest: InviteOrgRequestDtoRest, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrgInvitationResponseClass>>;
|
|
46
46
|
};
|
|
47
47
|
/**
|
|
48
48
|
* InviteOrganizationsApi - factory interface
|
|
@@ -52,12 +52,12 @@ export declare const InviteOrganizationsApiFactory: (configuration?: Configurati
|
|
|
52
52
|
/**
|
|
53
53
|
* This sends an email to invite an organization.
|
|
54
54
|
* @summary Invite an organization
|
|
55
|
-
* @param {
|
|
55
|
+
* @param {InviteOrgRequestDtoRest} inviteOrgRequestDtoRest
|
|
56
56
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
57
57
|
* @param {*} [options] Override http request option.
|
|
58
58
|
* @throws {RequiredError}
|
|
59
59
|
*/
|
|
60
|
-
inviteOrg(
|
|
60
|
+
inviteOrg(inviteOrgRequestDtoRest: InviteOrgRequestDtoRest, authorization?: string, options?: any): AxiosPromise<OrgInvitationResponseClass>;
|
|
61
61
|
};
|
|
62
62
|
/**
|
|
63
63
|
* Request parameters for inviteOrg operation in InviteOrganizationsApi.
|
|
@@ -67,10 +67,10 @@ export declare const InviteOrganizationsApiFactory: (configuration?: Configurati
|
|
|
67
67
|
export interface InviteOrganizationsApiInviteOrgRequest {
|
|
68
68
|
/**
|
|
69
69
|
*
|
|
70
|
-
* @type {
|
|
70
|
+
* @type {InviteOrgRequestDtoRest}
|
|
71
71
|
* @memberof InviteOrganizationsApiInviteOrg
|
|
72
72
|
*/
|
|
73
|
-
readonly
|
|
73
|
+
readonly inviteOrgRequestDtoRest: InviteOrgRequestDtoRest;
|
|
74
74
|
/**
|
|
75
75
|
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
76
76
|
* @type {string}
|
|
@@ -99,20 +99,20 @@ var InviteOrganizationsApiAxiosParamCreator = function (configuration) {
|
|
|
99
99
|
/**
|
|
100
100
|
* This sends an email to invite an organization.
|
|
101
101
|
* @summary Invite an organization
|
|
102
|
-
* @param {
|
|
102
|
+
* @param {InviteOrgRequestDtoRest} inviteOrgRequestDtoRest
|
|
103
103
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
104
104
|
* @param {*} [options] Override http request option.
|
|
105
105
|
* @throws {RequiredError}
|
|
106
106
|
*/
|
|
107
|
-
inviteOrg: function (
|
|
107
|
+
inviteOrg: function (inviteOrgRequestDtoRest, authorization, options) {
|
|
108
108
|
if (options === void 0) { options = {}; }
|
|
109
109
|
return __awaiter(_this, void 0, void 0, function () {
|
|
110
110
|
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
111
111
|
return __generator(this, function (_a) {
|
|
112
112
|
switch (_a.label) {
|
|
113
113
|
case 0:
|
|
114
|
-
// verify required parameter '
|
|
115
|
-
(0, common_1.assertParamExists)('inviteOrg', '
|
|
114
|
+
// verify required parameter 'inviteOrgRequestDtoRest' is not null or undefined
|
|
115
|
+
(0, common_1.assertParamExists)('inviteOrg', 'inviteOrgRequestDtoRest', inviteOrgRequestDtoRest);
|
|
116
116
|
localVarPath = "/tenantservice/v1/invitations/organizations";
|
|
117
117
|
localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
118
118
|
if (configuration) {
|
|
@@ -136,7 +136,7 @@ var InviteOrganizationsApiAxiosParamCreator = function (configuration) {
|
|
|
136
136
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
137
137
|
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
138
138
|
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
139
|
-
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(
|
|
139
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(inviteOrgRequestDtoRest, localVarRequestOptions, configuration);
|
|
140
140
|
return [2 /*return*/, {
|
|
141
141
|
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
142
142
|
options: localVarRequestOptions,
|
|
@@ -158,17 +158,17 @@ var InviteOrganizationsApiFp = function (configuration) {
|
|
|
158
158
|
/**
|
|
159
159
|
* This sends an email to invite an organization.
|
|
160
160
|
* @summary Invite an organization
|
|
161
|
-
* @param {
|
|
161
|
+
* @param {InviteOrgRequestDtoRest} inviteOrgRequestDtoRest
|
|
162
162
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
163
163
|
* @param {*} [options] Override http request option.
|
|
164
164
|
* @throws {RequiredError}
|
|
165
165
|
*/
|
|
166
|
-
inviteOrg: function (
|
|
166
|
+
inviteOrg: function (inviteOrgRequestDtoRest, authorization, options) {
|
|
167
167
|
return __awaiter(this, void 0, void 0, function () {
|
|
168
168
|
var localVarAxiosArgs;
|
|
169
169
|
return __generator(this, function (_a) {
|
|
170
170
|
switch (_a.label) {
|
|
171
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.inviteOrg(
|
|
171
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.inviteOrg(inviteOrgRequestDtoRest, authorization, options)];
|
|
172
172
|
case 1:
|
|
173
173
|
localVarAxiosArgs = _a.sent();
|
|
174
174
|
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
@@ -189,13 +189,13 @@ var InviteOrganizationsApiFactory = function (configuration, basePath, axios) {
|
|
|
189
189
|
/**
|
|
190
190
|
* This sends an email to invite an organization.
|
|
191
191
|
* @summary Invite an organization
|
|
192
|
-
* @param {
|
|
192
|
+
* @param {InviteOrgRequestDtoRest} inviteOrgRequestDtoRest
|
|
193
193
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
194
194
|
* @param {*} [options] Override http request option.
|
|
195
195
|
* @throws {RequiredError}
|
|
196
196
|
*/
|
|
197
|
-
inviteOrg: function (
|
|
198
|
-
return localVarFp.inviteOrg(
|
|
197
|
+
inviteOrg: function (inviteOrgRequestDtoRest, authorization, options) {
|
|
198
|
+
return localVarFp.inviteOrg(inviteOrgRequestDtoRest, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
199
199
|
},
|
|
200
200
|
};
|
|
201
201
|
};
|
|
@@ -221,7 +221,7 @@ var InviteOrganizationsApi = /** @class */ (function (_super) {
|
|
|
221
221
|
*/
|
|
222
222
|
InviteOrganizationsApi.prototype.inviteOrg = function (requestParameters, options) {
|
|
223
223
|
var _this = this;
|
|
224
|
-
return (0, exports.InviteOrganizationsApiFp)(this.configuration).inviteOrg(requestParameters.
|
|
224
|
+
return (0, exports.InviteOrganizationsApiFp)(this.configuration).inviteOrg(requestParameters.inviteOrgRequestDtoRest, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
225
225
|
};
|
|
226
226
|
return InviteOrganizationsApi;
|
|
227
227
|
}(base_1.BaseAPI));
|
|
@@ -14,10 +14,9 @@ import { Configuration } from '../configuration';
|
|
|
14
14
|
import { RequestArgs, BaseAPI } from '../base';
|
|
15
15
|
import { BatchDeleteRequestDto } from '../models';
|
|
16
16
|
import { BatchDeleteResponseClass } from '../models';
|
|
17
|
-
import {
|
|
18
|
-
import { InviteUserRequestDto } from '../models';
|
|
17
|
+
import { InviteUserRequestDtoRest } from '../models';
|
|
19
18
|
import { InviteUserResponseClass } from '../models';
|
|
20
|
-
import {
|
|
19
|
+
import { InviteUsersRequestDtoRest } from '../models';
|
|
21
20
|
import { InviteUsersResponseClass } from '../models';
|
|
22
21
|
import { ListInvitesResponseClass } from '../models';
|
|
23
22
|
/**
|
|
@@ -25,15 +24,6 @@ import { ListInvitesResponseClass } from '../models';
|
|
|
25
24
|
* @export
|
|
26
25
|
*/
|
|
27
26
|
export declare const InviteUsersApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
28
|
-
/**
|
|
29
|
-
* Permanently deletes the invited user. Supply the unique id that was returned when you created the invited user and this will delete it.
|
|
30
|
-
* @summary Delete the invited user
|
|
31
|
-
* @param {number} id
|
|
32
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
33
|
-
* @param {*} [options] Override http request option.
|
|
34
|
-
* @throws {RequiredError}
|
|
35
|
-
*/
|
|
36
|
-
deleteInvite: (id: number, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
37
27
|
/**
|
|
38
28
|
* This will deletes the users who has been invited. Supply array of ids that were returned when users has been created and this will delete it.
|
|
39
29
|
* @summary Delete invited users.
|
|
@@ -46,21 +36,21 @@ export declare const InviteUsersApiAxiosParamCreator: (configuration?: Configura
|
|
|
46
36
|
/**
|
|
47
37
|
* This send an email to invite a user with the specific role/roles.
|
|
48
38
|
* @summary Invite a user
|
|
49
|
-
* @param {
|
|
39
|
+
* @param {InviteUserRequestDtoRest} inviteUserRequestDtoRest
|
|
50
40
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
51
41
|
* @param {*} [options] Override http request option.
|
|
52
42
|
* @throws {RequiredError}
|
|
53
43
|
*/
|
|
54
|
-
inviteUser: (
|
|
44
|
+
inviteUser: (inviteUserRequestDtoRest: InviteUserRequestDtoRest, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
55
45
|
/**
|
|
56
46
|
* This send bulk emails to invite users with the specific role/roles.
|
|
57
47
|
* @summary Invite batch of users
|
|
58
|
-
* @param {
|
|
48
|
+
* @param {InviteUsersRequestDtoRest} inviteUsersRequestDtoRest
|
|
59
49
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
60
50
|
* @param {*} [options] Override http request option.
|
|
61
51
|
* @throws {RequiredError}
|
|
62
52
|
*/
|
|
63
|
-
inviteUsers: (
|
|
53
|
+
inviteUsers: (inviteUsersRequestDtoRest: InviteUsersRequestDtoRest, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
64
54
|
/**
|
|
65
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.
|
|
66
56
|
* @summary List invited users
|
|
@@ -70,7 +60,7 @@ export declare const InviteUsersApiAxiosParamCreator: (configuration?: Configura
|
|
|
70
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</i>
|
|
71
61
|
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
72
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: email, expiresOn</i>
|
|
73
|
-
* @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:
|
|
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>
|
|
74
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</i>
|
|
75
65
|
* @param {*} [options] Override http request option.
|
|
76
66
|
* @throws {RequiredError}
|
|
@@ -82,15 +72,6 @@ export declare const InviteUsersApiAxiosParamCreator: (configuration?: Configura
|
|
|
82
72
|
* @export
|
|
83
73
|
*/
|
|
84
74
|
export declare const InviteUsersApiFp: (configuration?: Configuration) => {
|
|
85
|
-
/**
|
|
86
|
-
* Permanently deletes the invited user. Supply the unique id that was returned when you created the invited user and this will delete it.
|
|
87
|
-
* @summary Delete the invited user
|
|
88
|
-
* @param {number} id
|
|
89
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
90
|
-
* @param {*} [options] Override http request option.
|
|
91
|
-
* @throws {RequiredError}
|
|
92
|
-
*/
|
|
93
|
-
deleteInvite(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponseClass>>;
|
|
94
75
|
/**
|
|
95
76
|
* This will deletes the users who has been invited. Supply array of ids that were returned when users has been created and this will delete it.
|
|
96
77
|
* @summary Delete invited users.
|
|
@@ -103,21 +84,21 @@ export declare const InviteUsersApiFp: (configuration?: Configuration) => {
|
|
|
103
84
|
/**
|
|
104
85
|
* This send an email to invite a user with the specific role/roles.
|
|
105
86
|
* @summary Invite a user
|
|
106
|
-
* @param {
|
|
87
|
+
* @param {InviteUserRequestDtoRest} inviteUserRequestDtoRest
|
|
107
88
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
108
89
|
* @param {*} [options] Override http request option.
|
|
109
90
|
* @throws {RequiredError}
|
|
110
91
|
*/
|
|
111
|
-
inviteUser(
|
|
92
|
+
inviteUser(inviteUserRequestDtoRest: InviteUserRequestDtoRest, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InviteUserResponseClass>>;
|
|
112
93
|
/**
|
|
113
94
|
* This send bulk emails to invite users with the specific role/roles.
|
|
114
95
|
* @summary Invite batch of users
|
|
115
|
-
* @param {
|
|
96
|
+
* @param {InviteUsersRequestDtoRest} inviteUsersRequestDtoRest
|
|
116
97
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
117
98
|
* @param {*} [options] Override http request option.
|
|
118
99
|
* @throws {RequiredError}
|
|
119
100
|
*/
|
|
120
|
-
inviteUsers(
|
|
101
|
+
inviteUsers(inviteUsersRequestDtoRest: InviteUsersRequestDtoRest, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InviteUsersResponseClass>>;
|
|
121
102
|
/**
|
|
122
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.
|
|
123
104
|
* @summary List invited users
|
|
@@ -127,7 +108,7 @@ export declare const InviteUsersApiFp: (configuration?: Configuration) => {
|
|
|
127
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</i>
|
|
128
109
|
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
129
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: email, expiresOn</i>
|
|
130
|
-
* @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:
|
|
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>
|
|
131
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</i>
|
|
132
113
|
* @param {*} [options] Override http request option.
|
|
133
114
|
* @throws {RequiredError}
|
|
@@ -139,15 +120,6 @@ export declare const InviteUsersApiFp: (configuration?: Configuration) => {
|
|
|
139
120
|
* @export
|
|
140
121
|
*/
|
|
141
122
|
export declare const InviteUsersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
142
|
-
/**
|
|
143
|
-
* Permanently deletes the invited user. Supply the unique id that was returned when you created the invited user and this will delete it.
|
|
144
|
-
* @summary Delete the invited user
|
|
145
|
-
* @param {number} id
|
|
146
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
147
|
-
* @param {*} [options] Override http request option.
|
|
148
|
-
* @throws {RequiredError}
|
|
149
|
-
*/
|
|
150
|
-
deleteInvite(id: number, authorization?: string, options?: any): AxiosPromise<DeleteResponseClass>;
|
|
151
123
|
/**
|
|
152
124
|
* This will deletes the users who has been invited. Supply array of ids that were returned when users has been created and this will delete it.
|
|
153
125
|
* @summary Delete invited users.
|
|
@@ -160,21 +132,21 @@ export declare const InviteUsersApiFactory: (configuration?: Configuration, base
|
|
|
160
132
|
/**
|
|
161
133
|
* This send an email to invite a user with the specific role/roles.
|
|
162
134
|
* @summary Invite a user
|
|
163
|
-
* @param {
|
|
135
|
+
* @param {InviteUserRequestDtoRest} inviteUserRequestDtoRest
|
|
164
136
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
165
137
|
* @param {*} [options] Override http request option.
|
|
166
138
|
* @throws {RequiredError}
|
|
167
139
|
*/
|
|
168
|
-
inviteUser(
|
|
140
|
+
inviteUser(inviteUserRequestDtoRest: InviteUserRequestDtoRest, authorization?: string, options?: any): AxiosPromise<InviteUserResponseClass>;
|
|
169
141
|
/**
|
|
170
142
|
* This send bulk emails to invite users with the specific role/roles.
|
|
171
143
|
* @summary Invite batch of users
|
|
172
|
-
* @param {
|
|
144
|
+
* @param {InviteUsersRequestDtoRest} inviteUsersRequestDtoRest
|
|
173
145
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
174
146
|
* @param {*} [options] Override http request option.
|
|
175
147
|
* @throws {RequiredError}
|
|
176
148
|
*/
|
|
177
|
-
inviteUsers(
|
|
149
|
+
inviteUsers(inviteUsersRequestDtoRest: InviteUsersRequestDtoRest, authorization?: string, options?: any): AxiosPromise<InviteUsersResponseClass>;
|
|
178
150
|
/**
|
|
179
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.
|
|
180
152
|
* @summary List invited users
|
|
@@ -184,32 +156,13 @@ export declare const InviteUsersApiFactory: (configuration?: Configuration, base
|
|
|
184
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</i>
|
|
185
157
|
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
186
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: email, expiresOn</i>
|
|
187
|
-
* @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:
|
|
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>
|
|
188
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</i>
|
|
189
161
|
* @param {*} [options] Override http request option.
|
|
190
162
|
* @throws {RequiredError}
|
|
191
163
|
*/
|
|
192
164
|
listInvites(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListInvitesResponseClass>;
|
|
193
165
|
};
|
|
194
|
-
/**
|
|
195
|
-
* Request parameters for deleteInvite operation in InviteUsersApi.
|
|
196
|
-
* @export
|
|
197
|
-
* @interface InviteUsersApiDeleteInviteRequest
|
|
198
|
-
*/
|
|
199
|
-
export interface InviteUsersApiDeleteInviteRequest {
|
|
200
|
-
/**
|
|
201
|
-
*
|
|
202
|
-
* @type {number}
|
|
203
|
-
* @memberof InviteUsersApiDeleteInvite
|
|
204
|
-
*/
|
|
205
|
-
readonly id: number;
|
|
206
|
-
/**
|
|
207
|
-
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
208
|
-
* @type {string}
|
|
209
|
-
* @memberof InviteUsersApiDeleteInvite
|
|
210
|
-
*/
|
|
211
|
-
readonly authorization?: string;
|
|
212
|
-
}
|
|
213
166
|
/**
|
|
214
167
|
* Request parameters for deleteInvites operation in InviteUsersApi.
|
|
215
168
|
* @export
|
|
@@ -237,10 +190,10 @@ export interface InviteUsersApiDeleteInvitesRequest {
|
|
|
237
190
|
export interface InviteUsersApiInviteUserRequest {
|
|
238
191
|
/**
|
|
239
192
|
*
|
|
240
|
-
* @type {
|
|
193
|
+
* @type {InviteUserRequestDtoRest}
|
|
241
194
|
* @memberof InviteUsersApiInviteUser
|
|
242
195
|
*/
|
|
243
|
-
readonly
|
|
196
|
+
readonly inviteUserRequestDtoRest: InviteUserRequestDtoRest;
|
|
244
197
|
/**
|
|
245
198
|
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
246
199
|
* @type {string}
|
|
@@ -256,10 +209,10 @@ export interface InviteUsersApiInviteUserRequest {
|
|
|
256
209
|
export interface InviteUsersApiInviteUsersRequest {
|
|
257
210
|
/**
|
|
258
211
|
*
|
|
259
|
-
* @type {
|
|
212
|
+
* @type {InviteUsersRequestDtoRest}
|
|
260
213
|
* @memberof InviteUsersApiInviteUsers
|
|
261
214
|
*/
|
|
262
|
-
readonly
|
|
215
|
+
readonly inviteUsersRequestDtoRest: InviteUsersRequestDtoRest;
|
|
263
216
|
/**
|
|
264
217
|
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
265
218
|
* @type {string}
|
|
@@ -310,7 +263,7 @@ export interface InviteUsersApiListInvitesRequest {
|
|
|
310
263
|
*/
|
|
311
264
|
readonly order?: string;
|
|
312
265
|
/**
|
|
313
|
-
* 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:
|
|
266
|
+
* 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>
|
|
314
267
|
* @type {string}
|
|
315
268
|
* @memberof InviteUsersApiListInvites
|
|
316
269
|
*/
|
|
@@ -329,15 +282,6 @@ export interface InviteUsersApiListInvitesRequest {
|
|
|
329
282
|
* @extends {BaseAPI}
|
|
330
283
|
*/
|
|
331
284
|
export declare class InviteUsersApi extends BaseAPI {
|
|
332
|
-
/**
|
|
333
|
-
* Permanently deletes the invited user. Supply the unique id that was returned when you created the invited user and this will delete it.
|
|
334
|
-
* @summary Delete the invited user
|
|
335
|
-
* @param {InviteUsersApiDeleteInviteRequest} requestParameters Request parameters.
|
|
336
|
-
* @param {*} [options] Override http request option.
|
|
337
|
-
* @throws {RequiredError}
|
|
338
|
-
* @memberof InviteUsersApi
|
|
339
|
-
*/
|
|
340
|
-
deleteInvite(requestParameters: InviteUsersApiDeleteInviteRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteResponseClass, any>>;
|
|
341
285
|
/**
|
|
342
286
|
* This will deletes the users who has been invited. Supply array of ids that were returned when users has been created and this will delete it.
|
|
343
287
|
* @summary Delete invited users.
|