Class ProjectVersions

Index

Constructors

Properties

Methods

createVersion deleteAndReplaceVersion getProjectVersions getProjectVersionsPaginated getVersion getVersionRelatedIssues getVersionUnresolvedIssues mergeVersions moveVersion updateVersion

Constructors

constructor

new ProjectVersions(client): Version3.ProjectVersions
Parameters
- client: Client
Returns Version3.ProjectVersions
- Defined in src/version3/projectVersions.ts:8

Properties

`Private` client

client: Client

Methods

createVersion

createVersion<T>(parameters, callback): Promise<void>
Creates a project version.

This operation can be accessed anonymously.

Permissions required: Administer Jira global permission or Administer Projects project permission for the project the version is added to.
Type Parameters
- T = Version3.Version3Models.Version
Parameters
- parameters: Version3.Version3Parameters.CreateVersion
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/projectVersions.ts:114
createVersion<T>(parameters, callback?): Promise<T>
Creates a project version.

This operation can be accessed anonymously.

Permissions required: Administer Jira global permission or Administer Projects project permission for the project the version is added to.
Type Parameters
- T = Version3.Version3Models.Version
Parameters
- parameters: Version3.Version3Parameters.CreateVersion
- Optional callback: undefined
Returns Promise<T>
- Defined in src/version3/projectVersions.ts:124

deleteAndReplaceVersion

deleteAndReplaceVersion<T>(parameters, callback): Promise<void>
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 required: Administer Jira global permission or Administer Projects project permission for the project that contains the version.
Type Parameters
- T = void
Parameters
- parameters: Version3.Version3Parameters.DeleteAndReplaceVersion
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/projectVersions.ts:365
deleteAndReplaceVersion<T>(parameters, callback?): Promise<T>
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 required: Administer Jira global permission or Administer Projects project permission for the project that contains the version.
Type Parameters
- T = void
Parameters
- parameters: Version3.Version3Parameters.DeleteAndReplaceVersion
- Optional callback: undefined
Returns Promise<T>
- Defined in src/version3/projectVersions.ts:384

getProjectVersions

getProjectVersions<T>(parameters, callback): Promise<void>
Returns all versions in a project. The response is not paginated. Use Get project versions paginated if you want to get the versions in a project with pagination.

This operation can be accessed anonymously.

Permissions required: Browse Projects project permission for the project.
Type Parameters
- T = Version3.Version3Models.Version[]
Parameters
- parameters: string | Version3.Version3Parameters.GetProjectVersions
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/projectVersions.ts:70
getProjectVersions<T>(parameters, callback?): Promise<T>
Returns all versions in a project. The response is not paginated. Use Get project versions paginated if you want to get the versions in a project with pagination.

This operation can be accessed anonymously.

Permissions required: Browse Projects project permission for the project.
Type Parameters
- T = Version3.Version3Models.Version[]
Parameters
- parameters: string | Version3.Version3Parameters.GetProjectVersions
- Optional callback: undefined
Returns Promise<T>
- Defined in src/version3/projectVersions.ts:84

getProjectVersionsPaginated

getProjectVersionsPaginated<T>(parameters, callback): Promise<void>
Returns a paginated list of all versions in a project. See the Get project versions resource if you want to get a full list of versions without pagination.

This operation can be accessed anonymously.

Permissions required: Browse Projects project permission for the project.
Type Parameters
- T = Version3.Version3Models.PageVersion
Parameters
- parameters: string | Version3.Version3Parameters.GetProjectVersionsPaginated
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/projectVersions.ts:20
getProjectVersionsPaginated<T>(parameters, callback?): Promise<T>
Returns a paginated list of all versions in a project. See the Get project versions resource if you want to get a full list of versions without pagination.

This operation can be accessed anonymously.

Permissions required: Browse Projects project permission for the project.
Type Parameters
- T = Version3.Version3Models.PageVersion
Parameters
- parameters: string | Version3.Version3Parameters.GetProjectVersionsPaginated
- Optional callback: undefined
Returns Promise<T>
- Defined in src/version3/projectVersions.ts:34

getVersion

getVersion<T>(parameters, callback): Promise<void>
Returns a project version.

This operation can be accessed anonymously.

Permissions required: Browse projects project permission for the project containing the version.
Type Parameters
- T = Version3.Version3Models.Version
Parameters
- parameters: string | Version3.Version3Parameters.GetVersion
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/projectVersions.ts:163
getVersion<T>(parameters, callback?): Promise<T>
Returns a project version.

This operation can be accessed anonymously.

Permissions required: Browse projects project permission for the project containing the version.
Type Parameters
- T = Version3.Version3Models.Version
Parameters
- parameters: string | Version3.Version3Parameters.GetVersion
- Optional callback: undefined
Returns Promise<T>
- Defined in src/version3/projectVersions.ts:175

getVersionRelatedIssues

getVersionRelatedIssues<T>(parameters, callback): Promise<void>
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 required: Browse projects project permission for the project that contains the version.
Type Parameters
- T = Version3.Version3Models.VersionIssueCounts
Parameters
- parameters: string | Version3.Version3Parameters.GetVersionRelatedIssues
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/projectVersions.ts:316
getVersionRelatedIssues<T>(parameters, callback?): Promise<T>
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 required: Browse projects project permission for the project that contains the version.
Type Parameters
- T = Version3.Version3Models.VersionIssueCounts
Parameters
- parameters: string | Version3.Version3Parameters.GetVersionRelatedIssues
- Optional callback: undefined
Returns Promise<T>
- Defined in src/version3/projectVersions.ts:332

getVersionUnresolvedIssues

getVersionUnresolvedIssues<T>(parameters, callback): Promise<void>
Returns counts of the issues and unresolved issues for the project version.

This operation can be accessed anonymously.

Permissions required: Browse projects project permission for the project that contains the version.
Type Parameters
- T = Version3.Version3Models.VersionUnresolvedIssuesCount
Parameters
- parameters: string | Version3.Version3Parameters.GetVersionUnresolvedIssues
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/projectVersions.ts:410
getVersionUnresolvedIssues<T>(parameters, callback?): Promise<T>
Returns counts of the issues and unresolved issues for the project version.

This operation can be accessed anonymously.

Permissions required: Browse projects project permission for the project that contains the version.
Type Parameters
- T = Version3.Version3Models.VersionUnresolvedIssuesCount
Parameters
- parameters: string | Version3.Version3Parameters.GetVersionUnresolvedIssues
- Optional callback: undefined
Returns Promise<T>
- Defined in src/version3/projectVersions.ts:422

mergeVersions

mergeVersions<T>(parameters, callback): Promise<void>
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 instead. This resource supports swapping version values in fixVersion, affectedVersion, and custom fields.

This operation can be accessed anonymously.

Permissions required: Administer Jira global permission or Administer Projects project permission for the project that contains the version.
Type Parameters
- T = void
Parameters
- parameters: Version3.Version3Parameters.MergeVersions
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/projectVersions.ts:249
mergeVersions<T>(parameters, callback?): Promise<T>
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 instead. This resource supports swapping version values in fixVersion, affectedVersion, and custom fields.

This operation can be accessed anonymously.

Permissions required: Administer Jira global permission or Administer Projects project permission for the project that contains the version.
Type Parameters
- T = void
Parameters
- parameters: Version3.Version3Parameters.MergeVersions
- Optional callback: undefined
Returns Promise<T>
- Defined in src/version3/projectVersions.ts:263

moveVersion

moveVersion<T>(parameters, callback): Promise<void>
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 required: Browse projects project permission for the project that contains the version.
Type Parameters
- T = Version3.Version3Models.Version
Parameters
- parameters: Version3.Version3Parameters.MoveVersion
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/projectVersions.ts:281
moveVersion<T>(parameters, callback?): Promise<T>
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 required: Browse projects project permission for the project that contains the version.
Type Parameters
- T = Version3.Version3Models.Version
Parameters
- parameters: Version3.Version3Parameters.MoveVersion
- Optional callback: undefined
Returns Promise<T>
- Defined in src/version3/projectVersions.ts:290

updateVersion

updateVersion<T>(parameters, callback): Promise<void>
Updates a project version.

This operation can be accessed anonymously.

Permissions required: Administer Jira global permission or Administer Projects project permission for the project that contains the version.
Type Parameters
- T = Version3.Version3Models.Version
Parameters
- parameters: Version3.Version3Parameters.UpdateVersion
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/projectVersions.ts:202
updateVersion<T>(parameters, callback?): Promise<T>
Updates a project version.

This operation can be accessed anonymously.

Permissions required: Administer Jira global permission or Administer Projects project permission for the project that contains the version.
Type Parameters
- T = Version3.Version3Models.Version
Parameters
- parameters: Version3.Version3Parameters.UpdateVersion
- Optional callback: undefined
Returns Promise<T>
- Defined in src/version3/projectVersions.ts:212

Class ProjectVersions

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Version3.ProjectVersions

Properties

Private client

Methods

createVersion

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

deleteAndReplaceVersion

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getProjectVersions

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getProjectVersionsPaginated

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getVersion

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getVersionRelatedIssues

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getVersionUnresolvedIssues

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

mergeVersions

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

moveVersion

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

updateVersion

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

`Private` client