@resolution/jira-api-client 0.1.0 → 0.1.2

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

@@ -1,229 +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 ProjectId,
-  type ProjectIssueTypes,
-  registerCommonValidationSchemas,
-} from "./common";
-/** Details of a status. */
-export interface JiraStatus {
-  /** The description of the status. */
-  description?: string;
-  /** The ID of the status. */
-  id?: string;
-  /** The name of the status. */
-  name?: string;
-  /** The scope of the status. */
-  scope?: StatusScope;
-  /** The category of the status. */
-  statusCategory?: "TODO" | "IN_PROGRESS" | "DONE";
-  /**
-   * Projects and issue types where the status is used. Only available if the
-   * `usages` expand is requested.
-   */
-  usages?: ProjectIssueTypes[];
-  /**
-   * The workflows that use this status. Only available if the `workflowUsages`
-   * expand is requested.
-   */
-  workflowUsages?: WorkflowUsages[];
-}
-export interface PageOfStatuses {
-  /** Whether this is the last page. */
-  isLast?: boolean;
-  /** The maximum number of items that could be returned. */
-  maxResults?: number;
-  /** The URL of the next page of results, if any. */
-  nextPage?: string;
-  /** The URL of this page. */
-  self?: string;
-  /** The index of the first item returned on the page. */
-  startAt?: number;
-  /** Number of items that satisfy the search. */
-  total?: number;
-  /** The list of items. */
-  values?: JiraStatus[];
-}
-/** Details of the status being created. */
-export interface StatusCreate {
-  /** The description of the status. */
-  description?: string;
-  /** The name of the status. */
-  name: string;
-  /** The category of the status. */
-  statusCategory: "TODO" | "IN_PROGRESS" | "DONE";
-}
-/** Details of the statuses being created and their scope. */
-export interface StatusCreateRequest {
-  /** The scope of the status. */
-  scope: StatusScope;
-  /** Details of the statuses being created. */
-  statuses: StatusCreate[];
-}
-/** The scope of the status. */
-export interface StatusScope {
-  /** Project ID details. */
-  project?: ProjectId | null;
-  /**
-   * The scope of the status. `GLOBAL` for company-managed projects and `PROJECT`
-   * for team-managed projects.
-   */
-  type: "PROJECT" | "GLOBAL";
-}
-/** Details of the status being updated. */
-export interface StatusUpdate extends Record<string, unknown> {
-  /** The description of the status. */
-  description?: string;
-  /** The ID of the status. */
-  id: string;
-  /** The name of the status. */
-  name: string;
-  /** The category of the status. */
-  statusCategory: "TODO" | "IN_PROGRESS" | "DONE";
-}
-/** The list of statuses that will be updated. */
-export interface StatusUpdateRequest {
-  /** The list of statuses that will be updated. */
-  statuses: StatusUpdate[];
-}
-/**
- * The workflows that use this status. Only available if the `workflowUsages`
- * expand is requested.
- */
-export interface WorkflowUsages {
-  /** Workflow ID. */
-  workflowId?: string;
-  /** Workflow name. */
-  workflowName?: string;
-}
-export function registerStatusValidationSchemas(
-  validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>,
-) {
-  validationSchemaStorage.register(
-    "JiraStatus",
-    z
-      .object({
-        description: z.string().optional(),
-        id: z.string().optional(),
-        name: z.string().optional(),
-        scope: validationSchemaStorage.lazy("StatusScope").optional(),
-        statusCategory: z.enum(["TODO", "IN_PROGRESS", "DONE"]).optional(),
-        usages: z
-          .array(validationSchemaStorage.lazy("ProjectIssueTypes"))
-          .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(),
-        workflowUsages: z
-          .array(validationSchemaStorage.lazy("WorkflowUsages"))
-          .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("JiraStatus"),
-  );
-  validationSchemaStorage.register(
-    "PageOfStatuses",
-    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("JiraStatus")).optional(),
-      })
-      .strict()
-      .describe("PageOfStatuses"),
-  );
-  validationSchemaStorage.register(
-    "StatusCreate",
-    z
-      .object({
-        description: z.string().optional(),
-        name: z.string().max(255),
-        statusCategory: z.enum(["TODO", "IN_PROGRESS", "DONE"]),
-      })
-      .strict()
-      .describe("StatusCreate"),
-  );
-  validationSchemaStorage.register(
-    "StatusCreateRequest",
-    z
-      .object({
-        scope: validationSchemaStorage.lazy("StatusScope"),
-        statuses: z.array(validationSchemaStorage.lazy("StatusCreate")),
-      })
-      .strict()
-      .describe("StatusCreateRequest"),
-  );
-  validationSchemaStorage.register(
-    "StatusScope",
-    z
-      .object({
-        project: z
-          .nullable(validationSchemaStorage.lazy("ProjectId"))
-          .optional(),
-        type: z.enum(["PROJECT", "GLOBAL"]),
-      })
-      .strict()
-      .describe("StatusScope"),
-  );
-  validationSchemaStorage.register(
-    "StatusUpdate",
-    z
-      .object({
-        description: z.string().optional(),
-        id: z.string(),
-        name: z.string(),
-        statusCategory: z.enum(["TODO", "IN_PROGRESS", "DONE"]),
-      })
-      .catchall(z.unknown())
-      .describe("StatusUpdate"),
-  );
-  validationSchemaStorage.register(
-    "StatusUpdateRequest",
-    z
-      .object({
-        statuses: z.array(validationSchemaStorage.lazy("StatusUpdate")),
-      })
-      .strict()
-      .describe("StatusUpdateRequest"),
-  );
-  validationSchemaStorage.register(
-    "WorkflowUsages",
-    z
-      .object({
-        workflowId: z.string().optional(),
-        workflowName: z.string().optional(),
-      })
-      .strict()
-      .describe("WorkflowUsages"),
-  );
-  validationSchemaStorage.registerOnce([registerCommonValidationSchemas]);
-}

package/src/openapi/platform/models/time-tracking.ts

@@ -1,38 +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 about the time tracking provider. */
-export interface TimeTrackingProvider {
-  /** The key for the time tracking provider. For example, *JIRA*. */
-  key: string;
-  /**
-   * The name of the time tracking provider. For example, *JIRA provided time
-   * tracking*.
-   */
-  name?: string;
-  /**
-   * The URL of the configuration page for the time tracking provider app. For
-   * example, * /example/config/url*. This property is only returned if the
-   * `adminPageKey` property is set in the module descriptor of the time tracking
-   * provider app.
-   */
-  url?: string;
-}
-export function registerTimeTrackingValidationSchemas(
-  validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>,
-) {
-  validationSchemaStorage.register(
-    "TimeTrackingProvider",
-    z
-      .object({
-        key: z.string(),
-        name: z.string().optional(),
-        url: z.string().optional(),
-      })
-      .strict()
-      .describe("TimeTrackingProvider"),
-  );
-}

package/src/openapi/platform/models/ui-modifications-apps.ts

@@ -1,229 +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 details of a UI modification. */
-export interface CreateUiModificationDetails {
-  /** List of contexts of the UI modification. The maximum number of contexts is 1000. */
-  contexts?: UiModificationContextDetails[];
-  /**
-   * The data of the UI modification. The maximum size of the data is 50000
-   * characters.
-   */
-  data?: string;
-  /** The description of the UI modification. The maximum length is 255 characters. */
-  description?: string;
-  /** The name of the UI modification. The maximum length is 255 characters. */
-  name: string;
-}
-export interface DetailedErrorCollection {
-  /** Map of objects representing additional details for an error */
-  details?: {
-    [key: string]: unknown;
-  };
-  /**
-   * The list of error messages produced by this operation. For example, "input
-   * parameter 'key' must be provided"
-   */
-  errorMessages?: string[];
-  /**
-   * The list of errors by parameter returned by the operation. For
-   * example,"projectKey": "Project keys must start with an uppercase letter,
-   * followed by one or more uppercase alphanumeric characters."
-   */
-  errors?: {
-    [key: string]: string;
-  };
-}
-/** A page of items. */
-export interface PageBeanUiModificationDetails {
-  /** 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?: UiModificationDetails[];
-}
-/**
- * The details of a UI modification's context, which define where to activate the
- * UI modification.
- */
-export interface UiModificationContextDetails {
-  /** The ID of the UI modification context. */
-  id?: string;
-  /**
-   * Whether a context is available. For example, when a project is deleted the
-   * context becomes unavailable.
-   */
-  isAvailable?: boolean;
-  /**
-   * The issue type ID of the context. Null is treated as a wildcard, meaning the UI
-   * modification will be applied to all issue types. Each UI modification context
-   * can have a maximum of one wildcard.
-   */
-  issueTypeId?: string;
-  /**
-   * The project ID of the context. Null is treated as a wildcard, meaning the UI
-   * modification will be applied to all projects. Each UI modification context can
-   * have a maximum of one wildcard.
-   */
-  projectId?: string;
-  /**
-   * The view type of the context. Only `GIC`(Global Issue Create) and `IssueView`
-   * are supported. Null is treated as a wildcard, meaning the UI modification will
-   * be applied to all view types. Each UI modification context can have a maximum
-   * of one wildcard.
-   */
-  viewType?: "GIC" | "IssueView";
-}
-/** The details of a UI modification. */
-export interface UiModificationDetails {
-  /** List of contexts of the UI modification. The maximum number of contexts is 1000. */
-  contexts?: UiModificationContextDetails[];
-  /**
-   * The data of the UI modification. The maximum size of the data is 50000
-   * characters.
-   */
-  data?: string;
-  /** The description of the UI modification. The maximum length is 255 characters. */
-  description?: string;
-  /** The ID of the UI modification. */
-  id: string;
-  /** The name of the UI modification. The maximum length is 255 characters. */
-  name: string;
-  /** The URL of the UI modification. */
-  self: string;
-}
-/** Identifiers for a UI modification. */
-export interface UiModificationIdentifiers {
-  /** The ID of the UI modification. */
-  id: string;
-  /** The URL of the UI modification. */
-  self: string;
-}
-/** The details of a UI modification. */
-export interface UpdateUiModificationDetails {
-  /**
-   * List of contexts of the UI modification. The maximum number of contexts is
-   * 1000. If provided, replaces all existing contexts.
-   */
-  contexts?: UiModificationContextDetails[];
-  /**
-   * The data of the UI modification. The maximum size of the data is 50000
-   * characters.
-   */
-  data?: string;
-  /** The description of the UI modification. The maximum length is 255 characters. */
-  description?: string;
-  /** The name of the UI modification. The maximum length is 255 characters. */
-  name?: string;
-}
-export function registerUiModificationsAppsValidationSchemas(
-  validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>,
-) {
-  validationSchemaStorage.register(
-    "CreateUiModificationDetails",
-    z
-      .object({
-        contexts: z
-          .array(validationSchemaStorage.lazy("UiModificationContextDetails"))
-          .optional(),
-        data: z.string().optional(),
-        description: z.string().optional(),
-        name: z.string(),
-      })
-      .strict()
-      .describe("CreateUiModificationDetails"),
-  );
-  validationSchemaStorage.register(
-    "DetailedErrorCollection",
-    z
-      .object({
-        details: z.object({}).catchall(z.unknown()).optional(),
-        errorMessages: z.array(z.string()).optional(),
-        errors: z.object({}).catchall(z.string()).optional(),
-      })
-      .strict()
-      .describe("DetailedErrorCollection"),
-  );
-  validationSchemaStorage.register(
-    "PageBeanUiModificationDetails",
-    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("UiModificationDetails"))
-          .optional(),
-      })
-      .strict()
-      .describe("PageBeanUiModificationDetails"),
-  );
-  validationSchemaStorage.register(
-    "UiModificationContextDetails",
-    z
-      .object({
-        id: z.string().optional(),
-        isAvailable: z.boolean().optional(),
-        issueTypeId: z.string().optional(),
-        projectId: z.string().optional(),
-        viewType: z.enum(["GIC", "IssueView"]).optional(),
-      })
-      .strict()
-      .describe("UiModificationContextDetails"),
-  );
-  validationSchemaStorage.register(
-    "UiModificationDetails",
-    z
-      .object({
-        contexts: z
-          .array(validationSchemaStorage.lazy("UiModificationContextDetails"))
-          .optional(),
-        data: z.string().optional(),
-        description: z.string().optional(),
-        id: z.string(),
-        name: z.string(),
-        self: z.string(),
-      })
-      .strict()
-      .describe("UiModificationDetails"),
-  );
-  validationSchemaStorage.register(
-    "UiModificationIdentifiers",
-    z
-      .object({
-        id: z.string(),
-        self: z.string(),
-      })
-      .strict()
-      .describe("UiModificationIdentifiers"),
-  );
-  validationSchemaStorage.register(
-    "UpdateUiModificationDetails",
-    z
-      .object({
-        contexts: z
-          .array(validationSchemaStorage.lazy("UiModificationContextDetails"))
-          .optional(),
-        data: z.string().optional(),
-        description: z.string().optional(),
-        name: z.string().optional(),
-      })
-      .strict()
-      .describe("UpdateUiModificationDetails"),
-  );
-}

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

@@ -1,69 +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";
-/** A page of items. */
-export interface PageBeanUserKey {
-  /** 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?: UserKey[];
-}
-/** List of user account IDs. */
-export interface UserKey {
-  /**
-   * The account ID of the user, which uniquely identifies the user across all
-   * Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Returns *unknown*
-   * if the record is deleted and corrupted, for example, as the result of a server
-   * import.
-   */
-  accountId?: string;
-  /**
-   * This property is no longer available and will be removed from the documentation
-   * soon. See the [deprecation
-   * notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/)
-   * for details.
-   */
-  key?: string;
-}
-export function registerUserSearchValidationSchemas(
-  validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>,
-) {
-  validationSchemaStorage.register(
-    "PageBeanUserKey",
-    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("UserKey")).optional(),
-      })
-      .strict()
-      .describe("PageBeanUserKey"),
-  );
-  validationSchemaStorage.register(
-    "UserKey",
-    z
-      .object({
-        accountId: z.string().max(128).optional(),
-        key: z.string().optional(),
-      })
-      .strict()
-      .describe("UserKey"),
-  );
-}

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

@@ -1,121 +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 user details. */
-export interface NewUserDetails extends Record<string, unknown> {
-  /**
-   * Deprecated, do not use.
-   *
-   * @deprecated
-   */
-  applicationKeys?: string[];
-  /**
-   * This property is no longer available. If the user has an Atlassian account,
-   * their display name is not changed. If the user does not have an Atlassian
-   * account, they are sent an email asking them set up an account.
-   */
-  displayName?: string;
-  /** The email address for the user. */
-  emailAddress: string;
-  /**
-   * This property is no longer available. See the [migration
-   * guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/)
-   * for details.
-   */
-  key?: string;
-  /**
-   * This property is no longer available. See the [migration
-   * guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/)
-   * for details.
-   */
-  name?: string;
-  /**
-   * This property is no longer available. If the user has an Atlassian account,
-   * their password is not changed. If the user does not have an Atlassian account,
-   * they are sent an email asking them set up an account.
-   */
-  password?: string;
-  /**
-   * Products the new user has access to. Valid products are: jira-core,
-   * jira-servicedesk, jira-product-discovery, jira-software. To create a user
-   * without product access, set this field to be an empty array.
-   */
-  products: string[];
-  /** The URL of the user. */
-  self?: string;
-}
-export interface UnrestrictedUserEmail extends Record<string, unknown> {
-  /** The accountId of the user */
-  accountId?: string;
-  /** The email of the user */
-  email?: string;
-}
-export interface UserColumnRequestBody {
-  columns?: string[];
-}
-export interface UserMigrationBean {
-  accountId?: string;
-  key?: string;
-  username?: string;
-}
-export function registerUsersValidationSchemas(
-  validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>,
-) {
-  validationSchemaStorage.register(
-    "NewUserDetails",
-    z
-      .object({
-        applicationKeys: z.array(z.string()).optional(),
-        displayName: z.string().optional(),
-        emailAddress: z.string(),
-        key: z.string().optional(),
-        name: z.string().optional(),
-        password: z.string().optional(),
-        products: 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",
-            });
-          }
-        }),
-        self: z.string().optional(),
-      })
-      .catchall(z.unknown())
-      .describe("NewUserDetails"),
-  );
-  validationSchemaStorage.register(
-    "UnrestrictedUserEmail",
-    z
-      .object({
-        accountId: z.string().optional(),
-        email: z.string().optional(),
-      })
-      .catchall(z.unknown())
-      .describe("UnrestrictedUserEmail"),
-  );
-  validationSchemaStorage.register(
-    "UserColumnRequestBody",
-    z
-      .object({
-        columns: z.array(z.string()).optional(),
-      })
-      .strict()
-      .describe("UserColumnRequestBody"),
-  );
-  validationSchemaStorage.register(
-    "UserMigrationBean",
-    z
-      .object({
-        accountId: z.string().optional(),
-        key: z.string().optional(),
-        username: z.string().optional(),
-      })
-      .strict()
-      .describe("UserMigrationBean"),
-  );
-}