/** * 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 { Component, ComponentIssuesCount, PageBeanComponentWithIssueCount } from '../models'; export interface CreateComponentRequest { Component: Component; } export interface DeleteComponentRequest { id: string; moveIssuesTo?: string; } export interface GetComponentRequest { id: string; } export interface GetComponentRelatedIssuesRequest { id: string; } export interface GetProjectComponentsRequest { projectIdOrKey: string; } export interface GetProjectComponentsPaginatedRequest { projectIdOrKey: string; startAt?: number; maxResults?: number; orderBy?: string; query?: string; } export interface UpdateComponentRequest { id: string; Component: Component; } /** * no description */ export declare class ProjectComponentsApi extends runtime.BaseAPI { /** * Creates a component. Use components to provide containers for issues within a project. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project in which the component is created or *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Create component */ createComponentRaw(requestParameters: CreateComponentRequest): Promise>; /** * Creates a component. Use components to provide containers for issues within a project. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project in which the component is created or *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Create component */ createComponent(requestParameters: CreateComponentRequest): Promise; /** * Deletes a component. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project containing the component or *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Delete component */ deleteComponentRaw(requestParameters: DeleteComponentRequest): Promise>; /** * Deletes a component. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project containing the component or *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Delete component */ deleteComponent(requestParameters: DeleteComponentRequest): Promise; /** * Returns a component. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for project containing the component. * Get component */ getComponentRaw(requestParameters: GetComponentRequest): Promise>; /** * Returns a component. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for project containing the component. * Get component */ getComponent(requestParameters: GetComponentRequest): Promise; /** * Returns the counts of issues assigned to the component. This operation can be accessed anonymously. **[Permissions](#permissions) required:** None. * Get component issues count */ getComponentRelatedIssuesRaw(requestParameters: GetComponentRelatedIssuesRequest): Promise>; /** * Returns the counts of issues assigned to the component. This operation can be accessed anonymously. **[Permissions](#permissions) required:** None. * Get component issues count */ getComponentRelatedIssues(requestParameters: GetComponentRelatedIssuesRequest): Promise; /** * Returns all components in a project. See the [Get project components paginated](#api-rest-api-3-project-projectIdOrKey-component-get) resource if you want to get a full list of components with pagination. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Browse Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project. * Get project components */ getProjectComponentsRaw(requestParameters: GetProjectComponentsRequest): Promise>>; /** * Returns all components in a project. See the [Get project components paginated](#api-rest-api-3-project-projectIdOrKey-component-get) resource if you want to get a full list of components with pagination. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Browse Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project. * Get project components */ getProjectComponents(requestParameters: GetProjectComponentsRequest): Promise>; /** * Returns a [paginated](#pagination) representation of all components in a project. See the [Get project components](#api-rest-api-3-project-projectIdOrKey-components-get) resource if you want to get a full list of versions without pagination. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Browse Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project. * Get project components paginated */ getProjectComponentsPaginatedRaw(requestParameters: GetProjectComponentsPaginatedRequest): Promise>; /** * Returns a [paginated](#pagination) representation of all components in a project. See the [Get project components](#api-rest-api-3-project-projectIdOrKey-components-get) resource if you want to get a full list of versions without pagination. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Browse Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project. * Get project components paginated */ getProjectComponentsPaginated(requestParameters: GetProjectComponentsPaginatedRequest): Promise; /** * Updates a component. Any fields included in the request are overwritten. If `leadAccountId` is an empty string (\"\") the component lead is removed. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project containing the component or *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Update component */ updateComponentRaw(requestParameters: UpdateComponentRequest): Promise>; /** * Updates a component. Any fields included in the request are overwritten. If `leadAccountId` is an empty string (\"\") the component lead is removed. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project containing the component or *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Update component */ updateComponent(requestParameters: UpdateComponentRequest): Promise; }