@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,392 +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 JsonTypeBean,
9
- registerCommonValidationSchemas,
10
- type Scope,
11
- } from "./common";
12
- /** A context. */
13
- export interface Context {
14
- /** The ID of the context. */
15
- id?: number;
16
- /** The name of the context. */
17
- name?: string;
18
- /** The scope of the context. */
19
- scope?: Scope;
20
- }
21
- export interface CustomFieldDefinitionJsonBean {
22
- /** The description of the custom field, which is displayed in Jira. */
23
- description?: string;
24
- /**
25
- * The name of the custom field, which is displayed in Jira. This is not the
26
- * unique identifier.
27
- */
28
- name: string;
29
- /**
30
- * The searcher defines the way the field is searched in Jira. For example,
31
- * *com.atlassian.jira.plugin.system.customfieldtypes:grouppickersearcher*.
32
- * The search UI (basic search and JQL search) will display different operations
33
- * and values for the field, based on the field searcher. You must specify a
34
- * searcher that is valid for the field type, as listed below (abbreviated values
35
- * shown):
36
- *
37
- * * `cascadingselect`: `cascadingselectsearcher`
38
- * * `datepicker`: `daterange`
39
- * * `datetime`: `datetimerange`
40
- * * `float`: `exactnumber` or `numberrange`
41
- * * `grouppicker`: `grouppickersearcher`
42
- * * `importid`: `exactnumber` or `numberrange`
43
- * * `labels`: `labelsearcher`
44
- * * `multicheckboxes`: `multiselectsearcher`
45
- * * `multigrouppicker`: `multiselectsearcher`
46
- * * `multiselect`: `multiselectsearcher`
47
- * * `multiuserpicker`: `userpickergroupsearcher`
48
- * * `multiversion`: `versionsearcher`
49
- * * `project`: `projectsearcher`
50
- * * `radiobuttons`: `multiselectsearcher`
51
- * * `readonlyfield`: `textsearcher`
52
- * * `select`: `multiselectsearcher`
53
- * * `textarea`: `textsearcher`
54
- * * `textfield`: `textsearcher`
55
- * * `url`: `exacttextsearcher`
56
- * * `userpicker`: `userpickergroupsearcher`
57
- * * `version`: `versionsearcher`
58
- *
59
- * If no searcher is provided, the field isn't searchable. However, [Forge custom
60
- * fields](https://developer.atlassian.com/platform/forge/manifest-reference/modules/#jira-custom-field-type--beta-)
61
- * have a searcher set automatically, so are always searchable.
62
- */
63
- searcherKey?:
64
- | "com.atlassian.jira.plugin.system.customfieldtypes:cascadingselectsearcher"
65
- | "com.atlassian.jira.plugin.system.customfieldtypes:daterange"
66
- | "com.atlassian.jira.plugin.system.customfieldtypes:datetimerange"
67
- | "com.atlassian.jira.plugin.system.customfieldtypes:exactnumber"
68
- | "com.atlassian.jira.plugin.system.customfieldtypes:exacttextsearcher"
69
- | "com.atlassian.jira.plugin.system.customfieldtypes:grouppickersearcher"
70
- | "com.atlassian.jira.plugin.system.customfieldtypes:labelsearcher"
71
- | "com.atlassian.jira.plugin.system.customfieldtypes:multiselectsearcher"
72
- | "com.atlassian.jira.plugin.system.customfieldtypes:numberrange"
73
- | "com.atlassian.jira.plugin.system.customfieldtypes:projectsearcher"
74
- | "com.atlassian.jira.plugin.system.customfieldtypes:textsearcher"
75
- | "com.atlassian.jira.plugin.system.customfieldtypes:userpickergroupsearcher"
76
- | "com.atlassian.jira.plugin.system.customfieldtypes:versionsearcher";
77
- /**
78
- * The type of the custom field. These built-in custom field types are available:
79
- *
80
- * * `cascadingselect`: Enables values to be selected from two levels of select
81
- * lists (value:
82
- * `com.atlassian.jira.plugin.system.customfieldtypes:cascadingselect`)
83
- * * `datepicker`: Stores a date using a picker control (value:
84
- * `com.atlassian.jira.plugin.system.customfieldtypes:datepicker`)
85
- * * `datetime`: Stores a date with a time component (value:
86
- * `com.atlassian.jira.plugin.system.customfieldtypes:datetime`)
87
- * * `float`: Stores and validates a numeric (floating point) input (value:
88
- * `com.atlassian.jira.plugin.system.customfieldtypes:float`)
89
- * * `grouppicker`: Stores a user group using a picker control (value:
90
- * `com.atlassian.jira.plugin.system.customfieldtypes:grouppicker`)
91
- * * `importid`: A read-only field that stores the ID the issue had in the
92
- * system it was imported from (value:
93
- * `com.atlassian.jira.plugin.system.customfieldtypes:importid`)
94
- * * `labels`: Stores labels (value:
95
- * `com.atlassian.jira.plugin.system.customfieldtypes:labels`)
96
- * * `multicheckboxes`: Stores multiple values using checkboxes (value: ``)
97
- * * `multigrouppicker`: Stores multiple user groups using a picker control
98
- * (value: ``)
99
- * * `multiselect`: Stores multiple values using a select list (value:
100
- * `com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes`)
101
- * * `multiuserpicker`: Stores multiple users using a picker control (value:
102
- * `com.atlassian.jira.plugin.system.customfieldtypes:multigrouppicker`)
103
- * * `multiversion`: Stores multiple versions from the versions available in a
104
- * project using a picker control (value:
105
- * `com.atlassian.jira.plugin.system.customfieldtypes:multiversion`)
106
- * * `project`: Stores a project from a list of projects that the user is
107
- * permitted to view (value:
108
- * `com.atlassian.jira.plugin.system.customfieldtypes:project`)
109
- * * `radiobuttons`: Stores a value using radio buttons (value:
110
- * `com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons`)
111
- * * `readonlyfield`: Stores a read-only text value, which can only be populated
112
- * via the API (value:
113
- * `com.atlassian.jira.plugin.system.customfieldtypes:readonlyfield`)
114
- * * `select`: Stores a value from a configurable list of options (value:
115
- * `com.atlassian.jira.plugin.system.customfieldtypes:select`)
116
- * * `textarea`: Stores a long text string using a multiline text area (value:
117
- * `com.atlassian.jira.plugin.system.customfieldtypes:textarea`)
118
- * * `textfield`: Stores a text string using a single-line text box (value:
119
- * `com.atlassian.jira.plugin.system.customfieldtypes:textfield`)
120
- * * `url`: Stores a URL (value:
121
- * `com.atlassian.jira.plugin.system.customfieldtypes:url`)
122
- * * `userpicker`: Stores a user using a picker control (value:
123
- * `com.atlassian.jira.plugin.system.customfieldtypes:userpicker`)
124
- * * `version`: Stores a version using a picker control (value:
125
- * `com.atlassian.jira.plugin.system.customfieldtypes:version`)
126
- *
127
- * To create a field based on a [Forge custom field
128
- * type](https://developer.atlassian.com/platform/forge/manifest-reference/modules/#jira-custom-field-type--beta-),
129
- * use the ID of the Forge custom field type as the value. For example,
130
- * `ari:cloud:ecosystem::extension/e62f20a2-4b61-4dbe-bfb9-9a88b5e3ac84/548c5df1-24aa-4f7c-bbbb-3038d947cb05/static/my-cf-type-key`.
131
- */
132
- type: string;
133
- }
134
- /** Details of a field. */
135
- export interface Field {
136
- /** Number of contexts where the field is used. */
137
- contextsCount?: number;
138
- /** The description of the field. */
139
- description?: string;
140
- /** The ID of the field. */
141
- id: string;
142
- /** Whether the field is locked. */
143
- isLocked?: boolean;
144
- /** Whether the field is shown on screen or not. */
145
- isUnscreenable?: boolean;
146
- /** The key of the field. */
147
- key?: string;
148
- /** Information about the most recent use of a field. */
149
- lastUsed?: FieldLastUsed;
150
- /** The name of the field. */
151
- name: string;
152
- /** Number of projects where the field is used. */
153
- projectsCount?: number;
154
- /** The schema of a field. */
155
- schema: JsonTypeBean;
156
- /** Number of screens where the field is used. */
157
- screensCount?: number;
158
- /** The searcher key of the field. Returned for custom fields. */
159
- searcherKey?: string;
160
- /** The stable ID of the field. */
161
- stableId?: string;
162
- }
163
- /** Information about the most recent use of a field. */
164
- export interface FieldLastUsed {
165
- /**
166
- * Last used value type:
167
- *
168
- * * *TRACKED*: field is tracked and a last used date is available.
169
- * * *NOT\_TRACKED*: field is not tracked, last used date is not available.
170
- * * *NO\_INFORMATION*: field is tracked, but no last used date is available.
171
- */
172
- type?: "TRACKED" | "NOT_TRACKED" | "NO_INFORMATION";
173
- /** The date when the value of the field last changed. */
174
- value?: string;
175
- }
176
- /** A page of items. */
177
- export interface PageBeanContext {
178
- /** Whether this is the last page. */
179
- isLast?: boolean;
180
- /** The maximum number of items that could be returned. */
181
- maxResults?: number;
182
- /** If there is another page of results, the URL of the next page. */
183
- nextPage?: string;
184
- /** The URL of the page. */
185
- self?: string;
186
- /** The index of the first item returned. */
187
- startAt?: number;
188
- /** The number of items returned. */
189
- total?: number;
190
- /** The list of items. */
191
- values?: Context[];
192
- }
193
- /** A page of items. */
194
- export interface PageBeanField {
195
- /** Whether this is the last page. */
196
- isLast?: boolean;
197
- /** The maximum number of items that could be returned. */
198
- maxResults?: number;
199
- /** If there is another page of results, the URL of the next page. */
200
- nextPage?: string;
201
- /** The URL of the page. */
202
- self?: string;
203
- /** The index of the first item returned. */
204
- startAt?: number;
205
- /** The number of items returned. */
206
- total?: number;
207
- /** The list of items. */
208
- values?: Field[];
209
- }
210
- /** Details of a custom field. */
211
- export interface UpdateCustomFieldDetails {
212
- /** The description of the custom field. The maximum length is 40000 characters. */
213
- description?: string;
214
- /**
215
- * The name of the custom field. It doesn't have to be unique. The maximum length
216
- * is 255 characters.
217
- */
218
- name?: string;
219
- /**
220
- * The searcher that defines the way the field is searched in Jira. It can be set
221
- * to `null`, otherwise you must specify the valid searcher for the field type, as
222
- * listed below (abbreviated values shown):
223
- *
224
- * * `cascadingselect`: `cascadingselectsearcher`
225
- * * `datepicker`: `daterange`
226
- * * `datetime`: `datetimerange`
227
- * * `float`: `exactnumber` or `numberrange`
228
- * * `grouppicker`: `grouppickersearcher`
229
- * * `importid`: `exactnumber` or `numberrange`
230
- * * `labels`: `labelsearcher`
231
- * * `multicheckboxes`: `multiselectsearcher`
232
- * * `multigrouppicker`: `multiselectsearcher`
233
- * * `multiselect`: `multiselectsearcher`
234
- * * `multiuserpicker`: `userpickergroupsearcher`
235
- * * `multiversion`: `versionsearcher`
236
- * * `project`: `projectsearcher`
237
- * * `radiobuttons`: `multiselectsearcher`
238
- * * `readonlyfield`: `textsearcher`
239
- * * `select`: `multiselectsearcher`
240
- * * `textarea`: `textsearcher`
241
- * * `textfield`: `textsearcher`
242
- * * `url`: `exacttextsearcher`
243
- * * `userpicker`: `userpickergroupsearcher`
244
- * * `version`: `versionsearcher`
245
- */
246
- searcherKey?:
247
- | "com.atlassian.jira.plugin.system.customfieldtypes:cascadingselectsearcher"
248
- | "com.atlassian.jira.plugin.system.customfieldtypes:daterange"
249
- | "com.atlassian.jira.plugin.system.customfieldtypes:datetimerange"
250
- | "com.atlassian.jira.plugin.system.customfieldtypes:exactnumber"
251
- | "com.atlassian.jira.plugin.system.customfieldtypes:exacttextsearcher"
252
- | "com.atlassian.jira.plugin.system.customfieldtypes:grouppickersearcher"
253
- | "com.atlassian.jira.plugin.system.customfieldtypes:labelsearcher"
254
- | "com.atlassian.jira.plugin.system.customfieldtypes:multiselectsearcher"
255
- | "com.atlassian.jira.plugin.system.customfieldtypes:numberrange"
256
- | "com.atlassian.jira.plugin.system.customfieldtypes:projectsearcher"
257
- | "com.atlassian.jira.plugin.system.customfieldtypes:textsearcher"
258
- | "com.atlassian.jira.plugin.system.customfieldtypes:userpickergroupsearcher"
259
- | "com.atlassian.jira.plugin.system.customfieldtypes:versionsearcher";
260
- }
261
- export function registerIssueFieldsValidationSchemas(
262
- validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>,
263
- ) {
264
- validationSchemaStorage.register(
265
- "Context",
266
- z
267
- .object({
268
- id: z.number().int().optional(),
269
- name: z.string().optional(),
270
- scope: validationSchemaStorage.lazy("Scope").optional(),
271
- })
272
- .strict()
273
- .describe("Context"),
274
- );
275
- validationSchemaStorage.register(
276
- "CustomFieldDefinitionJsonBean",
277
- z
278
- .object({
279
- description: z.string().optional(),
280
- name: z.string(),
281
- searcherKey: z
282
- .enum([
283
- "com.atlassian.jira.plugin.system.customfieldtypes:cascadingselectsearcher",
284
- "com.atlassian.jira.plugin.system.customfieldtypes:daterange",
285
- "com.atlassian.jira.plugin.system.customfieldtypes:datetimerange",
286
- "com.atlassian.jira.plugin.system.customfieldtypes:exactnumber",
287
- "com.atlassian.jira.plugin.system.customfieldtypes:exacttextsearcher",
288
- "com.atlassian.jira.plugin.system.customfieldtypes:grouppickersearcher",
289
- "com.atlassian.jira.plugin.system.customfieldtypes:labelsearcher",
290
- "com.atlassian.jira.plugin.system.customfieldtypes:multiselectsearcher",
291
- "com.atlassian.jira.plugin.system.customfieldtypes:numberrange",
292
- "com.atlassian.jira.plugin.system.customfieldtypes:projectsearcher",
293
- "com.atlassian.jira.plugin.system.customfieldtypes:textsearcher",
294
- "com.atlassian.jira.plugin.system.customfieldtypes:userpickergroupsearcher",
295
- "com.atlassian.jira.plugin.system.customfieldtypes:versionsearcher",
296
- ])
297
- .optional(),
298
- type: z.string(),
299
- })
300
- .strict()
301
- .describe("CustomFieldDefinitionJsonBean"),
302
- );
303
- validationSchemaStorage.register(
304
- "Field",
305
- z
306
- .object({
307
- contextsCount: z.number().int().optional(),
308
- description: z.string().optional(),
309
- id: z.string(),
310
- isLocked: z.boolean().optional(),
311
- isUnscreenable: z.boolean().optional(),
312
- key: z.string().optional(),
313
- lastUsed: validationSchemaStorage.lazy("FieldLastUsed").optional(),
314
- name: z.string(),
315
- projectsCount: z.number().int().optional(),
316
- schema: validationSchemaStorage.lazy("JsonTypeBean"),
317
- screensCount: z.number().int().optional(),
318
- searcherKey: z.string().optional(),
319
- stableId: z.string().optional(),
320
- })
321
- .strict()
322
- .describe("Field"),
323
- );
324
- validationSchemaStorage.register(
325
- "FieldLastUsed",
326
- z
327
- .object({
328
- type: z.enum(["TRACKED", "NOT_TRACKED", "NO_INFORMATION"]).optional(),
329
- value: z.string().optional(),
330
- })
331
- .strict()
332
- .describe("FieldLastUsed"),
333
- );
334
- validationSchemaStorage.register(
335
- "PageBeanContext",
336
- z
337
- .object({
338
- isLast: z.boolean().optional(),
339
- maxResults: z.number().int().optional(),
340
- nextPage: z.string().optional(),
341
- self: z.string().optional(),
342
- startAt: z.number().int().optional(),
343
- total: z.number().int().optional(),
344
- values: z.array(validationSchemaStorage.lazy("Context")).optional(),
345
- })
346
- .strict()
347
- .describe("PageBeanContext"),
348
- );
349
- validationSchemaStorage.register(
350
- "PageBeanField",
351
- z
352
- .object({
353
- isLast: z.boolean().optional(),
354
- maxResults: z.number().int().optional(),
355
- nextPage: z.string().optional(),
356
- self: z.string().optional(),
357
- startAt: z.number().int().optional(),
358
- total: z.number().int().optional(),
359
- values: z.array(validationSchemaStorage.lazy("Field")).optional(),
360
- })
361
- .strict()
362
- .describe("PageBeanField"),
363
- );
364
- validationSchemaStorage.register(
365
- "UpdateCustomFieldDetails",
366
- z
367
- .object({
368
- description: z.string().optional(),
369
- name: z.string().optional(),
370
- searcherKey: z
371
- .enum([
372
- "com.atlassian.jira.plugin.system.customfieldtypes:cascadingselectsearcher",
373
- "com.atlassian.jira.plugin.system.customfieldtypes:daterange",
374
- "com.atlassian.jira.plugin.system.customfieldtypes:datetimerange",
375
- "com.atlassian.jira.plugin.system.customfieldtypes:exactnumber",
376
- "com.atlassian.jira.plugin.system.customfieldtypes:exacttextsearcher",
377
- "com.atlassian.jira.plugin.system.customfieldtypes:grouppickersearcher",
378
- "com.atlassian.jira.plugin.system.customfieldtypes:labelsearcher",
379
- "com.atlassian.jira.plugin.system.customfieldtypes:multiselectsearcher",
380
- "com.atlassian.jira.plugin.system.customfieldtypes:numberrange",
381
- "com.atlassian.jira.plugin.system.customfieldtypes:projectsearcher",
382
- "com.atlassian.jira.plugin.system.customfieldtypes:textsearcher",
383
- "com.atlassian.jira.plugin.system.customfieldtypes:userpickergroupsearcher",
384
- "com.atlassian.jira.plugin.system.customfieldtypes:versionsearcher",
385
- ])
386
- .optional(),
387
- })
388
- .strict()
389
- .describe("UpdateCustomFieldDetails"),
390
- );
391
- validationSchemaStorage.registerOnce([registerCommonValidationSchemas]);
392
- }
@@ -1,28 +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 IssueLinkType, registerCommonValidationSchemas } from "./common";
8
- /** A list of issue link type beans. */
9
- export interface IssueLinkTypes {
10
- /** The issue link type bean. */
11
- issueLinkTypes?: IssueLinkType[];
12
- }
13
- export function registerIssueLinkTypesValidationSchemas(
14
- validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>,
15
- ) {
16
- validationSchemaStorage.register(
17
- "IssueLinkTypes",
18
- z
19
- .object({
20
- issueLinkTypes: z
21
- .array(validationSchemaStorage.lazy("IssueLinkType"))
22
- .optional(),
23
- })
24
- .strict()
25
- .describe("IssueLinkTypes"),
26
- );
27
- validationSchemaStorage.registerOnce([registerCommonValidationSchemas]);
28
- }
@@ -1,185 +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 Comment,
9
- type IssueLinkType,
10
- type IssueTypeDetails,
11
- type Priority,
12
- registerCommonValidationSchemas,
13
- type StatusDetails,
14
- type UserDetails,
15
- } from "./common";
16
- /** Priority schemes associated with the issue priority. */
17
- export interface ExpandPrioritySchemePage extends Record<string, unknown> {
18
- maxResults?: number;
19
- startAt?: number;
20
- total?: number;
21
- }
22
- /** Key fields from the linked issue. */
23
- export interface Fields {
24
- /** The assignee of the linked issue. */
25
- assignee?: UserDetails;
26
- /** The type of the linked issue. */
27
- issueType?: IssueTypeDetails;
28
- /** Details about an issue type. */
29
- issuetype?: IssueTypeDetails;
30
- /** The priority of the linked issue. */
31
- priority?: Priority;
32
- /** The status of the linked issue. */
33
- status?: StatusDetails;
34
- /** The summary description of the linked issue. */
35
- summary?: string;
36
- /** The time tracking of the linked issue. */
37
- timetracking?: TimeTrackingDetails;
38
- }
39
- /** Details of a link between issues. */
40
- export interface IssueLink {
41
- /** The ID of the issue link. */
42
- id?: string;
43
- /**
44
- * Provides details about the linked issue. If presenting this link in a user
45
- * interface, use the `inward` field of the issue link type to label the link.
46
- */
47
- inwardIssue: LinkedIssue;
48
- /**
49
- * Provides details about the linked issue. If presenting this link in a user
50
- * interface, use the `outward` field of the issue link type to label the link.
51
- */
52
- outwardIssue: LinkedIssue;
53
- /** The URL of the issue link. */
54
- self?: string;
55
- /** The type of link between the issues. */
56
- type: IssueLinkType;
57
- }
58
- /** The ID or key of a linked issue. */
59
- export interface LinkedIssue {
60
- /** The fields associated with the issue. */
61
- fields?: Fields;
62
- /** The ID of an issue. Required if `key` isn't provided. */
63
- id?: string;
64
- /** The key of an issue. Required if `id` isn't provided. */
65
- key?: string;
66
- /** The URL of the issue. */
67
- self?: string;
68
- }
69
- export interface LinkIssueRequestJsonBean {
70
- /** A comment. */
71
- comment?: Comment;
72
- /** The ID or key of a linked issue. */
73
- inwardIssue: LinkedIssue;
74
- /** The ID or key of a linked issue. */
75
- outwardIssue: LinkedIssue;
76
- /**
77
- * This object is used as follows:
78
- *
79
- * * In the [ issueLink](#api-rest-api-3-issueLink-post) resource it defines and
80
- * reports on the type of link between the issues. Find a list of issue link types
81
- * with [Get issue link types](#api-rest-api-3-issueLinkType-get).
82
- * * In the [ issueLinkType](#api-rest-api-3-issueLinkType-post) resource it
83
- * defines and reports on issue link types.
84
- */
85
- type: IssueLinkType;
86
- }
87
- /** Time tracking details. */
88
- export interface TimeTrackingDetails {
89
- /** The original estimate of time needed for this issue in readable format. */
90
- originalEstimate?: string;
91
- /** The original estimate of time needed for this issue in seconds. */
92
- originalEstimateSeconds?: number;
93
- /** The remaining estimate of time needed for this issue in readable format. */
94
- remainingEstimate?: string;
95
- /** The remaining estimate of time needed for this issue in seconds. */
96
- remainingEstimateSeconds?: number;
97
- /** Time worked on this issue in readable format. */
98
- timeSpent?: string;
99
- /** Time worked on this issue in seconds. */
100
- timeSpentSeconds?: number;
101
- }
102
- export function registerIssueLinksValidationSchemas(
103
- validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>,
104
- ) {
105
- validationSchemaStorage.register(
106
- "ExpandPrioritySchemePage",
107
- z
108
- .object({
109
- maxResults: z.number().int().optional(),
110
- startAt: z.number().int().optional(),
111
- total: z.number().int().optional(),
112
- })
113
- .catchall(z.unknown())
114
- .describe("ExpandPrioritySchemePage"),
115
- );
116
- validationSchemaStorage.register(
117
- "Fields",
118
- z
119
- .object({
120
- assignee: validationSchemaStorage.lazy("UserDetails").optional(),
121
- issueType: validationSchemaStorage.lazy("IssueTypeDetails").optional(),
122
- issuetype: validationSchemaStorage.lazy("IssueTypeDetails").optional(),
123
- priority: validationSchemaStorage.lazy("Priority").optional(),
124
- status: validationSchemaStorage.lazy("StatusDetails").optional(),
125
- summary: z.string().optional(),
126
- timetracking: validationSchemaStorage
127
- .lazy("TimeTrackingDetails")
128
- .optional(),
129
- })
130
- .strict()
131
- .describe("Fields"),
132
- );
133
- validationSchemaStorage.register(
134
- "IssueLink",
135
- z
136
- .object({
137
- id: z.string().optional(),
138
- inwardIssue: validationSchemaStorage.lazy("LinkedIssue"),
139
- outwardIssue: validationSchemaStorage.lazy("LinkedIssue"),
140
- self: z.string().optional(),
141
- type: validationSchemaStorage.lazy("IssueLinkType"),
142
- })
143
- .strict()
144
- .describe("IssueLink"),
145
- );
146
- validationSchemaStorage.register(
147
- "LinkedIssue",
148
- z
149
- .object({
150
- fields: validationSchemaStorage.lazy("Fields").optional(),
151
- id: z.string().optional(),
152
- key: z.string().optional(),
153
- self: z.string().optional(),
154
- })
155
- .strict()
156
- .describe("LinkedIssue"),
157
- );
158
- validationSchemaStorage.register(
159
- "LinkIssueRequestJsonBean",
160
- z
161
- .object({
162
- comment: validationSchemaStorage.lazy("Comment").optional(),
163
- inwardIssue: validationSchemaStorage.lazy("LinkedIssue"),
164
- outwardIssue: validationSchemaStorage.lazy("LinkedIssue"),
165
- type: validationSchemaStorage.lazy("IssueLinkType"),
166
- })
167
- .strict()
168
- .describe("LinkIssueRequestJsonBean"),
169
- );
170
- validationSchemaStorage.register(
171
- "TimeTrackingDetails",
172
- z
173
- .object({
174
- originalEstimate: z.string().optional(),
175
- originalEstimateSeconds: z.number().int().optional(),
176
- remainingEstimate: z.string().optional(),
177
- remainingEstimateSeconds: z.number().int().optional(),
178
- timeSpent: z.string().optional(),
179
- timeSpentSeconds: z.number().int().optional(),
180
- })
181
- .strict()
182
- .describe("TimeTrackingDetails"),
183
- );
184
- validationSchemaStorage.registerOnce([registerCommonValidationSchemas]);
185
- }