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

package/README.md

@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
 Navigate to the folder of your consuming project and run one of the following commands:
 
 ```
-npm install @emilgroup/tenant-sdk-node@1.39.1-beta.28 --save
+npm install @emilgroup/tenant-sdk-node@1.39.1-beta.29 --save
 ```
 or 
 ```
-yarn add @emilgroup/tenant-sdk-node@1.39.1-beta.28
+yarn add @emilgroup/tenant-sdk-node@1.39.1-beta.29
 ```
 
 And then you can import `UsersApi`.

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

@@ -45,7 +45,8 @@ const FormData = require('form-data');
 export const TestTenantPoolApiAxiosParamCreator = function (configuration?: Configuration) {
     return {
         /**
-         * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
+         * 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.
@@ -91,8 +92,9 @@ export const TestTenantPoolApiAxiosParamCreator = function (configuration?: Conf
             };
         },
         /**
-         * undefined  **Required Permissions**  \"tenant-management.tenants.delete\"
-         * @param {number} id 
+         * 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 {number} id The pool registration id (not the tenant id).
          * @param {string} [authorization] Bearer Token
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -135,7 +137,8 @@ export const TestTenantPoolApiAxiosParamCreator = function (configuration?: Conf
             };
         },
         /**
-         * undefined  **Required Permissions**  \"tenant-management.tenants.view\"
+         * 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}
@@ -175,8 +178,9 @@ export const TestTenantPoolApiAxiosParamCreator = function (configuration?: Conf
             };
         },
         /**
-         * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
-         * @param {string} leaseId 
+         * 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}
@@ -219,7 +223,8 @@ export const TestTenantPoolApiAxiosParamCreator = function (configuration?: Conf
             };
         },
         /**
-         * undefined  **Required Permissions**  \"tenant-management.tenants.create\"
+         * 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.
@@ -265,8 +270,9 @@ export const TestTenantPoolApiAxiosParamCreator = function (configuration?: Conf
             };
         },
         /**
-         * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
-         * @param {string} leaseId 
+         * 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}
@@ -309,8 +315,9 @@ export const TestTenantPoolApiAxiosParamCreator = function (configuration?: Conf
             };
         },
         /**
-         * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
-         * @param {number} id 
+         * 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 {number} id The pool registration id (not the tenant id).
          * @param {string} [authorization] Bearer Token
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -353,7 +360,8 @@ export const TestTenantPoolApiAxiosParamCreator = function (configuration?: Conf
             };
         },
         /**
-         * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
+         * 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.
@@ -399,8 +407,9 @@ export const TestTenantPoolApiAxiosParamCreator = function (configuration?: Conf
             };
         },
         /**
-         * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
-         * @param {string} tenantSlug 
+         * 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.
@@ -459,7 +468,8 @@ export const TestTenantPoolApiFp = function(configuration?: Configuration) {
     const localVarAxiosParamCreator = TestTenantPoolApiAxiosParamCreator(configuration)
     return {
         /**
-         * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
+         * 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.
@@ -470,8 +480,9 @@ export const TestTenantPoolApiFp = function(configuration?: Configuration) {
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
         /**
-         * undefined  **Required Permissions**  \"tenant-management.tenants.delete\"
-         * @param {number} id 
+         * 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 {number} id The pool registration id (not the tenant id).
          * @param {string} [authorization] Bearer Token
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -481,7 +492,8 @@ export const TestTenantPoolApiFp = function(configuration?: Configuration) {
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
         /**
-         * undefined  **Required Permissions**  \"tenant-management.tenants.view\"
+         * 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}
@@ -491,8 +503,9 @@ export const TestTenantPoolApiFp = function(configuration?: Configuration) {
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
         /**
-         * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
-         * @param {string} leaseId 
+         * 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}
@@ -502,7 +515,8 @@ export const TestTenantPoolApiFp = function(configuration?: Configuration) {
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
         /**
-         * undefined  **Required Permissions**  \"tenant-management.tenants.create\"
+         * 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.
@@ -513,8 +527,9 @@ export const TestTenantPoolApiFp = function(configuration?: Configuration) {
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
         /**
-         * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
-         * @param {string} leaseId 
+         * 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}
@@ -524,8 +539,9 @@ export const TestTenantPoolApiFp = function(configuration?: Configuration) {
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
         /**
-         * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
-         * @param {number} id 
+         * 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 {number} id The pool registration id (not the tenant id).
          * @param {string} [authorization] Bearer Token
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -535,7 +551,8 @@ export const TestTenantPoolApiFp = function(configuration?: Configuration) {
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
         /**
-         * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
+         * 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.
@@ -546,8 +563,9 @@ export const TestTenantPoolApiFp = function(configuration?: Configuration) {
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
         /**
-         * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
-         * @param {string} tenantSlug 
+         * 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.
@@ -568,7 +586,8 @@ export const TestTenantPoolApiFactory = function (configuration?: Configuration,
     const localVarFp = TestTenantPoolApiFp(configuration)
     return {
         /**
-         * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
+         * 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.
@@ -578,8 +597,9 @@ export const TestTenantPoolApiFactory = function (configuration?: Configuration,
             return localVarFp.checkout(checkoutRequestDto, authorization, options).then((request) => request(axios, basePath));
         },
         /**
-         * undefined  **Required Permissions**  \"tenant-management.tenants.delete\"
-         * @param {number} id 
+         * 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 {number} id The pool registration id (not the tenant id).
          * @param {string} [authorization] Bearer Token
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -588,7 +608,8 @@ export const TestTenantPoolApiFactory = function (configuration?: Configuration,
             return localVarFp.deregister(id, authorization, options).then((request) => request(axios, basePath));
         },
         /**
-         * undefined  **Required Permissions**  \"tenant-management.tenants.view\"
+         * 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}
@@ -597,8 +618,9 @@ export const TestTenantPoolApiFactory = function (configuration?: Configuration,
             return localVarFp.getCleanupRegistry(authorization, options).then((request) => request(axios, basePath));
         },
         /**
-         * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
-         * @param {string} leaseId 
+         * 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}
@@ -607,7 +629,8 @@ export const TestTenantPoolApiFactory = function (configuration?: Configuration,
             return localVarFp.heartbeat(leaseId, authorization, options).then((request) => request(axios, basePath));
         },
         /**
-         * undefined  **Required Permissions**  \"tenant-management.tenants.create\"
+         * 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.
@@ -617,8 +640,9 @@ export const TestTenantPoolApiFactory = function (configuration?: Configuration,
             return localVarFp.register(registerPoolTenantRequestDto, authorization, options).then((request) => request(axios, basePath));
         },
         /**
-         * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
-         * @param {string} leaseId 
+         * 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}
@@ -627,8 +651,9 @@ export const TestTenantPoolApiFactory = function (configuration?: Configuration,
             return localVarFp.release(leaseId, authorization, options).then((request) => request(axios, basePath));
         },
         /**
-         * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
-         * @param {number} id 
+         * 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 {number} id The pool registration id (not the tenant id).
          * @param {string} [authorization] Bearer Token
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -637,7 +662,8 @@ export const TestTenantPoolApiFactory = function (configuration?: Configuration,
             return localVarFp.retriggerCleanup(id, authorization, options).then((request) => request(axios, basePath));
         },
         /**
-         * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
+         * 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.
@@ -647,8 +673,9 @@ export const TestTenantPoolApiFactory = function (configuration?: Configuration,
             return localVarFp.updateCleanupRegistry(cleanupRegistryRequestDto, authorization, options).then((request) => request(axios, basePath));
         },
         /**
-         * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
-         * @param {string} tenantSlug 
+         * 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.
@@ -688,7 +715,7 @@ export interface TestTenantPoolApiCheckoutRequest {
  */
 export interface TestTenantPoolApiDeregisterRequest {
     /**
-     * 
+     * The pool registration id (not the tenant id).
      * @type {number}
      * @memberof TestTenantPoolApiDeregister
      */
@@ -723,7 +750,7 @@ export interface TestTenantPoolApiGetCleanupRegistryRequest {
  */
 export interface TestTenantPoolApiHeartbeatRequest {
     /**
-     * 
+     * The lease id returned by checkout.
      * @type {string}
      * @memberof TestTenantPoolApiHeartbeat
      */
@@ -765,7 +792,7 @@ export interface TestTenantPoolApiRegisterRequest {
  */
 export interface TestTenantPoolApiReleaseRequest {
     /**
-     * 
+     * The lease id returned by checkout.
      * @type {string}
      * @memberof TestTenantPoolApiRelease
      */
@@ -786,7 +813,7 @@ export interface TestTenantPoolApiReleaseRequest {
  */
 export interface TestTenantPoolApiRetriggerCleanupRequest {
     /**
-     * 
+     * The pool registration id (not the tenant id).
      * @type {number}
      * @memberof TestTenantPoolApiRetriggerCleanup
      */
@@ -828,7 +855,7 @@ export interface TestTenantPoolApiUpdateCleanupRegistryRequest {
  */
 export interface TestTenantPoolApiUpdateTagsRequest {
     /**
-     * 
+     * The slug of the tenant it was registered under.
      * @type {string}
      * @memberof TestTenantPoolApiUpdateTags
      */
@@ -857,7 +884,8 @@ export interface TestTenantPoolApiUpdateTagsRequest {
  */
 export class TestTenantPoolApi extends BaseAPI {
     /**
-     * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
+     * 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}
@@ -868,7 +896,8 @@ export class TestTenantPoolApi extends BaseAPI {
     }
 
     /**
-     * undefined  **Required Permissions**  \"tenant-management.tenants.delete\"
+     * 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}
@@ -879,7 +908,8 @@ export class TestTenantPoolApi extends BaseAPI {
     }
 
     /**
-     * undefined  **Required Permissions**  \"tenant-management.tenants.view\"
+     * 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}
@@ -890,7 +920,8 @@ export class TestTenantPoolApi extends BaseAPI {
     }
 
     /**
-     * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
+     * 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}
@@ -901,7 +932,8 @@ export class TestTenantPoolApi extends BaseAPI {
     }
 
     /**
-     * undefined  **Required Permissions**  \"tenant-management.tenants.create\"
+     * 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}
@@ -912,7 +944,8 @@ export class TestTenantPoolApi extends BaseAPI {
     }
 
     /**
-     * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
+     * 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}
@@ -923,7 +956,8 @@ export class TestTenantPoolApi extends BaseAPI {
     }
 
     /**
-     * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
+     * 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}
@@ -934,7 +968,8 @@ export class TestTenantPoolApi extends BaseAPI {
     }
 
     /**
-     * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
+     * 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}
@@ -945,7 +980,8 @@ export class TestTenantPoolApi extends BaseAPI {
     }
 
     /**
-     * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
+     * 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}

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

@@ -25,7 +25,8 @@ import { UpdateTagsBodyDto } from '../models';
  */
 export declare const TestTenantPoolApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
-     * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
+     * 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.
@@ -33,30 +34,34 @@ export declare const TestTenantPoolApiAxiosParamCreator: (configuration?: Config
      */
     checkout: (checkoutRequestDto: CheckoutRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * undefined  **Required Permissions**  \"tenant-management.tenants.delete\"
-     * @param {number} id
+     * 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 {number} id The pool registration id (not the tenant 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\"
+     * 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>;
     /**
-     * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
-     * @param {string} leaseId
+     * 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>;
     /**
-     * undefined  **Required Permissions**  \"tenant-management.tenants.create\"
+     * 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.
@@ -64,23 +69,26 @@ export declare const TestTenantPoolApiAxiosParamCreator: (configuration?: Config
      */
     register: (registerPoolTenantRequestDto: RegisterPoolTenantRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
-     * @param {string} leaseId
+     * 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>;
     /**
-     * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
-     * @param {number} id
+     * 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 {number} id The pool registration id (not the tenant 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\"
+     * 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.
@@ -88,8 +96,9 @@ export declare const TestTenantPoolApiAxiosParamCreator: (configuration?: Config
      */
     updateCleanupRegistry: (cleanupRegistryRequestDto: CleanupRegistryRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
-     * @param {string} tenantSlug
+     * 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.
@@ -103,7 +112,8 @@ export declare const TestTenantPoolApiAxiosParamCreator: (configuration?: Config
  */
 export declare const TestTenantPoolApiFp: (configuration?: Configuration) => {
     /**
-     * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
+     * 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.
@@ -111,30 +121,34 @@ export declare const TestTenantPoolApiFp: (configuration?: Configuration) => {
      */
     checkout(checkoutRequestDto: CheckoutRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CheckoutResponseClass>>;
     /**
-     * undefined  **Required Permissions**  \"tenant-management.tenants.delete\"
-     * @param {number} id
+     * 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 {number} id The pool registration id (not the tenant 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\"
+     * 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>>;
     /**
-     * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
-     * @param {string} leaseId
+     * 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>>;
     /**
-     * undefined  **Required Permissions**  \"tenant-management.tenants.create\"
+     * 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.
@@ -142,23 +156,26 @@ export declare const TestTenantPoolApiFp: (configuration?: Configuration) => {
      */
     register(registerPoolTenantRequestDto: RegisterPoolTenantRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PoolTenantResponseClass>>;
     /**
-     * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
-     * @param {string} leaseId
+     * 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>>;
     /**
-     * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
-     * @param {number} id
+     * 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 {number} id The pool registration id (not the tenant 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\"
+     * 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.
@@ -166,8 +183,9 @@ export declare const TestTenantPoolApiFp: (configuration?: Configuration) => {
      */
     updateCleanupRegistry(cleanupRegistryRequestDto: CleanupRegistryRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CleanupRegistryResponseClass>>;
     /**
-     * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
-     * @param {string} tenantSlug
+     * 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.
@@ -181,7 +199,8 @@ export declare const TestTenantPoolApiFp: (configuration?: Configuration) => {
  */
 export declare const TestTenantPoolApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
-     * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
+     * 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.
@@ -189,30 +208,34 @@ export declare const TestTenantPoolApiFactory: (configuration?: Configuration, b
      */
     checkout(checkoutRequestDto: CheckoutRequestDto, authorization?: string, options?: any): AxiosPromise<CheckoutResponseClass>;
     /**
-     * undefined  **Required Permissions**  \"tenant-management.tenants.delete\"
-     * @param {number} id
+     * 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 {number} id The pool registration id (not the tenant 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\"
+     * 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>;
     /**
-     * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
-     * @param {string} leaseId
+     * 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>;
     /**
-     * undefined  **Required Permissions**  \"tenant-management.tenants.create\"
+     * 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.
@@ -220,23 +243,26 @@ export declare const TestTenantPoolApiFactory: (configuration?: Configuration, b
      */
     register(registerPoolTenantRequestDto: RegisterPoolTenantRequestDto, authorization?: string, options?: any): AxiosPromise<PoolTenantResponseClass>;
     /**
-     * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
-     * @param {string} leaseId
+     * 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>;
     /**
-     * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
-     * @param {number} id
+     * 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 {number} id The pool registration id (not the tenant 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\"
+     * 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.
@@ -244,8 +270,9 @@ export declare const TestTenantPoolApiFactory: (configuration?: Configuration, b
      */
     updateCleanupRegistry(cleanupRegistryRequestDto: CleanupRegistryRequestDto, authorization?: string, options?: any): AxiosPromise<CleanupRegistryResponseClass>;
     /**
-     * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
-     * @param {string} tenantSlug
+     * 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.
@@ -279,7 +306,7 @@ export interface TestTenantPoolApiCheckoutRequest {
  */
 export interface TestTenantPoolApiDeregisterRequest {
     /**
-     *
+     * The pool registration id (not the tenant id).
      * @type {number}
      * @memberof TestTenantPoolApiDeregister
      */
@@ -311,7 +338,7 @@ export interface TestTenantPoolApiGetCleanupRegistryRequest {
  */
 export interface TestTenantPoolApiHeartbeatRequest {
     /**
-     *
+     * The lease id returned by checkout.
      * @type {string}
      * @memberof TestTenantPoolApiHeartbeat
      */
@@ -349,7 +376,7 @@ export interface TestTenantPoolApiRegisterRequest {
  */
 export interface TestTenantPoolApiReleaseRequest {
     /**
-     *
+     * The lease id returned by checkout.
      * @type {string}
      * @memberof TestTenantPoolApiRelease
      */
@@ -368,7 +395,7 @@ export interface TestTenantPoolApiReleaseRequest {
  */
 export interface TestTenantPoolApiRetriggerCleanupRequest {
     /**
-     *
+     * The pool registration id (not the tenant id).
      * @type {number}
      * @memberof TestTenantPoolApiRetriggerCleanup
      */
@@ -406,7 +433,7 @@ export interface TestTenantPoolApiUpdateCleanupRegistryRequest {
  */
 export interface TestTenantPoolApiUpdateTagsRequest {
     /**
-     *
+     * The slug of the tenant it was registered under.
      * @type {string}
      * @memberof TestTenantPoolApiUpdateTags
      */
@@ -432,7 +459,8 @@ export interface TestTenantPoolApiUpdateTagsRequest {
  */
 export declare class TestTenantPoolApi extends BaseAPI {
     /**
-     * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
+     * 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}
@@ -440,7 +468,8 @@ export declare class TestTenantPoolApi extends BaseAPI {
      */
     checkout(requestParameters: TestTenantPoolApiCheckoutRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CheckoutResponseClass, any, {}>>;
     /**
-     * undefined  **Required Permissions**  \"tenant-management.tenants.delete\"
+     * 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}
@@ -448,7 +477,8 @@ export declare class TestTenantPoolApi extends BaseAPI {
      */
     deregister(requestParameters: TestTenantPoolApiDeregisterRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
     /**
-     * undefined  **Required Permissions**  \"tenant-management.tenants.view\"
+     * 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}
@@ -456,7 +486,8 @@ export declare class TestTenantPoolApi extends BaseAPI {
      */
     getCleanupRegistry(requestParameters?: TestTenantPoolApiGetCleanupRegistryRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CleanupRegistryResponseClass, any, {}>>;
     /**
-     * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
+     * 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}
@@ -464,7 +495,8 @@ export declare class TestTenantPoolApi extends BaseAPI {
      */
     heartbeat(requestParameters: TestTenantPoolApiHeartbeatRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CheckoutResponseClass, any, {}>>;
     /**
-     * undefined  **Required Permissions**  \"tenant-management.tenants.create\"
+     * 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}
@@ -472,7 +504,8 @@ export declare class TestTenantPoolApi extends BaseAPI {
      */
     register(requestParameters: TestTenantPoolApiRegisterRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PoolTenantResponseClass, any, {}>>;
     /**
-     * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
+     * 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}
@@ -480,7 +513,8 @@ export declare class TestTenantPoolApi extends BaseAPI {
      */
     release(requestParameters: TestTenantPoolApiReleaseRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
     /**
-     * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
+     * 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}
@@ -488,7 +522,8 @@ export declare class TestTenantPoolApi extends BaseAPI {
      */
     retriggerCleanup(requestParameters: TestTenantPoolApiRetriggerCleanupRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
     /**
-     * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
+     * 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}
@@ -496,7 +531,8 @@ export declare class TestTenantPoolApi extends BaseAPI {
      */
     updateCleanupRegistry(requestParameters: TestTenantPoolApiUpdateCleanupRegistryRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CleanupRegistryResponseClass, any, {}>>;
     /**
-     * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
+     * 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}

package/dist/api/test-tenant-pool-api.js

@@ -97,7 +97,8 @@ var TestTenantPoolApiAxiosParamCreator = function (configuration) {
     var _this = this;
     return {
         /**
-         * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
+         * 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.
@@ -145,8 +146,9 @@ var TestTenantPoolApiAxiosParamCreator = function (configuration) {
             });
         },
         /**
-         * undefined  **Required Permissions**  \"tenant-management.tenants.delete\"
-         * @param {number} id
+         * 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 {number} id The pool registration id (not the tenant id).
          * @param {string} [authorization] Bearer Token
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -192,7 +194,8 @@ var TestTenantPoolApiAxiosParamCreator = function (configuration) {
             });
         },
         /**
-         * undefined  **Required Permissions**  \"tenant-management.tenants.view\"
+         * 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}
@@ -235,8 +238,9 @@ var TestTenantPoolApiAxiosParamCreator = function (configuration) {
             });
         },
         /**
-         * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
-         * @param {string} leaseId
+         * 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}
@@ -282,7 +286,8 @@ var TestTenantPoolApiAxiosParamCreator = function (configuration) {
             });
         },
         /**
-         * undefined  **Required Permissions**  \"tenant-management.tenants.create\"
+         * 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.
@@ -330,8 +335,9 @@ var TestTenantPoolApiAxiosParamCreator = function (configuration) {
             });
         },
         /**
-         * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
-         * @param {string} leaseId
+         * 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}
@@ -377,8 +383,9 @@ var TestTenantPoolApiAxiosParamCreator = function (configuration) {
             });
         },
         /**
-         * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
-         * @param {number} id
+         * 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 {number} id The pool registration id (not the tenant id).
          * @param {string} [authorization] Bearer Token
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -424,7 +431,8 @@ var TestTenantPoolApiAxiosParamCreator = function (configuration) {
             });
         },
         /**
-         * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
+         * 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.
@@ -472,8 +480,9 @@ var TestTenantPoolApiAxiosParamCreator = function (configuration) {
             });
         },
         /**
-         * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
-         * @param {string} tenantSlug
+         * 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.
@@ -534,7 +543,8 @@ var TestTenantPoolApiFp = function (configuration) {
     var localVarAxiosParamCreator = (0, exports.TestTenantPoolApiAxiosParamCreator)(configuration);
     return {
         /**
-         * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
+         * 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.
@@ -554,8 +564,9 @@ var TestTenantPoolApiFp = function (configuration) {
             });
         },
         /**
-         * undefined  **Required Permissions**  \"tenant-management.tenants.delete\"
-         * @param {number} id
+         * 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 {number} id The pool registration id (not the tenant id).
          * @param {string} [authorization] Bearer Token
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -574,7 +585,8 @@ var TestTenantPoolApiFp = function (configuration) {
             });
         },
         /**
-         * undefined  **Required Permissions**  \"tenant-management.tenants.view\"
+         * 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}
@@ -593,8 +605,9 @@ var TestTenantPoolApiFp = function (configuration) {
             });
         },
         /**
-         * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
-         * @param {string} leaseId
+         * 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}
@@ -613,7 +626,8 @@ var TestTenantPoolApiFp = function (configuration) {
             });
         },
         /**
-         * undefined  **Required Permissions**  \"tenant-management.tenants.create\"
+         * 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.
@@ -633,8 +647,9 @@ var TestTenantPoolApiFp = function (configuration) {
             });
         },
         /**
-         * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
-         * @param {string} leaseId
+         * 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}
@@ -653,8 +668,9 @@ var TestTenantPoolApiFp = function (configuration) {
             });
         },
         /**
-         * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
-         * @param {number} id
+         * 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 {number} id The pool registration id (not the tenant id).
          * @param {string} [authorization] Bearer Token
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -673,7 +689,8 @@ var TestTenantPoolApiFp = function (configuration) {
             });
         },
         /**
-         * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
+         * 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.
@@ -693,8 +710,9 @@ var TestTenantPoolApiFp = function (configuration) {
             });
         },
         /**
-         * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
-         * @param {string} tenantSlug
+         * 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.
@@ -724,7 +742,8 @@ var TestTenantPoolApiFactory = function (configuration, basePath, axios) {
     var localVarFp = (0, exports.TestTenantPoolApiFp)(configuration);
     return {
         /**
-         * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
+         * 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.
@@ -734,8 +753,9 @@ var TestTenantPoolApiFactory = function (configuration, basePath, axios) {
             return localVarFp.checkout(checkoutRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
         },
         /**
-         * undefined  **Required Permissions**  \"tenant-management.tenants.delete\"
-         * @param {number} id
+         * 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 {number} id The pool registration id (not the tenant id).
          * @param {string} [authorization] Bearer Token
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -744,7 +764,8 @@ var TestTenantPoolApiFactory = function (configuration, basePath, axios) {
             return localVarFp.deregister(id, authorization, options).then(function (request) { return request(axios, basePath); });
         },
         /**
-         * undefined  **Required Permissions**  \"tenant-management.tenants.view\"
+         * 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}
@@ -753,8 +774,9 @@ var TestTenantPoolApiFactory = function (configuration, basePath, axios) {
             return localVarFp.getCleanupRegistry(authorization, options).then(function (request) { return request(axios, basePath); });
         },
         /**
-         * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
-         * @param {string} leaseId
+         * 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}
@@ -763,7 +785,8 @@ var TestTenantPoolApiFactory = function (configuration, basePath, axios) {
             return localVarFp.heartbeat(leaseId, authorization, options).then(function (request) { return request(axios, basePath); });
         },
         /**
-         * undefined  **Required Permissions**  \"tenant-management.tenants.create\"
+         * 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.
@@ -773,8 +796,9 @@ var TestTenantPoolApiFactory = function (configuration, basePath, axios) {
             return localVarFp.register(registerPoolTenantRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
         },
         /**
-         * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
-         * @param {string} leaseId
+         * 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}
@@ -783,8 +807,9 @@ var TestTenantPoolApiFactory = function (configuration, basePath, axios) {
             return localVarFp.release(leaseId, authorization, options).then(function (request) { return request(axios, basePath); });
         },
         /**
-         * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
-         * @param {number} id
+         * 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 {number} id The pool registration id (not the tenant id).
          * @param {string} [authorization] Bearer Token
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -793,7 +818,8 @@ var TestTenantPoolApiFactory = function (configuration, basePath, axios) {
             return localVarFp.retriggerCleanup(id, authorization, options).then(function (request) { return request(axios, basePath); });
         },
         /**
-         * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
+         * 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.
@@ -803,8 +829,9 @@ var TestTenantPoolApiFactory = function (configuration, basePath, axios) {
             return localVarFp.updateCleanupRegistry(cleanupRegistryRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
         },
         /**
-         * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
-         * @param {string} tenantSlug
+         * 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.
@@ -828,7 +855,8 @@ var TestTenantPoolApi = /** @class */ (function (_super) {
         return _super !== null && _super.apply(this, arguments) || this;
     }
     /**
-     * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
+     * 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}
@@ -839,7 +867,8 @@ var TestTenantPoolApi = /** @class */ (function (_super) {
         return (0, exports.TestTenantPoolApiFp)(this.configuration).checkout(requestParameters.checkoutRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
     };
     /**
-     * undefined  **Required Permissions**  \"tenant-management.tenants.delete\"
+     * 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}
@@ -850,7 +879,8 @@ var TestTenantPoolApi = /** @class */ (function (_super) {
         return (0, exports.TestTenantPoolApiFp)(this.configuration).deregister(requestParameters.id, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
     };
     /**
-     * undefined  **Required Permissions**  \"tenant-management.tenants.view\"
+     * 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}
@@ -862,7 +892,8 @@ var TestTenantPoolApi = /** @class */ (function (_super) {
         return (0, exports.TestTenantPoolApiFp)(this.configuration).getCleanupRegistry(requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
     };
     /**
-     * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
+     * 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}
@@ -873,7 +904,8 @@ var TestTenantPoolApi = /** @class */ (function (_super) {
         return (0, exports.TestTenantPoolApiFp)(this.configuration).heartbeat(requestParameters.leaseId, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
     };
     /**
-     * undefined  **Required Permissions**  \"tenant-management.tenants.create\"
+     * 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}
@@ -884,7 +916,8 @@ var TestTenantPoolApi = /** @class */ (function (_super) {
         return (0, exports.TestTenantPoolApiFp)(this.configuration).register(requestParameters.registerPoolTenantRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
     };
     /**
-     * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
+     * 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}
@@ -895,7 +928,8 @@ var TestTenantPoolApi = /** @class */ (function (_super) {
         return (0, exports.TestTenantPoolApiFp)(this.configuration).release(requestParameters.leaseId, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
     };
     /**
-     * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
+     * 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}
@@ -906,7 +940,8 @@ var TestTenantPoolApi = /** @class */ (function (_super) {
         return (0, exports.TestTenantPoolApiFp)(this.configuration).retriggerCleanup(requestParameters.id, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
     };
     /**
-     * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
+     * 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}
@@ -917,7 +952,8 @@ var TestTenantPoolApi = /** @class */ (function (_super) {
         return (0, exports.TestTenantPoolApiFp)(this.configuration).updateCleanupRegistry(requestParameters.cleanupRegistryRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
     };
     /**
-     * undefined  **Required Permissions**  \"tenant-management.tenants.update\"
+     * 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}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@emilgroup/tenant-sdk-node",
-  "version": "1.39.1-beta.28",
+  "version": "1.39.1-beta.29",
   "description": "OpenAPI client for @emilgroup/tenant-sdk-node",
   "author": "OpenAPI-Generator Contributors",
   "keywords": [