@rbaileysr/zephyr-managed-api 1.3.5 → 1.3.7

package/dist/groups/Private/PrivateConfig.js

@@ -16,46 +16,62 @@ export class PrivateConfig extends PrivateBase {
         this.DataSets = new PrivateDataSets(apiConnection);
     }
     /**
-     * Archive a config item (Environment or Iteration) using private API
+     * Archive a config item using private API
      *
-     * Archives an Environment or Iteration by setting its `isArchived` flag to `true`.
+     * Archives a config item (Environment, Iteration, or Status) by setting its `isArchived` flag to `true`.
+     *
+     * Supported config types:
+     * - 'Environment' - Archive an environment
+     * - 'Iteration' - Archive an iteration
+     * - 'TestCaseStatus' - Archive a test case status
+     * - 'TestPlanStatus' - Archive a test plan status
+     * - 'TestCycleStatus' - Archive a test cycle status
+     * - 'TestExecutionStatus' - Archive a test execution status
      *
      * ⚠️ 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 config request
-     * @param request.type - Type of config item: 'Environment' or 'Iteration'
-     * @param request.id - Numeric ID of the environment or iteration to archive
+     * @param request.type - Type of config item: 'Environment', 'Iteration', 'TestCaseStatus', 'TestPlanStatus', 'TestCycleStatus', or 'TestExecutionStatus'
+     * @param request.id - Numeric ID of the config item to archive
      * @param request.projectId - Jira project ID (numeric, not the project key)
      * @returns Archive response with the ID of the archived item
      * @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 environment or iteration is not found
+     * @throws {NotFoundError} If the config item is not found
      * @throws {ServerError} If the server returns an error
      */
     async archiveConfig(credentials, request) {
         return this.updateArchiveStatus(credentials, request, true);
     }
     /**
-     * Unarchive a config item (Environment or Iteration) using private API
+     * Unarchive a config item using private API
+     *
+     * Unarchives a config item (Environment, Iteration, or Status) by setting its `isArchived` flag to `false`.
      *
-     * Unarchives an Environment or Iteration by setting its `isArchived` flag to `false`.
+     * Supported config types:
+     * - 'Environment' - Unarchive an environment
+     * - 'Iteration' - Unarchive an iteration
+     * - 'TestCaseStatus' - Unarchive a test case status
+     * - 'TestPlanStatus' - Unarchive a test plan status
+     * - 'TestCycleStatus' - Unarchive a test cycle status
+     * - 'TestExecutionStatus' - Unarchive a test execution status
      *
      * ⚠️ 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 config request (same interface as archive, but sets isArchived to false)
-     * @param request.type - Type of config item: 'Environment' or 'Iteration'
-     * @param request.id - Numeric ID of the environment or iteration to unarchive
+     * @param request.type - Type of config item: 'Environment', 'Iteration', 'TestCaseStatus', 'TestPlanStatus', 'TestCycleStatus', or 'TestExecutionStatus'
+     * @param request.id - Numeric ID of the config item to unarchive
      * @param request.projectId - Jira project ID (numeric, not the project key)
      * @returns Archive response with the ID of the unarchived item
      * @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 environment or iteration is not found
+     * @throws {NotFoundError} If the config item is not found
      * @throws {ServerError} If the server returns an error
      */
     async unarchiveConfig(credentials, request) {
@@ -67,8 +83,16 @@ export class PrivateConfig extends PrivateBase {
     async updateArchiveStatus(credentials, request, isArchived) {
         // Get Context JWT
         const contextJwt = await this.getContextJwt(credentials);
-        // Determine endpoint based on type
-        const endpoint = request.type.toLowerCase(); // 'environment' or 'iteration'
+        // Map config type to endpoint path
+        const endpointMap = {
+            Environment: 'environment',
+            Iteration: 'iteration',
+            TestCaseStatus: 'testcasestatus',
+            TestPlanStatus: 'testplanstatus',
+            TestCycleStatus: 'testrunstatus',
+            TestExecutionStatus: 'testresultstatus',
+        };
+        const endpoint = endpointMap[request.type];
         const url = `${this.privateApiBaseUrl}/${endpoint}/${request.id}`;
         const headers = {
             'Content-Type': 'application/json',

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

@@ -0,0 +1,157 @@
+/*!
+ * Copyright Adaptavist 2025 (c) All rights reserved
+ */
+/**
+ * Private API Iteration Data sub-group
+ * Supplements public API with iteration data for Test Cycles and Test Executions
+ *
+ * ⚠️ WARNING: These methods use private APIs that are not officially supported.
+ */
+import type { PrivateApiCredentials, GetTestCycleIterationRequest, TestCycleIterationResponse, UpdateTestCycleIterationRequest, GetTestExecutionIterationRequest, TestExecutionIterationResponse, UpdateTestExecutionIterationRequest } from '../../types';
+import type { ZephyrApiConnection } from '../../index';
+import { PrivateBase } from './PrivateBase';
+export declare class PrivateIterationData extends PrivateBase {
+    constructor(apiConnection?: ZephyrApiConnection);
+    /**
+     * 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);
+     * ```
+     */
+    getTestCycleIteration(credentials: PrivateApiCredentials, request: GetTestCycleIterationRequest): Promise<TestCycleIterationResponse>;
+    /**
+     * 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
+     * });
+     * ```
+     */
+    updateTestCycleIteration(credentials: PrivateApiCredentials, request: UpdateTestCycleIterationRequest): Promise<void>;
+    /**
+     * 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);
+     * ```
+     */
+    getTestExecutionIteration(credentials: PrivateApiCredentials, request: GetTestExecutionIterationRequest): Promise<TestExecutionIterationResponse>;
+    /**
+     * 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
+     * });
+     * ```
+     */
+    updateTestExecutionIteration(credentials: PrivateApiCredentials, request: UpdateTestExecutionIterationRequest): Promise<void>;
+}
+//# sourceMappingURL=PrivateIterationData.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"PrivateIterationData.d.ts","sourceRoot":"","sources":["../../../groups/Private/PrivateIterationData.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;;;;GAKG;AAEH,OAAO,KAAK,EACX,qBAAqB,EACrB,4BAA4B,EAC5B,0BAA0B,EAC1B,+BAA+B,EAC/B,gCAAgC,EAChC,8BAA8B,EAC9B,mCAAmC,EACnC,MAAM,aAAa,CAAC;AACrB,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AACvD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AA8B5C,qBAAa,oBAAqB,SAAQ,WAAW;gBACxC,aAAa,CAAC,EAAE,mBAAmB;IAQ/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACG,qBAAqB,CAC1B,WAAW,EAAE,qBAAqB,EAClC,OAAO,EAAE,4BAA4B,GACnC,OAAO,CAAC,0BAA0B,CAAC;IAqEtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACG,wBAAwB,CAC7B,WAAW,EAAE,qBAAqB,EAClC,OAAO,EAAE,+BAA+B,GACtC,OAAO,CAAC,IAAI,CAAC;IAgFhB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACG,yBAAyB,CAC9B,WAAW,EAAE,qBAAqB,EAClC,OAAO,EAAE,gCAAgC,GACvC,OAAO,CAAC,8BAA8B,CAAC;IAqE1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsCG;IACG,4BAA4B,CACjC,WAAW,EAAE,qBAAqB,EAClC,OAAO,EAAE,mCAAmC,GAC1C,OAAO,CAAC,IAAI,CAAC;CA0EhB"}

package/dist/groups/Private/PrivateIterationData.js

@@ -0,0 +1,364 @@
+/*!
+ * Copyright Adaptavist 2025 (c) All rights reserved
+ */
+import { PrivateBase } from './PrivateBase';
+import { BadRequestError, UnauthorizedError, ForbiddenError, NotFoundError, ServerError, UnexpectedError, } from '../../utils';
+export class PrivateIterationData 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);
+        }
+    }
+}

package/dist/groups/Private.d.ts

@@ -9,6 +9,7 @@ import { PrivateVersions } from './Private/PrivateVersions';
 import { PrivateAttachments } from './Private/PrivateAttachments';
 import { PrivateAuthentication } from './Private/PrivateAuthentication';
 import { PrivateVersionControl } from './Private/PrivateVersionControl';
+import { PrivateIterationData } from './Private/PrivateIterationData';
 /**
  * Private API group for accessing Zephyr's private/unofficial endpoints
  *
@@ -40,6 +41,11 @@ export declare class PrivateGroup extends PrivateBase {
      * Version Control sub-group - Get version-specific data (links, test script, test steps)
      */
     readonly VersionControl: PrivateVersionControl;
+    /**
+     * Iteration Data sub-group - Get and set iteration data for Test Cycles and Test Executions
+     * Supplements public API with iteration data not available in public endpoints
+     */
+    readonly IterationData: PrivateIterationData;
     constructor(apiConnection?: ZephyrApiConnection);
 }
 //# sourceMappingURL=Private.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"Private.d.ts","sourceRoot":"","sources":["../../groups/Private.ts"],"names":[],"mappings":"AAAA;;GAEG;AAyDH,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AACpD,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAC5D,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACxD,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAC5D,OAAO,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAClE,OAAO,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AACxE,OAAO,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AASxE;;;;;GAKG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAC5C;;OAEG;IACH,SAAgB,cAAc,EAAE,qBAAqB,CAAC;IAEtD;;OAEG;IACH,SAAgB,QAAQ,EAAE,eAAe,CAAC;IAE1C;;OAEG;IACH,SAAgB,MAAM,EAAE,aAAa,CAAC;IAEtC;;OAEG;IACH,SAAgB,QAAQ,EAAE,eAAe,CAAC;IAE1C;;OAEG;IACH,SAAgB,WAAW,EAAE,kBAAkB,CAAC;IAEhD;;OAEG;IACH,SAAgB,cAAc,EAAE,qBAAqB,CAAC;gBAE1C,aAAa,CAAC,EAAE,mBAAmB;CAU/C"}
+{"version":3,"file":"Private.d.ts","sourceRoot":"","sources":["../../groups/Private.ts"],"names":[],"mappings":"AAAA;;GAEG;AAyDH,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AACpD,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAC5D,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACxD,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAC5D,OAAO,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAClE,OAAO,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AACxE,OAAO,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AACxE,OAAO,EAAE,oBAAoB,EAAE,MAAM,gCAAgC,CAAC;AAStE;;;;;GAKG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAC5C;;OAEG;IACH,SAAgB,cAAc,EAAE,qBAAqB,CAAC;IAEtD;;OAEG;IACH,SAAgB,QAAQ,EAAE,eAAe,CAAC;IAE1C;;OAEG;IACH,SAAgB,MAAM,EAAE,aAAa,CAAC;IAEtC;;OAEG;IACH,SAAgB,QAAQ,EAAE,eAAe,CAAC;IAE1C;;OAEG;IACH,SAAgB,WAAW,EAAE,kBAAkB,CAAC;IAEhD;;OAEG;IACH,SAAgB,cAAc,EAAE,qBAAqB,CAAC;IAEtD;;;OAGG;IACH,SAAgB,aAAa,EAAE,oBAAoB,CAAC;gBAExC,aAAa,CAAC,EAAE,mBAAmB;CAW/C"}

package/dist/groups/Private.js

@@ -8,6 +8,7 @@ import { PrivateVersions } from './Private/PrivateVersions';
 import { PrivateAttachments } from './Private/PrivateAttachments';
 import { PrivateAuthentication } from './Private/PrivateAuthentication';
 import { PrivateVersionControl } from './Private/PrivateVersionControl';
+import { PrivateIterationData } from './Private/PrivateIterationData';
 /**
  * Private API group for accessing Zephyr's private/unofficial endpoints
  *
@@ -23,5 +24,6 @@ export class PrivateGroup extends PrivateBase {
         this.Versions = new PrivateVersions(apiConnection);
         this.Attachments = new PrivateAttachments(apiConnection);
         this.VersionControl = new PrivateVersionControl(apiConnection);
+        this.IterationData = new PrivateIterationData(apiConnection);
     }
 }