@resolution/jira-api-client 0.1.0 → 0.1.2

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

@@ -1,224 +0,0 @@
-// DO NOT EDIT!
-// This file is generated by "api-typescript-generator".
-// To update this file run "yarn build:openapi".
-import { z } from "zod";
-
-import * as commonHttpClient from "../core/common-http-client";
-import { CommonHttpService } from "../core/common-http-service";
-import {
-  type FoundUsersAndGroups,
-  registerGroupAndUserPickerValidationSchemas,
-} from "../models/group-and-user-picker";
-import { validationSchemaStorage } from "../validation-schema-storage";
-/**
- * This resource represents a list of users and a list of groups. Use it to obtain
- * the details to populate user and group picker suggestions list.
- */
-export class GroupAndUserPickerService extends CommonHttpService {
-  /**
-   * Returns a list of users and groups matching a string. The string is used:
-   *
-   *  *  for users, to find a case-insensitive match with display name and e-mail
-   * address. Note that if a user has hidden their email address in their user
-   * profile, partial matches of the email address will not find the user. An exact
-   * match is required.
-   *  *  for groups, to find a case-sensitive match with group name.
-   *
-   * For example, if the string *tin* is used, records with the display name *Tina*,
-   * email address *sarah@tinplatetraining.com*, and the group *accounting* would be
-   * returned.
-   *
-   * Optionally, the search can be refined to:
-   *
-   *  *  the projects and issue types associated with a custom field, such as a user
-   * picker. The search can then be further refined to return only users and groups
-   * that have permission to view specific:
-   *
-   *      *  projects.
-   *      *  issue types.
-   *
-   *     If multiple projects or issue types are specified, they must be a subset of
-   * those enabled for the custom field or no results are returned. For example, if
-   * a field is enabled for projects A, B, and C then the search could be limited to
-   * projects B and C. However, if the search is limited to projects B and D,
-   * nothing is returned.
-   *  *  not return Connect app users and groups.
-   *  *  return groups that have a case-insensitive match with the query.
-   *
-   * The primary use case for this resource is to populate a picker field suggestion
-   * list with users or groups. To this end, the returned object includes an `html`
-   * field for each list. This field highlights the matched query term in the item
-   * name with the HTML strong tag. Also, each list is wrapped in a response object
-   * that contains a header for use in a picker, specifically *Showing X of Y
-   * matching groups*.
-   *
-   * This operation can be accessed anonymously.
-   *
-   * **[Permissions](#permissions) required:** *Browse users and groups* [global
-   * permission](https://confluence.atlassian.com/x/yodKLg).
-   *
-   * @returns Returned if the request is successful.
-   *
-   * example: {
-   *   "groups": {
-   *     "groups": [
-   *       {
-   *         "groupId": "276f955c-63d7-42c8-9520-92d01dca0625",
-   *         "html": "<b>j</b>dog-developers",
-   *         "name": "jdog-developers"
-   *       },
-   *       {
-   *         "groupId": "6e87dc72-4f1f-421f-9382-2fee8b652487",
-   *         "html": "<b>j</b>uvenal-bot",
-   *         "name": "juvenal-bot"
-   *       }
-   *     ],
-   *     "header": "Showing 20 of 25 matching groups",
-   *     "total": 25
-   *   },
-   *   "users": {
-   *     "header": "Showing 20 of 25 matching groups",
-   *     "total": 25,
-   *     "users": [
-   *       {
-   *         "accountId": "5b10a2844c20165700ede21g",
-   *         "accountType": "atlassian",
-   *         "avatarUrl":
-   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
-   *         "displayName": "Mia Krystof",
-   *         "html": "<strong>Mi</strong>a Krystof -
-   * <strong>mi</strong>a@example.com (<strong>mi</strong>a)",
-   *         "key": "mia",
-   *         "name": "mia"
-   *       }
-   *     ]
-   *   }
-   * }
-   * @path {GET} /rest/api/3/groupuserpicker
-   * @scopes-current read:jira-work
-   * @scopes-beta read:group:jira, read:user:jira
-   */
-  findUsersAndGroups({
-    query,
-    maxResults,
-    showAvatar,
-    fieldId,
-    projectId,
-    issueTypeId,
-    avatarSize,
-    caseInsensitive,
-    excludeConnectAddons,
-  }: {
-    /** The search string. */
-    query: string;
-    /** The maximum number of items to return in each list. */
-    maxResults?: number;
-    /**
-     * Whether the user avatar should be returned. If an invalid value is provided,
-     * the default value is used.
-     */
-    showAvatar?: boolean;
-    /** The custom field ID of the field this request is for. */
-    fieldId?: string;
-    /**
-     * The ID of a project that returned users and groups must have permission to
-     * view. To include multiple projects, provide an ampersand-separated list. For
-     * example, `projectId=10000&projectId=10001`. This parameter is only used when
-     * `fieldId` is present.
-     */
-    projectId?: string[];
-    /**
-     * The ID of an issue type that returned users and groups must have permission to
-     * view. To include multiple issue types, provide an ampersand-separated list. For
-     * example, `issueTypeId=10000&issueTypeId=10001`. Special values, such as `-1`
-     * (all standard issue types) and `-2` (all subtask issue types), are supported.
-     * This parameter is only used when `fieldId` is present.
-     */
-    issueTypeId?: string[];
-    /**
-     * The size of the avatar to return. If an invalid value is provided, the default
-     * value is used.
-     */
-    avatarSize?:
-      | "xsmall"
-      | "xsmall@2x"
-      | "xsmall@3x"
-      | "small"
-      | "small@2x"
-      | "small@3x"
-      | "medium"
-      | "medium@2x"
-      | "medium@3x"
-      | "large"
-      | "large@2x"
-      | "large@3x"
-      | "xlarge"
-      | "xlarge@2x"
-      | "xlarge@3x"
-      | "xxlarge"
-      | "xxlarge@2x"
-      | "xxlarge@3x"
-      | "xxxlarge"
-      | "xxxlarge@2x"
-      | "xxxlarge@3x";
-    /** Whether the search for groups should be case insensitive. */
-    caseInsensitive?: boolean;
-    /**
-     * Whether Connect app users and groups should be excluded from the search
-     * results. If an invalid value is provided, the default value is used.
-     */
-    excludeConnectAddons?: boolean;
-  }): Promise<FoundUsersAndGroups> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/groupuserpicker",
-        method: "GET",
-        query: {
-          query,
-          maxResults,
-          showAvatar,
-          fieldId,
-          projectId,
-          issueTypeId,
-          avatarSize,
-          caseInsensitive,
-          excludeConnectAddons,
-        },
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: FoundUsersAndGroups;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "GroupAndUserPickerService.findUsersAndGroups.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  static initialize() {
-    validationSchemaStorage.registerExtensible(
-      "GroupAndUserPickerService.findUsersAndGroups.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: validationSchemaStorage.lazy("FoundUsersAndGroups"),
-        })
-        .describe("GroupAndUserPickerService.findUsersAndGroups.response"),
-    );
-    validationSchemaStorage.registerOnce([
-      registerGroupAndUserPickerValidationSchemas,
-    ]);
-  }
-}