@satorijs/adapter-lark 3.9.1 → 3.9.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (82) hide show
  1. package/lib/index.cjs +1078 -14
  2. package/lib/types/acs.d.ts +19 -19
  3. package/lib/types/admin.d.ts +58 -32
  4. package/lib/types/aily.d.ts +52 -52
  5. package/lib/types/apaas.d.ts +96 -96
  6. package/lib/types/application.d.ts +151 -67
  7. package/lib/types/approval.d.ts +182 -150
  8. package/lib/types/attendance.d.ts +395 -353
  9. package/lib/types/auth.d.ts +18 -18
  10. package/lib/types/authen.d.ts +24 -24
  11. package/lib/types/baike.d.ts +42 -42
  12. package/lib/types/bitable.d.ts +268 -184
  13. package/lib/types/calendar.d.ts +144 -144
  14. package/lib/types/cardkit.d.ts +8 -8
  15. package/lib/types/contact.d.ts +209 -137
  16. package/lib/types/corehr.d.ts +760 -620
  17. package/lib/types/document_ai.d.ts +68 -68
  18. package/lib/types/docx.d.ts +103 -95
  19. package/lib/types/drive.d.ts +236 -236
  20. package/lib/types/ehr.d.ts +26 -2
  21. package/lib/types/helpdesk.d.ts +155 -155
  22. package/lib/types/hire.d.ts +954 -510
  23. package/lib/types/im.d.ts +446 -446
  24. package/lib/types/index.d.ts +72 -30
  25. package/lib/types/lingo.d.ts +28 -28
  26. package/lib/types/mail.d.ts +192 -192
  27. package/lib/types/minutes.d.ts +4 -4
  28. package/lib/types/okr.d.ts +86 -58
  29. package/lib/types/passport.d.ts +13 -5
  30. package/lib/types/payroll.d.ts +13 -5
  31. package/lib/types/performance.d.ts +85 -79
  32. package/lib/types/personal_settings.d.ts +12 -12
  33. package/lib/types/report.d.ts +11 -5
  34. package/lib/types/search.d.ts +48 -24
  35. package/lib/types/sheets.d.ts +64 -64
  36. package/lib/types/speech_to_text.d.ts +4 -4
  37. package/lib/types/task.d.ts +191 -185
  38. package/lib/types/translation.d.ts +4 -4
  39. package/lib/types/vc.d.ts +335 -155
  40. package/lib/types/wiki.d.ts +48 -48
  41. package/package.json +1 -1
  42. package/src/internal.ts +1 -1
  43. package/src/types/acs.ts +24 -24
  44. package/src/types/admin.ts +69 -39
  45. package/src/types/aily.ts +61 -61
  46. package/src/types/apaas.ts +113 -113
  47. package/src/types/application.ts +173 -79
  48. package/src/types/approval.ts +202 -166
  49. package/src/types/attendance.ts +466 -421
  50. package/src/types/auth.ts +20 -20
  51. package/src/types/authen.ts +28 -28
  52. package/src/types/baike.ts +55 -55
  53. package/src/types/bitable.ts +305 -219
  54. package/src/types/calendar.ts +167 -167
  55. package/src/types/cardkit.ts +10 -10
  56. package/src/types/contact.ts +251 -169
  57. package/src/types/corehr.ts +903 -743
  58. package/src/types/document_ai.ts +85 -85
  59. package/src/types/docx.ts +117 -108
  60. package/src/types/drive.ts +298 -298
  61. package/src/types/ehr.ts +28 -2
  62. package/src/types/helpdesk.ts +181 -181
  63. package/src/types/hire.ts +1081 -591
  64. package/src/types/im.ts +521 -521
  65. package/src/types/index.ts +73 -30
  66. package/src/types/lingo.ts +36 -36
  67. package/src/types/mail.ts +215 -215
  68. package/src/types/minutes.ts +5 -5
  69. package/src/types/okr.ts +98 -66
  70. package/src/types/passport.ts +15 -6
  71. package/src/types/payroll.ts +15 -6
  72. package/src/types/performance.ts +98 -91
  73. package/src/types/personal_settings.ts +15 -15
  74. package/src/types/report.ts +13 -6
  75. package/src/types/search.ts +57 -29
  76. package/src/types/sheets.ts +80 -80
  77. package/src/types/speech_to_text.ts +5 -5
  78. package/src/types/task.ts +238 -231
  79. package/src/types/translation.ts +5 -5
  80. package/src/types/vc.ts +386 -186
  81. package/src/types/wiki.ts +59 -59
  82. package/src/utils.ts +12 -7
package/lib/types/im.d.ts CHANGED
@@ -373,452 +373,6 @@ export interface CreateImMessageQuery {
373
373
  /** 消息接收者id类型 open_id/user_id/union_id/email/chat_id */
374
374
  receive_id_type: 'open_id' | 'user_id' | 'union_id' | 'email' | 'chat_id';
375
375
  }
376
- export interface ReplyImMessageRequest {
377
- /** 消息内容 json 格式,格式说明参考: [发送消息content说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/im-v1/message/create_json) */
378
- content: string;
379
- /** 消息类型,包括:text、post、image、file、audio、media、sticker、interactive、share_card、share_user */
380
- msg_type: string;
381
- /** 是否以话题形式回复;若群聊已经是话题模式,则自动回复该条消息所在的话题 */
382
- reply_in_thread?: boolean;
383
- /** 由开发者生成的唯一字符串序列,用于回复消息请求去重;持有相同uuid的请求1小时内至多成功执行一次 */
384
- uuid?: string;
385
- }
386
- export interface UpdateImMessageRequest {
387
- /** 消息的类型,仅支持文本(text)和富文本(post)类型 */
388
- msg_type: string;
389
- /** 消息内容,JSON 格式 */
390
- content: string;
391
- }
392
- export interface ForwardImMessageRequest {
393
- /** 依据receive_id_type的值,填写对应的转发目标的ID */
394
- receive_id: string;
395
- }
396
- export interface ForwardImMessageQuery {
397
- /** 消息接收者id类型 open_id/user_id/union_id/email/chat_id */
398
- receive_id_type: 'open_id' | 'user_id' | 'union_id' | 'email' | 'chat_id' | 'thread_id';
399
- /** 由开发者生成的唯一字符串序列,用于转发消息请求去重;持有相同uuid的请求在1小时内向同一个目标的转发只可成功一次。 */
400
- uuid?: string;
401
- }
402
- export interface MergeForwardImMessageRequest {
403
- /** 依据receive_id_type的值,填写对应的转发目标的ID */
404
- receive_id: string;
405
- /** 要转发的消息ID列表 */
406
- message_id_list: string[];
407
- }
408
- export interface MergeForwardImMessageQuery {
409
- /** 消息接收者id类型 open_id/user_id/union_id/email/chat_id */
410
- receive_id_type: 'open_id' | 'user_id' | 'union_id' | 'email' | 'chat_id' | 'thread_id';
411
- /** 由开发者生成的唯一字符串序列,用于转发消息请求去重;持有相同uuid的请求在1小时内向同一个目标的转发只可成功一次。 */
412
- uuid?: string;
413
- }
414
- export interface ForwardImThreadRequest {
415
- /** 依据receive_id_type的值,填写对应的转发目标的ID */
416
- receive_id: string;
417
- }
418
- export interface ForwardImThreadQuery {
419
- /** 消息接收者id类型 open_id/user_id/union_id/email/chat_id/thread_id */
420
- receive_id_type: 'open_id' | 'user_id' | 'union_id' | 'email' | 'chat_id' | 'thread_id';
421
- /** 由开发者生成的唯一字符串序列,用于转发消息请求去重;持有相同uuid的请求在1小时内向同一个目标的转发只可成功一次。 */
422
- uuid?: string;
423
- }
424
- export interface PushFollowUpImMessageRequest {
425
- /** follow up列表 */
426
- follow_ups: FollowUp[];
427
- }
428
- export interface ReadUsersImMessageQuery extends Pagination {
429
- /** 此次调用中使用的用户ID的类型 */
430
- user_id_type: 'user_id' | 'union_id' | 'open_id';
431
- }
432
- export interface ListImMessageQuery extends Pagination {
433
- /** 容器类型 ,目前可选值仅有"chat",包含单聊(p2p)和群聊(group) */
434
- container_id_type: string;
435
- /** 容器的id,即chat的id,详情参见[群ID 说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description) */
436
- container_id: string;
437
- /** 历史信息的起始时间(秒级时间戳) */
438
- start_time?: string;
439
- /** 历史信息的结束时间(秒级时间戳) */
440
- end_time?: string;
441
- /** 消息排序方式 */
442
- sort_type?: 'ByCreateTimeAsc' | 'ByCreateTimeDesc';
443
- }
444
- export interface GetImMessageResourceQuery {
445
- /** 资源类型,可选"image, file“; image对应消息中的 图片,富文本消息中的图片。 file对应消息中的 文件、音频、视频、(表情包除外) */
446
- type: string;
447
- }
448
- export interface GetImMessageQuery {
449
- /** 此次调用中使用的用户ID的类型 */
450
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
451
- }
452
- export interface CreateImImageForm {
453
- /** 图片类型 */
454
- image_type: 'message' | 'avatar';
455
- /** 图片内容 **注意:** 上传的图片大小不能超过10MB */
456
- image: Blob;
457
- }
458
- export interface CreateImFileForm {
459
- /** 文件类型 */
460
- file_type: 'opus' | 'mp4' | 'pdf' | 'doc' | 'xls' | 'ppt' | 'stream';
461
- /** 带后缀的文件名 */
462
- file_name: string;
463
- /** 文件的时长(视频,音频),单位:毫秒。不填充时无法显示具体时长。 */
464
- duration?: number;
465
- /** 文件内容 */
466
- file: Blob;
467
- }
468
- export interface UrgentAppImMessageRequest {
469
- /** 该字段标识目标用户的id类型 */
470
- user_id_list: string[];
471
- }
472
- export interface UrgentAppImMessageQuery {
473
- /** 此次调用中使用的用户ID的类型 */
474
- user_id_type: 'user_id' | 'union_id' | 'open_id';
475
- }
476
- export interface UrgentSmsImMessageRequest {
477
- /** 该字段标识目标用户的id类型 */
478
- user_id_list: string[];
479
- }
480
- export interface UrgentSmsImMessageQuery {
481
- /** 此次调用中使用的用户ID的类型 */
482
- user_id_type: 'user_id' | 'union_id' | 'open_id';
483
- }
484
- export interface UrgentPhoneImMessageRequest {
485
- /** 该字段标识目标用户的id类型 */
486
- user_id_list: string[];
487
- }
488
- export interface UrgentPhoneImMessageQuery {
489
- /** 此次调用中使用的用户ID的类型 */
490
- user_id_type: 'user_id' | 'union_id' | 'open_id';
491
- }
492
- export interface CreateImMessageReactionRequest {
493
- /** reaction资源类型 */
494
- reaction_type: Emoji;
495
- }
496
- export interface ListImMessageReactionQuery extends Pagination {
497
- /** 待查询消息reaction的类型[emoji类型列举](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message-reaction/emojis-introduce)。- 不传入该参数,表示拉取所有类型reaction */
498
- reaction_type?: string;
499
- /** 当操作人为用户时返回用户ID的类型 */
500
- user_id_type?: 'open_id' | 'union_id' | 'user_id';
501
- }
502
- export interface CreateImPinRequest {
503
- /** 待Pin的消息ID */
504
- message_id: string;
505
- }
506
- export interface ListImPinQuery extends Pagination {
507
- /** 待获取Pin消息的Chat ID */
508
- chat_id: string;
509
- /** Pin信息的起始时间(毫秒级时间戳) */
510
- start_time?: string;
511
- /** Pin信息的结束时间(毫秒级时间戳) */
512
- end_time?: string;
513
- }
514
- export interface PatchImMessageRequest {
515
- /** 消息内容 json 格式,[发送消息 content 说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/im-v1/message/create_json),参考文档中的卡片格式 */
516
- content: string;
517
- }
518
- export interface BatchUpdateImUrlPreviewRequest {
519
- /** URL预览的token列表 */
520
- preview_tokens: string[];
521
- /** 需要更新URL预览的用户open_id。若不传,则默认更新URL所在会话成员;若用户不在URL所在会话,则无法更新该用户 */
522
- open_ids?: string[];
523
- }
524
- export interface CreateImChatRequest {
525
- /** 群头像对应的 Image Key,可通过[上传图片](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/im-v1/image/create)获取(注意:上传图片的 ==image_type== 需要指定为 ==avatar==) */
526
- avatar?: string;
527
- /** 群名称 **注意:** 公开群名称的长度不得少于2个字符 */
528
- name?: string;
529
- /** 群描述 */
530
- description?: string;
531
- /** 群国际化名称 */
532
- i18n_names?: I18nNames;
533
- /** 创建群时指定的群主,不填时指定建群的机器人为群主。群主 ID,ID值与查询参数中的 user_id_type 对应。不同 ID 的说明参见 [用户相关的 ID 概念](/ssl:ttdoc/home/user-identity-introduction/introduction) */
534
- owner_id?: string;
535
- /** 创建群时邀请的群成员,id 类型为 user_id_type */
536
- user_id_list?: string[];
537
- /** 创建群时邀请的群机器人 **注意:** 拉机器人入群请使用 ==app_id== */
538
- bot_id_list?: string[];
539
- /** 群消息模式 */
540
- group_message_type?: 'chat' | 'thread';
541
- /** 群模式**可选值有**:- `group`:群组 */
542
- chat_mode?: string;
543
- /** 群类型**可选值有**:- `private`:私有群- `public`:公开群 */
544
- chat_type?: string;
545
- /** 入群消息可见性**可选值有**:- `only_owner`:仅群主和管理员可见- `all_members`:所有成员可见- `not_anyone`:任何人均不可见 */
546
- join_message_visibility?: string;
547
- /** 退群消息可见性**可选值有**:- `only_owner`:仅群主和管理员可见- `all_members`:所有成员可见- `not_anyone`:任何人均不可见 */
548
- leave_message_visibility?: string;
549
- /** 加群审批**可选值有**:- `no_approval_required`:无需审批- `approval_required`:需要审批 */
550
- membership_approval?: string;
551
- /** 防泄密模式设置 */
552
- restricted_mode_setting?: RestrictedModeSetting;
553
- /** 谁可以加急 */
554
- urgent_setting?: 'only_owner' | 'all_members';
555
- /** 谁可以发起视频会议 */
556
- video_conference_setting?: 'only_owner' | 'all_members';
557
- /** 谁可以编辑群信息 */
558
- edit_permission?: 'only_owner' | 'all_members';
559
- /** 隐藏群成员人数设置 */
560
- hide_member_count_setting?: 'all_members' | 'only_owner';
561
- }
562
- export interface CreateImChatQuery {
563
- /** 此次调用中使用的用户ID的类型 */
564
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
565
- /** 如果选择了设置群主为指定用户,可以选择是否同时设置创建此群的机器人为管理员,此标志位用于标记是否设置创建群的机器人为管理员 */
566
- set_bot_manager?: boolean;
567
- /** 由开发者生成的唯一字符串序列,用于创建群组请求去重;持有相同uuid的请求10小时内只可成功创建1个群聊 */
568
- uuid?: string;
569
- }
570
- export interface UpdateImChatRequest {
571
- /** 群头像对应的 Image Key,可通过[上传图片](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/image/create)获取(注意:上传图片的 ==image_type== 需要指定为 ==avatar==) */
572
- avatar?: string;
573
- /** 群名称 */
574
- name?: string;
575
- /** 群描述 */
576
- description?: string;
577
- /** 群国际化名称 */
578
- i18n_names?: I18nNames;
579
- /** 加 user/bot 入群权限(all_members/only_owner) */
580
- add_member_permission?: string;
581
- /** 群分享权限(allowed/not_allowed) */
582
- share_card_permission?: string;
583
- /** at 所有人权限(all_members/only_owner) */
584
- at_all_permission?: string;
585
- /** 群编辑权限(all_members/only_owner) */
586
- edit_permission?: string;
587
- /** 新群主 ID */
588
- owner_id?: string;
589
- /** 入群消息可见性(only_owner/all_members/not_anyone) */
590
- join_message_visibility?: string;
591
- /** 出群消息可见性(only_owner/all_members/not_anyone) */
592
- leave_message_visibility?: string;
593
- /** 加群审批(no_approval_required/approval_required) */
594
- membership_approval?: string;
595
- /** 防泄密模式设置 */
596
- restricted_mode_setting?: RestrictedModeSetting;
597
- /** 群类型 */
598
- chat_type?: string;
599
- /** 群消息模式 */
600
- group_message_type?: 'chat' | 'thread';
601
- /** 谁可以加急 */
602
- urgent_setting?: 'only_owner' | 'all_members';
603
- /** 谁可以发起视频会议 */
604
- video_conference_setting?: 'only_owner' | 'all_members';
605
- /** 隐藏群成员人数设置 */
606
- hide_member_count_setting?: 'all_members' | 'only_owner';
607
- }
608
- export interface UpdateImChatQuery {
609
- /** 此次调用中使用的用户ID的类型 */
610
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
611
- }
612
- export interface UpdateImChatModerationRequest {
613
- /** 群发言模式(all_members/only_owner/moderator_list,其中 moderator_list 表示部分用户可发言的模式) */
614
- moderation_setting?: string;
615
- /** 选择部分用户可发言模式时,添加的可发言用户列表(自动过滤不在群内的用户) */
616
- moderator_added_list?: string[];
617
- /** 选择部分用户可发言模式时,移除的可发言用户列表(自动过滤不在群内的用户) */
618
- moderator_removed_list?: string[];
619
- }
620
- export interface UpdateImChatModerationQuery {
621
- /** 此次调用中使用的用户ID的类型 */
622
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
623
- }
624
- export interface GetImChatQuery {
625
- /** 此次调用中使用的用户ID的类型 */
626
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
627
- }
628
- export interface PutTopNoticeImChatTopNoticeRequest {
629
- /** 要进行发布的群置顶 */
630
- chat_top_notice: ChatTopNotice[];
631
- }
632
- export interface ListImChatQuery extends Pagination {
633
- /** 此次调用中使用的用户ID的类型 */
634
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
635
- /** 群组排序方式 */
636
- sort_type?: 'ByCreateTimeAsc' | 'ByActiveTimeDesc';
637
- }
638
- export interface SearchImChatQuery extends Pagination {
639
- /** 此次调用中使用的用户ID的类型 */
640
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
641
- /** 关键词。注意:如果query为空值将返回空的结果 */
642
- query?: string;
643
- }
644
- export interface GetImChatModerationQuery extends Pagination {
645
- /** 此次调用中使用的用户ID的类型 */
646
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
647
- }
648
- export interface LinkImChatRequest {
649
- /** 群分享链接有效时长,可选值week、year、permanently,分别表示7天、1年以及永久有效 */
650
- validity_period?: 'week' | 'year' | 'permanently';
651
- }
652
- export interface AddManagersImChatManagersRequest {
653
- /** 要增加的 manager_id */
654
- manager_ids?: string[];
655
- }
656
- export interface AddManagersImChatManagersQuery {
657
- /** 群成员 id 类型 open_id/user_id/union_id/app_id */
658
- member_id_type?: 'user_id' | 'union_id' | 'open_id' | 'app_id';
659
- }
660
- export interface DeleteManagersImChatManagersRequest {
661
- /** 要删除的 manager_id */
662
- manager_ids?: string[];
663
- }
664
- export interface DeleteManagersImChatManagersQuery {
665
- /** 群成员 id 类型 open_id/user_id/union_id/app_id */
666
- member_id_type?: 'user_id' | 'union_id' | 'open_id' | 'app_id';
667
- }
668
- export interface CreateImChatMembersRequest {
669
- /** 成员列表<b>注意:</b>每次请求,最多拉50个用户或者5个机器人,并且群组最多容纳15个机器人 */
670
- id_list?: string[];
671
- }
672
- export interface CreateImChatMembersQuery {
673
- /** 进群成员 id 类型 open_id/user_id/union_id/app_id<b>注意:</b>拉机器人入群请使用 ==app_id== */
674
- member_id_type?: 'user_id' | 'union_id' | 'open_id' | 'app_id';
675
- /** 出现不可用ID后的处理方式 0/1/2 */
676
- succeed_type?: 0 | 1 | 2;
677
- }
678
- export interface DeleteImChatMembersRequest {
679
- /** 成员列表 */
680
- id_list?: string[];
681
- }
682
- export interface DeleteImChatMembersQuery {
683
- /** 出群成员 id 类型 open_id/user_id/union_id/app_id */
684
- member_id_type?: 'user_id' | 'union_id' | 'open_id' | 'app_id';
685
- }
686
- export interface GetImChatMembersQuery extends Pagination {
687
- /** 群成员 用户 ID 类型,详情参见 [用户相关的 ID 概念](/ssl:ttdoc/home/user-identity-introduction/introduction) */
688
- member_id_type?: 'user_id' | 'union_id' | 'open_id';
689
- }
690
- export interface PatchImChatAnnouncementRequest {
691
- /** 文档当前版本号 int64 类型,get 接口会返回 */
692
- revision: string;
693
- /** 修改文档请求的序列化字段更新公告信息的格式和更新[云文档](/ssl:ttdoc/ukTMukTMukTM/uYDM2YjL2AjN24iNwYjN)格式相同 */
694
- requests?: string[];
695
- }
696
- export interface GetImChatAnnouncementQuery {
697
- /** 此次调用中使用的用户ID的类型 */
698
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
699
- }
700
- export interface CreateImChatTabRequest {
701
- /** 会话标签页 */
702
- chat_tabs: ChatTab[];
703
- }
704
- export interface DeleteTabsImChatTabRequest {
705
- /** 会话标签页id列表 */
706
- tab_ids: string[];
707
- }
708
- export interface UpdateTabsImChatTabRequest {
709
- /** 会话标签页 */
710
- chat_tabs?: ChatTab[];
711
- }
712
- export interface SortTabsImChatTabRequest {
713
- /** 会话标签页ID列表 */
714
- tab_ids?: string[];
715
- }
716
- export interface CreateImChatMenuTreeRequest {
717
- /** 要向群内追加的菜单 */
718
- menu_tree: ChatMenuTree;
719
- }
720
- export interface DeleteImChatMenuTreeRequest {
721
- /** 要删除的一级菜单ID列表 */
722
- chat_menu_top_level_ids: string[];
723
- }
724
- export interface PatchImChatMenuItemRequest {
725
- /** 修改的字段 */
726
- update_fields: ('ICON' | 'NAME' | 'I18N_NAME' | 'REDIRECT_LINK')[];
727
- /** 元信息 */
728
- chat_menu_item: ChatMenuItem;
729
- }
730
- export interface SortImChatMenuTreeRequest {
731
- /** 一级菜单id列表 */
732
- chat_menu_top_level_ids: string[];
733
- }
734
- export interface CreateImAppFeedCardRequest {
735
- /** 应用消息卡片 */
736
- app_feed_card?: OpenAppFeedCard;
737
- /** 用户 ID */
738
- user_ids?: string[];
739
- }
740
- export interface CreateImAppFeedCardQuery {
741
- /** 用户 ID 类型 */
742
- user_id_type?: 'open_id' | 'union_id' | 'user_id';
743
- }
744
- export interface UpdateImAppFeedCardBatchRequest {
745
- /** 应用消息卡片 */
746
- feed_cards?: UserOpenAppFeedCardUpdater[];
747
- }
748
- export interface UpdateImAppFeedCardBatchQuery {
749
- /** 此次调用中使用的用户ID的类型 可选值有: - open_id: 以open_id来识别用户 - user_id: 以user_id来识别用户 - union_id: 以union_id来识别用户 */
750
- user_id_type?: 'open_id' | 'user_id' | 'union_id';
751
- }
752
- export interface DeleteImAppFeedCardBatchRequest {
753
- /** 应用消息卡片 */
754
- feed_cards?: UserOpenAppFeedCardDeleter[];
755
- }
756
- export interface DeleteImAppFeedCardBatchQuery {
757
- /** 此次调用中使用的用户ID的类型 可选值有: - open_id: 以open_id来识别用户 - user_id: 以user_id来识别用户 - union_id: 以union_id来识别用户 */
758
- user_id_type?: 'open_id' | 'user_id' | 'union_id';
759
- }
760
- export interface BotTimeSentiveImFeedCardRequest {
761
- /** 临时置顶状态,true-打开,false-关闭 */
762
- time_sensitive: boolean;
763
- /** 用户id 列表 */
764
- user_ids: string[];
765
- }
766
- export interface BotTimeSentiveImFeedCardQuery {
767
- /** 此次调用中使用的用户ID的类型 可选值有: - open_id: 以open_id来识别用户 - user_id: 以user_id来识别用户 - union_id: 以union_id来识别用户 */
768
- user_id_type: 'open_id' | 'user_id' | 'union_id';
769
- }
770
- export interface UpdateImChatButtonRequest {
771
- /** 用户 ID 列表 */
772
- user_ids?: string[];
773
- /** 群 ID */
774
- chat_id: string;
775
- /** 按钮 */
776
- buttons?: OpenAppFeedCardButtons;
777
- }
778
- export interface UpdateImChatButtonQuery {
779
- /** 用户 ID 类型 */
780
- user_id_type?: 'open_id' | 'union_id' | 'user_id';
781
- }
782
- export interface PatchImFeedCardRequest {
783
- /** 临时置顶状态,true-打开,false-关闭 */
784
- time_sensitive: boolean;
785
- /** 用户id 列表 */
786
- user_ids: string[];
787
- }
788
- export interface PatchImFeedCardQuery {
789
- /** 此次调用中使用的用户ID的类型 可选值有: - open_id: 以open_id来识别用户 - user_id: 以user_id来识别用户 - union_id: 以union_id来识别用户 */
790
- user_id_type: 'open_id' | 'user_id' | 'union_id';
791
- }
792
- export interface GetImBizEntityTagRelationQuery {
793
- /** 业务类型 */
794
- tag_biz_type: 'chat';
795
- /** 业务实体id */
796
- biz_entity_id: string;
797
- }
798
- export interface CreateImTagRequest {
799
- /** 创建标签 */
800
- create_tag: CreateTag;
801
- }
802
- export interface PatchImTagRequest {
803
- /** 编辑标签 */
804
- patch_tag?: PatchTag;
805
- }
806
- export interface CreateImBizEntityTagRelationRequest {
807
- /** 业务类型 */
808
- tag_biz_type: 'chat';
809
- /** 业务实体id */
810
- biz_entity_id: string;
811
- /** 标签id */
812
- tag_ids?: string[];
813
- }
814
- export interface UpdateImBizEntityTagRelationRequest {
815
- /** 业务类型 */
816
- tag_biz_type: 'chat';
817
- /** 业务实体id */
818
- biz_entity_id: string;
819
- /** 标签id */
820
- tag_ids?: string[];
821
- }
822
376
  export interface CreateImMessageResponse {
823
377
  /** 消息id open_message_id */
824
378
  message_id?: string;
@@ -849,6 +403,16 @@ export interface CreateImMessageResponse {
849
403
  /** 合并消息的上一层级消息id open_message_id */
850
404
  upper_message_id?: string;
851
405
  }
406
+ export interface ReplyImMessageRequest {
407
+ /** 消息内容 json 格式,格式说明参考: [发送消息content说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/im-v1/message/create_json) */
408
+ content: string;
409
+ /** 消息类型,包括:text、post、image、file、audio、media、sticker、interactive、share_card、share_user */
410
+ msg_type: string;
411
+ /** 是否以话题形式回复;若群聊已经是话题模式,则自动回复该条消息所在的话题 */
412
+ reply_in_thread?: boolean;
413
+ /** 由开发者生成的唯一字符串序列,用于回复消息请求去重;持有相同uuid的请求1小时内至多成功执行一次 */
414
+ uuid?: string;
415
+ }
852
416
  export interface ReplyImMessageResponse {
853
417
  /** 消息id open_message_id */
854
418
  message_id?: string;
@@ -879,6 +443,12 @@ export interface ReplyImMessageResponse {
879
443
  /** 合并消息的上一层级消息id open_message_id */
880
444
  upper_message_id?: string;
881
445
  }
446
+ export interface UpdateImMessageRequest {
447
+ /** 消息的类型,仅支持文本(text)和富文本(post)类型 */
448
+ msg_type: string;
449
+ /** 消息内容,JSON 格式 */
450
+ content: string;
451
+ }
882
452
  export interface UpdateImMessageResponse {
883
453
  /** 消息id open_message_id */
884
454
  message_id?: string;
@@ -909,6 +479,16 @@ export interface UpdateImMessageResponse {
909
479
  /** 合并消息的上一层级消息id open_message_id */
910
480
  upper_message_id?: string;
911
481
  }
482
+ export interface ForwardImMessageRequest {
483
+ /** 依据receive_id_type的值,填写对应的转发目标的ID */
484
+ receive_id: string;
485
+ }
486
+ export interface ForwardImMessageQuery {
487
+ /** 消息接收者id类型 open_id/user_id/union_id/email/chat_id */
488
+ receive_id_type: 'open_id' | 'user_id' | 'union_id' | 'email' | 'chat_id' | 'thread_id';
489
+ /** 由开发者生成的唯一字符串序列,用于转发消息请求去重;持有相同uuid的请求在1小时内向同一个目标的转发只可成功一次。 */
490
+ uuid?: string;
491
+ }
912
492
  export interface ForwardImMessageResponse {
913
493
  /** 消息id open_message_id */
914
494
  message_id?: string;
@@ -939,12 +519,34 @@ export interface ForwardImMessageResponse {
939
519
  /** 合并消息的上一层级消息id open_message_id */
940
520
  upper_message_id?: string;
941
521
  }
522
+ export interface MergeForwardImMessageRequest {
523
+ /** 依据receive_id_type的值,填写对应的转发目标的ID */
524
+ receive_id: string;
525
+ /** 要转发的消息ID列表 */
526
+ message_id_list: string[];
527
+ }
528
+ export interface MergeForwardImMessageQuery {
529
+ /** 消息接收者id类型 open_id/user_id/union_id/email/chat_id */
530
+ receive_id_type: 'open_id' | 'user_id' | 'union_id' | 'email' | 'chat_id' | 'thread_id';
531
+ /** 由开发者生成的唯一字符串序列,用于转发消息请求去重;持有相同uuid的请求在1小时内向同一个目标的转发只可成功一次。 */
532
+ uuid?: string;
533
+ }
942
534
  export interface MergeForwardImMessageResponse {
943
535
  /** 合并转发生成的新消息 */
944
536
  message?: Message;
945
537
  /** 无效的消息ID列表 */
946
538
  invalid_message_id_list?: string[];
947
539
  }
540
+ export interface ForwardImThreadRequest {
541
+ /** 依据receive_id_type的值,填写对应的转发目标的ID */
542
+ receive_id: string;
543
+ }
544
+ export interface ForwardImThreadQuery {
545
+ /** 消息接收者id类型 open_id/user_id/union_id/email/chat_id/thread_id */
546
+ receive_id_type: 'open_id' | 'user_id' | 'union_id' | 'email' | 'chat_id' | 'thread_id';
547
+ /** 由开发者生成的唯一字符串序列,用于转发消息请求去重;持有相同uuid的请求在1小时内向同一个目标的转发只可成功一次。 */
548
+ uuid?: string;
549
+ }
948
550
  export interface ForwardImThreadResponse {
949
551
  /** 消息id open_message_id */
950
552
  message_id?: string;
@@ -975,6 +577,34 @@ export interface ForwardImThreadResponse {
975
577
  /** 合并消息的上一层级消息id open_message_id */
976
578
  upper_message_id?: string;
977
579
  }
580
+ export interface PushFollowUpImMessageRequest {
581
+ /** follow up列表 */
582
+ follow_ups: FollowUp[];
583
+ }
584
+ export interface ReadUsersImMessageQuery extends Pagination {
585
+ /** 此次调用中使用的用户ID的类型 */
586
+ user_id_type: 'user_id' | 'union_id' | 'open_id';
587
+ }
588
+ export interface ListImMessageQuery extends Pagination {
589
+ /** 容器类型 ,目前可选值仅有"chat",包含单聊(p2p)和群聊(group) */
590
+ container_id_type: string;
591
+ /** 容器的id,即chat的id,详情参见[群ID 说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-id-description) */
592
+ container_id: string;
593
+ /** 历史信息的起始时间(秒级时间戳) */
594
+ start_time?: string;
595
+ /** 历史信息的结束时间(秒级时间戳) */
596
+ end_time?: string;
597
+ /** 消息排序方式 */
598
+ sort_type?: 'ByCreateTimeAsc' | 'ByCreateTimeDesc';
599
+ }
600
+ export interface GetImMessageResourceQuery {
601
+ /** 资源类型,可选"image, file“; image对应消息中的 图片,富文本消息中的图片。 file对应消息中的 文件、音频、视频、(表情包除外) */
602
+ type: string;
603
+ }
604
+ export interface GetImMessageQuery {
605
+ /** 此次调用中使用的用户ID的类型 */
606
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
607
+ }
978
608
  export interface GetImMessageResponse {
979
609
  /** message[] */
980
610
  items?: Message[];
@@ -988,26 +618,70 @@ export interface GetProgressImBatchMessageResponse {
988
618
  /** 消息撤回进度 */
989
619
  batch_message_recall_progress?: BatchMessageRecallProgress;
990
620
  }
621
+ export interface CreateImImageForm {
622
+ /** 图片类型 */
623
+ image_type: 'message' | 'avatar';
624
+ /** 图片内容 **注意:** 上传的图片大小不能超过10MB */
625
+ image: Blob;
626
+ }
991
627
  export interface CreateImImageResponse {
992
628
  /** 图片的key */
993
629
  image_key?: string;
994
630
  }
631
+ export interface CreateImFileForm {
632
+ /** 文件类型 */
633
+ file_type: 'opus' | 'mp4' | 'pdf' | 'doc' | 'xls' | 'ppt' | 'stream';
634
+ /** 带后缀的文件名 */
635
+ file_name: string;
636
+ /** 文件的时长(视频,音频),单位:毫秒。不填充时无法显示具体时长。 */
637
+ duration?: number;
638
+ /** 文件内容 */
639
+ file: Blob;
640
+ }
995
641
  export interface CreateImFileResponse {
996
642
  /** 文件的key */
997
643
  file_key?: string;
998
644
  }
645
+ export interface UrgentAppImMessageRequest {
646
+ /** 该字段标识目标用户的id类型 */
647
+ user_id_list: string[];
648
+ }
649
+ export interface UrgentAppImMessageQuery {
650
+ /** 此次调用中使用的用户ID的类型 */
651
+ user_id_type: 'user_id' | 'union_id' | 'open_id';
652
+ }
999
653
  export interface UrgentAppImMessageResponse {
1000
654
  /** 无效的用户id */
1001
655
  invalid_user_id_list: string[];
1002
656
  }
657
+ export interface UrgentSmsImMessageRequest {
658
+ /** 该字段标识目标用户的id类型 */
659
+ user_id_list: string[];
660
+ }
661
+ export interface UrgentSmsImMessageQuery {
662
+ /** 此次调用中使用的用户ID的类型 */
663
+ user_id_type: 'user_id' | 'union_id' | 'open_id';
664
+ }
1003
665
  export interface UrgentSmsImMessageResponse {
1004
666
  /** 无效的用户id */
1005
667
  invalid_user_id_list: string[];
1006
668
  }
669
+ export interface UrgentPhoneImMessageRequest {
670
+ /** 该字段标识目标用户的id类型 */
671
+ user_id_list: string[];
672
+ }
673
+ export interface UrgentPhoneImMessageQuery {
674
+ /** 此次调用中使用的用户ID的类型 */
675
+ user_id_type: 'user_id' | 'union_id' | 'open_id';
676
+ }
1007
677
  export interface UrgentPhoneImMessageResponse {
1008
678
  /** 无效的用户id */
1009
679
  invalid_user_id_list: string[];
1010
680
  }
681
+ export interface CreateImMessageReactionRequest {
682
+ /** reaction资源类型 */
683
+ reaction_type: Emoji;
684
+ }
1011
685
  export interface CreateImMessageReactionResponse {
1012
686
  /** reaction资源ID */
1013
687
  reaction_id?: string;
@@ -1018,6 +692,12 @@ export interface CreateImMessageReactionResponse {
1018
692
  /** reaction资源类型 */
1019
693
  reaction_type?: Emoji;
1020
694
  }
695
+ export interface ListImMessageReactionQuery extends Pagination {
696
+ /** 待查询消息reaction的类型[emoji类型列举](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message-reaction/emojis-introduce)。- 不传入该参数,表示拉取所有类型reaction */
697
+ reaction_type?: string;
698
+ /** 当操作人为用户时返回用户ID的类型 */
699
+ user_id_type?: 'open_id' | 'union_id' | 'user_id';
700
+ }
1021
701
  export interface DeleteImMessageReactionResponse {
1022
702
  /** reaction资源ID */
1023
703
  reaction_id?: string;
@@ -1028,9 +708,77 @@ export interface DeleteImMessageReactionResponse {
1028
708
  /** reaction资源类型 */
1029
709
  reaction_type?: Emoji;
1030
710
  }
711
+ export interface CreateImPinRequest {
712
+ /** 待Pin的消息ID */
713
+ message_id: string;
714
+ }
1031
715
  export interface CreateImPinResponse {
1032
716
  pin?: Pin;
1033
717
  }
718
+ export interface ListImPinQuery extends Pagination {
719
+ /** 待获取Pin消息的Chat ID */
720
+ chat_id: string;
721
+ /** Pin信息的起始时间(毫秒级时间戳) */
722
+ start_time?: string;
723
+ /** Pin信息的结束时间(毫秒级时间戳) */
724
+ end_time?: string;
725
+ }
726
+ export interface PatchImMessageRequest {
727
+ /** 消息内容 json 格式,[发送消息 content 说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/im-v1/message/create_json),参考文档中的卡片格式 */
728
+ content: string;
729
+ }
730
+ export interface BatchUpdateImUrlPreviewRequest {
731
+ /** URL预览的token列表 */
732
+ preview_tokens: string[];
733
+ /** 需要更新URL预览的用户open_id。若不传,则默认更新URL所在会话成员;若用户不在URL所在会话,则无法更新该用户 */
734
+ open_ids?: string[];
735
+ }
736
+ export interface CreateImChatRequest {
737
+ /** 群头像对应的 Image Key,可通过[上传图片](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/im-v1/image/create)获取(注意:上传图片的 ==image_type== 需要指定为 ==avatar==) */
738
+ avatar?: string;
739
+ /** 群名称 **注意:** 公开群名称的长度不得少于2个字符 */
740
+ name?: string;
741
+ /** 群描述 */
742
+ description?: string;
743
+ /** 群国际化名称 */
744
+ i18n_names?: I18nNames;
745
+ /** 创建群时指定的群主,不填时指定建群的机器人为群主。群主 ID,ID值与查询参数中的 user_id_type 对应。不同 ID 的说明参见 [用户相关的 ID 概念](/ssl:ttdoc/home/user-identity-introduction/introduction) */
746
+ owner_id?: string;
747
+ /** 创建群时邀请的群成员,id 类型为 user_id_type */
748
+ user_id_list?: string[];
749
+ /** 创建群时邀请的群机器人 **注意:** 拉机器人入群请使用 ==app_id== */
750
+ bot_id_list?: string[];
751
+ /** 群消息模式 */
752
+ group_message_type?: 'chat' | 'thread';
753
+ /** 群模式**可选值有**:- `group`:群组 */
754
+ chat_mode?: string;
755
+ /** 群类型**可选值有**:- `private`:私有群- `public`:公开群 */
756
+ chat_type?: string;
757
+ /** 入群消息可见性**可选值有**:- `only_owner`:仅群主和管理员可见- `all_members`:所有成员可见- `not_anyone`:任何人均不可见 */
758
+ join_message_visibility?: string;
759
+ /** 退群消息可见性**可选值有**:- `only_owner`:仅群主和管理员可见- `all_members`:所有成员可见- `not_anyone`:任何人均不可见 */
760
+ leave_message_visibility?: string;
761
+ /** 加群审批**可选值有**:- `no_approval_required`:无需审批- `approval_required`:需要审批 */
762
+ membership_approval?: string;
763
+ /** 防泄密模式设置 */
764
+ restricted_mode_setting?: RestrictedModeSetting;
765
+ /** 谁可以加急 */
766
+ urgent_setting?: 'only_owner' | 'all_members';
767
+ /** 谁可以发起视频会议 */
768
+ video_conference_setting?: 'only_owner' | 'all_members';
769
+ /** 谁可以编辑群信息 */
770
+ edit_permission?: 'only_owner' | 'all_members';
771
+ /** 隐藏群成员人数设置 */
772
+ hide_member_count_setting?: 'all_members' | 'only_owner';
773
+ }
774
+ export interface CreateImChatQuery {
775
+ /** 此次调用中使用的用户ID的类型 */
776
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
777
+ /** 如果选择了设置群主为指定用户,可以选择是否同时设置创建此群的机器人为管理员,此标志位用于标记是否设置创建群的机器人为管理员 */
778
+ set_bot_manager?: boolean;
779
+ /** 由开发者生成的唯一字符串序列,用于创建群组请求去重;持有相同uuid的请求10小时内只可成功创建1个群聊 */
780
+ uuid?: string;
781
+ }
1034
782
  export interface CreateImChatResponse {
1035
783
  /** 群ID */
1036
784
  chat_id?: string;
@@ -1083,6 +831,64 @@ export interface CreateImChatResponse {
1083
831
  /** 隐藏群成员人数设置 */
1084
832
  hide_member_count_setting?: 'all_members' | 'only_owner';
1085
833
  }
834
+ export interface UpdateImChatRequest {
835
+ /** 群头像对应的 Image Key,可通过[上传图片](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/image/create)获取(注意:上传图片的 ==image_type== 需要指定为 ==avatar==) */
836
+ avatar?: string;
837
+ /** 群名称 */
838
+ name?: string;
839
+ /** 群描述 */
840
+ description?: string;
841
+ /** 群国际化名称 */
842
+ i18n_names?: I18nNames;
843
+ /** 加 user/bot 入群权限(all_members/only_owner) */
844
+ add_member_permission?: string;
845
+ /** 群分享权限(allowed/not_allowed) */
846
+ share_card_permission?: string;
847
+ /** at 所有人权限(all_members/only_owner) */
848
+ at_all_permission?: string;
849
+ /** 群编辑权限(all_members/only_owner) */
850
+ edit_permission?: string;
851
+ /** 新群主 ID */
852
+ owner_id?: string;
853
+ /** 入群消息可见性(only_owner/all_members/not_anyone) */
854
+ join_message_visibility?: string;
855
+ /** 出群消息可见性(only_owner/all_members/not_anyone) */
856
+ leave_message_visibility?: string;
857
+ /** 加群审批(no_approval_required/approval_required) */
858
+ membership_approval?: string;
859
+ /** 防泄密模式设置 */
860
+ restricted_mode_setting?: RestrictedModeSetting;
861
+ /** 群类型 */
862
+ chat_type?: string;
863
+ /** 群消息模式 */
864
+ group_message_type?: 'chat' | 'thread';
865
+ /** 谁可以加急 */
866
+ urgent_setting?: 'only_owner' | 'all_members';
867
+ /** 谁可以发起视频会议 */
868
+ video_conference_setting?: 'only_owner' | 'all_members';
869
+ /** 隐藏群成员人数设置 */
870
+ hide_member_count_setting?: 'all_members' | 'only_owner';
871
+ }
872
+ export interface UpdateImChatQuery {
873
+ /** 此次调用中使用的用户ID的类型 */
874
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
875
+ }
876
+ export interface UpdateImChatModerationRequest {
877
+ /** 群发言模式(all_members/only_owner/moderator_list,其中 moderator_list 表示部分用户可发言的模式) */
878
+ moderation_setting?: string;
879
+ /** 选择部分用户可发言模式时,添加的可发言用户列表(自动过滤不在群内的用户) */
880
+ moderator_added_list?: string[];
881
+ /** 选择部分用户可发言模式时,移除的可发言用户列表(自动过滤不在群内的用户) */
882
+ moderator_removed_list?: string[];
883
+ }
884
+ export interface UpdateImChatModerationQuery {
885
+ /** 此次调用中使用的用户ID的类型 */
886
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
887
+ }
888
+ export interface GetImChatQuery {
889
+ /** 此次调用中使用的用户ID的类型 */
890
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
891
+ }
1086
892
  export interface GetImChatResponse {
1087
893
  /** 群头像URL */
1088
894
  avatar?: string;
@@ -1143,6 +949,26 @@ export interface GetImChatResponse {
1143
949
  /** 群状态 */
1144
950
  chat_status?: 'normal' | 'dissolved' | 'dissolved_save';
1145
951
  }
952
+ export interface PutTopNoticeImChatTopNoticeRequest {
953
+ /** 要进行发布的群置顶 */
954
+ chat_top_notice: ChatTopNotice[];
955
+ }
956
+ export interface ListImChatQuery extends Pagination {
957
+ /** 此次调用中使用的用户ID的类型 */
958
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
959
+ /** 群组排序方式 */
960
+ sort_type?: 'ByCreateTimeAsc' | 'ByActiveTimeDesc';
961
+ }
962
+ export interface SearchImChatQuery extends Pagination {
963
+ /** 此次调用中使用的用户ID的类型 */
964
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
965
+ /** 关键词。注意:如果query为空值将返回空的结果 */
966
+ query?: string;
967
+ }
968
+ export interface GetImChatModerationQuery extends Pagination {
969
+ /** 此次调用中使用的用户ID的类型 */
970
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
971
+ }
1146
972
  export interface GetImChatModerationResponse {
1147
973
  /** 群发言模式 */
1148
974
  moderation_setting?: string;
@@ -1153,6 +979,10 @@ export interface GetImChatModerationResponse {
1153
979
  /** 可发言用户列表 */
1154
980
  items?: ListModerator[];
1155
981
  }
982
+ export interface LinkImChatRequest {
983
+ /** 群分享链接有效时长,可选值week、year、permanently,分别表示7天、1年以及永久有效 */
984
+ validity_period?: 'week' | 'year' | 'permanently';
985
+ }
1156
986
  export interface LinkImChatResponse {
1157
987
  /** 群分享链接 */
1158
988
  share_link?: string;
@@ -1161,18 +991,44 @@ export interface LinkImChatResponse {
1161
991
  /** 分享链接是否永久有效 */
1162
992
  is_permanent?: boolean;
1163
993
  }
994
+ export interface AddManagersImChatManagersRequest {
995
+ /** 要增加的 manager_id */
996
+ manager_ids?: string[];
997
+ }
998
+ export interface AddManagersImChatManagersQuery {
999
+ /** 群成员 id 类型 open_id/user_id/union_id/app_id */
1000
+ member_id_type?: 'user_id' | 'union_id' | 'open_id' | 'app_id';
1001
+ }
1164
1002
  export interface AddManagersImChatManagersResponse {
1165
1003
  /** 群目前的管理员id */
1166
1004
  chat_managers?: string[];
1167
1005
  /** 群目前的管理员bot id */
1168
1006
  chat_bot_managers?: string[];
1169
1007
  }
1008
+ export interface DeleteManagersImChatManagersRequest {
1009
+ /** 要删除的 manager_id */
1010
+ manager_ids?: string[];
1011
+ }
1012
+ export interface DeleteManagersImChatManagersQuery {
1013
+ /** 群成员 id 类型 open_id/user_id/union_id/app_id */
1014
+ member_id_type?: 'user_id' | 'union_id' | 'open_id' | 'app_id';
1015
+ }
1170
1016
  export interface DeleteManagersImChatManagersResponse {
1171
1017
  /** 群目前的管理员id */
1172
1018
  chat_managers?: string[];
1173
1019
  /** 群目前的管理员bot id */
1174
1020
  chat_bot_managers?: string[];
1175
1021
  }
1022
+ export interface CreateImChatMembersRequest {
1023
+ /** 成员列表<b>注意:</b>每次请求,最多拉50个用户或者5个机器人,并且群组最多容纳15个机器人 */
1024
+ id_list?: string[];
1025
+ }
1026
+ export interface CreateImChatMembersQuery {
1027
+ /** 进群成员 id 类型 open_id/user_id/union_id/app_id<b>注意:</b>拉机器人入群请使用 ==app_id== */
1028
+ member_id_type?: 'user_id' | 'union_id' | 'open_id' | 'app_id';
1029
+ /** 出现不可用ID后的处理方式 0/1/2 */
1030
+ succeed_type?: 0 | 1 | 2;
1031
+ }
1176
1032
  export interface CreateImChatMembersResponse {
1177
1033
  /** ID无效的成员列表 */
1178
1034
  invalid_id_list?: string[];
@@ -1181,10 +1037,22 @@ export interface CreateImChatMembersResponse {
1181
1037
  /** 等待群主或管理员审批的成员ID列表 */
1182
1038
  pending_approval_id_list?: string[];
1183
1039
  }
1040
+ export interface DeleteImChatMembersRequest {
1041
+ /** 成员列表 */
1042
+ id_list?: string[];
1043
+ }
1044
+ export interface DeleteImChatMembersQuery {
1045
+ /** 出群成员 id 类型 open_id/user_id/union_id/app_id */
1046
+ member_id_type?: 'user_id' | 'union_id' | 'open_id' | 'app_id';
1047
+ }
1184
1048
  export interface DeleteImChatMembersResponse {
1185
1049
  /** 无效成员列表 */
1186
1050
  invalid_id_list?: string[];
1187
1051
  }
1052
+ export interface GetImChatMembersQuery extends Pagination {
1053
+ /** 群成员 用户 ID 类型,详情参见 [用户相关的 ID 概念](/ssl:ttdoc/home/user-identity-introduction/introduction) */
1054
+ member_id_type?: 'user_id' | 'union_id' | 'open_id';
1055
+ }
1188
1056
  export interface GetImChatMembersResponse {
1189
1057
  /** member列表 */
1190
1058
  items?: ListMember[];
@@ -1199,6 +1067,16 @@ export interface IsInChatImChatMembersResponse {
1199
1067
  /** 用户或者机器人是否在群中 */
1200
1068
  is_in_chat?: boolean;
1201
1069
  }
1070
+ export interface PatchImChatAnnouncementRequest {
1071
+ /** 文档当前版本号 int64 类型,get 接口会返回 */
1072
+ revision: string;
1073
+ /** 修改文档请求的序列化字段更新公告信息的格式和更新[云文档](/ssl:ttdoc/ukTMukTMukTM/uYDM2YjL2AjN24iNwYjN)格式相同 */
1074
+ requests?: string[];
1075
+ }
1076
+ export interface GetImChatAnnouncementQuery {
1077
+ /** 此次调用中使用的用户ID的类型 */
1078
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
1079
+ }
1202
1080
  export interface GetImChatAnnouncementResponse {
1203
1081
  /** CCM 文档序列化信息 */
1204
1082
  content?: string;
@@ -1217,18 +1095,34 @@ export interface GetImChatAnnouncementResponse {
1217
1095
  /** 文档最新修改者id */
1218
1096
  modifier_id?: string;
1219
1097
  }
1098
+ export interface CreateImChatTabRequest {
1099
+ /** 会话标签页 */
1100
+ chat_tabs: ChatTab[];
1101
+ }
1220
1102
  export interface CreateImChatTabResponse {
1221
1103
  /** 群标签列表 */
1222
1104
  chat_tabs?: ChatTab[];
1223
1105
  }
1106
+ export interface DeleteTabsImChatTabRequest {
1107
+ /** 会话标签页id列表 */
1108
+ tab_ids: string[];
1109
+ }
1224
1110
  export interface DeleteTabsImChatTabResponse {
1225
1111
  /** 群标签列表 */
1226
1112
  chat_tabs?: ChatTab[];
1227
1113
  }
1114
+ export interface UpdateTabsImChatTabRequest {
1115
+ /** 会话标签页 */
1116
+ chat_tabs?: ChatTab[];
1117
+ }
1228
1118
  export interface UpdateTabsImChatTabResponse {
1229
1119
  /** 群标签列表 */
1230
1120
  chat_tabs?: ChatTab[];
1231
1121
  }
1122
+ export interface SortTabsImChatTabRequest {
1123
+ /** 会话标签页ID列表 */
1124
+ tab_ids?: string[];
1125
+ }
1232
1126
  export interface SortTabsImChatTabResponse {
1233
1127
  /** 群标签列表 */
1234
1128
  chat_tabs?: ChatTab[];
@@ -1237,17 +1131,35 @@ export interface ListTabsImChatTabResponse {
1237
1131
  /** 会话标签页 */
1238
1132
  chat_tabs?: ChatTab[];
1239
1133
  }
1134
+ export interface CreateImChatMenuTreeRequest {
1135
+ /** 要向群内追加的菜单 */
1136
+ menu_tree: ChatMenuTree;
1137
+ }
1240
1138
  export interface CreateImChatMenuTreeResponse {
1241
1139
  /** 追加后群内现有菜单 */
1242
1140
  menu_tree?: ChatMenuTree;
1243
1141
  }
1142
+ export interface DeleteImChatMenuTreeRequest {
1143
+ /** 要删除的一级菜单ID列表 */
1144
+ chat_menu_top_level_ids: string[];
1145
+ }
1244
1146
  export interface DeleteImChatMenuTreeResponse {
1245
1147
  /** 群内现有菜单 */
1246
1148
  menu_tree?: ChatMenuTree;
1247
1149
  }
1150
+ export interface PatchImChatMenuItemRequest {
1151
+ /** 修改的字段 */
1152
+ update_fields: ('ICON' | 'NAME' | 'I18N_NAME' | 'REDIRECT_LINK')[];
1153
+ /** 元信息 */
1154
+ chat_menu_item: ChatMenuItem;
1155
+ }
1248
1156
  export interface PatchImChatMenuItemResponse {
1249
1157
  chat_menu_item?: ChatMenuItem;
1250
1158
  }
1159
+ export interface SortImChatMenuTreeRequest {
1160
+ /** 一级菜单id列表 */
1161
+ chat_menu_top_level_ids: string[];
1162
+ }
1251
1163
  export interface SortImChatMenuTreeResponse {
1252
1164
  /** 排序后群内菜单 */
1253
1165
  menu_tree?: ChatMenuTree;
@@ -1256,45 +1168,133 @@ export interface GetImChatMenuTreeResponse {
1256
1168
  /** 群内所有菜单 */
1257
1169
  menu_tree?: ChatMenuTree;
1258
1170
  }
1171
+ export interface CreateImAppFeedCardRequest {
1172
+ /** 应用消息卡片 */
1173
+ app_feed_card?: OpenAppFeedCard;
1174
+ /** 用户 ID */
1175
+ user_ids?: string[];
1176
+ }
1177
+ export interface CreateImAppFeedCardQuery {
1178
+ /** 用户 ID 类型 */
1179
+ user_id_type?: 'open_id' | 'union_id' | 'user_id';
1180
+ }
1259
1181
  export interface CreateImAppFeedCardResponse {
1260
1182
  /** 失败的卡片 */
1261
1183
  failed_cards?: OpenFailedUserAppFeedCardItem[];
1262
1184
  /** 卡片业务 ID */
1263
1185
  biz_id?: string;
1264
1186
  }
1187
+ export interface UpdateImAppFeedCardBatchRequest {
1188
+ /** 应用消息卡片 */
1189
+ feed_cards?: UserOpenAppFeedCardUpdater[];
1190
+ }
1191
+ export interface UpdateImAppFeedCardBatchQuery {
1192
+ /** 此次调用中使用的用户ID的类型 可选值有: - open_id: 以open_id来识别用户 - user_id: 以user_id来识别用户 - union_id: 以union_id来识别用户 */
1193
+ user_id_type?: 'open_id' | 'user_id' | 'union_id';
1194
+ }
1265
1195
  export interface UpdateImAppFeedCardBatchResponse {
1266
1196
  /** 失败的卡片 */
1267
1197
  failed_cards?: OpenFailedUserAppFeedCardItem[];
1268
1198
  }
1199
+ export interface DeleteImAppFeedCardBatchRequest {
1200
+ /** 应用消息卡片 */
1201
+ feed_cards?: UserOpenAppFeedCardDeleter[];
1202
+ }
1203
+ export interface DeleteImAppFeedCardBatchQuery {
1204
+ /** 此次调用中使用的用户ID的类型 可选值有: - open_id: 以open_id来识别用户 - user_id: 以user_id来识别用户 - union_id: 以union_id来识别用户 */
1205
+ user_id_type?: 'open_id' | 'user_id' | 'union_id';
1206
+ }
1269
1207
  export interface DeleteImAppFeedCardBatchResponse {
1270
1208
  /** 失败的卡片 */
1271
1209
  failed_cards?: OpenFailedUserAppFeedCardItem[];
1272
1210
  }
1211
+ export interface BotTimeSentiveImFeedCardRequest {
1212
+ /** 临时置顶状态,true-打开,false-关闭 */
1213
+ time_sensitive: boolean;
1214
+ /** 用户id 列表 */
1215
+ user_ids: string[];
1216
+ }
1217
+ export interface BotTimeSentiveImFeedCardQuery {
1218
+ /** 此次调用中使用的用户ID的类型 可选值有: - open_id: 以open_id来识别用户 - user_id: 以user_id来识别用户 - union_id: 以union_id来识别用户 */
1219
+ user_id_type: 'open_id' | 'user_id' | 'union_id';
1220
+ }
1273
1221
  export interface BotTimeSentiveImFeedCardResponse {
1274
1222
  /** 失败原因 */
1275
1223
  failed_user_reasons?: FailedReason[];
1276
1224
  }
1225
+ export interface UpdateImChatButtonRequest {
1226
+ /** 用户 ID 列表 */
1227
+ user_ids?: string[];
1228
+ /** 群 ID */
1229
+ chat_id: string;
1230
+ /** 按钮 */
1231
+ buttons?: OpenAppFeedCardButtons;
1232
+ }
1233
+ export interface UpdateImChatButtonQuery {
1234
+ /** 用户 ID 类型 */
1235
+ user_id_type?: 'open_id' | 'union_id' | 'user_id';
1236
+ }
1277
1237
  export interface UpdateImChatButtonResponse {
1278
1238
  /** 失败的用户 */
1279
1239
  failed_user_reasons?: FailedReason[];
1280
1240
  }
1241
+ export interface PatchImFeedCardRequest {
1242
+ /** 临时置顶状态,true-打开,false-关闭 */
1243
+ time_sensitive: boolean;
1244
+ /** 用户id 列表 */
1245
+ user_ids: string[];
1246
+ }
1247
+ export interface PatchImFeedCardQuery {
1248
+ /** 此次调用中使用的用户ID的类型 可选值有: - open_id: 以open_id来识别用户 - user_id: 以user_id来识别用户 - union_id: 以union_id来识别用户 */
1249
+ user_id_type: 'open_id' | 'user_id' | 'union_id';
1250
+ }
1281
1251
  export interface PatchImFeedCardResponse {
1282
1252
  /** 失败原因 */
1283
1253
  failed_user_reasons?: FailedReason[];
1284
1254
  }
1255
+ export interface GetImBizEntityTagRelationQuery {
1256
+ /** 业务类型 */
1257
+ tag_biz_type: 'chat';
1258
+ /** 业务实体id */
1259
+ biz_entity_id: string;
1260
+ }
1285
1261
  export interface GetImBizEntityTagRelationResponse {
1286
1262
  /** 标签内容及绑定时间 */
1287
1263
  tag_info_with_bind_versions?: TagInfoWithBindVersion[];
1288
1264
  }
1265
+ export interface CreateImTagRequest {
1266
+ /** 创建标签 */
1267
+ create_tag: CreateTag;
1268
+ }
1289
1269
  export interface CreateImTagResponse {
1290
1270
  /** 创建的tagid */
1291
1271
  id?: string;
1292
1272
  /** 创建失败原因 */
1293
1273
  create_tag_fail_reason?: CreateTagFailReason;
1294
1274
  }
1275
+ export interface PatchImTagRequest {
1276
+ /** 编辑标签 */
1277
+ patch_tag?: PatchTag;
1278
+ }
1295
1279
  export interface PatchImTagResponse {
1296
1280
  /** 编辑后的taginfo */
1297
1281
  tag_info?: TagInfo;
1298
1282
  /** 修改失败原因 */
1299
1283
  patch_tag_fail_reason?: PatchTagFailReason;
1300
1284
  }
1285
+ export interface CreateImBizEntityTagRelationRequest {
1286
+ /** 业务类型 */
1287
+ tag_biz_type: 'chat';
1288
+ /** 业务实体id */
1289
+ biz_entity_id: string;
1290
+ /** 标签id */
1291
+ tag_ids?: string[];
1292
+ }
1293
+ export interface UpdateImBizEntityTagRelationRequest {
1294
+ /** 业务类型 */
1295
+ tag_biz_type: 'chat';
1296
+ /** 业务实体id */
1297
+ biz_entity_id: string;
1298
+ /** 标签id */
1299
+ tag_ids?: string[];
1300
+ }