@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
@@ -1,746 +1,821 @@
1
- import { AgentSchedule, AgentScheduleUpdateInfo, AgentSkill, AgentSkillRule, Category, CustomizedFieldDisplayItem, Event, Faq, FaqCreateInfo, FaqUpdateInfo, Notification, NotificationChat, NotificationDepartment, NotificationUser, Ticket, TicketCustomizedField, TicketMessage, TicketUser, UserCustomizedField, UserQueryFaqInfo } 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/helpdesk-v1/agent/patch
8
- */
9
- patchHelpdeskAgent(agent_id: string, body: PatchHelpdeskAgentRequest): Promise<void>;
10
- /**
11
- * 获取客服邮箱
12
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/agent/agent_email
13
- */
14
- agentEmailHelpdeskAgent(): Promise<AgentEmailHelpdeskAgentResponse>;
15
- /**
16
- * 创建客服工作日程
17
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/agent_schedule/create
18
- */
19
- createHelpdeskAgentSchedule(body: CreateHelpdeskAgentScheduleRequest): Promise<void>;
20
- /**
21
- * 删除客服工作日程
22
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/agent-schedules/delete
23
- */
24
- deleteHelpdeskAgentSchedules(agent_id: string): Promise<void>;
25
- /**
26
- * 更新客服工作日程
27
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/agent-schedules/patch
28
- */
29
- patchHelpdeskAgentSchedules(agent_id: string, body: PatchHelpdeskAgentSchedulesRequest): Promise<void>;
30
- /**
31
- * 查询指定客服工作日程
32
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/agent-schedules/get
33
- */
34
- getHelpdeskAgentSchedules(agent_id: string): Promise<GetHelpdeskAgentSchedulesResponse>;
35
- /**
36
- * 查询全部客服工作日程
37
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/agent_schedule/list
38
- */
39
- listHelpdeskAgentSchedule(query?: ListHelpdeskAgentScheduleQuery): Promise<ListHelpdeskAgentScheduleResponse>;
40
- /**
41
- * 创建客服技能
42
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/agent_skill/create
43
- */
44
- createHelpdeskAgentSkill(body: CreateHelpdeskAgentSkillRequest): Promise<CreateHelpdeskAgentSkillResponse>;
45
- /**
46
- * 删除客服技能
47
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/agent_skill/delete
48
- */
49
- deleteHelpdeskAgentSkill(agent_skill_id: string): Promise<void>;
50
- /**
51
- * 更新客服技能
52
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/agent_skill/patch
53
- */
54
- patchHelpdeskAgentSkill(agent_skill_id: string, body: PatchHelpdeskAgentSkillRequest): Promise<void>;
55
- /**
56
- * 查询指定客服技能
57
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/agent_skill/get
58
- */
59
- getHelpdeskAgentSkill(agent_skill_id: string): Promise<GetHelpdeskAgentSkillResponse>;
60
- /**
61
- * 查询全部客服技能
62
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/agent_skill/list
63
- */
64
- listHelpdeskAgentSkill(): Promise<ListHelpdeskAgentSkillResponse>;
65
- /**
66
- * 获取客服技能列表
67
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/agent_skill_rule/list
68
- */
69
- listHelpdeskAgentSkillRule(): Promise<ListHelpdeskAgentSkillRuleResponse>;
70
- /**
71
- * 创建服务台对话
72
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/ticket/start_service
73
- */
74
- startServiceHelpdeskTicket(body: StartServiceHelpdeskTicketRequest): Promise<StartServiceHelpdeskTicketResponse>;
75
- /**
76
- * 查询指定工单详情
77
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/ticket/get
78
- */
79
- getHelpdeskTicket(ticket_id: string): Promise<GetHelpdeskTicketResponse>;
80
- /**
81
- * 更新工单详情
82
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/ticket/update
83
- */
84
- updateHelpdeskTicket(ticket_id: string, body: UpdateHelpdeskTicketRequest): Promise<void>;
85
- /**
86
- * 查询全部工单详情
87
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/ticket/list
88
- */
89
- listHelpdeskTicket(query?: ListHelpdeskTicketQuery): Promise<ListHelpdeskTicketResponse>;
90
- /**
91
- * 获取工单内图像
92
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/ticket/ticket_image
93
- */
94
- ticketImageHelpdeskTicket(query?: TicketImageHelpdeskTicketQuery): Promise<ArrayBuffer>;
95
- /**
96
- * 回复用户在工单里的提问
97
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/ticket/answer_user_query
98
- */
99
- answerUserQueryHelpdeskTicket(ticket_id: string, body: AnswerUserQueryHelpdeskTicketRequest): Promise<void>;
100
- /**
101
- * 获取服务台自定义字段
102
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/ticket/customized_fields
103
- */
104
- customizedFieldsHelpdeskTicket(query?: CustomizedFieldsHelpdeskTicketQuery): Promise<CustomizedFieldsHelpdeskTicketResponse>;
105
- /**
106
- * 发送工单消息
107
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/ticket-message/create
108
- */
109
- createHelpdeskTicketMessage(ticket_id: string, body: CreateHelpdeskTicketMessageRequest): Promise<CreateHelpdeskTicketMessageResponse>;
110
- /**
111
- * 获取工单消息详情
112
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/ticket-message/list
113
- */
114
- listHelpdeskTicketMessage(ticket_id: string, query?: ListHelpdeskTicketMessageQuery): Promise<ListHelpdeskTicketMessageResponse>;
115
- /**
116
- * 服务台机器人向工单绑定的群内发送消息
117
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/bot-message/create
118
- */
119
- createHelpdeskBotMessage(body: CreateHelpdeskBotMessageRequest, query?: CreateHelpdeskBotMessageQuery): Promise<CreateHelpdeskBotMessageResponse>;
120
- /**
121
- * 创建工单自定义字段
122
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/ticket_customized_field/create-ticket-customized-field
123
- */
124
- createHelpdeskTicketCustomizedField(body: CreateHelpdeskTicketCustomizedFieldRequest): Promise<void>;
125
- /**
126
- * 删除工单自定义字段
127
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/ticket_customized_field/delete
128
- */
129
- deleteHelpdeskTicketCustomizedField(ticket_customized_field_id: string): Promise<void>;
130
- /**
131
- * 更新工单自定义字段
132
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/ticket_customized_field/update-ticket-customized-field
133
- */
134
- patchHelpdeskTicketCustomizedField(ticket_customized_field_id: string, body: PatchHelpdeskTicketCustomizedFieldRequest): Promise<void>;
135
- /**
136
- * 获取指定工单自定义字段
137
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/ticket_customized_field/get-ticket-customized-field
138
- */
139
- getHelpdeskTicketCustomizedField(ticket_customized_field_id: string): Promise<GetHelpdeskTicketCustomizedFieldResponse>;
140
- /**
141
- * 获取全部工单自定义字段
142
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/ticket_customized_field/list-ticket-customized-fields
143
- */
144
- listHelpdeskTicketCustomizedField(body: ListHelpdeskTicketCustomizedFieldRequest, query?: Pagination): Promise<ListHelpdeskTicketCustomizedFieldResponse> & AsyncIterableIterator<TicketCustomizedField>;
145
- /**
146
- * 创建知识库
147
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/faq/create
148
- */
149
- createHelpdeskFaq(body: CreateHelpdeskFaqRequest): Promise<CreateHelpdeskFaqResponse>;
150
- /**
151
- * 删除知识库
152
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/faq/delete
153
- */
154
- deleteHelpdeskFaq(id: string): Promise<void>;
155
- /**
156
- * 修改知识库
157
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/faq/patch
158
- */
159
- patchHelpdeskFaq(id: string, body: PatchHelpdeskFaqRequest): Promise<void>;
160
- /**
161
- * 获取指定知识库详情
162
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/faq/get
163
- */
164
- getHelpdeskFaq(id: string): Promise<GetHelpdeskFaqResponse>;
165
- /**
166
- * 获取全部知识库详情
167
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/faq/list
168
- */
169
- listHelpdeskFaq(query?: ListHelpdeskFaqQuery): Promise<ListHelpdeskFaqResponse> & AsyncIterableIterator<Faq>;
170
- /**
171
- * 获取知识库图像
172
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/faq/faq_image
173
- */
174
- faqImageHelpdeskFaq(id: string, image_key: string): Promise<ArrayBuffer>;
175
- /**
176
- * 搜索知识库
177
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/faq/search
178
- */
179
- searchHelpdeskFaq(query?: SearchHelpdeskFaqQuery): Paginated<Faq>;
180
- /**
181
- * 创建知识库分类
182
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/category/create
183
- */
184
- createHelpdeskCategory(body: CreateHelpdeskCategoryRequest): Promise<CreateHelpdeskCategoryResponse>;
185
- /**
186
- * 获取知识库分类
187
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/category/get
188
- */
189
- getHelpdeskCategory(id: string): Promise<GetHelpdeskCategoryResponse>;
190
- /**
191
- * 更新知识库分类详情
192
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/category/patch
193
- */
194
- patchHelpdeskCategory(id: string, body: PatchHelpdeskCategoryRequest): Promise<void>;
195
- /**
196
- * 删除知识库分类详情
197
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/category/delete
198
- */
199
- deleteHelpdeskCategory(id: string): Promise<void>;
200
- /**
201
- * 获取全部知识库分类
202
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/category/list-categories
203
- */
204
- listHelpdeskCategory(query?: ListHelpdeskCategoryQuery): Promise<ListHelpdeskCategoryResponse>;
205
- /**
206
- * 创建推送
207
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/notification/create
208
- */
209
- createHelpdeskNotification(body: CreateHelpdeskNotificationRequest, query?: CreateHelpdeskNotificationQuery): Promise<CreateHelpdeskNotificationResponse>;
210
- /**
211
- * 更新推送
212
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/notification/patch
213
- */
214
- patchHelpdeskNotification(notification_id: string, body: PatchHelpdeskNotificationRequest, query?: PatchHelpdeskNotificationQuery): Promise<void>;
215
- /**
216
- * 查询推送
217
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/notification/get
218
- */
219
- getHelpdeskNotification(notification_id: string, query?: GetHelpdeskNotificationQuery): Promise<GetHelpdeskNotificationResponse>;
220
- /**
221
- * 预览推送
222
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/notification/preview
223
- */
224
- previewHelpdeskNotification(notification_id: string): Promise<void>;
225
- /**
226
- * 提交审核
227
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/notification/submit_approve
228
- */
229
- submitApproveHelpdeskNotification(notification_id: string, body: SubmitApproveHelpdeskNotificationRequest): Promise<SubmitApproveHelpdeskNotificationResponse>;
230
- /**
231
- * 取消审核
232
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/notification/cancel_approve
233
- */
234
- cancelApproveHelpdeskNotification(notification_id: string): Promise<void>;
235
- /**
236
- * 执行推送
237
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/notification/execute_send
238
- */
239
- executeSendHelpdeskNotification(notification_id: string, body: ExecuteSendHelpdeskNotificationRequest): Promise<void>;
240
- /**
241
- * 取消推送
242
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/notification/cancel_send
243
- */
244
- cancelSendHelpdeskNotification(notification_id: string, body: CancelSendHelpdeskNotificationRequest): Promise<void>;
245
- /**
246
- * 订阅服务台事件
247
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/event/subscribe
248
- */
249
- subscribeHelpdeskEvent(body: SubscribeHelpdeskEventRequest): Promise<void>;
250
- /**
251
- * 取消订阅服务台事件
252
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/event/unsubscribe
253
- */
254
- unsubscribeHelpdeskEvent(body: UnsubscribeHelpdeskEventRequest): Promise<void>;
5
+ helpdesk: Helpdesk.Methods;
255
6
  }
256
7
  }
257
- export interface PatchHelpdeskAgentRequest {
258
- /** agent status */
259
- status?: number;
260
- }
261
- export interface AgentEmailHelpdeskAgentResponse {
262
- /** agent emails */
263
- agents?: string;
264
- }
265
- export interface CreateHelpdeskAgentScheduleRequest {
266
- /** 新客服日程 */
267
- agent_schedules?: AgentScheduleUpdateInfo[];
268
- }
269
- export interface PatchHelpdeskAgentSchedulesRequest {
270
- /** 工作日程列表 */
271
- agent_schedule?: AgentScheduleUpdateInfo;
272
- }
273
- export interface GetHelpdeskAgentSchedulesResponse {
274
- /** schedules of an agent */
275
- agent_schedule?: AgentSchedule;
276
- }
277
- export interface ListHelpdeskAgentScheduleQuery {
278
- /** 筛选条件, 1 - online客服, 2 - offline(手动)客服, 3 - off duty(下班)客服, 4 - 移除客服 */
279
- status: number[];
280
- }
281
- export interface ListHelpdeskAgentScheduleResponse {
282
- /** schedule of all agent */
283
- agent_schedules?: AgentSchedule[];
284
- }
285
- export interface CreateHelpdeskAgentSkillRequest {
286
- /** 技能名 */
287
- name?: string;
288
- /** 技能rules */
289
- rules?: AgentSkillRule[];
290
- /** 客服 ids */
291
- agent_ids?: string[];
292
- }
293
- export interface CreateHelpdeskAgentSkillResponse {
294
- agent_skill_id?: string;
295
- }
296
- export interface PatchHelpdeskAgentSkillRequest {
297
- /** 更新技能 */
298
- agent_skill?: AgentSkill;
299
- }
300
- export interface GetHelpdeskAgentSkillResponse {
301
- /** agent skill */
302
- agent_skill?: AgentSkill;
303
- }
304
- export interface ListHelpdeskAgentSkillResponse {
305
- /** list of agent groups */
306
- agent_skills?: AgentSkill[];
307
- }
308
- export interface ListHelpdeskAgentSkillRuleResponse {
309
- /** all rules for agent skill */
310
- rules?: AgentSkillRule[];
311
- }
312
- export interface StartServiceHelpdeskTicketRequest {
313
- /** 是否直接进入人工(若appointed_agents填写了,该值为必填) */
314
- human_service?: boolean;
315
- /** 客服 open ids (获取方式参考[获取单个用户信息](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/get)),human_service需要为true */
316
- appointed_agents?: string[];
317
- /** 用户 open id,(获取方式参考[获取单个用户信息](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/get)) */
318
- open_id: string;
319
- /** 工单来源自定义信息,长度限制1024字符,如设置,[获取工单详情](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/ticket/get)会返回此信息 */
320
- customized_info?: string;
321
- }
322
- export interface StartServiceHelpdeskTicketResponse {
323
- /** chat id */
324
- chat_id: string;
325
- }
326
- export interface GetHelpdeskTicketResponse {
327
- /** ticket detail */
328
- ticket?: Ticket;
329
- }
330
- export interface UpdateHelpdeskTicketRequest {
331
- /** new status, 1: 已创建, 2: 处理中, 3: 排队中, 5: 待定, 50: 机器人关闭工单, 51: 关闭工单 */
332
- status?: number;
333
- /** 新标签名 */
334
- tag_names?: string[];
335
- /** 新评论 */
336
- comment?: string;
337
- /** 自定义字段 */
338
- customized_fields?: CustomizedFieldDisplayItem[];
339
- /** ticket stage */
340
- ticket_type?: number;
341
- /** 工单是否解决,1: 未解决, 2: 已解决 */
342
- solved?: number;
343
- /** 工单来源渠道ID */
344
- channel?: number;
345
- }
346
- export interface ListHelpdeskTicketQuery {
347
- /** 搜索条件:工单ID */
348
- ticket_id?: string;
349
- /** 搜索条件: 客服id */
350
- agent_id?: string;
351
- /** 搜索条件: 关单客服id */
352
- closed_by_id?: string;
353
- /** 搜索条件: 工单类型 1:bot 2:人工 */
354
- type?: number;
355
- /** 搜索条件: 工单渠道 */
356
- channel?: number;
357
- /** 搜索条件: 工单是否解决 1:没解决 2:已解决 */
358
- solved?: number;
359
- /** 搜索条件: 工单评分 */
360
- score?: number;
361
- /** 搜索条件: 工单状态列表 */
362
- status_list?: number[];
363
- /** 搜索条件: 用户名称 */
364
- guest_name?: string;
365
- /** 搜索条件: 用户id */
366
- guest_id?: string;
367
- /** 搜索条件: 用户标签列表 */
368
- tags?: string[];
369
- /** 页数, 从1开始, 默认为1 */
370
- page?: number;
371
- /** 当前页大小,最大为200, 默认为20。分页查询最多累计返回一万条数据,超过一万条请更改查询条件,推荐通过时间查询。 */
372
- page_size?: number;
373
- /** 搜索条件: 工单创建起始时间 ms (也需要填上create_time_end),相当于>=create_time_start */
374
- create_time_start?: number;
375
- /** 搜索条件: 工单创建结束时间 ms (也需要填上create_time_start),相当于<=create_time_end */
376
- create_time_end?: number;
377
- /** 搜索条件: 工单修改起始时间 ms (也需要填上update_time_end) */
378
- update_time_start?: number;
379
- /** 搜索条件: 工单修改结束时间 ms(也需要填上update_time_start) */
380
- update_time_end?: number;
381
- }
382
- export interface ListHelpdeskTicketResponse {
383
- /** the total count */
384
- total?: number;
385
- tickets?: Ticket[];
386
- }
387
- export interface TicketImageHelpdeskTicketQuery {
388
- /** 工单ID */
389
- ticket_id: string;
390
- /** 消息ID[查询消息ID](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/ticket-message/list) */
391
- msg_id: string;
392
- /** index,当消息类型为post时,需指定图片index,index从0开始。当消息类型为img时,无需index */
393
- index?: number;
394
- }
395
- export interface AnswerUserQueryHelpdeskTicketRequest {
396
- /** 事件ID,可从订阅事件中提取 */
397
- event_id: string;
398
- /** faq结果列表 */
399
- faqs?: UserQueryFaqInfo[];
400
- }
401
- export interface CustomizedFieldsHelpdeskTicketQuery {
402
- /** visible only */
403
- visible_only?: boolean;
404
- }
405
- export interface CustomizedFieldsHelpdeskTicketResponse {
406
- /** user customized fields */
407
- user_customized_fields?: UserCustomizedField[];
408
- /** ticket customized fields */
409
- ticket_customized_fields?: TicketCustomizedField[];
410
- }
411
- export interface CreateHelpdeskTicketMessageRequest {
412
- /** 消息类型;text:纯文本;post:富文本 */
413
- msg_type: string;
414
- /** - 纯文本,参考[发送文本消息](/ssl:ttdoc/ukTMukTMukTM/uUjNz4SN2MjL1YzM)中的content;- 富文本,参考[发送富文本消息](/ssl:ttdoc/ukTMukTMukTM/uMDMxEjLzATMx4yMwETM)中的content */
415
- content: string;
416
- }
417
- export interface CreateHelpdeskTicketMessageResponse {
418
- /** chat消息open ID */
419
- message_id?: string;
420
- }
421
- export interface ListHelpdeskTicketMessageQuery {
422
- /** 起始时间 */
423
- time_start?: number;
424
- /** 结束时间 */
425
- time_end?: number;
426
- /** 页数ID */
427
- page?: number;
428
- /** 消息数量,最大200,默认20 */
429
- page_size?: number;
430
- }
431
- export interface ListHelpdeskTicketMessageResponse {
432
- /** list of ticket messages */
433
- messages?: TicketMessage[];
434
- /** total number of messages */
435
- total?: number;
436
- }
437
- export interface CreateHelpdeskBotMessageRequest {
438
- /** 消息类型 */
439
- msg_type: 'text' | 'post' | 'image' | 'interactive';
440
- /** 消息内容 */
441
- content: string;
442
- /** 接收消息用户id */
443
- receiver_id: string;
444
- /** 接收消息方式,chat(服务台专属服务群)或user(服务台机器人私聊)。若选择专属服务群,用户有正在处理的工单将会发送失败。默认以chat方式发送。 */
445
- receive_type?: 'chat' | 'user';
446
- }
447
- export interface CreateHelpdeskBotMessageQuery {
448
- /** 此次调用中使用的用户ID的类型 */
449
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
450
- }
451
- export interface CreateHelpdeskBotMessageResponse {
452
- message_id?: string;
453
- }
454
- export interface CreateHelpdeskTicketCustomizedFieldRequest {
455
- /** help desk id */
456
- helpdesk_id: string;
457
- /** key name */
458
- key_name: string;
459
- /** display name */
460
- display_name: string;
461
- /** the position of ticket customized field in the page */
462
- position: string;
463
- /** type of the field */
464
- field_type: string;
465
- /** description of the field */
466
- description: string;
467
- /** if the field is visible */
468
- visible: boolean;
469
- /** if the field is editable */
470
- editable: boolean;
471
- /** if the field is required */
472
- required: boolean;
473
- /** if the dropdown field supports multi-select */
474
- dropdown_allow_multiple?: boolean;
475
- }
476
- export interface PatchHelpdeskTicketCustomizedFieldRequest {
477
- /** display name */
478
- display_name?: string;
479
- /** the position of ticket customized field in the page */
480
- position?: string;
481
- /** description of the field */
482
- description?: string;
483
- /** if the field is visible */
484
- visible?: boolean;
485
- /** if the field is required */
486
- required?: boolean;
487
- }
488
- export interface GetHelpdeskTicketCustomizedFieldResponse {
489
- /** ticket customized field id */
490
- ticket_customized_field_id: string;
491
- /** help desk id */
492
- helpdesk_id: string;
493
- /** key name */
494
- key_name: string;
495
- /** display name */
496
- display_name: string;
497
- /** the position of ticket customized field in the page */
498
- position: string;
499
- /** type of the field */
500
- field_type: string;
501
- /** description of the field */
502
- description: string;
503
- /** if the field is visible */
504
- visible: boolean;
505
- /** if the field is editable */
506
- editable: boolean;
507
- /** if the field is required */
508
- required: boolean;
509
- /** the time when the field is created */
510
- created_at?: string;
511
- /** the time when the field is updated */
512
- updated_at?: string;
513
- /** the user who created the ticket customized field */
514
- created_by?: TicketUser;
515
- /** the user who recently updated the ticket customized field */
516
- updated_by?: TicketUser;
517
- /** if the dropdown field supports multi-select */
518
- dropdown_allow_multiple?: boolean;
519
- }
520
- export interface ListHelpdeskTicketCustomizedFieldRequest {
521
- /** 是否可见 */
522
- visible?: boolean;
523
- }
524
- export interface ListHelpdeskTicketCustomizedFieldResponse {
525
- /** whether there is more data */
526
- has_more?: boolean;
527
- /** the next page token */
528
- next_page_token?: string;
529
- /** all the ticket customized fields */
530
- items?: TicketCustomizedField[];
531
- }
532
- export interface CreateHelpdeskFaqRequest {
533
- /** 知识库详情 */
534
- faq?: FaqCreateInfo;
535
- }
536
- export interface CreateHelpdeskFaqResponse {
537
- /** faq detail */
538
- faq?: Faq;
539
- }
540
- export interface PatchHelpdeskFaqRequest {
541
- /** 修改的知识库内容 */
542
- faq?: FaqUpdateInfo;
543
- }
544
- export interface GetHelpdeskFaqResponse {
545
- /** faq detail */
546
- faq?: Faq;
547
- }
548
- export interface ListHelpdeskFaqQuery extends Pagination {
549
- /** 知识库分类ID */
550
- category_id?: string;
551
- /** 搜索条件: 知识库状态 1:在线 0:删除,可恢复 2:删除,不可恢复 */
552
- status?: string;
553
- /** 搜索条件: 关键词,匹配问题标题,问题关键字,用户姓名 */
554
- search?: string;
555
- }
556
- export interface ListHelpdeskFaqResponse {
557
- /** if there's next page */
558
- has_more?: boolean;
559
- /** the next page token */
560
- page_token?: string;
561
- /** the page size */
562
- page_size?: number;
563
- /** the total count */
564
- total?: number;
565
- items?: Faq[];
566
- }
567
- export interface SearchHelpdeskFaqQuery extends Pagination {
568
- /** 搜索query,query内容如果不是英文,包含中文空格等有两种编码策略:1. url编码 2. base64编码,同时加上base64=true参数 */
569
- query: string;
570
- /** 是否转换为base64,输入true表示是,不填写表示否,中文需要转换为base64 */
571
- base64?: string;
572
- }
573
- export interface CreateHelpdeskCategoryRequest {
574
- /** category name */
575
- name: string;
576
- /** parent category id, if any */
577
- parent_id: string;
578
- /** category language */
579
- language?: string;
580
- }
581
- export interface CreateHelpdeskCategoryResponse {
582
- /** category */
583
- category?: Category;
584
- }
585
- export interface GetHelpdeskCategoryResponse {
586
- /** category id */
587
- category_id: string;
588
- /** category id, for backward compatibility */
589
- id: string;
590
- /** category name */
591
- name: string;
592
- /** helpdesk id */
593
- helpdesk_id: string;
594
- /** category language */
595
- language?: string;
596
- }
597
- export interface PatchHelpdeskCategoryRequest {
598
- /** category name */
599
- name?: string;
600
- /** parent category id, if any */
601
- parent_id?: string;
602
- }
603
- export interface ListHelpdeskCategoryQuery {
604
- /** 知识库分类语言 */
605
- lang?: string;
606
- /** 排序键。1: 根据知识库分类更新时间排序 */
607
- order_by?: number;
608
- /** 顺序。true: 正序;false:反序 */
609
- asc?: boolean;
610
- }
611
- export interface ListHelpdeskCategoryResponse {
612
- /** list of categories */
613
- categories?: Category[];
614
- }
615
- export interface CreateHelpdeskNotificationRequest {
616
- /** 唯一ID */
617
- id?: string;
618
- /** 任务名称 */
619
- job_name?: string;
620
- /** 0(草稿)、1(等待审批)、 2(审批未通过)、3(正在发送中)、4(发送完成)、5(等待设置发送时间)、6(取消发送)、7(新人入职执行发送)、8(等待倒计时发送) */
621
- status?: number;
622
- /** 创建人 */
623
- create_user?: NotificationUser;
624
- /** 创建时间(毫秒时间戳) */
625
- created_at?: string;
626
- /** 更新用户 */
627
- update_user?: NotificationUser;
628
- /** 更新时间(毫秒时间戳) */
629
- updated_at?: string;
630
- /** 目标推送用户 */
631
- target_user_count?: number;
632
- /** 已推送用户总数 */
633
- sent_user_count?: number;
634
- /** 已读用户总数 */
635
- read_user_count?: number;
636
- /** 推送任务触发时间(毫秒时间戳) */
637
- send_at?: string;
638
- /** 推送内容,详见:https://open.feishu.cn/tool/cardbuilder?from=howtoguide */
639
- push_content?: string;
640
- /** 0(定时推送:push_scope不能等于3) 1(新人入职推送:push_scope必须等于1或者3;new_staff_scope_type不能为空) */
641
- push_type?: number;
642
- /** 推送范围(服务台私信) 0:组织内全部成员(user_list和department_list必须为空) 1:不推送任何成员(user_list和department_list必须为空,chat_list不可为空) 2:推送到部分成员(user_list或department_list不能为空) 3:入职新人 以上四种状态,chat_list都相对独立,只有在推送范围为1时,必须需要设置chat_list */
643
- push_scope_type?: number;
644
- /** 新人入职范围类型(push_type为1时生效) 0:组织内所有新人 1:组织内特定的部门(new_staff_scope_department_list 字段不能为空) */
645
- new_staff_scope_type?: number;
646
- /** 新人入职生效部门列表 */
647
- new_staff_scope_department_list?: NotificationDepartment[];
648
- /** push推送到成员列表 */
649
- user_list?: NotificationUser[];
650
- /** push推送到的部门信息列表 */
651
- department_list?: NotificationDepartment[];
652
- /** push推送到的会话列表(群) */
653
- chat_list?: NotificationChat[];
654
- /** 预留扩展字段 */
655
- ext?: string;
656
- }
657
- export interface CreateHelpdeskNotificationQuery {
658
- /** 此次调用中使用的用户ID的类型 */
659
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
660
- }
661
- export interface CreateHelpdeskNotificationResponse {
662
- /** 创建成功后的唯一id */
663
- notification_id?: string;
664
- /** 当前状态 */
665
- status?: number;
666
- }
667
- export interface PatchHelpdeskNotificationRequest {
668
- /** 唯一ID */
669
- id?: string;
670
- /** 任务名称 */
671
- job_name?: string;
672
- /** 0(草稿)、1(等待审批)、 2(审批未通过)、3(正在发送中)、4(发送完成)、5(等待设置发送时间)、6(取消发送)、7(新人入职执行发送)、8(等待倒计时发送) */
673
- status?: number;
674
- /** 创建人 */
675
- create_user?: NotificationUser;
676
- /** 创建时间(毫秒时间戳) */
677
- created_at?: string;
678
- /** 更新用户 */
679
- update_user?: NotificationUser;
680
- /** 更新时间(毫秒时间戳) */
681
- updated_at?: string;
682
- /** 目标推送用户 */
683
- target_user_count?: number;
684
- /** 已推送用户总数 */
685
- sent_user_count?: number;
686
- /** 已读用户总数 */
687
- read_user_count?: number;
688
- /** 推送任务触发时间(毫秒时间戳) */
689
- send_at?: string;
690
- /** 推送内容,详见:https://open.feishu.cn/tool/cardbuilder?from=howtoguide */
691
- push_content?: string;
692
- /** 0(定时推送:push_scope不能等于3) 1(新人入职推送:push_scope必须等于1或者3;new_staff_scope_type不能为空) */
693
- push_type?: number;
694
- /** 推送范围(服务台私信) 0:组织内全部成员(user_list和department_list必须为空) 1:不推送任何成员(user_list和department_list必须为空,chat_list不可为空) 2:推送到部分成员(user_list或department_list不能为空) 3:入职新人 以上四种状态,chat_list都相对独立,只有在推送范围为1时,必须需要设置chat_list */
695
- push_scope_type?: number;
696
- /** 新人入职范围类型(push_type为1时生效) 0:组织内所有新人 1:组织内特定的部门(new_staff_scope_department_list 字段不能为空) */
697
- new_staff_scope_type?: number;
698
- /** 新人入职生效部门列表 */
699
- new_staff_scope_department_list?: NotificationDepartment[];
700
- /** push推送到成员列表 */
701
- user_list?: NotificationUser[];
702
- /** push推送到的部门信息列表 */
703
- department_list?: NotificationDepartment[];
704
- /** push推送到的会话列表(群) */
705
- chat_list?: NotificationChat[];
706
- /** 预留扩展字段 */
707
- ext?: string;
708
- }
709
- export interface PatchHelpdeskNotificationQuery {
710
- /** 此次调用中使用的用户ID的类型 */
711
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
712
- }
713
- export interface GetHelpdeskNotificationQuery {
714
- /** 此次调用中使用的用户ID的类型 */
715
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
716
- }
717
- export interface GetHelpdeskNotificationResponse {
718
- /** push任务详情 */
719
- notification?: Notification;
720
- /** 审批链接 */
721
- approval_app_link?: string;
722
- }
723
- export interface SubmitApproveHelpdeskNotificationRequest {
724
- /** 提交审批理由 */
725
- reason: string;
726
- }
727
- export interface SubmitApproveHelpdeskNotificationResponse {
728
- /** 是否有权限创建或者管理审批流程 (有两种情况会导致没有权限: 1:用户没有安装服务台小程序,需要在https://app.feishu.cn/app/cli_9f9f8825d53b900d或者https://ftest.feishu.cn/admin/appCenter/manage/cli_9f9f8825d53b900d?lang=zh-CN 安装小程序 2:用户安装的服务台小程序版本过低) */
729
- has_access?: boolean;
730
- }
731
- export interface ExecuteSendHelpdeskNotificationRequest {
732
- /** 发送时间戳(毫秒) */
733
- send_at: string;
734
- }
735
- export interface CancelSendHelpdeskNotificationRequest {
736
- /** 是否召回已发送的消息,新人入职消息同样适用 */
737
- is_recall: boolean;
738
- }
739
- export interface SubscribeHelpdeskEventRequest {
740
- /** 可订阅的事件列表 */
741
- events: Event[];
742
- }
743
- export interface UnsubscribeHelpdeskEventRequest {
744
- /** event list to unsubscribe */
745
- events: Event[];
8
+ export declare namespace Helpdesk {
9
+ interface Methods {
10
+ agent: Agent.Methods;
11
+ agentSchedule: AgentSchedule.Methods;
12
+ agentSkill: AgentSkill.Methods;
13
+ agentSkillRule: AgentSkillRule.Methods;
14
+ ticket: Ticket.Methods;
15
+ bot: Bot.Methods;
16
+ ticketCustomizedField: TicketCustomizedField.Methods;
17
+ faq: Faq.Methods;
18
+ category: Category.Methods;
19
+ notification: Notification.Methods;
20
+ event: Event.Methods;
21
+ }
22
+ namespace Agent {
23
+ interface Methods {
24
+ schedules: Schedules.Methods;
25
+ /**
26
+ * 更新客服信息
27
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/agent/patch
28
+ */
29
+ patch(agent_id: string, body: PatchRequest): Promise<void>;
30
+ /**
31
+ * 获取客服邮箱
32
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/agent/agent_email
33
+ */
34
+ agentEmail(): Promise<AgentEmailResponse>;
35
+ }
36
+ interface PatchRequest {
37
+ /** agent status */
38
+ status?: number;
39
+ }
40
+ interface AgentEmailResponse {
41
+ /** agent emails */
42
+ agents?: string;
43
+ }
44
+ namespace Schedules {
45
+ interface Methods {
46
+ /**
47
+ * 删除客服工作日程
48
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/agent-schedules/delete
49
+ */
50
+ delete(agent_id: string): Promise<void>;
51
+ /**
52
+ * 更新客服工作日程
53
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/agent-schedules/patch
54
+ */
55
+ patch(agent_id: string, body: PatchRequest): Promise<void>;
56
+ /**
57
+ * 查询指定客服工作日程
58
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/agent-schedules/get
59
+ */
60
+ get(agent_id: string): Promise<GetResponse>;
61
+ }
62
+ interface PatchRequest {
63
+ /** 工作日程列表 */
64
+ agent_schedule?: Lark.AgentScheduleUpdateInfo;
65
+ }
66
+ interface GetResponse {
67
+ /** schedules of an agent */
68
+ agent_schedule?: Lark.AgentSchedule;
69
+ }
70
+ }
71
+ }
72
+ namespace AgentSchedule {
73
+ interface Methods {
74
+ /**
75
+ * 创建客服工作日程
76
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/agent_schedule/create
77
+ */
78
+ create(body: CreateRequest): Promise<void>;
79
+ /**
80
+ * 查询全部客服工作日程
81
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/agent_schedule/list
82
+ */
83
+ list(query?: ListQuery): Promise<ListResponse>;
84
+ }
85
+ interface CreateRequest {
86
+ /** 新客服日程 */
87
+ agent_schedules?: Lark.AgentScheduleUpdateInfo[];
88
+ }
89
+ interface ListQuery {
90
+ /** 筛选条件, 1 - online客服, 2 - offline(手动)客服, 3 - off duty(下班)客服, 4 - 移除客服 */
91
+ status: number[];
92
+ }
93
+ interface ListResponse {
94
+ /** schedule of all agent */
95
+ agent_schedules?: Lark.AgentSchedule[];
96
+ }
97
+ }
98
+ namespace AgentSkill {
99
+ interface Methods {
100
+ /**
101
+ * 创建客服技能
102
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/agent_skill/create
103
+ */
104
+ create(body: CreateRequest): Promise<CreateResponse>;
105
+ /**
106
+ * 删除客服技能
107
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/agent_skill/delete
108
+ */
109
+ delete(agent_skill_id: string): Promise<void>;
110
+ /**
111
+ * 更新客服技能
112
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/agent_skill/patch
113
+ */
114
+ patch(agent_skill_id: string, body: PatchRequest): Promise<void>;
115
+ /**
116
+ * 查询指定客服技能
117
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/agent_skill/get
118
+ */
119
+ get(agent_skill_id: string): Promise<GetResponse>;
120
+ /**
121
+ * 查询全部客服技能
122
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/agent_skill/list
123
+ */
124
+ list(): Promise<ListResponse>;
125
+ }
126
+ interface CreateRequest {
127
+ /** 技能名 */
128
+ name?: string;
129
+ /** 技能rules */
130
+ rules?: Lark.AgentSkillRule[];
131
+ /** 客服 ids */
132
+ agent_ids?: string[];
133
+ }
134
+ interface CreateResponse {
135
+ agent_skill_id?: string;
136
+ }
137
+ interface PatchRequest {
138
+ /** 更新技能 */
139
+ agent_skill?: Lark.AgentSkill;
140
+ }
141
+ interface GetResponse {
142
+ /** agent skill */
143
+ agent_skill?: Lark.AgentSkill;
144
+ }
145
+ interface ListResponse {
146
+ /** list of agent groups */
147
+ agent_skills?: Lark.AgentSkill[];
148
+ }
149
+ }
150
+ namespace AgentSkillRule {
151
+ interface Methods {
152
+ /**
153
+ * 获取客服技能列表
154
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/agent_skill_rule/list
155
+ */
156
+ list(): Promise<ListResponse>;
157
+ }
158
+ interface ListResponse {
159
+ /** all rules for agent skill */
160
+ rules?: Lark.AgentSkillRule[];
161
+ }
162
+ }
163
+ namespace Ticket {
164
+ interface Methods {
165
+ message: Message.Methods;
166
+ /**
167
+ * 创建服务台对话
168
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/ticket/start_service
169
+ */
170
+ startService(body: StartServiceRequest): Promise<StartServiceResponse>;
171
+ /**
172
+ * 查询指定工单详情
173
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/ticket/get
174
+ */
175
+ get(ticket_id: string): Promise<GetResponse>;
176
+ /**
177
+ * 更新工单详情
178
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/ticket/update
179
+ */
180
+ update(ticket_id: string, body: UpdateRequest): Promise<void>;
181
+ /**
182
+ * 查询全部工单详情
183
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/ticket/list
184
+ */
185
+ list(query?: ListQuery): Promise<ListResponse>;
186
+ /**
187
+ * 获取工单内图像
188
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/ticket/ticket_image
189
+ */
190
+ ticketImage(query?: TicketImageQuery): Promise<ArrayBuffer>;
191
+ /**
192
+ * 回复用户在工单里的提问
193
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/ticket/answer_user_query
194
+ */
195
+ answerUserQuery(ticket_id: string, body: AnswerUserQueryRequest): Promise<void>;
196
+ /**
197
+ * 获取服务台自定义字段
198
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/ticket/customized_fields
199
+ */
200
+ customizedFields(query?: CustomizedFieldsQuery): Promise<CustomizedFieldsResponse>;
201
+ }
202
+ interface StartServiceRequest {
203
+ /** 是否直接进入人工(若appointed_agents填写了,该值为必填) */
204
+ human_service?: boolean;
205
+ /** 客服 open ids (获取方式参考[获取单个用户信息](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/get)),human_service需要为true */
206
+ appointed_agents?: string[];
207
+ /** 用户 open id,(获取方式参考[获取单个用户信息](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/get)) */
208
+ open_id: string;
209
+ /** 工单来源自定义信息,长度限制1024字符,如设置,[获取工单详情](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/ticket/get)会返回此信息 */
210
+ customized_info?: string;
211
+ }
212
+ interface StartServiceResponse {
213
+ /** chat id */
214
+ chat_id: string;
215
+ }
216
+ interface GetResponse {
217
+ /** ticket detail */
218
+ ticket?: Lark.Ticket;
219
+ }
220
+ interface UpdateRequest {
221
+ /** new status, 1: 已创建, 2: 处理中, 3: 排队中, 5: 待定, 50: 机器人关闭工单, 51: 关闭工单 */
222
+ status?: number;
223
+ /** 新标签名 */
224
+ tag_names?: string[];
225
+ /** 新评论 */
226
+ comment?: string;
227
+ /** 自定义字段 */
228
+ customized_fields?: Lark.CustomizedFieldDisplayItem[];
229
+ /** ticket stage */
230
+ ticket_type?: number;
231
+ /** 工单是否解决,1: 未解决, 2: 已解决 */
232
+ solved?: number;
233
+ /** 工单来源渠道ID */
234
+ channel?: number;
235
+ }
236
+ interface ListQuery {
237
+ /** 搜索条件:工单ID */
238
+ ticket_id?: string;
239
+ /** 搜索条件: 客服id */
240
+ agent_id?: string;
241
+ /** 搜索条件: 关单客服id */
242
+ closed_by_id?: string;
243
+ /** 搜索条件: 工单类型 1:bot 2:人工 */
244
+ type?: number;
245
+ /** 搜索条件: 工单渠道 */
246
+ channel?: number;
247
+ /** 搜索条件: 工单是否解决 1:没解决 2:已解决 */
248
+ solved?: number;
249
+ /** 搜索条件: 工单评分 */
250
+ score?: number;
251
+ /** 搜索条件: 工单状态列表 */
252
+ status_list?: number[];
253
+ /** 搜索条件: 用户名称 */
254
+ guest_name?: string;
255
+ /** 搜索条件: 用户id */
256
+ guest_id?: string;
257
+ /** 搜索条件: 用户标签列表 */
258
+ tags?: string[];
259
+ /** 页数, 从1开始, 默认为1 */
260
+ page?: number;
261
+ /** 当前页大小,最大为200, 默认为20。分页查询最多累计返回一万条数据,超过一万条请更改查询条件,推荐通过时间查询。 */
262
+ page_size?: number;
263
+ /** 搜索条件: 工单创建起始时间 ms (也需要填上create_time_end),相当于>=create_time_start */
264
+ create_time_start?: number;
265
+ /** 搜索条件: 工单创建结束时间 ms (也需要填上create_time_start),相当于<=create_time_end */
266
+ create_time_end?: number;
267
+ /** 搜索条件: 工单修改起始时间 ms (也需要填上update_time_end) */
268
+ update_time_start?: number;
269
+ /** 搜索条件: 工单修改结束时间 ms(也需要填上update_time_start) */
270
+ update_time_end?: number;
271
+ }
272
+ interface ListResponse {
273
+ /** the total count */
274
+ total?: number;
275
+ tickets?: Lark.Ticket[];
276
+ }
277
+ interface TicketImageQuery {
278
+ /** 工单ID */
279
+ ticket_id: string;
280
+ /** 消息ID[查询消息ID](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/ticket-message/list) */
281
+ msg_id: string;
282
+ /** index,当消息类型为post时,需指定图片index,index从0开始。当消息类型为img时,无需index */
283
+ index?: number;
284
+ }
285
+ interface AnswerUserQueryRequest {
286
+ /** 事件ID,可从订阅事件中提取 */
287
+ event_id: string;
288
+ /** faq结果列表 */
289
+ faqs?: Lark.UserQueryFaqInfo[];
290
+ }
291
+ interface CustomizedFieldsQuery {
292
+ /** visible only */
293
+ visible_only?: boolean;
294
+ }
295
+ interface CustomizedFieldsResponse {
296
+ /** user customized fields */
297
+ user_customized_fields?: Lark.UserCustomizedField[];
298
+ /** ticket customized fields */
299
+ ticket_customized_fields?: Lark.TicketCustomizedField[];
300
+ }
301
+ namespace Message {
302
+ interface Methods {
303
+ /**
304
+ * 发送工单消息
305
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/ticket-message/create
306
+ */
307
+ create(ticket_id: string, body: CreateRequest): Promise<CreateResponse>;
308
+ /**
309
+ * 获取工单消息详情
310
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/ticket-message/list
311
+ */
312
+ list(ticket_id: string, query?: ListQuery): Promise<ListResponse>;
313
+ }
314
+ interface CreateRequest {
315
+ /** 消息类型;text:纯文本;post:富文本 */
316
+ msg_type: string;
317
+ /** - 纯文本,参考[发送文本消息](/ssl:ttdoc/ukTMukTMukTM/uUjNz4SN2MjL1YzM)中的content;- 富文本,参考[发送富文本消息](/ssl:ttdoc/ukTMukTMukTM/uMDMxEjLzATMx4yMwETM)中的content */
318
+ content: string;
319
+ }
320
+ interface CreateResponse {
321
+ /** chat消息open ID */
322
+ message_id?: string;
323
+ }
324
+ interface ListQuery {
325
+ /** 起始时间 */
326
+ time_start?: number;
327
+ /** 结束时间 */
328
+ time_end?: number;
329
+ /** 页数ID */
330
+ page?: number;
331
+ /** 消息数量,最大200,默认20 */
332
+ page_size?: number;
333
+ }
334
+ interface ListResponse {
335
+ /** list of ticket messages */
336
+ messages?: Lark.TicketMessage[];
337
+ /** total number of messages */
338
+ total?: number;
339
+ }
340
+ }
341
+ }
342
+ namespace Bot {
343
+ interface Methods {
344
+ message: Message.Methods;
345
+ }
346
+ namespace Message {
347
+ interface Methods {
348
+ /**
349
+ * 服务台机器人向工单绑定的群内发送消息
350
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/bot-message/create
351
+ */
352
+ create(body: CreateRequest, query?: CreateQuery): Promise<CreateResponse>;
353
+ }
354
+ interface CreateRequest {
355
+ /** 消息类型 */
356
+ msg_type: 'text' | 'post' | 'image' | 'interactive';
357
+ /** 消息内容 */
358
+ content: string;
359
+ /** 接收消息用户id */
360
+ receiver_id: string;
361
+ /** 接收消息方式,chat(服务台专属服务群)或user(服务台机器人私聊)。若选择专属服务群,用户有正在处理的工单将会发送失败。默认以chat方式发送。 */
362
+ receive_type?: 'chat' | 'user';
363
+ }
364
+ interface CreateQuery {
365
+ /** 此次调用中使用的用户ID的类型 */
366
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
367
+ }
368
+ interface CreateResponse {
369
+ message_id?: string;
370
+ }
371
+ }
372
+ }
373
+ namespace TicketCustomizedField {
374
+ interface Methods {
375
+ /**
376
+ * 创建工单自定义字段
377
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/ticket_customized_field/create-ticket-customized-field
378
+ */
379
+ create(body: CreateRequest): Promise<void>;
380
+ /**
381
+ * 删除工单自定义字段
382
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/ticket_customized_field/delete
383
+ */
384
+ delete(ticket_customized_field_id: string): Promise<void>;
385
+ /**
386
+ * 更新工单自定义字段
387
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/ticket_customized_field/update-ticket-customized-field
388
+ */
389
+ patch(ticket_customized_field_id: string, body: PatchRequest): Promise<void>;
390
+ /**
391
+ * 获取指定工单自定义字段
392
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/ticket_customized_field/get-ticket-customized-field
393
+ */
394
+ get(ticket_customized_field_id: string): Promise<GetResponse>;
395
+ /**
396
+ * 获取全部工单自定义字段
397
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/ticket_customized_field/list-ticket-customized-fields
398
+ */
399
+ list(body: ListRequest, query?: Pagination): Promise<ListResponse> & AsyncIterableIterator<Lark.TicketCustomizedField>;
400
+ }
401
+ interface CreateRequest {
402
+ /** help desk id */
403
+ helpdesk_id: string;
404
+ /** key name */
405
+ key_name: string;
406
+ /** display name */
407
+ display_name: string;
408
+ /** the position of ticket customized field in the page */
409
+ position: string;
410
+ /** type of the field */
411
+ field_type: string;
412
+ /** description of the field */
413
+ description: string;
414
+ /** if the field is visible */
415
+ visible: boolean;
416
+ /** if the field is editable */
417
+ editable: boolean;
418
+ /** if the field is required */
419
+ required: boolean;
420
+ /** if the dropdown field supports multi-select */
421
+ dropdown_allow_multiple?: boolean;
422
+ }
423
+ interface PatchRequest {
424
+ /** display name */
425
+ display_name?: string;
426
+ /** the position of ticket customized field in the page */
427
+ position?: string;
428
+ /** description of the field */
429
+ description?: string;
430
+ /** if the field is visible */
431
+ visible?: boolean;
432
+ /** if the field is required */
433
+ required?: boolean;
434
+ }
435
+ interface GetResponse {
436
+ /** ticket customized field id */
437
+ ticket_customized_field_id: string;
438
+ /** help desk id */
439
+ helpdesk_id: string;
440
+ /** key name */
441
+ key_name: string;
442
+ /** display name */
443
+ display_name: string;
444
+ /** the position of ticket customized field in the page */
445
+ position: string;
446
+ /** type of the field */
447
+ field_type: string;
448
+ /** description of the field */
449
+ description: string;
450
+ /** if the field is visible */
451
+ visible: boolean;
452
+ /** if the field is editable */
453
+ editable: boolean;
454
+ /** if the field is required */
455
+ required: boolean;
456
+ /** the time when the field is created */
457
+ created_at?: string;
458
+ /** the time when the field is updated */
459
+ updated_at?: string;
460
+ /** the user who created the ticket customized field */
461
+ created_by?: Lark.TicketUser;
462
+ /** the user who recently updated the ticket customized field */
463
+ updated_by?: Lark.TicketUser;
464
+ /** if the dropdown field supports multi-select */
465
+ dropdown_allow_multiple?: boolean;
466
+ }
467
+ interface ListRequest {
468
+ /** 是否可见 */
469
+ visible?: boolean;
470
+ }
471
+ interface ListResponse {
472
+ /** whether there is more data */
473
+ has_more?: boolean;
474
+ /** the next page token */
475
+ next_page_token?: string;
476
+ /** all the ticket customized fields */
477
+ items?: Lark.TicketCustomizedField[];
478
+ }
479
+ }
480
+ namespace Faq {
481
+ interface Methods {
482
+ /**
483
+ * 创建知识库
484
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/faq/create
485
+ */
486
+ create(body: CreateRequest): Promise<CreateResponse>;
487
+ /**
488
+ * 删除知识库
489
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/faq/delete
490
+ */
491
+ delete(id: string): Promise<void>;
492
+ /**
493
+ * 修改知识库
494
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/faq/patch
495
+ */
496
+ patch(id: string, body: PatchRequest): Promise<void>;
497
+ /**
498
+ * 获取指定知识库详情
499
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/faq/get
500
+ */
501
+ get(id: string): Promise<GetResponse>;
502
+ /**
503
+ * 获取全部知识库详情
504
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/faq/list
505
+ */
506
+ list(query?: ListQuery): Promise<ListResponse> & AsyncIterableIterator<Lark.Faq>;
507
+ /**
508
+ * 获取知识库图像
509
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/faq/faq_image
510
+ */
511
+ faqImage(id: string, image_key: string): Promise<ArrayBuffer>;
512
+ /**
513
+ * 搜索知识库
514
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/faq/search
515
+ */
516
+ search(query?: SearchQuery): Paginated<Lark.Faq>;
517
+ }
518
+ interface CreateRequest {
519
+ /** 知识库详情 */
520
+ faq?: Lark.FaqCreateInfo;
521
+ }
522
+ interface CreateResponse {
523
+ /** faq detail */
524
+ faq?: Lark.Faq;
525
+ }
526
+ interface PatchRequest {
527
+ /** 修改的知识库内容 */
528
+ faq?: Lark.FaqUpdateInfo;
529
+ }
530
+ interface GetResponse {
531
+ /** faq detail */
532
+ faq?: Lark.Faq;
533
+ }
534
+ interface ListQuery extends Pagination {
535
+ /** 知识库分类ID */
536
+ category_id?: string;
537
+ /** 搜索条件: 知识库状态 1:在线 0:删除,可恢复 2:删除,不可恢复 */
538
+ status?: string;
539
+ /** 搜索条件: 关键词,匹配问题标题,问题关键字,用户姓名 */
540
+ search?: string;
541
+ }
542
+ interface ListResponse {
543
+ /** if there's next page */
544
+ has_more?: boolean;
545
+ /** the next page token */
546
+ page_token?: string;
547
+ /** the page size */
548
+ page_size?: number;
549
+ /** the total count */
550
+ total?: number;
551
+ items?: Lark.Faq[];
552
+ }
553
+ interface SearchQuery extends Pagination {
554
+ /** 搜索query,query内容如果不是英文,包含中文空格等有两种编码策略:1. url编码 2. base64编码,同时加上base64=true参数 */
555
+ query: string;
556
+ /** 是否转换为base64,输入true表示是,不填写表示否,中文需要转换为base64 */
557
+ base64?: string;
558
+ }
559
+ }
560
+ namespace Category {
561
+ interface Methods {
562
+ /**
563
+ * 创建知识库分类
564
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/category/create
565
+ */
566
+ create(body: CreateRequest): Promise<CreateResponse>;
567
+ /**
568
+ * 获取知识库分类
569
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/category/get
570
+ */
571
+ get(id: string): Promise<GetResponse>;
572
+ /**
573
+ * 更新知识库分类详情
574
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/category/patch
575
+ */
576
+ patch(id: string, body: PatchRequest): Promise<void>;
577
+ /**
578
+ * 删除知识库分类详情
579
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/category/delete
580
+ */
581
+ delete(id: string): Promise<void>;
582
+ /**
583
+ * 获取全部知识库分类
584
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/category/list-categories
585
+ */
586
+ list(query?: ListQuery): Promise<ListResponse>;
587
+ }
588
+ interface CreateRequest {
589
+ /** category name */
590
+ name: string;
591
+ /** parent category id, if any */
592
+ parent_id: string;
593
+ /** category language */
594
+ language?: string;
595
+ }
596
+ interface CreateResponse {
597
+ /** category */
598
+ category?: Lark.Category;
599
+ }
600
+ interface GetResponse {
601
+ /** category id */
602
+ category_id: string;
603
+ /** category id, for backward compatibility */
604
+ id: string;
605
+ /** category name */
606
+ name: string;
607
+ /** helpdesk id */
608
+ helpdesk_id: string;
609
+ /** category language */
610
+ language?: string;
611
+ }
612
+ interface PatchRequest {
613
+ /** category name */
614
+ name?: string;
615
+ /** parent category id, if any */
616
+ parent_id?: string;
617
+ }
618
+ interface ListQuery {
619
+ /** 知识库分类语言 */
620
+ lang?: string;
621
+ /** 排序键。1: 根据知识库分类更新时间排序 */
622
+ order_by?: number;
623
+ /** 顺序。true: 正序;false:反序 */
624
+ asc?: boolean;
625
+ }
626
+ interface ListResponse {
627
+ /** list of categories */
628
+ categories?: Lark.Category[];
629
+ }
630
+ }
631
+ namespace Notification {
632
+ interface Methods {
633
+ /**
634
+ * 创建推送
635
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/notification/create
636
+ */
637
+ create(body: CreateRequest, query?: CreateQuery): Promise<CreateResponse>;
638
+ /**
639
+ * 更新推送
640
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/notification/patch
641
+ */
642
+ patch(notification_id: string, body: PatchRequest, query?: PatchQuery): Promise<void>;
643
+ /**
644
+ * 查询推送
645
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/notification/get
646
+ */
647
+ get(notification_id: string, query?: GetQuery): Promise<GetResponse>;
648
+ /**
649
+ * 预览推送
650
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/notification/preview
651
+ */
652
+ preview(notification_id: string): Promise<void>;
653
+ /**
654
+ * 提交审核
655
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/notification/submit_approve
656
+ */
657
+ submitApprove(notification_id: string, body: SubmitApproveRequest): Promise<SubmitApproveResponse>;
658
+ /**
659
+ * 取消审核
660
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/notification/cancel_approve
661
+ */
662
+ cancelApprove(notification_id: string): Promise<void>;
663
+ /**
664
+ * 执行推送
665
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/notification/execute_send
666
+ */
667
+ executeSend(notification_id: string, body: ExecuteSendRequest): Promise<void>;
668
+ /**
669
+ * 取消推送
670
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/notification/cancel_send
671
+ */
672
+ cancelSend(notification_id: string, body: CancelSendRequest): Promise<void>;
673
+ }
674
+ interface CreateRequest {
675
+ /** 唯一ID */
676
+ id?: string;
677
+ /** 任务名称 */
678
+ job_name?: string;
679
+ /** 0(草稿)、1(等待审批)、 2(审批未通过)、3(正在发送中)、4(发送完成)、5(等待设置发送时间)、6(取消发送)、7(新人入职执行发送)、8(等待倒计时发送) */
680
+ status?: number;
681
+ /** 创建人 */
682
+ create_user?: Lark.NotificationUser;
683
+ /** 创建时间(毫秒时间戳) */
684
+ created_at?: string;
685
+ /** 更新用户 */
686
+ update_user?: Lark.NotificationUser;
687
+ /** 更新时间(毫秒时间戳) */
688
+ updated_at?: string;
689
+ /** 目标推送用户 */
690
+ target_user_count?: number;
691
+ /** 已推送用户总数 */
692
+ sent_user_count?: number;
693
+ /** 已读用户总数 */
694
+ read_user_count?: number;
695
+ /** 推送任务触发时间(毫秒时间戳) */
696
+ send_at?: string;
697
+ /** 推送内容,详见:https://open.feishu.cn/tool/cardbuilder?from=howtoguide */
698
+ push_content?: string;
699
+ /** 0(定时推送:push_scope不能等于3) 1(新人入职推送:push_scope必须等于1或者3;new_staff_scope_type不能为空) */
700
+ push_type?: number;
701
+ /** 推送范围(服务台私信) 0:组织内全部成员(user_list和department_list必须为空) 1:不推送任何成员(user_list和department_list必须为空,chat_list不可为空) 2:推送到部分成员(user_list或department_list不能为空) 3:入职新人 以上四种状态,chat_list都相对独立,只有在推送范围为1时,必须需要设置chat_list */
702
+ push_scope_type?: number;
703
+ /** 新人入职范围类型(push_type为1时生效) 0:组织内所有新人 1:组织内特定的部门(new_staff_scope_department_list 字段不能为空) */
704
+ new_staff_scope_type?: number;
705
+ /** 新人入职生效部门列表 */
706
+ new_staff_scope_department_list?: Lark.NotificationDepartment[];
707
+ /** push推送到成员列表 */
708
+ user_list?: Lark.NotificationUser[];
709
+ /** push推送到的部门信息列表 */
710
+ department_list?: Lark.NotificationDepartment[];
711
+ /** push推送到的会话列表(群) */
712
+ chat_list?: Lark.NotificationChat[];
713
+ /** 预留扩展字段 */
714
+ ext?: string;
715
+ }
716
+ interface CreateQuery {
717
+ /** 此次调用中使用的用户ID的类型 */
718
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
719
+ }
720
+ interface CreateResponse {
721
+ /** 创建成功后的唯一id */
722
+ notification_id?: string;
723
+ /** 当前状态 */
724
+ status?: number;
725
+ }
726
+ interface PatchRequest {
727
+ /** 唯一ID */
728
+ id?: string;
729
+ /** 任务名称 */
730
+ job_name?: string;
731
+ /** 0(草稿)、1(等待审批)、 2(审批未通过)、3(正在发送中)、4(发送完成)、5(等待设置发送时间)、6(取消发送)、7(新人入职执行发送)、8(等待倒计时发送) */
732
+ status?: number;
733
+ /** 创建人 */
734
+ create_user?: Lark.NotificationUser;
735
+ /** 创建时间(毫秒时间戳) */
736
+ created_at?: string;
737
+ /** 更新用户 */
738
+ update_user?: Lark.NotificationUser;
739
+ /** 更新时间(毫秒时间戳) */
740
+ updated_at?: string;
741
+ /** 目标推送用户 */
742
+ target_user_count?: number;
743
+ /** 已推送用户总数 */
744
+ sent_user_count?: number;
745
+ /** 已读用户总数 */
746
+ read_user_count?: number;
747
+ /** 推送任务触发时间(毫秒时间戳) */
748
+ send_at?: string;
749
+ /** 推送内容,详见:https://open.feishu.cn/tool/cardbuilder?from=howtoguide */
750
+ push_content?: string;
751
+ /** 0(定时推送:push_scope不能等于3) 1(新人入职推送:push_scope必须等于1或者3;new_staff_scope_type不能为空) */
752
+ push_type?: number;
753
+ /** 推送范围(服务台私信) 0:组织内全部成员(user_list和department_list必须为空) 1:不推送任何成员(user_list和department_list必须为空,chat_list不可为空) 2:推送到部分成员(user_list或department_list不能为空) 3:入职新人 以上四种状态,chat_list都相对独立,只有在推送范围为1时,必须需要设置chat_list */
754
+ push_scope_type?: number;
755
+ /** 新人入职范围类型(push_type为1时生效) 0:组织内所有新人 1:组织内特定的部门(new_staff_scope_department_list 字段不能为空) */
756
+ new_staff_scope_type?: number;
757
+ /** 新人入职生效部门列表 */
758
+ new_staff_scope_department_list?: Lark.NotificationDepartment[];
759
+ /** push推送到成员列表 */
760
+ user_list?: Lark.NotificationUser[];
761
+ /** push推送到的部门信息列表 */
762
+ department_list?: Lark.NotificationDepartment[];
763
+ /** push推送到的会话列表(群) */
764
+ chat_list?: Lark.NotificationChat[];
765
+ /** 预留扩展字段 */
766
+ ext?: string;
767
+ }
768
+ interface PatchQuery {
769
+ /** 此次调用中使用的用户ID的类型 */
770
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
771
+ }
772
+ interface GetQuery {
773
+ /** 此次调用中使用的用户ID的类型 */
774
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
775
+ }
776
+ interface GetResponse {
777
+ /** push任务详情 */
778
+ notification?: Lark.Notification;
779
+ /** 审批链接 */
780
+ approval_app_link?: string;
781
+ }
782
+ interface SubmitApproveRequest {
783
+ /** 提交审批理由 */
784
+ reason: string;
785
+ }
786
+ interface SubmitApproveResponse {
787
+ /** 是否有权限创建或者管理审批流程 (有两种情况会导致没有权限: 1:用户没有安装服务台小程序,需要在https://app.feishu.cn/app/cli_9f9f8825d53b900d或者https://ftest.feishu.cn/admin/appCenter/manage/cli_9f9f8825d53b900d?lang=zh-CN 安装小程序 2:用户安装的服务台小程序版本过低) */
788
+ has_access?: boolean;
789
+ }
790
+ interface ExecuteSendRequest {
791
+ /** 发送时间戳(毫秒) */
792
+ send_at: string;
793
+ }
794
+ interface CancelSendRequest {
795
+ /** 是否召回已发送的消息,新人入职消息同样适用 */
796
+ is_recall: boolean;
797
+ }
798
+ }
799
+ namespace Event {
800
+ interface Methods {
801
+ /**
802
+ * 订阅服务台事件
803
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/event/subscribe
804
+ */
805
+ subscribe(body: SubscribeRequest): Promise<void>;
806
+ /**
807
+ * 取消订阅服务台事件
808
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/event/unsubscribe
809
+ */
810
+ unsubscribe(body: UnsubscribeRequest): Promise<void>;
811
+ }
812
+ interface SubscribeRequest {
813
+ /** 可订阅的事件列表 */
814
+ events: Lark.Event[];
815
+ }
816
+ interface UnsubscribeRequest {
817
+ /** event list to unsubscribe */
818
+ events: Lark.Event[];
819
+ }
820
+ }
746
821
  }