@satorijs/adapter-lark 3.9.0 → 3.9.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (89) hide show
  1. package/lib/index.cjs +1091 -27
  2. package/lib/internal.d.ts +2 -3
  3. package/lib/types/acs.d.ts +19 -19
  4. package/lib/types/admin.d.ts +58 -32
  5. package/lib/types/aily.d.ts +52 -52
  6. package/lib/types/apaas.d.ts +96 -96
  7. package/lib/types/api.d.ts +14 -1
  8. package/lib/types/application.d.ts +153 -69
  9. package/lib/types/approval.d.ts +186 -154
  10. package/lib/types/attendance.d.ts +395 -353
  11. package/lib/types/auth.d.ts +18 -18
  12. package/lib/types/authen.d.ts +24 -24
  13. package/lib/types/baike.d.ts +42 -42
  14. package/lib/types/bitable.d.ts +276 -192
  15. package/lib/types/calendar.d.ts +144 -144
  16. package/lib/types/cardkit.d.ts +8 -8
  17. package/lib/types/contact.d.ts +209 -137
  18. package/lib/types/corehr.d.ts +761 -613
  19. package/lib/types/document_ai.d.ts +68 -68
  20. package/lib/types/docx.d.ts +103 -95
  21. package/lib/types/drive.d.ts +237 -229
  22. package/lib/types/ehr.d.ts +26 -2
  23. package/lib/types/helpdesk.d.ts +156 -148
  24. package/lib/types/hire.d.ts +954 -510
  25. package/lib/types/im.d.ts +446 -446
  26. package/lib/types/index.d.ts +72 -30
  27. package/lib/types/lingo.d.ts +28 -28
  28. package/lib/types/mail.d.ts +192 -192
  29. package/lib/types/minutes.d.ts +4 -4
  30. package/lib/types/okr.d.ts +86 -58
  31. package/lib/types/passport.d.ts +13 -5
  32. package/lib/types/payroll.d.ts +13 -5
  33. package/lib/types/performance.d.ts +85 -79
  34. package/lib/types/personal_settings.d.ts +12 -12
  35. package/lib/types/report.d.ts +11 -5
  36. package/lib/types/search.d.ts +48 -24
  37. package/lib/types/sheets.d.ts +64 -64
  38. package/lib/types/speech_to_text.d.ts +4 -4
  39. package/lib/types/task.d.ts +191 -185
  40. package/lib/types/translation.d.ts +4 -4
  41. package/lib/types/vc.d.ts +335 -155
  42. package/lib/types/wiki.d.ts +48 -48
  43. package/package.json +1 -1
  44. package/src/internal.ts +3 -4
  45. package/src/types/acs.ts +24 -24
  46. package/src/types/admin.ts +69 -39
  47. package/src/types/aily.ts +61 -61
  48. package/src/types/apaas.ts +113 -113
  49. package/src/types/application.ts +177 -83
  50. package/src/types/approval.ts +210 -174
  51. package/src/types/attendance.ts +466 -421
  52. package/src/types/auth.ts +20 -20
  53. package/src/types/authen.ts +28 -28
  54. package/src/types/baike.ts +55 -55
  55. package/src/types/bitable.ts +321 -235
  56. package/src/types/calendar.ts +167 -167
  57. package/src/types/cardkit.ts +10 -10
  58. package/src/types/contact.ts +251 -169
  59. package/src/types/corehr.ts +905 -736
  60. package/src/types/document_ai.ts +85 -85
  61. package/src/types/docx.ts +117 -108
  62. package/src/types/drive.ts +299 -290
  63. package/src/types/ehr.ts +28 -2
  64. package/src/types/helpdesk.ts +182 -173
  65. package/src/types/hire.ts +1081 -591
  66. package/src/types/im.ts +521 -521
  67. package/src/types/index.ts +73 -30
  68. package/src/types/lingo.ts +36 -36
  69. package/src/types/mail.ts +215 -215
  70. package/src/types/minutes.ts +5 -5
  71. package/src/types/okr.ts +98 -66
  72. package/src/types/passport.ts +15 -6
  73. package/src/types/payroll.ts +15 -6
  74. package/src/types/performance.ts +98 -91
  75. package/src/types/personal_settings.ts +15 -15
  76. package/src/types/report.ts +13 -6
  77. package/src/types/search.ts +57 -29
  78. package/src/types/sheets.ts +80 -80
  79. package/src/types/speech_to_text.ts +5 -5
  80. package/src/types/task.ts +238 -231
  81. package/src/types/translation.ts +5 -5
  82. package/src/types/vc.ts +386 -186
  83. package/src/types/wiki.ts +59 -59
  84. package/src/utils.ts +11 -6
  85. package/lib/index.cjs.map +0 -6
  86. package/lib/types/guild.d.ts +0 -59
  87. package/lib/types/message/asset.d.ts +0 -40
  88. package/lib/types/user.d.ts +0 -78
  89. package/lib/types/utils.d.ts +0 -9
@@ -6,7 +6,7 @@ declare module '../internal' {
6
6
  * 获取文件夹中的文件清单
7
7
  * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/list
8
8
  */
9
- listDriveV1File(query?: ListDriveV1FileQuery): Paginated<File, 'files'>;
9
+ listDriveV1File(query?: ListDriveV1FileQuery): Promise<ListDriveV1FileResponse> & AsyncIterableIterator<File>;
10
10
  /**
11
11
  * 新建文件夹
12
12
  * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/create_folder
@@ -309,16 +309,34 @@ export interface ListDriveV1FileQuery extends Pagination {
309
309
  /** 此次调用中使用的用户ID的类型 */
310
310
  user_id_type?: 'user_id' | 'union_id' | 'open_id';
311
311
  }
312
+ export interface ListDriveV1FileResponse {
313
+ /** 文档详细信息 */
314
+ files?: File[];
315
+ /** 下一页分页参数 */
316
+ next_page_token?: string;
317
+ /** 是否有下一页 */
318
+ has_more?: boolean;
319
+ }
312
320
  export interface CreateFolderDriveV1FileRequest {
313
321
  /** 文件夹名称 */
314
322
  name: string;
315
323
  /** 父文件夹token */
316
324
  folder_token: string;
317
325
  }
326
+ export interface CreateFolderDriveV1FileResponse {
327
+ /** 新创建的文件夹 Token */
328
+ token?: string;
329
+ /** 创建文件夹的访问 URL */
330
+ url?: string;
331
+ }
318
332
  export interface TaskCheckDriveV1FileQuery {
319
333
  /** 文件相关异步任务id */
320
334
  task_id: string;
321
335
  }
336
+ export interface TaskCheckDriveV1FileResponse {
337
+ /** 异步任务的执行状态 */
338
+ status?: string;
339
+ }
322
340
  export interface BatchQueryDriveV1MetaRequest {
323
341
  /** 请求文档, 一次不超过200个 */
324
342
  request_docs: RequestDoc[];
@@ -329,10 +347,22 @@ export interface BatchQueryDriveV1MetaQuery {
329
347
  /** 此次调用中使用的用户ID的类型 */
330
348
  user_id_type?: 'user_id' | 'union_id' | 'open_id';
331
349
  }
350
+ export interface BatchQueryDriveV1MetaResponse {
351
+ metas: Meta[];
352
+ failed_list?: MetaFailed[];
353
+ }
332
354
  export interface GetDriveV1FileStatisticsQuery {
333
355
  /** 文档类型 */
334
356
  file_type: 'doc' | 'sheet' | 'mindnote' | 'bitable' | 'wiki' | 'file' | 'docx';
335
357
  }
358
+ export interface GetDriveV1FileStatisticsResponse {
359
+ /** 文档token */
360
+ file_token?: string;
361
+ /** 文档类型 */
362
+ file_type?: string;
363
+ /** 文档统计信息 */
364
+ statistics?: FileStatistics;
365
+ }
336
366
  export interface ListDriveV1FileViewRecordQuery extends Pagination {
337
367
  /** 文档类型 */
338
368
  file_type: 'doc' | 'docx' | 'sheet' | 'bitable' | 'mindnote' | 'wiki' | 'file';
@@ -353,16 +383,28 @@ export interface CopyDriveV1FileQuery {
353
383
  /** 此次调用中使用的用户ID的类型 */
354
384
  user_id_type?: 'user_id' | 'union_id' | 'open_id';
355
385
  }
386
+ export interface CopyDriveV1FileResponse {
387
+ /** 复制后的文件资源 */
388
+ file?: File;
389
+ }
356
390
  export interface MoveDriveV1FileRequest {
357
391
  /** 文件类型,如果该值为空或者与文件实际类型不匹配,接口会返回失败。 */
358
392
  type?: 'file' | 'docx' | 'bitable' | 'doc' | 'sheet' | 'mindnote' | 'folder' | 'slides';
359
393
  /** 目标文件夹token */
360
394
  folder_token?: string;
361
395
  }
396
+ export interface MoveDriveV1FileResponse {
397
+ /** 异步任务id,移动文件夹时返回 */
398
+ task_id?: string;
399
+ }
362
400
  export interface DeleteDriveV1FileQuery {
363
401
  /** 被删除文件的类型 */
364
402
  type: 'file' | 'docx' | 'bitable' | 'folder' | 'doc' | 'sheet' | 'mindnote' | 'shortcut' | 'slides';
365
403
  }
404
+ export interface DeleteDriveV1FileResponse {
405
+ /** 异步任务id,删除文件夹时返回 */
406
+ task_id?: string;
407
+ }
366
408
  export interface CreateShortcutDriveV1FileRequest {
367
409
  /** 创建快捷方式的目标父文件夹 token */
368
410
  parent_token: string;
@@ -373,6 +415,10 @@ export interface CreateShortcutDriveV1FileQuery {
373
415
  /** 此次调用中使用的用户ID的类型 */
374
416
  user_id_type?: 'user_id' | 'union_id' | 'open_id';
375
417
  }
418
+ export interface CreateShortcutDriveV1FileResponse {
419
+ /** 返回创建成功的shortcut节点 */
420
+ succ_shortcut_node?: File;
421
+ }
376
422
  export interface UploadAllDriveV1FileForm {
377
423
  /** 文件名。 */
378
424
  file_name: string;
@@ -387,6 +433,9 @@ export interface UploadAllDriveV1FileForm {
387
433
  /** 文件二进制内容。 */
388
434
  file: Blob;
389
435
  }
436
+ export interface UploadAllDriveV1FileResponse {
437
+ file_token?: string;
438
+ }
390
439
  export interface UploadPrepareDriveV1FileRequest {
391
440
  /** 文件名 */
392
441
  file_name: string;
@@ -397,6 +446,14 @@ export interface UploadPrepareDriveV1FileRequest {
397
446
  /** 文件大小 */
398
447
  size: number;
399
448
  }
449
+ export interface UploadPrepareDriveV1FileResponse {
450
+ /** 分片上传事务ID */
451
+ upload_id?: string;
452
+ /** 分片大小策略 */
453
+ block_size?: number;
454
+ /** 分片数量 */
455
+ block_num?: number;
456
+ }
400
457
  export interface UploadPartDriveV1FileForm {
401
458
  /** 分片上传事务ID。 */
402
459
  upload_id: string;
@@ -415,6 +472,9 @@ export interface UploadFinishDriveV1FileRequest {
415
472
  /** 分片数量 */
416
473
  block_num: number;
417
474
  }
475
+ export interface UploadFinishDriveV1FileResponse {
476
+ file_token?: string;
477
+ }
418
478
  export interface CreateDriveV1ImportTaskRequest {
419
479
  /** 导入文件格式后缀 */
420
480
  file_extension: string;
@@ -427,6 +487,14 @@ export interface CreateDriveV1ImportTaskRequest {
427
487
  /** 挂载点 */
428
488
  point: ImportTaskMountPoint;
429
489
  }
490
+ export interface CreateDriveV1ImportTaskResponse {
491
+ /** 导入任务ID */
492
+ ticket?: string;
493
+ }
494
+ export interface GetDriveV1ImportTaskResponse {
495
+ /** 导入任务 */
496
+ result?: ImportTask;
497
+ }
430
498
  export interface CreateDriveV1ExportTaskRequest {
431
499
  /** 导出文件扩展名 */
432
500
  file_extension: 'docx' | 'pdf' | 'xlsx' | 'csv';
@@ -437,10 +505,18 @@ export interface CreateDriveV1ExportTaskRequest {
437
505
  /** 导出子表 ID,仅当将 sheet/bitable 导出为 csv 时使用 */
438
506
  sub_id?: string;
439
507
  }
508
+ export interface CreateDriveV1ExportTaskResponse {
509
+ /** 导出任务ID */
510
+ ticket?: string;
511
+ }
440
512
  export interface GetDriveV1ExportTaskQuery {
441
513
  /** 导出文档的 token */
442
514
  token: string;
443
515
  }
516
+ export interface GetDriveV1ExportTaskResponse {
517
+ /** 导出结果 */
518
+ result?: ExportTask;
519
+ }
444
520
  export interface UploadAllDriveV1MediaForm {
445
521
  /** 文件名。 */
446
522
  file_name: string;
@@ -457,6 +533,9 @@ export interface UploadAllDriveV1MediaForm {
457
533
  /** 文件二进制内容。 */
458
534
  file: Blob;
459
535
  }
536
+ export interface UploadAllDriveV1MediaResponse {
537
+ file_token?: string;
538
+ }
460
539
  export interface UploadPrepareDriveV1MediaRequest {
461
540
  /** 文件名 */
462
541
  file_name: string;
@@ -469,6 +548,14 @@ export interface UploadPrepareDriveV1MediaRequest {
469
548
  /** 扩展信息(可选) */
470
549
  extra?: string;
471
550
  }
551
+ export interface UploadPrepareDriveV1MediaResponse {
552
+ /** 分片上传事务ID */
553
+ upload_id?: string;
554
+ /** 分片大小策略 */
555
+ block_size?: number;
556
+ /** 分片数量 */
557
+ block_num?: number;
558
+ }
472
559
  export interface UploadPartDriveV1MediaForm {
473
560
  /** 分片上传事务ID。 */
474
561
  upload_id: string;
@@ -487,6 +574,9 @@ export interface UploadFinishDriveV1MediaRequest {
487
574
  /** 分片数量 */
488
575
  block_num: number;
489
576
  }
577
+ export interface UploadFinishDriveV1MediaResponse {
578
+ file_token?: string;
579
+ }
490
580
  export interface DownloadDriveV1MediaQuery {
491
581
  /** 扩展信息 */
492
582
  extra?: string;
@@ -497,6 +587,10 @@ export interface BatchGetTmpDownloadUrlDriveV1MediaQuery {
497
587
  /** 拓展信息(可选) */
498
588
  extra?: string;
499
589
  }
590
+ export interface BatchGetTmpDownloadUrlDriveV1MediaResponse {
591
+ /** 临时下载列表 */
592
+ tmp_download_urls?: TmpDownloadUrl[];
593
+ }
500
594
  export interface CreateDriveV1FileVersionRequest {
501
595
  /** 版本文档标题,最大长度 1024 个Unicode 码点。通常情况下,一个英文或中文字符对应一个码点,但是某些特殊符号可能会对应多个码点。例如,家庭组合「👨‍👩‍👧」这个表情符号对应5个码点。 */
502
596
  name?: string;
@@ -507,6 +601,28 @@ export interface CreateDriveV1FileVersionQuery {
507
601
  /** 此次调用中使用的用户ID的类型 */
508
602
  user_id_type?: 'user_id' | 'union_id' | 'open_id';
509
603
  }
604
+ export interface CreateDriveV1FileVersionResponse {
605
+ /** 版本文档标题,最大长度 1024 个Unicode 码点。通常情况下,一个英文或中文字符对应一个码点,但是某些特殊符号可能会对应多个码点。例如,家庭组合「👨‍👩‍👧」这个表情符号对应5个码点。 */
606
+ name?: string;
607
+ /** 版本文档版本号 */
608
+ version?: string;
609
+ /** 源文档token */
610
+ parent_token?: string;
611
+ /** 版本文档所有者id */
612
+ owner_id?: string;
613
+ /** 版本文档创建者id */
614
+ creator_id?: string;
615
+ /** 版本文档创建时间 */
616
+ create_time?: string;
617
+ /** 版本文档更新时间 */
618
+ update_time?: string;
619
+ /** 版本文档状态 */
620
+ status?: '0' | '1' | '2';
621
+ /** 版本文档类型 */
622
+ obj_type?: 'docx' | 'sheet';
623
+ /** 源文档类型 */
624
+ parent_type?: 'docx' | 'sheet';
625
+ }
510
626
  export interface ListDriveV1FileVersionQuery extends Pagination {
511
627
  /** 原文档类型 */
512
628
  obj_type: 'docx' | 'sheet';
@@ -519,6 +635,28 @@ export interface GetDriveV1FileVersionQuery {
519
635
  /** 用户ID类型 */
520
636
  user_id_type?: 'open_id' | 'union_id' | 'user_id';
521
637
  }
638
+ export interface GetDriveV1FileVersionResponse {
639
+ /** 版本文档标题,最大长度 1024 个Unicode 码点。通常情况下,一个英文或中文字符对应一个码点,但是某些特殊符号可能会对应多个码点。例如,家庭组合「👨‍👩‍👧」这个表情符号对应5个码点。 */
640
+ name?: string;
641
+ /** 版本文档版本号 */
642
+ version?: string;
643
+ /** 源文档token */
644
+ parent_token?: string;
645
+ /** 版本文档所有者id */
646
+ owner_id?: string;
647
+ /** 版本文档创建者id */
648
+ creator_id?: string;
649
+ /** 版本文档创建时间 */
650
+ create_time?: string;
651
+ /** 版本文档更新时间 */
652
+ update_time?: string;
653
+ /** 版本文档状态 */
654
+ status?: '0' | '1' | '2';
655
+ /** 版本文档类型 */
656
+ obj_type?: 'docx' | 'sheet';
657
+ /** 源文档类型 */
658
+ parent_type?: 'docx' | 'sheet';
659
+ }
522
660
  export interface DeleteDriveV1FileVersionQuery {
523
661
  /** 文档类型 */
524
662
  obj_type: 'docx' | 'sheet';
@@ -543,6 +681,10 @@ export interface GetSubscribeDriveV1FileQuery {
543
681
  /** 事件类型 */
544
682
  event_type?: string;
545
683
  }
684
+ export interface GetSubscribeDriveV1FileResponse {
685
+ /** 是否有订阅,取值 true 表示已订阅;false 表示未订阅 */
686
+ is_subscribe?: boolean;
687
+ }
546
688
  export interface DeleteSubscribeDriveV1FileQuery {
547
689
  /** 文档类型 */
548
690
  file_type: 'doc' | 'docx' | 'sheet' | 'bitable' | 'file' | 'folder';
@@ -559,6 +701,10 @@ export interface BatchCreateDriveV1PermissionMemberQuery {
559
701
  /** 添加权限后是否通知对方 */
560
702
  need_notification?: boolean;
561
703
  }
704
+ export interface BatchCreateDriveV1PermissionMemberResponse {
705
+ /** 协作者列表 */
706
+ members?: BaseMember[];
707
+ }
562
708
  export interface TransferOwnerDriveV1PermissionMemberRequest {
563
709
  /** 文档拥有者的ID类型 */
564
710
  member_type: 'email' | 'openid' | 'userid';
@@ -583,6 +729,10 @@ export interface AuthDriveV1PermissionMemberQuery {
583
729
  /** 需要判断的权限 */
584
730
  action: 'view' | 'edit' | 'share' | 'comment' | 'export' | 'copy' | 'print' | 'manage_public';
585
731
  }
732
+ export interface AuthDriveV1PermissionMemberResponse {
733
+ /** 是否有权限 */
734
+ auth_result: boolean;
735
+ }
586
736
  export interface ListDriveV1PermissionMemberQuery {
587
737
  /** 文件类型,需要与文件的 token 相匹配 */
588
738
  type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'mindnote' | 'minutes' | 'slides';
@@ -591,6 +741,10 @@ export interface ListDriveV1PermissionMemberQuery {
591
741
  /** 协作者的权限角色类型 */
592
742
  perm_type?: 'container' | 'single_page';
593
743
  }
744
+ export interface ListDriveV1PermissionMemberResponse {
745
+ /** 返回的列表数据 */
746
+ items?: Member[];
747
+ }
594
748
  export interface CreateDriveV1PermissionMemberRequest {
595
749
  /** 协作者ID类型 */
596
750
  member_type: 'email' | 'openid' | 'unionid' | 'openchat' | 'opendepartmentid' | 'userid' | 'groupid' | 'wikispaceid';
@@ -609,6 +763,10 @@ export interface CreateDriveV1PermissionMemberQuery {
609
763
  /** 添加权限后是否通知对方 */
610
764
  need_notification?: boolean;
611
765
  }
766
+ export interface CreateDriveV1PermissionMemberResponse {
767
+ /** 本次添加权限的用户信息 */
768
+ member?: BaseMember;
769
+ }
612
770
  export interface UpdateDriveV1PermissionMemberRequest {
613
771
  /** 协作者ID类型 */
614
772
  member_type: 'email' | 'openid' | 'unionid' | 'openchat' | 'opendepartmentid' | 'userid' | 'groupid' | 'wikispaceid';
@@ -625,6 +783,10 @@ export interface UpdateDriveV1PermissionMemberQuery {
625
783
  /** 文件类型,放于query参数中,如:`?type=doc` */
626
784
  type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'mindnote' | 'minutes' | 'slides';
627
785
  }
786
+ export interface UpdateDriveV1PermissionMemberResponse {
787
+ /** 本次更新权限的用户信息 */
788
+ member?: BaseMember;
789
+ }
628
790
  export interface DeleteDriveV1PermissionMemberRequest {
629
791
  /** 协作者类型 */
630
792
  type?: 'user' | 'chat' | 'department' | 'group' | 'wiki_space_member' | 'wiki_space_viewer' | 'wiki_space_editor';
@@ -641,10 +803,18 @@ export interface CreateDriveV1PermissionPublicPasswordQuery {
641
803
  /** 文件类型,需要与文件的 token 相匹配 */
642
804
  type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'mindnote' | 'minutes' | 'slides';
643
805
  }
806
+ export interface CreateDriveV1PermissionPublicPasswordResponse {
807
+ /** 密码 */
808
+ password?: string;
809
+ }
644
810
  export interface UpdateDriveV1PermissionPublicPasswordQuery {
645
811
  /** 文件类型,需要与文件的 token 相匹配 */
646
812
  type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'mindnote' | 'minutes' | 'slides';
647
813
  }
814
+ export interface UpdateDriveV1PermissionPublicPasswordResponse {
815
+ /** 密码 */
816
+ password?: string;
817
+ }
648
818
  export interface DeleteDriveV1PermissionPublicPasswordQuery {
649
819
  /** 文件类型,需要与文件的 token 相匹配 */
650
820
  type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'mindnote' | 'minutes' | 'slides';
@@ -653,6 +823,10 @@ export interface GetDriveV1PermissionPublicQuery {
653
823
  /** 文件类型,放于query参数中,如:`?type=doc` */
654
824
  type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'mindnote' | 'minutes' | 'slides';
655
825
  }
826
+ export interface GetDriveV1PermissionPublicResponse {
827
+ /** 返回的文档公共设置 */
828
+ permission_public?: PermissionPublic;
829
+ }
656
830
  export interface PatchDriveV1PermissionPublicRequest {
657
831
  /** 允许内容被分享到组织外 */
658
832
  external_access?: boolean;
@@ -671,10 +845,18 @@ export interface PatchDriveV1PermissionPublicQuery {
671
845
  /** 文件类型,放于query参数中,如:`?type=doc` */
672
846
  type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'mindnote' | 'minutes' | 'slides';
673
847
  }
848
+ export interface PatchDriveV1PermissionPublicResponse {
849
+ /** 本次更新后的文档公共设置 */
850
+ permission_public?: PermissionPublic;
851
+ }
674
852
  export interface GetDriveV2PermissionPublicQuery {
675
853
  /** 文件类型,需要与文件的 token 相匹配 */
676
854
  type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'mindnote' | 'minutes' | 'slides';
677
855
  }
856
+ export interface GetDriveV2PermissionPublicResponse {
857
+ /** 返回的文档公共设置 */
858
+ permission_public?: PermissionPublic;
859
+ }
678
860
  export interface PatchDriveV2PermissionPublicRequest {
679
861
  /** 允许内容被分享到组织外 */
680
862
  external_access_entity?: 'open' | 'closed' | 'allow_share_partner_tenant';
@@ -695,6 +877,10 @@ export interface PatchDriveV2PermissionPublicQuery {
695
877
  /** 文件类型,需要与文件的 token 相匹配 */
696
878
  type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'mindnote' | 'minutes' | 'slides';
697
879
  }
880
+ export interface PatchDriveV2PermissionPublicResponse {
881
+ /** 本次更新后文档公共设置 */
882
+ permission_public?: PermissionPublic;
883
+ }
698
884
  export interface ListDriveV1FileCommentQuery extends Pagination {
699
885
  /** 文档类型 */
700
886
  file_type: 'doc' | 'sheet' | 'file' | 'docx';
@@ -715,6 +901,10 @@ export interface BatchQueryDriveV1FileCommentQuery {
715
901
  /** 此次调用中使用的用户ID的类型 */
716
902
  user_id_type?: 'user_id' | 'union_id' | 'open_id';
717
903
  }
904
+ export interface BatchQueryDriveV1FileCommentResponse {
905
+ /** 评论的相关信息、回复的信息、回复分页的信息 */
906
+ items?: FileComment[];
907
+ }
718
908
  export interface PatchDriveV1FileCommentRequest {
719
909
  /** 评论解决标志 */
720
910
  is_solved: boolean;
@@ -733,234 +923,6 @@ export interface CreateDriveV1FileCommentQuery {
733
923
  /** 此次调用中使用的用户 ID 的类型 */
734
924
  user_id_type?: 'user_id' | 'union_id' | 'open_id';
735
925
  }
736
- export interface GetDriveV1FileCommentQuery {
737
- /** 文档类型 */
738
- file_type: 'doc' | 'sheet' | 'file' | 'docx';
739
- /** 此次调用中使用的用户 ID 的类型 */
740
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
741
- }
742
- export interface ListDriveV1FileCommentReplyQuery extends Pagination {
743
- /** 文档类型 */
744
- file_type: 'doc' | 'sheet' | 'file' | 'docx';
745
- /** 此次调用中使用的用户ID的类型 */
746
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
747
- }
748
- export interface UpdateDriveV1FileCommentReplyRequest {
749
- /** 回复内容 */
750
- content: ReplyContent;
751
- }
752
- export interface UpdateDriveV1FileCommentReplyQuery {
753
- /** 文档类型 */
754
- file_type: 'doc' | 'sheet' | 'file' | 'docx';
755
- /** 此次调用中使用的用户ID的类型 */
756
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
757
- }
758
- export interface DeleteDriveV1FileCommentReplyQuery {
759
- /** 文档类型 */
760
- file_type: 'doc' | 'sheet' | 'file' | 'docx';
761
- }
762
- export interface GetDriveV1FileSubscriptionRequest {
763
- /** 文档类型 */
764
- file_type: 'doc' | 'docx' | 'wiki';
765
- }
766
- export interface CreateDriveV1FileSubscriptionRequest {
767
- /** 订阅关系ID */
768
- subscription_id?: string;
769
- /** 订阅类型 */
770
- subscription_type: 'comment_update';
771
- /** 是否订阅 */
772
- is_subcribe?: boolean;
773
- /** 文档类型 */
774
- file_type: 'doc' | 'docx' | 'wiki';
775
- }
776
- export interface PatchDriveV1FileSubscriptionRequest {
777
- /** 是否订阅 */
778
- is_subscribe: boolean;
779
- /** 文档类型 */
780
- file_type: 'doc' | 'docx' | 'wiki';
781
- }
782
- export interface CreateFolderDriveV1FileResponse {
783
- /** 新创建的文件夹 Token */
784
- token?: string;
785
- /** 创建文件夹的访问 URL */
786
- url?: string;
787
- }
788
- export interface TaskCheckDriveV1FileResponse {
789
- /** 异步任务的执行状态 */
790
- status?: string;
791
- }
792
- export interface BatchQueryDriveV1MetaResponse {
793
- metas: Meta[];
794
- failed_list?: MetaFailed[];
795
- }
796
- export interface GetDriveV1FileStatisticsResponse {
797
- /** 文档token */
798
- file_token?: string;
799
- /** 文档类型 */
800
- file_type?: string;
801
- /** 文档统计信息 */
802
- statistics?: FileStatistics;
803
- }
804
- export interface CopyDriveV1FileResponse {
805
- /** 复制后的文件资源 */
806
- file?: File;
807
- }
808
- export interface MoveDriveV1FileResponse {
809
- /** 异步任务id,移动文件夹时返回 */
810
- task_id?: string;
811
- }
812
- export interface DeleteDriveV1FileResponse {
813
- /** 异步任务id,删除文件夹时返回 */
814
- task_id?: string;
815
- }
816
- export interface CreateShortcutDriveV1FileResponse {
817
- /** 返回创建成功的shortcut节点 */
818
- succ_shortcut_node?: File;
819
- }
820
- export interface UploadAllDriveV1FileResponse {
821
- file_token?: string;
822
- }
823
- export interface UploadPrepareDriveV1FileResponse {
824
- /** 分片上传事务ID */
825
- upload_id?: string;
826
- /** 分片大小策略 */
827
- block_size?: number;
828
- /** 分片数量 */
829
- block_num?: number;
830
- }
831
- export interface UploadFinishDriveV1FileResponse {
832
- file_token?: string;
833
- }
834
- export interface CreateDriveV1ImportTaskResponse {
835
- /** 导入任务ID */
836
- ticket?: string;
837
- }
838
- export interface GetDriveV1ImportTaskResponse {
839
- /** 导入任务 */
840
- result?: ImportTask;
841
- }
842
- export interface CreateDriveV1ExportTaskResponse {
843
- /** 导出任务ID */
844
- ticket?: string;
845
- }
846
- export interface GetDriveV1ExportTaskResponse {
847
- /** 导出结果 */
848
- result?: ExportTask;
849
- }
850
- export interface UploadAllDriveV1MediaResponse {
851
- file_token?: string;
852
- }
853
- export interface UploadPrepareDriveV1MediaResponse {
854
- /** 分片上传事务ID */
855
- upload_id?: string;
856
- /** 分片大小策略 */
857
- block_size?: number;
858
- /** 分片数量 */
859
- block_num?: number;
860
- }
861
- export interface UploadFinishDriveV1MediaResponse {
862
- file_token?: string;
863
- }
864
- export interface BatchGetTmpDownloadUrlDriveV1MediaResponse {
865
- /** 临时下载列表 */
866
- tmp_download_urls?: TmpDownloadUrl[];
867
- }
868
- export interface CreateDriveV1FileVersionResponse {
869
- /** 版本文档标题,最大长度 1024 个Unicode 码点。通常情况下,一个英文或中文字符对应一个码点,但是某些特殊符号可能会对应多个码点。例如,家庭组合「👨‍👩‍👧」这个表情符号对应5个码点。 */
870
- name?: string;
871
- /** 版本文档版本号 */
872
- version?: string;
873
- /** 源文档token */
874
- parent_token?: string;
875
- /** 版本文档所有者id */
876
- owner_id?: string;
877
- /** 版本文档创建者id */
878
- creator_id?: string;
879
- /** 版本文档创建时间 */
880
- create_time?: string;
881
- /** 版本文档更新时间 */
882
- update_time?: string;
883
- /** 版本文档状态 */
884
- status?: '0' | '1' | '2';
885
- /** 版本文档类型 */
886
- obj_type?: 'docx' | 'sheet';
887
- /** 源文档类型 */
888
- parent_type?: 'docx' | 'sheet';
889
- }
890
- export interface GetDriveV1FileVersionResponse {
891
- /** 版本文档标题,最大长度 1024 个Unicode 码点。通常情况下,一个英文或中文字符对应一个码点,但是某些特殊符号可能会对应多个码点。例如,家庭组合「👨‍👩‍👧」这个表情符号对应5个码点。 */
892
- name?: string;
893
- /** 版本文档版本号 */
894
- version?: string;
895
- /** 源文档token */
896
- parent_token?: string;
897
- /** 版本文档所有者id */
898
- owner_id?: string;
899
- /** 版本文档创建者id */
900
- creator_id?: string;
901
- /** 版本文档创建时间 */
902
- create_time?: string;
903
- /** 版本文档更新时间 */
904
- update_time?: string;
905
- /** 版本文档状态 */
906
- status?: '0' | '1' | '2';
907
- /** 版本文档类型 */
908
- obj_type?: 'docx' | 'sheet';
909
- /** 源文档类型 */
910
- parent_type?: 'docx' | 'sheet';
911
- }
912
- export interface GetSubscribeDriveV1FileResponse {
913
- /** 是否有订阅,取值 true 表示已订阅;false 表示未订阅 */
914
- is_subscribe?: boolean;
915
- }
916
- export interface BatchCreateDriveV1PermissionMemberResponse {
917
- /** 协作者列表 */
918
- members?: BaseMember[];
919
- }
920
- export interface AuthDriveV1PermissionMemberResponse {
921
- /** 是否有权限 */
922
- auth_result: boolean;
923
- }
924
- export interface ListDriveV1PermissionMemberResponse {
925
- /** 返回的列表数据 */
926
- items?: Member[];
927
- }
928
- export interface CreateDriveV1PermissionMemberResponse {
929
- /** 本次添加权限的用户信息 */
930
- member?: BaseMember;
931
- }
932
- export interface UpdateDriveV1PermissionMemberResponse {
933
- /** 本次更新权限的用户信息 */
934
- member?: BaseMember;
935
- }
936
- export interface CreateDriveV1PermissionPublicPasswordResponse {
937
- /** 密码 */
938
- password?: string;
939
- }
940
- export interface UpdateDriveV1PermissionPublicPasswordResponse {
941
- /** 密码 */
942
- password?: string;
943
- }
944
- export interface GetDriveV1PermissionPublicResponse {
945
- /** 返回的文档公共设置 */
946
- permission_public?: PermissionPublic;
947
- }
948
- export interface PatchDriveV1PermissionPublicResponse {
949
- /** 本次更新后的文档公共设置 */
950
- permission_public?: PermissionPublic;
951
- }
952
- export interface GetDriveV2PermissionPublicResponse {
953
- /** 返回的文档公共设置 */
954
- permission_public?: PermissionPublic;
955
- }
956
- export interface PatchDriveV2PermissionPublicResponse {
957
- /** 本次更新后文档公共设置 */
958
- permission_public?: PermissionPublic;
959
- }
960
- export interface BatchQueryDriveV1FileCommentResponse {
961
- /** 评论的相关信息、回复的信息、回复分页的信息 */
962
- items?: FileComment[];
963
- }
964
926
  export interface CreateDriveV1FileCommentResponse {
965
927
  /** 评论 ID */
966
928
  comment_id?: string;
@@ -987,6 +949,12 @@ export interface CreateDriveV1FileCommentResponse {
987
949
  /** 评论里的回复列表 */
988
950
  reply_list?: ReplyList;
989
951
  }
952
+ export interface GetDriveV1FileCommentQuery {
953
+ /** 文档类型 */
954
+ file_type: 'doc' | 'sheet' | 'file' | 'docx';
955
+ /** 此次调用中使用的用户 ID 的类型 */
956
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
957
+ }
990
958
  export interface GetDriveV1FileCommentResponse {
991
959
  /** 评论 ID */
992
960
  comment_id?: string;
@@ -1013,6 +981,30 @@ export interface GetDriveV1FileCommentResponse {
1013
981
  /** 评论里的回复列表 */
1014
982
  reply_list?: ReplyList;
1015
983
  }
984
+ export interface ListDriveV1FileCommentReplyQuery extends Pagination {
985
+ /** 文档类型 */
986
+ file_type: 'doc' | 'sheet' | 'file' | 'docx';
987
+ /** 此次调用中使用的用户ID的类型 */
988
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
989
+ }
990
+ export interface UpdateDriveV1FileCommentReplyRequest {
991
+ /** 回复内容 */
992
+ content: ReplyContent;
993
+ }
994
+ export interface UpdateDriveV1FileCommentReplyQuery {
995
+ /** 文档类型 */
996
+ file_type: 'doc' | 'sheet' | 'file' | 'docx';
997
+ /** 此次调用中使用的用户ID的类型 */
998
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
999
+ }
1000
+ export interface DeleteDriveV1FileCommentReplyQuery {
1001
+ /** 文档类型 */
1002
+ file_type: 'doc' | 'sheet' | 'file' | 'docx';
1003
+ }
1004
+ export interface GetDriveV1FileSubscriptionRequest {
1005
+ /** 文档类型 */
1006
+ file_type: 'doc' | 'docx' | 'wiki';
1007
+ }
1016
1008
  export interface GetDriveV1FileSubscriptionResponse {
1017
1009
  /** 订阅关系ID */
1018
1010
  subscription_id: string;
@@ -1023,6 +1015,16 @@ export interface GetDriveV1FileSubscriptionResponse {
1023
1015
  /** 文档类型 */
1024
1016
  file_type?: 'doc' | 'docx' | 'wiki';
1025
1017
  }
1018
+ export interface CreateDriveV1FileSubscriptionRequest {
1019
+ /** 订阅关系ID */
1020
+ subscription_id?: string;
1021
+ /** 订阅类型 */
1022
+ subscription_type: 'comment_update';
1023
+ /** 是否订阅 */
1024
+ is_subcribe?: boolean;
1025
+ /** 文档类型 */
1026
+ file_type: 'doc' | 'docx' | 'wiki';
1027
+ }
1026
1028
  export interface CreateDriveV1FileSubscriptionResponse {
1027
1029
  /** 订阅关系ID */
1028
1030
  subscription_id?: string;
@@ -1033,6 +1035,12 @@ export interface CreateDriveV1FileSubscriptionResponse {
1033
1035
  /** 文档类型 */
1034
1036
  file_type?: 'doc' | 'docx' | 'wiki';
1035
1037
  }
1038
+ export interface PatchDriveV1FileSubscriptionRequest {
1039
+ /** 是否订阅 */
1040
+ is_subscribe: boolean;
1041
+ /** 文档类型 */
1042
+ file_type: 'doc' | 'docx' | 'wiki';
1043
+ }
1036
1044
  export interface PatchDriveV1FileSubscriptionResponse {
1037
1045
  /** 订阅关系ID */
1038
1046
  subscription_id?: string;