@emilgroup/tenant-sdk-node 1.30.0 → 1.31.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 +9 -0
- package/README.md +2 -2
- package/api/invite-users-api.ts +4 -4
- package/api/organization-migration-api.ts +683 -0
- package/api/users-api.ts +4 -4
- package/api.ts +2 -0
- package/base.ts +45 -3
- package/dist/api/invite-users-api.d.ts +4 -4
- package/dist/api/invite-users-api.js +3 -3
- package/dist/api/organization-migration-api.d.ts +385 -0
- package/dist/api/organization-migration-api.js +639 -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 +11 -2
- package/dist/base.js +42 -3
- 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/create-resources-migration-request-dto.d.ts +36 -0
- package/dist/models/create-resources-migration-request-dto.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 +8 -0
- package/dist/models/index.js +8 -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/create-resources-migration-request-dto.ts +42 -0
- package/models/get-organization-migration-response-class.ts +31 -0
- package/models/index.ts +8 -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
|
@@ -350,7 +350,7 @@ export const UsersApiAxiosParamCreator = function (configuration?: Configuration
|
|
|
350
350
|
* @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.
|
|
351
351
|
* @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>
|
|
352
352
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
353
|
-
* @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>
|
|
353
|
+
* @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>
|
|
354
354
|
* @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>
|
|
355
355
|
* @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>
|
|
356
356
|
* @param {*} [options] Override http request option.
|
|
@@ -506,7 +506,7 @@ export const UsersApiFp = function(configuration?: Configuration) {
|
|
|
506
506
|
* @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.
|
|
507
507
|
* @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>
|
|
508
508
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
509
|
-
* @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>
|
|
509
|
+
* @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>
|
|
510
510
|
* @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>
|
|
511
511
|
* @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>
|
|
512
512
|
* @param {*} [options] Override http request option.
|
|
@@ -598,7 +598,7 @@ export const UsersApiFactory = function (configuration?: Configuration, basePath
|
|
|
598
598
|
* @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.
|
|
599
599
|
* @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>
|
|
600
600
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
601
|
-
* @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>
|
|
601
|
+
* @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>
|
|
602
602
|
* @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>
|
|
603
603
|
* @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>
|
|
604
604
|
* @param {*} [options] Override http request option.
|
|
@@ -799,7 +799,7 @@ export interface UsersApiListUsersRequest {
|
|
|
799
799
|
readonly search?: string
|
|
800
800
|
|
|
801
801
|
/**
|
|
802
|
-
* 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>
|
|
802
|
+
* 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>
|
|
803
803
|
* @type {string}
|
|
804
804
|
* @memberof UsersApiListUsers
|
|
805
805
|
*/
|
package/api.ts
CHANGED
|
@@ -34,6 +34,7 @@ import { HealthCheckApi } from './api';
|
|
|
34
34
|
import { InviteOrganizationsApi } from './api';
|
|
35
35
|
import { InviteUsersApi } from './api';
|
|
36
36
|
import { ListOrganizationInvitationsApi } from './api';
|
|
37
|
+
import { OrganizationMigrationApi } from './api';
|
|
37
38
|
import { OrganizationsApi } from './api';
|
|
38
39
|
import { ReInviteAnOrganizationApi } from './api';
|
|
39
40
|
import { RolesApi } from './api';
|
|
@@ -51,6 +52,7 @@ export * from './api/health-check-api';
|
|
|
51
52
|
export * from './api/invite-organizations-api';
|
|
52
53
|
export * from './api/invite-users-api';
|
|
53
54
|
export * from './api/list-organization-invitations-api';
|
|
55
|
+
export * from './api/organization-migration-api';
|
|
54
56
|
export * from './api/organizations-api';
|
|
55
57
|
export * from './api/re-invite-an-organization-api';
|
|
56
58
|
export * from './api/roles-api';
|
package/base.ts
CHANGED
|
@@ -44,6 +44,16 @@ export interface LoginClass {
|
|
|
44
44
|
permissions: string;
|
|
45
45
|
}
|
|
46
46
|
|
|
47
|
+
export interface SwitchWorkspaceRequest {
|
|
48
|
+
username: string;
|
|
49
|
+
targetWorkspace: string;
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
export interface SwitchWorkspaceResponseClass {
|
|
53
|
+
accessToken: string;
|
|
54
|
+
permissions: string;
|
|
55
|
+
}
|
|
56
|
+
|
|
47
57
|
export enum Environment {
|
|
48
58
|
Production = 'https://apiv2.emil.de',
|
|
49
59
|
Test = 'https://apiv2-test.emil.de',
|
|
@@ -94,13 +104,13 @@ export class BaseAPI {
|
|
|
94
104
|
this.attachInterceptor(axios);
|
|
95
105
|
}
|
|
96
106
|
|
|
97
|
-
async initialize(env: Environment = Environment.Production) {
|
|
107
|
+
async initialize(env: Environment = Environment.Production, targetWorkspace?: string) {
|
|
98
108
|
this.configuration.basePath = env;
|
|
99
109
|
|
|
100
110
|
await this.loadCredentials();
|
|
101
111
|
|
|
102
112
|
if (this.username) {
|
|
103
|
-
await this.authorize(this.username, this.password);
|
|
113
|
+
await this.authorize(this.username, this.password, targetWorkspace);
|
|
104
114
|
this.password = null; // to avoid keeping password loaded in memory.
|
|
105
115
|
}
|
|
106
116
|
}
|
|
@@ -150,7 +160,7 @@ export class BaseAPI {
|
|
|
150
160
|
this.configuration.basePath = env;
|
|
151
161
|
}
|
|
152
162
|
|
|
153
|
-
async authorize(username: string, password: string): Promise<void> {
|
|
163
|
+
async authorize(username: string, password: string, targetWorkspace?: string): Promise<void> {
|
|
154
164
|
const options: AxiosRequestConfig = {
|
|
155
165
|
method: 'POST',
|
|
156
166
|
url: `${this.configuration.basePath}/authservice/v1/login`,
|
|
@@ -170,6 +180,38 @@ export class BaseAPI {
|
|
|
170
180
|
|
|
171
181
|
const refreshToken = this.extractRefreshToken(response)
|
|
172
182
|
this.configuration.refreshToken = refreshToken;
|
|
183
|
+
|
|
184
|
+
// Switch workspace if provided
|
|
185
|
+
if (targetWorkspace) {
|
|
186
|
+
await this.switchWorkspace(targetWorkspace);
|
|
187
|
+
}
|
|
188
|
+
}
|
|
189
|
+
|
|
190
|
+
async switchWorkspace(targetWorkspace: string): Promise<void> {
|
|
191
|
+
const options: AxiosRequestConfig = {
|
|
192
|
+
method: 'POST',
|
|
193
|
+
url: `${this.configuration.basePath}/authservice/v1/workspaces/switch`,
|
|
194
|
+
headers: {
|
|
195
|
+
'Content-Type': 'application/json',
|
|
196
|
+
'Authorization': `Bearer ${this.configuration.accessToken}`,
|
|
197
|
+
'Cookie': this.configuration.refreshToken,
|
|
198
|
+
},
|
|
199
|
+
data: {
|
|
200
|
+
username: this.configuration.username,
|
|
201
|
+
targetWorkspace,
|
|
202
|
+
} as SwitchWorkspaceRequest,
|
|
203
|
+
withCredentials: true,
|
|
204
|
+
};
|
|
205
|
+
|
|
206
|
+
const response = await globalAxios.request<SwitchWorkspaceResponseClass>(options);
|
|
207
|
+
|
|
208
|
+
const { data: { accessToken } } = response;
|
|
209
|
+
this.configuration.accessToken = `Bearer ${accessToken}`;
|
|
210
|
+
|
|
211
|
+
const refreshToken = this.extractRefreshToken(response);
|
|
212
|
+
if (refreshToken) {
|
|
213
|
+
this.configuration.refreshToken = refreshToken;
|
|
214
|
+
}
|
|
173
215
|
}
|
|
174
216
|
|
|
175
217
|
async refreshTokenInternal(): Promise<string> {
|
|
@@ -59,7 +59,7 @@ export declare const InviteUsersApiAxiosParamCreator: (configuration?: Configura
|
|
|
59
59
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
60
60
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, email, token, organizationId, ern, partnerCode</i>
|
|
61
61
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
62
|
-
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: email, expiresOn</i>
|
|
62
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, email, expiresOn</i>
|
|
63
63
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: organizations<i>
|
|
64
64
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, email, token, organizationId, ern, partnerCode</i>
|
|
65
65
|
* @param {*} [options] Override http request option.
|
|
@@ -107,7 +107,7 @@ export declare const InviteUsersApiFp: (configuration?: Configuration) => {
|
|
|
107
107
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
108
108
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, email, token, organizationId, ern, partnerCode</i>
|
|
109
109
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
110
|
-
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: email, expiresOn</i>
|
|
110
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, email, expiresOn</i>
|
|
111
111
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: organizations<i>
|
|
112
112
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, email, token, organizationId, ern, partnerCode</i>
|
|
113
113
|
* @param {*} [options] Override http request option.
|
|
@@ -155,7 +155,7 @@ export declare const InviteUsersApiFactory: (configuration?: Configuration, base
|
|
|
155
155
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
156
156
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, email, token, organizationId, ern, partnerCode</i>
|
|
157
157
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
158
|
-
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: email, expiresOn</i>
|
|
158
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, email, expiresOn</i>
|
|
159
159
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: organizations<i>
|
|
160
160
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, email, token, organizationId, ern, partnerCode</i>
|
|
161
161
|
* @param {*} [options] Override http request option.
|
|
@@ -257,7 +257,7 @@ export interface InviteUsersApiListInvitesRequest {
|
|
|
257
257
|
*/
|
|
258
258
|
readonly search?: string;
|
|
259
259
|
/**
|
|
260
|
-
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: email, expiresOn</i>
|
|
260
|
+
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, email, expiresOn</i>
|
|
261
261
|
* @type {string}
|
|
262
262
|
* @memberof InviteUsersApiListInvites
|
|
263
263
|
*/
|
|
@@ -251,7 +251,7 @@ var InviteUsersApiAxiosParamCreator = function (configuration) {
|
|
|
251
251
|
* @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.
|
|
252
252
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, email, token, organizationId, ern, partnerCode</i>
|
|
253
253
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
254
|
-
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: email, expiresOn</i>
|
|
254
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, email, expiresOn</i>
|
|
255
255
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: organizations<i>
|
|
256
256
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, email, token, organizationId, ern, partnerCode</i>
|
|
257
257
|
* @param {*} [options] Override http request option.
|
|
@@ -396,7 +396,7 @@ var InviteUsersApiFp = function (configuration) {
|
|
|
396
396
|
* @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.
|
|
397
397
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, email, token, organizationId, ern, partnerCode</i>
|
|
398
398
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
399
|
-
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: email, expiresOn</i>
|
|
399
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, email, expiresOn</i>
|
|
400
400
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: organizations<i>
|
|
401
401
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, email, token, organizationId, ern, partnerCode</i>
|
|
402
402
|
* @param {*} [options] Override http request option.
|
|
@@ -466,7 +466,7 @@ var InviteUsersApiFactory = function (configuration, basePath, axios) {
|
|
|
466
466
|
* @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.
|
|
467
467
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, email, token, organizationId, ern, partnerCode</i>
|
|
468
468
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
469
|
-
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: email, expiresOn</i>
|
|
469
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, email, expiresOn</i>
|
|
470
470
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: organizations<i>
|
|
471
471
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, email, token, organizationId, ern, partnerCode</i>
|
|
472
472
|
* @param {*} [options] Override http request option.
|
|
@@ -0,0 +1,385 @@
|
|
|
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 { CreateResourcesMigrationRequestDto } from '../models';
|
|
18
|
+
import { GetOrganizationMigrationResponseClass } from '../models';
|
|
19
|
+
import { ListOrganizationMigrationsResponseClass } from '../models';
|
|
20
|
+
import { RevertOrganizationMigrationRequestDto } from '../models';
|
|
21
|
+
import { RevertOrganizationMigrationResponseClass } from '../models';
|
|
22
|
+
/**
|
|
23
|
+
* OrganizationMigrationApi - axios parameter creator
|
|
24
|
+
* @export
|
|
25
|
+
*/
|
|
26
|
+
export declare const OrganizationMigrationApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
27
|
+
/**
|
|
28
|
+
* Creates a new organization migration to move all resources including the sub organizations. **Required Permissions** \"tenant-management.organizations.create\"
|
|
29
|
+
* @summary Create organization migration to move all resources including the sub organizations
|
|
30
|
+
* @param {CreateOrganizationMigrationRequestDto} createOrganizationMigrationRequestDto
|
|
31
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
32
|
+
* @param {*} [options] Override http request option.
|
|
33
|
+
* @throws {RequiredError}
|
|
34
|
+
*/
|
|
35
|
+
createOrganizationMigration: (createOrganizationMigrationRequestDto: CreateOrganizationMigrationRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
36
|
+
/**
|
|
37
|
+
* Creates a new organization migration to move only source organization\'s resources to target organization. It does not move organization and users. **Required Permissions** \"tenant-management.organizations.create\"
|
|
38
|
+
* @summary Create organization migration to move only resources excluding sub organizations
|
|
39
|
+
* @param {CreateResourcesMigrationRequestDto} createResourcesMigrationRequestDto
|
|
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
|
+
createResourcesMigration: (createResourcesMigrationRequestDto: CreateResourcesMigrationRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
45
|
+
/**
|
|
46
|
+
* Retrieves an organization migration by its code. **Required Permissions** \"tenant-management.organizations.view\"
|
|
47
|
+
* @summary Get organization migration
|
|
48
|
+
* @param {any} code Unique identifier for the object.
|
|
49
|
+
* @param {string} [expand] Fields to expand response by
|
|
50
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
51
|
+
* @param {*} [options] Override http request option.
|
|
52
|
+
* @throws {RequiredError}
|
|
53
|
+
*/
|
|
54
|
+
getOrganizationMigration: (code: any, expand?: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
55
|
+
/**
|
|
56
|
+
* Retrieves a list of organization migrations **Required Permissions** \"tenant-management.organizations.view\"
|
|
57
|
+
* @summary List organization migrations
|
|
58
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
59
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
60
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
61
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
62
|
+
* @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.
|
|
63
|
+
* @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.
|
|
64
|
+
* @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.
|
|
65
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
66
|
+
* @param {*} [options] Override http request option.
|
|
67
|
+
* @throws {RequiredError}
|
|
68
|
+
*/
|
|
69
|
+
listOrganizationMigrations: (pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
70
|
+
/**
|
|
71
|
+
* Reverts an organization migration. **Required Permissions** \"tenant-management.organizations.update\"
|
|
72
|
+
* @summary Revert organization migration
|
|
73
|
+
* @param {RevertOrganizationMigrationRequestDto} revertOrganizationMigrationRequestDto
|
|
74
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
75
|
+
* @param {*} [options] Override http request option.
|
|
76
|
+
* @throws {RequiredError}
|
|
77
|
+
*/
|
|
78
|
+
revertOrganizationMigration: (revertOrganizationMigrationRequestDto: RevertOrganizationMigrationRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
79
|
+
};
|
|
80
|
+
/**
|
|
81
|
+
* OrganizationMigrationApi - functional programming interface
|
|
82
|
+
* @export
|
|
83
|
+
*/
|
|
84
|
+
export declare const OrganizationMigrationApiFp: (configuration?: Configuration) => {
|
|
85
|
+
/**
|
|
86
|
+
* Creates a new organization migration to move all resources including the sub organizations. **Required Permissions** \"tenant-management.organizations.create\"
|
|
87
|
+
* @summary Create organization migration to move all resources including the sub organizations
|
|
88
|
+
* @param {CreateOrganizationMigrationRequestDto} createOrganizationMigrationRequestDto
|
|
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
|
+
createOrganizationMigration(createOrganizationMigrationRequestDto: CreateOrganizationMigrationRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateOrganizationMigrationResponseClass>>;
|
|
94
|
+
/**
|
|
95
|
+
* Creates a new organization migration to move only source organization\'s resources to target organization. It does not move organization and users. **Required Permissions** \"tenant-management.organizations.create\"
|
|
96
|
+
* @summary Create organization migration to move only resources excluding sub organizations
|
|
97
|
+
* @param {CreateResourcesMigrationRequestDto} createResourcesMigrationRequestDto
|
|
98
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
99
|
+
* @param {*} [options] Override http request option.
|
|
100
|
+
* @throws {RequiredError}
|
|
101
|
+
*/
|
|
102
|
+
createResourcesMigration(createResourcesMigrationRequestDto: CreateResourcesMigrationRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateOrganizationMigrationResponseClass>>;
|
|
103
|
+
/**
|
|
104
|
+
* Retrieves an organization migration by its code. **Required Permissions** \"tenant-management.organizations.view\"
|
|
105
|
+
* @summary Get organization migration
|
|
106
|
+
* @param {any} code Unique identifier for the object.
|
|
107
|
+
* @param {string} [expand] Fields to expand response by
|
|
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
|
+
getOrganizationMigration(code: any, expand?: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrganizationMigrationResponseClass>>;
|
|
113
|
+
/**
|
|
114
|
+
* Retrieves a list of organization migrations **Required Permissions** \"tenant-management.organizations.view\"
|
|
115
|
+
* @summary List organization migrations
|
|
116
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
117
|
+
* @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.
|
|
118
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
119
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
120
|
+
* @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.
|
|
121
|
+
* @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.
|
|
122
|
+
* @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.
|
|
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
|
+
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>>;
|
|
128
|
+
/**
|
|
129
|
+
* Reverts an organization migration. **Required Permissions** \"tenant-management.organizations.update\"
|
|
130
|
+
* @summary Revert organization migration
|
|
131
|
+
* @param {RevertOrganizationMigrationRequestDto} revertOrganizationMigrationRequestDto
|
|
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
|
+
revertOrganizationMigration(revertOrganizationMigrationRequestDto: RevertOrganizationMigrationRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RevertOrganizationMigrationResponseClass>>;
|
|
137
|
+
};
|
|
138
|
+
/**
|
|
139
|
+
* OrganizationMigrationApi - factory interface
|
|
140
|
+
* @export
|
|
141
|
+
*/
|
|
142
|
+
export declare const OrganizationMigrationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
143
|
+
/**
|
|
144
|
+
* Creates a new organization migration to move all resources including the sub organizations. **Required Permissions** \"tenant-management.organizations.create\"
|
|
145
|
+
* @summary Create organization migration to move all resources including the sub organizations
|
|
146
|
+
* @param {CreateOrganizationMigrationRequestDto} createOrganizationMigrationRequestDto
|
|
147
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
148
|
+
* @param {*} [options] Override http request option.
|
|
149
|
+
* @throws {RequiredError}
|
|
150
|
+
*/
|
|
151
|
+
createOrganizationMigration(createOrganizationMigrationRequestDto: CreateOrganizationMigrationRequestDto, authorization?: string, options?: any): AxiosPromise<CreateOrganizationMigrationResponseClass>;
|
|
152
|
+
/**
|
|
153
|
+
* Creates a new organization migration to move only source organization\'s resources to target organization. It does not move organization and users. **Required Permissions** \"tenant-management.organizations.create\"
|
|
154
|
+
* @summary Create organization migration to move only resources excluding sub organizations
|
|
155
|
+
* @param {CreateResourcesMigrationRequestDto} createResourcesMigrationRequestDto
|
|
156
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
157
|
+
* @param {*} [options] Override http request option.
|
|
158
|
+
* @throws {RequiredError}
|
|
159
|
+
*/
|
|
160
|
+
createResourcesMigration(createResourcesMigrationRequestDto: CreateResourcesMigrationRequestDto, authorization?: string, options?: any): AxiosPromise<CreateOrganizationMigrationResponseClass>;
|
|
161
|
+
/**
|
|
162
|
+
* Retrieves an organization migration by its code. **Required Permissions** \"tenant-management.organizations.view\"
|
|
163
|
+
* @summary Get organization migration
|
|
164
|
+
* @param {any} code Unique identifier for the object.
|
|
165
|
+
* @param {string} [expand] Fields to expand response by
|
|
166
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
167
|
+
* @param {*} [options] Override http request option.
|
|
168
|
+
* @throws {RequiredError}
|
|
169
|
+
*/
|
|
170
|
+
getOrganizationMigration(code: any, expand?: string, authorization?: string, options?: any): AxiosPromise<GetOrganizationMigrationResponseClass>;
|
|
171
|
+
/**
|
|
172
|
+
* Retrieves a list of organization migrations **Required Permissions** \"tenant-management.organizations.view\"
|
|
173
|
+
* @summary List organization migrations
|
|
174
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
175
|
+
* @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.
|
|
176
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
177
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
178
|
+
* @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.
|
|
179
|
+
* @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.
|
|
180
|
+
* @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.
|
|
181
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
182
|
+
* @param {*} [options] Override http request option.
|
|
183
|
+
* @throws {RequiredError}
|
|
184
|
+
*/
|
|
185
|
+
listOrganizationMigrations(pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, authorization?: string, options?: any): AxiosPromise<ListOrganizationMigrationsResponseClass>;
|
|
186
|
+
/**
|
|
187
|
+
* Reverts an organization migration. **Required Permissions** \"tenant-management.organizations.update\"
|
|
188
|
+
* @summary Revert organization migration
|
|
189
|
+
* @param {RevertOrganizationMigrationRequestDto} revertOrganizationMigrationRequestDto
|
|
190
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
191
|
+
* @param {*} [options] Override http request option.
|
|
192
|
+
* @throws {RequiredError}
|
|
193
|
+
*/
|
|
194
|
+
revertOrganizationMigration(revertOrganizationMigrationRequestDto: RevertOrganizationMigrationRequestDto, authorization?: string, options?: any): AxiosPromise<RevertOrganizationMigrationResponseClass>;
|
|
195
|
+
};
|
|
196
|
+
/**
|
|
197
|
+
* Request parameters for createOrganizationMigration operation in OrganizationMigrationApi.
|
|
198
|
+
* @export
|
|
199
|
+
* @interface OrganizationMigrationApiCreateOrganizationMigrationRequest
|
|
200
|
+
*/
|
|
201
|
+
export interface OrganizationMigrationApiCreateOrganizationMigrationRequest {
|
|
202
|
+
/**
|
|
203
|
+
*
|
|
204
|
+
* @type {CreateOrganizationMigrationRequestDto}
|
|
205
|
+
* @memberof OrganizationMigrationApiCreateOrganizationMigration
|
|
206
|
+
*/
|
|
207
|
+
readonly createOrganizationMigrationRequestDto: CreateOrganizationMigrationRequestDto;
|
|
208
|
+
/**
|
|
209
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
210
|
+
* @type {string}
|
|
211
|
+
* @memberof OrganizationMigrationApiCreateOrganizationMigration
|
|
212
|
+
*/
|
|
213
|
+
readonly authorization?: string;
|
|
214
|
+
}
|
|
215
|
+
/**
|
|
216
|
+
* Request parameters for createResourcesMigration operation in OrganizationMigrationApi.
|
|
217
|
+
* @export
|
|
218
|
+
* @interface OrganizationMigrationApiCreateResourcesMigrationRequest
|
|
219
|
+
*/
|
|
220
|
+
export interface OrganizationMigrationApiCreateResourcesMigrationRequest {
|
|
221
|
+
/**
|
|
222
|
+
*
|
|
223
|
+
* @type {CreateResourcesMigrationRequestDto}
|
|
224
|
+
* @memberof OrganizationMigrationApiCreateResourcesMigration
|
|
225
|
+
*/
|
|
226
|
+
readonly createResourcesMigrationRequestDto: CreateResourcesMigrationRequestDto;
|
|
227
|
+
/**
|
|
228
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
229
|
+
* @type {string}
|
|
230
|
+
* @memberof OrganizationMigrationApiCreateResourcesMigration
|
|
231
|
+
*/
|
|
232
|
+
readonly authorization?: string;
|
|
233
|
+
}
|
|
234
|
+
/**
|
|
235
|
+
* Request parameters for getOrganizationMigration operation in OrganizationMigrationApi.
|
|
236
|
+
* @export
|
|
237
|
+
* @interface OrganizationMigrationApiGetOrganizationMigrationRequest
|
|
238
|
+
*/
|
|
239
|
+
export interface OrganizationMigrationApiGetOrganizationMigrationRequest {
|
|
240
|
+
/**
|
|
241
|
+
* Unique identifier for the object.
|
|
242
|
+
* @type {any}
|
|
243
|
+
* @memberof OrganizationMigrationApiGetOrganizationMigration
|
|
244
|
+
*/
|
|
245
|
+
readonly code: any;
|
|
246
|
+
/**
|
|
247
|
+
* Fields to expand response by
|
|
248
|
+
* @type {string}
|
|
249
|
+
* @memberof OrganizationMigrationApiGetOrganizationMigration
|
|
250
|
+
*/
|
|
251
|
+
readonly expand?: string;
|
|
252
|
+
/**
|
|
253
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
254
|
+
* @type {string}
|
|
255
|
+
* @memberof OrganizationMigrationApiGetOrganizationMigration
|
|
256
|
+
*/
|
|
257
|
+
readonly authorization?: string;
|
|
258
|
+
}
|
|
259
|
+
/**
|
|
260
|
+
* Request parameters for listOrganizationMigrations operation in OrganizationMigrationApi.
|
|
261
|
+
* @export
|
|
262
|
+
* @interface OrganizationMigrationApiListOrganizationMigrationsRequest
|
|
263
|
+
*/
|
|
264
|
+
export interface OrganizationMigrationApiListOrganizationMigrationsRequest {
|
|
265
|
+
/**
|
|
266
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
267
|
+
* @type {number}
|
|
268
|
+
* @memberof OrganizationMigrationApiListOrganizationMigrations
|
|
269
|
+
*/
|
|
270
|
+
readonly pageSize?: number;
|
|
271
|
+
/**
|
|
272
|
+
* 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.
|
|
273
|
+
* @type {string}
|
|
274
|
+
* @memberof OrganizationMigrationApiListOrganizationMigrations
|
|
275
|
+
*/
|
|
276
|
+
readonly pageToken?: string;
|
|
277
|
+
/**
|
|
278
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
279
|
+
* @type {string}
|
|
280
|
+
* @memberof OrganizationMigrationApiListOrganizationMigrations
|
|
281
|
+
*/
|
|
282
|
+
readonly filter?: string;
|
|
283
|
+
/**
|
|
284
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
285
|
+
* @type {string}
|
|
286
|
+
* @memberof OrganizationMigrationApiListOrganizationMigrations
|
|
287
|
+
*/
|
|
288
|
+
readonly search?: string;
|
|
289
|
+
/**
|
|
290
|
+
* 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.
|
|
291
|
+
* @type {string}
|
|
292
|
+
* @memberof OrganizationMigrationApiListOrganizationMigrations
|
|
293
|
+
*/
|
|
294
|
+
readonly order?: string;
|
|
295
|
+
/**
|
|
296
|
+
* 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.
|
|
297
|
+
* @type {string}
|
|
298
|
+
* @memberof OrganizationMigrationApiListOrganizationMigrations
|
|
299
|
+
*/
|
|
300
|
+
readonly expand?: string;
|
|
301
|
+
/**
|
|
302
|
+
* 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.
|
|
303
|
+
* @type {string}
|
|
304
|
+
* @memberof OrganizationMigrationApiListOrganizationMigrations
|
|
305
|
+
*/
|
|
306
|
+
readonly filters?: string;
|
|
307
|
+
/**
|
|
308
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
309
|
+
* @type {string}
|
|
310
|
+
* @memberof OrganizationMigrationApiListOrganizationMigrations
|
|
311
|
+
*/
|
|
312
|
+
readonly authorization?: string;
|
|
313
|
+
}
|
|
314
|
+
/**
|
|
315
|
+
* Request parameters for revertOrganizationMigration operation in OrganizationMigrationApi.
|
|
316
|
+
* @export
|
|
317
|
+
* @interface OrganizationMigrationApiRevertOrganizationMigrationRequest
|
|
318
|
+
*/
|
|
319
|
+
export interface OrganizationMigrationApiRevertOrganizationMigrationRequest {
|
|
320
|
+
/**
|
|
321
|
+
*
|
|
322
|
+
* @type {RevertOrganizationMigrationRequestDto}
|
|
323
|
+
* @memberof OrganizationMigrationApiRevertOrganizationMigration
|
|
324
|
+
*/
|
|
325
|
+
readonly revertOrganizationMigrationRequestDto: RevertOrganizationMigrationRequestDto;
|
|
326
|
+
/**
|
|
327
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
328
|
+
* @type {string}
|
|
329
|
+
* @memberof OrganizationMigrationApiRevertOrganizationMigration
|
|
330
|
+
*/
|
|
331
|
+
readonly authorization?: string;
|
|
332
|
+
}
|
|
333
|
+
/**
|
|
334
|
+
* OrganizationMigrationApi - object-oriented interface
|
|
335
|
+
* @export
|
|
336
|
+
* @class OrganizationMigrationApi
|
|
337
|
+
* @extends {BaseAPI}
|
|
338
|
+
*/
|
|
339
|
+
export declare class OrganizationMigrationApi extends BaseAPI {
|
|
340
|
+
/**
|
|
341
|
+
* Creates a new organization migration to move all resources including the sub organizations. **Required Permissions** \"tenant-management.organizations.create\"
|
|
342
|
+
* @summary Create organization migration to move all resources including the sub organizations
|
|
343
|
+
* @param {OrganizationMigrationApiCreateOrganizationMigrationRequest} requestParameters Request parameters.
|
|
344
|
+
* @param {*} [options] Override http request option.
|
|
345
|
+
* @throws {RequiredError}
|
|
346
|
+
* @memberof OrganizationMigrationApi
|
|
347
|
+
*/
|
|
348
|
+
createOrganizationMigration(requestParameters: OrganizationMigrationApiCreateOrganizationMigrationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateOrganizationMigrationResponseClass, any>>;
|
|
349
|
+
/**
|
|
350
|
+
* Creates a new organization migration to move only source organization\'s resources to target organization. It does not move organization and users. **Required Permissions** \"tenant-management.organizations.create\"
|
|
351
|
+
* @summary Create organization migration to move only resources excluding sub organizations
|
|
352
|
+
* @param {OrganizationMigrationApiCreateResourcesMigrationRequest} requestParameters Request parameters.
|
|
353
|
+
* @param {*} [options] Override http request option.
|
|
354
|
+
* @throws {RequiredError}
|
|
355
|
+
* @memberof OrganizationMigrationApi
|
|
356
|
+
*/
|
|
357
|
+
createResourcesMigration(requestParameters: OrganizationMigrationApiCreateResourcesMigrationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateOrganizationMigrationResponseClass, any>>;
|
|
358
|
+
/**
|
|
359
|
+
* Retrieves an organization migration by its code. **Required Permissions** \"tenant-management.organizations.view\"
|
|
360
|
+
* @summary Get organization migration
|
|
361
|
+
* @param {OrganizationMigrationApiGetOrganizationMigrationRequest} requestParameters Request parameters.
|
|
362
|
+
* @param {*} [options] Override http request option.
|
|
363
|
+
* @throws {RequiredError}
|
|
364
|
+
* @memberof OrganizationMigrationApi
|
|
365
|
+
*/
|
|
366
|
+
getOrganizationMigration(requestParameters: OrganizationMigrationApiGetOrganizationMigrationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetOrganizationMigrationResponseClass, any>>;
|
|
367
|
+
/**
|
|
368
|
+
* Retrieves a list of organization migrations **Required Permissions** \"tenant-management.organizations.view\"
|
|
369
|
+
* @summary List organization migrations
|
|
370
|
+
* @param {OrganizationMigrationApiListOrganizationMigrationsRequest} requestParameters Request parameters.
|
|
371
|
+
* @param {*} [options] Override http request option.
|
|
372
|
+
* @throws {RequiredError}
|
|
373
|
+
* @memberof OrganizationMigrationApi
|
|
374
|
+
*/
|
|
375
|
+
listOrganizationMigrations(requestParameters?: OrganizationMigrationApiListOrganizationMigrationsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListOrganizationMigrationsResponseClass, any>>;
|
|
376
|
+
/**
|
|
377
|
+
* Reverts an organization migration. **Required Permissions** \"tenant-management.organizations.update\"
|
|
378
|
+
* @summary Revert organization migration
|
|
379
|
+
* @param {OrganizationMigrationApiRevertOrganizationMigrationRequest} requestParameters Request parameters.
|
|
380
|
+
* @param {*} [options] Override http request option.
|
|
381
|
+
* @throws {RequiredError}
|
|
382
|
+
* @memberof OrganizationMigrationApi
|
|
383
|
+
*/
|
|
384
|
+
revertOrganizationMigration(requestParameters: OrganizationMigrationApiRevertOrganizationMigrationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RevertOrganizationMigrationResponseClass, any>>;
|
|
385
|
+
}
|