@satorijs/adapter-lark 3.10.6 → 3.11.1

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