-
-
Notifications
You must be signed in to change notification settings - Fork 139
/
api_endpoints.py
269 lines (218 loc) · 10.2 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
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
"""Notion API endpoints.""" # noqa: E501
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.
*[🔗 Endpoint documentation](https://developers.notion.com/reference/patch-block-children)*
""" # noqa: E501
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](https://developers.notion.com/reference/block) contained in the block.
*[🔗 Endpoint documentation](https://developers.notion.com/reference/get-block-children)*
""" # noqa: E501
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](https://developers.notion.com/reference/block) using the ID specified.
*[🔗 Endpoint documentation](https://developers.notion.com/reference/retrieve-a-block)*
""" # noqa: E501
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.
*[🔗 Endpoint documentation](https://developers.notion.com/reference/update-a-block)*
""" # noqa: E501
return self.parent.request(
path=f"blocks/{block_id}",
method="PATCH",
body=pick(
kwargs,
"embed",
"type",
"archived",
"bookmark",
"image",
"video",
"pdf",
"file",
"audio",
"code",
"equation",
"divider",
"breadcrumb",
"table_of_contents",
"link_to_page",
"table_row",
"heading_1",
"heading_2",
"heading_3",
"paragraph",
"bulleted_list_item",
"numbered_list_item",
"quote",
"to_do",
"toggle",
"template",
"callout",
"synced_block",
"table",
),
auth=kwargs.get("auth"),
)
def delete(self, block_id: str, **kwargs: Any) -> SyncAsync[Any]:
"""Set a [Block object](https://developers.notion.com/reference/block), including page blocks, to `archived: true`.
*[🔗 Endpoint documentation](https://developers.notion.com/reference/delete-a-block)*
""" # noqa: E501
return self.parent.request(
path=f"blocks/{block_id}",
method="DELETE",
auth=kwargs.get("auth"),
)
class DatabasesEndpoint(Endpoint):
def list(self, **kwargs: Any) -> SyncAsync[Any]:
"""List all [Databases](https://developers.notion.com/reference/database) shared with the authenticated integration.
> ⚠️ **Deprecated endpoint**
*[🔗 Endpoint documentation](https://developers.notion.com/reference/get-databases)*
""" # noqa: E501
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](https://developers.notion.com/reference/page) contained in the database.
*[🔗 Endpoint documentation](https://developers.notion.com/reference/post-database-query)*
""" # noqa: E501
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](https://developers.notion.com/reference/database) using the ID specified.
*[🔗 Endpoint documentation](https://developers.notion.com/reference/post-database-query)*
""" # noqa: E501
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.
*[🔗 Endpoint documentation](https://developers.notion.com/reference/create-a-database)*
""" # noqa: E501
return self.parent.request(
path="databases",
method="POST",
body=pick(kwargs, "parent", "title", "properties", "icon", "cover"),
auth=kwargs.get("auth"),
)
def update(self, database_id: str, **kwargs: Any) -> SyncAsync[Any]:
"""Update an existing database as specified by the parameters.
*[🔗 Endpoint documentation](https://developers.notion.com/reference/update-a-database)*
""" # noqa: E501
return self.parent.request(
path=f"databases/{database_id}",
method="PATCH",
body=pick(kwargs, "properties", "title", "icon", "cover"),
auth=kwargs.get("auth"),
)
class PagesPropertiesEndpoint(Endpoint):
def retrieve(self, page_id: str, property_id: str, **kwargs: Any) -> SyncAsync[Any]:
"""Retrieve a `property_item` object for a given `page_id` and `property_id`.
*[🔗 Endpoint documentation](https://developers.notion.com/reference/retrieve-a-page-property)*
""" # noqa: E501
return self.parent.request(
path=f"pages/{page_id}/properties/{property_id}",
method="GET",
auth=kwargs.get("auth"),
query=pick(kwargs, "start_cursor", "page_size"),
)
class PagesEndpoint(Endpoint):
def __init__(self, *args: Any, **kwargs: Any) -> None:
super().__init__(*args, **kwargs)
self.properties = PagesPropertiesEndpoint(*args, **kwargs)
def create(self, **kwargs: Any) -> SyncAsync[Any]:
"""Create a new page in the specified database or as a child of an existing page.
*[🔗 Endpoint documentation](https://developers.notion.com/reference/post-page)*
""" # noqa: E501
return self.parent.request(
path="pages",
method="POST",
body=pick(kwargs, "parent", "properties", "children", "icon", "cover"),
auth=kwargs.get("auth"),
)
def retrieve(self, page_id: str, **kwargs: Any) -> SyncAsync[Any]:
"""Retrieve a [Page object](https://developers.notion.com/reference/page) using the ID specified.
*[🔗 Endpoint documentation](https://developers.notion.com/reference/retrieve-a-page)*
""" # noqa: E501
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](https://developers.notion.com/reference/page#property-value-object) for the specified page.
*[🔗 Endpoint documentation](https://developers.notion.com/reference/patch-page)*
""" # noqa: E501
return self.parent.request(
path=f"pages/{page_id}",
method="PATCH",
body=pick(kwargs, "archived", "properties", "icon", "cover"),
auth=kwargs.get("auth"),
)
class UsersEndpoint(Endpoint):
def list(self, **kwargs: Any) -> SyncAsync[Any]:
"""Return a paginated list of [Users](https://developers.notion.com/reference/user) for the workspace.
*[🔗 Endpoint documentation](https://developers.notion.com/reference/get-users)*
""" # noqa: E501
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](https://developers.notion.com/reference/user) using the ID specified.
*[🔗 Endpoint documentation](https://developers.notion.com/reference/get-user)*
""" # noqa: E501
return self.parent.request(
path=f"users/{user_id}", method="GET", auth=kwargs.get("auth")
)
def me(self, **kwargs: Any) -> SyncAsync[Any]:
"""Retrieve the bot [User](https://developers.notion.com/reference/user) associated with the API token.
*[🔗 Endpoint documentation](https://developers.notion.com/reference/get-self)*
""" # noqa: E501
return self.parent.request(
path="users/me", 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.
*[🔗 Endpoint documentation](https://developers.notion.com/reference/post-search)*
""" # noqa: E501
return self.parent.request(
path="search",
method="POST",
body=pick(kwargs, "query", "sort", "filter", "start_cursor", "page_size"),
auth=kwargs.get("auth"),
)