@resolution/jira-api-client 0.5.2 → 0.5.4

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

@@ -1,4 +1,4 @@
-import { CommonHttpService } from "../core/CommonHttpService";
+import { CommonHttpService } from "../../core/CommonHttpService";
 import { type EntityProperty, type PropertyKeys } from "../models/common";
 import { type AvailableDashboardGadgetsResponse, type BulkEditShareableEntityRequest, type BulkEditShareableEntityResponse, type Dashboard, type DashboardDetails, type DashboardGadget, type DashboardGadgetResponse, type DashboardGadgetSettings, type DashboardGadgetUpdateRequest, type PageBeanDashboard, type PageOfDashboards } from "../models/dashboards";
 /**
@@ -16,31 +16,34 @@ export declare class DashboardsService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "color": "blue",
      *   "id": 10001,
-     *   "moduleKey":
-     * "com.atlassian.plugins.atlassian-connect-plugin:com.atlassian.connect.node.sample-addon__sample-dashboard-item",
+     *   "moduleKey": "com.atlassian.plugins.atlassian-connect-plugin:com.atlassian.connect.node.sample-addon__sample-dashboard-item",
      *   "position": {
      *     "column": 1,
      *     "row": 0
      *   },
      *   "title": "Issue statistics"
      * }
-     * @path {POST} /rest/api/3/dashboard/{dashboardId}/gadget
+     * ```
+     * @path POST `/rest/api/3/dashboard/{dashboardId}/gadget`
      * @scopes-current write:jira-work, read:jira-work
      * @scopes-beta write:dashboard:jira, read:dashboard:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-dashboards#api-rest-api-3-dashboard-dashboardid-gadget-post
+     * @param params
      */
     addGadget: ({ dashboardId, dashboardGadgetSettings, }: {
         /** The ID of the dashboard. */
         dashboardId: number;
         /**
-         * @example {
+         * @example
+         * {
          *     "color": "blue",
          *     "ignoreUriAndModuleKeyValidation": false,
-         *     "moduleKey":
-         * "com.atlassian.plugins.atlassian-connect-plugin:com.atlassian.connect.node.sample-addon__sample-dashboard-item",
+         *     "moduleKey": "com.atlassian.plugins.atlassian-connect-plugin:com.atlassian.connect.node.sample-addon__sample-dashboard-item",
          *     "position": {
          *         "column": 1,
          *         "row": 0
@@ -61,7 +64,9 @@ export declare class DashboardsService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "action": "changePermission",
      *   "entityErrors": {
      *     "10002": {
@@ -72,20 +77,19 @@ export declare class DashboardsService extends CommonHttpService {
      *     }
      *   }
      * }
-     * @path {PUT} /rest/api/3/dashboard/bulk/edit
+     * ```
+     * @path PUT `/rest/api/3/dashboard/bulk/edit`
      * @scopes-current write:jira-work
-     * @scopes-beta read:dashboard:jira, read:group:jira, read:project:jira,
-     * read:project-role:jira, read:user:jira, write:dashboard: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:dashboard:jira, read:group:jira, read:project:jira, read:project-role:jira, read:user:jira, write:dashboard: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-dashboards#api-rest-api-3-dashboard-bulk-edit-put
+     * @param params
      */
     bulkEditDashboards: ({ bulkEditShareableEntityRequest, }: {
         /**
          * The details of dashboards being updated in bulk.
          *
-         * @example {
+         * @example
+         * {
          *     "action": "changePermission",
          *     "entityIds": [
          *         10001,
@@ -98,8 +102,7 @@ export declare class DashboardsService extends CommonHttpService {
          *                 "group": {
          *                     "groupId": "276f955c-63d7-42c8-9520-92d01dca0625",
          *                     "name": "jira-administrators",
-         *                     "self":
-         * "https://your-domain.atlassian.net/rest/api/~ver~/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625"
+         *                     "self": "https://your-domain.atlassian.net/rest/api/~ver~/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625"
          *                 },
          *                 "id": 10010,
          *                 "type": "group"
@@ -126,7 +129,9 @@ export declare class DashboardsService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "id": "10000",
      *   "isFavourite": false,
      *   "name": "System Dashboard",
@@ -137,17 +142,14 @@ export declare class DashboardsService extends CommonHttpService {
      *       "type": "global"
      *     }
      *   ],
-     *   "view":
-     * "https://your-domain.atlassian.net/secure/Dashboard.jspa?selectPageId=10000"
+     *   "view": "https://your-domain.atlassian.net/secure/Dashboard.jspa?selectPageId=10000"
      * }
-     * @path {POST} /rest/api/3/dashboard/{id}/copy
+     * ```
+     * @path POST `/rest/api/3/dashboard/{id}/copy`
      * @scopes-current write:jira-work
-     * @scopes-beta read:dashboard:jira, read:group:jira, read:project:jira,
-     * read:project-role:jira, read:user:jira, write:dashboard: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:dashboard:jira, read:group:jira, read:project:jira, read:project-role:jira, read:user:jira, write:dashboard: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-dashboards#api-rest-api-3-dashboard-id-copy-post
+     * @param params
      */
     copyDashboard: ({ id, extendAdminPermissions, dashboardDetails, }: {
         id: string;
@@ -160,9 +162,9 @@ export declare class DashboardsService extends CommonHttpService {
         /**
          * Dashboard details.
          *
-         * @example {
-         *     "description": "A dashboard to help auditors identify sample of issues to
-         * check.",
+         * @example
+         * {
+         *     "description": "A dashboard to help auditors identify sample of issues to check.",
          *     "editPermissions": [],
          *     "name": "Auditors dashboard",
          *     "sharePermissions": [
@@ -181,7 +183,9 @@ export declare class DashboardsService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "id": "10000",
      *   "isFavourite": false,
      *   "name": "System Dashboard",
@@ -192,17 +196,14 @@ export declare class DashboardsService extends CommonHttpService {
      *       "type": "global"
      *     }
      *   ],
-     *   "view":
-     * "https://your-domain.atlassian.net/secure/Dashboard.jspa?selectPageId=10000"
+     *   "view": "https://your-domain.atlassian.net/secure/Dashboard.jspa?selectPageId=10000"
      * }
-     * @path {POST} /rest/api/3/dashboard
+     * ```
+     * @path POST `/rest/api/3/dashboard`
      * @scopes-current write:jira-work
-     * @scopes-beta read:dashboard:jira, read:group:jira, read:project:jira,
-     * read:project-role:jira, read:user:jira, write:dashboard: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:dashboard:jira, read:group:jira, read:project:jira, read:project-role:jira, read:user:jira, write:dashboard: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-dashboards#api-rest-api-3-dashboard-post
+     * @param params
      */
     createDashboard: ({ extendAdminPermissions, dashboardDetails, }: {
         /**
@@ -214,9 +215,9 @@ export declare class DashboardsService extends CommonHttpService {
         /**
          * Dashboard details.
          *
-         * @example {
-         *     "description": "A dashboard to help auditors identify sample of issues to
-         * check.",
+         * @example
+         * {
+         *     "description": "A dashboard to help auditors identify sample of issues to check.",
          *     "editPermissions": [],
          *     "name": "Auditors dashboard",
          *     "sharePermissions": [
@@ -235,10 +236,11 @@ export declare class DashboardsService extends CommonHttpService {
      *
      * The dashboard to be deleted must be owned by the user.
      *
-     * @path {DELETE} /rest/api/3/dashboard/{id}
+     * @path DELETE `/rest/api/3/dashboard/{id}`
      * @scopes-current write:jira-work
      * @scopes-beta delete:dashboard:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-dashboards#api-rest-api-3-dashboard-id-delete
+     * @param params
      */
     deleteDashboard: ({ id, }: {
         /** The ID of the dashboard. */
@@ -255,11 +257,11 @@ export declare class DashboardsService extends CommonHttpService {
      * the System dashboard.
      *
      * @returns Returned if the dashboard item property is deleted.
-     * @path {DELETE}
-     * /rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey}
+     * @path DELETE `/rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey}`
      * @scopes-current write:jira-work
      * @scopes-beta delete:dashboard.property:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-dashboards#api-rest-api-3-dashboard-dashboardid-items-itemid-properties-propertykey-delete
+     * @param params
      */
     deleteDashboardItemProperty: ({ dashboardId, itemId, propertyKey, }: {
         /** The ID of the dashboard. */
@@ -276,21 +278,22 @@ export declare class DashboardsService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "gadgets": [
      *     {
-     *       "moduleKey":
-     * "com.atlassian.plugins.atlassian-connect-plugin:com.atlassian.connect.node.sample-addon__sample-dashboard-item",
+     *       "moduleKey": "com.atlassian.plugins.atlassian-connect-plugin:com.atlassian.connect.node.sample-addon__sample-dashboard-item",
      *       "title": "Issue statistics"
      *     },
      *     {
-     *       "uri":
-     * "rest/gadgets/1.0/g/com.atlassian.streams.streams-jira-plugin:activitystream-gadget/gadgets/activitystream-gadget.xml",
+     *       "uri": "rest/gadgets/1.0/g/com.atlassian.streams.streams-jira-plugin:activitystream-gadget/gadgets/activitystream-gadget.xml",
      *       "title": "Activity Stream"
      *     }
      *   ]
      * }
-     * @path {GET} /rest/api/3/dashboard/gadgets
+     * ```
+     * @path GET `/rest/api/3/dashboard/gadgets`
      * @scopes-current read:jira-work
      * @scopes-beta read:dashboard:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-dashboards#api-rest-api-3-dashboard-gadgets-get
@@ -306,7 +309,9 @@ export declare class DashboardsService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "dashboards": [
      *     {
      *       "id": "10000",
@@ -319,8 +324,7 @@ export declare class DashboardsService extends CommonHttpService {
      *           "type": "global"
      *         }
      *       ],
-     *       "view":
-     * "https://your-domain.atlassian.net/secure/Dashboard.jspa?selectPageId=10000"
+     *       "view": "https://your-domain.atlassian.net/secure/Dashboard.jspa?selectPageId=10000"
      *     },
      *     {
      *       "id": "20000",
@@ -328,19 +332,14 @@ export declare class DashboardsService extends CommonHttpService {
      *       "name": "Build Engineering",
      *       "owner": {
      *         "key": "Mia",
-     *         "self":
-     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
+     *         "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
      *         "name": "mia",
      *         "displayName": "Mia Krystof",
      *         "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"
      *         }
      *       },
      *       "popularity": 1,
@@ -349,15 +348,13 @@ export declare class DashboardsService extends CommonHttpService {
      *         {
      *           "group": {
      *             "name": "administrators",
-     *             "self":
-     * "https://your-domain.atlassian.net/rest/api/3/group?groupname=administrators"
+     *             "self": "https://your-domain.atlassian.net/rest/api/3/group?groupname=administrators"
      *           },
      *           "id": 10105,
      *           "type": "group"
      *         }
      *       ],
-     *       "view":
-     * "https://your-domain.atlassian.net/secure/Dashboard.jspa?selectPageId=20000"
+     *       "view": "https://your-domain.atlassian.net/secure/Dashboard.jspa?selectPageId=20000"
      *     }
      *   ],
      *   "maxResults": 10,
@@ -366,14 +363,12 @@ export declare class DashboardsService extends CommonHttpService {
      *   "startAt": 10,
      *   "total": 143
      * }
-     * @path {GET} /rest/api/3/dashboard
+     * ```
+     * @path GET `/rest/api/3/dashboard`
      * @scopes-current read:jira-work
-     * @scopes-beta read:dashboard:jira, read:group:jira, read:project:jira,
-     * read:project-role:jira, read:user: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:dashboard:jira, read:group:jira, read:project:jira, read:project-role:jira, read:user: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-dashboards#api-rest-api-3-dashboard-get
+     * @param params
      */
     getAllDashboards: ({ filter, startAt, maxResults, }?: {
         /**
@@ -404,12 +399,13 @@ export declare class DashboardsService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "gadgets": [
      *     {
      *       "id": 10001,
-     *       "moduleKey":
-     * "com.atlassian.plugins.atlassian-connect-plugin:com.atlassian.connect.node.sample-addon__sample-dashboard-item",
+     *       "moduleKey": "com.atlassian.plugins.atlassian-connect-plugin:com.atlassian.connect.node.sample-addon__sample-dashboard-item",
      *       "color": "blue",
      *       "position": {
      *         "row": 0,
@@ -419,8 +415,7 @@ export declare class DashboardsService extends CommonHttpService {
      *     },
      *     {
      *       "id": 10002,
-     *       "moduleKey":
-     * "com.atlassian.plugins.atlassian-connect-plugin:com.atlassian.connect.node.sample-addon__sample-dashboard-graph",
+     *       "moduleKey": "com.atlassian.plugins.atlassian-connect-plugin:com.atlassian.connect.node.sample-addon__sample-dashboard-graph",
      *       "color": "red",
      *       "position": {
      *         "row": 1,
@@ -430,8 +425,7 @@ export declare class DashboardsService extends CommonHttpService {
      *     },
      *     {
      *       "id": 10003,
-     *       "moduleKey":
-     * "com.atlassian.plugins.atlassian-connect-plugin:com.atlassian.connect.node.sample-addon__sample-dashboard-item",
+     *       "moduleKey": "com.atlassian.plugins.atlassian-connect-plugin:com.atlassian.connect.node.sample-addon__sample-dashboard-item",
      *       "color": "yellow",
      *       "position": {
      *         "row": 0,
@@ -441,10 +435,12 @@ export declare class DashboardsService extends CommonHttpService {
      *     }
      *   ]
      * }
-     * @path {GET} /rest/api/3/dashboard/{dashboardId}/gadget
+     * ```
+     * @path GET `/rest/api/3/dashboard/{dashboardId}/gadget`
      * @scopes-current read:jira-work
      * @scopes-beta read:dashboard:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-dashboards#api-rest-api-3-dashboard-dashboardid-gadget-get
+     * @param params
      */
     getAllGadgets: ({ dashboardId, moduleKey, uri, gadgetId, }: {
         /** The ID of the dashboard. */
@@ -480,7 +476,9 @@ export declare class DashboardsService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "id": "10000",
      *   "isFavourite": false,
      *   "name": "System Dashboard",
@@ -491,17 +489,14 @@ export declare class DashboardsService extends CommonHttpService {
      *       "type": "global"
      *     }
      *   ],
-     *   "view":
-     * "https://your-domain.atlassian.net/secure/Dashboard.jspa?selectPageId=10000"
+     *   "view": "https://your-domain.atlassian.net/secure/Dashboard.jspa?selectPageId=10000"
      * }
-     * @path {GET} /rest/api/3/dashboard/{id}
+     * ```
+     * @path GET `/rest/api/3/dashboard/{id}`
      * @scopes-current read:jira-work
-     * @scopes-beta read:dashboard:jira, read:group:jira, read:project:jira,
-     * read:project-role:jira, read:user: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:dashboard:jira, read:group:jira, read:project:jira, read:project-role:jira, read:user: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-dashboards#api-rest-api-3-dashboard-id-get
+     * @param params
      */
     getDashboard: ({ id, }: {
         /** The ID of the dashboard. */
@@ -540,18 +535,21 @@ export declare class DashboardsService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "key": "issue.support",
      *   "value": {
      *     "system.conversation.id": "b1bf38be-5e94-4b40-a3b8-9278735ee1e6",
      *     "system.support.time": "1m"
      *   }
      * }
-     * @path {GET}
-     * /rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey}
+     * ```
+     * @path GET `/rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey}`
      * @scopes-current read:jira-work
      * @scopes-beta read:dashboard.property:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-dashboards#api-rest-api-3-dashboard-dashboardid-items-itemid-properties-propertykey-get
+     * @param params
      */
     getDashboardItemProperty: ({ dashboardId, itemId, propertyKey, }: {
         /** The ID of the dashboard. */
@@ -576,19 +574,22 @@ export declare class DashboardsService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "keys": [
      *     {
      *       "key": "issue.support",
-     *       "self":
-     * "https://your-domain.atlassian.net/rest/api/3/issue/EX-2/properties/issue.support"
+     *       "self": "https://your-domain.atlassian.net/rest/api/3/issue/EX-2/properties/issue.support"
      *     }
      *   ]
      * }
-     * @path {GET} /rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties
+     * ```
+     * @path GET `/rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties`
      * @scopes-current read:jira-work
      * @scopes-beta read:dashboard.property:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-dashboards#api-rest-api-3-dashboard-dashboardid-items-itemid-properties-get
+     * @param params
      */
     getDashboardItemPropertyKeys: ({ dashboardId, itemId, }: {
         /** The ID of the dashboard. */
@@ -618,11 +619,12 @@ export declare class DashboardsService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "isLast": true,
      *   "maxResults": 100,
-     *   "self":
-     * "https://your-domain.atlassian.net/rest/api/3/dashboard/search?expand=owner&maxResults=50&startAt=0",
+     *   "self": "https://your-domain.atlassian.net/rest/api/3/dashboard/search?expand=owner&maxResults=50&startAt=0",
      *   "startAt": 0,
      *   "total": 2,
      *   "values": [
@@ -632,20 +634,15 @@ export declare class DashboardsService extends CommonHttpService {
      *       "isFavourite": true,
      *       "name": "Testing",
      *       "owner": {
-     *         "self":
-     * "https://your-domain.atlassian.net/user?accountId=5b10a2844c20165700ede21g",
+     *         "self": "https://your-domain.atlassian.net/user?accountId=5b10a2844c20165700ede21g",
      *         "displayName": "Mia",
      *         "active": true,
      *         "accountId": "5b10a2844c20165700ede21g",
      *         "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"
      *         }
      *       },
      *       "popularity": 1,
@@ -663,20 +660,15 @@ export declare class DashboardsService extends CommonHttpService {
      *       "isFavourite": false,
      *       "name": "Quantum ",
      *       "owner": {
-     *         "self":
-     * "https://your-domain.atlassian.net/user?accountId=5b10a2844c20165700ede21g",
+     *         "self": "https://your-domain.atlassian.net/user?accountId=5b10a2844c20165700ede21g",
      *         "displayName": "Mia",
      *         "active": true,
      *         "accountId": "5b10a2844c20165700ede21g",
      *         "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"
      *         }
      *       },
      *       "popularity": 0,
@@ -690,14 +682,12 @@ export declare class DashboardsService extends CommonHttpService {
      *     }
      *   ]
      * }
-     * @path {GET} /rest/api/3/dashboard/search
+     * ```
+     * @path GET `/rest/api/3/dashboard/search`
      * @scopes-current read:jira-work
-     * @scopes-beta read:dashboard:jira, read:group:jira, read:project:jira,
-     * read:project-role:jira, read:user: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:dashboard:jira, read:group:jira, read:project:jira, read:project-role:jira, read:user: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-dashboards#api-rest-api-3-dashboard-search-get
+     * @param params
      */
     getDashboardsPaginated: ({ dashboardName, accountId, owner, groupname, groupId, projectId, orderBy, startAt, maxResults, status, expand, }?: {
         /** String used to perform a case-insensitive partial match with `name`. */
@@ -781,10 +771,11 @@ export declare class DashboardsService extends CommonHttpService {
      * **[Permissions](#permissions) required:** None.
      *
      * @returns Returned if the request is successful.
-     * @path {DELETE} /rest/api/3/dashboard/{dashboardId}/gadget/{gadgetId}
+     * @path DELETE `/rest/api/3/dashboard/{dashboardId}/gadget/{gadgetId}`
      * @scopes-current write:jira-work
      * @scopes-beta write:dashboard:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-dashboards#api-rest-api-3-dashboard-dashboardid-gadget-gadgetid-delete
+     * @param params
      */
     removeGadget: ({ dashboardId, gadgetId, }: {
         /** The ID of the dashboard. */
@@ -825,18 +816,19 @@ export declare class DashboardsService extends CommonHttpService {
      * permission](https://confluence.atlassian.com/x/x4dKLg) are considered owners of
      * the System dashboard.
      *
-     * @returns * status: 200, mediaType: application/json
+     * @returns
+     *  * status: 200, mediaType: application/json
      *
      *    Returned if the dashboard item property is updated.
      *
      *  * status: 201, mediaType: application/json
      *
      *    Returned if the dashboard item property is created.
-     * @path {PUT}
-     * /rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey}
+     * @path PUT `/rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey}`
      * @scopes-current write:jira-work
      * @scopes-beta write:dashboard.property:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-dashboards#api-rest-api-3-dashboard-dashboardid-items-itemid-properties-propertykey-put
+     * @param params
      */
     setDashboardItemProperty: ({ dashboardId, itemId, propertyKey, requestBody, }: {
         /** The ID of the dashboard. */
@@ -855,7 +847,8 @@ export declare class DashboardsService extends CommonHttpService {
          * [JSON](https://tools.ietf.org/html/rfc4627) value. The maximum length of the
          * property value is 32768 bytes.
          *
-         * @example {
+         * @example
+         * {
          *     "number": 5,
          *     "string": "string-value"
          * }
@@ -874,7 +867,9 @@ export declare class DashboardsService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "id": "10000",
      *   "isFavourite": false,
      *   "name": "System Dashboard",
@@ -885,17 +880,14 @@ export declare class DashboardsService extends CommonHttpService {
      *       "type": "global"
      *     }
      *   ],
-     *   "view":
-     * "https://your-domain.atlassian.net/secure/Dashboard.jspa?selectPageId=10000"
+     *   "view": "https://your-domain.atlassian.net/secure/Dashboard.jspa?selectPageId=10000"
      * }
-     * @path {PUT} /rest/api/3/dashboard/{id}
+     * ```
+     * @path PUT `/rest/api/3/dashboard/{id}`
      * @scopes-current write:jira-work
-     * @scopes-beta read:dashboard:jira, read:group:jira, read:project:jira,
-     * read:project-role:jira, read:user:jira, write:dashboard: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:dashboard:jira, read:group:jira, read:project:jira, read:project-role:jira, read:user:jira, write:dashboard: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-dashboards#api-rest-api-3-dashboard-id-put
+     * @param params
      */
     updateDashboard: ({ id, extendAdminPermissions, dashboardDetails, }: {
         /** The ID of the dashboard to update. */
@@ -909,9 +901,9 @@ export declare class DashboardsService extends CommonHttpService {
         /**
          * Replacement dashboard details.
          *
-         * @example {
-         *     "description": "A dashboard to help auditors identify sample of issues to
-         * check.",
+         * @example
+         * {
+         *     "description": "A dashboard to help auditors identify sample of issues to check.",
          *     "editPermissions": [],
          *     "name": "Auditors dashboard",
          *     "sharePermissions": [
@@ -929,10 +921,11 @@ export declare class DashboardsService extends CommonHttpService {
      * **[Permissions](#permissions) required:** None.
      *
      * @returns Returned if the request is successful.
-     * @path {PUT} /rest/api/3/dashboard/{dashboardId}/gadget/{gadgetId}
+     * @path PUT `/rest/api/3/dashboard/{dashboardId}/gadget/{gadgetId}`
      * @scopes-current write:jira-work
      * @scopes-beta write:dashboard:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-dashboards#api-rest-api-3-dashboard-dashboardid-gadget-gadgetid-put
+     * @param params
      */
     updateGadget: ({ dashboardId, gadgetId, dashboardGadgetUpdateRequest, }: {
         /** The ID of the dashboard. */
@@ -940,7 +933,8 @@ export declare class DashboardsService extends CommonHttpService {
         /** The ID of the gadget. */
         gadgetId: number;
         /**
-         * @example {
+         * @example
+         * {
          *     "color": "red",
          *     "position": {
          *         "column": 1,