@emilgroup/tenant-sdk-node 1.39.1-beta.3 → 1.39.1-beta.30

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

@@ -0,0 +1,699 @@
+/**
+ * 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 { ListPoolTenantsResponseClass } 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) => {
+    /**
+     * Atomically claims one available pool tenant whose tags match the given filter and marks it leased for the given duration (defaults to 30 minutes). Concurrent callers requesting the same tags never receive the same tenant.  **Required Permissions**  \"tenant-management.tenants.update\"
+     * @summary Check out an available pool tenant
+     * @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>;
+    /**
+     * Removes the pool registration only -- never the underlying tenant. Refused unless the pool tenant is available, so an active lease or in-flight cleanup can never be deregistered out from under itself.  **Required Permissions**  \"tenant-management.tenants.delete\"
+     * @summary Deregister a pool tenant
+     * @param {string} tenantSlug The slug of the tenant it was registered under.
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deregister: (tenantSlug: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Returns the single, shared configuration describing which database entities get hard-deleted when a pool tenant is cleaned up after release.  **Required Permissions**  \"tenant-management.tenants.view\"
+     * @summary Read the shared cleanup registry
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getCleanupRegistry: (authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Resets the countdown on the lease held by leaseId to the given duration (defaults to 30 minutes). Callers should call this periodically while still using the tenant, since an unextended lease eventually expires and is reclaimed by the background sweep.  **Required Permissions**  \"tenant-management.tenants.update\"
+     * @summary Extend a checked-out lease
+     * @param {string} leaseId The lease id returned by checkout.
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    heartbeat: (leaseId: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Same as heartbeat by lease id, for callers that only track which tenant they leased rather than the lease id checkout returned.  **Required Permissions**  \"tenant-management.tenants.update\"
+     * @summary Extend a checked-out lease, by tenant slug
+     * @param {string} tenantSlug The slug of the leased tenant.
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    heartbeatByTenantSlug: (tenantSlug: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Returns every registered pool tenant, including its tags and status, regardless of availability.  **Required Permissions**  \"tenant-management.tenants.view\"
+     * @summary List every tenant in the test pool
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listPoolTenants: (authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Adds an existing tenant to the pool with the given tags, making it eligible for checkout by tests requesting matching tags. Does not create or modify the tenant itself.  **Required Permissions**  \"tenant-management.tenants.create\"
+     * @summary Register a tenant into the test pool
+     * @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>;
+    /**
+     * Ends the lease immediately and asynchronously triggers the tenant\'s cleanup, so it becomes available again once cleanup finishes. Cleanup is fire-and-forget: this call returns before cleanup completes.  **Required Permissions**  \"tenant-management.tenants.update\"
+     * @summary Release a checked-out lease
+     * @param {string} leaseId The lease id returned by checkout.
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    release: (leaseId: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Same as release by lease id, for callers that only track which tenant they leased rather than the lease id checkout returned.  **Required Permissions**  \"tenant-management.tenants.update\"
+     * @summary Release a checked-out lease, by tenant slug
+     * @param {string} tenantSlug The slug of the leased tenant.
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    releaseByTenantSlug: (tenantSlug: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Re-attempts cleanup for a pool tenant stuck in reset_failed, moving it back to leased and resubmitting the cleanup job. Refused for any other status.  **Required Permissions**  \"tenant-management.tenants.update\"
+     * @summary Retry a failed cleanup
+     * @param {string} tenantSlug The slug of the tenant it was registered under.
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    retriggerCleanup: (tenantSlug: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Replaces the full list of entities cleaned up when a pool tenant is released. There is only one registry, shared by every pool tenant.  **Required Permissions**  \"tenant-management.tenants.update\"
+     * @summary Replace the shared cleanup registry
+     * @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>;
+    /**
+     * Replaces the full tag set of the pool tenant registered under the given tenant slug.  **Required Permissions**  \"tenant-management.tenants.update\"
+     * @summary Replace a pool tenant\'s tags
+     * @param {string} tenantSlug The slug of the tenant it was registered under.
+     * @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) => {
+    /**
+     * Atomically claims one available pool tenant whose tags match the given filter and marks it leased for the given duration (defaults to 30 minutes). Concurrent callers requesting the same tags never receive the same tenant.  **Required Permissions**  \"tenant-management.tenants.update\"
+     * @summary Check out an available pool tenant
+     * @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>>;
+    /**
+     * Removes the pool registration only -- never the underlying tenant. Refused unless the pool tenant is available, so an active lease or in-flight cleanup can never be deregistered out from under itself.  **Required Permissions**  \"tenant-management.tenants.delete\"
+     * @summary Deregister a pool tenant
+     * @param {string} tenantSlug The slug of the tenant it was registered under.
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deregister(tenantSlug: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Returns the single, shared configuration describing which database entities get hard-deleted when a pool tenant is cleaned up after release.  **Required Permissions**  \"tenant-management.tenants.view\"
+     * @summary Read the shared cleanup registry
+     * @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>>;
+    /**
+     * Resets the countdown on the lease held by leaseId to the given duration (defaults to 30 minutes). Callers should call this periodically while still using the tenant, since an unextended lease eventually expires and is reclaimed by the background sweep.  **Required Permissions**  \"tenant-management.tenants.update\"
+     * @summary Extend a checked-out lease
+     * @param {string} leaseId The lease id returned by checkout.
+     * @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>>;
+    /**
+     * Same as heartbeat by lease id, for callers that only track which tenant they leased rather than the lease id checkout returned.  **Required Permissions**  \"tenant-management.tenants.update\"
+     * @summary Extend a checked-out lease, by tenant slug
+     * @param {string} tenantSlug The slug of the leased tenant.
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    heartbeatByTenantSlug(tenantSlug: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CheckoutResponseClass>>;
+    /**
+     * Returns every registered pool tenant, including its tags and status, regardless of availability.  **Required Permissions**  \"tenant-management.tenants.view\"
+     * @summary List every tenant in the test pool
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listPoolTenants(authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPoolTenantsResponseClass>>;
+    /**
+     * Adds an existing tenant to the pool with the given tags, making it eligible for checkout by tests requesting matching tags. Does not create or modify the tenant itself.  **Required Permissions**  \"tenant-management.tenants.create\"
+     * @summary Register a tenant into the test pool
+     * @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>>;
+    /**
+     * Ends the lease immediately and asynchronously triggers the tenant\'s cleanup, so it becomes available again once cleanup finishes. Cleanup is fire-and-forget: this call returns before cleanup completes.  **Required Permissions**  \"tenant-management.tenants.update\"
+     * @summary Release a checked-out lease
+     * @param {string} leaseId The lease id returned by checkout.
+     * @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>>;
+    /**
+     * Same as release by lease id, for callers that only track which tenant they leased rather than the lease id checkout returned.  **Required Permissions**  \"tenant-management.tenants.update\"
+     * @summary Release a checked-out lease, by tenant slug
+     * @param {string} tenantSlug The slug of the leased tenant.
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    releaseByTenantSlug(tenantSlug: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Re-attempts cleanup for a pool tenant stuck in reset_failed, moving it back to leased and resubmitting the cleanup job. Refused for any other status.  **Required Permissions**  \"tenant-management.tenants.update\"
+     * @summary Retry a failed cleanup
+     * @param {string} tenantSlug The slug of the tenant it was registered under.
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    retriggerCleanup(tenantSlug: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Replaces the full list of entities cleaned up when a pool tenant is released. There is only one registry, shared by every pool tenant.  **Required Permissions**  \"tenant-management.tenants.update\"
+     * @summary Replace the shared cleanup registry
+     * @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>>;
+    /**
+     * Replaces the full tag set of the pool tenant registered under the given tenant slug.  **Required Permissions**  \"tenant-management.tenants.update\"
+     * @summary Replace a pool tenant\'s tags
+     * @param {string} tenantSlug The slug of the tenant it was registered under.
+     * @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) => {
+    /**
+     * Atomically claims one available pool tenant whose tags match the given filter and marks it leased for the given duration (defaults to 30 minutes). Concurrent callers requesting the same tags never receive the same tenant.  **Required Permissions**  \"tenant-management.tenants.update\"
+     * @summary Check out an available pool tenant
+     * @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>;
+    /**
+     * Removes the pool registration only -- never the underlying tenant. Refused unless the pool tenant is available, so an active lease or in-flight cleanup can never be deregistered out from under itself.  **Required Permissions**  \"tenant-management.tenants.delete\"
+     * @summary Deregister a pool tenant
+     * @param {string} tenantSlug The slug of the tenant it was registered under.
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deregister(tenantSlug: string, authorization?: string, options?: any): AxiosPromise<void>;
+    /**
+     * Returns the single, shared configuration describing which database entities get hard-deleted when a pool tenant is cleaned up after release.  **Required Permissions**  \"tenant-management.tenants.view\"
+     * @summary Read the shared cleanup registry
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getCleanupRegistry(authorization?: string, options?: any): AxiosPromise<CleanupRegistryResponseClass>;
+    /**
+     * Resets the countdown on the lease held by leaseId to the given duration (defaults to 30 minutes). Callers should call this periodically while still using the tenant, since an unextended lease eventually expires and is reclaimed by the background sweep.  **Required Permissions**  \"tenant-management.tenants.update\"
+     * @summary Extend a checked-out lease
+     * @param {string} leaseId The lease id returned by checkout.
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    heartbeat(leaseId: string, authorization?: string, options?: any): AxiosPromise<CheckoutResponseClass>;
+    /**
+     * Same as heartbeat by lease id, for callers that only track which tenant they leased rather than the lease id checkout returned.  **Required Permissions**  \"tenant-management.tenants.update\"
+     * @summary Extend a checked-out lease, by tenant slug
+     * @param {string} tenantSlug The slug of the leased tenant.
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    heartbeatByTenantSlug(tenantSlug: string, authorization?: string, options?: any): AxiosPromise<CheckoutResponseClass>;
+    /**
+     * Returns every registered pool tenant, including its tags and status, regardless of availability.  **Required Permissions**  \"tenant-management.tenants.view\"
+     * @summary List every tenant in the test pool
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listPoolTenants(authorization?: string, options?: any): AxiosPromise<ListPoolTenantsResponseClass>;
+    /**
+     * Adds an existing tenant to the pool with the given tags, making it eligible for checkout by tests requesting matching tags. Does not create or modify the tenant itself.  **Required Permissions**  \"tenant-management.tenants.create\"
+     * @summary Register a tenant into the test pool
+     * @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>;
+    /**
+     * Ends the lease immediately and asynchronously triggers the tenant\'s cleanup, so it becomes available again once cleanup finishes. Cleanup is fire-and-forget: this call returns before cleanup completes.  **Required Permissions**  \"tenant-management.tenants.update\"
+     * @summary Release a checked-out lease
+     * @param {string} leaseId The lease id returned by checkout.
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    release(leaseId: string, authorization?: string, options?: any): AxiosPromise<void>;
+    /**
+     * Same as release by lease id, for callers that only track which tenant they leased rather than the lease id checkout returned.  **Required Permissions**  \"tenant-management.tenants.update\"
+     * @summary Release a checked-out lease, by tenant slug
+     * @param {string} tenantSlug The slug of the leased tenant.
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    releaseByTenantSlug(tenantSlug: string, authorization?: string, options?: any): AxiosPromise<void>;
+    /**
+     * Re-attempts cleanup for a pool tenant stuck in reset_failed, moving it back to leased and resubmitting the cleanup job. Refused for any other status.  **Required Permissions**  \"tenant-management.tenants.update\"
+     * @summary Retry a failed cleanup
+     * @param {string} tenantSlug The slug of the tenant it was registered under.
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    retriggerCleanup(tenantSlug: string, authorization?: string, options?: any): AxiosPromise<void>;
+    /**
+     * Replaces the full list of entities cleaned up when a pool tenant is released. There is only one registry, shared by every pool tenant.  **Required Permissions**  \"tenant-management.tenants.update\"
+     * @summary Replace the shared cleanup registry
+     * @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>;
+    /**
+     * Replaces the full tag set of the pool tenant registered under the given tenant slug.  **Required Permissions**  \"tenant-management.tenants.update\"
+     * @summary Replace a pool tenant\'s tags
+     * @param {string} tenantSlug The slug of the tenant it was registered under.
+     * @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 {
+    /**
+     * The slug of the tenant it was registered under.
+     * @type {string}
+     * @memberof TestTenantPoolApiDeregister
+     */
+    readonly tenantSlug: string;
+    /**
+     * 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 {
+    /**
+     * The lease id returned by checkout.
+     * @type {string}
+     * @memberof TestTenantPoolApiHeartbeat
+     */
+    readonly leaseId: string;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof TestTenantPoolApiHeartbeat
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for heartbeatByTenantSlug operation in TestTenantPoolApi.
+ * @export
+ * @interface TestTenantPoolApiHeartbeatByTenantSlugRequest
+ */
+export interface TestTenantPoolApiHeartbeatByTenantSlugRequest {
+    /**
+     * The slug of the leased tenant.
+     * @type {string}
+     * @memberof TestTenantPoolApiHeartbeatByTenantSlug
+     */
+    readonly tenantSlug: string;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof TestTenantPoolApiHeartbeatByTenantSlug
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for listPoolTenants operation in TestTenantPoolApi.
+ * @export
+ * @interface TestTenantPoolApiListPoolTenantsRequest
+ */
+export interface TestTenantPoolApiListPoolTenantsRequest {
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof TestTenantPoolApiListPoolTenants
+     */
+    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 {
+    /**
+     * The lease id returned by checkout.
+     * @type {string}
+     * @memberof TestTenantPoolApiRelease
+     */
+    readonly leaseId: string;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof TestTenantPoolApiRelease
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for releaseByTenantSlug operation in TestTenantPoolApi.
+ * @export
+ * @interface TestTenantPoolApiReleaseByTenantSlugRequest
+ */
+export interface TestTenantPoolApiReleaseByTenantSlugRequest {
+    /**
+     * The slug of the leased tenant.
+     * @type {string}
+     * @memberof TestTenantPoolApiReleaseByTenantSlug
+     */
+    readonly tenantSlug: string;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof TestTenantPoolApiReleaseByTenantSlug
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for retriggerCleanup operation in TestTenantPoolApi.
+ * @export
+ * @interface TestTenantPoolApiRetriggerCleanupRequest
+ */
+export interface TestTenantPoolApiRetriggerCleanupRequest {
+    /**
+     * The slug of the tenant it was registered under.
+     * @type {string}
+     * @memberof TestTenantPoolApiRetriggerCleanup
+     */
+    readonly tenantSlug: string;
+    /**
+     * 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 {
+    /**
+     * The slug of the tenant it was registered under.
+     * @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 {
+    /**
+     * Atomically claims one available pool tenant whose tags match the given filter and marks it leased for the given duration (defaults to 30 minutes). Concurrent callers requesting the same tags never receive the same tenant.  **Required Permissions**  \"tenant-management.tenants.update\"
+     * @summary Check out an available pool tenant
+     * @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, {}>>;
+    /**
+     * Removes the pool registration only -- never the underlying tenant. Refused unless the pool tenant is available, so an active lease or in-flight cleanup can never be deregistered out from under itself.  **Required Permissions**  \"tenant-management.tenants.delete\"
+     * @summary Deregister a pool tenant
+     * @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, {}>>;
+    /**
+     * Returns the single, shared configuration describing which database entities get hard-deleted when a pool tenant is cleaned up after release.  **Required Permissions**  \"tenant-management.tenants.view\"
+     * @summary Read the shared cleanup registry
+     * @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, {}>>;
+    /**
+     * Resets the countdown on the lease held by leaseId to the given duration (defaults to 30 minutes). Callers should call this periodically while still using the tenant, since an unextended lease eventually expires and is reclaimed by the background sweep.  **Required Permissions**  \"tenant-management.tenants.update\"
+     * @summary Extend a checked-out lease
+     * @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, {}>>;
+    /**
+     * Same as heartbeat by lease id, for callers that only track which tenant they leased rather than the lease id checkout returned.  **Required Permissions**  \"tenant-management.tenants.update\"
+     * @summary Extend a checked-out lease, by tenant slug
+     * @param {TestTenantPoolApiHeartbeatByTenantSlugRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TestTenantPoolApi
+     */
+    heartbeatByTenantSlug(requestParameters: TestTenantPoolApiHeartbeatByTenantSlugRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CheckoutResponseClass, any, {}>>;
+    /**
+     * Returns every registered pool tenant, including its tags and status, regardless of availability.  **Required Permissions**  \"tenant-management.tenants.view\"
+     * @summary List every tenant in the test pool
+     * @param {TestTenantPoolApiListPoolTenantsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TestTenantPoolApi
+     */
+    listPoolTenants(requestParameters?: TestTenantPoolApiListPoolTenantsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPoolTenantsResponseClass, any, {}>>;
+    /**
+     * Adds an existing tenant to the pool with the given tags, making it eligible for checkout by tests requesting matching tags. Does not create or modify the tenant itself.  **Required Permissions**  \"tenant-management.tenants.create\"
+     * @summary Register a tenant into the test pool
+     * @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, {}>>;
+    /**
+     * Ends the lease immediately and asynchronously triggers the tenant\'s cleanup, so it becomes available again once cleanup finishes. Cleanup is fire-and-forget: this call returns before cleanup completes.  **Required Permissions**  \"tenant-management.tenants.update\"
+     * @summary Release a checked-out lease
+     * @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, {}>>;
+    /**
+     * Same as release by lease id, for callers that only track which tenant they leased rather than the lease id checkout returned.  **Required Permissions**  \"tenant-management.tenants.update\"
+     * @summary Release a checked-out lease, by tenant slug
+     * @param {TestTenantPoolApiReleaseByTenantSlugRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TestTenantPoolApi
+     */
+    releaseByTenantSlug(requestParameters: TestTenantPoolApiReleaseByTenantSlugRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     * Re-attempts cleanup for a pool tenant stuck in reset_failed, moving it back to leased and resubmitting the cleanup job. Refused for any other status.  **Required Permissions**  \"tenant-management.tenants.update\"
+     * @summary Retry a failed cleanup
+     * @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, {}>>;
+    /**
+     * Replaces the full list of entities cleaned up when a pool tenant is released. There is only one registry, shared by every pool tenant.  **Required Permissions**  \"tenant-management.tenants.update\"
+     * @summary Replace the shared cleanup registry
+     * @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, {}>>;
+    /**
+     * Replaces the full tag set of the pool tenant registered under the given tenant slug.  **Required Permissions**  \"tenant-management.tenants.update\"
+     * @summary Replace a pool tenant\'s tags
+     * @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, {}>>;
+}