@notionhq/client 5.13.0 → 5.14.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.
- package/build/package.json +1 -1
- package/build/src/Client.d.ts +37 -1
- package/build/src/Client.d.ts.map +1 -1
- package/build/src/Client.js +124 -0
- package/build/src/Client.js.map +1 -1
- package/build/src/api-endpoints.d.ts +841 -3
- package/build/src/api-endpoints.d.ts.map +1 -1
- package/build/src/api-endpoints.js +82 -1
- package/build/src/api-endpoints.js.map +1 -1
- package/build/src/helpers.d.ts +5 -1
- package/build/src/helpers.d.ts.map +1 -1
- package/build/src/helpers.js +7 -0
- package/build/src/helpers.js.map +1 -1
- package/build/src/index.d.ts +2 -2
- package/build/src/index.d.ts.map +1 -1
- package/build/src/index.js +2 -1
- package/build/src/index.js.map +1 -1
- package/package.json +1 -1
|
@@ -513,6 +513,26 @@ type BlockObjectWithSingleLevelOfChildrenRequest = {
|
|
|
513
513
|
type?: "synced_block";
|
|
514
514
|
object?: "block";
|
|
515
515
|
};
|
|
516
|
+
type BoardViewConfigRequest = {
|
|
517
|
+
type: "board";
|
|
518
|
+
group_by: GroupByConfigRequest;
|
|
519
|
+
sub_group_by?: GroupByConfigRequest | null;
|
|
520
|
+
properties?: Array<ViewPropertyConfigRequest> | null;
|
|
521
|
+
cover?: CoverConfigRequest | null;
|
|
522
|
+
cover_size?: "small" | "medium" | "large" | null;
|
|
523
|
+
cover_aspect?: "contain" | "cover" | null;
|
|
524
|
+
card_layout?: "list" | "compact" | null;
|
|
525
|
+
};
|
|
526
|
+
type BoardViewConfigResponse = {
|
|
527
|
+
type: "board";
|
|
528
|
+
group_by: GroupByConfigResponse;
|
|
529
|
+
sub_group_by?: GroupByConfigResponse;
|
|
530
|
+
properties?: Array<ViewPropertyConfigResponse>;
|
|
531
|
+
cover?: CoverConfigResponse;
|
|
532
|
+
cover_size?: "small" | "medium" | "large";
|
|
533
|
+
cover_aspect?: "contain" | "cover";
|
|
534
|
+
card_layout?: "list" | "compact";
|
|
535
|
+
};
|
|
516
536
|
export type BookmarkBlockObjectResponse = {
|
|
517
537
|
type: "bookmark";
|
|
518
538
|
bookmark: MediaContentWithUrlAndCaptionResponse;
|
|
@@ -607,6 +627,21 @@ type ButtonSimplePropertyValueResponse = {
|
|
|
607
627
|
type: "button";
|
|
608
628
|
button: EmptyObject;
|
|
609
629
|
};
|
|
630
|
+
type CalendarViewConfigRequest = {
|
|
631
|
+
type: "calendar";
|
|
632
|
+
date_property_id: string;
|
|
633
|
+
properties?: Array<ViewPropertyConfigRequest> | null;
|
|
634
|
+
view_range?: "week" | "month" | null;
|
|
635
|
+
show_weekends?: boolean | null;
|
|
636
|
+
};
|
|
637
|
+
type CalendarViewConfigResponse = {
|
|
638
|
+
type: "calendar";
|
|
639
|
+
date_property_id: string;
|
|
640
|
+
date_property_name?: string;
|
|
641
|
+
properties?: Array<ViewPropertyConfigResponse>;
|
|
642
|
+
view_range?: "week" | "month";
|
|
643
|
+
show_weekends?: boolean;
|
|
644
|
+
};
|
|
610
645
|
export type CalloutBlockObjectResponse = {
|
|
611
646
|
type: "callout";
|
|
612
647
|
callout: {
|
|
@@ -626,10 +661,103 @@ export type CalloutBlockObjectResponse = {
|
|
|
626
661
|
/** @deprecated Use `in_trash` instead. Present for backwards compatibility with API versions prior to 2026-03-11. */
|
|
627
662
|
archived: boolean;
|
|
628
663
|
};
|
|
664
|
+
type ChartAggregationRequest = {
|
|
665
|
+
aggregator: "count" | "count_values" | "sum" | "average" | "median" | "min" | "max" | "range" | "unique" | "empty" | "not_empty" | "percent_empty" | "percent_not_empty" | "checked" | "unchecked" | "percent_checked" | "percent_unchecked" | "earliest_date" | "latest_date" | "date_range";
|
|
666
|
+
property_id?: string;
|
|
667
|
+
};
|
|
668
|
+
type ChartAggregationResponse = {
|
|
669
|
+
aggregator: "count" | "count_values" | "sum" | "average" | "median" | "min" | "max" | "range" | "unique" | "empty" | "not_empty" | "percent_empty" | "percent_not_empty" | "checked" | "unchecked" | "percent_checked" | "percent_unchecked" | "earliest_date" | "latest_date" | "date_range";
|
|
670
|
+
property_id?: string;
|
|
671
|
+
};
|
|
672
|
+
type ChartReferenceLineRequest = {
|
|
673
|
+
value: number;
|
|
674
|
+
label: string;
|
|
675
|
+
color: "gray" | "lightgray" | "brown" | "yellow" | "orange" | "green" | "blue" | "purple" | "pink" | "red";
|
|
676
|
+
dash_style: "solid" | "dash";
|
|
677
|
+
id?: string;
|
|
678
|
+
};
|
|
679
|
+
type ChartReferenceLineResponse = {
|
|
680
|
+
id: string;
|
|
681
|
+
value: number;
|
|
682
|
+
label: string;
|
|
683
|
+
color: "gray" | "lightgray" | "brown" | "yellow" | "orange" | "green" | "blue" | "purple" | "pink" | "red";
|
|
684
|
+
dash_style: "solid" | "dash";
|
|
685
|
+
};
|
|
686
|
+
type ChartViewConfigRequest = {
|
|
687
|
+
type: "chart";
|
|
688
|
+
chart_type: "column" | "bar" | "line" | "donut" | "number";
|
|
689
|
+
x_axis?: GroupByConfigRequest | null;
|
|
690
|
+
y_axis?: ChartAggregationRequest | null;
|
|
691
|
+
x_axis_property_id?: string | null;
|
|
692
|
+
y_axis_property_id?: string | null;
|
|
693
|
+
value?: ChartAggregationRequest | null;
|
|
694
|
+
sort?: "manual" | "x_ascending" | "x_descending" | "y_ascending" | "y_descending" | null;
|
|
695
|
+
color_theme?: "gray" | "blue" | "yellow" | "green" | "purple" | "teal" | "orange" | "pink" | "red" | "auto" | "colorful" | null;
|
|
696
|
+
height?: "small" | "medium" | "large" | "extra_large" | null;
|
|
697
|
+
hide_empty_groups?: boolean | null;
|
|
698
|
+
legend_position?: "off" | "bottom" | "side" | null;
|
|
699
|
+
show_data_labels?: boolean | null;
|
|
700
|
+
axis_labels?: "none" | "x_axis" | "y_axis" | "both" | null;
|
|
701
|
+
grid_lines?: "none" | "horizontal" | "vertical" | "both" | null;
|
|
702
|
+
cumulative?: boolean | null;
|
|
703
|
+
smooth_line?: boolean | null;
|
|
704
|
+
hide_line_fill_area?: boolean | null;
|
|
705
|
+
group_style?: "normal" | "percent" | "side_by_side" | null;
|
|
706
|
+
y_axis_min?: number | null;
|
|
707
|
+
y_axis_max?: number | null;
|
|
708
|
+
donut_labels?: "none" | "value" | "name" | "name_and_value" | null;
|
|
709
|
+
hide_title?: boolean | null;
|
|
710
|
+
stack_by?: GroupByConfigRequest | null;
|
|
711
|
+
reference_lines?: Array<ChartReferenceLineRequest> | null;
|
|
712
|
+
caption?: string | null;
|
|
713
|
+
color_by_value?: boolean | null;
|
|
714
|
+
};
|
|
715
|
+
type ChartViewConfigResponse = {
|
|
716
|
+
type: "chart";
|
|
717
|
+
chart_type: "column" | "bar" | "line" | "donut" | "number";
|
|
718
|
+
x_axis?: GroupByConfigResponse | null;
|
|
719
|
+
y_axis?: ChartAggregationResponse | null;
|
|
720
|
+
x_axis_property_id?: string;
|
|
721
|
+
y_axis_property_id?: string;
|
|
722
|
+
value?: ChartAggregationResponse;
|
|
723
|
+
sort?: "manual" | "x_ascending" | "x_descending" | "y_ascending" | "y_descending";
|
|
724
|
+
color_theme?: "gray" | "blue" | "yellow" | "green" | "purple" | "teal" | "orange" | "pink" | "red" | "auto" | "colorful";
|
|
725
|
+
height?: "small" | "medium" | "large" | "extra_large";
|
|
726
|
+
hide_empty_groups?: boolean;
|
|
727
|
+
legend_position?: "off" | "bottom" | "side";
|
|
728
|
+
show_data_labels?: boolean;
|
|
729
|
+
axis_labels?: "none" | "x_axis" | "y_axis" | "both";
|
|
730
|
+
grid_lines?: "none" | "horizontal" | "vertical" | "both";
|
|
731
|
+
cumulative?: boolean;
|
|
732
|
+
smooth_line?: boolean;
|
|
733
|
+
hide_line_fill_area?: boolean;
|
|
734
|
+
group_style?: "normal" | "percent" | "side_by_side";
|
|
735
|
+
y_axis_min?: number | null;
|
|
736
|
+
y_axis_max?: number | null;
|
|
737
|
+
donut_labels?: "none" | "value" | "name" | "name_and_value";
|
|
738
|
+
hide_title?: boolean;
|
|
739
|
+
stack_by?: GroupByConfigResponse | null;
|
|
740
|
+
reference_lines?: Array<ChartReferenceLineResponse> | null;
|
|
741
|
+
caption?: string | null;
|
|
742
|
+
color_by_value?: boolean;
|
|
743
|
+
};
|
|
629
744
|
type CheckboxDatabasePropertyConfigResponse = {
|
|
630
745
|
type: "checkbox";
|
|
631
746
|
checkbox: EmptyObject;
|
|
632
747
|
};
|
|
748
|
+
type CheckboxGroupByConfigRequest = {
|
|
749
|
+
type: "checkbox";
|
|
750
|
+
property_id: string;
|
|
751
|
+
sort: GroupSortRequest;
|
|
752
|
+
hide_empty_groups?: boolean;
|
|
753
|
+
};
|
|
754
|
+
type CheckboxGroupByConfigResponse = {
|
|
755
|
+
type: "checkbox";
|
|
756
|
+
property_id: string;
|
|
757
|
+
sort: GroupSortResponse;
|
|
758
|
+
property_name?: string;
|
|
759
|
+
hide_empty_groups?: boolean;
|
|
760
|
+
};
|
|
633
761
|
type CheckboxPropertyConfigurationRequest = {
|
|
634
762
|
type?: "checkbox";
|
|
635
763
|
checkbox: EmptyObject;
|
|
@@ -808,6 +936,41 @@ type ContentWithTableRowRequest = {
|
|
|
808
936
|
type ContentWithTableRowResponse = {
|
|
809
937
|
cells: Array<Array<RichTextItemResponse>>;
|
|
810
938
|
};
|
|
939
|
+
type CoverConfigRequest = {
|
|
940
|
+
type: "page_cover" | "page_content" | "property";
|
|
941
|
+
property_id?: string;
|
|
942
|
+
};
|
|
943
|
+
type CoverConfigResponse = {
|
|
944
|
+
type: "page_cover" | "page_content" | "page_content_first" | "property";
|
|
945
|
+
property_id?: string;
|
|
946
|
+
};
|
|
947
|
+
type CreateDatabaseForViewRequest = {
|
|
948
|
+
parent: {
|
|
949
|
+
type: "page_id";
|
|
950
|
+
page_id: IdRequest;
|
|
951
|
+
};
|
|
952
|
+
position?: {
|
|
953
|
+
type: "after_block";
|
|
954
|
+
block_id: IdRequest;
|
|
955
|
+
};
|
|
956
|
+
};
|
|
957
|
+
type CreateViewQueryRequest = {
|
|
958
|
+
page_size?: number;
|
|
959
|
+
};
|
|
960
|
+
type CreateViewRequest = {
|
|
961
|
+
data_source_id: IdRequest;
|
|
962
|
+
name: string;
|
|
963
|
+
type: ViewTypeRequest;
|
|
964
|
+
database_id?: IdRequest;
|
|
965
|
+
view_id?: IdRequest;
|
|
966
|
+
filter?: ViewFilterRequest;
|
|
967
|
+
sorts?: ViewSortsRequest;
|
|
968
|
+
quick_filters?: Record<string, QuickFilterConditionRequest>;
|
|
969
|
+
create_database?: CreateDatabaseForViewRequest;
|
|
970
|
+
configuration?: ViewConfigRequest;
|
|
971
|
+
position?: ViewPositionRequest;
|
|
972
|
+
placement?: WidgetPlacementRequest;
|
|
973
|
+
};
|
|
811
974
|
type CreatedByDatabasePropertyConfigResponse = {
|
|
812
975
|
type: "created_by";
|
|
813
976
|
created_by: EmptyObject;
|
|
@@ -861,6 +1024,21 @@ type CustomEmojiResponse = {
|
|
|
861
1024
|
name: string;
|
|
862
1025
|
url: string;
|
|
863
1026
|
};
|
|
1027
|
+
export type DashboardRowResponse = {
|
|
1028
|
+
id: string;
|
|
1029
|
+
widgets: Array<DashboardWidgetResponse>;
|
|
1030
|
+
height?: number;
|
|
1031
|
+
};
|
|
1032
|
+
type DashboardViewConfigResponse = {
|
|
1033
|
+
type: "dashboard";
|
|
1034
|
+
rows: Array<DashboardRowResponse>;
|
|
1035
|
+
};
|
|
1036
|
+
export type DashboardWidgetResponse = {
|
|
1037
|
+
id: string;
|
|
1038
|
+
view_id: string;
|
|
1039
|
+
width?: number;
|
|
1040
|
+
row_index?: number;
|
|
1041
|
+
};
|
|
864
1042
|
export type DataSourceObjectResponse = {
|
|
865
1043
|
object: "data_source";
|
|
866
1044
|
id: IdResponse;
|
|
@@ -891,6 +1069,28 @@ type DataSourceReferenceResponse = {
|
|
|
891
1069
|
id: IdResponse;
|
|
892
1070
|
name: string;
|
|
893
1071
|
};
|
|
1072
|
+
export type DataSourceViewObjectResponse = {
|
|
1073
|
+
object: "view";
|
|
1074
|
+
id: IdResponse;
|
|
1075
|
+
parent: DatabaseParentResponse;
|
|
1076
|
+
name: string;
|
|
1077
|
+
type: "table" | "board" | "list" | "calendar" | "timeline" | "gallery" | "form" | "chart" | "map" | "dashboard";
|
|
1078
|
+
created_time: string;
|
|
1079
|
+
last_edited_time: string;
|
|
1080
|
+
url: string;
|
|
1081
|
+
data_source_id?: string | null;
|
|
1082
|
+
created_by?: PartialUserObjectResponse | null;
|
|
1083
|
+
last_edited_by?: PartialUserObjectResponse | null;
|
|
1084
|
+
filter?: ViewFilterResponse | null;
|
|
1085
|
+
sorts?: Array<ViewSortResponse> | null;
|
|
1086
|
+
quick_filters?: Record<string, QuickFilterConditionResponse> | null;
|
|
1087
|
+
configuration?: ViewConfigResponse | null;
|
|
1088
|
+
dashboard_view_id?: string;
|
|
1089
|
+
};
|
|
1090
|
+
type DataSourceViewReferenceResponse = {
|
|
1091
|
+
object: "view";
|
|
1092
|
+
id: IdResponse;
|
|
1093
|
+
};
|
|
894
1094
|
export type DatabaseObjectResponse = {
|
|
895
1095
|
object: "database";
|
|
896
1096
|
id: IdResponse;
|
|
@@ -937,6 +1137,23 @@ type DateFormulaPropertyValueResponse = {
|
|
|
937
1137
|
type: "date";
|
|
938
1138
|
date: DateResponse | null;
|
|
939
1139
|
};
|
|
1140
|
+
type DateGroupByConfigRequest = {
|
|
1141
|
+
type: "date" | "created_time" | "last_edited_time";
|
|
1142
|
+
property_id: string;
|
|
1143
|
+
group_by: "relative" | "day" | "week" | "month" | "year";
|
|
1144
|
+
sort: GroupSortRequest;
|
|
1145
|
+
hide_empty_groups?: boolean;
|
|
1146
|
+
start_day_of_week?: 0 | 1;
|
|
1147
|
+
};
|
|
1148
|
+
type DateGroupByConfigResponse = {
|
|
1149
|
+
type: "date" | "created_time" | "last_edited_time";
|
|
1150
|
+
property_id: string;
|
|
1151
|
+
group_by: "relative" | "day" | "week" | "month" | "year";
|
|
1152
|
+
sort: GroupSortResponse;
|
|
1153
|
+
property_name?: string;
|
|
1154
|
+
hide_empty_groups?: boolean;
|
|
1155
|
+
start_day_of_week?: 0 | 1;
|
|
1156
|
+
};
|
|
940
1157
|
type DatePartialRollupValueResponse = {
|
|
941
1158
|
type: "date";
|
|
942
1159
|
date: DateResponse | null;
|
|
@@ -990,6 +1207,11 @@ type DateSimplePropertyValueResponse = {
|
|
|
990
1207
|
type: "date";
|
|
991
1208
|
date: DateResponse | null;
|
|
992
1209
|
};
|
|
1210
|
+
export type DeletedViewQueryResponse = {
|
|
1211
|
+
object: "view_query";
|
|
1212
|
+
id: IdResponse;
|
|
1213
|
+
deleted: boolean;
|
|
1214
|
+
};
|
|
993
1215
|
export type DividerBlockObjectResponse = {
|
|
994
1216
|
type: "divider";
|
|
995
1217
|
divider: EmptyObject;
|
|
@@ -1253,12 +1475,71 @@ type FilesSimplePropertyValueResponse = {
|
|
|
1253
1475
|
type: "files";
|
|
1254
1476
|
files: Array<InternalOrExternalFileWithNameResponse>;
|
|
1255
1477
|
};
|
|
1478
|
+
type FormViewConfigRequest = {
|
|
1479
|
+
type: "form";
|
|
1480
|
+
is_form_closed?: boolean | null;
|
|
1481
|
+
anonymous_submissions?: boolean | null;
|
|
1482
|
+
submission_permissions?: "none" | "comment_only" | "reader" | "read_and_write" | "editor" | null;
|
|
1483
|
+
};
|
|
1484
|
+
type FormViewConfigResponse = {
|
|
1485
|
+
type: "form";
|
|
1486
|
+
is_form_closed?: boolean;
|
|
1487
|
+
anonymous_submissions?: boolean;
|
|
1488
|
+
submission_permissions?: "none" | "comment_only" | "reader" | "read_and_write" | "editor";
|
|
1489
|
+
};
|
|
1490
|
+
type FormulaCheckboxSubGroupByRequest = {
|
|
1491
|
+
type: "checkbox";
|
|
1492
|
+
sort: GroupSortRequest;
|
|
1493
|
+
};
|
|
1494
|
+
type FormulaCheckboxSubGroupByResponse = {
|
|
1495
|
+
type: "checkbox";
|
|
1496
|
+
sort: GroupSortResponse;
|
|
1497
|
+
};
|
|
1256
1498
|
type FormulaDatabasePropertyConfigResponse = {
|
|
1257
1499
|
type: "formula";
|
|
1258
1500
|
formula: {
|
|
1259
1501
|
expression: string;
|
|
1260
1502
|
};
|
|
1261
1503
|
};
|
|
1504
|
+
type FormulaDateSubGroupByRequest = {
|
|
1505
|
+
type: "date";
|
|
1506
|
+
group_by: "relative" | "day" | "week" | "month" | "year";
|
|
1507
|
+
sort: GroupSortRequest;
|
|
1508
|
+
start_day_of_week?: 0 | 1;
|
|
1509
|
+
};
|
|
1510
|
+
type FormulaDateSubGroupByResponse = {
|
|
1511
|
+
type: "date";
|
|
1512
|
+
group_by: "relative" | "day" | "week" | "month" | "year";
|
|
1513
|
+
sort: GroupSortResponse;
|
|
1514
|
+
start_day_of_week?: 0 | 1;
|
|
1515
|
+
};
|
|
1516
|
+
type FormulaGroupByConfigRequest = {
|
|
1517
|
+
type: "formula";
|
|
1518
|
+
property_id: string;
|
|
1519
|
+
group_by: FormulaDateSubGroupByRequest | FormulaTextSubGroupByRequest | FormulaNumberSubGroupByRequest | FormulaCheckboxSubGroupByRequest;
|
|
1520
|
+
hide_empty_groups?: boolean;
|
|
1521
|
+
};
|
|
1522
|
+
type FormulaGroupByConfigResponse = {
|
|
1523
|
+
type: "formula";
|
|
1524
|
+
property_id: string;
|
|
1525
|
+
group_by: FormulaSubGroupByResponse;
|
|
1526
|
+
property_name?: string;
|
|
1527
|
+
hide_empty_groups?: boolean;
|
|
1528
|
+
};
|
|
1529
|
+
type FormulaNumberSubGroupByRequest = {
|
|
1530
|
+
type: "number";
|
|
1531
|
+
sort: GroupSortRequest;
|
|
1532
|
+
range_start?: number;
|
|
1533
|
+
range_end?: number;
|
|
1534
|
+
range_size?: number;
|
|
1535
|
+
};
|
|
1536
|
+
type FormulaNumberSubGroupByResponse = {
|
|
1537
|
+
type: "number";
|
|
1538
|
+
sort: GroupSortResponse;
|
|
1539
|
+
range_start?: number;
|
|
1540
|
+
range_end?: number;
|
|
1541
|
+
range_size?: number;
|
|
1542
|
+
};
|
|
1262
1543
|
type FormulaPropertyConfigurationRequest = {
|
|
1263
1544
|
type?: "formula";
|
|
1264
1545
|
formula: {
|
|
@@ -1286,6 +1567,44 @@ type FormulaSimplePropertyValueResponse = {
|
|
|
1286
1567
|
type: "formula";
|
|
1287
1568
|
formula: FormulaPropertyValueResponse;
|
|
1288
1569
|
};
|
|
1570
|
+
/**
|
|
1571
|
+
* Sub-group-by configuration for formula properties based on result type.
|
|
1572
|
+
*/
|
|
1573
|
+
type FormulaSubGroupByResponse = FormulaDateSubGroupByResponse | FormulaTextSubGroupByResponse | FormulaNumberSubGroupByResponse | FormulaCheckboxSubGroupByResponse;
|
|
1574
|
+
type FormulaTextSubGroupByRequest = {
|
|
1575
|
+
type: "text";
|
|
1576
|
+
group_by: "exact" | "alphabet_prefix";
|
|
1577
|
+
sort: GroupSortRequest;
|
|
1578
|
+
};
|
|
1579
|
+
type FormulaTextSubGroupByResponse = {
|
|
1580
|
+
type: "text";
|
|
1581
|
+
group_by: "exact" | "alphabet_prefix";
|
|
1582
|
+
sort: GroupSortResponse;
|
|
1583
|
+
};
|
|
1584
|
+
type GalleryViewConfigRequest = {
|
|
1585
|
+
type: "gallery";
|
|
1586
|
+
properties?: Array<ViewPropertyConfigRequest> | null;
|
|
1587
|
+
cover?: CoverConfigRequest | null;
|
|
1588
|
+
cover_size?: "small" | "medium" | "large" | null;
|
|
1589
|
+
cover_aspect?: "contain" | "cover" | null;
|
|
1590
|
+
card_layout?: "list" | "compact" | null;
|
|
1591
|
+
};
|
|
1592
|
+
type GalleryViewConfigResponse = {
|
|
1593
|
+
type: "gallery";
|
|
1594
|
+
properties?: Array<ViewPropertyConfigResponse>;
|
|
1595
|
+
cover?: CoverConfigResponse;
|
|
1596
|
+
cover_size?: "small" | "medium" | "large";
|
|
1597
|
+
cover_aspect?: "contain" | "cover";
|
|
1598
|
+
card_layout?: "list" | "compact";
|
|
1599
|
+
};
|
|
1600
|
+
/**
|
|
1601
|
+
* Group-by configuration based on property type.
|
|
1602
|
+
*/
|
|
1603
|
+
type GroupByConfigRequest = SelectGroupByConfigRequest | StatusGroupByConfigRequest | PersonGroupByConfigRequest | RelationGroupByConfigRequest | DateGroupByConfigRequest | TextGroupByConfigRequest | NumberGroupByConfigRequest | CheckboxGroupByConfigRequest | FormulaGroupByConfigRequest;
|
|
1604
|
+
/**
|
|
1605
|
+
* Group-by configuration based on property type.
|
|
1606
|
+
*/
|
|
1607
|
+
type GroupByConfigResponse = SelectGroupByConfigResponse | StatusGroupByConfigResponse | PersonGroupByConfigResponse | RelationGroupByConfigResponse | DateGroupByConfigResponse | TextGroupByConfigResponse | NumberGroupByConfigResponse | CheckboxGroupByConfigResponse | FormulaGroupByConfigResponse;
|
|
1289
1608
|
type GroupFilterOperatorArray = Array<PropertyOrTimestampFilter | {
|
|
1290
1609
|
or: PropertyOrTimestampFilterArray;
|
|
1291
1610
|
} | {
|
|
@@ -1301,6 +1620,12 @@ export type GroupObjectResponse = {
|
|
|
1301
1620
|
object: "group";
|
|
1302
1621
|
name: string | null;
|
|
1303
1622
|
};
|
|
1623
|
+
type GroupSortRequest = {
|
|
1624
|
+
type: "manual" | "ascending" | "descending";
|
|
1625
|
+
};
|
|
1626
|
+
type GroupSortResponse = {
|
|
1627
|
+
type: "manual" | "ascending" | "descending";
|
|
1628
|
+
};
|
|
1304
1629
|
type HeaderContentWithRichTextAndColorRequest = {
|
|
1305
1630
|
rich_text: Array<RichTextItemRequest>;
|
|
1306
1631
|
color?: ApiColor;
|
|
@@ -1502,10 +1827,31 @@ export type LinkToPageBlockObjectResponse = {
|
|
|
1502
1827
|
/** @deprecated Use `in_trash` instead. Present for backwards compatibility with API versions prior to 2026-03-11. */
|
|
1503
1828
|
archived: boolean;
|
|
1504
1829
|
};
|
|
1830
|
+
type ListViewConfigRequest = {
|
|
1831
|
+
type: "list";
|
|
1832
|
+
properties?: Array<ViewPropertyConfigRequest> | null;
|
|
1833
|
+
};
|
|
1834
|
+
type ListViewConfigResponse = {
|
|
1835
|
+
type: "list";
|
|
1836
|
+
properties?: Array<ViewPropertyConfigResponse>;
|
|
1837
|
+
};
|
|
1505
1838
|
type LocationPropertyConfigurationRequest = {
|
|
1506
1839
|
type?: "location";
|
|
1507
1840
|
location: EmptyObject;
|
|
1508
1841
|
};
|
|
1842
|
+
type MapViewConfigRequest = {
|
|
1843
|
+
type: "map";
|
|
1844
|
+
height?: "small" | "medium" | "large" | "extra_large" | null;
|
|
1845
|
+
map_by?: string | null;
|
|
1846
|
+
properties?: Array<ViewPropertyConfigRequest> | null;
|
|
1847
|
+
};
|
|
1848
|
+
type MapViewConfigResponse = {
|
|
1849
|
+
type: "map";
|
|
1850
|
+
height?: "small" | "medium" | "large" | "extra_large";
|
|
1851
|
+
map_by?: string;
|
|
1852
|
+
map_by_property_name?: string;
|
|
1853
|
+
properties?: Array<ViewPropertyConfigResponse>;
|
|
1854
|
+
};
|
|
1509
1855
|
type MediaContentWithFileAndCaptionRequest = {
|
|
1510
1856
|
external: ExternalFileRequest;
|
|
1511
1857
|
type?: "external";
|
|
@@ -1680,6 +2026,25 @@ type NumberFormulaPropertyValueResponse = {
|
|
|
1680
2026
|
type: "number";
|
|
1681
2027
|
number: number | null;
|
|
1682
2028
|
};
|
|
2029
|
+
type NumberGroupByConfigRequest = {
|
|
2030
|
+
type: "number";
|
|
2031
|
+
property_id: string;
|
|
2032
|
+
sort: GroupSortRequest;
|
|
2033
|
+
hide_empty_groups?: boolean;
|
|
2034
|
+
range_start?: number;
|
|
2035
|
+
range_end?: number;
|
|
2036
|
+
range_size?: number;
|
|
2037
|
+
};
|
|
2038
|
+
type NumberGroupByConfigResponse = {
|
|
2039
|
+
type: "number";
|
|
2040
|
+
property_id: string;
|
|
2041
|
+
sort: GroupSortResponse;
|
|
2042
|
+
property_name?: string;
|
|
2043
|
+
hide_empty_groups?: boolean;
|
|
2044
|
+
range_start?: number;
|
|
2045
|
+
range_end?: number;
|
|
2046
|
+
range_size?: number;
|
|
2047
|
+
};
|
|
1683
2048
|
type NumberPartialRollupValueResponse = {
|
|
1684
2049
|
type: "number";
|
|
1685
2050
|
number: number | null;
|
|
@@ -1756,6 +2121,7 @@ export type PageObjectResponse = {
|
|
|
1756
2121
|
in_trash: boolean;
|
|
1757
2122
|
/** @deprecated Use `in_trash` instead. Present for backwards compatibility with API versions prior to 2026-03-11. */
|
|
1758
2123
|
archived: boolean;
|
|
2124
|
+
is_archived: boolean;
|
|
1759
2125
|
is_locked: boolean;
|
|
1760
2126
|
url: string;
|
|
1761
2127
|
public_url: string | null;
|
|
@@ -1777,6 +2143,10 @@ type PagePositionSchema = {
|
|
|
1777
2143
|
type: "page_end";
|
|
1778
2144
|
};
|
|
1779
2145
|
type PagePropertyValueWithIdResponse = IdObjectResponse & (SimpleOrArrayPropertyValueResponse | PartialRollupPropertyResponse);
|
|
2146
|
+
type PageReferenceResponse = {
|
|
2147
|
+
object: string;
|
|
2148
|
+
id: IdResponse;
|
|
2149
|
+
};
|
|
1780
2150
|
export type ParagraphBlockObjectResponse = {
|
|
1781
2151
|
type: "paragraph";
|
|
1782
2152
|
paragraph: ContentWithRichTextAndColorResponse;
|
|
@@ -1816,6 +2186,12 @@ export type PartialDataSourceObjectResponse = {
|
|
|
1816
2186
|
id: IdResponse;
|
|
1817
2187
|
properties: Record<string, DatabasePropertyConfigResponse>;
|
|
1818
2188
|
};
|
|
2189
|
+
export type PartialDataSourceViewObjectResponse = {
|
|
2190
|
+
object: "view";
|
|
2191
|
+
id: IdResponse;
|
|
2192
|
+
parent: DatabaseParentResponse;
|
|
2193
|
+
type: "table" | "board" | "list" | "calendar" | "timeline" | "gallery" | "form" | "chart" | "map" | "dashboard";
|
|
2194
|
+
};
|
|
1819
2195
|
export type PartialDatabaseObjectResponse = {
|
|
1820
2196
|
object: "database";
|
|
1821
2197
|
id: IdResponse;
|
|
@@ -1888,6 +2264,19 @@ export type PeoplePropertyItemObjectResponse = {
|
|
|
1888
2264
|
object: "property_item";
|
|
1889
2265
|
id: string;
|
|
1890
2266
|
};
|
|
2267
|
+
type PersonGroupByConfigRequest = {
|
|
2268
|
+
type: "person" | "created_by" | "last_edited_by";
|
|
2269
|
+
property_id: string;
|
|
2270
|
+
sort: GroupSortRequest;
|
|
2271
|
+
hide_empty_groups?: boolean;
|
|
2272
|
+
};
|
|
2273
|
+
type PersonGroupByConfigResponse = {
|
|
2274
|
+
type: "person" | "created_by" | "last_edited_by";
|
|
2275
|
+
property_id: string;
|
|
2276
|
+
sort: GroupSortResponse;
|
|
2277
|
+
property_name?: string;
|
|
2278
|
+
hide_empty_groups?: boolean;
|
|
2279
|
+
};
|
|
1891
2280
|
export type PersonUserObjectResponse = {
|
|
1892
2281
|
type: "person";
|
|
1893
2282
|
person: {
|
|
@@ -2092,6 +2481,21 @@ type PropertyItemPropertyItemListResponse = {
|
|
|
2092
2481
|
};
|
|
2093
2482
|
type PropertyOrTimestampFilter = PropertyFilter | TimestampFilter;
|
|
2094
2483
|
type PropertyOrTimestampFilterArray = Array<PropertyOrTimestampFilter>;
|
|
2484
|
+
type PropertySortResponse = {
|
|
2485
|
+
property: string;
|
|
2486
|
+
direction: "ascending" | "descending";
|
|
2487
|
+
};
|
|
2488
|
+
/**
|
|
2489
|
+
* A property filter condition. Same shape as a property filter but without the
|
|
2490
|
+
* "property" field (the hashmap key identifies the property). For example: { "select": {
|
|
2491
|
+
* "equals": "High" } }.
|
|
2492
|
+
*/
|
|
2493
|
+
type QuickFilterConditionRequest = Record<string, never>;
|
|
2494
|
+
/**
|
|
2495
|
+
* A property filter condition. Same shape as a property filter but without the
|
|
2496
|
+
* "property" field. For example: { "select": { "equals": "High" } }.
|
|
2497
|
+
*/
|
|
2498
|
+
type QuickFilterConditionResponse = Record<string, never>;
|
|
2095
2499
|
export type QuoteBlockObjectResponse = {
|
|
2096
2500
|
type: "quote";
|
|
2097
2501
|
quote: ContentWithRichTextAndColorResponse;
|
|
@@ -2115,6 +2519,19 @@ type RelationDatabasePropertyConfigResponse = {
|
|
|
2115
2519
|
type: "relation";
|
|
2116
2520
|
relation: DatabasePropertyRelationConfigResponse;
|
|
2117
2521
|
};
|
|
2522
|
+
type RelationGroupByConfigRequest = {
|
|
2523
|
+
type: "relation";
|
|
2524
|
+
property_id: string;
|
|
2525
|
+
sort: GroupSortRequest;
|
|
2526
|
+
hide_empty_groups?: boolean;
|
|
2527
|
+
};
|
|
2528
|
+
type RelationGroupByConfigResponse = {
|
|
2529
|
+
type: "relation";
|
|
2530
|
+
property_id: string;
|
|
2531
|
+
sort: GroupSortResponse;
|
|
2532
|
+
property_name?: string;
|
|
2533
|
+
hide_empty_groups?: boolean;
|
|
2534
|
+
};
|
|
2118
2535
|
type RelationItemPropertyValueResponse = {
|
|
2119
2536
|
id: IdRequest;
|
|
2120
2537
|
};
|
|
@@ -2272,6 +2689,19 @@ type SelectDatabasePropertyConfigResponse = {
|
|
|
2272
2689
|
options: Array<SelectPropertyResponse>;
|
|
2273
2690
|
};
|
|
2274
2691
|
};
|
|
2692
|
+
type SelectGroupByConfigRequest = {
|
|
2693
|
+
type: "select" | "multi_select";
|
|
2694
|
+
property_id: string;
|
|
2695
|
+
sort: GroupSortRequest;
|
|
2696
|
+
hide_empty_groups?: boolean;
|
|
2697
|
+
};
|
|
2698
|
+
type SelectGroupByConfigResponse = {
|
|
2699
|
+
type: "select" | "multi_select";
|
|
2700
|
+
property_id: string;
|
|
2701
|
+
sort: GroupSortResponse;
|
|
2702
|
+
property_name?: string;
|
|
2703
|
+
hide_empty_groups?: boolean;
|
|
2704
|
+
};
|
|
2275
2705
|
type SelectPropertyConfigurationRequest = {
|
|
2276
2706
|
type?: "select";
|
|
2277
2707
|
select: {
|
|
@@ -2309,6 +2739,10 @@ type SinglePropertyDatabasePropertyRelationConfigResponse = {
|
|
|
2309
2739
|
type: "single_property";
|
|
2310
2740
|
single_property: EmptyObject;
|
|
2311
2741
|
};
|
|
2742
|
+
/**
|
|
2743
|
+
* One of: `ascending`, `descending`
|
|
2744
|
+
*/
|
|
2745
|
+
type SortDirectionRequest = "ascending" | "descending";
|
|
2312
2746
|
type StatusDatabasePropertyConfigResponse = {
|
|
2313
2747
|
type: "status";
|
|
2314
2748
|
status: {
|
|
@@ -2321,9 +2755,43 @@ type StatusDatabasePropertyConfigResponse = {
|
|
|
2321
2755
|
}>;
|
|
2322
2756
|
};
|
|
2323
2757
|
};
|
|
2758
|
+
type StatusGroupByConfigRequest = {
|
|
2759
|
+
type: "status";
|
|
2760
|
+
property_id: string;
|
|
2761
|
+
group_by: "group" | "option";
|
|
2762
|
+
sort: GroupSortRequest;
|
|
2763
|
+
hide_empty_groups?: boolean;
|
|
2764
|
+
};
|
|
2765
|
+
type StatusGroupByConfigResponse = {
|
|
2766
|
+
type: "status";
|
|
2767
|
+
property_id: string;
|
|
2768
|
+
group_by: "group" | "option";
|
|
2769
|
+
sort: GroupSortResponse;
|
|
2770
|
+
property_name?: string;
|
|
2771
|
+
hide_empty_groups?: boolean;
|
|
2772
|
+
};
|
|
2773
|
+
type StatusPropertyConfigRequest = {
|
|
2774
|
+
options?: Array<{
|
|
2775
|
+
name: string;
|
|
2776
|
+
color?: SelectColor;
|
|
2777
|
+
description?: string | null;
|
|
2778
|
+
}>;
|
|
2779
|
+
};
|
|
2780
|
+
type StatusPropertyConfigUpdateRequest = {
|
|
2781
|
+
options?: Array<{
|
|
2782
|
+
color?: SelectColor;
|
|
2783
|
+
description?: string | null;
|
|
2784
|
+
} & ({
|
|
2785
|
+
name: string;
|
|
2786
|
+
id?: string;
|
|
2787
|
+
} | {
|
|
2788
|
+
id: string;
|
|
2789
|
+
name?: string;
|
|
2790
|
+
})>;
|
|
2791
|
+
};
|
|
2324
2792
|
type StatusPropertyConfigurationRequest = {
|
|
2325
2793
|
type?: "status";
|
|
2326
|
-
status:
|
|
2794
|
+
status: StatusPropertyConfigRequest;
|
|
2327
2795
|
};
|
|
2328
2796
|
type StatusPropertyFilter = {
|
|
2329
2797
|
equals: string;
|
|
@@ -2355,6 +2823,18 @@ type StringFormulaPropertyValueResponse = {
|
|
|
2355
2823
|
string: string | null;
|
|
2356
2824
|
};
|
|
2357
2825
|
type StringRequest = string;
|
|
2826
|
+
type SubtaskConfigRequest = {
|
|
2827
|
+
property_id?: string;
|
|
2828
|
+
display_mode?: "show" | "hidden" | "flattened" | "disabled";
|
|
2829
|
+
filter_scope?: "parents" | "parents_and_subitems" | "subitems";
|
|
2830
|
+
toggle_column_id?: string;
|
|
2831
|
+
};
|
|
2832
|
+
type SubtaskConfigResponse = {
|
|
2833
|
+
property_id?: string;
|
|
2834
|
+
display_mode?: "show" | "hidden" | "flattened" | "disabled";
|
|
2835
|
+
filter_scope?: "parents" | "parents_and_subitems" | "subitems";
|
|
2836
|
+
toggle_column_id?: string;
|
|
2837
|
+
};
|
|
2358
2838
|
export type SyncedBlockBlockObjectResponse = {
|
|
2359
2839
|
type: "synced_block";
|
|
2360
2840
|
synced_block: {
|
|
@@ -2433,6 +2913,24 @@ type TableRowRequest = {
|
|
|
2433
2913
|
type?: "table_row";
|
|
2434
2914
|
object?: "block";
|
|
2435
2915
|
};
|
|
2916
|
+
type TableViewConfigRequest = {
|
|
2917
|
+
type: "table";
|
|
2918
|
+
properties?: Array<ViewPropertyConfigRequest> | null;
|
|
2919
|
+
group_by?: GroupByConfigRequest | null;
|
|
2920
|
+
subtasks?: SubtaskConfigRequest | null;
|
|
2921
|
+
wrap_cells?: boolean;
|
|
2922
|
+
frozen_column_index?: number;
|
|
2923
|
+
show_vertical_lines?: boolean;
|
|
2924
|
+
};
|
|
2925
|
+
type TableViewConfigResponse = {
|
|
2926
|
+
type: "table";
|
|
2927
|
+
properties?: Array<ViewPropertyConfigResponse>;
|
|
2928
|
+
group_by?: GroupByConfigResponse;
|
|
2929
|
+
subtasks?: SubtaskConfigResponse;
|
|
2930
|
+
wrap_cells?: boolean;
|
|
2931
|
+
frozen_column_index?: number;
|
|
2932
|
+
show_vertical_lines?: boolean;
|
|
2933
|
+
};
|
|
2436
2934
|
export type TemplateBlockObjectResponse = {
|
|
2437
2935
|
type: "template";
|
|
2438
2936
|
template: {
|
|
@@ -2474,6 +2972,21 @@ type TemplateMentionUserTemplateMentionResponse = {
|
|
|
2474
2972
|
* integrations, or UTC for internal integrations.
|
|
2475
2973
|
*/
|
|
2476
2974
|
type TemplateTimezone = string;
|
|
2975
|
+
type TextGroupByConfigRequest = {
|
|
2976
|
+
type: "text" | "title" | "url" | "email" | "phone_number";
|
|
2977
|
+
property_id: string;
|
|
2978
|
+
group_by: "exact" | "alphabet_prefix";
|
|
2979
|
+
sort: GroupSortRequest;
|
|
2980
|
+
hide_empty_groups?: boolean;
|
|
2981
|
+
};
|
|
2982
|
+
type TextGroupByConfigResponse = {
|
|
2983
|
+
type: "text" | "title" | "url" | "email" | "phone_number";
|
|
2984
|
+
property_id: string;
|
|
2985
|
+
group_by: "exact" | "alphabet_prefix";
|
|
2986
|
+
sort: GroupSortResponse;
|
|
2987
|
+
property_name?: string;
|
|
2988
|
+
hide_empty_groups?: boolean;
|
|
2989
|
+
};
|
|
2477
2990
|
type TextPropertyFilter = {
|
|
2478
2991
|
equals: string;
|
|
2479
2992
|
} | {
|
|
@@ -2507,6 +3020,44 @@ export type TextRichTextItemResponse = {
|
|
|
2507
3020
|
};
|
|
2508
3021
|
};
|
|
2509
3022
|
type TimeZoneRequest = string;
|
|
3023
|
+
type TimelineArrowsByRequest = {
|
|
3024
|
+
property_id?: string | null;
|
|
3025
|
+
};
|
|
3026
|
+
type TimelineArrowsByResponse = {
|
|
3027
|
+
property_id?: string | null;
|
|
3028
|
+
};
|
|
3029
|
+
type TimelinePreferenceRequest = {
|
|
3030
|
+
zoom_level: "hours" | "day" | "week" | "bi_week" | "month" | "quarter" | "year" | "5_years";
|
|
3031
|
+
center_timestamp?: number;
|
|
3032
|
+
};
|
|
3033
|
+
type TimelinePreferenceResponse = {
|
|
3034
|
+
zoom_level: "hours" | "day" | "week" | "bi_week" | "month" | "quarter" | "year" | "5_years";
|
|
3035
|
+
center_timestamp?: number;
|
|
3036
|
+
};
|
|
3037
|
+
type TimelineViewConfigRequest = {
|
|
3038
|
+
type: "timeline";
|
|
3039
|
+
date_property_id: string;
|
|
3040
|
+
end_date_property_id?: string | null;
|
|
3041
|
+
properties?: Array<ViewPropertyConfigRequest> | null;
|
|
3042
|
+
show_table?: boolean | null;
|
|
3043
|
+
table_properties?: Array<ViewPropertyConfigRequest> | null;
|
|
3044
|
+
preference?: TimelinePreferenceRequest | null;
|
|
3045
|
+
arrows_by?: TimelineArrowsByRequest | null;
|
|
3046
|
+
color_by?: boolean | null;
|
|
3047
|
+
};
|
|
3048
|
+
type TimelineViewConfigResponse = {
|
|
3049
|
+
type: "timeline";
|
|
3050
|
+
date_property_id: string;
|
|
3051
|
+
date_property_name?: string;
|
|
3052
|
+
end_date_property_id?: string;
|
|
3053
|
+
end_date_property_name?: string;
|
|
3054
|
+
properties?: Array<ViewPropertyConfigResponse>;
|
|
3055
|
+
show_table?: boolean;
|
|
3056
|
+
table_properties?: Array<ViewPropertyConfigResponse>;
|
|
3057
|
+
preference?: TimelinePreferenceResponse;
|
|
3058
|
+
arrows_by?: TimelineArrowsByResponse;
|
|
3059
|
+
color_by?: boolean;
|
|
3060
|
+
};
|
|
2510
3061
|
type TimestampCreatedTimeFilter = {
|
|
2511
3062
|
created_time: DatePropertyFilter;
|
|
2512
3063
|
timestamp: "created_time";
|
|
@@ -2518,6 +3069,10 @@ type TimestampLastEditedTimeFilter = {
|
|
|
2518
3069
|
timestamp: "last_edited_time";
|
|
2519
3070
|
type?: "last_edited_time";
|
|
2520
3071
|
};
|
|
3072
|
+
type TimestampSortResponse = {
|
|
3073
|
+
timestamp: "created_time" | "last_edited_time";
|
|
3074
|
+
direction: "ascending" | "descending";
|
|
3075
|
+
};
|
|
2521
3076
|
type TitleArrayBasedPropertyValueResponse = {
|
|
2522
3077
|
type: "title";
|
|
2523
3078
|
title: Array<RichTextItemResponse>;
|
|
@@ -2655,6 +3210,13 @@ type UpdateMediaContentWithUrlAndCaptionRequest = {
|
|
|
2655
3210
|
url?: string;
|
|
2656
3211
|
caption?: Array<RichTextItemRequest>;
|
|
2657
3212
|
};
|
|
3213
|
+
type UpdateViewRequest = {
|
|
3214
|
+
name?: string;
|
|
3215
|
+
filter?: ViewFilterRequest | null;
|
|
3216
|
+
sorts?: ViewPropertySortsRequest | null;
|
|
3217
|
+
quick_filters?: Record<string, QuickFilterConditionRequest | null> | null;
|
|
3218
|
+
configuration?: ViewConfigRequest;
|
|
3219
|
+
};
|
|
2658
3220
|
type UrlDatabasePropertyConfigResponse = {
|
|
2659
3221
|
type: "url";
|
|
2660
3222
|
url: EmptyObject;
|
|
@@ -2724,6 +3286,138 @@ export type VideoBlockObjectResponse = {
|
|
|
2724
3286
|
/** @deprecated Use `in_trash` instead. Present for backwards compatibility with API versions prior to 2026-03-11. */
|
|
2725
3287
|
archived: boolean;
|
|
2726
3288
|
};
|
|
3289
|
+
/**
|
|
3290
|
+
* View configuration, discriminated by the type field.
|
|
3291
|
+
*/
|
|
3292
|
+
type ViewConfigRequest = TableViewConfigRequest | BoardViewConfigRequest | CalendarViewConfigRequest | TimelineViewConfigRequest | GalleryViewConfigRequest | ListViewConfigRequest | MapViewConfigRequest | FormViewConfigRequest | ChartViewConfigRequest;
|
|
3293
|
+
/**
|
|
3294
|
+
* View configuration, typed by view type (table, board, calendar, etc.).
|
|
3295
|
+
*/
|
|
3296
|
+
type ViewConfigResponse = TableViewConfigResponse | BoardViewConfigResponse | CalendarViewConfigResponse | TimelineViewConfigResponse | GalleryViewConfigResponse | ListViewConfigResponse | MapViewConfigResponse | FormViewConfigResponse | ChartViewConfigResponse | DashboardViewConfigResponse;
|
|
3297
|
+
/**
|
|
3298
|
+
* Filter for the view. Uses the same format as the data source query filter (property
|
|
3299
|
+
* filters, timestamp filters, or compound and/or filters). Simple property filters appear
|
|
3300
|
+
* in the view's filter bar in the Notion UI. To filter by multiple values on a select or
|
|
3301
|
+
* status property, use a compound "or" filter with separate "equals" conditions for each
|
|
3302
|
+
* value.
|
|
3303
|
+
*/
|
|
3304
|
+
type ViewFilterRequest = Record<string, never>;
|
|
3305
|
+
/**
|
|
3306
|
+
* Filter for the view. Can be a property filter (filter by property value), timestamp
|
|
3307
|
+
* filter (filter by created_time or last_edited_time), or compound filter (combine
|
|
3308
|
+
* filters with and/or logic). Compound filters support up to 2 levels of nesting.
|
|
3309
|
+
*/
|
|
3310
|
+
type ViewFilterResponse = (Record<string, unknown> & {
|
|
3311
|
+
property: string;
|
|
3312
|
+
}) | (Record<string, unknown> & {
|
|
3313
|
+
timestamp: "created_time" | "last_edited_time";
|
|
3314
|
+
}) | {
|
|
3315
|
+
or?: Array<(Record<string, unknown> & {
|
|
3316
|
+
property: string;
|
|
3317
|
+
}) | (Record<string, unknown> & {
|
|
3318
|
+
timestamp: "created_time" | "last_edited_time";
|
|
3319
|
+
}) | {
|
|
3320
|
+
or?: Array<(Record<string, unknown> & {
|
|
3321
|
+
property: string;
|
|
3322
|
+
}) | (Record<string, unknown> & {
|
|
3323
|
+
timestamp: "created_time" | "last_edited_time";
|
|
3324
|
+
})>;
|
|
3325
|
+
and?: Array<(Record<string, unknown> & {
|
|
3326
|
+
property: string;
|
|
3327
|
+
}) | (Record<string, unknown> & {
|
|
3328
|
+
timestamp: "created_time" | "last_edited_time";
|
|
3329
|
+
})>;
|
|
3330
|
+
}>;
|
|
3331
|
+
and?: Array<(Record<string, unknown> & {
|
|
3332
|
+
property: string;
|
|
3333
|
+
}) | (Record<string, unknown> & {
|
|
3334
|
+
timestamp: "created_time" | "last_edited_time";
|
|
3335
|
+
}) | {
|
|
3336
|
+
or?: Array<(Record<string, unknown> & {
|
|
3337
|
+
property: string;
|
|
3338
|
+
}) | (Record<string, unknown> & {
|
|
3339
|
+
timestamp: "created_time" | "last_edited_time";
|
|
3340
|
+
})>;
|
|
3341
|
+
and?: Array<(Record<string, unknown> & {
|
|
3342
|
+
property: string;
|
|
3343
|
+
}) | (Record<string, unknown> & {
|
|
3344
|
+
timestamp: "created_time" | "last_edited_time";
|
|
3345
|
+
})>;
|
|
3346
|
+
}>;
|
|
3347
|
+
};
|
|
3348
|
+
/**
|
|
3349
|
+
* Position of the new view in the database's view tab bar.
|
|
3350
|
+
*/
|
|
3351
|
+
type ViewPositionRequest = {
|
|
3352
|
+
type: "start";
|
|
3353
|
+
} | {
|
|
3354
|
+
type: "end";
|
|
3355
|
+
} | {
|
|
3356
|
+
type: "after_view";
|
|
3357
|
+
view_id: IdRequest;
|
|
3358
|
+
};
|
|
3359
|
+
type ViewPropertyConfigRequest = {
|
|
3360
|
+
property_id: string;
|
|
3361
|
+
visible?: boolean;
|
|
3362
|
+
width?: number;
|
|
3363
|
+
wrap?: boolean;
|
|
3364
|
+
status_show_as?: "select" | "checkbox";
|
|
3365
|
+
card_property_width_mode?: "full_line" | "inline";
|
|
3366
|
+
date_format?: "full" | "short" | "month_day_year" | "day_month_year" | "year_month_day" | "relative";
|
|
3367
|
+
time_format?: "12_hour" | "24_hour" | "hidden";
|
|
3368
|
+
};
|
|
3369
|
+
type ViewPropertyConfigResponse = {
|
|
3370
|
+
property_id: string;
|
|
3371
|
+
property_name?: string;
|
|
3372
|
+
visible?: boolean;
|
|
3373
|
+
width?: number;
|
|
3374
|
+
wrap?: boolean;
|
|
3375
|
+
status_show_as?: "select" | "checkbox";
|
|
3376
|
+
card_property_width_mode?: "full_line" | "inline";
|
|
3377
|
+
date_format?: "full" | "short" | "month_day_year" | "day_month_year" | "year_month_day" | "relative";
|
|
3378
|
+
time_format?: "12_hour" | "24_hour" | "hidden";
|
|
3379
|
+
};
|
|
3380
|
+
type ViewPropertySortRequest = {
|
|
3381
|
+
property: string;
|
|
3382
|
+
direction: SortDirectionRequest;
|
|
3383
|
+
};
|
|
3384
|
+
type ViewPropertySortsRequest = Array<ViewPropertySortRequest>;
|
|
3385
|
+
export type ViewQueryResponse = {
|
|
3386
|
+
object: "view_query";
|
|
3387
|
+
id: IdResponse;
|
|
3388
|
+
view_id: IdResponse;
|
|
3389
|
+
expires_at: string;
|
|
3390
|
+
total_count: number;
|
|
3391
|
+
results: Array<PageReferenceResponse>;
|
|
3392
|
+
next_cursor: IdResponse | null;
|
|
3393
|
+
has_more: boolean;
|
|
3394
|
+
};
|
|
3395
|
+
/**
|
|
3396
|
+
* Sort for the view. Can be a property sort (with property and direction) or timestamp
|
|
3397
|
+
* sort (with timestamp and direction).
|
|
3398
|
+
*/
|
|
3399
|
+
type ViewSortRequest = Record<string, never>;
|
|
3400
|
+
/**
|
|
3401
|
+
* Sort for the view. Can sort by property or timestamp.
|
|
3402
|
+
*/
|
|
3403
|
+
type ViewSortResponse = PropertySortResponse | TimestampSortResponse;
|
|
3404
|
+
type ViewSortsRequest = Array<ViewSortRequest>;
|
|
3405
|
+
/**
|
|
3406
|
+
* One of: `table`, `board`, `list`, `calendar`, `timeline`, `gallery`, `form`, `chart`,
|
|
3407
|
+
* `map`, `dashboard`
|
|
3408
|
+
*/
|
|
3409
|
+
type ViewTypeRequest = "table" | "board" | "list" | "calendar" | "timeline" | "gallery" | "form" | "chart" | "map" | "dashboard";
|
|
3410
|
+
/**
|
|
3411
|
+
* Where to place the new widget in the dashboard. "new_row" creates a new row,
|
|
3412
|
+
* "existing_row" adds to an existing row side-by-side with other widgets.
|
|
3413
|
+
*/
|
|
3414
|
+
type WidgetPlacementRequest = {
|
|
3415
|
+
type: "new_row";
|
|
3416
|
+
row_index?: number;
|
|
3417
|
+
} | {
|
|
3418
|
+
type: "existing_row";
|
|
3419
|
+
row_index: number;
|
|
3420
|
+
};
|
|
2727
3421
|
type WorkspaceParentForBlockBasedObjectResponse = {
|
|
2728
3422
|
type: "workspace";
|
|
2729
3423
|
workspace: true;
|
|
@@ -3024,6 +3718,7 @@ type UpdatePageBodyParameters = {
|
|
|
3024
3718
|
in_trash?: boolean;
|
|
3025
3719
|
/** @deprecated Use `in_trash` instead. */
|
|
3026
3720
|
archived?: boolean;
|
|
3721
|
+
is_archived?: boolean;
|
|
3027
3722
|
};
|
|
3028
3723
|
export type UpdatePageParameters = UpdatePagePathParameters & UpdatePageBodyParameters;
|
|
3029
3724
|
export type UpdatePageResponse = PageObjectResponse | PartialPageObjectResponse;
|
|
@@ -3034,7 +3729,7 @@ export declare const updatePage: {
|
|
|
3034
3729
|
readonly method: "patch";
|
|
3035
3730
|
readonly pathParams: readonly ["page_id"];
|
|
3036
3731
|
readonly queryParams: readonly [];
|
|
3037
|
-
readonly bodyParams: readonly ["archived", "properties", "icon", "cover", "is_locked", "template", "erase_content", "in_trash"];
|
|
3732
|
+
readonly bodyParams: readonly ["archived", "properties", "icon", "cover", "is_locked", "template", "erase_content", "in_trash", "is_archived"];
|
|
3038
3733
|
readonly path: (p: UpdatePagePathParameters) => string;
|
|
3039
3734
|
};
|
|
3040
3735
|
type MovePagePathParameters = {
|
|
@@ -3513,7 +4208,7 @@ type UpdateDataSourceBodyParameters = {
|
|
|
3513
4208
|
};
|
|
3514
4209
|
} | {
|
|
3515
4210
|
type?: "status";
|
|
3516
|
-
status:
|
|
4211
|
+
status: StatusPropertyConfigUpdateRequest;
|
|
3517
4212
|
} | {
|
|
3518
4213
|
type?: "relation";
|
|
3519
4214
|
relation: {
|
|
@@ -3988,6 +4683,149 @@ export declare const getFileUpload: {
|
|
|
3988
4683
|
readonly bodyParams: readonly [];
|
|
3989
4684
|
readonly path: (p: GetFileUploadPathParameters) => string;
|
|
3990
4685
|
};
|
|
4686
|
+
type ListDatabaseViewsQueryParameters = {
|
|
4687
|
+
database_id?: IdRequest;
|
|
4688
|
+
data_source_id?: IdRequest;
|
|
4689
|
+
start_cursor?: string;
|
|
4690
|
+
page_size?: number;
|
|
4691
|
+
};
|
|
4692
|
+
export type ListDatabaseViewsParameters = ListDatabaseViewsQueryParameters;
|
|
4693
|
+
export type ListDatabaseViewsResponse = {
|
|
4694
|
+
object: "list";
|
|
4695
|
+
next_cursor: IdResponse | null;
|
|
4696
|
+
has_more: boolean;
|
|
4697
|
+
results: Array<DataSourceViewReferenceResponse>;
|
|
4698
|
+
type: "view";
|
|
4699
|
+
view: EmptyObject;
|
|
4700
|
+
};
|
|
4701
|
+
/**
|
|
4702
|
+
* List views
|
|
4703
|
+
*/
|
|
4704
|
+
export declare const listDatabaseViews: {
|
|
4705
|
+
readonly method: "get";
|
|
4706
|
+
readonly pathParams: readonly [];
|
|
4707
|
+
readonly queryParams: readonly ["database_id", "data_source_id", "start_cursor", "page_size"];
|
|
4708
|
+
readonly bodyParams: readonly [];
|
|
4709
|
+
readonly path: () => string;
|
|
4710
|
+
};
|
|
4711
|
+
type CreateViewBodyParameters = CreateViewRequest;
|
|
4712
|
+
export type CreateViewParameters = CreateViewBodyParameters;
|
|
4713
|
+
export type CreateViewResponse = PartialDataSourceViewObjectResponse | DataSourceViewObjectResponse;
|
|
4714
|
+
/**
|
|
4715
|
+
* Create a view
|
|
4716
|
+
*/
|
|
4717
|
+
export declare const createView: {
|
|
4718
|
+
readonly method: "post";
|
|
4719
|
+
readonly pathParams: readonly [];
|
|
4720
|
+
readonly queryParams: readonly [];
|
|
4721
|
+
readonly bodyParams: readonly [];
|
|
4722
|
+
readonly path: () => string;
|
|
4723
|
+
};
|
|
4724
|
+
type GetViewPathParameters = {
|
|
4725
|
+
view_id: IdRequest;
|
|
4726
|
+
};
|
|
4727
|
+
export type GetViewParameters = GetViewPathParameters;
|
|
4728
|
+
export type GetViewResponse = PartialDataSourceViewObjectResponse | DataSourceViewObjectResponse;
|
|
4729
|
+
/**
|
|
4730
|
+
* Retrieve a view
|
|
4731
|
+
*/
|
|
4732
|
+
export declare const getView: {
|
|
4733
|
+
readonly method: "get";
|
|
4734
|
+
readonly pathParams: readonly ["view_id"];
|
|
4735
|
+
readonly queryParams: readonly [];
|
|
4736
|
+
readonly bodyParams: readonly [];
|
|
4737
|
+
readonly path: (p: GetViewPathParameters) => string;
|
|
4738
|
+
};
|
|
4739
|
+
type UpdateViewPathParameters = {
|
|
4740
|
+
view_id: IdRequest;
|
|
4741
|
+
};
|
|
4742
|
+
type UpdateViewBodyParameters = UpdateViewRequest;
|
|
4743
|
+
export type UpdateViewParameters = UpdateViewPathParameters & UpdateViewBodyParameters;
|
|
4744
|
+
export type UpdateViewResponse = PartialDataSourceViewObjectResponse | DataSourceViewObjectResponse;
|
|
4745
|
+
/**
|
|
4746
|
+
* Update a view
|
|
4747
|
+
*/
|
|
4748
|
+
export declare const updateView: {
|
|
4749
|
+
readonly method: "patch";
|
|
4750
|
+
readonly pathParams: readonly ["view_id"];
|
|
4751
|
+
readonly queryParams: readonly [];
|
|
4752
|
+
readonly bodyParams: readonly [];
|
|
4753
|
+
readonly path: (p: UpdateViewPathParameters) => string;
|
|
4754
|
+
};
|
|
4755
|
+
type DeleteViewPathParameters = {
|
|
4756
|
+
view_id: IdRequest;
|
|
4757
|
+
};
|
|
4758
|
+
export type DeleteViewParameters = DeleteViewPathParameters;
|
|
4759
|
+
export type DeleteViewResponse = PartialDataSourceViewObjectResponse;
|
|
4760
|
+
/**
|
|
4761
|
+
* Delete a view
|
|
4762
|
+
*/
|
|
4763
|
+
export declare const deleteView: {
|
|
4764
|
+
readonly method: "delete";
|
|
4765
|
+
readonly pathParams: readonly ["view_id"];
|
|
4766
|
+
readonly queryParams: readonly [];
|
|
4767
|
+
readonly bodyParams: readonly [];
|
|
4768
|
+
readonly path: (p: DeleteViewPathParameters) => string;
|
|
4769
|
+
};
|
|
4770
|
+
type CreateViewQueryPathParameters = {
|
|
4771
|
+
view_id: IdRequest;
|
|
4772
|
+
};
|
|
4773
|
+
type CreateViewQueryBodyParameters = CreateViewQueryRequest;
|
|
4774
|
+
export type CreateViewQueryParameters = CreateViewQueryPathParameters & CreateViewQueryBodyParameters;
|
|
4775
|
+
export type CreateViewQueryResponse = ViewQueryResponse;
|
|
4776
|
+
/**
|
|
4777
|
+
* Create a view query
|
|
4778
|
+
*/
|
|
4779
|
+
export declare const createViewQuery: {
|
|
4780
|
+
readonly method: "post";
|
|
4781
|
+
readonly pathParams: readonly ["view_id"];
|
|
4782
|
+
readonly queryParams: readonly [];
|
|
4783
|
+
readonly bodyParams: readonly [];
|
|
4784
|
+
readonly path: (p: CreateViewQueryPathParameters) => string;
|
|
4785
|
+
};
|
|
4786
|
+
type GetViewQueryResultsPathParameters = {
|
|
4787
|
+
view_id: IdRequest;
|
|
4788
|
+
query_id: IdRequest;
|
|
4789
|
+
};
|
|
4790
|
+
type GetViewQueryResultsQueryParameters = {
|
|
4791
|
+
start_cursor?: string;
|
|
4792
|
+
page_size?: number;
|
|
4793
|
+
};
|
|
4794
|
+
export type GetViewQueryResultsParameters = GetViewQueryResultsPathParameters & GetViewQueryResultsQueryParameters;
|
|
4795
|
+
export type GetViewQueryResultsResponse = {
|
|
4796
|
+
object: "list";
|
|
4797
|
+
next_cursor: IdResponse | null;
|
|
4798
|
+
has_more: boolean;
|
|
4799
|
+
results: Array<PartialPageObjectResponse>;
|
|
4800
|
+
type: "page";
|
|
4801
|
+
page: EmptyObject;
|
|
4802
|
+
};
|
|
4803
|
+
/**
|
|
4804
|
+
* Get view query results
|
|
4805
|
+
*/
|
|
4806
|
+
export declare const getViewQueryResults: {
|
|
4807
|
+
readonly method: "get";
|
|
4808
|
+
readonly pathParams: readonly ["view_id", "query_id"];
|
|
4809
|
+
readonly queryParams: readonly ["start_cursor", "page_size"];
|
|
4810
|
+
readonly bodyParams: readonly [];
|
|
4811
|
+
readonly path: (p: GetViewQueryResultsPathParameters) => string;
|
|
4812
|
+
};
|
|
4813
|
+
type DeleteViewQueryPathParameters = {
|
|
4814
|
+
view_id: IdRequest;
|
|
4815
|
+
query_id: IdRequest;
|
|
4816
|
+
};
|
|
4817
|
+
export type DeleteViewQueryParameters = DeleteViewQueryPathParameters;
|
|
4818
|
+
export type DeleteViewQueryResponse = DeletedViewQueryResponse;
|
|
4819
|
+
/**
|
|
4820
|
+
* Delete a view query
|
|
4821
|
+
*/
|
|
4822
|
+
export declare const deleteViewQuery: {
|
|
4823
|
+
readonly method: "delete";
|
|
4824
|
+
readonly pathParams: readonly ["view_id", "query_id"];
|
|
4825
|
+
readonly queryParams: readonly [];
|
|
4826
|
+
readonly bodyParams: readonly [];
|
|
4827
|
+
readonly path: (p: DeleteViewQueryPathParameters) => string;
|
|
4828
|
+
};
|
|
3991
4829
|
type OauthTokenBodyParameters = {
|
|
3992
4830
|
grant_type: "authorization_code";
|
|
3993
4831
|
code: string;
|