@resolution/jira-api-client 0.1.0

package/lib/openapi/platform/services/user-search-service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"user-search-service.js","sourceRoot":"","sources":["../../../../src/openapi/platform/services/user-search-service.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,+DAA+D;AAC/D,qEAAgE;AAChE,6CAK0B;AAC1B,uDAG+B;AAC/B,4EAAuE;AACvE;;;;;;GAMG;AACH,MAAa,iBAAkB,SAAQ,uCAAiB;IACtD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoEG;IACH,mBAAmB,CAAC,EAClB,KAAK,EACL,SAAS,EACT,QAAQ,EACR,SAAS,EACT,OAAO,EACP,QAAQ,EACR,OAAO,EACP,UAAU,EACV,kBAAkB,EAClB,SAAS,GA0CV;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,oCAAoC;YAC1C,MAAM,EAAE,KAAK;YACb,KAAK,EAAE;gBACL,KAAK;gBACL,SAAS;gBACT,QAAQ;gBACR,SAAS;gBACT,OAAO;gBACP,QAAQ;gBACR,OAAO;gBACP,UAAU;gBACV,kBAAkB;gBAClB,SAAS;aACV;SACF,CAAC;aACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;YACvC,GAAG,EAAE;gBACH,kBAAkB,EAAE,MAAM;aAC3B;SACF,CAAC,CACH;aACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAIzB,CACL;aACA,IAAI,CACH,mDAAuB,CAAC,SAAS,CAC/B,gDAAgD,CACjD,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqEG;IACH,uBAAuB,CAAC,EACtB,KAAK,EACL,QAAQ,EACR,SAAS,EACT,WAAW,EACX,OAAO,EACP,UAAU,GA8BX;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,gDAAgD;YACtD,MAAM,EAAE,KAAK;YACb,KAAK,EAAE;gBACL,KAAK;gBACL,QAAQ;gBACR,SAAS;gBACT,WAAW;gBACX,OAAO;gBACP,UAAU;aACX;SACF,CAAC;aACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;YACvC,GAAG,EAAE;gBACH,kBAAkB,EAAE,MAAM;aAC3B;SACF,CAAC,CACH;aACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAIzB,CACL;aACA,IAAI,CACH,mDAAuB,CAAC,SAAS,CAC/B,oDAAoD,CACrD,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACH,mBAAmB,CAAC,EAClB,KAAK,EACL,OAAO,EACP,SAAS,GAQV;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,mCAAmC;YACzC,MAAM,EAAE,KAAK;YACb,KAAK,EAAE;gBACL,KAAK;gBACL,OAAO;gBACP,SAAS;aACV;SACF,CAAC;aACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;YACvC,GAAG,EAAE;gBACH,kBAAkB,EAAE,MAAM;aAC3B;SACF,CAAC,CACH;aACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAIzB,CACL;aACA,IAAI,CACH,mDAAuB,CAAC,SAAS,CAC/B,gDAAgD,CACjD,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqEG;IACH,SAAS,CAAC,EACR,KAAK,EACL,QAAQ,EACR,SAAS,EACT,OAAO,EACP,UAAU,EACV,QAAQ,GAgCT;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,yBAAyB;YAC/B,MAAM,EAAE,KAAK;YACb,KAAK,EAAE;gBACL,KAAK;gBACL,QAAQ;gBACR,SAAS;gBACT,OAAO;gBACP,UAAU;gBACV,QAAQ;aACT;SACF,CAAC;aACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;YACvC,GAAG,EAAE;gBACH,kBAAkB,EAAE,MAAM;aAC3B;SACF,CAAC,CACH;aACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAIzB,CACL;aACA,IAAI,CACH,mDAAuB,CAAC,SAAS,CAC/B,sCAAsC,CACvC,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACH,gBAAgB,CAAC,EACf,KAAK,EACL,OAAO,EACP,UAAU,GAQX;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,+BAA+B;YACrC,MAAM,EAAE,KAAK;YACb,KAAK,EAAE;gBACL,KAAK;gBACL,OAAO;gBACP,UAAU;aACX;SACF,CAAC;aACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;YACvC,GAAG,EAAE;gBACH,kBAAkB,EAAE,MAAM;aAC3B;SACF,CAAC,CACH;aACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAIzB,CACL;aACA,IAAI,CACH,mDAAuB,CAAC,SAAS,CAC/B,6CAA6C,CAC9C,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+CG;IACH,kBAAkB,CAAC,EACjB,KAAK,EACL,UAAU,EACV,UAAU,EACV,OAAO,EACP,iBAAiB,EACjB,UAAU,EACV,mBAAmB,GAiCpB;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,yBAAyB;YAC/B,MAAM,EAAE,KAAK;YACb,KAAK,EAAE;gBACL,KAAK;gBACL,UAAU;gBACV,UAAU;gBACV,OAAO;gBACP,iBAAiB;gBACjB,UAAU;gBACV,mBAAmB;aACpB;SACF,CAAC;aACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;YACvC,GAAG,EAAE;gBACH,kBAAkB,EAAE,MAAM;aAC3B;SACF,CAAC,CACH;aACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAIzB,CACL;aACA,IAAI,CACH,mDAAuB,CAAC,SAAS,CAC/B,+CAA+C,CAChD,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkFG;IACH,2BAA2B,CAAC,EAC1B,KAAK,EACL,QAAQ,EACR,SAAS,EACT,WAAW,EACX,QAAQ,EACR,UAAU,EACV,OAAO,EACP,UAAU,GAuEX;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,oCAAoC;YAC1C,MAAM,EAAE,KAAK;YACb,KAAK,EAAE;gBACL,KAAK;gBACL,QAAQ;gBACR,SAAS;gBACT,WAAW;gBACX,QAAQ;gBACR,UAAU;gBACV,OAAO;gBACP,UAAU;aACX;SACF,CAAC;aACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;YACvC,GAAG,EAAE;gBACH,kBAAkB,EAAE,MAAM;aAC3B;SACF,CAAC,CACH;aACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAIzB,CACL;aACA,IAAI,CACH,mDAAuB,CAAC,SAAS,CAC/B,wDAAwD,CACzD,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+EG;IACH,6BAA6B,CAAC,EAC5B,KAAK,EACL,QAAQ,EACR,SAAS,EACT,QAAQ,EACR,UAAU,EACV,OAAO,EACP,UAAU,GAgCX;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,mCAAmC;YACzC,MAAM,EAAE,KAAK;YACb,KAAK,EAAE;gBACL,KAAK;gBACL,QAAQ;gBACR,SAAS;gBACT,QAAQ;gBACR,UAAU;gBACV,OAAO;gBACP,UAAU;aACX;SACF,CAAC;aACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;YACvC,GAAG,EAAE;gBACH,kBAAkB,EAAE,MAAM;aAC3B;SACF,CAAC,CACH;aACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAIzB,CACL;aACA,IAAI,CACH,mDAAuB,CAAC,SAAS,CAC/B,0DAA0D,CAC3D,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD,MAAM,CAAC,UAAU;QACf,mDAAuB,CAAC,kBAAkB,CACxC,oDAAoD,EACpD,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,OAAC,CAAC,KAAK,CAAC,mDAAuB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;SACpD,CAAC;aACD,QAAQ,CAAC,oDAAoD,CAAC,CAClE,CAAC;QACF,mDAAuB,CAAC,kBAAkB,CACxC,gDAAgD,EAChD,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,OAAC,CAAC,KAAK,CAAC,mDAAuB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;SACpD,CAAC;aACD,QAAQ,CAAC,gDAAgD,CAAC,CAC9D,CAAC;QACF,mDAAuB,CAAC,kBAAkB,CACxC,wDAAwD,EACxD,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,OAAC,CAAC,KAAK,CAAC,mDAAuB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;SACpD,CAAC;aACD,QAAQ,CAAC,wDAAwD,CAAC,CACtE,CAAC;QACF,mDAAuB,CAAC,kBAAkB,CACxC,+CAA+C,EAC/C,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,mDAAuB,CAAC,IAAI,CAAC,YAAY,CAAC;SACjD,CAAC;aACD,QAAQ,CAAC,+CAA+C,CAAC,CAC7D,CAAC;QACF,mDAAuB,CAAC,kBAAkB,CACxC,sCAAsC,EACtC,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,OAAC,CAAC,KAAK,CAAC,mDAAuB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;SACpD,CAAC;aACD,QAAQ,CAAC,sCAAsC,CAAC,CACpD,CAAC;QACF,mDAAuB,CAAC,kBAAkB,CACxC,6CAA6C,EAC7C,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,mDAAuB,CAAC,IAAI,CAAC,cAAc,CAAC;SACnD,CAAC;aACD,QAAQ,CAAC,6CAA6C,CAAC,CAC3D,CAAC;QACF,mDAAuB,CAAC,kBAAkB,CACxC,gDAAgD,EAChD,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,mDAAuB,CAAC,IAAI,CAAC,iBAAiB,CAAC;SACtD,CAAC;aACD,QAAQ,CAAC,gDAAgD,CAAC,CAC9D,CAAC;QACF,mDAAuB,CAAC,kBAAkB,CACxC,0DAA0D,EAC1D,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,OAAC,CAAC,KAAK,CAAC,mDAAuB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;SACpD,CAAC;aACD,QAAQ,CAAC,0DAA0D,CAAC,CACxE,CAAC;QACF,mDAAuB,CAAC,YAAY,CAAC;YACnC,wCAA+B;YAC/B,iDAAmC;SACpC,CAAC,CAAC;IACL,CAAC;CACF;AApqCD,8CAoqCC"}

package/lib/openapi/platform/services/users-service.d.ts

@@ -0,0 +1,579 @@
+import { CommonHttpService } from "../core/common-http-service";
+import { type ColumnItem, type GroupName, type PageBeanUser, type User } from "../models/common";
+import { type NewUserDetails, type UnrestrictedUserEmail, type UserColumnRequestBody, type UserMigrationBean } from "../models/users";
+/**
+ * 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 declare 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>;
+    /**
+     * 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[]>;
+    /**
+     * 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>;
+    /**
+     * 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[]>;
+    /**
+     * 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[]>;
+    /**
+     * 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>;
+    /**
+     * 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[]>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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[]>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    static initialize(): void;
+}