bushero / notion-sharp Goto Github PK

View Code? Open in Web Editor NEW

1.0 1.0 1.0 487 KB

Unnoficial SDK around the Notion REST API

License: MIT License

C# 98.60% Batchfile 0.05% PowerShell 0.76% Shell 0.59%

notion rest notion-api sdk csharp refit

notion-sharp's Introduction

Notion-SDK

Unnoficial SDK for around Notion API

Installation

The project is avaiable on Nuget

dotnet add package Notion.Sharp

Usage

The first step for using the SDK is to initialize the client with the Bearer Token and the Notion API Version. You should create a notion integration to get a bearer token.

string bearerToken = BEARER_TOKEN;
string apiVersion = "2021-08-16";
INotion client = Notion.GetClient(bearerToken, apiVersion);

Endpoints

Each notion api endpoint has a corresponding method associated with it

Name	Method
Query a database	`QueryDatabaseAsync`
Create a database	`CreateDatabaseAsync`
Update database	`UpdateDatabaseAsync`
Retrieve a database	`GetDatabaseAsync`
List databases (deprecated)	`GetDatabasesAsync`
Retrieve a page	`GetPageAsync`
Create a page	`CreatePageAsync`
Update page	`UpdatePageAsync`
Retrieve a page property item	`GetPagePropertyAsync`
Retrieve a block	`GetBlockAsync`
Update a block	`UpdateBlockAsync`
Retrieve block children	`GetBlocksChildrenAsync`
Append block children	`AppendBlockChildrenAsync`
Delete a block	`DeleteBlockAsync`
Retrieve a user	`GetUserAsync`
List all users	`GetUsersAsync`
Retrieve your token's bot user	`GetMeAsync`
Search	`SearchAsync`

Examples

Make a request to any endpoint

PaginationList<User> users = await client.GetUsersAsync();

notion-sharp's People

Contributors

Stargazers

Watchers

Forkers

mlykes

notion-sharp's Issues

Sort

Create Date Property Value writer

Update database

Endpoint

Retrieve a user

Retrieve database

Retrieve a database

Database

Delete a block

Filter

Cashing

User

Add xml docs for the endpoints

As a user, I want to get documentation in the browser for the endpoints I use, so that it is clear for me how to use them.

Notion Client Creation

As a user of the Notion.SDK library,
I want to be able to initialize a client with my Bearer Token,
So that I can interact with the Notion's endpoints.

Add Linq to NavigationPage

As a user, I want to interact with the NavigationPage using Linq

Create a fluent interface for page creation

As a user, I want to create a page using a fluent interface

Update a block

Create a fluent interface for block creation

As a user, I want to create a block using a fluent interface

Change parameters for AppendBlock endpoind from object to strongly typed

As a user, I want to use strongly typed arguments when interacting with the AppendBlock endpoint

Use strongly typed arguments instead of object arguments when interacting with CreatePage endpoint

As a user, I want to use strongly typed arguments when interacting with the CreatePage endpoint

Property

Use strongly typed arguments instead of object arguments when interacting with UpdatePage endpoint

As a user, I want to use a strongly typed argument instead of an object argument when interacting with the UpdatePage endpoint

Query a database

Retrieve block children

Retrieve a block

File

Create a database

Create a Database

Update Page

Update page

Rich Text

Investigate an alternative solution for custom json serializers

Add a README.md

As a user, I want to see an awesome readme page when navigation to the github page of the project, so that I know what this project is all about without looking to the source code.