# Functions
No description provided by the author
NewClient creates a new Client with reasonable defaults.
No description provided by the author
No description provided by the author
NewDefaultClient returns a new client with the default options.
No description provided by the author
No description provided by the author
NewRichText creates a RichText object with the desired content.
NewRichTexts creates a RichTexts object with the desired content.
NewRichTextsP creates a pointer to a RichTexts object with the desired content.
# Constants
Defines values for BlockType.
Defines values for BlockType.
Defines values for BlockType.
Defines values for BlockType.
Defines values for BlockType.
Defines values for BlockType.
Defines values for BlockType.
Defines values for BlockType.
Defines values for BlockType.
Defines values for BlockType.
Defines values for BlockType.
Defines values for BlockType.
Defines values for BlockType.
Defines values for BlockType.
Defines values for BlockType.
Defines values for BlockType.
Defines values for BlockType.
Defines values for BlockType.
Defines values for BlockType.
Defines values for BlockType.
Defines values for BlockType.
Defines values for BlockType.
Defines values for BlockType.
Defines values for BlockType.
Defines values for BlockType.
Defines values for BlockType.
Defines values for BlockType.
Defines values for BlockType.
Defines values for BlockType.
Defines values for BlockType.
Defines values for BlockType.
Defines values for BlockType.
Defines values for BlockType.
Defines values for CodeLanguage.
Defines values for CodeLanguage.
Defines values for CodeLanguage.
Defines values for CodeLanguage.
Defines values for CodeLanguage.
Defines values for CodeLanguage.
Defines values for CodeLanguage.
Defines values for CodeLanguage.
Defines values for CodeLanguage.
Defines values for CodeLanguage.
Defines values for CodeLanguage.
Defines values for CodeLanguage.
Defines values for CodeLanguage.
Defines values for CodeLanguage.
Defines values for CodeLanguage.
Defines values for CodeLanguage.
Defines values for CodeLanguage.
Defines values for CodeLanguage.
Defines values for CodeLanguage.
Defines values for CodeLanguage.
Defines values for CodeLanguage.
Defines values for CodeLanguage.
Defines values for CodeLanguage.
Defines values for CodeLanguage.
Defines values for CodeLanguage.
Defines values for CodeLanguage.
Defines values for CodeLanguage.
Defines values for CodeLanguage.
Defines values for CodeLanguage.
Defines values for CodeLanguage.
Defines values for CodeLanguage.
Defines values for CodeLanguage.
Defines values for CodeLanguage.
Defines values for CodeLanguage.
Defines values for CodeLanguage.
Defines values for CodeLanguage.
Defines values for CodeLanguage.
Defines values for CodeLanguage.
Defines values for CodeLanguage.
Defines values for CodeLanguage.
Defines values for CodeLanguage.
Defines values for CodeLanguage.
Defines values for CodeLanguage.
Defines values for CodeLanguage.
Defines values for CodeLanguage.
Defines values for CodeLanguage.
Defines values for CodeLanguage.
Defines values for CodeLanguage.
Defines values for CodeLanguage.
Defines values for CodeLanguage.
Defines values for CodeLanguage.
Defines values for CodeLanguage.
Defines values for CodeLanguage.
Defines values for CodeLanguage.
Defines values for CodeLanguage.
Defines values for CodeLanguage.
Defines values for CodeLanguage.
Defines values for CodeLanguage.
Defines values for CodeLanguage.
Defines values for CodeLanguage.
Defines values for CodeLanguage.
Defines values for CodeLanguage.
Defines values for CodeLanguage.
Defines values for CodeLanguage.
Defines values for CodeLanguage.
Defines values for CodeLanguage.
Defines values for CodeLanguage.
Defines values for CodeLanguage.
Defines values for CodeLanguage.
Defines values for CodeLanguage.
Defines values for CodeLanguage.
Defines values for CodeLanguage.
Defines values for Color.
Defines values for Color.
Defines values for Color.
Defines values for Color.
Defines values for Color.
Defines values for Color.
Defines values for Color.
Defines values for Color.
Defines values for Color.
Defines values for Color.
Defines values for Color.
Defines values for Color.
Defines values for Color.
Defines values for Color.
Defines values for Color.
Defines values for Color.
Defines values for Color.
Defines values for Color.
Defines values for Color.
DefaultServer is the default server to be used.
Defines values for FileType.
Defines values for FileType.
Defines values for FileWithCaptionType.
Defines values for FileWithCaptionType.
Defines values for FormulaType.
Defines values for FormulaType.
Defines values for FormulaType.
Defines values for FormulaType.
Defines values for IconType.
Defines values for IconType.
Defines values for IconType.
Defines values for LinkToPageType.
Defines values for LinkToPageType.
Defines values for MentionType.
Defines values for MentionType.
Defines values for MentionType.
Defines values for MentionType.
Defines values for MentionType.
Defines values for NumberConfigFormat.
Defines values for NumberConfigFormat.
Defines values for NumberConfigFormat.
Defines values for NumberConfigFormat.
Defines values for NumberConfigFormat.
Defines values for NumberConfigFormat.
Defines values for NumberConfigFormat.
Defines values for NumberConfigFormat.
Defines values for NumberConfigFormat.
Defines values for NumberConfigFormat.
Defines values for NumberConfigFormat.
Defines values for NumberConfigFormat.
Defines values for NumberConfigFormat.
Defines values for NumberConfigFormat.
Defines values for NumberConfigFormat.
Defines values for NumberConfigFormat.
Defines values for NumberConfigFormat.
Defines values for NumberConfigFormat.
Defines values for NumberConfigFormat.
Defines values for NumberConfigFormat.
Defines values for NumberConfigFormat.
Defines values for NumberConfigFormat.
Defines values for NumberConfigFormat.
Defines values for NumberConfigFormat.
Defines values for NumberConfigFormat.
Defines values for NumberConfigFormat.
Defines values for NumberConfigFormat.
Defines values for NumberConfigFormat.
Defines values for NumberConfigFormat.
Defines values for NumberConfigFormat.
Defines values for NumberConfigFormat.
Defines values for NumberConfigFormat.
Defines values for NumberConfigFormat.
Defines values for NumberConfigFormat.
Defines values for NumberConfigFormat.
Defines values for NumberConfigFormat.
Defines values for ParentType.
Defines values for ParentType.
Defines values for ParentType.
Defines values for ParentType.
Defines values for PropertyType.
Defines values for PropertyType.
Defines values for PropertyType.
Defines values for PropertyType.
Defines values for PropertyType.
Defines values for PropertyType.
Defines values for PropertyType.
Defines values for PropertyType.
Defines values for PropertyType.
Defines values for PropertyType.
Defines values for PropertyType.
Defines values for PropertyType.
Defines values for PropertyType.
Defines values for PropertyType.
Defines values for PropertyType.
Defines values for PropertyType.
Defines values for PropertyType.
Defines values for PropertyType.
Defines values for PropertyType.
Defines values for PropertyType.
Defines values for RelationConfigurationType.
Defines values for RelationConfigurationType.
Defines values for RichTextType.
Defines values for RichTextType.
Defines values for RichTextType.
Defines values for RollupArrayItemType.
Defines values for RollupArrayItemType.
Defines values for RollupArrayItemType.
Defines values for RollupArrayItemType.
Defines values for RollupConfigFunction.
Defines values for RollupConfigFunction.
Defines values for RollupConfigFunction.
Defines values for RollupConfigFunction.
Defines values for RollupConfigFunction.
Defines values for RollupConfigFunction.
Defines values for RollupConfigFunction.
Defines values for RollupConfigFunction.
Defines values for RollupConfigFunction.
Defines values for RollupConfigFunction.
Defines values for RollupConfigFunction.
Defines values for RollupConfigFunction.
Defines values for RollupConfigFunction.
Defines values for RollupConfigFunction.
Defines values for RollupType.
Defines values for RollupType.
Defines values for RollupType.
Defines values for RollupType.
Defines values for SearchFilterProperty.
Defines values for SearchFilterValue.
Defines values for SearchFilterValue.
Defines values for SearchResultObject.
Defines values for SortDirection.
Defines values for SortDirection.
Defines values for SyncedFromType.
Defines values for TimestampFilterTimestamp.
Defines values for TimestampFilterTimestamp.
Defines values for UserType.
Defines values for UserType.
# Variables
ErrBadRequest is returned when we get a 502 Bad Gateway or 504 Gateway Timeout response.
TitleProperty represents a Title property.
# Structs
Style information which applies to the whole rich text object.
No description provided by the author
A block object represents content within Notion.
BlocksChildren defines model for BlocksChildren.
BlocksList defines model for BlocksList.
Bot defines model for Bot.
Callout block objects contain the following information within the callout field.
CheckboxFilter defines model for CheckboxFilter.
The title of the child page or database.
Code block objects contain this information within the `code` property.
No description provided by the author
No description provided by the author
Database defines model for Database.
DatabaseQuery defines model for DatabaseQuery.
Date defines model for Date.
A date filter condition can be used to limit `date` property value types and the timestamp property types `created_time` and `last_edited_time`.
No description provided by the author
No description provided by the author
Dual property relation objects contain this configuration within the `dual_property` property.
Embed blocks include block types that allow displaying another website within Notion.
Equation block objects contain this information within the `equation` property.
Something went wrong.
An external file is any URL that isn't hosted by Notion.
File objects contain data about files uploaded to Notion as well as external files linked in Notion.
FilesFilter defines model for FilesFilter.
File objects contain data about files uploaded to Notion as well as external files linked in Notion.
Filter defines model for Filter.
Formula property value objects represent the result of evaluating a formula described in the database's properties.
Formula database property objects contain this configuration within the `formula` property.
The primary field of the formula filter condition object matches the type of the formula’s result.
No description provided by the author
GetBlocksParams defines parameters for GetBlocks.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Heading block objects contain this information within their respective property.
Page or database icon.
An inline link in a text.
Link Preview block objects return the originally pasted url.
LinkToPage defines model for LinkToPage.
ListUsersParams defines parameters for ListUsers.
No description provided by the author
Mention defines model for Mention.
Every database should at least contain one property of type `title`.
MultiSelectFilter defines model for MultiSelectFilter.
File objects contain this information within the `file` property.
Number database property schema objects contain this configuration within the number property.
NumberFilter defines model for NumberFilter.
The Page object contains the [property values](https://developers.notion.com/reference/property-value-object) of a single Notion page.
PageOrDatabase defines model for PageOrDatabase.
PagesList defines model for PagesList.
Paragraph, quote, toggle and list item block objects contain this information within their respective property.
The `parent` property of a page or database contains these keys.
You can apply a people filter condition to people, created_by, and last_edited_by database property types.
User objects that represent people have the `type` property set to `person`.
Metadata that controls how a database property behaves.
A property value defines the identifier, type, and value of a page property in a page object.
No description provided by the author
Reference defines model for Reference.
RelationConfiguration defines model for RelationConfiguration.
RelationFilter defines model for RelationFilter.
Rich text objects contain data for displaying formatted text, mentions, and equations.
RichTextFilter defines model for RichTextFilter.
Rollup property value objects represent the result of evaluating a rollup described in the database's properties.
RollupArrayItem defines model for RollupArrayItem.
Rollup database property objects contain the following configuration within the `rollup` property.
This body determines what you search for.
SearchFilter defines model for SearchFilter.
No description provided by the author
SearchResult defines model for SearchResult.
SelectFilter defines model for SelectFilter.
Multi-select or select option values.
SelectValuesWrapper defines model for SelectValuesWrapper.
Sort defines model for Sort.
StatusConfig represents the status configuration for a database.
StatusFilter defines model for StatusFilter.
StatusGroup defines model for StatusGroup.
StatusOption defines model for StatusOption.
SyncedBlock defines model for SyncedBlock.
SyncedFrom defines model for SyncedFrom.
Table defines model for Table.
Table of contents block objects contain the following information within the `table_of_contents` property.
Table row blocks contain this within the table_row property.
Template defines model for Template.
Text objects contain this information within the `text` property of a RichText object.
TimestampFilter defines model for TimestampFilter.
Title defines model for Title.
To do block objects contain this information within the `to_do` property.
No description provided by the author
No description provided by the author
No description provided by the author
The User object represents a user in a Notion workspace.
UsersList defines model for UsersList.
# Interfaces
ClientInterface interface specification for the client.
Getter is any client that can get notion documents.
PropertyMetas defines model for PropertyMetas.
Properties of a page or database.
# Type aliases
AppendBlocksJSONBody defines parameters for AppendBlocks.
AppendBlocksJSONRequestBody defines body for AppendBlocks for application/json ContentType.
A block object represents content within Notion.
Blocks defines model for Blocks.
BlocksResponse defines model for BlocksResponse.
Type of block.
Client conforms to the OpenAPI3 specification for this service.
Coding language in code block.
The color of the block.
CreateDatabaseJSONRequestBody defines body for CreateDatabase for application/json ContentType.
CreatePageJSONBody defines parameters for CreatePage.
CreatePageJSONRequestBody defines body for CreatePage for application/json ContentType.
DatabaseRequestBody defines model for DatabaseRequestBody.
DatabaseResponse defines model for DatabaseResponse.
Databases is a list of databases.
Something went wrong.
Files defines model for Files.
Type of this file object.
Type of this file object.
Filters defines model for Filters.
FormulaType defines model for Formula.Type.
Type of icon.
A unique identifier for a page, block, database, user, or option.
Type of this link to page object.
Type of the inline mention.
A unique identifier for a page, block, database, or user.
How the number is displayed in Notion.
The Page object contains the [property values](https://developers.notion.com/reference/property-value-object) of a single Notion page.
Pages defines model for Pages.
The number of items from the full list desired in the response.
PagesResponse defines model for PagesResponse.
The type of the parent.
PropertyMetaMap is a map of all properties.
Type of the property.
PropertyValueMap is a map of all property values.
QueryDatabaseJSONBody defines parameters for QueryDatabase.
QueryDatabaseJSONRequestBody defines body for QueryDatabase for application/json ContentType.
References defines model for References.
The type of the relation.
RichTexts defines model for RichTexts.
Type of this rich text object.
Array rollup property values contain an array of number, date, or string objects within the results property.
RollupArrayItemType defines model for RollupArrayItem.Type.
The function that is evaluated for every page in the relation of the rollup.
RollupType defines model for Rollup.Type.
SearchFilterProperty defines model for SearchFilter.Property.
SearchFilterValue defines model for SearchFilter.Value.
SearchJSONBody defines parameters for Search.
SearchJSONRequestBody defines body for Search for application/json ContentType.
SearchResultObject defines model for SearchResult.Object.
An array of multi-select or select option values.
Which way to sort.
Sorts defines model for Sorts.
If supplied, this endpoint will return a page of results starting after the cursor provided.
StatusGroups defines model for StatusGroups.
An array of status option objects.
SyncedFromType defines model for SyncedFrom.Type.
A constant string representing the type of timestamp to use as a filter.
UpdateDatabaseJSONRequestBody defines body for UpdateDatabase for application/json ContentType.
UpdatePageJSONBody defines parameters for UpdatePage.
UpdatePageJSONRequestBody defines body for UpdatePage for application/json ContentType.
The User object represents a user in a Notion workspace.
Users defines model for Users.
UsersResponse defines model for UsersResponse.
Type of the user.
A unique identifier for a page, block, database, user, or option.
No description provided by the author