@larksuiteoapi/node-sdk 1.4.1 → 1.5.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/README.md CHANGED
@@ -478,6 +478,9 @@ import * as lark from '@larksuiteoapi/node-sdk';
478
478
  new lark.AESCipher('encrypt key').decrypt('content');
479
479
  ````
480
480
 
481
+ ## Examples
482
+ [Rapidly develop auto-responder bot](https://github.com/larksuite/lark-samples/blob/main/react_and_nodejs/robot/README.zh.md)
483
+
481
484
  ## Blog
482
485
  [ISV Application Development Guide](https://bytedance.feishu.cn/docx/RUZKdGwdyoH4KexMJgDcITQnn0b)
483
486
 
package/README.zh.md CHANGED
@@ -477,6 +477,9 @@ import * as lark from '@larksuiteoapi/node-sdk';
477
477
  new lark.AESCipher('encrypt key').decrypt('content');
478
478
  ```
479
479
 
480
+ ## Examples
481
+ [快速开发自动回复机器人](https://github.com/larksuite/lark-samples/blob/main/react_and_nodejs/robot/README.zh.md)
482
+
480
483
  ## Blog
481
484
  [ISV(商店应用)开发指南](https://bytedance.feishu.cn/docx/RUZKdGwdyoH4KexMJgDcITQnn0b)
482
485
 
package/es/index.js CHANGED
@@ -1012,6 +1012,83 @@ class Client$1 {
1012
1012
  * 应用信息
1013
1013
  */
1014
1014
  this.application = {
1015
+ /**
1016
+ * 推荐规则
1017
+ */
1018
+ appRecommendRule: {
1019
+ listWithIterator: (payload, options) => __awaiter(this, void 0, void 0, function* () {
1020
+ const { headers, params, data, path } = yield this.formatPayload(payload, options);
1021
+ const sendRequest = (innerPayload) => __awaiter(this, void 0, void 0, function* () {
1022
+ const res = yield httpInstance
1023
+ .request({
1024
+ url: fillApiPath(`${this.domain}/open-apis/application/v6/app_recommend_rules`, path),
1025
+ method: "GET",
1026
+ headers: pickBy(innerPayload.headers, identity),
1027
+ params: pickBy(innerPayload.params, identity),
1028
+ })
1029
+ .catch((e) => {
1030
+ this.logger.error(formatErrors(e));
1031
+ });
1032
+ return res;
1033
+ });
1034
+ const Iterable = {
1035
+ [Symbol.asyncIterator]() {
1036
+ return __asyncGenerator(this, arguments, function* _a() {
1037
+ let hasMore = true;
1038
+ let pageToken;
1039
+ while (hasMore) {
1040
+ try {
1041
+ const res = yield __await(sendRequest({
1042
+ headers,
1043
+ params: Object.assign(Object.assign({}, params), { page_token: pageToken }),
1044
+ data,
1045
+ }));
1046
+ const _b = get(res, "data") || {}, {
1047
+ // @ts-ignore
1048
+ has_more,
1049
+ // @ts-ignore
1050
+ page_token,
1051
+ // @ts-ignore
1052
+ next_page_token } = _b, rest = __rest(_b, ["has_more", "page_token", "next_page_token"]);
1053
+ yield yield __await(rest);
1054
+ hasMore = Boolean(has_more);
1055
+ pageToken = page_token || next_page_token;
1056
+ }
1057
+ catch (e) {
1058
+ yield yield __await(null);
1059
+ break;
1060
+ }
1061
+ }
1062
+ });
1063
+ },
1064
+ };
1065
+ return Iterable;
1066
+ }),
1067
+ /**
1068
+ * {@link https://open.feishu.cn/api-explorer?project=application&resource=app_recommend_rule&apiName=list&version=v6 click to debug }
1069
+ *
1070
+ * {@link https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/app_recommend_rule/list document }
1071
+ *
1072
+ * 获取当前设置的推荐规则列表
1073
+ *
1074
+ * 获取当前设置的推荐规则列表。
1075
+ */
1076
+ list: (payload, options) => __awaiter(this, void 0, void 0, function* () {
1077
+ const { headers, params, data, path } = yield this.formatPayload(payload, options);
1078
+ return httpInstance
1079
+ .request({
1080
+ url: fillApiPath(`${this.domain}/open-apis/application/v6/app_recommend_rules`, path),
1081
+ method: "GET",
1082
+ data,
1083
+ params,
1084
+ headers,
1085
+ })
1086
+ .catch((e) => {
1087
+ this.logger.error(formatErrors(e));
1088
+ throw e;
1089
+ });
1090
+ }),
1091
+ },
1015
1092
  /**
1016
1093
  * 应用使用情况
1017
1094
  */
@@ -1352,7 +1429,7 @@ class Client$1 {
1352
1429
  */
1353
1430
  this.approval = {
1354
1431
  /**
1355
- * 原生审批定义
1432
+ * 事件
1356
1433
  */
1357
1434
  approval: {
1358
1435
  /**
@@ -1862,7 +1939,7 @@ class Client$1 {
1862
1939
  *
1863
1940
  * 批量获取审批实例ID
1864
1941
  *
1865
- * 根据 approval_code 批量获取审批实例的 instance_code,用于拉取租户下某个审批定义的全部审批实例。默认以审批创建时间排序
1942
+ * 根据 approval_code 批量获取审批实例的 instance_code,用于拉取租户下某个审批定义的全部审批实例。默认以审批创建时间先后顺序排列
1866
1943
  */
1867
1944
  list: (payload, options) => __awaiter(this, void 0, void 0, function* () {
1868
1945
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -2170,7 +2247,7 @@ class Client$1 {
2170
2247
  }),
2171
2248
  },
2172
2249
  /**
2173
- * 审批查询
2250
+ * 原生审批任务
2174
2251
  */
2175
2252
  task: {
2176
2253
  /**
@@ -3771,7 +3848,7 @@ class Client$1 {
3771
3848
  },
3772
3849
  };
3773
3850
  /**
3774
- * 云文档-多维表格
3851
+ * 云文档-电子表格
3775
3852
  */
3776
3853
  this.bitable = {
3777
3854
  /**
@@ -6035,7 +6112,7 @@ class Client$1 {
6035
6112
  *
6036
6113
  * 该接口用于以当前身份(应用 / 用户)获取日历下的日程列表。;身份由 Header Authorization 的 Token 类型决定。
6037
6114
  *
6038
- * - 当前身份必须对日历有reader、writer或owner权限才会返回日程详细信息(调用[获取日历](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/get)接口,role字段可查看权限)。;;- 仅支持primary、shared和resource类型的日历获取日程列表。;;- 调用时首先使用 page_token 分页拉取存量数据,之后使用 sync_token 增量同步变更数据。;;- 为了确保调用方日程同步数据的一致性,在使用sync_token时,不能同时使用start_time和end_time,否则可能造成日程数据缺失。
6115
+ * - 当前身份必须对日历有reader、writer或owner权限才会返回日程详细信息(调用[获取日历](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/get)接口,role字段可查看权限)。;;- 仅支持primary、shared和resource类型的日历获取日程列表。;;- page_token 分页拉取存量数据,sync_token 增量同步变更数据;目前仅传anchor_time时,会返回page_token。;;- 为了确保调用方日程同步数据的一致性,在使用sync_token时,不能同时使用start_time和end_time,否则可能造成日程数据缺失。
6039
6116
  */
6040
6117
  list: (payload, options) => __awaiter(this, void 0, void 0, function* () {
6041
6118
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -8610,9 +8687,9 @@ class Client$1 {
8610
8687
  *
8611
8688
  * {@link https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-comment/list document }
8612
8689
  *
8613
- * 获取文档评论
8690
+ * 分页获取文档评论
8614
8691
  *
8615
- * 根据文档token分页获取云文档中的评论。
8692
+ * 该接口用于根据文档 token 分页获取文档评论。
8616
8693
  */
8617
8694
  list: (payload, options) => __awaiter(this, void 0, void 0, function* () {
8618
8695
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -8708,7 +8785,7 @@ class Client$1 {
8708
8785
  }),
8709
8786
  },
8710
8787
  /**
8711
- * 下载
8788
+ * 文件夹
8712
8789
  */
8713
8790
  file: {
8714
8791
  /**
@@ -9247,7 +9324,7 @@ class Client$1 {
9247
9324
  }),
9248
9325
  },
9249
9326
  /**
9250
- * 素材
9327
+ * 分片上传
9251
9328
  */
9252
9329
  media: {
9253
9330
  /**
@@ -12243,7 +12320,7 @@ class Client$1 {
12243
12320
  *
12244
12321
  * 获取会话中的群公告信息,公告信息格式与[云文档](https://open.feishu.cn/document/ukTMukTMukTM/uAzM5YjLwMTO24CMzkjN)格式相同。
12245
12322
  *
12246
- * 注意事项:;- 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app)
12323
+ * 注意事项:;- 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 机器人或授权用户必须在群里;- 获取内部群信息时,操作者须与群组在同一租户下
12247
12324
  */
12248
12325
  get: (payload, options) => __awaiter(this, void 0, void 0, function* () {
12249
12326
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -12269,7 +12346,7 @@ class Client$1 {
12269
12346
  *
12270
12347
  * 更新会话中的群公告信息,更新公告信息的格式和更新[云文档](https://open.feishu.cn/document/ukTMukTMukTM/uAzM5YjLwMTO24CMzkjN)格式相同。
12271
12348
  *
12272
- * 注意事项:;- 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 若群开启了 ==仅群主和群管理员可编辑群信息== 配置,群主/群管理员 或 创建群组且具备 ==更新应用所创建群的群信息== 权限的机器人,可更新群公告;- 若群未开启 ==仅群主和群管理员可编辑群信息== 配置,所有成员可以更新群公告
12349
+ * 注意事项:;- 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 机器人或授权用户必须在群里;- 操作者需要拥有群公告文档的阅读权限;- 获取内部群信息时,操作者须与群组在同一租户下;- 若群开启了 ==仅群主和群管理员可编辑群信息== 配置,群主/群管理员 或 创建群组且具备 ==更新应用所创建群的群信息== 权限的机器人,可更新群公告;- 若群未开启 ==仅群主和群管理员可编辑群信息== 配置,所有成员可以更新群公告
12273
12350
  */
12274
12351
  patch: (payload, options) => __awaiter(this, void 0, void 0, function* () {
12275
12352
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -12452,7 +12529,7 @@ class Client$1 {
12452
12529
  *
12453
12530
  * 获取用户或者机器人所在群列表。
12454
12531
  *
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单聊群
12532
+ * 注意事项:; - 应用需要开启[机器人能力](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单聊
12456
12533
  */
12457
12534
  list: (payload, options) => __awaiter(this, void 0, void 0, function* () {
12458
12535
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -12583,7 +12660,7 @@ class Client$1 {
12583
12660
  *
12584
12661
  * 将用户或机器人指定为群管理员。
12585
12662
  *
12586
- * 注意事项:; - 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 仅有群主可以指定群管理员;- 对于普通群,最多指定 10 个管理员;- 对于超大群,最多指定 20 个管理员;- 每次请求最多指定 50 个用户或者 5 个机器人;- 指定机器人类型的管理员请使用 ==app_id==
12663
+ * 注意事项:; - 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 仅有群主可以指定群管理员
12587
12664
  */
12588
12665
  addManagers: (payload, options) => __awaiter(this, void 0, void 0, function* () {
12589
12666
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -12609,7 +12686,7 @@ class Client$1 {
12609
12686
  *
12610
12687
  * 删除指定的群管理员(用户或机器人)。
12611
12688
  *
12612
- * 注意事项:; - 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 仅有群主可以删除群管理员;- 每次请求最多指定 50 个用户或者 5 个机器人;- 删除机器人类型的管理员请使用 ==app_id==
12689
+ * 注意事项:; - 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 仅有群主可以删除群管理员
12613
12690
  */
12614
12691
  deleteManagers: (payload, options) => __awaiter(this, void 0, void 0, function* () {
12615
12692
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -12666,7 +12743,7 @@ class Client$1 {
12666
12743
  *
12667
12744
  * 将用户或机器人移出群聊。
12668
12745
  *
12669
- * 注意事项:; - 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 用户或机器人在任何条件下均可移除自己出群(即主动退群);- 仅有群主/管理员 或 创建群组并且具备 ==更新应用所创建群的群信息== 权限的机器人,可以移除其他用户或者机器人; - 每次请求,最多移除50个用户或者5个机器人
12746
+ * 注意事项:; - 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 用户或机器人在任何条件下均可移除自己出群(即主动退群);- 仅有群主/管理员 或 创建群组并且具备 ==更新应用所创建群的群信息== 权限的机器人,可以移除其他用户或者机器人;- 每次请求,最多移除50个用户或者5个机器人;- 操作内部群时,操作者须与群组在同一租户下;- 操作外部群时,请先在[开发者后台](https://open.feishu.cn/app)—权限管理—权限配置页面申请 ==在外部群调用群聊的 API 及事件== 权限
12670
12747
  */
12671
12748
  delete: (payload, options) => __awaiter(this, void 0, void 0, function* () {
12672
12749
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -12738,9 +12815,9 @@ class Client$1 {
12738
12815
  *
12739
12816
  * 获取群成员列表
12740
12817
  *
12741
- * 如果用户在群中,则返回该群的成员列表。
12818
+ * 获取用户/机器人所在群的群成员列表。
12742
12819
  *
12743
- * 注意事项:; - 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app); - 该接口不会返回群内的机器人成员; - 由于返回的群成员列表会过滤掉机器人成员,因此返回的群成员个数可能会小于指定的page_size; - 如果有同一时间加入群的群成员,会一次性返回,这会导致返回的群成员个数可能会大于指定的page_size
12820
+ * 注意事项:; - 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app); - 机器人或授权用户必须在群组中; - 该接口不会返回群内的机器人成员; - 由于返回的群成员列表会过滤掉机器人成员,因此返回的群成员个数可能会小于指定的page_size; - 如果有同一时间加入群的群成员,会一次性返回,这会导致返回的群成员个数可能会大于指定的page_size;- 获取内部群信息时,操作者须与群组在同一租户下;- 获取外部群信息时,请先在[开发者后台](https://open.feishu.cn/app)—权限管理—权限配置页面申请 ==在外部群调用群聊的 API 及事件== 权限
12744
12821
  */
12745
12822
  get: (payload, options) => __awaiter(this, void 0, void 0, function* () {
12746
12823
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -12765,6 +12842,8 @@ class Client$1 {
12765
12842
  * 判断用户或机器人是否在群里
12766
12843
  *
12767
12844
  * 根据使用的access_token判断对应的用户或者机器人是否在群里。
12845
+ *
12846
+ * 注意事项:; - 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 获取内部群信息时,操作者须与群组在同一租户下;- 获取外部群信息时,请先在[开发者后台](https://open.feishu.cn/app)—权限管理—权限配置页面申请 ==在外部群调用群聊的 API 及事件== 权限
12768
12847
  */
12769
12848
  isInChat: (payload, options) => __awaiter(this, void 0, void 0, function* () {
12770
12849
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -12790,7 +12869,7 @@ class Client$1 {
12790
12869
  *
12791
12870
  * 用户或机器人主动加入群聊。
12792
12871
  *
12793
- * 注意事项:;- 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app); - 目前仅支持加入公开群
12872
+ * 注意事项:;- 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 目前仅支持加入公开群;- 操作内部群时,操作者须与群组在同一租户下
12794
12873
  */
12795
12874
  meJoin: (payload, options) => __awaiter(this, void 0, void 0, function* () {
12796
12875
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -12924,9 +13003,9 @@ class Client$1 {
12924
13003
  *
12925
13004
  * 添加会话标签页
12926
13005
  *
12927
- * 添加自定义会话标签页
13006
+ * 添加自定义会话标签页。
12928
13007
  *
12929
- * 注意事项:;;- 只允许添加类型为doc和url的会话标签页;;- 创建时不需要设置tabID;;- 一个群内最多只允许添加20个自定义会话标签页;;- 会话标签页的名称不超过30个字符;;- 添加doc类型时,操作者(access token对应的身份)需要拥有对应文档的权限
13008
+ * 注意事项:;- 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 机器人或授权用户必须在群里;- 不需要填写请求体中的`tab_id`字段;- 只允许添加类型为`doc`和`url`的会话标签页;- 添加doc类型时,操作者(access token对应的身份)需要拥有对应文档的权限;- 操作内部群时,操作者须与群组在同一租户下;- 操作外部群时,请先在[开发者后台](https://open.feishu.cn/app)—权限管理—权限配置页面申请 ==在外部群调用群聊的 API 及事件== 权限
12930
13009
  */
12931
13010
  create: (payload, options) => __awaiter(this, void 0, void 0, function* () {
12932
13011
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -12950,7 +13029,9 @@ class Client$1 {
12950
13029
  *
12951
13030
  * 删除会话标签页
12952
13031
  *
12953
- * 删除会话标签页
13032
+ * 删除会话标签页。
13033
+ *
13034
+ * 注意事项:;- 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 机器人或授权用户必须在群里;- 只允许删除类型为`doc`和`url`的会话标签页;- 操作内部群时,操作者须与群组在同一租户下;- 操作外部群时,请先在[开发者后台](https://open.feishu.cn/app)—权限管理—权限配置页面申请 ==在外部群调用群聊的 API 及事件== 权限
12954
13035
  */
12955
13036
  deleteTabs: (payload, options) => __awaiter(this, void 0, void 0, function* () {
12956
13037
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -12974,7 +13055,9 @@ class Client$1 {
12974
13055
  *
12975
13056
  * 拉取会话标签页
12976
13057
  *
12977
- * 拉取会话标签页
13058
+ * 拉取会话标签页。
13059
+ *
13060
+ * 注意事项:;- 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 机器人或授权用户必须在群里;- 操作内部群时,操作者须与群组在同一租户下;- 操作外部群时,请先在[开发者后台](https://open.feishu.cn/app)—权限管理—权限配置页面申请 ==在外部群调用群聊的 API 及事件== 权限
12978
13061
  */
12979
13062
  listTabs: (payload, options) => __awaiter(this, void 0, void 0, function* () {
12980
13063
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -12998,9 +13081,9 @@ class Client$1 {
12998
13081
  *
12999
13082
  * 会话标签页排序
13000
13083
  *
13001
- * 会话标签页排序
13084
+ * 会话标签页排序。
13002
13085
  *
13003
- * 注意事项:;;- 当前消息标签页固定为第一顺位,不参与排序,但是请求体中必须包含。;;- 请求体必须包含全部的TabID
13086
+ * 注意事项:;- 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 机器人或授权用户必须在群里;- 消息标签页强制固定为第一顺位,不参与排序,但是请求体中必须包含该标签页的Tab ID;- 操作内部群时,操作者须与群组在同一租户下;- 操作外部群时,请先在[开发者后台](https://open.feishu.cn/app)—权限管理—权限配置页面申请 ==在外部群调用群聊的 API 及事件== 权限
13004
13087
  */
13005
13088
  sortTabs: (payload, options) => __awaiter(this, void 0, void 0, function* () {
13006
13089
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -13026,7 +13109,7 @@ class Client$1 {
13026
13109
  *
13027
13110
  * 更新会话标签页
13028
13111
  *
13029
- * 注意事项:;;- 只允许更新类型为docurl的会话标签页;;- 会话标签页的名称不超过30个字符;;- 更新doc类型时,操作者(access token对应的身份)需要拥有对应文档的权限
13112
+ * 注意事项:;- 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 机器人或授权用户必须在群里;- 只允许更新类型为`doc`和`url`的会话标签页;- 更新doc类型时,操作者(access token对应的身份)需要拥有对应文档的权限;- 操作内部群时,操作者须与群组在同一租户下;- 操作外部群时,请先在[开发者后台](https://open.feishu.cn/app)—权限管理—权限配置页面申请 ==在外部群调用群聊的 API 及事件== 权限
13030
13113
  */
13031
13114
  updateTabs: (payload, options) => __awaiter(this, void 0, void 0, function* () {
13032
13115
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -13248,7 +13331,7 @@ class Client$1 {
13248
13331
  }),
13249
13332
  },
13250
13333
  /**
13251
- * 消息 - 消息卡片
13334
+ * 消息
13252
13335
  */
13253
13336
  message: {
13254
13337
  /**
@@ -13388,7 +13471,7 @@ class Client$1 {
13388
13471
  *
13389
13472
  * - 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app) ;- 获取消息时,机器人必须在群组中
13390
13473
  *
13391
- * 接口级别权限默认只能获取单聊(p2p)消息,如果需要获取群组(group)消息,应用还必须拥有 ***获取群组中所有消息*** 权限
13474
+ * 接口级别权限默认只能获取单聊(p2p)消息,如果需要获取群组(group)消息,应用还必须拥有 **==获取群组中所有消息==** 权限
13392
13475
  */
13393
13476
  list: (payload, options) => __awaiter(this, void 0, void 0, function* () {
13394
13477
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -13414,7 +13497,7 @@ class Client$1 {
13414
13497
  *
13415
13498
  * 更新应用已发送的消息卡片内容。
13416
13499
  *
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**
13500
+ * 注意事项:;- 需要开启[机器人能力](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**
13418
13501
  */
13419
13502
  patch: (payload, options) => __awaiter(this, void 0, void 0, function* () {
13420
13503
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -15790,7 +15873,7 @@ class Client$1 {
15790
15873
  *
15791
15874
  * 创建表格
15792
15875
  *
15793
- * 使用该接口可以在指定的目录下创建在线表格。
15876
+ * 在指定目录下创建表格
15794
15877
  */
15795
15878
  create: (payload, options) => __awaiter(this, void 0, void 0, function* () {
15796
15879
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -16224,7 +16307,7 @@ class Client$1 {
16224
16307
  }),
16225
16308
  },
16226
16309
  /**
16227
- * 行列
16310
+ * 单元格
16228
16311
  */
16229
16312
  spreadsheetSheet: {
16230
16313
  /**
@@ -16234,7 +16317,7 @@ class Client$1 {
16234
16317
  *
16235
16318
  * 查找单元格
16236
16319
  *
16237
- * 按照指定的条件查找子表的某个范围内的数据符合条件的单元格位置。请求体中的 range 和 find 字段为必填。
16320
+ * 在指定范围内查找符合查找条件的单元格。
16238
16321
  */
16239
16322
  find: (payload, options) => __awaiter(this, void 0, void 0, function* () {
16240
16323
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -17696,6 +17779,30 @@ class Client$1 {
17696
17779
  throw e;
17697
17780
  });
17698
17781
  }),
17782
+ /**
17783
+ * {@link https://open.feishu.cn/api-explorer?project=vc&resource=export&apiName=resource_reservation_list&version=v1 click to debug }
17784
+ *
17785
+ * {@link https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/export/resource_reservation_list document }
17786
+ *
17787
+ * 导出会议室预定数据
17788
+ *
17789
+ * 导出会议室预定数据,具体权限要求请参考「导出概述」
17790
+ */
17791
+ resourceReservationList: (payload, options) => __awaiter(this, void 0, void 0, function* () {
17792
+ const { headers, params, data, path } = yield this.formatPayload(payload, options);
17793
+ return httpInstance
17794
+ .request({
17795
+ url: fillApiPath(`${this.domain}/open-apis/vc/v1/exports/resource_reservation_list`, path),
17796
+ method: "POST",
17797
+ data,
17798
+ params,
17799
+ headers,
17800
+ })
17801
+ .catch((e) => {
17802
+ this.logger.error(formatErrors(e));
17803
+ throw e;
17804
+ });
17805
+ }),
17699
17806
  },
17700
17807
  /**
17701
17808
  * 会议
@@ -18204,7 +18311,7 @@ class Client$1 {
18204
18311
  }),
18205
18312
  },
18206
18313
  /**
18207
- * 会议室预定范围
18314
+ * reserve_config
18208
18315
  */
18209
18316
  reserveConfig: {
18210
18317
  /**
package/lib/index.js CHANGED
@@ -1027,6 +1027,83 @@ class Client$1 {
1027
1027
  * 应用信息
1028
1028
  */
1029
1029
  this.application = {
1030
+ /**
1031
+ * 推荐规则
1032
+ */
1033
+ appRecommendRule: {
1034
+ listWithIterator: (payload, options) => __awaiter(this, void 0, void 0, function* () {
1035
+ const { headers, params, data, path } = yield this.formatPayload(payload, options);
1036
+ const sendRequest = (innerPayload) => __awaiter(this, void 0, void 0, function* () {
1037
+ const res = yield httpInstance
1038
+ .request({
1039
+ url: fillApiPath(`${this.domain}/open-apis/application/v6/app_recommend_rules`, path),
1040
+ method: "GET",
1041
+ headers: pickBy__default["default"](innerPayload.headers, identity__default["default"]),
1042
+ params: pickBy__default["default"](innerPayload.params, identity__default["default"]),
1043
+ })
1044
+ .catch((e) => {
1045
+ this.logger.error(formatErrors(e));
1046
+ });
1047
+ return res;
1048
+ });
1049
+ const Iterable = {
1050
+ [Symbol.asyncIterator]() {
1051
+ return __asyncGenerator(this, arguments, function* _a() {
1052
+ let hasMore = true;
1053
+ let pageToken;
1054
+ while (hasMore) {
1055
+ try {
1056
+ const res = yield __await(sendRequest({
1057
+ headers,
1058
+ params: Object.assign(Object.assign({}, params), { page_token: pageToken }),
1059
+ data,
1060
+ }));
1061
+ const _b = get__default["default"](res, "data") || {}, {
1062
+ // @ts-ignore
1063
+ has_more,
1064
+ // @ts-ignore
1065
+ page_token,
1066
+ // @ts-ignore
1067
+ next_page_token } = _b, rest = __rest(_b, ["has_more", "page_token", "next_page_token"]);
1068
+ yield yield __await(rest);
1069
+ hasMore = Boolean(has_more);
1070
+ pageToken = page_token || next_page_token;
1071
+ }
1072
+ catch (e) {
1073
+ yield yield __await(null);
1074
+ break;
1075
+ }
1076
+ }
1077
+ });
1078
+ },
1079
+ };
1080
+ return Iterable;
1081
+ }),
1082
+ /**
1083
+ * {@link https://open.feishu.cn/api-explorer?project=application&resource=app_recommend_rule&apiName=list&version=v6 click to debug }
1084
+ *
1085
+ * {@link https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/app_recommend_rule/list document }
1086
+ *
1087
+ * 获取当前设置的推荐规则列表
1088
+ *
1089
+ * 获取当前设置的推荐规则列表。
1090
+ */
1091
+ list: (payload, options) => __awaiter(this, void 0, void 0, function* () {
1092
+ const { headers, params, data, path } = yield this.formatPayload(payload, options);
1093
+ return httpInstance
1094
+ .request({
1095
+ url: fillApiPath(`${this.domain}/open-apis/application/v6/app_recommend_rules`, path),
1096
+ method: "GET",
1097
+ data,
1098
+ params,
1099
+ headers,
1100
+ })
1101
+ .catch((e) => {
1102
+ this.logger.error(formatErrors(e));
1103
+ throw e;
1104
+ });
1105
+ }),
1106
+ },
1030
1107
  /**
1031
1108
  * 应用使用情况
1032
1109
  */
@@ -1367,7 +1444,7 @@ class Client$1 {
1367
1444
  */
1368
1445
  this.approval = {
1369
1446
  /**
1370
- * 原生审批定义
1447
+ * 事件
1371
1448
  */
1372
1449
  approval: {
1373
1450
  /**
@@ -1877,7 +1954,7 @@ class Client$1 {
1877
1954
  *
1878
1955
  * 批量获取审批实例ID
1879
1956
  *
1880
- * 根据 approval_code 批量获取审批实例的 instance_code,用于拉取租户下某个审批定义的全部审批实例。默认以审批创建时间排序
1957
+ * 根据 approval_code 批量获取审批实例的 instance_code,用于拉取租户下某个审批定义的全部审批实例。默认以审批创建时间先后顺序排列
1881
1958
  */
1882
1959
  list: (payload, options) => __awaiter(this, void 0, void 0, function* () {
1883
1960
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -2185,7 +2262,7 @@ class Client$1 {
2185
2262
  }),
2186
2263
  },
2187
2264
  /**
2188
- * 审批查询
2265
+ * 原生审批任务
2189
2266
  */
2190
2267
  task: {
2191
2268
  /**
@@ -3786,7 +3863,7 @@ class Client$1 {
3786
3863
  },
3787
3864
  };
3788
3865
  /**
3789
- * 云文档-多维表格
3866
+ * 云文档-电子表格
3790
3867
  */
3791
3868
  this.bitable = {
3792
3869
  /**
@@ -6050,7 +6127,7 @@ class Client$1 {
6050
6127
  *
6051
6128
  * 该接口用于以当前身份(应用 / 用户)获取日历下的日程列表。;身份由 Header Authorization 的 Token 类型决定。
6052
6129
  *
6053
- * - 当前身份必须对日历有reader、writer或owner权限才会返回日程详细信息(调用[获取日历](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/get)接口,role字段可查看权限)。;;- 仅支持primary、shared和resource类型的日历获取日程列表。;;- 调用时首先使用 page_token 分页拉取存量数据,之后使用 sync_token 增量同步变更数据。;;- 为了确保调用方日程同步数据的一致性,在使用sync_token时,不能同时使用start_time和end_time,否则可能造成日程数据缺失。
6130
+ * - 当前身份必须对日历有reader、writer或owner权限才会返回日程详细信息(调用[获取日历](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/get)接口,role字段可查看权限)。;;- 仅支持primary、shared和resource类型的日历获取日程列表。;;- page_token 分页拉取存量数据,sync_token 增量同步变更数据;目前仅传anchor_time时,会返回page_token。;;- 为了确保调用方日程同步数据的一致性,在使用sync_token时,不能同时使用start_time和end_time,否则可能造成日程数据缺失。
6054
6131
  */
6055
6132
  list: (payload, options) => __awaiter(this, void 0, void 0, function* () {
6056
6133
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -8625,9 +8702,9 @@ class Client$1 {
8625
8702
  *
8626
8703
  * {@link https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-comment/list document }
8627
8704
  *
8628
- * 获取文档评论
8705
+ * 分页获取文档评论
8629
8706
  *
8630
- * 根据文档token分页获取云文档中的评论。
8707
+ * 该接口用于根据文档 token 分页获取文档评论。
8631
8708
  */
8632
8709
  list: (payload, options) => __awaiter(this, void 0, void 0, function* () {
8633
8710
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -8723,7 +8800,7 @@ class Client$1 {
8723
8800
  }),
8724
8801
  },
8725
8802
  /**
8726
- * 下载
8803
+ * 文件夹
8727
8804
  */
8728
8805
  file: {
8729
8806
  /**
@@ -9262,7 +9339,7 @@ class Client$1 {
9262
9339
  }),
9263
9340
  },
9264
9341
  /**
9265
- * 素材
9342
+ * 分片上传
9266
9343
  */
9267
9344
  media: {
9268
9345
  /**
@@ -12258,7 +12335,7 @@ class Client$1 {
12258
12335
  *
12259
12336
  * 获取会话中的群公告信息,公告信息格式与[云文档](https://open.feishu.cn/document/ukTMukTMukTM/uAzM5YjLwMTO24CMzkjN)格式相同。
12260
12337
  *
12261
- * 注意事项:;- 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app)
12338
+ * 注意事项:;- 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 机器人或授权用户必须在群里;- 获取内部群信息时,操作者须与群组在同一租户下
12262
12339
  */
12263
12340
  get: (payload, options) => __awaiter(this, void 0, void 0, function* () {
12264
12341
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -12284,7 +12361,7 @@ class Client$1 {
12284
12361
  *
12285
12362
  * 更新会话中的群公告信息,更新公告信息的格式和更新[云文档](https://open.feishu.cn/document/ukTMukTMukTM/uAzM5YjLwMTO24CMzkjN)格式相同。
12286
12363
  *
12287
- * 注意事项:;- 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 若群开启了 ==仅群主和群管理员可编辑群信息== 配置,群主/群管理员 或 创建群组且具备 ==更新应用所创建群的群信息== 权限的机器人,可更新群公告;- 若群未开启 ==仅群主和群管理员可编辑群信息== 配置,所有成员可以更新群公告
12364
+ * 注意事项:;- 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 机器人或授权用户必须在群里;- 操作者需要拥有群公告文档的阅读权限;- 获取内部群信息时,操作者须与群组在同一租户下;- 若群开启了 ==仅群主和群管理员可编辑群信息== 配置,群主/群管理员 或 创建群组且具备 ==更新应用所创建群的群信息== 权限的机器人,可更新群公告;- 若群未开启 ==仅群主和群管理员可编辑群信息== 配置,所有成员可以更新群公告
12288
12365
  */
12289
12366
  patch: (payload, options) => __awaiter(this, void 0, void 0, function* () {
12290
12367
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -12467,7 +12544,7 @@ class Client$1 {
12467
12544
  *
12468
12545
  * 获取用户或者机器人所在群列表。
12469
12546
  *
12470
- * 注意事项:; - 应用需要开启[机器人能力](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单聊群
12547
+ * 注意事项:; - 应用需要开启[机器人能力](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单聊
12471
12548
  */
12472
12549
  list: (payload, options) => __awaiter(this, void 0, void 0, function* () {
12473
12550
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -12598,7 +12675,7 @@ class Client$1 {
12598
12675
  *
12599
12676
  * 将用户或机器人指定为群管理员。
12600
12677
  *
12601
- * 注意事项:; - 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 仅有群主可以指定群管理员;- 对于普通群,最多指定 10 个管理员;- 对于超大群,最多指定 20 个管理员;- 每次请求最多指定 50 个用户或者 5 个机器人;- 指定机器人类型的管理员请使用 ==app_id==
12678
+ * 注意事项:; - 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 仅有群主可以指定群管理员
12602
12679
  */
12603
12680
  addManagers: (payload, options) => __awaiter(this, void 0, void 0, function* () {
12604
12681
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -12624,7 +12701,7 @@ class Client$1 {
12624
12701
  *
12625
12702
  * 删除指定的群管理员(用户或机器人)。
12626
12703
  *
12627
- * 注意事项:; - 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 仅有群主可以删除群管理员;- 每次请求最多指定 50 个用户或者 5 个机器人;- 删除机器人类型的管理员请使用 ==app_id==
12704
+ * 注意事项:; - 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 仅有群主可以删除群管理员
12628
12705
  */
12629
12706
  deleteManagers: (payload, options) => __awaiter(this, void 0, void 0, function* () {
12630
12707
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -12681,7 +12758,7 @@ class Client$1 {
12681
12758
  *
12682
12759
  * 将用户或机器人移出群聊。
12683
12760
  *
12684
- * 注意事项:; - 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 用户或机器人在任何条件下均可移除自己出群(即主动退群);- 仅有群主/管理员 或 创建群组并且具备 ==更新应用所创建群的群信息== 权限的机器人,可以移除其他用户或者机器人; - 每次请求,最多移除50个用户或者5个机器人
12761
+ * 注意事项:; - 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 用户或机器人在任何条件下均可移除自己出群(即主动退群);- 仅有群主/管理员 或 创建群组并且具备 ==更新应用所创建群的群信息== 权限的机器人,可以移除其他用户或者机器人;- 每次请求,最多移除50个用户或者5个机器人;- 操作内部群时,操作者须与群组在同一租户下;- 操作外部群时,请先在[开发者后台](https://open.feishu.cn/app)—权限管理—权限配置页面申请 ==在外部群调用群聊的 API 及事件== 权限
12685
12762
  */
12686
12763
  delete: (payload, options) => __awaiter(this, void 0, void 0, function* () {
12687
12764
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -12753,9 +12830,9 @@ class Client$1 {
12753
12830
  *
12754
12831
  * 获取群成员列表
12755
12832
  *
12756
- * 如果用户在群中,则返回该群的成员列表。
12833
+ * 获取用户/机器人所在群的群成员列表。
12757
12834
  *
12758
- * 注意事项:; - 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app); - 该接口不会返回群内的机器人成员; - 由于返回的群成员列表会过滤掉机器人成员,因此返回的群成员个数可能会小于指定的page_size; - 如果有同一时间加入群的群成员,会一次性返回,这会导致返回的群成员个数可能会大于指定的page_size
12835
+ * 注意事项:; - 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app); - 机器人或授权用户必须在群组中; - 该接口不会返回群内的机器人成员; - 由于返回的群成员列表会过滤掉机器人成员,因此返回的群成员个数可能会小于指定的page_size; - 如果有同一时间加入群的群成员,会一次性返回,这会导致返回的群成员个数可能会大于指定的page_size;- 获取内部群信息时,操作者须与群组在同一租户下;- 获取外部群信息时,请先在[开发者后台](https://open.feishu.cn/app)—权限管理—权限配置页面申请 ==在外部群调用群聊的 API 及事件== 权限
12759
12836
  */
12760
12837
  get: (payload, options) => __awaiter(this, void 0, void 0, function* () {
12761
12838
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -12780,6 +12857,8 @@ class Client$1 {
12780
12857
  * 判断用户或机器人是否在群里
12781
12858
  *
12782
12859
  * 根据使用的access_token判断对应的用户或者机器人是否在群里。
12860
+ *
12861
+ * 注意事项:; - 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 获取内部群信息时,操作者须与群组在同一租户下;- 获取外部群信息时,请先在[开发者后台](https://open.feishu.cn/app)—权限管理—权限配置页面申请 ==在外部群调用群聊的 API 及事件== 权限
12783
12862
  */
12784
12863
  isInChat: (payload, options) => __awaiter(this, void 0, void 0, function* () {
12785
12864
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -12805,7 +12884,7 @@ class Client$1 {
12805
12884
  *
12806
12885
  * 用户或机器人主动加入群聊。
12807
12886
  *
12808
- * 注意事项:;- 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app); - 目前仅支持加入公开群
12887
+ * 注意事项:;- 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 目前仅支持加入公开群;- 操作内部群时,操作者须与群组在同一租户下
12809
12888
  */
12810
12889
  meJoin: (payload, options) => __awaiter(this, void 0, void 0, function* () {
12811
12890
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -12939,9 +13018,9 @@ class Client$1 {
12939
13018
  *
12940
13019
  * 添加会话标签页
12941
13020
  *
12942
- * 添加自定义会话标签页
13021
+ * 添加自定义会话标签页。
12943
13022
  *
12944
- * 注意事项:;;- 只允许添加类型为doc和url的会话标签页;;- 创建时不需要设置tabID;;- 一个群内最多只允许添加20个自定义会话标签页;;- 会话标签页的名称不超过30个字符;;- 添加doc类型时,操作者(access token对应的身份)需要拥有对应文档的权限
13023
+ * 注意事项:;- 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 机器人或授权用户必须在群里;- 不需要填写请求体中的`tab_id`字段;- 只允许添加类型为`doc`和`url`的会话标签页;- 添加doc类型时,操作者(access token对应的身份)需要拥有对应文档的权限;- 操作内部群时,操作者须与群组在同一租户下;- 操作外部群时,请先在[开发者后台](https://open.feishu.cn/app)—权限管理—权限配置页面申请 ==在外部群调用群聊的 API 及事件== 权限
12945
13024
  */
12946
13025
  create: (payload, options) => __awaiter(this, void 0, void 0, function* () {
12947
13026
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -12965,7 +13044,9 @@ class Client$1 {
12965
13044
  *
12966
13045
  * 删除会话标签页
12967
13046
  *
12968
- * 删除会话标签页
13047
+ * 删除会话标签页。
13048
+ *
13049
+ * 注意事项:;- 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 机器人或授权用户必须在群里;- 只允许删除类型为`doc`和`url`的会话标签页;- 操作内部群时,操作者须与群组在同一租户下;- 操作外部群时,请先在[开发者后台](https://open.feishu.cn/app)—权限管理—权限配置页面申请 ==在外部群调用群聊的 API 及事件== 权限
12969
13050
  */
12970
13051
  deleteTabs: (payload, options) => __awaiter(this, void 0, void 0, function* () {
12971
13052
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -12989,7 +13070,9 @@ class Client$1 {
12989
13070
  *
12990
13071
  * 拉取会话标签页
12991
13072
  *
12992
- * 拉取会话标签页
13073
+ * 拉取会话标签页。
13074
+ *
13075
+ * 注意事项:;- 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 机器人或授权用户必须在群里;- 操作内部群时,操作者须与群组在同一租户下;- 操作外部群时,请先在[开发者后台](https://open.feishu.cn/app)—权限管理—权限配置页面申请 ==在外部群调用群聊的 API 及事件== 权限
12993
13076
  */
12994
13077
  listTabs: (payload, options) => __awaiter(this, void 0, void 0, function* () {
12995
13078
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -13013,9 +13096,9 @@ class Client$1 {
13013
13096
  *
13014
13097
  * 会话标签页排序
13015
13098
  *
13016
- * 会话标签页排序
13099
+ * 会话标签页排序。
13017
13100
  *
13018
- * 注意事项:;;- 当前消息标签页固定为第一顺位,不参与排序,但是请求体中必须包含。;;- 请求体必须包含全部的TabID
13101
+ * 注意事项:;- 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 机器人或授权用户必须在群里;- 消息标签页强制固定为第一顺位,不参与排序,但是请求体中必须包含该标签页的Tab ID;- 操作内部群时,操作者须与群组在同一租户下;- 操作外部群时,请先在[开发者后台](https://open.feishu.cn/app)—权限管理—权限配置页面申请 ==在外部群调用群聊的 API 及事件== 权限
13019
13102
  */
13020
13103
  sortTabs: (payload, options) => __awaiter(this, void 0, void 0, function* () {
13021
13104
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -13041,7 +13124,7 @@ class Client$1 {
13041
13124
  *
13042
13125
  * 更新会话标签页
13043
13126
  *
13044
- * 注意事项:;;- 只允许更新类型为docurl的会话标签页;;- 会话标签页的名称不超过30个字符;;- 更新doc类型时,操作者(access token对应的身份)需要拥有对应文档的权限
13127
+ * 注意事项:;- 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 机器人或授权用户必须在群里;- 只允许更新类型为`doc`和`url`的会话标签页;- 更新doc类型时,操作者(access token对应的身份)需要拥有对应文档的权限;- 操作内部群时,操作者须与群组在同一租户下;- 操作外部群时,请先在[开发者后台](https://open.feishu.cn/app)—权限管理—权限配置页面申请 ==在外部群调用群聊的 API 及事件== 权限
13045
13128
  */
13046
13129
  updateTabs: (payload, options) => __awaiter(this, void 0, void 0, function* () {
13047
13130
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -13263,7 +13346,7 @@ class Client$1 {
13263
13346
  }),
13264
13347
  },
13265
13348
  /**
13266
- * 消息 - 消息卡片
13349
+ * 消息
13267
13350
  */
13268
13351
  message: {
13269
13352
  /**
@@ -13403,7 +13486,7 @@ class Client$1 {
13403
13486
  *
13404
13487
  * - 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app) ;- 获取消息时,机器人必须在群组中
13405
13488
  *
13406
- * 接口级别权限默认只能获取单聊(p2p)消息,如果需要获取群组(group)消息,应用还必须拥有 ***获取群组中所有消息*** 权限
13489
+ * 接口级别权限默认只能获取单聊(p2p)消息,如果需要获取群组(group)消息,应用还必须拥有 **==获取群组中所有消息==** 权限
13407
13490
  */
13408
13491
  list: (payload, options) => __awaiter(this, void 0, void 0, function* () {
13409
13492
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -13429,7 +13512,7 @@ class Client$1 {
13429
13512
  *
13430
13513
  * 更新应用已发送的消息卡片内容。
13431
13514
  *
13432
- * 注意事项:;- 需要开启[机器人能力](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**
13515
+ * 注意事项:;- 需要开启[机器人能力](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**
13433
13516
  */
13434
13517
  patch: (payload, options) => __awaiter(this, void 0, void 0, function* () {
13435
13518
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -15805,7 +15888,7 @@ class Client$1 {
15805
15888
  *
15806
15889
  * 创建表格
15807
15890
  *
15808
- * 使用该接口可以在指定的目录下创建在线表格。
15891
+ * 在指定目录下创建表格
15809
15892
  */
15810
15893
  create: (payload, options) => __awaiter(this, void 0, void 0, function* () {
15811
15894
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -16239,7 +16322,7 @@ class Client$1 {
16239
16322
  }),
16240
16323
  },
16241
16324
  /**
16242
- * 行列
16325
+ * 单元格
16243
16326
  */
16244
16327
  spreadsheetSheet: {
16245
16328
  /**
@@ -16249,7 +16332,7 @@ class Client$1 {
16249
16332
  *
16250
16333
  * 查找单元格
16251
16334
  *
16252
- * 按照指定的条件查找子表的某个范围内的数据符合条件的单元格位置。请求体中的 range 和 find 字段为必填。
16335
+ * 在指定范围内查找符合查找条件的单元格。
16253
16336
  */
16254
16337
  find: (payload, options) => __awaiter(this, void 0, void 0, function* () {
16255
16338
  const { headers, params, data, path } = yield this.formatPayload(payload, options);
@@ -17711,6 +17794,30 @@ class Client$1 {
17711
17794
  throw e;
17712
17795
  });
17713
17796
  }),
17797
+ /**
17798
+ * {@link https://open.feishu.cn/api-explorer?project=vc&resource=export&apiName=resource_reservation_list&version=v1 click to debug }
17799
+ *
17800
+ * {@link https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/export/resource_reservation_list document }
17801
+ *
17802
+ * 导出会议室预定数据
17803
+ *
17804
+ * 导出会议室预定数据,具体权限要求请参考「导出概述」
17805
+ */
17806
+ resourceReservationList: (payload, options) => __awaiter(this, void 0, void 0, function* () {
17807
+ const { headers, params, data, path } = yield this.formatPayload(payload, options);
17808
+ return httpInstance
17809
+ .request({
17810
+ url: fillApiPath(`${this.domain}/open-apis/vc/v1/exports/resource_reservation_list`, path),
17811
+ method: "POST",
17812
+ data,
17813
+ params,
17814
+ headers,
17815
+ })
17816
+ .catch((e) => {
17817
+ this.logger.error(formatErrors(e));
17818
+ throw e;
17819
+ });
17820
+ }),
17714
17821
  },
17715
17822
  /**
17716
17823
  * 会议
@@ -18219,7 +18326,7 @@ class Client$1 {
18219
18326
  }),
18220
18327
  },
18221
18328
  /**
18222
- * 会议室预定范围
18329
+ * reserve_config
18223
18330
  */
18224
18331
  reserveConfig: {
18225
18332
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@larksuiteoapi/node-sdk",
3
- "version": "1.4.1",
3
+ "version": "1.5.0",
4
4
  "description": "larksuite open sdk for nodejs",
5
5
  "keywords": [
6
6
  "feishu",
package/types/index.d.ts CHANGED
@@ -941,6 +941,134 @@ declare abstract class Client$1 {
941
941
  * 应用信息
942
942
  */
943
943
  application: {
944
+ /**
945
+ * 推荐规则
946
+ */
947
+ appRecommendRule: {
948
+ listWithIterator: (payload?: {
949
+ params: {
950
+ page_size: number;
951
+ page_token?: string;
952
+ user_id_type?: "user_id" | "union_id" | "open_id";
953
+ };
954
+ }, options?: IRequestOptions$1) => Promise<{
955
+ [Symbol.asyncIterator](): AsyncGenerator<{
956
+ rules?: {
957
+ id?: string | undefined;
958
+ name?: string | undefined;
959
+ status?: "closed" | "open" | undefined;
960
+ visibility_info?: {
961
+ is_all?: boolean | undefined;
962
+ department_ids?: string[] | undefined;
963
+ user_ids?: string[] | undefined;
964
+ group_ids?: string[] | undefined;
965
+ } | undefined;
966
+ recommend_item_infos?: {
967
+ item_id?: string | undefined;
968
+ item_type?: "link" | "application" | undefined;
969
+ name?: string | undefined;
970
+ description?: string | undefined;
971
+ link_url?: string | undefined;
972
+ client_id?: string | undefined;
973
+ icon_url?: string | undefined;
974
+ default_locale?: "zh_cn" | "en_us" | "ja_jp" | "zh_hk" | "zh_tw" | undefined;
975
+ i18n_name?: {
976
+ zh_cn?: string | undefined;
977
+ zh_hk?: string | undefined;
978
+ zh_tw?: string | undefined;
979
+ en_us?: string | undefined;
980
+ ja_jp?: string | undefined;
981
+ } | undefined;
982
+ }[] | undefined;
983
+ distributed_recommend_item_infos?: {
984
+ item_id?: string | undefined;
985
+ item_type?: "link" | "application" | undefined;
986
+ name?: string | undefined;
987
+ description?: string | undefined;
988
+ link_url?: string | undefined;
989
+ client_id?: string | undefined;
990
+ icon_url?: string | undefined;
991
+ default_locale?: "zh_cn" | "en_us" | "ja_jp" | "zh_hk" | "zh_tw" | undefined;
992
+ i18n_name?: {
993
+ zh_cn?: string | undefined;
994
+ zh_hk?: string | undefined;
995
+ zh_tw?: string | undefined;
996
+ en_us?: string | undefined;
997
+ ja_jp?: string | undefined;
998
+ } | undefined;
999
+ }[] | undefined;
1000
+ }[] | undefined;
1001
+ } | null, void, unknown>;
1002
+ }>;
1003
+ /**
1004
+ * {@link https://open.feishu.cn/api-explorer?project=application&resource=app_recommend_rule&apiName=list&version=v6 click to debug }
1005
+ *
1006
+ * {@link https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/app_recommend_rule/list document }
1007
+ *
1008
+ * 获取当前设置的推荐规则列表
1009
+ *
1010
+ * 获取当前设置的推荐规则列表。
1011
+ */
1012
+ list: (payload?: {
1013
+ params: {
1014
+ page_size: number;
1015
+ page_token?: string;
1016
+ user_id_type?: "user_id" | "union_id" | "open_id";
1017
+ };
1018
+ }, options?: IRequestOptions$1) => Promise<{
1019
+ code?: number | undefined;
1020
+ msg?: string | undefined;
1021
+ data?: {
1022
+ rules?: {
1023
+ id?: string | undefined;
1024
+ name?: string | undefined;
1025
+ status?: "closed" | "open" | undefined;
1026
+ visibility_info?: {
1027
+ is_all?: boolean | undefined;
1028
+ department_ids?: string[] | undefined;
1029
+ user_ids?: string[] | undefined;
1030
+ group_ids?: string[] | undefined;
1031
+ } | undefined;
1032
+ recommend_item_infos?: {
1033
+ item_id?: string | undefined;
1034
+ item_type?: "link" | "application" | undefined;
1035
+ name?: string | undefined;
1036
+ description?: string | undefined;
1037
+ link_url?: string | undefined;
1038
+ client_id?: string | undefined;
1039
+ icon_url?: string | undefined;
1040
+ default_locale?: "zh_cn" | "en_us" | "ja_jp" | "zh_hk" | "zh_tw" | undefined;
1041
+ i18n_name?: {
1042
+ zh_cn?: string | undefined;
1043
+ zh_hk?: string | undefined;
1044
+ zh_tw?: string | undefined;
1045
+ en_us?: string | undefined;
1046
+ ja_jp?: string | undefined;
1047
+ } | undefined;
1048
+ }[] | undefined;
1049
+ distributed_recommend_item_infos?: {
1050
+ item_id?: string | undefined;
1051
+ item_type?: "link" | "application" | undefined;
1052
+ name?: string | undefined;
1053
+ description?: string | undefined;
1054
+ link_url?: string | undefined;
1055
+ client_id?: string | undefined;
1056
+ icon_url?: string | undefined;
1057
+ default_locale?: "zh_cn" | "en_us" | "ja_jp" | "zh_hk" | "zh_tw" | undefined;
1058
+ i18n_name?: {
1059
+ zh_cn?: string | undefined;
1060
+ zh_hk?: string | undefined;
1061
+ zh_tw?: string | undefined;
1062
+ en_us?: string | undefined;
1063
+ ja_jp?: string | undefined;
1064
+ } | undefined;
1065
+ }[] | undefined;
1066
+ }[] | undefined;
1067
+ page_token?: string | undefined;
1068
+ has_more?: boolean | undefined;
1069
+ } | undefined;
1070
+ }>;
1071
+ };
944
1072
  /**
945
1073
  * 应用使用情况
946
1074
  */
@@ -1633,7 +1761,7 @@ declare abstract class Client$1 {
1633
1761
  */
1634
1762
  approval: {
1635
1763
  /**
1636
- * 原生审批定义
1764
+ * 事件
1637
1765
  */
1638
1766
  approval: {
1639
1767
  /**
@@ -2412,7 +2540,7 @@ declare abstract class Client$1 {
2412
2540
  *
2413
2541
  * 批量获取审批实例ID
2414
2542
  *
2415
- * 根据 approval_code 批量获取审批实例的 instance_code,用于拉取租户下某个审批定义的全部审批实例。默认以审批创建时间排序
2543
+ * 根据 approval_code 批量获取审批实例的 instance_code,用于拉取租户下某个审批定义的全部审批实例。默认以审批创建时间先后顺序排列
2416
2544
  */
2417
2545
  list: (payload?: {
2418
2546
  params: {
@@ -2844,7 +2972,7 @@ declare abstract class Client$1 {
2844
2972
  }>;
2845
2973
  };
2846
2974
  /**
2847
- * 审批查询
2975
+ * 原生审批任务
2848
2976
  */
2849
2977
  task: {
2850
2978
  /**
@@ -5959,7 +6087,7 @@ declare abstract class Client$1 {
5959
6087
  };
5960
6088
  };
5961
6089
  /**
5962
- * 云文档-多维表格
6090
+ * 云文档-电子表格
5963
6091
  */
5964
6092
  bitable: {
5965
6093
  /**
@@ -9052,7 +9180,7 @@ declare abstract class Client$1 {
9052
9180
  *
9053
9181
  * 该接口用于以当前身份(应用 / 用户)获取日历下的日程列表。;身份由 Header Authorization 的 Token 类型决定。
9054
9182
  *
9055
- * - 当前身份必须对日历有reader、writer或owner权限才会返回日程详细信息(调用[获取日历](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/get)接口,role字段可查看权限)。;;- 仅支持primary、shared和resource类型的日历获取日程列表。;;- 调用时首先使用 page_token 分页拉取存量数据,之后使用 sync_token 增量同步变更数据。;;- 为了确保调用方日程同步数据的一致性,在使用sync_token时,不能同时使用start_time和end_time,否则可能造成日程数据缺失。
9183
+ * - 当前身份必须对日历有reader、writer或owner权限才会返回日程详细信息(调用[获取日历](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/get)接口,role字段可查看权限)。;;- 仅支持primary、shared和resource类型的日历获取日程列表。;;- page_token 分页拉取存量数据,sync_token 增量同步变更数据;目前仅传anchor_time时,会返回page_token。;;- 为了确保调用方日程同步数据的一致性,在使用sync_token时,不能同时使用start_time和end_time,否则可能造成日程数据缺失。
9056
9184
  */
9057
9185
  list: (payload?: {
9058
9186
  params?: {
@@ -36471,9 +36599,9 @@ declare abstract class Client$1 {
36471
36599
  *
36472
36600
  * {@link https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file-comment/list document }
36473
36601
  *
36474
- * 获取文档评论
36602
+ * 分页获取文档评论
36475
36603
  *
36476
- * 根据文档token分页获取云文档中的评论。
36604
+ * 该接口用于根据文档 token 分页获取文档评论。
36477
36605
  */
36478
36606
  list: (payload?: {
36479
36607
  params: {
@@ -36627,7 +36755,7 @@ declare abstract class Client$1 {
36627
36755
  }>;
36628
36756
  };
36629
36757
  /**
36630
- * 下载
36758
+ * 文件夹
36631
36759
  */
36632
36760
  file: {
36633
36761
  /**
@@ -37152,7 +37280,7 @@ declare abstract class Client$1 {
37152
37280
  }>;
37153
37281
  };
37154
37282
  /**
37155
- * 素材
37283
+ * 分片上传
37156
37284
  */
37157
37285
  media: {
37158
37286
  /**
@@ -41912,7 +42040,7 @@ declare abstract class Client$1 {
41912
42040
  *
41913
42041
  * 获取会话中的群公告信息,公告信息格式与[云文档](https://open.feishu.cn/document/ukTMukTMukTM/uAzM5YjLwMTO24CMzkjN)格式相同。
41914
42042
  *
41915
- * 注意事项:;- 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app)
42043
+ * 注意事项:;- 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 机器人或授权用户必须在群里;- 获取内部群信息时,操作者须与群组在同一租户下
41916
42044
  */
41917
42045
  get: (payload?: {
41918
42046
  params?: {
@@ -41944,7 +42072,7 @@ declare abstract class Client$1 {
41944
42072
  *
41945
42073
  * 更新会话中的群公告信息,更新公告信息的格式和更新[云文档](https://open.feishu.cn/document/ukTMukTMukTM/uAzM5YjLwMTO24CMzkjN)格式相同。
41946
42074
  *
41947
- * 注意事项:;- 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 若群开启了 ==仅群主和群管理员可编辑群信息== 配置,群主/群管理员 或 创建群组且具备 ==更新应用所创建群的群信息== 权限的机器人,可更新群公告;- 若群未开启 ==仅群主和群管理员可编辑群信息== 配置,所有成员可以更新群公告
42075
+ * 注意事项:;- 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 机器人或授权用户必须在群里;- 操作者需要拥有群公告文档的阅读权限;- 获取内部群信息时,操作者须与群组在同一租户下;- 若群开启了 ==仅群主和群管理员可编辑群信息== 配置,群主/群管理员 或 创建群组且具备 ==更新应用所创建群的群信息== 权限的机器人,可更新群公告;- 若群未开启 ==仅群主和群管理员可编辑群信息== 配置,所有成员可以更新群公告
41948
42076
  */
41949
42077
  patch: (payload?: {
41950
42078
  data: {
@@ -42161,7 +42289,7 @@ declare abstract class Client$1 {
42161
42289
  *
42162
42290
  * 获取用户或者机器人所在群列表。
42163
42291
  *
42164
- * 注意事项:; - 应用需要开启[机器人能力](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单聊群
42292
+ * 注意事项:; - 应用需要开启[机器人能力](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单聊
42165
42293
  */
42166
42294
  list: (payload?: {
42167
42295
  params?: {
@@ -42304,7 +42432,7 @@ declare abstract class Client$1 {
42304
42432
  *
42305
42433
  * 将用户或机器人指定为群管理员。
42306
42434
  *
42307
- * 注意事项:; - 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 仅有群主可以指定群管理员;- 对于普通群,最多指定 10 个管理员;- 对于超大群,最多指定 20 个管理员;- 每次请求最多指定 50 个用户或者 5 个机器人;- 指定机器人类型的管理员请使用 ==app_id==
42435
+ * 注意事项:; - 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 仅有群主可以指定群管理员
42308
42436
  */
42309
42437
  addManagers: (payload?: {
42310
42438
  data?: {
@@ -42333,7 +42461,7 @@ declare abstract class Client$1 {
42333
42461
  *
42334
42462
  * 删除指定的群管理员(用户或机器人)。
42335
42463
  *
42336
- * 注意事项:; - 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 仅有群主可以删除群管理员;- 每次请求最多指定 50 个用户或者 5 个机器人;- 删除机器人类型的管理员请使用 ==app_id==
42464
+ * 注意事项:; - 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 仅有群主可以删除群管理员
42337
42465
  */
42338
42466
  deleteManagers: (payload?: {
42339
42467
  data?: {
@@ -42397,7 +42525,7 @@ declare abstract class Client$1 {
42397
42525
  *
42398
42526
  * 将用户或机器人移出群聊。
42399
42527
  *
42400
- * 注意事项:; - 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 用户或机器人在任何条件下均可移除自己出群(即主动退群);- 仅有群主/管理员 或 创建群组并且具备 ==更新应用所创建群的群信息== 权限的机器人,可以移除其他用户或者机器人; - 每次请求,最多移除50个用户或者5个机器人
42528
+ * 注意事项:; - 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 用户或机器人在任何条件下均可移除自己出群(即主动退群);- 仅有群主/管理员 或 创建群组并且具备 ==更新应用所创建群的群信息== 权限的机器人,可以移除其他用户或者机器人;- 每次请求,最多移除50个用户或者5个机器人;- 操作内部群时,操作者须与群组在同一租户下;- 操作外部群时,请先在[开发者后台](https://open.feishu.cn/app)—权限管理—权限配置页面申请 ==在外部群调用群聊的 API 及事件== 权限
42401
42529
  */
42402
42530
  delete: (payload?: {
42403
42531
  data?: {
@@ -42443,9 +42571,9 @@ declare abstract class Client$1 {
42443
42571
  *
42444
42572
  * 获取群成员列表
42445
42573
  *
42446
- * 如果用户在群中,则返回该群的成员列表。
42574
+ * 获取用户/机器人所在群的群成员列表。
42447
42575
  *
42448
- * 注意事项:; - 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app); - 该接口不会返回群内的机器人成员; - 由于返回的群成员列表会过滤掉机器人成员,因此返回的群成员个数可能会小于指定的page_size; - 如果有同一时间加入群的群成员,会一次性返回,这会导致返回的群成员个数可能会大于指定的page_size
42576
+ * 注意事项:; - 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app); - 机器人或授权用户必须在群组中; - 该接口不会返回群内的机器人成员; - 由于返回的群成员列表会过滤掉机器人成员,因此返回的群成员个数可能会小于指定的page_size; - 如果有同一时间加入群的群成员,会一次性返回,这会导致返回的群成员个数可能会大于指定的page_size;- 获取内部群信息时,操作者须与群组在同一租户下;- 获取外部群信息时,请先在[开发者后台](https://open.feishu.cn/app)—权限管理—权限配置页面申请 ==在外部群调用群聊的 API 及事件== 权限
42449
42577
  */
42450
42578
  get: (payload?: {
42451
42579
  params?: {
@@ -42479,6 +42607,8 @@ declare abstract class Client$1 {
42479
42607
  * 判断用户或机器人是否在群里
42480
42608
  *
42481
42609
  * 根据使用的access_token判断对应的用户或者机器人是否在群里。
42610
+ *
42611
+ * 注意事项:; - 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 获取内部群信息时,操作者须与群组在同一租户下;- 获取外部群信息时,请先在[开发者后台](https://open.feishu.cn/app)—权限管理—权限配置页面申请 ==在外部群调用群聊的 API 及事件== 权限
42482
42612
  */
42483
42613
  isInChat: (payload?: {
42484
42614
  path?: {
@@ -42500,7 +42630,7 @@ declare abstract class Client$1 {
42500
42630
  *
42501
42631
  * 用户或机器人主动加入群聊。
42502
42632
  *
42503
- * 注意事项:;- 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app); - 目前仅支持加入公开群
42633
+ * 注意事项:;- 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 目前仅支持加入公开群;- 操作内部群时,操作者须与群组在同一租户下
42504
42634
  */
42505
42635
  meJoin: (payload?: {
42506
42636
  path?: {
@@ -42609,9 +42739,9 @@ declare abstract class Client$1 {
42609
42739
  *
42610
42740
  * 添加会话标签页
42611
42741
  *
42612
- * 添加自定义会话标签页
42742
+ * 添加自定义会话标签页。
42613
42743
  *
42614
- * 注意事项:;;- 只允许添加类型为doc和url的会话标签页;;- 创建时不需要设置tabID;;- 一个群内最多只允许添加20个自定义会话标签页;;- 会话标签页的名称不超过30个字符;;- 添加doc类型时,操作者(access token对应的身份)需要拥有对应文档的权限
42744
+ * 注意事项:;- 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 机器人或授权用户必须在群里;- 不需要填写请求体中的`tab_id`字段;- 只允许添加类型为`doc`和`url`的会话标签页;- 添加doc类型时,操作者(access token对应的身份)需要拥有对应文档的权限;- 操作内部群时,操作者须与群组在同一租户下;- 操作外部群时,请先在[开发者后台](https://open.feishu.cn/app)—权限管理—权限配置页面申请 ==在外部群调用群聊的 API 及事件== 权限
42615
42745
  */
42616
42746
  create: (payload?: {
42617
42747
  data: {
@@ -42652,7 +42782,9 @@ declare abstract class Client$1 {
42652
42782
  *
42653
42783
  * 删除会话标签页
42654
42784
  *
42655
- * 删除会话标签页
42785
+ * 删除会话标签页。
42786
+ *
42787
+ * 注意事项:;- 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 机器人或授权用户必须在群里;- 只允许删除类型为`doc`和`url`的会话标签页;- 操作内部群时,操作者须与群组在同一租户下;- 操作外部群时,请先在[开发者后台](https://open.feishu.cn/app)—权限管理—权限配置页面申请 ==在外部群调用群聊的 API 及事件== 权限
42656
42788
  */
42657
42789
  deleteTabs: (payload?: {
42658
42790
  data: {
@@ -42684,7 +42816,9 @@ declare abstract class Client$1 {
42684
42816
  *
42685
42817
  * 拉取会话标签页
42686
42818
  *
42687
- * 拉取会话标签页
42819
+ * 拉取会话标签页。
42820
+ *
42821
+ * 注意事项:;- 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 机器人或授权用户必须在群里;- 操作内部群时,操作者须与群组在同一租户下;- 操作外部群时,请先在[开发者后台](https://open.feishu.cn/app)—权限管理—权限配置页面申请 ==在外部群调用群聊的 API 及事件== 权限
42688
42822
  */
42689
42823
  listTabs: (payload?: {
42690
42824
  path?: {
@@ -42713,9 +42847,9 @@ declare abstract class Client$1 {
42713
42847
  *
42714
42848
  * 会话标签页排序
42715
42849
  *
42716
- * 会话标签页排序
42850
+ * 会话标签页排序。
42717
42851
  *
42718
- * 注意事项:;;- 当前消息标签页固定为第一顺位,不参与排序,但是请求体中必须包含。;;- 请求体必须包含全部的TabID
42852
+ * 注意事项:;- 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 机器人或授权用户必须在群里;- 消息标签页强制固定为第一顺位,不参与排序,但是请求体中必须包含该标签页的Tab ID;- 操作内部群时,操作者须与群组在同一租户下;- 操作外部群时,请先在[开发者后台](https://open.feishu.cn/app)—权限管理—权限配置页面申请 ==在外部群调用群聊的 API 及事件== 权限
42719
42853
  */
42720
42854
  sortTabs: (payload?: {
42721
42855
  data?: {
@@ -42749,7 +42883,7 @@ declare abstract class Client$1 {
42749
42883
  *
42750
42884
  * 更新会话标签页
42751
42885
  *
42752
- * 注意事项:;;- 只允许更新类型为docurl的会话标签页;;- 会话标签页的名称不超过30个字符;;- 更新doc类型时,操作者(access token对应的身份)需要拥有对应文档的权限
42886
+ * 注意事项:;- 应用需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app);- 机器人或授权用户必须在群里;- 只允许更新类型为`doc`和`url`的会话标签页;- 更新doc类型时,操作者(access token对应的身份)需要拥有对应文档的权限;- 操作内部群时,操作者须与群组在同一租户下;- 操作外部群时,请先在[开发者后台](https://open.feishu.cn/app)—权限管理—权限配置页面申请 ==在外部群调用群聊的 API 及事件== 权限
42753
42887
  */
42754
42888
  updateTabs: (payload?: {
42755
42889
  data?: {
@@ -42922,7 +43056,7 @@ declare abstract class Client$1 {
42922
43056
  }>;
42923
43057
  };
42924
43058
  /**
42925
- * 消息 - 消息卡片
43059
+ * 消息
42926
43060
  */
42927
43061
  message: {
42928
43062
  /**
@@ -43099,7 +43233,7 @@ declare abstract class Client$1 {
43099
43233
  *
43100
43234
  * - 需要开启[机器人能力](https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app) ;- 获取消息时,机器人必须在群组中
43101
43235
  *
43102
- * 接口级别权限默认只能获取单聊(p2p)消息,如果需要获取群组(group)消息,应用还必须拥有 ***获取群组中所有消息*** 权限
43236
+ * 接口级别权限默认只能获取单聊(p2p)消息,如果需要获取群组(group)消息,应用还必须拥有 **==获取群组中所有消息==** 权限
43103
43237
  */
43104
43238
  list: (payload?: {
43105
43239
  params: {
@@ -43155,7 +43289,7 @@ declare abstract class Client$1 {
43155
43289
  *
43156
43290
  * 更新应用已发送的消息卡片内容。
43157
43291
  *
43158
- * 注意事项:;- 需要开启[机器人能力](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**
43292
+ * 注意事项:;- 需要开启[机器人能力](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**
43159
43293
  */
43160
43294
  patch: (payload?: {
43161
43295
  data: {
@@ -46048,7 +46182,7 @@ declare abstract class Client$1 {
46048
46182
  *
46049
46183
  * 创建表格
46050
46184
  *
46051
- * 使用该接口可以在指定的目录下创建在线表格。
46185
+ * 在指定目录下创建表格
46052
46186
  */
46053
46187
  create: (payload?: {
46054
46188
  data?: {
@@ -46528,7 +46662,7 @@ declare abstract class Client$1 {
46528
46662
  }>;
46529
46663
  };
46530
46664
  /**
46531
- * 行列
46665
+ * 单元格
46532
46666
  */
46533
46667
  spreadsheetSheet: {
46534
46668
  /**
@@ -46538,7 +46672,7 @@ declare abstract class Client$1 {
46538
46672
  *
46539
46673
  * 查找单元格
46540
46674
  *
46541
- * 按照指定的条件查找子表的某个范围内的数据符合条件的单元格位置。请求体中的 range 和 find 字段为必填。
46675
+ * 在指定范围内查找符合查找条件的单元格。
46542
46676
  */
46543
46677
  find: (payload?: {
46544
46678
  data: {
@@ -48198,6 +48332,31 @@ declare abstract class Client$1 {
48198
48332
  task_id?: string | undefined;
48199
48333
  } | undefined;
48200
48334
  }>;
48335
+ /**
48336
+ * {@link https://open.feishu.cn/api-explorer?project=vc&resource=export&apiName=resource_reservation_list&version=v1 click to debug }
48337
+ *
48338
+ * {@link https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/export/resource_reservation_list document }
48339
+ *
48340
+ * 导出会议室预定数据
48341
+ *
48342
+ * 导出会议室预定数据,具体权限要求请参考「导出概述」
48343
+ */
48344
+ resourceReservationList: (payload?: {
48345
+ data: {
48346
+ room_level_id: string;
48347
+ need_topic?: boolean;
48348
+ start_time: string;
48349
+ end_time: string;
48350
+ room_ids?: Array<string>;
48351
+ is_exclude?: boolean;
48352
+ };
48353
+ }, options?: IRequestOptions$1) => Promise<{
48354
+ code?: number | undefined;
48355
+ msg?: string | undefined;
48356
+ data?: {
48357
+ task_id?: string | undefined;
48358
+ } | undefined;
48359
+ }>;
48201
48360
  };
48202
48361
  /**
48203
48362
  * 会议
@@ -48887,7 +49046,7 @@ declare abstract class Client$1 {
48887
49046
  }>;
48888
49047
  };
48889
49048
  /**
48890
- * 会议室预定范围
49049
+ * reserve_config
48891
49050
  */
48892
49051
  reserveConfig: {
48893
49052
  /**
@@ -52366,7 +52525,7 @@ interface IHandles extends IOtherEventHandles {
52366
52525
  /**
52367
52526
  * {@link https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-member-user/events/deleted document }
52368
52527
  *
52369
- * 用户主动退群或被移出群聊
52528
+ * 用户出群
52370
52529
  *
52371
52530
  * 用户主动退群或被移出群聊时推送事件。
52372
52531
  *