@resolution/jira-api-client 0.1.0

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

@@ -0,0 +1,192 @@
+// 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 PageBeanIssueTypeScreenScheme,
+  registerCommonValidationSchemas,
+} from "./common";
+/** A page of items. */
+export interface PageBeanScreenScheme {
+  /** 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?: ScreenScheme[];
+}
+/** A screen scheme. */
+export interface ScreenScheme {
+  /** The description of the screen scheme. */
+  description?: string;
+  /** The ID of the screen scheme. */
+  id?: number;
+  /** Details of the issue type screen schemes associated with the screen scheme. */
+  issueTypeScreenSchemes?: PageBeanIssueTypeScreenScheme;
+  /** The name of the screen scheme. */
+  name?: string;
+  /** The IDs of the screens for the screen types of the screen scheme. */
+  screens?: ScreenTypes;
+}
+/** Details of a screen scheme. */
+export interface ScreenSchemeDetails {
+  /** The description of the screen scheme. The maximum length is 255 characters. */
+  description?: string;
+  /**
+   * The name of the screen scheme. The name must be unique. The maximum length is
+   * 255 characters.
+   */
+  name: string;
+  /**
+   * The IDs of the screens for the screen types of the screen scheme. Only screens
+   * used in classic projects are accepted.
+   */
+  screens: ScreenTypes;
+}
+/** The ID of a screen scheme. */
+export interface ScreenSchemeId {
+  /** The ID of the screen scheme. */
+  id: number;
+}
+/** The IDs of the screens for the screen types of the screen scheme. */
+export interface ScreenTypes {
+  /** The ID of the create screen. */
+  create?: number;
+  /** The ID of the default screen. Required when creating a screen scheme. */
+  default?: number;
+  /** The ID of the edit screen. */
+  edit?: number;
+  /** The ID of the view screen. */
+  view?: number;
+}
+/** Details of a screen scheme. */
+export interface UpdateScreenSchemeDetails {
+  /** The description of the screen scheme. The maximum length is 255 characters. */
+  description?: string;
+  /**
+   * The name of the screen scheme. The name must be unique. The maximum length is
+   * 255 characters.
+   */
+  name?: string;
+  /**
+   * The IDs of the screens for the screen types of the screen scheme. Only screens
+   * used in classic projects are accepted.
+   */
+  screens?: UpdateScreenTypes;
+}
+/** The IDs of the screens for the screen types of the screen scheme. */
+export interface UpdateScreenTypes {
+  /** The ID of the create screen. To remove the screen association, pass a null. */
+  create?: string;
+  /**
+   * The ID of the default screen. When specified, must include a screen ID as a
+   * default screen is required.
+   */
+  default?: string;
+  /** The ID of the edit screen. To remove the screen association, pass a null. */
+  edit?: string;
+  /** The ID of the view screen. To remove the screen association, pass a null. */
+  view?: string;
+}
+export function registerScreenSchemesValidationSchemas(
+  validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>,
+) {
+  validationSchemaStorage.register(
+    "PageBeanScreenScheme",
+    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("ScreenScheme"))
+          .optional(),
+      })
+      .strict()
+      .describe("PageBeanScreenScheme"),
+  );
+  validationSchemaStorage.register(
+    "ScreenScheme",
+    z
+      .object({
+        description: z.string().optional(),
+        id: z.number().int().optional(),
+        issueTypeScreenSchemes: validationSchemaStorage
+          .lazy("PageBeanIssueTypeScreenScheme")
+          .optional(),
+        name: z.string().optional(),
+        screens: validationSchemaStorage.lazy("ScreenTypes").optional(),
+      })
+      .strict()
+      .describe("ScreenScheme"),
+  );
+  validationSchemaStorage.register(
+    "ScreenSchemeDetails",
+    z
+      .object({
+        description: z.string().optional(),
+        name: z.string(),
+        screens: validationSchemaStorage.lazy("ScreenTypes"),
+      })
+      .strict()
+      .describe("ScreenSchemeDetails"),
+  );
+  validationSchemaStorage.register(
+    "ScreenSchemeId",
+    z
+      .object({
+        id: z.number().int(),
+      })
+      .strict()
+      .describe("ScreenSchemeId"),
+  );
+  validationSchemaStorage.register(
+    "ScreenTypes",
+    z
+      .object({
+        create: z.number().int().optional(),
+        default: z.number().int().optional(),
+        edit: z.number().int().optional(),
+        view: z.number().int().optional(),
+      })
+      .strict()
+      .describe("ScreenTypes"),
+  );
+  validationSchemaStorage.register(
+    "UpdateScreenSchemeDetails",
+    z
+      .object({
+        description: z.string().optional(),
+        name: z.string().optional(),
+        screens: validationSchemaStorage.lazy("UpdateScreenTypes").optional(),
+      })
+      .strict()
+      .describe("UpdateScreenSchemeDetails"),
+  );
+  validationSchemaStorage.register(
+    "UpdateScreenTypes",
+    z
+      .object({
+        create: z.string().optional(),
+        default: z.string().optional(),
+        edit: z.string().optional(),
+        view: z.string().optional(),
+      })
+      .strict()
+      .describe("UpdateScreenTypes"),
+  );
+  validationSchemaStorage.registerOnce([registerCommonValidationSchemas]);
+}

package/src/openapi/platform/models/screen-tab-fields.ts

@@ -0,0 +1,45 @@
+// 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";
+export interface AddFieldBean {
+  /** The ID of the field to add. */
+  fieldId: string;
+}
+export interface MoveFieldBean {
+  /**
+   * The ID of the screen tab field after which to place the moved screen tab field.
+   * Required if `position` isn't provided.
+   */
+  after?: string;
+  /**
+   * The named position to which the screen tab field should be moved. Required if
+   * `after` isn't provided.
+   */
+  position?: "Earlier" | "Later" | "First" | "Last";
+}
+export function registerScreenTabFieldsValidationSchemas(
+  validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>,
+) {
+  validationSchemaStorage.register(
+    "AddFieldBean",
+    z
+      .object({
+        fieldId: z.string(),
+      })
+      .strict()
+      .describe("AddFieldBean"),
+  );
+  validationSchemaStorage.register(
+    "MoveFieldBean",
+    z
+      .object({
+        after: z.string().optional(),
+        position: z.enum(["Earlier", "Later", "First", "Last"]).optional(),
+      })
+      .strict()
+      .describe("MoveFieldBean"),
+  );
+}

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

@@ -0,0 +1,171 @@
+// 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 Scope,
+  type ScreenableTab,
+} from "./common";
+/** A page of items. */
+export interface PageBeanScreen {
+  /** 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?: Screen[];
+}
+/** A page of items. */
+export interface PageBeanScreenWithTab {
+  /** 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?: ScreenWithTab[];
+}
+/** A screen. */
+export interface Screen {
+  /** The description of the screen. */
+  description?: string;
+  /** The ID of the screen. */
+  id?: number;
+  /** The name of the screen. */
+  name?: string;
+  /** The scope of the screen. */
+  scope?: Scope;
+}
+/** Details of a screen. */
+export interface ScreenDetails {
+  /** The description of the screen. The maximum length is 255 characters. */
+  description?: string;
+  /**
+   * The name of the screen. The name must be unique. The maximum length is 255
+   * characters.
+   */
+  name: string;
+}
+/** A screen with tab details. */
+export interface ScreenWithTab {
+  /** The description of the screen. */
+  description?: string;
+  /** The ID of the screen. */
+  id?: number;
+  /** The name of the screen. */
+  name?: string;
+  /** The scope of the screen. */
+  scope?: Scope;
+  /** The tab for the screen. */
+  tab?: ScreenableTab;
+}
+/** Details of a screen. */
+export interface UpdateScreenDetails {
+  /** The description of the screen. The maximum length is 255 characters. */
+  description?: string;
+  /**
+   * The name of the screen. The name must be unique. The maximum length is 255
+   * characters.
+   */
+  name?: string;
+}
+export function registerScreensValidationSchemas(
+  validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>,
+) {
+  validationSchemaStorage.register(
+    "PageBeanScreen",
+    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("Screen")).optional(),
+      })
+      .strict()
+      .describe("PageBeanScreen"),
+  );
+  validationSchemaStorage.register(
+    "PageBeanScreenWithTab",
+    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("ScreenWithTab"))
+          .optional(),
+      })
+      .strict()
+      .describe("PageBeanScreenWithTab"),
+  );
+  validationSchemaStorage.register(
+    "Screen",
+    z
+      .object({
+        description: z.string().optional(),
+        id: z.number().int().optional(),
+        name: z.string().optional(),
+        scope: validationSchemaStorage.lazy("Scope").optional(),
+      })
+      .strict()
+      .describe("Screen"),
+  );
+  validationSchemaStorage.register(
+    "ScreenDetails",
+    z
+      .object({
+        description: z.string().optional(),
+        name: z.string(),
+      })
+      .strict()
+      .describe("ScreenDetails"),
+  );
+  validationSchemaStorage.register(
+    "ScreenWithTab",
+    z
+      .object({
+        description: z.string().optional(),
+        id: z.number().int().optional(),
+        name: z.string().optional(),
+        scope: validationSchemaStorage.lazy("Scope").optional(),
+        tab: validationSchemaStorage.lazy("ScreenableTab").optional(),
+      })
+      .strict()
+      .describe("ScreenWithTab"),
+  );
+  validationSchemaStorage.register(
+    "UpdateScreenDetails",
+    z
+      .object({
+        description: z.string().optional(),
+        name: z.string().optional(),
+      })
+      .strict()
+      .describe("UpdateScreenDetails"),
+  );
+  validationSchemaStorage.registerOnce([registerCommonValidationSchemas]);
+}

package/src/openapi/platform/models/server-info.ts

@@ -0,0 +1,100 @@
+// 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";
+/** Jira instance health check results. Deprecated and no longer returned. */
+export interface HealthCheckResult {
+  /** The description of the Jira health check item. */
+  description?: string;
+  /** The name of the Jira health check item. */
+  name?: string;
+  /** Whether the Jira health check item passed or failed. */
+  passed?: boolean;
+}
+/** Details about the Jira instance. */
+export interface ServerInformation {
+  /** The base URL of the Jira instance. */
+  baseUrl?: string;
+  /** The timestamp when the Jira version was built. */
+  buildDate?: string;
+  /** The build number of the Jira version. */
+  buildNumber?: number;
+  /** The type of server deployment. This is always returned as *Cloud*. */
+  deploymentType?: string;
+  /** The display URL of the Jira instance. */
+  displayUrl?: string;
+  /** The display URL of the Servicedesk Help Center. */
+  displayUrlServicedeskHelpCenter?: string;
+  /** Jira instance health check results. Deprecated and no longer returned. */
+  healthChecks?: HealthCheckResult[];
+  /** The unique identifier of the Jira version. */
+  scmInfo?: string;
+  /** The time in Jira when this request was responded to. */
+  serverTime?: string;
+  /**
+   * The default timezone of the Jira server. In a format known as Olson Time Zones,
+   * IANA Time Zones or TZ Database Time Zones.
+   */
+  serverTimeZone?: {
+    displayName?: string;
+    dstsavings?: number;
+    id?: string;
+    rawOffset?: number;
+  } & {
+    [key: string]: unknown;
+  };
+  /** The name of the Jira instance. */
+  serverTitle?: string;
+  /** The version of Jira. */
+  version?: string;
+  /** The major, minor, and revision version numbers of the Jira version. */
+  versionNumbers?: number[];
+}
+export function registerServerInfoValidationSchemas(
+  validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>,
+) {
+  validationSchemaStorage.register(
+    "HealthCheckResult",
+    z
+      .object({
+        description: z.string().optional(),
+        name: z.string().optional(),
+        passed: z.boolean().optional(),
+      })
+      .strict()
+      .describe("HealthCheckResult"),
+  );
+  validationSchemaStorage.register(
+    "ServerInformation",
+    z
+      .object({
+        baseUrl: z.string().optional(),
+        buildDate: z.string().optional(),
+        buildNumber: z.number().int().optional(),
+        deploymentType: z.string().optional(),
+        displayUrl: z.string().optional(),
+        displayUrlServicedeskHelpCenter: z.string().optional(),
+        healthChecks: z
+          .array(validationSchemaStorage.lazy("HealthCheckResult"))
+          .optional(),
+        scmInfo: z.string().optional(),
+        serverTime: z.string().optional(),
+        serverTimeZone: z
+          .object({
+            displayName: z.string().optional(),
+            dstsavings: z.number().int().optional(),
+            id: z.string().optional(),
+            rawOffset: z.number().int().optional(),
+          })
+          .catchall(z.unknown())
+          .optional(),
+        serverTitle: z.string().optional(),
+        version: z.string().optional(),
+        versionNumbers: z.array(z.number().int()).optional(),
+      })
+      .strict()
+      .describe("ServerInformation"),
+  );
+}

package/src/openapi/platform/models/service-registry.ts

@@ -0,0 +1,68 @@
+// 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";
+export interface ServiceRegistry extends Record<string, unknown> {
+  /** service description */
+  description?: string | null;
+  /** service ID */
+  id?: string;
+  /** service name */
+  name?: string;
+  /** organization ID */
+  organizationId?: string;
+  /** service revision */
+  revision?: string;
+  serviceTier?: ServiceRegistryTier;
+}
+export interface ServiceRegistryTier extends Record<string, unknown> {
+  /** tier description */
+  description?: string | null;
+  /** tier ID */
+  id?: string;
+  /** tier level */
+  level?: number;
+  /** tier name */
+  name?: string | null;
+  /**
+   * name key of the tier
+   *
+   * @example service-registry.tier1.name
+   */
+  nameKey?: string;
+}
+export function registerServiceRegistryValidationSchemas(
+  validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>,
+) {
+  validationSchemaStorage.register(
+    "ServiceRegistry",
+    z
+      .object({
+        description: z.nullable(z.string()).optional(),
+        id: z.string().optional(),
+        name: z.string().optional(),
+        organizationId: z.string().optional(),
+        revision: z.string().optional(),
+        serviceTier: validationSchemaStorage
+          .lazy("ServiceRegistryTier")
+          .optional(),
+      })
+      .catchall(z.unknown())
+      .describe("ServiceRegistry"),
+  );
+  validationSchemaStorage.register(
+    "ServiceRegistryTier",
+    z
+      .object({
+        description: z.nullable(z.string()).optional(),
+        id: z.string().optional(),
+        level: z.number().int().optional(),
+        name: z.nullable(z.string()).optional(),
+        nameKey: z.string().optional(),
+      })
+      .catchall(z.unknown())
+      .describe("ServiceRegistryTier"),
+  );
+}