@rbaileysr/zephyr-managed-api 1.3.6 → 1.3.8

package/dist/groups/Private/PrivateExtendedData.js

@@ -0,0 +1,543 @@
+/*!
+ * Copyright Adaptavist 2025 (c) All rights reserved
+ */
+import { PrivateBase } from './PrivateBase';
+import { BadRequestError, UnauthorizedError, ForbiddenError, NotFoundError, ServerError, UnexpectedError, } from '../../utils';
+export class PrivateExtendedData extends PrivateBase {
+    constructor(apiConnection) {
+        super(apiConnection);
+    }
+    // ============================================================================
+    // Test Cycle Iteration Methods
+    // ============================================================================
+    /**
+     * Get test cycle iteration using private API
+     *
+     * Retrieves iteration data for a test cycle that is not available in the public API.
+     * Use this to supplement the public `getTestCycle()` response with iteration information.
+     *
+     * ⚠️ WARNING: This uses a private Zephyr API endpoint that is not officially supported.
+     * The endpoint may change or be removed at any time without notice.
+     *
+     * @param credentials - Private API credentials
+     * @param request - Get test cycle iteration request
+     * @param request.testCycleKey - Test cycle key (e.g., "M12-R1")
+     * @param request.projectId - Jira project ID (numeric, not the project key)
+     * @returns Test cycle iteration response with iterationId (null if not set)
+     * @throws {BadRequestError} If the request is invalid
+     * @throws {UnauthorizedError} If authentication fails
+     * @throws {ForbiddenError} If the user doesn't have permission
+     * @throws {NotFoundError} If the test cycle is not found
+     * @throws {ServerError} If the server returns an error
+     *
+     * @example
+     * ```typescript
+     * // Get iteration for a test cycle (supplements public getTestCycle)
+     * const publicData = await api.TestCycle.getTestCycle({ key: 'M12-R1' });
+     * const iterationData = await api.Private.IterationData.getTestCycleIteration(credentials, {
+     *   testCycleKey: 'M12-R1',
+     *   projectId: 10313
+     * });
+     * console.log('Iteration ID:', iterationData.iterationId);
+     * ```
+     */
+    async getTestCycleIteration(credentials, request) {
+        // Get Context JWT
+        const contextJwt = await this.getContextJwt(credentials);
+        // Build URL with minimal fields needed
+        const fields = 'id,key,iterationId';
+        const url = `${this.privateApiBaseUrl}/testrun/${request.testCycleKey}?fields=${encodeURIComponent(fields)}`;
+        const headers = {
+            accept: 'application/json',
+            authorization: `JWT ${contextJwt}`,
+            'jira-project-id': String(request.projectId),
+        };
+        try {
+            const response = await fetch(url, {
+                method: 'GET',
+                headers,
+            });
+            if (!response.ok) {
+                if (response.status === 400) {
+                    throw new BadRequestError(`Invalid request parameters for getting test cycle iteration.`);
+                }
+                if (response.status === 401) {
+                    throw new UnauthorizedError('Failed to authenticate. Please check your credentials.');
+                }
+                if (response.status === 403) {
+                    throw new ForbiddenError('Insufficient permissions to get test cycle iteration.');
+                }
+                if (response.status === 404) {
+                    throw new NotFoundError(`Test cycle '${request.testCycleKey}' not found.`);
+                }
+                throw new ServerError(`Failed to get test cycle iteration. Status: ${response.status}`, response.status, response.statusText);
+            }
+            const data = (await response.json());
+            return {
+                id: data.id,
+                key: data.key,
+                iterationId: data.iterationId ?? null,
+            };
+        }
+        catch (error) {
+            if (error instanceof BadRequestError ||
+                error instanceof UnauthorizedError ||
+                error instanceof ForbiddenError ||
+                error instanceof NotFoundError ||
+                error instanceof ServerError ||
+                error instanceof UnexpectedError) {
+                throw error;
+            }
+            throw new UnexpectedError(`Unexpected error while getting test cycle iteration for '${request.testCycleKey}'`, error);
+        }
+    }
+    /**
+     * Update test cycle iteration using private API
+     *
+     * Sets or clears the iteration for a test cycle. Use this to supplement
+     * a test cycle created via the public API with iteration data.
+     *
+     * ⚠️ WARNING: This uses a private Zephyr API endpoint that is not officially supported.
+     * The endpoint may change or be removed at any time without notice.
+     *
+     * @param credentials - Private API credentials
+     * @param request - Update test cycle iteration request
+     * @param request.testCycleKey - Test cycle key (e.g., "M12-R1")
+     * @param request.projectId - Jira project ID (numeric, not the project key)
+     * @param request.iterationId - Iteration ID to set, or null to clear
+     * @throws {BadRequestError} If the request is invalid
+     * @throws {UnauthorizedError} If authentication fails
+     * @throws {ForbiddenError} If the user doesn't have permission
+     * @throws {NotFoundError} If the test cycle is not found
+     * @throws {ServerError} If the server returns an error
+     *
+     * @example
+     * ```typescript
+     * // Create test cycle with public API, then set iteration with private API
+     * const testCycle = await api.TestCycle.createTestCycle({
+     *   projectKey: 'M12',
+     *   name: 'Sprint 1 Testing'
+     * });
+     *
+     * // Set iteration using private API
+     * await api.Private.IterationData.updateTestCycleIteration(credentials, {
+     *   testCycleKey: testCycle.key,
+     *   projectId: 10313,
+     *   iterationId: 10952254
+     * });
+     * ```
+     */
+    async updateTestCycleIteration(credentials, request) {
+        // Get Context JWT
+        const contextJwt = await this.getContextJwt(credentials);
+        // First, get the numeric ID for the test cycle
+        const testCycleData = await this.getTestCycleIteration(credentials, {
+            testCycleKey: request.testCycleKey,
+            projectId: request.projectId,
+        });
+        // Build URL with numeric ID
+        const url = `${this.privateApiBaseUrl}/testrun/${testCycleData.id}`;
+        const headers = {
+            'Content-Type': 'application/json',
+            accept: 'application/json',
+            authorization: `JWT ${contextJwt}`,
+            'jira-project-id': String(request.projectId),
+        };
+        const requestBody = {
+            id: testCycleData.id,
+            projectId: request.projectId,
+            iterationId: request.iterationId,
+        };
+        try {
+            const response = await fetch(url, {
+                method: 'PUT',
+                headers,
+                body: JSON.stringify(requestBody),
+            });
+            if (!response.ok) {
+                if (response.status === 400) {
+                    throw new BadRequestError(`Invalid request parameters for updating test cycle iteration.`);
+                }
+                if (response.status === 401) {
+                    throw new UnauthorizedError('Failed to authenticate. Please check your credentials.');
+                }
+                if (response.status === 403) {
+                    throw new ForbiddenError('Insufficient permissions to update test cycle iteration.');
+                }
+                if (response.status === 404) {
+                    throw new NotFoundError(`Test cycle '${request.testCycleKey}' not found.`);
+                }
+                throw new ServerError(`Failed to update test cycle iteration. Status: ${response.status}`, response.status, response.statusText);
+            }
+            // Response is empty on success
+        }
+        catch (error) {
+            if (error instanceof BadRequestError ||
+                error instanceof UnauthorizedError ||
+                error instanceof ForbiddenError ||
+                error instanceof NotFoundError ||
+                error instanceof ServerError ||
+                error instanceof UnexpectedError) {
+                throw error;
+            }
+            throw new UnexpectedError(`Unexpected error while updating test cycle iteration for '${request.testCycleKey}'`, error);
+        }
+    }
+    // ============================================================================
+    // Test Execution Iteration Methods
+    // ============================================================================
+    /**
+     * Get test execution iteration using private API
+     *
+     * Retrieves iteration data for a test execution that is not available in the public API.
+     * Use this to supplement the public `getTestExecution()` response with iteration information.
+     *
+     * ⚠️ WARNING: This uses a private Zephyr API endpoint that is not officially supported.
+     * The endpoint may change or be removed at any time without notice.
+     *
+     * @param credentials - Private API credentials
+     * @param request - Get test execution iteration request
+     * @param request.testExecutionKey - Test execution key (e.g., "M12-E1")
+     * @param request.projectId - Jira project ID (numeric, not the project key)
+     * @returns Test execution iteration response with iterationId (null if not set)
+     * @throws {BadRequestError} If the request is invalid
+     * @throws {UnauthorizedError} If authentication fails
+     * @throws {ForbiddenError} If the user doesn't have permission
+     * @throws {NotFoundError} If the test execution is not found
+     * @throws {ServerError} If the server returns an error
+     *
+     * @example
+     * ```typescript
+     * // Get iteration for a test execution (supplements public getTestExecution)
+     * const publicData = await api.TestExecution.getTestExecution({ key: 'M12-E1' });
+     * const iterationData = await api.Private.IterationData.getTestExecutionIteration(credentials, {
+     *   testExecutionKey: 'M12-E1',
+     *   projectId: 10313
+     * });
+     * console.log('Iteration ID:', iterationData.iterationId);
+     * ```
+     */
+    async getTestExecutionIteration(credentials, request) {
+        // Get Context JWT
+        const contextJwt = await this.getContextJwt(credentials);
+        // Build URL with minimal fields needed
+        const fields = 'id,key,iterationId';
+        const url = `${this.privateApiBaseUrl}/testresult/${request.testExecutionKey}?fields=${encodeURIComponent(fields)}&itemId=${request.testExecutionKey}`;
+        const headers = {
+            accept: 'application/json',
+            authorization: `JWT ${contextJwt}`,
+            'jira-project-id': String(request.projectId),
+        };
+        try {
+            const response = await fetch(url, {
+                method: 'GET',
+                headers,
+            });
+            if (!response.ok) {
+                if (response.status === 400) {
+                    throw new BadRequestError(`Invalid request parameters for getting test execution iteration.`);
+                }
+                if (response.status === 401) {
+                    throw new UnauthorizedError('Failed to authenticate. Please check your credentials.');
+                }
+                if (response.status === 403) {
+                    throw new ForbiddenError('Insufficient permissions to get test execution iteration.');
+                }
+                if (response.status === 404) {
+                    throw new NotFoundError(`Test execution '${request.testExecutionKey}' not found.`);
+                }
+                throw new ServerError(`Failed to get test execution iteration. Status: ${response.status}`, response.status, response.statusText);
+            }
+            const data = (await response.json());
+            return {
+                id: data.id,
+                key: data.key,
+                iterationId: data.iterationId ?? null,
+            };
+        }
+        catch (error) {
+            if (error instanceof BadRequestError ||
+                error instanceof UnauthorizedError ||
+                error instanceof ForbiddenError ||
+                error instanceof NotFoundError ||
+                error instanceof ServerError ||
+                error instanceof UnexpectedError) {
+                throw error;
+            }
+            throw new UnexpectedError(`Unexpected error while getting test execution iteration for '${request.testExecutionKey}'`, error);
+        }
+    }
+    /**
+     * Update test execution iteration using private API
+     *
+     * Sets or clears the iteration for a test execution. Use this to supplement
+     * a test execution created via the public API with iteration data.
+     *
+     * ⚠️ WARNING: This uses a private Zephyr API endpoint that is not officially supported.
+     * The endpoint may change or be removed at any time without notice.
+     *
+     * @param credentials - Private API credentials
+     * @param request - Update test execution iteration request
+     * @param request.testExecutionKey - Test execution key (e.g., "M12-E1")
+     * @param request.projectId - Jira project ID (numeric, not the project key)
+     * @param request.iterationId - Iteration ID to set, or null to clear
+     * @throws {BadRequestError} If the request is invalid
+     * @throws {UnauthorizedError} If authentication fails
+     * @throws {ForbiddenError} If the user doesn't have permission
+     * @throws {NotFoundError} If the test execution is not found
+     * @throws {ServerError} If the server returns an error
+     *
+     * @example
+     * ```typescript
+     * // Create test execution with public API (returns void), then set iteration with private API
+     * await api.TestExecution.createTestExecution({
+     *   projectKey: 'M12',
+     *   testCaseKey: 'M12-T1',
+     *   testCycleKey: 'M12-R1',
+     *   statusName: 'Pass'
+     * });
+     *
+     * // Note: createTestExecution returns no data, so use known key or look up after creation
+     * // Set iteration using private API
+     * await api.Private.IterationData.updateTestExecutionIteration(credentials, {
+     *   testExecutionKey: 'M12-E1', // Use known key or look up via listTestExecutions()
+     *   projectId: 10313,
+     *   iterationId: 10952254
+     * });
+     * ```
+     */
+    async updateTestExecutionIteration(credentials, request) {
+        // Get Context JWT
+        const contextJwt = await this.getContextJwt(credentials);
+        // First, get the numeric ID for the test execution
+        const testExecutionData = await this.getTestExecutionIteration(credentials, {
+            testExecutionKey: request.testExecutionKey,
+            projectId: request.projectId,
+        });
+        // Build URL with numeric ID
+        const url = `${this.privateApiBaseUrl}/testresult/${testExecutionData.id}`;
+        const headers = {
+            'Content-Type': 'application/json',
+            accept: 'application/json',
+            authorization: `JWT ${contextJwt}`,
+            'jira-project-id': String(request.projectId),
+        };
+        const requestBody = {
+            id: testExecutionData.id,
+            iterationId: request.iterationId,
+        };
+        try {
+            const response = await fetch(url, {
+                method: 'PUT',
+                headers,
+                body: JSON.stringify(requestBody),
+            });
+            if (!response.ok) {
+                if (response.status === 400) {
+                    throw new BadRequestError(`Invalid request parameters for updating test execution iteration.`);
+                }
+                if (response.status === 401) {
+                    throw new UnauthorizedError('Failed to authenticate. Please check your credentials.');
+                }
+                if (response.status === 403) {
+                    throw new ForbiddenError('Insufficient permissions to update test execution iteration.');
+                }
+                if (response.status === 404) {
+                    throw new NotFoundError(`Test execution '${request.testExecutionKey}' not found.`);
+                }
+                throw new ServerError(`Failed to update test execution iteration. Status: ${response.status}`, response.status, response.statusText);
+            }
+            // Response is empty on success
+        }
+        catch (error) {
+            if (error instanceof BadRequestError ||
+                error instanceof UnauthorizedError ||
+                error instanceof ForbiddenError ||
+                error instanceof NotFoundError ||
+                error instanceof ServerError ||
+                error instanceof UnexpectedError) {
+                throw error;
+            }
+            throw new UnexpectedError(`Unexpected error while updating test execution iteration for '${request.testExecutionKey}'`, error);
+        }
+    }
+    // ============================================================================
+    // Test Execution Version Methods
+    // ============================================================================
+    /**
+     * Get test execution version using private API
+     *
+     * Retrieves Jira version ID (release version) for a test execution that is not available in the public API.
+     * Use this to supplement the public `getTestExecution()` response with version information.
+     *
+     * ⚠️ WARNING: This uses a private Zephyr API endpoint that is not officially supported.
+     * The endpoint may change or be removed at any time without notice.
+     *
+     * @param credentials - Private API credentials
+     * @param request - Get test execution version request
+     * @param request.testExecutionKey - Test execution key (e.g., "M15-E3")
+     * @param request.projectId - Jira project ID (numeric, not the project key)
+     * @returns Test execution version response with jiraVersionId (null if not set)
+     * @throws {BadRequestError} If the request is invalid
+     * @throws {UnauthorizedError} If authentication fails
+     * @throws {ForbiddenError} If the user doesn't have permission
+     * @throws {NotFoundError} If the test execution is not found
+     * @throws {ServerError} If the server returns an error
+     *
+     * @example
+     * ```typescript
+     * // Get version for a test execution (supplements public getTestExecution)
+     * const publicData = await api.TestExecution.getTestExecution({ key: 'M15-E3' });
+     * const versionData = await api.Private.IterationData.getTestExecutionVersion(credentials, {
+     *   testExecutionKey: 'M15-E3',
+     *   projectId: 10316
+     * });
+     * console.log('Jira Version ID:', versionData.jiraVersionId);
+     * ```
+     */
+    async getTestExecutionVersion(credentials, request) {
+        // Get Context JWT
+        const contextJwt = await this.getContextJwt(credentials);
+        // Build URL with minimal fields needed (jiraVersionId is included in the fields)
+        const fields = 'id,key,jiraVersionId';
+        const url = `${this.privateApiBaseUrl}/testresult/${request.testExecutionKey}?fields=${encodeURIComponent(fields)}&itemId=${request.testExecutionKey}`;
+        const headers = {
+            accept: 'application/json',
+            authorization: `JWT ${contextJwt}`,
+            'jira-project-id': String(request.projectId),
+        };
+        try {
+            const response = await fetch(url, {
+                method: 'GET',
+                headers,
+            });
+            if (!response.ok) {
+                if (response.status === 400) {
+                    throw new BadRequestError(`Invalid request parameters for getting test execution version.`);
+                }
+                if (response.status === 401) {
+                    throw new UnauthorizedError('Failed to authenticate. Please check your credentials.');
+                }
+                if (response.status === 403) {
+                    throw new ForbiddenError('Insufficient permissions to get test execution version.');
+                }
+                if (response.status === 404) {
+                    throw new NotFoundError(`Test execution '${request.testExecutionKey}' not found.`);
+                }
+                throw new ServerError(`Failed to get test execution version. Status: ${response.status}`, response.status, response.statusText);
+            }
+            const data = (await response.json());
+            return {
+                id: data.id,
+                key: data.key,
+                // jiraVersionId is excluded from response if not set, so use null if undefined
+                jiraVersionId: data.jiraVersionId ?? null,
+            };
+        }
+        catch (error) {
+            if (error instanceof BadRequestError ||
+                error instanceof UnauthorizedError ||
+                error instanceof ForbiddenError ||
+                error instanceof NotFoundError ||
+                error instanceof ServerError ||
+                error instanceof UnexpectedError) {
+                throw error;
+            }
+            throw new UnexpectedError(`Unexpected error while getting test execution version for '${request.testExecutionKey}'`, error);
+        }
+    }
+    /**
+     * Update test execution version using private API
+     *
+     * Sets or clears the Jira version ID (release version) for a test execution. Use this to supplement
+     * a test execution created via the public API with version data.
+     *
+     * ⚠️ WARNING: This uses a private Zephyr API endpoint that is not officially supported.
+     * The endpoint may change or be removed at any time without notice.
+     *
+     * @param credentials - Private API credentials
+     * @param request - Update test execution version request
+     * @param request.testExecutionKey - Test execution key (e.g., "M15-E3")
+     * @param request.projectId - Jira project ID (numeric, not the project key)
+     * @param request.jiraVersionId - Jira version ID to set, or null to clear
+     * @throws {BadRequestError} If the request is invalid
+     * @throws {UnauthorizedError} If authentication fails
+     * @throws {ForbiddenError} If the user doesn't have permission
+     * @throws {NotFoundError} If the test execution is not found
+     * @throws {ServerError} If the server returns an error
+     *
+     * @example
+     * ```typescript
+     * // Create test execution with public API (returns void), then set version with private API
+     * await api.TestExecution.createTestExecution({
+     *   projectKey: 'M15',
+     *   testCaseKey: 'M15-T3',
+     *   testCycleKey: 'M15-R1',
+     *   statusName: 'Pass'
+     * });
+     *
+     * // Note: createTestExecution returns no data, so use known key or look up after creation
+     * // Set version using private API
+     * await api.Private.IterationData.updateTestExecutionVersion(credentials, {
+     *   testExecutionKey: 'M15-E3', // Use known key or look up via listTestExecutions()
+     *   projectId: 10316,
+     *   jiraVersionId: 10102
+     * });
+     * ```
+     */
+    async updateTestExecutionVersion(credentials, request) {
+        // Get Context JWT
+        const contextJwt = await this.getContextJwt(credentials);
+        // First, get the numeric ID for the test execution
+        const testExecutionData = await this.getTestExecutionVersion(credentials, {
+            testExecutionKey: request.testExecutionKey,
+            projectId: request.projectId,
+        });
+        // Build URL with numeric ID
+        const url = `${this.privateApiBaseUrl}/testresult/${testExecutionData.id}`;
+        const headers = {
+            'Content-Type': 'application/json',
+            accept: 'application/json',
+            authorization: `JWT ${contextJwt}`,
+            'jira-project-id': String(request.projectId),
+        };
+        const requestBody = {
+            id: testExecutionData.id,
+            jiraVersionId: request.jiraVersionId,
+        };
+        try {
+            const response = await fetch(url, {
+                method: 'PUT',
+                headers,
+                body: JSON.stringify(requestBody),
+            });
+            if (!response.ok) {
+                if (response.status === 400) {
+                    throw new BadRequestError(`Invalid request parameters for updating test execution version.`);
+                }
+                if (response.status === 401) {
+                    throw new UnauthorizedError('Failed to authenticate. Please check your credentials.');
+                }
+                if (response.status === 403) {
+                    throw new ForbiddenError('Insufficient permissions to update test execution version.');
+                }
+                if (response.status === 404) {
+                    throw new NotFoundError(`Test execution '${request.testExecutionKey}' not found.`);
+                }
+                throw new ServerError(`Failed to update test execution version. Status: ${response.status}`, response.status, response.statusText);
+            }
+            // Response is empty on success
+        }
+        catch (error) {
+            if (error instanceof BadRequestError ||
+                error instanceof UnauthorizedError ||
+                error instanceof ForbiddenError ||
+                error instanceof NotFoundError ||
+                error instanceof ServerError ||
+                error instanceof UnexpectedError) {
+                throw error;
+            }
+            throw new UnexpectedError(`Unexpected error while updating test execution version for '${request.testExecutionKey}'`, error);
+        }
+    }
+}

package/dist/groups/Private/PrivateTestCaseArchiving.d.ts

@@ -0,0 +1,123 @@
+/*!
+ * Copyright Adaptavist 2025 (c) All rights reserved
+ */
+/**
+ * Private API Test Case Archiving sub-group
+ * Provides functionality to list, archive, and unarchive test cases
+ *
+ * ⚠️ WARNING: These methods use private APIs that are not officially supported.
+ */
+import type { PrivateApiCredentials, GetArchivedTestCasesRequest, PrivateArchivedTestCaseSearchResponse, ArchiveTestCasesRequest, UnarchiveTestCasesRequest } from '../../types';
+import type { ZephyrApiConnection } from '../../index';
+import { PrivateBase } from './PrivateBase';
+export declare class PrivateTestCaseArchiving extends PrivateBase {
+    constructor(apiConnection?: ZephyrApiConnection);
+    /**
+     * Get archived test cases using private API
+     *
+     * Retrieves a paginated list of archived test cases for a project.
+     * The archived flag is not available in the public API, so this method
+     * provides access to archived test cases.
+     *
+     * ⚠️ WARNING: This uses a private Zephyr API endpoint that is not officially supported.
+     * The endpoint may change or be removed at any time without notice.
+     *
+     * @param credentials - Private API credentials
+     * @param request - Get archived test cases request
+     * @param request.projectId - Jira project ID (numeric, not the project key)
+     * @param request.maxResults - Maximum number of results to return (default: 50)
+     * @param request.startAt - Zero-indexed starting position (default: 0)
+     * @param request.query - Optional query string for filtering (e.g., "testCase.name CONTAINS 'test'")
+     * @returns Paginated list of archived test cases
+     * @throws {BadRequestError} If the request is invalid
+     * @throws {UnauthorizedError} If authentication fails
+     * @throws {ForbiddenError} If the user doesn't have permission
+     * @throws {ServerError} If the server returns an error
+     *
+     * @example
+     * ```typescript
+     * // Get first page of archived test cases
+     * const archived = await api.Private.TestCaseArchiving.getArchivedTestCases(credentials, {
+     *   projectId: 10316,
+     *   maxResults: 50,
+     *   startAt: 0
+     * });
+     *
+     * // Get archived test cases with custom query
+     * const filtered = await api.Private.TestCaseArchiving.getArchivedTestCases(credentials, {
+     *   projectId: 10316,
+     *   query: "testCase.name CONTAINS 'migration'"
+     * });
+     * ```
+     */
+    getArchivedTestCases(credentials: PrivateApiCredentials, request: GetArchivedTestCasesRequest): Promise<PrivateArchivedTestCaseSearchResponse>;
+    /**
+     * Archive test cases using private API
+     *
+     * Archives one or more test cases. This is a bulk operation that accepts
+     * an array of test case IDs.
+     *
+     * ⚠️ WARNING: This uses a private Zephyr API endpoint that is not officially supported.
+     * The endpoint may change or be removed at any time without notice.
+     *
+     * @param credentials - Private API credentials
+     * @param request - Archive test cases request
+     * @param request.projectId - Jira project ID (numeric, not the project key)
+     * @param request.testCaseIds - Array of test case IDs to archive
+     * @throws {BadRequestError} If the request is invalid
+     * @throws {UnauthorizedError} If authentication fails
+     * @throws {ForbiddenError} If the user doesn't have permission
+     * @throws {ServerError} If the server returns an error
+     *
+     * @example
+     * ```typescript
+     * // Archive a single test case
+     * await api.Private.TestCaseArchiving.archiveTestCases(credentials, {
+     *   projectId: 10316,
+     *   testCaseIds: [288004503]
+     * });
+     *
+     * // Archive multiple test cases
+     * await api.Private.TestCaseArchiving.archiveTestCases(credentials, {
+     *   projectId: 10316,
+     *   testCaseIds: [288004503, 288004504, 288004505]
+     * });
+     * ```
+     */
+    archiveTestCases(credentials: PrivateApiCredentials, request: ArchiveTestCasesRequest): Promise<void>;
+    /**
+     * Unarchive test cases using private API
+     *
+     * Unarchives one or more test cases. This is a bulk operation that accepts
+     * an array of test case IDs.
+     *
+     * ⚠️ WARNING: This uses a private Zephyr API endpoint that is not officially supported.
+     * The endpoint may change or be removed at any time without notice.
+     *
+     * @param credentials - Private API credentials
+     * @param request - Unarchive test cases request
+     * @param request.projectId - Jira project ID (numeric, not the project key)
+     * @param request.testCaseIds - Array of test case IDs to unarchive
+     * @throws {BadRequestError} If the request is invalid
+     * @throws {UnauthorizedError} If authentication fails
+     * @throws {ForbiddenError} If the user doesn't have permission
+     * @throws {ServerError} If the server returns an error
+     *
+     * @example
+     * ```typescript
+     * // Unarchive a single test case
+     * await api.Private.TestCaseArchiving.unarchiveTestCases(credentials, {
+     *   projectId: 10316,
+     *   testCaseIds: [288004503]
+     * });
+     *
+     * // Unarchive multiple test cases
+     * await api.Private.TestCaseArchiving.unarchiveTestCases(credentials, {
+     *   projectId: 10316,
+     *   testCaseIds: [288004503, 288004504, 288004505]
+     * });
+     * ```
+     */
+    unarchiveTestCases(credentials: PrivateApiCredentials, request: UnarchiveTestCasesRequest): Promise<void>;
+}
+//# sourceMappingURL=PrivateTestCaseArchiving.d.ts.map

package/dist/groups/Private/PrivateTestCaseArchiving.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PrivateTestCaseArchiving.d.ts","sourceRoot":"","sources":["../../../groups/Private/PrivateTestCaseArchiving.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;;;;GAKG;AAEH,OAAO,KAAK,EACX,qBAAqB,EACrB,2BAA2B,EAC3B,qCAAqC,EACrC,uBAAuB,EACvB,yBAAyB,EACzB,MAAM,aAAa,CAAC;AACrB,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AACvD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAU5C,qBAAa,wBAAyB,SAAQ,WAAW;gBAC5C,aAAa,CAAC,EAAE,mBAAmB;IAI/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACG,oBAAoB,CACzB,WAAW,EAAE,qBAAqB,EAClC,OAAO,EAAE,2BAA2B,GAClC,OAAO,CAAC,qCAAqC,CAAC;IAyEjD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACG,gBAAgB,CACrB,WAAW,EAAE,qBAAqB,EAClC,OAAO,EAAE,uBAAuB,GAC9B,OAAO,CAAC,IAAI,CAAC;IAkEhB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACG,kBAAkB,CACvB,WAAW,EAAE,qBAAqB,EAClC,OAAO,EAAE,yBAAyB,GAChC,OAAO,CAAC,IAAI,CAAC;CAiEhB"}