@rbaileysr/zephyr-managed-api 1.3.3 → 1.3.5

package/README.md

@@ -16,14 +16,14 @@ npm install @rbaileysr/zephyr-managed-api
 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
+   ```typescript
 import { createZephyrApi } from '@rbaileysr/zephyr-managed-api';
-import ZephyrApiConnection from '../api/zephyr';
+   import ZephyrApiConnection from '../api/zephyr';
 
-// Base URL is configured in the Generic Connector
+   // Base URL is configured in the Generic Connector
 const api = createZephyrApi(ZephyrApiConnection);
-```
-
+   ```
+   
 **Using OAuth Token:**
    ```typescript
 import { createZephyrApi } from '@rbaileysr/zephyr-managed-api';
@@ -133,52 +133,28 @@ const apiEU = createZephyrApi(
     - 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
+        - **Test Case**: `getTestCaseComments`, `createTestCaseComment`
+        - **Test Cycle**: `getTestCycleComments`, `createTestCycleComment`
+        - **Test Plan**: `getTestPlanComments`, `createTestPlanComment`
     - Config
-        - **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
-        - **Labels**
-            - **getLabels** - Get all labels for a project
-            - **createLabel** - Create a new label
-        - **Iterations**
-            - **getIterations** - Get all iterations for a project
-            - **createIteration** - Create a new iteration
-        - **DataSets**
-            - **getDataSets** - Get all data sets for a project
-            - **createDataSet** - Create a new data set
-            - **updateDataSet** - Update a data set (add items/options)
+        - **CustomFields**: `createCustomField`, `getCustomFields`
+        - **Labels**: `getLabels`, `createLabel`
+        - **Iterations**: `getIterations`, `createIteration`
+        - **DataSets**: `getDataSets`, `createDataSet`, `updateDataSet`
+        - **archiveConfig** - Archive an Environment or Iteration
+        - **unarchiveConfig** - Unarchive an Environment or Iteration
     - 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
+        - **Test Case**: `getTestCaseAttachments`, `downloadAttachment`, `createTestCaseAttachment`
+        - **Test Step**: `getTestStepAttachments`, `downloadTestStepAttachment`, `createTestStepAttachment`
+        - **Test Cycle**: `getTestCycleAttachments`, `downloadTestCycleAttachment`, `createTestCycleAttachment`
+        - **Test Plan**: `getTestPlanAttachments`, `downloadTestPlanAttachment`, `createTestPlanAttachment`
+        - **Test Execution**: `getTestExecutionAttachments`, `downloadTestExecutionAttachment`, `createTestExecutionAttachment`
+        - **Test Execution Step**: `getTestExecutionStepAttachments`, `downloadTestExecutionStepAttachment`, `createTestExecutionStepAttachment`
     - VersionControl
-        - **getTestCaseIssueLinks** - Get issue links for a test case (with version support)
-        - **getTestCaseWebLinks** - Get web links for a test case (with version support)
-        - **getTestCaseTestScript** - Get test script for a test case (with version support)
-        - **getTestCaseTestSteps** - Get test steps for a test case (with version support)
+        - **Test Case (version-specific)**: `getTestCaseIssueLinks`, `getTestCaseWebLinks`, `getTestCaseTestScript`, `getTestCaseTestSteps`
+        - **Test Execution Step**: `getTestExecutionStepIssueLinks`, `createTestExecutionStepIssueLink`
 
 ## Private API Authentication
 
@@ -282,6 +258,24 @@ const dataSets = await api.Private.Config.DataSets.getDataSets(credentials, {
 });
 ```
 
+### Example: Archive and Unarchive Config Items
+
+```typescript
+// Archive an environment
+const archivedEnv = await api.Private.Config.archiveConfig(credentials, {
+  type: 'Environment',
+  id: 10873400,
+  projectId: 10233
+});
+
+// Unarchive an iteration
+const unarchivedIteration = await api.Private.Config.unarchiveConfig(credentials, {
+  type: 'Iteration',
+  id: 10909775,
+  projectId: 10233
+});
+```
+
 ### Example: Create Test Case Version
 
 ```typescript
@@ -301,7 +295,7 @@ const newVersion = await api.Private.Versions.createTestCaseVersion(
 // Upload an attachment to a test case
 const file = new Blob(['file content'], { type: 'text/plain' });
 
-const attachment = await api.Private.Attachments.createAttachment(
+const attachment = await api.Private.Attachments.createTestCaseAttachment(
   credentials,
   {
     testCaseKey: 'PROJ-T1',
@@ -319,32 +313,49 @@ const attachment = await api.Private.Attachments.createAttachment(
 // Get issue links for current version
 const issueLinks = await api.Private.VersionControl.getTestCaseIssueLinks(credentials, {
   testCaseKey: 'PROJ-T1',
-  projectId: 10233
+    projectId: 10233
 });
 
 // Get web links for version 2 (previous version)
 const webLinks = await api.Private.VersionControl.getTestCaseWebLinks(credentials, {
   testCaseKey: 'PROJ-T1',
-  projectId: 10233,
+    projectId: 10233,
   version: 2
 });
 
 // Get test script for version 3
 const testScript = await api.Private.VersionControl.getTestCaseTestScript(credentials, {
   testCaseKey: 'PROJ-T1',
-  projectId: 10233,
+    projectId: 10233,
   version: 3
 });
 
-// Get test steps for version 1 (current version)
+// Get test steps for version 4 (current version, if there are 4 versions total)
 const testSteps = await api.Private.VersionControl.getTestCaseTestSteps(credentials, {
   testCaseKey: 'PROJ-T1',
   projectId: 10233,
-  version: 1
+  version: 4
+});
+
+// Get issue links for a test execution step (useful for migration)
+const stepIssueLinks = await api.Private.VersionControl.getTestExecutionStepIssueLinks(credentials, {
+  testExecutionKey: 'PROJ-E1',
+  stepIndex: 0,
+  projectId: 10233
+});
+// Returns: [{ id: 169099471, issueId: '66019', type: 'BLOCKS' }, ...]
+
+// Create an issue link for a test execution step
+const stepLink = await api.Private.VersionControl.createTestExecutionStepIssueLink(credentials, {
+  testExecutionKey: 'PROJ-E1',
+  stepIndex: 0,
+  issueId: 66019,
+  type: 'RELATED',
+  projectId: 10233
 });
 ```
 
-**Note:** Version numbers are relative to the current version (1 = current/latest, 2 = previous, 3 = version before that, etc.). If `version` is not provided, the latest version is used.
+**Note:** Version numbers are absolute (1-based: 1 = first version ever created, 2 = second version, etc. The highest number is the current/latest version). Use `listTestCaseVersions()` to find the total number of versions and identify the latest. If `version` is not provided, the latest version is used.
 
 **Important Notes:**
 - Private API methods require a `PrivateApiCredentials` object with `userEmail`, `apiToken`, and `jiraInstanceUrl`
@@ -358,6 +369,15 @@ Feel free to drop ideas, suggestions or improvements into our [Community hub](ht
 
 ## Changelog
 
+### 1.3.5
+
+- **Changed**: Minor fix to interface for created test step
+
+### 1.3.4
+
+- **Added**: `getTestExecutionStepIssueLinks()` - Get issue links for a test execution step (for migration purposes)
+- **Added**: `createTestExecutionStepIssueLink()` - Create an issue link for a test execution step
+
 ### 1.3.3
 
 - **Added**: New VersionControl sub-group under Private API for version-specific operations

package/dist/README.md

@@ -16,14 +16,14 @@ npm install @rbaileysr/zephyr-managed-api
 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
+   ```typescript
 import { createZephyrApi } from '@rbaileysr/zephyr-managed-api';
-import ZephyrApiConnection from '../api/zephyr';
+   import ZephyrApiConnection from '../api/zephyr';
 
-// Base URL is configured in the Generic Connector
+   // Base URL is configured in the Generic Connector
 const api = createZephyrApi(ZephyrApiConnection);
-```
-
+   ```
+   
 **Using OAuth Token:**
    ```typescript
 import { createZephyrApi } from '@rbaileysr/zephyr-managed-api';
@@ -133,52 +133,28 @@ const apiEU = createZephyrApi(
     - 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
+        - **Test Case**: `getTestCaseComments`, `createTestCaseComment`
+        - **Test Cycle**: `getTestCycleComments`, `createTestCycleComment`
+        - **Test Plan**: `getTestPlanComments`, `createTestPlanComment`
     - Config
-        - **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
-        - **Labels**
-            - **getLabels** - Get all labels for a project
-            - **createLabel** - Create a new label
-        - **Iterations**
-            - **getIterations** - Get all iterations for a project
-            - **createIteration** - Create a new iteration
-        - **DataSets**
-            - **getDataSets** - Get all data sets for a project
-            - **createDataSet** - Create a new data set
-            - **updateDataSet** - Update a data set (add items/options)
+        - **CustomFields**: `createCustomField`, `getCustomFields`
+        - **Labels**: `getLabels`, `createLabel`
+        - **Iterations**: `getIterations`, `createIteration`
+        - **DataSets**: `getDataSets`, `createDataSet`, `updateDataSet`
+        - **archiveConfig** - Archive an Environment or Iteration
+        - **unarchiveConfig** - Unarchive an Environment or Iteration
     - 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
+        - **Test Case**: `getTestCaseAttachments`, `downloadAttachment`, `createTestCaseAttachment`
+        - **Test Step**: `getTestStepAttachments`, `downloadTestStepAttachment`, `createTestStepAttachment`
+        - **Test Cycle**: `getTestCycleAttachments`, `downloadTestCycleAttachment`, `createTestCycleAttachment`
+        - **Test Plan**: `getTestPlanAttachments`, `downloadTestPlanAttachment`, `createTestPlanAttachment`
+        - **Test Execution**: `getTestExecutionAttachments`, `downloadTestExecutionAttachment`, `createTestExecutionAttachment`
+        - **Test Execution Step**: `getTestExecutionStepAttachments`, `downloadTestExecutionStepAttachment`, `createTestExecutionStepAttachment`
     - VersionControl
-        - **getTestCaseIssueLinks** - Get issue links for a test case (with version support)
-        - **getTestCaseWebLinks** - Get web links for a test case (with version support)
-        - **getTestCaseTestScript** - Get test script for a test case (with version support)
-        - **getTestCaseTestSteps** - Get test steps for a test case (with version support)
+        - **Test Case (version-specific)**: `getTestCaseIssueLinks`, `getTestCaseWebLinks`, `getTestCaseTestScript`, `getTestCaseTestSteps`
+        - **Test Execution Step**: `getTestExecutionStepIssueLinks`, `createTestExecutionStepIssueLink`
 
 ## Private API Authentication
 
@@ -282,6 +258,24 @@ const dataSets = await api.Private.Config.DataSets.getDataSets(credentials, {
 });
 ```
 
+### Example: Archive and Unarchive Config Items
+
+```typescript
+// Archive an environment
+const archivedEnv = await api.Private.Config.archiveConfig(credentials, {
+  type: 'Environment',
+  id: 10873400,
+  projectId: 10233
+});
+
+// Unarchive an iteration
+const unarchivedIteration = await api.Private.Config.unarchiveConfig(credentials, {
+  type: 'Iteration',
+  id: 10909775,
+  projectId: 10233
+});
+```
+
 ### Example: Create Test Case Version
 
 ```typescript
@@ -301,7 +295,7 @@ const newVersion = await api.Private.Versions.createTestCaseVersion(
 // Upload an attachment to a test case
 const file = new Blob(['file content'], { type: 'text/plain' });
 
-const attachment = await api.Private.Attachments.createAttachment(
+const attachment = await api.Private.Attachments.createTestCaseAttachment(
   credentials,
   {
     testCaseKey: 'PROJ-T1',
@@ -319,32 +313,49 @@ const attachment = await api.Private.Attachments.createAttachment(
 // Get issue links for current version
 const issueLinks = await api.Private.VersionControl.getTestCaseIssueLinks(credentials, {
   testCaseKey: 'PROJ-T1',
-  projectId: 10233
+    projectId: 10233
 });
 
 // Get web links for version 2 (previous version)
 const webLinks = await api.Private.VersionControl.getTestCaseWebLinks(credentials, {
   testCaseKey: 'PROJ-T1',
-  projectId: 10233,
+    projectId: 10233,
   version: 2
 });
 
 // Get test script for version 3
 const testScript = await api.Private.VersionControl.getTestCaseTestScript(credentials, {
   testCaseKey: 'PROJ-T1',
-  projectId: 10233,
+    projectId: 10233,
   version: 3
 });
 
-// Get test steps for version 1 (current version)
+// Get test steps for version 4 (current version, if there are 4 versions total)
 const testSteps = await api.Private.VersionControl.getTestCaseTestSteps(credentials, {
   testCaseKey: 'PROJ-T1',
   projectId: 10233,
-  version: 1
+  version: 4
+});
+
+// Get issue links for a test execution step (useful for migration)
+const stepIssueLinks = await api.Private.VersionControl.getTestExecutionStepIssueLinks(credentials, {
+  testExecutionKey: 'PROJ-E1',
+  stepIndex: 0,
+  projectId: 10233
+});
+// Returns: [{ id: 169099471, issueId: '66019', type: 'BLOCKS' }, ...]
+
+// Create an issue link for a test execution step
+const stepLink = await api.Private.VersionControl.createTestExecutionStepIssueLink(credentials, {
+  testExecutionKey: 'PROJ-E1',
+  stepIndex: 0,
+  issueId: 66019,
+  type: 'RELATED',
+  projectId: 10233
 });
 ```
 
-**Note:** Version numbers are relative to the current version (1 = current/latest, 2 = previous, 3 = version before that, etc.). If `version` is not provided, the latest version is used.
+**Note:** Version numbers are absolute (1-based: 1 = first version ever created, 2 = second version, etc. The highest number is the current/latest version). Use `listTestCaseVersions()` to find the total number of versions and identify the latest. If `version` is not provided, the latest version is used.
 
 **Important Notes:**
 - Private API methods require a `PrivateApiCredentials` object with `userEmail`, `apiToken`, and `jiraInstanceUrl`
@@ -358,6 +369,15 @@ Feel free to drop ideas, suggestions or improvements into our [Community hub](ht
 
 ## Changelog
 
+### 1.3.5
+
+- **Changed**: Minor fix to interface for created test step
+
+### 1.3.4
+
+- **Added**: `getTestExecutionStepIssueLinks()` - Get issue links for a test execution step (for migration purposes)
+- **Added**: `createTestExecutionStepIssueLink()` - Create an issue link for a test execution step
+
 ### 1.3.3
 
 - **Added**: New VersionControl sub-group under Private API for version-specific operations

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

@@ -1 +1 @@
-{"version":3,"file":"All.d.ts","sourceRoot":"","sources":["../../groups/All.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;;;;;GAMG;AAEH,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAcpD,qBAAa,QAAQ;IACpB,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAgB;IACzC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAiB;IAC3C,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAqB;IACnD,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAgB;IACzC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAc;IACrC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAe;IACvC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAc;IACrC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAgB;IACzC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAmB;IAC/C,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAY;IACjC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAiB;IAC3C,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAkB;gBAEjC,aAAa,EAAE,mBAAmB;IAgB9C,IAAI,aAAa,oGAEhB;IAED,IAAI,4BAA4B,+GAE/B;IAED,IAAI,WAAW,2MAEd;IAED,IAAI,cAAc,4GAEjB;IAED,IAAI,cAAc,yEAEjB;IAED,IAAI,gBAAgB,0EAEnB;IAED,IAAI,uBAAuB,gHAE1B;IAED,IAAI,qBAAqB,8GAExB;IAED,IAAI,oBAAoB,qHAEvB;IAED,IAAI,kBAAkB,oGAErB;IAED,IAAI,qBAAqB,oEAExB;IAED,IAAI,wBAAwB,iHAE3B;IAED,IAAI,oBAAoB;kBAuNs8N,CAAC;eAAiB,CAAC;oDArNh/N;IAED,IAAI,uBAAuB,gHAE1B;IAGD,IAAI,cAAc,sGAEjB;IAED,IAAI,YAAY,+FAEf;IAED,IAAI,eAAe,6GAElB;IAED,IAAI,eAAe,0EAElB;IAED,IAAI,iBAAiB,yFAEpB;IAED,IAAI,wBAAwB,iHAE3B;IAED,IAAI,sBAAsB,+GAEzB;IAGD,IAAI,kBAAkB,8GAErB;IAED,IAAI,yBAAyB,gIAE5B;IAED,IAAI,gBAAgB,uGAEnB;IAED,IAAI,mBAAmB,4GAEtB;IAED,IAAI,mBAAmB,8EAEtB;IAED,IAAI,sBAAsB,iGAEzB;IAED,IAAI,4BAA4B,qHAE/B;IAED,IAAI,yBAAyB,6HAE5B;IAED,IAAI,yBAAyB,oFAE5B;IAED,IAAI,uBAAuB,qGAE1B;IAGD,IAAI,aAAa,oGAEhB;IAED,IAAI,WAAW,6FAEd;IAED,IAAI,cAAc,4GAEjB;IAED,IAAI,uBAAuB,gHAE1B;IAED,IAAI,qBAAqB,8GAExB;IAED,IAAI,2BAA2B,oHAE9B;IAGD,IAAI,WAAW,+FAEd;IAED,IAAI,SAAS,yFAEZ;IAED,IAAI,YAAY,4FAEf;IAGD,IAAI,YAAY,kGAEf;IAED,IAAI,UAAU,2FAEb;IAGD,IAAI,YAAY,gGAEf;IAED,IAAI,SAAS,yFAEZ;IAED,IAAI,YAAY,4FAEf;IAED,IAAI,YAAY,4FAEf;IAGD,IAAI,cAAc,oGAEjB;IAED,IAAI,WAAW,6FAEd;IAED,IAAI,cAAc,gGAEjB;IAED,IAAI,cAAc,gGAEjB;IAGD,IAAI,gBAAgB,yGAEnB;IAED,IAAI,cAAc,mGAEjB;IAED,IAAI,iBAAiB,sGAEpB;IAED,IAAI,iBAAiB,sGAEpB;IAGD,IAAI,UAAU,qEAEb;IAGD,IAAI,qBAAqB,wHAExB;IAED,IAAI,sBAAsB,+GAEzB;IAED,IAAI,qBAAqB,6GAExB;IAED,IAAI,sBAAsB,mHAEzB;IAGD,IAAI,sBAAsB,yHAEzB;IAED,IAAI,wBAAwB,2HAE3B;IAED,IAAI,qBAAqB,wHAExB;IAED,IAAI,oBAAoB,+EAEvB;CACD"}
+{"version":3,"file":"All.d.ts","sourceRoot":"","sources":["../../groups/All.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;;;;;GAMG;AAEH,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAcpD,qBAAa,QAAQ;IACpB,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAgB;IACzC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAiB;IAC3C,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAqB;IACnD,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAgB;IACzC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAc;IACrC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAe;IACvC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAc;IACrC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAgB;IACzC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAmB;IAC/C,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAY;IACjC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAiB;IAC3C,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAkB;gBAEjC,aAAa,EAAE,mBAAmB;IAgB9C,IAAI,aAAa,oGAEhB;IAED,IAAI,4BAA4B,+GAE/B;IAED,IAAI,WAAW,2MAEd;IAED,IAAI,cAAc,4GAEjB;IAED,IAAI,cAAc,yEAEjB;IAED,IAAI,gBAAgB,0EAEnB;IAED,IAAI,uBAAuB,gHAE1B;IAED,IAAI,qBAAqB,8GAExB;IAED,IAAI,oBAAoB,qHAEvB;IAED,IAAI,kBAAkB,oGAErB;IAED,IAAI,qBAAqB,oEAExB;IAED,IAAI,wBAAwB,iHAE3B;IAED,IAAI,oBAAoB;kBAuN2hO,CAAC;eAAiB,CAAC;oDArNrkO;IAED,IAAI,uBAAuB,gHAE1B;IAGD,IAAI,cAAc,sGAEjB;IAED,IAAI,YAAY,+FAEf;IAED,IAAI,eAAe,6GAElB;IAED,IAAI,eAAe,0EAElB;IAED,IAAI,iBAAiB,yFAEpB;IAED,IAAI,wBAAwB,iHAE3B;IAED,IAAI,sBAAsB,+GAEzB;IAGD,IAAI,kBAAkB,8GAErB;IAED,IAAI,yBAAyB,gIAE5B;IAED,IAAI,gBAAgB,uGAEnB;IAED,IAAI,mBAAmB,4GAEtB;IAED,IAAI,mBAAmB,8EAEtB;IAED,IAAI,sBAAsB,iGAEzB;IAED,IAAI,4BAA4B,qHAE/B;IAED,IAAI,yBAAyB,6HAE5B;IAED,IAAI,yBAAyB,oFAE5B;IAED,IAAI,uBAAuB,qGAE1B;IAGD,IAAI,aAAa,oGAEhB;IAED,IAAI,WAAW,6FAEd;IAED,IAAI,cAAc,4GAEjB;IAED,IAAI,uBAAuB,gHAE1B;IAED,IAAI,qBAAqB,8GAExB;IAED,IAAI,2BAA2B,oHAE9B;IAGD,IAAI,WAAW,+FAEd;IAED,IAAI,SAAS,yFAEZ;IAED,IAAI,YAAY,4FAEf;IAGD,IAAI,YAAY,kGAEf;IAED,IAAI,UAAU,2FAEb;IAGD,IAAI,YAAY,gGAEf;IAED,IAAI,SAAS,yFAEZ;IAED,IAAI,YAAY,4FAEf;IAED,IAAI,YAAY,4FAEf;IAGD,IAAI,cAAc,oGAEjB;IAED,IAAI,WAAW,6FAEd;IAED,IAAI,cAAc,gGAEjB;IAED,IAAI,cAAc,gGAEjB;IAGD,IAAI,gBAAgB,yGAEnB;IAED,IAAI,cAAc,mGAEjB;IAED,IAAI,iBAAiB,sGAEpB;IAED,IAAI,iBAAiB,sGAEpB;IAGD,IAAI,UAAU,qEAEb;IAGD,IAAI,qBAAqB,wHAExB;IAED,IAAI,sBAAsB,+GAEzB;IAED,IAAI,qBAAqB,6GAExB;IAED,IAAI,sBAAsB,mHAEzB;IAGD,IAAI,sBAAsB,yHAEzB;IAED,IAAI,wBAAwB,2HAE3B;IAED,IAAI,qBAAqB,wHAExB;IAED,IAAI,oBAAoB,+EAEvB;CACD"}

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

@@ -25,7 +25,7 @@ export declare class PrivateAttachments extends PrivateBase {
      * @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)
-     * @param request.version - Optional version number (relative to current version, where 1 = current/latest version, 2 = previous version, 3 = version before that, etc.). If not provided, uses the latest version (same as version: 1).
+     * @param request.version - Optional version number (absolute, 1-based: 1 = first version ever created, 2 = second version, etc. The highest number is the current/latest version). If not provided, uses the latest version.
      * @returns Test case attachments response with array of attachment details
      * @throws {BadRequestError} If the request is invalid
      * @throws {UnauthorizedError} If authentication fails
@@ -51,7 +51,7 @@ export declare class PrivateAttachments extends PrivateBase {
      * @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')
-     * @param request.version - Optional version number (relative to current version, where 1 = current/latest version, 2 = previous version, 3 = version before that, etc.). If not provided, uses the latest version (same as version: 1).
+     * @param request.version - Optional version number (absolute, 1-based: 1 = first version ever created, 2 = second version, etc. The highest number is the current/latest version). If not provided, uses the latest version.
      * @returns Blob containing the attachment file data
      * @throws {BadRequestError} If the request is invalid
      * @throws {UnauthorizedError} If authentication fails

package/dist/groups/Private/PrivateAttachments.js

@@ -20,7 +20,7 @@ export class PrivateAttachments extends PrivateBase {
      * @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)
-     * @param request.version - Optional version number (relative to current version, where 1 = current/latest version, 2 = previous version, 3 = version before that, etc.). If not provided, uses the latest version (same as version: 1).
+     * @param request.version - Optional version number (absolute, 1-based: 1 = first version ever created, 2 = second version, etc. The highest number is the current/latest version). If not provided, uses the latest version.
      * @returns Test case attachments response with array of attachment details
      * @throws {BadRequestError} If the request is invalid
      * @throws {UnauthorizedError} If authentication fails
@@ -114,7 +114,7 @@ export class PrivateAttachments extends PrivateBase {
      * @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')
-     * @param request.version - Optional version number (relative to current version, where 1 = current/latest version, 2 = previous version, 3 = version before that, etc.). If not provided, uses the latest version (same as version: 1).
+     * @param request.version - Optional version number (absolute, 1-based: 1 = first version ever created, 2 = second version, etc. The highest number is the current/latest version). If not provided, uses the latest version.
      * @returns Blob containing the attachment file data
      * @throws {BadRequestError} If the request is invalid
      * @throws {UnauthorizedError} If authentication fails

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

@@ -24,7 +24,7 @@ export declare class PrivateComments extends PrivateBase {
      * @param request - Get comments 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.version - Optional version number (relative to current version, where 1 = current/latest version, 2 = previous version, 3 = version before that, etc.). If not provided, uses the latest version (same as version: 1).
+     * @param request.version - Optional version number (absolute, 1-based: 1 = first version ever created, 2 = second version, etc. The highest number is the current/latest version). If not provided, uses the latest version.
      * @returns Array of comments
      * @throws {BadRequestError} If the request is invalid
      * @throws {UnauthorizedError} If authentication fails

package/dist/groups/Private/PrivateComments.js

@@ -19,7 +19,7 @@ export class PrivateComments extends PrivateBase {
      * @param request - Get comments 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.version - Optional version number (relative to current version, where 1 = current/latest version, 2 = previous version, 3 = version before that, etc.). If not provided, uses the latest version (same as version: 1).
+     * @param request.version - Optional version number (absolute, 1-based: 1 = first version ever created, 2 = second version, etc. The highest number is the current/latest version). If not provided, uses the latest version.
      * @returns Array of comments
      * @throws {BadRequestError} If the request is invalid
      * @throws {UnauthorizedError} If authentication fails

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

@@ -7,6 +7,7 @@
  *
  * ⚠️ WARNING: These methods use private APIs that are not officially supported.
  */
+import type { PrivateApiCredentials, ArchiveConfigRequest, ArchiveConfigResponse } from '../../types';
 import type { ZephyrApiConnection } from '../../index';
 import { PrivateBase } from './PrivateBase';
 import { PrivateCustomFields } from './PrivateCustomFields';
@@ -31,5 +32,51 @@ export declare class PrivateConfig extends PrivateBase {
      */
     readonly DataSets: PrivateDataSets;
     constructor(apiConnection?: ZephyrApiConnection);
+    /**
+     * Archive a config item (Environment or Iteration) using private API
+     *
+     * Archives an Environment or Iteration by setting its `isArchived` flag to `true`.
+     *
+     * ⚠️ WARNING: This uses a private Zephyr API endpoint that is not officially supported.
+     * The endpoint may change or be removed at any time without notice.
+     *
+     * @param credentials - Private API credentials
+     * @param request - Archive config request
+     * @param request.type - Type of config item: 'Environment' or 'Iteration'
+     * @param request.id - Numeric ID of the environment or iteration to archive
+     * @param request.projectId - Jira project ID (numeric, not the project key)
+     * @returns Archive response with the ID of the archived item
+     * @throws {BadRequestError} If the request is invalid
+     * @throws {UnauthorizedError} If authentication fails
+     * @throws {ForbiddenError} If the user doesn't have permission
+     * @throws {NotFoundError} If the environment or iteration is not found
+     * @throws {ServerError} If the server returns an error
+     */
+    archiveConfig(credentials: PrivateApiCredentials, request: ArchiveConfigRequest): Promise<ArchiveConfigResponse>;
+    /**
+     * Unarchive a config item (Environment or Iteration) using private API
+     *
+     * Unarchives an Environment or Iteration by setting its `isArchived` flag to `false`.
+     *
+     * ⚠️ WARNING: This uses a private Zephyr API endpoint that is not officially supported.
+     * The endpoint may change or be removed at any time without notice.
+     *
+     * @param credentials - Private API credentials
+     * @param request - Archive config request (same interface as archive, but sets isArchived to false)
+     * @param request.type - Type of config item: 'Environment' or 'Iteration'
+     * @param request.id - Numeric ID of the environment or iteration to unarchive
+     * @param request.projectId - Jira project ID (numeric, not the project key)
+     * @returns Archive response with the ID of the unarchived item
+     * @throws {BadRequestError} If the request is invalid
+     * @throws {UnauthorizedError} If authentication fails
+     * @throws {ForbiddenError} If the user doesn't have permission
+     * @throws {NotFoundError} If the environment or iteration is not found
+     * @throws {ServerError} If the server returns an error
+     */
+    unarchiveConfig(credentials: PrivateApiCredentials, request: ArchiveConfigRequest): Promise<ArchiveConfigResponse>;
+    /**
+     * Internal method to update archive status
+     */
+    private updateArchiveStatus;
 }
 //# sourceMappingURL=PrivateConfig.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"PrivateConfig.d.ts","sourceRoot":"","sources":["../../../groups/Private/PrivateConfig.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AACvD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEpD,qBAAa,aAAc,SAAQ,WAAW;IAC7C;;OAEG;IACH,SAAgB,YAAY,EAAE,mBAAmB,CAAC;IAElD;;OAEG;IACH,SAAgB,MAAM,EAAE,aAAa,CAAC;IAEtC;;OAEG;IACH,SAAgB,UAAU,EAAE,iBAAiB,CAAC;IAE9C;;OAEG;IACH,SAAgB,QAAQ,EAAE,eAAe,CAAC;gBAE9B,aAAa,CAAC,EAAE,mBAAmB;CAO/C"}
+{"version":3,"file":"PrivateConfig.d.ts","sourceRoot":"","sources":["../../../groups/Private/PrivateConfig.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;;;;GAKG;AAEH,OAAO,KAAK,EACX,qBAAqB,EACrB,oBAAoB,EACpB,qBAAqB,EAErB,MAAM,aAAa,CAAC;AACrB,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AACvD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAUpD,qBAAa,aAAc,SAAQ,WAAW;IAC7C;;OAEG;IACH,SAAgB,YAAY,EAAE,mBAAmB,CAAC;IAElD;;OAEG;IACH,SAAgB,MAAM,EAAE,aAAa,CAAC;IAEtC;;OAEG;IACH,SAAgB,UAAU,EAAE,iBAAiB,CAAC;IAE9C;;OAEG;IACH,SAAgB,QAAQ,EAAE,eAAe,CAAC;gBAE9B,aAAa,CAAC,EAAE,mBAAmB;IAQ/C;;;;;;;;;;;;;;;;;;;OAmBG;IACG,aAAa,CAClB,WAAW,EAAE,qBAAqB,EAClC,OAAO,EAAE,oBAAoB,GAC3B,OAAO,CAAC,qBAAqB,CAAC;IAIjC;;;;;;;;;;;;;;;;;;;OAmBG;IACG,eAAe,CACpB,WAAW,EAAE,qBAAqB,EAClC,OAAO,EAAE,oBAAoB,GAC3B,OAAO,CAAC,qBAAqB,CAAC;IAIjC;;OAEG;YACW,mBAAmB;CAuEjC"}

package/dist/groups/Private/PrivateConfig.js

@@ -6,6 +6,7 @@ import { PrivateCustomFields } from './PrivateCustomFields';
 import { PrivateLabels } from './PrivateLabels';
 import { PrivateIterations } from './PrivateIterations';
 import { PrivateDataSets } from './PrivateDataSets';
+import { BadRequestError, UnauthorizedError, ForbiddenError, NotFoundError, ServerError, UnexpectedError, } from '../../utils';
 export class PrivateConfig extends PrivateBase {
     constructor(apiConnection) {
         super(apiConnection);
@@ -14,4 +15,103 @@ export class PrivateConfig extends PrivateBase {
         this.Iterations = new PrivateIterations(apiConnection);
         this.DataSets = new PrivateDataSets(apiConnection);
     }
+    /**
+     * Archive a config item (Environment or Iteration) using private API
+     *
+     * Archives an Environment or Iteration by setting its `isArchived` flag to `true`.
+     *
+     * ⚠️ WARNING: This uses a private Zephyr API endpoint that is not officially supported.
+     * The endpoint may change or be removed at any time without notice.
+     *
+     * @param credentials - Private API credentials
+     * @param request - Archive config request
+     * @param request.type - Type of config item: 'Environment' or 'Iteration'
+     * @param request.id - Numeric ID of the environment or iteration to archive
+     * @param request.projectId - Jira project ID (numeric, not the project key)
+     * @returns Archive response with the ID of the archived item
+     * @throws {BadRequestError} If the request is invalid
+     * @throws {UnauthorizedError} If authentication fails
+     * @throws {ForbiddenError} If the user doesn't have permission
+     * @throws {NotFoundError} If the environment or iteration is not found
+     * @throws {ServerError} If the server returns an error
+     */
+    async archiveConfig(credentials, request) {
+        return this.updateArchiveStatus(credentials, request, true);
+    }
+    /**
+     * Unarchive a config item (Environment or Iteration) using private API
+     *
+     * Unarchives an Environment or Iteration by setting its `isArchived` flag to `false`.
+     *
+     * ⚠️ WARNING: This uses a private Zephyr API endpoint that is not officially supported.
+     * The endpoint may change or be removed at any time without notice.
+     *
+     * @param credentials - Private API credentials
+     * @param request - Archive config request (same interface as archive, but sets isArchived to false)
+     * @param request.type - Type of config item: 'Environment' or 'Iteration'
+     * @param request.id - Numeric ID of the environment or iteration to unarchive
+     * @param request.projectId - Jira project ID (numeric, not the project key)
+     * @returns Archive response with the ID of the unarchived item
+     * @throws {BadRequestError} If the request is invalid
+     * @throws {UnauthorizedError} If authentication fails
+     * @throws {ForbiddenError} If the user doesn't have permission
+     * @throws {NotFoundError} If the environment or iteration is not found
+     * @throws {ServerError} If the server returns an error
+     */
+    async unarchiveConfig(credentials, request) {
+        return this.updateArchiveStatus(credentials, request, false);
+    }
+    /**
+     * Internal method to update archive status
+     */
+    async updateArchiveStatus(credentials, request, isArchived) {
+        // Get Context JWT
+        const contextJwt = await this.getContextJwt(credentials);
+        // Determine endpoint based on type
+        const endpoint = request.type.toLowerCase(); // 'environment' or 'iteration'
+        const url = `${this.privateApiBaseUrl}/${endpoint}/${request.id}`;
+        const headers = {
+            'Content-Type': 'application/json',
+            authorization: `JWT ${contextJwt}`,
+            'jira-project-id': String(request.projectId),
+        };
+        const requestBody = {
+            id: request.id,
+            isArchived,
+        };
+        try {
+            const response = await fetch(url, {
+                method: 'PUT',
+                headers,
+                body: JSON.stringify(requestBody),
+            });
+            if (!response.ok) {
+                if (response.status === 400) {
+                    throw new BadRequestError(`Invalid request parameters for ${isArchived ? 'archiving' : 'unarchiving'} ${request.type.toLowerCase()}.`);
+                }
+                if (response.status === 401) {
+                    throw new UnauthorizedError('Failed to authenticate. Please check your credentials.');
+                }
+                if (response.status === 403) {
+                    throw new ForbiddenError(`Insufficient permissions to ${isArchived ? 'archive' : 'unarchive'} ${request.type.toLowerCase()}.`);
+                }
+                if (response.status === 404) {
+                    throw new NotFoundError(`${request.type} with ID '${request.id}' not found.`);
+                }
+                throw new ServerError(`Failed to ${isArchived ? 'archive' : 'unarchive'} ${request.type.toLowerCase()}. Status: ${response.status}`, response.status, response.statusText);
+            }
+            return (await response.json());
+        }
+        catch (error) {
+            if (error instanceof BadRequestError ||
+                error instanceof UnauthorizedError ||
+                error instanceof ForbiddenError ||
+                error instanceof NotFoundError ||
+                error instanceof ServerError ||
+                error instanceof UnexpectedError) {
+                throw error;
+            }
+            throw new UnexpectedError(`Unexpected error while ${isArchived ? 'archiving' : 'unarchiving'} ${request.type.toLowerCase()}`, error);
+        }
+    }
 }