@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,918 +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
- /** Details about an issue. */
8
- export interface IssueBean {
9
- /** Details of changelogs associated with the issue. */
10
- changelog?: {
11
- /** The list of changelogs. */
12
- histories?: {
13
- /** The user who made the change. */
14
- author?: {
15
- /**
16
- * The account ID of the user, which uniquely identifies the user across all
17
- * Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.
18
- */
19
- accountId?: string;
20
- /**
21
- * The type of account represented by this user. This will be one of 'atlassian'
22
- * (normal users), 'app' (application user) or 'customer' (Jira Service Desk
23
- * customer user)
24
- */
25
- accountType?: string;
26
- /** Whether the user is active. */
27
- active?: boolean;
28
- /** The avatars of the user. */
29
- avatarUrls?: {
30
- /** The URL of the item's 16x16 pixel avatar. */
31
- "16x16"?: string;
32
- /** The URL of the item's 24x24 pixel avatar. */
33
- "24x24"?: string;
34
- /** The URL of the item's 32x32 pixel avatar. */
35
- "32x32"?: string;
36
- /** The URL of the item's 48x48 pixel avatar. */
37
- "48x48"?: string;
38
- };
39
- /**
40
- * The display name of the user. Depending on the user’s privacy settings, this
41
- * may return an alternative value.
42
- */
43
- displayName?: string;
44
- /**
45
- * The email address of the user. Depending on the user’s privacy settings, this
46
- * may be returned as null.
47
- */
48
- emailAddress?: string;
49
- /**
50
- * This property is no longer available and will be removed from the documentation
51
- * soon. See the [deprecation
52
- * notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/)
53
- * for details.
54
- */
55
- key?: string;
56
- /**
57
- * This property is no longer available and will be removed from the documentation
58
- * soon. See the [deprecation
59
- * notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/)
60
- * for details.
61
- */
62
- name?: string;
63
- /** The URL of the user. */
64
- self?: string;
65
- /**
66
- * The time zone specified in the user's profile. Depending on the user’s privacy
67
- * settings, this may be returned as null.
68
- */
69
- timeZone?: string;
70
- };
71
- /** The date on which the change took place. */
72
- created?: string;
73
- /** The history metadata associated with the changed. */
74
- historyMetadata?: {
75
- /** The activity described in the history record. */
76
- activityDescription?: string;
77
- /** The key of the activity described in the history record. */
78
- activityDescriptionKey?: string;
79
- /** Details of the user whose action created the history record. */
80
- actor?: {
81
- /** The URL to an avatar for the user or system associated with a history record. */
82
- avatarUrl?: string;
83
- /** The display name of the user or system associated with a history record. */
84
- displayName?: string;
85
- /**
86
- * The key of the display name of the user or system associated with a history
87
- * record.
88
- */
89
- displayNameKey?: string;
90
- /** The ID of the user or system associated with a history record. */
91
- id?: string;
92
- /** The type of the user or system associated with a history record. */
93
- type?: string;
94
- /** The URL of the user or system associated with a history record. */
95
- url?: string;
96
- } & {
97
- [key: string]: unknown;
98
- };
99
- /** Details of the cause that triggered the creation the history record. */
100
- cause?: {
101
- /** The URL to an avatar for the user or system associated with a history record. */
102
- avatarUrl?: string;
103
- /** The display name of the user or system associated with a history record. */
104
- displayName?: string;
105
- /**
106
- * The key of the display name of the user or system associated with a history
107
- * record.
108
- */
109
- displayNameKey?: string;
110
- /** The ID of the user or system associated with a history record. */
111
- id?: string;
112
- /** The type of the user or system associated with a history record. */
113
- type?: string;
114
- /** The URL of the user or system associated with a history record. */
115
- url?: string;
116
- } & {
117
- [key: string]: unknown;
118
- };
119
- /** The description of the history record. */
120
- description?: string;
121
- /** The description key of the history record. */
122
- descriptionKey?: string;
123
- /** The description of the email address associated the history record. */
124
- emailDescription?: string;
125
- /** The description key of the email address associated the history record. */
126
- emailDescriptionKey?: string;
127
- /** Additional arbitrary information about the history record. */
128
- extraData?: {
129
- [key: string]: string;
130
- };
131
- /** Details of the system that generated the history record. */
132
- generator?: {
133
- /** The URL to an avatar for the user or system associated with a history record. */
134
- avatarUrl?: string;
135
- /** The display name of the user or system associated with a history record. */
136
- displayName?: string;
137
- /**
138
- * The key of the display name of the user or system associated with a history
139
- * record.
140
- */
141
- displayNameKey?: string;
142
- /** The ID of the user or system associated with a history record. */
143
- id?: string;
144
- /** The type of the user or system associated with a history record. */
145
- type?: string;
146
- /** The URL of the user or system associated with a history record. */
147
- url?: string;
148
- } & {
149
- [key: string]: unknown;
150
- };
151
- /** The type of the history record. */
152
- type?: string;
153
- } & {
154
- [key: string]: unknown;
155
- };
156
- /** The ID of the changelog. */
157
- id?: string;
158
- /** The list of items changed. */
159
- items?: {
160
- /** The name of the field changed. */
161
- field?: string;
162
- /** The ID of the field changed. */
163
- fieldId?: string;
164
- /** The type of the field changed. */
165
- fieldtype?: string;
166
- /** The details of the original value. */
167
- from?: string;
168
- /** The details of the original value as a string. */
169
- fromString?: string;
170
- /** The details of the new value. */
171
- to?: string;
172
- /** The details of the new value as a string. */
173
- toString: string;
174
- }[];
175
- }[];
176
- /** The maximum number of results that could be on the page. */
177
- maxResults?: number;
178
- /** The index of the first item returned on the page. */
179
- startAt?: number;
180
- /** The number of results on the page. */
181
- total?: number;
182
- };
183
- /** The metadata for the fields on the issue that can be amended. */
184
- editmeta?: {
185
- fields?: {
186
- /** The metadata describing an issue field. */
187
- [key: string]: {
188
- /** The list of values allowed in the field. */
189
- allowedValues?: unknown[];
190
- /** The URL that can be used to automatically complete the field. */
191
- autoCompleteUrl?: string;
192
- /** The configuration properties. */
193
- configuration?: {
194
- [key: string]: unknown;
195
- };
196
- /** The default value of the field. */
197
- defaultValue?: unknown;
198
- /** Whether the field has a default value. */
199
- hasDefaultValue?: boolean;
200
- /** The key of the field. */
201
- key: string;
202
- /** The name of the field. */
203
- name: string;
204
- /** The list of operations that can be performed on the field. */
205
- operations: string[];
206
- /** Whether the field is required. */
207
- required: boolean;
208
- /** The data type of the field. */
209
- schema: {
210
- /** If the field is a custom field, the configuration of the field. */
211
- configuration?: {
212
- [key: string]: unknown;
213
- };
214
- /** If the field is a custom field, the URI of the field. */
215
- custom?: string;
216
- /** If the field is a custom field, the custom ID of the field. */
217
- customId?: number;
218
- /** When the data type is an array, the name of the field items within the array. */
219
- items?: string;
220
- /** If the field is a system field, the name of the field. */
221
- system?: string;
222
- /** The data type of the field. */
223
- type: string;
224
- };
225
- };
226
- };
227
- } & {
228
- [key: string]: unknown;
229
- };
230
- /** Expand options that include additional issue details in the response. */
231
- expand?: string;
232
- fields?: {
233
- [key: string]: unknown;
234
- };
235
- fieldsToInclude?: {
236
- actuallyIncluded?: string[];
237
- excluded?: string[];
238
- included?: string[];
239
- };
240
- /** The ID of the issue. */
241
- id?: string;
242
- /** The key of the issue. */
243
- key?: string;
244
- /** The ID and name of each field present on the issue. */
245
- names?: {
246
- [key: string]: string;
247
- };
248
- /** The operations that can be performed on the issue. */
249
- operations?: Operations;
250
- /** Details of the issue properties identified in the request. */
251
- properties?: {
252
- [key: string]: unknown;
253
- };
254
- /** The rendered value of each field present on the issue. */
255
- renderedFields?: {
256
- [key: string]: unknown;
257
- };
258
- /** The schema describing each field present on the issue. */
259
- schema?: {
260
- /** The schema of a field. */
261
- [key: string]: {
262
- /** If the field is a custom field, the configuration of the field. */
263
- configuration?: {
264
- [key: string]: unknown;
265
- };
266
- /** If the field is a custom field, the URI of the field. */
267
- custom?: string;
268
- /** If the field is a custom field, the custom ID of the field. */
269
- customId?: number;
270
- /** When the data type is an array, the name of the field items within the array. */
271
- items?: string;
272
- /** If the field is a system field, the name of the field. */
273
- system?: string;
274
- /** The data type of the field. */
275
- type: string;
276
- };
277
- };
278
- /** The URL of the issue details. */
279
- self?: string;
280
- /** The transitions that can be performed on the issue. */
281
- transitions?: ({
282
- /** Expand options that include additional transition details in the response. */
283
- expand?: string;
284
- /**
285
- * Details of the fields associated with the issue transition screen. Use this
286
- * information to populate `fields` and `update` in a transition request.
287
- */
288
- fields?: {
289
- /** The metadata describing an issue field. */
290
- [key: string]: {
291
- /** The list of values allowed in the field. */
292
- allowedValues?: unknown[];
293
- /** The URL that can be used to automatically complete the field. */
294
- autoCompleteUrl?: string;
295
- /** The configuration properties. */
296
- configuration?: {
297
- [key: string]: unknown;
298
- };
299
- /** The default value of the field. */
300
- defaultValue?: unknown;
301
- /** Whether the field has a default value. */
302
- hasDefaultValue?: boolean;
303
- /** The key of the field. */
304
- key: string;
305
- /** The name of the field. */
306
- name: string;
307
- /** The list of operations that can be performed on the field. */
308
- operations: string[];
309
- /** Whether the field is required. */
310
- required: boolean;
311
- /** The data type of the field. */
312
- schema: {
313
- /** If the field is a custom field, the configuration of the field. */
314
- configuration?: {
315
- [key: string]: unknown;
316
- };
317
- /** If the field is a custom field, the URI of the field. */
318
- custom?: string;
319
- /** If the field is a custom field, the custom ID of the field. */
320
- customId?: number;
321
- /** When the data type is an array, the name of the field items within the array. */
322
- items?: string;
323
- /** If the field is a system field, the name of the field. */
324
- system?: string;
325
- /** The data type of the field. */
326
- type: string;
327
- };
328
- };
329
- };
330
- /** Whether there is a screen associated with the issue transition. */
331
- hasScreen?: boolean;
332
- /**
333
- * The ID of the issue transition. Required when specifying a transition to
334
- * undertake.
335
- */
336
- id?: string;
337
- /** Whether the transition is available to be performed. */
338
- isAvailable?: boolean;
339
- /** Whether the issue has to meet criteria before the issue transition is applied. */
340
- isConditional?: boolean;
341
- /**
342
- * Whether the issue transition is global, that is, the transition is applied to
343
- * issues regardless of their status.
344
- */
345
- isGlobal?: boolean;
346
- /** Whether this is the initial issue transition for the workflow. */
347
- isInitial?: boolean;
348
- looped?: boolean;
349
- /** The name of the issue transition. */
350
- name?: string;
351
- /** Details of the issue status after the transition. */
352
- to?: {
353
- /** The description of the status. */
354
- description?: string;
355
- /** The URL of the icon used to represent the status. */
356
- iconUrl?: string;
357
- /** The ID of the status. */
358
- id?: string;
359
- /** The name of the status. */
360
- name?: string;
361
- /** The scope of the field. */
362
- scope?: {
363
- /** The project the item has scope in. */
364
- project?: {
365
- /** The URLs of the project's avatars. */
366
- avatarUrls?: {
367
- /** The URL of the item's 16x16 pixel avatar. */
368
- "16x16"?: string;
369
- /** The URL of the item's 24x24 pixel avatar. */
370
- "24x24"?: string;
371
- /** The URL of the item's 32x32 pixel avatar. */
372
- "32x32"?: string;
373
- /** The URL of the item's 48x48 pixel avatar. */
374
- "48x48"?: string;
375
- };
376
- /** The ID of the project. */
377
- id?: string;
378
- /** The key of the project. */
379
- key?: string;
380
- /** The name of the project. */
381
- name?: string;
382
- /** The category the project belongs to. */
383
- projectCategory?: {
384
- /** The name of the project category. */
385
- description?: string;
386
- /** The ID of the project category. */
387
- id?: string;
388
- /** The description of the project category. */
389
- name?: string;
390
- /** The URL of the project category. */
391
- self?: string;
392
- };
393
- /**
394
- * The [project
395
- * type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes)
396
- * of the project.
397
- */
398
- projectTypeKey?: "software" | "service_desk" | "business";
399
- /** The URL of the project details. */
400
- self?: string;
401
- /** Whether or not the project is simplified. */
402
- simplified?: boolean;
403
- };
404
- /** The type of scope. */
405
- type?: "PROJECT" | "TEMPLATE";
406
- } & {
407
- [key: string]: unknown;
408
- };
409
- /** The URL of the status. */
410
- self?: string;
411
- /** The category assigned to the status. */
412
- statusCategory?: {
413
- /** The name of the color used to represent the status category. */
414
- colorName?: string;
415
- /** The ID of the status category. */
416
- id?: number;
417
- /** The key of the status category. */
418
- key?: string;
419
- /** The name of the status category. */
420
- name?: string;
421
- /** The URL of the status category. */
422
- self?: string;
423
- } & {
424
- [key: string]: unknown;
425
- };
426
- } & {
427
- [key: string]: unknown;
428
- };
429
- } & {
430
- [key: string]: unknown;
431
- })[];
432
- /** The versions of each field on the issue. */
433
- versionedRepresentations?: {
434
- [key: string]: {
435
- [key: string]: unknown;
436
- };
437
- };
438
- }
439
- /** Details a link group, which defines issue operations. */
440
- export interface LinkGroup {
441
- groups?: LinkGroup[];
442
- /** Details about the operations available in this version. */
443
- header?: {
444
- href?: string;
445
- iconClass?: string;
446
- id?: string;
447
- label?: string;
448
- styleClass?: string;
449
- title?: string;
450
- weight?: number;
451
- };
452
- id?: string;
453
- links?: {
454
- href?: string;
455
- iconClass?: string;
456
- id?: string;
457
- label?: string;
458
- styleClass?: string;
459
- title?: string;
460
- weight?: number;
461
- }[];
462
- styleClass?: string;
463
- weight?: number;
464
- }
465
- /** Details of the operations that can be performed on the issue. */
466
- export interface Operations extends Record<string, unknown> {
467
- /** Details of the link groups defining issue operations. */
468
- linkGroups?: LinkGroup[];
469
- }
470
- /** The result of a JQL search. */
471
- export interface SearchResults {
472
- /** Expand options that include additional search result details in the response. */
473
- expand?: string;
474
- /** The list of issues found by the search. */
475
- issues?: IssueBean[];
476
- /** The maximum number of results that could be on the page. */
477
- maxResults?: number;
478
- /** The ID and name of each field in the search results. */
479
- names?: {
480
- [key: string]: string;
481
- };
482
- /** The schema describing the field types in the search results. */
483
- schema?: {
484
- /** The schema of a field. */
485
- [key: string]: {
486
- /** If the field is a custom field, the configuration of the field. */
487
- configuration?: {
488
- [key: string]: unknown;
489
- };
490
- /** If the field is a custom field, the URI of the field. */
491
- custom?: string;
492
- /** If the field is a custom field, the custom ID of the field. */
493
- customId?: number;
494
- /** When the data type is an array, the name of the field items within the array. */
495
- items?: string;
496
- /** If the field is a system field, the name of the field. */
497
- system?: string;
498
- /** The data type of the field. */
499
- type: string;
500
- };
501
- };
502
- /** The index of the first item returned on the page. */
503
- startAt?: number;
504
- /** The number of results on the page. */
505
- total?: number;
506
- /** Any warnings related to the JQL query. */
507
- warningMessages?: string[];
508
- }
509
- export function registerBoardValidationSchemas(
510
- validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>,
511
- ) {
512
- validationSchemaStorage.register(
513
- "IssueBean",
514
- z
515
- .object({
516
- changelog: z
517
- .object({
518
- histories: z
519
- .array(
520
- z
521
- .object({
522
- author: z
523
- .object({
524
- accountId: z.string().max(128).optional(),
525
- accountType: z.string().optional(),
526
- active: z.boolean().optional(),
527
- avatarUrls: z
528
- .object({
529
- "16x16": z.string().optional(),
530
- "24x24": z.string().optional(),
531
- "32x32": z.string().optional(),
532
- "48x48": z.string().optional(),
533
- })
534
- .strict()
535
- .optional(),
536
- displayName: z.string().optional(),
537
- emailAddress: z.string().optional(),
538
- key: z.string().optional(),
539
- name: z.string().optional(),
540
- self: z.string().optional(),
541
- timeZone: z.string().optional(),
542
- })
543
- .strict()
544
- .optional(),
545
- created: z.string().optional(),
546
- historyMetadata: z
547
- .object({
548
- activityDescription: z.string().optional(),
549
- activityDescriptionKey: z.string().optional(),
550
- actor: z
551
- .object({
552
- avatarUrl: z.string().optional(),
553
- displayName: z.string().optional(),
554
- displayNameKey: z.string().optional(),
555
- id: z.string().optional(),
556
- type: z.string().optional(),
557
- url: z.string().optional(),
558
- })
559
- .catchall(z.unknown())
560
- .optional(),
561
- cause: z
562
- .object({
563
- avatarUrl: z.string().optional(),
564
- displayName: z.string().optional(),
565
- displayNameKey: z.string().optional(),
566
- id: z.string().optional(),
567
- type: z.string().optional(),
568
- url: z.string().optional(),
569
- })
570
- .catchall(z.unknown())
571
- .optional(),
572
- description: z.string().optional(),
573
- descriptionKey: z.string().optional(),
574
- emailDescription: z.string().optional(),
575
- emailDescriptionKey: z.string().optional(),
576
- extraData: z.object({}).catchall(z.string()).optional(),
577
- generator: z
578
- .object({
579
- avatarUrl: z.string().optional(),
580
- displayName: z.string().optional(),
581
- displayNameKey: z.string().optional(),
582
- id: z.string().optional(),
583
- type: z.string().optional(),
584
- url: z.string().optional(),
585
- })
586
- .catchall(z.unknown())
587
- .optional(),
588
- type: z.string().optional(),
589
- })
590
- .catchall(z.unknown())
591
- .optional(),
592
- id: z.string().optional(),
593
- items: z
594
- .array(
595
- z
596
- .object({
597
- field: z.string().optional(),
598
- fieldId: z.string().optional(),
599
- fieldtype: z.string().optional(),
600
- from: z.string().optional(),
601
- fromString: z.string().optional(),
602
- to: z.string().optional(),
603
- toString: z.string(),
604
- })
605
- .strict(),
606
- )
607
- .optional(),
608
- })
609
- .strict(),
610
- )
611
- .optional(),
612
- maxResults: z.number().int().optional(),
613
- startAt: z.number().int().optional(),
614
- total: z.number().int().optional(),
615
- })
616
- .strict()
617
- .optional(),
618
- editmeta: z
619
- .object({
620
- fields: z
621
- .object({})
622
- .catchall(
623
- z
624
- .object({
625
- allowedValues: z.array(z.unknown()).optional(),
626
- autoCompleteUrl: z.string().optional(),
627
- configuration: z
628
- .object({})
629
- .catchall(z.unknown())
630
- .optional(),
631
- defaultValue: z.unknown().optional(),
632
- hasDefaultValue: z.boolean().optional(),
633
- key: z.string(),
634
- name: z.string(),
635
- operations: z.array(z.string()),
636
- required: z.boolean(),
637
- schema: z
638
- .object({
639
- configuration: z
640
- .object({})
641
- .catchall(z.unknown())
642
- .optional(),
643
- custom: z.string().optional(),
644
- customId: z.number().int().optional(),
645
- items: z.string().optional(),
646
- system: z.string().optional(),
647
- type: z.string(),
648
- })
649
- .strict(),
650
- })
651
- .strict(),
652
- )
653
- .optional(),
654
- })
655
- .catchall(z.unknown())
656
- .optional(),
657
- expand: z.string().optional(),
658
- fields: z.object({}).catchall(z.unknown()).optional(),
659
- fieldsToInclude: z
660
- .object({
661
- actuallyIncluded: z
662
- .array(z.string())
663
- .superRefine((items, ctx) => {
664
- if (new Set(items).size !== items.length) {
665
- ctx.addIssue({
666
- code: z.ZodIssueCode.custom,
667
- path: [],
668
- message: "Array items must be unique",
669
- });
670
- }
671
- })
672
- .optional(),
673
- excluded: z
674
- .array(z.string())
675
- .superRefine((items, ctx) => {
676
- if (new Set(items).size !== items.length) {
677
- ctx.addIssue({
678
- code: z.ZodIssueCode.custom,
679
- path: [],
680
- message: "Array items must be unique",
681
- });
682
- }
683
- })
684
- .optional(),
685
- included: z
686
- .array(z.string())
687
- .superRefine((items, ctx) => {
688
- if (new Set(items).size !== items.length) {
689
- ctx.addIssue({
690
- code: z.ZodIssueCode.custom,
691
- path: [],
692
- message: "Array items must be unique",
693
- });
694
- }
695
- })
696
- .optional(),
697
- })
698
- .strict()
699
- .optional(),
700
- id: z.string().optional(),
701
- key: z.string().optional(),
702
- names: z.object({}).catchall(z.string()).optional(),
703
- operations: validationSchemaStorage.lazy("Operations").optional(),
704
- properties: z.object({}).catchall(z.unknown()).optional(),
705
- renderedFields: z.object({}).catchall(z.unknown()).optional(),
706
- schema: z
707
- .object({})
708
- .catchall(
709
- z
710
- .object({
711
- configuration: z.object({}).catchall(z.unknown()).optional(),
712
- custom: z.string().optional(),
713
- customId: z.number().int().optional(),
714
- items: z.string().optional(),
715
- system: z.string().optional(),
716
- type: z.string(),
717
- })
718
- .strict(),
719
- )
720
- .optional(),
721
- self: z.string().optional(),
722
- transitions: z
723
- .array(
724
- z
725
- .object({
726
- expand: z.string().optional(),
727
- fields: z
728
- .object({})
729
- .catchall(
730
- z
731
- .object({
732
- allowedValues: z.array(z.unknown()).optional(),
733
- autoCompleteUrl: z.string().optional(),
734
- configuration: z
735
- .object({})
736
- .catchall(z.unknown())
737
- .optional(),
738
- defaultValue: z.unknown().optional(),
739
- hasDefaultValue: z.boolean().optional(),
740
- key: z.string(),
741
- name: z.string(),
742
- operations: z.array(z.string()),
743
- required: z.boolean(),
744
- schema: z
745
- .object({
746
- configuration: z
747
- .object({})
748
- .catchall(z.unknown())
749
- .optional(),
750
- custom: z.string().optional(),
751
- customId: z.number().int().optional(),
752
- items: z.string().optional(),
753
- system: z.string().optional(),
754
- type: z.string(),
755
- })
756
- .strict(),
757
- })
758
- .strict(),
759
- )
760
- .optional(),
761
- hasScreen: z.boolean().optional(),
762
- id: z.string().optional(),
763
- isAvailable: z.boolean().optional(),
764
- isConditional: z.boolean().optional(),
765
- isGlobal: z.boolean().optional(),
766
- isInitial: z.boolean().optional(),
767
- looped: z.boolean().optional(),
768
- name: z.string().optional(),
769
- to: z
770
- .object({
771
- description: z.string().optional(),
772
- iconUrl: z.string().optional(),
773
- id: z.string().optional(),
774
- name: z.string().optional(),
775
- scope: z
776
- .object({
777
- project: z
778
- .object({
779
- avatarUrls: z
780
- .object({
781
- "16x16": z.string().optional(),
782
- "24x24": z.string().optional(),
783
- "32x32": z.string().optional(),
784
- "48x48": z.string().optional(),
785
- })
786
- .strict()
787
- .optional(),
788
- id: z.string().optional(),
789
- key: z.string().optional(),
790
- name: z.string().optional(),
791
- projectCategory: z
792
- .object({
793
- description: z.string().optional(),
794
- id: z.string().optional(),
795
- name: z.string().optional(),
796
- self: z.string().optional(),
797
- })
798
- .strict()
799
- .optional(),
800
- projectTypeKey: z
801
- .enum(["software", "service_desk", "business"])
802
- .optional(),
803
- self: z.string().optional(),
804
- simplified: z.boolean().optional(),
805
- })
806
- .strict()
807
- .optional(),
808
- type: z.enum(["PROJECT", "TEMPLATE"]).optional(),
809
- })
810
- .catchall(z.unknown())
811
- .optional(),
812
- self: z.string().optional(),
813
- statusCategory: z
814
- .object({
815
- colorName: z.string().optional(),
816
- id: z.number().int().optional(),
817
- key: z.string().optional(),
818
- name: z.string().optional(),
819
- self: z.string().optional(),
820
- })
821
- .catchall(z.unknown())
822
- .optional(),
823
- })
824
- .catchall(z.unknown())
825
- .optional(),
826
- })
827
- .catchall(z.unknown()),
828
- )
829
- .optional(),
830
- versionedRepresentations: z
831
- .object({})
832
- .catchall(z.object({}).catchall(z.unknown()))
833
- .optional(),
834
- })
835
- .strict()
836
- .describe("IssueBean"),
837
- );
838
- validationSchemaStorage.register(
839
- "LinkGroup",
840
- z
841
- .object({
842
- groups: z.array(validationSchemaStorage.lazy("LinkGroup")).optional(),
843
- header: z
844
- .object({
845
- href: z.string().optional(),
846
- iconClass: z.string().optional(),
847
- id: z.string().optional(),
848
- label: z.string().optional(),
849
- styleClass: z.string().optional(),
850
- title: z.string().optional(),
851
- weight: z.number().int().optional(),
852
- })
853
- .strict()
854
- .optional(),
855
- id: z.string().optional(),
856
- links: z
857
- .array(
858
- z
859
- .object({
860
- href: z.string().optional(),
861
- iconClass: z.string().optional(),
862
- id: z.string().optional(),
863
- label: z.string().optional(),
864
- styleClass: z.string().optional(),
865
- title: z.string().optional(),
866
- weight: z.number().int().optional(),
867
- })
868
- .strict(),
869
- )
870
- .optional(),
871
- styleClass: z.string().optional(),
872
- weight: z.number().int().optional(),
873
- })
874
- .strict()
875
- .describe("LinkGroup"),
876
- );
877
- validationSchemaStorage.register(
878
- "Operations",
879
- z
880
- .object({
881
- linkGroups: z
882
- .array(validationSchemaStorage.lazy("LinkGroup"))
883
- .optional(),
884
- })
885
- .catchall(z.unknown())
886
- .describe("Operations"),
887
- );
888
- validationSchemaStorage.register(
889
- "SearchResults",
890
- z
891
- .object({
892
- expand: z.string().optional(),
893
- issues: z.array(validationSchemaStorage.lazy("IssueBean")).optional(),
894
- maxResults: z.number().int().optional(),
895
- names: z.object({}).catchall(z.string()).optional(),
896
- schema: z
897
- .object({})
898
- .catchall(
899
- z
900
- .object({
901
- configuration: z.object({}).catchall(z.unknown()).optional(),
902
- custom: z.string().optional(),
903
- customId: z.number().int().optional(),
904
- items: z.string().optional(),
905
- system: z.string().optional(),
906
- type: z.string(),
907
- })
908
- .strict(),
909
- )
910
- .optional(),
911
- startAt: z.number().int().optional(),
912
- total: z.number().int().optional(),
913
- warningMessages: z.array(z.string()).optional(),
914
- })
915
- .strict()
916
- .describe("SearchResults"),
917
- );
918
- }