@larksuiteoapi/node-sdk 1.16.1 → 1.17.1

package/README.md

@@ -6,6 +6,14 @@
 
 All of these make the overall development experience poor. In order to make the open capability easy to use, we have written this SDK, which integrates all the verbose logic into built-in processing, provides a complete type hints, and provides external semantics. Programming interface to improve coding experience. 
 
+Here are some official tutorials based on the sdk:
+* [Quickly develop interactive cards](https://open.feishu.cn/document/home/quickly-develop-interactive-cards/introduction)
+* [Quick Start of Personnel and Attendance Management System](https://open.feishu.cn/document/home/quick-start-of-personnel-and-attendance-management-system/overview)
+* [Quick access to Base](https://open.feishu.cn/document/home/quick-access-to-base/preparation)
+* [Department personnel management based on web app](https://open.feishu.cn/document/home/quick-access-to-base/department-personnel-management-based-on-web-app/overview)
+* [Quick access to Contact API](https://open.feishu.cn/document/home/quick-access-to-contact-api/introduction)
+* [Automatic attendance management based on approval](https://open.feishu.cn/document/home/automatic-attendance-management-based-on-approval/introduction)
+
 ## Concept
 - Development documentation: A reference to the open interface of the open platform, **a must-see for developers, you can use the search function to query documents efficiently**. [More introduction instructions](https://open.feishu.cn/document/) .
 

package/README.zh.md

@@ -5,6 +5,14 @@
 
 凡此种种，都使得整体的开发体验不佳，基于此，为了让开放能力变得易用，我们编写了该SDK，将所有冗长的逻辑内置处理，提供完备的类型系统，对外提供语义化的编程接口，提高编码体验。😙
 
+以下是一些基于该sdk的官方教程：
+* [快速开发互动卡片](https://open.feishu.cn/document/home/quickly-develop-interactive-cards/introduction)
+* [快速开发人员及考勤管理系统](https://open.feishu.cn/document/home/quick-start-of-personnel-and-attendance-management-system/overview)
+* [快速接入多维表格](https://open.feishu.cn/document/home/quick-access-to-base/preparation)
+* [基于网页应用实现部门人员管理](https://open.feishu.cn/document/home/quick-access-to-base/department-personnel-management-based-on-web-app/overview)
+* [快速接入通讯录](https://open.feishu.cn/document/home/quick-access-to-contact-api/introduction)
+* [基于审批实现自动考勤管理](https://open.feishu.cn/document/home/automatic-attendance-management-based-on-approval/introduction)
+
 ## 概念
 - 开发文档：开放平台的开放接口的参考，**开发者必看，可以使用搜索功能，高效的查询文档**。[更多介绍说明](https://open.feishu.cn/document/) 。
 

package/es/index.js

@@ -570,7 +570,7 @@ class Client$1 {
             },
         };
         /**
-         * 管理后台-数据报表
+         * 管理后台-企业勋章
          */
         this.admin = {
             /**
@@ -9737,7 +9737,7 @@ class Client$1 {
                 }),
             },
             /**
-             * 文件
+             * 异步任务状态
              */
             file: {
                 /**
@@ -10493,7 +10493,7 @@ class Client$1 {
                 }),
             },
             /**
-             * 分片上传
+             * 素材
              */
             media: {
                 /**
@@ -12766,7 +12766,7 @@ class Client$1 {
          */
         this.hire = {
             /**
-             * 投递
+             * 入职
              */
             application: {
                 /**
@@ -13098,6 +13098,83 @@ class Client$1 {
                     });
                 }),
             },
+            /**
+             * 评估（灰度租户可见）
+             */
+            evaluation: {
+                listWithIterator: (payload, options) => __awaiter(this, void 0, void 0, function* () {
+                    const { headers, params, data, path } = yield this.formatPayload(payload, options);
+                    const sendRequest = (innerPayload) => __awaiter(this, void 0, void 0, function* () {
+                        const res = yield this.httpInstance
+                            .request({
+                            url: fillApiPath(`${this.domain}/open-apis/hire/v1/evaluations`, path),
+                            method: "GET",
+                            headers: pickBy(innerPayload.headers, identity),
+                            params: pickBy(innerPayload.params, identity),
+                        })
+                            .catch((e) => {
+                            this.logger.error(formatErrors(e));
+                        });
+                        return res;
+                    });
+                    const Iterable = {
+                        [Symbol.asyncIterator]() {
+                            return __asyncGenerator(this, arguments, function* _a() {
+                                let hasMore = true;
+                                let pageToken;
+                                while (hasMore) {
+                                    try {
+                                        const res = yield __await(sendRequest({
+                                            headers,
+                                            params: Object.assign(Object.assign({}, params), { page_token: pageToken }),
+                                            data,
+                                        }));
+                                        const _b = get(res, "data") || {}, { 
+                                        // @ts-ignore
+                                        has_more, 
+                                        // @ts-ignore
+                                        page_token, 
+                                        // @ts-ignore
+                                        next_page_token } = _b, rest = __rest(_b, ["has_more", "page_token", "next_page_token"]);
+                                        yield yield __await(rest);
+                                        hasMore = Boolean(has_more);
+                                        pageToken = page_token || next_page_token;
+                                    }
+                                    catch (e) {
+                                        yield yield __await(null);
+                                        break;
+                                    }
+                                }
+                            });
+                        },
+                    };
+                    return Iterable;
+                }),
+                /**
+                 * {@link https://open.feishu.cn/api-explorer?project=hire&resource=evaluation&apiName=list&version=v1 click to debug }
+                 *
+                 * {@link https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/evaluation/list document }
+                 *
+                 * 获取简历评估信息
+                 *
+                 * 获取简历评估信息
+                 */
+                list: (payload, options) => __awaiter(this, void 0, void 0, function* () {
+                    const { headers, params, data, path } = yield this.formatPayload(payload, options);
+                    return this.httpInstance
+                        .request({
+                        url: fillApiPath(`${this.domain}/open-apis/hire/v1/evaluations`, path),
+                        method: "GET",
+                        data,
+                        params,
+                        headers,
+                    })
+                        .catch((e) => {
+                        this.logger.error(formatErrors(e));
+                        throw e;
+                    });
+                }),
+            },
             /**
              * 导入外部系统信息（灰度租户可见）
              */
@@ -13498,6 +13575,151 @@ class Client$1 {
                     });
                 }),
             },
+            /**
+             * Offer
+             */
+            offer: {
+                /**
+                 * {@link https://open.feishu.cn/api-explorer?project=hire&resource=offer&apiName=create&version=v1 click to debug }
+                 *
+                 * {@link https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/offer/create document }
+                 *
+                 * 创建 Offer
+                 *
+                 * 创建 Offer 时，需传入本文档中标注为必传的参数，其余参数是否必传参考「获取 Offer 申请表模板信息」的参数定义
+                 */
+                create: (payload, options) => __awaiter(this, void 0, void 0, function* () {
+                    const { headers, params, data, path } = yield this.formatPayload(payload, options);
+                    return this.httpInstance
+                        .request({
+                        url: fillApiPath(`${this.domain}/open-apis/hire/v1/offers`, path),
+                        method: "POST",
+                        data,
+                        params,
+                        headers,
+                    })
+                        .catch((e) => {
+                        this.logger.error(formatErrors(e));
+                        throw e;
+                    });
+                }),
+                /**
+                 * {@link https://open.feishu.cn/api-explorer?project=hire&resource=offer&apiName=get&version=v1 click to debug }
+                 *
+                 * {@link https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/offer/get document }
+                 *
+                 * 获取 Offer 详情
+                 *
+                 * 根据 Offer ID 获取 Offer 详细信息
+                 */
+                get: (payload, options) => __awaiter(this, void 0, void 0, function* () {
+                    const { headers, params, data, path } = yield this.formatPayload(payload, options);
+                    return this.httpInstance
+                        .request({
+                        url: fillApiPath(`${this.domain}/open-apis/hire/v1/offers/:offer_id`, path),
+                        method: "GET",
+                        data,
+                        params,
+                        headers,
+                    })
+                        .catch((e) => {
+                        this.logger.error(formatErrors(e));
+                        throw e;
+                    });
+                }),
+                /**
+                 * {@link https://open.feishu.cn/api-explorer?project=hire&resource=offer&apiName=intern_offer_status&version=v1 click to debug }
+                 *
+                 * {@link https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/offer/intern_offer_status document }
+                 *
+                 * 更新实习 Offer 入/离职状态
+                 *
+                 * 对「实习待入职」状态的实习 Offer 确认入职、放弃入职，或对「实习已入职」状态的实习 Offer 操作离职
+                 */
+                internOfferStatus: (payload, options) => __awaiter(this, void 0, void 0, function* () {
+                    const { headers, params, data, path } = yield this.formatPayload(payload, options);
+                    return this.httpInstance
+                        .request({
+                        url: fillApiPath(`${this.domain}/open-apis/hire/v1/offers/:offer_id/intern_offer_status`, path),
+                        method: "POST",
+                        data,
+                        params,
+                        headers,
+                    })
+                        .catch((e) => {
+                        this.logger.error(formatErrors(e));
+                        throw e;
+                    });
+                }),
+                /**
+                 * {@link https://open.feishu.cn/api-explorer?project=hire&resource=offer&apiName=list&version=v1 click to debug }
+                 *
+                 * {@link https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/offer/list document }
+                 *
+                 * 获取 Offer 列表
+                 *
+                 * 根据人才 ID 获取 Offer 列表
+                 */
+                list: (payload, options) => __awaiter(this, void 0, void 0, function* () {
+                    const { headers, params, data, path } = yield this.formatPayload(payload, options);
+                    return this.httpInstance
+                        .request({
+                        url: fillApiPath(`${this.domain}/open-apis/hire/v1/offers`, path),
+                        method: "GET",
+                        data,
+                        params,
+                        headers,
+                    })
+                        .catch((e) => {
+                        this.logger.error(formatErrors(e));
+                        throw e;
+                    });
+                }),
+                /**
+                 * {@link https://open.feishu.cn/api-explorer?project=hire&resource=offer&apiName=offer_status&version=v1 click to debug }
+                 *
+                 * {@link https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=offer_status&project=hire&resource=offer&version=v1 document }
+                 */
+                offerStatus: (payload, options) => __awaiter(this, void 0, void 0, function* () {
+                    const { headers, params, data, path } = yield this.formatPayload(payload, options);
+                    return this.httpInstance
+                        .request({
+                        url: fillApiPath(`${this.domain}/open-apis/hire/v1/offers/:offer_id/offer_status`, path),
+                        method: "PATCH",
+                        data,
+                        params,
+                        headers,
+                    })
+                        .catch((e) => {
+                        this.logger.error(formatErrors(e));
+                        throw e;
+                    });
+                }),
+                /**
+                 * {@link https://open.feishu.cn/api-explorer?project=hire&resource=offer&apiName=update&version=v1 click to debug }
+                 *
+                 * {@link https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/offer/update document }
+                 *
+                 * 更新 Offer 信息
+                 *
+                 * 1. 更新 Offer 时，需传入本文档中标注为必传的参数，其余参数是否必传参考「获取 Offer 申请表模板信息」的参数定义；;2. 对系统中已存在的 offer 进行更新的，若更新 offer 中含有「修改需审批」的字段，更新后原 Offer 的审批会自动撤回，需要重新发起审批
+                 */
+                update: (payload, options) => __awaiter(this, void 0, void 0, function* () {
+                    const { headers, params, data, path } = yield this.formatPayload(payload, options);
+                    return this.httpInstance
+                        .request({
+                        url: fillApiPath(`${this.domain}/open-apis/hire/v1/offers/:offer_id`, path),
+                        method: "PUT",
+                        data,
+                        params,
+                        headers,
+                    })
+                        .catch((e) => {
+                        this.logger.error(formatErrors(e));
+                        throw e;
+                    });
+                }),
+            },
             /**
              * offer_schema
              */
@@ -13523,6 +13745,35 @@ class Client$1 {
                     });
                 }),
             },
+            /**
+             * 问卷（灰度租户可见）
+             */
+            questionnaire: {
+                /**
+                 * {@link https://open.feishu.cn/api-explorer?project=hire&resource=questionnaire&apiName=list&version=v1 click to debug }
+                 *
+                 * {@link https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/questionnaire/list document }
+                 *
+                 * 获取面试满意度问卷列表
+                 *
+                 * 获取面试满意度问卷列表
+                 */
+                list: (payload, options) => __awaiter(this, void 0, void 0, function* () {
+                    const { headers, params, data, path } = yield this.formatPayload(payload, options);
+                    return this.httpInstance
+                        .request({
+                        url: fillApiPath(`${this.domain}/open-apis/hire/v1/questionnaires`, path),
+                        method: "GET",
+                        data,
+                        params,
+                        headers,
+                    })
+                        .catch((e) => {
+                        this.logger.error(formatErrors(e));
+                        throw e;
+                    });
+                }),
+            },
             /**
              * 内推
              */
@@ -15071,7 +15322,7 @@ class Client$1 {
                 }),
             },
             /**
-             * 消息加急
+             * 消息
              */
             message: {
                 /**
@@ -15126,6 +15377,28 @@ class Client$1 {
                         throw e;
                     });
                 }),
+                /**
+                 * {@link https://open.feishu.cn/api-explorer?project=im&resource=message&apiName=forward&version=v1 click to debug }
+                 *
+                 * {@link https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=forward&project=im&resource=message&version=v1 document }
+                 *
+                 * 转发一条消息
+                 */
+                forward: (payload, options) => __awaiter(this, void 0, void 0, function* () {
+                    const { headers, params, data, path } = yield this.formatPayload(payload, options);
+                    return this.httpInstance
+                        .request({
+                        url: fillApiPath(`${this.domain}/open-apis/im/v1/messages/:message_id/forward`, path),
+                        method: "POST",
+                        data,
+                        params,
+                        headers,
+                    })
+                        .catch((e) => {
+                        this.logger.error(formatErrors(e));
+                        throw e;
+                    });
+                }),
                 /**
                  * {@link https://open.feishu.cn/api-explorer?project=im&resource=message&apiName=get&version=v1 click to debug }
                  *
@@ -15228,6 +15501,28 @@ class Client$1 {
                         throw e;
                     });
                 }),
+                /**
+                 * {@link https://open.feishu.cn/api-explorer?project=im&resource=message&apiName=merge_forward&version=v1 click to debug }
+                 *
+                 * {@link https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=merge_forward&project=im&resource=message&version=v1 document }
+                 *
+                 * 合并转发多条消息
+                 */
+                mergeForward: (payload, options) => __awaiter(this, void 0, void 0, function* () {
+                    const { headers, params, data, path } = yield this.formatPayload(payload, options);
+                    return this.httpInstance
+                        .request({
+                        url: fillApiPath(`${this.domain}/open-apis/im/v1/messages/merge_forward`, path),
+                        method: "POST",
+                        data,
+                        params,
+                        headers,
+                    })
+                        .catch((e) => {
+                        this.logger.error(formatErrors(e));
+                        throw e;
+                    });
+                }),
                 /**
                  * {@link https://open.feishu.cn/api-explorer?project=im&resource=message&apiName=patch&version=v1 click to debug }
                  *
@@ -18436,7 +18731,7 @@ class Client$1 {
                 }),
             },
             /**
-             * 工作表
+             * 单元格
              */
             spreadsheetSheet: {
                 /**
@@ -19717,6 +20012,83 @@ class Client$1 {
          * 视频会议
          */
         this.vc = {
+            /**
+             * 告警中心
+             */
+            alert: {
+                listWithIterator: (payload, options) => __awaiter(this, void 0, void 0, function* () {
+                    const { headers, params, data, path } = yield this.formatPayload(payload, options);
+                    const sendRequest = (innerPayload) => __awaiter(this, void 0, void 0, function* () {
+                        const res = yield this.httpInstance
+                            .request({
+                            url: fillApiPath(`${this.domain}/open-apis/vc/v1/alerts`, path),
+                            method: "GET",
+                            headers: pickBy(innerPayload.headers, identity),
+                            params: pickBy(innerPayload.params, identity),
+                        })
+                            .catch((e) => {
+                            this.logger.error(formatErrors(e));
+                        });
+                        return res;
+                    });
+                    const Iterable = {
+                        [Symbol.asyncIterator]() {
+                            return __asyncGenerator(this, arguments, function* _a() {
+                                let hasMore = true;
+                                let pageToken;
+                                while (hasMore) {
+                                    try {
+                                        const res = yield __await(sendRequest({
+                                            headers,
+                                            params: Object.assign(Object.assign({}, params), { page_token: pageToken }),
+                                            data,
+                                        }));
+                                        const _b = get(res, "data") || {}, { 
+                                        // @ts-ignore
+                                        has_more, 
+                                        // @ts-ignore
+                                        page_token, 
+                                        // @ts-ignore
+                                        next_page_token } = _b, rest = __rest(_b, ["has_more", "page_token", "next_page_token"]);
+                                        yield yield __await(rest);
+                                        hasMore = Boolean(has_more);
+                                        pageToken = page_token || next_page_token;
+                                    }
+                                    catch (e) {
+                                        yield yield __await(null);
+                                        break;
+                                    }
+                                }
+                            });
+                        },
+                    };
+                    return Iterable;
+                }),
+                /**
+                 * {@link https://open.feishu.cn/api-explorer?project=vc&resource=alert&apiName=list&version=v1 click to debug }
+                 *
+                 * {@link https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/vc-v1/alert/list document }
+                 *
+                 * 获取告警记录
+                 *
+                 * 获取特定条件下租户的设备告警记录
+                 */
+                list: (payload, options) => __awaiter(this, void 0, void 0, function* () {
+                    const { headers, params, data, path } = yield this.formatPayload(payload, options);
+                    return this.httpInstance
+                        .request({
+                        url: fillApiPath(`${this.domain}/open-apis/vc/v1/alerts`, path),
+                        method: "GET",
+                        data,
+                        params,
+                        headers,
+                    })
+                        .catch((e) => {
+                        this.logger.error(formatErrors(e));
+                        throw e;
+                    });
+                }),
+            },
             /**
              * 导出
              */