@emilgroup/tenant-sdk 1.31.0 → 1.31.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 +8 -0
- package/README.md +2 -2
- package/api/organization-migration-api.ts +574 -0
- package/api/users-api.ts +4 -4
- package/api.ts +2 -0
- package/base.ts +45 -1
- package/dist/api/organization-migration-api.d.ts +329 -0
- package/dist/api/organization-migration-api.js +542 -0
- package/dist/api/users-api.d.ts +4 -4
- package/dist/api/users-api.js +3 -3
- package/dist/api.d.ts +1 -0
- package/dist/api.js +1 -0
- package/dist/base.d.ts +10 -1
- package/dist/base.js +41 -1
- package/dist/models/create-organization-migration-request-dto.d.ts +42 -0
- package/dist/models/create-organization-migration-request-dto.js +15 -0
- package/dist/models/create-organization-migration-response-class.d.ts +25 -0
- package/dist/models/create-organization-migration-response-class.js +15 -0
- package/dist/models/get-organization-migration-response-class.d.ts +25 -0
- package/dist/models/get-organization-migration-response-class.js +15 -0
- package/dist/models/index.d.ts +7 -0
- package/dist/models/index.js +7 -0
- package/dist/models/link-user-with-partner-request-dto-rest.d.ts +6 -0
- package/dist/models/list-organization-migrations-response-class.d.ts +43 -0
- package/dist/models/list-organization-migrations-response-class.js +15 -0
- package/dist/models/organization-migration-class.d.ts +81 -0
- package/dist/models/organization-migration-class.js +24 -0
- package/dist/models/revert-organization-migration-request-dto.d.ts +30 -0
- package/dist/models/revert-organization-migration-request-dto.js +15 -0
- package/dist/models/revert-organization-migration-response-class.d.ts +25 -0
- package/dist/models/revert-organization-migration-response-class.js +15 -0
- package/models/create-organization-migration-request-dto.ts +48 -0
- package/models/create-organization-migration-response-class.ts +31 -0
- package/models/get-organization-migration-response-class.ts +31 -0
- package/models/index.ts +7 -0
- package/models/link-user-with-partner-request-dto-rest.ts +6 -0
- package/models/list-organization-migrations-response-class.ts +49 -0
- package/models/organization-migration-class.ts +90 -0
- package/models/revert-organization-migration-request-dto.ts +36 -0
- package/models/revert-organization-migration-response-class.ts +31 -0
- package/package.json +1 -1
package/api/users-api.ts
CHANGED
|
@@ -346,7 +346,7 @@ export const UsersApiAxiosParamCreator = function (configuration?: Configuration
|
|
|
346
346
|
* @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.
|
|
347
347
|
* @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, code, email, sub, status, organizationId, ern, partnerCode</i>
|
|
348
348
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
349
|
-
* @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</i>
|
|
349
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, email</i>
|
|
350
350
|
* @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: subscriptions, organizations<i>
|
|
351
351
|
* @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, code, email, sub, status, organizationId, ern, partnerCode</i>
|
|
352
352
|
* @param {*} [options] Override http request option.
|
|
@@ -502,7 +502,7 @@ export const UsersApiFp = function(configuration?: Configuration) {
|
|
|
502
502
|
* @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.
|
|
503
503
|
* @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, code, email, sub, status, organizationId, ern, partnerCode</i>
|
|
504
504
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
505
|
-
* @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</i>
|
|
505
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, email</i>
|
|
506
506
|
* @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: subscriptions, organizations<i>
|
|
507
507
|
* @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, code, email, sub, status, organizationId, ern, partnerCode</i>
|
|
508
508
|
* @param {*} [options] Override http request option.
|
|
@@ -594,7 +594,7 @@ export const UsersApiFactory = function (configuration?: Configuration, basePath
|
|
|
594
594
|
* @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.
|
|
595
595
|
* @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, code, email, sub, status, organizationId, ern, partnerCode</i>
|
|
596
596
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
597
|
-
* @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</i>
|
|
597
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, email</i>
|
|
598
598
|
* @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: subscriptions, organizations<i>
|
|
599
599
|
* @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, code, email, sub, status, organizationId, ern, partnerCode</i>
|
|
600
600
|
* @param {*} [options] Override http request option.
|
|
@@ -795,7 +795,7 @@ export interface UsersApiListUsersRequest {
|
|
|
795
795
|
readonly search?: string
|
|
796
796
|
|
|
797
797
|
/**
|
|
798
|
-
* 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</i>
|
|
798
|
+
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, email</i>
|
|
799
799
|
* @type {string}
|
|
800
800
|
* @memberof UsersApiListUsers
|
|
801
801
|
*/
|
package/api.ts
CHANGED
|
@@ -30,6 +30,7 @@ import { HealthCheckApi } from './api';
|
|
|
30
30
|
import { InviteOrganizationsApi } from './api';
|
|
31
31
|
import { InviteUsersApi } from './api';
|
|
32
32
|
import { ListOrganizationInvitationsApi } from './api';
|
|
33
|
+
import { OrganizationMigrationApi } from './api';
|
|
33
34
|
import { OrganizationsApi } from './api';
|
|
34
35
|
import { ReInviteAnOrganizationApi } from './api';
|
|
35
36
|
import { RolesApi } from './api';
|
|
@@ -47,6 +48,7 @@ export * from './api/health-check-api';
|
|
|
47
48
|
export * from './api/invite-organizations-api';
|
|
48
49
|
export * from './api/invite-users-api';
|
|
49
50
|
export * from './api/list-organization-invitations-api';
|
|
51
|
+
export * from './api/organization-migration-api';
|
|
50
52
|
export * from './api/organizations-api';
|
|
51
53
|
export * from './api/re-invite-an-organization-api';
|
|
52
54
|
export * from './api/roles-api';
|
package/base.ts
CHANGED
|
@@ -37,6 +37,16 @@ export interface LoginClass {
|
|
|
37
37
|
permissions: string;
|
|
38
38
|
}
|
|
39
39
|
|
|
40
|
+
export interface SwitchWorkspaceRequest {
|
|
41
|
+
username: string;
|
|
42
|
+
targetWorkspace: string;
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
export interface SwitchWorkspaceResponseClass {
|
|
46
|
+
accessToken: string;
|
|
47
|
+
permissions: string;
|
|
48
|
+
}
|
|
49
|
+
|
|
40
50
|
export enum Environment {
|
|
41
51
|
Production = 'https://apiv2.emil.de',
|
|
42
52
|
Test = 'https://apiv2-test.emil.de',
|
|
@@ -119,7 +129,7 @@ export class BaseAPI {
|
|
|
119
129
|
return this.tokenData.permissions.split(',');
|
|
120
130
|
}
|
|
121
131
|
|
|
122
|
-
async authorize(username: string, password: string): Promise<void> {
|
|
132
|
+
async authorize(username: string, password: string, targetWorkspace?: string): Promise<void> {
|
|
123
133
|
const options: AxiosRequestConfig = {
|
|
124
134
|
method: 'POST',
|
|
125
135
|
url: `${this.configuration.basePath}/authservice/v1/login`,
|
|
@@ -141,6 +151,40 @@ export class BaseAPI {
|
|
|
141
151
|
this.tokenData.accessToken = accessToken;
|
|
142
152
|
this.tokenData.permissions = permissions;
|
|
143
153
|
|
|
154
|
+
// Switch workspace if provided
|
|
155
|
+
if (targetWorkspace) {
|
|
156
|
+
await this.switchWorkspace(targetWorkspace);
|
|
157
|
+
} else {
|
|
158
|
+
// Only store if no workspace switch (since switchWorkspace will store after switching)
|
|
159
|
+
this.storeTokenData({
|
|
160
|
+
...this.tokenData
|
|
161
|
+
});
|
|
162
|
+
}
|
|
163
|
+
}
|
|
164
|
+
|
|
165
|
+
async switchWorkspace(targetWorkspace: string): Promise<void> {
|
|
166
|
+
const options: AxiosRequestConfig = {
|
|
167
|
+
method: 'POST',
|
|
168
|
+
url: `${this.configuration.basePath}/authservice/v1/workspaces/switch`,
|
|
169
|
+
headers: {
|
|
170
|
+
'Content-Type': 'application/json',
|
|
171
|
+
'Authorization': `Bearer ${this.configuration.accessToken}`,
|
|
172
|
+
},
|
|
173
|
+
data: {
|
|
174
|
+
username: this.configuration.username,
|
|
175
|
+
targetWorkspace,
|
|
176
|
+
} as SwitchWorkspaceRequest,
|
|
177
|
+
withCredentials: true,
|
|
178
|
+
};
|
|
179
|
+
|
|
180
|
+
const response = await globalAxios.request<SwitchWorkspaceResponseClass>(options);
|
|
181
|
+
|
|
182
|
+
const { data: { accessToken, permissions } } = response;
|
|
183
|
+
|
|
184
|
+
this.configuration.accessToken = `Bearer ${accessToken}`;
|
|
185
|
+
this.tokenData.accessToken = accessToken;
|
|
186
|
+
this.tokenData.permissions = permissions;
|
|
187
|
+
|
|
144
188
|
this.storeTokenData({
|
|
145
189
|
...this.tokenData
|
|
146
190
|
});
|
|
@@ -0,0 +1,329 @@
|
|
|
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 { CreateOrganizationMigrationRequestDto } from '../models';
|
|
16
|
+
import { CreateOrganizationMigrationResponseClass } from '../models';
|
|
17
|
+
import { GetOrganizationMigrationResponseClass } from '../models';
|
|
18
|
+
import { ListOrganizationMigrationsResponseClass } from '../models';
|
|
19
|
+
import { RevertOrganizationMigrationRequestDto } from '../models';
|
|
20
|
+
import { RevertOrganizationMigrationResponseClass } from '../models';
|
|
21
|
+
/**
|
|
22
|
+
* OrganizationMigrationApi - axios parameter creator
|
|
23
|
+
* @export
|
|
24
|
+
*/
|
|
25
|
+
export declare const OrganizationMigrationApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
26
|
+
/**
|
|
27
|
+
* Creates a new organization migration. **Required Permissions** \"tenant-management.organizations.create\"
|
|
28
|
+
* @summary Create organization migration
|
|
29
|
+
* @param {CreateOrganizationMigrationRequestDto} createOrganizationMigrationRequestDto
|
|
30
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
31
|
+
* @param {*} [options] Override http request option.
|
|
32
|
+
* @throws {RequiredError}
|
|
33
|
+
*/
|
|
34
|
+
createOrganizationMigration: (createOrganizationMigrationRequestDto: CreateOrganizationMigrationRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
35
|
+
/**
|
|
36
|
+
* Retrieves an organization migration by its code. **Required Permissions** \"tenant-management.organizations.view\"
|
|
37
|
+
* @summary Get organization migration
|
|
38
|
+
* @param {any} code Unique identifier for the object.
|
|
39
|
+
* @param {string} [expand] Fields to expand response by
|
|
40
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
41
|
+
* @param {*} [options] Override http request option.
|
|
42
|
+
* @throws {RequiredError}
|
|
43
|
+
*/
|
|
44
|
+
getOrganizationMigration: (code: any, expand?: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
45
|
+
/**
|
|
46
|
+
* Retrieves a list of organization migrations **Required Permissions** \"tenant-management.organizations.view\"
|
|
47
|
+
* @summary List organization migrations
|
|
48
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
49
|
+
* @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.
|
|
50
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
51
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
52
|
+
* @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.
|
|
53
|
+
* @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.
|
|
54
|
+
* @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.
|
|
55
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
56
|
+
* @param {*} [options] Override http request option.
|
|
57
|
+
* @throws {RequiredError}
|
|
58
|
+
*/
|
|
59
|
+
listOrganizationMigrations: (pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
60
|
+
/**
|
|
61
|
+
* Reverts an organization migration. **Required Permissions** \"tenant-management.organizations.update\"
|
|
62
|
+
* @summary Revert organization migration
|
|
63
|
+
* @param {RevertOrganizationMigrationRequestDto} revertOrganizationMigrationRequestDto
|
|
64
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
65
|
+
* @param {*} [options] Override http request option.
|
|
66
|
+
* @throws {RequiredError}
|
|
67
|
+
*/
|
|
68
|
+
revertOrganizationMigration: (revertOrganizationMigrationRequestDto: RevertOrganizationMigrationRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
69
|
+
};
|
|
70
|
+
/**
|
|
71
|
+
* OrganizationMigrationApi - functional programming interface
|
|
72
|
+
* @export
|
|
73
|
+
*/
|
|
74
|
+
export declare const OrganizationMigrationApiFp: (configuration?: Configuration) => {
|
|
75
|
+
/**
|
|
76
|
+
* Creates a new organization migration. **Required Permissions** \"tenant-management.organizations.create\"
|
|
77
|
+
* @summary Create organization migration
|
|
78
|
+
* @param {CreateOrganizationMigrationRequestDto} createOrganizationMigrationRequestDto
|
|
79
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
80
|
+
* @param {*} [options] Override http request option.
|
|
81
|
+
* @throws {RequiredError}
|
|
82
|
+
*/
|
|
83
|
+
createOrganizationMigration(createOrganizationMigrationRequestDto: CreateOrganizationMigrationRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateOrganizationMigrationResponseClass>>;
|
|
84
|
+
/**
|
|
85
|
+
* Retrieves an organization migration by its code. **Required Permissions** \"tenant-management.organizations.view\"
|
|
86
|
+
* @summary Get organization migration
|
|
87
|
+
* @param {any} code Unique identifier for the object.
|
|
88
|
+
* @param {string} [expand] Fields to expand response by
|
|
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
|
+
getOrganizationMigration(code: any, expand?: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrganizationMigrationResponseClass>>;
|
|
94
|
+
/**
|
|
95
|
+
* Retrieves a list of organization migrations **Required Permissions** \"tenant-management.organizations.view\"
|
|
96
|
+
* @summary List organization migrations
|
|
97
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
98
|
+
* @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.
|
|
99
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
100
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
101
|
+
* @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.
|
|
102
|
+
* @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.
|
|
103
|
+
* @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.
|
|
104
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
105
|
+
* @param {*} [options] Override http request option.
|
|
106
|
+
* @throws {RequiredError}
|
|
107
|
+
*/
|
|
108
|
+
listOrganizationMigrations(pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListOrganizationMigrationsResponseClass>>;
|
|
109
|
+
/**
|
|
110
|
+
* Reverts an organization migration. **Required Permissions** \"tenant-management.organizations.update\"
|
|
111
|
+
* @summary Revert organization migration
|
|
112
|
+
* @param {RevertOrganizationMigrationRequestDto} revertOrganizationMigrationRequestDto
|
|
113
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
114
|
+
* @param {*} [options] Override http request option.
|
|
115
|
+
* @throws {RequiredError}
|
|
116
|
+
*/
|
|
117
|
+
revertOrganizationMigration(revertOrganizationMigrationRequestDto: RevertOrganizationMigrationRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RevertOrganizationMigrationResponseClass>>;
|
|
118
|
+
};
|
|
119
|
+
/**
|
|
120
|
+
* OrganizationMigrationApi - factory interface
|
|
121
|
+
* @export
|
|
122
|
+
*/
|
|
123
|
+
export declare const OrganizationMigrationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
124
|
+
/**
|
|
125
|
+
* Creates a new organization migration. **Required Permissions** \"tenant-management.organizations.create\"
|
|
126
|
+
* @summary Create organization migration
|
|
127
|
+
* @param {CreateOrganizationMigrationRequestDto} createOrganizationMigrationRequestDto
|
|
128
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
129
|
+
* @param {*} [options] Override http request option.
|
|
130
|
+
* @throws {RequiredError}
|
|
131
|
+
*/
|
|
132
|
+
createOrganizationMigration(createOrganizationMigrationRequestDto: CreateOrganizationMigrationRequestDto, authorization?: string, options?: any): AxiosPromise<CreateOrganizationMigrationResponseClass>;
|
|
133
|
+
/**
|
|
134
|
+
* Retrieves an organization migration by its code. **Required Permissions** \"tenant-management.organizations.view\"
|
|
135
|
+
* @summary Get organization migration
|
|
136
|
+
* @param {any} code Unique identifier for the object.
|
|
137
|
+
* @param {string} [expand] Fields to expand response by
|
|
138
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
139
|
+
* @param {*} [options] Override http request option.
|
|
140
|
+
* @throws {RequiredError}
|
|
141
|
+
*/
|
|
142
|
+
getOrganizationMigration(code: any, expand?: string, authorization?: string, options?: any): AxiosPromise<GetOrganizationMigrationResponseClass>;
|
|
143
|
+
/**
|
|
144
|
+
* Retrieves a list of organization migrations **Required Permissions** \"tenant-management.organizations.view\"
|
|
145
|
+
* @summary List organization migrations
|
|
146
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
147
|
+
* @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.
|
|
148
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
149
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
150
|
+
* @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.
|
|
151
|
+
* @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.
|
|
152
|
+
* @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.
|
|
153
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
154
|
+
* @param {*} [options] Override http request option.
|
|
155
|
+
* @throws {RequiredError}
|
|
156
|
+
*/
|
|
157
|
+
listOrganizationMigrations(pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, authorization?: string, options?: any): AxiosPromise<ListOrganizationMigrationsResponseClass>;
|
|
158
|
+
/**
|
|
159
|
+
* Reverts an organization migration. **Required Permissions** \"tenant-management.organizations.update\"
|
|
160
|
+
* @summary Revert organization migration
|
|
161
|
+
* @param {RevertOrganizationMigrationRequestDto} revertOrganizationMigrationRequestDto
|
|
162
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
163
|
+
* @param {*} [options] Override http request option.
|
|
164
|
+
* @throws {RequiredError}
|
|
165
|
+
*/
|
|
166
|
+
revertOrganizationMigration(revertOrganizationMigrationRequestDto: RevertOrganizationMigrationRequestDto, authorization?: string, options?: any): AxiosPromise<RevertOrganizationMigrationResponseClass>;
|
|
167
|
+
};
|
|
168
|
+
/**
|
|
169
|
+
* Request parameters for createOrganizationMigration operation in OrganizationMigrationApi.
|
|
170
|
+
* @export
|
|
171
|
+
* @interface OrganizationMigrationApiCreateOrganizationMigrationRequest
|
|
172
|
+
*/
|
|
173
|
+
export interface OrganizationMigrationApiCreateOrganizationMigrationRequest {
|
|
174
|
+
/**
|
|
175
|
+
*
|
|
176
|
+
* @type {CreateOrganizationMigrationRequestDto}
|
|
177
|
+
* @memberof OrganizationMigrationApiCreateOrganizationMigration
|
|
178
|
+
*/
|
|
179
|
+
readonly createOrganizationMigrationRequestDto: CreateOrganizationMigrationRequestDto;
|
|
180
|
+
/**
|
|
181
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
182
|
+
* @type {string}
|
|
183
|
+
* @memberof OrganizationMigrationApiCreateOrganizationMigration
|
|
184
|
+
*/
|
|
185
|
+
readonly authorization?: string;
|
|
186
|
+
}
|
|
187
|
+
/**
|
|
188
|
+
* Request parameters for getOrganizationMigration operation in OrganizationMigrationApi.
|
|
189
|
+
* @export
|
|
190
|
+
* @interface OrganizationMigrationApiGetOrganizationMigrationRequest
|
|
191
|
+
*/
|
|
192
|
+
export interface OrganizationMigrationApiGetOrganizationMigrationRequest {
|
|
193
|
+
/**
|
|
194
|
+
* Unique identifier for the object.
|
|
195
|
+
* @type {any}
|
|
196
|
+
* @memberof OrganizationMigrationApiGetOrganizationMigration
|
|
197
|
+
*/
|
|
198
|
+
readonly code: any;
|
|
199
|
+
/**
|
|
200
|
+
* Fields to expand response by
|
|
201
|
+
* @type {string}
|
|
202
|
+
* @memberof OrganizationMigrationApiGetOrganizationMigration
|
|
203
|
+
*/
|
|
204
|
+
readonly expand?: string;
|
|
205
|
+
/**
|
|
206
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
207
|
+
* @type {string}
|
|
208
|
+
* @memberof OrganizationMigrationApiGetOrganizationMigration
|
|
209
|
+
*/
|
|
210
|
+
readonly authorization?: string;
|
|
211
|
+
}
|
|
212
|
+
/**
|
|
213
|
+
* Request parameters for listOrganizationMigrations operation in OrganizationMigrationApi.
|
|
214
|
+
* @export
|
|
215
|
+
* @interface OrganizationMigrationApiListOrganizationMigrationsRequest
|
|
216
|
+
*/
|
|
217
|
+
export interface OrganizationMigrationApiListOrganizationMigrationsRequest {
|
|
218
|
+
/**
|
|
219
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
220
|
+
* @type {number}
|
|
221
|
+
* @memberof OrganizationMigrationApiListOrganizationMigrations
|
|
222
|
+
*/
|
|
223
|
+
readonly pageSize?: number;
|
|
224
|
+
/**
|
|
225
|
+
* 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.
|
|
226
|
+
* @type {string}
|
|
227
|
+
* @memberof OrganizationMigrationApiListOrganizationMigrations
|
|
228
|
+
*/
|
|
229
|
+
readonly pageToken?: string;
|
|
230
|
+
/**
|
|
231
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
232
|
+
* @type {string}
|
|
233
|
+
* @memberof OrganizationMigrationApiListOrganizationMigrations
|
|
234
|
+
*/
|
|
235
|
+
readonly filter?: string;
|
|
236
|
+
/**
|
|
237
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
238
|
+
* @type {string}
|
|
239
|
+
* @memberof OrganizationMigrationApiListOrganizationMigrations
|
|
240
|
+
*/
|
|
241
|
+
readonly search?: string;
|
|
242
|
+
/**
|
|
243
|
+
* 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.
|
|
244
|
+
* @type {string}
|
|
245
|
+
* @memberof OrganizationMigrationApiListOrganizationMigrations
|
|
246
|
+
*/
|
|
247
|
+
readonly order?: string;
|
|
248
|
+
/**
|
|
249
|
+
* 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.
|
|
250
|
+
* @type {string}
|
|
251
|
+
* @memberof OrganizationMigrationApiListOrganizationMigrations
|
|
252
|
+
*/
|
|
253
|
+
readonly expand?: string;
|
|
254
|
+
/**
|
|
255
|
+
* 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.
|
|
256
|
+
* @type {string}
|
|
257
|
+
* @memberof OrganizationMigrationApiListOrganizationMigrations
|
|
258
|
+
*/
|
|
259
|
+
readonly filters?: string;
|
|
260
|
+
/**
|
|
261
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
262
|
+
* @type {string}
|
|
263
|
+
* @memberof OrganizationMigrationApiListOrganizationMigrations
|
|
264
|
+
*/
|
|
265
|
+
readonly authorization?: string;
|
|
266
|
+
}
|
|
267
|
+
/**
|
|
268
|
+
* Request parameters for revertOrganizationMigration operation in OrganizationMigrationApi.
|
|
269
|
+
* @export
|
|
270
|
+
* @interface OrganizationMigrationApiRevertOrganizationMigrationRequest
|
|
271
|
+
*/
|
|
272
|
+
export interface OrganizationMigrationApiRevertOrganizationMigrationRequest {
|
|
273
|
+
/**
|
|
274
|
+
*
|
|
275
|
+
* @type {RevertOrganizationMigrationRequestDto}
|
|
276
|
+
* @memberof OrganizationMigrationApiRevertOrganizationMigration
|
|
277
|
+
*/
|
|
278
|
+
readonly revertOrganizationMigrationRequestDto: RevertOrganizationMigrationRequestDto;
|
|
279
|
+
/**
|
|
280
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
281
|
+
* @type {string}
|
|
282
|
+
* @memberof OrganizationMigrationApiRevertOrganizationMigration
|
|
283
|
+
*/
|
|
284
|
+
readonly authorization?: string;
|
|
285
|
+
}
|
|
286
|
+
/**
|
|
287
|
+
* OrganizationMigrationApi - object-oriented interface
|
|
288
|
+
* @export
|
|
289
|
+
* @class OrganizationMigrationApi
|
|
290
|
+
* @extends {BaseAPI}
|
|
291
|
+
*/
|
|
292
|
+
export declare class OrganizationMigrationApi extends BaseAPI {
|
|
293
|
+
/**
|
|
294
|
+
* Creates a new organization migration. **Required Permissions** \"tenant-management.organizations.create\"
|
|
295
|
+
* @summary Create organization migration
|
|
296
|
+
* @param {OrganizationMigrationApiCreateOrganizationMigrationRequest} requestParameters Request parameters.
|
|
297
|
+
* @param {*} [options] Override http request option.
|
|
298
|
+
* @throws {RequiredError}
|
|
299
|
+
* @memberof OrganizationMigrationApi
|
|
300
|
+
*/
|
|
301
|
+
createOrganizationMigration(requestParameters: OrganizationMigrationApiCreateOrganizationMigrationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateOrganizationMigrationResponseClass, any>>;
|
|
302
|
+
/**
|
|
303
|
+
* Retrieves an organization migration by its code. **Required Permissions** \"tenant-management.organizations.view\"
|
|
304
|
+
* @summary Get organization migration
|
|
305
|
+
* @param {OrganizationMigrationApiGetOrganizationMigrationRequest} requestParameters Request parameters.
|
|
306
|
+
* @param {*} [options] Override http request option.
|
|
307
|
+
* @throws {RequiredError}
|
|
308
|
+
* @memberof OrganizationMigrationApi
|
|
309
|
+
*/
|
|
310
|
+
getOrganizationMigration(requestParameters: OrganizationMigrationApiGetOrganizationMigrationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetOrganizationMigrationResponseClass, any>>;
|
|
311
|
+
/**
|
|
312
|
+
* Retrieves a list of organization migrations **Required Permissions** \"tenant-management.organizations.view\"
|
|
313
|
+
* @summary List organization migrations
|
|
314
|
+
* @param {OrganizationMigrationApiListOrganizationMigrationsRequest} requestParameters Request parameters.
|
|
315
|
+
* @param {*} [options] Override http request option.
|
|
316
|
+
* @throws {RequiredError}
|
|
317
|
+
* @memberof OrganizationMigrationApi
|
|
318
|
+
*/
|
|
319
|
+
listOrganizationMigrations(requestParameters?: OrganizationMigrationApiListOrganizationMigrationsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListOrganizationMigrationsResponseClass, any>>;
|
|
320
|
+
/**
|
|
321
|
+
* Reverts an organization migration. **Required Permissions** \"tenant-management.organizations.update\"
|
|
322
|
+
* @summary Revert organization migration
|
|
323
|
+
* @param {OrganizationMigrationApiRevertOrganizationMigrationRequest} requestParameters Request parameters.
|
|
324
|
+
* @param {*} [options] Override http request option.
|
|
325
|
+
* @throws {RequiredError}
|
|
326
|
+
* @memberof OrganizationMigrationApi
|
|
327
|
+
*/
|
|
328
|
+
revertOrganizationMigration(requestParameters: OrganizationMigrationApiRevertOrganizationMigrationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RevertOrganizationMigrationResponseClass, any>>;
|
|
329
|
+
}
|