Skip to content

Draft: Generated Documentation #352

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions docs/Notion.Client.ApiEndpoints.BlocksApiUrls.Delete(string).md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
### [Notion.Client](Notion.Client.md 'Notion.Client').[ApiEndpoints](Notion.Client.ApiEndpoints.md 'Notion.Client.ApiEndpoints').[BlocksApiUrls](Notion.Client.ApiEndpoints.BlocksApiUrls.md 'Notion.Client.ApiEndpoints.BlocksApiUrls')

## ApiEndpoints.BlocksApiUrls.Delete(string) Method

Get the Uri [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') for deleting a block.

```csharp
public static string Delete(string blockId);
```
#### Parameters

<a name='Notion.Client.ApiEndpoints.BlocksApiUrls.Delete(string).blockId'></a>

`blockId` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')

Identifier for a Notion block

#### Returns
[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
Returns a Uri [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') for deleting a block.
13 changes: 13 additions & 0 deletions docs/Notion.Client.ApiEndpoints.BlocksApiUrls.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
### [Notion.Client](Notion.Client.md 'Notion.Client').[ApiEndpoints](Notion.Client.ApiEndpoints.md 'Notion.Client.ApiEndpoints')

## ApiEndpoints.BlocksApiUrls Class

```csharp
public static class ApiEndpoints.BlocksApiUrls
```

Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') &#129106; BlocksApiUrls

| Methods | |
| :--- | :--- |
| [Delete(string)](Notion.Client.ApiEndpoints.BlocksApiUrls.Delete(string).md 'Notion.Client.ApiEndpoints.BlocksApiUrls.Delete(string)') | Get the Uri [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') for deleting a block. |
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
### [Notion.Client](Notion.Client.md 'Notion.Client').[ApiEndpoints](Notion.Client.ApiEndpoints.md 'Notion.Client.ApiEndpoints').[PagesApiUrls](Notion.Client.ApiEndpoints.PagesApiUrls.md 'Notion.Client.ApiEndpoints.PagesApiUrls')

## ApiEndpoints.PagesApiUrls.RetrievePropertyItem(string, string) Method

Get the Uri [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') for retrieve page property item

```csharp
public static string RetrievePropertyItem(string pageId, string propertyId);
```
#### Parameters

<a name='Notion.Client.ApiEndpoints.PagesApiUrls.RetrievePropertyItem(string,string).pageId'></a>

`pageId` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')

Identifier for a Notion Page

<a name='Notion.Client.ApiEndpoints.PagesApiUrls.RetrievePropertyItem(string,string).propertyId'></a>

`propertyId` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')

Identifier for a Notion Property

#### Returns
[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
Returns a Uri [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') for Retrieve page property item
13 changes: 13 additions & 0 deletions docs/Notion.Client.ApiEndpoints.PagesApiUrls.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
### [Notion.Client](Notion.Client.md 'Notion.Client').[ApiEndpoints](Notion.Client.ApiEndpoints.md 'Notion.Client.ApiEndpoints')

## ApiEndpoints.PagesApiUrls Class

```csharp
public static class ApiEndpoints.PagesApiUrls
```

Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') &#129106; PagesApiUrls

| Methods | |
| :--- | :--- |
| [RetrievePropertyItem(string, string)](Notion.Client.ApiEndpoints.PagesApiUrls.RetrievePropertyItem(string,string).md 'Notion.Client.ApiEndpoints.PagesApiUrls.RetrievePropertyItem(string, string)') | Get the Uri [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') for retrieve page property item |
13 changes: 13 additions & 0 deletions docs/Notion.Client.ApiEndpoints.UsersApiUrls.Me().md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
### [Notion.Client](Notion.Client.md 'Notion.Client').[ApiEndpoints](Notion.Client.ApiEndpoints.md 'Notion.Client.ApiEndpoints').[UsersApiUrls](Notion.Client.ApiEndpoints.UsersApiUrls.md 'Notion.Client.ApiEndpoints.UsersApiUrls')

## ApiEndpoints.UsersApiUrls.Me() Method

Get the Uri [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') for retrieve your token's bot user.

```csharp
public static string Me();
```

#### Returns
[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
Returns a Uri [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') retrieve your token's bot user.
13 changes: 13 additions & 0 deletions docs/Notion.Client.ApiEndpoints.UsersApiUrls.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
### [Notion.Client](Notion.Client.md 'Notion.Client').[ApiEndpoints](Notion.Client.ApiEndpoints.md 'Notion.Client.ApiEndpoints')

## ApiEndpoints.UsersApiUrls Class

```csharp
public static class ApiEndpoints.UsersApiUrls
```

Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') &#129106; UsersApiUrls

| Methods | |
| :--- | :--- |
| [Me()](Notion.Client.ApiEndpoints.UsersApiUrls.Me().md 'Notion.Client.ApiEndpoints.UsersApiUrls.Me()') | Get the Uri [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') for retrieve your token's bot user. |
22 changes: 22 additions & 0 deletions docs/Notion.Client.ApiEndpoints.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
### [Notion.Client](Notion.Client.md 'Notion.Client')

## ApiEndpoints Class

```csharp
public static class ApiEndpoints
```

### [Notion.Client](Notion.Client.md 'Notion.Client').[ApiEndpoints](Notion.Client.ApiEndpoints.md 'Notion.Client.ApiEndpoints')

## ApiEndpoints.BlocksApiUrls Class

```csharp
public static class ApiEndpoints.BlocksApiUrls
```

Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') &#129106; BlocksApiUrls

| Methods | |
| :--- | :--- |
| [Delete(string)](Notion.Client.ApiEndpoints.BlocksApiUrls.Delete(string).md 'Notion.Client.ApiEndpoints.BlocksApiUrls.Delete(string)') | Get the Uri [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') for deleting a block. |

14 changes: 14 additions & 0 deletions docs/Notion.Client.Block.Parent.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
### [Notion.Client](Notion.Client.md 'Notion.Client').[Block](Notion.Client.Block.md 'Notion.Client.Block')

## Block.Parent Property

Information about the block's parent.

```csharp
public Notion.Client.IBlockParent Parent { get; set; }
```

Implements [Parent](https://docs.microsoft.com/en-us/dotnet/api/Notion.Client.IBlock.Parent 'Notion.Client.IBlock.Parent')

#### Property Value
[Notion.Client.IBlockParent](https://docs.microsoft.com/en-us/dotnet/api/Notion.Client.IBlockParent 'Notion.Client.IBlockParent')
18 changes: 18 additions & 0 deletions docs/Notion.Client.Block.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
### [Notion.Client](Notion.Client.md 'Notion.Client')

## Block Class

```csharp
public abstract class Block :
Notion.Client.IBlock,
Notion.Client.IObject,
Notion.Client.IObjectModificationData
```

Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') &#129106; Block

Implements [Notion.Client.IBlock](https://docs.microsoft.com/en-us/dotnet/api/Notion.Client.IBlock 'Notion.Client.IBlock'), [Notion.Client.IObject](https://docs.microsoft.com/en-us/dotnet/api/Notion.Client.IObject 'Notion.Client.IObject'), [IObjectModificationData](Notion.Client.IObjectModificationData.md 'Notion.Client.IObjectModificationData')

| Properties | |
| :--- | :--- |
| [Parent](Notion.Client.Block.Parent.md 'Notion.Client.Block.Parent') | Information about the block's parent. |
12 changes: 12 additions & 0 deletions docs/Notion.Client.BlockParent.BlockId.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
### [Notion.Client](Notion.Client.md 'Notion.Client').[BlockParent](Notion.Client.BlockParent.md 'Notion.Client.BlockParent')

## BlockParent.BlockId Property

The ID of the block that the element belongs to.

```csharp
public string BlockId { get; set; }
```

#### Property Value
[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
14 changes: 14 additions & 0 deletions docs/Notion.Client.BlockParent.Type.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
### [Notion.Client](Notion.Client.md 'Notion.Client').[BlockParent](Notion.Client.BlockParent.md 'Notion.Client.BlockParent')

## BlockParent.Type Property

Always has a value "block_id"

```csharp
public Notion.Client.ParentType Type { get; set; }
```

Implements [Type](https://docs.microsoft.com/en-us/dotnet/api/Notion.Client.IParent.Type 'Notion.Client.IParent.Type')

#### Property Value
[Notion.Client.ParentType](https://docs.microsoft.com/en-us/dotnet/api/Notion.Client.ParentType 'Notion.Client.ParentType')
21 changes: 21 additions & 0 deletions docs/Notion.Client.BlockParent.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
### [Notion.Client](Notion.Client.md 'Notion.Client')

## BlockParent Class

```csharp
public class BlockParent :
Notion.Client.IPageParent,
Notion.Client.IParent,
Notion.Client.IDatabaseParent,
Notion.Client.IBlockParent,
Notion.Client.ICommentParent
```

Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') &#129106; BlockParent

Implements [Notion.Client.IPageParent](https://docs.microsoft.com/en-us/dotnet/api/Notion.Client.IPageParent 'Notion.Client.IPageParent'), [Notion.Client.IParent](https://docs.microsoft.com/en-us/dotnet/api/Notion.Client.IParent 'Notion.Client.IParent'), [Notion.Client.IDatabaseParent](https://docs.microsoft.com/en-us/dotnet/api/Notion.Client.IDatabaseParent 'Notion.Client.IDatabaseParent'), [Notion.Client.IBlockParent](https://docs.microsoft.com/en-us/dotnet/api/Notion.Client.IBlockParent 'Notion.Client.IBlockParent'), [Notion.Client.ICommentParent](https://docs.microsoft.com/en-us/dotnet/api/Notion.Client.ICommentParent 'Notion.Client.ICommentParent')

| Properties | |
| :--- | :--- |
| [BlockId](Notion.Client.BlockParent.BlockId.md 'Notion.Client.BlockParent.BlockId') | The ID of the block that the element belongs to. |
| [Type](Notion.Client.BlockParent.Type.md 'Notion.Client.BlockParent.Type') | Always has a value "block_id" |
11 changes: 11 additions & 0 deletions docs/Notion.Client.CheckboxPropertyValue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
### [Notion.Client](Notion.Client.md 'Notion.Client')

## CheckboxPropertyValue Class

Checkbox property value objects contain a boolean within the checkbox property.

```csharp
public class CheckboxPropertyValue : Notion.Client.PropertyValue
```

Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') &#129106; [PropertyValue](Notion.Client.PropertyValue.md 'Notion.Client.PropertyValue') &#129106; CheckboxPropertyValue
12 changes: 12 additions & 0 deletions docs/Notion.Client.CreatedByPropertyValue.CreatedBy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
### [Notion.Client](Notion.Client.md 'Notion.Client').[CreatedByPropertyValue](Notion.Client.CreatedByPropertyValue.md 'Notion.Client.CreatedByPropertyValue')

## CreatedByPropertyValue.CreatedBy Property

Describes the user who created this page.

```csharp
public Notion.Client.User CreatedBy { get; set; }
```

#### Property Value
[Notion.Client.User](https://docs.microsoft.com/en-us/dotnet/api/Notion.Client.User 'Notion.Client.User')
15 changes: 15 additions & 0 deletions docs/Notion.Client.CreatedByPropertyValue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
### [Notion.Client](Notion.Client.md 'Notion.Client')

## CreatedByPropertyValue Class

Created by property value object

```csharp
public class CreatedByPropertyValue : Notion.Client.PropertyValue
```

Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') &#129106; [PropertyValue](Notion.Client.PropertyValue.md 'Notion.Client.PropertyValue') &#129106; CreatedByPropertyValue

| Properties | |
| :--- | :--- |
| [CreatedBy](Notion.Client.CreatedByPropertyValue.CreatedBy.md 'Notion.Client.CreatedByPropertyValue.CreatedBy') | Describes the user who created this page. |
12 changes: 12 additions & 0 deletions docs/Notion.Client.CreatedTimePropertyValue.CreatedTime.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
### [Notion.Client](Notion.Client.md 'Notion.Client').[CreatedTimePropertyValue](Notion.Client.CreatedTimePropertyValue.md 'Notion.Client.CreatedTimePropertyValue')

## CreatedTimePropertyValue.CreatedTime Property

The date and time when this page was created.

```csharp
public string CreatedTime { get; set; }
```

#### Property Value
[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
15 changes: 15 additions & 0 deletions docs/Notion.Client.CreatedTimePropertyValue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
### [Notion.Client](Notion.Client.md 'Notion.Client')

## CreatedTimePropertyValue Class

Created time property value object.

```csharp
public class CreatedTimePropertyValue : Notion.Client.PropertyValue
```

Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') &#129106; [PropertyValue](Notion.Client.PropertyValue.md 'Notion.Client.PropertyValue') &#129106; CreatedTimePropertyValue

| Properties | |
| :--- | :--- |
| [CreatedTime](Notion.Client.CreatedTimePropertyValue.CreatedTime.md 'Notion.Client.CreatedTimePropertyValue.CreatedTime') | The date and time when this page was created. |
12 changes: 12 additions & 0 deletions docs/Notion.Client.Database.Archived.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
### [Notion.Client](Notion.Client.md 'Notion.Client').[Database](Notion.Client.Database.md 'Notion.Client.Database')

## Database.Archived Property

The archived status of the database.

```csharp
public bool Archived { get; set; }
```

#### Property Value
[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean')
12 changes: 12 additions & 0 deletions docs/Notion.Client.Database.Url.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
### [Notion.Client](Notion.Client.md 'Notion.Client').[Database](Notion.Client.Database.md 'Notion.Client.Database')

## Database.Url Property

The URL of the Notion database.

```csharp
public string Url { get; set; }
```

#### Property Value
[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
18 changes: 18 additions & 0 deletions docs/Notion.Client.Database.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
### [Notion.Client](Notion.Client.md 'Notion.Client')

## Database Class

```csharp
public class Database :
Notion.Client.IObject,
Notion.Client.IObjectModificationData
```

Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') &#129106; Database

Implements [Notion.Client.IObject](https://docs.microsoft.com/en-us/dotnet/api/Notion.Client.IObject 'Notion.Client.IObject'), [IObjectModificationData](Notion.Client.IObjectModificationData.md 'Notion.Client.IObjectModificationData')

| Properties | |
| :--- | :--- |
| [Archived](Notion.Client.Database.Archived.md 'Notion.Client.Database.Archived') | The archived status of the database. |
| [Url](Notion.Client.Database.Url.md 'Notion.Client.Database.Url') | The URL of the Notion database. |
12 changes: 12 additions & 0 deletions docs/Notion.Client.DatabaseParent.DatabaseId.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
### [Notion.Client](Notion.Client.md 'Notion.Client').[DatabaseParent](Notion.Client.DatabaseParent.md 'Notion.Client.DatabaseParent')

## DatabaseParent.DatabaseId Property

The ID of the database that this page belongs to.

```csharp
public string DatabaseId { get; set; }
```

#### Property Value
[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
14 changes: 14 additions & 0 deletions docs/Notion.Client.DatabaseParent.Type.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
### [Notion.Client](Notion.Client.md 'Notion.Client').[DatabaseParent](Notion.Client.DatabaseParent.md 'Notion.Client.DatabaseParent')

## DatabaseParent.Type Property

Always "database_id"

```csharp
public Notion.Client.ParentType Type { get; set; }
```

Implements [Type](https://docs.microsoft.com/en-us/dotnet/api/Notion.Client.IParent.Type 'Notion.Client.IParent.Type')

#### Property Value
[Notion.Client.ParentType](https://docs.microsoft.com/en-us/dotnet/api/Notion.Client.ParentType 'Notion.Client.ParentType')
19 changes: 19 additions & 0 deletions docs/Notion.Client.DatabaseParent.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
### [Notion.Client](Notion.Client.md 'Notion.Client')

## DatabaseParent Class

```csharp
public class DatabaseParent :
Notion.Client.IPageParent,
Notion.Client.IParent,
Notion.Client.IBlockParent
```

Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') &#129106; DatabaseParent

Implements [Notion.Client.IPageParent](https://docs.microsoft.com/en-us/dotnet/api/Notion.Client.IPageParent 'Notion.Client.IPageParent'), [Notion.Client.IParent](https://docs.microsoft.com/en-us/dotnet/api/Notion.Client.IParent 'Notion.Client.IParent'), [Notion.Client.IBlockParent](https://docs.microsoft.com/en-us/dotnet/api/Notion.Client.IBlockParent 'Notion.Client.IBlockParent')

| Properties | |
| :--- | :--- |
| [DatabaseId](Notion.Client.DatabaseParent.DatabaseId.md 'Notion.Client.DatabaseParent.DatabaseId') | The ID of the database that this page belongs to. |
| [Type](Notion.Client.DatabaseParent.Type.md 'Notion.Client.DatabaseParent.Type') | Always "database_id" |
Loading