@notionhq/client 3.1.0 → 3.1.2

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/README.md CHANGED
@@ -273,7 +273,7 @@ const blocks = await collectPaginatedAPI(notion.blocks.children.list, {
273
273
 
274
274
  This package supports the following minimum versions:
275
275
 
276
- - Runtime: `node >= 12`
276
+ - Runtime: `node >= 18`
277
277
  - Type definitions (optional): `typescript >= 4.5`
278
278
 
279
279
  Earlier versions may still work, but we encourage people building new applications to upgrade to the current stable.
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@notionhq/client",
3
- "version": "3.1.0",
3
+ "version": "3.1.2",
4
4
  "description": "A simple and easy to use client for the Notion API",
5
5
  "engines": {
6
6
  "node": ">=18"
@@ -15,27 +15,31 @@ export type PartialUserObjectResponse = {
15
15
  id: IdRequest;
16
16
  object: "user";
17
17
  };
18
+ type BotInfoResponse = {
19
+ owner: {
20
+ type: "user";
21
+ user: {
22
+ type: "person";
23
+ person: {
24
+ email: string;
25
+ };
26
+ name: string | null;
27
+ avatar_url: string | null;
28
+ id: IdRequest;
29
+ object: "user";
30
+ } | PartialUserObjectResponse;
31
+ } | {
32
+ type: "workspace";
33
+ workspace: true;
34
+ };
35
+ workspace_name: string | null;
36
+ workspace_limits: {
37
+ max_file_upload_size_in_bytes: number;
38
+ };
39
+ };
18
40
  export type BotUserObjectResponse = {
19
41
  type: "bot";
20
- bot: EmptyObject | {
21
- owner: {
22
- type: "user";
23
- user: {
24
- type: "person";
25
- person: {
26
- email: string;
27
- };
28
- name: string | null;
29
- avatar_url: string | null;
30
- id: IdRequest;
31
- object: "user";
32
- } | PartialUserObjectResponse;
33
- } | {
34
- type: "workspace";
35
- workspace: true;
36
- };
37
- workspace_name: string | null;
38
- };
42
+ bot: EmptyObject | BotInfoResponse;
39
43
  name: string | null;
40
44
  avatar_url: string | null;
41
45
  id: IdRequest;
@@ -93,25 +97,7 @@ type VerificationPropertyResponse = {
93
97
  avatar_url?: string | null;
94
98
  object?: "user";
95
99
  } | null | {
96
- bot: EmptyObject | {
97
- owner: {
98
- type: "user";
99
- user: {
100
- type: "person";
101
- person: {
102
- email: string;
103
- };
104
- name: string | null;
105
- avatar_url: string | null;
106
- id: IdRequest;
107
- object: "user";
108
- } | PartialUserObjectResponse;
109
- } | {
110
- type: "workspace";
111
- workspace: true;
112
- };
113
- workspace_name: string | null;
114
- };
100
+ bot: EmptyObject | BotInfoResponse;
115
101
  id: IdRequest;
116
102
  type?: "bot";
117
103
  name?: string | null;
@@ -512,9 +498,9 @@ type FormulaDatabasePropertyConfigResponse = {
512
498
  };
513
499
  type SelectPropertyResponse = {
514
500
  id: StringRequest;
515
- name: StringRequest;
501
+ name: TextRequest;
516
502
  color: SelectColor;
517
- description: StringRequest | null;
503
+ description: TextRequest | null;
518
504
  };
519
505
  type SelectDatabasePropertyConfigResponse = {
520
506
  type: "select";
@@ -536,9 +522,9 @@ type MultiSelectDatabasePropertyConfigResponse = {
536
522
  };
537
523
  type StatusPropertyResponse = {
538
524
  id: StringRequest;
539
- name: StringRequest;
525
+ name: TextRequest;
540
526
  color: SelectColor;
541
- description: StringRequest | null;
527
+ description: TextRequest | null;
542
528
  };
543
529
  type StatusDatabasePropertyConfigResponse = {
544
530
  type: "status";
@@ -546,7 +532,7 @@ type StatusDatabasePropertyConfigResponse = {
546
532
  options: Array<StatusPropertyResponse>;
547
533
  groups: Array<{
548
534
  id: StringRequest;
549
- name: StringRequest;
535
+ name: TextRequest;
550
536
  color: SelectColor;
551
537
  option_ids: Array<string>;
552
538
  }>;
@@ -564,7 +550,7 @@ type DualPropertyDatabasePropertyRelationConfigResponse = {
564
550
  type: "dual_property";
565
551
  dual_property: {
566
552
  synced_property_id: StringRequest;
567
- synced_property_name: StringRequest;
553
+ synced_property_name: TextRequest;
568
554
  };
569
555
  database_id: IdRequest;
570
556
  };
@@ -2034,25 +2020,7 @@ type RichTextItemRequest = {
2034
2020
  avatar_url?: string | null;
2035
2021
  object?: "user";
2036
2022
  } | {
2037
- bot: EmptyObject | {
2038
- owner: {
2039
- type: "user";
2040
- user: {
2041
- type: "person";
2042
- person: {
2043
- email: string;
2044
- };
2045
- name: string | null;
2046
- avatar_url: string | null;
2047
- id: IdRequest;
2048
- object: "user";
2049
- } | PartialUserObjectResponse;
2050
- } | {
2051
- type: "workspace";
2052
- workspace: true;
2053
- };
2054
- workspace_name: string | null;
2055
- };
2023
+ bot: EmptyObject | BotInfoResponse;
2056
2024
  id: IdRequest;
2057
2025
  type?: "bot";
2058
2026
  name?: string | null;
@@ -3013,27 +2981,27 @@ type CreatePageBodyParameters = {
3013
2981
  } | {
3014
2982
  select: {
3015
2983
  id: StringRequest;
3016
- name?: StringRequest;
2984
+ name?: TextRequest;
3017
2985
  color?: SelectColor;
3018
- description?: StringRequest | null;
2986
+ description?: TextRequest | null;
3019
2987
  } | null | {
3020
- name: StringRequest;
2988
+ name: TextRequest;
3021
2989
  id?: StringRequest;
3022
2990
  color?: SelectColor;
3023
- description?: StringRequest | null;
2991
+ description?: TextRequest | null;
3024
2992
  } | null;
3025
2993
  type?: "select";
3026
2994
  } | {
3027
2995
  multi_select: Array<{
3028
2996
  id: StringRequest;
3029
- name?: StringRequest;
2997
+ name?: TextRequest;
3030
2998
  color?: SelectColor;
3031
- description?: StringRequest | null;
2999
+ description?: TextRequest | null;
3032
3000
  } | {
3033
- name: StringRequest;
3001
+ name: TextRequest;
3034
3002
  id?: StringRequest;
3035
3003
  color?: SelectColor;
3036
- description?: StringRequest | null;
3004
+ description?: TextRequest | null;
3037
3005
  }>;
3038
3006
  type?: "multi_select";
3039
3007
  } | {
@@ -3049,25 +3017,7 @@ type CreatePageBodyParameters = {
3049
3017
  avatar_url?: string | null;
3050
3018
  object?: "user";
3051
3019
  } | {
3052
- bot: EmptyObject | {
3053
- owner: {
3054
- type: "user";
3055
- user: {
3056
- type: "person";
3057
- person: {
3058
- email: string;
3059
- };
3060
- name: string | null;
3061
- avatar_url: string | null;
3062
- id: IdRequest;
3063
- object: "user";
3064
- } | PartialUserObjectResponse;
3065
- } | {
3066
- type: "workspace";
3067
- workspace: true;
3068
- };
3069
- workspace_name: string | null;
3070
- };
3020
+ bot: EmptyObject | BotInfoResponse;
3071
3021
  id: IdRequest;
3072
3022
  type?: "bot";
3073
3023
  name?: string | null;
@@ -3098,36 +3048,36 @@ type CreatePageBodyParameters = {
3098
3048
  } | {
3099
3049
  status: {
3100
3050
  id: StringRequest;
3101
- name?: StringRequest;
3051
+ name?: TextRequest;
3102
3052
  color?: SelectColor;
3103
- description?: StringRequest | null;
3053
+ description?: TextRequest | null;
3104
3054
  } | null | {
3105
- name: StringRequest;
3055
+ name: TextRequest;
3106
3056
  id?: StringRequest;
3107
3057
  color?: SelectColor;
3108
- description?: StringRequest | null;
3058
+ description?: TextRequest | null;
3109
3059
  } | null;
3110
3060
  type?: "status";
3111
3061
  }> | Record<string, Array<RichTextItemRequest> | Array<RichTextItemRequest> | number | null | TextRequest | null | {
3112
3062
  id: StringRequest;
3113
- name?: StringRequest;
3063
+ name?: TextRequest;
3114
3064
  color?: SelectColor;
3115
- description?: StringRequest | null;
3065
+ description?: TextRequest | null;
3116
3066
  } | null | {
3117
- name: StringRequest;
3067
+ name: TextRequest;
3118
3068
  id?: StringRequest;
3119
3069
  color?: SelectColor;
3120
- description?: StringRequest | null;
3070
+ description?: TextRequest | null;
3121
3071
  } | null | Array<{
3122
3072
  id: StringRequest;
3123
- name?: StringRequest;
3073
+ name?: TextRequest;
3124
3074
  color?: SelectColor;
3125
- description?: StringRequest | null;
3075
+ description?: TextRequest | null;
3126
3076
  } | {
3127
- name: StringRequest;
3077
+ name: TextRequest;
3128
3078
  id?: StringRequest;
3129
3079
  color?: SelectColor;
3130
- description?: StringRequest | null;
3080
+ description?: TextRequest | null;
3131
3081
  }> | Array<{
3132
3082
  id: IdRequest;
3133
3083
  } | {
@@ -3140,25 +3090,7 @@ type CreatePageBodyParameters = {
3140
3090
  avatar_url?: string | null;
3141
3091
  object?: "user";
3142
3092
  } | {
3143
- bot: EmptyObject | {
3144
- owner: {
3145
- type: "user";
3146
- user: {
3147
- type: "person";
3148
- person: {
3149
- email: string;
3150
- };
3151
- name: string | null;
3152
- avatar_url: string | null;
3153
- id: IdRequest;
3154
- object: "user";
3155
- } | PartialUserObjectResponse;
3156
- } | {
3157
- type: "workspace";
3158
- workspace: true;
3159
- };
3160
- workspace_name: string | null;
3161
- };
3093
+ bot: EmptyObject | BotInfoResponse;
3162
3094
  id: IdRequest;
3163
3095
  type?: "bot";
3164
3096
  name?: string | null;
@@ -3168,14 +3100,14 @@ type CreatePageBodyParameters = {
3168
3100
  id: IdRequest;
3169
3101
  }> | Array<InternalOrExternalFileWithNameRequest | FileUploadWithOptionalNameRequest> | {
3170
3102
  id: StringRequest;
3171
- name?: StringRequest;
3103
+ name?: TextRequest;
3172
3104
  color?: SelectColor;
3173
- description?: StringRequest | null;
3105
+ description?: TextRequest | null;
3174
3106
  } | null | {
3175
- name: StringRequest;
3107
+ name: TextRequest;
3176
3108
  id?: StringRequest;
3177
3109
  color?: SelectColor;
3178
- description?: StringRequest | null;
3110
+ description?: TextRequest | null;
3179
3111
  } | null>;
3180
3112
  icon?: PageIconRequest | null;
3181
3113
  cover?: PageCoverRequest | null;
@@ -3225,27 +3157,27 @@ type UpdatePageBodyParameters = {
3225
3157
  } | {
3226
3158
  select: {
3227
3159
  id: StringRequest;
3228
- name?: StringRequest;
3160
+ name?: TextRequest;
3229
3161
  color?: SelectColor;
3230
- description?: StringRequest | null;
3162
+ description?: TextRequest | null;
3231
3163
  } | null | {
3232
- name: StringRequest;
3164
+ name: TextRequest;
3233
3165
  id?: StringRequest;
3234
3166
  color?: SelectColor;
3235
- description?: StringRequest | null;
3167
+ description?: TextRequest | null;
3236
3168
  } | null;
3237
3169
  type?: "select";
3238
3170
  } | {
3239
3171
  multi_select: Array<{
3240
3172
  id: StringRequest;
3241
- name?: StringRequest;
3173
+ name?: TextRequest;
3242
3174
  color?: SelectColor;
3243
- description?: StringRequest | null;
3175
+ description?: TextRequest | null;
3244
3176
  } | {
3245
- name: StringRequest;
3177
+ name: TextRequest;
3246
3178
  id?: StringRequest;
3247
3179
  color?: SelectColor;
3248
- description?: StringRequest | null;
3180
+ description?: TextRequest | null;
3249
3181
  }>;
3250
3182
  type?: "multi_select";
3251
3183
  } | {
@@ -3261,25 +3193,7 @@ type UpdatePageBodyParameters = {
3261
3193
  avatar_url?: string | null;
3262
3194
  object?: "user";
3263
3195
  } | {
3264
- bot: EmptyObject | {
3265
- owner: {
3266
- type: "user";
3267
- user: {
3268
- type: "person";
3269
- person: {
3270
- email: string;
3271
- };
3272
- name: string | null;
3273
- avatar_url: string | null;
3274
- id: IdRequest;
3275
- object: "user";
3276
- } | PartialUserObjectResponse;
3277
- } | {
3278
- type: "workspace";
3279
- workspace: true;
3280
- };
3281
- workspace_name: string | null;
3282
- };
3196
+ bot: EmptyObject | BotInfoResponse;
3283
3197
  id: IdRequest;
3284
3198
  type?: "bot";
3285
3199
  name?: string | null;
@@ -3310,36 +3224,36 @@ type UpdatePageBodyParameters = {
3310
3224
  } | {
3311
3225
  status: {
3312
3226
  id: StringRequest;
3313
- name?: StringRequest;
3227
+ name?: TextRequest;
3314
3228
  color?: SelectColor;
3315
- description?: StringRequest | null;
3229
+ description?: TextRequest | null;
3316
3230
  } | null | {
3317
- name: StringRequest;
3231
+ name: TextRequest;
3318
3232
  id?: StringRequest;
3319
3233
  color?: SelectColor;
3320
- description?: StringRequest | null;
3234
+ description?: TextRequest | null;
3321
3235
  } | null;
3322
3236
  type?: "status";
3323
3237
  }> | Record<string, Array<RichTextItemRequest> | Array<RichTextItemRequest> | number | null | TextRequest | null | {
3324
3238
  id: StringRequest;
3325
- name?: StringRequest;
3239
+ name?: TextRequest;
3326
3240
  color?: SelectColor;
3327
- description?: StringRequest | null;
3241
+ description?: TextRequest | null;
3328
3242
  } | null | {
3329
- name: StringRequest;
3243
+ name: TextRequest;
3330
3244
  id?: StringRequest;
3331
3245
  color?: SelectColor;
3332
- description?: StringRequest | null;
3246
+ description?: TextRequest | null;
3333
3247
  } | null | Array<{
3334
3248
  id: StringRequest;
3335
- name?: StringRequest;
3249
+ name?: TextRequest;
3336
3250
  color?: SelectColor;
3337
- description?: StringRequest | null;
3251
+ description?: TextRequest | null;
3338
3252
  } | {
3339
- name: StringRequest;
3253
+ name: TextRequest;
3340
3254
  id?: StringRequest;
3341
3255
  color?: SelectColor;
3342
- description?: StringRequest | null;
3256
+ description?: TextRequest | null;
3343
3257
  }> | Array<{
3344
3258
  id: IdRequest;
3345
3259
  } | {
@@ -3352,25 +3266,7 @@ type UpdatePageBodyParameters = {
3352
3266
  avatar_url?: string | null;
3353
3267
  object?: "user";
3354
3268
  } | {
3355
- bot: EmptyObject | {
3356
- owner: {
3357
- type: "user";
3358
- user: {
3359
- type: "person";
3360
- person: {
3361
- email: string;
3362
- };
3363
- name: string | null;
3364
- avatar_url: string | null;
3365
- id: IdRequest;
3366
- object: "user";
3367
- } | PartialUserObjectResponse;
3368
- } | {
3369
- type: "workspace";
3370
- workspace: true;
3371
- };
3372
- workspace_name: string | null;
3373
- };
3269
+ bot: EmptyObject | BotInfoResponse;
3374
3270
  id: IdRequest;
3375
3271
  type?: "bot";
3376
3272
  name?: string | null;
@@ -3380,14 +3276,14 @@ type UpdatePageBodyParameters = {
3380
3276
  id: IdRequest;
3381
3277
  }> | Array<InternalOrExternalFileWithNameRequest | FileUploadWithOptionalNameRequest> | {
3382
3278
  id: StringRequest;
3383
- name?: StringRequest;
3279
+ name?: TextRequest;
3384
3280
  color?: SelectColor;
3385
- description?: StringRequest | null;
3281
+ description?: TextRequest | null;
3386
3282
  } | null | {
3387
- name: StringRequest;
3283
+ name: TextRequest;
3388
3284
  id?: StringRequest;
3389
3285
  color?: SelectColor;
3390
- description?: StringRequest | null;
3286
+ description?: TextRequest | null;
3391
3287
  } | null>;
3392
3288
  icon?: PageIconRequest | null;
3393
3289
  cover?: PageCoverRequest | null;
@@ -3750,14 +3646,14 @@ type UpdateDatabaseBodyParameters = {
3750
3646
  select: {
3751
3647
  options?: Array<{
3752
3648
  id: StringRequest;
3753
- name?: StringRequest;
3649
+ name?: TextRequest;
3754
3650
  color?: SelectColor;
3755
- description?: StringRequest | null;
3651
+ description?: TextRequest | null;
3756
3652
  } | {
3757
- name: StringRequest;
3653
+ name: TextRequest;
3758
3654
  id?: StringRequest;
3759
3655
  color?: SelectColor;
3760
- description?: StringRequest | null;
3656
+ description?: TextRequest | null;
3761
3657
  }>;
3762
3658
  };
3763
3659
  type?: "select";
@@ -3767,14 +3663,14 @@ type UpdateDatabaseBodyParameters = {
3767
3663
  multi_select: {
3768
3664
  options?: Array<{
3769
3665
  id: StringRequest;
3770
- name?: StringRequest;
3666
+ name?: TextRequest;
3771
3667
  color?: SelectColor;
3772
- description?: StringRequest | null;
3668
+ description?: TextRequest | null;
3773
3669
  } | {
3774
- name: StringRequest;
3670
+ name: TextRequest;
3775
3671
  id?: StringRequest;
3776
3672
  color?: SelectColor;
3777
- description?: StringRequest | null;
3673
+ description?: TextRequest | null;
3778
3674
  }>;
3779
3675
  };
3780
3676
  type?: "multi_select";
@@ -4001,9 +3897,9 @@ type CreateDatabaseBodyParameters = {
4001
3897
  } | {
4002
3898
  select: {
4003
3899
  options?: Array<{
4004
- name: StringRequest;
3900
+ name: TextRequest;
4005
3901
  color?: SelectColor;
4006
- description?: StringRequest | null;
3902
+ description?: TextRequest | null;
4007
3903
  }>;
4008
3904
  };
4009
3905
  type?: "select";
@@ -4011,9 +3907,9 @@ type CreateDatabaseBodyParameters = {
4011
3907
  } | {
4012
3908
  multi_select: {
4013
3909
  options?: Array<{
4014
- name: StringRequest;
3910
+ name: TextRequest;
4015
3911
  color?: SelectColor;
4016
- description?: StringRequest | null;
3912
+ description?: TextRequest | null;
4017
3913
  }>;
4018
3914
  };
4019
3915
  type?: "multi_select";