@resolution/jira-api-client 0.1.0

package/src/openapi/platform/models/groups.ts

@@ -0,0 +1,247 @@
+// 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 { registerCommonValidationSchemas, type UserDetails } from "./common";
+export interface AddGroupBean extends Record<string, unknown> {
+  /** The name of the group. */
+  name: string;
+}
+/** A group found in a search. */
+export interface FoundGroup {
+  /**
+   * The ID of the group, which uniquely identifies the group across all Atlassian
+   * products. For example, *952d12c3-5b5b-4d04-bb32-44d383afc4b2*.
+   */
+  groupId?: string;
+  /** The group name with the matched query string highlighted with the HTML bold tag. */
+  html?: string;
+  labels?: GroupLabel[];
+  /**
+   * The name of the group. The name of a group is mutable, to reliably identify a
+   * group use ``groupId`.`
+   */
+  name?: string;
+}
+export interface Group {
+  /** Expand options that include additional group details in the response. */
+  expand?: string;
+  /**
+   * The ID of the group, which uniquely identifies the group across all Atlassian
+   * products. For example, *952d12c3-5b5b-4d04-bb32-44d383afc4b2*.
+   */
+  groupId?: string | null;
+  /** The name of group. */
+  name?: string;
+  /** The URL for these group details. */
+  self?: string;
+  /**
+   * A paginated list of the users that are members of the group. A maximum of 50
+   * users is returned in the list, to access additional users append
+   * `[start-index:end-index]` to the expand request. For example, to access the
+   * next 50 users, use`?expand=users[51:100]`.
+   */
+  users?: PagedListUserDetailsApplicationUser;
+}
+/** Details about a group. */
+export interface GroupDetails {
+  /**
+   * The ID of the group, which uniquely identifies the group across all Atlassian
+   * products. For example, *952d12c3-5b5b-4d04-bb32-44d383afc4b2*.
+   */
+  groupId?: string | null;
+  /** The name of the group. */
+  name?: string;
+}
+/** A group label. */
+export interface GroupLabel {
+  /** The group label name. */
+  text?: string;
+  /** The title of the group label. */
+  title?: string;
+  /** The type of the group label. */
+  type?: "ADMIN" | "SINGLE" | "MULTIPLE";
+}
+/** A page of items. */
+export interface PageBeanGroupDetails {
+  /** 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?: GroupDetails[];
+}
+/** A page of items. */
+export interface PageBeanUserDetails {
+  /** 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?: UserDetails[];
+}
+/**
+ * A paged list. To access additional details append `[start-index:end-index]` to
+ * the expand request. For example, `?expand=sharedUsers[10:40]` returns a list
+ * starting at item 10 and finishing at item 40.
+ */
+export interface PagedListUserDetailsApplicationUser {
+  /** The index of the last item returned on the page. */
+  "end-index"?: number;
+  /** The list of items. */
+  items?: UserDetails[];
+  /** The maximum number of results that could be on the page. */
+  "max-results"?: number;
+  /** The number of items on the page. */
+  size?: number;
+  /** The index of the first item returned on the page. */
+  "start-index"?: number;
+}
+export interface UpdateUserToGroupBean extends Record<string, unknown> {
+  /**
+   * The account ID of the user, which uniquely identifies the user across all
+   * Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.
+   */
+  accountId?: string;
+  /**
+   * This property is no longer available. See the [deprecation
+   * notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/)
+   * for details.
+   */
+  name?: string;
+}
+export function registerGroupsValidationSchemas(
+  validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>,
+) {
+  validationSchemaStorage.register(
+    "AddGroupBean",
+    z
+      .object({
+        name: z.string(),
+      })
+      .catchall(z.unknown())
+      .describe("AddGroupBean"),
+  );
+  validationSchemaStorage.register(
+    "FoundGroup",
+    z
+      .object({
+        groupId: z.string().optional(),
+        html: z.string().optional(),
+        labels: z.array(validationSchemaStorage.lazy("GroupLabel")).optional(),
+        name: z.string().optional(),
+      })
+      .strict()
+      .describe("FoundGroup"),
+  );
+  validationSchemaStorage.register(
+    "Group",
+    z
+      .object({
+        expand: z.string().optional(),
+        groupId: z.nullable(z.string()).optional(),
+        name: z.string().optional(),
+        self: z.string().optional(),
+        users: validationSchemaStorage
+          .lazy("PagedListUserDetailsApplicationUser")
+          .optional(),
+      })
+      .strict()
+      .describe("Group"),
+  );
+  validationSchemaStorage.register(
+    "GroupDetails",
+    z
+      .object({
+        groupId: z.nullable(z.string()).optional(),
+        name: z.string().optional(),
+      })
+      .strict()
+      .describe("GroupDetails"),
+  );
+  validationSchemaStorage.register(
+    "GroupLabel",
+    z
+      .object({
+        text: z.string().optional(),
+        title: z.string().optional(),
+        type: z.enum(["ADMIN", "SINGLE", "MULTIPLE"]).optional(),
+      })
+      .strict()
+      .describe("GroupLabel"),
+  );
+  validationSchemaStorage.register(
+    "PageBeanGroupDetails",
+    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("GroupDetails"))
+          .optional(),
+      })
+      .strict()
+      .describe("PageBeanGroupDetails"),
+  );
+  validationSchemaStorage.register(
+    "PageBeanUserDetails",
+    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("UserDetails")).optional(),
+      })
+      .strict()
+      .describe("PageBeanUserDetails"),
+  );
+  validationSchemaStorage.register(
+    "PagedListUserDetailsApplicationUser",
+    z
+      .object({
+        "end-index": z.number().int().optional(),
+        items: z.array(validationSchemaStorage.lazy("UserDetails")).optional(),
+        "max-results": z.number().int().optional(),
+        size: z.number().int().optional(),
+        "start-index": z.number().int().optional(),
+      })
+      .strict()
+      .describe("PagedListUserDetailsApplicationUser"),
+  );
+  validationSchemaStorage.register(
+    "UpdateUserToGroupBean",
+    z
+      .object({
+        accountId: z.string().max(128).optional(),
+        name: z.string().optional(),
+      })
+      .catchall(z.unknown())
+      .describe("UpdateUserToGroupBean"),
+  );
+  validationSchemaStorage.registerOnce([registerCommonValidationSchemas]);
+}

package/src/openapi/platform/models/issue-attachments.ts

@@ -0,0 +1,290 @@
+// DO NOT EDIT!
+// This file is generated by "api-typescript-generator".
+// To update this file run "yarn build:openapi".
+import type { Stream } from "stream";
+import { z, type ZodTypeAny } from "zod";
+
+import type { CommonValidationSchemaStorage } from "../core/common-validation-schema-storage";
+import {
+  type ApplicationRole,
+  type GroupName,
+  registerCommonValidationSchemas,
+  type User,
+  type UserDetails,
+} from "./common";
+/** Details about an attachment. */
+export interface Attachment extends Record<string, unknown> {
+  /** Details of the user who added the attachment. */
+  author?: UserDetails;
+  /** The content of the attachment. */
+  content?: string;
+  /** The datetime the attachment was created. */
+  created?: string;
+  /** The file name of the attachment. */
+  filename?: string;
+  /** The ID of the attachment. */
+  id?: string;
+  /** The MIME type of the attachment. */
+  mimeType?: string;
+  /** The URL of the attachment details response. */
+  self?: string;
+  /** The size of the attachment. */
+  size?: number;
+  /** The URL of a thumbnail representing the attachment. */
+  thumbnail?: string;
+}
+export interface AttachmentArchiveEntry {
+  abbreviatedName?: string;
+  entryIndex?: number;
+  mediaType?: string;
+  name?: string;
+  size?: number;
+}
+export interface AttachmentArchiveImpl {
+  /** The list of the items included in the archive. */
+  entries?: AttachmentArchiveEntry[];
+  /** The number of items in the archive. */
+  totalEntryCount?: number;
+}
+/** Metadata for an item in an attachment archive. */
+export interface AttachmentArchiveItemReadable {
+  /** The position of the item within the archive. */
+  index?: number;
+  /** The label for the archive item. */
+  label?: string;
+  /** The MIME type of the archive item. */
+  mediaType?: string;
+  /** The path of the archive item. */
+  path?: string;
+  /** The size of the archive item. */
+  size?: string;
+}
+/** Metadata for an archive (for example a zip) and its contents. */
+export interface AttachmentArchiveMetadataReadable {
+  /** The list of the items included in the archive. */
+  entries?: AttachmentArchiveItemReadable[];
+  /** The ID of the attachment. */
+  id?: number;
+  /** The MIME type of the attachment. */
+  mediaType?: string;
+  /** The name of the archive file. */
+  name?: string;
+  /** The number of items included in the archive. */
+  totalEntryCount?: number;
+}
+/** Metadata for an issue attachment. */
+export interface AttachmentMetadata {
+  /** Details of the user who attached the file. */
+  author?: User;
+  /** The URL of the attachment. */
+  content?: string;
+  /** The datetime the attachment was created. */
+  created?: string;
+  /** The name of the attachment file. */
+  filename?: string;
+  /** The ID of the attachment. */
+  id?: number;
+  /** The MIME type of the attachment. */
+  mimeType?: string;
+  /** Additional properties of the attachment. */
+  properties?: {
+    [key: string]: unknown;
+  };
+  /** The URL of the attachment metadata details. */
+  self?: string;
+  /** The size of the attachment. */
+  size?: number;
+  /** The URL of a thumbnail representing the attachment. */
+  thumbnail?: string;
+}
+/** Details of the instance's attachment settings. */
+export interface AttachmentSettings {
+  /** Whether the ability to add attachments is enabled. */
+  enabled?: boolean;
+  /** The maximum size of attachments permitted, in bytes. */
+  uploadLimit?: number;
+}
+export interface ListWrapperCallbackApplicationRole {}
+export interface ListWrapperCallbackGroupName {}
+export type MultipartFile = [
+  Blob | Stream,
+  {
+    filename?: string;
+  },
+];
+/** The application roles the user is assigned to. */
+export interface SimpleListWrapperApplicationRole {
+  callback?: ListWrapperCallbackApplicationRole;
+  items?: ApplicationRole[];
+  "max-results"?: number;
+  pagingCallback?: ListWrapperCallbackApplicationRole;
+  size?: number;
+}
+/** The groups that the user belongs to. */
+export interface SimpleListWrapperGroupName {
+  callback?: ListWrapperCallbackGroupName;
+  items?: GroupName[];
+  "max-results"?: number;
+  pagingCallback?: ListWrapperCallbackGroupName;
+  size?: number;
+}
+export function registerIssueAttachmentsValidationSchemas(
+  validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>,
+) {
+  validationSchemaStorage.register(
+    "Attachment",
+    z
+      .object({
+        author: validationSchemaStorage.lazy("UserDetails").optional(),
+        content: z.string().optional(),
+        created: z.string().optional(),
+        filename: z.string().optional(),
+        id: z.string().optional(),
+        mimeType: z.string().optional(),
+        self: z.string().optional(),
+        size: z.number().int().optional(),
+        thumbnail: z.string().optional(),
+      })
+      .catchall(z.unknown())
+      .describe("Attachment"),
+  );
+  validationSchemaStorage.register(
+    "AttachmentArchiveEntry",
+    z
+      .object({
+        abbreviatedName: z.string().optional(),
+        entryIndex: z.number().int().optional(),
+        mediaType: z.string().optional(),
+        name: z.string().optional(),
+        size: z.number().int().optional(),
+      })
+      .strict()
+      .describe("AttachmentArchiveEntry"),
+  );
+  validationSchemaStorage.register(
+    "AttachmentArchiveImpl",
+    z
+      .object({
+        entries: z
+          .array(validationSchemaStorage.lazy("AttachmentArchiveEntry"))
+          .optional(),
+        totalEntryCount: z.number().int().optional(),
+      })
+      .strict()
+      .describe("AttachmentArchiveImpl"),
+  );
+  validationSchemaStorage.register(
+    "AttachmentArchiveItemReadable",
+    z
+      .object({
+        index: z.number().int().optional(),
+        label: z.string().optional(),
+        mediaType: z.string().optional(),
+        path: z.string().optional(),
+        size: z.string().optional(),
+      })
+      .strict()
+      .describe("AttachmentArchiveItemReadable"),
+  );
+  validationSchemaStorage.register(
+    "AttachmentArchiveMetadataReadable",
+    z
+      .object({
+        entries: z
+          .array(validationSchemaStorage.lazy("AttachmentArchiveItemReadable"))
+          .optional(),
+        id: z.number().int().optional(),
+        mediaType: z.string().optional(),
+        name: z.string().optional(),
+        totalEntryCount: z.number().int().optional(),
+      })
+      .strict()
+      .describe("AttachmentArchiveMetadataReadable"),
+  );
+  validationSchemaStorage.register(
+    "AttachmentMetadata",
+    z
+      .object({
+        author: validationSchemaStorage.lazy("User").optional(),
+        content: z.string().optional(),
+        created: z.string().optional(),
+        filename: z.string().optional(),
+        id: z.number().int().optional(),
+        mimeType: z.string().optional(),
+        properties: z.object({}).catchall(z.unknown()).optional(),
+        self: z.string().optional(),
+        size: z.number().int().optional(),
+        thumbnail: z.string().optional(),
+      })
+      .strict()
+      .describe("AttachmentMetadata"),
+  );
+  validationSchemaStorage.register(
+    "AttachmentSettings",
+    z
+      .object({
+        enabled: z.boolean().optional(),
+        uploadLimit: z.number().int().optional(),
+      })
+      .strict()
+      .describe("AttachmentSettings"),
+  );
+  validationSchemaStorage.register(
+    "ListWrapperCallbackApplicationRole",
+    z.object({}).strict().describe("ListWrapperCallbackApplicationRole"),
+  );
+  validationSchemaStorage.register(
+    "ListWrapperCallbackGroupName",
+    z.object({}).strict().describe("ListWrapperCallbackGroupName"),
+  );
+  validationSchemaStorage.register(
+    "MultipartFile",
+    z
+      .tuple([
+        z.string(),
+        z
+          .object({
+            filename: z.string().optional(),
+          })
+          .strict(),
+      ])
+      .describe("MultipartFile"),
+  );
+  validationSchemaStorage.register(
+    "SimpleListWrapperApplicationRole",
+    z
+      .object({
+        callback: validationSchemaStorage
+          .lazy("ListWrapperCallbackApplicationRole")
+          .optional(),
+        items: z
+          .array(validationSchemaStorage.lazy("ApplicationRole"))
+          .optional(),
+        "max-results": z.number().int().optional(),
+        pagingCallback: validationSchemaStorage
+          .lazy("ListWrapperCallbackApplicationRole")
+          .optional(),
+        size: z.number().int().optional(),
+      })
+      .strict()
+      .describe("SimpleListWrapperApplicationRole"),
+  );
+  validationSchemaStorage.register(
+    "SimpleListWrapperGroupName",
+    z
+      .object({
+        callback: validationSchemaStorage
+          .lazy("ListWrapperCallbackGroupName")
+          .optional(),
+        items: z.array(validationSchemaStorage.lazy("GroupName")).optional(),
+        "max-results": z.number().int().optional(),
+        pagingCallback: validationSchemaStorage
+          .lazy("ListWrapperCallbackGroupName")
+          .optional(),
+        size: z.number().int().optional(),
+      })
+      .strict()
+      .describe("SimpleListWrapperGroupName"),
+  );
+  validationSchemaStorage.registerOnce([registerCommonValidationSchemas]);
+}

package/src/openapi/platform/models/issue-comment-properties.ts

@@ -0,0 +1,27 @@
+// 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";
+/** Property key details. */
+export interface PropertyKey {
+  /** The key of the property. */
+  key?: string;
+  /** The URL of the property. */
+  self?: string;
+}
+export function registerIssueCommentPropertiesValidationSchemas(
+  validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>,
+) {
+  validationSchemaStorage.register(
+    "PropertyKey",
+    z
+      .object({
+        key: z.string().optional(),
+        self: z.string().optional(),
+      })
+      .strict()
+      .describe("PropertyKey"),
+  );
+}

package/src/openapi/platform/models/issue-comments.ts

@@ -0,0 +1,91 @@
+// 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 Comment, registerCommonValidationSchemas } from "./common";
+export interface IssueCommentListRequestBean {
+  /** The list of comment IDs. A maximum of 1000 IDs can be specified. */
+  ids: number[];
+}
+/** A page of items. */
+export interface PageBeanComment {
+  /** 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?: Comment[];
+}
+/** A page of comments. */
+export interface PageOfComments extends Record<string, unknown> {
+  /** The list of comments. */
+  comments?: Comment[];
+  /** The maximum number of items that could be returned. */
+  maxResults?: number;
+  /** The index of the first item returned. */
+  startAt?: number;
+  /** The number of items returned. */
+  total?: number;
+}
+export function registerIssueCommentsValidationSchemas(
+  validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>,
+) {
+  validationSchemaStorage.register(
+    "IssueCommentListRequestBean",
+    z
+      .object({
+        ids: 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",
+            });
+          }
+        }),
+      })
+      .strict()
+      .describe("IssueCommentListRequestBean"),
+  );
+  validationSchemaStorage.register(
+    "PageBeanComment",
+    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("Comment")).optional(),
+      })
+      .strict()
+      .describe("PageBeanComment"),
+  );
+  validationSchemaStorage.register(
+    "PageOfComments",
+    z
+      .object({
+        comments: z.array(validationSchemaStorage.lazy("Comment")).optional(),
+        maxResults: z.number().int().optional(),
+        startAt: z.number().int().optional(),
+        total: z.number().int().optional(),
+      })
+      .catchall(z.unknown())
+      .describe("PageOfComments"),
+  );
+  validationSchemaStorage.registerOnce([registerCommonValidationSchemas]);
+}