@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
@@ -7,7 +7,7 @@ declare module '../internal' {
7
7
  * 获取文件夹中的文件清单
8
8
  * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/list
9
9
  */
10
- listDriveV1File(query?: ListDriveV1FileQuery): Paginated<File, 'files'>
10
+ listDriveV1File(query?: ListDriveV1FileQuery): Promise<ListDriveV1FileResponse> & AsyncIterableIterator<File>
11
11
  /**
12
12
  * 新建文件夹
13
13
  * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/create_folder
@@ -312,6 +312,15 @@ export interface ListDriveV1FileQuery extends Pagination {
312
312
  user_id_type?: 'user_id' | 'union_id' | 'open_id'
313
313
  }
314
314
 
315
+ export interface ListDriveV1FileResponse {
316
+ /** 文档详细信息 */
317
+ files?: File[]
318
+ /** 下一页分页参数 */
319
+ next_page_token?: string
320
+ /** 是否有下一页 */
321
+ has_more?: boolean
322
+ }
323
+
315
324
  export interface CreateFolderDriveV1FileRequest {
316
325
  /** 文件夹名称 */
317
326
  name: string
@@ -319,11 +328,23 @@ export interface CreateFolderDriveV1FileRequest {
319
328
  folder_token: string
320
329
  }
321
330
 
331
+ export interface CreateFolderDriveV1FileResponse {
332
+ /** 新创建的文件夹 Token */
333
+ token?: string
334
+ /** 创建文件夹的访问 URL */
335
+ url?: string
336
+ }
337
+
322
338
  export interface TaskCheckDriveV1FileQuery {
323
339
  /** 文件相关异步任务id */
324
340
  task_id: string
325
341
  }
326
342
 
343
+ export interface TaskCheckDriveV1FileResponse {
344
+ /** 异步任务的执行状态 */
345
+ status?: string
346
+ }
347
+
327
348
  export interface BatchQueryDriveV1MetaRequest {
328
349
  /** 请求文档, 一次不超过200个 */
329
350
  request_docs: RequestDoc[]
@@ -336,11 +357,25 @@ export interface BatchQueryDriveV1MetaQuery {
336
357
  user_id_type?: 'user_id' | 'union_id' | 'open_id'
337
358
  }
338
359
 
360
+ export interface BatchQueryDriveV1MetaResponse {
361
+ metas: Meta[]
362
+ failed_list?: MetaFailed[]
363
+ }
364
+
339
365
  export interface GetDriveV1FileStatisticsQuery {
340
366
  /** 文档类型 */
341
367
  file_type: 'doc' | 'sheet' | 'mindnote' | 'bitable' | 'wiki' | 'file' | 'docx'
342
368
  }
343
369
 
370
+ export interface GetDriveV1FileStatisticsResponse {
371
+ /** 文档token */
372
+ file_token?: string
373
+ /** 文档类型 */
374
+ file_type?: string
375
+ /** 文档统计信息 */
376
+ statistics?: FileStatistics
377
+ }
378
+
344
379
  export interface ListDriveV1FileViewRecordQuery extends Pagination {
345
380
  /** 文档类型 */
346
381
  file_type: 'doc' | 'docx' | 'sheet' | 'bitable' | 'mindnote' | 'wiki' | 'file'
@@ -364,6 +399,11 @@ export interface CopyDriveV1FileQuery {
364
399
  user_id_type?: 'user_id' | 'union_id' | 'open_id'
365
400
  }
366
401
 
402
+ export interface CopyDriveV1FileResponse {
403
+ /** 复制后的文件资源 */
404
+ file?: File
405
+ }
406
+
367
407
  export interface MoveDriveV1FileRequest {
368
408
  /** 文件类型,如果该值为空或者与文件实际类型不匹配,接口会返回失败。 */
369
409
  type?: 'file' | 'docx' | 'bitable' | 'doc' | 'sheet' | 'mindnote' | 'folder' | 'slides'
@@ -371,11 +411,21 @@ export interface MoveDriveV1FileRequest {
371
411
  folder_token?: string
372
412
  }
373
413
 
414
+ export interface MoveDriveV1FileResponse {
415
+ /** 异步任务id,移动文件夹时返回 */
416
+ task_id?: string
417
+ }
418
+
374
419
  export interface DeleteDriveV1FileQuery {
375
420
  /** 被删除文件的类型 */
376
421
  type: 'file' | 'docx' | 'bitable' | 'folder' | 'doc' | 'sheet' | 'mindnote' | 'shortcut' | 'slides'
377
422
  }
378
423
 
424
+ export interface DeleteDriveV1FileResponse {
425
+ /** 异步任务id,删除文件夹时返回 */
426
+ task_id?: string
427
+ }
428
+
379
429
  export interface CreateShortcutDriveV1FileRequest {
380
430
  /** 创建快捷方式的目标父文件夹 token */
381
431
  parent_token: string
@@ -388,6 +438,11 @@ export interface CreateShortcutDriveV1FileQuery {
388
438
  user_id_type?: 'user_id' | 'union_id' | 'open_id'
389
439
  }
390
440
 
441
+ export interface CreateShortcutDriveV1FileResponse {
442
+ /** 返回创建成功的shortcut节点 */
443
+ succ_shortcut_node?: File
444
+ }
445
+
391
446
  export interface UploadAllDriveV1FileForm {
392
447
  /** 文件名。 */
393
448
  file_name: string
@@ -403,6 +458,10 @@ export interface UploadAllDriveV1FileForm {
403
458
  file: Blob
404
459
  }
405
460
 
461
+ export interface UploadAllDriveV1FileResponse {
462
+ file_token?: string
463
+ }
464
+
406
465
  export interface UploadPrepareDriveV1FileRequest {
407
466
  /** 文件名 */
408
467
  file_name: string
@@ -414,6 +473,15 @@ export interface UploadPrepareDriveV1FileRequest {
414
473
  size: number
415
474
  }
416
475
 
476
+ export interface UploadPrepareDriveV1FileResponse {
477
+ /** 分片上传事务ID */
478
+ upload_id?: string
479
+ /** 分片大小策略 */
480
+ block_size?: number
481
+ /** 分片数量 */
482
+ block_num?: number
483
+ }
484
+
417
485
  export interface UploadPartDriveV1FileForm {
418
486
  /** 分片上传事务ID。 */
419
487
  upload_id: string
@@ -434,6 +502,10 @@ export interface UploadFinishDriveV1FileRequest {
434
502
  block_num: number
435
503
  }
436
504
 
505
+ export interface UploadFinishDriveV1FileResponse {
506
+ file_token?: string
507
+ }
508
+
437
509
  export interface CreateDriveV1ImportTaskRequest {
438
510
  /** 导入文件格式后缀 */
439
511
  file_extension: string
@@ -447,6 +519,16 @@ export interface CreateDriveV1ImportTaskRequest {
447
519
  point: ImportTaskMountPoint
448
520
  }
449
521
 
522
+ export interface CreateDriveV1ImportTaskResponse {
523
+ /** 导入任务ID */
524
+ ticket?: string
525
+ }
526
+
527
+ export interface GetDriveV1ImportTaskResponse {
528
+ /** 导入任务 */
529
+ result?: ImportTask
530
+ }
531
+
450
532
  export interface CreateDriveV1ExportTaskRequest {
451
533
  /** 导出文件扩展名 */
452
534
  file_extension: 'docx' | 'pdf' | 'xlsx' | 'csv'
@@ -458,11 +540,21 @@ export interface CreateDriveV1ExportTaskRequest {
458
540
  sub_id?: string
459
541
  }
460
542
 
543
+ export interface CreateDriveV1ExportTaskResponse {
544
+ /** 导出任务ID */
545
+ ticket?: string
546
+ }
547
+
461
548
  export interface GetDriveV1ExportTaskQuery {
462
549
  /** 导出文档的 token */
463
550
  token: string
464
551
  }
465
552
 
553
+ export interface GetDriveV1ExportTaskResponse {
554
+ /** 导出结果 */
555
+ result?: ExportTask
556
+ }
557
+
466
558
  export interface UploadAllDriveV1MediaForm {
467
559
  /** 文件名。 */
468
560
  file_name: string
@@ -480,6 +572,10 @@ export interface UploadAllDriveV1MediaForm {
480
572
  file: Blob
481
573
  }
482
574
 
575
+ export interface UploadAllDriveV1MediaResponse {
576
+ file_token?: string
577
+ }
578
+
483
579
  export interface UploadPrepareDriveV1MediaRequest {
484
580
  /** 文件名 */
485
581
  file_name: string
@@ -493,6 +589,15 @@ export interface UploadPrepareDriveV1MediaRequest {
493
589
  extra?: string
494
590
  }
495
591
 
592
+ export interface UploadPrepareDriveV1MediaResponse {
593
+ /** 分片上传事务ID */
594
+ upload_id?: string
595
+ /** 分片大小策略 */
596
+ block_size?: number
597
+ /** 分片数量 */
598
+ block_num?: number
599
+ }
600
+
496
601
  export interface UploadPartDriveV1MediaForm {
497
602
  /** 分片上传事务ID。 */
498
603
  upload_id: string
@@ -513,6 +618,10 @@ export interface UploadFinishDriveV1MediaRequest {
513
618
  block_num: number
514
619
  }
515
620
 
621
+ export interface UploadFinishDriveV1MediaResponse {
622
+ file_token?: string
623
+ }
624
+
516
625
  export interface DownloadDriveV1MediaQuery {
517
626
  /** 扩展信息 */
518
627
  extra?: string
@@ -525,6 +634,11 @@ export interface BatchGetTmpDownloadUrlDriveV1MediaQuery {
525
634
  extra?: string
526
635
  }
527
636
 
637
+ export interface BatchGetTmpDownloadUrlDriveV1MediaResponse {
638
+ /** 临时下载列表 */
639
+ tmp_download_urls?: TmpDownloadUrl[]
640
+ }
641
+
528
642
  export interface CreateDriveV1FileVersionRequest {
529
643
  /** 版本文档标题,最大长度 1024 个Unicode 码点。通常情况下,一个英文或中文字符对应一个码点,但是某些特殊符号可能会对应多个码点。例如,家庭组合「👨‍👩‍👧」这个表情符号对应5个码点。 */
530
644
  name?: string
@@ -537,6 +651,29 @@ export interface CreateDriveV1FileVersionQuery {
537
651
  user_id_type?: 'user_id' | 'union_id' | 'open_id'
538
652
  }
539
653
 
654
+ export interface CreateDriveV1FileVersionResponse {
655
+ /** 版本文档标题,最大长度 1024 个Unicode 码点。通常情况下,一个英文或中文字符对应一个码点,但是某些特殊符号可能会对应多个码点。例如,家庭组合「👨‍👩‍👧」这个表情符号对应5个码点。 */
656
+ name?: string
657
+ /** 版本文档版本号 */
658
+ version?: string
659
+ /** 源文档token */
660
+ parent_token?: string
661
+ /** 版本文档所有者id */
662
+ owner_id?: string
663
+ /** 版本文档创建者id */
664
+ creator_id?: string
665
+ /** 版本文档创建时间 */
666
+ create_time?: string
667
+ /** 版本文档更新时间 */
668
+ update_time?: string
669
+ /** 版本文档状态 */
670
+ status?: '0' | '1' | '2'
671
+ /** 版本文档类型 */
672
+ obj_type?: 'docx' | 'sheet'
673
+ /** 源文档类型 */
674
+ parent_type?: 'docx' | 'sheet'
675
+ }
676
+
540
677
  export interface ListDriveV1FileVersionQuery extends Pagination {
541
678
  /** 原文档类型 */
542
679
  obj_type: 'docx' | 'sheet'
@@ -551,6 +688,29 @@ export interface GetDriveV1FileVersionQuery {
551
688
  user_id_type?: 'open_id' | 'union_id' | 'user_id'
552
689
  }
553
690
 
691
+ export interface GetDriveV1FileVersionResponse {
692
+ /** 版本文档标题,最大长度 1024 个Unicode 码点。通常情况下,一个英文或中文字符对应一个码点,但是某些特殊符号可能会对应多个码点。例如,家庭组合「👨‍👩‍👧」这个表情符号对应5个码点。 */
693
+ name?: string
694
+ /** 版本文档版本号 */
695
+ version?: string
696
+ /** 源文档token */
697
+ parent_token?: string
698
+ /** 版本文档所有者id */
699
+ owner_id?: string
700
+ /** 版本文档创建者id */
701
+ creator_id?: string
702
+ /** 版本文档创建时间 */
703
+ create_time?: string
704
+ /** 版本文档更新时间 */
705
+ update_time?: string
706
+ /** 版本文档状态 */
707
+ status?: '0' | '1' | '2'
708
+ /** 版本文档类型 */
709
+ obj_type?: 'docx' | 'sheet'
710
+ /** 源文档类型 */
711
+ parent_type?: 'docx' | 'sheet'
712
+ }
713
+
554
714
  export interface DeleteDriveV1FileVersionQuery {
555
715
  /** 文档类型 */
556
716
  obj_type: 'docx' | 'sheet'
@@ -579,6 +739,11 @@ export interface GetSubscribeDriveV1FileQuery {
579
739
  event_type?: string
580
740
  }
581
741
 
742
+ export interface GetSubscribeDriveV1FileResponse {
743
+ /** 是否有订阅,取值 true 表示已订阅;false 表示未订阅 */
744
+ is_subscribe?: boolean
745
+ }
746
+
582
747
  export interface DeleteSubscribeDriveV1FileQuery {
583
748
  /** 文档类型 */
584
749
  file_type: 'doc' | 'docx' | 'sheet' | 'bitable' | 'file' | 'folder'
@@ -598,6 +763,11 @@ export interface BatchCreateDriveV1PermissionMemberQuery {
598
763
  need_notification?: boolean
599
764
  }
600
765
 
766
+ export interface BatchCreateDriveV1PermissionMemberResponse {
767
+ /** 协作者列表 */
768
+ members?: BaseMember[]
769
+ }
770
+
601
771
  export interface TransferOwnerDriveV1PermissionMemberRequest {
602
772
  /** 文档拥有者的ID类型 */
603
773
  member_type: 'email' | 'openid' | 'userid'
@@ -625,6 +795,11 @@ export interface AuthDriveV1PermissionMemberQuery {
625
795
  action: 'view' | 'edit' | 'share' | 'comment' | 'export' | 'copy' | 'print' | 'manage_public'
626
796
  }
627
797
 
798
+ export interface AuthDriveV1PermissionMemberResponse {
799
+ /** 是否有权限 */
800
+ auth_result: boolean
801
+ }
802
+
628
803
  export interface ListDriveV1PermissionMemberQuery {
629
804
  /** 文件类型,需要与文件的 token 相匹配 */
630
805
  type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'mindnote' | 'minutes' | 'slides'
@@ -634,6 +809,11 @@ export interface ListDriveV1PermissionMemberQuery {
634
809
  perm_type?: 'container' | 'single_page'
635
810
  }
636
811
 
812
+ export interface ListDriveV1PermissionMemberResponse {
813
+ /** 返回的列表数据 */
814
+ items?: Member[]
815
+ }
816
+
637
817
  export interface CreateDriveV1PermissionMemberRequest {
638
818
  /** 协作者ID类型 */
639
819
  member_type: 'email' | 'openid' | 'unionid' | 'openchat' | 'opendepartmentid' | 'userid' | 'groupid' | 'wikispaceid'
@@ -654,6 +834,11 @@ export interface CreateDriveV1PermissionMemberQuery {
654
834
  need_notification?: boolean
655
835
  }
656
836
 
837
+ export interface CreateDriveV1PermissionMemberResponse {
838
+ /** 本次添加权限的用户信息 */
839
+ member?: BaseMember
840
+ }
841
+
657
842
  export interface UpdateDriveV1PermissionMemberRequest {
658
843
  /** 协作者ID类型 */
659
844
  member_type: 'email' | 'openid' | 'unionid' | 'openchat' | 'opendepartmentid' | 'userid' | 'groupid' | 'wikispaceid'
@@ -672,6 +857,11 @@ export interface UpdateDriveV1PermissionMemberQuery {
672
857
  type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'mindnote' | 'minutes' | 'slides'
673
858
  }
674
859
 
860
+ export interface UpdateDriveV1PermissionMemberResponse {
861
+ /** 本次更新权限的用户信息 */
862
+ member?: BaseMember
863
+ }
864
+
675
865
  export interface DeleteDriveV1PermissionMemberRequest {
676
866
  /** 协作者类型 */
677
867
  type?: 'user' | 'chat' | 'department' | 'group' | 'wiki_space_member' | 'wiki_space_viewer' | 'wiki_space_editor'
@@ -691,11 +881,21 @@ export interface CreateDriveV1PermissionPublicPasswordQuery {
691
881
  type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'mindnote' | 'minutes' | 'slides'
692
882
  }
693
883
 
884
+ export interface CreateDriveV1PermissionPublicPasswordResponse {
885
+ /** 密码 */
886
+ password?: string
887
+ }
888
+
694
889
  export interface UpdateDriveV1PermissionPublicPasswordQuery {
695
890
  /** 文件类型,需要与文件的 token 相匹配 */
696
891
  type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'mindnote' | 'minutes' | 'slides'
697
892
  }
698
893
 
894
+ export interface UpdateDriveV1PermissionPublicPasswordResponse {
895
+ /** 密码 */
896
+ password?: string
897
+ }
898
+
699
899
  export interface DeleteDriveV1PermissionPublicPasswordQuery {
700
900
  /** 文件类型,需要与文件的 token 相匹配 */
701
901
  type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'mindnote' | 'minutes' | 'slides'
@@ -706,6 +906,11 @@ export interface GetDriveV1PermissionPublicQuery {
706
906
  type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'mindnote' | 'minutes' | 'slides'
707
907
  }
708
908
 
909
+ export interface GetDriveV1PermissionPublicResponse {
910
+ /** 返回的文档公共设置 */
911
+ permission_public?: PermissionPublic
912
+ }
913
+
709
914
  export interface PatchDriveV1PermissionPublicRequest {
710
915
  /** 允许内容被分享到组织外 */
711
916
  external_access?: boolean
@@ -726,11 +931,21 @@ export interface PatchDriveV1PermissionPublicQuery {
726
931
  type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'mindnote' | 'minutes' | 'slides'
727
932
  }
728
933
 
934
+ export interface PatchDriveV1PermissionPublicResponse {
935
+ /** 本次更新后的文档公共设置 */
936
+ permission_public?: PermissionPublic
937
+ }
938
+
729
939
  export interface GetDriveV2PermissionPublicQuery {
730
940
  /** 文件类型,需要与文件的 token 相匹配 */
731
941
  type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'mindnote' | 'minutes' | 'slides'
732
942
  }
733
943
 
944
+ export interface GetDriveV2PermissionPublicResponse {
945
+ /** 返回的文档公共设置 */
946
+ permission_public?: PermissionPublic
947
+ }
948
+
734
949
  export interface PatchDriveV2PermissionPublicRequest {
735
950
  /** 允许内容被分享到组织外 */
736
951
  external_access_entity?: 'open' | 'closed' | 'allow_share_partner_tenant'
@@ -753,6 +968,11 @@ export interface PatchDriveV2PermissionPublicQuery {
753
968
  type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'mindnote' | 'minutes' | 'slides'
754
969
  }
755
970
 
971
+ export interface PatchDriveV2PermissionPublicResponse {
972
+ /** 本次更新后文档公共设置 */
973
+ permission_public?: PermissionPublic
974
+ }
975
+
756
976
  export interface ListDriveV1FileCommentQuery extends Pagination {
757
977
  /** 文档类型 */
758
978
  file_type: 'doc' | 'sheet' | 'file' | 'docx'
@@ -776,6 +996,11 @@ export interface BatchQueryDriveV1FileCommentQuery {
776
996
  user_id_type?: 'user_id' | 'union_id' | 'open_id'
777
997
  }
778
998
 
999
+ export interface BatchQueryDriveV1FileCommentResponse {
1000
+ /** 评论的相关信息、回复的信息、回复分页的信息 */
1001
+ items?: FileComment[]
1002
+ }
1003
+
779
1004
  export interface PatchDriveV1FileCommentRequest {
780
1005
  /** 评论解决标志 */
781
1006
  is_solved: boolean
@@ -798,277 +1023,41 @@ export interface CreateDriveV1FileCommentQuery {
798
1023
  user_id_type?: 'user_id' | 'union_id' | 'open_id'
799
1024
  }
800
1025
 
801
- export interface GetDriveV1FileCommentQuery {
802
- /** 文档类型 */
803
- file_type: 'doc' | 'sheet' | 'file' | 'docx'
804
- /** 此次调用中使用的用户 ID 的类型 */
805
- user_id_type?: 'user_id' | 'union_id' | 'open_id'
1026
+ export interface CreateDriveV1FileCommentResponse {
1027
+ /** 评论 ID */
1028
+ comment_id?: string
1029
+ /** 用户 ID */
1030
+ user_id?: string
1031
+ /** 创建时间 */
1032
+ create_time?: number
1033
+ /** 更新时间 */
1034
+ update_time?: number
1035
+ /** 是否已解决 */
1036
+ is_solved?: boolean
1037
+ /** 解决评论时间 */
1038
+ solved_time?: number
1039
+ /** 解决评论者的用户 ID */
1040
+ solver_user_id?: string
1041
+ /** 是否有更多回复 */
1042
+ has_more?: boolean
1043
+ /** 回复分页标记 */
1044
+ page_token?: string
1045
+ /** 是否是全文评论 */
1046
+ is_whole?: boolean
1047
+ /** 局部评论的引用字段 */
1048
+ quote?: string
1049
+ /** 评论里的回复列表 */
1050
+ reply_list?: ReplyList
806
1051
  }
807
1052
 
808
- export interface ListDriveV1FileCommentReplyQuery extends Pagination {
1053
+ export interface GetDriveV1FileCommentQuery {
809
1054
  /** 文档类型 */
810
1055
  file_type: 'doc' | 'sheet' | 'file' | 'docx'
811
- /** 此次调用中使用的用户ID的类型 */
1056
+ /** 此次调用中使用的用户 ID 的类型 */
812
1057
  user_id_type?: 'user_id' | 'union_id' | 'open_id'
813
1058
  }
814
1059
 
815
- export interface UpdateDriveV1FileCommentReplyRequest {
816
- /** 回复内容 */
817
- content: ReplyContent
818
- }
819
-
820
- export interface UpdateDriveV1FileCommentReplyQuery {
821
- /** 文档类型 */
822
- file_type: 'doc' | 'sheet' | 'file' | 'docx'
823
- /** 此次调用中使用的用户ID的类型 */
824
- user_id_type?: 'user_id' | 'union_id' | 'open_id'
825
- }
826
-
827
- export interface DeleteDriveV1FileCommentReplyQuery {
828
- /** 文档类型 */
829
- file_type: 'doc' | 'sheet' | 'file' | 'docx'
830
- }
831
-
832
- export interface GetDriveV1FileSubscriptionRequest {
833
- /** 文档类型 */
834
- file_type: 'doc' | 'docx' | 'wiki'
835
- }
836
-
837
- export interface CreateDriveV1FileSubscriptionRequest {
838
- /** 订阅关系ID */
839
- subscription_id?: string
840
- /** 订阅类型 */
841
- subscription_type: 'comment_update'
842
- /** 是否订阅 */
843
- is_subcribe?: boolean
844
- /** 文档类型 */
845
- file_type: 'doc' | 'docx' | 'wiki'
846
- }
847
-
848
- export interface PatchDriveV1FileSubscriptionRequest {
849
- /** 是否订阅 */
850
- is_subscribe: boolean
851
- /** 文档类型 */
852
- file_type: 'doc' | 'docx' | 'wiki'
853
- }
854
-
855
- export interface CreateFolderDriveV1FileResponse {
856
- /** 新创建的文件夹 Token */
857
- token?: string
858
- /** 创建文件夹的访问 URL */
859
- url?: string
860
- }
861
-
862
- export interface TaskCheckDriveV1FileResponse {
863
- /** 异步任务的执行状态 */
864
- status?: string
865
- }
866
-
867
- export interface BatchQueryDriveV1MetaResponse {
868
- metas: Meta[]
869
- failed_list?: MetaFailed[]
870
- }
871
-
872
- export interface GetDriveV1FileStatisticsResponse {
873
- /** 文档token */
874
- file_token?: string
875
- /** 文档类型 */
876
- file_type?: string
877
- /** 文档统计信息 */
878
- statistics?: FileStatistics
879
- }
880
-
881
- export interface CopyDriveV1FileResponse {
882
- /** 复制后的文件资源 */
883
- file?: File
884
- }
885
-
886
- export interface MoveDriveV1FileResponse {
887
- /** 异步任务id,移动文件夹时返回 */
888
- task_id?: string
889
- }
890
-
891
- export interface DeleteDriveV1FileResponse {
892
- /** 异步任务id,删除文件夹时返回 */
893
- task_id?: string
894
- }
895
-
896
- export interface CreateShortcutDriveV1FileResponse {
897
- /** 返回创建成功的shortcut节点 */
898
- succ_shortcut_node?: File
899
- }
900
-
901
- export interface UploadAllDriveV1FileResponse {
902
- file_token?: string
903
- }
904
-
905
- export interface UploadPrepareDriveV1FileResponse {
906
- /** 分片上传事务ID */
907
- upload_id?: string
908
- /** 分片大小策略 */
909
- block_size?: number
910
- /** 分片数量 */
911
- block_num?: number
912
- }
913
-
914
- export interface UploadFinishDriveV1FileResponse {
915
- file_token?: string
916
- }
917
-
918
- export interface CreateDriveV1ImportTaskResponse {
919
- /** 导入任务ID */
920
- ticket?: string
921
- }
922
-
923
- export interface GetDriveV1ImportTaskResponse {
924
- /** 导入任务 */
925
- result?: ImportTask
926
- }
927
-
928
- export interface CreateDriveV1ExportTaskResponse {
929
- /** 导出任务ID */
930
- ticket?: string
931
- }
932
-
933
- export interface GetDriveV1ExportTaskResponse {
934
- /** 导出结果 */
935
- result?: ExportTask
936
- }
937
-
938
- export interface UploadAllDriveV1MediaResponse {
939
- file_token?: string
940
- }
941
-
942
- export interface UploadPrepareDriveV1MediaResponse {
943
- /** 分片上传事务ID */
944
- upload_id?: string
945
- /** 分片大小策略 */
946
- block_size?: number
947
- /** 分片数量 */
948
- block_num?: number
949
- }
950
-
951
- export interface UploadFinishDriveV1MediaResponse {
952
- file_token?: string
953
- }
954
-
955
- export interface BatchGetTmpDownloadUrlDriveV1MediaResponse {
956
- /** 临时下载列表 */
957
- tmp_download_urls?: TmpDownloadUrl[]
958
- }
959
-
960
- export interface CreateDriveV1FileVersionResponse {
961
- /** 版本文档标题,最大长度 1024 个Unicode 码点。通常情况下,一个英文或中文字符对应一个码点,但是某些特殊符号可能会对应多个码点。例如,家庭组合「👨‍👩‍👧」这个表情符号对应5个码点。 */
962
- name?: string
963
- /** 版本文档版本号 */
964
- version?: string
965
- /** 源文档token */
966
- parent_token?: string
967
- /** 版本文档所有者id */
968
- owner_id?: string
969
- /** 版本文档创建者id */
970
- creator_id?: string
971
- /** 版本文档创建时间 */
972
- create_time?: string
973
- /** 版本文档更新时间 */
974
- update_time?: string
975
- /** 版本文档状态 */
976
- status?: '0' | '1' | '2'
977
- /** 版本文档类型 */
978
- obj_type?: 'docx' | 'sheet'
979
- /** 源文档类型 */
980
- parent_type?: 'docx' | 'sheet'
981
- }
982
-
983
- export interface GetDriveV1FileVersionResponse {
984
- /** 版本文档标题,最大长度 1024 个Unicode 码点。通常情况下,一个英文或中文字符对应一个码点,但是某些特殊符号可能会对应多个码点。例如,家庭组合「👨‍👩‍👧」这个表情符号对应5个码点。 */
985
- name?: string
986
- /** 版本文档版本号 */
987
- version?: string
988
- /** 源文档token */
989
- parent_token?: string
990
- /** 版本文档所有者id */
991
- owner_id?: string
992
- /** 版本文档创建者id */
993
- creator_id?: string
994
- /** 版本文档创建时间 */
995
- create_time?: string
996
- /** 版本文档更新时间 */
997
- update_time?: string
998
- /** 版本文档状态 */
999
- status?: '0' | '1' | '2'
1000
- /** 版本文档类型 */
1001
- obj_type?: 'docx' | 'sheet'
1002
- /** 源文档类型 */
1003
- parent_type?: 'docx' | 'sheet'
1004
- }
1005
-
1006
- export interface GetSubscribeDriveV1FileResponse {
1007
- /** 是否有订阅,取值 true 表示已订阅;false 表示未订阅 */
1008
- is_subscribe?: boolean
1009
- }
1010
-
1011
- export interface BatchCreateDriveV1PermissionMemberResponse {
1012
- /** 协作者列表 */
1013
- members?: BaseMember[]
1014
- }
1015
-
1016
- export interface AuthDriveV1PermissionMemberResponse {
1017
- /** 是否有权限 */
1018
- auth_result: boolean
1019
- }
1020
-
1021
- export interface ListDriveV1PermissionMemberResponse {
1022
- /** 返回的列表数据 */
1023
- items?: Member[]
1024
- }
1025
-
1026
- export interface CreateDriveV1PermissionMemberResponse {
1027
- /** 本次添加权限的用户信息 */
1028
- member?: BaseMember
1029
- }
1030
-
1031
- export interface UpdateDriveV1PermissionMemberResponse {
1032
- /** 本次更新权限的用户信息 */
1033
- member?: BaseMember
1034
- }
1035
-
1036
- export interface CreateDriveV1PermissionPublicPasswordResponse {
1037
- /** 密码 */
1038
- password?: string
1039
- }
1040
-
1041
- export interface UpdateDriveV1PermissionPublicPasswordResponse {
1042
- /** 密码 */
1043
- password?: string
1044
- }
1045
-
1046
- export interface GetDriveV1PermissionPublicResponse {
1047
- /** 返回的文档公共设置 */
1048
- permission_public?: PermissionPublic
1049
- }
1050
-
1051
- export interface PatchDriveV1PermissionPublicResponse {
1052
- /** 本次更新后的文档公共设置 */
1053
- permission_public?: PermissionPublic
1054
- }
1055
-
1056
- export interface GetDriveV2PermissionPublicResponse {
1057
- /** 返回的文档公共设置 */
1058
- permission_public?: PermissionPublic
1059
- }
1060
-
1061
- export interface PatchDriveV2PermissionPublicResponse {
1062
- /** 本次更新后文档公共设置 */
1063
- permission_public?: PermissionPublic
1064
- }
1065
-
1066
- export interface BatchQueryDriveV1FileCommentResponse {
1067
- /** 评论的相关信息、回复的信息、回复分页的信息 */
1068
- items?: FileComment[]
1069
- }
1070
-
1071
- export interface CreateDriveV1FileCommentResponse {
1060
+ export interface GetDriveV1FileCommentResponse {
1072
1061
  /** 评论 ID */
1073
1062
  comment_id?: string
1074
1063
  /** 用户 ID */
@@ -1095,31 +1084,33 @@ export interface CreateDriveV1FileCommentResponse {
1095
1084
  reply_list?: ReplyList
1096
1085
  }
1097
1086
 
1098
- export interface GetDriveV1FileCommentResponse {
1099
- /** 评论 ID */
1100
- comment_id?: string
1101
- /** 用户 ID */
1102
- user_id?: string
1103
- /** 创建时间 */
1104
- create_time?: number
1105
- /** 更新时间 */
1106
- update_time?: number
1107
- /** 是否已解决 */
1108
- is_solved?: boolean
1109
- /** 解决评论时间 */
1110
- solved_time?: number
1111
- /** 解决评论者的用户 ID */
1112
- solver_user_id?: string
1113
- /** 是否有更多回复 */
1114
- has_more?: boolean
1115
- /** 回复分页标记 */
1116
- page_token?: string
1117
- /** 是否是全文评论 */
1118
- is_whole?: boolean
1119
- /** 局部评论的引用字段 */
1120
- quote?: string
1121
- /** 评论里的回复列表 */
1122
- reply_list?: ReplyList
1087
+ export interface ListDriveV1FileCommentReplyQuery extends Pagination {
1088
+ /** 文档类型 */
1089
+ file_type: 'doc' | 'sheet' | 'file' | 'docx'
1090
+ /** 此次调用中使用的用户ID的类型 */
1091
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
1092
+ }
1093
+
1094
+ export interface UpdateDriveV1FileCommentReplyRequest {
1095
+ /** 回复内容 */
1096
+ content: ReplyContent
1097
+ }
1098
+
1099
+ export interface UpdateDriveV1FileCommentReplyQuery {
1100
+ /** 文档类型 */
1101
+ file_type: 'doc' | 'sheet' | 'file' | 'docx'
1102
+ /** 此次调用中使用的用户ID的类型 */
1103
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
1104
+ }
1105
+
1106
+ export interface DeleteDriveV1FileCommentReplyQuery {
1107
+ /** 文档类型 */
1108
+ file_type: 'doc' | 'sheet' | 'file' | 'docx'
1109
+ }
1110
+
1111
+ export interface GetDriveV1FileSubscriptionRequest {
1112
+ /** 文档类型 */
1113
+ file_type: 'doc' | 'docx' | 'wiki'
1123
1114
  }
1124
1115
 
1125
1116
  export interface GetDriveV1FileSubscriptionResponse {
@@ -1133,6 +1124,17 @@ export interface GetDriveV1FileSubscriptionResponse {
1133
1124
  file_type?: 'doc' | 'docx' | 'wiki'
1134
1125
  }
1135
1126
 
1127
+ export interface CreateDriveV1FileSubscriptionRequest {
1128
+ /** 订阅关系ID */
1129
+ subscription_id?: string
1130
+ /** 订阅类型 */
1131
+ subscription_type: 'comment_update'
1132
+ /** 是否订阅 */
1133
+ is_subcribe?: boolean
1134
+ /** 文档类型 */
1135
+ file_type: 'doc' | 'docx' | 'wiki'
1136
+ }
1137
+
1136
1138
  export interface CreateDriveV1FileSubscriptionResponse {
1137
1139
  /** 订阅关系ID */
1138
1140
  subscription_id?: string
@@ -1144,6 +1146,13 @@ export interface CreateDriveV1FileSubscriptionResponse {
1144
1146
  file_type?: 'doc' | 'docx' | 'wiki'
1145
1147
  }
1146
1148
 
1149
+ export interface PatchDriveV1FileSubscriptionRequest {
1150
+ /** 是否订阅 */
1151
+ is_subscribe: boolean
1152
+ /** 文档类型 */
1153
+ file_type: 'doc' | 'docx' | 'wiki'
1154
+ }
1155
+
1147
1156
  export interface PatchDriveV1FileSubscriptionResponse {
1148
1157
  /** 订阅关系ID */
1149
1158
  subscription_id?: string