@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,1268 +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 {
8
- type AvatarUrlsBean,
9
- type EntityProperty,
10
- type ErrorCollection,
11
- type GroupName,
12
- type JsonTypeBean,
13
- registerCommonValidationSchemas,
14
- type Scope,
15
- type SimpleLink,
16
- type StatusDetails,
17
- type UserDetails,
18
- } from "./common";
19
- /** Details of a filter for exporting archived issues. */
20
- export interface ArchivedIssuesFilterRequest extends Record<string, unknown> {
21
- /** List archived issues archived by a specified account ID. */
22
- archivedBy?: string[];
23
- /** List issues archived within a specified date range. */
24
- archivedDateRange?: DateRangeFilterRequest;
25
- /** List archived issues with a specified issue type ID. */
26
- issueTypes?: string[];
27
- /** List archived issues with a specified project key. */
28
- projects?: string[];
29
- /** List archived issues where the reporter is a specified account ID. */
30
- reporters?: string[];
31
- }
32
- export interface ArchiveIssueAsyncRequest {
33
- jql?: string;
34
- }
35
- export interface BulkOperationErrorResult {
36
- /** Error messages from an operation. */
37
- elementErrors?: ErrorCollection;
38
- failedElementNumber?: number;
39
- status?: number;
40
- }
41
- /** A change item. */
42
- export interface ChangeDetails {
43
- /** The name of the field changed. */
44
- field?: string;
45
- /** The ID of the field changed. */
46
- fieldId?: string;
47
- /** The type of the field changed. */
48
- fieldtype?: string;
49
- /** The details of the original value. */
50
- from?: string | null;
51
- /** The details of the original value as a string. */
52
- fromString?: string | null;
53
- /** The details of the new value. */
54
- to?: string;
55
- /** The details of the new value as a string. */
56
- toString: string;
57
- }
58
- /**
59
- * A log of changes made to issue fields. Changelogs related to workflow
60
- * associations are currently being deprecated.
61
- */
62
- export interface Changelog {
63
- /** The user who made the change. */
64
- author?: UserDetails;
65
- /** The date on which the change took place. */
66
- created?: string;
67
- /** The history metadata associated with the changed. */
68
- historyMetadata?: HistoryMetadata;
69
- /** The ID of the changelog. */
70
- id?: string;
71
- /** The list of items changed. */
72
- items?: ChangeDetails[];
73
- }
74
- /** Details about a created issue or subtask. */
75
- export interface CreatedIssue {
76
- /** The ID of the created issue or subtask. */
77
- id?: string;
78
- /** The key of the created issue or subtask. */
79
- key?: string;
80
- /** The URL of the created issue or subtask. */
81
- self?: string;
82
- /** The response code and messages related to any requested transition. */
83
- transition?: NestedResponse;
84
- /** The response code and messages related to any requested watchers. */
85
- watchers?: NestedResponse;
86
- }
87
- /** Details about the issues created and the errors for requests that failed. */
88
- export interface CreatedIssues {
89
- /** Error details for failed issue creation requests. */
90
- errors?: BulkOperationErrorResult[];
91
- /** Details of the issues created. */
92
- issues?: CreatedIssue[];
93
- }
94
- /** List issues archived within a specified date range. */
95
- export interface DateRangeFilterRequest {
96
- /** List issues archived after a specified date, passed in the YYYY-MM-DD format. */
97
- dateAfter: string;
98
- /** List issues archived before a specified date provided in the YYYY-MM-DD format. */
99
- dateBefore: string;
100
- }
101
- export interface Error {
102
- count?: number;
103
- issueIdsOrKeys?: string[];
104
- message?: string;
105
- }
106
- export interface Errors {
107
- issueIsSubtask?: Error;
108
- issuesInArchivedProjects?: Error;
109
- issuesInUnlicensedProjects?: Error;
110
- issuesNotFound?: Error;
111
- }
112
- /** The response for status request for a running/completed export task. */
113
- export interface ExportArchivedIssuesTaskProgressResponse {
114
- fileUrl?: string;
115
- payload?: string;
116
- progress?: number;
117
- status?: string;
118
- submittedTime?: string;
119
- taskId?: string;
120
- }
121
- /** The metadata describing an issue field for createmeta. */
122
- export interface FieldCreateMetadata {
123
- /** The list of values allowed in the field. */
124
- allowedValues?: unknown[];
125
- /** The URL that can be used to automatically complete the field. */
126
- autoCompleteUrl?: string;
127
- /** The configuration properties. */
128
- configuration?: {
129
- [key: string]: unknown;
130
- };
131
- /** The default value of the field. */
132
- defaultValue?: unknown;
133
- /** The field id. */
134
- fieldId: string;
135
- /** Whether the field has a default value. */
136
- hasDefaultValue?: boolean;
137
- /** The key of the field. */
138
- key: string;
139
- /** The name of the field. */
140
- name: string;
141
- /** The list of operations that can be performed on the field. */
142
- operations: string[];
143
- /** Whether the field is required. */
144
- required: boolean;
145
- /** The data type of the field. */
146
- schema: JsonTypeBean;
147
- }
148
- /** The metadata describing an issue field. */
149
- export interface FieldMetadata {
150
- /** The list of values allowed in the field. */
151
- allowedValues?: unknown[];
152
- /** The URL that can be used to automatically complete the field. */
153
- autoCompleteUrl?: string;
154
- /** The configuration properties. */
155
- configuration?: {
156
- [key: string]: unknown;
157
- };
158
- /** The default value of the field. */
159
- defaultValue?: unknown;
160
- /** Whether the field has a default value. */
161
- hasDefaultValue?: boolean;
162
- /** The key of the field. */
163
- key: string;
164
- /** The name of the field. */
165
- name: string;
166
- /** The list of operations that can be performed on the field. */
167
- operations: string[];
168
- /** Whether the field is required. */
169
- required: boolean;
170
- /** The data type of the field. */
171
- schema: JsonTypeBean;
172
- }
173
- /** Details of an operation to perform on a field. */
174
- export interface FieldUpdateOperation {
175
- /**
176
- * The value to add to the field.
177
- *
178
- * @example triaged
179
- */
180
- add?: unknown;
181
- /**
182
- * The field value to copy from another issue.
183
- *
184
- * @example {
185
- * "issuelinks": {
186
- * "sourceIssues": [
187
- * {
188
- * "key": "FP-5"
189
- * }
190
- * ]
191
- * }
192
- * }
193
- */
194
- copy?: unknown;
195
- /**
196
- * The value to edit in the field.
197
- *
198
- * @example {
199
- * "originalEstimate": "1w 1d",
200
- * "remainingEstimate": "4d"
201
- * }
202
- */
203
- edit?: unknown;
204
- /**
205
- * The value to removed from the field.
206
- *
207
- * @example blocker
208
- */
209
- remove?: unknown;
210
- /**
211
- * The value to set in the field.
212
- *
213
- * @example A new summary
214
- */
215
- set?: unknown;
216
- }
217
- /** Details of issue history metadata. */
218
- export interface HistoryMetadata extends Record<string, unknown> {
219
- /** The activity described in the history record. */
220
- activityDescription?: string;
221
- /** The key of the activity described in the history record. */
222
- activityDescriptionKey?: string;
223
- /** Details of the user whose action created the history record. */
224
- actor?: HistoryMetadataParticipant;
225
- /** Details of the cause that triggered the creation the history record. */
226
- cause?: HistoryMetadataParticipant;
227
- /** The description of the history record. */
228
- description?: string;
229
- /** The description key of the history record. */
230
- descriptionKey?: string;
231
- /** The description of the email address associated the history record. */
232
- emailDescription?: string;
233
- /** The description key of the email address associated the history record. */
234
- emailDescriptionKey?: string;
235
- /** Additional arbitrary information about the history record. */
236
- extraData?: {
237
- [key: string]: string;
238
- };
239
- /** Details of the system that generated the history record. */
240
- generator?: HistoryMetadataParticipant;
241
- /** The type of the history record. */
242
- type?: string;
243
- }
244
- /** Details of user or system associated with a issue history metadata item. */
245
- export interface HistoryMetadataParticipant extends Record<string, unknown> {
246
- /** The URL to an avatar for the user or system associated with a history record. */
247
- avatarUrl?: string;
248
- /** The display name of the user or system associated with a history record. */
249
- displayName?: string;
250
- /**
251
- * The key of the display name of the user or system associated with a history
252
- * record.
253
- */
254
- displayNameKey?: string;
255
- /** The ID of the user or system associated with a history record. */
256
- id?: string;
257
- /** The type of the user or system associated with a history record. */
258
- type?: string;
259
- /** The URL of the user or system associated with a history record. */
260
- url?: string;
261
- }
262
- export interface IncludedFields {
263
- actuallyIncluded?: string[];
264
- excluded?: string[];
265
- included?: string[];
266
- }
267
- /** List of Issue Ids Or Keys that are to be archived or unarchived */
268
- export interface IssueArchivalSyncRequest {
269
- issueIdsOrKeys?: string[];
270
- }
271
- /**
272
- * Number of archived/unarchived issues and list of errors that occurred during
273
- * the action, if any.
274
- */
275
- export interface IssueArchivalSyncResponse {
276
- errors?: Errors;
277
- numberOfIssuesUpdated?: number;
278
- }
279
- /** A list of changelog IDs. */
280
- export interface IssueChangelogIds {
281
- /** The list of changelog IDs. */
282
- changelogIds: number[];
283
- }
284
- /** The wrapper for the issue creation metadata for a list of projects. */
285
- export interface IssueCreateMetadata {
286
- /** Expand options that include additional project details in the response. */
287
- expand?: string;
288
- /** List of projects and their issue creation metadata. */
289
- projects?: ProjectIssueCreateMetadata[];
290
- }
291
- /** Details about an issue event. */
292
- export interface IssueEvent {
293
- /** The ID of the event. */
294
- id?: number;
295
- /** The name of the event. */
296
- name?: string;
297
- }
298
- export interface IssueLimitReportRequest {
299
- /**
300
- * A list of fields and their respective approaching limit threshold. Required for
301
- * querying issues approaching limits. Optional for querying issues breaching
302
- * limits. Accepted fields are: `comment`, `worklog`, `attachment`,
303
- * `remoteIssueLinks`, and `issuelinks`. Example:
304
- * `{"issuesApproachingLimitParams": {"comment": 4500, "attachment": 1800}}`
305
- */
306
- issuesApproachingLimitParams?: {
307
- [key: string]: number;
308
- };
309
- }
310
- export interface IssueLimitReportResponseBean {
311
- /** A list of ids of issues approaching the limit, and their field count */
312
- issuesApproachingLimit?: {
313
- [key: string]: {
314
- [key: string]: number;
315
- };
316
- };
317
- /** A list of ids of issues breaching the limit, and their field count */
318
- issuesBreachingLimit?: {
319
- [key: string]: {
320
- [key: string]: number;
321
- };
322
- };
323
- /** The fields and their defined limits */
324
- limits?: {
325
- [key: string]: number;
326
- };
327
- }
328
- export interface IssuesUpdateBean extends Record<string, unknown> {
329
- issueUpdates?: IssueUpdateDetails[];
330
- }
331
- /** Details of an issue transition. */
332
- export interface IssueTransition extends Record<string, unknown> {
333
- /** Expand options that include additional transition details in the response. */
334
- expand?: string;
335
- /**
336
- * Details of the fields associated with the issue transition screen. Use this
337
- * information to populate `fields` and `update` in a transition request.
338
- */
339
- fields?: {
340
- /** The metadata describing an issue field. */
341
- [key: string]: FieldMetadata;
342
- };
343
- /** Whether there is a screen associated with the issue transition. */
344
- hasScreen?: boolean;
345
- /**
346
- * The ID of the issue transition. Required when specifying a transition to
347
- * undertake.
348
- */
349
- id?: string;
350
- /** Whether the transition is available to be performed. */
351
- isAvailable?: boolean;
352
- /** Whether the issue has to meet criteria before the issue transition is applied. */
353
- isConditional?: boolean;
354
- /**
355
- * Whether the issue transition is global, that is, the transition is applied to
356
- * issues regardless of their status.
357
- */
358
- isGlobal?: boolean;
359
- /** Whether this is the initial issue transition for the workflow. */
360
- isInitial?: boolean;
361
- looped?: boolean;
362
- /** The name of the issue transition. */
363
- name?: string;
364
- /** Details of the issue status after the transition. */
365
- to?: StatusDetails;
366
- }
367
- /** Details of the issue creation metadata for an issue type. */
368
- export interface IssueTypeIssueCreateMetadata {
369
- /** The ID of the issue type's avatar. */
370
- avatarId?: number;
371
- /** The description of the issue type. */
372
- description?: string;
373
- /** Unique ID for next-gen projects. */
374
- entityId?: string;
375
- /**
376
- * Expand options that include additional issue type metadata details in the
377
- * response.
378
- */
379
- expand?: string;
380
- /** List of the fields available when creating an issue for the issue type. */
381
- fields?: {
382
- /** The metadata describing an issue field. */
383
- [key: string]: FieldMetadata;
384
- };
385
- /** Hierarchy level of the issue type. */
386
- hierarchyLevel?: number;
387
- /** The URL of the issue type's avatar. */
388
- iconUrl?: string;
389
- /** The ID of the issue type. */
390
- id?: string;
391
- /** The name of the issue type. */
392
- name?: string;
393
- /** Details of the next-gen projects the issue type is available in. */
394
- scope?: Scope;
395
- /** The URL of these issue type details. */
396
- self?: string;
397
- /** Whether this issue type is used to create subtasks. */
398
- subtask?: boolean;
399
- }
400
- /** Details of an issue update request. */
401
- export interface IssueUpdateDetails extends Record<string, unknown> {
402
- /**
403
- * List of issue screen fields to update, specifying the sub-field to update and
404
- * its value for each field. This field provides a straightforward option when
405
- * setting a sub-field. When multiple sub-fields or other operations are required,
406
- * use `update`. Fields included in here cannot be included in `update`.
407
- */
408
- fields?: {
409
- [key: string]: unknown;
410
- };
411
- /** Additional issue history details. */
412
- historyMetadata?: HistoryMetadata;
413
- /** Details of issue properties to be add or update. */
414
- properties?: EntityProperty[];
415
- /**
416
- * Details of a transition. Required when performing a transition, optional when
417
- * creating or editing an issue.
418
- */
419
- transition?: IssueTransition;
420
- /**
421
- * A Map containing the field field name and a list of operations to perform on
422
- * the issue screen field. Note that fields included in here cannot be included in
423
- * `fields`.
424
- */
425
- update?: {
426
- [key: string]: FieldUpdateOperation[];
427
- };
428
- }
429
- /** A list of editable field details. */
430
- export interface IssueUpdateMetadata extends Record<string, unknown> {
431
- fields?: {
432
- /** The metadata describing an issue field. */
433
- [key: string]: FieldMetadata;
434
- };
435
- }
436
- /** Details a link group, which defines issue operations. */
437
- export interface LinkGroup {
438
- groups?: LinkGroup[];
439
- /** Details about the operations available in this version. */
440
- header?: SimpleLink;
441
- id?: string;
442
- links?: SimpleLink[];
443
- styleClass?: string;
444
- weight?: number;
445
- }
446
- /** The response code and messages related to any requested watchers. */
447
- export interface NestedResponse {
448
- /** Error messages from an operation. */
449
- errorCollection?: ErrorCollection;
450
- status?: number;
451
- warningCollection?: WarningCollection;
452
- }
453
- /** Details about a notification. */
454
- export interface Notification extends Record<string, unknown> {
455
- /** The HTML body of the email notification for the issue. */
456
- htmlBody?: string;
457
- /** Restricts the notifications to users with the specified permissions. */
458
- restrict?: NotificationRecipientsRestrictions;
459
- /**
460
- * The subject of the email notification for the issue. If this is not specified,
461
- * then the subject is set to the issue key and summary.
462
- */
463
- subject?: string;
464
- /** The plain text body of the email notification for the issue. */
465
- textBody?: string;
466
- /** The recipients of the email notification for the issue. */
467
- to?: NotificationRecipients;
468
- }
469
- /** Details of the users and groups to receive the notification. */
470
- export interface NotificationRecipients extends Record<string, unknown> {
471
- /** Whether the notification should be sent to the issue's assignees. */
472
- assignee?: boolean;
473
- /** List of groupIds to receive the notification. */
474
- groupIds?: string[];
475
- /** List of groups to receive the notification. */
476
- groups?: GroupName[];
477
- /** Whether the notification should be sent to the issue's reporter. */
478
- reporter?: boolean;
479
- /** List of users to receive the notification. */
480
- users?: UserDetails[];
481
- /** Whether the notification should be sent to the issue's voters. */
482
- voters?: boolean;
483
- /** Whether the notification should be sent to the issue's watchers. */
484
- watchers?: boolean;
485
- }
486
- /**
487
- * Details of the group membership or permissions needed to receive the
488
- * notification.
489
- */
490
- export interface NotificationRecipientsRestrictions {
491
- /** List of groupId memberships required to receive the notification. */
492
- groupIds?: string[];
493
- /** List of group memberships required to receive the notification. */
494
- groups?: GroupName[];
495
- /** List of permissions required to receive the notification. */
496
- permissions?: RestrictedPermission[];
497
- }
498
- /** Details of the operations that can be performed on the issue. */
499
- export interface Operations extends Record<string, unknown> {
500
- /** Details of the link groups defining issue operations. */
501
- linkGroups?: LinkGroup[];
502
- }
503
- /** A page of items. */
504
- export interface PageBeanChangelog {
505
- /** Whether this is the last page. */
506
- isLast?: boolean;
507
- /** The maximum number of items that could be returned. */
508
- maxResults?: number;
509
- /** If there is another page of results, the URL of the next page. */
510
- nextPage?: string;
511
- /** The URL of the page. */
512
- self?: string;
513
- /** The index of the first item returned. */
514
- startAt?: number;
515
- /** The number of items returned. */
516
- total?: number;
517
- /** The list of items. */
518
- values?: Changelog[];
519
- }
520
- /** A page of changelogs. */
521
- export interface PageOfChangelogs {
522
- /** The list of changelogs. */
523
- histories?: Changelog[];
524
- /** The maximum number of results that could be on the page. */
525
- maxResults?: number;
526
- /** The index of the first item returned on the page. */
527
- startAt?: number;
528
- /** The number of results on the page. */
529
- total?: number;
530
- }
531
- /** A page of CreateMetaIssueTypes. */
532
- export interface PageOfCreateMetaIssueTypes extends Record<string, unknown> {
533
- createMetaIssueType?: IssueTypeIssueCreateMetadata[];
534
- /** The list of CreateMetaIssueType. */
535
- issueTypes?: IssueTypeIssueCreateMetadata[];
536
- /** The maximum number of items to return per page. */
537
- maxResults?: number;
538
- /** The index of the first item returned. */
539
- startAt?: number;
540
- /** The total number of items in all pages. */
541
- total?: number;
542
- }
543
- /** A page of CreateMetaIssueType with Field. */
544
- export interface PageOfCreateMetaIssueTypeWithField
545
- extends Record<string, unknown> {
546
- /** The collection of FieldCreateMetaBeans. */
547
- fields?: FieldCreateMetadata[];
548
- /** The maximum number of items to return per page. */
549
- maxResults?: number;
550
- results?: FieldCreateMetadata[];
551
- /** The index of the first item returned. */
552
- startAt?: number;
553
- /** The total number of items in all pages. */
554
- total?: number;
555
- }
556
- /** Details of the issue creation metadata for a project. */
557
- export interface ProjectIssueCreateMetadata {
558
- /** List of the project's avatars, returning the avatar size and associated URL. */
559
- avatarUrls?: AvatarUrlsBean;
560
- /**
561
- * Expand options that include additional project issue create metadata details in
562
- * the response.
563
- */
564
- expand?: string;
565
- /** The ID of the project. */
566
- id?: string;
567
- /** List of the issue types supported by the project. */
568
- issuetypes?: IssueTypeIssueCreateMetadata[];
569
- /** The key of the project. */
570
- key?: string;
571
- /** The name of the project. */
572
- name?: string;
573
- /** The URL of the project. */
574
- self?: string;
575
- }
576
- /** Details of the permission. */
577
- export interface RestrictedPermission extends Record<string, unknown> {
578
- /**
579
- * The ID of the permission. Either `id` or `key` must be specified. Use [Get all
580
- * permissions](#api-rest-api-3-permissions-get) to get the list of permissions.
581
- */
582
- id?: string;
583
- /**
584
- * The key of the permission. Either `id` or `key` must be specified. Use [Get all
585
- * permissions](#api-rest-api-3-permissions-get) to get the list of permissions.
586
- */
587
- key?: string;
588
- }
589
- /** List of issue transitions. */
590
- export interface Transitions {
591
- /** Expand options that include additional transitions details in the response. */
592
- expand?: string;
593
- /** List of issue transitions. */
594
- transitions?: IssueTransition[];
595
- }
596
- export interface WarningCollection {
597
- warnings?: string[];
598
- }
599
- export function registerIssuesValidationSchemas(
600
- validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>,
601
- ) {
602
- validationSchemaStorage.register(
603
- "ArchivedIssuesFilterRequest",
604
- z
605
- .object({
606
- archivedBy: z.array(z.string()).optional(),
607
- archivedDateRange: validationSchemaStorage
608
- .lazy("DateRangeFilterRequest")
609
- .optional(),
610
- issueTypes: z.array(z.string()).optional(),
611
- projects: z.array(z.string()).optional(),
612
- reporters: z.array(z.string()).optional(),
613
- })
614
- .catchall(z.unknown())
615
- .describe("ArchivedIssuesFilterRequest"),
616
- );
617
- validationSchemaStorage.register(
618
- "ArchiveIssueAsyncRequest",
619
- z
620
- .object({
621
- jql: z.string().optional(),
622
- })
623
- .strict()
624
- .describe("ArchiveIssueAsyncRequest"),
625
- );
626
- validationSchemaStorage.register(
627
- "BulkOperationErrorResult",
628
- z
629
- .object({
630
- elementErrors: validationSchemaStorage
631
- .lazy("ErrorCollection")
632
- .optional(),
633
- failedElementNumber: z.number().int().optional(),
634
- status: z.number().int().optional(),
635
- })
636
- .strict()
637
- .describe("BulkOperationErrorResult"),
638
- );
639
- validationSchemaStorage.register(
640
- "ChangeDetails",
641
- z
642
- .object({
643
- field: z.string().optional(),
644
- fieldId: z.string().optional(),
645
- fieldtype: z.string().optional(),
646
- from: z.nullable(z.string()).optional(),
647
- fromString: z.nullable(z.string()).optional(),
648
- to: z.string().optional(),
649
- toString: z.string(),
650
- })
651
- .strict()
652
- .describe("ChangeDetails"),
653
- );
654
- validationSchemaStorage.register(
655
- "Changelog",
656
- z
657
- .object({
658
- author: validationSchemaStorage.lazy("UserDetails").optional(),
659
- created: z.string().optional(),
660
- historyMetadata: validationSchemaStorage
661
- .lazy("HistoryMetadata")
662
- .optional(),
663
- id: z.string().optional(),
664
- items: z
665
- .array(validationSchemaStorage.lazy("ChangeDetails"))
666
- .optional(),
667
- })
668
- .strict()
669
- .describe("Changelog"),
670
- );
671
- validationSchemaStorage.register(
672
- "CreatedIssue",
673
- z
674
- .object({
675
- id: z.string().optional(),
676
- key: z.string().optional(),
677
- self: z.string().optional(),
678
- transition: validationSchemaStorage.lazy("NestedResponse").optional(),
679
- watchers: validationSchemaStorage.lazy("NestedResponse").optional(),
680
- })
681
- .strict()
682
- .describe("CreatedIssue"),
683
- );
684
- validationSchemaStorage.register(
685
- "CreatedIssues",
686
- z
687
- .object({
688
- errors: z
689
- .array(validationSchemaStorage.lazy("BulkOperationErrorResult"))
690
- .optional(),
691
- issues: z
692
- .array(validationSchemaStorage.lazy("CreatedIssue"))
693
- .optional(),
694
- })
695
- .strict()
696
- .describe("CreatedIssues"),
697
- );
698
- validationSchemaStorage.register(
699
- "DateRangeFilterRequest",
700
- z
701
- .object({
702
- dateAfter: z.string(),
703
- dateBefore: z.string(),
704
- })
705
- .strict()
706
- .describe("DateRangeFilterRequest"),
707
- );
708
- validationSchemaStorage.register(
709
- "Error",
710
- z
711
- .object({
712
- count: z.number().int().optional(),
713
- issueIdsOrKeys: z
714
- .array(z.string())
715
- .superRefine((items, ctx) => {
716
- if (new Set(items).size !== items.length) {
717
- ctx.addIssue({
718
- code: z.ZodIssueCode.custom,
719
- path: [],
720
- message: "Array items must be unique",
721
- });
722
- }
723
- })
724
- .optional(),
725
- message: z.string().optional(),
726
- })
727
- .strict()
728
- .describe("Error"),
729
- );
730
- validationSchemaStorage.register(
731
- "Errors",
732
- z
733
- .object({
734
- issueIsSubtask: validationSchemaStorage.lazy("Error").optional(),
735
- issuesInArchivedProjects: validationSchemaStorage
736
- .lazy("Error")
737
- .optional(),
738
- issuesInUnlicensedProjects: validationSchemaStorage
739
- .lazy("Error")
740
- .optional(),
741
- issuesNotFound: validationSchemaStorage.lazy("Error").optional(),
742
- })
743
- .strict()
744
- .describe("Errors"),
745
- );
746
- validationSchemaStorage.register(
747
- "ExportArchivedIssuesTaskProgressResponse",
748
- z
749
- .object({
750
- fileUrl: z.string().optional(),
751
- payload: z.string().optional(),
752
- progress: z.number().int().optional(),
753
- status: z.string().optional(),
754
- submittedTime: z.string().optional(),
755
- taskId: z.string().optional(),
756
- })
757
- .strict()
758
- .describe("ExportArchivedIssuesTaskProgressResponse"),
759
- );
760
- validationSchemaStorage.register(
761
- "FieldCreateMetadata",
762
- z
763
- .object({
764
- allowedValues: z.array(z.unknown()).optional(),
765
- autoCompleteUrl: z.string().optional(),
766
- configuration: z.object({}).catchall(z.unknown()).optional(),
767
- defaultValue: z.unknown().optional(),
768
- fieldId: z.string(),
769
- hasDefaultValue: z.boolean().optional(),
770
- key: z.string(),
771
- name: z.string(),
772
- operations: z.array(z.string()),
773
- required: z.boolean(),
774
- schema: validationSchemaStorage.lazy("JsonTypeBean"),
775
- })
776
- .strict()
777
- .describe("FieldCreateMetadata"),
778
- );
779
- validationSchemaStorage.register(
780
- "FieldMetadata",
781
- z
782
- .object({
783
- allowedValues: z.array(z.unknown()).optional(),
784
- autoCompleteUrl: z.string().optional(),
785
- configuration: z.object({}).catchall(z.unknown()).optional(),
786
- defaultValue: z.unknown().optional(),
787
- hasDefaultValue: z.boolean().optional(),
788
- key: z.string(),
789
- name: z.string(),
790
- operations: z.array(z.string()),
791
- required: z.boolean(),
792
- schema: validationSchemaStorage.lazy("JsonTypeBean"),
793
- })
794
- .strict()
795
- .describe("FieldMetadata"),
796
- );
797
- validationSchemaStorage.register(
798
- "FieldUpdateOperation",
799
- z
800
- .object({
801
- add: z.unknown().optional(),
802
- copy: z.unknown().optional(),
803
- edit: z.unknown().optional(),
804
- remove: z.unknown().optional(),
805
- set: z.unknown().optional(),
806
- })
807
- .strict()
808
- .describe("FieldUpdateOperation"),
809
- );
810
- validationSchemaStorage.register(
811
- "HistoryMetadata",
812
- z
813
- .object({
814
- activityDescription: z.string().optional(),
815
- activityDescriptionKey: z.string().optional(),
816
- actor: validationSchemaStorage
817
- .lazy("HistoryMetadataParticipant")
818
- .optional(),
819
- cause: validationSchemaStorage
820
- .lazy("HistoryMetadataParticipant")
821
- .optional(),
822
- description: z.string().optional(),
823
- descriptionKey: z.string().optional(),
824
- emailDescription: z.string().optional(),
825
- emailDescriptionKey: z.string().optional(),
826
- extraData: z.object({}).catchall(z.string()).optional(),
827
- generator: validationSchemaStorage
828
- .lazy("HistoryMetadataParticipant")
829
- .optional(),
830
- type: z.string().optional(),
831
- })
832
- .catchall(z.unknown())
833
- .describe("HistoryMetadata"),
834
- );
835
- validationSchemaStorage.register(
836
- "HistoryMetadataParticipant",
837
- z
838
- .object({
839
- avatarUrl: z.string().optional(),
840
- displayName: z.string().optional(),
841
- displayNameKey: z.string().optional(),
842
- id: z.string().optional(),
843
- type: z.string().optional(),
844
- url: z.string().optional(),
845
- })
846
- .catchall(z.unknown())
847
- .describe("HistoryMetadataParticipant"),
848
- );
849
- validationSchemaStorage.register(
850
- "IncludedFields",
851
- z
852
- .object({
853
- actuallyIncluded: z
854
- .array(z.string())
855
- .superRefine((items, ctx) => {
856
- if (new Set(items).size !== items.length) {
857
- ctx.addIssue({
858
- code: z.ZodIssueCode.custom,
859
- path: [],
860
- message: "Array items must be unique",
861
- });
862
- }
863
- })
864
- .optional(),
865
- excluded: z
866
- .array(z.string())
867
- .superRefine((items, ctx) => {
868
- if (new Set(items).size !== items.length) {
869
- ctx.addIssue({
870
- code: z.ZodIssueCode.custom,
871
- path: [],
872
- message: "Array items must be unique",
873
- });
874
- }
875
- })
876
- .optional(),
877
- included: z
878
- .array(z.string())
879
- .superRefine((items, ctx) => {
880
- if (new Set(items).size !== items.length) {
881
- ctx.addIssue({
882
- code: z.ZodIssueCode.custom,
883
- path: [],
884
- message: "Array items must be unique",
885
- });
886
- }
887
- })
888
- .optional(),
889
- })
890
- .strict()
891
- .describe("IncludedFields"),
892
- );
893
- validationSchemaStorage.register(
894
- "IssueArchivalSyncRequest",
895
- z
896
- .object({
897
- issueIdsOrKeys: z.array(z.string()).optional(),
898
- })
899
- .strict()
900
- .describe("IssueArchivalSyncRequest"),
901
- );
902
- validationSchemaStorage.register(
903
- "IssueArchivalSyncResponse",
904
- z
905
- .object({
906
- errors: validationSchemaStorage.lazy("Errors").optional(),
907
- numberOfIssuesUpdated: z.number().int().optional(),
908
- })
909
- .strict()
910
- .describe("IssueArchivalSyncResponse"),
911
- );
912
- validationSchemaStorage.register(
913
- "IssueChangelogIds",
914
- z
915
- .object({
916
- changelogIds: z.array(z.number().int()).superRefine((items, ctx) => {
917
- if (
918
- new Set(items.map((item) => JSON.stringify(item))).size !==
919
- items.length
920
- ) {
921
- ctx.addIssue({
922
- code: z.ZodIssueCode.custom,
923
- path: [],
924
- message: "Array items must be unique",
925
- });
926
- }
927
- }),
928
- })
929
- .strict()
930
- .describe("IssueChangelogIds"),
931
- );
932
- validationSchemaStorage.register(
933
- "IssueCreateMetadata",
934
- z
935
- .object({
936
- expand: z.string().optional(),
937
- projects: z
938
- .array(validationSchemaStorage.lazy("ProjectIssueCreateMetadata"))
939
- .optional(),
940
- })
941
- .strict()
942
- .describe("IssueCreateMetadata"),
943
- );
944
- validationSchemaStorage.register(
945
- "IssueEvent",
946
- z
947
- .object({
948
- id: z.number().int().optional(),
949
- name: z.string().optional(),
950
- })
951
- .strict()
952
- .describe("IssueEvent"),
953
- );
954
- validationSchemaStorage.register(
955
- "IssueLimitReportRequest",
956
- z
957
- .object({
958
- issuesApproachingLimitParams: z
959
- .object({})
960
- .catchall(z.number().int())
961
- .optional(),
962
- })
963
- .strict()
964
- .describe("IssueLimitReportRequest"),
965
- );
966
- validationSchemaStorage.register(
967
- "IssueLimitReportResponseBean",
968
- z
969
- .object({
970
- issuesApproachingLimit: z
971
- .object({})
972
- .catchall(z.object({}).catchall(z.number().int()))
973
- .optional(),
974
- issuesBreachingLimit: z
975
- .object({})
976
- .catchall(z.object({}).catchall(z.number().int()))
977
- .optional(),
978
- limits: z.object({}).catchall(z.number().int()).optional(),
979
- })
980
- .strict()
981
- .describe("IssueLimitReportResponseBean"),
982
- );
983
- validationSchemaStorage.register(
984
- "IssuesUpdateBean",
985
- z
986
- .object({
987
- issueUpdates: z
988
- .array(validationSchemaStorage.lazy("IssueUpdateDetails"))
989
- .optional(),
990
- })
991
- .catchall(z.unknown())
992
- .describe("IssuesUpdateBean"),
993
- );
994
- validationSchemaStorage.register(
995
- "IssueTransition",
996
- z
997
- .object({
998
- expand: z.string().optional(),
999
- fields: z
1000
- .object({})
1001
- .catchall(validationSchemaStorage.lazy("FieldMetadata"))
1002
- .optional(),
1003
- hasScreen: z.boolean().optional(),
1004
- id: z.string().optional(),
1005
- isAvailable: z.boolean().optional(),
1006
- isConditional: z.boolean().optional(),
1007
- isGlobal: z.boolean().optional(),
1008
- isInitial: z.boolean().optional(),
1009
- looped: z.boolean().optional(),
1010
- name: z.string().optional(),
1011
- to: validationSchemaStorage.lazy("StatusDetails").optional(),
1012
- })
1013
- .catchall(z.unknown())
1014
- .describe("IssueTransition"),
1015
- );
1016
- validationSchemaStorage.register(
1017
- "IssueTypeIssueCreateMetadata",
1018
- z
1019
- .object({
1020
- avatarId: z.number().int().optional(),
1021
- description: z.string().optional(),
1022
- entityId: z.string().optional(),
1023
- expand: z.string().optional(),
1024
- fields: z
1025
- .object({})
1026
- .catchall(validationSchemaStorage.lazy("FieldMetadata"))
1027
- .optional(),
1028
- hierarchyLevel: z.number().int().optional(),
1029
- iconUrl: z.string().optional(),
1030
- id: z.string().optional(),
1031
- name: z.string().optional(),
1032
- scope: validationSchemaStorage.lazy("Scope").optional(),
1033
- self: z.string().optional(),
1034
- subtask: z.boolean().optional(),
1035
- })
1036
- .strict()
1037
- .describe("IssueTypeIssueCreateMetadata"),
1038
- );
1039
- validationSchemaStorage.register(
1040
- "IssueUpdateDetails",
1041
- z
1042
- .object({
1043
- fields: z.object({}).catchall(z.unknown()).optional(),
1044
- historyMetadata: validationSchemaStorage
1045
- .lazy("HistoryMetadata")
1046
- .optional(),
1047
- properties: z
1048
- .array(validationSchemaStorage.lazy("EntityProperty"))
1049
- .optional(),
1050
- transition: validationSchemaStorage.lazy("IssueTransition").optional(),
1051
- update: z
1052
- .object({})
1053
- .catchall(
1054
- z.array(validationSchemaStorage.lazy("FieldUpdateOperation")),
1055
- )
1056
- .optional(),
1057
- })
1058
- .catchall(z.unknown())
1059
- .describe("IssueUpdateDetails"),
1060
- );
1061
- validationSchemaStorage.register(
1062
- "IssueUpdateMetadata",
1063
- z
1064
- .object({
1065
- fields: z
1066
- .object({})
1067
- .catchall(validationSchemaStorage.lazy("FieldMetadata"))
1068
- .optional(),
1069
- })
1070
- .catchall(z.unknown())
1071
- .describe("IssueUpdateMetadata"),
1072
- );
1073
- validationSchemaStorage.register(
1074
- "LinkGroup",
1075
- z
1076
- .object({
1077
- groups: z.array(validationSchemaStorage.lazy("LinkGroup")).optional(),
1078
- header: validationSchemaStorage.lazy("SimpleLink").optional(),
1079
- id: z.string().optional(),
1080
- links: z.array(validationSchemaStorage.lazy("SimpleLink")).optional(),
1081
- styleClass: z.string().optional(),
1082
- weight: z.number().int().optional(),
1083
- })
1084
- .strict()
1085
- .describe("LinkGroup"),
1086
- );
1087
- validationSchemaStorage.register(
1088
- "NestedResponse",
1089
- z
1090
- .object({
1091
- errorCollection: validationSchemaStorage
1092
- .lazy("ErrorCollection")
1093
- .optional(),
1094
- status: z.number().int().optional(),
1095
- warningCollection: validationSchemaStorage
1096
- .lazy("WarningCollection")
1097
- .optional(),
1098
- })
1099
- .strict()
1100
- .describe("NestedResponse"),
1101
- );
1102
- validationSchemaStorage.register(
1103
- "Notification",
1104
- z
1105
- .object({
1106
- htmlBody: z.string().optional(),
1107
- restrict: validationSchemaStorage
1108
- .lazy("NotificationRecipientsRestrictions")
1109
- .optional(),
1110
- subject: z.string().optional(),
1111
- textBody: z.string().optional(),
1112
- to: validationSchemaStorage.lazy("NotificationRecipients").optional(),
1113
- })
1114
- .catchall(z.unknown())
1115
- .describe("Notification"),
1116
- );
1117
- validationSchemaStorage.register(
1118
- "NotificationRecipients",
1119
- z
1120
- .object({
1121
- assignee: z.boolean().optional(),
1122
- groupIds: z.array(z.string()).optional(),
1123
- groups: z.array(validationSchemaStorage.lazy("GroupName")).optional(),
1124
- reporter: z.boolean().optional(),
1125
- users: z.array(validationSchemaStorage.lazy("UserDetails")).optional(),
1126
- voters: z.boolean().optional(),
1127
- watchers: z.boolean().optional(),
1128
- })
1129
- .catchall(z.unknown())
1130
- .describe("NotificationRecipients"),
1131
- );
1132
- validationSchemaStorage.register(
1133
- "NotificationRecipientsRestrictions",
1134
- z
1135
- .object({
1136
- groupIds: z.array(z.string()).optional(),
1137
- groups: z.array(validationSchemaStorage.lazy("GroupName")).optional(),
1138
- permissions: z
1139
- .array(validationSchemaStorage.lazy("RestrictedPermission"))
1140
- .optional(),
1141
- })
1142
- .strict()
1143
- .describe("NotificationRecipientsRestrictions"),
1144
- );
1145
- validationSchemaStorage.register(
1146
- "Operations",
1147
- z
1148
- .object({
1149
- linkGroups: z
1150
- .array(validationSchemaStorage.lazy("LinkGroup"))
1151
- .optional(),
1152
- })
1153
- .catchall(z.unknown())
1154
- .describe("Operations"),
1155
- );
1156
- validationSchemaStorage.register(
1157
- "PageBeanChangelog",
1158
- z
1159
- .object({
1160
- isLast: z.boolean().optional(),
1161
- maxResults: z.number().int().optional(),
1162
- nextPage: z.string().optional(),
1163
- self: z.string().optional(),
1164
- startAt: z.number().int().optional(),
1165
- total: z.number().int().optional(),
1166
- values: z.array(validationSchemaStorage.lazy("Changelog")).optional(),
1167
- })
1168
- .strict()
1169
- .describe("PageBeanChangelog"),
1170
- );
1171
- validationSchemaStorage.register(
1172
- "PageOfChangelogs",
1173
- z
1174
- .object({
1175
- histories: z
1176
- .array(validationSchemaStorage.lazy("Changelog"))
1177
- .optional(),
1178
- maxResults: z.number().int().optional(),
1179
- startAt: z.number().int().optional(),
1180
- total: z.number().int().optional(),
1181
- })
1182
- .strict()
1183
- .describe("PageOfChangelogs"),
1184
- );
1185
- validationSchemaStorage.register(
1186
- "PageOfCreateMetaIssueTypes",
1187
- z
1188
- .object({
1189
- createMetaIssueType: z
1190
- .array(validationSchemaStorage.lazy("IssueTypeIssueCreateMetadata"))
1191
- .optional(),
1192
- issueTypes: z
1193
- .array(validationSchemaStorage.lazy("IssueTypeIssueCreateMetadata"))
1194
- .optional(),
1195
- maxResults: z.number().int().optional(),
1196
- startAt: z.number().int().optional(),
1197
- total: z.number().int().optional(),
1198
- })
1199
- .catchall(z.unknown())
1200
- .describe("PageOfCreateMetaIssueTypes"),
1201
- );
1202
- validationSchemaStorage.register(
1203
- "PageOfCreateMetaIssueTypeWithField",
1204
- z
1205
- .object({
1206
- fields: z
1207
- .array(validationSchemaStorage.lazy("FieldCreateMetadata"))
1208
- .optional(),
1209
- maxResults: z.number().int().optional(),
1210
- results: z
1211
- .array(validationSchemaStorage.lazy("FieldCreateMetadata"))
1212
- .optional(),
1213
- startAt: z.number().int().optional(),
1214
- total: z.number().int().optional(),
1215
- })
1216
- .catchall(z.unknown())
1217
- .describe("PageOfCreateMetaIssueTypeWithField"),
1218
- );
1219
- validationSchemaStorage.register(
1220
- "ProjectIssueCreateMetadata",
1221
- z
1222
- .object({
1223
- avatarUrls: validationSchemaStorage.lazy("AvatarUrlsBean").optional(),
1224
- expand: z.string().optional(),
1225
- id: z.string().optional(),
1226
- issuetypes: z
1227
- .array(validationSchemaStorage.lazy("IssueTypeIssueCreateMetadata"))
1228
- .optional(),
1229
- key: z.string().optional(),
1230
- name: z.string().optional(),
1231
- self: z.string().optional(),
1232
- })
1233
- .strict()
1234
- .describe("ProjectIssueCreateMetadata"),
1235
- );
1236
- validationSchemaStorage.register(
1237
- "RestrictedPermission",
1238
- z
1239
- .object({
1240
- id: z.string().optional(),
1241
- key: z.string().optional(),
1242
- })
1243
- .catchall(z.unknown())
1244
- .describe("RestrictedPermission"),
1245
- );
1246
- validationSchemaStorage.register(
1247
- "Transitions",
1248
- z
1249
- .object({
1250
- expand: z.string().optional(),
1251
- transitions: z
1252
- .array(validationSchemaStorage.lazy("IssueTransition"))
1253
- .optional(),
1254
- })
1255
- .strict()
1256
- .describe("Transitions"),
1257
- );
1258
- validationSchemaStorage.register(
1259
- "WarningCollection",
1260
- z
1261
- .object({
1262
- warnings: z.array(z.string()).optional(),
1263
- })
1264
- .strict()
1265
- .describe("WarningCollection"),
1266
- );
1267
- validationSchemaStorage.registerOnce([registerCommonValidationSchemas]);
1268
- }