@resolution/jira-api-client 0.5.2 → 0.5.3

package/lib/openapi/platform/services/UsersService.d.ts

@@ -20,7 +20,9 @@ export declare class UsersService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "isLast": true,
      *   "maxResults": 100,
      *   "startAt": 0,
@@ -31,27 +33,24 @@ export declare class UsersService extends CommonHttpService {
      *       "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"
+     *         "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",
+     *       "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
      *       "timeZone": "Australia/Sydney"
      *     }
      *   ]
      * }
-     * @path {GET} /rest/api/3/user/bulk
+     * ```
+     * @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
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-users#api-rest-api-3-user-bulk-get
+     * @param params
      */
     bulkGetUsers: ({ startAt, maxResults, username, key, accountId, }: {
         /** The index of the first item to return in a page of results (page offset). */
@@ -87,7 +86,9 @@ export declare class UsersService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: [
+     * example:
+     * ```
+     * [
      *   {
      *     "username": "mia",
      *     "accountId": "5b10a2844c20165700ede21g"
@@ -97,10 +98,12 @@ export declare class UsersService extends CommonHttpService {
      *     "accountId": "5b10ac8d82e05b22cc7d4ef5"
      *   }
      * ]
-     * @path {GET} /rest/api/3/user/bulk/migration
+     * ```
+     * @path GET `/rest/api/3/user/bulk/migration`
      * @scopes-current read:jira-user
      * @scopes-beta read:user:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-users#api-rest-api-3-user-bulk-migration-get
+     * @param params
      */
     bulkGetUsersMigration: ({ startAt, maxResults, username, key, }?: {
         /** The index of the first item to return in a page of results (page offset). */
@@ -133,7 +136,9 @@ export declare class UsersService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "accountId": "5b10a2844c20165700ede21g",
      *   "accountType": "atlassian",
      *   "active": true,
@@ -142,14 +147,10 @@ export declare class UsersService extends CommonHttpService {
      *     "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"
+     *     "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",
@@ -159,18 +160,20 @@ export declare class UsersService extends CommonHttpService {
      *   },
      *   "key": "",
      *   "name": "",
-     *   "self":
-     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
+     *   "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
      *   "timeZone": "Australia/Sydney"
      * }
-     * @path {POST} /rest/api/3/user
+     * ```
+     * @path POST `/rest/api/3/user`
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-users#api-rest-api-3-user-post
+     * @param params
      */
     createUser: ({ newUserDetails, }: {
         /**
          * Details about the user to be created.
          *
-         * @example {
+         * @example
+         * {
          *     "emailAddress": "mia@atlassian.com"
          * }
          */
@@ -191,52 +194,46 @@ export declare class UsersService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: [
+     * 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"
+     *       "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"
+     *     "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"
+     *       "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"
+     *     "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10ac8d82e05b22cc7d4ef5"
      *   }
      * ]
-     * @path {GET} /rest/api/3/users/search
+     * ```
+     * @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
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-users#api-rest-api-3-users-search-get
+     * @param params
      */
     getAllUsers: ({ startAt, maxResults, }?: {
         /** The index of the first item to return. */
@@ -259,52 +256,46 @@ export declare class UsersService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: [
+     * 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"
+     *       "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"
+     *     "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"
+     *       "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"
+     *     "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10ac8d82e05b22cc7d4ef5"
      *   }
      * ]
-     * @path {GET} /rest/api/3/users
+     * ```
+     * @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
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-users#api-rest-api-3-users-get
+     * @param params
      */
     getAllUsersDefault: ({ startAt, maxResults, }?: {
         /** The index of the first item to return. */
@@ -326,7 +317,9 @@ export declare class UsersService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "accountId": "5b10a2844c20165700ede21g",
      *   "accountType": "atlassian",
      *   "active": true,
@@ -335,14 +328,10 @@ export declare class UsersService extends CommonHttpService {
      *     "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"
+     *     "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",
@@ -352,14 +341,15 @@ export declare class UsersService extends CommonHttpService {
      *   },
      *   "key": "",
      *   "name": "",
-     *   "self":
-     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
+     *   "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
      *   "timeZone": "Australia/Sydney"
      * }
-     * @path {GET} /rest/api/3/user
+     * ```
+     * @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
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-users#api-rest-api-3-user-get
+     * @param params
      */
     getUser: ({ accountId, username, key, expand, }?: {
         /**
@@ -403,10 +393,11 @@ export declare class UsersService extends CommonHttpService {
      *  *  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
+     * @path GET `/rest/api/3/user/columns`
      * @scopes-current read:jira-user
      * @scopes-beta read:user.columns:jira, read:filter.column:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-users#api-rest-api-3-user-columns-get
+     * @param params
      */
     getUserDefaultColumns: ({ accountId, username, }?: {
         /**
@@ -428,9 +419,13 @@ export declare class UsersService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: name@example.com
-     * @path {GET} /rest/api/3/user/email
+     * example:
+     * ```
+     * name@example.com
+     * ```
+     * @path GET `/rest/api/3/user/email`
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-users#api-rest-api-3-user-email-get
+     * @param params
      */
     getUserEmail: ({ accountId, }: {
         /**
@@ -445,8 +440,9 @@ export declare class UsersService extends CommonHttpService {
      * [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
+     * @path GET `/rest/api/3/user/email/bulk`
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-users#api-rest-api-3-user-email-bulk-get
+     * @param params
      */
     getUserEmailBulk: ({ accountId, }: {
         /**
@@ -465,16 +461,19 @@ export declare class UsersService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: {
+     * 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"
+     *   "self": "https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625"
      * }
-     * @path {GET} /rest/api/3/user/groups
+     * ```
+     * @path GET `/rest/api/3/user/groups`
      * @scopes-current read:jira-user
      * @scopes-beta read:group:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-users#api-rest-api-3-user-groups-get
+     * @param params
      */
     getUserGroups: ({ accountId, username, key, }: {
         /**
@@ -504,8 +503,9 @@ export declare class UsersService extends CommonHttpService {
      * membership of the *site-admin*
      * [group](https://confluence.atlassian.com/x/24xjL)).
      *
-     * @path {DELETE} /rest/api/3/user
+     * @path DELETE `/rest/api/3/user`
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-users#api-rest-api-3-user-delete
+     * @param params
      */
     removeUser: ({ accountId, username, key, }: {
         /**
@@ -539,8 +539,9 @@ export declare class UsersService extends CommonHttpService {
      * any user.
      *  *  Permission to access Jira, to set the calling user's columns.
      *
-     * @path {DELETE} /rest/api/3/user/columns
+     * @path DELETE `/rest/api/3/user/columns`
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-users#api-rest-api-3-user-columns-delete
+     * @param params
      */
     resetUserColumns: ({ accountId, username, }?: {
         /**
@@ -575,8 +576,9 @@ export declare class UsersService extends CommonHttpService {
      *  *  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
+     * @path PUT `/rest/api/3/user/columns`
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-users#api-rest-api-3-user-columns-put
+     * @param params
      */
     setUserColumns: ({ accountId, userColumnRequestBody, }: {
         /**