@larksuiteoapi/node-sdk 1.0.1 → 1.0.4
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 +4 -6
- package/README.zh.md +0 -2
- package/es/index.js +531 -373
- package/lib/index.js +531 -373
- package/package.json +1 -3
- package/types/index.d.ts +1556 -1224
package/README.md
CHANGED
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
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.
|
|
8
8
|
|
|
9
9
|
## Concept
|
|
10
|
-
- Development documentation: A reference to the open interface of the open platform, **
|
|
10
|
+
- 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/) .
|
|
11
11
|
|
|
12
12
|
- Developer background: The management background of the developer's development application, [more introduction](https://open.feishu.cn/app/).
|
|
13
13
|
|
|
@@ -66,8 +66,6 @@ const res = await client.im.message.create({
|
|
|
66
66
|
},
|
|
67
67
|
});
|
|
68
68
|
````
|
|
69
|
-
> Note: The SDK has made a complete type declaration for the call result of the API. In development, most of our focus is on the call result itself, but there are still a few scenarios where we need to pay attention to the details of the API call. The SDK puts this part of the content in the result’s prototype of the call, and if you need to get this part of the information, you can use `res.request` to get it.
|
|
70
|
-
|
|
71
69
|
> tips: If you want to debug an API, you can click the link in the comment to enter the API debugging platform for debugging:
|
|
72
70
|

|
|
73
71
|
|
|
@@ -87,13 +85,13 @@ For store apps, the specified appType that needs to be displayed is lark.AppType
|
|
|
87
85
|
```typescript
|
|
88
86
|
import * as lark from '@larksuiteoapi/node-sdk';
|
|
89
87
|
|
|
90
|
-
const client = new lark.
|
|
88
|
+
const client = new lark.Client({
|
|
91
89
|
appId: 'app id',
|
|
92
90
|
appSecret: 'app secret',
|
|
93
91
|
appType: lark.AppType.ISV,
|
|
94
92
|
});
|
|
95
93
|
````
|
|
96
|
-
**When using the client of the created store application to initiate an API call, you need to manually pass the [tenant_key](https://open.feishu.cn/document/ukTMukTMukTM/ukDNz4SO0MjL5QzM/g#d15ab5d)**, you can Use lark.withTenantKey to do it:
|
|
94
|
+
**When using the client of the created store application to initiate an API call, you need to manually pass the [tenant_key](https://open.feishu.cn/document/ukTMukTMukTM/ukDNz4SO0MjL5QzM/g#d15ab5d)**, you can Use `lark.withTenantKey` to do it:
|
|
97
95
|
```typescript
|
|
98
96
|
client.im.message.create({
|
|
99
97
|
params: {
|
|
@@ -449,4 +447,4 @@ new lark.AESCipher('encrypt key').decrypt('content');
|
|
|
449
447
|
MIT
|
|
450
448
|
|
|
451
449
|
## Contact Us
|
|
452
|
-
Click [Server SDK](https://open.feishu.cn/document/ukTMukTMukTM/uETO1YjLxkTN24SM5UjN) in the upper right corner of the page
|
|
450
|
+
Click [Server SDK](https://open.feishu.cn/document/ukTMukTMukTM/uETO1YjLxkTN24SM5UjN) in the upper right corner of the page 【Is this document helpful to you? 】Submit feedback
|
package/README.zh.md
CHANGED
|
@@ -65,8 +65,6 @@ const res = await client.im.message.create({
|
|
|
65
65
|
},
|
|
66
66
|
});
|
|
67
67
|
```
|
|
68
|
-
> 注:SDK对API的调用结果做了完备的类型声明,在开发中我们绝大部分关注点在于调用结果本身,但仍有少数场景需要关注API的调用细节,SDK将这部分内容放在了调用结果的原型对象上,如果需要得到这部分信息,可以使用`res.request`来获取。
|
|
69
|
-
|
|
70
68
|
> tips: 如果想调试某个api,可以点击注释中的链接进入api调试台进行调试:
|
|
71
69
|

|
|
72
70
|
|