@rbaileysr/zephyr-managed-api 1.2.1 → 1.2.9

package/dist/groups/Private/PrivateCustomFields.js

@@ -0,0 +1,150 @@
+/*!
+ * Copyright Adaptavist 2025 (c) All rights reserved
+ */
+import { PrivateBase } from './PrivateBase';
+import { BadRequestError, UnauthorizedError, ForbiddenError, NotFoundError, ServerError, UnexpectedError, } from '../../utils';
+export class PrivateCustomFields extends PrivateBase {
+    constructor(apiConnection) {
+        super(apiConnection);
+    }
+    /**
+     * Create a custom field using private API
+     *
+     * Creates a custom field for the specified entity type (test case, test plan, test run, test step, or test execution).
+     *
+     * ⚠️ 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 category - Entity type for the custom field (TEST_CASE, TEST_PLAN, TEST_RUN, TEST_STEP, or TEST_EXECUTION)
+     * @param request - Custom field creation request
+     * @returns The created custom field response
+     * @throws {BadRequestError} If the request is invalid
+     * @throws {UnauthorizedError} If authentication fails
+     * @throws {ForbiddenError} If the user doesn't have permission
+     * @throws {ServerError} If the server returns an error
+     */
+    async createCustomField(credentials, category, request) {
+        // Get Context JWT
+        const contextJwt = await this.getContextJwt(credentials);
+        // Determine endpoint based on category
+        const endpointMap = {
+            TEST_CASE: 'customfield/testcase',
+            TEST_PLAN: 'customfield/testplan',
+            TEST_RUN: 'customfield/testrun',
+            TEST_STEP: 'customfield/teststep',
+            TEST_EXECUTION: 'customfield/testexecution',
+        };
+        const url = `${this.privateApiBaseUrl}/${endpointMap[category]}`;
+        const headers = {
+            'Content-Type': 'application/json',
+            authorization: `JWT ${contextJwt}`,
+            'jira-project-id': String(request.projectId),
+        };
+        try {
+            const response = await fetch(url, {
+                method: 'POST',
+                headers,
+                body: JSON.stringify(request),
+            });
+            if (!response.ok) {
+                if (response.status === 400) {
+                    const errorText = await response.text().catch(() => 'Bad Request');
+                    throw new BadRequestError(`Failed to create custom field: ${errorText}`, response.statusText);
+                }
+                if (response.status === 401) {
+                    throw new UnauthorizedError('Authentication failed. Please check your credentials.');
+                }
+                if (response.status === 403) {
+                    throw new ForbiddenError('You do not have permission to create custom fields in this project.');
+                }
+                if (response.status === 404) {
+                    throw new NotFoundError('Project or resource not found.');
+                }
+                throw new ServerError(`Failed to create custom field. Status: ${response.status}`, response.status, response.statusText);
+            }
+            return await response.json();
+        }
+        catch (error) {
+            if (error instanceof BadRequestError ||
+                error instanceof UnauthorizedError ||
+                error instanceof ForbiddenError ||
+                error instanceof NotFoundError ||
+                error instanceof ServerError) {
+                throw error;
+            }
+            throw new UnexpectedError('Unexpected error while creating custom field', error);
+        }
+    }
+    /**
+     * Get custom fields for a specific entity type using private API
+     *
+     * Retrieves all custom fields configured for the specified entity type (test case, test plan, test run, test step, or test execution) in a project.
+     *
+     * ⚠️ 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 category - Entity type for the custom fields (TEST_CASE, TEST_PLAN, TEST_RUN, TEST_STEP, or TEST_EXECUTION)
+     * @param request - Get custom fields request
+     * @param request.projectId - Jira project ID (numeric, not the project key)
+     * @returns Array of custom field definitions
+     * @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 project is not found
+     * @throws {ServerError} If the server returns an error
+     */
+    async getCustomFields(credentials, category, request) {
+        // Get Context JWT
+        const contextJwt = await this.getContextJwt(credentials);
+        // Determine endpoint based on category
+        // Note: API uses "testrun" in URL even though category is "TEST_RUN"
+        const endpointMap = {
+            TEST_CASE: 'testcase',
+            TEST_PLAN: 'testplan',
+            TEST_RUN: 'testrun', // API uses "testrun" in URL
+            TEST_STEP: 'teststep',
+            TEST_EXECUTION: 'testexecution',
+        };
+        const url = `${this.privateApiBaseUrl}/project/${request.projectId}/customfields/${endpointMap[category]}?projectId=${request.projectId}`;
+        const headers = {
+            accept: 'application/json',
+            authorization: `JWT ${contextJwt}`,
+            'jira-project-id': String(request.projectId),
+        };
+        try {
+            const response = await fetch(url, {
+                method: 'GET',
+                headers,
+            });
+            if (!response.ok) {
+                if (response.status === 400) {
+                    const errorText = await response.text().catch(() => 'Bad Request');
+                    throw new BadRequestError(`Failed to get custom fields: ${errorText}`, response.statusText);
+                }
+                if (response.status === 401) {
+                    throw new UnauthorizedError('Authentication failed. Please check your credentials.');
+                }
+                if (response.status === 403) {
+                    throw new ForbiddenError('You do not have permission to view custom fields in this project.');
+                }
+                if (response.status === 404) {
+                    throw new NotFoundError('Project not found.');
+                }
+                throw new ServerError(`Failed to get custom fields. Status: ${response.status}`, response.status, response.statusText);
+            }
+            return (await response.json());
+        }
+        catch (error) {
+            if (error instanceof BadRequestError ||
+                error instanceof UnauthorizedError ||
+                error instanceof ForbiddenError ||
+                error instanceof NotFoundError ||
+                error instanceof ServerError) {
+                throw error;
+            }
+            throw new UnexpectedError('Unexpected error while getting custom fields', error);
+        }
+    }
+}

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

@@ -0,0 +1,38 @@
+/*!
+ * Copyright Adaptavist 2025 (c) All rights reserved
+ */
+/**
+ * Private API Versions sub-group
+ * Handles test case version creation
+ *
+ * ⚠️ WARNING: These methods use private APIs that are not officially supported.
+ */
+import type { PrivateApiCredentials, CreateTestCaseVersionRequest, CreateTestCaseVersionResponse } from '../../types';
+import { PrivateBase } from './PrivateBase';
+import type { ZephyrApiConnection } from '../../index';
+export declare class PrivateVersions extends PrivateBase {
+    constructor(apiConnection?: ZephyrApiConnection);
+    /**
+     * Create a new test case version using private API
+     *
+     * Creates a new version of an existing test case. Note that when a new version
+     * is created, the testCaseId changes for that test case.
+     *
+     * ⚠️ 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 - Test case version creation 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)
+     * @returns The created version response with id and key
+     * @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 case is not found
+     * @throws {ServerError} If the server returns an error (including 409 Conflict if version already exists)
+     * @throws {UnexpectedError} If test case ID cannot be looked up from key and Zephyr Connector is not available
+     */
+    createTestCaseVersion(credentials: PrivateApiCredentials, request: CreateTestCaseVersionRequest): Promise<CreateTestCaseVersionResponse>;
+}
+//# sourceMappingURL=PrivateVersions.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"PrivateVersions.d.ts","sourceRoot":"","sources":["../../../groups/Private/PrivateVersions.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,qBAAqB,EAAE,4BAA4B,EAAE,6BAA6B,EAAE,MAAM,aAAa,CAAC;AACtH,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAS5C,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAEvD,qBAAa,eAAgB,SAAQ,WAAW;gBACnC,aAAa,CAAC,EAAE,mBAAmB;IAI/C;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,qBAAqB,CAC1B,WAAW,EAAE,qBAAqB,EAClC,OAAO,EAAE,4BAA4B,GACnC,OAAO,CAAC,6BAA6B,CAAC;CAuFzC"}

package/dist/groups/Private/PrivateVersions.js

@@ -0,0 +1,99 @@
+/*!
+ * Copyright Adaptavist 2025 (c) All rights reserved
+ */
+import { PrivateBase } from './PrivateBase';
+import { BadRequestError, UnauthorizedError, ForbiddenError, NotFoundError, ServerError, UnexpectedError, } from '../../utils';
+export class PrivateVersions extends PrivateBase {
+    constructor(apiConnection) {
+        super(apiConnection);
+    }
+    /**
+     * Create a new test case version using private API
+     *
+     * Creates a new version of an existing test case. Note that when a new version
+     * is created, the testCaseId changes for that test case.
+     *
+     * ⚠️ 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 - Test case version creation 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)
+     * @returns The created version response with id and key
+     * @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 case is not found
+     * @throws {ServerError} If the server returns an error (including 409 Conflict if version already exists)
+     * @throws {UnexpectedError} If test case ID cannot be looked up from key and Zephyr Connector is not available
+     */
+    async createTestCaseVersion(credentials, request) {
+        // Get test case ID from key if we have API connection
+        let testCaseId;
+        if (this.testCaseGroup) {
+            try {
+                const testCase = await this.testCaseGroup.getTestCase({ testCaseKey: request.testCaseKey });
+                if (!testCase) {
+                    throw new NotFoundError(`Test case with key '${request.testCaseKey}' not found.`);
+                }
+                testCaseId = testCase.id;
+            }
+            catch (error) {
+                if (error instanceof NotFoundError) {
+                    throw new NotFoundError(`Test case with key '${request.testCaseKey}' not found.`);
+                }
+                throw new UnexpectedError(`Failed to look up test case ID from key '${request.testCaseKey}'. Ensure Zephyr Connector is configured.`, error);
+            }
+        }
+        else {
+            throw new UnexpectedError('Cannot look up test case ID from key. This method requires Zephyr Connector to be configured. Use createZephyrApi() with an API Connection.');
+        }
+        // Get Context JWT
+        const contextJwt = await this.getContextJwt(credentials);
+        const url = `${this.privateApiBaseUrl}/testcase/${testCaseId}/newversion`;
+        const headers = {
+            'Content-Type': 'application/json',
+            authorization: `JWT ${contextJwt}`,
+            'jira-project-id': String(request.projectId),
+        };
+        try {
+            const response = await fetch(url, {
+                method: 'POST',
+                headers,
+                body: JSON.stringify({}), // Empty body as per documentation
+            });
+            if (!response.ok) {
+                if (response.status === 400) {
+                    const errorText = await response.text().catch(() => 'Bad Request');
+                    throw new BadRequestError(`Failed to create test case version: ${errorText}`, response.statusText);
+                }
+                if (response.status === 401) {
+                    throw new UnauthorizedError('Authentication failed. Please check your credentials.');
+                }
+                if (response.status === 403) {
+                    throw new ForbiddenError('You do not have permission to create test case versions in this project.');
+                }
+                if (response.status === 404) {
+                    throw new NotFoundError('Test case not found.');
+                }
+                if (response.status === 409) {
+                    throw new ServerError('Conflict: A new version already exists for this test case.', response.status, response.statusText);
+                }
+                throw new ServerError(`Failed to create test case version. Status: ${response.status}`, response.status, response.statusText);
+            }
+            return (await response.json());
+        }
+        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 case version', error);
+        }
+    }
+}

package/dist/groups/Private.d.ts

@@ -1,262 +1,40 @@
 /*!
  * Copyright Adaptavist 2025 (c) All rights reserved
  */
-/**
- * Private API group
- *
- * ⚠️ WARNING: These functions use Zephyr's private/unofficial API endpoints.
- *
- * These endpoints are:
- * - Not officially supported by SmartBear
- * - Not part of the public API documentation
- * - Subject to change at any time without notice
- * - Not covered by Standard Support
- *
- * Use these functions at your own risk. They may break with future Zephyr updates.
- */
-import type { CreatePrivateCustomFieldRequest, PrivateCustomFieldCategory, CreateTestCaseVersionRequest, CreateTestCaseVersionResponse, CreateAttachmentRequest, CreateTestCaseCommentRequest, CreateTestCaseCommentResponse, GetTestCaseAttachmentsRequest, GetTestCaseAttachmentsResponse, DownloadAttachmentRequest } from '../types';
 import type { ZephyrApiConnection } from '../index';
+import { PrivateBase } from './Private/PrivateBase';
+import { PrivateComments } from './Private/PrivateComments';
+import { PrivateCustomFields } from './Private/PrivateCustomFields';
+import { PrivateVersions } from './Private/PrivateVersions';
+import { PrivateAttachments } from './Private/PrivateAttachments';
+import { PrivateAuthentication } from './Private/PrivateAuthentication';
 /**
  * Private API group for accessing Zephyr's private/unofficial endpoints
  *
  * ⚠️ WARNING: These methods use private APIs that are not officially supported.
  * They may change or break at any time without notice.
  */
-export declare class PrivateGroup {
+export declare class PrivateGroup extends PrivateBase {
     /**
-     * Base URL for Zephyr private API endpoints
+     * Authentication sub-group - Get Jira Context JWT token
      */
-    private readonly privateApiBaseUrl;
+    readonly Authentication: PrivateAuthentication;
     /**
-     * Optional API connection for accessing public API (e.g., to look up test case IDs from keys)
+     * Comments sub-group - Get and create comments for test cases, test cycles, and test plans
      */
-    private readonly apiConnection?;
-    private readonly testCaseGroup?;
-    constructor(apiConnection?: ZephyrApiConnection);
+    readonly Comments: PrivateComments;
     /**
-     * Get Jira Context JWT token
-     *
-     * Retrieves a short-lived JWT token (15 minutes) from Jira that is required
-     * for private Zephyr API endpoints. This token may need to be refreshed
-     * during long operations.
-     *
-     * ⚠️ WARNING: This uses a private Jira endpoint and may change without notice.
-     *
-     * @param userEmail - Jira user email address
-     * @param apiToken - Jira API token
-     * @param jiraInstanceUrl - Full Jira instance URL (e.g., 'https://your-instance.atlassian.net')
-     * @returns The Context JWT token string
-     * @throws {UnauthorizedError} If authentication fails
-     * @throws {UnexpectedError} If the JWT cannot be extracted from the response
+     * CustomFields sub-group - Create and get custom fields
      */
-    getContextJwt(userEmail: string, apiToken: string, jiraInstanceUrl: string): Promise<string>;
+    readonly CustomFields: PrivateCustomFields;
     /**
-     * Create a custom field using private API
-     *
-     * Creates a custom field for the specified entity type (test case, test plan, test run, or test step).
-     *
-     * ⚠️ 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 userEmail - Jira user email address
-     * @param apiToken - Jira API token
-     * @param jiraInstanceUrl - Full Jira instance URL (e.g., 'https://your-instance.atlassian.net')
-     * @param category - Entity type for the custom field (TEST_CASE, TEST_PLAN, TEST_RUN, or TEST_STEP)
-     * @param request - Custom field creation request
-     * @returns The created custom field response
-     * @throws {BadRequestError} If the request is invalid
-     * @throws {UnauthorizedError} If authentication fails
-     * @throws {ForbiddenError} If the user doesn't have permission
-     * @throws {ServerError} If the server returns an error
+     * Versions sub-group - Create test case versions
      */
-    createCustomField(userEmail: string, apiToken: string, jiraInstanceUrl: string, category: PrivateCustomFieldCategory, request: CreatePrivateCustomFieldRequest): Promise<unknown>;
+    readonly Versions: PrivateVersions;
     /**
-     * Create a new test case version using private API
-     *
-     * Creates a new version of an existing test case. Note that when a new version
-     * is created, the testCaseId changes for that test case.
-     *
-     * ⚠️ 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 userEmail - Jira user email address
-     * @param apiToken - Jira API token
-     * @param jiraInstanceUrl - Full Jira instance URL (e.g., 'https://your-instance.atlassian.net')
-     * @param request - Test case version creation 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)
-     * @returns The created version response with id and key
-     * @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 case is not found
-     * @throws {ServerError} If the server returns an error (including 409 Conflict if version already exists)
-     * @throws {UnexpectedError} If test case ID cannot be looked up from key and Zephyr Connector is not available
+     * Attachments sub-group - Get, download, and create attachments
      */
-    createTestCaseVersion(userEmail: string, apiToken: string, jiraInstanceUrl: string, request: CreateTestCaseVersionRequest): Promise<CreateTestCaseVersionResponse>;
-    /**
-     * Get upload details for attachment upload
-     *
-     * Retrieves S3 upload credentials and configuration needed to upload an attachment.
-     *
-     * ⚠️ 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 contextJwt - Jira Context JWT token
-     * @returns Upload details including S3 bucket URL, credentials, and policy
-     * @throws {UnauthorizedError} If authentication fails
-     * @throws {ServerError} If the server returns an error
-     */
-    private getUploadDetails;
-    /**
-     * Upload file to S3
-     *
-     * Uploads a file to S3 using the credentials from upload details.
-     *
-     * @param upload - Upload details from getUploadDetails
-     * @param projectId - Jira project ID
-     * @param testCaseId - Numeric test case ID
-     * @param userAccountId - Atlassian account ID
-     * @param file - File to upload (Blob or ArrayBuffer)
-     * @param fileName - Name of the file
-     * @returns S3 upload information
-     * @throws {UnexpectedError} If upload fails
-     */
-    private uploadToS3;
-    /**
-     * Save attachment metadata
-     *
-     * Saves metadata for an uploaded attachment.
-     *
-     * @param contextJwt - Jira Context JWT token
-     * @param projectId - Jira project ID
-     * @param testCaseId - Numeric test case ID
-     * @param userAccountId - Atlassian account ID
-     * @param s3Key - S3 key from upload
-     * @param fileName - File name
-     * @param mimeType - MIME type
-     * @param fileSize - File size in bytes
-     * @returns Attachment metadata response
-     * @throws {BadRequestError} If the request is invalid
-     * @throws {UnauthorizedError} If authentication fails
-     * @throws {ServerError} If the server returns an error
-     */
-    private saveAttachmentMetadata;
-    /**
-     * Create a comment on a test case using private API
-     *
-     * Adds a comment to an existing test case. The comment will be associated with
-     * the specified user account ID.
-     *
-     * ⚠️ 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 userEmail - Jira user email address
-     * @param apiToken - Jira API token
-     * @param jiraInstanceUrl - Full Jira instance URL (e.g., 'https://your-instance.atlassian.net')
-     * @param request - Comment creation 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.body - Comment text/body
-     * @param request.createdBy - Atlassian account ID of the user creating the comment (e.g., '5d6fdc98dc6e480dbc021aae')
-     * @returns Comment creation response
-     * @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 case is not found
-     * @throws {ServerError} If the server returns an error
-     * @throws {UnexpectedError} If test case ID cannot be looked up from key and Zephyr Connector is not available
-     */
-    createTestCaseComment(userEmail: string, apiToken: string, jiraInstanceUrl: string, request: CreateTestCaseCommentRequest): Promise<CreateTestCaseCommentResponse>;
-    /**
-     * Get attachments for a test case using private API
-     *
-     * Retrieves all attachment details for a test case, including signed S3 URLs
-     * for downloading the attachments.
-     *
-     * ⚠️ 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 userEmail - Jira user email address
-     * @param apiToken - Jira API token
-     * @param jiraInstanceUrl - Full Jira instance URL (e.g., 'https://your-instance.atlassian.net')
-     * @param request - Get attachments 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)
-     * @returns Test case attachments response with array of attachment details
-     * @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 case is not found
-     * @throws {ServerError} If the server returns an error
-     * @throws {UnexpectedError} If test case ID cannot be looked up from key and Zephyr Connector is not available
-     */
-    getTestCaseAttachments(userEmail: string, apiToken: string, jiraInstanceUrl: string, request: GetTestCaseAttachmentsRequest): Promise<GetTestCaseAttachmentsResponse>;
-    /**
-     * Download an attachment from a test case using private API
-     *
-     * Downloads an attachment file into memory. This method:
-     * 1. Gets fresh attachment details (including a fresh signed S3 URL)
-     * 2. Downloads the file from the signed URL
-     * 3. Returns the file as a Blob
-     *
-     * ⚠️ WARNING: This uses private Zephyr API endpoints that are not officially supported.
-     * The endpoints may change or be removed at any time without notice.
-     *
-     * @param userEmail - Jira user email address
-     * @param apiToken - Jira API token
-     * @param jiraInstanceUrl - Full Jira instance URL (e.g., 'https://your-instance.atlassian.net')
-     * @param request - Download attachment 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.attachmentId - Attachment ID (UUID string, e.g., 'c3f14125-638f-47f9-9211-12a9777c09e7')
-     * @returns Blob containing the attachment file data
-     * @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 case or attachment is not found
-     * @throws {ServerError} If the server returns an error
-     * @throws {UnexpectedError} If test case ID cannot be looked up from key and Zephyr Connector is not available, or if download fails
-     */
-    downloadAttachment(userEmail: string, apiToken: string, jiraInstanceUrl: string, request: DownloadAttachmentRequest): Promise<Blob>;
-    /**
-     * Generate a UUID v4 (compatible with ScriptRunner Connect runtime)
-     *
-     * Uses crypto.getRandomValues() which is available in web standards
-     */
-    private generateUUID;
-    /**
-     * Get MIME type from file name
-     */
-    private getMimeType;
-    /**
-     * Create an attachment for a test case using private API
-     *
-     * Uploads a file attachment to a test case. This involves:
-     * 1. Getting upload details (S3 credentials)
-     * 2. Uploading the file to S3
-     * 3. Saving attachment metadata
-     *
-     * ⚠️ WARNING: This uses private Zephyr API endpoints that are not officially supported.
-     * The endpoints may change or be removed at any time without notice.
-     *
-     * @param userEmail - Jira user email address
-     * @param apiToken - Jira API token
-     * @param jiraInstanceUrl - Full Jira instance URL (e.g., 'https://your-instance.atlassian.net')
-     * @param request - Attachment creation 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.file - File to upload (Blob or ArrayBuffer)
-     * @param request.fileName - Name of the file
-     * @param request.userAccountId - Atlassian account ID (e.g., '5d6fdc98dc6e480dbc021aae')
-     * @returns Attachment metadata response
-     * @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 case is not found
-     * @throws {ServerError} If the server returns an error
-     * @throws {UnexpectedError} If test case ID cannot be looked up from key and Zephyr Connector is not available
-     */
-    createAttachment(userEmail: string, apiToken: string, jiraInstanceUrl: string, request: CreateAttachmentRequest): Promise<unknown>;
+    readonly Attachments: PrivateAttachments;
+    constructor(apiConnection?: ZephyrApiConnection);
 }
 //# sourceMappingURL=Private.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"Private.d.ts","sourceRoot":"","sources":["../../groups/Private.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;;;;;;;;;;;GAYG;AAEH,OAAO,KAAK,EACX,+BAA+B,EAC/B,0BAA0B,EAC1B,4BAA4B,EAC5B,6BAA6B,EAG7B,uBAAuB,EACvB,4BAA4B,EAC5B,6BAA6B,EAC7B,6BAA6B,EAC7B,8BAA8B,EAE9B,yBAAyB,EACzB,MAAM,UAAU,CAAC;AAClB,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAWpD;;;;;GAKG;AACH,qBAAa,YAAY;IACxB;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAA2D;IAE7F;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAsB;IACrD,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAgB;gBAEnC,aAAa,CAAC,EAAE,mBAAmB;IAO/C;;;;;;;;;;;;;;;OAeG;IACG,aAAa,CAClB,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,MAAM,EAChB,eAAe,EAAE,MAAM,GACrB,OAAO,CAAC,MAAM,CAAC;IAuElB;;;;;;;;;;;;;;;;;;OAkBG;IACG,iBAAiB,CACtB,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,MAAM,EAChB,eAAe,EAAE,MAAM,EACvB,QAAQ,EAAE,0BAA0B,EACpC,OAAO,EAAE,+BAA+B,GACtC,OAAO,CAAC,OAAO,CAAC;IA8DnB;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,qBAAqB,CAC1B,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,MAAM,EAChB,eAAe,EAAE,MAAM,EACvB,OAAO,EAAE,4BAA4B,GACnC,OAAO,CAAC,6BAA6B,CAAC;IAsFzC;;;;;;;;;;;;OAYG;YACW,gBAAgB;IAiC9B;;;;;;;;;;;;;OAaG;YACW,UAAU;IAsExB;;;;;;;;;;;;;;;;;OAiBG;YACW,sBAAsB;IAgEpC;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,qBAAqB,CAC1B,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,MAAM,EAChB,eAAe,EAAE,MAAM,EACvB,OAAO,EAAE,4BAA4B,GACnC,OAAO,CAAC,6BAA6B,CAAC;IAoFzC;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,sBAAsB,CAC3B,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,MAAM,EAChB,eAAe,EAAE,MAAM,EACvB,OAAO,EAAE,6BAA6B,GACpC,OAAO,CAAC,8BAA8B,CAAC;IA8E1C;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACG,kBAAkB,CACvB,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,MAAM,EAChB,eAAe,EAAE,MAAM,EACvB,OAAO,EAAE,yBAAyB,GAChC,OAAO,CAAC,IAAI,CAAC;IAwDhB;;;;OAIG;IACH,OAAO,CAAC,YAAY;IAwBpB;;OAEG;IACH,OAAO,CAAC,WAAW;IAkBnB;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACG,gBAAgB,CACrB,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,MAAM,EAChB,eAAe,EAAE,MAAM,EACvB,OAAO,EAAE,uBAAuB,GAC9B,OAAO,CAAC,OAAO,CAAC;CAqDnB"}
+{"version":3,"file":"Private.d.ts","sourceRoot":"","sources":["../../groups/Private.ts"],"names":[],"mappings":"AAAA;;GAEG;AA6DH,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AACpD,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAC5D,OAAO,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAC;AACpE,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAC5D,OAAO,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAClE,OAAO,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AASxE;;;;;GAKG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAC5C;;OAEG;IACH,SAAgB,cAAc,EAAE,qBAAqB,CAAC;IAEtD;;OAEG;IACH,SAAgB,QAAQ,EAAE,eAAe,CAAC;IAE1C;;OAEG;IACH,SAAgB,YAAY,EAAE,mBAAmB,CAAC;IAElD;;OAEG;IACH,SAAgB,QAAQ,EAAE,eAAe,CAAC;IAE1C;;OAEG;IACH,SAAgB,WAAW,EAAE,kBAAkB,CAAC;gBAEpC,aAAa,CAAC,EAAE,mBAAmB;CAS/C"}