@rbaileysr/zephyr-managed-api 1.3.6 → 1.3.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -141,8 +141,8 @@ const apiEU = createZephyrApi(
141
141
  - **Labels**: `getLabels`, `createLabel`
142
142
  - **Iterations**: `getIterations`, `createIteration`
143
143
  - **DataSets**: `getDataSets`, `createDataSet`, `updateDataSet`
144
- - **archiveConfig** - Archive an Environment or Iteration
145
- - **unarchiveConfig** - Unarchive an Environment or Iteration
144
+ - **archiveConfig** - Archive a config item (Environment, Iteration, or Status)
145
+ - **unarchiveConfig** - Unarchive a config item (Environment, Iteration, or Status)
146
146
  - Versions
147
147
  - **createTestCaseVersion** - Create a new test case version
148
148
  - Attachments
@@ -155,6 +155,11 @@ const apiEU = createZephyrApi(
155
155
  - VersionControl
156
156
  - **Test Case (version-specific)**: `getTestCaseIssueLinks`, `getTestCaseWebLinks`, `getTestCaseTestScript`, `getTestCaseTestSteps`
157
157
  - **Test Execution Step**: `getTestExecutionStepIssueLinks`, `createTestExecutionStepIssueLink`
158
+ - ExtendedData (supplements public API with extended data: iterations and versions)
159
+ - **Test Cycle**: `getTestCycleIteration`, `updateTestCycleIteration`
160
+ - **Test Execution**: `getTestExecutionIteration`, `updateTestExecutionIteration`, `getTestExecutionVersion`, `updateTestExecutionVersion`
161
+ - TestCaseArchiving (access archived test cases and archiving operations)
162
+ - **Test Case**: `getArchivedTestCases`, `archiveTestCases`, `unarchiveTestCases`
158
163
 
159
164
  ## Private API Authentication
160
165
 
@@ -274,6 +279,41 @@ const unarchivedIteration = await api.Private.Config.unarchiveConfig(credentials
274
279
  id: 10909775,
275
280
  projectId: 10233
276
281
  });
282
+
283
+ // Archive a test case status
284
+ const archivedTestCaseStatus = await api.Private.Config.archiveConfig(credentials, {
285
+ type: 'TestCaseStatus',
286
+ id: 10952238,
287
+ projectId: 10313
288
+ });
289
+
290
+ // Archive a test plan status
291
+ const archivedTestPlanStatus = await api.Private.Config.archiveConfig(credentials, {
292
+ type: 'TestPlanStatus',
293
+ id: 10952241,
294
+ projectId: 10313
295
+ });
296
+
297
+ // Archive a test cycle status
298
+ const archivedTestCycleStatus = await api.Private.Config.archiveConfig(credentials, {
299
+ type: 'TestCycleStatus',
300
+ id: 10952244,
301
+ projectId: 10313
302
+ });
303
+
304
+ // Archive a test execution status
305
+ const archivedTestExecutionStatus = await api.Private.Config.archiveConfig(credentials, {
306
+ type: 'TestExecutionStatus',
307
+ id: 10952247,
308
+ projectId: 10313
309
+ });
310
+
311
+ // Unarchive any status (same types supported)
312
+ const unarchivedStatus = await api.Private.Config.unarchiveConfig(credentials, {
313
+ type: 'TestCaseStatus',
314
+ id: 10952238,
315
+ projectId: 10313
316
+ });
277
317
  ```
278
318
 
279
319
  ### Example: Create Test Case Version
@@ -355,6 +395,156 @@ const stepLink = await api.Private.VersionControl.createTestExecutionStepIssueLi
355
395
  });
356
396
  ```
357
397
 
398
+ ### Example: Get and Set Extended Data (Supplements Public API)
399
+
400
+ The public API does not support getting or setting iterations for Test Cycles and Test Executions, or Jira version IDs (release versions) for Test Executions. Use the `ExtendedData` sub-group to supplement public API calls with this additional data.
401
+
402
+ ```typescript
403
+ // === Test Cycle Iteration ===
404
+
405
+ // Create test cycle with public API
406
+ const testCycle = await api.TestCycle.createTestCycle({
407
+ projectKey: 'M12',
408
+ name: 'Sprint 1 Testing'
409
+ });
410
+
411
+ // Set iteration using private API (supplements createTestCycle)
412
+ await api.Private.ExtendedData.updateTestCycleIteration(credentials, {
413
+ testCycleKey: testCycle.key,
414
+ projectId: 10313,
415
+ iterationId: 10952254
416
+ });
417
+
418
+ // Get iteration data (supplements getTestCycle)
419
+ const testCycleIteration = await api.Private.ExtendedData.getTestCycleIteration(credentials, {
420
+ testCycleKey: 'M12-R1',
421
+ projectId: 10313
422
+ });
423
+ console.log('Test Cycle Iteration ID:', testCycleIteration.iterationId); // null if not set
424
+
425
+ // === Test Execution Iteration ===
426
+
427
+ // Create test execution with public API (returns void)
428
+ await api.TestExecution.createTestExecution({
429
+ projectKey: 'M12',
430
+ testCaseKey: 'M12-T1',
431
+ testCycleKey: 'M12-R1',
432
+ statusName: 'Pass'
433
+ });
434
+
435
+ // Note: createTestExecution returns no data, so you need to know the execution key
436
+ // or look it up using listTestExecutions() after creation
437
+
438
+ // Set iteration using private API (supplements createTestExecution)
439
+ await api.Private.ExtendedData.updateTestExecutionIteration(credentials, {
440
+ testExecutionKey: 'M12-E1', // Use known key or look up after creation
441
+ projectId: 10313,
442
+ iterationId: 10952254
443
+ });
444
+
445
+ // Get iteration data (supplements getTestExecution)
446
+ const testExecutionIteration = await api.Private.ExtendedData.getTestExecutionIteration(credentials, {
447
+ testExecutionKey: 'M12-E1',
448
+ projectId: 10313
449
+ });
450
+ console.log('Test Execution Iteration ID:', testExecutionIteration.iterationId); // null if not set
451
+
452
+ // Clear iteration by setting to null
453
+ await api.Private.ExtendedData.updateTestCycleIteration(credentials, {
454
+ testCycleKey: 'M12-R1',
455
+ projectId: 10313,
456
+ iterationId: null
457
+ });
458
+
459
+ // === Test Execution Version (Release Version) ===
460
+
461
+ // Create test execution with public API (returns void)
462
+ await api.TestExecution.createTestExecution({
463
+ projectKey: 'M15',
464
+ testCaseKey: 'M15-T3',
465
+ testCycleKey: 'M15-R1',
466
+ statusName: 'Pass'
467
+ });
468
+
469
+ // Note: createTestExecution returns no data, so you need to know the execution key
470
+ // or look it up using listTestExecutions() after creation
471
+
472
+ // Set Jira version ID (release version) using private API (supplements createTestExecution)
473
+ await api.Private.ExtendedData.updateTestExecutionVersion(credentials, {
474
+ testExecutionKey: 'M15-E3', // Use known key or look up after creation
475
+ projectId: 10316,
476
+ jiraVersionId: 10102
477
+ });
478
+
479
+ // Get version data (supplements getTestExecution)
480
+ const testExecutionVersion = await api.Private.ExtendedData.getTestExecutionVersion(credentials, {
481
+ testExecutionKey: 'M15-E3',
482
+ projectId: 10316
483
+ });
484
+ console.log('Jira Version ID:', testExecutionVersion.jiraVersionId); // null if not set
485
+
486
+ // Clear version by setting to null
487
+ await api.Private.ExtendedData.updateTestExecutionVersion(credentials, {
488
+ testExecutionKey: 'M15-E3',
489
+ projectId: 10316,
490
+ jiraVersionId: null
491
+ });
492
+ ```
493
+
494
+ ### Example: Test Case Archiving
495
+
496
+ The public API does not expose the archived flag on test cases. Use the `TestCaseArchiving` sub-group to list archived test cases and perform archiving/unarchiving operations.
497
+
498
+ ```typescript
499
+ // === Get Archived Test Cases ===
500
+
501
+ // Get first page of archived test cases
502
+ const archived = await api.Private.TestCaseArchiving.getArchivedTestCases(credentials, {
503
+ projectId: 10316,
504
+ maxResults: 50,
505
+ startAt: 0
506
+ });
507
+ console.log(`Found ${archived.total} archived test cases`);
508
+ archived.results.forEach(tc => {
509
+ console.log(`- ${tc.key}: ${tc.name}`);
510
+ });
511
+
512
+ // Get archived test cases with custom query filter
513
+ const filtered = await api.Private.TestCaseArchiving.getArchivedTestCases(credentials, {
514
+ projectId: 10316,
515
+ query: "testCase.name CONTAINS 'migration'",
516
+ maxResults: 100
517
+ });
518
+
519
+ // === Archive Test Cases ===
520
+
521
+ // Archive a single test case
522
+ await api.Private.TestCaseArchiving.archiveTestCases(credentials, {
523
+ projectId: 10316,
524
+ testCaseIds: [288004503]
525
+ });
526
+
527
+ // Archive multiple test cases
528
+ await api.Private.TestCaseArchiving.archiveTestCases(credentials, {
529
+ projectId: 10316,
530
+ testCaseIds: [288004503, 288004504, 288004505]
531
+ });
532
+
533
+ // === Unarchive Test Cases ===
534
+
535
+ // Unarchive a single test case
536
+ await api.Private.TestCaseArchiving.unarchiveTestCases(credentials, {
537
+ projectId: 10316,
538
+ testCaseIds: [288004503]
539
+ });
540
+
541
+ // Unarchive multiple test cases
542
+ await api.Private.TestCaseArchiving.unarchiveTestCases(credentials, {
543
+ projectId: 10316,
544
+ testCaseIds: [288004503, 288004504, 288004505]
545
+ });
546
+ ```
547
+
358
548
  **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.
359
549
 
360
550
  **Important Notes:**
@@ -369,7 +559,29 @@ Feel free to drop ideas, suggestions or improvements into our [Community hub](ht
369
559
 
370
560
  ## Changelog
371
561
 
372
- ### 1.3.5
562
+ ### 1.3.8
563
+
564
+ - **Added**: `getTestExecutionVersion()` - Get Jira version ID (release version) for a test execution (supplements public `getTestExecution()`)
565
+ - **Added**: `updateTestExecutionVersion()` - Set/clear Jira version ID for a test execution (supplements public `createTestExecution()`/`updateTestExecution()`)
566
+ - **Added**: New `TestCaseArchiving` sub-group under Private API for test case archiving operations
567
+ - **Added**: `getArchivedTestCases()` - Get paginated list of archived test cases (supplements public API which doesn't expose archived flag)
568
+ - **Added**: `archiveTestCases()` - Archive one or more test cases (bulk operation)
569
+ - **Added**: `unarchiveTestCases()` - Unarchive one or more test cases (bulk operation)
570
+ - **Changed**: Renamed `IterationData` sub-group to `ExtendedData` to better reflect that it handles both iteration and version data
571
+
572
+ ### 1.3.7
573
+
574
+ - **Added**: New `ExtendedData` sub-group under Private API to supplement public API with extended data (iterations and versions)
575
+ - **Added**: `getTestCycleIteration()` - Get iteration for a test cycle (supplements public `getTestCycle()`)
576
+ - **Added**: `updateTestCycleIteration()` - Set/clear iteration for a test cycle (supplements public `createTestCycle()`/`updateTestCycle()`)
577
+ - **Added**: `getTestExecutionIteration()` - Get iteration for a test execution (supplements public `getTestExecution()`)
578
+ - **Added**: `updateTestExecutionIteration()` - Set/clear iteration for a test execution (supplements public `createTestExecution()`/`updateTestExecution()`)
579
+ - **Added**: Support for archiving/unarchiving statuses in `archiveConfig()` and `unarchiveConfig()` methods
580
+ - **Added**: New config types: 'TestCaseStatus', 'TestPlanStatus', 'TestCycleStatus', 'TestExecutionStatus'
581
+ - **Changed**: `archiveConfig()` and `unarchiveConfig()` now support archiving statuses in addition to Environments and Iterations
582
+ - **Fixed**: `createTestExecution()` now correctly returns `Promise<void>` instead of `Promise<CreatedResource>`, matching the actual API response
583
+
584
+ ### 1.3.6
373
585
 
374
586
  - **Fixed**: Corrected return types for `createPriority()`, `createStatus()`, `createEnvironment()`, and `createFolder()` - these methods now correctly return `CreatedResource` (id and self) instead of full entity objects, matching the actual API response
375
587
 
package/dist/README.md CHANGED
@@ -141,8 +141,8 @@ const apiEU = createZephyrApi(
141
141
  - **Labels**: `getLabels`, `createLabel`
142
142
  - **Iterations**: `getIterations`, `createIteration`
143
143
  - **DataSets**: `getDataSets`, `createDataSet`, `updateDataSet`
144
- - **archiveConfig** - Archive an Environment or Iteration
145
- - **unarchiveConfig** - Unarchive an Environment or Iteration
144
+ - **archiveConfig** - Archive a config item (Environment, Iteration, or Status)
145
+ - **unarchiveConfig** - Unarchive a config item (Environment, Iteration, or Status)
146
146
  - Versions
147
147
  - **createTestCaseVersion** - Create a new test case version
148
148
  - Attachments
@@ -155,6 +155,11 @@ const apiEU = createZephyrApi(
155
155
  - VersionControl
156
156
  - **Test Case (version-specific)**: `getTestCaseIssueLinks`, `getTestCaseWebLinks`, `getTestCaseTestScript`, `getTestCaseTestSteps`
157
157
  - **Test Execution Step**: `getTestExecutionStepIssueLinks`, `createTestExecutionStepIssueLink`
158
+ - ExtendedData (supplements public API with extended data: iterations and versions)
159
+ - **Test Cycle**: `getTestCycleIteration`, `updateTestCycleIteration`
160
+ - **Test Execution**: `getTestExecutionIteration`, `updateTestExecutionIteration`, `getTestExecutionVersion`, `updateTestExecutionVersion`
161
+ - TestCaseArchiving (access archived test cases and archiving operations)
162
+ - **Test Case**: `getArchivedTestCases`, `archiveTestCases`, `unarchiveTestCases`
158
163
 
159
164
  ## Private API Authentication
160
165
 
@@ -274,6 +279,41 @@ const unarchivedIteration = await api.Private.Config.unarchiveConfig(credentials
274
279
  id: 10909775,
275
280
  projectId: 10233
276
281
  });
282
+
283
+ // Archive a test case status
284
+ const archivedTestCaseStatus = await api.Private.Config.archiveConfig(credentials, {
285
+ type: 'TestCaseStatus',
286
+ id: 10952238,
287
+ projectId: 10313
288
+ });
289
+
290
+ // Archive a test plan status
291
+ const archivedTestPlanStatus = await api.Private.Config.archiveConfig(credentials, {
292
+ type: 'TestPlanStatus',
293
+ id: 10952241,
294
+ projectId: 10313
295
+ });
296
+
297
+ // Archive a test cycle status
298
+ const archivedTestCycleStatus = await api.Private.Config.archiveConfig(credentials, {
299
+ type: 'TestCycleStatus',
300
+ id: 10952244,
301
+ projectId: 10313
302
+ });
303
+
304
+ // Archive a test execution status
305
+ const archivedTestExecutionStatus = await api.Private.Config.archiveConfig(credentials, {
306
+ type: 'TestExecutionStatus',
307
+ id: 10952247,
308
+ projectId: 10313
309
+ });
310
+
311
+ // Unarchive any status (same types supported)
312
+ const unarchivedStatus = await api.Private.Config.unarchiveConfig(credentials, {
313
+ type: 'TestCaseStatus',
314
+ id: 10952238,
315
+ projectId: 10313
316
+ });
277
317
  ```
278
318
 
279
319
  ### Example: Create Test Case Version
@@ -355,6 +395,156 @@ const stepLink = await api.Private.VersionControl.createTestExecutionStepIssueLi
355
395
  });
356
396
  ```
357
397
 
398
+ ### Example: Get and Set Extended Data (Supplements Public API)
399
+
400
+ The public API does not support getting or setting iterations for Test Cycles and Test Executions, or Jira version IDs (release versions) for Test Executions. Use the `ExtendedData` sub-group to supplement public API calls with this additional data.
401
+
402
+ ```typescript
403
+ // === Test Cycle Iteration ===
404
+
405
+ // Create test cycle with public API
406
+ const testCycle = await api.TestCycle.createTestCycle({
407
+ projectKey: 'M12',
408
+ name: 'Sprint 1 Testing'
409
+ });
410
+
411
+ // Set iteration using private API (supplements createTestCycle)
412
+ await api.Private.ExtendedData.updateTestCycleIteration(credentials, {
413
+ testCycleKey: testCycle.key,
414
+ projectId: 10313,
415
+ iterationId: 10952254
416
+ });
417
+
418
+ // Get iteration data (supplements getTestCycle)
419
+ const testCycleIteration = await api.Private.ExtendedData.getTestCycleIteration(credentials, {
420
+ testCycleKey: 'M12-R1',
421
+ projectId: 10313
422
+ });
423
+ console.log('Test Cycle Iteration ID:', testCycleIteration.iterationId); // null if not set
424
+
425
+ // === Test Execution Iteration ===
426
+
427
+ // Create test execution with public API (returns void)
428
+ await api.TestExecution.createTestExecution({
429
+ projectKey: 'M12',
430
+ testCaseKey: 'M12-T1',
431
+ testCycleKey: 'M12-R1',
432
+ statusName: 'Pass'
433
+ });
434
+
435
+ // Note: createTestExecution returns no data, so you need to know the execution key
436
+ // or look it up using listTestExecutions() after creation
437
+
438
+ // Set iteration using private API (supplements createTestExecution)
439
+ await api.Private.ExtendedData.updateTestExecutionIteration(credentials, {
440
+ testExecutionKey: 'M12-E1', // Use known key or look up after creation
441
+ projectId: 10313,
442
+ iterationId: 10952254
443
+ });
444
+
445
+ // Get iteration data (supplements getTestExecution)
446
+ const testExecutionIteration = await api.Private.ExtendedData.getTestExecutionIteration(credentials, {
447
+ testExecutionKey: 'M12-E1',
448
+ projectId: 10313
449
+ });
450
+ console.log('Test Execution Iteration ID:', testExecutionIteration.iterationId); // null if not set
451
+
452
+ // Clear iteration by setting to null
453
+ await api.Private.ExtendedData.updateTestCycleIteration(credentials, {
454
+ testCycleKey: 'M12-R1',
455
+ projectId: 10313,
456
+ iterationId: null
457
+ });
458
+
459
+ // === Test Execution Version (Release Version) ===
460
+
461
+ // Create test execution with public API (returns void)
462
+ await api.TestExecution.createTestExecution({
463
+ projectKey: 'M15',
464
+ testCaseKey: 'M15-T3',
465
+ testCycleKey: 'M15-R1',
466
+ statusName: 'Pass'
467
+ });
468
+
469
+ // Note: createTestExecution returns no data, so you need to know the execution key
470
+ // or look it up using listTestExecutions() after creation
471
+
472
+ // Set Jira version ID (release version) using private API (supplements createTestExecution)
473
+ await api.Private.ExtendedData.updateTestExecutionVersion(credentials, {
474
+ testExecutionKey: 'M15-E3', // Use known key or look up after creation
475
+ projectId: 10316,
476
+ jiraVersionId: 10102
477
+ });
478
+
479
+ // Get version data (supplements getTestExecution)
480
+ const testExecutionVersion = await api.Private.ExtendedData.getTestExecutionVersion(credentials, {
481
+ testExecutionKey: 'M15-E3',
482
+ projectId: 10316
483
+ });
484
+ console.log('Jira Version ID:', testExecutionVersion.jiraVersionId); // null if not set
485
+
486
+ // Clear version by setting to null
487
+ await api.Private.ExtendedData.updateTestExecutionVersion(credentials, {
488
+ testExecutionKey: 'M15-E3',
489
+ projectId: 10316,
490
+ jiraVersionId: null
491
+ });
492
+ ```
493
+
494
+ ### Example: Test Case Archiving
495
+
496
+ The public API does not expose the archived flag on test cases. Use the `TestCaseArchiving` sub-group to list archived test cases and perform archiving/unarchiving operations.
497
+
498
+ ```typescript
499
+ // === Get Archived Test Cases ===
500
+
501
+ // Get first page of archived test cases
502
+ const archived = await api.Private.TestCaseArchiving.getArchivedTestCases(credentials, {
503
+ projectId: 10316,
504
+ maxResults: 50,
505
+ startAt: 0
506
+ });
507
+ console.log(`Found ${archived.total} archived test cases`);
508
+ archived.results.forEach(tc => {
509
+ console.log(`- ${tc.key}: ${tc.name}`);
510
+ });
511
+
512
+ // Get archived test cases with custom query filter
513
+ const filtered = await api.Private.TestCaseArchiving.getArchivedTestCases(credentials, {
514
+ projectId: 10316,
515
+ query: "testCase.name CONTAINS 'migration'",
516
+ maxResults: 100
517
+ });
518
+
519
+ // === Archive Test Cases ===
520
+
521
+ // Archive a single test case
522
+ await api.Private.TestCaseArchiving.archiveTestCases(credentials, {
523
+ projectId: 10316,
524
+ testCaseIds: [288004503]
525
+ });
526
+
527
+ // Archive multiple test cases
528
+ await api.Private.TestCaseArchiving.archiveTestCases(credentials, {
529
+ projectId: 10316,
530
+ testCaseIds: [288004503, 288004504, 288004505]
531
+ });
532
+
533
+ // === Unarchive Test Cases ===
534
+
535
+ // Unarchive a single test case
536
+ await api.Private.TestCaseArchiving.unarchiveTestCases(credentials, {
537
+ projectId: 10316,
538
+ testCaseIds: [288004503]
539
+ });
540
+
541
+ // Unarchive multiple test cases
542
+ await api.Private.TestCaseArchiving.unarchiveTestCases(credentials, {
543
+ projectId: 10316,
544
+ testCaseIds: [288004503, 288004504, 288004505]
545
+ });
546
+ ```
547
+
358
548
  **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.
359
549
 
360
550
  **Important Notes:**
@@ -369,7 +559,29 @@ Feel free to drop ideas, suggestions or improvements into our [Community hub](ht
369
559
 
370
560
  ## Changelog
371
561
 
372
- ### 1.3.5
562
+ ### 1.3.8
563
+
564
+ - **Added**: `getTestExecutionVersion()` - Get Jira version ID (release version) for a test execution (supplements public `getTestExecution()`)
565
+ - **Added**: `updateTestExecutionVersion()` - Set/clear Jira version ID for a test execution (supplements public `createTestExecution()`/`updateTestExecution()`)
566
+ - **Added**: New `TestCaseArchiving` sub-group under Private API for test case archiving operations
567
+ - **Added**: `getArchivedTestCases()` - Get paginated list of archived test cases (supplements public API which doesn't expose archived flag)
568
+ - **Added**: `archiveTestCases()` - Archive one or more test cases (bulk operation)
569
+ - **Added**: `unarchiveTestCases()` - Unarchive one or more test cases (bulk operation)
570
+ - **Changed**: Renamed `IterationData` sub-group to `ExtendedData` to better reflect that it handles both iteration and version data
571
+
572
+ ### 1.3.7
573
+
574
+ - **Added**: New `ExtendedData` sub-group under Private API to supplement public API with extended data (iterations and versions)
575
+ - **Added**: `getTestCycleIteration()` - Get iteration for a test cycle (supplements public `getTestCycle()`)
576
+ - **Added**: `updateTestCycleIteration()` - Set/clear iteration for a test cycle (supplements public `createTestCycle()`/`updateTestCycle()`)
577
+ - **Added**: `getTestExecutionIteration()` - Get iteration for a test execution (supplements public `getTestExecution()`)
578
+ - **Added**: `updateTestExecutionIteration()` - Set/clear iteration for a test execution (supplements public `createTestExecution()`/`updateTestExecution()`)
579
+ - **Added**: Support for archiving/unarchiving statuses in `archiveConfig()` and `unarchiveConfig()` methods
580
+ - **Added**: New config types: 'TestCaseStatus', 'TestPlanStatus', 'TestCycleStatus', 'TestExecutionStatus'
581
+ - **Changed**: `archiveConfig()` and `unarchiveConfig()` now support archiving statuses in addition to Environments and Iterations
582
+ - **Fixed**: `createTestExecution()` now correctly returns `Promise<void>` instead of `Promise<CreatedResource>`, matching the actual API response
583
+
584
+ ### 1.3.6
373
585
 
374
586
  - **Fixed**: Corrected return types for `createPriority()`, `createStatus()`, `createEnvironment()`, and `createFolder()` - these methods now correctly return `CreatedResource` (id and self) instead of full entity objects, matching the actual API response
375
587
 
@@ -50,7 +50,7 @@ export declare class AllGroup {
50
50
  get listTestExecutions(): (options?: import("../types").ListTestExecutionsOptions) => Promise<import("../types").TestExecutionList>;
51
51
  get listTestExecutionsNextgen(): (options?: import("../types").ListTestExecutionsNextgenOptions) => Promise<import("../types").CursorPagedTestExecutionList>;
52
52
  get getTestExecution(): (options: import("../types").GetTestExecutionOptions) => Promise<import("../types").TestExecution>;
53
- get createTestExecution(): (request: import("../types").CreateTestExecutionRequest) => Promise<import("../types").CreatedResource>;
53
+ get createTestExecution(): (request: import("../types").CreateTestExecutionRequest) => Promise<void>;
54
54
  get updateTestExecution(): (request: import("../types").UpdateTestExecutionRequest) => Promise<void>;
55
55
  get listTestExecutionLinks(): (testExecutionIdOrKey: string | number) => Promise<import("../types").TestExecutionLinkList>;
56
56
  get createTestExecutionIssueLink(): (request: import("../types").CreateTestExecutionIssueLinkRequest) => Promise<import("../types").CreatedResource>;
@@ -1 +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;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,qGAEf;IAGD,IAAI,YAAY,kGAEf;IAED,IAAI,UAAU,2FAEb;IAGD,IAAI,YAAY,gGAEf;IAED,IAAI,SAAS,yFAEZ;IAED,IAAI,YAAY,qGAEf;IAED,IAAI,YAAY,4FAEf;IAGD,IAAI,cAAc,oGAEjB;IAED,IAAI,WAAW,6FAEd;IAED,IAAI,cAAc,uGAEjB;IAED,IAAI,cAAc,gGAEjB;IAGD,IAAI,gBAAgB,yGAEnB;IAED,IAAI,cAAc,mGAEjB;IAED,IAAI,iBAAiB,0GAEpB;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"}
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;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,8EAEtB;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,qGAEf;IAGD,IAAI,YAAY,kGAEf;IAED,IAAI,UAAU,2FAEb;IAGD,IAAI,YAAY,gGAEf;IAED,IAAI,SAAS,yFAEZ;IAED,IAAI,YAAY,qGAEf;IAED,IAAI,YAAY,4FAEf;IAGD,IAAI,cAAc,oGAEjB;IAED,IAAI,WAAW,6FAEd;IAED,IAAI,cAAc,uGAEjB;IAED,IAAI,cAAc,gGAEjB;IAGD,IAAI,gBAAgB,yGAEnB;IAED,IAAI,cAAc,mGAEjB;IAED,IAAI,iBAAiB,0GAEpB;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"}
@@ -33,44 +33,60 @@ export declare class PrivateConfig extends PrivateBase {
33
33
  readonly DataSets: PrivateDataSets;
34
34
  constructor(apiConnection?: ZephyrApiConnection);
35
35
  /**
36
- * Archive a config item (Environment or Iteration) using private API
36
+ * Archive a config item using private API
37
37
  *
38
- * Archives an Environment or Iteration by setting its `isArchived` flag to `true`.
38
+ * Archives a config item (Environment, Iteration, or Status) by setting its `isArchived` flag to `true`.
39
+ *
40
+ * Supported config types:
41
+ * - 'Environment' - Archive an environment
42
+ * - 'Iteration' - Archive an iteration
43
+ * - 'TestCaseStatus' - Archive a test case status
44
+ * - 'TestPlanStatus' - Archive a test plan status
45
+ * - 'TestCycleStatus' - Archive a test cycle status
46
+ * - 'TestExecutionStatus' - Archive a test execution status
39
47
  *
40
48
  * ⚠️ WARNING: This uses a private Zephyr API endpoint that is not officially supported.
41
49
  * The endpoint may change or be removed at any time without notice.
42
50
  *
43
51
  * @param credentials - Private API credentials
44
52
  * @param request - Archive config request
45
- * @param request.type - Type of config item: 'Environment' or 'Iteration'
46
- * @param request.id - Numeric ID of the environment or iteration to archive
53
+ * @param request.type - Type of config item: 'Environment', 'Iteration', 'TestCaseStatus', 'TestPlanStatus', 'TestCycleStatus', or 'TestExecutionStatus'
54
+ * @param request.id - Numeric ID of the config item to archive
47
55
  * @param request.projectId - Jira project ID (numeric, not the project key)
48
56
  * @returns Archive response with the ID of the archived item
49
57
  * @throws {BadRequestError} If the request is invalid
50
58
  * @throws {UnauthorizedError} If authentication fails
51
59
  * @throws {ForbiddenError} If the user doesn't have permission
52
- * @throws {NotFoundError} If the environment or iteration is not found
60
+ * @throws {NotFoundError} If the config item is not found
53
61
  * @throws {ServerError} If the server returns an error
54
62
  */
55
63
  archiveConfig(credentials: PrivateApiCredentials, request: ArchiveConfigRequest): Promise<ArchiveConfigResponse>;
56
64
  /**
57
- * Unarchive a config item (Environment or Iteration) using private API
65
+ * Unarchive a config item using private API
66
+ *
67
+ * Unarchives a config item (Environment, Iteration, or Status) by setting its `isArchived` flag to `false`.
58
68
  *
59
- * Unarchives an Environment or Iteration by setting its `isArchived` flag to `false`.
69
+ * Supported config types:
70
+ * - 'Environment' - Unarchive an environment
71
+ * - 'Iteration' - Unarchive an iteration
72
+ * - 'TestCaseStatus' - Unarchive a test case status
73
+ * - 'TestPlanStatus' - Unarchive a test plan status
74
+ * - 'TestCycleStatus' - Unarchive a test cycle status
75
+ * - 'TestExecutionStatus' - Unarchive a test execution status
60
76
  *
61
77
  * ⚠️ WARNING: This uses a private Zephyr API endpoint that is not officially supported.
62
78
  * The endpoint may change or be removed at any time without notice.
63
79
  *
64
80
  * @param credentials - Private API credentials
65
81
  * @param request - Archive config request (same interface as archive, but sets isArchived to false)
66
- * @param request.type - Type of config item: 'Environment' or 'Iteration'
67
- * @param request.id - Numeric ID of the environment or iteration to unarchive
82
+ * @param request.type - Type of config item: 'Environment', 'Iteration', 'TestCaseStatus', 'TestPlanStatus', 'TestCycleStatus', or 'TestExecutionStatus'
83
+ * @param request.id - Numeric ID of the config item to unarchive
68
84
  * @param request.projectId - Jira project ID (numeric, not the project key)
69
85
  * @returns Archive response with the ID of the unarchived item
70
86
  * @throws {BadRequestError} If the request is invalid
71
87
  * @throws {UnauthorizedError} If authentication fails
72
88
  * @throws {ForbiddenError} If the user doesn't have permission
73
- * @throws {NotFoundError} If the environment or iteration is not found
89
+ * @throws {NotFoundError} If the config item is not found
74
90
  * @throws {ServerError} If the server returns an error
75
91
  */
76
92
  unarchiveConfig(credentials: PrivateApiCredentials, request: ArchiveConfigRequest): Promise<ArchiveConfigResponse>;
@@ -1 +1 @@
1
- {"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"}
1
+ {"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;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACG,aAAa,CAClB,WAAW,EAAE,qBAAqB,EAClC,OAAO,EAAE,oBAAoB,GAC3B,OAAO,CAAC,qBAAqB,CAAC;IAIjC;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACG,eAAe,CACpB,WAAW,EAAE,qBAAqB,EAClC,OAAO,EAAE,oBAAoB,GAC3B,OAAO,CAAC,qBAAqB,CAAC;IAIjC;;OAEG;YACW,mBAAmB;CAgFjC"}