@rbaileysr/zephyr-managed-api 1.2.1 → 1.2.9

package/README.md

@@ -1,606 +1,238 @@
-# Zephyr Managed API
+# ScriptRunner Connect Managed API for Zephyr Scale
+Managed API for Zephyr Scale Cloud is an API Client for Zephyr Scale Cloud by [Adaptavist](https://www.adaptavist.com/). You can read more about Managed APIs [here](https://docs.adaptavist.com/src/managed-apis).
 
-A comprehensive Managed API wrapper for Zephyr Cloud REST API v2, providing type-safe, hierarchical access to all Zephyr API endpoints.
-
-> **⚠️ Important: ScriptRunner Connect Runtime Only**
-> 
-> This package is specifically designed for **ScriptRunner Connect's custom runtime** and will **NOT work in standard Node.js projects**. It uses web standards-based APIs (fetch, etc.) and ES modules, making it compatible with ScriptRunner Connect's runtime environment.
-
-## Overview
-
-This Managed API wrapper provides a clean, type-safe interface to interact with the Zephyr Cloud API. It follows the same hierarchical pattern as other ScriptRunner Connect Managed APIs, making it easy to use and consistent with the platform's conventions.
-
-## Features
-
-- **Type-Safe**: Full TypeScript support with IntelliSense
-- **Hierarchical Structure**: Organized by resource type (TestCase, TestCycle, TestPlan, etc.)
-- **Comprehensive Coverage**: Supports all Zephyr Cloud REST API v2 endpoints
-- **Error Handling**: Built-in error parsing and handling using Commons Core error types
-- **Pagination Support**: Both offset-based and cursor-based pagination
-- **Flexible Authentication**: Supports OAuth tokens and ScriptRunner Connect API Connections (base URL configured in Generic Connector)
-- **Custom Fields**: Full support for dynamic custom fields
-- **Web App Compatible**: Works seamlessly in ScriptRunner Connect web app
-- **Single Import**: Convenient default export for all utilities and types
+This is [ScriptRunner Connect](https://scriptrunnerconnect.com) runtime specific version of the Managed API. This package is specifically designed for **ScriptRunner Connect's custom runtime** and will **NOT work in standard Node.js projects**. It uses web standards-based APIs (fetch, etc.) and ES modules, making it compatible with ScriptRunner Connect's runtime environment.
 
 ## Installation
 
-### NPM Package
-
 ```bash
 npm install @rbaileysr/zephyr-managed-api
 ```
 
 **Important:** After installing via NPM, you must also add the package through ScriptRunner Connect's Package Manager in the web UI. The package will then be available in your workspace.
 
-### ScriptRunner Connect Workspace Setup
-
-1. **Add Package via Web UI:**
-   - Go to Package Manager in ScriptRunner Connect web UI
-   - Click "Add Package"
-   - Enter: `@rbaileysr/zephyr-managed-api`
-   - Click Add/Save
-
-2. **Sync Workspace Files:**
-   - Download latest workspace files from SFTP server
-   - Or use `SFTP: Sync Remote → Local` if using VS Code + SFTP
-
-3. **Install Dependencies:**
-   ```bash
-   npm install
-   ```
-
-4. **Use in Scripts:**
-   ```typescript
-   // Single import (recommended) - everything in one import
-   import Zephyr from '@rbaileysr/zephyr-managed-api';
-   import ZephyrApiConnection from '../api/zephyr';
-
-   // Using API Connection (recommended for ScriptRunner Connect)
-   // Base URL is configured in the Generic Connector
-   const api = Zephyr.createZephyrApi(ZephyrApiConnection);
-   
-   // Access utilities and error types from the same import
-   const pages = await Zephyr.getAllPages(...);
-   const errorStrategy = new Zephyr.ErrorStrategyBuilder()...;
-   ```
-   
-   **Alternative - Named Imports:**
-   ```typescript
-   // Named imports (if you prefer)
-   import { createZephyrApi, getAllPages, ErrorStrategyBuilder } from '@rbaileysr/zephyr-managed-api';
-   ```
-
-## Usage
-
-### Basic Examples
-
-#### Using API Connection (ScriptRunner Connect) - Single Import
-
-```typescript
-// Single import for everything
-import Zephyr from '@rbaileysr/zephyr-managed-api';
-import ZephyrApiConnection from '../api/zephyr';
+## Constructing Managed API
 
-// Create API instance (base URL configured in Generic Connector)
-const api = Zephyr.createZephyrApi(ZephyrApiConnection);
-
-// Get a test case
-const testCase = await api.TestCase.getTestCase({ testCaseKey: 'PROJ-T1' });
-console.log(`Test case: ${testCase.name}`);
-```
-
-#### Using API Connection - Named Imports
+In ScriptRunner Connect a Managed API is constructed for you, but if you need to construct it manually, here's how you can do it:
 
+**Using API Connection (recommended for ScriptRunner Connect):**
 ```typescript
-// Named imports (alternative)
 import { createZephyrApi } from '@rbaileysr/zephyr-managed-api';
 import ZephyrApiConnection from '../api/zephyr';
 
-const api = createZephyrApi(ZephyrApiConnection);
-const testCase = await api.TestCase.getTestCase({ testCaseKey: 'PROJ-T1' });
-```
-
-#### Using OAuth Token
-
-```typescript
-import Zephyr from '@rbaileysr/zephyr-managed-api';
-
-// OAuth token with full base URL (US region)
-const api = Zephyr.createZephyrApi(
-  'your-oauth-token-here',
-  'https://api.zephyrscale.smartbear.com/v2'
-);
-
-// OAuth token with full base URL (EU region)
-const apiEU = Zephyr.createZephyrApi(
-  'your-oauth-token-here',
-  'https://eu.api.zephyrscale.smartbear.com/v2'
-);
-
-// List test cases
-const testCases = await api.TestCase.listTestCases({
-  projectKey: 'PROJ',
-  maxResults: 10,
-  startAt: 0
-});
-console.log(`Found ${testCases.values.length} test cases`);
-```
-
-#### Create a Test Case
-
-```typescript
-const testCase = await api.TestCase.createTestCase({
-  body: {
-    projectKey: 'PROJ',
-    name: 'Login Test Case',
-    objective: 'Verify user can login successfully',
-    precondition: 'User account exists',
-    priorityName: 'High',
-    statusName: 'Draft',
-    labels: ['automated', 'regression'],
-    customFields: {
-      'Build Number': '2024.1',
-      'Release Date': '2024-01-15'
-    }
-  }
-});
-console.log(`Created test case: ${testCase.key}`);
-```
-
-#### Create a Test Cycle
-
-```typescript
-const testCycle = await api.TestCycle.createTestCycle({
-  body: {
-    projectKey: 'PROJ',
-    name: 'Sprint 1 Regression',
-    description: 'Regression tests for Sprint 1',
-    plannedStartDate: '2024-01-15T09:00:00Z',
-    plannedEndDate: '2024-01-22T17:00:00Z',
-    statusName: 'In Progress',
-    customFields: {
-      'Environment': 'Production'
-    }
-  }
-});
-console.log(`Created test cycle: ${testCycle.key}`);
-```
-
-#### Create a Test Execution
-
-```typescript
-const testExecution = await api.TestExecution.createTestExecution({
-  body: {
-    projectKey: 'PROJ',
-    testCaseKey: 'PROJ-T1',
-    testCycleKey: 'PROJ-R1',
-    statusName: 'Pass',
-    environmentName: 'Chrome Latest',
-    executionTime: 120000, // 2 minutes in milliseconds
-    comment: 'Test passed successfully'
-  }
-});
-console.log(`Created test execution: ${testExecution.key || testExecution.id}`);
-```
-
-#### Update a Test Case
-
-```typescript
-// First, get the test case
-const testCase = await api.TestCase.getTestCase({ testCaseKey: 'PROJ-T1' });
-
-// Update it
-testCase.name = 'Updated Test Case Name';
-testCase.objective = 'Updated objective';
-testCase.labels = [...(testCase.labels || []), 'updated'];
-
-await api.TestCase.updateTestCase({
-  testCaseKey: 'PROJ-T1',
-  body: testCase
-});
-```
-
-#### List with Filters and Pagination
-
-```typescript
-// Offset-based pagination
-const testCases = await api.TestCase.listTestCases({
-  projectKey: 'PROJ',
-  folderId: 12345,
-  maxResults: 50,
-  startAt: 0
-});
-
-// Cursor-based pagination (for large datasets)
-const testCasesCursor = await api.TestCase.listTestCasesCursorPaginated({
-  projectKey: 'PROJ',
-  limit: 100,
-  startAtId: 0
-});
-```
-
-#### Create Links
-
-```typescript
-// Link test case to Jira issue
-const issueLink = await api.TestCase.createTestCaseIssueLink({
-  testCaseKey: 'PROJ-T1',
-  body: {
-    issueId: 12345
-  }
-});
-
-// Link test case to web URL
-const webLink = await api.TestCase.createTestCaseWebLink({
-  testCaseKey: 'PROJ-T1',
-  body: {
-    url: 'https://example.com/test-resource',
-    description: 'External test resource'
-  }
-});
-```
-
-## API Groups
-
-The Managed API is organized into the following groups:
-
-### Project
-- `listProjects(options?)` - List all projects
-- `getProject(options)` - Get a specific project
-
-### Status
-- `listStatuses(options)` - List all statuses
-- `getStatus(options)` - Get a specific status
-- `createStatus(request)` - Create a new status
-- `updateStatus(request)` - Update a status
-
-### Priority
-- `listPriorities(options)` - List all priorities
-- `getPriority(options)` - Get a specific priority
-- `createPriority(request)` - Create a new priority
-- `updatePriority(request)` - Update a priority
-
-### Environment
-- `listEnvironments(options)` - List all environments
-- `getEnvironment(options)` - Get a specific environment
-- `createEnvironment(request)` - Create a new environment
-- `updateEnvironment(request)` - Update an environment
-
-### Folder
-- `listFolders(options)` - List all folders
-- `getFolder(options)` - Get a specific folder
-- `createFolder(request)` - Create a new folder
-
-### TestCase
-- `listTestCases(options?)` - List all test cases
-- `listTestCasesCursorPaginated(options?)` - List test cases with cursor pagination
-- `getTestCase(options)` - Get a specific test case
-- `createTestCase(request)` - Create a new test case
-- `updateTestCase(request)` - Update a test case
-- `getTestCaseLinks(testCaseKey)` - Get links for a test case
-- `createTestCaseIssueLink(request)` - Create issue link
-- `createTestCaseWebLink(request)` - Create web link
-- `listTestCaseVersions(options)` - List test case versions
-- `getTestCaseVersion(options)` - Get a specific version
-- `getTestCaseTestScript(testCaseKey)` - Get test script
-- `createTestCaseTestScript(request)` - Create or update test script
-- `getTestCaseTestSteps(testCaseKey, options?)` - Get test steps
-- `createTestCaseTestSteps(request)` - Create test steps
-
-### TestCycle
-- `listTestCycles(options?)` - List all test cycles
-- `getTestCycle(options)` - Get a specific test cycle
-- `createTestCycle(request)` - Create a new test cycle
-- `updateTestCycle(request)` - Update a test cycle
-- `getTestCycleLinks(testCycleIdOrKey)` - Get links for a test cycle
-- `createTestCycleIssueLink(request)` - Create issue link
-- `createTestCycleWebLink(request)` - Create web link
-
-### TestPlan
-- `listTestPlans(options?)` - List all test plans
-- `getTestPlan(options)` - Get a specific test plan
-- `createTestPlan(request)` - Create a new test plan
-- `createTestPlanIssueLink(request)` - Create issue link
-- `createTestPlanWebLink(request)` - Create web link
-- `createTestPlanTestCycleLink(request)` - Link test cycle to test plan
-
-### TestExecution
-- `listTestExecutions(options?)` - List all test executions
-- `listTestExecutionsNextgen(options?)` - List test executions with cursor pagination
-- `getTestExecution(options)` - Get a specific test execution
-- `createTestExecution(request)` - Create a new test execution
-- `updateTestExecution(request)` - Update a test execution
-- `getTestExecutionTestSteps(options)` - Get test steps for execution
-- `putTestExecutionTestSteps(request)` - Update test steps
-- `syncTestExecutionScript(request)` - Sync with test case script
-- `listTestExecutionLinks(testExecutionIdOrKey)` - Get links
-- `createTestExecutionIssueLink(request)` - Create issue link
-
-### Link
-- `deleteLink(options)` - Delete a link (idempotent)
-
-### IssueLink
-- `getIssueLinkTestCases(options)` - Get test cases linked to issue
-- `getIssueLinkTestCycles(options)` - Get test cycles linked to issue
-- `getIssueLinkTestPlans(options)` - Get test plans linked to issue
-- `getIssueLinkExecutions(options)` - Get test executions linked to issue
-
-### Automation
-- `createCustomExecutions(request)` - Upload custom format results
-- `createCucumberExecutions(request)` - Upload Cucumber results
-- `createJUnitExecutions(request)` - Upload JUnit XML results
-- `retrieveBDDTestCases(options)` - Retrieve BDD feature files
-
-### Private API ⚠️
-> **⚠️ WARNING: Private API Methods**
-> 
-> The following methods use Zephyr's private/unofficial API endpoints that 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 methods at your own risk. They may break with future Zephyr updates.
-
-- `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, 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
-
-### Using ScriptRunner Connect API Connection (Recommended)
-
-When using in ScriptRunner Connect, configure a Generic Connector with the full base URL in the web UI:
-
-**For US region:** `https://api.zephyrscale.smartbear.com/v2`  
-**For EU region:** `https://eu.api.zephyrscale.smartbear.com/v2`
-
-Then use it in your script:
-
-```typescript
-import Zephyr from '@rbaileysr/zephyr-managed-api';
-import ZephyrApiConnection from '../api/zephyr';
-
 // Base URL is configured in the Generic Connector
-const api = Zephyr.createZephyrApi(ZephyrApiConnection);
+const api = createZephyrApi(ZephyrApiConnection);
 ```
 
-### Using OAuth Token
-
-For local testing or when using OAuth tokens directly, provide the full base URL:
-
+**Using OAuth Token:**
 ```typescript
-import Zephyr from '@rbaileysr/zephyr-managed-api';
+import { createZephyrApi } from '@rbaileysr/zephyr-managed-api';
 
 // US region
-const api = Zephyr.createZephyrApi(
+const api = createZephyrApi(
   'your-oauth-token',
   'https://api.zephyrscale.smartbear.com/v2'
 );
 
 // EU region
-const apiEU = Zephyr.createZephyrApi(
+const apiEU = createZephyrApi(
   'your-oauth-token',
   'https://eu.api.zephyrscale.smartbear.com/v2'
 );
 ```
 
-## Private API ⚠️
-
-> **⚠️ WARNING: Private API Usage**
-> 
-> The Private API methods use Zephyr's private/unofficial endpoints that are not officially supported by SmartBear. These endpoints may change or be removed at any time without notice and are not covered by Standard Support. Use these methods at your own risk.
-
-The Private API group provides access to functionality not available in the public Zephyr API, such as creating custom fields and test case versions. These methods require Jira user credentials (email and API token) rather than OAuth tokens.
-
-### Authentication
-
-Private API methods use Jira Basic Authentication (email + API token) to retrieve a Context JWT token, which is then used to authenticate with Zephyr's private endpoints.
+## Supported API calls
+
+- [fetch](https://docs.adaptavist.com/src/managed-apis/managed-api-abstractions)
+- Project
+    - [listProjects](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Projects/operation/listProjects)
+    - [getProject](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Projects/operation/getProject)
+- Status
+    - [listStatuses](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Statuses/operation/listStatuses)
+    - [getStatus](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Statuses/operation/getStatus)
+    - [createStatus](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Statuses/operation/createStatus)
+    - [updateStatus](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Statuses/operation/updateStatus)
+- Priority
+    - [listPriorities](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Priorities/operation/listPriorities)
+    - [getPriority](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Priorities/operation/getPriority)
+    - [createPriority](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Priorities/operation/createPriority)
+    - [updatePriority](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Priorities/operation/updatePriority)
+- Environment
+    - [listEnvironments](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Environments/operation/listEnvironments)
+    - [getEnvironment](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Environments/operation/getEnvironment)
+    - [createEnvironment](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Environments/operation/createEnvironment)
+    - [updateEnvironment](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Environments/operation/updateEnvironment)
+- Folder
+    - [listFolders](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Folders/operation/listFolders)
+    - [getFolder](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Folders/operation/getFolder)
+    - [createFolder](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Folders/operation/createFolder)
+- TestCase
+    - [listTestCases](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Cases/operation/listTestCases)
+    - [listTestCasesCursorPaginated](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Cases/operation/listTestCasesCursorPaginated)
+    - [getTestCase](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Cases/operation/getTestCase)
+    - [createTestCase](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Cases/operation/createTestCase)
+    - [updateTestCase](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Cases/operation/updateTestCase)
+    - [getTestCaseLinks](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Cases/operation/getTestCaseLinks)
+    - [createTestCaseIssueLink](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Cases/operation/createTestCaseIssueLink)
+    - [createTestCaseWebLink](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Cases/operation/createTestCaseWebLink)
+    - [listTestCaseVersions](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Cases/operation/listTestCaseVersions)
+    - [getTestCaseVersion](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Cases/operation/getTestCaseVersion)
+    - [getTestCaseTestScript](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Cases/operation/getTestCaseTestScript)
+    - [createTestCaseTestScript](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Cases/operation/createTestCaseTestScript)
+    - [getTestCaseTestSteps](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Cases/operation/getTestCaseTestSteps)
+    - [createTestCaseTestSteps](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Cases/operation/createTestCaseTestSteps)
+- TestCycle
+    - [listTestCycles](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Cycles/operation/listTestCycles)
+    - [getTestCycle](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Cycles/operation/getTestCycle)
+    - [createTestCycle](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Cycles/operation/createTestCycle)
+    - [updateTestCycle](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Cycles/operation/updateTestCycle)
+    - [getTestCycleLinks](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Cycles/operation/getTestCycleLinks)
+    - [createTestCycleIssueLink](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Cycles/operation/createTestCycleIssueLink)
+    - [createTestCycleWebLink](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Cycles/operation/createTestCycleWebLink)
+- TestPlan
+    - [listTestPlans](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Plans/operation/listTestPlans)
+    - [getTestPlan](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Plans/operation/getTestPlan)
+    - [createTestPlan](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Plans/operation/createTestPlan)
+    - [createTestPlanIssueLink](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Plans/operation/createTestPlanIssueLink)
+    - [createTestPlanWebLink](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Plans/operation/createTestPlanWebLink)
+    - [createTestPlanTestCycleLink](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Plans/operation/createTestPlanTestCycleLink)
+- TestExecution
+    - [listTestExecutions](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Executions/operation/listTestExecutions)
+    - [listTestExecutionsNextgen](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Executions/operation/listTestExecutionsNextgen)
+    - [getTestExecution](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Executions/operation/getTestExecution)
+    - [createTestExecution](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Executions/operation/createTestExecution)
+    - [updateTestExecution](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Executions/operation/updateTestExecution)
+    - [getTestExecutionTestSteps](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Executions/operation/getTestExecutionTestSteps)
+    - [putTestExecutionTestSteps](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Executions/operation/putTestExecutionTestSteps)
+    - [syncTestExecutionScript](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Executions/operation/syncTestExecutionScript)
+    - [listTestExecutionLinks](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Executions/operation/listTestExecutionLinks)
+    - [createTestExecutionIssueLink](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Executions/operation/createTestExecutionIssueLink)
+- Link
+    - [deleteLink](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Links/operation/deleteLink)
+- IssueLink
+    - [getIssueLinkTestCases](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Issue-Links/operation/getIssueLinkTestCases)
+    - [getIssueLinkTestCycles](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Issue-Links/operation/getIssueLinkTestCycles)
+    - [getIssueLinkTestPlans](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Issue-Links/operation/getIssueLinkTestPlans)
+    - [getIssueLinkExecutions](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Issue-Links/operation/getIssueLinkExecutions)
+- Automation
+    - [createCustomExecutions](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Automation/operation/createCustomExecutions)
+    - [createCucumberExecutions](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Automation/operation/createCucumberExecutions)
+    - [createJUnitExecutions](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Automation/operation/createJUnitExecutions)
+    - [retrieveBDDTestCases](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Automation/operation/retrieveBDDTestCases)
+- Private ⚠️
+    > **⚠️ WARNING: Private API Methods**
+    > 
+    > The following methods use Zephyr's private/unofficial API endpoints that 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 methods at your own risk. They may break with future Zephyr updates.
+    
+    - Authentication
+        - **getContextJwt] - Get Jira Context JWT token (required for all private API calls)
+    - Comments
+        - **getTestCaseComments** - Get all comments for a test case
+        - **getTestCycleComments** - Get all comments for a test cycle
+        - **getTestPlanComments** - Get all comments for a test plan
+        - **createTestCaseComment** - Create a comment on a test case
+        - **createTestCycleComment** - Create a comment on a test cycle
+        - **createTestPlanComment** - Create a comment on a test plan
+    - CustomFields
+        - **createCustomField** - Create custom fields for test cases, test plans, test runs, test steps, or test executions
+        - **getCustomFields** - Get all custom fields for test cases, test plans, test runs, test steps, or test executions
+    - Versions
+        - **createTestCaseVersion** - Create a new test case version
+    - Attachments
+        - **getTestCaseAttachments** - Get all attachments for a test case
+        - **downloadAttachment** - Download an attachment from a test case
+        - **createAttachment** - Upload an attachment to a test case
+        - **getTestStepAttachments** - Get all attachments for a test step
+        - **downloadTestStepAttachment** - Download an attachment from a test step
+        - **createTestStepAttachment** - Upload an attachment to a test step
+        - **getTestCycleAttachments** - Get all attachments for a test cycle
+        - **downloadTestCycleAttachment** - Download an attachment from a test cycle
+        - **createTestCycleAttachment** - Upload an attachment to a test cycle
+        - **getTestPlanAttachments** - Get all attachments for a test plan
+        - **downloadTestPlanAttachment** - Download an attachment from a test plan
+        - **createTestPlanAttachment** - Upload an attachment to a test plan
+        - **getTestExecutionAttachments** - Get all attachments for a test execution
+        - **downloadTestExecutionAttachment** - Download an attachment from a test execution
+        - **createTestExecutionAttachment** - Upload an attachment to a test execution
+        - **getTestExecutionStepAttachments** - Get all attachments for a test execution step
+        - **downloadTestExecutionStepAttachment** - Download an attachment from a test execution step
+        - **createTestExecutionStepAttachment** - Upload an attachment to a test execution step
+
+## Private API Authentication
+
+Private API methods require Jira user credentials (email and API token) rather than OAuth tokens. These methods use Jira Basic Authentication to retrieve a Context JWT token, which is then used to authenticate with Zephyr's private endpoints.
 
 ### Get Context JWT
 
 The Context JWT is a short-lived token (15 minutes) required for all private API calls:
 
 ```typescript
-import Zephyr from '@rbaileysr/zephyr-managed-api';
+import { createZephyrApi } from '@rbaileysr/zephyr-managed-api';
 import ZephyrApiConnection from '../api/zephyr';
 
-const api = Zephyr.createZephyrApi(ZephyrApiConnection);
+const api = createZephyrApi(ZephyrApiConnection);
+
+// Define credentials once
+const credentials = {
+  userEmail: 'user@example.com',
+  apiToken: 'jira-api-token',
+  jiraInstanceUrl: 'https://your-instance.atlassian.net'
+};
 
 // Get Context JWT token
-const contextJwt = await api.Private.getContextJwt(
-  'user@example.com',
-  'jira-api-token',
-  'https://your-instance.atlassian.net'
-);
+const contextJwt = await api.Private.Authentication.getContextJwt(credentials);
 ```
 
-### Create Custom Fields
-
-Create custom fields for test cases, test plans, test runs, or test steps:
+### Example: Create Custom Field
 
 ```typescript
-// Create a basic custom field for test cases
-const customField = await api.Private.createCustomField(
-  'user@example.com',
-  'jira-api-token',
-  'https://your-instance.atlassian.net',
-  'TEST_CASE', // Category: TEST_CASE, TEST_PLAN, TEST_RUN, or TEST_STEP
+// Create a custom field for test cases
+const customField = await api.Private.CustomFields.createCustomField(
+  credentials,
+  'TEST_CASE',
   {
     projectId: 10017,
     name: 'Build Number',
-    type: 'SINGLE_LINE_TEXT', // CHECKBOX, NUMBER, DECIMAL, SINGLE_LINE_TEXT, MULTI_LINE_TEXT, SINGLE_CHOICE_SELECT_LIST, MULTI_CHOICE_SELECT_LIST, USER_LIST, DATE
+    type: 'SINGLE_LINE_TEXT',
     required: false,
     index: 4,
     category: 'TEST_CASE',
-    options: [], // Only for SINGLE_CHOICE_SELECT_LIST or MULTI_CHOICE_SELECT_LIST
-    archived: false
-  }
-);
-
-// Create a custom field with options (select list)
-const selectField = await api.Private.createCustomField(
-  'user@example.com',
-  'jira-api-token',
-  'https://your-instance.atlassian.net',
-  'TEST_CASE',
-  {
-    projectId: 10017,
-    name: 'Test Category',
-    type: 'MULTI_CHOICE_SELECT_LIST',
-    required: false,
-    index: 5,
-    category: 'TEST_CASE',
-    options: [
-      { index: 1, name: 'Smoke', archived: false },
-      { index: 2, name: 'Regression', archived: false },
-      { index: 3, name: 'Performance', archived: false }
-    ],
     archived: false
   }
 );
 ```
 
-**Available Custom Field Types:**
-- `CHECKBOX` - Checkbox
-- `NUMBER` - Number
-- `DECIMAL` - Decimal number
-- `SINGLE_LINE_TEXT` - Single-line text
-- `MULTI_LINE_TEXT` - Multi-line text
-- `SINGLE_CHOICE_SELECT_LIST` - Single-choice select list
-- `MULTI_CHOICE_SELECT_LIST` - Multi-choice select list
-- `USER_LIST` - User picker
-- `DATE` - Date picker
-
-**Available Categories:**
-- `TEST_CASE` - Custom field for test cases
-- `TEST_PLAN` - Custom field for test plans
-- `TEST_RUN` - Custom field for test cycles (test runs)
-- `TEST_STEP` - Custom field for test steps
-
-### Create Test Case Version
-
-Create a new version of an existing test case. **Note:** When a new version is created, the `testCaseId` changes for that test case.
+### Example: Create Test Case Version
 
 ```typescript
-// 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',
+// Create a new version of an existing test case
+const newVersion = await api.Private.Versions.createTestCaseVersion(
+  credentials,
   {
     testCaseKey: 'PROJ-T1',  // Uses key, looks up ID automatically
     projectId: 10017          // Numeric project ID
   }
 );
-// Returns: { id: 286693656, key: "ZEP-T18" }
 ```
 
-**Important Notes:**
-- 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.
+### Example: Upload Attachment
 
 ```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.
+// Upload an attachment to a test case
+const file = new Blob(['file content'], { type: 'text/plain' });
 
-```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',
+const attachment = await api.Private.Attachments.createAttachment(
+  credentials,
   {
     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
+    file: file,
     fileName: 'test-file.txt',
     userAccountId: '5d6fdc98dc6e480dbc021aae'  // Atlassian account ID
   }
@@ -608,391 +240,84 @@ const attachment = await api.Private.createAttachment(
 ```
 
 **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:
-
-```typescript
-try {
-  await api.Private.createCustomField(...);
-} catch (error) {
-  if (error instanceof Zephyr.BadRequestError) {
-    console.log('Invalid request parameters');
-  } else if (error instanceof Zephyr.UnauthorizedError) {
-    console.log('Authentication failed - check your credentials');
-  } else if (error instanceof Zephyr.ForbiddenError) {
-    console.log('Insufficient permissions');
-  } else if (error instanceof Zephyr.NotFoundError) {
-    console.log('Resource not found');
-  } else if (error instanceof Zephyr.ServerError) {
-    if (error.status === 409) {
-      console.log('Conflict - version already exists');
-    }
-  }
-}
-```
-
-## Custom Fields
-
-Custom fields are supported as flexible key-value pairs:
-
-```typescript
-const customFields = {
-  'Build Number': 20,
-  'Release Date': '2024-01-15',
-  'Pre-Condition(s)': 'User should have logged in.<br>User should have navigated to the panel.',
-  'Implemented': false,
-  'Category': ['Performance', 'Regression'],
-  'Tester': 'user-account-id-here'
-};
-
-await api.TestCase.createTestCase({
-  body: {
-    projectKey: 'PROJ',
-    name: 'Test Case',
-    customFields: customFields
-  }
-});
-```
-
-**Note**: 
-- Multi-line text fields support HTML with `<br>` tags
-- Dates should be in format `yyyy-MM-dd`
-- Users should have values of Jira User Account IDs
-- Custom field types are defined in your Zephyr project configuration
-
-## Error Handling
-
-The API uses Commons Core-compatible error types for consistent error handling. All API methods automatically retry on rate limiting (HTTP 429) with exponential backoff.
-
-### Error Types
-
-```typescript
-// Single import for everything
-import Zephyr from '@rbaileysr/zephyr-managed-api';
-import ZephyrApiConnection from '../api/zephyr';
+- Private API methods require a `PrivateApiCredentials` object with `userEmail`, `apiToken`, and `jiraInstanceUrl`
+- The Context JWT token expires after 15 minutes and must be retrieved for each private API call
+- All private API methods automatically handle Context JWT retrieval internally
+- Methods that accept keys (like `testCaseKey`) automatically look up numeric IDs when needed
 
-const api = Zephyr.createZephyrApi(ZephyrApiConnection);
-
-try {
-  const testCase = await api.TestCase.getTestCase({ testCaseKey: 'INVALID-T1' });
-} catch (error) {
-  if (error instanceof Zephyr.NotFoundError) {
-    console.log('Test case not found');
-  } else if (error instanceof Zephyr.BadRequestError) {
-    console.log('Invalid request');
-  } else if (error instanceof Zephyr.TooManyRequestsError) {
-    console.log('Rate limited - this should have been retried automatically');
-  } else if (error instanceof Zephyr.HttpError) {
-    console.log(`HTTP error: ${error.message}`);
-  }
-}
-```
-
-**Alternative - Named Imports:**
-```typescript
-import { 
-  createZephyrApi,
-  BadRequestError, 
-  UnauthorizedError, 
-  ForbiddenError,
-  NotFoundError,
-  TooManyRequestsError,
-  ServerError,
-  HttpError,
-  UnexpectedError
-} from '@rbaileysr/zephyr-managed-api';
-
-// Use named imports as before
-```
-
-### Automatic Rate Limiting Handling
-
-All API methods automatically handle rate limiting (HTTP 429) with:
-
-- **Exponential Backoff**: Starts at 1 second, doubles with each retry
-- **Retry-After Header Support**: Respects `Retry-After` header when present
-- **Configurable Retries**: Defaults to 5 retries, max delay of 60 seconds
-- **Transparent Operation**: Retries happen automatically - no code changes needed
-
-**Default Retry Configuration:**
-- Maximum retries: 5
-- Initial delay: 1 second
-- Maximum delay: 60 seconds
-- Backoff multiplier: 2x
-
-**Example:**
-```typescript
-// This call will automatically retry on 429 errors
-// You don't need to handle rate limiting manually
-const testCases = await api.TestCase.listTestCases({ projectKey: 'PROJ' });
-```
-
-If rate limiting occurs:
-1. The API waits (using Retry-After header if present, otherwise exponential backoff)
-2. Retries the request automatically
-3. Repeats up to 5 times
-4. Only throws `TooManyRequestsError` if all retries are exhausted
-
-### Error Strategy Support
-
-For advanced error handling, you can provide an `errorStrategy` parameter to customize how errors are handled:
-
-```typescript
-import Zephyr from '@rbaileysr/zephyr-managed-api';
-import ZephyrApiConnection from '../api/zephyr';
+## Contact
 
-const api = Zephyr.createZephyrApi(ZephyrApiConnection);
+Feel free to drop ideas, suggestions or improvements into our [Community hub](https://loop.scriptrunnerhq.com/c/integration-forum).
 
-// Return null instead of throwing on 404
-const testCase = await api.TestCase.getTestCase(
-  { testCaseKey: 'PROJ-T1' },
-  {
-    handleHttp404Error: () => ({ type: 'return', value: null })
-  }
-);
-
-// Using ErrorStrategyBuilder for cleaner syntax
-const errorStrategy = new Zephyr.ErrorStrategyBuilder<TestCase | null>()
-  .http404Error(() => ({ type: 'return', value: null }))
-  .retryOnRateLimiting(10) // Retry up to 10 times on rate limiting
-  .http500Error(() => Zephyr.retry(5000)) // Retry server errors with 5s delay
-  .build();
-
-const testCase2 = await api.TestCase.getTestCase(
-  { testCaseKey: 'PROJ-T2' },
-  errorStrategy
-);
-```
-
-**Available Error Strategy Handlers:**
-- `handleHttp400Error` - Handle 400 Bad Request
-- `handleHttp401Error` - Handle 401 Unauthorized
-- `handleHttp403Error` - Handle 403 Forbidden
-- `handleHttp404Error` - Handle 404 Not Found
-- `handleHttp429Error` - Handle 429 Too Many Requests (receives retryCount)
-- `handleHttp500Error` - Handle 500+ Server Errors
-- `handleHttpError` - Handle any HTTP error (fallback)
-
-**Error Strategy Actions:**
-- `retry(delay)` - Retry the request after the specified delay (milliseconds)
-- `continuePropagation()` - Let the error propagate normally (default)
-- `{ type: 'return', value: T }` - Return a specific value instead of throwing
-
-### Error Type Reference
-
-| Error Type | HTTP Status | Description |
-|------------|-------------|-------------|
-| `BadRequestError` | 400 | Invalid request parameters |
-| `UnauthorizedError` | 401 | Authentication required or invalid |
-| `ForbiddenError` | 403 | Insufficient permissions |
-| `NotFoundError` | 404 | Resource not found |
-| `TooManyRequestsError` | 429 | Rate limit exceeded (after retries) |
-| `ServerError` | 500+ | Server-side error |
-| `HttpError` | Other | Generic HTTP error |
-| `UnexpectedError` | N/A | Network or parsing errors |
-
-## Pagination
-
-### Manual Pagination
-
-#### Offset-Based Pagination
-
-```typescript
-const testCases = await api.TestCase.listTestCases({
-  projectKey: 'PROJ',
-  maxResults: 50,
-  startAt: 0
-});
-
-// Check if more results available
-if (!testCases.isLast) {
-  const nextPage = await api.TestCase.listTestCases({
-    projectKey: 'PROJ',
-    maxResults: 50,
-    startAt: testCases.startAt + testCases.maxResults
-  });
-}
-```
-
-#### Cursor-Based Pagination
-
-```typescript
-const testCases = await api.TestCase.listTestCasesCursorPaginated({
-  projectKey: 'PROJ',
-  limit: 100,
-  startAtId: 0
-});
-
-// Get next page
-if (testCases.nextStartAtId !== null) {
-  const nextPage = await api.TestCase.listTestCasesCursorPaginated({
-    projectKey: 'PROJ',
-    limit: 100,
-    startAtId: testCases.nextStartAtId
-  });
-}
-```
-
-### Automatic Pagination with `getAllPages()`
-
-For convenience, use `getAllPages()` to automatically fetch all pages:
-
-#### Offset-Based Pagination
-
-```typescript
-import Zephyr from '@rbaileysr/zephyr-managed-api';
-import ZephyrApiConnection from '../api/zephyr';
-
-const api = Zephyr.createZephyrApi(ZephyrApiConnection);
-
-// Automatically fetches all pages
-const allTestCases = await Zephyr.getAllPages(
-  (startAt, maxResults) => api.TestCase.listTestCases({
-    projectKey: 'PROJ',
-    startAt,
-    maxResults
-  }),
-  { maxResults: 50 } // Optional: page size
-);
-
-// allTestCases is an array of all TestCase objects from all pages
-console.log(`Found ${allTestCases.length} test cases`);
-```
-
-#### Cursor-Based Pagination
-
-```typescript
-import Zephyr from '@rbaileysr/zephyr-managed-api';
-import ZephyrApiConnection from '../api/zephyr';
-
-const api = Zephyr.createZephyrApi(ZephyrApiConnection);
-
-// Automatically fetches all pages
-const allTestCases = await Zephyr.getAllPagesCursor(
-  (startAtId, limit) => api.TestCase.listTestCasesCursorPaginated({
-    projectKey: 'PROJ',
-    startAtId,
-    limit
-  }),
-  { limit: 100 } // Optional: page size
-);
-
-// allTestCases is an array of all TestCase objects from all pages
-console.log(`Found ${allTestCases.length} test cases`);
-```
+## Changelog
 
-**Note**: `getAllPages()` and `getAllPagesCursor()` automatically handle pagination and will make multiple API calls as needed. Be mindful of rate limits when fetching large datasets.
+### 1.2.9
 
-## API Documentation
+- **Changed**: Test step and test execution step attachment methods now use `stepIndex` (zero-based array index) instead of `stepId`/`testScriptResultId` for better usability
+- **Changed**: Renamed `createAttachment` to `createTestCaseAttachment` to match naming convention with other attachment methods
+- **Removed**: All deprecated methods from `Private` group - use sub-groups (`Private.Comments`, `Private.Attachments`, etc.) instead
+- **Fixed**: Corrected API documentation URLs in README to use proper tag-based format
 
-All API methods include comprehensive JSDoc comments with:
-- Detailed descriptions of what each endpoint does
-- Parameter documentation with types and requirements
-- Return type documentation
-- Links to official Zephyr API documentation
+### 1.2.8
 
-When using the package in ScriptRunner Connect, IntelliSense will display these descriptions and links in the code editor.
+- **Added**: Attachment support for test steps, test executions, and test execution steps
+- **Changed**: Updated `PrivateBase` to include `TestExecutionGroup` for test execution key-to-ID lookups
 
-## Type Definitions
+### 1.2.7
 
-All TypeScript types are exported from the main module:
+- **Added**: Attachment support for test cycles and test plans
 
-```typescript
-import type { 
-  TestCase, 
-  TestCycle, 
-  TestExecution,
-  TestPlan,
-  CustomFields,
-  ZephyrApiConnection,
-  ErrorStrategy,
-  ErrorStrategyBuilder
-} from '@rbaileysr/zephyr-managed-api';
-```
+### 1.2.6
 
-## All Group
+- **Added**: `createTestCycleComment()` and `createTestPlanComment()` methods
+- **Changed**: Private API reorganized into sub-groups for better organization
 
-For programmatic access to all methods, use the `All` group:
-
-```typescript
-// Access all methods through the All group
-const testCase = await Zephyr.All.getTestCase({ testCaseKey: 'PROJ-T1' });
-const testCycle = await Zephyr.All.createTestCycle({ body: { ... } });
-```
+### 1.2.5
 
-The `All` group provides a single point of access to all API methods across all resource groups, useful for dynamic method invocation or when you need to iterate over all available methods.
+- **Added**: `getTestPlanComments()` method
+- **Changed**: Private API reorganized into sub-groups (Authentication, Comments, CustomFields, Versions, Attachments)
 
-## License
+### 1.2.4
 
-UNLICENSED - Copyright Adaptavist 2025 (c) All rights reserved
+- **Added**: `getTestCaseComments()` and `getTestCycleComments()` methods
 
-## Support
+### 1.2.3
 
-For issues, questions, or contributions, please refer to the project repository on GitHub.
+- **Changed**: All private API methods now accept a single `PrivateApiCredentials` interface instead of three separate parameters
 
-## Links
+### 1.2.2
 
-- **NPM Package**: https://www.npmjs.com/package/@rbaileysr/zephyr-managed-api
-- **Zephyr API Documentation**: https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/
-- **ScriptRunner Connect Documentation**: https://docs.adaptavist.com/src/latest/
-
-## Changelog
+- **Added**: `getCustomFields()` method for retrieving custom fields
+- **Added**: Support for `TEST_EXECUTION` category in custom field operations
 
 ### 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 (accepts testCaseKey and looks up ID automatically)
+  - `getContextJwt()` - Retrieve Jira Context JWT token
+  - `createCustomField()` - Create custom fields for test cases, test plans, test runs, test steps, and test executions
+  - `createTestCaseVersion()` - Create new test case versions
   - `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
+  - `getTestCaseAttachments()` - Get all attachment details for a test case
+  - `downloadAttachment()` - Download attachment files into memory
+  - `createAttachment()` - Upload file attachments to test cases
 
 ### 1.0.1
 
-- **Added**: Comprehensive JSDoc comments with API endpoint descriptions and links to official documentation
-- **Added**: Single import option via default export for convenient usage
+- **Added**: Comprehensive JSDoc comments with API endpoint descriptions
+- **Added**: Single import option via default export
 - **Changed**: Removed `region` parameter from `createZephyrApi` - base URL now configured in Generic Connector
-- **Improved**: Error handling to support both `BadRequestError` and `NotFoundError` in test examples
-- **Improved**: Type safety and IntelliSense support throughout the API
 
 ### 1.0.0
 
 - **Initial Release**: Complete Managed API wrapper for Zephyr Cloud REST API v2
-- **Added**: Full support for all Zephyr API endpoints (Test Cases, Test Cycles, Test Plans, Test Executions, etc.)
-- **Added**: Type-safe TypeScript definitions for all API operations
+- **Added**: Full support for all Zephyr API endpoints
+- **Added**: Type-safe TypeScript definitions
 - **Added**: Hierarchical API structure matching ScriptRunner Connect conventions
 - **Added**: Automatic rate limiting retry with exponential backoff
 - **Added**: Support for both API Connection and OAuth token authentication
-- **Added**: Pagination helpers (`getAllPages`, `getAllPagesCursor`)
-- **Added**: Error strategy builder for advanced error handling
-- **Added**: Comprehensive error types compatible with Commons Core
 
+Copyright Adaptavist 2025 (c) All rights reserved