@resolution/jira-api-client 0.1.0

package/src/openapi/platform/services/users-service.ts

@@ -0,0 +1,1108 @@
+// 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 ColumnItem,
+  type GroupName,
+  type PageBeanUser,
+  registerCommonValidationSchemas,
+  type User,
+} from "../models/common";
+import {
+  type NewUserDetails,
+  registerUsersValidationSchemas,
+  type UnrestrictedUserEmail,
+  type UserColumnRequestBody,
+  type UserMigrationBean,
+} from "../models/users";
+import { validationSchemaStorage } from "../validation-schema-storage";
+/**
+ * This resource represent users. Use it to:
+ *
+ *  *  get, get a list of, create, and delete users.
+ *  *  get, set, and reset a user's default issue table columns.
+ *  *  get a list of the groups the user belongs to.
+ *  *  get a list of user account IDs for a list of usernames or user keys.
+ */
+export class UsersService extends CommonHttpService {
+  /**
+   * Returns a [paginated](#pagination) list of the users specified by one or more
+   * account IDs.
+   *
+   * **[Permissions](#permissions) required:** Permission to access Jira.
+   *
+   * @returns Returned if the request is successful.
+   *
+   * example: {
+   *   "isLast": true,
+   *   "maxResults": 100,
+   *   "startAt": 0,
+   *   "total": 1,
+   *   "values": [
+   *     {
+   *       "accountId": "5b10a2844c20165700ede21g",
+   *       "accountType": "atlassian",
+   *       "active": true,
+   *       "avatarUrls": {
+   *         "16x16":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
+   *         "24x24":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
+   *         "32x32":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
+   *         "48x48":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
+   *       },
+   *       "displayName": "Mia Krystof",
+   *       "emailAddress": "mia@example.com",
+   *       "self":
+   * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
+   *       "timeZone": "Australia/Sydney"
+   *     }
+   *   ]
+   * }
+   * @path {GET} /rest/api/3/user/bulk
+   * @scopes-current read:jira-user
+   * @scopes-beta read:application-role:jira, read:group:jira, read:user:jira, read:avatar:jira
+   */
+  bulkGetUsers({
+    startAt,
+    maxResults,
+    username,
+    key,
+    accountId,
+  }: {
+    /** The index of the first item to return in a page of results (page offset). */
+    startAt?: number;
+    /** The maximum number of items to return per page. */
+    maxResults?: number;
+    /**
+     * This parameter 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.
+     */
+    username?: string[];
+    /**
+     * This parameter 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[];
+    /**
+     * The account ID of a user. To specify multiple users, pass multiple `accountId`
+     * parameters. For example,
+     * `accountId=5b10a2844c20165700ede21g&accountId=5b10ac8d82e05b22cc7d4ef5`.
+     */
+    accountId: string[];
+  }): Promise<PageBeanUser> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/user/bulk",
+        method: "GET",
+        query: {
+          startAt,
+          maxResults,
+          username,
+          key,
+          accountId,
+        },
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          200: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 200;
+          mediaType: "application/json";
+          body: PageBeanUser;
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator("UsersService.bulkGetUsers.response"),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  /**
+   * Returns the account IDs for the users specified in the `key` or `username`
+   * parameters. Note that multiple `key` or `username` parameters can be specified.
+   *
+   * **[Permissions](#permissions) required:** Permission to access Jira.
+   *
+   * @returns Returned if the request is successful.
+   *
+   * example: [
+   *   {
+   *     "username": "mia",
+   *     "accountId": "5b10a2844c20165700ede21g"
+   *   },
+   *   {
+   *     "username": "emma",
+   *     "accountId": "5b10ac8d82e05b22cc7d4ef5"
+   *   }
+   * ]
+   * @path {GET} /rest/api/3/user/bulk/migration
+   * @scopes-current read:jira-user
+   * @scopes-beta read:user:jira
+   */
+  bulkGetUsersMigration({
+    startAt,
+    maxResults,
+    username,
+    key,
+  }: {
+    /** The index of the first item to return in a page of results (page offset). */
+    startAt?: number;
+    /** The maximum number of items to return per page. */
+    maxResults?: number;
+    /**
+     * Username of a user. To specify multiple users, pass multiple copies of this
+     * parameter. For example, `username=fred&username=barney`. Required if `key`
+     * isn't provided. Cannot be provided if `key` is present.
+     */
+    username?: string[];
+    /**
+     * Key of a user. To specify multiple users, pass multiple copies of this
+     * parameter. For example, `key=fred&key=barney`. Required if `username` isn't
+     * provided. Cannot be provided if `username` is present.
+     */
+    key?: string[];
+  }): Promise<UserMigrationBean[]> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/user/bulk/migration",
+        method: "GET",
+        query: {
+          startAt,
+          maxResults,
+          username,
+          key,
+        },
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          200: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 200;
+          mediaType: "application/json";
+          body: UserMigrationBean[];
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "UsersService.bulkGetUsersMigration.response",
+        ),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  /**
+   * Creates a user. This resource is retained for legacy compatibility. As soon as
+   * a more suitable alternative is available this resource will be deprecated.
+   *
+   * If the user exists and has access to Jira, the operation returns a 201 status.
+   * If the user exists but does not have access to Jira, the operation returns a
+   * 400 status.
+   *
+   * **[Permissions](#permissions) required:** *Administer Jira* [global
+   * permission](https://confluence.atlassian.com/x/x4dKLg).
+   *
+   * @returns Returned if the request is successful.
+   *
+   * example: {
+   *   "accountId": "5b10a2844c20165700ede21g",
+   *   "accountType": "atlassian",
+   *   "active": true,
+   *   "applicationRoles": {
+   *     "items": [],
+   *     "size": 1
+   *   },
+   *   "avatarUrls": {
+   *     "16x16":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
+   *     "24x24":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
+   *     "32x32":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
+   *     "48x48":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
+   *   },
+   *   "displayName": "Mia Krystof",
+   *   "emailAddress": "mia@example.com",
+   *   "groups": {
+   *     "items": [],
+   *     "size": 3
+   *   },
+   *   "key": "",
+   *   "name": "",
+   *   "self":
+   * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
+   *   "timeZone": "Australia/Sydney"
+   * }
+   * @path {POST} /rest/api/3/user
+   */
+  createUser({
+    newUserDetails,
+  }: {
+    /**
+     * Details about the user to be created.
+     *
+     * @example {
+     *     "emailAddress": "mia@atlassian.com"
+     * }
+     */
+    newUserDetails: NewUserDetails;
+  }): Promise<User> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/user",
+        method: "POST",
+        headers: {
+          "Content-Type": "application/json",
+        },
+        body: newUserDetails,
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          201: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 201;
+          mediaType: "application/json";
+          body: User;
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator("UsersService.createUser.response"),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  /**
+   * Returns a list of all users, including active users, inactive users and
+   * previously deleted users that have an Atlassian account.
+   *
+   * Privacy controls are applied to the response based on the users' preferences.
+   * This could mean, for example, that the user's email address is hidden. See the
+   * [Profile visibility
+   * overview](https://developer.atlassian.com/cloud/jira/platform/profile-visibility/)
+   * for more details.
+   *
+   * **[Permissions](#permissions) required:** *Browse users and groups* [global
+   * permission](https://confluence.atlassian.com/x/x4dKLg).
+   *
+   * @returns Returned if the request is successful.
+   *
+   * example: [
+   *   {
+   *     "accountId": "5b10a2844c20165700ede21g",
+   *     "accountType": "atlassian",
+   *     "active": false,
+   *     "avatarUrls": {
+   *       "16x16":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
+   *       "24x24":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
+   *       "32x32":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
+   *       "48x48":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
+   *     },
+   *     "displayName": "Mia Krystof",
+   *     "key": "",
+   *     "name": "",
+   *     "self":
+   * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+   *   },
+   *   {
+   *     "accountId": "5b10ac8d82e05b22cc7d4ef5",
+   *     "accountType": "atlassian",
+   *     "active": false,
+   *     "avatarUrls": {
+   *       "16x16":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=16&s=16",
+   *       "24x24":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=24&s=24",
+   *       "32x32":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=32&s=32",
+   *       "48x48":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=48&s=48"
+   *     },
+   *     "displayName": "Emma Richards",
+   *     "key": "",
+   *     "name": "",
+   *     "self":
+   * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10ac8d82e05b22cc7d4ef5"
+   *   }
+   * ]
+   * @path {GET} /rest/api/3/users/search
+   * @scopes-current read:jira-user
+   * @scopes-beta read:user:jira, read:application-role:jira, read:avatar:jira, read:group:jira
+   */
+  getAllUsers({
+    startAt,
+    maxResults,
+  }: {
+    /** The index of the first item to return. */
+    startAt?: number;
+    /** The maximum number of items to return. */
+    maxResults?: number;
+  }): Promise<User[]> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/users/search",
+        method: "GET",
+        query: {
+          startAt,
+          maxResults,
+        },
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          200: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 200;
+          mediaType: "application/json";
+          body: User[];
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator("UsersService.getAllUsers.response"),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  /**
+   * Returns a list of all users, including active users, inactive users and
+   * previously deleted users that have an Atlassian account.
+   *
+   * Privacy controls are applied to the response based on the users' preferences.
+   * This could mean, for example, that the user's email address is hidden. See the
+   * [Profile visibility
+   * overview](https://developer.atlassian.com/cloud/jira/platform/profile-visibility/)
+   * for more details.
+   *
+   * **[Permissions](#permissions) required:** *Browse users and groups* [global
+   * permission](https://confluence.atlassian.com/x/x4dKLg).
+   *
+   * @returns Returned if the request is successful.
+   *
+   * example: [
+   *   {
+   *     "accountId": "5b10a2844c20165700ede21g",
+   *     "accountType": "atlassian",
+   *     "active": false,
+   *     "avatarUrls": {
+   *       "16x16":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
+   *       "24x24":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
+   *       "32x32":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
+   *       "48x48":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
+   *     },
+   *     "displayName": "Mia Krystof",
+   *     "key": "",
+   *     "name": "",
+   *     "self":
+   * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+   *   },
+   *   {
+   *     "accountId": "5b10ac8d82e05b22cc7d4ef5",
+   *     "accountType": "atlassian",
+   *     "active": false,
+   *     "avatarUrls": {
+   *       "16x16":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=16&s=16",
+   *       "24x24":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=24&s=24",
+   *       "32x32":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=32&s=32",
+   *       "48x48":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=48&s=48"
+   *     },
+   *     "displayName": "Emma Richards",
+   *     "key": "",
+   *     "name": "",
+   *     "self":
+   * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10ac8d82e05b22cc7d4ef5"
+   *   }
+   * ]
+   * @path {GET} /rest/api/3/users
+   * @scopes-current read:jira-user
+   * @scopes-beta read:user:jira, read:application-role:jira, read:avatar:jira, read:group:jira
+   */
+  getAllUsersDefault({
+    startAt,
+    maxResults,
+  }: {
+    /** The index of the first item to return. */
+    startAt?: number;
+    /** The maximum number of items to return. */
+    maxResults?: number;
+  }): Promise<User[]> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/users",
+        method: "GET",
+        query: {
+          startAt,
+          maxResults,
+        },
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          200: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 200;
+          mediaType: "application/json";
+          body: User[];
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "UsersService.getAllUsersDefault.response",
+        ),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  /**
+   * Returns a user.
+   *
+   * Privacy controls are applied to the response based on the user's preferences.
+   * This could mean, for example, that the user's email address is hidden. See the
+   * [Profile visibility
+   * overview](https://developer.atlassian.com/cloud/jira/platform/profile-visibility/)
+   * for more details.
+   *
+   * **[Permissions](#permissions) required:** *Browse users and groups* [global
+   * permission](https://confluence.atlassian.com/x/x4dKLg).
+   *
+   * @returns Returned if the request is successful.
+   *
+   * example: {
+   *   "accountId": "5b10a2844c20165700ede21g",
+   *   "accountType": "atlassian",
+   *   "active": true,
+   *   "applicationRoles": {
+   *     "items": [],
+   *     "size": 1
+   *   },
+   *   "avatarUrls": {
+   *     "16x16":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
+   *     "24x24":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
+   *     "32x32":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
+   *     "48x48":
+   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
+   *   },
+   *   "displayName": "Mia Krystof",
+   *   "emailAddress": "mia@example.com",
+   *   "groups": {
+   *     "items": [],
+   *     "size": 3
+   *   },
+   *   "key": "",
+   *   "name": "",
+   *   "self":
+   * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
+   *   "timeZone": "Australia/Sydney"
+   * }
+   * @path {GET} /rest/api/3/user
+   * @scopes-current read:jira-user
+   * @scopes-beta read:application-role:jira, read:group:jira, read:user:jira, read:avatar:jira
+   */
+  getUser({
+    accountId,
+    username,
+    key,
+    expand,
+  }: {
+    /**
+     * The account ID of the user, which uniquely identifies the user across all
+     * Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required.
+     */
+    accountId?: string;
+    /**
+     * This parameter is no longer available. See the [deprecation
+     * notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide)
+     * for details.
+     */
+    username?: string;
+    /**
+     * This parameter 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;
+    /**
+     * Use [expand](#expansion) to include additional information about users in the
+     * response. This parameter accepts a comma-separated list. Expand options include:
+     *
+     *  *  `groups` includes all groups and nested groups to which the user belongs.
+     *  *  `applicationRoles` includes details of all the applications to which the
+     * user has access.
+     */
+    expand?: string;
+  }): Promise<User> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/user",
+        method: "GET",
+        query: {
+          accountId,
+          username,
+          key,
+          expand,
+        },
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          200: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 200;
+          mediaType: "application/json";
+          body: User;
+        }>(),
+      )
+      .then(validationSchemaStorage.validator("UsersService.getUser.response"))
+      .then(commonHttpClient.getBody);
+  }
+  /**
+   * Returns the default [issue table
+   * columns](https://confluence.atlassian.com/x/XYdKLg) for the user. If
+   * `accountId` is not passed in the request, the calling user's details are
+   * returned.
+   *
+   * **[Permissions](#permissions) required:**
+   *
+   *  *  *Administer Jira* [global
+   * permission](https://confluence.atlassian.com/x/x4dKLgl), to get the column
+   * details for any user.
+   *  *  Permission to access Jira, to get the calling user's column details.
+   *
+   * @returns Returned if the request is successful.
+   * @path {GET} /rest/api/3/user/columns
+   * @scopes-current read:jira-user
+   * @scopes-beta read:user.columns:jira, read:filter.column:jira
+   */
+  getUserDefaultColumns({
+    accountId,
+    username,
+  }: {
+    /**
+     * The account ID of the user, which uniquely identifies the user across all
+     * Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.
+     */
+    accountId?: string;
+    /**
+     * This parameter is no longer available See the [deprecation
+     * notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/)
+     * for details.
+     */
+    username?: string;
+  }): Promise<ColumnItem[]> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/user/columns",
+        method: "GET",
+        query: {
+          accountId,
+          username,
+        },
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          200: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 200;
+          mediaType: "application/json";
+          body: ColumnItem[];
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "UsersService.getUserDefaultColumns.response",
+        ),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  /**
+   * Returns a user's email address. This API is only available to apps approved by
+   * Atlassian, according to these
+   * [guidelines](https://community.developer.atlassian.com/t/guidelines-for-requesting-access-to-email-address/27603).
+   *
+   * @returns Returned if the request is successful.
+   *
+   * example: name@example.com
+   * @path {GET} /rest/api/3/user/email
+   */
+  getUserEmail({
+    accountId,
+  }: {
+    /**
+     * The account ID of the user, which uniquely identifies the user across all
+     * Atlassian products. For example, `5b10ac8d82e05b22cc7d4ef5`.
+     */
+    accountId: string;
+  }): Promise<UnrestrictedUserEmail> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/user/email",
+        method: "GET",
+        query: {
+          accountId,
+        },
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          200: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 200;
+          mediaType: "application/json";
+          body: UnrestrictedUserEmail;
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator("UsersService.getUserEmail.response"),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  /**
+   * Returns a user's email address. This API is only available to apps approved by
+   * Atlassian, according to these
+   * [guidelines](https://community.developer.atlassian.com/t/guidelines-for-requesting-access-to-email-address/27603).
+   *
+   * @returns Returned if the request is successful.
+   * @path {GET} /rest/api/3/user/email/bulk
+   */
+  getUserEmailBulk({
+    accountId,
+  }: {
+    /**
+     * The account IDs of the users for which emails are required. An `accountId` is
+     * an identifier that uniquely identifies the user across all Atlassian products.
+     * For example, `5b10ac8d82e05b22cc7d4ef5`. Note, this should be treated as an
+     * opaque identifier (that is, do not assume any structure in the value).
+     */
+    accountId: string[];
+  }): Promise<UnrestrictedUserEmail> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/user/email/bulk",
+        method: "GET",
+        query: {
+          accountId,
+        },
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          200: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 200;
+          mediaType: "application/json";
+          body: UnrestrictedUserEmail;
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "UsersService.getUserEmailBulk.response",
+        ),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  /**
+   * Returns the groups to which a user belongs.
+   *
+   * **[Permissions](#permissions) required:** *Browse users and groups* [global
+   * permission](https://confluence.atlassian.com/x/x4dKLg).
+   *
+   * @returns Returned if the request is successful.
+   *
+   * example: {
+   *   "groupId": "276f955c-63d7-42c8-9520-92d01dca0625",
+   *   "name": "jira-administrators",
+   *   "self":
+   * "https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625"
+   * }
+   * @path {GET} /rest/api/3/user/groups
+   * @scopes-current read:jira-user
+   * @scopes-beta read:group:jira
+   */
+  getUserGroups({
+    accountId,
+    username,
+    key,
+  }: {
+    /**
+     * The account ID of the user, which uniquely identifies the user across all
+     * Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.
+     */
+    accountId: string;
+    /**
+     * This parameter is no longer available. See the [deprecation
+     * notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/)
+     * for details.
+     */
+    username?: string;
+    /**
+     * This parameter 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;
+  }): Promise<GroupName[]> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/user/groups",
+        method: "GET",
+        query: {
+          accountId,
+          username,
+          key,
+        },
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          200: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 200;
+          mediaType: "application/json";
+          body: GroupName[];
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "UsersService.getUserGroups.response",
+        ),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  /**
+   * Deletes a user. If the operation completes successfully then the user is
+   * removed from Jira's user base. This operation does not delete the user's
+   * Atlassian account.
+   *
+   * **[Permissions](#permissions) required:** Site administration (that is,
+   * membership of the *site-admin*
+   * [group](https://confluence.atlassian.com/x/24xjL)).
+   *
+   * @path {DELETE} /rest/api/3/user
+   */
+  removeUser({
+    accountId,
+    username,
+    key,
+  }: {
+    /**
+     * The account ID of the user, which uniquely identifies the user across all
+     * Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.
+     */
+    accountId: string;
+    /**
+     * This parameter is no longer available. See the [deprecation
+     * notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/)
+     * for details.
+     */
+    username?: string;
+    /**
+     * This parameter 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;
+  }): Promise<void> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/user",
+        method: "DELETE",
+        query: {
+          accountId,
+          username,
+          key,
+        },
+      })
+      .then(commonHttpClient.discardResult);
+  }
+  /**
+   * Resets the default [ issue table
+   * columns](https://confluence.atlassian.com/x/XYdKLg) for the user to the system
+   * default. If `accountId` is not passed, the calling user's default columns are
+   * reset.
+   *
+   * **[Permissions](#permissions) required:**
+   *
+   *  *  *Administer Jira* [global
+   * permission](https://confluence.atlassian.com/x/x4dKLg), to set the columns on
+   * any user.
+   *  *  Permission to access Jira, to set the calling user's columns.
+   *
+   * @path {DELETE} /rest/api/3/user/columns
+   */
+  resetUserColumns({
+    accountId,
+    username,
+  }: {
+    /**
+     * The account ID of the user, which uniquely identifies the user across all
+     * Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.
+     */
+    accountId?: string;
+    /**
+     * This parameter is no longer available. See the [deprecation
+     * notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/)
+     * for details.
+     */
+    username?: string;
+  }): Promise<void> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/user/columns",
+        method: "DELETE",
+        query: {
+          accountId,
+          username,
+        },
+      })
+      .then(commonHttpClient.discardResult);
+  }
+  /**
+   * Sets the default [ issue table
+   * columns](https://confluence.atlassian.com/x/XYdKLg) for the user. If an account
+   * ID is not passed, the calling user's default columns are set. If no column
+   * details are sent, then all default columns are removed.
+   *
+   * The parameters for this resource are expressed as HTML form data. For example,
+   * in curl:
+   *
+   * `curl -X PUT -d columns=summary -d columns=description
+   * https://your-domain.atlassian.net/rest/api/3/user/columns?accountId=5b10ac8d82e05b22cc7d4ef5'`
+   *
+   * **[Permissions](#permissions) required:**
+   *
+   *  *  *Administer Jira* [global
+   * permission](https://confluence.atlassian.com/x/x4dKLg), to set the columns on
+   * any user.
+   *  *  Permission to access Jira, to set the calling user's columns.
+   *
+   * @returns Returned if the request is successful.
+   * @path {PUT} /rest/api/3/user/columns
+   */
+  setUserColumns({
+    accountId,
+    userColumnRequestBody,
+  }: {
+    /**
+     * The account ID of the user, which uniquely identifies the user across all
+     * Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.
+     */
+    accountId?: string;
+    /**
+     * The ID of a column to set. To set multiple columns, send multiple `columns`
+     * parameters.
+     */
+    userColumnRequestBody: UserColumnRequestBody;
+  }): Promise<unknown> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/user/columns",
+        method: "PUT",
+        query: {
+          accountId,
+        },
+        headers: {
+          "Content-Type": "multipart/form-data",
+        },
+        body: userColumnRequestBody,
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          200: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 200;
+          mediaType: "application/json";
+          body: unknown;
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "UsersService.setUserColumns.response",
+        ),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  static initialize() {
+    validationSchemaStorage.registerExtensible(
+      "UsersService.getUser.response",
+      z
+        .object({
+          status: z.literal(200),
+          mediaType: z.literal("application/json"),
+          body: validationSchemaStorage.lazy("User"),
+        })
+        .describe("UsersService.getUser.response"),
+    );
+    validationSchemaStorage.registerExtensible(
+      "UsersService.createUser.response",
+      z
+        .object({
+          status: z.literal(201),
+          mediaType: z.literal("application/json"),
+          body: validationSchemaStorage.lazy("User"),
+        })
+        .describe("UsersService.createUser.response"),
+    );
+    validationSchemaStorage.registerExtensible(
+      "UsersService.bulkGetUsers.response",
+      z
+        .object({
+          status: z.literal(200),
+          mediaType: z.literal("application/json"),
+          body: validationSchemaStorage.lazy("PageBeanUser"),
+        })
+        .describe("UsersService.bulkGetUsers.response"),
+    );
+    validationSchemaStorage.registerExtensible(
+      "UsersService.bulkGetUsersMigration.response",
+      z
+        .object({
+          status: z.literal(200),
+          mediaType: z.literal("application/json"),
+          body: z.array(validationSchemaStorage.lazy("UserMigrationBean")),
+        })
+        .describe("UsersService.bulkGetUsersMigration.response"),
+    );
+    validationSchemaStorage.registerExtensible(
+      "UsersService.getUserDefaultColumns.response",
+      z
+        .object({
+          status: z.literal(200),
+          mediaType: z.literal("application/json"),
+          body: z.array(validationSchemaStorage.lazy("ColumnItem")),
+        })
+        .describe("UsersService.getUserDefaultColumns.response"),
+    );
+    validationSchemaStorage.registerExtensible(
+      "UsersService.setUserColumns.response",
+      z
+        .object({
+          status: z.literal(200),
+          mediaType: z.literal("application/json"),
+          body: z.unknown(),
+        })
+        .describe("UsersService.setUserColumns.response"),
+    );
+    validationSchemaStorage.registerExtensible(
+      "UsersService.getUserEmail.response",
+      z
+        .object({
+          status: z.literal(200),
+          mediaType: z.literal("application/json"),
+          body: validationSchemaStorage.lazy("UnrestrictedUserEmail"),
+        })
+        .describe("UsersService.getUserEmail.response"),
+    );
+    validationSchemaStorage.registerExtensible(
+      "UsersService.getUserEmailBulk.response",
+      z
+        .object({
+          status: z.literal(200),
+          mediaType: z.literal("application/json"),
+          body: validationSchemaStorage.lazy("UnrestrictedUserEmail"),
+        })
+        .describe("UsersService.getUserEmailBulk.response"),
+    );
+    validationSchemaStorage.registerExtensible(
+      "UsersService.getUserGroups.response",
+      z
+        .object({
+          status: z.literal(200),
+          mediaType: z.literal("application/json"),
+          body: z.array(validationSchemaStorage.lazy("GroupName")),
+        })
+        .describe("UsersService.getUserGroups.response"),
+    );
+    validationSchemaStorage.registerExtensible(
+      "UsersService.getAllUsersDefault.response",
+      z
+        .object({
+          status: z.literal(200),
+          mediaType: z.literal("application/json"),
+          body: z.array(validationSchemaStorage.lazy("User")),
+        })
+        .describe("UsersService.getAllUsersDefault.response"),
+    );
+    validationSchemaStorage.registerExtensible(
+      "UsersService.getAllUsers.response",
+      z
+        .object({
+          status: z.literal(200),
+          mediaType: z.literal("application/json"),
+          body: z.array(validationSchemaStorage.lazy("User")),
+        })
+        .describe("UsersService.getAllUsers.response"),
+    );
+    validationSchemaStorage.registerOnce([
+      registerCommonValidationSchemas,
+      registerUsersValidationSchemas,
+    ]);
+  }
+}