@satorijs/adapter-lark 3.10.6 → 3.11.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (116) hide show
  1. package/lib/index.cjs +2880 -2370
  2. package/lib/internal.d.ts +4 -4
  3. package/lib/types/acs.d.ts +212 -172
  4. package/lib/types/admin.d.ts +331 -291
  5. package/lib/types/aily.d.ts +331 -216
  6. package/lib/types/apaas.d.ts +646 -494
  7. package/lib/types/application.d.ts +559 -458
  8. package/lib/types/approval.d.ts +826 -791
  9. package/lib/types/attendance.d.ts +1094 -994
  10. package/lib/types/auth.d.ts +66 -61
  11. package/lib/types/authen.d.ts +221 -186
  12. package/lib/types/baike.d.ts +258 -233
  13. package/lib/types/base.d.ts +74 -0
  14. package/lib/types/bitable.d.ts +830 -770
  15. package/lib/types/board.d.ts +29 -14
  16. package/lib/types/calendar.d.ts +660 -605
  17. package/lib/types/cardkit.d.ts +149 -134
  18. package/lib/types/compensation.d.ts +84 -49
  19. package/lib/types/contact.d.ts +1279 -1204
  20. package/lib/types/corehr.d.ts +4982 -4526
  21. package/lib/types/directory.d.ts +447 -0
  22. package/lib/types/docs.d.ts +28 -18
  23. package/lib/types/document_ai.d.ts +347 -252
  24. package/lib/types/docx.d.ts +428 -383
  25. package/lib/types/drive.d.ts +1093 -1048
  26. package/lib/types/ehr.d.ts +66 -51
  27. package/lib/types/event.d.ts +16 -6
  28. package/lib/types/helpdesk.d.ts +816 -741
  29. package/lib/types/hire.d.ts +3955 -3589
  30. package/lib/types/human_authentication.d.ts +32 -22
  31. package/lib/types/im.d.ts +1420 -1295
  32. package/lib/types/index.d.ts +1422 -330
  33. package/lib/types/lingo.d.ts +279 -249
  34. package/lib/types/mail.d.ts +1032 -675
  35. package/lib/types/mdm.d.ts +105 -37
  36. package/lib/types/minutes.d.ts +73 -26
  37. package/lib/types/moments.d.ts +23 -13
  38. package/lib/types/okr.d.ts +266 -225
  39. package/lib/types/optical_char_recognition.d.ts +22 -12
  40. package/lib/types/passport.d.ts +58 -48
  41. package/lib/types/payroll.d.ts +210 -53
  42. package/lib/types/performance.d.ts +463 -414
  43. package/lib/types/personal_settings.d.ts +93 -82
  44. package/lib/types/report.d.ts +79 -58
  45. package/lib/types/search.d.ts +265 -235
  46. package/lib/types/security_and_compliance.d.ts +30 -19
  47. package/lib/types/sheets.d.ts +356 -321
  48. package/lib/types/speech_to_text.d.ts +44 -34
  49. package/lib/types/task.d.ts +998 -1087
  50. package/lib/types/tenant.d.ts +25 -15
  51. package/lib/types/translation.d.ts +42 -32
  52. package/lib/types/trust_party.d.ts +81 -0
  53. package/lib/types/vc.d.ts +1218 -1123
  54. package/lib/types/verification.d.ts +11 -6
  55. package/lib/types/wiki.d.ts +270 -235
  56. package/lib/types/workplace.d.ts +58 -38
  57. package/lib/utils.d.ts +2 -2
  58. package/package.json +4 -4
  59. package/src/bot.ts +15 -15
  60. package/src/internal.ts +29 -12
  61. package/src/message.ts +10 -10
  62. package/src/types/acs.ts +234 -186
  63. package/src/types/admin.ts +353 -305
  64. package/src/types/aily.ts +375 -233
  65. package/src/types/apaas.ts +754 -568
  66. package/src/types/application.ts +633 -507
  67. package/src/types/approval.ts +914 -872
  68. package/src/types/attendance.ts +1226 -1104
  69. package/src/types/auth.ts +72 -66
  70. package/src/types/authen.ts +233 -191
  71. package/src/types/baike.ts +276 -246
  72. package/src/types/base.ts +93 -0
  73. package/src/types/bitable.ts +966 -894
  74. package/src/types/board.ts +34 -16
  75. package/src/types/calendar.ts +751 -685
  76. package/src/types/cardkit.ts +164 -146
  77. package/src/types/compensation.ts +97 -55
  78. package/src/types/contact.ts +1465 -1375
  79. package/src/types/corehr.ts +5664 -5077
  80. package/src/types/directory.ts +569 -0
  81. package/src/types/docs.ts +31 -19
  82. package/src/types/document_ai.ts +401 -287
  83. package/src/types/docx.ts +492 -438
  84. package/src/types/drive.ts +1266 -1213
  85. package/src/types/ehr.ts +71 -53
  86. package/src/types/event.ts +19 -7
  87. package/src/types/helpdesk.ts +930 -840
  88. package/src/types/hire.ts +4453 -4019
  89. package/src/types/human_authentication.ts +35 -23
  90. package/src/types/im.ts +1626 -1476
  91. package/src/types/index.ts +1532 -346
  92. package/src/types/lingo.ts +299 -263
  93. package/src/types/mail.ts +1231 -779
  94. package/src/types/mdm.ts +122 -39
  95. package/src/types/minutes.ts +88 -28
  96. package/src/types/moments.ts +26 -14
  97. package/src/types/okr.ts +286 -238
  98. package/src/types/optical_char_recognition.ts +25 -13
  99. package/src/types/passport.ts +62 -50
  100. package/src/types/payroll.ts +254 -57
  101. package/src/types/performance.ts +528 -467
  102. package/src/types/personal_settings.ts +101 -89
  103. package/src/types/report.ts +86 -62
  104. package/src/types/search.ts +285 -249
  105. package/src/types/security_and_compliance.ts +33 -21
  106. package/src/types/sheets.ts +421 -379
  107. package/src/types/speech_to_text.ts +48 -36
  108. package/src/types/task.ts +1152 -1260
  109. package/src/types/tenant.ts +29 -17
  110. package/src/types/translation.ts +46 -34
  111. package/src/types/trust_party.ts +110 -0
  112. package/src/types/vc.ts +1397 -1283
  113. package/src/types/verification.ts +13 -7
  114. package/src/types/wiki.ts +293 -251
  115. package/src/types/workplace.ts +65 -41
  116. package/src/utils.ts +3 -3
package/lib/types/vc.d.ts CHANGED
@@ -1,1128 +1,1223 @@
1
- import { Alert, ApprovalConfig, Device, DisableInformConfig, Meeting, MeetingInfo, MeetingInviteStatus, MeetingParticipantResult, MeetingRecording, MeetingUser, Participant, ParticipantQuality, RecordingPermissionObject, Report, ReportTopUser, Reserve, ReserveAdminConfig, ReserveCorrectionCheckInfo, ReserveFormConfig, ReserveMeetingSetting, ReserveScopeConfig, Room, RoomConfig, RoomDigitalSignage, RoomLevel, RoomMeetingReservation, RoomStatus, ScopeConfig, TimeConfig } from '.';
2
- import { Pagination } from '../internal';
1
+ import * as Lark from '.';
2
+ import { Paginated, Pagination } from '../internal';
3
3
  declare module '../internal' {
4
4
  interface Internal {
5
- /**
6
- * 预约会议
7
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve/apply
8
- */
9
- applyVcReserve(body: ApplyVcReserveRequest, query?: ApplyVcReserveQuery): Promise<ApplyVcReserveResponse>;
10
- /**
11
- * 删除预约
12
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve/delete
13
- */
14
- deleteVcReserve(reserve_id: string): Promise<void>;
15
- /**
16
- * 更新预约
17
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve/update
18
- */
19
- updateVcReserve(reserve_id: string, body: UpdateVcReserveRequest, query?: UpdateVcReserveQuery): Promise<UpdateVcReserveResponse>;
20
- /**
21
- * 获取预约
22
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve/get
23
- */
24
- getVcReserve(reserve_id: string, query?: GetVcReserveQuery): Promise<GetVcReserveResponse>;
25
- /**
26
- * 获取活跃会议
27
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve/get_active_meeting
28
- */
29
- getActiveMeetingVcReserve(reserve_id: string, query?: GetActiveMeetingVcReserveQuery): Promise<GetActiveMeetingVcReserveResponse>;
30
- /**
31
- * 邀请参会人
32
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting/invite
33
- */
34
- inviteVcMeeting(meeting_id: string, body: InviteVcMeetingRequest, query?: InviteVcMeetingQuery): Promise<InviteVcMeetingResponse>;
35
- /**
36
- * 移除参会人
37
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting/kickout
38
- */
39
- kickoutVcMeeting(meeting_id: string, body: KickoutVcMeetingRequest, query?: KickoutVcMeetingQuery): Promise<KickoutVcMeetingResponse>;
40
- /**
41
- * 设置主持人
42
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting/set_host
43
- */
44
- setHostVcMeeting(meeting_id: string, body: SetHostVcMeetingRequest, query?: SetHostVcMeetingQuery): Promise<SetHostVcMeetingResponse>;
45
- /**
46
- * 结束会议
47
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting/end
48
- */
49
- endVcMeeting(meeting_id: string): Promise<void>;
50
- /**
51
- * 获取会议详情
52
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting/get
53
- */
54
- getVcMeeting(meeting_id: string, query?: GetVcMeetingQuery): Promise<GetVcMeetingResponse>;
55
- /**
56
- * 获取与会议号关联的会议列表
57
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting/list_by_no
58
- */
59
- listByNoVcMeeting(query?: ListByNoVcMeetingQuery): Paginated<Meeting, 'meeting_briefs'>;
60
- /**
61
- * 开始录制
62
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting-recording/start
63
- */
64
- startVcMeetingRecording(meeting_id: string, body: StartVcMeetingRecordingRequest): Promise<void>;
65
- /**
66
- * 停止录制
67
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting-recording/stop
68
- */
69
- stopVcMeetingRecording(meeting_id: string): Promise<void>;
70
- /**
71
- * 获取录制文件
72
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting-recording/get
73
- */
74
- getVcMeetingRecording(meeting_id: string): Promise<GetVcMeetingRecordingResponse>;
75
- /**
76
- * 授权录制文件
77
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting-recording/set_permission
78
- */
79
- setPermissionVcMeetingRecording(meeting_id: string, body: SetPermissionVcMeetingRecordingRequest, query?: SetPermissionVcMeetingRecordingQuery): Promise<void>;
80
- /**
81
- * 获取会议报告
82
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/report/get_daily
83
- */
84
- getDailyVcReport(query?: GetDailyVcReportQuery): Promise<GetDailyVcReportResponse>;
85
- /**
86
- * 获取 Top 用户列表
87
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/report/get_top_user
88
- */
89
- getTopUserVcReport(query?: GetTopUserVcReportQuery): Promise<GetTopUserVcReportResponse>;
90
- /**
91
- * 导出会议明细
92
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/export/meeting_list
93
- */
94
- meetingListVcExport(body: MeetingListVcExportRequest, query?: MeetingListVcExportQuery): Promise<MeetingListVcExportResponse>;
95
- /**
96
- * 导出参会人明细
97
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/export/participant_list
98
- */
99
- participantListVcExport(body: ParticipantListVcExportRequest, query?: ParticipantListVcExportQuery): Promise<ParticipantListVcExportResponse>;
100
- /**
101
- * 导出参会人会议质量数据
102
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/export/participant_quality_list
103
- */
104
- participantQualityListVcExport(body: ParticipantQualityListVcExportRequest, query?: ParticipantQualityListVcExportQuery): Promise<ParticipantQualityListVcExportResponse>;
105
- /**
106
- * 导出会议室预定数据
107
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/export/resource_reservation_list
108
- */
109
- resourceReservationListVcExport(body: ResourceReservationListVcExportRequest): Promise<ResourceReservationListVcExportResponse>;
110
- /**
111
- * 查询导出任务结果
112
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/export/get
113
- */
114
- getVcExport(task_id: string): Promise<GetVcExportResponse>;
115
- /**
116
- * 下载导出文件
117
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/export/download
118
- */
119
- downloadVcExport(query?: DownloadVcExportQuery): Promise<ArrayBuffer>;
120
- /**
121
- * 创建会议室层级
122
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room_level/create
123
- */
124
- createVcRoomLevel(body: CreateVcRoomLevelRequest): Promise<CreateVcRoomLevelResponse>;
125
- /**
126
- * 删除会议室层级
127
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room_level/del
128
- */
129
- delVcRoomLevel(body: DelVcRoomLevelRequest): Promise<void>;
130
- /**
131
- * 更新会议室层级
132
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room_level/patch
133
- */
134
- patchVcRoomLevel(room_level_id: string, body: PatchVcRoomLevelRequest): Promise<void>;
135
- /**
136
- * 查询会议室层级详情
137
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room_level/get
138
- */
139
- getVcRoomLevel(room_level_id: string): Promise<GetVcRoomLevelResponse>;
140
- /**
141
- * 批量查询会议室层级详情
142
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room_level/mget
143
- */
144
- mgetVcRoomLevel(body: MgetVcRoomLevelRequest): Promise<MgetVcRoomLevelResponse>;
145
- /**
146
- * 查询会议室层级列表
147
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room_level/list
148
- */
149
- listVcRoomLevel(query?: ListVcRoomLevelQuery): Paginated<RoomLevel>;
150
- /**
151
- * 搜索会议室层级
152
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room_level/search
153
- */
154
- searchVcRoomLevel(query?: SearchVcRoomLevelQuery): Promise<SearchVcRoomLevelResponse>;
155
- /**
156
- * 创建会议室
157
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room/create
158
- */
159
- createVcRoom(body: CreateVcRoomRequest, query?: CreateVcRoomQuery): Promise<CreateVcRoomResponse>;
160
- /**
161
- * 删除会议室
162
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room/delete
163
- */
164
- deleteVcRoom(room_id: string): Promise<void>;
165
- /**
166
- * 更新会议室
167
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room/patch
168
- */
169
- patchVcRoom(room_id: string, body: PatchVcRoomRequest, query?: PatchVcRoomQuery): Promise<void>;
170
- /**
171
- * 查询会议室详情
172
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room/get
173
- */
174
- getVcRoom(room_id: string, query?: GetVcRoomQuery): Promise<GetVcRoomResponse>;
175
- /**
176
- * 批量查询会议室详情
177
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room/mget
178
- */
179
- mgetVcRoom(body: MgetVcRoomRequest, query?: MgetVcRoomQuery): Promise<MgetVcRoomResponse>;
180
- /**
181
- * 查询会议室列表
182
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room/list
183
- */
184
- listVcRoom(query?: ListVcRoomQuery): Paginated<Room, 'rooms'>;
185
- /**
186
- * 搜索会议室
187
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room/search
188
- */
189
- searchVcRoom(body: SearchVcRoomRequest, query?: SearchVcRoomQuery): Paginated<Room, 'rooms'>;
190
- /**
191
- * 查询会议室配置
192
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/scope_config/get
193
- */
194
- getVcScopeConfig(query?: GetVcScopeConfigQuery): Promise<GetVcScopeConfigResponse>;
195
- /**
196
- * 设置会议室配置
197
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/scope_config/create
198
- */
199
- createVcScopeConfig(body: CreateVcScopeConfigRequest, query?: CreateVcScopeConfigQuery): Promise<void>;
200
- /**
201
- * 查询会议室预定限制
202
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve_config/reserve_scope
203
- */
204
- reserveScopeVcReserveConfig(query?: ReserveScopeVcReserveConfigQuery): Promise<ReserveScopeVcReserveConfigResponse>;
205
- /**
206
- * 更新会议室预定限制
207
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve_config/patch
208
- */
209
- patchVcReserveConfig(reserve_config_id: string, body: PatchVcReserveConfigRequest, query?: PatchVcReserveConfigQuery): Promise<void>;
210
- /**
211
- * 查询会议室预定表单
212
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve_config-form/get
213
- */
214
- getVcReserveConfigForm(reserve_config_id: string, query?: GetVcReserveConfigFormQuery): Promise<GetVcReserveConfigFormResponse>;
215
- /**
216
- * 更新会议室预定表单
217
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve_config-form/patch
218
- */
219
- patchVcReserveConfigForm(reserve_config_id: string, body: PatchVcReserveConfigFormRequest, query?: PatchVcReserveConfigFormQuery): Promise<void>;
220
- /**
221
- * 查询会议室预定管理员
222
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve_config-admin/get
223
- */
224
- getVcReserveConfigAdmin(reserve_config_id: string, query?: GetVcReserveConfigAdminQuery): Promise<GetVcReserveConfigAdminResponse>;
225
- /**
226
- * 更新会议室预定管理员
227
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve_config-admin/patch
228
- */
229
- patchVcReserveConfigAdmin(reserve_config_id: string, body: PatchVcReserveConfigAdminRequest, query?: PatchVcReserveConfigAdminQuery): Promise<void>;
230
- /**
231
- * 查询禁用状态变更通知
232
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve_config-disable_inform/get
233
- */
234
- getVcReserveConfigDisableInform(reserve_config_id: string, query?: GetVcReserveConfigDisableInformQuery): Promise<GetVcReserveConfigDisableInformResponse>;
235
- /**
236
- * 更新禁用状态变更通知
237
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve_config-disable_inform/patch
238
- */
239
- patchVcReserveConfigDisableInform(reserve_config_id: string, body: PatchVcReserveConfigDisableInformRequest, query?: PatchVcReserveConfigDisableInformQuery): Promise<void>;
240
- /**
241
- * 查询会议明细
242
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting_list/get
243
- */
244
- getVcMeetingList(query?: GetVcMeetingListQuery): Paginated<MeetingInfo, 'meeting_list'>;
245
- /**
246
- * 查询参会人明细
247
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/participant_list/get
248
- */
249
- getVcParticipantList(query?: GetVcParticipantListQuery): Paginated<Participant, 'participants'>;
250
- /**
251
- * 查询参会人会议质量数据
252
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/participant_quality_list/get
253
- */
254
- getVcParticipantQualityList(query?: GetVcParticipantQualityListQuery): Paginated<ParticipantQuality, 'participant_quality_list'>;
255
- /**
256
- * 查询会议室预定数据
257
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/resource_reservation_list/get
258
- */
259
- getVcResourceReservationList(query?: GetVcResourceReservationListQuery): Paginated<RoomMeetingReservation, 'room_reservation_list'>;
260
- /**
261
- * 获取告警记录
262
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/alert/list
263
- */
264
- listVcAlert(query?: ListVcAlertQuery): Paginated<Alert>;
265
- /**
266
- * 创建签到板部署码
267
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room_config/set_checkboard_access_code
268
- */
269
- setCheckboardAccessCodeVcRoomConfig(body: SetCheckboardAccessCodeVcRoomConfigRequest): Promise<SetCheckboardAccessCodeVcRoomConfigResponse>;
270
- /**
271
- * 创建会议室部署码
272
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room_config/set_room_access_code
273
- */
274
- setRoomAccessCodeVcRoomConfig(body: SetRoomAccessCodeVcRoomConfigRequest): Promise<SetRoomAccessCodeVcRoomConfigResponse>;
275
- /**
276
- * 查询会议室配置
277
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room_config/query
278
- */
279
- queryVcRoomConfig(query?: QueryVcRoomConfigQuery): Promise<QueryVcRoomConfigResponse>;
280
- /**
281
- * 设置会议室配置
282
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room_config/set
283
- */
284
- setVcRoomConfig(body: SetVcRoomConfigRequest, query?: SetVcRoomConfigQuery): Promise<void>;
5
+ vc: Vc.Methods;
285
6
  }
286
7
  }
287
- export interface ApplyVcReserveRequest {
288
- /** 预约到期时间（unix时间，单位sec），多人会议必填 */
289
- end_time?: string;
290
- /** 指定会议归属人，使用tenant_access_token时生效且必传，使用user_access_token时不生效，必须指定为同租户下的合法lark用户 */
291
- owner_id?: string;
292
- /** 会议设置 */
293
- meeting_settings: ReserveMeetingSetting;
294
- }
295
- export interface ApplyVcReserveQuery {
296
- /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */
297
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
298
- }
299
- export interface ApplyVcReserveResponse {
300
- reserve?: Reserve;
301
- reserve_correction_check_info?: ReserveCorrectionCheckInfo;
302
- }
303
- export interface UpdateVcReserveRequest {
304
- /** 预约到期时间（unix时间，单位sec） */
305
- end_time?: string;
306
- /** 会议设置 */
307
- meeting_settings?: ReserveMeetingSetting;
308
- }
309
- export interface UpdateVcReserveQuery {
310
- /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */
311
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
312
- }
313
- export interface UpdateVcReserveResponse {
314
- reserve?: Reserve;
315
- reserve_correction_check_info?: ReserveCorrectionCheckInfo;
316
- }
317
- export interface GetVcReserveQuery {
318
- /** 此次调用中使用的用户ID的类型 */
319
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
320
- }
321
- export interface GetVcReserveResponse {
322
- reserve?: Reserve;
323
- }
324
- export interface GetActiveMeetingVcReserveQuery {
325
- /** 是否需要参会人列表，默认为false */
326
- with_participants?: boolean;
327
- /** 此次调用中使用的用户ID的类型 */
328
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
329
- }
330
- export interface GetActiveMeetingVcReserveResponse {
331
- meeting?: Meeting;
332
- }
333
- export interface InviteVcMeetingRequest {
334
- /** 被邀请的用户列表 */
335
- invitees: MeetingUser[];
336
- }
337
- export interface InviteVcMeetingQuery {
338
- /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */
339
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
340
- }
341
- export interface InviteVcMeetingResponse {
342
- /** 邀请结果 */
343
- invite_results?: MeetingInviteStatus[];
344
- }
345
- export interface KickoutVcMeetingRequest {
346
- /** 需踢出的用户列表 */
347
- kickout_users: MeetingUser[];
348
- }
349
- export interface KickoutVcMeetingQuery {
350
- /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */
351
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
352
- }
353
- export interface KickoutVcMeetingResponse {
354
- /** 踢出结果 */
355
- kickout_results?: MeetingParticipantResult[];
356
- }
357
- export interface SetHostVcMeetingRequest {
358
- /** 将要设置的主持人 */
359
- host_user: MeetingUser;
360
- /** 当前主持人（CAS并发安全：如果和会中当前主持人不符则会设置失败，可使用返回的最新数据重新设置） */
361
- old_host_user?: MeetingUser;
362
- }
363
- export interface SetHostVcMeetingQuery {
364
- /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */
365
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
366
- }
367
- export interface SetHostVcMeetingResponse {
368
- /** 会中当前主持人 */
369
- host_user?: MeetingUser;
370
- }
371
- export interface GetVcMeetingQuery {
372
- /** 是否需要参会人列表 */
373
- with_participants?: boolean;
374
- /** 是否需要会中使用能力统计（仅限tenant_access_token） */
375
- with_meeting_ability?: boolean;
376
- /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */
377
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
378
- }
379
- export interface GetVcMeetingResponse {
380
- meeting?: Meeting;
381
- }
382
- export interface ListByNoVcMeetingQuery extends Pagination {
383
- /** 9位会议号 */
384
- meeting_no: string;
385
- /** 查询开始时间（unix时间，单位sec） */
386
- start_time: string;
387
- /** 查询结束时间（unix时间，单位sec） */
388
- end_time: string;
389
- }
390
- export interface StartVcMeetingRecordingRequest {
391
- /** 录制文件时间显示使用的时区[-12,12] */
392
- timezone?: number;
393
- }
394
- export interface GetVcMeetingRecordingResponse {
395
- recording?: MeetingRecording;
396
- }
397
- export declare const enum SetPermissionVcMeetingRecordingRequestActionType {
398
- /** 授权 */
399
- Authorize = 0,
400
- /** 取消授权 */
401
- Revoke = 1
402
- }
403
- export interface SetPermissionVcMeetingRecordingRequest {
404
- /** 授权对象列表 */
405
- permission_objects: RecordingPermissionObject[];
406
- /** 授权或者取消授权，默认授权 */
407
- action_type?: SetPermissionVcMeetingRecordingRequestActionType;
408
- }
409
- export interface SetPermissionVcMeetingRecordingQuery {
410
- /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */
411
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
412
- }
413
- export declare const enum GetDailyVcReportQueryUnit {
414
- /** 中国大陆 */
415
- CN = 0,
416
- /** 美国 */
417
- VA = 1,
418
- /** 新加坡 */
419
- SG = 2,
420
- /** 日本 */
421
- JP = 3
422
- }
423
- export interface GetDailyVcReportQuery {
424
- /** 开始时间（unix时间，单位sec） */
425
- start_time: string;
426
- /** 结束时间（unix时间，单位sec） */
427
- end_time: string;
428
- /** 数据驻留地 */
429
- unit?: GetDailyVcReportQueryUnit;
430
- }
431
- export interface GetDailyVcReportResponse {
432
- /** 会议报告 */
433
- meeting_report?: Report;
434
- }
435
- export declare const enum GetTopUserVcReportQueryOrderBy {
436
- /** 会议数量 */
437
- MeetingCount = 1,
438
- /** 会议时长 */
439
- MeetingDuration = 2
440
- }
441
- export declare const enum GetTopUserVcReportQueryUnit {
442
- /** 中国大陆 */
443
- CN = 0,
444
- /** 美国 */
445
- VA = 1,
446
- /** 新加坡 */
447
- SG = 2,
448
- /** 日本 */
449
- JP = 3
450
- }
451
- export interface GetTopUserVcReportQuery {
452
- /** 开始时间（unix时间，单位sec） */
453
- start_time: string;
454
- /** 结束时间（unix时间，单位sec） */
455
- end_time: string;
456
- /** 取前多少位 */
457
- limit: number;
458
- /** 排序依据（降序） */
459
- order_by: GetTopUserVcReportQueryOrderBy;
460
- /** 数据驻留地 */
461
- unit?: GetTopUserVcReportQueryUnit;
462
- /** 此次调用中使用的用户ID的类型 */
463
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
464
- }
465
- export interface GetTopUserVcReportResponse {
466
- /** top用户列表 */
467
- top_user_report?: ReportTopUser[];
468
- }
469
- export declare const enum MeetingListVcExportRequestMeetingStatus {
470
- /** 进行中 */
471
- Ongoing = 1,
472
- /** 已结束 */
473
- Past = 2,
474
- /** 待召开 */
475
- Future = 3
476
- }
477
- export declare const enum MeetingListVcExportRequestMeetingType {
478
- /** 全部类型（默认） */
479
- All = 1,
480
- /** 视频会议 */
481
- Meeting = 2,
482
- /** 本地投屏 */
483
- ShareScreen = 3
484
- }
485
- export interface MeetingListVcExportRequest {
486
- /** 查询开始时间（unix时间，单位sec） */
487
- start_time: string;
488
- /** 查询结束时间（unix时间，单位sec） */
489
- end_time: string;
490
- /** 会议状态（不传默认为已结束会议） */
491
- meeting_status?: MeetingListVcExportRequestMeetingStatus;
492
- /** 按9位会议号筛选（最多一个筛选条件） */
493
- meeting_no?: string;
494
- /** 按参会Lark用户筛选（最多一个筛选条件） */
495
- user_id?: string;
496
- /** 按参会Rooms筛选（最多一个筛选条件） */
497
- room_id?: string;
498
- /** 按会议类型筛选（最多一个筛选条件） */
499
- meeting_type?: MeetingListVcExportRequestMeetingType;
500
- }
501
- export interface MeetingListVcExportQuery {
502
- /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */
503
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
504
- }
505
- export interface MeetingListVcExportResponse {
506
- /** 任务id */
507
- task_id?: string;
508
- }
509
- export declare const enum ParticipantListVcExportRequestMeetingStatus {
510
- /** 进行中 */
511
- Ongoing = 1,
512
- /** 已结束 */
513
- Past = 2,
514
- /** 待召开 */
515
- Future = 3
516
- }
517
- export interface ParticipantListVcExportRequest {
518
- /** 会议开始时间（unix时间，单位sec） */
519
- meeting_start_time: string;
520
- /** 会议结束时间（unix时间，单位sec） */
521
- meeting_end_time: string;
522
- /** 会议状态（不传默认为已结束会议） */
523
- meeting_status?: ParticipantListVcExportRequestMeetingStatus;
524
- /** 9位会议号 */
525
- meeting_no: string;
526
- /** 按参会Lark用户筛选（最多一个筛选条件） */
527
- user_id?: string;
528
- /** 按参会Rooms筛选（最多一个筛选条件） */
529
- room_id?: string;
530
- }
531
- export interface ParticipantListVcExportQuery {
532
- /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */
533
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
534
- }
535
- export interface ParticipantListVcExportResponse {
536
- /** 任务id */
537
- task_id?: string;
538
- }
539
- export interface ParticipantQualityListVcExportRequest {
540
- /** 会议开始时间（unix时间，单位sec） */
541
- meeting_start_time: string;
542
- /** 会议结束时间（unix时间，单位sec） */
543
- meeting_end_time: string;
544
- /** 9位会议号 */
545
- meeting_no: string;
546
- /** 参会人入会时间（unix时间，单位sec） */
547
- join_time: string;
548
- /** 参会人为Lark用户时填入 */
549
- user_id?: string;
550
- /** 参会人为Rooms时填入 */
551
- room_id?: string;
552
- }
553
- export interface ParticipantQualityListVcExportQuery {
554
- /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */
555
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
556
- }
557
- export interface ParticipantQualityListVcExportResponse {
558
- /** 任务id */
559
- task_id?: string;
560
- }
561
- export interface ResourceReservationListVcExportRequest {
562
- /** 层级id */
563
- room_level_id: string;
564
- /** 是否展示会议主题 */
565
- need_topic?: boolean;
566
- /** 查询开始时间（unix时间，单位sec） */
567
- start_time: string;
568
- /** 查询结束时间（unix时间，单位sec） */
569
- end_time: string;
570
- /** 待筛选的会议室id列表 */
571
- room_ids?: string[];
572
- /** 若为true表示导出room_ids范围外的会议室，默认为false */
573
- is_exclude?: boolean;
574
- }
575
- export interface ResourceReservationListVcExportResponse {
576
- /** 任务id */
577
- task_id?: string;
578
- }
579
- export declare const enum GetVcExportResponseStatus {
580
- /** 处理中 */
581
- InProgress = 1,
582
- /** 失败 */
583
- Failed = 2,
584
- /** 完成 */
585
- Done = 3
586
- }
587
- export interface GetVcExportResponse {
588
- /** 任务状态 */
589
- status: GetVcExportResponseStatus;
590
- /** 文件下载地址 */
591
- url?: string;
592
- /** 文件token */
593
- file_token?: string;
594
- /** 失败信息 */
595
- fail_msg?: string;
596
- }
597
- export interface DownloadVcExportQuery {
598
- /** 文档token */
599
- file_token: string;
600
- }
601
- export interface CreateVcRoomLevelRequest {
602
- /** 层级名称 */
603
- name: string;
604
- /** 父层级ID */
605
- parent_id: string;
606
- /** 自定义层级ID */
607
- custom_group_id?: string;
608
- }
609
- export interface CreateVcRoomLevelResponse {
610
- room_level?: RoomLevel;
611
- }
612
- export interface DelVcRoomLevelRequest {
613
- /** 层级ID */
614
- room_level_id: string;
615
- /** 是否删除所有子层级 */
616
- delete_child?: boolean;
617
- }
618
- export interface PatchVcRoomLevelRequest {
619
- /** 层级名称 */
620
- name: string;
621
- /** 父层级ID */
622
- parent_id: string;
623
- /** 自定义层级ID */
624
- custom_group_id?: string;
625
- }
626
- export interface GetVcRoomLevelResponse {
627
- room_level?: RoomLevel;
628
- }
629
- export interface MgetVcRoomLevelRequest {
630
- /** 层级id列表 */
631
- level_ids: string[];
632
- }
633
- export interface MgetVcRoomLevelResponse {
634
- /** 层级列表 */
635
- items?: RoomLevel[];
636
- }
637
- export interface ListVcRoomLevelQuery extends Pagination {
638
- /** 层级ID，不传则返回该租户下第一层级列表 */
639
- room_level_id?: string;
640
- }
641
- export interface SearchVcRoomLevelQuery {
642
- /** 用于查询指定会议室的租户自定义会议室ID */
643
- custom_level_ids: string;
644
- }
645
- export interface SearchVcRoomLevelResponse {
646
- /** 层级id列表 */
647
- level_ids?: string[];
648
- }
649
- export interface CreateVcRoomRequest {
650
- /** 会议室名称 */
651
- name: string;
652
- /** 会议室能容纳的人数 */
653
- capacity: number;
654
- /** 会议室的相关描述 */
655
- description?: string;
656
- /** 自定义的会议室ID */
657
- custom_room_id?: string;
658
- /** 层级ID */
659
- room_level_id: string;
660
- /** 会议室状态 */
661
- room_status?: RoomStatus;
662
- /** 设施信息列表 */
663
- device?: Device[];
664
- }
665
- export interface CreateVcRoomQuery {
666
- /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */
667
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
668
- }
669
- export interface CreateVcRoomResponse {
670
- room?: Room;
671
- }
672
- export interface PatchVcRoomRequest {
673
- /** 会议室名称 */
674
- name?: string;
675
- /** 会议室能容纳的人数 */
676
- capacity?: number;
677
- /** 会议室的相关描述 */
678
- description?: string;
679
- /** 自定义的会议室ID */
680
- custom_room_id?: string;
681
- /** 层级ID */
682
- room_level_id?: string;
683
- /** 会议室状态 */
684
- room_status?: RoomStatus;
685
- /** 设施信息列表 */
686
- device?: Device[];
687
- }
688
- export interface PatchVcRoomQuery {
689
- /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */
690
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
691
- }
692
- export interface GetVcRoomQuery {
693
- /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */
694
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
695
- }
696
- export interface GetVcRoomResponse {
697
- room?: Room;
698
- }
699
- export interface MgetVcRoomRequest {
700
- /** 会议室id列表 */
701
- room_ids: string[];
702
- }
703
- export interface MgetVcRoomQuery {
704
- /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */
705
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
706
- }
707
- export interface MgetVcRoomResponse {
708
- /** 会议室列表 */
709
- items?: Room[];
710
- }
711
- export interface ListVcRoomQuery extends Pagination {
712
- /** 层级ID，不传则返回该租户下的所有会议室 */
713
- room_level_id?: string;
714
- /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */
715
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
716
- }
717
- export interface SearchVcRoomRequest {
718
- /** 用于查询指定会议室的租户自定义会议室ID列表，优先使用该字段进行查询 */
719
- custom_room_ids?: string[];
720
- /** 会议室搜索关键词（当custom_room_ids为空时，使用该字段进行查询） */
721
- keyword?: string;
722
- /** 在该会议室层级下进行搜索 */
723
- room_level_id?: string;
724
- /** 搜索会议室是否包括层级名称 */
725
- search_level_name?: boolean;
726
- /** 分页大小，该值默认为10，最大为100 */
727
- page_size?: number;
728
- /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */
729
- page_token?: string;
730
- }
731
- export interface SearchVcRoomQuery {
732
- /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */
733
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
734
- }
735
- export declare const enum GetVcScopeConfigQueryScopeType {
736
- /** 会议室层级 */
737
- RoomLevel = 1,
738
- /** 会议室 */
739
- Room = 2
740
- }
741
- export interface GetVcScopeConfigQuery {
742
- /** 查询节点范围 */
743
- scope_type: GetVcScopeConfigQueryScopeType;
744
- /** 查询节点ID：如果scope_type为1，则为层级ID，如果scope_type为2，则为会议室ID */
745
- scope_id: string;
746
- /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */
747
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
748
- }
749
- export interface GetVcScopeConfigResponse {
750
- /** 当前节点的配置，根据层级顺序从底向上进行合并计算后的结果；如果当前节点某个值已配置，则取该节点的值，否则会从该节点的父层级节点获取，如果父节点依然未配置，则继续向上递归获取；若所有节点均未配置，则该值返回为空 */
751
- current_config?: ScopeConfig;
752
- /** 所有节点的原始配置，按照层级顺序从底向上返回；如果某节点某个值未配置，则该值返回为空 */
753
- origin_configs?: ScopeConfig[];
754
- }
755
- export declare const enum CreateVcScopeConfigRequestScopeType {
756
- /** 会议室层级 */
757
- RoomLevel = 1,
758
- /** 会议室 */
759
- Room = 2
760
- }
761
- export interface CreateVcScopeConfigRequest {
762
- /** 查询节点范围 */
763
- scope_type: CreateVcScopeConfigRequestScopeType;
764
- /** 查询节点ID：如果scope_type为1，则为层级ID，如果scope_type为2，则为会议室ID */
765
- scope_id: string;
766
- /** 节点配置 */
767
- scope_config?: RoomConfig;
768
- }
769
- export interface CreateVcScopeConfigQuery {
770
- /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */
771
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
772
- }
773
- export interface ReserveScopeVcReserveConfigQuery {
774
- /** 会议室或层级id */
775
- scope_id: string;
776
- /** 1代表层级，2代表会议室 */
777
- scope_type: string;
778
- /** 此次调用中使用的用户ID的类型 */
779
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
780
- }
781
- export interface ReserveScopeVcReserveConfigResponse {
782
- /** 预定审批设置 */
783
- approve_config?: ApprovalConfig;
784
- /** 预定时间设置 */
785
- time_config?: TimeConfig;
786
- /** 预定范围设置 */
787
- reserve_scope_config?: ReserveScopeConfig;
788
- }
789
- export interface PatchVcReserveConfigRequest {
790
- /** 1代表层级，2代表会议室 */
791
- scope_type: string;
792
- /** 预定审批设置 */
793
- approval_config?: ApprovalConfig;
794
- /** 预定时间设置 */
795
- time_config?: TimeConfig;
796
- /** 预定范围设置 */
797
- reserve_scope_config?: ReserveScopeConfig;
798
- }
799
- export interface PatchVcReserveConfigQuery {
800
- /** 此次调用中使用的用户ID的类型 */
801
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
802
- }
803
- export interface GetVcReserveConfigFormQuery {
804
- /** 1代表层级，2代表会议室 */
805
- scope_type: number;
806
- /** 此次调用中使用的用户ID的类型 */
807
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
808
- }
809
- export interface GetVcReserveConfigFormResponse {
810
- /** 预定表单 */
811
- reserve_form_config: ReserveFormConfig;
812
- }
813
- export interface PatchVcReserveConfigFormRequest {
814
- /** 1代表层级，2代表会议室 */
815
- scope_type: number;
816
- /** 预定表单设置 */
817
- reserve_form_config: ReserveFormConfig;
818
- }
819
- export interface PatchVcReserveConfigFormQuery {
820
- /** 此次调用中使用的用户ID的类型 */
821
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
822
- }
823
- export interface GetVcReserveConfigAdminQuery {
824
- /** 会议室或层级 */
825
- scope_type: number;
826
- /** 此次调用中使用的用户ID的类型 */
827
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
828
- }
829
- export interface GetVcReserveConfigAdminResponse {
830
- /** 预定管理员/部门 */
831
- reserve_admin_config: ReserveAdminConfig;
832
- }
833
- export interface PatchVcReserveConfigAdminRequest {
834
- /** 1代表层级，2代表会议室 */
835
- scope_type: number;
836
- /** 预定管理员或部门 */
837
- reserve_admin_config: ReserveAdminConfig;
838
- }
839
- export interface PatchVcReserveConfigAdminQuery {
840
- /** 此次调用中使用的用户ID的类型 */
841
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
842
- }
843
- export interface GetVcReserveConfigDisableInformQuery {
844
- /** 1表示层级，2表示会议室 */
845
- scope_type: number;
846
- /** 此次调用中使用的用户ID的类型 */
847
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
848
- }
849
- export interface GetVcReserveConfigDisableInformResponse {
850
- /** 会议室禁用通知配置 */
851
- disable_inform?: DisableInformConfig;
852
- }
853
- export interface PatchVcReserveConfigDisableInformRequest {
854
- /** 1表示会议室层级，2表示会议室 */
855
- scope_type: number;
856
- /** 禁用通知配置 */
857
- disable_inform: DisableInformConfig;
858
- }
859
- export interface PatchVcReserveConfigDisableInformQuery {
860
- /** 此次调用中使用的用户ID的类型 */
861
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
862
- }
863
- export declare const enum GetVcMeetingListQueryMeetingStatus {
864
- /** 进行中 */
865
- Ongoing = 1,
866
- /** 已结束 */
867
- Past = 2,
868
- /** 待召开 */
869
- Future = 3
870
- }
871
- export declare const enum GetVcMeetingListQueryMeetingType {
872
- /** 全部类型（默认） */
873
- All = 1,
874
- /** 视频会议 */
875
- Meeting = 2,
876
- /** 本地投屏 */
877
- ShareScreen = 3
878
- }
879
- export interface GetVcMeetingListQuery extends Pagination {
880
- /** 查询开始时间（unix时间，单位sec） */
881
- start_time: string;
882
- /** 查询结束时间（unix时间，单位sec） */
883
- end_time: string;
884
- /** 会议状态 */
885
- meeting_status?: GetVcMeetingListQueryMeetingStatus;
886
- /** 按9位会议号筛选（最多一个筛选条件） */
887
- meeting_no?: string;
888
- /** 按参会Lark用户筛选（最多一个筛选条件） */
889
- user_id?: string;
890
- /** 按参会Rooms筛选（最多一个筛选条件） */
891
- room_id?: string;
892
- /** 按会议类型筛选（最多一个筛选条件） */
893
- meeting_type?: GetVcMeetingListQueryMeetingType;
894
- /** 此次调用中使用的用户ID的类型 */
895
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
896
- }
897
- export declare const enum GetVcParticipantListQueryMeetingStatus {
898
- /** 进行中 */
899
- Ongoing = 1,
900
- /** 已结束 */
901
- Past = 2,
902
- /** 待召开 */
903
- Future = 3
904
- }
905
- export interface GetVcParticipantListQuery extends Pagination {
906
- /** 会议开始时间（需要精确到一分钟，unix时间，单位sec） */
907
- meeting_start_time: string;
908
- /** 会议结束时间（unix时间，单位sec；对于进行中会议则传0） */
909
- meeting_end_time: string;
910
- /** 会议状态（不传默认为已结束会议） */
911
- meeting_status?: GetVcParticipantListQueryMeetingStatus;
912
- /** 9位会议号 */
913
- meeting_no: string;
914
- /** 按参会Lark用户筛选（最多一个筛选条件） */
915
- user_id?: string;
916
- /** 按参会Rooms筛选（最多一个筛选条件） */
917
- room_id?: string;
918
- /** 此次调用中使用的用户ID的类型 */
919
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
920
- }
921
- export interface GetVcParticipantQualityListQuery extends Pagination {
922
- /** 会议开始时间（需要精确到一分钟，unix时间，单位sec） */
923
- meeting_start_time: string;
924
- /** 会议结束时间（unix时间，单位sec） */
925
- meeting_end_time: string;
926
- /** 9位会议号 */
927
- meeting_no: string;
928
- /** 参会人入会时间（unix时间，单位sec） */
929
- join_time: string;
930
- /** 参会人为Lark用户时填入 */
931
- user_id?: string;
932
- /** 参会人为Rooms时填入 */
933
- room_id?: string;
934
- /** 此次调用中使用的用户ID的类型 */
935
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
936
- }
937
- export interface GetVcResourceReservationListQuery extends Pagination {
938
- /** 层级id */
939
- room_level_id: string;
940
- /** 是否展示会议主题 */
941
- need_topic?: boolean;
942
- /** 查询开始时间（unix时间，单位sec） */
943
- start_time: string;
944
- /** 查询结束时间（unix时间，单位sec） */
945
- end_time: string;
946
- /** 待筛选的会议室id列表 */
947
- room_ids: string[];
948
- /** 若为true表示导出room_ids范围外的会议室，默认为false */
949
- is_exclude?: boolean;
950
- }
951
- export declare const enum ListVcAlertQueryQueryType {
952
- /** 会议室 */
953
- Room = 1,
954
- /** erc */
955
- Erc = 2,
956
- /** SIP会议室系统 */
957
- Sip = 3
958
- }
959
- export interface ListVcAlertQuery extends Pagination {
960
- /** 开始时间（unix时间，单位sec） */
961
- start_time: string;
962
- /** 结束时间（unix时间，单位sec） */
963
- end_time: string;
964
- /** 查询对象类型 */
965
- query_type?: ListVcAlertQueryQueryType;
966
- /** 查询对象ID */
967
- query_value?: string;
968
- }
969
- export declare const enum SetCheckboardAccessCodeVcRoomConfigRequestScope {
970
- /** 租户 */
971
- Tenant = 1,
972
- /** 国家/地区 */
973
- CountryDistrict = 2,
974
- /** 城市 */
975
- City = 3,
976
- /** 建筑 */
977
- Building = 4,
978
- /** 楼层 */
979
- Floor = 5,
980
- /** 会议室 */
981
- Room = 6
982
- }
983
- export declare const enum SetCheckboardAccessCodeVcRoomConfigRequestValidDay {
984
- /** 1天 */
985
- Day = 1,
986
- /** 7天 */
987
- Week = 7,
988
- /** 30天 */
989
- Month = 30
990
- }
991
- export interface SetCheckboardAccessCodeVcRoomConfigRequest {
992
- /** 设置节点范围 */
993
- scope: SetCheckboardAccessCodeVcRoomConfigRequestScope;
994
- /** 国家/地区ID scope为2，3时需要此参数 */
995
- country_id?: string;
996
- /** 城市ID scope为3时需要此参数 */
997
- district_id?: string;
998
- /** 建筑ID scope为4，5时需要此参数 */
999
- building_id?: string;
1000
- /** 楼层 scope为5时需要此参数 */
1001
- floor_name?: string;
1002
- /** 会议室ID scope为6时需要此参数 */
1003
- room_id?: string;
1004
- /** 有效天数 */
1005
- valid_day: SetCheckboardAccessCodeVcRoomConfigRequestValidDay;
1006
- }
1007
- export interface SetCheckboardAccessCodeVcRoomConfigResponse {
1008
- /** 部署访问码 */
1009
- access_code?: string;
1010
- }
1011
- export declare const enum SetRoomAccessCodeVcRoomConfigRequestScope {
1012
- /** 租户 */
1013
- Tenant = 1,
1014
- /** 国家/地区 */
1015
- CountryDistrict = 2,
1016
- /** 城市 */
1017
- City = 3,
1018
- /** 建筑 */
1019
- Building = 4,
1020
- /** 楼层 */
1021
- Floor = 5,
1022
- /** 会议室 */
1023
- Room = 6
1024
- }
1025
- export declare const enum SetRoomAccessCodeVcRoomConfigRequestValidDay {
1026
- /** 1天 */
1027
- Day = 1,
1028
- /** 7天 */
1029
- Week = 7,
1030
- /** 30天 */
1031
- Month = 30
1032
- }
1033
- export interface SetRoomAccessCodeVcRoomConfigRequest {
1034
- /** 设置节点范围 */
1035
- scope: SetRoomAccessCodeVcRoomConfigRequestScope;
1036
- /** 国家/地区ID scope为2，3时需要此参数 */
1037
- country_id?: string;
1038
- /** 城市ID scope为3时需要此参数 */
1039
- district_id?: string;
1040
- /** 建筑ID scope为4，5时需要此参数 */
1041
- building_id?: string;
1042
- /** 楼层 scope为5时需要此参数 */
1043
- floor_name?: string;
1044
- /** 会议室ID scope为6时需要此参数 */
1045
- room_id?: string;
1046
- /** 有效天数 */
1047
- valid_day: SetRoomAccessCodeVcRoomConfigRequestValidDay;
1048
- }
1049
- export interface SetRoomAccessCodeVcRoomConfigResponse {
1050
- /** 部署访问码 */
1051
- access_code?: string;
1052
- }
1053
- export declare const enum QueryVcRoomConfigQueryScope {
1054
- /** 租户 */
1055
- Tenant = 1,
1056
- /** 国家/地区 */
1057
- CountryDistrict = 2,
1058
- /** 城市 */
1059
- City = 3,
1060
- /** 建筑 */
1061
- Building = 4,
1062
- /** 楼层 */
1063
- Floor = 5,
1064
- /** 会议室 */
1065
- Room = 6
1066
- }
1067
- export interface QueryVcRoomConfigQuery {
1068
- /** 查询节点范围 */
1069
- scope: QueryVcRoomConfigQueryScope;
1070
- /** 国家/地区ID scope为2，3时需要此参数 */
1071
- country_id?: string;
1072
- /** 城市ID scope为3时需要此参数 */
1073
- district_id?: string;
1074
- /** 建筑ID scope为4，5时需要此参数 */
1075
- building_id?: string;
1076
- /** 楼层 scope为5时需要此参数 */
1077
- floor_name?: string;
1078
- /** 会议室ID scope为6时需要此参数 */
1079
- room_id?: string;
1080
- /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */
1081
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
1082
- }
1083
- export interface QueryVcRoomConfigResponse {
1084
- /** 飞书会议室背景图 */
1085
- room_background?: string;
1086
- /** 飞书签到板背景图 */
1087
- display_background?: string;
1088
- /** 飞书会议室数字标牌 */
1089
- digital_signage?: RoomDigitalSignage;
1090
- /** 飞书投屏盒子数字标牌 */
1091
- room_box_digital_signage?: RoomDigitalSignage;
1092
- /** 会议室状态 */
1093
- room_status?: RoomStatus;
1094
- }
1095
- export declare const enum SetVcRoomConfigRequestScope {
1096
- /** 租户 */
1097
- Tenant = 1,
1098
- /** 国家/地区 */
1099
- CountryDistrict = 2,
1100
- /** 城市 */
1101
- City = 3,
1102
- /** 建筑 */
1103
- Building = 4,
1104
- /** 楼层 */
1105
- Floor = 5,
1106
- /** 会议室 */
1107
- Room = 6
1108
- }
1109
- export interface SetVcRoomConfigRequest {
1110
- /** 设置节点范围 */
1111
- scope: SetVcRoomConfigRequestScope;
1112
- /** 国家/地区ID scope为2，3时需要此参数 */
1113
- country_id?: string;
1114
- /** 城市ID scope为3时需要此参数 */
1115
- district_id?: string;
1116
- /** 建筑ID scope为4，5时需要此参数 */
1117
- building_id?: string;
1118
- /** 楼层 scope为5时需要此参数 */
1119
- floor_name?: string;
1120
- /** 会议室ID scope为6时需要此参数 */
1121
- room_id?: string;
1122
- /** 会议室设置 */
1123
- room_config: RoomConfig;
1124
- }
1125
- export interface SetVcRoomConfigQuery {
1126
- /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */
1127
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
8
+ export declare namespace Vc {
9
+ interface Methods {
10
+ reserve: Reserve.Methods;
11
+ meeting: Meeting.Methods;
12
+ report: Report.Methods;
13
+ export: Export.Methods;
14
+ roomLevel: RoomLevel.Methods;
15
+ room: Room.Methods;
16
+ scopeConfig: ScopeConfig.Methods;
17
+ reserveConfig: ReserveConfig.Methods;
18
+ meetingList: MeetingList.Methods;
19
+ participantList: ParticipantList.Methods;
20
+ participantQualityList: ParticipantQualityList.Methods;
21
+ resourceReservationList: ResourceReservationList.Methods;
22
+ alert: Alert.Methods;
23
+ roomConfig: RoomConfig.Methods;
24
+ }
25
+ namespace Reserve {
26
+ interface Methods {
27
+ /**
28
+ * 预约会议
29
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve/apply
30
+ */
31
+ apply(body: ApplyRequest, query?: ApplyQuery): Promise<ApplyResponse>;
32
+ /**
33
+ * 删除预约
34
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve/delete
35
+ */
36
+ delete(reserve_id: string): Promise<void>;
37
+ /**
38
+ * 更新预约
39
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve/update
40
+ */
41
+ update(reserve_id: string, body: UpdateRequest, query?: UpdateQuery): Promise<UpdateResponse>;
42
+ /**
43
+ * 获取预约
44
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve/get
45
+ */
46
+ get(reserve_id: string, query?: GetQuery): Promise<GetResponse>;
47
+ /**
48
+ * 获取活跃会议
49
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve/get_active_meeting
50
+ */
51
+ getActiveMeeting(reserve_id: string, query?: GetActiveMeetingQuery): Promise<GetActiveMeetingResponse>;
52
+ }
53
+ interface ApplyRequest {
54
+ /** 预约到期时间（unix时间，单位sec），多人会议必填 */
55
+ end_time?: string;
56
+ /** 指定会议归属人，使用tenant_access_token时生效且必传，使用user_access_token时不生效，必须指定为同租户下的合法lark用户 */
57
+ owner_id?: string;
58
+ /** 会议设置 */
59
+ meeting_settings: Lark.ReserveMeetingSetting;
60
+ }
61
+ interface ApplyQuery {
62
+ /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */
63
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
64
+ }
65
+ interface ApplyResponse {
66
+ reserve?: Lark.Reserve;
67
+ reserve_correction_check_info?: Lark.ReserveCorrectionCheckInfo;
68
+ }
69
+ interface UpdateRequest {
70
+ /** 预约到期时间（unix时间，单位sec） */
71
+ end_time?: string;
72
+ /** 会议设置 */
73
+ meeting_settings?: Lark.ReserveMeetingSetting;
74
+ }
75
+ interface UpdateQuery {
76
+ /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */
77
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
78
+ }
79
+ interface UpdateResponse {
80
+ reserve?: Lark.Reserve;
81
+ reserve_correction_check_info?: Lark.ReserveCorrectionCheckInfo;
82
+ }
83
+ interface GetQuery {
84
+ /** 此次调用中使用的用户ID的类型 */
85
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
86
+ }
87
+ interface GetResponse {
88
+ reserve?: Lark.Reserve;
89
+ }
90
+ interface GetActiveMeetingQuery {
91
+ /** 是否需要参会人列表，默认为false */
92
+ with_participants?: boolean;
93
+ /** 此次调用中使用的用户ID的类型 */
94
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
95
+ }
96
+ interface GetActiveMeetingResponse {
97
+ meeting?: Lark.Meeting;
98
+ }
99
+ }
100
+ namespace Meeting {
101
+ interface Methods {
102
+ recording: Recording.Methods;
103
+ /**
104
+ * 邀请参会人
105
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting/invite
106
+ */
107
+ invite(meeting_id: string, body: InviteRequest, query?: InviteQuery): Promise<InviteResponse>;
108
+ /**
109
+ * 移除参会人
110
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting/kickout
111
+ */
112
+ kickout(meeting_id: string, body: KickoutRequest, query?: KickoutQuery): Promise<KickoutResponse>;
113
+ /**
114
+ * 设置主持人
115
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting/set_host
116
+ */
117
+ setHost(meeting_id: string, body: SetHostRequest, query?: SetHostQuery): Promise<SetHostResponse>;
118
+ /**
119
+ * 结束会议
120
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting/end
121
+ */
122
+ end(meeting_id: string): Promise<void>;
123
+ /**
124
+ * 获取会议详情
125
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting/get
126
+ */
127
+ get(meeting_id: string, query?: GetQuery): Promise<GetResponse>;
128
+ /**
129
+ * 获取与会议号关联的会议列表
130
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting/list_by_no
131
+ */
132
+ listByNo(query?: ListByNoQuery): Paginated<Lark.Meeting, 'meeting_briefs'>;
133
+ }
134
+ interface InviteRequest {
135
+ /** 被邀请的用户列表 */
136
+ invitees: Lark.MeetingUser[];
137
+ }
138
+ interface InviteQuery {
139
+ /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */
140
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
141
+ }
142
+ interface InviteResponse {
143
+ /** 邀请结果 */
144
+ invite_results?: Lark.MeetingInviteStatus[];
145
+ }
146
+ interface KickoutRequest {
147
+ /** 需踢出的用户列表 */
148
+ kickout_users: Lark.MeetingUser[];
149
+ }
150
+ interface KickoutQuery {
151
+ /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */
152
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
153
+ }
154
+ interface KickoutResponse {
155
+ /** 踢出结果 */
156
+ kickout_results?: Lark.MeetingParticipantResult[];
157
+ }
158
+ interface SetHostRequest {
159
+ /** 将要设置的主持人 */
160
+ host_user: Lark.MeetingUser;
161
+ /** 当前主持人（CAS并发安全：如果和会中当前主持人不符则会设置失败，可使用返回的最新数据重新设置） */
162
+ old_host_user?: Lark.MeetingUser;
163
+ }
164
+ interface SetHostQuery {
165
+ /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */
166
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
167
+ }
168
+ interface SetHostResponse {
169
+ /** 会中当前主持人 */
170
+ host_user?: Lark.MeetingUser;
171
+ }
172
+ interface GetQuery {
173
+ /** 是否需要参会人列表 */
174
+ with_participants?: boolean;
175
+ /** 是否需要会中使用能力统计（仅限tenant_access_token） */
176
+ with_meeting_ability?: boolean;
177
+ /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */
178
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
179
+ }
180
+ interface GetResponse {
181
+ meeting?: Lark.Meeting;
182
+ }
183
+ interface ListByNoQuery extends Pagination {
184
+ /** 9位会议号 */
185
+ meeting_no: string;
186
+ /** 查询开始时间（unix时间，单位sec） */
187
+ start_time: string;
188
+ /** 查询结束时间（unix时间，单位sec） */
189
+ end_time: string;
190
+ }
191
+ namespace Recording {
192
+ interface Methods {
193
+ /**
194
+ * 开始录制
195
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting-recording/start
196
+ */
197
+ start(meeting_id: string, body: StartRequest): Promise<void>;
198
+ /**
199
+ * 停止录制
200
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting-recording/stop
201
+ */
202
+ stop(meeting_id: string): Promise<void>;
203
+ /**
204
+ * 获取录制文件
205
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting-recording/get
206
+ */
207
+ get(meeting_id: string): Promise<GetResponse>;
208
+ /**
209
+ * 授权录制文件
210
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting-recording/set_permission
211
+ */
212
+ setPermission(meeting_id: string, body: SetPermissionRequest, query?: SetPermissionQuery): Promise<void>;
213
+ }
214
+ interface StartRequest {
215
+ /** 录制文件时间显示使用的时区[-12,12] */
216
+ timezone?: number;
217
+ }
218
+ interface GetResponse {
219
+ recording?: Lark.MeetingRecording;
220
+ }
221
+ const enum SetPermissionRequestActionType {
222
+ /** 授权 */
223
+ Authorize = 0,
224
+ /** 取消授权 */
225
+ Revoke = 1
226
+ }
227
+ interface SetPermissionRequest {
228
+ /** 授权对象列表 */
229
+ permission_objects: Lark.RecordingPermissionObject[];
230
+ /** 授权或者取消授权，默认授权 */
231
+ action_type?: SetPermissionRequestActionType;
232
+ }
233
+ interface SetPermissionQuery {
234
+ /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */
235
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
236
+ }
237
+ }
238
+ }
239
+ namespace Report {
240
+ interface Methods {
241
+ /**
242
+ * 获取会议报告
243
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/report/get_daily
244
+ */
245
+ getDaily(query?: GetDailyQuery): Promise<GetDailyResponse>;
246
+ /**
247
+ * 获取 Top 用户列表
248
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/report/get_top_user
249
+ */
250
+ getTopUser(query?: GetTopUserQuery): Promise<GetTopUserResponse>;
251
+ }
252
+ const enum GetDailyQueryUnit {
253
+ /** 中国大陆 */
254
+ CN = 0,
255
+ /** 美国 */
256
+ VA = 1,
257
+ /** 新加坡 */
258
+ SG = 2,
259
+ /** 日本 */
260
+ JP = 3
261
+ }
262
+ interface GetDailyQuery {
263
+ /** 开始时间（unix时间，单位sec） */
264
+ start_time: string;
265
+ /** 结束时间（unix时间，单位sec） */
266
+ end_time: string;
267
+ /** 数据驻留地 */
268
+ unit?: GetDailyQueryUnit;
269
+ }
270
+ interface GetDailyResponse {
271
+ /** 会议报告 */
272
+ meeting_report?: Lark.Report;
273
+ }
274
+ const enum GetTopUserQueryOrderBy {
275
+ /** 会议数量 */
276
+ MeetingCount = 1,
277
+ /** 会议时长 */
278
+ MeetingDuration = 2
279
+ }
280
+ const enum GetTopUserQueryUnit {
281
+ /** 中国大陆 */
282
+ CN = 0,
283
+ /** 美国 */
284
+ VA = 1,
285
+ /** 新加坡 */
286
+ SG = 2,
287
+ /** 日本 */
288
+ JP = 3
289
+ }
290
+ interface GetTopUserQuery {
291
+ /** 开始时间（unix时间，单位sec） */
292
+ start_time: string;
293
+ /** 结束时间（unix时间，单位sec） */
294
+ end_time: string;
295
+ /** 取前多少位 */
296
+ limit: number;
297
+ /** 排序依据（降序） */
298
+ order_by: GetTopUserQueryOrderBy;
299
+ /** 数据驻留地 */
300
+ unit?: GetTopUserQueryUnit;
301
+ /** 此次调用中使用的用户ID的类型 */
302
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
303
+ }
304
+ interface GetTopUserResponse {
305
+ /** top用户列表 */
306
+ top_user_report?: Lark.ReportTopUser[];
307
+ }
308
+ }
309
+ namespace Export {
310
+ interface Methods {
311
+ /**
312
+ * 导出会议明细
313
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/export/meeting_list
314
+ */
315
+ meetingList(body: MeetingListRequest, query?: MeetingListQuery): Promise<MeetingListResponse>;
316
+ /**
317
+ * 导出参会人明细
318
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/export/participant_list
319
+ */
320
+ participantList(body: ParticipantListRequest, query?: ParticipantListQuery): Promise<ParticipantListResponse>;
321
+ /**
322
+ * 导出参会人会议质量数据
323
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/export/participant_quality_list
324
+ */
325
+ participantQualityList(body: ParticipantQualityListRequest, query?: ParticipantQualityListQuery): Promise<ParticipantQualityListResponse>;
326
+ /**
327
+ * 导出会议室预定数据
328
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/export/resource_reservation_list
329
+ */
330
+ resourceReservationList(body: ResourceReservationListRequest): Promise<ResourceReservationListResponse>;
331
+ /**
332
+ * 查询导出任务结果
333
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/export/get
334
+ */
335
+ get(task_id: string): Promise<GetResponse>;
336
+ /**
337
+ * 下载导出文件
338
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/export/download
339
+ */
340
+ download(query?: DownloadQuery): Promise<ArrayBuffer>;
341
+ }
342
+ const enum MeetingListRequestMeetingStatus {
343
+ /** 进行中 */
344
+ Ongoing = 1,
345
+ /** 已结束 */
346
+ Past = 2,
347
+ /** 待召开 */
348
+ Future = 3
349
+ }
350
+ const enum MeetingListRequestMeetingType {
351
+ /** 全部类型（默认） */
352
+ All = 1,
353
+ /** 视频会议 */
354
+ Meeting = 2,
355
+ /** 本地投屏 */
356
+ ShareScreen = 3
357
+ }
358
+ interface MeetingListRequest {
359
+ /** 查询开始时间（unix时间，单位sec） */
360
+ start_time: string;
361
+ /** 查询结束时间（unix时间，单位sec） */
362
+ end_time: string;
363
+ /** 会议状态（不传默认为已结束会议） */
364
+ meeting_status?: MeetingListRequestMeetingStatus;
365
+ /** 按9位会议号筛选（最多一个筛选条件） */
366
+ meeting_no?: string;
367
+ /** 按参会Lark用户筛选（最多一个筛选条件） */
368
+ user_id?: string;
369
+ /** 按参会Rooms筛选（最多一个筛选条件） */
370
+ room_id?: string;
371
+ /** 按会议类型筛选（最多一个筛选条件） */
372
+ meeting_type?: MeetingListRequestMeetingType;
373
+ }
374
+ interface MeetingListQuery {
375
+ /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */
376
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
377
+ }
378
+ interface MeetingListResponse {
379
+ /** 任务id */
380
+ task_id?: string;
381
+ }
382
+ const enum ParticipantListRequestMeetingStatus {
383
+ /** 进行中 */
384
+ Ongoing = 1,
385
+ /** 已结束 */
386
+ Past = 2,
387
+ /** 待召开 */
388
+ Future = 3
389
+ }
390
+ interface ParticipantListRequest {
391
+ /** 会议开始时间（unix时间，单位sec） */
392
+ meeting_start_time: string;
393
+ /** 会议结束时间（unix时间，单位sec） */
394
+ meeting_end_time: string;
395
+ /** 会议状态（不传默认为已结束会议） */
396
+ meeting_status?: ParticipantListRequestMeetingStatus;
397
+ /** 9位会议号 */
398
+ meeting_no: string;
399
+ /** 按参会Lark用户筛选（最多一个筛选条件） */
400
+ user_id?: string;
401
+ /** 按参会Rooms筛选（最多一个筛选条件） */
402
+ room_id?: string;
403
+ }
404
+ interface ParticipantListQuery {
405
+ /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */
406
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
407
+ }
408
+ interface ParticipantListResponse {
409
+ /** 任务id */
410
+ task_id?: string;
411
+ }
412
+ interface ParticipantQualityListRequest {
413
+ /** 会议开始时间（unix时间，单位sec） */
414
+ meeting_start_time: string;
415
+ /** 会议结束时间（unix时间，单位sec） */
416
+ meeting_end_time: string;
417
+ /** 9位会议号 */
418
+ meeting_no: string;
419
+ /** 参会人入会时间（unix时间，单位sec） */
420
+ join_time: string;
421
+ /** 参会人为Lark用户时填入 */
422
+ user_id?: string;
423
+ /** 参会人为Rooms时填入 */
424
+ room_id?: string;
425
+ }
426
+ interface ParticipantQualityListQuery {
427
+ /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */
428
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
429
+ }
430
+ interface ParticipantQualityListResponse {
431
+ /** 任务id */
432
+ task_id?: string;
433
+ }
434
+ interface ResourceReservationListRequest {
435
+ /** 层级id */
436
+ room_level_id: string;
437
+ /** 是否展示会议主题 */
438
+ need_topic?: boolean;
439
+ /** 查询开始时间（unix时间，单位sec） */
440
+ start_time: string;
441
+ /** 查询结束时间（unix时间，单位sec） */
442
+ end_time: string;
443
+ /** 待筛选的会议室id列表 */
444
+ room_ids?: string[];
445
+ /** 若为true表示导出room_ids范围外的会议室，默认为false */
446
+ is_exclude?: boolean;
447
+ }
448
+ interface ResourceReservationListResponse {
449
+ /** 任务id */
450
+ task_id?: string;
451
+ }
452
+ const enum GetResponseStatus {
453
+ /** 处理中 */
454
+ InProgress = 1,
455
+ /** 失败 */
456
+ Failed = 2,
457
+ /** 完成 */
458
+ Done = 3
459
+ }
460
+ interface GetResponse {
461
+ /** 任务状态 */
462
+ status: GetResponseStatus;
463
+ /** 文件下载地址 */
464
+ url?: string;
465
+ /** 文件token */
466
+ file_token?: string;
467
+ /** 失败信息 */
468
+ fail_msg?: string;
469
+ }
470
+ interface DownloadQuery {
471
+ /** 文档token */
472
+ file_token: string;
473
+ }
474
+ }
475
+ namespace RoomLevel {
476
+ interface Methods {
477
+ /**
478
+ * 创建会议室层级
479
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room_level/create
480
+ */
481
+ create(body: CreateRequest): Promise<CreateResponse>;
482
+ /**
483
+ * 删除会议室层级
484
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room_level/del
485
+ */
486
+ del(body: DelRequest): Promise<void>;
487
+ /**
488
+ * 更新会议室层级
489
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room_level/patch
490
+ */
491
+ patch(room_level_id: string, body: PatchRequest): Promise<void>;
492
+ /**
493
+ * 查询会议室层级详情
494
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room_level/get
495
+ */
496
+ get(room_level_id: string): Promise<GetResponse>;
497
+ /**
498
+ * 批量查询会议室层级详情
499
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room_level/mget
500
+ */
501
+ mget(body: MgetRequest): Promise<MgetResponse>;
502
+ /**
503
+ * 查询会议室层级列表
504
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room_level/list
505
+ */
506
+ list(query?: ListQuery): Paginated<Lark.RoomLevel>;
507
+ /**
508
+ * 搜索会议室层级
509
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room_level/search
510
+ */
511
+ search(query?: SearchQuery): Promise<SearchResponse>;
512
+ }
513
+ interface CreateRequest {
514
+ /** 层级名称 */
515
+ name: string;
516
+ /** 父层级ID */
517
+ parent_id: string;
518
+ /** 自定义层级ID */
519
+ custom_group_id?: string;
520
+ }
521
+ interface CreateResponse {
522
+ room_level?: Lark.RoomLevel;
523
+ }
524
+ interface DelRequest {
525
+ /** 层级ID */
526
+ room_level_id: string;
527
+ /** 是否删除所有子层级 */
528
+ delete_child?: boolean;
529
+ }
530
+ interface PatchRequest {
531
+ /** 层级名称 */
532
+ name: string;
533
+ /** 父层级ID */
534
+ parent_id: string;
535
+ /** 自定义层级ID */
536
+ custom_group_id?: string;
537
+ }
538
+ interface GetResponse {
539
+ room_level?: Lark.RoomLevel;
540
+ }
541
+ interface MgetRequest {
542
+ /** 层级id列表 */
543
+ level_ids: string[];
544
+ }
545
+ interface MgetResponse {
546
+ /** 层级列表 */
547
+ items?: Lark.RoomLevel[];
548
+ }
549
+ interface ListQuery extends Pagination {
550
+ /** 层级ID，不传则返回该租户下第一层级列表 */
551
+ room_level_id?: string;
552
+ }
553
+ interface SearchQuery {
554
+ /** 用于查询指定会议室的租户自定义会议室ID */
555
+ custom_level_ids: string;
556
+ }
557
+ interface SearchResponse {
558
+ /** 层级id列表 */
559
+ level_ids?: string[];
560
+ }
561
+ }
562
+ namespace Room {
563
+ interface Methods {
564
+ /**
565
+ * 创建会议室
566
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room/create
567
+ */
568
+ create(body: CreateRequest, query?: CreateQuery): Promise<CreateResponse>;
569
+ /**
570
+ * 删除会议室
571
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room/delete
572
+ */
573
+ delete(room_id: string): Promise<void>;
574
+ /**
575
+ * 更新会议室
576
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room/patch
577
+ */
578
+ patch(room_id: string, body: PatchRequest, query?: PatchQuery): Promise<void>;
579
+ /**
580
+ * 查询会议室详情
581
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room/get
582
+ */
583
+ get(room_id: string, query?: GetQuery): Promise<GetResponse>;
584
+ /**
585
+ * 批量查询会议室详情
586
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room/mget
587
+ */
588
+ mget(body: MgetRequest, query?: MgetQuery): Promise<MgetResponse>;
589
+ /**
590
+ * 查询会议室列表
591
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room/list
592
+ */
593
+ list(query?: ListQuery): Paginated<Lark.Room, 'rooms'>;
594
+ /**
595
+ * 搜索会议室
596
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room/search
597
+ */
598
+ search(body: SearchRequest, query?: SearchQuery): Paginated<Lark.Room, 'rooms'>;
599
+ }
600
+ interface CreateRequest {
601
+ /** 会议室名称 */
602
+ name: string;
603
+ /** 会议室能容纳的人数 */
604
+ capacity: number;
605
+ /** 会议室的相关描述 */
606
+ description?: string;
607
+ /** 自定义的会议室ID */
608
+ custom_room_id?: string;
609
+ /** 层级ID */
610
+ room_level_id: string;
611
+ /** 会议室状态 */
612
+ room_status?: Lark.RoomStatus;
613
+ /** 设施信息列表 */
614
+ device?: Lark.Device[];
615
+ }
616
+ interface CreateQuery {
617
+ /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */
618
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
619
+ }
620
+ interface CreateResponse {
621
+ room?: Lark.Room;
622
+ }
623
+ interface PatchRequest {
624
+ /** 会议室名称 */
625
+ name?: string;
626
+ /** 会议室能容纳的人数 */
627
+ capacity?: number;
628
+ /** 会议室的相关描述 */
629
+ description?: string;
630
+ /** 自定义的会议室ID */
631
+ custom_room_id?: string;
632
+ /** 层级ID */
633
+ room_level_id?: string;
634
+ /** 会议室状态 */
635
+ room_status?: Lark.RoomStatus;
636
+ /** 设施信息列表 */
637
+ device?: Lark.Device[];
638
+ }
639
+ interface PatchQuery {
640
+ /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */
641
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
642
+ }
643
+ interface GetQuery {
644
+ /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */
645
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
646
+ }
647
+ interface GetResponse {
648
+ room?: Lark.Room;
649
+ }
650
+ interface MgetRequest {
651
+ /** 会议室id列表 */
652
+ room_ids: string[];
653
+ }
654
+ interface MgetQuery {
655
+ /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */
656
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
657
+ }
658
+ interface MgetResponse {
659
+ /** 会议室列表 */
660
+ items?: Lark.Room[];
661
+ }
662
+ interface ListQuery extends Pagination {
663
+ /** 层级ID，不传则返回该租户下的所有会议室 */
664
+ room_level_id?: string;
665
+ /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */
666
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
667
+ }
668
+ interface SearchRequest {
669
+ /** 用于查询指定会议室的租户自定义会议室ID列表，优先使用该字段进行查询 */
670
+ custom_room_ids?: string[];
671
+ /** 会议室搜索关键词（当custom_room_ids为空时，使用该字段进行查询） */
672
+ keyword?: string;
673
+ /** 在该会议室层级下进行搜索 */
674
+ room_level_id?: string;
675
+ /** 搜索会议室是否包括层级名称 */
676
+ search_level_name?: boolean;
677
+ /** 分页大小，该值默认为10，最大为100 */
678
+ page_size?: number;
679
+ /** 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 */
680
+ page_token?: string;
681
+ }
682
+ interface SearchQuery {
683
+ /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */
684
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
685
+ }
686
+ }
687
+ namespace ScopeConfig {
688
+ interface Methods {
689
+ /**
690
+ * 查询会议室配置
691
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/scope_config/get
692
+ */
693
+ get(query?: GetQuery): Promise<GetResponse>;
694
+ /**
695
+ * 设置会议室配置
696
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/scope_config/create
697
+ */
698
+ create(body: CreateRequest, query?: CreateQuery): Promise<void>;
699
+ }
700
+ const enum GetQueryScopeType {
701
+ /** 会议室层级 */
702
+ RoomLevel = 1,
703
+ /** 会议室 */
704
+ Room = 2
705
+ }
706
+ interface GetQuery {
707
+ /** 查询节点范围 */
708
+ scope_type: GetQueryScopeType;
709
+ /** 查询节点ID：如果scope_type为1，则为层级ID，如果scope_type为2，则为会议室ID */
710
+ scope_id: string;
711
+ /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */
712
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
713
+ }
714
+ interface GetResponse {
715
+ /** 当前节点的配置，根据层级顺序从底向上进行合并计算后的结果；如果当前节点某个值已配置，则取该节点的值，否则会从该节点的父层级节点获取，如果父节点依然未配置，则继续向上递归获取；若所有节点均未配置，则该值返回为空 */
716
+ current_config?: Lark.ScopeConfig;
717
+ /** 所有节点的原始配置，按照层级顺序从底向上返回；如果某节点某个值未配置，则该值返回为空 */
718
+ origin_configs?: Lark.ScopeConfig[];
719
+ }
720
+ const enum CreateRequestScopeType {
721
+ /** 会议室层级 */
722
+ RoomLevel = 1,
723
+ /** 会议室 */
724
+ Room = 2
725
+ }
726
+ interface CreateRequest {
727
+ /** 查询节点范围 */
728
+ scope_type: CreateRequestScopeType;
729
+ /** 查询节点ID：如果scope_type为1，则为层级ID，如果scope_type为2，则为会议室ID */
730
+ scope_id: string;
731
+ /** 节点配置 */
732
+ scope_config?: Lark.RoomConfig;
733
+ }
734
+ interface CreateQuery {
735
+ /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */
736
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
737
+ }
738
+ }
739
+ namespace ReserveConfig {
740
+ interface Methods {
741
+ form: Form.Methods;
742
+ admin: Admin.Methods;
743
+ disableInform: DisableInform.Methods;
744
+ /**
745
+ * 查询会议室预定限制
746
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve_config/reserve_scope
747
+ */
748
+ reserveScope(query?: ReserveScopeQuery): Promise<ReserveScopeResponse>;
749
+ /**
750
+ * 更新会议室预定限制
751
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve_config/patch
752
+ */
753
+ patch(reserve_config_id: string, body: PatchRequest, query?: PatchQuery): Promise<void>;
754
+ }
755
+ interface ReserveScopeQuery {
756
+ /** 会议室或层级id */
757
+ scope_id: string;
758
+ /** 1代表层级，2代表会议室 */
759
+ scope_type: string;
760
+ /** 此次调用中使用的用户ID的类型 */
761
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
762
+ }
763
+ interface ReserveScopeResponse {
764
+ /** 预定审批设置 */
765
+ approve_config?: Lark.ApprovalConfig;
766
+ /** 预定时间设置 */
767
+ time_config?: Lark.TimeConfig;
768
+ /** 预定范围设置 */
769
+ reserve_scope_config?: Lark.ReserveScopeConfig;
770
+ }
771
+ interface PatchRequest {
772
+ /** 1代表层级，2代表会议室 */
773
+ scope_type: string;
774
+ /** 预定审批设置 */
775
+ approval_config?: Lark.ApprovalConfig;
776
+ /** 预定时间设置 */
777
+ time_config?: Lark.TimeConfig;
778
+ /** 预定范围设置 */
779
+ reserve_scope_config?: Lark.ReserveScopeConfig;
780
+ }
781
+ interface PatchQuery {
782
+ /** 此次调用中使用的用户ID的类型 */
783
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
784
+ }
785
+ namespace Form {
786
+ interface Methods {
787
+ /**
788
+ * 查询会议室预定表单
789
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve_config-form/get
790
+ */
791
+ get(reserve_config_id: string, query?: GetQuery): Promise<GetResponse>;
792
+ /**
793
+ * 更新会议室预定表单
794
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve_config-form/patch
795
+ */
796
+ patch(reserve_config_id: string, body: PatchRequest, query?: PatchQuery): Promise<void>;
797
+ }
798
+ interface GetQuery {
799
+ /** 1代表层级，2代表会议室 */
800
+ scope_type: number;
801
+ /** 此次调用中使用的用户ID的类型 */
802
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
803
+ }
804
+ interface GetResponse {
805
+ /** 预定表单 */
806
+ reserve_form_config: Lark.ReserveFormConfig;
807
+ }
808
+ interface PatchRequest {
809
+ /** 1代表层级，2代表会议室 */
810
+ scope_type: number;
811
+ /** 预定表单设置 */
812
+ reserve_form_config: Lark.ReserveFormConfig;
813
+ }
814
+ interface PatchQuery {
815
+ /** 此次调用中使用的用户ID的类型 */
816
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
817
+ }
818
+ }
819
+ namespace Admin {
820
+ interface Methods {
821
+ /**
822
+ * 查询会议室预定管理员
823
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve_config-admin/get
824
+ */
825
+ get(reserve_config_id: string, query?: GetQuery): Promise<GetResponse>;
826
+ /**
827
+ * 更新会议室预定管理员
828
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve_config-admin/patch
829
+ */
830
+ patch(reserve_config_id: string, body: PatchRequest, query?: PatchQuery): Promise<void>;
831
+ }
832
+ interface GetQuery {
833
+ /** 会议室或层级 */
834
+ scope_type: number;
835
+ /** 此次调用中使用的用户ID的类型 */
836
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
837
+ }
838
+ interface GetResponse {
839
+ /** 预定管理员/部门 */
840
+ reserve_admin_config: Lark.ReserveAdminConfig;
841
+ }
842
+ interface PatchRequest {
843
+ /** 1代表层级，2代表会议室 */
844
+ scope_type: number;
845
+ /** 预定管理员或部门 */
846
+ reserve_admin_config: Lark.ReserveAdminConfig;
847
+ }
848
+ interface PatchQuery {
849
+ /** 此次调用中使用的用户ID的类型 */
850
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
851
+ }
852
+ }
853
+ namespace DisableInform {
854
+ interface Methods {
855
+ /**
856
+ * 查询禁用状态变更通知
857
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve_config-disable_inform/get
858
+ */
859
+ get(reserve_config_id: string, query?: GetQuery): Promise<GetResponse>;
860
+ /**
861
+ * 更新禁用状态变更通知
862
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve_config-disable_inform/patch
863
+ */
864
+ patch(reserve_config_id: string, body: PatchRequest, query?: PatchQuery): Promise<void>;
865
+ }
866
+ interface GetQuery {
867
+ /** 1表示层级，2表示会议室 */
868
+ scope_type: number;
869
+ /** 此次调用中使用的用户ID的类型 */
870
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
871
+ }
872
+ interface GetResponse {
873
+ /** 会议室禁用通知配置 */
874
+ disable_inform?: Lark.DisableInformConfig;
875
+ }
876
+ interface PatchRequest {
877
+ /** 1表示会议室层级，2表示会议室 */
878
+ scope_type: number;
879
+ /** 禁用通知配置 */
880
+ disable_inform: Lark.DisableInformConfig;
881
+ }
882
+ interface PatchQuery {
883
+ /** 此次调用中使用的用户ID的类型 */
884
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
885
+ }
886
+ }
887
+ }
888
+ namespace MeetingList {
889
+ interface Methods {
890
+ /**
891
+ * 查询会议明细
892
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/meeting_list/get
893
+ */
894
+ get(query?: GetQuery): Paginated<Lark.MeetingInfo, 'meeting_list'>;
895
+ }
896
+ const enum GetQueryMeetingStatus {
897
+ /** 进行中 */
898
+ Ongoing = 1,
899
+ /** 已结束 */
900
+ Past = 2,
901
+ /** 待召开 */
902
+ Future = 3
903
+ }
904
+ const enum GetQueryMeetingType {
905
+ /** 全部类型（默认） */
906
+ All = 1,
907
+ /** 视频会议 */
908
+ Meeting = 2,
909
+ /** 本地投屏 */
910
+ ShareScreen = 3
911
+ }
912
+ interface GetQuery extends Pagination {
913
+ /** 查询开始时间（unix时间，单位sec） */
914
+ start_time: string;
915
+ /** 查询结束时间（unix时间，单位sec） */
916
+ end_time: string;
917
+ /** 会议状态 */
918
+ meeting_status?: GetQueryMeetingStatus;
919
+ /** 按9位会议号筛选（最多一个筛选条件） */
920
+ meeting_no?: string;
921
+ /** 按参会Lark用户筛选（最多一个筛选条件） */
922
+ user_id?: string;
923
+ /** 按参会Rooms筛选（最多一个筛选条件） */
924
+ room_id?: string;
925
+ /** 按会议类型筛选（最多一个筛选条件） */
926
+ meeting_type?: GetQueryMeetingType;
927
+ /** 此次调用中使用的用户ID的类型 */
928
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
929
+ }
930
+ }
931
+ namespace ParticipantList {
932
+ interface Methods {
933
+ /**
934
+ * 查询参会人明细
935
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/participant_list/get
936
+ */
937
+ get(query?: GetQuery): Paginated<Lark.Participant, 'participants'>;
938
+ }
939
+ const enum GetQueryMeetingStatus {
940
+ /** 进行中 */
941
+ Ongoing = 1,
942
+ /** 已结束 */
943
+ Past = 2,
944
+ /** 待召开 */
945
+ Future = 3
946
+ }
947
+ interface GetQuery extends Pagination {
948
+ /** 会议开始时间（需要精确到一分钟，unix时间，单位sec） */
949
+ meeting_start_time: string;
950
+ /** 会议结束时间（unix时间，单位sec；对于进行中会议则传0） */
951
+ meeting_end_time: string;
952
+ /** 会议状态（不传默认为已结束会议） */
953
+ meeting_status?: GetQueryMeetingStatus;
954
+ /** 9位会议号 */
955
+ meeting_no: string;
956
+ /** 按参会Lark用户筛选（最多一个筛选条件） */
957
+ user_id?: string;
958
+ /** 按参会Rooms筛选（最多一个筛选条件） */
959
+ room_id?: string;
960
+ /** 此次调用中使用的用户ID的类型 */
961
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
962
+ }
963
+ }
964
+ namespace ParticipantQualityList {
965
+ interface Methods {
966
+ /**
967
+ * 查询参会人会议质量数据
968
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/participant_quality_list/get
969
+ */
970
+ get(query?: GetQuery): Paginated<Lark.ParticipantQuality, 'participant_quality_list'>;
971
+ }
972
+ interface GetQuery extends Pagination {
973
+ /** 会议开始时间（需要精确到一分钟，unix时间，单位sec） */
974
+ meeting_start_time: string;
975
+ /** 会议结束时间（unix时间，单位sec） */
976
+ meeting_end_time: string;
977
+ /** 9位会议号 */
978
+ meeting_no: string;
979
+ /** 参会人入会时间（unix时间，单位sec） */
980
+ join_time: string;
981
+ /** 参会人为Lark用户时填入 */
982
+ user_id?: string;
983
+ /** 参会人为Rooms时填入 */
984
+ room_id?: string;
985
+ /** 此次调用中使用的用户ID的类型 */
986
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
987
+ }
988
+ }
989
+ namespace ResourceReservationList {
990
+ interface Methods {
991
+ /**
992
+ * 查询会议室预定数据
993
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/resource_reservation_list/get
994
+ */
995
+ get(query?: GetQuery): Paginated<Lark.RoomMeetingReservation, 'room_reservation_list'>;
996
+ }
997
+ interface GetQuery extends Pagination {
998
+ /** 层级id */
999
+ room_level_id: string;
1000
+ /** 是否展示会议主题 */
1001
+ need_topic?: boolean;
1002
+ /** 查询开始时间（unix时间，单位sec） */
1003
+ start_time: string;
1004
+ /** 查询结束时间（unix时间，单位sec） */
1005
+ end_time: string;
1006
+ /** 待筛选的会议室id列表 */
1007
+ room_ids: string[];
1008
+ /** 若为true表示导出room_ids范围外的会议室，默认为false */
1009
+ is_exclude?: boolean;
1010
+ }
1011
+ }
1012
+ namespace Alert {
1013
+ interface Methods {
1014
+ /**
1015
+ * 获取告警记录
1016
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/alert/list
1017
+ */
1018
+ list(query?: ListQuery): Paginated<Lark.Alert>;
1019
+ }
1020
+ const enum ListQueryQueryType {
1021
+ /** 会议室 */
1022
+ Room = 1,
1023
+ /** erc */
1024
+ Erc = 2,
1025
+ /** SIP会议室系统 */
1026
+ Sip = 3
1027
+ }
1028
+ interface ListQuery extends Pagination {
1029
+ /** 开始时间（unix时间，单位sec） */
1030
+ start_time: string;
1031
+ /** 结束时间（unix时间，单位sec） */
1032
+ end_time: string;
1033
+ /** 查询对象类型 */
1034
+ query_type?: ListQueryQueryType;
1035
+ /** 查询对象ID */
1036
+ query_value?: string;
1037
+ }
1038
+ }
1039
+ namespace RoomConfig {
1040
+ interface Methods {
1041
+ /**
1042
+ * 创建签到板部署码
1043
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room_config/set_checkboard_access_code
1044
+ */
1045
+ setCheckboardAccessCode(body: SetCheckboardAccessCodeRequest): Promise<SetCheckboardAccessCodeResponse>;
1046
+ /**
1047
+ * 创建会议室部署码
1048
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room_config/set_room_access_code
1049
+ */
1050
+ setRoomAccessCode(body: SetRoomAccessCodeRequest): Promise<SetRoomAccessCodeResponse>;
1051
+ /**
1052
+ * 查询会议室配置
1053
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room_config/query
1054
+ */
1055
+ query(query?: QueryQuery): Promise<QueryResponse>;
1056
+ /**
1057
+ * 设置会议室配置
1058
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/room_config/set
1059
+ */
1060
+ set(body: SetRequest, query?: SetQuery): Promise<void>;
1061
+ }
1062
+ const enum SetCheckboardAccessCodeRequestScope {
1063
+ /** 租户 */
1064
+ Tenant = 1,
1065
+ /** 国家/地区 */
1066
+ CountryDistrict = 2,
1067
+ /** 城市 */
1068
+ City = 3,
1069
+ /** 建筑 */
1070
+ Building = 4,
1071
+ /** 楼层 */
1072
+ Floor = 5,
1073
+ /** 会议室 */
1074
+ Room = 6
1075
+ }
1076
+ const enum SetCheckboardAccessCodeRequestValidDay {
1077
+ /** 1天 */
1078
+ Day = 1,
1079
+ /** 7天 */
1080
+ Week = 7,
1081
+ /** 30天 */
1082
+ Month = 30
1083
+ }
1084
+ interface SetCheckboardAccessCodeRequest {
1085
+ /** 设置节点范围 */
1086
+ scope: SetCheckboardAccessCodeRequestScope;
1087
+ /** 国家/地区ID scope为2，3时需要此参数 */
1088
+ country_id?: string;
1089
+ /** 城市ID scope为3时需要此参数 */
1090
+ district_id?: string;
1091
+ /** 建筑ID scope为4，5时需要此参数 */
1092
+ building_id?: string;
1093
+ /** 楼层 scope为5时需要此参数 */
1094
+ floor_name?: string;
1095
+ /** 会议室ID scope为6时需要此参数 */
1096
+ room_id?: string;
1097
+ /** 有效天数 */
1098
+ valid_day: SetCheckboardAccessCodeRequestValidDay;
1099
+ }
1100
+ interface SetCheckboardAccessCodeResponse {
1101
+ /** 部署访问码 */
1102
+ access_code?: string;
1103
+ }
1104
+ const enum SetRoomAccessCodeRequestScope {
1105
+ /** 租户 */
1106
+ Tenant = 1,
1107
+ /** 国家/地区 */
1108
+ CountryDistrict = 2,
1109
+ /** 城市 */
1110
+ City = 3,
1111
+ /** 建筑 */
1112
+ Building = 4,
1113
+ /** 楼层 */
1114
+ Floor = 5,
1115
+ /** 会议室 */
1116
+ Room = 6
1117
+ }
1118
+ const enum SetRoomAccessCodeRequestValidDay {
1119
+ /** 1天 */
1120
+ Day = 1,
1121
+ /** 7天 */
1122
+ Week = 7,
1123
+ /** 30天 */
1124
+ Month = 30
1125
+ }
1126
+ interface SetRoomAccessCodeRequest {
1127
+ /** 设置节点范围 */
1128
+ scope: SetRoomAccessCodeRequestScope;
1129
+ /** 国家/地区ID scope为2，3时需要此参数 */
1130
+ country_id?: string;
1131
+ /** 城市ID scope为3时需要此参数 */
1132
+ district_id?: string;
1133
+ /** 建筑ID scope为4，5时需要此参数 */
1134
+ building_id?: string;
1135
+ /** 楼层 scope为5时需要此参数 */
1136
+ floor_name?: string;
1137
+ /** 会议室ID scope为6时需要此参数 */
1138
+ room_id?: string;
1139
+ /** 有效天数 */
1140
+ valid_day: SetRoomAccessCodeRequestValidDay;
1141
+ }
1142
+ interface SetRoomAccessCodeResponse {
1143
+ /** 部署访问码 */
1144
+ access_code?: string;
1145
+ }
1146
+ const enum QueryQueryScope {
1147
+ /** 租户 */
1148
+ Tenant = 1,
1149
+ /** 国家/地区 */
1150
+ CountryDistrict = 2,
1151
+ /** 城市 */
1152
+ City = 3,
1153
+ /** 建筑 */
1154
+ Building = 4,
1155
+ /** 楼层 */
1156
+ Floor = 5,
1157
+ /** 会议室 */
1158
+ Room = 6
1159
+ }
1160
+ interface QueryQuery {
1161
+ /** 查询节点范围 */
1162
+ scope: QueryQueryScope;
1163
+ /** 国家/地区ID scope为2，3时需要此参数 */
1164
+ country_id?: string;
1165
+ /** 城市ID scope为3时需要此参数 */
1166
+ district_id?: string;
1167
+ /** 建筑ID scope为4，5时需要此参数 */
1168
+ building_id?: string;
1169
+ /** 楼层 scope为5时需要此参数 */
1170
+ floor_name?: string;
1171
+ /** 会议室ID scope为6时需要此参数 */
1172
+ room_id?: string;
1173
+ /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */
1174
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
1175
+ }
1176
+ interface QueryResponse {
1177
+ /** 飞书会议室背景图 */
1178
+ room_background?: string;
1179
+ /** 飞书签到板背景图 */
1180
+ display_background?: string;
1181
+ /** 飞书会议室数字标牌 */
1182
+ digital_signage?: Lark.RoomDigitalSignage;
1183
+ /** 飞书投屏盒子数字标牌 */
1184
+ room_box_digital_signage?: Lark.RoomDigitalSignage;
1185
+ /** 会议室状态 */
1186
+ room_status?: Lark.RoomStatus;
1187
+ }
1188
+ const enum SetRequestScope {
1189
+ /** 租户 */
1190
+ Tenant = 1,
1191
+ /** 国家/地区 */
1192
+ CountryDistrict = 2,
1193
+ /** 城市 */
1194
+ City = 3,
1195
+ /** 建筑 */
1196
+ Building = 4,
1197
+ /** 楼层 */
1198
+ Floor = 5,
1199
+ /** 会议室 */
1200
+ Room = 6
1201
+ }
1202
+ interface SetRequest {
1203
+ /** 设置节点范围 */
1204
+ scope: SetRequestScope;
1205
+ /** 国家/地区ID scope为2，3时需要此参数 */
1206
+ country_id?: string;
1207
+ /** 城市ID scope为3时需要此参数 */
1208
+ district_id?: string;
1209
+ /** 建筑ID scope为4，5时需要此参数 */
1210
+ building_id?: string;
1211
+ /** 楼层 scope为5时需要此参数 */
1212
+ floor_name?: string;
1213
+ /** 会议室ID scope为6时需要此参数 */
1214
+ room_id?: string;
1215
+ /** 会议室设置 */
1216
+ room_config: Lark.RoomConfig;
1217
+ }
1218
+ interface SetQuery {
1219
+ /** 此次调用中使用的用户ID的类型，默认使用open_id可不填 */
1220
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
1221
+ }
1222
+ }
1128
1223
  }