@rbaileysr/zephyr-managed-api 1.1.0 → 1.2.1

package/README.md

@@ -344,7 +344,11 @@ The Managed API is organized into the following groups:
 
 - `getContextJwt(userEmail, apiToken, jiraInstanceUrl)` - Get Jira Context JWT token (required for private API calls)
 - `createCustomField(userEmail, apiToken, jiraInstanceUrl, category, request)` - Create custom fields for test cases, test plans, test runs, or test steps
-- `createTestCaseVersion(userEmail, apiToken, jiraInstanceUrl, testCaseId, projectId)` - Create a new test case version
+- `createTestCaseVersion(userEmail, apiToken, jiraInstanceUrl, request)` - Create a new test case version
+- `createTestCaseComment(userEmail, apiToken, jiraInstanceUrl, request)` - Create a comment on a test case
+- `getTestCaseAttachments(userEmail, apiToken, jiraInstanceUrl, request)` - Get all attachments for a test case
+- `downloadAttachment(userEmail, apiToken, jiraInstanceUrl, request)` - Download an attachment file into memory
+- `createAttachment(userEmail, apiToken, jiraInstanceUrl, request)` - Upload an attachment to a test case
 
 ## Authentication
 
@@ -483,26 +487,131 @@ const selectField = await api.Private.createCustomField(
 Create a new version of an existing test case. **Note:** When a new version is created, the `testCaseId` changes for that test case.
 
 ```typescript
-// First, get the test case to find its numeric ID
-const testCase = await api.TestCase.getTestCase({ testCaseKey: 'PROJ-T1' });
-const testCaseId = testCase.id; // Numeric ID, not the key
-
-// Create a new version
+// Create a new version (test case ID is looked up automatically from key)
 const newVersion = await api.Private.createTestCaseVersion(
   'user@example.com',
   'jira-api-token',
   'https://your-instance.atlassian.net',
-  testCaseId, // Numeric test case ID
-  10017 // Project ID or key
+  {
+    testCaseKey: 'PROJ-T1',  // Uses key, looks up ID automatically
+    projectId: 10017          // Numeric project ID
+  }
 );
+// Returns: { id: 286693656, key: "ZEP-T18" }
 ```
 
 **Important Notes:**
-- The `testCaseId` must be the numeric ID, not the test case key (e.g., `PROJ-T1`)
-- Use `api.TestCase.getTestCase()` to get the numeric ID from a test case key
+- The method accepts `testCaseKey` and automatically looks up the numeric ID
+- The `projectId` must be numeric, not the project key
 - If a new version already exists, the API will return a 409 Conflict error
 - The test case ID changes after creating a new version
 
+### Create Test Case Comment
+
+Add a comment to an existing test case.
+
+```typescript
+const comment = await api.Private.createTestCaseComment(
+  'user@example.com',
+  'jira-api-token',
+  'https://your-instance.atlassian.net',
+  {
+    testCaseKey: 'PROJ-T1',                    // Uses key, looks up ID automatically
+    projectId: 10233,                          // Numeric project ID
+    body: 'This is a test comment',            // Comment text
+    createdBy: '5d6fdc98dc6e480dbc021aae'      // Atlassian account ID
+  }
+);
+```
+
+### Get Test Case Attachments
+
+Retrieve all attachment details for a test case, including signed S3 URLs for downloading.
+
+```typescript
+const attachments = await api.Private.getTestCaseAttachments(
+  'user@example.com',
+  'jira-api-token',
+  'https://your-instance.atlassian.net',
+  {
+    testCaseKey: 'PROJ-T1',
+    projectId: 10233
+  }
+);
+
+console.log(`Found ${attachments.attachments.length} attachments`);
+attachments.attachments.forEach(att => {
+  console.log(`- ${att.name} (${att.fileSize} bytes, ${att.mimeType})`);
+  console.log(`  ID: ${att.id}`);
+  console.log(`  URL: ${att.url}`);
+});
+```
+
+**Response Structure:**
+Each attachment includes:
+- `id` - Attachment UUID
+- `name` - File name
+- `mimeType` - MIME type (e.g., 'image/jpeg', 'application/pdf')
+- `fileSize` - File size in bytes
+- `url` - Signed S3 URL for downloading (expires after ~90 minutes)
+- `createdOn` - Creation timestamp
+- `userKey` - Atlassian account ID of the uploader
+- `s3Key` - S3 storage key
+
+### Download Attachment
+
+Download an attachment file into memory. This method automatically gets a fresh signed URL and downloads the file.
+
+```typescript
+const fileBlob = await api.Private.downloadAttachment(
+  'user@example.com',
+  'jira-api-token',
+  'https://your-instance.atlassian.net',
+  {
+    testCaseKey: 'PROJ-T1',
+    projectId: 10233,
+    attachmentId: 'c3f14125-638f-47f9-9211-12a9777c09e7'  // Attachment UUID
+  }
+);
+
+// Use the blob (e.g., save to Record Storage, upload elsewhere, etc.)
+console.log(`Downloaded file: ${fileBlob.size} bytes, type: ${fileBlob.type}`);
+
+// Example: Convert to ArrayBuffer if needed
+const arrayBuffer = await fileBlob.arrayBuffer();
+```
+
+**Important Notes:**
+- The method automatically gets a fresh signed URL to ensure it hasn't expired
+- Returns a `Blob` object that can be used directly or converted to `ArrayBuffer`
+- The signed URLs from `getTestCaseAttachments` expire after ~90 minutes, but `downloadAttachment` always gets a fresh URL
+
+### Upload Attachment
+
+Upload a file attachment to a test case.
+
+```typescript
+const file = new Blob(['file content'], { type: 'text/plain' });
+
+const attachment = await api.Private.createAttachment(
+  'user@example.com',
+  'jira-api-token',
+  'https://your-instance.atlassian.net',
+  {
+    testCaseKey: 'PROJ-T1',                    // Uses key, looks up ID automatically
+    projectId: 10233,                          // Numeric project ID
+    file: file,                                 // Blob or ArrayBuffer
+    fileName: 'test-file.txt',
+    userAccountId: '5d6fdc98dc6e480dbc021aae'  // Atlassian account ID
+  }
+);
+```
+
+**Important Notes:**
+- The method handles the complete upload flow: getting S3 credentials, uploading to S3, and saving metadata
+- Supports both `Blob` and `ArrayBuffer` file types
+- MIME type is automatically detected from file name extension
+
 ### Error Handling for Private API
 
 Private API methods use the same error types as the public API:
@@ -834,13 +943,37 @@ For issues, questions, or contributions, please refer to the project repository
 
 ## Changelog
 
+### 1.2.1
+
+- **Fixed**: UUID generation for attachment uploads - replaced `crypto.randomUUID()` with custom implementation compatible with ScriptRunner Connect runtime
+- **Improved**: UUID generation now uses `crypto.getRandomValues()` which is available in ScriptRunner Connect's web standards runtime
+
+### 1.2.0
+
+- **Added**: Private API group with support for unofficial Zephyr endpoints
+  - `getContextJwt()` - Retrieve Jira Context JWT token for private API authentication
+  - `createCustomField()` - Create custom fields for test cases, test plans, test runs, and test steps
+  - `createTestCaseVersion()` - Create new test case versions (accepts testCaseKey and looks up ID automatically)
+  - `createTestCaseComment()` - Create comments on test cases
+  - `getTestCaseAttachments()` - Get all attachment details for a test case with signed S3 URLs
+  - `downloadAttachment()` - Download attachment files into memory with automatic fresh URL retrieval
+  - `createAttachment()` - Upload file attachments to test cases (complete S3 upload flow)
+- **Added**: Type definitions for private API requests and responses
+- **Changed**: `createTestCaseVersion()` now uses interface structure and automatically looks up test case ID from key
+- **Warning**: Private API methods are not officially supported and may change without notice
+
 ### 1.1.0
 
 - **Added**: Private API group with support for unofficial Zephyr endpoints
   - `getContextJwt()` - Retrieve Jira Context JWT token for private API authentication
   - `createCustomField()` - Create custom fields for test cases, test plans, test runs, and test steps
-  - `createTestCaseVersion()` - Create new test case versions
-- **Added**: Type definitions for private API requests (`CreatePrivateCustomFieldRequest`, `PrivateCustomFieldType`, `PrivateCustomFieldCategory`, etc.)
+  - `createTestCaseVersion()` - Create new test case versions (accepts testCaseKey and looks up ID automatically)
+  - `createTestCaseComment()` - Create comments on test cases
+  - `getTestCaseAttachments()` - Get all attachment details for a test case with signed S3 URLs
+  - `downloadAttachment()` - Download attachment files into memory with automatic fresh URL retrieval
+  - `createAttachment()` - Upload file attachments to test cases (complete S3 upload flow)
+- **Added**: Type definitions for private API requests and responses
+- **Changed**: `createTestCaseVersion()` now uses interface structure and automatically looks up test case ID from key
 - **Warning**: Private API methods are not officially supported and may change without notice
 
 ### 1.0.1

package/dist/README.md

@@ -344,7 +344,11 @@ The Managed API is organized into the following groups:
 
 - `getContextJwt(userEmail, apiToken, jiraInstanceUrl)` - Get Jira Context JWT token (required for private API calls)
 - `createCustomField(userEmail, apiToken, jiraInstanceUrl, category, request)` - Create custom fields for test cases, test plans, test runs, or test steps
-- `createTestCaseVersion(userEmail, apiToken, jiraInstanceUrl, testCaseId, projectId)` - Create a new test case version
+- `createTestCaseVersion(userEmail, apiToken, jiraInstanceUrl, request)` - Create a new test case version
+- `createTestCaseComment(userEmail, apiToken, jiraInstanceUrl, request)` - Create a comment on a test case
+- `getTestCaseAttachments(userEmail, apiToken, jiraInstanceUrl, request)` - Get all attachments for a test case
+- `downloadAttachment(userEmail, apiToken, jiraInstanceUrl, request)` - Download an attachment file into memory
+- `createAttachment(userEmail, apiToken, jiraInstanceUrl, request)` - Upload an attachment to a test case
 
 ## Authentication
 
@@ -483,26 +487,131 @@ const selectField = await api.Private.createCustomField(
 Create a new version of an existing test case. **Note:** When a new version is created, the `testCaseId` changes for that test case.
 
 ```typescript
-// First, get the test case to find its numeric ID
-const testCase = await api.TestCase.getTestCase({ testCaseKey: 'PROJ-T1' });
-const testCaseId = testCase.id; // Numeric ID, not the key
-
-// Create a new version
+// Create a new version (test case ID is looked up automatically from key)
 const newVersion = await api.Private.createTestCaseVersion(
   'user@example.com',
   'jira-api-token',
   'https://your-instance.atlassian.net',
-  testCaseId, // Numeric test case ID
-  10017 // Project ID or key
+  {
+    testCaseKey: 'PROJ-T1',  // Uses key, looks up ID automatically
+    projectId: 10017          // Numeric project ID
+  }
 );
+// Returns: { id: 286693656, key: "ZEP-T18" }
 ```
 
 **Important Notes:**
-- The `testCaseId` must be the numeric ID, not the test case key (e.g., `PROJ-T1`)
-- Use `api.TestCase.getTestCase()` to get the numeric ID from a test case key
+- The method accepts `testCaseKey` and automatically looks up the numeric ID
+- The `projectId` must be numeric, not the project key
 - If a new version already exists, the API will return a 409 Conflict error
 - The test case ID changes after creating a new version
 
+### Create Test Case Comment
+
+Add a comment to an existing test case.
+
+```typescript
+const comment = await api.Private.createTestCaseComment(
+  'user@example.com',
+  'jira-api-token',
+  'https://your-instance.atlassian.net',
+  {
+    testCaseKey: 'PROJ-T1',                    // Uses key, looks up ID automatically
+    projectId: 10233,                          // Numeric project ID
+    body: 'This is a test comment',            // Comment text
+    createdBy: '5d6fdc98dc6e480dbc021aae'      // Atlassian account ID
+  }
+);
+```
+
+### Get Test Case Attachments
+
+Retrieve all attachment details for a test case, including signed S3 URLs for downloading.
+
+```typescript
+const attachments = await api.Private.getTestCaseAttachments(
+  'user@example.com',
+  'jira-api-token',
+  'https://your-instance.atlassian.net',
+  {
+    testCaseKey: 'PROJ-T1',
+    projectId: 10233
+  }
+);
+
+console.log(`Found ${attachments.attachments.length} attachments`);
+attachments.attachments.forEach(att => {
+  console.log(`- ${att.name} (${att.fileSize} bytes, ${att.mimeType})`);
+  console.log(`  ID: ${att.id}`);
+  console.log(`  URL: ${att.url}`);
+});
+```
+
+**Response Structure:**
+Each attachment includes:
+- `id` - Attachment UUID
+- `name` - File name
+- `mimeType` - MIME type (e.g., 'image/jpeg', 'application/pdf')
+- `fileSize` - File size in bytes
+- `url` - Signed S3 URL for downloading (expires after ~90 minutes)
+- `createdOn` - Creation timestamp
+- `userKey` - Atlassian account ID of the uploader
+- `s3Key` - S3 storage key
+
+### Download Attachment
+
+Download an attachment file into memory. This method automatically gets a fresh signed URL and downloads the file.
+
+```typescript
+const fileBlob = await api.Private.downloadAttachment(
+  'user@example.com',
+  'jira-api-token',
+  'https://your-instance.atlassian.net',
+  {
+    testCaseKey: 'PROJ-T1',
+    projectId: 10233,
+    attachmentId: 'c3f14125-638f-47f9-9211-12a9777c09e7'  // Attachment UUID
+  }
+);
+
+// Use the blob (e.g., save to Record Storage, upload elsewhere, etc.)
+console.log(`Downloaded file: ${fileBlob.size} bytes, type: ${fileBlob.type}`);
+
+// Example: Convert to ArrayBuffer if needed
+const arrayBuffer = await fileBlob.arrayBuffer();
+```
+
+**Important Notes:**
+- The method automatically gets a fresh signed URL to ensure it hasn't expired
+- Returns a `Blob` object that can be used directly or converted to `ArrayBuffer`
+- The signed URLs from `getTestCaseAttachments` expire after ~90 minutes, but `downloadAttachment` always gets a fresh URL
+
+### Upload Attachment
+
+Upload a file attachment to a test case.
+
+```typescript
+const file = new Blob(['file content'], { type: 'text/plain' });
+
+const attachment = await api.Private.createAttachment(
+  'user@example.com',
+  'jira-api-token',
+  'https://your-instance.atlassian.net',
+  {
+    testCaseKey: 'PROJ-T1',                    // Uses key, looks up ID automatically
+    projectId: 10233,                          // Numeric project ID
+    file: file,                                 // Blob or ArrayBuffer
+    fileName: 'test-file.txt',
+    userAccountId: '5d6fdc98dc6e480dbc021aae'  // Atlassian account ID
+  }
+);
+```
+
+**Important Notes:**
+- The method handles the complete upload flow: getting S3 credentials, uploading to S3, and saving metadata
+- Supports both `Blob` and `ArrayBuffer` file types
+- MIME type is automatically detected from file name extension
+
 ### Error Handling for Private API
 
 Private API methods use the same error types as the public API:
@@ -834,13 +943,37 @@ For issues, questions, or contributions, please refer to the project repository
 
 ## Changelog
 
+### 1.2.1
+
+- **Fixed**: UUID generation for attachment uploads - replaced `crypto.randomUUID()` with custom implementation compatible with ScriptRunner Connect runtime
+- **Improved**: UUID generation now uses `crypto.getRandomValues()` which is available in ScriptRunner Connect's web standards runtime
+
+### 1.2.0
+
+- **Added**: Private API group with support for unofficial Zephyr endpoints
+  - `getContextJwt()` - Retrieve Jira Context JWT token for private API authentication
+  - `createCustomField()` - Create custom fields for test cases, test plans, test runs, and test steps
+  - `createTestCaseVersion()` - Create new test case versions (accepts testCaseKey and looks up ID automatically)
+  - `createTestCaseComment()` - Create comments on test cases
+  - `getTestCaseAttachments()` - Get all attachment details for a test case with signed S3 URLs
+  - `downloadAttachment()` - Download attachment files into memory with automatic fresh URL retrieval
+  - `createAttachment()` - Upload file attachments to test cases (complete S3 upload flow)
+- **Added**: Type definitions for private API requests and responses
+- **Changed**: `createTestCaseVersion()` now uses interface structure and automatically looks up test case ID from key
+- **Warning**: Private API methods are not officially supported and may change without notice
+
 ### 1.1.0
 
 - **Added**: Private API group with support for unofficial Zephyr endpoints
   - `getContextJwt()` - Retrieve Jira Context JWT token for private API authentication
   - `createCustomField()` - Create custom fields for test cases, test plans, test runs, and test steps
-  - `createTestCaseVersion()` - Create new test case versions
-- **Added**: Type definitions for private API requests (`CreatePrivateCustomFieldRequest`, `PrivateCustomFieldType`, `PrivateCustomFieldCategory`, etc.)
+  - `createTestCaseVersion()` - Create new test case versions (accepts testCaseKey and looks up ID automatically)
+  - `createTestCaseComment()` - Create comments on test cases
+  - `getTestCaseAttachments()` - Get all attachment details for a test case with signed S3 URLs
+  - `downloadAttachment()` - Download attachment files into memory with automatic fresh URL retrieval
+  - `createAttachment()` - Upload file attachments to test cases (complete S3 upload flow)
+- **Added**: Type definitions for private API requests and responses
+- **Changed**: `createTestCaseVersion()` now uses interface structure and automatically looks up test case ID from key
 - **Warning**: Private API methods are not officially supported and may change without notice
 
 ### 1.0.1

package/dist/groups/Private.d.ts

@@ -14,7 +14,8 @@
  *
  * Use these functions at your own risk. They may break with future Zephyr updates.
  */
-import type { CreatePrivateCustomFieldRequest, PrivateCustomFieldCategory } from '../types';
+import type { CreatePrivateCustomFieldRequest, PrivateCustomFieldCategory, CreateTestCaseVersionRequest, CreateTestCaseVersionResponse, CreateAttachmentRequest, CreateTestCaseCommentRequest, CreateTestCaseCommentResponse, GetTestCaseAttachmentsRequest, GetTestCaseAttachmentsResponse, DownloadAttachmentRequest } from '../types';
+import type { ZephyrApiConnection } from '../index';
 /**
  * Private API group for accessing Zephyr's private/unofficial endpoints
  *
@@ -26,6 +27,12 @@ export declare class PrivateGroup {
      * Base URL for Zephyr private API endpoints
      */
     private readonly privateApiBaseUrl;
+    /**
+     * Optional API connection for accessing public API (e.g., to look up test case IDs from keys)
+     */
+    private readonly apiConnection?;
+    private readonly testCaseGroup?;
+    constructor(apiConnection?: ZephyrApiConnection);
     /**
      * Get Jira Context JWT token
      *
@@ -75,15 +82,181 @@ export declare class PrivateGroup {
      * @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 testCaseId - Numeric test case ID (not the test case key)
-     * @param projectId - Jira project ID or key
-     * @returns The created version response
+     * @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(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
      */
-    createTestCaseVersion(userEmail: string, apiToken: string, jiraInstanceUrl: string, testCaseId: number, projectId: number | string): Promise<unknown>;
+    createAttachment(userEmail: string, apiToken: string, jiraInstanceUrl: string, request: CreateAttachmentRequest): Promise<unknown>;
 }
 //# 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,EAE1B,MAAM,UAAU,CAAC;AAUlB;;;;;GAKG;AACH,qBAAa,YAAY;IACxB;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAA2D;IAE7F;;;;;;;;;;;;;;;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;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,qBAAqB,CAC1B,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,MAAM,EAChB,eAAe,EAAE,MAAM,EACvB,UAAU,EAAE,MAAM,EAClB,SAAS,EAAE,MAAM,GAAG,MAAM,GACxB,OAAO,CAAC,OAAO,CAAC;CA4DnB"}
+{"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"}