-
-
Notifications
You must be signed in to change notification settings - Fork 139
/
api_endpoints.py
205 lines (167 loc) · 7.4 KB
/
api_endpoints.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
"""Notion API endpoints."""
from typing import TYPE_CHECKING, Any
from notion_client.helpers import pick
from notion_client.typing import SyncAsync
if TYPE_CHECKING:
from notion_client.client import BaseClient
class Endpoint:
def __init__(self, parent: "BaseClient") -> None:
self.parent = parent
class BlocksChildrenEndpoint(Endpoint):
def append(self, block_id: str, **kwargs: Any) -> SyncAsync[Any]:
"""Create and append new children blocks to the block using the ID specified.
Returns the Block object which contains the new children.
"""
return self.parent.request(
path=f"blocks/{block_id}/children",
method="PATCH",
body=pick(kwargs, "children"),
auth=kwargs.get("auth"),
)
def list(self, block_id: str, **kwargs: Any) -> SyncAsync[Any]:
"""Return a paginated array of child block objects contained in the block.
In order to receive a complete representation of a block, you may need to
recursively retrieve the block children of child blocks.
"""
return self.parent.request(
path=f"blocks/{block_id}/children",
method="GET",
query=pick(kwargs, "start_cursor", "page_size"),
auth=kwargs.get("auth"),
)
class BlocksEndpoint(Endpoint):
def __init__(self, *args: Any, **kwargs: Any) -> None:
super().__init__(*args, **kwargs)
self.children = BlocksChildrenEndpoint(*args, **kwargs)
def retrieve(self, block_id: str, **kwargs: Any) -> SyncAsync[Any]:
"""Retrieve a Block object using the ID specified."""
return self.parent.request(
path=f"blocks/{block_id}", method="GET", auth=kwargs.get("auth")
)
def update(self, block_id: str, **kwargs: Any) -> SyncAsync[Any]:
"""Update the content for the specified `block_id` based on the block type.
Supported fields are based on the block object type.
**Note**: The update replaces the *entire* value for a given field. If a field is
omitted (ex: omitting `checked` when updating a `to_do` block), the value will
not be changed.
Currently this endpoint supports updating `paragraph`, `heading_1`, `heading_2`,
`heading_3`, `bulleted_list_item`, `numbered_list_item`, `toggle` and `to_do`
blocks.
"""
return self.parent.request(
path=f"blocks/{block_id}",
method="PATCH",
body=pick(
kwargs,
"paragraph",
"heading_1",
"heading_2",
"heading_3",
"bulleted_list_item",
"numbered_list_item",
"toggle",
"to_do",
),
auth=kwargs.get("auth"),
)
class DatabasesEndpoint(Endpoint):
def list(self, **kwargs: Any) -> SyncAsync[Any]:
"""List all Databases shared with the authenticated integration."""
return self.parent.request(
path="databases",
method="GET",
query=pick(kwargs, "start_cursor", "page_size"),
auth=kwargs.get("auth"),
)
def query(self, database_id: str, **kwargs: Any) -> SyncAsync[Any]:
"""Get a list of Pages contained in the database.
The result is filtered and ordered according to the filter conditions and sort
criteria provided in the request.
"""
return self.parent.request(
path=f"databases/{database_id}/query",
method="POST",
body=pick(kwargs, "filter", "sorts", "start_cursor", "page_size"),
auth=kwargs.get("auth"),
)
def retrieve(self, database_id: str, **kwargs: Any) -> SyncAsync[Any]:
"""Retrieve a Database object using the ID specified."""
return self.parent.request(
path=f"databases/{database_id}", method="GET", auth=kwargs.get("auth")
)
def create(self, **kwargs: Any) -> SyncAsync[Any]:
"""Create a database as a subpage in the specified parent page."""
return self.parent.request(
path="databases",
method="POST",
body=pick(kwargs, "parent", "title", "properties"),
auth=kwargs.get("auth"),
)
def update(self, database_id: str, **kwargs: Any) -> SyncAsync[Any]:
"""Update an existing database as specified by the parameters."""
return self.parent.request(
path=f"databases/{database_id}",
method="PATCH",
body=pick(kwargs, "properties", "title"),
auth=kwargs.get("auth"),
)
class PagesEndpoint(Endpoint):
def create(self, **kwargs: Any) -> SyncAsync[Any]:
"""Create a new page in the specified database or as a child of an existing page.
If the parent is a database, the `properties` parameter must conform to the
parent database's property schema.
If the parent is a page, the only valid property is `title`. The new page may
include page content, described as blocks in the `children` parameter.
"""
return self.parent.request(
path="pages",
method="POST",
body=pick(kwargs, "parent", "properties", "children"),
auth=kwargs.get("auth"),
)
def retrieve(self, page_id: str, **kwargs: Any) -> SyncAsync[Any]:
"""Retrieve a Page object using the ID specified."""
return self.parent.request(
path=f"pages/{page_id}", method="GET", auth=kwargs.get("auth")
)
def update(self, page_id: str, **kwargs: Any) -> SyncAsync[Any]:
"""Update page property values for the specified page.
Properties that are not set via the `properties` parameter will remain
unchanged. If the parent is a database, the new property values in the
`properties` parameter must conform to the parent database's property schema.
"""
return self.parent.request(
path=f"pages/{page_id}",
method="PATCH",
body=pick(kwargs, "archived", "properties"),
auth=kwargs.get("auth"),
)
class UsersEndpoint(Endpoint):
def list(self, **kwargs: Any) -> SyncAsync[Any]:
"""Return a paginated list of Users for the workspace."""
return self.parent.request(
path="users",
method="GET",
query=pick(kwargs, "start_cursor", "page_size"),
auth=kwargs.get("auth"),
)
def retrieve(self, user_id: str, **kwargs: Any) -> SyncAsync[Any]:
"""Retrieve a User using the ID specified."""
return self.parent.request(
path=f"users/{user_id}", method="GET", auth=kwargs.get("auth")
)
class SearchEndpoint(Endpoint):
def __call__(self, **kwargs: Any) -> SyncAsync[Any]:
"""Search all pages and child pages that are shared with the integration.
The results may include databases. The `query` parameter matches against the page
titles. If the `query` parameter is not provided, the response will contain all
pages (and child pages) in the results.
The `filter` parameter can be used to query specifically for only pages or only
databases.
"""
return self.parent.request(
path="search",
method="POST",
body=pick(kwargs, "query", "sort", "filter", "start_cursor", "page_size"),
auth=kwargs.get("auth"),
)