@rbaileysr/zephyr-managed-api 1.0.0

package/dist/groups/TestExecution.js

@@ -0,0 +1,239 @@
+/**
+ * Test Execution API group
+ * Handles test execution-related operations
+ */
+import { buildQueryString, parseResponse, buildRequestBody } from '../utils';
+export class TestExecutionGroup {
+    constructor(api) {
+        this.api = api;
+    }
+    /**
+     * List all test executions
+     *
+     * Retrieves a paginated list of all test executions. Query parameters can be used to filter by project, test cycle, test case, dates, and more.
+     *
+     * @param options - Optional query parameters for filtering and pagination
+     * @param options.projectKey - Filter test executions by Jira project key
+     * @param options.testCycle - Filter by test cycle key
+     * @param options.testCase - Filter by test case key
+     * @param options.actualEndDateAfter - Filter for 'Actual End Date' after the given time (ISO 8601 format)
+     * @param options.actualEndDateBefore - Filter for 'Actual End Date' before the given time (ISO 8601 format)
+     * @param options.includeStepLinks - If true, execution step issue links will be included in the response
+     * @param options.jiraProjectVersionId - Filter by Jira Project Version ID
+     * @param options.maxResults - Maximum number of results to return (default: 10, max: 1000)
+     * @param options.startAt - Zero-indexed starting position (must be multiple of maxResults)
+     * @returns Paginated list of test executions with metadata (total, isLast, etc.)
+     *
+     * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/listTestExecutions Official API Documentation}
+     */
+    async listTestExecutions(options) {
+        const queryString = buildQueryString(options);
+        const response = await this.api.fetch(`/testexecutions${queryString}`);
+        return parseResponse(response);
+    }
+    /**
+     * List all test executions (NextGen - cursor-based pagination)
+     *
+     * Retrieves test executions using cursor-based pagination. Use this endpoint for retrieving large volumes of test executions
+     * as it provides better performance than offset-based pagination.
+     *
+     * @param options - Optional query parameters for filtering and pagination
+     * @param options.projectKey - Filter test executions by Jira project key
+     * @param options.testCycle - Filter by test cycle key
+     * @param options.testCase - Filter by test case key
+     * @param options.actualEndDateAfter - Filter for 'Actual End Date' after the given time (ISO 8601 format)
+     * @param options.actualEndDateBefore - Filter for 'Actual End Date' before the given time (ISO 8601 format)
+     * @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 executions with nextStartAtId for pagination
+     *
+     * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/listTestExecutionsNextgen Official API Documentation}
+     */
+    async listTestExecutionsNextgen(options) {
+        const queryString = buildQueryString(options);
+        const response = await this.api.fetch(`/testexecutions/nextgen${queryString}`);
+        return parseResponse(response);
+    }
+    /**
+     * Get a specific test execution
+     *
+     * Retrieves detailed information about a specific test execution by its ID or key.
+     *
+     * @param options - Get test execution options
+     * @param options.testExecutionIdOrKey - The test execution ID or key
+     * @param options.includeStepLinks - If true, execution step issue links will be included in the response
+     * @returns Test execution object with all fields
+     *
+     * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/getTestExecution Official API Documentation}
+     */
+    async getTestExecution(options) {
+        const params = [];
+        if (options.includeStepLinks !== undefined) {
+            params.push(`includeStepLinks=${options.includeStepLinks}`);
+        }
+        const queryString = params.length > 0 ? `?${params.join('&')}` : '';
+        const response = await this.api.fetch(`/testexecutions/${options.testExecutionIdOrKey}${queryString}`);
+        return parseResponse(response);
+    }
+    /**
+     * Create a new test execution
+     *
+     * Creates a new test execution for a test case within a test cycle. Required fields include projectKey, testCaseKey, testCycleKey, and statusName.
+     * Optional fields include environmentName, actualEndDate, executionTime, executedById, assignedToId, comment, and customFields.
+     *
+     * @param request - Create test execution request
+     * @param request.body - Test execution data
+     * @param request.body.projectKey - Jira project key (required)
+     * @param request.body.testCaseKey - Test case key (required)
+     * @param request.body.testCycleKey - Test cycle key (required)
+     * @param request.body.statusName - Status name (required)
+     * @param request.body.environmentName - Environment name (optional)
+     * @param request.body.actualEndDate - Actual end date in ISO 8601 format (optional)
+     * @param request.body.executionTime - Actual test execution time in milliseconds (optional)
+     * @param request.body.executedById - Account ID of user who executed the test (optional)
+     * @param request.body.assignedToId - Account ID of user assigned to the test (optional)
+     * @param request.body.comment - Comment added against overall test case execution (optional)
+     * @param request.body.customFields - Custom field values (optional)
+     * @returns Created test execution with id and self link
+     *
+     * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/createTestExecution Official API Documentation}
+     */
+    async createTestExecution(request) {
+        const response = await this.api.fetch('/testexecutions', {
+            method: 'POST',
+            headers: { 'Content-Type': 'application/json' },
+            body: buildRequestBody(request.body),
+        });
+        return parseResponse(response);
+    }
+    /**
+     * Update a test execution
+     *
+     * Updates an existing test execution. All fields are optional. Note that test executions may become immutable if there's a more recent execution for the same test case.
+     *
+     * @param request - Update test execution request
+     * @param request.testExecutionIdOrKey - The test execution ID or key to update
+     * @param request.body - Test execution data to update (all fields optional)
+     * @param request.body.statusName - Status name (optional)
+     * @param request.body.environmentName - Environment name (optional)
+     * @param request.body.actualEndDate - Actual end date in ISO 8601 format (optional)
+     * @param request.body.executionTime - Actual test execution time in milliseconds (optional)
+     * @param request.body.executedById - Account ID of user who executed the test (optional)
+     * @param request.body.assignedToId - Account ID of user assigned to the test (optional)
+     * @param request.body.comment - Comment added against overall test case execution (optional)
+     * @returns Promise that resolves when update is complete
+     *
+     * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/updateTestExecution Official API Documentation}
+     */
+    async updateTestExecution(request) {
+        const response = await this.api.fetch(`/testexecutions/${request.testExecutionIdOrKey}`, {
+            method: 'PUT',
+            headers: { 'Content-Type': 'application/json' },
+            body: buildRequestBody(request.body),
+        });
+        if (!response.ok) {
+            await parseResponse(response);
+        }
+    }
+    /**
+     * Get test steps for a test execution
+     *
+     * Retrieves the test steps associated with a test execution. Provides a paged response.
+     *
+     * @param options - Get test steps options
+     * @param options.testExecutionIdOrKey - The test execution ID or key
+     * @param options.maxResults - Maximum number of results to return (default: 50)
+     * @param options.startAt - Zero-indexed starting position (must be multiple of maxResults)
+     * @param options.testDataRowNumber - Filter by test data row number (optional)
+     * @returns Paginated list of test execution steps
+     *
+     * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/getTestExecutionTestSteps Official API Documentation}
+     */
+    async getTestExecutionTestSteps(options) {
+        const queryString = buildQueryString({
+            maxResults: options.maxResults,
+            startAt: options.startAt,
+            testDataRowNumber: options.testDataRowNumber,
+        });
+        const response = await this.api.fetch(`/testexecutions/${options.testExecutionIdOrKey}/teststeps${queryString}`);
+        return parseResponse(response);
+    }
+    /**
+     * Update test steps for a test execution
+     *
+     * Updates the test steps for a test execution. The number of steps sent must match the number of steps in the test execution.
+     * Update of test execution containing test data is not supported.
+     *
+     * @param request - Update test steps request
+     * @param request.testExecutionIdOrKey - The test execution ID or key
+     * @param request.body - Test steps data
+     * @param request.body.items - Array of test step items with id, statusName, and optional comment
+     * @returns Promise that resolves when update is complete
+     *
+     * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/putTestExecutionTestSteps Official API Documentation}
+     */
+    async putTestExecutionTestSteps(request) {
+        const response = await this.api.fetch(`/testexecutions/${request.testExecutionIdOrKey}/teststeps`, {
+            method: 'PUT',
+            headers: { 'Content-Type': 'application/json' },
+            body: buildRequestBody(request.body),
+        });
+        if (!response.ok) {
+            await parseResponse(response);
+        }
+    }
+    /**
+     * Sync test execution with content of test case script
+     *
+     * Synchronizes the test execution steps with the content of the test case script. This updates the test execution
+     * to match any changes made to the test case's test script or test steps.
+     *
+     * @param request - Sync test execution script request
+     * @param request.testExecutionIdOrKey - The test execution ID or key
+     * @returns Link object with id and self link
+     *
+     * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/syncTestExecutionScript Official API Documentation}
+     */
+    async syncTestExecutionScript(request) {
+        const response = await this.api.fetch(`/testexecutions/${request.testExecutionIdOrKey}/teststeps/sync`, {
+            method: 'POST',
+        });
+        return parseResponse(response);
+    }
+    /**
+     * Get links for a test execution
+     *
+     * Retrieves all links associated with a test execution, including issue links.
+     *
+     * @param testExecutionIdOrKey - The test execution ID or key
+     * @returns List of links including issues array
+     *
+     * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/listTestExecutionLinks Official API Documentation}
+     */
+    async listTestExecutionLinks(testExecutionIdOrKey) {
+        const response = await this.api.fetch(`/testexecutions/${testExecutionIdOrKey}/links`);
+        return parseResponse(response);
+    }
+    /**
+     * Create a link between a test execution and a Jira issue
+     *
+     * Creates a link between a test execution and a Jira issue. The link type can be COVERAGE, BLOCKS, or RELATED.
+     *
+     * @param request - Create issue link request
+     * @param request.testExecutionIdOrKey - The test execution ID or key
+     * @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/createTestExecutionIssueLink Official API Documentation}
+     */
+    async createTestExecutionIssueLink(request) {
+        const response = await this.api.fetch(`/testexecutions/${request.testExecutionIdOrKey}/links/issues`, {
+            method: 'POST',
+            headers: { 'Content-Type': 'application/json' },
+            body: buildRequestBody(request.body),
+        });
+        return parseResponse(response);
+    }
+}

package/dist/groups/TestPlan.d.ts

@@ -0,0 +1,103 @@
+/**
+ * Test Plan API group
+ * Handles test plan-related operations
+ */
+import type { TestPlan, TestPlanList, ListTestPlansOptions, GetTestPlanOptions, CreateTestPlanRequest, CreateTestPlanIssueLinkRequest, CreateTestPlanWebLinkRequest, CreateTestPlanTestCycleLinkRequest, KeyedCreatedResource, CreatedResource } from '../types';
+import type { ZephyrApiConnection } from '../index';
+export declare class TestPlanGroup {
+    private api;
+    constructor(api: ZephyrApiConnection);
+    /**
+     * List all test plans
+     *
+     * Retrieves a paginated list of all test plans. Query parameters can be used to filter by project.
+     *
+     * @param options - Optional query parameters for filtering and pagination
+     * @param options.projectKey - Filter test plans by Jira project key
+     * @param options.maxResults - Maximum number of results to return (default: 10, max: 1000)
+     * @param options.startAt - Zero-indexed starting position (must be multiple of maxResults)
+     * @returns Paginated list of test plans with metadata (total, isLast, etc.)
+     *
+     * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/listTestPlans Official API Documentation}
+     */
+    listTestPlans(options?: ListTestPlansOptions): Promise<TestPlanList>;
+    /**
+     * Get a specific test plan
+     *
+     * Retrieves detailed information about a specific test plan by its ID or key (e.g., 'PROJ-P1').
+     *
+     * @param options - Get test plan options
+     * @param options.testPlanIdOrKey - The test plan ID or key (e.g., 'PROJ-P1')
+     * @returns Test plan object with all fields
+     *
+     * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/getTestPlan Official API Documentation}
+     */
+    getTestPlan(options: GetTestPlanOptions): Promise<TestPlan>;
+    /**
+     * Create a new test plan
+     *
+     * Creates a new test plan in the specified project. Required fields include projectKey and name.
+     * Optional fields include objective, folderId, statusName, ownerId, labels, and customFields.
+     *
+     * @param request - Create test plan request
+     * @param request.body - Test plan data
+     * @param request.body.projectKey - Jira project key (required)
+     * @param request.body.name - Test plan name (required)
+     * @param request.body.objective - Test plan objective (optional)
+     * @param request.body.folderId - Folder ID (optional)
+     * @param request.body.statusName - Status name (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 plan with key, id, and self link
+     *
+     * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/createTestPlan Official API Documentation}
+     */
+    createTestPlan(request: CreateTestPlanRequest): Promise<KeyedCreatedResource>;
+    /**
+     * Create a link between a test plan and a Jira issue
+     *
+     * Creates a link between a test plan and a Jira issue. The link type can be COVERAGE, BLOCKS, or RELATED.
+     *
+     * @param request - Create issue link request
+     * @param request.testPlanIdOrKey - The test plan ID or key (e.g., 'PROJ-P1')
+     * @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/createTestPlanIssueLink Official API Documentation}
+     */
+    createTestPlanIssueLink(request: CreateTestPlanIssueLinkRequest): Promise<CreatedResource>;
+    /**
+     * Create a link between a test plan and a generic URL
+     *
+     * Creates a web link between a test plan and an external URL. Useful for linking to documentation, requirements, or other resources.
+     *
+     * @param request - Create web link request
+     * @param request.testPlanIdOrKey - The test plan ID or key (e.g., 'PROJ-P1')
+     * @param request.body - Web link data
+     * @param request.body.url - The URL to link to (required)
+     * @param request.body.description - Link description (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/createTestPlanWebLink Official API Documentation}
+     */
+    createTestPlanWebLink(request: CreateTestPlanWebLinkRequest): Promise<CreatedResource>;
+    /**
+     * Create a link between a test plan and a test cycle
+     *
+     * Creates a link between a test plan and a test cycle. This associates a test cycle with a test plan.
+     *
+     * @param request - Create test cycle link request
+     * @param request.testPlanIdOrKey - The test plan ID or key (e.g., 'PROJ-P1')
+     * @param request.body - Link data
+     * @param request.body.testCycleIdOrKey - The test cycle ID or key (required)
+     * @returns Created link resource with id and self link
+     *
+     * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/createTestPlanTestCycleLink Official API Documentation}
+     */
+    createTestPlanTestCycleLink(request: CreateTestPlanTestCycleLinkRequest): Promise<CreatedResource>;
+}
+//# sourceMappingURL=TestPlan.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"TestPlan.d.ts","sourceRoot":"","sources":["../../groups/TestPlan.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EACX,QAAQ,EACR,YAAY,EACZ,oBAAoB,EACpB,kBAAkB,EAClB,qBAAqB,EACrB,8BAA8B,EAC9B,4BAA4B,EAC5B,kCAAkC,EAClC,oBAAoB,EACpB,eAAe,EACf,MAAM,UAAU,CAAC;AAElB,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAEpD,qBAAa,aAAa;IACb,OAAO,CAAC,GAAG;gBAAH,GAAG,EAAE,mBAAmB;IAE5C;;;;;;;;;;;;OAYG;IACG,aAAa,CAAC,OAAO,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,YAAY,CAAC;IAM1E;;;;;;;;;;OAUG;IACG,WAAW,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,QAAQ,CAAC;IAKjE;;;;;;;;;;;;;;;;;;;OAmBG;IACG,cAAc,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,oBAAoB,CAAC;IASnF;;;;;;;;;;;;;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;IAY5F;;;;;;;;;;;;OAYG;IACG,2BAA2B,CAChC,OAAO,EAAE,kCAAkC,GACzC,OAAO,CAAC,eAAe,CAAC;CAW3B"}

package/dist/groups/TestPlan.js

@@ -0,0 +1,137 @@
+/**
+ * Test Plan API group
+ * Handles test plan-related operations
+ */
+import { buildQueryString, parseResponse, buildRequestBody } from '../utils';
+export class TestPlanGroup {
+    constructor(api) {
+        this.api = api;
+    }
+    /**
+     * List all test plans
+     *
+     * Retrieves a paginated list of all test plans. Query parameters can be used to filter by project.
+     *
+     * @param options - Optional query parameters for filtering and pagination
+     * @param options.projectKey - Filter test plans by Jira project key
+     * @param options.maxResults - Maximum number of results to return (default: 10, max: 1000)
+     * @param options.startAt - Zero-indexed starting position (must be multiple of maxResults)
+     * @returns Paginated list of test plans with metadata (total, isLast, etc.)
+     *
+     * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/listTestPlans Official API Documentation}
+     */
+    async listTestPlans(options) {
+        const queryString = buildQueryString(options);
+        const response = await this.api.fetch(`/testplans${queryString}`);
+        return parseResponse(response);
+    }
+    /**
+     * Get a specific test plan
+     *
+     * Retrieves detailed information about a specific test plan by its ID or key (e.g., 'PROJ-P1').
+     *
+     * @param options - Get test plan options
+     * @param options.testPlanIdOrKey - The test plan ID or key (e.g., 'PROJ-P1')
+     * @returns Test plan object with all fields
+     *
+     * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/getTestPlan Official API Documentation}
+     */
+    async getTestPlan(options) {
+        const response = await this.api.fetch(`/testplans/${options.testPlanIdOrKey}`);
+        return parseResponse(response);
+    }
+    /**
+     * Create a new test plan
+     *
+     * Creates a new test plan in the specified project. Required fields include projectKey and name.
+     * Optional fields include objective, folderId, statusName, ownerId, labels, and customFields.
+     *
+     * @param request - Create test plan request
+     * @param request.body - Test plan data
+     * @param request.body.projectKey - Jira project key (required)
+     * @param request.body.name - Test plan name (required)
+     * @param request.body.objective - Test plan objective (optional)
+     * @param request.body.folderId - Folder ID (optional)
+     * @param request.body.statusName - Status name (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 plan with key, id, and self link
+     *
+     * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/createTestPlan Official API Documentation}
+     */
+    async createTestPlan(request) {
+        const response = await this.api.fetch('/testplans', {
+            method: 'POST',
+            headers: { 'Content-Type': 'application/json' },
+            body: buildRequestBody(request.body),
+        });
+        return parseResponse(response);
+    }
+    /**
+     * Create a link between a test plan and a Jira issue
+     *
+     * Creates a link between a test plan and a Jira issue. The link type can be COVERAGE, BLOCKS, or RELATED.
+     *
+     * @param request - Create issue link request
+     * @param request.testPlanIdOrKey - The test plan ID or key (e.g., 'PROJ-P1')
+     * @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/createTestPlanIssueLink Official API Documentation}
+     */
+    async createTestPlanIssueLink(request) {
+        const response = await this.api.fetch(`/testplans/${request.testPlanIdOrKey}/links/issues`, {
+            method: 'POST',
+            headers: { 'Content-Type': 'application/json' },
+            body: buildRequestBody(request.body),
+        });
+        return parseResponse(response);
+    }
+    /**
+     * Create a link between a test plan and a generic URL
+     *
+     * Creates a web link between a test plan and an external URL. Useful for linking to documentation, requirements, or other resources.
+     *
+     * @param request - Create web link request
+     * @param request.testPlanIdOrKey - The test plan ID or key (e.g., 'PROJ-P1')
+     * @param request.body - Web link data
+     * @param request.body.url - The URL to link to (required)
+     * @param request.body.description - Link description (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/createTestPlanWebLink Official API Documentation}
+     */
+    async createTestPlanWebLink(request) {
+        const response = await this.api.fetch(`/testplans/${request.testPlanIdOrKey}/links/weblinks`, {
+            method: 'POST',
+            headers: { 'Content-Type': 'application/json' },
+            body: buildRequestBody(request.body),
+        });
+        return parseResponse(response);
+    }
+    /**
+     * Create a link between a test plan and a test cycle
+     *
+     * Creates a link between a test plan and a test cycle. This associates a test cycle with a test plan.
+     *
+     * @param request - Create test cycle link request
+     * @param request.testPlanIdOrKey - The test plan ID or key (e.g., 'PROJ-P1')
+     * @param request.body - Link data
+     * @param request.body.testCycleIdOrKey - The test cycle ID or key (required)
+     * @returns Created link resource with id and self link
+     *
+     * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/createTestPlanTestCycleLink Official API Documentation}
+     */
+    async createTestPlanTestCycleLink(request) {
+        const response = await this.api.fetch(`/testplans/${request.testPlanIdOrKey}/links/testcycles`, {
+            method: 'POST',
+            headers: { 'Content-Type': 'application/json' },
+            body: buildRequestBody(request.body),
+        });
+        return parseResponse(response);
+    }
+}

package/dist/index.d.ts

@@ -0,0 +1,119 @@
+/**
+ * Zephyr Managed API
+ *
+ * A comprehensive Managed API wrapper for Zephyr Cloud REST API v2
+ * Provides type-safe, hierarchical access to all Zephyr API endpoints
+ *
+ * Usage:
+ * ```typescript
+ * import { createZephyrApi } from './zephyr';
+ * import ZephyrApiConnection from '../api/zephyr';
+ *
+ * // Using API Connection (ScriptRunner Connect)
+ * const Zephyr = createZephyrApi(ZephyrApiConnection, 'us');
+ *
+ * // Using OAuth Token
+ * const Zephyr = createZephyrApi('oauth-token-string', 'us');
+ *
+ * // Use the API
+ * const testCase = await Zephyr.TestCase.getTestCase({ testCaseKey: 'PROJ-T1' });
+ * ```
+ */
+import { TestCaseGroup } from './groups/TestCase';
+import { TestCycleGroup } from './groups/TestCycle';
+import { TestExecutionGroup } from './groups/TestExecution';
+import { TestPlanGroup } from './groups/TestPlan';
+import { FolderGroup } from './groups/Folder';
+import { ProjectGroup } from './groups/Project';
+import { StatusGroup } from './groups/Status';
+import { PriorityGroup } from './groups/Priority';
+import { EnvironmentGroup } from './groups/Environment';
+import { LinkGroup } from './groups/Link';
+import { IssueLinkGroup } from './groups/IssueLink';
+import { AutomationGroup } from './groups/Automation';
+import { AllGroup } from './groups/All';
+/**
+ * Type for API connection that provides fetch method
+ * Use structural type for maximum compatibility
+ */
+export interface ZephyrApiConnection {
+    fetch: (path: string, options?: {
+        method?: string;
+        headers?: Record<string, string> | Headers | Array<[string, string]>;
+        body?: string | FormData | Blob | ArrayBuffer | URLSearchParams | null;
+    }) => Promise<{
+        ok: boolean;
+        status: number;
+        statusText: string;
+        json(): Promise<any>;
+        headers: {
+            get(name: string): string | null;
+        };
+    }>;
+    connectionId?: string;
+}
+/**
+ * Main Zephyr API class
+ * Provides hierarchical access to all Zephyr API groups
+ */
+export declare class ZephyrApi {
+    readonly TestCase: TestCaseGroup;
+    readonly TestCycle: TestCycleGroup;
+    readonly TestExecution: TestExecutionGroup;
+    readonly TestPlan: TestPlanGroup;
+    readonly Folder: FolderGroup;
+    readonly Project: ProjectGroup;
+    readonly Status: StatusGroup;
+    readonly Priority: PriorityGroup;
+    readonly Environment: EnvironmentGroup;
+    readonly Link: LinkGroup;
+    readonly IssueLink: IssueLinkGroup;
+    readonly Automation: AutomationGroup;
+    readonly All: AllGroup;
+    /**
+     * Access to the underlying API connection for advanced use cases
+     */
+    readonly fetch: ZephyrApiConnection['fetch'];
+    readonly connectionId?: string;
+    constructor(apiConnection: ZephyrApiConnection);
+}
+/**
+ * Create a Zephyr API instance with the provided API connection (Connector-based)
+ *
+ * @param apiConnection - The API connection from scripts/api/zephyr
+ * @param region - API region ('us' or 'eu'), defaults to 'us'
+ * @returns A Zephyr API instance with all resource groups
+ *
+ * @example
+ * ```typescript
+ * import { createZephyrApi } from './zephyr';
+ * import ZephyrApiConnection from '../api/zephyr';
+ *
+ * const Zephyr = createZephyrApi(ZephyrApiConnection, 'us');
+ * const testCase = await Zephyr.TestCase.getTestCase({ testCaseKey: 'PROJ-T1' });
+ * ```
+ */
+export declare function createZephyrApi(apiConnection: ZephyrApiConnection, region?: 'us' | 'eu'): ZephyrApi;
+/**
+ * Create a Zephyr API instance with OAuth token
+ *
+ * @param oauthToken - The OAuth token string
+ * @param region - API region ('us' or 'eu'), defaults to 'us'
+ * @param baseUrl - Optional custom base URL (overrides region)
+ * @returns A Zephyr API instance with all resource groups
+ *
+ * @example
+ * ```typescript
+ * import { createZephyrApi } from './zephyr';
+ *
+ * // OAuth token authentication
+ * const Zephyr = createZephyrApi('oauth-token-string', 'us');
+ * const testCase = await Zephyr.TestCase.getTestCase({ testCaseKey: 'PROJ-T1' });
+ * ```
+ */
+export declare function createZephyrApi(oauthToken: string, region?: 'us' | 'eu', baseUrl?: string): ZephyrApi;
+export * from './types';
+export * from './error-strategy';
+export { getAllPages, getAllPagesCursor } from './utils';
+export { HttpError, BadRequestError, UnauthorizedError, ForbiddenError, NotFoundError, TooManyRequestsError, ServerError, UnexpectedError, } from './utils';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AAC5D,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAChD,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC1C,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AACtD,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAExC;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IACnC,KAAK,EAAE,CACN,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE;QACT,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,GAAG,KAAK,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;QACrE,IAAI,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,IAAI,GAAG,WAAW,GAAG,eAAe,GAAG,IAAI,CAAC;KACvE,KACG,OAAO,CAAC;QACZ,EAAE,EAAE,OAAO,CAAC;QACZ,MAAM,EAAE,MAAM,CAAC;QACf,UAAU,EAAE,MAAM,CAAC;QACnB,IAAI,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC;QACrB,OAAO,EAAE;YAAE,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAA;SAAE,CAAC;KAC9C,CAAC,CAAC;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACtB;AAkED;;;GAGG;AACH,qBAAa,SAAS;IACrB,SAAgB,QAAQ,EAAE,aAAa,CAAC;IACxC,SAAgB,SAAS,EAAE,cAAc,CAAC;IAC1C,SAAgB,aAAa,EAAE,kBAAkB,CAAC;IAClD,SAAgB,QAAQ,EAAE,aAAa,CAAC;IACxC,SAAgB,MAAM,EAAE,WAAW,CAAC;IACpC,SAAgB,OAAO,EAAE,YAAY,CAAC;IACtC,SAAgB,MAAM,EAAE,WAAW,CAAC;IACpC,SAAgB,QAAQ,EAAE,aAAa,CAAC;IACxC,SAAgB,WAAW,EAAE,gBAAgB,CAAC;IAC9C,SAAgB,IAAI,EAAE,SAAS,CAAC;IAChC,SAAgB,SAAS,EAAE,cAAc,CAAC;IAC1C,SAAgB,UAAU,EAAE,eAAe,CAAC;IAC5C,SAAgB,GAAG,EAAE,QAAQ,CAAC;IAE9B;;OAEG;IACH,SAAgB,KAAK,EAAE,mBAAmB,CAAC,OAAO,CAAC,CAAC;IACpD,SAAgB,YAAY,CAAC,EAAE,MAAM,CAAC;gBAE1B,aAAa,EAAE,mBAAmB;CAmB9C;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,eAAe,CAC9B,aAAa,EAAE,mBAAmB,EAClC,MAAM,CAAC,EAAE,IAAI,GAAG,IAAI,GAClB,SAAS,CAAC;AAEb;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,eAAe,CAC9B,UAAU,EAAE,MAAM,EAClB,MAAM,CAAC,EAAE,IAAI,GAAG,IAAI,EACpB,OAAO,CAAC,EAAE,MAAM,GACd,SAAS,CAAC;AAyBb,cAAc,SAAS,CAAC;AAGxB,cAAc,kBAAkB,CAAC;AAGjC,OAAO,EAAE,WAAW,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC;AAGzD,OAAO,EACN,SAAS,EACT,eAAe,EACf,iBAAiB,EACjB,cAAc,EACd,aAAa,EACb,oBAAoB,EACpB,WAAW,EACX,eAAe,GACf,MAAM,SAAS,CAAC"}