@rbaileysr/zephyr-managed-api 1.3.6 → 1.3.8

package/dist/groups/Private/PrivateConfig.js

@@ -16,46 +16,62 @@ export class PrivateConfig extends PrivateBase {
         this.DataSets = new PrivateDataSets(apiConnection);
     }
     /**
-     * Archive a config item (Environment or Iteration) using private API
+     * Archive a config item using private API
      *
-     * Archives an Environment or Iteration by setting its `isArchived` flag to `true`.
+     * Archives a config item (Environment, Iteration, or Status) by setting its `isArchived` flag to `true`.
+     *
+     * Supported config types:
+     * - 'Environment' - Archive an environment
+     * - 'Iteration' - Archive an iteration
+     * - 'TestCaseStatus' - Archive a test case status
+     * - 'TestPlanStatus' - Archive a test plan status
+     * - 'TestCycleStatus' - Archive a test cycle status
+     * - 'TestExecutionStatus' - Archive a test execution status
      *
      * ⚠️ WARNING: This uses a private Zephyr API endpoint that is not officially supported.
      * The endpoint may change or be removed at any time without notice.
      *
      * @param credentials - Private API credentials
      * @param request - Archive config request
-     * @param request.type - Type of config item: 'Environment' or 'Iteration'
-     * @param request.id - Numeric ID of the environment or iteration to archive
+     * @param request.type - Type of config item: 'Environment', 'Iteration', 'TestCaseStatus', 'TestPlanStatus', 'TestCycleStatus', or 'TestExecutionStatus'
+     * @param request.id - Numeric ID of the config item to archive
      * @param request.projectId - Jira project ID (numeric, not the project key)
      * @returns Archive response with the ID of the archived item
      * @throws {BadRequestError} If the request is invalid
      * @throws {UnauthorizedError} If authentication fails
      * @throws {ForbiddenError} If the user doesn't have permission
-     * @throws {NotFoundError} If the environment or iteration is not found
+     * @throws {NotFoundError} If the config item is not found
      * @throws {ServerError} If the server returns an error
      */
     async archiveConfig(credentials, request) {
         return this.updateArchiveStatus(credentials, request, true);
     }
     /**
-     * Unarchive a config item (Environment or Iteration) using private API
+     * Unarchive a config item using private API
+     *
+     * Unarchives a config item (Environment, Iteration, or Status) by setting its `isArchived` flag to `false`.
      *
-     * Unarchives an Environment or Iteration by setting its `isArchived` flag to `false`.
+     * Supported config types:
+     * - 'Environment' - Unarchive an environment
+     * - 'Iteration' - Unarchive an iteration
+     * - 'TestCaseStatus' - Unarchive a test case status
+     * - 'TestPlanStatus' - Unarchive a test plan status
+     * - 'TestCycleStatus' - Unarchive a test cycle status
+     * - 'TestExecutionStatus' - Unarchive a test execution status
      *
      * ⚠️ WARNING: This uses a private Zephyr API endpoint that is not officially supported.
      * The endpoint may change or be removed at any time without notice.
      *
      * @param credentials - Private API credentials
      * @param request - Archive config request (same interface as archive, but sets isArchived to false)
-     * @param request.type - Type of config item: 'Environment' or 'Iteration'
-     * @param request.id - Numeric ID of the environment or iteration to unarchive
+     * @param request.type - Type of config item: 'Environment', 'Iteration', 'TestCaseStatus', 'TestPlanStatus', 'TestCycleStatus', or 'TestExecutionStatus'
+     * @param request.id - Numeric ID of the config item to unarchive
      * @param request.projectId - Jira project ID (numeric, not the project key)
      * @returns Archive response with the ID of the unarchived item
      * @throws {BadRequestError} If the request is invalid
      * @throws {UnauthorizedError} If authentication fails
      * @throws {ForbiddenError} If the user doesn't have permission
-     * @throws {NotFoundError} If the environment or iteration is not found
+     * @throws {NotFoundError} If the config item is not found
      * @throws {ServerError} If the server returns an error
      */
     async unarchiveConfig(credentials, request) {
@@ -67,8 +83,16 @@ export class PrivateConfig extends PrivateBase {
     async updateArchiveStatus(credentials, request, isArchived) {
         // Get Context JWT
         const contextJwt = await this.getContextJwt(credentials);
-        // Determine endpoint based on type
-        const endpoint = request.type.toLowerCase(); // 'environment' or 'iteration'
+        // Map config type to endpoint path
+        const endpointMap = {
+            Environment: 'environment',
+            Iteration: 'iteration',
+            TestCaseStatus: 'testcasestatus',
+            TestPlanStatus: 'testplanstatus',
+            TestCycleStatus: 'testrunstatus',
+            TestExecutionStatus: 'testresultstatus',
+        };
+        const endpoint = endpointMap[request.type];
         const url = `${this.privateApiBaseUrl}/${endpoint}/${request.id}`;
         const headers = {
             'Content-Type': 'application/json',

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

@@ -0,0 +1,229 @@
+/*!
+ * Copyright Adaptavist 2025 (c) All rights reserved
+ */
+/**
+ * Private API Extended Data sub-group
+ * Supplements public API with extended data (iterations, versions) for Test Cycles and Test Executions
+ *
+ * ⚠️ WARNING: These methods use private APIs that are not officially supported.
+ */
+import type { PrivateApiCredentials, GetTestCycleIterationRequest, TestCycleIterationResponse, UpdateTestCycleIterationRequest, GetTestExecutionIterationRequest, TestExecutionIterationResponse, UpdateTestExecutionIterationRequest, GetTestExecutionVersionRequest, TestExecutionVersionResponse, UpdateTestExecutionVersionRequest } from '../../types';
+import type { ZephyrApiConnection } from '../../index';
+import { PrivateBase } from './PrivateBase';
+export declare class PrivateExtendedData extends PrivateBase {
+    constructor(apiConnection?: ZephyrApiConnection);
+    /**
+     * Get test cycle iteration using private API
+     *
+     * Retrieves iteration data for a test cycle that is not available in the public API.
+     * Use this to supplement the public `getTestCycle()` response with iteration information.
+     *
+     * ⚠️ WARNING: This uses a private Zephyr API endpoint that is not officially supported.
+     * The endpoint may change or be removed at any time without notice.
+     *
+     * @param credentials - Private API credentials
+     * @param request - Get test cycle iteration request
+     * @param request.testCycleKey - Test cycle key (e.g., "M12-R1")
+     * @param request.projectId - Jira project ID (numeric, not the project key)
+     * @returns Test cycle iteration response with iterationId (null if not set)
+     * @throws {BadRequestError} If the request is invalid
+     * @throws {UnauthorizedError} If authentication fails
+     * @throws {ForbiddenError} If the user doesn't have permission
+     * @throws {NotFoundError} If the test cycle is not found
+     * @throws {ServerError} If the server returns an error
+     *
+     * @example
+     * ```typescript
+     * // Get iteration for a test cycle (supplements public getTestCycle)
+     * const publicData = await api.TestCycle.getTestCycle({ key: 'M12-R1' });
+     * const iterationData = await api.Private.IterationData.getTestCycleIteration(credentials, {
+     *   testCycleKey: 'M12-R1',
+     *   projectId: 10313
+     * });
+     * console.log('Iteration ID:', iterationData.iterationId);
+     * ```
+     */
+    getTestCycleIteration(credentials: PrivateApiCredentials, request: GetTestCycleIterationRequest): Promise<TestCycleIterationResponse>;
+    /**
+     * Update test cycle iteration using private API
+     *
+     * Sets or clears the iteration for a test cycle. Use this to supplement
+     * a test cycle created via the public API with iteration data.
+     *
+     * ⚠️ WARNING: This uses a private Zephyr API endpoint that is not officially supported.
+     * The endpoint may change or be removed at any time without notice.
+     *
+     * @param credentials - Private API credentials
+     * @param request - Update test cycle iteration request
+     * @param request.testCycleKey - Test cycle key (e.g., "M12-R1")
+     * @param request.projectId - Jira project ID (numeric, not the project key)
+     * @param request.iterationId - Iteration ID to set, or null to clear
+     * @throws {BadRequestError} If the request is invalid
+     * @throws {UnauthorizedError} If authentication fails
+     * @throws {ForbiddenError} If the user doesn't have permission
+     * @throws {NotFoundError} If the test cycle is not found
+     * @throws {ServerError} If the server returns an error
+     *
+     * @example
+     * ```typescript
+     * // Create test cycle with public API, then set iteration with private API
+     * const testCycle = await api.TestCycle.createTestCycle({
+     *   projectKey: 'M12',
+     *   name: 'Sprint 1 Testing'
+     * });
+     *
+     * // Set iteration using private API
+     * await api.Private.IterationData.updateTestCycleIteration(credentials, {
+     *   testCycleKey: testCycle.key,
+     *   projectId: 10313,
+     *   iterationId: 10952254
+     * });
+     * ```
+     */
+    updateTestCycleIteration(credentials: PrivateApiCredentials, request: UpdateTestCycleIterationRequest): Promise<void>;
+    /**
+     * Get test execution iteration using private API
+     *
+     * Retrieves iteration data for a test execution that is not available in the public API.
+     * Use this to supplement the public `getTestExecution()` response with iteration information.
+     *
+     * ⚠️ WARNING: This uses a private Zephyr API endpoint that is not officially supported.
+     * The endpoint may change or be removed at any time without notice.
+     *
+     * @param credentials - Private API credentials
+     * @param request - Get test execution iteration request
+     * @param request.testExecutionKey - Test execution key (e.g., "M12-E1")
+     * @param request.projectId - Jira project ID (numeric, not the project key)
+     * @returns Test execution iteration response with iterationId (null if not set)
+     * @throws {BadRequestError} If the request is invalid
+     * @throws {UnauthorizedError} If authentication fails
+     * @throws {ForbiddenError} If the user doesn't have permission
+     * @throws {NotFoundError} If the test execution is not found
+     * @throws {ServerError} If the server returns an error
+     *
+     * @example
+     * ```typescript
+     * // Get iteration for a test execution (supplements public getTestExecution)
+     * const publicData = await api.TestExecution.getTestExecution({ key: 'M12-E1' });
+     * const iterationData = await api.Private.IterationData.getTestExecutionIteration(credentials, {
+     *   testExecutionKey: 'M12-E1',
+     *   projectId: 10313
+     * });
+     * console.log('Iteration ID:', iterationData.iterationId);
+     * ```
+     */
+    getTestExecutionIteration(credentials: PrivateApiCredentials, request: GetTestExecutionIterationRequest): Promise<TestExecutionIterationResponse>;
+    /**
+     * Update test execution iteration using private API
+     *
+     * Sets or clears the iteration for a test execution. Use this to supplement
+     * a test execution created via the public API with iteration data.
+     *
+     * ⚠️ WARNING: This uses a private Zephyr API endpoint that is not officially supported.
+     * The endpoint may change or be removed at any time without notice.
+     *
+     * @param credentials - Private API credentials
+     * @param request - Update test execution iteration request
+     * @param request.testExecutionKey - Test execution key (e.g., "M12-E1")
+     * @param request.projectId - Jira project ID (numeric, not the project key)
+     * @param request.iterationId - Iteration ID to set, or null to clear
+     * @throws {BadRequestError} If the request is invalid
+     * @throws {UnauthorizedError} If authentication fails
+     * @throws {ForbiddenError} If the user doesn't have permission
+     * @throws {NotFoundError} If the test execution is not found
+     * @throws {ServerError} If the server returns an error
+     *
+     * @example
+     * ```typescript
+     * // Create test execution with public API (returns void), then set iteration with private API
+     * await api.TestExecution.createTestExecution({
+     *   projectKey: 'M12',
+     *   testCaseKey: 'M12-T1',
+     *   testCycleKey: 'M12-R1',
+     *   statusName: 'Pass'
+     * });
+     *
+     * // Note: createTestExecution returns no data, so use known key or look up after creation
+     * // Set iteration using private API
+     * await api.Private.IterationData.updateTestExecutionIteration(credentials, {
+     *   testExecutionKey: 'M12-E1', // Use known key or look up via listTestExecutions()
+     *   projectId: 10313,
+     *   iterationId: 10952254
+     * });
+     * ```
+     */
+    updateTestExecutionIteration(credentials: PrivateApiCredentials, request: UpdateTestExecutionIterationRequest): Promise<void>;
+    /**
+     * Get test execution version using private API
+     *
+     * Retrieves Jira version ID (release version) for a test execution that is not available in the public API.
+     * Use this to supplement the public `getTestExecution()` response with version information.
+     *
+     * ⚠️ WARNING: This uses a private Zephyr API endpoint that is not officially supported.
+     * The endpoint may change or be removed at any time without notice.
+     *
+     * @param credentials - Private API credentials
+     * @param request - Get test execution version request
+     * @param request.testExecutionKey - Test execution key (e.g., "M15-E3")
+     * @param request.projectId - Jira project ID (numeric, not the project key)
+     * @returns Test execution version response with jiraVersionId (null if not set)
+     * @throws {BadRequestError} If the request is invalid
+     * @throws {UnauthorizedError} If authentication fails
+     * @throws {ForbiddenError} If the user doesn't have permission
+     * @throws {NotFoundError} If the test execution is not found
+     * @throws {ServerError} If the server returns an error
+     *
+     * @example
+     * ```typescript
+     * // Get version for a test execution (supplements public getTestExecution)
+     * const publicData = await api.TestExecution.getTestExecution({ key: 'M15-E3' });
+     * const versionData = await api.Private.IterationData.getTestExecutionVersion(credentials, {
+     *   testExecutionKey: 'M15-E3',
+     *   projectId: 10316
+     * });
+     * console.log('Jira Version ID:', versionData.jiraVersionId);
+     * ```
+     */
+    getTestExecutionVersion(credentials: PrivateApiCredentials, request: GetTestExecutionVersionRequest): Promise<TestExecutionVersionResponse>;
+    /**
+     * Update test execution version using private API
+     *
+     * Sets or clears the Jira version ID (release version) for a test execution. Use this to supplement
+     * a test execution created via the public API with version data.
+     *
+     * ⚠️ WARNING: This uses a private Zephyr API endpoint that is not officially supported.
+     * The endpoint may change or be removed at any time without notice.
+     *
+     * @param credentials - Private API credentials
+     * @param request - Update test execution version request
+     * @param request.testExecutionKey - Test execution key (e.g., "M15-E3")
+     * @param request.projectId - Jira project ID (numeric, not the project key)
+     * @param request.jiraVersionId - Jira version ID to set, or null to clear
+     * @throws {BadRequestError} If the request is invalid
+     * @throws {UnauthorizedError} If authentication fails
+     * @throws {ForbiddenError} If the user doesn't have permission
+     * @throws {NotFoundError} If the test execution is not found
+     * @throws {ServerError} If the server returns an error
+     *
+     * @example
+     * ```typescript
+     * // Create test execution with public API (returns void), then set version with private API
+     * await api.TestExecution.createTestExecution({
+     *   projectKey: 'M15',
+     *   testCaseKey: 'M15-T3',
+     *   testCycleKey: 'M15-R1',
+     *   statusName: 'Pass'
+     * });
+     *
+     * // Note: createTestExecution returns no data, so use known key or look up after creation
+     * // Set version using private API
+     * await api.Private.IterationData.updateTestExecutionVersion(credentials, {
+     *   testExecutionKey: 'M15-E3', // Use known key or look up via listTestExecutions()
+     *   projectId: 10316,
+     *   jiraVersionId: 10102
+     * });
+     * ```
+     */
+    updateTestExecutionVersion(credentials: PrivateApiCredentials, request: UpdateTestExecutionVersionRequest): Promise<void>;
+}
+//# sourceMappingURL=PrivateExtendedData.d.ts.map

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

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