Class Plans

Index

Constructors

constructor

Methods

archivePlan createPlan duplicatePlan getPlan getPlans trashPlan updatePlan

Constructors

constructor

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

Methods

archivePlan

archivePlan<T = void>(
parameters: Version3Parameters.ArchivePlan,
callback: Callback<T>,
): Promise<void>
Archives a plan.

Permissions required: Administer Jira global permission.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.ArchivePlan
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/plans.ts:158
archivePlan<T = void>(
parameters: Version3Parameters.ArchivePlan,
callback?: undefined,
): Promise<T>
Archives a plan.

Permissions required: Administer Jira global permission.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.ArchivePlan
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/plans.ts:165

createPlan

createPlan<T = unknown>(
parameters: Version3Parameters.CreatePlan,
callback: Callback<T>,
): Promise<void>
Creates a plan.

Permissions required: Administer Jira global permission.
Type Parameters
- T = unknown
Parameters
- parameters: Version3Parameters.CreatePlan
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/plans.ts:54
createPlan<T = unknown>(
parameters: Version3Parameters.CreatePlan,
callback?: undefined,
): Promise<T>
Creates a plan.

Permissions required: Administer Jira global permission.
Type Parameters
- T = unknown
Parameters
- parameters: Version3Parameters.CreatePlan
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/plans.ts:61

duplicatePlan

duplicatePlan<T = unknown>(
parameters: Version3Parameters.DuplicatePlan,
callback: Callback<T>,
): Promise<void>
Duplicates a plan.

Permissions required: Administer Jira global permission.
Type Parameters
- T = unknown
Parameters
- parameters: Version3Parameters.DuplicatePlan
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/plans.ts:181
duplicatePlan<T = unknown>(
parameters: Version3Parameters.DuplicatePlan,
callback?: undefined,
): Promise<T>
Duplicates a plan.

Permissions required: Administer Jira global permission.
Type Parameters
- T = unknown
Parameters
- parameters: Version3Parameters.DuplicatePlan
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/plans.ts:188

getPlan

getPlan<T = Version3Models.Plan>(
parameters: Version3Parameters.GetPlan,
callback: Callback<T>,
): Promise<void>
Returns a plan.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.Plan
Parameters
- parameters: Version3Parameters.GetPlan
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/plans.ts:90
getPlan<T = Version3Models.Plan>(
parameters: Version3Parameters.GetPlan,
callback?: undefined,
): Promise<T>
Returns a plan.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.Plan
Parameters
- parameters: Version3Parameters.GetPlan
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/plans.ts:97

getPlans

getPlans<T = Version3Models.PageWithCursorGetPlanResponseForPage>(
parameters: undefined | Version3Parameters.GetPlans,
callback: Callback<T>,
): Promise<void>
Returns a paginated list of plans.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.PageWithCursorGetPlanResponseForPage
Parameters
- parameters: undefined | Version3Parameters.GetPlans
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/plans.ts:16
getPlans<T = Version3Models.PageWithCursorGetPlanResponseForPage>(
parameters?: Version3Parameters.GetPlans,
callback?: undefined,
): Promise<T>
Returns a paginated list of plans.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.PageWithCursorGetPlanResponseForPage
Parameters
- Optionalparameters: Version3Parameters.GetPlans
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/plans.ts:26

trashPlan

trashPlan<T = void>(
parameters: Version3Parameters.TrashPlan,
callback: Callback<T>,
): Promise<void>
Moves a plan to trash.

Permissions required: Administer Jira global permission.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.TrashPlan
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/plans.ts:207
trashPlan<T = void>(
parameters: Version3Parameters.TrashPlan,
callback?: undefined,
): Promise<T>
Moves a plan to trash.

Permissions required: Administer Jira global permission.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.TrashPlan
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/plans.ts:214

updatePlan

updatePlan<T = void>(
parameters: Version3Parameters.UpdatePlan,
callback: Callback<T>,
): Promise<void>
Updates any of the following details of a plan using JSON Patch.

Permissions required: Administer Jira global permission.

Note that "add" operations do not respect array indexes in target locations. Call the "Get plan" endpoint to find out the order of array elements.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.UpdatePlan
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/plans.ts:119
updatePlan<T = void>(
parameters: Version3Parameters.UpdatePlan,
callback?: undefined,
): Promise<T>
Updates any of the following details of a plan using JSON Patch.

Permissions required: Administer Jira global permission.

Note that "add" operations do not respect array indexes in target locations. Call the "Get plan" endpoint to find out the order of array elements.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.UpdatePlan
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/plans.ts:129

Class Plans

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Version3.Plans

Methods

archivePlan

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

createPlan

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

duplicatePlan

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getPlan

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getPlans

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

trashPlan

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

updatePlan

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

Settings

On This Page