@resolution/jira-api-client 0.1.0 → 0.1.2

package/src/openapi/platform/models/issue-notification-schemes.ts

@@ -1,370 +0,0 @@
-// 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 FieldDetails,
-  type GroupName,
-  type NotificationScheme,
-  type ProjectRole,
-  registerCommonValidationSchemas,
-  type UserDetails,
-} from "./common";
-/** Details of notifications which should be added to the notification scheme. */
-export interface AddNotificationsDetails extends Record<string, unknown> {
-  /** The list of notifications which should be added to the notification scheme. */
-  notificationSchemeEvents: NotificationSchemeEventDetails[];
-}
-/** Details of an notification scheme. */
-export interface CreateNotificationSchemeDetails
-  extends Record<string, unknown> {
-  /** The description of the notification scheme. */
-  description?: string;
-  /** The name of the notification scheme. Must be unique (case-insensitive). */
-  name: string;
-  /** The list of notifications which should be added to the notification scheme. */
-  notificationSchemeEvents?: NotificationSchemeEventDetails[];
-}
-/** Details about a notification associated with an event. */
-export interface EventNotification {
-  /** The email address. */
-  emailAddress?: string;
-  /**
-   * Expand options that include additional event notification details in the
-   * response.
-   */
-  expand?: string;
-  /** The custom user or group field. */
-  field?: FieldDetails;
-  /** The specified group. */
-  group?: GroupName;
-  /** The ID of the notification. */
-  id?: number;
-  /** Identifies the recipients of the notification. */
-  notificationType?:
-    | "CurrentAssignee"
-    | "Reporter"
-    | "CurrentUser"
-    | "ProjectLead"
-    | "ComponentLead"
-    | "User"
-    | "Group"
-    | "ProjectRole"
-    | "EmailAddress"
-    | "AllWatchers"
-    | "UserCustomField"
-    | "GroupCustomField";
-  /**
-   * As a group's name can change, use of `recipient` is recommended. The identifier
-   * associated with the `notificationType` value that defines the receiver of the
-   * notification, where the receiver isn't implied by `notificationType` value. So,
-   * when `notificationType` is:
-   *
-   *  *  `User` The `parameter` is the user account ID.
-   *  *  `Group` The `parameter` is the group name.
-   *  *  `ProjectRole` The `parameter` is the project role ID.
-   *  *  `UserCustomField` The `parameter` is the ID of the custom field.
-   *  *  `GroupCustomField` The `parameter` is the ID of the custom field.
-   */
-  parameter?: string;
-  /** The specified project role. */
-  projectRole?: ProjectRole;
-  /**
-   * The identifier associated with the `notificationType` value that defines the
-   * receiver of the notification, where the receiver isn't implied by the
-   * `notificationType` value. So, when `notificationType` is:
-   *
-   *  *  `User`, `recipient` is the user account ID.
-   *  *  `Group`, `recipient` is the group ID.
-   *  *  `ProjectRole`, `recipient` is the project role ID.
-   *  *  `UserCustomField`, `recipient` is the ID of the custom field.
-   *  *  `GroupCustomField`, `recipient` is the ID of the custom field.
-   */
-  recipient?: string;
-  /** The specified user. */
-  user?: UserDetails;
-}
-/** Details about a notification event. */
-export interface NotificationEvent {
-  /** The description of the event. */
-  description?: string;
-  /**
-   * The ID of the event. The event can be a [Jira system
-   * event](https://confluence.atlassian.com/x/8YdKLg#Creatinganotificationscheme-eventsEvents)
-   * or a [custom event](https://confluence.atlassian.com/x/AIlKLg).
-   */
-  id?: number;
-  /** The name of the event. */
-  name?: string;
-  /**
-   * The template of the event. Only custom events configured by Jira administrators
-   * have template.
-   */
-  templateEvent?: NotificationEvent;
-}
-export interface NotificationSchemeAndProjectMappingJsonBean {
-  notificationSchemeId?: string;
-  projectId?: string;
-}
-/** Details about a notification scheme event. */
-export interface NotificationSchemeEvent {
-  /** Details about a notification event. */
-  event?: NotificationEvent;
-  notifications?: EventNotification[];
-}
-/** Details of a notification scheme event. */
-export interface NotificationSchemeEventDetails
-  extends Record<string, unknown> {
-  /** The ID of the event. */
-  event: NotificationSchemeEventTypeId;
-  /** The list of notifications mapped to a specified event. */
-  notifications: NotificationSchemeNotificationDetails[];
-}
-/** The ID of an event that is being mapped to notifications. */
-export interface NotificationSchemeEventTypeId extends Record<string, unknown> {
-  /** The ID of the notification scheme event. */
-  id: string;
-}
-/** The ID of a notification scheme. */
-export interface NotificationSchemeId extends Record<string, unknown> {
-  /** The ID of a notification scheme. */
-  id: string;
-}
-/** Details of a notification within a notification scheme. */
-export interface NotificationSchemeNotificationDetails
-  extends Record<string, unknown> {
-  /** The notification type, e.g `CurrentAssignee`, `Group`, `EmailAddress`. */
-  notificationType: string;
-  /** The value corresponding to the specified notification type. */
-  parameter?: string;
-}
-/** A page of items. */
-export interface PageBeanNotificationScheme {
-  /** 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?: NotificationScheme[];
-}
-/** A page of items. */
-export interface PageBeanNotificationSchemeAndProjectMappingJsonBean {
-  /** 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?: NotificationSchemeAndProjectMappingJsonBean[];
-}
-/** Details of a notification scheme. */
-export interface UpdateNotificationSchemeDetails
-  extends Record<string, unknown> {
-  /** The description of the notification scheme. */
-  description?: string;
-  /** The name of the notification scheme. Must be unique. */
-  name?: string;
-}
-export function registerIssueNotificationSchemesValidationSchemas(
-  validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>,
-) {
-  validationSchemaStorage.register(
-    "AddNotificationsDetails",
-    z
-      .object({
-        notificationSchemeEvents: z.array(
-          validationSchemaStorage.lazy("NotificationSchemeEventDetails"),
-        ),
-      })
-      .catchall(z.unknown())
-      .describe("AddNotificationsDetails"),
-  );
-  validationSchemaStorage.register(
-    "CreateNotificationSchemeDetails",
-    z
-      .object({
-        description: z.string().max(4000).optional(),
-        name: z.string().max(255),
-        notificationSchemeEvents: z
-          .array(validationSchemaStorage.lazy("NotificationSchemeEventDetails"))
-          .optional(),
-      })
-      .catchall(z.unknown())
-      .describe("CreateNotificationSchemeDetails"),
-  );
-  validationSchemaStorage.register(
-    "EventNotification",
-    z
-      .object({
-        emailAddress: z.string().optional(),
-        expand: z.string().optional(),
-        field: validationSchemaStorage.lazy("FieldDetails").optional(),
-        group: validationSchemaStorage.lazy("GroupName").optional(),
-        id: z.number().int().optional(),
-        notificationType: z
-          .enum([
-            "CurrentAssignee",
-            "Reporter",
-            "CurrentUser",
-            "ProjectLead",
-            "ComponentLead",
-            "User",
-            "Group",
-            "ProjectRole",
-            "EmailAddress",
-            "AllWatchers",
-            "UserCustomField",
-            "GroupCustomField",
-          ])
-          .optional(),
-        parameter: z.string().optional(),
-        projectRole: validationSchemaStorage.lazy("ProjectRole").optional(),
-        recipient: z.string().optional(),
-        user: validationSchemaStorage.lazy("UserDetails").optional(),
-      })
-      .strict()
-      .describe("EventNotification"),
-  );
-  validationSchemaStorage.register(
-    "NotificationEvent",
-    z
-      .object({
-        description: z.string().optional(),
-        id: z.number().int().optional(),
-        name: z.string().optional(),
-        templateEvent: validationSchemaStorage
-          .lazy("NotificationEvent")
-          .optional(),
-      })
-      .strict()
-      .describe("NotificationEvent"),
-  );
-  validationSchemaStorage.register(
-    "NotificationSchemeAndProjectMappingJsonBean",
-    z
-      .object({
-        notificationSchemeId: z.string().optional(),
-        projectId: z.string().optional(),
-      })
-      .strict()
-      .describe("NotificationSchemeAndProjectMappingJsonBean"),
-  );
-  validationSchemaStorage.register(
-    "NotificationSchemeEvent",
-    z
-      .object({
-        event: validationSchemaStorage.lazy("NotificationEvent").optional(),
-        notifications: z
-          .array(validationSchemaStorage.lazy("EventNotification"))
-          .optional(),
-      })
-      .strict()
-      .describe("NotificationSchemeEvent"),
-  );
-  validationSchemaStorage.register(
-    "NotificationSchemeEventDetails",
-    z
-      .object({
-        event: validationSchemaStorage.lazy("NotificationSchemeEventTypeId"),
-        notifications: z.array(
-          validationSchemaStorage.lazy("NotificationSchemeNotificationDetails"),
-        ),
-      })
-      .catchall(z.unknown())
-      .describe("NotificationSchemeEventDetails"),
-  );
-  validationSchemaStorage.register(
-    "NotificationSchemeEventTypeId",
-    z
-      .object({
-        id: z.string(),
-      })
-      .catchall(z.unknown())
-      .describe("NotificationSchemeEventTypeId"),
-  );
-  validationSchemaStorage.register(
-    "NotificationSchemeId",
-    z
-      .object({
-        id: z.string(),
-      })
-      .catchall(z.unknown())
-      .describe("NotificationSchemeId"),
-  );
-  validationSchemaStorage.register(
-    "NotificationSchemeNotificationDetails",
-    z
-      .object({
-        notificationType: z.string(),
-        parameter: z.string().optional(),
-      })
-      .catchall(z.unknown())
-      .describe("NotificationSchemeNotificationDetails"),
-  );
-  validationSchemaStorage.register(
-    "PageBeanNotificationScheme",
-    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("NotificationScheme"))
-          .optional(),
-      })
-      .strict()
-      .describe("PageBeanNotificationScheme"),
-  );
-  validationSchemaStorage.register(
-    "PageBeanNotificationSchemeAndProjectMappingJsonBean",
-    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(
-              "NotificationSchemeAndProjectMappingJsonBean",
-            ),
-          )
-          .optional(),
-      })
-      .strict()
-      .describe("PageBeanNotificationSchemeAndProjectMappingJsonBean"),
-  );
-  validationSchemaStorage.register(
-    "UpdateNotificationSchemeDetails",
-    z
-      .object({
-        description: z.string().max(4000).optional(),
-        name: z.string().max(255).optional(),
-      })
-      .catchall(z.unknown())
-      .describe("UpdateNotificationSchemeDetails"),
-  );
-  validationSchemaStorage.registerOnce([registerCommonValidationSchemas]);
-}

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

@@ -1,196 +0,0 @@
-// 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 Priority, registerCommonValidationSchemas } from "./common";
-/** Details of an issue priority. */
-export interface CreatePriorityDetails extends Record<string, unknown> {
-  /** The description of the priority. */
-  description?: string;
-  /**
-   * The URL of an icon for the priority. Accepted protocols are HTTP and HTTPS.
-   * Built in icons can also be used.
-   */
-  iconUrl?:
-    | "/images/icons/priorities/blocker.png"
-    | "/images/icons/priorities/critical.png"
-    | "/images/icons/priorities/high.png"
-    | "/images/icons/priorities/highest.png"
-    | "/images/icons/priorities/low.png"
-    | "/images/icons/priorities/lowest.png"
-    | "/images/icons/priorities/major.png"
-    | "/images/icons/priorities/medium.png"
-    | "/images/icons/priorities/minor.png"
-    | "/images/icons/priorities/trivial.png";
-  /** The name of the priority. Must be unique. */
-  name: string;
-  /** The status color of the priority in 3-digit or 6-digit hexadecimal format. */
-  statusColor: string;
-}
-/** A page of items. */
-export interface PageBeanPriority {
-  /** 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?: Priority[];
-}
-/** The ID of an issue priority. */
-export interface PriorityId extends Record<string, unknown> {
-  /** The ID of the issue priority. */
-  id: string;
-}
-/** Change the order of issue priorities. */
-export interface ReorderIssuePriorities {
-  /** The ID of the priority. Required if `position` isn't provided. */
-  after?: string;
-  /** The list of issue IDs to be reordered. Cannot contain duplicates nor after ID. */
-  ids: string[];
-  /**
-   * The position for issue priorities to be moved to. Required if `after` isn't
-   * provided.
-   */
-  position?: string;
-}
-/** The new default issue priority. */
-export interface SetDefaultPriorityRequest {
-  /**
-   * The ID of the new default issue priority. Must be an existing ID or null.
-   * Setting this to null erases the default priority setting.
-   */
-  id: string;
-}
-/** Details of an issue priority. */
-export interface UpdatePriorityDetails extends Record<string, unknown> {
-  /** The description of the priority. */
-  description?: string;
-  /**
-   * The URL of an icon for the priority. Accepted protocols are HTTP and HTTPS.
-   * Built in icons can also be used.
-   */
-  iconUrl?:
-    | "/images/icons/priorities/blocker.png"
-    | "/images/icons/priorities/critical.png"
-    | "/images/icons/priorities/high.png"
-    | "/images/icons/priorities/highest.png"
-    | "/images/icons/priorities/low.png"
-    | "/images/icons/priorities/lowest.png"
-    | "/images/icons/priorities/major.png"
-    | "/images/icons/priorities/medium.png"
-    | "/images/icons/priorities/minor.png"
-    | "/images/icons/priorities/trivial.png";
-  /** The name of the priority. Must be unique. */
-  name?: string;
-  /** The status color of the priority in 3-digit or 6-digit hexadecimal format. */
-  statusColor?: string;
-}
-export function registerIssuePrioritiesValidationSchemas(
-  validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>,
-) {
-  validationSchemaStorage.register(
-    "CreatePriorityDetails",
-    z
-      .object({
-        description: z.string().max(255).optional(),
-        iconUrl: z
-          .enum([
-            "/images/icons/priorities/blocker.png",
-            "/images/icons/priorities/critical.png",
-            "/images/icons/priorities/high.png",
-            "/images/icons/priorities/highest.png",
-            "/images/icons/priorities/low.png",
-            "/images/icons/priorities/lowest.png",
-            "/images/icons/priorities/major.png",
-            "/images/icons/priorities/medium.png",
-            "/images/icons/priorities/minor.png",
-            "/images/icons/priorities/trivial.png",
-          ])
-          .optional(),
-        name: z.string().max(60),
-        statusColor: z.string(),
-      })
-      .catchall(z.unknown())
-      .describe("CreatePriorityDetails"),
-  );
-  validationSchemaStorage.register(
-    "PageBeanPriority",
-    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("Priority")).optional(),
-      })
-      .strict()
-      .describe("PageBeanPriority"),
-  );
-  validationSchemaStorage.register(
-    "PriorityId",
-    z
-      .object({
-        id: z.string(),
-      })
-      .catchall(z.unknown())
-      .describe("PriorityId"),
-  );
-  validationSchemaStorage.register(
-    "ReorderIssuePriorities",
-    z
-      .object({
-        after: z.string().optional(),
-        ids: z.array(z.string()),
-        position: z.string().optional(),
-      })
-      .strict()
-      .describe("ReorderIssuePriorities"),
-  );
-  validationSchemaStorage.register(
-    "SetDefaultPriorityRequest",
-    z
-      .object({
-        id: z.string(),
-      })
-      .strict()
-      .describe("SetDefaultPriorityRequest"),
-  );
-  validationSchemaStorage.register(
-    "UpdatePriorityDetails",
-    z
-      .object({
-        description: z.string().max(255).optional(),
-        iconUrl: z
-          .enum([
-            "/images/icons/priorities/blocker.png",
-            "/images/icons/priorities/critical.png",
-            "/images/icons/priorities/high.png",
-            "/images/icons/priorities/highest.png",
-            "/images/icons/priorities/low.png",
-            "/images/icons/priorities/lowest.png",
-            "/images/icons/priorities/major.png",
-            "/images/icons/priorities/medium.png",
-            "/images/icons/priorities/minor.png",
-            "/images/icons/priorities/trivial.png",
-          ])
-          .optional(),
-        name: z.string().max(60).optional(),
-        statusColor: z.string().optional(),
-      })
-      .catchall(z.unknown())
-      .describe("UpdatePriorityDetails"),
-  );
-  validationSchemaStorage.registerOnce([registerCommonValidationSchemas]);
-}