internal

package
v2.2.0 Latest Latest
Warning

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

 Go to latest Published: Mar 10, 2025 License: MIT Imports: 14 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.

Types

type ApprovalService 

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

ApprovalService provides methods to interact with approval operations in Jira Service Management.

func NewApprovalService 

func NewApprovalService(client service.Connector, version string) *ApprovalService

NewApprovalService creates a new instance of ApprovalService. It takes a service.Connector and a version string as input and returns a pointer to 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/{issueKeyOrID}/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/{issueKeyOrID}/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/{issueKeyOrID}/approval

https://docs.go-atlassian.io/jira-service-management-cloud/request/approval#get-approvals

type AttachmentService 

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

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

func NewAttachmentService 

func NewAttachmentService(client service.Connector, version string) *AttachmentService

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

func (*AttachmentService) Create 

func (s *AttachmentService) Create(ctx context.Context, issueKeyOrID string, payload *model.RequestAttachmentCreationPayloadScheme) (*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/{issueKeyOrID}/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/{issueKeyOrID}/attachment

https://docs.go-atlassian.io/jira-service-management-cloud/request/attachment#get-attachments-for-request

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 true if the experimental flag has been 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 sets the experimental flag.

func (*AuthenticationService) SetUserAgent 

func (a *AuthenticationService) SetUserAgent(agent string)

SetUserAgent sets the user agent string.

type CommentService 

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

CommentService provides methods to interact with comment operations in Jira Service Management.

func NewCommentService 

func NewCommentService(client service.Connector, version string) *CommentService

NewCommentService creates a new instance of CommentService. It takes a service.Connector and a version string as input and returns a pointer to 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/{issueKeyOrID}/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/{issueKeyOrID}/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/{issueKeyOrID}/comment/{commentID}

https://docs.go-atlassian.io/jira-service-management-cloud/request/comments#get-request-comment-by-id

func (*CommentService) Gets 

func (s *CommentService) Gets(ctx context.Context, issueKeyOrID string, options *model.RequestCommentOptionsScheme) (*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/{issueKeyOrID}/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
}

CustomerService provides methods to interact with customer operations in Jira Service Management.

func NewCustomerService 

func NewCustomerService(client service.Connector, version string) *CustomerService

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

func (*CustomerService) Add 

func (c *CustomerService) Add(ctx context.Context, serviceDeskID string, 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 string, 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 string, 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
}

FeedbackService provides methods to interact with feedback operations in Jira Service Management.

func NewFeedbackService 

func NewFeedbackService(client service.Connector, version string) *FeedbackService

NewFeedbackService creates a new instance of FeedbackService. It takes a service.Connector and a version string as input and returns a pointer to 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
}

InfoService provides methods to interact with information operations in Jira Service Management.

func NewInfoService 

func NewInfoService(client service.Connector, version string) *InfoService

NewInfoService creates a new instance of InfoService. It takes a service.Connector and a version string as input and returns a pointer to 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
}

KnowledgebaseService provides methods to interact with knowledge base operations in Jira Service Management.

func NewKnowledgebaseService 

func NewKnowledgebaseService(client service.Connector, version string) *KnowledgebaseService

NewKnowledgebaseService creates a new instance of KnowledgebaseService. It takes a service.Connector and a version string as input and returns a pointer to 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
}

OrganizationService provides methods to interact with organization operations in Jira Service Management.

func NewOrganizationService 

func NewOrganizationService(client service.Connector, version string) *OrganizationService

NewOrganizationService creates a new instance of OrganizationService. It takes a service.Connector and a version string as input and returns a pointer to 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

https://docs.go-atlassian.io/jira-service-management-cloud/organization#remove-users-from-organization

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
}

ParticipantService provides methods to interact with participant operations in Jira Service Management.

func NewParticipantService 

func NewParticipantService(client service.Connector, version string) *ParticipantService

NewParticipantService creates a new instance of ParticipantService. It takes a service.Connector and a version string as input and returns a pointer to 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/{issueKeyOrID}/participant

https://docs.go-atlassian.io/jira-service-management-cloud/request/participants#add-request-participants

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/{issueKeyOrID}/participant

https://docs.go-atlassian.io/jira-service-management-cloud/request/participants#get-request-participants

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/{issueKeyOrID}/participant

https://docs.go-atlassian.io/jira-service-management-cloud/request/participants#remove-request-participants

type QueueService 

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

QueueService provides methods to interact with queue operations in Jira Service Management.

func NewQueueService 

func NewQueueService(client service.Connector, version string) *QueueService

NewQueueService creates a new instance of QueueService. It takes a service.Connector and a version string as input and returns a pointer to 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

https://docs.go-atlassian.io/jira-service-management-cloud/request/service-desk/queue#get-issues-in-queue

type RequestService 

type RequestService struct {

	// Approval handles approval operations.
	Approval *ApprovalService
	// Attachment handles attachment operations.
	Attachment *AttachmentService
	// Comment handles comment operations.
	Comment *CommentService
	// Participant handles participant operations.
	Participant *ParticipantService
	// SLA handles service level agreement operations.
	SLA *ServiceLevelAgreementService
	// Feedback handles feedback operations.
	Feedback *FeedbackService
	// Type handles request type operations.
	Type *TypeService
	// contains filtered or unexported fields
}

RequestService provides methods to interact with service request operations in Jira Service Management.

func NewRequestService 

func NewRequestService(client service.Connector, version string, subServices *ServiceRequestSubServices) (*RequestService, error)

NewRequestService creates a new instance of RequestService. It takes a service.Connector, a version string, and an optional ServiceRequestSubServices as input. Returns a pointer to RequestService and an error if the version is not provided.

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/{issueKeyOrID}

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/{issueKeyOrID}/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/{issueKeyOrID}/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/{issueKeyOrID}/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/{issueKeyOrID}/notification

https://docs.go-atlassian.io/jira-service-management-cloud/request#unsubscribe

type ServiceDeskService 

type ServiceDeskService struct {

	// Queue handles queue operations.
	Queue *QueueService
	// contains filtered or unexported fields
}

ServiceDeskService provides methods to interact with service desk operations in Jira Service Management.

func NewServiceDeskService 

func NewServiceDeskService(client service.Connector, version string, queue *QueueService) (*ServiceDeskService, error)

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

func (*ServiceDeskService) Attach 

func (s *ServiceDeskService) Attach(ctx context.Context, serviceDeskID string, fileName string, file io.Reader) (*model.ServiceDeskTemporaryFileScheme, *model.ResponseScheme, error)

Attach one temporary attachments to a service desk

POST /rest/servicedeskapi/servicedesk/{serviceDeskId}/attachTemporaryFile

https://docs.go-atlassian.io/jira-service-management-cloud/request/service-desk#attach-temporary-file

func (*ServiceDeskService) Get 

func (s *ServiceDeskService) Get(ctx context.Context, serviceDeskID string) (*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}

https://docs.go-atlassian.io/jira-service-management-cloud/request/service-desk#get-service-desk-by-id

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
}

ServiceLevelAgreementService provides methods to interact with SLA operations in Jira Service Management.

func NewServiceLevelAgreementService 

func NewServiceLevelAgreementService(client service.Connector, version string) *ServiceLevelAgreementService

NewServiceLevelAgreementService creates a new instance of ServiceLevelAgreementService. It takes a service.Connector and a version string as input and returns a pointer to 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/{issueKeyOrID}/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/{issueKeyOrID}/sla

https://docs.go-atlassian.io/jira-service-management-cloud/request/sla#get-sla-information

type ServiceRequestSubServices 

type ServiceRequestSubServices struct {
	// Approval handles approval operations.
	Approval *ApprovalService
	// Attachment handles attachment operations.
	Attachment *AttachmentService
	// Comment handles comment operations.
	Comment *CommentService
	// Participant handles participant operations.
	Participant *ParticipantService
	// SLA handles service level agreement operations.
	SLA *ServiceLevelAgreementService
	// Feedback handles feedback operations.
	Feedback *FeedbackService
	// Type handles request type operations.
	Type *TypeService
}

ServiceRequestSubServices holds the sub-services related to service requests in Jira Service Management.

type TypeService 

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

TypeService provides methods to interact with request type operations in Jira Service Management.

func NewTypeService 

func NewTypeService(client service.Connector, version string) *TypeService

NewTypeService creates a new instance of TypeService. It takes a service.Connector and a version string as input and returns a pointer to 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) Groups 

func (t *TypeService) Groups(ctx context.Context, serviceDeskID int) (*model.RequestTypeGroupPageScheme, *model.ResponseScheme, error)

Groups returns the groups for a service desk's customer request type.

GET /rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttypegroup

https://docs.go-atlassian.io/jira-service-management-cloud/request/types#get-request-type-groups

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 

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

WorkSpaceService provides methods to interact with workspace operations in Jira Service Management.

func NewWorkSpaceService 

func NewWorkSpaceService(client service.Connector, version string) *WorkSpaceService

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

func (*WorkSpaceService) Gets 

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

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.