@resolution/jira-api-client 0.1.0 → 0.1.2

package/src/openapi/platform/models/project-components.ts

@@ -1,231 +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 { registerCommonValidationSchemas, type User } from "./common";
-/** Count of issues assigned to a component. */
-export interface ComponentIssuesCount {
-  /** The count of issues assigned to a component. */
-  issueCount?: number;
-  /** The URL for this count of issues for a component. */
-  self?: string;
-}
-export interface ComponentJsonBean extends Record<string, unknown> {
-  ari?: string;
-  description?: string;
-  id?: string;
-  metadata?: {
-    [key: string]: string;
-  };
-  name?: string;
-  self?: string;
-}
-/** Details about a component with a count of the issues it contains. */
-export interface ComponentWithIssueCount {
-  /**
-   * The details of the user associated with `assigneeType`, if any. See
-   * `realAssignee` for details of the user assigned to issues created with this
-   * component.
-   */
-  assignee?: User;
-  /**
-   * The nominal user type used to determine the assignee for issues created with
-   * this component. See `realAssigneeType` for details on how the type of the user,
-   * and hence the user, assigned to issues is determined. Takes the following
-   * values:
-   *
-   *  *  `PROJECT_LEAD` the assignee to any issues created with this component is
-   * nominally the lead for the project the component is in.
-   *  *  `COMPONENT_LEAD` the assignee to any issues created with this component is
-   * nominally the lead for the component.
-   *  *  `UNASSIGNED` an assignee is not set for issues created with this component.
-   *  *  `PROJECT_DEFAULT` the assignee to any issues created with this component is
-   * nominally the default assignee for the project that the component is in.
-   */
-  assigneeType?:
-    | "PROJECT_DEFAULT"
-    | "COMPONENT_LEAD"
-    | "PROJECT_LEAD"
-    | "UNASSIGNED";
-  /** The description for the component. */
-  description?: string;
-  /** The unique identifier for the component. */
-  id?: string;
-  /**
-   * Whether a user is associated with `assigneeType`. For example, if the
-   * `assigneeType` is set to `COMPONENT_LEAD` but the component lead is not set,
-   * then `false` is returned.
-   */
-  isAssigneeTypeValid?: boolean;
-  /** Count of issues for the component. */
-  issueCount?: number;
-  /** The user details for the component's lead user. */
-  lead?: User;
-  /** The name for the component. */
-  name?: string;
-  /** The key of the project to which the component is assigned. */
-  project?: string;
-  /** Not used. */
-  projectId?: number;
-  /**
-   * The user assigned to issues created with this component, when `assigneeType`
-   * does not identify a valid assignee.
-   */
-  realAssignee?: User;
-  /**
-   * The type of the assignee that is assigned to issues created with this
-   * component, when an assignee cannot be set from the `assigneeType`. For example,
-   * `assigneeType` is set to `COMPONENT_LEAD` but no component lead is set. This
-   * property is set to one of the following values:
-   *
-   *  *  `PROJECT_LEAD` when `assigneeType` is `PROJECT_LEAD` and the project lead
-   * has permission to be assigned issues in the project that the component is in.
-   *  *  `COMPONENT_LEAD` when `assignee`Type is `COMPONENT_LEAD` and the component
-   * lead has permission to be assigned issues in the project that the component is
-   * in.
-   *  *  `UNASSIGNED` when `assigneeType` is `UNASSIGNED` and Jira is configured to
-   * allow unassigned issues.
-   *  *  `PROJECT_DEFAULT` when none of the preceding cases are true.
-   */
-  realAssigneeType?:
-    | "PROJECT_DEFAULT"
-    | "COMPONENT_LEAD"
-    | "PROJECT_LEAD"
-    | "UNASSIGNED";
-  /** The URL for this count of the issues contained in the component. */
-  self?: string;
-}
-/** A page of items. */
-export interface PageBean2ComponentJsonBean {
-  /** 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?: ComponentJsonBean[];
-}
-/** A page of items. */
-export interface PageBeanComponentWithIssueCount {
-  /** 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?: ComponentWithIssueCount[];
-}
-export function registerProjectComponentsValidationSchemas(
-  validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>,
-) {
-  validationSchemaStorage.register(
-    "ComponentIssuesCount",
-    z
-      .object({
-        issueCount: z.number().int().optional(),
-        self: z.string().optional(),
-      })
-      .strict()
-      .describe("ComponentIssuesCount"),
-  );
-  validationSchemaStorage.register(
-    "ComponentJsonBean",
-    z
-      .object({
-        ari: z.string().optional(),
-        description: z.string().optional(),
-        id: z.string().optional(),
-        metadata: z.object({}).catchall(z.string()).optional(),
-        name: z.string().optional(),
-        self: z.string().optional(),
-      })
-      .catchall(z.unknown())
-      .describe("ComponentJsonBean"),
-  );
-  validationSchemaStorage.register(
-    "ComponentWithIssueCount",
-    z
-      .object({
-        assignee: validationSchemaStorage.lazy("User").optional(),
-        assigneeType: z
-          .enum([
-            "PROJECT_DEFAULT",
-            "COMPONENT_LEAD",
-            "PROJECT_LEAD",
-            "UNASSIGNED",
-          ])
-          .optional(),
-        description: z.string().optional(),
-        id: z.string().optional(),
-        isAssigneeTypeValid: z.boolean().optional(),
-        issueCount: z.number().int().optional(),
-        lead: validationSchemaStorage.lazy("User").optional(),
-        name: z.string().optional(),
-        project: z.string().optional(),
-        projectId: z.number().int().optional(),
-        realAssignee: validationSchemaStorage.lazy("User").optional(),
-        realAssigneeType: z
-          .enum([
-            "PROJECT_DEFAULT",
-            "COMPONENT_LEAD",
-            "PROJECT_LEAD",
-            "UNASSIGNED",
-          ])
-          .optional(),
-        self: z.string().optional(),
-      })
-      .strict()
-      .describe("ComponentWithIssueCount"),
-  );
-  validationSchemaStorage.register(
-    "PageBean2ComponentJsonBean",
-    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("ComponentJsonBean"))
-          .optional(),
-      })
-      .strict()
-      .describe("PageBean2ComponentJsonBean"),
-  );
-  validationSchemaStorage.register(
-    "PageBeanComponentWithIssueCount",
-    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("ComponentWithIssueCount"))
-          .optional(),
-      })
-      .strict()
-      .describe("PageBeanComponentWithIssueCount"),
-  );
-  validationSchemaStorage.registerOnce([registerCommonValidationSchemas]);
-}

package/src/openapi/platform/models/project-email.ts

@@ -1,27 +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 project's sender email address. */
-export interface ProjectEmailAddress {
-  /** The email address. */
-  emailAddress?: string;
-  /** When using a custom domain, the status of the email address. */
-  emailAddressStatus?: string[];
-}
-export function registerProjectEmailValidationSchemas(
-  validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>,
-) {
-  validationSchemaStorage.register(
-    "ProjectEmailAddress",
-    z
-      .object({
-        emailAddress: z.string().optional(),
-        emailAddressStatus: z.array(z.string()).optional(),
-      })
-      .strict()
-      .describe("ProjectEmailAddress"),
-  );
-}

package/src/openapi/platform/models/project-features.ts

@@ -1,78 +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 list of features on a project. */
-export interface ContainerForProjectFeatures {
-  /** The project features. */
-  features?: ProjectFeature[];
-}
-/** Details of a project feature. */
-export interface ProjectFeature {
-  /** The key of the feature. */
-  feature?: string;
-  /** URI for the image representing the feature. */
-  imageUri?: string;
-  /** Localized display description for the feature. */
-  localisedDescription?: string;
-  /** Localized display name for the feature. */
-  localisedName?: string;
-  /** List of keys of the features required to enable the feature. */
-  prerequisites?: string[];
-  /** The ID of the project. */
-  projectId?: number;
-  /**
-   * The state of the feature. When updating the state of a feature, only ENABLED
-   * and DISABLED are supported. Responses can contain all values
-   */
-  state?: "ENABLED" | "DISABLED" | "COMING_SOON";
-  /** Whether the state of the feature can be updated. */
-  toggleLocked?: boolean;
-}
-/** Details of the feature state. */
-export interface ProjectFeatureState {
-  /** The feature state. */
-  state?: "ENABLED" | "DISABLED" | "COMING_SOON";
-}
-export function registerProjectFeaturesValidationSchemas(
-  validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>,
-) {
-  validationSchemaStorage.register(
-    "ContainerForProjectFeatures",
-    z
-      .object({
-        features: z
-          .array(validationSchemaStorage.lazy("ProjectFeature"))
-          .optional(),
-      })
-      .strict()
-      .describe("ContainerForProjectFeatures"),
-  );
-  validationSchemaStorage.register(
-    "ProjectFeature",
-    z
-      .object({
-        feature: z.string().optional(),
-        imageUri: z.string().optional(),
-        localisedDescription: z.string().optional(),
-        localisedName: z.string().optional(),
-        prerequisites: z.array(z.string()).optional(),
-        projectId: z.number().int().optional(),
-        state: z.enum(["ENABLED", "DISABLED", "COMING_SOON"]).optional(),
-        toggleLocked: z.boolean().optional(),
-      })
-      .strict()
-      .describe("ProjectFeature"),
-  );
-  validationSchemaStorage.register(
-    "ProjectFeatureState",
-    z
-      .object({
-        state: z.enum(["ENABLED", "DISABLED", "COMING_SOON"]).optional(),
-      })
-      .strict()
-      .describe("ProjectFeatureState"),
-  );
-}

package/src/openapi/platform/models/project-permission-schemes.ts

@@ -1,43 +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 { registerCommonValidationSchemas, type SecurityLevel } from "./common";
-export interface IdBean {
-  /**
-   * The ID of the permission scheme to associate with the project. Use the [Get all
-   * permission schemes](#api-rest-api-3-permissionscheme-get) resource to get a
-   * list of permission scheme IDs.
-   */
-  id: number;
-}
-/** List of issue level security items in a project. */
-export interface ProjectIssueSecurityLevels {
-  /** Issue level security items list. */
-  levels: SecurityLevel[];
-}
-export function registerProjectPermissionSchemesValidationSchemas(
-  validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>,
-) {
-  validationSchemaStorage.register(
-    "IdBean",
-    z
-      .object({
-        id: z.number().int(),
-      })
-      .strict()
-      .describe("IdBean"),
-  );
-  validationSchemaStorage.register(
-    "ProjectIssueSecurityLevels",
-    z
-      .object({
-        levels: z.array(validationSchemaStorage.lazy("SecurityLevel")),
-      })
-      .strict()
-      .describe("ProjectIssueSecurityLevels"),
-  );
-  validationSchemaStorage.registerOnce([registerCommonValidationSchemas]);
-}

package/src/openapi/platform/models/project-role-actors.ts

@@ -1,107 +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";
-export interface ActorInputBean {
-  /**
-   * The name of the group to add as a default actor. This parameter cannot be used
-   * with the `groupId` parameter. As a group's name can change,use of `groupId` is
-   * recommended. This parameter accepts a comma-separated list. For example,
-   * `"group":["project-admin", "jira-developers"]`.
-   */
-  group?: string[];
-  /**
-   * The ID of the group to add as a default actor. This parameter cannot be used
-   * with the `group` parameter This parameter accepts a comma-separated list. For
-   * example, `"groupId":["77f6ab39-e755-4570-a6ae-2d7a8df0bcb8",
-   * "0c011f85-69ed-49c4-a801-3b18d0f771bc"]`.
-   */
-  groupId?: string[];
-  /**
-   * The account IDs of the users to add as default actors. This parameter accepts a
-   * comma-separated list. For example, `"user":["5b10a2844c20165700ede21g",
-   * "5b109f2e9729b51b54dc274d"]`.
-   */
-  user?: string[];
-}
-export interface ActorsMap {
-  /**
-   * The name of the group to add. This parameter cannot be used with the `groupId`
-   * parameter. As a group's name can change, use of `groupId` is recommended.
-   */
-  group?: string[];
-  /**
-   * The ID of the group to add. This parameter cannot be used with the `group`
-   * parameter.
-   */
-  groupId?: string[];
-  /** The user account ID of the user to add. */
-  user?: string[];
-}
-export interface ProjectRoleActorsUpdateBean {
-  /**
-   * The actors to add to the project role.
-   *
-   * Add groups using:
-   *
-   *  *  `atlassian-group-role-actor` and a list of group names.
-   *  *  `atlassian-group-role-actor-id` and a list of group IDs.
-   *
-   * As a group's name can change, use of `atlassian-group-role-actor-id` is
-   * recommended. For example,
-   * `"atlassian-group-role-actor-id":["eef79f81-0b89-4fca-a736-4be531a10869","77f6ab39-e755-4570-a6ae-2d7a8df0bcb8"]`.
-   *
-   * Add users using `atlassian-user-role-actor` and a list of account IDs. For
-   * example, `"atlassian-user-role-actor":["12345678-9abc-def1-2345-6789abcdef12",
-   * "abcdef12-3456-789a-bcde-f123456789ab"]`.
-   */
-  categorisedActors?: {
-    [key: string]: string[];
-  };
-  /**
-   * The ID of the project role. Use [Get all project
-   * roles](#api-rest-api-3-role-get) to get a list of project role IDs.
-   */
-  id?: number;
-}
-export function registerProjectRoleActorsValidationSchemas(
-  validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>,
-) {
-  validationSchemaStorage.register(
-    "ActorInputBean",
-    z
-      .object({
-        group: z.array(z.string()).optional(),
-        groupId: z.array(z.string()).optional(),
-        user: z.array(z.string()).optional(),
-      })
-      .strict()
-      .describe("ActorInputBean"),
-  );
-  validationSchemaStorage.register(
-    "ActorsMap",
-    z
-      .object({
-        group: z.array(z.string()).optional(),
-        groupId: z.array(z.string()).optional(),
-        user: z.array(z.string()).optional(),
-      })
-      .strict()
-      .describe("ActorsMap"),
-  );
-  validationSchemaStorage.register(
-    "ProjectRoleActorsUpdateBean",
-    z
-      .object({
-        categorisedActors: z
-          .object({})
-          .catchall(z.array(z.string()))
-          .optional(),
-        id: z.number().int().optional(),
-      })
-      .strict()
-      .describe("ProjectRoleActorsUpdateBean"),
-  );
-}

package/src/openapi/platform/models/project-roles.ts

@@ -1,76 +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 { registerCommonValidationSchemas, type Scope } from "./common";
-export interface CreateUpdateRoleRequestBean {
-  /**
-   * A description of the project role. Required when fully updating a project role.
-   * Optional when creating or partially updating a project role.
-   */
-  description?: string;
-  /**
-   * The name of the project role. Must be unique. Cannot begin or end with
-   * whitespace. The maximum length is 255 characters. Required when creating a
-   * project role. Optional when partially updating a project role.
-   */
-  name?: string;
-}
-/** Details about a project role. */
-export interface ProjectRoleDetails {
-  /** Whether this role is the admin role for the project. */
-  admin?: boolean;
-  /** Whether this role is the default role for the project. */
-  default?: boolean;
-  /** The description of the project role. */
-  description?: string;
-  /** The ID of the project role. */
-  id?: number;
-  /** The name of the project role. */
-  name?: string;
-  /** Whether the roles are configurable for this project. */
-  roleConfigurable?: boolean;
-  /**
-   * The scope of the role. Indicated for roles associated with [next-gen
-   * projects](https://confluence.atlassian.com/x/loMyO).
-   */
-  scope?: Scope;
-  /** The URL the project role details. */
-  self?: string;
-  /** The translated name of the project role. */
-  translatedName?: string;
-}
-export function registerProjectRolesValidationSchemas(
-  validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>,
-) {
-  validationSchemaStorage.register(
-    "CreateUpdateRoleRequestBean",
-    z
-      .object({
-        description: z.string().optional(),
-        name: z.string().optional(),
-      })
-      .strict()
-      .describe("CreateUpdateRoleRequestBean"),
-  );
-  validationSchemaStorage.register(
-    "ProjectRoleDetails",
-    z
-      .object({
-        admin: z.boolean().optional(),
-        default: z.boolean().optional(),
-        description: z.string().optional(),
-        id: z.number().int().optional(),
-        name: z.string().optional(),
-        roleConfigurable: z.boolean().optional(),
-        scope: validationSchemaStorage.lazy("Scope").optional(),
-        self: z.string().optional(),
-        translatedName: z.string().optional(),
-      })
-      .strict()
-      .describe("ProjectRoleDetails"),
-  );
-  validationSchemaStorage.registerOnce([registerCommonValidationSchemas]);
-}

package/src/openapi/platform/models/project-types.ts

@@ -1,36 +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 a project type. */
-export interface ProjectType {
-  /** The color of the project type. */
-  color?: string;
-  /** The key of the project type's description. */
-  descriptionI18nKey?: string;
-  /** The formatted key of the project type. */
-  formattedKey?: string;
-  /** The icon of the project type. */
-  icon?: string;
-  /** The key of the project type. */
-  key?: string;
-}
-export function registerProjectTypesValidationSchemas(
-  validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>,
-) {
-  validationSchemaStorage.register(
-    "ProjectType",
-    z
-      .object({
-        color: z.string().optional(),
-        descriptionI18nKey: z.string().optional(),
-        formattedKey: z.string().optional(),
-        icon: z.string().optional(),
-        key: z.string().optional(),
-      })
-      .strict()
-      .describe("ProjectType"),
-  );
-}