@satorijs/adapter-lark 3.11.8 → 3.12.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (68) hide show
  1. package/lib/bot.d.ts +5 -5
  2. package/lib/http.d.ts +6 -3
  3. package/lib/index.cjs +634 -261
  4. package/lib/types/acs.d.ts +4 -1
  5. package/lib/types/aily.d.ts +3 -3
  6. package/lib/types/apaas.d.ts +190 -28
  7. package/lib/types/application.d.ts +20 -4
  8. package/lib/types/approval.d.ts +0 -13
  9. package/lib/types/attendance.d.ts +11 -5
  10. package/lib/types/authen.d.ts +8 -2
  11. package/lib/types/bitable.d.ts +25 -4
  12. package/lib/types/board.d.ts +56 -0
  13. package/lib/types/calendar.d.ts +71 -5
  14. package/lib/types/cardkit.d.ts +2 -2
  15. package/lib/types/compensation.d.ts +400 -0
  16. package/lib/types/contact.d.ts +55 -12
  17. package/lib/types/corehr.d.ts +1287 -79
  18. package/lib/types/directory.d.ts +3 -41
  19. package/lib/types/docx.d.ts +23 -0
  20. package/lib/types/drive.d.ts +107 -90
  21. package/lib/types/ehr.d.ts +11 -2
  22. package/lib/types/helpdesk.d.ts +15 -6
  23. package/lib/types/hire.d.ts +52 -3
  24. package/lib/types/human_authentication.d.ts +1 -1
  25. package/lib/types/im.d.ts +77 -21
  26. package/lib/types/index.d.ts +1670 -105
  27. package/lib/types/mail.d.ts +106 -16
  28. package/lib/types/payroll.d.ts +117 -81
  29. package/lib/types/performance.d.ts +1 -1
  30. package/lib/types/search.d.ts +4 -1
  31. package/lib/types/security_and_compliance.d.ts +254 -1
  32. package/lib/ws.d.ts +30 -0
  33. package/package.json +6 -3
  34. package/src/bot.ts +28 -15
  35. package/src/http.ts +10 -4
  36. package/src/types/acs.ts +4 -1
  37. package/src/types/aily.ts +3 -3
  38. package/src/types/apaas.ts +237 -38
  39. package/src/types/application.ts +20 -4
  40. package/src/types/approval.ts +0 -15
  41. package/src/types/attendance.ts +11 -5
  42. package/src/types/authen.ts +8 -2
  43. package/src/types/bitable.ts +25 -4
  44. package/src/types/board.ts +75 -2
  45. package/src/types/calendar.ts +88 -5
  46. package/src/types/cardkit.ts +2 -2
  47. package/src/types/compensation.ts +485 -0
  48. package/src/types/contact.ts +55 -12
  49. package/src/types/corehr.ts +1480 -123
  50. package/src/types/directory.ts +3 -53
  51. package/src/types/docx.ts +29 -0
  52. package/src/types/drive.ts +129 -112
  53. package/src/types/ehr.ts +11 -2
  54. package/src/types/helpdesk.ts +15 -6
  55. package/src/types/hire.ts +66 -3
  56. package/src/types/human_authentication.ts +1 -1
  57. package/src/types/im.ts +77 -21
  58. package/src/types/index.ts +1751 -107
  59. package/src/types/mail.ts +106 -16
  60. package/src/types/payroll.ts +146 -103
  61. package/src/types/performance.ts +1 -1
  62. package/src/types/search.ts +4 -1
  63. package/src/types/security_and_compliance.ts +292 -1
  64. package/src/ws.ts +183 -0
  65. package/lib/types/api.d.ts +0 -28510
  66. package/lib/types/internal.d.ts +0 -21
  67. package/lib/types/message/content.d.ts +0 -433
  68. package/lib/types/message/index.d.ts +0 -95
@@ -24,7 +24,7 @@ export namespace Directory {
24
24
  */
25
25
  create(body: CreateRequest, query?: CreateQuery): Promise<CreateResponse>
26
26
  /**
27
- * 更新员工
27
+ * 更新员工信息
28
28
  * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/directory-v1/employee/patch
29
29
  */
30
30
  patch(employee_id: string, body: PatchRequest, query?: PatchQuery): Promise<void>
@@ -59,15 +59,10 @@ export namespace Directory {
59
59
  */
60
60
  filter(body: FilterRequest, query?: FilterQuery): Promise<FilterResponse>
61
61
  /**
62
- * 搜索员工
62
+ * 搜索员工信息
63
63
  * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/directory-v1/employee/search
64
64
  */
65
65
  search(body: SearchRequest, query?: SearchQuery): Promise<SearchResponse>
66
- /**
67
- * 转换员工 ID
68
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/directory-v1/employee/idconvert
69
- */
70
- idconvert(body: IdconvertRequest, query?: IdconvertQuery): Promise<IdconvertResponse>
71
66
  }
72
67
 
73
68
  export interface CreateRequest {
@@ -214,23 +209,6 @@ export namespace Directory {
214
209
  /** 字段异常信息 */
215
210
  abnormals?: Lark.AbnormalRecord[]
216
211
  }
217
-
218
- export interface IdconvertRequest {
219
- /** 用户ID列表 */
220
- employee_ids: string[]
221
- }
222
-
223
- export interface IdconvertQuery {
224
- /** 员工ID类型 */
225
- employee_id_type?: 'open_id' | 'union_id' | 'employee_id'
226
- }
227
-
228
- export interface IdconvertResponse {
229
- /** id转换结果列表 */
230
- id_convert_results?: Lark.EmployeeIdConvertResult[]
231
- /** 异常信息列表 */
232
- abnormals?: Lark.AbnormalRecord[]
233
- }
234
212
  }
235
213
 
236
214
  export namespace Department {
@@ -256,7 +234,7 @@ export namespace Directory {
256
234
  */
257
235
  mget(body: MgetRequest, query?: MgetQuery): Promise<MgetResponse>
258
236
  /**
259
- * 批量获取部门列表
237
+ * 获取部门列表
260
238
  * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/directory-v1/department/filter
261
239
  */
262
240
  filter(body: FilterRequest, query?: FilterQuery): Promise<FilterResponse>
@@ -265,11 +243,6 @@ export namespace Directory {
265
243
  * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/directory-v1/department/search
266
244
  */
267
245
  search(body: SearchRequest, query?: SearchQuery): Promise<SearchResponse>
268
- /**
269
- * 转换部门 ID
270
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/directory-v1/department/idconvert
271
- */
272
- idconvert(body: IdconvertRequest, query?: IdconvertQuery): Promise<IdconvertResponse>
273
246
  }
274
247
 
275
248
  export interface CreateRequest {
@@ -376,23 +349,6 @@ export namespace Directory {
376
349
  /** 字段异常信息 */
377
350
  abnormals?: Lark.AbnormalRecord[]
378
351
  }
379
-
380
- export interface IdconvertRequest {
381
- /** 部门ID列表 */
382
- department_ids: string[]
383
- }
384
-
385
- export interface IdconvertQuery {
386
- /** 部门ID类型 */
387
- department_id_type?: 'department_id' | 'open_department_id'
388
- }
389
-
390
- export interface IdconvertResponse {
391
- /** id转换结果列表 */
392
- id_convert_results?: Lark.DepartmentIdConvertResult[]
393
- /** 异常信息列表 */
394
- abnormals?: Lark.AbnormalRecord[]
395
- }
396
352
  }
397
353
 
398
354
  export namespace CollborationShareEntity {
@@ -530,9 +486,6 @@ Internal.define({
530
486
  '/directory/v1/employees/search': {
531
487
  POST: 'directory.employee.search',
532
488
  },
533
- '/directory/v1/employees/idconvert': {
534
- POST: 'directory.employee.idconvert',
535
- },
536
489
  '/directory/v1/departments': {
537
490
  POST: 'directory.department.create',
538
491
  },
@@ -549,9 +502,6 @@ Internal.define({
549
502
  '/directory/v1/departments/search': {
550
503
  POST: 'directory.department.search',
551
504
  },
552
- '/directory/v1/departments/idconvert': {
553
- POST: 'directory.department.idconvert',
554
- },
555
505
  '/directory/v1/share_entities': {
556
506
  GET: 'directory.collborationShareEntity.list',
557
507
  },
package/src/types/docx.ts CHANGED
@@ -208,6 +208,11 @@ export namespace Docx {
208
208
  * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/document/raw_content
209
209
  */
210
210
  rawContent(document_id: string, query?: RawContentQuery): Promise<RawContentResponse>
211
+ /**
212
+ * Markdown/HTML 内容转换为文档块
213
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/document-docx/docx-v1/document/convert
214
+ */
215
+ convert(body: ConvertRequest, query?: ConvertQuery): Promise<ConvertResponse>
211
216
  }
212
217
 
213
218
  export interface CreateRequest {
@@ -246,6 +251,27 @@ export namespace Docx {
246
251
  content?: string
247
252
  }
248
253
 
254
+ export interface ConvertRequest {
255
+ /** 内容类型 */
256
+ content_type: 'markdown' | 'html'
257
+ /** 文本内容 */
258
+ content: string
259
+ }
260
+
261
+ export interface ConvertQuery {
262
+ /** 此次调用中使用的用户ID的类型 */
263
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
264
+ }
265
+
266
+ export interface ConvertResponse {
267
+ /** 第一级 Block 对应的临时 ID 列表, index 代表了 Block 的顺序 */
268
+ first_level_block_ids?: string[]
269
+ /** 带有父子关系的 Block 列表 */
270
+ blocks?: Lark.Block[]
271
+ /** 如果要转换的内容中带有图片,这里记录了临时 Block ID 和 Image URL 的对应关系 */
272
+ block_id_to_image_urls?: Lark.BlockIdToImageUrl[]
273
+ }
274
+
249
275
  export namespace Block {
250
276
  export interface Methods {
251
277
  children: Children.Methods
@@ -531,4 +557,7 @@ Internal.define({
531
557
  '/docx/v1/documents/{document_id}/blocks/{block_id}/children/batch_delete': {
532
558
  DELETE: 'docx.document.block.children.batchDelete',
533
559
  },
560
+ '/docx/v1/documents/blocks/convert': {
561
+ POST: 'docx.document.convert',
562
+ },
534
563
  })
@@ -211,7 +211,10 @@ export namespace Drive {
211
211
  file_name: string
212
212
  /** 上传点类型。 */
213
213
  parent_type: 'explorer'
214
- /** 文件夹token,获取方式见 [概述](/ssl:ttdoc/ukTMukTMukTM/uUDN04SN0QjL1QDN/files/guide/introduction) */
214
+ /**
215
+ * 文件夹token,
216
+ * 获取方式见 [概述](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/files/guide/introduction)
217
+ */
215
218
  parent_node: string
216
219
  /** 文件大小(以字节为单位)。 */
217
220
  size: number
@@ -958,104 +961,41 @@ export namespace Drive {
958
961
 
959
962
  export namespace Member {
960
963
  export interface Methods {
964
+ /**
965
+ * 增加协作者权限
966
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-member/create
967
+ */
968
+ create(token: string, body: CreateRequest, query?: CreateQuery): Promise<CreateResponse>
961
969
  /**
962
970
  * 批量增加协作者权限
963
971
  * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-member/batch_create
964
972
  */
965
973
  batchCreate(token: string, body: BatchCreateRequest, query?: BatchCreateQuery): Promise<BatchCreateResponse>
966
974
  /**
967
- * 转移所有者
968
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-member/transfer_owner
969
- */
970
- transferOwner(token: string, body: TransferOwnerRequest, query?: TransferOwnerQuery): Promise<void>
971
- /**
972
- * 判断当前用户是否有某权限
973
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-member/auth
975
+ * 更新协作者权限
976
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-member/update
974
977
  */
975
- auth(token: string, query?: AuthQuery): Promise<AuthResponse>
978
+ update(token: string, member_id: string, body: UpdateRequest, query?: UpdateQuery): Promise<UpdateResponse>
976
979
  /**
977
- * 获取协作者列表
980
+ * 获取云文档协作者
978
981
  * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-member/list
979
982
  */
980
983
  list(token: string, query?: ListQuery): Promise<ListResponse>
981
984
  /**
982
- * 增加协作者权限
983
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-member/create
985
+ * 移除云文档协作者权限
986
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-member/delete
984
987
  */
985
- create(token: string, body: CreateRequest, query?: CreateQuery): Promise<CreateResponse>
988
+ delete(token: string, member_id: string, body: DeleteRequest, query?: DeleteQuery): Promise<void>
986
989
  /**
987
- * 更新协作者权限
988
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-member/update
990
+ * 转移云文档所有者
991
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-member/transfer_owner
989
992
  */
990
- update(token: string, member_id: string, body: UpdateRequest, query?: UpdateQuery): Promise<UpdateResponse>
993
+ transferOwner(token: string, body: TransferOwnerRequest, query?: TransferOwnerQuery): Promise<void>
991
994
  /**
992
- * 移除协作者权限
993
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-member/delete
995
+ * 判断用户云文档权限
996
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-member/auth
994
997
  */
995
- delete(token: string, member_id: string, body: DeleteRequest, query?: DeleteQuery): Promise<void>
996
- }
997
-
998
- export interface BatchCreateRequest {
999
- /** 协作者列表 */
1000
- members: Lark.BaseMember[]
1001
- }
1002
-
1003
- export interface BatchCreateQuery {
1004
- /** 文件的类型 */
1005
- type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'folder' | 'mindnote' | 'minutes' | 'slides'
1006
- /** 添加权限后是否通知对方 */
1007
- need_notification?: boolean
1008
- }
1009
-
1010
- export interface BatchCreateResponse {
1011
- /** 协作者列表 */
1012
- members?: Lark.BaseMember[]
1013
- }
1014
-
1015
- export interface TransferOwnerRequest {
1016
- /** 文档拥有者的ID类型 */
1017
- member_type: 'email' | 'openid' | 'userid'
1018
- /** 文档拥有者的ID,与文档拥有者的ID类型需要对应 */
1019
- member_id: string
1020
- }
1021
-
1022
- export interface TransferOwnerQuery {
1023
- /** 文件类型,需要与文件的 token 相匹配 */
1024
- type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'mindnote' | 'minutes' | 'slides' | 'folder'
1025
- /** 是否需要通知新 Owner */
1026
- need_notification?: boolean
1027
- /** 转移后是否需要移除原 Owner 的权限 */
1028
- remove_old_owner?: boolean
1029
- /** 仅当内容不在共享文件夹中,此参数才会生效。如果设为false,系统会将该内容移至新所有者的个人空间根文件夹。如果设为 true,则留在原位置。 */
1030
- stay_put?: boolean
1031
- /** 仅当 remove_old_owner = false 时,此参数才会生效 保留原文件所有者指定的权限角色 */
1032
- old_owner_perm?: string
1033
- }
1034
-
1035
- export interface AuthQuery {
1036
- /** 文件类型,需要与文件的 token 相匹配 */
1037
- type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'mindnote' | 'minutes' | 'slides'
1038
- /** 需要判断的权限 */
1039
- action: 'view' | 'edit' | 'share' | 'comment' | 'export' | 'copy' | 'print' | 'manage_public'
1040
- }
1041
-
1042
- export interface AuthResponse {
1043
- /** 是否有权限 */
1044
- auth_result: boolean
1045
- }
1046
-
1047
- export interface ListQuery {
1048
- /** 文件类型,需要与文件的 token 相匹配 */
1049
- type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'mindnote' | 'minutes' | 'slides'
1050
- /** 指定返回的协作者字段信息,如无指定则默认不返回**可选值有:** - `name`:协作者名- `type`:协作者类型- `avatar`:头像- `external_label`:外部标签**注意:** - 你可以使用特殊值`*`指定返回目前支持的所有字段- 你可以使用`,`分隔若干个你想指定返回的字段,如:`name,avatar`- 按需指定返回字段接口性能更好 */
1051
- fields?: string
1052
- /** 协作者的权限角色类型 */
1053
- perm_type?: 'container' | 'single_page'
1054
- }
1055
-
1056
- export interface ListResponse {
1057
- /** 返回的列表数据 */
1058
- items?: Lark.Member[]
998
+ auth(token: string, query?: AuthQuery): Promise<AuthResponse>
1059
999
  }
1060
1000
 
1061
1001
  export interface CreateRequest {
@@ -1083,6 +1023,23 @@ export namespace Drive {
1083
1023
  member?: Lark.BaseMember
1084
1024
  }
1085
1025
 
1026
+ export interface BatchCreateRequest {
1027
+ /** 协作者列表 */
1028
+ members: Lark.BaseMember[]
1029
+ }
1030
+
1031
+ export interface BatchCreateQuery {
1032
+ /** 文件的类型 */
1033
+ type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'folder' | 'mindnote' | 'minutes' | 'slides'
1034
+ /** 添加权限后是否通知对方 */
1035
+ need_notification?: boolean
1036
+ }
1037
+
1038
+ export interface BatchCreateResponse {
1039
+ /** 协作者列表 */
1040
+ members?: Lark.BaseMember[]
1041
+ }
1042
+
1086
1043
  export interface UpdateRequest {
1087
1044
  /** 协作者ID类型 */
1088
1045
  member_type: 'email' | 'openid' | 'unionid' | 'openchat' | 'opendepartmentid' | 'userid' | 'groupid' | 'wikispaceid'
@@ -1095,7 +1052,10 @@ export namespace Drive {
1095
1052
  }
1096
1053
 
1097
1054
  export interface UpdateQuery {
1098
- /** 更新权限后是否通知对方**注意:** 使用`tenant_access_token`访问不支持该参数 */
1055
+ /**
1056
+ * 更新权限后是否通知对方
1057
+ * **注意:** 使用`tenant_access_token`访问不支持该参数
1058
+ */
1099
1059
  need_notification?: boolean
1100
1060
  /** 文件类型,放于query参数中,如:`?type=doc` */
1101
1061
  type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'mindnote' | 'minutes' | 'slides'
@@ -1106,6 +1066,31 @@ export namespace Drive {
1106
1066
  member?: Lark.BaseMember
1107
1067
  }
1108
1068
 
1069
+ export interface ListQuery {
1070
+ /** 文件类型,需要与文件的 token 相匹配 */
1071
+ type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'mindnote' | 'minutes' | 'slides'
1072
+ /**
1073
+ * 指定返回的协作者字段信息,如无指定则默认不返回
1074
+ * **可选值有:**
1075
+ * - `name`:协作者名
1076
+ * - `type`:协作者类型
1077
+ * - `avatar`:头像
1078
+ * - `external_label`:外部标签
1079
+ * **注意:**
1080
+ * - 你可以使用特殊值`*`指定返回目前支持的所有字段
1081
+ * - 你可以使用`,`分隔若干个你想指定返回的字段,如:`name,avatar`
1082
+ * - 按需指定返回字段接口性能更好
1083
+ */
1084
+ fields?: string
1085
+ /** 协作者的权限角色类型 */
1086
+ perm_type?: 'container' | 'single_page'
1087
+ }
1088
+
1089
+ export interface ListResponse {
1090
+ /** 返回的列表数据 */
1091
+ items?: Lark.Member[]
1092
+ }
1093
+
1109
1094
  export interface DeleteRequest {
1110
1095
  /** 协作者类型 */
1111
1096
  type?: 'user' | 'chat' | 'department' | 'group' | 'wiki_space_member' | 'wiki_space_viewer' | 'wiki_space_editor'
@@ -1119,31 +1104,53 @@ export namespace Drive {
1119
1104
  /** 权限成员类型,放于query参数中,如:`?member_type=openid` */
1120
1105
  member_type: 'email' | 'openid' | 'openchat' | 'opendepartmentid' | 'userid' | 'unionid' | 'groupid' | 'wikispaceid'
1121
1106
  }
1107
+
1108
+ export interface TransferOwnerRequest {
1109
+ /** 文档拥有者的ID类型 */
1110
+ member_type: 'email' | 'openid' | 'userid'
1111
+ /** 文档拥有者的ID,与文档拥有者的ID类型需要对应 */
1112
+ member_id: string
1113
+ }
1114
+
1115
+ export interface TransferOwnerQuery {
1116
+ /** 文件类型,需要与文件的 token 相匹配 */
1117
+ type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'mindnote' | 'minutes' | 'slides' | 'folder'
1118
+ /** 是否需要通知新 Owner */
1119
+ need_notification?: boolean
1120
+ /** 转移后是否需要移除原 Owner 的权限 */
1121
+ remove_old_owner?: boolean
1122
+ /** 仅当内容不在共享文件夹中,此参数才会生效。如果设为false,系统会将该内容移至新所有者的个人空间根文件夹。如果设为 true,则留在原位置。 */
1123
+ stay_put?: boolean
1124
+ /** 仅当 remove_old_owner = false 时,此参数才会生效 保留原文件所有者指定的权限角色 */
1125
+ old_owner_perm?: string
1126
+ }
1127
+
1128
+ export interface AuthQuery {
1129
+ /** 文件类型,需要与文件的 token 相匹配 */
1130
+ type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'mindnote' | 'minutes' | 'slides'
1131
+ /** 需要判断的权限 */
1132
+ action: 'view' | 'edit' | 'share' | 'comment' | 'export' | 'copy' | 'print' | 'manage_public'
1133
+ }
1134
+
1135
+ export interface AuthResponse {
1136
+ /** 是否有权限 */
1137
+ auth_result: boolean
1138
+ }
1122
1139
  }
1123
1140
 
1124
1141
  export namespace Public {
1125
1142
  export interface Methods {
1126
1143
  password: Password.Methods
1127
- /**
1128
- * 获取云文档权限设置
1129
- * @see https://open.feishu.cn/document/ukTMukTMukTM/uIzNzUjLyczM14iM3MTN/drive-v2/permission-public/get
1130
- */
1131
- get(token: string, query?: GetQuery): Promise<GetResponse>
1132
1144
  /**
1133
1145
  * 更新云文档权限设置
1134
1146
  * @see https://open.feishu.cn/document/ukTMukTMukTM/uIzNzUjLyczM14iM3MTN/drive-v2/permission-public/patch
1135
1147
  */
1136
1148
  patch(token: string, body: PatchRequest, query?: PatchQuery): Promise<PatchResponse>
1137
- }
1138
-
1139
- export interface GetQuery {
1140
- /** 文件类型,需要与文件的 token 相匹配 */
1141
- type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'mindnote' | 'minutes' | 'slides'
1142
- }
1143
-
1144
- export interface GetResponse {
1145
- /** 返回的文档公共设置 */
1146
- permission_public?: Lark.PermissionPublic
1149
+ /**
1150
+ * 获取云文档权限设置
1151
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/uIzNzUjLyczM14iM3MTN/drive-v2/permission-public/get
1152
+ */
1153
+ get(token: string, query?: GetQuery): Promise<GetResponse>
1147
1154
  }
1148
1155
 
1149
1156
  export interface PatchRequest {
@@ -1173,20 +1180,30 @@ export namespace Drive {
1173
1180
  permission_public?: Lark.PermissionPublic
1174
1181
  }
1175
1182
 
1183
+ export interface GetQuery {
1184
+ /** 文件类型,需要与文件的 token 相匹配 */
1185
+ type: 'doc' | 'sheet' | 'file' | 'wiki' | 'bitable' | 'docx' | 'mindnote' | 'minutes' | 'slides'
1186
+ }
1187
+
1188
+ export interface GetResponse {
1189
+ /** 返回的文档公共设置 */
1190
+ permission_public?: Lark.PermissionPublic
1191
+ }
1192
+
1176
1193
  export namespace Password {
1177
1194
  export interface Methods {
1178
1195
  /**
1179
- * 开启密码
1196
+ * 启用云文档密码
1180
1197
  * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-public-password/create
1181
1198
  */
1182
1199
  create(token: string, query?: CreateQuery): Promise<CreateResponse>
1183
1200
  /**
1184
- * 刷新密码
1201
+ * 刷新云文档密码
1185
1202
  * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-public-password/update
1186
1203
  */
1187
1204
  update(token: string, query?: UpdateQuery): Promise<UpdateResponse>
1188
1205
  /**
1189
- * 关闭密码
1206
+ * 停用云文档密码
1190
1207
  * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-public-password/delete
1191
1208
  */
1192
1209
  delete(token: string, query?: DeleteQuery): Promise<void>
@@ -1320,32 +1337,32 @@ Internal.define({
1320
1337
  '/drive/v1/files/{file_token}/delete_subscribe': {
1321
1338
  DELETE: 'drive.file.deleteSubscribe',
1322
1339
  },
1340
+ '/drive/v1/permissions/{token}/members': {
1341
+ POST: 'drive.permission.member.create',
1342
+ GET: 'drive.permission.member.list',
1343
+ },
1323
1344
  '/drive/v1/permissions/{token}/members/batch_create': {
1324
1345
  POST: 'drive.permission.member.batchCreate',
1325
1346
  },
1347
+ '/drive/v1/permissions/{token}/members/{member_id}': {
1348
+ PUT: 'drive.permission.member.update',
1349
+ DELETE: 'drive.permission.member.delete',
1350
+ },
1326
1351
  '/drive/v1/permissions/{token}/members/transfer_owner': {
1327
1352
  POST: 'drive.permission.member.transferOwner',
1328
1353
  },
1329
1354
  '/drive/v1/permissions/{token}/members/auth': {
1330
1355
  GET: 'drive.permission.member.auth',
1331
1356
  },
1332
- '/drive/v1/permissions/{token}/members': {
1333
- GET: 'drive.permission.member.list',
1334
- POST: 'drive.permission.member.create',
1335
- },
1336
- '/drive/v1/permissions/{token}/members/{member_id}': {
1337
- PUT: 'drive.permission.member.update',
1338
- DELETE: 'drive.permission.member.delete',
1357
+ '/drive/v2/permissions/{token}/public': {
1358
+ PATCH: 'drive.permission.public.patch',
1359
+ GET: 'drive.permission.public.get',
1339
1360
  },
1340
1361
  '/drive/v1/permissions/{token}/public/password': {
1341
1362
  POST: 'drive.permission.public.password.create',
1342
1363
  PUT: 'drive.permission.public.password.update',
1343
1364
  DELETE: 'drive.permission.public.password.delete',
1344
1365
  },
1345
- '/drive/v2/permissions/{token}/public': {
1346
- GET: 'drive.permission.public.get',
1347
- PATCH: 'drive.permission.public.patch',
1348
- },
1349
1366
  '/drive/v1/files/{file_token}/comments': {
1350
1367
  GET: { name: 'drive.file.comment.list', pagination: { argIndex: 1 } },
1351
1368
  POST: 'drive.file.comment.create',
package/src/types/ehr.ts CHANGED
@@ -51,7 +51,11 @@ export namespace Ehr {
51
51
  export interface ListQuery extends Pagination {
52
52
  /** 返回数据类型 */
53
53
  view?: 'basic' | 'full'
54
- /** 员工状态,不传代表查询所有员工状态实际在职 = 2&4可同时查询多个状态的记录,如 status=2&status=4 */
54
+ /**
55
+ * 员工状态,不传代表查询所有员工状态
56
+ * 实际在职 = 2&4
57
+ * 可同时查询多个状态的记录,如 status=2&status=4
58
+ */
55
59
  status?: ListQueryStatus[]
56
60
  /** 雇员类型,不传代表查询所有雇员类型 */
57
61
  type?: ListQueryType[]
@@ -61,7 +65,12 @@ export namespace Ehr {
61
65
  end_time?: string
62
66
  /** 此次调用中使用的用户ID的类型 */
63
67
  user_id_type?: 'user_id' | 'union_id' | 'open_id'
64
- /** user_id、open_id 或 union_id,默认为 open_id。如果传入的值不是 open_id,需要一并传入 user_id_type 参数。可一次查询多个 id 的用户,例如:user_ids=ou_8ebd4f35d7101ffdeb4771d7c8ec517e&user_ids=ou_7abc4f35d7101ffdeb4771dabcde[用户相关的 ID 概念](/ssl:ttdoc/home/user-identity-introduction/introduction) */
68
+ /**
69
+ * user_id、open_id 或 union_id,默认为 open_id。
70
+ * 如果传入的值不是 open_id,需要一并传入 user_id_type 参数。
71
+ * 可一次查询多个 id 的用户,例如:user_ids=ou_8ebd4f35d7101ffdeb4771d7c8ec517e&user_ids=ou_7abc4f35d7101ffdeb4771dabcde
72
+ * [用户相关的 ID 概念](https://open.feishu.cn/document/home/user-identity-introduction/introduction)
73
+ */
65
74
  user_ids?: string[]
66
75
  }
67
76
  }
@@ -224,11 +224,11 @@ export namespace Helpdesk {
224
224
  export interface StartServiceRequest {
225
225
  /** 是否直接进入人工(若appointed_agents填写了,该值为必填) */
226
226
  human_service?: boolean
227
- /** 客服 open ids (获取方式参考[获取单个用户信息](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/get)),human_service需要为true */
227
+ /** 客服 open ids (获取方式参考[获取单个用户信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/get)),human_service需要为true */
228
228
  appointed_agents?: string[]
229
- /** 用户 open id,(获取方式参考[获取单个用户信息](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/get)) */
229
+ /** 用户 open id,(获取方式参考[获取单个用户信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/get)) */
230
230
  open_id: string
231
- /** 工单来源自定义信息,长度限制1024字符,如设置,[获取工单详情](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/ticket/get)会返回此信息 */
231
+ /** 工单来源自定义信息,长度限制1024字符,如设置,[获取工单详情](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/ticket/get)会返回此信息 */
232
232
  customized_info?: string
233
233
  }
234
234
 
@@ -305,7 +305,10 @@ export namespace Helpdesk {
305
305
  export interface TicketImageQuery {
306
306
  /** 工单ID */
307
307
  ticket_id: string
308
- /** 消息ID[查询消息ID](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/ticket-message/list) */
308
+ /**
309
+ * 消息ID
310
+ * [查询消息ID](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/helpdesk-v1/ticket-message/list)
311
+ */
309
312
  msg_id: string
310
313
  /** index,当消息类型为post时,需指定图片index,index从0开始。当消息类型为img时,无需index */
311
314
  index?: number
@@ -347,7 +350,10 @@ export namespace Helpdesk {
347
350
  export interface CreateRequest {
348
351
  /** 消息类型;text:纯文本;post:富文本 */
349
352
  msg_type: string
350
- /** - 纯文本,参考[发送文本消息](/ssl:ttdoc/ukTMukTMukTM/uUjNz4SN2MjL1YzM)中的content;- 富文本,参考[发送富文本消息](/ssl:ttdoc/ukTMukTMukTM/uMDMxEjLzATMx4yMwETM)中的content */
353
+ /**
354
+ * - 纯文本,参考[发送文本消息](https://open.feishu.cn/document/ukTMukTMukTM/uUjNz4SN2MjL1YzM)中的content;
355
+ * - 富文本,参考[发送富文本消息](https://open.feishu.cn/document/ukTMukTMukTM/uMDMxEjLzATMx4yMwETM)中的content
356
+ */
351
357
  content: string
352
358
  }
353
359
 
@@ -606,7 +612,10 @@ export namespace Helpdesk {
606
612
  }
607
613
 
608
614
  export interface SearchQuery extends Pagination {
609
- /** 搜索query,query内容如果不是英文,包含中文空格等有两种编码策略:1. url编码 2. base64编码,同时加上base64=true参数 */
615
+ /**
616
+ * 搜索query
617
+ * ,query内容如果不是英文,包含中文空格等有两种编码策略:1. url编码 2. base64编码,同时加上base64=true参数
618
+ */
610
619
  query: string
611
620
  /** 是否转换为base64,输入true表示是,不填写表示否,中文需要转换为base64 */
612
621
  base64?: string