@testcollab/sdk 3.11.0 → 3.12.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.
Files changed (186) hide show
  1. package/.openapi-generator/FILES +44 -0
  2. package/dist/apis/ReleasesApi.d.ts +280 -0
  3. package/dist/apis/ReleasesApi.js +379 -0
  4. package/dist/apis/index.d.ts +1 -0
  5. package/dist/apis/index.js +1 -0
  6. package/dist/esm/apis/ReleasesApi.d.ts +280 -0
  7. package/dist/esm/apis/ReleasesApi.js +375 -0
  8. package/dist/esm/apis/index.d.ts +1 -0
  9. package/dist/esm/apis/index.js +1 -0
  10. package/dist/esm/models/Activity.d.ts +9 -0
  11. package/dist/esm/models/Activity.js +6 -1
  12. package/dist/esm/models/ActivityAuditInfo.d.ts +44 -0
  13. package/dist/esm/models/ActivityAuditInfo.js +45 -0
  14. package/dist/esm/models/Release.d.ts +131 -0
  15. package/dist/esm/models/Release.js +95 -0
  16. package/dist/esm/models/ReleaseGoNoGoThreshold.d.ts +45 -0
  17. package/dist/esm/models/ReleaseGoNoGoThreshold.js +45 -0
  18. package/dist/esm/models/ReleaseMinified.d.ts +67 -0
  19. package/dist/esm/models/ReleaseMinified.js +65 -0
  20. package/dist/esm/models/ReleasePayload.d.ts +98 -0
  21. package/dist/esm/models/ReleasePayload.js +75 -0
  22. package/dist/esm/models/ReleaseReadiness.d.ts +106 -0
  23. package/dist/esm/models/ReleaseReadiness.js +79 -0
  24. package/dist/esm/models/ReleaseReadinessComparison.d.ts +52 -0
  25. package/dist/esm/models/ReleaseReadinessComparison.js +47 -0
  26. package/dist/esm/models/ReleaseReadinessConfigurationCoverage.d.ts +84 -0
  27. package/dist/esm/models/ReleaseReadinessConfigurationCoverage.js +71 -0
  28. package/dist/esm/models/ReleaseReadinessCoverageItem.d.ts +75 -0
  29. package/dist/esm/models/ReleaseReadinessCoverageItem.js +65 -0
  30. package/dist/esm/models/ReleaseReadinessCustomFieldCoverage.d.ts +77 -0
  31. package/dist/esm/models/ReleaseReadinessCustomFieldCoverage.js +75 -0
  32. package/dist/esm/models/ReleaseReadinessCustomFieldGroup.d.ts +75 -0
  33. package/dist/esm/models/ReleaseReadinessCustomFieldGroup.js +69 -0
  34. package/dist/esm/models/ReleaseReadinessDefectSeverity.d.ts +38 -0
  35. package/dist/esm/models/ReleaseReadinessDefectSeverity.js +47 -0
  36. package/dist/esm/models/ReleaseReadinessDefects.d.ts +46 -0
  37. package/dist/esm/models/ReleaseReadinessDefects.js +52 -0
  38. package/dist/esm/models/ReleaseReadinessEvidence.d.ts +45 -0
  39. package/dist/esm/models/ReleaseReadinessEvidence.js +51 -0
  40. package/dist/esm/models/ReleaseReadinessRequirementCoverage.d.ts +41 -0
  41. package/dist/esm/models/ReleaseReadinessRequirementCoverage.js +48 -0
  42. package/dist/esm/models/ReleaseReadinessRequirementItem.d.ts +92 -0
  43. package/dist/esm/models/ReleaseReadinessRequirementItem.js +84 -0
  44. package/dist/esm/models/ReleaseReadinessRequirementSummary.d.ts +57 -0
  45. package/dist/esm/models/ReleaseReadinessRequirementSummary.js +59 -0
  46. package/dist/esm/models/ReleaseReadinessSummary.d.ts +70 -0
  47. package/dist/esm/models/ReleaseReadinessSummary.js +51 -0
  48. package/dist/esm/models/ReleaseReadinessTestPlan.d.ts +69 -0
  49. package/dist/esm/models/ReleaseReadinessTestPlan.js +68 -0
  50. package/dist/esm/models/ReleaseReadinessTestPlanRun.d.ts +51 -0
  51. package/dist/esm/models/ReleaseReadinessTestPlanRun.js +51 -0
  52. package/dist/esm/models/ReleaseReadinessVerdict.d.ts +50 -0
  53. package/dist/esm/models/ReleaseReadinessVerdict.js +56 -0
  54. package/dist/esm/models/StepWiseResult.d.ts +6 -0
  55. package/dist/esm/models/StepWiseResult.js +2 -0
  56. package/dist/esm/models/TestDatasetWiseResult.d.ts +6 -0
  57. package/dist/esm/models/TestDatasetWiseResult.js +2 -0
  58. package/dist/esm/models/TestPlan.d.ts +7 -0
  59. package/dist/esm/models/TestPlan.js +2 -0
  60. package/dist/esm/models/TestPlanBulkActionPayload.d.ts +6 -0
  61. package/dist/esm/models/TestPlanBulkActionPayload.js +2 -0
  62. package/dist/esm/models/TestPlanPayload.d.ts +6 -0
  63. package/dist/esm/models/TestPlanPayload.js +2 -0
  64. package/dist/esm/models/TraceabilityMatrixPayload.d.ts +7 -0
  65. package/dist/esm/models/TraceabilityMatrixPayload.js +2 -0
  66. package/dist/esm/models/index.d.ts +21 -0
  67. package/dist/esm/models/index.js +21 -0
  68. package/dist/models/Activity.d.ts +9 -0
  69. package/dist/models/Activity.js +6 -1
  70. package/dist/models/ActivityAuditInfo.d.ts +44 -0
  71. package/dist/models/ActivityAuditInfo.js +52 -0
  72. package/dist/models/Release.d.ts +131 -0
  73. package/dist/models/Release.js +103 -0
  74. package/dist/models/ReleaseGoNoGoThreshold.d.ts +45 -0
  75. package/dist/models/ReleaseGoNoGoThreshold.js +52 -0
  76. package/dist/models/ReleaseMinified.d.ts +67 -0
  77. package/dist/models/ReleaseMinified.js +73 -0
  78. package/dist/models/ReleasePayload.d.ts +98 -0
  79. package/dist/models/ReleasePayload.js +83 -0
  80. package/dist/models/ReleaseReadiness.d.ts +106 -0
  81. package/dist/models/ReleaseReadiness.js +86 -0
  82. package/dist/models/ReleaseReadinessComparison.d.ts +52 -0
  83. package/dist/models/ReleaseReadinessComparison.js +54 -0
  84. package/dist/models/ReleaseReadinessConfigurationCoverage.d.ts +84 -0
  85. package/dist/models/ReleaseReadinessConfigurationCoverage.js +78 -0
  86. package/dist/models/ReleaseReadinessCoverageItem.d.ts +75 -0
  87. package/dist/models/ReleaseReadinessCoverageItem.js +72 -0
  88. package/dist/models/ReleaseReadinessCustomFieldCoverage.d.ts +77 -0
  89. package/dist/models/ReleaseReadinessCustomFieldCoverage.js +83 -0
  90. package/dist/models/ReleaseReadinessCustomFieldGroup.d.ts +75 -0
  91. package/dist/models/ReleaseReadinessCustomFieldGroup.js +76 -0
  92. package/dist/models/ReleaseReadinessDefectSeverity.d.ts +38 -0
  93. package/dist/models/ReleaseReadinessDefectSeverity.js +54 -0
  94. package/dist/models/ReleaseReadinessDefects.d.ts +46 -0
  95. package/dist/models/ReleaseReadinessDefects.js +59 -0
  96. package/dist/models/ReleaseReadinessEvidence.d.ts +45 -0
  97. package/dist/models/ReleaseReadinessEvidence.js +58 -0
  98. package/dist/models/ReleaseReadinessRequirementCoverage.d.ts +41 -0
  99. package/dist/models/ReleaseReadinessRequirementCoverage.js +55 -0
  100. package/dist/models/ReleaseReadinessRequirementItem.d.ts +92 -0
  101. package/dist/models/ReleaseReadinessRequirementItem.js +92 -0
  102. package/dist/models/ReleaseReadinessRequirementSummary.d.ts +57 -0
  103. package/dist/models/ReleaseReadinessRequirementSummary.js +66 -0
  104. package/dist/models/ReleaseReadinessSummary.d.ts +70 -0
  105. package/dist/models/ReleaseReadinessSummary.js +58 -0
  106. package/dist/models/ReleaseReadinessTestPlan.d.ts +69 -0
  107. package/dist/models/ReleaseReadinessTestPlan.js +76 -0
  108. package/dist/models/ReleaseReadinessTestPlanRun.d.ts +51 -0
  109. package/dist/models/ReleaseReadinessTestPlanRun.js +58 -0
  110. package/dist/models/ReleaseReadinessVerdict.d.ts +50 -0
  111. package/dist/models/ReleaseReadinessVerdict.js +64 -0
  112. package/dist/models/StepWiseResult.d.ts +6 -0
  113. package/dist/models/StepWiseResult.js +2 -0
  114. package/dist/models/TestDatasetWiseResult.d.ts +6 -0
  115. package/dist/models/TestDatasetWiseResult.js +2 -0
  116. package/dist/models/TestPlan.d.ts +7 -0
  117. package/dist/models/TestPlan.js +2 -0
  118. package/dist/models/TestPlanBulkActionPayload.d.ts +6 -0
  119. package/dist/models/TestPlanBulkActionPayload.js +2 -0
  120. package/dist/models/TestPlanPayload.d.ts +6 -0
  121. package/dist/models/TestPlanPayload.js +2 -0
  122. package/dist/models/TraceabilityMatrixPayload.d.ts +7 -0
  123. package/dist/models/TraceabilityMatrixPayload.js +2 -0
  124. package/dist/models/index.d.ts +21 -0
  125. package/dist/models/index.js +21 -0
  126. package/docs/Activity.md +2 -0
  127. package/docs/ActivityAuditInfo.md +39 -0
  128. package/docs/Release.md +62 -0
  129. package/docs/ReleaseGoNoGoThreshold.md +39 -0
  130. package/docs/ReleaseMinified.md +42 -0
  131. package/docs/ReleasePayload.md +52 -0
  132. package/docs/ReleaseReadiness.md +55 -0
  133. package/docs/ReleaseReadinessComparison.md +41 -0
  134. package/docs/ReleaseReadinessConfigurationCoverage.md +51 -0
  135. package/docs/ReleaseReadinessCoverageItem.md +49 -0
  136. package/docs/ReleaseReadinessCustomFieldCoverage.md +43 -0
  137. package/docs/ReleaseReadinessCustomFieldGroup.md +49 -0
  138. package/docs/ReleaseReadinessDefectSeverity.md +36 -0
  139. package/docs/ReleaseReadinessDefects.md +39 -0
  140. package/docs/ReleaseReadinessEvidence.md +39 -0
  141. package/docs/ReleaseReadinessRequirementCoverage.md +37 -0
  142. package/docs/ReleaseReadinessRequirementItem.md +51 -0
  143. package/docs/ReleaseReadinessRequirementSummary.md +43 -0
  144. package/docs/ReleaseReadinessSummary.md +47 -0
  145. package/docs/ReleaseReadinessTestPlan.md +43 -0
  146. package/docs/ReleaseReadinessTestPlanRun.md +41 -0
  147. package/docs/ReleaseReadinessVerdict.md +37 -0
  148. package/docs/ReleasesApi.md +655 -0
  149. package/docs/StepWiseResult.md +2 -0
  150. package/docs/TestDatasetWiseResult.md +2 -0
  151. package/docs/TestPlan.md +2 -0
  152. package/docs/TestPlanBulkActionPayload.md +2 -0
  153. package/docs/TestPlanPayload.md +2 -0
  154. package/docs/TraceabilityMatrixPayload.md +2 -0
  155. package/package.json +1 -1
  156. package/src/apis/ReleasesApi.ts +663 -0
  157. package/src/apis/index.ts +1 -0
  158. package/src/models/Activity.ts +18 -1
  159. package/src/models/ActivityAuditInfo.ts +81 -0
  160. package/src/models/Release.ts +227 -0
  161. package/src/models/ReleaseGoNoGoThreshold.ts +82 -0
  162. package/src/models/ReleaseMinified.ts +114 -0
  163. package/src/models/ReleasePayload.ts +162 -0
  164. package/src/models/ReleaseReadiness.ts +233 -0
  165. package/src/models/ReleaseReadinessComparison.ts +98 -0
  166. package/src/models/ReleaseReadinessConfigurationCoverage.ts +138 -0
  167. package/src/models/ReleaseReadinessCoverageItem.ts +127 -0
  168. package/src/models/ReleaseReadinessCustomFieldCoverage.ts +133 -0
  169. package/src/models/ReleaseReadinessCustomFieldGroup.ts +129 -0
  170. package/src/models/ReleaseReadinessDefectSeverity.ts +75 -0
  171. package/src/models/ReleaseReadinessDefects.ts +93 -0
  172. package/src/models/ReleaseReadinessEvidence.ts +85 -0
  173. package/src/models/ReleaseReadinessRequirementCoverage.ts +91 -0
  174. package/src/models/ReleaseReadinessRequirementItem.ts +153 -0
  175. package/src/models/ReleaseReadinessRequirementSummary.ts +103 -0
  176. package/src/models/ReleaseReadinessSummary.ts +124 -0
  177. package/src/models/ReleaseReadinessTestPlan.ts +131 -0
  178. package/src/models/ReleaseReadinessTestPlanRun.ts +92 -0
  179. package/src/models/ReleaseReadinessVerdict.ts +90 -0
  180. package/src/models/StepWiseResult.ts +8 -0
  181. package/src/models/TestDatasetWiseResult.ts +8 -0
  182. package/src/models/TestPlan.ts +15 -0
  183. package/src/models/TestPlanBulkActionPayload.ts +8 -0
  184. package/src/models/TestPlanPayload.ts +8 -0
  185. package/src/models/TraceabilityMatrixPayload.ts +9 -0
  186. package/src/models/index.ts +21 -0
@@ -11,6 +11,7 @@
11
11
  */
12
12
  import type { ProjectMini } from './ProjectMini';
13
13
  import type { User } from './User';
14
+ import type { ActivityAuditInfo } from './ActivityAuditInfo';
14
15
  /**
15
16
  *
16
17
  * @export
@@ -65,6 +66,12 @@ export interface Activity {
65
66
  * @memberof Activity
66
67
  */
67
68
  user: User;
69
+ /**
70
+ *
71
+ * @type {ActivityAuditInfo}
72
+ * @memberof Activity
73
+ */
74
+ auditInfo?: ActivityAuditInfo;
68
75
  /**
69
76
  * Time when the activity was performed
70
77
  * @type {string}
@@ -94,6 +101,8 @@ export declare const ActivityActivityTypeEnum: {
94
101
  readonly FinishedRun: "finished_run";
95
102
  readonly AssigneeChange: "assignee_change";
96
103
  readonly Comment: "comment";
104
+ readonly ReleaseVerdictChange: "release_verdict_change";
105
+ readonly Link: "link";
97
106
  };
98
107
  export type ActivityActivityTypeEnum = typeof ActivityActivityTypeEnum[keyof typeof ActivityActivityTypeEnum];
99
108
  /**
@@ -13,6 +13,7 @@
13
13
  */
14
14
  import { ProjectMiniFromJSON, ProjectMiniToJSON, } from './ProjectMini';
15
15
  import { UserFromJSON, UserToJSON, } from './User';
16
+ import { ActivityAuditInfoFromJSON, ActivityAuditInfoToJSON, } from './ActivityAuditInfo';
16
17
  /**
17
18
  * @export
18
19
  */
@@ -28,7 +29,9 @@ export const ActivityActivityTypeEnum = {
28
29
  Reopen: 'reopen',
29
30
  FinishedRun: 'finished_run',
30
31
  AssigneeChange: 'assignee_change',
31
- Comment: 'comment'
32
+ Comment: 'comment',
33
+ ReleaseVerdictChange: 'release_verdict_change',
34
+ Link: 'link'
32
35
  };
33
36
  /**
34
37
  * Check if a given object implements the Activity interface.
@@ -62,6 +65,7 @@ export function ActivityFromJSONTyped(json, ignoreDiscriminator) {
62
65
  'project': json['project'] == null ? undefined : ProjectMiniFromJSON(json['project']),
63
66
  'activityType': json['activity_type'],
64
67
  'user': UserFromJSON(json['user']),
68
+ 'auditInfo': json['audit_info'] == null ? undefined : ActivityAuditInfoFromJSON(json['audit_info']),
65
69
  'createdAt': json['created_at'] == null ? undefined : json['created_at'],
66
70
  'updatedAt': json['updated_at'] == null ? undefined : json['updated_at'],
67
71
  };
@@ -82,6 +86,7 @@ export function ActivityToJSONTyped(value, ignoreDiscriminator = false) {
82
86
  'project': ProjectMiniToJSON(value['project']),
83
87
  'activity_type': value['activityType'],
84
88
  'user': UserToJSON(value['user']),
89
+ 'audit_info': ActivityAuditInfoToJSON(value['auditInfo']),
85
90
  'created_at': value['createdAt'],
86
91
  'updated_at': value['updatedAt'],
87
92
  };
@@ -0,0 +1,44 @@
1
+ /**
2
+ * TC API
3
+ * TestCollab is a test management tool that helps development teams carry out testing effectively and avoid failures. # Introduction This is an API documentation for TestCollab 2. # Authentication TestCollab supports two forms of authentication: - An <b>API token</b> is required to make API calls. The token can be generated from user\'s profile; to obtain it login to your TestCollab account and go to [\'My Profile Settings\'](https://testcollab.io/my_profile) and switch to API Token tab. Click on \"Generate new API token\", Once the token is generated it can be sent as a query parameter for the API calls made - https://api.testcollab.io/projects?token=<generated-API-token> - <b>Bearer authentication</b> (also called token authentication) is an HTTP authentication scheme that involves security tokens called bearer tokens. You can generate bearer auth token using [Login](#operation/login) API. Send this token as the Authorization header while making requests to protected resources: `Authorization: Bearer <token>` For making API calls, we recommend using the <b>API token</b> generated from user profile page as it won\'t affect the on-going user session and will be available until it is revoked by the user who generated it. # Error Handling Error responses - `Not Found` - Error is sent when requested resource is not available. - `Unauthorized - invalid token` - Error is sent when API token sent with the request is invalid or revoked. Error contains status code 401 - `Forbidden` - Error is sent when logged in user is not part of the company, project or his role does not allow to complete given action. Response consist of 403 status code and more information is given in error message.
4
+ *
5
+ * The version of the OpenAPI document: 2.3.1
6
+ * Contact: support@testcollab.com
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ * Additional metadata for the activity (e.g. release name, old/new verdict)
14
+ * @export
15
+ * @interface ActivityAuditInfo
16
+ */
17
+ export interface ActivityAuditInfo {
18
+ /**
19
+ * Name of the release
20
+ * @type {string}
21
+ * @memberof ActivityAuditInfo
22
+ */
23
+ releaseName?: string;
24
+ /**
25
+ * Previous verdict value
26
+ * @type {string}
27
+ * @memberof ActivityAuditInfo
28
+ */
29
+ oldVerdict?: string;
30
+ /**
31
+ * New verdict value
32
+ * @type {string}
33
+ * @memberof ActivityAuditInfo
34
+ */
35
+ newVerdict?: string;
36
+ }
37
+ /**
38
+ * Check if a given object implements the ActivityAuditInfo interface.
39
+ */
40
+ export declare function instanceOfActivityAuditInfo(value: object): value is ActivityAuditInfo;
41
+ export declare function ActivityAuditInfoFromJSON(json: any): ActivityAuditInfo;
42
+ export declare function ActivityAuditInfoFromJSONTyped(json: any, ignoreDiscriminator: boolean): ActivityAuditInfo;
43
+ export declare function ActivityAuditInfoToJSON(json: any): ActivityAuditInfo;
44
+ export declare function ActivityAuditInfoToJSONTyped(value?: ActivityAuditInfo | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,45 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * TC API
5
+ * TestCollab is a test management tool that helps development teams carry out testing effectively and avoid failures. # Introduction This is an API documentation for TestCollab 2. # Authentication TestCollab supports two forms of authentication: - An <b>API token</b> is required to make API calls. The token can be generated from user\'s profile; to obtain it login to your TestCollab account and go to [\'My Profile Settings\'](https://testcollab.io/my_profile) and switch to API Token tab. Click on \"Generate new API token\", Once the token is generated it can be sent as a query parameter for the API calls made - https://api.testcollab.io/projects?token=<generated-API-token> - <b>Bearer authentication</b> (also called token authentication) is an HTTP authentication scheme that involves security tokens called bearer tokens. You can generate bearer auth token using [Login](#operation/login) API. Send this token as the Authorization header while making requests to protected resources: `Authorization: Bearer <token>` For making API calls, we recommend using the <b>API token</b> generated from user profile page as it won\'t affect the on-going user session and will be available until it is revoked by the user who generated it. # Error Handling Error responses - `Not Found` - Error is sent when requested resource is not available. - `Unauthorized - invalid token` - Error is sent when API token sent with the request is invalid or revoked. Error contains status code 401 - `Forbidden` - Error is sent when logged in user is not part of the company, project or his role does not allow to complete given action. Response consist of 403 status code and more information is given in error message.
6
+ *
7
+ * The version of the OpenAPI document: 2.3.1
8
+ * Contact: support@testcollab.com
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ /**
15
+ * Check if a given object implements the ActivityAuditInfo interface.
16
+ */
17
+ export function instanceOfActivityAuditInfo(value) {
18
+ return true;
19
+ }
20
+ export function ActivityAuditInfoFromJSON(json) {
21
+ return ActivityAuditInfoFromJSONTyped(json, false);
22
+ }
23
+ export function ActivityAuditInfoFromJSONTyped(json, ignoreDiscriminator) {
24
+ if (json == null) {
25
+ return json;
26
+ }
27
+ return {
28
+ 'releaseName': json['release_name'] == null ? undefined : json['release_name'],
29
+ 'oldVerdict': json['old_verdict'] == null ? undefined : json['old_verdict'],
30
+ 'newVerdict': json['new_verdict'] == null ? undefined : json['new_verdict'],
31
+ };
32
+ }
33
+ export function ActivityAuditInfoToJSON(json) {
34
+ return ActivityAuditInfoToJSONTyped(json, false);
35
+ }
36
+ export function ActivityAuditInfoToJSONTyped(value, ignoreDiscriminator = false) {
37
+ if (value == null) {
38
+ return value;
39
+ }
40
+ return {
41
+ 'release_name': value['releaseName'],
42
+ 'old_verdict': value['oldVerdict'],
43
+ 'new_verdict': value['newVerdict'],
44
+ };
45
+ }
@@ -0,0 +1,131 @@
1
+ /**
2
+ * TC API
3
+ * TestCollab is a test management tool that helps development teams carry out testing effectively and avoid failures. # Introduction This is an API documentation for TestCollab 2. # Authentication TestCollab supports two forms of authentication: - An <b>API token</b> is required to make API calls. The token can be generated from user\'s profile; to obtain it login to your TestCollab account and go to [\'My Profile Settings\'](https://testcollab.io/my_profile) and switch to API Token tab. Click on \"Generate new API token\", Once the token is generated it can be sent as a query parameter for the API calls made - https://api.testcollab.io/projects?token=<generated-API-token> - <b>Bearer authentication</b> (also called token authentication) is an HTTP authentication scheme that involves security tokens called bearer tokens. You can generate bearer auth token using [Login](#operation/login) API. Send this token as the Authorization header while making requests to protected resources: `Authorization: Bearer <token>` For making API calls, we recommend using the <b>API token</b> generated from user profile page as it won\'t affect the on-going user session and will be available until it is revoked by the user who generated it. # Error Handling Error responses - `Not Found` - Error is sent when requested resource is not available. - `Unauthorized - invalid token` - Error is sent when API token sent with the request is invalid or revoked. Error contains status code 401 - `Forbidden` - Error is sent when logged in user is not part of the company, project or his role does not allow to complete given action. Response consist of 403 status code and more information is given in error message.
4
+ *
5
+ * The version of the OpenAPI document: 2.3.1
6
+ * Contact: support@testcollab.com
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { ReleaseGoNoGoThreshold } from './ReleaseGoNoGoThreshold';
13
+ import type { RequirementMinified } from './RequirementMinified';
14
+ import type { UserMinified } from './UserMinified';
15
+ import type { TestPlanMinified } from './TestPlanMinified';
16
+ /**
17
+ *
18
+ * @export
19
+ * @interface Release
20
+ */
21
+ export interface Release {
22
+ /**
23
+ *
24
+ * @type {number}
25
+ * @memberof Release
26
+ */
27
+ id: number;
28
+ /**
29
+ *
30
+ * @type {string}
31
+ * @memberof Release
32
+ */
33
+ name: string;
34
+ /**
35
+ *
36
+ * @type {string}
37
+ * @memberof Release
38
+ */
39
+ description?: string;
40
+ /**
41
+ *
42
+ * @type {string}
43
+ * @memberof Release
44
+ */
45
+ status: ReleaseStatusEnum;
46
+ /**
47
+ *
48
+ * @type {string}
49
+ * @memberof Release
50
+ */
51
+ targetDate?: string;
52
+ /**
53
+ *
54
+ * @type {string}
55
+ * @memberof Release
56
+ */
57
+ releaseDate?: string;
58
+ /**
59
+ *
60
+ * @type {ReleaseGoNoGoThreshold}
61
+ * @memberof Release
62
+ */
63
+ goNoGoThreshold?: ReleaseGoNoGoThreshold;
64
+ /**
65
+ *
66
+ * @type {boolean}
67
+ * @memberof Release
68
+ */
69
+ isPublic?: boolean;
70
+ /**
71
+ *
72
+ * @type {string}
73
+ * @memberof Release
74
+ */
75
+ publicToken?: string;
76
+ /**
77
+ *
78
+ * @type {Array<TestPlanMinified>}
79
+ * @memberof Release
80
+ */
81
+ testPlans?: Array<TestPlanMinified>;
82
+ /**
83
+ * Requirements associated with this release
84
+ * @type {Array<RequirementMinified>}
85
+ * @memberof Release
86
+ */
87
+ requirements?: Array<RequirementMinified>;
88
+ /**
89
+ *
90
+ * @type {number}
91
+ * @memberof Release
92
+ */
93
+ project: number;
94
+ /**
95
+ *
96
+ * @type {UserMinified}
97
+ * @memberof Release
98
+ */
99
+ createdBy: UserMinified;
100
+ /**
101
+ *
102
+ * @type {string}
103
+ * @memberof Release
104
+ */
105
+ createdAt: string;
106
+ /**
107
+ *
108
+ * @type {string}
109
+ * @memberof Release
110
+ */
111
+ updatedAt: string;
112
+ }
113
+ /**
114
+ * @export
115
+ */
116
+ export declare const ReleaseStatusEnum: {
117
+ readonly Planned: "planned";
118
+ readonly InProgress: "in_progress";
119
+ readonly Ready: "ready";
120
+ readonly Shipped: "shipped";
121
+ readonly Blocked: "blocked";
122
+ };
123
+ export type ReleaseStatusEnum = typeof ReleaseStatusEnum[keyof typeof ReleaseStatusEnum];
124
+ /**
125
+ * Check if a given object implements the Release interface.
126
+ */
127
+ export declare function instanceOfRelease(value: object): value is Release;
128
+ export declare function ReleaseFromJSON(json: any): Release;
129
+ export declare function ReleaseFromJSONTyped(json: any, ignoreDiscriminator: boolean): Release;
130
+ export declare function ReleaseToJSON(json: any): Release;
131
+ export declare function ReleaseToJSONTyped(value?: Release | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,95 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * TC API
5
+ * TestCollab is a test management tool that helps development teams carry out testing effectively and avoid failures. # Introduction This is an API documentation for TestCollab 2. # Authentication TestCollab supports two forms of authentication: - An <b>API token</b> is required to make API calls. The token can be generated from user\'s profile; to obtain it login to your TestCollab account and go to [\'My Profile Settings\'](https://testcollab.io/my_profile) and switch to API Token tab. Click on \"Generate new API token\", Once the token is generated it can be sent as a query parameter for the API calls made - https://api.testcollab.io/projects?token=<generated-API-token> - <b>Bearer authentication</b> (also called token authentication) is an HTTP authentication scheme that involves security tokens called bearer tokens. You can generate bearer auth token using [Login](#operation/login) API. Send this token as the Authorization header while making requests to protected resources: `Authorization: Bearer <token>` For making API calls, we recommend using the <b>API token</b> generated from user profile page as it won\'t affect the on-going user session and will be available until it is revoked by the user who generated it. # Error Handling Error responses - `Not Found` - Error is sent when requested resource is not available. - `Unauthorized - invalid token` - Error is sent when API token sent with the request is invalid or revoked. Error contains status code 401 - `Forbidden` - Error is sent when logged in user is not part of the company, project or his role does not allow to complete given action. Response consist of 403 status code and more information is given in error message.
6
+ *
7
+ * The version of the OpenAPI document: 2.3.1
8
+ * Contact: support@testcollab.com
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ import { RequirementMinifiedFromJSON, RequirementMinifiedToJSON, } from './RequirementMinified';
15
+ import { TestPlanMinifiedFromJSON, TestPlanMinifiedToJSON, } from './TestPlanMinified';
16
+ /**
17
+ * @export
18
+ */
19
+ export const ReleaseStatusEnum = {
20
+ Planned: 'planned',
21
+ InProgress: 'in_progress',
22
+ Ready: 'ready',
23
+ Shipped: 'shipped',
24
+ Blocked: 'blocked'
25
+ };
26
+ /**
27
+ * Check if a given object implements the Release interface.
28
+ */
29
+ export function instanceOfRelease(value) {
30
+ if (!('id' in value) || value['id'] === undefined)
31
+ return false;
32
+ if (!('name' in value) || value['name'] === undefined)
33
+ return false;
34
+ if (!('status' in value) || value['status'] === undefined)
35
+ return false;
36
+ if (!('project' in value) || value['project'] === undefined)
37
+ return false;
38
+ if (!('createdBy' in value) || value['createdBy'] === undefined)
39
+ return false;
40
+ if (!('createdAt' in value) || value['createdAt'] === undefined)
41
+ return false;
42
+ if (!('updatedAt' in value) || value['updatedAt'] === undefined)
43
+ return false;
44
+ return true;
45
+ }
46
+ export function ReleaseFromJSON(json) {
47
+ return ReleaseFromJSONTyped(json, false);
48
+ }
49
+ export function ReleaseFromJSONTyped(json, ignoreDiscriminator) {
50
+ if (json == null) {
51
+ return json;
52
+ }
53
+ return {
54
+ 'id': json['id'],
55
+ 'name': json['name'],
56
+ 'description': json['description'] == null ? undefined : json['description'],
57
+ 'status': json['status'],
58
+ 'targetDate': json['target_date'] == null ? undefined : json['target_date'],
59
+ 'releaseDate': json['release_date'] == null ? undefined : json['release_date'],
60
+ 'goNoGoThreshold': json['go_no_go_threshold'] == null ? undefined : json['go_no_go_threshold'],
61
+ 'isPublic': json['is_public'] == null ? undefined : json['is_public'],
62
+ 'publicToken': json['public_token'] == null ? undefined : json['public_token'],
63
+ 'testPlans': json['test_plans'] == null ? undefined : (json['test_plans'].map(TestPlanMinifiedFromJSON)),
64
+ 'requirements': json['requirements'] == null ? undefined : (json['requirements'].map(RequirementMinifiedFromJSON)),
65
+ 'project': json['project'],
66
+ 'createdBy': json['created_by'],
67
+ 'createdAt': json['created_at'],
68
+ 'updatedAt': json['updated_at'],
69
+ };
70
+ }
71
+ export function ReleaseToJSON(json) {
72
+ return ReleaseToJSONTyped(json, false);
73
+ }
74
+ export function ReleaseToJSONTyped(value, ignoreDiscriminator = false) {
75
+ if (value == null) {
76
+ return value;
77
+ }
78
+ return {
79
+ 'id': value['id'],
80
+ 'name': value['name'],
81
+ 'description': value['description'],
82
+ 'status': value['status'],
83
+ 'target_date': value['targetDate'],
84
+ 'release_date': value['releaseDate'],
85
+ 'go_no_go_threshold': value['goNoGoThreshold'],
86
+ 'is_public': value['isPublic'],
87
+ 'public_token': value['publicToken'],
88
+ 'test_plans': value['testPlans'] == null ? undefined : (value['testPlans'].map(TestPlanMinifiedToJSON)),
89
+ 'requirements': value['requirements'] == null ? undefined : (value['requirements'].map(RequirementMinifiedToJSON)),
90
+ 'project': value['project'],
91
+ 'created_by': value['createdBy'],
92
+ 'created_at': value['createdAt'],
93
+ 'updated_at': value['updatedAt'],
94
+ };
95
+ }
@@ -0,0 +1,45 @@
1
+ /**
2
+ * TC API
3
+ * TestCollab is a test management tool that helps development teams carry out testing effectively and avoid failures. # Introduction This is an API documentation for TestCollab 2. # Authentication TestCollab supports two forms of authentication: - An <b>API token</b> is required to make API calls. The token can be generated from user\'s profile; to obtain it login to your TestCollab account and go to [\'My Profile Settings\'](https://testcollab.io/my_profile) and switch to API Token tab. Click on \"Generate new API token\", Once the token is generated it can be sent as a query parameter for the API calls made - https://api.testcollab.io/projects?token=<generated-API-token> - <b>Bearer authentication</b> (also called token authentication) is an HTTP authentication scheme that involves security tokens called bearer tokens. You can generate bearer auth token using [Login](#operation/login) API. Send this token as the Authorization header while making requests to protected resources: `Authorization: Bearer <token>` For making API calls, we recommend using the <b>API token</b> generated from user profile page as it won\'t affect the on-going user session and will be available until it is revoked by the user who generated it. # Error Handling Error responses - `Not Found` - Error is sent when requested resource is not available. - `Unauthorized - invalid token` - Error is sent when API token sent with the request is invalid or revoked. Error contains status code 401 - `Forbidden` - Error is sent when logged in user is not part of the company, project or his role does not allow to complete given action. Response consist of 403 status code and more information is given in error message.
4
+ *
5
+ * The version of the OpenAPI document: 2.3.1
6
+ * Contact: support@testcollab.com
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ * Configurable thresholds that determine the auto-computed Go/No-Go verdict for a release. All fields are optional — only configured thresholds are evaluated.
14
+ *
15
+ * @export
16
+ * @interface ReleaseGoNoGoThreshold
17
+ */
18
+ export interface ReleaseGoNoGoThreshold {
19
+ /**
20
+ * Minimum overall pass rate percentage required for a Go verdict
21
+ * @type {number}
22
+ * @memberof ReleaseGoNoGoThreshold
23
+ */
24
+ minPassRate?: number;
25
+ /**
26
+ * Maximum number of total open defects allowed across all severities
27
+ * @type {number}
28
+ * @memberof ReleaseGoNoGoThreshold
29
+ */
30
+ maxOpenDefects?: number;
31
+ /**
32
+ * Minimum percentage of failed executions that must have attachments
33
+ * @type {number}
34
+ * @memberof ReleaseGoNoGoThreshold
35
+ */
36
+ minEvidenceCoverage?: number;
37
+ }
38
+ /**
39
+ * Check if a given object implements the ReleaseGoNoGoThreshold interface.
40
+ */
41
+ export declare function instanceOfReleaseGoNoGoThreshold(value: object): value is ReleaseGoNoGoThreshold;
42
+ export declare function ReleaseGoNoGoThresholdFromJSON(json: any): ReleaseGoNoGoThreshold;
43
+ export declare function ReleaseGoNoGoThresholdFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReleaseGoNoGoThreshold;
44
+ export declare function ReleaseGoNoGoThresholdToJSON(json: any): ReleaseGoNoGoThreshold;
45
+ export declare function ReleaseGoNoGoThresholdToJSONTyped(value?: ReleaseGoNoGoThreshold | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,45 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * TC API
5
+ * TestCollab is a test management tool that helps development teams carry out testing effectively and avoid failures. # Introduction This is an API documentation for TestCollab 2. # Authentication TestCollab supports two forms of authentication: - An <b>API token</b> is required to make API calls. The token can be generated from user\'s profile; to obtain it login to your TestCollab account and go to [\'My Profile Settings\'](https://testcollab.io/my_profile) and switch to API Token tab. Click on \"Generate new API token\", Once the token is generated it can be sent as a query parameter for the API calls made - https://api.testcollab.io/projects?token=<generated-API-token> - <b>Bearer authentication</b> (also called token authentication) is an HTTP authentication scheme that involves security tokens called bearer tokens. You can generate bearer auth token using [Login](#operation/login) API. Send this token as the Authorization header while making requests to protected resources: `Authorization: Bearer <token>` For making API calls, we recommend using the <b>API token</b> generated from user profile page as it won\'t affect the on-going user session and will be available until it is revoked by the user who generated it. # Error Handling Error responses - `Not Found` - Error is sent when requested resource is not available. - `Unauthorized - invalid token` - Error is sent when API token sent with the request is invalid or revoked. Error contains status code 401 - `Forbidden` - Error is sent when logged in user is not part of the company, project or his role does not allow to complete given action. Response consist of 403 status code and more information is given in error message.
6
+ *
7
+ * The version of the OpenAPI document: 2.3.1
8
+ * Contact: support@testcollab.com
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ /**
15
+ * Check if a given object implements the ReleaseGoNoGoThreshold interface.
16
+ */
17
+ export function instanceOfReleaseGoNoGoThreshold(value) {
18
+ return true;
19
+ }
20
+ export function ReleaseGoNoGoThresholdFromJSON(json) {
21
+ return ReleaseGoNoGoThresholdFromJSONTyped(json, false);
22
+ }
23
+ export function ReleaseGoNoGoThresholdFromJSONTyped(json, ignoreDiscriminator) {
24
+ if (json == null) {
25
+ return json;
26
+ }
27
+ return {
28
+ 'minPassRate': json['min_pass_rate'] == null ? undefined : json['min_pass_rate'],
29
+ 'maxOpenDefects': json['max_open_defects'] == null ? undefined : json['max_open_defects'],
30
+ 'minEvidenceCoverage': json['min_evidence_coverage'] == null ? undefined : json['min_evidence_coverage'],
31
+ };
32
+ }
33
+ export function ReleaseGoNoGoThresholdToJSON(json) {
34
+ return ReleaseGoNoGoThresholdToJSONTyped(json, false);
35
+ }
36
+ export function ReleaseGoNoGoThresholdToJSONTyped(value, ignoreDiscriminator = false) {
37
+ if (value == null) {
38
+ return value;
39
+ }
40
+ return {
41
+ 'min_pass_rate': value['minPassRate'],
42
+ 'max_open_defects': value['maxOpenDefects'],
43
+ 'min_evidence_coverage': value['minEvidenceCoverage'],
44
+ };
45
+ }
@@ -0,0 +1,67 @@
1
+ /**
2
+ * TC API
3
+ * TestCollab is a test management tool that helps development teams carry out testing effectively and avoid failures. # Introduction This is an API documentation for TestCollab 2. # Authentication TestCollab supports two forms of authentication: - An <b>API token</b> is required to make API calls. The token can be generated from user\'s profile; to obtain it login to your TestCollab account and go to [\'My Profile Settings\'](https://testcollab.io/my_profile) and switch to API Token tab. Click on \"Generate new API token\", Once the token is generated it can be sent as a query parameter for the API calls made - https://api.testcollab.io/projects?token=<generated-API-token> - <b>Bearer authentication</b> (also called token authentication) is an HTTP authentication scheme that involves security tokens called bearer tokens. You can generate bearer auth token using [Login](#operation/login) API. Send this token as the Authorization header while making requests to protected resources: `Authorization: Bearer <token>` For making API calls, we recommend using the <b>API token</b> generated from user profile page as it won\'t affect the on-going user session and will be available until it is revoked by the user who generated it. # Error Handling Error responses - `Not Found` - Error is sent when requested resource is not available. - `Unauthorized - invalid token` - Error is sent when API token sent with the request is invalid or revoked. Error contains status code 401 - `Forbidden` - Error is sent when logged in user is not part of the company, project or his role does not allow to complete given action. Response consist of 403 status code and more information is given in error message.
4
+ *
5
+ * The version of the OpenAPI document: 2.3.1
6
+ * Contact: support@testcollab.com
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface ReleaseMinified
16
+ */
17
+ export interface ReleaseMinified {
18
+ /**
19
+ *
20
+ * @type {number}
21
+ * @memberof ReleaseMinified
22
+ */
23
+ id: number;
24
+ /**
25
+ *
26
+ * @type {string}
27
+ * @memberof ReleaseMinified
28
+ */
29
+ name: string;
30
+ /**
31
+ *
32
+ * @type {string}
33
+ * @memberof ReleaseMinified
34
+ */
35
+ status: ReleaseMinifiedStatusEnum;
36
+ /**
37
+ *
38
+ * @type {string}
39
+ * @memberof ReleaseMinified
40
+ */
41
+ targetDate?: string;
42
+ /**
43
+ *
44
+ * @type {string}
45
+ * @memberof ReleaseMinified
46
+ */
47
+ createdAt?: string;
48
+ }
49
+ /**
50
+ * @export
51
+ */
52
+ export declare const ReleaseMinifiedStatusEnum: {
53
+ readonly Planned: "planned";
54
+ readonly InProgress: "in_progress";
55
+ readonly Ready: "ready";
56
+ readonly Shipped: "shipped";
57
+ readonly Blocked: "blocked";
58
+ };
59
+ export type ReleaseMinifiedStatusEnum = typeof ReleaseMinifiedStatusEnum[keyof typeof ReleaseMinifiedStatusEnum];
60
+ /**
61
+ * Check if a given object implements the ReleaseMinified interface.
62
+ */
63
+ export declare function instanceOfReleaseMinified(value: object): value is ReleaseMinified;
64
+ export declare function ReleaseMinifiedFromJSON(json: any): ReleaseMinified;
65
+ export declare function ReleaseMinifiedFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReleaseMinified;
66
+ export declare function ReleaseMinifiedToJSON(json: any): ReleaseMinified;
67
+ export declare function ReleaseMinifiedToJSONTyped(value?: ReleaseMinified | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,65 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * TC API
5
+ * TestCollab is a test management tool that helps development teams carry out testing effectively and avoid failures. # Introduction This is an API documentation for TestCollab 2. # Authentication TestCollab supports two forms of authentication: - An <b>API token</b> is required to make API calls. The token can be generated from user\'s profile; to obtain it login to your TestCollab account and go to [\'My Profile Settings\'](https://testcollab.io/my_profile) and switch to API Token tab. Click on \"Generate new API token\", Once the token is generated it can be sent as a query parameter for the API calls made - https://api.testcollab.io/projects?token=<generated-API-token> - <b>Bearer authentication</b> (also called token authentication) is an HTTP authentication scheme that involves security tokens called bearer tokens. You can generate bearer auth token using [Login](#operation/login) API. Send this token as the Authorization header while making requests to protected resources: `Authorization: Bearer <token>` For making API calls, we recommend using the <b>API token</b> generated from user profile page as it won\'t affect the on-going user session and will be available until it is revoked by the user who generated it. # Error Handling Error responses - `Not Found` - Error is sent when requested resource is not available. - `Unauthorized - invalid token` - Error is sent when API token sent with the request is invalid or revoked. Error contains status code 401 - `Forbidden` - Error is sent when logged in user is not part of the company, project or his role does not allow to complete given action. Response consist of 403 status code and more information is given in error message.
6
+ *
7
+ * The version of the OpenAPI document: 2.3.1
8
+ * Contact: support@testcollab.com
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ /**
15
+ * @export
16
+ */
17
+ export const ReleaseMinifiedStatusEnum = {
18
+ Planned: 'planned',
19
+ InProgress: 'in_progress',
20
+ Ready: 'ready',
21
+ Shipped: 'shipped',
22
+ Blocked: 'blocked'
23
+ };
24
+ /**
25
+ * Check if a given object implements the ReleaseMinified interface.
26
+ */
27
+ export function instanceOfReleaseMinified(value) {
28
+ if (!('id' in value) || value['id'] === undefined)
29
+ return false;
30
+ if (!('name' in value) || value['name'] === undefined)
31
+ return false;
32
+ if (!('status' in value) || value['status'] === undefined)
33
+ return false;
34
+ return true;
35
+ }
36
+ export function ReleaseMinifiedFromJSON(json) {
37
+ return ReleaseMinifiedFromJSONTyped(json, false);
38
+ }
39
+ export function ReleaseMinifiedFromJSONTyped(json, ignoreDiscriminator) {
40
+ if (json == null) {
41
+ return json;
42
+ }
43
+ return {
44
+ 'id': json['id'],
45
+ 'name': json['name'],
46
+ 'status': json['status'],
47
+ 'targetDate': json['target_date'] == null ? undefined : json['target_date'],
48
+ 'createdAt': json['created_at'] == null ? undefined : json['created_at'],
49
+ };
50
+ }
51
+ export function ReleaseMinifiedToJSON(json) {
52
+ return ReleaseMinifiedToJSONTyped(json, false);
53
+ }
54
+ export function ReleaseMinifiedToJSONTyped(value, ignoreDiscriminator = false) {
55
+ if (value == null) {
56
+ return value;
57
+ }
58
+ return {
59
+ 'id': value['id'],
60
+ 'name': value['name'],
61
+ 'status': value['status'],
62
+ 'target_date': value['targetDate'],
63
+ 'created_at': value['createdAt'],
64
+ };
65
+ }