@resolution/jira-api-client 0.1.0

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

@@ -0,0 +1,367 @@
+// 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 IssueBean,
+  type JsonTypeBean,
+  registerCommonValidationSchemas,
+} from "./common";
+export interface IdSearchRequestBean {
+  /**
+   * A [JQL](https://confluence.atlassian.com/x/egORLQ) expression. Order by clauses
+   * are not allowed.
+   */
+  jql?: string;
+  /** The maximum number of items to return per page. */
+  maxResults?: number;
+  /**
+   * The continuation token to fetch the next page. This token is provided by the
+   * response of this endpoint.
+   */
+  nextPageToken?: string;
+}
+/**
+ * Result of your JQL search. Returns a list of issue IDs and a token to fetch the
+ * next page if one exists.
+ */
+export interface IdSearchResults {
+  /** The list of issue IDs found by the search. */
+  issueIds?: number[];
+  /**
+   * Continuation token to fetch the next page. If this result represents the last
+   * or the only page this token will be null.
+   */
+  nextPageToken?: string;
+}
+/**
+ * A list of matched issues or errors for each JQL query, in the order the JQL
+ * queries were passed.
+ */
+export interface IssueMatches {
+  matches: IssueMatchesForJql[];
+}
+/**
+ * A list of the issues matched to a JQL query or details of errors encountered
+ * during matching.
+ */
+export interface IssueMatchesForJql {
+  /** A list of errors. */
+  errors: string[];
+  /** A list of issue IDs. */
+  matchedIssues: number[];
+}
+/** A list of issues suggested for use in auto-completion. */
+export interface IssuePickerSuggestions {
+  /** A list of issues for an issue type suggested for use in auto-completion. */
+  sections?: IssuePickerSuggestionsIssueType[];
+}
+/** A type of issue suggested for use in auto-completion. */
+export interface IssuePickerSuggestionsIssueType {
+  /** The ID of the type of issues suggested for use in auto-completion. */
+  id?: string;
+  /** A list of issues suggested for use in auto-completion. */
+  issues?: SuggestedIssue[];
+  /** The label of the type of issues suggested for use in auto-completion. */
+  label?: string;
+  /**
+   * If no issue suggestions are found, returns a message indicating no suggestions
+   * were found,
+   */
+  msg?: string;
+  /**
+   * If issue suggestions are found, returns a message indicating the number of
+   * issues suggestions found and returned.
+   */
+  sub?: string;
+}
+/** List of issues and JQL queries. */
+export interface IssuesAndJqlQueries {
+  /** A list of issue IDs. */
+  issueIds: number[];
+  /** A list of JQL queries. */
+  jqls: string[];
+}
+export interface SearchRequestBean {
+  /**
+   * Use [expand](em>#expansion) to include additional information about issues in
+   * the response. Note that, unlike the majority of instances where `expand` is
+   * specified, `expand` is defined as a list of values. The expand options are:
+   *
+   *  *  `renderedFields` Returns field values rendered in HTML format.
+   *  *  `names` Returns the display name of each field.
+   *  *  `schema` Returns the schema describing a field type.
+   *  *  `transitions` Returns all possible transitions for the issue.
+   *  *  `operations` Returns all possible operations for the issue.
+   *  *  `editmeta` Returns information about how each field can be edited.
+   *  *  `changelog` Returns a list of recent updates to an issue, sorted by date,
+   * starting from the most recent.
+   *  *  `versionedRepresentations` Instead of `fields`, returns
+   * `versionedRepresentations` a JSON array containing each version of a field's
+   * value, with the highest numbered item representing the most recent version.
+   */
+  expand?: string[];
+  /**
+   * A list of fields to return for each issue, use it to retrieve a subset of
+   * fields. This parameter accepts a comma-separated list. Expand options include:
+   *
+   *  *  `*all` Returns all fields.
+   *  *  `*navigable` Returns navigable fields.
+   *  *  Any issue field, prefixed with a minus to exclude.
+   *
+   * The default is `*navigable`.
+   *
+   * Examples:
+   *
+   *  *  `summary,comment` Returns the summary and comments fields only.
+   *  *  `-description` Returns all navigable (default) fields except description.
+   *  *  `*all,-comment` Returns all fields except comments.
+   *
+   * Multiple `fields` parameters can be included in a request.
+   *
+   * Note: All navigable fields are returned by default. This differs from [GET
+   * issue](#api-rest-api-3-issue-issueIdOrKey-get) where the default is all fields.
+   */
+  fields?: string[];
+  /** Reference fields by their key (rather than ID). The default is `false`. */
+  fieldsByKeys?: boolean;
+  /** A [JQL](https://confluence.atlassian.com/x/egORLQ) expression. */
+  jql?: string;
+  /** The maximum number of items to return per page. */
+  maxResults?: number;
+  /**
+   * A list of up to 5 issue properties to include in the results. This parameter
+   * accepts a comma-separated list.
+   */
+  properties?: string[];
+  /**
+   * The index of the first item to return in the page of results (page offset). The
+   * base index is `0`.
+   */
+  startAt?: number;
+  /**
+   * Determines how to validate the JQL query and treat the validation results.
+   * Supported values:
+   *
+   *  *  `strict` Returns a 400 response code if any errors are found, along with a
+   * list of all errors (and warnings).
+   *  *  `warn` Returns all errors as warnings.
+   *  *  `none` No validation is performed.
+   *  *  `true` *Deprecated* A legacy synonym for `strict`.
+   *  *  `false` *Deprecated* A legacy synonym for `warn`.
+   *
+   * The default is `strict`.
+   *
+   * Note: If the JQL is not correctly formed a 400 response code is returned,
+   * regardless of the `validateQuery` value.
+   */
+  validateQuery?: "strict" | "warn" | "none" | "true" | "false";
+}
+/** 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]: JsonTypeBean;
+  };
+  /** 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[];
+}
+/** An issue suggested for use in the issue picker auto-completion. */
+export interface SuggestedIssue {
+  /** The ID of the issue. */
+  id?: number;
+  /** The URL of the issue type's avatar. */
+  img?: string;
+  /** The key of the issue. */
+  key?: string;
+  /** The key of the issue in HTML format. */
+  keyHtml?: string;
+  /**
+   * The phrase containing the query string in HTML format, with the string
+   * highlighted with HTML bold tags.
+   */
+  summary?: string;
+  /** The phrase containing the query string, as plain text. */
+  summaryText?: string;
+}
+export function registerIssueSearchValidationSchemas(
+  validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>,
+) {
+  validationSchemaStorage.register(
+    "IdSearchRequestBean",
+    z
+      .object({
+        jql: z.string().optional(),
+        maxResults: z.number().int().optional(),
+        nextPageToken: z.string().optional(),
+      })
+      .strict()
+      .describe("IdSearchRequestBean"),
+  );
+  validationSchemaStorage.register(
+    "IdSearchResults",
+    z
+      .object({
+        issueIds: z.array(z.number().int()).optional(),
+        nextPageToken: z.string().optional(),
+      })
+      .strict()
+      .describe("IdSearchResults"),
+  );
+  validationSchemaStorage.register(
+    "IssueMatches",
+    z
+      .object({
+        matches: z.array(validationSchemaStorage.lazy("IssueMatchesForJql")),
+      })
+      .strict()
+      .describe("IssueMatches"),
+  );
+  validationSchemaStorage.register(
+    "IssueMatchesForJql",
+    z
+      .object({
+        errors: z.array(z.string()).superRefine((items, ctx) => {
+          if (new Set(items).size !== items.length) {
+            ctx.addIssue({
+              code: z.ZodIssueCode.custom,
+              path: [],
+              message: "Array items must be unique",
+            });
+          }
+        }),
+        matchedIssues: 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("IssueMatchesForJql"),
+  );
+  validationSchemaStorage.register(
+    "IssuePickerSuggestions",
+    z
+      .object({
+        sections: z
+          .array(
+            validationSchemaStorage.lazy("IssuePickerSuggestionsIssueType"),
+          )
+          .optional(),
+      })
+      .strict()
+      .describe("IssuePickerSuggestions"),
+  );
+  validationSchemaStorage.register(
+    "IssuePickerSuggestionsIssueType",
+    z
+      .object({
+        id: z.string().optional(),
+        issues: z
+          .array(validationSchemaStorage.lazy("SuggestedIssue"))
+          .optional(),
+        label: z.string().optional(),
+        msg: z.string().optional(),
+        sub: z.string().optional(),
+      })
+      .strict()
+      .describe("IssuePickerSuggestionsIssueType"),
+  );
+  validationSchemaStorage.register(
+    "IssuesAndJqlQueries",
+    z
+      .object({
+        issueIds: 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",
+            });
+          }
+        }),
+        jqls: z.array(z.string()),
+      })
+      .strict()
+      .describe("IssuesAndJqlQueries"),
+  );
+  validationSchemaStorage.register(
+    "SearchRequestBean",
+    z
+      .object({
+        expand: z.array(z.string()).optional(),
+        fields: z.array(z.string()).optional(),
+        fieldsByKeys: z.boolean().optional(),
+        jql: z.string().optional(),
+        maxResults: z.number().int().optional(),
+        properties: z.array(z.string()).optional(),
+        startAt: z.number().int().optional(),
+        validateQuery: z
+          .enum(["strict", "warn", "none", "true", "false"])
+          .optional(),
+      })
+      .strict()
+      .describe("SearchRequestBean"),
+  );
+  validationSchemaStorage.register(
+    "SearchResults",
+    z
+      .object({
+        expand: z.string().optional(),
+        issues: z.array(validationSchemaStorage.lazy("IssueBean")).optional(),
+        maxResults: z.number().int().optional(),
+        names: z.object({}).catchall(z.string()).optional(),
+        schema: z
+          .object({})
+          .catchall(validationSchemaStorage.lazy("JsonTypeBean"))
+          .optional(),
+        startAt: z.number().int().optional(),
+        total: z.number().int().optional(),
+        warningMessages: z.array(z.string()).optional(),
+      })
+      .strict()
+      .describe("SearchResults"),
+  );
+  validationSchemaStorage.register(
+    "SuggestedIssue",
+    z
+      .object({
+        id: z.number().int().optional(),
+        img: z.string().optional(),
+        key: z.string().optional(),
+        keyHtml: z.string().optional(),
+        summary: z.string().optional(),
+        summaryText: z.string().optional(),
+      })
+      .strict()
+      .describe("SuggestedIssue"),
+  );
+  validationSchemaStorage.registerOnce([registerCommonValidationSchemas]);
+}

package/src/openapi/platform/models/issue-security-level.ts

@@ -0,0 +1,76 @@
+// 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 PermissionHolder,
+  registerCommonValidationSchemas,
+} from "./common";
+/** Issue security level member. */
+export interface IssueSecurityLevelMember {
+  /**
+   * The user or group being granted the permission. It consists of a `type` and a
+   * type-dependent `parameter`. See [Holder
+   * object](../api-group-permission-schemes/#holder-object) in *Get all permission
+   * schemes* for more information.
+   */
+  holder: PermissionHolder;
+  /** The ID of the issue security level member. */
+  id: number;
+  /** The ID of the issue security level. */
+  issueSecurityLevelId: number;
+  managed?: boolean;
+}
+/** A page of items. */
+export interface PageBeanIssueSecurityLevelMember {
+  /** 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?: IssueSecurityLevelMember[];
+}
+export function registerIssueSecurityLevelValidationSchemas(
+  validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>,
+) {
+  validationSchemaStorage.register(
+    "IssueSecurityLevelMember",
+    z
+      .object({
+        holder: validationSchemaStorage.lazy("PermissionHolder"),
+        id: z.number().int(),
+        issueSecurityLevelId: z.number().int(),
+        managed: z.boolean().optional(),
+      })
+      .strict()
+      .describe("IssueSecurityLevelMember"),
+  );
+  validationSchemaStorage.register(
+    "PageBeanIssueSecurityLevelMember",
+    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("IssueSecurityLevelMember"))
+          .optional(),
+      })
+      .strict()
+      .describe("PageBeanIssueSecurityLevelMember"),
+  );
+  validationSchemaStorage.registerOnce([registerCommonValidationSchemas]);
+}