Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/notion-dotnet/notion-sdk-net
A Notion SDK for .Net
https://github.com/notion-dotnet/notion-sdk-net
api api-client csharp dotnet hacktoberfest hacktoberfest2022 hacktoberfest2023 notion notion-api notion-dotnet sdk
Last synced: 7 days ago
JSON representation
A Notion SDK for .Net
- Host: GitHub
- URL: https://github.com/notion-dotnet/notion-sdk-net
- Owner: notion-dotnet
- License: mit
- Created: 2021-05-22T04:58:50.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-11-03T09:08:14.000Z (about 2 months ago)
- Last Synced: 2024-12-03T18:30:34.178Z (21 days ago)
- Topics: api, api-client, csharp, dotnet, hacktoberfest, hacktoberfest2022, hacktoberfest2023, notion, notion-api, notion-dotnet, sdk
- Language: C#
- Homepage:
- Size: 736 KB
- Stars: 185
- Watchers: 6
- Forks: 47
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
[]()
[]()
[](https://github.com/notion-dotnet/notion-sdk-net/actions/workflows/ci-build.yml)
[](https://github.com/notion-dotnet/notion-sdk-net/actions/workflows/build-artifacts-code.yml)
[](https://github.com/notion-dotnet/notion-sdk-net/actions/workflows/publish-code.yml)
[](https://github.com/notion-dotnet/notion-sdk-net/actions/workflows/codeql-analysis.yml)
[](https://lgtm.com/projects/g/notion-dotnet/notion-sdk-net/alerts/?mode=list)
[](https://lgtm.com/projects/g/notion-dotnet/notion-sdk-net/alerts/?mode=list)
[]()
[]()
[]()
[]()
[]()
[]()
Provides the following packages:
| Package | Downloads | Nuget |
|---|---|---|
| Notion.Net | [](https://www.nuget.org/packages/Notion.Net) | [ ](https://www.nuget.org/packages/Notion.Net) |
## Installation
.Net CLI
```
dotnet add package Notion.Net
```
**Note:** default Notion-Version used by NuGet package versions
| Package version | Notion-Version |
| --- | --- |
| 4.0.0-preview-1.8.21.2022 | 2022-06-28 |
| 3.0.0+ | 2022-02-22 |
| 2.0.0+ | 2021-08-16 |
| 1.0.0+ | 2021-05-13 |
## Usage
> Before getting started, you need to [create an integration](https://www.notion.com/my-integrations) and find the token. You can learn more about authorization [here](https://developers.notion.com/docs/authorization).
Import and initialize the client using the integration token created above.
```csharp
var client = NotionClientFactory.Create(new ClientOptions
{
AuthToken = ""
});
```
Make A request to any Endpoint. For example you can call below to fetch the paginated list of users.
```csharp
var usersList = await client.Users.ListAsync();
```
## Dependency Injection
Library also provides extension method to register NotionClient with Microsoft dependency injection.
```
services.AddNotionClient(options => {
options.AuthToken = "";
});
```
### Querying a database
After you initialized your client and got an id of a database, you can query it for any contained pages. You can add filters and sorts to your request. Here is a simple example:
```C#
// Date filter for page property called "When"
var dateFilter = new DateFilter("When", onOrAfter: DateTime.Now);
var queryParams = new DatabasesQueryParameters { Filter = dateFilter };
var pages = await client.Databases.QueryAsync(databaseId, queryParams);
```
Filters constructors contain all possible filter conditions, but you need to choose only condition per filter, all other should be `null`. So, for example this code would not filter by 2 conditions as one might expect:
```C#
var filter = new TextFilter("Name", startsWith: "Mr", contains: "John"); // WRONG FILTER USAGE
```
To use complex filters, use class `CompoundFilter`. It allows adding many filters and even nesting compound filters into each other (it works as filter group in Notion interface). Here is an example of filter that would return pages that were due in past month AND either had a certain assignee OR had high urgency:
```C#
var selectFilter = new SelectFilter("Urgency", equal: "High");
var assigneeFilter = new PeopleFilter("Assignee", contains: "some-uuid");
var dateFilter = new DateFilter("Due", pastMonth: new Dictionary());
var orGroup = new List { assigneeFilter, selectFilter };
var complexFiler = new CompoundFilter(
and: new List { dateFilter, new CompoundFilter(or: orGroup) }
);
```
## Supported Endpoints
- [x] Databases
- [x] Query a database
- [x] Create a database
- [x] Update database
- [x] Retrieve a database
- [x] Pages
- [x] Retrieve a page
- [x] Create a page
- [x] Update page
- [x] Retrieve page property item
- [x] Blocks
- [x] Retrieve a block
- [x] Update a block
- [x] Retrieve block children
- [x] Append block children
- [x] Delete a block
- [x] Comments
- [x] Retrieve comments
- [x] Create comment
- [x] Users
- [x] Retrieve a User
- [x] List all users
- [x] Retrieve your token's bot user
- [x] Search
## Enable internal logs
The library make use of `ILoggerFactory` interface exposed by `Microsoft.Extensions.Logging`. Which allow you to have ability to enable the internal logs when developing application to get additional information.
To enable logging you need to add the below code at startup of the application.
```csharp
// pass the ILoggerFactory instance
NotionClientLogging.ConfigureLogger(logger);
```
You can set the LogLevel in config file.
```json
{
"Logging": {
"LogLevel": {
"Notion.Client": "Trace"
}
}
}
```
You can also refer `examples/list-users` example.
## Contributors
This project exists thanks to all the people who contribute.
[](https://github.com/notion-dotnet/notion-sdk-net/graphs/contributors)
## Contribution Guideline
Hello! Thank you for choosing to help contribute to this open source library. There are many ways you can contribute and help is always welcome. You can read the detailed [Contribution Guideline](https://github.com/notion-dotnet/notion-sdk-net/blob/main/CONTRIBUTING.md) defined here - we will continue to improve it.