@larksuiteoapi/node-sdk 1.6.2 → 1.7.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 (4) hide show
  1. package/es/index.js +253 -64
  2. package/lib/index.js +253 -64
  3. package/package.json +1 -1
  4. package/types/index.d.ts +587 -203
package/lib/index.js CHANGED
@@ -576,7 +576,7 @@ class Client$1 {
576
576
  },
577
577
  };
578
578
  /**
579
- * 管理后台-数据报表
579
+ * 管理后台-企业勋章
580
580
  */
581
581
  this.admin = {
582
582
  /**
@@ -2262,7 +2262,7 @@ class Client$1 {
2262
2262
  }),
2263
2263
  },
2264
2264
  /**
2265
- * 原生审批任务
2265
+ * 审批查询
2266
2266
  */
2267
2267
  task: {
2268
2268
  /**
@@ -3980,9 +3980,9 @@ class Client$1 {
3980
3980
  *
3981
3981
  * 获取多维表格元数据
3982
3982
  *
3983
- * 通过 app_token 获取多维表格元数据
3983
+ * 获取指定多维表格的元数据信息，包括多维表格名称，多维表格版本号，多维表格是否开启高级权限等。
3984
3984
  *
3985
- * 该接口支持调用频率上限为 20 QPS
3985
+ * 该接口支持调用频率上限为 20 QPS（Query Per Second，每秒请求率）
3986
3986
  */
3987
3987
  get: (payload, options) => __awaiter(this, void 0, void 0, function* () {
3988
3988
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -4867,7 +4867,7 @@ class Client$1 {
4867
4867
  *
4868
4868
  * 该接口用于在数据表中新增多条记录，单次调用最多新增 500 条记录。
4869
4869
  *
4870
- * 该接口支持调用频率上限为 10 QPS
4870
+ * 该接口支持调用频率上限为 10 QPS（Query Per Second，每秒请求率）
4871
4871
  */
4872
4872
  batchCreate: (payload, options) => __awaiter(this, void 0, void 0, function* () {
4873
4873
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -4945,7 +4945,7 @@ class Client$1 {
4945
4945
  *
4946
4946
  * 该接口用于在数据表中新增一条记录
4947
4947
  *
4948
- * 该接口支持调用频率上限为 10 QPS
4948
+ * 该接口支持调用频率上限为 10 QPS（Query Per Second，每秒请求率）
4949
4949
  */
4950
4950
  create: (payload, options) => __awaiter(this, void 0, void 0, function* () {
4951
4951
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -5071,7 +5071,7 @@ class Client$1 {
5071
5071
  *
5072
5072
  * 该接口用于列出数据表中的现有记录，单次最多列出 500 行记录，支持分页获取。
5073
5073
  *
5074
- * 该接口支持调用频率上限为 1000 次/分钟
5074
+ * 该接口支持调用频率上限为 10 QPS（Query Per Second，每秒请求率），1000 QPM（Query Per Minute，每分钟请求率）
5075
5075
  */
5076
5076
  list: (payload, options) => __awaiter(this, void 0, void 0, function* () {
5077
5077
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -5097,7 +5097,7 @@ class Client$1 {
5097
5097
  *
5098
5098
  * 该接口用于更新数据表中的一条记录
5099
5099
  *
5100
- * 该接口支持调用频率上限为 10 QPS
5100
+ * 该接口支持调用频率上限为 10 QPS（Query Per Second，每秒请求率）
5101
5101
  */
5102
5102
  update: (payload, options) => __awaiter(this, void 0, void 0, function* () {
5103
5103
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -8812,7 +8812,7 @@ class Client$1 {
8812
8812
  }),
8813
8813
  },
8814
8814
  /**
8815
- * 下载
8815
+ * 事件
8816
8816
  */
8817
8817
  file: {
8818
8818
  /**
@@ -11551,7 +11551,7 @@ class Client$1 {
11551
11551
  */
11552
11552
  this.hire = {
11553
11553
  /**
11554
- * 投递
11554
+ * 入职
11555
11555
  */
11556
11556
  application: {
11557
11557
  /**
@@ -12240,7 +12240,7 @@ class Client$1 {
12240
12240
  },
12241
12241
  };
12242
12242
  /**
12243
- * 消息与群组
12243
+ * 消息卡片
12244
12244
  */
12245
12245
  this.im = {
12246
12246
  /**
@@ -12256,7 +12256,7 @@ class Client$1 {
12256
12256
  *
12257
12257
  * 批量撤回通过[批量发送消息](https://open.feishu.cn/document/ukTMukTMukTM/ucDO1EjL3gTNx4yN4UTM)接口发送的消息。
12258
12258
  *
12259
- * 注意事项：;- 撤回单条发送的消息请使用[撤回消息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/delete)接口;- 不支持撤回发出时间超过1天的消息;- 一次调用涉及大量消息，所以为异步接口，会有一定延迟。
12259
+ * 注意事项：;- 应用需要启用[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability) ;- 撤回单条发送的消息请使用[撤回消息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/delete)接口;- 不支持撤回发出时间超过1天的消息;- 一次调用涉及大量消息，所以为异步接口，会有一定延迟。
12260
12260
  */
12261
12261
  delete: (payload, options) => __awaiter(this, void 0, void 0, function* () {
12262
12262
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -12339,7 +12339,7 @@ class Client$1 {
12339
12339
  *
12340
12340
  * 获取会话中的群公告信息，公告信息格式与[云文档](https://open.feishu.cn/document/ukTMukTMukTM/uAzM5YjLwMTO24CMzkjN)格式相同。
12341
12341
  *
12342
- * 注意事项：;- 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 机器人或授权用户必须在群里;- 获取内部群信息时，操作者须与群组在同一租户下
12342
+ * 注意事项：;- 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability);- 机器人或授权用户必须在群里;- 获取内部群信息时，操作者须与群组在同一租户下
12343
12343
  */
12344
12344
  get: (payload, options) => __awaiter(this, void 0, void 0, function* () {
12345
12345
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -12365,7 +12365,7 @@ class Client$1 {
12365
12365
  *
12366
12366
  * 更新会话中的群公告信息，更新公告信息的格式和更新[云文档](https://open.feishu.cn/document/ukTMukTMukTM/uAzM5YjLwMTO24CMzkjN)格式相同。
12367
12367
  *
12368
- * 注意事项：;- 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 机器人或授权用户必须在群里;- 操作者需要拥有群公告文档的阅读权限;- 获取内部群信息时，操作者须与群组在同一租户下;- 若群开启了 ==仅群主和群管理员可编辑群信息== 配置，群主/群管理员 或 创建群组且具备 ==更新应用所创建群的群信息== 权限的机器人，可更新群公告;- 若群未开启 ==仅群主和群管理员可编辑群信息== 配置，所有成员可以更新群公告
12368
+ * 注意事项：;- 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability);- 机器人或授权用户必须在群里;- 操作者需要拥有群公告文档的阅读权限;- 获取内部群信息时，操作者须与群组在同一租户下;- 若群开启了 ==仅群主和群管理员可编辑群信息== 配置，群主/群管理员 或 创建群组且具备 ==更新应用所创建群的群信息== 权限的机器人，可更新群公告;- 若群未开启 ==仅群主和群管理员可编辑群信息== 配置，所有成员可以更新群公告
12369
12369
  */
12370
12370
  patch: (payload, options) => __awaiter(this, void 0, void 0, function* () {
12371
12371
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -12396,7 +12396,7 @@ class Client$1 {
12396
12396
  *
12397
12397
  * 创建群并设置群头像、群名、群描述等。
12398
12398
  *
12399
- * 注意事项：; - 应用需要开启[机器人能力](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)接口
12399
+ * 注意事项：; - 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability);- 本接口支持在创建群的同时拉用户或机器人进群；如果仅需要拉用户或者机器人入群参考 [将用户或机器人拉入群聊](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-members/create)接口
12400
12400
  */
12401
12401
  create: (payload, options) => __awaiter(this, void 0, void 0, function* () {
12402
12402
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -12422,7 +12422,7 @@ class Client$1 {
12422
12422
  *
12423
12423
  * 解散群组。
12424
12424
  *
12425
- * 注意事项：;- 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 如果使用tenant_access_token，需要机器人符合以下任一情况才可解散群：; - 机器人是群主; - 机器人是群的创建者且具备==更新应用所创建群的群信息==权限;- 如果使用user_access_token，需要对应的用户是群主才可解散群
12425
+ * 注意事项：;- 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability);- 如果使用tenant_access_token，需要机器人符合以下任一情况才可解散群：; - 机器人是群主; - 机器人是群的创建者且具备==更新应用所创建群的群信息==权限;- 如果使用user_access_token，需要对应的用户是群主才可解散群
12426
12426
  */
12427
12427
  delete: (payload, options) => __awaiter(this, void 0, void 0, function* () {
12428
12428
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -12448,7 +12448,7 @@ class Client$1 {
12448
12448
  *
12449
12449
  * 获取群名称、群描述、群头像、群主 ID 等群基本信息。
12450
12450
  *
12451
- * 注意事项：; - 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app); - 机器人或授权用户必须在群里（否则只会返回群名称、群头像等基本信息）;- 获取内部群信息时，操作者须与群组在同一租户下
12451
+ * 注意事项：; - 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability); - 机器人或授权用户必须在群里（否则只会返回群名称、群头像等基本信息）;- 获取内部群信息时，操作者须与群组在同一租户下
12452
12452
  */
12453
12453
  get: (payload, options) => __awaiter(this, void 0, void 0, function* () {
12454
12454
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -12472,9 +12472,9 @@ class Client$1 {
12472
12472
  *
12473
12473
  * 获取群分享链接
12474
12474
  *
12475
- * 获取指定群的分享链接
12475
+ * 获取指定群的分享链接。
12476
12476
  *
12477
- * 注意事项:;- 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app); - 机器人或授权用户必须在群组中;- 单聊、密聊、团队群不支持分享群链接;- 当Bot被停用或Bot退出群组时，Bot生成的群链接也将停用;- 当群聊开启了 ==仅群主和群管理员可添加群成员/分享群== 设置时，仅**群主**和**群管理员**可以获取群分享链接;- 获取内部群分享链接时，操作者须与群组在同一租户下
12477
+ * 注意事项:;- 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability); - 机器人或授权用户必须在群组中;- 单聊、密聊、团队群不支持分享群链接;- 当Bot被停用或Bot退出群组时，Bot生成的群链接也将停用;- 当群聊开启了 ==仅群主和群管理员可添加群成员/分享群== 设置时，仅**群主**和**群管理员**可以获取群分享链接;- 获取内部群分享链接时，操作者须与群组在同一租户下
12478
12478
  */
12479
12479
  link: (payload, options) => __awaiter(this, void 0, void 0, function* () {
12480
12480
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -12548,7 +12548,7 @@ class Client$1 {
12548
12548
  *
12549
12549
  * 获取用户或者机器人所在群列表。
12550
12550
  *
12551
- * 注意事项：; - 应用需要开启[机器人能力](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单聊
12551
+ * 注意事项：; - 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability);- 请注意区分本接口和[获取群信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/get)的请求 URL;- 获取的群列表不包含P2P单聊
12552
12552
  */
12553
12553
  list: (payload, options) => __awaiter(this, void 0, void 0, function* () {
12554
12554
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -12622,7 +12622,7 @@ class Client$1 {
12622
12622
  *
12623
12623
  * 搜索对用户或机器人可见的群列表，包括：用户或机器人所在的群、对用户或机器人公开的群。;搜索可获得的群信息包括：群ID（chat_id）、群名称、群描述等。
12624
12624
  *
12625
- * 注意事项：; - 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app)
12625
+ * 注意事项：; - 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)
12626
12626
  */
12627
12627
  search: (payload, options) => __awaiter(this, void 0, void 0, function* () {
12628
12628
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -12648,7 +12648,7 @@ class Client$1 {
12648
12648
  *
12649
12649
  * 更新群头像、群名称、群描述、群配置、转让群主等。
12650
12650
  *
12651
- * 注意事项：;- 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 对于群主/群管理员 或 创建群组且具备 ==更新应用所创建群的群信息== 权限的机器人，可更新所有信息;- 对于不满足上述权限条件的群成员或机器人：; - 若未开启 ==仅群主和群管理员可编辑群信息== 配置，仅可更新群头像、群名称、群描述、群国际化名称信息; - 若开启了 ==仅群主和群管理员可编辑群信息== 配置，任何群信息都不能修改
12651
+ * 注意事项：;- 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability);- 对于群主/群管理员 或 创建群组且具备 ==更新应用所创建群的群信息== 权限的机器人，可更新所有信息;- 对于不满足上述权限条件的群成员或机器人：; - 若未开启 ==仅群主和群管理员可编辑群信息== 配置，仅可更新群头像、群名称、群描述、群国际化名称信息; - 若开启了 ==仅群主和群管理员可编辑群信息== 配置，任何群信息都不能修改;- 如果同时更新 ==邀请用户或机器人入群权限== 和 ==群分享权限== 这两项设置需要满足以下条件：; - 若未开启 ==仅群主和管理员可以邀请用户或机器人入群==，需要设置 ==群分享权限== 为 ==允许分享==; - 若开启了 ==仅群主和管理员可以邀请用户或机器人入群==，需要设置 ==群分享权限== 为 ==不允许分享==
12652
12652
  */
12653
12653
  update: (payload, options) => __awaiter(this, void 0, void 0, function* () {
12654
12654
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -12679,7 +12679,7 @@ class Client$1 {
12679
12679
  *
12680
12680
  * 将用户或机器人指定为群管理员。
12681
12681
  *
12682
- * 注意事项：; - 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 仅有群主可以指定群管理员
12682
+ * 注意事项：; - 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability);- 仅有群主可以指定群管理员
12683
12683
  */
12684
12684
  addManagers: (payload, options) => __awaiter(this, void 0, void 0, function* () {
12685
12685
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -12705,7 +12705,7 @@ class Client$1 {
12705
12705
  *
12706
12706
  * 删除指定的群管理员（用户或机器人）。
12707
12707
  *
12708
- * 注意事项：; - 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 仅有群主可以删除群管理员
12708
+ * 注意事项：; - 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability);- 仅有群主可以删除群管理员
12709
12709
  */
12710
12710
  deleteManagers: (payload, options) => __awaiter(this, void 0, void 0, function* () {
12711
12711
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -12736,7 +12736,7 @@ class Client$1 {
12736
12736
  *
12737
12737
  * 将用户或机器人拉入群聊。
12738
12738
  *
12739
- * 注意事项：; - 应用需要开启[机器人能力](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); - 机器人或授权用户必须在群组中;- 外部租户不能被加入到内部群中;- 操作内部群时，操作者须与群组在同一租户下; - 在开启 ==仅群主和群管理员可添加群成员== 的设置时，仅有群主/管理员 或 创建群组且具备 ==更新应用所创建群的群信息== 权限的机器人，可以拉用户或者机器人进群; - 在未开启 ==仅群主和群管理员可添加群成员== 的设置时，所有群成员都可以拉用户或机器人进群
12739
+ * 注意事项：; - 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability); - 如需拉用户进群，需要机器人对用户有[可用性](https://open.feishu.cn/document/home/introduction-to-scope-and-authorization/availability); - 机器人或授权用户必须在群组中;- 外部租户不能被加入到内部群中;- 操作内部群时，操作者须与群组在同一租户下; - 在开启 ==仅群主和群管理员可添加群成员== 的设置时，仅有群主/管理员 或 创建群组且具备 ==更新应用所创建群的群信息== 权限的机器人，可以拉用户或者机器人进群; - 在未开启 ==仅群主和群管理员可添加群成员== 的设置时，所有群成员都可以拉用户或机器人进群
12740
12740
  */
12741
12741
  create: (payload, options) => __awaiter(this, void 0, void 0, function* () {
12742
12742
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -12762,7 +12762,7 @@ class Client$1 {
12762
12762
  *
12763
12763
  * 将用户或机器人移出群聊。
12764
12764
  *
12765
- * 注意事项：; - 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 用户或机器人在任何条件下均可移除自己出群（即主动退群）;- 仅有群主/管理员 或 创建群组并且具备 ==更新应用所创建群的群信息== 权限的机器人，可以移除其他用户或者机器人;- 每次请求，最多移除50个用户或者5个机器人;- 操作内部群时，操作者须与群组在同一租户下
12765
+ * 注意事项：; - 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability);- 用户或机器人在任何条件下均可移除自己出群（即主动退群）;- 仅有群主/管理员 或 创建群组并且具备 ==更新应用所创建群的群信息== 权限的机器人，可以移除其他用户或者机器人;- 每次请求，最多移除50个用户或者5个机器人;- 操作内部群时，操作者须与群组在同一租户下
12766
12766
  */
12767
12767
  delete: (payload, options) => __awaiter(this, void 0, void 0, function* () {
12768
12768
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -12836,7 +12836,7 @@ class Client$1 {
12836
12836
  *
12837
12837
  * 获取用户/机器人所在群的群成员列表。
12838
12838
  *
12839
- * 注意事项：; - 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app); - 机器人或授权用户必须在群组中; - 该接口不会返回群内的机器人成员; - 由于返回的群成员列表会过滤掉机器人成员，因此返回的群成员个数可能会小于指定的page_size; - 如果有同一时间加入群的群成员，会一次性返回，这会导致返回的群成员个数可能会大于指定的page_size;- 获取内部群信息时，操作者须与群组在同一租户下
12839
+ * 注意事项：; - 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability); - 机器人或授权用户必须在群组中; - 该接口不会返回群内的机器人成员; - 由于返回的群成员列表会过滤掉机器人成员，因此返回的群成员个数可能会小于指定的page_size; - 如果有同一时间加入群的群成员，会一次性返回，这会导致返回的群成员个数可能会大于指定的page_size;- 获取内部群信息时，操作者须与群组在同一租户下
12840
12840
  */
12841
12841
  get: (payload, options) => __awaiter(this, void 0, void 0, function* () {
12842
12842
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -12862,7 +12862,7 @@ class Client$1 {
12862
12862
  *
12863
12863
  * 根据使用的access_token判断对应的用户或者机器人是否在群里。
12864
12864
  *
12865
- * 注意事项：; - 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 获取内部群信息时，操作者须与群组在同一租户下
12865
+ * 注意事项：; - 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability);- 获取内部群信息时，操作者须与群组在同一租户下
12866
12866
  */
12867
12867
  isInChat: (payload, options) => __awaiter(this, void 0, void 0, function* () {
12868
12868
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -12888,7 +12888,7 @@ class Client$1 {
12888
12888
  *
12889
12889
  * 用户或机器人主动加入群聊。
12890
12890
  *
12891
- * 注意事项：;- 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 目前仅支持加入公开群;- 操作内部群时，操作者须与群组在同一租户下
12891
+ * 注意事项：;- 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability);- 目前仅支持加入公开群;- 操作内部群时，操作者须与群组在同一租户下
12892
12892
  */
12893
12893
  meJoin: (payload, options) => __awaiter(this, void 0, void 0, function* () {
12894
12894
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -12967,7 +12967,7 @@ class Client$1 {
12967
12967
  *
12968
12968
  * 获取群发言模式、可发言用户名单等
12969
12969
  *
12970
- * 注意事项：; - 应用需要开启[机器人能力](https://open.feishu.cn/document/uQjL04CN/uYTMuYTMuYTM); - 机器人 或 授权用户 必须在群里
12970
+ * 注意事项：; - 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability); - 机器人 或 授权用户 必须在群里
12971
12971
  */
12972
12972
  get: (payload, options) => __awaiter(this, void 0, void 0, function* () {
12973
12973
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -12993,7 +12993,7 @@ class Client$1 {
12993
12993
  *
12994
12994
  * 更新群组的发言权限设置，可设置为全员可发言、仅管理员可发言 或 指定用户可发言。
12995
12995
  *
12996
- * 注意事项：; - 需要开启[机器人能力](https://open.feishu.cn/document/uQjL04CN/uYTMuYTMuYTM);- 若以用户授权调用接口，**当授权用户是群主**时，可更新群发言权限;- 若以租户授权调用接口(即以机器人身份调用接口)，当**机器人是群主** 或者 **机器人是群组创建者、具备==更新应用所创建群的群信息==权限且仍在群内**时，可更新群发言权限
12996
+ * 注意事项：; - 需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability);- 若以用户授权调用接口，**当授权用户是群主**时，可更新群发言权限;- 若以租户授权调用接口(即以机器人身份调用接口)，当**机器人是群主** 或者 **机器人是群组创建者、具备==更新应用所创建群的群信息==权限且仍在群内**时，可更新群发言权限
12997
12997
  */
12998
12998
  update: (payload, options) => __awaiter(this, void 0, void 0, function* () {
12999
12999
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -13024,7 +13024,7 @@ class Client$1 {
13024
13024
  *
13025
13025
  * 添加自定义会话标签页。
13026
13026
  *
13027
- * 注意事项：;- 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 机器人或授权用户必须在群里;- 只允许添加类型为`doc`和`url`的会话标签页;- 添加doc类型时，操作者（access token对应的身份）需要拥有对应文档的权限;- tab_config字段当前只对`url`类型的会话标签页生效;- 在开启 ==仅群主和管理员可管理标签页== 的设置时，仅群主和群管理员可以添加会话标签页;- 操作内部群时，操作者须与群组在同一租户下
13027
+ * 注意事项：;- 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability);- 机器人或授权用户必须在群里;- 只允许添加类型为`doc`和`url`的会话标签页;- 添加doc类型时，操作者（access token对应的身份）需要拥有对应文档的权限;- tab_config字段当前只对`url`类型的会话标签页生效;- 在开启 ==仅群主和管理员可管理标签页== 的设置时，仅群主和群管理员可以添加会话标签页;- 操作内部群时，操作者须与群组在同一租户下
13028
13028
  */
13029
13029
  create: (payload, options) => __awaiter(this, void 0, void 0, function* () {
13030
13030
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -13050,7 +13050,7 @@ class Client$1 {
13050
13050
  *
13051
13051
  * 删除会话标签页。
13052
13052
  *
13053
- * 注意事项：;- 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 机器人或授权用户必须在群里;- 只允许删除类型为`doc`和`url`的会话标签页;- 在开启 ==仅群主和管理员可管理标签页== 的设置时，仅群主和群管理员可以删除会话标签页;- 操作内部群时，操作者须与群组在同一租户下
13053
+ * 注意事项：;- 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability);- 机器人或授权用户必须在群里;- 只允许删除类型为`doc`和`url`的会话标签页;- 在开启 ==仅群主和管理员可管理标签页== 的设置时，仅群主和群管理员可以删除会话标签页;- 操作内部群时，操作者须与群组在同一租户下
13054
13054
  */
13055
13055
  deleteTabs: (payload, options) => __awaiter(this, void 0, void 0, function* () {
13056
13056
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -13076,7 +13076,7 @@ class Client$1 {
13076
13076
  *
13077
13077
  * 拉取会话标签页。
13078
13078
  *
13079
- * 注意事项：;- 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 机器人或授权用户必须在群里;- 操作内部群时，操作者须与群组在同一租户下
13079
+ * 注意事项：;- 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability);- 机器人或授权用户必须在群里;- 操作内部群时，操作者须与群组在同一租户下
13080
13080
  */
13081
13081
  listTabs: (payload, options) => __awaiter(this, void 0, void 0, function* () {
13082
13082
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -13102,7 +13102,7 @@ class Client$1 {
13102
13102
  *
13103
13103
  * 会话标签页排序。
13104
13104
  *
13105
- * 注意事项：;- 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 机器人或授权用户必须在群里;- 消息标签页强制固定为第一顺位，不参与排序，但是请求体中必须包含该标签页的Tab ID;- 操作内部群时，操作者须与群组在同一租户下
13105
+ * 注意事项：;- 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability);- 机器人或授权用户必须在群里;- 消息标签页强制固定为第一顺位，不参与排序，但是请求体中必须包含该标签页的Tab ID;- 操作内部群时，操作者须与群组在同一租户下
13106
13106
  */
13107
13107
  sortTabs: (payload, options) => __awaiter(this, void 0, void 0, function* () {
13108
13108
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -13128,7 +13128,7 @@ class Client$1 {
13128
13128
  *
13129
13129
  * 更新会话标签页
13130
13130
  *
13131
- * 注意事项：;- 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 机器人或授权用户必须在群里;- 只允许更新类型为`doc`和`url`的会话标签页;- 更新doc类型时，操作者（access token对应的身份）需要拥有对应文档的权限;- 在开启 ==仅群主和管理员可管理标签页== 的设置时，仅群主和群管理员可以更新会话标签页;- 操作内部群时，操作者须与群组在同一租户下
13131
+ * 注意事项：;- 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability);- 机器人或授权用户必须在群里;- 只允许更新类型为`doc`和`url`的会话标签页;- 更新doc类型时，操作者（access token对应的身份）需要拥有对应文档的权限;- 在开启 ==仅群主和管理员可管理标签页== 的设置时，仅群主和群管理员可以更新会话标签页;- 操作内部群时，操作者须与群组在同一租户下
13132
13132
  */
13133
13133
  updateTabs: (payload, options) => __awaiter(this, void 0, void 0, function* () {
13134
13134
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -13159,7 +13159,7 @@ class Client$1 {
13159
13159
  *
13160
13160
  * 撤销会话中的置顶。
13161
13161
  *
13162
- * 注意事项：; - 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app); - 机器人或授权用户必须在群组中;- 撤销内部群置顶时，操作者须与群组在同一租户下
13162
+ * 注意事项：; - 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability); - 机器人或授权用户必须在群组中;- 撤销内部群置顶时，操作者须与群组在同一租户下
13163
13163
  */
13164
13164
  deleteTopNotice: (payload, options) => __awaiter(this, void 0, void 0, function* () {
13165
13165
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -13185,7 +13185,7 @@ class Client$1 {
13185
13185
  *
13186
13186
  * 更新会话中的群置顶信息，可以将群中的某一条消息，或者群公告置顶显示。
13187
13187
  *
13188
- * 注意事项：; - 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app); - 机器人或授权用户必须在群组中;- 更新内部群置顶时，操作者须与群组在同一租户下
13188
+ * 注意事项：; - 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability); - 机器人或授权用户必须在群组中;- 更新内部群置顶时，操作者须与群组在同一租户下
13189
13189
  */
13190
13190
  putTopNotice: (payload, options) => __awaiter(this, void 0, void 0, function* () {
13191
13191
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -13216,7 +13216,7 @@ class Client$1 {
13216
13216
  *
13217
13217
  * 上传文件，可以上传视频，音频和常见的文件类型。
13218
13218
  *
13219
- * 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 文件大小不得超过30M，且不允许上传空文件
13219
+ * 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability);- 文件大小不得超过30M，且不允许上传空文件
13220
13220
  */
13221
13221
  create: (payload, options) => __awaiter(this, void 0, void 0, function* () {
13222
13222
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -13243,7 +13243,7 @@ class Client$1 {
13243
13243
  *
13244
13244
  * 下载文件接口，只能下载应用自己上传的文件。
13245
13245
  *
13246
- * 注意事项:;- 需要开启[机器人能力](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
13246
+ * 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability);- 只能下载机器人自己上传的文件;- 下载用户发送的资源，请使用[获取消息中的资源文件](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message-resource/get)接口;- 下载的资源大小不能超过100M;- 如果需要Content-Disposition header，发起请求的时候需要在header中设置Content-Type为application/json
13247
13247
  */
13248
13248
  get: (payload, options) => __awaiter(this, void 0, void 0, function* () {
13249
13249
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -13289,7 +13289,7 @@ class Client$1 {
13289
13289
  *
13290
13290
  * 上传图片接口，支持上传 JPEG、PNG、WEBP、GIF、TIFF、BMP、ICO格式图片。
13291
13291
  *
13292
- * 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 图片大小不得超过10M，且不支持上传大小为0的图片
13292
+ * 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability);- 图片大小不得超过10M，且不支持上传大小为0的图片
13293
13293
  */
13294
13294
  create: (payload, options) => __awaiter(this, void 0, void 0, function* () {
13295
13295
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -13316,7 +13316,7 @@ class Client$1 {
13316
13316
  *
13317
13317
  * 下载图片资源，只能下载当前应用所上传且图片类型为message的图片。
13318
13318
  *
13319
- * 注意事项:;- 需要开启[机器人能力](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)接口
13319
+ * 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability);- 只能下载机器人自己上传且图片类型为message的图片，avatar类型暂不支持下载;- 下载用户发送的资源，请使用[获取消息中的资源文件](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message-resource/get)接口
13320
13320
  */
13321
13321
  get: (payload, options) => __awaiter(this, void 0, void 0, function* () {
13322
13322
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -13362,7 +13362,7 @@ class Client$1 {
13362
13362
  *
13363
13363
  * 给指定用户或者会话发送消息，支持文本、富文本、可交互的[消息卡片](https://open.feishu.cn/document/ukTMukTMukTM/uczM3QjL3MzN04yNzcDN)、群名片、个人名片、图片、视频、音频、文件、表情包。
13364
13364
  *
13365
- * 注意事项:;- 需要开启[机器人能力](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);- 给群组发送消息，需要机器人在群组中
13365
+ * 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability) ;- 给用户发送消息，需要机器人对用户有[可用性](https://open.feishu.cn/document/home/introduction-to-scope-and-authorization/availability);- 给群组发送消息，需要机器人在群组中
13366
13366
  */
13367
13367
  create: (payload, options) => __awaiter(this, void 0, void 0, function* () {
13368
13368
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -13388,7 +13388,7 @@ class Client$1 {
13388
13388
  *
13389
13389
  * 机器人撤回机器人自己发送的消息或群主撤回群内消息。
13390
13390
  *
13391
- * 注意事项:;- 需要开启[机器人能力](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)」接口发送的消息
13391
+ * 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability) ，撤回消息时机器人仍需要在会话内;- 机器人可以撤回单聊和群组内，自己发送 且 发送时间不超过1天(24小时)的消息;- 若机器人要撤回群内他人发送的消息，则机器人必须是该群的群主、管理员 或者 创建者，且消息发送时间不超过1年;- 无法撤回通过「[批量发送消息](https://open.feishu.cn/document/ukTMukTMukTM/ucDO1EjL3gTNx4yN4UTM)」接口发送的消息
13392
13392
  */
13393
13393
  delete: (payload, options) => __awaiter(this, void 0, void 0, function* () {
13394
13394
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -13414,7 +13414,7 @@ class Client$1 {
13414
13414
  *
13415
13415
  * 通过 message_id 查询消息内容。
13416
13416
  *
13417
- * 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app) ;- 机器人必须在群组中
13417
+ * 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability) ;- 机器人必须在群组中
13418
13418
  */
13419
13419
  get: (payload, options) => __awaiter(this, void 0, void 0, function* () {
13420
13420
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -13488,7 +13488,7 @@ class Client$1 {
13488
13488
  *
13489
13489
  * 获取会话（包括单聊、群组）的历史消息（聊天记录）。
13490
13490
  *
13491
- * - 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app) ;- 获取消息时，机器人必须在群组中
13491
+ * - 需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability) ;- 获取消息时，机器人必须在群组中
13492
13492
  *
13493
13493
  * 接口级别权限默认只能获取单聊（p2p）消息，如果需要获取群组（group）消息，应用还必须拥有 **==获取群组中所有消息==** 权限
13494
13494
  */
@@ -13516,7 +13516,7 @@ class Client$1 {
13516
13516
  *
13517
13517
  * 更新应用已发送的消息卡片内容。
13518
13518
  *
13519
- * 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 若以user_access_token更新消息，该操作用户必须是卡片消息的发送者;- 仅支持对所有人更新**未撤回**的[「共享卡片」](ukTMukTMukTM/uAjNwUjLwYDM14CM2ATN)消息，需在卡片的config属性中，显式声明 =="update_multi":true==。 ;- **不支持更新批量消息**;- 文本消息请求体最大不能超过150KB；卡片及富文本消息请求体最大不能超过30KB;- 仅支持修改14天内发送的消息;- 单条消息更新频控为**5QPS**
13519
+ * 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability);- 若以user_access_token更新消息，该操作用户必须是卡片消息的发送者;- 仅支持对所有人更新**未撤回**的[「共享卡片」](ukTMukTMukTM/uAjNwUjLwYDM14CM2ATN)消息，需在卡片的config属性中，显式声明 =="update_multi":true==。 ;- **不支持更新批量消息**;- 文本消息请求体最大不能超过150KB；卡片及富文本消息请求体最大不能超过30KB;- 仅支持修改14天内发送的消息;- 单条消息更新频控为**5QPS**
13520
13520
  */
13521
13521
  patch: (payload, options) => __awaiter(this, void 0, void 0, function* () {
13522
13522
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -13542,7 +13542,7 @@ class Client$1 {
13542
13542
  *
13543
13543
  * 查询消息的已读信息。
13544
13544
  *
13545
- * 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app) ;- 只能查询机器人自己发送，且发送时间不超过7天的消息;- 查询消息已读信息时机器人仍需要在会话内;- 本接口不支持查询批量消息
13545
+ * 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability) ;- 只能查询机器人自己发送，且发送时间不超过7天的消息;- 查询消息已读信息时机器人仍需要在会话内;- 本接口不支持查询批量消息
13546
13546
  */
13547
13547
  readUsers: (payload, options) => __awaiter(this, void 0, void 0, function* () {
13548
13548
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -13568,7 +13568,7 @@ class Client$1 {
13568
13568
  *
13569
13569
  * 回复指定消息，支持文本、富文本、卡片、群名片、个人名片、图片、视频、文件等多种消息类型。
13570
13570
  *
13571
- * 注意事项:;- 需要开启[机器人能力](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);- 回复群组消息，需要机器人在群中
13571
+ * 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability) ;- 回复私聊消息，需要机器人对用户有[可用性](https://open.feishu.cn/document/home/introduction-to-scope-and-authorization/availability);- 回复群组消息，需要机器人在群中
13572
13572
  */
13573
13573
  reply: (payload, options) => __awaiter(this, void 0, void 0, function* () {
13574
13574
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -13594,7 +13594,7 @@ class Client$1 {
13594
13594
  *
13595
13595
  * 对指定消息进行应用内加急。
13596
13596
  *
13597
- * 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app) ;- 不支持加急批量消息;- 只能加急机器人自己发送的消息;- 加急时机器人需要在加急消息所在的群中;- 调用本接口需要用户已阅读加急的消息才可以继续加急（用户未读的加急上限为200条）
13597
+ * 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability) ;- 不支持加急批量消息;- 只能加急机器人自己发送的消息;- 加急时机器人需要在加急消息所在的群中;- 调用本接口需要用户已阅读加急的消息才可以继续加急（用户未读的加急上限为200条）
13598
13598
  *
13599
13599
  * 特别说明：;- 默认接口限流为50 QPS，请谨慎调用
13600
13600
  */
@@ -13622,7 +13622,7 @@ class Client$1 {
13622
13622
  *
13623
13623
  * 对指定消息进行应用内加急与电话加急。
13624
13624
  *
13625
- * 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app) ;- 只能加急机器人自己发送的消息;- 加急时机器人需要在加急消息所在的群组中;- 需要用户阅读已加急的消息才可以继续加急（用户未读的加急上限为200条）
13625
+ * 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability) ;- 只能加急机器人自己发送的消息;- 加急时机器人需要在加急消息所在的群组中;- 需要用户阅读已加急的消息才可以继续加急（用户未读的加急上限为200条）
13626
13626
  *
13627
13627
  * 特别说明：;- 通过接口产生的电话加急将消耗企业的加急额度，请慎重调用;- 通过[租户管理后台](https://admin.feishu.cn/)-费用中心-短信/电话加急 可以查看当前额度;- 默认接口限流为50 QPS，请谨慎调用
13628
13628
  */
@@ -13650,7 +13650,7 @@ class Client$1 {
13650
13650
  *
13651
13651
  * 对指定消息进行应用内加急与短信加急。
13652
13652
  *
13653
- * 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app) ;- 只能加急机器人自己发送的消息;- 加急时机器人仍需要在加急消息所在的群组中;- 调用本接口需要用户已阅读加急的消息才可以继续加急（用户未读的加急上限为200条）
13653
+ * 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability) ;- 只能加急机器人自己发送的消息;- 加急时机器人仍需要在加急消息所在的群组中;- 调用本接口需要用户已阅读加急的消息才可以继续加急（用户未读的加急上限为200条）
13654
13654
  *
13655
13655
  * 特别说明：;- 通过接口产生的短信加急将消耗企业的加急额度，请慎重调用;- 通过[租户管理后台](https://admin.feishu.cn/)-费用中心-短信/电话加急 可以查看当前额度;- 默认接口限流为50 QPS，请谨慎调用
13656
13656
  */
@@ -13683,7 +13683,7 @@ class Client$1 {
13683
13683
  *
13684
13684
  * 给指定消息添加指定类型的表情回复（reaction即表情回复，本文档统一用“reaction”代称）。
13685
13685
  *
13686
- * 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app) ;- 待添加reaction的消息要真实存在，不能被撤回;- 给消息添加reaction，需要reaction的发送方（机器人或者用户）在消息所在的会话内
13686
+ * 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability) ;- 待添加reaction的消息要真实存在，不能被撤回;- 给消息添加reaction，需要reaction的发送方（机器人或者用户）在消息所在的会话内
13687
13687
  */
13688
13688
  create: (payload, options) => __awaiter(this, void 0, void 0, function* () {
13689
13689
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -13709,7 +13709,7 @@ class Client$1 {
13709
13709
  *
13710
13710
  * 删除指定消息的表情回复（reaction即表情回复，本文档统一用“reaction”代称）。
13711
13711
  *
13712
- * 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app) ;- 只能删除真实存在的reaction，并且删除reaction请求的操作者必须是reaction的原始添加者
13712
+ * 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability) ;- 只能删除真实存在的reaction，并且删除reaction请求的操作者必须是reaction的原始添加者
13713
13713
  */
13714
13714
  delete: (payload, options) => __awaiter(this, void 0, void 0, function* () {
13715
13715
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -13783,7 +13783,7 @@ class Client$1 {
13783
13783
  *
13784
13784
  * 获取指定消息的特定类型表情回复列表（reaction即表情回复，本文档统一用“reaction”代称）。
13785
13785
  *
13786
- * 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app) ;- 待获取reaction信息的消息要真实存在，不能被撤回;- 获取消息的reaction，需要request的授权主体（机器人或者用户）在消息所在的会话内
13786
+ * 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability) ;- 待获取reaction信息的消息要真实存在，不能被撤回;- 获取消息的reaction，需要request的授权主体（机器人或者用户）在消息所在的会话内
13787
13787
  */
13788
13788
  list: (payload, options) => __awaiter(this, void 0, void 0, function* () {
13789
13789
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -13814,7 +13814,7 @@ class Client$1 {
13814
13814
  *
13815
13815
  * 获取消息中的资源文件，包括音频，视频，图片和文件，**暂不支持表情包资源下载**。当前仅支持 100M 以内的资源文件的下载。
13816
13816
  *
13817
- * 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 机器人和消息需要在同一会话中;- 暂不支持获取合并转发消息中的子消息的资源文件
13817
+ * 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability);- 机器人和消息需要在同一会话中;- 暂不支持获取合并转发消息中的子消息的资源文件
13818
13818
  */
13819
13819
  get: (payload, options) => __awaiter(this, void 0, void 0, function* () {
13820
13820
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -13860,7 +13860,7 @@ class Client$1 {
13860
13860
  *
13861
13861
  * Pin一条指定的消息。
13862
13862
  *
13863
- * 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app) ;- Pin消息时，机器人必须在对应的群组中;- 若消息已经被Pin，返回该Pin的操作信息;- 不能Pin一条对操作者不可见的消息;- 对同一条消息的Pin操作不能超过==5 QPS==
13863
+ * 注意事项:;- 需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability) ;- Pin消息时，机器人必须在对应的群组中;- 若消息已经被Pin，返回该Pin的操作信息;- 不能Pin一条对操作者不可见的消息;- 对同一条消息的Pin操作不能超过==5 QPS==
13864
13864
  */
13865
13865
  create: (payload, options) => __awaiter(this, void 0, void 0, function* () {
13866
13866
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -13886,7 +13886,7 @@ class Client$1 {
13886
13886
  *
13887
13887
  * 移除一条指定消息的Pin。
13888
13888
  *
13889
- * 注意事项：;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app) ;- 移除Pin消息时，机器人必须在对应的群组中;- 若消息未被Pin或已被撤回，返回成功信息;- 不能移除一条对操作者不可见的Pin消息;- 对同一条消息移除Pin的操作不能超过==5 QPS==
13889
+ * 注意事项：;- 需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability) ;- 移除Pin消息时，机器人必须在对应的群组中;- 若消息未被Pin或已被撤回，返回成功信息;- 不能移除一条对操作者不可见的Pin消息;- 对同一条消息移除Pin的操作不能超过==5 QPS==
13890
13890
  */
13891
13891
  delete: (payload, options) => __awaiter(this, void 0, void 0, function* () {
13892
13892
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -13960,7 +13960,7 @@ class Client$1 {
13960
13960
  *
13961
13961
  * 获取所在群内指定时间范围内的所有Pin消息。
13962
13962
  *
13963
- * 注意事项：;- 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app) ;- 获取Pin消息时，机器人必须在群组中;- 获取的Pin消息按Pin的创建时间降序排列;- 接口默认限流为==50 QPS==
13963
+ * 注意事项：;- 需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability) ;- 获取Pin消息时，机器人必须在群组中;- 获取的Pin消息按Pin的创建时间降序排列;- 接口默认限流为==50 QPS==
13964
13964
  */
13965
13965
  list: (payload, options) => __awaiter(this, void 0, void 0, function* () {
13966
13966
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -15232,6 +15232,165 @@ class Client$1 {
15232
15232
  return get__default["default"](res, "data", {});
15233
15233
  }),
15234
15234
  },
15235
+ /**
15236
+ * 指标库
15237
+ */
15238
+ metricSource: {
15239
+ /**
15240
+ * {@link https://open.feishu.cn/api-explorer?project=okr&resource=metric_source&apiName=list&version=v1 click to debug }
15241
+ *
15242
+ * {@link https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/metric_source/list document }
15243
+ *
15244
+ * 获取指标库
15245
+ *
15246
+ * 获取租户下全部 OKR 指标库（仅限 OKR 企业版使用）
15247
+ */
15248
+ list: (payload, options) => __awaiter(this, void 0, void 0, function* () {
15249
+ const { headers, params, data, path } = yield this.formatPayload(payload, options);
15250
+ return httpInstance
15251
+ .request({
15252
+ url: fillApiPath(`${this.domain}/open-apis/okr/v1/metric_sources`, path),
15253
+ method: "GET",
15254
+ data,
15255
+ params,
15256
+ headers,
15257
+ })
15258
+ .catch((e) => {
15259
+ this.logger.error(formatErrors(e));
15260
+ throw e;
15261
+ });
15262
+ }),
15263
+ },
15264
+ /**
15265
+ * 指标项
15266
+ */
15267
+ metricSourceTableItem: {
15268
+ /**
15269
+ * {@link https://open.feishu.cn/api-explorer?project=okr&resource=metric_source.table.item&apiName=batch_update&version=v1 click to debug }
15270
+ *
15271
+ * {@link https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/metric_source-table-item/batch_update document }
15272
+ *
15273
+ * 批量更新指标项
15274
+ *
15275
+ * - 该接口用于批量更新多项指标，单次调用最多更新 100 条记录。接口仅限 OKR 企业版使用。;; 更新成功后 OKR 系统会给以下人员发送消息通知：;; - 首次更新目标值的人员 ;; - 已经将指标添加为 KR、且本次目标值/起始值/支撑的上级有变更的人员，不包含仅更新了进度值的人员
15276
+ */
15277
+ batchUpdate: (payload, options) => __awaiter(this, void 0, void 0, function* () {
15278
+ const { headers, params, data, path } = yield this.formatPayload(payload, options);
15279
+ return httpInstance
15280
+ .request({
15281
+ url: fillApiPath(`${this.domain}/open-apis/okr/v1/metric_sources/:metric_source_id/tables/:metric_table_id/items/batch_update`, path),
15282
+ method: "PATCH",
15283
+ data,
15284
+ params,
15285
+ headers,
15286
+ })
15287
+ .catch((e) => {
15288
+ this.logger.error(formatErrors(e));
15289
+ throw e;
15290
+ });
15291
+ }),
15292
+ /**
15293
+ * {@link https://open.feishu.cn/api-explorer?project=okr&resource=metric_source.table.item&apiName=get&version=v1 click to debug }
15294
+ *
15295
+ * {@link https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/metric_source-table-item/get document }
15296
+ *
15297
+ * 获取指标项详情
15298
+ *
15299
+ * 获取某项指标的具体内容（仅限 OKR 企业版使用）
15300
+ */
15301
+ get: (payload, options) => __awaiter(this, void 0, void 0, function* () {
15302
+ const { headers, params, data, path } = yield this.formatPayload(payload, options);
15303
+ return httpInstance
15304
+ .request({
15305
+ url: fillApiPath(`${this.domain}/open-apis/okr/v1/metric_sources/:metric_source_id/tables/:metric_table_id/items/:metric_item_id`, path),
15306
+ method: "GET",
15307
+ data,
15308
+ params,
15309
+ headers,
15310
+ })
15311
+ .catch((e) => {
15312
+ this.logger.error(formatErrors(e));
15313
+ throw e;
15314
+ });
15315
+ }),
15316
+ /**
15317
+ * {@link https://open.feishu.cn/api-explorer?project=okr&resource=metric_source.table.item&apiName=list&version=v1 click to debug }
15318
+ *
15319
+ * {@link https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/metric_source-table-item/list document }
15320
+ *
15321
+ * 获取指标项
15322
+ *
15323
+ * 获取指定指标表下的所有指标项（仅限 OKR 企业版使用）
15324
+ */
15325
+ list: (payload, options) => __awaiter(this, void 0, void 0, function* () {
15326
+ const { headers, params, data, path } = yield this.formatPayload(payload, options);
15327
+ return httpInstance
15328
+ .request({
15329
+ url: fillApiPath(`${this.domain}/open-apis/okr/v1/metric_sources/:metric_source_id/tables/:metric_table_id/items`, path),
15330
+ method: "GET",
15331
+ data,
15332
+ params,
15333
+ headers,
15334
+ })
15335
+ .catch((e) => {
15336
+ this.logger.error(formatErrors(e));
15337
+ throw e;
15338
+ });
15339
+ }),
15340
+ /**
15341
+ * {@link https://open.feishu.cn/api-explorer?project=okr&resource=metric_source.table.item&apiName=patch&version=v1 click to debug }
15342
+ *
15343
+ * {@link https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/metric_source-table-item/patch document }
15344
+ *
15345
+ * 更新指标项
15346
+ *
15347
+ * - 该接口用于更新某项指标，接口仅限 OKR 企业版使用。;; 更新成功后 OKR 系统会给以下人员发送消息通知：;; - 首次更新目标值的人员 ;; - 已经将指标添加为 KR、且本次目标值/起始值/支撑的上级有变更的人员，不包含仅更新了进度值的人员
15348
+ */
15349
+ patch: (payload, options) => __awaiter(this, void 0, void 0, function* () {
15350
+ const { headers, params, data, path } = yield this.formatPayload(payload, options);
15351
+ return httpInstance
15352
+ .request({
15353
+ url: fillApiPath(`${this.domain}/open-apis/okr/v1/metric_sources/:metric_source_id/tables/:metric_table_id/items/:metric_item_id`, path),
15354
+ method: "PATCH",
15355
+ data,
15356
+ params,
15357
+ headers,
15358
+ })
15359
+ .catch((e) => {
15360
+ this.logger.error(formatErrors(e));
15361
+ throw e;
15362
+ });
15363
+ }),
15364
+ },
15365
+ /**
15366
+ * 指标表
15367
+ */
15368
+ metricSourceTable: {
15369
+ /**
15370
+ * {@link https://open.feishu.cn/api-explorer?project=okr&resource=metric_source.table&apiName=list&version=v1 click to debug }
15371
+ *
15372
+ * {@link https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/metric_source-table/list document }
15373
+ *
15374
+ * 获取指标表
15375
+ *
15376
+ * 获取指定指标库下有哪些指标表（仅限 OKR 企业版使用）
15377
+ */
15378
+ list: (payload, options) => __awaiter(this, void 0, void 0, function* () {
15379
+ const { headers, params, data, path } = yield this.formatPayload(payload, options);
15380
+ return httpInstance
15381
+ .request({
15382
+ url: fillApiPath(`${this.domain}/open-apis/okr/v1/metric_sources/:metric_source_id/tables`, path),
15383
+ method: "GET",
15384
+ data,
15385
+ params,
15386
+ headers,
15387
+ })
15388
+ .catch((e) => {
15389
+ this.logger.error(formatErrors(e));
15390
+ throw e;
15391
+ });
15392
+ }),
15393
+ },
15235
15394
  /**
15236
15395
  * OKR
15237
15396
  */
@@ -15395,6 +15554,35 @@ class Client$1 {
15395
15554
  });
15396
15555
  }),
15397
15556
  },
15557
+ /**
15558
+ * 复盘（灰度租户可见）
15559
+ */
15560
+ review: {
15561
+ /**
15562
+ * {@link https://open.feishu.cn/api-explorer?project=okr&resource=review&apiName=query&version=v1 click to debug }
15563
+ *
15564
+ * {@link https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/review/query document }
15565
+ *
15566
+ * 查询复盘信息
15567
+ *
15568
+ * 根据周期和用户查询复盘信息。
15569
+ */
15570
+ query: (payload, options) => __awaiter(this, void 0, void 0, function* () {
15571
+ const { headers, params, data, path } = yield this.formatPayload(payload, options);
15572
+ return httpInstance
15573
+ .request({
15574
+ url: fillApiPath(`${this.domain}/open-apis/okr/v1/reviews/query`, path),
15575
+ method: "GET",
15576
+ data,
15577
+ params,
15578
+ headers,
15579
+ })
15580
+ .catch((e) => {
15581
+ this.logger.error(formatErrors(e));
15582
+ throw e;
15583
+ });
15584
+ }),
15585
+ },
15398
15586
  /**
15399
15587
  * 用户OKR
15400
15588
  */
@@ -16326,7 +16514,7 @@ class Client$1 {
16326
16514
  }),
16327
16515
  },
16328
16516
  /**
16329
- * 工作表
16517
+ * 行列
16330
16518
  */
16331
16519
  spreadsheetSheet: {
16332
16520
  /**
@@ -19761,16 +19949,17 @@ class RequestHandle {
19761
19949
  parse(data) {
19762
19950
  const targetData = (() => {
19763
19951
  var _a;
19764
- if ('encrypt' in data) {
19952
+ const _b = data || {}, { encrypt } = _b, rest = __rest(_b, ["encrypt"]);
19953
+ if (encrypt) {
19765
19954
  try {
19766
- return JSON.parse((_a = this.aesCipher) === null || _a === void 0 ? void 0 : _a.decrypt(data.encrypt));
19955
+ return Object.assign(Object.assign({}, JSON.parse((_a = this.aesCipher) === null || _a === void 0 ? void 0 : _a.decrypt(encrypt))), rest);
19767
19956
  }
19768
19957
  catch (e) {
19769
19958
  this.logger.error('parse encrypt data failed');
19770
- return '';
19959
+ return {};
19771
19960
  }
19772
19961
  }
19773
- return data;
19962
+ return rest;
19774
19963
  })();
19775
19964
  // v1和v2版事件的区别：https://open.feishu.cn/document/ukTMukTMukTM/uUTNz4SN1MjL1UzM
19776
19965
  if ('schema' in targetData) {