/** * 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 { DeleteAndReplaceVersionBean, PageBeanVersion, Version, VersionIssueCounts, VersionMoveBean, VersionUnresolvedIssuesCount } from '../models'; export interface CreateVersionRequest { Version: Version; } export interface DeleteAndReplaceVersionRequest { id: string; DeleteAndReplaceVersionBean: DeleteAndReplaceVersionBean; } export interface DeleteVersionRequest { id: string; moveFixIssuesTo?: string; moveAffectedIssuesTo?: string; } export interface GetProjectVersionsRequest { projectIdOrKey: string; expand?: string; } export interface GetProjectVersionsPaginatedRequest { projectIdOrKey: string; startAt?: number; maxResults?: number; orderBy?: string; query?: string; status?: string; expand?: string; } export interface GetVersionRequest { id: string; expand?: string; } export interface GetVersionRelatedIssuesRequest { id: string; } export interface GetVersionUnresolvedIssuesRequest { id: string; } export interface MergeVersionsRequest { id: string; moveIssuesTo: string; } export interface MoveVersionRequest { id: string; VersionMoveBean: VersionMoveBean; } export interface UpdateVersionRequest { id: string; Version: Version; } /** * no description */ export declare class ProjectVersionsApi extends runtime.BaseAPI { /** * Creates a project version. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) or *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project the version is added to. * Create version */ createVersionRaw(requestParameters: CreateVersionRequest): Promise>; /** * Creates a project version. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) or *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project the version is added to. * Create version */ createVersion(requestParameters: CreateVersionRequest): Promise; /** * Deletes a project version. Alternative versions can be provided to update issues that use the deleted version in `fixVersion`, `affectedVersion`, or any version picker custom fields. If alternatives are not provided, occurrences of `fixVersion`, `affectedVersion`, and any version picker custom field, that contain the deleted version, are cleared. Any replacement version must be in the same project as the version being deleted and cannot be the version being deleted. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) or *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that contains the version. * Delete and replace version */ deleteAndReplaceVersionRaw(requestParameters: DeleteAndReplaceVersionRequest): Promise>; /** * Deletes a project version. Alternative versions can be provided to update issues that use the deleted version in `fixVersion`, `affectedVersion`, or any version picker custom fields. If alternatives are not provided, occurrences of `fixVersion`, `affectedVersion`, and any version picker custom field, that contain the deleted version, are cleared. Any replacement version must be in the same project as the version being deleted and cannot be the version being deleted. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) or *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that contains the version. * Delete and replace version */ deleteAndReplaceVersion(requestParameters: DeleteAndReplaceVersionRequest): Promise; /** * Deletes a project version. Deprecated, use [ Delete and replace version](#api-rest-api-3-version-id-removeAndSwap-post) that supports swapping version values in custom fields, in addition to the swapping for `fixVersion` and `affectedVersion` provided in this resource. Alternative versions can be provided to update issues that use the deleted version in `fixVersion` or `affectedVersion`. If alternatives are not provided, occurrences of `fixVersion` and `affectedVersion` that contain the deleted version are cleared. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) or *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that contains the version. * Delete version */ deleteVersionRaw(requestParameters: DeleteVersionRequest): Promise>; /** * Deletes a project version. Deprecated, use [ Delete and replace version](#api-rest-api-3-version-id-removeAndSwap-post) that supports swapping version values in custom fields, in addition to the swapping for `fixVersion` and `affectedVersion` provided in this resource. Alternative versions can be provided to update issues that use the deleted version in `fixVersion` or `affectedVersion`. If alternatives are not provided, occurrences of `fixVersion` and `affectedVersion` that contain the deleted version are cleared. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) or *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that contains the version. * Delete version */ deleteVersion(requestParameters: DeleteVersionRequest): Promise; /** * Returns all versions in a project. The response is not paginated. Use [Get project versions paginated](#api-rest-api-3-project-projectIdOrKey-version-get) if you want to get the versions in a project 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 versions */ getProjectVersionsRaw(requestParameters: GetProjectVersionsRequest): Promise>>; /** * Returns all versions in a project. The response is not paginated. Use [Get project versions paginated](#api-rest-api-3-project-projectIdOrKey-version-get) if you want to get the versions in a project 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 versions */ getProjectVersions(requestParameters: GetProjectVersionsRequest): Promise>; /** * Returns a [paginated](#pagination) representation of all versions in a project. See the [Get project versions](#api-rest-api-3-project-projectIdOrKey-versions-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 versions paginated */ getProjectVersionsPaginatedRaw(requestParameters: GetProjectVersionsPaginatedRequest): Promise>; /** * Returns a [paginated](#pagination) representation of all versions in a project. See the [Get project versions](#api-rest-api-3-project-projectIdOrKey-versions-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 versions paginated */ getProjectVersionsPaginated(requestParameters: GetProjectVersionsPaginatedRequest): Promise; /** * Returns a project version. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project containing the version. * Get version */ getVersionRaw(requestParameters: GetVersionRequest): Promise>; /** * Returns a project version. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project containing the version. * Get version */ getVersion(requestParameters: GetVersionRequest): Promise; /** * Returns the following counts for a version: * Number of issues where the `fixVersion` is set to the version. * Number of issues where the `affectedVersion` is set to the version. * Number of issues where a version custom field is set to the version. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Browse projects* project permission for the project that contains the version. * Get version\'s related issues count */ getVersionRelatedIssuesRaw(requestParameters: GetVersionRelatedIssuesRequest): Promise>; /** * Returns the following counts for a version: * Number of issues where the `fixVersion` is set to the version. * Number of issues where the `affectedVersion` is set to the version. * Number of issues where a version custom field is set to the version. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Browse projects* project permission for the project that contains the version. * Get version\'s related issues count */ getVersionRelatedIssues(requestParameters: GetVersionRelatedIssuesRequest): Promise; /** * Returns counts of the issues and unresolved issues for the project version. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Browse projects* project permission for the project that contains the version. * Get version\'s unresolved issues count */ getVersionUnresolvedIssuesRaw(requestParameters: GetVersionUnresolvedIssuesRequest): Promise>; /** * Returns counts of the issues and unresolved issues for the project version. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Browse projects* project permission for the project that contains the version. * Get version\'s unresolved issues count */ getVersionUnresolvedIssues(requestParameters: GetVersionUnresolvedIssuesRequest): Promise; /** * Merges two project versions. The merge is completed by deleting the version specified in `id` and replacing any occurrences of its ID in `fixVersion` with the version ID specified in `moveIssuesTo`. Consider using [ Delete and replace version](#api-rest-api-3-version-id-removeAndSwap-post) instead. This resource supports swapping version values in `fixVersion`, `affectedVersion`, and custom fields. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) or *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that contains the version. * Merge versions */ mergeVersionsRaw(requestParameters: MergeVersionsRequest): Promise>; /** * Merges two project versions. The merge is completed by deleting the version specified in `id` and replacing any occurrences of its ID in `fixVersion` with the version ID specified in `moveIssuesTo`. Consider using [ Delete and replace version](#api-rest-api-3-version-id-removeAndSwap-post) instead. This resource supports swapping version values in `fixVersion`, `affectedVersion`, and custom fields. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) or *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that contains the version. * Merge versions */ mergeVersions(requestParameters: MergeVersionsRequest): Promise; /** * Modifies the version\'s sequence within the project, which affects the display order of the versions in Jira. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Browse projects* project permission for the project that contains the version. * Move version */ moveVersionRaw(requestParameters: MoveVersionRequest): Promise>; /** * Modifies the version\'s sequence within the project, which affects the display order of the versions in Jira. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Browse projects* project permission for the project that contains the version. * Move version */ moveVersion(requestParameters: MoveVersionRequest): Promise; /** * Updates a project version. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) or *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that contains the version. * Update version */ updateVersionRaw(requestParameters: UpdateVersionRequest): Promise>; /** * Updates a project version. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) or *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that contains the version. * Update version */ updateVersion(requestParameters: UpdateVersionRequest): Promise; }