@rbaileysr/zephyr-managed-api 1.3.0 → 1.3.1

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.
Files changed (46) hide show
  1. package/README.md +109 -18
  2. package/dist/README.md +109 -18
  3. package/dist/groups/All.d.ts.map +1 -1
  4. package/dist/groups/Automation.d.ts +4 -4
  5. package/dist/groups/Automation.js +4 -4
  6. package/dist/groups/Environment.d.ts +4 -4
  7. package/dist/groups/Environment.js +4 -4
  8. package/dist/groups/Folder.d.ts +3 -3
  9. package/dist/groups/Folder.js +3 -3
  10. package/dist/groups/IssueLink.d.ts +4 -4
  11. package/dist/groups/IssueLink.js +4 -4
  12. package/dist/groups/Link.d.ts +1 -1
  13. package/dist/groups/Link.js +1 -1
  14. package/dist/groups/Priority.d.ts +4 -4
  15. package/dist/groups/Priority.js +4 -4
  16. package/dist/groups/Private/PrivateConfig.d.ts +35 -0
  17. package/dist/groups/Private/PrivateConfig.d.ts.map +1 -0
  18. package/dist/groups/Private/PrivateConfig.js +17 -0
  19. package/dist/groups/Private/PrivateDataSets.d.ts +67 -0
  20. package/dist/groups/Private/PrivateDataSets.d.ts.map +1 -0
  21. package/dist/groups/Private/PrivateDataSets.js +192 -0
  22. package/dist/groups/Private/PrivateIterations.d.ts +46 -0
  23. package/dist/groups/Private/PrivateIterations.d.ts.map +1 -0
  24. package/dist/groups/Private/PrivateIterations.js +127 -0
  25. package/dist/groups/Private/PrivateLabels.d.ts +46 -0
  26. package/dist/groups/Private/PrivateLabels.d.ts.map +1 -0
  27. package/dist/groups/Private/PrivateLabels.js +127 -0
  28. package/dist/groups/Private.d.ts +3 -3
  29. package/dist/groups/Private.d.ts.map +1 -1
  30. package/dist/groups/Private.js +2 -2
  31. package/dist/groups/Project.d.ts +2 -2
  32. package/dist/groups/Project.js +2 -2
  33. package/dist/groups/Status.d.ts +4 -4
  34. package/dist/groups/Status.js +4 -4
  35. package/dist/groups/TestCase.d.ts +14 -14
  36. package/dist/groups/TestCase.js +14 -14
  37. package/dist/groups/TestCycle.d.ts +7 -7
  38. package/dist/groups/TestCycle.js +7 -7
  39. package/dist/groups/TestExecution.d.ts +10 -10
  40. package/dist/groups/TestExecution.js +10 -10
  41. package/dist/groups/TestPlan.d.ts +6 -6
  42. package/dist/groups/TestPlan.js +6 -6
  43. package/dist/package.json +1 -1
  44. package/dist/types.d.ts +136 -0
  45. package/dist/types.d.ts.map +1 -1
  46. package/package.json +1 -1
package/README.md CHANGED
@@ -16,16 +16,16 @@ npm install @rbaileysr/zephyr-managed-api
16
16
  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:
17
17
 
18
18
  **Using API Connection (recommended for ScriptRunner Connect):**
19
- ```typescript
19
+ ```typescript
20
20
  import { createZephyrApi } from '@rbaileysr/zephyr-managed-api';
21
- import ZephyrApiConnection from '../api/zephyr';
21
+ import ZephyrApiConnection from '../api/zephyr';
22
22
 
23
- // Base URL is configured in the Generic Connector
23
+ // Base URL is configured in the Generic Connector
24
24
  const api = createZephyrApi(ZephyrApiConnection);
25
25
  ```
26
26
 
27
27
  **Using OAuth Token:**
28
- ```typescript
28
+ ```typescript
29
29
  import { createZephyrApi } from '@rbaileysr/zephyr-managed-api';
30
30
 
31
31
  // US region
@@ -120,16 +120,16 @@ const apiEU = createZephyrApi(
120
120
  - [createJUnitExecutions](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Automation/operation/createJUnitExecutions)
121
121
  - [retrieveBDDTestCases](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Automation/operation/retrieveBDDTestCases)
122
122
  - Private ⚠️
123
- > **⚠️ WARNING: Private API Methods**
124
- >
125
- > The following methods use Zephyr's private/unofficial API endpoints that are:
126
- > - **Not officially supported** by SmartBear
127
- > - **Not part of the public API documentation**
128
- > - **Subject to change at any time** without notice
129
- > - **Not covered by Standard Support**
130
- >
131
- > Use these methods at your own risk. They may break with future Zephyr updates.
132
-
123
+ > **⚠️ WARNING: Private API Methods**
124
+ >
125
+ > The following methods use Zephyr's private/unofficial API endpoints that are:
126
+ > - **Not officially supported** by SmartBear
127
+ > - **Not part of the public API documentation**
128
+ > - **Subject to change at any time** without notice
129
+ > - **Not covered by Standard Support**
130
+ >
131
+ > Use these methods at your own risk. They may break with future Zephyr updates.
132
+
133
133
  - Authentication
134
134
  - **getContextJwt** - Get Jira Context JWT token (required for all private API calls)
135
135
  - Comments
@@ -139,9 +139,20 @@ const apiEU = createZephyrApi(
139
139
  - **createTestCaseComment** - Create a comment on a test case
140
140
  - **createTestCycleComment** - Create a comment on a test cycle
141
141
  - **createTestPlanComment** - Create a comment on a test plan
142
- - CustomFields
143
- - **createCustomField** - Create custom fields for test cases, test plans, test runs, test steps, or test executions
144
- - **getCustomFields** - Get all custom fields for test cases, test plans, test runs, test steps, or test executions
142
+ - Config
143
+ - **CustomFields**
144
+ - **createCustomField** - Create custom fields for test cases, test plans, test runs, test steps, or test executions
145
+ - **getCustomFields** - Get all custom fields for test cases, test plans, test runs, test steps, or test executions
146
+ - **Labels**
147
+ - **getLabels** - Get all labels for a project
148
+ - **createLabel** - Create a new label
149
+ - **Iterations**
150
+ - **getIterations** - Get all iterations for a project
151
+ - **createIteration** - Create a new iteration
152
+ - **DataSets**
153
+ - **getDataSets** - Get all data sets for a project
154
+ - **createDataSet** - Create a new data set
155
+ - **updateDataSet** - Update a data set (add items/options)
145
156
  - Versions
146
157
  - **createTestCaseVersion** - Create a new test case version
147
158
  - Attachments
@@ -193,7 +204,7 @@ const contextJwt = await api.Private.Authentication.getContextJwt(credentials);
193
204
 
194
205
  ```typescript
195
206
  // Create a custom field for test cases
196
- const customField = await api.Private.CustomFields.createCustomField(
207
+ const customField = await api.Private.Config.CustomFields.createCustomField(
197
208
  credentials,
198
209
  'TEST_CASE',
199
210
  {
@@ -208,6 +219,77 @@ const customField = await api.Private.CustomFields.createCustomField(
208
219
  );
209
220
  ```
210
221
 
222
+ ### Example: Create Label
223
+
224
+ ```typescript
225
+ // Create a new label
226
+ await api.Private.Config.Labels.createLabel(credentials, {
227
+ projectId: 10233,
228
+ name: 'automated',
229
+ color: '#FFFFFF',
230
+ index: 0,
231
+ items: []
232
+ });
233
+
234
+ // Get all labels
235
+ const labels = await api.Private.Config.Labels.getLabels(credentials, {
236
+ projectId: 10233
237
+ });
238
+ ```
239
+
240
+ ### Example: Create Iteration
241
+
242
+ ```typescript
243
+ // Create a new iteration
244
+ const iteration = await api.Private.Config.Iterations.createIteration(credentials, {
245
+ projectId: 10233,
246
+ name: 'Sprint 1',
247
+ description: 'First sprint of Q1',
248
+ color: '#FFFFFF',
249
+ index: 0,
250
+ items: []
251
+ });
252
+
253
+ // Get all iterations
254
+ const iterations = await api.Private.Config.Iterations.getIterations(credentials, {
255
+ projectId: 10233
256
+ });
257
+ ```
258
+
259
+ ### Example: Create and Update Data Set
260
+
261
+ ```typescript
262
+ // Create a new data set (empty)
263
+ const dataSet = await api.Private.Config.DataSets.createDataSet(credentials, {
264
+ projectId: 10233,
265
+ name: 'Environment',
266
+ color: '#FFFFFF',
267
+ index: 0,
268
+ items: []
269
+ });
270
+
271
+ // Add items/options to the data set
272
+ const updatedDataSet = await api.Private.Config.DataSets.updateDataSet(
273
+ credentials,
274
+ dataSet.id,
275
+ {
276
+ id: dataSet.id,
277
+ name: 'Environment',
278
+ projectId: 10233,
279
+ items: [
280
+ { name: 'Production', index: 0, archived: false },
281
+ { name: 'Staging', index: 1, archived: false },
282
+ { name: 'Development', index: 2, archived: false }
283
+ ]
284
+ }
285
+ );
286
+
287
+ // Get all data sets
288
+ const dataSets = await api.Private.Config.DataSets.getDataSets(credentials, {
289
+ projectId: 10233
290
+ });
291
+ ```
292
+
211
293
  ### Example: Create Test Case Version
212
294
 
213
295
  ```typescript
@@ -251,6 +333,15 @@ Feel free to drop ideas, suggestions or improvements into our [Community hub](ht
251
333
 
252
334
  ## Changelog
253
335
 
336
+ ### 1.3.1
337
+
338
+ - **Added**: New Config sub-group under Private API for configuration operations
339
+ - **Added**: Labels endpoints (getLabels, createLabel)
340
+ - **Added**: Iterations endpoints (getIterations, createIteration)
341
+ - **Added**: DataSets endpoints (getDataSets, createDataSet, updateDataSet)
342
+ - **Changed**: CustomFields moved to Private.Config.CustomFields (backward compatible path removed)
343
+ - **Changed**: Private API now organized as: Authentication, Comments, Config (CustomFields, Labels, Iterations, DataSets), Versions, Attachments
344
+
254
345
  ### 1.3.0
255
346
 
256
347
  - **Tested**: All API functions from the Private API have been tested and verified - 16/12/2025
package/dist/README.md CHANGED
@@ -16,16 +16,16 @@ npm install @rbaileysr/zephyr-managed-api
16
16
  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:
17
17
 
18
18
  **Using API Connection (recommended for ScriptRunner Connect):**
19
- ```typescript
19
+ ```typescript
20
20
  import { createZephyrApi } from '@rbaileysr/zephyr-managed-api';
21
- import ZephyrApiConnection from '../api/zephyr';
21
+ import ZephyrApiConnection from '../api/zephyr';
22
22
 
23
- // Base URL is configured in the Generic Connector
23
+ // Base URL is configured in the Generic Connector
24
24
  const api = createZephyrApi(ZephyrApiConnection);
25
25
  ```
26
26
 
27
27
  **Using OAuth Token:**
28
- ```typescript
28
+ ```typescript
29
29
  import { createZephyrApi } from '@rbaileysr/zephyr-managed-api';
30
30
 
31
31
  // US region
@@ -120,16 +120,16 @@ const apiEU = createZephyrApi(
120
120
  - [createJUnitExecutions](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Automation/operation/createJUnitExecutions)
121
121
  - [retrieveBDDTestCases](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Automation/operation/retrieveBDDTestCases)
122
122
  - Private ⚠️
123
- > **⚠️ WARNING: Private API Methods**
124
- >
125
- > The following methods use Zephyr's private/unofficial API endpoints that are:
126
- > - **Not officially supported** by SmartBear
127
- > - **Not part of the public API documentation**
128
- > - **Subject to change at any time** without notice
129
- > - **Not covered by Standard Support**
130
- >
131
- > Use these methods at your own risk. They may break with future Zephyr updates.
132
-
123
+ > **⚠️ WARNING: Private API Methods**
124
+ >
125
+ > The following methods use Zephyr's private/unofficial API endpoints that are:
126
+ > - **Not officially supported** by SmartBear
127
+ > - **Not part of the public API documentation**
128
+ > - **Subject to change at any time** without notice
129
+ > - **Not covered by Standard Support**
130
+ >
131
+ > Use these methods at your own risk. They may break with future Zephyr updates.
132
+
133
133
  - Authentication
134
134
  - **getContextJwt** - Get Jira Context JWT token (required for all private API calls)
135
135
  - Comments
@@ -139,9 +139,20 @@ const apiEU = createZephyrApi(
139
139
  - **createTestCaseComment** - Create a comment on a test case
140
140
  - **createTestCycleComment** - Create a comment on a test cycle
141
141
  - **createTestPlanComment** - Create a comment on a test plan
142
- - CustomFields
143
- - **createCustomField** - Create custom fields for test cases, test plans, test runs, test steps, or test executions
144
- - **getCustomFields** - Get all custom fields for test cases, test plans, test runs, test steps, or test executions
142
+ - Config
143
+ - **CustomFields**
144
+ - **createCustomField** - Create custom fields for test cases, test plans, test runs, test steps, or test executions
145
+ - **getCustomFields** - Get all custom fields for test cases, test plans, test runs, test steps, or test executions
146
+ - **Labels**
147
+ - **getLabels** - Get all labels for a project
148
+ - **createLabel** - Create a new label
149
+ - **Iterations**
150
+ - **getIterations** - Get all iterations for a project
151
+ - **createIteration** - Create a new iteration
152
+ - **DataSets**
153
+ - **getDataSets** - Get all data sets for a project
154
+ - **createDataSet** - Create a new data set
155
+ - **updateDataSet** - Update a data set (add items/options)
145
156
  - Versions
146
157
  - **createTestCaseVersion** - Create a new test case version
147
158
  - Attachments
@@ -193,7 +204,7 @@ const contextJwt = await api.Private.Authentication.getContextJwt(credentials);
193
204
 
194
205
  ```typescript
195
206
  // Create a custom field for test cases
196
- const customField = await api.Private.CustomFields.createCustomField(
207
+ const customField = await api.Private.Config.CustomFields.createCustomField(
197
208
  credentials,
198
209
  'TEST_CASE',
199
210
  {
@@ -208,6 +219,77 @@ const customField = await api.Private.CustomFields.createCustomField(
208
219
  );
209
220
  ```
210
221
 
222
+ ### Example: Create Label
223
+
224
+ ```typescript
225
+ // Create a new label
226
+ await api.Private.Config.Labels.createLabel(credentials, {
227
+ projectId: 10233,
228
+ name: 'automated',
229
+ color: '#FFFFFF',
230
+ index: 0,
231
+ items: []
232
+ });
233
+
234
+ // Get all labels
235
+ const labels = await api.Private.Config.Labels.getLabels(credentials, {
236
+ projectId: 10233
237
+ });
238
+ ```
239
+
240
+ ### Example: Create Iteration
241
+
242
+ ```typescript
243
+ // Create a new iteration
244
+ const iteration = await api.Private.Config.Iterations.createIteration(credentials, {
245
+ projectId: 10233,
246
+ name: 'Sprint 1',
247
+ description: 'First sprint of Q1',
248
+ color: '#FFFFFF',
249
+ index: 0,
250
+ items: []
251
+ });
252
+
253
+ // Get all iterations
254
+ const iterations = await api.Private.Config.Iterations.getIterations(credentials, {
255
+ projectId: 10233
256
+ });
257
+ ```
258
+
259
+ ### Example: Create and Update Data Set
260
+
261
+ ```typescript
262
+ // Create a new data set (empty)
263
+ const dataSet = await api.Private.Config.DataSets.createDataSet(credentials, {
264
+ projectId: 10233,
265
+ name: 'Environment',
266
+ color: '#FFFFFF',
267
+ index: 0,
268
+ items: []
269
+ });
270
+
271
+ // Add items/options to the data set
272
+ const updatedDataSet = await api.Private.Config.DataSets.updateDataSet(
273
+ credentials,
274
+ dataSet.id,
275
+ {
276
+ id: dataSet.id,
277
+ name: 'Environment',
278
+ projectId: 10233,
279
+ items: [
280
+ { name: 'Production', index: 0, archived: false },
281
+ { name: 'Staging', index: 1, archived: false },
282
+ { name: 'Development', index: 2, archived: false }
283
+ ]
284
+ }
285
+ );
286
+
287
+ // Get all data sets
288
+ const dataSets = await api.Private.Config.DataSets.getDataSets(credentials, {
289
+ projectId: 10233
290
+ });
291
+ ```
292
+
211
293
  ### Example: Create Test Case Version
212
294
 
213
295
  ```typescript
@@ -251,6 +333,15 @@ Feel free to drop ideas, suggestions or improvements into our [Community hub](ht
251
333
 
252
334
  ## Changelog
253
335
 
336
+ ### 1.3.1
337
+
338
+ - **Added**: New Config sub-group under Private API for configuration operations
339
+ - **Added**: Labels endpoints (getLabels, createLabel)
340
+ - **Added**: Iterations endpoints (getIterations, createIteration)
341
+ - **Added**: DataSets endpoints (getDataSets, createDataSet, updateDataSet)
342
+ - **Changed**: CustomFields moved to Private.Config.CustomFields (backward compatible path removed)
343
+ - **Changed**: Private API now organized as: Authentication, Comments, Config (CustomFields, Labels, Iterations, DataSets), Versions, Attachments
344
+
254
345
  ### 1.3.0
255
346
 
256
347
  - **Tested**: All API functions from the Private API have been tested and verified - 16/12/2025
@@ -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;kBAuN0yN,CAAC;eAAiB,CAAC;oDArNp1N;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"}
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"}
@@ -24,7 +24,7 @@ export declare class AutomationGroup {
24
24
  * @param request.body.testCycle - Test cycle customization data as JSON (optional)
25
25
  * @returns Automation result with created test cycle information
26
26
  *
27
- * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/createCustomExecutions Official API Documentation}
27
+ * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Automation/operation/createCustomExecutions Official API Documentation}
28
28
  */
29
29
  createCustomExecutions(request: CreateAutomationExecutionCustomRequest): Promise<AutomationResult>;
30
30
  /**
@@ -41,7 +41,7 @@ export declare class AutomationGroup {
41
41
  * @param request.body.testCycle - Test cycle customization data as JSON (optional)
42
42
  * @returns Automation result with created test cycle information
43
43
  *
44
- * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/createCucumberExecutions Official API Documentation}
44
+ * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Automation/operation/createCucumberExecutions Official API Documentation}
45
45
  */
46
46
  createCucumberExecutions(request: CreateAutomationExecutionCucumberRequest): Promise<AutomationResult>;
47
47
  /**
@@ -58,7 +58,7 @@ export declare class AutomationGroup {
58
58
  * @param request.body.testCycle - Test cycle customization data as JSON (optional)
59
59
  * @returns Automation result with created test cycle information
60
60
  *
61
- * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/createJUnitExecutions Official API Documentation}
61
+ * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Automation/operation/createJUnitExecutions Official API Documentation}
62
62
  */
63
63
  createJUnitExecutions(request: CreateAutomationExecutionJunitRequest): Promise<AutomationResult>;
64
64
  /**
@@ -71,7 +71,7 @@ export declare class AutomationGroup {
71
71
  * @param options.projectKey - Filter by Jira project key (optional)
72
72
  * @returns Blob containing the zip file with Cucumber Feature Files
73
73
  *
74
- * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/retrieveBDDTestCases Official API Documentation}
74
+ * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Automation/operation/retrieveBDDTestCases Official API Documentation}
75
75
  */
76
76
  retrieveBDDTestCases(options: RetrieveBDDTestCasesOptions): Promise<Blob>;
77
77
  }
@@ -20,7 +20,7 @@ export class AutomationGroup {
20
20
  * @param request.body.testCycle - Test cycle customization data as JSON (optional)
21
21
  * @returns Automation result with created test cycle information
22
22
  *
23
- * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/createCustomExecutions Official API Documentation}
23
+ * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Automation/operation/createCustomExecutions Official API Documentation}
24
24
  */
25
25
  async createCustomExecutions(request) {
26
26
  const params = [];
@@ -51,7 +51,7 @@ export class AutomationGroup {
51
51
  * @param request.body.testCycle - Test cycle customization data as JSON (optional)
52
52
  * @returns Automation result with created test cycle information
53
53
  *
54
- * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/createCucumberExecutions Official API Documentation}
54
+ * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Automation/operation/createCucumberExecutions Official API Documentation}
55
55
  */
56
56
  async createCucumberExecutions(request) {
57
57
  const params = [];
@@ -82,7 +82,7 @@ export class AutomationGroup {
82
82
  * @param request.body.testCycle - Test cycle customization data as JSON (optional)
83
83
  * @returns Automation result with created test cycle information
84
84
  *
85
- * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/createJUnitExecutions Official API Documentation}
85
+ * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Automation/operation/createJUnitExecutions Official API Documentation}
86
86
  */
87
87
  async createJUnitExecutions(request) {
88
88
  const params = [];
@@ -109,7 +109,7 @@ export class AutomationGroup {
109
109
  * @param options.projectKey - Filter by Jira project key (optional)
110
110
  * @returns Blob containing the zip file with Cucumber Feature Files
111
111
  *
112
- * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/retrieveBDDTestCases Official API Documentation}
112
+ * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Automation/operation/retrieveBDDTestCases Official API Documentation}
113
113
  */
114
114
  async retrieveBDDTestCases(options) {
115
115
  const params = [];
@@ -21,7 +21,7 @@ export declare class EnvironmentGroup {
21
21
  * @param options.startAt - Zero-indexed starting position (must be multiple of maxResults)
22
22
  * @returns Paginated list of environments with metadata (total, isLast, etc.)
23
23
  *
24
- * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/listEnvironments Official API Documentation}
24
+ * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Environments/operation/listEnvironments Official API Documentation}
25
25
  */
26
26
  listEnvironments(options: ListEnvironmentsOptions): Promise<EnvironmentList>;
27
27
  /**
@@ -33,7 +33,7 @@ export declare class EnvironmentGroup {
33
33
  * @param options.environmentId - The environment ID
34
34
  * @returns Environment object with all fields
35
35
  *
36
- * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/getEnvironment Official API Documentation}
36
+ * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Environments/operation/getEnvironment Official API Documentation}
37
37
  */
38
38
  getEnvironment(options: GetEnvironmentOptions): Promise<Environment>;
39
39
  /**
@@ -50,7 +50,7 @@ export declare class EnvironmentGroup {
50
50
  * @param request.body.index - Display order index (optional)
51
51
  * @returns Created environment object
52
52
  *
53
- * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/createEnvironment Official API Documentation}
53
+ * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Environments/operation/createEnvironment Official API Documentation}
54
54
  */
55
55
  createEnvironment(request: CreateEnvironmentRequest): Promise<Environment>;
56
56
  /**
@@ -69,7 +69,7 @@ export declare class EnvironmentGroup {
69
69
  * @param request.body.description - Environment description (optional)
70
70
  * @returns Updated environment object
71
71
  *
72
- * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/updateEnvironment Official API Documentation}
72
+ * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Environments/operation/updateEnvironment Official API Documentation}
73
73
  */
74
74
  updateEnvironment(request: UpdateEnvironmentRequest): Promise<Environment>;
75
75
  }
@@ -17,7 +17,7 @@ export class EnvironmentGroup {
17
17
  * @param options.startAt - Zero-indexed starting position (must be multiple of maxResults)
18
18
  * @returns Paginated list of environments with metadata (total, isLast, etc.)
19
19
  *
20
- * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/listEnvironments Official API Documentation}
20
+ * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Environments/operation/listEnvironments Official API Documentation}
21
21
  */
22
22
  async listEnvironments(options) {
23
23
  const queryString = buildQueryString(options);
@@ -33,7 +33,7 @@ export class EnvironmentGroup {
33
33
  * @param options.environmentId - The environment ID
34
34
  * @returns Environment object with all fields
35
35
  *
36
- * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/getEnvironment Official API Documentation}
36
+ * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Environments/operation/getEnvironment Official API Documentation}
37
37
  */
38
38
  async getEnvironment(options) {
39
39
  const response = await this.api.fetch(`/environments/${options.environmentId}`);
@@ -53,7 +53,7 @@ export class EnvironmentGroup {
53
53
  * @param request.body.index - Display order index (optional)
54
54
  * @returns Created environment object
55
55
  *
56
- * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/createEnvironment Official API Documentation}
56
+ * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Environments/operation/createEnvironment Official API Documentation}
57
57
  */
58
58
  async createEnvironment(request) {
59
59
  const response = await this.api.fetch('/environments', {
@@ -79,7 +79,7 @@ export class EnvironmentGroup {
79
79
  * @param request.body.description - Environment description (optional)
80
80
  * @returns Updated environment object
81
81
  *
82
- * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/updateEnvironment Official API Documentation}
82
+ * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Environments/operation/updateEnvironment Official API Documentation}
83
83
  */
84
84
  async updateEnvironment(request) {
85
85
  const response = await this.api.fetch(`/environments/${request.environmentId}`, {
@@ -22,7 +22,7 @@ export declare class FolderGroup {
22
22
  * @param options.startAt - Zero-indexed starting position (must be multiple of maxResults)
23
23
  * @returns Paginated list of folders with metadata (total, isLast, etc.)
24
24
  *
25
- * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/listFolders Official API Documentation}
25
+ * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Folders/operation/listFolders Official API Documentation}
26
26
  */
27
27
  listFolders(options: ListFoldersOptions): Promise<FolderList>;
28
28
  /**
@@ -34,7 +34,7 @@ export declare class FolderGroup {
34
34
  * @param options.folderId - The folder ID
35
35
  * @returns Folder object with all fields
36
36
  *
37
- * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/getFolder Official API Documentation}
37
+ * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Folders/operation/getFolder Official API Documentation}
38
38
  */
39
39
  getFolder(options: GetFolderOptions): Promise<Folder>;
40
40
  /**
@@ -51,7 +51,7 @@ export declare class FolderGroup {
51
51
  * @param request.body.parentId - Parent folder ID (optional, must be null for root folders)
52
52
  * @returns Created folder object
53
53
  *
54
- * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/createFolder Official API Documentation}
54
+ * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Folders/operation/createFolder Official API Documentation}
55
55
  */
56
56
  createFolder(request: CreateFolderRequest): Promise<Folder>;
57
57
  }
@@ -18,7 +18,7 @@ export class FolderGroup {
18
18
  * @param options.startAt - Zero-indexed starting position (must be multiple of maxResults)
19
19
  * @returns Paginated list of folders with metadata (total, isLast, etc.)
20
20
  *
21
- * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/listFolders Official API Documentation}
21
+ * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Folders/operation/listFolders Official API Documentation}
22
22
  */
23
23
  async listFolders(options) {
24
24
  const queryString = buildQueryString(options);
@@ -34,7 +34,7 @@ export class FolderGroup {
34
34
  * @param options.folderId - The folder ID
35
35
  * @returns Folder object with all fields
36
36
  *
37
- * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/getFolder Official API Documentation}
37
+ * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Folders/operation/getFolder Official API Documentation}
38
38
  */
39
39
  async getFolder(options) {
40
40
  const response = await this.api.fetch(`/folders/${options.folderId}`);
@@ -54,7 +54,7 @@ export class FolderGroup {
54
54
  * @param request.body.parentId - Parent folder ID (optional, must be null for root folders)
55
55
  * @returns Created folder object
56
56
  *
57
- * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/createFolder Official API Documentation}
57
+ * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Folders/operation/createFolder Official API Documentation}
58
58
  */
59
59
  async createFolder(request) {
60
60
  const response = await this.api.fetch('/folders', {
@@ -19,7 +19,7 @@ export declare class IssueLinkGroup {
19
19
  * @param options.issueKey - The key of the Jira issue (e.g., 'PROJ-123')
20
20
  * @returns List of test case keys and versions linked to the issue
21
21
  *
22
- * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/getIssueLinkTestCases Official API Documentation}
22
+ * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Issue-Links/operation/getIssueLinkTestCases Official API Documentation}
23
23
  */
24
24
  getIssueLinkTestCases(options: GetIssueLinkTestCasesOptions): Promise<TestCaseKeyAndVersionList>;
25
25
  /**
@@ -31,7 +31,7 @@ export declare class IssueLinkGroup {
31
31
  * @param options.issueKey - The key of the Jira issue (e.g., 'PROJ-123')
32
32
  * @returns List of test cycle IDs linked to the issue
33
33
  *
34
- * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/getIssueLinkTestCycles Official API Documentation}
34
+ * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Issue-Links/operation/getIssueLinkTestCycles Official API Documentation}
35
35
  */
36
36
  getIssueLinkTestCycles(options: GetIssueLinkTestCyclesOptions): Promise<TestCycleIdList>;
37
37
  /**
@@ -43,7 +43,7 @@ export declare class IssueLinkGroup {
43
43
  * @param options.issueKey - The key of the Jira issue (e.g., 'PROJ-123')
44
44
  * @returns List of test plan IDs linked to the issue
45
45
  *
46
- * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/getIssueLinkTestPlans Official API Documentation}
46
+ * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Issue-Links/operation/getIssueLinkTestPlans Official API Documentation}
47
47
  */
48
48
  getIssueLinkTestPlans(options: GetIssueLinkTestPlansOptions): Promise<TestPlanIdList>;
49
49
  /**
@@ -55,7 +55,7 @@ export declare class IssueLinkGroup {
55
55
  * @param options.issueKey - The key of the Jira issue (e.g., 'PROJ-123')
56
56
  * @returns List of test execution IDs linked to the issue
57
57
  *
58
- * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/getIssueLinkTestExecutions Official API Documentation}
58
+ * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Issue-Links/operation/getIssueLinkTestExecutions Official API Documentation}
59
59
  */
60
60
  getIssueLinkExecutions(options: GetIssueLinkExecutionsOptions): Promise<TestExecutionIdList>;
61
61
  }
@@ -15,7 +15,7 @@ export class IssueLinkGroup {
15
15
  * @param options.issueKey - The key of the Jira issue (e.g., 'PROJ-123')
16
16
  * @returns List of test case keys and versions linked to the issue
17
17
  *
18
- * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/getIssueLinkTestCases Official API Documentation}
18
+ * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Issue-Links/operation/getIssueLinkTestCases Official API Documentation}
19
19
  */
20
20
  async getIssueLinkTestCases(options) {
21
21
  const response = await this.api.fetch(`/issuelinks/${options.issueKey}/testcases`);
@@ -30,7 +30,7 @@ export class IssueLinkGroup {
30
30
  * @param options.issueKey - The key of the Jira issue (e.g., 'PROJ-123')
31
31
  * @returns List of test cycle IDs linked to the issue
32
32
  *
33
- * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/getIssueLinkTestCycles Official API Documentation}
33
+ * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Issue-Links/operation/getIssueLinkTestCycles Official API Documentation}
34
34
  */
35
35
  async getIssueLinkTestCycles(options) {
36
36
  const response = await this.api.fetch(`/issuelinks/${options.issueKey}/testcycles`);
@@ -45,7 +45,7 @@ export class IssueLinkGroup {
45
45
  * @param options.issueKey - The key of the Jira issue (e.g., 'PROJ-123')
46
46
  * @returns List of test plan IDs linked to the issue
47
47
  *
48
- * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/getIssueLinkTestPlans Official API Documentation}
48
+ * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Issue-Links/operation/getIssueLinkTestPlans Official API Documentation}
49
49
  */
50
50
  async getIssueLinkTestPlans(options) {
51
51
  const response = await this.api.fetch(`/issuelinks/${options.issueKey}/testplans`);
@@ -60,7 +60,7 @@ export class IssueLinkGroup {
60
60
  * @param options.issueKey - The key of the Jira issue (e.g., 'PROJ-123')
61
61
  * @returns List of test execution IDs linked to the issue
62
62
  *
63
- * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/getIssueLinkTestExecutions Official API Documentation}
63
+ * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Issue-Links/operation/getIssueLinkTestExecutions Official API Documentation}
64
64
  */
65
65
  async getIssueLinkExecutions(options) {
66
66
  const response = await this.api.fetch(`/issuelinks/${options.issueKey}/executions`);
@@ -19,7 +19,7 @@ export declare class LinkGroup {
19
19
  * @param options.linkId - The link ID to delete
20
20
  * @returns Promise that resolves when deletion is complete (or if link doesn't exist)
21
21
  *
22
- * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/deleteLink Official API Documentation}
22
+ * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Links/operation/deleteLink Official API Documentation}
23
23
  */
24
24
  deleteLink(options: DeleteLinkOptions): Promise<void>;
25
25
  }
@@ -15,7 +15,7 @@ export class LinkGroup {
15
15
  * @param options.linkId - The link ID to delete
16
16
  * @returns Promise that resolves when deletion is complete (or if link doesn't exist)
17
17
  *
18
- * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/#operation/deleteLink Official API Documentation}
18
+ * @see {@link https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Links/operation/deleteLink Official API Documentation}
19
19
  */
20
20
  async deleteLink(options) {
21
21
  const response = await this.api.fetch(`/links/${options.linkId}`, {