client

package
v1.0.9 Latest Latest
Warning

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

 Go to latest Published: Apr 27, 2026 License: MIT Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type APIResponse 

type APIResponse struct {
	Code    int             `json:"code"`
	Message string          `json:"message"`
	Data    json.RawMessage `json:"data"`
}

type Annotation added in v1.0.3 

type Annotation struct {
	ID         string `json:"id"`
	Text       string `json:"text"`
	Note       string `json:"note"`
	ImageURL   string `json:"image_url"`
	Color      string `json:"color"`
	CardID     string `json:"card_id"`
	CreateTime string `json:"create_time"`
	UpdateTime string `json:"update_time"`
}

type AnnotationFilterRequest added in v1.0.3 

type AnnotationFilterRequest struct {
	Colors           []string `json:"colors,omitempty"`
	LastAnnotationID string   `json:"last_annotation_id,omitempty"`
	Limit            int      `json:"limit,omitempty"`
	Keyword          string   `json:"keyword,omitempty"`
	StartTime        string   `json:"start_time,omitempty"`
	EndTime          string   `json:"end_time,omitempty"`
}

type Card 

type Card struct {
	ID           string   `json:"id"`
	Title        string   `json:"title"`
	Description  string   `json:"description"`
	ArticleTitle string   `json:"article_title"`
	Domain       string   `json:"domain"`
	Read         bool     `json:"read"`
	Starred      bool     `json:"starred"`
	Tags         []string `json:"tags"`
	Folder       *Folder  `json:"folder,omitempty"`
	URL          string   `json:"url"`
	CreateTime   string   `json:"create_time"`
	UpdateTime   string   `json:"update_time"`
}

Card is the shape returned by the card/filter list endpoint.

type CardAddTagsRequest added in v1.0.4 

type CardAddTagsRequest struct {
	ID                string   `json:"id"`
	AddTagNestedNames []string `json:"add_tag_nested_names,omitempty"`
}

type CardDetail added in v1.0.2 

type CardDetail struct {
	ID           string       `json:"id"`
	Title        string       `json:"title"`
	Description  string       `json:"description"`
	ArticleTitle string       `json:"article_title"`
	Domain       string       `json:"domain"`
	Read         bool         `json:"read"`
	Starred      bool         `json:"starred"`
	Tags         []string     `json:"tags"`
	Folder       *Folder      `json:"folder,omitempty"`
	URL          string       `json:"url"`
	CreateTime   string       `json:"create_time"`
	UpdateTime   string       `json:"update_time"`
	Content      string       `json:"content"`
	Author       string       `json:"author"`
	Annotations  []Annotation `json:"annotations"`
	Insight      *Insight     `json:"insight,omitempty"`
}

CardDetail is the full shape returned by the card/detail endpoint.

type CardFilterRequest 

type CardFilterRequest struct {
	FolderFilters []string `json:"folder_filters,omitempty"`
	TagFilters    []string `json:"tag_filters,omitempty"`
	Starred       *bool    `json:"starred,omitempty"`
	Read          *bool    `json:"read,omitempty"`
	Annotated     *bool    `json:"annotated,omitempty"`
	Archived      *bool    `json:"archived,omitempty"`
	LastCardID    string   `json:"last_card_id,omitempty"`
	Limit         int      `json:"limit,omitempty"`
	Keyword       string   `json:"keyword,omitempty"`
	Page          int      `json:"page,omitempty"`
	StartTime     string   `json:"start_time,omitempty"`
	EndTime       string   `json:"end_time,omitempty"`
}

type CardRemoveTagsRequest added in v1.0.4 

type CardRemoveTagsRequest struct {
	ID                   string   `json:"id"`
	RemoveTagNestedNames []string `json:"remove_tag_nested_names,omitempty"`
}

type CardUpdateRequest added in v1.0.2 

type CardUpdateRequest struct {
	ID               string   `json:"id"`
	Title            string   `json:"title,omitempty"`
	Description      string   `json:"description,omitempty"`
	Starred          *bool    `json:"starred,omitempty"`
	Read             *bool    `json:"read,omitempty"`
	FolderNestedName *string  `json:"folder_nested_name,omitempty"`
	TagNestedNames   []string `json:"tag_nested_names,omitempty"`
}

type Client 

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

func New 

func New(baseURL, token string) *Client

func (*Client) AddCardTags added in v1.0.4 

func (c *Client) AddCardTags(req *CardAddTagsRequest) error

func (*Client) ArchiveCards added in v1.0.8 

func (c *Client) ArchiveCards(ids []string) error

func (*Client) DeleteCards added in v1.0.2 

func (c *Client) DeleteCards(ids []string) error

func (*Client) DeleteTags added in v1.0.8 

func (c *Client) DeleteTags(ids []string) error

func (*Client) FilterAnnotations added in v1.0.3 

func (c *Client) FilterAnnotations(req *AnnotationFilterRequest) ([]Annotation, error)

func (*Client) FilterCards 

func (c *Client) FilterCards(req *CardFilterRequest) ([]Card, error)

func (*Client) GetCardDetail added in v1.0.2 

func (c *Client) GetCardDetail(id string) (*CardDetail, error)

func (*Client) ListFolders added in v1.0.4 

func (c *Client) ListFolders() ([]Folder, error)

func (*Client) ListTags 

func (c *Client) ListTags() ([]Tag, error)

func (*Client) MergeTags added in v1.0.8 

func (c *Client) MergeTags(req *TagMergeRequest) error

func (*Client) MoveCards added in v1.0.8 

func (c *Client) MoveCards(req *MoveCardsRequest) error

func (*Client) RagQueryCards added in v1.0.3 

func (c *Client) RagQueryCards(query string) ([]Card, error)

func (*Client) RemoveCardTags added in v1.0.4 

func (c *Client) RemoveCardTags(req *CardRemoveTagsRequest) error

func (*Client) SaveCards added in v1.0.4 

func (c *Client) SaveCards(req *SaveCardsRequest) error

func (*Client) UpdateCard added in v1.0.2 

func (c *Client) UpdateCard(req *CardUpdateRequest) error

func (*Client) UpdateTag added in v1.0.8 

func (c *Client) UpdateTag(req *TagUpdateRequest) error

type Folder added in v1.0.4 

type Folder struct {
	ID            string  `json:"id"`
	NestedName    string  `json:"nested_name"`
	Name          string  `json:"name"`
	ParentID      *string `json:"parent_id"`
	Uncategorized bool    `json:"uncategorized,omitempty"`
}

type Insight added in v1.0.2 

type Insight struct {
	ID         string      `json:"id"`
	Summary    string      `json:"summary"`
	QAs        []InsightQA `json:"qas"`
	CreateTime string      `json:"create_time"`
	UpdateTime string      `json:"update_time"`
}

type InsightQA added in v1.0.2 

type InsightQA struct {
	Q string `json:"q"`
	A string `json:"a"`
}

type MoveCardsRequest added in v1.0.8 

type MoveCardsRequest struct {
	FolderID string   `json:"folder_id"`
	CardIDs  []string `json:"card_ids"`
}

type RagQueryRequest added in v1.0.3 

type RagQueryRequest struct {
	Query string `json:"query"`
}

type SaveCardEntry added in v1.0.4 

type SaveCardEntry struct {
	Title       string `json:"title,omitempty"`
	Description string `json:"description,omitempty"`
	URL         string `json:"url"`
}

type SaveCardsRequest added in v1.0.4 

type SaveCardsRequest struct {
	Cards            []SaveCardEntry `json:"cards"`
	FolderNestedName string          `json:"folder_nested_name,omitempty"`
	TagNestedNames   []string        `json:"tag_nested_names,omitempty"`
}

type Tag 

type Tag struct {
	ID         string  `json:"id"`
	NestedName string  `json:"nested_name"`
	Name       string  `json:"name"`
	ParentID   *string `json:"parent_id"`
}

type TagMergeRequest added in v1.0.8 

type TagMergeRequest struct {
	SourceTagIDs []string `json:"source_tag_ids"`
	TargetTagID  string   `json:"target_tag_id"`
}

type TagUpdateRequest added in v1.0.8 

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.