@resolution/jira-api-client 0.1.0

package/src/openapi/platform/models/priority-schemes.ts

@@ -0,0 +1,527 @@
+// DO NOT EDIT!
+// This file is generated by "api-typescript-generator".
+// To update this file run "yarn build:openapi".
+import { z, type ZodTypeAny } from "zod";
+
+import type { CommonValidationSchemaStorage } from "../core/common-validation-schema-storage";
+import {
+  type JsonNode,
+  type PageBeanProjectDetails,
+  registerCommonValidationSchemas,
+} from "./common";
+/** Details of a new priority scheme */
+export interface CreatePrioritySchemeDetails {
+  /** The ID of the default priority for the priority scheme. */
+  defaultPriorityId: number;
+  /** The description of the priority scheme. */
+  description?: string;
+  /**
+   * Mappings of issue priorities for issues being migrated in and out of this
+   * priority scheme.
+   */
+  mappings?: PriorityMapping;
+  /** The name of the priority scheme. Must be unique. */
+  name: string;
+  /** The IDs of priorities in the scheme. */
+  priorityIds: number[];
+  /** The IDs of projects that will use the priority scheme. */
+  projectIds?: number[];
+}
+/** A page of items. */
+export interface PageBeanPrioritySchemeWithPaginatedPrioritiesAndProjects {
+  /** Whether this is the last page. */
+  isLast?: boolean;
+  /** The maximum number of items that could be returned. */
+  maxResults?: number;
+  /** If there is another page of results, the URL of the next page. */
+  nextPage?: string;
+  /** The URL of the page. */
+  self?: string;
+  /** The index of the first item returned. */
+  startAt?: number;
+  /** The number of items returned. */
+  total?: number;
+  /** The list of items. */
+  values?: PrioritySchemeWithPaginatedPrioritiesAndProjects[];
+}
+/** A page of items. */
+export interface PageBeanPriorityWithSequence {
+  /** Whether this is the last page. */
+  isLast?: boolean;
+  /** The maximum number of items that could be returned. */
+  maxResults?: number;
+  /** If there is another page of results, the URL of the next page. */
+  nextPage?: string;
+  /** The URL of the page. */
+  self?: string;
+  /** The index of the first item returned. */
+  startAt?: number;
+  /** The number of items returned. */
+  total?: number;
+  /** The list of items. */
+  values?: PriorityWithSequence[];
+}
+/** Mapping of issue priorities for changes in priority schemes. */
+export interface PriorityMapping {
+  /**
+   * The mapping of priorities for issues being migrated **into** this priority
+   * scheme. Key is the old priority ID, value is the new priority ID (must exist in
+   * this priority scheme).
+   */
+  in?: {
+    [key: string]: number;
+  };
+  /**
+   * The mapping of priorities for issues being migrated **out of** this priority
+   * scheme. Key is the old priority ID (must exist in this priority scheme), value
+   * is the new priority ID (must exist in the default priority scheme). Required
+   * for updating an existing priority scheme. Not used when creating a new priority
+   * scheme.
+   */
+  out?: {
+    [key: string]: number;
+  };
+}
+/** Priorities to remove from a scheme */
+export interface PrioritySchemeChangesWithMappings {
+  /** Affected entity ids. */
+  ids: number[];
+  /** Instructions to migrate issues. */
+  mappings?: PriorityMapping[];
+}
+/** Priorities to add to a scheme */
+export interface PrioritySchemeChangesWithoutMappings {
+  /** Affected entity ids. */
+  ids: number[];
+}
+/** The ID of a priority scheme. */
+export interface PrioritySchemeId {
+  /** The ID of the priority scheme. */
+  id?: string;
+  /** The in-progress issue migration task. */
+  task?: TaskProgressBeanJsonNode;
+}
+/** A priority scheme with paginated priorities and projects. */
+export interface PrioritySchemeWithPaginatedPrioritiesAndProjects
+  extends Record<string, unknown> {
+  default?: boolean;
+  /** The ID of the default issue priority. */
+  defaultPriorityId?: string;
+  /** The description of the priority scheme */
+  description?: string;
+  /** The ID of the priority scheme. */
+  id: string;
+  isDefault?: boolean;
+  /** The name of the priority scheme */
+  name: string;
+  /** The paginated list of priorities. */
+  priorities?: PageBeanPriorityWithSequence;
+  /** The paginated list of projects. */
+  projects?: PageBeanProjectDetails;
+  /** The URL of the priority scheme. */
+  self?: string;
+}
+/** An issue priority with sequence information. */
+export interface PriorityWithSequence {
+  /** The description of the issue priority. */
+  description?: string;
+  /** The URL of the icon for the issue priority. */
+  iconUrl?: string;
+  /** The ID of the issue priority. */
+  id?: string;
+  /** Whether this priority is the default. */
+  isDefault?: boolean;
+  /** The name of the issue priority. */
+  name?: string;
+  /** The URL of the issue priority. */
+  self?: string;
+  /** The sequence of the issue priority. */
+  sequence?: string;
+  /** The color used to indicate the issue priority. */
+  statusColor?: string;
+}
+/**
+ * Details of changes to a priority scheme's priorities that require suggested
+ * priority mappings.
+ */
+export interface SuggestedMappingsForPrioritiesRequestBean {
+  /** The ids of priorities being removed from the scheme. */
+  add?: number[];
+  /** The ids of priorities being removed from the scheme. */
+  remove?: number[];
+}
+/**
+ * Details of changes to a priority scheme's projects that require suggested
+ * priority mappings.
+ */
+export interface SuggestedMappingsForProjectsRequestBean {
+  /** The ids of projects being added to the scheme. */
+  add?: number[];
+}
+/**
+ * Details of changes to a priority scheme that require suggested priority
+ * mappings.
+ */
+export interface SuggestedMappingsRequestBean {
+  /** The maximum number of results that could be on the page. */
+  maxResults?: number;
+  /** The priority changes in the scheme. */
+  priorities?: SuggestedMappingsForPrioritiesRequestBean;
+  /** The project changes in the scheme. */
+  projects?: SuggestedMappingsForProjectsRequestBean;
+  /** The id of the priority scheme. */
+  schemeId?: number;
+  /** The index of the first item returned on the page. */
+  startAt?: number;
+}
+/** Details about a task. */
+export interface TaskProgressBeanJsonNode {
+  /** The description of the task. */
+  description?: string;
+  /** The execution time of the task, in milliseconds. */
+  elapsedRuntime: number;
+  /** A timestamp recording when the task was finished. */
+  finished?: number;
+  /** The ID of the task. */
+  id: string;
+  /** A timestamp recording when the task progress was last updated. */
+  lastUpdate: number;
+  /** Information about the progress of the task. */
+  message?: string;
+  /** The progress of the task, as a percentage complete. */
+  progress: number;
+  /** The result of the task execution. */
+  result?: JsonNode;
+  /** The URL of the task. */
+  self: string;
+  /** A timestamp recording when the task was started. */
+  started?: number;
+  /** The status of the task. */
+  status:
+    | "ENQUEUED"
+    | "RUNNING"
+    | "COMPLETE"
+    | "FAILED"
+    | "CANCEL_REQUESTED"
+    | "CANCELLED"
+    | "DEAD";
+  /** A timestamp recording when the task was submitted. */
+  submitted: number;
+  /** The ID of the user who submitted the task. */
+  submittedBy: number;
+}
+/** Update priorities in a scheme */
+export interface UpdatePrioritiesInSchemeRequestBean
+  extends Record<string, unknown> {
+  /** Priorities to add to a scheme */
+  add?: PrioritySchemeChangesWithoutMappings;
+  /** Priorities to remove from a scheme */
+  remove?: PrioritySchemeChangesWithMappings;
+}
+/** Details of a priority scheme. */
+export interface UpdatePrioritySchemeRequestBean {
+  /** The default priority of the scheme. */
+  defaultPriorityId?: number;
+  /** The description of the priority scheme. */
+  description?: string;
+  /** Instructions to migrate issues. */
+  mappings?: PriorityMapping;
+  /** The name of the priority scheme. Must be unique. */
+  name?: string;
+  /** The priorities in the scheme. */
+  priorities?: UpdatePrioritiesInSchemeRequestBean;
+  /** The projects in the scheme. */
+  projects?: UpdateProjectsInSchemeRequestBean;
+}
+/** Details of the updated priority scheme. */
+export interface UpdatePrioritySchemeResponseBean
+  extends Record<string, unknown> {
+  /** A priority scheme with paginated priorities and projects. */
+  priorityScheme?: PrioritySchemeWithPaginatedPrioritiesAndProjects;
+  /** The in-progress issue migration task. */
+  task?: TaskProgressBeanJsonNode;
+}
+/** Update projects in a scheme */
+export interface UpdateProjectsInSchemeRequestBean
+  extends Record<string, unknown> {
+  /** Projects to add to a scheme */
+  add?: PrioritySchemeChangesWithoutMappings;
+  /** Projects to remove from a scheme */
+  remove?: PrioritySchemeChangesWithoutMappings;
+}
+export function registerPrioritySchemesValidationSchemas(
+  validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>,
+) {
+  validationSchemaStorage.register(
+    "CreatePrioritySchemeDetails",
+    z
+      .object({
+        defaultPriorityId: z.number().int(),
+        description: z.string().max(4000).optional(),
+        mappings: validationSchemaStorage.lazy("PriorityMapping").optional(),
+        name: z.string().max(255),
+        priorityIds: z.array(z.number().int()),
+        projectIds: z
+          .array(z.number().int())
+          .superRefine((items, ctx) => {
+            if (
+              new Set(items.map((item) => JSON.stringify(item))).size !==
+              items.length
+            ) {
+              ctx.addIssue({
+                code: z.ZodIssueCode.custom,
+                path: [],
+                message: "Array items must be unique",
+              });
+            }
+          })
+          .optional(),
+      })
+      .strict()
+      .describe("CreatePrioritySchemeDetails"),
+  );
+  validationSchemaStorage.register(
+    "PageBeanPrioritySchemeWithPaginatedPrioritiesAndProjects",
+    z
+      .object({
+        isLast: z.boolean().optional(),
+        maxResults: z.number().int().optional(),
+        nextPage: z.string().optional(),
+        self: z.string().optional(),
+        startAt: z.number().int().optional(),
+        total: z.number().int().optional(),
+        values: z
+          .array(
+            validationSchemaStorage.lazy(
+              "PrioritySchemeWithPaginatedPrioritiesAndProjects",
+            ),
+          )
+          .optional(),
+      })
+      .strict()
+      .describe("PageBeanPrioritySchemeWithPaginatedPrioritiesAndProjects"),
+  );
+  validationSchemaStorage.register(
+    "PageBeanPriorityWithSequence",
+    z
+      .object({
+        isLast: z.boolean().optional(),
+        maxResults: z.number().int().optional(),
+        nextPage: z.string().optional(),
+        self: z.string().optional(),
+        startAt: z.number().int().optional(),
+        total: z.number().int().optional(),
+        values: z
+          .array(validationSchemaStorage.lazy("PriorityWithSequence"))
+          .optional(),
+      })
+      .strict()
+      .describe("PageBeanPriorityWithSequence"),
+  );
+  validationSchemaStorage.register(
+    "PriorityMapping",
+    z
+      .object({
+        in: z.object({}).catchall(z.number().int()).optional(),
+        out: z.object({}).catchall(z.number().int()).optional(),
+      })
+      .strict()
+      .describe("PriorityMapping"),
+  );
+  validationSchemaStorage.register(
+    "PrioritySchemeChangesWithMappings",
+    z
+      .object({
+        ids: z.array(z.number().int()),
+        mappings: z
+          .array(validationSchemaStorage.lazy("PriorityMapping"))
+          .optional(),
+      })
+      .strict()
+      .describe("PrioritySchemeChangesWithMappings"),
+  );
+  validationSchemaStorage.register(
+    "PrioritySchemeChangesWithoutMappings",
+    z
+      .object({
+        ids: z.array(z.number().int()),
+      })
+      .strict()
+      .describe("PrioritySchemeChangesWithoutMappings"),
+  );
+  validationSchemaStorage.register(
+    "PrioritySchemeId",
+    z
+      .object({
+        id: z.string().optional(),
+        task: validationSchemaStorage
+          .lazy("TaskProgressBeanJsonNode")
+          .optional(),
+      })
+      .strict()
+      .describe("PrioritySchemeId"),
+  );
+  validationSchemaStorage.register(
+    "PrioritySchemeWithPaginatedPrioritiesAndProjects",
+    z
+      .object({
+        default: z.boolean().optional(),
+        defaultPriorityId: z.string().optional(),
+        description: z.string().optional(),
+        id: z.string(),
+        isDefault: z.boolean().optional(),
+        name: z.string(),
+        priorities: validationSchemaStorage
+          .lazy("PageBeanPriorityWithSequence")
+          .optional(),
+        projects: validationSchemaStorage
+          .lazy("PageBeanProjectDetails")
+          .optional(),
+        self: z.string().optional(),
+      })
+      .catchall(z.unknown())
+      .describe("PrioritySchemeWithPaginatedPrioritiesAndProjects"),
+  );
+  validationSchemaStorage.register(
+    "PriorityWithSequence",
+    z
+      .object({
+        description: z.string().optional(),
+        iconUrl: z.string().optional(),
+        id: z.string().optional(),
+        isDefault: z.boolean().optional(),
+        name: z.string().optional(),
+        self: z.string().optional(),
+        sequence: z.string().optional(),
+        statusColor: z.string().optional(),
+      })
+      .strict()
+      .describe("PriorityWithSequence"),
+  );
+  validationSchemaStorage.register(
+    "SuggestedMappingsForPrioritiesRequestBean",
+    z
+      .object({
+        add: z.array(z.number().int()).optional(),
+        remove: z.array(z.number().int()).optional(),
+      })
+      .strict()
+      .describe("SuggestedMappingsForPrioritiesRequestBean"),
+  );
+  validationSchemaStorage.register(
+    "SuggestedMappingsForProjectsRequestBean",
+    z
+      .object({
+        add: z.array(z.number().int()).optional(),
+      })
+      .strict()
+      .describe("SuggestedMappingsForProjectsRequestBean"),
+  );
+  validationSchemaStorage.register(
+    "SuggestedMappingsRequestBean",
+    z
+      .object({
+        maxResults: z.number().int().optional(),
+        priorities: validationSchemaStorage
+          .lazy("SuggestedMappingsForPrioritiesRequestBean")
+          .optional(),
+        projects: validationSchemaStorage
+          .lazy("SuggestedMappingsForProjectsRequestBean")
+          .optional(),
+        schemeId: z.number().int().optional(),
+        startAt: z.number().int().optional(),
+      })
+      .strict()
+      .describe("SuggestedMappingsRequestBean"),
+  );
+  validationSchemaStorage.register(
+    "TaskProgressBeanJsonNode",
+    z
+      .object({
+        description: z.string().optional(),
+        elapsedRuntime: z.number().int(),
+        finished: z.number().int().optional(),
+        id: z.string(),
+        lastUpdate: z.number().int(),
+        message: z.string().optional(),
+        progress: z.number().int(),
+        result: validationSchemaStorage.lazy("JsonNode").optional(),
+        self: z.string(),
+        started: z.number().int().optional(),
+        status: z.enum([
+          "ENQUEUED",
+          "RUNNING",
+          "COMPLETE",
+          "FAILED",
+          "CANCEL_REQUESTED",
+          "CANCELLED",
+          "DEAD",
+        ]),
+        submitted: z.number().int(),
+        submittedBy: z.number().int(),
+      })
+      .strict()
+      .describe("TaskProgressBeanJsonNode"),
+  );
+  validationSchemaStorage.register(
+    "UpdatePrioritiesInSchemeRequestBean",
+    z
+      .object({
+        add: validationSchemaStorage
+          .lazy("PrioritySchemeChangesWithoutMappings")
+          .optional(),
+        remove: validationSchemaStorage
+          .lazy("PrioritySchemeChangesWithMappings")
+          .optional(),
+      })
+      .catchall(z.unknown())
+      .describe("UpdatePrioritiesInSchemeRequestBean"),
+  );
+  validationSchemaStorage.register(
+    "UpdatePrioritySchemeRequestBean",
+    z
+      .object({
+        defaultPriorityId: z.number().int().optional(),
+        description: z.string().max(4000).optional(),
+        mappings: validationSchemaStorage.lazy("PriorityMapping").optional(),
+        name: z.string().max(255).optional(),
+        priorities: validationSchemaStorage
+          .lazy("UpdatePrioritiesInSchemeRequestBean")
+          .optional(),
+        projects: validationSchemaStorage
+          .lazy("UpdateProjectsInSchemeRequestBean")
+          .optional(),
+      })
+      .strict()
+      .describe("UpdatePrioritySchemeRequestBean"),
+  );
+  validationSchemaStorage.register(
+    "UpdatePrioritySchemeResponseBean",
+    z
+      .object({
+        priorityScheme: validationSchemaStorage
+          .lazy("PrioritySchemeWithPaginatedPrioritiesAndProjects")
+          .optional(),
+        task: validationSchemaStorage
+          .lazy("TaskProgressBeanJsonNode")
+          .optional(),
+      })
+      .catchall(z.unknown())
+      .describe("UpdatePrioritySchemeResponseBean"),
+  );
+  validationSchemaStorage.register(
+    "UpdateProjectsInSchemeRequestBean",
+    z
+      .object({
+        add: validationSchemaStorage
+          .lazy("PrioritySchemeChangesWithoutMappings")
+          .optional(),
+        remove: validationSchemaStorage
+          .lazy("PrioritySchemeChangesWithoutMappings")
+          .optional(),
+      })
+      .catchall(z.unknown())
+      .describe("UpdateProjectsInSchemeRequestBean"),
+  );
+  validationSchemaStorage.registerOnce([registerCommonValidationSchemas]);
+}

package/src/openapi/platform/models/project-avatars.ts

@@ -0,0 +1,29 @@
+// DO NOT EDIT!
+// This file is generated by "api-typescript-generator".
+// To update this file run "yarn build:openapi".
+import { z, type ZodTypeAny } from "zod";
+
+import type { CommonValidationSchemaStorage } from "../core/common-validation-schema-storage";
+import { type Avatar, registerCommonValidationSchemas } from "./common";
+/** List of project avatars. */
+export interface ProjectAvatars {
+  /** List of avatars added to Jira. These avatars may be deleted. */
+  custom?: Avatar[];
+  /** List of avatars included with Jira. These avatars cannot be deleted. */
+  system?: Avatar[];
+}
+export function registerProjectAvatarsValidationSchemas(
+  validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>,
+) {
+  validationSchemaStorage.register(
+    "ProjectAvatars",
+    z
+      .object({
+        custom: z.array(validationSchemaStorage.lazy("Avatar")).optional(),
+        system: z.array(validationSchemaStorage.lazy("Avatar")).optional(),
+      })
+      .strict()
+      .describe("ProjectAvatars"),
+  );
+  validationSchemaStorage.registerOnce([registerCommonValidationSchemas]);
+}

package/src/openapi/platform/models/project-classification-levels.ts

@@ -0,0 +1,24 @@
+// DO NOT EDIT!
+// This file is generated by "api-typescript-generator".
+// To update this file run "yarn build:openapi".
+import { z, type ZodTypeAny } from "zod";
+
+import type { CommonValidationSchemaStorage } from "../core/common-validation-schema-storage";
+/** The request for updating the default project classification level. */
+export interface UpdateDefaultProjectClassificationBean {
+  /** The ID of the project classification. */
+  id: string;
+}
+export function registerProjectClassificationLevelsValidationSchemas(
+  validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>,
+) {
+  validationSchemaStorage.register(
+    "UpdateDefaultProjectClassificationBean",
+    z
+      .object({
+        id: z.string(),
+      })
+      .strict()
+      .describe("UpdateDefaultProjectClassificationBean"),
+  );
+}