@yunzhanghu/sdk-nodejs 1.0.2 → 1.0.4

package/.editorconfig

@@ -0,0 +1,8 @@
+# .editorconfig
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+charset = utf-8

package/.eslintrc.js

@@ -0,0 +1,16 @@
+module.exports = {
+    extends: ['@yzh-devkit/eslint-config-lint/eslintWithTS'],
+    ignorePatterns: ['.eslintrc.js', 'tdsformat.js'],
+    rules: {
+        'react/no-array-index-key': 'off',
+        'no-underscore-dangle': 'off',
+        'react/no-unstable-nested-components': 'off',
+        '@typescript-eslint/no-unsafe-argument': 'off',
+        '@typescript-eslint/no-var-requires': 'off',
+        // // warn
+        // 'simple-import-sort/imports': [
+        //     'warn',
+        //     { groups: [['^react', '^[a-z]', '^@[^/]'], ['^@/'], ['^\\.'], ['.(less|css)$']] },
+        // ],
+    },
+};

package/.prettierrc.js

@@ -0,0 +1,3 @@
+module.exports = {
+    ...require('@yzh-devkit/eslint-config-lint/prettier'),
+};

package/README.md

@@ -64,8 +64,13 @@ OpenSSL-> rsa -in private_key.pem -pubout -out pubkey.pem
 ### 示例功能列表
 
 - [用户信息验证](./example/authentication.js)
-- [用户签约（H5 签约）](./example/h5UserSign.js) or [用户签约（API 签约）](./example/apiUserSign.js)
-- [个体工商户注册（云账户新经济 H5）](./example/bizlicXjjH5.js) or [个体工商户注册（云账户新经济 H5+API）](./example/bizlicXjjH5Api.js)
+- 用户签约
+   - [H5 签约](./example/h5UserSign.js)
+   - [API 签约](./example/apiUserSign.js)
+   - [签约信息上传](./example/uploadusersign.js)
+- 个体工商户注册
+   - [云账户新经济 H5](./example/bizlicXjjH5.js)
+   - [云账户新经济 H5](./example/bizlicXjjH5.js) 
 - [实时支付](./example/payment.js)
 - [异步通知](./example/notify.js)
 - [对账文件获取](./example/dataService.js)
@@ -103,15 +108,27 @@ const client = new yunzhanghu.InvoiceClient({
 // 如：GetInvoiceAmount 查询可开具发票额度和发票开具信息
 client
   .GetInvoiceAmount({
+    
+    /**
+      * @param {string} request-id：请求 ID，请求的唯一标识
+      * 建议平台企业自定义 request-id，并记录在日志中，便于问题发现及排查
+      * 如未自定义 request-id，将使用 SDK 中的 UUID 方法自动生成。注意：UUID 方法生成的 request-id 不能保证全局唯一，推荐自定义 request-id
+      */
+    request_id: "requestIdExample123456789",
     dealer_id: process.env.DEALER_ID,
     broker_id: process.env.BROKER_ID,
-// 可自定义 Header 中的 request-id，建议将 request-id 记录在日志中
-// request_id:'req1678257009001'
   })
   .then((data) => {
-    console.log("data", data)
+    if (data.code === "0000") {
+      // 操作成功
+      console.log("操作成功 ", data.data)
+    } else {
+      // 失败返回
+      console.log("失败返回 ", "code：" + data.code + " message：" + data.message + " request_id：" + data.request_id)
+    } 
   })
   .catch((err) => {
-    console.error("error", err)
+    // 发生异常
+    console.log(err.toString())
   })
 ```

package/example/apiUserSign.js

@@ -2,69 +2,123 @@ const yzhAPI = require("../yzh/index.js")
 const config = require("./conf/config.js")
 
 // 用户签约（API 签约）
-
 const apiusersign = new yzhAPI.ApiUserSignServiceClient(config)
 
 // 获取协议预览 URL
 apiusersign
   .ApiUserSignContract({
+
+    /**
+      * @param {string} request-id：请求 ID，请求的唯一标识
+      * 建议平台企业自定义 request-id，并记录在日志中，便于问题发现及排查
+      * 如未自定义 request-id，将使用 SDK 中的 UUID 方法自动生成。注意：UUID 方法生成的 request-id 不能保证全局唯一，推荐自定义 request-id
+      */
+    request_id: "requestIdExample123456789",
     dealer_id: config.dealer_id,
     broker_id: config.broker_id,
   })
   .then((data) => {
-    console.log("响应内容：", data)
+    if (data.code === "0000") {
+      // 操作成功
+      console.log("操作成功 ", data.data)
+    } else {
+      // 失败返回
+      console.log("失败返回 ", "code：" + data.code + " message：" + data.message + " request_id：" + data.request_id)
+    } 
   })
   .catch((err) => {
+    // 发生异常
     console.log(err.toString())
   })
 
 // 用户签约
 apiusersign
   .ApiUserSign({
+    
+    /**
+      * @param {string} request-id：请求 ID，请求的唯一标识
+      * 建议平台企业自定义 request-id，并记录在日志中，便于问题发现及排查
+      * 如未自定义 request-id，将使用 SDK 中的 UUID 方法自动生成。注意：UUID 方法生成的 request-id 不能保证全局唯一，推荐自定义 request-id
+      */
+    request_id: "requestIdExample123456789",
     dealer_id: config.dealer_id,
     broker_id: config.broker_id,
     real_name: "张三",
-    id_card: "120110119990000111",
-    phone: "",
-    user_id: "",
+    id_card: "110121202202222222",
+    user_id: "userId00001",
     card_type: "idcard",
   })
   .then((data) => {
-    console.log("响应内容：", data)
+    if (data.code === "0000") {
+      // 操作成功
+      console.log("操作成功 ", data.data)
+    } else {
+      // 失败返回
+      console.log("失败返回 ", "code：" + data.code + " message：" + data.message + " request_id：" + data.request_id)
+    } 
   })
   .catch((err) => {
+    // 发生异常
     console.log(err.toString())
   })
 
 // 获取用户签约状态
 apiusersign
   .GetApiUserSignStatus({
+    
+    /**
+      * @param {string} request-id：请求 ID，请求的唯一标识
+      * 建议平台企业自定义 request-id，并记录在日志中，便于问题发现及排查
+      * 如未自定义 request-id，将使用 SDK 中的 UUID 方法自动生成。注意：UUID 方法生成的 request-id 不能保证全局唯一，推荐自定义 request-id
+      */
+    request_id: "requestIdExample123456789",
     dealer_id: config.dealer_id,
     broker_id: config.broker_id,
     real_name: " 张三",
-    id_card: "120110119990000111",
-    user_id: "",
+    id_card: "110121202202222222",
+    user_id: "userId00001",
   })
   .then((data) => {
-    console.log("响应内容：", data)
+    if (data.code === "0000") {
+      // 操作成功
+      console.log("操作成功 ", data.data)
+    } else {
+      // 失败返回
+      console.log("失败返回 ", "code：" + data.code + " message：" + data.message + " request_id：" + data.request_id)
+    } 
   })
   .catch((err) => {
+    // 发生异常
     console.log(err.toString())
   })
 
 // 用户解约（测试账号专用接口）
 apiusersign
   .ApiUserSignRelease({
+    
+    /**
+      * @param {string} request-id：请求 ID，请求的唯一标识
+      * 建议平台企业自定义 request-id，并记录在日志中，便于问题发现及排查
+      * 如未自定义 request-id，将使用 SDK 中的 UUID 方法自动生成。注意：UUID 方法生成的 request-id 不能保证全局唯一，推荐自定义 request-id
+      */
+    request_id: "requestIdExample123456789",
     dealer_id: this.dealer_id,
     broker_id: this.broker_id,
     real_name: "张三",
-    id_card: "120110119990000111",
-    user_id: "",
+    id_card: "110121202202222222",
+    user_id: "userId00001",
     card_type: "idcard",
   })
   .then((data) => {
-    console.log("响应内容：", data)
+    if (data.code === "0000") {
+      // 操作成功
+      console.log("操作成功 ", data.data)
+    } else {
+      // 失败返回
+      console.log("失败返回 ", "code：" + data.code + " message：" + data.message + " request_id：" + data.request_id)
+    } 
   })
   .catch((err) => {
+    // 发生异常
     console.log(err.toString())
   })

package/example/authentication.js

@@ -4,93 +4,176 @@ const fs = require("fs")
 const path = require("path")
 
 // 用户信息验证
-
 const authentication = new yzhAPI.AuthenticationClient(config)
 
 // 银行卡四要素鉴权请求（下发短信验证码）
 authentication
   .BankCardFourAuthVerify({
+    
+    /**
+      * @param {string} request-id：请求 ID，请求的唯一标识
+      * 建议平台企业自定义 request-id，并记录在日志中，便于问题发现及排查
+      * 如未自定义 request-id，将使用 SDK 中的 UUID 方法自动生成。注意：UUID 方法生成的 request-id 不能保证全局唯一，推荐自定义 request-id
+      */
+    request_id: "requestIdExample123456789",
     real_name: "张三",
-    card_no: "6214830112341234",
-    id_card: "120111199901101234",
-    mobile: "111111111",
+    card_no: "8888888888888888888",
+    id_card: "110121202202222222",
+    mobile: "188****8888",
   })
   .then((data) => {
-    console.log("响应内容：", data)
+    if (data.code === "0000") {
+      // 操作成功
+      console.log("操作成功 ", data.data)
+    } else {
+      // 失败返回
+      console.log("失败返回 ", "code：" + data.code + " message：" + data.message + " request_id：" + data.request_id)
+    } 
   })
   .catch((err) => {
+    // 发生异常
     console.log(err.toString())
   })
 
 // 银行卡四要素确认请求（上传短信验证码）
 authentication
   .BankCardFourAuthConfirm({
+    
+    /**
+      * @param {string} request-id：请求 ID，请求的唯一标识
+      * 建议平台企业自定义 request-id，并记录在日志中，便于问题发现及排查
+      * 如未自定义 request-id，将使用 SDK 中的 UUID 方法自动生成。注意：UUID 方法生成的 request-id 不能保证全局唯一，推荐自定义 request-id
+      */
+    request_id: "requestIdExample123456789",
     real_name: "张三",
-    card_no: "6214830112341234",
-    id_card: "120111199901101234",
-    mobile: "111111111",
+    card_no: "8888888888888888888",
+    id_card: "110121202202222222",
+    mobile: "188****8888",
     ref: "MTY3NDA0Mzc4NTg1MTY4NjUzNy0xMDYuMTIwLjQwLjU4",
     captcha: "502373",
   })
   .then((data) => {
-    console.log("响应内容：", data)
+    if (data.code === "0000") {
+      // 操作成功
+      console.log("操作成功 ", data.data)
+    } else {
+      // 失败返回
+      console.log("失败返回 ", "code：" + data.code + " message：" + data.message + " request_id：" + data.request_id)
+    } 
   })
   .catch((err) => {
+    // 发生异常
     console.log(err.toString())
   })
 
 // 银行卡四要素验证
 authentication
   .BankCardFourVerify({
+    
+    /**
+      * @param {string} request-id：请求 ID，请求的唯一标识
+      * 建议平台企业自定义 request-id，并记录在日志中，便于问题发现及排查
+      * 如未自定义 request-id，将使用 SDK 中的 UUID 方法自动生成。注意：UUID 方法生成的 request-id 不能保证全局唯一，推荐自定义 request-id
+      */
+    request_id: "requestIdExample123456789",
     real_name: "张三",
-    card_no: "6214830112341234",
-    id_card: "120111199901101234",
-    mobile: "1111111111",
+    card_no: "8888888888888888888",
+    id_card: "110121202202222222",
+    mobile: "188****8888",
   })
   .then((data) => {
-    console.log("响应内容：", data)
+    if (data.code === "0000") {
+      // 操作成功
+      console.log("操作成功 ", data.data)
+    } else {
+      // 失败返回
+      console.log("失败返回 ", "code：" + data.code + " message：" + data.message + " request_id：" + data.request_id)
+    } 
   })
   .catch((err) => {
+    // 发生异常
     console.log(err.toString())
   })
 
 // 银行卡三要素验证
 authentication
   .BankCardThreeVerify({
+    
+    /**
+      * @param {string} request-id：请求 ID，请求的唯一标识
+      * 建议平台企业自定义 request-id，并记录在日志中，便于问题发现及排查
+      * 如未自定义 request-id，将使用 SDK 中的 UUID 方法自动生成。注意：UUID 方法生成的 request-id 不能保证全局唯一，推荐自定义 request-id
+      */
+    request_id: "requestIdExample123456789",
     real_name: "张三",
-    card_no: "6214830112341234",
-    id_card: "120111199901101234",
+    card_no: "8888888888888888888",
+    id_card: "110121202202222222",
   })
   .then((data) => {
-    console.log("响应内容：", data)
+    if (data.code === "0000") {
+      // 操作成功
+      console.log("操作成功 ", data.data)
+    } else {
+      // 失败返回
+      console.log("失败返回 ", "code：" + data.code + " message：" + data.message + " request_id：" + data.request_id)
+    } 
   })
   .catch((err) => {
+    // 发生异常
     console.log(err.toString())
   })
 
 // 身份证实名验证
 authentication
   .IDCardVerify({
+    
+    /**
+      * @param {string} request-id：请求 ID，请求的唯一标识
+      * 建议平台企业自定义 request-id，并记录在日志中，便于问题发现及排查
+      * 如未自定义 request-id，将使用 SDK 中的 UUID 方法自动生成。注意：UUID 方法生成的 request-id 不能保证全局唯一，推荐自定义 request-id
+      */
+    request_id: "requestIdExample123456789",
     real_name: "张三",
-    id_card: "120111199901101234",
+    id_card: "110121202202222222",
   })
   .then((data) => {
-    console.log("响应内容：", data)
+    if (data.code === "0000") {
+      // 操作成功
+      console.log("操作成功 ", data.data)
+    } else {
+      // 失败返回
+      console.log("失败返回 ", "code：" + data.code + " message：" + data.message + " request_id：" + data.request_id)
+    } 
   })
   .catch((err) => {
+    // 发生异常
     console.log(err.toString())
   })
 
 // 银行卡信息查询
 authentication
   .GetBankCardInfo({
-    card_no: "6214830112341234",
+    
+    /**
+      * @param {string} request-id：请求 ID，请求的唯一标识
+      * 建议平台企业自定义 request-id，并记录在日志中，便于问题发现及排查
+      * 如未自定义 request-id，将使用 SDK 中的 UUID 方法自动生成。注意：UUID 方法生成的 request-id 不能保证全局唯一，推荐自定义 request-id
+      */
+    request_id: "requestIdExample123456789",
+    card_no: "8888888888888888888",
     bank_name: "招商银行",
   })
   .then((data) => {
-    console.log("响应内容：", data)
+    if (data.code === "0000") {
+      // 操作成功
+      console.log("操作成功 ", data.data)
+    } else {
+      // 失败返回
+      console.log("失败返回 ", "code：" + data.code + " message：" + data.message + " request_id：" + data.request_id)
+    } 
   })
   .catch((err) => {
+    // 发生异常
     console.log(err.toString())
   })
 
@@ -108,7 +191,14 @@ function parse(file) {
 // 上传免验证用户名单信息
 authentication
   .UserExemptedInfo({
-    id_card: "120111199901101234",
+    
+    /**
+      * @param {string} request-id：请求 ID，请求的唯一标识
+      * 建议平台企业自定义 request-id，并记录在日志中，便于问题发现及排查
+      * 如未自定义 request-id，将使用 SDK 中的 UUID 方法自动生成。注意：UUID 方法生成的 request-id 不能保证全局唯一，推荐自定义 request-id
+      */
+    request_id: "requestIdExample123456789",
+    id_card: "parssport0001",
     card_type: "passport",
     real_name: "测试",
     comment_apply: "test",
@@ -118,25 +208,46 @@ authentication
     country: "CHN",
     birthday: "20200101",
     gender: "男",
-    notify_url: "",
+    notify_url: "https://www.example.com",
     ref: "test019011901",
   })
   .then((data) => {
-    console.log("响应内容：", data)
+    if (data.code === "0000") {
+      // 操作成功
+      console.log("操作成功 ", data.data)
+    } else {
+      // 失败返回
+      console.log("失败返回 ", "code：" + data.code + " message：" + data.message + " request_id：" + data.request_id)
+    } 
   })
   .catch((err) => {
+    // 发生异常
     console.log(err.toString())
   })
 
 // 查看免验证用户名单是否存在
 authentication
   .UserWhiteCheck({
-    id_card: "120111199901101234",
+    
+    /**
+      * @param {string} request-id：请求 ID，请求的唯一标识
+      * 建议平台企业自定义 request-id，并记录在日志中，便于问题发现及排查
+      * 如未自定义 request-id，将使用 SDK 中的 UUID 方法自动生成。注意：UUID 方法生成的 request-id 不能保证全局唯一，推荐自定义 request-id
+      */
+    request_id: "requestIdExample123456789",
+    id_card: "110121202202222222",
     real_name: "测试",
   })
   .then((data) => {
-    console.log("响应内容：", data)
+    if (data.code === "0000") {
+      // 操作成功
+      console.log("操作成功 ", data.data)
+    } else {
+      // 失败返回
+      console.log("失败返回 ", "code：" + data.code + " message：" + data.message + " request_id：" + data.request_id)
+    } 
   })
   .catch((err) => {
+    // 发生异常
     console.log(err.toString())
   })

package/example/bizlicXjjH5.js

@@ -2,7 +2,6 @@ const yzhAPI = require("../yzh/index.js")
 const config = require("./conf/config.js")
 
 // 个体工商户注册（云账户新经济 H5）
-
 const bizlicxjjh5 = new yzhAPI.BizlicXjjH5ServiceClient({
   ...config,
   base_url: "https://api-aic.yunzhanghu.com/",
@@ -11,36 +10,63 @@ const bizlicxjjh5 = new yzhAPI.BizlicXjjH5ServiceClient({
 // 预启动
 bizlicxjjh5
   .H5GetStartUrl({
+    
+    /**
+      * @param {string} request-id：请求 ID，请求的唯一标识
+      * 建议平台企业自定义 request-id，并记录在日志中，便于问题发现及排查
+      * 如未自定义 request-id，将使用 SDK 中的 UUID 方法自动生成。注意：UUID 方法生成的 request-id 不能保证全局唯一，推荐自定义 request-id
+      */
+    request_id: "requestIdExample123456789",
     dealer_id: config.dealer_id,
     broker_id: config.broker_id,
     dealer_user_id: "test000",
     client_type: 1,
-    notify_url: "https://xxx",
+    notify_url: "https://www.example.com",
     color: "#8500ff",
-    return_url: "https://xxx",
+    return_url: "https://www.example.com",
     customer_title: 1,
   })
   .then((data) => {
-    console.log("响应内容：", data)
+    if (data.code === "0000") {
+      // 操作成功
+      console.log("操作成功 ", data.data)
+    } else {
+      // 失败返回
+      console.log("失败返回 ", "code：" + data.code + " message：" + data.message + " request_id：" + data.request_id)
+    } 
   })
   .catch((err) => {
+    // 发生异常
     console.log(err.toString())
   })
 
 // 查询个体工商户状态
 bizlicxjjh5
   .H5EcoCityAicStatus({
+    
+    /**
+      * @param {string} request-id：请求 ID，请求的唯一标识
+      * 建议平台企业自定义 request-id，并记录在日志中，便于问题发现及排查
+      * 如未自定义 request-id，将使用 SDK 中的 UUID 方法自动生成。注意：UUID 方法生成的 request-id 不能保证全局唯一，推荐自定义 request-id
+      */
+    request_id: "requestIdExample123456789",
     dealer_id: config.dealer_id,
     broker_id: config.broker_id,
     open_id: "",
     dealer_user_id: "test000",
-    phone_no: "",
     real_name: "张三",
-    id_card: "120110119990000111",
+    id_card: "110121202202222222",
   })
   .then((data) => {
-    console.log("响应内容：", data)
+    if (data.code === "0000") {
+      // 操作成功
+      console.log("操作成功 ", data.data)
+    } else {
+      // 失败返回
+      console.log("失败返回 ", "code：" + data.code + " message：" + data.message + " request_id：" + data.request_id)
+    } 
   })
   .catch((err) => {
+    // 发生异常
     console.log(err.toString())
   })

package/example/bizlicXjjH5Api.js

@@ -2,7 +2,6 @@ const yzhAPI = require("../yzh/index.js")
 const config = require("./conf/config.js")
 
 // 个体工商户注册（云账户新经济 H5+API）
-
 const bizlicxjjh5api = new yzhAPI.BizlicXjjH5APIServiceClient({
   ...config,
   base_url: "https://api-aic.yunzhanghu.com/",
@@ -11,12 +10,19 @@ const bizlicxjjh5api = new yzhAPI.BizlicXjjH5APIServiceClient({
 // 工商实名信息录入
 bizlicxjjh5api
   .H5PreCollectBizlicMsg({
+    
+    /**
+      * @param {string} request-id：请求 ID，请求的唯一标识
+      * 建议平台企业自定义 request-id，并记录在日志中，便于问题发现及排查
+      * 如未自定义 request-id，将使用 SDK 中的 UUID 方法自动生成。注意：UUID 方法生成的 request-id 不能保证全局唯一，推荐自定义 request-id
+      */
+    request_id: "requestIdExample123456789",
     dealer_id: config.dealer_id,
     broker_id: config.broker_id,
     dealer_user_id: "test000",
-    phone_no: "",
+    phone_no: "188****8888",
     real_name: "张三",
-    id_card: "120110119990000111",
+    id_card: "110121202202222222",
     id_card_address: "",
     id_card_agency: "",
     id_card_nation: "20",
@@ -24,45 +30,79 @@ bizlicxjjh5api
     id_card_validity_end: "",
   })
   .then((data) => {
-    console.log("响应内容：", data)
+    if (data.code === "0000") {
+      // 操作成功
+      console.log("操作成功 ", data.data)
+    } else {
+      // 失败返回
+      console.log("失败返回 ", "code：" + data.code + " message：" + data.message + " request_id：" + data.request_id)
+    } 
   })
   .catch((err) => {
+    // 发生异常
     console.log(err.toString())
   })
 
 // 预启动
 bizlicxjjh5api
   .H5APIGetStartUrl({
+    
+    /**
+      * @param {string} request-id：请求 ID，请求的唯一标识
+      * 建议平台企业自定义 request-id，并记录在日志中，便于问题发现及排查
+      * 如未自定义 request-id，将使用 SDK 中的 UUID 方法自动生成。注意：UUID 方法生成的 request-id 不能保证全局唯一，推荐自定义 request-id
+      */
+    request_id: "requestIdExample123456789",
     dealer_id: config.dealer_id,
     broker_id: config.broker_id,
     dealer_user_id: "test000",
     client_type: 2,
-    notify_url: "https://xxx",
+    notify_url: "https://www.example.com",
     color: "#8500ff",
-    return_url: "https://xxx",
+    return_url: "https://www.example.com",
     customer_title: 1,
   })
   .then((data) => {
-    console.log("响应内容：", data)
+    if (data.code === "0000") {
+      // 操作成功
+      console.log("操作成功 ", data.data)
+    } else {
+      // 失败返回
+      console.log("失败返回 ", "code：" + data.code + " message：" + data.message + " request_id：" + data.request_id)
+    } 
   })
   .catch((err) => {
+    // 发生异常
     console.log(err.toString())
   })
 
 // 查询个体工商户状态
 bizlicxjjh5api
   .H5APIEcoCityAicStatus({
+    
+    /**
+      * @param {string} request-id：请求 ID，请求的唯一标识
+      * 建议平台企业自定义 request-id，并记录在日志中，便于问题发现及排查
+      * 如未自定义 request-id，将使用 SDK 中的 UUID 方法自动生成。注意：UUID 方法生成的 request-id 不能保证全局唯一，推荐自定义 request-id
+      */
+    request_id: "requestIdExample123456789",
     dealer_id: config.dealer_id,
     broker_id: config.broker_id,
     open_id: "",
     dealer_user_id: "test000",
-    phone_no: "",
     real_name: "张三",
-    id_card: "120110119990000111",
+    id_card: "110121202202222222",
   })
   .then((data) => {
-    console.log("响应内容：", data)
+    if (data.code === "0000") {
+      // 操作成功
+      console.log("操作成功 ", data.data)
+    } else {
+      // 失败返回
+      console.log("失败返回 ", "code：" + data.code + " message：" + data.message + " request_id：" + data.request_id)
+    } 
   })
   .catch((err) => {
+    // 发生异常
     console.log(err.toString())
   })