@resolution/jira-api-client 0.5.4 → 0.5.6

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

@@ -1,7 +1,11 @@
 import { type ZodTypeAny } from "zod";
 import type { CommonValidationSchemaStorage } from "../../core/CommonValidationSchemaStorage";
 import { type DocumentVersion, type ProjectDetails, type ProjectIssueTypes, type Scope, type WorkflowScope } from "./common";
-/** The Connect provided ecosystem rules available. */
+/**
+ * The Connect provided ecosystem rules available.
+ *
+ * @category Models
+ */
 export interface AvailableWorkflowConnectRule {
     /** The add-on providing the rule. */
     addonKey?: string;
@@ -22,7 +26,11 @@ export interface AvailableWorkflowConnectRule {
     /** The URL view path segment defined in the Connect module. */
     viewUrl?: string;
 }
-/** The Forge provided ecosystem rules available. */
+/**
+ * The Forge provided ecosystem rules available.
+ *
+ * @category Models
+ */
 export interface AvailableWorkflowForgeRule {
     /** The rule description. */
     description?: string;
@@ -35,7 +43,11 @@ export interface AvailableWorkflowForgeRule {
     /** The rule type. */
     ruleType?: "Condition" | "Validator" | "Function" | "Screen";
 }
-/** The Atlassian provided system rules available. */
+/**
+ * The Atlassian provided system rules available.
+ *
+ * @category Models
+ */
 export interface AvailableWorkflowSystemRule {
     /** The rule description. */
     description: string;
@@ -52,14 +64,22 @@ export interface AvailableWorkflowSystemRule {
     /** The rule type. */
     ruleType: "Condition" | "Validator" | "Function" | "Screen";
 }
-/** The trigger rules available. */
+/**
+ * The trigger rules available.
+ *
+ * @category Models
+ */
 export interface AvailableWorkflowTriggers {
     /** The list of available trigger types. */
     availableTypes: AvailableWorkflowTriggerTypes[];
     /** The rule key of the rule. */
     ruleKey: string;
 }
-/** The list of available trigger types. */
+/**
+ * The list of available trigger types.
+ *
+ * @category Models
+ */
 export interface AvailableWorkflowTriggerTypes {
     /** The description of the trigger rule. */
     description?: string;
@@ -68,7 +88,11 @@ export interface AvailableWorkflowTriggerTypes {
     /** The type identifier of trigger rule. */
     type?: string;
 }
-/** The conditions group associated with the transition. */
+/**
+ * The conditions group associated with the transition.
+ *
+ * @category Models
+ */
 export interface ConditionGroupConfiguration {
     /** The nested conditions of the condition group. */
     conditionGroups?: (ConditionGroupConfiguration | null)[];
@@ -82,7 +106,11 @@ export interface ConditionGroupConfiguration {
      */
     operation?: "ANY" | "ALL";
 }
-/** The conditions group associated with the transition. */
+/**
+ * The conditions group associated with the transition.
+ *
+ * @category Models
+ */
 export interface ConditionGroupUpdate {
     /** The nested conditions of the condition group. */
     conditionGroups?: (ConditionGroupUpdate | null)[];
@@ -96,7 +124,11 @@ export interface ConditionGroupUpdate {
      */
     operation: "ANY" | "ALL";
 }
-/** A workflow transition condition. */
+/**
+ * A workflow transition condition.
+ *
+ * @category Models
+ */
 export interface CreateWorkflowCondition {
     /** The list of workflow conditions. */
     conditions?: CreateWorkflowCondition[];
@@ -109,7 +141,11 @@ export interface CreateWorkflowCondition {
     /** The type of the transition rule. */
     type?: string;
 }
-/** The details of a workflow. */
+/**
+ * The details of a workflow.
+ *
+ * @category Models
+ */
 export interface CreateWorkflowDetails {
     /** The description of the workflow. The maximum length is 1000 characters. */
     description?: string;
@@ -140,7 +176,11 @@ export interface CreateWorkflowDetails {
      */
     transitions: CreateWorkflowTransitionDetails[];
 }
-/** The details of a transition status. */
+/**
+ * The details of a transition status.
+ *
+ * @category Models
+ */
 export interface CreateWorkflowStatusDetails {
     /** The ID of the status. */
     id: string;
@@ -149,7 +189,11 @@ export interface CreateWorkflowStatusDetails {
         [key: string]: string;
     };
 }
-/** The details of a workflow transition. */
+/**
+ * The details of a workflow transition.
+ *
+ * @category Models
+ */
 export interface CreateWorkflowTransitionDetails {
     /** The description of the transition. The maximum length is 1000 characters. */
     description?: string;
@@ -170,7 +214,11 @@ export interface CreateWorkflowTransitionDetails {
     /** The type of the transition. */
     type: "global" | "initial" | "directed";
 }
-/** A workflow transition rule. */
+/**
+ * A workflow transition rule.
+ *
+ * @category Models
+ */
 export interface CreateWorkflowTransitionRule {
     /** EXPERIMENTAL. The configuration of the transition rule. */
     configuration?: {
@@ -179,7 +227,11 @@ export interface CreateWorkflowTransitionRule {
     /** The type of the transition rule. */
     type: string;
 }
-/** The details of a workflow transition rules. */
+/**
+ * The details of a workflow transition rules.
+ *
+ * @category Models
+ */
 export interface CreateWorkflowTransitionRulesDetails {
     /** The workflow conditions. */
     conditions?: CreateWorkflowCondition;
@@ -255,12 +307,20 @@ export interface CreateWorkflowTransitionRulesDetails {
      */
     validators?: CreateWorkflowTransitionRule[];
 }
-/** The details of a transition screen. */
+/**
+ * The details of a transition screen.
+ *
+ * @category Models
+ */
 export interface CreateWorkflowTransitionScreenDetails {
     /** The ID of the screen. */
     id: string;
 }
-/** Details about a workflow. */
+/**
+ * Details about a workflow.
+ *
+ * @category Models
+ */
 export interface DeprecatedWorkflow {
     default?: boolean;
     /** The description of the workflow. */
@@ -283,7 +343,11 @@ export interface DeprecatedWorkflow {
     /** The number of steps included in the workflow. */
     steps?: number;
 }
-/** Details of a workflow. */
+/**
+ * Details of a workflow.
+ *
+ * @category Models
+ */
 export interface JiraWorkflow {
     /** The description of the workflow. */
     description?: string;
@@ -318,7 +382,11 @@ export interface JiraWorkflow {
     /** The current version details of this workflow scheme. */
     version?: DocumentVersion;
 }
-/** Details of a status. */
+/**
+ * Details of a status.
+ *
+ * @category Models
+ */
 export interface JiraWorkflowStatus {
     /** The description of the status. */
     description?: string;
@@ -339,7 +407,11 @@ export interface JiraWorkflowStatus {
      */
     usages?: ProjectIssueTypes[];
 }
-/** A page of items. */
+/**
+ * A page of items.
+ *
+ * @category Models
+ */
 export interface PageBeanWorkflow {
     /** Whether this is the last page. */
     isLast?: boolean;
@@ -356,21 +428,33 @@ export interface PageBeanWorkflow {
     /** The list of items. */
     values?: Workflow[];
 }
-/** A project and issueType ID pair that identifies a status mapping. */
+/**
+ * A project and issueType ID pair that identifies a status mapping.
+ *
+ * @category Models
+ */
 export interface ProjectAndIssueTypePair {
     /** The ID of the issue type. */
     issueTypeId: string;
     /** The ID of the project. */
     projectId: string;
 }
-/** Properties that identify a published workflow. */
+/**
+ * Properties that identify a published workflow.
+ *
+ * @category Models
+ */
 export interface PublishedWorkflowId {
     /** The entity ID of the workflow. */
     entityId?: string;
     /** The name of the workflow. */
     name: string;
 }
-/** The statuses associated with this workflow. */
+/**
+ * The statuses associated with this workflow.
+ *
+ * @category Models
+ */
 export interface StatusLayoutUpdate extends Record<string, unknown> {
     /** The starting point for the statuses in the workflow. */
     layout?: WorkflowLayout | null;
@@ -381,7 +465,11 @@ export interface StatusLayoutUpdate extends Record<string, unknown> {
     /** A unique ID which the status will use to refer to this layout configuration. */
     statusReference: string;
 }
-/** The mapping of old to new status ID for a specific project and issue type. */
+/**
+ * The mapping of old to new status ID for a specific project and issue type.
+ *
+ * @category Models
+ */
 export interface StatusMappingDto extends Record<string, unknown> {
     /** The issue type for the status mapping. */
     issueTypeId: string;
@@ -393,21 +481,33 @@ export interface StatusMappingDto extends Record<string, unknown> {
      */
     statusMigrations: StatusMigration[];
 }
-/** The mapping of old to new status ID. */
+/**
+ * The mapping of old to new status ID.
+ *
+ * @category Models
+ */
 export interface StatusMigration extends Record<string, unknown> {
     /** The new status ID. */
     newStatusReference: string;
     /** The old status ID. */
     oldStatusReference: string;
 }
-/** The status reference and port that a transition is connected to. */
+/**
+ * The status reference and port that a transition is connected to.
+ *
+ * @category Models
+ */
 export interface StatusReferenceAndPort {
     /** The port this transition uses to connect to this status. */
     port?: number;
     /** The reference of this status. */
     statusReference: string;
 }
-/** Details of a workflow transition. */
+/**
+ * Details of a workflow transition.
+ *
+ * @category Models
+ */
 export interface Transition {
     /** The description of the transition. */
     description: string;
@@ -430,14 +530,22 @@ export interface Transition {
     /** The type of the transition. */
     type: "global" | "initial" | "directed";
 }
-/** The details of a transition screen. */
+/**
+ * The details of a transition screen.
+ *
+ * @category Models
+ */
 export interface TransitionScreenDetails {
     /** The ID of the screen. */
     id: string;
     /** The name of the screen. */
     name?: string;
 }
-/** The transitions of this workflow. */
+/**
+ * The transitions of this workflow.
+ *
+ * @category Models
+ */
 export interface TransitionUpdateDto extends Record<string, unknown> {
     /** The post-functions of the transition. */
     actions?: (WorkflowRuleConfiguration | null)[];
@@ -471,6 +579,8 @@ export interface TransitionUpdateDto extends Record<string, unknown> {
 /**
  * The level of validation to return from the API. If no values are provided, the
  * default would return `WARNING` and `ERROR` level validation results.
+ *
+ * @category Models
  */
 export interface ValidationOptionsForCreate {
     levels?: ("WARNING" | "ERROR")[];
@@ -478,11 +588,17 @@ export interface ValidationOptionsForCreate {
 /**
  * The level of validation to return from the API. If no values are provided, the
  * default would return `WARNING` and `ERROR` level validation results.
+ *
+ * @category Models
  */
 export interface ValidationOptionsForUpdate {
     levels?: ("WARNING" | "ERROR")[];
 }
-/** Details about a workflow. */
+/**
+ * Details about a workflow.
+ *
+ * @category Models
+ */
 export interface Workflow {
     /** The creation date of the workflow. */
     created?: string;
@@ -507,6 +623,7 @@ export interface Workflow {
     /** The last edited date of the workflow. */
     updated?: string;
 }
+/** @category Models */
 export interface WorkflowCapabilities {
     /** The Connect provided ecosystem rules available. */
     connectRules?: AvailableWorkflowConnectRule[];
@@ -527,6 +644,8 @@ export interface WorkflowCapabilities {
 /**
  * A compound workflow transition rule condition. This object returns `nodeType`
  * as `compound`.
+ *
+ * @category Models
  */
 export interface WorkflowCompoundCondition {
     /** The list of workflow conditions. */
@@ -535,9 +654,17 @@ export interface WorkflowCompoundCondition {
     /** The compound condition operator. */
     operator: "AND" | "OR";
 }
-/** The workflow transition rule conditions tree. */
+/**
+ * The workflow transition rule conditions tree.
+ *
+ * @category Models
+ */
 export type WorkflowCondition = WorkflowSimpleCondition | WorkflowCompoundCondition;
-/** The details of the workflows to create. */
+/**
+ * The details of the workflows to create.
+ *
+ * @category Models
+ */
 export interface WorkflowCreate {
     /** The description of the workflow to create. */
     description?: string;
@@ -550,7 +677,11 @@ export interface WorkflowCreate {
     /** The transitions of this workflow. */
     transitions: TransitionUpdateDto[];
 }
-/** The create workflows payload. */
+/**
+ * The create workflows payload.
+ *
+ * @category Models
+ */
 export interface WorkflowCreateRequest {
     /** The scope of the workflow. */
     scope: WorkflowScope;
@@ -559,13 +690,18 @@ export interface WorkflowCreateRequest {
     /** The details of the workflows to create. */
     workflows: WorkflowCreate[];
 }
-/** Details of the created workflows and statuses. */
+/**
+ * Details of the created workflows and statuses.
+ *
+ * @category Models
+ */
 export interface WorkflowCreateResponse {
     /** List of created statuses. */
     statuses?: JiraWorkflowStatus[];
     /** List of created workflows. */
     workflows?: JiraWorkflow[];
 }
+/** @category Models */
 export interface WorkflowCreateValidateRequest {
     /** The create workflows payload. */
     payload: WorkflowCreateRequest;
@@ -578,6 +714,8 @@ export interface WorkflowCreateValidateRequest {
 /**
  * A reference to the location of the error. This will be null if the error does
  * not refer to a specific element.
+ *
+ * @category Models
  */
 export interface WorkflowElementReference {
     /** A property key. */
@@ -591,27 +729,40 @@ export interface WorkflowElementReference {
     /** A transition ID. */
     transitionId?: string;
 }
-/** The classic workflow identifiers. */
+/**
+ * The classic workflow identifiers.
+ *
+ * @category Models
+ */
 export interface WorkflowIds {
     /** The entity ID of the workflow. */
     entityId?: string;
     /** The name of the workflow. */
     name: string;
 }
-/** The starting point for the statuses in the workflow. */
+/**
+ * The starting point for the statuses in the workflow.
+ *
+ * @category Models
+ */
 export interface WorkflowLayout {
     /** The x axis location. */
     x?: number;
     /** The y axis location. */
     y?: number;
 }
-/** Operations allowed on a workflow */
+/**
+ * Operations allowed on a workflow
+ *
+ * @category Models
+ */
 export interface WorkflowOperations {
     /** Whether the workflow can be deleted. */
     canDelete: boolean;
     /** Whether the workflow can be updated. */
     canEdit: boolean;
 }
+/** @category Models */
 export interface WorkflowReadRequest {
     /** The list of projects and issue types to query. */
     projectAndIssueTypes?: ProjectAndIssueTypePair[];
@@ -620,14 +771,22 @@ export interface WorkflowReadRequest {
     /** The list of workflow names to query. */
     workflowNames?: string[];
 }
-/** Details of workflows and related statuses. */
+/**
+ * Details of workflows and related statuses.
+ *
+ * @category Models
+ */
 export interface WorkflowReadResponse {
     /** List of statuses. */
     statuses?: JiraWorkflowStatus[];
     /** List of workflows. */
     workflows?: JiraWorkflow[];
 }
-/** The statuses referenced in the workflow. */
+/**
+ * The statuses referenced in the workflow.
+ *
+ * @category Models
+ */
 export interface WorkflowReferenceStatus {
     /** Indicates if the status is deprecated. */
     deprecated?: boolean;
@@ -640,7 +799,11 @@ export interface WorkflowReferenceStatus {
     /** The reference of the status. */
     statusReference?: string;
 }
-/** The configuration of the rule. */
+/**
+ * The configuration of the rule.
+ *
+ * @category Models
+ */
 export interface WorkflowRuleConfiguration {
     /** The ID of the rule. */
     id?: string | null;
@@ -651,7 +814,11 @@ export interface WorkflowRuleConfiguration {
     /** The rule key of the rule. */
     ruleKey: string;
 }
-/** A collection of transition rules. */
+/**
+ * A collection of transition rules.
+ *
+ * @category Models
+ */
 export interface WorkflowRules {
     /** The workflow transition rule conditions tree. */
     conditionsTree?: WorkflowCondition;
@@ -660,7 +827,11 @@ export interface WorkflowRules {
     /** The workflow validators. */
     validators?: WorkflowTransitionRule[];
 }
-/** The ID and the name of the workflow scheme. */
+/**
+ * The ID and the name of the workflow scheme.
+ *
+ * @category Models
+ */
 export interface WorkflowSchemeIdName {
     /** The ID of the workflow scheme. */
     id: string;
@@ -670,6 +841,8 @@ export interface WorkflowSchemeIdName {
 /**
  * A workflow transition rule condition. This object returns `nodeType` as
  * `simple`.
+ *
+ * @category Models
  */
 export interface WorkflowSimpleCondition {
     /** EXPERIMENTAL. The configuration of the transition rule. */
@@ -680,7 +853,11 @@ export interface WorkflowSimpleCondition {
     /** The type of the transition rule. */
     type: string;
 }
-/** Details of a workflow status. */
+/**
+ * Details of a workflow status.
+ *
+ * @category Models
+ */
 export interface WorkflowStatus {
     /** The ID of the issue status. */
     id: string;
@@ -705,6 +882,7 @@ export interface WorkflowStatus {
  * The status reference and port that a transition is connected to.
  *
  * @deprecated
+ * @category Models
  */
 export interface WorkflowStatusAndPort {
     /** The port the transition is connected to this status. */
@@ -712,14 +890,22 @@ export interface WorkflowStatusAndPort {
     /** The reference of this status. */
     statusReference?: string;
 }
-/** The x and y location of the status in the workflow. */
+/**
+ * The x and y location of the status in the workflow.
+ *
+ * @category Models
+ */
 export interface WorkflowStatusLayout {
     /** The x axis location. */
     x?: number | null;
     /** The y axis location. */
     y?: number | null;
 }
-/** Details of the status being updated. */
+/**
+ * Details of the status being updated.
+ *
+ * @category Models
+ */
 export interface WorkflowStatusUpdate extends Record<string, unknown> {
     /** The description of the status. */
     description?: string;
@@ -735,6 +921,8 @@ export interface WorkflowStatusUpdate extends Record<string, unknown> {
 /**
  * The statuses the transition can start from, and the mapping of ports between
  * the statuses.
+ *
+ * @category Models
  */
 export interface WorkflowTransitionLinks {
     /** The port that the transition starts from. */
@@ -744,7 +932,11 @@ export interface WorkflowTransitionLinks {
     /** The port that the transition goes to. */
     toPort?: number | null;
 }
-/** A workflow transition rule. */
+/**
+ * A workflow transition rule.
+ *
+ * @category Models
+ */
 export interface WorkflowTransitionRule {
     /** EXPERIMENTAL. The configuration of the transition rule. */
     configuration?: unknown;
@@ -755,6 +947,8 @@ export interface WorkflowTransitionRule {
  * The transitions of the workflow. Note that a transition can have either the
  * deprecated `to`/`from` fields or the `toStatusReference`/`links` fields, but
  * never both nor a combination.
+ *
+ * @category Models
  */
 export interface WorkflowTransitions {
     /** The post-functions of the transition. */
@@ -802,7 +996,11 @@ export interface WorkflowTransitions {
     /** The validators of the transition. */
     validators?: (WorkflowRuleConfiguration | null)[];
 }
-/** The trigger configuration associated with a workflow. */
+/**
+ * The trigger configuration associated with a workflow.
+ *
+ * @category Models
+ */
 export interface WorkflowTrigger {
     /** The ID of the trigger. */
     id?: string;
@@ -813,7 +1011,11 @@ export interface WorkflowTrigger {
     /** The rule key of the trigger. */
     ruleKey: string;
 }
-/** The details of the workflows to update. */
+/**
+ * The details of the workflows to update.
+ *
+ * @category Models
+ */
 export interface WorkflowUpdate extends Record<string, unknown> {
     /** The mapping of old to new status ID. */
     defaultStatusMappings?: StatusMigration[];
@@ -832,13 +1034,18 @@ export interface WorkflowUpdate extends Record<string, unknown> {
     /** The current version details of this workflow scheme. */
     version: DocumentVersion;
 }
-/** The update workflows payload. */
+/**
+ * The update workflows payload.
+ *
+ * @category Models
+ */
 export interface WorkflowUpdateRequest {
     /** The statuses to associate with the workflows. */
     statuses: WorkflowStatusUpdate[];
     /** The details of the workflows to update. */
     workflows: WorkflowUpdate[];
 }
+/** @category Models */
 export interface WorkflowUpdateResponse {
     /** List of updated statuses. */
     statuses?: JiraWorkflowStatus[];
@@ -850,6 +1057,7 @@ export interface WorkflowUpdateResponse {
     /** List of updated workflows. */
     workflows?: JiraWorkflow[];
 }
+/** @category Models */
 export interface WorkflowUpdateValidateRequestBean {
     /** The update workflows payload. */
     payload: WorkflowUpdateRequest;
@@ -859,7 +1067,11 @@ export interface WorkflowUpdateValidateRequestBean {
      */
     validationOptions?: ValidationOptionsForUpdate;
 }
-/** The details about a workflow validation error. */
+/**
+ * The details about a workflow validation error.
+ *
+ * @category Models
+ */
 export interface WorkflowValidationError {
     /** An error code. */
     code?: string;
@@ -875,6 +1087,7 @@ export interface WorkflowValidationError {
     /** The type of element the error or warning references. */
     type?: "RULE" | "STATUS" | "STATUS_LAYOUT" | "STATUS_PROPERTY" | "WORKFLOW" | "TRANSITION" | "TRANSITION_PROPERTY" | "SCOPE" | "STATUS_MAPPING" | "TRIGGER";
 }
+/** @category Models */
 export interface WorkflowValidationErrorList {
     /** The list of validation errors. */
     errors?: WorkflowValidationError[];