@resolution/jira-api-client 0.1.0 → 0.1.2

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

@@ -1,259 +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 JsonNode, registerCommonValidationSchemas } from "./common";
-/** Bulk issue property update request details. */
-export interface BulkIssuePropertyUpdateRequest {
-  /**
-   * EXPERIMENTAL. The Jira expression to calculate the value of the property. The
-   * value of the expression must be an object that can be converted to JSON, such
-   * as a number, boolean, string, list, or map. The context variables available to
-   * the expression are `issue` and `user`. Issues for which the expression returns
-   * a value whose JSON representation is longer than 32768 characters are ignored.
-   */
-  expression?: string;
-  /** The bulk operation filter. */
-  filter?: IssueFilterForBulkPropertySet;
-  /**
-   * The value of the property. The value must be a
-   * [valid](https://tools.ietf.org/html/rfc4627), non-empty JSON blob. The maximum
-   * length is 32768 characters.
-   */
-  value?: unknown;
-}
-/**
- * Lists of issues and entity properties. See [Entity
- * properties](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/)
- * for more information.
- */
-export interface IssueEntityProperties {
-  /** A list of entity property IDs. */
-  entitiesIds?: number[];
-  /** A list of entity property keys and values. */
-  properties?: {
-    [key: string]: JsonNode;
-  };
-}
-/**
- * An issue ID with entity property values. See [Entity
- * properties](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/)
- * for more information.
- */
-export interface IssueEntityPropertiesForMultiUpdate {
-  /** The ID of the issue. */
-  issueID?: number;
-  /**
-   * Entity properties to set on the issue. The maximum length of an issue property
-   * value is 32768 characters.
-   */
-  properties?: {
-    [key: string]: JsonNode;
-  };
-}
-/** Bulk operation filter details. */
-export interface IssueFilterForBulkPropertyDelete {
-  /** The value of properties to perform the bulk operation on. */
-  currentValue?: unknown;
-  /** List of issues to perform the bulk delete operation on. */
-  entityIds?: number[];
-}
-/** Bulk operation filter details. */
-export interface IssueFilterForBulkPropertySet {
-  /** The value of properties to perform the bulk operation on. */
-  currentValue?: unknown;
-  /** List of issues to perform the bulk operation on. */
-  entityIds?: number[];
-  /**
-   * Whether the bulk operation occurs only when the property is present on or
-   * absent from an issue.
-   */
-  hasProperty?: boolean;
-}
-/**
- * A list of issues and their respective properties to set or update. See [Entity
- * properties](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/)
- * for more information.
- */
-export interface MultiIssueEntityProperties {
-  /** A list of issue IDs and their respective properties. */
-  issues?: IssueEntityPropertiesForMultiUpdate[];
-}
-export function registerIssuePropertiesValidationSchemas(
-  validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>,
-) {
-  validationSchemaStorage.register(
-    "BulkIssuePropertyUpdateRequest",
-    z
-      .object({
-        expression: z.string().optional(),
-        filter: validationSchemaStorage
-          .lazy("IssueFilterForBulkPropertySet")
-          .optional(),
-        value: z.unknown().optional(),
-      })
-      .strict()
-      .describe("BulkIssuePropertyUpdateRequest"),
-  );
-  validationSchemaStorage.register(
-    "IssueEntityProperties",
-    z
-      .object({
-        entitiesIds: z
-          .array(z.number().int())
-          .min(1)
-          .max(10000)
-          .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",
-              });
-            }
-          })
-          .optional(),
-        properties: z
-          .object({})
-          .catchall(validationSchemaStorage.lazy("JsonNode"))
-          .superRefine((obj, ctx) => {
-            if (Object.keys(obj).length < 1) {
-              ctx.addIssue({
-                code: z.ZodIssueCode.custom,
-                path: [],
-                message: "Should have at least 1 properties",
-              });
-            }
-          })
-          .superRefine((obj, ctx) => {
-            if (Object.keys(obj).length > 10) {
-              ctx.addIssue({
-                code: z.ZodIssueCode.custom,
-                path: [],
-                message: "Should have at most 10 properties",
-              });
-            }
-          })
-          .optional(),
-      })
-      .strict()
-      .describe("IssueEntityProperties"),
-  );
-  validationSchemaStorage.register(
-    "IssueEntityPropertiesForMultiUpdate",
-    z
-      .object({
-        issueID: z.number().int().optional(),
-        properties: z
-          .object({})
-          .catchall(validationSchemaStorage.lazy("JsonNode"))
-          .superRefine((obj, ctx) => {
-            if (Object.keys(obj).length < 1) {
-              ctx.addIssue({
-                code: z.ZodIssueCode.custom,
-                path: [],
-                message: "Should have at least 1 properties",
-              });
-            }
-          })
-          .superRefine((obj, ctx) => {
-            if (Object.keys(obj).length > 10) {
-              ctx.addIssue({
-                code: z.ZodIssueCode.custom,
-                path: [],
-                message: "Should have at most 10 properties",
-              });
-            }
-          })
-          .optional(),
-      })
-      .strict()
-      .superRefine((obj, ctx) => {
-        if (Object.keys(obj).length < 1) {
-          ctx.addIssue({
-            code: z.ZodIssueCode.custom,
-            path: [],
-            message: "Should have at least 1 properties",
-          });
-        }
-      })
-      .superRefine((obj, ctx) => {
-        if (Object.keys(obj).length > 100) {
-          ctx.addIssue({
-            code: z.ZodIssueCode.custom,
-            path: [],
-            message: "Should have at most 100 properties",
-          });
-        }
-      })
-      .describe("IssueEntityPropertiesForMultiUpdate"),
-  );
-  validationSchemaStorage.register(
-    "IssueFilterForBulkPropertyDelete",
-    z
-      .object({
-        currentValue: z.unknown().optional(),
-        entityIds: 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",
-              });
-            }
-          })
-          .optional(),
-      })
-      .strict()
-      .describe("IssueFilterForBulkPropertyDelete"),
-  );
-  validationSchemaStorage.register(
-    "IssueFilterForBulkPropertySet",
-    z
-      .object({
-        currentValue: z.unknown().optional(),
-        entityIds: 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",
-              });
-            }
-          })
-          .optional(),
-        hasProperty: z.boolean().optional(),
-      })
-      .strict()
-      .describe("IssueFilterForBulkPropertySet"),
-  );
-  validationSchemaStorage.register(
-    "MultiIssueEntityProperties",
-    z
-      .object({
-        issues: z
-          .array(
-            validationSchemaStorage.lazy("IssueEntityPropertiesForMultiUpdate"),
-          )
-          .optional(),
-      })
-      .strict()
-      .describe("MultiIssueEntityProperties"),
-  );
-  validationSchemaStorage.registerOnce([registerCommonValidationSchemas]);
-}

package/src/openapi/platform/models/issue-remote-links.ts

@@ -1,207 +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";
-/** The application the linked item is in. */
-export interface Application extends Record<string, unknown> {
-  /**
-   * The name of the application. Used in conjunction with the (remote) object icon
-   * title to display a tooltip for the link's icon. The tooltip takes the format
-   * "\[application name\] icon title". Blank items are excluded from the tooltip
-   * title. If both items are blank, the icon tooltop displays as "Web Link".
-   * Grouping and sorting of links may place links without an application name last.
-   */
-  name?: string;
-  /** The name-spaced type of the application, used by registered rendering apps. */
-  type?: string;
-}
-/**
- * An icon. If no icon is defined:
- *
- *  *  for a status icon, no status icon displays in Jira.
- *  *  for the remote object icon, the default link icon displays in Jira.
- */
-export interface Icon extends Record<string, unknown> {
-  /**
-   * The URL of the tooltip, used only for a status icon. If not set, the status
-   * icon in Jira is not clickable.
-   */
-  link?: string;
-  /**
-   * The title of the icon. This is used as follows:
-   *
-   *  *  For a status icon it is used as a tooltip on the icon. If not set, the
-   * status icon doesn't display a tooltip in Jira.
-   *  *  For the remote object icon it is used in conjunction with the application
-   * name to display a tooltip for the link's icon. The tooltip takes the format
-   * "\[application name\] icon title". Blank itemsare excluded from the tooltip
-   * title. If both items are blank, the icon tooltop displays as "Web Link".
-   */
-  title?: string;
-  /** The URL of an icon that displays at 16x16 pixel in Jira. */
-  url16x16?: string;
-}
-/** Details of an issue remote link. */
-export interface RemoteIssueLink {
-  /** Details of the remote application the linked item is in. */
-  application?: Application;
-  /** The global ID of the link, such as the ID of the item on the remote system. */
-  globalId?: string;
-  /** The ID of the link. */
-  id?: number;
-  /** Details of the item linked to. */
-  object?: RemoteObject;
-  /** Description of the relationship between the issue and the linked item. */
-  relationship?: string;
-  /** The URL of the link. */
-  self?: string;
-}
-/** Details of the identifiers for a created or updated remote issue link. */
-export interface RemoteIssueLinkIdentifies {
-  /**
-   * The ID of the remote issue link, such as the ID of the item on the remote
-   * system.
-   */
-  id?: number;
-  /** The URL of the remote issue link. */
-  self?: string;
-}
-/** Details of a remote issue link. */
-export interface RemoteIssueLinkRequest extends Record<string, unknown> {
-  /** Details of the remote application the linked item is in. For example, trello. */
-  application?: Application;
-  /**
-   * An identifier for the remote item in the remote system. For example, the global
-   * ID for a remote item in Confluence would consist of the app ID and page ID,
-   * like this: `appId=456&pageId=123`.
-   *
-   * Setting this field enables the remote issue link details to be updated or
-   * deleted using remote system and item details as the record identifier, rather
-   * than using the record's Jira ID.
-   *
-   * The maximum length is 255 characters.
-   */
-  globalId?: string;
-  /** Details of the item linked to. */
-  object: RemoteObject;
-  /**
-   * Description of the relationship between the issue and the linked item. If not
-   * set, the relationship description "links to" is used in Jira.
-   */
-  relationship?: string;
-}
-/** The linked item. */
-export interface RemoteObject extends Record<string, unknown> {
-  /**
-   * Details of the icon for the item. If no icon is defined, the default link icon
-   * is used in Jira.
-   */
-  icon?: Icon;
-  /** The status of the item. */
-  status?: Status;
-  /** The summary details of the item. */
-  summary?: string;
-  /** The title of the item. */
-  title: string;
-  /** The URL of the item. */
-  url: string;
-}
-/** The status of the item. */
-export interface Status extends Record<string, unknown> {
-  /**
-   * Details of the icon representing the status. If not provided, no status icon
-   * displays in Jira.
-   */
-  icon?: Icon;
-  /**
-   * Whether the item is resolved. If set to "true", the link to the issue is
-   * displayed in a strikethrough font, otherwise the link displays in normal font.
-   */
-  resolved?: boolean;
-}
-export function registerIssueRemoteLinksValidationSchemas(
-  validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>,
-) {
-  validationSchemaStorage.register(
-    "Application",
-    z
-      .object({
-        name: z.string().optional(),
-        type: z.string().optional(),
-      })
-      .catchall(z.unknown())
-      .describe("Application"),
-  );
-  validationSchemaStorage.register(
-    "Icon",
-    z
-      .object({
-        link: z.string().optional(),
-        title: z.string().optional(),
-        url16x16: z.string().optional(),
-      })
-      .catchall(z.unknown())
-      .describe("Icon"),
-  );
-  validationSchemaStorage.register(
-    "RemoteIssueLink",
-    z
-      .object({
-        application: validationSchemaStorage.lazy("Application").optional(),
-        globalId: z.string().optional(),
-        id: z.number().int().optional(),
-        object: validationSchemaStorage.lazy("RemoteObject").optional(),
-        relationship: z.string().optional(),
-        self: z.string().optional(),
-      })
-      .strict()
-      .describe("RemoteIssueLink"),
-  );
-  validationSchemaStorage.register(
-    "RemoteIssueLinkIdentifies",
-    z
-      .object({
-        id: z.number().int().optional(),
-        self: z.string().optional(),
-      })
-      .strict()
-      .describe("RemoteIssueLinkIdentifies"),
-  );
-  validationSchemaStorage.register(
-    "RemoteIssueLinkRequest",
-    z
-      .object({
-        application: validationSchemaStorage.lazy("Application").optional(),
-        globalId: z.string().optional(),
-        object: validationSchemaStorage.lazy("RemoteObject"),
-        relationship: z.string().optional(),
-      })
-      .catchall(z.unknown())
-      .describe("RemoteIssueLinkRequest"),
-  );
-  validationSchemaStorage.register(
-    "RemoteObject",
-    z
-      .object({
-        icon: validationSchemaStorage.lazy("Icon").optional(),
-        status: validationSchemaStorage.lazy("Status").optional(),
-        summary: z.string().optional(),
-        title: z.string(),
-        url: z.string(),
-      })
-      .catchall(z.unknown())
-      .describe("RemoteObject"),
-  );
-  validationSchemaStorage.register(
-    "Status",
-    z
-      .object({
-        icon: validationSchemaStorage.lazy("Icon").optional(),
-        resolved: z.boolean().optional(),
-      })
-      .catchall(z.unknown())
-      .describe("Status"),
-  );
-}

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

@@ -1,180 +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";
-/** Details of an issue resolution. */
-export interface CreateResolutionDetails extends Record<string, unknown> {
-  /** The description of the resolution. */
-  description?: string;
-  /** The name of the resolution. Must be unique (case-insensitive). */
-  name: string;
-}
-/** A page of items. */
-export interface PageBeanResolutionJsonBean {
-  /** 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?: ResolutionJsonBean[];
-}
-/** Change the order of issue resolutions. */
-export interface ReorderIssueResolutionsRequest {
-  /** The ID of the resolution. Required if `position` isn't provided. */
-  after?: string;
-  /**
-   * The list of resolution IDs to be reordered. Cannot contain duplicates nor after
-   * ID.
-   */
-  ids: string[];
-  /**
-   * The position for issue resolutions to be moved to. Required if `after` isn't
-   * provided.
-   */
-  position?: string;
-}
-/** Details of an issue resolution. */
-export interface Resolution {
-  /** The description of the issue resolution. */
-  description?: string;
-  /** The ID of the issue resolution. */
-  id?: string;
-  /** The name of the issue resolution. */
-  name?: string;
-  /** The URL of the issue resolution. */
-  self?: string;
-}
-/** The ID of an issue resolution. */
-export interface ResolutionId extends Record<string, unknown> {
-  /** The ID of the issue resolution. */
-  id: string;
-}
-export interface ResolutionJsonBean {
-  default?: boolean;
-  description?: string;
-  iconUrl?: string;
-  id?: string;
-  name?: string;
-  self?: string;
-}
-/** The new default issue resolution. */
-export interface SetDefaultResolutionRequest {
-  /**
-   * The ID of the new default issue resolution. Must be an existing ID or null.
-   * Setting this to null erases the default resolution setting.
-   */
-  id: string;
-}
-/** Details of an issue resolution. */
-export interface UpdateResolutionDetails extends Record<string, unknown> {
-  /** The description of the resolution. */
-  description?: string;
-  /** The name of the resolution. Must be unique. */
-  name: string;
-}
-export function registerIssueResolutionsValidationSchemas(
-  validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>,
-) {
-  validationSchemaStorage.register(
-    "CreateResolutionDetails",
-    z
-      .object({
-        description: z.string().max(255).optional(),
-        name: z.string().max(60),
-      })
-      .catchall(z.unknown())
-      .describe("CreateResolutionDetails"),
-  );
-  validationSchemaStorage.register(
-    "PageBeanResolutionJsonBean",
-    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("ResolutionJsonBean"))
-          .optional(),
-      })
-      .strict()
-      .describe("PageBeanResolutionJsonBean"),
-  );
-  validationSchemaStorage.register(
-    "ReorderIssueResolutionsRequest",
-    z
-      .object({
-        after: z.string().optional(),
-        ids: z.array(z.string()),
-        position: z.string().optional(),
-      })
-      .strict()
-      .describe("ReorderIssueResolutionsRequest"),
-  );
-  validationSchemaStorage.register(
-    "Resolution",
-    z
-      .object({
-        description: z.string().optional(),
-        id: z.string().optional(),
-        name: z.string().optional(),
-        self: z.string().optional(),
-      })
-      .strict()
-      .describe("Resolution"),
-  );
-  validationSchemaStorage.register(
-    "ResolutionId",
-    z
-      .object({
-        id: z.string(),
-      })
-      .catchall(z.unknown())
-      .describe("ResolutionId"),
-  );
-  validationSchemaStorage.register(
-    "ResolutionJsonBean",
-    z
-      .object({
-        default: z.boolean().optional(),
-        description: z.string().optional(),
-        iconUrl: z.string().optional(),
-        id: z.string().optional(),
-        name: z.string().optional(),
-        self: z.string().optional(),
-      })
-      .strict()
-      .describe("ResolutionJsonBean"),
-  );
-  validationSchemaStorage.register(
-    "SetDefaultResolutionRequest",
-    z
-      .object({
-        id: z.string(),
-      })
-      .strict()
-      .describe("SetDefaultResolutionRequest"),
-  );
-  validationSchemaStorage.register(
-    "UpdateResolutionDetails",
-    z
-      .object({
-        description: z.string().max(255).optional(),
-        name: z.string().max(60),
-      })
-      .catchall(z.unknown())
-      .describe("UpdateResolutionDetails"),
-  );
-}