@notionhq/client 5.14.0 → 5.16.0

package/build/src/api-endpoints/data-sources.d.ts

@@ -0,0 +1,430 @@
+import type { DataSourceParentResponse, DatabaseParentResponse, EmptyObject, GroupFilterOperatorArray, IdRequest, IdResponse, NumberFormat, PageCoverResponse, PageIconRequest, PageIconResponse, PageObjectResponse, ParentOfDataSourceRequest, ParentOfDatabaseResponse, PartialPageObjectResponse, PartialUserObjectResponse, PropertyConfigurationRequest, PropertyDescriptionRequest, PropertyFilter, RichTextItemRequest, RichTextItemResponse, RollupFunction, SelectColor, StatusPropertyConfigUpdateRequest, TimestampFilter } from "./common";
+type CheckboxDatabasePropertyConfigResponse = {
+    type: "checkbox";
+    checkbox: EmptyObject;
+};
+type CreatedByDatabasePropertyConfigResponse = {
+    type: "created_by";
+    created_by: EmptyObject;
+};
+type CreatedTimeDatabasePropertyConfigResponse = {
+    type: "created_time";
+    created_time: EmptyObject;
+};
+export type DataSourceObjectResponse = {
+    object: "data_source";
+    id: IdResponse;
+    title: Array<RichTextItemResponse>;
+    description: Array<RichTextItemResponse>;
+    parent: ParentOfDataSourceResponse;
+    database_parent: ParentOfDatabaseResponse;
+    is_inline: boolean;
+    in_trash: boolean;
+    /** @deprecated Use `in_trash` instead. Present for backwards compatibility with API versions prior to 2026-03-11. */
+    archived: boolean;
+    created_time: string;
+    last_edited_time: string;
+    created_by: PartialUserObjectResponse;
+    last_edited_by: PartialUserObjectResponse;
+    properties: Record<string, DatabasePropertyConfigResponse>;
+    icon: PageIconResponse | null;
+    cover: PageCoverResponse | null;
+    url: string;
+    public_url: string | null;
+};
+type DatabasePropertyConfigResponse = DatabasePropertyConfigResponseCommon & (NumberDatabasePropertyConfigResponse | FormulaDatabasePropertyConfigResponse | SelectDatabasePropertyConfigResponse | MultiSelectDatabasePropertyConfigResponse | StatusDatabasePropertyConfigResponse | RelationDatabasePropertyConfigResponse | RollupDatabasePropertyConfigResponse | UniqueIdDatabasePropertyConfigResponse | TitleDatabasePropertyConfigResponse | RichTextDatabasePropertyConfigResponse | UrlDatabasePropertyConfigResponse | PeopleDatabasePropertyConfigResponse | FilesDatabasePropertyConfigResponse | EmailDatabasePropertyConfigResponse | PhoneNumberDatabasePropertyConfigResponse | DateDatabasePropertyConfigResponse | CheckboxDatabasePropertyConfigResponse | CreatedByDatabasePropertyConfigResponse | CreatedTimeDatabasePropertyConfigResponse | LastEditedByDatabasePropertyConfigResponse | LastEditedTimeDatabasePropertyConfigResponse);
+type DatabasePropertyConfigResponseCommon = {
+    id: string;
+    name: string;
+    description: PropertyDescriptionRequest | null;
+};
+type DatabasePropertyRelationConfigResponse = DatabasePropertyRelationConfigResponseCommon & (SinglePropertyDatabasePropertyRelationConfigResponse | DualPropertyDatabasePropertyRelationConfigResponse);
+type DatabasePropertyRelationConfigResponseCommon = {
+    database_id: IdResponse;
+    data_source_id: IdResponse;
+};
+type DateDatabasePropertyConfigResponse = {
+    type: "date";
+    date: EmptyObject;
+};
+type DualPropertyDatabasePropertyRelationConfigResponse = {
+    type?: "dual_property";
+    dual_property: {
+        synced_property_id: string;
+        synced_property_name: string;
+    };
+};
+type EmailDatabasePropertyConfigResponse = {
+    type: "email";
+    email: EmptyObject;
+};
+type FilesDatabasePropertyConfigResponse = {
+    type: "files";
+    files: EmptyObject;
+};
+type FormulaDatabasePropertyConfigResponse = {
+    type: "formula";
+    formula: {
+        expression: string;
+    };
+};
+type LastEditedByDatabasePropertyConfigResponse = {
+    type: "last_edited_by";
+    last_edited_by: EmptyObject;
+};
+type LastEditedTimeDatabasePropertyConfigResponse = {
+    type: "last_edited_time";
+    last_edited_time: EmptyObject;
+};
+type MultiSelectDatabasePropertyConfigResponse = {
+    type: "multi_select";
+    multi_select: {
+        options: Array<SelectPropertyResponse>;
+    };
+};
+type NumberDatabasePropertyConfigResponse = {
+    type: "number";
+    number: {
+        format: NumberFormat;
+    };
+};
+/**
+ * The parent of the data source. This is typically a database (`database_id`), but for
+ * externally synced data sources, can be another data source (`data_source_id`).
+ */
+type ParentOfDataSourceResponse = DatabaseParentResponse | DataSourceParentResponse;
+export type PartialDataSourceObjectResponse = {
+    object: "data_source";
+    id: IdResponse;
+    properties: Record<string, DatabasePropertyConfigResponse>;
+};
+type PeopleDatabasePropertyConfigResponse = {
+    type: "people";
+    people: EmptyObject;
+};
+type PhoneNumberDatabasePropertyConfigResponse = {
+    type: "phone_number";
+    phone_number: EmptyObject;
+};
+type RelationDatabasePropertyConfigResponse = {
+    type: "relation";
+    relation: DatabasePropertyRelationConfigResponse;
+};
+type RichTextDatabasePropertyConfigResponse = {
+    type: "rich_text";
+    rich_text: EmptyObject;
+};
+type RollupDatabasePropertyConfigResponse = {
+    type: "rollup";
+    rollup: {
+        function: RollupFunction;
+        rollup_property_name: string;
+        relation_property_name: string;
+        rollup_property_id: string;
+        relation_property_id: string;
+    };
+};
+type SelectDatabasePropertyConfigResponse = {
+    type: "select";
+    select: {
+        options: Array<SelectPropertyResponse>;
+    };
+};
+type SelectPropertyResponse = {
+    id: string;
+    name: string;
+    color: SelectColor;
+    description: string | null;
+};
+type SinglePropertyDatabasePropertyRelationConfigResponse = {
+    type: "single_property";
+    single_property: EmptyObject;
+};
+type StatusDatabasePropertyConfigResponse = {
+    type: "status";
+    status: {
+        options: Array<StatusPropertyResponse>;
+        groups: Array<{
+            id: string;
+            name: string;
+            color: SelectColor;
+            option_ids: Array<string>;
+        }>;
+    };
+};
+type StatusPropertyResponse = {
+    id: string;
+    name: string;
+    color: SelectColor;
+    description: string | null;
+};
+type TitleDatabasePropertyConfigResponse = {
+    type: "title";
+    title: EmptyObject;
+};
+type UniqueIdDatabasePropertyConfigResponse = {
+    type: "unique_id";
+    unique_id: {
+        prefix: string | null;
+    };
+};
+type UrlDatabasePropertyConfigResponse = {
+    type: "url";
+    url: EmptyObject;
+};
+type GetDataSourcePathParameters = {
+    data_source_id: IdRequest;
+};
+export type GetDataSourceParameters = GetDataSourcePathParameters;
+export type GetDataSourceResponse = PartialDataSourceObjectResponse | DataSourceObjectResponse;
+/**
+ * Retrieve a data source
+ */
+export declare const getDataSource: {
+    readonly method: "get";
+    readonly pathParams: readonly ["data_source_id"];
+    readonly queryParams: readonly [];
+    readonly bodyParams: readonly [];
+    readonly path: (p: GetDataSourcePathParameters) => string;
+};
+type UpdateDataSourcePathParameters = {
+    data_source_id: IdRequest;
+};
+type UpdateDataSourceBodyParameters = {
+    title?: Array<RichTextItemRequest>;
+    icon?: PageIconRequest | null;
+    properties?: Record<string, ({
+        name?: string;
+        description?: PropertyDescriptionRequest | null;
+    } & ({
+        type?: "number";
+        number: {
+            format?: NumberFormat;
+        };
+    } | {
+        type?: "formula";
+        formula: {
+            expression?: string;
+        };
+    } | {
+        type?: "select";
+        select: {
+            options?: Array<{
+                color?: SelectColor;
+                description?: string | null;
+            } & ({
+                name: string;
+                id?: string;
+            } | {
+                id: string;
+                name?: string;
+            })>;
+        };
+    } | {
+        type?: "multi_select";
+        multi_select: {
+            options?: Array<{
+                color?: SelectColor;
+                description?: string | null;
+            } & ({
+                name: string;
+                id?: string;
+            } | {
+                id: string;
+                name?: string;
+            })>;
+        };
+    } | {
+        type?: "status";
+        status: StatusPropertyConfigUpdateRequest;
+    } | {
+        type?: "relation";
+        relation: {
+            data_source_id: IdRequest;
+        } & ({
+            type?: "single_property";
+            single_property: EmptyObject;
+        } | {
+            type?: "dual_property";
+            dual_property: {
+                synced_property_id?: string;
+                synced_property_name?: string;
+            };
+        });
+    } | {
+        type?: "rollup";
+        rollup: {
+            function: RollupFunction;
+        } & ({
+            relation_property_name: string;
+            rollup_property_name: string;
+        } | {
+            relation_property_id: string;
+            rollup_property_name: string;
+        } | {
+            relation_property_name: string;
+            rollup_property_id: string;
+        } | {
+            relation_property_id: string;
+            rollup_property_id: string;
+        });
+    } | {
+        type?: "unique_id";
+        unique_id: {
+            prefix?: string | null;
+        };
+    } | {
+        type?: "title";
+        title: EmptyObject;
+    } | {
+        type?: "rich_text";
+        rich_text: EmptyObject;
+    } | {
+        type?: "url";
+        url: EmptyObject;
+    } | {
+        type?: "people";
+        people: EmptyObject;
+    } | {
+        type?: "files";
+        files: EmptyObject;
+    } | {
+        type?: "email";
+        email: EmptyObject;
+    } | {
+        type?: "phone_number";
+        phone_number: EmptyObject;
+    } | {
+        type?: "date";
+        date: EmptyObject;
+    } | {
+        type?: "checkbox";
+        checkbox: EmptyObject;
+    } | {
+        type?: "created_by";
+        created_by: EmptyObject;
+    } | {
+        type?: "created_time";
+        created_time: EmptyObject;
+    } | {
+        type?: "last_edited_by";
+        last_edited_by: EmptyObject;
+    } | {
+        type?: "last_edited_time";
+        last_edited_time: EmptyObject;
+    } | {
+        type?: "place";
+        place: EmptyObject;
+    })) | {
+        name: string;
+    } | null>;
+    in_trash?: boolean;
+    /** @deprecated Use `in_trash` instead. */
+    archived?: boolean;
+    parent?: ParentOfDataSourceRequest;
+};
+export type UpdateDataSourceParameters = UpdateDataSourcePathParameters & UpdateDataSourceBodyParameters;
+export type UpdateDataSourceResponse = PartialDataSourceObjectResponse | DataSourceObjectResponse;
+/**
+ * Update a data source
+ */
+export declare const updateDataSource: {
+    readonly method: "patch";
+    readonly pathParams: readonly ["data_source_id"];
+    readonly queryParams: readonly [];
+    readonly bodyParams: readonly ["archived", "title", "icon", "properties", "in_trash", "parent"];
+    readonly path: (p: UpdateDataSourcePathParameters) => string;
+};
+type QueryDataSourcePathParameters = {
+    data_source_id: IdRequest;
+};
+type QueryDataSourceQueryParameters = {
+    filter_properties?: Array<string>;
+};
+type QueryDataSourceBodyParameters = {
+    sorts?: Array<{
+        property: string;
+        direction: "ascending" | "descending";
+    } | {
+        timestamp: "created_time" | "last_edited_time";
+        direction: "ascending" | "descending";
+    }>;
+    filter?: {
+        or: GroupFilterOperatorArray;
+    } | {
+        and: GroupFilterOperatorArray;
+    } | PropertyFilter | TimestampFilter;
+    start_cursor?: string;
+    page_size?: number;
+    in_trash?: boolean;
+    /** @deprecated Use `in_trash` instead. */
+    archived?: boolean;
+    result_type?: "page" | "data_source";
+};
+export type QueryDataSourceParameters = QueryDataSourcePathParameters & QueryDataSourceQueryParameters & QueryDataSourceBodyParameters;
+export type QueryDataSourceResponse = {
+    type: "page_or_data_source";
+    page_or_data_source: EmptyObject;
+    object: "list";
+    next_cursor: string | null;
+    has_more: boolean;
+    results: Array<PageObjectResponse | PartialPageObjectResponse | PartialDataSourceObjectResponse | DataSourceObjectResponse>;
+};
+/**
+ * Query a data source
+ */
+export declare const queryDataSource: {
+    readonly method: "post";
+    readonly pathParams: readonly ["data_source_id"];
+    readonly queryParams: readonly ["filter_properties"];
+    readonly bodyParams: readonly ["archived", "sorts", "filter", "start_cursor", "page_size", "in_trash", "result_type"];
+    readonly path: (p: QueryDataSourcePathParameters) => string;
+};
+type CreateDataSourceBodyParameters = {
+    parent: ParentOfDataSourceRequest;
+    properties: Record<string, PropertyConfigurationRequest>;
+    title?: Array<RichTextItemRequest>;
+    icon?: PageIconRequest | null;
+};
+export type CreateDataSourceParameters = CreateDataSourceBodyParameters;
+export type CreateDataSourceResponse = PartialDataSourceObjectResponse | DataSourceObjectResponse;
+/**
+ * Create a data source
+ */
+export declare const createDataSource: {
+    readonly method: "post";
+    readonly pathParams: readonly [];
+    readonly queryParams: readonly [];
+    readonly bodyParams: readonly ["parent", "properties", "title", "icon"];
+    readonly path: () => string;
+};
+type ListDataSourceTemplatesPathParameters = {
+    data_source_id: IdRequest;
+};
+type ListDataSourceTemplatesQueryParameters = {
+    name?: string;
+    start_cursor?: string;
+    page_size?: number;
+};
+export type ListDataSourceTemplatesParameters = ListDataSourceTemplatesPathParameters & ListDataSourceTemplatesQueryParameters;
+export type ListDataSourceTemplatesResponse = {
+    templates: Array<{
+        id: IdResponse;
+        name: string;
+        is_default: boolean;
+    }>;
+    has_more: boolean;
+    next_cursor: IdResponse | null;
+};
+/**
+ * List templates in a data source
+ */
+export declare const listDataSourceTemplates: {
+    readonly method: "get";
+    readonly pathParams: readonly ["data_source_id"];
+    readonly queryParams: readonly ["name", "start_cursor", "page_size"];
+    readonly bodyParams: readonly [];
+    readonly path: (p: ListDataSourceTemplatesPathParameters) => string;
+};
+export {};
+//# sourceMappingURL=data-sources.d.ts.map

package/build/src/api-endpoints/data-sources.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"data-sources.d.ts","sourceRoot":"","sources":["../../../src/api-endpoints/data-sources.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EACV,wBAAwB,EACxB,sBAAsB,EACtB,WAAW,EACX,wBAAwB,EACxB,SAAS,EACT,UAAU,EACV,YAAY,EACZ,iBAAiB,EACjB,eAAe,EACf,gBAAgB,EAChB,kBAAkB,EAClB,yBAAyB,EACzB,wBAAwB,EACxB,yBAAyB,EACzB,yBAAyB,EACzB,4BAA4B,EAC5B,0BAA0B,EAC1B,cAAc,EACd,mBAAmB,EACnB,oBAAoB,EACpB,cAAc,EACd,WAAW,EACX,iCAAiC,EACjC,eAAe,EAChB,MAAM,UAAU,CAAA;AAEjB,KAAK,sCAAsC,GAAG;IAE5C,IAAI,EAAE,UAAU,CAAA;IAChB,QAAQ,EAAE,WAAW,CAAA;CACtB,CAAA;AAED,KAAK,uCAAuC,GAAG;IAE7C,IAAI,EAAE,YAAY,CAAA;IAClB,UAAU,EAAE,WAAW,CAAA;CACxB,CAAA;AAED,KAAK,yCAAyC,GAAG;IAE/C,IAAI,EAAE,cAAc,CAAA;IACpB,YAAY,EAAE,WAAW,CAAA;CAC1B,CAAA;AAED,MAAM,MAAM,wBAAwB,GAAG;IAErC,MAAM,EAAE,aAAa,CAAA;IAErB,EAAE,EAAE,UAAU,CAAA;IAEd,KAAK,EAAE,KAAK,CAAC,oBAAoB,CAAC,CAAA;IAElC,WAAW,EAAE,KAAK,CAAC,oBAAoB,CAAC,CAAA;IAExC,MAAM,EAAE,0BAA0B,CAAA;IAGlC,eAAe,EAAE,wBAAwB,CAAA;IAEzC,SAAS,EAAE,OAAO,CAAA;IAElB,QAAQ,EAAE,OAAO,CAAA;IACjB,qHAAqH;IACrH,QAAQ,EAAE,OAAO,CAAA;IAEjB,YAAY,EAAE,MAAM,CAAA;IAEpB,gBAAgB,EAAE,MAAM,CAAA;IAExB,UAAU,EAAE,yBAAyB,CAAA;IAErC,cAAc,EAAE,yBAAyB,CAAA;IAEzC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,8BAA8B,CAAC,CAAA;IAE1D,IAAI,EAAE,gBAAgB,GAAG,IAAI,CAAA;IAE7B,KAAK,EAAE,iBAAiB,GAAG,IAAI,CAAA;IAE/B,GAAG,EAAE,MAAM,CAAA;IAEX,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;CAC1B,CAAA;AAED,KAAK,8BAA8B,GAAG,oCAAoC,GACxE,CACI,oCAAoC,GACpC,qCAAqC,GACrC,oCAAoC,GACpC,yCAAyC,GACzC,oCAAoC,GACpC,sCAAsC,GACtC,oCAAoC,GACpC,sCAAsC,GACtC,mCAAmC,GACnC,sCAAsC,GACtC,iCAAiC,GACjC,oCAAoC,GACpC,mCAAmC,GACnC,mCAAmC,GACnC,yCAAyC,GACzC,kCAAkC,GAClC,sCAAsC,GACtC,uCAAuC,GACvC,yCAAyC,GACzC,0CAA0C,GAC1C,4CAA4C,CAC/C,CAAA;AAEH,KAAK,oCAAoC,GAAG;IAE1C,EAAE,EAAE,MAAM,CAAA;IAEV,IAAI,EAAE,MAAM,CAAA;IAEZ,WAAW,EAAE,0BAA0B,GAAG,IAAI,CAAA;CAC/C,CAAA;AAED,KAAK,sCAAsC,GACzC,4CAA4C,GAC1C,CACI,oDAAoD,GACpD,kDAAkD,CACrD,CAAA;AAEL,KAAK,4CAA4C,GAAG;IAClD,WAAW,EAAE,UAAU,CAAA;IACvB,cAAc,EAAE,UAAU,CAAA;CAC3B,CAAA;AAED,KAAK,kCAAkC,GAAG;IAExC,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,WAAW,CAAA;CAClB,CAAA;AAED,KAAK,kDAAkD,GAAG;IAExD,IAAI,CAAC,EAAE,eAAe,CAAA;IACtB,aAAa,EAAE;QAAE,kBAAkB,EAAE,MAAM,CAAC;QAAC,oBAAoB,EAAE,MAAM,CAAA;KAAE,CAAA;CAC5E,CAAA;AAED,KAAK,mCAAmC,GAAG;IAEzC,IAAI,EAAE,OAAO,CAAA;IACb,KAAK,EAAE,WAAW,CAAA;CACnB,CAAA;AAED,KAAK,mCAAmC,GAAG;IAEzC,IAAI,EAAE,OAAO,CAAA;IACb,KAAK,EAAE,WAAW,CAAA;CACnB,CAAA;AAED,KAAK,qCAAqC,GAAG;IAE3C,IAAI,EAAE,SAAS,CAAA;IACf,OAAO,EAAE;QAAE,UAAU,EAAE,MAAM,CAAA;KAAE,CAAA;CAChC,CAAA;AAED,KAAK,0CAA0C,GAAG;IAEhD,IAAI,EAAE,gBAAgB,CAAA;IACtB,cAAc,EAAE,WAAW,CAAA;CAC5B,CAAA;AAED,KAAK,4CAA4C,GAAG;IAElD,IAAI,EAAE,kBAAkB,CAAA;IACxB,gBAAgB,EAAE,WAAW,CAAA;CAC9B,CAAA;AAED,KAAK,yCAAyC,GAAG;IAE/C,IAAI,EAAE,cAAc,CAAA;IACpB,YAAY,EAAE;QAAE,OAAO,EAAE,KAAK,CAAC,sBAAsB,CAAC,CAAA;KAAE,CAAA;CACzD,CAAA;AAED,KAAK,oCAAoC,GAAG;IAE1C,IAAI,EAAE,QAAQ,CAAA;IACd,MAAM,EAAE;QAEN,MAAM,EAAE,YAAY,CAAA;KACrB,CAAA;CACF,CAAA;AAED;;;GAGG;AACH,KAAK,0BAA0B,GAC3B,sBAAsB,GACtB,wBAAwB,CAAA;AAE5B,MAAM,MAAM,+BAA+B,GAAG;IAE5C,MAAM,EAAE,aAAa,CAAA;IAErB,EAAE,EAAE,UAAU,CAAA;IAEd,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,8BAA8B,CAAC,CAAA;CAC3D,CAAA;AAED,KAAK,oCAAoC,GAAG;IAE1C,IAAI,EAAE,QAAQ,CAAA;IACd,MAAM,EAAE,WAAW,CAAA;CACpB,CAAA;AAED,KAAK,yCAAyC,GAAG;IAE/C,IAAI,EAAE,cAAc,CAAA;IACpB,YAAY,EAAE,WAAW,CAAA;CAC1B,CAAA;AAED,KAAK,sCAAsC,GAAG;IAE5C,IAAI,EAAE,UAAU,CAAA;IAChB,QAAQ,EAAE,sCAAsC,CAAA;CACjD,CAAA;AAED,KAAK,sCAAsC,GAAG;IAE5C,IAAI,EAAE,WAAW,CAAA;IACjB,SAAS,EAAE,WAAW,CAAA;CACvB,CAAA;AAED,KAAK,oCAAoC,GAAG;IAE1C,IAAI,EAAE,QAAQ,CAAA;IACd,MAAM,EAAE;QAEN,QAAQ,EAAE,cAAc,CAAA;QACxB,oBAAoB,EAAE,MAAM,CAAA;QAC5B,sBAAsB,EAAE,MAAM,CAAA;QAC9B,kBAAkB,EAAE,MAAM,CAAA;QAC1B,oBAAoB,EAAE,MAAM,CAAA;KAC7B,CAAA;CACF,CAAA;AAED,KAAK,oCAAoC,GAAG;IAE1C,IAAI,EAAE,QAAQ,CAAA;IACd,MAAM,EAAE;QAAE,OAAO,EAAE,KAAK,CAAC,sBAAsB,CAAC,CAAA;KAAE,CAAA;CACnD,CAAA;AAED,KAAK,sBAAsB,GAAG;IAC5B,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,WAAW,CAAA;IAClB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;CAC3B,CAAA;AAED,KAAK,oDAAoD,GAAG;IAE1D,IAAI,EAAE,iBAAiB,CAAA;IACvB,eAAe,EAAE,WAAW,CAAA;CAC7B,CAAA;AAED,KAAK,oCAAoC,GAAG;IAE1C,IAAI,EAAE,QAAQ,CAAA;IACd,MAAM,EAAE;QAEN,OAAO,EAAE,KAAK,CAAC,sBAAsB,CAAC,CAAA;QAEtC,MAAM,EAAE,KAAK,CAAC;YAEZ,EAAE,EAAE,MAAM,CAAA;YAEV,IAAI,EAAE,MAAM,CAAA;YAEZ,KAAK,EAAE,WAAW,CAAA;YAElB,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAA;SAC1B,CAAC,CAAA;KACH,CAAA;CACF,CAAA;AAED,KAAK,sBAAsB,GAAG;IAE5B,EAAE,EAAE,MAAM,CAAA;IAEV,IAAI,EAAE,MAAM,CAAA;IAEZ,KAAK,EAAE,WAAW,CAAA;IAElB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;CAC3B,CAAA;AAED,KAAK,mCAAmC,GAAG;IAEzC,IAAI,EAAE,OAAO,CAAA;IACb,KAAK,EAAE,WAAW,CAAA;CACnB,CAAA;AAED,KAAK,sCAAsC,GAAG;IAE5C,IAAI,EAAE,WAAW,CAAA;IACjB,SAAS,EAAE;QAET,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;KACtB,CAAA;CACF,CAAA;AAED,KAAK,iCAAiC,GAAG;IAEvC,IAAI,EAAE,KAAK,CAAA;IACX,GAAG,EAAE,WAAW,CAAA;CACjB,CAAA;AAED,KAAK,2BAA2B,GAAG;IAEjC,cAAc,EAAE,SAAS,CAAA;CAC1B,CAAA;AAED,MAAM,MAAM,uBAAuB,GAAG,2BAA2B,CAAA;AAEjE,MAAM,MAAM,qBAAqB,GAC7B,+BAA+B,GAC/B,wBAAwB,CAAA;AAE5B;;GAEG;AACH,eAAO,MAAM,aAAa;;;;;uBAMd,2BAA2B,KAAG,MAAM;CAEtC,CAAA;AAEV,KAAK,8BAA8B,GAAG;IAEpC,cAAc,EAAE,SAAS,CAAA;CAC1B,CAAA;AAED,KAAK,8BAA8B,GAAG;IAEpC,KAAK,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,CAAA;IAElC,IAAI,CAAC,EAAE,eAAe,GAAG,IAAI,CAAA;IAG7B,UAAU,CAAC,EAAE,MAAM,CACjB,MAAM,EACJ,CAAC;QAEC,IAAI,CAAC,EAAE,MAAM,CAAA;QAEb,WAAW,CAAC,EAAE,0BAA0B,GAAG,IAAI,CAAA;KAChD,GAAG,CACA;QAEE,IAAI,CAAC,EAAE,QAAQ,CAAA;QACf,MAAM,EAAE;YAAE,MAAM,CAAC,EAAE,YAAY,CAAA;SAAE,CAAA;KAClC,GACD;QAEE,IAAI,CAAC,EAAE,SAAS,CAAA;QAChB,OAAO,EAAE;YAAE,UAAU,CAAC,EAAE,MAAM,CAAA;SAAE,CAAA;KACjC,GACD;QAEE,IAAI,CAAC,EAAE,QAAQ,CAAA;QACf,MAAM,EAAE;YACN,OAAO,CAAC,EAAE,KAAK,CACb;gBAAE,KAAK,CAAC,EAAE,WAAW,CAAC;gBAAC,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;aAAE,GAAG,CACnD;gBAAE,IAAI,EAAE,MAAM,CAAC;gBAAC,EAAE,CAAC,EAAE,MAAM,CAAA;aAAE,GAC7B;gBAAE,EAAE,EAAE,MAAM,CAAC;gBAAC,IAAI,CAAC,EAAE,MAAM,CAAA;aAAE,CAChC,CACF,CAAA;SACF,CAAA;KACF,GACD;QAEE,IAAI,CAAC,EAAE,cAAc,CAAA;QACrB,YAAY,EAAE;YACZ,OAAO,CAAC,EAAE,KAAK,CACb;gBAAE,KAAK,CAAC,EAAE,WAAW,CAAC;gBAAC,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;aAAE,GAAG,CACnD;gBAAE,IAAI,EAAE,MAAM,CAAC;gBAAC,EAAE,CAAC,EAAE,MAAM,CAAA;aAAE,GAC7B;gBAAE,EAAE,EAAE,MAAM,CAAC;gBAAC,IAAI,CAAC,EAAE,MAAM,CAAA;aAAE,CAChC,CACF,CAAA;SACF,CAAA;KACF,GACD;QAEE,IAAI,CAAC,EAAE,QAAQ,CAAA;QACf,MAAM,EAAE,iCAAiC,CAAA;KAC1C,GACD;QAEE,IAAI,CAAC,EAAE,UAAU,CAAA;QACjB,QAAQ,EAAE;YAAE,cAAc,EAAE,SAAS,CAAA;SAAE,GAAG,CACtC;YAEE,IAAI,CAAC,EAAE,iBAAiB,CAAA;YACxB,eAAe,EAAE,WAAW,CAAA;SAC7B,GACD;YAEE,IAAI,CAAC,EAAE,eAAe,CAAA;YACtB,aAAa,EAAE;gBACb,kBAAkB,CAAC,EAAE,MAAM,CAAA;gBAC3B,oBAAoB,CAAC,EAAE,MAAM,CAAA;aAC9B,CAAA;SACF,CACJ,CAAA;KACF,GACD;QAEE,IAAI,CAAC,EAAE,QAAQ,CAAA;QACf,MAAM,EAAE;YAEN,QAAQ,EAAE,cAAc,CAAA;SACzB,GAAG,CACA;YAAE,sBAAsB,EAAE,MAAM,CAAC;YAAC,oBAAoB,EAAE,MAAM,CAAA;SAAE,GAChE;YAAE,oBAAoB,EAAE,MAAM,CAAC;YAAC,oBAAoB,EAAE,MAAM,CAAA;SAAE,GAC9D;YAAE,sBAAsB,EAAE,MAAM,CAAC;YAAC,kBAAkB,EAAE,MAAM,CAAA;SAAE,GAC9D;YAAE,oBAAoB,EAAE,MAAM,CAAC;YAAC,kBAAkB,EAAE,MAAM,CAAA;SAAE,CAC/D,CAAA;KACF,GACD;QAEE,IAAI,CAAC,EAAE,WAAW,CAAA;QAClB,SAAS,EAAE;YAAE,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;SAAE,CAAA;KACtC,GACD;QAEE,IAAI,CAAC,EAAE,OAAO,CAAA;QACd,KAAK,EAAE,WAAW,CAAA;KACnB,GACD;QAEE,IAAI,CAAC,EAAE,WAAW,CAAA;QAClB,SAAS,EAAE,WAAW,CAAA;KACvB,GACD;QAEE,IAAI,CAAC,EAAE,KAAK,CAAA;QACZ,GAAG,EAAE,WAAW,CAAA;KACjB,GACD;QAEE,IAAI,CAAC,EAAE,QAAQ,CAAA;QACf,MAAM,EAAE,WAAW,CAAA;KACpB,GACD;QAEE,IAAI,CAAC,EAAE,OAAO,CAAA;QACd,KAAK,EAAE,WAAW,CAAA;KACnB,GACD;QAEE,IAAI,CAAC,EAAE,OAAO,CAAA;QACd,KAAK,EAAE,WAAW,CAAA;KACnB,GACD;QAEE,IAAI,CAAC,EAAE,cAAc,CAAA;QACrB,YAAY,EAAE,WAAW,CAAA;KAC1B,GACD;QAEE,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,IAAI,EAAE,WAAW,CAAA;KAClB,GACD;QAEE,IAAI,CAAC,EAAE,UAAU,CAAA;QACjB,QAAQ,EAAE,WAAW,CAAA;KACtB,GACD;QAEE,IAAI,CAAC,EAAE,YAAY,CAAA;QACnB,UAAU,EAAE,WAAW,CAAA;KACxB,GACD;QAEE,IAAI,CAAC,EAAE,cAAc,CAAA;QACrB,YAAY,EAAE,WAAW,CAAA;KAC1B,GACD;QAEE,IAAI,CAAC,EAAE,gBAAgB,CAAA;QACvB,cAAc,EAAE,WAAW,CAAA;KAC5B,GACD;QAEE,IAAI,CAAC,EAAE,kBAAkB,CAAA;QACzB,gBAAgB,EAAE,WAAW,CAAA;KAC9B,GACD;QAEE,IAAI,CAAC,EAAE,OAAO,CAAA;QACd,KAAK,EAAE,WAAW,CAAA;KACnB,CACJ,CAAC,GACF;QAEE,IAAI,EAAE,MAAM,CAAA;KACb,GACD,IAAI,CACP,CAAA;IAGD,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,0CAA0C;IAC1C,QAAQ,CAAC,EAAE,OAAO,CAAA;IAGlB,MAAM,CAAC,EAAE,yBAAyB,CAAA;CACnC,CAAA;AAED,MAAM,MAAM,0BAA0B,GAAG,8BAA8B,GACrE,8BAA8B,CAAA;AAEhC,MAAM,MAAM,wBAAwB,GAChC,+BAA+B,GAC/B,wBAAwB,CAAA;AAE5B;;GAEG;AACH,eAAO,MAAM,gBAAgB;;;;;uBAMjB,8BAA8B,KAAG,MAAM;CAEzC,CAAA;AAEV,KAAK,6BAA6B,GAAG;IACnC,cAAc,EAAE,SAAS,CAAA;CAC1B,CAAA;AAED,KAAK,8BAA8B,GAAG;IACpC,iBAAiB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAA;CAClC,CAAA;AAED,KAAK,6BAA6B,GAAG;IACnC,KAAK,CAAC,EAAE,KAAK,CACT;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,WAAW,GAAG,YAAY,CAAA;KAAE,GAC3D;QACE,SAAS,EAAE,cAAc,GAAG,kBAAkB,CAAA;QAC9C,SAAS,EAAE,WAAW,GAAG,YAAY,CAAA;KACtC,CACJ,CAAA;IACD,MAAM,CAAC,EACH;QAAE,EAAE,EAAE,wBAAwB,CAAA;KAAE,GAChC;QAAE,GAAG,EAAE,wBAAwB,CAAA;KAAE,GACjC,cAAc,GACd,eAAe,CAAA;IACnB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,0CAA0C;IAC1C,QAAQ,CAAC,EAAE,OAAO,CAAA;IAIlB,WAAW,CAAC,EAAE,MAAM,GAAG,aAAa,CAAA;CACrC,CAAA;AAED,MAAM,MAAM,yBAAyB,GAAG,6BAA6B,GACnE,8BAA8B,GAC9B,6BAA6B,CAAA;AAE/B,MAAM,MAAM,uBAAuB,GAAG;IACpC,IAAI,EAAE,qBAAqB,CAAA;IAC3B,mBAAmB,EAAE,WAAW,CAAA;IAChC,MAAM,EAAE,MAAM,CAAA;IACd,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,QAAQ,EAAE,OAAO,CAAA;IACjB,OAAO,EAAE,KAAK,CACV,kBAAkB,GAClB,yBAAyB,GACzB,+BAA+B,GAC/B,wBAAwB,CAC3B,CAAA;CACF,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,eAAe;;;;;uBAchB,6BAA6B,KAAG,MAAM;CAExC,CAAA;AAEV,KAAK,8BAA8B,GAAG;IAEpC,MAAM,EAAE,yBAAyB,CAAA;IAEjC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,4BAA4B,CAAC,CAAA;IAExD,KAAK,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,CAAA;IAElC,IAAI,CAAC,EAAE,eAAe,GAAG,IAAI,CAAA;CAC9B,CAAA;AAED,MAAM,MAAM,0BAA0B,GAAG,8BAA8B,CAAA;AAEvE,MAAM,MAAM,wBAAwB,GAChC,+BAA+B,GAC/B,wBAAwB,CAAA;AAE5B;;GAEG;AACH,eAAO,MAAM,gBAAgB;;;;;yBAMjB,MAAM;CACR,CAAA;AAEV,KAAK,qCAAqC,GAAG;IAE3C,cAAc,EAAE,SAAS,CAAA;CAC1B,CAAA;AAED,KAAK,sCAAsC,GAAG;IAE5C,IAAI,CAAC,EAAE,MAAM,CAAA;IAGb,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB,CAAA;AAED,MAAM,MAAM,iCAAiC,GAC3C,qCAAqC,GAAG,sCAAsC,CAAA;AAEhF,MAAM,MAAM,+BAA+B,GAAG;IAE5C,SAAS,EAAE,KAAK,CAAC;QAEf,EAAE,EAAE,UAAU,CAAA;QAEd,IAAI,EAAE,MAAM,CAAA;QAEZ,UAAU,EAAE,OAAO,CAAA;KACpB,CAAC,CAAA;IAEF,QAAQ,EAAE,OAAO,CAAA;IAEjB,WAAW,EAAE,UAAU,GAAG,IAAI,CAAA;CAC/B,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,uBAAuB;;;;;uBAMxB,qCAAqC,KAAG,MAAM;CAEhD,CAAA"}

package/build/src/api-endpoints/data-sources.js

@@ -0,0 +1,64 @@
+"use strict";
+// cspell:disable-file
+// Note: This is a generated file. DO NOT EDIT!
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.listDataSourceTemplates = exports.createDataSource = exports.queryDataSource = exports.updateDataSource = exports.getDataSource = void 0;
+/**
+ * Retrieve a data source
+ */
+exports.getDataSource = {
+    method: "get",
+    pathParams: ["data_source_id"],
+    queryParams: [],
+    bodyParams: [],
+    path: (p) => `data_sources/${p.data_source_id}`,
+};
+/**
+ * Update a data source
+ */
+exports.updateDataSource = {
+    method: "patch",
+    pathParams: ["data_source_id"],
+    queryParams: [],
+    bodyParams: ["archived", "title", "icon", "properties", "in_trash", "parent"],
+    path: (p) => `data_sources/${p.data_source_id}`,
+};
+/**
+ * Query a data source
+ */
+exports.queryDataSource = {
+    method: "post",
+    pathParams: ["data_source_id"],
+    queryParams: ["filter_properties"],
+    bodyParams: [
+        "archived",
+        "sorts",
+        "filter",
+        "start_cursor",
+        "page_size",
+        "in_trash",
+        "result_type",
+    ],
+    path: (p) => `data_sources/${p.data_source_id}/query`,
+};
+/**
+ * Create a data source
+ */
+exports.createDataSource = {
+    method: "post",
+    pathParams: [],
+    queryParams: [],
+    bodyParams: ["parent", "properties", "title", "icon"],
+    path: () => `data_sources`,
+};
+/**
+ * List templates in a data source
+ */
+exports.listDataSourceTemplates = {
+    method: "get",
+    pathParams: ["data_source_id"],
+    queryParams: ["name", "start_cursor", "page_size"],
+    bodyParams: [],
+    path: (p) => `data_sources/${p.data_source_id}/templates`,
+};
+//# sourceMappingURL=data-sources.js.map

package/build/src/api-endpoints/data-sources.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"data-sources.js","sourceRoot":"","sources":["../../../src/api-endpoints/data-sources.ts"],"names":[],"mappings":";AAAA,sBAAsB;AACtB,+CAA+C;;;AAsU/C;;GAEG;AACU,QAAA,aAAa,GAAG;IAC3B,MAAM,EAAE,KAAK;IACb,UAAU,EAAE,CAAC,gBAAgB,CAAC;IAC9B,WAAW,EAAE,EAAE;IACf,UAAU,EAAE,EAAE;IAEd,IAAI,EAAE,CAAC,CAA8B,EAAU,EAAE,CAC/C,gBAAgB,CAAC,CAAC,cAAc,EAAE;CAC5B,CAAA;AAgMV;;GAEG;AACU,QAAA,gBAAgB,GAAG;IAC9B,MAAM,EAAE,OAAO;IACf,UAAU,EAAE,CAAC,gBAAgB,CAAC;IAC9B,WAAW,EAAE,EAAE;IACf,UAAU,EAAE,CAAC,UAAU,EAAE,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,UAAU,EAAE,QAAQ,CAAC;IAE7E,IAAI,EAAE,CAAC,CAAiC,EAAU,EAAE,CAClD,gBAAgB,CAAC,CAAC,cAAc,EAAE;CAC5B,CAAA;AAoDV;;GAEG;AACU,QAAA,eAAe,GAAG;IAC7B,MAAM,EAAE,MAAM;IACd,UAAU,EAAE,CAAC,gBAAgB,CAAC;IAC9B,WAAW,EAAE,CAAC,mBAAmB,CAAC;IAClC,UAAU,EAAE;QACV,UAAU;QACV,OAAO;QACP,QAAQ;QACR,cAAc;QACd,WAAW;QACX,UAAU;QACV,aAAa;KACd;IAED,IAAI,EAAE,CAAC,CAAgC,EAAU,EAAE,CACjD,gBAAgB,CAAC,CAAC,cAAc,QAAQ;CAClC,CAAA;AAmBV;;GAEG;AACU,QAAA,gBAAgB,GAAG;IAC9B,MAAM,EAAE,MAAM;IACd,UAAU,EAAE,EAAE;IACd,WAAW,EAAE,EAAE;IACf,UAAU,EAAE,CAAC,QAAQ,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,CAAC;IAErD,IAAI,EAAE,GAAW,EAAE,CAAC,cAAc;CAC1B,CAAA;AAoCV;;GAEG;AACU,QAAA,uBAAuB,GAAG;IACrC,MAAM,EAAE,KAAK;IACb,UAAU,EAAE,CAAC,gBAAgB,CAAC;IAC9B,WAAW,EAAE,CAAC,MAAM,EAAE,cAAc,EAAE,WAAW,CAAC;IAClD,UAAU,EAAE,EAAE;IAEd,IAAI,EAAE,CAAC,CAAwC,EAAU,EAAE,CACzD,gBAAgB,CAAC,CAAC,cAAc,YAAY;CACtC,CAAA","sourcesContent":["// cspell:disable-file\n// Note: This is a generated file. DO NOT EDIT!\n\nimport type {\n  DataSourceParentResponse,\n  DatabaseParentResponse,\n  EmptyObject,\n  GroupFilterOperatorArray,\n  IdRequest,\n  IdResponse,\n  NumberFormat,\n  PageCoverResponse,\n  PageIconRequest,\n  PageIconResponse,\n  PageObjectResponse,\n  ParentOfDataSourceRequest,\n  ParentOfDatabaseResponse,\n  PartialPageObjectResponse,\n  PartialUserObjectResponse,\n  PropertyConfigurationRequest,\n  PropertyDescriptionRequest,\n  PropertyFilter,\n  RichTextItemRequest,\n  RichTextItemResponse,\n  RollupFunction,\n  SelectColor,\n  StatusPropertyConfigUpdateRequest,\n  TimestampFilter,\n} from \"./common\"\n\ntype CheckboxDatabasePropertyConfigResponse = {\n  // Always `checkbox`\n  type: \"checkbox\"\n  checkbox: EmptyObject\n}\n\ntype CreatedByDatabasePropertyConfigResponse = {\n  // Always `created_by`\n  type: \"created_by\"\n  created_by: EmptyObject\n}\n\ntype CreatedTimeDatabasePropertyConfigResponse = {\n  // Always `created_time`\n  type: \"created_time\"\n  created_time: EmptyObject\n}\n\nexport type DataSourceObjectResponse = {\n  // The data source object type name.\n  object: \"data_source\"\n  // The ID of the data source.\n  id: IdResponse\n  // The title of the data source.\n  title: Array<RichTextItemResponse>\n  // The description of the data source.\n  description: Array<RichTextItemResponse>\n  // The parent of the data source.\n  parent: ParentOfDataSourceResponse\n  // The parent of the data source's containing database. This is typically a page, block,\n  // or workspace, but can be another database in the case of wikis.\n  database_parent: ParentOfDatabaseResponse\n  // Whether the data source is inline.\n  is_inline: boolean\n  // Whether the data source is in the trash.\n  in_trash: boolean\n  /** @deprecated Use `in_trash` instead. Present for backwards compatibility with API versions prior to 2026-03-11. */\n  archived: boolean\n  // The time when the data source was created.\n  created_time: string\n  // The time when the data source was last edited.\n  last_edited_time: string\n  // The user who created the data source.\n  created_by: PartialUserObjectResponse\n  // The user who last edited the data source.\n  last_edited_by: PartialUserObjectResponse\n  // The properties schema of the data source.\n  properties: Record<string, DatabasePropertyConfigResponse>\n  // The icon of the data source.\n  icon: PageIconResponse | null\n  // The cover of the data source.\n  cover: PageCoverResponse | null\n  // The URL of the data source.\n  url: string\n  // The public URL of the data source if it is publicly accessible.\n  public_url: string | null\n}\n\ntype DatabasePropertyConfigResponse = DatabasePropertyConfigResponseCommon &\n  (\n    | NumberDatabasePropertyConfigResponse\n    | FormulaDatabasePropertyConfigResponse\n    | SelectDatabasePropertyConfigResponse\n    | MultiSelectDatabasePropertyConfigResponse\n    | StatusDatabasePropertyConfigResponse\n    | RelationDatabasePropertyConfigResponse\n    | RollupDatabasePropertyConfigResponse\n    | UniqueIdDatabasePropertyConfigResponse\n    | TitleDatabasePropertyConfigResponse\n    | RichTextDatabasePropertyConfigResponse\n    | UrlDatabasePropertyConfigResponse\n    | PeopleDatabasePropertyConfigResponse\n    | FilesDatabasePropertyConfigResponse\n    | EmailDatabasePropertyConfigResponse\n    | PhoneNumberDatabasePropertyConfigResponse\n    | DateDatabasePropertyConfigResponse\n    | CheckboxDatabasePropertyConfigResponse\n    | CreatedByDatabasePropertyConfigResponse\n    | CreatedTimeDatabasePropertyConfigResponse\n    | LastEditedByDatabasePropertyConfigResponse\n    | LastEditedTimeDatabasePropertyConfigResponse\n  )\n\ntype DatabasePropertyConfigResponseCommon = {\n  // The ID of the property.\n  id: string\n  // The name of the property.\n  name: string\n  // The description of the property.\n  description: PropertyDescriptionRequest | null\n}\n\ntype DatabasePropertyRelationConfigResponse =\n  DatabasePropertyRelationConfigResponseCommon &\n    (\n      | SinglePropertyDatabasePropertyRelationConfigResponse\n      | DualPropertyDatabasePropertyRelationConfigResponse\n    )\n\ntype DatabasePropertyRelationConfigResponseCommon = {\n  database_id: IdResponse\n  data_source_id: IdResponse\n}\n\ntype DateDatabasePropertyConfigResponse = {\n  // Always `date`\n  type: \"date\"\n  date: EmptyObject\n}\n\ntype DualPropertyDatabasePropertyRelationConfigResponse = {\n  // Always `dual_property`\n  type?: \"dual_property\"\n  dual_property: { synced_property_id: string; synced_property_name: string }\n}\n\ntype EmailDatabasePropertyConfigResponse = {\n  // Always `email`\n  type: \"email\"\n  email: EmptyObject\n}\n\ntype FilesDatabasePropertyConfigResponse = {\n  // Always `files`\n  type: \"files\"\n  files: EmptyObject\n}\n\ntype FormulaDatabasePropertyConfigResponse = {\n  // Always `formula`\n  type: \"formula\"\n  formula: { expression: string }\n}\n\ntype LastEditedByDatabasePropertyConfigResponse = {\n  // Always `last_edited_by`\n  type: \"last_edited_by\"\n  last_edited_by: EmptyObject\n}\n\ntype LastEditedTimeDatabasePropertyConfigResponse = {\n  // Always `last_edited_time`\n  type: \"last_edited_time\"\n  last_edited_time: EmptyObject\n}\n\ntype MultiSelectDatabasePropertyConfigResponse = {\n  // Always `multi_select`\n  type: \"multi_select\"\n  multi_select: { options: Array<SelectPropertyResponse> }\n}\n\ntype NumberDatabasePropertyConfigResponse = {\n  // Always `number`\n  type: \"number\"\n  number: {\n    // The number format for the property.\n    format: NumberFormat\n  }\n}\n\n/**\n * The parent of the data source. This is typically a database (`database_id`), but for\n * externally synced data sources, can be another data source (`data_source_id`).\n */\ntype ParentOfDataSourceResponse =\n  | DatabaseParentResponse\n  | DataSourceParentResponse\n\nexport type PartialDataSourceObjectResponse = {\n  // The data source object type name.\n  object: \"data_source\"\n  // The ID of the data source.\n  id: IdResponse\n  // The properties schema of the data source.\n  properties: Record<string, DatabasePropertyConfigResponse>\n}\n\ntype PeopleDatabasePropertyConfigResponse = {\n  // Always `people`\n  type: \"people\"\n  people: EmptyObject\n}\n\ntype PhoneNumberDatabasePropertyConfigResponse = {\n  // Always `phone_number`\n  type: \"phone_number\"\n  phone_number: EmptyObject\n}\n\ntype RelationDatabasePropertyConfigResponse = {\n  // Always `relation`\n  type: \"relation\"\n  relation: DatabasePropertyRelationConfigResponse\n}\n\ntype RichTextDatabasePropertyConfigResponse = {\n  // Always `rich_text`\n  type: \"rich_text\"\n  rich_text: EmptyObject\n}\n\ntype RollupDatabasePropertyConfigResponse = {\n  // Always `rollup`\n  type: \"rollup\"\n  rollup: {\n    // The function to use for the rollup, e.g. count, count_values, percent_not_empty, max.\n    function: RollupFunction\n    rollup_property_name: string\n    relation_property_name: string\n    rollup_property_id: string\n    relation_property_id: string\n  }\n}\n\ntype SelectDatabasePropertyConfigResponse = {\n  // Always `select`\n  type: \"select\"\n  select: { options: Array<SelectPropertyResponse> }\n}\n\ntype SelectPropertyResponse = {\n  id: string\n  name: string\n  color: SelectColor\n  description: string | null\n}\n\ntype SinglePropertyDatabasePropertyRelationConfigResponse = {\n  // Always `single_property`\n  type: \"single_property\"\n  single_property: EmptyObject\n}\n\ntype StatusDatabasePropertyConfigResponse = {\n  // Always `status`\n  type: \"status\"\n  status: {\n    // The options for the status property.\n    options: Array<StatusPropertyResponse>\n    // The groups for the status property.\n    groups: Array<{\n      // The ID of the status group.\n      id: string\n      // The name of the status group.\n      name: string\n      // The color of the status group.\n      color: SelectColor\n      // The IDs of the status options in this group.\n      option_ids: Array<string>\n    }>\n  }\n}\n\ntype StatusPropertyResponse = {\n  // The ID of the status option.\n  id: string\n  // The name of the status option.\n  name: string\n  // The color of the status option.\n  color: SelectColor\n  // The description of the status option.\n  description: string | null\n}\n\ntype TitleDatabasePropertyConfigResponse = {\n  // Always `title`\n  type: \"title\"\n  title: EmptyObject\n}\n\ntype UniqueIdDatabasePropertyConfigResponse = {\n  // Always `unique_id`\n  type: \"unique_id\"\n  unique_id: {\n    // The prefix for the unique ID.\n    prefix: string | null\n  }\n}\n\ntype UrlDatabasePropertyConfigResponse = {\n  // Always `url`\n  type: \"url\"\n  url: EmptyObject\n}\n\ntype GetDataSourcePathParameters = {\n  // ID of a Notion data source.\n  data_source_id: IdRequest\n}\n\nexport type GetDataSourceParameters = GetDataSourcePathParameters\n\nexport type GetDataSourceResponse =\n  | PartialDataSourceObjectResponse\n  | DataSourceObjectResponse\n\n/**\n * Retrieve a data source\n */\nexport const getDataSource = {\n  method: \"get\",\n  pathParams: [\"data_source_id\"],\n  queryParams: [],\n  bodyParams: [],\n\n  path: (p: GetDataSourcePathParameters): string =>\n    `data_sources/${p.data_source_id}`,\n} as const\n\ntype UpdateDataSourcePathParameters = {\n  // ID of a Notion data source.\n  data_source_id: IdRequest\n}\n\ntype UpdateDataSourceBodyParameters = {\n  // Title of data source as it appears in Notion.\n  title?: Array<RichTextItemRequest>\n  // Page icon.\n  icon?: PageIconRequest | null\n  // The property schema of the data source. The keys are property names or IDs, and the\n  // values are property configuration objects. Properties set to null will be removed.\n  properties?: Record<\n    string,\n    | ({\n        // The name of the property.\n        name?: string\n        // The description of the property.\n        description?: PropertyDescriptionRequest | null\n      } & (\n        | {\n            // Always `number`\n            type?: \"number\"\n            number: { format?: NumberFormat }\n          }\n        | {\n            // Always `formula`\n            type?: \"formula\"\n            formula: { expression?: string }\n          }\n        | {\n            // Always `select`\n            type?: \"select\"\n            select: {\n              options?: Array<\n                { color?: SelectColor; description?: string | null } & (\n                  | { name: string; id?: string }\n                  | { id: string; name?: string }\n                )\n              >\n            }\n          }\n        | {\n            // Always `multi_select`\n            type?: \"multi_select\"\n            multi_select: {\n              options?: Array<\n                { color?: SelectColor; description?: string | null } & (\n                  | { name: string; id?: string }\n                  | { id: string; name?: string }\n                )\n              >\n            }\n          }\n        | {\n            // Always `status`\n            type?: \"status\"\n            status: StatusPropertyConfigUpdateRequest\n          }\n        | {\n            // Always `relation`\n            type?: \"relation\"\n            relation: { data_source_id: IdRequest } & (\n              | {\n                  // Always `single_property`\n                  type?: \"single_property\"\n                  single_property: EmptyObject\n                }\n              | {\n                  // Always `dual_property`\n                  type?: \"dual_property\"\n                  dual_property: {\n                    synced_property_id?: string\n                    synced_property_name?: string\n                  }\n                }\n            )\n          }\n        | {\n            // Always `rollup`\n            type?: \"rollup\"\n            rollup: {\n              // The function to use for the rollup, e.g. count, count_values, percent_not_empty, max.\n              function: RollupFunction\n            } & (\n              | { relation_property_name: string; rollup_property_name: string }\n              | { relation_property_id: string; rollup_property_name: string }\n              | { relation_property_name: string; rollup_property_id: string }\n              | { relation_property_id: string; rollup_property_id: string }\n            )\n          }\n        | {\n            // Always `unique_id`\n            type?: \"unique_id\"\n            unique_id: { prefix?: string | null }\n          }\n        | {\n            // Always `title`\n            type?: \"title\"\n            title: EmptyObject\n          }\n        | {\n            // Always `rich_text`\n            type?: \"rich_text\"\n            rich_text: EmptyObject\n          }\n        | {\n            // Always `url`\n            type?: \"url\"\n            url: EmptyObject\n          }\n        | {\n            // Always `people`\n            type?: \"people\"\n            people: EmptyObject\n          }\n        | {\n            // Always `files`\n            type?: \"files\"\n            files: EmptyObject\n          }\n        | {\n            // Always `email`\n            type?: \"email\"\n            email: EmptyObject\n          }\n        | {\n            // Always `phone_number`\n            type?: \"phone_number\"\n            phone_number: EmptyObject\n          }\n        | {\n            // Always `date`\n            type?: \"date\"\n            date: EmptyObject\n          }\n        | {\n            // Always `checkbox`\n            type?: \"checkbox\"\n            checkbox: EmptyObject\n          }\n        | {\n            // Always `created_by`\n            type?: \"created_by\"\n            created_by: EmptyObject\n          }\n        | {\n            // Always `created_time`\n            type?: \"created_time\"\n            created_time: EmptyObject\n          }\n        | {\n            // Always `last_edited_by`\n            type?: \"last_edited_by\"\n            last_edited_by: EmptyObject\n          }\n        | {\n            // Always `last_edited_time`\n            type?: \"last_edited_time\"\n            last_edited_time: EmptyObject\n          }\n        | {\n            // Always `place`\n            type?: \"place\"\n            place: EmptyObject\n          }\n      ))\n    | {\n        // The new name of the property.\n        name: string\n      }\n    | null\n  >\n  // Whether the database should be moved to or from the trash. If not provided, the trash\n  // status will not be updated.\n  in_trash?: boolean\n  /** @deprecated Use `in_trash` instead. */\n  archived?: boolean\n  // The parent of the data source, when moving it to a different database. If not\n  // provided, the parent will not be updated.\n  parent?: ParentOfDataSourceRequest\n}\n\nexport type UpdateDataSourceParameters = UpdateDataSourcePathParameters &\n  UpdateDataSourceBodyParameters\n\nexport type UpdateDataSourceResponse =\n  | PartialDataSourceObjectResponse\n  | DataSourceObjectResponse\n\n/**\n * Update a data source\n */\nexport const updateDataSource = {\n  method: \"patch\",\n  pathParams: [\"data_source_id\"],\n  queryParams: [],\n  bodyParams: [\"archived\", \"title\", \"icon\", \"properties\", \"in_trash\", \"parent\"],\n\n  path: (p: UpdateDataSourcePathParameters): string =>\n    `data_sources/${p.data_source_id}`,\n} as const\n\ntype QueryDataSourcePathParameters = {\n  data_source_id: IdRequest\n}\n\ntype QueryDataSourceQueryParameters = {\n  filter_properties?: Array<string>\n}\n\ntype QueryDataSourceBodyParameters = {\n  sorts?: Array<\n    | { property: string; direction: \"ascending\" | \"descending\" }\n    | {\n        timestamp: \"created_time\" | \"last_edited_time\"\n        direction: \"ascending\" | \"descending\"\n      }\n  >\n  filter?:\n    | { or: GroupFilterOperatorArray }\n    | { and: GroupFilterOperatorArray }\n    | PropertyFilter\n    | TimestampFilter\n  start_cursor?: string\n  page_size?: number\n  in_trash?: boolean\n  /** @deprecated Use `in_trash` instead. */\n  archived?: boolean\n  // Optionally filter the results to only include pages or data sources. Regular, non-wiki\n  // databases only support page children. The default behavior is no result type\n  // filtering, in other words, returning both pages and data sources for wikis.\n  result_type?: \"page\" | \"data_source\"\n}\n\nexport type QueryDataSourceParameters = QueryDataSourcePathParameters &\n  QueryDataSourceQueryParameters &\n  QueryDataSourceBodyParameters\n\nexport type QueryDataSourceResponse = {\n  type: \"page_or_data_source\"\n  page_or_data_source: EmptyObject\n  object: \"list\"\n  next_cursor: string | null\n  has_more: boolean\n  results: Array<\n    | PageObjectResponse\n    | PartialPageObjectResponse\n    | PartialDataSourceObjectResponse\n    | DataSourceObjectResponse\n  >\n}\n\n/**\n * Query a data source\n */\nexport const queryDataSource = {\n  method: \"post\",\n  pathParams: [\"data_source_id\"],\n  queryParams: [\"filter_properties\"],\n  bodyParams: [\n    \"archived\",\n    \"sorts\",\n    \"filter\",\n    \"start_cursor\",\n    \"page_size\",\n    \"in_trash\",\n    \"result_type\",\n  ],\n\n  path: (p: QueryDataSourcePathParameters): string =>\n    `data_sources/${p.data_source_id}/query`,\n} as const\n\ntype CreateDataSourceBodyParameters = {\n  // An object specifying the parent of the new data source to be created.\n  parent: ParentOfDataSourceRequest\n  // Property schema of data source.\n  properties: Record<string, PropertyConfigurationRequest>\n  // Title of data source as it appears in Notion.\n  title?: Array<RichTextItemRequest>\n  // Page icon.\n  icon?: PageIconRequest | null\n}\n\nexport type CreateDataSourceParameters = CreateDataSourceBodyParameters\n\nexport type CreateDataSourceResponse =\n  | PartialDataSourceObjectResponse\n  | DataSourceObjectResponse\n\n/**\n * Create a data source\n */\nexport const createDataSource = {\n  method: \"post\",\n  pathParams: [],\n  queryParams: [],\n  bodyParams: [\"parent\", \"properties\", \"title\", \"icon\"],\n\n  path: (): string => `data_sources`,\n} as const\n\ntype ListDataSourceTemplatesPathParameters = {\n  // ID of a Notion data source.\n  data_source_id: IdRequest\n}\n\ntype ListDataSourceTemplatesQueryParameters = {\n  // Filter templates by name (case-insensitive substring match).\n  name?: string\n  // If supplied, this endpoint will return a page of results starting after the cursor\n  // provided. If not supplied, this endpoint will return the first page of results.\n  start_cursor?: string\n  // The number of items from the full list desired in the response. Maximum: 100\n  page_size?: number\n}\n\nexport type ListDataSourceTemplatesParameters =\n  ListDataSourceTemplatesPathParameters & ListDataSourceTemplatesQueryParameters\n\nexport type ListDataSourceTemplatesResponse = {\n  // Array of templates available in this data source.\n  templates: Array<{\n    // ID of the template page.\n    id: IdResponse\n    // Name of the template.\n    name: string\n    // Whether this template is the default template for the data source.\n    is_default: boolean\n  }>\n  // Whether there are more templates available beyond this page.\n  has_more: boolean\n  // Cursor to use for the next page of results. Null if there are no more results.\n  next_cursor: IdResponse | null\n}\n\n/**\n * List templates in a data source\n */\nexport const listDataSourceTemplates = {\n  method: \"get\",\n  pathParams: [\"data_source_id\"],\n  queryParams: [\"name\", \"start_cursor\", \"page_size\"],\n  bodyParams: [],\n\n  path: (p: ListDataSourceTemplatesPathParameters): string =>\n    `data_sources/${p.data_source_id}/templates`,\n} as const\n"]}

package/build/src/api-endpoints/databases.d.ts

@@ -0,0 +1,109 @@
+import type { IdRequest, IdResponse, InitialDataSourceRequest, PageCoverRequest, PageCoverResponse, PageIconRequest, PageIconResponse, ParentOfDatabaseResponse, RichTextItemRequest, RichTextItemResponse } from "./common";
+type DataSourceReferenceResponse = {
+    id: IdResponse;
+    name: string;
+};
+export type DatabaseObjectResponse = {
+    object: "database";
+    id: IdResponse;
+    title: Array<RichTextItemResponse>;
+    description: Array<RichTextItemResponse>;
+    parent: ParentOfDatabaseResponse;
+    is_inline: boolean;
+    in_trash: boolean;
+    /** @deprecated Use `in_trash` instead. Present for backwards compatibility with API versions prior to 2026-03-11. */
+    archived: boolean;
+    is_locked: boolean;
+    created_time: string;
+    last_edited_time: string;
+    data_sources: Array<DataSourceReferenceResponse>;
+    icon: PageIconResponse | null;
+    cover: PageCoverResponse | null;
+    url: string;
+    public_url: string | null;
+};
+export type PartialDatabaseObjectResponse = {
+    object: "database";
+    id: IdResponse;
+};
+type GetDatabasePathParameters = {
+    database_id: IdRequest;
+};
+export type GetDatabaseParameters = GetDatabasePathParameters;
+export type GetDatabaseResponse = PartialDatabaseObjectResponse | DatabaseObjectResponse;
+/**
+ * Retrieve a database
+ */
+export declare const getDatabase: {
+    readonly method: "get";
+    readonly pathParams: readonly ["database_id"];
+    readonly queryParams: readonly [];
+    readonly bodyParams: readonly [];
+    readonly path: (p: GetDatabasePathParameters) => string;
+};
+type UpdateDatabasePathParameters = {
+    database_id: IdRequest;
+};
+type UpdateDatabaseBodyParameters = {
+    parent?: {
+        type: "page_id" | "workspace";
+    } & ({
+        type: "page_id";
+        page_id: IdRequest;
+    } | {
+        type: "workspace";
+        workspace: true;
+    });
+    title?: Array<RichTextItemRequest>;
+    description?: Array<RichTextItemRequest>;
+    is_inline?: boolean;
+    icon?: PageIconRequest;
+    cover?: PageCoverRequest;
+    in_trash?: boolean;
+    /** @deprecated Use `in_trash` instead. */
+    archived?: boolean;
+    is_locked?: boolean;
+};
+export type UpdateDatabaseParameters = UpdateDatabasePathParameters & UpdateDatabaseBodyParameters;
+export type UpdateDatabaseResponse = PartialDatabaseObjectResponse | DatabaseObjectResponse;
+/**
+ * Update a database
+ */
+export declare const updateDatabase: {
+    readonly method: "patch";
+    readonly pathParams: readonly ["database_id"];
+    readonly queryParams: readonly [];
+    readonly bodyParams: readonly ["parent", "title", "description", "is_inline", "icon", "cover", "in_trash", "is_locked"];
+    readonly path: (p: UpdateDatabasePathParameters) => string;
+};
+type CreateDatabaseBodyParameters = {
+    parent: {
+        type: "page_id" | "workspace";
+    } & ({
+        type: "page_id";
+        page_id: IdRequest;
+    } | {
+        type: "workspace";
+        workspace: true;
+    });
+    title?: Array<RichTextItemRequest>;
+    description?: Array<RichTextItemRequest>;
+    is_inline?: boolean;
+    initial_data_source?: InitialDataSourceRequest;
+    icon?: PageIconRequest;
+    cover?: PageCoverRequest;
+};
+export type CreateDatabaseParameters = CreateDatabaseBodyParameters;
+export type CreateDatabaseResponse = PartialDatabaseObjectResponse | DatabaseObjectResponse;
+/**
+ * Create a database
+ */
+export declare const createDatabase: {
+    readonly method: "post";
+    readonly pathParams: readonly [];
+    readonly queryParams: readonly [];
+    readonly bodyParams: readonly ["parent", "title", "description", "is_inline", "initial_data_source", "icon", "cover"];
+    readonly path: () => string;
+};
+export {};
+//# sourceMappingURL=databases.d.ts.map