@larksuiteoapi/node-sdk 1.3.0 → 1.4.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.
package/es/index.js CHANGED
@@ -1044,7 +1044,7 @@ class Client$1 {
1044
1044
  }),
1045
1045
  },
1046
1046
  /**
1047
- * 应用
1047
+ * 事件
1048
1048
  */
1049
1049
  applicationAppVersion: {
1050
1050
  /**
@@ -1122,9 +1122,11 @@ class Client$1 {
1122
1122
  /**
1123
1123
  * {@link https://open.feishu.cn/api-explorer?project=application&resource=application.app_version&apiName=list&version=v6 click to debug }
1124
1124
  *
1125
- * {@link https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=list&project=application&resource=application.app_version&version=v6 document }
1125
+ * {@link https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application-app_version/list document }
1126
1126
  *
1127
1127
  * 获取应用版本列表
1128
+ *
1129
+ * 根据 app_id 获取对应应用版本列表。
1128
1130
  */
1129
1131
  list: (payload, options) => __awaiter(this, void 0, void 0, function* () {
1130
1132
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -1350,7 +1352,7 @@ class Client$1 {
1350
1352
  */
1351
1353
  this.approval = {
1352
1354
  /**
1353
- * 审批定义
1355
+ * 原生审批定义
1354
1356
  */
1355
1357
  approval: {
1356
1358
  /**
@@ -1454,7 +1456,11 @@ class Client$1 {
1454
1456
  /**
1455
1457
  * {@link https://open.feishu.cn/api-explorer?project=approval&resource=approval&apiName=list&version=v4 click to debug }
1456
1458
  *
1457
- * {@link https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=list&project=approval&resource=approval&version=v4 document }
1459
+ * {@link https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/approval/list document }
1460
+ *
1461
+ * 查询审批定义列表
1462
+ *
1463
+ * 查询当前用户可发起的审批定义列表。
1458
1464
  */
1459
1465
  list: (payload, options) => __awaiter(this, void 0, void 0, function* () {
1460
1466
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -1682,13 +1688,13 @@ class Client$1 {
1682
1688
  }),
1683
1689
  },
1684
1690
  /**
1685
- * 审批实例
1691
+ * 原生审批实例
1686
1692
  */
1687
1693
  instance: {
1688
1694
  /**
1689
1695
  * {@link https://open.feishu.cn/api-explorer?project=approval&resource=instance&apiName=add_sign&version=v4 click to debug }
1690
1696
  *
1691
- * {@link https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=add_sign&project=approval&resource=instance&version=v4 document }
1697
+ * {@link https://open.feishu.cn/document/ukTMukTMukTM/ukTM5UjL5ETO14SOxkTN/approval-task-addsign document }
1692
1698
  */
1693
1699
  addSign: (payload, options) => __awaiter(this, void 0, void 0, function* () {
1694
1700
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -1876,7 +1882,7 @@ class Client$1 {
1876
1882
  /**
1877
1883
  * {@link https://open.feishu.cn/api-explorer?project=approval&resource=instance&apiName=preview&version=v4 click to debug }
1878
1884
  *
1879
- * {@link https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=preview&project=approval&resource=instance&version=v4 document }
1885
+ * {@link https://open.feishu.cn/document/ukTMukTMukTM/ukTM5UjL5ETO14SOxkTN/approval-preview document }
1880
1886
  */
1881
1887
  preview: (payload, options) => __awaiter(this, void 0, void 0, function* () {
1882
1888
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -1946,7 +1952,7 @@ class Client$1 {
1946
1952
  *
1947
1953
  * {@link https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/query document }
1948
1954
  *
1949
- * 实例列表查询
1955
+ * 查询实例列表
1950
1956
  *
1951
1957
  * 该接口通过不同条件查询审批系统中符合条件的审批实例列表。
1952
1958
  */
@@ -1970,7 +1976,7 @@ class Client$1 {
1970
1976
  *
1971
1977
  * {@link https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/search_cc document }
1972
1978
  *
1973
- * 抄送列表查询接口
1979
+ * 查询抄送列表
1974
1980
  *
1975
1981
  * 该接口通过不同条件查询审批系统中符合条件的审批抄送列表。
1976
1982
  */
@@ -2015,7 +2021,7 @@ class Client$1 {
2015
2021
  }),
2016
2022
  },
2017
2023
  /**
2018
- * 评论
2024
+ * 原生审批评论
2019
2025
  */
2020
2026
  instanceComment: {
2021
2027
  /**
@@ -2164,7 +2170,7 @@ class Client$1 {
2164
2170
  }),
2165
2171
  },
2166
2172
  /**
2167
- * 审批任务
2173
+ * 审批查询
2168
2174
  */
2169
2175
  task: {
2170
2176
  /**
@@ -2316,7 +2322,7 @@ class Client$1 {
2316
2322
  *
2317
2323
  * {@link https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/task/search document }
2318
2324
  *
2319
- * 任务列表查询
2325
+ * 查询任务列表
2320
2326
  *
2321
2327
  * 该接口通过不同条件查询审批系统中符合条件的审批任务列表
2322
2328
  */
@@ -2366,7 +2372,7 @@ class Client$1 {
2366
2372
  */
2367
2373
  this.attendance = {
2368
2374
  /**
2369
- * 假勤审批
2375
+ * approval_info
2370
2376
  */
2371
2377
  approvalInfo: {
2372
2378
  /**
@@ -2928,7 +2934,7 @@ class Client$1 {
2928
2934
  }),
2929
2935
  },
2930
2936
  /**
2931
- * 考勤记录
2937
+ * user_flow
2932
2938
  */
2933
2939
  userFlow: {
2934
2940
  /**
@@ -3091,7 +3097,7 @@ class Client$1 {
3091
3097
  }),
3092
3098
  },
3093
3099
  /**
3094
- * 考勤统计
3100
+ * user_stats_field
3095
3101
  */
3096
3102
  userStatsField: {
3097
3103
  /**
@@ -3120,7 +3126,7 @@ class Client$1 {
3120
3126
  }),
3121
3127
  },
3122
3128
  /**
3123
- * 考勤统计
3129
+ * user_stats_view
3124
3130
  */
3125
3131
  userStatsView: {
3126
3132
  /**
@@ -3434,7 +3440,7 @@ class Client$1 {
3434
3440
  *
3435
3441
  * 创建免审词条
3436
3442
  *
3437
- * 通过此接口创建的词条,不需要百科管理员审核可直接写入词库,请慎重使用【租户管理员请慎重审批】
3443
+ * 通过此接口创建的词条,不需要百科管理员审核可直接写入词库,请慎重使用【租户管理员请慎重审批】。
3438
3444
  */
3439
3445
  create: (payload, options) => __awaiter(this, void 0, void 0, function* () {
3440
3446
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -3458,7 +3464,7 @@ class Client$1 {
3458
3464
  *
3459
3465
  * 获取词条详情
3460
3466
  *
3461
- * 通过词条 id 拉取对应的实体词详情信息
3467
+ * 通过词条 id 拉取对应的词条详情信息。
3462
3468
  *
3463
3469
  * 也支持通过 provider 和 outer_id 返回对应实体的详情数据。此时路径中的 entity_id 为固定的 enterprise_0
3464
3470
  */
@@ -3484,7 +3490,7 @@ class Client$1 {
3484
3490
  *
3485
3491
  * 词条高亮
3486
3492
  *
3487
- * 传入一句话,智能识别句中对应的词条,并返回词条位置和 entity_id,可在外部系统中快速实现百科词条智能高亮
3493
+ * 传入一句话,智能识别句中对应的词条,并返回词条位置和 entity_id,可在外部系统中快速实现百科词条智能高亮。
3488
3494
  */
3489
3495
  highlight: (payload, options) => __awaiter(this, void 0, void 0, function* () {
3490
3496
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -3556,7 +3562,7 @@ class Client$1 {
3556
3562
  *
3557
3563
  * 获取词条列表
3558
3564
  *
3559
- * 分页拉取词条列表数据,支持拉取租户内的全部词条
3565
+ * 分页拉取词条列表数据,支持拉取租户内的全部词条。
3560
3566
  */
3561
3567
  list: (payload, options) => __awaiter(this, void 0, void 0, function* () {
3562
3568
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -3580,7 +3586,7 @@ class Client$1 {
3580
3586
  *
3581
3587
  * 精准搜索词条
3582
3588
  *
3583
- * 将关键词与词条名、别名精准匹配,并返回对应的 词条 ID
3589
+ * 将关键词与词条名、别名精准匹配,并返回对应的 词条 ID
3584
3590
  */
3585
3591
  match: (payload, options) => __awaiter(this, void 0, void 0, function* () {
3586
3592
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -3652,7 +3658,7 @@ class Client$1 {
3652
3658
  *
3653
3659
  * 模糊搜索词条
3654
3660
  *
3655
- * 传入关键词,与词条名、别名、释义等信息进行模糊匹配,返回搜到的词条信息
3661
+ * 传入关键词,与词条名、别名、释义等信息进行模糊匹配,返回搜到的词条信息。
3656
3662
  */
3657
3663
  search: (payload, options) => __awaiter(this, void 0, void 0, function* () {
3658
3664
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -3676,7 +3682,7 @@ class Client$1 {
3676
3682
  *
3677
3683
  * 更新免审词条
3678
3684
  *
3679
- * 通过此接口更新已有的词条,不需要百科管理员审核可直接写入词库,请慎重使用【租户管理员请慎重审批】
3685
+ * 通过此接口更新已有的词条,不需要百科管理员审核可直接写入词库,请慎重使用【租户管理员请慎重审批】。
3680
3686
  */
3681
3687
  update: (payload, options) => __awaiter(this, void 0, void 0, function* () {
3682
3688
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -3695,13 +3701,17 @@ class Client$1 {
3695
3701
  }),
3696
3702
  },
3697
3703
  /**
3698
- * file
3704
+ * 文件
3699
3705
  */
3700
3706
  file: {
3701
3707
  /**
3702
3708
  * {@link https://open.feishu.cn/api-explorer?project=baike&resource=file&apiName=download&version=v1 click to debug }
3703
3709
  *
3704
- * {@link https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=download&project=baike&resource=file&version=v1 document }
3710
+ * {@link https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/file/download document }
3711
+ *
3712
+ * 图片下载
3713
+ *
3714
+ * 通过 file_token 下载原图片
3705
3715
  */
3706
3716
  download: (payload, options) => __awaiter(this, void 0, void 0, function* () {
3707
3717
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -3736,7 +3746,11 @@ class Client$1 {
3736
3746
  /**
3737
3747
  * {@link https://open.feishu.cn/api-explorer?project=baike&resource=file&apiName=upload&version=v1 click to debug }
3738
3748
  *
3739
- * {@link https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=upload&project=baike&resource=file&version=v1 document }
3749
+ * {@link https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/file/upload document }
3750
+ *
3751
+ * 图片上传
3752
+ *
3753
+ * 百科词条图片资源上传。
3740
3754
  */
3741
3755
  upload: (payload, options) => __awaiter(this, void 0, void 0, function* () {
3742
3756
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -3757,7 +3771,7 @@ class Client$1 {
3757
3771
  },
3758
3772
  };
3759
3773
  /**
3760
- * 云文档-电子表格
3774
+ * 云文档-多维表格
3761
3775
  */
3762
3776
  this.bitable = {
3763
3777
  /**
@@ -5122,7 +5136,7 @@ class Client$1 {
5122
5136
  */
5123
5137
  this.block = {
5124
5138
  /**
5125
- * entity
5139
+ * 服务端 API
5126
5140
  */
5127
5141
  entity: {
5128
5142
  /**
@@ -5175,7 +5189,7 @@ class Client$1 {
5175
5189
  }),
5176
5190
  },
5177
5191
  /**
5178
- * message
5192
+ * 服务端 API
5179
5193
  */
5180
5194
  message: {
5181
5195
  /**
@@ -5183,9 +5197,9 @@ class Client$1 {
5183
5197
  *
5184
5198
  * {@link https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/block-v2/message/create document }
5185
5199
  *
5186
- * Block消息推送
5200
+ * Block协同数据推送
5187
5201
  *
5188
- * 根据BlockID向指定用户列表推送消息。
5202
+ * 根据BlockID向指定用户列表推送协同数据。
5189
5203
  */
5190
5204
  create: (payload, options) => __awaiter(this, void 0, void 0, function* () {
5191
5205
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -6474,7 +6488,7 @@ class Client$1 {
6474
6488
  }),
6475
6489
  },
6476
6490
  /**
6477
- * 部门管理
6491
+ * 部门
6478
6492
  */
6479
6493
  department: {
6480
6494
  childrenWithIterator: (payload, options) => __awaiter(this, void 0, void 0, function* () {
@@ -6532,9 +6546,9 @@ class Client$1 {
6532
6546
  *
6533
6547
  * 获取子部门列表
6534
6548
  *
6535
- * 通过部门ID获取部门的子部门列表。[常见问题答疑](https://open.feishu.cn/document/ugTN1YjL4UTN24CO1UjN/uQzN1YjL0cTN24CN3UjN)。
6549
+ * 通过部门ID获取部门的子部门列表。
6536
6550
  *
6537
- * - 使用 user_access_token 时,返回该用户组织架构可见性范围([登陆企业管理后台进行权限配置](https://www.feishu.cn/admin/security/permission/visibility))内的所有可见部门。当进行递归查询时,最多1000个部门对该用户可见。;;- 使用 ; tenant_access_token 则基于应用的通讯录权限范围进行权限校验与过滤。;如果部门ID为0,会检验应用是否有全员通讯录权限,如果是非0 部门ID,则会校验应用是否有该部门的通讯录权限。无部门权限返回无部门通讯录权限错误码,有权限则返回部门下子部门列表(根据fetch_child决定是否递归)。
6551
+ * - 部门ID 必填,根部门的部门ID 为0。;- 使用 `user_access_token` 时,返回该用户组织架构可见性范围([登陆企业管理后台进行权限配置](https://www.feishu.cn/admin/security/permission/visibility))内的所有可见部门。当进行递归查询时,最多1000个部门对该用户可见。;;- 使用 ;`tenant_access_token` 则基于应用的通讯录权限范围进行权限校验与过滤。;如果部门ID为0,会检验应用是否有全员通讯录权限,如果是非0 部门ID,则会校验应用是否有该部门的通讯录权限。无部门权限返回无部门通讯录权限错误码,有权限则返回部门下子部门列表(根据fetch_child决定是否递归)。
6538
6552
  */
6539
6553
  children: (payload, options) => __awaiter(this, void 0, void 0, function* () {
6540
6554
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -6558,7 +6572,7 @@ class Client$1 {
6558
6572
  *
6559
6573
  * 创建部门
6560
6574
  *
6561
- * 该接口用于向通讯录中创建部门。[常见问题答疑](https://open.feishu.cn/document/ugTN1YjL4UTN24CO1UjN/uQzN1YjL0cTN24CN3UjN)。
6575
+ * 该接口用于向通讯录中创建部门。
6562
6576
  *
6563
6577
  * 只可在应用的通讯录权限范围内的部门下创建部门。若需要在根部门下创建子部门,则应用通讯录权限范围需要设置为“全部成员”。应用商店应用无权限调用此接口。
6564
6578
  */
@@ -6584,7 +6598,7 @@ class Client$1 {
6584
6598
  *
6585
6599
  * 删除部门
6586
6600
  *
6587
- * 该接口用于向通讯录中删除部门。[常见问题答疑](https://open.feishu.cn/document/ugTN1YjL4UTN24CO1UjN/uQzN1YjL0cTN24CN3UjN)。
6601
+ * 该接口用于向通讯录中删除部门。
6588
6602
  *
6589
6603
  * 应用需要同时拥有待删除部门及其父部门的通讯录授权。应用商店应用无权限调用该接口。
6590
6604
  */
@@ -6610,9 +6624,9 @@ class Client$1 {
6610
6624
  *
6611
6625
  * 获取单个部门信息
6612
6626
  *
6613
- * 该接口用于向通讯录获取单个部门信息。[常见问题答疑](https://open.feishu.cn/document/ugTN1YjL4UTN24CO1UjN/uQzN1YjL0cTN24CN3UjN)。
6627
+ * 该接口用于向通讯录获取单个部门信息。
6614
6628
  *
6615
- * 使用tenant_access_token时,应用需要拥有待查询部门的通讯录授权。如果需要获取根部门信息,则需要拥有全员权限。;使用user_access_token时,用户需要有待查询部门的可见性,如果需要获取根部门信息,则要求员工可见所有人。
6629
+ * - 使用`tenant_access_token`时,应用需要拥有待查询部门的通讯录授权。如果需要获取根部门信息,则需要拥有全员权限。;- 使用`user_access_token`时,用户需要有待查询部门的可见性,如果需要获取根部门信息,则要求员工可见所有人。
6616
6630
  */
6617
6631
  get: (payload, options) => __awaiter(this, void 0, void 0, function* () {
6618
6632
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -6758,9 +6772,9 @@ class Client$1 {
6758
6772
  *
6759
6773
  * 获取父部门信息
6760
6774
  *
6761
- * 该接口用来递归获取部门父部门的信息,并按照由子到父的顺序返回有权限的父部门信息列表。[常见问题答疑](https://open.feishu.cn/document/ugTN1YjL4UTN24CO1UjN/uQzN1YjL0cTN24CN3UjN)。
6775
+ * 该接口用来递归获取部门父部门的信息,并按照由子到父的顺序返回有权限的父部门信息列表。
6762
6776
  *
6763
- * 使用tenant_access_token时,该接口只返回可见性范围内的父部门信息;;例如:A >>B>>C>>D四级部门,通讯录权限只到B,那么查询D部门的parent,会返回B和C两级部门。;使用user_access_token时,该接口只返回对于用户可见的父部门信息
6777
+ * 使用`tenant_access_token`时,该接口只返回可见性范围内的父部门信息。;例如:A >>B>>C>>D四级部门,通讯录权限只到B,那么查询D部门的parent,会返回B和C两级部门。;使用user_access_token时,该接口只返回对于用户可见的父部门信息。
6764
6778
  */
6765
6779
  parent: (payload, options) => __awaiter(this, void 0, void 0, function* () {
6766
6780
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -6782,9 +6796,9 @@ class Client$1 {
6782
6796
  *
6783
6797
  * {@link https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/patch document }
6784
6798
  *
6785
- * 修改部分部门信息
6799
+ * 修改部门部分信息
6786
6800
  *
6787
- * 该接口用于更新通讯录中部门的信息中的任一个字段。[常见问题答疑](https://open.feishu.cn/document/ugTN1YjL4UTN24CO1UjN/uQzN1YjL0cTN24CN3UjN)。
6801
+ * 该接口用于更新通讯录中部门的信息中的任一个字段。
6788
6802
  *
6789
6803
  * 调用该接口需要具有该部门以及更新操作涉及的部门的通讯录权限。应用商店应用无权限调用此接口。
6790
6804
  */
@@ -6858,9 +6872,9 @@ class Client$1 {
6858
6872
  *
6859
6873
  * 搜索部门
6860
6874
  *
6861
- * 搜索部门,用户通过关键词查询可见的部门数据,部门可见性需要管理员在后台配置。[常见问题答疑](https://open.feishu.cn/document/ugTN1YjL4UTN24CO1UjN/uQzN1YjL0cTN24CN3UjN)。
6875
+ * 搜索部门,用户通过关键词查询可见的部门数据,部门可见性需要管理员在后台配置。
6862
6876
  *
6863
- * 部门存在,但用户搜索不到并不一定是搜索有问题,可能是管理员在后台配置了权限控制,导致用户无法搜索到该部门
6877
+ * 部门存在,但用户搜索不到并不一定是搜索有问题,可能是管理员在后台配置了权限控制,导致用户无法搜索到该部门。
6864
6878
  */
6865
6879
  search: (payload, options) => __awaiter(this, void 0, void 0, function* () {
6866
6880
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -6908,7 +6922,7 @@ class Client$1 {
6908
6922
  *
6909
6923
  * 更新部门所有信息
6910
6924
  *
6911
- * 该接口用于更新当前部门所有信息。[常见问题答疑](https://open.feishu.cn/document/ugTN1YjL4UTN24CO1UjN/uQzN1YjL0cTN24CN3UjN)。
6925
+ * 该接口用于更新当前部门所有信息。
6912
6926
  *
6913
6927
  * - 调用该接口需要具有该部门以及更新操作涉及的部门的通讯录权限。应用商店应用无权限调用此接口。;; - 没有填写的字段会被置为空值(order字段除外)。
6914
6928
  */
@@ -7714,7 +7728,7 @@ class Client$1 {
7714
7728
  *
7715
7729
  * 创建用户
7716
7730
  *
7717
- * 使用该接口向通讯录创建一个用户,可以理解为员工入职。创建用户后只返回有数据权限的数据。具体的数据权限的与字段的对应关系请参照[应用权限](https://open.feishu.cn/document/ukTMukTMukTM/uQjN3QjL0YzN04CN2cDN)。[常见问题答疑](https://open.feishu.cn/document/ugTN1YjL4UTN24CO1UjN/uQzN1YjL0cTN24CN3UjN)。
7731
+ * 使用该接口向通讯录创建一个用户,可以理解为员工入职。创建用户后只返回有数据权限的数据。具体的数据权限的与字段的对应关系请参照[应用权限](https://open.feishu.cn/document/ukTMukTMukTM/uQjN3QjL0YzN04CN2cDN)。
7718
7732
  *
7719
7733
  * - 新增用户的所有部门必须都在当前应用的通讯录授权范围内才允许新增用户,如果想要在根部门下新增用户,必须要有全员权限。;- 应用商店应用无权限调用此接口。;- 创建用户后,会给用户发送邀请短信/邮件,用户在操作同意后才可访问团队。;- 返回数据中不返回手机号,如果需要请重新查询用户信息获取手机号。
7720
7734
  */
@@ -7740,9 +7754,9 @@ class Client$1 {
7740
7754
  *
7741
7755
  * 删除用户
7742
7756
  *
7743
- * 该接口向通讯录删除一个用户信息,可以理解为员工离职。[常见问题答疑](https://open.feishu.cn/document/ugTN1YjL4UTN24CO1UjN/uQzN1YjL0cTN24CN3UjN)。
7757
+ * 该接口向通讯录删除一个用户信息,可以理解为员工离职。
7744
7758
  *
7745
- * 若用户归属部门A、部门B,应用的通讯录权限范围必须包括部门A和部门B才可以删除用户。应用商店应用无权限调用接口。用户可以在删除员工时设置删除员工数据的接收者,如果不设置则由其leader接收,如果该员工没有leader,则会将该员工的数据删除。
7759
+ * - 若用户归属部门A、部门B,应用的通讯录权限范围必须包括部门A和部门B才可以删除用户。;- 应用商店应用无权限调用接口。;- 用户可以在删除员工时设置删除员工数据的接收者,如果不设置则由其leader接收,如果该员工没有leader,则会将该员工的数据删除。
7746
7760
  */
7747
7761
  delete: (payload, options) => __awaiter(this, void 0, void 0, function* () {
7748
7762
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -7814,9 +7828,9 @@ class Client$1 {
7814
7828
  *
7815
7829
  * 获取部门直属用户列表
7816
7830
  *
7817
- * 基于部门ID获取部门直属用户列表。;[常见问题答疑](https://open.feishu.cn/document/ugTN1YjL4UTN24CO1UjN/uQzN1YjL0cTN24CN3UjN).
7831
+ * 基于部门ID获取部门直属用户列表。
7818
7832
  *
7819
- * - 使用 user_access_token 情况下根据个人组织架构的通讯录可见范围进行权限过滤,返回个人组织架构通讯录范围([登录企业管理后台进行权限配置](https://www.feishu.cn/admin/security/permission/visibility))内可见的用户数据。;- 使用tenant_access_token,会根据应用通讯录的范围进行权限过滤。 如果请求的部门ID为0,则校验应用是否具有全员通讯录权限; 如果是非0的部门ID,则会验证应用是否具有该部门的通讯录权限。 无权限返回无权限错误码,有权限则返回对应部门下的直接用户列表。
7833
+ * - 部门ID 必填,根部门的部门ID为0。;- 使用 `user_access_token` 情况下根据个人组织架构的通讯录可见范围进行权限过滤,返回个人组织架构通讯录范围([登录企业管理后台进行权限配置](https://www.feishu.cn/admin/security/permission/visibility))内可见的用户数据。;- 使用`tenant_access_token`会根据应用通讯录的范围进行权限过滤。 如果请求的部门ID为0,则校验应用是否具有全员通讯录权限; 如果是非0的部门ID,则会验证应用是否具有该部门的通讯录权限。 无权限返回无权限错误码,有权限则返回对应部门下的直接用户列表。
7820
7834
  */
7821
7835
  findByDepartment: (payload, options) => __awaiter(this, void 0, void 0, function* () {
7822
7836
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -7840,7 +7854,7 @@ class Client$1 {
7840
7854
  *
7841
7855
  * 获取单个用户信息
7842
7856
  *
7843
- * 该接口用于获取通讯录中[单个用户的信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/field-overview)。[常见问题答疑](https://open.feishu.cn/document/ugTN1YjL4UTN24CO1UjN/uQzN1YjL0cTN24CN3UjN)。
7857
+ * 该接口用于获取通讯录中单个用户的信息。
7844
7858
  */
7845
7859
  get: (payload, options) => __awaiter(this, void 0, void 0, function* () {
7846
7860
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -7938,7 +7952,7 @@ class Client$1 {
7938
7952
  *
7939
7953
  * 修改用户部分信息
7940
7954
  *
7941
- * 该接口用于更新通讯录中用户的字段,未传递的参数不会更新。[常见问题答疑](https://open.feishu.cn/document/ugTN1YjL4UTN24CO1UjN/uQzN1YjL0cTN24CN3UjN)。
7955
+ * 该接口用于更新通讯录中用户的字段,未传递的参数不会更新。
7942
7956
  */
7943
7957
  patch: (payload, options) => __awaiter(this, void 0, void 0, function* () {
7944
7958
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -7962,9 +7976,9 @@ class Client$1 {
7962
7976
  *
7963
7977
  * 更新用户所有信息
7964
7978
  *
7965
- * 该接口用于更新通讯录中用户的字段。[常见问题答疑](https://open.feishu.cn/document/ugTN1YjL4UTN24CO1UjN/uQzN1YjL0cTN24CN3UjN)。
7979
+ * 该接口用于更新通讯录中用户的字段。
7966
7980
  *
7967
- * ;应用需要拥有待更新用户的通讯录授权,如果涉及到用户部门变更,还需要同时拥有所有新部门的通讯录授权。应用商店应用无权限调用此接口。
7981
+ * 应用需要拥有待更新用户的通讯录授权,如果涉及到用户部门变更,还需要同时拥有所有新部门的通讯录授权。应用商店应用无权限调用此接口。
7968
7982
  */
7969
7983
  update: (payload, options) => __awaiter(this, void 0, void 0, function* () {
7970
7984
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -8016,6 +8030,8 @@ class Client$1 {
8016
8030
  *
8017
8031
  * 批量更新块的富文本内容。
8018
8032
  *
8033
+ * 频率限制:单个应用调用频率上限为每秒 3 次。
8034
+ *
8019
8035
  * 在调用此接口前,请仔细阅读[新版文档 OpenAPI 接口校验规则](https://bytedance.feishu.cn/docx/doxcnby5Y0yoACL3PdfZqrJEm6f#doxcnMiwAKCiE6oQEkPyhvmmQEe),了解相关规则及约束。
8020
8036
  */
8021
8037
  batchUpdate: (payload, options) => __awaiter(this, void 0, void 0, function* () {
@@ -8042,6 +8058,8 @@ class Client$1 {
8042
8058
  *
8043
8059
  * 获取指定块的富文本内容。
8044
8060
  *
8061
+ * 频率限制:单个应用调用频率上限为每秒 5 次。
8062
+ *
8045
8063
  * 在调用此接口前,请仔细阅读[新版文档 OpenAPI 接口校验规则](https://bytedance.feishu.cn/docx/doxcnamKaccZKqIMopnREJCZUMe#doxcnWEMWYAg2YMkEq0SZXHzaih),了解相关规则及约束。
8046
8064
  */
8047
8065
  get: (payload, options) => __awaiter(this, void 0, void 0, function* () {
@@ -8116,6 +8134,8 @@ class Client$1 {
8116
8134
  *
8117
8135
  * 获取文档所有块的富文本内容并分页返回。
8118
8136
  *
8137
+ * 频率限制:单个应用调用频率上限为每秒 5 次。
8138
+ *
8119
8139
  * 在调用此接口前,请仔细阅读[新版文档 OpenAPI 接口校验规则](https://bytedance.feishu.cn/docx/doxcnamKaccZKqIMopnREJCZUMe#doxcn6AkCE2AUUm2WwxID7lS7Xc),了解相关规则及约束。
8120
8140
  */
8121
8141
  list: (payload, options) => __awaiter(this, void 0, void 0, function* () {
@@ -8142,6 +8162,8 @@ class Client$1 {
8142
8162
  *
8143
8163
  * 更新指定的块。
8144
8164
  *
8165
+ * 频率限制:单个应用调用频率上限为每秒 3 次。
8166
+ *
8145
8167
  * 在调用此接口前,请仔细阅读[新版文档 OpenAPI 接口校验规则](https://bytedance.feishu.cn/docx/doxcnby5Y0yoACL3PdfZqrJEm6f#doxcnEeyS0I8MMqoieIMpK7jm8g),了解相关规则及约束。
8146
8168
  */
8147
8169
  patch: (payload, options) => __awaiter(this, void 0, void 0, function* () {
@@ -8161,7 +8183,7 @@ class Client$1 {
8161
8183
  }),
8162
8184
  },
8163
8185
  /**
8164
- *
8186
+ * document.block.children
8165
8187
  */
8166
8188
  documentBlockChildren: {
8167
8189
  /**
@@ -8173,6 +8195,8 @@ class Client$1 {
8173
8195
  *
8174
8196
  * 指定需要操作的块,删除其指定范围的子块。如果操作成功,接口将返回应用删除操作后的文档版本号。
8175
8197
  *
8198
+ * 频率限制:单个应用调用频率上限为每秒 3 次。
8199
+ *
8176
8200
  * 在调用此接口前,请仔细阅读[新版文档 OpenAPI 接口校验规则](https://bytedance.feishu.cn/docx/doxcnby5Y0yoACL3PdfZqrJEm6f#doxcngCsscGk0WacO258mYDgM6b),了解相关规则及约束。
8177
8201
  */
8178
8202
  batchDelete: (payload, options) => __awaiter(this, void 0, void 0, function* () {
@@ -8199,6 +8223,8 @@ class Client$1 {
8199
8223
  *
8200
8224
  * 指定需要操作的块,为其创建一批子块,并插入到指定位置。如果操作成功,接口将返回新创建子块的富文本内容。
8201
8225
  *
8226
+ * 频率限制:单个应用调用频率上限为每秒 3 次。
8227
+ *
8202
8228
  * 在调用此接口前,请仔细阅读[新版文档 OpenAPI 接口校验规则](https://bytedance.feishu.cn/docx/doxcnby5Y0yoACL3PdfZqrJEm6f#doxcnm0ooUe0s20GwwVB3a05rtb),了解相关规则及约束。
8203
8229
  */
8204
8230
  create: (payload, options) => __awaiter(this, void 0, void 0, function* () {
@@ -8273,6 +8299,8 @@ class Client$1 {
8273
8299
  *
8274
8300
  * 给定一个指定版本的文档,并指定需要操作的块,分页遍历其所有子块富文本内容 。如果不指定版本,则会默认查询最新版本。
8275
8301
  *
8302
+ * 频率限制:单个应用调用频率上限为每秒 5 次。
8303
+ *
8276
8304
  * 在调用此接口前,请仔细阅读[新版文档 OpenAPI 接口校验规则](https://bytedance.feishu.cn/docx/doxcnby5Y0yoACL3PdfZqrJEm6f#doxcnE2UK2yY0gEGK8nBMPtB0vd),了解相关规则及约束。
8277
8305
  */
8278
8306
  get: (payload, options) => __awaiter(this, void 0, void 0, function* () {
@@ -8304,6 +8332,8 @@ class Client$1 {
8304
8332
  *
8305
8333
  * 创建新版文档,文档标题和目录可选。
8306
8334
  *
8335
+ * 频率限制:单个应用调用频率上限为每秒 3 次。
8336
+ *
8307
8337
  * 在调用此接口前,请仔细阅读[新版文档 OpenAPI 接口校验规则](https://bytedance.feishu.cn/docx/doxcnby5Y0yoACL3PdfZqrJEm6f#doxcnyoyCgwS8ywWwMtQr9yjZ2f),了解相关规则及约束。
8308
8338
  */
8309
8339
  create: (payload, options) => __awaiter(this, void 0, void 0, function* () {
@@ -8330,6 +8360,8 @@ class Client$1 {
8330
8360
  *
8331
8361
  * 获取文档最新版本号、标题等
8332
8362
  *
8363
+ * 频率限制:单个应用调用频率上限为每秒 5 次。
8364
+ *
8333
8365
  * 在调用此接口前,请仔细阅读[新版文档 OpenAPI 接口校验规则](https://bytedance.feishu.cn/docx/doxcnby5Y0yoACL3PdfZqrJEm6f#doxcnWKAE4aSaIU4GcdLInSaVde),了解相关规则及约束。
8334
8366
  */
8335
8367
  get: (payload, options) => __awaiter(this, void 0, void 0, function* () {
@@ -8356,6 +8388,8 @@ class Client$1 {
8356
8388
  *
8357
8389
  * 获取文档的纯文本内容。
8358
8390
  *
8391
+ * 频率限制:单个应用调用频率上限为每秒 5 次。
8392
+ *
8359
8393
  * 在调用此接口前,请仔细阅读[新版文档 OpenAPI 接口校验规则](https://bytedance.feishu.cn/docx/doxcnby5Y0yoACL3PdfZqrJEm6f#doxcnQeqI4wiKIMis6GNvCOBuqg),了解相关规则及约束。
8360
8394
  */
8361
8395
  rawContent: (payload, options) => __awaiter(this, void 0, void 0, function* () {
@@ -8576,11 +8610,9 @@ class Client$1 {
8576
8610
  *
8577
8611
  * {@link https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-comment/list document }
8578
8612
  *
8579
- * 获取评论列表
8580
- *
8581
- * 通过分页方式获取云文档中的全文评论列表。
8613
+ * 获取文档评论
8582
8614
  *
8583
- * 注意:该接口仅可获取在线文档的全文评论,不支持获取局部评论或者在线表格中的评论。
8615
+ * 根据文档token分页获取云文档中的评论。
8584
8616
  */
8585
8617
  list: (payload, options) => __awaiter(this, void 0, void 0, function* () {
8586
8618
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -8676,7 +8708,7 @@ class Client$1 {
8676
8708
  }),
8677
8709
  },
8678
8710
  /**
8679
- * 分片上传
8711
+ * 下载
8680
8712
  */
8681
8713
  file: {
8682
8714
  /**
@@ -8903,7 +8935,7 @@ class Client$1 {
8903
8935
  *
8904
8936
  * 订阅云文档事件
8905
8937
  *
8906
- * 该接口**仅支持文档拥有者**订阅自己文档的通知事件,可订阅的文档类型为**旧版文档**、**新版文档**、**电子表格**和**多维表格**。在调用该接口之前请确保正确[配置事件回调网址和订阅事件类型](https://open.feishu.cn/document/ukTMukTMukTM/uUTNz4SN1MjL1UzM#2eb3504a),事件类型参考[事件列表](https://open.feishu.cn/document/ukTMukTMukTM/uYDNxYjL2QTM24iN0EjN/event-list)。
8938
+ * 该接口仅支持**文档拥有者**订阅自己文档的通知事件,可订阅的文档类型为**旧版文档**、**新版文档**、**电子表格**和**多维表格**。在调用该接口之前请确保正确[配置事件回调网址和订阅事件类型](https://open.feishu.cn/document/ukTMukTMukTM/uUTNz4SN1MjL1UzM#2eb3504a),事件类型参考[事件列表](https://open.feishu.cn/document/ukTMukTMukTM/uYDNxYjL2QTM24iN0EjN/event-list)。
8907
8939
  */
8908
8940
  subscribe: (payload, options) => __awaiter(this, void 0, void 0, function* () {
8909
8941
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -9056,7 +9088,7 @@ class Client$1 {
9056
9088
  }),
9057
9089
  },
9058
9090
  /**
9059
- * 文件
9091
+ * file.statistics
9060
9092
  */
9061
9093
  fileStatistics: {
9062
9094
  /**
@@ -9215,7 +9247,7 @@ class Client$1 {
9215
9247
  }),
9216
9248
  },
9217
9249
  /**
9218
- * 分片上传
9250
+ * 素材
9219
9251
  */
9220
9252
  media: {
9221
9253
  /**
@@ -9397,7 +9429,7 @@ class Client$1 {
9397
9429
  }),
9398
9430
  },
9399
9431
  /**
9400
- * 文件
9432
+ * meta
9401
9433
  */
9402
9434
  meta: {
9403
9435
  /**
@@ -9477,6 +9509,32 @@ class Client$1 {
9477
9509
  throw e;
9478
9510
  });
9479
9511
  }),
9512
+ /**
9513
+ * {@link https://open.feishu.cn/api-explorer?project=drive&resource=permission.member&apiName=list&version=v1 click to debug }
9514
+ *
9515
+ * {@link https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/permission-member/list document }
9516
+ *
9517
+ * 获取协作者列表
9518
+ *
9519
+ * 该接口用于根据 filetoken 查询协作者
9520
+ *
9521
+ * - 你能获取到协作者列表的前提是你对该文档有分享权限;- 目前仅支持人、群、组织架构三种类型的协作者
9522
+ */
9523
+ list: (payload, options) => __awaiter(this, void 0, void 0, function* () {
9524
+ const { headers, params, data, path } = yield this.formatPayload(payload, options);
9525
+ return httpInstance
9526
+ .request({
9527
+ url: fillApiPath(`${this.domain}/open-apis/drive/v1/permissions/:token/members`, path),
9528
+ method: "GET",
9529
+ data,
9530
+ params,
9531
+ headers,
9532
+ })
9533
+ .catch((e) => {
9534
+ this.logger.error(formatErrors(e));
9535
+ throw e;
9536
+ });
9537
+ }),
9480
9538
  /**
9481
9539
  * {@link https://open.feishu.cn/api-explorer?project=drive&resource=permission.member&apiName=update&version=v1 click to debug }
9482
9540
  *
@@ -9699,7 +9757,7 @@ class Client$1 {
9699
9757
  */
9700
9758
  this.event = {
9701
9759
  /**
9702
- * 事件出口IP
9760
+ * 事件订阅
9703
9761
  */
9704
9762
  outboundIp: {
9705
9763
  listWithIterator: (payload, options) => __awaiter(this, void 0, void 0, function* () {
@@ -9755,11 +9813,11 @@ class Client$1 {
9755
9813
  *
9756
9814
  * {@link https://open.feishu.cn/document/ukTMukTMukTM/uYDNxYjL2QTM24iN0EjN/event-v1/outbound_ip/list document }
9757
9815
  *
9758
- * 获取事件出口IP
9816
+ * 获取事件出口 IP
9759
9817
  *
9760
- * 飞书开放平台向应用配置的回调地址推送事件时,是通过特定的IP发送出去的。如果企业需要做防火墙配置,那么可以通过这个接口获取到所有相关的IP段。
9818
+ * 飞书开放平台向应用配置的回调地址推送事件时,是通过特定的 IP 发送出去的,应用可以通过本接口获取所有相关的 IP 地址。
9761
9819
  *
9762
- * IP段有变更可能,建议企业每隔6小时定时拉取IP段更新防火墙设置,这样因IP变更导致推送失败的事件还可以通过重试解决。
9820
+ * IP 地址有变更可能,建议应用每隔 6 小时定时拉取最新的 IP 地址,以免由于企业防火墙设置,导致应用无法及时接收到飞书开放平台推送的事件。
9763
9821
  */
9764
9822
  list: (payload, options) => __awaiter(this, void 0, void 0, function* () {
9765
9823
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -10075,7 +10133,7 @@ class Client$1 {
10075
10133
  }),
10076
10134
  },
10077
10135
  /**
10078
- * 客服工作日程
10136
+ * agent_schedule
10079
10137
  */
10080
10138
  agentSchedule: {
10081
10139
  /**
@@ -11395,7 +11453,7 @@ class Client$1 {
11395
11453
  /**
11396
11454
  * {@link https://open.feishu.cn/api-explorer?project=hire&resource=application&apiName=create&version=v1 click to debug }
11397
11455
  *
11398
- * {@link https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/application/create document }
11456
+ * {@link https://open.feishu.cn/document/ukTMukTMukTM/uQzM1YjL0MTN24CNzUjN/create_application document }
11399
11457
  *
11400
11458
  * 创建投递
11401
11459
  *
@@ -11419,7 +11477,7 @@ class Client$1 {
11419
11477
  /**
11420
11478
  * {@link https://open.feishu.cn/api-explorer?project=hire&resource=application&apiName=get&version=v1 click to debug }
11421
11479
  *
11422
- * {@link https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/application/get document }
11480
+ * {@link https://open.feishu.cn/document/ukTMukTMukTM/uQzM1YjL0MTN24CNzUjN/get-application document }
11423
11481
  *
11424
11482
  * 获取投递信息
11425
11483
  *
@@ -11443,7 +11501,7 @@ class Client$1 {
11443
11501
  /**
11444
11502
  * {@link https://open.feishu.cn/api-explorer?project=hire&resource=application&apiName=list&version=v1 click to debug }
11445
11503
  *
11446
- * {@link https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/application/list document }
11504
+ * {@link https://open.feishu.cn/document/ukTMukTMukTM/uQzM1YjL0MTN24CNzUjN/get-application-list document }
11447
11505
  *
11448
11506
  * 获取投递列表
11449
11507
  *
@@ -11467,7 +11525,7 @@ class Client$1 {
11467
11525
  /**
11468
11526
  * {@link https://open.feishu.cn/api-explorer?project=hire&resource=application&apiName=offer&version=v1 click to debug }
11469
11527
  *
11470
- * {@link https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/application/offer document }
11528
+ * {@link https://open.feishu.cn/document/ukTMukTMukTM/uQzM1YjL0MTN24CNzUjN/get-application-offer document }
11471
11529
  *
11472
11530
  * 获取 Offer 信息
11473
11531
  *
@@ -11491,7 +11549,7 @@ class Client$1 {
11491
11549
  /**
11492
11550
  * {@link https://open.feishu.cn/api-explorer?project=hire&resource=application&apiName=terminate&version=v1 click to debug }
11493
11551
  *
11494
- * {@link https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/application/terminate document }
11552
+ * {@link https://open.feishu.cn/document/ukTMukTMukTM/uQzM1YjL0MTN24CNzUjN/terminate-application document }
11495
11553
  *
11496
11554
  * 终止投递
11497
11555
  *
@@ -11515,7 +11573,7 @@ class Client$1 {
11515
11573
  /**
11516
11574
  * {@link https://open.feishu.cn/api-explorer?project=hire&resource=application&apiName=transfer_onboard&version=v1 click to debug }
11517
11575
  *
11518
- * {@link https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/application/transfer_onboard document }
11576
+ * {@link https://open.feishu.cn/document/ukTMukTMukTM/uczM1YjL3MTN24yNzUjN document }
11519
11577
  *
11520
11578
  * 操作候选人入职
11521
11579
  *
@@ -11703,7 +11761,7 @@ class Client$1 {
11703
11761
  /**
11704
11762
  * {@link https://open.feishu.cn/api-explorer?project=hire&resource=job&apiName=get&version=v1 click to debug }
11705
11763
  *
11706
- * {@link https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job/get document }
11764
+ * {@link https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/job/get-job document }
11707
11765
  *
11708
11766
  * 获取职位信息
11709
11767
  *
@@ -11726,7 +11784,7 @@ class Client$1 {
11726
11784
  }),
11727
11785
  },
11728
11786
  /**
11729
- * 职位
11787
+ * job.manager
11730
11788
  */
11731
11789
  jobManager: {
11732
11790
  /**
@@ -11761,7 +11819,7 @@ class Client$1 {
11761
11819
  /**
11762
11820
  * {@link https://open.feishu.cn/api-explorer?project=hire&resource=job_process&apiName=list&version=v1 click to debug }
11763
11821
  *
11764
- * {@link https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/job_process/list document }
11822
+ * {@link https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/jop-process/get-process document }
11765
11823
  *
11766
11824
  * 获取招聘流程信息
11767
11825
  *
@@ -12026,7 +12084,7 @@ class Client$1 {
12026
12084
  /**
12027
12085
  * {@link https://open.feishu.cn/api-explorer?project=hire&resource=talent&apiName=get&version=v1 click to debug }
12028
12086
  *
12029
- * {@link https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent/get document }
12087
+ * {@link https://open.feishu.cn/document/ukTMukTMukTM/uUzM1YjL1MTN24SNzUjN/get-talent document }
12030
12088
  *
12031
12089
  * 获取人才信息
12032
12090
  *
@@ -12100,9 +12158,9 @@ class Client$1 {
12100
12158
  *
12101
12159
  * 批量撤回消息
12102
12160
  *
12103
- * 批量撤回消息
12161
+ * 批量撤回通过[批量发送消息](https://open.feishu.cn/document/ukTMukTMukTM/ucDO1EjL3gTNx4yN4UTM)接口发送的消息。
12104
12162
  *
12105
- * 注意事项:;- 只能撤回通过[批量发送消息](https://open.feishu.cn/document/ukTMukTMukTM/ucDO1EjL3gTNx4yN4UTM)接口产生的消息,单条消息的撤回请使用[撤回消息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/delete)接口;- 路径参数**batch_message_id**为[批量发送消息](https://open.feishu.cn/document/ukTMukTMukTM/ucDO1EjL3gTNx4yN4UTM)接口返回值中的**message_id**字段,用于标识一次批量发送消息请求,格式为:**bm-xxx**;- 一次调用涉及大量消息,所以为异步接口,会有一定延迟。
12163
+ * 注意事项:;- 撤回单条发送的消息请使用[撤回消息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/delete)接口;- 不支持撤回发出时间超过1天的消息;- 一次调用涉及大量消息,所以为异步接口,会有一定延迟。
12106
12164
  */
12107
12165
  delete: (payload, options) => __awaiter(this, void 0, void 0, function* () {
12108
12166
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -12126,9 +12184,9 @@ class Client$1 {
12126
12184
  *
12127
12185
  * 查询批量消息整体进度
12128
12186
  *
12129
- * 查询批量消息整体进度
12187
+ * 该接口在[查询批量消息推送和阅读人数](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/batch_message/read_user)查询结果的基础上,增加了批量请求中有效的userid数量以及消息撤回进度数据。
12130
12188
  *
12131
- * 注意事项:;* 该接口是[查询批量消息推送和阅读人数](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/batch_message/read_user)接口的加强版;* 该接口返回的数据为查询时刻的快照数据
12189
+ * 注意事项:;* 该接口返回的数据为查询时刻的快照数据
12132
12190
  */
12133
12191
  getProgress: (payload, options) => __awaiter(this, void 0, void 0, function* () {
12134
12192
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -12152,9 +12210,9 @@ class Client$1 {
12152
12210
  *
12153
12211
  * 查询批量消息推送和阅读人数
12154
12212
  *
12155
- * 查询批量消息推送和阅读人数
12213
+ * 批量发送消息后,可以通过该接口查询批量消息推送的总人数和阅读人数。
12156
12214
  *
12157
- * 注意事项:;- 只能查询通过[批量发送消息](https://open.feishu.cn/document/ukTMukTMukTM/ucDO1EjL3gTNx4yN4UTM)接口产生的消息;- 该接口返回的数据为查询时刻的快照数据。
12215
+ * 注意事项:;- 只能查询通过[批量发送消息](https://open.feishu.cn/document/ukTMukTMukTM/ucDO1EjL3gTNx4yN4UTM)接口产生的消息;- 该接口返回的数据为查询时刻的快照数据
12158
12216
  */
12159
12217
  readUser: (payload, options) => __awaiter(this, void 0, void 0, function* () {
12160
12218
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -12242,7 +12300,7 @@ class Client$1 {
12242
12300
  *
12243
12301
  * 创建群并设置群头像、群名、群描述等。
12244
12302
  *
12245
- * 注意事项:; - 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 本接口只支持创建群,如果需要拉用户或者机器人入群参考 [将用户或机器人拉入群聊](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-members/create)接口;- 每次请求,最多拉 50 个用户或者 5 个机器人,并且群组最多容纳 15 个机器人; - 拉机器人入群请使用 ==app_id==
12303
+ * 注意事项:; - 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 本接口支持在创建群的同时拉用户或机器人进群;如果仅需要拉用户或者机器人入群参考 [将用户或机器人拉入群聊](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-members/create)接口
12246
12304
  */
12247
12305
  create: (payload, options) => __awaiter(this, void 0, void 0, function* () {
12248
12306
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -12266,9 +12324,9 @@ class Client$1 {
12266
12324
  *
12267
12325
  * 解散群
12268
12326
  *
12269
- * 解散群组
12327
+ * 解散群组。
12270
12328
  *
12271
- * 注意事项:;- 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 如果使用tenant_access_token,需要机器人是群的创建者且具备==更新应用所创建群的群信息==权限才可解散群;- 如果使用user_access_token,需要对应的用户是群主才可解散群
12329
+ * 注意事项:;- 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 如果使用tenant_access_token,需要机器人符合以下任一情况才可解散群:; - 机器人是群主; - 机器人是群的创建者且具备==更新应用所创建群的群信息==权限;- 如果使用user_access_token,需要对应的用户是群主才可解散群;- 解散外部群时,请先在[开发者后台](https://open.feishu.cn/app)—权限管理—权限配置页面申请 ==在外部群调用群聊的 API 及事件== 权限
12272
12330
  */
12273
12331
  delete: (payload, options) => __awaiter(this, void 0, void 0, function* () {
12274
12332
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -12294,7 +12352,7 @@ class Client$1 {
12294
12352
  *
12295
12353
  * 获取群名称、群描述、群头像、群主 ID 等群基本信息。
12296
12354
  *
12297
- * 注意事项:; - 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app); - 机器人或授权用户必须在群里(否则只会返回群名称、群头像等基本信息)
12355
+ * 注意事项:; - 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app); - 机器人或授权用户必须在群里(否则只会返回群名称、群头像等基本信息);- 获取内部群信息时,操作者须与群组在同一租户下;- 获取外部群信息时,请先在[开发者后台](https://open.feishu.cn/app)—权限管理—权限配置页面申请 ==在外部群调用群聊的 API 及事件== 权限
12298
12356
  */
12299
12357
  get: (payload, options) => __awaiter(this, void 0, void 0, function* () {
12300
12358
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -12320,7 +12378,7 @@ class Client$1 {
12320
12378
  *
12321
12379
  * 获取指定群的分享链接
12322
12380
  *
12323
- * 注意事项:;- 该接口遵守群分享权限管控;;- 单聊、密聊、团队群不支持分享群链接;;- 当Bot被停用或Bot退出群组时,Bot生成的群链接也将停用
12381
+ * 注意事项:;- 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app); - 机器人或授权用户必须在群组中;- 单聊、密聊、团队群不支持分享群链接;- 当Bot被停用或Bot退出群组时,Bot生成的群链接也将停用;- 当群聊开启了 ==仅群主和群管理员可添加群成员/分享群== 设置时,仅**群主**和**群管理员**可以获取群分享链接;- 获取内部群分享链接时,操作者须与群组在同一租户下;- 获取外部群分享链接时,请先在[开发者后台](https://open.feishu.cn/app)—权限管理—权限配置页面申请 ==在外部群调用群聊的 API 及事件== 权限
12324
12382
  */
12325
12383
  link: (payload, options) => __awaiter(this, void 0, void 0, function* () {
12326
12384
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -12394,7 +12452,7 @@ class Client$1 {
12394
12452
  *
12395
12453
  * 获取用户或者机器人所在群列表。
12396
12454
  *
12397
- * 注意事项:; - 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 查询参数 **user_id_type** 用于控制响应体中 owner_id 的类型,如果是获取机器人所在群列表该值可以不填;- 请注意区分本接口和[获取群信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/get)的请求 URL;- 获取的群列表不包含p2p单聊群
12455
+ * 注意事项:; - 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 请注意区分本接口和[获取群信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/get)的请求 URL;- 获取的群列表不包含p2p单聊群
12398
12456
  */
12399
12457
  list: (payload, options) => __awaiter(this, void 0, void 0, function* () {
12400
12458
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -12494,7 +12552,7 @@ class Client$1 {
12494
12552
  *
12495
12553
  * 更新群头像、群名称、群描述、群配置、转让群主等。
12496
12554
  *
12497
- * 注意事项:;- 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 若群未开启 ==仅群主和群管理员可编辑群信息== 配置:; - 群主/群管理员 创建群组且具备==更新应用所创建群的群信息==权限的机器人,可更新所有信息; - 不满足上述条件的群成员或机器人,仅可更新群头像、群名称、群描述、群国际化名称信息 ;- 若群开启了==仅群主和群管理员可编辑群信息==配置:; - 群主/群管理员 创建群组且具备==更新应用所创建群的群信息==权限的机器人,可更新所有信息; - 不满足上述条件的群成员或者机器人,任何群信息都不能修改
12555
+ * 注意事项:;- 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 对于群主/群管理员 创建群组且具备 ==更新应用所创建群的群信息== 权限的机器人,可更新所有信息;- 对于不满足上述权限条件的群成员或机器人:; - 若未开启 ==仅群主和群管理员可编辑群信息== 配置,仅可更新群头像、群名称、群描述、群国际化名称信息; - 若开启了 ==仅群主和群管理员可编辑群信息== 配置,任何群信息都不能修改;- 更新外部群信息时,请先在[开发者后台](https://open.feishu.cn/app)—权限管理—权限配置页面申请 ==在外部群调用群聊的 API 及事件== 权限
12498
12556
  */
12499
12557
  update: (payload, options) => __awaiter(this, void 0, void 0, function* () {
12500
12558
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -12549,7 +12607,7 @@ class Client$1 {
12549
12607
  *
12550
12608
  * 删除群管理员
12551
12609
  *
12552
- * 删除指定的群管理员(用户或机器人)
12610
+ * 删除指定的群管理员(用户或机器人)。
12553
12611
  *
12554
12612
  * 注意事项:; - 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 仅有群主可以删除群管理员;- 每次请求最多指定 50 个用户或者 5 个机器人;- 删除机器人类型的管理员请使用 ==app_id==
12555
12613
  */
@@ -12582,7 +12640,7 @@ class Client$1 {
12582
12640
  *
12583
12641
  * 将用户或机器人拉入群聊。
12584
12642
  *
12585
- * 注意事项:; - 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app); - 如需拉用户进群,需要机器人对用户有可见性; - 在开启 ==仅群主和群管理员可添加群成员== 的设置时,仅有群主/管理员 或 创建群组且具备 ==更新应用所创建群的群信息== 权限的机器人,可以拉用户或者机器人进群; - 在未开启 ==仅群主和群管理员可添加群成员== 的设置时,所有群成员都可以拉用户或机器人进群; - 每次请求,最多拉50个用户或者5个机器人,并且群组最多容纳15个机器人; - 拉机器人入群请使用 ==app_id==
12643
+ * 注意事项:; - 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app); - 如需拉用户进群,需要机器人对用户有[可用性](https://open.feishu.cn/document/home/introduction-to-scope-and-authorization/availability); - 机器人或授权用户必须在群组中;- 外部租户不能被加入到内部群中;- 操作内部群时,操作者须与群组在同一租户下;- 操作外部群时,请先在[开发者后台](https://open.feishu.cn/app)—权限管理—权限配置页面申请 ==在外部群调用群聊的 API 及事件== 权限; - 在开启 ==仅群主和群管理员可添加群成员== 的设置时,仅有群主/管理员 或 创建群组且具备 ==更新应用所创建群的群信息== 权限的机器人,可以拉用户或者机器人进群; - 在未开启 ==仅群主和群管理员可添加群成员== 的设置时,所有群成员都可以拉用户或机器人进群
12586
12644
  */
12587
12645
  create: (payload, options) => __awaiter(this, void 0, void 0, function* () {
12588
12646
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -12608,7 +12666,7 @@ class Client$1 {
12608
12666
  *
12609
12667
  * 将用户或机器人移出群聊。
12610
12668
  *
12611
- * 注意事项:; - 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 用户或机器人在任何条件下均可移除自己出群(即主动退群);- 仅有群主/管理员 或 创建群组并且具备 ==更新应用所创建群的群信息== 权限的机器人,可以移除其他用户或者机器人; - 每次请求,最多移除50个用户或者5个机器人;- 移除机器人请使用 ==app_id==
12669
+ * 注意事项:; - 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 用户或机器人在任何条件下均可移除自己出群(即主动退群);- 仅有群主/管理员 或 创建群组并且具备 ==更新应用所创建群的群信息== 权限的机器人,可以移除其他用户或者机器人; - 每次请求,最多移除50个用户或者5个机器人
12612
12670
  */
12613
12671
  delete: (payload, options) => __awaiter(this, void 0, void 0, function* () {
12614
12672
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -12751,7 +12809,7 @@ class Client$1 {
12751
12809
  }),
12752
12810
  },
12753
12811
  /**
12754
- * 群组
12812
+ * chat.moderation
12755
12813
  */
12756
12814
  chatModeration: {
12757
12815
  getWithIterator: (payload, options) => __awaiter(this, void 0, void 0, function* () {
@@ -12837,7 +12895,7 @@ class Client$1 {
12837
12895
  *
12838
12896
  * 更新群组的发言权限设置,可设置为全员可发言、仅管理员可发言 或 指定用户可发言。
12839
12897
  *
12840
- * 注意事项:; - 需要开启[机器人能力](https://open.feishu.cn/document/uQjL04CN/uYTMuYTMuYTM);- 若以用户授权调用接口,**当授权用户是群主**时,可更新群发言权限;- 若以租户授权调用接口(即以机器人身份调用接口),当**机器人是群主** 或者 **机器人是创建群组、具备==更新应用所创建群的群信息==权限且仍在群内**时,可更新群发言权限
12898
+ * 注意事项:; - 需要开启[机器人能力](https://open.feishu.cn/document/uQjL04CN/uYTMuYTMuYTM);- 若以用户授权调用接口,**当授权用户是群主**时,可更新群发言权限;- 若以租户授权调用接口(即以机器人身份调用接口),当**机器人是群主** 或者 **机器人是群组创建者、具备==更新应用所创建群的群信息==权限且仍在群内**时,可更新群发言权限
12841
12899
  */
12842
12900
  update: (payload, options) => __awaiter(this, void 0, void 0, function* () {
12843
12901
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -12987,7 +13045,7 @@ class Client$1 {
12987
13045
  }),
12988
13046
  },
12989
13047
  /**
12990
- * 群组
13048
+ * chat.top_notice
12991
13049
  */
12992
13050
  chatTopNotice: {
12993
13051
  /**
@@ -12997,7 +13055,9 @@ class Client$1 {
12997
13055
  *
12998
13056
  * 撤销群置顶
12999
13057
  *
13000
- * 撤销会话中的置顶
13058
+ * 撤销会话中的置顶。
13059
+ *
13060
+ * 注意事项:; - 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app); - 机器人或授权用户必须在群组中;- 撤销内部群置顶时,操作者须与群组在同一租户下;- 撤销外部群置顶时,请先在[开发者后台](https://open.feishu.cn/app)—权限管理—权限配置页面申请 ==在外部群调用群聊的 API 及事件== 权限
13001
13061
  */
13002
13062
  deleteTopNotice: (payload, options) => __awaiter(this, void 0, void 0, function* () {
13003
13063
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -13022,6 +13082,8 @@ class Client$1 {
13022
13082
  * 更新群置顶
13023
13083
  *
13024
13084
  * 更新会话中的群置顶信息,可以将群中的某一条消息,或者群公告置顶显示。
13085
+ *
13086
+ * 注意事项:; - 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app); - 机器人或授权用户必须在群组中;- 更新内部群置顶时,操作者须与群组在同一租户下;- 更新外部群置顶时,请先在[开发者后台](https://open.feishu.cn/app)—权限管理—权限配置页面申请 ==在外部群调用群聊的 API 及事件== 权限
13025
13087
  */
13026
13088
  putTopNotice: (payload, options) => __awaiter(this, void 0, void 0, function* () {
13027
13089
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -13050,9 +13112,9 @@ class Client$1 {
13050
13112
  *
13051
13113
  * 上传文件
13052
13114
  *
13053
- * 上传文件,可以上传视频,音频和常见的文件类型
13115
+ * 上传文件,可以上传视频,音频和常见的文件类型。
13054
13116
  *
13055
- * 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 不允许上传空文件;- 示例代码中需要自行替换文件路径和鉴权Token
13117
+ * 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 文件大小不得超过30M,且不允许上传空文件
13056
13118
  */
13057
13119
  create: (payload, options) => __awaiter(this, void 0, void 0, function* () {
13058
13120
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -13077,9 +13139,9 @@ class Client$1 {
13077
13139
  *
13078
13140
  * 下载文件
13079
13141
  *
13080
- * 下载文件接口,只能下载应用自己上传的文件
13142
+ * 下载文件接口,只能下载应用自己上传的文件。
13081
13143
  *
13082
- * 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 只能下载机器人自己上传的文件;- 下载用户发送的资源,请使用[获取消息中的资源文件](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message-resource/get)接口
13144
+ * 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 只能下载机器人自己上传的文件;- 下载用户发送的资源,请使用[获取消息中的资源文件](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message-resource/get)接口;- 下载的资源大小不能超过100M;- 如果需要Content-Disposition header,发起请求的时候需要在header中设置Content-Type为application/json
13083
13145
  */
13084
13146
  get: (payload, options) => __awaiter(this, void 0, void 0, function* () {
13085
13147
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -13123,9 +13185,9 @@ class Client$1 {
13123
13185
  *
13124
13186
  * 上传图片
13125
13187
  *
13126
- * 上传图片接口,可以上传 JPEG、PNG、WEBP、GIF、TIFF、BMP、ICO格式图片
13188
+ * 上传图片接口,支持上传 JPEG、PNG、WEBP、GIF、TIFF、BMP、ICO格式图片。
13127
13189
  *
13128
- * 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 上传的图片大小不能超过10MB
13190
+ * 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 图片大小不得超过10M,且不支持上传大小为0的图片
13129
13191
  */
13130
13192
  create: (payload, options) => __awaiter(this, void 0, void 0, function* () {
13131
13193
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -13150,9 +13212,9 @@ class Client$1 {
13150
13212
  *
13151
13213
  * 下载图片
13152
13214
  *
13153
- * 下载图片资源,只能下载应用自己上传且图片类型为message的图片
13215
+ * 下载图片资源,只能下载当前应用所上传且图片类型为message的图片。
13154
13216
  *
13155
- * 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 只能下载机器人自己上传且图片类型为message的图片,avatar类型暂不支持下载;;- 下载用户发送的资源,请使用[获取消息中的资源文件](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message-resource/get)接口
13217
+ * 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 只能下载机器人自己上传且图片类型为message的图片,avatar类型暂不支持下载;- 下载用户发送的资源,请使用[获取消息中的资源文件](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message-resource/get)接口
13156
13218
  */
13157
13219
  get: (payload, options) => __awaiter(this, void 0, void 0, function* () {
13158
13220
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -13186,7 +13248,7 @@ class Client$1 {
13186
13248
  }),
13187
13249
  },
13188
13250
  /**
13189
- * 加急操作
13251
+ * 消息 - 消息卡片
13190
13252
  */
13191
13253
  message: {
13192
13254
  /**
@@ -13198,7 +13260,7 @@ class Client$1 {
13198
13260
  *
13199
13261
  * 给指定用户或者会话发送消息,支持文本、富文本、可交互的[消息卡片](https://open.feishu.cn/document/ukTMukTMukTM/uczM3QjL3MzN04yNzcDN)、群名片、个人名片、图片、视频、音频、文件、表情包。
13200
13262
  *
13201
- * 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app) ;- 给用户发送消息,需要机器人对用户有[可用性](https://open.feishu.cn/document/home/introduction-to-scope-and-authorization/availability);- 给群组发送消息,需要机器人在群中;- 文本消息请求体最大不能超过150KB;- 卡片及富文本消息请求体最大不能超过30KB;- 消息卡片的 `update_multi`(是否为共享卡片)字段在卡片内容的`config`结构体中设置。详细参考文档[配置卡片属性](https://open.feishu.cn/document/ukTMukTMukTM/uAjNwUjLwYDM14CM2ATN)
13263
+ * 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app) ;- 给用户发送消息,需要机器人对用户有[可用性](https://open.feishu.cn/document/home/introduction-to-scope-and-authorization/availability);- 给群组发送消息,需要机器人在群组中
13202
13264
  */
13203
13265
  create: (payload, options) => __awaiter(this, void 0, void 0, function* () {
13204
13266
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -13224,7 +13286,7 @@ class Client$1 {
13224
13286
  *
13225
13287
  * 机器人撤回机器人自己发送的消息或群主撤回群内消息。
13226
13288
  *
13227
- * 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app) ,撤回消息时机器人仍需要在会话内;- 机器人可以撤回单聊和群组内,自己发送 且 发送时间不超过1天(24小时)的消息;- 若机器人要撤回群内他人发送的消息,则机器人必须是该群的群主、管理员 或者 创建者,且消息发送时间不超过1年;- 无法撤回通过「批量发送消息接口」发送的消息
13289
+ * 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app) ,撤回消息时机器人仍需要在会话内;- 机器人可以撤回单聊和群组内,自己发送 且 发送时间不超过1天(24小时)的消息;- 若机器人要撤回群内他人发送的消息,则机器人必须是该群的群主、管理员 或者 创建者,且消息发送时间不超过1年;- 无法撤回通过「[批量发送消息](https://open.feishu.cn/document/ukTMukTMukTM/ucDO1EjL3gTNx4yN4UTM)」接口发送的消息
13228
13290
  */
13229
13291
  delete: (payload, options) => __awaiter(this, void 0, void 0, function* () {
13230
13292
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -13248,7 +13310,7 @@ class Client$1 {
13248
13310
  *
13249
13311
  * 获取指定消息的内容
13250
13312
  *
13251
- * 通过 message_id 查询消息内容
13313
+ * 通过 message_id 查询消息内容。
13252
13314
  *
13253
13315
  * 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app) ;- 机器人必须在群组中
13254
13316
  */
@@ -13318,7 +13380,7 @@ class Client$1 {
13318
13380
  /**
13319
13381
  * {@link https://open.feishu.cn/api-explorer?project=im&resource=message&apiName=list&version=v1 click to debug }
13320
13382
  *
13321
- * {@link https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/list document }
13383
+ * {@link https://open.feishu.cn/document/ukTMukTMukTM/uADO3YjLwgzN24CM4cjN document }
13322
13384
  *
13323
13385
  * 获取会话历史消息
13324
13386
  *
@@ -13352,7 +13414,7 @@ class Client$1 {
13352
13414
  *
13353
13415
  * 更新应用已发送的消息卡片内容。
13354
13416
  *
13355
- * 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app) ;- 当前仅支持更新 **卡片消息**;- **不支持更新批量消息**;- 只支持对所有人都更新的[「共享卡片」](ukTMukTMukTM/uAjNwUjLwYDM14CM2ATN),也即需要在卡片的`config`属性中,显式声明`"update_multi":true`。<br>如果你只想更新特定人的消息卡片,必须要用户在卡片操作交互后触发,开发文档参考[「独享卡片」](https://open.feishu.cn/document/ukTMukTMukTM/uYjNwUjL2YDM14iN2ATN#49904b71);- 单条消息更新频控为**5QPS**
13417
+ * 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 若以user_access_token更新消息,该操作用户必须是卡片消息的发送者;- 对所有人更新[「共享卡片」](ukTMukTMukTM/uAjNwUjLwYDM14CM2ATN),需在卡片的config属性中,显式声明`"update_multi":true`。 更新特定人的卡片内容,必须在用户对卡片进行交互操作后触发调用,参考[「独享卡片」](https://open.feishu.cn/document/ukTMukTMukTM/uYjNwUjL2YDM14iN2ATN#49904b71) ;- 当前仅支持更新未撤回的 **卡片消息**;- **不支持更新批量消息**;- 文本消息请求体最大不能超过150KB;卡片及富文本消息请求体最大不能超过30KB;- 仅支持修改14天内发送的消息;- 单条消息更新频控为**5QPS**
13356
13418
  */
13357
13419
  patch: (payload, options) => __awaiter(this, void 0, void 0, function* () {
13358
13420
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -13404,7 +13466,7 @@ class Client$1 {
13404
13466
  *
13405
13467
  * 回复指定消息,支持文本、富文本、卡片、群名片、个人名片、图片、视频、文件等多种消息类型。
13406
13468
  *
13407
- * 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app) ;- 回复私聊消息,需要机器人对用户有可用性;- 回复群组消息,需要机器人在群中
13469
+ * 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app) ;- 回复私聊消息,需要机器人对用户有[可用性](https://open.feishu.cn/document/home/introduction-to-scope-and-authorization/availability);- 回复群组消息,需要机器人在群中
13408
13470
  */
13409
13471
  reply: (payload, options) => __awaiter(this, void 0, void 0, function* () {
13410
13472
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -13430,7 +13492,9 @@ class Client$1 {
13430
13492
  *
13431
13493
  * 对指定消息进行应用内加急。
13432
13494
  *
13433
- * 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app) ;- 只能加急机器人自己发送的消息;- 加急时机器人仍需要在会话内
13495
+ * 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app) ;- 不支持加急批量消息;- 只能加急机器人自己发送的消息;- 加急时机器人需要在加急消息所在的群中;- 调用本接口需要用户已阅读加急的消息才可以继续加急(用户未读的加急上限为200条)
13496
+ *
13497
+ * 特别说明:;- 默认接口限流为50 QPS,请谨慎调用
13434
13498
  */
13435
13499
  urgentApp: (payload, options) => __awaiter(this, void 0, void 0, function* () {
13436
13500
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -13454,11 +13518,11 @@ class Client$1 {
13454
13518
  *
13455
13519
  * 发送电话加急
13456
13520
  *
13457
- * 对指定消息进行应用内加急与电话加急
13521
+ * 对指定消息进行应用内加急与电话加急。
13458
13522
  *
13459
- * 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app) ;- 只能加急机器人自己发送的消息;- 加急时机器人仍需要在会话内
13523
+ * 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app) ;- 只能加急机器人自己发送的消息;- 加急时机器人需要在加急消息所在的群组中;- 需要用户阅读已加急的消息才可以继续加急(用户未读的加急上限为200条)
13460
13524
  *
13461
- * 特别说明:;- 通过接口产生的电话加急将消耗企业的加急额度,请慎重调用。;- 通过租户管理后台-费用中心-短信/电话加急 可以查看当前额度。;- 默认接口限流为50 QPS,请谨慎调用。
13525
+ * 特别说明:;- 通过接口产生的电话加急将消耗企业的加急额度,请慎重调用;- 通过[租户管理后台](https://admin.feishu.cn/)-费用中心-短信/电话加急 可以查看当前额度;- 默认接口限流为50 QPS,请谨慎调用
13462
13526
  */
13463
13527
  urgentPhone: (payload, options) => __awaiter(this, void 0, void 0, function* () {
13464
13528
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -13484,9 +13548,9 @@ class Client$1 {
13484
13548
  *
13485
13549
  * 对指定消息进行应用内加急与短信加急。
13486
13550
  *
13487
- * 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app) ;- 只能加急机器人自己发送的消息;- 加急时机器人仍需要在会话内
13551
+ * 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app) ;- 只能加急机器人自己发送的消息;- 加急时机器人仍需要在加急消息所在的群组中;- 调用本接口需要用户已阅读加急的消息才可以继续加急(用户未读的加急上限为200条)
13488
13552
  *
13489
- * 特别说明:;- 通过接口产生的短信加急将消耗企业的加急额度,请慎重调用。;- 通过租户管理后台-费用中心-短信/电话加急 可以查看当前额度。;- 默认接口限流为50 QPS,请谨慎调用。
13553
+ * 特别说明:;- 通过接口产生的短信加急将消耗企业的加急额度,请慎重调用;- 通过[租户管理后台](https://admin.feishu.cn/)-费用中心-短信/电话加急 可以查看当前额度;- 默认接口限流为50 QPS,请谨慎调用
13490
13554
  */
13491
13555
  urgentSms: (payload, options) => __awaiter(this, void 0, void 0, function* () {
13492
13556
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -13515,7 +13579,7 @@ class Client$1 {
13515
13579
  *
13516
13580
  * 添加消息表情回复
13517
13581
  *
13518
- * 给指定消息添加指定类型的表情回复(reaction即表情回复,本说明文档统一用“reaction”代称)。
13582
+ * 给指定消息添加指定类型的表情回复(reaction即表情回复,本文档统一用“reaction”代称)。
13519
13583
  *
13520
13584
  * 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app) ;- 待添加reaction的消息要真实存在,不能被撤回;- 给消息添加reaction,需要reaction的发送方(机器人或者用户)在消息所在的会话内
13521
13585
  */
@@ -13541,7 +13605,7 @@ class Client$1 {
13541
13605
  *
13542
13606
  * 删除消息表情回复
13543
13607
  *
13544
- * 删除指定消息的表情回复(reaction即表情回复,本说明文档统一用“reaction”代称)。
13608
+ * 删除指定消息的表情回复(reaction即表情回复,本文档统一用“reaction”代称)。
13545
13609
  *
13546
13610
  * 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app) ;- 只能删除真实存在的reaction,并且删除reaction请求的操作者必须是reaction的原始添加者
13547
13611
  */
@@ -13615,7 +13679,7 @@ class Client$1 {
13615
13679
  *
13616
13680
  * 获取消息表情回复
13617
13681
  *
13618
- * 获取指定消息的特定类型表情回复列表(reaction即表情回复,本说明文档统一用“reaction”代称)。
13682
+ * 获取指定消息的特定类型表情回复列表(reaction即表情回复,本文档统一用“reaction”代称)。
13619
13683
  *
13620
13684
  * 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app) ;- 待获取reaction信息的消息要真实存在,不能被撤回;- 获取消息的reaction,需要request的授权主体(机器人或者用户)在消息所在的会话内
13621
13685
  */
@@ -13636,7 +13700,7 @@ class Client$1 {
13636
13700
  }),
13637
13701
  },
13638
13702
  /**
13639
- * 消息
13703
+ * message.resource
13640
13704
  */
13641
13705
  messageResource: {
13642
13706
  /**
@@ -13648,7 +13712,7 @@ class Client$1 {
13648
13712
  *
13649
13713
  * 获取消息中的资源文件,包括音频,视频,图片和文件,**暂不支持表情包资源下载**。当前仅支持 100M 以内的资源文件的下载。
13650
13714
  *
13651
- * 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 机器人和消息需要在同一会话中;- 请求的 file_key 和 message_id 需要匹配;- 暂不支持获取合并转发消息中的子消息的资源文件;- 获取群组消息时,应用必须拥有 获取群组中所有的消息 权限
13715
+ * 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 机器人和消息需要在同一会话中;- 暂不支持获取合并转发消息中的子消息的资源文件
13652
13716
  */
13653
13717
  get: (payload, options) => __awaiter(this, void 0, void 0, function* () {
13654
13718
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -13692,7 +13756,9 @@ class Client$1 {
13692
13756
  *
13693
13757
  * Pin消息
13694
13758
  *
13695
- * Pin一条指定的消息
13759
+ * Pin一条指定的消息。
13760
+ *
13761
+ * 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app) ;- Pin消息时,机器人必须在对应的群组中;- 若消息已经被Pin,返回该Pin的操作信息;- 不能Pin一条对操作者不可见的消息;- 对同一条消息的Pin操作不能超过==5 QPS==
13696
13762
  */
13697
13763
  create: (payload, options) => __awaiter(this, void 0, void 0, function* () {
13698
13764
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -13716,7 +13782,9 @@ class Client$1 {
13716
13782
  *
13717
13783
  * 移除Pin消息
13718
13784
  *
13719
- * 移除一条指定消息的Pin
13785
+ * 移除一条指定消息的Pin
13786
+ *
13787
+ * 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app) ;- 移除Pin消息时,机器人必须在对应的群组中;- 若消息未被Pin或已被撤回,返回成功信息;- 不能移除一条对操作者不可见的Pin消息;- 对同一条消息移除Pin的操作不能超过==5 QPS==
13720
13788
  */
13721
13789
  delete: (payload, options) => __awaiter(this, void 0, void 0, function* () {
13722
13790
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -13788,7 +13856,9 @@ class Client$1 {
13788
13856
  *
13789
13857
  * 获取群内Pin消息
13790
13858
  *
13791
- * 获取所在群内指定时间范围内的所有Pin消息
13859
+ * 获取所在群内指定时间范围内的所有Pin消息。
13860
+ *
13861
+ * 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app) ;- 获取Pin消息时,机器人必须在群组中;- 获取的Pin消息按Pin的创建时间降序排列;- 接口默认限流为==50 QPS==
13792
13862
  */
13793
13863
  list: (payload, options) => __awaiter(this, void 0, void 0, function* () {
13794
13864
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -16766,7 +16836,7 @@ class Client$1 {
16766
16836
  *
16767
16837
  * 新增执行者
16768
16838
  *
16769
- * 该接口用于新增任务执行者,一次性可以添加多个执行者。新增的执行者必须是表示是用户的ID。
16839
+ * 该接口用于新增任务执行者,一次性可以添加多个执行者。新增的执行者必须是用户的ID。
16770
16840
  */
16771
16841
  create: (payload, options) => __awaiter(this, void 0, void 0, function* () {
16772
16842
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -17411,7 +17481,7 @@ class Client$1 {
17411
17481
  */
17412
17482
  this.vc = {
17413
17483
  /**
17414
- * alert
17484
+ * 告警中心
17415
17485
  */
17416
17486
  alert: {
17417
17487
  listWithIterator: (payload, options) => __awaiter(this, void 0, void 0, function* () {
@@ -17465,7 +17535,11 @@ class Client$1 {
17465
17535
  /**
17466
17536
  * {@link https://open.feishu.cn/api-explorer?project=vc&resource=alert&apiName=list&version=v1 click to debug }
17467
17537
  *
17468
- * {@link https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=list&project=vc&resource=alert&version=v1 document }
17538
+ * {@link https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/alert/list document }
17539
+ *
17540
+ * 获取告警记录
17541
+ *
17542
+ * 获取特定条件下租户的设备告警记录
17469
17543
  */
17470
17544
  list: (payload, options) => __awaiter(this, void 0, void 0, function* () {
17471
17545
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -17490,7 +17564,11 @@ class Client$1 {
17490
17564
  /**
17491
17565
  * {@link https://open.feishu.cn/api-explorer?project=vc&resource=export&apiName=download&version=v1 click to debug }
17492
17566
  *
17493
- * {@link https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=download&project=vc&resource=export&version=v1 document }
17567
+ * {@link https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/export/download document }
17568
+ *
17569
+ * 下载导出文件
17570
+ *
17571
+ * 下载导出文件
17494
17572
  */
17495
17573
  download: (payload, options) => __awaiter(this, void 0, void 0, function* () {
17496
17574
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -17553,7 +17631,7 @@ class Client$1 {
17553
17631
  *
17554
17632
  * 导出会议明细
17555
17633
  *
17556
- * 导出会议明细
17634
+ * 导出会议明细,具体权限要求请参考「导出概述」
17557
17635
  */
17558
17636
  meetingList: (payload, options) => __awaiter(this, void 0, void 0, function* () {
17559
17637
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -17577,7 +17655,7 @@ class Client$1 {
17577
17655
  *
17578
17656
  * 导出参会人明细
17579
17657
  *
17580
- * 导出某个会议的参会人详情列表
17658
+ * 导出某个会议的参会人详情列表,具体权限要求请参考「导出概述」
17581
17659
  */
17582
17660
  participantList: (payload, options) => __awaiter(this, void 0, void 0, function* () {
17583
17661
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -17601,7 +17679,7 @@ class Client$1 {
17601
17679
  *
17602
17680
  * 导出参会人会议质量数据
17603
17681
  *
17604
- * 导出某场会议某个参会人的音视频&共享质量数据
17682
+ * 导出某场会议某个参会人的音视频&共享质量数据;,具体权限要求请参考「导出概述」
17605
17683
  */
17606
17684
  participantQualityList: (payload, options) => __awaiter(this, void 0, void 0, function* () {
17607
17685
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -18125,6 +18203,59 @@ class Client$1 {
18125
18203
  });
18126
18204
  }),
18127
18205
  },
18206
+ /**
18207
+ * 会议室预定范围
18208
+ */
18209
+ reserveConfig: {
18210
+ /**
18211
+ * {@link https://open.feishu.cn/api-explorer?project=vc&resource=reserve_config&apiName=patch&version=v1 click to debug }
18212
+ *
18213
+ * {@link https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve_config/patch document }
18214
+ *
18215
+ * 更新会议室预定范围
18216
+ *
18217
+ * 更新会议室预定范围
18218
+ */
18219
+ patch: (payload, options) => __awaiter(this, void 0, void 0, function* () {
18220
+ const { headers, params, data, path } = yield this.formatPayload(payload, options);
18221
+ return httpInstance
18222
+ .request({
18223
+ url: fillApiPath(`${this.domain}/open-apis/vc/v1/reserve_configs/:reserve_config_id`, path),
18224
+ method: "PATCH",
18225
+ data,
18226
+ params,
18227
+ headers,
18228
+ })
18229
+ .catch((e) => {
18230
+ this.logger.error(formatErrors(e));
18231
+ throw e;
18232
+ });
18233
+ }),
18234
+ /**
18235
+ * {@link https://open.feishu.cn/api-explorer?project=vc&resource=reserve_config&apiName=reserve_scope&version=v1 click to debug }
18236
+ *
18237
+ * {@link https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/reserve_config/reserve_scope document }
18238
+ *
18239
+ * 获取会议室预定范围
18240
+ *
18241
+ * 获取会议室预定范围
18242
+ */
18243
+ reserveScope: (payload, options) => __awaiter(this, void 0, void 0, function* () {
18244
+ const { headers, params, data, path } = yield this.formatPayload(payload, options);
18245
+ return httpInstance
18246
+ .request({
18247
+ url: fillApiPath(`${this.domain}/open-apis/vc/v1/reserve_configs/reserve_scope`, path),
18248
+ method: "GET",
18249
+ data,
18250
+ params,
18251
+ headers,
18252
+ })
18253
+ .catch((e) => {
18254
+ this.logger.error(formatErrors(e));
18255
+ throw e;
18256
+ });
18257
+ }),
18258
+ },
18128
18259
  /**
18129
18260
  * 会议室配置
18130
18261
  */