@emilgroup/tenant-sdk-node 1.29.1-beta.1 → 1.31.0

package/dist/api/organization-migration-api.d.ts

@@ -0,0 +1,385 @@
+/**
+ * EMIL Tenant Service
+ * The EMIL TenantService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
+import { Configuration } from '../configuration';
+import { RequestArgs, BaseAPI } from '../base';
+import { CreateOrganizationMigrationRequestDto } from '../models';
+import { CreateOrganizationMigrationResponseClass } from '../models';
+import { CreateResourcesMigrationRequestDto } from '../models';
+import { GetOrganizationMigrationResponseClass } from '../models';
+import { ListOrganizationMigrationsResponseClass } from '../models';
+import { RevertOrganizationMigrationRequestDto } from '../models';
+import { RevertOrganizationMigrationResponseClass } from '../models';
+/**
+ * OrganizationMigrationApi - axios parameter creator
+ * @export
+ */
+export declare const OrganizationMigrationApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Creates a new organization migration to move all resources including the sub organizations.  **Required Permissions**  \"tenant-management.organizations.create\"
+     * @summary Create organization migration to move all resources including the sub organizations
+     * @param {CreateOrganizationMigrationRequestDto} createOrganizationMigrationRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createOrganizationMigration: (createOrganizationMigrationRequestDto: CreateOrganizationMigrationRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * 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\"
+     * @summary Create organization migration to move only resources excluding sub organizations
+     * @param {CreateResourcesMigrationRequestDto} createResourcesMigrationRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createResourcesMigration: (createResourcesMigrationRequestDto: CreateResourcesMigrationRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieves an organization migration by its code.  **Required Permissions**  \"tenant-management.organizations.view\"
+     * @summary Get organization migration
+     * @param {any} code Unique identifier for the object.
+     * @param {string} [expand] Fields to expand response by
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getOrganizationMigration: (code: any, expand?: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieves a list of organization migrations  **Required Permissions**  \"tenant-management.organizations.view\"
+     * @summary List organization migrations
+     * @param {number} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
+     * @param {string} [filter] Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
+     * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * @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.
+     * @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.
+     * @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.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listOrganizationMigrations: (pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Reverts an organization migration.  **Required Permissions**  \"tenant-management.organizations.update\"
+     * @summary Revert organization migration
+     * @param {RevertOrganizationMigrationRequestDto} revertOrganizationMigrationRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    revertOrganizationMigration: (revertOrganizationMigrationRequestDto: RevertOrganizationMigrationRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * OrganizationMigrationApi - functional programming interface
+ * @export
+ */
+export declare const OrganizationMigrationApiFp: (configuration?: Configuration) => {
+    /**
+     * Creates a new organization migration to move all resources including the sub organizations.  **Required Permissions**  \"tenant-management.organizations.create\"
+     * @summary Create organization migration to move all resources including the sub organizations
+     * @param {CreateOrganizationMigrationRequestDto} createOrganizationMigrationRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createOrganizationMigration(createOrganizationMigrationRequestDto: CreateOrganizationMigrationRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateOrganizationMigrationResponseClass>>;
+    /**
+     * 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\"
+     * @summary Create organization migration to move only resources excluding sub organizations
+     * @param {CreateResourcesMigrationRequestDto} createResourcesMigrationRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createResourcesMigration(createResourcesMigrationRequestDto: CreateResourcesMigrationRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateOrganizationMigrationResponseClass>>;
+    /**
+     * Retrieves an organization migration by its code.  **Required Permissions**  \"tenant-management.organizations.view\"
+     * @summary Get organization migration
+     * @param {any} code Unique identifier for the object.
+     * @param {string} [expand] Fields to expand response by
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getOrganizationMigration(code: any, expand?: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrganizationMigrationResponseClass>>;
+    /**
+     * Retrieves a list of organization migrations  **Required Permissions**  \"tenant-management.organizations.view\"
+     * @summary List organization migrations
+     * @param {number} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
+     * @param {string} [filter] Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
+     * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * @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.
+     * @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.
+     * @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.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    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>>;
+    /**
+     * Reverts an organization migration.  **Required Permissions**  \"tenant-management.organizations.update\"
+     * @summary Revert organization migration
+     * @param {RevertOrganizationMigrationRequestDto} revertOrganizationMigrationRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    revertOrganizationMigration(revertOrganizationMigrationRequestDto: RevertOrganizationMigrationRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RevertOrganizationMigrationResponseClass>>;
+};
+/**
+ * OrganizationMigrationApi - factory interface
+ * @export
+ */
+export declare const OrganizationMigrationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Creates a new organization migration to move all resources including the sub organizations.  **Required Permissions**  \"tenant-management.organizations.create\"
+     * @summary Create organization migration to move all resources including the sub organizations
+     * @param {CreateOrganizationMigrationRequestDto} createOrganizationMigrationRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createOrganizationMigration(createOrganizationMigrationRequestDto: CreateOrganizationMigrationRequestDto, authorization?: string, options?: any): AxiosPromise<CreateOrganizationMigrationResponseClass>;
+    /**
+     * 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\"
+     * @summary Create organization migration to move only resources excluding sub organizations
+     * @param {CreateResourcesMigrationRequestDto} createResourcesMigrationRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createResourcesMigration(createResourcesMigrationRequestDto: CreateResourcesMigrationRequestDto, authorization?: string, options?: any): AxiosPromise<CreateOrganizationMigrationResponseClass>;
+    /**
+     * Retrieves an organization migration by its code.  **Required Permissions**  \"tenant-management.organizations.view\"
+     * @summary Get organization migration
+     * @param {any} code Unique identifier for the object.
+     * @param {string} [expand] Fields to expand response by
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getOrganizationMigration(code: any, expand?: string, authorization?: string, options?: any): AxiosPromise<GetOrganizationMigrationResponseClass>;
+    /**
+     * Retrieves a list of organization migrations  **Required Permissions**  \"tenant-management.organizations.view\"
+     * @summary List organization migrations
+     * @param {number} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
+     * @param {string} [filter] Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
+     * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * @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.
+     * @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.
+     * @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.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listOrganizationMigrations(pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, authorization?: string, options?: any): AxiosPromise<ListOrganizationMigrationsResponseClass>;
+    /**
+     * Reverts an organization migration.  **Required Permissions**  \"tenant-management.organizations.update\"
+     * @summary Revert organization migration
+     * @param {RevertOrganizationMigrationRequestDto} revertOrganizationMigrationRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    revertOrganizationMigration(revertOrganizationMigrationRequestDto: RevertOrganizationMigrationRequestDto, authorization?: string, options?: any): AxiosPromise<RevertOrganizationMigrationResponseClass>;
+};
+/**
+ * Request parameters for createOrganizationMigration operation in OrganizationMigrationApi.
+ * @export
+ * @interface OrganizationMigrationApiCreateOrganizationMigrationRequest
+ */
+export interface OrganizationMigrationApiCreateOrganizationMigrationRequest {
+    /**
+     *
+     * @type {CreateOrganizationMigrationRequestDto}
+     * @memberof OrganizationMigrationApiCreateOrganizationMigration
+     */
+    readonly createOrganizationMigrationRequestDto: CreateOrganizationMigrationRequestDto;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof OrganizationMigrationApiCreateOrganizationMigration
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for createResourcesMigration operation in OrganizationMigrationApi.
+ * @export
+ * @interface OrganizationMigrationApiCreateResourcesMigrationRequest
+ */
+export interface OrganizationMigrationApiCreateResourcesMigrationRequest {
+    /**
+     *
+     * @type {CreateResourcesMigrationRequestDto}
+     * @memberof OrganizationMigrationApiCreateResourcesMigration
+     */
+    readonly createResourcesMigrationRequestDto: CreateResourcesMigrationRequestDto;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof OrganizationMigrationApiCreateResourcesMigration
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for getOrganizationMigration operation in OrganizationMigrationApi.
+ * @export
+ * @interface OrganizationMigrationApiGetOrganizationMigrationRequest
+ */
+export interface OrganizationMigrationApiGetOrganizationMigrationRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {any}
+     * @memberof OrganizationMigrationApiGetOrganizationMigration
+     */
+    readonly code: any;
+    /**
+     * Fields to expand response by
+     * @type {string}
+     * @memberof OrganizationMigrationApiGetOrganizationMigration
+     */
+    readonly expand?: string;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof OrganizationMigrationApiGetOrganizationMigration
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for listOrganizationMigrations operation in OrganizationMigrationApi.
+ * @export
+ * @interface OrganizationMigrationApiListOrganizationMigrationsRequest
+ */
+export interface OrganizationMigrationApiListOrganizationMigrationsRequest {
+    /**
+     * A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @type {number}
+     * @memberof OrganizationMigrationApiListOrganizationMigrations
+     */
+    readonly pageSize?: number;
+    /**
+     * 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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
+     * @type {string}
+     * @memberof OrganizationMigrationApiListOrganizationMigrations
+     */
+    readonly pageToken?: string;
+    /**
+     * Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
+     * @type {string}
+     * @memberof OrganizationMigrationApiListOrganizationMigrations
+     */
+    readonly filter?: string;
+    /**
+     * To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * @type {string}
+     * @memberof OrganizationMigrationApiListOrganizationMigrations
+     */
+    readonly search?: string;
+    /**
+     * 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.
+     * @type {string}
+     * @memberof OrganizationMigrationApiListOrganizationMigrations
+     */
+    readonly order?: string;
+    /**
+     * 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.
+     * @type {string}
+     * @memberof OrganizationMigrationApiListOrganizationMigrations
+     */
+    readonly expand?: string;
+    /**
+     * 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.
+     * @type {string}
+     * @memberof OrganizationMigrationApiListOrganizationMigrations
+     */
+    readonly filters?: string;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof OrganizationMigrationApiListOrganizationMigrations
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for revertOrganizationMigration operation in OrganizationMigrationApi.
+ * @export
+ * @interface OrganizationMigrationApiRevertOrganizationMigrationRequest
+ */
+export interface OrganizationMigrationApiRevertOrganizationMigrationRequest {
+    /**
+     *
+     * @type {RevertOrganizationMigrationRequestDto}
+     * @memberof OrganizationMigrationApiRevertOrganizationMigration
+     */
+    readonly revertOrganizationMigrationRequestDto: RevertOrganizationMigrationRequestDto;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof OrganizationMigrationApiRevertOrganizationMigration
+     */
+    readonly authorization?: string;
+}
+/**
+ * OrganizationMigrationApi - object-oriented interface
+ * @export
+ * @class OrganizationMigrationApi
+ * @extends {BaseAPI}
+ */
+export declare class OrganizationMigrationApi extends BaseAPI {
+    /**
+     * Creates a new organization migration to move all resources including the sub organizations.  **Required Permissions**  \"tenant-management.organizations.create\"
+     * @summary Create organization migration to move all resources including the sub organizations
+     * @param {OrganizationMigrationApiCreateOrganizationMigrationRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrganizationMigrationApi
+     */
+    createOrganizationMigration(requestParameters: OrganizationMigrationApiCreateOrganizationMigrationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateOrganizationMigrationResponseClass, any>>;
+    /**
+     * 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\"
+     * @summary Create organization migration to move only resources excluding sub organizations
+     * @param {OrganizationMigrationApiCreateResourcesMigrationRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrganizationMigrationApi
+     */
+    createResourcesMigration(requestParameters: OrganizationMigrationApiCreateResourcesMigrationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateOrganizationMigrationResponseClass, any>>;
+    /**
+     * Retrieves an organization migration by its code.  **Required Permissions**  \"tenant-management.organizations.view\"
+     * @summary Get organization migration
+     * @param {OrganizationMigrationApiGetOrganizationMigrationRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrganizationMigrationApi
+     */
+    getOrganizationMigration(requestParameters: OrganizationMigrationApiGetOrganizationMigrationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetOrganizationMigrationResponseClass, any>>;
+    /**
+     * Retrieves a list of organization migrations  **Required Permissions**  \"tenant-management.organizations.view\"
+     * @summary List organization migrations
+     * @param {OrganizationMigrationApiListOrganizationMigrationsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrganizationMigrationApi
+     */
+    listOrganizationMigrations(requestParameters?: OrganizationMigrationApiListOrganizationMigrationsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListOrganizationMigrationsResponseClass, any>>;
+    /**
+     * Reverts an organization migration.  **Required Permissions**  \"tenant-management.organizations.update\"
+     * @summary Revert organization migration
+     * @param {OrganizationMigrationApiRevertOrganizationMigrationRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrganizationMigrationApi
+     */
+    revertOrganizationMigration(requestParameters: OrganizationMigrationApiRevertOrganizationMigrationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RevertOrganizationMigrationResponseClass, any>>;
+}