@larksuiteoapi/node-sdk 1.4.0 → 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 +12 -1
- package/README.zh.md +12 -1
- package/es/index.js +139 -32
- package/lib/index.js +139 -32
- package/package.json +1 -1
- package/types/index.d.ts +326 -34
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类型的日历获取日程列表。;;-
|
|
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
|
-
*
|
|
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;- 获取的群列表不包含
|
|
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);-
|
|
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);-
|
|
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);- 用户或机器人在任何条件下均可移除自己出群(即主动退群);- 仅有群主/管理员 或 创建群组并且具备 ==更新应用所创建群的群信息==
|
|
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
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
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更新消息,该操作用户必须是卡片消息的发送者;-
|
|
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
|
-
*
|
|
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
|
*
|
|
@@ -53361,4 +53520,137 @@ declare const adaptKoaRouter: (dispatcher: EventDispatcher | CardActionHandler,
|
|
|
53361
53520
|
autoChallenge?: boolean;
|
|
53362
53521
|
}) => (ctx: any, next: any) => Promise<void>;
|
|
53363
53522
|
|
|
53364
|
-
|
|
53523
|
+
interface InteractiveCardActionEvent {
|
|
53524
|
+
open_id: string;
|
|
53525
|
+
user_id?: string;
|
|
53526
|
+
tenant_key: string;
|
|
53527
|
+
open_message_id: string;
|
|
53528
|
+
token: string;
|
|
53529
|
+
action: {
|
|
53530
|
+
value: Record<string, any>;
|
|
53531
|
+
tag: string;
|
|
53532
|
+
option?: string;
|
|
53533
|
+
timezone?: string;
|
|
53534
|
+
};
|
|
53535
|
+
}
|
|
53536
|
+
interface InteractiveCard {
|
|
53537
|
+
config?: InteractiveCardConfig;
|
|
53538
|
+
header?: InteractiveCardHeader;
|
|
53539
|
+
elements?: InteractiveCardElement[];
|
|
53540
|
+
i18n_elements?: Record<string, InteractiveCardElement[]>;
|
|
53541
|
+
card_link?: InteractiveCardUrlItem;
|
|
53542
|
+
}
|
|
53543
|
+
interface InteractiveCardConfig {
|
|
53544
|
+
enable_forward?: boolean;
|
|
53545
|
+
update_multi?: boolean;
|
|
53546
|
+
wide_screen_mode?: boolean;
|
|
53547
|
+
}
|
|
53548
|
+
declare type InteractiveCardHeaderTemplate = 'blue' | 'wathet' | 'turquoise' | 'green' | 'yellow' | 'orange' | 'red' | 'carmine' | 'violet' | 'purple' | 'indigo' | 'grey';
|
|
53549
|
+
interface InteractiveCardHeader {
|
|
53550
|
+
title: InteractiveCardTitle;
|
|
53551
|
+
template?: InteractiveCardHeaderTemplate;
|
|
53552
|
+
}
|
|
53553
|
+
declare type InteractiveCardElement = InteractiveCardDivElement | InteractiveCardMarkdownElement | InteractiveCardDividerElement | InteractiveCardImageElement | InteractiveCardNoteElement | InterfaceCardActionElement;
|
|
53554
|
+
interface InteractiveCardTitle extends Omit<InteractiveCardPlainTextItem, 'lines'> {
|
|
53555
|
+
i18n?: Record<string, string>;
|
|
53556
|
+
}
|
|
53557
|
+
declare type InteractiveCardTextItem = InteractiveCardPlainTextItem | InteractiveCardLarkMdItem;
|
|
53558
|
+
interface InteractiveCardPlainTextItem {
|
|
53559
|
+
tag: 'plain_text';
|
|
53560
|
+
content?: string;
|
|
53561
|
+
lines?: number;
|
|
53562
|
+
}
|
|
53563
|
+
interface InteractiveCardLarkMdItem {
|
|
53564
|
+
tag: 'lark_md';
|
|
53565
|
+
content?: string;
|
|
53566
|
+
}
|
|
53567
|
+
interface InteractiveCardImageItem {
|
|
53568
|
+
tag: 'img';
|
|
53569
|
+
img_key: string;
|
|
53570
|
+
alt: InteractiveCardPlainTextItem;
|
|
53571
|
+
preview?: boolean;
|
|
53572
|
+
}
|
|
53573
|
+
interface InteractiveCardUrlItem {
|
|
53574
|
+
url: string;
|
|
53575
|
+
android_url?: string;
|
|
53576
|
+
ios_url?: string;
|
|
53577
|
+
pc_url?: string;
|
|
53578
|
+
}
|
|
53579
|
+
interface InteractiveCardField {
|
|
53580
|
+
is_short: boolean;
|
|
53581
|
+
text: InteractiveCardTextItem;
|
|
53582
|
+
}
|
|
53583
|
+
interface InteractiveCardDivElement {
|
|
53584
|
+
tag: 'div';
|
|
53585
|
+
text: InteractiveCardTextItem;
|
|
53586
|
+
fields?: InteractiveCardField[];
|
|
53587
|
+
extra?: any;
|
|
53588
|
+
}
|
|
53589
|
+
interface InteractiveCardMarkdownElement {
|
|
53590
|
+
tag: 'markdown';
|
|
53591
|
+
content: string;
|
|
53592
|
+
text_align?: 'left' | 'center' | 'right';
|
|
53593
|
+
href?: Record<string, InteractiveCardUrlItem>;
|
|
53594
|
+
}
|
|
53595
|
+
interface InteractiveCardDividerElement {
|
|
53596
|
+
tag: 'hr';
|
|
53597
|
+
}
|
|
53598
|
+
interface InteractiveCardImageElement extends InteractiveCardImageItem {
|
|
53599
|
+
title?: InteractiveCardTextItem;
|
|
53600
|
+
custom_width?: number;
|
|
53601
|
+
compact_width?: boolean;
|
|
53602
|
+
mode?: 'crop_center' | 'fit_horizontal';
|
|
53603
|
+
}
|
|
53604
|
+
interface InteractiveCardNoteElement {
|
|
53605
|
+
tag: 'note';
|
|
53606
|
+
elements: (InteractiveCardTextItem | InteractiveCardImageItem)[];
|
|
53607
|
+
}
|
|
53608
|
+
interface InterfaceCardActionElement {
|
|
53609
|
+
tag: 'action';
|
|
53610
|
+
actions: InteractiveCardActionItem[];
|
|
53611
|
+
layout?: 'bisected' | 'trisection' | 'flow';
|
|
53612
|
+
}
|
|
53613
|
+
declare type InteractiveCardActionItem = InteractiveCardDatePickerActionItem | InteractiveCardButtonActionItem | InteractiveCardOverflowActionItem | InteractiveCardSelectMenuActionItem;
|
|
53614
|
+
interface InteractiveCardActionBaseItem {
|
|
53615
|
+
confirm?: {
|
|
53616
|
+
title: InteractiveCardPlainTextItem;
|
|
53617
|
+
text: InteractiveCardPlainTextItem;
|
|
53618
|
+
};
|
|
53619
|
+
}
|
|
53620
|
+
interface InteractiveCardActionOptionItem {
|
|
53621
|
+
text?: InteractiveCardPlainTextItem;
|
|
53622
|
+
value?: string;
|
|
53623
|
+
}
|
|
53624
|
+
interface InteractiveCardDatePickerActionItem extends InteractiveCardActionBaseItem {
|
|
53625
|
+
tag: 'date_picker' | 'picker_time' | 'picker_datetime';
|
|
53626
|
+
initial_date?: string;
|
|
53627
|
+
initial_time?: string;
|
|
53628
|
+
initial_datetime?: string;
|
|
53629
|
+
placeholder?: InteractiveCardPlainTextItem;
|
|
53630
|
+
value?: Record<string, any>;
|
|
53631
|
+
}
|
|
53632
|
+
interface InteractiveCardButtonActionItem extends InteractiveCardActionBaseItem {
|
|
53633
|
+
tag: 'button';
|
|
53634
|
+
text?: InteractiveCardTextItem;
|
|
53635
|
+
url?: string;
|
|
53636
|
+
multi_utl?: InteractiveCardUrlItem;
|
|
53637
|
+
type?: 'default' | 'primary' | 'danger';
|
|
53638
|
+
value?: Record<string, any>;
|
|
53639
|
+
}
|
|
53640
|
+
interface InteractiveCardOverflowActionItem extends InteractiveCardActionBaseItem {
|
|
53641
|
+
tag: 'overflow';
|
|
53642
|
+
options?: (InteractiveCardActionOptionItem & {
|
|
53643
|
+
url?: string;
|
|
53644
|
+
multi_utl?: InteractiveCardUrlItem;
|
|
53645
|
+
})[];
|
|
53646
|
+
value?: Record<string, any>;
|
|
53647
|
+
}
|
|
53648
|
+
interface InteractiveCardSelectMenuActionItem extends InteractiveCardActionBaseItem {
|
|
53649
|
+
tag: 'select_static' | 'select_person';
|
|
53650
|
+
placeholder?: InteractiveCardPlainTextItem;
|
|
53651
|
+
initial_option?: string;
|
|
53652
|
+
option?: InteractiveCardActionOptionItem[];
|
|
53653
|
+
value?: Record<string, any>;
|
|
53654
|
+
}
|
|
53655
|
+
|
|
53656
|
+
export { AESCipher, AppType, CAppTicket, CardActionHandler, Client, Domain, EventDispatcher, IHandles as EventHandles, InteractiveCard, InteractiveCardActionEvent, InteractiveCardActionItem, InteractiveCardButtonActionItem, InteractiveCardDatePickerActionItem, InteractiveCardDivElement, InteractiveCardDividerElement, InteractiveCardElement, InteractiveCardField, InteractiveCardImageElement, InteractiveCardImageItem, InteractiveCardLarkMdItem, InteractiveCardMarkdownElement, InteractiveCardNoteElement, InteractiveCardOverflowActionItem, InteractiveCardPlainTextItem, InteractiveCardSelectMenuActionItem, InteractiveCardTextItem, InteractiveCardTitle, InteractiveCardUrlItem, InterfaceCardActionElement, LoggerLevel, adaptDefault, adaptExpress, adaptKoa, adaptKoaRouter, withAll, withHelpDeskCredential, withTenantKey, withTenantToken, withUserAccessToken };
|