@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,1493 +1,1583 @@
1
- import { CustomAttr, Department, DepartmentI18nName, DepartmentLeader, EmployeeTypeEnum, FunctionalRoleMember, FunctionalRoleMemberResult, Group, I18nContent, JobFamily, JobLevel, JobTitle, Memberlist, MemberResult, ResourceAcceptor, Unit, UnitDepartment, User, UserContactInfo, UserCustomAttr, UserDepartmentInfo, UserOrder, WorkCity } 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/reference/contact-v3/scope/list
9
- */
10
- listContactScope(query?: ListContactScopeQuery): Promise<ListContactScopeResponse>
11
- /**
12
- * 创建用户
13
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/create
14
- */
15
- createContactUser(body: CreateContactUserRequest, query?: CreateContactUserQuery): Promise<CreateContactUserResponse>
16
- /**
17
- * 修改用户部分信息
18
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/patch
19
- */
20
- patchContactUser(user_id: string, body: PatchContactUserRequest, query?: PatchContactUserQuery): Promise<PatchContactUserResponse>
21
- /**
22
- * 更新用户 ID
23
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/update_user_id
24
- */
25
- updateUserIdContactUser(user_id: string, body: UpdateUserIdContactUserRequest, query?: UpdateUserIdContactUserQuery): Promise<void>
26
- /**
27
- * 获取单个用户信息
28
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/get
29
- */
30
- getContactUser(user_id: string, query?: GetContactUserQuery): Promise<GetContactUserResponse>
31
- /**
32
- * 批量获取用户信息
33
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/batch
34
- */
35
- batchContactUser(query?: BatchContactUserQuery): Promise<BatchContactUserResponse>
36
- /**
37
- * 获取部门直属用户列表
38
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/find_by_department
39
- */
40
- findByDepartmentContactUser(query?: FindByDepartmentContactUserQuery): Paginated<User>
41
- /**
42
- * 通过手机号或邮箱获取用户 ID
43
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/batch_get_id
44
- */
45
- batchGetIdContactUser(body: BatchGetIdContactUserRequest, query?: BatchGetIdContactUserQuery): Promise<BatchGetIdContactUserResponse>
46
- /**
47
- * 删除用户
48
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/delete
49
- */
50
- deleteContactUser(user_id: string, body: DeleteContactUserRequest, query?: DeleteContactUserQuery): Promise<void>
51
- /**
52
- * 恢复已删除用户
53
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/resurrect
54
- */
55
- resurrectContactUser(user_id: string, body: ResurrectContactUserRequest, query?: ResurrectContactUserQuery): Promise<void>
56
- /**
57
- * 创建用户组
58
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group/create
59
- */
60
- createContactGroup(body: CreateContactGroupRequest, query?: CreateContactGroupQuery): Promise<CreateContactGroupResponse>
61
- /**
62
- * 更新用户组
63
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group/patch
64
- */
65
- patchContactGroup(group_id: string, body: PatchContactGroupRequest, query?: PatchContactGroupQuery): Promise<void>
66
- /**
67
- * 查询指定用户组
68
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group/get
69
- */
70
- getContactGroup(group_id: string, query?: GetContactGroupQuery): Promise<GetContactGroupResponse>
71
- /**
72
- * 查询用户组列表
73
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group/simplelist
74
- */
75
- simplelistContactGroup(query?: SimplelistContactGroupQuery): Paginated<Group, 'grouplist'>
76
- /**
77
- * 查询用户所属用户组
78
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group/member_belong
79
- */
80
- memberBelongContactGroup(query?: MemberBelongContactGroupQuery): Paginated<string, 'group_list'>
81
- /**
82
- * 删除用户组
83
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group/delete
84
- */
85
- deleteContactGroup(group_id: string): Promise<void>
86
- /**
87
- * 获取企业自定义用户字段
88
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/custom_attr/list
89
- */
90
- listContactCustomAttr(query?: Pagination): Paginated<CustomAttr>
91
- /**
92
- * 新增人员类型
93
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/employee_type_enum/create
94
- */
95
- createContactEmployeeTypeEnum(body: CreateContactEmployeeTypeEnumRequest): Promise<CreateContactEmployeeTypeEnumResponse>
96
- /**
97
- * 更新人员类型
98
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/employee_type_enum/update
99
- */
100
- updateContactEmployeeTypeEnum(enum_id: string, body: UpdateContactEmployeeTypeEnumRequest): Promise<UpdateContactEmployeeTypeEnumResponse>
101
- /**
102
- * 查询人员类型
103
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/employee_type_enum/list
104
- */
105
- listContactEmployeeTypeEnum(query?: Pagination): Paginated<EmployeeTypeEnum>
106
- /**
107
- * 删除人员类型
108
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/employee_type_enum/delete
109
- */
110
- deleteContactEmployeeTypeEnum(enum_id: string): Promise<void>
111
- /**
112
- * 创建部门
113
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/create
114
- */
115
- createContactDepartment(body: CreateContactDepartmentRequest, query?: CreateContactDepartmentQuery): Promise<CreateContactDepartmentResponse>
116
- /**
117
- * 修改部门部分信息
118
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/patch
119
- */
120
- patchContactDepartment(department_id: string, body: PatchContactDepartmentRequest, query?: PatchContactDepartmentQuery): Promise<PatchContactDepartmentResponse>
121
- /**
122
- * 更新部门所有信息
123
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/update
124
- */
125
- updateContactDepartment(department_id: string, body: UpdateContactDepartmentRequest, query?: UpdateContactDepartmentQuery): Promise<UpdateContactDepartmentResponse>
126
- /**
127
- * 更新部门 ID
128
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/update_department_id
129
- */
130
- updateDepartmentIdContactDepartment(department_id: string, body: UpdateDepartmentIdContactDepartmentRequest, query?: UpdateDepartmentIdContactDepartmentQuery): Promise<void>
131
- /**
132
- * 部门群转为普通群
133
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/unbind_department_chat
134
- */
135
- unbindDepartmentChatContactDepartment(body: UnbindDepartmentChatContactDepartmentRequest, query?: UnbindDepartmentChatContactDepartmentQuery): Promise<void>
136
- /**
137
- * 获取单个部门信息
138
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/get
139
- */
140
- getContactDepartment(department_id: string, query?: GetContactDepartmentQuery): Promise<GetContactDepartmentResponse>
141
- /**
142
- * 批量获取部门信息
143
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/batch
144
- */
145
- batchContactDepartment(query?: BatchContactDepartmentQuery): Promise<BatchContactDepartmentResponse>
146
- /**
147
- * 获取子部门列表
148
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/children
149
- */
150
- childrenContactDepartment(department_id: string, query?: ChildrenContactDepartmentQuery): Paginated<Department>
151
- /**
152
- * 获取父部门信息
153
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/parent
154
- */
155
- parentContactDepartment(query?: ParentContactDepartmentQuery): Paginated<Department>
156
- /**
157
- * 搜索部门
158
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/search
159
- */
160
- searchContactDepartment(body: SearchContactDepartmentRequest, query?: SearchContactDepartmentQuery): Paginated<Department>
161
- /**
162
- * 删除部门
163
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/delete
164
- */
165
- deleteContactDepartment(department_id: string, query?: DeleteContactDepartmentQuery): Promise<void>
166
- /**
167
- * 创建单位
168
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/unit/create
169
- */
170
- createContactUnit(body: CreateContactUnitRequest): Promise<CreateContactUnitResponse>
171
- /**
172
- * 修改单位信息
173
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/unit/patch
174
- */
175
- patchContactUnit(unit_id: string, body: PatchContactUnitRequest): Promise<void>
176
- /**
177
- * 建立部门与单位的绑定关系
178
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/unit/bind_department
179
- */
180
- bindDepartmentContactUnit(body: BindDepartmentContactUnitRequest): Promise<void>
181
- /**
182
- * 解除部门与单位的绑定关系
183
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/unit/unbind_department
184
- */
185
- unbindDepartmentContactUnit(body: UnbindDepartmentContactUnitRequest): Promise<void>
186
- /**
187
- * 获取单位绑定的部门列表
188
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/unit/list_department
189
- */
190
- listDepartmentContactUnit(query?: ListDepartmentContactUnitQuery): Paginated<UnitDepartment, 'departmentlist'>
191
- /**
192
- * 获取单位信息
193
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/unit/get
194
- */
195
- getContactUnit(unit_id: string): Promise<GetContactUnitResponse>
196
- /**
197
- * 获取单位列表
198
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/unit/list
199
- */
200
- listContactUnit(query?: Pagination): Paginated<Unit, 'unitlist'>
201
- /**
202
- * 删除单位
203
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/unit/delete
204
- */
205
- deleteContactUnit(unit_id: string): Promise<void>
206
- /**
207
- * 添加用户组成员
208
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group-member/add
209
- */
210
- addContactGroupMember(group_id: string, body: AddContactGroupMemberRequest): Promise<void>
211
- /**
212
- * 批量添加用户组成员
213
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group-member/batch_add
214
- */
215
- batchAddContactGroupMember(group_id: string, body: BatchAddContactGroupMemberRequest): Promise<BatchAddContactGroupMemberResponse>
216
- /**
217
- * 查询用户组成员列表
218
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group-member/simplelist
219
- */
220
- simplelistContactGroupMember(group_id: string, query?: SimplelistContactGroupMemberQuery): Paginated<Memberlist, 'memberlist'>
221
- /**
222
- * 移除用户组成员
223
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group-member/remove
224
- */
225
- removeContactGroupMember(group_id: string, body: RemoveContactGroupMemberRequest): Promise<void>
226
- /**
227
- * 批量移除用户组成员
228
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group-member/batch_remove
229
- */
230
- batchRemoveContactGroupMember(group_id: string, body: BatchRemoveContactGroupMemberRequest): Promise<void>
231
- /**
232
- * 创建角色
233
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/functional_role/create
234
- */
235
- createContactFunctionalRole(body: CreateContactFunctionalRoleRequest): Promise<CreateContactFunctionalRoleResponse>
236
- /**
237
- * 修改角色名称
238
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/functional_role/update
239
- */
240
- updateContactFunctionalRole(role_id: string, body: UpdateContactFunctionalRoleRequest): Promise<void>
241
- /**
242
- * 删除角色
243
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/functional_role/delete
244
- */
245
- deleteContactFunctionalRole(role_id: string): Promise<void>
246
- /**
247
- * 批量添加角色成员
248
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/functional_role-member/batch_create
249
- */
250
- batchCreateContactFunctionalRoleMember(role_id: string, body: BatchCreateContactFunctionalRoleMemberRequest, query?: BatchCreateContactFunctionalRoleMemberQuery): Promise<BatchCreateContactFunctionalRoleMemberResponse>
251
- /**
252
- * 批量设置角色成员管理范围
253
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/functional_role-member/scopes
254
- */
255
- scopesContactFunctionalRoleMember(role_id: string, body: ScopesContactFunctionalRoleMemberRequest, query?: ScopesContactFunctionalRoleMemberQuery): Promise<ScopesContactFunctionalRoleMemberResponse>
256
- /**
257
- * 查询角色下某个成员的管理范围
258
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/functional_role-member/get
259
- */
260
- getContactFunctionalRoleMember(role_id: string, member_id: string, query?: GetContactFunctionalRoleMemberQuery): Promise<GetContactFunctionalRoleMemberResponse>
261
- /**
262
- * 查询角色下的所有成员信息
263
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/functional_role-member/list
264
- */
265
- listContactFunctionalRoleMember(role_id: string, query?: ListContactFunctionalRoleMemberQuery): Paginated<FunctionalRoleMember, 'members'>
266
- /**
267
- * 删除角色下的成员
268
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/functional_role-member/batch_delete
269
- */
270
- batchDeleteContactFunctionalRoleMember(role_id: string, body: BatchDeleteContactFunctionalRoleMemberRequest, query?: BatchDeleteContactFunctionalRoleMemberQuery): Promise<BatchDeleteContactFunctionalRoleMemberResponse>
271
- /**
272
- * 创建职级
273
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_level/create
274
- */
275
- createContactJobLevel(body: CreateContactJobLevelRequest): Promise<CreateContactJobLevelResponse>
276
- /**
277
- * 更新职级
278
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_level/update
279
- */
280
- updateContactJobLevel(job_level_id: string, body: UpdateContactJobLevelRequest): Promise<UpdateContactJobLevelResponse>
281
- /**
282
- * 获取单个职级信息
283
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_level/get
284
- */
285
- getContactJobLevel(job_level_id: string): Promise<GetContactJobLevelResponse>
286
- /**
287
- * 获取租户职级列表
288
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_level/list
289
- */
290
- listContactJobLevel(query?: ListContactJobLevelQuery): Paginated<JobLevel>
291
- /**
292
- * 删除职级
293
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_level/delete
294
- */
295
- deleteContactJobLevel(job_level_id: string): Promise<void>
296
- /**
297
- * 创建序列
298
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_family/create
299
- */
300
- createContactJobFamily(body: CreateContactJobFamilyRequest): Promise<CreateContactJobFamilyResponse>
301
- /**
302
- * 更新序列
303
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_family/update
304
- */
305
- updateContactJobFamily(job_family_id: string, body: UpdateContactJobFamilyRequest): Promise<UpdateContactJobFamilyResponse>
306
- /**
307
- * 获取单个序列信息
308
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_family/get
309
- */
310
- getContactJobFamily(job_family_id: string): Promise<GetContactJobFamilyResponse>
311
- /**
312
- * 获取租户序列列表
313
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_family/list
314
- */
315
- listContactJobFamily(query?: ListContactJobFamilyQuery): Paginated<JobFamily>
316
- /**
317
- * 删除序列
318
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_family/delete
319
- */
320
- deleteContactJobFamily(job_family_id: string): Promise<void>
321
- /**
322
- * 获取单个职务信息
323
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_title/get
324
- */
325
- getContactJobTitle(job_title_id: string): Promise<GetContactJobTitleResponse>
326
- /**
327
- * 获取租户职务列表
328
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_title/list
329
- */
330
- listContactJobTitle(query?: Pagination): Paginated<JobTitle>
331
- /**
332
- * 获取单个工作城市信息
333
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/work_city/get
334
- */
335
- getContactWorkCity(work_city_id: string): Promise<GetContactWorkCityResponse>
336
- /**
337
- * 获取租户工作城市列表
338
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/work_city/list
339
- */
340
- listContactWorkCity(query?: Pagination): Paginated<WorkCity>
341
- /**
342
- * 获取用户列表
343
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/list
344
- */
345
- listContactUser(query?: ListContactUserQuery): Paginated<User>
346
- /**
347
- * 更新用户所有信息
348
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/update
349
- */
350
- updateContactUser(user_id: string, body: UpdateContactUserRequest, query?: UpdateContactUserQuery): Promise<UpdateContactUserResponse>
351
- /**
352
- * 获取部门信息列表
353
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/list
354
- */
355
- listContactDepartment(query?: ListContactDepartmentQuery): Paginated<Department>
6
+ contact: Contact.Methods
356
7
  }
357
8
  }
358
9
 
359
- export interface ListContactScopeQuery extends Pagination {
360
- /** 返回值的用户ID的类型 */
361
- user_id_type?: 'open_id' | 'union_id' | 'user_id'
362
- /** 返回值的部门ID的类型 */
363
- department_id_type?: 'department_id' | 'open_department_id'
364
- }
365
-
366
- export interface ListContactScopeResponse {
367
- /** 已授权部门列表,授权范围为全员可见时返回的是当前企业的所有一级部门列表 */
368
- department_ids?: string[]
369
- /** 已授权用户列表,应用申请了获取用户user_id 权限时返回;当授权范围为全员可见时返回的是当前企业所有顶级部门用户列表 */
370
- user_ids?: string[]
371
- /** 已授权的用户组,授权范围为全员可见时返回的是当前企业所有用户组 */
372
- group_ids?: string[]
373
- /** 是否还有更多项 */
374
- has_more?: boolean
375
- /** 分页标记,当 has_more 为 true 时,会同时返回新的 page_token */
376
- page_token?: string
377
- }
378
-
379
- export const enum CreateContactUserRequestGender {
380
- /** 保密 */
381
- Unkown = 0,
382
- /** 男 */
383
- Male = 1,
384
- /** 女 */
385
- Female = 2,
386
- /** 其他 */
387
- Others = 3,
388
- }
389
-
390
- export interface CreateContactUserRequest {
391
- /** 租户内用户的唯一标识 */
392
- user_id?: string
393
- /** 用户名 */
394
- name: string
395
- /** 英文名 */
396
- en_name?: string
397
- /** 别名 */
398
- nickname?: string
399
- /** 邮箱 */
400
- email?: string
401
- /** 手机号 */
402
- mobile: string
403
- /** 手机号码可见性,true 为可见,false 为不可见,目前默认为 true。不可见时,组织员工将无法查看该员工的手机号码 */
404
- mobile_visible?: boolean
405
- /** 性别 */
406
- gender?: CreateContactUserRequestGender
407
- /** 头像的文件Key */
408
- avatar_key?: string
409
- /** 用户所在的部门 */
410
- department_ids: string[]
411
- /** 用户的上级领导 */
412
- leader_user_id?: string
413
- /** 城市 */
414
- city?: string
415
- /** 国家 */
416
- country?: string
417
- /** 工位 */
418
- work_station?: string
419
- /** 入职时间 */
420
- join_time?: number
421
- /** 工号 */
422
- employee_no?: string
423
- /** 员工类型 */
424
- employee_type: number
425
- /** 用户排序信息 */
426
- orders?: UserOrder[]
427
- /** 自定义属性 */
428
- custom_attrs?: UserCustomAttr[]
429
- /** 企业邮箱 */
430
- enterprise_email?: string
431
- /** 职务 */
432
- job_title?: string
433
- /** 数据驻留地 */
434
- geo?: string
435
- /** 职级ID */
436
- job_level_id?: string
437
- /** 序列ID */
438
- job_family_id?: string
439
- /** 分配给用户的席位ID列表 */
440
- subscription_ids?: string[]
441
- /** 虚线上级ID */
442
- dotted_line_leader_user_ids?: string[]
443
- }
444
-
445
- export interface CreateContactUserQuery {
446
- /** 此次调用中使用的用户ID的类型 */
447
- user_id_type?: 'user_id' | 'union_id' | 'open_id'
448
- /** 此次调用中使用的部门ID的类型。不同 ID 的说明参见[部门ID说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/field-overview#23857fe0) */
449
- department_id_type?: 'department_id' | 'open_department_id'
450
- /** 用于幂等判断是否为同一请求,避免重复创建。字符串类型,自行生成。 */
451
- client_token?: string
452
- }
453
-
454
- export interface CreateContactUserResponse {
455
- user?: User
456
- }
457
-
458
- export const enum PatchContactUserRequestGender {
459
- /** 保密 */
460
- Unkown = 0,
461
- /** 男 */
462
- Male = 1,
463
- /** 女 */
464
- Female = 2,
465
- /** 其他 */
466
- Others = 3,
467
- }
468
-
469
- export interface PatchContactUserRequest {
470
- /** 用户名称 */
471
- name?: string
472
- /** 英文名 */
473
- en_name?: string
474
- /** 别名 */
475
- nickname?: string
476
- /** 邮箱 */
477
- email?: string
478
- /** 用户手机号 */
479
- mobile?: string
480
- /** 手机号码可见性,true 为可见,false 为不可见,目前默认为 true。不可见时,组织员工将无法查看该员工的手机号码 */
481
- mobile_visible?: boolean
482
- /** 性别 */
483
- gender?: PatchContactUserRequestGender
484
- /** 头像的文件Key */
485
- avatar_key?: string
486
- /** 用户所在部门ID */
487
- department_ids?: string[]
488
- /** 用户直属上级 */
489
- leader_user_id?: string
490
- /** 城市 */
491
- city?: string
492
- /** 国家 */
493
- country?: string
494
- /** 工位 */
495
- work_station?: string
496
- /** 入职时间 */
497
- join_time?: number
498
- /** 工号 */
499
- employee_no?: string
500
- /** 员工类型 */
501
- employee_type?: number
502
- /** 用户排序信息 */
503
- orders?: UserOrder[]
504
- /** 自定义属性 */
505
- custom_attrs?: UserCustomAttr[]
506
- /** 企业邮箱 */
507
- enterprise_email?: string
508
- /** 职务 */
509
- job_title?: string
510
- /** 是否冻结用户 */
511
- is_frozen?: boolean
512
- /** 职级ID */
513
- job_level_id?: string
514
- /** 序列ID */
515
- job_family_id?: string
516
- /** 分配给用户的席位ID列表 */
517
- subscription_ids?: string[]
518
- /** 虚线上级ID */
519
- dotted_line_leader_user_ids?: string[]
520
- }
521
-
522
- export interface PatchContactUserQuery {
523
- /** 此次调用中使用的用户ID的类型 */
524
- user_id_type?: 'user_id' | 'union_id' | 'open_id'
525
- /** 此次调用中使用的部门ID的类型 */
526
- department_id_type?: 'department_id' | 'open_department_id'
527
- }
528
-
529
- export interface PatchContactUserResponse {
530
- user?: User
531
- }
532
-
533
- export interface UpdateUserIdContactUserRequest {
534
- /** 自定义新用户ID */
535
- new_user_id: string
536
- }
537
-
538
- export interface UpdateUserIdContactUserQuery {
539
- /** 此次调用中使用的用户ID的类型 */
540
- user_id_type?: 'user_id' | 'union_id' | 'open_id'
541
- }
542
-
543
- export interface GetContactUserQuery {
544
- /** 此次调用中使用的用户ID的类型 */
545
- user_id_type?: 'user_id' | 'union_id' | 'open_id'
546
- /** 此次调用中使用的部门ID的类型不同 ID 的说明 [部门ID说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/field-overview#23857fe0) */
547
- department_id_type?: 'department_id' | 'open_department_id'
548
- }
549
-
550
- export interface GetContactUserResponse {
551
- user?: User
552
- }
553
-
554
- export interface BatchContactUserQuery {
555
- /** 要查询的用户ID列表 */
556
- user_ids: string[]
557
- /** 指定请求中用户ID类型 */
558
- user_id_type?: 'open_id' | 'union_id' | 'user_id'
559
- /** 指定查询结果中用户关联的部门ID类型 */
560
- department_id_type?: 'open_department_id' | 'department_id'
561
- }
562
-
563
- export interface BatchContactUserResponse {
564
- /** 查询到的用户信息,其中异常的用户ID不返回结果。 */
565
- items?: User[]
566
- }
567
-
568
- export interface FindByDepartmentContactUserQuery extends Pagination {
569
- /** 此次调用中使用的用户ID的类型 */
570
- user_id_type?: 'user_id' | 'union_id' | 'open_id'
571
- /** 此次调用中使用的部门ID的类型部门ID类型的区别参见[部门ID说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/field-overview#23857fe0) */
572
- department_id_type?: 'department_id' | 'open_department_id'
573
- /** 填写该字段表示获取该部门下用户,必填。根部门的部门ID为0。ID值与查询参数中的department_id_type 对应。不同 ID 的说明与department_id的获取方式参见 [部门ID说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/field-overview#23857fe0) */
574
- department_id: string
575
- }
576
-
577
- export interface BatchGetIdContactUserRequest {
578
- /** 要查询的用户邮箱,最多 50 条。注意,emails与mobiles相互独立,每条用户邮箱返回对应的用户ID。本接口返回的用户ID数量为emails数量与mobiles数量的和。 */
579
- emails?: string[]
580
- /** 要查询的用户手机号,最多 50 条。注意1. emails与mobiles相互独立,每条用户手机号返回对应的用户ID。2. 非中国大陆地区的手机号需要添加以 “+” 开头的国家 / 地区代码。 */
581
- mobiles?: string[]
582
- /** 查询结果包含离职员工,可查询离职用户的ID */
583
- include_resigned?: boolean
584
- }
585
-
586
- export interface BatchGetIdContactUserQuery {
587
- /** 返回的用户ID的类型 */
588
- user_id_type?: 'open_id' | 'union_id' | 'user_id'
589
- }
590
-
591
- export interface BatchGetIdContactUserResponse {
592
- /** 手机号或者邮箱对应的用户id信息 */
593
- user_list?: UserContactInfo[]
594
- }
595
-
596
- export interface DeleteContactUserRequest {
597
- /** 部门群接收者。被删除用户为部门群群主时,转让群主给指定接收者,不指定接收者则默认转让给群内第一个入群的人 */
598
- department_chat_acceptor_user_id?: string
599
- /** 外部群接收者。被删除用户为外部群群主时,转让群主给指定接收者,不指定接收者则默认转让给群内与被删除用户在同一组织的第一个入群的人,如果组织内只有该用户在群里,则解散外部群 */
600
- external_chat_acceptor_user_id?: string
601
- /** 文档接收者。用户被删除时,其拥有的文档转让给接收者。不指定接收者则默认转让给直属上级,如果无直属上级则将文档资源保留在该用户名下。 */
602
- docs_acceptor_user_id?: string
603
- /** 日程接收者。用户被删除时,其拥有的日程转让给接收者,不指定接收者则默认转让给直属上级,如果无直属上级则直接删除日程资源。 */
604
- calendar_acceptor_user_id?: string
605
- /** 应用接受者。用户被删除时,其创建的应用转让给接收者,不指定接收者则默认转让给直属上级。如果无直属上级则保留应用在该用户名下,但该用户无法登录开发者后台进行应用管理,管理员可以在管理后台手动转移应用给其他人。 */
606
- application_acceptor_user_id?: string
607
- /** 妙记接收者。用户被删除时,其拥有的妙记资源转让给接收者。如果不指定接收者,则默认转让给直属上级。如果无直属上级则将妙记保留在该用户名下。 */
608
- minutes_acceptor_user_id?: string
609
- /** 飞书问卷接收者。用户被删除时,其拥有的飞书问卷资源转让给接收者,不指定接收者则默认转让给直属上级,如果无直属上级则直接删除飞书问卷资源。 */
610
- survey_acceptor_user_id?: string
611
- /** 用户邮件资源处理方式。用户被删除时,根据传递的操作指令对其拥有的邮件资源做对应处理。未传递指令时默认将邮件资源转让给直属上级,如果无直属上级则保留邮件资源在该用户名下。 */
612
- email_acceptor?: ResourceAcceptor
613
- /** 用户集成平台资源接收者 */
614
- anycross_acceptor_user_id?: string
615
- }
616
-
617
- export interface DeleteContactUserQuery {
618
- /** 此次调用中使用的用户ID的类型 */
619
- user_id_type?: 'user_id' | 'union_id' | 'open_id'
620
- }
621
-
622
- export interface ResurrectContactUserRequest {
623
- /** 指定恢复后用户所在部门 */
624
- departments?: UserDepartmentInfo[]
625
- /** 指定恢复后分配的席位 */
626
- subscription_ids?: string[]
627
- }
628
-
629
- export interface ResurrectContactUserQuery {
630
- /** 用户id类型 */
631
- user_id_type?: 'open_id' | 'union_id' | 'user_id'
632
- /** 部门id类型 */
633
- department_id_type?: 'department_id' | 'open_department_id'
634
- }
635
-
636
- export const enum CreateContactGroupRequestType {
637
- /** 普通用户组 */
638
- Assign = 1,
639
- /** 动态用户组 */
640
- Dynamic = 2,
641
- }
642
-
643
- export interface CreateContactGroupRequest {
644
- /** 用户组的名字,企业内唯一,最大长度:100 字符 */
645
- name: string
646
- /** 用户组描述 */
647
- description?: string
648
- /** 用户组的类型。默认为1表示普通用户组 */
649
- type?: CreateContactGroupRequestType
650
- /** 自定义用户组ID,可在创建时自定义,不自定义则由系统自动生成,已创建用户组不允许修改 group_id 。自定义group_id数据校验规则:最大长度:64 字符校验规则:数字、大小写字母的组合,不能包含空格 */
651
- group_id?: string
652
- }
653
-
654
- export interface CreateContactGroupQuery {
655
- /** 此次调用中使用的用户ID的类型 */
656
- user_id_type?: 'user_id' | 'union_id' | 'open_id'
657
- /** 此次调用中使用的部门ID的类型 */
658
- department_id_type?: 'open_department_id' | 'department_id'
659
- }
660
-
661
- export interface CreateContactGroupResponse {
662
- /** 用户组ID */
663
- group_id: string
664
- }
665
-
666
- export interface PatchContactGroupRequest {
667
- /** 用户组的名字,企业内唯一,最大长度:100 字符 */
668
- name?: string
669
- /** 用户组描述信息最大长度:500 字 */
670
- description?: string
671
- }
672
-
673
- export interface PatchContactGroupQuery {
674
- /** 此次调用中使用的用户ID的类型 */
675
- user_id_type?: 'user_id' | 'union_id' | 'open_id'
676
- /** 此次调用中使用的部门ID的类型 */
677
- department_id_type?: 'department_id' | 'open_department_id'
678
- }
679
-
680
- export interface GetContactGroupQuery {
681
- /** 此次调用中使用的用户ID的类型 */
682
- user_id_type?: 'user_id' | 'union_id' | 'open_id'
683
- /** 此次调用中使用的部门ID的类型 */
684
- department_id_type?: 'open_department_id' | 'department_id'
685
- }
686
-
687
- export interface GetContactGroupResponse {
688
- /** 用户组详情 */
689
- group: Group
690
- }
691
-
692
- export const enum SimplelistContactGroupQueryType {
693
- /** 普通用户组 */
694
- Assign = 1,
695
- /** 动态用户组 */
696
- Dynamic = 2,
697
- }
698
-
699
- export interface SimplelistContactGroupQuery extends Pagination {
700
- /** 用户组类型 */
701
- type?: SimplelistContactGroupQueryType
702
- }
703
-
704
- export const enum MemberBelongContactGroupQueryGroupType {
705
- /** 普通用户组 */
706
- Assign = 1,
707
- /** 动态用户组 */
708
- Dynamic = 2,
709
- }
710
-
711
- export interface MemberBelongContactGroupQuery extends Pagination {
712
- /** 成员ID */
713
- member_id: string
714
- /** 成员ID类型 */
715
- member_id_type?: 'open_id' | 'union_id' | 'user_id'
716
- /** 欲获取的用户组类型 */
717
- group_type?: MemberBelongContactGroupQueryGroupType
718
- }
719
-
720
- export const enum CreateContactEmployeeTypeEnumRequestEnumType {
721
- /** 内置类型 */
722
- Defualt = 1,
723
- /** 自定义 */
724
- Custom = 2,
725
- }
726
-
727
- export const enum CreateContactEmployeeTypeEnumRequestEnumStatus {
728
- /** 激活 */
729
- Active = 1,
730
- /** 未激活 */
731
- Inactive = 2,
732
- }
733
-
734
- export interface CreateContactEmployeeTypeEnumRequest {
735
- /** 枚举内容 */
736
- content: string
737
- /** 类型 */
738
- enum_type: CreateContactEmployeeTypeEnumRequestEnumType
739
- /** 类型 */
740
- enum_status: CreateContactEmployeeTypeEnumRequestEnumStatus
741
- /** i18n定义 */
742
- i18n_content?: I18nContent[]
743
- }
744
-
745
- export interface CreateContactEmployeeTypeEnumResponse {
746
- /** 创建人员类型接口 */
747
- employee_type_enum?: EmployeeTypeEnum
748
- }
749
-
750
- export const enum UpdateContactEmployeeTypeEnumRequestEnumType {
751
- /** 内置类型 */
752
- Defualt = 1,
753
- /** 自定义 */
754
- Custom = 2,
755
- }
756
-
757
- export const enum UpdateContactEmployeeTypeEnumRequestEnumStatus {
758
- /** 激活 */
759
- Active = 1,
760
- /** 未激活 */
761
- Inactive = 2,
762
- }
763
-
764
- export interface UpdateContactEmployeeTypeEnumRequest {
765
- /** 枚举内容 */
766
- content: string
767
- /** 类型 */
768
- enum_type: UpdateContactEmployeeTypeEnumRequestEnumType
769
- /** 类型 */
770
- enum_status: UpdateContactEmployeeTypeEnumRequestEnumStatus
771
- /** i18n定义 */
772
- i18n_content?: I18nContent[]
773
- }
774
-
775
- export interface UpdateContactEmployeeTypeEnumResponse {
776
- employee_type_enum?: EmployeeTypeEnum
777
- }
778
-
779
- export interface CreateContactDepartmentRequest {
780
- /** 部门名称 */
781
- name: string
782
- /** 国际化的部门名称 */
783
- i18n_name?: DepartmentI18nName
784
- /** 父部门的ID */
785
- parent_department_id: string
786
- /** 本部门的自定义部门ID */
787
- department_id?: string
788
- /** 部门主管用户ID */
789
- leader_user_id?: string
790
- /** 部门的排序 */
791
- order?: string
792
- /** 是否创建部门群,默认不创建 */
793
- create_group_chat?: boolean
794
- /** 部门负责人 */
795
- leaders?: DepartmentLeader[]
796
- /** 部门群雇员类型限制 */
797
- group_chat_employee_types?: number[]
798
- /** 部门HRBP */
799
- department_hrbps?: string[]
800
- }
801
-
802
- export interface CreateContactDepartmentQuery {
803
- /** 此次调用中使用的用户ID的类型 */
804
- user_id_type?: 'user_id' | 'union_id' | 'open_id'
805
- /** 此次调用中使用的部门ID的类型不同 ID 的说明参见[部门ID说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/field-overview#23857fe0) */
806
- department_id_type?: 'department_id' | 'open_department_id'
807
- /** 用于幂等判断是否为同一请求,避免重复创建。字符串类型,自行生成。 */
808
- client_token?: string
809
- }
810
-
811
- export interface CreateContactDepartmentResponse {
812
- department?: Department
813
- }
814
-
815
- export interface PatchContactDepartmentRequest {
816
- /** 部门名 */
817
- name?: string
818
- /** 国际化的部门名称 */
819
- i18n_name?: DepartmentI18nName
820
- /** 父部门ID */
821
- parent_department_id?: string
822
- /** leaderID */
823
- leader_user_id?: string
824
- /** 部门的排序 */
825
- order?: string
826
- /** 是否创建部门群,默认不创建 */
827
- create_group_chat?: boolean
828
- /** 部门负责人 */
829
- leaders?: DepartmentLeader[]
830
- /** 部门群雇员类型限制 */
831
- group_chat_employee_types?: number[]
832
- /** 部门HRBP */
833
- department_hrbps?: string[]
834
- }
835
-
836
- export interface PatchContactDepartmentQuery {
837
- /** 此次调用中使用的用户ID的类型 */
838
- user_id_type?: 'user_id' | 'union_id' | 'open_id'
839
- /** 此次调用中使用的部门ID的类型 */
840
- department_id_type?: 'department_id' | 'open_department_id'
841
- }
842
-
843
- export interface PatchContactDepartmentResponse {
844
- department?: Department
845
- }
846
-
847
- export interface UpdateContactDepartmentRequest {
848
- /** 部门名称 */
849
- name: string
850
- /** 国际化的部门名称 */
851
- i18n_name?: DepartmentI18nName
852
- /** 父部门ID */
853
- parent_department_id: string
854
- /** LeaderID */
855
- leader_user_id?: string
856
- /** 部门的排序 */
857
- order?: string
858
- /** 是否创建部门群,默认不创建 */
859
- create_group_chat?: boolean
860
- /** 部门负责人 */
861
- leaders?: DepartmentLeader[]
862
- /** 部门群雇员类型限制 */
863
- group_chat_employee_types?: number[]
864
- }
865
-
866
- export interface UpdateContactDepartmentQuery {
867
- /** 此次调用中使用的用户ID的类型 */
868
- user_id_type?: 'user_id' | 'union_id' | 'open_id'
869
- /** 此次调用中使用的部门ID的类型 */
870
- department_id_type?: 'department_id' | 'open_department_id'
871
- }
872
-
873
- export interface UpdateContactDepartmentResponse {
874
- department?: Department
875
- }
876
-
877
- export interface UpdateDepartmentIdContactDepartmentRequest {
878
- /** 本部门的自定义部门新ID */
879
- new_department_id: string
880
- }
881
-
882
- export interface UpdateDepartmentIdContactDepartmentQuery {
883
- /** 此次调用中使用的部门ID的类型 */
884
- department_id_type?: 'department_id' | 'open_department_id'
885
- }
886
-
887
- export interface UnbindDepartmentChatContactDepartmentRequest {
888
- /** 部门ID */
889
- department_id: string
890
- }
891
-
892
- export interface UnbindDepartmentChatContactDepartmentQuery {
893
- /** 此次调用中使用的部门ID的类型,默认为"open_department_id" */
894
- department_id_type?: 'department_id' | 'open_department_id'
895
- }
896
-
897
- export interface GetContactDepartmentQuery {
898
- /** 此次调用中使用的用户ID的类型 */
899
- user_id_type?: 'user_id' | 'union_id' | 'open_id'
900
- /** 此次调用中使用的部门ID的类型不同 ID 的说明 [部门ID说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/field-overview#23857fe0) */
901
- department_id_type?: 'department_id' | 'open_department_id'
902
- }
903
-
904
- export interface GetContactDepartmentResponse {
905
- department?: Department
906
- }
907
-
908
- export interface BatchContactDepartmentQuery {
909
- /** 查询的部门ID列表,类型需要与department_id_type对应 */
910
- department_ids: string[]
911
- /** 说明请求中department_id_list参数所使用的部门ID类型 */
912
- department_id_type?: 'open_department_id' | 'department_id'
913
- /** 指定调用结果中包含用户(如部门leader)关联的用户ID类型 */
914
- user_id_type?: 'open_id' | 'union_id' | 'user_id'
915
- }
916
-
917
- export interface BatchContactDepartmentResponse {
918
- /** 查询到的部门信息,其中异常的部门ID不返回结果。 */
919
- items?: Department[]
920
- }
921
-
922
- export interface ChildrenContactDepartmentQuery extends Pagination {
923
- /** 此次调用中使用的用户ID的类型 */
924
- user_id_type?: 'user_id' | 'union_id' | 'open_id'
925
- /** 此次调用中使用的部门ID的类型不同 ID 的说明与department_id的获取方式参见 [部门ID说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/field-overview#23857fe0) */
926
- department_id_type?: 'department_id' | 'open_department_id'
927
- /** 是否递归获取子部门 */
928
- fetch_child?: boolean
929
- }
930
-
931
- export interface ParentContactDepartmentQuery extends Pagination {
932
- /** 此次调用中使用的用户ID的类型 */
933
- user_id_type?: 'user_id' | 'union_id' | 'open_id'
934
- /** 此次调用中使用的部门ID的类型 */
935
- department_id_type?: 'department_id' | 'open_department_id'
936
- /** 部门ID */
937
- department_id: string
938
- }
939
-
940
- export interface SearchContactDepartmentRequest {
941
- /** 搜索关键词,匹配字段为部门名称(不支持匹配部门国际化名称) */
942
- query: string
943
- }
944
-
945
- export interface SearchContactDepartmentQuery extends Pagination {
946
- /** 此次调用中使用的用户ID的类型 */
947
- user_id_type?: 'user_id' | 'union_id' | 'open_id'
948
- /** 此次调用中使用的部门ID的类型 */
949
- department_id_type?: 'department_id' | 'open_department_id'
950
- }
951
-
952
- export interface DeleteContactDepartmentQuery {
953
- /** 此次调用中使用的部门ID的类型 */
954
- department_id_type?: 'department_id' | 'open_department_id'
955
- }
956
-
957
- export interface CreateContactUnitRequest {
958
- /** 单位自定义ID。不带默认自动生成。1-64字节范围大小,需为数字字母 */
959
- unit_id?: string
960
- /** 单位的名字,长度范围为1-100个字 */
961
- name: string
962
- /** 单位类型,长度范围为1-100个字,创建后不可修改 */
963
- unit_type: string
964
- }
965
-
966
- export interface CreateContactUnitResponse {
967
- /** 单位的自定义ID */
968
- unit_id: string
969
- }
970
-
971
- export interface PatchContactUnitRequest {
972
- /** 单位的名字 */
973
- name?: string
974
- }
975
-
976
- export interface BindDepartmentContactUnitRequest {
977
- /** 单位ID */
978
- unit_id: string
979
- /** 单位关联的部门ID */
980
- department_id: string
981
- /** 此次调用中使用的部门ID的类型 */
982
- department_id_type?: 'department_id' | 'open_department_id'
983
- }
984
-
985
- export interface UnbindDepartmentContactUnitRequest {
986
- /** 单位ID */
987
- unit_id: string
988
- /** 预解除关联的部门ID */
989
- department_id: string
990
- /** 此次调用中使用的部门ID的类型 */
991
- department_id_type?: 'department_id' | 'open_department_id'
992
- }
993
-
994
- export interface ListDepartmentContactUnitQuery extends Pagination {
995
- /** 单位ID */
996
- unit_id: string
997
- /** 此次调用中预获取的部门ID的类型 */
998
- department_id_type?: 'department_id' | 'open_department_id'
999
- }
1000
-
1001
- export interface GetContactUnitResponse {
1002
- /** 单位信息 */
1003
- unit: Unit
1004
- }
1005
-
1006
- export interface AddContactGroupMemberRequest {
1007
- /** 用户组成员的类型,取值为 user */
1008
- member_type: 'user'
1009
- /** 当member_type =user时候,member_id_type表示user_id_type,枚举值为open_id, union_id, user_id */
1010
- member_id_type: 'open_id' | 'union_id' | 'user_id'
1011
- /** 添加的成员ID */
1012
- member_id: string
1013
- }
1014
-
1015
- export interface BatchAddContactGroupMemberRequest {
1016
- /** 待添加成员 */
1017
- members?: Memberlist[]
1018
- }
1019
-
1020
- export interface BatchAddContactGroupMemberResponse {
1021
- /** 成员添加操作结果 */
1022
- results?: MemberResult[]
1023
- }
1024
-
1025
- export interface SimplelistContactGroupMemberQuery extends Pagination {
1026
- /** 欲获取成员ID类型。当member_type=user时候,member_id_type表示user_id_type,枚举值open_id, union_id和user_id。当member_type=department时候,member_id_type表示department_id_type,枚举值open_id和department_id。 */
1027
- member_id_type?: 'open_id' | 'union_id' | 'user_id' | 'department_id'
1028
- /** 欲获取的用户组成员类型。 */
1029
- member_type?: 'user' | 'department'
1030
- }
1031
-
1032
- export interface RemoveContactGroupMemberRequest {
1033
- /** 用户组成员的类型,取值为 user */
1034
- member_type: 'user'
1035
- /** 操作移除的用户组成员ID */
1036
- member_id: string
1037
- /** 当member_type =user时候,member_id_type表示user_id_type,枚举值为open_id, union_id, user_id */
1038
- member_id_type: 'open_id' | 'union_id' | 'user_id'
1039
- }
1040
-
1041
- export interface BatchRemoveContactGroupMemberRequest {
1042
- /** 待移除成员 */
1043
- members: Memberlist[]
1044
- }
1045
-
1046
- export interface CreateContactFunctionalRoleRequest {
1047
- /** 角色名称,在单租户下唯一 */
1048
- role_name: string
1049
- }
1050
-
1051
- export interface CreateContactFunctionalRoleResponse {
1052
- /** 角色ID,在单租户下唯一 */
1053
- role_id: string
1054
- }
1055
-
1056
- export interface UpdateContactFunctionalRoleRequest {
1057
- /** 修改的角色名称,在单租户下唯一 */
1058
- role_name: string
1059
- }
1060
-
1061
- export interface BatchCreateContactFunctionalRoleMemberRequest {
1062
- /** 角色添加的角色成员列表(一批用户的UserID列表) */
1063
- members: string[]
1064
- }
1065
-
1066
- export interface BatchCreateContactFunctionalRoleMemberQuery {
1067
- /** 成员ID类型 */
1068
- user_id_type?: 'open_id' | 'union_id' | 'user_id'
1069
- }
1070
-
1071
- export interface BatchCreateContactFunctionalRoleMemberResponse {
1072
- /** 批量新增角色成员结果集 */
1073
- results?: FunctionalRoleMemberResult[]
1074
- }
1075
-
1076
- export interface ScopesContactFunctionalRoleMemberRequest {
1077
- /** 角色修改的角色成员列表(一批用户的UserID列表) */
1078
- members: string[]
1079
- /** 角色内用户的管理范围 */
1080
- departments: string[]
1081
- }
1082
-
1083
- export interface ScopesContactFunctionalRoleMemberQuery {
1084
- /** 用户 ID 类型 */
1085
- user_id_type?: 'open_id' | 'union_id' | 'user_id'
1086
- /** 此次调用中使用的部门ID的类型 */
1087
- department_id_type?: 'department_id' | 'open_department_id'
1088
- }
1089
-
1090
- export interface ScopesContactFunctionalRoleMemberResponse {
1091
- /** 批量更新角色成员管理范围结果集 */
1092
- results?: FunctionalRoleMemberResult[]
1093
- }
1094
-
1095
- export interface GetContactFunctionalRoleMemberQuery {
1096
- /** 用户 ID 类型 */
1097
- user_id_type?: 'open_id' | 'union_id' | 'user_id'
1098
- /** 此次调用中使用的部门ID的类型 */
1099
- department_id_type?: 'department_id' | 'open_department_id'
1100
- }
1101
-
1102
- export interface GetContactFunctionalRoleMemberResponse {
1103
- /** 成员的管理范围 */
1104
- member?: FunctionalRoleMember
1105
- }
1106
-
1107
- export interface ListContactFunctionalRoleMemberQuery extends Pagination {
1108
- /** 用户 ID 类型 */
1109
- user_id_type?: 'open_id' | 'union_id' | 'user_id'
1110
- /** 此次调用中使用的部门ID的类型 */
1111
- department_id_type?: 'department_id' | 'open_department_id'
1112
- }
1113
-
1114
- export interface BatchDeleteContactFunctionalRoleMemberRequest {
1115
- /** 角色删除的角色成员列表(一批用户的UserID列表) */
1116
- members?: string[]
1117
- }
1118
-
1119
- export interface BatchDeleteContactFunctionalRoleMemberQuery {
1120
- /** 成员ID类型 */
1121
- user_id_type?: 'open_id' | 'union_id' | 'user_id'
1122
- }
1123
-
1124
- export interface BatchDeleteContactFunctionalRoleMemberResponse {
1125
- /** 批量新增角色成员结果集 */
1126
- result?: FunctionalRoleMemberResult[]
1127
- }
1128
-
1129
- export interface CreateContactJobLevelRequest {
1130
- /** 职级名称 */
1131
- name: string
1132
- /** 职级描述 */
1133
- description?: string
1134
- /** 职级的排序,可填入自然数100-100000的数值,系统按照数值大小从小到大排序。不填写该字段时,默认新增排序在当前职级列表中最后位(最大值) */
1135
- order?: number
1136
- /** 是否启用 */
1137
- status: boolean
1138
- /** 多语言名称 */
1139
- i18n_name?: I18nContent[]
1140
- /** 多语言描述 */
1141
- i18n_description?: I18nContent[]
1142
- }
1143
-
1144
- export interface CreateContactJobLevelResponse {
1145
- /** 职级信息 */
1146
- job_level?: JobLevel
1147
- }
1148
-
1149
- export interface UpdateContactJobLevelRequest {
1150
- /** 职级名称 */
1151
- name?: string
1152
- /** 职级描述 */
1153
- description?: string
1154
- /** 职级的排序,可填入自然数100-100000的数值,系统按照数值大小从小到大排序。不填写该字段时,默认新增排序在当前职级列表中最后位(最大值) */
1155
- order?: number
1156
- /** 是否启用 */
1157
- status?: boolean
1158
- /** 多语言名称 */
1159
- i18n_name?: I18nContent[]
1160
- /** 多语言描述 */
1161
- i18n_description?: I18nContent[]
1162
- }
1163
-
1164
- export interface UpdateContactJobLevelResponse {
1165
- /** 职级信息 */
1166
- job_level?: JobLevel
1167
- }
1168
-
1169
- export interface GetContactJobLevelResponse {
1170
- /** 职级信息 */
1171
- job_level?: JobLevel
1172
- }
1173
-
1174
- export interface ListContactJobLevelQuery extends Pagination {
1175
- /** 传入该字段时,可查询指定职级名称对应的职级信息。 */
1176
- name?: string
1177
- }
1178
-
1179
- export interface CreateContactJobFamilyRequest {
1180
- /** 序列名称。1-100字符,支持中、英文及符号 */
1181
- name: string
1182
- /** 序列描述,描述序列详情信息 */
1183
- description?: string
1184
- /** 上级序列ID。需是该租户的序列ID列表中的值,对应唯一的序列名称。 */
1185
- parent_job_family_id?: string
1186
- /** 是否启用 */
1187
- status: boolean
1188
- /** 多语言序列名称 */
1189
- i18n_name?: I18nContent[]
1190
- /** 多语言描述 */
1191
- i18n_description?: I18nContent[]
1192
- }
1193
-
1194
- export interface CreateContactJobFamilyResponse {
1195
- /** 序列信息 */
1196
- job_family?: JobFamily
1197
- }
10
+ export namespace Contact {
11
+ export interface Methods {
12
+ scope: Scope.Methods
13
+ user: User.Methods
14
+ group: Group.Methods
15
+ customAttr: CustomAttr.Methods
16
+ employeeTypeEnum: EmployeeTypeEnum.Methods
17
+ department: Department.Methods
18
+ unit: Unit.Methods
19
+ functionalRole: FunctionalRole.Methods
20
+ jobLevel: JobLevel.Methods
21
+ jobFamily: JobFamily.Methods
22
+ jobTitle: JobTitle.Methods
23
+ workCity: WorkCity.Methods
24
+ }
1198
25
 
1199
- export interface UpdateContactJobFamilyRequest {
1200
- /** 序列名称。1-100字符,支持中、英文及符号 */
1201
- name?: string
1202
- /** 序列描述,描述序列详情信息 */
1203
- description?: string
1204
- /** 上级序列ID。需是该租户的序列ID列表中的值,对应唯一的序列名称。 */
1205
- parent_job_family_id?: string
1206
- /** 是否启用 */
1207
- status?: boolean
1208
- /** 多语言序列名称 */
1209
- i18n_name?: I18nContent[]
1210
- /** 多语言描述 */
1211
- i18n_description?: I18nContent[]
1212
- }
26
+ export namespace Scope {
27
+ export interface Methods {
28
+ /**
29
+ * 获取通讯录授权范围
30
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/scope/list
31
+ */
32
+ list(query?: ListQuery): Promise<ListResponse>
33
+ }
34
+
35
+ export interface ListQuery extends Pagination {
36
+ /** 返回值的用户ID的类型 */
37
+ user_id_type?: 'open_id' | 'union_id' | 'user_id'
38
+ /** 返回值的部门ID的类型 */
39
+ department_id_type?: 'department_id' | 'open_department_id'
40
+ }
41
+
42
+ export interface ListResponse {
43
+ /** 已授权部门列表,授权范围为全员可见时返回的是当前企业的所有一级部门列表 */
44
+ department_ids?: string[]
45
+ /** 已授权用户列表,应用申请了获取用户user_id 权限时返回;当授权范围为全员可见时返回的是当前企业所有顶级部门用户列表 */
46
+ user_ids?: string[]
47
+ /** 已授权的用户组,授权范围为全员可见时返回的是当前企业所有用户组 */
48
+ group_ids?: string[]
49
+ /** 是否还有更多项 */
50
+ has_more?: boolean
51
+ /** 分页标记,当 has_more 为 true 时,会同时返回新的 page_token */
52
+ page_token?: string
53
+ }
54
+ }
1213
55
 
1214
- export interface UpdateContactJobFamilyResponse {
1215
- /** 更新后的序列信息 */
1216
- job_family?: JobFamily
1217
- }
56
+ export namespace User {
57
+ export interface Methods {
58
+ /**
59
+ * 创建用户
60
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/create
61
+ */
62
+ create(body: CreateRequest, query?: CreateQuery): Promise<CreateResponse>
63
+ /**
64
+ * 修改用户部分信息
65
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/patch
66
+ */
67
+ patch(user_id: string, body: PatchRequest, query?: PatchQuery): Promise<PatchResponse>
68
+ /**
69
+ * 更新用户 ID
70
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/update_user_id
71
+ */
72
+ updateUserId(user_id: string, body: UpdateUserIdRequest, query?: UpdateUserIdQuery): Promise<void>
73
+ /**
74
+ * 获取单个用户信息
75
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/get
76
+ */
77
+ get(user_id: string, query?: GetQuery): Promise<GetResponse>
78
+ /**
79
+ * 批量获取用户信息
80
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/batch
81
+ */
82
+ batch(query?: BatchQuery): Promise<BatchResponse>
83
+ /**
84
+ * 获取部门直属用户列表
85
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/find_by_department
86
+ */
87
+ findByDepartment(query?: FindByDepartmentQuery): Paginated<Lark.User>
88
+ /**
89
+ * 通过手机号或邮箱获取用户 ID
90
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/batch_get_id
91
+ */
92
+ batchGetId(body: BatchGetIdRequest, query?: BatchGetIdQuery): Promise<BatchGetIdResponse>
93
+ /**
94
+ * 删除用户
95
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/delete
96
+ */
97
+ delete(user_id: string, body: DeleteRequest, query?: DeleteQuery): Promise<void>
98
+ /**
99
+ * 恢复已删除用户
100
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/resurrect
101
+ */
102
+ resurrect(user_id: string, body: ResurrectRequest, query?: ResurrectQuery): Promise<void>
103
+ /**
104
+ * 获取用户列表
105
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/list
106
+ */
107
+ list(query?: ListQuery): Paginated<Lark.User>
108
+ /**
109
+ * 更新用户所有信息
110
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/update
111
+ */
112
+ update(user_id: string, body: UpdateRequest, query?: UpdateQuery): Promise<UpdateResponse>
113
+ }
114
+
115
+ export const enum CreateRequestGender {
116
+ /** 保密 */
117
+ Unkown = 0,
118
+ /** 男 */
119
+ Male = 1,
120
+ /** 女 */
121
+ Female = 2,
122
+ /** 其他 */
123
+ Others = 3,
124
+ }
125
+
126
+ export interface CreateRequest {
127
+ /** 租户内用户的唯一标识 */
128
+ user_id?: string
129
+ /** 用户名 */
130
+ name: string
131
+ /** 英文名 */
132
+ en_name?: string
133
+ /** 别名 */
134
+ nickname?: string
135
+ /** 邮箱 */
136
+ email?: string
137
+ /** 手机号 */
138
+ mobile: string
139
+ /** 手机号码可见性,true 为可见,false 为不可见,目前默认为 true。不可见时,组织员工将无法查看该员工的手机号码 */
140
+ mobile_visible?: boolean
141
+ /** 性别 */
142
+ gender?: CreateRequestGender
143
+ /** 头像的文件Key */
144
+ avatar_key?: string
145
+ /** 用户所在的部门 */
146
+ department_ids: string[]
147
+ /** 用户的上级领导 */
148
+ leader_user_id?: string
149
+ /** 城市 */
150
+ city?: string
151
+ /** 国家 */
152
+ country?: string
153
+ /** 工位 */
154
+ work_station?: string
155
+ /** 入职时间 */
156
+ join_time?: number
157
+ /** 工号 */
158
+ employee_no?: string
159
+ /** 员工类型 */
160
+ employee_type: number
161
+ /** 用户排序信息 */
162
+ orders?: Lark.UserOrder[]
163
+ /** 自定义属性 */
164
+ custom_attrs?: Lark.UserCustomAttr[]
165
+ /** 企业邮箱 */
166
+ enterprise_email?: string
167
+ /** 职务 */
168
+ job_title?: string
169
+ /** 数据驻留地 */
170
+ geo?: string
171
+ /** 职级ID */
172
+ job_level_id?: string
173
+ /** 序列ID */
174
+ job_family_id?: string
175
+ /** 分配给用户的席位ID列表 */
176
+ subscription_ids?: string[]
177
+ /** 虚线上级ID */
178
+ dotted_line_leader_user_ids?: string[]
179
+ }
180
+
181
+ export interface CreateQuery {
182
+ /** 此次调用中使用的用户ID的类型 */
183
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
184
+ /** 此次调用中使用的部门ID的类型。不同 ID 的说明参见[部门ID说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/field-overview#23857fe0) */
185
+ department_id_type?: 'department_id' | 'open_department_id'
186
+ /** 用于幂等判断是否为同一请求,避免重复创建。字符串类型,自行生成。 */
187
+ client_token?: string
188
+ }
189
+
190
+ export interface CreateResponse {
191
+ user?: Lark.User
192
+ }
193
+
194
+ export const enum PatchRequestGender {
195
+ /** 保密 */
196
+ Unkown = 0,
197
+ /** 男 */
198
+ Male = 1,
199
+ /** 女 */
200
+ Female = 2,
201
+ /** 其他 */
202
+ Others = 3,
203
+ }
204
+
205
+ export interface PatchRequest {
206
+ /** 用户名称 */
207
+ name?: string
208
+ /** 英文名 */
209
+ en_name?: string
210
+ /** 别名 */
211
+ nickname?: string
212
+ /** 邮箱 */
213
+ email?: string
214
+ /** 用户手机号 */
215
+ mobile?: string
216
+ /** 手机号码可见性,true 为可见,false 为不可见,目前默认为 true。不可见时,组织员工将无法查看该员工的手机号码 */
217
+ mobile_visible?: boolean
218
+ /** 性别 */
219
+ gender?: PatchRequestGender
220
+ /** 头像的文件Key */
221
+ avatar_key?: string
222
+ /** 用户所在部门ID */
223
+ department_ids?: string[]
224
+ /** 用户直属上级 */
225
+ leader_user_id?: string
226
+ /** 城市 */
227
+ city?: string
228
+ /** 国家 */
229
+ country?: string
230
+ /** 工位 */
231
+ work_station?: string
232
+ /** 入职时间 */
233
+ join_time?: number
234
+ /** 工号 */
235
+ employee_no?: string
236
+ /** 员工类型 */
237
+ employee_type?: number
238
+ /** 用户排序信息 */
239
+ orders?: Lark.UserOrder[]
240
+ /** 自定义属性 */
241
+ custom_attrs?: Lark.UserCustomAttr[]
242
+ /** 企业邮箱 */
243
+ enterprise_email?: string
244
+ /** 职务 */
245
+ job_title?: string
246
+ /** 是否冻结用户 */
247
+ is_frozen?: boolean
248
+ /** 职级ID */
249
+ job_level_id?: string
250
+ /** 序列ID */
251
+ job_family_id?: string
252
+ /** 分配给用户的席位ID列表 */
253
+ subscription_ids?: string[]
254
+ /** 虚线上级ID */
255
+ dotted_line_leader_user_ids?: string[]
256
+ }
257
+
258
+ export interface PatchQuery {
259
+ /** 此次调用中使用的用户ID的类型 */
260
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
261
+ /** 此次调用中使用的部门ID的类型 */
262
+ department_id_type?: 'department_id' | 'open_department_id'
263
+ }
264
+
265
+ export interface PatchResponse {
266
+ user?: Lark.User
267
+ }
268
+
269
+ export interface UpdateUserIdRequest {
270
+ /** 自定义新用户ID */
271
+ new_user_id: string
272
+ }
273
+
274
+ export interface UpdateUserIdQuery {
275
+ /** 此次调用中使用的用户ID的类型 */
276
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
277
+ }
278
+
279
+ export interface GetQuery {
280
+ /** 此次调用中使用的用户ID的类型 */
281
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
282
+ /** 此次调用中使用的部门ID的类型不同 ID 的说明 [部门ID说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/field-overview#23857fe0) */
283
+ department_id_type?: 'department_id' | 'open_department_id'
284
+ }
285
+
286
+ export interface GetResponse {
287
+ user?: Lark.User
288
+ }
289
+
290
+ export interface BatchQuery {
291
+ /** 要查询的用户ID列表 */
292
+ user_ids: string[]
293
+ /** 指定请求中用户ID类型 */
294
+ user_id_type?: 'open_id' | 'union_id' | 'user_id'
295
+ /** 指定查询结果中用户关联的部门ID类型 */
296
+ department_id_type?: 'open_department_id' | 'department_id'
297
+ }
298
+
299
+ export interface BatchResponse {
300
+ /** 查询到的用户信息,其中异常的用户ID不返回结果。 */
301
+ items?: Lark.User[]
302
+ }
303
+
304
+ export interface FindByDepartmentQuery extends Pagination {
305
+ /** 此次调用中使用的用户ID的类型 */
306
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
307
+ /** 此次调用中使用的部门ID的类型部门ID类型的区别参见[部门ID说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/field-overview#23857fe0) */
308
+ department_id_type?: 'department_id' | 'open_department_id'
309
+ /** 填写该字段表示获取该部门下用户,必填。根部门的部门ID为0。ID值与查询参数中的department_id_type 对应。不同 ID 的说明与department_id的获取方式参见 [部门ID说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/field-overview#23857fe0) */
310
+ department_id: string
311
+ }
312
+
313
+ export interface BatchGetIdRequest {
314
+ /** 要查询的用户邮箱,最多 50 条。注意,emails与mobiles相互独立,每条用户邮箱返回对应的用户ID。本接口返回的用户ID数量为emails数量与mobiles数量的和。 */
315
+ emails?: string[]
316
+ /** 要查询的用户手机号,最多 50 条。注意1. emails与mobiles相互独立,每条用户手机号返回对应的用户ID。2. 非中国大陆地区的手机号需要添加以 “+” 开头的国家 / 地区代码。 */
317
+ mobiles?: string[]
318
+ /** 查询结果包含离职员工,可查询离职用户的ID */
319
+ include_resigned?: boolean
320
+ }
321
+
322
+ export interface BatchGetIdQuery {
323
+ /** 返回的用户ID的类型 */
324
+ user_id_type?: 'open_id' | 'union_id' | 'user_id'
325
+ }
326
+
327
+ export interface BatchGetIdResponse {
328
+ /** 手机号或者邮箱对应的用户id信息 */
329
+ user_list?: Lark.UserContactInfo[]
330
+ }
331
+
332
+ export interface DeleteRequest {
333
+ /** 部门群接收者。被删除用户为部门群群主时,转让群主给指定接收者,不指定接收者则默认转让给群内第一个入群的人 */
334
+ department_chat_acceptor_user_id?: string
335
+ /** 外部群接收者。被删除用户为外部群群主时,转让群主给指定接收者,不指定接收者则默认转让给群内与被删除用户在同一组织的第一个入群的人,如果组织内只有该用户在群里,则解散外部群 */
336
+ external_chat_acceptor_user_id?: string
337
+ /** 文档接收者。用户被删除时,其拥有的文档转让给接收者。不指定接收者则默认转让给直属上级,如果无直属上级则将文档资源保留在该用户名下。 */
338
+ docs_acceptor_user_id?: string
339
+ /** 日程接收者。用户被删除时,其拥有的日程转让给接收者,不指定接收者则默认转让给直属上级,如果无直属上级则直接删除日程资源。 */
340
+ calendar_acceptor_user_id?: string
341
+ /** 应用接受者。用户被删除时,其创建的应用转让给接收者,不指定接收者则默认转让给直属上级。如果无直属上级则保留应用在该用户名下,但该用户无法登录开发者后台进行应用管理,管理员可以在管理后台手动转移应用给其他人。 */
342
+ application_acceptor_user_id?: string
343
+ /** 妙记接收者。用户被删除时,其拥有的妙记资源转让给接收者。如果不指定接收者,则默认转让给直属上级。如果无直属上级则将妙记保留在该用户名下。 */
344
+ minutes_acceptor_user_id?: string
345
+ /** 飞书问卷接收者。用户被删除时,其拥有的飞书问卷资源转让给接收者,不指定接收者则默认转让给直属上级,如果无直属上级则直接删除飞书问卷资源。 */
346
+ survey_acceptor_user_id?: string
347
+ /** 用户邮件资源处理方式。用户被删除时,根据传递的操作指令对其拥有的邮件资源做对应处理。未传递指令时默认将邮件资源转让给直属上级,如果无直属上级则保留邮件资源在该用户名下。 */
348
+ email_acceptor?: Lark.ResourceAcceptor
349
+ /** 用户集成平台资源接收者 */
350
+ anycross_acceptor_user_id?: string
351
+ }
352
+
353
+ export interface DeleteQuery {
354
+ /** 此次调用中使用的用户ID的类型 */
355
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
356
+ }
357
+
358
+ export interface ResurrectRequest {
359
+ /** 指定恢复后用户所在部门 */
360
+ departments?: Lark.UserDepartmentInfo[]
361
+ /** 指定恢复后分配的席位 */
362
+ subscription_ids?: string[]
363
+ }
364
+
365
+ export interface ResurrectQuery {
366
+ /** 用户id类型 */
367
+ user_id_type?: 'open_id' | 'union_id' | 'user_id'
368
+ /** 部门id类型 */
369
+ department_id_type?: 'department_id' | 'open_department_id'
370
+ }
371
+
372
+ export interface ListQuery extends Pagination {
373
+ /** 此次调用中使用的用户ID的类型 */
374
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
375
+ /** 此次调用中使用的部门ID的类型 */
376
+ department_id_type?: 'department_id' | 'open_department_id'
377
+ /** 填写该字段表示获取部门下所有用户,选填。 */
378
+ department_id?: string
379
+ }
380
+
381
+ export const enum UpdateRequestGender {
382
+ /** 保密 */
383
+ Unkown = 0,
384
+ /** 男 */
385
+ Male = 1,
386
+ /** 女 */
387
+ Female = 2,
388
+ /** 其他 */
389
+ Others = 3,
390
+ }
391
+
392
+ export interface UpdateRequest {
393
+ /** 用户名 */
394
+ name: string
395
+ /** 英文名 */
396
+ en_name?: string
397
+ /** 别名 */
398
+ nickname?: string
399
+ /** 邮箱 */
400
+ email?: string
401
+ /** 手机号 */
402
+ mobile: string
403
+ /** 手机号码可见性,true 为可见,false 为不可见,目前默认为 true。不可见时,组织员工将无法查看该员工的手机号码 */
404
+ mobile_visible?: boolean
405
+ /** 性别 */
406
+ gender?: UpdateRequestGender
407
+ /** 头像的文件Key */
408
+ avatar_key?: string
409
+ /** 用户所在部门ID */
410
+ department_ids: string[]
411
+ /** 用户直属上级 */
412
+ leader_user_id?: string
413
+ /** 城市 */
414
+ city?: string
415
+ /** 国家 */
416
+ country?: string
417
+ /** 工位 */
418
+ work_station?: string
419
+ /** 入职时间 */
420
+ join_time?: number
421
+ /** 工号 */
422
+ employee_no?: string
423
+ /** 员工类型 */
424
+ employee_type: number
425
+ /** 用户排序信息 */
426
+ orders?: Lark.UserOrder[]
427
+ /** 自定义属性 */
428
+ custom_attrs?: Lark.UserCustomAttr[]
429
+ /** 企业邮箱 */
430
+ enterprise_email?: string
431
+ /** 职务 */
432
+ job_title?: string
433
+ /** 是否冻结用户 */
434
+ is_frozen?: boolean
435
+ }
436
+
437
+ export interface UpdateQuery {
438
+ /** 此次调用中使用的用户ID的类型 */
439
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
440
+ /** 此次调用中使用的部门ID的类型 */
441
+ department_id_type?: 'department_id' | 'open_department_id'
442
+ }
443
+
444
+ export interface UpdateResponse {
445
+ user?: Lark.User
446
+ }
447
+ }
1218
448
 
1219
- export interface GetContactJobFamilyResponse {
1220
- /** 序列信息 */
1221
- job_family?: JobFamily
1222
- }
449
+ export namespace Group {
450
+ export interface Methods {
451
+ member: Member.Methods
452
+ /**
453
+ * 创建用户组
454
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group/create
455
+ */
456
+ create(body: CreateRequest, query?: CreateQuery): Promise<CreateResponse>
457
+ /**
458
+ * 更新用户组
459
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group/patch
460
+ */
461
+ patch(group_id: string, body: PatchRequest, query?: PatchQuery): Promise<void>
462
+ /**
463
+ * 查询指定用户组
464
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group/get
465
+ */
466
+ get(group_id: string, query?: GetQuery): Promise<GetResponse>
467
+ /**
468
+ * 查询用户组列表
469
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group/simplelist
470
+ */
471
+ simplelist(query?: SimplelistQuery): Paginated<Lark.Group, 'grouplist'>
472
+ /**
473
+ * 查询用户所属用户组
474
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group/member_belong
475
+ */
476
+ memberBelong(query?: MemberBelongQuery): Paginated<string, 'group_list'>
477
+ /**
478
+ * 删除用户组
479
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group/delete
480
+ */
481
+ delete(group_id: string): Promise<void>
482
+ }
483
+
484
+ export const enum CreateRequestType {
485
+ /** 普通用户组 */
486
+ Assign = 1,
487
+ /** 动态用户组 */
488
+ Dynamic = 2,
489
+ }
490
+
491
+ export interface CreateRequest {
492
+ /** 用户组的名字,企业内唯一,最大长度:100 字符 */
493
+ name: string
494
+ /** 用户组描述 */
495
+ description?: string
496
+ /** 用户组的类型。默认为1表示普通用户组 */
497
+ type?: CreateRequestType
498
+ /** 自定义用户组ID,可在创建时自定义,不自定义则由系统自动生成,已创建用户组不允许修改 group_id 。自定义group_id数据校验规则:最大长度:64 字符校验规则:数字、大小写字母的组合,不能包含空格 */
499
+ group_id?: string
500
+ }
501
+
502
+ export interface CreateQuery {
503
+ /** 此次调用中使用的用户ID的类型 */
504
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
505
+ /** 此次调用中使用的部门ID的类型 */
506
+ department_id_type?: 'open_department_id' | 'department_id'
507
+ }
508
+
509
+ export interface CreateResponse {
510
+ /** 用户组ID */
511
+ group_id: string
512
+ }
513
+
514
+ export interface PatchRequest {
515
+ /** 用户组的名字,企业内唯一,最大长度:100 字符 */
516
+ name?: string
517
+ /** 用户组描述信息最大长度:500 字 */
518
+ description?: string
519
+ }
520
+
521
+ export interface PatchQuery {
522
+ /** 此次调用中使用的用户ID的类型 */
523
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
524
+ /** 此次调用中使用的部门ID的类型 */
525
+ department_id_type?: 'department_id' | 'open_department_id'
526
+ }
527
+
528
+ export interface GetQuery {
529
+ /** 此次调用中使用的用户ID的类型 */
530
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
531
+ /** 此次调用中使用的部门ID的类型 */
532
+ department_id_type?: 'open_department_id' | 'department_id'
533
+ }
534
+
535
+ export interface GetResponse {
536
+ /** 用户组详情 */
537
+ group: Lark.Group
538
+ }
539
+
540
+ export const enum SimplelistQueryType {
541
+ /** 普通用户组 */
542
+ Assign = 1,
543
+ /** 动态用户组 */
544
+ Dynamic = 2,
545
+ }
546
+
547
+ export interface SimplelistQuery extends Pagination {
548
+ /** 用户组类型 */
549
+ type?: SimplelistQueryType
550
+ }
551
+
552
+ export const enum MemberBelongQueryGroupType {
553
+ /** 普通用户组 */
554
+ Assign = 1,
555
+ /** 动态用户组 */
556
+ Dynamic = 2,
557
+ }
558
+
559
+ export interface MemberBelongQuery extends Pagination {
560
+ /** 成员ID */
561
+ member_id: string
562
+ /** 成员ID类型 */
563
+ member_id_type?: 'open_id' | 'union_id' | 'user_id'
564
+ /** 欲获取的用户组类型 */
565
+ group_type?: MemberBelongQueryGroupType
566
+ }
567
+
568
+ export namespace Member {
569
+ export interface Methods {
570
+ /**
571
+ * 添加用户组成员
572
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group-member/add
573
+ */
574
+ add(group_id: string, body: AddRequest): Promise<void>
575
+ /**
576
+ * 批量添加用户组成员
577
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group-member/batch_add
578
+ */
579
+ batchAdd(group_id: string, body: BatchAddRequest): Promise<BatchAddResponse>
580
+ /**
581
+ * 查询用户组成员列表
582
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group-member/simplelist
583
+ */
584
+ simplelist(group_id: string, query?: SimplelistQuery): Paginated<Lark.Memberlist, 'memberlist'>
585
+ /**
586
+ * 移除用户组成员
587
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group-member/remove
588
+ */
589
+ remove(group_id: string, body: RemoveRequest): Promise<void>
590
+ /**
591
+ * 批量移除用户组成员
592
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/group-member/batch_remove
593
+ */
594
+ batchRemove(group_id: string, body: BatchRemoveRequest): Promise<void>
595
+ }
596
+
597
+ export interface AddRequest {
598
+ /** 用户组成员的类型,取值为 user */
599
+ member_type: 'user'
600
+ /** 当member_type =user时候,member_id_type表示user_id_type,枚举值为open_id, union_id, user_id */
601
+ member_id_type: 'open_id' | 'union_id' | 'user_id'
602
+ /** 添加的成员ID */
603
+ member_id: string
604
+ }
605
+
606
+ export interface BatchAddRequest {
607
+ /** 待添加成员 */
608
+ members?: Lark.Memberlist[]
609
+ }
610
+
611
+ export interface BatchAddResponse {
612
+ /** 成员添加操作结果 */
613
+ results?: Lark.MemberResult[]
614
+ }
615
+
616
+ export interface SimplelistQuery extends Pagination {
617
+ /** 欲获取成员ID类型。当member_type=user时候,member_id_type表示user_id_type,枚举值open_id, union_id和user_id。当member_type=department时候,member_id_type表示department_id_type,枚举值open_id和department_id。 */
618
+ member_id_type?: 'open_id' | 'union_id' | 'user_id' | 'department_id'
619
+ /** 欲获取的用户组成员类型。 */
620
+ member_type?: 'user' | 'department'
621
+ }
622
+
623
+ export interface RemoveRequest {
624
+ /** 用户组成员的类型,取值为 user */
625
+ member_type: 'user'
626
+ /** 操作移除的用户组成员ID */
627
+ member_id: string
628
+ /** 当member_type =user时候,member_id_type表示user_id_type,枚举值为open_id, union_id, user_id */
629
+ member_id_type: 'open_id' | 'union_id' | 'user_id'
630
+ }
631
+
632
+ export interface BatchRemoveRequest {
633
+ /** 待移除成员 */
634
+ members: Lark.Memberlist[]
635
+ }
636
+ }
637
+ }
1223
638
 
1224
- export interface ListContactJobFamilyQuery extends Pagination {
1225
- /** 序列名称,传入该字段时,可查询指定序列名称对应的序列信息 */
1226
- name?: string
1227
- }
639
+ export namespace CustomAttr {
640
+ export interface Methods {
641
+ /**
642
+ * 获取企业自定义用户字段
643
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/custom_attr/list
644
+ */
645
+ list(query?: Pagination): Paginated<Lark.CustomAttr>
646
+ }
647
+ }
1228
648
 
1229
- export interface GetContactJobTitleResponse {
1230
- /** 职务信息 */
1231
- job_title?: JobTitle
1232
- }
649
+ export namespace EmployeeTypeEnum {
650
+ export interface Methods {
651
+ /**
652
+ * 新增人员类型
653
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/employee_type_enum/create
654
+ */
655
+ create(body: CreateRequest): Promise<CreateResponse>
656
+ /**
657
+ * 更新人员类型
658
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/employee_type_enum/update
659
+ */
660
+ update(enum_id: string, body: UpdateRequest): Promise<UpdateResponse>
661
+ /**
662
+ * 查询人员类型
663
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/employee_type_enum/list
664
+ */
665
+ list(query?: Pagination): Paginated<Lark.EmployeeTypeEnum>
666
+ /**
667
+ * 删除人员类型
668
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/employee_type_enum/delete
669
+ */
670
+ delete(enum_id: string): Promise<void>
671
+ }
672
+
673
+ export const enum CreateRequestEnumType {
674
+ /** 内置类型 */
675
+ Defualt = 1,
676
+ /** 自定义 */
677
+ Custom = 2,
678
+ }
679
+
680
+ export const enum CreateRequestEnumStatus {
681
+ /** 激活 */
682
+ Active = 1,
683
+ /** 未激活 */
684
+ Inactive = 2,
685
+ }
686
+
687
+ export interface CreateRequest {
688
+ /** 枚举内容 */
689
+ content: string
690
+ /** 类型 */
691
+ enum_type: CreateRequestEnumType
692
+ /** 类型 */
693
+ enum_status: CreateRequestEnumStatus
694
+ /** i18n定义 */
695
+ i18n_content?: Lark.I18nContent[]
696
+ }
697
+
698
+ export interface CreateResponse {
699
+ /** 创建人员类型接口 */
700
+ employee_type_enum?: Lark.EmployeeTypeEnum
701
+ }
702
+
703
+ export const enum UpdateRequestEnumType {
704
+ /** 内置类型 */
705
+ Defualt = 1,
706
+ /** 自定义 */
707
+ Custom = 2,
708
+ }
709
+
710
+ export const enum UpdateRequestEnumStatus {
711
+ /** 激活 */
712
+ Active = 1,
713
+ /** 未激活 */
714
+ Inactive = 2,
715
+ }
716
+
717
+ export interface UpdateRequest {
718
+ /** 枚举内容 */
719
+ content: string
720
+ /** 类型 */
721
+ enum_type: UpdateRequestEnumType
722
+ /** 类型 */
723
+ enum_status: UpdateRequestEnumStatus
724
+ /** i18n定义 */
725
+ i18n_content?: Lark.I18nContent[]
726
+ }
727
+
728
+ export interface UpdateResponse {
729
+ employee_type_enum?: Lark.EmployeeTypeEnum
730
+ }
731
+ }
1233
732
 
1234
- export interface GetContactWorkCityResponse {
1235
- /** 工作城市信息 */
1236
- work_city?: WorkCity
1237
- }
733
+ export namespace Department {
734
+ export interface Methods {
735
+ /**
736
+ * 创建部门
737
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/create
738
+ */
739
+ create(body: CreateRequest, query?: CreateQuery): Promise<CreateResponse>
740
+ /**
741
+ * 修改部门部分信息
742
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/patch
743
+ */
744
+ patch(department_id: string, body: PatchRequest, query?: PatchQuery): Promise<PatchResponse>
745
+ /**
746
+ * 更新部门所有信息
747
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/update
748
+ */
749
+ update(department_id: string, body: UpdateRequest, query?: UpdateQuery): Promise<UpdateResponse>
750
+ /**
751
+ * 更新部门 ID
752
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/update_department_id
753
+ */
754
+ updateDepartmentId(department_id: string, body: UpdateDepartmentIdRequest, query?: UpdateDepartmentIdQuery): Promise<void>
755
+ /**
756
+ * 部门群转为普通群
757
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/unbind_department_chat
758
+ */
759
+ unbindDepartmentChat(body: UnbindDepartmentChatRequest, query?: UnbindDepartmentChatQuery): Promise<void>
760
+ /**
761
+ * 获取单个部门信息
762
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/get
763
+ */
764
+ get(department_id: string, query?: GetQuery): Promise<GetResponse>
765
+ /**
766
+ * 批量获取部门信息
767
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/batch
768
+ */
769
+ batch(query?: BatchQuery): Promise<BatchResponse>
770
+ /**
771
+ * 获取子部门列表
772
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/children
773
+ */
774
+ children(department_id: string, query?: ChildrenQuery): Paginated<Lark.Department>
775
+ /**
776
+ * 获取父部门信息
777
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/parent
778
+ */
779
+ parent(query?: ParentQuery): Paginated<Lark.Department>
780
+ /**
781
+ * 搜索部门
782
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/search
783
+ */
784
+ search(body: SearchRequest, query?: SearchQuery): Paginated<Lark.Department>
785
+ /**
786
+ * 删除部门
787
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/delete
788
+ */
789
+ delete(department_id: string, query?: DeleteQuery): Promise<void>
790
+ /**
791
+ * 获取部门信息列表
792
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/list
793
+ */
794
+ list(query?: ListQuery): Paginated<Lark.Department>
795
+ }
796
+
797
+ export interface CreateRequest {
798
+ /** 部门名称 */
799
+ name: string
800
+ /** 国际化的部门名称 */
801
+ i18n_name?: Lark.DepartmentI18nName
802
+ /** 父部门的ID */
803
+ parent_department_id: string
804
+ /** 本部门的自定义部门ID */
805
+ department_id?: string
806
+ /** 部门主管用户ID */
807
+ leader_user_id?: string
808
+ /** 部门的排序 */
809
+ order?: string
810
+ /** 是否创建部门群,默认不创建 */
811
+ create_group_chat?: boolean
812
+ /** 部门负责人 */
813
+ leaders?: Lark.DepartmentLeader[]
814
+ /** 部门群雇员类型限制 */
815
+ group_chat_employee_types?: number[]
816
+ /** 部门HRBP */
817
+ department_hrbps?: string[]
818
+ }
819
+
820
+ export interface CreateQuery {
821
+ /** 此次调用中使用的用户ID的类型 */
822
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
823
+ /** 此次调用中使用的部门ID的类型不同 ID 的说明参见[部门ID说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/field-overview#23857fe0) */
824
+ department_id_type?: 'department_id' | 'open_department_id'
825
+ /** 用于幂等判断是否为同一请求,避免重复创建。字符串类型,自行生成。 */
826
+ client_token?: string
827
+ }
828
+
829
+ export interface CreateResponse {
830
+ department?: Lark.Department
831
+ }
832
+
833
+ export interface PatchRequest {
834
+ /** 部门名 */
835
+ name?: string
836
+ /** 国际化的部门名称 */
837
+ i18n_name?: Lark.DepartmentI18nName
838
+ /** 父部门ID */
839
+ parent_department_id?: string
840
+ /** leaderID */
841
+ leader_user_id?: string
842
+ /** 部门的排序 */
843
+ order?: string
844
+ /** 是否创建部门群,默认不创建 */
845
+ create_group_chat?: boolean
846
+ /** 部门负责人 */
847
+ leaders?: Lark.DepartmentLeader[]
848
+ /** 部门群雇员类型限制 */
849
+ group_chat_employee_types?: number[]
850
+ /** 部门HRBP */
851
+ department_hrbps?: string[]
852
+ }
853
+
854
+ export interface PatchQuery {
855
+ /** 此次调用中使用的用户ID的类型 */
856
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
857
+ /** 此次调用中使用的部门ID的类型 */
858
+ department_id_type?: 'department_id' | 'open_department_id'
859
+ }
860
+
861
+ export interface PatchResponse {
862
+ department?: Lark.Department
863
+ }
864
+
865
+ export interface UpdateRequest {
866
+ /** 部门名称 */
867
+ name: string
868
+ /** 国际化的部门名称 */
869
+ i18n_name?: Lark.DepartmentI18nName
870
+ /** 父部门ID */
871
+ parent_department_id: string
872
+ /** LeaderID */
873
+ leader_user_id?: string
874
+ /** 部门的排序 */
875
+ order?: string
876
+ /** 是否创建部门群,默认不创建 */
877
+ create_group_chat?: boolean
878
+ /** 部门负责人 */
879
+ leaders?: Lark.DepartmentLeader[]
880
+ /** 部门群雇员类型限制 */
881
+ group_chat_employee_types?: number[]
882
+ }
883
+
884
+ export interface UpdateQuery {
885
+ /** 此次调用中使用的用户ID的类型 */
886
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
887
+ /** 此次调用中使用的部门ID的类型 */
888
+ department_id_type?: 'department_id' | 'open_department_id'
889
+ }
890
+
891
+ export interface UpdateResponse {
892
+ department?: Lark.Department
893
+ }
894
+
895
+ export interface UpdateDepartmentIdRequest {
896
+ /** 本部门的自定义部门新ID */
897
+ new_department_id: string
898
+ }
899
+
900
+ export interface UpdateDepartmentIdQuery {
901
+ /** 此次调用中使用的部门ID的类型 */
902
+ department_id_type?: 'department_id' | 'open_department_id'
903
+ }
904
+
905
+ export interface UnbindDepartmentChatRequest {
906
+ /** 部门ID */
907
+ department_id: string
908
+ }
909
+
910
+ export interface UnbindDepartmentChatQuery {
911
+ /** 此次调用中使用的部门ID的类型,默认为"open_department_id" */
912
+ department_id_type?: 'department_id' | 'open_department_id'
913
+ }
914
+
915
+ export interface GetQuery {
916
+ /** 此次调用中使用的用户ID的类型 */
917
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
918
+ /** 此次调用中使用的部门ID的类型不同 ID 的说明 [部门ID说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/field-overview#23857fe0) */
919
+ department_id_type?: 'department_id' | 'open_department_id'
920
+ }
921
+
922
+ export interface GetResponse {
923
+ department?: Lark.Department
924
+ }
925
+
926
+ export interface BatchQuery {
927
+ /** 查询的部门ID列表,类型需要与department_id_type对应 */
928
+ department_ids: string[]
929
+ /** 说明请求中department_id_list参数所使用的部门ID类型 */
930
+ department_id_type?: 'open_department_id' | 'department_id'
931
+ /** 指定调用结果中包含用户(如部门leader)关联的用户ID类型 */
932
+ user_id_type?: 'open_id' | 'union_id' | 'user_id'
933
+ }
934
+
935
+ export interface BatchResponse {
936
+ /** 查询到的部门信息,其中异常的部门ID不返回结果。 */
937
+ items?: Lark.Department[]
938
+ }
939
+
940
+ export interface ChildrenQuery extends Pagination {
941
+ /** 此次调用中使用的用户ID的类型 */
942
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
943
+ /** 此次调用中使用的部门ID的类型不同 ID 的说明与department_id的获取方式参见 [部门ID说明](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/field-overview#23857fe0) */
944
+ department_id_type?: 'department_id' | 'open_department_id'
945
+ /** 是否递归获取子部门 */
946
+ fetch_child?: boolean
947
+ }
948
+
949
+ export interface ParentQuery extends Pagination {
950
+ /** 此次调用中使用的用户ID的类型 */
951
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
952
+ /** 此次调用中使用的部门ID的类型 */
953
+ department_id_type?: 'department_id' | 'open_department_id'
954
+ /** 部门ID */
955
+ department_id: string
956
+ }
957
+
958
+ export interface SearchRequest {
959
+ /** 搜索关键词,匹配字段为部门名称(不支持匹配部门国际化名称) */
960
+ query: string
961
+ }
962
+
963
+ export interface SearchQuery extends Pagination {
964
+ /** 此次调用中使用的用户ID的类型 */
965
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
966
+ /** 此次调用中使用的部门ID的类型 */
967
+ department_id_type?: 'department_id' | 'open_department_id'
968
+ }
969
+
970
+ export interface DeleteQuery {
971
+ /** 此次调用中使用的部门ID的类型 */
972
+ department_id_type?: 'department_id' | 'open_department_id'
973
+ }
974
+
975
+ export interface ListQuery extends Pagination {
976
+ /** 此次调用中使用的用户ID的类型 */
977
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
978
+ /** 此次调用中使用的部门ID的类型 */
979
+ department_id_type?: 'department_id' | 'open_department_id'
980
+ /** 父部门的ID,填上获取部门下所有子部门,此处填写的 ID 必须是 department_id_type 指定的 ID。 */
981
+ parent_department_id?: string
982
+ /** 是否递归获取子部门 */
983
+ fetch_child?: boolean
984
+ }
985
+ }
1238
986
 
1239
- export interface ListContactUserQuery extends Pagination {
1240
- /** 此次调用中使用的用户ID的类型 */
1241
- user_id_type?: 'user_id' | 'union_id' | 'open_id'
1242
- /** 此次调用中使用的部门ID的类型 */
1243
- department_id_type?: 'department_id' | 'open_department_id'
1244
- /** 填写该字段表示获取部门下所有用户,选填。 */
1245
- department_id?: string
1246
- }
987
+ export namespace Unit {
988
+ export interface Methods {
989
+ /**
990
+ * 创建单位
991
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/unit/create
992
+ */
993
+ create(body: CreateRequest): Promise<CreateResponse>
994
+ /**
995
+ * 修改单位信息
996
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/unit/patch
997
+ */
998
+ patch(unit_id: string, body: PatchRequest): Promise<void>
999
+ /**
1000
+ * 建立部门与单位的绑定关系
1001
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/unit/bind_department
1002
+ */
1003
+ bindDepartment(body: BindDepartmentRequest): Promise<void>
1004
+ /**
1005
+ * 解除部门与单位的绑定关系
1006
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/unit/unbind_department
1007
+ */
1008
+ unbindDepartment(body: UnbindDepartmentRequest): Promise<void>
1009
+ /**
1010
+ * 获取单位绑定的部门列表
1011
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/unit/list_department
1012
+ */
1013
+ listDepartment(query?: ListDepartmentQuery): Paginated<Lark.UnitDepartment, 'departmentlist'>
1014
+ /**
1015
+ * 获取单位信息
1016
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/unit/get
1017
+ */
1018
+ get(unit_id: string): Promise<GetResponse>
1019
+ /**
1020
+ * 获取单位列表
1021
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/unit/list
1022
+ */
1023
+ list(query?: Pagination): Paginated<Lark.Unit, 'unitlist'>
1024
+ /**
1025
+ * 删除单位
1026
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/unit/delete
1027
+ */
1028
+ delete(unit_id: string): Promise<void>
1029
+ }
1030
+
1031
+ export interface CreateRequest {
1032
+ /** 单位自定义ID。不带默认自动生成。1-64字节范围大小,需为数字字母 */
1033
+ unit_id?: string
1034
+ /** 单位的名字,长度范围为1-100个字 */
1035
+ name: string
1036
+ /** 单位类型,长度范围为1-100个字,创建后不可修改 */
1037
+ unit_type: string
1038
+ }
1039
+
1040
+ export interface CreateResponse {
1041
+ /** 单位的自定义ID */
1042
+ unit_id: string
1043
+ }
1044
+
1045
+ export interface PatchRequest {
1046
+ /** 单位的名字 */
1047
+ name?: string
1048
+ }
1049
+
1050
+ export interface BindDepartmentRequest {
1051
+ /** 单位ID */
1052
+ unit_id: string
1053
+ /** 单位关联的部门ID */
1054
+ department_id: string
1055
+ /** 此次调用中使用的部门ID的类型 */
1056
+ department_id_type?: 'department_id' | 'open_department_id'
1057
+ }
1058
+
1059
+ export interface UnbindDepartmentRequest {
1060
+ /** 单位ID */
1061
+ unit_id: string
1062
+ /** 预解除关联的部门ID */
1063
+ department_id: string
1064
+ /** 此次调用中使用的部门ID的类型 */
1065
+ department_id_type?: 'department_id' | 'open_department_id'
1066
+ }
1067
+
1068
+ export interface ListDepartmentQuery extends Pagination {
1069
+ /** 单位ID */
1070
+ unit_id: string
1071
+ /** 此次调用中预获取的部门ID的类型 */
1072
+ department_id_type?: 'department_id' | 'open_department_id'
1073
+ }
1074
+
1075
+ export interface GetResponse {
1076
+ /** 单位信息 */
1077
+ unit: Lark.Unit
1078
+ }
1079
+ }
1247
1080
 
1248
- export const enum UpdateContactUserRequestGender {
1249
- /** 保密 */
1250
- Unkown = 0,
1251
- /** 男 */
1252
- Male = 1,
1253
- /** */
1254
- Female = 2,
1255
- /** 其他 */
1256
- Others = 3,
1257
- }
1081
+ export namespace FunctionalRole {
1082
+ export interface Methods {
1083
+ member: Member.Methods
1084
+ /**
1085
+ * 创建角色
1086
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/functional_role/create
1087
+ */
1088
+ create(body: CreateRequest): Promise<CreateResponse>
1089
+ /**
1090
+ * 修改角色名称
1091
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/functional_role/update
1092
+ */
1093
+ update(role_id: string, body: UpdateRequest): Promise<void>
1094
+ /**
1095
+ * 删除角色
1096
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/functional_role/delete
1097
+ */
1098
+ delete(role_id: string): Promise<void>
1099
+ }
1100
+
1101
+ export interface CreateRequest {
1102
+ /** 角色名称,在单租户下唯一 */
1103
+ role_name: string
1104
+ }
1105
+
1106
+ export interface CreateResponse {
1107
+ /** 角色ID,在单租户下唯一 */
1108
+ role_id: string
1109
+ }
1110
+
1111
+ export interface UpdateRequest {
1112
+ /** 修改的角色名称,在单租户下唯一 */
1113
+ role_name: string
1114
+ }
1115
+
1116
+ export namespace Member {
1117
+ export interface Methods {
1118
+ /**
1119
+ * 批量添加角色成员
1120
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/functional_role-member/batch_create
1121
+ */
1122
+ batchCreate(role_id: string, body: BatchCreateRequest, query?: BatchCreateQuery): Promise<BatchCreateResponse>
1123
+ /**
1124
+ * 批量设置角色成员管理范围
1125
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/functional_role-member/scopes
1126
+ */
1127
+ scopes(role_id: string, body: ScopesRequest, query?: ScopesQuery): Promise<ScopesResponse>
1128
+ /**
1129
+ * 查询角色下某个成员的管理范围
1130
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/functional_role-member/get
1131
+ */
1132
+ get(role_id: string, member_id: string, query?: GetQuery): Promise<GetResponse>
1133
+ /**
1134
+ * 查询角色下的所有成员信息
1135
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/functional_role-member/list
1136
+ */
1137
+ list(role_id: string, query?: ListQuery): Paginated<Lark.FunctionalRoleMember, 'members'>
1138
+ /**
1139
+ * 删除角色下的成员
1140
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/functional_role-member/batch_delete
1141
+ */
1142
+ batchDelete(role_id: string, body: BatchDeleteRequest, query?: BatchDeleteQuery): Promise<BatchDeleteResponse>
1143
+ }
1144
+
1145
+ export interface BatchCreateRequest {
1146
+ /** 角色添加的角色成员列表(一批用户的UserID列表) */
1147
+ members: string[]
1148
+ }
1149
+
1150
+ export interface BatchCreateQuery {
1151
+ /** 成员ID类型 */
1152
+ user_id_type?: 'open_id' | 'union_id' | 'user_id'
1153
+ }
1154
+
1155
+ export interface BatchCreateResponse {
1156
+ /** 批量新增角色成员结果集 */
1157
+ results?: Lark.FunctionalRoleMemberResult[]
1158
+ }
1159
+
1160
+ export interface ScopesRequest {
1161
+ /** 角色修改的角色成员列表(一批用户的UserID列表) */
1162
+ members: string[]
1163
+ /** 角色内用户的管理范围 */
1164
+ departments: string[]
1165
+ }
1166
+
1167
+ export interface ScopesQuery {
1168
+ /** 用户 ID 类型 */
1169
+ user_id_type?: 'open_id' | 'union_id' | 'user_id'
1170
+ /** 此次调用中使用的部门ID的类型 */
1171
+ department_id_type?: 'department_id' | 'open_department_id'
1172
+ }
1173
+
1174
+ export interface ScopesResponse {
1175
+ /** 批量更新角色成员管理范围结果集 */
1176
+ results?: Lark.FunctionalRoleMemberResult[]
1177
+ }
1178
+
1179
+ export interface GetQuery {
1180
+ /** 用户 ID 类型 */
1181
+ user_id_type?: 'open_id' | 'union_id' | 'user_id'
1182
+ /** 此次调用中使用的部门ID的类型 */
1183
+ department_id_type?: 'department_id' | 'open_department_id'
1184
+ }
1185
+
1186
+ export interface GetResponse {
1187
+ /** 成员的管理范围 */
1188
+ member?: Lark.FunctionalRoleMember
1189
+ }
1190
+
1191
+ export interface ListQuery extends Pagination {
1192
+ /** 用户 ID 类型 */
1193
+ user_id_type?: 'open_id' | 'union_id' | 'user_id'
1194
+ /** 此次调用中使用的部门ID的类型 */
1195
+ department_id_type?: 'department_id' | 'open_department_id'
1196
+ }
1197
+
1198
+ export interface BatchDeleteRequest {
1199
+ /** 角色删除的角色成员列表(一批用户的UserID列表) */
1200
+ members?: string[]
1201
+ }
1202
+
1203
+ export interface BatchDeleteQuery {
1204
+ /** 成员ID类型 */
1205
+ user_id_type?: 'open_id' | 'union_id' | 'user_id'
1206
+ }
1207
+
1208
+ export interface BatchDeleteResponse {
1209
+ /** 批量新增角色成员结果集 */
1210
+ result?: Lark.FunctionalRoleMemberResult[]
1211
+ }
1212
+ }
1213
+ }
1258
1214
 
1259
- export interface UpdateContactUserRequest {
1260
- /** 用户名 */
1261
- name: string
1262
- /** 英文名 */
1263
- en_name?: string
1264
- /** 别名 */
1265
- nickname?: string
1266
- /** 邮箱 */
1267
- email?: string
1268
- /** 手机号 */
1269
- mobile: string
1270
- /** 手机号码可见性,true 为可见,false 为不可见,目前默认为 true。不可见时,组织员工将无法查看该员工的手机号码 */
1271
- mobile_visible?: boolean
1272
- /** 性别 */
1273
- gender?: UpdateContactUserRequestGender
1274
- /** 头像的文件Key */
1275
- avatar_key?: string
1276
- /** 用户所在部门ID */
1277
- department_ids: string[]
1278
- /** 用户直属上级 */
1279
- leader_user_id?: string
1280
- /** 城市 */
1281
- city?: string
1282
- /** 国家 */
1283
- country?: string
1284
- /** 工位 */
1285
- work_station?: string
1286
- /** 入职时间 */
1287
- join_time?: number
1288
- /** 工号 */
1289
- employee_no?: string
1290
- /** 员工类型 */
1291
- employee_type: number
1292
- /** 用户排序信息 */
1293
- orders?: UserOrder[]
1294
- /** 自定义属性 */
1295
- custom_attrs?: UserCustomAttr[]
1296
- /** 企业邮箱 */
1297
- enterprise_email?: string
1298
- /** 职务 */
1299
- job_title?: string
1300
- /** 是否冻结用户 */
1301
- is_frozen?: boolean
1302
- }
1215
+ export namespace JobLevel {
1216
+ export interface Methods {
1217
+ /**
1218
+ * 创建职级
1219
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_level/create
1220
+ */
1221
+ create(body: CreateRequest): Promise<CreateResponse>
1222
+ /**
1223
+ * 更新职级
1224
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_level/update
1225
+ */
1226
+ update(job_level_id: string, body: UpdateRequest): Promise<UpdateResponse>
1227
+ /**
1228
+ * 获取单个职级信息
1229
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_level/get
1230
+ */
1231
+ get(job_level_id: string): Promise<GetResponse>
1232
+ /**
1233
+ * 获取租户职级列表
1234
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_level/list
1235
+ */
1236
+ list(query?: ListQuery): Paginated<Lark.JobLevel>
1237
+ /**
1238
+ * 删除职级
1239
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_level/delete
1240
+ */
1241
+ delete(job_level_id: string): Promise<void>
1242
+ }
1243
+
1244
+ export interface CreateRequest {
1245
+ /** 职级名称 */
1246
+ name: string
1247
+ /** 职级描述 */
1248
+ description?: string
1249
+ /** 职级的排序,可填入自然数100-100000的数值,系统按照数值大小从小到大排序。不填写该字段时,默认新增排序在当前职级列表中最后位(最大值) */
1250
+ order?: number
1251
+ /** 是否启用 */
1252
+ status: boolean
1253
+ /** 多语言名称 */
1254
+ i18n_name?: Lark.I18nContent[]
1255
+ /** 多语言描述 */
1256
+ i18n_description?: Lark.I18nContent[]
1257
+ }
1258
+
1259
+ export interface CreateResponse {
1260
+ /** 职级信息 */
1261
+ job_level?: Lark.JobLevel
1262
+ }
1263
+
1264
+ export interface UpdateRequest {
1265
+ /** 职级名称 */
1266
+ name?: string
1267
+ /** 职级描述 */
1268
+ description?: string
1269
+ /** 职级的排序,可填入自然数100-100000的数值,系统按照数值大小从小到大排序。不填写该字段时,默认新增排序在当前职级列表中最后位(最大值) */
1270
+ order?: number
1271
+ /** 是否启用 */
1272
+ status?: boolean
1273
+ /** 多语言名称 */
1274
+ i18n_name?: Lark.I18nContent[]
1275
+ /** 多语言描述 */
1276
+ i18n_description?: Lark.I18nContent[]
1277
+ }
1278
+
1279
+ export interface UpdateResponse {
1280
+ /** 职级信息 */
1281
+ job_level?: Lark.JobLevel
1282
+ }
1283
+
1284
+ export interface GetResponse {
1285
+ /** 职级信息 */
1286
+ job_level?: Lark.JobLevel
1287
+ }
1288
+
1289
+ export interface ListQuery extends Pagination {
1290
+ /** 传入该字段时,可查询指定职级名称对应的职级信息。 */
1291
+ name?: string
1292
+ }
1293
+ }
1303
1294
 
1304
- export interface UpdateContactUserQuery {
1305
- /** 此次调用中使用的用户ID的类型 */
1306
- user_id_type?: 'user_id' | 'union_id' | 'open_id'
1307
- /** 此次调用中使用的部门ID的类型 */
1308
- department_id_type?: 'department_id' | 'open_department_id'
1309
- }
1295
+ export namespace JobFamily {
1296
+ export interface Methods {
1297
+ /**
1298
+ * 创建序列
1299
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_family/create
1300
+ */
1301
+ create(body: CreateRequest): Promise<CreateResponse>
1302
+ /**
1303
+ * 更新序列
1304
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_family/update
1305
+ */
1306
+ update(job_family_id: string, body: UpdateRequest): Promise<UpdateResponse>
1307
+ /**
1308
+ * 获取单个序列信息
1309
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_family/get
1310
+ */
1311
+ get(job_family_id: string): Promise<GetResponse>
1312
+ /**
1313
+ * 获取租户序列列表
1314
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_family/list
1315
+ */
1316
+ list(query?: ListQuery): Paginated<Lark.JobFamily>
1317
+ /**
1318
+ * 删除序列
1319
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_family/delete
1320
+ */
1321
+ delete(job_family_id: string): Promise<void>
1322
+ }
1323
+
1324
+ export interface CreateRequest {
1325
+ /** 序列名称。1-100字符,支持中、英文及符号 */
1326
+ name: string
1327
+ /** 序列描述,描述序列详情信息 */
1328
+ description?: string
1329
+ /** 上级序列ID。需是该租户的序列ID列表中的值,对应唯一的序列名称。 */
1330
+ parent_job_family_id?: string
1331
+ /** 是否启用 */
1332
+ status: boolean
1333
+ /** 多语言序列名称 */
1334
+ i18n_name?: Lark.I18nContent[]
1335
+ /** 多语言描述 */
1336
+ i18n_description?: Lark.I18nContent[]
1337
+ }
1338
+
1339
+ export interface CreateResponse {
1340
+ /** 序列信息 */
1341
+ job_family?: Lark.JobFamily
1342
+ }
1343
+
1344
+ export interface UpdateRequest {
1345
+ /** 序列名称。1-100字符,支持中、英文及符号 */
1346
+ name?: string
1347
+ /** 序列描述,描述序列详情信息 */
1348
+ description?: string
1349
+ /** 上级序列ID。需是该租户的序列ID列表中的值,对应唯一的序列名称。 */
1350
+ parent_job_family_id?: string
1351
+ /** 是否启用 */
1352
+ status?: boolean
1353
+ /** 多语言序列名称 */
1354
+ i18n_name?: Lark.I18nContent[]
1355
+ /** 多语言描述 */
1356
+ i18n_description?: Lark.I18nContent[]
1357
+ }
1358
+
1359
+ export interface UpdateResponse {
1360
+ /** 更新后的序列信息 */
1361
+ job_family?: Lark.JobFamily
1362
+ }
1363
+
1364
+ export interface GetResponse {
1365
+ /** 序列信息 */
1366
+ job_family?: Lark.JobFamily
1367
+ }
1368
+
1369
+ export interface ListQuery extends Pagination {
1370
+ /** 序列名称,传入该字段时,可查询指定序列名称对应的序列信息 */
1371
+ name?: string
1372
+ }
1373
+ }
1310
1374
 
1311
- export interface UpdateContactUserResponse {
1312
- user?: User
1313
- }
1375
+ export namespace JobTitle {
1376
+ export interface Methods {
1377
+ /**
1378
+ * 获取单个职务信息
1379
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_title/get
1380
+ */
1381
+ get(job_title_id: string): Promise<GetResponse>
1382
+ /**
1383
+ * 获取租户职务列表
1384
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_title/list
1385
+ */
1386
+ list(query?: Pagination): Paginated<Lark.JobTitle>
1387
+ }
1388
+
1389
+ export interface GetResponse {
1390
+ /** 职务信息 */
1391
+ job_title?: Lark.JobTitle
1392
+ }
1393
+ }
1314
1394
 
1315
- export interface ListContactDepartmentQuery extends Pagination {
1316
- /** 此次调用中使用的用户ID的类型 */
1317
- user_id_type?: 'user_id' | 'union_id' | 'open_id'
1318
- /** 此次调用中使用的部门ID的类型 */
1319
- department_id_type?: 'department_id' | 'open_department_id'
1320
- /** 父部门的ID,填上获取部门下所有子部门,此处填写的 ID 必须是 department_id_type 指定的 ID。 */
1321
- parent_department_id?: string
1322
- /** 是否递归获取子部门 */
1323
- fetch_child?: boolean
1395
+ export namespace WorkCity {
1396
+ export interface Methods {
1397
+ /**
1398
+ * 获取单个工作城市信息
1399
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/work_city/get
1400
+ */
1401
+ get(work_city_id: string): Promise<GetResponse>
1402
+ /**
1403
+ * 获取租户工作城市列表
1404
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/work_city/list
1405
+ */
1406
+ list(query?: Pagination): Paginated<Lark.WorkCity>
1407
+ }
1408
+
1409
+ export interface GetResponse {
1410
+ /** 工作城市信息 */
1411
+ work_city?: Lark.WorkCity
1412
+ }
1413
+ }
1324
1414
  }
1325
1415
 
1326
1416
  Internal.define({
1327
1417
  '/contact/v3/scopes': {
1328
- GET: 'listContactScope',
1418
+ GET: 'contact.scope.list',
1329
1419
  },
1330
1420
  '/contact/v3/users': {
1331
- POST: 'createContactUser',
1332
- GET: { name: 'listContactUser', pagination: { argIndex: 0 } },
1421
+ POST: 'contact.user.create',
1422
+ GET: { name: 'contact.user.list', pagination: { argIndex: 0 } },
1333
1423
  },
1334
1424
  '/contact/v3/users/{user_id}': {
1335
- PATCH: 'patchContactUser',
1336
- GET: 'getContactUser',
1337
- DELETE: 'deleteContactUser',
1338
- PUT: 'updateContactUser',
1425
+ PATCH: 'contact.user.patch',
1426
+ GET: 'contact.user.get',
1427
+ DELETE: 'contact.user.delete',
1428
+ PUT: 'contact.user.update',
1339
1429
  },
1340
1430
  '/contact/v3/users/{user_id}/update_user_id': {
1341
- PATCH: 'updateUserIdContactUser',
1431
+ PATCH: 'contact.user.updateUserId',
1342
1432
  },
1343
1433
  '/contact/v3/users/batch': {
1344
- GET: 'batchContactUser',
1434
+ GET: 'contact.user.batch',
1345
1435
  },
1346
1436
  '/contact/v3/users/find_by_department': {
1347
- GET: { name: 'findByDepartmentContactUser', pagination: { argIndex: 0 } },
1437
+ GET: { name: 'contact.user.findByDepartment', pagination: { argIndex: 0 } },
1348
1438
  },
1349
1439
  '/contact/v3/users/batch_get_id': {
1350
- POST: 'batchGetIdContactUser',
1440
+ POST: 'contact.user.batchGetId',
1351
1441
  },
1352
1442
  '/contact/v3/users/{user_id}/resurrect': {
1353
- POST: 'resurrectContactUser',
1443
+ POST: 'contact.user.resurrect',
1354
1444
  },
1355
1445
  '/contact/v3/group': {
1356
- POST: 'createContactGroup',
1446
+ POST: 'contact.group.create',
1357
1447
  },
1358
1448
  '/contact/v3/group/{group_id}': {
1359
- PATCH: 'patchContactGroup',
1360
- GET: 'getContactGroup',
1361
- DELETE: 'deleteContactGroup',
1449
+ PATCH: 'contact.group.patch',
1450
+ GET: 'contact.group.get',
1451
+ DELETE: 'contact.group.delete',
1362
1452
  },
1363
1453
  '/contact/v3/group/simplelist': {
1364
- GET: { name: 'simplelistContactGroup', pagination: { argIndex: 0, itemsKey: 'grouplist' } },
1454
+ GET: { name: 'contact.group.simplelist', pagination: { argIndex: 0, itemsKey: 'grouplist' } },
1365
1455
  },
1366
1456
  '/contact/v3/group/member_belong': {
1367
- GET: { name: 'memberBelongContactGroup', pagination: { argIndex: 0, itemsKey: 'group_list' } },
1457
+ GET: { name: 'contact.group.memberBelong', pagination: { argIndex: 0, itemsKey: 'group_list' } },
1368
1458
  },
1369
1459
  '/contact/v3/custom_attrs': {
1370
- GET: { name: 'listContactCustomAttr', pagination: { argIndex: 0 } },
1460
+ GET: { name: 'contact.customAttr.list', pagination: { argIndex: 0 } },
1371
1461
  },
1372
1462
  '/contact/v3/employee_type_enums': {
1373
- POST: 'createContactEmployeeTypeEnum',
1374
- GET: { name: 'listContactEmployeeTypeEnum', pagination: { argIndex: 0 } },
1463
+ POST: 'contact.employeeTypeEnum.create',
1464
+ GET: { name: 'contact.employeeTypeEnum.list', pagination: { argIndex: 0 } },
1375
1465
  },
1376
1466
  '/contact/v3/employee_type_enums/{enum_id}': {
1377
- PUT: 'updateContactEmployeeTypeEnum',
1378
- DELETE: 'deleteContactEmployeeTypeEnum',
1467
+ PUT: 'contact.employeeTypeEnum.update',
1468
+ DELETE: 'contact.employeeTypeEnum.delete',
1379
1469
  },
1380
1470
  '/contact/v3/departments': {
1381
- POST: 'createContactDepartment',
1382
- GET: { name: 'listContactDepartment', pagination: { argIndex: 0 } },
1471
+ POST: 'contact.department.create',
1472
+ GET: { name: 'contact.department.list', pagination: { argIndex: 0 } },
1383
1473
  },
1384
1474
  '/contact/v3/departments/{department_id}': {
1385
- PATCH: 'patchContactDepartment',
1386
- PUT: 'updateContactDepartment',
1387
- GET: 'getContactDepartment',
1388
- DELETE: 'deleteContactDepartment',
1475
+ PATCH: 'contact.department.patch',
1476
+ PUT: 'contact.department.update',
1477
+ GET: 'contact.department.get',
1478
+ DELETE: 'contact.department.delete',
1389
1479
  },
1390
1480
  '/contact/v3/departments/{department_id}/update_department_id': {
1391
- PATCH: 'updateDepartmentIdContactDepartment',
1481
+ PATCH: 'contact.department.updateDepartmentId',
1392
1482
  },
1393
1483
  '/contact/v3/departments/unbind_department_chat': {
1394
- POST: 'unbindDepartmentChatContactDepartment',
1484
+ POST: 'contact.department.unbindDepartmentChat',
1395
1485
  },
1396
1486
  '/contact/v3/departments/batch': {
1397
- GET: 'batchContactDepartment',
1487
+ GET: 'contact.department.batch',
1398
1488
  },
1399
1489
  '/contact/v3/departments/{department_id}/children': {
1400
- GET: { name: 'childrenContactDepartment', pagination: { argIndex: 1 } },
1490
+ GET: { name: 'contact.department.children', pagination: { argIndex: 1 } },
1401
1491
  },
1402
1492
  '/contact/v3/departments/parent': {
1403
- GET: { name: 'parentContactDepartment', pagination: { argIndex: 0 } },
1493
+ GET: { name: 'contact.department.parent', pagination: { argIndex: 0 } },
1404
1494
  },
1405
1495
  '/contact/v3/departments/search': {
1406
- POST: { name: 'searchContactDepartment', pagination: { argIndex: 1 } },
1496
+ POST: { name: 'contact.department.search', pagination: { argIndex: 1 } },
1407
1497
  },
1408
1498
  '/contact/v3/unit': {
1409
- POST: 'createContactUnit',
1410
- GET: { name: 'listContactUnit', pagination: { argIndex: 0, itemsKey: 'unitlist' } },
1499
+ POST: 'contact.unit.create',
1500
+ GET: { name: 'contact.unit.list', pagination: { argIndex: 0, itemsKey: 'unitlist' } },
1411
1501
  },
1412
1502
  '/contact/v3/unit/{unit_id}': {
1413
- PATCH: 'patchContactUnit',
1414
- GET: 'getContactUnit',
1415
- DELETE: 'deleteContactUnit',
1503
+ PATCH: 'contact.unit.patch',
1504
+ GET: 'contact.unit.get',
1505
+ DELETE: 'contact.unit.delete',
1416
1506
  },
1417
1507
  '/contact/v3/unit/bind_department': {
1418
- POST: 'bindDepartmentContactUnit',
1508
+ POST: 'contact.unit.bindDepartment',
1419
1509
  },
1420
1510
  '/contact/v3/unit/unbind_department': {
1421
- POST: 'unbindDepartmentContactUnit',
1511
+ POST: 'contact.unit.unbindDepartment',
1422
1512
  },
1423
1513
  '/contact/v3/unit/list_department': {
1424
- GET: { name: 'listDepartmentContactUnit', pagination: { argIndex: 0, itemsKey: 'departmentlist' } },
1514
+ GET: { name: 'contact.unit.listDepartment', pagination: { argIndex: 0, itemsKey: 'departmentlist' } },
1425
1515
  },
1426
1516
  '/contact/v3/group/{group_id}/member/add': {
1427
- POST: 'addContactGroupMember',
1517
+ POST: 'contact.group.member.add',
1428
1518
  },
1429
1519
  '/contact/v3/group/{group_id}/member/batch_add': {
1430
- POST: 'batchAddContactGroupMember',
1520
+ POST: 'contact.group.member.batchAdd',
1431
1521
  },
1432
1522
  '/contact/v3/group/{group_id}/member/simplelist': {
1433
- GET: { name: 'simplelistContactGroupMember', pagination: { argIndex: 1, itemsKey: 'memberlist' } },
1523
+ GET: { name: 'contact.group.member.simplelist', pagination: { argIndex: 1, itemsKey: 'memberlist' } },
1434
1524
  },
1435
1525
  '/contact/v3/group/{group_id}/member/remove': {
1436
- POST: 'removeContactGroupMember',
1526
+ POST: 'contact.group.member.remove',
1437
1527
  },
1438
1528
  '/contact/v3/group/{group_id}/member/batch_remove': {
1439
- POST: 'batchRemoveContactGroupMember',
1529
+ POST: 'contact.group.member.batchRemove',
1440
1530
  },
1441
1531
  '/contact/v3/functional_roles': {
1442
- POST: 'createContactFunctionalRole',
1532
+ POST: 'contact.functionalRole.create',
1443
1533
  },
1444
1534
  '/contact/v3/functional_roles/{role_id}': {
1445
- PUT: 'updateContactFunctionalRole',
1446
- DELETE: 'deleteContactFunctionalRole',
1535
+ PUT: 'contact.functionalRole.update',
1536
+ DELETE: 'contact.functionalRole.delete',
1447
1537
  },
1448
1538
  '/contact/v3/functional_roles/{role_id}/members/batch_create': {
1449
- POST: 'batchCreateContactFunctionalRoleMember',
1539
+ POST: 'contact.functionalRole.member.batchCreate',
1450
1540
  },
1451
1541
  '/contact/v3/functional_roles/{role_id}/members/scopes': {
1452
- PATCH: 'scopesContactFunctionalRoleMember',
1542
+ PATCH: 'contact.functionalRole.member.scopes',
1453
1543
  },
1454
1544
  '/contact/v3/functional_roles/{role_id}/members/{member_id}': {
1455
- GET: 'getContactFunctionalRoleMember',
1545
+ GET: 'contact.functionalRole.member.get',
1456
1546
  },
1457
1547
  '/contact/v3/functional_roles/{role_id}/members': {
1458
- GET: { name: 'listContactFunctionalRoleMember', pagination: { argIndex: 1, itemsKey: 'members' } },
1548
+ GET: { name: 'contact.functionalRole.member.list', pagination: { argIndex: 1, itemsKey: 'members' } },
1459
1549
  },
1460
1550
  '/contact/v3/functional_roles/{role_id}/members/batch_delete': {
1461
- PATCH: 'batchDeleteContactFunctionalRoleMember',
1551
+ PATCH: 'contact.functionalRole.member.batchDelete',
1462
1552
  },
1463
1553
  '/contact/v3/job_levels': {
1464
- POST: 'createContactJobLevel',
1465
- GET: { name: 'listContactJobLevel', pagination: { argIndex: 0 } },
1554
+ POST: 'contact.jobLevel.create',
1555
+ GET: { name: 'contact.jobLevel.list', pagination: { argIndex: 0 } },
1466
1556
  },
1467
1557
  '/contact/v3/job_levels/{job_level_id}': {
1468
- PUT: 'updateContactJobLevel',
1469
- GET: 'getContactJobLevel',
1470
- DELETE: 'deleteContactJobLevel',
1558
+ PUT: 'contact.jobLevel.update',
1559
+ GET: 'contact.jobLevel.get',
1560
+ DELETE: 'contact.jobLevel.delete',
1471
1561
  },
1472
1562
  '/contact/v3/job_families': {
1473
- POST: 'createContactJobFamily',
1474
- GET: { name: 'listContactJobFamily', pagination: { argIndex: 0 } },
1563
+ POST: 'contact.jobFamily.create',
1564
+ GET: { name: 'contact.jobFamily.list', pagination: { argIndex: 0 } },
1475
1565
  },
1476
1566
  '/contact/v3/job_families/{job_family_id}': {
1477
- PUT: 'updateContactJobFamily',
1478
- GET: 'getContactJobFamily',
1479
- DELETE: 'deleteContactJobFamily',
1567
+ PUT: 'contact.jobFamily.update',
1568
+ GET: 'contact.jobFamily.get',
1569
+ DELETE: 'contact.jobFamily.delete',
1480
1570
  },
1481
1571
  '/contact/v3/job_titles/{job_title_id}': {
1482
- GET: 'getContactJobTitle',
1572
+ GET: 'contact.jobTitle.get',
1483
1573
  },
1484
1574
  '/contact/v3/job_titles': {
1485
- GET: { name: 'listContactJobTitle', pagination: { argIndex: 0 } },
1575
+ GET: { name: 'contact.jobTitle.list', pagination: { argIndex: 0 } },
1486
1576
  },
1487
1577
  '/contact/v3/work_cities/{work_city_id}': {
1488
- GET: 'getContactWorkCity',
1578
+ GET: 'contact.workCity.get',
1489
1579
  },
1490
1580
  '/contact/v3/work_cities': {
1491
- GET: { name: 'listContactWorkCity', pagination: { argIndex: 0 } },
1581
+ GET: { name: 'contact.workCity.list', pagination: { argIndex: 0 } },
1492
1582
  },
1493
1583
  })