@emilgroup/tenant-sdk-node 1.33.1-beta.23 → 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 -1
- package/README.md +2 -2
- package/api/dashboard-api.ts +6 -23
- package/api/invitation-controller-rest-api.ts +561 -0
- package/api/settings-api.ts +304 -0
- package/api/user-controller-rest-api.ts +1413 -0
- package/api.ts +4 -0
- package/base.ts +1 -0
- package/dist/api/dashboard-api.d.ts +3 -13
- package/dist/api/dashboard-api.js +6 -13
- package/dist/api/invitation-controller-rest-api.d.ts +315 -0
- package/dist/api/invitation-controller-rest-api.js +538 -0
- 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.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/custom-field-dto.d.ts +1 -1
- package/dist/models/get-settings-response-class.d.ts +1 -1
- package/dist/models/index.d.ts +3 -1
- package/dist/models/index.js +3 -1
- package/dist/models/set-setting-grpc-request-dto.d.ts +42 -0
- package/dist/models/set-setting-request-dto.d.ts +4 -10
- 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/custom-field-dto.ts +1 -1
- package/models/get-settings-response-class.ts +1 -1
- package/models/index.ts +3 -1
- package/models/set-setting-grpc-request-dto.ts +48 -0
- package/models/set-setting-request-dto.ts +4 -10
- package/models/set-tenant-setting-response-class.ts +42 -0
- package/models/{duplicate-dashboard-request-dto.ts → set-user-setting-response-class.ts} +14 -8
- package/models/tenant-settings-class.ts +6 -0
- package/package.json +2 -2
- package/dist/models/duplicate-dashboard-request-dto.d.ts +0 -30
- /package/dist/models/{duplicate-dashboard-request-dto.js → set-setting-grpc-request-dto.js} +0 -0
package/api.ts
CHANGED
|
@@ -31,6 +31,7 @@ import { DataReportApi } from './api';
|
|
|
31
31
|
import { DataReportExecutorApi } from './api';
|
|
32
32
|
import { DeleteOrganizationInvitationsApi } from './api';
|
|
33
33
|
import { HealthCheckApi } from './api';
|
|
34
|
+
import { InvitationControllerRestApi } from './api';
|
|
34
35
|
import { InviteOrganizationsApi } from './api';
|
|
35
36
|
import { InviteUsersApi } from './api';
|
|
36
37
|
import { ListOrganizationInvitationsApi } from './api';
|
|
@@ -39,6 +40,7 @@ import { OrganizationsApi } from './api';
|
|
|
39
40
|
import { ReInviteAnOrganizationApi } from './api';
|
|
40
41
|
import { RolesApi } from './api';
|
|
41
42
|
import { SettingsApi } from './api';
|
|
43
|
+
import { UserControllerRestApi } from './api';
|
|
42
44
|
import { UsersApi } from './api';
|
|
43
45
|
|
|
44
46
|
|
|
@@ -49,6 +51,7 @@ export * from './api/data-report-api';
|
|
|
49
51
|
export * from './api/data-report-executor-api';
|
|
50
52
|
export * from './api/delete-organization-invitations-api';
|
|
51
53
|
export * from './api/health-check-api';
|
|
54
|
+
export * from './api/invitation-controller-rest-api';
|
|
52
55
|
export * from './api/invite-organizations-api';
|
|
53
56
|
export * from './api/invite-users-api';
|
|
54
57
|
export * from './api/list-organization-invitations-api';
|
|
@@ -57,5 +60,6 @@ export * from './api/organizations-api';
|
|
|
57
60
|
export * from './api/re-invite-an-organization-api';
|
|
58
61
|
export * from './api/roles-api';
|
|
59
62
|
export * from './api/settings-api';
|
|
63
|
+
export * from './api/user-controller-rest-api';
|
|
60
64
|
export * from './api/users-api';
|
|
61
65
|
|
package/base.ts
CHANGED
|
@@ -60,6 +60,7 @@ export enum Environment {
|
|
|
60
60
|
Staging = 'https://apiv2-staging.emil.de',
|
|
61
61
|
Development = 'https://apiv2-dev.emil.de',
|
|
62
62
|
ProductionZurich = 'https://eu-central-2.apiv2.emil.de',
|
|
63
|
+
StagingZurich = 'https://eu-central-2.apiv2-staging.emil.de',
|
|
63
64
|
}
|
|
64
65
|
|
|
65
66
|
let _retry_count = 0
|
|
@@ -17,7 +17,6 @@ import { CreateDashboardResponseClass } from '../models';
|
|
|
17
17
|
import { CreateDashboardV2RequestDto } from '../models';
|
|
18
18
|
import { CreateDashboardV2ResponseClass } from '../models';
|
|
19
19
|
import { DeleteResponseClass } from '../models';
|
|
20
|
-
import { DuplicateDashboardRequestDto } from '../models';
|
|
21
20
|
import { DuplicateDashboardResponseClass } from '../models';
|
|
22
21
|
import { GetDashboardResponseClass } from '../models';
|
|
23
22
|
import { GetEmbeddedUrlResponseClass } from '../models';
|
|
@@ -63,12 +62,11 @@ export declare const DashboardApiAxiosParamCreator: (configuration?: Configurati
|
|
|
63
62
|
* Creates a copy of the specified dashboard with all its configurations and settings. **Required Permissions** \"reporting.dashboards.create\"
|
|
64
63
|
* @summary Creates a duplicate of an existing dashboard
|
|
65
64
|
* @param {string} code
|
|
66
|
-
* @param {DuplicateDashboardRequestDto} duplicateDashboardRequestDto
|
|
67
65
|
* @param {string} [authorization] Bearer Token
|
|
68
66
|
* @param {*} [options] Override http request option.
|
|
69
67
|
* @throws {RequiredError}
|
|
70
68
|
*/
|
|
71
|
-
duplicateDashboard: (code: string,
|
|
69
|
+
duplicateDashboard: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
72
70
|
/**
|
|
73
71
|
* Creates a secure embedded URL that allows dashboard analysis and editing within external applications. **Required Permissions** \"reporting.dashboards.update\"
|
|
74
72
|
* @summary Generates an embedded URL for dashboard editing
|
|
@@ -177,12 +175,11 @@ export declare const DashboardApiFp: (configuration?: Configuration) => {
|
|
|
177
175
|
* Creates a copy of the specified dashboard with all its configurations and settings. **Required Permissions** \"reporting.dashboards.create\"
|
|
178
176
|
* @summary Creates a duplicate of an existing dashboard
|
|
179
177
|
* @param {string} code
|
|
180
|
-
* @param {DuplicateDashboardRequestDto} duplicateDashboardRequestDto
|
|
181
178
|
* @param {string} [authorization] Bearer Token
|
|
182
179
|
* @param {*} [options] Override http request option.
|
|
183
180
|
* @throws {RequiredError}
|
|
184
181
|
*/
|
|
185
|
-
duplicateDashboard(code: string,
|
|
182
|
+
duplicateDashboard(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DuplicateDashboardResponseClass>>;
|
|
186
183
|
/**
|
|
187
184
|
* Creates a secure embedded URL that allows dashboard analysis and editing within external applications. **Required Permissions** \"reporting.dashboards.update\"
|
|
188
185
|
* @summary Generates an embedded URL for dashboard editing
|
|
@@ -291,12 +288,11 @@ export declare const DashboardApiFactory: (configuration?: Configuration, basePa
|
|
|
291
288
|
* Creates a copy of the specified dashboard with all its configurations and settings. **Required Permissions** \"reporting.dashboards.create\"
|
|
292
289
|
* @summary Creates a duplicate of an existing dashboard
|
|
293
290
|
* @param {string} code
|
|
294
|
-
* @param {DuplicateDashboardRequestDto} duplicateDashboardRequestDto
|
|
295
291
|
* @param {string} [authorization] Bearer Token
|
|
296
292
|
* @param {*} [options] Override http request option.
|
|
297
293
|
* @throws {RequiredError}
|
|
298
294
|
*/
|
|
299
|
-
duplicateDashboard(code: string,
|
|
295
|
+
duplicateDashboard(code: string, authorization?: string, options?: any): AxiosPromise<DuplicateDashboardResponseClass>;
|
|
300
296
|
/**
|
|
301
297
|
* Creates a secure embedded URL that allows dashboard analysis and editing within external applications. **Required Permissions** \"reporting.dashboards.update\"
|
|
302
298
|
* @summary Generates an embedded URL for dashboard editing
|
|
@@ -437,12 +433,6 @@ export interface DashboardApiDuplicateDashboardRequest {
|
|
|
437
433
|
* @memberof DashboardApiDuplicateDashboard
|
|
438
434
|
*/
|
|
439
435
|
readonly code: string;
|
|
440
|
-
/**
|
|
441
|
-
*
|
|
442
|
-
* @type {DuplicateDashboardRequestDto}
|
|
443
|
-
* @memberof DashboardApiDuplicateDashboard
|
|
444
|
-
*/
|
|
445
|
-
readonly duplicateDashboardRequestDto: DuplicateDashboardRequestDto;
|
|
446
436
|
/**
|
|
447
437
|
* Bearer Token
|
|
448
438
|
* @type {string}
|
|
@@ -247,12 +247,11 @@ var DashboardApiAxiosParamCreator = function (configuration) {
|
|
|
247
247
|
* Creates a copy of the specified dashboard with all its configurations and settings. **Required Permissions** \"reporting.dashboards.create\"
|
|
248
248
|
* @summary Creates a duplicate of an existing dashboard
|
|
249
249
|
* @param {string} code
|
|
250
|
-
* @param {DuplicateDashboardRequestDto} duplicateDashboardRequestDto
|
|
251
250
|
* @param {string} [authorization] Bearer Token
|
|
252
251
|
* @param {*} [options] Override http request option.
|
|
253
252
|
* @throws {RequiredError}
|
|
254
253
|
*/
|
|
255
|
-
duplicateDashboard: function (code,
|
|
254
|
+
duplicateDashboard: function (code, authorization, options) {
|
|
256
255
|
if (options === void 0) { options = {}; }
|
|
257
256
|
return __awaiter(_this, void 0, void 0, function () {
|
|
258
257
|
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
@@ -261,8 +260,6 @@ var DashboardApiAxiosParamCreator = function (configuration) {
|
|
|
261
260
|
case 0:
|
|
262
261
|
// verify required parameter 'code' is not null or undefined
|
|
263
262
|
(0, common_1.assertParamExists)('duplicateDashboard', 'code', code);
|
|
264
|
-
// verify required parameter 'duplicateDashboardRequestDto' is not null or undefined
|
|
265
|
-
(0, common_1.assertParamExists)('duplicateDashboard', 'duplicateDashboardRequestDto', duplicateDashboardRequestDto);
|
|
266
263
|
localVarPath = "/tenantservice/v1/dashboards/{code}/duplicate"
|
|
267
264
|
.replace("{".concat("code", "}"), encodeURIComponent(String(code)));
|
|
268
265
|
localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
@@ -283,11 +280,9 @@ var DashboardApiAxiosParamCreator = function (configuration) {
|
|
|
283
280
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
284
281
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
285
282
|
}
|
|
286
|
-
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
287
283
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
288
284
|
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
289
285
|
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
290
|
-
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(duplicateDashboardRequestDto, localVarRequestOptions, configuration);
|
|
291
286
|
return [2 /*return*/, {
|
|
292
287
|
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
293
288
|
options: localVarRequestOptions,
|
|
@@ -741,17 +736,16 @@ var DashboardApiFp = function (configuration) {
|
|
|
741
736
|
* Creates a copy of the specified dashboard with all its configurations and settings. **Required Permissions** \"reporting.dashboards.create\"
|
|
742
737
|
* @summary Creates a duplicate of an existing dashboard
|
|
743
738
|
* @param {string} code
|
|
744
|
-
* @param {DuplicateDashboardRequestDto} duplicateDashboardRequestDto
|
|
745
739
|
* @param {string} [authorization] Bearer Token
|
|
746
740
|
* @param {*} [options] Override http request option.
|
|
747
741
|
* @throws {RequiredError}
|
|
748
742
|
*/
|
|
749
|
-
duplicateDashboard: function (code,
|
|
743
|
+
duplicateDashboard: function (code, authorization, options) {
|
|
750
744
|
return __awaiter(this, void 0, void 0, function () {
|
|
751
745
|
var localVarAxiosArgs;
|
|
752
746
|
return __generator(this, function (_a) {
|
|
753
747
|
switch (_a.label) {
|
|
754
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.duplicateDashboard(code,
|
|
748
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.duplicateDashboard(code, authorization, options)];
|
|
755
749
|
case 1:
|
|
756
750
|
localVarAxiosArgs = _a.sent();
|
|
757
751
|
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
@@ -961,13 +955,12 @@ var DashboardApiFactory = function (configuration, basePath, axios) {
|
|
|
961
955
|
* Creates a copy of the specified dashboard with all its configurations and settings. **Required Permissions** \"reporting.dashboards.create\"
|
|
962
956
|
* @summary Creates a duplicate of an existing dashboard
|
|
963
957
|
* @param {string} code
|
|
964
|
-
* @param {DuplicateDashboardRequestDto} duplicateDashboardRequestDto
|
|
965
958
|
* @param {string} [authorization] Bearer Token
|
|
966
959
|
* @param {*} [options] Override http request option.
|
|
967
960
|
* @throws {RequiredError}
|
|
968
961
|
*/
|
|
969
|
-
duplicateDashboard: function (code,
|
|
970
|
-
return localVarFp.duplicateDashboard(code,
|
|
962
|
+
duplicateDashboard: function (code, authorization, options) {
|
|
963
|
+
return localVarFp.duplicateDashboard(code, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
971
964
|
},
|
|
972
965
|
/**
|
|
973
966
|
* Creates a secure embedded URL that allows dashboard analysis and editing within external applications. **Required Permissions** \"reporting.dashboards.update\"
|
|
@@ -1114,7 +1107,7 @@ var DashboardApi = /** @class */ (function (_super) {
|
|
|
1114
1107
|
*/
|
|
1115
1108
|
DashboardApi.prototype.duplicateDashboard = function (requestParameters, options) {
|
|
1116
1109
|
var _this = this;
|
|
1117
|
-
return (0, exports.DashboardApiFp)(this.configuration).duplicateDashboard(requestParameters.code, requestParameters.
|
|
1110
|
+
return (0, exports.DashboardApiFp)(this.configuration).duplicateDashboard(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
1118
1111
|
};
|
|
1119
1112
|
/**
|
|
1120
1113
|
* Creates a secure embedded URL that allows dashboard analysis and editing within external applications. **Required Permissions** \"reporting.dashboards.update\"
|
|
@@ -0,0 +1,315 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* EMIL Tenant Service
|
|
3
|
+
* The EMIL TenantService API description
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0
|
|
6
|
+
* Contact: kontakt@emil.de
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
13
|
+
import { Configuration } from '../configuration';
|
|
14
|
+
import { RequestArgs, BaseAPI } from '../base';
|
|
15
|
+
import { DeleteResponseClass } from '../models';
|
|
16
|
+
import { InviteOrgRequestDtoRest } from '../models';
|
|
17
|
+
import { ListOrgInvitationsResponseClass } from '../models';
|
|
18
|
+
import { OrgInvitationResponseClass } from '../models';
|
|
19
|
+
import { ReInviteOrgRequestDto } from '../models';
|
|
20
|
+
/**
|
|
21
|
+
* InvitationControllerRestApi - axios parameter creator
|
|
22
|
+
* @export
|
|
23
|
+
*/
|
|
24
|
+
export declare const InvitationControllerRestApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
25
|
+
/**
|
|
26
|
+
* 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\"
|
|
27
|
+
* @summary Delete the organization invitation
|
|
28
|
+
* @param {number} id
|
|
29
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
30
|
+
* @param {*} [options] Override http request option.
|
|
31
|
+
* @throws {RequiredError}
|
|
32
|
+
*/
|
|
33
|
+
deleteOrgInvitation: (id: number, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
34
|
+
/**
|
|
35
|
+
* This sends an email to invite an organization. **Required Permissions** \"tenant-management.organizations.create\"
|
|
36
|
+
* @summary Invite an organization
|
|
37
|
+
* @param {InviteOrgRequestDtoRest} inviteOrgRequestDtoRest
|
|
38
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
39
|
+
* @param {*} [options] Override http request option.
|
|
40
|
+
* @throws {RequiredError}
|
|
41
|
+
*/
|
|
42
|
+
inviteOrg: (inviteOrgRequestDtoRest: InviteOrgRequestDtoRest, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
43
|
+
/**
|
|
44
|
+
* 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\"
|
|
45
|
+
* @summary List organization invitations
|
|
46
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
47
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
48
|
+
* @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.
|
|
49
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
50
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
51
|
+
* @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.
|
|
52
|
+
* @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.
|
|
53
|
+
* @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.
|
|
54
|
+
* @param {*} [options] Override http request option.
|
|
55
|
+
* @throws {RequiredError}
|
|
56
|
+
*/
|
|
57
|
+
listOrgInvitations: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
58
|
+
/**
|
|
59
|
+
* This re-sends an email to invite an organization. **Required Permissions** \"tenant-management.organizations.create\"
|
|
60
|
+
* @param {ReInviteOrgRequestDto} reInviteOrgRequestDto
|
|
61
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
62
|
+
* @param {*} [options] Override http request option.
|
|
63
|
+
* @throws {RequiredError}
|
|
64
|
+
*/
|
|
65
|
+
reInviteOrganization: (reInviteOrgRequestDto: ReInviteOrgRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
66
|
+
};
|
|
67
|
+
/**
|
|
68
|
+
* InvitationControllerRestApi - functional programming interface
|
|
69
|
+
* @export
|
|
70
|
+
*/
|
|
71
|
+
export declare const InvitationControllerRestApiFp: (configuration?: Configuration) => {
|
|
72
|
+
/**
|
|
73
|
+
* 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\"
|
|
74
|
+
* @summary Delete the organization invitation
|
|
75
|
+
* @param {number} id
|
|
76
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
77
|
+
* @param {*} [options] Override http request option.
|
|
78
|
+
* @throws {RequiredError}
|
|
79
|
+
*/
|
|
80
|
+
deleteOrgInvitation(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponseClass>>;
|
|
81
|
+
/**
|
|
82
|
+
* This sends an email to invite an organization. **Required Permissions** \"tenant-management.organizations.create\"
|
|
83
|
+
* @summary Invite an organization
|
|
84
|
+
* @param {InviteOrgRequestDtoRest} inviteOrgRequestDtoRest
|
|
85
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
86
|
+
* @param {*} [options] Override http request option.
|
|
87
|
+
* @throws {RequiredError}
|
|
88
|
+
*/
|
|
89
|
+
inviteOrg(inviteOrgRequestDtoRest: InviteOrgRequestDtoRest, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrgInvitationResponseClass>>;
|
|
90
|
+
/**
|
|
91
|
+
* 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\"
|
|
92
|
+
* @summary List organization invitations
|
|
93
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
94
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
95
|
+
* @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.
|
|
96
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
97
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
98
|
+
* @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.
|
|
99
|
+
* @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.
|
|
100
|
+
* @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.
|
|
101
|
+
* @param {*} [options] Override http request option.
|
|
102
|
+
* @throws {RequiredError}
|
|
103
|
+
*/
|
|
104
|
+
listOrgInvitations(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListOrgInvitationsResponseClass>>;
|
|
105
|
+
/**
|
|
106
|
+
* This re-sends an email to invite an organization. **Required Permissions** \"tenant-management.organizations.create\"
|
|
107
|
+
* @param {ReInviteOrgRequestDto} reInviteOrgRequestDto
|
|
108
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
109
|
+
* @param {*} [options] Override http request option.
|
|
110
|
+
* @throws {RequiredError}
|
|
111
|
+
*/
|
|
112
|
+
reInviteOrganization(reInviteOrgRequestDto: ReInviteOrgRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrgInvitationResponseClass>>;
|
|
113
|
+
};
|
|
114
|
+
/**
|
|
115
|
+
* InvitationControllerRestApi - factory interface
|
|
116
|
+
* @export
|
|
117
|
+
*/
|
|
118
|
+
export declare const InvitationControllerRestApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
119
|
+
/**
|
|
120
|
+
* 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\"
|
|
121
|
+
* @summary Delete the organization invitation
|
|
122
|
+
* @param {number} id
|
|
123
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
124
|
+
* @param {*} [options] Override http request option.
|
|
125
|
+
* @throws {RequiredError}
|
|
126
|
+
*/
|
|
127
|
+
deleteOrgInvitation(id: number, authorization?: string, options?: any): AxiosPromise<DeleteResponseClass>;
|
|
128
|
+
/**
|
|
129
|
+
* This sends an email to invite an organization. **Required Permissions** \"tenant-management.organizations.create\"
|
|
130
|
+
* @summary Invite an organization
|
|
131
|
+
* @param {InviteOrgRequestDtoRest} inviteOrgRequestDtoRest
|
|
132
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
133
|
+
* @param {*} [options] Override http request option.
|
|
134
|
+
* @throws {RequiredError}
|
|
135
|
+
*/
|
|
136
|
+
inviteOrg(inviteOrgRequestDtoRest: InviteOrgRequestDtoRest, authorization?: string, options?: any): AxiosPromise<OrgInvitationResponseClass>;
|
|
137
|
+
/**
|
|
138
|
+
* 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\"
|
|
139
|
+
* @summary List organization invitations
|
|
140
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
141
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
142
|
+
* @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.
|
|
143
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
144
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
145
|
+
* @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.
|
|
146
|
+
* @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.
|
|
147
|
+
* @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.
|
|
148
|
+
* @param {*} [options] Override http request option.
|
|
149
|
+
* @throws {RequiredError}
|
|
150
|
+
*/
|
|
151
|
+
listOrgInvitations(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListOrgInvitationsResponseClass>;
|
|
152
|
+
/**
|
|
153
|
+
* This re-sends an email to invite an organization. **Required Permissions** \"tenant-management.organizations.create\"
|
|
154
|
+
* @param {ReInviteOrgRequestDto} reInviteOrgRequestDto
|
|
155
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
156
|
+
* @param {*} [options] Override http request option.
|
|
157
|
+
* @throws {RequiredError}
|
|
158
|
+
*/
|
|
159
|
+
reInviteOrganization(reInviteOrgRequestDto: ReInviteOrgRequestDto, authorization?: string, options?: any): AxiosPromise<OrgInvitationResponseClass>;
|
|
160
|
+
};
|
|
161
|
+
/**
|
|
162
|
+
* Request parameters for deleteOrgInvitation operation in InvitationControllerRestApi.
|
|
163
|
+
* @export
|
|
164
|
+
* @interface InvitationControllerRestApiDeleteOrgInvitationRequest
|
|
165
|
+
*/
|
|
166
|
+
export interface InvitationControllerRestApiDeleteOrgInvitationRequest {
|
|
167
|
+
/**
|
|
168
|
+
*
|
|
169
|
+
* @type {number}
|
|
170
|
+
* @memberof InvitationControllerRestApiDeleteOrgInvitation
|
|
171
|
+
*/
|
|
172
|
+
readonly id: number;
|
|
173
|
+
/**
|
|
174
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
175
|
+
* @type {string}
|
|
176
|
+
* @memberof InvitationControllerRestApiDeleteOrgInvitation
|
|
177
|
+
*/
|
|
178
|
+
readonly authorization?: string;
|
|
179
|
+
}
|
|
180
|
+
/**
|
|
181
|
+
* Request parameters for inviteOrg operation in InvitationControllerRestApi.
|
|
182
|
+
* @export
|
|
183
|
+
* @interface InvitationControllerRestApiInviteOrgRequest
|
|
184
|
+
*/
|
|
185
|
+
export interface InvitationControllerRestApiInviteOrgRequest {
|
|
186
|
+
/**
|
|
187
|
+
*
|
|
188
|
+
* @type {InviteOrgRequestDtoRest}
|
|
189
|
+
* @memberof InvitationControllerRestApiInviteOrg
|
|
190
|
+
*/
|
|
191
|
+
readonly inviteOrgRequestDtoRest: InviteOrgRequestDtoRest;
|
|
192
|
+
/**
|
|
193
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
194
|
+
* @type {string}
|
|
195
|
+
* @memberof InvitationControllerRestApiInviteOrg
|
|
196
|
+
*/
|
|
197
|
+
readonly authorization?: string;
|
|
198
|
+
}
|
|
199
|
+
/**
|
|
200
|
+
* Request parameters for listOrgInvitations operation in InvitationControllerRestApi.
|
|
201
|
+
* @export
|
|
202
|
+
* @interface InvitationControllerRestApiListOrgInvitationsRequest
|
|
203
|
+
*/
|
|
204
|
+
export interface InvitationControllerRestApiListOrgInvitationsRequest {
|
|
205
|
+
/**
|
|
206
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
207
|
+
* @type {string}
|
|
208
|
+
* @memberof InvitationControllerRestApiListOrgInvitations
|
|
209
|
+
*/
|
|
210
|
+
readonly authorization?: string;
|
|
211
|
+
/**
|
|
212
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
213
|
+
* @type {number}
|
|
214
|
+
* @memberof InvitationControllerRestApiListOrgInvitations
|
|
215
|
+
*/
|
|
216
|
+
readonly pageSize?: number;
|
|
217
|
+
/**
|
|
218
|
+
* 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.
|
|
219
|
+
* @type {string}
|
|
220
|
+
* @memberof InvitationControllerRestApiListOrgInvitations
|
|
221
|
+
*/
|
|
222
|
+
readonly pageToken?: string;
|
|
223
|
+
/**
|
|
224
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
225
|
+
* @type {string}
|
|
226
|
+
* @memberof InvitationControllerRestApiListOrgInvitations
|
|
227
|
+
*/
|
|
228
|
+
readonly filter?: string;
|
|
229
|
+
/**
|
|
230
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
231
|
+
* @type {string}
|
|
232
|
+
* @memberof InvitationControllerRestApiListOrgInvitations
|
|
233
|
+
*/
|
|
234
|
+
readonly search?: string;
|
|
235
|
+
/**
|
|
236
|
+
* 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.
|
|
237
|
+
* @type {string}
|
|
238
|
+
* @memberof InvitationControllerRestApiListOrgInvitations
|
|
239
|
+
*/
|
|
240
|
+
readonly order?: string;
|
|
241
|
+
/**
|
|
242
|
+
* 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.
|
|
243
|
+
* @type {string}
|
|
244
|
+
* @memberof InvitationControllerRestApiListOrgInvitations
|
|
245
|
+
*/
|
|
246
|
+
readonly expand?: string;
|
|
247
|
+
/**
|
|
248
|
+
* 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.
|
|
249
|
+
* @type {string}
|
|
250
|
+
* @memberof InvitationControllerRestApiListOrgInvitations
|
|
251
|
+
*/
|
|
252
|
+
readonly filters?: string;
|
|
253
|
+
}
|
|
254
|
+
/**
|
|
255
|
+
* Request parameters for reInviteOrganization operation in InvitationControllerRestApi.
|
|
256
|
+
* @export
|
|
257
|
+
* @interface InvitationControllerRestApiReInviteOrganizationRequest
|
|
258
|
+
*/
|
|
259
|
+
export interface InvitationControllerRestApiReInviteOrganizationRequest {
|
|
260
|
+
/**
|
|
261
|
+
*
|
|
262
|
+
* @type {ReInviteOrgRequestDto}
|
|
263
|
+
* @memberof InvitationControllerRestApiReInviteOrganization
|
|
264
|
+
*/
|
|
265
|
+
readonly reInviteOrgRequestDto: ReInviteOrgRequestDto;
|
|
266
|
+
/**
|
|
267
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
268
|
+
* @type {string}
|
|
269
|
+
* @memberof InvitationControllerRestApiReInviteOrganization
|
|
270
|
+
*/
|
|
271
|
+
readonly authorization?: string;
|
|
272
|
+
}
|
|
273
|
+
/**
|
|
274
|
+
* InvitationControllerRestApi - object-oriented interface
|
|
275
|
+
* @export
|
|
276
|
+
* @class InvitationControllerRestApi
|
|
277
|
+
* @extends {BaseAPI}
|
|
278
|
+
*/
|
|
279
|
+
export declare class InvitationControllerRestApi extends BaseAPI {
|
|
280
|
+
/**
|
|
281
|
+
* 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\"
|
|
282
|
+
* @summary Delete the organization invitation
|
|
283
|
+
* @param {InvitationControllerRestApiDeleteOrgInvitationRequest} requestParameters Request parameters.
|
|
284
|
+
* @param {*} [options] Override http request option.
|
|
285
|
+
* @throws {RequiredError}
|
|
286
|
+
* @memberof InvitationControllerRestApi
|
|
287
|
+
*/
|
|
288
|
+
deleteOrgInvitation(requestParameters: InvitationControllerRestApiDeleteOrgInvitationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteResponseClass, any, {}>>;
|
|
289
|
+
/**
|
|
290
|
+
* This sends an email to invite an organization. **Required Permissions** \"tenant-management.organizations.create\"
|
|
291
|
+
* @summary Invite an organization
|
|
292
|
+
* @param {InvitationControllerRestApiInviteOrgRequest} requestParameters Request parameters.
|
|
293
|
+
* @param {*} [options] Override http request option.
|
|
294
|
+
* @throws {RequiredError}
|
|
295
|
+
* @memberof InvitationControllerRestApi
|
|
296
|
+
*/
|
|
297
|
+
inviteOrg(requestParameters: InvitationControllerRestApiInviteOrgRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OrgInvitationResponseClass, any, {}>>;
|
|
298
|
+
/**
|
|
299
|
+
* 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\"
|
|
300
|
+
* @summary List organization invitations
|
|
301
|
+
* @param {InvitationControllerRestApiListOrgInvitationsRequest} requestParameters Request parameters.
|
|
302
|
+
* @param {*} [options] Override http request option.
|
|
303
|
+
* @throws {RequiredError}
|
|
304
|
+
* @memberof InvitationControllerRestApi
|
|
305
|
+
*/
|
|
306
|
+
listOrgInvitations(requestParameters?: InvitationControllerRestApiListOrgInvitationsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListOrgInvitationsResponseClass, any, {}>>;
|
|
307
|
+
/**
|
|
308
|
+
* This re-sends an email to invite an organization. **Required Permissions** \"tenant-management.organizations.create\"
|
|
309
|
+
* @param {InvitationControllerRestApiReInviteOrganizationRequest} requestParameters Request parameters.
|
|
310
|
+
* @param {*} [options] Override http request option.
|
|
311
|
+
* @throws {RequiredError}
|
|
312
|
+
* @memberof InvitationControllerRestApi
|
|
313
|
+
*/
|
|
314
|
+
reInviteOrganization(requestParameters: InvitationControllerRestApiReInviteOrganizationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OrgInvitationResponseClass, any, {}>>;
|
|
315
|
+
}
|