@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,192 +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 PageBeanIssueTypeScreenScheme,
9
- registerCommonValidationSchemas,
10
- } from "./common";
11
- /** A page of items. */
12
- export interface PageBeanScreenScheme {
13
- /** Whether this is the last page. */
14
- isLast?: boolean;
15
- /** The maximum number of items that could be returned. */
16
- maxResults?: number;
17
- /** If there is another page of results, the URL of the next page. */
18
- nextPage?: string;
19
- /** The URL of the page. */
20
- self?: string;
21
- /** The index of the first item returned. */
22
- startAt?: number;
23
- /** The number of items returned. */
24
- total?: number;
25
- /** The list of items. */
26
- values?: ScreenScheme[];
27
- }
28
- /** A screen scheme. */
29
- export interface ScreenScheme {
30
- /** The description of the screen scheme. */
31
- description?: string;
32
- /** The ID of the screen scheme. */
33
- id?: number;
34
- /** Details of the issue type screen schemes associated with the screen scheme. */
35
- issueTypeScreenSchemes?: PageBeanIssueTypeScreenScheme;
36
- /** The name of the screen scheme. */
37
- name?: string;
38
- /** The IDs of the screens for the screen types of the screen scheme. */
39
- screens?: ScreenTypes;
40
- }
41
- /** Details of a screen scheme. */
42
- export interface ScreenSchemeDetails {
43
- /** The description of the screen scheme. The maximum length is 255 characters. */
44
- description?: string;
45
- /**
46
- * The name of the screen scheme. The name must be unique. The maximum length is
47
- * 255 characters.
48
- */
49
- name: string;
50
- /**
51
- * The IDs of the screens for the screen types of the screen scheme. Only screens
52
- * used in classic projects are accepted.
53
- */
54
- screens: ScreenTypes;
55
- }
56
- /** The ID of a screen scheme. */
57
- export interface ScreenSchemeId {
58
- /** The ID of the screen scheme. */
59
- id: number;
60
- }
61
- /** The IDs of the screens for the screen types of the screen scheme. */
62
- export interface ScreenTypes {
63
- /** The ID of the create screen. */
64
- create?: number;
65
- /** The ID of the default screen. Required when creating a screen scheme. */
66
- default?: number;
67
- /** The ID of the edit screen. */
68
- edit?: number;
69
- /** The ID of the view screen. */
70
- view?: number;
71
- }
72
- /** Details of a screen scheme. */
73
- export interface UpdateScreenSchemeDetails {
74
- /** The description of the screen scheme. The maximum length is 255 characters. */
75
- description?: string;
76
- /**
77
- * The name of the screen scheme. The name must be unique. The maximum length is
78
- * 255 characters.
79
- */
80
- name?: string;
81
- /**
82
- * The IDs of the screens for the screen types of the screen scheme. Only screens
83
- * used in classic projects are accepted.
84
- */
85
- screens?: UpdateScreenTypes;
86
- }
87
- /** The IDs of the screens for the screen types of the screen scheme. */
88
- export interface UpdateScreenTypes {
89
- /** The ID of the create screen. To remove the screen association, pass a null. */
90
- create?: string;
91
- /**
92
- * The ID of the default screen. When specified, must include a screen ID as a
93
- * default screen is required.
94
- */
95
- default?: string;
96
- /** The ID of the edit screen. To remove the screen association, pass a null. */
97
- edit?: string;
98
- /** The ID of the view screen. To remove the screen association, pass a null. */
99
- view?: string;
100
- }
101
- export function registerScreenSchemesValidationSchemas(
102
- validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>,
103
- ) {
104
- validationSchemaStorage.register(
105
- "PageBeanScreenScheme",
106
- z
107
- .object({
108
- isLast: z.boolean().optional(),
109
- maxResults: z.number().int().optional(),
110
- nextPage: z.string().optional(),
111
- self: z.string().optional(),
112
- startAt: z.number().int().optional(),
113
- total: z.number().int().optional(),
114
- values: z
115
- .array(validationSchemaStorage.lazy("ScreenScheme"))
116
- .optional(),
117
- })
118
- .strict()
119
- .describe("PageBeanScreenScheme"),
120
- );
121
- validationSchemaStorage.register(
122
- "ScreenScheme",
123
- z
124
- .object({
125
- description: z.string().optional(),
126
- id: z.number().int().optional(),
127
- issueTypeScreenSchemes: validationSchemaStorage
128
- .lazy("PageBeanIssueTypeScreenScheme")
129
- .optional(),
130
- name: z.string().optional(),
131
- screens: validationSchemaStorage.lazy("ScreenTypes").optional(),
132
- })
133
- .strict()
134
- .describe("ScreenScheme"),
135
- );
136
- validationSchemaStorage.register(
137
- "ScreenSchemeDetails",
138
- z
139
- .object({
140
- description: z.string().optional(),
141
- name: z.string(),
142
- screens: validationSchemaStorage.lazy("ScreenTypes"),
143
- })
144
- .strict()
145
- .describe("ScreenSchemeDetails"),
146
- );
147
- validationSchemaStorage.register(
148
- "ScreenSchemeId",
149
- z
150
- .object({
151
- id: z.number().int(),
152
- })
153
- .strict()
154
- .describe("ScreenSchemeId"),
155
- );
156
- validationSchemaStorage.register(
157
- "ScreenTypes",
158
- z
159
- .object({
160
- create: z.number().int().optional(),
161
- default: z.number().int().optional(),
162
- edit: z.number().int().optional(),
163
- view: z.number().int().optional(),
164
- })
165
- .strict()
166
- .describe("ScreenTypes"),
167
- );
168
- validationSchemaStorage.register(
169
- "UpdateScreenSchemeDetails",
170
- z
171
- .object({
172
- description: z.string().optional(),
173
- name: z.string().optional(),
174
- screens: validationSchemaStorage.lazy("UpdateScreenTypes").optional(),
175
- })
176
- .strict()
177
- .describe("UpdateScreenSchemeDetails"),
178
- );
179
- validationSchemaStorage.register(
180
- "UpdateScreenTypes",
181
- z
182
- .object({
183
- create: z.string().optional(),
184
- default: z.string().optional(),
185
- edit: z.string().optional(),
186
- view: z.string().optional(),
187
- })
188
- .strict()
189
- .describe("UpdateScreenTypes"),
190
- );
191
- validationSchemaStorage.registerOnce([registerCommonValidationSchemas]);
192
- }
@@ -1,45 +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
- export interface AddFieldBean {
8
- /** The ID of the field to add. */
9
- fieldId: string;
10
- }
11
- export interface MoveFieldBean {
12
- /**
13
- * The ID of the screen tab field after which to place the moved screen tab field.
14
- * Required if `position` isn't provided.
15
- */
16
- after?: string;
17
- /**
18
- * The named position to which the screen tab field should be moved. Required if
19
- * `after` isn't provided.
20
- */
21
- position?: "Earlier" | "Later" | "First" | "Last";
22
- }
23
- export function registerScreenTabFieldsValidationSchemas(
24
- validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>,
25
- ) {
26
- validationSchemaStorage.register(
27
- "AddFieldBean",
28
- z
29
- .object({
30
- fieldId: z.string(),
31
- })
32
- .strict()
33
- .describe("AddFieldBean"),
34
- );
35
- validationSchemaStorage.register(
36
- "MoveFieldBean",
37
- z
38
- .object({
39
- after: z.string().optional(),
40
- position: z.enum(["Earlier", "Later", "First", "Last"]).optional(),
41
- })
42
- .strict()
43
- .describe("MoveFieldBean"),
44
- );
45
- }
@@ -1,171 +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 Scope,
10
- type ScreenableTab,
11
- } from "./common";
12
- /** A page of items. */
13
- export interface PageBeanScreen {
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?: Screen[];
28
- }
29
- /** A page of items. */
30
- export interface PageBeanScreenWithTab {
31
- /** Whether this is the last page. */
32
- isLast?: boolean;
33
- /** The maximum number of items that could be returned. */
34
- maxResults?: number;
35
- /** If there is another page of results, the URL of the next page. */
36
- nextPage?: string;
37
- /** The URL of the page. */
38
- self?: string;
39
- /** The index of the first item returned. */
40
- startAt?: number;
41
- /** The number of items returned. */
42
- total?: number;
43
- /** The list of items. */
44
- values?: ScreenWithTab[];
45
- }
46
- /** A screen. */
47
- export interface Screen {
48
- /** The description of the screen. */
49
- description?: string;
50
- /** The ID of the screen. */
51
- id?: number;
52
- /** The name of the screen. */
53
- name?: string;
54
- /** The scope of the screen. */
55
- scope?: Scope;
56
- }
57
- /** Details of a screen. */
58
- export interface ScreenDetails {
59
- /** The description of the screen. The maximum length is 255 characters. */
60
- description?: string;
61
- /**
62
- * The name of the screen. The name must be unique. The maximum length is 255
63
- * characters.
64
- */
65
- name: string;
66
- }
67
- /** A screen with tab details. */
68
- export interface ScreenWithTab {
69
- /** The description of the screen. */
70
- description?: string;
71
- /** The ID of the screen. */
72
- id?: number;
73
- /** The name of the screen. */
74
- name?: string;
75
- /** The scope of the screen. */
76
- scope?: Scope;
77
- /** The tab for the screen. */
78
- tab?: ScreenableTab;
79
- }
80
- /** Details of a screen. */
81
- export interface UpdateScreenDetails {
82
- /** The description of the screen. The maximum length is 255 characters. */
83
- description?: string;
84
- /**
85
- * The name of the screen. The name must be unique. The maximum length is 255
86
- * characters.
87
- */
88
- name?: string;
89
- }
90
- export function registerScreensValidationSchemas(
91
- validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>,
92
- ) {
93
- validationSchemaStorage.register(
94
- "PageBeanScreen",
95
- z
96
- .object({
97
- isLast: z.boolean().optional(),
98
- maxResults: z.number().int().optional(),
99
- nextPage: z.string().optional(),
100
- self: z.string().optional(),
101
- startAt: z.number().int().optional(),
102
- total: z.number().int().optional(),
103
- values: z.array(validationSchemaStorage.lazy("Screen")).optional(),
104
- })
105
- .strict()
106
- .describe("PageBeanScreen"),
107
- );
108
- validationSchemaStorage.register(
109
- "PageBeanScreenWithTab",
110
- z
111
- .object({
112
- isLast: z.boolean().optional(),
113
- maxResults: z.number().int().optional(),
114
- nextPage: z.string().optional(),
115
- self: z.string().optional(),
116
- startAt: z.number().int().optional(),
117
- total: z.number().int().optional(),
118
- values: z
119
- .array(validationSchemaStorage.lazy("ScreenWithTab"))
120
- .optional(),
121
- })
122
- .strict()
123
- .describe("PageBeanScreenWithTab"),
124
- );
125
- validationSchemaStorage.register(
126
- "Screen",
127
- z
128
- .object({
129
- description: z.string().optional(),
130
- id: z.number().int().optional(),
131
- name: z.string().optional(),
132
- scope: validationSchemaStorage.lazy("Scope").optional(),
133
- })
134
- .strict()
135
- .describe("Screen"),
136
- );
137
- validationSchemaStorage.register(
138
- "ScreenDetails",
139
- z
140
- .object({
141
- description: z.string().optional(),
142
- name: z.string(),
143
- })
144
- .strict()
145
- .describe("ScreenDetails"),
146
- );
147
- validationSchemaStorage.register(
148
- "ScreenWithTab",
149
- z
150
- .object({
151
- description: z.string().optional(),
152
- id: z.number().int().optional(),
153
- name: z.string().optional(),
154
- scope: validationSchemaStorage.lazy("Scope").optional(),
155
- tab: validationSchemaStorage.lazy("ScreenableTab").optional(),
156
- })
157
- .strict()
158
- .describe("ScreenWithTab"),
159
- );
160
- validationSchemaStorage.register(
161
- "UpdateScreenDetails",
162
- z
163
- .object({
164
- description: z.string().optional(),
165
- name: z.string().optional(),
166
- })
167
- .strict()
168
- .describe("UpdateScreenDetails"),
169
- );
170
- validationSchemaStorage.registerOnce([registerCommonValidationSchemas]);
171
- }
@@ -1,100 +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
- /** Jira instance health check results. Deprecated and no longer returned. */
8
- export interface HealthCheckResult {
9
- /** The description of the Jira health check item. */
10
- description?: string;
11
- /** The name of the Jira health check item. */
12
- name?: string;
13
- /** Whether the Jira health check item passed or failed. */
14
- passed?: boolean;
15
- }
16
- /** Details about the Jira instance. */
17
- export interface ServerInformation {
18
- /** The base URL of the Jira instance. */
19
- baseUrl?: string;
20
- /** The timestamp when the Jira version was built. */
21
- buildDate?: string;
22
- /** The build number of the Jira version. */
23
- buildNumber?: number;
24
- /** The type of server deployment. This is always returned as *Cloud*. */
25
- deploymentType?: string;
26
- /** The display URL of the Jira instance. */
27
- displayUrl?: string;
28
- /** The display URL of the Servicedesk Help Center. */
29
- displayUrlServicedeskHelpCenter?: string;
30
- /** Jira instance health check results. Deprecated and no longer returned. */
31
- healthChecks?: HealthCheckResult[];
32
- /** The unique identifier of the Jira version. */
33
- scmInfo?: string;
34
- /** The time in Jira when this request was responded to. */
35
- serverTime?: string;
36
- /**
37
- * The default timezone of the Jira server. In a format known as Olson Time Zones,
38
- * IANA Time Zones or TZ Database Time Zones.
39
- */
40
- serverTimeZone?: {
41
- displayName?: string;
42
- dstsavings?: number;
43
- id?: string;
44
- rawOffset?: number;
45
- } & {
46
- [key: string]: unknown;
47
- };
48
- /** The name of the Jira instance. */
49
- serverTitle?: string;
50
- /** The version of Jira. */
51
- version?: string;
52
- /** The major, minor, and revision version numbers of the Jira version. */
53
- versionNumbers?: number[];
54
- }
55
- export function registerServerInfoValidationSchemas(
56
- validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>,
57
- ) {
58
- validationSchemaStorage.register(
59
- "HealthCheckResult",
60
- z
61
- .object({
62
- description: z.string().optional(),
63
- name: z.string().optional(),
64
- passed: z.boolean().optional(),
65
- })
66
- .strict()
67
- .describe("HealthCheckResult"),
68
- );
69
- validationSchemaStorage.register(
70
- "ServerInformation",
71
- z
72
- .object({
73
- baseUrl: z.string().optional(),
74
- buildDate: z.string().optional(),
75
- buildNumber: z.number().int().optional(),
76
- deploymentType: z.string().optional(),
77
- displayUrl: z.string().optional(),
78
- displayUrlServicedeskHelpCenter: z.string().optional(),
79
- healthChecks: z
80
- .array(validationSchemaStorage.lazy("HealthCheckResult"))
81
- .optional(),
82
- scmInfo: z.string().optional(),
83
- serverTime: z.string().optional(),
84
- serverTimeZone: z
85
- .object({
86
- displayName: z.string().optional(),
87
- dstsavings: z.number().int().optional(),
88
- id: z.string().optional(),
89
- rawOffset: z.number().int().optional(),
90
- })
91
- .catchall(z.unknown())
92
- .optional(),
93
- serverTitle: z.string().optional(),
94
- version: z.string().optional(),
95
- versionNumbers: z.array(z.number().int()).optional(),
96
- })
97
- .strict()
98
- .describe("ServerInformation"),
99
- );
100
- }
@@ -1,68 +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
- export interface ServiceRegistry extends Record<string, unknown> {
8
- /** service description */
9
- description?: string | null;
10
- /** service ID */
11
- id?: string;
12
- /** service name */
13
- name?: string;
14
- /** organization ID */
15
- organizationId?: string;
16
- /** service revision */
17
- revision?: string;
18
- serviceTier?: ServiceRegistryTier;
19
- }
20
- export interface ServiceRegistryTier extends Record<string, unknown> {
21
- /** tier description */
22
- description?: string | null;
23
- /** tier ID */
24
- id?: string;
25
- /** tier level */
26
- level?: number;
27
- /** tier name */
28
- name?: string | null;
29
- /**
30
- * name key of the tier
31
- *
32
- * @example service-registry.tier1.name
33
- */
34
- nameKey?: string;
35
- }
36
- export function registerServiceRegistryValidationSchemas(
37
- validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>,
38
- ) {
39
- validationSchemaStorage.register(
40
- "ServiceRegistry",
41
- z
42
- .object({
43
- description: z.nullable(z.string()).optional(),
44
- id: z.string().optional(),
45
- name: z.string().optional(),
46
- organizationId: z.string().optional(),
47
- revision: z.string().optional(),
48
- serviceTier: validationSchemaStorage
49
- .lazy("ServiceRegistryTier")
50
- .optional(),
51
- })
52
- .catchall(z.unknown())
53
- .describe("ServiceRegistry"),
54
- );
55
- validationSchemaStorage.register(
56
- "ServiceRegistryTier",
57
- z
58
- .object({
59
- description: z.nullable(z.string()).optional(),
60
- id: z.string().optional(),
61
- level: z.number().int().optional(),
62
- name: z.nullable(z.string()).optional(),
63
- nameKey: z.string().optional(),
64
- })
65
- .catchall(z.unknown())
66
- .describe("ServiceRegistryTier"),
67
- );
68
- }