@rbaileysr/zephyr-managed-api 1.2.8 → 1.3.0
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 +102 -91
- package/dist/README.md +102 -91
- package/dist/error-strategy.d.ts.map +1 -1
- package/dist/groups/All.d.ts.map +1 -1
- package/dist/groups/Automation.d.ts.map +1 -1
- package/dist/groups/Folder.d.ts.map +1 -1
- package/dist/groups/IssueLink.d.ts.map +1 -1
- package/dist/groups/Private/PrivateAttachments.d.ts +8 -8
- package/dist/groups/Private/PrivateAttachments.d.ts.map +1 -1
- package/dist/groups/Private/PrivateAttachments.js +112 -75
- package/dist/groups/Private/PrivateBase.d.ts.map +1 -1
- package/dist/groups/Private/PrivateBase.js +1 -1
- package/dist/groups/Private/PrivateComments.d.ts.map +1 -1
- package/dist/groups/Private/PrivateComments.js +13 -13
- package/dist/groups/Private/PrivateCustomFields.d.ts.map +1 -1
- package/dist/groups/Private/PrivateCustomFields.js +5 -5
- package/dist/groups/Private/PrivateVersions.d.ts.map +1 -1
- package/dist/groups/Private/PrivateVersions.js +3 -3
- package/dist/groups/Private.d.ts +0 -184
- package/dist/groups/Private.d.ts.map +1 -1
- package/dist/groups/Private.js +0 -226
- package/dist/groups/TestCase.d.ts.map +1 -1
- package/dist/groups/TestCycle.d.ts.map +1 -1
- package/dist/groups/TestExecution.d.ts.map +1 -1
- package/dist/groups/TestPlan.d.ts.map +1 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/package.json +1 -1
- package/dist/types.d.ts +7 -7
- package/dist/types.d.ts.map +1 -1
- package/dist/utils.d.ts.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -45,80 +45,80 @@ const apiEU = createZephyrApi(
|
|
|
45
45
|
|
|
46
46
|
- [fetch](https://docs.adaptavist.com/src/managed-apis/managed-api-abstractions)
|
|
47
47
|
- Project
|
|
48
|
-
- [listProjects](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
49
|
-
- [getProject](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
48
|
+
- [listProjects](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Projects/operation/listProjects)
|
|
49
|
+
- [getProject](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Projects/operation/getProject)
|
|
50
50
|
- Status
|
|
51
|
-
- [listStatuses](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
52
|
-
- [getStatus](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
53
|
-
- [createStatus](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
54
|
-
- [updateStatus](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
51
|
+
- [listStatuses](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Statuses/operation/listStatuses)
|
|
52
|
+
- [getStatus](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Statuses/operation/getStatus)
|
|
53
|
+
- [createStatus](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Statuses/operation/createStatus)
|
|
54
|
+
- [updateStatus](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Statuses/operation/updateStatus)
|
|
55
55
|
- Priority
|
|
56
|
-
- [listPriorities](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
57
|
-
- [getPriority](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
58
|
-
- [createPriority](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
59
|
-
- [updatePriority](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
56
|
+
- [listPriorities](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Priorities/operation/listPriorities)
|
|
57
|
+
- [getPriority](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Priorities/operation/getPriority)
|
|
58
|
+
- [createPriority](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Priorities/operation/createPriority)
|
|
59
|
+
- [updatePriority](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Priorities/operation/updatePriority)
|
|
60
60
|
- Environment
|
|
61
|
-
- [listEnvironments](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
62
|
-
- [getEnvironment](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
63
|
-
- [createEnvironment](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
64
|
-
- [updateEnvironment](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
61
|
+
- [listEnvironments](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Environments/operation/listEnvironments)
|
|
62
|
+
- [getEnvironment](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Environments/operation/getEnvironment)
|
|
63
|
+
- [createEnvironment](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Environments/operation/createEnvironment)
|
|
64
|
+
- [updateEnvironment](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Environments/operation/updateEnvironment)
|
|
65
65
|
- Folder
|
|
66
|
-
- [listFolders](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
67
|
-
- [getFolder](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
68
|
-
- [createFolder](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
66
|
+
- [listFolders](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Folders/operation/listFolders)
|
|
67
|
+
- [getFolder](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Folders/operation/getFolder)
|
|
68
|
+
- [createFolder](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Folders/operation/createFolder)
|
|
69
69
|
- TestCase
|
|
70
|
-
- [listTestCases](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
71
|
-
- [listTestCasesCursorPaginated](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
72
|
-
- [getTestCase](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
73
|
-
- [createTestCase](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
74
|
-
- [updateTestCase](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
75
|
-
- [getTestCaseLinks](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
76
|
-
- [createTestCaseIssueLink](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
77
|
-
- [createTestCaseWebLink](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
78
|
-
- [listTestCaseVersions](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
79
|
-
- [getTestCaseVersion](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
80
|
-
- [getTestCaseTestScript](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
81
|
-
- [createTestCaseTestScript](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
82
|
-
- [getTestCaseTestSteps](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
83
|
-
- [createTestCaseTestSteps](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
70
|
+
- [listTestCases](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Cases/operation/listTestCases)
|
|
71
|
+
- [listTestCasesCursorPaginated](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Cases/operation/listTestCasesCursorPaginated)
|
|
72
|
+
- [getTestCase](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Cases/operation/getTestCase)
|
|
73
|
+
- [createTestCase](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Cases/operation/createTestCase)
|
|
74
|
+
- [updateTestCase](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Cases/operation/updateTestCase)
|
|
75
|
+
- [getTestCaseLinks](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Cases/operation/getTestCaseLinks)
|
|
76
|
+
- [createTestCaseIssueLink](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Cases/operation/createTestCaseIssueLink)
|
|
77
|
+
- [createTestCaseWebLink](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Cases/operation/createTestCaseWebLink)
|
|
78
|
+
- [listTestCaseVersions](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Cases/operation/listTestCaseVersions)
|
|
79
|
+
- [getTestCaseVersion](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Cases/operation/getTestCaseVersion)
|
|
80
|
+
- [getTestCaseTestScript](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Cases/operation/getTestCaseTestScript)
|
|
81
|
+
- [createTestCaseTestScript](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Cases/operation/createTestCaseTestScript)
|
|
82
|
+
- [getTestCaseTestSteps](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Cases/operation/getTestCaseTestSteps)
|
|
83
|
+
- [createTestCaseTestSteps](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Cases/operation/createTestCaseTestSteps)
|
|
84
84
|
- TestCycle
|
|
85
|
-
- [listTestCycles](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
86
|
-
- [getTestCycle](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
87
|
-
- [createTestCycle](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
88
|
-
- [updateTestCycle](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
89
|
-
- [getTestCycleLinks](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
90
|
-
- [createTestCycleIssueLink](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
91
|
-
- [createTestCycleWebLink](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
85
|
+
- [listTestCycles](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Cycles/operation/listTestCycles)
|
|
86
|
+
- [getTestCycle](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Cycles/operation/getTestCycle)
|
|
87
|
+
- [createTestCycle](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Cycles/operation/createTestCycle)
|
|
88
|
+
- [updateTestCycle](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Cycles/operation/updateTestCycle)
|
|
89
|
+
- [getTestCycleLinks](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Cycles/operation/getTestCycleLinks)
|
|
90
|
+
- [createTestCycleIssueLink](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Cycles/operation/createTestCycleIssueLink)
|
|
91
|
+
- [createTestCycleWebLink](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Cycles/operation/createTestCycleWebLink)
|
|
92
92
|
- TestPlan
|
|
93
|
-
- [listTestPlans](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
94
|
-
- [getTestPlan](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
95
|
-
- [createTestPlan](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
96
|
-
- [createTestPlanIssueLink](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
97
|
-
- [createTestPlanWebLink](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
98
|
-
- [createTestPlanTestCycleLink](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
93
|
+
- [listTestPlans](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Plans/operation/listTestPlans)
|
|
94
|
+
- [getTestPlan](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Plans/operation/getTestPlan)
|
|
95
|
+
- [createTestPlan](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Plans/operation/createTestPlan)
|
|
96
|
+
- [createTestPlanIssueLink](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Plans/operation/createTestPlanIssueLink)
|
|
97
|
+
- [createTestPlanWebLink](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Plans/operation/createTestPlanWebLink)
|
|
98
|
+
- [createTestPlanTestCycleLink](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Plans/operation/createTestPlanTestCycleLink)
|
|
99
99
|
- TestExecution
|
|
100
|
-
- [listTestExecutions](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
101
|
-
- [listTestExecutionsNextgen](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
102
|
-
- [getTestExecution](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
103
|
-
- [createTestExecution](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
104
|
-
- [updateTestExecution](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
105
|
-
- [getTestExecutionTestSteps](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
106
|
-
- [putTestExecutionTestSteps](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
107
|
-
- [syncTestExecutionScript](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
108
|
-
- [listTestExecutionLinks](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
109
|
-
- [createTestExecutionIssueLink](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
100
|
+
- [listTestExecutions](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Executions/operation/listTestExecutions)
|
|
101
|
+
- [listTestExecutionsNextgen](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Executions/operation/listTestExecutionsNextgen)
|
|
102
|
+
- [getTestExecution](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Executions/operation/getTestExecution)
|
|
103
|
+
- [createTestExecution](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Executions/operation/createTestExecution)
|
|
104
|
+
- [updateTestExecution](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Executions/operation/updateTestExecution)
|
|
105
|
+
- [getTestExecutionTestSteps](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Executions/operation/getTestExecutionTestSteps)
|
|
106
|
+
- [putTestExecutionTestSteps](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Executions/operation/putTestExecutionTestSteps)
|
|
107
|
+
- [syncTestExecutionScript](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Executions/operation/syncTestExecutionScript)
|
|
108
|
+
- [listTestExecutionLinks](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Executions/operation/listTestExecutionLinks)
|
|
109
|
+
- [createTestExecutionIssueLink](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Executions/operation/createTestExecutionIssueLink)
|
|
110
110
|
- Link
|
|
111
|
-
- [deleteLink](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
111
|
+
- [deleteLink](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Links/operation/deleteLink)
|
|
112
112
|
- IssueLink
|
|
113
|
-
- [getIssueLinkTestCases](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
114
|
-
- [getIssueLinkTestCycles](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
115
|
-
- [getIssueLinkTestPlans](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
116
|
-
- [getIssueLinkExecutions](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
113
|
+
- [getIssueLinkTestCases](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Issue-Links/operation/getIssueLinkTestCases)
|
|
114
|
+
- [getIssueLinkTestCycles](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Issue-Links/operation/getIssueLinkTestCycles)
|
|
115
|
+
- [getIssueLinkTestPlans](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Issue-Links/operation/getIssueLinkTestPlans)
|
|
116
|
+
- [getIssueLinkExecutions](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Issue-Links/operation/getIssueLinkExecutions)
|
|
117
117
|
- Automation
|
|
118
|
-
- [createCustomExecutions](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
119
|
-
- [createCucumberExecutions](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
120
|
-
- [createJUnitExecutions](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
121
|
-
- [retrieveBDDTestCases](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
118
|
+
- [createCustomExecutions](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Automation/operation/createCustomExecutions)
|
|
119
|
+
- [createCucumberExecutions](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Automation/operation/createCucumberExecutions)
|
|
120
|
+
- [createJUnitExecutions](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Automation/operation/createJUnitExecutions)
|
|
121
|
+
- [retrieveBDDTestCases](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Automation/operation/retrieveBDDTestCases)
|
|
122
122
|
- Private ⚠️
|
|
123
123
|
> **⚠️ WARNING: Private API Methods**
|
|
124
124
|
>
|
|
@@ -131,38 +131,38 @@ const apiEU = createZephyrApi(
|
|
|
131
131
|
> Use these methods at your own risk. They may break with future Zephyr updates.
|
|
132
132
|
|
|
133
133
|
- Authentication
|
|
134
|
-
-
|
|
134
|
+
- **getContextJwt** - Get Jira Context JWT token (required for all private API calls)
|
|
135
135
|
- Comments
|
|
136
|
-
-
|
|
137
|
-
-
|
|
138
|
-
-
|
|
139
|
-
-
|
|
140
|
-
-
|
|
141
|
-
-
|
|
136
|
+
- **getTestCaseComments** - Get all comments for a test case
|
|
137
|
+
- **getTestCycleComments** - Get all comments for a test cycle
|
|
138
|
+
- **getTestPlanComments** - Get all comments for a test plan
|
|
139
|
+
- **createTestCaseComment** - Create a comment on a test case
|
|
140
|
+
- **createTestCycleComment** - Create a comment on a test cycle
|
|
141
|
+
- **createTestPlanComment** - Create a comment on a test plan
|
|
142
142
|
- CustomFields
|
|
143
|
-
-
|
|
144
|
-
-
|
|
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
|
|
145
145
|
- Versions
|
|
146
|
-
-
|
|
146
|
+
- **createTestCaseVersion** - Create a new test case version
|
|
147
147
|
- Attachments
|
|
148
|
-
-
|
|
149
|
-
-
|
|
150
|
-
-
|
|
151
|
-
-
|
|
152
|
-
-
|
|
153
|
-
-
|
|
154
|
-
-
|
|
155
|
-
-
|
|
156
|
-
-
|
|
157
|
-
-
|
|
158
|
-
-
|
|
159
|
-
-
|
|
160
|
-
-
|
|
161
|
-
-
|
|
162
|
-
-
|
|
163
|
-
-
|
|
164
|
-
-
|
|
165
|
-
-
|
|
148
|
+
- **getTestCaseAttachments** - Get all attachments for a test case
|
|
149
|
+
- **downloadAttachment** - Download an attachment from a test case
|
|
150
|
+
- **createAttachment** - Upload an attachment to a test case
|
|
151
|
+
- **getTestStepAttachments** - Get all attachments for a test step
|
|
152
|
+
- **downloadTestStepAttachment** - Download an attachment from a test step
|
|
153
|
+
- **createTestStepAttachment** - Upload an attachment to a test step
|
|
154
|
+
- **getTestCycleAttachments** - Get all attachments for a test cycle
|
|
155
|
+
- **downloadTestCycleAttachment** - Download an attachment from a test cycle
|
|
156
|
+
- **createTestCycleAttachment** - Upload an attachment to a test cycle
|
|
157
|
+
- **getTestPlanAttachments** - Get all attachments for a test plan
|
|
158
|
+
- **downloadTestPlanAttachment** - Download an attachment from a test plan
|
|
159
|
+
- **createTestPlanAttachment** - Upload an attachment to a test plan
|
|
160
|
+
- **getTestExecutionAttachments** - Get all attachments for a test execution
|
|
161
|
+
- **downloadTestExecutionAttachment** - Download an attachment from a test execution
|
|
162
|
+
- **createTestExecutionAttachment** - Upload an attachment to a test execution
|
|
163
|
+
- **getTestExecutionStepAttachments** - Get all attachments for a test execution step
|
|
164
|
+
- **downloadTestExecutionStepAttachment** - Download an attachment from a test execution step
|
|
165
|
+
- **createTestExecutionStepAttachment** - Upload an attachment to a test execution step
|
|
166
166
|
|
|
167
167
|
## Private API Authentication
|
|
168
168
|
|
|
@@ -251,6 +251,17 @@ Feel free to drop ideas, suggestions or improvements into our [Community hub](ht
|
|
|
251
251
|
|
|
252
252
|
## Changelog
|
|
253
253
|
|
|
254
|
+
### 1.3.0
|
|
255
|
+
|
|
256
|
+
- **Tested**: All API functions from the Private API have been tested and verified - 16/12/2025
|
|
257
|
+
|
|
258
|
+
### 1.2.9
|
|
259
|
+
|
|
260
|
+
- **Changed**: Test step and test execution step attachment methods now use `stepIndex` (zero-based array index) instead of `stepId`/`testScriptResultId` for better usability
|
|
261
|
+
- **Changed**: Renamed `createAttachment` to `createTestCaseAttachment` to match naming convention with other attachment methods
|
|
262
|
+
- **Removed**: All deprecated methods from `Private` group - use sub-groups (`Private.Comments`, `Private.Attachments`, etc.) instead
|
|
263
|
+
- **Fixed**: Corrected API documentation URLs in README to use proper tag-based format
|
|
264
|
+
|
|
254
265
|
### 1.2.8
|
|
255
266
|
|
|
256
267
|
- **Added**: Attachment support for test steps, test executions, and test execution steps
|
package/dist/README.md
CHANGED
|
@@ -45,80 +45,80 @@ const apiEU = createZephyrApi(
|
|
|
45
45
|
|
|
46
46
|
- [fetch](https://docs.adaptavist.com/src/managed-apis/managed-api-abstractions)
|
|
47
47
|
- Project
|
|
48
|
-
- [listProjects](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
49
|
-
- [getProject](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
48
|
+
- [listProjects](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Projects/operation/listProjects)
|
|
49
|
+
- [getProject](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Projects/operation/getProject)
|
|
50
50
|
- Status
|
|
51
|
-
- [listStatuses](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
52
|
-
- [getStatus](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
53
|
-
- [createStatus](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
54
|
-
- [updateStatus](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
51
|
+
- [listStatuses](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Statuses/operation/listStatuses)
|
|
52
|
+
- [getStatus](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Statuses/operation/getStatus)
|
|
53
|
+
- [createStatus](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Statuses/operation/createStatus)
|
|
54
|
+
- [updateStatus](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Statuses/operation/updateStatus)
|
|
55
55
|
- Priority
|
|
56
|
-
- [listPriorities](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
57
|
-
- [getPriority](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
58
|
-
- [createPriority](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
59
|
-
- [updatePriority](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
56
|
+
- [listPriorities](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Priorities/operation/listPriorities)
|
|
57
|
+
- [getPriority](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Priorities/operation/getPriority)
|
|
58
|
+
- [createPriority](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Priorities/operation/createPriority)
|
|
59
|
+
- [updatePriority](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Priorities/operation/updatePriority)
|
|
60
60
|
- Environment
|
|
61
|
-
- [listEnvironments](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
62
|
-
- [getEnvironment](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
63
|
-
- [createEnvironment](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
64
|
-
- [updateEnvironment](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
61
|
+
- [listEnvironments](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Environments/operation/listEnvironments)
|
|
62
|
+
- [getEnvironment](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Environments/operation/getEnvironment)
|
|
63
|
+
- [createEnvironment](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Environments/operation/createEnvironment)
|
|
64
|
+
- [updateEnvironment](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Environments/operation/updateEnvironment)
|
|
65
65
|
- Folder
|
|
66
|
-
- [listFolders](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
67
|
-
- [getFolder](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
68
|
-
- [createFolder](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
66
|
+
- [listFolders](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Folders/operation/listFolders)
|
|
67
|
+
- [getFolder](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Folders/operation/getFolder)
|
|
68
|
+
- [createFolder](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Folders/operation/createFolder)
|
|
69
69
|
- TestCase
|
|
70
|
-
- [listTestCases](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
71
|
-
- [listTestCasesCursorPaginated](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
72
|
-
- [getTestCase](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
73
|
-
- [createTestCase](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
74
|
-
- [updateTestCase](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
75
|
-
- [getTestCaseLinks](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
76
|
-
- [createTestCaseIssueLink](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
77
|
-
- [createTestCaseWebLink](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
78
|
-
- [listTestCaseVersions](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
79
|
-
- [getTestCaseVersion](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
80
|
-
- [getTestCaseTestScript](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
81
|
-
- [createTestCaseTestScript](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
82
|
-
- [getTestCaseTestSteps](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
83
|
-
- [createTestCaseTestSteps](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
70
|
+
- [listTestCases](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Cases/operation/listTestCases)
|
|
71
|
+
- [listTestCasesCursorPaginated](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Cases/operation/listTestCasesCursorPaginated)
|
|
72
|
+
- [getTestCase](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Cases/operation/getTestCase)
|
|
73
|
+
- [createTestCase](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Cases/operation/createTestCase)
|
|
74
|
+
- [updateTestCase](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Cases/operation/updateTestCase)
|
|
75
|
+
- [getTestCaseLinks](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Cases/operation/getTestCaseLinks)
|
|
76
|
+
- [createTestCaseIssueLink](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Cases/operation/createTestCaseIssueLink)
|
|
77
|
+
- [createTestCaseWebLink](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Cases/operation/createTestCaseWebLink)
|
|
78
|
+
- [listTestCaseVersions](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Cases/operation/listTestCaseVersions)
|
|
79
|
+
- [getTestCaseVersion](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Cases/operation/getTestCaseVersion)
|
|
80
|
+
- [getTestCaseTestScript](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Cases/operation/getTestCaseTestScript)
|
|
81
|
+
- [createTestCaseTestScript](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Cases/operation/createTestCaseTestScript)
|
|
82
|
+
- [getTestCaseTestSteps](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Cases/operation/getTestCaseTestSteps)
|
|
83
|
+
- [createTestCaseTestSteps](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Cases/operation/createTestCaseTestSteps)
|
|
84
84
|
- TestCycle
|
|
85
|
-
- [listTestCycles](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
86
|
-
- [getTestCycle](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
87
|
-
- [createTestCycle](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
88
|
-
- [updateTestCycle](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
89
|
-
- [getTestCycleLinks](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
90
|
-
- [createTestCycleIssueLink](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
91
|
-
- [createTestCycleWebLink](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
85
|
+
- [listTestCycles](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Cycles/operation/listTestCycles)
|
|
86
|
+
- [getTestCycle](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Cycles/operation/getTestCycle)
|
|
87
|
+
- [createTestCycle](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Cycles/operation/createTestCycle)
|
|
88
|
+
- [updateTestCycle](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Cycles/operation/updateTestCycle)
|
|
89
|
+
- [getTestCycleLinks](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Cycles/operation/getTestCycleLinks)
|
|
90
|
+
- [createTestCycleIssueLink](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Cycles/operation/createTestCycleIssueLink)
|
|
91
|
+
- [createTestCycleWebLink](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Cycles/operation/createTestCycleWebLink)
|
|
92
92
|
- TestPlan
|
|
93
|
-
- [listTestPlans](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
94
|
-
- [getTestPlan](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
95
|
-
- [createTestPlan](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
96
|
-
- [createTestPlanIssueLink](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
97
|
-
- [createTestPlanWebLink](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
98
|
-
- [createTestPlanTestCycleLink](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
93
|
+
- [listTestPlans](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Plans/operation/listTestPlans)
|
|
94
|
+
- [getTestPlan](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Plans/operation/getTestPlan)
|
|
95
|
+
- [createTestPlan](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Plans/operation/createTestPlan)
|
|
96
|
+
- [createTestPlanIssueLink](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Plans/operation/createTestPlanIssueLink)
|
|
97
|
+
- [createTestPlanWebLink](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Plans/operation/createTestPlanWebLink)
|
|
98
|
+
- [createTestPlanTestCycleLink](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Plans/operation/createTestPlanTestCycleLink)
|
|
99
99
|
- TestExecution
|
|
100
|
-
- [listTestExecutions](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
101
|
-
- [listTestExecutionsNextgen](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
102
|
-
- [getTestExecution](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
103
|
-
- [createTestExecution](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
104
|
-
- [updateTestExecution](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
105
|
-
- [getTestExecutionTestSteps](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
106
|
-
- [putTestExecutionTestSteps](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
107
|
-
- [syncTestExecutionScript](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
108
|
-
- [listTestExecutionLinks](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
109
|
-
- [createTestExecutionIssueLink](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
100
|
+
- [listTestExecutions](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Executions/operation/listTestExecutions)
|
|
101
|
+
- [listTestExecutionsNextgen](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Executions/operation/listTestExecutionsNextgen)
|
|
102
|
+
- [getTestExecution](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Executions/operation/getTestExecution)
|
|
103
|
+
- [createTestExecution](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Executions/operation/createTestExecution)
|
|
104
|
+
- [updateTestExecution](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Executions/operation/updateTestExecution)
|
|
105
|
+
- [getTestExecutionTestSteps](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Executions/operation/getTestExecutionTestSteps)
|
|
106
|
+
- [putTestExecutionTestSteps](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Executions/operation/putTestExecutionTestSteps)
|
|
107
|
+
- [syncTestExecutionScript](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Executions/operation/syncTestExecutionScript)
|
|
108
|
+
- [listTestExecutionLinks](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Executions/operation/listTestExecutionLinks)
|
|
109
|
+
- [createTestExecutionIssueLink](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Test-Executions/operation/createTestExecutionIssueLink)
|
|
110
110
|
- Link
|
|
111
|
-
- [deleteLink](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
111
|
+
- [deleteLink](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Links/operation/deleteLink)
|
|
112
112
|
- IssueLink
|
|
113
|
-
- [getIssueLinkTestCases](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
114
|
-
- [getIssueLinkTestCycles](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
115
|
-
- [getIssueLinkTestPlans](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
116
|
-
- [getIssueLinkExecutions](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
113
|
+
- [getIssueLinkTestCases](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Issue-Links/operation/getIssueLinkTestCases)
|
|
114
|
+
- [getIssueLinkTestCycles](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Issue-Links/operation/getIssueLinkTestCycles)
|
|
115
|
+
- [getIssueLinkTestPlans](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Issue-Links/operation/getIssueLinkTestPlans)
|
|
116
|
+
- [getIssueLinkExecutions](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Issue-Links/operation/getIssueLinkExecutions)
|
|
117
117
|
- Automation
|
|
118
|
-
- [createCustomExecutions](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
119
|
-
- [createCucumberExecutions](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
120
|
-
- [createJUnitExecutions](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
121
|
-
- [retrieveBDDTestCases](https://support.smartbear.com/zephyr-scale-cloud/api-docs/
|
|
118
|
+
- [createCustomExecutions](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Automation/operation/createCustomExecutions)
|
|
119
|
+
- [createCucumberExecutions](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Automation/operation/createCucumberExecutions)
|
|
120
|
+
- [createJUnitExecutions](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Automation/operation/createJUnitExecutions)
|
|
121
|
+
- [retrieveBDDTestCases](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#tag/Automation/operation/retrieveBDDTestCases)
|
|
122
122
|
- Private ⚠️
|
|
123
123
|
> **⚠️ WARNING: Private API Methods**
|
|
124
124
|
>
|
|
@@ -131,38 +131,38 @@ const apiEU = createZephyrApi(
|
|
|
131
131
|
> Use these methods at your own risk. They may break with future Zephyr updates.
|
|
132
132
|
|
|
133
133
|
- Authentication
|
|
134
|
-
-
|
|
134
|
+
- **getContextJwt** - Get Jira Context JWT token (required for all private API calls)
|
|
135
135
|
- Comments
|
|
136
|
-
-
|
|
137
|
-
-
|
|
138
|
-
-
|
|
139
|
-
-
|
|
140
|
-
-
|
|
141
|
-
-
|
|
136
|
+
- **getTestCaseComments** - Get all comments for a test case
|
|
137
|
+
- **getTestCycleComments** - Get all comments for a test cycle
|
|
138
|
+
- **getTestPlanComments** - Get all comments for a test plan
|
|
139
|
+
- **createTestCaseComment** - Create a comment on a test case
|
|
140
|
+
- **createTestCycleComment** - Create a comment on a test cycle
|
|
141
|
+
- **createTestPlanComment** - Create a comment on a test plan
|
|
142
142
|
- CustomFields
|
|
143
|
-
-
|
|
144
|
-
-
|
|
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
|
|
145
145
|
- Versions
|
|
146
|
-
-
|
|
146
|
+
- **createTestCaseVersion** - Create a new test case version
|
|
147
147
|
- Attachments
|
|
148
|
-
-
|
|
149
|
-
-
|
|
150
|
-
-
|
|
151
|
-
-
|
|
152
|
-
-
|
|
153
|
-
-
|
|
154
|
-
-
|
|
155
|
-
-
|
|
156
|
-
-
|
|
157
|
-
-
|
|
158
|
-
-
|
|
159
|
-
-
|
|
160
|
-
-
|
|
161
|
-
-
|
|
162
|
-
-
|
|
163
|
-
-
|
|
164
|
-
-
|
|
165
|
-
-
|
|
148
|
+
- **getTestCaseAttachments** - Get all attachments for a test case
|
|
149
|
+
- **downloadAttachment** - Download an attachment from a test case
|
|
150
|
+
- **createAttachment** - Upload an attachment to a test case
|
|
151
|
+
- **getTestStepAttachments** - Get all attachments for a test step
|
|
152
|
+
- **downloadTestStepAttachment** - Download an attachment from a test step
|
|
153
|
+
- **createTestStepAttachment** - Upload an attachment to a test step
|
|
154
|
+
- **getTestCycleAttachments** - Get all attachments for a test cycle
|
|
155
|
+
- **downloadTestCycleAttachment** - Download an attachment from a test cycle
|
|
156
|
+
- **createTestCycleAttachment** - Upload an attachment to a test cycle
|
|
157
|
+
- **getTestPlanAttachments** - Get all attachments for a test plan
|
|
158
|
+
- **downloadTestPlanAttachment** - Download an attachment from a test plan
|
|
159
|
+
- **createTestPlanAttachment** - Upload an attachment to a test plan
|
|
160
|
+
- **getTestExecutionAttachments** - Get all attachments for a test execution
|
|
161
|
+
- **downloadTestExecutionAttachment** - Download an attachment from a test execution
|
|
162
|
+
- **createTestExecutionAttachment** - Upload an attachment to a test execution
|
|
163
|
+
- **getTestExecutionStepAttachments** - Get all attachments for a test execution step
|
|
164
|
+
- **downloadTestExecutionStepAttachment** - Download an attachment from a test execution step
|
|
165
|
+
- **createTestExecutionStepAttachment** - Upload an attachment to a test execution step
|
|
166
166
|
|
|
167
167
|
## Private API Authentication
|
|
168
168
|
|
|
@@ -251,6 +251,17 @@ Feel free to drop ideas, suggestions or improvements into our [Community hub](ht
|
|
|
251
251
|
|
|
252
252
|
## Changelog
|
|
253
253
|
|
|
254
|
+
### 1.3.0
|
|
255
|
+
|
|
256
|
+
- **Tested**: All API functions from the Private API have been tested and verified - 16/12/2025
|
|
257
|
+
|
|
258
|
+
### 1.2.9
|
|
259
|
+
|
|
260
|
+
- **Changed**: Test step and test execution step attachment methods now use `stepIndex` (zero-based array index) instead of `stepId`/`testScriptResultId` for better usability
|
|
261
|
+
- **Changed**: Renamed `createAttachment` to `createTestCaseAttachment` to match naming convention with other attachment methods
|
|
262
|
+
- **Removed**: All deprecated methods from `Private` group - use sub-groups (`Private.Comments`, `Private.Attachments`, etc.) instead
|
|
263
|
+
- **Fixed**: Corrected API documentation URLs in README to use proper tag-based format
|
|
264
|
+
|
|
254
265
|
### 1.2.8
|
|
255
266
|
|
|
256
267
|
- **Added**: Attachment support for test steps, test executions, and test execution steps
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"error-strategy.d.ts","sourceRoot":"","sources":["../error-strategy.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH;;;GAGG;AAEH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAW/C;;GAEG;AACH,MAAM,WAAW,WAAW;IAC3B,IAAI,EAAE,OAAO,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACzC,IAAI,EAAE,UAAU,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB,CAAC,CAAC;IACnC,IAAI,EAAE,QAAQ,CAAC;IACf,KAAK,EAAE,CAAC,CAAC;CACT;AAED,MAAM,MAAM,mBAAmB,CAAC,CAAC,IAAI,WAAW,GAAG,yBAAyB,GAAG,iBAAiB,CAAC,CAAC,CAAC,CAAC;AAEpG;;GAEG;AACH,wBAAgB,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,WAAW,CAEhD;AAED;;GAEG;AACH,wBAAgB,mBAAmB,IAAI,yBAAyB,CAE/D;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB,CAAC,CAAC;IACvC,kBAAkB,CAAC,EAAE,
|
|
1
|
+
{"version":3,"file":"error-strategy.d.ts","sourceRoot":"","sources":["../error-strategy.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH;;;GAGG;AAEH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAW/C;;GAEG;AACH,MAAM,WAAW,WAAW;IAC3B,IAAI,EAAE,OAAO,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACzC,IAAI,EAAE,UAAU,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB,CAAC,CAAC;IACnC,IAAI,EAAE,QAAQ,CAAC;IACf,KAAK,EAAE,CAAC,CAAC;CACT;AAED,MAAM,MAAM,mBAAmB,CAAC,CAAC,IAAI,WAAW,GAAG,yBAAyB,GAAG,iBAAiB,CAAC,CAAC,CAAC,CAAC;AAEpG;;GAEG;AACH,wBAAgB,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,WAAW,CAEhD;AAED;;GAEG;AACH,wBAAgB,mBAAmB,IAAI,yBAAyB,CAE/D;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB,CAAC,CAAC;IACvC,kBAAkB,CAAC,EAAE,CACpB,QAAQ,EAAE,eAAe,EACzB,SAAS,EAAE,OAAO,KACd,mBAAmB,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,CAAC;IAC9D,kBAAkB,CAAC,EAAE,CACpB,QAAQ,EAAE,eAAe,EACzB,SAAS,EAAE,OAAO,KACd,mBAAmB,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,CAAC;IAC9D,kBAAkB,CAAC,EAAE,CACpB,QAAQ,EAAE,eAAe,EACzB,SAAS,EAAE,OAAO,KACd,mBAAmB,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,CAAC;IAC9D,kBAAkB,CAAC,EAAE,CACpB,QAAQ,EAAE,eAAe,EACzB,SAAS,EAAE,OAAO,KACd,mBAAmB,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,CAAC;IAC9D,kBAAkB,CAAC,EAAE,CACpB,QAAQ,EAAE,eAAe,EACzB,UAAU,EAAE,MAAM,KACd,mBAAmB,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,CAAC;IAC9D,kBAAkB,CAAC,EAAE,CACpB,QAAQ,EAAE,eAAe,EACzB,SAAS,EAAE,OAAO,KACd,mBAAmB,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,CAAC;IAC9D,eAAe,CAAC,EAAE,CACjB,QAAQ,EAAE,eAAe,EACzB,SAAS,EAAE,OAAO,KACd,mBAAmB,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,CAAC;CAC9D;AAED;;GAEG;AACH,qBAAa,oBAAoB,CAAC,CAAC,GAAG,OAAO;IAC5C,OAAO,CAAC,QAAQ,CAAgC;IAEhD,YAAY,CACX,OAAO,EAAE,CACR,QAAQ,EAAE,eAAe,EACzB,SAAS,EAAE,OAAO,KACd,mBAAmB,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,GAC3D,IAAI;IAKP,YAAY,CACX,OAAO,EAAE,CACR,QAAQ,EAAE,eAAe,EACzB,SAAS,EAAE,OAAO,KACd,mBAAmB,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,GAC3D,IAAI;IAKP,YAAY,CACX,OAAO,EAAE,CACR,QAAQ,EAAE,eAAe,EACzB,SAAS,EAAE,OAAO,KACd,mBAAmB,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,GAC3D,IAAI;IAKP,YAAY,CACX,OAAO,EAAE,CACR,QAAQ,EAAE,eAAe,EACzB,SAAS,EAAE,OAAO,KACd,mBAAmB,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,GAC3D,IAAI;IAKP,YAAY,CACX,OAAO,EAAE,CACR,QAAQ,EAAE,eAAe,EACzB,UAAU,EAAE,MAAM,KACd,mBAAmB,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,GAC3D,IAAI;IAKP,YAAY,CACX,OAAO,EAAE,CACR,QAAQ,EAAE,eAAe,EACzB,SAAS,EAAE,OAAO,KACd,mBAAmB,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,GAC3D,IAAI;IAKP,SAAS,CACR,OAAO,EAAE,CACR,QAAQ,EAAE,eAAe,EACzB,SAAS,EAAE,OAAO,KACd,mBAAmB,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,GAC3D,IAAI;IAKP;;OAEG;IACH,mBAAmB,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI;IAc7C,KAAK,IAAI,qBAAqB,CAAC,CAAC,CAAC;CAGjC;AAED;;GAEG;AACH,wBAAsB,kBAAkB,CAAC,CAAC,EACzC,QAAQ,EAAE,eAAe,EACzB,aAAa,EAAE,qBAAqB,CAAC,CAAC,CAAC,GAAG,SAAS,EACnD,UAAU,GAAE,MAAU,GACpB,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,CAqDjC"}
|
package/dist/groups/All.d.ts.map
CHANGED
|
@@ -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;
|
|
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 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Automation.d.ts","sourceRoot":"","sources":["../../groups/Automation.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;;GAGG;AAEH,OAAO,KAAK,EACX,sCAAsC,EACtC,wCAAwC,EACxC,qCAAqC,EACrC,2BAA2B,EAC3B,gBAAgB,EAChB,MAAM,UAAU,CAAC;AAElB,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAEpD,qBAAa,eAAe;IACf,OAAO,CAAC,GAAG;gBAAH,GAAG,EAAE,mBAAmB;IAE5C;;;;;;;;;;;;;;;OAeG;IACG,sBAAsB,
|
|
1
|
+
{"version":3,"file":"Automation.d.ts","sourceRoot":"","sources":["../../groups/Automation.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;;GAGG;AAEH,OAAO,KAAK,EACX,sCAAsC,EACtC,wCAAwC,EACxC,qCAAqC,EACrC,2BAA2B,EAC3B,gBAAgB,EAChB,MAAM,UAAU,CAAC;AAElB,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAEpD,qBAAa,eAAe;IACf,OAAO,CAAC,GAAG;gBAAH,GAAG,EAAE,mBAAmB;IAE5C;;;;;;;;;;;;;;;OAeG;IACG,sBAAsB,CAAC,OAAO,EAAE,sCAAsC,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAgBxG;;;;;;;;;;;;;;;OAeG;IACG,wBAAwB,CAAC,OAAO,EAAE,wCAAwC,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAgB5G;;;;;;;;;;;;;;;OAeG;IACG,qBAAqB,CAAC,OAAO,EAAE,qCAAqC,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAgBtG;;;;;;;;;;;OAWG;IACG,oBAAoB,CAAC,OAAO,EAAE,2BAA2B,GAAG,OAAO,CAAC,IAAI,CAAC;CAkB/E"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Folder.d.ts","sourceRoot":"","sources":["../../groups/Folder.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;;GAGG;AAEH,OAAO,KAAK,
|
|
1
|
+
{"version":3,"file":"Folder.d.ts","sourceRoot":"","sources":["../../groups/Folder.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;;GAGG;AAEH,OAAO,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAE9G,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAEpD,qBAAa,WAAW;IACX,OAAO,CAAC,GAAG;gBAAH,GAAG,EAAE,mBAAmB;IAE5C;;;;;;;;;;;;;OAaG;IACG,WAAW,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,CAAC;IAMnE;;;;;;;;;;OAUG;IACG,SAAS,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,MAAM,CAAC;IAK3D;;;;;;;;;;;;;;;OAeG;IACG,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,MAAM,CAAC;CAQjE"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"IssueLink.d.ts","sourceRoot":"","sources":["../../groups/IssueLink.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;;GAGG;AAEH,OAAO,KAAK,EACX,4BAA4B,EAC5B,6BAA6B,EAC7B,4BAA4B,EAC5B,6BAA6B,EAC7B,yBAAyB,EACzB,eAAe,EACf,cAAc,EACd,mBAAmB,EACnB,MAAM,UAAU,CAAC;AAElB,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAEpD,qBAAa,cAAc;IACd,OAAO,CAAC,GAAG;gBAAH,GAAG,EAAE,mBAAmB;IAE5C;;;;;;;;;;OAUG;IACG,qBAAqB,
|
|
1
|
+
{"version":3,"file":"IssueLink.d.ts","sourceRoot":"","sources":["../../groups/IssueLink.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;;GAGG;AAEH,OAAO,KAAK,EACX,4BAA4B,EAC5B,6BAA6B,EAC7B,4BAA4B,EAC5B,6BAA6B,EAC7B,yBAAyB,EACzB,eAAe,EACf,cAAc,EACd,mBAAmB,EACnB,MAAM,UAAU,CAAC;AAElB,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAEpD,qBAAa,cAAc;IACd,OAAO,CAAC,GAAG;gBAAH,GAAG,EAAE,mBAAmB;IAE5C;;;;;;;;;;OAUG;IACG,qBAAqB,CAAC,OAAO,EAAE,4BAA4B,GAAG,OAAO,CAAC,yBAAyB,CAAC;IAKtG;;;;;;;;;;OAUG;IACG,sBAAsB,CAAC,OAAO,EAAE,6BAA6B,GAAG,OAAO,CAAC,eAAe,CAAC;IAK9F;;;;;;;;;;OAUG;IACG,qBAAqB,CAAC,OAAO,EAAE,4BAA4B,GAAG,OAAO,CAAC,cAAc,CAAC;IAK3F;;;;;;;;;;OAUG;IACG,sBAAsB,CAAC,OAAO,EAAE,6BAA6B,GAAG,OAAO,CAAC,mBAAmB,CAAC;CAIlG"}
|