@resolution/jira-api-client 0.5.1 → 0.5.3

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

@@ -45,7 +45,9 @@ export declare class UserSearchService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "accountId": "5b10a2844c20165700ede21g",
      *   "accountType": "atlassian",
      *   "active": true,
@@ -54,14 +56,10 @@ export declare class UserSearchService 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",
@@ -71,15 +69,15 @@ export declare class UserSearchService 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/assignable/search
+     * ```
+     * @path GET `/rest/api/3/user/assignable/search`
      * @scopes-current read:jira-user
-     * @scopes-beta read:issue:jira, read:project:jira, read:user:jira, read:application-role:jira,
-     * read:avatar:jira, read:group:jira
+     * @scopes-beta read:issue:jira, read:project:jira, 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-user-search#api-rest-api-3-user-assignable-search-get
+     * @param params
      */
     findAssignableUsers: ({ query, sessionId, username, accountId, project, issueKey, startAt, maxResults, actionDescriptorId, recommend, }?: {
         /**
@@ -146,53 +144,46 @@ export declare class UserSearchService 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/user/assignable/multiProjectSearch
+     * ```
+     * @path GET `/rest/api/3/user/assignable/multiProjectSearch`
      * @scopes-current read:jira-user
-     * @scopes-beta read:project:jira, read:user:jira, read:application-role:jira,
-     * read:avatar:jira, read:group:jira
+     * @scopes-beta read:project:jira, 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-user-search#api-rest-api-3-user-assignable-multiprojectsearch-get
+     * @param params
      */
     findBulkAssignableUsers: ({ query, username, accountId, projectKeys, startAt, maxResults, }: {
         /**
@@ -264,12 +255,11 @@ export declare class UserSearchService extends CommonHttpService {
      * `is assignee of PROJ AND [propertyKey].entity.property.path is "property value"`
      *
      * @returns Returned if the request is successful.
-     * @path {GET} /rest/api/3/user/search/query/key
+     * @path GET `/rest/api/3/user/search/query/key`
      * @scopes-current read:jira-user
-     * @scopes-beta read:comment:jira, read:issue:jira, read:issue.vote:jira,
-     * read:issue.watcher:jira, read:project:jira, read:user.property:jira,
-     * read:user:jira
+     * @scopes-beta read:comment:jira, read:issue:jira, read:issue.vote:jira, read:issue.watcher:jira, read:project:jira, read:user.property:jira, read:user:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-user-search#api-rest-api-3-user-search-query-key-get
+     * @param params
      */
     findUserKeysByQuery: ({ query, startAt, maxResult, }: {
         /** The search query. */
@@ -302,53 +292,46 @@ export declare class UserSearchService 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/user/search
+     * ```
+     * @path GET `/rest/api/3/user/search`
      * @scopes-current read:jira-user
-     * @scopes-beta read:user:jira, read:user.property:jira, read:application-role:jira,
-     * read:avatar:jira, read:group:jira
+     * @scopes-beta read:user:jira, read:user.property:jira, read:application-role:jira, read:avatar:jira, read:group:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-user-search#api-rest-api-3-user-search-get
+     * @param params
      */
     findUsers: ({ query, username, accountId, startAt, maxResults, property, }?: {
         /**
@@ -422,13 +405,11 @@ export declare class UserSearchService extends CommonHttpService {
      * `is assignee of PROJ AND [propertyKey].entity.property.path is "property value"`
      *
      * @returns Returned if the request is successful.
-     * @path {GET} /rest/api/3/user/search/query
+     * @path GET `/rest/api/3/user/search/query`
      * @scopes-current read:jira-user
-     * @scopes-beta read:comment:jira, read:issue:jira, read:issue.vote:jira,
-     * read:issue.watcher:jira, read:project:jira, read:user:jira,
-     * read:user.property:jira, read:application-role:jira, read:avatar:jira,
-     * read:group:jira
+     * @scopes-beta read:comment:jira, read:issue:jira, read:issue.vote:jira, read:issue.watcher:jira, read:project:jira, read:user:jira, read:user.property:jira, read:application-role:jira, read:avatar:jira, read:group:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-user-search#api-rest-api-3-user-search-query-get
+     * @param params
      */
     findUsersByQuery: ({ query, startAt, maxResults, }: {
         /** The search query. */
@@ -465,27 +446,29 @@ export declare class UserSearchService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "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",
+     *       "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)",
+     *       "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/user/picker
+     * ```
+     * @path GET `/rest/api/3/user/picker`
      * @scopes-current read:jira-user
      * @scopes-beta read:user:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-user-search#api-rest-api-3-user-picker-get
+     * @param params
      */
     findUsersForPicker: ({ query, maxResults, showAvatar, exclude, excludeAccountIds, avatarSize, excludeConnectUsers, }: {
         /**
@@ -556,53 +539,46 @@ export declare class UserSearchService 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/user/permission/search
+     * ```
+     * @path GET `/rest/api/3/user/permission/search`
      * @scopes-current read:jira-user
-     * @scopes-beta read:issue:jira, read:project:jira, read:user:jira, read:application-role:jira,
-     * read:avatar:jira, read:group:jira
+     * @scopes-beta read:issue:jira, read:project:jira, 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-user-search#api-rest-api-3-user-permission-search-get
+     * @param params
      */
     findUsersWithAllPermissions: ({ query, username, accountId, permissions, issueKey, projectKey, startAt, maxResults, }: {
         /**
@@ -708,53 +684,46 @@ export declare class UserSearchService 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/user/viewissue/search
+     * ```
+     * @path GET `/rest/api/3/user/viewissue/search`
      * @scopes-current read:jira-user
-     * @scopes-beta read:issue:jira, read:project:jira, read:user:jira, read:application-role:jira,
-     * read:avatar:jira, read:group:jira
+     * @scopes-beta read:issue:jira, read:project:jira, 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-user-search#api-rest-api-3-user-viewissue-search-get
+     * @param params
      */
     findUsersWithBrowsePermission: ({ query, username, accountId, issueKey, projectKey, startAt, maxResults, }?: {
         /**
@@ -788,5 +757,5 @@ export declare class UserSearchService extends CommonHttpService {
         /** The maximum number of items to return per page. */
         maxResults?: number | undefined;
     }) => Promise<User[]>;
-    static initialize(): void;
+    protected static initialize(): void;
 }