@resolution/jira-api-client 0.1.0

package/lib/openapi/platform/services/dashboards-service.js

@@ -0,0 +1,1109 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DashboardsService = void 0;
+// DO NOT EDIT!
+// This file is generated by "api-typescript-generator".
+// To update this file run "yarn build:openapi".
+const zod_1 = require("zod");
+const commonHttpClient = require("../core/common-http-client");
+const common_http_service_1 = require("../core/common-http-service");
+const common_1 = require("../models/common");
+const dashboards_1 = require("../models/dashboards");
+const validation_schema_storage_1 = require("../validation-schema-storage");
+/**
+ * This resource represents dashboards. Use it to obtain the details of dashboards
+ * as well as get, create, update, or remove item properties and gadgets from
+ * dashboards.
+ */
+class DashboardsService extends common_http_service_1.CommonHttpService {
+    /**
+     * Adds a gadget to a dashboard.
+     *
+     * **[Permissions](#permissions) required:** None.
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: {
+     *   "id": 10001,
+     *   "moduleKey":
+     * "com.atlassian.plugins.atlassian-connect-plugin:com.atlassian.connect.node.sample-addon__sample-dashboard-item",
+     *   "color": "blue",
+     *   "position": {
+     *     "row": 0,
+     *     "column": 1
+     *   },
+     *   "title": "Issue statistics"
+     * }
+     * @path {POST} /rest/api/3/dashboard/{dashboardId}/gadget
+     * @scopes-current write:jira-work, read:jira-work
+     * @scopes-beta write:dashboard:jira, read:dashboard:jira
+     */
+    addGadget({ dashboardId, dashboardGadgetSettings, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/api/3/dashboard/{dashboardId}/gadget",
+            method: "POST",
+            pathParams: {
+                dashboardId,
+            },
+            headers: {
+                "Content-Type": "application/json",
+            },
+            body: dashboardGadgetSettings,
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validation_schema_storage_1.validationSchemaStorage.validator("DashboardsService.addGadget.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Bulk edit dashboards. Maximum number of dashboards to be edited at the same
+     * time is 100.
+     *
+     * **[Permissions](#permissions) required:** None
+     *
+     * The dashboards to be updated must be owned by the user, or the user must be an
+     * administrator.
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: {
+     *   "action": "changePermission",
+     *   "entityErrors": {
+     *     "10002": {
+     *       "errorMessages": [
+     *         "Only owner or editors of the dashboard can change permissions."
+     *       ],
+     *       "errors": {}
+     *     }
+     *   }
+     * }
+     * @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
+     */
+    bulkEditDashboards({ bulkEditShareableEntityRequest, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/api/3/dashboard/bulk/edit",
+            method: "PUT",
+            headers: {
+                "Content-Type": "application/json",
+            },
+            body: bulkEditShareableEntityRequest,
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validation_schema_storage_1.validationSchemaStorage.validator("DashboardsService.bulkEditDashboards.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Copies a dashboard. Any values provided in the `dashboard` parameter replace
+     * those in the copied dashboard.
+     *
+     * **[Permissions](#permissions) required:** None
+     *
+     * The dashboard to be copied must be owned by or shared with the user.
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: {
+     *   "id": "10000",
+     *   "isFavourite": false,
+     *   "name": "System Dashboard",
+     *   "popularity": 1,
+     *   "self": "https://your-domain.atlassian.net/rest/api/3/dashboard/10000",
+     *   "sharePermissions": [
+     *     {
+     *       "type": "global"
+     *     }
+     *   ],
+     *   "view":
+     * "https://your-domain.atlassian.net/secure/Dashboard.jspa?selectPageId=10000"
+     * }
+     * @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
+     */
+    copyDashboard({ id, dashboardDetails, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/api/3/dashboard/{id}/copy",
+            method: "POST",
+            pathParams: {
+                id,
+            },
+            headers: {
+                "Content-Type": "application/json",
+            },
+            body: dashboardDetails,
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validation_schema_storage_1.validationSchemaStorage.validator("DashboardsService.copyDashboard.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Creates a dashboard.
+     *
+     * **[Permissions](#permissions) required:** None.
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: {
+     *   "id": "10000",
+     *   "isFavourite": false,
+     *   "name": "System Dashboard",
+     *   "popularity": 1,
+     *   "self": "https://your-domain.atlassian.net/rest/api/3/dashboard/10000",
+     *   "sharePermissions": [
+     *     {
+     *       "type": "global"
+     *     }
+     *   ],
+     *   "view":
+     * "https://your-domain.atlassian.net/secure/Dashboard.jspa?selectPageId=10000"
+     * }
+     * @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
+     */
+    createDashboard({ dashboardDetails, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/api/3/dashboard",
+            method: "POST",
+            headers: {
+                "Content-Type": "application/json",
+            },
+            body: dashboardDetails,
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validation_schema_storage_1.validationSchemaStorage.validator("DashboardsService.createDashboard.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Deletes a dashboard.
+     *
+     * **[Permissions](#permissions) required:** None
+     *
+     * The dashboard to be deleted must be owned by the user.
+     *
+     * @path {DELETE} /rest/api/3/dashboard/{id}
+     * @scopes-current write:jira-work
+     * @scopes-beta delete:dashboard:jira
+     */
+    deleteDashboard({ id, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/api/3/dashboard/{id}",
+            method: "DELETE",
+            pathParams: {
+                id,
+            },
+        })
+            .then(commonHttpClient.discardResult);
+    }
+    /**
+     * Deletes a dashboard item property.
+     *
+     * This operation can be accessed anonymously.
+     *
+     * **[Permissions](#permissions) required:** The user must be the owner of the
+     * dashboard. Note, users with the *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg) are considered owners of
+     * the System dashboard.
+     *
+     * @returns Returned if the dashboard item property is deleted.
+     * @path {DELETE}
+     * /rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey}
+     * @scopes-current write:jira-work
+     * @scopes-beta delete:dashboard.property:jira
+     */
+    deleteDashboardItemProperty({ dashboardId, itemId, propertyKey, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey}",
+            method: "DELETE",
+            pathParams: {
+                dashboardId,
+                itemId,
+                propertyKey,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            204: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validation_schema_storage_1.validationSchemaStorage.validator("DashboardsService.deleteDashboardItemProperty.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Gets a list of all available gadgets that can be added to all dashboards.
+     *
+     * **[Permissions](#permissions) required:** None.
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: {
+     *   "gadgets": [
+     *     {
+     *       "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",
+     *       "title": "Activity Stream"
+     *     }
+     *   ]
+     * }
+     * @path {GET} /rest/api/3/dashboard/gadgets
+     * @scopes-current read:jira-work
+     * @scopes-beta read:dashboard:jira
+     */
+    getAllAvailableDashboardGadgets() {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/api/3/dashboard/gadgets",
+            method: "GET",
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validation_schema_storage_1.validationSchemaStorage.validator("DashboardsService.getAllAvailableDashboardGadgets.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Returns a list of dashboards owned by or shared with the user. The list may be
+     * filtered to include only favorite or owned dashboards.
+     *
+     * This operation can be accessed anonymously.
+     *
+     * **[Permissions](#permissions) required:** None.
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: {
+     *   "dashboards": [
+     *     {
+     *       "id": "10000",
+     *       "isFavourite": false,
+     *       "name": "System Dashboard",
+     *       "popularity": 1,
+     *       "self": "https://your-domain.atlassian.net/rest/api/3/dashboard/10000",
+     *       "sharePermissions": [
+     *         {
+     *           "type": "global"
+     *         }
+     *       ],
+     *       "view":
+     * "https://your-domain.atlassian.net/secure/Dashboard.jspa?selectPageId=10000"
+     *     },
+     *     {
+     *       "id": "20000",
+     *       "isFavourite": true,
+     *       "name": "Build Engineering",
+     *       "owner": {
+     *         "key": "Mia",
+     *         "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"
+     *         }
+     *       },
+     *       "popularity": 1,
+     *       "self": "https://your-domain.atlassian.net/rest/api/3/dashboard/20000",
+     *       "sharePermissions": [
+     *         {
+     *           "group": {
+     *             "name": "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"
+     *     }
+     *   ],
+     *   "maxResults": 10,
+     *   "next": "https://your-domain.atlassian.net/rest/api/3/dashboard?startAt=10",
+     *   "prev": "https://your-domain.atlassian.net/rest/api/3/dashboard?startAt=0",
+     *   "startAt": 10,
+     *   "total": 143
+     * }
+     * @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
+     */
+    getAllDashboards({ filter, startAt, maxResults, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/api/3/dashboard",
+            method: "GET",
+            query: {
+                filter,
+                startAt,
+                maxResults,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validation_schema_storage_1.validationSchemaStorage.validator("DashboardsService.getAllDashboards.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Returns a list of dashboard gadgets on a dashboard.
+     *
+     * This operation returns:
+     *
+     *  *  Gadgets from a list of IDs, when `id` is set.
+     *  *  Gadgets with a module key, when `moduleKey` is set.
+     *  *  Gadgets from a list of URIs, when `uri` is set.
+     *  *  All gadgets, when no other parameters are set.
+     *
+     * This operation can be accessed anonymously.
+     *
+     * **[Permissions](#permissions) required:** None.
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: {
+     *   "gadgets": [
+     *     {
+     *       "id": 10001,
+     *       "moduleKey":
+     * "com.atlassian.plugins.atlassian-connect-plugin:com.atlassian.connect.node.sample-addon__sample-dashboard-item",
+     *       "color": "blue",
+     *       "position": {
+     *         "row": 0,
+     *         "column": 0
+     *       },
+     *       "title": "Issue statistics"
+     *     },
+     *     {
+     *       "id": 10002,
+     *       "moduleKey":
+     * "com.atlassian.plugins.atlassian-connect-plugin:com.atlassian.connect.node.sample-addon__sample-dashboard-graph",
+     *       "color": "red",
+     *       "position": {
+     *         "row": 1,
+     *         "column": 0
+     *       },
+     *       "title": "Activity stream"
+     *     },
+     *     {
+     *       "id": 10003,
+     *       "moduleKey":
+     * "com.atlassian.plugins.atlassian-connect-plugin:com.atlassian.connect.node.sample-addon__sample-dashboard-item",
+     *       "color": "yellow",
+     *       "position": {
+     *         "row": 0,
+     *         "column": 1
+     *       },
+     *       "title": "Bubble chart"
+     *     }
+     *   ]
+     * }
+     * @path {GET} /rest/api/3/dashboard/{dashboardId}/gadget
+     * @scopes-current read:jira-work
+     * @scopes-beta read:dashboard:jira
+     */
+    getAllGadgets({ dashboardId, moduleKey, uri, gadgetId, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/api/3/dashboard/{dashboardId}/gadget",
+            method: "GET",
+            pathParams: {
+                dashboardId,
+            },
+            query: {
+                moduleKey,
+                uri,
+                gadgetId,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validation_schema_storage_1.validationSchemaStorage.validator("DashboardsService.getAllGadgets.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Returns a dashboard.
+     *
+     * This operation can be accessed anonymously.
+     *
+     * **[Permissions](#permissions) required:** None.
+     *
+     * However, to get a dashboard, the dashboard must be shared with the user or the
+     * user must own it. Note, users with the *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg) are considered owners of
+     * the System dashboard. The System dashboard is considered to be shared with all
+     * other users.
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: {
+     *   "id": "10000",
+     *   "isFavourite": false,
+     *   "name": "System Dashboard",
+     *   "popularity": 1,
+     *   "self": "https://your-domain.atlassian.net/rest/api/3/dashboard/10000",
+     *   "sharePermissions": [
+     *     {
+     *       "type": "global"
+     *     }
+     *   ],
+     *   "view":
+     * "https://your-domain.atlassian.net/secure/Dashboard.jspa?selectPageId=10000"
+     * }
+     * @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
+     */
+    getDashboard({ id, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/api/3/dashboard/{id}",
+            method: "GET",
+            pathParams: {
+                id,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validation_schema_storage_1.validationSchemaStorage.validator("DashboardsService.getDashboard.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Returns the key and value of a dashboard item property.
+     *
+     * A dashboard item enables an app to add user-specific information to a user
+     * dashboard. Dashboard items are exposed to users as gadgets that users can add
+     * to their dashboards. For more information on how users do this, see [Adding and
+     * customizing gadgets](https://confluence.atlassian.com/x/7AeiLQ).
+     *
+     * When an app creates a dashboard item it registers a callback to receive the
+     * dashboard item ID. The callback fires whenever the item is rendered or, where
+     * the item is configurable, the user edits the item. The app then uses this
+     * resource to store the item's content or configuration details. For more
+     * information on working with dashboard items, see [ Building a dashboard item
+     * for a JIRA Connect
+     * add-on](https://developer.atlassian.com/server/jira/platform/guide-building-a-dashboard-item-for-a-jira-connect-add-on-33746254/)
+     * and the [Dashboard
+     * Item](https://developer.atlassian.com/cloud/jira/platform/modules/dashboard-item/)
+     * documentation.
+     *
+     * There is no resource to set or get dashboard items.
+     *
+     * This operation can be accessed anonymously.
+     *
+     * **[Permissions](#permissions) required:** The user must be the owner of the
+     * dashboard or have the dashboard shared with them. Note, users with the
+     * *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg) are considered owners of
+     * the System dashboard. The System dashboard is considered to be shared with all
+     * other users, and is accessible to anonymous users when Jira\\u2019s anonymous
+     * access is permitted.
+     *
+     * @returns Returned if the request is successful.
+     *
+     * 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}
+     * @scopes-current read:jira-work
+     * @scopes-beta read:dashboard.property:jira
+     */
+    getDashboardItemProperty({ dashboardId, itemId, propertyKey, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey}",
+            method: "GET",
+            pathParams: {
+                dashboardId,
+                itemId,
+                propertyKey,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validation_schema_storage_1.validationSchemaStorage.validator("DashboardsService.getDashboardItemProperty.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Returns the keys of all properties for a dashboard item.
+     *
+     * This operation can be accessed anonymously.
+     *
+     * **[Permissions](#permissions) required:** The user must be the owner of the
+     * dashboard or have the dashboard shared with them. Note, users with the
+     * *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg) are considered owners of
+     * the System dashboard. The System dashboard is considered to be shared with all
+     * other users, and is accessible to anonymous users when Jira\\u2019s anonymous
+     * access is permitted.
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: {
+     *   "keys": [
+     *     {
+     *       "key": "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
+     * @scopes-current read:jira-work
+     * @scopes-beta read:dashboard.property:jira
+     */
+    getDashboardItemPropertyKeys({ dashboardId, itemId, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties",
+            method: "GET",
+            pathParams: {
+                dashboardId,
+                itemId,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validation_schema_storage_1.validationSchemaStorage.validator("DashboardsService.getDashboardItemPropertyKeys.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Returns a [paginated](#pagination) list of dashboards. This operation is
+     * similar to [Get dashboards](#api-rest-api-3-dashboard-get) except that the
+     * results can be refined to include dashboards that have specific attributes. For
+     * example, dashboards with a particular name. When multiple attributes are
+     * specified only filters matching all attributes are returned.
+     *
+     * This operation can be accessed anonymously.
+     *
+     * **[Permissions](#permissions) required:** The following dashboards that match
+     * the query parameters are returned:
+     *
+     *  *  Dashboards owned by the user. Not returned for anonymous users.
+     *  *  Dashboards shared with a group that the user is a member of. Not returned
+     * for anonymous users.
+     *  *  Dashboards shared with a private project that the user can browse. Not
+     * returned for anonymous users.
+     *  *  Dashboards shared with a public project.
+     *  *  Dashboards shared with the public.
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: {
+     *   "isLast": true,
+     *   "maxResults": 100,
+     *   "self":
+     * "https://your-domain.atlassian.net/rest/api/3/dashboard/search?expand=owner&maxResults=50&startAt=0",
+     *   "startAt": 0,
+     *   "total": 2,
+     *   "values": [
+     *     {
+     *       "description": "Testing program",
+     *       "id": "1",
+     *       "isFavourite": true,
+     *       "name": "Testing",
+     *       "owner": {
+     *         "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"
+     *         }
+     *       },
+     *       "popularity": 1,
+     *       "self": "https://your-domain.atlassian.net/rest/api/3/dashboard/1",
+     *       "sharePermissions": [
+     *         {
+     *           "type": "global"
+     *         }
+     *       ],
+     *       "view": "https://your-domain.atlassian.net/Dashboard.jspa?selectPageId=1"
+     *     },
+     *     {
+     *       "description": "Quantum initiative",
+     *       "id": "2",
+     *       "isFavourite": false,
+     *       "name": "Quantum ",
+     *       "owner": {
+     *         "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"
+     *         }
+     *       },
+     *       "popularity": 0,
+     *       "self": "https://your-domain.atlassian.net/rest/api/3/dashboard/2",
+     *       "sharePermissions": [
+     *         {
+     *           "type": "loggedin"
+     *         }
+     *       ],
+     *       "view": "https://your-domain.atlassian.net/Dashboard.jspa?selectPageId=2"
+     *     }
+     *   ]
+     * }
+     * @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
+     */
+    getDashboardsPaginated({ dashboardName, accountId, owner, groupname, groupId, projectId, orderBy, startAt, maxResults, status, expand, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/api/3/dashboard/search",
+            method: "GET",
+            query: {
+                dashboardName,
+                accountId,
+                owner,
+                groupname,
+                groupId,
+                projectId,
+                orderBy,
+                startAt,
+                maxResults,
+                status,
+                expand,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validation_schema_storage_1.validationSchemaStorage.validator("DashboardsService.getDashboardsPaginated.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Removes a dashboard gadget from a dashboard.
+     *
+     * When a gadget is removed from a dashboard, other gadgets in the same column are
+     * moved up to fill the emptied position.
+     *
+     * **[Permissions](#permissions) required:** None.
+     *
+     * @returns Returned if the request is successful.
+     * @path {DELETE} /rest/api/3/dashboard/{dashboardId}/gadget/{gadgetId}
+     * @scopes-current write:jira-work
+     * @scopes-beta write:dashboard:jira
+     */
+    removeGadget({ dashboardId, gadgetId, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/api/3/dashboard/{dashboardId}/gadget/{gadgetId}",
+            method: "DELETE",
+            pathParams: {
+                dashboardId,
+                gadgetId,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            204: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validation_schema_storage_1.validationSchemaStorage.validator("DashboardsService.removeGadget.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Sets the value of a dashboard item property. Use this resource in apps to store
+     * custom data against a dashboard item.
+     *
+     * A dashboard item enables an app to add user-specific information to a user
+     * dashboard. Dashboard items are exposed to users as gadgets that users can add
+     * to their dashboards. For more information on how users do this, see [Adding and
+     * customizing gadgets](https://confluence.atlassian.com/x/7AeiLQ).
+     *
+     * When an app creates a dashboard item it registers a callback to receive the
+     * dashboard item ID. The callback fires whenever the item is rendered or, where
+     * the item is configurable, the user edits the item. The app then uses this
+     * resource to store the item's content or configuration details. For more
+     * information on working with dashboard items, see [ Building a dashboard item
+     * for a JIRA Connect
+     * add-on](https://developer.atlassian.com/server/jira/platform/guide-building-a-dashboard-item-for-a-jira-connect-add-on-33746254/)
+     * and the [Dashboard
+     * Item](https://developer.atlassian.com/cloud/jira/platform/modules/dashboard-item/)
+     * documentation.
+     *
+     * There is no resource to set or get dashboard items.
+     *
+     * The value of the request body must be a
+     * [valid](http://tools.ietf.org/html/rfc4627), non-empty JSON blob. The maximum
+     * length is 32768 characters.
+     *
+     * This operation can be accessed anonymously.
+     *
+     * **[Permissions](#permissions) required:** The user must be the owner of the
+     * dashboard. Note, users with the *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg) are considered owners of
+     * the System dashboard.
+     *
+     * @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}
+     * @scopes-current write:jira-work
+     * @scopes-beta write:dashboard.property:jira
+     */
+    setDashboardItemProperty({ dashboardId, itemId, propertyKey, requestBody, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey}",
+            method: "PUT",
+            pathParams: {
+                dashboardId,
+                itemId,
+                propertyKey,
+            },
+            headers: {
+                "Content-Type": "application/json",
+            },
+            body: requestBody,
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+            201: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validation_schema_storage_1.validationSchemaStorage.validator("DashboardsService.setDashboardItemProperty.response"))
+            .then(commonHttpClient.asCreatedResponse("body"));
+    }
+    /**
+     * Updates a dashboard, replacing all the dashboard details with those provided.
+     *
+     * **[Permissions](#permissions) required:** None
+     *
+     * The dashboard to be updated must be owned by the user.
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: {
+     *   "id": "10000",
+     *   "isFavourite": false,
+     *   "name": "System Dashboard",
+     *   "popularity": 1,
+     *   "self": "https://your-domain.atlassian.net/rest/api/3/dashboard/10000",
+     *   "sharePermissions": [
+     *     {
+     *       "type": "global"
+     *     }
+     *   ],
+     *   "view":
+     * "https://your-domain.atlassian.net/secure/Dashboard.jspa?selectPageId=10000"
+     * }
+     * @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
+     */
+    updateDashboard({ id, dashboardDetails, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/api/3/dashboard/{id}",
+            method: "PUT",
+            pathParams: {
+                id,
+            },
+            headers: {
+                "Content-Type": "application/json",
+            },
+            body: dashboardDetails,
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validation_schema_storage_1.validationSchemaStorage.validator("DashboardsService.updateDashboard.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Changes the title, position, and color of the gadget on a dashboard.
+     *
+     * **[Permissions](#permissions) required:** None.
+     *
+     * @returns Returned if the request is successful.
+     * @path {PUT} /rest/api/3/dashboard/{dashboardId}/gadget/{gadgetId}
+     * @scopes-current write:jira-work
+     * @scopes-beta write:dashboard:jira
+     */
+    updateGadget({ dashboardId, gadgetId, dashboardGadgetUpdateRequest, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/api/3/dashboard/{dashboardId}/gadget/{gadgetId}",
+            method: "PUT",
+            pathParams: {
+                dashboardId,
+                gadgetId,
+            },
+            headers: {
+                "Content-Type": "application/json",
+            },
+            body: dashboardGadgetUpdateRequest,
+        })
+            .then(this.getClientInstance().responseHandler({
+            204: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validation_schema_storage_1.validationSchemaStorage.validator("DashboardsService.updateGadget.response"))
+            .then(commonHttpClient.getBody);
+    }
+    static initialize() {
+        validation_schema_storage_1.validationSchemaStorage.registerExtensible("DashboardsService.getAllDashboards.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validation_schema_storage_1.validationSchemaStorage.lazy("PageOfDashboards"),
+        })
+            .describe("DashboardsService.getAllDashboards.response"));
+        validation_schema_storage_1.validationSchemaStorage.registerExtensible("DashboardsService.createDashboard.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validation_schema_storage_1.validationSchemaStorage.lazy("Dashboard"),
+        })
+            .describe("DashboardsService.createDashboard.response"));
+        validation_schema_storage_1.validationSchemaStorage.registerExtensible("DashboardsService.getAllGadgets.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validation_schema_storage_1.validationSchemaStorage.lazy("DashboardGadgetResponse"),
+        })
+            .describe("DashboardsService.getAllGadgets.response"));
+        validation_schema_storage_1.validationSchemaStorage.registerExtensible("DashboardsService.addGadget.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validation_schema_storage_1.validationSchemaStorage.lazy("DashboardGadget"),
+        })
+            .describe("DashboardsService.addGadget.response"));
+        validation_schema_storage_1.validationSchemaStorage.registerExtensible("DashboardsService.updateGadget.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(204),
+            mediaType: zod_1.z.literal("application/json"),
+            body: zod_1.z.unknown(),
+        })
+            .describe("DashboardsService.updateGadget.response"));
+        validation_schema_storage_1.validationSchemaStorage.registerExtensible("DashboardsService.removeGadget.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(204),
+            mediaType: zod_1.z.literal("application/json"),
+            body: zod_1.z.unknown(),
+        })
+            .describe("DashboardsService.removeGadget.response"));
+        validation_schema_storage_1.validationSchemaStorage.registerExtensible("DashboardsService.getDashboardItemPropertyKeys.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validation_schema_storage_1.validationSchemaStorage.lazy("PropertyKeys"),
+        })
+            .describe("DashboardsService.getDashboardItemPropertyKeys.response"));
+        validation_schema_storage_1.validationSchemaStorage.registerExtensible("DashboardsService.getDashboardItemProperty.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validation_schema_storage_1.validationSchemaStorage.lazy("EntityProperty"),
+        })
+            .describe("DashboardsService.getDashboardItemProperty.response"));
+        validation_schema_storage_1.validationSchemaStorage.registerExtensible("DashboardsService.setDashboardItemProperty.response", zod_1.z
+            .object({
+            status: zod_1.z.number(),
+            mediaType: zod_1.z.string(),
+            body: zod_1.z.unknown(),
+        })
+            .superRefine(({ status: status, body: body }, ctx) => {
+            if (status === 200 || status === 201) {
+                zod_1.z.unknown().parse(body);
+            }
+            else {
+                ctx.addIssue({
+                    code: zod_1.z.ZodIssueCode.custom,
+                    path: ["status"],
+                    message: `Unexpected status code: ${status}`,
+                });
+            }
+        })
+            .describe("DashboardsService.setDashboardItemProperty.response"));
+        validation_schema_storage_1.validationSchemaStorage.registerExtensible("DashboardsService.deleteDashboardItemProperty.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(204),
+            mediaType: zod_1.z.literal("application/json"),
+            body: zod_1.z.unknown(),
+        })
+            .describe("DashboardsService.deleteDashboardItemProperty.response"));
+        validation_schema_storage_1.validationSchemaStorage.registerExtensible("DashboardsService.getDashboard.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validation_schema_storage_1.validationSchemaStorage.lazy("Dashboard"),
+        })
+            .describe("DashboardsService.getDashboard.response"));
+        validation_schema_storage_1.validationSchemaStorage.registerExtensible("DashboardsService.updateDashboard.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validation_schema_storage_1.validationSchemaStorage.lazy("Dashboard"),
+        })
+            .describe("DashboardsService.updateDashboard.response"));
+        validation_schema_storage_1.validationSchemaStorage.registerExtensible("DashboardsService.copyDashboard.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validation_schema_storage_1.validationSchemaStorage.lazy("Dashboard"),
+        })
+            .describe("DashboardsService.copyDashboard.response"));
+        validation_schema_storage_1.validationSchemaStorage.registerExtensible("DashboardsService.bulkEditDashboards.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validation_schema_storage_1.validationSchemaStorage.lazy("BulkEditShareableEntityResponse"),
+        })
+            .describe("DashboardsService.bulkEditDashboards.response"));
+        validation_schema_storage_1.validationSchemaStorage.registerExtensible("DashboardsService.getAllAvailableDashboardGadgets.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validation_schema_storage_1.validationSchemaStorage.lazy("AvailableDashboardGadgetsResponse"),
+        })
+            .describe("DashboardsService.getAllAvailableDashboardGadgets.response"));
+        validation_schema_storage_1.validationSchemaStorage.registerExtensible("DashboardsService.getDashboardsPaginated.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validation_schema_storage_1.validationSchemaStorage.lazy("PageBeanDashboard"),
+        })
+            .describe("DashboardsService.getDashboardsPaginated.response"));
+        validation_schema_storage_1.validationSchemaStorage.registerOnce([
+            dashboards_1.registerDashboardsValidationSchemas,
+            common_1.registerCommonValidationSchemas,
+        ]);
+    }
+}
+exports.DashboardsService = DashboardsService;
+//# sourceMappingURL=dashboards-service.js.map