@resolution/jira-api-client 0.5.2 → 0.5.4

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

@@ -1,4 +1,4 @@
-import { CommonHttpService } from "../core/CommonHttpService";
+import { CommonHttpService } from "../../core/CommonHttpService";
 import { type ColumnItem, type ColumnRequestBody } from "../models/common";
 import { type ChangeFilterOwner, type Filter, type PageBeanFilterDetails } from "../models/filters";
 /**
@@ -17,10 +17,11 @@ export declare class FiltersService extends CommonHttpService {
      * permission](https://confluence.atlassian.com/x/x4dKLg).
      *
      * @returns Returned if the request is successful.
-     * @path {PUT} /rest/api/3/filter/{id}/owner
+     * @path PUT `/rest/api/3/filter/{id}/owner`
      * @scopes-beta read:filter:jira, write:filter:jira
      * @scopes-current write:jira-work
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filters#api-rest-api-3-filter-id-owner-put
+     * @param params
      */
     changeFilterOwner: ({ id, changeFilterOwner, }: {
         /** The ID of the filter to update. */
@@ -28,7 +29,8 @@ export declare class FiltersService extends CommonHttpService {
         /**
          * The account ID of the new owner of the filter.
          *
-         * @example {
+         * @example
+         * {
          *     "accountId": "0000-0000-0000-0000"
          * }
          */
@@ -42,7 +44,9 @@ export declare class FiltersService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "approximateLastUsed": null,
      *   "description": "Lists all open bugs",
      *   "favourite": true,
@@ -55,23 +59,17 @@ export declare class FiltersService extends CommonHttpService {
      *     "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"
      *   },
-     *   "searchUrl":
-     * "https://your-domain.atlassian.net/rest/api/3/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty",
+     *   "searchUrl": "https://your-domain.atlassian.net/rest/api/3/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty",
      *   "self": "https://your-domain.atlassian.net/rest/api/3/filter/10000",
      *   "sharePermissions": [],
      *   "subscriptions": {
@@ -83,14 +81,12 @@ export declare class FiltersService extends CommonHttpService {
      *   },
      *   "viewUrl": "https://your-domain.atlassian.net/issues/?filter=10000"
      * }
-     * @path {POST} /rest/api/3/filter
+     * ```
+     * @path POST `/rest/api/3/filter`
      * @scopes-current write:jira-work
-     * @scopes-beta read:filter:jira, read:group:jira, read:project:jira, read:project-role:jira,
-     * read:user:jira, write:filter:jira, read:application-role:jira,
-     * read:avatar:jira, read:issue-type-hierarchy:jira, read:issue-type:jira,
-     * read:project-category:jira, read:project-version:jira,
-     * read:project.component:jira
+     * @scopes-beta read:filter:jira, read:group:jira, read:project:jira, read:project-role:jira, read:user:jira, write:filter:jira, read:application-role:jira, read:avatar:jira, read:issue-type-hierarchy:jira, read:issue-type:jira, read:project-category:jira, read:project-version:jira, read:project.component:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filters#api-rest-api-3-filter-post
+     * @param params
      */
     createFilter: ({ expand, overrideSharePermissions, filter, }: {
         /**
@@ -121,7 +117,8 @@ export declare class FiltersService extends CommonHttpService {
         /**
          * The filter to create.
          *
-         * @example {
+         * @example
+         * {
          *     "description": "Lists all open bugs",
          *     "jql": "type = Bug and resolution is empty",
          *     "name": "All Open Bugs"
@@ -140,7 +137,9 @@ export declare class FiltersService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "approximateLastUsed": "2023-03-01T13:15:00.000+0000",
      *   "description": "Lists all open bugs",
      *   "favourite": true,
@@ -153,23 +152,17 @@ export declare class FiltersService extends CommonHttpService {
      *     "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"
      *   },
-     *   "searchUrl":
-     * "https://your-domain.atlassian.net/rest/api/3/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty",
+     *   "searchUrl": "https://your-domain.atlassian.net/rest/api/3/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty",
      *   "self": "https://your-domain.atlassian.net/rest/api/3/filter/10000",
      *   "sharePermissions": [],
      *   "subscriptions": {
@@ -181,14 +174,12 @@ export declare class FiltersService extends CommonHttpService {
      *   },
      *   "viewUrl": "https://your-domain.atlassian.net/issues/?filter=10000"
      * }
-     * @path {DELETE} /rest/api/3/filter/{id}/favourite
+     * ```
+     * @path DELETE `/rest/api/3/filter/{id}/favourite`
      * @scopes-current write:jira-work
-     * @scopes-beta write:filter:jira, read:application-role:jira, read:avatar:jira,
-     * read:filter:jira, read:group:jira, read:issue-type-hierarchy:jira,
-     * read:issue-type:jira, read:project-category:jira, read:project-role:jira,
-     * read:project-version:jira, read:project.component:jira, read:project:jira,
-     * read:user:jira
+     * @scopes-beta write:filter:jira, read:application-role:jira, read:avatar:jira, read:filter:jira, read:group:jira, read:issue-type-hierarchy:jira, read:issue-type:jira, read:project-category:jira, read:project-role:jira, read:project-version:jira, read:project.component:jira, read:project:jira, read:user:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filters#api-rest-api-3-filter-id-favourite-delete
+     * @param params
      */
     deleteFavouriteForFilter: ({ id, expand, }: {
         /** The ID of the filter. */
@@ -221,10 +212,11 @@ export declare class FiltersService extends CommonHttpService {
      * *Administer Jira* [global
      * permission](https://confluence.atlassian.com/x/x4dKLg).
      *
-     * @path {DELETE} /rest/api/3/filter/{id}
+     * @path DELETE `/rest/api/3/filter/{id}`
      * @scopes-current write:jira-work
      * @scopes-beta delete:filter:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filters#api-rest-api-3-filter-id-delete
+     * @param params
      */
     deleteFilter: ({ id, }: {
         /** The ID of the filter to delete. */
@@ -249,7 +241,9 @@ export declare class FiltersService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: [
+     * example:
+     * ```
+     * [
      *   {
      *     "label": "Key",
      *     "value": "issuekey"
@@ -259,10 +253,12 @@ export declare class FiltersService extends CommonHttpService {
      *     "value": "summary"
      *   }
      * ]
-     * @path {GET} /rest/api/3/filter/{id}/columns
+     * ```
+     * @path GET `/rest/api/3/filter/{id}/columns`
      * @scopes-current read:jira-work
      * @scopes-beta read:filter.column:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filters#api-rest-api-3-filter-id-columns-get
+     * @param params
      */
     getColumns: ({ id, }: {
         /** The ID of the filter. */
@@ -288,7 +284,9 @@ export declare class FiltersService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: [
+     * example:
+     * ```
+     * [
      *   {
      *     "approximateLastUsed": "2023-03-01T13:15:00.000+0000",
      *     "description": "Lists all open bugs",
@@ -302,23 +300,17 @@ export declare class FiltersService extends CommonHttpService {
      *       "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"
      *     },
-     *     "searchUrl":
-     * "https://your-domain.atlassian.net/rest/api/3/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty",
+     *     "searchUrl": "https://your-domain.atlassian.net/rest/api/3/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty",
      *     "self": "https://your-domain.atlassian.net/rest/api/3/filter/10000",
      *     "sharePermissions": [],
      *     "subscriptions": {
@@ -343,23 +335,17 @@ export declare class FiltersService extends CommonHttpService {
      *       "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"
      *     },
-     *     "searchUrl":
-     * "https://your-domain.atlassian.net/rest/api/3/search?jql=assignee+in+%28currentUser%28%29%29+and+resolution+is+empty",
+     *     "searchUrl": "https://your-domain.atlassian.net/rest/api/3/search?jql=assignee+in+%28currentUser%28%29%29+and+resolution+is+empty",
      *     "self": "https://your-domain.atlassian.net/rest/api/3/filter/10010",
      *     "sharePermissions": [
      *       {
@@ -370,14 +356,10 @@ export declare class FiltersService extends CommonHttpService {
      *         "id": 10010,
      *         "project": {
      *           "avatarUrls": {
-     *             "16x16":
-     * "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
-     *             "24x24":
-     * "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
-     *             "32x32":
-     * "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
-     *             "48x48":
-     * "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
+     *             "16x16": "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
+     *             "24x24": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
+     *             "32x32": "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
+     *             "48x48": "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
      *           },
      *           "id": "10000",
      *           "insight": {
@@ -390,8 +372,7 @@ export declare class FiltersService extends CommonHttpService {
      *             "description": "First Project Category",
      *             "id": "10000",
      *             "name": "FIRST",
-     *             "self":
-     * "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
+     *             "self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
      *           },
      *           "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
      *           "simplified": false,
@@ -410,12 +391,12 @@ export declare class FiltersService extends CommonHttpService {
      *     "viewUrl": "https://your-domain.atlassian.net/issues/?filter=10010"
      *   }
      * ]
-     * @path {GET} /rest/api/3/filter/favourite
+     * ```
+     * @path GET `/rest/api/3/filter/favourite`
      * @scopes-current read:jira-work
-     * @scopes-beta read:filter:jira, read:group:jira, read:project:jira, read:project-role:jira,
-     * read:user:jira, read:jql:jira, read:application-role:jira, read:avatar:jira,
-     * read:issue-type-hierarchy:jira
+     * @scopes-beta read:filter:jira, read:group:jira, read:project:jira, read:project-role:jira, read:user:jira, read:jql:jira, read:application-role:jira, read:avatar:jira, read:issue-type-hierarchy:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filters#api-rest-api-3-filter-favourite-get
+     * @param params
      */
     getFavouriteFilters: ({ expand, }?: {
         /**
@@ -455,7 +436,9 @@ export declare class FiltersService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "approximateLastUsed": "2023-03-01T13:15:00.000+0000",
      *   "description": "Lists all open bugs",
      *   "favourite": true,
@@ -468,23 +451,17 @@ export declare class FiltersService extends CommonHttpService {
      *     "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"
      *   },
-     *   "searchUrl":
-     * "https://your-domain.atlassian.net/rest/api/3/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty",
+     *   "searchUrl": "https://your-domain.atlassian.net/rest/api/3/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty",
      *   "self": "https://your-domain.atlassian.net/rest/api/3/filter/10000",
      *   "sharePermissions": [],
      *   "subscriptions": {
@@ -496,12 +473,12 @@ export declare class FiltersService extends CommonHttpService {
      *   },
      *   "viewUrl": "https://your-domain.atlassian.net/issues/?filter=10000"
      * }
-     * @path {GET} /rest/api/3/filter/{id}
+     * ```
+     * @path GET `/rest/api/3/filter/{id}`
      * @scopes-current read:jira-work
-     * @scopes-beta read:filter:jira, read:group:jira, read:project:jira, read:project-role:jira,
-     * read:user:jira, read:jql:jira, read:application-role:jira, read:avatar:jira,
-     * read:issue-type-hierarchy:jira
+     * @scopes-beta read:filter:jira, read:group:jira, read:project:jira, read:project-role:jira, read:user:jira, read:jql:jira, read:application-role:jira, read:avatar:jira, read:issue-type-hierarchy:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filters#api-rest-api-3-filter-id-get
+     * @param params
      */
     getFilter: ({ id, expand, overrideSharePermissions, }: {
         /** The ID of the filter to return. */
@@ -554,11 +531,12 @@ export declare class FiltersService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "isLast": true,
      *   "maxResults": 100,
-     *   "self":
-     * "https://your-domain.atlassian.net/rest/api/3/filter/search?accountId=&maxResults=50&filterName=&orderBy=name&startAt=0&expand=description,owner,jql,searchUrl,viewUrl,favourite,favouritedCount,sharePermissions,editPermissions,isWritable,subscriptions,approximateLastUsed",
+     *   "self": "https://your-domain.atlassian.net/rest/api/3/filter/search?accountId=&maxResults=50&filterName=&orderBy=name&startAt=0&expand=description,owner,jql,searchUrl,viewUrl,favourite,favouritedCount,sharePermissions,editPermissions,isWritable,subscriptions,approximateLastUsed",
      *   "startAt": 0,
      *   "total": 2,
      *   "values": [
@@ -566,8 +544,7 @@ export declare class FiltersService extends CommonHttpService {
      *       "approximateLastUsed": "2023-03-01T13:15:00.000+0000",
      *       "description": "Lists all open bugs",
      *       "editPermissions": [],
-     *       "expand":
-     * "description,owner,jql,searchUrl,viewUrl,favourite,favouritedCount,sharePermissions,editPermissions,isWritable,approximateLastUsed,subscriptions",
+     *       "expand": "description,owner,jql,searchUrl,viewUrl,favourite,favouritedCount,sharePermissions,editPermissions,isWritable,approximateLastUsed,subscriptions",
      *       "favourite": false,
      *       "favouritedCount": 0,
      *       "id": "10000",
@@ -578,23 +555,17 @@ export declare class FiltersService extends CommonHttpService {
      *         "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"
      *       },
-     *       "searchUrl":
-     * "https://your-domain.atlassian.net/rest/api/3/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty",
+     *       "searchUrl": "https://your-domain.atlassian.net/rest/api/3/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty",
      *       "self": "https://your-domain.atlassian.net/rest/api/3/filter/10000",
      *       "sharePermissions": [],
      *       "subscriptions": [],
@@ -608,14 +579,10 @@ export declare class FiltersService extends CommonHttpService {
      *           "id": 10010,
      *           "project": {
      *             "avatarUrls": {
-     *               "16x16":
-     * "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10002",
-     *               "24x24":
-     * "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10002",
-     *               "32x32":
-     * "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10002",
-     *               "48x48":
-     * "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10002"
+     *               "16x16": "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10002",
+     *               "24x24": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10002",
+     *               "32x32": "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10002",
+     *               "48x48": "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10002"
      *             },
      *             "deleted": true,
      *             "deletedBy": {
@@ -623,20 +590,15 @@ export declare class FiltersService extends CommonHttpService {
      *               "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"
      *             },
      *             "deletedDate": "2022-11-11T13:35:29.000+0000",
      *             "id": "10002",
@@ -650,8 +612,7 @@ export declare class FiltersService extends CommonHttpService {
      *               "description": "First Project Category",
      *               "id": "10000",
      *               "name": "FIRST",
-     *               "self":
-     * "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
+     *               "self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
      *             },
      *             "retentionTillDate": "2023-01-10T13:35:29.000+0000",
      *             "self": "https://your-domain.atlassian.net/rest/api/3/project/MKY",
@@ -659,12 +620,10 @@ export declare class FiltersService extends CommonHttpService {
      *             "style": "classic"
      *           },
      *           "role": {
-     *             "self":
-     * "https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360",
+     *             "self": "https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360",
      *             "name": "Developers",
      *             "id": 10360,
-     *             "description": "A project role that represents developers in a
-     * project",
+     *             "description": "A project role that represents developers in a project",
      *             "actors": [
      *               {
      *                 "actorGroup": {
@@ -701,15 +660,13 @@ export declare class FiltersService extends CommonHttpService {
      *           "group": {
      *             "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"
      *           },
      *           "id": 10010,
      *           "type": "group"
      *         }
      *       ],
-     *       "expand":
-     * "description,owner,jql,searchUrl,viewUrl,favourite,favouritedCount,sharePermissions,editPermissions,isWritable,approximateLastUsed,subscriptions",
+     *       "expand": "description,owner,jql,searchUrl,viewUrl,favourite,favouritedCount,sharePermissions,editPermissions,isWritable,approximateLastUsed,subscriptions",
      *       "favourite": true,
      *       "favouritedCount": 123,
      *       "id": "10010",
@@ -720,23 +677,17 @@ export declare class FiltersService extends CommonHttpService {
      *         "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"
      *       },
-     *       "searchUrl":
-     * "https://your-domain.atlassian.net/rest/api/3/search?jql=assignee+in+%28currentUser%28%29%29+and+resolution+is+empty",
+     *       "searchUrl": "https://your-domain.atlassian.net/rest/api/3/search?jql=assignee+in+%28currentUser%28%29%29+and+resolution+is+empty",
      *       "self": "https://your-domain.atlassian.net/rest/api/3/filter/10010",
      *       "sharePermissions": [
      *         {
@@ -747,14 +698,10 @@ export declare class FiltersService extends CommonHttpService {
      *           "id": 10010,
      *           "project": {
      *             "avatarUrls": {
-     *               "16x16":
-     * "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
-     *               "24x24":
-     * "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
-     *               "32x32":
-     * "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
-     *               "48x48":
-     * "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
+     *               "16x16": "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
+     *               "24x24": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
+     *               "32x32": "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
+     *               "48x48": "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
      *             },
      *             "id": "10000",
      *             "insight": {
@@ -767,8 +714,7 @@ export declare class FiltersService extends CommonHttpService {
      *               "description": "First Project Category",
      *               "id": "10000",
      *               "name": "FIRST",
-     *               "self":
-     * "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
+     *               "self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
      *             },
      *             "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
      *             "simplified": false,
@@ -789,14 +735,10 @@ export declare class FiltersService 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",
@@ -806,8 +748,7 @@ export declare class FiltersService 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"
      *           }
      *         }
@@ -816,12 +757,12 @@ export declare class FiltersService extends CommonHttpService {
      *     }
      *   ]
      * }
-     * @path {GET} /rest/api/3/filter/search
+     * ```
+     * @path GET `/rest/api/3/filter/search`
      * @scopes-current read:jira-work
-     * @scopes-beta read:filter:jira, read:group:jira, read:project:jira, read:project-role:jira,
-     * read:user:jira, read:jql:jira, read:application-role:jira, read:avatar:jira,
-     * read:issue-type-hierarchy:jira
+     * @scopes-beta read:filter:jira, read:group:jira, read:project:jira, read:project-role:jira, read:user:jira, read:jql:jira, read:application-role:jira, read:avatar:jira, read:issue-type-hierarchy:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filters#api-rest-api-3-filter-search-get
+     * @param params
      */
     getFiltersPaginated: ({ filterName, accountId, owner, groupname, groupId, projectId, id, orderBy, startAt, maxResults, expand, overrideSharePermissions, }?: {
         /** String used to perform a case-insensitive partial match with `name`. */
@@ -928,7 +869,9 @@ export declare class FiltersService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: [
+     * example:
+     * ```
+     * [
      *   {
      *     "approximateLastUsed": "2023-03-01T13:15:00.000+0000",
      *     "description": "Lists all open bugs",
@@ -942,23 +885,17 @@ export declare class FiltersService extends CommonHttpService {
      *       "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"
      *     },
-     *     "searchUrl":
-     * "https://your-domain.atlassian.net/rest/api/3/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty",
+     *     "searchUrl": "https://your-domain.atlassian.net/rest/api/3/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty",
      *     "self": "https://your-domain.atlassian.net/rest/api/3/filter/10000",
      *     "sharePermissions": [],
      *     "subscriptions": {
@@ -983,23 +920,17 @@ export declare class FiltersService extends CommonHttpService {
      *       "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"
      *     },
-     *     "searchUrl":
-     * "https://your-domain.atlassian.net/rest/api/3/search?jql=assignee+in+%28currentUser%28%29%29+and+resolution+is+empty",
+     *     "searchUrl": "https://your-domain.atlassian.net/rest/api/3/search?jql=assignee+in+%28currentUser%28%29%29+and+resolution+is+empty",
      *     "self": "https://your-domain.atlassian.net/rest/api/3/filter/10010",
      *     "sharePermissions": [
      *       {
@@ -1010,14 +941,10 @@ export declare class FiltersService extends CommonHttpService {
      *         "id": 10010,
      *         "project": {
      *           "avatarUrls": {
-     *             "16x16":
-     * "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
-     *             "24x24":
-     * "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
-     *             "32x32":
-     * "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
-     *             "48x48":
-     * "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
+     *             "16x16": "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
+     *             "24x24": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
+     *             "32x32": "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
+     *             "48x48": "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
      *           },
      *           "id": "10000",
      *           "insight": {
@@ -1030,8 +957,7 @@ export declare class FiltersService extends CommonHttpService {
      *             "description": "First Project Category",
      *             "id": "10000",
      *             "name": "FIRST",
-     *             "self":
-     * "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
+     *             "self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
      *           },
      *           "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
      *           "simplified": false,
@@ -1050,12 +976,12 @@ export declare class FiltersService extends CommonHttpService {
      *     "viewUrl": "https://your-domain.atlassian.net/issues/?filter=10010"
      *   }
      * ]
-     * @path {GET} /rest/api/3/filter/my
+     * ```
+     * @path GET `/rest/api/3/filter/my`
      * @scopes-current read:jira-work
-     * @scopes-beta read:filter:jira, read:group:jira, read:project:jira, read:project-role:jira,
-     * read:user:jira, read:jql:jira, read:application-role:jira, read:avatar:jira,
-     * read:issue-type-hierarchy:jira
+     * @scopes-beta read:filter:jira, read:group:jira, read:project:jira, read:project-role:jira, read:user:jira, read:jql:jira, read:application-role:jira, read:avatar:jira, read:issue-type-hierarchy:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filters#api-rest-api-3-filter-my-get
+     * @param params
      */
     getMyFilters: ({ expand, includeFavourites, }?: {
         /**
@@ -1093,10 +1019,11 @@ export declare class FiltersService extends CommonHttpService {
      *  *  filters shared with a public project.
      *  *  filters shared with the public.
      *
-     * @path {DELETE} /rest/api/3/filter/{id}/columns
+     * @path DELETE `/rest/api/3/filter/{id}/columns`
      * @scopes-beta delete:filter.column:jira
      * @scopes-current write:jira-work
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filters#api-rest-api-3-filter-id-columns-delete
+     * @param params
      */
     resetColumns: ({ id, }: {
         /** The ID of the filter. */
@@ -1124,10 +1051,11 @@ export declare class FiltersService extends CommonHttpService {
      *  *  filters shared with the public.
      *
      * @returns Returned if the request is successful.
-     * @path {PUT} /rest/api/3/filter/{id}/columns
+     * @path PUT `/rest/api/3/filter/{id}/columns`
      * @scopes-current write:jira-work
      * @scopes-beta write:filter.column:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filters#api-rest-api-3-filter-id-columns-put
+     * @param params
      */
     setColumns: ({ id, mediaType, columnRequestBody, }: {
         /** The ID of the filter. */
@@ -1164,7 +1092,9 @@ export declare class FiltersService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "approximateLastUsed": "2023-03-01T13:15:00.000+0000",
      *   "description": "Lists all open bugs",
      *   "favourite": true,
@@ -1177,23 +1107,17 @@ export declare class FiltersService extends CommonHttpService {
      *     "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"
      *   },
-     *   "searchUrl":
-     * "https://your-domain.atlassian.net/rest/api/3/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty",
+     *   "searchUrl": "https://your-domain.atlassian.net/rest/api/3/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty",
      *   "self": "https://your-domain.atlassian.net/rest/api/3/filter/10000",
      *   "sharePermissions": [],
      *   "subscriptions": {
@@ -1205,12 +1129,12 @@ export declare class FiltersService extends CommonHttpService {
      *   },
      *   "viewUrl": "https://your-domain.atlassian.net/issues/?filter=10000"
      * }
-     * @path {PUT} /rest/api/3/filter/{id}/favourite
+     * ```
+     * @path PUT `/rest/api/3/filter/{id}/favourite`
      * @scopes-current write:jira-work
-     * @scopes-beta read:filter:jira, read:group:jira, read:project:jira, read:project-role:jira,
-     * read:user:jira, write:filter:jira, read:jql:jira, read:application-role:jira,
-     * read:avatar:jira, read:issue-type-hierarchy:jira
+     * @scopes-beta read:filter:jira, read:group:jira, read:project:jira, read:project-role:jira, read:user:jira, write:filter:jira, read:jql:jira, read:application-role:jira, read:avatar:jira, read:issue-type-hierarchy:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filters#api-rest-api-3-filter-id-favourite-put
+     * @param params
      */
     setFavouriteForFilter: ({ id, expand, }: {
         /** The ID of the filter. */
@@ -1244,7 +1168,9 @@ export declare class FiltersService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "approximateLastUsed": "2023-03-01T13:15:00.000+0000",
      *   "description": "Lists all open bugs",
      *   "favourite": true,
@@ -1257,23 +1183,17 @@ export declare class FiltersService extends CommonHttpService {
      *     "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"
      *   },
-     *   "searchUrl":
-     * "https://your-domain.atlassian.net/rest/api/3/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty",
+     *   "searchUrl": "https://your-domain.atlassian.net/rest/api/3/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty",
      *   "self": "https://your-domain.atlassian.net/rest/api/3/filter/10000",
      *   "sharePermissions": [],
      *   "subscriptions": {
@@ -1285,12 +1205,12 @@ export declare class FiltersService extends CommonHttpService {
      *   },
      *   "viewUrl": "https://your-domain.atlassian.net/issues/?filter=10000"
      * }
-     * @path {PUT} /rest/api/3/filter/{id}
+     * ```
+     * @path PUT `/rest/api/3/filter/{id}`
      * @scopes-current write:jira-work
-     * @scopes-beta write:filter:jira, read:filter:jira, read:group:jira, read:project:jira,
-     * read:project-role:jira, read:user:jira, read:jql:jira,
-     * read:application-role:jira, read:avatar:jira, read:issue-type-hierarchy:jira
+     * @scopes-beta write:filter:jira, read:filter:jira, read:group:jira, read:project:jira, read:project-role:jira, read:user:jira, read:jql:jira, read:application-role:jira, read:avatar:jira, read:issue-type-hierarchy:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filters#api-rest-api-3-filter-id-put
+     * @param params
      */
     updateFilter: ({ id, expand, overrideSharePermissions, filter, }: {
         /** The ID of the filter to update. */
@@ -1323,7 +1243,8 @@ export declare class FiltersService extends CommonHttpService {
         /**
          * The filter to update.
          *
-         * @example {
+         * @example
+         * {
          *     "description": "Lists all open bugs",
          *     "jql": "type = Bug and resolution is empty",
          *     "name": "All Open Bugs"