internal

package
v1.6.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 24, 2024 License: MIT Imports: 17 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewAuthenticationService 

func NewAuthenticationService(client service.Connector) common.Authentication

NewAuthenticationService creates a new instance of AuthenticationService. It takes a service.Connector as input and returns a common.Authentication interface.

func NewCommentService 

func NewCommentService(client service.Connector, version string) (*CommentADFService, *CommentRichTextService, error)

NewCommentService creates a new instance of CommentADFService and CommentRichTextService. It takes a service.Connector and a version string as input. Returns pointers to CommentADFService and CommentRichTextService, and an error if the version is not provided.

func NewIssueService 

func NewIssueService(client service.Connector, version string, services *IssueServices) (*IssueRichTextService, *IssueADFService, error)

NewIssueService creates new instances of IssueRichTextService and IssueADFService. It takes a service.Connector, a version string, and an optional IssueServices struct as input. Returns pointers to IssueRichTextService and IssueADFService, and an error if the version is not provided.

func NewLinkService 

func NewLinkService(client service.Connector, version string, linkType *LinkTypeService, remote *RemoteLinkService) (*LinkADFService, *LinkRichTextService, error)

NewLinkService creates new instances of LinkADFService and LinkRichTextService.

func NewSearchService 

func NewSearchService(client service.Connector, version string) (*SearchADFService, *SearchRichTextService, error)

NewSearchService creates a new instance of SearchADFService and SearchRichTextService.

Types

type AnnouncementBannerService 

type AnnouncementBannerService struct {
	// contains filtered or unexported fields
}

AnnouncementBannerService provides methods to interact with announcement banner operations in Jira Service Management.

func NewAnnouncementBannerService 

func NewAnnouncementBannerService(client service.Connector, version string) *AnnouncementBannerService

NewAnnouncementBannerService creates a new instance of AnnouncementBannerService. It takes a service.Connector and a version string as input and returns a pointer to AnnouncementBannerService.

func (*AnnouncementBannerService) Get 

func (a *AnnouncementBannerService) Get(ctx context.Context) (*model.AnnouncementBannerScheme, *model.ResponseScheme, error)

Get returns the current announcement banner configuration.

GET /rest/api/{2-3}/announcementBanner

https://docs.go-atlassian.io/jira-software-cloud/announcement-banner#get-announcement-banner-configuration

func (*AnnouncementBannerService) Update 

func (a *AnnouncementBannerService) Update(ctx context.Context, payload *model.AnnouncementBannerPayloadScheme) (*model.ResponseScheme, error)

Update updates the announcement banner configuration.

PUT /rest/api/{2-3}/announcementBanner

https://docs.go-atlassian.io/jira-software-cloud/announcement-banner#get-announcement-banner-configuration

type ApplicationRoleService 

type ApplicationRoleService struct {
	// contains filtered or unexported fields
}

ApplicationRoleService provides methods to interact with application role operations in Jira Service Management.

func NewApplicationRoleService 

func NewApplicationRoleService(client service.Connector, version string) (*ApplicationRoleService, error)

NewApplicationRoleService creates a new instance of ApplicationRoleService. It takes a service.Connector and a version string as input. Returns a pointer to ApplicationRoleService and an error if the version is not provided.

func (*ApplicationRoleService) Get 

func (a *ApplicationRoleService) Get(ctx context.Context, key string) (*model.ApplicationRoleScheme, *model.ResponseScheme, error)

Get returns an application role.

GET /rest/api/{2-3}/applicationrole/{key}

https://docs.go-atlassian.io/jira-software-cloud/application-roles#get-application-role

func (*ApplicationRoleService) Gets 

func (a *ApplicationRoleService) Gets(ctx context.Context) ([]*model.ApplicationRoleScheme, *model.ResponseScheme, error)

Gets returns all application roles.

In Jira, application roles are managed using the Application access configuration page.

GET /rest/api/{2-3}/applicationrole

https://docs.go-atlassian.io/jira-software-cloud/application-roles#get-all-application-roles

type AuditRecordService 

type AuditRecordService struct {
	// contains filtered or unexported fields
}

AuditRecordService provides methods to interact with audit record operations in Jira Service Management.

func NewAuditRecordService 

func NewAuditRecordService(client service.Connector, version string) (*AuditRecordService, error)

NewAuditRecordService creates a new instance of AuditRecordService. It takes a service.Connector and a version string as input. Returns a pointer to AuditRecordService and an error if the version is not provided.

func (*AuditRecordService) Get 

func (a *AuditRecordService) Get(ctx context.Context, options *model.AuditRecordGetOptions, offSet, limit int) (*model.AuditRecordPageScheme, *model.ResponseScheme, error)

Get allows you to retrieve the audit records for specific activities that have occurred within Jira.

GET /rest/api/{2-3}/auditing/record

https://docs.go-atlassian.io/jira-software-cloud/audit-records#get-audit-records

type AuthenticationService 

type AuthenticationService struct {
	// contains filtered or unexported fields
}

AuthenticationService provides methods to manage authentication in Jira Service Management.

func (*AuthenticationService) GetBasicAuth 

func (a *AuthenticationService) GetBasicAuth() (string, string)

GetBasicAuth returns the email and token used for basic authentication.

func (*AuthenticationService) GetBearerToken 

func (a *AuthenticationService) GetBearerToken() string

GetBearerToken returns the bearer token used for authentication.

func (*AuthenticationService) GetUserAgent 

func (a *AuthenticationService) GetUserAgent() string

GetUserAgent returns the user agent string.

func (*AuthenticationService) HasBasicAuth 

func (a *AuthenticationService) HasBasicAuth() bool

HasBasicAuth returns true if basic authentication credentials have been provided.

func (*AuthenticationService) HasSetExperimentalFlag 

func (a *AuthenticationService) HasSetExperimentalFlag() bool

HasSetExperimentalFlag returns false indicating the experimental flag is not set.

func (*AuthenticationService) HasUserAgent 

func (a *AuthenticationService) HasUserAgent() bool

HasUserAgent returns true if a user agent has been provided.

func (*AuthenticationService) SetBasicAuth 

func (a *AuthenticationService) SetBasicAuth(mail, token string)

SetBasicAuth sets the basic authentication credentials.

func (*AuthenticationService) SetBearerToken 

func (a *AuthenticationService) SetBearerToken(token string)

SetBearerToken sets the bearer token for authentication.

func (*AuthenticationService) SetExperimentalFlag 

func (a *AuthenticationService) SetExperimentalFlag()

SetExperimentalFlag is a placeholder for setting an experimental flag.

func (*AuthenticationService) SetUserAgent 

func (a *AuthenticationService) SetUserAgent(agent string)

SetUserAgent sets the user agent string.

type CommentADFService 

type CommentADFService struct {
	// contains filtered or unexported fields
}

CommentADFService provides methods to interact with comment operations in Jira Service Management using ADF format.

func (*CommentADFService) Add 

func (c *CommentADFService) Add(ctx context.Context, issueKeyOrID string, payload *model.CommentPayloadScheme, expand []string) (*model.IssueCommentScheme, *model.ResponseScheme, error)

Add adds a comment to an issue.

POST /rest/api/{2-3}/issue/{issueKeyOrID}/comment

https://docs.go-atlassian.io/jira-software-cloud/issues/comments#add-comment

func (*CommentADFService) Delete 

func (c *CommentADFService) Delete(ctx context.Context, issueKeyOrID, commentID string) (*model.ResponseScheme, error)

Delete deletes a comment.

DELETE /rest/api/{2-3}/issue/{issueKeyOrID}/comment/{id}

https://docs.go-atlassian.io/jira-software-cloud/issues/comments#delete-comment

func (*CommentADFService) Get 

func (c *CommentADFService) Get(ctx context.Context, issueKeyOrID, commentID string) (*model.IssueCommentScheme, *model.ResponseScheme, error)

Get returns a comment.

GET /rest/api/{2-3}/issue/{issueKeyOrID}/comment/{id}

https://docs.go-atlassian.io/jira-software-cloud/issues/comments#get-comment

func (*CommentADFService) Gets 

func (c *CommentADFService) Gets(ctx context.Context, issueKeyOrID, orderBy string, expand []string, startAt, maxResults int) (*model.IssueCommentPageScheme, *model.ResponseScheme, error)

Gets returns all comments for an issue.

GET /rest/api/{2-3}/issue/{issueKeyOrID}/comment

https://docs.go-atlassian.io/jira-software-cloud/issues/comments#get-comments

type CommentRichTextService 

type CommentRichTextService struct {
	// contains filtered or unexported fields
}

CommentRichTextService provides methods to interact with comment operations in Jira Service Management using Rich Text format.

func (*CommentRichTextService) Add 

func (c *CommentRichTextService) Add(ctx context.Context, issueKeyOrID string, payload *model.CommentPayloadSchemeV2, expand []string) (*model.IssueCommentSchemeV2, *model.ResponseScheme, error)

Add adds a comment to an issue.

POST /rest/api/{2-3}/issue/{issueKeyOrID}/comment

https://docs.go-atlassian.io/jira-software-cloud/issues/comments#add-comment

func (*CommentRichTextService) Delete 

func (c *CommentRichTextService) Delete(ctx context.Context, issueKeyOrID, commentID string) (*model.ResponseScheme, error)

Delete deletes a comment.

DELETE /rest/api/{2-3}/issue/{issueKeyOrID}/comment/{commentID}

https://docs.go-atlassian.io/jira-software-cloud/issues/comments#delete-comment

func (*CommentRichTextService) Get 

func (c *CommentRichTextService) Get(ctx context.Context, issueKeyOrID, commentID string) (*model.IssueCommentSchemeV2, *model.ResponseScheme, error)

Get returns a comment.

GET /rest/api/{2-3}/issue/{issueKeyOrID}/comment/{commentID}

TODO: The documentation needs to be created, raise a ticket here: https://github.com/m1keru/go-atlassian/issues

func (*CommentRichTextService) Gets 

func (c *CommentRichTextService) Gets(ctx context.Context, issueKeyOrID, orderBy string, expand []string, startAt, maxResults int) (*model.IssueCommentPageSchemeV2, *model.ResponseScheme, error)

Gets returns all comments for an issue.

GET /rest/api/{2-3}/issue/{issueKeyOrID}/comment

https://docs.go-atlassian.io/jira-software-cloud/issues/comments#get-comments

type DashboardService 

type DashboardService struct {
	// contains filtered or unexported fields
}

DashboardService provides methods to interact with dashboard operations in Jira Service Management.

func NewDashboardService 

func NewDashboardService(client service.Connector, version string) (*DashboardService, error)

NewDashboardService creates a new instance of DashboardService. It takes a service.Connector and a version string as input. Returns a pointer to DashboardService and an error if the version is not provided.

func (*DashboardService) Copy 

func (d *DashboardService) Copy(ctx context.Context, dashboardID string, payload *model.DashboardPayloadScheme) (*model.DashboardScheme, *model.ResponseScheme, error)

Copy copies a dashboard.

Any values provided in the dashboard parameter replace those in the copied dashboard.

POST /rest/api/{2-3}/dashboard/{id}/copy

https://docs.go-atlassian.io/jira-software-cloud/dashboards#copy-dashboard

func (*DashboardService) Create 

func (d *DashboardService) Create(ctx context.Context, payload *model.DashboardPayloadScheme) (*model.DashboardScheme, *model.ResponseScheme, error)

Create creates a dashboard.

POST /rest/api/{3-2}/dashboard

https://docs.go-atlassian.io/jira-software-cloud/dashboards#create-dashboard

func (*DashboardService) Delete 

func (d *DashboardService) Delete(ctx context.Context, dashboardID string) (*model.ResponseScheme, error)

Delete deletes a dashboard.

DELETE /rest/api/{2-3}/dashboard/{id}

https://docs.go-atlassian.io/jira-software-cloud/dashboards#delete-dashboard

func (*DashboardService) Get 

func (d *DashboardService) Get(ctx context.Context, dashboardID string) (*model.DashboardScheme, *model.ResponseScheme, error)

Get returns a dashboard.

GET /rest/api/{2-3}/dashboard/{id}

https://docs.go-atlassian.io/jira-software-cloud/dashboards#get-dashboard

func (*DashboardService) Gets 

func (d *DashboardService) Gets(ctx context.Context, startAt, maxResults int, filter string) (*model.DashboardPageScheme, *model.ResponseScheme, error)

Gets returns a list of dashboards owned by or shared with the user.

The list may be filtered to include only favorite or owned dashboards.

GET /rest/api/{3-2}/dashboard

https://docs.go-atlassian.io/jira-software-cloud/dashboards#get-all-dashboards

func (*DashboardService) Search 

func (d *DashboardService) Search(ctx context.Context, options *model.DashboardSearchOptionsScheme, startAt, maxResults int) (*model.DashboardSearchPageScheme, *model.ResponseScheme, error)

Search returns a paginated list of dashboards.

This operation is similar to Get dashboards except that the results can be refined to include dashboards that have specific attributes.

GET /rest/api/{2-3}/dashboard/search

https://docs.go-atlassian.io/jira-software-cloud/dashboards#search-for-dashboards

func (*DashboardService) Update 

func (d *DashboardService) Update(ctx context.Context, dashboardID string, payload *model.DashboardPayloadScheme) (*model.DashboardScheme, *model.ResponseScheme, error)

Update updates a dashboard

PUT /rest/api/{2-3}/dashboard/{id}

https://docs.go-atlassian.io/jira-software-cloud/dashboards#update-dashboard

type FilterService 

type FilterService struct {

	// Share is the service for managing filter sharing.
	Share jira.FilterSharingConnector
	// contains filtered or unexported fields
}

FilterService provides methods to manage filters in Jira Service Management.

func NewFilterService 

func NewFilterService(client service.Connector, version string, share jira.FilterSharingConnector) (*FilterService, error)

NewFilterService creates a new instance of FilterService. It takes a service.Connector, a version string, and a jira.FilterSharingConnector as input. Returns a pointer to FilterService and an error if the version is not provided.

func (*FilterService) Change 

func (f *FilterService) Change(ctx context.Context, filterID int, accountID string) (*model.ResponseScheme, error)

Change changes the owner of the filter.

PUT /rest/api/{2-3}/filter/{id}/owner

https://docs.go-atlassian.io/jira-software-cloud/filters#change-filter-owner

func (*FilterService) Create 

func (f *FilterService) Create(ctx context.Context, payload *model.FilterPayloadScheme) (*model.FilterScheme, *model.ResponseScheme, error)

Create creates a filter. The filter is shared according to the default share scope.

The filter is not selected as a favorite.

POST /rest/api/{2-3}/filter

https://docs.go-atlassian.io/jira-software-cloud/filters#create-filter

func (*FilterService) Delete 

func (f *FilterService) Delete(ctx context.Context, filterID int) (*model.ResponseScheme, error)

Delete a filter.

DELETE /rest/api/{2-3}/filter/{id}

https://docs.go-atlassian.io/jira-software-cloud/filters#delete-filter

func (*FilterService) Favorite 

func (f *FilterService) Favorite(ctx context.Context) ([]*model.FilterScheme, *model.ResponseScheme, error)

Favorite returns the visible favorite filters of the user.

GET /rest/api/{2-3}/filter/favourite

https://docs.go-atlassian.io/jira-software-cloud/filters#get-favorites

func (*FilterService) Get 

func (f *FilterService) Get(ctx context.Context, filterID int, expand []string) (*model.FilterScheme, *model.ResponseScheme, error)

Get returns a filter.

GET /rest/api/{2-3}/filter/{id}

https://docs.go-atlassian.io/jira-software-cloud/filters#get-filter

func (*FilterService) My 

func (f *FilterService) My(ctx context.Context, favorites bool, expand []string) ([]*model.FilterScheme, *model.ResponseScheme, error)

My returns the filters owned by the user. If includeFavourites is true,

The user's visible favorite filters are also returned. GET /rest/api/{2-3}/filter/my

https://docs.go-atlassian.io/jira-software-cloud/filters#get-my-filters

func (*FilterService) Search 

func (f *FilterService) Search(ctx context.Context, options *model.FilterSearchOptionScheme, startAt, maxResults int) (*model.FilterSearchPageScheme,
	*model.ResponseScheme, error)

Search returns a paginated list of filters

GET /rest/api/{2-3}/filter/search

https://docs.go-atlassian.io/jira-software-cloud/filters#search-filters

func (*FilterService) Update 

func (f *FilterService) Update(ctx context.Context, filterID int, payload *model.FilterPayloadScheme) (*model.FilterScheme, *model.ResponseScheme, error)

Update updates a filter. Use this operation to update a filter's name, description, JQL, or sharing.

PUT /rest/api/{2-3}/filter/{id}

https://docs.go-atlassian.io/jira-software-cloud/filters#update-filter

type FilterShareService 

type FilterShareService struct {
	// contains filtered or unexported fields
}

FilterShareService provides methods to manage filter sharing in Jira Service Management.

func NewFilterShareService 

func NewFilterShareService(client service.Connector, version string) (*FilterShareService, error)

NewFilterShareService creates a new instance of FilterShareService. It takes a service.Connector and a version string as input. Returns a pointer to FilterShareService and an error if the version is not provided.

func (*FilterShareService) Add 

func (f *FilterShareService) Add(ctx context.Context, filterID int, payload *model.PermissionFilterPayloadScheme) ([]*model.SharePermissionScheme, *model.ResponseScheme, error)

Add a share permissions to a filter.

If you add a global share permission (one for all logged-in users or the public)

it will overwrite all share permissions for the filter.

POST /rest/api/{2-3}/filter/{id}/permission

https://docs.go-atlassian.io/jira-software-cloud/filters/sharing#add-share-permission

func (*FilterShareService) Delete 

func (f *FilterShareService) Delete(ctx context.Context, filterID, permissionID int) (*model.ResponseScheme, error)

Delete deletes a share permission from a filter.

DELETE /rest/api/{2-3}/filter/{id}/permission/{permissionID}

https://docs.go-atlassian.io/jira-software-cloud/filters/sharing#delete-share-permission

func (*FilterShareService) Get 

func (f *FilterShareService) Get(ctx context.Context, filterID, permissionID int) (*model.SharePermissionScheme, *model.ResponseScheme, error)

Get returns a share permission for a filter.

A filter can be shared with groups, projects, all logged-in users, or the public.

Sharing with all logged-in users or the public is known as a global share permission.

GET /rest/api/{2-3}/filter/{id}/permission/{permissionID}

https://docs.go-atlassian.io/jira-software-cloud/filters/sharing#get-share-permission

func (*FilterShareService) Gets 

func (f *FilterShareService) Gets(ctx context.Context, filterID int) ([]*model.SharePermissionScheme, *model.ResponseScheme, error)

Gets returns the share permissions for a filter.

1.A filter can be shared with groups, projects, all logged-in users, or the public.

2.Sharing with all logged-in users or the public is known as a global share permission.

GET /rest/api/{2-3}/filter/{id}/permission

https://docs.go-atlassian.io/jira-software-cloud/filters/sharing#get-share-permissions

func (*FilterShareService) Scope 

func (f *FilterShareService) Scope(ctx context.Context) (*model.ShareFilterScopeScheme, *model.ResponseScheme, error)

Scope returns the default sharing settings for new filters and dashboards for a user.

GET /rest/api/{2-3}/filter/defaultShareScope

https://docs.go-atlassian.io/jira-software-cloud/filters/sharing#get-default-share-scope

func (*FilterShareService) SetScope 

func (f *FilterShareService) SetScope(ctx context.Context, scope string) (*model.ResponseScheme, error)

SetScope sets the default sharing for new filters and dashboards for a user.

PUT /rest/api/{2-3}/filter/defaultShareScope

https://docs.go-atlassian.io/jira-software-cloud/filters/sharing#set-default-share-scope

type GroupService 

type GroupService struct {
	// contains filtered or unexported fields
}

GroupService provides methods to manage groups in Jira Service Management.

func NewGroupService 

func NewGroupService(client service.Connector, version string) (*GroupService, error)

NewGroupService creates a new instance of GroupService. It takes a service.Connector and a version string as input. Returns a pointer to GroupService and an error if the version is not provided.

func (*GroupService) Add 

func (g *GroupService) Add(ctx context.Context, groupName, accountID string) (*model.GroupScheme, *model.ResponseScheme, error)

Add adds a user to a group.

POST /rest/api/{2-3}/group/user

https://docs.go-atlassian.io/jira-software-cloud/groups#add-user-to-group

func (*GroupService) Bulk 

func (g *GroupService) Bulk(ctx context.Context, options *model.GroupBulkOptionsScheme, startAt, maxResults int) (*model.BulkGroupScheme, *model.ResponseScheme, error)

Bulk returns a paginated list of groups.

GET /rest/api/{2-3}/group/bulk

https://docs.go-atlassian.io/jira-software-cloud/groups#bulk-groups

func (*GroupService) Create 

func (g *GroupService) Create(ctx context.Context, groupName string) (*model.GroupScheme, *model.ResponseScheme, error)

Create creates a group.

POST /rest/api/{2-3}/group

https://docs.go-atlassian.io/jira-software-cloud/groups#create-group

func (*GroupService) Delete 

func (g *GroupService) Delete(ctx context.Context, groupName string) (*model.ResponseScheme, error)

Delete deletes a group.

DELETE /rest/api/{2-3}/group

https://docs.go-atlassian.io/jira-software-cloud/groups#remove-group

func (*GroupService) Members 

func (g *GroupService) Members(ctx context.Context, groupName string, inactive bool, startAt, maxResults int) (*model.GroupMemberPageScheme, *model.ResponseScheme, error)

Members returns a paginated list of all users in a group.

GET /rest/api/{2-3}/group/member

https://docs.go-atlassian.io/jira-software-cloud/groups#get-users-from-groups

func (*GroupService) Remove 

func (g *GroupService) Remove(ctx context.Context, groupName, accountID string) (*model.ResponseScheme, error)

Remove removes a user from a group.

DELETE /rest/api/{2-3}/group/user

https://docs.go-atlassian.io/jira-software-cloud/groups#remove-user-from-group

type GroupUserPickerService 

type GroupUserPickerService struct {
	// contains filtered or unexported fields
}

GroupUserPickerService handles communication with the GroupUserPicker related methods of the Jira API.

func NewGroupUserPickerService 

func NewGroupUserPickerService(client service.Connector, version string) (*GroupUserPickerService, error)

NewGroupUserPickerService creates a new GroupUserPickerService instance.

func (*GroupUserPickerService) Find 

func (g *GroupUserPickerService) Find(ctx context.Context, options *model.GroupUserPickerFindOptionScheme) (*model.GroupUserPickerFindScheme, *model.ResponseScheme, error)

Find returns a list of users and groups matching a string.

GET /rest/api/{2-3}/groupuserpicker

https://docs.go-atlassian.io/jira-software-cloud/groupuserpicker#find-users-and-groups

type IssueADFService 

type IssueADFService struct {

	// Attachment is the service for managing issue attachments.
	Attachment *IssueAttachmentService
	// Comment is the service for managing ADF comments.
	Comment *CommentADFService
	// Field is the service for managing issue fields.
	Field *IssueFieldService
	// Label is the service for managing issue labels.
	Label *LabelService
	// Link is the service for managing ADF issue links.
	Link *LinkADFService
	// Metadata is the service for managing issue metadata.
	Metadata *MetadataService
	// Priority is the service for managing issue priorities.
	Priority *PriorityService
	// Resolution is the service for managing issue resolutions.
	Resolution *ResolutionService
	// Search is the service for managing ADF issue searches.
	Search *SearchADFService
	// Type is the service for managing issue types.
	Type *TypeService
	// Vote is the service for managing issue votes.
	Vote *VoteService
	// Watcher is the service for managing issue watchers.
	Watcher *WatcherService
	// Worklog is the service for managing ADF worklogs.
	Worklog *WorklogADFService
	// Property is the service for managing issue properties.
	Property *IssuePropertyService
	// contains filtered or unexported fields
}

IssueADFService provides methods to manage issues in Jira Service Management using the ADF format.

func (*IssueADFService) Assign 

func (i *IssueADFService) Assign(ctx context.Context, issueKeyOrID, accountID string) (*model.ResponseScheme, error)

Assign assigns an issue to a user.

Use this operation when the calling user does not have the Edit Issues permission but has the

Assign issue permission for the project that the issue is in.

If accountID is set to:

  1. "-1", the issue is assigned to the default assignee for the project.
  2. null, the issue is set to unassigned.

PUT /rest/api/{2-3}/issue/{issueKeyOrID}/assignee

https://docs.go-atlassian.io/jira-software-cloud/issues#assign-issue

func (*IssueADFService) Create 

func (i *IssueADFService) Create(ctx context.Context, payload *model.IssueScheme, customFields *model.CustomFields) (*model.IssueResponseScheme, *model.ResponseScheme, error)

Create creates an issue or, where the option to create subtasks is enabled in Jira, a subtask.

POST /rest/api/{2-3}/issue

https://docs.go-atlassian.io/jira-software-cloud/issues#create-issue

func (*IssueADFService) Creates 

func (i *IssueADFService) Creates(ctx context.Context, payload []*model.IssueBulkSchemeV3) (*model.IssueBulkResponseScheme, *model.ResponseScheme, error)

Creates issues and, where the option to create subtasks is enabled in Jira, subtasks.

1.Creates upto 50 issues and, where the option to create subtasks is enabled in Jira, subtasks.

2.Transitions may be applied, to move the issues or subtasks to a workflow step other than the default start step, and issue properties set.

POST /rest/api/{2-3}/issue/bulk

https://docs.go-atlassian.io/jira-software-cloud/issues#bulk-create-issue

func (*IssueADFService) Delete 

func (i *IssueADFService) Delete(ctx context.Context, issueKeyOrID string, deleteSubTasks bool) (*model.ResponseScheme, error)

Delete deletes an issue.

1.An issue cannot be deleted if it has one or more subtasks.

2.To delete an issue with subtasks, set deleteSubtasks.

3.This causes the issue's subtasks to be deleted with the issue.

DELETE /rest/api/{2-3}/issue/{issueKeyOrID}

https://docs.go-atlassian.io/jira-software-cloud/issues#delete-issue

func (*IssueADFService) Get 

func (i *IssueADFService) Get(ctx context.Context, issueKeyOrID string, fields, expand []string) (*model.IssueScheme, *model.ResponseScheme, error)

Get returns the details for an issue.

The issue is identified by its ID or key, however, if the identifier doesn't match an issue, a case-insensitive search

and check for moved issues is performed. If a matching issue is found its details are returned, a 302 or other redirect is not returned.

The issue key returned to the response is the key of the issue found.

GET /rest/api/{2-3}/issue/{issueKeyOrID}

https://docs.go-atlassian.io/jira-software-cloud/issues#get-issue

func (*IssueADFService) Move 

func (i *IssueADFService) Move(ctx context.Context, issueKeyOrID, transitionID string, options *model.IssueMoveOptionsV3) (*model.ResponseScheme, error)

Move performs an issue transition and, if the transition has a screen, updates the fields from the transition screen.

sortByCategory To update the fields on the transition screen, specify the fields in the fields or update parameters in the request body. Get details about the fields using Get transitions with the transitions.fields expand.

POST /rest/api/{2-3}/issue/{issueKeyOrID}/transitions

https://docs.go-atlassian.io/jira-software-cloud/issues#transition-issue

func (*IssueADFService) Notify 

func (i *IssueADFService) Notify(ctx context.Context, issueKeyOrID string, options *model.IssueNotifyOptionsScheme) (*model.ResponseScheme, error)

Notify creates an email notification for an issue and adds it to the mail queue.

POST /rest/api/{2-3}/issue/{issueKeyOrID}/notify

https://docs.go-atlassian.io/jira-software-cloud/issues#send-notification-for-issue

func (*IssueADFService) Transitions 

func (i *IssueADFService) Transitions(ctx context.Context, issueKeyOrID string) (*model.IssueTransitionsScheme, *model.ResponseScheme, error)

Transitions returns either all transitions or a transition that can be performed by the user on an issue, based on the issue's status.

Note, if a request is made for a transition that does not exist or cannot be performed on the issue,

given its status, the response will return any empty transitions list.

GET /rest/api/{2-3}/issue/{issueKeyOrID}/transitions

https://docs.go-atlassian.io/jira-software-cloud/issues#get-transitions

func (*IssueADFService) Update 

func (i *IssueADFService) Update(ctx context.Context, issueKeyOrID string, notify bool, payload *model.IssueScheme, customFields *model.CustomFields, operations *model.UpdateOperations) (*model.ResponseScheme, error)

Update edits an issue.

Edits an issue. A transition may be applied and issue properties updated as part of the edit.

The edits to the issue's fields are defined using update and fields

PUT /rest/api/{2-3}/issue/{issueKeyOrID}

https://docs.go-atlassian.io/jira-software-cloud/issues#edit-issue

type IssueAttachmentService 

type IssueAttachmentService struct {
	// contains filtered or unexported fields
}

IssueAttachmentService provides methods to interact with issue attachment operations in Jira Service Management.

func NewIssueAttachmentService 

func NewIssueAttachmentService(client service.Connector, version string) (*IssueAttachmentService, error)

NewIssueAttachmentService creates a new instance of IssueAttachmentService. It takes a service.Connector and a version string as input. Returns a pointer to IssueAttachmentService and an error if the version is not provided.

func (*IssueAttachmentService) Add 

func (i *IssueAttachmentService) Add(ctx context.Context, issueKeyOrID, fileName string, file io.Reader) ([]*model.IssueAttachmentScheme, *model.ResponseScheme, error)

Add adds one attachment to an issue. Attachments are posted as multipart/form-data (RFC 1867).

POST /rest/api/{2-3}/issue/{issueKeyOrID}/attachments

https://docs.go-atlassian.io/jira-software-cloud/issues/attachments#add-attachment

func (*IssueAttachmentService) Delete 

func (i *IssueAttachmentService) Delete(ctx context.Context, attachmentID string) (*model.ResponseScheme, error)

Delete deletes an attachment from an issue.

DELETE /rest/api/{2-3}/attachment/{id}

https://docs.go-atlassian.io/jira-software-cloud/issues/attachments#delete-attachment

func (*IssueAttachmentService) Download 

func (i *IssueAttachmentService) Download(ctx context.Context, attachmentID string, redirect bool) (*model.ResponseScheme, error)

Download returns the contents of an attachment. A Range header can be set to define a range of bytes within the attachment to download.

See the HTTP Range header standard for details.

GET /rest/api/{2-3}/attachment/content/{id}

https://docs.go-atlassian.io/jira-software-cloud/issues/attachments#download-attachment

func (*IssueAttachmentService) Human 

func (i *IssueAttachmentService) Human(ctx context.Context, attachmentID string) (*model.IssueAttachmentHumanMetadataScheme, *model.ResponseScheme, error)

Human returns the metadata for the contents of an attachment, if it is an archive, and metadata for the attachment itself.

For example, if the attachment is a ZIP archive, then information about the files in the archive is returned and metadata for the ZIP archive.

GET /rest/api/{2-3}/attachment/{id}/expand/human

Experimental Endpoint

https://docs.go-atlassian.io/jira-software-cloud/issues/attachments#get-all-metadata-for-an-expanded-attachment

func (*IssueAttachmentService) Metadata 

func (i *IssueAttachmentService) Metadata(ctx context.Context, attachmentID string) (*model.IssueAttachmentMetadataScheme, *model.ResponseScheme, error)

Metadata returns the metadata for an attachment. Note that the attachment itself is not returned.

GET /rest/api/{2-3}/attachment/{id}

https://docs.go-atlassian.io/jira-software-cloud/issues/attachments#get-attachment-metadata

func (*IssueAttachmentService) Settings 

func (i *IssueAttachmentService) Settings(ctx context.Context) (*model.AttachmentSettingScheme, *model.ResponseScheme, error)

Settings returns the attachment settings, that is, whether attachments are enabled and the maximum attachment size allowed.

GET /rest/api/{2-3}/attachment/meta

https://docs.go-atlassian.io/jira-software-cloud/issues/attachments#get-jira-attachment-settings

type IssueFieldConfigItemService 

type IssueFieldConfigItemService struct {
	// contains filtered or unexported fields
}

IssueFieldConfigItemService provides methods to manage field configuration items in Jira Service Management.

func NewIssueFieldConfigurationItemService 

func NewIssueFieldConfigurationItemService(client service.Connector, version string) (*IssueFieldConfigItemService, error)

NewIssueFieldConfigurationItemService creates a new instance of IssueFieldConfigItemService. It takes a service.Connector and a version string as input. Returns a pointer to IssueFieldConfigItemService and an error if the version is not provided.

func (*IssueFieldConfigItemService) Gets 

func (i *IssueFieldConfigItemService) Gets(ctx context.Context, id, startAt, maxResults int) (*model.FieldConfigurationItemPageScheme, *model.ResponseScheme, error)

Gets Returns a paginated list of all fields for a configuration.

GET /rest/api/{2-3}/fieldconfiguration/{id}/fields

https://docs.go-atlassian.io/jira-software-cloud/issues/fields/configuration/items#get-field-configuration-items

func (*IssueFieldConfigItemService) Update 

func (i *IssueFieldConfigItemService) Update(ctx context.Context, id int, payload *model.UpdateFieldConfigurationItemPayloadScheme) (*model.ResponseScheme, error)

Update updates fields in a field configuration. The properties of the field configuration fields provided override the existing values.

1. This operation can only update field configurations used in company-managed (classic) projects.

PUT /rest/api/{2-3}/fieldconfiguration/{id}/fields

https://docs.go-atlassian.io/jira-software-cloud/issues/fields/configuration/items#update-field-configuration-items

type IssueFieldConfigSchemeService 

type IssueFieldConfigSchemeService struct {
	// contains filtered or unexported fields
}

IssueFieldConfigSchemeService provides methods to manage field configuration schemes in Jira Service Management.

func NewIssueFieldConfigurationSchemeService 

func NewIssueFieldConfigurationSchemeService(client service.Connector, version string) (*IssueFieldConfigSchemeService, error)

NewIssueFieldConfigurationSchemeService creates a new instance of IssueFieldConfigSchemeService. It takes a service.Connector and a version string as input. Returns a pointer to IssueFieldConfigSchemeService and an error if the version is not provided.

func (*IssueFieldConfigSchemeService) Assign 

func (i *IssueFieldConfigSchemeService) Assign(ctx context.Context, payload *model.FieldConfigurationSchemeAssignPayload) (*model.ResponseScheme, error)

Assign assigns a field configuration scheme to a project. If the field configuration scheme ID is null,

the operation assigns the default field configuration scheme.

Field configuration schemes can only be assigned to classic projects.

PUT /rest/api/{2-3}/fieldconfigurationscheme/project

https://docs.go-atlassian.io/jira-software-cloud/issues/fields/configuration/schemes#assign-field-configuration-scheme

func (*IssueFieldConfigSchemeService) Create 

func (i *IssueFieldConfigSchemeService) Create(ctx context.Context, name, description string) (*model.FieldConfigurationSchemeScheme, *model.ResponseScheme, error)

Create creates a field configuration scheme.

This operation can only create field configuration schemes used in company-managed (classic) projects.

POST /rest/api/{2-3}/fieldconfigurationscheme

https://docs.go-atlassian.io/jira-software-cloud/issues/fields/configuration/schemes#create-field-configuration-scheme

func (*IssueFieldConfigSchemeService) Delete 

func (i *IssueFieldConfigSchemeService) Delete(ctx context.Context, schemeID int) (*model.ResponseScheme, error)

Delete deletes a field configuration scheme.

This operation can only delete field configuration schemes used in company-managed (classic) projects.

DELETE /rest/api/{2-3}/fieldconfigurationscheme/{schemeID}

https://docs.go-atlassian.io/jira-software-cloud/issues/fields/configuration/schemes#delete-field-configuration-scheme

func (*IssueFieldConfigSchemeService) Gets 

func (i *IssueFieldConfigSchemeService) Gets(ctx context.Context, ids []int, startAt, maxResults int) (*model.FieldConfigurationSchemePageScheme, *model.ResponseScheme, error)

Gets returns a paginated list of field configuration schemes.

Only field configuration schemes used in classic projects are returned.

GET /rest/api/{2-3}/fieldconfigurationscheme

https://docs.go-atlassian.io/jira-software-cloud/issues/fields/configuration/schemes#get-field-configuration-schemes 

func (i *IssueFieldConfigSchemeService) Link(ctx context.Context, schemeID int, payload *model.FieldConfigurationToIssueTypeMappingPayloadScheme) (*model.ResponseScheme, error)

Link assigns issue types to field configurations on field configuration scheme.

This operation can only modify field configuration schemes used in company-managed (classic) projects.

PUT /rest/api/{2-3}/fieldconfigurationscheme/{schemeID}/mapping

https://docs.go-atlassian.io/jira-software-cloud/issues/fields/configuration/schemes#assign-issue-types-to-field-configuration

func (*IssueFieldConfigSchemeService) Mapping 

func (i *IssueFieldConfigSchemeService) Mapping(ctx context.Context, fieldConfigIDs []int, startAt, maxResults int) (*model.FieldConfigurationIssueTypeItemPageScheme, *model.ResponseScheme, error)

Mapping returns a paginated list of field configuration issue type items.

Only items used in classic projects are returned.

GET /rest/api/{2-3}/fieldconfigurationscheme/mapping

https://docs.go-atlassian.io/jira-software-cloud/issues/fields/configuration/schemes#get-field-configuration-scheme-mapping

func (*IssueFieldConfigSchemeService) Project 

func (i *IssueFieldConfigSchemeService) Project(ctx context.Context, projectIDs []int, startAt, maxResults int) (*model.FieldConfigurationSchemeProjectPageScheme, *model.ResponseScheme, error)

Project returns a paginated list of field configuration schemes and, for each scheme, a list of the projects that use it.

1. The list is sorted by field configuration scheme ID. The first item contains the list of project IDs assigned to the default field configuration scheme.

2. Only field configuration schemes used in classic projects are returned.\

GET /rest/api/{2-3}/fieldconfigurationscheme/project

https://docs.go-atlassian.io/jira-software-cloud/issues/fields/configuration/schemes#get-field-configuration-schemes-by-project 

func (i *IssueFieldConfigSchemeService) Unlink(ctx context.Context, schemeID int, issueTypeIDs []string) (*model.ResponseScheme, error)

Unlink removes issue types from the field configuration scheme.

This operation can only modify field configuration schemes used in company-managed (classic) projects.

POST /rest/api/{2-3}/fieldconfigurationscheme/{schemeID}/mapping/delete

https://docs.go-atlassian.io/jira-software-cloud/issues/fields/configuration/schemes#remove-issue-types-to-field-configuration

func (*IssueFieldConfigSchemeService) Update 

func (i *IssueFieldConfigSchemeService) Update(ctx context.Context, schemeID int, name, description string) (*model.ResponseScheme, error)

Update updates a field configuration scheme.

This operation can only update field configuration schemes used in company-managed (classic) projects.

PUT /rest/api/{2-3}/fieldconfigurationscheme/{schemeID}

https://docs.go-atlassian.io/jira-software-cloud/issues/fields/configuration/schemes#update-field-configuration-scheme

type IssueFieldConfigService 

type IssueFieldConfigService struct {

	// Item is the service for managing field configuration items.
	Item *IssueFieldConfigItemService
	// Scheme is the service for managing field configuration schemes.
	Scheme *IssueFieldConfigSchemeService
	// contains filtered or unexported fields
}

IssueFieldConfigService provides methods to manage field configurations in Jira Service Management.

func NewIssueFieldConfigurationService 

func NewIssueFieldConfigurationService(client service.Connector, version string, item *IssueFieldConfigItemService,
	scheme *IssueFieldConfigSchemeService) (*IssueFieldConfigService, error)

NewIssueFieldConfigurationService creates a new instance of IssueFieldConfigService. It takes a service.Connector, a version string, an IssueFieldConfigItemService, and an IssueFieldConfigSchemeService as input. Returns a pointer to IssueFieldConfigService and an error if the version is not provided.

func (*IssueFieldConfigService) Create 

func (i *IssueFieldConfigService) Create(ctx context.Context, name, description string) (*model.FieldConfigurationScheme, *model.ResponseScheme, error)

Create creates a field configuration. The field configuration is created with the same field properties as the default configuration, with all the fields being optional.

This operation can only create configurations for use in company-managed (classic) projects.

POST /rest/api/{2-3}/fieldconfiguration

https://docs.go-atlassian.io/jira-software-cloud/issues/fields/configuration#create-field-configuration

func (*IssueFieldConfigService) Delete 

func (i *IssueFieldConfigService) Delete(ctx context.Context, id int) (*model.ResponseScheme, error)

Delete deletes a field configuration.

This operation can only delete configurations used in company-managed (classic) projects.

DELETE /rest/api/{2-3}/fieldconfiguration/{id}

https://docs.go-atlassian.io/jira-software-cloud/issues/fields/configuration#delete-field-configuration

func (*IssueFieldConfigService) Gets 

func (i *IssueFieldConfigService) Gets(ctx context.Context, ids []int, isDefault bool, startAt, maxResults int) (*model.FieldConfigurationPageScheme, *model.ResponseScheme, error)

Gets Returns a paginated list of all field configurations.

GET /rest/api/{2-3}/fieldconfiguration

https://docs.go-atlassian.io/jira-software-cloud/issues/fields/configuration#get-all-field-configurations

func (*IssueFieldConfigService) Update 

func (i *IssueFieldConfigService) Update(ctx context.Context, id int, name, description string) (*model.ResponseScheme, error)

Update updates a field configuration. The name and the description provided in the request override the existing values.

This operation can only update configurations used in company-managed (classic) projects.

PUT /rest/api/{2-3}/fieldconfiguration/{id}

https://docs.go-atlassian.io/jira-software-cloud/issues/fields/configuration#update-field-configuration

type IssueFieldContextOptionService 

type IssueFieldContextOptionService struct {
	// contains filtered or unexported fields
}

IssueFieldContextOptionService provides methods to manage field context options in Jira Service Management.

func NewIssueFieldContextOptionService 

func NewIssueFieldContextOptionService(client service.Connector, version string) (*IssueFieldContextOptionService, error)

NewIssueFieldContextOptionService creates a new instance of IssueFieldContextOptionService. It takes a service.Connector and a version string as input. Returns a pointer to IssueFieldContextOptionService and an error if the version is not provided.

func (*IssueFieldContextOptionService) Create 

func (i *IssueFieldContextOptionService) Create(ctx context.Context, fieldID string, contextID int, payload *model.FieldContextOptionListScheme) (*model.FieldContextOptionListScheme, *model.ResponseScheme, error)

Create creates options and, where the custom select field is of the type Select List (cascading), cascading options for a custom select field.

1. The options are added to a context of the field.

2. The maximum number of options that can be created per request is 1000 and each field can have a maximum of 10000 options.

POST /rest/api/{2-3}/field/{fieldID}/context/{contextID}/option

https://docs.go-atlassian.io/jira-software-cloud/issues/fields/context/option#create-custom-field-options

func (*IssueFieldContextOptionService) Delete 

func (i *IssueFieldContextOptionService) Delete(ctx context.Context, fieldID string, contextID, optionID int) (*model.ResponseScheme, error)

Delete deletes a custom field option.

1. Options with cascading options cannot be deleted without deleting the cascading options first.

DELETE /rest/api/{2-3}/field/{fieldID}/context/{contextID}/option/{optionID}

https://docs.go-atlassian.io/jira-software-cloud/issues/fields/context/option#delete-custom-field-options

func (*IssueFieldContextOptionService) Gets 

func (i *IssueFieldContextOptionService) Gets(ctx context.Context, fieldID string, contextID int, options *model.FieldOptionContextParams, startAt, maxResults int) (*model.CustomFieldContextOptionPageScheme, *model.ResponseScheme, error)

Gets returns a paginated list of all custom field option for a context.

Options are returned first then cascading options, in the order they display in Jira.

GET /rest/api/{2-3}/field/{fieldID}/context/{contextID}/option

https://docs.go-atlassian.io/jira-software-cloud/issues/fields/context/option#get-custom-field-options

func (*IssueFieldContextOptionService) Order 

func (i *IssueFieldContextOptionService) Order(ctx context.Context, fieldID string, contextID int, payload *model.OrderFieldOptionPayloadScheme) (*model.ResponseScheme, error)

Order changes the order of custom field options or cascading options in a context.

PUT /rest/api/{2-3}/field/{fieldID}/context/{contextID}/option/move

https://docs.go-atlassian.io/jira-software-cloud/issues/fields/context/option#reorder-custom-field-options

func (*IssueFieldContextOptionService) Update 

func (i *IssueFieldContextOptionService) Update(ctx context.Context, fieldID string, contextID int, payload *model.FieldContextOptionListScheme) (*model.FieldContextOptionListScheme, *model.ResponseScheme, error)

Update updates the options of a custom field.

1. If any of the options are not found, no options are updated.

2. Options where the values in the request match the current values aren't updated and aren't reported in the response.

PUT /rest/api/{2-3}/field/{fieldID}/context/{contextID}/option

https://docs.go-atlassian.io/jira-software-cloud/issues/fields/context/option#update-custom-field-options

type IssueFieldContextService 

type IssueFieldContextService struct {

	// Option is the service for managing field context options.
	Option *IssueFieldContextOptionService
	// contains filtered or unexported fields
}

IssueFieldContextService provides methods to manage field contexts in Jira Service Management.

func NewIssueFieldContextService 

func NewIssueFieldContextService(client service.Connector, version string, option *IssueFieldContextOptionService) (*IssueFieldContextService, error)

NewIssueFieldContextService creates a new instance of IssueFieldContextService. It takes a service.Connector, a version string, and an IssueFieldContextOptionService as input. Returns a pointer to IssueFieldContextService and an error if the version is not provided.

func (*IssueFieldContextService) AddIssueTypes 

func (i *IssueFieldContextService) AddIssueTypes(ctx context.Context, fieldID string, contextID int, issueTypesIDs []string) (*model.ResponseScheme, error)

AddIssueTypes adds issue types to a custom field context, appending the issue types to the issue types list.

PUT /rest/api/{2-3}/field/{fieldID}/context/{contextID}/issuetype

https://docs.go-atlassian.io/jira-software-cloud/issues/fields/context#add-issue-types-to-context

func (*IssueFieldContextService) Create 

func (i *IssueFieldContextService) Create(ctx context.Context, fieldID string, payload *model.FieldContextPayloadScheme) (*model.FieldContextScheme, *model.ResponseScheme, error)

Create creates a custom field context.

1. If projectIDs is empty, a global context is created. A global context is one that applies to all project.

2. If issueTypeIDs is empty, the context applies to all issue types.

POST /rest/api/{2-3}/field/{fieldID}/context

https://docs.go-atlassian.io/jira-software-cloud/issues/fields/context#create-custom-field-context

func (*IssueFieldContextService) Delete 

func (i *IssueFieldContextService) Delete(ctx context.Context, fieldID string, contextID int) (*model.ResponseScheme, error)

Delete deletes a custom field context.

DELETE /rest/api/{2-3}/field/{fieldID}/context/{contextID}

https://docs.go-atlassian.io/jira-software-cloud/issues/fields/context#delete-custom-field-context

func (*IssueFieldContextService) GetDefaultValues 

func (i *IssueFieldContextService) GetDefaultValues(ctx context.Context, fieldID string, contextIDs []int, startAt, maxResults int) (*model.CustomFieldDefaultValuePageScheme, *model.ResponseScheme, error)

GetDefaultValues returns a paginated list of defaults for a custom field.

The results can be filtered by contextID, otherwise all values are returned. If no defaults are set for a context, nothing is returned.

GET /rest/api/{2-3}/field/{fieldID}/context/defaultValue

https://docs.go-atlassian.io/jira-software-cloud/issues/fields/context#get-custom-field-contexts-default-values

func (*IssueFieldContextService) Gets 

func (i *IssueFieldContextService) Gets(ctx context.Context, fieldID string, options *model.FieldContextOptionsScheme, startAt, maxResults int) (*model.CustomFieldContextPageScheme, *model.ResponseScheme, error)

Gets returns a paginated list of contexts for a custom field. Contexts can be returned as follows:

1. By defining id only, all contexts from the list of IDs.

2. By defining isAnyIssueType

3. By defining isGlobalContext

GET /rest/api/{2-3}/field/{fieldID}/context

https://docs.go-atlassian.io/jira-software-cloud/issues/fields/context#get-custom-field-contexts

func (*IssueFieldContextService) IssueTypesContext 

func (i *IssueFieldContextService) IssueTypesContext(ctx context.Context, fieldID string, contextIDs []int, startAt, maxResults int) (*model.IssueTypeToContextMappingPageScheme, *model.ResponseScheme, error)

IssueTypesContext returns a paginated list of context to issue type mappings for a custom field.

1. Mappings are returned for all contexts or a list of contexts.

2. Mappings are ordered first by context ID and then by issue type ID.

GET /rest/api/{2-3}/field/{fieldID}/context/issuetypemapping

Docs: TODO: The documentation needs to be created, raise a ticket here: https://github.com/m1keru/go-atlassian/issues 

func (i *IssueFieldContextService) Link(ctx context.Context, fieldID string, contextID int, projectIDs []string) (*model.ResponseScheme, error)

Link assigns a custom field context to projects. If any project in the request is assigned to any context of the custom field, the operation fails.

PUT /rest/api/{2-3}/field/{fieldID}/context/{contextID}/project

https://docs.go-atlassian.io/jira-software-cloud/issues/fields/context#assign-custom-field-context-to-projects

func (*IssueFieldContextService) ProjectsContext 

func (i *IssueFieldContextService) ProjectsContext(ctx context.Context, fieldID string, contextIDs []int, startAt, maxResults int) (*model.CustomFieldContextProjectMappingPageScheme, *model.ResponseScheme, error)

ProjectsContext returns a paginated list of context to project mappings for a custom field.

1. The result can be filtered by contextID, or otherwise all mappings are returned.

2. Invalid IDs are ignored.

GET /rest/api/{2-3}/field/{fieldID}/context/projectmapping

Docs: TODO: The documentation needs to be created, raise a ticket here: https://github.com/m1keru/go-atlassian/issues

func (*IssueFieldContextService) RemoveIssueTypes 

func (i *IssueFieldContextService) RemoveIssueTypes(ctx context.Context, fieldID string, contextID int, issueTypesIDs []string) (*model.ResponseScheme, error)

RemoveIssueTypes removes issue types from a custom field context. A custom field context without any issue types applies to all issue types.

POST /rest/api/{2-3}/field/{fieldID}/context/{contextID}/issuetype/remove

https://docs.go-atlassian.io/jira-software-cloud/issues/fields/context#remove-issue-types-from-context

func (*IssueFieldContextService) SetDefaultValue 

func (i *IssueFieldContextService) SetDefaultValue(ctx context.Context, fieldID string, payload *model.FieldContextDefaultPayloadScheme) (*model.ResponseScheme, error)

SetDefaultValue sets default for contexts of a custom field.

PUT /rest/api/{2-3}/field/{fieldID}/context/defaultValue

https://docs.go-atlassian.io/jira-software-cloud/issues/fields/context#set-custom-field-contexts-default-values 

func (i *IssueFieldContextService) UnLink(ctx context.Context, fieldID string, contextID int, projectIDs []string) (*model.ResponseScheme, error)

UnLink removes a custom field context from projects.

1. A custom field context without any projects applies to all projects.

2. Removing all projects from a custom field context would result in it applying to all projects.

POST /rest/api/{2-3}/field/{fieldID}/context/{contextID}/project/remove

https://docs.go-atlassian.io/jira-software-cloud/issues/fields/context#remove-custom-field-context-from-projects

func (*IssueFieldContextService) Update 

func (i *IssueFieldContextService) Update(ctx context.Context, fieldID string, contextID int, name, description string) (*model.ResponseScheme, error)

Update updates a custom field context

PUT /rest/api/{2-3}/field/{fieldID}/context/{contextID}

https://docs.go-atlassian.io/jira-software-cloud/issues/fields/context#update-custom-field-context

type IssueFieldService 

type IssueFieldService struct {

	// Configuration is the service for managing field configurations.
	Configuration *IssueFieldConfigService
	// Context is the service for managing field contexts.
	Context *IssueFieldContextService
	// Trash is the service for managing trashed fields.
	Trash *IssueFieldTrashService
	// contains filtered or unexported fields
}

IssueFieldService provides methods to manage issue fields in Jira Service Management.

func NewIssueFieldService 

func NewIssueFieldService(client service.Connector, version string, configuration *IssueFieldConfigService, context *IssueFieldContextService,
	trash *IssueFieldTrashService) (*IssueFieldService, error)

NewIssueFieldService creates a new instance of IssueFieldService. It takes a service.Connector, a version string, an IssueFieldConfigService, an IssueFieldContextService, and an IssueFieldTrashService as input. Returns a pointer to IssueFieldService and an error if the version is not provided.

func (*IssueFieldService) Create 

func (i *IssueFieldService) Create(ctx context.Context, payload *model.CustomFieldScheme) (*model.IssueFieldScheme, *model.ResponseScheme, error)

Create creates a custom field.

POST /rest/api/{2-3}/field

https://docs.go-atlassian.io/jira-software-cloud/issues/fields#create-custom-field

func (*IssueFieldService) Delete 

func (i *IssueFieldService) Delete(ctx context.Context, fieldID string) (*model.TaskScheme, *model.ResponseScheme, error)

Delete deletes a custom field. The custom field is deleted whether it is in the trash or not.

See Edit or delete a custom field for more information on trashing and deleting custom fields.

DELETE /rest/api/{2-3}/field/{id}

https://docs.go-atlassian.io/jira-software-cloud/issues/fields#delete-field

func (*IssueFieldService) Gets 

func (i *IssueFieldService) Gets(ctx context.Context) ([]*model.IssueFieldScheme, *model.ResponseScheme, error)

Gets returns system and custom issue fields according to the following rules:

1. Fields that cannot be added to the issue navigator are always returned.

2. Fields that cannot be placed on an issue screen are always returned.

3. Fields that depend on global Jira settings are only returned if the setting is enabled. That is, timetracking fields, subtasks, votes, and watches.

4. For all other fields, this operation only returns the fields that the user has permission to view

GET /rest/api/{2-3}/field

https://docs.go-atlassian.io/jira-software-cloud/issues/fields#get-fields

func (*IssueFieldService) Search 

func (i *IssueFieldService) Search(ctx context.Context, options *model.FieldSearchOptionsScheme, startAt, maxResults int) (*model.FieldSearchPageScheme, *model.ResponseScheme, error)

Search returns a paginated list of fields for Classic Jira projects.

GET /rest/api/{2-3}/field/search

https://docs.go-atlassian.io/jira-software-cloud/issues/fields#get-fields-paginated

type IssueFieldTrashService 

type IssueFieldTrashService struct {
	// contains filtered or unexported fields
}

IssueFieldTrashService provides methods to manage trashed fields in Jira Service Management.

func NewIssueFieldTrashService 

func NewIssueFieldTrashService(client service.Connector, version string) (*IssueFieldTrashService, error)

NewIssueFieldTrashService creates a new instance of IssueFieldTrashService. It takes a service.Connector and a version string as input. Returns a pointer to IssueFieldTrashService and an error if the version is not provided.

func (*IssueFieldTrashService) Move 

func (i *IssueFieldTrashService) Move(ctx context.Context, id string) (*model.ResponseScheme, error)

Move moves a custom field to trash.

See Edit or delete a custom field for more information on trashing and deleting custom fields.

POST /rest/api/{2-3}/field/{id}/trash

https://docs.go-atlassian.io/jira-software-cloud/issues/fields/trash#move-field-to-trash

func (*IssueFieldTrashService) Restore 

func (i *IssueFieldTrashService) Restore(ctx context.Context, id string) (*model.ResponseScheme, error)

Restore restores a custom field from trash.

See Edit or delete a custom field for more information on trashing and deleting custom fields.

POST /rest/api/{2-3}/field/{id}/restore

https://docs.go-atlassian.io/jira-software-cloud/issues/fields/trash#move-field-to-trash

func (*IssueFieldTrashService) Search 

func (i *IssueFieldTrashService) Search(ctx context.Context, options *model.FieldSearchOptionsScheme, startAt, maxResults int) (*model.FieldSearchPageScheme, *model.ResponseScheme, error)

Search returns a paginated list of fields in the trash.

The list may be restricted to field whose field name or description partially match a string.

Only custom fields can be queried, type must be set to custom.

GET /rest/api/{2-3}/field/search/trashed

https://docs.go-atlassian.io/jira-software-cloud/issues/fields/trash#search-fields-in-trash

type IssuePropertyService 

type IssuePropertyService struct {
	// contains filtered or unexported fields
}

IssuePropertyService handles the issue property methods for the Jira Cloud REST API.

func NewIssuePropertyService 

func NewIssuePropertyService(client service.Connector, version string) (*IssuePropertyService, error)

NewIssuePropertyService creates a new instance of the IssuePropertyService.

func (*IssuePropertyService) Delete 

func (i *IssuePropertyService) Delete(ctx context.Context, issueKeyOrID, propertyKey string) (*model.ResponseScheme, error)

Delete deletes an issue's property.

  • This operation can be accessed anonymously.

Permissions required:

  • Browse projects and Edit issues project permissions for the project containing the issue.
  • If issue-level security is configured, issue-level security permission to view the issue.

Endpoint: DELETE /rest/api/{apiVersion}/issue/{issueKeyOrID}/properties/{propertyKey}

You can refer to the documentation: Delete issue property

func (*IssuePropertyService) Get 

func (i *IssuePropertyService) Get(ctx context.Context, issueKeyOrID, propertyKey string) (*model.EntityPropertyScheme, *model.ResponseScheme, error)

Get returns the key and value of an issue's property.

  • This operation can be accessed anonymously.

Permissions required:

  • Browse projects project permission for the project containing the issue.
  • If issue-level security is configured, issue-level security permission to view the issue.

Endpoint: GET /rest/api/{apiVersion}/issue/{issueKeyOrID}/properties/{propertyKey}

You can refer to the documentation: Get issue property

func (*IssuePropertyService) Gets 

func (i *IssuePropertyService) Gets(ctx context.Context, issueKeyOrID string) (*model.PropertyPageScheme, *model.ResponseScheme, error)

Gets returns the URLs and keys of an issue's properties.

  • This operation can be accessed anonymously.

Permissions required:

  • Browse projects project permission for the project containing the issue.
  • If issue-level security is configured, issue-level security permission to view the issue.

Endpoint: GET /rest/api/{apiVersion}/issue/{issueKeyOrID}/properties

You can refer to the documentation: Get issue property keys

func (*IssuePropertyService) Set 

func (i *IssuePropertyService) Set(ctx context.Context, issueKeyOrID, propertyKey string, payload interface{}) (*model.ResponseScheme, error)

Set sets the value of an issue's property. Use this resource to store custom data against an issue.

  • The value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.
  • This operation can be accessed anonymously.

Permissions required:

  • Browse projects and Edit issues project permissions for the project containing the issue.
  • If issue-level security is configured, issue-level security permission to view the issue.

Endpoint: PUT /rest/api/{apiVersion}/issue/{issueKeyOrID}/properties/{propertyKey}

You can refer to the documentation: Set issue property

type IssueRichTextService 

type IssueRichTextService struct {

	// Attachment is the service for managing issue attachments.
	Attachment *IssueAttachmentService
	// Comment is the service for managing rich text comments.
	Comment *CommentRichTextService
	// Field is the service for managing issue fields.
	Field *IssueFieldService
	// Label is the service for managing issue labels.
	Label *LabelService
	// Link is the service for managing rich text issue links.
	Link *LinkRichTextService
	// Metadata is the service for managing issue metadata.
	Metadata *MetadataService
	// Priority is the service for managing issue priorities.
	Priority *PriorityService
	// Resolution is the service for managing issue resolutions.
	Resolution *ResolutionService
	// Search is the service for managing rich text issue searches.
	Search *SearchRichTextService
	// Type is the service for managing issue types.
	Type *TypeService
	// Vote is the service for managing issue votes.
	Vote *VoteService
	// Watcher is the service for managing issue watchers.
	Watcher *WatcherService
	// Worklog is the service for managing rich text worklogs.
	Worklog *WorklogRichTextService
	// Property is the service for managing issue properties.
	Property *IssuePropertyService
	// contains filtered or unexported fields
}

IssueRichTextService provides methods to manage issues in Jira Service Management using the rich text format.

func (IssueRichTextService) Assign 

func (i IssueRichTextService) Assign(ctx context.Context, issueKeyOrID, accountID string) (*model.ResponseScheme, error)

Assign assigns an issue to a user.

Use this operation when the calling user does not have the Edit Issues permission but has the

Assign issue permission for the project that the issue is in.

If accountID is set to:

  1. "-1", the issue is assigned to the default assignee for the project.
  2. null, the issue is set to unassigned.

PUT /rest/api/{2-3}/issue/{issueKeyOrID}/assignee

https://docs.go-atlassian.io/jira-software-cloud/issues#assign-issue

func (IssueRichTextService) Create 

func (i IssueRichTextService) Create(ctx context.Context, payload *model.IssueSchemeV2, customFields *model.CustomFields) (*model.IssueResponseScheme, *model.ResponseScheme, error)

Create creates an issue or, where the option to create subtasks is enabled in Jira, a subtask.

POST /rest/api/{2-3}/issue

https://docs.go-atlassian.io/jira-software-cloud/issues#create-issue

func (IssueRichTextService) Creates 

func (i IssueRichTextService) Creates(ctx context.Context, payload []*model.IssueBulkSchemeV2) (*model.IssueBulkResponseScheme, *model.ResponseScheme, error)

Creates issues and, where the option to create subtasks is enabled in Jira, subtasks.

1.Creates upto 50 issues and, where the option to create subtasks is enabled in Jira, subtasks.

2.Transitions may be applied, to move the issues or subtasks to a workflow step other than the default start step, and issue properties set.

POST /rest/api/{2-3}/issue/bulk

https://docs.go-atlassian.io/jira-software-cloud/issues#bulk-create-issue

func (IssueRichTextService) Delete 

func (i IssueRichTextService) Delete(ctx context.Context, issueKeyOrID string, deleteSubTasks bool) (*model.ResponseScheme, error)

Delete deletes an issue.

1.An issue cannot be deleted if it has one or more subtasks.

2.To delete an issue with subtasks, set deleteSubtasks.

3.This causes the issue's subtasks to be deleted with the issue.

DELETE /rest/api/{2-3}/issue/{issueKeyOrID}

https://docs.go-atlassian.io/jira-software-cloud/issues#delete-issue

func (IssueRichTextService) Get 

func (i IssueRichTextService) Get(ctx context.Context, issueKeyOrID string, fields, expand []string) (*model.IssueSchemeV2, *model.ResponseScheme, error)

Get returns the details for an issue.

The issue is identified by its ID or key, however, if the identifier doesn't match an issue, a case-insensitive search

and check for moved issues is performed. If a matching issue is found its details are returned, a 302 or other redirect is not returned.

The issue key returned to the response is the key of the issue found.

GET /rest/api/{2-3}/issue/{issueKeyOrID}

https://docs.go-atlassian.io/jira-software-cloud/issues#get-issue

func (IssueRichTextService) Move 

func (i IssueRichTextService) Move(ctx context.Context, issueKeyOrID, transitionID string, options *model.IssueMoveOptionsV2) (*model.ResponseScheme, error)

Move performs an issue transition and, if the transition has a screen, updates the fields from the transition screen.

sortByCategory To update the fields on the transition screen, specify the fields in the fields or update parameters in the request body. Get details about the fields using Get transitions with the transitions.fields expand.

POST /rest/api/{2-3}/issue/{issueKeyOrID}/transitions

https://docs.go-atlassian.io/jira-software-cloud/issues#transition-issue

func (IssueRichTextService) Notify 

func (i IssueRichTextService) Notify(ctx context.Context, issueKeyOrID string, options *model.IssueNotifyOptionsScheme) (*model.ResponseScheme, error)

Notify creates an email notification for an issue and adds it to the mail queue.

POST /rest/api/{2-3}/issue/{issueKeyOrID}/notify

https://docs.go-atlassian.io/jira-software-cloud/issues#send-notification-for-issue

func (IssueRichTextService) Transitions 

func (i IssueRichTextService) Transitions(ctx context.Context, issueKeyOrID string) (*model.IssueTransitionsScheme, *model.ResponseScheme, error)

Transitions returns either all transitions or a transition that can be performed by the user on an issue, based on the issue's status.

Note, if a request is made for a transition that does not exist or cannot be performed on the issue,

given its status, the response will return any empty transitions list.

GET /rest/api/{2-3}/issue/{issueKeyOrID}/transitions

https://docs.go-atlassian.io/jira-software-cloud/issues#get-transitions

func (IssueRichTextService) Update 

func (i IssueRichTextService) Update(ctx context.Context, issueKeyOrID string, notify bool, payload *model.IssueSchemeV2, customFields *model.CustomFields, operations *model.UpdateOperations) (*model.ResponseScheme, error)

Update edits an issue.

Edits an issue. A transition may be applied and issue properties updated as part of the edit.

The edits to the issue's fields are defined using update and fields

PUT /rest/api/{2-3}/issue/{issueKeyOrID}

https://docs.go-atlassian.io/jira-software-cloud/issues#edit-issue

type IssueServices 

type IssueServices struct {
	// Attachment is the service for managing issue attachments.
	Attachment *IssueAttachmentService
	// CommentRT is the service for managing rich text comments.
	CommentRT *CommentRichTextService
	// CommentADF is the service for managing ADF comments.
	CommentADF *CommentADFService
	// Field is the service for managing issue fields.
	Field *IssueFieldService
	// Label is the service for managing issue labels.
	Label *LabelService
	// LinkRT is the service for managing rich text issue links.
	LinkRT *LinkRichTextService
	// LinkADF is the service for managing ADF issue links.
	LinkADF *LinkADFService
	// Metadata is the service for managing issue metadata.
	Metadata *MetadataService
	// Priority is the service for managing issue priorities.
	Priority *PriorityService
	// Resolution is the service for managing issue resolutions.
	Resolution *ResolutionService
	// SearchRT is the service for managing rich text issue searches.
	SearchRT *SearchRichTextService
	// SearchADF is the service for managing ADF issue searches.
	SearchADF *SearchADFService
	// Type is the service for managing issue types.
	Type *TypeService
	// Vote is the service for managing issue votes.
	Vote *VoteService
	// Watcher is the service for managing issue watchers.
	Watcher *WatcherService
	// WorklogAdf is the service for managing ADF worklogs.
	WorklogAdf *WorklogADFService
	// WorklogRichText is the service for managing rich text worklogs.
	WorklogRichText *WorklogRichTextService
	// Property is the service for managing issue properties.
	Property *IssuePropertyService
}

IssueServices groups various services related to issue management in Jira Service Management.

type JQLService 

type JQLService struct {
	// contains filtered or unexported fields
}

JQLService provides methods to manage JQL queries in Jira Service Management.

func NewJQLService 

func NewJQLService(client service.Connector, version string) (*JQLService, error)

NewJQLService creates a new instance of JQLService.

func (*JQLService) Parse 

func (j *JQLService) Parse(ctx context.Context, validationType string, JqlQueries []string) (*model.ParsedQueryPageScheme, *model.ResponseScheme, error)

Parse parses and validates JQL queries.

Validation is performed in context of the current user.

POST /rest/api/{2-3}/jql/parse

https://docs.go-atlassian.io/jira-software-cloud/jql#parse-jql-query

type LabelService 

type LabelService struct {
	// contains filtered or unexported fields
}

LabelService provides methods to manage labels in Jira Service Management.

func NewLabelService 

func NewLabelService(client service.Connector, version string) (*LabelService, error)

NewLabelService creates a new instance of LabelService.

func (*LabelService) Gets 

func (i *LabelService) Gets(ctx context.Context, startAt, maxResults int) (*model.IssueLabelsScheme, *model.ResponseScheme, error)

Gets returns a paginated list of labels.

GET /rest/api/{2-3}/label

https://docs.go-atlassian.io/jira-software-cloud/issues/labels#get-all-labels

type LinkADFService 

type LinkADFService struct {
	Type   *LinkTypeService
	Remote *RemoteLinkService
	// contains filtered or unexported fields
}

func (*LinkADFService) Create 

func (l *LinkADFService) Create(ctx context.Context, payload *model.LinkPayloadSchemeV3) (*model.ResponseScheme, error)

Create creates a link between two issues. Use this operation to indicate a relationship between two issues

and optionally add a comment to the form (outward) issue.

To use this resource the site must have Issue Linking enabled.

https://docs.go-atlassian.io/jira-software-cloud/issues/link#create-issue-link

func (*LinkADFService) Delete 

func (l *LinkADFService) Delete(ctx context.Context, linkID string) (*model.ResponseScheme, error)

Delete deletes an issue link.

DELETE /rest/api/{2-3}/issueLink/{linkID}

https://docs.go-atlassian.io/jira-software-cloud/issues/link#delete-issue-link

func (*LinkADFService) Get 

func (l *LinkADFService) Get(ctx context.Context, linkID string) (*model.IssueLinkScheme, *model.ResponseScheme, error)

Get returns an issue link.

GET /rest/api/{2-3}/issueLink/{linkID}

https://docs.go-atlassian.io/jira-software-cloud/issues/link#get-issue-link

func (*LinkADFService) Gets 

func (l *LinkADFService) Gets(ctx context.Context, issueKeyOrID string) (*model.IssueLinkPageScheme, *model.ResponseScheme, error)

Gets get the issue links ID's associated with a Jira Issue

https://docs.go-atlassian.io/jira-software-cloud/issues/link#get-issue-links

type LinkRichTextService 

type LinkRichTextService struct {

	// Type is the service for managing link types.
	Type *LinkTypeService
	// Remote is the service for managing remote links.
	Remote *RemoteLinkService
	// contains filtered or unexported fields
}

LinkRichTextService provides methods to manage issue links in Jira Service Management using the rich text format.

func (*LinkRichTextService) Create 

func (l *LinkRichTextService) Create(ctx context.Context, payload *model.LinkPayloadSchemeV2) (*model.ResponseScheme, error)

Create creates a link between two issues. Use this operation to indicate a relationship between two issues

and optionally add a comment to the from (outward) issue.

To use this resource the site must have Issue Linking enabled.

https://docs.go-atlassian.io/jira-software-cloud/issues/link#create-issue-link

func (*LinkRichTextService) Delete 

func (l *LinkRichTextService) Delete(ctx context.Context, linkID string) (*model.ResponseScheme, error)

Delete deletes an issue link.

DELETE /rest/api/{2-3}/issueLink/{linkID}

https://docs.go-atlassian.io/jira-software-cloud/issues/link#delete-issue-link

func (*LinkRichTextService) Get 

func (l *LinkRichTextService) Get(ctx context.Context, linkID string) (*model.IssueLinkScheme, *model.ResponseScheme, error)

Get returns an issue link.

GET /rest/api/{2-3}/issueLink/{linkID}

https://docs.go-atlassian.io/jira-software-cloud/issues/link#get-issue-link

func (*LinkRichTextService) Gets 

func (l *LinkRichTextService) Gets(ctx context.Context, issueKeyOrID string) (*model.IssueLinkPageScheme, *model.ResponseScheme, error)

Gets get the issue links ID's associated with a Jira Issue

https://docs.go-atlassian.io/jira-software-cloud/issues/link#get-issue-links

type LinkTypeService 

type LinkTypeService struct {
	// contains filtered or unexported fields
}

LinkTypeService provides methods to manage issue link types in Jira Service Management.

func NewLinkTypeService 

func NewLinkTypeService(client service.Connector, version string) (*LinkTypeService, error)

NewLinkTypeService creates a new instance of LinkTypeService.

func (*LinkTypeService) Create 

func (l *LinkTypeService) Create(ctx context.Context, payload *model.LinkTypeScheme) (*model.LinkTypeScheme, *model.ResponseScheme, error)

Create creates an issue link type.

Use this operation to create descriptions of the reasons why issues are linked.

The issue link type consists of a name and descriptions for a link's inward and outward relationships.

POST /rest/api/{2-3}/issueLinkType

https://docs.go-atlassian.io/jira-software-cloud/issues/link/types#create-issue-link-type

func (*LinkTypeService) Delete 

func (l *LinkTypeService) Delete(ctx context.Context, issueLinkTypeID string) (*model.ResponseScheme, error)

Delete deletes an issue link type.

DELETE /rest/api/{2-3}/issueLinkType/{issueLinkTypeID}

https://docs.go-atlassian.io/jira-software-cloud/issues/link/types#delete-issue-link-type

func (*LinkTypeService) Get 

func (l *LinkTypeService) Get(ctx context.Context, issueLinkTypeID string) (*model.LinkTypeScheme, *model.ResponseScheme, error)

Get returns an issue link type.

GET /rest/api/{2-3}/issueLinkType/{issueLinkTypeID}

https://docs.go-atlassian.io/jira-software-cloud/issues/link/types#get-issue-link-type

func (*LinkTypeService) Gets 

func (l *LinkTypeService) Gets(ctx context.Context) (*model.IssueLinkTypeSearchScheme, *model.ResponseScheme, error)

Gets returns a list of all issue link types.

GET /rest/api/{2-3}/issueLinkType

https://docs.go-atlassian.io/jira-software-cloud/issues/link/types#get-issue-link-types

func (*LinkTypeService) Update 

func (l *LinkTypeService) Update(ctx context.Context, issueLinkTypeID string, payload *model.LinkTypeScheme) (*model.LinkTypeScheme, *model.ResponseScheme, error)

Update updates an issue link type.

PUT /rest/api/{2-3}/issueLinkType/{issueLinkTypeID}

https://docs.go-atlassian.io/jira-software-cloud/issues/link/types#update-issue-link-type

type MetadataService 

type MetadataService struct {
	// contains filtered or unexported fields
}

MetadataService provides methods to manage metadata in Jira Service Management.

func NewMetadataService 

func NewMetadataService(client service.Connector, version string) (*MetadataService, error)

NewMetadataService creates a new instance of MetadataService.

func (*MetadataService) Create 

func (m *MetadataService) Create(ctx context.Context, opts *model.IssueMetadataCreateOptions) (gjson.Result, *model.ResponseScheme, error)

Create returns details of projects, issue types within projects, and, when requested,

the create screen fields for each issue type for the user.

GET /rest/api/{2-3}/issue/createmeta

https://docs.go-atlassian.io/jira-software-cloud/issues/metadata#get-create-issue-metadata

func (*MetadataService) Get 

func (m *MetadataService) Get(ctx context.Context, issueKeyOrID string, overrideScreenSecurity, overrideEditableFlag bool) (gjson.Result, *model.ResponseScheme, error)

Get edit issue metadata returns the edit screen fields for an issue that are visible to and editable by the user.

Use the information to populate the requests in Edit issue.

GET /rest/api/{2-3}/issue/{issueKeyOrID}/editmeta

https://docs.go-atlassian.io/jira-software-cloud/issues/metadata#get-edit-issue-metadata

type MySelfService 

type MySelfService struct {
	// contains filtered or unexported fields
}

MySelfService provides methods to manage the current user's details in Jira Service Management.

func NewMySelfService 

func NewMySelfService(client service.Connector, version string) (*MySelfService, error)

NewMySelfService creates a new instance of MySelfService.

func (*MySelfService) Details 

func (m *MySelfService) Details(ctx context.Context, expand []string) (*model.UserScheme, *model.ResponseScheme, error)

Details returns details for the current user.

GET /rest/api/{2-3}/myself

https://docs.go-atlassian.io/jira-software-cloud/myself#get-current-user

type NotificationSchemeService 

type NotificationSchemeService struct {
	// contains filtered or unexported fields
}

NotificationSchemeService provides methods to manage notification schemes in Jira Service Management.

func NewNotificationSchemeService 

func NewNotificationSchemeService(client service.Connector, version string) (*NotificationSchemeService, error)

NewNotificationSchemeService creates a new instance of NotificationSchemeService.

func (*NotificationSchemeService) Append 

func (n *NotificationSchemeService) Append(ctx context.Context, schemeID string, payload *model.NotificationSchemeEventsPayloadScheme) (*model.ResponseScheme, error)

Append adds notifications to a notification scheme.

You can add up to 1000 notifications per request.

PUT /rest/api/{2-3}/notificationscheme/{id}/notification

https://docs.go-atlassian.io/jira-software-cloud/projects/notification-schemes#append-notifications-to-scheme

func (*NotificationSchemeService) Create 

func (n *NotificationSchemeService) Create(ctx context.Context, payload *model.NotificationSchemePayloadScheme) (*model.NotificationSchemeCreatedPayload, *model.ResponseScheme, error)

Create creates a notification scheme with notifications. You can create up to 1000 notifications per request.

POST /rest/api/{2-3}/notificationscheme

https://docs.go-atlassian.io/jira-software-cloud/projects/notification-schemes#create-notification-scheme

func (*NotificationSchemeService) Delete 

func (n *NotificationSchemeService) Delete(ctx context.Context, schemeID string) (*model.ResponseScheme, error)

Delete deletes a notification scheme.

DELETE /rest/api/{2-3}/notificationscheme/{notificationSchemeId}

https://docs.go-atlassian.io/jira-software-cloud/projects/notification-schemes#delete-notification-scheme

func (*NotificationSchemeService) Get 

func (n *NotificationSchemeService) Get(ctx context.Context, schemeID string, expand []string) (*model.NotificationSchemeScheme, *model.ResponseScheme, error)

Get returns a notification scheme, including the list of events and the recipients who will

receive notifications for those events.

GET /rest/api/{2-3}/notificationscheme/{id}

https://docs.go-atlassian.io/jira-software-cloud/projects/notification-schemes#get-notification-scheme

func (*NotificationSchemeService) Projects 

func (n *NotificationSchemeService) Projects(ctx context.Context, schemeIDs, projectIDs []string, startAt, maxResults int) (*model.NotificationSchemeProjectPageScheme, *model.ResponseScheme, error)

Projects returns a paginated mapping of project that have notification scheme assigned.

You can provide either one or multiple notification scheme IDs or project IDs to filter by.

If you don't provide any, this will return a list of all mappings.

Note that only company-managed (classic) projects are supported.

This is because team-managed projects don't have a concept of a default notification scheme.

The mappings are ordered by projectID.

GET /rest/api/{2-3}/notificationscheme/project

func (*NotificationSchemeService) Remove 

func (n *NotificationSchemeService) Remove(ctx context.Context, schemeID, notificationID string) (*model.ResponseScheme, error)

Remove removes a notification from a notification scheme.

DELETE /rest/api/{2-3}/notificationscheme/{notificationSchemeId}/notification/{notificationId}

https://docs.go-atlassian.io/jira-software-cloud/projects/notification-schemes#remove-notifications-to-scheme

func (*NotificationSchemeService) Search 

func (n *NotificationSchemeService) Search(ctx context.Context, options *model.NotificationSchemeSearchOptions, startAt, maxResults int) (*model.NotificationSchemePageScheme, *model.ResponseScheme, error)

Search returns a paginated list of notification schemes ordered by the display name.

GET /rest/api/{2-3}/notificationscheme

https://docs.go-atlassian.io/jira-software-cloud/projects/notification-schemes#get-notification-schemes

func (*NotificationSchemeService) Update 

func (n *NotificationSchemeService) Update(ctx context.Context, schemeID string, payload *model.NotificationSchemePayloadScheme) (*model.ResponseScheme, error)

Update updates a notification scheme.

PUT /rest/api/{2-3}/notificationscheme/{id}

https://docs.go-atlassian.io/jira-software-cloud/projects/notification-schemes#update-notification-scheme

type PermissionSchemeGrantService 

type PermissionSchemeGrantService struct {
	// contains filtered or unexported fields
}

PermissionSchemeGrantService provides methods to manage permission scheme grants in Jira Service Management.

func NewPermissionSchemeGrantService 

func NewPermissionSchemeGrantService(client service.Connector, version string) (*PermissionSchemeGrantService, error)

NewPermissionSchemeGrantService creates a new instance of PermissionSchemeGrantService.

func (*PermissionSchemeGrantService) Create 

func (p *PermissionSchemeGrantService) Create(ctx context.Context, permissionSchemeID int, payload *model.PermissionGrantPayloadScheme) (*model.PermissionGrantScheme, *model.ResponseScheme, error)

Create creates a permission grant in a permission scheme.

POST /rest/api/{2-3}/permissionscheme/{permissionSchemeID}/permission

https://docs.go-atlassian.io/jira-software-cloud/permissions/scheme/grant#create-permission-grant

func (*PermissionSchemeGrantService) Delete 

func (p *PermissionSchemeGrantService) Delete(ctx context.Context, permissionSchemeID, permissionGrantID int) (*model.ResponseScheme, error)

Delete deletes a permission grant from a permission scheme. See About permission schemes and grants for more details.

DELETE /rest/api/{2-3}/permissionscheme/{permissionSchemeID}/permission/{permissionGrantID}

https://docs.go-atlassian.io/jira-software-cloud/permissions/scheme/grant#delete-permission-scheme-grant

func (*PermissionSchemeGrantService) Get 

func (p *PermissionSchemeGrantService) Get(ctx context.Context, permissionSchemeID, permissionGrantID int, expand []string) (*model.PermissionGrantScheme, *model.ResponseScheme, error)

Get returns a permission grant.

GET /rest/api/{2-3}/permissionscheme/{permissionSchemeID}/permission/{permissionGrantID}

https://docs.go-atlassian.io/jira-software-cloud/permissions/scheme/grant#get-permission-scheme-grant

func (*PermissionSchemeGrantService) Gets 

func (p *PermissionSchemeGrantService) Gets(ctx context.Context, permissionSchemeID int, expand []string) (*model.PermissionSchemeGrantsScheme, *model.ResponseScheme, error)

Gets returns all permission grants for a permission scheme.

GET /rest/api/{2-3}/permissionscheme/{permissionSchemeID}/permission

https://docs.go-atlassian.io/jira-software-cloud/permissions/scheme/grant#get-permission-scheme-grants

type PermissionSchemeService 

type PermissionSchemeService struct {

	// Grant is the service for managing permission scheme grants.
	Grant *PermissionSchemeGrantService
	// contains filtered or unexported fields
}

PermissionSchemeService provides methods to manage permission schemes in Jira Service Management.

func NewPermissionSchemeService 

func NewPermissionSchemeService(client service.Connector, version string, grant *PermissionSchemeGrantService) (*PermissionSchemeService, error)

NewPermissionSchemeService creates a new instance of PermissionSchemeService.

func (*PermissionSchemeService) Create 

func (p *PermissionSchemeService) Create(ctx context.Context, payload *model.PermissionSchemeScheme) (*model.PermissionSchemeScheme, *model.ResponseScheme, error)

Create creates a new permission scheme.

You can create a permission scheme with or without defining a set of permission grants.

POST /rest/api/{2-3}/permissionscheme

https://docs.go-atlassian.io/jira-software-cloud/permissions/scheme#create-permission-scheme

func (*PermissionSchemeService) Delete 

func (p *PermissionSchemeService) Delete(ctx context.Context, permissionSchemeID int) (*model.ResponseScheme, error)

Delete deletes a permission scheme.

DELETE /rest/api/{2-3}/permissionscheme/{permissionSchemeID}

https://docs.go-atlassian.io/jira-software-cloud/permissions/scheme#delete-permission-scheme

func (*PermissionSchemeService) Get 

func (p *PermissionSchemeService) Get(ctx context.Context, permissionSchemeID int, expand []string) (*model.PermissionSchemeScheme, *model.ResponseScheme, error)

Get returns a permission scheme.

GET /rest/api/{2-3}/permissionscheme/{permissionSchemeID}

https://docs.go-atlassian.io/jira-software-cloud/permissions/scheme#get-permission-scheme

func (*PermissionSchemeService) Gets 

func (p *PermissionSchemeService) Gets(ctx context.Context) (*model.PermissionSchemePageScheme, *model.ResponseScheme, error)

Gets returns all permission schemes.

GET /rest/api/{2-3}/permissionscheme

https://docs.go-atlassian.io/jira-software-cloud/permissions/scheme#get-all-permission-schemes

func (*PermissionSchemeService) Update 

func (p *PermissionSchemeService) Update(ctx context.Context, permissionSchemeID int, payload *model.PermissionSchemeScheme) (*model.PermissionSchemeScheme, *model.ResponseScheme, error)

Update updates a permission scheme. Below are some important things to note when using this resource:

1. If a permissions list is present in the request, then it is set in the permission scheme, overwriting all existing grants.

2. If you want to update only the name and description, then do not send a permissions list in the request.

3. Sending an empty list will remove all permission grants from the permission scheme.

PUT /rest/api/{2-3}/permissionscheme/{permissionSchemeID}

https://docs.go-atlassian.io/jira-software-cloud/permissions/scheme#update-permission-scheme

type PermissionService 

type PermissionService struct {

	// Scheme is the service for managing permission schemes.
	Scheme *PermissionSchemeService
	// contains filtered or unexported fields
}

PermissionService provides methods to manage permissions in Jira Service Management.

func NewPermissionService 

func NewPermissionService(client service.Connector, version string, scheme *PermissionSchemeService) (*PermissionService, error)

NewPermissionService creates a new instance of PermissionService.

func (*PermissionService) Check 

func (p *PermissionService) Check(ctx context.Context, payload *model.PermissionCheckPayload) (*model.PermissionGrantsScheme, *model.ResponseScheme, error)

Check search the permissions linked to an accountID, then check if the user permissions.

POST /rest/api/{2-3}/permissions/check

https://docs.go-atlassian.io/jira-software-cloud/permissions#check-permissions

func (*PermissionService) Gets 

func (p *PermissionService) Gets(ctx context.Context) ([]*model.PermissionScheme, *model.ResponseScheme, error)

Gets returns all permissions, including: global permissions, project permissions and global permissions added by plugins.

GET /rest/api/{2-3}/permissions

https://docs.go-atlassian.io/jira-software-cloud/permissions#get-my-permissions

func (*PermissionService) Projects 

func (p *PermissionService) Projects(ctx context.Context, permissions []string) (*model.PermittedProjectsScheme, *model.ResponseScheme, error)

Projects returns all the projects where the user is granted a list of project permissions.

POST /rest/api/{2-3}/permissions/project

https://docs.go-atlassian.io/jira-software-cloud/permissions#get-permitted-projects

type PriorityService 

type PriorityService struct {
	// contains filtered or unexported fields
}

PriorityService provides methods to manage issue priorities in Jira Service Management.

func NewPriorityService 

func NewPriorityService(client service.Connector, version string) (*PriorityService, error)

NewPriorityService creates a new instance of PriorityService.

func (*PriorityService) Get 

func (p *PriorityService) Get(ctx context.Context, priorityID string) (*model.PriorityScheme, *model.ResponseScheme, error)

Get returns an issue priority.

GET /rest/api/{2-3}/priority/{priorityID}

https://docs.go-atlassian.io/jira-software-cloud/issues/priorities#get-priority

func (*PriorityService) Gets 

func (p *PriorityService) Gets(ctx context.Context) ([]*model.PriorityScheme, *model.ResponseScheme, error)

Gets returns the list of all issue priorities.

GET /rest/api/{2-3}/priority

https://docs.go-atlassian.io/jira-software-cloud/issues/priorities#get-priorities

type ProjectCategoryService 

type ProjectCategoryService struct {
	// contains filtered or unexported fields
}

ProjectCategoryService provides methods to manage project categories in Jira Service Management.

func NewProjectCategoryService 

func NewProjectCategoryService(client service.Connector, version string) (*ProjectCategoryService, error)

NewProjectCategoryService creates a new instance of ProjectCategoryService.

func (*ProjectCategoryService) Create 

func (p *ProjectCategoryService) Create(ctx context.Context, payload *model.ProjectCategoryPayloadScheme) (*model.ProjectCategoryScheme, *model.ResponseScheme, error)

Create creates a project category.

POST /rest/api/{2-3}/projectCategory

https://docs.go-atlassian.io/jira-software-cloud/projects/categories#create-project-category

func (*ProjectCategoryService) Delete 

func (p *ProjectCategoryService) Delete(ctx context.Context, categoryID int) (*model.ResponseScheme, error)

Delete deletes a project category.

DELETE /rest/api/{2-3}/projectCategory/{categoryID}

https://docs.go-atlassian.io/jira-software-cloud/projects/categories#delete-project-category

func (*ProjectCategoryService) Get 

func (p *ProjectCategoryService) Get(ctx context.Context, categoryID int) (*model.ProjectCategoryScheme, *model.ResponseScheme, error)

Get returns a project category.

GET /rest/api/{2-3}/projectCategory/{categoryID}

https://docs.go-atlassian.io/jira-software-cloud/projects/categories#get-project-category-by-id

func (*ProjectCategoryService) Gets 

func (p *ProjectCategoryService) Gets(ctx context.Context) ([]*model.ProjectCategoryScheme, *model.ResponseScheme, error)

Gets returns all project categories.

GET /rest/api/{2-3}/projectCategory

https://docs.go-atlassian.io/jira-software-cloud/projects/categories#get-all-project-categories

func (*ProjectCategoryService) Update 

func (p *ProjectCategoryService) Update(ctx context.Context, categoryID int, payload *model.ProjectCategoryPayloadScheme) (*model.ProjectCategoryScheme, *model.ResponseScheme, error)

Update updates a project category.

PUT /rest/api/{2-3}/projectCategory/{categoryID}

https://docs.go-atlassian.io/jira-software-cloud/projects/categories#update-project-category

type ProjectChildServices 

type ProjectChildServices struct {
	// Category is the service for managing project categories.
	Category *ProjectCategoryService
	// Component is the service for managing project components.
	Component *ProjectComponentService
	// Feature is the service for managing project features.
	Feature *ProjectFeatureService
	// Permission is the service for managing project permission schemes.
	Permission *ProjectPermissionSchemeService
	// Property is the service for managing project properties.
	Property *ProjectPropertyService
	// Role is the service for managing project roles.
	Role *ProjectRoleService
	// Type is the service for managing project types.
	Type *ProjectTypeService
	// Validator is the service for managing project validators.
	Validator *ProjectValidatorService
	// Version is the service for managing project versions.
	Version *ProjectVersionService
}

ProjectChildServices holds various child services related to project management in Jira Service Management.

type ProjectComponentService 

type ProjectComponentService struct {
	// contains filtered or unexported fields
}

ProjectComponentService provides methods to manage project components in Jira Service Management.

func NewProjectComponentService 

func NewProjectComponentService(client service.Connector, version string) (*ProjectComponentService, error)

NewProjectComponentService creates a new instance of ProjectComponentService.

func (*ProjectComponentService) Count 

func (p *ProjectComponentService) Count(ctx context.Context, componentID string) (*model.ComponentCountScheme, *model.ResponseScheme, error)

Count returns the counts of issues assigned to the component.

GET /rest/api/{2-3}/component/{componentID}/relatedIssueCounts

https://docs.go-atlassian.io/jira-software-cloud/projects/components#get-component-issues-count

func (*ProjectComponentService) Create 

func (p *ProjectComponentService) Create(ctx context.Context, payload *model.ComponentPayloadScheme) (*model.ComponentScheme, *model.ResponseScheme, error)

Create creates a component. Use components to provide containers for issues within a project.

POST /rest/api/{2-3}/component

https://docs.go-atlassian.io/jira-software-cloud/projects/components#create-component

func (*ProjectComponentService) Delete 

func (p *ProjectComponentService) Delete(ctx context.Context, componentID string) (*model.ResponseScheme, error)

Delete deletes a component.

DELETE /rest/api/{2-3}/component/{componentID}

https://docs.go-atlassian.io/jira-software-cloud/projects/components#delete-component

func (*ProjectComponentService) Get 

func (p *ProjectComponentService) Get(ctx context.Context, componentID string) (*model.ComponentScheme, *model.ResponseScheme, error)

Get returns a component.

GET /rest/api/{2-3}/component/{componentID}

https://docs.go-atlassian.io/jira-software-cloud/projects/components#get-component

func (*ProjectComponentService) Gets 

func (p *ProjectComponentService) Gets(ctx context.Context, projectKeyOrID string) ([]*model.ComponentScheme, *model.ResponseScheme, error)

Gets returns all components in a project.

GET /rest/api/{2-3}/project/{projectKeyOrID}/components

https://docs.go-atlassian.io/jira-software-cloud/projects/components#get-project-components

func (*ProjectComponentService) Update 

func (p *ProjectComponentService) Update(ctx context.Context, componentID string, payload *model.ComponentPayloadScheme) (*model.ComponentScheme, *model.ResponseScheme, error)

Update updates a component.

Any fields included in the request are overwritten

PUT /rest/api/{2-3}/component/{componentID}

https://docs.go-atlassian.io/jira-software-cloud/projects/components#update-component

type ProjectFeatureService 

type ProjectFeatureService struct {
	// contains filtered or unexported fields
}

ProjectFeatureService provides methods to manage project features in Jira Service Management.

func NewProjectFeatureService 

func NewProjectFeatureService(client service.Connector, version string) (*ProjectFeatureService, error)

NewProjectFeatureService creates a new instance of ProjectFeatureService.

func (*ProjectFeatureService) Gets 

func (p *ProjectFeatureService) Gets(ctx context.Context, projectKeyOrID string) (*model.ProjectFeaturesScheme, *model.ResponseScheme, error)

Gets returns the list of features for a project.

GET /rest/api/{2-3}/project/{projectKeyOrID}/features

https://docs.go-atlassian.io/jira-software-cloud/projects/features#get-project-features

func (*ProjectFeatureService) Set 

func (p *ProjectFeatureService) Set(ctx context.Context, projectKeyOrID, featureKey, state string) (*model.ProjectFeaturesScheme, *model.ResponseScheme, error)

Set sets the state of a project feature.

PUT /rest/api/{2-3}/project/{projectKeyOrID}/features/{featureKey}

https://docs.go-atlassian.io/jira-software-cloud/projects/features#set-project-feature-state

type ProjectPermissionSchemeService 

type ProjectPermissionSchemeService struct {
	// contains filtered or unexported fields
}

ProjectPermissionSchemeService provides methods to manage project permission schemes in Jira Service Management.

func NewProjectPermissionSchemeService 

func NewProjectPermissionSchemeService(client service.Connector, version string) (*ProjectPermissionSchemeService, error)

NewProjectPermissionSchemeService creates a new instance of ProjectPermissionSchemeService.

func (*ProjectPermissionSchemeService) Assign 

func (p *ProjectPermissionSchemeService) Assign(ctx context.Context, projectKeyOrID string, permissionSchemeID int) (*model.PermissionSchemeScheme, *model.ResponseScheme, error)

Assign assigns a permission scheme with a project.

See Managing project permissions for more information about permission schemes.

PUT /rest/api/{2-3}/project/{projectKeyOrID}/permissionscheme

func (*ProjectPermissionSchemeService) Get 

func (p *ProjectPermissionSchemeService) Get(ctx context.Context, projectKeyOrID string, expand []string) (*model.PermissionSchemeScheme, *model.ResponseScheme, error)

Get search the permission scheme associated with the project.

GET /rest/api/{2-3}/project/{projectKeyOrID}/permissionscheme

https://docs.go-atlassian.io/jira-software-cloud/projects/permission-schemes#get-assigned-permission-scheme

func (*ProjectPermissionSchemeService) SecurityLevels 

func (p *ProjectPermissionSchemeService) SecurityLevels(ctx context.Context, projectKeyOrID string) (*model.IssueSecurityLevelsScheme, *model.ResponseScheme, error)

SecurityLevels returns all issue security levels for the project that the user has access to.

GET /rest/api/{2-3}/project/{projectKeyOrID}/securitylevel

https://docs.go-atlassian.io/jira-software-cloud/projects/permission-schemes#get-project-issue-security-levels

type ProjectPropertyService 

type ProjectPropertyService struct {
	// contains filtered or unexported fields
}

ProjectPropertyService provides methods to manage project properties in Jira Service Management.

func NewProjectPropertyService 

func NewProjectPropertyService(client service.Connector, version string) (*ProjectPropertyService, error)

NewProjectPropertyService creates a new instance of ProjectPropertyService.

func (*ProjectPropertyService) Delete 

func (p *ProjectPropertyService) Delete(ctx context.Context, projectKeyOrID, propertyKey string) (*model.ResponseScheme, error)

Delete deletes the property from a project.

DELETE /rest/api/{2-3}/project/{projectKeyOrID}/properties/{propertyKey}

https://docs.go-atlassian.io/jira-software-cloud/projects/properties#delete-project-property

func (*ProjectPropertyService) Get 

func (p *ProjectPropertyService) Get(ctx context.Context, projectKeyOrID, propertyKey string) (*model.EntityPropertyScheme, *model.ResponseScheme, error)

Get returns the value of a project property.

GET /rest/api/{2-3}/project/{projectKeyOrID}/properties/{propertyKey}

https://docs.go-atlassian.io/jira-software-cloud/projects/properties#get-project-property

func (*ProjectPropertyService) Gets 

func (p *ProjectPropertyService) Gets(ctx context.Context, projectKeyOrID string) (*model.PropertyPageScheme, *model.ResponseScheme, error)

Gets returns all project property keys for the project.

GET /rest/api/{2-3}/project/{projectKeyOrID}/properties

https://docs.go-atlassian.io/jira-software-cloud/projects/properties#get-project-properties-keys

func (*ProjectPropertyService) Set 

func (p *ProjectPropertyService) Set(ctx context.Context, projectKeyOrID, propertyKey string, payload interface{}) (*model.ResponseScheme, error)

Set sets the value of the project property.

You can use project properties to store custom data against the project.

The value of the request body must be a valid, non-empty JSON blob.

The maximum length is 32768 characters.

PUT /rest/api/{2-3}/project/{projectKeyOrID}/properties/{propertyKey}

https://docs.go-atlassian.io/jira-software-cloud/projects/properties#set-project-property

type ProjectRoleActorService 

type ProjectRoleActorService struct {
	// contains filtered or unexported fields
}

ProjectRoleActorService provides methods to manage project role actors in Jira Service Management.

func NewProjectRoleActorService 

func NewProjectRoleActorService(client service.Connector, version string) (*ProjectRoleActorService, error)

NewProjectRoleActorService creates a new instance of ProjectRoleActorService.

func (*ProjectRoleActorService) Add 

func (p *ProjectRoleActorService) Add(ctx context.Context, projectKeyOrID string, roleID int, accountIDs, groups []string) (*model.ProjectRoleScheme, *model.ResponseScheme, error)

Add adds actors to a project role for the project.

POST /rest/api/{2-3}/project/{projectKeyOrID}/role/{roleID}

https://docs.go-atlassian.io/jira-software-cloud/projects/roles/actors#add-actors-to-project-role

func (*ProjectRoleActorService) Delete 

func (p *ProjectRoleActorService) Delete(ctx context.Context, projectKeyOrID string, roleID int, accountID, group string) (*model.ResponseScheme, error)

Delete deletes actors from a project role for the project.

DELETE /rest/api/{2-3}/project/{projectKeyOrID}/role/{roleID}

https://docs.go-atlassian.io/jira-software-cloud/projects/roles/actors#delete-actors-from-project-role

type ProjectRoleService 

type ProjectRoleService struct {

	// Actor is the service for managing project role actors.
	Actor *ProjectRoleActorService
	// contains filtered or unexported fields
}

ProjectRoleService provides methods to manage project roles in Jira Service Management.

func NewProjectRoleService 

func NewProjectRoleService(client service.Connector, version string, actor *ProjectRoleActorService) (*ProjectRoleService, error)

NewProjectRoleService creates a new instance of ProjectRoleService.

func (*ProjectRoleService) Create 

func (p *ProjectRoleService) Create(ctx context.Context, payload *model.ProjectRolePayloadScheme) (*model.ProjectRoleScheme, *model.ResponseScheme, error)

Create creates a new project role with no default actors.

POST /rest/api/{2-3}/role

https://docs.go-atlassian.io/jira-software-cloud/projects/roles#create-project-role

func (*ProjectRoleService) Details 

func (p *ProjectRoleService) Details(ctx context.Context, projectKeyOrID string) ([]*model.ProjectRoleDetailScheme, *model.ResponseScheme, error)

Details returns all project roles and the details for each role.

GET /rest/api/{2-3}/project/{projectKeyOrID}/roledetails

https://docs.go-atlassian.io/jira-software-cloud/projects/roles#get-project-role-details

func (*ProjectRoleService) Get 

func (p *ProjectRoleService) Get(ctx context.Context, projectKeyOrID string, roleID int) (*model.ProjectRoleScheme, *model.ResponseScheme, error)

Get returns a project role's details and actors associated with the project.

GET /rest/api/{2-3}/project/{projectKeyOrID}/role/{id}

https://docs.go-atlassian.io/jira-software-cloud/projects/roles#get-project-role-for-project

func (*ProjectRoleService) Gets 

func (p *ProjectRoleService) Gets(ctx context.Context, projectKeyOrID string) (*map[string]int, *model.ResponseScheme, error)

Gets returns a list of project roles for the project returning the name and self URL for each role.

GET /rest/api/{2-3}/project/{projectKeyOrID}/role

https://docs.go-atlassian.io/jira-software-cloud/projects/roles#get-project-roles-for-project

func (*ProjectRoleService) Global 

func (p *ProjectRoleService) Global(ctx context.Context) ([]*model.ProjectRoleScheme, *model.ResponseScheme, error)

Global gets a list of all project roles, complete with project role details and default actors.

GET /rest/api/{2-3}/role

https://docs.go-atlassian.io/jira-software-cloud/projects/roles#get-all-project-roles

type ProjectService 

type ProjectService struct {

	// Category is the service for managing project categories.
	Category *ProjectCategoryService
	// Component is the service for managing project components.
	Component *ProjectComponentService
	// Feature is the service for managing project features.
	Feature *ProjectFeatureService
	// Permission is the service for managing project permission schemes.
	Permission *ProjectPermissionSchemeService
	// Property is the service for managing project properties.
	Property *ProjectPropertyService
	// Role is the service for managing project roles.
	Role *ProjectRoleService
	// Type is the service for managing project types.
	Type *ProjectTypeService
	// Validator is the service for managing project validators.
	Validator *ProjectValidatorService
	// Version is the service for managing project versions.
	Version *ProjectVersionService
	// contains filtered or unexported fields
}

ProjectService provides methods to manage projects in Jira Service Management.

func NewProjectService 

func NewProjectService(client service.Connector, version string, subServices *ProjectChildServices) (*ProjectService, error)

NewProjectService creates a new instance of ProjectService.

func (*ProjectService) Archive 

func (p *ProjectService) Archive(ctx context.Context, projectKeyOrID string) (*model.ResponseScheme, error)

Archive archives a project. Archived projects cannot be deleted.

To delete an archived project, restore the project and then delete it.

To restore a project, use the Jira UI.

POST /rest/api/{2-3}/project/{projectKeyOrID}/archive

https://docs.go-atlassian.io/jira-software-cloud/projects#archive-project

func (*ProjectService) Create 

func (p *ProjectService) Create(ctx context.Context, payload *model.ProjectPayloadScheme) (*model.NewProjectCreatedScheme, *model.ResponseScheme, error)

Create creates a project based on a project type template

POST /rest/api/{2-3}/project

https://docs.go-atlassian.io/jira-software-cloud/projects#create-project

func (*ProjectService) Delete 

func (p *ProjectService) Delete(ctx context.Context, projectKeyOrID string, enableUndo bool) (*model.ResponseScheme, error)

Delete deletes a project.

You can't delete a project if it's archived. To delete an archived project, restore the project and then delete it.

To restore a project, use the Jira UI.

DELETE /rest/api/{2-3}/project/{projectKeyOrID}

https://docs.go-atlassian.io/jira-software-cloud/projects#delete-project

func (*ProjectService) DeleteAsynchronously 

func (p *ProjectService) DeleteAsynchronously(ctx context.Context, projectKeyOrID string) (*model.TaskScheme, *model.ResponseScheme, error)

DeleteAsynchronously deletes a project asynchronously.

1. transactional, that is, if part of to delete fails the project is not deleted.

2. asynchronous. Follow the location link in the response to determine the status of the task and use Get task to obtain subsequent updates.

POST /rest/api/{2-3}/project/{projectKeyOrID}/delete

https://docs.go-atlassian.io/jira-software-cloud/projects#delete-project-asynchronously

func (*ProjectService) Get 

func (p *ProjectService) Get(ctx context.Context, projectKeyOrID string, expand []string) (*model.ProjectScheme, *model.ResponseScheme, error)

Get returns the project details for a project.

GET /rest/api/{2-3}project/{projectKeyOrID}

https://docs.go-atlassian.io/jira-software-cloud/projects#get-project

func (*ProjectService) NotificationScheme 

func (p *ProjectService) NotificationScheme(ctx context.Context, projectKeyOrID string, expand []string) (*model.NotificationSchemeScheme, *model.ResponseScheme, error)

NotificationScheme gets the notification scheme associated with the project.

GET /rest/api/{2-3}/project/{projectKeyOrID}/notificationscheme

https://docs.go-atlassian.io/jira-software-cloud/projects#get-project-notification-scheme

func (*ProjectService) Restore 

func (p *ProjectService) Restore(ctx context.Context, projectKeyOrID string) (*model.ProjectScheme, *model.ResponseScheme, error)

Restore restores a project from the Jira recycle bin.

POST /rest/api/3/project/{projectKeyOrID}/restore

https://docs.go-atlassian.io/jira-software-cloud/projects#restore-deleted-project

func (*ProjectService) Search 

func (p *ProjectService) Search(ctx context.Context, options *model.ProjectSearchOptionsScheme, startAt, maxResults int) (*model.ProjectSearchScheme, *model.ResponseScheme, error)

Search returns a paginated list of projects visible to the user.

GET /rest/api/{2-3}/project/search

https://docs.go-atlassian.io/jira-software-cloud/projects#get-projects-paginated

func (*ProjectService) Statuses 

func (p *ProjectService) Statuses(ctx context.Context, projectKeyOrID string) ([]*model.ProjectStatusPageScheme, *model.ResponseScheme, error)

Statuses returns the valid statuses for a project.

The statuses are grouped by issue type, as each project has a set of valid issue types and each issue type has a set of valid statuses.

GET /rest/api/{2-3}/project/{projectKeyOrID}/statuses

https://docs.go-atlassian.io/jira-software-cloud/projects#get-all-statuses-for-project

func (*ProjectService) Update 

func (p *ProjectService) Update(ctx context.Context, projectKeyOrID string, payload *model.ProjectUpdateScheme) (*model.ProjectScheme, *model.ResponseScheme, error)

Update updates the project details of a project.

PUT /rest/api/{2-3}/project/{projectKeyOrID}

https://docs.go-atlassian.io/jira-software-cloud/projects#update-project

type ProjectTypeService 

type ProjectTypeService struct {
	// contains filtered or unexported fields
}

ProjectTypeService provides methods to manage project types in Jira Service Management.

func NewProjectTypeService 

func NewProjectTypeService(client service.Connector, version string) (*ProjectTypeService, error)

NewProjectTypeService creates a new instance of ProjectTypeService.

func (*ProjectTypeService) Accessible 

func (p *ProjectTypeService) Accessible(ctx context.Context, projectTypeKey string) (*model.ProjectTypeScheme, *model.ResponseScheme, error)

Accessible returns a project type if it is accessible to the user.

GET /rest/api/{2-3}/project/type/{projectTypeKey}/accessible

https://docs.go-atlassian.io/jira-software-cloud/projects/types#get-accessible-project-type-by-key

func (*ProjectTypeService) Get 

func (p *ProjectTypeService) Get(ctx context.Context, projectTypeKey string) (*model.ProjectTypeScheme, *model.ResponseScheme, error)

Get returns a project type

GET /rest/api/{2-3}/project/type/{projectTypeKey}

https://docs.go-atlassian.io/jira-software-cloud/projects/types#get-project-type-by-key

func (*ProjectTypeService) Gets 

func (p *ProjectTypeService) Gets(ctx context.Context) ([]*model.ProjectTypeScheme, *model.ResponseScheme, error)

Gets returns all project types, whether the instance has a valid license for each type.

GET /rest/api/{2-3}/project/type

https://docs.go-atlassian.io/jira-software-cloud/projects/types#get-all-project-types

func (*ProjectTypeService) Licensed 

func (p *ProjectTypeService) Licensed(ctx context.Context) ([]*model.ProjectTypeScheme, *model.ResponseScheme, error)

Licensed returns all project types with a valid license.

GET /rest/api/{2-3}/project/type/accessible

https://docs.go-atlassian.io/jira-software-cloud/projects/types#get-licensed-project-types

type ProjectValidatorService 

type ProjectValidatorService struct {
	// contains filtered or unexported fields
}

ProjectValidatorService provides methods to validate project keys and names in Jira Service Management.

func NewProjectValidatorService 

func NewProjectValidatorService(client service.Connector, version string) (*ProjectValidatorService, error)

NewProjectValidatorService creates a new instance of ProjectValidatorService.

func (*ProjectValidatorService) Key 

func (p *ProjectValidatorService) Key(ctx context.Context, key string) (string, *model.ResponseScheme, error)

Key validates a project key and, if the key is invalid or in use,

generates a valid random string for the project key.

GET /rest/api/{2-3}/projectvalidate/validProjectKey

https://docs.go-atlassian.io/jira-software-cloud/projects/validation#get-valid-project-key

func (*ProjectValidatorService) Name 

func (p *ProjectValidatorService) Name(ctx context.Context, name string) (string, *model.ResponseScheme, error)

Name checks that a project name isn't in use.

If the name isn't in use, the passed string is returned.

If the name is in use, this operation attempts to generate a valid project name based on the one supplied,

usually by adding a sequence number. If a valid project name cannot be generated, a 404 response is returned.

GET /rest/api/{2-3}/projectvalidate/validProjectName

https://docs.go-atlassian.io/jira-software-cloud/projects/validation#get-valid-project-name

func (*ProjectValidatorService) Validate 

func (p *ProjectValidatorService) Validate(ctx context.Context, key string) (*model.ProjectValidationMessageScheme, *model.ResponseScheme, error)

Validate validates a project key by confirming the key is a valid string and not in use.

GET /rest/api/{2-3}/projectvalidate/key

https://docs.go-atlassian.io/jira-software-cloud/projects/validation#validate-project-key

type ProjectVersionService 

type ProjectVersionService struct {
	// contains filtered or unexported fields
}

ProjectVersionService provides methods to manage project versions in Jira Service Management.

func NewProjectVersionService 

func NewProjectVersionService(client service.Connector, version string) (*ProjectVersionService, error)

NewProjectVersionService creates a new instance of ProjectVersionService.

func (*ProjectVersionService) Create 

func (p *ProjectVersionService) Create(ctx context.Context, payload *model.VersionPayloadScheme) (*model.VersionScheme, *model.ResponseScheme, error)

Create creates a project version.

POST /rest/api/{2-3}/version

https://docs.go-atlassian.io/jira-software-cloud/projects/versions#create-version

func (*ProjectVersionService) Get 

func (p *ProjectVersionService) Get(ctx context.Context, versionID string, expand []string) (*model.VersionScheme, *model.ResponseScheme, error)

Get returns a project version.

GET /rest/api/{2-3}/version/{id}

https://docs.go-atlassian.io/jira-software-cloud/projects/versions#get-version

func (*ProjectVersionService) Gets 

func (p *ProjectVersionService) Gets(ctx context.Context, projectKeyOrID string) ([]*model.VersionScheme, *model.ResponseScheme, error)

Gets returns all versions in a project.

The response is not paginated.

Use Search() if you want to get the versions in a project with pagination.

GET /rest/api/{2-3}/project/{projectKeyOrID}/versions

https://docs.go-atlassian.io/jira-software-cloud/projects/versions#get-project-versions

func (*ProjectVersionService) Merge 

func (p *ProjectVersionService) Merge(ctx context.Context, versionID, versionMoveIssuesTo string) (*model.ResponseScheme, error)

Merge 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.

PUT /rest/api/{2-3}/version/{id}/mergeto/{moveIssuesTo}

func (*ProjectVersionService) RelatedIssueCounts 

func (p *ProjectVersionService) RelatedIssueCounts(ctx context.Context, versionID string) (*model.VersionIssueCountsScheme, *model.ResponseScheme, error)

RelatedIssueCounts returns the following counts for a version:

1. Number of issues where the fixVersion is set to the version.

2. Number of issues where the affectedVersion is set to the version.

3. Number of issues where a version custom field is set to the version.

GET /rest/api/{2-3}/version/{id}/relatedIssueCounts

https://docs.go-atlassian.io/jira-software-cloud/projects/versions#get-versions-related-issues-count

func (*ProjectVersionService) Search 

func (p *ProjectVersionService) Search(ctx context.Context, projectKeyOrID string, options *model.VersionGetsOptions, startAt, maxResults int) (*model.VersionPageScheme, *model.ResponseScheme, error)

Search returns a paginated list of all versions in a project.

GET /rest/api/{2-3}/project/{projectKeyOrID}/version

https://docs.go-atlassian.io/jira-software-cloud/projects/versions#get-project-versions-paginated

func (*ProjectVersionService) UnresolvedIssueCount 

func (p *ProjectVersionService) UnresolvedIssueCount(ctx context.Context, versionID string) (*model.VersionUnresolvedIssuesCountScheme, *model.ResponseScheme, error)

UnresolvedIssueCount returns counts of the issues and unresolved issues for the project version.

GET /rest/api/{2-3}/version/{id}/unresolvedIssueCount

https://docs.go-atlassian.io/jira-software-cloud/projects/versions#get-versions-unresolved-issues-count

func (*ProjectVersionService) Update 

func (p *ProjectVersionService) Update(ctx context.Context, versionID string, payload *model.VersionPayloadScheme) (*model.VersionScheme, *model.ResponseScheme, error)

Update updates a project version.

PUT /rest/api/{2-3}/version/{id}

https://docs.go-atlassian.io/jira-software-cloud/projects/versions#update-version

type RemoteLinkService 

type RemoteLinkService struct {
	// contains filtered or unexported fields
}

RemoteLinkService provides methods to manage remote issue links in Jira Service Management.

func NewRemoteLinkService 

func NewRemoteLinkService(client service.Connector, version string) (*RemoteLinkService, error)

NewRemoteLinkService creates a new instance of RemoteLinkService.

func (*RemoteLinkService) Create 

func (r *RemoteLinkService) Create(ctx context.Context, issueKeyOrID string, payload *model.RemoteLinkScheme) (*model.RemoteLinkIdentify, *model.ResponseScheme, error)

Create creates or updates a remote issue link for an issue.

If a globalID is provided and a remote issue link with that global ID is found it is updated.

Any fields without values in the request are set to null. Otherwise, the remote issue link is created.

POST /rest/api/{2-3}/issue/{issueKeyOrID}/remotelink

https://docs.go-atlassian.io/jira-software-cloud/issues/link/remote#create-remote-issue-link

func (*RemoteLinkService) DeleteByGlobalID 

func (r *RemoteLinkService) DeleteByGlobalID(ctx context.Context, issueKeyOrID, globalID string) (*model.ResponseScheme, error)

DeleteByGlobalID deletes the remote issue link from the issue using the link's global ID.

Where the global ID includes reserved URL characters these must be escaped in the request.

For example, pass system=http://www.mycompany.com/support&id=1 as system%3Dhttp%3A%2F%2Fwww.mycompany.com%2Fsupport%26id%3D1.

DELETE /rest/api/{2-3}/issue/{issueKeyOrID}/remotelink

https://docs.go-atlassian.io/jira-software-cloud/issues/link/remote#delete-remote-issue-link-by-global-id

func (*RemoteLinkService) DeleteByID 

func (r *RemoteLinkService) DeleteByID(ctx context.Context, issueKeyOrID, linkID string) (*model.ResponseScheme, error)

DeleteByID deletes a remote issue link from an issue.

DELETE /rest/api/{2-3}/issue/{issueKeyOrID}/remotelink/{linkID}

https://docs.go-atlassian.io/jira-software-cloud/issues/link/remote#delete-remote-issue-link-by-id

func (*RemoteLinkService) Get 

func (r *RemoteLinkService) Get(ctx context.Context, issueKeyOrID, linkID string) (*model.RemoteLinkScheme, *model.ResponseScheme, error)

Get returns a remote issue link for an issue.

GET /rest/api/{2-3}/issue/{issueKeyOrID}/remotelink/{linkID}

https://docs.go-atlassian.io/jira-software-cloud/issues/link/remote#get-remote-issue-link

func (*RemoteLinkService) Gets 

func (r *RemoteLinkService) Gets(ctx context.Context, issueKeyOrID, globalID string) ([]*model.RemoteLinkScheme, *model.ResponseScheme, error)

Gets returns the remote issue links for an issue.

When a remote issue link global ID is provided the record with that global ID is returned,

otherwise all remote issue links are returned.

Where a global ID includes reserved URL characters these must be escaped in the request

GET /rest/api/{2-3}/issue/{issueKeyOrID}/remotelink

https://docs.go-atlassian.io/jira-software-cloud/issues/link/remote#get-remote-issue-links

func (*RemoteLinkService) Update 

func (r *RemoteLinkService) Update(ctx context.Context, issueKeyOrID, linkID string, payload *model.RemoteLinkScheme) (*model.ResponseScheme, error)

Update updates a remote issue link for an issue.

Note: Fields without values in the request are set to null.

PUT /rest/api/{2-3}/issue/{issueKeyOrID}/remotelink/{linkID}

https://docs.go-atlassian.io/jira-software-cloud/issues/link/remote#update-remote-issue-link

type ResolutionService 

type ResolutionService struct {
	// contains filtered or unexported fields
}

ResolutionService provides methods to manage issue resolutions in Jira Service Management.

func NewResolutionService 

func NewResolutionService(client service.Connector, version string) (*ResolutionService, error)

NewResolutionService creates a new instance of ResolutionService.

func (*ResolutionService) Get 

func (r *ResolutionService) Get(ctx context.Context, resolutionID string) (*model.ResolutionScheme, *model.ResponseScheme, error)

Get returns an issue resolution value.

GET /rest/api/{2-3}/resolution/{resolutionID}

https://docs.go-atlassian.io/jira-software-cloud/issues/resolutions#get-resolution

func (*ResolutionService) Gets 

func (r *ResolutionService) Gets(ctx context.Context) ([]*model.ResolutionScheme, *model.ResponseScheme, error)

Gets returns a list of all issue resolution values.

GET /rest/api/{2-3}/resolution

https://docs.go-atlassian.io/jira-software-cloud/issues/resolutions#get-resolutions

type ScreenSchemeService 

type ScreenSchemeService struct {
	// contains filtered or unexported fields
}

ScreenSchemeService provides methods to manage screen schemes in Jira Service Management.

func NewScreenSchemeService 

func NewScreenSchemeService(client service.Connector, version string) (*ScreenSchemeService, error)

NewScreenSchemeService creates a new instance of ScreenSchemeService.

func (*ScreenSchemeService) Create 

func (s *ScreenSchemeService) Create(ctx context.Context, payload *model.ScreenSchemePayloadScheme) (*model.ScreenSchemeScheme, *model.ResponseScheme, error)

Create creates a screen scheme.

POST /rest/api/{2-3}/screenscheme

https://docs.go-atlassian.io/jira-software-cloud/screens/schemes#create-screen-scheme

func (*ScreenSchemeService) Delete 

func (s *ScreenSchemeService) Delete(ctx context.Context, screenSchemeID string) (*model.ResponseScheme, error)

Delete deletes a screen scheme. A screen scheme cannot be deleted if it is used in an issue type screen scheme.

Only screens schemes used in classic projects can be deleted.

DELETE /rest/api/{2-3}/screenscheme/{screenSchemeID}

https://docs.go-atlassian.io/jira-software-cloud/screens/schemes#delete-screen-scheme

func (*ScreenSchemeService) Gets 

func (s *ScreenSchemeService) Gets(ctx context.Context, options *model.ScreenSchemeParamsScheme, startAt, maxResults int) (*model.ScreenSchemePageScheme, *model.ResponseScheme, error)

Gets returns a paginated list of screen schemes.

Only screen schemes used in classic projects are returned.

GET /rest/api/{2-3}/screenscheme

https://docs.go-atlassian.io/jira-software-cloud/screens/schemes#get-screen-schemes

func (*ScreenSchemeService) Update 

func (s *ScreenSchemeService) Update(ctx context.Context, screenSchemeID string, payload *model.ScreenSchemePayloadScheme) (*model.ResponseScheme, error)

Update updates a screen scheme. Only screen schemes used in classic projects can be updated.

PUT /rest/api/{2-3}/screenscheme/{screenSchemeID}

https://docs.go-atlassian.io/jira-software-cloud/screens/schemes#update-screen-scheme

type ScreenService 

type ScreenService struct {

	// Scheme is the service for managing screen schemes.
	Scheme *ScreenSchemeService
	// Tab is the service for managing screen tabs.
	Tab *ScreenTabService
	// contains filtered or unexported fields
}

ScreenService provides methods to manage screens in Jira Service Management.

func NewScreenService 

func NewScreenService(client service.Connector, version string, scheme *ScreenSchemeService, tab *ScreenTabService) (*ScreenService, error)

NewScreenService creates a new instance of ScreenService.

func (*ScreenService) AddToDefault 

func (s *ScreenService) AddToDefault(ctx context.Context, fieldID string) (*model.ResponseScheme, error)

AddToDefault adds a field to the default tab of the default screen.

POST /rest/api/{2-3}/screens/addToDefault/{fieldID}

https://docs.go-atlassian.io/jira-software-cloud/screens#add-field-to-default-screen

func (*ScreenService) Available 

func (s *ScreenService) Available(ctx context.Context, screenID int) ([]*model.AvailableScreenFieldScheme, *model.ResponseScheme, error)

Available returns the fields that can be added to a tab on a screen.

GET /rest/api/{2-3}/screens/{screenID}/availableFields

https://docs.go-atlassian.io/jira-software-cloud/screens#get-available-screen-fields

func (*ScreenService) Create 

func (s *ScreenService) Create(ctx context.Context, name, description string) (*model.ScreenScheme, *model.ResponseScheme, error)

Create creates a screen with a default field tab

POST /rest/api/{2-3}/screens

https://docs.go-atlassian.io/jira-software-cloud/screens#create-screen

func (*ScreenService) Delete 

func (s *ScreenService) Delete(ctx context.Context, screenID int) (*model.ResponseScheme, error)

Delete deletes a screen. A screen cannot be deleted if it is used in a screen scheme,

workflow, or workflow draft. Only screens used in classic projects can be deleted.

DELETE /rest/api/{2-3}/screens/{screenID}

https://docs.go-atlassian.io/jira-software-cloud/screens#delete-screen

func (*ScreenService) Fields 

func (s *ScreenService) Fields(ctx context.Context, fieldID string, startAt, maxResults int) (*model.ScreenFieldPageScheme, *model.ResponseScheme, error)

Fields returns a paginated list of the screens a field is used in.

GET /rest/api/{2-3}/field/{fieldID}/screens

https://docs.go-atlassian.io/jira-software-cloud/screens#get-screens-for-a-field

func (*ScreenService) Gets 

func (s *ScreenService) Gets(ctx context.Context, options *model.ScreenParamsScheme, startAt, maxResults int) (*model.ScreenSearchPageScheme, *model.ResponseScheme, error)

Gets returns a paginated list of all screens or those specified by one or more screen IDs.

GET /rest/api/{2-3}/screens

https://docs.go-atlassian.io/jira-software-cloud/screens#get-screens

func (*ScreenService) Update 

func (s *ScreenService) Update(ctx context.Context, screenID int, name, description string) (*model.ScreenScheme, *model.ResponseScheme, error)

Update updates a screen. Only screens used in classic projects can be updated.

PUT /rest/api/{2-3}/screens/{screenID}

https://docs.go-atlassian.io/jira-software-cloud/screens#update-screen

type ScreenTabFieldService 

type ScreenTabFieldService struct {
	// contains filtered or unexported fields
}

ScreenTabFieldService provides methods to manage screen tab fields in Jira Service Management.

func NewScreenTabFieldService 

func NewScreenTabFieldService(client service.Connector, version string) (*ScreenTabFieldService, error)

NewScreenTabFieldService creates a new instance of ScreenTabFieldService.

func (*ScreenTabFieldService) Add 

func (s *ScreenTabFieldService) Add(ctx context.Context, screenID, tabID int, fieldID string) (*model.ScreenTabFieldScheme, *model.ResponseScheme, error)

Add adds a field to a screen tab.

POST /rest/api/{2-3}/screens/{screenID}/tabs/{tabID}/fields

https://docs.go-atlassian.io/jira-software-cloud/screens/tabs/fields#add-screen-tab-field

func (*ScreenTabFieldService) Gets 

func (s *ScreenTabFieldService) Gets(ctx context.Context, screenID, tabID int) ([]*model.ScreenTabFieldScheme, *model.ResponseScheme, error)

Gets returns all fields for a screen tab.

GET /rest/api/{2-3}/screens/{screenID}/tabs/{tabID}/fields

https://docs.go-atlassian.io/jira-software-cloud/screens/tabs/fields#get-all-screen-tab-fields

func (*ScreenTabFieldService) Move 

func (s *ScreenTabFieldService) Move(ctx context.Context, screenID, tabID int, fieldID, after, position string) (*model.ResponseScheme, error)

Move moves a screen tab field.

If after and position are provided in the request, position is ignored.

POST /rest/api/{2-3}/screens/{screenID}/tabs/{tabID}/fields/{fieldID}/move

TODO: Add documentation

func (*ScreenTabFieldService) Remove 

func (s *ScreenTabFieldService) Remove(ctx context.Context, screenID, tabID int, fieldID string) (*model.ResponseScheme, error)

Remove removes a field from a screen tab.

DELETE /rest/api/{2-3}/screens/{screenID}/tabs/{tabID}/fields/{fieldID}

https://docs.go-atlassian.io/jira-software-cloud/screens/tabs/fields#remove-screen-tab-field

type ScreenTabService 

type ScreenTabService struct {

	// Field is the service for managing screen tab fields.
	Field *ScreenTabFieldService
	// contains filtered or unexported fields
}

ScreenTabService provides methods to manage screen tabs in Jira Service Management.

func NewScreenTabService 

func NewScreenTabService(client service.Connector, version string, field *ScreenTabFieldService) (*ScreenTabService, error)

NewScreenTabService creates a new instance of ScreenTabService.

func (*ScreenTabService) Create 

func (s *ScreenTabService) Create(ctx context.Context, screenID int, tabName string) (*model.ScreenTabScheme, *model.ResponseScheme, error)

Create creates a tab for a screen.

POST /rest/api/{2-3}/screens/{screenID}/tabs

https://docs.go-atlassian.io/jira-software-cloud/screens/tabs#create-screen-tab

func (*ScreenTabService) Delete 

func (s *ScreenTabService) Delete(ctx context.Context, screenID, tabID int) (*model.ResponseScheme, error)

Delete deletes a screen tab.

DELETE /rest/api/{2-3}/screens/{screenID}/tabs/{tabID}

https://docs.go-atlassian.io/jira-software-cloud/screens/tabs#delete-screen-tab

func (*ScreenTabService) Gets 

func (s *ScreenTabService) Gets(ctx context.Context, screenID int, projectKey string) ([]*model.ScreenTabScheme, *model.ResponseScheme, error)

Gets returns the list of tabs for a screen.

GET /rest/api/{2-3}/screens/{screenID}/tabs

https://docs.go-atlassian.io/jira-software-cloud/screens/tabs#get-all-screen-tabs

func (*ScreenTabService) Move 

func (s *ScreenTabService) Move(ctx context.Context, screenID, tabID, position int) (*model.ResponseScheme, error)

Move moves a screen tab.

POST /rest/api/{2-3}/screens/{screenID}/tabs/{tabID}/move/{pos}

https://docs.go-atlassian.io/jira-software-cloud/screens/tabs#move-screen-tab

func (*ScreenTabService) Update 

func (s *ScreenTabService) Update(ctx context.Context, screenID, tabID int, newTabName string) (*model.ScreenTabScheme, *model.ResponseScheme, error)

Update updates the name of a screen tab.

PUT /rest/api/{2-3}/screens/{screenID}/tabs/{tabID}

https://docs.go-atlassian.io/jira-software-cloud/screens/tabs#update-screen-tab

type SearchADFService 

type SearchADFService struct {
	// contains filtered or unexported fields
}

SearchADFService provides methods to manage advanced document format (ADF) searches in Jira Service Management.

func (*SearchADFService) Checks 

func (s *SearchADFService) Checks(ctx context.Context, payload *model.IssueSearchCheckPayloadScheme) (*model.IssueMatchesPageScheme, *model.ResponseScheme, error)

Checks checks whether one or more issues would be returned by one or more JQL queries.

POST /rest/api/{2-3}/jql/match

https://docs.go-atlassian.io/jira-software-cloud/issues/search#check-issues-against-jql

func (*SearchADFService) Get 

func (s *SearchADFService) Get(ctx context.Context, jql string, fields, expands []string, startAt, maxResults int, validate string) (*model.IssueSearchScheme, *model.ResponseScheme, error)

Get search issues using JQL query under the HTTP Method GET

GET /rest/api/3/search

https://docs.go-atlassian.io/jira-software-cloud/issues/search#search-for-issues-using-jql-get

func (*SearchADFService) Post 

func (s *SearchADFService) Post(ctx context.Context, jql string, fields, expands []string, startAt, maxResults int, validate string) (*model.IssueSearchScheme, *model.ResponseScheme, error)

Post search issues using JQL query under the HTTP Method POST

POST /rest/api/3/search

https://docs.go-atlassian.io/jira-software-cloud/issues/search#search-for-issues-using-jql-get

type SearchRichTextService 

type SearchRichTextService struct {
	// contains filtered or unexported fields
}

SearchRichTextService provides methods to manage rich text searches in Jira Service Management.

func (*SearchRichTextService) Checks 

func (s *SearchRichTextService) Checks(ctx context.Context, payload *model.IssueSearchCheckPayloadScheme) (*model.IssueMatchesPageScheme, *model.ResponseScheme, error)

Checks checks whether one or more issues would be returned by one or more JQL queries.

POST /rest/api/{2-3}/jql/match

https://docs.go-atlassian.io/jira-software-cloud/issues/search#check-issues-against-jql

func (*SearchRichTextService) Get 

func (s *SearchRichTextService) Get(ctx context.Context, jql string, fields, expands []string, startAt, maxResults int, validate string) (*model.IssueSearchSchemeV2, *model.ResponseScheme, error)

Get search issues using JQL query under the HTTP Method GET

GET /rest/api/2/search

https://docs.go-atlassian.io/jira-software-cloud/issues/search#search-for-issues-using-jql-get

func (*SearchRichTextService) Post 

func (s *SearchRichTextService) Post(ctx context.Context, jql string, fields, expands []string, startAt, maxResults int, validate string) (*model.IssueSearchSchemeV2, *model.ResponseScheme, error)

Post search issues using JQL query under the HTTP Method POST

POST /rest/api/2/search

https://docs.go-atlassian.io/jira-software-cloud/issues/search#search-for-issues-using-jql-get

type ServerService 

type ServerService struct {
	// contains filtered or unexported fields
}

ServerService provides methods to manage server information in Jira Service Management.

func NewServerService 

func NewServerService(client service.Connector, version string) (*ServerService, error)

NewServerService creates a new instance of ServerService.

func (*ServerService) Info 

func (s *ServerService) Info(ctx context.Context) (*model.ServerInformationScheme, *model.ResponseScheme, error)

Info returns information about the Jira instance

GET /rest/api/{2-3}/serverInfo

https://docs.go-atlassian.io/jira-software-cloud/server#get-jira-instance-info

type TaskService 

type TaskService struct {
	// contains filtered or unexported fields
}

TaskService provides methods to manage tasks in Jira Service Management.

func NewTaskService 

func NewTaskService(client service.Connector, version string) (*TaskService, error)

NewTaskService creates a new instance of TaskService.

func (*TaskService) Cancel 

func (t *TaskService) Cancel(ctx context.Context, taskID string) (*model.ResponseScheme, error)

Cancel cancels a task.

POST /rest/api/{2-3}/task/{taskID}/cancel

https://docs.go-atlassian.io/jira-software-cloud/tasks#cancel-task

func (*TaskService) Get 

func (t *TaskService) Get(ctx context.Context, taskID string) (*model.TaskScheme, *model.ResponseScheme, error)

Get returns the status of a long-running asynchronous task.

When a task has finished, this operation returns the JSON blob applicable to the task.

See the documentation of the operation that created the task for details.

Task details are not permanently retained.

GET /rest/api/{2-3}/task/{taskID}

https://docs.go-atlassian.io/jira-software-cloud/tasks#get-task

type TeamService 

type TeamService struct {
	// contains filtered or unexported fields
}

TeamService provides methods to manage team information in Jira Advanced Roadmaps.

func NewTeamService 

func NewTeamService(client service.Connector) *TeamService

NewTeamService creates a new instance of TeamService.

func (*TeamService) Create 

func (t *TeamService) Create(ctx context.Context, payload *model.JiraTeamCreatePayloadScheme) (*model.JiraTeamCreateResponseScheme, *model.ResponseScheme, error)

Create creates a team on the Advanced Roadmaps

POST /rest/teams/1.0/teams/create

https://docs.go-atlassian.io/jira-software-cloud/teams#create-team

func (*TeamService) Gets 

func (t *TeamService) Gets(ctx context.Context, maxResults int) (*model.JiraTeamPageScheme, *model.ResponseScheme, error)

Gets gets the Teams information from the Jira Advanced Roadmaps application.

Teams in Advanced Roadmaps are different from the teams found in the rest of Jira Software Cloud.

In Advanced Roadmaps, they act as a label applied to issues that designates which team will eventually.

pick up the work on your timeline. By adding the Team field to your Jira issues.

you can save this value back to your Jira issues, which makes sprint planning easier.

POST /rest/teams/1.0/teams/find

https://docs.go-atlassian.io/jira-software-cloud/teams#get-teams

type TypeSchemeService 

type TypeSchemeService struct {
	// contains filtered or unexported fields
}

TypeSchemeService provides methods to manage issue type schemes in Jira Service Management.

func NewTypeSchemeService 

func NewTypeSchemeService(client service.Connector, version string) (*TypeSchemeService, error)

NewTypeSchemeService creates a new instance of TypeSchemeService.

func (*TypeSchemeService) Append 

func (t *TypeSchemeService) Append(ctx context.Context, issueTypeSchemeID int, issueTypeIDs []int) (*model.ResponseScheme, error)

Append adds issue types to an issue type scheme.

1.The added issue types are appended to the issue types list.

2.If any of the issue types exist in the issue type scheme, the operation fails and no issue types are added.

PUT /rest/api/{2-3}/issuetypescheme/{issueTypeSchemeID}/issuetype

https://docs.go-atlassian.io/jira-software-cloud/issues/types/scheme#add-issue-types-to-issue-type-scheme

func (*TypeSchemeService) Assign 

func (t *TypeSchemeService) Assign(ctx context.Context, issueTypeSchemeID, projectID string) (*model.ResponseScheme, error)

Assign assigns an issue type scheme to a project.

PUT /rest/api/{2-3}/issuetypescheme/project

https://docs.go-atlassian.io/jira-software-cloud/issues/types/scheme#assign-issue-type-scheme-to-project

func (*TypeSchemeService) Create 

func (t *TypeSchemeService) Create(ctx context.Context, payload *model.IssueTypeSchemePayloadScheme) (*model.NewIssueTypeSchemeScheme, *model.ResponseScheme, error)

Create creates an issue type scheme.

POST /rest/api/{2-3}/issuetypescheme

https://docs.go-atlassian.io/jira-software-cloud/issues/types/scheme#create-issue-type-scheme

func (*TypeSchemeService) Delete 

func (t *TypeSchemeService) Delete(ctx context.Context, issueTypeSchemeID int) (*model.ResponseScheme, error)

Delete deletes an issue type scheme.

1.Only issue type schemes used in classic projects can be deleted.

2.Any projects assigned to the scheme are reassigned to the default issue type scheme.

DELETE /rest/api/{2-3}/issuetypescheme/{issueTypeSchemeID}

https://docs.go-atlassian.io/jira-software-cloud/issues/types/scheme#delete-issue-type-scheme

func (*TypeSchemeService) Gets 

func (t *TypeSchemeService) Gets(ctx context.Context, issueTypeSchemeIDs []int, startAt, maxResults int) (*model.IssueTypeSchemePageScheme, *model.ResponseScheme, error)

Gets returns a paginated list of issue type schemes.

GET /rest/api/{2-3}/issuetypescheme

https://docs.go-atlassian.io/jira-software-cloud/issues/types/scheme#get-all-issue-type-schemes

func (*TypeSchemeService) Items 

func (t *TypeSchemeService) Items(ctx context.Context, issueTypeSchemeIDs []int, startAt, maxResults int) (*model.IssueTypeSchemeItemPageScheme, *model.ResponseScheme, error)

Items returns a paginated list of issue type scheme items.

GET /rest/api/{2-3}/issuetypescheme/mapping

https://docs.go-atlassian.io/jira-software-cloud/issues/types/scheme#get-issue-type-scheme-items

func (*TypeSchemeService) Projects 

func (t *TypeSchemeService) Projects(ctx context.Context, projectIDs []int, startAt, maxResults int) (*model.ProjectIssueTypeSchemePageScheme, *model.ResponseScheme, error)

Projects returns a paginated list of issue type schemes and, for each issue type scheme, a list of the projects that use it.

GET /rest/api/{2-3}/issuetypescheme/project

https://docs.go-atlassian.io/jira-software-cloud/issues/types/scheme#get-issue-type-schemes-for-projects

func (*TypeSchemeService) Remove 

func (t *TypeSchemeService) Remove(ctx context.Context, issueTypeSchemeID, issueTypeID int) (*model.ResponseScheme, error)

Remove removes an issue type from an issue type scheme, this operation cannot remove:

1.any issue type used by issues.

2.any issue types from the default issue type scheme.

3.the last standard issue type from an issue type scheme.

DELETE /rest/api/{2-3}/issuetypescheme/{issueTypeSchemeID}/issuetype/{issueTypeID}

https://docs.go-atlassian.io/jira-software-cloud/issues/types/scheme#remove-issue-type-from-issue-type-scheme

func (*TypeSchemeService) Update 

func (t *TypeSchemeService) Update(ctx context.Context, issueTypeSchemeID int, payload *model.IssueTypeSchemePayloadScheme) (*model.ResponseScheme, error)

Update updates an issue type scheme.

PUT /rest/api/{2-3}/issuetypescheme/{issueTypeSchemeID}

https://docs.go-atlassian.io/jira-software-cloud/issues/types/scheme#update-issue-type-scheme

type TypeScreenSchemeService 

type TypeScreenSchemeService struct {
	// contains filtered or unexported fields
}

TypeScreenSchemeService provides methods to manage issue type screen schemes in Jira Service Management.

func NewTypeScreenSchemeService 

func NewTypeScreenSchemeService(client service.Connector, version string) (*TypeScreenSchemeService, error)

NewTypeScreenSchemeService creates a new instance of TypeScreenSchemeService.

func (*TypeScreenSchemeService) Append 

func (t *TypeScreenSchemeService) Append(ctx context.Context, issueTypeScreenSchemeID string, payload *model.IssueTypeScreenSchemePayloadScheme) (*model.ResponseScheme, error)

Append appends issue type to screen scheme mappings to an issue type screen scheme.

PUT /rest/api/{2-3}/issuetypescreenscheme/{issueTypeScreenSchemeID}/mapping

https://docs.go-atlassian.io/jira-software-cloud/issues/types/screen-scheme#append-mappings-to-issue-type-screen-scheme

func (*TypeScreenSchemeService) Assign 

func (t *TypeScreenSchemeService) Assign(ctx context.Context, issueTypeScreenSchemeID, projectID string) (*model.ResponseScheme, error)

Assign assigns an issue type screen scheme to a project.

Issue type screen schemes can only be assigned to classic projects.

PUT /rest/api/{2-3}/issuetypescreenscheme/projectg

https://docs.go-atlassian.io/jira-software-cloud/issues/types/screen-scheme#assign-issue-type-screen-scheme-to-project

func (*TypeScreenSchemeService) Create 

func (t *TypeScreenSchemeService) Create(ctx context.Context, payload *model.IssueTypeScreenSchemePayloadScheme) (*model.IssueTypeScreenScreenCreatedScheme, *model.ResponseScheme, error)

Create creates an issue type screen scheme.

POST /rest/api/{2-3}/issuetypescreenscheme

https://docs.go-atlassian.io/jira-software-cloud/issues/types/screen-scheme#create-issue-type-screen-scheme

func (*TypeScreenSchemeService) Delete 

func (t *TypeScreenSchemeService) Delete(ctx context.Context, issueTypeScreenSchemeID string) (*model.ResponseScheme, error)

Delete deletes an issue type screen scheme.

DELETE /rest/api/{2-3}/issuetypescreenscheme/{issueTypeScreenSchemeID}

https://docs.go-atlassian.io/jira-software-cloud/issues/types/screen-scheme#delete-issue-type-screen-scheme

func (*TypeScreenSchemeService) Gets 

func (t *TypeScreenSchemeService) Gets(ctx context.Context, options *model.ScreenSchemeParamsScheme, startAt, maxResults int) (*model.IssueTypeScreenSchemePageScheme, *model.ResponseScheme, error)

Gets returns a paginated list of issue type screen schemes.

Only issue type screen schemes used in classic projects are returned.

GET /rest/api/{2-3}/issuetypescreenscheme

https://docs.go-atlassian.io/jira-software-cloud/issues/types/screen-scheme#get-issue-type-screen-schemes

func (*TypeScreenSchemeService) Mapping 

func (t *TypeScreenSchemeService) Mapping(ctx context.Context, issueTypeScreenSchemeIDs []int, startAt, maxResults int) (*model.IssueTypeScreenSchemeMappingScheme, *model.ResponseScheme, error)

Mapping returns a paginated list of issue type screen scheme items.

Only issue type screen schemes used in classic projects are returned.

GET /rest/api/{2-3}/issuetypescreenscheme/mapping

https://docs.go-atlassian.io/jira-software-cloud/issues/types/screen-scheme#get-issue-type-screen-scheme-items

func (*TypeScreenSchemeService) Projects 

func (t *TypeScreenSchemeService) Projects(ctx context.Context, projectIDs []int, startAt, maxResults int) (*model.IssueTypeProjectScreenSchemePageScheme, *model.ResponseScheme, error)

Projects returns a paginated list of issue type screen schemes and, for each issue type screen scheme, a list of the projects that use it.

GET /rest/api/{2-3}/issuetypescreenscheme/project/{projectID}

https://docs.go-atlassian.io/jira-software-cloud/issues/types/screen-scheme#assign-issue-type-screen-scheme-to-project

func (*TypeScreenSchemeService) Remove 

func (t *TypeScreenSchemeService) Remove(ctx context.Context, issueTypeScreenSchemeID string, issueTypeIDs []string) (*model.ResponseScheme, error)

Remove removes issue type to screen scheme mappings from an issue type screen scheme.

POST /rest/api/{2-3}/issuetypescreenscheme/{issueTypeScreenSchemeID}/mapping/remove

https://docs.go-atlassian.io/jira-software-cloud/issues/types/screen-scheme#remove-mappings-from-issue-type-screen-scheme

func (*TypeScreenSchemeService) SchemesByProject 

func (t *TypeScreenSchemeService) SchemesByProject(ctx context.Context, issueTypeScreenSchemeID, startAt, maxResults int) (*model.IssueTypeScreenSchemeByProjectPageScheme, *model.ResponseScheme, error)

SchemesByProject returns a paginated list of projects associated with an issue type screen scheme.

GET /rest/api/{2-3}/issuetypescreenscheme/{issueTypeScreenSchemeID}/project

https://docs.go-atlassian.io/jira-software-cloud/issues/types/screen-scheme#get-issue-type-screen-scheme-projects

func (*TypeScreenSchemeService) Update 

func (t *TypeScreenSchemeService) Update(ctx context.Context, issueTypeScreenSchemeID, name, description string) (*model.ResponseScheme, error)

Update updates an issue type screen scheme.

PUT /rest/api/{2-3}/issuetypescreenscheme/{issueTypeScreenSchemeID}

https://docs.go-atlassian.io/jira-software-cloud/issues/types/screen-scheme#update-issue-type-screen-scheme

func (*TypeScreenSchemeService) UpdateDefault 

func (t *TypeScreenSchemeService) UpdateDefault(ctx context.Context, issueTypeScreenSchemeID, screenSchemeID string) (*model.ResponseScheme, error)

UpdateDefault updates the default screen scheme of an issue type screen scheme. The default screen scheme is used for all unmapped issue types.

PUT /rest/api/{2-3}/issuetypescreenscheme/{issueTypeScreenSchemeID}/mapping/default

https://docs.go-atlassian.io/jira-software-cloud/issues/types/screen-scheme#update-issue-type-screen-scheme-default-screen-scheme

type TypeService 

type TypeService struct {

	// Scheme is the service for managing type schemes.
	Scheme *TypeSchemeService
	// ScreenScheme is the service for managing type screen schemes.
	ScreenScheme *TypeScreenSchemeService
	// contains filtered or unexported fields
}

TypeService provides methods to manage issue types in Jira Service Management.

func NewTypeService 

func NewTypeService(client service.Connector, version string, scheme *TypeSchemeService, screenScheme *TypeScreenSchemeService) (
	*TypeService, error)

NewTypeService creates a new instance of TypeService.

func (*TypeService) Alternatives 

func (t *TypeService) Alternatives(ctx context.Context, issueTypeID string) ([]*model.IssueTypeScheme, *model.ResponseScheme, error)

Alternatives returns a list of issue types that can be used to replace the issue type.

The alternative issue types are those assigned to the same workflow scheme, field configuration scheme, and screen scheme.

GET /rest/api/{2-3}/issuetype/{id}/alternatives

https://docs.go-atlassian.io/jira-software-cloud/issues/type#get-alternative-issue-types

func (*TypeService) Create 

func (t *TypeService) Create(ctx context.Context, payload *model.IssueTypePayloadScheme) (*model.IssueTypeScheme, *model.ResponseScheme, error)

Create creates an issue type and adds it to the default issue type scheme.

POST /rest/api/{2-3}/issuetype

https://docs.go-atlassian.io/jira-software-cloud/issues/type#create-issue-type

func (*TypeService) Delete 

func (t *TypeService) Delete(ctx context.Context, issueTypeID string) (*model.ResponseScheme, error)

Delete deletes the issue type.

If the issue type is in use, all uses are updated with the alternative issue type (alternativeIssueTypeID). A list of alternative issue types are obtained from the Get alternative issue types resource.

DELETE /rest/api/{2-3}/issuetype/{id}

https://docs.go-atlassian.io/jira-software-cloud/issues/type#delete-issue-type

func (*TypeService) Get 

func (t *TypeService) Get(ctx context.Context, issueTypeID string) (*model.IssueTypeScheme, *model.ResponseScheme, error)

Get returns an issue type.

GET /rest/api/{2-3}/issuetype/{id}

https://docs.go-atlassian.io/jira-software-cloud/issues/type#get-issue-type

func (*TypeService) Gets 

func (t *TypeService) Gets(ctx context.Context) ([]*model.IssueTypeScheme, *model.ResponseScheme, error)

Gets returns all issue types.

GET /rest/api/{2-3}/issuetype

https://docs.go-atlassian.io/jira-software-cloud/issues/type#get-all-issue-types-for-user

func (*TypeService) Update 

func (t *TypeService) Update(ctx context.Context, issueTypeID string, payload *model.IssueTypePayloadScheme) (*model.IssueTypeScheme, *model.ResponseScheme, error)

Update updates the issue type.

PUT /rest/api/{2-3}/issuetype/{id}

https://docs.go-atlassian.io/jira-software-cloud/issues/type#update-issue-type

type UserSearchService 

type UserSearchService struct {
	// contains filtered or unexported fields
}

UserSearchService provides methods to search for users in Jira Service Management.

func NewUserSearchService 

func NewUserSearchService(client service.Connector, version string) (*UserSearchService, error)

NewUserSearchService creates a new instance of UserSearchService.

func (*UserSearchService) Check 

func (u *UserSearchService) Check(ctx context.Context, permission string, options *model.UserPermissionCheckParamsScheme, startAt, maxResults int) ([]*model.UserScheme, *model.ResponseScheme, error)

Check returns a list of users who fulfill these criteria:

1. their user attributes match a search string. 2. they have a set of permissions for a project or issue.

If no search string is provided, a list of all users with the permissions is returned.

GET /rest/api/{2-3}/user/permission/search

https://docs.go-atlassian.io/jira-software-cloud/users/search#find-users-with-permissions

func (*UserSearchService) Do 

func (u *UserSearchService) Do(ctx context.Context, accountID, query string, startAt, maxResults int) ([]*model.UserScheme, *model.ResponseScheme, error)

Do return a list of users that match the search string and property.

This operation takes the users in the range defined by startAt and maxResults, up to the thousandth user,

and then returns only the users from that range that match the search string and property.

This means the operation usually returns fewer users than specified in maxResults

GET /rest/api/{2-3}/user/search

https://docs.go-atlassian.io/jira-software-cloud/users/search#find-users

func (*UserSearchService) Projects 

func (u *UserSearchService) Projects(ctx context.Context, accountID string, projectKeys []string, startAt, maxResults int) ([]*model.UserScheme, *model.ResponseScheme, error)

Projects returns a list of users who can be assigned issues in one or more projects.

The list may be restricted to users whose attributes match a string.

GET /rest/api/{2-3}/user/assignable/multiProjectSearch

https://docs.go-atlassian.io/jira-software-cloud/users/search#find-users-assignable-to-projects

type UserService 

type UserService struct {

	// Search is the service for searching users.
	Search *UserSearchService
	// contains filtered or unexported fields
}

UserService provides methods to manage users in Jira Service Management.

func NewUserService 

func NewUserService(client service.Connector, version string, connector *UserSearchService) (*UserService, error)

NewUserService creates a new instance of UserService.

func (*UserService) Create 

func (u *UserService) Create(ctx context.Context, payload *model.UserPayloadScheme) (*model.UserScheme, *model.ResponseScheme, error)

Create creates a user. This resource is retained for legacy compatibility.

As soon as a more suitable alternative is available this resource will be deprecated.

The option is provided to set or generate a password for the user.

When using the option to generate a password, by omitting password from the request, include "notification": "true" to ensure the user is

sent an email advising them that their account is created.

This email includes a link for the user to set their password. If the notification isn't sent for a generated password,

the user will need to be sent a reset password request from Jira.

POST /rest/api/{2-3}user

https://docs.go-atlassian.io/jira-software-cloud/users#create-user

func (*UserService) Delete 

func (u *UserService) Delete(ctx context.Context, accountID string) (*model.ResponseScheme, error)

Delete deletes a user.

DELETE /rest/api/{2-3}/user

https://docs.go-atlassian.io/jira-software-cloud/users#delete-user

func (*UserService) Find 

func (u *UserService) Find(ctx context.Context, accountIDs []string, startAt, maxResults int) (*model.UserSearchPageScheme, *model.ResponseScheme, error)

Find returns a paginated list of the users specified by one or more account IDs.

GET /rest/api/{2-3}/user/bulk

https://docs.go-atlassian.io/jira-software-cloud/users#bulk-get-users

func (*UserService) Get 

func (u *UserService) Get(ctx context.Context, accountID string, expand []string) (*model.UserScheme, *model.ResponseScheme, error)

Get returns a user

GET /rest/api/{2-3}/user

https://docs.go-atlassian.io/jira-software-cloud/users#get-user

func (*UserService) Gets 

func (u *UserService) Gets(ctx context.Context, startAt, maxResults int) ([]*model.UserScheme, *model.ResponseScheme, error)

Gets returns a list of all (active and inactive) users.

GET /rest/api/{2-3}/users/search

https://docs.go-atlassian.io/jira-software-cloud/users#get-all-users

func (*UserService) Groups 

func (u *UserService) Groups(ctx context.Context, accountIDs string) ([]*model.UserGroupScheme, *model.ResponseScheme, error)

Groups returns the groups to which a user belongs.

GET /rest/api/{2-3}/user/groups

https://docs.go-atlassian.io/jira-software-cloud/users#get-user-groups

type VoteService 

type VoteService struct {
	// contains filtered or unexported fields
}

VoteService provides methods to manage votes on issues in Jira Service Management.

func NewVoteService 

func NewVoteService(client service.Connector, version string) (*VoteService, error)

NewVoteService creates a new instance of VoteService.

func (*VoteService) Add 

func (v *VoteService) Add(ctx context.Context, issueKeyOrID string) (*model.ResponseScheme, error)

Add adds the user's vote to an issue. This is the equivalent of the user clicking Vote on an issue in Jira.

This operation requires the Allow users to vote on issues option to be ON.

POST /rest/api/{2-3}/issue/{issueKeyOrID}/votes

https://docs.go-atlassian.io/jira-software-cloud/issues/vote#add-vote

func (*VoteService) Delete 

func (v *VoteService) Delete(ctx context.Context, issueKeyOrID string) (*model.ResponseScheme, error)

Delete deletes a user's vote from an issue. This is the equivalent of the user clicking Unvote on an issue in Jira.

This operation requires the Allow users to vote on issues option to be ON.

DELETE /rest/api/{2-3}/issue/{issueKeyOrID}/votes

https://docs.go-atlassian.io/jira-software-cloud/issues/vote#delete-vote

func (*VoteService) Gets 

func (v *VoteService) Gets(ctx context.Context, issueKeyOrID string) (*model.IssueVoteScheme, *model.ResponseScheme, error)

Gets returns details about the votes on an issue.

This operation requires allowing users to vote on issues option to be ON

GET /rest/api/{2-3}/issue/{issueKeyOrID}/votes

https://docs.go-atlassian.io/jira-software-cloud/issues/vote#get-votes

type WatcherService 

type WatcherService struct {
	// contains filtered or unexported fields
}

WatcherService provides methods to manage watchers in Jira Service Management.

func NewWatcherService 

func NewWatcherService(client service.Connector, version string) (*WatcherService, error)

NewWatcherService creates a new instance of WatcherService.

func (*WatcherService) Add 

func (w *WatcherService) Add(ctx context.Context, issueKeyOrID string, accountID ...string) (*model.ResponseScheme, error)

Add adds a user as a watcher of an issue by passing the account ID of the user.

For example, "5b10ac8d82e05b22cc7d4ef5". If no user is specified the calling user is added.

POST /rest/api/{2-3}/issue/{issueKeyOrID}/watchers

https://docs.go-atlassian.io/jira-software-cloud/issues/watcher#add-watcher

func (*WatcherService) Delete 

func (w *WatcherService) Delete(ctx context.Context, issueKeyOrID, accountID string) (*model.ResponseScheme, error)

Delete deletes a user as a watcher of an issue.

DELETE /rest/api/{2-3}/issue/{issueKeyOrID}/watchers

https://docs.go-atlassian.io/jira-software-cloud/issues/watcher#delete-watcher

func (*WatcherService) Gets 

func (w *WatcherService) Gets(ctx context.Context, issueKeyOrID string) (*model.IssueWatcherScheme, *model.ResponseScheme, error)

Gets returns the watchers for an issue.

GET /rest/api/{2-3}/issue/{issueKeyOrID}/watchers

https://docs.go-atlassian.io/jira-software-cloud/issues/watcher#get-issue-watchers

type WorkflowSchemeIssueTypeService 

type WorkflowSchemeIssueTypeService struct {
	// contains filtered or unexported fields
}

WorkflowSchemeIssueTypeService provides methods to manage issue type-workflow mappings in workflow schemes.

func NewWorkflowSchemeIssueTypeService 

func NewWorkflowSchemeIssueTypeService(client service.Connector, version string) *WorkflowSchemeIssueTypeService

NewWorkflowSchemeIssueTypeService creates a new instance of WorkflowSchemeIssueTypeService.

func (*WorkflowSchemeIssueTypeService) Delete 

func (w *WorkflowSchemeIssueTypeService) Delete(ctx context.Context, schemeID int, issueTypeID string, updateDraft bool) (*model.WorkflowSchemeScheme, *model.ResponseScheme, error)

Delete deletes the issue type-workflow mapping for an issue type in a workflow scheme.

Note that active workflow schemes cannot be edited.

If the workflow scheme is active, set updateDraftIfNeeded to true and a draft workflow scheme is created or

updated with the issue type-workflow mapping deleted.

The draft workflow scheme can be published in Jira.

DELETE /rest/api/{2-3}/workflowscheme/{id}/issuetype/{issueType}

https://docs.go-atlassian.io/jira-software-cloud/workflow/scheme/issue-type#delete-workflow-for-issue-type-in-workflow-scheme

func (*WorkflowSchemeIssueTypeService) Get 

func (w *WorkflowSchemeIssueTypeService) Get(ctx context.Context, schemeID int, issueTypeID string, returnDraft bool) (*model.IssueTypeWorkflowMappingScheme, *model.ResponseScheme, error)

Get returns the issue type-workflow mapping for an issue type in a workflow scheme.

GET /rest/api/{2-3}/workflowscheme/{id}/issuetype/{issueType}

https://docs.go-atlassian.io/jira-software-cloud/workflow/scheme/issue-type#get-workflow-for-issue-type-in-workflow-scheme

func (*WorkflowSchemeIssueTypeService) Mapping 

func (w *WorkflowSchemeIssueTypeService) Mapping(ctx context.Context, schemeID int, workflowName string, returnDraft bool) ([]*model.IssueTypesWorkflowMappingScheme, *model.ResponseScheme, error)

Mapping returns the workflow-issue type mappings for a workflow scheme.

GET /rest/api/{2-3}/workflowscheme/{id}/workflow

https://docs.go-atlassian.io/jira-software-cloud/workflow/scheme/issue-type#get-issue-types-for-workflows-in-workflow-scheme

func (*WorkflowSchemeIssueTypeService) Set 

func (w *WorkflowSchemeIssueTypeService) Set(ctx context.Context, schemeID int, issueTypeID string, payload *model.IssueTypeWorkflowPayloadScheme) (*model.WorkflowSchemeScheme, *model.ResponseScheme, error)

Set sets the workflow for an issue type in a workflow scheme.

Note that active workflow schemes cannot be edited.

If the workflow scheme is active, set updateDraftIfNeeded to true in the request body and a draft workflow scheme

is created or updated with the new issue type-workflow mapping.

The draft workflow scheme can be published in Jira.

PUT /rest/api/{2-3}/workflowscheme/{id}/issuetype/{issueType}

https://docs.go-atlassian.io/jira-software-cloud/workflow/scheme/issue-type#set-workflow-for-issue-type-in-workflow-scheme

type WorkflowSchemeService 

type WorkflowSchemeService struct {

	// IssueType is the service for managing workflow scheme issue types.
	IssueType *WorkflowSchemeIssueTypeService
	// contains filtered or unexported fields
}

WorkflowSchemeService provides methods to manage workflow schemes in Jira Service Management.

func NewWorkflowSchemeService 

func NewWorkflowSchemeService(client service.Connector, version string, issueType *WorkflowSchemeIssueTypeService) *WorkflowSchemeService

NewWorkflowSchemeService creates a new instance of WorkflowSchemeService.

func (*WorkflowSchemeService) Assign 

func (w *WorkflowSchemeService) Assign(ctx context.Context, schemeID, projectID string) (*model.ResponseScheme, error)

Assign assigns a workflow scheme to a project.

This operation is performed only when there are no issues in the project.

Workflow schemes can only be assigned to classic projects.

PUT /rest/api/{2-3}/workflowscheme/project

https://docs.go-atlassian.io/jira-software-cloud/workflow/scheme#get-workflow-schemes-associations

func (*WorkflowSchemeService) Associations 

func (w *WorkflowSchemeService) Associations(ctx context.Context, projectIDs []int) (*model.WorkflowSchemeAssociationPageScheme, *model.ResponseScheme, error)

Associations returns a list of the workflow schemes associated with a list of projects.

Each returned workflow scheme includes a list of the requested projects associated with it.

Any team-managed or non-existent projects in the request are ignored and no errors are returned.

If the project is associated with the Default Workflow Scheme no ID is returned.

This is because the way the Default Workflow Scheme is stored means it has no ID.

GET /rest/api/{2-3}/workflowscheme/project

https://docs.go-atlassian.io/jira-software-cloud/workflow/scheme#get-workflow-schemes-associations

func (*WorkflowSchemeService) Create 

func (w *WorkflowSchemeService) Create(ctx context.Context, payload *model.WorkflowSchemePayloadScheme) (*model.WorkflowSchemeScheme, *model.ResponseScheme, error)

Create creates a workflow scheme.

POST /rest/api/{2-3}/workflowscheme

https://docs.go-atlassian.io/jira-software-cloud/workflow/scheme#create-workflows-scheme

func (*WorkflowSchemeService) Delete 

func (w *WorkflowSchemeService) Delete(ctx context.Context, schemeID int) (*model.ResponseScheme, error)

Delete deletes a workflow scheme.

Note that a workflow scheme cannot be deleted if it is active (that is, being used by at least one project).

DELETE /rest/api/{2-3}/workflowscheme/{id}

https://docs.go-atlassian.io/jira-software-cloud/workflow/scheme#delete-workflow-scheme

func (*WorkflowSchemeService) Get 

func (w *WorkflowSchemeService) Get(ctx context.Context, schemeID int, returnDraftIfExists bool) (*model.WorkflowSchemeScheme, *model.ResponseScheme, error)

Get returns a workflow scheme

GET /rest/api/{2-3}/workflowscheme/{id}

https://docs.go-atlassian.io/jira-software-cloud/workflow/scheme#get-workflow-scheme

func (*WorkflowSchemeService) Gets 

func (w *WorkflowSchemeService) Gets(ctx context.Context, startAt, maxResults int) (*model.WorkflowSchemePageScheme, *model.ResponseScheme, error)

Gets returns a paginated list of all workflow schemes, not including draft workflow schemes.

GET /rest/api/{2-3}/workflowscheme

https://docs.go-atlassian.io/jira-software-cloud/workflow/scheme#gets-workflows-schemes

func (*WorkflowSchemeService) Update 

func (w *WorkflowSchemeService) Update(ctx context.Context, schemeID int, payload *model.WorkflowSchemePayloadScheme) (*model.WorkflowSchemeScheme, *model.ResponseScheme, error)

Update updates a workflow scheme, including the name, default workflow, issue type to project mappings, and more.

If the workflow scheme is active (that is, being used by at least one project), then a draft workflow scheme is created or updated instead,

provided that updateDraftIfNeeded is set to true.

PUT /rest/api/{2-3}/workflowscheme/{id}

https://docs.go-atlassian.io/jira-software-cloud/workflow/scheme#update-workflow-scheme

type WorkflowService 

type WorkflowService struct {

	// Scheme is the service for managing workflow schemes.
	Scheme *WorkflowSchemeService
	// Status is the service for managing workflow statuses.
	Status *WorkflowStatusService
	// contains filtered or unexported fields
}

WorkflowService provides methods to manage workflows in Jira Service Management.

func NewWorkflowService 

func NewWorkflowService(client service.Connector, version string, scheme *WorkflowSchemeService, status *WorkflowStatusService) (*WorkflowService, error)

NewWorkflowService creates a new instance of WorkflowService.

func (*WorkflowService) Capabilities 

func (w *WorkflowService) Capabilities(ctx context.Context, workflowID, projectID, issueTypeID string) (*model.WorkflowCapabilitiesScheme, *model.ResponseScheme, error)

Capabilities Get the list of workflow capabilities for a specific workflow using either the workflow ID, or the project and issue type ID pair.

The response includes the scope of the workflow, defined as global/project-based, and a list of project types that the workflow is scoped to.

It also includes all rules organised into their broad categories (conditions, validators, actions, triggers, screens) as well as the source location (Atlassian-provided, Connect, Forge).

GET /rest/api/{2-3}/workflows/capabilities

https://docs.go-atlassian.io/jira-software-cloud/workflow#get-workflow-capabilities

func (*WorkflowService) Create 

func (w *WorkflowService) Create(ctx context.Context, payload *model.WorkflowPayloadScheme) (*model.WorkflowCreatedResponseScheme, *model.ResponseScheme, error)

Create creates a workflow.

You can define transition rules using the shapes detailed in the following sections.

If no transitional rules are specified the default system transition rules are used.

POST /rest/api/{2-3}/workflow

https://docs.go-atlassian.io/jira-software-cloud/workflow#create-workflow

func (*WorkflowService) Creates 

func (w *WorkflowService) Creates(ctx context.Context, payload *model.WorkflowCreatesPayload) (*model.WorkflowCreateResponseScheme, *model.ResponseScheme, error)

Creates create workflows and related statuses.

This method allows you to create a workflow by defining transition rules using the shapes detailed in the Atlassian REST API documentation. If no transition rules are specified, the default system transition rules will be used.

POST /rest/api/{2-3}/workflows

For more details, refer to: https://docs.go-atlassian.io/jira-software-cloud/workflow#bulk-create-workflows

Example: 

payload := &models.WorkflowCreatesPayload{
	Scope: &models.WorkflowScopeScheme{Type: "GLOBAL"},
	// The workflows to create, with transition rules.
}

response, respScheme, err := client.Workflow.Creates(ctx, payload)
if err != nil {
	log.Fatalf("Failed to create workflow: %v", err)
}

fmt.Printf("Workflow created with ID: %s", response.ID)

func (*WorkflowService) Delete 

func (w *WorkflowService) Delete(ctx context.Context, workflowID string) (*model.ResponseScheme, error)

Delete deletes a workflow.

The workflow cannot be deleted if it is:

1. an active workflow. 2. a system workflow. 3. associated with any workflow scheme. 4. associated with any draft workflow scheme.

DELETE /rest/api/{2-3}/workflow/{workflowID}

https://docs.go-atlassian.io/jira-software-cloud/workflow#search-workflows

func (*WorkflowService) Gets 

func (w *WorkflowService) Gets(ctx context.Context, options *model.WorkflowSearchOptions, startAt, maxResults int) (*model.WorkflowPageScheme, *model.ResponseScheme, error)

Gets returns a paginated list of published classic workflows.

When workflow names are specified, details of those workflows are returned.

Otherwise, all published classic workflows are returned.

GET /rest/api/{2-3}/workflow/search

https://docs.go-atlassian.io/jira-software-cloud/workflow#search-workflows

func (*WorkflowService) Search 

func (w *WorkflowService) Search(ctx context.Context, options *model.WorkflowSearchCriteria, expand []string, transitionLinks bool) (*model.WorkflowReadResponseScheme, *model.ResponseScheme, error)

Search searches for workflows based on specified criteria.

This method returns a paginated list of workflows that match the search criteria provided in the `options` parameter.

The search can be expanded to include additional details, such as transition links, by specifying the `expand` and `transitionLinks` parameters.

When search criteria are provided in the `options` parameter, only workflows matching those criteria are returned. If no criteria are specified, all workflows are returned.

GET /rest/api/{2-3}/workflow/search

https://docs.go-atlassian.io/jira-software-cloud/workflow#bulk-get-workflows

func (*WorkflowService) Updates 

func (w *WorkflowService) Updates(ctx context.Context, payload *model.WorkflowUpdatesPayloadScheme, expand []string) (*model.WorkflowUpdateResponseScheme, *model.ResponseScheme, error)

Updates updates workflows.

This method allows you to update workflows by providing a payload containing the details of the updates. You can expand specific fields using the 'expand' parameter.

The update follows the API detailed in the Atlassian documentation.

POST /rest/api/{2-3}/workflows/update

For more details, refer to: https://docs.go-atlassian.io/jira-software-cloud/workflow#bulk-update-workflows

func (*WorkflowService) ValidateCreateWorkflows 

func (w *WorkflowService) ValidateCreateWorkflows(ctx context.Context, payload *model.ValidationOptionsForCreateScheme) (*model.WorkflowValidationErrorListScheme, *model.ResponseScheme, error)

ValidateCreateWorkflows validates workflows before creating them.

This method allows you to validate the configuration of one or more workflows before they are created in Jira. It helps ensure that the workflows adhere to the defined rules and constraints.

The validation checks will include all aspects of the workflows, such as transitions, statuses, and any related conditions or validators.

POST /rest/api/{2-3}/workflows/create/validation

For more details, refer to: https://docs.go-atlassian.io/jira-software-cloud/workflow#validate-create-workflows

Example: 

 ctx := context.Background()
 payload := &model.ValidationOptionsForCreateScheme{
     Payload: payload,
    Options: &models.ValidationOptionsLevelScheme{
		  Levels: []string{"ERROR", "WARNING"},
	  }

 validationResult, response, err := client.Workflow.ValidateCreateWorkflows(ctx, payload)
 if err != nil {
     log.Fatalf("Failed to validate workflow: %v", err)
 }

 if validationResult != nil {
     log.Printf("Workflow validation errors: %v", validationResult.Errors)
 }

 log.Printf("Validation response: %v", response)

func (*WorkflowService) ValidateUpdateWorkflows 

func (w *WorkflowService) ValidateUpdateWorkflows(ctx context.Context, payload *model.ValidationOptionsForUpdateScheme) (*model.WorkflowValidationErrorListScheme, *model.ResponseScheme, error)

ValidateUpdateWorkflows validates the update of one or more workflows.

This method allows you to validate changes to workflows before they are applied. The validation checks for potential issues that could prevent the workflows from being updated successfully.

The validation process will check for conditions such as: 

1.Whether the transitions are valid.
2. Whether the status and transition names are unique within the workflow.
3. If the validation fails, a list of validation errors is returned, which should be resolved before applying the changes.

POST /rest/api/{2-3}/workflows/update/validation

For more details, refer to: https://docs.go-atlassian.io/jira-software-cloud/workflow#validate-update-workflows

Example: 

options := &model.ValidationOptionsForUpdateScheme{
    // populate the validation options here
}

result, response, err := client.Workflow.ValidateUpdateWorkflows(ctx, options)
if err != nil {
    log.Fatalf("Validation failed: %v", err)
}

if len(result.Errors) > 0 {
    log.Printf("Validation errors: %v", result.Errors)
} else {
    log.Println("Validation passed, you can proceed with the update.")
}

type WorkflowStatusService 

type WorkflowStatusService struct {
	// contains filtered or unexported fields
}

WorkflowStatusService provides methods to manage workflow statuses in Jira Service Management.

func NewWorkflowStatusService 

func NewWorkflowStatusService(client service.Connector, version string) (*WorkflowStatusService, error)

NewWorkflowStatusService creates a new instance of WorkflowStatusService.

func (*WorkflowStatusService) Bulk 

func (w *WorkflowStatusService) Bulk(ctx context.Context) ([]*model.StatusDetailScheme, *model.ResponseScheme, error)

Bulk returns a list of all statuses associated with active workflows.

GET /rest/api/{2-3}/status

https://docs.go-atlassian.io/jira-software-cloud/workflow/status#bulk-workflow-statuses

func (*WorkflowStatusService) Create 

func (w *WorkflowStatusService) Create(ctx context.Context, payload *model.WorkflowStatusPayloadScheme) ([]*model.WorkflowStatusDetailScheme, *model.ResponseScheme, error)

Create creates statuses for a global or project scope.

POST /rest/api/{2-3}/statuses

https://docs.go-atlassian.io/jira-software-cloud/workflow/status#create-workflow-statuses

func (*WorkflowStatusService) Delete 

func (w *WorkflowStatusService) Delete(ctx context.Context, ids []string) (*model.ResponseScheme, error)

Delete deletes statuses by ID.

DELETE /rest/api/{2-3}/statuses

https://docs.go-atlassian.io/jira-software-cloud/workflow/status#delete-workflow-statuses

func (*WorkflowStatusService) Get 

func (w *WorkflowStatusService) Get(ctx context.Context, idOrName string) (*model.StatusDetailScheme, *model.ResponseScheme, error)

Get returns a status.

The status must be associated with an active workflow to be returned.

If a name is used on more than one status, only the status found first is returned.

Therefore, identifying the status by its ID may be preferable.

This operation can be accessed anonymously.

GET /rest/api/{2-3}/status/{idOrName}

https://docs.go-atlassian.io/jira-software-cloud/workflow/status#get-workflow-status

func (*WorkflowStatusService) Gets 

func (w *WorkflowStatusService) Gets(ctx context.Context, ids, expand []string) ([]*model.WorkflowStatusDetailScheme, *model.ResponseScheme, error)

Gets returns a list of the statuses specified by one or more status IDs.

GET /rest/api/{2-3}/statuses

https://docs.go-atlassian.io/jira-software-cloud/workflow/status#gets-workflow-statuses

func (*WorkflowStatusService) Search 

func (w *WorkflowStatusService) Search(ctx context.Context, options *model.WorkflowStatusSearchParams, startAt, maxResults int) (*model.WorkflowStatusDetailPageScheme, *model.ResponseScheme, error)

Search returns a paginated list of statuses that match a search on name or project.

GET /rest/api/{2-3}/statuses/search

https://docs.go-atlassian.io/jira-software-cloud/workflow/status#search-workflow-statuses

func (*WorkflowStatusService) Update 

func (w *WorkflowStatusService) Update(ctx context.Context, payload *model.WorkflowStatusPayloadScheme) (*model.ResponseScheme, error)

Update updates statuses by ID.

PUT /rest/api/{2-3}/statuses

https://docs.go-atlassian.io/jira-software-cloud/workflow/status#update-workflow-statuses

type WorklogADFService 

type WorklogADFService struct {
	// contains filtered or unexported fields
}

WorklogADFService provides methods to manage worklogs in Jira Service Management.

func NewWorklogADFService 

func NewWorklogADFService(client service.Connector, version string) (*WorklogADFService, error)

NewWorklogADFService creates a new instance of WorklogADFService.

func (*WorklogADFService) Add 

func (w *WorklogADFService) Add(ctx context.Context, issueKeyOrID string, payload *model.WorklogADFPayloadScheme, options *model.WorklogOptionsScheme) (*model.IssueWorklogADFScheme, *model.ResponseScheme, error)

Add adds a worklog to an issue.

Time tracking must be enabled in Jira, otherwise this operation returns an error.

POST /rest/api/3/issue/{issueKeyOrID}/worklog

https://docs.go-atlassian.io/jira-software-cloud/issues/worklogs#add-worklog

func (*WorklogADFService) Delete 

func (w *WorklogADFService) Delete(ctx context.Context, issueKeyOrID, worklogID string, options *model.WorklogOptionsScheme) (*model.ResponseScheme, error)

Delete deletes a worklog from an issue.

Time tracking must be enabled in Jira, otherwise this operation returns an error.

DELETE /rest/api/{2-3}/issue/{issueKeyOrID}/worklog/{id}

https://docs.go-atlassian.io/jira-software-cloud/issues/worklogs#delete-worklog

func (*WorklogADFService) Deleted 

func (w *WorklogADFService) Deleted(ctx context.Context, since int) (result *model.ChangedWorklogPageScheme, response *model.ResponseScheme, err error)

Deleted returns a list of IDs and delete timestamps for worklogs deleted after a date and time.

This resource is paginated, with a limit of 1000 worklogs per page. Each page lists worklogs from oldest to youngest. If the number of items in the date range exceeds 1000, until indicates the timestamp of the youngest item on the page. Also, nextPage provides the URL for the next page of worklogs. The lastPage parameter is set to true on the last page of worklogs.

This resource does not return worklogs deleted during the minute preceding the request.

GET /rest/api/{2-3}/worklog/deleted

https://docs.go-atlassian.io/jira-software-cloud/issues/worklogs#get-ids-of-deleted-worklogs

func (*WorklogADFService) Get 

func (w *WorklogADFService) Get(ctx context.Context, issueKeyOrID, worklogID string, expand []string) (*model.IssueWorklogADFScheme, *model.ResponseScheme, error)

Get returns a worklog.

Time tracking must be enabled in Jira, otherwise this operation returns an error.

GET /rest/api/{2-3}/issue/{issueKeyOrID}/worklog/{id}

https://docs.go-atlassian.io/jira-software-cloud/issues/worklogs#get-worklog

func (*WorklogADFService) Gets 

func (w *WorklogADFService) Gets(ctx context.Context, worklogIDs []int, expand []string) ([]*model.IssueWorklogADFScheme, *model.ResponseScheme, error)

Gets returns worklog details for a list of worklog IDs.

The returned list of worklogs is limited to 1000 items.

POST /rest/api/{2-3}/worklog/list

https://docs.go-atlassian.io/jira-software-cloud/issues/worklogs#get-worklogs

func (*WorklogADFService) Issue 

func (w *WorklogADFService) Issue(ctx context.Context, issueKeyOrID string, startAt, maxResults, after int, expand []string) (*model.IssueWorklogADFPageScheme, *model.ResponseScheme, error)

Issue returns worklogs for an issue, starting from the oldest worklog or from the worklog started on or after a date and time.

Time tracking must be enabled in Jira, otherwise this operation returns an error.

GET /rest/api/{2-3}/issue/{issueKeyOrID}/worklog

https://docs.go-atlassian.io/jira-software-cloud/issues/worklogs#get-issue-worklogs

func (*WorklogADFService) Update 

func (w *WorklogADFService) Update(ctx context.Context, issueKeyOrID, worklogID string, payload *model.WorklogADFPayloadScheme, options *model.WorklogOptionsScheme) (*model.IssueWorklogADFScheme, *model.ResponseScheme, error)

Update updates a worklog.

Time tracking must be enabled in Jira, otherwise this operation returns an error.

PUT /rest/api/3/issue/{issueKeyOrID}/worklog/{id}

https://docs.go-atlassian.io/jira-software-cloud/issues/worklogs#update-worklog

func (*WorklogADFService) Updated 

func (w *WorklogADFService) Updated(ctx context.Context, since int, expand []string) (*model.ChangedWorklogPageScheme, *model.ResponseScheme, error)

Updated returns a list of IDs and update timestamps for worklogs updated after a date and time.

This resource is paginated, with a limit of 1000 worklogs per page. Each page lists worklogs from oldest to youngest. If the number of items in the date range exceeds 1000, until indicates the timestamp of the youngest item on the page. Also, nextPage provides the URL for the next page of worklogs. The lastPage parameter is set to true on the last page of worklogs.

This resource does not return worklogs updated during the minute preceding the request.

GET /rest/api/{2-3}/worklog/updated

https://docs.go-atlassian.io/jira-software-cloud/issues/worklogs#get-ids-of-updated-worklogs

type WorklogRichTextService 

type WorklogRichTextService struct {
	// contains filtered or unexported fields
}

WorklogRichTextService provides methods to manage worklogs in Jira Service Management.

func NewWorklogRichTextService 

func NewWorklogRichTextService(client service.Connector, version string) (*WorklogRichTextService, error)

NewWorklogRichTextService creates a new instance of WorklogRichTextService.

func (*WorklogRichTextService) Add 

func (w *WorklogRichTextService) Add(ctx context.Context, issueKeyOrID string, payload *model.WorklogRichTextPayloadScheme, options *model.WorklogOptionsScheme) (*model.IssueWorklogRichTextScheme, *model.ResponseScheme, error)

Add adds a worklog to an issue.

Time tracking must be enabled in Jira, otherwise this operation returns an error.

POST /rest/api/2/issue/{issueKeyOrID}/worklog

https://docs.go-atlassian.io/jira-software-cloud/issues/worklogs#add-worklog

func (*WorklogRichTextService) Delete 

func (w *WorklogRichTextService) Delete(ctx context.Context, issueKeyOrID, worklogID string, options *model.WorklogOptionsScheme) (*model.ResponseScheme, error)

Delete deletes a worklog from an issue.

Time tracking must be enabled in Jira, otherwise this operation returns an error.

DELETE /rest/api/{2-3}/issue/{issueKeyOrID}/worklog/{id}

https://docs.go-atlassian.io/jira-software-cloud/issues/worklogs#delete-worklog

func (*WorklogRichTextService) Deleted 

func (w *WorklogRichTextService) Deleted(ctx context.Context, since int) (result *model.ChangedWorklogPageScheme, response *model.ResponseScheme, err error)

Deleted returns a list of IDs and delete timestamps for worklogs deleted after a date and time.

This resource is paginated, with a limit of 1000 worklogs per page. Each page lists worklogs from oldest to youngest. If the number of items in the date range exceeds 1000, until indicates the timestamp of the youngest item on the page. Also, nextPage provides the URL for the next page of worklogs. The lastPage parameter is set to true on the last page of worklogs.

This resource does not return worklogs deleted during the minute preceding the request.

GET /rest/api/{2-3}/worklog/deleted

https://docs.go-atlassian.io/jira-software-cloud/issues/worklogs#get-ids-of-deleted-worklogs

func (*WorklogRichTextService) Get 

func (w *WorklogRichTextService) Get(ctx context.Context, issueKeyOrID, worklogID string, expand []string) (*model.IssueWorklogRichTextScheme, *model.ResponseScheme, error)

Get returns a worklog.

Time tracking must be enabled in Jira, otherwise this operation returns an error.

GET /rest/api/{2-3}/issue/{issueKeyOrID}/worklog/{worklogID}

https://docs.go-atlassian.io/jira-software-cloud/issues/worklogs#get-worklog

func (*WorklogRichTextService) Gets 

func (w *WorklogRichTextService) Gets(ctx context.Context, worklogIDs []int, expand []string) ([]*model.IssueWorklogRichTextScheme, *model.ResponseScheme, error)

Gets returns worklog details for a list of worklog IDs.

The returned list of worklogs is limited to 1000 items.

POST /rest/api/{2-3}/worklog/list

https://docs.go-atlassian.io/jira-software-cloud/issues/worklogs#get-worklogs

func (*WorklogRichTextService) Issue 

func (w *WorklogRichTextService) Issue(ctx context.Context, issueKeyOrID string, startAt, maxResults, after int, expand []string) (*model.IssueWorklogRichTextPageScheme, *model.ResponseScheme, error)

Issue returns worklogs for an issue, starting from the oldest worklog or from the worklog started on or after a date and time.

Time tracking must be enabled in Jira, otherwise this operation returns an error.

GET /rest/api/{2-3}/issue/{issueKeyOrID}/worklog

https://docs.go-atlassian.io/jira-software-cloud/issues/worklogs#get-issue-worklogs

func (*WorklogRichTextService) Update 

func (w *WorklogRichTextService) Update(ctx context.Context, issueKeyOrID, worklogID string, payload *model.WorklogRichTextPayloadScheme, options *model.WorklogOptionsScheme) (*model.IssueWorklogRichTextScheme, *model.ResponseScheme, error)

Update updates a worklog.

Time tracking must be enabled in Jira, otherwise this operation returns an error.

PUT /rest/api/2/issue/{issueKeyOrID}/worklog/{worklogID}

https://docs.go-atlassian.io/jira-software-cloud/issues/worklogs#update-worklog

func (*WorklogRichTextService) Updated 

func (w *WorklogRichTextService) Updated(ctx context.Context, since int, expand []string) (*model.ChangedWorklogPageScheme, *model.ResponseScheme, error)

Updated returns a list of IDs and update timestamps for worklogs updated after a date and time.

This resource is paginated, with a limit of 1000 worklogs per page. Each page lists worklogs from oldest to youngest. If the number of items in the date range exceeds 1000, until indicates the timestamp of the youngest item on the page. Also, nextPage provides the URL for the next page of worklogs. The lastPage parameter is set to true on the last page of worklogs.

This resource does not return worklogs updated during the minute preceding the request.

GET /rest/api/{2-3}/worklog/updated

https://docs.go-atlassian.io/jira-software-cloud/issues/worklogs#get-ids-of-updated-worklogs

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.