@rbaileysr/zephyr-managed-api 1.0.0

package/dist/groups/TestCase.d.ts

@@ -0,0 +1,254 @@
+/**
+ * Test Case API group
+ * Handles test case-related operations
+ */
+import type { TestCase, TestCaseList, CursorPagedTestCaseList, ListTestCasesOptions, GetTestCaseOptions, CreateTestCaseRequest, UpdateTestCaseRequest, TestCaseLinkList, CreateTestCaseIssueLinkRequest, CreateTestCaseWebLinkRequest, TestCaseVersionLinkList, ListTestCaseVersionsOptions, GetTestCaseVersionOptions, CreateTestCaseTestScriptRequest, TestScript, TestStepsList, CreateTestCaseTestStepsRequest, KeyedCreatedResource, CreatedResource } from '../types';
+import type { ZephyrApiConnection } from '../index';
+import type { ErrorStrategyHandlers } from '../error-strategy';
+export declare class TestCaseGroup {
+    private api;
+    constructor(api: ZephyrApiConnection);
+    /**
+     * List all test cases
+     *
+     * Retrieves a paginated list of test cases. Supports filtering by project key and folder ID.
+     * Automatically retries on rate limiting (429) with exponential backoff.
+     *
+     * @param options - Optional query parameters for filtering and pagination
+     * @param options.projectKey - Filter test cases by Jira project key
+     * @param options.folderId - Filter test cases by folder ID
+     * @param options.maxResults - Maximum number of results to return (default: 50)
+     * @param options.startAt - Zero-indexed starting position (must be multiple of maxResults)
+     * @returns Paginated list of test cases with metadata (total, isLast, etc.)
+     *
+     * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/listTestCases Official API Documentation}
+     */
+    listTestCases(options?: ListTestCasesOptions): Promise<TestCaseList>;
+    /**
+     * List all test cases (NextGen - cursor-based pagination)
+     *
+     * Retrieves test cases using cursor-based pagination. Use this endpoint for retrieving large volumes of test cases
+     * as it provides better performance than offset-based pagination.
+     * Automatically retries on rate limiting (429) with exponential backoff.
+     *
+     * @param options - Optional query parameters for filtering and pagination
+     * @param options.projectKey - Filter test cases by Jira project key
+     * @param options.folderId - Filter test cases by folder ID
+     * @param options.limit - Maximum number of results to return per page (default: 100)
+     * @param options.startAtId - Starting ID for cursor-based pagination (use null for first page)
+     * @returns Cursor-paginated list of test cases with nextStartAtId for pagination
+     *
+     * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/listTestCasesNextgen Official API Documentation}
+     */
+    listTestCasesCursorPaginated(options?: ListTestCasesOptions): Promise<CursorPagedTestCaseList>;
+    /**
+     * Get a specific test case
+     *
+     * Retrieves detailed information about a specific test case by its key (e.g., 'PROJ-T1').
+     * Automatically retries on rate limiting (429) with exponential backoff.
+     *
+     * @param options - Get test case options
+     * @param options.testCaseKey - The test case key (e.g., 'PROJ-T1')
+     * @param errorStrategy - Optional error strategy for custom error handling (e.g., return null on 404)
+     * @returns Test case object with all fields, or value specified by error strategy
+     *
+     * @example
+     * ```typescript
+     * // Return null if not found instead of throwing
+     * const testCase = await Zephyr.TestCase.getTestCase(
+     *   { testCaseKey: 'PROJ-T1' },
+     *   {
+     *     handleHttp404Error: () => ({ type: 'return', value: null })
+     *   }
+     * );
+     * ```
+     *
+     * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/getTestCase Official API Documentation}
+     */
+    getTestCase(options: GetTestCaseOptions, errorStrategy?: ErrorStrategyHandlers<TestCase | null>): Promise<TestCase | null>;
+    /**
+     * Create a new test case
+     *
+     * Creates a new test case in the specified project. Required fields include projectKey and name.
+     * Optional fields include objective, precondition, estimatedTime, priority, status, folder, owner, labels, and customFields.
+     * Automatically retries on rate limiting (429) with exponential backoff.
+     *
+     * @param request - Create test case request
+     * @param request.body - Test case data
+     * @param request.body.projectKey - Jira project key (required)
+     * @param request.body.name - Test case name (required)
+     * @param request.body.objective - Test case objective (optional)
+     * @param request.body.precondition - Test case precondition (optional)
+     * @param request.body.estimatedTime - Estimated execution time in milliseconds (optional)
+     * @param request.body.priorityName - Priority name (optional)
+     * @param request.body.statusName - Status name (optional)
+     * @param request.body.folderId - Folder ID (optional)
+     * @param request.body.ownerId - Owner account ID (optional)
+     * @param request.body.labels - Array of labels (optional)
+     * @param request.body.customFields - Custom field values (optional)
+     * @returns Created test case with key, id, and self link
+     *
+     * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/createTestCase Official API Documentation}
+     */
+    createTestCase(request: CreateTestCaseRequest): Promise<KeyedCreatedResource>;
+    /**
+     * Update an existing test case
+     *
+     * Updates an existing test case. For each non-specified field the value will be cleared.
+     * If the project has test case custom fields, all custom fields should be present in the request.
+     * Automatically retries on rate limiting (429) with exponential backoff.
+     *
+     * @param request - Update test case request
+     * @param request.testCaseKey - The test case key to update (e.g., 'PROJ-T1')
+     * @param request.body - Test case data to update (all fields optional, but unspecified fields will be cleared)
+     * @param request.body.name - Test case name (optional)
+     * @param request.body.objective - Test case objective (optional)
+     * @param request.body.precondition - Test case precondition (optional)
+     * @param request.body.estimatedTime - Estimated execution time in milliseconds (optional)
+     * @param request.body.priorityName - Priority name (optional)
+     * @param request.body.statusName - Status name (optional)
+     * @param request.body.folderId - Folder ID (optional)
+     * @param request.body.ownerId - Owner account ID (optional)
+     * @param request.body.labels - Array of labels (optional)
+     * @param request.body.customFields - Custom field values (optional, but all custom fields must be present if any are included)
+     * @returns Promise that resolves when update is complete
+     *
+     * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/updateTestCase Official API Documentation}
+     */
+    updateTestCase(request: UpdateTestCaseRequest): Promise<void>;
+    /**
+     * Get links for a test case
+     *
+     * Retrieves all links associated with a test case, including issue links and web links.
+     *
+     * @param testCaseKey - The test case key (e.g., 'PROJ-T1')
+     * @returns List of links including issues and webLinks arrays
+     *
+     * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/getTestCaseLinks Official API Documentation}
+     */
+    getTestCaseLinks(testCaseKey: string): Promise<TestCaseLinkList>;
+    /**
+     * Create a link between a test case and a Jira issue
+     *
+     * Creates a link between a test case and a Jira issue. The link type can be COVERAGE, BLOCKS, or RELATED.
+     *
+     * @param request - Create issue link request
+     * @param request.testCaseKey - The test case key (e.g., 'PROJ-T1')
+     * @param request.body - Link data
+     * @param request.body.issueId - Jira issue ID (required)
+     * @param request.body.type - Link type: 'COVERAGE', 'BLOCKS', or 'RELATED' (optional, defaults to 'COVERAGE')
+     * @returns Created link resource with id and self link
+     *
+     * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/createTestCaseIssueLink Official API Documentation}
+     */
+    createTestCaseIssueLink(request: CreateTestCaseIssueLinkRequest): Promise<CreatedResource>;
+    /**
+     * Create a link between a test case and a generic URL
+     *
+     * Creates a web link between a test case and an external URL. Useful for linking to documentation, requirements, or other resources.
+     *
+     * @param request - Create web link request
+     * @param request.testCaseKey - The test case key (e.g., 'PROJ-T1')
+     * @param request.body - Web link data
+     * @param request.body.url - The URL to link to (required)
+     * @param request.body.description - Link description (optional)
+     * @param request.body.type - Link type: 'COVERAGE', 'BLOCKS', or 'RELATED' (optional, defaults to 'COVERAGE')
+     * @returns Created link resource with id and self link
+     *
+     * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/createTestCaseWebLink Official API Documentation}
+     */
+    createTestCaseWebLink(request: CreateTestCaseWebLinkRequest): Promise<CreatedResource>;
+    /**
+     * List all test case versions
+     *
+     * Retrieves a paginated list of all versions of a test case. Response is ordered by most recent first.
+     * Useful for tracking changes to test cases over time.
+     *
+     * @param options - List versions options
+     * @param options.testCaseKey - The test case key (e.g., 'PROJ-T1')
+     * @param options.maxResults - Maximum number of results to return (default: 50)
+     * @param options.startAt - Zero-indexed starting position (must be multiple of maxResults)
+     * @returns Paginated list of test case version links
+     *
+     * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/listTestCaseVersions Official API Documentation}
+     */
+    listTestCaseVersions(options: ListTestCaseVersionsOptions): Promise<TestCaseVersionLinkList>;
+    /**
+     * Get a specific version of a test case
+     *
+     * Retrieves a specific version of a test case. Use this to view historical data or compare different versions.
+     *
+     * @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)
+     * @returns Test case object for the specified version
+     *
+     * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/getTestCaseVersion Official API Documentation}
+     */
+    getTestCaseVersion(options: GetTestCaseVersionOptions): Promise<TestCase>;
+    /**
+     * Get the test script for a test case
+     *
+     * Retrieves the test script associated with a test case. Test scripts can be plain text or BDD format.
+     *
+     * @param testCaseKey - The test case key (e.g., 'PROJ-T1')
+     * @returns Test script object with type and text/content
+     *
+     * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/getTestCaseTestScript Official API Documentation}
+     */
+    getTestCaseTestScript(testCaseKey: string): Promise<TestScript>;
+    /**
+     * Create or update the test script for a test case
+     *
+     * Creates or updates the test script for a test case. Test scripts can be plain text or BDD format.
+     * If the test case currently has a sequence of test steps assigned to it, these will be implicitly removed.
+     *
+     * @param request - Create test script request
+     * @param request.testCaseKey - The test case key (e.g., 'PROJ-T1')
+     * @param request.body - Test script data
+     * @param request.body.type - Script type: 'plain' or 'bdd' (required)
+     * @param request.body.text - Script text for plain type (required for plain type)
+     * @param request.body.content - Script content for BDD type (required for BDD type)
+     * @returns Created resource with id and self link
+     *
+     * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/createTestCaseTestScript Official API Documentation}
+     */
+    createTestCaseTestScript(request: CreateTestCaseTestScriptRequest): Promise<CreatedResource>;
+    /**
+     * Get test steps for a test case
+     *
+     * Retrieves the test steps associated with a test case. Provides a paged response, with 100 items per page by default.
+     * Test steps are used for structured test case definitions with step-by-step instructions.
+     *
+     * @param testCaseKey - The test case key (e.g., 'PROJ-T1')
+     * @param options - Optional pagination parameters
+     * @param options.maxResults - Maximum number of results to return (default: 100)
+     * @param options.startAt - Zero-indexed starting position (must be multiple of maxResults)
+     * @returns Paginated list of test steps
+     *
+     * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/getTestCaseTestSteps Official API Documentation}
+     */
+    getTestCaseTestSteps(testCaseKey: string, options?: {
+        maxResults?: number;
+        startAt?: number;
+    }): Promise<TestStepsList>;
+    /**
+     * Assign a series of test steps to a test case
+     *
+     * Creates or updates test steps for a test case. A maximum of 100 steps can be posted per request.
+     * If this endpoint is called on a test case that already has a plain text or BDD test script, that test script will implicitly be removed.
+     * Use mode 'OVERWRITE' to replace all existing steps, or 'APPEND' to add steps to existing ones.
+     *
+     * @param request - Create test steps request
+     * @param request.testCaseKey - The test case key (e.g., 'PROJ-T1')
+     * @param request.body - Test steps data
+     * @param request.body.mode - Operation mode: 'OVERWRITE' to replace all steps, 'APPEND' to add steps (required)
+     * @param request.body.items - Array of test step items (maximum 100 per request)
+     * @param request.body.items[].inline - Inline test step with description, testData, and expectedResult
+     * @returns Created resource with id and self link
+     *
+     * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/createTestCaseTestSteps Official API Documentation}
+     */
+    createTestCaseTestSteps(request: CreateTestCaseTestStepsRequest): Promise<CreatedResource>;
+}
+//# sourceMappingURL=TestCase.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"TestCase.d.ts","sourceRoot":"","sources":["../../groups/TestCase.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EACX,QAAQ,EACR,YAAY,EACZ,uBAAuB,EACvB,oBAAoB,EACpB,kBAAkB,EAClB,qBAAqB,EACrB,qBAAqB,EACrB,gBAAgB,EAChB,8BAA8B,EAC9B,4BAA4B,EAC5B,uBAAuB,EACvB,2BAA2B,EAC3B,yBAAyB,EACzB,+BAA+B,EAC/B,UAAU,EACV,aAAa,EACb,8BAA8B,EAC9B,oBAAoB,EACpB,eAAe,EACf,MAAM,UAAU,CAAC;AAElB,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AACpD,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,mBAAmB,CAAC;AAE/D,qBAAa,aAAa;IACb,OAAO,CAAC,GAAG;gBAAH,GAAG,EAAE,mBAAmB;IAE5C;;;;;;;;;;;;;;OAcG;IACG,aAAa,CAAC,OAAO,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,YAAY,CAAC;IAK1E;;;;;;;;;;;;;;;OAeG;IACG,4BAA4B,CACjC,OAAO,CAAC,EAAE,oBAAoB,GAC5B,OAAO,CAAC,uBAAuB,CAAC;IAKnC;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,WAAW,CAChB,OAAO,EAAE,kBAAkB,EAC3B,aAAa,CAAC,EAAE,qBAAqB,CAAC,QAAQ,GAAG,IAAI,CAAC,GACpD,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC;IAQ3B;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,cAAc,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAUnF;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,cAAc,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,IAAI,CAAC;IAqBnE;;;;;;;;;OASG;IACG,gBAAgB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAKtE;;;;;;;;;;;;;OAaG;IACG,uBAAuB,CAC5B,OAAO,EAAE,8BAA8B,GACrC,OAAO,CAAC,eAAe,CAAC;IAY3B;;;;;;;;;;;;;;OAcG;IACG,qBAAqB,CAAC,OAAO,EAAE,4BAA4B,GAAG,OAAO,CAAC,eAAe,CAAC;IAS5F;;;;;;;;;;;;;OAaG;IACG,oBAAoB,CACzB,OAAO,EAAE,2BAA2B,GAClC,OAAO,CAAC,uBAAuB,CAAC;IAQnC;;;;;;;;;;;OAWG;IACG,kBAAkB,CAAC,OAAO,EAAE,yBAAyB,GAAG,OAAO,CAAC,QAAQ,CAAC;IAO/E;;;;;;;;;OASG;IACG,qBAAqB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAKrE;;;;;;;;;;;;;;;OAeG;IACG,wBAAwB,CAC7B,OAAO,EAAE,+BAA+B,GACtC,OAAO,CAAC,eAAe,CAAC;IAS3B;;;;;;;;;;;;;OAaG;IACG,oBAAoB,CACzB,WAAW,EAAE,MAAM,EACnB,OAAO,CAAC,EAAE;QAAE,UAAU,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,GACjD,OAAO,CAAC,aAAa,CAAC;IAMzB;;;;;;;;;;;;;;;;OAgBG;IACG,uBAAuB,CAC5B,OAAO,EAAE,8BAA8B,GACrC,OAAO,CAAC,eAAe,CAAC;CAQ3B"}

package/dist/groups/TestCase.js

@@ -0,0 +1,327 @@
+/**
+ * Test Case API group
+ * Handles test case-related operations
+ */
+import { buildQueryString, parseResponse, buildRequestBody, executeWithRetry } from '../utils';
+export class TestCaseGroup {
+    constructor(api) {
+        this.api = api;
+    }
+    /**
+     * List all test cases
+     *
+     * Retrieves a paginated list of test cases. Supports filtering by project key and folder ID.
+     * Automatically retries on rate limiting (429) with exponential backoff.
+     *
+     * @param options - Optional query parameters for filtering and pagination
+     * @param options.projectKey - Filter test cases by Jira project key
+     * @param options.folderId - Filter test cases by folder ID
+     * @param options.maxResults - Maximum number of results to return (default: 50)
+     * @param options.startAt - Zero-indexed starting position (must be multiple of maxResults)
+     * @returns Paginated list of test cases with metadata (total, isLast, etc.)
+     *
+     * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/listTestCases Official API Documentation}
+     */
+    async listTestCases(options) {
+        const queryString = buildQueryString(options);
+        return executeWithRetry(() => this.api.fetch(`/testcases${queryString}`));
+    }
+    /**
+     * List all test cases (NextGen - cursor-based pagination)
+     *
+     * Retrieves test cases using cursor-based pagination. Use this endpoint for retrieving large volumes of test cases
+     * as it provides better performance than offset-based pagination.
+     * Automatically retries on rate limiting (429) with exponential backoff.
+     *
+     * @param options - Optional query parameters for filtering and pagination
+     * @param options.projectKey - Filter test cases by Jira project key
+     * @param options.folderId - Filter test cases by folder ID
+     * @param options.limit - Maximum number of results to return per page (default: 100)
+     * @param options.startAtId - Starting ID for cursor-based pagination (use null for first page)
+     * @returns Cursor-paginated list of test cases with nextStartAtId for pagination
+     *
+     * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/listTestCasesNextgen Official API Documentation}
+     */
+    async listTestCasesCursorPaginated(options) {
+        const queryString = buildQueryString(options);
+        return executeWithRetry(() => this.api.fetch(`/testcases/nextgen${queryString}`));
+    }
+    /**
+     * Get a specific test case
+     *
+     * Retrieves detailed information about a specific test case by its key (e.g., 'PROJ-T1').
+     * Automatically retries on rate limiting (429) with exponential backoff.
+     *
+     * @param options - Get test case options
+     * @param options.testCaseKey - The test case key (e.g., 'PROJ-T1')
+     * @param errorStrategy - Optional error strategy for custom error handling (e.g., return null on 404)
+     * @returns Test case object with all fields, or value specified by error strategy
+     *
+     * @example
+     * ```typescript
+     * // Return null if not found instead of throwing
+     * const testCase = await Zephyr.TestCase.getTestCase(
+     *   { testCaseKey: 'PROJ-T1' },
+     *   {
+     *     handleHttp404Error: () => ({ type: 'return', value: null })
+     *   }
+     * );
+     * ```
+     *
+     * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/getTestCase Official API Documentation}
+     */
+    async getTestCase(options, errorStrategy) {
+        return executeWithRetry(() => this.api.fetch(`/testcases/${options.testCaseKey}`), {}, errorStrategy);
+    }
+    /**
+     * Create a new test case
+     *
+     * Creates a new test case in the specified project. Required fields include projectKey and name.
+     * Optional fields include objective, precondition, estimatedTime, priority, status, folder, owner, labels, and customFields.
+     * Automatically retries on rate limiting (429) with exponential backoff.
+     *
+     * @param request - Create test case request
+     * @param request.body - Test case data
+     * @param request.body.projectKey - Jira project key (required)
+     * @param request.body.name - Test case name (required)
+     * @param request.body.objective - Test case objective (optional)
+     * @param request.body.precondition - Test case precondition (optional)
+     * @param request.body.estimatedTime - Estimated execution time in milliseconds (optional)
+     * @param request.body.priorityName - Priority name (optional)
+     * @param request.body.statusName - Status name (optional)
+     * @param request.body.folderId - Folder ID (optional)
+     * @param request.body.ownerId - Owner account ID (optional)
+     * @param request.body.labels - Array of labels (optional)
+     * @param request.body.customFields - Custom field values (optional)
+     * @returns Created test case with key, id, and self link
+     *
+     * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/createTestCase Official API Documentation}
+     */
+    async createTestCase(request) {
+        return executeWithRetry(() => this.api.fetch('/testcases', {
+            method: 'POST',
+            headers: { 'Content-Type': 'application/json' },
+            body: buildRequestBody(request.body),
+        }));
+    }
+    /**
+     * Update an existing test case
+     *
+     * Updates an existing test case. For each non-specified field the value will be cleared.
+     * If the project has test case custom fields, all custom fields should be present in the request.
+     * Automatically retries on rate limiting (429) with exponential backoff.
+     *
+     * @param request - Update test case request
+     * @param request.testCaseKey - The test case key to update (e.g., 'PROJ-T1')
+     * @param request.body - Test case data to update (all fields optional, but unspecified fields will be cleared)
+     * @param request.body.name - Test case name (optional)
+     * @param request.body.objective - Test case objective (optional)
+     * @param request.body.precondition - Test case precondition (optional)
+     * @param request.body.estimatedTime - Estimated execution time in milliseconds (optional)
+     * @param request.body.priorityName - Priority name (optional)
+     * @param request.body.statusName - Status name (optional)
+     * @param request.body.folderId - Folder ID (optional)
+     * @param request.body.ownerId - Owner account ID (optional)
+     * @param request.body.labels - Array of labels (optional)
+     * @param request.body.customFields - Custom field values (optional, but all custom fields must be present if any are included)
+     * @returns Promise that resolves when update is complete
+     *
+     * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/updateTestCase Official API Documentation}
+     */
+    async updateTestCase(request) {
+        await executeWithRetry(async () => {
+            const response = await this.api.fetch(`/testcases/${request.testCaseKey}`, {
+                method: 'PUT',
+                headers: { 'Content-Type': 'application/json' },
+                body: buildRequestBody(request.body),
+            });
+            if (!response.ok) {
+                await parseResponse(response);
+            }
+            // Return a mock response for void returns
+            return {
+                ok: true,
+                status: 200,
+                statusText: 'OK',
+                json: async () => ({ ok: true }),
+                headers: { get: () => null },
+            };
+        });
+    }
+    /**
+     * Get links for a test case
+     *
+     * Retrieves all links associated with a test case, including issue links and web links.
+     *
+     * @param testCaseKey - The test case key (e.g., 'PROJ-T1')
+     * @returns List of links including issues and webLinks arrays
+     *
+     * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/getTestCaseLinks Official API Documentation}
+     */
+    async getTestCaseLinks(testCaseKey) {
+        const response = await this.api.fetch(`/testcases/${testCaseKey}/links`);
+        return parseResponse(response);
+    }
+    /**
+     * Create a link between a test case and a Jira issue
+     *
+     * Creates a link between a test case and a Jira issue. The link type can be COVERAGE, BLOCKS, or RELATED.
+     *
+     * @param request - Create issue link request
+     * @param request.testCaseKey - The test case key (e.g., 'PROJ-T1')
+     * @param request.body - Link data
+     * @param request.body.issueId - Jira issue ID (required)
+     * @param request.body.type - Link type: 'COVERAGE', 'BLOCKS', or 'RELATED' (optional, defaults to 'COVERAGE')
+     * @returns Created link resource with id and self link
+     *
+     * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/createTestCaseIssueLink Official API Documentation}
+     */
+    async createTestCaseIssueLink(request) {
+        const response = await this.api.fetch(`/testcases/${request.testCaseKey}/links/issues`, {
+            method: 'POST',
+            headers: { 'Content-Type': 'application/json' },
+            body: buildRequestBody(request.body),
+        });
+        return parseResponse(response);
+    }
+    /**
+     * Create a link between a test case and a generic URL
+     *
+     * Creates a web link between a test case and an external URL. Useful for linking to documentation, requirements, or other resources.
+     *
+     * @param request - Create web link request
+     * @param request.testCaseKey - The test case key (e.g., 'PROJ-T1')
+     * @param request.body - Web link data
+     * @param request.body.url - The URL to link to (required)
+     * @param request.body.description - Link description (optional)
+     * @param request.body.type - Link type: 'COVERAGE', 'BLOCKS', or 'RELATED' (optional, defaults to 'COVERAGE')
+     * @returns Created link resource with id and self link
+     *
+     * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/createTestCaseWebLink Official API Documentation}
+     */
+    async createTestCaseWebLink(request) {
+        const response = await this.api.fetch(`/testcases/${request.testCaseKey}/links/weblinks`, {
+            method: 'POST',
+            headers: { 'Content-Type': 'application/json' },
+            body: buildRequestBody(request.body),
+        });
+        return parseResponse(response);
+    }
+    /**
+     * List all test case versions
+     *
+     * Retrieves a paginated list of all versions of a test case. Response is ordered by most recent first.
+     * Useful for tracking changes to test cases over time.
+     *
+     * @param options - List versions options
+     * @param options.testCaseKey - The test case key (e.g., 'PROJ-T1')
+     * @param options.maxResults - Maximum number of results to return (default: 50)
+     * @param options.startAt - Zero-indexed starting position (must be multiple of maxResults)
+     * @returns Paginated list of test case version links
+     *
+     * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/listTestCaseVersions Official API Documentation}
+     */
+    async listTestCaseVersions(options) {
+        const queryString = buildQueryString(options);
+        const response = await this.api.fetch(`/testcases/${options.testCaseKey}/versions${queryString}`);
+        return parseResponse(response);
+    }
+    /**
+     * Get a specific version of a test case
+     *
+     * Retrieves a specific version of a test case. Use this to view historical data or compare different versions.
+     *
+     * @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)
+     * @returns Test case object for the specified version
+     *
+     * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/getTestCaseVersion Official API Documentation}
+     */
+    async getTestCaseVersion(options) {
+        const response = await this.api.fetch(`/testcases/${options.testCaseKey}/versions/${options.version}`);
+        return parseResponse(response);
+    }
+    /**
+     * Get the test script for a test case
+     *
+     * Retrieves the test script associated with a test case. Test scripts can be plain text or BDD format.
+     *
+     * @param testCaseKey - The test case key (e.g., 'PROJ-T1')
+     * @returns Test script object with type and text/content
+     *
+     * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/getTestCaseTestScript Official API Documentation}
+     */
+    async getTestCaseTestScript(testCaseKey) {
+        const response = await this.api.fetch(`/testcases/${testCaseKey}/testscript`);
+        return parseResponse(response);
+    }
+    /**
+     * Create or update the test script for a test case
+     *
+     * Creates or updates the test script for a test case. Test scripts can be plain text or BDD format.
+     * If the test case currently has a sequence of test steps assigned to it, these will be implicitly removed.
+     *
+     * @param request - Create test script request
+     * @param request.testCaseKey - The test case key (e.g., 'PROJ-T1')
+     * @param request.body - Test script data
+     * @param request.body.type - Script type: 'plain' or 'bdd' (required)
+     * @param request.body.text - Script text for plain type (required for plain type)
+     * @param request.body.content - Script content for BDD type (required for BDD type)
+     * @returns Created resource with id and self link
+     *
+     * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/createTestCaseTestScript Official API Documentation}
+     */
+    async createTestCaseTestScript(request) {
+        const response = await this.api.fetch(`/testcases/${request.testCaseKey}/testscript`, {
+            method: 'POST',
+            headers: { 'Content-Type': 'application/json' },
+            body: buildRequestBody(request.body),
+        });
+        return parseResponse(response);
+    }
+    /**
+     * Get test steps for a test case
+     *
+     * Retrieves the test steps associated with a test case. Provides a paged response, with 100 items per page by default.
+     * Test steps are used for structured test case definitions with step-by-step instructions.
+     *
+     * @param testCaseKey - The test case key (e.g., 'PROJ-T1')
+     * @param options - Optional pagination parameters
+     * @param options.maxResults - Maximum number of results to return (default: 100)
+     * @param options.startAt - Zero-indexed starting position (must be multiple of maxResults)
+     * @returns Paginated list of test steps
+     *
+     * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/getTestCaseTestSteps Official API Documentation}
+     */
+    async getTestCaseTestSteps(testCaseKey, options) {
+        const queryString = buildQueryString(options);
+        const response = await this.api.fetch(`/testcases/${testCaseKey}/teststeps${queryString}`);
+        return parseResponse(response);
+    }
+    /**
+     * Assign a series of test steps to a test case
+     *
+     * Creates or updates test steps for a test case. A maximum of 100 steps can be posted per request.
+     * If this endpoint is called on a test case that already has a plain text or BDD test script, that test script will implicitly be removed.
+     * Use mode 'OVERWRITE' to replace all existing steps, or 'APPEND' to add steps to existing ones.
+     *
+     * @param request - Create test steps request
+     * @param request.testCaseKey - The test case key (e.g., 'PROJ-T1')
+     * @param request.body - Test steps data
+     * @param request.body.mode - Operation mode: 'OVERWRITE' to replace all steps, 'APPEND' to add steps (required)
+     * @param request.body.items - Array of test step items (maximum 100 per request)
+     * @param request.body.items[].inline - Inline test step with description, testData, and expectedResult
+     * @returns Created resource with id and self link
+     *
+     * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/createTestCaseTestSteps Official API Documentation}
+     */
+    async createTestCaseTestSteps(request) {
+        const response = await this.api.fetch(`/testcases/${request.testCaseKey}/teststeps`, {
+            method: 'POST',
+            headers: { 'Content-Type': 'application/json' },
+            body: buildRequestBody(request.body),
+        });
+        return parseResponse(response);
+    }
+}