zendesk

Documentation

Overview

zendesk package provides api access to the zendesk rest api

zendesk package provides api access to the zendesk rest apis

Index

• func URL(subDomain, ticketID string) string
• type Attachment
  • func GetAttachmentsFromComments(jsonData string) ([]Attachment, *string, error)
• type Client
  • func NewClient(username, password, subDomain string, verbose bool) *Client
  • func (z *Client) GetTicketComentsJSON(ticketID string, pageURL *string) (string, error)
• type CommentTextWithLink
  • func GetLinksFromComments(jsonData string) ([]CommentTextWithLink, *string, error)
• type MissingJSONFieldError
  • func (m MissingJSONFieldError) Error() string
• type ParserErr
  • func (p ParserErr) Error() string

Functions

func URL

func URL(subDomain, ticketID string) string

Types

type Attachment

type Attachment struct {
	ParentCommentDate time.Time // "created_at": "2000-01-01T11:11:07Z",
	ParentCommentID   int64
	FileName          string
	ContentURL        string
	ContentType       string
	Size              int64
	Deleted           bool
}

Attachment maps to

{
	"url": "https://dremio.zendesk.com/api/v2/attachments/1.json",
	"id": 1,
	"file_name": "test.txt",
	"content_url": "https://tester.zendesk.com/attachments/token/abc/?name=test.txt",
	"mapped_content_url": "https://test.tester.com/attachments/token/abc/?name=test.txt",
	"content_type": "text/plain",
	"size": 1111,
	"width": null,
	"height": null,
	"inline": false,
	"deleted": false,
	"thumbnails": []
}

with additional data from parent comment

func GetAttachmentsFromComments

func GetAttachmentsFromComments(jsonData string) ([]Attachment, *string, error)

GetLinksFromComments is parsing out the links from the html_ docs are here https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_comments/#list-comments

type Client

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

func NewClient

func NewClient(username, password, subDomain string, verbose bool) *Client

func (*Client) GetTicketComentsJSON

func (z *Client) GetTicketComentsJSON(ticketID string, pageURL *string) (string, error)

GetTicketComments returns all comments as a concatenated string so we can search them GET /api/v2/tickets/{ticket_id}/comments curl https://{subdomain}.zendesk.com/api/v2/tickets/{ticket_id}/comments.json \

{
	"comments": [
	  {
		"attachments": [
		  {
			"content_type": "text/plain",
			"content_url": "https://company.zendesk.com/attachments/crash.log",
			"file_name": "crash.log",
			"id": 498483,
			"size": 2532,
			"thumbnails": []
		  }
		],
		"author_id": 123123,
		"body": "Thanks for your help!",
		"created_at": "2009-07-20T22:55:29Z",
		"id": 1274,
		"metadata": {
		  "system": {
			"client": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/61.0.3163.100 Safari/537.36",
			"ip_address": "1.1.1.1",
			"latitude": -37.000000000001,
			"location": "Melbourne, 07, Australia",
			"longitude": 144.0000000000002
		  },
		  "via": {
			"channel": "web",
			"source": {
			  "from": {},
			  "rel": "web_widget",
			  "to": {}
			}
		  }
		},
		"public": true,
		"type": "Comment"
	  }
	]
  }

type CommentTextWithLink

type CommentTextWithLink struct {
	Body string
	URL  string
}

CommentTextWithLink takes the extracted link from the html_body and then also returns the body in text format so that we can store the comment with the downloaded files

func GetLinksFromComments

func GetLinksFromComments(jsonData string) ([]CommentTextWithLink, *string, error)

GetLinksFromComments is parsing out the links from the html_ docs are here https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_comments/#list-comments

type MissingJSONFieldError

type MissingJSONFieldError struct {
	FieldName string
	JSONData  string
	Location  string
}

MissingJSONFieldError provides location, field name and raw json data parsed

func (MissingJSONFieldError) Error

func (m MissingJSONFieldError) Error() string

Error provides location if one is present otherwise it will omit that text

type ParserErr

type ParserErr struct {
	Err      error
	JSONData string
	Location string
}

ParserErr provides location, raw json data parsed and nested error

func (ParserErr) Error

func (p ParserErr) Error() string

Error provides location if one is present otherwise it will omit that text