@notionhq/client 3.1.1 → 3.1.3

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.
@@ -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;
@@ -2951,6 +2919,9 @@ type TimestampLastEditedTimeFilter = {
2951
2919
  };
2952
2920
  export type GetSelfParameters = Record<string, never>;
2953
2921
  export type GetSelfResponse = UserObjectResponse;
2922
+ /**
2923
+ * Retrieve your token's bot user
2924
+ */
2954
2925
  export declare const getSelf: {
2955
2926
  readonly method: "get";
2956
2927
  readonly pathParams: readonly [];
@@ -2963,6 +2934,9 @@ type GetUserPathParameters = {
2963
2934
  };
2964
2935
  export type GetUserParameters = GetUserPathParameters;
2965
2936
  export type GetUserResponse = UserObjectResponse;
2937
+ /**
2938
+ * Retrieve a user
2939
+ */
2966
2940
  export declare const getUser: {
2967
2941
  readonly method: "get";
2968
2942
  readonly pathParams: readonly ["user_id"];
@@ -2983,6 +2957,9 @@ export type ListUsersResponse = {
2983
2957
  has_more: boolean;
2984
2958
  results: Array<UserObjectResponse>;
2985
2959
  };
2960
+ /**
2961
+ * List all users
2962
+ */
2986
2963
  export declare const listUsers: {
2987
2964
  readonly method: "get";
2988
2965
  readonly pathParams: readonly [];
@@ -3013,27 +2990,27 @@ type CreatePageBodyParameters = {
3013
2990
  } | {
3014
2991
  select: {
3015
2992
  id: StringRequest;
3016
- name?: StringRequest;
2993
+ name?: TextRequest;
3017
2994
  color?: SelectColor;
3018
- description?: StringRequest | null;
2995
+ description?: TextRequest | null;
3019
2996
  } | null | {
3020
- name: StringRequest;
2997
+ name: TextRequest;
3021
2998
  id?: StringRequest;
3022
2999
  color?: SelectColor;
3023
- description?: StringRequest | null;
3000
+ description?: TextRequest | null;
3024
3001
  } | null;
3025
3002
  type?: "select";
3026
3003
  } | {
3027
3004
  multi_select: Array<{
3028
3005
  id: StringRequest;
3029
- name?: StringRequest;
3006
+ name?: TextRequest;
3030
3007
  color?: SelectColor;
3031
- description?: StringRequest | null;
3008
+ description?: TextRequest | null;
3032
3009
  } | {
3033
- name: StringRequest;
3010
+ name: TextRequest;
3034
3011
  id?: StringRequest;
3035
3012
  color?: SelectColor;
3036
- description?: StringRequest | null;
3013
+ description?: TextRequest | null;
3037
3014
  }>;
3038
3015
  type?: "multi_select";
3039
3016
  } | {
@@ -3049,25 +3026,7 @@ type CreatePageBodyParameters = {
3049
3026
  avatar_url?: string | null;
3050
3027
  object?: "user";
3051
3028
  } | {
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
- };
3029
+ bot: EmptyObject | BotInfoResponse;
3071
3030
  id: IdRequest;
3072
3031
  type?: "bot";
3073
3032
  name?: string | null;
@@ -3098,36 +3057,36 @@ type CreatePageBodyParameters = {
3098
3057
  } | {
3099
3058
  status: {
3100
3059
  id: StringRequest;
3101
- name?: StringRequest;
3060
+ name?: TextRequest;
3102
3061
  color?: SelectColor;
3103
- description?: StringRequest | null;
3062
+ description?: TextRequest | null;
3104
3063
  } | null | {
3105
- name: StringRequest;
3064
+ name: TextRequest;
3106
3065
  id?: StringRequest;
3107
3066
  color?: SelectColor;
3108
- description?: StringRequest | null;
3067
+ description?: TextRequest | null;
3109
3068
  } | null;
3110
3069
  type?: "status";
3111
3070
  }> | Record<string, Array<RichTextItemRequest> | Array<RichTextItemRequest> | number | null | TextRequest | null | {
3112
3071
  id: StringRequest;
3113
- name?: StringRequest;
3072
+ name?: TextRequest;
3114
3073
  color?: SelectColor;
3115
- description?: StringRequest | null;
3074
+ description?: TextRequest | null;
3116
3075
  } | null | {
3117
- name: StringRequest;
3076
+ name: TextRequest;
3118
3077
  id?: StringRequest;
3119
3078
  color?: SelectColor;
3120
- description?: StringRequest | null;
3079
+ description?: TextRequest | null;
3121
3080
  } | null | Array<{
3122
3081
  id: StringRequest;
3123
- name?: StringRequest;
3082
+ name?: TextRequest;
3124
3083
  color?: SelectColor;
3125
- description?: StringRequest | null;
3084
+ description?: TextRequest | null;
3126
3085
  } | {
3127
- name: StringRequest;
3086
+ name: TextRequest;
3128
3087
  id?: StringRequest;
3129
3088
  color?: SelectColor;
3130
- description?: StringRequest | null;
3089
+ description?: TextRequest | null;
3131
3090
  }> | Array<{
3132
3091
  id: IdRequest;
3133
3092
  } | {
@@ -3140,25 +3099,7 @@ type CreatePageBodyParameters = {
3140
3099
  avatar_url?: string | null;
3141
3100
  object?: "user";
3142
3101
  } | {
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
- };
3102
+ bot: EmptyObject | BotInfoResponse;
3162
3103
  id: IdRequest;
3163
3104
  type?: "bot";
3164
3105
  name?: string | null;
@@ -3168,14 +3109,14 @@ type CreatePageBodyParameters = {
3168
3109
  id: IdRequest;
3169
3110
  }> | Array<InternalOrExternalFileWithNameRequest | FileUploadWithOptionalNameRequest> | {
3170
3111
  id: StringRequest;
3171
- name?: StringRequest;
3112
+ name?: TextRequest;
3172
3113
  color?: SelectColor;
3173
- description?: StringRequest | null;
3114
+ description?: TextRequest | null;
3174
3115
  } | null | {
3175
- name: StringRequest;
3116
+ name: TextRequest;
3176
3117
  id?: StringRequest;
3177
3118
  color?: SelectColor;
3178
- description?: StringRequest | null;
3119
+ description?: TextRequest | null;
3179
3120
  } | null>;
3180
3121
  icon?: PageIconRequest | null;
3181
3122
  cover?: PageCoverRequest | null;
@@ -3184,6 +3125,9 @@ type CreatePageBodyParameters = {
3184
3125
  };
3185
3126
  export type CreatePageParameters = CreatePageBodyParameters;
3186
3127
  export type CreatePageResponse = PageObjectResponse | PartialPageObjectResponse;
3128
+ /**
3129
+ * Create a page
3130
+ */
3187
3131
  export declare const createPage: {
3188
3132
  readonly method: "post";
3189
3133
  readonly pathParams: readonly [];
@@ -3199,6 +3143,9 @@ type GetPageQueryParameters = {
3199
3143
  };
3200
3144
  export type GetPageParameters = GetPagePathParameters & GetPageQueryParameters;
3201
3145
  export type GetPageResponse = PageObjectResponse | PartialPageObjectResponse;
3146
+ /**
3147
+ * Retrieve a page
3148
+ */
3202
3149
  export declare const getPage: {
3203
3150
  readonly method: "get";
3204
3151
  readonly pathParams: readonly ["page_id"];
@@ -3225,27 +3172,27 @@ type UpdatePageBodyParameters = {
3225
3172
  } | {
3226
3173
  select: {
3227
3174
  id: StringRequest;
3228
- name?: StringRequest;
3175
+ name?: TextRequest;
3229
3176
  color?: SelectColor;
3230
- description?: StringRequest | null;
3177
+ description?: TextRequest | null;
3231
3178
  } | null | {
3232
- name: StringRequest;
3179
+ name: TextRequest;
3233
3180
  id?: StringRequest;
3234
3181
  color?: SelectColor;
3235
- description?: StringRequest | null;
3182
+ description?: TextRequest | null;
3236
3183
  } | null;
3237
3184
  type?: "select";
3238
3185
  } | {
3239
3186
  multi_select: Array<{
3240
3187
  id: StringRequest;
3241
- name?: StringRequest;
3188
+ name?: TextRequest;
3242
3189
  color?: SelectColor;
3243
- description?: StringRequest | null;
3190
+ description?: TextRequest | null;
3244
3191
  } | {
3245
- name: StringRequest;
3192
+ name: TextRequest;
3246
3193
  id?: StringRequest;
3247
3194
  color?: SelectColor;
3248
- description?: StringRequest | null;
3195
+ description?: TextRequest | null;
3249
3196
  }>;
3250
3197
  type?: "multi_select";
3251
3198
  } | {
@@ -3261,25 +3208,7 @@ type UpdatePageBodyParameters = {
3261
3208
  avatar_url?: string | null;
3262
3209
  object?: "user";
3263
3210
  } | {
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
- };
3211
+ bot: EmptyObject | BotInfoResponse;
3283
3212
  id: IdRequest;
3284
3213
  type?: "bot";
3285
3214
  name?: string | null;
@@ -3310,36 +3239,36 @@ type UpdatePageBodyParameters = {
3310
3239
  } | {
3311
3240
  status: {
3312
3241
  id: StringRequest;
3313
- name?: StringRequest;
3242
+ name?: TextRequest;
3314
3243
  color?: SelectColor;
3315
- description?: StringRequest | null;
3244
+ description?: TextRequest | null;
3316
3245
  } | null | {
3317
- name: StringRequest;
3246
+ name: TextRequest;
3318
3247
  id?: StringRequest;
3319
3248
  color?: SelectColor;
3320
- description?: StringRequest | null;
3249
+ description?: TextRequest | null;
3321
3250
  } | null;
3322
3251
  type?: "status";
3323
3252
  }> | Record<string, Array<RichTextItemRequest> | Array<RichTextItemRequest> | number | null | TextRequest | null | {
3324
3253
  id: StringRequest;
3325
- name?: StringRequest;
3254
+ name?: TextRequest;
3326
3255
  color?: SelectColor;
3327
- description?: StringRequest | null;
3256
+ description?: TextRequest | null;
3328
3257
  } | null | {
3329
- name: StringRequest;
3258
+ name: TextRequest;
3330
3259
  id?: StringRequest;
3331
3260
  color?: SelectColor;
3332
- description?: StringRequest | null;
3261
+ description?: TextRequest | null;
3333
3262
  } | null | Array<{
3334
3263
  id: StringRequest;
3335
- name?: StringRequest;
3264
+ name?: TextRequest;
3336
3265
  color?: SelectColor;
3337
- description?: StringRequest | null;
3266
+ description?: TextRequest | null;
3338
3267
  } | {
3339
- name: StringRequest;
3268
+ name: TextRequest;
3340
3269
  id?: StringRequest;
3341
3270
  color?: SelectColor;
3342
- description?: StringRequest | null;
3271
+ description?: TextRequest | null;
3343
3272
  }> | Array<{
3344
3273
  id: IdRequest;
3345
3274
  } | {
@@ -3352,25 +3281,7 @@ type UpdatePageBodyParameters = {
3352
3281
  avatar_url?: string | null;
3353
3282
  object?: "user";
3354
3283
  } | {
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
- };
3284
+ bot: EmptyObject | BotInfoResponse;
3374
3285
  id: IdRequest;
3375
3286
  type?: "bot";
3376
3287
  name?: string | null;
@@ -3380,14 +3291,14 @@ type UpdatePageBodyParameters = {
3380
3291
  id: IdRequest;
3381
3292
  }> | Array<InternalOrExternalFileWithNameRequest | FileUploadWithOptionalNameRequest> | {
3382
3293
  id: StringRequest;
3383
- name?: StringRequest;
3294
+ name?: TextRequest;
3384
3295
  color?: SelectColor;
3385
- description?: StringRequest | null;
3296
+ description?: TextRequest | null;
3386
3297
  } | null | {
3387
- name: StringRequest;
3298
+ name: TextRequest;
3388
3299
  id?: StringRequest;
3389
3300
  color?: SelectColor;
3390
- description?: StringRequest | null;
3301
+ description?: TextRequest | null;
3391
3302
  } | null>;
3392
3303
  icon?: PageIconRequest | null;
3393
3304
  cover?: PageCoverRequest | null;
@@ -3396,6 +3307,9 @@ type UpdatePageBodyParameters = {
3396
3307
  };
3397
3308
  export type UpdatePageParameters = UpdatePagePathParameters & UpdatePageBodyParameters;
3398
3309
  export type UpdatePageResponse = PageObjectResponse | PartialPageObjectResponse;
3310
+ /**
3311
+ * Update page properties
3312
+ */
3399
3313
  export declare const updatePage: {
3400
3314
  readonly method: "patch";
3401
3315
  readonly pathParams: readonly ["page_id"];
@@ -3413,6 +3327,9 @@ type GetPagePropertyQueryParameters = {
3413
3327
  };
3414
3328
  export type GetPagePropertyParameters = GetPagePropertyPathParameters & GetPagePropertyQueryParameters;
3415
3329
  export type GetPagePropertyResponse = PropertyItemObjectResponse | PropertyItemListResponse;
3330
+ /**
3331
+ * Retrieve a page property item
3332
+ */
3416
3333
  export declare const getPageProperty: {
3417
3334
  readonly method: "get";
3418
3335
  readonly pathParams: readonly ["page_id", "property_id"];
@@ -3425,6 +3342,9 @@ type GetBlockPathParameters = {
3425
3342
  };
3426
3343
  export type GetBlockParameters = GetBlockPathParameters;
3427
3344
  export type GetBlockResponse = PartialBlockObjectResponse | BlockObjectResponse;
3345
+ /**
3346
+ * Retrieve a block
3347
+ */
3428
3348
  export declare const getBlock: {
3429
3349
  readonly method: "get";
3430
3350
  readonly pathParams: readonly ["block_id"];
@@ -3647,6 +3567,9 @@ type UpdateBlockBodyParameters = {
3647
3567
  };
3648
3568
  export type UpdateBlockParameters = UpdateBlockPathParameters & UpdateBlockBodyParameters;
3649
3569
  export type UpdateBlockResponse = PartialBlockObjectResponse | BlockObjectResponse;
3570
+ /**
3571
+ * Update a block
3572
+ */
3650
3573
  export declare const updateBlock: {
3651
3574
  readonly method: "patch";
3652
3575
  readonly pathParams: readonly ["block_id"];
@@ -3659,6 +3582,9 @@ type DeleteBlockPathParameters = {
3659
3582
  };
3660
3583
  export type DeleteBlockParameters = DeleteBlockPathParameters;
3661
3584
  export type DeleteBlockResponse = PartialBlockObjectResponse | BlockObjectResponse;
3585
+ /**
3586
+ * Delete a block
3587
+ */
3662
3588
  export declare const deleteBlock: {
3663
3589
  readonly method: "delete";
3664
3590
  readonly pathParams: readonly ["block_id"];
@@ -3682,6 +3608,9 @@ export type ListBlockChildrenResponse = {
3682
3608
  has_more: boolean;
3683
3609
  results: Array<PartialBlockObjectResponse | BlockObjectResponse>;
3684
3610
  };
3611
+ /**
3612
+ * Retrieve block children
3613
+ */
3685
3614
  export declare const listBlockChildren: {
3686
3615
  readonly method: "get";
3687
3616
  readonly pathParams: readonly ["block_id"];
@@ -3705,6 +3634,9 @@ export type AppendBlockChildrenResponse = {
3705
3634
  has_more: boolean;
3706
3635
  results: Array<PartialBlockObjectResponse | BlockObjectResponse>;
3707
3636
  };
3637
+ /**
3638
+ * Append block children
3639
+ */
3708
3640
  export declare const appendBlockChildren: {
3709
3641
  readonly method: "patch";
3710
3642
  readonly pathParams: readonly ["block_id"];
@@ -3717,6 +3649,9 @@ type GetDatabasePathParameters = {
3717
3649
  };
3718
3650
  export type GetDatabaseParameters = GetDatabasePathParameters;
3719
3651
  export type GetDatabaseResponse = PartialDatabaseObjectResponse | DatabaseObjectResponse;
3652
+ /**
3653
+ * Retrieve a database
3654
+ */
3720
3655
  export declare const getDatabase: {
3721
3656
  readonly method: "get";
3722
3657
  readonly pathParams: readonly ["database_id"];
@@ -3750,14 +3685,14 @@ type UpdateDatabaseBodyParameters = {
3750
3685
  select: {
3751
3686
  options?: Array<{
3752
3687
  id: StringRequest;
3753
- name?: StringRequest;
3688
+ name?: TextRequest;
3754
3689
  color?: SelectColor;
3755
- description?: StringRequest | null;
3690
+ description?: TextRequest | null;
3756
3691
  } | {
3757
- name: StringRequest;
3692
+ name: TextRequest;
3758
3693
  id?: StringRequest;
3759
3694
  color?: SelectColor;
3760
- description?: StringRequest | null;
3695
+ description?: TextRequest | null;
3761
3696
  }>;
3762
3697
  };
3763
3698
  type?: "select";
@@ -3767,14 +3702,14 @@ type UpdateDatabaseBodyParameters = {
3767
3702
  multi_select: {
3768
3703
  options?: Array<{
3769
3704
  id: StringRequest;
3770
- name?: StringRequest;
3705
+ name?: TextRequest;
3771
3706
  color?: SelectColor;
3772
- description?: StringRequest | null;
3707
+ description?: TextRequest | null;
3773
3708
  } | {
3774
- name: StringRequest;
3709
+ name: TextRequest;
3775
3710
  id?: StringRequest;
3776
3711
  color?: SelectColor;
3777
- description?: StringRequest | null;
3712
+ description?: TextRequest | null;
3778
3713
  }>;
3779
3714
  };
3780
3715
  type?: "multi_select";
@@ -3903,6 +3838,9 @@ type UpdateDatabaseBodyParameters = {
3903
3838
  };
3904
3839
  export type UpdateDatabaseParameters = UpdateDatabasePathParameters & UpdateDatabaseBodyParameters;
3905
3840
  export type UpdateDatabaseResponse = PartialDatabaseObjectResponse | DatabaseObjectResponse;
3841
+ /**
3842
+ * Update a database
3843
+ */
3906
3844
  export declare const updateDatabase: {
3907
3845
  readonly method: "patch";
3908
3846
  readonly pathParams: readonly ["database_id"];
@@ -3951,6 +3889,9 @@ export type QueryDatabaseResponse = {
3951
3889
  has_more: boolean;
3952
3890
  results: Array<PageObjectResponse | PartialPageObjectResponse | PartialDatabaseObjectResponse | DatabaseObjectResponse>;
3953
3891
  };
3892
+ /**
3893
+ * Query a database
3894
+ */
3954
3895
  export declare const queryDatabase: {
3955
3896
  readonly method: "post";
3956
3897
  readonly pathParams: readonly ["database_id"];
@@ -3971,6 +3912,9 @@ export type ListDatabasesResponse = {
3971
3912
  has_more: boolean;
3972
3913
  results: Array<PartialDatabaseObjectResponse | DatabaseObjectResponse>;
3973
3914
  };
3915
+ /**
3916
+ * List databases
3917
+ */
3974
3918
  export declare const listDatabases: {
3975
3919
  readonly method: "get";
3976
3920
  readonly pathParams: readonly [];
@@ -4001,9 +3945,9 @@ type CreateDatabaseBodyParameters = {
4001
3945
  } | {
4002
3946
  select: {
4003
3947
  options?: Array<{
4004
- name: StringRequest;
3948
+ name: TextRequest;
4005
3949
  color?: SelectColor;
4006
- description?: StringRequest | null;
3950
+ description?: TextRequest | null;
4007
3951
  }>;
4008
3952
  };
4009
3953
  type?: "select";
@@ -4011,9 +3955,9 @@ type CreateDatabaseBodyParameters = {
4011
3955
  } | {
4012
3956
  multi_select: {
4013
3957
  options?: Array<{
4014
- name: StringRequest;
3958
+ name: TextRequest;
4015
3959
  color?: SelectColor;
4016
- description?: StringRequest | null;
3960
+ description?: TextRequest | null;
4017
3961
  }>;
4018
3962
  };
4019
3963
  type?: "multi_select";
@@ -4125,6 +4069,9 @@ type CreateDatabaseBodyParameters = {
4125
4069
  };
4126
4070
  export type CreateDatabaseParameters = CreateDatabaseBodyParameters;
4127
4071
  export type CreateDatabaseResponse = PartialDatabaseObjectResponse | DatabaseObjectResponse;
4072
+ /**
4073
+ * Create a database
4074
+ */
4128
4075
  export declare const createDatabase: {
4129
4076
  readonly method: "post";
4130
4077
  readonly pathParams: readonly [];
@@ -4154,6 +4101,9 @@ export type SearchResponse = {
4154
4101
  has_more: boolean;
4155
4102
  results: Array<PageObjectResponse | PartialPageObjectResponse | PartialDatabaseObjectResponse | DatabaseObjectResponse>;
4156
4103
  };
4104
+ /**
4105
+ * Search by title
4106
+ */
4157
4107
  export declare const search: {
4158
4108
  readonly method: "post";
4159
4109
  readonly pathParams: readonly [];
@@ -4179,6 +4129,9 @@ type CreateCommentBodyParameters = {
4179
4129
  };
4180
4130
  export type CreateCommentParameters = CreateCommentBodyParameters;
4181
4131
  export type CreateCommentResponse = CommentObjectResponse | PartialCommentObjectResponse;
4132
+ /**
4133
+ * Create comment
4134
+ */
4182
4135
  export declare const createComment: {
4183
4136
  readonly method: "post";
4184
4137
  readonly pathParams: readonly [];
@@ -4200,6 +4153,9 @@ export type ListCommentsResponse = {
4200
4153
  has_more: boolean;
4201
4154
  results: Array<CommentObjectResponse>;
4202
4155
  };
4156
+ /**
4157
+ * List comments
4158
+ */
4203
4159
  export declare const listComments: {
4204
4160
  readonly method: "get";
4205
4161
  readonly pathParams: readonly [];
@@ -4216,6 +4172,9 @@ type CreateFileUploadBodyParameters = {
4216
4172
  };
4217
4173
  export type CreateFileUploadParameters = CreateFileUploadBodyParameters;
4218
4174
  export type CreateFileUploadResponse = FileUploadObjectResponse;
4175
+ /**
4176
+ * Create a file upload
4177
+ */
4219
4178
  export declare const createFileUpload: {
4220
4179
  readonly method: "post";
4221
4180
  readonly pathParams: readonly [];
@@ -4237,6 +4196,9 @@ export type ListFileUploadsResponse = {
4237
4196
  has_more: boolean;
4238
4197
  results: Array<FileUploadObjectResponse>;
4239
4198
  };
4199
+ /**
4200
+ * List file uploads
4201
+ */
4240
4202
  export declare const listFileUploads: {
4241
4203
  readonly method: "get";
4242
4204
  readonly pathParams: readonly [];
@@ -4256,6 +4218,9 @@ type SendFileUploadFormDataParameters = {
4256
4218
  };
4257
4219
  export type SendFileUploadParameters = SendFileUploadPathParameters & SendFileUploadFormDataParameters;
4258
4220
  export type SendFileUploadResponse = FileUploadObjectResponse;
4221
+ /**
4222
+ * Upload a file
4223
+ */
4259
4224
  export declare const sendFileUpload: {
4260
4225
  readonly method: "post";
4261
4226
  readonly pathParams: readonly ["file_upload_id"];
@@ -4269,6 +4234,9 @@ type CompleteFileUploadPathParameters = {
4269
4234
  };
4270
4235
  export type CompleteFileUploadParameters = CompleteFileUploadPathParameters;
4271
4236
  export type CompleteFileUploadResponse = FileUploadObjectResponse;
4237
+ /**
4238
+ * Complete a multi-part file upload
4239
+ */
4272
4240
  export declare const completeFileUpload: {
4273
4241
  readonly method: "post";
4274
4242
  readonly pathParams: readonly ["file_upload_id"];
@@ -4281,6 +4249,9 @@ type GetFileUploadPathParameters = {
4281
4249
  };
4282
4250
  export type GetFileUploadParameters = GetFileUploadPathParameters;
4283
4251
  export type GetFileUploadResponse = FileUploadObjectResponse;
4252
+ /**
4253
+ * Retrieve a file upload
4254
+ */
4284
4255
  export declare const getFileUpload: {
4285
4256
  readonly method: "get";
4286
4257
  readonly pathParams: readonly ["file_upload_id"];
@@ -4324,6 +4295,9 @@ export type OauthTokenResponse = {
4324
4295
  duplicated_template_id: string | null;
4325
4296
  request_id?: string;
4326
4297
  };
4298
+ /**
4299
+ * Exchange an authorization code for an access token
4300
+ */
4327
4301
  export declare const oauthToken: {
4328
4302
  readonly method: "post";
4329
4303
  readonly pathParams: readonly [];
@@ -4338,6 +4312,9 @@ export type OauthRevokeParameters = OauthRevokeBodyParameters;
4338
4312
  export type OauthRevokeResponse = {
4339
4313
  request_id?: string;
4340
4314
  };
4315
+ /**
4316
+ * Revoke a token
4317
+ */
4341
4318
  export declare const oauthRevoke: {
4342
4319
  readonly method: "post";
4343
4320
  readonly pathParams: readonly [];
@@ -4355,6 +4332,9 @@ export type OauthIntrospectResponse = {
4355
4332
  iat?: number;
4356
4333
  request_id?: string;
4357
4334
  };
4335
+ /**
4336
+ * Introspect a token
4337
+ */
4358
4338
  export declare const oauthIntrospect: {
4359
4339
  readonly method: "post";
4360
4340
  readonly pathParams: readonly [];