documents

package

v0.9.0 Latest Latest Go to latest Published: May 16, 2025 License: Apache-2.0 Imports: 16 Imported by: 3

Documentation ¶

Index ¶

type Client
- func NewClient(client *rest.Client) *Client
type DocumentType
type ListResponse
type Metadata
- func UnmarshallMetadata(b []byte) (Metadata, error)
type Response

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Client ¶

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

Client is the HTTP client to be used for interacting with the Document API

func NewClient ¶

func NewClient(client *rest.Client) *Client

NewClient creates a new document client

func (Client) Create ¶

func (c Client) Create(ctx context.Context, name string, isPrivate bool, externalId string, data []byte, documentType DocumentType) (api.Response, error)

func (Client) Delete ¶

func (c Client) Delete(ctx context.Context, id string) (api.Response, error)

func (Client) Get ¶

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

func (Client) List ¶

func (c Client) List(ctx context.Context, filter string) (ListResponse, error)

func (Client) Update ¶

func (c Client) Update(ctx context.Context, id string, name string, isPrivate bool, data []byte, documentType DocumentType) (api.Response, error)

type DocumentType ¶

type DocumentType = string

DocumentType defines the *known* types of documents. It is possible to pass an arbitrary string in consumers to download any kind of document.

const (
	Dashboard DocumentType = "dashboard"
	Notebook  DocumentType = "notebook"
	Launchpad DocumentType = "launchpad"
)

type ListResponse ¶

type ListResponse struct {
	api.Response
	Responses []Response
}

ListResponse is a list of API Responses

type Metadata ¶

type Metadata struct {
	ID          string  `json:"id"`
	ExternalID  string  `json:"externalId"`
	Actor       string  `json:"actor"`
	Owner       string  `json:"owner"`
	Name        string  `json:"name"`
	Type        string  `json:"type"`
	Version     int     `json:"version"`
	IsPrivate   bool    `json:"isPrivate"`
	OriginAppID *string `json:"originAppId,omitempty"`
}

func UnmarshallMetadata ¶

func UnmarshallMetadata(b []byte) (Metadata, error)

type Response ¶

type Response struct {
	api.Response
	Metadata
}

Response contains the API response

Source Files ¶

View all Source files

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