document

Documentation

Index

• func NextPageURL(baseURL, path string, nextPageKey string) (string, error)
• type Client
  • func NewClient(url string, client *http.Client) *Client
  • func (a Client) DELETE(resourceType ResourceType, id string) (err error)
  • func (a Client) GET(resourceType ResourceType, id string) (res *Response, err error)
  • func (a Client) INSERT(resourceType ResourceType, data *bytes.Buffer, contentType string) (id string, err error)
  • func (a Client) LIST(resourceType ResourceType) (res []Response, err error)
  • func (a Client) UPDATE(resourceType ResourceType, id string, data *bytes.Buffer, contentType string) (err error)
• type Resource
• type ResourceType
• type Response
• type ResponseErr
  • func (e ResponseErr) Error() string

Functions

func NextPageURL

func NextPageURL(baseURL, path string, nextPageKey string) (string, error)

Types

type Client

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

func NewClient

func NewClient(url string, client *http.Client) *Client

NewClient creates a new client to interact with the Automation API

func (Client) DELETE

func (a Client) DELETE(resourceType ResourceType, id string) (err error)

DELETE removes a given document object by ID

func (Client) GET

func (a Client) GET(resourceType ResourceType, id string) (res *Response, err error)

GET returns one specific automation object

func (Client) INSERT

func (a Client) INSERT(resourceType ResourceType, data *bytes.Buffer, contentType string) (id string, err error)

INSERT creates a given document object

func (Client) LIST

func (a Client) LIST(resourceType ResourceType) (res []Response, err error)

LIST returns all document objects

func (Client) UPDATE

func (a Client) UPDATE(resourceType ResourceType, id string, data *bytes.Buffer, contentType string) (err error)

UPDATE updates a given document object

type Resource

type Resource struct {
	// Path is the API path to be used for this resource
	Path string
}

Resource specifies information about a specific resource

type ResourceType

type ResourceType int

ResourceType enumerates different kind of resources

const (
	Documents ResourceType = iota
)

type Response

type Response struct {
	ID        string `json:"id"`
	Actor     string `json:"actor"`
	Owner     string `json:"owner"`
	Name      string `json:"name"`
	Type      string `json:"type"`
	IsPrivate bool   `json:"isPrivate"`
	Content   string `json:"content"`
	Version   int    `json:"version"`
}

type ResponseErr

type ResponseErr struct {
	StatusCode int
	Message    string
	Data       []byte
}

ResponseErr is used to return HTTP related information as an error

func (ResponseErr) Error

func (e ResponseErr) Error() string