@resolution/jira-api-client 0.1.0

package/src/openapi/platform/core/common-http-service.ts

@@ -0,0 +1,22 @@
+// DO NOT EDIT!
+// This file is generated by "api-typescript-generator".
+// To update this file run "yarn build:openapi".
+import type * as commonHttpClient from "./common-http-client";
+export class CommonHttpService {
+  protected getClientInstance: () => commonHttpClient.CommonHttpClient;
+  constructor(getClientInstance: () => commonHttpClient.CommonHttpClient) {
+    this.getClientInstance = () => {
+      const classInstance = this.constructor as typeof CommonHttpService;
+      if (classInstance.initialized !== true) {
+        classInstance.initialized = true;
+        if (classInstance.initialize !== undefined) {
+          classInstance.initialize();
+        }
+      }
+      this.getClientInstance = getClientInstance;
+      return getClientInstance();
+    };
+  }
+  protected static initialized: boolean | undefined;
+  protected static initialize: (() => void) | undefined;
+}

package/src/openapi/platform/core/common-validation-schema-storage.ts

@@ -0,0 +1,105 @@
+// DO NOT EDIT!
+// This file is generated by "api-typescript-generator".
+// To update this file run "yarn build:openapi".
+import {
+  CommonHttpClientError,
+  type CommonHttpClientFetchResponse,
+  type CommonHttpClientOptions,
+  isJsonMediaType,
+} from "./common-http-client";
+type CommonValidationSchemaStorageAssertDataShape<T> = <D>(
+  schema: T,
+  data: D,
+) => void;
+type RegisterOnceCallback<T> = (
+  validationSchemaStorage: CommonValidationSchemaStorage<T>,
+) => void;
+type CommonValidationSchemaStorageMakeExtensible<T> = (schema: T) => T;
+type CommonValidationSchemaStorageFormatErrorMessage<T> = (
+  error: Error,
+  schema: T,
+) => string;
+type CommonValidationSchemaStorageLazyGetter<T> = (callback: () => T) => T;
+export class CommonValidationSchemaStorage<T> {
+  protected assertDataShape: CommonValidationSchemaStorageAssertDataShape<T>;
+  protected makeExtensible: CommonValidationSchemaStorageMakeExtensible<T>;
+  protected schemas: Record<string, T> = {};
+  protected registeredCallbacks = new Set<RegisterOnceCallback<T>>();
+  protected errorClass: CommonHttpClientOptions["errorClass"] =
+    CommonHttpClientError;
+  protected formatErrorMessage: CommonValidationSchemaStorageFormatErrorMessage<T>;
+  protected lazyGetter: CommonValidationSchemaStorageLazyGetter<T>;
+  constructor({
+    assertDataShape,
+    makeExtensible,
+    formatErrorMessage,
+    lazyGetter,
+  }: {
+    assertDataShape: CommonValidationSchemaStorageAssertDataShape<T>;
+    makeExtensible: CommonValidationSchemaStorageMakeExtensible<T>;
+    formatErrorMessage: CommonValidationSchemaStorageFormatErrorMessage<T>;
+    lazyGetter: CommonValidationSchemaStorageLazyGetter<T>;
+  }) {
+    this.assertDataShape = assertDataShape;
+    this.makeExtensible = makeExtensible;
+    this.formatErrorMessage = formatErrorMessage;
+    this.lazyGetter = lazyGetter;
+  }
+  register(key: string, schema: T) {
+    this.schemas[key] = schema;
+  }
+  registerExtensible(key: string, schema: T) {
+    this.schemas[key] = this.makeExtensible(schema);
+  }
+  registerOnce(callbacks: RegisterOnceCallback<T>[]) {
+    for (const callback of callbacks) {
+      if (!this.registeredCallbacks.has(callback)) {
+        this.registeredCallbacks.add(callback);
+        callback(this);
+      }
+    }
+  }
+  get(key: string): T {
+    return this.schemas[key];
+  }
+  lazy(key: string): T {
+    return this.lazyGetter(() => this.schemas[key]);
+  }
+  validator<
+    D extends {
+      mediaType: string;
+      status: number;
+      body: unknown;
+      response: CommonHttpClientFetchResponse;
+    },
+  >(key: string): (data: D) => D {
+    return (data: D) => {
+      const schema = this.schemas[key];
+      if (schema === undefined) {
+        throw new Error(`Schema with key "${key}" not found`);
+      }
+      if (data.mediaType !== undefined && isJsonMediaType(data.mediaType)) {
+        try {
+          this.assertDataShape(schema, data);
+        } catch (error) {
+          throw new this.errorClass(
+            new URL(data.response.url),
+            undefined,
+            data.response,
+            undefined,
+            error instanceof Error
+              ? this.formatErrorMessage(error, schema)
+              : String(error),
+          );
+        }
+      }
+      return data;
+    };
+  }
+  getErrorClass() {
+    return this.errorClass;
+  }
+  setErrorClass(errorClass: CommonHttpClientOptions["errorClass"]) {
+    this.errorClass = errorClass;
+  }
+}

package/src/openapi/platform/models/announcement-banner.ts

@@ -0,0 +1,59 @@
+// 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";
+/** Announcement banner configuration. */
+export interface AnnouncementBannerConfiguration {
+  /** Hash of the banner data. The client detects updates by comparing hash IDs. */
+  hashId?: string;
+  /** Flag indicating if the announcement banner can be dismissed by the user. */
+  isDismissible?: boolean;
+  /** Flag indicating if the announcement banner is enabled or not. */
+  isEnabled?: boolean;
+  /** The text on the announcement banner. */
+  message?: string;
+  /** Visibility of the announcement banner. */
+  visibility?: "PUBLIC" | "PRIVATE";
+}
+/** Configuration of the announcement banner. */
+export interface AnnouncementBannerConfigurationUpdate {
+  /** Flag indicating if the announcement banner can be dismissed by the user. */
+  isDismissible?: boolean;
+  /** Flag indicating if the announcement banner is enabled or not. */
+  isEnabled?: boolean;
+  /** The text on the announcement banner. */
+  message?: string;
+  /** Visibility of the announcement banner. Can be public or private. */
+  visibility?: string;
+}
+export function registerAnnouncementBannerValidationSchemas(
+  validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>,
+) {
+  validationSchemaStorage.register(
+    "AnnouncementBannerConfiguration",
+    z
+      .object({
+        hashId: z.string().optional(),
+        isDismissible: z.boolean().optional(),
+        isEnabled: z.boolean().optional(),
+        message: z.string().optional(),
+        visibility: z.enum(["PUBLIC", "PRIVATE"]).optional(),
+      })
+      .strict()
+      .describe("AnnouncementBannerConfiguration"),
+  );
+  validationSchemaStorage.register(
+    "AnnouncementBannerConfigurationUpdate",
+    z
+      .object({
+        isDismissible: z.boolean().optional(),
+        isEnabled: z.boolean().optional(),
+        message: z.string().optional(),
+        visibility: z.string().optional(),
+      })
+      .strict()
+      .describe("AnnouncementBannerConfigurationUpdate"),
+  );
+}

package/src/openapi/platform/models/app-data-policies.ts

@@ -0,0 +1,79 @@
+// 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";
+/** Details about data policies for a list of projects. */
+export interface ProjectDataPolicies {
+  /** List of projects with data policies. */
+  projectDataPolicies?: ProjectWithDataPolicy[];
+}
+/** Details about data policy. */
+export interface ProjectDataPolicy {
+  /**
+   * Whether the project contains any content inaccessible to the requesting
+   * application.
+   */
+  anyContentBlocked?: boolean;
+}
+/** Details about data policies for a project. */
+export interface ProjectWithDataPolicy {
+  /** Data policy. */
+  dataPolicy?: ProjectDataPolicy;
+  /** The project ID. */
+  id?: number;
+}
+/** Details about data policy. */
+export interface WorkspaceDataPolicy {
+  /**
+   * Whether the workspace contains any content inaccessible to the requesting
+   * application.
+   */
+  anyContentBlocked?: boolean;
+}
+export function registerAppDataPoliciesValidationSchemas(
+  validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>,
+) {
+  validationSchemaStorage.register(
+    "ProjectDataPolicies",
+    z
+      .object({
+        projectDataPolicies: z
+          .array(validationSchemaStorage.lazy("ProjectWithDataPolicy"))
+          .optional(),
+      })
+      .strict()
+      .describe("ProjectDataPolicies"),
+  );
+  validationSchemaStorage.register(
+    "ProjectDataPolicy",
+    z
+      .object({
+        anyContentBlocked: z.boolean().optional(),
+      })
+      .strict()
+      .describe("ProjectDataPolicy"),
+  );
+  validationSchemaStorage.register(
+    "ProjectWithDataPolicy",
+    z
+      .object({
+        dataPolicy: validationSchemaStorage
+          .lazy("ProjectDataPolicy")
+          .optional(),
+        id: z.number().int().optional(),
+      })
+      .strict()
+      .describe("ProjectWithDataPolicy"),
+  );
+  validationSchemaStorage.register(
+    "WorkspaceDataPolicy",
+    z
+      .object({
+        anyContentBlocked: z.boolean().optional(),
+      })
+      .strict()
+      .describe("WorkspaceDataPolicy"),
+  );
+}

package/src/openapi/platform/models/app-migration.ts

@@ -0,0 +1,172 @@
+// 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 WorkflowTransitionRules,
+} from "./common";
+/** A list of custom field details. */
+export interface ConnectCustomFieldValue extends Record<string, unknown> {
+  /** The type of custom field. */
+  _type:
+    | "StringIssueField"
+    | "NumberIssueField"
+    | "RichTextIssueField"
+    | "SingleSelectIssueField"
+    | "MultiSelectIssueField"
+    | "TextIssueField";
+  /** The custom field ID. */
+  fieldID: number;
+  /** The issue ID. */
+  issueID: number;
+  /** The value of number type custom field when `_type` is `NumberIssueField`. */
+  number?: number;
+  /**
+   * The value of single select and multiselect custom field type when `_type` is
+   * `SingleSelectIssueField` or `MultiSelectIssueField`.
+   */
+  optionID?: string;
+  /** The value of richText type custom field when `_type` is `RichTextIssueField`. */
+  richText?: string;
+  /** The value of string type custom field when `_type` is `StringIssueField`. */
+  string?: string;
+  /** The value of of text custom field type when `_type` is `TextIssueField`. */
+  text?: string;
+}
+/** Details of updates for a custom field. */
+export interface ConnectCustomFieldValues {
+  /** The list of custom field update details. */
+  updateValueList?: ConnectCustomFieldValue[];
+}
+export interface EntityPropertyDetails extends Record<string, unknown> {
+  /**
+   * The entity property ID.
+   *
+   * @example 123
+   */
+  entityId: number;
+  /**
+   * The entity property key.
+   *
+   * @example mykey
+   */
+  key: string;
+  /**
+   * The new value of the entity property.
+   *
+   * @example newValue
+   */
+  value: string;
+}
+/** Details of the workflow and its transition rules. */
+export interface WorkflowRulesSearch extends Record<string, unknown> {
+  /**
+   * Use expand to include additional information in the response. This parameter
+   * accepts `transition` which, for each rule, returns information about the
+   * transition the rule is assigned to.
+   *
+   * @example transition
+   */
+  expand?: string;
+  /** The list of workflow rule IDs. */
+  ruleIds: string[];
+  /**
+   * The workflow ID.
+   *
+   * @example a498d711-685d-428d-8c3e-bc03bb450ea7
+   */
+  workflowEntityId: string;
+}
+/** Details of workflow transition rules. */
+export interface WorkflowRulesSearchDetails extends Record<string, unknown> {
+  /**
+   * List of workflow rule IDs that do not belong to the workflow or can not be
+   * found.
+   */
+  invalidRules?: string[];
+  /** List of valid workflow transition rules. */
+  validRules?: WorkflowTransitionRules[];
+  /**
+   * The workflow ID.
+   *
+   * @example a498d711-685d-428d-8c3e-bc03bb450ea7
+   */
+  workflowEntityId?: string;
+}
+export function registerAppMigrationValidationSchemas(
+  validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>,
+) {
+  validationSchemaStorage.register(
+    "ConnectCustomFieldValue",
+    z
+      .object({
+        _type: z.enum([
+          "StringIssueField",
+          "NumberIssueField",
+          "RichTextIssueField",
+          "SingleSelectIssueField",
+          "MultiSelectIssueField",
+          "TextIssueField",
+        ]),
+        fieldID: z.number().int(),
+        issueID: z.number().int(),
+        number: z.number().optional(),
+        optionID: z.string().optional(),
+        richText: z.string().optional(),
+        string: z.string().optional(),
+        text: z.string().optional(),
+      })
+      .catchall(z.unknown())
+      .describe("ConnectCustomFieldValue"),
+  );
+  validationSchemaStorage.register(
+    "ConnectCustomFieldValues",
+    z
+      .object({
+        updateValueList: z
+          .array(validationSchemaStorage.lazy("ConnectCustomFieldValue"))
+          .optional(),
+      })
+      .strict()
+      .describe("ConnectCustomFieldValues"),
+  );
+  validationSchemaStorage.register(
+    "EntityPropertyDetails",
+    z
+      .object({
+        entityId: z.number(),
+        key: z.string(),
+        value: z.string(),
+      })
+      .catchall(z.unknown())
+      .describe("EntityPropertyDetails"),
+  );
+  validationSchemaStorage.register(
+    "WorkflowRulesSearch",
+    z
+      .object({
+        expand: z.string().optional(),
+        ruleIds: z.array(z.string()).min(1).max(10),
+        workflowEntityId: z.string(),
+      })
+      .catchall(z.unknown())
+      .describe("WorkflowRulesSearch"),
+  );
+  validationSchemaStorage.register(
+    "WorkflowRulesSearchDetails",
+    z
+      .object({
+        invalidRules: z.array(z.string()).optional(),
+        validRules: z
+          .array(validationSchemaStorage.lazy("WorkflowTransitionRules"))
+          .optional(),
+        workflowEntityId: z.string().optional(),
+      })
+      .catchall(z.unknown())
+      .describe("WorkflowRulesSearchDetails"),
+  );
+  validationSchemaStorage.registerOnce([registerCommonValidationSchemas]);
+}

package/src/openapi/platform/models/app-properties.ts

@@ -0,0 +1,32 @@
+// 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";
+/**
+ * @example {
+ *     "message": "An example message.",
+ *     "statusCode": 200
+ * }
+ */
+export interface OperationMessage {
+  /** The human-readable message that describes the result. */
+  message: string;
+  /** The status code of the response. */
+  statusCode: number;
+}
+export function registerAppPropertiesValidationSchemas(
+  validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>,
+) {
+  validationSchemaStorage.register(
+    "OperationMessage",
+    z
+      .object({
+        message: z.string(),
+        statusCode: z.number().int(),
+      })
+      .strict()
+      .describe("OperationMessage"),
+  );
+}

package/src/openapi/platform/models/audit-records.ts

@@ -0,0 +1,140 @@
+// 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";
+/** Details of an item associated with the changed record. */
+export interface AssociatedItemBean {
+  /** The ID of the associated record. */
+  id?: string;
+  /** The name of the associated record. */
+  name?: string;
+  /** The ID of the associated parent record. */
+  parentId?: string;
+  /** The name of the associated parent record. */
+  parentName?: string;
+  /** The type of the associated record. */
+  typeName?: string;
+}
+/** An audit record. */
+export interface AuditRecordBean {
+  /** The list of items associated with the changed record. */
+  associatedItems?: AssociatedItemBean[];
+  /**
+   * Deprecated, use `authorAccountId` instead. The key of the user who created the
+   * audit record.
+   *
+   * @deprecated
+   */
+  authorKey?: string;
+  /**
+   * The category of the audit record. For a list of these categories, see the help
+   * article [Auditing in Jira
+   * applications](https://confluence.atlassian.com/x/noXKM).
+   */
+  category?: string;
+  /** The list of values changed in the record event. */
+  changedValues?: ChangedValueBean[];
+  /** The date and time on which the audit record was created. */
+  created?: string;
+  /** The description of the audit record. */
+  description?: string;
+  /** The event the audit record originated from. */
+  eventSource?: string;
+  /** The ID of the audit record. */
+  id?: number;
+  /** Details of an item associated with the changed record. */
+  objectItem?: AssociatedItemBean;
+  /** The URL of the computer where the creation of the audit record was initiated. */
+  remoteAddress?: string;
+  /** The summary of the audit record. */
+  summary?: string;
+}
+/** Container for a list of audit records. */
+export interface AuditRecords {
+  /** The requested or default limit on the number of audit items to be returned. */
+  limit?: number;
+  /** The number of audit items skipped before the first item in this list. */
+  offset?: number;
+  /** The list of audit items. */
+  records?: AuditRecordBean[];
+  /** The total number of audit items returned. */
+  total?: number;
+}
+/** Details of names changed in the record event. */
+export interface ChangedValueBean {
+  /** The value of the field before the change. */
+  changedFrom?: string;
+  /** The value of the field after the change. */
+  changedTo?: string;
+  /** The name of the field changed. */
+  fieldName?: string;
+}
+export function registerAuditRecordsValidationSchemas(
+  validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>,
+) {
+  validationSchemaStorage.register(
+    "AssociatedItemBean",
+    z
+      .object({
+        id: z.string().optional(),
+        name: z.string().optional(),
+        parentId: z.string().optional(),
+        parentName: z.string().optional(),
+        typeName: z.string().optional(),
+      })
+      .strict()
+      .describe("AssociatedItemBean"),
+  );
+  validationSchemaStorage.register(
+    "AuditRecordBean",
+    z
+      .object({
+        associatedItems: z
+          .array(validationSchemaStorage.lazy("AssociatedItemBean"))
+          .optional(),
+        authorKey: z.string().optional(),
+        category: z.string().optional(),
+        changedValues: z
+          .array(validationSchemaStorage.lazy("ChangedValueBean"))
+          .optional(),
+        created: z.string().optional(),
+        description: z.string().optional(),
+        eventSource: z.string().optional(),
+        id: z.number().int().optional(),
+        objectItem: validationSchemaStorage
+          .lazy("AssociatedItemBean")
+          .optional(),
+        remoteAddress: z.string().optional(),
+        summary: z.string().optional(),
+      })
+      .strict()
+      .describe("AuditRecordBean"),
+  );
+  validationSchemaStorage.register(
+    "AuditRecords",
+    z
+      .object({
+        limit: z.number().int().optional(),
+        offset: z.number().int().optional(),
+        records: z
+          .array(validationSchemaStorage.lazy("AuditRecordBean"))
+          .optional(),
+        total: z.number().int().optional(),
+      })
+      .strict()
+      .describe("AuditRecords"),
+  );
+  validationSchemaStorage.register(
+    "ChangedValueBean",
+    z
+      .object({
+        changedFrom: z.string().optional(),
+        changedTo: z.string().optional(),
+        fieldName: z.string().optional(),
+      })
+      .strict()
+      .describe("ChangedValueBean"),
+  );
+}

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

@@ -0,0 +1,48 @@
+// 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";
+/** Details about system and custom avatars. */
+export interface Avatars {
+  /** Custom avatars list. */
+  custom?: Avatar[];
+  /** System avatars list. */
+  system?: Avatar[];
+}
+export interface StreamingResponseBody {}
+/** List of system avatars. */
+export interface SystemAvatars {
+  /** A list of avatar details. */
+  system?: Avatar[];
+}
+export function registerAvatarsValidationSchemas(
+  validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>,
+) {
+  validationSchemaStorage.register(
+    "Avatars",
+    z
+      .object({
+        custom: z.array(validationSchemaStorage.lazy("Avatar")).optional(),
+        system: z.array(validationSchemaStorage.lazy("Avatar")).optional(),
+      })
+      .strict()
+      .describe("Avatars"),
+  );
+  validationSchemaStorage.register(
+    "StreamingResponseBody",
+    z.object({}).strict().describe("StreamingResponseBody"),
+  );
+  validationSchemaStorage.register(
+    "SystemAvatars",
+    z
+      .object({
+        system: z.array(validationSchemaStorage.lazy("Avatar")).optional(),
+      })
+      .strict()
+      .describe("SystemAvatars"),
+  );
+  validationSchemaStorage.registerOnce([registerCommonValidationSchemas]);
+}