@notionhq/client 5.14.0 → 5.16.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (75) hide show
  1. package/README.md +45 -9
  2. package/build/package.json +1 -1
  3. package/build/src/Client.d.ts +7 -1
  4. package/build/src/Client.d.ts.map +1 -1
  5. package/build/src/Client.js +21 -5
  6. package/build/src/Client.js.map +1 -1
  7. package/build/src/api-endpoints/blocks.d.ts +1010 -0
  8. package/build/src/api-endpoints/blocks.d.ts.map +1 -0
  9. package/build/src/api-endpoints/blocks.js +90 -0
  10. package/build/src/api-endpoints/blocks.js.map +1 -0
  11. package/build/src/api-endpoints/comments.d.ts +112 -0
  12. package/build/src/api-endpoints/comments.d.ts.map +1 -0
  13. package/build/src/api-endpoints/comments.js +42 -0
  14. package/build/src/api-endpoints/comments.js.map +1 -0
  15. package/build/src/api-endpoints/common.d.ts +1976 -0
  16. package/build/src/api-endpoints/common.d.ts.map +1 -0
  17. package/build/src/api-endpoints/common.js +5 -0
  18. package/build/src/api-endpoints/common.js.map +1 -0
  19. package/build/src/api-endpoints/custom-emojis.d.ts +26 -0
  20. package/build/src/api-endpoints/custom-emojis.d.ts.map +1 -0
  21. package/build/src/api-endpoints/custom-emojis.js +16 -0
  22. package/build/src/api-endpoints/custom-emojis.js.map +1 -0
  23. package/build/src/api-endpoints/data-sources.d.ts +430 -0
  24. package/build/src/api-endpoints/data-sources.d.ts.map +1 -0
  25. package/build/src/api-endpoints/data-sources.js +64 -0
  26. package/build/src/api-endpoints/data-sources.js.map +1 -0
  27. package/build/src/api-endpoints/databases.d.ts +109 -0
  28. package/build/src/api-endpoints/databases.d.ts.map +1 -0
  29. package/build/src/api-endpoints/databases.js +53 -0
  30. package/build/src/api-endpoints/databases.js.map +1 -0
  31. package/build/src/api-endpoints/file-uploads.d.ts +138 -0
  32. package/build/src/api-endpoints/file-uploads.d.ts.map +1 -0
  33. package/build/src/api-endpoints/file-uploads.js +63 -0
  34. package/build/src/api-endpoints/file-uploads.js.map +1 -0
  35. package/build/src/api-endpoints/oauth.d.ts +90 -0
  36. package/build/src/api-endpoints/oauth.d.ts.map +1 -0
  37. package/build/src/api-endpoints/oauth.js +42 -0
  38. package/build/src/api-endpoints/oauth.js.map +1 -0
  39. package/build/src/api-endpoints/pages.d.ts +639 -0
  40. package/build/src/api-endpoints/pages.d.ts.map +1 -0
  41. package/build/src/api-endpoints/pages.js +102 -0
  42. package/build/src/api-endpoints/pages.js.map +1 -0
  43. package/build/src/api-endpoints/search.d.ts +36 -0
  44. package/build/src/api-endpoints/search.d.ts.map +1 -0
  45. package/build/src/api-endpoints/search.js +16 -0
  46. package/build/src/api-endpoints/search.js.map +1 -0
  47. package/build/src/api-endpoints/users.d.ts +53 -0
  48. package/build/src/api-endpoints/users.d.ts.map +1 -0
  49. package/build/src/api-endpoints/users.js +36 -0
  50. package/build/src/api-endpoints/users.js.map +1 -0
  51. package/build/src/api-endpoints/views.d.ts +504 -0
  52. package/build/src/api-endpoints/views.d.ts.map +1 -0
  53. package/build/src/api-endpoints/views.js +86 -0
  54. package/build/src/api-endpoints/views.js.map +1 -0
  55. package/build/src/api-endpoints/webhooks.d.ts +302 -0
  56. package/build/src/api-endpoints/webhooks.d.ts.map +1 -0
  57. package/build/src/api-endpoints/webhooks.js +5 -0
  58. package/build/src/api-endpoints/webhooks.js.map +1 -0
  59. package/build/src/api-endpoints.d.ts +13 -4916
  60. package/build/src/api-endpoints.d.ts.map +1 -1
  61. package/build/src/api-endpoints.js +31 -533
  62. package/build/src/api-endpoints.js.map +1 -1
  63. package/build/src/constants.d.ts +32 -0
  64. package/build/src/constants.d.ts.map +1 -0
  65. package/build/src/constants.js +35 -0
  66. package/build/src/constants.js.map +1 -0
  67. package/build/src/errors.d.ts +2 -1
  68. package/build/src/errors.d.ts.map +1 -1
  69. package/build/src/errors.js +3 -0
  70. package/build/src/errors.js.map +1 -1
  71. package/build/src/index.d.ts +2 -1
  72. package/build/src/index.d.ts.map +1 -1
  73. package/build/src/index.js +8 -1
  74. package/build/src/index.js.map +1 -1
  75. package/package.json +1 -1
@@ -1,538 +1,36 @@
1
1
  "use strict";
2
2
  // cspell:disable-file
3
3
  // Note: This is a generated file. DO NOT EDIT!
4
- Object.defineProperty(exports, "__esModule", { value: true });
5
- exports.oauthIntrospect = exports.oauthRevoke = exports.oauthToken = exports.deleteViewQuery = exports.getViewQueryResults = exports.createViewQuery = exports.deleteView = exports.updateView = exports.getView = exports.createView = exports.listDatabaseViews = exports.getFileUpload = exports.completeFileUpload = exports.sendFileUpload = exports.listFileUploads = exports.createFileUpload = exports.getComment = exports.listComments = exports.createComment = exports.search = exports.createDatabase = exports.updateDatabase = exports.getDatabase = exports.listDataSourceTemplates = exports.createDataSource = exports.queryDataSource = exports.updateDataSource = exports.getDataSource = exports.appendBlockChildren = exports.listBlockChildren = exports.deleteBlock = exports.updateBlock = exports.getBlock = exports.updatePageMarkdown = exports.getPageMarkdown = exports.getPageProperty = exports.movePage = exports.updatePage = exports.getPage = exports.createPage = exports.listUsers = exports.getUser = exports.getSelf = void 0;
6
- /**
7
- * Retrieve your token's bot user
8
- */
9
- exports.getSelf = {
10
- method: "get",
11
- pathParams: [],
12
- queryParams: [],
13
- bodyParams: [],
14
- path: () => `users/me`,
15
- };
16
- /**
17
- * Retrieve a user
18
- */
19
- exports.getUser = {
20
- method: "get",
21
- pathParams: ["user_id"],
22
- queryParams: [],
23
- bodyParams: [],
24
- path: (p) => `users/${p.user_id}`,
25
- };
26
- /**
27
- * List all users
28
- */
29
- exports.listUsers = {
30
- method: "get",
31
- pathParams: [],
32
- queryParams: ["start_cursor", "page_size"],
33
- bodyParams: [],
34
- path: () => `users`,
35
- };
36
- /**
37
- * Create a page
38
- */
39
- exports.createPage = {
40
- method: "post",
41
- pathParams: [],
42
- queryParams: [],
43
- bodyParams: [
44
- "parent",
45
- "properties",
46
- "icon",
47
- "cover",
48
- "content",
49
- "children",
50
- "markdown",
51
- "template",
52
- "position",
53
- ],
54
- path: () => `pages`,
55
- };
56
- /**
57
- * Retrieve a page
58
- */
59
- exports.getPage = {
60
- method: "get",
61
- pathParams: ["page_id"],
62
- queryParams: ["filter_properties"],
63
- bodyParams: [],
64
- path: (p) => `pages/${p.page_id}`,
65
- };
66
- /**
67
- * Update page
68
- */
69
- exports.updatePage = {
70
- method: "patch",
71
- pathParams: ["page_id"],
72
- queryParams: [],
73
- bodyParams: [
74
- "archived",
75
- "properties",
76
- "icon",
77
- "cover",
78
- "is_locked",
79
- "template",
80
- "erase_content",
81
- "in_trash",
82
- "is_archived",
83
- ],
84
- path: (p) => `pages/${p.page_id}`,
85
- };
86
- /**
87
- * Move a page
88
- */
89
- exports.movePage = {
90
- method: "post",
91
- pathParams: ["page_id"],
92
- queryParams: [],
93
- bodyParams: ["parent"],
94
- path: (p) => `pages/${p.page_id}/move`,
95
- };
96
- /**
97
- * Retrieve a page property item
98
- */
99
- exports.getPageProperty = {
100
- method: "get",
101
- pathParams: ["page_id", "property_id"],
102
- queryParams: ["start_cursor", "page_size"],
103
- bodyParams: [],
104
- path: (p) => `pages/${p.page_id}/properties/${p.property_id}`,
105
- };
106
- /**
107
- * Retrieve a page as markdown
108
- */
109
- exports.getPageMarkdown = {
110
- method: "get",
111
- pathParams: ["page_id"],
112
- queryParams: ["include_transcript"],
113
- bodyParams: [],
114
- path: (p) => `pages/${p.page_id}/markdown`,
115
- };
116
- /**
117
- * Update a page's content as markdown
118
- */
119
- exports.updatePageMarkdown = {
120
- method: "patch",
121
- pathParams: ["page_id"],
122
- queryParams: [],
123
- bodyParams: [
124
- "type",
125
- "insert_content",
126
- "replace_content_range",
127
- "update_content",
128
- "replace_content",
129
- ],
130
- path: (p) => `pages/${p.page_id}/markdown`,
131
- };
132
- /**
133
- * Retrieve a block
134
- */
135
- exports.getBlock = {
136
- method: "get",
137
- pathParams: ["block_id"],
138
- queryParams: [],
139
- bodyParams: [],
140
- path: (p) => `blocks/${p.block_id}`,
141
- };
142
- /**
143
- * Update a block
144
- */
145
- exports.updateBlock = {
146
- method: "patch",
147
- pathParams: ["block_id"],
148
- queryParams: [],
149
- bodyParams: [
150
- "archived",
151
- "embed",
152
- "type",
153
- "in_trash",
154
- "bookmark",
155
- "image",
156
- "video",
157
- "pdf",
158
- "file",
159
- "audio",
160
- "code",
161
- "equation",
162
- "divider",
163
- "breadcrumb",
164
- "table_of_contents",
165
- "link_to_page",
166
- "table_row",
167
- "heading_1",
168
- "heading_2",
169
- "heading_3",
170
- "paragraph",
171
- "bulleted_list_item",
172
- "numbered_list_item",
173
- "quote",
174
- "to_do",
175
- "toggle",
176
- "template",
177
- "callout",
178
- "synced_block",
179
- "table",
180
- "column",
181
- ],
182
- path: (p) => `blocks/${p.block_id}`,
183
- };
184
- /**
185
- * Delete a block
186
- */
187
- exports.deleteBlock = {
188
- method: "delete",
189
- pathParams: ["block_id"],
190
- queryParams: [],
191
- bodyParams: [],
192
- path: (p) => `blocks/${p.block_id}`,
193
- };
194
- /**
195
- * Retrieve block children
196
- */
197
- exports.listBlockChildren = {
198
- method: "get",
199
- pathParams: ["block_id"],
200
- queryParams: ["start_cursor", "page_size"],
201
- bodyParams: [],
202
- path: (p) => `blocks/${p.block_id}/children`,
203
- };
204
- /**
205
- * Append block children
206
- */
207
- exports.appendBlockChildren = {
208
- method: "patch",
209
- pathParams: ["block_id"],
210
- queryParams: [],
211
- bodyParams: ["after", "children", "position"],
212
- path: (p) => `blocks/${p.block_id}/children`,
213
- };
214
- /**
215
- * Retrieve a data source
216
- */
217
- exports.getDataSource = {
218
- method: "get",
219
- pathParams: ["data_source_id"],
220
- queryParams: [],
221
- bodyParams: [],
222
- path: (p) => `data_sources/${p.data_source_id}`,
223
- };
224
- /**
225
- * Update a data source
226
- */
227
- exports.updateDataSource = {
228
- method: "patch",
229
- pathParams: ["data_source_id"],
230
- queryParams: [],
231
- bodyParams: ["archived", "title", "icon", "properties", "in_trash", "parent"],
232
- path: (p) => `data_sources/${p.data_source_id}`,
233
- };
234
- /**
235
- * Query a data source
236
- */
237
- exports.queryDataSource = {
238
- method: "post",
239
- pathParams: ["data_source_id"],
240
- queryParams: ["filter_properties"],
241
- bodyParams: [
242
- "archived",
243
- "sorts",
244
- "filter",
245
- "start_cursor",
246
- "page_size",
247
- "in_trash",
248
- "result_type",
249
- ],
250
- path: (p) => `data_sources/${p.data_source_id}/query`,
251
- };
252
- /**
253
- * Create a data source
254
- */
255
- exports.createDataSource = {
256
- method: "post",
257
- pathParams: [],
258
- queryParams: [],
259
- bodyParams: ["parent", "properties", "title", "icon"],
260
- path: () => `data_sources`,
261
- };
262
- /**
263
- * List templates in a data source
264
- */
265
- exports.listDataSourceTemplates = {
266
- method: "get",
267
- pathParams: ["data_source_id"],
268
- queryParams: ["name", "start_cursor", "page_size"],
269
- bodyParams: [],
270
- path: (p) => `data_sources/${p.data_source_id}/templates`,
271
- };
272
- /**
273
- * Retrieve a database
274
- */
275
- exports.getDatabase = {
276
- method: "get",
277
- pathParams: ["database_id"],
278
- queryParams: [],
279
- bodyParams: [],
280
- path: (p) => `databases/${p.database_id}`,
281
- };
282
- /**
283
- * Update a database
284
- */
285
- exports.updateDatabase = {
286
- method: "patch",
287
- pathParams: ["database_id"],
288
- queryParams: [],
289
- bodyParams: [
290
- "parent",
291
- "title",
292
- "description",
293
- "is_inline",
294
- "icon",
295
- "cover",
296
- "in_trash",
297
- "is_locked",
298
- ],
299
- path: (p) => `databases/${p.database_id}`,
300
- };
301
- /**
302
- * Create a database
303
- */
304
- exports.createDatabase = {
305
- method: "post",
306
- pathParams: [],
307
- queryParams: [],
308
- bodyParams: [
309
- "parent",
310
- "title",
311
- "description",
312
- "is_inline",
313
- "initial_data_source",
314
- "icon",
315
- "cover",
316
- ],
317
- path: () => `databases`,
318
- };
319
- /**
320
- * Search by title
321
- */
322
- exports.search = {
323
- method: "post",
324
- pathParams: [],
325
- queryParams: [],
326
- bodyParams: ["sort", "query", "start_cursor", "page_size", "filter"],
327
- path: () => `search`,
328
- };
329
- /**
330
- * Create a comment
331
- */
332
- exports.createComment = {
333
- method: "post",
334
- pathParams: [],
335
- queryParams: [],
336
- bodyParams: [
337
- "rich_text",
338
- "attachments",
339
- "display_name",
340
- "parent",
341
- "discussion_id",
342
- ],
343
- path: () => `comments`,
344
- };
345
- /**
346
- * List comments
347
- */
348
- exports.listComments = {
349
- method: "get",
350
- pathParams: [],
351
- queryParams: ["block_id", "start_cursor", "page_size"],
352
- bodyParams: [],
353
- path: () => `comments`,
354
- };
355
- /**
356
- * Retrieve a comment
357
- */
358
- exports.getComment = {
359
- method: "get",
360
- pathParams: ["comment_id"],
361
- queryParams: [],
362
- bodyParams: [],
363
- path: (p) => `comments/${p.comment_id}`,
364
- };
365
- /**
366
- * Create a file upload
367
- */
368
- exports.createFileUpload = {
369
- method: "post",
370
- pathParams: [],
371
- queryParams: [],
372
- bodyParams: [
373
- "mode",
374
- "filename",
375
- "content_type",
376
- "number_of_parts",
377
- "external_url",
378
- ],
379
- path: () => `file_uploads`,
380
- };
381
- /**
382
- * List file uploads
383
- */
384
- exports.listFileUploads = {
385
- method: "get",
386
- pathParams: [],
387
- queryParams: ["status", "start_cursor", "page_size"],
388
- bodyParams: [],
389
- path: () => `file_uploads`,
390
- };
391
- /**
392
- * Upload a file
393
- */
394
- exports.sendFileUpload = {
395
- method: "post",
396
- pathParams: ["file_upload_id"],
397
- queryParams: [],
398
- bodyParams: [],
399
- formDataParams: ["file", "part_number"],
400
- path: (p) => `file_uploads/${p.file_upload_id}/send`,
401
- };
402
- /**
403
- * Complete a multi-part file upload
404
- */
405
- exports.completeFileUpload = {
406
- method: "post",
407
- pathParams: ["file_upload_id"],
408
- queryParams: [],
409
- bodyParams: [],
410
- path: (p) => `file_uploads/${p.file_upload_id}/complete`,
411
- };
412
- /**
413
- * Retrieve a file upload
414
- */
415
- exports.getFileUpload = {
416
- method: "get",
417
- pathParams: ["file_upload_id"],
418
- queryParams: [],
419
- bodyParams: [],
420
- path: (p) => `file_uploads/${p.file_upload_id}`,
421
- };
422
- /**
423
- * List views
424
- */
425
- exports.listDatabaseViews = {
426
- method: "get",
427
- pathParams: [],
428
- queryParams: ["database_id", "data_source_id", "start_cursor", "page_size"],
429
- bodyParams: [],
430
- path: () => `views`,
431
- };
432
- /**
433
- * Create a view
434
- */
435
- exports.createView = {
436
- method: "post",
437
- pathParams: [],
438
- queryParams: [],
439
- bodyParams: [],
440
- path: () => `views`,
441
- };
442
- /**
443
- * Retrieve a view
444
- */
445
- exports.getView = {
446
- method: "get",
447
- pathParams: ["view_id"],
448
- queryParams: [],
449
- bodyParams: [],
450
- path: (p) => `views/${p.view_id}`,
451
- };
452
- /**
453
- * Update a view
454
- */
455
- exports.updateView = {
456
- method: "patch",
457
- pathParams: ["view_id"],
458
- queryParams: [],
459
- bodyParams: [],
460
- path: (p) => `views/${p.view_id}`,
461
- };
462
- /**
463
- * Delete a view
464
- */
465
- exports.deleteView = {
466
- method: "delete",
467
- pathParams: ["view_id"],
468
- queryParams: [],
469
- bodyParams: [],
470
- path: (p) => `views/${p.view_id}`,
471
- };
472
- /**
473
- * Create a view query
474
- */
475
- exports.createViewQuery = {
476
- method: "post",
477
- pathParams: ["view_id"],
478
- queryParams: [],
479
- bodyParams: [],
480
- path: (p) => `views/${p.view_id}/queries`,
481
- };
482
- /**
483
- * Get view query results
484
- */
485
- exports.getViewQueryResults = {
486
- method: "get",
487
- pathParams: ["view_id", "query_id"],
488
- queryParams: ["start_cursor", "page_size"],
489
- bodyParams: [],
490
- path: (p) => `views/${p.view_id}/queries/${p.query_id}`,
491
- };
492
- /**
493
- * Delete a view query
494
- */
495
- exports.deleteViewQuery = {
496
- method: "delete",
497
- pathParams: ["view_id", "query_id"],
498
- queryParams: [],
499
- bodyParams: [],
500
- path: (p) => `views/${p.view_id}/queries/${p.query_id}`,
501
- };
502
- /**
503
- * Exchange an authorization code for an access and refresh token
504
- */
505
- exports.oauthToken = {
506
- method: "post",
507
- pathParams: [],
508
- queryParams: [],
509
- bodyParams: [
510
- "grant_type",
511
- "code",
512
- "redirect_uri",
513
- "external_account",
514
- "refresh_token",
515
- ],
516
- path: () => `oauth/token`,
517
- };
518
- /**
519
- * Revoke a token
520
- */
521
- exports.oauthRevoke = {
522
- method: "post",
523
- pathParams: [],
524
- queryParams: [],
525
- bodyParams: ["token"],
526
- path: () => `oauth/revoke`,
527
- };
528
- /**
529
- * Introspect a token
530
- */
531
- exports.oauthIntrospect = {
532
- method: "post",
533
- pathParams: [],
534
- queryParams: [],
535
- bodyParams: ["token"],
536
- path: () => `oauth/introspect`,
4
+ //
5
+ // This barrel re-exports all API types from per-resource modules.
6
+ // Import from this file for backwards compatibility, or import
7
+ // directly from the specific resource module.
8
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
9
+ if (k2 === undefined) k2 = k;
10
+ var desc = Object.getOwnPropertyDescriptor(m, k);
11
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
12
+ desc = { enumerable: true, get: function() { return m[k]; } };
13
+ }
14
+ Object.defineProperty(o, k2, desc);
15
+ }) : (function(o, m, k, k2) {
16
+ if (k2 === undefined) k2 = k;
17
+ o[k2] = m[k];
18
+ }));
19
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
20
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
537
21
  };
22
+ Object.defineProperty(exports, "__esModule", { value: true });
23
+ __exportStar(require("./api-endpoints/blocks"), exports);
24
+ __exportStar(require("./api-endpoints/comments"), exports);
25
+ __exportStar(require("./api-endpoints/common"), exports);
26
+ __exportStar(require("./api-endpoints/custom-emojis"), exports);
27
+ __exportStar(require("./api-endpoints/data-sources"), exports);
28
+ __exportStar(require("./api-endpoints/databases"), exports);
29
+ __exportStar(require("./api-endpoints/file-uploads"), exports);
30
+ __exportStar(require("./api-endpoints/oauth"), exports);
31
+ __exportStar(require("./api-endpoints/pages"), exports);
32
+ __exportStar(require("./api-endpoints/search"), exports);
33
+ __exportStar(require("./api-endpoints/users"), exports);
34
+ __exportStar(require("./api-endpoints/views"), exports);
35
+ __exportStar(require("./api-endpoints/webhooks"), exports);
538
36
  //# sourceMappingURL=api-endpoints.js.map