Class: LicenseRoleClient

LicenseRoleClient(jiraClient)

new LicenseRoleClient(jiraClient)

Used to access Jira REST endpoints in '/rest/api/2/licenserole'

Parameters:
Name Type Description
jiraClient JiraClient
Source:

Methods

editLicenseRole(opts, callbackopt) → {Promise}

Updates the license role with the passed data. Only the groups of the role may be updated. Requests to change the id or the name of the role will be silently ignored.

Parameters:
Name Type Attributes Description
opts

The request options sent to the Jira API.

Properties
Name Type Description
roleId

The id of the license role to retrieve.
role

The new data to place in the role. See https://docs.atlassian.com/jira/REST/latest/#d2e365
callback <optional>

Called when the license role is edited.
Source:
Returns:

Resolved when the license role is edited.

Type
Promise

getAllLicenseRoles(opts, callbackopt) → {Promise}

Returns all license roles in the system.

Parameters:
Name Type Attributes Description
opts

Ignored
callback <optional>

Called when the license roles have been retrieved.
Source:
Returns:

Resolved when the license roles have been retrieved.

Type
Promise

getLicenseRole(opts, callbackopt) → {Promise}

Gets the passed license role if it exists.

Parameters:
Name Type Attributes Description
opts

The request options sent to the Jira API.

Properties
Name Type Description
roleId

The id of the license role to retrieve.
callback <optional>

Called when the license role is retrieved.
Source:
Returns:

Resolved when the license role is retrieved.

Type
Promise