documents

Documentation

Index

• type Client
  • func NewClient(client *rest.Client) *Client
  • func (c *Client) Create(ctx context.Context, doc Document) (*http.Response, error)
  • func (c *Client) Delete(ctx context.Context, id string, version int) (*http.Response, error)
  • func (c *Client) Get(ctx context.Context, id string) (*http.Response, error)
  • func (c *Client) List(ctx context.Context, requestOptions rest.RequestOptions) (*http.Response, error)
  • func (c *Client) Patch(ctx context.Context, id string, version int, doc Document) (*http.Response, error)
  • func (c *Client) Trash(ctx context.Context, id string) (*http.Response, error)
  • func (c *Client) Update(ctx context.Context, id string, data []byte, ...) (*http.Response, error)
• type Document

Types

type Client

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

func NewClient

func NewClient(client *rest.Client) *Client

func (*Client) Create

func (c *Client) Create(ctx context.Context, doc Document) (*http.Response, error)

Create posts the content of the document to the server using http POST to create new document. NOTE: some of the arguments of the document are ignored due the design of the HTTP API.

func (*Client) Delete

func (c *Client) Delete(ctx context.Context, id string, version int) (*http.Response, error)

func (*Client) Get

func (c *Client) Get(ctx context.Context, id string) (*http.Response, error)

func (*Client) List

func (c *Client) List(ctx context.Context, requestOptions rest.RequestOptions) (*http.Response, error)

func (*Client) Patch

func (c *Client) Patch(ctx context.Context, id string, version int, doc Document) (*http.Response, error)

Patch patches the content of the document to the server using http PATCH to change the document. NOTE: some of the arguments of the document are ignored due the design of the HTTP API.

func (*Client) Trash

func (c *Client) Trash(ctx context.Context, id string) (*http.Response, error)

func (*Client) Update

func (c *Client) Update(ctx context.Context, id string, data []byte, requestOptions rest.RequestOptions) (*http.Response, error)

type Document

type Document struct {
	Kind       string
	Name       string
	ExternalID string
	Public     bool
	Content    []byte
}