@larksuiteoapi/node-sdk 1.19.0 → 1.20.0

package/es/index.js

@@ -570,7 +570,7 @@ class Client$1 {
             },
         };
         /**
-         * 管理后台-密码
+         * 管理后台-企业勋章
          */
         this.admin = {
             /**
@@ -1102,6 +1102,32 @@ class Client$1 {
              * 应用使用情况
              */
             applicationAppUsage: {
+                /**
+                 * {@link https://open.feishu.cn/api-explorer?project=application&resource=application.app_usage&apiName=department_overview&version=v6 click to debug }
+                 *
+                 * {@link https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application-app_usage/department_overview document }
+                 *
+                 * 获取多部门应用使用概览（灰度租户可见）
+                 *
+                 * 查看应用在某一天/某一周/某一个月的使用数据，可以根据部门做多层子部门的筛选
+                 *
+                 * 1. 仅支持企业版/旗舰版租户使用;2. 一般每天早上10点产出前一天的数据;3. 已经支持的指标包括：应用的活跃用户数、累计用户数、新增用户数、访问页面数、打开次数;4. 按照部门查看数据时，可以分别展示当前部门以及其子部门的使用情况;5. 如果查询的部门在查询日期没有使用过应用，只返回指标：应用的活跃用户数指标;6. 数据从飞书4.10版本开始统计，使用飞书版本4.10及以下版本的用户数据不会被统计到;7. 调用频控为100次/分
+                 */
+                departmentOverview: (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/application/v6/applications/:app_id/app_usage/department_overview`, path),
+                        method: "POST",
+                        data,
+                        params,
+                        headers,
+                    })
+                        .catch((e) => {
+                        this.logger.error(formatErrors(e));
+                        throw e;
+                    });
+                }),
                 /**
                  * {@link https://open.feishu.cn/api-explorer?project=application&resource=application.app_usage&apiName=overview&version=v6 click to debug }
                  *
@@ -1505,7 +1531,7 @@ class Client$1 {
          */
         this.approval = {
             /**
-             * 原生审批定义
+             * 事件
              */
             approval: {
                 /**
@@ -1637,6 +1663,26 @@ class Client$1 {
                         throw e;
                     });
                 }),
+                /**
+                 * {@link https://open.feishu.cn/api-explorer?project=approval&resource=external_approval&apiName=get&version=v4 click to debug }
+                 *
+                 * {@link https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=get&project=approval&resource=external_approval&version=v4 document }
+                 */
+                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/approval/v4/external_approvals/:approval_code`, path),
+                        method: "GET",
+                        data,
+                        params,
+                        headers,
+                    })
+                        .catch((e) => {
+                        this.logger.error(formatErrors(e));
+                        throw e;
+                    });
+                }),
             },
             /**
              * 三方审批实例
@@ -8442,6 +8488,99 @@ class Client$1 {
                     });
                 }),
             },
+            /**
+             * job_title
+             */
+            jobTitle: {
+                /**
+                 * {@link https://open.feishu.cn/api-explorer?project=contact&resource=job_title&apiName=get&version=v3 click to debug }
+                 *
+                 * {@link https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=get&project=contact&resource=job_title&version=v3 document }
+                 */
+                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/contact/v3/job_titles/:job_title_id`, path),
+                        method: "GET",
+                        data,
+                        params,
+                        headers,
+                    })
+                        .catch((e) => {
+                        this.logger.error(formatErrors(e));
+                        throw e;
+                    });
+                }),
+                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/contact/v3/job_titles`, 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=contact&resource=job_title&apiName=list&version=v3 click to debug }
+                 *
+                 * {@link https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=list&project=contact&resource=job_title&version=v3 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/contact/v3/job_titles`, path),
+                        method: "GET",
+                        data,
+                        params,
+                        headers,
+                    })
+                        .catch((e) => {
+                        this.logger.error(formatErrors(e));
+                        throw e;
+                    });
+                }),
+            },
             /**
              * 通讯录权限范围
              */
@@ -9060,6 +9199,119 @@ class Client$1 {
                         throw e;
                     });
                 }),
+                /**
+                 * {@link https://open.feishu.cn/api-explorer?project=contact&resource=user&apiName=update_user_id&version=v3 click to debug }
+                 *
+                 * {@link https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=update_user_id&project=contact&resource=user&version=v3 document }
+                 */
+                updateUserId: (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/contact/v3/users/:user_id/update_user_id`, path),
+                        method: "PATCH",
+                        data,
+                        params,
+                        headers,
+                    })
+                        .catch((e) => {
+                        this.logger.error(formatErrors(e));
+                        throw e;
+                    });
+                }),
+            },
+            /**
+             * work_city
+             */
+            workCity: {
+                /**
+                 * {@link https://open.feishu.cn/api-explorer?project=contact&resource=work_city&apiName=get&version=v3 click to debug }
+                 *
+                 * {@link https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=get&project=contact&resource=work_city&version=v3 document }
+                 */
+                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/contact/v3/work_cities/:work_city_id`, path),
+                        method: "GET",
+                        data,
+                        params,
+                        headers,
+                    })
+                        .catch((e) => {
+                        this.logger.error(formatErrors(e));
+                        throw e;
+                    });
+                }),
+                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/contact/v3/work_cities`, 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=contact&resource=work_city&apiName=list&version=v3 click to debug }
+                 *
+                 * {@link https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=list&project=contact&resource=work_city&version=v3 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/contact/v3/work_cities`, path),
+                        method: "GET",
+                        data,
+                        params,
+                        headers,
+                    })
+                        .catch((e) => {
+                        this.logger.error(formatErrors(e));
+                        throw e;
+                    });
+                }),
             },
         };
         /**
@@ -12264,6 +12516,30 @@ class Client$1 {
                         throw e;
                     });
                 }),
+                /**
+                 * {@link https://open.feishu.cn/api-explorer?project=drive&resource=file&apiName=delete_subscribe&version=v1 click to debug }
+                 *
+                 * {@link https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/delete_subscribe document }
+                 *
+                 * 取消云文档事件订阅情况
+                 *
+                 * 该接口**仅支持文档拥有者**取消订阅自己文档的通知事件，可订阅的文档类型为**旧版文档**、**新版文档**、**电子表格**和**多维表格**。在调用该接口之前请确保正确[配置事件回调网址和订阅事件类型](https://open.feishu.cn/document/ukTMukTMukTM/uUTNz4SN1MjL1UzM#2eb3504a)，事件类型参考[事件列表](https://open.feishu.cn/document/ukTMukTMukTM/uYDNxYjL2QTM24iN0EjN/event-list)。
+                 */
+                deleteSubscribe: (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/drive/v1/files/:file_token/delete_subscribe`, path),
+                        method: "DELETE",
+                        data,
+                        params,
+                        headers,
+                    })
+                        .catch((e) => {
+                        this.logger.error(formatErrors(e));
+                        throw e;
+                    });
+                }),
                 /**
                  * {@link https://open.feishu.cn/api-explorer?project=drive&resource=file&apiName=download&version=v1 click to debug }
                  *
@@ -12305,6 +12581,30 @@ class Client$1 {
                         }),
                     };
                 }),
+                /**
+                 * {@link https://open.feishu.cn/api-explorer?project=drive&resource=file&apiName=get_subscribe&version=v1 click to debug }
+                 *
+                 * {@link https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/get_subscribe document }
+                 *
+                 * 查询云文档事件订阅状态
+                 *
+                 * 该接口**仅支持文档拥有者**查询自己文档的订阅状态，可订阅的文档类型为**旧版文档**、**新版文档**、**电子表格**和**多维表格**。在调用该接口之前请确保正确[配置事件回调网址和订阅事件类型](https://open.feishu.cn/document/ukTMukTMukTM/uUTNz4SN1MjL1UzM#2eb3504a)，事件类型参考[事件列表](https://open.feishu.cn/document/ukTMukTMukTM/uYDNxYjL2QTM24iN0EjN/event-list)。
+                 */
+                getSubscribe: (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/drive/v1/files/:file_token/get_subscribe`, path),
+                        method: "GET",
+                        data,
+                        params,
+                        headers,
+                    })
+                        .catch((e) => {
+                        this.logger.error(formatErrors(e));
+                        throw e;
+                    });
+                }),
                 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* () {
@@ -16574,6 +16874,79 @@ class Client$1 {
                     });
                 }),
             },
+            /**
+             * registration_schema
+             */
+            registrationSchema: {
+                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/registration_schemas`, 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=registration_schema&apiName=list&version=v1 click to debug }
+                 *
+                 * {@link https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=list&project=hire&resource=registration_schema&version=v1 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/registration_schemas`, path),
+                        method: "GET",
+                        data,
+                        params,
+                        headers,
+                    })
+                        .catch((e) => {
+                        this.logger.error(formatErrors(e));
+                        throw e;
+                    });
+                }),
+            },
             /**
              * 简历来源
              */
@@ -16805,6 +17178,35 @@ class Client$1 {
                     });
                 }),
             },
+            /**
+             * talent_object
+             */
+            talentObject: {
+                /**
+                 * {@link https://open.feishu.cn/api-explorer?project=hire&resource=talent_object&apiName=query&version=v1 click to debug }
+                 *
+                 * {@link https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/talent_object/query document }
+                 *
+                 * 获取人才字段
+                 *
+                 * 获取人才字段
+                 */
+                query: (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/talent_objects/query`, path),
+                        method: "GET",
+                        data,
+                        params,
+                        headers,
+                    })
+                        .catch((e) => {
+                        this.logger.error(formatErrors(e));
+                        throw e;
+                    });
+                }),
+            },
         };
         /**
          * 实名认证
@@ -18093,7 +18495,7 @@ class Client$1 {
                 }),
             },
             /**
-             * 消息
+             * 消息加急
              */
             message: {
                 /**
@@ -22042,7 +22444,7 @@ class Client$1 {
                 }),
             },
             /**
-             * 单元格
+             * 工作表
              */
             spreadsheetSheet: {
                 /**