@emilgroup/tenant-sdk-node 1.39.1-beta.26 → 1.39.1-beta.28

package/dist/api/test-tenant-pool-api.d.ts

@@ -0,0 +1,506 @@
+/**
+ * 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 { CheckoutRequestDto } from '../models';
+import { CheckoutResponseClass } from '../models';
+import { CleanupRegistryRequestDto } from '../models';
+import { CleanupRegistryResponseClass } from '../models';
+import { PoolTenantResponseClass } from '../models';
+import { RegisterPoolTenantRequestDto } from '../models';
+import { UpdateTagsBodyDto } from '../models';
+/**
+ * TestTenantPoolApi - axios parameter creator
+ * @export
+ */
+export declare const TestTenantPoolApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
+     * @param {CheckoutRequestDto} checkoutRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    checkout: (checkoutRequestDto: CheckoutRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * undefined  **Required Permissions**  \"tenant-management.tenants.delete\"
+     * @param {number} id
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deregister: (id: number, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * undefined  **Required Permissions**  \"tenant-management.tenants.view\"
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getCleanupRegistry: (authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
+     * @param {string} leaseId
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    heartbeat: (leaseId: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * undefined  **Required Permissions**  \"tenant-management.tenants.create\"
+     * @param {RegisterPoolTenantRequestDto} registerPoolTenantRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    register: (registerPoolTenantRequestDto: RegisterPoolTenantRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
+     * @param {string} leaseId
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    release: (leaseId: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
+     * @param {number} id
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    retriggerCleanup: (id: number, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
+     * @param {CleanupRegistryRequestDto} cleanupRegistryRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateCleanupRegistry: (cleanupRegistryRequestDto: CleanupRegistryRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
+     * @param {string} tenantSlug
+     * @param {UpdateTagsBodyDto} updateTagsBodyDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateTags: (tenantSlug: string, updateTagsBodyDto: UpdateTagsBodyDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * TestTenantPoolApi - functional programming interface
+ * @export
+ */
+export declare const TestTenantPoolApiFp: (configuration?: Configuration) => {
+    /**
+     * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
+     * @param {CheckoutRequestDto} checkoutRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    checkout(checkoutRequestDto: CheckoutRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CheckoutResponseClass>>;
+    /**
+     * undefined  **Required Permissions**  \"tenant-management.tenants.delete\"
+     * @param {number} id
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deregister(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * undefined  **Required Permissions**  \"tenant-management.tenants.view\"
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getCleanupRegistry(authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CleanupRegistryResponseClass>>;
+    /**
+     * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
+     * @param {string} leaseId
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    heartbeat(leaseId: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CheckoutResponseClass>>;
+    /**
+     * undefined  **Required Permissions**  \"tenant-management.tenants.create\"
+     * @param {RegisterPoolTenantRequestDto} registerPoolTenantRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    register(registerPoolTenantRequestDto: RegisterPoolTenantRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PoolTenantResponseClass>>;
+    /**
+     * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
+     * @param {string} leaseId
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    release(leaseId: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
+     * @param {number} id
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    retriggerCleanup(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
+     * @param {CleanupRegistryRequestDto} cleanupRegistryRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateCleanupRegistry(cleanupRegistryRequestDto: CleanupRegistryRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CleanupRegistryResponseClass>>;
+    /**
+     * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
+     * @param {string} tenantSlug
+     * @param {UpdateTagsBodyDto} updateTagsBodyDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateTags(tenantSlug: string, updateTagsBodyDto: UpdateTagsBodyDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PoolTenantResponseClass>>;
+};
+/**
+ * TestTenantPoolApi - factory interface
+ * @export
+ */
+export declare const TestTenantPoolApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
+     * @param {CheckoutRequestDto} checkoutRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    checkout(checkoutRequestDto: CheckoutRequestDto, authorization?: string, options?: any): AxiosPromise<CheckoutResponseClass>;
+    /**
+     * undefined  **Required Permissions**  \"tenant-management.tenants.delete\"
+     * @param {number} id
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deregister(id: number, authorization?: string, options?: any): AxiosPromise<void>;
+    /**
+     * undefined  **Required Permissions**  \"tenant-management.tenants.view\"
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getCleanupRegistry(authorization?: string, options?: any): AxiosPromise<CleanupRegistryResponseClass>;
+    /**
+     * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
+     * @param {string} leaseId
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    heartbeat(leaseId: string, authorization?: string, options?: any): AxiosPromise<CheckoutResponseClass>;
+    /**
+     * undefined  **Required Permissions**  \"tenant-management.tenants.create\"
+     * @param {RegisterPoolTenantRequestDto} registerPoolTenantRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    register(registerPoolTenantRequestDto: RegisterPoolTenantRequestDto, authorization?: string, options?: any): AxiosPromise<PoolTenantResponseClass>;
+    /**
+     * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
+     * @param {string} leaseId
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    release(leaseId: string, authorization?: string, options?: any): AxiosPromise<void>;
+    /**
+     * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
+     * @param {number} id
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    retriggerCleanup(id: number, authorization?: string, options?: any): AxiosPromise<void>;
+    /**
+     * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
+     * @param {CleanupRegistryRequestDto} cleanupRegistryRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateCleanupRegistry(cleanupRegistryRequestDto: CleanupRegistryRequestDto, authorization?: string, options?: any): AxiosPromise<CleanupRegistryResponseClass>;
+    /**
+     * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
+     * @param {string} tenantSlug
+     * @param {UpdateTagsBodyDto} updateTagsBodyDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateTags(tenantSlug: string, updateTagsBodyDto: UpdateTagsBodyDto, authorization?: string, options?: any): AxiosPromise<PoolTenantResponseClass>;
+};
+/**
+ * Request parameters for checkout operation in TestTenantPoolApi.
+ * @export
+ * @interface TestTenantPoolApiCheckoutRequest
+ */
+export interface TestTenantPoolApiCheckoutRequest {
+    /**
+     *
+     * @type {CheckoutRequestDto}
+     * @memberof TestTenantPoolApiCheckout
+     */
+    readonly checkoutRequestDto: CheckoutRequestDto;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof TestTenantPoolApiCheckout
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for deregister operation in TestTenantPoolApi.
+ * @export
+ * @interface TestTenantPoolApiDeregisterRequest
+ */
+export interface TestTenantPoolApiDeregisterRequest {
+    /**
+     *
+     * @type {number}
+     * @memberof TestTenantPoolApiDeregister
+     */
+    readonly id: number;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof TestTenantPoolApiDeregister
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for getCleanupRegistry operation in TestTenantPoolApi.
+ * @export
+ * @interface TestTenantPoolApiGetCleanupRegistryRequest
+ */
+export interface TestTenantPoolApiGetCleanupRegistryRequest {
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof TestTenantPoolApiGetCleanupRegistry
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for heartbeat operation in TestTenantPoolApi.
+ * @export
+ * @interface TestTenantPoolApiHeartbeatRequest
+ */
+export interface TestTenantPoolApiHeartbeatRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof TestTenantPoolApiHeartbeat
+     */
+    readonly leaseId: string;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof TestTenantPoolApiHeartbeat
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for register operation in TestTenantPoolApi.
+ * @export
+ * @interface TestTenantPoolApiRegisterRequest
+ */
+export interface TestTenantPoolApiRegisterRequest {
+    /**
+     *
+     * @type {RegisterPoolTenantRequestDto}
+     * @memberof TestTenantPoolApiRegister
+     */
+    readonly registerPoolTenantRequestDto: RegisterPoolTenantRequestDto;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof TestTenantPoolApiRegister
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for release operation in TestTenantPoolApi.
+ * @export
+ * @interface TestTenantPoolApiReleaseRequest
+ */
+export interface TestTenantPoolApiReleaseRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof TestTenantPoolApiRelease
+     */
+    readonly leaseId: string;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof TestTenantPoolApiRelease
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for retriggerCleanup operation in TestTenantPoolApi.
+ * @export
+ * @interface TestTenantPoolApiRetriggerCleanupRequest
+ */
+export interface TestTenantPoolApiRetriggerCleanupRequest {
+    /**
+     *
+     * @type {number}
+     * @memberof TestTenantPoolApiRetriggerCleanup
+     */
+    readonly id: number;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof TestTenantPoolApiRetriggerCleanup
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for updateCleanupRegistry operation in TestTenantPoolApi.
+ * @export
+ * @interface TestTenantPoolApiUpdateCleanupRegistryRequest
+ */
+export interface TestTenantPoolApiUpdateCleanupRegistryRequest {
+    /**
+     *
+     * @type {CleanupRegistryRequestDto}
+     * @memberof TestTenantPoolApiUpdateCleanupRegistry
+     */
+    readonly cleanupRegistryRequestDto: CleanupRegistryRequestDto;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof TestTenantPoolApiUpdateCleanupRegistry
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for updateTags operation in TestTenantPoolApi.
+ * @export
+ * @interface TestTenantPoolApiUpdateTagsRequest
+ */
+export interface TestTenantPoolApiUpdateTagsRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof TestTenantPoolApiUpdateTags
+     */
+    readonly tenantSlug: string;
+    /**
+     *
+     * @type {UpdateTagsBodyDto}
+     * @memberof TestTenantPoolApiUpdateTags
+     */
+    readonly updateTagsBodyDto: UpdateTagsBodyDto;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof TestTenantPoolApiUpdateTags
+     */
+    readonly authorization?: string;
+}
+/**
+ * TestTenantPoolApi - object-oriented interface
+ * @export
+ * @class TestTenantPoolApi
+ * @extends {BaseAPI}
+ */
+export declare class TestTenantPoolApi extends BaseAPI {
+    /**
+     * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
+     * @param {TestTenantPoolApiCheckoutRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TestTenantPoolApi
+     */
+    checkout(requestParameters: TestTenantPoolApiCheckoutRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CheckoutResponseClass, any, {}>>;
+    /**
+     * undefined  **Required Permissions**  \"tenant-management.tenants.delete\"
+     * @param {TestTenantPoolApiDeregisterRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TestTenantPoolApi
+     */
+    deregister(requestParameters: TestTenantPoolApiDeregisterRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     * undefined  **Required Permissions**  \"tenant-management.tenants.view\"
+     * @param {TestTenantPoolApiGetCleanupRegistryRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TestTenantPoolApi
+     */
+    getCleanupRegistry(requestParameters?: TestTenantPoolApiGetCleanupRegistryRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CleanupRegistryResponseClass, any, {}>>;
+    /**
+     * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
+     * @param {TestTenantPoolApiHeartbeatRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TestTenantPoolApi
+     */
+    heartbeat(requestParameters: TestTenantPoolApiHeartbeatRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CheckoutResponseClass, any, {}>>;
+    /**
+     * undefined  **Required Permissions**  \"tenant-management.tenants.create\"
+     * @param {TestTenantPoolApiRegisterRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TestTenantPoolApi
+     */
+    register(requestParameters: TestTenantPoolApiRegisterRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PoolTenantResponseClass, any, {}>>;
+    /**
+     * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
+     * @param {TestTenantPoolApiReleaseRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TestTenantPoolApi
+     */
+    release(requestParameters: TestTenantPoolApiReleaseRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
+     * @param {TestTenantPoolApiRetriggerCleanupRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TestTenantPoolApi
+     */
+    retriggerCleanup(requestParameters: TestTenantPoolApiRetriggerCleanupRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
+     * @param {TestTenantPoolApiUpdateCleanupRegistryRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TestTenantPoolApi
+     */
+    updateCleanupRegistry(requestParameters: TestTenantPoolApiUpdateCleanupRegistryRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CleanupRegistryResponseClass, any, {}>>;
+    /**
+     * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
+     * @param {TestTenantPoolApiUpdateTagsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TestTenantPoolApi
+     */
+    updateTags(requestParameters: TestTenantPoolApiUpdateTagsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PoolTenantResponseClass, any, {}>>;
+}