@resolution/jira-api-client 0.1.0

package/src/openapi/platform/models/dynamic-modules.ts

@@ -0,0 +1,121 @@
+// 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 [Connect
+ * module](https://developer.atlassian.com/cloud/jira/platform/about-jira-modules/)
+ * in the same format as in the
+ * [app
+ * descriptor](https://developer.atlassian.com/cloud/jira/platform/app-descriptor/).
+ *
+ * @example {
+ *     "description": {
+ *         "value": "field with team"
+ *     },
+ *     "type": "single_select",
+ *     "extractions": [
+ *         {
+ *             "path": "category",
+ *             "type": "text",
+ *             "name": "categoryName"
+ *         }
+ *     ],
+ *     "name": {
+ *         "value": "Team"
+ *     },
+ *     "key": "team-field"
+ * }
+ */
+export interface ConnectModule {
+  [key: string]: unknown;
+}
+/**
+ * @example {
+ *     "jiraEntityProperties": [
+ *         {
+ *             "keyConfigurations": [
+ *                 {
+ *                     "extractions": [
+ *                         {
+ *                             "objectName": "extension",
+ *                             "type": "text",
+ *                             "alias": "attachmentExtension"
+ *                         }
+ *                     ],
+ *                     "propertyKey": "attachment"
+ *                 }
+ *             ],
+ *             "entityType": "issue",
+ *             "name": {
+ *                 "value": "Attachment Index Document"
+ *             },
+ *             "key": "dynamic-attachment-entity-property"
+ *         }
+ *     ],
+ *     "jiraIssueFields": [
+ *         {
+ *             "description": {
+ *                 "value": "A dynamically added single-select field"
+ *             },
+ *             "type": "single_select",
+ *             "extractions": [
+ *                 {
+ *                     "path": "category",
+ *                     "type": "text",
+ *                     "name": "categoryName"
+ *                 }
+ *             ],
+ *             "name": {
+ *                 "value": "Dynamic single select"
+ *             },
+ *             "key": "dynamic-select-field"
+ *         }
+ *     ]
+ * }
+ */
+export interface ConnectModules extends Record<string, unknown> {
+  /**
+   * A list of app modules in the same format as the `modules` property in the
+   * [app
+   * descriptor](https://developer.atlassian.com/cloud/jira/platform/app-descriptor/).
+   */
+  modules: ConnectModule[];
+}
+/**
+ * @example {
+ *     "message": "The request is not from a Connect app."
+ * }
+ */
+export interface ErrorMessage {
+  /** The error message. */
+  message: string;
+}
+export function registerDynamicModulesValidationSchemas(
+  validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>,
+) {
+  validationSchemaStorage.register(
+    "ConnectModule",
+    z.object({}).catchall(z.unknown()).describe("ConnectModule"),
+  );
+  validationSchemaStorage.register(
+    "ConnectModules",
+    z
+      .object({
+        modules: z.array(validationSchemaStorage.lazy("ConnectModule")),
+      })
+      .catchall(z.unknown())
+      .describe("ConnectModules"),
+  );
+  validationSchemaStorage.register(
+    "ErrorMessage",
+    z
+      .object({
+        message: z.string(),
+      })
+      .strict()
+      .describe("ErrorMessage"),
+  );
+}

package/src/openapi/platform/models/filter-sharing.ts

@@ -0,0 +1,103 @@
+// 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 the scope of the default sharing for new filters and dashboards. */
+export interface DefaultShareScope {
+  /**
+   * The scope of the default sharing for new filters and dashboards:
+   *
+   *  *  `AUTHENTICATED` Shared with all logged-in users.
+   *  *  `GLOBAL` Shared with all logged-in users. This shows as `AUTHENTICATED` in
+   * the response.
+   *  *  `PRIVATE` Not shared with any users.
+   */
+  scope: "GLOBAL" | "AUTHENTICATED" | "PRIVATE";
+}
+export interface SharePermissionInputBean {
+  /**
+   * The user account ID that the filter is shared with. For a request, specify the
+   * `accountId` property for the user.
+   */
+  accountId?: string;
+  /**
+   * The ID of the group, which uniquely identifies the group across all Atlassian
+   * products.For example, *952d12c3-5b5b-4d04-bb32-44d383afc4b2*. Cannot be
+   * provided with `groupname`.
+   */
+  groupId?: string;
+  /**
+   * The name of the group to share the filter with. Set `type` to `group`. Please
+   * note that the name of a group is mutable, to reliably identify a group use
+   * `groupId`.
+   */
+  groupname?: string;
+  /** The ID of the project to share the filter with. Set `type` to `project`. */
+  projectId?: string;
+  /**
+   * The ID of the project role to share the filter with. Set `type` to
+   * `projectRole` and the `projectId` for the project that the role is in.
+   */
+  projectRoleId?: string;
+  /** The rights for the share permission. */
+  rights?: number;
+  /**
+   * The type of the share permission.Specify the type as follows:
+   *
+   *  *  `user` Share with a user.
+   *  *  `group` Share with a group. Specify `groupname` as well.
+   *  *  `project` Share with a project. Specify `projectId` as well.
+   *  *  `projectRole` Share with a project role in a project. Specify `projectId`
+   * and `projectRoleId` as well.
+   *  *  `global` Share globally, including anonymous users. If set, this type
+   * overrides all existing share permissions and must be deleted before any
+   * non-global share permissions is set.
+   *  *  `authenticated` Share with all logged-in users. This shows as `loggedin` in
+   * the response. If set, this type overrides all existing share permissions and
+   * must be deleted before any non-global share permissions is set.
+   */
+  type:
+    | "user"
+    | "project"
+    | "group"
+    | "projectRole"
+    | "global"
+    | "authenticated";
+}
+export function registerFilterSharingValidationSchemas(
+  validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>,
+) {
+  validationSchemaStorage.register(
+    "DefaultShareScope",
+    z
+      .object({
+        scope: z.enum(["GLOBAL", "AUTHENTICATED", "PRIVATE"]),
+      })
+      .strict()
+      .describe("DefaultShareScope"),
+  );
+  validationSchemaStorage.register(
+    "SharePermissionInputBean",
+    z
+      .object({
+        accountId: z.string().optional(),
+        groupId: z.string().optional(),
+        groupname: z.string().optional(),
+        projectId: z.string().optional(),
+        projectRoleId: z.string().optional(),
+        rights: z.number().int().optional(),
+        type: z.enum([
+          "user",
+          "project",
+          "group",
+          "projectRole",
+          "global",
+          "authenticated",
+        ]),
+      })
+      .strict()
+      .describe("SharePermissionInputBean"),
+  );
+}

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

@@ -0,0 +1,319 @@
+// 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 GroupName,
+  registerCommonValidationSchemas,
+  type SharePermission,
+  type User,
+} from "./common";
+/** The account ID of the new owner. */
+export interface ChangeFilterOwner {
+  /** The account ID of the new owner. */
+  accountId: string;
+}
+/** Details about a filter. */
+export interface Filter {
+  /**
+   * \[Experimental\] Approximate last used time. Returns the date and time when the
+   * filter was last used. Returns `null` if the filter hasn't been used after
+   * tracking was enabled. For performance reasons, timestamps aren't updated in
+   * real time and therefore may not be exactly accurate.
+   */
+  approximateLastUsed?: string;
+  /** A description of the filter. */
+  description?: string;
+  /** The groups and projects that can edit the filter. */
+  editPermissions?: SharePermission[];
+  /** Whether the filter is selected as a favorite. */
+  favourite?: boolean;
+  /**
+   * The count of how many users have selected this filter as a favorite, including
+   * the filter owner.
+   */
+  favouritedCount?: number;
+  /** The unique identifier for the filter. */
+  id?: string;
+  /** The JQL query for the filter. For example, *project = SSP AND issuetype = Bug*. */
+  jql?: string;
+  /** The name of the filter. Must be unique. */
+  name: string;
+  /**
+   * The user who owns the filter. This is defaulted to the creator of the filter,
+   * however Jira administrators can change the owner of a shared filter in the
+   * admin settings.
+   */
+  owner?: User;
+  /**
+   * A URL to view the filter results in Jira, using the [Search for issues using
+   * JQL](#api-rest-api-3-filter-search-get) operation with the filter's JQL string
+   * to return the filter results. For example,
+   * *https://your-domain.atlassian.net/rest/api/3/search?jql=project+%3D+SSP+AND+issuetype+%3D+Bug*.
+   */
+  searchUrl?: string;
+  /** The URL of the filter. */
+  self?: string;
+  /** The groups and projects that the filter is shared with. */
+  sharePermissions?: SharePermission[];
+  /**
+   * A paginated list of the users that the filter is shared with. This includes
+   * users that are members of the groups or can browse the projects that the filter
+   * is shared with.
+   */
+  sharedUsers?: UserList;
+  /** A paginated list of the users that are subscribed to the filter. */
+  subscriptions?: FilterSubscriptionsList;
+  /**
+   * A URL to view the filter results in Jira, using the ID of the filter. For
+   * example, *https://your-domain.atlassian.net/issues/?filter=10100*.
+   */
+  viewUrl?: string;
+}
+/** Details of a filter. */
+export interface FilterDetails {
+  /**
+   * \[Experimental\] Approximate last used time. Returns the date and time when the
+   * filter was last used. Returns `null` if the filter hasn't been used after
+   * tracking was enabled. For performance reasons, timestamps aren't updated in
+   * real time and therefore may not be exactly accurate.
+   */
+  approximateLastUsed?: string;
+  /** The description of the filter. */
+  description?: string;
+  /**
+   * The groups and projects that can edit the filter. This can be specified when
+   * updating a filter, but not when creating a filter.
+   */
+  editPermissions?: SharePermission[];
+  /** Expand options that include additional filter details in the response. */
+  expand?: string;
+  /**
+   * Whether the filter is selected as a favorite by any users, not including the
+   * filter owner.
+   */
+  favourite?: boolean;
+  /**
+   * The count of how many users have selected this filter as a favorite, including
+   * the filter owner.
+   */
+  favouritedCount?: number;
+  /** The unique identifier for the filter. */
+  id?: string;
+  /** The JQL query for the filter. For example, *project = SSP AND issuetype = Bug*. */
+  jql?: string;
+  /** The name of the filter. */
+  name: string;
+  /**
+   * The user who owns the filter. Defaults to the creator of the filter, however,
+   * Jira administrators can change the owner of a shared filter in the admin
+   * settings.
+   */
+  owner?: User;
+  /**
+   * A URL to view the filter results in Jira, using the [Search for issues using
+   * JQL](#api-rest-api-3-filter-search-get) operation with the filter's JQL string
+   * to return the filter results. For example,
+   * *https://your-domain.atlassian.net/rest/api/3/search?jql=project+%3D+SSP+AND+issuetype+%3D+Bug*.
+   */
+  searchUrl?: string;
+  /** The URL of the filter. */
+  self?: string;
+  /**
+   * The groups and projects that the filter is shared with. This can be specified
+   * when updating a filter, but not when creating a filter.
+   */
+  sharePermissions?: SharePermission[];
+  /** The users that are subscribed to the filter. */
+  subscriptions?: FilterSubscription[];
+  /**
+   * A URL to view the filter results in Jira, using the ID of the filter. For
+   * example, *https://your-domain.atlassian.net/issues/?filter=10100*.
+   */
+  viewUrl?: string;
+}
+/** Details of a user or group subscribing to a filter. */
+export interface FilterSubscription {
+  /** The group subscribing to filter. */
+  group?: GroupName;
+  /** The ID of the filter subscription. */
+  id?: number;
+  /** The user subscribing to filter. */
+  user?: User;
+}
+/** A paginated list of subscriptions to a filter. */
+export interface FilterSubscriptionsList {
+  /** The index of the last item returned on the page. */
+  "end-index"?: number;
+  /** The list of items. */
+  items?: FilterSubscription[];
+  /** The maximum number of results that could be on the page. */
+  "max-results"?: number;
+  /** The number of items on the page. */
+  size?: number;
+  /** The index of the first item returned on the page. */
+  "start-index"?: number;
+}
+/** A page of items. */
+export interface PageBeanFilterDetails {
+  /** 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?: FilterDetails[];
+}
+/**
+ * A paginated list of users sharing the filter. This includes users that are
+ * members of the groups or can browse the projects that the filter is shared with.
+ */
+export interface UserList {
+  /** The index of the last item returned on the page. */
+  "end-index"?: number;
+  /** The list of items. */
+  items?: User[];
+  /** The maximum number of results that could be on the page. */
+  "max-results"?: number;
+  /** The number of items on the page. */
+  size?: number;
+  /** The index of the first item returned on the page. */
+  "start-index"?: number;
+}
+export function registerFiltersValidationSchemas(
+  validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>,
+) {
+  validationSchemaStorage.register(
+    "ChangeFilterOwner",
+    z
+      .object({
+        accountId: z.string(),
+      })
+      .strict()
+      .describe("ChangeFilterOwner"),
+  );
+  validationSchemaStorage.register(
+    "Filter",
+    z
+      .object({
+        approximateLastUsed: z.string().optional(),
+        description: z.string().optional(),
+        editPermissions: z
+          .array(validationSchemaStorage.lazy("SharePermission"))
+          .optional(),
+        favourite: z.boolean().optional(),
+        favouritedCount: z.number().int().optional(),
+        id: z.string().optional(),
+        jql: z.string().optional(),
+        name: z.string(),
+        owner: validationSchemaStorage.lazy("User").optional(),
+        searchUrl: z.string().optional(),
+        self: z.string().optional(),
+        sharePermissions: z
+          .array(validationSchemaStorage.lazy("SharePermission"))
+          .optional(),
+        sharedUsers: validationSchemaStorage.lazy("UserList").optional(),
+        subscriptions: validationSchemaStorage
+          .lazy("FilterSubscriptionsList")
+          .optional(),
+        viewUrl: z.string().optional(),
+      })
+      .strict()
+      .describe("Filter"),
+  );
+  validationSchemaStorage.register(
+    "FilterDetails",
+    z
+      .object({
+        approximateLastUsed: z.string().optional(),
+        description: z.string().optional(),
+        editPermissions: z
+          .array(validationSchemaStorage.lazy("SharePermission"))
+          .optional(),
+        expand: z.string().optional(),
+        favourite: z.boolean().optional(),
+        favouritedCount: z.number().int().optional(),
+        id: z.string().optional(),
+        jql: z.string().optional(),
+        name: z.string(),
+        owner: validationSchemaStorage.lazy("User").optional(),
+        searchUrl: z.string().optional(),
+        self: z.string().optional(),
+        sharePermissions: z
+          .array(validationSchemaStorage.lazy("SharePermission"))
+          .optional(),
+        subscriptions: z
+          .array(validationSchemaStorage.lazy("FilterSubscription"))
+          .optional(),
+        viewUrl: z.string().optional(),
+      })
+      .strict()
+      .describe("FilterDetails"),
+  );
+  validationSchemaStorage.register(
+    "FilterSubscription",
+    z
+      .object({
+        group: validationSchemaStorage.lazy("GroupName").optional(),
+        id: z.number().int().optional(),
+        user: validationSchemaStorage.lazy("User").optional(),
+      })
+      .strict()
+      .describe("FilterSubscription"),
+  );
+  validationSchemaStorage.register(
+    "FilterSubscriptionsList",
+    z
+      .object({
+        "end-index": z.number().int().optional(),
+        items: z
+          .array(validationSchemaStorage.lazy("FilterSubscription"))
+          .optional(),
+        "max-results": z.number().int().optional(),
+        size: z.number().int().optional(),
+        "start-index": z.number().int().optional(),
+      })
+      .strict()
+      .describe("FilterSubscriptionsList"),
+  );
+  validationSchemaStorage.register(
+    "PageBeanFilterDetails",
+    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("FilterDetails"))
+          .optional(),
+      })
+      .strict()
+      .describe("PageBeanFilterDetails"),
+  );
+  validationSchemaStorage.register(
+    "UserList",
+    z
+      .object({
+        "end-index": z.number().int().optional(),
+        items: z.array(validationSchemaStorage.lazy("User")).optional(),
+        "max-results": z.number().int().optional(),
+        size: z.number().int().optional(),
+        "start-index": z.number().int().optional(),
+      })
+      .strict()
+      .describe("UserList"),
+  );
+  validationSchemaStorage.registerOnce([registerCommonValidationSchemas]);
+}

package/src/openapi/platform/models/group-and-user-picker.ts

@@ -0,0 +1,85 @@
+// 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 FoundGroups,
+  type FoundUsers,
+  registerCommonValidationSchemas,
+} from "./common";
+/** List of users and groups found in a search. */
+export interface FoundUsersAndGroups {
+  /**
+   * The list of groups found in a search, including header text (Showing X of Y
+   * matching groups) and total of matched groups.
+   */
+  groups?: FoundGroups;
+  /**
+   * The list of users found in a search, including header text (Showing X of Y
+   * matching users) and total of matched users.
+   */
+  users?: FoundUsers;
+}
+/** A user found in a search. */
+export interface UserPickerUser {
+  /**
+   * The account ID of the user, which uniquely identifies the user across all
+   * Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.
+   */
+  accountId?: string;
+  /** The avatar URL of the user. */
+  avatarUrl?: string;
+  /**
+   * The display name of the user. Depending on the user’s privacy setting, this may
+   * be returned as null.
+   */
+  displayName?: string;
+  /**
+   * The display name, email address, and key of the user with the matched query
+   * string highlighted with the HTML bold tag.
+   */
+  html?: string;
+  /**
+   * This property is no longer available. See the [deprecation
+   * notice](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 [deprecation
+   * notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/)
+   * for details.
+   */
+  name?: string;
+}
+export function registerGroupAndUserPickerValidationSchemas(
+  validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>,
+) {
+  validationSchemaStorage.register(
+    "FoundUsersAndGroups",
+    z
+      .object({
+        groups: validationSchemaStorage.lazy("FoundGroups").optional(),
+        users: validationSchemaStorage.lazy("FoundUsers").optional(),
+      })
+      .strict()
+      .describe("FoundUsersAndGroups"),
+  );
+  validationSchemaStorage.register(
+    "UserPickerUser",
+    z
+      .object({
+        accountId: z.string().optional(),
+        avatarUrl: z.string().optional(),
+        displayName: z.string().optional(),
+        html: z.string().optional(),
+        key: z.string().optional(),
+        name: z.string().optional(),
+      })
+      .strict()
+      .describe("UserPickerUser"),
+  );
+  validationSchemaStorage.registerOnce([registerCommonValidationSchemas]);
+}