@resolution/jira-api-client 0.5.7 → 0.5.8

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 (60) hide show
  1. package/CHANGELOG.md +11 -0
  2. package/lib/openapi/platform/BaseJiraPlatformApiClient.d.ts +9 -10
  3. package/lib/openapi/platform/BaseJiraPlatformApiClient.js.map +1 -1
  4. package/lib/openapi/platform/models/common.d.ts +268 -3
  5. package/lib/openapi/platform/models/common.js +156 -3
  6. package/lib/openapi/platform/models/common.js.map +1 -1
  7. package/lib/openapi/platform/models/issueAttachments.d.ts +1 -26
  8. package/lib/openapi/platform/models/issueAttachments.js +0 -14
  9. package/lib/openapi/platform/models/issueAttachments.js.map +1 -1
  10. package/lib/openapi/platform/models/issueComments.d.ts +0 -15
  11. package/lib/openapi/platform/models/issueComments.js +0 -9
  12. package/lib/openapi/platform/models/issueComments.js.map +1 -1
  13. package/lib/openapi/platform/models/issueLinks.d.ts +1 -89
  14. package/lib/openapi/platform/models/issueLinks.js +0 -52
  15. package/lib/openapi/platform/models/issueLinks.js.map +1 -1
  16. package/lib/openapi/platform/models/issueResolutions.d.ts +0 -15
  17. package/lib/openapi/platform/models/issueResolutions.js +0 -9
  18. package/lib/openapi/platform/models/issueResolutions.js.map +1 -1
  19. package/lib/openapi/platform/models/issueWatchers.d.ts +0 -16
  20. package/lib/openapi/platform/models/issueWatchers.js +0 -13
  21. package/lib/openapi/platform/models/issueWatchers.js.map +1 -1
  22. package/lib/openapi/platform/models/issueWorklogs.d.ts +1 -71
  23. package/lib/openapi/platform/models/issueWorklogs.js +0 -29
  24. package/lib/openapi/platform/models/issueWorklogs.js.map +1 -1
  25. package/lib/openapi/platform/models/issues.d.ts +57 -1
  26. package/lib/openapi/platform/models/issues.js +41 -0
  27. package/lib/openapi/platform/models/issues.js.map +1 -1
  28. package/lib/openapi/platform/services/IssueAttachmentsService.d.ts +2 -1
  29. package/lib/openapi/platform/services/IssueAttachmentsService.js +2 -0
  30. package/lib/openapi/platform/services/IssueAttachmentsService.js.map +1 -1
  31. package/lib/openapi/platform/services/IssueCommentsService.d.ts +2 -2
  32. package/lib/openapi/platform/services/IssueCommentsService.js.map +1 -1
  33. package/lib/openapi/platform/services/IssueLinksService.d.ts +2 -1
  34. package/lib/openapi/platform/services/IssueLinksService.js +2 -2
  35. package/lib/openapi/platform/services/IssueLinksService.js.map +1 -1
  36. package/lib/openapi/platform/services/IssueResolutionsService.d.ts +2 -1
  37. package/lib/openapi/platform/services/IssueResolutionsService.js +2 -0
  38. package/lib/openapi/platform/services/IssueResolutionsService.js.map +1 -1
  39. package/lib/openapi/platform/services/IssueVotesService.d.ts +1 -1
  40. package/lib/openapi/platform/services/IssueVotesService.js +2 -2
  41. package/lib/openapi/platform/services/IssueVotesService.js.map +1 -1
  42. package/lib/openapi/platform/services/IssueWatchersService.d.ts +2 -1
  43. package/lib/openapi/platform/services/IssueWatchersService.js +2 -0
  44. package/lib/openapi/platform/services/IssueWatchersService.js.map +1 -1
  45. package/lib/openapi/platform/services/IssueWorklogsService.d.ts +2 -1
  46. package/lib/openapi/platform/services/IssueWorklogsService.js +2 -0
  47. package/lib/openapi/platform/services/IssueWorklogsService.js.map +1 -1
  48. package/lib/openapi/software/BaseJiraSoftwareApiClient.d.ts +10 -2
  49. package/lib/openapi/software/BaseJiraSoftwareApiClient.js.map +1 -1
  50. package/lib/openapi/software/models/board.d.ts +873 -0
  51. package/lib/openapi/software/models/board.js +417 -0
  52. package/lib/openapi/software/models/board.js.map +1 -1
  53. package/lib/openapi/software/models/common.d.ts +74 -1
  54. package/lib/openapi/software/models/common.js +61 -1
  55. package/lib/openapi/software/models/common.js.map +1 -1
  56. package/lib/openapi/software/models/deployments.d.ts +1 -1
  57. package/package.json +3 -3
  58. package/lib/openapi/platform/models/issueVotes.d.ts +0 -22
  59. package/lib/openapi/platform/models/issueVotes.js +0 -22
  60. package/lib/openapi/platform/models/issueVotes.js.map +0 -1
@@ -1,6 +1,97 @@
1
1
  import { type ZodTypeAny } from "zod";
2
2
  import type { CommonValidationSchemaStorage } from "../../core/CommonValidationSchemaStorage";
3
3
  import { type IssueBean } from "./common";
4
+ /**
5
+ * Details of an application role.
6
+ *
7
+ * @category Models
8
+ */
9
+ export interface ApplicationRole {
10
+ /**
11
+ * The groups that are granted default access for this application role. As a
12
+ * group's name can change, use of `defaultGroupsDetails` is recommended to
13
+ * identify a groups.
14
+ */
15
+ defaultGroups?: string[];
16
+ /** The groups that are granted default access for this application role. */
17
+ defaultGroupsDetails?: GroupName[];
18
+ /**
19
+ * Deprecated.
20
+ *
21
+ * @deprecated
22
+ */
23
+ defined?: boolean;
24
+ /** The groups associated with the application role. */
25
+ groupDetails?: GroupName[];
26
+ /**
27
+ * The groups associated with the application role. As a group's name can change,
28
+ * use of `groupDetails` is recommended to identify a groups.
29
+ */
30
+ groups?: string[];
31
+ hasUnlimitedSeats?: boolean;
32
+ /** The key of the application role. */
33
+ key?: string;
34
+ /** The display name of the application role. */
35
+ name?: string;
36
+ /** The maximum count of users on your license. */
37
+ numberOfSeats?: number;
38
+ /** Indicates if the application role belongs to Jira platform (`jira-core`). */
39
+ platform?: boolean;
40
+ /** The count of users remaining on your license. */
41
+ remainingSeats?: number;
42
+ /**
43
+ * Determines whether this application role should be selected by default on user
44
+ * creation.
45
+ */
46
+ selectedByDefault?: boolean;
47
+ /** The number of users counting against your license. */
48
+ userCount?: number;
49
+ /**
50
+ * The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted
51
+ * against your license.
52
+ */
53
+ userCountDescription?: string;
54
+ }
55
+ /**
56
+ * Details about an attachment.
57
+ *
58
+ * @category Models
59
+ */
60
+ export interface Attachment extends Record<string, unknown> {
61
+ /** Details of the user who added the attachment. */
62
+ author?: UserDetails;
63
+ /** The content of the attachment. */
64
+ content?: string;
65
+ /** The datetime the attachment was created. */
66
+ created?: string;
67
+ /** The file name of the attachment. */
68
+ filename?: string;
69
+ /** The ID of the attachment. */
70
+ id?: string;
71
+ /** The MIME type of the attachment. */
72
+ mimeType?: string;
73
+ /** The URL of the attachment details response. */
74
+ self?: string;
75
+ /** The size of the attachment. */
76
+ size?: number;
77
+ /** The URL of a thumbnail representing the attachment. */
78
+ thumbnail?: string;
79
+ }
80
+ /**
81
+ * The avatars of the user.
82
+ *
83
+ * @category Models
84
+ */
85
+ export interface AvatarUrlsBean {
86
+ /** The URL of the item's 16x16 pixel avatar. */
87
+ "16x16"?: string;
88
+ /** The URL of the item's 24x24 pixel avatar. */
89
+ "24x24"?: string;
90
+ /** The URL of the item's 32x32 pixel avatar. */
91
+ "32x32"?: string;
92
+ /** The URL of the item's 48x48 pixel avatar. */
93
+ "48x48"?: string;
94
+ }
4
95
  /**
5
96
  * Details about a board.
6
97
  *
@@ -127,6 +218,69 @@ export interface ColumnConfigBean {
127
218
  columns?: ColumnBean[];
128
219
  constraintType?: string;
129
220
  }
221
+ /**
222
+ * A comment.
223
+ *
224
+ * @category Models
225
+ */
226
+ export interface Comment extends Record<string, unknown> {
227
+ /** The ID of the user who created the comment. */
228
+ author?: UserDetails;
229
+ /**
230
+ * The comment text in [Atlassian Document
231
+ * Format](https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/).
232
+ */
233
+ body?: unknown;
234
+ /** The date and time at which the comment was created. */
235
+ created?: string;
236
+ /** The ID of the comment. */
237
+ id?: string;
238
+ /**
239
+ * Whether the comment was added from an email sent by a person who is not part of
240
+ * the issue. See [Allow external emails to be added as comments on
241
+ * issues](https://support.atlassian.com/jira-service-management-cloud/docs/allow-external-emails-to-be-added-as-comments-on-issues/)for
242
+ * information on setting up this feature.
243
+ */
244
+ jsdAuthorCanSeeRequest?: boolean;
245
+ /**
246
+ * Whether the comment is visible in Jira Service Desk. Defaults to true when
247
+ * comments are created in the Jira Cloud Platform. This includes when the site
248
+ * doesn't use Jira Service Desk or the project isn't a Jira Service Desk project
249
+ * and, therefore, there is no Jira Service Desk for the issue to be visible on.
250
+ * To create a comment with its visibility in Jira Service Desk set to false, use
251
+ * the Jira Service Desk REST API [Create request
252
+ * comment](https://developer.atlassian.com/cloud/jira/service-desk/rest/#api-rest-servicedeskapi-request-issueIdOrKey-comment-post)
253
+ * operation.
254
+ */
255
+ jsdPublic?: boolean;
256
+ /** A list of comment properties. Optional on create and update. */
257
+ properties?: EntityProperty[];
258
+ /** The rendered version of the comment. */
259
+ renderedBody?: string;
260
+ /** The URL of the comment. */
261
+ self?: string;
262
+ /** The ID of the user who updated the comment last. */
263
+ updateAuthor?: UserDetails;
264
+ /** The date and time at which the comment was updated last. */
265
+ updated?: string;
266
+ /**
267
+ * The group or role to which this comment is visible. Optional on create and
268
+ * update.
269
+ */
270
+ visibility?: Visibility;
271
+ }
272
+ /**
273
+ * An entity property, for more information see [Entity
274
+ * properties](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/).
275
+ *
276
+ * @category Models
277
+ */
278
+ export interface EntityProperty {
279
+ /** The key of the property. Required on create and update. */
280
+ key?: string;
281
+ /** The value of the property. Required on create and update. */
282
+ value?: unknown;
283
+ }
130
284
  /** @category Models */
131
285
  export interface Entry {
132
286
  errors?: string[];
@@ -150,6 +304,16 @@ export interface EstimationFieldBean {
150
304
  displayName?: string;
151
305
  fieldId?: string;
152
306
  }
307
+ /**
308
+ * Priority schemes associated with the issue priority.
309
+ *
310
+ * @category Models
311
+ */
312
+ export interface ExpandPrioritySchemePage extends Record<string, unknown> {
313
+ maxResults?: number;
314
+ startAt?: number;
315
+ total?: number;
316
+ }
153
317
  /** @category Models */
154
318
  export interface FeatureBean {
155
319
  boardFeature?: "SIMPLE_ROADMAP" | "BACKLOG" | "SPRINTS" | "CALENDAR" | "DEVTOOLS" | "REPORTS" | "ESTIMATION" | "PAGES" | "CODE" | "SECURITY" | "REQUESTS" | "INCIDENTS" | "RELEASES" | "DEPLOYMENTS" | "ISSUE_NAVIGATOR" | "ON_CALL_SCHEDULE" | "BOARD" | "GOALS" | "LIST_VIEW";
@@ -205,11 +369,48 @@ export interface FieldMetadata {
205
369
  /** The data type of the field. */
206
370
  schema: JsonTypeBean;
207
371
  }
372
+ /**
373
+ * Key fields from the linked issue.
374
+ *
375
+ * @category Models
376
+ */
377
+ export interface Fields {
378
+ /** The assignee of the linked issue. */
379
+ assignee?: UserDetails;
380
+ /** The type of the linked issue. */
381
+ issueType?: IssueTypeDetails;
382
+ /** Details about an issue type. */
383
+ issuetype?: IssueTypeDetails;
384
+ /** The priority of the linked issue. */
385
+ priority?: Priority;
386
+ /** The status of the linked issue. */
387
+ status?: StatusDetails;
388
+ /** The summary description of the linked issue. */
389
+ summary?: string;
390
+ /** The time tracking of the linked issue. */
391
+ timetracking?: TimeTrackingDetails;
392
+ }
208
393
  /** @category Models */
209
394
  export interface GroupBean {
210
395
  name?: string;
211
396
  self?: string;
212
397
  }
398
+ /**
399
+ * Details about a group.
400
+ *
401
+ * @category Models
402
+ */
403
+ export interface GroupName {
404
+ /**
405
+ * The ID of the group, which uniquely identifies the group across all Atlassian
406
+ * products. For example, *952d12c3-5b5b-4d04-bb32-44d383afc4b2*.
407
+ */
408
+ groupId?: string | null;
409
+ /** The name of group. */
410
+ name?: string;
411
+ /** The URL for these group details. */
412
+ self?: string;
413
+ }
213
414
  /**
214
415
  * Details of issue history metadata.
215
416
  *
@@ -269,6 +470,88 @@ export interface IncludedFields {
269
470
  excluded?: string[];
270
471
  included?: string[];
271
472
  }
473
+ /**
474
+ * Details of a link between issues.
475
+ *
476
+ * @category Models
477
+ */
478
+ export interface IssueLink {
479
+ /** The ID of the issue link. */
480
+ id?: string;
481
+ /**
482
+ * Provides details about the linked issue. If presenting this link in a user
483
+ * interface, use the `inward` field of the issue link type to label the link.
484
+ */
485
+ inwardIssue: LinkedIssue;
486
+ /**
487
+ * Provides details about the linked issue. If presenting this link in a user
488
+ * interface, use the `outward` field of the issue link type to label the link.
489
+ */
490
+ outwardIssue: LinkedIssue;
491
+ /** The URL of the issue link. */
492
+ self?: string;
493
+ /** The type of link between the issues. */
494
+ type: IssueLinkType;
495
+ }
496
+ /**
497
+ * This object is used as follows:
498
+ *
499
+ * * In the [ issueLink](#api-rest-api-3-issueLink-post) resource it defines and
500
+ * reports on the type of link between the issues. Find a list of issue link types
501
+ * with [Get issue link types](#api-rest-api-3-issueLinkType-get).
502
+ * * In the [ issueLinkType](#api-rest-api-3-issueLinkType-post) resource it
503
+ * defines and reports on issue link types.
504
+ *
505
+ * @category Models
506
+ */
507
+ export interface IssueLinkType {
508
+ /**
509
+ * The ID of the issue link type and is used as follows:
510
+ *
511
+ * * In the [ issueLink](#api-rest-api-3-issueLink-post) resource it is the type
512
+ * of issue link. Required on create when `name` isn't provided. Otherwise, read
513
+ * only.
514
+ * * In the [ issueLinkType](#api-rest-api-3-issueLinkType-post) resource it is
515
+ * read only.
516
+ */
517
+ id?: string;
518
+ /**
519
+ * The description of the issue link type inward link and is used as follows:
520
+ *
521
+ * * In the [ issueLink](#api-rest-api-3-issueLink-post) resource it is read
522
+ * only.
523
+ * * In the [ issueLinkType](#api-rest-api-3-issueLinkType-post) resource it is
524
+ * required on create and optional on update. Otherwise, read only.
525
+ */
526
+ inward?: string;
527
+ /**
528
+ * The name of the issue link type and is used as follows:
529
+ *
530
+ * * In the [ issueLink](#api-rest-api-3-issueLink-post) resource it is the type
531
+ * of issue link. Required on create when `id` isn't provided. Otherwise, read
532
+ * only.
533
+ * * In the [ issueLinkType](#api-rest-api-3-issueLinkType-post) resource it is
534
+ * required on create and optional on update. Otherwise, read only.
535
+ */
536
+ name?: string;
537
+ /**
538
+ * The description of the issue link type outward link and is used as follows:
539
+ *
540
+ * * In the [ issueLink](#api-rest-api-3-issueLink-post) resource it is read
541
+ * only.
542
+ * * In the [ issueLinkType](#api-rest-api-3-issueLinkType-post) resource it is
543
+ * required on create and optional on update. Otherwise, read only.
544
+ */
545
+ outward?: string;
546
+ /** The URL of the issue link type. Read only. */
547
+ self?: string;
548
+ }
549
+ /** @category Models */
550
+ export interface IssueProgress extends Record<string, unknown> {
551
+ progress: number;
552
+ total: number;
553
+ percent?: number;
554
+ }
272
555
  /**
273
556
  * Details of an issue transition.
274
557
  *
@@ -308,6 +591,33 @@ export interface IssueTransition extends Record<string, unknown> {
308
591
  /** Details of the issue status after the transition. */
309
592
  to?: StatusDetails;
310
593
  }
594
+ /**
595
+ * Details about an issue type.
596
+ *
597
+ * @category Models
598
+ */
599
+ export interface IssueTypeDetails {
600
+ /** The ID of the issue type's avatar. */
601
+ avatarId?: number;
602
+ /** The description of the issue type. */
603
+ description?: string;
604
+ /** Unique ID for next-gen projects. */
605
+ entityId?: string;
606
+ /** Hierarchy level of the issue type. */
607
+ hierarchyLevel?: number;
608
+ /** The URL of the issue type's avatar. */
609
+ iconUrl?: string;
610
+ /** The ID of the issue type. */
611
+ id?: string;
612
+ /** The name of the issue type. */
613
+ name?: string;
614
+ /** Details of the next-gen projects the issue type is available in. */
615
+ scope?: Scope;
616
+ /** The URL of these issue type details. */
617
+ self?: string;
618
+ /** Whether this issue type is used to create subtasks. */
619
+ subtask?: boolean;
620
+ }
311
621
  /**
312
622
  * A list of editable field details.
313
623
  *
@@ -339,6 +649,21 @@ export interface JsonTypeBean {
339
649
  /** The data type of the field. */
340
650
  type: string;
341
651
  }
652
+ /**
653
+ * The ID or key of a linked issue.
654
+ *
655
+ * @category Models
656
+ */
657
+ export interface LinkedIssue {
658
+ /** The fields associated with the issue. */
659
+ fields?: Fields;
660
+ /** The ID of an issue. Required if `key` isn't provided. */
661
+ id?: string;
662
+ /** The key of an issue. Required if `id` isn't provided. */
663
+ key?: string;
664
+ /** The URL of the issue. */
665
+ self?: string;
666
+ }
342
667
  /**
343
668
  * Details a link group, which defines issue operations.
344
669
  *
@@ -354,6 +679,12 @@ export interface LinkGroup {
354
679
  weight?: number;
355
680
  }
356
681
  /** @category Models */
682
+ export interface ListWrapperCallbackApplicationRole {
683
+ }
684
+ /** @category Models */
685
+ export interface ListWrapperCallbackGroupName {
686
+ }
687
+ /** @category Models */
357
688
  export interface LocationBean {
358
689
  projectKeyOrId?: string;
359
690
  type?: "project" | "user";
@@ -390,10 +721,169 @@ export interface PageOfChangelogs {
390
721
  /** The number of results on the page. */
391
722
  total?: number;
392
723
  }
724
+ /**
725
+ * A page of comments.
726
+ *
727
+ * @category Models
728
+ */
729
+ export interface PageOfComments extends Record<string, unknown> {
730
+ /** The list of comments. */
731
+ comments?: Comment[];
732
+ /** The maximum number of items that could be returned. */
733
+ maxResults?: number;
734
+ /** The index of the first item returned. */
735
+ startAt?: number;
736
+ /** The number of items returned. */
737
+ total?: number;
738
+ }
739
+ /**
740
+ * Paginated list of worklog details
741
+ *
742
+ * @category Models
743
+ */
744
+ export interface PageOfWorklogs extends Record<string, unknown> {
745
+ /** The maximum number of results that could be on the page. */
746
+ maxResults?: number;
747
+ /** The index of the first item returned on the page. */
748
+ startAt?: number;
749
+ /** The number of results on the page. */
750
+ total?: number;
751
+ /** List of worklogs. */
752
+ worklogs?: Worklog[];
753
+ }
393
754
  /** @category Models */
394
755
  export interface PartialSuccessBean {
395
756
  entries?: Entry[];
396
757
  }
758
+ /**
759
+ * An issue priority.
760
+ *
761
+ * @category Models
762
+ */
763
+ export interface Priority extends Record<string, unknown> {
764
+ /** The description of the issue priority. */
765
+ description?: string;
766
+ /** The URL of the icon for the issue priority. */
767
+ iconUrl?: string;
768
+ /** The ID of the issue priority. */
769
+ id?: string;
770
+ /** Whether this priority is the default. */
771
+ isDefault?: boolean;
772
+ /** The name of the issue priority. */
773
+ name?: string;
774
+ /** Priority schemes associated with the issue priority. */
775
+ schemes?: ExpandPrioritySchemePage;
776
+ /** The URL of the issue priority. */
777
+ self?: string;
778
+ /** The color used to indicate the issue priority. */
779
+ statusColor?: string;
780
+ }
781
+ /**
782
+ * Details about a project component.
783
+ *
784
+ * @category Models
785
+ */
786
+ export interface ProjectComponent {
787
+ /**
788
+ * Compass component's ID. Can't be updated. Not required for creating a Project
789
+ * Component.
790
+ */
791
+ ari?: string;
792
+ /**
793
+ * The details of the user associated with `assigneeType`, if any. See
794
+ * `realAssignee` for details of the user assigned to issues created with this
795
+ * component.
796
+ */
797
+ assignee?: User;
798
+ /**
799
+ * The nominal user type used to determine the assignee for issues created with
800
+ * this component. See `realAssigneeType` for details on how the type of the user,
801
+ * and hence the user, assigned to issues is determined. Can take the following
802
+ * values:
803
+ *
804
+ * * `PROJECT_LEAD` the assignee to any issues created with this component is
805
+ * nominally the lead for the project the component is in.
806
+ * * `COMPONENT_LEAD` the assignee to any issues created with this component is
807
+ * nominally the lead for the component.
808
+ * * `UNASSIGNED` an assignee is not set for issues created with this component.
809
+ * * `PROJECT_DEFAULT` the assignee to any issues created with this component is
810
+ * nominally the default assignee for the project that the component is in.
811
+ *
812
+ * Default value: `PROJECT_DEFAULT`.
813
+ * Optional when creating or updating a component.
814
+ */
815
+ assigneeType?: "PROJECT_DEFAULT" | "COMPONENT_LEAD" | "PROJECT_LEAD" | "UNASSIGNED";
816
+ /**
817
+ * The description for the component. Optional when creating or updating a
818
+ * component.
819
+ */
820
+ description?: string;
821
+ /** The unique identifier for the component. */
822
+ id?: string;
823
+ /**
824
+ * Whether a user is associated with `assigneeType`. For example, if the
825
+ * `assigneeType` is set to `COMPONENT_LEAD` but the component lead is not set,
826
+ * then `false` is returned.
827
+ */
828
+ isAssigneeTypeValid?: boolean;
829
+ /** The user details for the component's lead user. */
830
+ lead?: User;
831
+ /**
832
+ * The accountId of the component's lead user. The accountId uniquely identifies
833
+ * the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.
834
+ */
835
+ leadAccountId?: string;
836
+ /**
837
+ * This property is no longer available and will be removed from the documentation
838
+ * soon. See the [deprecation
839
+ * notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/)
840
+ * for details.
841
+ */
842
+ leadUserName?: string;
843
+ /**
844
+ * Compass component's metadata. Can't be updated. Not required for creating a
845
+ * Project Component.
846
+ */
847
+ metadata?: {
848
+ [key: string]: string;
849
+ };
850
+ /**
851
+ * The unique name for the component in the project. Required when creating a
852
+ * component. Optional when updating a component. The maximum length is 255
853
+ * characters.
854
+ */
855
+ name?: string;
856
+ /**
857
+ * The key of the project the component is assigned to. Required when creating a
858
+ * component. Can't be updated.
859
+ */
860
+ project?: string;
861
+ /** The ID of the project the component is assigned to. */
862
+ projectId?: number;
863
+ /**
864
+ * The user assigned to issues created with this component, when `assigneeType`
865
+ * does not identify a valid assignee.
866
+ */
867
+ realAssignee?: User;
868
+ /**
869
+ * The type of the assignee that is assigned to issues created with this
870
+ * component, when an assignee cannot be set from the `assigneeType`. For example,
871
+ * `assigneeType` is set to `COMPONENT_LEAD` but no component lead is set. This
872
+ * property is set to one of the following values:
873
+ *
874
+ * * `PROJECT_LEAD` when `assigneeType` is `PROJECT_LEAD` and the project lead
875
+ * has permission to be assigned issues in the project that the component is in.
876
+ * * `COMPONENT_LEAD` when `assignee`Type is `COMPONENT_LEAD` and the component
877
+ * lead has permission to be assigned issues in the project that the component is
878
+ * in.
879
+ * * `UNASSIGNED` when `assigneeType` is `UNASSIGNED` and Jira is configured to
880
+ * allow unassigned issues.
881
+ * * `PROJECT_DEFAULT` when none of the preceding cases are true.
882
+ */
883
+ realAssigneeType?: "PROJECT_DEFAULT" | "COMPONENT_LEAD" | "PROJECT_LEAD" | "UNASSIGNED";
884
+ /** The URL of the component. */
885
+ self?: string;
886
+ }
397
887
  /**
398
888
  * Details about a project.
399
889
  *
@@ -443,6 +933,21 @@ export interface RelationBean {
443
933
  export interface ReportsResponseBean {
444
934
  reports?: {}[];
445
935
  }
936
+ /**
937
+ * Details of an issue resolution.
938
+ *
939
+ * @category Models
940
+ */
941
+ export interface Resolution {
942
+ /** The description of the issue resolution. */
943
+ description?: string;
944
+ /** The ID of the issue resolution. */
945
+ id?: string;
946
+ /** The name of the issue resolution. */
947
+ name?: string;
948
+ /** The URL of the issue resolution. */
949
+ self?: string;
950
+ }
446
951
  /**
447
952
  * The projects the item is associated with. Indicated for items associated with
448
953
  * [next-gen projects](https://confluence.atlassian.com/x/loMyO).
@@ -496,6 +1001,30 @@ export interface SimpleLink {
496
1001
  title?: string;
497
1002
  weight?: number;
498
1003
  }
1004
+ /**
1005
+ * The application roles the user is assigned to.
1006
+ *
1007
+ * @category Models
1008
+ */
1009
+ export interface SimpleListWrapperApplicationRole {
1010
+ callback?: ListWrapperCallbackApplicationRole;
1011
+ items?: ApplicationRole[];
1012
+ "max-results"?: number;
1013
+ pagingCallback?: ListWrapperCallbackApplicationRole;
1014
+ size?: number;
1015
+ }
1016
+ /**
1017
+ * The groups that the user belongs to.
1018
+ *
1019
+ * @category Models
1020
+ */
1021
+ export interface SimpleListWrapperGroupName {
1022
+ callback?: ListWrapperCallbackGroupName;
1023
+ items?: GroupName[];
1024
+ "max-results"?: number;
1025
+ pagingCallback?: ListWrapperCallbackGroupName;
1026
+ size?: number;
1027
+ }
499
1028
  /**
500
1029
  * A status category.
501
1030
  *
@@ -538,6 +1067,25 @@ export interface StatusDetails extends Record<string, unknown> {
538
1067
  export interface SubqueryBean {
539
1068
  query?: string;
540
1069
  }
1070
+ /**
1071
+ * Time tracking details.
1072
+ *
1073
+ * @category Models
1074
+ */
1075
+ export interface TimeTrackingDetails {
1076
+ /** The original estimate of time needed for this issue in readable format. */
1077
+ originalEstimate?: string;
1078
+ /** The original estimate of time needed for this issue in seconds. */
1079
+ originalEstimateSeconds?: number;
1080
+ /** The remaining estimate of time needed for this issue in readable format. */
1081
+ remainingEstimate?: string;
1082
+ /** The remaining estimate of time needed for this issue in seconds. */
1083
+ remainingEstimateSeconds?: number;
1084
+ /** Time worked on this issue in readable format. */
1085
+ timeSpent?: string;
1086
+ /** Time worked on this issue in seconds. */
1087
+ timeSpentSeconds?: number;
1088
+ }
541
1089
  /**
542
1090
  * A project category.
543
1091
  *
@@ -553,6 +1101,84 @@ export interface UpdatedProjectCategory {
553
1101
  /** The URL of the project category. */
554
1102
  self?: string;
555
1103
  }
1104
+ /**
1105
+ * A user with details as permitted by the user's Atlassian Account privacy
1106
+ * settings. However, be aware of these exceptions:
1107
+ *
1108
+ * * User record deleted from Atlassian: This occurs as the result of a right to
1109
+ * be forgotten request. In this case, `displayName` provides an indication and
1110
+ * other parameters have default values or are blank (for example, email is blank).
1111
+ * * User record corrupted: This occurs as a results of events such as a server
1112
+ * import and can only happen to deleted users. In this case, `accountId` returns
1113
+ * *unknown* and all other parameters have fallback values.
1114
+ * * User record unavailable: This usually occurs due to an internal service
1115
+ * outage. In this case, all parameters have fallback values.
1116
+ *
1117
+ * @category Models
1118
+ */
1119
+ export interface User {
1120
+ /**
1121
+ * The account ID of the user, which uniquely identifies the user across all
1122
+ * Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required in
1123
+ * requests.
1124
+ */
1125
+ accountId?: string;
1126
+ /**
1127
+ * The user account type. Can take the following values:
1128
+ *
1129
+ * * `atlassian` regular Atlassian user account
1130
+ * * `app` system account used for Connect applications and OAuth to represent
1131
+ * external systems
1132
+ * * `customer` Jira Service Desk account representing an external service desk
1133
+ */
1134
+ accountType?: "atlassian" | "app" | "customer" | "unknown";
1135
+ /** Whether the user is active. */
1136
+ active?: boolean;
1137
+ /** The application roles the user is assigned to. */
1138
+ applicationRoles?: SimpleListWrapperApplicationRole;
1139
+ /** The avatars of the user. */
1140
+ avatarUrls?: AvatarUrlsBean;
1141
+ /**
1142
+ * The display name of the user. Depending on the user’s privacy setting, this may
1143
+ * return an alternative value.
1144
+ */
1145
+ displayName?: string;
1146
+ /**
1147
+ * The email address of the user. Depending on the user’s privacy setting, this
1148
+ * may be returned as null.
1149
+ */
1150
+ emailAddress?: string;
1151
+ /** Expand options that include additional user details in the response. */
1152
+ expand?: string;
1153
+ /** The groups that the user belongs to. */
1154
+ groups?: SimpleListWrapperGroupName;
1155
+ /**
1156
+ * This property is no longer available and will be removed from the documentation
1157
+ * soon. See the [deprecation
1158
+ * notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/)
1159
+ * for details.
1160
+ */
1161
+ key?: string;
1162
+ /**
1163
+ * The locale of the user. Depending on the user’s privacy setting, this may be
1164
+ * returned as null.
1165
+ */
1166
+ locale?: string;
1167
+ /**
1168
+ * This property is no longer available and will be removed from the documentation
1169
+ * soon. See the [deprecation
1170
+ * notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/)
1171
+ * for details.
1172
+ */
1173
+ name?: string;
1174
+ /** The URL of the user. */
1175
+ self?: string;
1176
+ /**
1177
+ * The time zone specified in the user's profile. Depending on the user’s privacy
1178
+ * setting, this may be returned as null.
1179
+ */
1180
+ timeZone?: string;
1181
+ }
556
1182
  /** @category Models */
557
1183
  export interface UserBean {
558
1184
  /**
@@ -670,4 +1296,251 @@ export interface UserDetails {
670
1296
  */
671
1297
  timeZone?: string;
672
1298
  }
1299
+ /**
1300
+ * Details about a project version.
1301
+ *
1302
+ * @category Models
1303
+ */
1304
+ export interface Version {
1305
+ /**
1306
+ * If the expand option `approvers` is used, returns a list containing the
1307
+ * approvers for this version.
1308
+ */
1309
+ approvers?: VersionApprover[];
1310
+ /**
1311
+ * Indicates that the version is archived. Optional when creating or updating a
1312
+ * version.
1313
+ */
1314
+ archived?: boolean;
1315
+ /**
1316
+ * The description of the version. Optional when creating or updating a version.
1317
+ * The maximum size is 16,384 bytes.
1318
+ */
1319
+ description?: string;
1320
+ /**
1321
+ * If the expand option `driver` is used, returns the Atlassian account ID of the
1322
+ * driver.
1323
+ */
1324
+ driver?: string;
1325
+ /**
1326
+ * Use [expand](em>#expansion) to include additional information about version in
1327
+ * the response. This parameter accepts a comma-separated list. Expand options
1328
+ * include:
1329
+ *
1330
+ * * `operations` Returns the list of operations available for this version.
1331
+ * * `issuesstatus` Returns the count of issues in this version for each of the
1332
+ * status categories *to do*, *in progress*, *done*, and *unmapped*. The
1333
+ * *unmapped* property contains a count of issues with a status other than *to
1334
+ * do*, *in progress*, and *done*.
1335
+ * * `driver` Returns the Atlassian account ID of the version driver.
1336
+ * * `approvers` Returns a list containing approvers for this version.
1337
+ *
1338
+ * Optional for create and update.
1339
+ */
1340
+ expand?: string;
1341
+ /** The ID of the version. */
1342
+ id?: string;
1343
+ /**
1344
+ * If the expand option `issuesstatus` is used, returns the count of issues in
1345
+ * this version for each of the status categories *to do*, *in progress*, *done*,
1346
+ * and *unmapped*. The *unmapped* property contains a count of issues with a
1347
+ * status other than *to do*, *in progress*, and *done*.
1348
+ */
1349
+ issuesStatusForFixVersion?: VersionIssuesStatus;
1350
+ /**
1351
+ * The URL of the self link to the version to which all unfixed issues are moved
1352
+ * when a version is released. Not applicable when creating a version. Optional
1353
+ * when updating a version.
1354
+ */
1355
+ moveUnfixedIssuesTo?: string;
1356
+ /**
1357
+ * The unique name of the version. Required when creating a version. Optional when
1358
+ * updating a version. The maximum length is 255 characters.
1359
+ */
1360
+ name?: string;
1361
+ /**
1362
+ * If the expand option `operations` is used, returns the list of operations
1363
+ * available for this version.
1364
+ */
1365
+ operations?: SimpleLink[];
1366
+ /** Indicates that the version is overdue. */
1367
+ overdue?: boolean;
1368
+ /**
1369
+ * Deprecated. Use `projectId`.
1370
+ *
1371
+ * @deprecated
1372
+ */
1373
+ project?: string;
1374
+ /**
1375
+ * The ID of the project to which this version is attached. Required when creating
1376
+ * a version. Not applicable when updating a version.
1377
+ */
1378
+ projectId?: number;
1379
+ /**
1380
+ * The release date of the version. Expressed in ISO 8601 format (yyyy-mm-dd).
1381
+ * Optional when creating or updating a version.
1382
+ */
1383
+ releaseDate?: string;
1384
+ /**
1385
+ * Indicates that the version is released. If the version is released a request to
1386
+ * release again is ignored. Not applicable when creating a version. Optional when
1387
+ * updating a version.
1388
+ */
1389
+ released?: boolean;
1390
+ /** The URL of the version. */
1391
+ self?: string;
1392
+ /**
1393
+ * The start date of the version. Expressed in ISO 8601 format (yyyy-mm-dd).
1394
+ * Optional when creating or updating a version.
1395
+ */
1396
+ startDate?: string;
1397
+ /**
1398
+ * The date on which work on this version is expected to finish, expressed in the
1399
+ * instance's *Day/Month/Year Format* date format.
1400
+ */
1401
+ userReleaseDate?: string;
1402
+ /**
1403
+ * The date on which work on this version is expected to start, expressed in the
1404
+ * instance's *Day/Month/Year Format* date format.
1405
+ */
1406
+ userStartDate?: string;
1407
+ }
1408
+ /**
1409
+ * Contains details about a version approver.
1410
+ *
1411
+ * @category Models
1412
+ */
1413
+ export interface VersionApprover extends Record<string, unknown> {
1414
+ /** The Atlassian account ID of the approver. */
1415
+ accountId?: string;
1416
+ /** A description of why the user is declining the approval. */
1417
+ declineReason?: string;
1418
+ /** A description of what the user is approving within the specified version. */
1419
+ description?: string;
1420
+ /** The status of the approval, which can be *PENDING*, *APPROVED*, or *DECLINED* */
1421
+ status?: string;
1422
+ }
1423
+ /**
1424
+ * Counts of the number of issues in various statuses.
1425
+ *
1426
+ * @category Models
1427
+ */
1428
+ export interface VersionIssuesStatus extends Record<string, unknown> {
1429
+ /** Count of issues with status *done*. */
1430
+ done?: number;
1431
+ /** Count of issues with status *in progress*. */
1432
+ inProgress?: number;
1433
+ /** Count of issues with status *to do*. */
1434
+ toDo?: number;
1435
+ /** Count of issues with a status other than *to do*, *in progress*, and *done*. */
1436
+ unmapped?: number;
1437
+ }
1438
+ /**
1439
+ * The group or role to which this item is visible.
1440
+ *
1441
+ * @category Models
1442
+ */
1443
+ export interface Visibility extends Record<string, unknown> {
1444
+ /**
1445
+ * The ID of the group or the name of the role that visibility of this item is
1446
+ * restricted to.
1447
+ */
1448
+ identifier?: string | null;
1449
+ /** Whether visibility of this item is restricted to a group or role. */
1450
+ type?: "group" | "role";
1451
+ /**
1452
+ * The name of the group or role that visibility of this item is restricted to.
1453
+ * Please note that the name of a group is mutable, to reliably identify a group
1454
+ * use `identifier`.
1455
+ */
1456
+ value?: string;
1457
+ }
1458
+ /**
1459
+ * The details of votes on an issue.
1460
+ *
1461
+ * @category Models
1462
+ */
1463
+ export interface Votes {
1464
+ /** Whether the user making this request has voted on the issue. */
1465
+ hasVoted?: boolean;
1466
+ /** The URL of these issue vote details. */
1467
+ self?: string;
1468
+ /**
1469
+ * List of the users who have voted on this issue. An empty list is returned when
1470
+ * the calling user doesn't have the *View voters and watchers* project permission.
1471
+ */
1472
+ voters?: User[];
1473
+ /** The number of votes on the issue. */
1474
+ votes?: number;
1475
+ }
1476
+ /**
1477
+ * The details of watchers on an issue.
1478
+ *
1479
+ * @category Models
1480
+ */
1481
+ export interface Watchers {
1482
+ /** Whether the calling user is watching this issue. */
1483
+ isWatching?: boolean;
1484
+ /** The URL of these issue watcher details. */
1485
+ self?: string;
1486
+ /** The number of users watching this issue. */
1487
+ watchCount?: number;
1488
+ /** Details of the users watching this issue. */
1489
+ watchers?: UserDetails[];
1490
+ }
1491
+ /**
1492
+ * Details of a worklog.
1493
+ *
1494
+ * @category Models
1495
+ */
1496
+ export interface Worklog extends Record<string, unknown> {
1497
+ /** Details of the user who created the worklog. */
1498
+ author?: UserDetails;
1499
+ /**
1500
+ * A comment about the worklog in [Atlassian Document
1501
+ * Format](https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/).
1502
+ * Optional when creating or updating a worklog.
1503
+ */
1504
+ comment?: unknown;
1505
+ /** The datetime on which the worklog was created. */
1506
+ created?: string;
1507
+ /** The ID of the worklog record. */
1508
+ id?: string;
1509
+ /** The ID of the issue this worklog is for. */
1510
+ issueId?: string;
1511
+ /**
1512
+ * Details of properties for the worklog. Optional when creating or updating a
1513
+ * worklog.
1514
+ */
1515
+ properties?: EntityProperty[];
1516
+ /** The URL of the worklog item. */
1517
+ self?: string;
1518
+ /**
1519
+ * The datetime on which the worklog effort was started. Required when creating a
1520
+ * worklog. Optional when updating a worklog.
1521
+ */
1522
+ started?: string;
1523
+ /**
1524
+ * The time spent working on the issue as days (\#d), hours (\#h), or minutes (\#m
1525
+ * or \#). Required when creating a worklog if `timeSpentSeconds` isn't provided.
1526
+ * Optional when updating a worklog. Cannot be provided if `timeSpentSecond` is
1527
+ * provided.
1528
+ */
1529
+ timeSpent?: string;
1530
+ /**
1531
+ * The time in seconds spent working on the issue. Required when creating a
1532
+ * worklog if `timeSpent` isn't provided. Optional when updating a worklog. Cannot
1533
+ * be provided if `timeSpent` is provided.
1534
+ */
1535
+ timeSpentSeconds?: number;
1536
+ /** Details of the user who last updated the worklog. */
1537
+ updateAuthor?: UserDetails;
1538
+ /** The datetime on which the worklog was last updated. */
1539
+ updated?: string;
1540
+ /**
1541
+ * Details about any restrictions in the visibility of the worklog. Optional when
1542
+ * creating or updating a worklog.
1543
+ */
1544
+ visibility?: Visibility;
1545
+ }
673
1546
  export declare function registerBoardValidationSchemas(validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>): void;