@puppi/adapter-notion 0.0.0-stage → 0.1.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/LICENSE +202 -0
- package/README.md +25 -2
- package/dist/define.d.ts +18 -0
- package/dist/define.d.ts.map +1 -0
- package/dist/define.js +12 -0
- package/dist/define.js.map +1 -0
- package/dist/index.d.ts +230 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +125 -0
- package/dist/index.js.map +1 -0
- package/dist/openapi.d.ts +2378 -0
- package/dist/openapi.d.ts.map +1 -0
- package/dist/openapi.js +6 -0
- package/dist/openapi.js.map +1 -0
- package/dist/operations.d.ts +17 -0
- package/dist/operations.d.ts.map +1 -0
- package/dist/operations.js +24 -0
- package/dist/operations.js.map +1 -0
- package/package.json +48 -3
|
@@ -0,0 +1,2378 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by openapi-typescript.
|
|
3
|
+
* Do not make direct changes to the file.
|
|
4
|
+
*/
|
|
5
|
+
export type paths = {
|
|
6
|
+
"/v1/users/me": {
|
|
7
|
+
parameters: {
|
|
8
|
+
query?: never;
|
|
9
|
+
header?: never;
|
|
10
|
+
path?: never;
|
|
11
|
+
cookie?: never;
|
|
12
|
+
};
|
|
13
|
+
/** Retrieve your token's bot user */
|
|
14
|
+
get: operations["get-self"];
|
|
15
|
+
put?: never;
|
|
16
|
+
post?: never;
|
|
17
|
+
delete?: never;
|
|
18
|
+
options?: never;
|
|
19
|
+
head?: never;
|
|
20
|
+
patch?: never;
|
|
21
|
+
trace?: never;
|
|
22
|
+
};
|
|
23
|
+
"/v1/users": {
|
|
24
|
+
parameters: {
|
|
25
|
+
query?: never;
|
|
26
|
+
header?: never;
|
|
27
|
+
path?: never;
|
|
28
|
+
cookie?: never;
|
|
29
|
+
};
|
|
30
|
+
/** List all users */
|
|
31
|
+
get: operations["get-users"];
|
|
32
|
+
put?: never;
|
|
33
|
+
post?: never;
|
|
34
|
+
delete?: never;
|
|
35
|
+
options?: never;
|
|
36
|
+
head?: never;
|
|
37
|
+
patch?: never;
|
|
38
|
+
trace?: never;
|
|
39
|
+
};
|
|
40
|
+
"/v1/search": {
|
|
41
|
+
parameters: {
|
|
42
|
+
query?: never;
|
|
43
|
+
header?: never;
|
|
44
|
+
path?: never;
|
|
45
|
+
cookie?: never;
|
|
46
|
+
};
|
|
47
|
+
get?: never;
|
|
48
|
+
put?: never;
|
|
49
|
+
/** Search by title */
|
|
50
|
+
post: operations["post-search"];
|
|
51
|
+
delete?: never;
|
|
52
|
+
options?: never;
|
|
53
|
+
head?: never;
|
|
54
|
+
patch?: never;
|
|
55
|
+
trace?: never;
|
|
56
|
+
};
|
|
57
|
+
"/v1/data_sources/{data_source_id}/query": {
|
|
58
|
+
parameters: {
|
|
59
|
+
query?: never;
|
|
60
|
+
header?: never;
|
|
61
|
+
path?: never;
|
|
62
|
+
cookie?: never;
|
|
63
|
+
};
|
|
64
|
+
get?: never;
|
|
65
|
+
put?: never;
|
|
66
|
+
/** Query a data source */
|
|
67
|
+
post: operations["post-database-query"];
|
|
68
|
+
delete?: never;
|
|
69
|
+
options?: never;
|
|
70
|
+
head?: never;
|
|
71
|
+
patch?: never;
|
|
72
|
+
trace?: never;
|
|
73
|
+
};
|
|
74
|
+
};
|
|
75
|
+
export type webhooks = Record<string, never>;
|
|
76
|
+
export type components = {
|
|
77
|
+
schemas: {
|
|
78
|
+
agentIdParentForBlockBasedObjectResponse: {
|
|
79
|
+
/**
|
|
80
|
+
* @description The parent type.
|
|
81
|
+
* @constant
|
|
82
|
+
*/
|
|
83
|
+
type: "agent_id";
|
|
84
|
+
/** @description The ID of the parent agent. */
|
|
85
|
+
agent_id: components["schemas"]["idResponse"];
|
|
86
|
+
};
|
|
87
|
+
annotationResponse: {
|
|
88
|
+
bold: boolean;
|
|
89
|
+
italic: boolean;
|
|
90
|
+
strikethrough: boolean;
|
|
91
|
+
underline: boolean;
|
|
92
|
+
code: boolean;
|
|
93
|
+
color: components["schemas"]["apiColor"];
|
|
94
|
+
};
|
|
95
|
+
/**
|
|
96
|
+
* @description One of: `default`, `gray`, `brown`, `orange`, `yellow`, `green`, `blue`, `purple`, `pink`, `red`, `default_background`, `gray_background`, `brown_background`, `orange_background`, `yellow_background`, `green_background`, `blue_background`, `purple_background`, `pink_background`, `red_background`
|
|
97
|
+
* @enum {string}
|
|
98
|
+
*/
|
|
99
|
+
apiColor: "default" | "gray" | "brown" | "orange" | "yellow" | "green" | "blue" | "purple" | "pink" | "red" | "default_background" | "gray_background" | "brown_background" | "orange_background" | "yellow_background" | "green_background" | "blue_background" | "purple_background" | "pink_background" | "red_background";
|
|
100
|
+
arrayBasedPropertyValueResponse: components["schemas"]["titleArrayBasedPropertyValueResponse"] | components["schemas"]["richTextArrayBasedPropertyValueResponse"] | components["schemas"]["peopleArrayBasedPropertyValueResponse"] | components["schemas"]["relationArrayBasedPropertyValueResponse"];
|
|
101
|
+
/** Array */
|
|
102
|
+
arrayPartialRollupValueResponse: {
|
|
103
|
+
/**
|
|
104
|
+
* @description Always `array`
|
|
105
|
+
* @constant
|
|
106
|
+
*/
|
|
107
|
+
type: "array";
|
|
108
|
+
array: components["schemas"]["simpleOrArrayPropertyValueResponse"][];
|
|
109
|
+
};
|
|
110
|
+
blockIdParentForBlockBasedObjectResponse: {
|
|
111
|
+
/**
|
|
112
|
+
* @description The parent type.
|
|
113
|
+
* @constant
|
|
114
|
+
*/
|
|
115
|
+
type: "block_id";
|
|
116
|
+
/** @description The ID of the parent block. */
|
|
117
|
+
block_id: components["schemas"]["idResponse"];
|
|
118
|
+
};
|
|
119
|
+
/** Boolean */
|
|
120
|
+
booleanFormulaPropertyValueResponse: {
|
|
121
|
+
/**
|
|
122
|
+
* @description Always `boolean`
|
|
123
|
+
* @constant
|
|
124
|
+
*/
|
|
125
|
+
type: "boolean";
|
|
126
|
+
boolean: boolean | null;
|
|
127
|
+
};
|
|
128
|
+
botInfoResponse: {
|
|
129
|
+
/** @description Details about the owner of the bot. */
|
|
130
|
+
owner: {
|
|
131
|
+
/**
|
|
132
|
+
* @description Always `user`
|
|
133
|
+
* @constant
|
|
134
|
+
*/
|
|
135
|
+
type: "user";
|
|
136
|
+
/** @description Details about the owner of the bot, when the `type` of the owner is `user`. This means the bot is for a integration. */
|
|
137
|
+
user: {
|
|
138
|
+
/** @description The ID of the user. */
|
|
139
|
+
id: components["schemas"]["idResponse"];
|
|
140
|
+
/**
|
|
141
|
+
* @description The user object type name.
|
|
142
|
+
* @constant
|
|
143
|
+
*/
|
|
144
|
+
object: "user";
|
|
145
|
+
/** @description The name of the user. */
|
|
146
|
+
name: string | null;
|
|
147
|
+
/** @description The avatar URL of the user. */
|
|
148
|
+
avatar_url: string | null;
|
|
149
|
+
/**
|
|
150
|
+
* @description The type of the user.
|
|
151
|
+
* @constant
|
|
152
|
+
*/
|
|
153
|
+
type: "person";
|
|
154
|
+
/** @description The person info of the user. */
|
|
155
|
+
person: {
|
|
156
|
+
/** @description The email of the person. */
|
|
157
|
+
email?: string;
|
|
158
|
+
/** @description Whether the person's email is verified. */
|
|
159
|
+
email_verified?: boolean;
|
|
160
|
+
};
|
|
161
|
+
} | components["schemas"]["partialUserObjectResponse"];
|
|
162
|
+
} | {
|
|
163
|
+
/**
|
|
164
|
+
* @description Always `workspace`
|
|
165
|
+
* @constant
|
|
166
|
+
*/
|
|
167
|
+
type: "workspace";
|
|
168
|
+
/**
|
|
169
|
+
* @description Details about the owner of the bot, when the `type` of the owner is `workspace`. This means the bot is for an internal integration.
|
|
170
|
+
* @constant
|
|
171
|
+
*/
|
|
172
|
+
workspace: true;
|
|
173
|
+
};
|
|
174
|
+
/** @description The ID of the bot's workspace. */
|
|
175
|
+
workspace_id: string;
|
|
176
|
+
/** @description Limits and restrictions that apply to the bot's workspace */
|
|
177
|
+
workspace_limits: {
|
|
178
|
+
/** @description The maximum allowable size of a file upload, in bytes */
|
|
179
|
+
max_file_upload_size_in_bytes: number;
|
|
180
|
+
};
|
|
181
|
+
/** @description The name of the bot's workspace. */
|
|
182
|
+
workspace_name: string | null;
|
|
183
|
+
};
|
|
184
|
+
/** Bot */
|
|
185
|
+
botUserObjectResponse: {
|
|
186
|
+
/**
|
|
187
|
+
* @description Indicates this user is a bot.
|
|
188
|
+
* @constant
|
|
189
|
+
*/
|
|
190
|
+
type: "bot";
|
|
191
|
+
/** @description Details about the bot, when the `type` of the user is `bot`. */
|
|
192
|
+
bot: components["schemas"]["emptyObject"] | components["schemas"]["botInfoResponse"];
|
|
193
|
+
};
|
|
194
|
+
/** Button */
|
|
195
|
+
buttonSimplePropertyValueResponse: {
|
|
196
|
+
/**
|
|
197
|
+
* @description Always `button`
|
|
198
|
+
* @constant
|
|
199
|
+
*/
|
|
200
|
+
type: "button";
|
|
201
|
+
button: components["schemas"]["emptyObject"];
|
|
202
|
+
};
|
|
203
|
+
/** Checkbox */
|
|
204
|
+
checkboxDatabasePropertyConfigResponse: {
|
|
205
|
+
/**
|
|
206
|
+
* @description Always `checkbox`
|
|
207
|
+
* @constant
|
|
208
|
+
*/
|
|
209
|
+
type: "checkbox";
|
|
210
|
+
checkbox: components["schemas"]["emptyObject"];
|
|
211
|
+
};
|
|
212
|
+
checkboxPropertyFilter: {
|
|
213
|
+
equals: boolean;
|
|
214
|
+
} | {
|
|
215
|
+
does_not_equal: boolean;
|
|
216
|
+
};
|
|
217
|
+
/** Checkbox */
|
|
218
|
+
checkboxSimplePropertyValueResponse: {
|
|
219
|
+
/**
|
|
220
|
+
* @description Always `checkbox`
|
|
221
|
+
* @constant
|
|
222
|
+
*/
|
|
223
|
+
type: "checkbox";
|
|
224
|
+
checkbox: boolean;
|
|
225
|
+
};
|
|
226
|
+
/** Created By */
|
|
227
|
+
createdByDatabasePropertyConfigResponse: {
|
|
228
|
+
/**
|
|
229
|
+
* @description Always `created_by`
|
|
230
|
+
* @constant
|
|
231
|
+
*/
|
|
232
|
+
type: "created_by";
|
|
233
|
+
created_by: components["schemas"]["emptyObject"];
|
|
234
|
+
};
|
|
235
|
+
/** Created By */
|
|
236
|
+
createdBySimplePropertyValueResponse: {
|
|
237
|
+
/**
|
|
238
|
+
* @description Always `created_by`
|
|
239
|
+
* @constant
|
|
240
|
+
*/
|
|
241
|
+
type: "created_by";
|
|
242
|
+
created_by: components["schemas"]["userValueResponse"];
|
|
243
|
+
};
|
|
244
|
+
/** Created Time */
|
|
245
|
+
createdTimeDatabasePropertyConfigResponse: {
|
|
246
|
+
/**
|
|
247
|
+
* @description Always `created_time`
|
|
248
|
+
* @constant
|
|
249
|
+
*/
|
|
250
|
+
type: "created_time";
|
|
251
|
+
created_time: components["schemas"]["emptyObject"];
|
|
252
|
+
};
|
|
253
|
+
/** Created Time */
|
|
254
|
+
createdTimeSimplePropertyValueResponse: {
|
|
255
|
+
/**
|
|
256
|
+
* @description Always `created_time`
|
|
257
|
+
* @constant
|
|
258
|
+
*/
|
|
259
|
+
type: "created_time";
|
|
260
|
+
/** Format: date-time */
|
|
261
|
+
created_time: string;
|
|
262
|
+
};
|
|
263
|
+
/** Custom Emoji */
|
|
264
|
+
customEmojiPageIconResponse: {
|
|
265
|
+
/**
|
|
266
|
+
* @description Type of icon. In this case, a custom emoji.
|
|
267
|
+
* @constant
|
|
268
|
+
*/
|
|
269
|
+
type: "custom_emoji";
|
|
270
|
+
/** @description The custom emoji details for the icon. */
|
|
271
|
+
custom_emoji: components["schemas"]["customEmojiResponse"];
|
|
272
|
+
};
|
|
273
|
+
customEmojiResponse: {
|
|
274
|
+
/** @description The ID of the custom emoji. */
|
|
275
|
+
id: components["schemas"]["idResponse"];
|
|
276
|
+
/** @description The name of the custom emoji. */
|
|
277
|
+
name: string;
|
|
278
|
+
/** @description The URL of the custom emoji. */
|
|
279
|
+
url: string;
|
|
280
|
+
};
|
|
281
|
+
dataSourceObjectResponse: {
|
|
282
|
+
/**
|
|
283
|
+
* @description The data source object type name.
|
|
284
|
+
* @constant
|
|
285
|
+
*/
|
|
286
|
+
object: "data_source";
|
|
287
|
+
/** @description The ID of the data source. */
|
|
288
|
+
id: components["schemas"]["idResponse"];
|
|
289
|
+
/** @description The title of the data source. */
|
|
290
|
+
title: components["schemas"]["richTextItemResponse"][];
|
|
291
|
+
/** @description The description of the data source. */
|
|
292
|
+
description: components["schemas"]["richTextItemResponse"][];
|
|
293
|
+
/** @description The parent of the data source. */
|
|
294
|
+
parent: components["schemas"]["parentOfDataSourceResponse"];
|
|
295
|
+
/** @description The parent of the data source's containing database. This is typically a page, block, or workspace, but can be another database in the case of wikis. */
|
|
296
|
+
database_parent: components["schemas"]["parentOfDatabaseResponse"];
|
|
297
|
+
/** @description Whether the data source is inline. */
|
|
298
|
+
is_inline: boolean;
|
|
299
|
+
/** @description The type of typed database this data source belongs to, or `null` for a regular data source. */
|
|
300
|
+
database_type: ("tasks" | "projects" | "sprints" | "docs" | "wiki" | "meetings" | "meeting_notes" | "skills" | "github_prs") | null;
|
|
301
|
+
/** @description Whether the data source is in the trash. */
|
|
302
|
+
in_trash: boolean;
|
|
303
|
+
/**
|
|
304
|
+
* Format: date-time
|
|
305
|
+
* @description The time when the data source was created.
|
|
306
|
+
*/
|
|
307
|
+
created_time: string;
|
|
308
|
+
/**
|
|
309
|
+
* Format: date-time
|
|
310
|
+
* @description The time when the data source was last edited.
|
|
311
|
+
*/
|
|
312
|
+
last_edited_time: string;
|
|
313
|
+
/** @description The user who created the data source. */
|
|
314
|
+
created_by: components["schemas"]["partialUserObjectResponse"];
|
|
315
|
+
/** @description The user who last edited the data source. */
|
|
316
|
+
last_edited_by: components["schemas"]["partialUserObjectResponse"];
|
|
317
|
+
/** @description The properties schema of the data source. */
|
|
318
|
+
properties: {
|
|
319
|
+
[key: string]: components["schemas"]["databasePropertyConfigResponse"];
|
|
320
|
+
};
|
|
321
|
+
/** @description The icon of the data source. */
|
|
322
|
+
icon: components["schemas"]["pageIconResponse"] | null;
|
|
323
|
+
/** @description The cover of the data source. */
|
|
324
|
+
cover: components["schemas"]["pageCoverResponse"] | null;
|
|
325
|
+
/** @description The URL of the data source. */
|
|
326
|
+
url: string;
|
|
327
|
+
/** @description The public URL of the data source if it is publicly accessible. */
|
|
328
|
+
public_url: string | null;
|
|
329
|
+
/** @description Sync identity and available health, included when listing or retrieving data sources. */
|
|
330
|
+
sync_metadata?: {
|
|
331
|
+
/** @description Live collection sync health. Null means unavailable, not unhealthy. Missing timestamps are unknown. */
|
|
332
|
+
health?: null | {
|
|
333
|
+
checks: {
|
|
334
|
+
sync_version_updated_at: string;
|
|
335
|
+
delta_synced_through_at?: string;
|
|
336
|
+
last_execution_succeeded_at?: string;
|
|
337
|
+
};
|
|
338
|
+
error: {
|
|
339
|
+
code: string;
|
|
340
|
+
/** @enum {string} */
|
|
341
|
+
severity: "action_required" | "degraded" | "failing";
|
|
342
|
+
};
|
|
343
|
+
/** @constant */
|
|
344
|
+
ok: false;
|
|
345
|
+
paused: boolean;
|
|
346
|
+
/** @enum {string} */
|
|
347
|
+
stage: "backfilling" | "initializing" | "steady";
|
|
348
|
+
} | {
|
|
349
|
+
checks: {
|
|
350
|
+
sync_version_updated_at: string;
|
|
351
|
+
delta_synced_through_at?: string;
|
|
352
|
+
last_execution_succeeded_at?: string;
|
|
353
|
+
};
|
|
354
|
+
/** @constant */
|
|
355
|
+
ok: true;
|
|
356
|
+
paused: boolean;
|
|
357
|
+
/** @enum {string} */
|
|
358
|
+
stage: "backfilling" | "initializing" | "steady";
|
|
359
|
+
} | {
|
|
360
|
+
/** @constant */
|
|
361
|
+
paused: true;
|
|
362
|
+
};
|
|
363
|
+
/** @description Notion user who owns the sync credential, included when health is available. */
|
|
364
|
+
owner_user_id?: components["schemas"]["idResponse"];
|
|
365
|
+
/** @description Provider resource synced to this data source, when available. */
|
|
366
|
+
resource?: string;
|
|
367
|
+
/** @description Stored identity of an external database sync. */
|
|
368
|
+
external_database_sync?: {
|
|
369
|
+
/** @description The stored sync ID. This is not a credential. */
|
|
370
|
+
sync_id: components["schemas"]["idResponse"];
|
|
371
|
+
/**
|
|
372
|
+
* @description The sync provider: github (GitHub), jira (Jira), or salesforce (Salesforce).
|
|
373
|
+
* @enum {string}
|
|
374
|
+
*/
|
|
375
|
+
provider: "github" | "jira" | "salesforce";
|
|
376
|
+
};
|
|
377
|
+
/**
|
|
378
|
+
* @description The provider of a legacy synced data source: Jira or Salesforce. Values are case-sensitive.
|
|
379
|
+
* @enum {string}
|
|
380
|
+
*/
|
|
381
|
+
external_collection_type?: "Jira" | "Salesforce";
|
|
382
|
+
/** @description The stored sync ID when provider details are unavailable. This is not a credential. */
|
|
383
|
+
sync_id?: components["schemas"]["idResponse"];
|
|
384
|
+
/** @description Stored state for a legacy synced data source. Missing or invalid timestamps are omitted. This is not a live health check. */
|
|
385
|
+
sync_state?: {
|
|
386
|
+
/** @description Stored legacy sync state: true means syncing, false means not syncing, and row_limit_exceeded means the row limit stopped syncing. False does not guarantee a successful sync. */
|
|
387
|
+
syncing: boolean | "row_limit_exceeded";
|
|
388
|
+
/**
|
|
389
|
+
* Format: date-time
|
|
390
|
+
* @description Stored legacy sync update time in UTC ISO 8601 format. This does not guarantee that all source changes have been imported.
|
|
391
|
+
*/
|
|
392
|
+
last_synced_at?: string;
|
|
393
|
+
/**
|
|
394
|
+
* Format: date-time
|
|
395
|
+
* @description Stored legacy sync checkpoint time in UTC ISO 8601 format.
|
|
396
|
+
*/
|
|
397
|
+
last_sync_checkpoint_at?: string;
|
|
398
|
+
/**
|
|
399
|
+
* Format: date-time
|
|
400
|
+
* @description Stored legacy sync heartbeat time in UTC ISO 8601 format.
|
|
401
|
+
*/
|
|
402
|
+
last_sync_heartbeat_at?: string;
|
|
403
|
+
};
|
|
404
|
+
/** @description Opaque, developer-defined collection key for a worker sync. It is not a globally unique ID or a credential. Worker status is not included. */
|
|
405
|
+
synced_collection_key?: string;
|
|
406
|
+
};
|
|
407
|
+
};
|
|
408
|
+
dataSourceParentResponse: {
|
|
409
|
+
/**
|
|
410
|
+
* @description The parent type.
|
|
411
|
+
* @constant
|
|
412
|
+
*/
|
|
413
|
+
type: "data_source_id";
|
|
414
|
+
/** @description The ID of the parent data source. */
|
|
415
|
+
data_source_id: components["schemas"]["idResponse"];
|
|
416
|
+
/** @description The ID of the data source's parent database. */
|
|
417
|
+
database_id: components["schemas"]["idResponse"];
|
|
418
|
+
};
|
|
419
|
+
databaseParentResponse: {
|
|
420
|
+
/**
|
|
421
|
+
* @description The parent type.
|
|
422
|
+
* @constant
|
|
423
|
+
*/
|
|
424
|
+
type: "database_id";
|
|
425
|
+
/** @description The ID of the parent database. */
|
|
426
|
+
database_id: components["schemas"]["idResponse"];
|
|
427
|
+
};
|
|
428
|
+
databasePropertyConfigResponse: components["schemas"]["databasePropertyConfigResponseCommon"] & (components["schemas"]["numberDatabasePropertyConfigResponse"] | components["schemas"]["formulaDatabasePropertyConfigResponse"] | components["schemas"]["selectDatabasePropertyConfigResponse"] | components["schemas"]["multiSelectDatabasePropertyConfigResponse"] | components["schemas"]["statusDatabasePropertyConfigResponse"] | components["schemas"]["relationDatabasePropertyConfigResponse"] | components["schemas"]["rollupDatabasePropertyConfigResponse"] | components["schemas"]["uniqueIdDatabasePropertyConfigResponse"] | components["schemas"]["titleDatabasePropertyConfigResponse"] | components["schemas"]["richTextDatabasePropertyConfigResponse"] | components["schemas"]["urlDatabasePropertyConfigResponse"] | components["schemas"]["peopleDatabasePropertyConfigResponse"] | components["schemas"]["filesDatabasePropertyConfigResponse"] | components["schemas"]["emailDatabasePropertyConfigResponse"] | components["schemas"]["phoneNumberDatabasePropertyConfigResponse"] | components["schemas"]["dateDatabasePropertyConfigResponse"] | components["schemas"]["checkboxDatabasePropertyConfigResponse"] | components["schemas"]["createdByDatabasePropertyConfigResponse"] | components["schemas"]["createdTimeDatabasePropertyConfigResponse"] | components["schemas"]["lastEditedByDatabasePropertyConfigResponse"] | components["schemas"]["lastEditedTimeDatabasePropertyConfigResponse"]);
|
|
429
|
+
databasePropertyConfigResponseCommon: {
|
|
430
|
+
/** @description The ID of the property. */
|
|
431
|
+
id: string;
|
|
432
|
+
/** @description The name of the property. */
|
|
433
|
+
name: string;
|
|
434
|
+
/** @description The description of the property. */
|
|
435
|
+
description: components["schemas"]["propertyDescriptionRequest"] | null;
|
|
436
|
+
};
|
|
437
|
+
databasePropertyRelationConfigResponse: components["schemas"]["databasePropertyRelationConfigResponseCommon"] & (components["schemas"]["singlePropertyDatabasePropertyRelationConfigResponse"] | components["schemas"]["dualPropertyDatabasePropertyRelationConfigResponse"]);
|
|
438
|
+
databasePropertyRelationConfigResponseCommon: {
|
|
439
|
+
database_id: components["schemas"]["idResponse"];
|
|
440
|
+
data_source_id: components["schemas"]["idResponse"];
|
|
441
|
+
/** @description The maximum number of pages each page can relate to, or null when there is no limit. Read-only. */
|
|
442
|
+
limit: number | null;
|
|
443
|
+
};
|
|
444
|
+
/** Date */
|
|
445
|
+
dateDatabasePropertyConfigResponse: {
|
|
446
|
+
/**
|
|
447
|
+
* @description Always `date`
|
|
448
|
+
* @constant
|
|
449
|
+
*/
|
|
450
|
+
type: "date";
|
|
451
|
+
date: components["schemas"]["emptyObject"];
|
|
452
|
+
};
|
|
453
|
+
/** Date */
|
|
454
|
+
dateFormulaPropertyValueResponse: {
|
|
455
|
+
/**
|
|
456
|
+
* @description Always `date`
|
|
457
|
+
* @constant
|
|
458
|
+
*/
|
|
459
|
+
type: "date";
|
|
460
|
+
date: components["schemas"]["dateResponse"] | null;
|
|
461
|
+
};
|
|
462
|
+
dateOrRelativeDate: string | components["schemas"]["relativeDateValue"];
|
|
463
|
+
/** Date */
|
|
464
|
+
datePartialRollupValueResponse: {
|
|
465
|
+
/**
|
|
466
|
+
* @description Always `date`
|
|
467
|
+
* @constant
|
|
468
|
+
*/
|
|
469
|
+
type: "date";
|
|
470
|
+
date: components["schemas"]["dateResponse"] | null;
|
|
471
|
+
};
|
|
472
|
+
datePropertyFilter: ({
|
|
473
|
+
equals: components["schemas"]["dateOrRelativeDate"];
|
|
474
|
+
} | {
|
|
475
|
+
before: components["schemas"]["dateOrRelativeDate"];
|
|
476
|
+
} | {
|
|
477
|
+
after: components["schemas"]["dateOrRelativeDate"];
|
|
478
|
+
} | {
|
|
479
|
+
on_or_before: components["schemas"]["dateOrRelativeDate"];
|
|
480
|
+
} | {
|
|
481
|
+
on_or_after: components["schemas"]["dateOrRelativeDate"];
|
|
482
|
+
} | {
|
|
483
|
+
this_week: components["schemas"]["emptyObject"];
|
|
484
|
+
} | {
|
|
485
|
+
past_week: components["schemas"]["emptyObject"];
|
|
486
|
+
} | {
|
|
487
|
+
past_month: components["schemas"]["emptyObject"];
|
|
488
|
+
} | {
|
|
489
|
+
past_year: components["schemas"]["emptyObject"];
|
|
490
|
+
} | {
|
|
491
|
+
next_week: components["schemas"]["emptyObject"];
|
|
492
|
+
} | {
|
|
493
|
+
next_month: components["schemas"]["emptyObject"];
|
|
494
|
+
} | {
|
|
495
|
+
next_year: components["schemas"]["emptyObject"];
|
|
496
|
+
}) | components["schemas"]["existencePropertyFilter"];
|
|
497
|
+
dateResponse: {
|
|
498
|
+
/**
|
|
499
|
+
* Format: date
|
|
500
|
+
* @description The start date of the date object.
|
|
501
|
+
*/
|
|
502
|
+
start: string;
|
|
503
|
+
/** @description The end date of the date object, if any. */
|
|
504
|
+
end: string | null;
|
|
505
|
+
/** @description The time zone of the date object. */
|
|
506
|
+
time_zone: components["schemas"]["timeZoneRequest"] | null;
|
|
507
|
+
};
|
|
508
|
+
/** Date */
|
|
509
|
+
dateSimplePropertyValueResponse: {
|
|
510
|
+
/**
|
|
511
|
+
* @description Always `date`
|
|
512
|
+
* @constant
|
|
513
|
+
*/
|
|
514
|
+
type: "date";
|
|
515
|
+
date: components["schemas"]["dateResponse"] | null;
|
|
516
|
+
};
|
|
517
|
+
/** Dual Property */
|
|
518
|
+
dualPropertyDatabasePropertyRelationConfigResponse: {
|
|
519
|
+
/**
|
|
520
|
+
* @description Always `dual_property`
|
|
521
|
+
* @constant
|
|
522
|
+
*/
|
|
523
|
+
type?: "dual_property";
|
|
524
|
+
dual_property: {
|
|
525
|
+
synced_property_id: string;
|
|
526
|
+
synced_property_name: string;
|
|
527
|
+
};
|
|
528
|
+
};
|
|
529
|
+
/** Email */
|
|
530
|
+
emailDatabasePropertyConfigResponse: {
|
|
531
|
+
/**
|
|
532
|
+
* @description Always `email`
|
|
533
|
+
* @constant
|
|
534
|
+
*/
|
|
535
|
+
type: "email";
|
|
536
|
+
email: components["schemas"]["emptyObject"];
|
|
537
|
+
};
|
|
538
|
+
/** Email */
|
|
539
|
+
emailSimplePropertyValueResponse: {
|
|
540
|
+
/**
|
|
541
|
+
* @description Always `email`
|
|
542
|
+
* @constant
|
|
543
|
+
*/
|
|
544
|
+
type: "email";
|
|
545
|
+
email: string | null;
|
|
546
|
+
};
|
|
547
|
+
/** Emoji */
|
|
548
|
+
emojiPageIconResponse: {
|
|
549
|
+
/**
|
|
550
|
+
* @description Type of icon. In this case, an emoji.
|
|
551
|
+
* @constant
|
|
552
|
+
*/
|
|
553
|
+
type: "emoji";
|
|
554
|
+
/** @description The emoji character used as the icon. */
|
|
555
|
+
emoji: components["schemas"]["emojiRequest"];
|
|
556
|
+
};
|
|
557
|
+
/** @example 😀 */
|
|
558
|
+
emojiRequest: string;
|
|
559
|
+
emptyObject: Record<string, unknown>;
|
|
560
|
+
/** Equation */
|
|
561
|
+
equationRichTextItemResponse: {
|
|
562
|
+
/**
|
|
563
|
+
* @description Always `equation`
|
|
564
|
+
* @constant
|
|
565
|
+
*/
|
|
566
|
+
type: "equation";
|
|
567
|
+
/** @description Notion supports inline LaTeX equations as rich text objects with a type value of `equation`. */
|
|
568
|
+
equation: {
|
|
569
|
+
/**
|
|
570
|
+
* @description A KaTeX compatible string.
|
|
571
|
+
* @example e=mc^2
|
|
572
|
+
*/
|
|
573
|
+
expression: string;
|
|
574
|
+
};
|
|
575
|
+
};
|
|
576
|
+
error_api_400: components["schemas"]["publicApiCommonErrorResponse"] & {
|
|
577
|
+
/** @enum {unknown} */
|
|
578
|
+
code: "invalid_json" | "invalid_request_url" | "invalid_request" | "missing_version" | "invalid_beta" | "validation_error" | "invalid_credit_limit";
|
|
579
|
+
/** @constant */
|
|
580
|
+
status: 400;
|
|
581
|
+
};
|
|
582
|
+
error_api_401: components["schemas"]["publicApiCommonErrorResponse"] & {
|
|
583
|
+
/** @enum {unknown} */
|
|
584
|
+
code: "unauthorized";
|
|
585
|
+
/** @constant */
|
|
586
|
+
status: 401;
|
|
587
|
+
};
|
|
588
|
+
error_api_403: (components["schemas"]["publicApiCommonErrorResponse"] & {
|
|
589
|
+
/** @enum {unknown} */
|
|
590
|
+
code: "restricted_resource" | "status_change_not_allowed";
|
|
591
|
+
/** @constant */
|
|
592
|
+
status: 403;
|
|
593
|
+
}) | (components["schemas"]["publicApiCommonErrorResponse"] & {
|
|
594
|
+
/** @constant */
|
|
595
|
+
code: "workspace_credits_exhausted";
|
|
596
|
+
/** @constant */
|
|
597
|
+
status: 403;
|
|
598
|
+
additional_data: {
|
|
599
|
+
/** @constant */
|
|
600
|
+
tool_error_code: "workspace_credits_exhausted";
|
|
601
|
+
/** @constant */
|
|
602
|
+
tool_error_class: "entitlement_required";
|
|
603
|
+
/** @constant */
|
|
604
|
+
tool_error_retryable: "false";
|
|
605
|
+
/**
|
|
606
|
+
* @description The recovery action selected by Notion for the caller.
|
|
607
|
+
* @enum {unknown}
|
|
608
|
+
*/
|
|
609
|
+
recovery_kind: "contact_workspace_owner" | "open_workspace_credit_settings";
|
|
610
|
+
/**
|
|
611
|
+
* Format: uri
|
|
612
|
+
* @description Present when recovery_kind directs the caller to a settings page.
|
|
613
|
+
*/
|
|
614
|
+
recovery_url?: string;
|
|
615
|
+
} & {
|
|
616
|
+
[key: string]: string | string[];
|
|
617
|
+
};
|
|
618
|
+
}) | (components["schemas"]["publicApiCommonErrorResponse"] & {
|
|
619
|
+
/** @constant */
|
|
620
|
+
code: "agent_credit_limit_reached";
|
|
621
|
+
/** @constant */
|
|
622
|
+
status: 403;
|
|
623
|
+
additional_data: {
|
|
624
|
+
/** @constant */
|
|
625
|
+
tool_error_code: "agent_credit_limit_reached";
|
|
626
|
+
/** @constant */
|
|
627
|
+
tool_error_class: "entitlement_required";
|
|
628
|
+
/** @constant */
|
|
629
|
+
tool_error_retryable: "false";
|
|
630
|
+
/**
|
|
631
|
+
* @description The recovery action selected by Notion for the caller.
|
|
632
|
+
* @enum {unknown}
|
|
633
|
+
*/
|
|
634
|
+
recovery_kind: "contact_workspace_owner" | "none" | "open_agent_settings" | "request_agent_limit_increase" | "request_pending";
|
|
635
|
+
/**
|
|
636
|
+
* Format: uri
|
|
637
|
+
* @description Present when recovery_kind directs the caller to a settings page.
|
|
638
|
+
*/
|
|
639
|
+
recovery_url?: string;
|
|
640
|
+
} & {
|
|
641
|
+
[key: string]: string | string[];
|
|
642
|
+
};
|
|
643
|
+
});
|
|
644
|
+
error_api_404: components["schemas"]["publicApiCommonErrorResponse"] & {
|
|
645
|
+
/** @enum {unknown} */
|
|
646
|
+
code: "object_not_found" | "directory_not_found";
|
|
647
|
+
/** @constant */
|
|
648
|
+
status: 404;
|
|
649
|
+
};
|
|
650
|
+
error_api_406: components["schemas"]["publicApiCommonErrorResponse"] & {
|
|
651
|
+
/** @enum {unknown} */
|
|
652
|
+
code: "row_limit_exceeded";
|
|
653
|
+
/** @constant */
|
|
654
|
+
status: 406;
|
|
655
|
+
};
|
|
656
|
+
error_api_409: components["schemas"]["publicApiCommonErrorResponse"] & {
|
|
657
|
+
/** @enum {unknown} */
|
|
658
|
+
code: "conflict_error" | "idempotency_key_reused" | "agent_deleted";
|
|
659
|
+
/** @constant */
|
|
660
|
+
status: 409;
|
|
661
|
+
};
|
|
662
|
+
error_api_429: components["schemas"]["publicApiCommonErrorResponse"] & {
|
|
663
|
+
/** @enum {unknown} */
|
|
664
|
+
code: "rate_limited";
|
|
665
|
+
/** @constant */
|
|
666
|
+
status: 429;
|
|
667
|
+
};
|
|
668
|
+
error_api_500: components["schemas"]["publicApiCommonErrorResponse"] & {
|
|
669
|
+
/** @enum {unknown} */
|
|
670
|
+
code: "internal_server_error";
|
|
671
|
+
/** @constant */
|
|
672
|
+
status: 500;
|
|
673
|
+
};
|
|
674
|
+
error_api_503: components["schemas"]["publicApiCommonErrorResponse"] & {
|
|
675
|
+
/** @enum {unknown} */
|
|
676
|
+
code: "service_unavailable";
|
|
677
|
+
/** @constant */
|
|
678
|
+
status: 503;
|
|
679
|
+
};
|
|
680
|
+
error_api_504: components["schemas"]["publicApiCommonErrorResponse"] & {
|
|
681
|
+
/** @enum {unknown} */
|
|
682
|
+
code: "gateway_timeout";
|
|
683
|
+
/** @constant */
|
|
684
|
+
status: 504;
|
|
685
|
+
};
|
|
686
|
+
error_api_529: components["schemas"]["publicApiCommonErrorResponse"] & {
|
|
687
|
+
/** @enum {unknown} */
|
|
688
|
+
code: "service_overload";
|
|
689
|
+
/** @constant */
|
|
690
|
+
status: 529;
|
|
691
|
+
};
|
|
692
|
+
existencePropertyFilter: {
|
|
693
|
+
/** @constant */
|
|
694
|
+
is_empty: true;
|
|
695
|
+
} | {
|
|
696
|
+
/** @constant */
|
|
697
|
+
is_not_empty: true;
|
|
698
|
+
};
|
|
699
|
+
/** External */
|
|
700
|
+
externalInternalOrExternalFileWithNameResponse: {
|
|
701
|
+
/**
|
|
702
|
+
* @description Type of attachment. In this case, an external URL.
|
|
703
|
+
* @constant
|
|
704
|
+
*/
|
|
705
|
+
type: "external";
|
|
706
|
+
/** @description The external URL. */
|
|
707
|
+
external: {
|
|
708
|
+
/** @description The URL of the external file or resource. */
|
|
709
|
+
url: string;
|
|
710
|
+
};
|
|
711
|
+
};
|
|
712
|
+
/** External */
|
|
713
|
+
externalPageCoverResponse: {
|
|
714
|
+
/**
|
|
715
|
+
* @description Type of cover. In this case, an external URL.
|
|
716
|
+
* @constant
|
|
717
|
+
*/
|
|
718
|
+
type: "external";
|
|
719
|
+
/** @description The external URL for the cover. */
|
|
720
|
+
external: {
|
|
721
|
+
/** @description The URL of the external file or resource. */
|
|
722
|
+
url: string;
|
|
723
|
+
};
|
|
724
|
+
};
|
|
725
|
+
/** External */
|
|
726
|
+
externalPageIconResponse: {
|
|
727
|
+
/**
|
|
728
|
+
* @description Type of icon. In this case, an external URL.
|
|
729
|
+
* @constant
|
|
730
|
+
*/
|
|
731
|
+
type: "external";
|
|
732
|
+
/** @description The external URL for the icon. */
|
|
733
|
+
external: {
|
|
734
|
+
/** @description The URL of the external file or resource. */
|
|
735
|
+
url: string;
|
|
736
|
+
};
|
|
737
|
+
};
|
|
738
|
+
/** File */
|
|
739
|
+
fileInternalOrExternalFileWithNameResponse: {
|
|
740
|
+
/**
|
|
741
|
+
* @description Type of attachment. In this case, a file uploaded to a Notion workspace.
|
|
742
|
+
* @constant
|
|
743
|
+
*/
|
|
744
|
+
type: "file";
|
|
745
|
+
/** @description The file URL. */
|
|
746
|
+
file: components["schemas"]["internalFileResponse"];
|
|
747
|
+
};
|
|
748
|
+
/** File */
|
|
749
|
+
filePageCoverResponse: {
|
|
750
|
+
/**
|
|
751
|
+
* @description Type of cover. In this case, a file.
|
|
752
|
+
* @constant
|
|
753
|
+
*/
|
|
754
|
+
type: "file";
|
|
755
|
+
/** @description The file URL for the cover. */
|
|
756
|
+
file: components["schemas"]["internalFileResponse"];
|
|
757
|
+
};
|
|
758
|
+
/** File */
|
|
759
|
+
filePageIconResponse: {
|
|
760
|
+
/**
|
|
761
|
+
* @description Type of icon. In this case, a file.
|
|
762
|
+
* @constant
|
|
763
|
+
*/
|
|
764
|
+
type: "file";
|
|
765
|
+
/** @description The file URL for the icon. */
|
|
766
|
+
file: components["schemas"]["internalFileResponse"];
|
|
767
|
+
};
|
|
768
|
+
/** Files */
|
|
769
|
+
filesDatabasePropertyConfigResponse: {
|
|
770
|
+
/**
|
|
771
|
+
* @description Always `files`
|
|
772
|
+
* @constant
|
|
773
|
+
*/
|
|
774
|
+
type: "files";
|
|
775
|
+
files: components["schemas"]["emptyObject"];
|
|
776
|
+
};
|
|
777
|
+
/** Files */
|
|
778
|
+
filesSimplePropertyValueResponse: {
|
|
779
|
+
/**
|
|
780
|
+
* @description Always `files`
|
|
781
|
+
* @constant
|
|
782
|
+
*/
|
|
783
|
+
type: "files";
|
|
784
|
+
files: components["schemas"]["internalOrExternalFileWithNameResponse"][];
|
|
785
|
+
};
|
|
786
|
+
/** Formula */
|
|
787
|
+
formulaDatabasePropertyConfigResponse: {
|
|
788
|
+
/**
|
|
789
|
+
* @description Always `formula`
|
|
790
|
+
* @constant
|
|
791
|
+
*/
|
|
792
|
+
type: "formula";
|
|
793
|
+
formula: {
|
|
794
|
+
expression: string;
|
|
795
|
+
};
|
|
796
|
+
};
|
|
797
|
+
formulaPropertyFilter: {
|
|
798
|
+
string: components["schemas"]["textPropertyFilter"];
|
|
799
|
+
} | {
|
|
800
|
+
checkbox: components["schemas"]["checkboxPropertyFilter"];
|
|
801
|
+
} | {
|
|
802
|
+
number: components["schemas"]["numberPropertyFilter"];
|
|
803
|
+
} | {
|
|
804
|
+
date: components["schemas"]["datePropertyFilter"];
|
|
805
|
+
};
|
|
806
|
+
formulaPropertyValueResponse: components["schemas"]["booleanFormulaPropertyValueResponse"] | components["schemas"]["dateFormulaPropertyValueResponse"] | components["schemas"]["numberFormulaPropertyValueResponse"] | components["schemas"]["stringFormulaPropertyValueResponse"] | components["schemas"]["unsupportedFormulaPropertyValueResponse"];
|
|
807
|
+
/** Formula */
|
|
808
|
+
formulaSimplePropertyValueResponse: {
|
|
809
|
+
/**
|
|
810
|
+
* @description Always `formula`
|
|
811
|
+
* @constant
|
|
812
|
+
*/
|
|
813
|
+
type: "formula";
|
|
814
|
+
formula: components["schemas"]["formulaPropertyValueResponse"];
|
|
815
|
+
};
|
|
816
|
+
groupFilterOperatorArray: (components["schemas"]["propertyOrTimestampFilter"] | ({
|
|
817
|
+
or: components["schemas"]["propertyOrTimestampFilterArray"];
|
|
818
|
+
} | {
|
|
819
|
+
and: components["schemas"]["propertyOrTimestampFilterArray"];
|
|
820
|
+
}))[];
|
|
821
|
+
groupObjectResponse: {
|
|
822
|
+
/** @description The ID of the group. */
|
|
823
|
+
id: components["schemas"]["idResponse"];
|
|
824
|
+
/**
|
|
825
|
+
* @description The group object type name.
|
|
826
|
+
* @constant
|
|
827
|
+
*/
|
|
828
|
+
object: "group";
|
|
829
|
+
/** @description The name of the group. */
|
|
830
|
+
name: string | null;
|
|
831
|
+
};
|
|
832
|
+
/** Icon */
|
|
833
|
+
iconPageIconResponse: {
|
|
834
|
+
/**
|
|
835
|
+
* @description Type of icon. In this case, a Notion native icon.
|
|
836
|
+
* @constant
|
|
837
|
+
*/
|
|
838
|
+
type: "icon";
|
|
839
|
+
/** @description The Notion native icon, specified by name and color. */
|
|
840
|
+
icon: components["schemas"]["noticonIconResponse"];
|
|
841
|
+
};
|
|
842
|
+
idObjectResponse: {
|
|
843
|
+
id: string;
|
|
844
|
+
};
|
|
845
|
+
idRequest: string;
|
|
846
|
+
/** Format: uuid */
|
|
847
|
+
idResponse: string;
|
|
848
|
+
internalFileResponse: {
|
|
849
|
+
/** @description The URL of the file. */
|
|
850
|
+
url: string;
|
|
851
|
+
/**
|
|
852
|
+
* Format: date-time
|
|
853
|
+
* @description The time when the URL will expire.
|
|
854
|
+
*/
|
|
855
|
+
expiry_time: string;
|
|
856
|
+
};
|
|
857
|
+
internalOrExternalFileWithNameResponse: components["schemas"]["internalOrExternalFileWithNameResponseCommon"] & (components["schemas"]["fileInternalOrExternalFileWithNameResponse"] | components["schemas"]["externalInternalOrExternalFileWithNameResponse"]);
|
|
858
|
+
internalOrExternalFileWithNameResponseCommon: {
|
|
859
|
+
/** @description The name of the file. */
|
|
860
|
+
name: string;
|
|
861
|
+
};
|
|
862
|
+
/** Last Edited By */
|
|
863
|
+
lastEditedByDatabasePropertyConfigResponse: {
|
|
864
|
+
/**
|
|
865
|
+
* @description Always `last_edited_by`
|
|
866
|
+
* @constant
|
|
867
|
+
*/
|
|
868
|
+
type: "last_edited_by";
|
|
869
|
+
last_edited_by: components["schemas"]["emptyObject"];
|
|
870
|
+
};
|
|
871
|
+
/** Last Edited By */
|
|
872
|
+
lastEditedBySimplePropertyValueResponse: {
|
|
873
|
+
/**
|
|
874
|
+
* @description Always `last_edited_by`
|
|
875
|
+
* @constant
|
|
876
|
+
*/
|
|
877
|
+
type: "last_edited_by";
|
|
878
|
+
last_edited_by: components["schemas"]["userValueResponse"];
|
|
879
|
+
};
|
|
880
|
+
/** Last Edited Time */
|
|
881
|
+
lastEditedTimeDatabasePropertyConfigResponse: {
|
|
882
|
+
/**
|
|
883
|
+
* @description Always `last_edited_time`
|
|
884
|
+
* @constant
|
|
885
|
+
*/
|
|
886
|
+
type: "last_edited_time";
|
|
887
|
+
last_edited_time: components["schemas"]["emptyObject"];
|
|
888
|
+
};
|
|
889
|
+
/** Last Edited Time */
|
|
890
|
+
lastEditedTimeSimplePropertyValueResponse: {
|
|
891
|
+
/**
|
|
892
|
+
* @description Always `last_edited_time`
|
|
893
|
+
* @constant
|
|
894
|
+
*/
|
|
895
|
+
type: "last_edited_time";
|
|
896
|
+
/** Format: date-time */
|
|
897
|
+
last_edited_time: string;
|
|
898
|
+
};
|
|
899
|
+
linkMentionResponse: {
|
|
900
|
+
/** @description The href of the link mention. */
|
|
901
|
+
href: string;
|
|
902
|
+
/** @description The title of the link. */
|
|
903
|
+
title?: string;
|
|
904
|
+
/** @description The description of the link. */
|
|
905
|
+
description?: string;
|
|
906
|
+
/** @description The author of the link. */
|
|
907
|
+
link_author?: string;
|
|
908
|
+
/** @description The provider of the link. */
|
|
909
|
+
link_provider?: string;
|
|
910
|
+
/** @description The thumbnail URL of the link. */
|
|
911
|
+
thumbnail_url?: string;
|
|
912
|
+
/** @description The icon URL of the link. */
|
|
913
|
+
icon_url?: string;
|
|
914
|
+
/** @description The iframe URL of the link. */
|
|
915
|
+
iframe_url?: string;
|
|
916
|
+
/** @description The height of the link preview iframe. */
|
|
917
|
+
height?: number;
|
|
918
|
+
/** @description The padding of the link preview iframe. */
|
|
919
|
+
padding?: number;
|
|
920
|
+
/** @description The top padding of the link preview iframe. */
|
|
921
|
+
padding_top?: number;
|
|
922
|
+
};
|
|
923
|
+
linkPreviewMentionResponse: {
|
|
924
|
+
/** @description The URL of the link preview mention. */
|
|
925
|
+
url: string;
|
|
926
|
+
};
|
|
927
|
+
/** Mention */
|
|
928
|
+
mentionRichTextItemResponse: {
|
|
929
|
+
/**
|
|
930
|
+
* @description Always `mention`
|
|
931
|
+
* @constant
|
|
932
|
+
*/
|
|
933
|
+
type: "mention";
|
|
934
|
+
/** @description Mention objects represent an inline mention of a database, date, link preview mention, page, template mention, or user. A mention is created in the Notion UI when a user types `@` followed by the name of the reference. */
|
|
935
|
+
mention: {
|
|
936
|
+
/**
|
|
937
|
+
* @description Always `user`
|
|
938
|
+
* @constant
|
|
939
|
+
*/
|
|
940
|
+
type: "user";
|
|
941
|
+
/** @description Details of the user mention. */
|
|
942
|
+
user: components["schemas"]["userValueResponse"];
|
|
943
|
+
} | {
|
|
944
|
+
/**
|
|
945
|
+
* @description Always `date`
|
|
946
|
+
* @constant
|
|
947
|
+
*/
|
|
948
|
+
type: "date";
|
|
949
|
+
/** @description Details of the date mention. */
|
|
950
|
+
date: components["schemas"]["dateResponse"];
|
|
951
|
+
} | {
|
|
952
|
+
/**
|
|
953
|
+
* @description Always `link_preview`
|
|
954
|
+
* @constant
|
|
955
|
+
*/
|
|
956
|
+
type: "link_preview";
|
|
957
|
+
/** @description Details of the link preview mention. */
|
|
958
|
+
link_preview: components["schemas"]["linkPreviewMentionResponse"];
|
|
959
|
+
} | {
|
|
960
|
+
/**
|
|
961
|
+
* @description Always `link_mention`
|
|
962
|
+
* @constant
|
|
963
|
+
*/
|
|
964
|
+
type: "link_mention";
|
|
965
|
+
/** @description Details of the link mention. */
|
|
966
|
+
link_mention: components["schemas"]["linkMentionResponse"];
|
|
967
|
+
} | {
|
|
968
|
+
/**
|
|
969
|
+
* @description Always `page`
|
|
970
|
+
* @constant
|
|
971
|
+
*/
|
|
972
|
+
type: "page";
|
|
973
|
+
/** @description Details of the page mention. */
|
|
974
|
+
page: {
|
|
975
|
+
/** @description The ID of the page in the mention. */
|
|
976
|
+
id: components["schemas"]["idResponse"];
|
|
977
|
+
};
|
|
978
|
+
} | {
|
|
979
|
+
/**
|
|
980
|
+
* @description Always `database`
|
|
981
|
+
* @constant
|
|
982
|
+
*/
|
|
983
|
+
type: "database";
|
|
984
|
+
/** @description Details of the database mention. */
|
|
985
|
+
database: {
|
|
986
|
+
/** @description The ID of the database in the mention. */
|
|
987
|
+
id: components["schemas"]["idResponse"];
|
|
988
|
+
};
|
|
989
|
+
} | {
|
|
990
|
+
/**
|
|
991
|
+
* @description Always `template_mention`
|
|
992
|
+
* @constant
|
|
993
|
+
*/
|
|
994
|
+
type: "template_mention";
|
|
995
|
+
/** @description Details of the template mention. */
|
|
996
|
+
template_mention: components["schemas"]["templateMentionResponse"];
|
|
997
|
+
} | {
|
|
998
|
+
/**
|
|
999
|
+
* @description Always `custom_emoji`
|
|
1000
|
+
* @constant
|
|
1001
|
+
*/
|
|
1002
|
+
type: "custom_emoji";
|
|
1003
|
+
/** @description Details of the custom emoji mention. */
|
|
1004
|
+
custom_emoji: components["schemas"]["customEmojiResponse"];
|
|
1005
|
+
};
|
|
1006
|
+
};
|
|
1007
|
+
/** Multi Select */
|
|
1008
|
+
multiSelectDatabasePropertyConfigResponse: {
|
|
1009
|
+
/**
|
|
1010
|
+
* @description Always `multi_select`
|
|
1011
|
+
* @constant
|
|
1012
|
+
*/
|
|
1013
|
+
type: "multi_select";
|
|
1014
|
+
multi_select: {
|
|
1015
|
+
options: components["schemas"]["selectPropertyResponse"][];
|
|
1016
|
+
};
|
|
1017
|
+
};
|
|
1018
|
+
multiSelectPropertyFilter: ({
|
|
1019
|
+
contains: components["schemas"]["stringOrStringArray"];
|
|
1020
|
+
} | {
|
|
1021
|
+
does_not_contain: components["schemas"]["stringOrStringArray"];
|
|
1022
|
+
}) | components["schemas"]["existencePropertyFilter"];
|
|
1023
|
+
/** Multi Select */
|
|
1024
|
+
multiSelectSimplePropertyValueResponse: {
|
|
1025
|
+
/**
|
|
1026
|
+
* @description Always `multi_select`
|
|
1027
|
+
* @constant
|
|
1028
|
+
*/
|
|
1029
|
+
type: "multi_select";
|
|
1030
|
+
multi_select: components["schemas"]["partialSelectPropertyValueResponse"][];
|
|
1031
|
+
};
|
|
1032
|
+
/**
|
|
1033
|
+
* @description One of: `gray`, `lightgray`, `brown`, `yellow`, `orange`, `green`, `blue`, `purple`, `pink`, `red`
|
|
1034
|
+
* @enum {string}
|
|
1035
|
+
*/
|
|
1036
|
+
noticonColor: "gray" | "lightgray" | "brown" | "yellow" | "orange" | "green" | "blue" | "purple" | "pink" | "red";
|
|
1037
|
+
noticonIconResponse: {
|
|
1038
|
+
/** @description The name of the Notion icon (e.g. pizza, meeting, home). See the Notion icon picker for valid names. */
|
|
1039
|
+
name: components["schemas"]["noticonName"];
|
|
1040
|
+
/** @description The color variant of the icon. Valid values: gray, lightgray, brown, yellow, orange, green, blue, purple, pink, red. */
|
|
1041
|
+
color: components["schemas"]["noticonColor"];
|
|
1042
|
+
};
|
|
1043
|
+
/**
|
|
1044
|
+
* @example pizza
|
|
1045
|
+
* @example meeting
|
|
1046
|
+
* @example home
|
|
1047
|
+
* @example star
|
|
1048
|
+
* @example robot
|
|
1049
|
+
*/
|
|
1050
|
+
noticonName: string;
|
|
1051
|
+
/** Number */
|
|
1052
|
+
numberDatabasePropertyConfigResponse: {
|
|
1053
|
+
/**
|
|
1054
|
+
* @description Always `number`
|
|
1055
|
+
* @constant
|
|
1056
|
+
*/
|
|
1057
|
+
type: "number";
|
|
1058
|
+
number: {
|
|
1059
|
+
/** @description The number format for the property. */
|
|
1060
|
+
format: components["schemas"]["numberFormat"];
|
|
1061
|
+
};
|
|
1062
|
+
};
|
|
1063
|
+
/** @example number */
|
|
1064
|
+
numberFormat: string;
|
|
1065
|
+
/** Number */
|
|
1066
|
+
numberFormulaPropertyValueResponse: {
|
|
1067
|
+
/**
|
|
1068
|
+
* @description Always `number`
|
|
1069
|
+
* @constant
|
|
1070
|
+
*/
|
|
1071
|
+
type: "number";
|
|
1072
|
+
number: number | null;
|
|
1073
|
+
};
|
|
1074
|
+
/** Number */
|
|
1075
|
+
numberPartialRollupValueResponse: {
|
|
1076
|
+
/**
|
|
1077
|
+
* @description Always `number`
|
|
1078
|
+
* @constant
|
|
1079
|
+
*/
|
|
1080
|
+
type: "number";
|
|
1081
|
+
number: number | null;
|
|
1082
|
+
};
|
|
1083
|
+
numberPropertyFilter: ({
|
|
1084
|
+
equals: number;
|
|
1085
|
+
} | {
|
|
1086
|
+
does_not_equal: number;
|
|
1087
|
+
} | {
|
|
1088
|
+
greater_than: number;
|
|
1089
|
+
} | {
|
|
1090
|
+
less_than: number;
|
|
1091
|
+
} | {
|
|
1092
|
+
greater_than_or_equal_to: number;
|
|
1093
|
+
} | {
|
|
1094
|
+
less_than_or_equal_to: number;
|
|
1095
|
+
}) | components["schemas"]["existencePropertyFilter"];
|
|
1096
|
+
/** Number */
|
|
1097
|
+
numberSimplePropertyValueResponse: {
|
|
1098
|
+
/**
|
|
1099
|
+
* @description Always `number`
|
|
1100
|
+
* @constant
|
|
1101
|
+
*/
|
|
1102
|
+
type: "number";
|
|
1103
|
+
number: number | null;
|
|
1104
|
+
};
|
|
1105
|
+
pageCoverResponse: components["schemas"]["filePageCoverResponse"] | components["schemas"]["externalPageCoverResponse"];
|
|
1106
|
+
pageIconResponse: components["schemas"]["emojiPageIconResponse"] | components["schemas"]["filePageIconResponse"] | components["schemas"]["externalPageIconResponse"] | components["schemas"]["customEmojiPageIconResponse"] | components["schemas"]["iconPageIconResponse"];
|
|
1107
|
+
pageIdParentForBlockBasedObjectResponse: {
|
|
1108
|
+
/**
|
|
1109
|
+
* @description The parent type.
|
|
1110
|
+
* @constant
|
|
1111
|
+
*/
|
|
1112
|
+
type: "page_id";
|
|
1113
|
+
/** @description The ID of the parent page. */
|
|
1114
|
+
page_id: components["schemas"]["idResponse"];
|
|
1115
|
+
};
|
|
1116
|
+
pageObjectResponse: {
|
|
1117
|
+
/**
|
|
1118
|
+
* @description The page object type name.
|
|
1119
|
+
* @constant
|
|
1120
|
+
*/
|
|
1121
|
+
object: "page";
|
|
1122
|
+
/** @description The ID of the page. */
|
|
1123
|
+
id: components["schemas"]["idResponse"];
|
|
1124
|
+
/**
|
|
1125
|
+
* Format: date-time
|
|
1126
|
+
* @description Date and time when this page was created.
|
|
1127
|
+
*/
|
|
1128
|
+
created_time: string;
|
|
1129
|
+
/**
|
|
1130
|
+
* Format: date-time
|
|
1131
|
+
* @description Date and time when this page was last edited.
|
|
1132
|
+
*/
|
|
1133
|
+
last_edited_time: string;
|
|
1134
|
+
/** @description Whether the page is in trash. */
|
|
1135
|
+
in_trash: boolean;
|
|
1136
|
+
/** @description Whether the page has been archived. */
|
|
1137
|
+
is_archived: boolean;
|
|
1138
|
+
/** @description Whether the page is locked from editing in the Notion app UI. */
|
|
1139
|
+
is_locked: boolean;
|
|
1140
|
+
/** @description The URL of the Notion page. */
|
|
1141
|
+
url: string;
|
|
1142
|
+
/** @description The public URL of the Notion page, if it has been published to the web. */
|
|
1143
|
+
public_url: string | null;
|
|
1144
|
+
/** @description Information about the page's parent. */
|
|
1145
|
+
parent: components["schemas"]["parentForBlockBasedObjectResponse"];
|
|
1146
|
+
/** @description Property values of this page. */
|
|
1147
|
+
properties: {
|
|
1148
|
+
[key: string]: components["schemas"]["pagePropertyValueWithIdResponse"];
|
|
1149
|
+
};
|
|
1150
|
+
/** @description Page icon. */
|
|
1151
|
+
icon: components["schemas"]["pageIconResponse"] | null;
|
|
1152
|
+
/** @description Page cover image. */
|
|
1153
|
+
cover: components["schemas"]["pageCoverResponse"] | null;
|
|
1154
|
+
/** @description User who created the page. */
|
|
1155
|
+
created_by: components["schemas"]["partialUserObjectResponse"];
|
|
1156
|
+
/** @description User who last edited the page. */
|
|
1157
|
+
last_edited_by: components["schemas"]["partialUserObjectResponse"];
|
|
1158
|
+
};
|
|
1159
|
+
/** Page Or Data Source */
|
|
1160
|
+
pageOrDataSourceListResponse: {
|
|
1161
|
+
/** @constant */
|
|
1162
|
+
type: "page_or_data_source";
|
|
1163
|
+
page_or_data_source: components["schemas"]["emptyObject"];
|
|
1164
|
+
/** @constant */
|
|
1165
|
+
object: "list";
|
|
1166
|
+
next_cursor: string | null;
|
|
1167
|
+
has_more: boolean;
|
|
1168
|
+
results: ((components["schemas"]["pageObjectResponse"] | components["schemas"]["partialPageObjectResponse"]) | (components["schemas"]["partialDataSourceObjectResponse"] | components["schemas"]["dataSourceObjectResponse"]))[];
|
|
1169
|
+
request_status?: {
|
|
1170
|
+
/** @enum {string} */
|
|
1171
|
+
type: "complete" | "incomplete";
|
|
1172
|
+
/** @enum {string} */
|
|
1173
|
+
incomplete_reason?: "query_result_limit_reached";
|
|
1174
|
+
};
|
|
1175
|
+
};
|
|
1176
|
+
pagePropertyValueWithIdResponse: components["schemas"]["idObjectResponse"] & (components["schemas"]["simpleOrArrayPropertyValueResponse"] | components["schemas"]["partialRollupPropertyResponse"]);
|
|
1177
|
+
parentForBlockBasedObjectResponse: components["schemas"]["databaseParentResponse"] | components["schemas"]["dataSourceParentResponse"] | components["schemas"]["pageIdParentForBlockBasedObjectResponse"] | components["schemas"]["blockIdParentForBlockBasedObjectResponse"] | components["schemas"]["agentIdParentForBlockBasedObjectResponse"] | components["schemas"]["workspaceParentForBlockBasedObjectResponse"];
|
|
1178
|
+
/** @description The parent of the data source. This is typically a database (`database_id`), but for externally synced data sources, can be another data source (`data_source_id`). */
|
|
1179
|
+
parentOfDataSourceResponse: components["schemas"]["databaseParentResponse"] | components["schemas"]["dataSourceParentResponse"];
|
|
1180
|
+
parentOfDatabaseResponse: components["schemas"]["pageIdParentForBlockBasedObjectResponse"] | components["schemas"]["workspaceParentForBlockBasedObjectResponse"] | components["schemas"]["databaseParentResponse"] | components["schemas"]["blockIdParentForBlockBasedObjectResponse"];
|
|
1181
|
+
partialDataSourceObjectResponse: {
|
|
1182
|
+
/**
|
|
1183
|
+
* @description The data source object type name.
|
|
1184
|
+
* @constant
|
|
1185
|
+
*/
|
|
1186
|
+
object: "data_source";
|
|
1187
|
+
/** @description The ID of the data source. */
|
|
1188
|
+
id: components["schemas"]["idResponse"];
|
|
1189
|
+
/** @description The properties schema of the data source. */
|
|
1190
|
+
properties: {
|
|
1191
|
+
[key: string]: components["schemas"]["databasePropertyConfigResponse"];
|
|
1192
|
+
};
|
|
1193
|
+
};
|
|
1194
|
+
partialPageObjectResponse: {
|
|
1195
|
+
/**
|
|
1196
|
+
* @description The page object type name.
|
|
1197
|
+
* @constant
|
|
1198
|
+
*/
|
|
1199
|
+
object: "page";
|
|
1200
|
+
/** @description The ID of the page. */
|
|
1201
|
+
id: components["schemas"]["idResponse"];
|
|
1202
|
+
};
|
|
1203
|
+
partialRollupPropertyResponse: {
|
|
1204
|
+
/**
|
|
1205
|
+
* @description Always `rollup`
|
|
1206
|
+
* @constant
|
|
1207
|
+
*/
|
|
1208
|
+
type: "rollup";
|
|
1209
|
+
rollup: components["schemas"]["partialRollupValueResponse"];
|
|
1210
|
+
};
|
|
1211
|
+
partialRollupValueResponse: components["schemas"]["partialRollupValueResponseCommon"] & (components["schemas"]["numberPartialRollupValueResponse"] | components["schemas"]["datePartialRollupValueResponse"] | components["schemas"]["arrayPartialRollupValueResponse"] | components["schemas"]["unsupportedPartialRollupValueResponse"]);
|
|
1212
|
+
partialRollupValueResponseCommon: {
|
|
1213
|
+
/** @description The function used for the rollup, e.g. count, count_values, percent_not_empty, max. */
|
|
1214
|
+
function: components["schemas"]["rollupFunction"];
|
|
1215
|
+
};
|
|
1216
|
+
partialSelectPropertyValueResponse: {
|
|
1217
|
+
id: string;
|
|
1218
|
+
name: string;
|
|
1219
|
+
/**
|
|
1220
|
+
* @description One of: `default`, `gray`, `brown`, `orange`, `yellow`, `green`, `blue`, `purple`, `pink`, `red`
|
|
1221
|
+
* @enum {string}
|
|
1222
|
+
*/
|
|
1223
|
+
color: "default" | "gray" | "brown" | "orange" | "yellow" | "green" | "blue" | "purple" | "pink" | "red";
|
|
1224
|
+
};
|
|
1225
|
+
partialUserObjectResponse: {
|
|
1226
|
+
id: components["schemas"]["idResponse"];
|
|
1227
|
+
/**
|
|
1228
|
+
* @description Always `user`
|
|
1229
|
+
* @constant
|
|
1230
|
+
*/
|
|
1231
|
+
object: "user";
|
|
1232
|
+
};
|
|
1233
|
+
/** People */
|
|
1234
|
+
peopleArrayBasedPropertyValueResponse: {
|
|
1235
|
+
/**
|
|
1236
|
+
* @description Always `people`
|
|
1237
|
+
* @constant
|
|
1238
|
+
*/
|
|
1239
|
+
type: "people";
|
|
1240
|
+
people: (components["schemas"]["userValueResponse"] | components["schemas"]["groupObjectResponse"])[];
|
|
1241
|
+
};
|
|
1242
|
+
/** People */
|
|
1243
|
+
peopleDatabasePropertyConfigResponse: {
|
|
1244
|
+
/**
|
|
1245
|
+
* @description Always `people`
|
|
1246
|
+
* @constant
|
|
1247
|
+
*/
|
|
1248
|
+
type: "people";
|
|
1249
|
+
people: components["schemas"]["emptyObject"];
|
|
1250
|
+
};
|
|
1251
|
+
peoplePropertyFilter: ({
|
|
1252
|
+
contains: components["schemas"]["personIdOrMe"];
|
|
1253
|
+
} | {
|
|
1254
|
+
does_not_contain: components["schemas"]["personIdOrMe"];
|
|
1255
|
+
}) | components["schemas"]["existencePropertyFilter"];
|
|
1256
|
+
personIdOrMe: components["schemas"]["idRequest"] | "me";
|
|
1257
|
+
/** Person */
|
|
1258
|
+
personUserObjectResponse: {
|
|
1259
|
+
/**
|
|
1260
|
+
* @description Indicates this user is a person.
|
|
1261
|
+
* @constant
|
|
1262
|
+
*/
|
|
1263
|
+
type: "person";
|
|
1264
|
+
/** @description Details about the person, when the `type` of the user is `person`. */
|
|
1265
|
+
person: {
|
|
1266
|
+
/** @description The email of the person. */
|
|
1267
|
+
email?: string;
|
|
1268
|
+
/** @description Whether the person's email is verified. */
|
|
1269
|
+
email_verified?: boolean;
|
|
1270
|
+
};
|
|
1271
|
+
};
|
|
1272
|
+
/** Phone Number */
|
|
1273
|
+
phoneNumberDatabasePropertyConfigResponse: {
|
|
1274
|
+
/**
|
|
1275
|
+
* @description Always `phone_number`
|
|
1276
|
+
* @constant
|
|
1277
|
+
*/
|
|
1278
|
+
type: "phone_number";
|
|
1279
|
+
phone_number: components["schemas"]["emptyObject"];
|
|
1280
|
+
};
|
|
1281
|
+
/** Phone Number */
|
|
1282
|
+
phoneNumberSimplePropertyValueResponse: {
|
|
1283
|
+
/**
|
|
1284
|
+
* @description Always `phone_number`
|
|
1285
|
+
* @constant
|
|
1286
|
+
*/
|
|
1287
|
+
type: "phone_number";
|
|
1288
|
+
phone_number: string | null;
|
|
1289
|
+
};
|
|
1290
|
+
placePropertyValueResponse: {
|
|
1291
|
+
lat: number;
|
|
1292
|
+
lon: number;
|
|
1293
|
+
name?: string | null;
|
|
1294
|
+
address?: string | null;
|
|
1295
|
+
aws_place_id?: string | null;
|
|
1296
|
+
google_place_id?: string | null;
|
|
1297
|
+
};
|
|
1298
|
+
/** Place */
|
|
1299
|
+
placeSimplePropertyValueResponse: {
|
|
1300
|
+
/**
|
|
1301
|
+
* @description Always `place`
|
|
1302
|
+
* @constant
|
|
1303
|
+
*/
|
|
1304
|
+
type: "place";
|
|
1305
|
+
place: components["schemas"]["placePropertyValueResponse"] | null;
|
|
1306
|
+
};
|
|
1307
|
+
propertyDescriptionRequest: string;
|
|
1308
|
+
propertyFilter: {
|
|
1309
|
+
title: components["schemas"]["textPropertyFilter"];
|
|
1310
|
+
property: string;
|
|
1311
|
+
/** @constant */
|
|
1312
|
+
type?: "title";
|
|
1313
|
+
} | {
|
|
1314
|
+
rich_text: components["schemas"]["textPropertyFilter"];
|
|
1315
|
+
property: string;
|
|
1316
|
+
/** @constant */
|
|
1317
|
+
type?: "rich_text";
|
|
1318
|
+
} | {
|
|
1319
|
+
number: components["schemas"]["numberPropertyFilter"];
|
|
1320
|
+
property: string;
|
|
1321
|
+
/** @constant */
|
|
1322
|
+
type?: "number";
|
|
1323
|
+
} | {
|
|
1324
|
+
checkbox: components["schemas"]["checkboxPropertyFilter"];
|
|
1325
|
+
property: string;
|
|
1326
|
+
/** @constant */
|
|
1327
|
+
type?: "checkbox";
|
|
1328
|
+
} | {
|
|
1329
|
+
select: components["schemas"]["selectPropertyFilter"];
|
|
1330
|
+
property: string;
|
|
1331
|
+
/** @constant */
|
|
1332
|
+
type?: "select";
|
|
1333
|
+
} | {
|
|
1334
|
+
multi_select: components["schemas"]["multiSelectPropertyFilter"];
|
|
1335
|
+
property: string;
|
|
1336
|
+
/** @constant */
|
|
1337
|
+
type?: "multi_select";
|
|
1338
|
+
} | {
|
|
1339
|
+
status: components["schemas"]["statusPropertyFilter"];
|
|
1340
|
+
property: string;
|
|
1341
|
+
/** @constant */
|
|
1342
|
+
type?: "status";
|
|
1343
|
+
} | {
|
|
1344
|
+
date: components["schemas"]["datePropertyFilter"];
|
|
1345
|
+
property: string;
|
|
1346
|
+
/** @constant */
|
|
1347
|
+
type?: "date";
|
|
1348
|
+
} | {
|
|
1349
|
+
people: components["schemas"]["peoplePropertyFilter"];
|
|
1350
|
+
property: string;
|
|
1351
|
+
/** @constant */
|
|
1352
|
+
type?: "people";
|
|
1353
|
+
} | {
|
|
1354
|
+
files: components["schemas"]["existencePropertyFilter"];
|
|
1355
|
+
property: string;
|
|
1356
|
+
/** @constant */
|
|
1357
|
+
type?: "files";
|
|
1358
|
+
} | {
|
|
1359
|
+
url: components["schemas"]["textPropertyFilter"];
|
|
1360
|
+
property: string;
|
|
1361
|
+
/** @constant */
|
|
1362
|
+
type?: "url";
|
|
1363
|
+
} | {
|
|
1364
|
+
email: components["schemas"]["textPropertyFilter"];
|
|
1365
|
+
property: string;
|
|
1366
|
+
/** @constant */
|
|
1367
|
+
type?: "email";
|
|
1368
|
+
} | {
|
|
1369
|
+
phone_number: components["schemas"]["textPropertyFilter"];
|
|
1370
|
+
property: string;
|
|
1371
|
+
/** @constant */
|
|
1372
|
+
type?: "phone_number";
|
|
1373
|
+
} | {
|
|
1374
|
+
relation: components["schemas"]["relationPropertyFilter"];
|
|
1375
|
+
property: string;
|
|
1376
|
+
/** @constant */
|
|
1377
|
+
type?: "relation";
|
|
1378
|
+
} | {
|
|
1379
|
+
created_by: components["schemas"]["peoplePropertyFilter"];
|
|
1380
|
+
property: string;
|
|
1381
|
+
/** @constant */
|
|
1382
|
+
type?: "created_by";
|
|
1383
|
+
} | {
|
|
1384
|
+
created_time: components["schemas"]["datePropertyFilter"];
|
|
1385
|
+
property: string;
|
|
1386
|
+
/** @constant */
|
|
1387
|
+
type?: "created_time";
|
|
1388
|
+
} | {
|
|
1389
|
+
last_edited_by: components["schemas"]["peoplePropertyFilter"];
|
|
1390
|
+
property: string;
|
|
1391
|
+
/** @constant */
|
|
1392
|
+
type?: "last_edited_by";
|
|
1393
|
+
} | {
|
|
1394
|
+
last_edited_time: components["schemas"]["datePropertyFilter"];
|
|
1395
|
+
property: string;
|
|
1396
|
+
/** @constant */
|
|
1397
|
+
type?: "last_edited_time";
|
|
1398
|
+
} | {
|
|
1399
|
+
formula: components["schemas"]["formulaPropertyFilter"];
|
|
1400
|
+
property: string;
|
|
1401
|
+
/** @constant */
|
|
1402
|
+
type?: "formula";
|
|
1403
|
+
} | {
|
|
1404
|
+
unique_id: components["schemas"]["numberPropertyFilter"];
|
|
1405
|
+
property: string;
|
|
1406
|
+
/** @constant */
|
|
1407
|
+
type?: "unique_id";
|
|
1408
|
+
} | {
|
|
1409
|
+
rollup: components["schemas"]["rollupPropertyFilter"];
|
|
1410
|
+
property: string;
|
|
1411
|
+
/** @constant */
|
|
1412
|
+
type?: "rollup";
|
|
1413
|
+
} | {
|
|
1414
|
+
verification: components["schemas"]["verificationPropertyStatusFilter"] | components["schemas"]["verificationPropertyDoesNotEqualFilter"];
|
|
1415
|
+
property: string;
|
|
1416
|
+
/** @constant */
|
|
1417
|
+
type?: "verification";
|
|
1418
|
+
};
|
|
1419
|
+
propertyOrTimestampFilter: components["schemas"]["propertyFilter"] | components["schemas"]["timestampFilter"];
|
|
1420
|
+
propertyOrTimestampFilterArray: components["schemas"]["propertyOrTimestampFilter"][];
|
|
1421
|
+
publicApiCommonErrorResponse: {
|
|
1422
|
+
/** @constant */
|
|
1423
|
+
object: "error";
|
|
1424
|
+
message: string;
|
|
1425
|
+
additional_data?: {
|
|
1426
|
+
[key: string]: string | string[];
|
|
1427
|
+
};
|
|
1428
|
+
};
|
|
1429
|
+
/** Relation */
|
|
1430
|
+
relationArrayBasedPropertyValueResponse: {
|
|
1431
|
+
/**
|
|
1432
|
+
* @description Always `relation`
|
|
1433
|
+
* @constant
|
|
1434
|
+
*/
|
|
1435
|
+
type: "relation";
|
|
1436
|
+
relation: components["schemas"]["relationItemPropertyValueResponse"][];
|
|
1437
|
+
};
|
|
1438
|
+
/** Relation */
|
|
1439
|
+
relationDatabasePropertyConfigResponse: {
|
|
1440
|
+
/**
|
|
1441
|
+
* @description Always `relation`
|
|
1442
|
+
* @constant
|
|
1443
|
+
*/
|
|
1444
|
+
type: "relation";
|
|
1445
|
+
relation: components["schemas"]["databasePropertyRelationConfigResponse"];
|
|
1446
|
+
};
|
|
1447
|
+
relationItemPropertyValueResponse: {
|
|
1448
|
+
id: components["schemas"]["idRequest"];
|
|
1449
|
+
};
|
|
1450
|
+
relationPropertyFilter: ({
|
|
1451
|
+
contains: components["schemas"]["idRequest"];
|
|
1452
|
+
} | {
|
|
1453
|
+
does_not_contain: components["schemas"]["idRequest"];
|
|
1454
|
+
}) | components["schemas"]["existencePropertyFilter"];
|
|
1455
|
+
/** @enum {string} */
|
|
1456
|
+
relativeDateValue: "today" | "tomorrow" | "yesterday" | "one_week_ago" | "one_week_from_now" | "one_month_ago" | "one_month_from_now";
|
|
1457
|
+
/** Rich Text */
|
|
1458
|
+
richTextArrayBasedPropertyValueResponse: {
|
|
1459
|
+
/**
|
|
1460
|
+
* @description Always `rich_text`
|
|
1461
|
+
* @constant
|
|
1462
|
+
*/
|
|
1463
|
+
type: "rich_text";
|
|
1464
|
+
rich_text: components["schemas"]["richTextItemResponse"][];
|
|
1465
|
+
};
|
|
1466
|
+
/** Rich Text */
|
|
1467
|
+
richTextDatabasePropertyConfigResponse: {
|
|
1468
|
+
/**
|
|
1469
|
+
* @description Always `rich_text`
|
|
1470
|
+
* @constant
|
|
1471
|
+
*/
|
|
1472
|
+
type: "rich_text";
|
|
1473
|
+
rich_text: components["schemas"]["emptyObject"];
|
|
1474
|
+
};
|
|
1475
|
+
richTextItemResponse: components["schemas"]["richTextItemResponseCommon"] & (components["schemas"]["textRichTextItemResponse"] | components["schemas"]["mentionRichTextItemResponse"] | components["schemas"]["equationRichTextItemResponse"]);
|
|
1476
|
+
richTextItemResponseCommon: {
|
|
1477
|
+
/** @description The plain text content of the rich text object, without any styling. */
|
|
1478
|
+
plain_text: string;
|
|
1479
|
+
/** @description A URL that the rich text object links to or mentions. */
|
|
1480
|
+
href: string | null;
|
|
1481
|
+
/** @description All rich text objects contain an annotations object that sets the styling for the rich text. */
|
|
1482
|
+
annotations: components["schemas"]["annotationResponse"];
|
|
1483
|
+
};
|
|
1484
|
+
/** Rollup */
|
|
1485
|
+
rollupDatabasePropertyConfigResponse: {
|
|
1486
|
+
/**
|
|
1487
|
+
* @description Always `rollup`
|
|
1488
|
+
* @constant
|
|
1489
|
+
*/
|
|
1490
|
+
type: "rollup";
|
|
1491
|
+
rollup: {
|
|
1492
|
+
/** @description The function to use for the rollup, e.g. count, count_values, percent_not_empty, max. */
|
|
1493
|
+
function: components["schemas"]["rollupFunction"];
|
|
1494
|
+
rollup_property_name: string;
|
|
1495
|
+
relation_property_name: string;
|
|
1496
|
+
rollup_property_id: string;
|
|
1497
|
+
relation_property_id: string;
|
|
1498
|
+
};
|
|
1499
|
+
};
|
|
1500
|
+
/** @enum {string} */
|
|
1501
|
+
rollupFunction: "count" | "count_values" | "empty" | "not_empty" | "unique" | "show_unique" | "percent_empty" | "percent_not_empty" | "sum" | "average" | "median" | "min" | "max" | "range" | "earliest_date" | "latest_date" | "date_range" | "checked" | "unchecked" | "percent_checked" | "percent_unchecked" | "count_per_group" | "percent_per_group" | "show_original";
|
|
1502
|
+
rollupPropertyFilter: {
|
|
1503
|
+
any: components["schemas"]["rollupSubfilterPropertyFilter"];
|
|
1504
|
+
} | {
|
|
1505
|
+
none: components["schemas"]["rollupSubfilterPropertyFilter"];
|
|
1506
|
+
} | {
|
|
1507
|
+
every: components["schemas"]["rollupSubfilterPropertyFilter"];
|
|
1508
|
+
} | {
|
|
1509
|
+
date: components["schemas"]["datePropertyFilter"];
|
|
1510
|
+
} | {
|
|
1511
|
+
number: components["schemas"]["numberPropertyFilter"];
|
|
1512
|
+
};
|
|
1513
|
+
rollupSubfilterPropertyFilter: {
|
|
1514
|
+
rich_text: components["schemas"]["textPropertyFilter"];
|
|
1515
|
+
} | {
|
|
1516
|
+
number: components["schemas"]["numberPropertyFilter"];
|
|
1517
|
+
} | {
|
|
1518
|
+
checkbox: components["schemas"]["checkboxPropertyFilter"];
|
|
1519
|
+
} | {
|
|
1520
|
+
select: components["schemas"]["selectPropertyFilter"];
|
|
1521
|
+
} | {
|
|
1522
|
+
multi_select: components["schemas"]["multiSelectPropertyFilter"];
|
|
1523
|
+
} | {
|
|
1524
|
+
relation: components["schemas"]["relationPropertyFilter"];
|
|
1525
|
+
} | {
|
|
1526
|
+
date: components["schemas"]["datePropertyFilter"];
|
|
1527
|
+
} | {
|
|
1528
|
+
people: components["schemas"]["peoplePropertyFilter"];
|
|
1529
|
+
} | {
|
|
1530
|
+
files: components["schemas"]["existencePropertyFilter"];
|
|
1531
|
+
} | {
|
|
1532
|
+
status: components["schemas"]["statusPropertyFilter"];
|
|
1533
|
+
};
|
|
1534
|
+
/**
|
|
1535
|
+
* @description One of: `default`, `gray`, `brown`, `orange`, `yellow`, `green`, `blue`, `purple`, `pink`, `red`
|
|
1536
|
+
* @enum {string}
|
|
1537
|
+
*/
|
|
1538
|
+
selectColor: "default" | "gray" | "brown" | "orange" | "yellow" | "green" | "blue" | "purple" | "pink" | "red";
|
|
1539
|
+
/** Select */
|
|
1540
|
+
selectDatabasePropertyConfigResponse: {
|
|
1541
|
+
/**
|
|
1542
|
+
* @description Always `select`
|
|
1543
|
+
* @constant
|
|
1544
|
+
*/
|
|
1545
|
+
type: "select";
|
|
1546
|
+
select: {
|
|
1547
|
+
options: components["schemas"]["selectPropertyResponse"][];
|
|
1548
|
+
};
|
|
1549
|
+
};
|
|
1550
|
+
selectPropertyFilter: ({
|
|
1551
|
+
equals: components["schemas"]["stringOrStringArray"];
|
|
1552
|
+
} | {
|
|
1553
|
+
does_not_equal: components["schemas"]["stringOrStringArray"];
|
|
1554
|
+
}) | components["schemas"]["existencePropertyFilter"];
|
|
1555
|
+
selectPropertyResponse: {
|
|
1556
|
+
id: string;
|
|
1557
|
+
name: string;
|
|
1558
|
+
color: components["schemas"]["selectColor"];
|
|
1559
|
+
description: string | null;
|
|
1560
|
+
};
|
|
1561
|
+
/** Select */
|
|
1562
|
+
selectSimplePropertyValueResponse: {
|
|
1563
|
+
/**
|
|
1564
|
+
* @description Always `select`
|
|
1565
|
+
* @constant
|
|
1566
|
+
*/
|
|
1567
|
+
type: "select";
|
|
1568
|
+
select: components["schemas"]["partialSelectPropertyValueResponse"] | null;
|
|
1569
|
+
};
|
|
1570
|
+
simpleOrArrayPropertyValueResponse: components["schemas"]["simplePropertyValueResponse"] | components["schemas"]["arrayBasedPropertyValueResponse"];
|
|
1571
|
+
simplePropertyValueResponse: components["schemas"]["numberSimplePropertyValueResponse"] | components["schemas"]["urlSimplePropertyValueResponse"] | components["schemas"]["selectSimplePropertyValueResponse"] | components["schemas"]["multiSelectSimplePropertyValueResponse"] | components["schemas"]["statusSimplePropertyValueResponse"] | components["schemas"]["dateSimplePropertyValueResponse"] | components["schemas"]["emailSimplePropertyValueResponse"] | components["schemas"]["phoneNumberSimplePropertyValueResponse"] | components["schemas"]["checkboxSimplePropertyValueResponse"] | components["schemas"]["filesSimplePropertyValueResponse"] | components["schemas"]["createdBySimplePropertyValueResponse"] | components["schemas"]["createdTimeSimplePropertyValueResponse"] | components["schemas"]["lastEditedBySimplePropertyValueResponse"] | components["schemas"]["lastEditedTimeSimplePropertyValueResponse"] | components["schemas"]["formulaSimplePropertyValueResponse"] | components["schemas"]["buttonSimplePropertyValueResponse"] | components["schemas"]["uniqueIdSimplePropertyValueResponse"] | components["schemas"]["verificationSimplePropertyValueResponse"] | components["schemas"]["placeSimplePropertyValueResponse"];
|
|
1572
|
+
/** Single Property */
|
|
1573
|
+
singlePropertyDatabasePropertyRelationConfigResponse: {
|
|
1574
|
+
/**
|
|
1575
|
+
* @description Always `single_property`
|
|
1576
|
+
* @constant
|
|
1577
|
+
*/
|
|
1578
|
+
type: "single_property";
|
|
1579
|
+
single_property: components["schemas"]["emptyObject"];
|
|
1580
|
+
};
|
|
1581
|
+
/** Status */
|
|
1582
|
+
statusDatabasePropertyConfigResponse: {
|
|
1583
|
+
/**
|
|
1584
|
+
* @description Always `status`
|
|
1585
|
+
* @constant
|
|
1586
|
+
*/
|
|
1587
|
+
type: "status";
|
|
1588
|
+
status: {
|
|
1589
|
+
/** @description The name of the configured default status option, or null when no default is configured. Read-only. */
|
|
1590
|
+
default_option: string | null;
|
|
1591
|
+
/** @description The options for the status property. */
|
|
1592
|
+
options: components["schemas"]["statusPropertyResponse"][];
|
|
1593
|
+
/** @description The groups for the status property. */
|
|
1594
|
+
groups: {
|
|
1595
|
+
/** @description The ID of the status group. */
|
|
1596
|
+
id: string;
|
|
1597
|
+
/** @description The name of the status group. */
|
|
1598
|
+
name: string;
|
|
1599
|
+
/** @description The color of the status group. */
|
|
1600
|
+
color: components["schemas"]["selectColor"];
|
|
1601
|
+
/** @description The IDs of the status options in this group. */
|
|
1602
|
+
option_ids: string[];
|
|
1603
|
+
}[];
|
|
1604
|
+
};
|
|
1605
|
+
};
|
|
1606
|
+
statusGroupNames: components["schemas"]["stringRequest"] | components["schemas"]["stringRequest"][];
|
|
1607
|
+
statusPropertyFilter: components["schemas"]["statusValueFilter"] | components["schemas"]["existencePropertyFilter"];
|
|
1608
|
+
statusPropertyResponse: {
|
|
1609
|
+
/** @description The ID of the status option. */
|
|
1610
|
+
id: string;
|
|
1611
|
+
/** @description The name of the status option. */
|
|
1612
|
+
name: string;
|
|
1613
|
+
/** @description The color of the status option. */
|
|
1614
|
+
color: components["schemas"]["selectColor"];
|
|
1615
|
+
/** @description The description of the status option. */
|
|
1616
|
+
description: string | null;
|
|
1617
|
+
};
|
|
1618
|
+
/** Status */
|
|
1619
|
+
statusSimplePropertyValueResponse: {
|
|
1620
|
+
/**
|
|
1621
|
+
* @description Always `status`
|
|
1622
|
+
* @constant
|
|
1623
|
+
*/
|
|
1624
|
+
type: "status";
|
|
1625
|
+
status: components["schemas"]["partialSelectPropertyValueResponse"] | null;
|
|
1626
|
+
};
|
|
1627
|
+
/** @description The group operators match status groups instead of options. They require the `Notion-Beta: status-group-filters-2026-10-06` header. */
|
|
1628
|
+
statusValueFilter: {
|
|
1629
|
+
equals: components["schemas"]["stringOrStringArray"];
|
|
1630
|
+
} | {
|
|
1631
|
+
does_not_equal: components["schemas"]["stringOrStringArray"];
|
|
1632
|
+
} | {
|
|
1633
|
+
group_equals: components["schemas"]["statusGroupNames"];
|
|
1634
|
+
} | {
|
|
1635
|
+
group_does_not_equal: components["schemas"]["statusGroupNames"];
|
|
1636
|
+
};
|
|
1637
|
+
/** String */
|
|
1638
|
+
stringFormulaPropertyValueResponse: {
|
|
1639
|
+
/**
|
|
1640
|
+
* @description Always `string`
|
|
1641
|
+
* @constant
|
|
1642
|
+
*/
|
|
1643
|
+
type: "string";
|
|
1644
|
+
string: string | null;
|
|
1645
|
+
};
|
|
1646
|
+
stringOrStringArray: string | string[];
|
|
1647
|
+
stringRequest: string;
|
|
1648
|
+
/** Template Mention Date */
|
|
1649
|
+
templateMentionDateTemplateMentionResponse: {
|
|
1650
|
+
/**
|
|
1651
|
+
* @description Always `template_mention_date`
|
|
1652
|
+
* @constant
|
|
1653
|
+
*/
|
|
1654
|
+
type: "template_mention_date";
|
|
1655
|
+
/**
|
|
1656
|
+
* @description The date of the template mention.
|
|
1657
|
+
* @enum {string}
|
|
1658
|
+
*/
|
|
1659
|
+
template_mention_date: "today" | "now";
|
|
1660
|
+
};
|
|
1661
|
+
templateMentionResponse: components["schemas"]["templateMentionDateTemplateMentionResponse"] | components["schemas"]["templateMentionUserTemplateMentionResponse"];
|
|
1662
|
+
/** Template Mention User */
|
|
1663
|
+
templateMentionUserTemplateMentionResponse: {
|
|
1664
|
+
/**
|
|
1665
|
+
* @description Always `template_mention_user`
|
|
1666
|
+
* @constant
|
|
1667
|
+
*/
|
|
1668
|
+
type: "template_mention_user";
|
|
1669
|
+
/**
|
|
1670
|
+
* @description The user of the template mention.
|
|
1671
|
+
* @constant
|
|
1672
|
+
*/
|
|
1673
|
+
template_mention_user: "me";
|
|
1674
|
+
};
|
|
1675
|
+
textPropertyFilter: ({
|
|
1676
|
+
equals: string;
|
|
1677
|
+
} | {
|
|
1678
|
+
does_not_equal: string;
|
|
1679
|
+
} | {
|
|
1680
|
+
contains: string;
|
|
1681
|
+
} | {
|
|
1682
|
+
does_not_contain: string;
|
|
1683
|
+
} | {
|
|
1684
|
+
starts_with: string;
|
|
1685
|
+
} | {
|
|
1686
|
+
ends_with: string;
|
|
1687
|
+
}) | components["schemas"]["existencePropertyFilter"];
|
|
1688
|
+
/** Text */
|
|
1689
|
+
textRichTextItemResponse: {
|
|
1690
|
+
/**
|
|
1691
|
+
* @description Always `text`
|
|
1692
|
+
* @constant
|
|
1693
|
+
*/
|
|
1694
|
+
type: "text";
|
|
1695
|
+
/** @description If a rich text object's type value is `text`, then the corresponding text field contains an object including the text content and any inline link. */
|
|
1696
|
+
text: {
|
|
1697
|
+
/** @description The actual text content of the text. */
|
|
1698
|
+
content: string;
|
|
1699
|
+
/** @description An object with information about any inline link in this text, if included. */
|
|
1700
|
+
link: {
|
|
1701
|
+
/**
|
|
1702
|
+
* @description The URL of the link.
|
|
1703
|
+
* @example https://www.notion.com
|
|
1704
|
+
*/
|
|
1705
|
+
url: string;
|
|
1706
|
+
} | null;
|
|
1707
|
+
};
|
|
1708
|
+
};
|
|
1709
|
+
/** @example Africa/Abidjan */
|
|
1710
|
+
timeZoneRequest: string;
|
|
1711
|
+
/** Created Time */
|
|
1712
|
+
timestampCreatedTimeFilter: {
|
|
1713
|
+
created_time: components["schemas"]["datePropertyFilter"];
|
|
1714
|
+
/** @constant */
|
|
1715
|
+
timestamp: "created_time";
|
|
1716
|
+
/** @constant */
|
|
1717
|
+
type?: "created_time";
|
|
1718
|
+
};
|
|
1719
|
+
timestampFilter: components["schemas"]["timestampCreatedTimeFilter"] | components["schemas"]["timestampLastEditedTimeFilter"];
|
|
1720
|
+
/** Last Edited Time */
|
|
1721
|
+
timestampLastEditedTimeFilter: {
|
|
1722
|
+
last_edited_time: components["schemas"]["datePropertyFilter"];
|
|
1723
|
+
/** @constant */
|
|
1724
|
+
timestamp: "last_edited_time";
|
|
1725
|
+
/** @constant */
|
|
1726
|
+
type?: "last_edited_time";
|
|
1727
|
+
};
|
|
1728
|
+
/** Title */
|
|
1729
|
+
titleArrayBasedPropertyValueResponse: {
|
|
1730
|
+
/**
|
|
1731
|
+
* @description Always `title`
|
|
1732
|
+
* @constant
|
|
1733
|
+
*/
|
|
1734
|
+
type: "title";
|
|
1735
|
+
title: components["schemas"]["richTextItemResponse"][];
|
|
1736
|
+
};
|
|
1737
|
+
/** Title */
|
|
1738
|
+
titleDatabasePropertyConfigResponse: {
|
|
1739
|
+
/**
|
|
1740
|
+
* @description Always `title`
|
|
1741
|
+
* @constant
|
|
1742
|
+
*/
|
|
1743
|
+
type: "title";
|
|
1744
|
+
title: components["schemas"]["emptyObject"];
|
|
1745
|
+
};
|
|
1746
|
+
/** Unique Id */
|
|
1747
|
+
uniqueIdDatabasePropertyConfigResponse: {
|
|
1748
|
+
/**
|
|
1749
|
+
* @description Always `unique_id`
|
|
1750
|
+
* @constant
|
|
1751
|
+
*/
|
|
1752
|
+
type: "unique_id";
|
|
1753
|
+
unique_id: {
|
|
1754
|
+
/** @description The prefix for the unique ID. */
|
|
1755
|
+
prefix: string | null;
|
|
1756
|
+
};
|
|
1757
|
+
};
|
|
1758
|
+
uniqueIdPropertyValueResponse: {
|
|
1759
|
+
prefix: string | null;
|
|
1760
|
+
number: number | null;
|
|
1761
|
+
};
|
|
1762
|
+
/** Unique Id */
|
|
1763
|
+
uniqueIdSimplePropertyValueResponse: {
|
|
1764
|
+
/**
|
|
1765
|
+
* @description Always `unique_id`
|
|
1766
|
+
* @constant
|
|
1767
|
+
*/
|
|
1768
|
+
type: "unique_id";
|
|
1769
|
+
unique_id: components["schemas"]["uniqueIdPropertyValueResponse"];
|
|
1770
|
+
};
|
|
1771
|
+
/** Unsupported */
|
|
1772
|
+
unsupportedFormulaPropertyValueResponse: {
|
|
1773
|
+
/**
|
|
1774
|
+
* @description Always `unsupported`
|
|
1775
|
+
* @constant
|
|
1776
|
+
*/
|
|
1777
|
+
type: "unsupported";
|
|
1778
|
+
unsupported: components["schemas"]["emptyObject"];
|
|
1779
|
+
};
|
|
1780
|
+
/** Unsupported */
|
|
1781
|
+
unsupportedPartialRollupValueResponse: {
|
|
1782
|
+
/**
|
|
1783
|
+
* @description Always `unsupported`
|
|
1784
|
+
* @constant
|
|
1785
|
+
*/
|
|
1786
|
+
type: "unsupported";
|
|
1787
|
+
unsupported: components["schemas"]["emptyObject"];
|
|
1788
|
+
};
|
|
1789
|
+
/** Url */
|
|
1790
|
+
urlDatabasePropertyConfigResponse: {
|
|
1791
|
+
/**
|
|
1792
|
+
* @description Always `url`
|
|
1793
|
+
* @constant
|
|
1794
|
+
*/
|
|
1795
|
+
type: "url";
|
|
1796
|
+
url: components["schemas"]["emptyObject"];
|
|
1797
|
+
};
|
|
1798
|
+
/** Url */
|
|
1799
|
+
urlSimplePropertyValueResponse: {
|
|
1800
|
+
/**
|
|
1801
|
+
* @description Always `url`
|
|
1802
|
+
* @constant
|
|
1803
|
+
*/
|
|
1804
|
+
type: "url";
|
|
1805
|
+
url: string | null;
|
|
1806
|
+
};
|
|
1807
|
+
userObjectResponse: components["schemas"]["userObjectResponseCommon"] & (components["schemas"]["personUserObjectResponse"] | components["schemas"]["botUserObjectResponse"]);
|
|
1808
|
+
userObjectResponseCommon: {
|
|
1809
|
+
/** @description The ID of the user. */
|
|
1810
|
+
id: components["schemas"]["idResponse"];
|
|
1811
|
+
/**
|
|
1812
|
+
* @description The user object type name.
|
|
1813
|
+
* @constant
|
|
1814
|
+
*/
|
|
1815
|
+
object: "user";
|
|
1816
|
+
/** @description The name of the user. */
|
|
1817
|
+
name: string | null;
|
|
1818
|
+
/** @description The avatar URL of the user. */
|
|
1819
|
+
avatar_url: string | null;
|
|
1820
|
+
};
|
|
1821
|
+
userValueResponse: components["schemas"]["partialUserObjectResponse"] | components["schemas"]["userObjectResponse"];
|
|
1822
|
+
verificationPropertyDoesNotEqualFilter: {
|
|
1823
|
+
/** @enum {string} */
|
|
1824
|
+
does_not_equal: "verified" | "expired" | "none";
|
|
1825
|
+
};
|
|
1826
|
+
/** Verified */
|
|
1827
|
+
verificationPropertyResponse: {
|
|
1828
|
+
/**
|
|
1829
|
+
* @description One of: `verified`, `expired`
|
|
1830
|
+
* @enum {string}
|
|
1831
|
+
*/
|
|
1832
|
+
state: "verified" | "expired";
|
|
1833
|
+
date: components["schemas"]["dateResponse"] | null;
|
|
1834
|
+
verified_by: components["schemas"]["userValueResponse"] | null;
|
|
1835
|
+
};
|
|
1836
|
+
verificationPropertyStatusFilter: {
|
|
1837
|
+
/** @enum {string} */
|
|
1838
|
+
status: "verified" | "expired" | "none";
|
|
1839
|
+
};
|
|
1840
|
+
/** Unverified */
|
|
1841
|
+
verificationPropertyUnverifiedResponse: {
|
|
1842
|
+
/**
|
|
1843
|
+
* @description Always `unverified`
|
|
1844
|
+
* @constant
|
|
1845
|
+
*/
|
|
1846
|
+
state: "unverified";
|
|
1847
|
+
date: null;
|
|
1848
|
+
verified_by: null;
|
|
1849
|
+
};
|
|
1850
|
+
verificationPropertyValueResponse: components["schemas"]["verificationPropertyUnverifiedResponse"] | components["schemas"]["verificationPropertyResponse"];
|
|
1851
|
+
/** Verification */
|
|
1852
|
+
verificationSimplePropertyValueResponse: {
|
|
1853
|
+
/**
|
|
1854
|
+
* @description Always `verification`
|
|
1855
|
+
* @constant
|
|
1856
|
+
*/
|
|
1857
|
+
type: "verification";
|
|
1858
|
+
verification: components["schemas"]["verificationPropertyValueResponse"] | null;
|
|
1859
|
+
};
|
|
1860
|
+
/** @description A property filter, timestamp filter, or compound and/or filter. */
|
|
1861
|
+
viewFilterRequest: ({
|
|
1862
|
+
or: components["schemas"]["groupFilterOperatorArray"];
|
|
1863
|
+
} | {
|
|
1864
|
+
and: components["schemas"]["groupFilterOperatorArray"];
|
|
1865
|
+
}) | components["schemas"]["propertyFilter"] | components["schemas"]["timestampFilter"];
|
|
1866
|
+
/** @description Sort by property name or ID, or by timestamp. */
|
|
1867
|
+
viewSortRequest: {
|
|
1868
|
+
property: string;
|
|
1869
|
+
/** @enum {string} */
|
|
1870
|
+
direction: "ascending" | "descending";
|
|
1871
|
+
} | {
|
|
1872
|
+
/** @enum {string} */
|
|
1873
|
+
timestamp: "created_time" | "last_edited_time";
|
|
1874
|
+
/** @enum {string} */
|
|
1875
|
+
direction: "ascending" | "descending";
|
|
1876
|
+
};
|
|
1877
|
+
workspaceParentForBlockBasedObjectResponse: {
|
|
1878
|
+
/**
|
|
1879
|
+
* @description The parent type.
|
|
1880
|
+
* @constant
|
|
1881
|
+
*/
|
|
1882
|
+
type: "workspace";
|
|
1883
|
+
/**
|
|
1884
|
+
* @description Always true for workspace parent.
|
|
1885
|
+
* @constant
|
|
1886
|
+
*/
|
|
1887
|
+
workspace: true;
|
|
1888
|
+
};
|
|
1889
|
+
};
|
|
1890
|
+
responses: {
|
|
1891
|
+
error_api_400: {
|
|
1892
|
+
headers: {
|
|
1893
|
+
[name: string]: unknown;
|
|
1894
|
+
};
|
|
1895
|
+
content: {
|
|
1896
|
+
"application/json": components["schemas"]["error_api_400"];
|
|
1897
|
+
};
|
|
1898
|
+
};
|
|
1899
|
+
error_api_401: {
|
|
1900
|
+
headers: {
|
|
1901
|
+
[name: string]: unknown;
|
|
1902
|
+
};
|
|
1903
|
+
content: {
|
|
1904
|
+
"application/json": components["schemas"]["error_api_401"];
|
|
1905
|
+
};
|
|
1906
|
+
};
|
|
1907
|
+
error_api_403: {
|
|
1908
|
+
headers: {
|
|
1909
|
+
[name: string]: unknown;
|
|
1910
|
+
};
|
|
1911
|
+
content: {
|
|
1912
|
+
"application/json": components["schemas"]["error_api_403"];
|
|
1913
|
+
};
|
|
1914
|
+
};
|
|
1915
|
+
error_api_404: {
|
|
1916
|
+
headers: {
|
|
1917
|
+
[name: string]: unknown;
|
|
1918
|
+
};
|
|
1919
|
+
content: {
|
|
1920
|
+
"application/json": components["schemas"]["error_api_404"];
|
|
1921
|
+
};
|
|
1922
|
+
};
|
|
1923
|
+
error_api_429: {
|
|
1924
|
+
headers: {
|
|
1925
|
+
[name: string]: unknown;
|
|
1926
|
+
};
|
|
1927
|
+
content: {
|
|
1928
|
+
"application/json": components["schemas"]["error_api_429"];
|
|
1929
|
+
};
|
|
1930
|
+
};
|
|
1931
|
+
error_api_529: {
|
|
1932
|
+
headers: {
|
|
1933
|
+
[name: string]: unknown;
|
|
1934
|
+
};
|
|
1935
|
+
content: {
|
|
1936
|
+
"application/json": components["schemas"]["error_api_529"];
|
|
1937
|
+
};
|
|
1938
|
+
};
|
|
1939
|
+
error_api_500: {
|
|
1940
|
+
headers: {
|
|
1941
|
+
[name: string]: unknown;
|
|
1942
|
+
};
|
|
1943
|
+
content: {
|
|
1944
|
+
"application/json": components["schemas"]["error_api_500"];
|
|
1945
|
+
};
|
|
1946
|
+
};
|
|
1947
|
+
error_api_503: {
|
|
1948
|
+
headers: {
|
|
1949
|
+
[name: string]: unknown;
|
|
1950
|
+
};
|
|
1951
|
+
content: {
|
|
1952
|
+
"application/json": components["schemas"]["error_api_503"];
|
|
1953
|
+
};
|
|
1954
|
+
};
|
|
1955
|
+
error_api_504: {
|
|
1956
|
+
headers: {
|
|
1957
|
+
[name: string]: unknown;
|
|
1958
|
+
};
|
|
1959
|
+
content: {
|
|
1960
|
+
"application/json": components["schemas"]["error_api_504"];
|
|
1961
|
+
};
|
|
1962
|
+
};
|
|
1963
|
+
error_api_409: {
|
|
1964
|
+
headers: {
|
|
1965
|
+
[name: string]: unknown;
|
|
1966
|
+
};
|
|
1967
|
+
content: {
|
|
1968
|
+
"application/json": components["schemas"]["error_api_409"];
|
|
1969
|
+
};
|
|
1970
|
+
};
|
|
1971
|
+
error_api_406: {
|
|
1972
|
+
headers: {
|
|
1973
|
+
[name: string]: unknown;
|
|
1974
|
+
};
|
|
1975
|
+
content: {
|
|
1976
|
+
"application/json": components["schemas"]["error_api_406"];
|
|
1977
|
+
};
|
|
1978
|
+
};
|
|
1979
|
+
};
|
|
1980
|
+
parameters: {
|
|
1981
|
+
/** @description The [API version](/reference/versioning) to use for this request. The latest version is `2026-03-11`. */
|
|
1982
|
+
notionVersion: "2026-03-11";
|
|
1983
|
+
};
|
|
1984
|
+
requestBodies: never;
|
|
1985
|
+
headers: never;
|
|
1986
|
+
pathItems: never;
|
|
1987
|
+
};
|
|
1988
|
+
export type SchemaAgentIdParentForBlockBasedObjectResponse = components["schemas"]["agentIdParentForBlockBasedObjectResponse"];
|
|
1989
|
+
export type SchemaAnnotationResponse = components["schemas"]["annotationResponse"];
|
|
1990
|
+
export type SchemaApiColor = components["schemas"]["apiColor"];
|
|
1991
|
+
export type SchemaArrayBasedPropertyValueResponse = components["schemas"]["arrayBasedPropertyValueResponse"];
|
|
1992
|
+
export type SchemaArrayPartialRollupValueResponse = components["schemas"]["arrayPartialRollupValueResponse"];
|
|
1993
|
+
export type SchemaBlockIdParentForBlockBasedObjectResponse = components["schemas"]["blockIdParentForBlockBasedObjectResponse"];
|
|
1994
|
+
export type SchemaBooleanFormulaPropertyValueResponse = components["schemas"]["booleanFormulaPropertyValueResponse"];
|
|
1995
|
+
export type SchemaBotInfoResponse = components["schemas"]["botInfoResponse"];
|
|
1996
|
+
export type SchemaBotUserObjectResponse = components["schemas"]["botUserObjectResponse"];
|
|
1997
|
+
export type SchemaButtonSimplePropertyValueResponse = components["schemas"]["buttonSimplePropertyValueResponse"];
|
|
1998
|
+
export type SchemaCheckboxDatabasePropertyConfigResponse = components["schemas"]["checkboxDatabasePropertyConfigResponse"];
|
|
1999
|
+
export type SchemaCheckboxPropertyFilter = components["schemas"]["checkboxPropertyFilter"];
|
|
2000
|
+
export type SchemaCheckboxSimplePropertyValueResponse = components["schemas"]["checkboxSimplePropertyValueResponse"];
|
|
2001
|
+
export type SchemaCreatedByDatabasePropertyConfigResponse = components["schemas"]["createdByDatabasePropertyConfigResponse"];
|
|
2002
|
+
export type SchemaCreatedBySimplePropertyValueResponse = components["schemas"]["createdBySimplePropertyValueResponse"];
|
|
2003
|
+
export type SchemaCreatedTimeDatabasePropertyConfigResponse = components["schemas"]["createdTimeDatabasePropertyConfigResponse"];
|
|
2004
|
+
export type SchemaCreatedTimeSimplePropertyValueResponse = components["schemas"]["createdTimeSimplePropertyValueResponse"];
|
|
2005
|
+
export type SchemaCustomEmojiPageIconResponse = components["schemas"]["customEmojiPageIconResponse"];
|
|
2006
|
+
export type SchemaCustomEmojiResponse = components["schemas"]["customEmojiResponse"];
|
|
2007
|
+
export type SchemaDataSourceObjectResponse = components["schemas"]["dataSourceObjectResponse"];
|
|
2008
|
+
export type SchemaDataSourceParentResponse = components["schemas"]["dataSourceParentResponse"];
|
|
2009
|
+
export type SchemaDatabaseParentResponse = components["schemas"]["databaseParentResponse"];
|
|
2010
|
+
export type SchemaDatabasePropertyConfigResponse = components["schemas"]["databasePropertyConfigResponse"];
|
|
2011
|
+
export type SchemaDatabasePropertyConfigResponseCommon = components["schemas"]["databasePropertyConfigResponseCommon"];
|
|
2012
|
+
export type SchemaDatabasePropertyRelationConfigResponse = components["schemas"]["databasePropertyRelationConfigResponse"];
|
|
2013
|
+
export type SchemaDatabasePropertyRelationConfigResponseCommon = components["schemas"]["databasePropertyRelationConfigResponseCommon"];
|
|
2014
|
+
export type SchemaDateDatabasePropertyConfigResponse = components["schemas"]["dateDatabasePropertyConfigResponse"];
|
|
2015
|
+
export type SchemaDateFormulaPropertyValueResponse = components["schemas"]["dateFormulaPropertyValueResponse"];
|
|
2016
|
+
export type SchemaDateOrRelativeDate = components["schemas"]["dateOrRelativeDate"];
|
|
2017
|
+
export type SchemaDatePartialRollupValueResponse = components["schemas"]["datePartialRollupValueResponse"];
|
|
2018
|
+
export type SchemaDatePropertyFilter = components["schemas"]["datePropertyFilter"];
|
|
2019
|
+
export type SchemaDateResponse = components["schemas"]["dateResponse"];
|
|
2020
|
+
export type SchemaDateSimplePropertyValueResponse = components["schemas"]["dateSimplePropertyValueResponse"];
|
|
2021
|
+
export type SchemaDualPropertyDatabasePropertyRelationConfigResponse = components["schemas"]["dualPropertyDatabasePropertyRelationConfigResponse"];
|
|
2022
|
+
export type SchemaEmailDatabasePropertyConfigResponse = components["schemas"]["emailDatabasePropertyConfigResponse"];
|
|
2023
|
+
export type SchemaEmailSimplePropertyValueResponse = components["schemas"]["emailSimplePropertyValueResponse"];
|
|
2024
|
+
export type SchemaEmojiPageIconResponse = components["schemas"]["emojiPageIconResponse"];
|
|
2025
|
+
export type SchemaEmojiRequest = components["schemas"]["emojiRequest"];
|
|
2026
|
+
export type SchemaEmptyObject = components["schemas"]["emptyObject"];
|
|
2027
|
+
export type SchemaEquationRichTextItemResponse = components["schemas"]["equationRichTextItemResponse"];
|
|
2028
|
+
export type SchemaErrorApi_400 = components["schemas"]["error_api_400"];
|
|
2029
|
+
export type SchemaErrorApi_401 = components["schemas"]["error_api_401"];
|
|
2030
|
+
export type SchemaErrorApi_403 = components["schemas"]["error_api_403"];
|
|
2031
|
+
export type SchemaErrorApi_404 = components["schemas"]["error_api_404"];
|
|
2032
|
+
export type SchemaErrorApi_406 = components["schemas"]["error_api_406"];
|
|
2033
|
+
export type SchemaErrorApi_409 = components["schemas"]["error_api_409"];
|
|
2034
|
+
export type SchemaErrorApi_429 = components["schemas"]["error_api_429"];
|
|
2035
|
+
export type SchemaErrorApi_500 = components["schemas"]["error_api_500"];
|
|
2036
|
+
export type SchemaErrorApi_503 = components["schemas"]["error_api_503"];
|
|
2037
|
+
export type SchemaErrorApi_504 = components["schemas"]["error_api_504"];
|
|
2038
|
+
export type SchemaErrorApi_529 = components["schemas"]["error_api_529"];
|
|
2039
|
+
export type SchemaExistencePropertyFilter = components["schemas"]["existencePropertyFilter"];
|
|
2040
|
+
export type SchemaExternalInternalOrExternalFileWithNameResponse = components["schemas"]["externalInternalOrExternalFileWithNameResponse"];
|
|
2041
|
+
export type SchemaExternalPageCoverResponse = components["schemas"]["externalPageCoverResponse"];
|
|
2042
|
+
export type SchemaExternalPageIconResponse = components["schemas"]["externalPageIconResponse"];
|
|
2043
|
+
export type SchemaFileInternalOrExternalFileWithNameResponse = components["schemas"]["fileInternalOrExternalFileWithNameResponse"];
|
|
2044
|
+
export type SchemaFilePageCoverResponse = components["schemas"]["filePageCoverResponse"];
|
|
2045
|
+
export type SchemaFilePageIconResponse = components["schemas"]["filePageIconResponse"];
|
|
2046
|
+
export type SchemaFilesDatabasePropertyConfigResponse = components["schemas"]["filesDatabasePropertyConfigResponse"];
|
|
2047
|
+
export type SchemaFilesSimplePropertyValueResponse = components["schemas"]["filesSimplePropertyValueResponse"];
|
|
2048
|
+
export type SchemaFormulaDatabasePropertyConfigResponse = components["schemas"]["formulaDatabasePropertyConfigResponse"];
|
|
2049
|
+
export type SchemaFormulaPropertyFilter = components["schemas"]["formulaPropertyFilter"];
|
|
2050
|
+
export type SchemaFormulaPropertyValueResponse = components["schemas"]["formulaPropertyValueResponse"];
|
|
2051
|
+
export type SchemaFormulaSimplePropertyValueResponse = components["schemas"]["formulaSimplePropertyValueResponse"];
|
|
2052
|
+
export type SchemaGroupFilterOperatorArray = components["schemas"]["groupFilterOperatorArray"];
|
|
2053
|
+
export type SchemaGroupObjectResponse = components["schemas"]["groupObjectResponse"];
|
|
2054
|
+
export type SchemaIconPageIconResponse = components["schemas"]["iconPageIconResponse"];
|
|
2055
|
+
export type SchemaIdObjectResponse = components["schemas"]["idObjectResponse"];
|
|
2056
|
+
export type SchemaIdRequest = components["schemas"]["idRequest"];
|
|
2057
|
+
export type SchemaIdResponse = components["schemas"]["idResponse"];
|
|
2058
|
+
export type SchemaInternalFileResponse = components["schemas"]["internalFileResponse"];
|
|
2059
|
+
export type SchemaInternalOrExternalFileWithNameResponse = components["schemas"]["internalOrExternalFileWithNameResponse"];
|
|
2060
|
+
export type SchemaInternalOrExternalFileWithNameResponseCommon = components["schemas"]["internalOrExternalFileWithNameResponseCommon"];
|
|
2061
|
+
export type SchemaLastEditedByDatabasePropertyConfigResponse = components["schemas"]["lastEditedByDatabasePropertyConfigResponse"];
|
|
2062
|
+
export type SchemaLastEditedBySimplePropertyValueResponse = components["schemas"]["lastEditedBySimplePropertyValueResponse"];
|
|
2063
|
+
export type SchemaLastEditedTimeDatabasePropertyConfigResponse = components["schemas"]["lastEditedTimeDatabasePropertyConfigResponse"];
|
|
2064
|
+
export type SchemaLastEditedTimeSimplePropertyValueResponse = components["schemas"]["lastEditedTimeSimplePropertyValueResponse"];
|
|
2065
|
+
export type SchemaLinkMentionResponse = components["schemas"]["linkMentionResponse"];
|
|
2066
|
+
export type SchemaLinkPreviewMentionResponse = components["schemas"]["linkPreviewMentionResponse"];
|
|
2067
|
+
export type SchemaMentionRichTextItemResponse = components["schemas"]["mentionRichTextItemResponse"];
|
|
2068
|
+
export type SchemaMultiSelectDatabasePropertyConfigResponse = components["schemas"]["multiSelectDatabasePropertyConfigResponse"];
|
|
2069
|
+
export type SchemaMultiSelectPropertyFilter = components["schemas"]["multiSelectPropertyFilter"];
|
|
2070
|
+
export type SchemaMultiSelectSimplePropertyValueResponse = components["schemas"]["multiSelectSimplePropertyValueResponse"];
|
|
2071
|
+
export type SchemaNoticonColor = components["schemas"]["noticonColor"];
|
|
2072
|
+
export type SchemaNoticonIconResponse = components["schemas"]["noticonIconResponse"];
|
|
2073
|
+
export type SchemaNoticonName = components["schemas"]["noticonName"];
|
|
2074
|
+
export type SchemaNumberDatabasePropertyConfigResponse = components["schemas"]["numberDatabasePropertyConfigResponse"];
|
|
2075
|
+
export type SchemaNumberFormat = components["schemas"]["numberFormat"];
|
|
2076
|
+
export type SchemaNumberFormulaPropertyValueResponse = components["schemas"]["numberFormulaPropertyValueResponse"];
|
|
2077
|
+
export type SchemaNumberPartialRollupValueResponse = components["schemas"]["numberPartialRollupValueResponse"];
|
|
2078
|
+
export type SchemaNumberPropertyFilter = components["schemas"]["numberPropertyFilter"];
|
|
2079
|
+
export type SchemaNumberSimplePropertyValueResponse = components["schemas"]["numberSimplePropertyValueResponse"];
|
|
2080
|
+
export type SchemaPageCoverResponse = components["schemas"]["pageCoverResponse"];
|
|
2081
|
+
export type SchemaPageIconResponse = components["schemas"]["pageIconResponse"];
|
|
2082
|
+
export type SchemaPageIdParentForBlockBasedObjectResponse = components["schemas"]["pageIdParentForBlockBasedObjectResponse"];
|
|
2083
|
+
export type SchemaPageObjectResponse = components["schemas"]["pageObjectResponse"];
|
|
2084
|
+
export type SchemaPageOrDataSourceListResponse = components["schemas"]["pageOrDataSourceListResponse"];
|
|
2085
|
+
export type SchemaPagePropertyValueWithIdResponse = components["schemas"]["pagePropertyValueWithIdResponse"];
|
|
2086
|
+
export type SchemaParentForBlockBasedObjectResponse = components["schemas"]["parentForBlockBasedObjectResponse"];
|
|
2087
|
+
export type SchemaParentOfDataSourceResponse = components["schemas"]["parentOfDataSourceResponse"];
|
|
2088
|
+
export type SchemaParentOfDatabaseResponse = components["schemas"]["parentOfDatabaseResponse"];
|
|
2089
|
+
export type SchemaPartialDataSourceObjectResponse = components["schemas"]["partialDataSourceObjectResponse"];
|
|
2090
|
+
export type SchemaPartialPageObjectResponse = components["schemas"]["partialPageObjectResponse"];
|
|
2091
|
+
export type SchemaPartialRollupPropertyResponse = components["schemas"]["partialRollupPropertyResponse"];
|
|
2092
|
+
export type SchemaPartialRollupValueResponse = components["schemas"]["partialRollupValueResponse"];
|
|
2093
|
+
export type SchemaPartialRollupValueResponseCommon = components["schemas"]["partialRollupValueResponseCommon"];
|
|
2094
|
+
export type SchemaPartialSelectPropertyValueResponse = components["schemas"]["partialSelectPropertyValueResponse"];
|
|
2095
|
+
export type SchemaPartialUserObjectResponse = components["schemas"]["partialUserObjectResponse"];
|
|
2096
|
+
export type SchemaPeopleArrayBasedPropertyValueResponse = components["schemas"]["peopleArrayBasedPropertyValueResponse"];
|
|
2097
|
+
export type SchemaPeopleDatabasePropertyConfigResponse = components["schemas"]["peopleDatabasePropertyConfigResponse"];
|
|
2098
|
+
export type SchemaPeoplePropertyFilter = components["schemas"]["peoplePropertyFilter"];
|
|
2099
|
+
export type SchemaPersonIdOrMe = components["schemas"]["personIdOrMe"];
|
|
2100
|
+
export type SchemaPersonUserObjectResponse = components["schemas"]["personUserObjectResponse"];
|
|
2101
|
+
export type SchemaPhoneNumberDatabasePropertyConfigResponse = components["schemas"]["phoneNumberDatabasePropertyConfigResponse"];
|
|
2102
|
+
export type SchemaPhoneNumberSimplePropertyValueResponse = components["schemas"]["phoneNumberSimplePropertyValueResponse"];
|
|
2103
|
+
export type SchemaPlacePropertyValueResponse = components["schemas"]["placePropertyValueResponse"];
|
|
2104
|
+
export type SchemaPlaceSimplePropertyValueResponse = components["schemas"]["placeSimplePropertyValueResponse"];
|
|
2105
|
+
export type SchemaPropertyDescriptionRequest = components["schemas"]["propertyDescriptionRequest"];
|
|
2106
|
+
export type SchemaPropertyFilter = components["schemas"]["propertyFilter"];
|
|
2107
|
+
export type SchemaPropertyOrTimestampFilter = components["schemas"]["propertyOrTimestampFilter"];
|
|
2108
|
+
export type SchemaPropertyOrTimestampFilterArray = components["schemas"]["propertyOrTimestampFilterArray"];
|
|
2109
|
+
export type SchemaPublicApiCommonErrorResponse = components["schemas"]["publicApiCommonErrorResponse"];
|
|
2110
|
+
export type SchemaRelationArrayBasedPropertyValueResponse = components["schemas"]["relationArrayBasedPropertyValueResponse"];
|
|
2111
|
+
export type SchemaRelationDatabasePropertyConfigResponse = components["schemas"]["relationDatabasePropertyConfigResponse"];
|
|
2112
|
+
export type SchemaRelationItemPropertyValueResponse = components["schemas"]["relationItemPropertyValueResponse"];
|
|
2113
|
+
export type SchemaRelationPropertyFilter = components["schemas"]["relationPropertyFilter"];
|
|
2114
|
+
export type SchemaRelativeDateValue = components["schemas"]["relativeDateValue"];
|
|
2115
|
+
export type SchemaRichTextArrayBasedPropertyValueResponse = components["schemas"]["richTextArrayBasedPropertyValueResponse"];
|
|
2116
|
+
export type SchemaRichTextDatabasePropertyConfigResponse = components["schemas"]["richTextDatabasePropertyConfigResponse"];
|
|
2117
|
+
export type SchemaRichTextItemResponse = components["schemas"]["richTextItemResponse"];
|
|
2118
|
+
export type SchemaRichTextItemResponseCommon = components["schemas"]["richTextItemResponseCommon"];
|
|
2119
|
+
export type SchemaRollupDatabasePropertyConfigResponse = components["schemas"]["rollupDatabasePropertyConfigResponse"];
|
|
2120
|
+
export type SchemaRollupFunction = components["schemas"]["rollupFunction"];
|
|
2121
|
+
export type SchemaRollupPropertyFilter = components["schemas"]["rollupPropertyFilter"];
|
|
2122
|
+
export type SchemaRollupSubfilterPropertyFilter = components["schemas"]["rollupSubfilterPropertyFilter"];
|
|
2123
|
+
export type SchemaSelectColor = components["schemas"]["selectColor"];
|
|
2124
|
+
export type SchemaSelectDatabasePropertyConfigResponse = components["schemas"]["selectDatabasePropertyConfigResponse"];
|
|
2125
|
+
export type SchemaSelectPropertyFilter = components["schemas"]["selectPropertyFilter"];
|
|
2126
|
+
export type SchemaSelectPropertyResponse = components["schemas"]["selectPropertyResponse"];
|
|
2127
|
+
export type SchemaSelectSimplePropertyValueResponse = components["schemas"]["selectSimplePropertyValueResponse"];
|
|
2128
|
+
export type SchemaSimpleOrArrayPropertyValueResponse = components["schemas"]["simpleOrArrayPropertyValueResponse"];
|
|
2129
|
+
export type SchemaSimplePropertyValueResponse = components["schemas"]["simplePropertyValueResponse"];
|
|
2130
|
+
export type SchemaSinglePropertyDatabasePropertyRelationConfigResponse = components["schemas"]["singlePropertyDatabasePropertyRelationConfigResponse"];
|
|
2131
|
+
export type SchemaStatusDatabasePropertyConfigResponse = components["schemas"]["statusDatabasePropertyConfigResponse"];
|
|
2132
|
+
export type SchemaStatusGroupNames = components["schemas"]["statusGroupNames"];
|
|
2133
|
+
export type SchemaStatusPropertyFilter = components["schemas"]["statusPropertyFilter"];
|
|
2134
|
+
export type SchemaStatusPropertyResponse = components["schemas"]["statusPropertyResponse"];
|
|
2135
|
+
export type SchemaStatusSimplePropertyValueResponse = components["schemas"]["statusSimplePropertyValueResponse"];
|
|
2136
|
+
export type SchemaStatusValueFilter = components["schemas"]["statusValueFilter"];
|
|
2137
|
+
export type SchemaStringFormulaPropertyValueResponse = components["schemas"]["stringFormulaPropertyValueResponse"];
|
|
2138
|
+
export type SchemaStringOrStringArray = components["schemas"]["stringOrStringArray"];
|
|
2139
|
+
export type SchemaStringRequest = components["schemas"]["stringRequest"];
|
|
2140
|
+
export type SchemaTemplateMentionDateTemplateMentionResponse = components["schemas"]["templateMentionDateTemplateMentionResponse"];
|
|
2141
|
+
export type SchemaTemplateMentionResponse = components["schemas"]["templateMentionResponse"];
|
|
2142
|
+
export type SchemaTemplateMentionUserTemplateMentionResponse = components["schemas"]["templateMentionUserTemplateMentionResponse"];
|
|
2143
|
+
export type SchemaTextPropertyFilter = components["schemas"]["textPropertyFilter"];
|
|
2144
|
+
export type SchemaTextRichTextItemResponse = components["schemas"]["textRichTextItemResponse"];
|
|
2145
|
+
export type SchemaTimeZoneRequest = components["schemas"]["timeZoneRequest"];
|
|
2146
|
+
export type SchemaTimestampCreatedTimeFilter = components["schemas"]["timestampCreatedTimeFilter"];
|
|
2147
|
+
export type SchemaTimestampFilter = components["schemas"]["timestampFilter"];
|
|
2148
|
+
export type SchemaTimestampLastEditedTimeFilter = components["schemas"]["timestampLastEditedTimeFilter"];
|
|
2149
|
+
export type SchemaTitleArrayBasedPropertyValueResponse = components["schemas"]["titleArrayBasedPropertyValueResponse"];
|
|
2150
|
+
export type SchemaTitleDatabasePropertyConfigResponse = components["schemas"]["titleDatabasePropertyConfigResponse"];
|
|
2151
|
+
export type SchemaUniqueIdDatabasePropertyConfigResponse = components["schemas"]["uniqueIdDatabasePropertyConfigResponse"];
|
|
2152
|
+
export type SchemaUniqueIdPropertyValueResponse = components["schemas"]["uniqueIdPropertyValueResponse"];
|
|
2153
|
+
export type SchemaUniqueIdSimplePropertyValueResponse = components["schemas"]["uniqueIdSimplePropertyValueResponse"];
|
|
2154
|
+
export type SchemaUnsupportedFormulaPropertyValueResponse = components["schemas"]["unsupportedFormulaPropertyValueResponse"];
|
|
2155
|
+
export type SchemaUnsupportedPartialRollupValueResponse = components["schemas"]["unsupportedPartialRollupValueResponse"];
|
|
2156
|
+
export type SchemaUrlDatabasePropertyConfigResponse = components["schemas"]["urlDatabasePropertyConfigResponse"];
|
|
2157
|
+
export type SchemaUrlSimplePropertyValueResponse = components["schemas"]["urlSimplePropertyValueResponse"];
|
|
2158
|
+
export type SchemaUserObjectResponse = components["schemas"]["userObjectResponse"];
|
|
2159
|
+
export type SchemaUserObjectResponseCommon = components["schemas"]["userObjectResponseCommon"];
|
|
2160
|
+
export type SchemaUserValueResponse = components["schemas"]["userValueResponse"];
|
|
2161
|
+
export type SchemaVerificationPropertyDoesNotEqualFilter = components["schemas"]["verificationPropertyDoesNotEqualFilter"];
|
|
2162
|
+
export type SchemaVerificationPropertyResponse = components["schemas"]["verificationPropertyResponse"];
|
|
2163
|
+
export type SchemaVerificationPropertyStatusFilter = components["schemas"]["verificationPropertyStatusFilter"];
|
|
2164
|
+
export type SchemaVerificationPropertyUnverifiedResponse = components["schemas"]["verificationPropertyUnverifiedResponse"];
|
|
2165
|
+
export type SchemaVerificationPropertyValueResponse = components["schemas"]["verificationPropertyValueResponse"];
|
|
2166
|
+
export type SchemaVerificationSimplePropertyValueResponse = components["schemas"]["verificationSimplePropertyValueResponse"];
|
|
2167
|
+
export type SchemaViewFilterRequest = components["schemas"]["viewFilterRequest"];
|
|
2168
|
+
export type SchemaViewSortRequest = components["schemas"]["viewSortRequest"];
|
|
2169
|
+
export type SchemaWorkspaceParentForBlockBasedObjectResponse = components["schemas"]["workspaceParentForBlockBasedObjectResponse"];
|
|
2170
|
+
export type ResponseErrorApi_400 = components["responses"]["error_api_400"];
|
|
2171
|
+
export type ResponseErrorApi_401 = components["responses"]["error_api_401"];
|
|
2172
|
+
export type ResponseErrorApi_403 = components["responses"]["error_api_403"];
|
|
2173
|
+
export type ResponseErrorApi_404 = components["responses"]["error_api_404"];
|
|
2174
|
+
export type ResponseErrorApi_429 = components["responses"]["error_api_429"];
|
|
2175
|
+
export type ResponseErrorApi_529 = components["responses"]["error_api_529"];
|
|
2176
|
+
export type ResponseErrorApi_500 = components["responses"]["error_api_500"];
|
|
2177
|
+
export type ResponseErrorApi_503 = components["responses"]["error_api_503"];
|
|
2178
|
+
export type ResponseErrorApi_504 = components["responses"]["error_api_504"];
|
|
2179
|
+
export type ResponseErrorApi_409 = components["responses"]["error_api_409"];
|
|
2180
|
+
export type ResponseErrorApi_406 = components["responses"]["error_api_406"];
|
|
2181
|
+
export type ParameterNotionVersion = components["parameters"]["notionVersion"];
|
|
2182
|
+
export type $defs = Record<string, never>;
|
|
2183
|
+
export interface operations {
|
|
2184
|
+
"get-self": {
|
|
2185
|
+
parameters: {
|
|
2186
|
+
query?: never;
|
|
2187
|
+
header: {
|
|
2188
|
+
/** @description The [API version](/reference/versioning) to use for this request. The latest version is `2026-03-11`. */
|
|
2189
|
+
"Notion-Version": components["parameters"]["notionVersion"];
|
|
2190
|
+
};
|
|
2191
|
+
path?: never;
|
|
2192
|
+
cookie?: never;
|
|
2193
|
+
};
|
|
2194
|
+
requestBody?: never;
|
|
2195
|
+
responses: {
|
|
2196
|
+
200: {
|
|
2197
|
+
headers: {
|
|
2198
|
+
[name: string]: unknown;
|
|
2199
|
+
};
|
|
2200
|
+
content: {
|
|
2201
|
+
"application/json": components["schemas"]["userObjectResponse"];
|
|
2202
|
+
};
|
|
2203
|
+
};
|
|
2204
|
+
400: components["responses"]["error_api_400"];
|
|
2205
|
+
401: components["responses"]["error_api_401"];
|
|
2206
|
+
403: components["responses"]["error_api_403"];
|
|
2207
|
+
404: components["responses"]["error_api_404"];
|
|
2208
|
+
406: components["responses"]["error_api_406"];
|
|
2209
|
+
409: components["responses"]["error_api_409"];
|
|
2210
|
+
429: components["responses"]["error_api_429"];
|
|
2211
|
+
500: components["responses"]["error_api_500"];
|
|
2212
|
+
503: components["responses"]["error_api_503"];
|
|
2213
|
+
504: components["responses"]["error_api_504"];
|
|
2214
|
+
529: components["responses"]["error_api_529"];
|
|
2215
|
+
};
|
|
2216
|
+
};
|
|
2217
|
+
"get-users": {
|
|
2218
|
+
parameters: {
|
|
2219
|
+
query?: {
|
|
2220
|
+
start_cursor?: string;
|
|
2221
|
+
page_size?: number;
|
|
2222
|
+
};
|
|
2223
|
+
header: {
|
|
2224
|
+
/** @description The [API version](/reference/versioning) to use for this request. The latest version is `2026-03-11`. */
|
|
2225
|
+
"Notion-Version": components["parameters"]["notionVersion"];
|
|
2226
|
+
};
|
|
2227
|
+
path?: never;
|
|
2228
|
+
cookie?: never;
|
|
2229
|
+
};
|
|
2230
|
+
requestBody?: never;
|
|
2231
|
+
responses: {
|
|
2232
|
+
200: {
|
|
2233
|
+
headers: {
|
|
2234
|
+
[name: string]: unknown;
|
|
2235
|
+
};
|
|
2236
|
+
content: {
|
|
2237
|
+
"application/json": {
|
|
2238
|
+
/** @constant */
|
|
2239
|
+
type: "user";
|
|
2240
|
+
user: components["schemas"]["emptyObject"];
|
|
2241
|
+
/** @constant */
|
|
2242
|
+
object: "list";
|
|
2243
|
+
next_cursor: string | null;
|
|
2244
|
+
has_more: boolean;
|
|
2245
|
+
results: components["schemas"]["userObjectResponse"][];
|
|
2246
|
+
};
|
|
2247
|
+
};
|
|
2248
|
+
};
|
|
2249
|
+
400: components["responses"]["error_api_400"];
|
|
2250
|
+
401: components["responses"]["error_api_401"];
|
|
2251
|
+
403: components["responses"]["error_api_403"];
|
|
2252
|
+
404: components["responses"]["error_api_404"];
|
|
2253
|
+
406: components["responses"]["error_api_406"];
|
|
2254
|
+
409: components["responses"]["error_api_409"];
|
|
2255
|
+
429: components["responses"]["error_api_429"];
|
|
2256
|
+
500: components["responses"]["error_api_500"];
|
|
2257
|
+
503: components["responses"]["error_api_503"];
|
|
2258
|
+
504: components["responses"]["error_api_504"];
|
|
2259
|
+
529: components["responses"]["error_api_529"];
|
|
2260
|
+
};
|
|
2261
|
+
};
|
|
2262
|
+
"post-search": {
|
|
2263
|
+
parameters: {
|
|
2264
|
+
query?: {
|
|
2265
|
+
filter_properties?: string[];
|
|
2266
|
+
};
|
|
2267
|
+
header: {
|
|
2268
|
+
/** @description The [API version](/reference/versioning) to use for this request. The latest version is `2026-03-11`. */
|
|
2269
|
+
"Notion-Version": components["parameters"]["notionVersion"];
|
|
2270
|
+
};
|
|
2271
|
+
path?: never;
|
|
2272
|
+
cookie?: never;
|
|
2273
|
+
};
|
|
2274
|
+
requestBody: {
|
|
2275
|
+
content: {
|
|
2276
|
+
"application/json": {
|
|
2277
|
+
sort?: {
|
|
2278
|
+
/** @enum {string} */
|
|
2279
|
+
timestamp: "last_edited_time";
|
|
2280
|
+
/** @enum {string} */
|
|
2281
|
+
direction: "ascending" | "descending";
|
|
2282
|
+
} | {
|
|
2283
|
+
/** @enum {string} */
|
|
2284
|
+
property: "relevance";
|
|
2285
|
+
};
|
|
2286
|
+
query?: string;
|
|
2287
|
+
/** Format: uuid */
|
|
2288
|
+
start_cursor?: string;
|
|
2289
|
+
page_size?: number;
|
|
2290
|
+
filter?: {
|
|
2291
|
+
/** @enum {string} */
|
|
2292
|
+
property: "object";
|
|
2293
|
+
/** @enum {string} */
|
|
2294
|
+
value: "page" | "data_source";
|
|
2295
|
+
in_trash?: boolean;
|
|
2296
|
+
} | {
|
|
2297
|
+
in_trash: boolean;
|
|
2298
|
+
};
|
|
2299
|
+
};
|
|
2300
|
+
};
|
|
2301
|
+
};
|
|
2302
|
+
responses: {
|
|
2303
|
+
200: {
|
|
2304
|
+
headers: {
|
|
2305
|
+
[name: string]: unknown;
|
|
2306
|
+
};
|
|
2307
|
+
content: {
|
|
2308
|
+
"application/json": components["schemas"]["pageOrDataSourceListResponse"];
|
|
2309
|
+
};
|
|
2310
|
+
};
|
|
2311
|
+
400: components["responses"]["error_api_400"];
|
|
2312
|
+
401: components["responses"]["error_api_401"];
|
|
2313
|
+
403: components["responses"]["error_api_403"];
|
|
2314
|
+
404: components["responses"]["error_api_404"];
|
|
2315
|
+
406: components["responses"]["error_api_406"];
|
|
2316
|
+
409: components["responses"]["error_api_409"];
|
|
2317
|
+
429: components["responses"]["error_api_429"];
|
|
2318
|
+
500: components["responses"]["error_api_500"];
|
|
2319
|
+
503: components["responses"]["error_api_503"];
|
|
2320
|
+
504: components["responses"]["error_api_504"];
|
|
2321
|
+
529: components["responses"]["error_api_529"];
|
|
2322
|
+
};
|
|
2323
|
+
};
|
|
2324
|
+
"post-database-query": {
|
|
2325
|
+
parameters: {
|
|
2326
|
+
query?: {
|
|
2327
|
+
filter_properties?: string[];
|
|
2328
|
+
};
|
|
2329
|
+
header: {
|
|
2330
|
+
/** @description The [API version](/reference/versioning) to use for this request. The latest version is `2026-03-11`. */
|
|
2331
|
+
"Notion-Version": components["parameters"]["notionVersion"];
|
|
2332
|
+
};
|
|
2333
|
+
path: {
|
|
2334
|
+
data_source_id: components["schemas"]["idRequest"];
|
|
2335
|
+
};
|
|
2336
|
+
cookie?: never;
|
|
2337
|
+
};
|
|
2338
|
+
requestBody: {
|
|
2339
|
+
content: {
|
|
2340
|
+
"application/json": {
|
|
2341
|
+
sorts?: components["schemas"]["viewSortRequest"][];
|
|
2342
|
+
filter?: components["schemas"]["viewFilterRequest"];
|
|
2343
|
+
start_cursor?: string;
|
|
2344
|
+
page_size?: number;
|
|
2345
|
+
/** @description Whether to return archived pages. When omitted or false, returns non-archived pages. When true, returns archived pages. */
|
|
2346
|
+
is_archived?: boolean;
|
|
2347
|
+
/**
|
|
2348
|
+
* @description Optionally filter the results to only include pages or data sources. Regular, non-wiki databases only support page children. The default behavior is no result type filtering, in other words, returning both pages and data sources for wikis.
|
|
2349
|
+
* @enum {string}
|
|
2350
|
+
*/
|
|
2351
|
+
result_type?: "page" | "data_source";
|
|
2352
|
+
};
|
|
2353
|
+
};
|
|
2354
|
+
};
|
|
2355
|
+
responses: {
|
|
2356
|
+
200: {
|
|
2357
|
+
headers: {
|
|
2358
|
+
[name: string]: unknown;
|
|
2359
|
+
};
|
|
2360
|
+
content: {
|
|
2361
|
+
"application/json": components["schemas"]["pageOrDataSourceListResponse"];
|
|
2362
|
+
};
|
|
2363
|
+
};
|
|
2364
|
+
400: components["responses"]["error_api_400"];
|
|
2365
|
+
401: components["responses"]["error_api_401"];
|
|
2366
|
+
403: components["responses"]["error_api_403"];
|
|
2367
|
+
404: components["responses"]["error_api_404"];
|
|
2368
|
+
406: components["responses"]["error_api_406"];
|
|
2369
|
+
409: components["responses"]["error_api_409"];
|
|
2370
|
+
429: components["responses"]["error_api_429"];
|
|
2371
|
+
500: components["responses"]["error_api_500"];
|
|
2372
|
+
503: components["responses"]["error_api_503"];
|
|
2373
|
+
504: components["responses"]["error_api_504"];
|
|
2374
|
+
529: components["responses"]["error_api_529"];
|
|
2375
|
+
};
|
|
2376
|
+
};
|
|
2377
|
+
}
|
|
2378
|
+
//# sourceMappingURL=openapi.d.ts.map
|