Documentation ¶
Index ¶
- func NewAuthenticationService(client service.Connector) common.Authentication
- type ApprovalService
- func (s *ApprovalService) Answer(ctx context.Context, issueKeyOrID string, approvalID int, approve bool) (*model.CustomerApprovalScheme, *model.ResponseScheme, error)
- func (s *ApprovalService) Get(ctx context.Context, issueKeyOrID string, approvalID int) (*model.CustomerApprovalScheme, *model.ResponseScheme, error)
- func (s *ApprovalService) Gets(ctx context.Context, issueKeyOrID string, start, limit int) (*model.CustomerApprovalPageScheme, *model.ResponseScheme, error)
- type AttachmentService
- func (s *AttachmentService) Create(ctx context.Context, issueKeyOrID string, temporaryAttachmentIDs []string, ...) (*model.RequestAttachmentCreationScheme, *model.ResponseScheme, error)
- func (s *AttachmentService) Gets(ctx context.Context, issueKeyOrID string, start, limit int) (*model.RequestAttachmentPageScheme, *model.ResponseScheme, error)
- type AuthenticationService
- func (a *AuthenticationService) GetBasicAuth() (string, string)
- func (a *AuthenticationService) GetBearerToken() string
- func (a *AuthenticationService) GetUserAgent() string
- func (a *AuthenticationService) HasBasicAuth() bool
- func (a *AuthenticationService) HasSetExperimentalFlag() bool
- func (a *AuthenticationService) HasUserAgent() bool
- func (a *AuthenticationService) SetBasicAuth(mail, token string)
- func (a *AuthenticationService) SetBearerToken(token string)
- func (a *AuthenticationService) SetExperimentalFlag()
- func (a *AuthenticationService) SetUserAgent(agent string)
- type CommentService
- func (s *CommentService) Attachments(ctx context.Context, issueKeyOrID string, commentID, start, limit int) (*model.RequestAttachmentPageScheme, *model.ResponseScheme, error)
- func (s *CommentService) Create(ctx context.Context, issueKeyOrID, body string, public bool) (*model.RequestCommentScheme, *model.ResponseScheme, error)
- func (s *CommentService) Get(ctx context.Context, issueKeyOrID string, commentID int, expand []string) (*model.RequestCommentScheme, *model.ResponseScheme, error)
- func (s *CommentService) Gets(ctx context.Context, issueKeyOrID string, public bool, expand []string, ...) (*model.RequestCommentPageScheme, *model.ResponseScheme, error)
- type CustomerService
- func (c *CustomerService) Add(ctx context.Context, serviceDeskID int, accountIDs []string) (*model.ResponseScheme, error)
- func (c *CustomerService) Create(ctx context.Context, email, displayName string) (*model.CustomerScheme, *model.ResponseScheme, error)
- func (c *CustomerService) Gets(ctx context.Context, serviceDeskID int, query string, start, limit int) (*model.CustomerPageScheme, *model.ResponseScheme, error)
- func (c *CustomerService) Remove(ctx context.Context, serviceDeskID int, accountIDs []string) (*model.ResponseScheme, error)
- type FeedbackService
- func (s *FeedbackService) Delete(ctx context.Context, requestIDOrKey string) (*model.ResponseScheme, error)
- func (s *FeedbackService) Get(ctx context.Context, requestIDOrKey string) (*model.CustomerFeedbackScheme, *model.ResponseScheme, error)
- func (s *FeedbackService) Post(ctx context.Context, requestIDOrKey string, rating int, comment string) (*model.CustomerFeedbackScheme, *model.ResponseScheme, error)
- type InfoService
- type KnowledgebaseService
- func (k *KnowledgebaseService) Gets(ctx context.Context, serviceDeskID int, query string, highlight bool, ...) (*model.ArticlePageScheme, *model.ResponseScheme, error)
- func (k *KnowledgebaseService) Search(ctx context.Context, query string, highlight bool, start, limit int) (*model.ArticlePageScheme, *model.ResponseScheme, error)
- type OrganizationService
- func (o *OrganizationService) Add(ctx context.Context, organizationID int, accountIDs []string) (*model.ResponseScheme, error)
- func (o *OrganizationService) Associate(ctx context.Context, serviceDeskID, organizationID int) (*model.ResponseScheme, error)
- func (o *OrganizationService) Create(ctx context.Context, name string) (*model.OrganizationScheme, *model.ResponseScheme, error)
- func (o *OrganizationService) Delete(ctx context.Context, organizationID int) (*model.ResponseScheme, error)
- func (o *OrganizationService) Detach(ctx context.Context, serviceDeskID, organizationID int) (*model.ResponseScheme, error)
- func (o *OrganizationService) Get(ctx context.Context, organizationID int) (*model.OrganizationScheme, *model.ResponseScheme, error)
- func (o *OrganizationService) Gets(ctx context.Context, accountID string, start, limit int) (*model.OrganizationPageScheme, *model.ResponseScheme, error)
- func (o *OrganizationService) Project(ctx context.Context, accountID string, serviceDeskID, start, limit int) (*model.OrganizationPageScheme, *model.ResponseScheme, error)
- func (o *OrganizationService) Remove(ctx context.Context, organizationID int, accountIDs []string) (*model.ResponseScheme, error)
- func (o *OrganizationService) Users(ctx context.Context, organizationID, start, limit int) (*model.OrganizationUsersPageScheme, *model.ResponseScheme, error)
- type ParticipantService
- func (s *ParticipantService) Add(ctx context.Context, issueKeyOrID string, accountIDs []string) (*model.RequestParticipantPageScheme, *model.ResponseScheme, error)
- func (s *ParticipantService) Gets(ctx context.Context, issueKeyOrID string, start, limit int) (*model.RequestParticipantPageScheme, *model.ResponseScheme, error)
- func (s *ParticipantService) Remove(ctx context.Context, issueKeyOrID string, accountIDs []string) (*model.RequestParticipantPageScheme, *model.ResponseScheme, error)
- type QueueService
- func (q *QueueService) Get(ctx context.Context, serviceDeskID, queueID int, includeCount bool) (*model.ServiceDeskQueueScheme, *model.ResponseScheme, error)
- func (q *QueueService) Gets(ctx context.Context, serviceDeskID int, includeCount bool, start, limit int) (*model.ServiceDeskQueuePageScheme, *model.ResponseScheme, error)
- func (q *QueueService) Issues(ctx context.Context, serviceDeskID, queueID, start, limit int) (*model.ServiceDeskIssueQueueScheme, *model.ResponseScheme, error)
- type RequestService
- func (s *RequestService) Create(ctx context.Context, payload *model.CreateCustomerRequestPayloadScheme) (*model.CustomerRequestScheme, *model.ResponseScheme, error)
- func (s *RequestService) Get(ctx context.Context, issueKeyOrID string, expand []string) (*model.CustomerRequestScheme, *model.ResponseScheme, error)
- func (s *RequestService) Gets(ctx context.Context, options *model.ServiceRequestOptionScheme, ...) (*model.CustomerRequestPageScheme, *model.ResponseScheme, error)
- func (s *RequestService) Subscribe(ctx context.Context, issueKeyOrID string) (*model.ResponseScheme, error)
- func (s *RequestService) Transition(ctx context.Context, issueKeyOrID, transitionID, comment string) (*model.ResponseScheme, error)
- func (s *RequestService) Transitions(ctx context.Context, issueKeyOrID string, start, limit int) (*model.CustomerRequestTransitionPageScheme, *model.ResponseScheme, error)
- func (s *RequestService) Unsubscribe(ctx context.Context, issueKeyOrID string) (*model.ResponseScheme, error)
- type ServiceDeskService
- func (s *ServiceDeskService) Attach(ctx context.Context, serviceDeskID int, fileName string, file io.Reader) (*model.ServiceDeskTemporaryFileScheme, *model.ResponseScheme, error)
- func (s *ServiceDeskService) Get(ctx context.Context, serviceDeskID int) (*model.ServiceDeskScheme, *model.ResponseScheme, error)
- func (s *ServiceDeskService) Gets(ctx context.Context, start, limit int) (*model.ServiceDeskPageScheme, *model.ResponseScheme, error)
- type ServiceLevelAgreementService
- func (s *ServiceLevelAgreementService) Get(ctx context.Context, issueKeyOrID string, metricID int) (*model.RequestSLAScheme, *model.ResponseScheme, error)
- func (s *ServiceLevelAgreementService) Gets(ctx context.Context, issueKeyOrID string, start, limit int) (*model.RequestSLAPageScheme, *model.ResponseScheme, error)
- type ServiceRequestSubServices
- type TypeService
- func (t *TypeService) Create(ctx context.Context, serviceDeskID int, ...) (*model.RequestTypeScheme, *model.ResponseScheme, error)
- func (t *TypeService) Delete(ctx context.Context, serviceDeskID, requestTypeID int) (*model.ResponseScheme, error)
- func (t *TypeService) Fields(ctx context.Context, serviceDeskID, requestTypeID int) (*model.RequestTypeFieldsScheme, *model.ResponseScheme, error)
- func (t *TypeService) Get(ctx context.Context, serviceDeskID, requestTypeID int) (*model.RequestTypeScheme, *model.ResponseScheme, error)
- func (t *TypeService) Gets(ctx context.Context, serviceDeskID, groupID, start, limit int) (*model.ProjectRequestTypePageScheme, *model.ResponseScheme, error)
- func (t *TypeService) Search(ctx context.Context, query string, start, limit int) (*model.RequestTypePageScheme, *model.ResponseScheme, error)
- type WorkSpaceService
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewAuthenticationService ¶
func NewAuthenticationService(client service.Connector) common.Authentication
Types ¶
type ApprovalService ¶
type ApprovalService struct {
// contains filtered or unexported fields
}
func NewApprovalService ¶
func NewApprovalService(client service.Connector, version string) *ApprovalService
func (*ApprovalService) Answer ¶
func (s *ApprovalService) Answer(ctx context.Context, issueKeyOrID string, approvalID int, approve bool) (*model.CustomerApprovalScheme, *model.ResponseScheme, error)
Answer enables a user to Approve or Decline an approval on a customer request.
The approval is assumed to be owned by the user making the call.
POST /rest/servicedeskapi/request/{issueIdOrKey}/approval/{approvalId}
https://docs.go-atlassian.io/jira-service-management-cloud/request/approval#answer-approval
func (*ApprovalService) Get ¶
func (s *ApprovalService) Get(ctx context.Context, issueKeyOrID string, approvalID int) (*model.CustomerApprovalScheme, *model.ResponseScheme, error)
Get returns an approval. Use this method to determine the status of an approval and the list of approvers.
GET /rest/servicedeskapi/request/{issueIdOrKey}/approval/{approvalId}
https://docs.go-atlassian.io/jira-service-management-cloud/request/approval#get-approval-by-id
func (*ApprovalService) Gets ¶
func (s *ApprovalService) Gets(ctx context.Context, issueKeyOrID string, start, limit int) (*model.CustomerApprovalPageScheme, *model.ResponseScheme, error)
Gets returns all approvals on a customer request.
GET /rest/servicedeskapi/request/{issueIdOrKey}/approval
https://docs.go-atlassian.io/jira-service-management-cloud/request/approval#get-approvals
type AttachmentService ¶
type AttachmentService struct {
// contains filtered or unexported fields
}
func NewAttachmentService ¶
func NewAttachmentService(client service.Connector, version string) *AttachmentService
func (*AttachmentService) Create ¶
func (s *AttachmentService) Create(ctx context.Context, issueKeyOrID string, temporaryAttachmentIDs []string, public bool) (*model.RequestAttachmentCreationScheme, *model.ResponseScheme, error)
Create adds one or more temporary files (attached to the request's service desk using
servicedesk/{serviceDeskId}/attachTemporaryFile) as attachments to a customer request
POST /rest/servicedeskapi/request/{issueIdOrKey}/attachment
https://docs.go-atlassian.io/jira-service-management-cloud/request/attachment#create-attachment
func (*AttachmentService) Gets ¶
func (s *AttachmentService) Gets(ctx context.Context, issueKeyOrID string, start, limit int) (*model.RequestAttachmentPageScheme, *model.ResponseScheme, error)
Gets returns all the attachments for a customer requests.
GET /rest/servicedeskapi/request/{issueIdOrKey}/attachment
type AuthenticationService ¶
type AuthenticationService struct {
// contains filtered or unexported fields
}
func (*AuthenticationService) GetBasicAuth ¶
func (a *AuthenticationService) GetBasicAuth() (string, string)
func (*AuthenticationService) GetBearerToken ¶ added in v1.5.0
func (a *AuthenticationService) GetBearerToken() string
func (*AuthenticationService) GetUserAgent ¶
func (a *AuthenticationService) GetUserAgent() string
func (*AuthenticationService) HasBasicAuth ¶
func (a *AuthenticationService) HasBasicAuth() bool
func (*AuthenticationService) HasSetExperimentalFlag ¶
func (a *AuthenticationService) HasSetExperimentalFlag() bool
func (*AuthenticationService) HasUserAgent ¶
func (a *AuthenticationService) HasUserAgent() bool
func (*AuthenticationService) SetBasicAuth ¶
func (a *AuthenticationService) SetBasicAuth(mail, token string)
func (*AuthenticationService) SetBearerToken ¶ added in v1.5.0
func (a *AuthenticationService) SetBearerToken(token string)
func (*AuthenticationService) SetExperimentalFlag ¶
func (a *AuthenticationService) SetExperimentalFlag()
func (*AuthenticationService) SetUserAgent ¶
func (a *AuthenticationService) SetUserAgent(agent string)
type CommentService ¶
type CommentService struct {
// contains filtered or unexported fields
}
func NewCommentService ¶
func NewCommentService(client service.Connector, version string) *CommentService
func (*CommentService) Attachments ¶
func (s *CommentService) Attachments(ctx context.Context, issueKeyOrID string, commentID, start, limit int) (*model.RequestAttachmentPageScheme, *model.ResponseScheme, error)
Attachments returns the attachments referenced in a comment.
GET /rest/servicedeskapi/request/{issueIdOrKey}/comment/{commentId}/attachment
https://docs.go-atlassian.io/jira-service-management-cloud/request/comments#get-comment-attachments
func (*CommentService) Create ¶
func (s *CommentService) Create(ctx context.Context, issueKeyOrID, body string, public bool) (*model.RequestCommentScheme, *model.ResponseScheme, error)
Create creates a public or private (internal) comment on a customer request, with the comment visibility set by public.
POST /rest/servicedeskapi/request/{issueIdOrKey}/comment
https://docs.go-atlassian.io/jira-service-management-cloud/request/comments#create-request-comment
func (*CommentService) Get ¶
func (s *CommentService) Get(ctx context.Context, issueKeyOrID string, commentID int, expand []string) (*model.RequestCommentScheme, *model.ResponseScheme, error)
Get returns details of a customer request's comment.
GET /rest/servicedeskapi/request/{issueIdOrKey}/comment/{commentId}
func (*CommentService) Gets ¶
func (s *CommentService) Gets(ctx context.Context, issueKeyOrID string, public bool, expand []string, start, limit int) (*model.RequestCommentPageScheme, *model.ResponseScheme, error)
Gets returns all comments on a customer request.
No permissions error is provided if, for example, the user doesn't have access to the service desk or request,
the method simply returns an empty response.
GET /rest/servicedeskapi/request/{issueIdOrKey}/comment
https://docs.go-atlassian.io/jira-service-management-cloud/request/comments#get-request-comments
type CustomerService ¶
type CustomerService struct {
// contains filtered or unexported fields
}
func NewCustomerService ¶
func NewCustomerService(client service.Connector, version string) *CustomerService
func (*CustomerService) Add ¶
func (c *CustomerService) Add(ctx context.Context, serviceDeskID int, accountIDs []string) (*model.ResponseScheme, error)
Add adds one or more customers to a service desk.
POST /rest/servicedeskapi/servicedesk/{serviceDeskId}/customer
https://docs.go-atlassian.io/jira-service-management-cloud/customer#add-customers
func (*CustomerService) Create ¶
func (c *CustomerService) Create(ctx context.Context, email, displayName string) (*model.CustomerScheme, *model.ResponseScheme, error)
Create adds a customer to the Jira Service Management
instance by passing a JSON file including an email address and display name.
The display name does not need to be unique. The record's identifiers,
name and key, are automatically generated from the request details.
POST /rest/servicedeskapi/customer
https://docs.go-atlassian.io/jira-service-management-cloud/customer#create-customer
func (*CustomerService) Gets ¶
func (c *CustomerService) Gets(ctx context.Context, serviceDeskID int, query string, start, limit int) (*model.CustomerPageScheme, *model.ResponseScheme, error)
Gets returns a list of the customers on a service desk.
GET /rest/servicedeskapi/servicedesk/{serviceDeskId}/customer
https://docs.go-atlassian.io/jira-service-management-cloud/customer#get-customers
func (*CustomerService) Remove ¶
func (c *CustomerService) Remove(ctx context.Context, serviceDeskID int, accountIDs []string) (*model.ResponseScheme, error)
Remove removes one or more customers from a service desk. The service desk must have closed access
DELETE /rest/servicedeskapi/servicedesk/{serviceDeskId}/customer
https://docs.go-atlassian.io/jira-service-management-cloud/customer#remove-customers
type FeedbackService ¶
type FeedbackService struct {
// contains filtered or unexported fields
}
func NewFeedbackService ¶
func NewFeedbackService(client service.Connector, version string) *FeedbackService
func (*FeedbackService) Delete ¶
func (s *FeedbackService) Delete(ctx context.Context, requestIDOrKey string) (*model.ResponseScheme, error)
Delete deletes the feedback of request using its requestKey or requestId
DELETE /rest/servicedeskapi/request/{requestIdOrKey}/feedback
https://docs.go-atlassian.io/jira-service-management-cloud/request/feedback#delete-feedback
func (*FeedbackService) Get ¶
func (s *FeedbackService) Get(ctx context.Context, requestIDOrKey string) (*model.CustomerFeedbackScheme, *model.ResponseScheme, error)
Get retrieves a feedback of a request using it's requestKey or requestId
GET /rest/servicedeskapi/request/{requestIdOrKey}/feedback
https://docs.go-atlassian.io/jira-service-management-cloud/request/feedback#get-feedback
func (*FeedbackService) Post ¶
func (s *FeedbackService) Post(ctx context.Context, requestIDOrKey string, rating int, comment string) (*model.CustomerFeedbackScheme, *model.ResponseScheme, error)
Post adds a feedback on a request using its requestKey or requestId
POST /rest/servicedeskapi/request/{requestIdOrKey}/feedback
https://docs.go-atlassian.io/jira-service-management-cloud/request/feedback#post-feedback
type InfoService ¶
type InfoService struct {
// contains filtered or unexported fields
}
func NewInfoService ¶
func NewInfoService(client service.Connector, version string) *InfoService
func (*InfoService) Get ¶
func (i *InfoService) Get(ctx context.Context) (*model.InfoScheme, *model.ResponseScheme, error)
Get retrieves information about the Jira Service Management instance such as software version, builds, and related links.
GET /rest/servicedeskapi/info
https://docs.go-atlassian.io/jira-service-management-cloud/info#get-info
type KnowledgebaseService ¶
type KnowledgebaseService struct {
// contains filtered or unexported fields
}
func NewKnowledgebaseService ¶
func NewKnowledgebaseService(client service.Connector, version string) *KnowledgebaseService
func (*KnowledgebaseService) Gets ¶
func (k *KnowledgebaseService) Gets(ctx context.Context, serviceDeskID int, query string, highlight bool, start, limit int) (*model.ArticlePageScheme, *model.ResponseScheme, error)
Gets returns articles which match the given query string across all service desks.
GET /rest/servicedeskapi/servicedesk/{serviceDeskId}/knowledgebase/article
https://docs.go-atlassian.io/jira-service-management-cloud/knowledgebase#get-articles
func (*KnowledgebaseService) Search ¶
func (k *KnowledgebaseService) Search(ctx context.Context, query string, highlight bool, start, limit int) (*model.ArticlePageScheme, *model.ResponseScheme, error)
Search returns articles which match the given query string across all service desks.
GET /rest/servicedeskapi/knowledgebase/article
https://docs.go-atlassian.io/jira-service-management-cloud/knowledgebase#search-articles
type OrganizationService ¶
type OrganizationService struct {
// contains filtered or unexported fields
}
func NewOrganizationService ¶
func NewOrganizationService(client service.Connector, version string) *OrganizationService
func (*OrganizationService) Add ¶
func (o *OrganizationService) Add(ctx context.Context, organizationID int, accountIDs []string) (*model.ResponseScheme, error)
Add adds users to an organization.
POST /rest/servicedeskapi/organization/{organizationId}/user
https://docs.go-atlassian.io/jira-service-management-cloud/organization#add-users-to-organization
func (*OrganizationService) Associate ¶
func (o *OrganizationService) Associate(ctx context.Context, serviceDeskID, organizationID int) (*model.ResponseScheme, error)
Associate adds an organization to a service desk.
If the organization ID is already associated with the service desk,
no change is made and the resource returns a 204 success code.
POST /rest/servicedeskapi/servicedesk/{serviceDeskId}/organization
https://docs.go-atlassian.io/jira-service-management-cloud/organization#associate-organization
func (*OrganizationService) Create ¶
func (o *OrganizationService) Create(ctx context.Context, name string) (*model.OrganizationScheme, *model.ResponseScheme, error)
Create creates an organization by passing the name of the organization.
POST /rest/servicedeskapi/organization
https://docs.go-atlassian.io/jira-service-management-cloud/organization#create-organization
func (*OrganizationService) Delete ¶
func (o *OrganizationService) Delete(ctx context.Context, organizationID int) (*model.ResponseScheme, error)
Delete deletes an organization.
Note that the organization is deleted regardless of other associations it may have.
For example, associations with service desks.
DELETE /rest/servicedeskapi/organization/{organizationId}
https://docs.go-atlassian.io/jira-service-management/organization#delete-organization
func (*OrganizationService) Detach ¶
func (o *OrganizationService) Detach(ctx context.Context, serviceDeskID, organizationID int) (*model.ResponseScheme, error)
Detach removes an organization from a service desk.
If the organization ID does not match an organization associated with the service desk,
no change is made and the resource returns a 204 success code.
DELETE /rest/servicedeskapi/servicedesk/{serviceDeskId}/organization
https://docs.go-atlassian.io/jira-service-management-cloud/organization#detach-organization
func (*OrganizationService) Get ¶
func (o *OrganizationService) Get(ctx context.Context, organizationID int) (*model.OrganizationScheme, *model.ResponseScheme, error)
Get returns details of an organization.
Use this method to get organization details whenever your application component is passed an organization ID ¶
but needs to display other organization details.
GET /rest/servicedeskapi/organization/{organizationId}
https://docs.go-atlassian.io/jira-service-management-cloud/organization#get-organization
func (*OrganizationService) Gets ¶
func (o *OrganizationService) Gets(ctx context.Context, accountID string, start, limit int) (*model.OrganizationPageScheme, *model.ResponseScheme, error)
Gets returns a list of organizations in the Jira Service Management instance.
Use this method when you want to present a list of organizations or want to locate an organization by name.
GET /rest/servicedeskapi/organization
https://docs.go-atlassian.io/jira-service-management-cloud/organization#get-organizations
func (*OrganizationService) Project ¶
func (o *OrganizationService) Project(ctx context.Context, accountID string, serviceDeskID, start, limit int) (*model.OrganizationPageScheme, *model.ResponseScheme, error)
Project returns a list of all organizations associated with a service desk.
GET /rest/servicedeskapi/servicedesk/{serviceDeskId}/organization
https://docs.go-atlassian.io/jira-service-management/organization#get-project-organizations
func (*OrganizationService) Remove ¶
func (o *OrganizationService) Remove(ctx context.Context, organizationID int, accountIDs []string) (*model.ResponseScheme, error)
Remove removes users from an organization.
DELETE /rest/servicedeskapi/organization/{organizationId}/user
func (*OrganizationService) Users ¶
func (o *OrganizationService) Users(ctx context.Context, organizationID, start, limit int) (*model.OrganizationUsersPageScheme, *model.ResponseScheme, error)
Users returns all the users associated with an organization.
Use this method where you want to provide a list of users for an ¶
organization or determine if a user is associated with an organization.
GET /rest/servicedeskapi/organization/{organizationId}/user
https://docs.go-atlassian.io/jira-service-management-cloud/organization#get-users-in-organization
type ParticipantService ¶
type ParticipantService struct {
// contains filtered or unexported fields
}
func NewParticipantService ¶
func NewParticipantService(client service.Connector, version string) *ParticipantService
func (*ParticipantService) Add ¶
func (s *ParticipantService) Add(ctx context.Context, issueKeyOrID string, accountIDs []string) (*model.RequestParticipantPageScheme, *model.ResponseScheme, error)
Add adds participants to a customer request.
POST /rest/servicedeskapi/request/{issueIdOrKey}/participant
func (*ParticipantService) Gets ¶
func (s *ParticipantService) Gets(ctx context.Context, issueKeyOrID string, start, limit int) (*model.RequestParticipantPageScheme, *model.ResponseScheme, error)
Gets returns a list of all the participants on a customer request.
GET /rest/servicedeskapi/request/{issueIdOrKey}/participant
func (*ParticipantService) Remove ¶
func (s *ParticipantService) Remove(ctx context.Context, issueKeyOrID string, accountIDs []string) (*model.RequestParticipantPageScheme, *model.ResponseScheme, error)
Remove removes participants from a customer request.
DELETE /rest/servicedeskapi/request/{issueIdOrKey}/participant
type QueueService ¶
type QueueService struct {
// contains filtered or unexported fields
}
func NewQueueService ¶
func NewQueueService(client service.Connector, version string) *QueueService
func (*QueueService) Get ¶
func (q *QueueService) Get(ctx context.Context, serviceDeskID, queueID int, includeCount bool) (*model.ServiceDeskQueueScheme, *model.ResponseScheme, error)
Get returns a specific queues in a service desk.
GET /rest/servicedeskapi/servicedesk/{serviceDeskId}/queue/{queueId}
https://docs.go-atlassian.io/jira-service-management-cloud/request/service-desk/queue#get-queue
func (*QueueService) Gets ¶
func (q *QueueService) Gets(ctx context.Context, serviceDeskID int, includeCount bool, start, limit int) (*model.ServiceDeskQueuePageScheme, *model.ResponseScheme, error)
Gets returns the queues in a service desk
GET /rest/servicedeskapi/servicedesk/{serviceDeskId}/queue
https://docs.go-atlassian.io/jira-service-management-cloud/request/service-desk/queue#get-queues
func (*QueueService) Issues ¶
func (q *QueueService) Issues(ctx context.Context, serviceDeskID, queueID, start, limit int) (*model.ServiceDeskIssueQueueScheme, *model.ResponseScheme, error)
Issues returns the customer requests in a queue
GET /rest/servicedeskapi/servicedesk/{serviceDeskId}/queue/{queueId}/issue
type RequestService ¶
type RequestService struct { Approval *ApprovalService Attachment *AttachmentService Comment *CommentService Participant *ParticipantService SLA *ServiceLevelAgreementService Feedback *FeedbackService Type *TypeService // contains filtered or unexported fields }
func NewRequestService ¶
func NewRequestService(client service.Connector, version string, subServices *ServiceRequestSubServices) (*RequestService, error)
func (*RequestService) Create ¶
func (s *RequestService) Create(ctx context.Context, payload *model.CreateCustomerRequestPayloadScheme) (*model.CustomerRequestScheme, *model.ResponseScheme, error)
Create creates a customer request in a service desk.
The JSON request must include the service desk and customer request type, as well as any fields that are required for the request type.
POST /rest/servicedeskapi/request
https://docs.go-atlassian.io/jira-service-management/request#create-customer-request
func (*RequestService) Get ¶
func (s *RequestService) Get(ctx context.Context, issueKeyOrID string, expand []string) (*model.CustomerRequestScheme, *model.ResponseScheme, error)
Get returns a customer request.
GET /rest/servicedeskapi/request/{issueIdOrKey}
https://docs.go-atlassian.io/jira-service-management-cloud/request#get-customer-request-by-id-or-key
func (*RequestService) Gets ¶
func (s *RequestService) Gets(ctx context.Context, options *model.ServiceRequestOptionScheme, start, limit int) (*model.CustomerRequestPageScheme, *model.ResponseScheme, error)
Gets returns all customer requests for the user executing the query.
The returned customer requests are ordered chronologically by the latest activity on each request. For example, the latest status transition or comment.
GET /rest/servicedeskapi/request
https://docs.go-atlassian.io/jira-service-management-cloud/request#get-customer-requests
func (*RequestService) Subscribe ¶
func (s *RequestService) Subscribe(ctx context.Context, issueKeyOrID string) (*model.ResponseScheme, error)
Subscribe subscribes the user to receiving notifications from a customer request.
PUT /rest/servicedeskapi/request/{issueIdOrKey}/notification
https://docs.go-atlassian.io/jira-service-management-cloud/request#subscribe
func (*RequestService) Transition ¶
func (s *RequestService) Transition(ctx context.Context, issueKeyOrID, transitionID, comment string) (*model.ResponseScheme, error)
Transition performs a customer transition for a given request and transition.
An optional comment can be included to provide a reason for the transition.
POST /rest/servicedeskapi/request/{issueIdOrKey}/transition
https://docs.go-atlassian.io/jira-service-management-cloud/request#perform-customer-transition
func (*RequestService) Transitions ¶
func (s *RequestService) Transitions(ctx context.Context, issueKeyOrID string, start, limit int) (*model.CustomerRequestTransitionPageScheme, *model.ResponseScheme, error)
Transitions returns a list of transitions, the workflow processes that moves a customer request from one status to another, that the user can perform on a request.
GET /rest/servicedeskapi/request/{issueIdOrKey}/transition
https://docs.go-atlassian.io/jira-service-management-cloud/request#get-customer-transitions
func (*RequestService) Unsubscribe ¶
func (s *RequestService) Unsubscribe(ctx context.Context, issueKeyOrID string) (*model.ResponseScheme, error)
Unsubscribe unsubscribes the user from notifications from a customer request.
DELETE /rest/servicedeskapi/request/{issueIdOrKey}/notification
https://docs.go-atlassian.io/jira-service-management-cloud/request#unsubscribe
type ServiceDeskService ¶
type ServiceDeskService struct { Queue *QueueService // contains filtered or unexported fields }
func NewServiceDeskService ¶
func NewServiceDeskService(client service.Connector, version string, queue *QueueService) (*ServiceDeskService, error)
func (*ServiceDeskService) Attach ¶
func (s *ServiceDeskService) Attach(ctx context.Context, serviceDeskID int, fileName string, file io.Reader) (*model.ServiceDeskTemporaryFileScheme, *model.ResponseScheme, error)
Attach one temporary attachments to a service desk
POST /rest/servicedeskapi/servicedesk/{serviceDeskId}/attachTemporaryFile
func (*ServiceDeskService) Get ¶
func (s *ServiceDeskService) Get(ctx context.Context, serviceDeskID int) (*model.ServiceDeskScheme, *model.ResponseScheme, error)
Get returns a service desk.
Use this method to get service desk details whenever your application component is passed a service desk ID ¶
but needs to display other service desk details.
GET /rest/servicedeskapi/servicedesk/{serviceDeskId}
func (*ServiceDeskService) Gets ¶
func (s *ServiceDeskService) Gets(ctx context.Context, start, limit int) (*model.ServiceDeskPageScheme, *model.ResponseScheme, error)
Gets returns all the service desks in the Jira Service Management instance that the user has permission to access.
GET /rest/servicedeskapi/servicedesk
https://docs.go-atlassian.io/jira-service-management-cloud/request/service-desk#get-service-desks
type ServiceLevelAgreementService ¶
type ServiceLevelAgreementService struct {
// contains filtered or unexported fields
}
func NewServiceLevelAgreementService ¶
func NewServiceLevelAgreementService(client service.Connector, version string) *ServiceLevelAgreementService
func (*ServiceLevelAgreementService) Get ¶
func (s *ServiceLevelAgreementService) Get(ctx context.Context, issueKeyOrID string, metricID int) (*model.RequestSLAScheme, *model.ResponseScheme, error)
Get returns the details for an SLA on a customer request.
GET /rest/servicedeskapi/request/{issueIdOrKey}/sla/{slaMetricId}
https://docs.go-atlassian.io/jira-service-management-cloud/request/sla#get-sla-information-by-id
func (*ServiceLevelAgreementService) Gets ¶
func (s *ServiceLevelAgreementService) Gets(ctx context.Context, issueKeyOrID string, start, limit int) (*model.RequestSLAPageScheme, *model.ResponseScheme, error)
Gets returns all the SLA records on a customer request.
A customer request can have zero or more SLAs. Each SLA can have recordings for zero or more "completed cycles" and zero or 1 "ongoing cycle".
GET /rest/servicedeskapi/request/{issueIdOrKey}/sla
https://docs.go-atlassian.io/jira-service-management-cloud/request/sla#get-sla-information
type ServiceRequestSubServices ¶
type ServiceRequestSubServices struct { Approval *ApprovalService Attachment *AttachmentService Comment *CommentService Participant *ParticipantService SLA *ServiceLevelAgreementService Feedback *FeedbackService Type *TypeService }
type TypeService ¶
type TypeService struct {
// contains filtered or unexported fields
}
func NewTypeService ¶
func NewTypeService(client service.Connector, version string) *TypeService
func (*TypeService) Create ¶
func (t *TypeService) Create(ctx context.Context, serviceDeskID int, payload *model.RequestTypePayloadScheme) (*model.RequestTypeScheme, *model.ResponseScheme, error)
Create enables a customer request type to be added to a service desk based on an issue type.
POST /rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype
https://docs.go-atlassian.io/jira-service-management-cloud/request/types#create-request-type
func (*TypeService) Delete ¶
func (t *TypeService) Delete(ctx context.Context, serviceDeskID, requestTypeID int) (*model.ResponseScheme, error)
Delete deletes a customer request type from a service desk, and removes it from all customer requests.
DELETE /rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype/{requestTypeId}
https://docs.go-atlassian.io/jira-service-management-cloud/request/types#delete-request-type
func (*TypeService) Fields ¶
func (t *TypeService) Fields(ctx context.Context, serviceDeskID, requestTypeID int) (*model.RequestTypeFieldsScheme, *model.ResponseScheme, error)
Fields returns the fields for a service desk's customer request type.
GET /rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype/{requestTypeId}/field
https://docs.go-atlassian.io/jira-service-management-cloud/request/types#get-request-type-fields
func (*TypeService) Get ¶
func (t *TypeService) Get(ctx context.Context, serviceDeskID, requestTypeID int) (*model.RequestTypeScheme, *model.ResponseScheme, error)
Get returns a customer request type from a service desk.
GET /rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype/{requestTypeId}
https://docs.go-atlassian.io/jira-service-management-cloud/request/types#get-request-type-by-id
func (*TypeService) Gets ¶
func (t *TypeService) Gets(ctx context.Context, serviceDeskID, groupID, start, limit int) (*model.ProjectRequestTypePageScheme, *model.ResponseScheme, error)
Gets returns all customer request types from a service desk.
GET /rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype
https://docs.go-atlassian.io/jira-service-management-cloud/request/types#get-request-types
func (*TypeService) Search ¶
func (t *TypeService) Search(ctx context.Context, query string, start, limit int) (*model.RequestTypePageScheme, *model.ResponseScheme, error)
Search returns all customer request types used in the Jira Service Management instance, optionally filtered by a query string.
GET /rest/servicedeskapi/requesttype
https://docs.go-atlassian.io/jira-service-management-cloud/request/types#get-all-request-types
type WorkSpaceService ¶ added in v1.5.1
type WorkSpaceService struct {
// contains filtered or unexported fields
}
func NewWorkSpaceService ¶ added in v1.5.1
func NewWorkSpaceService(client service.Connector, version string) *WorkSpaceService
func (*WorkSpaceService) Gets ¶ added in v1.5.1
func (w *WorkSpaceService) Gets(ctx context.Context) (*model.WorkSpacePageScheme, *model.ResponseScheme, error)
Gets retrieves workspace assets
This endpoint is used to fetch the assets associated with a workspace.
These assets may include knowledge base articles, request types, request fields, customer portals, queues, etc.
GET /rest/servicedeskapi/assets/workspace
https://docs.go-atlassian.io/jira-service-management/workspaces#get-workspaces