alipay-serverless-sdk - npm Package Compare versions

Comparing version 0.0.1 to 0.0.2

package.json

 {
   "name": "alipay-serverless-sdk",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "Alipay Serverless SDK",
@@ -5,0 +5,0 @@ "main": "dist/index.js",

README.md

@@ -1,15 +0,15 @@
-# Alipay Cloud SDK
+Alipay Serverless SDK
 
-> Serverless 云端调用 - 支付宝开放平台
+> 支付宝小程序端Serverless配套SDK
 
-## Installation 安装
+# Installation 安装
 
 ```sh
-npm install alipay-cloud-sdk --save
+npm install alipay-serverless-sdk --save
 npm install @alicloud/mpserverless-sdk --save
 ```
 
-> `alipay-cloud-sdk` 依赖 `@alicloud/mpserverless-sdk`，使用时需要传入 mpserverless-sdk 实例进行初始化
+> `alipay-serverless-sdk` 依赖 `@alicloud/mpserverless-sdk`，使用时需要传入 mpserverless-sdk 实例进行初始化
 
-## Usage 使用示例
+# Usage 快速示例
 
@@ -19,3 +19,3 @@ ```js
 import MiniProgram from '@alicloud/mpserverless-sdk';
-import cloud from 'alipay-cloud-sdk';
+import cloud from 'alipay-serverless-sdk';
 
@@ -31,129 +31,412 @@ // 2. 在 app.js 中对 sdk 进行初始化
 });
-// 2.3 初始化 alipay-cloud-sdk
-cloud.init(mpserverless, {});
+// 2.3 初始化 alipay-serverless-sdk
+cloud.init(mpserverless);
 
 // 3. 在想要使用的页面导入 alipay-cloud-sdk 即可使用
 // 比如在 page.js
-import cloud from 'alipay-cloud-sdk';
+import cloud from 'alipay-serverless-sdk';
 
-cloud.base.createQrcode(urlParam, queryParam, describe);
+cloud.base.qrcode.create(urlParam, queryParam, describe);
 ```
 
-## API 接口列表
+# API Doc
 
-### cloud.init() 初始化
+注：将API Doc中各个API的上两级标题中的英文（转首字符小写驼峰格式），用点号拼接在一起，就是这个API的完整引用路径，下面是几个典型的例子。
 
-```js
-cloud.init(mpserverless, {
-  // 配置此参数后，拥有回调消息的 openapi 将回调该地址
-  notify: {
-    url: 'https://callback',
-  },
-})
-```
+```ts
+import cloud from 'alipay-serverless-sdk';
 
-### cloud.aliyun 阿里云能力
+//调用基础能力-用户授权-获取授权访问令牌API
+cloud.base.oauth.getToken
 
-> 短信
+//调用营销能力-小程序模板消息-发送模板消息API
+cloud.marketing.templateMessage.send
 
-```ts
-cloud.aliyun.sendSms(phoneNumbers: string, signName: string, templateCode: string)
-cloud.aliyun.sendBatchSms(phoneNumberJson: object, signNameJson: object, templateCode: string, templateParamJson: object)
-cloud.aliyun.querySms(phoneNumber: string, sendDate: string, pageSize: number, currentPage: number)
-cloud.aliyun.querySmsWithBizId(phoneNumber: string, sendDate: string, pageSize: number, currentPage: number, bizId: string)
-```
+//调用会员能力-支付宝身份认证-生成认证链接API
+cloud.member.identification.certify
 
-### cloud.base 通用基础能力
+//调用支付能力-花呗分期-创建花呗分期交易API
+cloud.payment.huabei.create
 
-> 用户授权
+//调用安全能力-文本风险识别-检测内容风险API
+cloud.security.textRisk.detect
 
-```ts
-cloud.base.getOAuthToken(code: string)
-cloud.base.getOAuthTokenWithAuthCode(code: string)
-cloud.base.getOAuthTokenWithRefreshToken(refreshToken: string)
+//调用阿里云能力-短信-发送API
+cloud.aliyun.shortMessage.send
 ```
 
-> 小程序二维码
+## 基础能力 Base
+### 用户授权 OAuth
+#### 获取授权访问令牌
+* API声明
 
-```ts
-cloud.base.createQrcode(urlParam: string, queryParam: string, describe: string)
-```
+getToken(code: string)
 
-### cloud.fund 资金能力
+* 入参说明
 
-> 授权
+| 字段名  | 类型     | 必填 | 说明 |
+|------|--------|----|----|
+| code | string | 是  |  授权码，用户对应用授权后得到  |
 
-```ts
-cloud.fund.freezeAuth(outOrderNo: string, outRequestNo: string, orderTitle: string, amount: string, payeeUserId: string)
-cloud.fund.unfreezeAuth(authNo: string, outRequestNo: string, amount: string, remark: string)
-cloud.fund.payTrade(subject: string, outTradeNo: string, totalAmount: string, authCode: string)
-cloud.fund.cancelAuth(authNo: string, outOrderNo: string, outRequestNo: string, remark: string)
-cloud.fund.queryAuth(authNo: string, outOrderNo: string, outRequestNo: string)
-```
+* 出参说明
 
-> 转账
+可前往[alipay.system.oauth.token](https://docs.open.alipay.com/api_9/alipay.system.oauth.token)查看更加详细的参数说明。
 
-```ts
-cloud.fund.transfer(outBizNo: string, transAmount: string, productCode: string, orderTitle: string, payee_Info: Participant)
-cloud.fund.queryTransfer(productCode: string, payFundOrderId: string)
-cloud.fund.queryAccount(alipayUserId: string)
-```
+#### 刷新授权访问令牌
+* API声明
 
-> 红包
+refreshToken(refreshToken: string)
 
-```ts
-cloud.fund.redpacketTransfer(params: object)
-```
+* 入参说明
 
-### cloud.marketing 营销能力
+| 字段名  | 类型     | 必填 | 说明 |
+|------|--------|----|----|
+| refreshToken | string | 是  |  刷新令牌，上次换取访问令牌时得到，见出参的refresh_token字段  |
 
-> 小程序模板消息
+* 出参说明
 
-```ts
-cloud.marketing.sendTemplateMessage(toUserId: string, formId: string, userTemplateId: string, page: string, data: string)
-```
+可前往[alipay.system.oauth.token](https://docs.open.alipay.com/api_9/alipay.system.oauth.token)查看更加详细的参数说明。
 
-### cloud.member 会员能力
+---
 
-> 支付宝身份认证
+### 小程序二维码 Qrcode
+#### 创建小程序二维码
+* API声明
 
-```ts
-cloud.member.initializeUserCertify(outerOrderNo: string, bizCode: string, identityParam: UserCertifyParam, merchantConfig: UserCertifyMerchantConfig)
-cloud.member.userCertify(certifyId: string)
-cloud.member.queryUserCertify(certifyId: string)
-```
+create(urlParam: string, queryParam: string, describe: string)
 
-### cloud.payment 支付能力
+* 入参说明
 
-> 通用能力
+| 字段名  | 类型     | 必填 | 说明 |
+|------|--------|----|----|
+| urlParam | string | 是  |  小程序中能访问到的页面路径，例如：page/component/component-pages/view/view  |
+| queryParam | string | 是  |  小程序的启动参数，打开小程序的query ，在小程序 onLaunch的方法中获取  |
+| describe | string | 是  |  二维码描述  |
 
-```ts
-cloud.payment.createTrade(subject: string, outTradeNo: string, totalAmount: string, buyerId: string)
-cloud.payment.queryTrade(tradeNo: string)
-cloud.payment.refundTrade(outTradeNo: string, refundAmount: string, outRequestNo: string,  refundReason: string)
-// cloud.payment.closeTrade()
-// cloud.payment.cancelTrade()
-```
+* 出参说明
 
-> 花呗分期
+可前往[alipay.open.app.qrcode.create](https://docs.open.alipay.com/api_5/alipay.open.app.qrcode.create)查看更加详细的参数说明。
 
-```ts
-cloud.payment.createHuabeiTrade(subject: string, outTradeNo: string, totalAmount: string, buyerId: string, huabeiConfig: HuabeiConfig)
-```
+---
 
-> 当面付
+## 营销能力 Marketing
+### 小程序模板消息 TemplateMessage
+#### 发送模板消息
+* API声明
 
-```ts
-// cloud.payment.payFaceToFaceTrade()
-```
+send(toUserId: string, formId: string, userTemplateId: string, page: string, data: string)
+			
+* 入参说明
 
+| 字段名  | 类型     | 必填 | 说明 |
+|------|--------|----|----|
+| toUserId | string | 是  |  发送消息的支付宝账号  |
+| formId | string | 是  |  用户发生的交易行为的交易号，或者用户在小程序产生表单提交的表单号，用于信息发送的校验  |
+| userTemplateId | string | 是  |  用户申请的模板id号，固定的模板id会发送固定的消息  |
+| page | string | 是  |  小程序的跳转页面，用于消息中心用户点击之后详细跳转的小程序页面，例如：page/component/index |
+| data | string | 是  |  开发者需要发送模板消息中的自定义部分来替换模板的占位符，例如：{"keyword1": {"value" : "12:00"},"keyword2": {"value" : "20180808"},"keyword3": {"value" : "支付宝"}}  |
 
-### cloud.security 安全能力
+* 出参说明
 
-> 文本风险识别
+可前往[alipay.open.app.mini.templatemessage.send](https://docs.open.alipay.com/api_5/alipay.open.app.mini.templatemessage.send)查看更加详细的参数说明。
 
-```ts
-cloud.security.detectRiskContent(content: string);
-```
+---
 
-## Contribute 共建
+
+## 会员能力 Member
+### 支付宝身份认证 Identification
+#### 身份认证初始化
+* API声明
+
+init(outerOrderNo: string, bizCode: string, identityParam: IdentityParam, merchantConfig: MerchantConfig)
+			
+* 入参说明
+
+| 字段名  | 类型     | 必填 | 说明 |
+|------|--------|----|----|
+| outerOrderNo | string | 是  |  商户请求的唯一标识，商户要保证其唯一性，值为32位长度的字母数字组合，建议前面几位字符是商户自定义的简称，中间可以使用一段时间，后段可以使用一个随机或递增序列  |
+| bizCode | string | 是  |  认证场景码，入参支持的认证场景码和商户签约的认证场景相关，可选值有如下，FACE：多因子人脸认证；CERT_PHOTO：多因子证照认证；CERT_PHOTO_FACE：多因子证照和人脸认证；SMART_FACE：多因子快捷认证  |
+| identityParam | IdentityParam | 是  |   需要验证的身份信息参数  |
+| merchantConfig | MerchantConfig | 是  |  商户个性化配置  |
+
+IdentityParam对象说明
+
+| 字段名  | 类型     | 必填 | 说明 |
+|------|--------|----|----|
+| identity_type | string | 是  |  身份信息参数类型，必须传入CERT_INFO  |
+| cert_type | string | 是  |  证件类型，当前支持身份证，必须传入IDENTITY_CARD  |
+| cert_name | string | 是  |  真实姓名 |
+| cert_no | string | 是  |  证件号码  |
+
+MerchantConfig对象说明
+
+| 字段名  | 类型     | 必填 | 说明 |
+|------|--------|----|----|
+| return_url | string | 是  |  需要回跳的目标URL地址，一般指定为商户业务页面  |
+
+* 出参说明
+
+可前往[alipay.user.certify.open.initialize](https://docs.open.alipay.com/api_2/alipay.user.certify.open.initialize)查看更加详细的参数说明。
+
+#### 生成认证链接
+* API声明
+
+certify(certifyId: string)
+			
+* 入参说明
+
+| 字段名  | 类型     | 必填 | 说明 |
+|------|--------|----|----|
+| certify_id | string | 是  |  本次申请操作的唯一标识，由身份认证初始化接口调用后生成，后续的操作都需要用到  |
+
+* 出参说明
+
+可前往[alipay.user.certify.open.certify](https://docs.open.alipay.com/api_2/alipay.user.certify.open.certify)查看更加详细的参数说明。
+
+#### 身份认证记录查询
+* API声明
+
+query(certifyId: string)
+			
+* 入参说明
+
+| 字段名  | 类型     | 必填 | 说明 |
+|------|--------|----|----|
+| certify_id | string | 是  |  身份认证操作的唯一标识，由身份认证初始化接口调用后生成  |
+
+* 出参说明
+
+可前往[alipay.user.certify.open.query](https://docs.open.alipay.com/api_2/alipay.user.certify.open.query)查看更加详细的参数说明。
+
+---
+
+
+## 支付能力 Payment
+### 通用接口 Common
+#### 创建交易
+* API声明
+
+create(subject: string, outTradeNo: string, totalAmount: string, buyerId: string)
+
+* 入参说明
+
+| 字段名  | 类型     | 必填 | 说明 |
+|------|--------|----|----|
+| subject | string | 是  |  订单标题  |
+| outTradeNo | string | 是  | 商户订单号，64个字符以内，可包含字母、数字、下划线，需保证在商户端不重复  |
+| totalAmount | string | 是  | 订单总金额，单位为元，精确到小数点后两位，取值范围[0.01,100000000]  |
+| buyerId | string | 否  | 买家的支付宝用户ID，如果为空，会从传入的码值信息中获取买家ID  |
+
+* 出参说明
+
+可前往[alipay.trade.pay](https://docs.open.alipay.com/api_1/alipay.trade.pay)查看更加详细的参数说明。
+
+#### 查询交易
+* API声明
+
+query(outTradeNo: string)
+
+* 入参说明
+
+| 字段名  | 类型     | 必填 | 说明 |
+|------|--------|----|----|
+| outTradeNo | string | 是  |  交易创建时传入的商户订单号  |
+
+* 出参说明
+
+可前往[alipay.trade.query](https://docs.open.alipay.com/api_1/alipay.trade.query)查看更加详细的参数说明。
+
+#### 交易退款
+* API声明
+
+refund(outTradeNo: string, refundAmount: string)
+
+* 入参说明
+
+| 字段名  | 类型     | 必填 | 说明 |
+|------|--------|----|----|
+| outTradeNo | string | 是  |  交易创建时传入的商户订单号  |
+| refundAmount | string | 是  |  需要退款的金额，该金额不能大于订单金额，单位为元，支持两位小数  |
+
+* 出参说明
+
+可前往[alipay.trade.refund](https://docs.open.alipay.com/api_1/alipay.trade.refund)查看更加详细的参数说明。
+
+#### 关闭交易
+* API声明
+
+close(outTradeNo: string)
+
+* 入参说明
+
+| 字段名  | 类型     | 必填 | 说明 |
+|------|--------|----|----|
+| outTradeNo | string | 是  |  交易创建时传入的商户订单号  |
+
+* 出参说明
+
+可前往[alipay.trade.close](https://docs.open.alipay.com/api_1/alipay.trade.close)查看更加详细的参数说明。
+
+#### 撤销交易
+* API声明
+
+cancel(outTradeNo: string)
+
+* 入参说明
+
+| 字段名  | 类型     | 必填 | 说明 |
+|------|--------|----|----|
+| outTradeNo | string | 是  |  交易创建时传入的商户订单号  |
+
+* 出参说明
+
+可前往[alipay.trade.cancel](https://docs.open.alipay.com/api_1/alipay.trade.cancel)查看更加详细的参数说明。
+
+---
+
+### 花呗分期 HuaBei
+#### 创建花呗分期交易
+* API声明
+
+create(subject: string, outTradeNo: string, totalAmount: string, buyerId: string, extendParams: HuabeiConfig)
+
+* 入参说明
+
+| 字段名  | 类型     | 必填 | 说明 |
+|------|--------|----|----|
+| subject | string | 是  |  订单标题  |
+| outTradeNo | string | 是  | 商户订单号，64个字符以内，可包含字母、数字、下划线，需保证在商户端不重复  |
+| totalAmount | string | 是  | 订单总金额，单位为元，精确到小数点后两位，取值范围[0.01,100000000]  |
+| buyerId | string | 否  | 买家的支付宝用户ID，如果为空，会从传入的码值信息中获取买家ID  |
+| extendParams | HuabeiConfig | 是  |  花呗交易扩展参数  |
+
+HuabeiConfig对象说明
+
+| 字段名  | 类型     | 必填 | 说明 |
+|------|--------|----|----|
+| hbFqNum | string | 是  | 花呗分期数，仅支持传入3、6、12  |
+| hbFqSellerPercent | string | 是  | 代表卖家承担收费比例，商家承担手续费传入100，用户承担手续费传入0，仅支持传入100、0两种  |
+
+
+* 出参说明
+
+可前往[alipay.trade.create](https://docs.open.alipay.com/api_1/alipay.trade.create)查看更加详细的参数说明。
+
+--- 
+
+### 当面付 FaceToFace
+#### 当面付交易付款
+* API声明
+
+pay(subject: string, outTradeNo: string, totalAmount: string, authCode: string)
+
+* 入参说明
+
+| 字段名  | 类型     | 必填 | 说明 |
+|------|--------|----|----|
+| subject | string | 是  |  订单标题  |
+| outTradeNo | string | 是  |  交易创建时传入的商户订单号  |
+| totalAmount | string | 是  |  订单总金额，单位为元，精确到小数点后两位，取值范围[0.01,100000000]  |
+| authCode | string | 是  |  支付授权码，25~30开头的长度为16~24位的数字，实际字符串长度以开发者获取的付款码长度为准  |
+
+* 出参说明
+
+可前往[alipay.trade.pay](https://docs.open.alipay.com/api_1/alipay.trade.pay)查看更加详细的参数说明。
+
+---
+
+## 安全能力 Security
+### 文本风险识别 TextRisk
+### 检测内容风险
+* API声明
+
+detect(content: string)
+
+* 入参说明
+
+| 字段名  | 类型     | 必填 | 说明 |
+|------|--------|----|----|
+| content | string | 是  |  待检测的文本内容 |
+
+* 出参说明
+
+可前往[alipay.security.risk.content.detect](https://docs.open.alipay.com/api_49/alipay.security.risk.content.detect)查看更加详细的参数说明。
+
+## 阿里云能力 Aliyun
+### 短信 ShortMessage
+#### 发送
+* API声明
+
+send(phoneNumbers: string, signName: string, templateCode: string)
+
+* 入参说明
+
+| 字段名  | 类型     | 必填 | 说明 |
+|------|--------|----|----|
+| phoneNumbers | string | 是  |  短信接收号码,支持以逗号分隔的形式进行批量调用，批量上限为1000个手机号码,批量调用相对于单条调用及时性稍有延迟，验证码类型的短信推荐使用单条调用的方式；发送国际/港澳台消息时，接收号码格式为：国际区号+号码，如“85200000000” |
+| signName | string | 是  |  短信签名 |
+| templateCode | string | 是  |  短信模板ID，发送国际/港澳台消息时，请使用国际/港澳台短信模版 |
+
+* 出参说明
+
+可前往[SendSms](https://help.aliyun.com/document_detail/55284.htm)查看更加详细的参数说明。
+
+#### 批量发送
+* API声明
+
+batchSend(phoneNumberJson: object, signNameJson: object, templateCode: string, templateParamJson: string)
+
+* 入参说明
+
+| 字段名  | 类型     | 必填 | 说明 |
+|------|--------|----|----|
+| phoneNumberJson | string | 是  |  短信接收号码,JSON格式，批量上限为100个手机号码，批量调用相对于单条调用及时性稍有延迟，验证码类型的短信推荐使用单条调用的方式 |
+| signNameJson | string | 是  |  JOSN格式短信签名，例如：[“云通信”,”云通信”] |
+| templateCode | string | 是  |  短信模板ID，发送国际/港澳台消息时，请使用国际/港澳台短信模版 |
+| templateParamJson | string | 是  |  短信模板变量替换JSON串，例如：[{“code”:”1234”,”product”:”ytx1”},{“code”:”5678”,”product”:”ytx2”}] |
+
+* 出参说明
+
+可前往[SendBatchSms](https://help.aliyun.com/document_detail/66041.html)查看更加详细的参数说明。
+
+#### 查询
+* API声明
+
+query(phoneNumber: string, sendDate: string, pageSize: number, currentPage: number)
+
+* 入参说明
+
+| 字段名  | 类型     | 必填 | 说明 |
+|------|--------|----|----|
+| phoneNumber | string | 是  | 短信接收号码,如果需要查询国际短信,号码前需要带上对应国家的区号,区号的获取详见国际短信支持国家信息查询API接口  |
+| sendDate | string | 是  | 短信发送日期格式yyyyMMdd,支持最近30天记录查询，例如：20170525 |
+| pageSize | number | 是  | 页大小，最大不超过50 |
+| currentPage | number | 是  | 当前页码 |
+
+* 出参说明
+
+可前往[QuerySendDetails](https://help.aliyun.com/document_detail/55289.html)查看更加详细的参数说明。
+
+#### 精准查询
+* API声明
+
+preciseQuery(phoneNumber: string, sendDate: string, pageSize: number, currentPage: number, bizId: string)
+
+* 入参说明
+
+| 字段名  | 类型     | 必填 | 说明 |
+|------|--------|----|----|
+| phoneNumber | string | 是  | 短信接收号码,如果需要查询国际短信,号码前需要带上对应国家的区号,区号的获取详见国际短信支持国家信息查询API接口  |
+| sendDate | string | 是  | 短信发送日期格式yyyyMMdd,支持最近30天记录查询，例如：20170525 |
+| pageSize | number | 是  | 页大小，最大不超过50 |
+| currentPage | number | 是  | 当前页码 |
+| bizId | string | 是  | 发送流水号,从调用发送接口返回值中获取 |
+
+* 出参说明
+
+可前往[QuerySendDetails](https://help.aliyun.com/document_detail/55289.html)查看更加详细的参数说明。
+
+
+
+
+

New alerts

Native code

Supply chain risk

Contains native code (e.g., compiled binaries or shared libraries). Including native code can obscure malicious behavior.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

158674

increased by14.23%

Number of package files

72

increased by1.41%

Number of lines in readme file

441

increased by179.11%

Worsened metrics

Number of medium supply chain risk alerts

2

increased by100%

No dependency changes