notion

package module

v0.1.1-0...-d7dea04 Latest Latest Go to latest Published: May 31, 2021 License: MIT Imports: 12 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/kjk/notion

Links

Open Source Insights

README ¶

notion

notion is a Go client for the Notion API.

Features

The client supports all (non-deprecated) endpoints available in the Notion API, as of May 15, 2021:

Getting started

To obtain an API key (required for API calls), follow Notion’s getting started guide.

Code example

First, construct a new Client:

import "github.com/kjk/notion"

(...)

client := notion.NewClient("secret-api-key")

Then, use the methods defined on Client to make requests to the API. For example:

page, err := client.GetPage(context.Background(), "18d35eb5-91f1-4dcb-85b0-c340fd965015")
if err != nil {
    // Handle error...
}

👉 Check out the docs on pkg.go.dev for further reference and examples.

Status

The Notion API is currently in public beta.

⚠️ Although the API itself is versioned, this client will make breaking changes in its code until v1.0 of the module is released.

Official Notion API is still limited:

not all block types are supported
no way to avoid re-downloading data we already have

Other clients

https://github.com/kjk/notionapi : another Go client I wrote, this one uses unofficial API
https://github.com/makenotion/notion-sdk-js : official node SDK from Notion
https://github.com/dstotijn/go-notion : another Go client
https://github.com/jomei/notionapi : another Go client

License

MIT License

I based this code on https://github.com/dstotijn/go-notion (as of https://github.com/dstotijn/go-notion/commit/55aa9db5c7a72af2a57ac953ebbbdbdec3e1efa1, May 19 2021). I made API changes so it's not compatible with go-notion.

Documentation ¶

Index ¶

Constants
Variables
type APIError
- func (err *APIError) Error() string
- func (err *APIError) Unwrap() error
type Annotations
type Block
type BlockChildrenResponse
type BlockType
type Bot
type CheckboxDatabaseQueryFilter
type ChildPage
type Client
- func NewClient(apiKey string, opts *ClientOptions) *Client
- func (c *Client) AppendBlockChildren(ctx context.Context, blockID string, children []Block) (*Block, error)
- func (c *Client) CreatePage(ctx context.Context, params CreatePageParams) (*Page, error)
- func (c *Client) GetBlockChildren(ctx context.Context, blockID string, query *PaginationQuery) (*BlockChildrenResponse, error)
- func (c *Client) GetDatabase(ctx context.Context, id string) (*Database, error)
- func (c *Client) GetPage(ctx context.Context, id string) (*Page, error)
- func (c *Client) GetUser(ctx context.Context, id string) (*User, error)
- func (c *Client) ListUsers(ctx context.Context, query *PaginationQuery) (*ListUsersResponse, error)
- func (c *Client) QueryDatabase(ctx context.Context, id string, query *DatabaseQuery) (*DatabaseQueryResponse, error)
- func (c *Client) Search(ctx context.Context, opts *SearchOpts) (*SearchResponse, error)
- func (c *Client) UpdatePageProps(ctx context.Context, pageID string, params UpdatePageParams) (*Page, error)
type ClientOptions
type Color
type CreatePageParams
- func (p CreatePageParams) MarshalJSON() ([]byte, error)
- func (p CreatePageParams) Validate() error
type Database
type DatabasePageProperties
type DatabasePageProperty
type DatabaseProperties
type DatabaseProperty
- func (prop DatabaseProperty) Metadata() interface{}
type DatabasePropertyType
type DatabaseQuery
type DatabaseQueryFilter
type DatabaseQueryResponse
type DatabaseQuerySort
type Date
type DateDatabaseQueryFilter
type Equation
type FilesDatabaseQueryFilter
type FormulaDatabaseQueryFilter
type FormulaMetadata
type FormulaProperty
type FormulaType
type Heading
type ID
type Link
type ListUsersResponse
type Mention
type MentionType
type MultiSelectDatabaseQueryFilter
type NumberDatabaseQueryFilter
type NumberFormat
type NumberMetadata
type Page
- func (p *Page) UnmarshalJSON(b []byte) error
type PageParent
type PageProperties
type PageTitle
type PaginationQuery
type ParentType
type PeopleDatabaseQueryFilter
type Person
type RelationDatabaseQueryFilter
type RelationMetadata
type RelationProperty
type RichText
type RichTextBlock
type RichTextType
type RollupMetadata
type SearchFilter
type SearchOpts
type SearchResponse
type SearchResults
- func (sr *SearchResults) UnmarshalJSON(b []byte) error
type SearchSort
type SelectDatabaseQueryFilter
type SelectMetadata
type SelectOptions
type SortDirection
type SortTimestamp
type Text
type TextDatabaseQueryFilter
type Time
- func (t Time) Equal(t2 Time) bool
- func (t Time) MarshalJSON() ([]byte, error)
- func (t *Time) String() string
- func (t *Time) UnmarshalJSON(data []byte) error
type ToDo
type UpdatePageParams
- func (p UpdatePageParams) MarshalJSON() ([]byte, error)
- func (p UpdatePageParams) Validate() error
type User

Constants ¶

View Source

const (
	// Database property type enums.
	DBPropTypeTitle          DatabasePropertyType = "title"
	DBPropTypeRichText       DatabasePropertyType = "rich_text"
	DBPropTypeNumber         DatabasePropertyType = "number"
	DBPropTypeSelect         DatabasePropertyType = "select"
	DBPropTypeMultiSelect    DatabasePropertyType = "multi_select"
	DBPropTypeDate           DatabasePropertyType = "date"
	DBPropTypePeople         DatabasePropertyType = "people"
	DBPropTypeFile           DatabasePropertyType = "file"
	DBPropTypeCheckbox       DatabasePropertyType = "checkbox"
	DBPropTypeURL            DatabasePropertyType = "url"
	DBPropTypeEmail          DatabasePropertyType = "email"
	DBPropTypePhoneNumber    DatabasePropertyType = "phone_number"
	DBPropTypeFormula        DatabasePropertyType = "formula"
	DBPropTypeRelation       DatabasePropertyType = "relation"
	DBPropTypeRollup         DatabasePropertyType = "rollup"
	DBPropTypeCreatedTime    DatabasePropertyType = "created_time"
	DBPropTypeCreatedBy      DatabasePropertyType = "created_by"
	DBPropTypeLastEditedTime DatabasePropertyType = "last_edited_time"
	DBPropTypeLastEditedBy   DatabasePropertyType = "last_edited_by"

	// Number format enums.
	NumberFormatNumber           NumberFormat = "number"
	NumberFormatNumberWithCommas NumberFormat = "number_with_commas"
	NumberFormatPercent          NumberFormat = "percent"
	NumberFormatDollar           NumberFormat = "dollar"
	NumberFormatEuro             NumberFormat = "euro"
	NumberFormatPound            NumberFormat = "pound"
	NumberFormatPonud            NumberFormat = "yen"
	NumberFormatRuble            NumberFormat = "ruble"
	NumberFormatRupee            NumberFormat = "rupee"
	NumberFormatWon              NumberFormat = "won"
	NumberformatYuan             NumberFormat = "yuan"

	// Sort timestamp enums.
	SortTimeStampCreatedTime    SortTimestamp = "created_time"
	SortTimeStampLastEditedTime SortTimestamp = "last_edited_time"

	// Sort direction enums.
	SortDirAsc  SortDirection = "ascending"
	SortDirDesc SortDirection = "descending"
)

Variables ¶

View Source

var (
	ErrInvalidJSON        = errors.New("notion: request body could not be decoded as JSON")
	ErrInvalidRequestURL  = errors.New("notion: request URL is not valid")
	ErrInvalidRequest     = errors.New("notion: request is not supported")
	ErrValidation         = errors.New("notion: request body does not match the schema for the expected parameters")
	ErrUnauthorized       = errors.New("notion: bearer token is not valid")
	ErrRestrictedResource = errors.New("notion: client doesn't have permission to perform this operation")
	ErrObjectNotFound     = errors.New("notion: the resource does not exist")
	ErrConflict           = errors.New("notion: the transaction could not be completed, potentially due to a data collision")
	ErrRateLimited        = errors.New("notion: this request exceeds the number of requests allowed")
	ErrInternalServer     = errors.New("notion: an unexpected error occurred")
	ErrServiceUnavailable = errors.New("notion: service is unavailable")
)

See: https://developers.notion.com/reference/errors.

Functions ¶

This section is empty.

Types ¶

type APIError ¶

type APIError struct {
	Object  string `json:"object"`
	Status  int    `json:"status"`
	Code    string `json:"code"`
	Message string `json:"message"`
}

func (*APIError) Error ¶

func (err *APIError) Error() string

Error implements `error`.

func (*APIError) Unwrap ¶

func (err *APIError) Unwrap() error

type Annotations ¶

type Annotations struct {
	Bold          bool  `json:"bold,omitempty"`
	Italic        bool  `json:"italic,omitempty"`
	Strikethrough bool  `json:"strikethrough,omitempty"`
	Underline     bool  `json:"underline,omitempty"`
	Code          bool  `json:"code,omitempty"`
	Color         Color `json:"color,omitempty"`
}

type Block ¶

type Block struct {
	Object         string     `json:"object"`
	ID             string     `json:"id,omitempty"`
	Type           BlockType  `json:"type"`
	CreatedTime    *time.Time `json:"created_time,omitempty"`
	LastEditedTime *time.Time `json:"last_edited_time,omitempty"`
	HasChildren    bool       `json:"has_children,omitempty"`

	Paragraph        *RichTextBlock `json:"paragraph,omitempty"`
	Heading1         *Heading       `json:"heading_1,omitempty"`
	Heading2         *Heading       `json:"heading_2,omitempty"`
	Heading3         *Heading       `json:"heading_3,omitempty"`
	BulletedListItem *RichTextBlock `json:"bulleted_list_item,omitempty"`
	NumberedListItem *RichTextBlock `json:"numbered_list_item,omitempty"`
	ToDo             *ToDo          `json:"to_do,omitempty"`
	Toggle           *RichTextBlock `json:"toggle,omitempty"`
	ChildPage        *ChildPage     `json:"rich_text,omitempty"`

	RawJSON []byte `json:"-"`
}

Block represents content on the Notion platform. See: https://developers.notion.com/reference/block

type BlockChildrenResponse ¶

type BlockChildrenResponse struct {
	Results    []Block `json:"results"`
	HasMore    bool    `json:"has_more"`
	NextCursor string  `json:"next_cursor"`

	RawJSON []byte `json:"-"`
}

BlockChildrenResponse contains results (block children) and pagination data returned from a find request.

type BlockType ¶

type BlockType string

const (
	BlockTypeParagraph        BlockType = "paragraph"
	BlockTypeHeading1         BlockType = "heading_1"
	BlockTypeHeading2         BlockType = "heading_2"
	BlockTypeHeading3         BlockType = "heading_3"
	BlockTypeBulletedListItem BlockType = "bulleted_list_item"
	BlockTypeNumberedListItem BlockType = "numbered_list_item"
	BlockTypeToDo             BlockType = "to_do"
	BlockTypeToggle           BlockType = "toggle"
	BlockTypeChildPage        BlockType = "child_page"
	BlockTypeUnsupported      BlockType = "unsupported"
)

type Bot ¶

type Bot struct{}

type CheckboxDatabaseQueryFilter ¶

type CheckboxDatabaseQueryFilter struct {
	Equals       *bool `json:"equals,omitempty"`
	DoesNotEqual *bool `json:"does_not_equal,omitempty"`
}

type ChildPage ¶

type ChildPage struct {
	Title string `json:"title"`
}

type Client ¶

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

Client is used for HTTP requests to the Notion API.

func (*Client) AppendBlockChildren ¶

func (c *Client) AppendBlockChildren(ctx context.Context, blockID string, children []Block) (*Block, error)

AppendBlockChildren appends child content (blocks) to an existing block. See: https://developers.notion.com/reference/patch-block-children

func (*Client) CreatePage ¶

func (c *Client) CreatePage(ctx context.Context, params CreatePageParams) (*Page, error)

CreatePage creates a new page in the specified database or as a child of an existing page. See: https://developers.notion.com/reference/post-page

func (*Client) GetBlockChildren ¶

func (c *Client) GetBlockChildren(ctx context.Context, blockID string, query *PaginationQuery) (*BlockChildrenResponse, error)

GetBlockChildren returns a list of block children for a given block ID. See: https://developers.notion.com/reference/get-block-children

func (*Client) GetDatabase ¶

func (c *Client) GetDatabase(ctx context.Context, id string) (*Database, error)

GetDatabase fetches information about a database given its ID. See: https://developers.notion.com/reference/get-database

func (*Client) GetPage ¶

func (c *Client) GetPage(ctx context.Context, id string) (*Page, error)

GetPage fetches information about a page by ID See: https://developers.notion.com/reference/get-page

func (*Client) GetUser ¶

func (c *Client) GetUser(ctx context.Context, id string) (*User, error)

FindUserByID fetches a user by ID. See: https://developers.notion.com/reference/get-user

func (*Client) ListUsers ¶

func (c *Client) ListUsers(ctx context.Context, query *PaginationQuery) (*ListUsersResponse, error)

ListUsers returns a list of all users, and pagination metadata. See: https://developers.notion.com/reference/get-users

func (*Client) QueryDatabase ¶

func (c *Client) QueryDatabase(ctx context.Context, id string, query *DatabaseQuery) (*DatabaseQueryResponse, error)

QueryDatabase returns database contents, with optional filters, sorts and pagination. See: https://developers.notion.com/reference/post-database-query

func (*Client) Search ¶

func (c *Client) Search(ctx context.Context, opts *SearchOpts) (*SearchResponse, error)

Search fetches all pages and child pages that are shared with the integration. Optionally uses query, filter and pagination options. See: https://developers.notion.com/reference/post-search

func (*Client) UpdatePageProps ¶

func (c *Client) UpdatePageProps(ctx context.Context, pageID string, params UpdatePageParams) (*Page, error)

UpdatePageProps updates page property values for a page. See: https://developers.notion.com/reference/patch-page

type ClientOptions ¶

type ClientOptions struct {
	HTTPClient *http.Client
}

ClientOptions describes options when creating client

type Color ¶

type Color string

const (
	ColorDefault  Color = "default"
	ColorGray     Color = "gray"
	ColorBrown    Color = "brown"
	ColorOrange   Color = "orange"
	ColorYellow   Color = "yellow"
	ColorGreen    Color = "green"
	ColorBlue     Color = "blue"
	ColorPurple   Color = "purple"
	ColorPink     Color = "pink"
	ColorRed      Color = "red"
	ColorGrayBg   Color = "gray_background"
	ColorBrownBg  Color = "brown_background"
	ColorOrangeBg Color = "orange_background"
	ColorYellowBg Color = "yellow_background"
	ColorGreenBg  Color = "green_background"
	ColorBlueBg   Color = "blue_background"
	ColorPurpleBg Color = "purple_background"
	ColorPinkBg   Color = "pink_background"
	ColorRedBg    Color = "red_background"
)

type CreatePageParams ¶

type CreatePageParams struct {
	ParentType ParentType
	ParentID   string

	// Either DatabasePageProperties or Title must be not nil.
	DatabasePageProperties *DatabasePageProperties
	Title                  []RichText

	// Optionally, children blocks are added to the page.
	Children []Block
}

CreatePageParams are the params used for creating a page.

func (CreatePageParams) MarshalJSON ¶

func (p CreatePageParams) MarshalJSON() ([]byte, error)

func (CreatePageParams) Validate ¶

func (p CreatePageParams) Validate() error

type Database ¶

type Database struct {
	ID             string             `json:"id"`
	CreatedTime    time.Time          `json:"created_time"`
	LastEditedTime time.Time          `json:"last_edited_time"`
	Title          []RichText         `json:"title"`
	Properties     DatabaseProperties `json:"properties"`

	RawJSON []byte `json:"-"`
}

Database is a resource on the Notion platform. See: https://developers.notion.com/reference/database

type DatabasePageProperties ¶

type DatabasePageProperties map[string]DatabasePageProperty

DatabasePageProperties are properties of a page whose parent is a database.

type DatabasePageProperty ¶

type DatabasePageProperty struct {
	ID   string               `json:"id,omitempty"`
	Type DatabasePropertyType `json:"type"`

	Title       []RichText         `json:"title,omitempty"`
	RichText    []RichText         `json:"rich_text,omitempty"`
	Number      float64            `json:"number,omitempty"`
	Select      *SelectOptions     `json:"select,omitempty"`
	MultiSelect []SelectOptions    `json:"multi_select,omitempty"`
	Date        *Date              `json:"date,omitempty"`
	Formula     *FormulaProperty   `json:"formula,omitempty"`
	Relation    []RelationProperty `json:"relation,omitempty"`
	Rollup      *RollupMetadata    `json:"rollup,omitempty"`

	// RawJSON is for debugging, shows JSON response from the server
	RawJSON []byte `json:"-"`
}

type DatabaseProperties ¶

type DatabaseProperties map[string]DatabaseProperty

DatabaseProperties is a mapping of properties defined on a database.

type DatabaseProperty ¶

type DatabaseProperty struct {
	ID   string               `json:"id"`
	Type DatabasePropertyType `json:"type"`

	Number      *NumberMetadata   `json:"number,omitempty"`
	Select      *SelectMetadata   `json:"select,omitempty"`
	MultiSelect *SelectMetadata   `json:"multi_select,omitempty"`
	Formula     *FormulaMetadata  `json:"formula,omitempty"`
	Relation    *RelationMetadata `json:"relation,omitempty"`
	Rollup      *RollupMetadata   `json:"rollup,omitempty"`
}

func (DatabaseProperty) Metadata ¶

func (prop DatabaseProperty) Metadata() interface{}

Metadata returns the underlying property metadata, based on its `type` field. When type is unknown/unmapped or doesn't have additional properies, `nil` is returned.

type DatabasePropertyType ¶

type DatabasePropertyType string

type DatabaseQuery ¶

type DatabaseQuery struct {
	Filter      *DatabaseQueryFilter `json:"filter,omitempty"`
	Sorts       []DatabaseQuerySort  `json:"sorts,omitempty"`
	StartCursor string               `json:"start_cursor,omitempty"`
	PageSize    int                  `json:"page_size,omitempty"`
}

DatabaseQuery is used for quering a database.

type DatabaseQueryFilter ¶

type DatabaseQueryFilter struct {
	Property string `json:"property,omitempty"`

	Text        *TextDatabaseQueryFilter        `json:"text,omitempty"`
	Number      *NumberDatabaseQueryFilter      `json:"number,omitempty"`
	Checkbox    *CheckboxDatabaseQueryFilter    `json:"checkbox,omitempty"`
	Select      *SelectDatabaseQueryFilter      `json:"select,omitempty"`
	MultiSelect *MultiSelectDatabaseQueryFilter `json:"multi_select,omitempty"`
	Date        *DateDatabaseQueryFilter        `json:"date,omitempty"`
	People      *PeopleDatabaseQueryFilter      `json:"people,omitempty"`
	Files       *FilesDatabaseQueryFilter       `json:"files,omitempty"`
	Relation    *RelationDatabaseQueryFilter    `json:"relation,omitempty"`

	Or  []DatabaseQueryFilter `json:"or,omitempty"`
	And []DatabaseQueryFilter `json:"and,omitempty"`
}

DatabaseQueryFilter is used to filter database contents. See: https://developers.notion.com/reference/post-database-query#post-database-query-filter

type DatabaseQueryResponse ¶

type DatabaseQueryResponse struct {
	Results    []Page `json:"results"`
	HasMore    bool   `json:"has_more"`
	NextCursor string `json:"next_cursor"`

	RawJSON []byte `json:"-"`
}

DatabaseQueryResponse contains the results and pagination data from a query request.

type DatabaseQuerySort ¶

type DatabaseQuerySort struct {
	Property  string        `json:"property,omitempty"`
	Timestamp SortTimestamp `json:"timestamp,omitempty"`
	Direction SortDirection `json:"direction,omitempty"`
}

type Date ¶

type Date struct {
	Start Time  `json:"start"`
	End   *Time `json:"end,omitempty"`
}

type DateDatabaseQueryFilter ¶

type DateDatabaseQueryFilter struct {
	Equals     *time.Time `json:"equals,omitempty"`
	Before     *time.Time `json:"before,omitempty"`
	After      *time.Time `json:"after,omitempty"`
	OnOrBefore *time.Time `json:"on_or_before,omitempty"`
	OnOrAfter  *time.Time `json:"on_or_after,omitempty"`
	IsEmpty    bool       `json:"is_empty,omitempty"`
	IsNotEmpty bool       `json:"is_not_empty,omitempty"`
	PastWeek   *struct{}  `json:"past_week,omitempty"`
	PastMonth  *struct{}  `json:"past_month,omitempty"`
	PastYear   *struct{}  `json:"past_year,omitempty"`
	NextWeek   *struct{}  `json:"next_week,omitempty"`
	NextMonth  *struct{}  `json:"next_month,omitempty"`
	NextYear   *struct{}  `json:"next_year,omitempty"`
}

type Equation ¶

type Equation struct {
	Expression string `json:"expression"`
}

type FilesDatabaseQueryFilter ¶

type FilesDatabaseQueryFilter struct {
	IsEmpty    bool `json:"is_empty,omitempty"`
	IsNotEmpty bool `json:"is_not_empty,omitempty"`
}

type FormulaDatabaseQueryFilter ¶

type FormulaDatabaseQueryFilter struct {
	Text     TextDatabaseQueryFilter     `json:"text,omitempty"`
	Checkbox CheckboxDatabaseQueryFilter `json:"checkbox,omitempty"`
	Number   NumberDatabaseQueryFilter   `json:"number,omitempty"`
	Date     DateDatabaseQueryFilter     `json:"date,omitempty"`
}

type FormulaProperty ¶

type FormulaProperty struct {
	Type FormulaType `json:"type"`
	// one of those depending on Type
	String  string     `json:"string"`
	Number  float64    `json:"number"`
	Boolean bool       `json:"boolean"`
	Date    *time.Time `json:"date,omitempty"`
}

type FormulaType ¶

type FormulaType string

https://developers.notion.com/reference/page#formula-property-values

const (
	FormulaTypeString  FormulaType = "string"
	FormulaTypeNumber  FormulaType = "number"
	FormulaTypeBoolean FormulaType = "boolean"
	FormulaTypeDate    FormulaType = "date"
)

type Heading ¶

type Heading struct {
	Text []RichText `json:"text"`
}

type ID ¶

type ID struct {
	ID string `json:"id"`
}

type Link ¶

type Link struct {
	URL string `json:"url"`
}

type ListUsersResponse ¶

type ListUsersResponse struct {
	Results    []User `json:"results"`
	HasMore    bool   `json:"has_more"`
	NextCursor string `json:"next_cursor"`

	RawJSON []byte `json:"-"`
}

ListUsersResponse contains results (users) and pagination data returned from a list request.

type Mention ¶

type Mention struct {
	Type MentionType `json:"type"`

	User     *User `json:"user,omitempty"`
	Page     *ID   `json:"page,omitempty"`
	Database *ID   `json:"database,omitempty"`
	Date     *Date `json:"date,omitempty"`
}

type MentionType ¶

type MentionType string

const (
	MentionTypeUser     MentionType = "user"
	MentionTypePage     MentionType = "page"
	MentionTypeDatabase MentionType = "database"
	MentionTypeDate     MentionType = "date"
)

type MultiSelectDatabaseQueryFilter ¶

type MultiSelectDatabaseQueryFilter struct {
	Contains       string `json:"contains,omitempty"`
	DoesNotContain string `json:"does_not_contain,omitempty"`
	IsEmpty        bool   `json:"is_empty,omitempty"`
	IsNotEmpty     bool   `json:"is_not_empty,omitempty"`
}

type NumberDatabaseQueryFilter ¶

type NumberDatabaseQueryFilter struct {
	Equals               *int `json:"equals,omitempty"`
	DoesNotEqual         *int `json:"does_not_equal,omitempty"`
	GreaterThan          *int `json:"greater_than,omitempty"`
	LessThan             *int `json:"less_than,omitempty"`
	GreaterThanOrEqualTo *int `json:"greater_than_or_equal_to,omitempty"`
	LessThanOrEqualTo    *int `json:"less_than_or_equal_to,omitempty"`
	IsEmpty              bool `json:"is_empty,omitempty"`
	IsNotEmpty           bool `json:"is_not_empty,omitempty"`
}

type NumberFormat ¶

type NumberFormat string

type Page ¶

type Page struct {
	ID             string     `json:"id"`
	CreatedTime    time.Time  `json:"created_time"`
	LastEditedTime time.Time  `json:"last_edited_time"`
	Parent         PageParent `json:"parent"`
	Archived       bool       `json:"archived"`

	// Properties differ between parent type.
	// See the `UnmarshalJSON` method.
	Properties interface{} `json:"properties"`

	// RawJSON is for debugging, shows JSON response from the server
	RawJSON []byte `json:"-"`
}

Page is a resource on the Notion platform. Its parent is either a workspace, another page, or a database. See: https://developers.notion.com/reference/page

func (*Page) UnmarshalJSON ¶

func (p *Page) UnmarshalJSON(b []byte) error

UnmarshalJSON implements json.Unmarshaler.

Pages get a different Properties type based on the parent of the page. If parent type is `workspace` or `page_id`, PageProperties is used. Else if parent type is `database_id`, DatabasePageProperties is used.

type PageParent ¶

type PageParent struct {
	Type ParentType `json:"type,omitempty"`

	PageID     *string `json:"page_id,omitempty"`
	DatabaseID *string `json:"database_id,omitempty"`
}

type PageProperties ¶

type PageProperties struct {
	Title PageTitle `json:"title"`
}

PageProperties are properties of a page whose parent is a page or a workspace.

type PageTitle ¶

type PageTitle struct {
	Title []RichText `json:"title"`
}

type PaginationQuery ¶

type PaginationQuery struct {
	StartCursor string
	PageSize    int
}

type ParentType ¶

type ParentType string

const (
	ParentTypeDatabase ParentType = "database_id"
	ParentTypePage     ParentType = "page_id"
)

type PeopleDatabaseQueryFilter ¶

type PeopleDatabaseQueryFilter struct {
	Contains       string `json:"contains,omitempty"`
	DoesNotContain string `json:"does_not_contain,omitempty"`
	IsEmpty        bool   `json:"is_empty,omitempty"`
	IsNotEmpty     bool   `json:"is_not_empty,omitempty"`
}

type Person ¶

type Person struct {
	Email string `json:"email"`
}

type RelationDatabaseQueryFilter ¶

type RelationDatabaseQueryFilter struct {
	Contains       string `json:"contains,omitempty"`
	DoesNotContain string `json:"does_not_contain,omitempty"`
	IsEmpty        bool   `json:"is_empty,omitempty"`
	IsNotEmpty     bool   `json:"is_not_empty,omitempty"`
}

type RelationMetadata ¶

type RelationMetadata struct {
	DatabaseID     string `json:"database_id,omitempty"`
	SyncedPropName string `json:"synced_property_name,omitempty"`
	SyncedPropID   string `json:"synced_property_id,omitempty"`
}

Database property metadata types.

type RelationProperty ¶

type RelationProperty struct {
	ID string `json:"id"`
}

type RichText ¶

type RichText struct {
	Type        RichTextType `json:"type,omitempty"`
	Annotations *Annotations `json:"annotations,omitempty"`

	PlainText string    `json:"plain_text,omitempty"`
	HRef      *string   `json:"href,omitempty"`
	Text      *Text     `json:"text,omitempty"`
	Mention   *Mention  `json:"mention,omitempty"`
	Equation  *Equation `json:"equation,omitempty"`
}

type RichTextBlock ¶

type RichTextBlock struct {
	Text     []RichText `json:"text"`
	Children []Block    `json:"children,omitempty"`
}

type RichTextType ¶

type RichTextType string

const (
	RichTextTypeText     RichTextType = "text"
	RichTextTypeMention  RichTextType = "mention"
	RichTextTypeEquation RichTextType = "equation"
)

type RollupMetadata ¶

type RollupMetadata struct {
	RelationPropName string `json:"relation_property_name,omitempty"`
	RelationPropID   string `json:"relation_property_id,omitempty"`
	RollupPropName   string `json:"rollup_property_name,omitempty"`
	RollupPropID     string `json:"rollup_property_id,omitempty"`
	Function         string `json:"function,omitempty"`
}

Database property metadata types.

type SearchFilter struct {
	Value    string `json:"value"`
	Property string `json:"property"`
}

type SearchOpts ¶

type SearchOpts struct {
	Query       string        `json:"query,omitempty"`
	Sort        *SearchFilter `json:"sort,omitempty"`
	Filter      *SearchFilter `json:"filter,omitempty"`
	StartCursor string        `json:"start_cursor,omitempty"`
	PageSize    int           `json:"page_size,omitempty"`
}

type SearchResponse ¶

type SearchResponse struct {
	// Results are either *notion.Page or *notion.Database.
	// See `SearchResponse.UnmarshalJSON`.
	Results    SearchResults `json:"results"`
	HasMore    bool          `json:"has_more"`
	NextCursor string        `json:"next_cursor"`

	RawJSON []byte `json:"-"`
}

type SearchResults ¶

type SearchResults []interface{}

interface{} is either *notion.Page or *notion.Database

func (*SearchResults) UnmarshalJSON ¶

func (sr *SearchResults) UnmarshalJSON(b []byte) error

type SearchSort ¶

type SearchSort struct {
	Direction SortDirection `json:"direction,omitempty"`
	Timestamp string        `json:"timestamp"`
}

type SelectDatabaseQueryFilter ¶

type SelectDatabaseQueryFilter struct {
	Equals       string `json:"equals,omitempty"`
	DoesNotEqual string `json:"does_not_equal,omitempty"`
	IsEmpty      bool   `json:"is_empty,omitempty"`
	IsNotEmpty   bool   `json:"is_not_empty,omitempty"`
}

type SelectMetadata ¶

type SelectMetadata struct {
	Options []SelectOptions `json:"options"`
}

Database property metadata types.

type SelectOptions ¶

type SelectOptions struct {
	ID    string `json:"id,omitempty"`
	Name  string `json:"name,omitempty"`
	Color Color  `json:"color,omitempty"`
}

type SortDirection ¶

type SortDirection string

type SortTimestamp ¶

type SortTimestamp string

type Text ¶

type Text struct {
	Content string `json:"content"`
	Link    *Link  `json:"link,omitempty"`
}

type TextDatabaseQueryFilter ¶

type TextDatabaseQueryFilter struct {
	Equals         string `json:"equals,omitempty"`
	DoesNotEqual   string `json:"does_not_equal,omitempty"`
	Contains       string `json:"contains,omitempty"`
	DoesNotContain string `json:"does_not_contain,omitempty"`
	StartsWith     string `json:"starts_with,omitempty"`
	EndsWith       string `json:"ends_with,omitempty"`
	IsEmpty        bool   `json:"is_empty,omitempty"`
	IsNotEmpty     bool   `json:"is_not_empty,omitempty"`
}

type Time ¶

type Time time.Time

func (Time) Equal ¶

func (t Time) Equal(t2 Time) bool

func (Time) MarshalJSON ¶

func (t Time) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface.

func (*Time) String ¶

func (t *Time) String() string

String returns the time in the custom format

func (*Time) UnmarshalJSON ¶

func (t *Time) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface. The time is expected to be a quoted string in RFC 3339 format or "YYYY-MM-DD" format

type ToDo ¶

type ToDo struct {
	RichTextBlock
	Checked *bool `json:"checked,omitempty"`
}

type UpdatePageParams ¶

type UpdatePageParams struct {
	// Either DatabasePageProperties or Title must be not nil.
	DatabasePageProperties *DatabasePageProperties
	Title                  []RichText
}

func (UpdatePageParams) MarshalJSON ¶

func (p UpdatePageParams) MarshalJSON() ([]byte, error)

func (UpdatePageParams) Validate ¶

func (p UpdatePageParams) Validate() error

type User ¶

type User struct {
	ID        string  `json:"id"`
	Type      string  `json:"type"`
	Name      string  `json:"name"`
	AvatarURL *string `json:"avatar_url"`

	Person *Person `json:"person"`
	Bot    *Bot    `json:"bot"`

	RawJSON []byte `json:"-"`
}

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
do
examples

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

README ¶

notion

Features

Getting started

Code example

Status

Other clients

License

Documentation ¶

Index ¶

Constants ¶

Variables ¶

Functions ¶

Types ¶

type APIError ¶

func (*APIError) Error ¶

func (*APIError) Unwrap ¶

type Annotations ¶

type Block ¶

type BlockChildrenResponse ¶

type BlockType ¶

type Bot ¶

type CheckboxDatabaseQueryFilter ¶

type ChildPage ¶

type Client ¶

func NewClient ¶

func (*Client) AppendBlockChildren ¶

func (*Client) CreatePage ¶

func (*Client) GetBlockChildren ¶

func (*Client) GetDatabase ¶

func (*Client) GetPage ¶

func (*Client) GetUser ¶

func (*Client) ListUsers ¶

func (*Client) QueryDatabase ¶

func (*Client) Search ¶

func (*Client) UpdatePageProps ¶

type ClientOptions ¶

type Color ¶

type CreatePageParams ¶

func (CreatePageParams) MarshalJSON ¶

func (CreatePageParams) Validate ¶

type Database ¶

type DatabasePageProperties ¶

type DatabasePageProperty ¶

type DatabaseProperties ¶

type DatabaseProperty ¶

func (DatabaseProperty) Metadata ¶

type DatabasePropertyType ¶

type DatabaseQuery ¶

type DatabaseQueryFilter ¶

type DatabaseQueryResponse ¶

type DatabaseQuerySort ¶

type Date ¶

type DateDatabaseQueryFilter ¶

type Equation ¶

type FilesDatabaseQueryFilter ¶

type FormulaDatabaseQueryFilter ¶

type FormulaMetadata ¶

type FormulaProperty ¶

type FormulaType ¶

type Heading ¶

type ID ¶

type Link ¶

type ListUsersResponse ¶

type Mention ¶

type MentionType ¶

type MultiSelectDatabaseQueryFilter ¶

type NumberDatabaseQueryFilter ¶

type NumberFormat ¶

type NumberMetadata ¶

type Page ¶

func (*Page) UnmarshalJSON ¶

type PageParent ¶

type PageProperties ¶

type PageTitle ¶

type PaginationQuery ¶

type ParentType ¶

type PeopleDatabaseQueryFilter ¶

type Person ¶

type RelationDatabaseQueryFilter ¶