@notionhq/client 3.1.2 → 3.1.3

package/build/src/api-endpoints.js

@@ -3,6 +3,9 @@
 // Note: This is a generated file. DO NOT EDIT!
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.oauthIntrospect = exports.oauthRevoke = exports.oauthToken = exports.getFileUpload = exports.completeFileUpload = exports.sendFileUpload = exports.listFileUploads = exports.createFileUpload = exports.listComments = exports.createComment = exports.search = exports.createDatabase = exports.listDatabases = exports.queryDatabase = exports.updateDatabase = exports.getDatabase = exports.appendBlockChildren = exports.listBlockChildren = exports.deleteBlock = exports.updateBlock = exports.getBlock = exports.getPageProperty = exports.updatePage = exports.getPage = exports.createPage = exports.listUsers = exports.getUser = exports.getSelf = void 0;
+/**
+ * Retrieve your token's bot user
+ */
 exports.getSelf = {
     method: "get",
     pathParams: [],
@@ -10,6 +13,9 @@ exports.getSelf = {
     bodyParams: [],
     path: () => `users/me`,
 };
+/**
+ * Retrieve a user
+ */
 exports.getUser = {
     method: "get",
     pathParams: ["user_id"],
@@ -17,6 +23,9 @@ exports.getUser = {
     bodyParams: [],
     path: (p) => `users/${p.user_id}`,
 };
+/**
+ * List all users
+ */
 exports.listUsers = {
     method: "get",
     pathParams: [],
@@ -24,6 +33,9 @@ exports.listUsers = {
     bodyParams: [],
     path: () => `users`,
 };
+/**
+ * Create a page
+ */
 exports.createPage = {
     method: "post",
     pathParams: [],
@@ -31,6 +43,9 @@ exports.createPage = {
     bodyParams: ["parent", "properties", "icon", "cover", "content", "children"],
     path: () => `pages`,
 };
+/**
+ * Retrieve a page
+ */
 exports.getPage = {
     method: "get",
     pathParams: ["page_id"],
@@ -38,6 +53,9 @@ exports.getPage = {
     bodyParams: [],
     path: (p) => `pages/${p.page_id}`,
 };
+/**
+ * Update page properties
+ */
 exports.updatePage = {
     method: "patch",
     pathParams: ["page_id"],
@@ -45,6 +63,9 @@ exports.updatePage = {
     bodyParams: ["properties", "icon", "cover", "archived", "in_trash"],
     path: (p) => `pages/${p.page_id}`,
 };
+/**
+ * Retrieve a page property item
+ */
 exports.getPageProperty = {
     method: "get",
     pathParams: ["page_id", "property_id"],
@@ -52,6 +73,9 @@ exports.getPageProperty = {
     bodyParams: [],
     path: (p) => `pages/${p.page_id}/properties/${p.property_id}`,
 };
+/**
+ * Retrieve a block
+ */
 exports.getBlock = {
     method: "get",
     pathParams: ["block_id"],
@@ -59,6 +83,9 @@ exports.getBlock = {
     bodyParams: [],
     path: (p) => `blocks/${p.block_id}`,
 };
+/**
+ * Update a block
+ */
 exports.updateBlock = {
     method: "patch",
     pathParams: ["block_id"],
@@ -98,6 +125,9 @@ exports.updateBlock = {
     ],
     path: (p) => `blocks/${p.block_id}`,
 };
+/**
+ * Delete a block
+ */
 exports.deleteBlock = {
     method: "delete",
     pathParams: ["block_id"],
@@ -105,6 +135,9 @@ exports.deleteBlock = {
     bodyParams: [],
     path: (p) => `blocks/${p.block_id}`,
 };
+/**
+ * Retrieve block children
+ */
 exports.listBlockChildren = {
     method: "get",
     pathParams: ["block_id"],
@@ -112,6 +145,9 @@ exports.listBlockChildren = {
     bodyParams: [],
     path: (p) => `blocks/${p.block_id}/children`,
 };
+/**
+ * Append block children
+ */
 exports.appendBlockChildren = {
     method: "patch",
     pathParams: ["block_id"],
@@ -119,6 +155,9 @@ exports.appendBlockChildren = {
     bodyParams: ["children", "after"],
     path: (p) => `blocks/${p.block_id}/children`,
 };
+/**
+ * Retrieve a database
+ */
 exports.getDatabase = {
     method: "get",
     pathParams: ["database_id"],
@@ -126,6 +165,9 @@ exports.getDatabase = {
     bodyParams: [],
     path: (p) => `databases/${p.database_id}`,
 };
+/**
+ * Update a database
+ */
 exports.updateDatabase = {
     method: "patch",
     pathParams: ["database_id"],
@@ -142,6 +184,9 @@ exports.updateDatabase = {
     ],
     path: (p) => `databases/${p.database_id}`,
 };
+/**
+ * Query a database
+ */
 exports.queryDatabase = {
     method: "post",
     pathParams: ["database_id"],
@@ -156,6 +201,9 @@ exports.queryDatabase = {
     ],
     path: (p) => `databases/${p.database_id}/query`,
 };
+/**
+ * List databases
+ */
 exports.listDatabases = {
     method: "get",
     pathParams: [],
@@ -163,6 +211,9 @@ exports.listDatabases = {
     bodyParams: [],
     path: () => `databases`,
 };
+/**
+ * Create a database
+ */
 exports.createDatabase = {
     method: "post",
     pathParams: [],
@@ -178,6 +229,9 @@ exports.createDatabase = {
     ],
     path: () => `databases`,
 };
+/**
+ * Search by title
+ */
 exports.search = {
     method: "post",
     pathParams: [],
@@ -185,6 +239,9 @@ exports.search = {
     bodyParams: ["sort", "query", "start_cursor", "page_size", "filter"],
     path: () => `search`,
 };
+/**
+ * Create comment
+ */
 exports.createComment = {
     method: "post",
     pathParams: [],
@@ -192,6 +249,9 @@ exports.createComment = {
     bodyParams: ["parent", "rich_text", "discussion_id"],
     path: () => `comments`,
 };
+/**
+ * List comments
+ */
 exports.listComments = {
     method: "get",
     pathParams: [],
@@ -199,6 +259,9 @@ exports.listComments = {
     bodyParams: [],
     path: () => `comments`,
 };
+/**
+ * Create a file upload
+ */
 exports.createFileUpload = {
     method: "post",
     pathParams: [],
@@ -212,6 +275,9 @@ exports.createFileUpload = {
     ],
     path: () => `file_uploads`,
 };
+/**
+ * List file uploads
+ */
 exports.listFileUploads = {
     method: "get",
     pathParams: [],
@@ -219,6 +285,9 @@ exports.listFileUploads = {
     bodyParams: [],
     path: () => `file_uploads`,
 };
+/**
+ * Upload a file
+ */
 exports.sendFileUpload = {
     method: "post",
     pathParams: ["file_upload_id"],
@@ -227,6 +296,9 @@ exports.sendFileUpload = {
     formDataParams: ["file", "part_number"],
     path: (p) => `file_uploads/${p.file_upload_id}/send`,
 };
+/**
+ * Complete a multi-part file upload
+ */
 exports.completeFileUpload = {
     method: "post",
     pathParams: ["file_upload_id"],
@@ -234,6 +306,9 @@ exports.completeFileUpload = {
     bodyParams: [],
     path: (p) => `file_uploads/${p.file_upload_id}/complete`,
 };
+/**
+ * Retrieve a file upload
+ */
 exports.getFileUpload = {
     method: "get",
     pathParams: ["file_upload_id"],
@@ -241,6 +316,9 @@ exports.getFileUpload = {
     bodyParams: [],
     path: (p) => `file_uploads/${p.file_upload_id}`,
 };
+/**
+ * Exchange an authorization code for an access token
+ */
 exports.oauthToken = {
     method: "post",
     pathParams: [],
@@ -248,6 +326,9 @@ exports.oauthToken = {
     bodyParams: ["grant_type", "code", "redirect_uri", "external_account"],
     path: () => `oauth/token`,
 };
+/**
+ * Revoke a token
+ */
 exports.oauthRevoke = {
     method: "post",
     pathParams: [],
@@ -255,6 +336,9 @@ exports.oauthRevoke = {
     bodyParams: ["token"],
     path: () => `oauth/revoke`,
 };
+/**
+ * Introspect a token
+ */
 exports.oauthIntrospect = {
     method: "post",
     pathParams: [],