@emilgroup/tenant-sdk-node 1.0.1 → 1.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/api/custom-schema-api.ts +53 -61
- package/api/data-report-api.ts +66 -76
- package/api/invite-organizations-api.ts +24 -28
- package/api/invite-users-api.ts +69 -79
- package/api/organizations-api.ts +22 -26
- package/api/users-api.ts +130 -148
- package/dist/api/custom-schema-api.d.ts +43 -43
- package/dist/api/custom-schema-api.js +31 -38
- package/dist/api/data-report-api.d.ts +53 -53
- package/dist/api/data-report-api.js +40 -49
- package/dist/api/invite-organizations-api.d.ts +21 -21
- package/dist/api/invite-organizations-api.js +13 -16
- package/dist/api/invite-users-api.d.ts +57 -57
- package/dist/api/invite-users-api.js +40 -49
- package/dist/api/organizations-api.d.ts +19 -19
- package/dist/api/organizations-api.js +13 -16
- package/dist/api/users-api.d.ts +105 -105
- package/dist/api/users-api.js +76 -93
- package/package.json +1 -1
|
@@ -23,16 +23,16 @@ export declare const InviteOrganizationsApiAxiosParamCreator: (configuration?: C
|
|
|
23
23
|
/**
|
|
24
24
|
* This sends an email to invite an organization.
|
|
25
25
|
* @summary Invite an organization
|
|
26
|
-
* @param {string} authorization Bearer Token: provided by the login endpoint under the name accessToken.
|
|
27
26
|
* @param {InviteOrgRequestDto} inviteOrgRequestDto
|
|
27
|
+
* @param {string} [authorization] Bearer Token
|
|
28
28
|
* @param {*} [options] Override http request option.
|
|
29
29
|
* @throws {RequiredError}
|
|
30
30
|
*/
|
|
31
|
-
inviteOrg: (
|
|
31
|
+
inviteOrg: (inviteOrgRequestDto: InviteOrgRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
32
32
|
/**
|
|
33
33
|
* Returns a list of org invitations you have previously created. The org invitations are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
34
34
|
* @summary List org invitations
|
|
35
|
-
* @param {string} authorization Bearer Token
|
|
35
|
+
* @param {string} [authorization] Bearer Token
|
|
36
36
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
37
37
|
* @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.
|
|
38
38
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
@@ -42,7 +42,7 @@ export declare const InviteOrganizationsApiAxiosParamCreator: (configuration?: C
|
|
|
42
42
|
* @param {*} [options] Override http request option.
|
|
43
43
|
* @throws {RequiredError}
|
|
44
44
|
*/
|
|
45
|
-
listOrgInvitations: (authorization
|
|
45
|
+
listOrgInvitations: (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
46
46
|
};
|
|
47
47
|
/**
|
|
48
48
|
* InviteOrganizationsApi - functional programming interface
|
|
@@ -52,16 +52,16 @@ export declare const InviteOrganizationsApiFp: (configuration?: Configuration) =
|
|
|
52
52
|
/**
|
|
53
53
|
* This sends an email to invite an organization.
|
|
54
54
|
* @summary Invite an organization
|
|
55
|
-
* @param {string} authorization Bearer Token: provided by the login endpoint under the name accessToken.
|
|
56
55
|
* @param {InviteOrgRequestDto} inviteOrgRequestDto
|
|
56
|
+
* @param {string} [authorization] Bearer Token
|
|
57
57
|
* @param {*} [options] Override http request option.
|
|
58
58
|
* @throws {RequiredError}
|
|
59
59
|
*/
|
|
60
|
-
inviteOrg(
|
|
60
|
+
inviteOrg(inviteOrgRequestDto: InviteOrgRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrgInvitationResponseClass>>;
|
|
61
61
|
/**
|
|
62
62
|
* Returns a list of org invitations you have previously created. The org invitations are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
63
63
|
* @summary List org invitations
|
|
64
|
-
* @param {string} authorization Bearer Token
|
|
64
|
+
* @param {string} [authorization] Bearer Token
|
|
65
65
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
66
66
|
* @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
67
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
@@ -71,7 +71,7 @@ export declare const InviteOrganizationsApiFp: (configuration?: Configuration) =
|
|
|
71
71
|
* @param {*} [options] Override http request option.
|
|
72
72
|
* @throws {RequiredError}
|
|
73
73
|
*/
|
|
74
|
-
listOrgInvitations(authorization
|
|
74
|
+
listOrgInvitations(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListOrgInvitationsResponseClass>>;
|
|
75
75
|
};
|
|
76
76
|
/**
|
|
77
77
|
* InviteOrganizationsApi - factory interface
|
|
@@ -81,16 +81,16 @@ export declare const InviteOrganizationsApiFactory: (configuration?: Configurati
|
|
|
81
81
|
/**
|
|
82
82
|
* This sends an email to invite an organization.
|
|
83
83
|
* @summary Invite an organization
|
|
84
|
-
* @param {string} authorization Bearer Token: provided by the login endpoint under the name accessToken.
|
|
85
84
|
* @param {InviteOrgRequestDto} inviteOrgRequestDto
|
|
85
|
+
* @param {string} [authorization] Bearer Token
|
|
86
86
|
* @param {*} [options] Override http request option.
|
|
87
87
|
* @throws {RequiredError}
|
|
88
88
|
*/
|
|
89
|
-
inviteOrg(
|
|
89
|
+
inviteOrg(inviteOrgRequestDto: InviteOrgRequestDto, authorization?: string, options?: any): AxiosPromise<OrgInvitationResponseClass>;
|
|
90
90
|
/**
|
|
91
91
|
* Returns a list of org invitations you have previously created. The org invitations are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
92
92
|
* @summary List org invitations
|
|
93
|
-
* @param {string} authorization Bearer Token
|
|
93
|
+
* @param {string} [authorization] Bearer Token
|
|
94
94
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
95
95
|
* @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.
|
|
96
96
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
@@ -100,7 +100,7 @@ export declare const InviteOrganizationsApiFactory: (configuration?: Configurati
|
|
|
100
100
|
* @param {*} [options] Override http request option.
|
|
101
101
|
* @throws {RequiredError}
|
|
102
102
|
*/
|
|
103
|
-
listOrgInvitations(authorization
|
|
103
|
+
listOrgInvitations(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: any): AxiosPromise<ListOrgInvitationsResponseClass>;
|
|
104
104
|
};
|
|
105
105
|
/**
|
|
106
106
|
* Request parameters for inviteOrg operation in InviteOrganizationsApi.
|
|
@@ -108,18 +108,18 @@ export declare const InviteOrganizationsApiFactory: (configuration?: Configurati
|
|
|
108
108
|
* @interface InviteOrganizationsApiInviteOrgRequest
|
|
109
109
|
*/
|
|
110
110
|
export interface InviteOrganizationsApiInviteOrgRequest {
|
|
111
|
-
/**
|
|
112
|
-
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
113
|
-
* @type {string}
|
|
114
|
-
* @memberof InviteOrganizationsApiInviteOrg
|
|
115
|
-
*/
|
|
116
|
-
readonly authorization: string;
|
|
117
111
|
/**
|
|
118
112
|
*
|
|
119
113
|
* @type {InviteOrgRequestDto}
|
|
120
114
|
* @memberof InviteOrganizationsApiInviteOrg
|
|
121
115
|
*/
|
|
122
116
|
readonly inviteOrgRequestDto: InviteOrgRequestDto;
|
|
117
|
+
/**
|
|
118
|
+
* Bearer Token
|
|
119
|
+
* @type {string}
|
|
120
|
+
* @memberof InviteOrganizationsApiInviteOrg
|
|
121
|
+
*/
|
|
122
|
+
readonly authorization?: string;
|
|
123
123
|
}
|
|
124
124
|
/**
|
|
125
125
|
* Request parameters for listOrgInvitations operation in InviteOrganizationsApi.
|
|
@@ -128,11 +128,11 @@ export interface InviteOrganizationsApiInviteOrgRequest {
|
|
|
128
128
|
*/
|
|
129
129
|
export interface InviteOrganizationsApiListOrgInvitationsRequest {
|
|
130
130
|
/**
|
|
131
|
-
* Bearer Token
|
|
131
|
+
* Bearer Token
|
|
132
132
|
* @type {string}
|
|
133
133
|
* @memberof InviteOrganizationsApiListOrgInvitations
|
|
134
134
|
*/
|
|
135
|
-
readonly authorization
|
|
135
|
+
readonly authorization?: string;
|
|
136
136
|
/**
|
|
137
137
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
138
138
|
* @type {any}
|
|
@@ -194,5 +194,5 @@ export declare class InviteOrganizationsApi extends BaseAPI {
|
|
|
194
194
|
* @throws {RequiredError}
|
|
195
195
|
* @memberof InviteOrganizationsApi
|
|
196
196
|
*/
|
|
197
|
-
listOrgInvitations(requestParameters
|
|
197
|
+
listOrgInvitations(requestParameters?: InviteOrganizationsApiListOrgInvitationsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListOrgInvitationsResponseClass, any>>;
|
|
198
198
|
}
|
|
@@ -99,20 +99,18 @@ var InviteOrganizationsApiAxiosParamCreator = function (configuration) {
|
|
|
99
99
|
/**
|
|
100
100
|
* This sends an email to invite an organization.
|
|
101
101
|
* @summary Invite an organization
|
|
102
|
-
* @param {string} authorization Bearer Token: provided by the login endpoint under the name accessToken.
|
|
103
102
|
* @param {InviteOrgRequestDto} inviteOrgRequestDto
|
|
103
|
+
* @param {string} [authorization] Bearer Token
|
|
104
104
|
* @param {*} [options] Override http request option.
|
|
105
105
|
* @throws {RequiredError}
|
|
106
106
|
*/
|
|
107
|
-
inviteOrg: function (
|
|
107
|
+
inviteOrg: function (inviteOrgRequestDto, 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 'authorization' is not null or undefined
|
|
115
|
-
(0, common_1.assertParamExists)('inviteOrg', 'authorization', authorization);
|
|
116
114
|
// verify required parameter 'inviteOrgRequestDto' is not null or undefined
|
|
117
115
|
(0, common_1.assertParamExists)('inviteOrg', 'inviteOrgRequestDto', inviteOrgRequestDto);
|
|
118
116
|
localVarPath = "/tenantservice/v1/invitations/organizations";
|
|
@@ -150,7 +148,7 @@ var InviteOrganizationsApiAxiosParamCreator = function (configuration) {
|
|
|
150
148
|
/**
|
|
151
149
|
* Returns a list of org invitations you have previously created. The org invitations are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
152
150
|
* @summary List org invitations
|
|
153
|
-
* @param {string} authorization Bearer Token
|
|
151
|
+
* @param {string} [authorization] Bearer Token
|
|
154
152
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
155
153
|
* @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.
|
|
156
154
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
@@ -167,8 +165,6 @@ var InviteOrganizationsApiAxiosParamCreator = function (configuration) {
|
|
|
167
165
|
return __generator(this, function (_a) {
|
|
168
166
|
switch (_a.label) {
|
|
169
167
|
case 0:
|
|
170
|
-
// verify required parameter 'authorization' is not null or undefined
|
|
171
|
-
(0, common_1.assertParamExists)('listOrgInvitations', 'authorization', authorization);
|
|
172
168
|
localVarPath = "/tenantservice/v1/invitations/organizations";
|
|
173
169
|
localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
174
170
|
if (configuration) {
|
|
@@ -230,17 +226,17 @@ var InviteOrganizationsApiFp = function (configuration) {
|
|
|
230
226
|
/**
|
|
231
227
|
* This sends an email to invite an organization.
|
|
232
228
|
* @summary Invite an organization
|
|
233
|
-
* @param {string} authorization Bearer Token: provided by the login endpoint under the name accessToken.
|
|
234
229
|
* @param {InviteOrgRequestDto} inviteOrgRequestDto
|
|
230
|
+
* @param {string} [authorization] Bearer Token
|
|
235
231
|
* @param {*} [options] Override http request option.
|
|
236
232
|
* @throws {RequiredError}
|
|
237
233
|
*/
|
|
238
|
-
inviteOrg: function (
|
|
234
|
+
inviteOrg: function (inviteOrgRequestDto, authorization, options) {
|
|
239
235
|
return __awaiter(this, void 0, void 0, function () {
|
|
240
236
|
var localVarAxiosArgs;
|
|
241
237
|
return __generator(this, function (_a) {
|
|
242
238
|
switch (_a.label) {
|
|
243
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.inviteOrg(
|
|
239
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.inviteOrg(inviteOrgRequestDto, authorization, options)];
|
|
244
240
|
case 1:
|
|
245
241
|
localVarAxiosArgs = _a.sent();
|
|
246
242
|
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
@@ -251,7 +247,7 @@ var InviteOrganizationsApiFp = function (configuration) {
|
|
|
251
247
|
/**
|
|
252
248
|
* Returns a list of org invitations you have previously created. The org invitations are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
253
249
|
* @summary List org invitations
|
|
254
|
-
* @param {string} authorization Bearer Token
|
|
250
|
+
* @param {string} [authorization] Bearer Token
|
|
255
251
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
256
252
|
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
257
253
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
@@ -287,18 +283,18 @@ var InviteOrganizationsApiFactory = function (configuration, basePath, axios) {
|
|
|
287
283
|
/**
|
|
288
284
|
* This sends an email to invite an organization.
|
|
289
285
|
* @summary Invite an organization
|
|
290
|
-
* @param {string} authorization Bearer Token: provided by the login endpoint under the name accessToken.
|
|
291
286
|
* @param {InviteOrgRequestDto} inviteOrgRequestDto
|
|
287
|
+
* @param {string} [authorization] Bearer Token
|
|
292
288
|
* @param {*} [options] Override http request option.
|
|
293
289
|
* @throws {RequiredError}
|
|
294
290
|
*/
|
|
295
|
-
inviteOrg: function (
|
|
296
|
-
return localVarFp.inviteOrg(
|
|
291
|
+
inviteOrg: function (inviteOrgRequestDto, authorization, options) {
|
|
292
|
+
return localVarFp.inviteOrg(inviteOrgRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
297
293
|
},
|
|
298
294
|
/**
|
|
299
295
|
* Returns a list of org invitations you have previously created. The org invitations are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
300
296
|
* @summary List org invitations
|
|
301
|
-
* @param {string} authorization Bearer Token
|
|
297
|
+
* @param {string} [authorization] Bearer Token
|
|
302
298
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
303
299
|
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
304
300
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
@@ -335,7 +331,7 @@ var InviteOrganizationsApi = /** @class */ (function (_super) {
|
|
|
335
331
|
*/
|
|
336
332
|
InviteOrganizationsApi.prototype.inviteOrg = function (requestParameters, options) {
|
|
337
333
|
var _this = this;
|
|
338
|
-
return (0, exports.InviteOrganizationsApiFp)(this.configuration).inviteOrg(requestParameters.
|
|
334
|
+
return (0, exports.InviteOrganizationsApiFp)(this.configuration).inviteOrg(requestParameters.inviteOrgRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
339
335
|
};
|
|
340
336
|
/**
|
|
341
337
|
* Returns a list of org invitations you have previously created. The org invitations are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
@@ -347,6 +343,7 @@ var InviteOrganizationsApi = /** @class */ (function (_super) {
|
|
|
347
343
|
*/
|
|
348
344
|
InviteOrganizationsApi.prototype.listOrgInvitations = function (requestParameters, options) {
|
|
349
345
|
var _this = this;
|
|
346
|
+
if (requestParameters === void 0) { requestParameters = {}; }
|
|
350
347
|
return (0, exports.InviteOrganizationsApiFp)(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); });
|
|
351
348
|
};
|
|
352
349
|
return InviteOrganizationsApi;
|
|
@@ -28,43 +28,43 @@ export declare const InviteUsersApiAxiosParamCreator: (configuration?: Configura
|
|
|
28
28
|
/**
|
|
29
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
30
|
* @summary Delete the invited user
|
|
31
|
-
* @param {string} authorization Bearer Token: provided by the login endpoint under the name accessToken.
|
|
32
31
|
* @param {number} id
|
|
32
|
+
* @param {string} [authorization] Bearer Token
|
|
33
33
|
* @param {*} [options] Override http request option.
|
|
34
34
|
* @throws {RequiredError}
|
|
35
35
|
*/
|
|
36
|
-
deleteInvite: (
|
|
36
|
+
deleteInvite: (id: number, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
37
37
|
/**
|
|
38
38
|
* 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
39
|
* @summary Delete invited users.
|
|
40
|
-
* @param {string} authorization Bearer Token: provided by the login endpoint under the name accessToken.
|
|
41
40
|
* @param {BatchDeleteRequestDto} batchDeleteRequestDto
|
|
41
|
+
* @param {string} [authorization] Bearer Token
|
|
42
42
|
* @param {*} [options] Override http request option.
|
|
43
43
|
* @throws {RequiredError}
|
|
44
44
|
*/
|
|
45
|
-
deleteInvites: (
|
|
45
|
+
deleteInvites: (batchDeleteRequestDto: BatchDeleteRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
46
46
|
/**
|
|
47
47
|
* This send an email to invite a user with the specific role/roles.
|
|
48
48
|
* @summary Invite a user
|
|
49
|
-
* @param {string} authorization Bearer Token: provided by the login endpoint under the name accessToken.
|
|
50
49
|
* @param {InviteUserRequestDto} inviteUserRequestDto
|
|
50
|
+
* @param {string} [authorization] Bearer Token
|
|
51
51
|
* @param {*} [options] Override http request option.
|
|
52
52
|
* @throws {RequiredError}
|
|
53
53
|
*/
|
|
54
|
-
inviteUser: (
|
|
54
|
+
inviteUser: (inviteUserRequestDto: InviteUserRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
55
55
|
/**
|
|
56
56
|
* This send bulk emails to invite users with the specific role/roles.
|
|
57
57
|
* @summary Invite batch of users
|
|
58
|
-
* @param {string} authorization Bearer Token: provided by the login endpoint under the name accessToken.
|
|
59
58
|
* @param {InviteUsersRequestDto} inviteUsersRequestDto
|
|
59
|
+
* @param {string} [authorization] Bearer Token
|
|
60
60
|
* @param {*} [options] Override http request option.
|
|
61
61
|
* @throws {RequiredError}
|
|
62
62
|
*/
|
|
63
|
-
inviteUsers: (
|
|
63
|
+
inviteUsers: (inviteUsersRequestDto: InviteUsersRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
64
64
|
/**
|
|
65
65
|
* Returns a list of invited users you have previously created. The invited users are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
66
66
|
* @summary List invited users
|
|
67
|
-
* @param {string} authorization Bearer Token
|
|
67
|
+
* @param {string} [authorization] Bearer Token
|
|
68
68
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
69
69
|
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
70
70
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
@@ -74,7 +74,7 @@ export declare const InviteUsersApiAxiosParamCreator: (configuration?: Configura
|
|
|
74
74
|
* @param {*} [options] Override http request option.
|
|
75
75
|
* @throws {RequiredError}
|
|
76
76
|
*/
|
|
77
|
-
listInvites: (authorization
|
|
77
|
+
listInvites: (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
78
78
|
};
|
|
79
79
|
/**
|
|
80
80
|
* InviteUsersApi - functional programming interface
|
|
@@ -84,43 +84,43 @@ export declare const InviteUsersApiFp: (configuration?: Configuration) => {
|
|
|
84
84
|
/**
|
|
85
85
|
* Permanently deletes the invited user. Supply the unique id that was returned when you created the invited user and this will delete it.
|
|
86
86
|
* @summary Delete the invited user
|
|
87
|
-
* @param {string} authorization Bearer Token: provided by the login endpoint under the name accessToken.
|
|
88
87
|
* @param {number} id
|
|
88
|
+
* @param {string} [authorization] Bearer Token
|
|
89
89
|
* @param {*} [options] Override http request option.
|
|
90
90
|
* @throws {RequiredError}
|
|
91
91
|
*/
|
|
92
|
-
deleteInvite(
|
|
92
|
+
deleteInvite(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponseClass>>;
|
|
93
93
|
/**
|
|
94
94
|
* 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.
|
|
95
95
|
* @summary Delete invited users.
|
|
96
|
-
* @param {string} authorization Bearer Token: provided by the login endpoint under the name accessToken.
|
|
97
96
|
* @param {BatchDeleteRequestDto} batchDeleteRequestDto
|
|
97
|
+
* @param {string} [authorization] Bearer Token
|
|
98
98
|
* @param {*} [options] Override http request option.
|
|
99
99
|
* @throws {RequiredError}
|
|
100
100
|
*/
|
|
101
|
-
deleteInvites(
|
|
101
|
+
deleteInvites(batchDeleteRequestDto: BatchDeleteRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BatchDeleteResponseClass>>;
|
|
102
102
|
/**
|
|
103
103
|
* This send an email to invite a user with the specific role/roles.
|
|
104
104
|
* @summary Invite a user
|
|
105
|
-
* @param {string} authorization Bearer Token: provided by the login endpoint under the name accessToken.
|
|
106
105
|
* @param {InviteUserRequestDto} inviteUserRequestDto
|
|
106
|
+
* @param {string} [authorization] Bearer Token
|
|
107
107
|
* @param {*} [options] Override http request option.
|
|
108
108
|
* @throws {RequiredError}
|
|
109
109
|
*/
|
|
110
|
-
inviteUser(
|
|
110
|
+
inviteUser(inviteUserRequestDto: InviteUserRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InviteUserResponseClass>>;
|
|
111
111
|
/**
|
|
112
112
|
* This send bulk emails to invite users with the specific role/roles.
|
|
113
113
|
* @summary Invite batch of users
|
|
114
|
-
* @param {string} authorization Bearer Token: provided by the login endpoint under the name accessToken.
|
|
115
114
|
* @param {InviteUsersRequestDto} inviteUsersRequestDto
|
|
115
|
+
* @param {string} [authorization] Bearer Token
|
|
116
116
|
* @param {*} [options] Override http request option.
|
|
117
117
|
* @throws {RequiredError}
|
|
118
118
|
*/
|
|
119
|
-
inviteUsers(
|
|
119
|
+
inviteUsers(inviteUsersRequestDto: InviteUsersRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InviteUsersResponseClass>>;
|
|
120
120
|
/**
|
|
121
121
|
* Returns a list of invited users you have previously created. The invited users are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
122
122
|
* @summary List invited users
|
|
123
|
-
* @param {string} authorization Bearer Token
|
|
123
|
+
* @param {string} [authorization] Bearer Token
|
|
124
124
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
125
125
|
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
126
126
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
@@ -130,7 +130,7 @@ export declare const InviteUsersApiFp: (configuration?: Configuration) => {
|
|
|
130
130
|
* @param {*} [options] Override http request option.
|
|
131
131
|
* @throws {RequiredError}
|
|
132
132
|
*/
|
|
133
|
-
listInvites(authorization
|
|
133
|
+
listInvites(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListInvitesResponseClass>>;
|
|
134
134
|
};
|
|
135
135
|
/**
|
|
136
136
|
* InviteUsersApi - factory interface
|
|
@@ -140,43 +140,43 @@ export declare const InviteUsersApiFactory: (configuration?: Configuration, base
|
|
|
140
140
|
/**
|
|
141
141
|
* Permanently deletes the invited user. Supply the unique id that was returned when you created the invited user and this will delete it.
|
|
142
142
|
* @summary Delete the invited user
|
|
143
|
-
* @param {string} authorization Bearer Token: provided by the login endpoint under the name accessToken.
|
|
144
143
|
* @param {number} id
|
|
144
|
+
* @param {string} [authorization] Bearer Token
|
|
145
145
|
* @param {*} [options] Override http request option.
|
|
146
146
|
* @throws {RequiredError}
|
|
147
147
|
*/
|
|
148
|
-
deleteInvite(
|
|
148
|
+
deleteInvite(id: number, authorization?: string, options?: any): AxiosPromise<DeleteResponseClass>;
|
|
149
149
|
/**
|
|
150
150
|
* 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.
|
|
151
151
|
* @summary Delete invited users.
|
|
152
|
-
* @param {string} authorization Bearer Token: provided by the login endpoint under the name accessToken.
|
|
153
152
|
* @param {BatchDeleteRequestDto} batchDeleteRequestDto
|
|
153
|
+
* @param {string} [authorization] Bearer Token
|
|
154
154
|
* @param {*} [options] Override http request option.
|
|
155
155
|
* @throws {RequiredError}
|
|
156
156
|
*/
|
|
157
|
-
deleteInvites(
|
|
157
|
+
deleteInvites(batchDeleteRequestDto: BatchDeleteRequestDto, authorization?: string, options?: any): AxiosPromise<BatchDeleteResponseClass>;
|
|
158
158
|
/**
|
|
159
159
|
* This send an email to invite a user with the specific role/roles.
|
|
160
160
|
* @summary Invite a user
|
|
161
|
-
* @param {string} authorization Bearer Token: provided by the login endpoint under the name accessToken.
|
|
162
161
|
* @param {InviteUserRequestDto} inviteUserRequestDto
|
|
162
|
+
* @param {string} [authorization] Bearer Token
|
|
163
163
|
* @param {*} [options] Override http request option.
|
|
164
164
|
* @throws {RequiredError}
|
|
165
165
|
*/
|
|
166
|
-
inviteUser(
|
|
166
|
+
inviteUser(inviteUserRequestDto: InviteUserRequestDto, authorization?: string, options?: any): AxiosPromise<InviteUserResponseClass>;
|
|
167
167
|
/**
|
|
168
168
|
* This send bulk emails to invite users with the specific role/roles.
|
|
169
169
|
* @summary Invite batch of users
|
|
170
|
-
* @param {string} authorization Bearer Token: provided by the login endpoint under the name accessToken.
|
|
171
170
|
* @param {InviteUsersRequestDto} inviteUsersRequestDto
|
|
171
|
+
* @param {string} [authorization] Bearer Token
|
|
172
172
|
* @param {*} [options] Override http request option.
|
|
173
173
|
* @throws {RequiredError}
|
|
174
174
|
*/
|
|
175
|
-
inviteUsers(
|
|
175
|
+
inviteUsers(inviteUsersRequestDto: InviteUsersRequestDto, authorization?: string, options?: any): AxiosPromise<InviteUsersResponseClass>;
|
|
176
176
|
/**
|
|
177
177
|
* Returns a list of invited users you have previously created. The invited users are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
178
178
|
* @summary List invited users
|
|
179
|
-
* @param {string} authorization Bearer Token
|
|
179
|
+
* @param {string} [authorization] Bearer Token
|
|
180
180
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
181
181
|
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
182
182
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
@@ -186,7 +186,7 @@ export declare const InviteUsersApiFactory: (configuration?: Configuration, base
|
|
|
186
186
|
* @param {*} [options] Override http request option.
|
|
187
187
|
* @throws {RequiredError}
|
|
188
188
|
*/
|
|
189
|
-
listInvites(authorization
|
|
189
|
+
listInvites(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: any): AxiosPromise<ListInvitesResponseClass>;
|
|
190
190
|
};
|
|
191
191
|
/**
|
|
192
192
|
* Request parameters for deleteInvite operation in InviteUsersApi.
|
|
@@ -194,18 +194,18 @@ export declare const InviteUsersApiFactory: (configuration?: Configuration, base
|
|
|
194
194
|
* @interface InviteUsersApiDeleteInviteRequest
|
|
195
195
|
*/
|
|
196
196
|
export interface InviteUsersApiDeleteInviteRequest {
|
|
197
|
-
/**
|
|
198
|
-
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
199
|
-
* @type {string}
|
|
200
|
-
* @memberof InviteUsersApiDeleteInvite
|
|
201
|
-
*/
|
|
202
|
-
readonly authorization: string;
|
|
203
197
|
/**
|
|
204
198
|
*
|
|
205
199
|
* @type {number}
|
|
206
200
|
* @memberof InviteUsersApiDeleteInvite
|
|
207
201
|
*/
|
|
208
202
|
readonly id: number;
|
|
203
|
+
/**
|
|
204
|
+
* Bearer Token
|
|
205
|
+
* @type {string}
|
|
206
|
+
* @memberof InviteUsersApiDeleteInvite
|
|
207
|
+
*/
|
|
208
|
+
readonly authorization?: string;
|
|
209
209
|
}
|
|
210
210
|
/**
|
|
211
211
|
* Request parameters for deleteInvites operation in InviteUsersApi.
|
|
@@ -213,18 +213,18 @@ export interface InviteUsersApiDeleteInviteRequest {
|
|
|
213
213
|
* @interface InviteUsersApiDeleteInvitesRequest
|
|
214
214
|
*/
|
|
215
215
|
export interface InviteUsersApiDeleteInvitesRequest {
|
|
216
|
-
/**
|
|
217
|
-
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
218
|
-
* @type {string}
|
|
219
|
-
* @memberof InviteUsersApiDeleteInvites
|
|
220
|
-
*/
|
|
221
|
-
readonly authorization: string;
|
|
222
216
|
/**
|
|
223
217
|
*
|
|
224
218
|
* @type {BatchDeleteRequestDto}
|
|
225
219
|
* @memberof InviteUsersApiDeleteInvites
|
|
226
220
|
*/
|
|
227
221
|
readonly batchDeleteRequestDto: BatchDeleteRequestDto;
|
|
222
|
+
/**
|
|
223
|
+
* Bearer Token
|
|
224
|
+
* @type {string}
|
|
225
|
+
* @memberof InviteUsersApiDeleteInvites
|
|
226
|
+
*/
|
|
227
|
+
readonly authorization?: string;
|
|
228
228
|
}
|
|
229
229
|
/**
|
|
230
230
|
* Request parameters for inviteUser operation in InviteUsersApi.
|
|
@@ -232,18 +232,18 @@ export interface InviteUsersApiDeleteInvitesRequest {
|
|
|
232
232
|
* @interface InviteUsersApiInviteUserRequest
|
|
233
233
|
*/
|
|
234
234
|
export interface InviteUsersApiInviteUserRequest {
|
|
235
|
-
/**
|
|
236
|
-
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
237
|
-
* @type {string}
|
|
238
|
-
* @memberof InviteUsersApiInviteUser
|
|
239
|
-
*/
|
|
240
|
-
readonly authorization: string;
|
|
241
235
|
/**
|
|
242
236
|
*
|
|
243
237
|
* @type {InviteUserRequestDto}
|
|
244
238
|
* @memberof InviteUsersApiInviteUser
|
|
245
239
|
*/
|
|
246
240
|
readonly inviteUserRequestDto: InviteUserRequestDto;
|
|
241
|
+
/**
|
|
242
|
+
* Bearer Token
|
|
243
|
+
* @type {string}
|
|
244
|
+
* @memberof InviteUsersApiInviteUser
|
|
245
|
+
*/
|
|
246
|
+
readonly authorization?: string;
|
|
247
247
|
}
|
|
248
248
|
/**
|
|
249
249
|
* Request parameters for inviteUsers operation in InviteUsersApi.
|
|
@@ -251,18 +251,18 @@ export interface InviteUsersApiInviteUserRequest {
|
|
|
251
251
|
* @interface InviteUsersApiInviteUsersRequest
|
|
252
252
|
*/
|
|
253
253
|
export interface InviteUsersApiInviteUsersRequest {
|
|
254
|
-
/**
|
|
255
|
-
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
256
|
-
* @type {string}
|
|
257
|
-
* @memberof InviteUsersApiInviteUsers
|
|
258
|
-
*/
|
|
259
|
-
readonly authorization: string;
|
|
260
254
|
/**
|
|
261
255
|
*
|
|
262
256
|
* @type {InviteUsersRequestDto}
|
|
263
257
|
* @memberof InviteUsersApiInviteUsers
|
|
264
258
|
*/
|
|
265
259
|
readonly inviteUsersRequestDto: InviteUsersRequestDto;
|
|
260
|
+
/**
|
|
261
|
+
* Bearer Token
|
|
262
|
+
* @type {string}
|
|
263
|
+
* @memberof InviteUsersApiInviteUsers
|
|
264
|
+
*/
|
|
265
|
+
readonly authorization?: string;
|
|
266
266
|
}
|
|
267
267
|
/**
|
|
268
268
|
* Request parameters for listInvites operation in InviteUsersApi.
|
|
@@ -271,11 +271,11 @@ export interface InviteUsersApiInviteUsersRequest {
|
|
|
271
271
|
*/
|
|
272
272
|
export interface InviteUsersApiListInvitesRequest {
|
|
273
273
|
/**
|
|
274
|
-
* Bearer Token
|
|
274
|
+
* Bearer Token
|
|
275
275
|
* @type {string}
|
|
276
276
|
* @memberof InviteUsersApiListInvites
|
|
277
277
|
*/
|
|
278
|
-
readonly authorization
|
|
278
|
+
readonly authorization?: string;
|
|
279
279
|
/**
|
|
280
280
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
281
281
|
* @type {any}
|
|
@@ -364,5 +364,5 @@ export declare class InviteUsersApi extends BaseAPI {
|
|
|
364
364
|
* @throws {RequiredError}
|
|
365
365
|
* @memberof InviteUsersApi
|
|
366
366
|
*/
|
|
367
|
-
listInvites(requestParameters
|
|
367
|
+
listInvites(requestParameters?: InviteUsersApiListInvitesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListInvitesResponseClass, any>>;
|
|
368
368
|
}
|