/** * The Jira Cloud platform REST API * Jira Cloud platform REST API documentation * * The version of the OpenAPI document: 1001.0.0-SNAPSHOT * Contact: ecosystem@atlassian.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import * as runtime from '../runtime'; import { IssueTypeWithStatus, NotificationScheme, PageBeanProject, Project, ProjectIdentifiers, ProjectInputBean } from '../models'; export interface CreateProjectRequest { ProjectInputBean: ProjectInputBean; } export interface DeleteProjectRequest { projectIdOrKey: string; } export interface GetAllProjectsRequest { expand?: string; recent?: number; properties?: Array; } export interface GetAllStatusesRequest { projectIdOrKey: string; } export interface GetNotificationScheme1Request { projectKeyOrId: string; expand?: string; } export interface GetProjectRequest { projectIdOrKey: string; expand?: string; properties?: Array; } export interface SearchProjectsRequest { startAt?: number; maxResults?: number; orderBy?: string; query?: string; typeKey?: string; categoryId?: number; searchBy?: string; action?: SearchProjectsActionEnum; expand?: string; } export interface UpdateProjectRequest { projectIdOrKey: string; ProjectInputBean: ProjectInputBean; expand?: string; } export interface UpdateProjectTypeRequest { projectIdOrKey: string; newProjectTypeKey: UpdateProjectTypeNewProjectTypeKeyEnum; } /** * no description */ export declare class ProjectsApi extends runtime.BaseAPI { /** * 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-desk, com.atlassian.servicedesk:simplified-internal-service-desk, com.atlassian.servicedesk:simplified-external-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 Desk 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 Desk 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). * Create project */ createProjectRaw(requestParameters: CreateProjectRequest): Promise>; /** * 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-desk, com.atlassian.servicedesk:simplified-internal-service-desk, com.atlassian.servicedesk:simplified-external-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 Desk 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 Desk 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). * Create project */ createProject(requestParameters: CreateProjectRequest): Promise; /** * Deletes a project. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Delete project */ deleteProjectRaw(requestParameters: DeleteProjectRequest): Promise>; /** * Deletes a project. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Delete project */ deleteProject(requestParameters: DeleteProjectRequest): Promise; /** * 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. * Get all projects */ getAllProjectsRaw(requestParameters: GetAllProjectsRequest): Promise>>; /** * 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. * Get all projects */ getAllProjects(requestParameters: GetAllProjectsRequest): Promise>; /** * 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. * Get all statuses for project */ getAllStatusesRaw(requestParameters: GetAllStatusesRequest): Promise>>; /** * 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. * Get all statuses for project */ getAllStatuses(requestParameters: GetAllStatusesRequest): Promise>; /** * Gets a [notification scheme](https://confluence.atlassian.com/x/8YdKLg) associated with the project. See the [Get notification scheme](#api-rest-api-3-notificationscheme-id-get) resource for more information about notification schemes. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) or *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg). * Get project notification scheme */ getNotificationScheme1Raw(requestParameters: GetNotificationScheme1Request): Promise>; /** * Gets a [notification scheme](https://confluence.atlassian.com/x/8YdKLg) associated with the project. See the [Get notification scheme](#api-rest-api-3-notificationscheme-id-get) resource for more information about notification schemes. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) or *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg). * Get project notification scheme */ getNotificationScheme1(requestParameters: GetNotificationScheme1Request): Promise; /** * 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. * Get project */ getProjectRaw(requestParameters: GetProjectRequest): Promise>; /** * 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. * Get project */ getProject(requestParameters: GetProjectRequest): Promise; /** * Returns projects visible to the user. This operation can be accessed anonymously. **[Permissions](#permissions) required:** Projects are returned only where the user has *Browse Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project. * Get projects paginated */ searchProjectsRaw(requestParameters: SearchProjectsRequest): Promise>; /** * Returns projects visible to the user. This operation can be accessed anonymously. **[Permissions](#permissions) required:** Projects are returned only where the user has *Browse Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project. * Get projects paginated */ searchProjects(requestParameters: SearchProjectsRequest): Promise; /** * Updates the [project details](https://confluence.atlassian.com/x/ahLpNw) of a project. All parameters are optional in the body of the request. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Update project */ updateProjectRaw(requestParameters: UpdateProjectRequest): Promise>; /** * Updates the [project details](https://confluence.atlassian.com/x/ahLpNw) of a project. All parameters are optional in the body of the request. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Update project */ updateProject(requestParameters: UpdateProjectRequest): Promise; /** * Deprecated, this feature is no longer supported and no alternatives are available, see [Convert project to a different template or type](https://confluence.atlassian.com/x/yEKeOQ). Updates a [project type](https://confluence.atlassian.com/x/GwiiLQ). The project type can be updated for classic projects only, project type cannot be updated for next-gen projects. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Update project type */ updateProjectTypeRaw(requestParameters: UpdateProjectTypeRequest): Promise>; /** * Deprecated, this feature is no longer supported and no alternatives are available, see [Convert project to a different template or type](https://confluence.atlassian.com/x/yEKeOQ). Updates a [project type](https://confluence.atlassian.com/x/GwiiLQ). The project type can be updated for classic projects only, project type cannot be updated for next-gen projects. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Update project type */ updateProjectType(requestParameters: UpdateProjectTypeRequest): Promise; } /** * @export * @enum {string} */ export declare enum SearchProjectsActionEnum { View = "view", Browse = "browse", Edit = "edit" } /** * @export * @enum {string} */ export declare enum UpdateProjectTypeNewProjectTypeKeyEnum { Software = "software", ServiceDesk = "service_desk", Business = "business" }