@rbaileysr/zephyr-managed-api 1.3.3 → 1.3.4

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

@@ -7,7 +7,7 @@
  *
  * ⚠️ WARNING: These methods use private APIs that are not officially supported.
  */
-import type { PrivateApiCredentials, GetTestCaseIssueLinksRequest, GetTestCaseWebLinksRequest, GetTestCaseTestScriptRequest, GetTestCaseTestStepsRequest, IssueLinkList, WebLinkList, TestScript, TestStepsList } from '../../types';
+import type { PrivateApiCredentials, GetTestCaseIssueLinksRequest, GetTestCaseWebLinksRequest, GetTestCaseTestScriptRequest, GetTestCaseTestStepsRequest, GetTestExecutionStepIssueLinksRequest, CreateTestExecutionStepIssueLinkRequest, CreateTestExecutionStepIssueLinkResponse, TestExecutionStepIssueLinkList, IssueLinkList, WebLinkList, TestScript, TestStepsList } from '../../types';
 import { PrivateBase } from './PrivateBase';
 import type { ZephyrApiConnection } from '../../index';
 export declare class PrivateVersionControl extends PrivateBase {
@@ -25,7 +25,7 @@ export declare class PrivateVersionControl extends PrivateBase {
      * @param request - Get issue links request
      * @param request.testCaseKey - Test case key (e.g., 'PROJ-T1'). The numeric ID will be looked up automatically if Zephyr Connector is available.
      * @param request.projectId - Jira project ID (numeric, not the project key)
-     * @param request.version - Optional version number (relative to current version, where 1 = current/latest version, 2 = previous version, 3 = version before that, etc.). If not provided, uses the latest version (same as version: 1).
+     * @param request.version - Optional version number (absolute, 1-based: 1 = first version ever created, 2 = second version, etc. The highest number is the current/latest version). If not provided, uses the latest version.
      * @returns Array of issue links matching the public API format
      * @throws {BadRequestError} If the request is invalid
      * @throws {UnauthorizedError} If authentication fails
@@ -48,7 +48,7 @@ export declare class PrivateVersionControl extends PrivateBase {
      * @param request - Get web links request
      * @param request.testCaseKey - Test case key (e.g., 'PROJ-T1'). The numeric ID will be looked up automatically if Zephyr Connector is available.
      * @param request.projectId - Jira project ID (numeric, not the project key)
-     * @param request.version - Optional version number (relative to current version, where 1 = current/latest version, 2 = previous version, 3 = version before that, etc.). If not provided, uses the latest version (same as version: 1).
+     * @param request.version - Optional version number (absolute, 1-based: 1 = first version ever created, 2 = second version, etc. The highest number is the current/latest version). If not provided, uses the latest version.
      * @returns Array of web links matching the public API format
      * @throws {BadRequestError} If the request is invalid
      * @throws {UnauthorizedError} If authentication fails
@@ -71,7 +71,7 @@ export declare class PrivateVersionControl extends PrivateBase {
      * @param request - Get test script request
      * @param request.testCaseKey - Test case key (e.g., 'PROJ-T1')
      * @param request.projectId - Jira project ID (numeric, not the project key)
-     * @param request.version - Optional version number (relative to current version, where 1 = current/latest version, 2 = previous version, 3 = version before that, etc.). If not provided, uses the latest version (same as version: 1).
+     * @param request.version - Optional version number (absolute, 1-based: 1 = first version ever created, 2 = second version, etc. The highest number is the current/latest version). If not provided, uses the latest version.
      * @returns Test script matching the public API format, or null if no test script exists
      * @throws {BadRequestError} If the request is invalid
      * @throws {UnauthorizedError} If authentication fails
@@ -94,7 +94,7 @@ export declare class PrivateVersionControl extends PrivateBase {
      * @param request - Get test steps request
      * @param request.testCaseKey - Test case key (e.g., 'PROJ-T1')
      * @param request.projectId - Jira project ID (numeric, not the project key)
-     * @param request.version - Optional version number (relative to current version, where 1 = current/latest version, 2 = previous version, 3 = version before that, etc.). If not provided, uses the latest version (same as version: 1).
+     * @param request.version - Optional version number (absolute, 1-based: 1 = first version ever created, 2 = second version, etc. The highest number is the current/latest version). If not provided, uses the latest version.
      * @returns Test steps list matching the public API format
      * @throws {BadRequestError} If the request is invalid
      * @throws {UnauthorizedError} If authentication fails
@@ -104,5 +104,66 @@ export declare class PrivateVersionControl extends PrivateBase {
      * @throws {UnexpectedError} If test case cannot be retrieved
      */
     getTestCaseTestSteps(credentials: PrivateApiCredentials, request: GetTestCaseTestStepsRequest): Promise<TestStepsList>;
+    /**
+     * Map LinkType to numeric typeId for private API
+     */
+    private mapLinkTypeToTypeId;
+    /**
+     * Map numeric typeId to LinkType for private API
+     */
+    private mapTypeIdToLinkType;
+    /**
+     * Get issue links for a test execution step using private API
+     *
+     * Retrieves all issue links associated with a specific test execution step. This is useful for
+     * migration scenarios where you need to extract issue links from a source test execution and
+     * recreate them in a target instance.
+     *
+     * ⚠️ 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 issue links request
+     * @param request.testExecutionKey - Test execution key (e.g., 'PROJ-E1')
+     * @param request.stepIndex - Zero-based index of the test execution step
+     * @param request.projectId - Jira project ID (numeric, not the project key)
+     * @returns List of issue links for the test execution step
+     * @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 or step is not found
+     * @throws {ServerError} If the server returns an error
+     * @throws {UnexpectedError} If an unexpected error occurs
+     */
+    getTestExecutionStepIssueLinks(credentials: PrivateApiCredentials, request: GetTestExecutionStepIssueLinksRequest): Promise<TestExecutionStepIssueLinkList>;
+    /**
+     * Map system key to LinkType
+     */
+    private mapSystemKeyToLinkType;
+    /**
+     * Create an issue link for a test execution step using private API
+     *
+     * Creates a link between a test execution step and a Jira issue. The link type can be COVERAGE, BLOCKS, or RELATED.
+     * This functionality is not available in the public API.
+     *
+     * ⚠️ 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 - Create issue link request
+     * @param request.testExecutionKey - Test execution key (e.g., 'PROJ-E1')
+     * @param request.stepIndex - Zero-based index of the test execution step
+     * @param request.issueId - Jira issue ID (numeric)
+     * @param request.type - Link type: 'COVERAGE', 'BLOCKS', or 'RELATED' (optional, defaults to 'COVERAGE')
+     * @param request.projectId - Jira project ID (numeric, not the project key)
+     * @returns Created link response with ID
+     * @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 or step is not found
+     * @throws {ServerError} If the server returns an error
+     * @throws {UnexpectedError} If test execution ID cannot be looked up
+     */
+    createTestExecutionStepIssueLink(credentials: PrivateApiCredentials, request: CreateTestExecutionStepIssueLinkRequest): Promise<CreateTestExecutionStepIssueLinkResponse>;
 }
 //# sourceMappingURL=PrivateVersionControl.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"PrivateVersionControl.d.ts","sourceRoot":"","sources":["../../../groups/Private/PrivateVersionControl.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;;;;GAKG;AAEH,OAAO,KAAK,EACX,qBAAqB,EACrB,4BAA4B,EAC5B,0BAA0B,EAC1B,4BAA4B,EAC5B,2BAA2B,EAC3B,aAAa,EACb,WAAW,EACX,UAAU,EACV,aAAa,EAKb,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAS5C,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAqEvD,qBAAa,qBAAsB,SAAQ,WAAW;gBACzC,aAAa,CAAC,EAAE,mBAAmB;IAI/C;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,qBAAqB,CAC1B,WAAW,EAAE,qBAAqB,EAClC,OAAO,EAAE,4BAA4B,GACnC,OAAO,CAAC,aAAa,CAAC;IA2GzB;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,mBAAmB,CACxB,WAAW,EAAE,qBAAqB,EAClC,OAAO,EAAE,0BAA0B,GACjC,OAAO,CAAC,WAAW,CAAC;IA2GvB;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,qBAAqB,CAC1B,WAAW,EAAE,qBAAqB,EAClC,OAAO,EAAE,4BAA4B,GACnC,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC;IAgH7B;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,oBAAoB,CACzB,WAAW,EAAE,qBAAqB,EAClC,OAAO,EAAE,2BAA2B,GAClC,OAAO,CAAC,aAAa,CAAC;CAgIzB"}
+{"version":3,"file":"PrivateVersionControl.d.ts","sourceRoot":"","sources":["../../../groups/Private/PrivateVersionControl.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;;;;GAKG;AAEH,OAAO,KAAK,EACX,qBAAqB,EACrB,4BAA4B,EAC5B,0BAA0B,EAC1B,4BAA4B,EAC5B,2BAA2B,EAC3B,qCAAqC,EACrC,uCAAuC,EACvC,wCAAwC,EACxC,8BAA8B,EAC9B,aAAa,EACb,WAAW,EACX,UAAU,EACV,aAAa,EAMb,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAS5C,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAqEvD,qBAAa,qBAAsB,SAAQ,WAAW;gBACzC,aAAa,CAAC,EAAE,mBAAmB;IAI/C;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,qBAAqB,CAC1B,WAAW,EAAE,qBAAqB,EAClC,OAAO,EAAE,4BAA4B,GACnC,OAAO,CAAC,aAAa,CAAC;IA2GzB;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,mBAAmB,CACxB,WAAW,EAAE,qBAAqB,EAClC,OAAO,EAAE,0BAA0B,GACjC,OAAO,CAAC,WAAW,CAAC;IA2GvB;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,qBAAqB,CAC1B,WAAW,EAAE,qBAAqB,EAClC,OAAO,EAAE,4BAA4B,GACnC,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC;IAgH7B;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,oBAAoB,CACzB,WAAW,EAAE,qBAAqB,EAClC,OAAO,EAAE,2BAA2B,GAClC,OAAO,CAAC,aAAa,CAAC;IAiIzB;;OAEG;IACH,OAAO,CAAC,mBAAmB;IAa3B;;OAEG;IACH,OAAO,CAAC,mBAAmB;IAa3B;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,8BAA8B,CACnC,WAAW,EAAE,qBAAqB,EAClC,OAAO,EAAE,qCAAqC,GAC5C,OAAO,CAAC,8BAA8B,CAAC;IAiF1C;;OAEG;IACH,OAAO,CAAC,sBAAsB;IAa9B;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,gCAAgC,CACrC,WAAW,EAAE,qBAAqB,EAClC,OAAO,EAAE,uCAAuC,GAC9C,OAAO,CAAC,wCAAwC,CAAC;CA+IpD"}

package/dist/groups/Private/PrivateVersionControl.js

@@ -20,7 +20,7 @@ export class PrivateVersionControl extends PrivateBase {
      * @param request - Get issue links request
      * @param request.testCaseKey - Test case key (e.g., 'PROJ-T1'). The numeric ID will be looked up automatically if Zephyr Connector is available.
      * @param request.projectId - Jira project ID (numeric, not the project key)
-     * @param request.version - Optional version number (relative to current version, where 1 = current/latest version, 2 = previous version, 3 = version before that, etc.). If not provided, uses the latest version (same as version: 1).
+     * @param request.version - Optional version number (absolute, 1-based: 1 = first version ever created, 2 = second version, etc. The highest number is the current/latest version). If not provided, uses the latest version.
      * @returns Array of issue links matching the public API format
      * @throws {BadRequestError} If the request is invalid
      * @throws {UnauthorizedError} If authentication fails
@@ -125,7 +125,7 @@ export class PrivateVersionControl extends PrivateBase {
      * @param request - Get web links request
      * @param request.testCaseKey - Test case key (e.g., 'PROJ-T1'). The numeric ID will be looked up automatically if Zephyr Connector is available.
      * @param request.projectId - Jira project ID (numeric, not the project key)
-     * @param request.version - Optional version number (relative to current version, where 1 = current/latest version, 2 = previous version, 3 = version before that, etc.). If not provided, uses the latest version (same as version: 1).
+     * @param request.version - Optional version number (absolute, 1-based: 1 = first version ever created, 2 = second version, etc. The highest number is the current/latest version). If not provided, uses the latest version.
      * @returns Array of web links matching the public API format
      * @throws {BadRequestError} If the request is invalid
      * @throws {UnauthorizedError} If authentication fails
@@ -230,7 +230,7 @@ export class PrivateVersionControl extends PrivateBase {
      * @param request - Get test script request
      * @param request.testCaseKey - Test case key (e.g., 'PROJ-T1')
      * @param request.projectId - Jira project ID (numeric, not the project key)
-     * @param request.version - Optional version number (relative to current version, where 1 = current/latest version, 2 = previous version, 3 = version before that, etc.). If not provided, uses the latest version (same as version: 1).
+     * @param request.version - Optional version number (absolute, 1-based: 1 = first version ever created, 2 = second version, etc. The highest number is the current/latest version). If not provided, uses the latest version.
      * @returns Test script matching the public API format, or null if no test script exists
      * @throws {BadRequestError} If the request is invalid
      * @throws {UnauthorizedError} If authentication fails
@@ -339,7 +339,7 @@ export class PrivateVersionControl extends PrivateBase {
      * @param request - Get test steps request
      * @param request.testCaseKey - Test case key (e.g., 'PROJ-T1')
      * @param request.projectId - Jira project ID (numeric, not the project key)
-     * @param request.version - Optional version number (relative to current version, where 1 = current/latest version, 2 = previous version, 3 = version before that, etc.). If not provided, uses the latest version (same as version: 1).
+     * @param request.version - Optional version number (absolute, 1-based: 1 = first version ever created, 2 = second version, etc. The highest number is the current/latest version). If not provided, uses the latest version.
      * @returns Test steps list matching the public API format
      * @throws {BadRequestError} If the request is invalid
      * @throws {UnauthorizedError} If authentication fails
@@ -451,4 +451,259 @@ export class PrivateVersionControl extends PrivateBase {
             throw new UnexpectedError('Unexpected error while getting test case test steps', error);
         }
     }
+    /**
+     * Map LinkType to numeric typeId for private API
+     */
+    mapLinkTypeToTypeId(type) {
+        switch (type) {
+            case 'COVERAGE':
+                return 1;
+            case 'BLOCKS':
+                return 2;
+            case 'RELATED':
+                return 3;
+            default:
+                return 1; // Default to COVERAGE
+        }
+    }
+    /**
+     * Map numeric typeId to LinkType for private API
+     */
+    mapTypeIdToLinkType(typeId) {
+        switch (typeId) {
+            case 1:
+                return 'COVERAGE';
+            case 2:
+                return 'BLOCKS';
+            case 3:
+                return 'RELATED';
+            default:
+                return 'COVERAGE'; // Default to COVERAGE
+        }
+    }
+    /**
+     * Get issue links for a test execution step using private API
+     *
+     * Retrieves all issue links associated with a specific test execution step. This is useful for
+     * migration scenarios where you need to extract issue links from a source test execution and
+     * recreate them in a target instance.
+     *
+     * ⚠️ 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 issue links request
+     * @param request.testExecutionKey - Test execution key (e.g., 'PROJ-E1')
+     * @param request.stepIndex - Zero-based index of the test execution step
+     * @param request.projectId - Jira project ID (numeric, not the project key)
+     * @returns List of issue links for the test execution step
+     * @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 or step is not found
+     * @throws {ServerError} If the server returns an error
+     * @throws {UnexpectedError} If an unexpected error occurs
+     */
+    async getTestExecutionStepIssueLinks(credentials, request) {
+        // Get Context JWT
+        const contextJwt = await this.getContextJwt(credentials);
+        // Fetch test execution with traceLinks in testScriptResults
+        const url = `${this.privateApiBaseUrl}/testresult/${request.testExecutionKey}?fields=testScriptResults(id,index,traceLinks(id,type(id,systemKey),issueId)),attachments&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 === 404) {
+                    throw new NotFoundError(`Test execution with key '${request.testExecutionKey}' not found.`);
+                }
+                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 step issue links.');
+                }
+                throw new ServerError(`Failed to get test execution step issue links. Status: ${response.status}`, response.status, response.statusText);
+            }
+            const executionData = (await response.json());
+            const steps = executionData.testScriptResults || [];
+            if (request.stepIndex < 0 || request.stepIndex >= steps.length) {
+                throw new NotFoundError(`Test execution step at index ${request.stepIndex} not found in test execution '${request.testExecutionKey}'. Test execution has ${steps.length} step(s).`);
+            }
+            const step = steps[request.stepIndex];
+            const traceLinks = step.traceLinks || [];
+            // Transform private API response to migration-friendly format
+            return traceLinks.map((link) => ({
+                id: link.id,
+                issueId: link.issueId,
+                type: this.mapSystemKeyToLinkType(link.type.systemKey),
+            }));
+        }
+        catch (error) {
+            if (error instanceof NotFoundError ||
+                error instanceof UnauthorizedError ||
+                error instanceof ForbiddenError ||
+                error instanceof ServerError ||
+                error instanceof UnexpectedError) {
+                throw error;
+            }
+            throw new UnexpectedError('Unexpected error while getting test execution step issue links', error);
+        }
+    }
+    /**
+     * Map system key to LinkType
+     */
+    mapSystemKeyToLinkType(systemKey) {
+        switch (systemKey.toUpperCase()) {
+            case 'COVERAGE':
+                return 'COVERAGE';
+            case 'BLOCKS':
+                return 'BLOCKS';
+            case 'RELATED':
+                return 'RELATED';
+            default:
+                return 'COVERAGE'; // Default to COVERAGE
+        }
+    }
+    /**
+     * Create an issue link for a test execution step using private API
+     *
+     * Creates a link between a test execution step and a Jira issue. The link type can be COVERAGE, BLOCKS, or RELATED.
+     * This functionality is not available in the public API.
+     *
+     * ⚠️ 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 - Create issue link request
+     * @param request.testExecutionKey - Test execution key (e.g., 'PROJ-E1')
+     * @param request.stepIndex - Zero-based index of the test execution step
+     * @param request.issueId - Jira issue ID (numeric)
+     * @param request.type - Link type: 'COVERAGE', 'BLOCKS', or 'RELATED' (optional, defaults to 'COVERAGE')
+     * @param request.projectId - Jira project ID (numeric, not the project key)
+     * @returns Created link response with ID
+     * @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 or step is not found
+     * @throws {ServerError} If the server returns an error
+     * @throws {UnexpectedError} If test execution ID cannot be looked up
+     */
+    async createTestExecutionStepIssueLink(credentials, request) {
+        // Get Context JWT
+        const contextJwt = await this.getContextJwt(credentials);
+        // Step 1: Get test execution to find testResultId (numeric ID)
+        let testResultId;
+        if (this.testExecutionGroup) {
+            try {
+                const testExecution = await this.testExecutionGroup.getTestExecution({
+                    testExecutionIdOrKey: request.testExecutionKey,
+                });
+                testResultId = testExecution.id;
+            }
+            catch (error) {
+                if (error instanceof NotFoundError) {
+                    throw new NotFoundError(`Test execution with key '${request.testExecutionKey}' not found.`);
+                }
+                throw new UnexpectedError(`Failed to look up test execution ID from key '${request.testExecutionKey}'. Ensure Zephyr Connector is configured.`, error);
+            }
+        }
+        else {
+            throw new UnexpectedError('Cannot look up test execution ID from key. This method requires Zephyr Connector to be configured. Use createZephyrApi() with an API Connection.');
+        }
+        // Step 2: Get test execution steps to find testScriptResultId from stepIndex
+        const url = `${this.privateApiBaseUrl}/testresult/${request.testExecutionKey}?fields=testScriptResults(id,index),attachments&itemId=${request.testExecutionKey}`;
+        const headers = {
+            accept: 'application/json',
+            authorization: `JWT ${contextJwt}`,
+            'jira-project-id': String(request.projectId),
+        };
+        let testScriptResultId;
+        try {
+            const response = await fetch(url, {
+                method: 'GET',
+                headers,
+            });
+            if (!response.ok) {
+                if (response.status === 404) {
+                    throw new NotFoundError(`Test execution with key '${request.testExecutionKey}' not found.`);
+                }
+                throw new ServerError(`Failed to get test execution steps. Status: ${response.status}`, response.status, response.statusText);
+            }
+            const executionData = (await response.json());
+            const steps = executionData.testScriptResults || [];
+            if (request.stepIndex < 0 || request.stepIndex >= steps.length) {
+                throw new NotFoundError(`Test execution step at index ${request.stepIndex} not found in test execution '${request.testExecutionKey}'. Test execution has ${steps.length} step(s).`);
+            }
+            testScriptResultId = steps[request.stepIndex].id;
+        }
+        catch (error) {
+            if (error instanceof NotFoundError ||
+                error instanceof ServerError ||
+                error instanceof UnexpectedError) {
+                throw error;
+            }
+            throw new UnexpectedError('Unexpected error while getting test execution steps', error);
+        }
+        // Step 3: Create the issue link using bulk endpoint
+        const typeId = this.mapLinkTypeToTypeId(request.type);
+        const bulkUrl = `${this.privateApiBaseUrl}/tracelink/testresult/bulk/create`;
+        const bulkHeaders = {
+            'Content-Type': 'application/json',
+            authorization: `JWT ${contextJwt}`,
+            'jira-project-id': String(request.projectId),
+        };
+        const requestBody = [
+            {
+                testResultId,
+                issueId: String(request.issueId),
+                testScriptResultId,
+                typeId,
+            },
+        ];
+        try {
+            const response = await fetch(bulkUrl, {
+                method: 'POST',
+                headers: bulkHeaders,
+                body: JSON.stringify(requestBody),
+            });
+            if (!response.ok) {
+                if (response.status === 400) {
+                    throw new BadRequestError('Invalid request parameters for creating test execution step issue link.');
+                }
+                if (response.status === 401) {
+                    throw new UnauthorizedError('Failed to authenticate. Please check your credentials.');
+                }
+                if (response.status === 403) {
+                    throw new ForbiddenError('Insufficient permissions to create test execution step issue link.');
+                }
+                if (response.status === 404) {
+                    throw new NotFoundError(`Test execution '${request.testExecutionKey}' or step at index ${request.stepIndex} not found.`);
+                }
+                throw new ServerError(`Failed to create test execution step issue link. Status: ${response.status}`, response.status, response.statusText);
+            }
+            const results = (await response.json());
+            if (results.length === 0) {
+                throw new UnexpectedError('No link ID returned from API response.');
+            }
+            return results[0];
+        }
+        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 creating test execution step issue link', error);
+        }
+    }
 }

package/dist/groups/TestCase.d.ts

@@ -183,7 +183,7 @@ export declare class TestCaseGroup {
      *
      * @param options - Get version options
      * @param options.testCaseKey - The test case key (e.g., 'PROJ-T1')
-     * @param options.version - The version number (1-based, where 1 is the current version)
+     * @param options.version - The version number (absolute, 1-based: 1 = first version ever created, 2 = second version, etc. The highest number is the current/latest version)
      * @returns Test case object for the specified version
      *
      * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Cases/operation/getTestCaseVersion Official API Documentation}

package/dist/groups/TestCase.js

@@ -232,7 +232,7 @@ export class TestCaseGroup {
      *
      * @param options - Get version options
      * @param options.testCaseKey - The test case key (e.g., 'PROJ-T1')
-     * @param options.version - The version number (1-based, where 1 is the current version)
+     * @param options.version - The version number (absolute, 1-based: 1 = first version ever created, 2 = second version, etc. The highest number is the current/latest version)
      * @returns Test case object for the specified version
      *
      * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Cases/operation/getTestCaseVersion Official API Documentation}

package/dist/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rbaileysr/zephyr-managed-api",
-  "version": "1.3.3",
+  "version": "1.3.4",
   "description": "Managed API wrapper for Zephyr Cloud REST API v2 - Comprehensive type-safe access to all Zephyr API endpoints for ScriptRunner Connect",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/dist/types.d.ts

@@ -1529,9 +1529,8 @@ export interface GetTestCaseCommentsRequest {
     testCaseKey: string;
     projectId: number;
     /**
-     * Optional version number (relative to current version, where 1 = current/latest version, 2 = previous version, 3 = version before that, etc.).
-     * If not provided or undefined, uses the latest version (same as version: 1).
-     * Note: Version numbers are relative, not absolute. To get the first version ever created, you need to know the total number of versions.
+     * Optional version number (absolute, 1-based: 1 = first version ever created, 2 = second version, etc. The highest number is the current/latest version).
+     * If not provided or undefined, uses the latest version. Use `listTestCaseVersions()` to find the total number of versions and identify the latest.
      */
     version?: number;
 }
@@ -1578,9 +1577,8 @@ export interface GetTestCaseAttachmentsRequest {
     testCaseKey: string;
     projectId: number;
     /**
-     * Optional version number (relative to current version, where 1 = current/latest version, 2 = previous version, 3 = version before that, etc.).
-     * If not provided or undefined, uses the latest version (same as version: 1).
-     * Note: Version numbers are relative, not absolute. To get the first version ever created, you need to know the total number of versions.
+     * Optional version number (absolute, 1-based: 1 = first version ever created, 2 = second version, etc. The highest number is the current/latest version).
+     * If not provided or undefined, uses the latest version. Use `listTestCaseVersions()` to find the total number of versions and identify the latest.
      */
     version?: number;
 }
@@ -1592,9 +1590,8 @@ export interface DownloadAttachmentRequest {
     projectId: number;
     attachmentId: string;
     /**
-     * Optional version number (relative to current version, where 1 = current/latest version, 2 = previous version, 3 = version before that, etc.).
-     * If not provided or undefined, uses the latest version (same as version: 1).
-     * Note: Version numbers are relative, not absolute. To get the first version ever created, you need to know the total number of versions.
+     * Optional version number (absolute, 1-based: 1 = first version ever created, 2 = second version, etc. The highest number is the current/latest version).
+     * If not provided or undefined, uses the latest version. Use `listTestCaseVersions()` to find the total number of versions and identify the latest.
      */
     version?: number;
 }
@@ -1966,6 +1963,33 @@ export interface UpdateDataSetResponse {
 export interface GetDataSetsRequest {
     projectId: number;
 }
+/**
+ * Config type for archive/unarchive operations
+ */
+export type ConfigType = 'Environment' | 'Iteration';
+/**
+ * Archive config request for private API
+ */
+export interface ArchiveConfigRequest {
+    /**
+     * Type of config item: 'Environment' or 'Iteration'
+     */
+    type: ConfigType;
+    /**
+     * Numeric ID of the environment or iteration to archive
+     */
+    id: number;
+    /**
+     * Jira project ID (numeric, not the project key)
+     */
+    projectId: number;
+}
+/**
+ * Archive config response for private API
+ */
+export interface ArchiveConfigResponse {
+    id: number;
+}
 /**
  * Get test case issue links request for private API
  */
@@ -1973,9 +1997,8 @@ export interface GetTestCaseIssueLinksRequest {
     testCaseKey: string;
     projectId: number;
     /**
-     * Optional version number (relative to current version, where 1 = current/latest version, 2 = previous version, 3 = version before that, etc.).
-     * If not provided or undefined, uses the latest version (same as version: 1).
-     * Note: Version numbers are relative, not absolute. To get the first version ever created, you need to know the total number of versions.
+     * Optional version number (absolute, 1-based: 1 = first version ever created, 2 = second version, etc. The highest number is the current/latest version).
+     * If not provided or undefined, uses the latest version. Use `listTestCaseVersions()` to find the total number of versions and identify the latest.
      */
     version?: number;
 }
@@ -1986,9 +2009,8 @@ export interface GetTestCaseWebLinksRequest {
     testCaseKey: string;
     projectId: number;
     /**
-     * Optional version number (relative to current version, where 1 = current/latest version, 2 = previous version, 3 = version before that, etc.).
-     * If not provided or undefined, uses the latest version (same as version: 1).
-     * Note: Version numbers are relative, not absolute. To get the first version ever created, you need to know the total number of versions.
+     * Optional version number (absolute, 1-based: 1 = first version ever created, 2 = second version, etc. The highest number is the current/latest version).
+     * If not provided or undefined, uses the latest version. Use `listTestCaseVersions()` to find the total number of versions and identify the latest.
      */
     version?: number;
 }
@@ -1999,9 +2021,8 @@ export interface GetTestCaseTestScriptRequest {
     testCaseKey: string;
     projectId: number;
     /**
-     * Optional version number (relative to current version, where 1 = current/latest version, 2 = previous version, 3 = version before that, etc.).
-     * If not provided or undefined, uses the latest version (same as version: 1).
-     * Note: Version numbers are relative, not absolute. To get the first version ever created, you need to know the total number of versions.
+     * Optional version number (absolute, 1-based: 1 = first version ever created, 2 = second version, etc. The highest number is the current/latest version).
+     * If not provided or undefined, uses the latest version. Use `listTestCaseVersions()` to find the total number of versions and identify the latest.
      */
     version?: number;
 }
@@ -2012,10 +2033,48 @@ export interface GetTestCaseTestStepsRequest {
     testCaseKey: string;
     projectId: number;
     /**
-     * Optional version number (relative to current version, where 1 = current/latest version, 2 = previous version, 3 = version before that, etc.).
-     * If not provided or undefined, uses the latest version (same as version: 1).
-     * Note: Version numbers are relative, not absolute. To get the first version ever created, you need to know the total number of versions.
+     * Optional version number (absolute, 1-based: 1 = first version ever created, 2 = second version, etc. The highest number is the current/latest version).
+     * If not provided or undefined, uses the latest version. Use `listTestCaseVersions()` to find the total number of versions and identify the latest.
      */
     version?: number;
 }
+/**
+ * Create test execution step issue link request for private API
+ */
+export interface CreateTestExecutionStepIssueLinkRequest {
+    testExecutionKey: string;
+    stepIndex: number;
+    /**
+     * Jira issue ID (can be provided as number or string, will be converted to string for API)
+     */
+    issueId: number | string;
+    type: LinkType;
+    projectId: number;
+}
+/**
+ * Create test execution step issue link response for private API
+ */
+export interface CreateTestExecutionStepIssueLinkResponse {
+    id: number;
+}
+/**
+ * Get test execution step issue links request for private API
+ */
+export interface GetTestExecutionStepIssueLinksRequest {
+    testExecutionKey: string;
+    stepIndex: number;
+    projectId: number;
+}
+/**
+ * Test execution step issue link (from private API response)
+ */
+export interface TestExecutionStepIssueLink {
+    id: number;
+    issueId: string;
+    type: LinkType;
+}
+/**
+ * Test execution step issue link list
+ */
+export type TestExecutionStepIssueLinkList = TestExecutionStepIssueLink[];
 //# sourceMappingURL=types.d.ts.map