@visus-io/notion-sdk-ts 3.0.2 → 3.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +20 -87
- package/dist/api/asyncTasks.api.d.ts +72 -0
- package/dist/api/asyncTasks.api.js +70 -0
- package/dist/api/base.api.d.ts +15 -4
- package/dist/api/base.api.js +20 -8
- package/dist/api/blocks.api.d.ts +435 -73
- package/dist/api/blocks.api.js +43 -1
- package/dist/api/comments.api.d.ts +42 -5
- package/dist/api/comments.api.js +45 -1
- package/dist/api/customEmojis.api.d.ts +38 -0
- package/dist/api/customEmojis.api.js +38 -0
- package/dist/api/dataSources.api.d.ts +67 -14
- package/dist/api/dataSources.api.js +26 -1
- package/dist/api/databases.api.d.ts +47 -11
- package/dist/api/databases.api.js +4 -1
- package/dist/api/fileUploads.api.d.ts +8 -5
- package/dist/api/fileUploads.api.js +11 -7
- package/dist/api/index.d.ts +3 -0
- package/dist/api/index.js +7 -1
- package/dist/api/pages.api.d.ts +144 -10
- package/dist/api/pages.api.js +66 -0
- package/dist/api/search.api.d.ts +12 -2
- package/dist/api/search.api.js +5 -2
- package/dist/api/users.api.d.ts +3 -0
- package/dist/api/users.api.js +2 -0
- package/dist/api/views.api.d.ts +286 -0
- package/dist/api/views.api.js +172 -0
- package/dist/client.d.ts +17 -17
- package/dist/client.js +25 -30
- package/dist/errors.d.ts +19 -5
- package/dist/errors.js +16 -4
- package/dist/helpers/block.helpers.d.ts +49 -5
- package/dist/helpers/block.helpers.js +50 -6
- package/dist/helpers/file.helpers.d.ts +46 -5
- package/dist/helpers/file.helpers.js +36 -8
- package/dist/helpers/filter.helpers.d.ts +8 -6
- package/dist/helpers/filter.helpers.js +2 -0
- package/dist/helpers/index.d.ts +3 -2
- package/dist/helpers/index.js +5 -1
- package/dist/helpers/pagination.helpers.d.ts +85 -13
- package/dist/helpers/pagination.helpers.js +114 -8
- package/dist/helpers/parent.helpers.d.ts +5 -3
- package/dist/helpers/parent.helpers.js +5 -3
- package/dist/helpers/property.helpers.d.ts +31 -0
- package/dist/helpers/property.helpers.js +30 -1
- package/dist/helpers/richText.helpers.d.ts +10 -5
- package/dist/helpers/richText.helpers.js +11 -6
- package/dist/helpers/sort.helpers.d.ts +2 -0
- package/dist/helpers/sort.helpers.js +2 -0
- package/dist/helpers/webhook.helpers.d.ts +54 -0
- package/dist/helpers/webhook.helpers.js +83 -0
- package/dist/models/asyncTask.model.d.ts +61 -0
- package/dist/models/asyncTask.model.js +91 -0
- package/dist/models/base.model.d.ts +16 -4
- package/dist/models/base.model.js +17 -5
- package/dist/models/block.model.d.ts +6 -2
- package/dist/models/block.model.js +48 -33
- package/dist/models/comment.model.d.ts +4 -2
- package/dist/models/comment.model.js +4 -2
- package/dist/models/customEmoji.model.d.ts +30 -0
- package/dist/models/customEmoji.model.js +44 -0
- package/dist/models/dataSource.model.d.ts +7 -5
- package/dist/models/dataSource.model.js +5 -3
- package/dist/models/database.model.d.ts +13 -5
- package/dist/models/database.model.js +15 -5
- package/dist/models/fileUpload.model.d.ts +6 -4
- package/dist/models/fileUpload.model.js +6 -4
- package/dist/models/index.d.ts +3 -0
- package/dist/models/index.js +7 -1
- package/dist/models/page.model.d.ts +8 -2
- package/dist/models/page.model.js +14 -4
- package/dist/models/richText.model.d.ts +3 -1
- package/dist/models/richText.model.js +3 -1
- package/dist/models/user.model.d.ts +4 -2
- package/dist/models/user.model.js +4 -2
- package/dist/models/view.model.d.ts +81 -0
- package/dist/models/view.model.js +121 -0
- package/dist/notion.d.ts +32 -8
- package/dist/notion.js +25 -4
- package/dist/schemas/asyncTask.schema.d.ts +53 -0
- package/dist/schemas/asyncTask.schema.js +88 -0
- package/dist/schemas/block.schema.d.ts +390 -73
- package/dist/schemas/block.schema.js +39 -8
- package/dist/schemas/codeLanguages.d.ts +7 -1
- package/dist/schemas/codeLanguages.js +4 -1
- package/dist/schemas/colors.d.ts +7 -1
- package/dist/schemas/colors.js +4 -1
- package/dist/schemas/comment.schema.d.ts +28 -5
- package/dist/schemas/comment.schema.js +11 -2
- package/dist/schemas/customEmoji.schema.d.ts +18 -0
- package/dist/schemas/customEmoji.schema.js +50 -0
- package/dist/schemas/dataSource.schema.d.ts +84 -10
- package/dist/schemas/dataSource.schema.js +31 -6
- package/dist/schemas/database.schema.d.ts +51 -7
- package/dist/schemas/database.schema.js +10 -3
- package/dist/schemas/emoji.schema.d.ts +7 -2
- package/dist/schemas/emoji.schema.js +4 -2
- package/dist/schemas/file.schema.d.ts +18 -2
- package/dist/schemas/file.schema.js +6 -2
- package/dist/schemas/fileUpload.schema.d.ts +9 -3
- package/dist/schemas/fileUpload.schema.js +5 -2
- package/dist/schemas/icon.schema.d.ts +116 -0
- package/dist/schemas/icon.schema.js +100 -0
- package/dist/schemas/index.d.ts +6 -0
- package/dist/schemas/index.js +6 -0
- package/dist/schemas/meetingNotesQuery.schema.d.ts +4198 -0
- package/dist/schemas/meetingNotesQuery.schema.js +67 -0
- package/dist/schemas/page.schema.d.ts +51 -9
- package/dist/schemas/page.schema.js +6 -2
- package/dist/schemas/pageMarkdown.schema.d.ts +70 -0
- package/dist/schemas/pageMarkdown.schema.js +70 -0
- package/dist/schemas/pageProperties.schema.d.ts +105 -21
- package/dist/schemas/pageProperties.schema.js +8 -6
- package/dist/schemas/pagination.schema.d.ts +57 -7
- package/dist/schemas/pagination.schema.js +25 -1
- package/dist/schemas/parent.schema.d.ts +39 -3
- package/dist/schemas/parent.schema.js +17 -5
- package/dist/schemas/propertyObjects.schema.d.ts +93 -15
- package/dist/schemas/propertyObjects.schema.js +11 -5
- package/dist/schemas/richText.schema.d.ts +23 -6
- package/dist/schemas/richText.schema.js +7 -4
- package/dist/schemas/shared.schema.d.ts +6 -3
- package/dist/schemas/shared.schema.js +6 -3
- package/dist/schemas/user.schema.d.ts +17 -0
- package/dist/schemas/user.schema.js +7 -3
- package/dist/schemas/view.schema.d.ts +1111 -0
- package/dist/schemas/view.schema.js +134 -0
- package/dist/validation.d.ts +11 -4
- package/dist/validation.js +11 -4
- package/package.json +6 -3
|
@@ -11,7 +11,7 @@ export interface RetrieveDatabaseOptions {
|
|
|
11
11
|
}
|
|
12
12
|
/**
|
|
13
13
|
* Filter condition for database queries.
|
|
14
|
-
* This is
|
|
14
|
+
* This type is simplified. The Notion API supports many more filter types.
|
|
15
15
|
* See: https://developers.notion.com/reference/post-database-query-filter
|
|
16
16
|
*/
|
|
17
17
|
export type DatabaseFilter = Record<string, unknown>;
|
|
@@ -62,8 +62,8 @@ export interface InitialDataSource {
|
|
|
62
62
|
}
|
|
63
63
|
/**
|
|
64
64
|
* Options for creating a database.
|
|
65
|
-
* As of API version 2025-09-03, databases
|
|
66
|
-
*
|
|
65
|
+
* As of API version 2025-09-03, databases require an `initial_data_source` object.
|
|
66
|
+
* This object holds the properties schema. It replaces top-level properties.
|
|
67
67
|
*/
|
|
68
68
|
export interface CreateDatabaseOptions {
|
|
69
69
|
/** The parent object (page or workspace) */
|
|
@@ -81,8 +81,8 @@ export interface CreateDatabaseOptions {
|
|
|
81
81
|
}
|
|
82
82
|
/**
|
|
83
83
|
* Options for updating a database.
|
|
84
|
-
* As of API version 2025-09-03, properties
|
|
85
|
-
* Use
|
|
84
|
+
* As of API version 2025-09-03, manage properties at the data source level.
|
|
85
|
+
* Use DataSourcesAPI to update properties.
|
|
86
86
|
*/
|
|
87
87
|
export interface UpdateDatabaseOptions {
|
|
88
88
|
/** Update the database title */
|
|
@@ -93,6 +93,8 @@ export interface UpdateDatabaseOptions {
|
|
|
93
93
|
cover?: unknown;
|
|
94
94
|
/** Move to trash or restore from trash */
|
|
95
95
|
in_trash?: boolean;
|
|
96
|
+
/** Lock or unlock the database from editing */
|
|
97
|
+
is_locked?: boolean;
|
|
96
98
|
/** Whether the database is inline */
|
|
97
99
|
is_inline?: boolean;
|
|
98
100
|
/** Move the database to a different parent */
|
|
@@ -100,6 +102,8 @@ export interface UpdateDatabaseOptions {
|
|
|
100
102
|
}
|
|
101
103
|
/**
|
|
102
104
|
* Databases API client for working with Notion databases.
|
|
105
|
+
*
|
|
106
|
+
* @category Databases & Data Sources
|
|
103
107
|
*/
|
|
104
108
|
export declare class DatabasesAPI extends BaseAPI<NotionDatabase, Database> {
|
|
105
109
|
protected readonly client: NotionClient;
|
|
@@ -120,6 +124,7 @@ export declare class DatabasesAPI extends BaseAPI<NotionDatabase, Database> {
|
|
|
120
124
|
avatar_url: import("zod").ZodOptional<import("zod").ZodUnion<readonly [import("zod").ZodURL, import("zod").ZodNull]>>;
|
|
121
125
|
person: import("zod").ZodObject<{
|
|
122
126
|
email: import("zod").ZodEmail;
|
|
127
|
+
email_verified: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
123
128
|
}, import("zod/v4/core").$strip>;
|
|
124
129
|
}, import("zod/v4/core").$strip>, import("zod").ZodObject<{
|
|
125
130
|
object: import("zod").ZodLiteral<"user">;
|
|
@@ -153,6 +158,7 @@ export declare class DatabasesAPI extends BaseAPI<NotionDatabase, Database> {
|
|
|
153
158
|
avatar_url: import("zod").ZodOptional<import("zod").ZodUnion<readonly [import("zod").ZodURL, import("zod").ZodNull]>>;
|
|
154
159
|
person: import("zod").ZodObject<{
|
|
155
160
|
email: import("zod").ZodEmail;
|
|
161
|
+
email_verified: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
156
162
|
}, import("zod/v4/core").$strip>;
|
|
157
163
|
}, import("zod/v4/core").$strip>, import("zod").ZodObject<{
|
|
158
164
|
object: import("zod").ZodLiteral<"user">;
|
|
@@ -192,11 +198,11 @@ export declare class DatabasesAPI extends BaseAPI<NotionDatabase, Database> {
|
|
|
192
198
|
underline: import("zod").ZodBoolean;
|
|
193
199
|
code: import("zod").ZodBoolean;
|
|
194
200
|
color: import("zod").ZodEnum<{
|
|
201
|
+
default: "default";
|
|
195
202
|
blue: "blue";
|
|
196
203
|
blue_background: "blue_background";
|
|
197
204
|
brown: "brown";
|
|
198
205
|
brown_background: "brown_background";
|
|
199
|
-
default: "default";
|
|
200
206
|
gray: "gray";
|
|
201
207
|
gray_background: "gray_background";
|
|
202
208
|
green: "green";
|
|
@@ -261,6 +267,7 @@ export declare class DatabasesAPI extends BaseAPI<NotionDatabase, Database> {
|
|
|
261
267
|
avatar_url: import("zod").ZodOptional<import("zod").ZodUnion<readonly [import("zod").ZodURL, import("zod").ZodNull]>>;
|
|
262
268
|
person: import("zod").ZodObject<{
|
|
263
269
|
email: import("zod").ZodEmail;
|
|
270
|
+
email_verified: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
264
271
|
}, import("zod/v4/core").$strip>;
|
|
265
272
|
}, import("zod/v4/core").$strip>, import("zod").ZodObject<{
|
|
266
273
|
object: import("zod").ZodLiteral<"user">;
|
|
@@ -293,11 +300,11 @@ export declare class DatabasesAPI extends BaseAPI<NotionDatabase, Database> {
|
|
|
293
300
|
underline: import("zod").ZodBoolean;
|
|
294
301
|
code: import("zod").ZodBoolean;
|
|
295
302
|
color: import("zod").ZodEnum<{
|
|
303
|
+
default: "default";
|
|
296
304
|
blue: "blue";
|
|
297
305
|
blue_background: "blue_background";
|
|
298
306
|
brown: "brown";
|
|
299
307
|
brown_background: "brown_background";
|
|
300
|
-
default: "default";
|
|
301
308
|
gray: "gray";
|
|
302
309
|
gray_background: "gray_background";
|
|
303
310
|
green: "green";
|
|
@@ -328,11 +335,11 @@ export declare class DatabasesAPI extends BaseAPI<NotionDatabase, Database> {
|
|
|
328
335
|
underline: import("zod").ZodBoolean;
|
|
329
336
|
code: import("zod").ZodBoolean;
|
|
330
337
|
color: import("zod").ZodEnum<{
|
|
338
|
+
default: "default";
|
|
331
339
|
blue: "blue";
|
|
332
340
|
blue_background: "blue_background";
|
|
333
341
|
brown: "brown";
|
|
334
342
|
brown_background: "brown_background";
|
|
335
|
-
default: "default";
|
|
336
343
|
gray: "gray";
|
|
337
344
|
gray_background: "gray_background";
|
|
338
345
|
green: "green";
|
|
@@ -367,11 +374,11 @@ export declare class DatabasesAPI extends BaseAPI<NotionDatabase, Database> {
|
|
|
367
374
|
underline: import("zod").ZodBoolean;
|
|
368
375
|
code: import("zod").ZodBoolean;
|
|
369
376
|
color: import("zod").ZodEnum<{
|
|
377
|
+
default: "default";
|
|
370
378
|
blue: "blue";
|
|
371
379
|
blue_background: "blue_background";
|
|
372
380
|
brown: "brown";
|
|
373
381
|
brown_background: "brown_background";
|
|
374
|
-
default: "default";
|
|
375
382
|
gray: "gray";
|
|
376
383
|
gray_background: "gray_background";
|
|
377
384
|
green: "green";
|
|
@@ -436,6 +443,7 @@ export declare class DatabasesAPI extends BaseAPI<NotionDatabase, Database> {
|
|
|
436
443
|
avatar_url: import("zod").ZodOptional<import("zod").ZodUnion<readonly [import("zod").ZodURL, import("zod").ZodNull]>>;
|
|
437
444
|
person: import("zod").ZodObject<{
|
|
438
445
|
email: import("zod").ZodEmail;
|
|
446
|
+
email_verified: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
439
447
|
}, import("zod/v4/core").$strip>;
|
|
440
448
|
}, import("zod/v4/core").$strip>, import("zod").ZodObject<{
|
|
441
449
|
object: import("zod").ZodLiteral<"user">;
|
|
@@ -468,11 +476,11 @@ export declare class DatabasesAPI extends BaseAPI<NotionDatabase, Database> {
|
|
|
468
476
|
underline: import("zod").ZodBoolean;
|
|
469
477
|
code: import("zod").ZodBoolean;
|
|
470
478
|
color: import("zod").ZodEnum<{
|
|
479
|
+
default: "default";
|
|
471
480
|
blue: "blue";
|
|
472
481
|
blue_background: "blue_background";
|
|
473
482
|
brown: "brown";
|
|
474
483
|
brown_background: "brown_background";
|
|
475
|
-
default: "default";
|
|
476
484
|
gray: "gray";
|
|
477
485
|
gray_background: "gray_background";
|
|
478
486
|
green: "green";
|
|
@@ -503,11 +511,11 @@ export declare class DatabasesAPI extends BaseAPI<NotionDatabase, Database> {
|
|
|
503
511
|
underline: import("zod").ZodBoolean;
|
|
504
512
|
code: import("zod").ZodBoolean;
|
|
505
513
|
color: import("zod").ZodEnum<{
|
|
514
|
+
default: "default";
|
|
506
515
|
blue: "blue";
|
|
507
516
|
blue_background: "blue_background";
|
|
508
517
|
brown: "brown";
|
|
509
518
|
brown_background: "brown_background";
|
|
510
|
-
default: "default";
|
|
511
519
|
gray: "gray";
|
|
512
520
|
gray_background: "gray_background";
|
|
513
521
|
green: "green";
|
|
@@ -546,6 +554,30 @@ export declare class DatabasesAPI extends BaseAPI<NotionDatabase, Database> {
|
|
|
546
554
|
}, import("zod/v4/core").$strip>], "type">, import("zod").ZodObject<{
|
|
547
555
|
type: import("zod").ZodLiteral<"emoji">;
|
|
548
556
|
emoji: import("zod").ZodString;
|
|
557
|
+
}, import("zod/v4/core").$strip>, import("zod").ZodObject<{
|
|
558
|
+
type: import("zod").ZodLiteral<"icon">;
|
|
559
|
+
icon: import("zod").ZodObject<{
|
|
560
|
+
name: import("zod").ZodString;
|
|
561
|
+
color: import("zod").ZodOptional<import("zod").ZodEnum<{
|
|
562
|
+
blue: "blue";
|
|
563
|
+
brown: "brown";
|
|
564
|
+
gray: "gray";
|
|
565
|
+
green: "green";
|
|
566
|
+
orange: "orange";
|
|
567
|
+
pink: "pink";
|
|
568
|
+
purple: "purple";
|
|
569
|
+
red: "red";
|
|
570
|
+
yellow: "yellow";
|
|
571
|
+
lightgray: "lightgray";
|
|
572
|
+
}>>;
|
|
573
|
+
}, import("zod/v4/core").$strip>;
|
|
574
|
+
}, import("zod/v4/core").$strip>, import("zod").ZodObject<{
|
|
575
|
+
type: import("zod").ZodLiteral<"custom_emoji">;
|
|
576
|
+
custom_emoji: import("zod").ZodObject<{
|
|
577
|
+
id: import("zod").ZodUUID;
|
|
578
|
+
name: import("zod").ZodOptional<import("zod").ZodString>;
|
|
579
|
+
url: import("zod").ZodOptional<import("zod").ZodURL>;
|
|
580
|
+
}, import("zod/v4/core").$strip>;
|
|
549
581
|
}, import("zod/v4/core").$strip>]>>;
|
|
550
582
|
cover: import("zod").ZodNullable<import("zod").ZodDiscriminatedUnion<[import("zod").ZodObject<{
|
|
551
583
|
type: import("zod").ZodLiteral<"file">;
|
|
@@ -580,10 +612,14 @@ export declare class DatabasesAPI extends BaseAPI<NotionDatabase, Database> {
|
|
|
580
612
|
}, import("zod/v4/core").$strip>, import("zod").ZodObject<{
|
|
581
613
|
type: import("zod").ZodLiteral<"block_id">;
|
|
582
614
|
block_id: import("zod").ZodUUID;
|
|
615
|
+
}, import("zod/v4/core").$strip>, import("zod").ZodObject<{
|
|
616
|
+
type: import("zod").ZodLiteral<"agent_id">;
|
|
617
|
+
agent_id: import("zod").ZodUUID;
|
|
583
618
|
}, import("zod/v4/core").$strip>], "type">;
|
|
584
619
|
url: import("zod").ZodURL;
|
|
585
620
|
in_trash: import("zod").ZodBoolean;
|
|
586
621
|
is_inline: import("zod").ZodBoolean;
|
|
622
|
+
is_locked: import("zod").ZodOptional<import("zod").ZodBoolean>;
|
|
587
623
|
public_url: import("zod").ZodNullable<import("zod").ZodURL>;
|
|
588
624
|
}, import("zod/v4/core").$strip>;
|
|
589
625
|
ModelClass: typeof Database;
|
|
@@ -3,10 +3,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
3
3
|
exports.DatabasesAPI = void 0;
|
|
4
4
|
const schemas_1 = require("../schemas");
|
|
5
5
|
const models_1 = require("../models");
|
|
6
|
+
const base_model_1 = require("../models/base.model");
|
|
6
7
|
const validation_1 = require("../validation");
|
|
7
8
|
const base_api_1 = require("./base.api");
|
|
8
9
|
/**
|
|
9
10
|
* Databases API client for working with Notion databases.
|
|
11
|
+
*
|
|
12
|
+
* @category Databases & Data Sources
|
|
10
13
|
*/
|
|
11
14
|
class DatabasesAPI extends base_api_1.BaseAPI {
|
|
12
15
|
constructor(client) {
|
|
@@ -60,7 +63,7 @@ class DatabasesAPI extends base_api_1.BaseAPI {
|
|
|
60
63
|
const parsed = listSchema.parse(response);
|
|
61
64
|
return {
|
|
62
65
|
object: 'list',
|
|
63
|
-
results: parsed.results.map((page) => new models_1.Page(page)),
|
|
66
|
+
results: parsed.results.map((page) => new models_1.Page(page, base_model_1.TRUSTED)),
|
|
64
67
|
next_cursor: parsed.next_cursor,
|
|
65
68
|
has_more: parsed.has_more,
|
|
66
69
|
type: 'page',
|
|
@@ -19,6 +19,8 @@ export interface InitiateFileUploadOptions {
|
|
|
19
19
|
export type FileData = Buffer | ArrayBuffer | Blob | ReadableStream;
|
|
20
20
|
/**
|
|
21
21
|
* FileUploads API client for uploading files to Notion.
|
|
22
|
+
*
|
|
23
|
+
* @category File Uploads
|
|
22
24
|
*/
|
|
23
25
|
export declare class FileUploadsAPI extends BaseAPI<NotionFileUpload, FileUpload> {
|
|
24
26
|
protected readonly client: NotionClient;
|
|
@@ -29,10 +31,10 @@ export declare class FileUploadsAPI extends BaseAPI<NotionFileUpload, FileUpload
|
|
|
29
31
|
created_time: import("zod").ZodUnion<readonly [import("zod").ZodISODateTime, import("zod").ZodISODate]>;
|
|
30
32
|
expiry_time: import("zod").ZodNullable<import("zod").ZodUnion<readonly [import("zod").ZodISODateTime, import("zod").ZodISODate]>>;
|
|
31
33
|
status: import("zod").ZodEnum<{
|
|
34
|
+
failed: "failed";
|
|
32
35
|
pending: "pending";
|
|
33
36
|
uploaded: "uploaded";
|
|
34
37
|
expired: "expired";
|
|
35
|
-
failed: "failed";
|
|
36
38
|
}>;
|
|
37
39
|
filename: import("zod").ZodString;
|
|
38
40
|
content_type: import("zod").ZodNullable<import("zod").ZodString>;
|
|
@@ -55,7 +57,8 @@ export declare class FileUploadsAPI extends BaseAPI<NotionFileUpload, FileUpload
|
|
|
55
57
|
initiate(options: InitiateFileUploadOptions): Promise<FileUpload>;
|
|
56
58
|
/**
|
|
57
59
|
* Upload file data to the upload URL.
|
|
58
|
-
* This
|
|
60
|
+
* This method sends a PUT request directly to the upload URL. It does not go
|
|
61
|
+
* through the Notion API.
|
|
59
62
|
*
|
|
60
63
|
* @param uploadUrl - The upload URL from initiate()
|
|
61
64
|
* @param fileData - The file data to upload
|
|
@@ -74,9 +77,9 @@ export declare class FileUploadsAPI extends BaseAPI<NotionFileUpload, FileUpload
|
|
|
74
77
|
*/
|
|
75
78
|
complete(completeUrl: string): Promise<FileUpload>;
|
|
76
79
|
/**
|
|
77
|
-
*
|
|
78
|
-
* URLs
|
|
79
|
-
* relative paths
|
|
80
|
+
* Extract the request path from a complete URL.
|
|
81
|
+
* Accept absolute URLs, for example `https://api.notion.com/v1/file_uploads/.../complete`.
|
|
82
|
+
* Accept relative paths too, for example `/v1/file_uploads/.../complete` or the path alone.
|
|
80
83
|
*/
|
|
81
84
|
private static toRequestPath;
|
|
82
85
|
/**
|
|
@@ -3,9 +3,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
3
3
|
exports.FileUploadsAPI = void 0;
|
|
4
4
|
const schemas_1 = require("../schemas");
|
|
5
5
|
const models_1 = require("../models");
|
|
6
|
+
const base_model_1 = require("../models/base.model");
|
|
6
7
|
const base_api_1 = require("./base.api");
|
|
7
8
|
/**
|
|
8
9
|
* FileUploads API client for uploading files to Notion.
|
|
10
|
+
*
|
|
11
|
+
* @category File Uploads
|
|
9
12
|
*/
|
|
10
13
|
class FileUploadsAPI extends base_api_1.BaseAPI {
|
|
11
14
|
constructor(client) {
|
|
@@ -31,11 +34,12 @@ class FileUploadsAPI extends base_api_1.BaseAPI {
|
|
|
31
34
|
body: options,
|
|
32
35
|
});
|
|
33
36
|
const parsed = schemas_1.fileUploadSchema.parse(response);
|
|
34
|
-
return new models_1.FileUpload(parsed);
|
|
37
|
+
return new models_1.FileUpload(parsed, base_model_1.TRUSTED);
|
|
35
38
|
}
|
|
36
39
|
/**
|
|
37
40
|
* Upload file data to the upload URL.
|
|
38
|
-
* This
|
|
41
|
+
* This method sends a PUT request directly to the upload URL. It does not go
|
|
42
|
+
* through the Notion API.
|
|
39
43
|
*
|
|
40
44
|
* @param uploadUrl - The upload URL from initiate()
|
|
41
45
|
* @param fileData - The file data to upload
|
|
@@ -70,12 +74,12 @@ class FileUploadsAPI extends base_api_1.BaseAPI {
|
|
|
70
74
|
body: {},
|
|
71
75
|
});
|
|
72
76
|
const parsed = schemas_1.fileUploadSchema.parse(response);
|
|
73
|
-
return new models_1.FileUpload(parsed);
|
|
77
|
+
return new models_1.FileUpload(parsed, base_model_1.TRUSTED);
|
|
74
78
|
}
|
|
75
79
|
/**
|
|
76
|
-
*
|
|
77
|
-
* URLs
|
|
78
|
-
* relative paths
|
|
80
|
+
* Extract the request path from a complete URL.
|
|
81
|
+
* Accept absolute URLs, for example `https://api.notion.com/v1/file_uploads/.../complete`.
|
|
82
|
+
* Accept relative paths too, for example `/v1/file_uploads/.../complete` or the path alone.
|
|
79
83
|
*/
|
|
80
84
|
static toRequestPath(completeUrl) {
|
|
81
85
|
let path;
|
|
@@ -136,7 +140,7 @@ class FileUploadsAPI extends base_api_1.BaseAPI {
|
|
|
136
140
|
path: `/file_uploads/${fileUploadId}`,
|
|
137
141
|
});
|
|
138
142
|
const parsed = schemas_1.fileUploadSchema.parse(response);
|
|
139
|
-
return new models_1.FileUpload(parsed);
|
|
143
|
+
return new models_1.FileUpload(parsed, base_model_1.TRUSTED);
|
|
140
144
|
}
|
|
141
145
|
}
|
|
142
146
|
exports.FileUploadsAPI = FileUploadsAPI;
|
package/dist/api/index.d.ts
CHANGED
|
@@ -1,8 +1,11 @@
|
|
|
1
|
+
export { AsyncTasksAPI } from './asyncTasks.api';
|
|
1
2
|
export { BlocksAPI } from './blocks.api';
|
|
2
3
|
export { CommentsAPI } from './comments.api';
|
|
4
|
+
export { CustomEmojisAPI } from './customEmojis.api';
|
|
3
5
|
export { DatabasesAPI } from './databases.api';
|
|
4
6
|
export { DataSourcesAPI } from './dataSources.api';
|
|
5
7
|
export { FileUploadsAPI } from './fileUploads.api';
|
|
6
8
|
export { PagesAPI } from './pages.api';
|
|
7
9
|
export { SearchAPI } from './search.api';
|
|
8
10
|
export { UsersAPI } from './users.api';
|
|
11
|
+
export { ViewsAPI } from './views.api';
|
package/dist/api/index.js
CHANGED
|
@@ -1,10 +1,14 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.UsersAPI = exports.SearchAPI = exports.PagesAPI = exports.FileUploadsAPI = exports.DataSourcesAPI = exports.DatabasesAPI = exports.CommentsAPI = exports.BlocksAPI = void 0;
|
|
3
|
+
exports.ViewsAPI = exports.UsersAPI = exports.SearchAPI = exports.PagesAPI = exports.FileUploadsAPI = exports.DataSourcesAPI = exports.DatabasesAPI = exports.CustomEmojisAPI = exports.CommentsAPI = exports.BlocksAPI = exports.AsyncTasksAPI = void 0;
|
|
4
|
+
var asyncTasks_api_1 = require("./asyncTasks.api");
|
|
5
|
+
Object.defineProperty(exports, "AsyncTasksAPI", { enumerable: true, get: function () { return asyncTasks_api_1.AsyncTasksAPI; } });
|
|
4
6
|
var blocks_api_1 = require("./blocks.api");
|
|
5
7
|
Object.defineProperty(exports, "BlocksAPI", { enumerable: true, get: function () { return blocks_api_1.BlocksAPI; } });
|
|
6
8
|
var comments_api_1 = require("./comments.api");
|
|
7
9
|
Object.defineProperty(exports, "CommentsAPI", { enumerable: true, get: function () { return comments_api_1.CommentsAPI; } });
|
|
10
|
+
var customEmojis_api_1 = require("./customEmojis.api");
|
|
11
|
+
Object.defineProperty(exports, "CustomEmojisAPI", { enumerable: true, get: function () { return customEmojis_api_1.CustomEmojisAPI; } });
|
|
8
12
|
var databases_api_1 = require("./databases.api");
|
|
9
13
|
Object.defineProperty(exports, "DatabasesAPI", { enumerable: true, get: function () { return databases_api_1.DatabasesAPI; } });
|
|
10
14
|
var dataSources_api_1 = require("./dataSources.api");
|
|
@@ -17,3 +21,5 @@ var search_api_1 = require("./search.api");
|
|
|
17
21
|
Object.defineProperty(exports, "SearchAPI", { enumerable: true, get: function () { return search_api_1.SearchAPI; } });
|
|
18
22
|
var users_api_1 = require("./users.api");
|
|
19
23
|
Object.defineProperty(exports, "UsersAPI", { enumerable: true, get: function () { return users_api_1.UsersAPI; } });
|
|
24
|
+
var views_api_1 = require("./views.api");
|
|
25
|
+
Object.defineProperty(exports, "ViewsAPI", { enumerable: true, get: function () { return views_api_1.ViewsAPI; } });
|