@resolution/jira-api-client 0.1.0

package/lib/openapi/software/models/board.d.ts

@@ -0,0 +1,505 @@
+import { type ZodTypeAny } from "zod";
+import type { CommonValidationSchemaStorage } from "../core/common-validation-schema-storage";
+/** Details about an issue. */
+export interface IssueBean {
+    /** Details of changelogs associated with the issue. */
+    changelog?: {
+        /** The list of changelogs. */
+        histories?: {
+            /** The user who made the change. */
+            author?: {
+                /**
+                 * The account ID of the user, which uniquely identifies the user across all
+                 * Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.
+                 */
+                accountId?: string;
+                /**
+                 * The type of account represented by this user. This will be one of 'atlassian'
+                 * (normal users), 'app' (application user) or 'customer' (Jira Service Desk
+                 * customer user)
+                 */
+                accountType?: string;
+                /** Whether the user is active. */
+                active?: boolean;
+                /** The avatars of the user. */
+                avatarUrls?: {
+                    /** The URL of the item's 16x16 pixel avatar. */
+                    "16x16"?: string;
+                    /** The URL of the item's 24x24 pixel avatar. */
+                    "24x24"?: string;
+                    /** The URL of the item's 32x32 pixel avatar. */
+                    "32x32"?: string;
+                    /** The URL of the item's 48x48 pixel avatar. */
+                    "48x48"?: string;
+                };
+                /**
+                 * The display name of the user. Depending on the user’s privacy settings, this
+                 * may return an alternative value.
+                 */
+                displayName?: string;
+                /**
+                 * The email address of the user. Depending on the user’s privacy settings, this
+                 * may be returned as null.
+                 */
+                emailAddress?: string;
+                /**
+                 * This property is no longer available and will be removed from the documentation
+                 * soon. See the [deprecation
+                 * notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/)
+                 * for details.
+                 */
+                key?: string;
+                /**
+                 * This property is no longer available and will be removed from the documentation
+                 * soon. See the [deprecation
+                 * notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/)
+                 * for details.
+                 */
+                name?: string;
+                /** The URL of the user. */
+                self?: string;
+                /**
+                 * The time zone specified in the user's profile. Depending on the user’s privacy
+                 * settings, this may be returned as null.
+                 */
+                timeZone?: string;
+            };
+            /** The date on which the change took place. */
+            created?: string;
+            /** The history metadata associated with the changed. */
+            historyMetadata?: {
+                /** The activity described in the history record. */
+                activityDescription?: string;
+                /** The key of the activity described in the history record. */
+                activityDescriptionKey?: string;
+                /** Details of the user whose action created the history record. */
+                actor?: {
+                    /** The URL to an avatar for the user or system associated with a history record. */
+                    avatarUrl?: string;
+                    /** The display name of the user or system associated with a history record. */
+                    displayName?: string;
+                    /**
+                     * The key of the display name of the user or system associated with a history
+                     * record.
+                     */
+                    displayNameKey?: string;
+                    /** The ID of the user or system associated with a history record. */
+                    id?: string;
+                    /** The type of the user or system associated with a history record. */
+                    type?: string;
+                    /** The URL of the user or system associated with a history record. */
+                    url?: string;
+                } & {
+                    [key: string]: unknown;
+                };
+                /** Details of the cause that triggered the creation the history record. */
+                cause?: {
+                    /** The URL to an avatar for the user or system associated with a history record. */
+                    avatarUrl?: string;
+                    /** The display name of the user or system associated with a history record. */
+                    displayName?: string;
+                    /**
+                     * The key of the display name of the user or system associated with a history
+                     * record.
+                     */
+                    displayNameKey?: string;
+                    /** The ID of the user or system associated with a history record. */
+                    id?: string;
+                    /** The type of the user or system associated with a history record. */
+                    type?: string;
+                    /** The URL of the user or system associated with a history record. */
+                    url?: string;
+                } & {
+                    [key: string]: unknown;
+                };
+                /** The description of the history record. */
+                description?: string;
+                /** The description key of the history record. */
+                descriptionKey?: string;
+                /** The description of the email address associated the history record. */
+                emailDescription?: string;
+                /** The description key of the email address associated the history record. */
+                emailDescriptionKey?: string;
+                /** Additional arbitrary information about the history record. */
+                extraData?: {
+                    [key: string]: string;
+                };
+                /** Details of the system that generated the history record. */
+                generator?: {
+                    /** The URL to an avatar for the user or system associated with a history record. */
+                    avatarUrl?: string;
+                    /** The display name of the user or system associated with a history record. */
+                    displayName?: string;
+                    /**
+                     * The key of the display name of the user or system associated with a history
+                     * record.
+                     */
+                    displayNameKey?: string;
+                    /** The ID of the user or system associated with a history record. */
+                    id?: string;
+                    /** The type of the user or system associated with a history record. */
+                    type?: string;
+                    /** The URL of the user or system associated with a history record. */
+                    url?: string;
+                } & {
+                    [key: string]: unknown;
+                };
+                /** The type of the history record. */
+                type?: string;
+            } & {
+                [key: string]: unknown;
+            };
+            /** The ID of the changelog. */
+            id?: string;
+            /** The list of items changed. */
+            items?: {
+                /** The name of the field changed. */
+                field?: string;
+                /** The ID of the field changed. */
+                fieldId?: string;
+                /** The type of the field changed. */
+                fieldtype?: string;
+                /** The details of the original value. */
+                from?: string;
+                /** The details of the original value as a string. */
+                fromString?: string;
+                /** The details of the new value. */
+                to?: string;
+                /** The details of the new value as a string. */
+                toString: string;
+            }[];
+        }[];
+        /** The maximum number of results that could be on the page. */
+        maxResults?: number;
+        /** The index of the first item returned on the page. */
+        startAt?: number;
+        /** The number of results on the page. */
+        total?: number;
+    };
+    /** The metadata for the fields on the issue that can be amended. */
+    editmeta?: {
+        fields?: {
+            /** The metadata describing an issue field. */
+            [key: string]: {
+                /** The list of values allowed in the field. */
+                allowedValues?: unknown[];
+                /** The URL that can be used to automatically complete the field. */
+                autoCompleteUrl?: string;
+                /** The configuration properties. */
+                configuration?: {
+                    [key: string]: unknown;
+                };
+                /** The default value of the field. */
+                defaultValue?: unknown;
+                /** Whether the field has a default value. */
+                hasDefaultValue?: boolean;
+                /** The key of the field. */
+                key: string;
+                /** The name of the field. */
+                name: string;
+                /** The list of operations that can be performed on the field. */
+                operations: string[];
+                /** Whether the field is required. */
+                required: boolean;
+                /** The data type of the field. */
+                schema: {
+                    /** If the field is a custom field, the configuration of the field. */
+                    configuration?: {
+                        [key: string]: unknown;
+                    };
+                    /** If the field is a custom field, the URI of the field. */
+                    custom?: string;
+                    /** If the field is a custom field, the custom ID of the field. */
+                    customId?: number;
+                    /** When the data type is an array, the name of the field items within the array. */
+                    items?: string;
+                    /** If the field is a system field, the name of the field. */
+                    system?: string;
+                    /** The data type of the field. */
+                    type: string;
+                };
+            };
+        };
+    } & {
+        [key: string]: unknown;
+    };
+    /** Expand options that include additional issue details in the response. */
+    expand?: string;
+    fields?: {
+        [key: string]: unknown;
+    };
+    fieldsToInclude?: {
+        actuallyIncluded?: string[];
+        excluded?: string[];
+        included?: string[];
+    };
+    /** The ID of the issue. */
+    id?: string;
+    /** The key of the issue. */
+    key?: string;
+    /** The ID and name of each field present on the issue. */
+    names?: {
+        [key: string]: string;
+    };
+    /** The operations that can be performed on the issue. */
+    operations?: Operations;
+    /** Details of the issue properties identified in the request. */
+    properties?: {
+        [key: string]: unknown;
+    };
+    /** The rendered value of each field present on the issue. */
+    renderedFields?: {
+        [key: string]: unknown;
+    };
+    /** The schema describing each field present on the issue. */
+    schema?: {
+        /** The schema of a field. */
+        [key: string]: {
+            /** If the field is a custom field, the configuration of the field. */
+            configuration?: {
+                [key: string]: unknown;
+            };
+            /** If the field is a custom field, the URI of the field. */
+            custom?: string;
+            /** If the field is a custom field, the custom ID of the field. */
+            customId?: number;
+            /** When the data type is an array, the name of the field items within the array. */
+            items?: string;
+            /** If the field is a system field, the name of the field. */
+            system?: string;
+            /** The data type of the field. */
+            type: string;
+        };
+    };
+    /** The URL of the issue details. */
+    self?: string;
+    /** The transitions that can be performed on the issue. */
+    transitions?: ({
+        /** Expand options that include additional transition details in the response. */
+        expand?: string;
+        /**
+         * Details of the fields associated with the issue transition screen. Use this
+         * information to populate `fields` and `update` in a transition request.
+         */
+        fields?: {
+            /** The metadata describing an issue field. */
+            [key: string]: {
+                /** The list of values allowed in the field. */
+                allowedValues?: unknown[];
+                /** The URL that can be used to automatically complete the field. */
+                autoCompleteUrl?: string;
+                /** The configuration properties. */
+                configuration?: {
+                    [key: string]: unknown;
+                };
+                /** The default value of the field. */
+                defaultValue?: unknown;
+                /** Whether the field has a default value. */
+                hasDefaultValue?: boolean;
+                /** The key of the field. */
+                key: string;
+                /** The name of the field. */
+                name: string;
+                /** The list of operations that can be performed on the field. */
+                operations: string[];
+                /** Whether the field is required. */
+                required: boolean;
+                /** The data type of the field. */
+                schema: {
+                    /** If the field is a custom field, the configuration of the field. */
+                    configuration?: {
+                        [key: string]: unknown;
+                    };
+                    /** If the field is a custom field, the URI of the field. */
+                    custom?: string;
+                    /** If the field is a custom field, the custom ID of the field. */
+                    customId?: number;
+                    /** When the data type is an array, the name of the field items within the array. */
+                    items?: string;
+                    /** If the field is a system field, the name of the field. */
+                    system?: string;
+                    /** The data type of the field. */
+                    type: string;
+                };
+            };
+        };
+        /** Whether there is a screen associated with the issue transition. */
+        hasScreen?: boolean;
+        /**
+         * The ID of the issue transition. Required when specifying a transition to
+         * undertake.
+         */
+        id?: string;
+        /** Whether the transition is available to be performed. */
+        isAvailable?: boolean;
+        /** Whether the issue has to meet criteria before the issue transition is applied. */
+        isConditional?: boolean;
+        /**
+         * Whether the issue transition is global, that is, the transition is applied to
+         * issues regardless of their status.
+         */
+        isGlobal?: boolean;
+        /** Whether this is the initial issue transition for the workflow. */
+        isInitial?: boolean;
+        looped?: boolean;
+        /** The name of the issue transition. */
+        name?: string;
+        /** Details of the issue status after the transition. */
+        to?: {
+            /** The description of the status. */
+            description?: string;
+            /** The URL of the icon used to represent the status. */
+            iconUrl?: string;
+            /** The ID of the status. */
+            id?: string;
+            /** The name of the status. */
+            name?: string;
+            /** The scope of the field. */
+            scope?: {
+                /** The project the item has scope in. */
+                project?: {
+                    /** The URLs of the project's avatars. */
+                    avatarUrls?: {
+                        /** The URL of the item's 16x16 pixel avatar. */
+                        "16x16"?: string;
+                        /** The URL of the item's 24x24 pixel avatar. */
+                        "24x24"?: string;
+                        /** The URL of the item's 32x32 pixel avatar. */
+                        "32x32"?: string;
+                        /** The URL of the item's 48x48 pixel avatar. */
+                        "48x48"?: string;
+                    };
+                    /** The ID of the project. */
+                    id?: string;
+                    /** The key of the project. */
+                    key?: string;
+                    /** The name of the project. */
+                    name?: string;
+                    /** The category the project belongs to. */
+                    projectCategory?: {
+                        /** The name of the project category. */
+                        description?: string;
+                        /** The ID of the project category. */
+                        id?: string;
+                        /** The description of the project category. */
+                        name?: string;
+                        /** The URL of the project category. */
+                        self?: string;
+                    };
+                    /**
+                     * The [project
+                     * type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes)
+                     * of the project.
+                     */
+                    projectTypeKey?: "software" | "service_desk" | "business";
+                    /** The URL of the project details. */
+                    self?: string;
+                    /** Whether or not the project is simplified. */
+                    simplified?: boolean;
+                };
+                /** The type of scope. */
+                type?: "PROJECT" | "TEMPLATE";
+            } & {
+                [key: string]: unknown;
+            };
+            /** The URL of the status. */
+            self?: string;
+            /** The category assigned to the status. */
+            statusCategory?: {
+                /** The name of the color used to represent the status category. */
+                colorName?: string;
+                /** The ID of the status category. */
+                id?: number;
+                /** The key of the status category. */
+                key?: string;
+                /** The name of the status category. */
+                name?: string;
+                /** The URL of the status category. */
+                self?: string;
+            } & {
+                [key: string]: unknown;
+            };
+        } & {
+            [key: string]: unknown;
+        };
+    } & {
+        [key: string]: unknown;
+    })[];
+    /** The versions of each field on the issue. */
+    versionedRepresentations?: {
+        [key: string]: {
+            [key: string]: unknown;
+        };
+    };
+}
+/** Details a link group, which defines issue operations. */
+export interface LinkGroup {
+    groups?: LinkGroup[];
+    /** Details about the operations available in this version. */
+    header?: {
+        href?: string;
+        iconClass?: string;
+        id?: string;
+        label?: string;
+        styleClass?: string;
+        title?: string;
+        weight?: number;
+    };
+    id?: string;
+    links?: {
+        href?: string;
+        iconClass?: string;
+        id?: string;
+        label?: string;
+        styleClass?: string;
+        title?: string;
+        weight?: number;
+    }[];
+    styleClass?: string;
+    weight?: number;
+}
+/** Details of the operations that can be performed on the issue. */
+export interface Operations extends Record<string, unknown> {
+    /** Details of the link groups defining issue operations. */
+    linkGroups?: LinkGroup[];
+}
+/** The result of a JQL search. */
+export interface SearchResults {
+    /** Expand options that include additional search result details in the response. */
+    expand?: string;
+    /** The list of issues found by the search. */
+    issues?: IssueBean[];
+    /** The maximum number of results that could be on the page. */
+    maxResults?: number;
+    /** The ID and name of each field in the search results. */
+    names?: {
+        [key: string]: string;
+    };
+    /** The schema describing the field types in the search results. */
+    schema?: {
+        /** The schema of a field. */
+        [key: string]: {
+            /** If the field is a custom field, the configuration of the field. */
+            configuration?: {
+                [key: string]: unknown;
+            };
+            /** If the field is a custom field, the URI of the field. */
+            custom?: string;
+            /** If the field is a custom field, the custom ID of the field. */
+            customId?: number;
+            /** When the data type is an array, the name of the field items within the array. */
+            items?: string;
+            /** If the field is a system field, the name of the field. */
+            system?: string;
+            /** The data type of the field. */
+            type: string;
+        };
+    };
+    /** The index of the first item returned on the page. */
+    startAt?: number;
+    /** The number of results on the page. */
+    total?: number;
+    /** Any warnings related to the JQL query. */
+    warningMessages?: string[];
+}
+export declare function registerBoardValidationSchemas(validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>): void;