@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,849 +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
- registerCommonValidationSchemas,
9
- type SharePermission,
10
- } from "./common";
11
- /** The details of the available dashboard gadget. */
12
- export interface AvailableDashboardGadget {
13
- /** The module key of the gadget type. */
14
- moduleKey?: string;
15
- /** The title of the gadget. */
16
- title: string;
17
- /** The URI of the gadget type. */
18
- uri?: string;
19
- }
20
- /** The list of available gadgets. */
21
- export interface AvailableDashboardGadgetsResponse {
22
- /** The list of available gadgets. */
23
- gadgets: AvailableDashboardGadget[];
24
- }
25
- /** Details for changing owners of shareable entities */
26
- export interface BulkChangeOwnerDetails {
27
- /** Whether the name is fixed automatically if it's duplicated after changing owner. */
28
- autofixName: boolean;
29
- /** The account id of the new owner. */
30
- newOwner: string;
31
- }
32
- /** Errors of bulk edit action. */
33
- export interface BulkEditActionError {
34
- /** The error messages. */
35
- errorMessages: string[];
36
- /** The errors. */
37
- errors: {
38
- [key: string]: string;
39
- };
40
- }
41
- /** Details of a request to bulk edit shareable entity. */
42
- export interface BulkEditShareableEntityRequest {
43
- /** Allowed action for bulk edit shareable entity */
44
- action:
45
- | "changeOwner"
46
- | "changePermission"
47
- | "addPermission"
48
- | "removePermission";
49
- /** The details of change owner action. */
50
- changeOwnerDetails?: BulkChangeOwnerDetails;
51
- /** The id list of shareable entities to be changed. */
52
- entityIds: number[];
53
- /**
54
- * Whether the actions are executed by users with Administer Jira global
55
- * permission.
56
- */
57
- extendAdminPermissions?: boolean;
58
- /** The permission details to be changed. */
59
- permissionDetails?: PermissionDetails;
60
- }
61
- /** Details of a request to bulk edit shareable entity. */
62
- export interface BulkEditShareableEntityResponse {
63
- /** Allowed action for bulk edit shareable entity */
64
- action:
65
- | "changeOwner"
66
- | "changePermission"
67
- | "addPermission"
68
- | "removePermission";
69
- /** The mapping dashboard id to errors if any. */
70
- entityErrors?: {
71
- /** Errors of bulk edit action. */
72
- [key: string]: BulkEditActionError;
73
- };
74
- }
75
- /** Details of a dashboard. */
76
- export interface Dashboard {
77
- /** The automatic refresh interval for the dashboard in milliseconds. */
78
- automaticRefreshMs?: number;
79
- description?: string;
80
- /** The details of any edit share permissions for the dashboard. */
81
- editPermissions?: SharePermission[];
82
- /** The ID of the dashboard. */
83
- id?: string;
84
- /** Whether the dashboard is selected as a favorite by the user. */
85
- isFavourite?: boolean;
86
- /** Whether the current user has permission to edit the dashboard. */
87
- isWritable?: boolean;
88
- /** The name of the dashboard. */
89
- name?: string;
90
- /** The owner of the dashboard. */
91
- owner?: UserBean;
92
- /** The number of users who have this dashboard as a favorite. */
93
- popularity?: number;
94
- /** The rank of this dashboard. */
95
- rank?: number;
96
- /** The URL of these dashboard details. */
97
- self?: string;
98
- /** The details of any view share permissions for the dashboard. */
99
- sharePermissions?: SharePermission[];
100
- /** Whether the current dashboard is system dashboard. */
101
- systemDashboard?: boolean;
102
- /** The URL of the dashboard. */
103
- view?: string;
104
- }
105
- /** Details of a dashboard. */
106
- export interface DashboardDetails {
107
- /** The description of the dashboard. */
108
- description?: string;
109
- /** The edit permissions for the dashboard. */
110
- editPermissions: SharePermission[];
111
- /** The name of the dashboard. */
112
- name: string;
113
- /** The share permissions for the dashboard. */
114
- sharePermissions: SharePermission[];
115
- }
116
- /** Details of a gadget. */
117
- export interface DashboardGadget {
118
- /**
119
- * The color of the gadget. Should be one of `blue`, `red`, `yellow`, `green`,
120
- * `cyan`, `purple`, `gray`, or `white`.
121
- */
122
- color:
123
- | "blue"
124
- | "red"
125
- | "yellow"
126
- | "green"
127
- | "cyan"
128
- | "purple"
129
- | "gray"
130
- | "white";
131
- /** The ID of the gadget instance. */
132
- id: number;
133
- /** The module key of the gadget type. */
134
- moduleKey?: string;
135
- /** The position of the gadget. */
136
- position: DashboardGadgetPosition;
137
- /** The title of the gadget. */
138
- title: string;
139
- /** The URI of the gadget type. */
140
- uri?: string;
141
- }
142
- /** Details of a gadget position. */
143
- export interface DashboardGadgetPosition {
144
- "The column position of the gadget.": number;
145
- "The row position of the gadget.": number;
146
- }
147
- /** The list of gadgets on the dashboard. */
148
- export interface DashboardGadgetResponse {
149
- /** The list of gadgets. */
150
- gadgets: DashboardGadget[];
151
- }
152
- /** Details of the settings for a dashboard gadget. */
153
- export interface DashboardGadgetSettings {
154
- /**
155
- * The color of the gadget. Should be one of `blue`, `red`, `yellow`, `green`,
156
- * `cyan`, `purple`, `gray`, or `white`.
157
- */
158
- color?: string;
159
- /**
160
- * Whether to ignore the validation of module key and URI. For example, when a
161
- * gadget is created that is a part of an application that isn't installed.
162
- */
163
- ignoreUriAndModuleKeyValidation?: boolean;
164
- /** The module key of the gadget type. Can't be provided with `uri`. */
165
- moduleKey?: string;
166
- /**
167
- * The position of the gadget. When the gadget is placed into the position, other
168
- * gadgets in the same column are moved down to accommodate it.
169
- */
170
- position?: DashboardGadgetPosition;
171
- /** The title of the gadget. */
172
- title?: string;
173
- /** The URI of the gadget type. Can't be provided with `moduleKey`. */
174
- uri?: string;
175
- }
176
- /** The details of the gadget to update. */
177
- export interface DashboardGadgetUpdateRequest {
178
- /**
179
- * The color of the gadget. Should be one of `blue`, `red`, `yellow`, `green`,
180
- * `cyan`, `purple`, `gray`, or `white`.
181
- */
182
- color?: string;
183
- /** The position of the gadget. */
184
- position?: DashboardGadgetPosition;
185
- /** The title of the gadget. */
186
- title?: string;
187
- }
188
- /** The project issue type hierarchy. */
189
- export interface Hierarchy {
190
- /**
191
- * The ID of the base level. This property is deprecated, see [Change notice:
192
- * Removing hierarchy level IDs from next-gen
193
- * APIs](https://developer.atlassian.com/cloud/jira/platform/change-notice-removing-hierarchy-level-ids-from-next-gen-apis/).
194
- *
195
- * @deprecated
196
- */
197
- baseLevelId?: number;
198
- /** Details about the hierarchy level. */
199
- levels?: SimplifiedHierarchyLevel[];
200
- }
201
- /** A page of items. */
202
- export interface PageBeanDashboard {
203
- /** Whether this is the last page. */
204
- isLast?: boolean;
205
- /** The maximum number of items that could be returned. */
206
- maxResults?: number;
207
- /** If there is another page of results, the URL of the next page. */
208
- nextPage?: string;
209
- /** The URL of the page. */
210
- self?: string;
211
- /** The index of the first item returned. */
212
- startAt?: number;
213
- /** The number of items returned. */
214
- total?: number;
215
- /** The list of items. */
216
- values?: Dashboard[];
217
- }
218
- /** A page containing dashboard details. */
219
- export interface PageOfDashboards {
220
- /** List of dashboards. */
221
- dashboards?: Dashboard[];
222
- /** The maximum number of results that could be on the page. */
223
- maxResults?: number;
224
- /** The URL of the next page of results, if any. */
225
- next?: string;
226
- /** The URL of the previous page of results, if any. */
227
- prev?: string;
228
- /** The index of the first item returned on the page. */
229
- startAt?: number;
230
- /** The number of results on the page. */
231
- total?: number;
232
- }
233
- /** Details for permissions of shareable entities */
234
- export interface PermissionDetails {
235
- /** The edit permissions for the shareable entities. */
236
- editPermissions: SharePermission[];
237
- /** The share permissions for the shareable entities. */
238
- sharePermissions: SharePermission[];
239
- }
240
- /** Additional details about a project. */
241
- export interface ProjectInsight {
242
- /** The last issue update time. */
243
- lastIssueUpdateTime?: string;
244
- /** Total issue count. */
245
- totalIssueCount?: number;
246
- }
247
- /** The project landing page info. */
248
- export interface ProjectLandingPageInfo {
249
- attributes?: {
250
- [key: string]: string;
251
- };
252
- boardId?: number;
253
- boardName?: string;
254
- projectKey?: string;
255
- projectType?: string;
256
- queueCategory?: string;
257
- queueId?: number;
258
- queueName?: string;
259
- simpleBoard?: boolean;
260
- simplified?: boolean;
261
- url?: string;
262
- }
263
- /** Permissions which a user has on a project. */
264
- export interface ProjectPermissions {
265
- /** Whether the logged user can edit the project. */
266
- canEdit?: boolean;
267
- }
268
- /** Details of the group associated with the role. */
269
- export interface ProjectRoleGroup {
270
- /** The display name of the group. */
271
- displayName?: string;
272
- /** The ID of the group. */
273
- groupId?: string;
274
- /**
275
- * The name of the group. As a group's name can change, use of `groupId` is
276
- * recommended to identify the group.
277
- */
278
- name?: string;
279
- }
280
- /** Details of the user associated with the role. */
281
- export interface ProjectRoleUser {
282
- /**
283
- * The account ID of the user, which uniquely identifies the user across all
284
- * Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Returns *unknown*
285
- * if the record is deleted and corrupted, for example, as the result of a server
286
- * import.
287
- */
288
- accountId?: string;
289
- }
290
- /** Details about a user assigned to a project role. */
291
- export interface RoleActor {
292
- actorGroup?: ProjectRoleGroup;
293
- actorUser?: ProjectRoleUser;
294
- /** The avatar of the role actor. */
295
- avatarUrl?: string;
296
- /**
297
- * The display name of the role actor. For users, depending on the user’s privacy
298
- * setting, this may return an alternative value for the user's name.
299
- */
300
- displayName?: string;
301
- /** The ID of the role actor. */
302
- id?: number;
303
- /**
304
- * This property is no longer available and will be removed from the documentation
305
- * soon. See the [deprecation
306
- * notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/)
307
- * for details.
308
- */
309
- name?: string;
310
- /** The type of role actor. */
311
- type?: "atlassian-group-role-actor" | "atlassian-user-role-actor";
312
- }
313
- export interface SimplifiedHierarchyLevel {
314
- /**
315
- * The ID of the level above this one in the hierarchy. This property is
316
- * deprecated, see [Change notice: Removing hierarchy level IDs from next-gen
317
- * APIs](https://developer.atlassian.com/cloud/jira/platform/change-notice-removing-hierarchy-level-ids-from-next-gen-apis/).
318
- *
319
- * @deprecated
320
- */
321
- aboveLevelId?: number;
322
- /**
323
- * The ID of the level below this one in the hierarchy. This property is
324
- * deprecated, see [Change notice: Removing hierarchy level IDs from next-gen
325
- * APIs](https://developer.atlassian.com/cloud/jira/platform/change-notice-removing-hierarchy-level-ids-from-next-gen-apis/).
326
- *
327
- * @deprecated
328
- */
329
- belowLevelId?: number;
330
- /**
331
- * The external UUID of the hierarchy level. This property is deprecated, see
332
- * [Change notice: Removing hierarchy level IDs from next-gen
333
- * APIs](https://developer.atlassian.com/cloud/jira/platform/change-notice-removing-hierarchy-level-ids-from-next-gen-apis/).
334
- *
335
- * @deprecated
336
- */
337
- externalUuid?: string;
338
- hierarchyLevelNumber?: number;
339
- /**
340
- * The ID of the hierarchy level. This property is deprecated, see [Change notice:
341
- * Removing hierarchy level IDs from next-gen
342
- * APIs](https://developer.atlassian.com/cloud/jira/platform/change-notice-removing-hierarchy-level-ids-from-next-gen-apis/).
343
- *
344
- * @deprecated
345
- */
346
- id?: number;
347
- /** The issue types available in this hierarchy level. */
348
- issueTypeIds?: number[];
349
- /** The level of this item in the hierarchy. */
350
- level?: number;
351
- /** The name of this hierarchy level. */
352
- name?: string;
353
- /**
354
- * The ID of the project configuration. This property is deprecated, see [Change
355
- * oticen: Removing hierarchy level IDs from next-gen
356
- * APIs](https://developer.atlassian.com/cloud/jira/platform/change-notice-removing-hierarchy-level-ids-from-next-gen-apis/).
357
- *
358
- * @deprecated
359
- */
360
- projectConfigurationId?: number;
361
- }
362
- /**
363
- * The user account ID that the filter is shared with. For a request, specify the
364
- * `accountId` property for the user.
365
- */
366
- export interface UserBean {
367
- /**
368
- * The account ID of the user, which uniquely identifies the user across all
369
- * Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.
370
- */
371
- accountId?: string;
372
- /** Whether the user is active. */
373
- active?: boolean;
374
- /** The avatars of the user. */
375
- avatarUrls?: UserBeanAvatarUrls;
376
- /**
377
- * The display name of the user. Depending on the user’s privacy setting, this may
378
- * return an alternative value.
379
- */
380
- displayName?: string;
381
- /**
382
- * This property is deprecated in favor of `accountId` because of privacy changes.
383
- * See the [migration
384
- * guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/)
385
- * for details.
386
- * The key of the user.
387
- *
388
- * @deprecated
389
- */
390
- key?: string;
391
- /**
392
- * This property is deprecated in favor of `accountId` because of privacy changes.
393
- * See the [migration
394
- * guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/)
395
- * for details.
396
- * The username of the user.
397
- *
398
- * @deprecated
399
- */
400
- name?: string;
401
- /** The URL of the user. */
402
- self?: string;
403
- }
404
- /** The avatars of the user. */
405
- export interface UserBeanAvatarUrls {
406
- /** The URL of the user's 16x16 pixel avatar. */
407
- "16x16"?: string;
408
- /** The URL of the user's 24x24 pixel avatar. */
409
- "24x24"?: string;
410
- /** The URL of the user's 32x32 pixel avatar. */
411
- "32x32"?: string;
412
- /** The URL of the user's 48x48 pixel avatar. */
413
- "48x48"?: string;
414
- }
415
- /** Contains details about a version approver. */
416
- export interface VersionApprover extends Record<string, unknown> {
417
- /** The Atlassian account ID of the approver. */
418
- accountId?: string;
419
- /** A description of why the user is declining the approval. */
420
- declineReason?: string;
421
- /** A description of what the user is approving within the specified version. */
422
- description?: string;
423
- /** The status of the approval, which can be *PENDING*, *APPROVED*, or *DECLINED* */
424
- status?: string;
425
- }
426
- /** Counts of the number of issues in various statuses. */
427
- export interface VersionIssuesStatus extends Record<string, unknown> {
428
- /** Count of issues with status *done*. */
429
- done?: number;
430
- /** Count of issues with status *in progress*. */
431
- inProgress?: number;
432
- /** Count of issues with status *to do*. */
433
- toDo?: number;
434
- /** Count of issues with a status other than *to do*, *in progress*, and *done*. */
435
- unmapped?: number;
436
- }
437
- export function registerDashboardsValidationSchemas(
438
- validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>,
439
- ) {
440
- validationSchemaStorage.register(
441
- "AvailableDashboardGadget",
442
- z
443
- .object({
444
- moduleKey: z.string().optional(),
445
- title: z.string(),
446
- uri: z.string().optional(),
447
- })
448
- .strict()
449
- .describe("AvailableDashboardGadget"),
450
- );
451
- validationSchemaStorage.register(
452
- "AvailableDashboardGadgetsResponse",
453
- z
454
- .object({
455
- gadgets: z.array(
456
- validationSchemaStorage.lazy("AvailableDashboardGadget"),
457
- ),
458
- })
459
- .strict()
460
- .describe("AvailableDashboardGadgetsResponse"),
461
- );
462
- validationSchemaStorage.register(
463
- "BulkChangeOwnerDetails",
464
- z
465
- .object({
466
- autofixName: z.boolean(),
467
- newOwner: z.string(),
468
- })
469
- .strict()
470
- .describe("BulkChangeOwnerDetails"),
471
- );
472
- validationSchemaStorage.register(
473
- "BulkEditActionError",
474
- z
475
- .object({
476
- errorMessages: z.array(z.string()),
477
- errors: z.object({}).catchall(z.string()),
478
- })
479
- .strict()
480
- .describe("BulkEditActionError"),
481
- );
482
- validationSchemaStorage.register(
483
- "BulkEditShareableEntityRequest",
484
- z
485
- .object({
486
- action: z.enum([
487
- "changeOwner",
488
- "changePermission",
489
- "addPermission",
490
- "removePermission",
491
- ]),
492
- changeOwnerDetails: validationSchemaStorage
493
- .lazy("BulkChangeOwnerDetails")
494
- .optional(),
495
- entityIds: z.array(z.number().int()).superRefine((items, ctx) => {
496
- if (
497
- new Set(items.map((item) => JSON.stringify(item))).size !==
498
- items.length
499
- ) {
500
- ctx.addIssue({
501
- code: z.ZodIssueCode.custom,
502
- path: [],
503
- message: "Array items must be unique",
504
- });
505
- }
506
- }),
507
- extendAdminPermissions: z.boolean().optional(),
508
- permissionDetails: validationSchemaStorage
509
- .lazy("PermissionDetails")
510
- .optional(),
511
- })
512
- .strict()
513
- .describe("BulkEditShareableEntityRequest"),
514
- );
515
- validationSchemaStorage.register(
516
- "BulkEditShareableEntityResponse",
517
- z
518
- .object({
519
- action: z.enum([
520
- "changeOwner",
521
- "changePermission",
522
- "addPermission",
523
- "removePermission",
524
- ]),
525
- entityErrors: z
526
- .object({})
527
- .catchall(validationSchemaStorage.lazy("BulkEditActionError"))
528
- .optional(),
529
- })
530
- .strict()
531
- .describe("BulkEditShareableEntityResponse"),
532
- );
533
- validationSchemaStorage.register(
534
- "Dashboard",
535
- z
536
- .object({
537
- automaticRefreshMs: z.number().int().optional(),
538
- description: z.string().optional(),
539
- editPermissions: z
540
- .array(validationSchemaStorage.lazy("SharePermission"))
541
- .optional(),
542
- id: z.string().optional(),
543
- isFavourite: z.boolean().optional(),
544
- isWritable: z.boolean().optional(),
545
- name: z.string().optional(),
546
- owner: validationSchemaStorage.lazy("UserBean").optional(),
547
- popularity: z.number().int().optional(),
548
- rank: z.number().int().optional(),
549
- self: z.string().optional(),
550
- sharePermissions: z
551
- .array(validationSchemaStorage.lazy("SharePermission"))
552
- .optional(),
553
- systemDashboard: z.boolean().optional(),
554
- view: z.string().optional(),
555
- })
556
- .strict()
557
- .describe("Dashboard"),
558
- );
559
- validationSchemaStorage.register(
560
- "DashboardDetails",
561
- z
562
- .object({
563
- description: z.string().optional(),
564
- editPermissions: z.array(
565
- validationSchemaStorage.lazy("SharePermission"),
566
- ),
567
- name: z.string(),
568
- sharePermissions: z.array(
569
- validationSchemaStorage.lazy("SharePermission"),
570
- ),
571
- })
572
- .strict()
573
- .describe("DashboardDetails"),
574
- );
575
- validationSchemaStorage.register(
576
- "DashboardGadget",
577
- z
578
- .object({
579
- color: z.enum([
580
- "blue",
581
- "red",
582
- "yellow",
583
- "green",
584
- "cyan",
585
- "purple",
586
- "gray",
587
- "white",
588
- ]),
589
- id: z.number().int(),
590
- moduleKey: z.string().optional(),
591
- position: validationSchemaStorage.lazy("DashboardGadgetPosition"),
592
- title: z.string(),
593
- uri: z.string().optional(),
594
- })
595
- .strict()
596
- .describe("DashboardGadget"),
597
- );
598
- validationSchemaStorage.register(
599
- "DashboardGadgetPosition",
600
- z
601
- .object({
602
- "The column position of the gadget.": z.number().int(),
603
- "The row position of the gadget.": z.number().int(),
604
- })
605
- .strict()
606
- .describe("DashboardGadgetPosition"),
607
- );
608
- validationSchemaStorage.register(
609
- "DashboardGadgetResponse",
610
- z
611
- .object({
612
- gadgets: z.array(validationSchemaStorage.lazy("DashboardGadget")),
613
- })
614
- .strict()
615
- .describe("DashboardGadgetResponse"),
616
- );
617
- validationSchemaStorage.register(
618
- "DashboardGadgetSettings",
619
- z
620
- .object({
621
- color: z.string().optional(),
622
- ignoreUriAndModuleKeyValidation: z.boolean().optional(),
623
- moduleKey: z.string().optional(),
624
- position: validationSchemaStorage
625
- .lazy("DashboardGadgetPosition")
626
- .optional(),
627
- title: z.string().optional(),
628
- uri: z.string().optional(),
629
- })
630
- .strict()
631
- .describe("DashboardGadgetSettings"),
632
- );
633
- validationSchemaStorage.register(
634
- "DashboardGadgetUpdateRequest",
635
- z
636
- .object({
637
- color: z.string().optional(),
638
- position: validationSchemaStorage
639
- .lazy("DashboardGadgetPosition")
640
- .optional(),
641
- title: z.string().optional(),
642
- })
643
- .strict()
644
- .describe("DashboardGadgetUpdateRequest"),
645
- );
646
- validationSchemaStorage.register(
647
- "Hierarchy",
648
- z
649
- .object({
650
- baseLevelId: z.number().int().optional(),
651
- levels: z
652
- .array(validationSchemaStorage.lazy("SimplifiedHierarchyLevel"))
653
- .optional(),
654
- })
655
- .strict()
656
- .describe("Hierarchy"),
657
- );
658
- validationSchemaStorage.register(
659
- "PageBeanDashboard",
660
- z
661
- .object({
662
- isLast: z.boolean().optional(),
663
- maxResults: z.number().int().optional(),
664
- nextPage: z.string().optional(),
665
- self: z.string().optional(),
666
- startAt: z.number().int().optional(),
667
- total: z.number().int().optional(),
668
- values: z.array(validationSchemaStorage.lazy("Dashboard")).optional(),
669
- })
670
- .strict()
671
- .describe("PageBeanDashboard"),
672
- );
673
- validationSchemaStorage.register(
674
- "PageOfDashboards",
675
- z
676
- .object({
677
- dashboards: z
678
- .array(validationSchemaStorage.lazy("Dashboard"))
679
- .optional(),
680
- maxResults: z.number().int().optional(),
681
- next: z.string().optional(),
682
- prev: z.string().optional(),
683
- startAt: z.number().int().optional(),
684
- total: z.number().int().optional(),
685
- })
686
- .strict()
687
- .describe("PageOfDashboards"),
688
- );
689
- validationSchemaStorage.register(
690
- "PermissionDetails",
691
- z
692
- .object({
693
- editPermissions: z.array(
694
- validationSchemaStorage.lazy("SharePermission"),
695
- ),
696
- sharePermissions: z.array(
697
- validationSchemaStorage.lazy("SharePermission"),
698
- ),
699
- })
700
- .strict()
701
- .describe("PermissionDetails"),
702
- );
703
- validationSchemaStorage.register(
704
- "ProjectInsight",
705
- z
706
- .object({
707
- lastIssueUpdateTime: z.string().optional(),
708
- totalIssueCount: z.number().int().optional(),
709
- })
710
- .strict()
711
- .describe("ProjectInsight"),
712
- );
713
- validationSchemaStorage.register(
714
- "ProjectLandingPageInfo",
715
- z
716
- .object({
717
- attributes: z.object({}).catchall(z.string()).optional(),
718
- boardId: z.number().int().optional(),
719
- boardName: z.string().optional(),
720
- projectKey: z.string().optional(),
721
- projectType: z.string().optional(),
722
- queueCategory: z.string().optional(),
723
- queueId: z.number().int().optional(),
724
- queueName: z.string().optional(),
725
- simpleBoard: z.boolean().optional(),
726
- simplified: z.boolean().optional(),
727
- url: z.string().optional(),
728
- })
729
- .strict()
730
- .describe("ProjectLandingPageInfo"),
731
- );
732
- validationSchemaStorage.register(
733
- "ProjectPermissions",
734
- z
735
- .object({
736
- canEdit: z.boolean().optional(),
737
- })
738
- .strict()
739
- .describe("ProjectPermissions"),
740
- );
741
- validationSchemaStorage.register(
742
- "ProjectRoleGroup",
743
- z
744
- .object({
745
- displayName: z.string().optional(),
746
- groupId: z.string().optional(),
747
- name: z.string().optional(),
748
- })
749
- .strict()
750
- .describe("ProjectRoleGroup"),
751
- );
752
- validationSchemaStorage.register(
753
- "ProjectRoleUser",
754
- z
755
- .object({
756
- accountId: z.string().max(128).optional(),
757
- })
758
- .strict()
759
- .describe("ProjectRoleUser"),
760
- );
761
- validationSchemaStorage.register(
762
- "RoleActor",
763
- z
764
- .object({
765
- actorGroup: validationSchemaStorage.lazy("ProjectRoleGroup").optional(),
766
- actorUser: validationSchemaStorage.lazy("ProjectRoleUser").optional(),
767
- avatarUrl: z.string().optional(),
768
- displayName: z.string().optional(),
769
- id: z.number().int().optional(),
770
- name: z.string().optional(),
771
- type: z
772
- .enum(["atlassian-group-role-actor", "atlassian-user-role-actor"])
773
- .optional(),
774
- })
775
- .strict()
776
- .describe("RoleActor"),
777
- );
778
- validationSchemaStorage.register(
779
- "SimplifiedHierarchyLevel",
780
- z
781
- .object({
782
- aboveLevelId: z.number().int().optional(),
783
- belowLevelId: z.number().int().optional(),
784
- externalUuid: z.string().optional(),
785
- hierarchyLevelNumber: z.number().int().optional(),
786
- id: z.number().int().optional(),
787
- issueTypeIds: z.array(z.number().int()).optional(),
788
- level: z.number().int().optional(),
789
- name: z.string().optional(),
790
- projectConfigurationId: z.number().int().optional(),
791
- })
792
- .strict()
793
- .describe("SimplifiedHierarchyLevel"),
794
- );
795
- validationSchemaStorage.register(
796
- "UserBean",
797
- z
798
- .object({
799
- accountId: z.string().max(128).optional(),
800
- active: z.boolean().optional(),
801
- avatarUrls: validationSchemaStorage
802
- .lazy("UserBeanAvatarUrls")
803
- .optional(),
804
- displayName: z.string().optional(),
805
- key: z.string().optional(),
806
- name: z.string().optional(),
807
- self: z.string().optional(),
808
- })
809
- .strict()
810
- .describe("UserBean"),
811
- );
812
- validationSchemaStorage.register(
813
- "UserBeanAvatarUrls",
814
- z
815
- .object({
816
- "16x16": z.string().optional(),
817
- "24x24": z.string().optional(),
818
- "32x32": z.string().optional(),
819
- "48x48": z.string().optional(),
820
- })
821
- .strict()
822
- .describe("UserBeanAvatarUrls"),
823
- );
824
- validationSchemaStorage.register(
825
- "VersionApprover",
826
- z
827
- .object({
828
- accountId: z.string().optional(),
829
- declineReason: z.string().optional(),
830
- description: z.string().optional(),
831
- status: z.string().optional(),
832
- })
833
- .catchall(z.unknown())
834
- .describe("VersionApprover"),
835
- );
836
- validationSchemaStorage.register(
837
- "VersionIssuesStatus",
838
- z
839
- .object({
840
- done: z.number().int().optional(),
841
- inProgress: z.number().int().optional(),
842
- toDo: z.number().int().optional(),
843
- unmapped: z.number().int().optional(),
844
- })
845
- .catchall(z.unknown())
846
- .describe("VersionIssuesStatus"),
847
- );
848
- validationSchemaStorage.registerOnce([registerCommonValidationSchemas]);
849
- }