@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,247 +0,0 @@
1
- // DO NOT EDIT!
2
- // This file is generated by "api-typescript-generator".
3
- // To update this file run "yarn build:openapi".
4
- import { z, type ZodTypeAny } from "zod";
5
-
6
- import type { CommonValidationSchemaStorage } from "../core/common-validation-schema-storage";
7
- import { registerCommonValidationSchemas, type UserDetails } from "./common";
8
- export interface AddGroupBean extends Record<string, unknown> {
9
- /** The name of the group. */
10
- name: string;
11
- }
12
- /** A group found in a search. */
13
- export interface FoundGroup {
14
- /**
15
- * The ID of the group, which uniquely identifies the group across all Atlassian
16
- * products. For example, *952d12c3-5b5b-4d04-bb32-44d383afc4b2*.
17
- */
18
- groupId?: string;
19
- /** The group name with the matched query string highlighted with the HTML bold tag. */
20
- html?: string;
21
- labels?: GroupLabel[];
22
- /**
23
- * The name of the group. The name of a group is mutable, to reliably identify a
24
- * group use ``groupId`.`
25
- */
26
- name?: string;
27
- }
28
- export interface Group {
29
- /** Expand options that include additional group details in the response. */
30
- expand?: string;
31
- /**
32
- * The ID of the group, which uniquely identifies the group across all Atlassian
33
- * products. For example, *952d12c3-5b5b-4d04-bb32-44d383afc4b2*.
34
- */
35
- groupId?: string | null;
36
- /** The name of group. */
37
- name?: string;
38
- /** The URL for these group details. */
39
- self?: string;
40
- /**
41
- * A paginated list of the users that are members of the group. A maximum of 50
42
- * users is returned in the list, to access additional users append
43
- * `[start-index:end-index]` to the expand request. For example, to access the
44
- * next 50 users, use`?expand=users[51:100]`.
45
- */
46
- users?: PagedListUserDetailsApplicationUser;
47
- }
48
- /** Details about a group. */
49
- export interface GroupDetails {
50
- /**
51
- * The ID of the group, which uniquely identifies the group across all Atlassian
52
- * products. For example, *952d12c3-5b5b-4d04-bb32-44d383afc4b2*.
53
- */
54
- groupId?: string | null;
55
- /** The name of the group. */
56
- name?: string;
57
- }
58
- /** A group label. */
59
- export interface GroupLabel {
60
- /** The group label name. */
61
- text?: string;
62
- /** The title of the group label. */
63
- title?: string;
64
- /** The type of the group label. */
65
- type?: "ADMIN" | "SINGLE" | "MULTIPLE";
66
- }
67
- /** A page of items. */
68
- export interface PageBeanGroupDetails {
69
- /** Whether this is the last page. */
70
- isLast?: boolean;
71
- /** The maximum number of items that could be returned. */
72
- maxResults?: number;
73
- /** If there is another page of results, the URL of the next page. */
74
- nextPage?: string;
75
- /** The URL of the page. */
76
- self?: string;
77
- /** The index of the first item returned. */
78
- startAt?: number;
79
- /** The number of items returned. */
80
- total?: number;
81
- /** The list of items. */
82
- values?: GroupDetails[];
83
- }
84
- /** A page of items. */
85
- export interface PageBeanUserDetails {
86
- /** Whether this is the last page. */
87
- isLast?: boolean;
88
- /** The maximum number of items that could be returned. */
89
- maxResults?: number;
90
- /** If there is another page of results, the URL of the next page. */
91
- nextPage?: string;
92
- /** The URL of the page. */
93
- self?: string;
94
- /** The index of the first item returned. */
95
- startAt?: number;
96
- /** The number of items returned. */
97
- total?: number;
98
- /** The list of items. */
99
- values?: UserDetails[];
100
- }
101
- /**
102
- * A paged list. To access additional details append `[start-index:end-index]` to
103
- * the expand request. For example, `?expand=sharedUsers[10:40]` returns a list
104
- * starting at item 10 and finishing at item 40.
105
- */
106
- export interface PagedListUserDetailsApplicationUser {
107
- /** The index of the last item returned on the page. */
108
- "end-index"?: number;
109
- /** The list of items. */
110
- items?: UserDetails[];
111
- /** The maximum number of results that could be on the page. */
112
- "max-results"?: number;
113
- /** The number of items on the page. */
114
- size?: number;
115
- /** The index of the first item returned on the page. */
116
- "start-index"?: number;
117
- }
118
- export interface UpdateUserToGroupBean extends Record<string, unknown> {
119
- /**
120
- * The account ID of the user, which uniquely identifies the user across all
121
- * Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.
122
- */
123
- accountId?: string;
124
- /**
125
- * This property is no longer available. See the [deprecation
126
- * notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/)
127
- * for details.
128
- */
129
- name?: string;
130
- }
131
- export function registerGroupsValidationSchemas(
132
- validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>,
133
- ) {
134
- validationSchemaStorage.register(
135
- "AddGroupBean",
136
- z
137
- .object({
138
- name: z.string(),
139
- })
140
- .catchall(z.unknown())
141
- .describe("AddGroupBean"),
142
- );
143
- validationSchemaStorage.register(
144
- "FoundGroup",
145
- z
146
- .object({
147
- groupId: z.string().optional(),
148
- html: z.string().optional(),
149
- labels: z.array(validationSchemaStorage.lazy("GroupLabel")).optional(),
150
- name: z.string().optional(),
151
- })
152
- .strict()
153
- .describe("FoundGroup"),
154
- );
155
- validationSchemaStorage.register(
156
- "Group",
157
- z
158
- .object({
159
- expand: z.string().optional(),
160
- groupId: z.nullable(z.string()).optional(),
161
- name: z.string().optional(),
162
- self: z.string().optional(),
163
- users: validationSchemaStorage
164
- .lazy("PagedListUserDetailsApplicationUser")
165
- .optional(),
166
- })
167
- .strict()
168
- .describe("Group"),
169
- );
170
- validationSchemaStorage.register(
171
- "GroupDetails",
172
- z
173
- .object({
174
- groupId: z.nullable(z.string()).optional(),
175
- name: z.string().optional(),
176
- })
177
- .strict()
178
- .describe("GroupDetails"),
179
- );
180
- validationSchemaStorage.register(
181
- "GroupLabel",
182
- z
183
- .object({
184
- text: z.string().optional(),
185
- title: z.string().optional(),
186
- type: z.enum(["ADMIN", "SINGLE", "MULTIPLE"]).optional(),
187
- })
188
- .strict()
189
- .describe("GroupLabel"),
190
- );
191
- validationSchemaStorage.register(
192
- "PageBeanGroupDetails",
193
- z
194
- .object({
195
- isLast: z.boolean().optional(),
196
- maxResults: z.number().int().optional(),
197
- nextPage: z.string().optional(),
198
- self: z.string().optional(),
199
- startAt: z.number().int().optional(),
200
- total: z.number().int().optional(),
201
- values: z
202
- .array(validationSchemaStorage.lazy("GroupDetails"))
203
- .optional(),
204
- })
205
- .strict()
206
- .describe("PageBeanGroupDetails"),
207
- );
208
- validationSchemaStorage.register(
209
- "PageBeanUserDetails",
210
- z
211
- .object({
212
- isLast: z.boolean().optional(),
213
- maxResults: z.number().int().optional(),
214
- nextPage: z.string().optional(),
215
- self: z.string().optional(),
216
- startAt: z.number().int().optional(),
217
- total: z.number().int().optional(),
218
- values: z.array(validationSchemaStorage.lazy("UserDetails")).optional(),
219
- })
220
- .strict()
221
- .describe("PageBeanUserDetails"),
222
- );
223
- validationSchemaStorage.register(
224
- "PagedListUserDetailsApplicationUser",
225
- z
226
- .object({
227
- "end-index": z.number().int().optional(),
228
- items: z.array(validationSchemaStorage.lazy("UserDetails")).optional(),
229
- "max-results": z.number().int().optional(),
230
- size: z.number().int().optional(),
231
- "start-index": z.number().int().optional(),
232
- })
233
- .strict()
234
- .describe("PagedListUserDetailsApplicationUser"),
235
- );
236
- validationSchemaStorage.register(
237
- "UpdateUserToGroupBean",
238
- z
239
- .object({
240
- accountId: z.string().max(128).optional(),
241
- name: z.string().optional(),
242
- })
243
- .catchall(z.unknown())
244
- .describe("UpdateUserToGroupBean"),
245
- );
246
- validationSchemaStorage.registerOnce([registerCommonValidationSchemas]);
247
- }
@@ -1,290 +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 type { Stream } from "stream";
5
- import { z, type ZodTypeAny } from "zod";
6
-
7
- import type { CommonValidationSchemaStorage } from "../core/common-validation-schema-storage";
8
- import {
9
- type ApplicationRole,
10
- type GroupName,
11
- registerCommonValidationSchemas,
12
- type User,
13
- type UserDetails,
14
- } from "./common";
15
- /** Details about an attachment. */
16
- export interface Attachment extends Record<string, unknown> {
17
- /** Details of the user who added the attachment. */
18
- author?: UserDetails;
19
- /** The content of the attachment. */
20
- content?: string;
21
- /** The datetime the attachment was created. */
22
- created?: string;
23
- /** The file name of the attachment. */
24
- filename?: string;
25
- /** The ID of the attachment. */
26
- id?: string;
27
- /** The MIME type of the attachment. */
28
- mimeType?: string;
29
- /** The URL of the attachment details response. */
30
- self?: string;
31
- /** The size of the attachment. */
32
- size?: number;
33
- /** The URL of a thumbnail representing the attachment. */
34
- thumbnail?: string;
35
- }
36
- export interface AttachmentArchiveEntry {
37
- abbreviatedName?: string;
38
- entryIndex?: number;
39
- mediaType?: string;
40
- name?: string;
41
- size?: number;
42
- }
43
- export interface AttachmentArchiveImpl {
44
- /** The list of the items included in the archive. */
45
- entries?: AttachmentArchiveEntry[];
46
- /** The number of items in the archive. */
47
- totalEntryCount?: number;
48
- }
49
- /** Metadata for an item in an attachment archive. */
50
- export interface AttachmentArchiveItemReadable {
51
- /** The position of the item within the archive. */
52
- index?: number;
53
- /** The label for the archive item. */
54
- label?: string;
55
- /** The MIME type of the archive item. */
56
- mediaType?: string;
57
- /** The path of the archive item. */
58
- path?: string;
59
- /** The size of the archive item. */
60
- size?: string;
61
- }
62
- /** Metadata for an archive (for example a zip) and its contents. */
63
- export interface AttachmentArchiveMetadataReadable {
64
- /** The list of the items included in the archive. */
65
- entries?: AttachmentArchiveItemReadable[];
66
- /** The ID of the attachment. */
67
- id?: number;
68
- /** The MIME type of the attachment. */
69
- mediaType?: string;
70
- /** The name of the archive file. */
71
- name?: string;
72
- /** The number of items included in the archive. */
73
- totalEntryCount?: number;
74
- }
75
- /** Metadata for an issue attachment. */
76
- export interface AttachmentMetadata {
77
- /** Details of the user who attached the file. */
78
- author?: User;
79
- /** The URL of the attachment. */
80
- content?: string;
81
- /** The datetime the attachment was created. */
82
- created?: string;
83
- /** The name of the attachment file. */
84
- filename?: string;
85
- /** The ID of the attachment. */
86
- id?: number;
87
- /** The MIME type of the attachment. */
88
- mimeType?: string;
89
- /** Additional properties of the attachment. */
90
- properties?: {
91
- [key: string]: unknown;
92
- };
93
- /** The URL of the attachment metadata details. */
94
- self?: string;
95
- /** The size of the attachment. */
96
- size?: number;
97
- /** The URL of a thumbnail representing the attachment. */
98
- thumbnail?: string;
99
- }
100
- /** Details of the instance's attachment settings. */
101
- export interface AttachmentSettings {
102
- /** Whether the ability to add attachments is enabled. */
103
- enabled?: boolean;
104
- /** The maximum size of attachments permitted, in bytes. */
105
- uploadLimit?: number;
106
- }
107
- export interface ListWrapperCallbackApplicationRole {}
108
- export interface ListWrapperCallbackGroupName {}
109
- export type MultipartFile = [
110
- Blob | Stream,
111
- {
112
- filename?: string;
113
- },
114
- ];
115
- /** The application roles the user is assigned to. */
116
- export interface SimpleListWrapperApplicationRole {
117
- callback?: ListWrapperCallbackApplicationRole;
118
- items?: ApplicationRole[];
119
- "max-results"?: number;
120
- pagingCallback?: ListWrapperCallbackApplicationRole;
121
- size?: number;
122
- }
123
- /** The groups that the user belongs to. */
124
- export interface SimpleListWrapperGroupName {
125
- callback?: ListWrapperCallbackGroupName;
126
- items?: GroupName[];
127
- "max-results"?: number;
128
- pagingCallback?: ListWrapperCallbackGroupName;
129
- size?: number;
130
- }
131
- export function registerIssueAttachmentsValidationSchemas(
132
- validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>,
133
- ) {
134
- validationSchemaStorage.register(
135
- "Attachment",
136
- z
137
- .object({
138
- author: validationSchemaStorage.lazy("UserDetails").optional(),
139
- content: z.string().optional(),
140
- created: z.string().optional(),
141
- filename: z.string().optional(),
142
- id: z.string().optional(),
143
- mimeType: z.string().optional(),
144
- self: z.string().optional(),
145
- size: z.number().int().optional(),
146
- thumbnail: z.string().optional(),
147
- })
148
- .catchall(z.unknown())
149
- .describe("Attachment"),
150
- );
151
- validationSchemaStorage.register(
152
- "AttachmentArchiveEntry",
153
- z
154
- .object({
155
- abbreviatedName: z.string().optional(),
156
- entryIndex: z.number().int().optional(),
157
- mediaType: z.string().optional(),
158
- name: z.string().optional(),
159
- size: z.number().int().optional(),
160
- })
161
- .strict()
162
- .describe("AttachmentArchiveEntry"),
163
- );
164
- validationSchemaStorage.register(
165
- "AttachmentArchiveImpl",
166
- z
167
- .object({
168
- entries: z
169
- .array(validationSchemaStorage.lazy("AttachmentArchiveEntry"))
170
- .optional(),
171
- totalEntryCount: z.number().int().optional(),
172
- })
173
- .strict()
174
- .describe("AttachmentArchiveImpl"),
175
- );
176
- validationSchemaStorage.register(
177
- "AttachmentArchiveItemReadable",
178
- z
179
- .object({
180
- index: z.number().int().optional(),
181
- label: z.string().optional(),
182
- mediaType: z.string().optional(),
183
- path: z.string().optional(),
184
- size: z.string().optional(),
185
- })
186
- .strict()
187
- .describe("AttachmentArchiveItemReadable"),
188
- );
189
- validationSchemaStorage.register(
190
- "AttachmentArchiveMetadataReadable",
191
- z
192
- .object({
193
- entries: z
194
- .array(validationSchemaStorage.lazy("AttachmentArchiveItemReadable"))
195
- .optional(),
196
- id: z.number().int().optional(),
197
- mediaType: z.string().optional(),
198
- name: z.string().optional(),
199
- totalEntryCount: z.number().int().optional(),
200
- })
201
- .strict()
202
- .describe("AttachmentArchiveMetadataReadable"),
203
- );
204
- validationSchemaStorage.register(
205
- "AttachmentMetadata",
206
- z
207
- .object({
208
- author: validationSchemaStorage.lazy("User").optional(),
209
- content: z.string().optional(),
210
- created: z.string().optional(),
211
- filename: z.string().optional(),
212
- id: z.number().int().optional(),
213
- mimeType: z.string().optional(),
214
- properties: z.object({}).catchall(z.unknown()).optional(),
215
- self: z.string().optional(),
216
- size: z.number().int().optional(),
217
- thumbnail: z.string().optional(),
218
- })
219
- .strict()
220
- .describe("AttachmentMetadata"),
221
- );
222
- validationSchemaStorage.register(
223
- "AttachmentSettings",
224
- z
225
- .object({
226
- enabled: z.boolean().optional(),
227
- uploadLimit: z.number().int().optional(),
228
- })
229
- .strict()
230
- .describe("AttachmentSettings"),
231
- );
232
- validationSchemaStorage.register(
233
- "ListWrapperCallbackApplicationRole",
234
- z.object({}).strict().describe("ListWrapperCallbackApplicationRole"),
235
- );
236
- validationSchemaStorage.register(
237
- "ListWrapperCallbackGroupName",
238
- z.object({}).strict().describe("ListWrapperCallbackGroupName"),
239
- );
240
- validationSchemaStorage.register(
241
- "MultipartFile",
242
- z
243
- .tuple([
244
- z.string(),
245
- z
246
- .object({
247
- filename: z.string().optional(),
248
- })
249
- .strict(),
250
- ])
251
- .describe("MultipartFile"),
252
- );
253
- validationSchemaStorage.register(
254
- "SimpleListWrapperApplicationRole",
255
- z
256
- .object({
257
- callback: validationSchemaStorage
258
- .lazy("ListWrapperCallbackApplicationRole")
259
- .optional(),
260
- items: z
261
- .array(validationSchemaStorage.lazy("ApplicationRole"))
262
- .optional(),
263
- "max-results": z.number().int().optional(),
264
- pagingCallback: validationSchemaStorage
265
- .lazy("ListWrapperCallbackApplicationRole")
266
- .optional(),
267
- size: z.number().int().optional(),
268
- })
269
- .strict()
270
- .describe("SimpleListWrapperApplicationRole"),
271
- );
272
- validationSchemaStorage.register(
273
- "SimpleListWrapperGroupName",
274
- z
275
- .object({
276
- callback: validationSchemaStorage
277
- .lazy("ListWrapperCallbackGroupName")
278
- .optional(),
279
- items: z.array(validationSchemaStorage.lazy("GroupName")).optional(),
280
- "max-results": z.number().int().optional(),
281
- pagingCallback: validationSchemaStorage
282
- .lazy("ListWrapperCallbackGroupName")
283
- .optional(),
284
- size: z.number().int().optional(),
285
- })
286
- .strict()
287
- .describe("SimpleListWrapperGroupName"),
288
- );
289
- validationSchemaStorage.registerOnce([registerCommonValidationSchemas]);
290
- }
@@ -1,27 +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
- /** Property key details. */
8
- export interface PropertyKey {
9
- /** The key of the property. */
10
- key?: string;
11
- /** The URL of the property. */
12
- self?: string;
13
- }
14
- export function registerIssueCommentPropertiesValidationSchemas(
15
- validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>,
16
- ) {
17
- validationSchemaStorage.register(
18
- "PropertyKey",
19
- z
20
- .object({
21
- key: z.string().optional(),
22
- self: z.string().optional(),
23
- })
24
- .strict()
25
- .describe("PropertyKey"),
26
- );
27
- }
@@ -1,91 +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 { type Comment, registerCommonValidationSchemas } from "./common";
8
- export interface IssueCommentListRequestBean {
9
- /** The list of comment IDs. A maximum of 1000 IDs can be specified. */
10
- ids: number[];
11
- }
12
- /** A page of items. */
13
- export interface PageBeanComment {
14
- /** Whether this is the last page. */
15
- isLast?: boolean;
16
- /** The maximum number of items that could be returned. */
17
- maxResults?: number;
18
- /** If there is another page of results, the URL of the next page. */
19
- nextPage?: string;
20
- /** The URL of the page. */
21
- self?: string;
22
- /** The index of the first item returned. */
23
- startAt?: number;
24
- /** The number of items returned. */
25
- total?: number;
26
- /** The list of items. */
27
- values?: Comment[];
28
- }
29
- /** A page of comments. */
30
- export interface PageOfComments extends Record<string, unknown> {
31
- /** The list of comments. */
32
- comments?: Comment[];
33
- /** The maximum number of items that could be returned. */
34
- maxResults?: number;
35
- /** The index of the first item returned. */
36
- startAt?: number;
37
- /** The number of items returned. */
38
- total?: number;
39
- }
40
- export function registerIssueCommentsValidationSchemas(
41
- validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>,
42
- ) {
43
- validationSchemaStorage.register(
44
- "IssueCommentListRequestBean",
45
- z
46
- .object({
47
- ids: z.array(z.number().int()).superRefine((items, ctx) => {
48
- if (
49
- new Set(items.map((item) => JSON.stringify(item))).size !==
50
- items.length
51
- ) {
52
- ctx.addIssue({
53
- code: z.ZodIssueCode.custom,
54
- path: [],
55
- message: "Array items must be unique",
56
- });
57
- }
58
- }),
59
- })
60
- .strict()
61
- .describe("IssueCommentListRequestBean"),
62
- );
63
- validationSchemaStorage.register(
64
- "PageBeanComment",
65
- z
66
- .object({
67
- isLast: z.boolean().optional(),
68
- maxResults: z.number().int().optional(),
69
- nextPage: z.string().optional(),
70
- self: z.string().optional(),
71
- startAt: z.number().int().optional(),
72
- total: z.number().int().optional(),
73
- values: z.array(validationSchemaStorage.lazy("Comment")).optional(),
74
- })
75
- .strict()
76
- .describe("PageBeanComment"),
77
- );
78
- validationSchemaStorage.register(
79
- "PageOfComments",
80
- z
81
- .object({
82
- comments: z.array(validationSchemaStorage.lazy("Comment")).optional(),
83
- maxResults: z.number().int().optional(),
84
- startAt: z.number().int().optional(),
85
- total: z.number().int().optional(),
86
- })
87
- .catchall(z.unknown())
88
- .describe("PageOfComments"),
89
- );
90
- validationSchemaStorage.registerOnce([registerCommonValidationSchemas]);
91
- }