Jira

@shelson/jirav2026.08.21.1· 2d agoMODELS

01README

Jira Cloud platform models

02Release Notes

Added: component, dashboard, field_scheme, filter, issue, issue_link, issue_link_type, issue_type, permission_scheme, plan, priority, project, project_category, resolution, role, version, workflow_scheme
Added: transitionByName/fetchByKey convenience methods on issue (issue_transitions.ts)

03Models17

@shelson/jira/componentv2026.08.21.1component.ts

Global Arguments

Argument	Type	Required	Description
assigneeType?	enum	no	The nominal user type used to determine the assignee for issues created with this component. See `realAssigneeType` for details on how the type of the user, and hence the user, assigned to issues is determined. Can take the following values:\n\n * `PROJECT_LEAD` the assignee to any issues created with this component is nominally the lead for the project the component is in.\n * `COMPONENT_LEAD` the assignee to any issues created with this component is nominally the lead for the component.\n *
description?	string	no	The description for the component. Optional when creating or updating a component.
leadAccountId?	string	no	The accountId of the component's lead user. The accountId uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
leadUserName?	string	no	This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.
name?	string	no	The unique name for the component in the project. Required when creating a component. Optional when updating a component. The maximum length is 255 characters.
project?	string	no	The key of the project the component is assigned to. Required when creating a component. Can't be updated.
site?	string	no	Jira Cloud site hostname (e.g. acme.atlassian.net); overrides the JIRA_SITE environment variable
email?	string	no	Atlassian account email for API authentication; overrides the JIRA_EMAIL environment variable
token?	string	no	Jira API token; overrides the JIRA_API_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.

fn create()

Create a component

fn get(id: union)

Get a component

Argument	Type	Required	Description
id	union	yes	The ID of the component

fn update()

Update component attributes

fn delete(id: union)

Delete the component

Argument	Type	Required	Description
id	union	yes	The ID of the component

fn sync()

Sync component state from Jira

Resources

state(infinite)— Component resource state

@shelson/jira/dashboardv2026.08.21.1dashboard.ts

Global Arguments

Argument	Type	Required	Description
description?	string	no	The description of the dashboard.
editPermissions	array	yes	The edit permissions for the dashboard.
name	string	yes	The name of the dashboard.
sharePermissions	array	yes	The share permissions for the dashboard.
site?	string	no	Jira Cloud site hostname (e.g. acme.atlassian.net); overrides the JIRA_SITE environment variable
email?	string	no	Atlassian account email for API authentication; overrides the JIRA_EMAIL environment variable
token?	string	no	Jira API token; overrides the JIRA_API_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.

fn create()

Create a dashboard

fn get(id: union)

Get a dashboard

Argument	Type	Required	Description
id	union	yes	The ID of the dashboard

fn update()

Update dashboard attributes

fn delete(id: union)

Delete the dashboard

Argument	Type	Required	Description
id	union	yes	The ID of the dashboard

fn sync()

Sync dashboard state from Jira

Resources

state(infinite)— Dashboard resource state

@shelson/jira/field-schemev2026.08.21.1field_scheme.ts

Global Arguments

Argument	Type	Required	Description
description?	string	no	Description of the scheme to be created
name	string	yes	The name of the scheme to be created
site?	string	no	Jira Cloud site hostname (e.g. acme.atlassian.net); overrides the JIRA_SITE environment variable
email?	string	no	Atlassian account email for API authentication; overrides the JIRA_EMAIL environment variable
token?	string	no	Jira API token; overrides the JIRA_API_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.

fn create()

Create a field scheme

fn get(id: union)

Get a field scheme

Argument	Type	Required	Description
id	union	yes	The ID of the field scheme

fn update()

Update field scheme attributes

fn delete(id: union)

Delete the field scheme

Argument	Type	Required	Description
id	union	yes	The ID of the field scheme

fn sync()

Sync field scheme state from Jira

Resources

state(infinite)— Field Scheme resource state

@shelson/jira/filterv2026.08.21.1filter.ts

Global Arguments

Argument	Type	Required	Description
description?	string	no	A description of the filter.
editPermissions?	array	no	The groups and projects that can edit the filter.
favourite?	boolean	no	Whether the filter is selected as a favorite.
jql?	string	no	The JQL query for the filter. For example, project = SSP AND issuetype = Bug.
name	string	yes	The name of the filter. Must be unique.
sharePermissions?	array	no	The groups and projects that the filter is shared with.
site?	string	no	Jira Cloud site hostname (e.g. acme.atlassian.net); overrides the JIRA_SITE environment variable
email?	string	no	Atlassian account email for API authentication; overrides the JIRA_EMAIL environment variable
token?	string	no	Jira API token; overrides the JIRA_API_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.

fn create()

Create a filter

fn get(id: union)

Get a filter

Argument	Type	Required	Description
id	union	yes	The ID of the filter

fn update()

Update filter attributes

fn delete(id: union)

Delete the filter

Argument	Type	Required	Description
id	union	yes	The ID of the filter

fn sync()

Sync filter state from Jira

Resources

state(infinite)— Filter resource state

@shelson/jira/issuev2026.08.21.1issue.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
fields?	record	no	List of issue screen fields to update, specifying the sub-field to update and its value for each field. This field provides a straightforward option when setting a sub-field. When multiple sub-fields or other operations are required, use `update`. Fields included in here cannot be included in `update`.
historyMetadata?	object	no	Additional issue history details.
properties?	array	no	Details of issue properties to be add or update.
transition?	object	no	Details of a transition. Required when performing a transition, optional when creating or editing an issue.
update?	record	no	A Map containing the field field name and a list of operations to perform on the issue screen field. Note that fields included in here cannot be included in `fields`.
site?	string	no	Jira Cloud site hostname (e.g. acme.atlassian.net); overrides the JIRA_SITE environment variable
email?	string	no	Atlassian account email for API authentication; overrides the JIRA_EMAIL environment variable
token?	string	no	Jira API token; overrides the JIRA_API_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.

fn create()

Create a issue

fn get(idOrKey: string)

Get a issue

Argument	Type	Required	Description
idOrKey	string	yes	The ID or key of the issue

fn update()

Update issue attributes

fn delete(idOrKey: string)

Delete the issue

Argument	Type	Required	Description
idOrKey	string	yes	The ID or key of the issue

fn sync()

Sync issue state from Jira

Resources

state(infinite)— Issue resource state

@shelson/jira/issue-linkv2026.08.21.1issue_link.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
comment?	object	no	A comment.
inwardIssue	object	yes	The ID or key of a linked issue.
outwardIssue	object	yes	The ID or key of a linked issue.
type	object	yes	This object is used as follows:\n\n * In the [ issueLink](#api-rest-api-3-issueLink-post) resource it defines and reports on the type of link between the issues. Find a list of issue link types with [Get issue link types](#api-rest-api-3-issueLinkType-get).\n * In the [ issueLinkType](#api-rest-api-3-issueLinkType-post) resource it defines and reports on issue link types.
site?	string	no	Jira Cloud site hostname (e.g. acme.atlassian.net); overrides the JIRA_SITE environment variable
email?	string	no	Atlassian account email for API authentication; overrides the JIRA_EMAIL environment variable
token?	string	no	Jira API token; overrides the JIRA_API_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.

fn create()

Create a issue link

fn get(id: union)

Get a issue link

Argument	Type	Required	Description
id	union	yes	The ID of the issue link

fn delete(id?: union)

Delete the issue link

Argument	Type	Required	Description
id?	union	no	The ID of the issue link (resolved from inwardIssue/outwardIssue when omitted)

fn sync()

Sync issue link state from Jira

Resources

state(infinite)— Issue Link resource state

@shelson/jira/issue-link-typev2026.08.21.1issue_link_type.ts

Global Arguments

Argument	Type	Required	Description
id?	string	no	The ID of the issue link type and is used as follows:\n\n * In the [ issueLink](#api-rest-api-3-issueLink-post) resource it is the type of issue link. Required on create when `name` isn't provided. Otherwise, read only.\n * In the [ issueLinkType](#api-rest-api-3-issueLinkType-post) resource it is read only.
inward?	string	no	The description of the issue link type inward link and is used as follows:\n\n * In the [ issueLink](#api-rest-api-3-issueLink-post) resource it is read only.\n * In the [ issueLinkType](#api-rest-api-3-issueLinkType-post) resource it is required on create and optional on update. Otherwise, read only.
name?	string	no	The name of the issue link type and is used as follows:\n\n * In the [ issueLink](#api-rest-api-3-issueLink-post) resource it is the type of issue link. Required on create when `id` isn't provided. Otherwise, read only.\n * In the [ issueLinkType](#api-rest-api-3-issueLinkType-post) resource it is required on create and optional on update. Otherwise, read only.
outward?	string	no	The description of the issue link type outward link and is used as follows:\n\n * In the [ issueLink](#api-rest-api-3-issueLink-post) resource it is read only.\n * In the [ issueLinkType](#api-rest-api-3-issueLinkType-post) resource it is required on create and optional on update. Otherwise, read only.
site?	string	no	Jira Cloud site hostname (e.g. acme.atlassian.net); overrides the JIRA_SITE environment variable
email?	string	no	Atlassian account email for API authentication; overrides the JIRA_EMAIL environment variable
token?	string	no	Jira API token; overrides the JIRA_API_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.

fn create()

Create a issue link type

fn get(id: union)

Get a issue link type

Argument	Type	Required	Description
id	union	yes	The ID of the issue link type

fn update()

Update issue link type attributes

fn delete(id: union)

Delete the issue link type

Argument	Type	Required	Description
id	union	yes	The ID of the issue link type

fn sync()

Sync issue link type state from Jira

Resources

state(infinite)— Issue Link Type resource state

@shelson/jira/issue-typev2026.08.21.1issue_type.ts

Global Arguments

Argument	Type	Required	Description
avatarId?	number	no	The ID of an issue type avatar. This can be obtained be obtained from the following endpoints:\n\n * [System issue type avatar IDs only](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-avatars/#api-rest-api-3-avatar-type-system-get)\n * [System and custom issue type avatar IDs](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-avatars/#api-rest-api-3-universal-avatar-type-type-owner-entityid-get)
description?	string	no	The description of the issue type.
name	string	yes	The unique name for the issue type. The maximum length is 60 characters.
hierarchyLevel?	number	no	The hierarchy level of the issue type. Use:\n\n * `-1` for Subtask.\n * `0` for Base.\n\nDefaults to `0`.
type?	enum	no	Deprecated. Use `hierarchyLevel` instead. See the [deprecation notice](https://community.developer.atlassian.com/t/deprecation-of-the-epic-link-parent-link-and-other-related-fields-in-rest-apis-and-webhooks/54048) for details.\n\nWhether the issue type is `subtype` or `standard`. Defaults to `standard`.
site?	string	no	Jira Cloud site hostname (e.g. acme.atlassian.net); overrides the JIRA_SITE environment variable
email?	string	no	Atlassian account email for API authentication; overrides the JIRA_EMAIL environment variable
token?	string	no	Jira API token; overrides the JIRA_API_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.

fn create()

Create a issue type

fn get(id: union)

Get a issue type

Argument	Type	Required	Description
id	union	yes	The ID of the issue type

fn update()

Update issue type attributes

fn delete(id: union)

Delete the issue type

Argument	Type	Required	Description
id	union	yes	The ID of the issue type

fn sync()

Sync issue type state from Jira

Resources

state(infinite)— Issue Type resource state

@shelson/jira/permission-schemev2026.08.21.1permission_scheme.ts

Global Arguments

Argument	Type	Required	Description
description?	string	no	A description for the permission scheme.
name	string	yes	The name of the permission scheme. Must be unique.
permissions?	array	no	The permission scheme to create or update. See [About permission schemes and grants](../api-group-permission-schemes/#about-permission-schemes-and-grants) for more information.
scope?	object	no	The scope of the permission scheme.
site?	string	no	Jira Cloud site hostname (e.g. acme.atlassian.net); overrides the JIRA_SITE environment variable
email?	string	no	Atlassian account email for API authentication; overrides the JIRA_EMAIL environment variable
token?	string	no	Jira API token; overrides the JIRA_API_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.

fn create()

Create a permission scheme

fn get(id: union)

Get a permission scheme

Argument	Type	Required	Description
id	union	yes	The ID of the permission scheme

fn update()

Update permission scheme attributes

fn delete(id: union)

Delete the permission scheme

Argument	Type	Required	Description
id	union	yes	The ID of the permission scheme

fn sync()

Sync permission scheme state from Jira

Resources

state(infinite)— Permission Scheme resource state

@shelson/jira/planv2026.08.21.1plan.ts

Global Arguments

Argument	Type	Required	Description
crossProjectReleases?	array	no	The cross-project releases to include in the plan.
customFields?	array	no	The custom fields for the plan.
exclusionRules?	object	no	The exclusion rules for the plan.
issueSources	array	yes	The issue sources to include in the plan.
leadAccountId?	string	no	The account ID of the plan lead.
name	string	yes	The plan name.
permissions?	array	no	The permissions for the plan.
scheduling	object	yes	The scheduling settings for the plan.
site?	string	no	Jira Cloud site hostname (e.g. acme.atlassian.net); overrides the JIRA_SITE environment variable
email?	string	no	Atlassian account email for API authentication; overrides the JIRA_EMAIL environment variable
token?	string	no	Jira API token; overrides the JIRA_API_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.

fn create()

Create a plan

fn get(id: union)

Get a plan

Argument	Type	Required	Description
id	union	yes	The ID of the plan

fn update()

Update plan attributes

fn sync()

Sync plan state from Jira

Resources

state(infinite)— Plan resource state

@shelson/jira/priorityv2026.08.21.1priority.ts

Global Arguments

Argument	Type	Required	Description
avatarId?	number	no	The ID for the avatar for the priority. Either the iconUrl or avatarId must be defined, but not both. This parameter is nullable and will become mandatory once the iconUrl parameter is deprecated.
description?	string	no	The description of the priority.
iconUrl?	enum	no	The URL of an icon for the priority. Accepted protocols are HTTP and HTTPS. Built in icons can also be used. Either the iconUrl or avatarId must be defined, but not both.
name	string	yes	The name of the priority. Must be unique.
statusColor	string	yes	The status color of the priority in 3-digit or 6-digit hexadecimal format.
site?	string	no	Jira Cloud site hostname (e.g. acme.atlassian.net); overrides the JIRA_SITE environment variable
email?	string	no	Atlassian account email for API authentication; overrides the JIRA_EMAIL environment variable
token?	string	no	Jira API token; overrides the JIRA_API_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.

fn create()

Create a priority

fn get(id: union)

Get a priority

Argument	Type	Required	Description
id	union	yes	The ID of the priority

fn update()

Update priority attributes

fn delete(id: union)

Delete the priority

Argument	Type	Required	Description
id	union	yes	The ID of the priority

fn sync()

Sync priority state from Jira

Resources

state(infinite)— Priority resource state

@shelson/jira/projectv2026.08.21.1project.ts

Global Arguments

Argument	Type	Required	Description
assigneeType?	enum	no	The default assignee when creating issues for this project.
avatarId?	number	no	An integer value for the project's avatar.
categoryId?	number	no	The ID of the project's category. A complete list of category IDs is found using the [Get all project categories](#api-rest-api-3-projectCategory-get) operation.
description?	string	no	A brief description of the project.
issueSecurityScheme?	number	no	The ID of the issue security scheme for the project, which enables you to control who can and cannot view issues. Use the [Get issue security schemes](#api-rest-api-3-issuesecurityschemes-get) resource to get all issue security scheme IDs.
key	string	yes	Project keys must be unique and start with an uppercase letter followed by one or more uppercase alphanumeric characters. The maximum length is 10 characters.
lead?	string	no	This parameter is deprecated because of privacy changes. Use `leadAccountId` instead. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. The user name of the project lead. Either `lead` or `leadAccountId` must be set when creating a project. Cannot be provided with `leadAccountId`.
leadAccountId?	string	no	The account ID of the project lead. Either `lead` or `leadAccountId` must be set when creating a project. Cannot be provided with `lead`.
name	string	yes	The name of the project.
notificationScheme?	number	no	The ID of the notification scheme for the project. Use the [Get notification schemes](#api-rest-api-3-notificationscheme-get) resource to get a list of notification scheme IDs.
permissionScheme?	number	no	The ID of the permission scheme for the project. Use the [Get all permission schemes](#api-rest-api-3-permissionscheme-get) resource to see a list of all permission scheme IDs.
releasedProjectKeys?	array	no	Previous project keys to be released from the current project. Released keys must belong to the current project and not contain the current project key
url?	string	no	A link to information about this project, such as project documentation
fieldConfigurationScheme?	number	no	Deprecated use [fieldScheme](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-field-schemes/#api-group-field-schemes) instead. The ID of the field configuration scheme for the project. Use the [Get all field configuration schemes](#api-rest-api-3-fieldconfigurationscheme-get) operation to get a list of field configuration scheme IDs. If you specify the field configuration scheme you cannot specify the project template key.
fieldScheme?	number	no	The ID of the field scheme for the project. Use the [Get field schemes](#api-rest-api-3-config-fieldschemes-get) operation to get a list of field scheme IDs. If you specify the field scheme you cannot specify the project template key.
issueTypeScheme?	number	no	The ID of the issue type scheme for the project. Use the [Get all issue type schemes](#api-rest-api-3-issuetypescheme-get) operation to get a list of issue type scheme IDs. If you specify the issue type scheme you cannot specify the project template key.
issueTypeScreenScheme?	number	no	The ID of the issue type screen scheme for the project. Use the [Get all issue type screen schemes](#api-rest-api-3-issuetypescreenscheme-get) operation to get a list of issue type screen scheme IDs. If you specify the issue type screen scheme you cannot specify the project template key.
projectTemplateKey?	enum	no	A predefined configuration for a project. The type of the `projectTemplateKey` must match with the type of the `projectTypeKey`.
projectTypeKey?	enum	no	The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes), which defines the application-specific feature set. If you don't specify the project template you have to specify the project type.
workflowScheme?	number	no	The ID of the workflow scheme for the project. Use the [Get all workflow schemes](#api-rest-api-3-workflowscheme-get) operation to get a list of workflow scheme IDs. If you specify the workflow scheme you cannot specify the project template key.
site?	string	no	Jira Cloud site hostname (e.g. acme.atlassian.net); overrides the JIRA_SITE environment variable
email?	string	no	Atlassian account email for API authentication; overrides the JIRA_EMAIL environment variable
token?	string	no	Jira API token; overrides the JIRA_API_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.

fn create()

Create a project

fn get(idOrKey: string)

Get a project

Argument	Type	Required	Description
idOrKey	string	yes	The ID or key of the project

fn update()

Update project attributes

fn delete(idOrKey: string)

Delete the project

Argument	Type	Required	Description
idOrKey	string	yes	The ID or key of the project

fn sync()

Sync project state from Jira

Resources

state(infinite)— Project resource state

@shelson/jira/project-categoryv2026.08.21.1project_category.ts

Global Arguments

Argument	Type	Required	Description
description?	string	no	The description of the project category.
name?	string	no	The name of the project category. Required on create, optional on update.
site?	string	no	Jira Cloud site hostname (e.g. acme.atlassian.net); overrides the JIRA_SITE environment variable
email?	string	no	Atlassian account email for API authentication; overrides the JIRA_EMAIL environment variable
token?	string	no	Jira API token; overrides the JIRA_API_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.

fn create()

Create a project category

fn get(id: union)

Get a project category

Argument	Type	Required	Description
id	union	yes	The ID of the project category

fn update()

Update project category attributes

fn delete(id: union)

Delete the project category

Argument	Type	Required	Description
id	union	yes	The ID of the project category

fn sync()

Sync project category state from Jira

Resources

state(infinite)— Project Category resource state

@shelson/jira/resolutionv2026.08.21.1resolution.ts

Global Arguments

Argument	Type	Required	Description
description?	string	no	The description of the resolution.
name	string	yes	The name of the resolution. Must be unique (case-insensitive).
site?	string	no	Jira Cloud site hostname (e.g. acme.atlassian.net); overrides the JIRA_SITE environment variable
email?	string	no	Atlassian account email for API authentication; overrides the JIRA_EMAIL environment variable
token?	string	no	Jira API token; overrides the JIRA_API_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.

fn create()

Create a resolution

fn get(id: union)

Get a resolution

Argument	Type	Required	Description
id	union	yes	The ID of the resolution

fn update()

Update resolution attributes

fn delete(id: union, replaceWith?: union)

Delete the resolution

Argument	Type	Required	Description
id	union	yes	The ID of the resolution
replaceWith?	union	no	ID of the resolution to move issues to (required when the resolution is in use)

fn sync()

Sync resolution state from Jira

Resources

state(infinite)— Resolution resource state

@shelson/jira/rolev2026.08.21.1role.ts

Global Arguments

Argument	Type	Required	Description
description?	string	no	A description of the project role. Required when fully updating a project role. Optional when creating or partially updating a project role.
name?	string	no	The name of the project role. Must be unique. Cannot begin or end with whitespace. The maximum length is 255 characters. Required when creating a project role. Optional when partially updating a project role.
site?	string	no	Jira Cloud site hostname (e.g. acme.atlassian.net); overrides the JIRA_SITE environment variable
email?	string	no	Atlassian account email for API authentication; overrides the JIRA_EMAIL environment variable
token?	string	no	Jira API token; overrides the JIRA_API_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.

fn create()

Create a role

fn get(id: union)

Get a role

Argument	Type	Required	Description
id	union	yes	The ID of the role

fn update()

Update role attributes

fn delete(id: union)

Delete the role

Argument	Type	Required	Description
id	union	yes	The ID of the role

fn sync()

Sync role state from Jira

Resources

state(infinite)— Role resource state

@shelson/jira/versionv2026.08.21.1version.ts

Global Arguments

Argument	Type	Required	Description
archived?	boolean	no	Indicates that the version is archived. Optional when creating or updating a version.
description?	string	no	The description of the version. Optional when creating or updating a version. The maximum size is 16,384 bytes.
driver?	string	no	The Atlassian account ID of the version driver. Optional when creating or updating a version. If the expand option `driver` is used, returns the Atlassian account ID of the driver.
expand?	string	no	Use [expand](em>#expansion) to include additional information about version in the response. This parameter accepts a comma-separated list. Expand options include:\n\n * `operations` Returns the list of operations available for this version.\n * `issuesstatus` Returns the count of issues in this version for each of the status categories to do, in progress, done, and unmapped. The unmapped property contains a count of issues with a status other than to do, in progress, and done.
moveUnfixedIssuesTo?	string	no	The URL of the self link to the version to which all unfixed issues are moved when a version is released. Not applicable when creating a version. Optional when updating a version.
name?	string	no	The unique name of the version. Required when creating a version. Optional when updating a version. The maximum length is 255 characters.
project?	string	no	Deprecated. Use `projectId`.
projectId?	number	no	The ID of the project to which this version is attached. Required when creating a version. Not applicable when updating a version.
releaseDate?	string	no	The release date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version.
released?	boolean	no	Indicates that the version is released. If the version is released a request to release again is ignored. Not applicable when creating a version. Optional when updating a version.
startDate?	string	no	The start date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version.
site?	string	no	Jira Cloud site hostname (e.g. acme.atlassian.net); overrides the JIRA_SITE environment variable
email?	string	no	Atlassian account email for API authentication; overrides the JIRA_EMAIL environment variable
token?	string	no	Jira API token; overrides the JIRA_API_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.

fn create()

Create a version

fn get(id: union)

Get a version

Argument	Type	Required	Description
id	union	yes	The ID of the version

fn update()

Update version attributes

fn delete(id: union)

Delete the version

Argument	Type	Required	Description
id	union	yes	The ID of the version

fn sync()

Sync version state from Jira

Resources

state(infinite)— Version resource state

@shelson/jira/workflow-schemev2026.08.21.1workflow_scheme.ts

Global Arguments

Argument	Type	Required	Description
defaultWorkflow?	string	no	The name of the default workflow for the workflow scheme. The default workflow has All Unassigned Issue Types assigned to it in Jira. If `defaultWorkflow` is not specified when creating a workflow scheme, it is set to Jira Workflow (jira).
description?	string	no	The description of the workflow scheme.
issueTypeMappings?	record	no	The issue type to workflow mappings, where each mapping is an issue type ID and workflow name pair. Note that an issue type can only be mapped to one workflow in a workflow scheme.
name?	string	no	The name of the workflow scheme. The name must be unique. The maximum length is 255 characters. Required when creating a workflow scheme.
updateDraftIfNeeded?	boolean	no	Whether to create or update a draft workflow scheme when updating an active workflow scheme. An active workflow scheme is a workflow scheme that is used by at least one project. The following examples show how this property works:\n\n * Update an active workflow scheme with `updateDraftIfNeeded` set to `true`: If a draft workflow scheme exists, it is updated. Otherwise, a draft workflow scheme is created.\n * Update an active workflow scheme with `updateDraftIfNeeded` set to `false`: An error
site?	string	no	Jira Cloud site hostname (e.g. acme.atlassian.net); overrides the JIRA_SITE environment variable
email?	string	no	Atlassian account email for API authentication; overrides the JIRA_EMAIL environment variable
token?	string	no	Jira API token; overrides the JIRA_API_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.

fn create()

Create a workflow scheme

fn get(id: union)

Get a workflow scheme

Argument	Type	Required	Description
id	union	yes	The ID of the workflow scheme

fn update()

Update workflow scheme attributes

fn delete(id: union)

Delete the workflow scheme

Argument	Type	Required	Description
id	union	yes	The ID of the workflow scheme

fn sync()

Sync workflow scheme state from Jira

Resources

state(infinite)— Workflow Scheme resource state

04Stats

100 / 100

Downloads

Archive size

128.0 KB

Has README or module doc2/2earned
README has a code example1/1earned
README is substantive1/1earned
Most symbols documented1/1earned
No slow types (deprecated)1/1earned
Dependencies pass trust audit2/2earned
Has description1/1earned
Platform support declared (or universal)2/2earned
License declared1/1earned
Verified public repository2/2earned

Repository

https://github.com/shelson/swamp-extensions

05Platforms

linux · x86_64 linux · aarch64 macOS · x86_64 macOS · aarch64

06Labels

#jira #atlassian #project-management