@resolution/jira-api-client 0.5.4 → 0.5.6

package/lib/openapi/platform/models/common.d.ts

@@ -12,7 +12,11 @@ import { type IncludedFields, type IssueTransition, type IssueUpdateMetadata, ty
 import { type IssueTypeScreenScheme } from "./issueTypeScreenSchemes";
 import { type PermissionGrant } from "./permissionSchemes";
 import { type AppWorkflowTransitionRule, type WorkflowId } from "./workflowTransitionRules";
-/** Details of an application role. */
+/**
+ * Details of an application role.
+ *
+ * @category Models
+ */
 export interface ApplicationRole {
     /**
      * The groups that are granted default access for this application role. As a
@@ -59,7 +63,11 @@ export interface ApplicationRole {
      */
     userCountDescription?: string;
 }
-/** Details of an avatar. */
+/**
+ * Details of an avatar.
+ *
+ * @category Models
+ */
 export interface Avatar extends Record<string, unknown> {
     /** The file name of the avatar icon. Returned for system avatars. */
     fileName?: string;
@@ -82,7 +90,11 @@ export interface Avatar extends Record<string, unknown> {
         [key: string]: string;
     };
 }
-/** The avatars of the user. */
+/**
+ * The avatars of the user.
+ *
+ * @category Models
+ */
 export interface AvatarUrlsBean {
     /** The URL of the item's 16x16 pixel avatar. */
     "16x16"?: string;
@@ -93,17 +105,26 @@ export interface AvatarUrlsBean {
     /** The URL of the item's 48x48 pixel avatar. */
     "48x48"?: string;
 }
-/** Details of an issue navigator column item. */
+/**
+ * Details of an issue navigator column item.
+ *
+ * @category Models
+ */
 export interface ColumnItem {
     /** The issue navigator column label. */
     label?: string;
     /** The issue navigator column value. */
     value?: string;
 }
+/** @category Models */
 export interface ColumnRequestBody {
     columns?: string[];
 }
-/** A comment. */
+/**
+ * A comment.
+ *
+ * @category Models
+ */
 export interface Comment extends Record<string, unknown> {
     /** The ID of the user who created the comment. */
     author?: UserDetails;
@@ -150,7 +171,11 @@ export interface Comment extends Record<string, unknown> {
      */
     visibility?: Visibility;
 }
-/** Details about the default workflow. */
+/**
+ * Details about the default workflow.
+ *
+ * @category Models
+ */
 export interface DefaultWorkflow {
     /**
      * Whether a draft workflow scheme is created or updated when updating an active
@@ -161,7 +186,11 @@ export interface DefaultWorkflow {
     /** The name of the workflow to set as the default workflow. */
     workflow: string;
 }
-/** The current version details of this workflow scheme. */
+/**
+ * The current version details of this workflow scheme.
+ *
+ * @category Models
+ */
 export interface DocumentVersion {
     /** The version UUID. */
     id: string;
@@ -171,6 +200,8 @@ export interface DocumentVersion {
 /**
  * An entity property, for more information see [Entity
  * properties](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/).
+ *
+ * @category Models
  */
 export interface EntityProperty {
     /** The key of the property. Required on create and update. */
@@ -178,7 +209,11 @@ export interface EntityProperty {
     /** The value of the property. Required on create and update. */
     value?: unknown;
 }
-/** Error messages from an operation. */
+/**
+ * Error messages from an operation.
+ *
+ * @category Models
+ */
 export interface ErrorCollection {
     /**
      * The list of error messages produced by this operation. For example, "input
@@ -195,10 +230,15 @@ export interface ErrorCollection {
     };
     status?: number;
 }
+/** @category Models */
 export interface ErrorMessage {
     message?: string;
 }
-/** Details about a field. */
+/**
+ * Details about a field.
+ *
+ * @category Models
+ */
 export interface FieldDetails {
     /**
      * The names that can be used to reference the field in an advanced search. For
@@ -228,6 +268,8 @@ export interface FieldDetails {
 /**
  * The list of groups found in a search, including header text (Showing X of Y
  * matching groups) and total of matched groups.
+ *
+ * @category Models
  */
 export interface FoundGroups {
     groups?: FoundGroup[];
@@ -242,6 +284,8 @@ export interface FoundGroups {
 /**
  * The list of users found in a search, including header text (Showing X of Y
  * matching users) and total of matched users.
+ *
+ * @category Models
  */
 export interface FoundUsers {
     /**
@@ -253,7 +297,11 @@ export interface FoundUsers {
     total?: number;
     users?: UserPickerUser[];
 }
-/** Details about a group. */
+/**
+ * Details about a group.
+ *
+ * @category Models
+ */
 export interface GroupName {
     /**
      * The ID of the group, which uniquely identifies the group across all Atlassian
@@ -265,7 +313,11 @@ export interface GroupName {
     /** The URL for these group details. */
     self?: string;
 }
-/** Details about an issue. */
+/**
+ * Details about an issue.
+ *
+ * @category Models
+ */
 export interface IssueBean {
     /** Details of changelogs associated with the issue. */
     changelog?: PageOfChangelogs;
@@ -321,6 +373,8 @@ export interface IssueBean {
  * with [Get issue link types](#api-rest-api-3-issueLinkType-get).
  *  *  In the [ issueLinkType](#api-rest-api-3-issueLinkType-post) resource it
  * defines and reports on issue link types.
+ *
+ * @category Models
  */
 export interface IssueLinkType {
     /**
@@ -364,7 +418,11 @@ export interface IssueLinkType {
     /** The URL of the issue link type. Read only. */
     self?: string;
 }
-/** Details about an issue type. */
+/**
+ * Details about an issue type.
+ *
+ * @category Models
+ */
 export interface IssueTypeDetails {
     /** The ID of the issue type's avatar. */
     avatarId?: number;
@@ -387,12 +445,20 @@ export interface IssueTypeDetails {
     /** Whether this issue type is used to create subtasks. */
     subtask?: boolean;
 }
-/** The list of issue type IDs. */
+/**
+ * The list of issue type IDs.
+ *
+ * @category Models
+ */
 export interface IssueTypeIds {
     /** The list of issue type IDs. */
     issueTypeIds: string[];
 }
-/** Details about the mapping between issue types and a workflow. */
+/**
+ * Details about the mapping between issue types and a workflow.
+ *
+ * @category Models
+ */
 export interface IssueTypesWorkflowMapping {
     /** Whether the workflow is the default workflow for the workflow scheme. */
     defaultMapping?: boolean;
@@ -407,7 +473,11 @@ export interface IssueTypesWorkflowMapping {
     /** The name of the workflow. Optional if updating the workflow-issue types mapping. */
     workflow?: string;
 }
-/** Details about the mapping between an issue type and a workflow. */
+/**
+ * Details about the mapping between an issue type and a workflow.
+ *
+ * @category Models
+ */
 export interface IssueTypeWorkflowMapping {
     /**
      * The ID of the issue type. Not required if updating the issue type-workflow
@@ -423,6 +493,7 @@ export interface IssueTypeWorkflowMapping {
     /** The name of the workflow. */
     workflow?: string;
 }
+/** @category Models */
 export interface JsonNode {
     array?: boolean;
     bigDecimal?: boolean;
@@ -467,7 +538,11 @@ export interface JsonNode {
     valueAsText?: string;
     valueNode?: boolean;
 }
-/** The schema of a field. */
+/**
+ * The schema of a field.
+ *
+ * @category Models
+ */
 export interface JsonTypeBean {
     /** If the field is a custom field, the configuration of the field. */
     configuration?: {
@@ -484,7 +559,11 @@ export interface JsonTypeBean {
     /** The data type of the field. */
     type: string;
 }
-/** Details about a notification scheme. */
+/**
+ * Details about a notification scheme.
+ *
+ * @category Models
+ */
 export interface NotificationScheme {
     /** The description of the notification scheme. */
     description?: string;
@@ -505,7 +584,11 @@ export interface NotificationScheme {
     scope?: Scope;
     self?: string;
 }
-/** A page of items. */
+/**
+ * A page of items.
+ *
+ * @category Models
+ */
 export interface PageBeanIssueTypeScreenScheme {
     /** Whether this is the last page. */
     isLast?: boolean;
@@ -522,7 +605,11 @@ export interface PageBeanIssueTypeScreenScheme {
     /** The list of items. */
     values?: IssueTypeScreenScheme[];
 }
-/** A page of items. */
+/**
+ * A page of items.
+ *
+ * @category Models
+ */
 export interface PageBeanProject {
     /** Whether this is the last page. */
     isLast?: boolean;
@@ -539,7 +626,11 @@ export interface PageBeanProject {
     /** The list of items. */
     values?: Project[];
 }
-/** A page of items. */
+/**
+ * A page of items.
+ *
+ * @category Models
+ */
 export interface PageBeanProjectDetails {
     /** Whether this is the last page. */
     isLast?: boolean;
@@ -556,7 +647,11 @@ export interface PageBeanProjectDetails {
     /** The list of items. */
     values?: ProjectDetails[];
 }
-/** A page of items. */
+/**
+ * A page of items.
+ *
+ * @category Models
+ */
 export interface PageBeanUser {
     /** Whether this is the last page. */
     isLast?: boolean;
@@ -577,6 +672,8 @@ export interface PageBeanUser {
  * Details of a user, group, field, or project role that holds a permission. See
  * [Holder object](../api-group-permission-schemes/#holder-object) in *Get all
  * permission schemes* for more information.
+ *
+ * @category Models
  */
 export interface PermissionHolder {
     /**
@@ -597,7 +694,11 @@ export interface PermissionHolder {
      */
     value?: string;
 }
-/** Details of a permission scheme. */
+/**
+ * Details of a permission scheme.
+ *
+ * @category Models
+ */
 export interface PermissionScheme extends Record<string, unknown> {
     /** A description for the permission scheme. */
     description?: string;
@@ -618,7 +719,11 @@ export interface PermissionScheme extends Record<string, unknown> {
     /** The URL of the permission scheme. */
     self?: string;
 }
-/** An issue priority. */
+/**
+ * An issue priority.
+ *
+ * @category Models
+ */
 export interface Priority extends Record<string, unknown> {
     /** The description of the issue priority. */
     description?: string;
@@ -637,7 +742,11 @@ export interface Priority extends Record<string, unknown> {
     /** The color used to indicate the issue priority. */
     statusColor?: string;
 }
-/** Details about a project. */
+/**
+ * Details about a project.
+ *
+ * @category Models
+ */
 export interface Project {
     /** Whether the project is archived. */
     archived?: boolean;
@@ -725,7 +834,11 @@ export interface Project {
      */
     versions?: Version[];
 }
-/** A project category. */
+/**
+ * A project category.
+ *
+ * @category Models
+ */
 export interface ProjectCategory {
     /** The description of the project category. */
     description?: string;
@@ -736,7 +849,11 @@ export interface ProjectCategory {
     /** The URL of the project category. */
     self?: string;
 }
-/** Details about a project component. */
+/**
+ * Details about a project component.
+ *
+ * @category Models
+ */
 export interface ProjectComponent {
     /**
      * Compass component's ID. Can't be updated. Not required for creating a Project
@@ -838,7 +955,11 @@ export interface ProjectComponent {
     /** The URL of the component. */
     self?: string;
 }
-/** Details about a project. */
+/**
+ * Details about a project.
+ *
+ * @category Models
+ */
 export interface ProjectDetails {
     /** The URLs of the project's avatars. */
     avatarUrls?: AvatarUrlsBean;
@@ -861,7 +982,11 @@ export interface ProjectDetails {
     /** Whether or not the project is simplified. */
     simplified?: boolean;
 }
-/** Project ID details. */
+/**
+ * Project ID details.
+ *
+ * @category Models
+ */
 export interface ProjectId {
     /** The ID of the project. */
     id: string;
@@ -869,6 +994,8 @@ export interface ProjectId {
 /**
  * Use the optional `workflows.usages` expand to get additional information about
  * the projects and issue types associated with the requested workflows.
+ *
+ * @category Models
  */
 export interface ProjectIssueTypes {
     /** IDs of the issue types */
@@ -876,7 +1003,11 @@ export interface ProjectIssueTypes {
     /** Project ID details. */
     project?: ProjectId | null;
 }
-/** Details about the roles in a project. */
+/**
+ * Details about the roles in a project.
+ *
+ * @category Models
+ */
 export interface ProjectRole {
     /** The list of users who act in this role. */
     actors?: RoleActor[];
@@ -904,7 +1035,11 @@ export interface ProjectRole {
     /** The translated name of the project role. */
     translatedName?: string;
 }
-/** List of property keys. */
+/**
+ * List of property keys.
+ *
+ * @category Models
+ */
 export interface PropertyKeys {
     /** Property key details. */
     keys?: PropertyKey[];
@@ -912,6 +1047,8 @@ export interface PropertyKeys {
 /**
  * The projects the item is associated with. Indicated for items associated with
  * [next-gen projects](https://confluence.atlassian.com/x/loMyO).
+ *
+ * @category Models
  */
 export interface Scope extends Record<string, unknown> {
     /** The project the item has scope in. */
@@ -919,7 +1056,11 @@ export interface Scope extends Record<string, unknown> {
     /** The type of scope. */
     type?: "PROJECT" | "TEMPLATE";
 }
-/** A screen tab field. */
+/**
+ * A screen tab field.
+ *
+ * @category Models
+ */
 export interface ScreenableField {
     /** The ID of the screen tab field. */
     id?: string;
@@ -929,14 +1070,22 @@ export interface ScreenableField {
      */
     name?: string;
 }
-/** A screen tab. */
+/**
+ * A screen tab.
+ *
+ * @category Models
+ */
 export interface ScreenableTab {
     /** The ID of the screen tab. */
     id?: number;
     /** The name of the screen tab. The maximum length is 255 characters. */
     name: string;
 }
-/** Details of an issue level security item. */
+/**
+ * Details of an issue level security item.
+ *
+ * @category Models
+ */
 export interface SecurityLevel {
     /** The description of the issue level security item. */
     description?: string;
@@ -951,7 +1100,11 @@ export interface SecurityLevel {
     /** The URL of the issue level security item. */
     self?: string;
 }
-/** Details about a security scheme. */
+/**
+ * Details about a security scheme.
+ *
+ * @category Models
+ */
 export interface SecurityScheme {
     /** The ID of the default security level. */
     defaultSecurityLevelId?: number;
@@ -965,7 +1118,11 @@ export interface SecurityScheme {
     /** The URL of the issue security scheme. */
     self?: string;
 }
-/** Details of a share permission for the filter. */
+/**
+ * Details of a share permission for the filter.
+ *
+ * @category Models
+ */
 export interface SharePermission {
     /**
      * The group that the filter is shared with. For a request, specify the `groupId`
@@ -1014,7 +1171,11 @@ export interface SharePermission {
      */
     user?: UserBean;
 }
-/** Details about the operations available in this version. */
+/**
+ * Details about the operations available in this version.
+ *
+ * @category Models
+ */
 export interface SimpleLink {
     href?: string;
     iconClass?: string;
@@ -1024,7 +1185,11 @@ export interface SimpleLink {
     title?: string;
     weight?: number;
 }
-/** A status category. */
+/**
+ * A status category.
+ *
+ * @category Models
+ */
 export interface StatusCategory extends Record<string, unknown> {
     /** The name of the color used to represent the status category. */
     colorName?: string;
@@ -1037,7 +1202,11 @@ export interface StatusCategory extends Record<string, unknown> {
     /** The URL of the status category. */
     self?: string;
 }
-/** A status. */
+/**
+ * A status.
+ *
+ * @category Models
+ */
 export interface StatusDetails extends Record<string, unknown> {
     /** The description of the status. */
     description?: string;
@@ -1054,7 +1223,11 @@ export interface StatusDetails extends Record<string, unknown> {
     /** The category assigned to the status. */
     statusCategory?: StatusCategory;
 }
-/** Details about a task. */
+/**
+ * Details about a task.
+ *
+ * @category Models
+ */
 export interface TaskProgressBeanObject {
     /** The description of the task. */
     description?: string;
@@ -1083,7 +1256,11 @@ export interface TaskProgressBeanObject {
     /** The ID of the user who submitted the task. */
     submittedBy: number;
 }
-/** Details about a task. */
+/**
+ * Details about a task.
+ *
+ * @category Models
+ */
 export interface TaskProgressBeanRemoveOptionFromIssuesResult {
     /** The description of the task. */
     description?: string;
@@ -1112,7 +1289,11 @@ export interface TaskProgressBeanRemoveOptionFromIssuesResult {
     /** The ID of the user who submitted the task. */
     submittedBy: number;
 }
-/** Details of the time tracking configuration. */
+/**
+ * Details of the time tracking configuration.
+ *
+ * @category Models
+ */
 export interface TimeTrackingConfiguration {
     /** The default unit of time applied to logged time. */
     defaultUnit: "minute" | "hour" | "day" | "week";
@@ -1123,7 +1304,11 @@ export interface TimeTrackingConfiguration {
     /** The number of hours in a working day. */
     workingHoursPerDay: number;
 }
-/** A project category. */
+/**
+ * A project category.
+ *
+ * @category Models
+ */
 export interface UpdatedProjectCategory {
     /** The name of the project category. */
     description?: string;
@@ -1146,6 +1331,8 @@ export interface UpdatedProjectCategory {
  * *unknown* and all other parameters have fallback values.
  *  *  User record unavailable: This usually occurs due to an internal service
  * outage. In this case, all parameters have fallback values.
+ *
+ * @category Models
  */
 export interface User {
     /**
@@ -1222,6 +1409,8 @@ export interface User {
  * *unknown* and all other parameters have fallback values.
  *  *  User record unavailable: This usually occurs due to an internal service
  * outage. In this case, all parameters have fallback values.
+ *
+ * @category Models
  */
 export interface UserDetails {
     /**
@@ -1271,7 +1460,11 @@ export interface UserDetails {
      */
     timeZone?: string;
 }
-/** Details about a project version. */
+/**
+ * Details about a project version.
+ *
+ * @category Models
+ */
 export interface Version {
     /**
      * If the expand option `approvers` is used, returns a list containing the
@@ -1376,7 +1569,11 @@ export interface Version {
      */
     userStartDate?: string;
 }
-/** The group or role to which this item is visible. */
+/**
+ * The group or role to which this item is visible.
+ *
+ * @category Models
+ */
 export interface Visibility extends Record<string, unknown> {
     /**
      * The ID of the group or the name of the role that visibility of this item is
@@ -1392,7 +1589,11 @@ export interface Visibility extends Record<string, unknown> {
      */
     value?: string;
 }
-/** Details about a workflow scheme. */
+/**
+ * Details about a workflow scheme.
+ *
+ * @category Models
+ */
 export interface WorkflowScheme {
     /**
      * The name of the default workflow for the workflow scheme. The default workflow
@@ -1470,7 +1671,11 @@ export interface WorkflowScheme {
      */
     updateDraftIfNeeded?: boolean;
 }
-/** The scope of the workflow. */
+/**
+ * The scope of the workflow.
+ *
+ * @category Models
+ */
 export interface WorkflowScope {
     /** Project ID details. */
     project?: ProjectId | null;
@@ -1480,7 +1685,11 @@ export interface WorkflowScope {
      */
     type: "PROJECT" | "GLOBAL";
 }
-/** A workflow with transition rules. */
+/**
+ * A workflow with transition rules.
+ *
+ * @category Models
+ */
 export interface WorkflowTransitionRules {
     /** The list of conditions within the workflow. */
     conditions?: AppWorkflowTransitionRule[];