package
2.0.0+incompatible
Repository: https://github.com/jinoarch/go-jira.git
Documentation: pkg.go.dev

# README

Jira: Cloud client

The API client library for cloud hosted Jira instances by Atlassian.

For further information, please switch to the README.md in the root folder.

# Packages

No description provided by the author

# Functions

Bool is a helper routine that allocates a new bool value to store v and returns a pointer to it.
CheckResponse checks the API response for errors, and returns them if present.
InitIssueWithMetaAndFields returns Issue with with values from fieldsConfig properly set.
NewClient returns a new Jira API client with provided base URL (often is your Jira hostname) If a nil httpClient is provided, a new http.Client will be used.
NewJiraError creates a new jira Error.
WithAccountId sets the account id to search.
WithActive sets the active users lookup.
WithInactive sets the inactive users lookup.
WithMaxResults sets the max results to return.
WithProperty sets the property (Property keys are specified by path) to search.
Applies query options to http request.
WithStartAt set the start pager.
WithUsername sets the username to search.

# Constants

AssigneeAutomatic represents the value of the "Assignee: Automatic" of Jira.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
These constants are the keys of the default Jira status categories.
These constants are the keys of the default Jira status categories.
These constants are the keys of the default Jira status categories.
These constants are the keys of the default Jira status categories.

# Structs

Actor represents a Jira actor.
ActorUser contains the account id of the actor/user.
No description provided by the author
ApplicationRole represents a role assigned to a user.
ApplicationRoles is a wrapper for ApplicationRole.
Attachment represents a Jira attachment.
AvatarUrls represents different dimensions of avatars / images.
BasicAuthTransport is an http.RoundTripper that authenticates all requests using HTTP Basic Authentication with the provided username and a Personal API Token.
Board represents a Jira agile board.
BoardConfiguration represents a boardConfiguration of a jira board.
BoardConfigurationColumn lists the name of the board with the statuses that maps to a particular column.
BoardConfigurationColumnConfig lists the columns for a given board in the order defined in the column configuration with constrainttype (none, issueCount, issueCountExclSubs).
BoardConfigurationColumnStatus represents a status in the column configuration.
BoardConfigurationFilter reference to the filter used by the given board.
BoardConfigurationLocation reference to the container that the board is located in.
BoardConfigurationSubQuery (Kanban only) - JQL subquery used by the given board.
BoardListOptions specifies the optional parameters to the BoardService.GetList.
BoardLocation represents the location of a Jira board.
BoardsList reflects a list of agile boards.
Changelog reflects the change log of an issue.
ChangelogHistory reflects one single changelog history entry.
ChangelogItems reflects one single changelog item of a history item.
A Client manages communication with the Jira API.
Comment represents a comment by a person to an issue in Jira.
Comments represents a list of Comment.
CommentVisibility represents he visibility of a comment.
Component represents a "component" of a Jira issue.
ComponentCreateOptions are passed to the ComponentService.Create function to create a new Jira component.
CreateMetaInfo contains information about fields and their attributed to create a ticket.
CreateTransitionPayload is used for creating new issue transitions.
Customer represents a ServiceDesk customer.
CustomerList is a page of customers.
CustomerListOptions is the query options for listing customers.
EditMetaInfo contains information about fields and their attributed to edit a ticket.
No description provided by the author
Epic represents the epic to which an issue is associated Not that this struct does not process the returned "color" value.
Error message from Jira See https://docs.atlassian.com/jira/REST/cloud/#error-responses.
Field represents a field of a Jira issue.
FieldSchema represents a schema of a Jira field.
Filter represents a Filter in Jira.
FilterSearchOptions specifies the optional parameters for the Search method https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-filter-search-get.
FiltersList reflects a list of filters.
FiltersListItem represents a Filter of FiltersList in Jira.
FixVersion represents a software release in which an issue is fixed.
GetAllSprintsOptions specifies the optional parameters to the BoardService.GetList.
GetMyFiltersQueryOptions specifies the optional parameters for the Get My Filters method.
GetQueryOptions specifies the optional parameters for the Get Issue methods.
GetWorklogsQueryOptions specifies the optional parameters for the Get Worklogs method.
Group represents a Jira group.
GroupMember reflects a single member of a group.
GroupMembers represent members in a Jira group.
GroupSearchOptions specifies the optional parameters for the Get Group methods.
No description provided by the author
Issue represents a Jira issue.
IssueFields represents single fields of a Jira issue.
IssueLink represents a link between two issues in Jira.
IssueLinkType represents a type of a link between to issues in Jira.
IssueRenderedFields represents rendered fields of a Jira issue.
IssuesInSprintResult represents a wrapper struct for search result.
IssuesWrapper represents a wrapper struct for moving issues to sprint.
IssueType represents a type of a Jira issue.
JWTAuthTransport is an http.RoundTripper that authenticates all requests using Jira's JWT based authentication.
MetaIssueType represents the different issue types a project has.
MetaProject is the meta information about a project returned from createmeta api.
Option represents an option value in a SelectList or MultiSelect custom issue field.
Organization contains Organization data.
OrganizationCreationDTO is DTO for creat organization API.
OrganizationUsersDTO contains organization user ids.
PagedDTO is response of a paged list.
Parent represents the parent of a Jira issue, to be used with subtask issue types.
Parent Fields.
No description provided by the author
PermissionScheme represents the permission scheme for the project.
No description provided by the author
Priority represents a priority of a Jira issue.
Progress represents the progress of a Jira issue.
Project represents a Jira Project.
ProjectCategory represents a single project category.
ProjectComponent represents a single component of a project.
PropertyKey contains Property key details.
PropertyKeys contains an array of PropertyKey.
RemoteLink represents remote links which linked to issues.
RemoteLinkApplication represents remote links application.
RemoteLinkIcon represents icon displayed next to link.
RemoteLinkObject represents remote link object itself.
RemoteLinkStatus if the link is a resolvable object (issue, epic) - the structure represent its status.
Request represents a ServiceDesk customer request.
RequestComment is a comment for a request.
RequestDate is the date format used in requests.
RequestFieldValue is a request field.
RequestStatus is the status for a request.
Resolution represents a resolution of a Jira issue.
Response represents Jira API response.
Role represents a Jira product role.
SearchOptions specifies the optional parameters to various List methods that support pagination.
SelfLink Stores REST API URL to the organization.
ServiceDeskOrganizationDTO is a DTO for ServiceDesk organizations.
Sprint represents a sprint on Jira agile board.
SprintsList reflects a list of agile sprints.
Status represents the current status of a Jira issue.
StatusCategory represents the category a status belongs to.
Subtasks represents all issues of a parent issue.
TimeTracking represents the timetracking fields of a Jira issue.
Transition represents an issue transition in Jira.
TransitionField represents the value of one Transition.
TransitionPayload represents the request payload of Transition calls like DoTransition.
TransitionPayloadComment represents comment in Transition payload.
TransitionPayloadCommentBody represents body of comment in payload.
TransitionPayloadFields represents the fields that can be set when executing a transition.
TransitionPayloadUpdate represents the updates of Transition calls like DoTransition.
UpdateQueryOptions specifies the optional parameters to the Edit issue.
User represents a Jira user.
UserGroup represents the group list.
Groups is a wrapper for UserGroup.
Version represents a single release version of a project.
Watcher represents a simplified user that "observes" the issue.
Watches represents a type of how many and which user are "observing" a Jira issue to track the status / updates.
Worklog represents the work log of a Jira issue.
WorklogRecord represents one entry of a Worklog.

# Type aliases

AffectsVersion represents a software release which is affected by an issue.
BoardService handles Agile Boards for the Jira instance / API.
ComponentService represents project components.
CustomerService handles ServiceDesk customers for the Jira instance / API.
CustomFields represents custom fields of Jira This can heavily differ between Jira instances.
Date represents the Date definition of Jira as a time.Time of go.
FieldService handles fields for the Jira instance / API.
FilterService handles fields for the Jira instance / API.
GroupService handles Groups for the Jira instance / API.
IssueLinkTypeService handles issue link types for the Jira instance / API.
IssueService handles Issues for the Jira instance / API.
OrganizationService handles Organizations for the Jira instance / API.
PermissionSchemeService handles permissionschemes for the Jira instance / API.
PriorityService handles priorities for the Jira instance / API.
ProjectList represent a list of Projects.
ProjectService handles projects for the Jira instance / API.
RequestService handles ServiceDesk customer requests for the Jira instance / API.
ResolutionService handles resolutions for the Jira instance / API.
RoleService handles roles for the Jira instance / API.
ServiceDeskService handles ServiceDesk for the Jira instance / API.
SprintService handles sprints in Jira Agile API.
StatusCategoryService handles status categories for the Jira instance / API.
StatusService handles staties for the Jira instance / API.
Time represents the Time definition of Jira as a time.Time of go.
UserService handles users for the Jira instance / API.
VersionService handles Versions for the Jira instance / API.