@resolution/jira-api-client 0.1.0

package/lib/openapi/platform/services/projects-service.d.ts

@@ -0,0 +1,1622 @@
+import { CommonHttpService } from "../core/common-http-service";
+import { type NotificationScheme, type PageBeanProject, type Project } from "../models/common";
+import { type CreateProjectDetails, type IssueTypeWithStatus, type ProjectIdentifiers, type ProjectIssueTypeHierarchy, type StringList, type UpdateProjectDetails } from "../models/projects";
+/**
+ * This resource represents projects. Use it to get, create, update, and delete
+ * projects. Also get statuses available to a project, a project's notification
+ * schemes, and update a project's type.
+ */
+export declare class ProjectsService extends CommonHttpService {
+    /**
+     * Archives a project. You can't delete a project if it's archived. To delete an
+     * archived project, restore the project and then delete it. To restore a project,
+     * use the Jira UI.
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @returns Returned if the request is successful.
+     * @path {POST} /rest/api/3/project/{projectIdOrKey}/archive
+     * @scopes-current manage:jira-project
+     * @scopes-beta write:project:jira
+     */
+    archiveProject({ projectIdOrKey, }: {
+        /** The project ID or project key (case sensitive). */
+        projectIdOrKey: string;
+    }): Promise<void>;
+    /**
+     * Creates a project based on a project type template, as shown in the following
+     * table:
+     *
+     * | Project Type Key | Project Template Key |
+     * |--|--|
+     * | `business` |
+     * `com.atlassian.jira-core-project-templates:jira-core-simplified-content-management`,
+     * `com.atlassian.jira-core-project-templates:jira-core-simplified-document-approval`,
+     * `com.atlassian.jira-core-project-templates:jira-core-simplified-lead-tracking`,
+     * `com.atlassian.jira-core-project-templates:jira-core-simplified-process-control`,
+     * `com.atlassian.jira-core-project-templates:jira-core-simplified-procurement`,
+     * `com.atlassian.jira-core-project-templates:jira-core-simplified-project-management`,
+     * `com.atlassian.jira-core-project-templates:jira-core-simplified-recruitment`,
+     * `com.atlassian.jira-core-project-templates:jira-core-simplified-task-tracking` |
+     * | `service_desk` |
+     * `com.atlassian.servicedesk:simplified-it-service-management`,
+     * `com.atlassian.servicedesk:simplified-general-service-desk-it`,
+     * `com.atlassian.servicedesk:simplified-general-service-desk-business`,
+     * `com.atlassian.servicedesk:simplified-external-service-desk`,
+     * `com.atlassian.servicedesk:simplified-hr-service-desk`,
+     * `com.atlassian.servicedesk:simplified-facilities-service-desk`,
+     * `com.atlassian.servicedesk:simplified-legal-service-desk`,
+     * `com.atlassian.servicedesk:simplified-analytics-service-desk`,
+     * `com.atlassian.servicedesk:simplified-marketing-service-desk`,
+     * `com.atlassian.servicedesk:simplified-design-service-desk`,
+     * `com.atlassian.servicedesk:simplified-sales-service-desk`,
+     * `com.atlassian.servicedesk:simplified-blank-project-business`,
+     * `com.atlassian.servicedesk:simplified-blank-project-it`,
+     * `com.atlassian.servicedesk:simplified-finance-service-desk`,
+     * `com.atlassian.servicedesk:next-gen-it-service-desk`,
+     * `com.atlassian.servicedesk:next-gen-hr-service-desk`,
+     * `com.atlassian.servicedesk:next-gen-legal-service-desk`,
+     * `com.atlassian.servicedesk:next-gen-marketing-service-desk`,
+     * `com.atlassian.servicedesk:next-gen-facilities-service-desk`,
+     * `com.atlassian.servicedesk:next-gen-general-it-service-desk`,
+     * `com.atlassian.servicedesk:next-gen-general-business-service-desk`,
+     * `com.atlassian.servicedesk:next-gen-analytics-service-desk`,
+     * `com.atlassian.servicedesk:next-gen-finance-service-desk`,
+     * `com.atlassian.servicedesk:next-gen-design-service-desk`,
+     * `com.atlassian.servicedesk:next-gen-sales-service-desk` |
+     * | `software` | `com.pyxis.greenhopper.jira:gh-simplified-agility-kanban`,
+     * `com.pyxis.greenhopper.jira:gh-simplified-agility-scrum`,
+     * `com.pyxis.greenhopper.jira:gh-simplified-basic`,
+     * `com.pyxis.greenhopper.jira:gh-simplified-kanban-classic`,
+     * `com.pyxis.greenhopper.jira:gh-simplified-scrum-classic` |
+     * The project types are available according to the installed Jira features as
+     * follows:
+     *
+     *  *  Jira Core, the default, enables `business` projects.
+     *  *  Jira Service Management enables `service_desk` projects.
+     *  *  Jira Software enables `software` projects.
+     *
+     * To determine which features are installed, go to **Jira settings** > **Apps** >
+     * **Manage apps** and review the System Apps list. To add Jira Software or Jira
+     * Service Management into a JIRA instance, use **Jira settings** > **Apps** >
+     * **Finding new apps**. For more information, see [ Managing
+     * add-ons](https://confluence.atlassian.com/x/S31NLg).
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @returns Returned if the project is created.
+     *
+     * example: {
+     *   "id": 10010,
+     *   "key": "EX",
+     *   "self": "https://your-domain.atlassian.net/jira/rest/api/3/project/10042"
+     * }
+     * @path {POST} /rest/api/3/project
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta write:project:jira, read:project:jira
+     */
+    createProject({ createProjectDetails, }: {
+        /**
+         * The JSON representation of the project being created.
+         *
+         * @example {
+         *     "assigneeType": "PROJECT_LEAD",
+         *     "avatarId": 10200,
+         *     "categoryId": 10120,
+         *     "description": "Cloud migration initiative",
+         *     "issueSecurityScheme": 10001,
+         *     "key": "EX",
+         *     "leadAccountId": "5b10a0effa615349cb016cd8",
+         *     "name": "Example",
+         *     "notificationScheme": 10021,
+         *     "permissionScheme": 10011,
+         *     "projectTemplateKey":
+         * "com.atlassian.jira-core-project-templates:jira-core-simplified-process-control",
+         *     "projectTypeKey": "business",
+         *     "url": "http://atlassian.com"
+         * }
+         */
+        createProjectDetails: CreateProjectDetails;
+    }): Promise<ProjectIdentifiers>;
+    /**
+     * Deletes a project.
+     *
+     * You can't delete a project if it's archived. To delete an archived project,
+     * restore the project and then delete it. To restore a project, use the Jira UI.
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @path {DELETE} /rest/api/3/project/{projectIdOrKey}
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta delete:project:jira
+     */
+    deleteProject({ projectIdOrKey, enableUndo, }: {
+        /** The project ID or project key (case sensitive). */
+        projectIdOrKey: string;
+        /**
+         * Whether this project is placed in the Jira recycle bin where it will be
+         * available for restoration.
+         */
+        enableUndo?: boolean;
+    }): Promise<void>;
+    /**
+     * Deletes a project asynchronously.
+     *
+     * This operation is:
+     *
+     *  *  transactional, that is, if part of the delete fails the project is not
+     * deleted.
+     *  *  [asynchronous](#async). Follow the `location` link in the response to
+     * determine the status of the task and use [Get
+     * task](#api-rest-api-3-task-taskId-get) to obtain subsequent updates.
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @path {POST} /rest/api/3/project/{projectIdOrKey}/delete
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta write:project:jira, write:project.property:jira
+     */
+    deleteProjectAsynchronously({ projectIdOrKey, }: {
+        /** The project ID or project key (case sensitive). */
+        projectIdOrKey: string;
+    }): Promise<void>;
+    /**
+     * Returns all projects visible to the user. Deprecated, use [ Get projects
+     * paginated](#api-rest-api-3-project-search-get) that supports search and
+     * pagination.
+     *
+     * This operation can be accessed anonymously.
+     *
+     * **[Permissions](#permissions) required:** Projects are returned only where the
+     * user has *Browse Projects* or *Administer projects* [project
+     * permission](https://confluence.atlassian.com/x/yodKLg) for the project.
+     *
+     * @deprecated
+     * @returns Returned if the request is successful.
+     *
+     * example: [
+     *   {
+     *     "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"
+     *     },
+     *     "id": "10000",
+     *     "insight": {
+     *       "lastIssueUpdateTime": 1619069825000,
+     *       "totalIssueCount": 100
+     *     },
+     *     "key": "EX",
+     *     "name": "Example",
+     *     "projectCategory": {
+     *       "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/project/EX",
+     *     "simplified": false,
+     *     "style": "CLASSIC"
+     *   },
+     *   {
+     *     "avatarUrls": {
+     *       "16x16":
+     * "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10001",
+     *       "24x24":
+     * "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10001",
+     *       "32x32":
+     * "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10001",
+     *       "48x48":
+     * "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10001"
+     *     },
+     *     "id": "10001",
+     *     "insight": {
+     *       "lastIssueUpdateTime": 1619069825000,
+     *       "totalIssueCount": 100
+     *     },
+     *     "key": "ABC",
+     *     "name": "Alphabetical",
+     *     "projectCategory": {
+     *       "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/project/ABC",
+     *     "simplified": false,
+     *     "style": "CLASSIC"
+     *   }
+     * ]
+     * @path {GET} /rest/api/3/project
+     * @scopes-current read:jira-work
+     * @scopes-beta read:issue-type:jira, read:project:jira, read:project.property:jira,
+     * read:user:jira, read:application-role:jira, read:avatar:jira, read:group:jira,
+     * read:issue-type-hierarchy:jira, read:project-category:jira,
+     * read:project-version:jira, read:project.component:jira
+     */
+    getAllProjects({ expand, recent, properties, }: {
+        /**
+         * Use [expand](#expansion) to include additional information in the response.
+         * This parameter accepts a comma-separated list. Expanded options include:
+         *
+         *  *  `description` Returns the project description.
+         *  *  `issueTypes` Returns all issue types associated with the project.
+         *  *  `lead` Returns information about the project lead.
+         *  *  `projectKeys` Returns all project keys associated with the project.
+         */
+        expand?: string;
+        /**
+         * Returns the user's most recently accessed projects. You may specify the number
+         * of results to return up to a maximum of 20. If access is anonymous, then the
+         * recently accessed projects are based on the current HTTP session.
+         */
+        recent?: number;
+        /**
+         * A list of project properties to return for the project. This parameter accepts
+         * a comma-separated list.
+         */
+        properties?: string[];
+    }): Promise<Project[]>;
+    /**
+     * Returns the valid statuses for a project. The statuses are grouped by issue
+     * type, as each project has a set of valid issue types and each issue type has a
+     * set of valid statuses.
+     *
+     * This operation can be accessed anonymously.
+     *
+     * **[Permissions](#permissions) required:** *Browse Projects* [project
+     * permission](https://confluence.atlassian.com/x/yodKLg) for the project.
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: [
+     *   {
+     *     "id": "3",
+     *     "name": "Task",
+     *     "self": "https://your-domain.atlassian.net/rest/api/3/issueType/3",
+     *     "statuses": [
+     *       {
+     *         "description": "The issue is currently being worked on.",
+     *         "iconUrl":
+     * "https://your-domain.atlassian.net/images/icons/progress.gif",
+     *         "id": "10000",
+     *         "name": "In Progress",
+     *         "self": "https://your-domain.atlassian.net/rest/api/3/status/10000"
+     *       },
+     *       {
+     *         "description": "The issue is closed.",
+     *         "iconUrl": "https://your-domain.atlassian.net/images/icons/closed.gif",
+     *         "id": "5",
+     *         "name": "Closed",
+     *         "self": "https://your-domain.atlassian.net/rest/api/3/status/5"
+     *       }
+     *     ],
+     *     "subtask": false
+     *   }
+     * ]
+     * @path {GET} /rest/api/3/project/{projectIdOrKey}/statuses
+     * @scopes-current read:jira-work
+     * @scopes-beta read:issue-status:jira, read:issue-type:jira, read:status:jira
+     */
+    getAllStatuses({ projectIdOrKey, }: {
+        /** The project ID or project key (case sensitive). */
+        projectIdOrKey: string;
+    }): Promise<IssueTypeWithStatus[]>;
+    /**
+     * Get the issue type hierarchy for a next-gen project.
+     *
+     * The issue type hierarchy for a project consists of:
+     *
+     *  *  *Epic* at level 1 (optional).
+     *  *  One or more issue types at level 0 such as *Story*, *Task*, or *Bug*. Where
+     * the issue type *Epic* is defined, these issue types are used to break down the
+     * content of an epic.
+     *  *  *Subtask* at level -1 (optional). This issue type enables level 0 issue
+     * types to be broken down into components. Issues based on a level -1 issue type
+     * must have a parent issue.
+     *
+     * **[Permissions](#permissions) required:** *Browse projects* [project
+     * permission](https://confluence.atlassian.com/x/yodKLg) for the project.
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: {
+     *   "hierarchy": [
+     *     {
+     *       "issueTypes": [
+     *         {
+     *           "avatarId": 10324,
+     *           "entityId": "ce32639b-8911-4689-81da-65681f451516",
+     *           "id": 10008,
+     *           "name": "Story"
+     *         },
+     *         {
+     *           "avatarId": 10324,
+     *           "entityId": "ffdbced5-fbfc-4370-a848-94e2ce3751af",
+     *           "id": 10001,
+     *           "name": "Bug"
+     *         }
+     *       ],
+     *       "level": 0,
+     *       "name": "Base"
+     *     },
+     *     {
+     *       "issueTypes": [
+     *         {
+     *           "avatarId": 10179,
+     *           "entityId": "80f20d47-34dc-4680-8937-936b7e762a35",
+     *           "id": 10007,
+     *           "name": "Epic"
+     *         }
+     *       ],
+     *       "level": 1,
+     *       "name": "Epic"
+     *     },
+     *     {
+     *       "issueTypes": [
+     *         {
+     *           "avatarId": 10573,
+     *           "entityId": "210b4879-15cc-414c-9746-f8f6b6be0a72",
+     *           "id": 10009,
+     *           "name": "Subtask"
+     *         }
+     *       ],
+     *       "level": -1,
+     *       "name": "Subtask"
+     *     }
+     *   ],
+     *   "projectId": 10030
+     * }
+     * @path {GET} /rest/api/3/project/{projectId}/hierarchy
+     * @scopes-current read:jira-work
+     * @scopes-beta read:issue-type:jira, read:issue-type-hierarchy:jira
+     */
+    getHierarchy({ projectId, }: {
+        /** The ID of the project. */
+        projectId: number;
+    }): Promise<ProjectIssueTypeHierarchy>;
+    /**
+     * Gets a [notification scheme](https://confluence.atlassian.com/x/8YdKLg)
+     * associated with the project.
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg) or *Administer Projects*
+     * [project permission](https://confluence.atlassian.com/x/yodKLg).
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: {
+     *   "description": "description",
+     *   "expand": "notificationSchemeEvents,user,group,projectRole,field,all",
+     *   "id": 10100,
+     *   "name": "notification scheme name",
+     *   "notificationSchemeEvents": [
+     *     {
+     *       "event": {
+     *         "description": "Event published when an issue is created",
+     *         "id": 1,
+     *         "name": "Issue created"
+     *       },
+     *       "notifications": [
+     *         {
+     *           "expand": "group",
+     *           "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"
+     *           },
+     *           "id": 1,
+     *           "notificationType": "Group",
+     *           "parameter": "jira-administrators",
+     *           "recipient": "276f955c-63d7-42c8-9520-92d01dca0625"
+     *         },
+     *         {
+     *           "id": 2,
+     *           "notificationType": "CurrentAssignee"
+     *         },
+     *         {
+     *           "expand": "projectRole",
+     *           "id": 3,
+     *           "notificationType": "ProjectRole",
+     *           "parameter": "10360",
+     *           "projectRole": {
+     *             "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",
+     *             "actors": [
+     *               {
+     *                 "actorGroup": {
+     *                   "name": "jira-developers",
+     *                   "displayName": "jira-developers",
+     *                   "groupId": "952d12c3-5b5b-4d04-bb32-44d383afc4b2"
+     *                 },
+     *                 "displayName": "jira-developers",
+     *                 "id": 10240,
+     *                 "name": "jira-developers",
+     *                 "type": "atlassian-group-role-actor"
+     *               },
+     *               {
+     *                 "actorUser": {
+     *                   "accountId": "5b10a2844c20165700ede21g"
+     *                 },
+     *                 "displayName": "Mia Krystof",
+     *                 "id": 10241,
+     *                 "type": "atlassian-user-role-actor"
+     *               }
+     *             ],
+     *             "scope": {
+     *               "project": {
+     *                 "id": "10000",
+     *                 "key": "KEY",
+     *                 "name": "Next Gen Project"
+     *               },
+     *               "type": "PROJECT"
+     *             }
+     *           },
+     *           "recipient": "10360"
+     *         },
+     *         {
+     *           "emailAddress": "rest-developer@atlassian.com",
+     *           "id": 4,
+     *           "notificationType": "EmailAddress",
+     *           "parameter": "rest-developer@atlassian.com",
+     *           "recipient": "rest-developer@atlassian.com"
+     *         },
+     *         {
+     *           "expand": "user",
+     *           "id": 5,
+     *           "notificationType": "User",
+     *           "parameter": "5b10a2844c20165700ede21g",
+     *           "recipient": "5b10a2844c20165700ede21g",
+     *           "user": {
+     *             "accountId": "5b10a2844c20165700ede21g",
+     *             "active": false,
+     *             "displayName": "Mia Krystof",
+     *             "self":
+     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+     *           }
+     *         },
+     *         {
+     *           "expand": "field",
+     *           "field": {
+     *             "clauseNames": [
+     *               "cf[10101]",
+     *               "New custom field"
+     *             ],
+     *             "custom": true,
+     *             "id": "customfield_10101",
+     *             "key": "customfield_10101",
+     *             "name": "New custom field",
+     *             "navigable": true,
+     *             "orderable": true,
+     *             "schema": {
+     *               "custom":
+     * "com.atlassian.jira.plugin.system.customfieldtypes:project",
+     *               "customId": 10101,
+     *               "type": "project"
+     *             },
+     *             "searchable": true,
+     *             "untranslatedName": "New custom field"
+     *           },
+     *           "id": 6,
+     *           "notificationType": "GroupCustomField",
+     *           "parameter": "customfield_10101",
+     *           "recipient": "customfield_10101"
+     *         }
+     *       ]
+     *     },
+     *     {
+     *       "event": {
+     *         "description": "Custom event that is published together with an issue
+     * created event",
+     *         "id": 20,
+     *         "name": "Custom event",
+     *         "templateEvent": {
+     *           "description": "Event published when an issue is created",
+     *           "id": 1,
+     *           "name": "Issue created"
+     *         }
+     *       },
+     *       "notifications": [
+     *         {
+     *           "expand": "group",
+     *           "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"
+     *           },
+     *           "id": 1,
+     *           "notificationType": "Group",
+     *           "parameter": "jira-administrators",
+     *           "recipient": "276f955c-63d7-42c8-9520-92d01dca0625"
+     *         },
+     *         {
+     *           "id": 2,
+     *           "notificationType": "CurrentAssignee"
+     *         },
+     *         {
+     *           "expand": "projectRole",
+     *           "id": 3,
+     *           "notificationType": "ProjectRole",
+     *           "parameter": "10360",
+     *           "projectRole": {
+     *             "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",
+     *             "actors": [
+     *               {
+     *                 "actorGroup": {
+     *                   "name": "jira-developers",
+     *                   "displayName": "jira-developers",
+     *                   "groupId": "952d12c3-5b5b-4d04-bb32-44d383afc4b2"
+     *                 },
+     *                 "displayName": "jira-developers",
+     *                 "id": 10240,
+     *                 "name": "jira-developers",
+     *                 "type": "atlassian-group-role-actor"
+     *               },
+     *               {
+     *                 "actorUser": {
+     *                   "accountId": "5b10a2844c20165700ede21g"
+     *                 },
+     *                 "displayName": "Mia Krystof",
+     *                 "id": 10241,
+     *                 "type": "atlassian-user-role-actor"
+     *               }
+     *             ],
+     *             "scope": {
+     *               "project": {
+     *                 "id": "10000",
+     *                 "key": "KEY",
+     *                 "name": "Next Gen Project"
+     *               },
+     *               "type": "PROJECT"
+     *             }
+     *           },
+     *           "recipient": "10360"
+     *         },
+     *         {
+     *           "emailAddress": "rest-developer@atlassian.com",
+     *           "id": 4,
+     *           "notificationType": "EmailAddress",
+     *           "parameter": "rest-developer@atlassian.com",
+     *           "recipient": "rest-developer@atlassian.com"
+     *         },
+     *         {
+     *           "expand": "user",
+     *           "id": 5,
+     *           "notificationType": "User",
+     *           "parameter": "5b10a2844c20165700ede21g",
+     *           "recipient": "5b10a2844c20165700ede21g",
+     *           "user": {
+     *             "accountId": "5b10a2844c20165700ede21g",
+     *             "active": false,
+     *             "displayName": "Mia Krystof",
+     *             "self":
+     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+     *           }
+     *         },
+     *         {
+     *           "expand": "field",
+     *           "field": {
+     *             "clauseNames": [
+     *               "cf[10101]",
+     *               "New custom field"
+     *             ],
+     *             "custom": true,
+     *             "id": "customfield_10101",
+     *             "key": "customfield_10101",
+     *             "name": "New custom field",
+     *             "navigable": true,
+     *             "orderable": true,
+     *             "schema": {
+     *               "custom":
+     * "com.atlassian.jira.plugin.system.customfieldtypes:project",
+     *               "customId": 10101,
+     *               "type": "project"
+     *             },
+     *             "searchable": true,
+     *             "untranslatedName": "New custom field"
+     *           },
+     *           "id": 6,
+     *           "notificationType": "GroupCustomField",
+     *           "parameter": "customfield_10101",
+     *           "recipient": "customfield_10101"
+     *         }
+     *       ]
+     *     }
+     *   ],
+     *   "projects": [
+     *     10001,
+     *     10002
+     *   ],
+     *   "self": "https://your-domain.atlassian.net/rest/api/3/notificationscheme"
+     * }
+     * @path {GET} /rest/api/3/project/{projectKeyOrId}/notificationscheme
+     * @scopes-current read:jira-work
+     * @scopes-beta read:project-category:jira, read:project-role:jira, read:project:jira,
+     * read:user:jira, read:group:jira, read:field:jira, read:avatar:jira,
+     * read:field-configuration:jira, read:notification-scheme:jira
+     */
+    getNotificationSchemeForProject({ projectKeyOrId, expand, }: {
+        /** The project ID or project key (case sensitive). */
+        projectKeyOrId: string;
+        /**
+         * Use [expand](#expansion) to include additional information in the response.
+         * This parameter accepts a comma-separated list. Expand options include:
+         *
+         *  *  `all` Returns all expandable information
+         *  *  `field` Returns information about any custom fields assigned to receive an
+         * event
+         *  *  `group` Returns information about any groups assigned to receive an event
+         *  *  `notificationSchemeEvents` Returns a list of event associations. This list
+         * is returned for all expandable information
+         *  *  `projectRole` Returns information about any project roles assigned to
+         * receive an event
+         *  *  `user` Returns information about any users assigned to receive an event
+         */
+        expand?: string;
+    }): Promise<NotificationScheme>;
+    /**
+     * Returns the [project details](https://confluence.atlassian.com/x/ahLpNw) for a
+     * project.
+     *
+     * This operation can be accessed anonymously.
+     *
+     * **[Permissions](#permissions) required:** *Browse projects* [project
+     * permission](https://confluence.atlassian.com/x/yodKLg) for the project.
+     *
+     * @returns Returned if successful.
+     *
+     * example: {
+     *   "assigneeType": "PROJECT_LEAD",
+     *   "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"
+     *   },
+     *   "components": [
+     *     {
+     *       "ari":
+     * "ari:cloud:compass:fdb3fdec-4e70-be56-11ee-0242ac120002:component/fdb3fdec-4e70-11ee-be56-0242ac120002/fdb3fdec-11ee-4e70-be56-0242ac120002",
+     *       "assignee": {
+     *         "accountId": "5b10a2844c20165700ede21g",
+     *         "accountType": "atlassian",
+     *         "active": false,
+     *         "avatarUrls": {
+     *           "16x16":
+     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
+     *           "24x24":
+     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
+     *           "32x32":
+     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
+     *           "48x48":
+     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
+     *         },
+     *         "displayName": "Mia Krystof",
+     *         "key": "",
+     *         "name": "",
+     *         "self":
+     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+     *       },
+     *       "assigneeType": "PROJECT_LEAD",
+     *       "description": "This is a Jira component",
+     *       "id": "10000",
+     *       "isAssigneeTypeValid": false,
+     *       "lead": {
+     *         "accountId": "5b10a2844c20165700ede21g",
+     *         "accountType": "atlassian",
+     *         "active": false,
+     *         "avatarUrls": {
+     *           "16x16":
+     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
+     *           "24x24":
+     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
+     *           "32x32":
+     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
+     *           "48x48":
+     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
+     *         },
+     *         "displayName": "Mia Krystof",
+     *         "key": "",
+     *         "name": "",
+     *         "self":
+     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+     *       },
+     *       "metadata": {
+     *         "icon": "https://www.example.com/icon.png"
+     *       },
+     *       "name": "Component 1",
+     *       "project": "HSP",
+     *       "projectId": 10000,
+     *       "realAssignee": {
+     *         "accountId": "5b10a2844c20165700ede21g",
+     *         "accountType": "atlassian",
+     *         "active": false,
+     *         "avatarUrls": {
+     *           "16x16":
+     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
+     *           "24x24":
+     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
+     *           "32x32":
+     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
+     *           "48x48":
+     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
+     *         },
+     *         "displayName": "Mia Krystof",
+     *         "key": "",
+     *         "name": "",
+     *         "self":
+     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+     *       },
+     *       "realAssigneeType": "PROJECT_LEAD",
+     *       "self": "https://your-domain.atlassian.net/rest/api/3/component/10000"
+     *     }
+     *   ],
+     *   "description": "This project was created as an example for REST.",
+     *   "email": "from-jira@example.com",
+     *   "id": "10000",
+     *   "insight": {
+     *     "lastIssueUpdateTime": "2021-04-22T05:37:05.000+0000",
+     *     "totalIssueCount": 100
+     *   },
+     *   "issueTypes": [
+     *     {
+     *       "avatarId": 1,
+     *       "description": "A task that needs to be done.",
+     *       "hierarchyLevel": 0,
+     *       "iconUrl":
+     * "https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10299&avatarType=issuetype\",",
+     *       "id": "3",
+     *       "name": "Task",
+     *       "self": "https://your-domain.atlassian.net/rest/api/3/issueType/3",
+     *       "subtask": false
+     *     },
+     *     {
+     *       "avatarId": 10002,
+     *       "description": "A problem with the software.",
+     *       "entityId": "9d7dd6f7-e8b6-4247-954b-7b2c9b2a5ba2",
+     *       "hierarchyLevel": 0,
+     *       "iconUrl":
+     * "https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10316&avatarType=issuetype\",",
+     *       "id": "1",
+     *       "name": "Bug",
+     *       "scope": {
+     *         "project": {
+     *           "id": "10000"
+     *         },
+     *         "type": "PROJECT"
+     *       },
+     *       "self": "https://your-domain.atlassian.net/rest/api/3/issueType/1",
+     *       "subtask": false
+     *     }
+     *   ],
+     *   "key": "EX",
+     *   "lead": {
+     *     "accountId": "5b10a2844c20165700ede21g",
+     *     "accountType": "atlassian",
+     *     "active": false,
+     *     "avatarUrls": {
+     *       "16x16":
+     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
+     *       "24x24":
+     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
+     *       "32x32":
+     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
+     *       "48x48":
+     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
+     *     },
+     *     "displayName": "Mia Krystof",
+     *     "key": "",
+     *     "name": "",
+     *     "self":
+     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+     *   },
+     *   "name": "Example",
+     *   "projectCategory": {
+     *     "description": "First Project Category",
+     *     "id": "10000",
+     *     "name": "FIRST",
+     *     "self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
+     *   },
+     *   "properties": {
+     *     "propertyKey": "propertyValue"
+     *   },
+     *   "roles": {
+     *     "Developers":
+     * "https://your-domain.atlassian.net/rest/api/3/project/EX/role/10000"
+     *   },
+     *   "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
+     *   "simplified": false,
+     *   "style": "classic",
+     *   "url": "https://www.example.com",
+     *   "versions": []
+     * }
+     * @path {GET} /rest/api/3/project/{projectIdOrKey}
+     * @scopes-current read:jira-work
+     * @scopes-beta read:issue-type:jira, read:project:jira, read:project.property:jira,
+     * read:user:jira, read:application-role:jira, read:avatar:jira, read:group:jira,
+     * read:issue-type-hierarchy:jira, read:project-category:jira,
+     * read:project-version:jira, read:project.component:jira
+     */
+    getProject({ projectIdOrKey, expand, properties, }: {
+        /** The project ID or project key (case sensitive). */
+        projectIdOrKey: string;
+        /**
+         * Use [expand](#expansion) to include additional information in the response.
+         * This parameter accepts a comma-separated list. Note that the project
+         * description, issue types, and project lead are included in all responses by
+         * default. Expand options include:
+         *
+         *  *  `description` The project description.
+         *  *  `issueTypes` The issue types associated with the project.
+         *  *  `lead` The project lead.
+         *  *  `projectKeys` All project keys associated with the project.
+         *  *  `issueTypeHierarchy` The project issue type hierarchy.
+         */
+        expand?: string;
+        /**
+         * A list of project properties to return for the project. This parameter accepts
+         * a comma-separated list.
+         */
+        properties?: string[];
+    }): Promise<Project>;
+    /**
+     * Returns a list of up to 20 projects recently viewed by the user that are still
+     * visible to the user.
+     *
+     * This operation can be accessed anonymously.
+     *
+     * **[Permissions](#permissions) required:** Projects are returned only where the
+     * user has one of:
+     *
+     *  *  *Browse Projects* [project
+     * permission](https://confluence.atlassian.com/x/yodKLg) for the project.
+     *  *  *Administer Projects* [project
+     * permission](https://confluence.atlassian.com/x/yodKLg) for the project.
+     *  *  *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: [
+     *   {
+     *     "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"
+     *     },
+     *     "id": "10000",
+     *     "insight": {
+     *       "lastIssueUpdateTime": 1619069825000,
+     *       "totalIssueCount": 100
+     *     },
+     *     "key": "EX",
+     *     "name": "Example",
+     *     "projectCategory": {
+     *       "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/project/EX",
+     *     "simplified": false,
+     *     "style": "CLASSIC"
+     *   },
+     *   {
+     *     "avatarUrls": {
+     *       "16x16":
+     * "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10001",
+     *       "24x24":
+     * "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10001",
+     *       "32x32":
+     * "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10001",
+     *       "48x48":
+     * "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10001"
+     *     },
+     *     "id": "10001",
+     *     "insight": {
+     *       "lastIssueUpdateTime": 1619069825000,
+     *       "totalIssueCount": 100
+     *     },
+     *     "key": "ABC",
+     *     "name": "Alphabetical",
+     *     "projectCategory": {
+     *       "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/project/ABC",
+     *     "simplified": false,
+     *     "style": "CLASSIC"
+     *   }
+     * ]
+     * @path {GET} /rest/api/3/project/recent
+     * @scopes-current read:jira-work
+     * @scopes-beta read:issue-type:jira, read:project:jira, read:project.property:jira,
+     * read:user:jira, read:application-role:jira, read:avatar:jira, read:group:jira,
+     * read:issue-type-hierarchy:jira, read:project-category:jira,
+     * read:project-version:jira, read:project.component:jira
+     */
+    getRecent({ expand, properties, }: {
+        /**
+         * Use [expand](#expansion) to include additional information in the response.
+         * This parameter accepts a comma-separated list. Expanded options include:
+         *
+         *  *  `description` Returns the project description.
+         *  *  `projectKeys` Returns all project keys associated with a project.
+         *  *  `lead` Returns information about the project lead.
+         *  *  `issueTypes` Returns all issue types associated with the project.
+         *  *  `url` Returns the URL associated with the project.
+         *  *  `permissions` Returns the permissions associated with the project.
+         *  *  `insight` EXPERIMENTAL. Returns the insight details of total issue count
+         * and last issue update time for the project.
+         *  *  `*` Returns the project with all available expand options.
+         */
+        expand?: string;
+        /**
+         * EXPERIMENTAL. A list of project properties to return for the project. This
+         * parameter accepts a comma-separated list. Invalid property names are ignored.
+         */
+        properties?: StringList[];
+    }): Promise<Project[]>;
+    /**
+     * Restores a project that has been archived or placed in the Jira recycle bin.
+     *
+     * **[Permissions](#permissions) required:**
+     *
+     *  *  *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg)for Company managed
+     * projects.
+     *  *  *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg) or *Administer projects*
+     * [project permission](https://confluence.atlassian.com/x/yodKLg) for the project
+     * for Team managed projects.
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: {
+     *   "assigneeType": "PROJECT_LEAD",
+     *   "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"
+     *   },
+     *   "components": [
+     *     {
+     *       "ari":
+     * "ari:cloud:compass:fdb3fdec-4e70-be56-11ee-0242ac120002:component/fdb3fdec-4e70-11ee-be56-0242ac120002/fdb3fdec-11ee-4e70-be56-0242ac120002",
+     *       "assignee": {
+     *         "accountId": "5b10a2844c20165700ede21g",
+     *         "accountType": "atlassian",
+     *         "active": false,
+     *         "avatarUrls": {
+     *           "16x16":
+     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
+     *           "24x24":
+     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
+     *           "32x32":
+     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
+     *           "48x48":
+     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
+     *         },
+     *         "displayName": "Mia Krystof",
+     *         "key": "",
+     *         "name": "",
+     *         "self":
+     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+     *       },
+     *       "assigneeType": "PROJECT_LEAD",
+     *       "description": "This is a Jira component",
+     *       "id": "10000",
+     *       "isAssigneeTypeValid": false,
+     *       "lead": {
+     *         "accountId": "5b10a2844c20165700ede21g",
+     *         "accountType": "atlassian",
+     *         "active": false,
+     *         "avatarUrls": {
+     *           "16x16":
+     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
+     *           "24x24":
+     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
+     *           "32x32":
+     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
+     *           "48x48":
+     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
+     *         },
+     *         "displayName": "Mia Krystof",
+     *         "key": "",
+     *         "name": "",
+     *         "self":
+     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+     *       },
+     *       "metadata": {
+     *         "icon": "https://www.example.com/icon.png"
+     *       },
+     *       "name": "Component 1",
+     *       "project": "HSP",
+     *       "projectId": 10000,
+     *       "realAssignee": {
+     *         "accountId": "5b10a2844c20165700ede21g",
+     *         "accountType": "atlassian",
+     *         "active": false,
+     *         "avatarUrls": {
+     *           "16x16":
+     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
+     *           "24x24":
+     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
+     *           "32x32":
+     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
+     *           "48x48":
+     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
+     *         },
+     *         "displayName": "Mia Krystof",
+     *         "key": "",
+     *         "name": "",
+     *         "self":
+     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+     *       },
+     *       "realAssigneeType": "PROJECT_LEAD",
+     *       "self": "https://your-domain.atlassian.net/rest/api/3/component/10000"
+     *     }
+     *   ],
+     *   "description": "This project was created as an example for REST.",
+     *   "email": "from-jira@example.com",
+     *   "id": "10000",
+     *   "insight": {
+     *     "lastIssueUpdateTime": "2021-04-22T05:37:05.000+0000",
+     *     "totalIssueCount": 100
+     *   },
+     *   "issueTypes": [
+     *     {
+     *       "avatarId": 1,
+     *       "description": "A task that needs to be done.",
+     *       "hierarchyLevel": 0,
+     *       "iconUrl":
+     * "https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10299&avatarType=issuetype\",",
+     *       "id": "3",
+     *       "name": "Task",
+     *       "self": "https://your-domain.atlassian.net/rest/api/3/issueType/3",
+     *       "subtask": false
+     *     },
+     *     {
+     *       "avatarId": 10002,
+     *       "description": "A problem with the software.",
+     *       "entityId": "9d7dd6f7-e8b6-4247-954b-7b2c9b2a5ba2",
+     *       "hierarchyLevel": 0,
+     *       "iconUrl":
+     * "https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10316&avatarType=issuetype\",",
+     *       "id": "1",
+     *       "name": "Bug",
+     *       "scope": {
+     *         "project": {
+     *           "id": "10000"
+     *         },
+     *         "type": "PROJECT"
+     *       },
+     *       "self": "https://your-domain.atlassian.net/rest/api/3/issueType/1",
+     *       "subtask": false
+     *     }
+     *   ],
+     *   "key": "EX",
+     *   "lead": {
+     *     "accountId": "5b10a2844c20165700ede21g",
+     *     "accountType": "atlassian",
+     *     "active": false,
+     *     "avatarUrls": {
+     *       "16x16":
+     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
+     *       "24x24":
+     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
+     *       "32x32":
+     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
+     *       "48x48":
+     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
+     *     },
+     *     "displayName": "Mia Krystof",
+     *     "key": "",
+     *     "name": "",
+     *     "self":
+     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+     *   },
+     *   "name": "Example",
+     *   "projectCategory": {
+     *     "description": "First Project Category",
+     *     "id": "10000",
+     *     "name": "FIRST",
+     *     "self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
+     *   },
+     *   "properties": {
+     *     "propertyKey": "propertyValue"
+     *   },
+     *   "roles": {
+     *     "Developers":
+     * "https://your-domain.atlassian.net/rest/api/3/project/EX/role/10000"
+     *   },
+     *   "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
+     *   "simplified": false,
+     *   "style": "classic",
+     *   "url": "https://www.example.com",
+     *   "versions": []
+     * }
+     * @path {POST} /rest/api/3/project/{projectIdOrKey}/restore
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta read:issue-type:jira, read:project:jira, read:project.property:jira,
+     * read:user:jira, write:project:jira, read:application-role:jira,
+     * read:avatar:jira, read:group:jira, read:issue-type-hierarchy:jira,
+     * read:project-category:jira, read:project-version:jira,
+     * read:project.component:jira
+     */
+    restore({ projectIdOrKey, }: {
+        /** The project ID or project key (case sensitive). */
+        projectIdOrKey: string;
+    }): Promise<Project>;
+    /**
+     * Returns a [paginated](#pagination) list of projects visible to the user.
+     *
+     * This operation can be accessed anonymously.
+     *
+     * **[Permissions](#permissions) required:** Projects are returned only where the
+     * user has one of:
+     *
+     *  *  *Browse Projects* [project
+     * permission](https://confluence.atlassian.com/x/yodKLg) for the project.
+     *  *  *Administer Projects* [project
+     * permission](https://confluence.atlassian.com/x/yodKLg) for the project.
+     *  *  *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: {
+     *   "isLast": false,
+     *   "maxResults": 2,
+     *   "nextPage":
+     * "https://your-domain.atlassian.net/rest/api/3/project/search?startAt=2&maxResults=2",
+     *   "self":
+     * "https://your-domain.atlassian.net/rest/api/3/project/search?startAt=0&maxResults=2",
+     *   "startAt": 0,
+     *   "total": 7,
+     *   "values": [
+     *     {
+     *       "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"
+     *       },
+     *       "id": "10000",
+     *       "insight": {
+     *         "lastIssueUpdateTime": "2021-04-22T05:37:05.000+0000",
+     *         "totalIssueCount": 100
+     *       },
+     *       "key": "EX",
+     *       "name": "Example",
+     *       "projectCategory": {
+     *         "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/project/EX",
+     *       "simplified": false,
+     *       "style": "classic"
+     *     },
+     *     {
+     *       "avatarUrls": {
+     *         "16x16":
+     * "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10001",
+     *         "24x24":
+     * "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10001",
+     *         "32x32":
+     * "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10001",
+     *         "48x48":
+     * "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10001"
+     *       },
+     *       "id": "10001",
+     *       "insight": {
+     *         "lastIssueUpdateTime": "2021-04-22T05:37:05.000+0000",
+     *         "totalIssueCount": 100
+     *       },
+     *       "key": "ABC",
+     *       "name": "Alphabetical",
+     *       "projectCategory": {
+     *         "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/project/ABC",
+     *       "simplified": false,
+     *       "style": "classic"
+     *     }
+     *   ]
+     * }
+     * @path {GET} /rest/api/3/project/search
+     * @scopes-current read:jira-work
+     * @scopes-beta read:issue-type:jira, read:project:jira, read:project.property:jira,
+     * read:user:jira, read:application-role:jira, read:avatar:jira, read:group:jira,
+     * read:issue-type-hierarchy:jira, read:project-category:jira,
+     * read:project-version:jira, read:project.component:jira
+     */
+    searchProjects({ startAt, maxResults, orderBy, id, keys, query, typeKey, categoryId, action, expand, status, properties, propertyQuery, }: {
+        /** The index of the first item to return in a page of results (page offset). */
+        startAt?: number;
+        /** The maximum number of items to return per page. */
+        maxResults?: number;
+        /**
+         * [Order](#ordering) the results by a field.
+         *
+         *  *  `category` Sorts by project category. A complete list of category IDs is
+         * found using [Get all project categories](#api-rest-api-3-projectCategory-get).
+         *  *  `issueCount` Sorts by the total number of issues in each project.
+         *  *  `key` Sorts by project key.
+         *  *  `lastIssueUpdatedTime` Sorts by the last issue update time.
+         *  *  `name` Sorts by project name.
+         *  *  `owner` Sorts by project lead.
+         *  *  `archivedDate` EXPERIMENTAL. Sorts by project archived date.
+         *  *  `deletedDate` EXPERIMENTAL. Sorts by project deleted date.
+         */
+        orderBy?: "category" | "-category" | "+category" | "key" | "-key" | "+key" | "name" | "-name" | "+name" | "owner" | "-owner" | "+owner" | "issueCount" | "-issueCount" | "+issueCount" | "lastIssueUpdatedDate" | "-lastIssueUpdatedDate" | "+lastIssueUpdatedDate" | "archivedDate" | "+archivedDate" | "-archivedDate" | "deletedDate" | "+deletedDate" | "-deletedDate";
+        /**
+         * The project IDs to filter the results by. To include multiple IDs, provide an
+         * ampersand-separated list. For example, `id=10000&id=10001`. Up to 50 project
+         * IDs can be provided.
+         */
+        id?: number[];
+        /**
+         * The project keys to filter the results by. To include multiple keys, provide an
+         * ampersand-separated list. For example, `keys=PA&keys=PB`. Up to 50 project keys
+         * can be provided.
+         */
+        keys?: string[];
+        /**
+         * Filter the results using a literal string. Projects with a matching `key` or
+         * `name` are returned (case insensitive).
+         */
+        query?: string;
+        /**
+         * Orders results by the [project
+         * type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes).
+         * This parameter accepts a comma-separated list. Valid values are `business`,
+         * `service_desk`, and `software`.
+         */
+        typeKey?: string;
+        /**
+         * The ID of the project's category. A complete list of category IDs is found
+         * using the [Get all project categories](#api-rest-api-3-projectCategory-get)
+         * operation.
+         */
+        categoryId?: number;
+        /**
+         * Filter results by projects for which the user can:
+         *
+         *  *  `view` the project, meaning that they have one of the following permissions:
+         *
+         *      *  *Browse projects* [project
+         * permission](https://confluence.atlassian.com/x/yodKLg) for the project.
+         *      *  *Administer projects* [project
+         * permission](https://confluence.atlassian.com/x/yodKLg) for the project.
+         *      *  *Administer Jira* [global
+         * permission](https://confluence.atlassian.com/x/x4dKLg).
+         *  *  `browse` the project, meaning that they have the *Browse projects* [project
+         * permission](https://confluence.atlassian.com/x/yodKLg) for the project.
+         *  *  `edit` the project, meaning that they have one of the following permissions:
+         *
+         *      *  *Administer projects* [project
+         * permission](https://confluence.atlassian.com/x/yodKLg) for the project.
+         *      *  *Administer Jira* [global
+         * permission](https://confluence.atlassian.com/x/x4dKLg).
+         *  *  `create` the project, meaning that they have the *Create issues* [project
+         * permission](https://confluence.atlassian.com/x/yodKLg) for the project in which
+         * the issue is created.
+         */
+        action?: "view" | "browse" | "edit" | "create";
+        /**
+         * Use [expand](#expansion) to include additional information in the response.
+         * This parameter accepts a comma-separated list. Expanded options include:
+         *
+         *  *  `description` Returns the project description.
+         *  *  `projectKeys` Returns all project keys associated with a project.
+         *  *  `lead` Returns information about the project lead.
+         *  *  `issueTypes` Returns all issue types associated with the project.
+         *  *  `url` Returns the URL associated with the project.
+         *  *  `insight` EXPERIMENTAL. Returns the insight details of total issue count
+         * and last issue update time for the project.
+         */
+        expand?: string;
+        /**
+         * EXPERIMENTAL. Filter results by project status:
+         *
+         *  *  `live` Search live projects.
+         *  *  `archived` Search archived projects.
+         *  *  `deleted` Search deleted projects, those in the recycle bin.
+         */
+        status?: ("live" | "archived" | "deleted")[];
+        /**
+         * EXPERIMENTAL. A list of project properties to return for the project. This
+         * parameter accepts a comma-separated list.
+         */
+        properties?: StringList[];
+        /**
+         * EXPERIMENTAL. A query string used to search properties. The query string cannot
+         * be specified using a JSON object. For example, to search for the value of
+         * `nested` from `{"something":{"nested":1,"other":2}}` use
+         * `[thepropertykey].something.nested=1`. Note that the propertyQuery key is
+         * enclosed in square brackets to enable searching where the propertyQuery key
+         * includes dot (.) or equals (=) characters. Note that `thepropertykey` is only
+         * returned when included in `properties`.
+         */
+        propertyQuery?: string;
+    }): Promise<PageBeanProject>;
+    /**
+     * Updates the [project details](https://confluence.atlassian.com/x/ahLpNw) of a
+     * project.
+     *
+     * All parameters are optional in the body of the request. Schemes will only be
+     * updated if they are included in the request, any omitted schemes will be left
+     * unchanged.
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg). is only needed when
+     * changing the schemes or project key. Otherwise you will only need *Administer
+     * Projects* [project permission](https://confluence.atlassian.com/x/yodKLg)
+     *
+     * @returns Returned if the project is updated.
+     *
+     * example: {
+     *   "assigneeType": "PROJECT_LEAD",
+     *   "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"
+     *   },
+     *   "components": [
+     *     {
+     *       "ari":
+     * "ari:cloud:compass:fdb3fdec-4e70-be56-11ee-0242ac120002:component/fdb3fdec-4e70-11ee-be56-0242ac120002/fdb3fdec-11ee-4e70-be56-0242ac120002",
+     *       "assignee": {
+     *         "accountId": "5b10a2844c20165700ede21g",
+     *         "accountType": "atlassian",
+     *         "active": false,
+     *         "avatarUrls": {
+     *           "16x16":
+     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
+     *           "24x24":
+     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
+     *           "32x32":
+     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
+     *           "48x48":
+     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
+     *         },
+     *         "displayName": "Mia Krystof",
+     *         "key": "",
+     *         "name": "",
+     *         "self":
+     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+     *       },
+     *       "assigneeType": "PROJECT_LEAD",
+     *       "description": "This is a Jira component",
+     *       "id": "10000",
+     *       "isAssigneeTypeValid": false,
+     *       "lead": {
+     *         "accountId": "5b10a2844c20165700ede21g",
+     *         "accountType": "atlassian",
+     *         "active": false,
+     *         "avatarUrls": {
+     *           "16x16":
+     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
+     *           "24x24":
+     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
+     *           "32x32":
+     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
+     *           "48x48":
+     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
+     *         },
+     *         "displayName": "Mia Krystof",
+     *         "key": "",
+     *         "name": "",
+     *         "self":
+     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+     *       },
+     *       "metadata": {
+     *         "icon": "https://www.example.com/icon.png"
+     *       },
+     *       "name": "Component 1",
+     *       "project": "HSP",
+     *       "projectId": 10000,
+     *       "realAssignee": {
+     *         "accountId": "5b10a2844c20165700ede21g",
+     *         "accountType": "atlassian",
+     *         "active": false,
+     *         "avatarUrls": {
+     *           "16x16":
+     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
+     *           "24x24":
+     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
+     *           "32x32":
+     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
+     *           "48x48":
+     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
+     *         },
+     *         "displayName": "Mia Krystof",
+     *         "key": "",
+     *         "name": "",
+     *         "self":
+     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+     *       },
+     *       "realAssigneeType": "PROJECT_LEAD",
+     *       "self": "https://your-domain.atlassian.net/rest/api/3/component/10000"
+     *     }
+     *   ],
+     *   "description": "This project was created as an example for REST.",
+     *   "email": "from-jira@example.com",
+     *   "id": "10000",
+     *   "insight": {
+     *     "lastIssueUpdateTime": "2021-04-22T05:37:05.000+0000",
+     *     "totalIssueCount": 100
+     *   },
+     *   "issueTypes": [
+     *     {
+     *       "avatarId": 1,
+     *       "description": "A task that needs to be done.",
+     *       "hierarchyLevel": 0,
+     *       "iconUrl":
+     * "https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10299&avatarType=issuetype\",",
+     *       "id": "3",
+     *       "name": "Task",
+     *       "self": "https://your-domain.atlassian.net/rest/api/3/issueType/3",
+     *       "subtask": false
+     *     },
+     *     {
+     *       "avatarId": 10002,
+     *       "description": "A problem with the software.",
+     *       "entityId": "9d7dd6f7-e8b6-4247-954b-7b2c9b2a5ba2",
+     *       "hierarchyLevel": 0,
+     *       "iconUrl":
+     * "https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10316&avatarType=issuetype\",",
+     *       "id": "1",
+     *       "name": "Bug",
+     *       "scope": {
+     *         "project": {
+     *           "id": "10000"
+     *         },
+     *         "type": "PROJECT"
+     *       },
+     *       "self": "https://your-domain.atlassian.net/rest/api/3/issueType/1",
+     *       "subtask": false
+     *     }
+     *   ],
+     *   "key": "EX",
+     *   "lead": {
+     *     "accountId": "5b10a2844c20165700ede21g",
+     *     "accountType": "atlassian",
+     *     "active": false,
+     *     "avatarUrls": {
+     *       "16x16":
+     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
+     *       "24x24":
+     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
+     *       "32x32":
+     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
+     *       "48x48":
+     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
+     *     },
+     *     "displayName": "Mia Krystof",
+     *     "key": "",
+     *     "name": "",
+     *     "self":
+     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+     *   },
+     *   "name": "Example",
+     *   "projectCategory": {
+     *     "description": "First Project Category",
+     *     "id": "10000",
+     *     "name": "FIRST",
+     *     "self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
+     *   },
+     *   "properties": {
+     *     "propertyKey": "propertyValue"
+     *   },
+     *   "roles": {
+     *     "Developers":
+     * "https://your-domain.atlassian.net/rest/api/3/project/EX/role/10000"
+     *   },
+     *   "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
+     *   "simplified": false,
+     *   "style": "classic",
+     *   "url": "https://www.example.com",
+     *   "versions": []
+     * }
+     * @path {PUT} /rest/api/3/project/{projectIdOrKey}
+     * @scopes-current manage:jira-project
+     * @scopes-beta read:issue-type:jira, read:project:jira, read:project.property:jira,
+     * read:user:jira, write:project:jira, write:project.avatar:jira,
+     * read:application-role:jira, read:avatar:jira, read:group:jira,
+     * read:issue-type-hierarchy:jira, read:project-category:jira,
+     * read:project-version:jira, read:project.component:jira
+     */
+    updateProject({ projectIdOrKey, expand, updateProjectDetails, }: {
+        /** The project ID or project key (case sensitive). */
+        projectIdOrKey: string;
+        /**
+         * Use [expand](#expansion) to include additional information in the response.
+         * This parameter accepts a comma-separated list. Note that the project
+         * description, issue types, and project lead are included in all responses by
+         * default. Expand options include:
+         *
+         *  *  `description` The project description.
+         *  *  `issueTypes` The issue types associated with the project.
+         *  *  `lead` The project lead.
+         *  *  `projectKeys` All project keys associated with the project.
+         */
+        expand?: string;
+        /**
+         * The project details to be updated.
+         *
+         * @example {
+         *     "assigneeType": "PROJECT_LEAD",
+         *     "avatarId": 10200,
+         *     "categoryId": 10120,
+         *     "description": "Cloud migration initiative",
+         *     "issueSecurityScheme": 10001,
+         *     "key": "EX",
+         *     "leadAccountId": "5b10a0effa615349cb016cd8",
+         *     "name": "Example",
+         *     "notificationScheme": 10021,
+         *     "permissionScheme": 10011,
+         *     "url": "http://atlassian.com"
+         * }
+         */
+        updateProjectDetails: UpdateProjectDetails;
+    }): Promise<Project>;
+    static initialize(): void;
+}