@notionhq/client
Version:
A simple and easy to use client for the Notion API
237 lines • 9.7 kB
TypeScript
import type { Agent } from "node:http";
import { type Logger, LogLevel } from "./logging";
import { type GetBlockParameters, type GetBlockResponse, type UpdateBlockParameters, type UpdateBlockResponse, type DeleteBlockParameters, type DeleteBlockResponse, type AppendBlockChildrenParameters, type AppendBlockChildrenResponse, type ListBlockChildrenParameters, type ListBlockChildrenResponse, type QueryDataSourceParameters, type QueryDataSourceResponse, type CreateDataSourceParameters, type CreateDataSourceResponse, type UpdateDataSourceParameters, type UpdateDataSourceResponse, type GetDataSourceParameters, type GetDataSourceResponse, type CreatePageParameters, type CreatePageResponse, type GetPageParameters, type GetPageResponse, type UpdatePageParameters, type UpdatePageResponse, type GetUserParameters, type GetUserResponse, type ListUsersParameters, type ListUsersResponse, type SearchParameters, type SearchResponse, type GetSelfParameters, type GetSelfResponse, type GetPagePropertyParameters, type GetPagePropertyResponse, type CreateCommentParameters, type CreateCommentResponse, type ListCommentsParameters, type ListCommentsResponse, type GetCommentParameters, type GetCommentResponse, type OauthTokenResponse, type OauthTokenParameters, type OauthIntrospectResponse, type OauthIntrospectParameters, type OauthRevokeResponse, type OauthRevokeParameters, type CreateFileUploadParameters, type CreateFileUploadResponse, type GetFileUploadResponse, type GetFileUploadParameters, type SendFileUploadParameters, type SendFileUploadResponse, type CompleteFileUploadParameters, type CompleteFileUploadResponse, type ListFileUploadsParameters, type ListFileUploadsResponse, GetDatabaseParameters, GetDatabaseResponse, CreateDatabaseResponse, CreateDatabaseParameters, UpdateDatabaseParameters, UpdateDatabaseResponse, ListDataSourceTemplatesResponse, ListDataSourceTemplatesParameters } from "./api-endpoints";
import type { SupportedFetch } from "./fetch-types";
export interface ClientOptions {
auth?: string;
timeoutMs?: number;
baseUrl?: string;
logLevel?: LogLevel;
logger?: Logger;
notionVersion?: string;
fetch?: SupportedFetch;
/** Silently ignored in the browser */
agent?: Agent;
}
type FileParam = {
filename?: string;
data: string | Blob;
};
export interface RequestParameters {
path: string;
method: Method;
query?: QueryParams;
body?: Record<string, unknown>;
formDataParams?: Record<string, string | FileParam>;
headers?: Record<string, string>;
/**
* To authenticate using public API token, `auth` should be passed as a
* string. If you are trying to complete OAuth, then `auth` should be an object
* containing your integration's client ID and secret.
*/
auth?: string | {
client_id: string;
client_secret: string;
};
}
export default class Client {
#private;
static readonly defaultNotionVersion = "2025-09-03";
constructor(options?: ClientOptions);
/**
* Sends a request.
*/
request<ResponseBody extends object>(args: RequestParameters): Promise<ResponseBody>;
readonly blocks: {
/**
* Retrieve block
*/
retrieve: (args: WithAuth<GetBlockParameters>) => Promise<GetBlockResponse>;
/**
* Update block
*/
update: (args: WithAuth<UpdateBlockParameters>) => Promise<UpdateBlockResponse>;
/**
* Delete block
*/
delete: (args: WithAuth<DeleteBlockParameters>) => Promise<DeleteBlockResponse>;
children: {
/**
* Append block children
*/
append: (args: WithAuth<AppendBlockChildrenParameters>) => Promise<AppendBlockChildrenResponse>;
/**
* Retrieve block children
*/
list: (args: WithAuth<ListBlockChildrenParameters>) => Promise<ListBlockChildrenResponse>;
};
};
readonly databases: {
/**
* Retrieve a database
*/
retrieve: (args: WithAuth<GetDatabaseParameters>) => Promise<GetDatabaseResponse>;
/**
* Create a database
*/
create: (args: WithAuth<CreateDatabaseParameters>) => Promise<CreateDatabaseResponse>;
/**
* Update a database
*/
update: (args: WithAuth<UpdateDatabaseParameters>) => Promise<UpdateDatabaseResponse>;
};
readonly dataSources: {
/**
* Retrieve a data source
*/
retrieve: (args: WithAuth<GetDataSourceParameters>) => Promise<GetDataSourceResponse>;
/**
* Query a data source
*/
query: (args: WithAuth<QueryDataSourceParameters>) => Promise<QueryDataSourceResponse>;
/**
* Create a data source
*/
create: (args: WithAuth<CreateDataSourceParameters>) => Promise<CreateDataSourceResponse>;
/**
* Update a data source
*/
update: (args: WithAuth<UpdateDataSourceParameters>) => Promise<UpdateDataSourceResponse>;
/**
* List page templates that are available for a data source
*/
listTemplates: (args: WithAuth<ListDataSourceTemplatesParameters>) => Promise<ListDataSourceTemplatesResponse>;
};
readonly pages: {
/**
* Create a page
*/
create: (args: WithAuth<CreatePageParameters>) => Promise<CreatePageResponse>;
/**
* Retrieve a page
*/
retrieve: (args: WithAuth<GetPageParameters>) => Promise<GetPageResponse>;
/**
* Update page properties
*/
update: (args: WithAuth<UpdatePageParameters>) => Promise<UpdatePageResponse>;
properties: {
/**
* Retrieve page property
*/
retrieve: (args: WithAuth<GetPagePropertyParameters>) => Promise<GetPagePropertyResponse>;
};
};
readonly users: {
/**
* Retrieve a user
*/
retrieve: (args: WithAuth<GetUserParameters>) => Promise<GetUserResponse>;
/**
* List all users
*/
list: (args: WithAuth<ListUsersParameters>) => Promise<ListUsersResponse>;
/**
* Get details about bot
*/
me: (args: WithAuth<GetSelfParameters>) => Promise<GetSelfResponse>;
};
readonly comments: {
/**
* Create a comment
*/
create: (args: WithAuth<CreateCommentParameters>) => Promise<CreateCommentResponse>;
/**
* List comments
*/
list: (args: WithAuth<ListCommentsParameters>) => Promise<ListCommentsResponse>;
/**
* Retrieve a comment
*/
retrieve: (args: WithAuth<GetCommentParameters>) => Promise<GetCommentResponse>;
};
readonly fileUploads: {
/**
* Create a file upload
*/
create: (args: WithAuth<CreateFileUploadParameters>) => Promise<CreateFileUploadResponse>;
/**
* Retrieve a file upload
*/
retrieve: (args: WithAuth<GetFileUploadParameters>) => Promise<GetFileUploadResponse>;
/**
* List file uploads
*/
list: (args: WithAuth<ListFileUploadsParameters>) => Promise<ListFileUploadsResponse>;
/**
* Send a file upload
*
* Requires a `file_upload_id`, obtained from the `id` of the Create File
* Upload API response.
*
* The `file` parameter contains the raw file contents or Blob/File object
* under `file.data`, and an optional `file.filename` string.
*
* Supply a stringified `part_number` parameter when using file uploads
* in multi-part mode.
*
* This endpoint sends HTTP multipart/form-data instead of JSON parameters.
*/
send: (args: WithAuth<SendFileUploadParameters>) => Promise<SendFileUploadResponse>;
/**
* Complete a file upload
*/
complete: (args: WithAuth<CompleteFileUploadParameters>) => Promise<CompleteFileUploadResponse>;
};
/**
* Search
*/
search: (args: WithAuth<SearchParameters>) => Promise<SearchResponse>;
readonly oauth: {
/**
* Get token
*/
token: (args: OauthTokenParameters & {
client_id: string;
client_secret: string;
}) => Promise<OauthTokenResponse>;
/**
* Introspect token
*/
introspect: (args: OauthIntrospectParameters & {
client_id: string;
client_secret: string;
}) => Promise<OauthIntrospectResponse>;
/**
* Revoke token
*/
revoke: (args: OauthRevokeParameters & {
client_id: string;
client_secret: string;
}) => Promise<OauthRevokeResponse>;
};
/**
* Emits a log message to the console.
*
* @param level The level for this message
* @param args Arguments to send to the console
*/
private log;
/**
* Transforms an API key or access token into a headers object suitable for an HTTP request.
*
* This method uses the instance's value as the default when the input is undefined. If neither are defined, it returns
* an empty object
*
* @param auth API key or access token
* @returns headers key-value object
*/
private authAsHeaders;
}
type Method = "get" | "post" | "patch" | "delete";
type QueryParams = Record<string, string | number | string[]> | URLSearchParams;
type WithAuth<P> = P & {
auth?: string;
};
export {};
//# sourceMappingURL=Client.d.ts.map