@larksuiteoapi/node-sdk 1.17.0 → 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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@larksuiteoapi/node-sdk",
-  "version": "1.17.0",
+  "version": "1.17.1",
   "description": "larksuite open sdk for nodejs",
   "keywords": [
     "feishu",

package/types/index.d.ts

@@ -11,6 +11,7 @@
  */
 
 import { AxiosInstance, AxiosRequestConfig } from 'axios';
+import fs from 'fs';
 
 declare const defaultHttpInstance: AxiosInstance;
 
@@ -268,7 +269,7 @@ declare abstract class Client$1 {
              */
             update: (payload?: {
                 data: {
-                    files: Buffer;
+                    files: Buffer | fs.ReadStream;
                     file_type: string;
                     file_name: string;
                 };
@@ -1001,7 +1002,7 @@ declare abstract class Client$1 {
              */
             create: (payload?: {
                 data: {
-                    image_file: Buffer;
+                    image_file: Buffer | fs.ReadStream;
                     image_type: number;
                 };
             }, options?: IRequestOptions$1) => Promise<{
@@ -3511,7 +3512,7 @@ declare abstract class Client$1 {
              */
             upload: (payload?: {
                 data?: {
-                    file?: Buffer;
+                    file?: Buffer | fs.ReadStream;
                 };
                 params: {
                     file_name: string;
@@ -6590,7 +6591,7 @@ declare abstract class Client$1 {
             upload: (payload?: {
                 data: {
                     name: string;
-                    file: Buffer;
+                    file: Buffer | fs.ReadStream;
                 };
             }, options?: IRequestOptions$1) => Promise<{
                 file_token?: string | undefined;
@@ -39172,7 +39173,7 @@ declare abstract class Client$1 {
                     parent_node: string;
                     size: number;
                     checksum?: string;
-                    file: Buffer;
+                    file: Buffer | fs.ReadStream;
                 };
             }, options?: IRequestOptions$1) => Promise<{
                 file_token?: string | undefined;
@@ -39217,7 +39218,7 @@ declare abstract class Client$1 {
                     seq: number;
                     size: number;
                     checksum?: string;
-                    file: Buffer;
+                    file: Buffer | fs.ReadStream;
                 };
             }, options?: IRequestOptions$1) => Promise<{} | null>;
             /**
@@ -39713,7 +39714,7 @@ declare abstract class Client$1 {
                     size: number;
                     checksum?: string;
                     extra?: string;
-                    file: Buffer;
+                    file: Buffer | fs.ReadStream;
                 };
             }, options?: IRequestOptions$1) => Promise<{
                 file_token?: string | undefined;
@@ -39758,7 +39759,7 @@ declare abstract class Client$1 {
                     seq: number;
                     size: number;
                     checksum?: string;
-                    file: Buffer;
+                    file: Buffer | fs.ReadStream;
                 };
             }, options?: IRequestOptions$1) => Promise<{} | null>;
             /**
@@ -47258,7 +47259,7 @@ declare abstract class Client$1 {
                     file_type: "opus" | "mp4" | "pdf" | "doc" | "xls" | "ppt" | "stream";
                     file_name: string;
                     duration?: number;
-                    file: Buffer;
+                    file: Buffer | fs.ReadStream;
                 };
             }, options?: IRequestOptions$1) => Promise<{
                 file_key?: string | undefined;
@@ -47300,7 +47301,7 @@ declare abstract class Client$1 {
             create: (payload?: {
                 data: {
                     image_type: "message" | "avatar";
-                    image: Buffer;
+                    image: Buffer | fs.ReadStream;
                 };
             }, options?: IRequestOptions$1) => Promise<{
                 image_key?: string | undefined;
@@ -49482,7 +49483,7 @@ declare abstract class Client$1 {
              */
             upload: (payload?: {
                 data: {
-                    data: Buffer;
+                    data: Buffer | fs.ReadStream;
                     target_id: string;
                     target_type: number;
                 };