@rbaileysr/zephyr-managed-api 1.2.1 → 1.2.9

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

@@ -0,0 +1,697 @@
+/*!
+ * Copyright Adaptavist 2025 (c) All rights reserved
+ */
+/**
+ * Private API Attachments sub-group
+ * Handles attachment operations for test cases, test cycles, and test plans
+ *
+ * ⚠️ WARNING: These methods use private APIs that are not officially supported.
+ */
+import type { PrivateApiCredentials, GetTestCaseAttachmentsRequest, GetTestCaseAttachmentsResponse, DownloadAttachmentRequest, CreateTestCaseAttachmentRequest, GetTestCycleAttachmentsRequest, GetTestCycleAttachmentsResponse, DownloadTestCycleAttachmentRequest, CreateTestCycleAttachmentRequest, GetTestPlanAttachmentsRequest, GetTestPlanAttachmentsResponse, DownloadTestPlanAttachmentRequest, CreateTestPlanAttachmentRequest, GetTestStepAttachmentsRequest, GetTestStepAttachmentsResponse, DownloadTestStepAttachmentRequest, CreateTestStepAttachmentRequest, GetTestExecutionAttachmentsRequest, GetTestExecutionAttachmentsResponse, DownloadTestExecutionAttachmentRequest, CreateTestExecutionAttachmentRequest, GetTestExecutionStepAttachmentsRequest, GetTestExecutionStepAttachmentsResponse, DownloadTestExecutionStepAttachmentRequest, CreateTestExecutionStepAttachmentRequest } from '../../types';
+import { PrivateBase } from './PrivateBase';
+import type { ZephyrApiConnection } from '../../index';
+export declare class PrivateAttachments extends PrivateBase {
+    constructor(apiConnection?: ZephyrApiConnection);
+    /**
+     * 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 credentials - Private API credentials
+     * @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(credentials: PrivateApiCredentials, 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 credentials - Private API credentials
+     * @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(credentials: PrivateApiCredentials, request: DownloadAttachmentRequest): Promise<Blob>;
+    /**
+     * 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 credentials - Private API credentials
+     * @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
+     */
+    createTestCaseAttachment(credentials: PrivateApiCredentials, request: CreateTestCaseAttachmentRequest): Promise<unknown>;
+    /**
+     * 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;
+    /**
+     * 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;
+    /**
+     * Get attachments for a test cycle using private API
+     *
+     * Retrieves all attachment details for a test cycle, 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 credentials - Private API credentials
+     * @param request - Get attachments request
+     * @param request.testCycleKey - Test cycle key (e.g., 'PROJ-R1'). 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 cycle 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 cycle is not found
+     * @throws {ServerError} If the server returns an error
+     * @throws {UnexpectedError} If test cycle ID cannot be looked up from key and Zephyr Connector is not available
+     */
+    getTestCycleAttachments(credentials: PrivateApiCredentials, request: GetTestCycleAttachmentsRequest): Promise<GetTestCycleAttachmentsResponse>;
+    /**
+     * Download an attachment from a test cycle 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 credentials - Private API credentials
+     * @param request - Download attachment request
+     * @param request.testCycleKey - Test cycle key (e.g., 'PROJ-R1'). 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., '13fbe8bc-a87b-4db1-bf01-8b4451db79fb')
+     * @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 cycle or attachment is not found
+     * @throws {ServerError} If the server returns an error
+     * @throws {UnexpectedError} If test cycle ID cannot be looked up from key and Zephyr Connector is not available, or if download fails
+     */
+    downloadTestCycleAttachment(credentials: PrivateApiCredentials, request: DownloadTestCycleAttachmentRequest): Promise<Blob>;
+    /**
+     * Create an attachment for a test cycle using private API
+     *
+     * Uploads a file attachment to a test cycle. 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 credentials - Private API credentials
+     * @param request - Attachment creation request
+     * @param request.testCycleKey - Test cycle key (e.g., 'PROJ-R1'). 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 cycle is not found
+     * @throws {ServerError} If the server returns an error
+     * @throws {UnexpectedError} If test cycle ID cannot be looked up from key and Zephyr Connector is not available
+     */
+    createTestCycleAttachment(credentials: PrivateApiCredentials, request: CreateTestCycleAttachmentRequest): Promise<unknown>;
+    /**
+     * Get attachments for a test plan using private API
+     *
+     * Retrieves all attachment details for a test plan, 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 credentials - Private API credentials
+     * @param request - Get attachments request
+     * @param request.testPlanKey - Test plan key (e.g., 'PROJ-P1'). 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 plan 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 plan is not found
+     * @throws {ServerError} If the server returns an error
+     * @throws {UnexpectedError} If test plan ID cannot be looked up from key and Zephyr Connector is not available
+     */
+    getTestPlanAttachments(credentials: PrivateApiCredentials, request: GetTestPlanAttachmentsRequest): Promise<GetTestPlanAttachmentsResponse>;
+    /**
+     * Download an attachment from a test plan 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 credentials - Private API credentials
+     * @param request - Download attachment request
+     * @param request.testPlanKey - Test plan key (e.g., 'PROJ-P1'). 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)
+     * @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 plan or attachment is not found
+     * @throws {ServerError} If the server returns an error
+     * @throws {UnexpectedError} If test plan ID cannot be looked up from key and Zephyr Connector is not available, or if download fails
+     */
+    downloadTestPlanAttachment(credentials: PrivateApiCredentials, request: DownloadTestPlanAttachmentRequest): Promise<Blob>;
+    /**
+     * Create an attachment for a test plan using private API
+     *
+     * Uploads a file attachment to a test plan. 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 credentials - Private API credentials
+     * @param request - Attachment creation request
+     * @param request.testPlanKey - Test plan key (e.g., 'PROJ-P1'). 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 plan is not found
+     * @throws {ServerError} If the server returns an error
+     * @throws {UnexpectedError} If test plan ID cannot be looked up from key and Zephyr Connector is not available
+     */
+    createTestPlanAttachment(credentials: PrivateApiCredentials, request: CreateTestPlanAttachmentRequest): Promise<unknown>;
+    /**
+     * Upload file to S3 for test cycle
+     *
+     * Uploads a file to S3 using the credentials from upload details.
+     * Uses "testrun" in the S3 key path.
+     *
+     * @param upload - Upload details from getUploadDetails
+     * @param projectId - Jira project ID
+     * @param testCycleId - Numeric test cycle 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 uploadToS3ForTestCycle;
+    /**
+     * Save test cycle attachment metadata
+     *
+     * Saves metadata for an uploaded test cycle attachment.
+     *
+     * @param contextJwt - Jira Context JWT token
+     * @param projectId - Jira project ID
+     * @param testCycleId - Numeric test cycle 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 saveTestCycleAttachmentMetadata;
+    /**
+     * Upload file to S3 for test plan
+     *
+     * Uploads a file to S3 using the credentials from upload details.
+     * Uses "testplan" in the S3 key path.
+     *
+     * @param upload - Upload details from getUploadDetails
+     * @param projectId - Jira project ID
+     * @param testPlanId - Numeric test plan 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 uploadToS3ForTestPlan;
+    /**
+     * Save test plan attachment metadata
+     *
+     * Saves metadata for an uploaded test plan attachment.
+     *
+     * @param contextJwt - Jira Context JWT token
+     * @param projectId - Jira project ID
+     * @param testPlanId - Numeric test plan 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 saveTestPlanAttachmentMetadata;
+    /**
+     * Get attachments for a test step using private API
+     *
+     * Retrieves all attachment details for a specific test step within a test case.
+     * Attachments are retrieved by getting the test case with fields including testScript.steps.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 credentials - Private API credentials
+     * @param request - Get attachments request
+     * @param request.testCaseKey - Test case key (e.g., 'PROJ-T1')
+     * @param request.stepIndex - Zero-based index of the test step in the test case
+     * @param request.projectId - Jira project ID (numeric, not the project key)
+     * @returns Test step 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 or step is not found
+     * @throws {ServerError} If the server returns an error
+     * @throws {UnexpectedError} If the test case cannot be retrieved
+     */
+    getTestStepAttachments(credentials: PrivateApiCredentials, request: GetTestStepAttachmentsRequest): Promise<GetTestStepAttachmentsResponse>;
+    /**
+     * Download an attachment from a test step 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 credentials - Private API credentials
+     * @param request - Download attachment request
+     * @param request.testCaseKey - Test case key (e.g., 'PROJ-T1')
+     * @param request.stepIndex - Zero-based index of the test step in the test case
+     * @param request.projectId - Jira project ID (numeric, not the project key)
+     * @param request.attachmentId - Attachment ID (UUID string)
+     * @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, step, or attachment is not found
+     * @throws {ServerError} If the server returns an error
+     * @throws {UnexpectedError} If download fails
+     */
+    downloadTestStepAttachment(credentials: PrivateApiCredentials, request: DownloadTestStepAttachmentRequest): Promise<Blob>;
+    /**
+     * Create an attachment for a test step using private API
+     *
+     * Uploads a file attachment to a test step. 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 credentials - Private API credentials
+     * @param request - Attachment creation request
+     * @param request.testCaseKey - Test case key (e.g., 'PROJ-T1')
+     * @param request.stepIndex - Zero-based index of the test step in the test case
+     * @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 or step is not found
+     * @throws {ServerError} If the server returns an error
+     */
+    createTestStepAttachment(credentials: PrivateApiCredentials, request: CreateTestStepAttachmentRequest): Promise<unknown>;
+    /**
+     * Get attachments for a test execution using private API
+     *
+     * Retrieves all attachment details for a test execution, 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 credentials - Private API credentials
+     * @param request - Get attachments request
+     * @param request.testExecutionKey - Test execution key (e.g., 'PROJ-E1'). 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 execution 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 execution is not found
+     * @throws {ServerError} If the server returns an error
+     * @throws {UnexpectedError} If test execution ID cannot be looked up from key and Zephyr Connector is not available
+     */
+    getTestExecutionAttachments(credentials: PrivateApiCredentials, request: GetTestExecutionAttachmentsRequest): Promise<GetTestExecutionAttachmentsResponse>;
+    /**
+     * Download an attachment from a test execution 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 credentials - Private API credentials
+     * @param request - Download attachment request
+     * @param request.testExecutionKey - Test execution key (e.g., 'PROJ-E1'). 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)
+     * @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 execution or attachment is not found
+     * @throws {ServerError} If the server returns an error
+     * @throws {UnexpectedError} If test execution ID cannot be looked up from key and Zephyr Connector is not available, or if download fails
+     */
+    downloadTestExecutionAttachment(credentials: PrivateApiCredentials, request: DownloadTestExecutionAttachmentRequest): Promise<Blob>;
+    /**
+     * Create an attachment for a test execution using private API
+     *
+     * Uploads a file attachment to a test execution. 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 credentials - Private API credentials
+     * @param request - Attachment creation request
+     * @param request.testExecutionKey - Test execution key (e.g., 'PROJ-E1'). 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 execution is not found
+     * @throws {ServerError} If the server returns an error
+     * @throws {UnexpectedError} If test execution ID cannot be looked up from key and Zephyr Connector is not available
+     */
+    createTestExecutionAttachment(credentials: PrivateApiCredentials, request: CreateTestExecutionAttachmentRequest): Promise<unknown>;
+    /**
+     * Get attachments for a test execution step using private API
+     *
+     * Retrieves all attachment details for a specific test execution step (testScriptResult).
+     * Attachments are retrieved by getting the test execution with fields including testScriptResults.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 credentials - Private API credentials
+     * @param request - Get attachments request
+     * @param request.testExecutionKey - Test execution key (e.g., 'PROJ-E1')
+     * @param request.stepIndex - Zero-based index of the test execution step
+     * @param request.projectId - Jira project ID (numeric, not the project key)
+     * @returns Test execution step 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 execution or step is not found
+     * @throws {ServerError} If the server returns an error
+     * @throws {UnexpectedError} If the test execution cannot be retrieved
+     */
+    getTestExecutionStepAttachments(credentials: PrivateApiCredentials, request: GetTestExecutionStepAttachmentsRequest): Promise<GetTestExecutionStepAttachmentsResponse>;
+    /**
+     * Download an attachment from a test execution step 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 credentials - Private API credentials
+     * @param request - Download attachment request
+     * @param request.testExecutionKey - Test execution key (e.g., 'PROJ-E1')
+     * @param request.stepIndex - Zero-based index of the test execution step
+     * @param request.projectId - Jira project ID (numeric, not the project key)
+     * @param request.attachmentId - Attachment ID (UUID string)
+     * @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 execution, step, or attachment is not found
+     * @throws {ServerError} If the server returns an error
+     * @throws {UnexpectedError} If download fails
+     */
+    downloadTestExecutionStepAttachment(credentials: PrivateApiCredentials, request: DownloadTestExecutionStepAttachmentRequest): Promise<Blob>;
+    /**
+     * Create an attachment for a test execution step using private API
+     *
+     * Uploads a file attachment to a test execution step. 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 credentials - Private API credentials
+     * @param request - Attachment creation request
+     * @param request.testExecutionKey - Test execution key (e.g., 'PROJ-E1')
+     * @param request.stepIndex - Zero-based index of the test execution step
+     * @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 execution or step is not found
+     * @throws {ServerError} If the server returns an error
+     */
+    createTestExecutionStepAttachment(credentials: PrivateApiCredentials, request: CreateTestExecutionStepAttachmentRequest): Promise<unknown>;
+    /**
+     * Upload file to S3 for test step
+     *
+     * Uploads a file to S3 using the credentials from upload details.
+     * Uses "step" in the S3 key path.
+     *
+     * @param upload - Upload details from getUploadDetails
+     * @param projectId - Jira project ID
+     * @param stepId - Numeric test step 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 uploadToS3ForTestStep;
+    /**
+     * Save test step attachment metadata
+     *
+     * Saves metadata for an uploaded test step attachment.
+     *
+     * @param contextJwt - Jira Context JWT token
+     * @param projectId - Jira project ID
+     * @param stepId - Numeric test step 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 saveTestStepAttachmentMetadata;
+    /**
+     * Upload file to S3 for test execution
+     *
+     * Uploads a file to S3 using the credentials from upload details.
+     * Uses "testresult" in the S3 key path.
+     *
+     * @param upload - Upload details from getUploadDetails
+     * @param projectId - Jira project ID
+     * @param testExecutionId - Numeric test execution 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 uploadToS3ForTestExecution;
+    /**
+     * Save test execution attachment metadata
+     *
+     * Saves metadata for an uploaded test execution attachment.
+     *
+     * @param contextJwt - Jira Context JWT token
+     * @param projectId - Jira project ID
+     * @param testExecutionId - Numeric test execution 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 saveTestExecutionAttachmentMetadata;
+    /**
+     * Upload file to S3 for test execution step
+     *
+     * Uploads a file to S3 using the credentials from upload details.
+     * Uses "testscriptresult" in the S3 key path.
+     *
+     * @param upload - Upload details from getUploadDetails
+     * @param projectId - Jira project ID
+     * @param testScriptResultId - Numeric test script result 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 uploadToS3ForTestExecutionStep;
+    /**
+     * Save test execution step attachment metadata
+     *
+     * Saves metadata for an uploaded test execution step attachment.
+     *
+     * @param contextJwt - Jira Context JWT token
+     * @param projectId - Jira project ID
+     * @param testScriptResultId - Numeric test script result 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 saveTestExecutionStepAttachmentMetadata;
+}
+//# sourceMappingURL=PrivateAttachments.d.ts.map