@resolution/jira-api-client 0.1.0 → 0.1.2

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 (201) hide show
  1. package/CHANGELOG.md +22 -0
  2. package/package.json +10 -3
  3. package/.eslintrc.js +0 -3
  4. package/config/api-typescript-generator.config.ts +0 -91
  5. package/config/compare-schemas.ts +0 -307
  6. package/src/index.ts +0 -47
  7. package/src/openapi/platform/base-jira-platform-api-client.ts +0 -2298
  8. package/src/openapi/platform/core/common-http-client.ts +0 -723
  9. package/src/openapi/platform/core/common-http-service.ts +0 -22
  10. package/src/openapi/platform/core/common-validation-schema-storage.ts +0 -105
  11. package/src/openapi/platform/models/announcement-banner.ts +0 -59
  12. package/src/openapi/platform/models/app-data-policies.ts +0 -79
  13. package/src/openapi/platform/models/app-migration.ts +0 -172
  14. package/src/openapi/platform/models/app-properties.ts +0 -32
  15. package/src/openapi/platform/models/audit-records.ts +0 -140
  16. package/src/openapi/platform/models/avatars.ts +0 -48
  17. package/src/openapi/platform/models/classification-levels.ts +0 -58
  18. package/src/openapi/platform/models/common.ts +0 -2669
  19. package/src/openapi/platform/models/dashboards.ts +0 -849
  20. package/src/openapi/platform/models/dynamic-modules.ts +0 -121
  21. package/src/openapi/platform/models/filter-sharing.ts +0 -103
  22. package/src/openapi/platform/models/filters.ts +0 -319
  23. package/src/openapi/platform/models/group-and-user-picker.ts +0 -85
  24. package/src/openapi/platform/models/groups.ts +0 -247
  25. package/src/openapi/platform/models/issue-attachments.ts +0 -290
  26. package/src/openapi/platform/models/issue-comment-properties.ts +0 -27
  27. package/src/openapi/platform/models/issue-comments.ts +0 -91
  28. package/src/openapi/platform/models/issue-custom-field-configuration-apps.ts +0 -96
  29. package/src/openapi/platform/models/issue-custom-field-contexts.ts +0 -1072
  30. package/src/openapi/platform/models/issue-custom-field-options-apps.ts +0 -273
  31. package/src/openapi/platform/models/issue-custom-field-options.ts +0 -283
  32. package/src/openapi/platform/models/issue-custom-field-values-apps.ts +0 -118
  33. package/src/openapi/platform/models/issue-field-configurations.ts +0 -435
  34. package/src/openapi/platform/models/issue-fields.ts +0 -392
  35. package/src/openapi/platform/models/issue-link-types.ts +0 -28
  36. package/src/openapi/platform/models/issue-links.ts +0 -185
  37. package/src/openapi/platform/models/issue-notification-schemes.ts +0 -370
  38. package/src/openapi/platform/models/issue-priorities.ts +0 -196
  39. package/src/openapi/platform/models/issue-properties.ts +0 -259
  40. package/src/openapi/platform/models/issue-remote-links.ts +0 -207
  41. package/src/openapi/platform/models/issue-resolutions.ts +0 -180
  42. package/src/openapi/platform/models/issue-search.ts +0 -367
  43. package/src/openapi/platform/models/issue-security-level.ts +0 -76
  44. package/src/openapi/platform/models/issue-security-schemes.ts +0 -496
  45. package/src/openapi/platform/models/issue-type-schemes.ts +0 -290
  46. package/src/openapi/platform/models/issue-type-screen-schemes.ts +0 -286
  47. package/src/openapi/platform/models/issue-types.ts +0 -66
  48. package/src/openapi/platform/models/issue-votes.ts +0 -38
  49. package/src/openapi/platform/models/issue-watchers.ts +0 -67
  50. package/src/openapi/platform/models/issue-worklogs.ts +0 -190
  51. package/src/openapi/platform/models/issues.ts +0 -1268
  52. package/src/openapi/platform/models/jira-expressions.ts +0 -578
  53. package/src/openapi/platform/models/jira-settings.ts +0 -118
  54. package/src/openapi/platform/models/jql-functions-apps.ts +0 -128
  55. package/src/openapi/platform/models/jql.ts +0 -783
  56. package/src/openapi/platform/models/labels.ts +0 -42
  57. package/src/openapi/platform/models/license-metrics.ts +0 -68
  58. package/src/openapi/platform/models/myself.ts +0 -29
  59. package/src/openapi/platform/models/permission-schemes.ts +0 -89
  60. package/src/openapi/platform/models/permissions.ts +0 -308
  61. package/src/openapi/platform/models/priority-schemes.ts +0 -527
  62. package/src/openapi/platform/models/project-avatars.ts +0 -29
  63. package/src/openapi/platform/models/project-classification-levels.ts +0 -24
  64. package/src/openapi/platform/models/project-components.ts +0 -231
  65. package/src/openapi/platform/models/project-email.ts +0 -27
  66. package/src/openapi/platform/models/project-features.ts +0 -78
  67. package/src/openapi/platform/models/project-permission-schemes.ts +0 -43
  68. package/src/openapi/platform/models/project-role-actors.ts +0 -107
  69. package/src/openapi/platform/models/project-roles.ts +0 -76
  70. package/src/openapi/platform/models/project-types.ts +0 -36
  71. package/src/openapi/platform/models/project-versions.ts +0 -216
  72. package/src/openapi/platform/models/projects.ts +0 -429
  73. package/src/openapi/platform/models/screen-schemes.ts +0 -192
  74. package/src/openapi/platform/models/screen-tab-fields.ts +0 -45
  75. package/src/openapi/platform/models/screens.ts +0 -171
  76. package/src/openapi/platform/models/server-info.ts +0 -100
  77. package/src/openapi/platform/models/service-registry.ts +0 -68
  78. package/src/openapi/platform/models/status.ts +0 -229
  79. package/src/openapi/platform/models/time-tracking.ts +0 -38
  80. package/src/openapi/platform/models/ui-modifications-apps.ts +0 -229
  81. package/src/openapi/platform/models/user-search.ts +0 -69
  82. package/src/openapi/platform/models/users.ts +0 -121
  83. package/src/openapi/platform/models/webhooks.ts +0 -307
  84. package/src/openapi/platform/models/workflow-scheme-drafts.ts +0 -58
  85. package/src/openapi/platform/models/workflow-scheme-project-associations.ts +0 -68
  86. package/src/openapi/platform/models/workflow-schemes.ts +0 -545
  87. package/src/openapi/platform/models/workflow-transition-properties.ts +0 -33
  88. package/src/openapi/platform/models/workflow-transition-rules.ts +0 -261
  89. package/src/openapi/platform/models/workflows.ts +0 -1943
  90. package/src/openapi/platform/services/announcement-banner-service.ts +0 -142
  91. package/src/openapi/platform/services/app-data-policies-service.ts +0 -136
  92. package/src/openapi/platform/services/app-migration-service.ts +0 -289
  93. package/src/openapi/platform/services/app-properties-service.ts +0 -441
  94. package/src/openapi/platform/services/application-roles-service.ts +0 -247
  95. package/src/openapi/platform/services/audit-records-service.ts +0 -164
  96. package/src/openapi/platform/services/avatars-service.ts +0 -769
  97. package/src/openapi/platform/services/classification-levels-service.ts +0 -131
  98. package/src/openapi/platform/services/dashboards-service.ts +0 -1721
  99. package/src/openapi/platform/services/dynamic-modules-service.ts +0 -127
  100. package/src/openapi/platform/services/filter-sharing-service.ts +0 -687
  101. package/src/openapi/platform/services/filters-service.ts +0 -1901
  102. package/src/openapi/platform/services/group-and-user-picker-service.ts +0 -224
  103. package/src/openapi/platform/services/groups-service.ts +0 -751
  104. package/src/openapi/platform/services/issue-attachments-service.ts +0 -900
  105. package/src/openapi/platform/services/issue-comment-properties-service.ts +0 -324
  106. package/src/openapi/platform/services/issue-comments-service.ts +0 -812
  107. package/src/openapi/platform/services/issue-custom-field-configuration-apps-service.ts +0 -277
  108. package/src/openapi/platform/services/issue-custom-field-contexts-service.ts +0 -1339
  109. package/src/openapi/platform/services/issue-custom-field-options-apps-service.ts +0 -994
  110. package/src/openapi/platform/services/issue-custom-field-options-service.ts +0 -651
  111. package/src/openapi/platform/services/issue-custom-field-values-apps-service.ts +0 -201
  112. package/src/openapi/platform/services/issue-field-configurations-service.ts +0 -1294
  113. package/src/openapi/platform/services/issue-fields-service.ts +0 -837
  114. package/src/openapi/platform/services/issue-link-types-service.ts +0 -360
  115. package/src/openapi/platform/services/issue-links-service.ts +0 -345
  116. package/src/openapi/platform/services/issue-navigator-settings-service.ts +0 -119
  117. package/src/openapi/platform/services/issue-notification-schemes-service.ts +0 -1209
  118. package/src/openapi/platform/services/issue-priorities-service.ts +0 -575
  119. package/src/openapi/platform/services/issue-properties-service.ts +0 -606
  120. package/src/openapi/platform/services/issue-remote-links-service.ts +0 -597
  121. package/src/openapi/platform/services/issue-resolutions-service.ts +0 -534
  122. package/src/openapi/platform/services/issue-search-service.ts +0 -1139
  123. package/src/openapi/platform/services/issue-security-level-service.ts +0 -250
  124. package/src/openapi/platform/services/issue-security-schemes-service.ts +0 -1240
  125. package/src/openapi/platform/services/issue-type-properties-service.ts +0 -325
  126. package/src/openapi/platform/services/issue-type-schemes-service.ts +0 -940
  127. package/src/openapi/platform/services/issue-type-screen-schemes-service.ts +0 -994
  128. package/src/openapi/platform/services/issue-types-service.ts +0 -679
  129. package/src/openapi/platform/services/issue-votes-service.ts +0 -221
  130. package/src/openapi/platform/services/issue-watchers-service.ts +0 -331
  131. package/src/openapi/platform/services/issue-worklog-properties-service.ts +0 -348
  132. package/src/openapi/platform/services/issue-worklogs-service.ts +0 -1089
  133. package/src/openapi/platform/services/issues-service.ts +0 -3346
  134. package/src/openapi/platform/services/jira-expressions-service.ts +0 -407
  135. package/src/openapi/platform/services/jira-settings-service.ts +0 -415
  136. package/src/openapi/platform/services/jql-functions-apps-service.ts +0 -219
  137. package/src/openapi/platform/services/jql-service.ts +0 -896
  138. package/src/openapi/platform/services/labels-service.ts +0 -89
  139. package/src/openapi/platform/services/license-metrics-service.ts +0 -216
  140. package/src/openapi/platform/services/myself-service.ts +0 -520
  141. package/src/openapi/platform/services/permission-schemes-service.ts +0 -926
  142. package/src/openapi/platform/services/permissions-service.ts +0 -407
  143. package/src/openapi/platform/services/priority-schemes-service.ts +0 -1001
  144. package/src/openapi/platform/services/project-avatars-service.ts +0 -341
  145. package/src/openapi/platform/services/project-categories-service.ts +0 -318
  146. package/src/openapi/platform/services/project-classification-levels-service.ts +0 -232
  147. package/src/openapi/platform/services/project-components-service.ts +0 -1332
  148. package/src/openapi/platform/services/project-email-service.ts +0 -161
  149. package/src/openapi/platform/services/project-features-service.ts +0 -207
  150. package/src/openapi/platform/services/project-key-and-name-validation-service.ts +0 -200
  151. package/src/openapi/platform/services/project-permission-schemes-service.ts +0 -384
  152. package/src/openapi/platform/services/project-properties-service.ts +0 -320
  153. package/src/openapi/platform/services/project-role-actors-service.ts +0 -627
  154. package/src/openapi/platform/services/project-roles-service.ts +0 -867
  155. package/src/openapi/platform/services/project-types-service.ts +0 -297
  156. package/src/openapi/platform/services/project-versions-service.ts +0 -1287
  157. package/src/openapi/platform/services/projects-service.ts +0 -2196
  158. package/src/openapi/platform/services/screen-schemes-service.ts +0 -334
  159. package/src/openapi/platform/services/screen-tab-fields-service.ts +0 -276
  160. package/src/openapi/platform/services/screen-tabs-service.ts +0 -421
  161. package/src/openapi/platform/services/screens-service.ts +0 -528
  162. package/src/openapi/platform/services/server-info-service.ts +0 -88
  163. package/src/openapi/platform/services/service-registry-service.ts +0 -89
  164. package/src/openapi/platform/services/status-service.ts +0 -498
  165. package/src/openapi/platform/services/tasks-service.ts +0 -159
  166. package/src/openapi/platform/services/time-tracking-service.ts +0 -386
  167. package/src/openapi/platform/services/ui-modifications-apps-service.ts +0 -403
  168. package/src/openapi/platform/services/user-properties-service.ts +0 -413
  169. package/src/openapi/platform/services/user-search-service.ts +0 -1214
  170. package/src/openapi/platform/services/users-service.ts +0 -1108
  171. package/src/openapi/platform/services/webhooks-service.ts +0 -458
  172. package/src/openapi/platform/services/workflow-scheme-drafts-service.ts +0 -1313
  173. package/src/openapi/platform/services/workflow-scheme-project-associations-service.ts +0 -189
  174. package/src/openapi/platform/services/workflow-schemes-service.ts +0 -1617
  175. package/src/openapi/platform/services/workflow-status-categories-service.ts +0 -151
  176. package/src/openapi/platform/services/workflow-statuses-service.ts +0 -176
  177. package/src/openapi/platform/services/workflow-transition-properties-service.ts +0 -388
  178. package/src/openapi/platform/services/workflow-transition-rules-service.ts +0 -485
  179. package/src/openapi/platform/services/workflows-service.ts +0 -3477
  180. package/src/openapi/platform/validation-schema-storage.ts +0 -186
  181. package/src/openapi/software/base-jira-software-api-client.ts +0 -447
  182. package/src/openapi/software/core/common-http-client.ts +0 -723
  183. package/src/openapi/software/core/common-http-service.ts +0 -22
  184. package/src/openapi/software/core/common-validation-schema-storage.ts +0 -105
  185. package/src/openapi/software/models/board.ts +0 -918
  186. package/src/openapi/software/services/backlog-service.ts +0 -160
  187. package/src/openapi/software/services/board-service.ts +0 -4189
  188. package/src/openapi/software/services/builds-service.ts +0 -571
  189. package/src/openapi/software/services/deployments-service.ts +0 -403
  190. package/src/openapi/software/services/dev-ops-components-service.ts +0 -371
  191. package/src/openapi/software/services/development-information-service.ts +0 -2357
  192. package/src/openapi/software/services/epic-service.ts +0 -854
  193. package/src/openapi/software/services/feature-flags-service.ts +0 -303
  194. package/src/openapi/software/services/issue-service.ts +0 -529
  195. package/src/openapi/software/services/operations-service.ts +0 -741
  196. package/src/openapi/software/services/remote-links-service.ts +0 -653
  197. package/src/openapi/software/services/security-information-service.ts +0 -495
  198. package/src/openapi/software/services/sprint-service.ts +0 -969
  199. package/src/openapi/software/validation-schema-storage.ts +0 -186
  200. package/tsconfig.build.json +0 -7
  201. package/tsconfig.json +0 -4
@@ -1,216 +0,0 @@
1
- // DO NOT EDIT!
2
- // This file is generated by "api-typescript-generator".
3
- // To update this file run "yarn build:openapi".
4
- import { z, type ZodTypeAny } from "zod";
5
-
6
- import type { CommonValidationSchemaStorage } from "../core/common-validation-schema-storage";
7
- import { registerCommonValidationSchemas, type Version } from "./common";
8
- /** Details about the replacement for a deleted version. */
9
- export interface CustomFieldReplacement {
10
- /** The ID of the custom field in which to replace the version number. */
11
- customFieldId?: number;
12
- /** The version number to use as a replacement for the deleted version. */
13
- moveTo?: number;
14
- }
15
- export interface DeleteAndReplaceVersionBean {
16
- /**
17
- * An array of custom field IDs (`customFieldId`) and version IDs (`moveTo`) to
18
- * update when the fields contain the deleted version.
19
- */
20
- customFieldReplacementList?: CustomFieldReplacement[];
21
- /**
22
- * The ID of the version to update `affectedVersion` to when the field contains
23
- * the deleted version.
24
- */
25
- moveAffectedIssuesTo?: number;
26
- /**
27
- * The ID of the version to update `fixVersion` to when the field contains the
28
- * deleted version.
29
- */
30
- moveFixIssuesTo?: number;
31
- }
32
- /** A page of items. */
33
- export interface PageBeanVersion {
34
- /** Whether this is the last page. */
35
- isLast?: boolean;
36
- /** The maximum number of items that could be returned. */
37
- maxResults?: number;
38
- /** If there is another page of results, the URL of the next page. */
39
- nextPage?: string;
40
- /** The URL of the page. */
41
- self?: string;
42
- /** The index of the first item returned. */
43
- startAt?: number;
44
- /** The number of items returned. */
45
- total?: number;
46
- /** The list of items. */
47
- values?: Version[];
48
- }
49
- /** Various counts of issues within a version. */
50
- export interface VersionIssueCounts {
51
- /** List of custom fields using the version. */
52
- customFieldUsage?: VersionUsageInCustomField[];
53
- /** Count of issues where a version custom field is set to the version. */
54
- issueCountWithCustomFieldsShowingVersion?: number;
55
- /** Count of issues where the `affectedVersion` is set to the version. */
56
- issuesAffectedCount?: number;
57
- /** Count of issues where the `fixVersion` is set to the version. */
58
- issuesFixedCount?: number;
59
- /** The URL of these count details. */
60
- self?: string;
61
- }
62
- export interface VersionMoveBean {
63
- /**
64
- * The URL (self link) of the version after which to place the moved version.
65
- * Cannot be used with `position`.
66
- */
67
- after?: string;
68
- /**
69
- * An absolute position in which to place the moved version. Cannot be used with
70
- * `after`.
71
- */
72
- position?: "Earlier" | "Later" | "First" | "Last";
73
- }
74
- /** Associated related work to a version */
75
- export interface VersionRelatedWork {
76
- /** The category of the related work */
77
- category: string;
78
- /**
79
- * The ID of the issue associated with the related work (if there is one). Cannot
80
- * be updated via the Rest API.
81
- */
82
- issueId?: number;
83
- /**
84
- * The id of the related work. For the native release note related work item, this
85
- * will be null, and Rest API does not support updating it.
86
- */
87
- relatedWorkId?: string;
88
- /** The title of the related work */
89
- title?: string;
90
- /**
91
- * The URL of the related work. Will be null for the native release note related
92
- * work item, but is otherwise required.
93
- */
94
- url?: string;
95
- }
96
- /** Count of a version's unresolved issues. */
97
- export interface VersionUnresolvedIssuesCount {
98
- /** Count of issues. */
99
- issuesCount?: number;
100
- /** Count of unresolved issues. */
101
- issuesUnresolvedCount?: number;
102
- /** The URL of these count details. */
103
- self?: string;
104
- }
105
- /** List of custom fields using the version. */
106
- export interface VersionUsageInCustomField {
107
- /** The ID of the custom field. */
108
- customFieldId?: number;
109
- /** The name of the custom field. */
110
- fieldName?: string;
111
- /** Count of the issues where the custom field contains the version. */
112
- issueCountWithVersionInCustomField?: number;
113
- }
114
- export function registerProjectVersionsValidationSchemas(
115
- validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>,
116
- ) {
117
- validationSchemaStorage.register(
118
- "CustomFieldReplacement",
119
- z
120
- .object({
121
- customFieldId: z.number().int().optional(),
122
- moveTo: z.number().int().optional(),
123
- })
124
- .strict()
125
- .describe("CustomFieldReplacement"),
126
- );
127
- validationSchemaStorage.register(
128
- "DeleteAndReplaceVersionBean",
129
- z
130
- .object({
131
- customFieldReplacementList: z
132
- .array(validationSchemaStorage.lazy("CustomFieldReplacement"))
133
- .optional(),
134
- moveAffectedIssuesTo: z.number().int().optional(),
135
- moveFixIssuesTo: z.number().int().optional(),
136
- })
137
- .strict()
138
- .describe("DeleteAndReplaceVersionBean"),
139
- );
140
- validationSchemaStorage.register(
141
- "PageBeanVersion",
142
- z
143
- .object({
144
- isLast: z.boolean().optional(),
145
- maxResults: z.number().int().optional(),
146
- nextPage: z.string().optional(),
147
- self: z.string().optional(),
148
- startAt: z.number().int().optional(),
149
- total: z.number().int().optional(),
150
- values: z.array(validationSchemaStorage.lazy("Version")).optional(),
151
- })
152
- .strict()
153
- .describe("PageBeanVersion"),
154
- );
155
- validationSchemaStorage.register(
156
- "VersionIssueCounts",
157
- z
158
- .object({
159
- customFieldUsage: z
160
- .array(validationSchemaStorage.lazy("VersionUsageInCustomField"))
161
- .optional(),
162
- issueCountWithCustomFieldsShowingVersion: z.number().int().optional(),
163
- issuesAffectedCount: z.number().int().optional(),
164
- issuesFixedCount: z.number().int().optional(),
165
- self: z.string().optional(),
166
- })
167
- .strict()
168
- .describe("VersionIssueCounts"),
169
- );
170
- validationSchemaStorage.register(
171
- "VersionMoveBean",
172
- z
173
- .object({
174
- after: z.string().optional(),
175
- position: z.enum(["Earlier", "Later", "First", "Last"]).optional(),
176
- })
177
- .strict()
178
- .describe("VersionMoveBean"),
179
- );
180
- validationSchemaStorage.register(
181
- "VersionRelatedWork",
182
- z
183
- .object({
184
- category: z.string(),
185
- issueId: z.number().int().optional(),
186
- relatedWorkId: z.string().optional(),
187
- title: z.string().optional(),
188
- url: z.string().optional(),
189
- })
190
- .strict()
191
- .describe("VersionRelatedWork"),
192
- );
193
- validationSchemaStorage.register(
194
- "VersionUnresolvedIssuesCount",
195
- z
196
- .object({
197
- issuesCount: z.number().int().optional(),
198
- issuesUnresolvedCount: z.number().int().optional(),
199
- self: z.string().optional(),
200
- })
201
- .strict()
202
- .describe("VersionUnresolvedIssuesCount"),
203
- );
204
- validationSchemaStorage.register(
205
- "VersionUsageInCustomField",
206
- z
207
- .object({
208
- customFieldId: z.number().int().optional(),
209
- fieldName: z.string().optional(),
210
- issueCountWithVersionInCustomField: z.number().int().optional(),
211
- })
212
- .strict()
213
- .describe("VersionUsageInCustomField"),
214
- );
215
- validationSchemaStorage.registerOnce([registerCommonValidationSchemas]);
216
- }
@@ -1,429 +0,0 @@
1
- // DO NOT EDIT!
2
- // This file is generated by "api-typescript-generator".
3
- // To update this file run "yarn build:openapi".
4
- import { z, type ZodTypeAny } from "zod";
5
-
6
- import type { CommonValidationSchemaStorage } from "../core/common-validation-schema-storage";
7
- import { registerCommonValidationSchemas, type StatusDetails } from "./common";
8
- /** Details about the project. */
9
- export interface CreateProjectDetails {
10
- /** The default assignee when creating issues for this project. */
11
- assigneeType?: "PROJECT_LEAD" | "UNASSIGNED";
12
- /** An integer value for the project's avatar. */
13
- avatarId?: number;
14
- /**
15
- * The ID of the project's category. A complete list of category IDs is found
16
- * using the [Get all project categories](#api-rest-api-3-projectCategory-get)
17
- * operation.
18
- */
19
- categoryId?: number;
20
- /** A brief description of the project. */
21
- description?: string;
22
- /**
23
- * The ID of the field configuration scheme for the project. Use the [Get all
24
- * field configuration schemes](#api-rest-api-3-fieldconfigurationscheme-get)
25
- * operation to get a list of field configuration scheme IDs. If you specify the
26
- * field configuration scheme you cannot specify the project template key.
27
- */
28
- fieldConfigurationScheme?: number;
29
- /**
30
- * The ID of the issue security scheme for the project, which enables you to
31
- * control who can and cannot view issues. Use the [Get issue security
32
- * schemes](#api-rest-api-3-issuesecurityschemes-get) resource to get all issue
33
- * security scheme IDs.
34
- */
35
- issueSecurityScheme?: number;
36
- /**
37
- * The ID of the issue type scheme for the project. Use the [Get all issue type
38
- * schemes](#api-rest-api-3-issuetypescheme-get) operation to get a list of issue
39
- * type scheme IDs. If you specify the issue type scheme you cannot specify the
40
- * project template key.
41
- */
42
- issueTypeScheme?: number;
43
- /**
44
- * The ID of the issue type screen scheme for the project. Use the [Get all issue
45
- * type screen schemes](#api-rest-api-3-issuetypescreenscheme-get) operation to
46
- * get a list of issue type screen scheme IDs. If you specify the issue type
47
- * screen scheme you cannot specify the project template key.
48
- */
49
- issueTypeScreenScheme?: number;
50
- /**
51
- * Project keys must be unique and start with an uppercase letter followed by one
52
- * or more uppercase alphanumeric characters. The maximum length is 10 characters.
53
- */
54
- key: string;
55
- /**
56
- * This parameter is deprecated because of privacy changes. Use `leadAccountId`
57
- * instead. See the [migration
58
- * guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/)
59
- * for details. The user name of the project lead. Either `lead` or
60
- * `leadAccountId` must be set when creating a project. Cannot be provided with
61
- * `leadAccountId`.
62
- *
63
- * @deprecated
64
- */
65
- lead?: string;
66
- /**
67
- * The account ID of the project lead. Either `lead` or `leadAccountId` must be
68
- * set when creating a project. Cannot be provided with `lead`.
69
- */
70
- leadAccountId?: string;
71
- /** The name of the project. */
72
- name: string;
73
- /**
74
- * The ID of the notification scheme for the project. Use the [Get notification
75
- * schemes](#api-rest-api-3-notificationscheme-get) resource to get a list of
76
- * notification scheme IDs.
77
- */
78
- notificationScheme?: number;
79
- /**
80
- * The ID of the permission scheme for the project. Use the [Get all permission
81
- * schemes](#api-rest-api-3-permissionscheme-get) resource to see a list of all
82
- * permission scheme IDs.
83
- */
84
- permissionScheme?: number;
85
- /**
86
- * A predefined configuration for a project. The type of the `projectTemplateKey`
87
- * must match with the type of the `projectTypeKey`.
88
- */
89
- projectTemplateKey?:
90
- | "com.pyxis.greenhopper.jira:gh-simplified-agility-kanban"
91
- | "com.pyxis.greenhopper.jira:gh-simplified-agility-scrum"
92
- | "com.pyxis.greenhopper.jira:gh-simplified-basic"
93
- | "com.pyxis.greenhopper.jira:gh-simplified-kanban-classic"
94
- | "com.pyxis.greenhopper.jira:gh-simplified-scrum-classic"
95
- | "com.pyxis.greenhopper.jira:gh-cross-team-template"
96
- | "com.pyxis.greenhopper.jira:gh-cross-team-planning-template"
97
- | "com.atlassian.servicedesk:simplified-it-service-management"
98
- | "com.atlassian.servicedesk:simplified-general-service-desk"
99
- | "com.atlassian.servicedesk:simplified-general-service-desk-it"
100
- | "com.atlassian.servicedesk:simplified-general-service-desk-business"
101
- | "com.atlassian.servicedesk:simplified-internal-service-desk"
102
- | "com.atlassian.servicedesk:simplified-external-service-desk"
103
- | "com.atlassian.servicedesk:simplified-hr-service-desk"
104
- | "com.atlassian.servicedesk:simplified-facilities-service-desk"
105
- | "com.atlassian.servicedesk:simplified-legal-service-desk"
106
- | "com.atlassian.servicedesk:simplified-marketing-service-desk"
107
- | "com.atlassian.servicedesk:simplified-finance-service-desk"
108
- | "com.atlassian.servicedesk:simplified-analytics-service-desk"
109
- | "com.atlassian.servicedesk:simplified-design-service-desk"
110
- | "com.atlassian.servicedesk:simplified-sales-service-desk"
111
- | "com.atlassian.servicedesk:simplified-halp-service-desk"
112
- | "com.atlassian.servicedesk:simplified-blank-project-it"
113
- | "com.atlassian.servicedesk:simplified-blank-project-business"
114
- | "com.atlassian.servicedesk:next-gen-it-service-desk"
115
- | "com.atlassian.servicedesk:next-gen-hr-service-desk"
116
- | "com.atlassian.servicedesk:next-gen-legal-service-desk"
117
- | "com.atlassian.servicedesk:next-gen-marketing-service-desk"
118
- | "com.atlassian.servicedesk:next-gen-facilities-service-desk"
119
- | "com.atlassian.servicedesk:next-gen-general-service-desk"
120
- | "com.atlassian.servicedesk:next-gen-general-it-service-desk"
121
- | "com.atlassian.servicedesk:next-gen-general-business-service-desk"
122
- | "com.atlassian.servicedesk:next-gen-analytics-service-desk"
123
- | "com.atlassian.servicedesk:next-gen-finance-service-desk"
124
- | "com.atlassian.servicedesk:next-gen-design-service-desk"
125
- | "com.atlassian.servicedesk:next-gen-sales-service-desk"
126
- | "com.atlassian.jira-core-project-templates:jira-core-simplified-content-management"
127
- | "com.atlassian.jira-core-project-templates:jira-core-simplified-document-approval"
128
- | "com.atlassian.jira-core-project-templates:jira-core-simplified-lead-tracking"
129
- | "com.atlassian.jira-core-project-templates:jira-core-simplified-process-control"
130
- | "com.atlassian.jira-core-project-templates:jira-core-simplified-procurement"
131
- | "com.atlassian.jira-core-project-templates:jira-core-simplified-project-management"
132
- | "com.atlassian.jira-core-project-templates:jira-core-simplified-recruitment"
133
- | "com.atlassian.jira-core-project-templates:jira-core-simplified-task-";
134
- /**
135
- * The [project
136
- * type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes),
137
- * which defines the application-specific feature set. If you don't specify the
138
- * project template you have to specify the project type.
139
- */
140
- projectTypeKey?: "software" | "service_desk" | "business";
141
- /** A link to information about this project, such as project documentation */
142
- url?: string;
143
- /**
144
- * The ID of the workflow scheme for the project. Use the [Get all workflow
145
- * schemes](#api-rest-api-3-workflowscheme-get) operation to get a list of
146
- * workflow scheme IDs. If you specify the workflow scheme you cannot specify the
147
- * project template key.
148
- */
149
- workflowScheme?: number;
150
- }
151
- /** Details of an issue type. */
152
- export interface IssueTypeInfo {
153
- /** The avatar of the issue type. */
154
- avatarId?: number;
155
- /** The ID of the issue type. */
156
- id?: number;
157
- /** The name of the issue type. */
158
- name?: string;
159
- }
160
- /** Status details for an issue type. */
161
- export interface IssueTypeWithStatus {
162
- /** The ID of the issue type. */
163
- id: string;
164
- /** The name of the issue type. */
165
- name: string;
166
- /** The URL of the issue type's status details. */
167
- self: string;
168
- /** List of status details for the issue type. */
169
- statuses: StatusDetails[];
170
- /** Whether this issue type represents subtasks. */
171
- subtask: boolean;
172
- }
173
- /** Identifiers for a project. */
174
- export interface ProjectIdentifiers {
175
- /** The ID of the created project. */
176
- id: number;
177
- /** The key of the created project. */
178
- key: string;
179
- /** The URL of the created project. */
180
- self: string;
181
- }
182
- /** The hierarchy of issue types within a project. */
183
- export interface ProjectIssueTypeHierarchy {
184
- /** Details of an issue type hierarchy level. */
185
- hierarchy?: ProjectIssueTypesHierarchyLevel[];
186
- /** The ID of the project. */
187
- projectId?: number;
188
- }
189
- /** Details of an issue type hierarchy level. */
190
- export interface ProjectIssueTypesHierarchyLevel {
191
- /**
192
- * The ID of the issue type hierarchy level. This property is deprecated, see
193
- * [Change notice: Removing hierarchy level IDs from next-gen
194
- * APIs](https://developer.atlassian.com/cloud/jira/platform/change-notice-removing-hierarchy-level-ids-from-next-gen-apis/).
195
- *
196
- * @deprecated
197
- */
198
- entityId?: string;
199
- /** The list of issue types in the hierarchy level. */
200
- issueTypes?: IssueTypeInfo[];
201
- /** The level of the issue type hierarchy level. */
202
- level?: number;
203
- /** The name of the issue type hierarchy level. */
204
- name?: string;
205
- }
206
- export interface StringList {}
207
- /** Details about the project. */
208
- export interface UpdateProjectDetails {
209
- /** The default assignee when creating issues for this project. */
210
- assigneeType?: "PROJECT_LEAD" | "UNASSIGNED";
211
- /** An integer value for the project's avatar. */
212
- avatarId?: number;
213
- /**
214
- * The ID of the project's category. A complete list of category IDs is found
215
- * using the [Get all project categories](#api-rest-api-3-projectCategory-get)
216
- * operation. To remove the project category from the project, set the value to
217
- * `-1.`
218
- */
219
- categoryId?: number;
220
- /** A brief description of the project. */
221
- description?: string;
222
- /**
223
- * The ID of the issue security scheme for the project, which enables you to
224
- * control who can and cannot view issues. Use the [Get issue security
225
- * schemes](#api-rest-api-3-issuesecurityschemes-get) resource to get all issue
226
- * security scheme IDs.
227
- */
228
- issueSecurityScheme?: number;
229
- /**
230
- * Project keys must be unique and start with an uppercase letter followed by one
231
- * or more uppercase alphanumeric characters. The maximum length is 10 characters.
232
- */
233
- key?: string;
234
- /**
235
- * This parameter is deprecated because of privacy changes. Use `leadAccountId`
236
- * instead. See the [migration
237
- * guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/)
238
- * for details. The user name of the project lead. Cannot be provided with
239
- * `leadAccountId`.
240
- *
241
- * @deprecated
242
- */
243
- lead?: string;
244
- /** The account ID of the project lead. Cannot be provided with `lead`. */
245
- leadAccountId?: string;
246
- /** The name of the project. */
247
- name?: string;
248
- /**
249
- * The ID of the notification scheme for the project. Use the [Get notification
250
- * schemes](#api-rest-api-3-notificationscheme-get) resource to get a list of
251
- * notification scheme IDs.
252
- */
253
- notificationScheme?: number;
254
- /**
255
- * The ID of the permission scheme for the project. Use the [Get all permission
256
- * schemes](#api-rest-api-3-permissionscheme-get) resource to see a list of all
257
- * permission scheme IDs.
258
- */
259
- permissionScheme?: number;
260
- /** A link to information about this project, such as project documentation */
261
- url?: string;
262
- }
263
- export function registerProjectsValidationSchemas(
264
- validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>,
265
- ) {
266
- validationSchemaStorage.register(
267
- "CreateProjectDetails",
268
- z
269
- .object({
270
- assigneeType: z.enum(["PROJECT_LEAD", "UNASSIGNED"]).optional(),
271
- avatarId: z.number().int().optional(),
272
- categoryId: z.number().int().optional(),
273
- description: z.string().optional(),
274
- fieldConfigurationScheme: z.number().int().optional(),
275
- issueSecurityScheme: z.number().int().optional(),
276
- issueTypeScheme: z.number().int().optional(),
277
- issueTypeScreenScheme: z.number().int().optional(),
278
- key: z.string(),
279
- lead: z.string().optional(),
280
- leadAccountId: z.string().max(128).optional(),
281
- name: z.string(),
282
- notificationScheme: z.number().int().optional(),
283
- permissionScheme: z.number().int().optional(),
284
- projectTemplateKey: z
285
- .enum([
286
- "com.pyxis.greenhopper.jira:gh-simplified-agility-kanban",
287
- "com.pyxis.greenhopper.jira:gh-simplified-agility-scrum",
288
- "com.pyxis.greenhopper.jira:gh-simplified-basic",
289
- "com.pyxis.greenhopper.jira:gh-simplified-kanban-classic",
290
- "com.pyxis.greenhopper.jira:gh-simplified-scrum-classic",
291
- "com.pyxis.greenhopper.jira:gh-cross-team-template",
292
- "com.pyxis.greenhopper.jira:gh-cross-team-planning-template",
293
- "com.atlassian.servicedesk:simplified-it-service-management",
294
- "com.atlassian.servicedesk:simplified-general-service-desk",
295
- "com.atlassian.servicedesk:simplified-general-service-desk-it",
296
- "com.atlassian.servicedesk:simplified-general-service-desk-business",
297
- "com.atlassian.servicedesk:simplified-internal-service-desk",
298
- "com.atlassian.servicedesk:simplified-external-service-desk",
299
- "com.atlassian.servicedesk:simplified-hr-service-desk",
300
- "com.atlassian.servicedesk:simplified-facilities-service-desk",
301
- "com.atlassian.servicedesk:simplified-legal-service-desk",
302
- "com.atlassian.servicedesk:simplified-marketing-service-desk",
303
- "com.atlassian.servicedesk:simplified-finance-service-desk",
304
- "com.atlassian.servicedesk:simplified-analytics-service-desk",
305
- "com.atlassian.servicedesk:simplified-design-service-desk",
306
- "com.atlassian.servicedesk:simplified-sales-service-desk",
307
- "com.atlassian.servicedesk:simplified-halp-service-desk",
308
- "com.atlassian.servicedesk:simplified-blank-project-it",
309
- "com.atlassian.servicedesk:simplified-blank-project-business",
310
- "com.atlassian.servicedesk:next-gen-it-service-desk",
311
- "com.atlassian.servicedesk:next-gen-hr-service-desk",
312
- "com.atlassian.servicedesk:next-gen-legal-service-desk",
313
- "com.atlassian.servicedesk:next-gen-marketing-service-desk",
314
- "com.atlassian.servicedesk:next-gen-facilities-service-desk",
315
- "com.atlassian.servicedesk:next-gen-general-service-desk",
316
- "com.atlassian.servicedesk:next-gen-general-it-service-desk",
317
- "com.atlassian.servicedesk:next-gen-general-business-service-desk",
318
- "com.atlassian.servicedesk:next-gen-analytics-service-desk",
319
- "com.atlassian.servicedesk:next-gen-finance-service-desk",
320
- "com.atlassian.servicedesk:next-gen-design-service-desk",
321
- "com.atlassian.servicedesk:next-gen-sales-service-desk",
322
- "com.atlassian.jira-core-project-templates:jira-core-simplified-content-management",
323
- "com.atlassian.jira-core-project-templates:jira-core-simplified-document-approval",
324
- "com.atlassian.jira-core-project-templates:jira-core-simplified-lead-tracking",
325
- "com.atlassian.jira-core-project-templates:jira-core-simplified-process-control",
326
- "com.atlassian.jira-core-project-templates:jira-core-simplified-procurement",
327
- "com.atlassian.jira-core-project-templates:jira-core-simplified-project-management",
328
- "com.atlassian.jira-core-project-templates:jira-core-simplified-recruitment",
329
- "com.atlassian.jira-core-project-templates:jira-core-simplified-task-",
330
- ])
331
- .optional(),
332
- projectTypeKey: z
333
- .enum(["software", "service_desk", "business"])
334
- .optional(),
335
- url: z.string().optional(),
336
- workflowScheme: z.number().int().optional(),
337
- })
338
- .strict()
339
- .describe("CreateProjectDetails"),
340
- );
341
- validationSchemaStorage.register(
342
- "IssueTypeInfo",
343
- z
344
- .object({
345
- avatarId: z.number().int().optional(),
346
- id: z.number().int().optional(),
347
- name: z.string().optional(),
348
- })
349
- .strict()
350
- .describe("IssueTypeInfo"),
351
- );
352
- validationSchemaStorage.register(
353
- "IssueTypeWithStatus",
354
- z
355
- .object({
356
- id: z.string(),
357
- name: z.string(),
358
- self: z.string(),
359
- statuses: z.array(validationSchemaStorage.lazy("StatusDetails")),
360
- subtask: z.boolean(),
361
- })
362
- .strict()
363
- .describe("IssueTypeWithStatus"),
364
- );
365
- validationSchemaStorage.register(
366
- "ProjectIdentifiers",
367
- z
368
- .object({
369
- id: z.number().int(),
370
- key: z.string(),
371
- self: z.string(),
372
- })
373
- .strict()
374
- .describe("ProjectIdentifiers"),
375
- );
376
- validationSchemaStorage.register(
377
- "ProjectIssueTypeHierarchy",
378
- z
379
- .object({
380
- hierarchy: z
381
- .array(
382
- validationSchemaStorage.lazy("ProjectIssueTypesHierarchyLevel"),
383
- )
384
- .optional(),
385
- projectId: z.number().int().optional(),
386
- })
387
- .strict()
388
- .describe("ProjectIssueTypeHierarchy"),
389
- );
390
- validationSchemaStorage.register(
391
- "ProjectIssueTypesHierarchyLevel",
392
- z
393
- .object({
394
- entityId: z.string().optional(),
395
- issueTypes: z
396
- .array(validationSchemaStorage.lazy("IssueTypeInfo"))
397
- .optional(),
398
- level: z.number().int().optional(),
399
- name: z.string().optional(),
400
- })
401
- .strict()
402
- .describe("ProjectIssueTypesHierarchyLevel"),
403
- );
404
- validationSchemaStorage.register(
405
- "StringList",
406
- z.object({}).strict().describe("StringList"),
407
- );
408
- validationSchemaStorage.register(
409
- "UpdateProjectDetails",
410
- z
411
- .object({
412
- assigneeType: z.enum(["PROJECT_LEAD", "UNASSIGNED"]).optional(),
413
- avatarId: z.number().int().optional(),
414
- categoryId: z.number().int().optional(),
415
- description: z.string().optional(),
416
- issueSecurityScheme: z.number().int().optional(),
417
- key: z.string().optional(),
418
- lead: z.string().optional(),
419
- leadAccountId: z.string().max(128).optional(),
420
- name: z.string().optional(),
421
- notificationScheme: z.number().int().optional(),
422
- permissionScheme: z.number().int().optional(),
423
- url: z.string().optional(),
424
- })
425
- .strict()
426
- .describe("UpdateProjectDetails"),
427
- );
428
- validationSchemaStorage.registerOnce([registerCommonValidationSchemas]);
429
- }