servicedesk

package
v2.0.0-...-f438546 Latest Latest
Warning

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

Go to latest
Published: Dec 21, 2022 License: MIT Imports: 2 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AdditionalCommentDTO

type AdditionalCommentDTO struct {
	Body string `json:"body,omitempty" structs:"body,omitempty"`
}

type AttachedTemporaryFile

type AttachedTemporaryFile struct {
	TemporaryAttachments []TemporaryAttachment `json:"temporaryAttachments,omitempty" structs:"temporaryAttachments,omitempty"`
}

type AttachmentCreateResultDTO

type AttachmentCreateResultDTO struct {
	Comment     CommentDTO                     `json:"comment,omitempty" structs:"comment,omitempty"`
	Attachments model.PagedDTOT[AttachmentDTO] `json:"attachments,omitempty" structs:"attachments,omitempty"`
}

type AttachmentDTO

type AttachmentDTO struct {
	Filename string            `json:"filename,omitempty" structs:"filename,omitempty"`
	Author   UserDTO           `json:"author,omitempty" structs:"author,omitempty"`
	Created  model.DateDTO     `json:"created,omitempty" structs:"created,omitempty"`
	Size     int64             `json:"size,omitempty" structs:"size,omitempty"`
	MIMEType string            `json:"mimeType,omitempty" structs:"mimeType,omitempty"`
	Links    AttachmentLinkDTO `json:"_links,omitempty" structs:"_links,omitempty"`
}

type AttachmentLinkDTO

type AttachmentLinkDTO struct {
	Self      string `json:"self,omitempty" structs:"self,omitempty"`
	JIRARest  string `json:"jiraRest,omitempty" structs:"jiraRest,omitempty"`
	Content   string `json:"content,omitempty" structs:"content,omitempty"`
	Thumbnail string `json:"thumbnail,omitempty" structs:"thumbnail,omitempty"`
}

type CommentDTO

type CommentDTO struct {
	ID           string
	Body         string                         `json:"body,omitempty" structs:"body,omitempty"`
	RenderedBody *RenderedValueDTO              `json:"renderedBody,omitempty" structs:"renderedBody,omitempty"`
	Author       UserDTO                        `json:"author,omitempty" structs:"author,omitempty"`
	Created      model.DateDTO                  `json:"created,omitempty" structs:"created,omitempty"`
	Attachments  model.PagedDTOT[AttachmentDTO] `json:"attachments,omitempty" structs:"attachments,omitempty"`
	Public       bool                           `json:"public,omitempty" structs:"public,omitempty"`
	Expands      []string                       `json:"_expands,omitempty" structs:"_expands,omitempty"`
	Links        *model.SelfLink                `json:"_links,omitempty" structs:"_links,omitempty"`
}

type CreateRequest

type CreateRequest struct {
	ServiceDeskID string         `json:"serviceDeskId,omitempty" structs:"serviceDeskId,omitempty"`
	TypeID        string         `json:"requestTypeId,omitempty" structs:"requestTypeId,omitempty"`
	FieldValues   map[string]any `json:"requestFieldValues,omitempty" structs:"requestFieldValues,omitempty"`
	Participants  []string       `json:"requestParticipants,omitempty" structs:"requestParticipants,omitempty"`
	Requester     string         `json:"raiseOnBehalfOf,omitempty" structs:"raiseOnBehalfOf,omitempty"`
}

type CreateRequestAttachment

type CreateRequestAttachment struct {
	TemporaryAttachmentIDs []string              `json:"temporaryAttachmentIds,omitempty" structs:"temporaryAttachmentIds,omitempty"`
	AdditionalComment      *AdditionalCommentDTO `json:"additionalComment,omitempty" structs:"additionalComment,omitempty"`
	Public                 bool                  `json:"public" structs:"public"`
}

type CreateRequestComment

type CreateRequestComment struct {
	Body   string `json:"body" structs:"body"`
	Public bool   `json:"public" structs:"public"`
}

type Customer

type Customer struct {
	AccountID    string          `json:"accountId,omitempty" structs:"accountId,omitempty"`
	Name         string          `json:"name,omitempty" structs:"name,omitempty"`
	Key          string          `json:"key,omitempty" structs:"key,omitempty"`
	EmailAddress string          `json:"emailAddress,omitempty" structs:"emailAddress,omitempty"`
	DisplayName  string          `json:"displayName,omitempty" structs:"displayName,omitempty"`
	Active       *bool           `json:"active,omitempty" structs:"active,omitempty"`
	TimeZone     string          `json:"timeZone,omitempty" structs:"timeZone,omitempty"`
	Links        *model.SelfLink `json:"_links,omitempty" structs:"_links,omitempty"`
}

Customer represents a ServiceDesk customer.

type CustomerListOptions

type CustomerListOptions struct {
	Query string `url:"query,omitempty"`
	Start int    `url:"start,omitempty"`
	Limit int    `url:"limit,omitempty"`
}

CustomerListOptions is the query options for listing customers.

type CustomerRequestCreateMeta

type CustomerRequestCreateMeta struct {
	RequestTypeFields         []RequestTypeField `json:"requestTypeFields,omitempty" structs:"requestTypeFields,omitempty"`
	CanRaiseOnBehalfOf        bool               `json:"canRaiseOnBehalfOf,omitempty" structs:"canRaiseOnBehalfOf,omitempty"`
	CanAddRequestParticipants bool               `json:"canAddRequestParticipants,omitempty" structs:"canAddRequestParticipants,omitempty"`
}

type JiraSchema

type JiraSchema struct {
	Type          string            `json:"type,omitempty" structs:"type,omitempty"`
	Items         string            `json:"items,omitempty" structs:"items,omitempty"`
	System        string            `json:"system,omitempty" structs:"system,omitempty"`
	Custom        string            `json:"custom,omitempty" structs:"custom,omitempty"`
	CustomID      int               `json:"customId,omitempty" structs:"customId,omitempty"`
	Configuration map[string]string `json:"configuration,omitempty" structs:"configuration,omitempty"`
}

type RenderedValueDTO

type RenderedValueDTO struct {
	HTML string `json:"html,omitempty" structs:"html,omitempty"`
}

type Request

type Request struct {
	IssueID       string              `json:"issueId,omitempty" structs:"issueId,omitempty"`
	IssueKey      string              `json:"issueKey,omitempty" structs:"issueKey,omitempty"`
	TypeID        string              `json:"requestTypeId,omitempty" structs:"requestTypeId,omitempty"`
	ServiceDeskID string              `json:"serviceDeskId,omitempty" structs:"serviceDeskId,omitempty"`
	Reporter      *Customer           `json:"reporter,omitempty" structs:"reporter,omitempty"`
	FieldValues   []RequestFieldValue `json:"requestFieldValues,omitempty" structs:"requestFieldValues,omitempty"`
	Status        *RequestStatus      `json:"currentStatus,omitempty" structs:"currentStatus,omitempty"`
	Links         *model.SelfLink     `json:"_links,omitempty" structs:"_links,omitempty"`
	Expands       []string            `json:"_expands,omitempty" structs:"_expands,omitempty"`
}

Request represents a ServiceDesk customer request.

type RequestComment

type RequestComment struct {
	ID      string          `json:"id,omitempty" structs:"id,omitempty"`
	Body    string          `json:"body,omitempty" structs:"body,omitempty"`
	Public  bool            `json:"public" structs:"public"`
	Author  *Customer       `json:"author,omitempty" structs:"author,omitempty"`
	Created *RequestDate    `json:"created,omitempty" structs:"created,omitempty"`
	Links   *model.SelfLink `json:"_links,omitempty" structs:"_links,omitempty"`
	Expands []string        `json:"_expands,omitempty" structs:"_expands,omitempty"`
}

RequestComment is a comment for a request.

type RequestCommentListOptions

type RequestCommentListOptions struct {
	Public   *bool    `url:"public,omitempty" query:"public"`
	Internal *bool    `url:"internal,omitempty" query:"internal"`
	Expand   []string `url:"expand,omitempty" query:"expand"`
	Start    int      `url:"start,omitempty" query:"start"`
	Limit    int      `url:"limit,omitempty" query:"limit"`
}

RequestCommentListOptions is the query options for listing comments for a ServiceDesk request.

type RequestDate

type RequestDate struct {
	ISO8601  string `json:"iso8601,omitempty" structs:"iso8601,omitempty"`
	Jira     string `json:"jira,omitempty" structs:"jira,omitempty"`
	Friendly string `json:"friendly,omitempty" structs:"friendly,omitempty"`
	Epoch    int64  `json:"epoch,omitempty" structs:"epoch,omitempty"`
}

RequestDate is the date format used in requests.

type RequestFieldValue

type RequestFieldValue struct {
	FieldID string `json:"fieldId,omitempty" structs:"fieldId,omitempty"`
	Label   string `json:"label,omitempty" structs:"label,omitempty"`
	Value   any    `json:"value,omitempty" structs:"value,omitempty"`
}

RequestFieldValue is a request field.

type RequestStatus

type RequestStatus struct {
	Status   string
	Category string
	Date     RequestDate
}

RequestStatus is the status for a request.

type RequestType

type RequestType struct {
	ID            string           `json:"id,omitempty" structs:"id,omitempty"`
	Name          string           `json:"name,omitempty" structs:"name,omitempty"`
	Description   string           `json:"description,omitempty" structs:"description,omitempty"`
	HelpText      string           `json:"helpText,omitempty" structs:"helpText,omitempty"`
	IssueTypeID   string           `json:"issueTypeId,omitempty" structs:"issueTypeId,omitempty"`
	ServiceDeskID string           `json:"serviceDeskId,omitempty" structs:"serviceDeskId,omitempty"`
	GroupIDs      []string         `json:"groupIds,omitempty" structs:"groupIds,omitempty"`
	Icon          *RequestTypeIcon `json:"icon,omitempty" structs:"icon,omitempty"`
	Practice      string           `json:"practice,omitempty" structs:"practice,omitempty"`
	Expands       []string         `json:"_expands,omitempty" structs:"_expands,omitempty"`
	Links         *model.SelfLink  `json:"_links,omitempty" structs:"_links,omitempty"`
}

RequestType contains RequestType data

type RequestTypeField

type RequestTypeField struct {
	FieldID       string                  `json:"fieldId,omitempty" structs:"fieldId,omitempty"`
	Name          string                  `json:"name,omitempty" structs:"name,omitempty"`
	Description   string                  `json:"description,omitempty" structs:"description,omitempty"`
	Required      bool                    `json:"required" structs:"required"`
	DefaultValues []RequestTypeFieldValue `json:"defaultValues,omitempty" structs:"defaultValues,omitempty"`
	ValidValues   []RequestTypeFieldValue `json:"validValues,omitempty" structs:"validValues,omitempty"`
	PresetValues  []string                `json:"presetValues,omitempty" structs:"presetValues,omitempty"`
	JiraSchema    *JiraSchema             `json:"jiraSchema,omitempty" structs:"jiraSchema,omitempty"`
	Visible       bool                    `json:"visible" structs:"visible"`
}

type RequestTypeFieldValue

type RequestTypeFieldValue struct {
	Value    string                  `json:"value,omitempty" structs:"value,omitempty"`
	Label    string                  `json:"label,omitempty" structs:"label,omitempty"`
	Children []RequestTypeFieldValue `json:"children,omitempty" structs:"children,omitempty"`
}

type RequestTypeGroup

type RequestTypeGroup struct {
	ID   string `json:"id"`
	Name string `json:"name"`
}

type RequestTypeIcon

type RequestTypeIcon struct {
	ID    string               `json:"id,omitempty" structs:"id,omitempty"`
	Links *RequestTypeIconLink `json:"_links,omitempty" structs:"_links,omitempty"`
}

RequestTypeIcon contains RequestType icon data

type RequestTypeIconLink struct {
	IconURLs map[string]string `json:"iconUrls,omitempty" structs:"iconUrls,omitempty"`
}

RequestTypeIconLink contains RequestTypeIcon link data

type RequestTypeOptions

type RequestTypeOptions struct {
	SearchQuery string `url:"searchQuery,omitempty" query:"searchQuery"`
	GroupID     int    `url:"groupId,omitempty" query:"groupId"`
}

RequestTypeOptions is the query options for listing request types.

type TemporaryAttachment

type TemporaryAttachment struct {
	TemporaryAttachmentID string `json:"temporaryAttachmentId,omitempty" structs:"temporaryAttachmentId,omitempty"`
	FileName              string `json:"fileName,omitempty" structs:"fileName,omitempty"`
}

type TemporaryFile

type TemporaryFile struct {
	Name string
	File io.Reader
}

type UserDTO

type UserDTO struct {
	AccountID    string       `json:"accountId,omitempty" structs:"accountId,omitempty"`
	Name         string       `json:"name,omitempty" structs:"name,omitempty"`
	Key          string       `json:"key,omitempty" structs:"key,omitempty"`
	EmailAddress string       `json:"emailAddress,omitempty" structs:"emailAddress,omitempty"`
	DisplayName  string       `json:"displayName,omitempty" structs:"displayName,omitempty"`
	Active       bool         `json:"active" structs:"active"`
	TimeZone     string       `json:"timeZone,omitempty" structs:"timeZone,omitempty"`
	Links        *UserLinkDTO `json:"_links,omitempty" structs:"_links,omitempty"`
}

type UserLinkDTO

type UserLinkDTO struct {
	Self       string            `json:"self,omitempty" structs:"self,omitempty"`
	JIRARest   string            `json:"jiraRest,omitempty" structs:"jiraRest,omitempty"`
	AvatarUrls map[string]string `json:"avatarUrls,omitempty" structs:"avatarUrls,omitempty"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL