tencentcloud-sdk-nodejs-ess 4.1.303 → 4.1.304

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tencentcloud-sdk-nodejs-ess",
-  "version": "4.1.303",
+  "version": "4.1.304",
   "description": "腾讯云 API NODEJS SDK",
   "main": "./tencentcloud/index.js",
   "module": "./es/index.js",

package/tencentcloud/services/ess/v20201111/ess_client.d.ts

@@ -851,43 +851,26 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
        * 此接口（CreateFlowByFiles）用来通过上传后的pdf资源编号来创建待签署的合同流程。<br/>
   适用场景：适用非制式的合同文件签署。一般开发者自己有完整的签署文件，可以通过该接口传入完整的PDF文件及流程信息生成待签署的合同流程。<br/>
   
-  <table>
-      <thead>
-          <tr>
-              <th>签署人类别</th>
-              <th>需要提前准备的信息</th>
-          </tr>
-      </thead>
-      <tbody>
-          <tr>
-              <td>自己企业的员工签署（未认证加入或已认证加入）</td>
-              <td>签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号（证件号非必传）</td>
-          </tr>
-          <tr>
-              <td>自己企业的员工签署（已认证加入）</td>
-              <td>签署企业的名字、员工在电子签平台的ID（UserId）</td>
-          </tr>
-          <tr>
-              <td>其他企业的员工签署</td>
-              <td>签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号（证件号非必传）</td>
-          </tr>
-          <tr>
-              <td>个人（自然人）签署</td>
-              <td>个人的真实名字、个人的触达手机号、个人的身份证（证件号非必传）</td>
-          </tr>
-      </tbody>
-  </table>
+  ## 传参方式指引
   
+  | 签署方类型 | ApproverType | 需要提前准备的信息 | 对应 Approvers 关键字段 |
+  |------|------|------|------|
+  | 本企业员工（未认证加入） | 0 | 签署企业名、员工真实姓名、员工触达手机号、证件号（非必传） | OrganizationName + ApproverName + ApproverMobile |
+  | 本企业员工（已认证加入） | 0 | 签署企业名、员工在电子签平台的 ID（UserId） | OrganizationName + UserId |
+  | 他方企业员工 | 0 | 签署企业名、员工真实姓名、员工触达手机号、证件号（非必传） | OrganizationName + ApproverName + ApproverMobile |
+  | 个人（自然人） | 1 | 个人真实姓名、个人触达手机号、身份证号（非必传） | ApproverName + ApproverMobile |
   
   
-  该接口需要依赖[上传文件](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口生成pdf资源编号（FileIds）进行使用。（如果非pdf文件需要调用[创建文件转换任务](https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi)接口转换成pdf资源）<br/>
+  该接口需要依赖[上传文件](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口生成pdf资源编号（FileIds）进行使用。（如果非pdf文件需要调用[创建文件转换任务](https://qian.tencent.com/developers/companyApis/templatesAndFiles/DescribeFileConvertTask)接口转换成pdf资源）<br/>
   
-  
-  ![image](https://qcloudimg.tencent-cloud.cn/raw/f097a74b289e3e1acd740936bdfe9843.png)
+  ## 整体流程图
+  ![image](https://qcloudimg.tencent-cloud.cn/raw/9577ac334c083ecfe0014a187d64b485.svg)
   
   注：
-  -  合同**发起后就会扣减合同的额度**, 只有撤销没有参与方签署过或只有自动签署签署过的合同，才会返还合同额度。（**过期，拒签，签署完成，解除完成等状态不会返还额度**）
-  - **静默（自动）签署不支持合同签署方存在填写**功能
+  -  合同<font color="red">发起后就会扣减合同的额度</font> , 只有撤销没有参与方签署过或只有自动签署签署过的合同，且<font color="red">有撤销合同额度</font>的情形下，才会返还合同额度。（**过期，拒签，签署完成，解除完成等状态不会返还额度**）。具体可以参考[合同撤销返还额度说明](https://qian.tencent.com/developers/company/contract_cancel_quota)。
+  - 支持的证件类型可以参考[支持的证件类型](https://qian.tencent.com/developers/company/id_card_support)。
+  - 合同发起方需要【组织管理】->【角色管理】中拥有<font color="red">接口发起合同</font>的权限
+  ![image](https://qcloudimg.tencent-cloud.cn/raw/c8553d1823ca1323e82c11f01c86e8cd.png)
   
   
   <font color="red">相关视频指引</font> <br>
@@ -968,7 +951,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
       ciphertext = SymmetricEncrypt(ALGO, AESKey, iv, plaintext)
       # 4. 计算完整性签名：HMAC(Key, IV || Ciphertext)
       signature = HMAC(HMACKey, concat(iv, ciphertext))
-      # 5. 组装外层请求参数（三段均为标准 Base64）
+      # 5. 组装外层请求参数
       encReq = {
           RequestAction:       bizAction,
           IV:                  Base64(iv),
@@ -1006,6 +989,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
   ```
   
   **AES-CBC 示例**
+  
   以下示例参数及结果可用于验证 AES-CBC 加密和 HMAC-SHA256 签名算法的实现是否正确。
   
   加密密钥：AES-CBC-Key-1234
@@ -1024,6 +1008,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
   ```
   
   **SM4-CBC 示例**
+  
   以下示例参数及结果可用于验证 SM4-CBC 加密和 HMAC-SM4 签名算法的实现是否正确。
   
   加密密钥：SM4-CBC-Key-1234

package/tencentcloud/services/ess/v20201111/ess_client.js

@@ -1017,43 +1017,26 @@ class Client extends TencentCloudCommon.AbstractClient {
        * 此接口（CreateFlowByFiles）用来通过上传后的pdf资源编号来创建待签署的合同流程。<br/>
   适用场景：适用非制式的合同文件签署。一般开发者自己有完整的签署文件，可以通过该接口传入完整的PDF文件及流程信息生成待签署的合同流程。<br/>
   
-  <table>
-      <thead>
-          <tr>
-              <th>签署人类别</th>
-              <th>需要提前准备的信息</th>
-          </tr>
-      </thead>
-      <tbody>
-          <tr>
-              <td>自己企业的员工签署（未认证加入或已认证加入）</td>
-              <td>签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号（证件号非必传）</td>
-          </tr>
-          <tr>
-              <td>自己企业的员工签署（已认证加入）</td>
-              <td>签署企业的名字、员工在电子签平台的ID（UserId）</td>
-          </tr>
-          <tr>
-              <td>其他企业的员工签署</td>
-              <td>签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号（证件号非必传）</td>
-          </tr>
-          <tr>
-              <td>个人（自然人）签署</td>
-              <td>个人的真实名字、个人的触达手机号、个人的身份证（证件号非必传）</td>
-          </tr>
-      </tbody>
-  </table>
+  ## 传参方式指引
   
+  | 签署方类型 | ApproverType | 需要提前准备的信息 | 对应 Approvers 关键字段 |
+  |------|------|------|------|
+  | 本企业员工（未认证加入） | 0 | 签署企业名、员工真实姓名、员工触达手机号、证件号（非必传） | OrganizationName + ApproverName + ApproverMobile |
+  | 本企业员工（已认证加入） | 0 | 签署企业名、员工在电子签平台的 ID（UserId） | OrganizationName + UserId |
+  | 他方企业员工 | 0 | 签署企业名、员工真实姓名、员工触达手机号、证件号（非必传） | OrganizationName + ApproverName + ApproverMobile |
+  | 个人（自然人） | 1 | 个人真实姓名、个人触达手机号、身份证号（非必传） | ApproverName + ApproverMobile |
   
   
-  该接口需要依赖[上传文件](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口生成pdf资源编号（FileIds）进行使用。（如果非pdf文件需要调用[创建文件转换任务](https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi)接口转换成pdf资源）<br/>
+  该接口需要依赖[上传文件](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口生成pdf资源编号（FileIds）进行使用。（如果非pdf文件需要调用[创建文件转换任务](https://qian.tencent.com/developers/companyApis/templatesAndFiles/DescribeFileConvertTask)接口转换成pdf资源）<br/>
   
-  
-  ![image](https://qcloudimg.tencent-cloud.cn/raw/f097a74b289e3e1acd740936bdfe9843.png)
+  ## 整体流程图
+  ![image](https://qcloudimg.tencent-cloud.cn/raw/9577ac334c083ecfe0014a187d64b485.svg)
   
   注：
-  -  合同**发起后就会扣减合同的额度**, 只有撤销没有参与方签署过或只有自动签署签署过的合同，才会返还合同额度。（**过期，拒签，签署完成，解除完成等状态不会返还额度**）
-  - **静默（自动）签署不支持合同签署方存在填写**功能
+  -  合同<font color="red">发起后就会扣减合同的额度</font> , 只有撤销没有参与方签署过或只有自动签署签署过的合同，且<font color="red">有撤销合同额度</font>的情形下，才会返还合同额度。（**过期，拒签，签署完成，解除完成等状态不会返还额度**）。具体可以参考[合同撤销返还额度说明](https://qian.tencent.com/developers/company/contract_cancel_quota)。
+  - 支持的证件类型可以参考[支持的证件类型](https://qian.tencent.com/developers/company/id_card_support)。
+  - 合同发起方需要【组织管理】->【角色管理】中拥有<font color="red">接口发起合同</font>的权限
+  ![image](https://qcloudimg.tencent-cloud.cn/raw/c8553d1823ca1323e82c11f01c86e8cd.png)
   
   
   <font color="red">相关视频指引</font> <br>
@@ -1142,7 +1125,7 @@ class Client extends TencentCloudCommon.AbstractClient {
       ciphertext = SymmetricEncrypt(ALGO, AESKey, iv, plaintext)
       # 4. 计算完整性签名：HMAC(Key, IV || Ciphertext)
       signature = HMAC(HMACKey, concat(iv, ciphertext))
-      # 5. 组装外层请求参数（三段均为标准 Base64）
+      # 5. 组装外层请求参数
       encReq = {
           RequestAction:       bizAction,
           IV:                  Base64(iv),
@@ -1180,6 +1163,7 @@ class Client extends TencentCloudCommon.AbstractClient {
   ```
   
   **AES-CBC 示例**
+  
   以下示例参数及结果可用于验证 AES-CBC 加密和 HMAC-SHA256 签名算法的实现是否正确。
   
   加密密钥：AES-CBC-Key-1234
@@ -1198,6 +1182,7 @@ class Client extends TencentCloudCommon.AbstractClient {
   ```
   
   **SM4-CBC 示例**
+  
   以下示例参数及结果可用于验证 SM4-CBC 加密和 HMAC-SM4 签名算法的实现是否正确。
   
   加密密钥：SM4-CBC-Key-1234

package/tencentcloud/services/ess/v20201111/ess_models.d.ts

@@ -4448,65 +4448,36 @@ export interface DeleteIntegrationDepartmentResponse {
  */
 export interface AutoSignConfig {
     /**
-     * 自动签开通个人用户信息, 包括名字,身份证等
+     * <p>自动签开通个人用户信息, 包括名字,身份证等</p>
      */
     UserInfo: UserThreeFactor;
     /**
-     * 是否回调证书信息:
-  <ul><li>**false**: 不需要(默认)</li>
-  <li>**true**:需要</li></ul>
-  
-  注：`该字段已经失效，请勿设置此参数。`
+     * <p>是否回调证书信息:</p><ul><li>**false**: 不需要(默认)</li><li>**true**:需要</li></ul><p>注：<code>该字段已经失效，请勿设置此参数。</code></p>
      */
     CertInfoCallback?: boolean;
     /**
-     * 是否支持用户自定义签名印章:
-  <ul><li>**false**: 不能自己定义(默认)</li>
-  <li>**true**: 可以自己定义</li></ul>
+     * <p>是否支持用户自定义签名印章:</p><ul><li>**false**: 不能自己定义(默认)</li><li>**true**: 可以自己定义</li></ul>
      */
     UserDefineSeal?: boolean;
     /**
-     * 回调中是否需要自动签将要使用的印章(签名) 图片的 base64:
-  <ul><li>**false**: 不需要(默认)</li>
-  <li>**true**: 需要</li></ul>
+     * <p>回调中是否需要自动签将要使用的印章(签名) 图片的 base64:</p><ul><li>**false**: 不需要(默认)</li><li>**true**: 需要</li></ul>
      */
     SealImgCallback?: boolean;
     /**
-     * 执行结果的回调URL，该URL仅支持HTTP或HTTPS协议，建议采用HTTPS协议以保证数据传输的安全性。
-  腾讯电子签服务器将通过POST方式，application/json格式通知执行结果，请确保外网可以正常访问该URL。
-  回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
+     * <p>执行结果的回调URL，该URL仅支持HTTP或HTTPS协议，建议采用HTTPS协议以保证数据传输的安全性。<br>腾讯电子签服务器将通过POST方式，application/json格式通知执行结果，请确保外网可以正常访问该URL。<br>回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。</p>
      * @deprecated
      */
     CallbackUrl?: string;
     /**
-     * 开通时候的身份验证方式, 取值为：
-  <ul><li>**WEIXINAPP** : 微信人脸识别</li>
-  <li>**INSIGHT** : 慧眼人脸识别</li>
-  <li>**TELECOM** : 运营商三要素验证</li></ul>
-  注：
-  <ul><li>如果是小程序开通链接，仅支持 WEIXINAPP 。为空默认 WEIXINAPP</li>
-  <li>如果是 H5 开通链接，支持传 INSIGHT / TELECOM。为空默认 INSIGHT </li></ul>
+     * <p>开通时候的身份验证方式, 取值为：</p><ul><li>**WEIXINAPP** : 微信人脸识别</li><li>**INSIGHT** : 慧眼人脸识别</li><li>**TELECOM** : 运营商三要素验证</li></ul>注：<ul><li>如果是小程序开通链接，仅支持 WEIXINAPP 。为空默认 WEIXINAPP</li><li>如果是 H5 开通链接，支持传 INSIGHT / TELECOM。为空默认 INSIGHT </li></ul>
      */
     VerifyChannels?: Array<string>;
     /**
-     * 设置用户自动签合同的扣费方式。
-  
-  <ul><li><b>1</b>: (默认)使用合同份额进行扣减</li></ul>
-  
-  注：`该字段已经失效，请勿设置此参数。`
+     * <p>设置用户自动签合同的扣费方式。</p><ul><li><b>1</b>: (默认)使用合同份额进行扣减</li></ul><p>注：<code>该字段已经失效，请勿设置此参数。</code></p>
      */
     LicenseType?: number;
     /**
-     * 开通成功后前端页面跳转的url，此字段的用法场景请联系客户经理确认。
-  
-  注：`仅支持H5开通场景`, `跳转链接仅支持 https:// , qianapp:// 开头`
-  
-  跳转场景：
-  <ul><li>**贵方H5 -> 腾讯电子签H5 -> 贵方H5** : JumpUrl格式: https://YOUR_CUSTOM_URL/xxxx，只需满足 https:// 开头的正确且合规的网址即可。</li>
-  <li>**贵方原生App -> 腾讯电子签H5 -> 贵方原生App** : JumpUrl格式: qianapp://YOUR_CUSTOM_URL，只需满足 qianapp:// 开头的URL即可。`APP实现方，需要拦截Webview地址跳转，发现url是qianapp:// 开头时跳转到原生页面。`APP拦截地址跳转可参考：<a href='https://stackoverflow.com/questions/41693263/android-webview-err-unknown-url-scheme'>Android</a>，<a href='https://razorpay.com/docs/payments/payment-gateway/web-integration/standard/webview/upi-intent-ios/'>IOS</a> </li></ul>
-  
-  成功结果返回：
-  若贵方需要在跳转回时通过链接query参数提示开通成功，JumpUrl中的query应携带如下参数：`appendResult=qian`。这样腾讯电子签H5会在跳转回的url后面会添加query参数提示贵方签署成功，例如： qianapp://YOUR_CUSTOM_URL?action=sign&result=success&from=tencent_ess
+     * <p>开通成功后前端页面跳转的url，此字段的用法场景请联系客户经理确认。</p><p>注：<code>仅支持H5开通场景</code>, <code>跳转链接仅支持 https:// , qianapp:// 开头</code></p><p>跳转场景：</p><ul><li>**贵方H5 -&gt; 腾讯电子签H5 -&gt; 贵方H5** : JumpUrl格式: https://YOUR_CUSTOM_URL/xxxx，只需满足 https:// 开头的正确且合规的网址即可。</li><li>**贵方原生App -&gt; 腾讯电子签H5 -&gt; 贵方原生App** : JumpUrl格式: qianapp://YOUR_CUSTOM_URL，只需满足 qianapp:// 开头的URL即可。<code>APP实现方，需要拦截Webview地址跳转，发现url是qianapp:// 开头时跳转到原生页面。</code>APP拦截地址跳转可参考：<a href="https://qian.tencent.com/developers/company/openqianh5/#3-%E8%BF%94%E5%9B%9E%E5%BA%94%E7%94%A8jumpurl%E6%A0%BC%E5%BC%8F">返回应用JumpUrl格式</a></li></ul><p>成功结果返回：<br>若贵方需要在跳转回时通过链接query参数提示开通成功，JumpUrl中的query应携带如下参数：<code>appendResult=qian</code>。这样腾讯电子签H5会在跳转回的url后面会添加query参数提示贵方签署成功，例如： qianapp://YOUR_CUSTOM_URL?action=sign&amp;result=success&amp;from=tencent_ess</p>
      */
     JumpUrl?: string;
 }
@@ -7658,21 +7629,21 @@ export interface DescribeOrganizationGroupOrganizationsRequest {
  */
 export interface Agent {
     /**
-     * 代理机构的应用编号,32位字符串，一般不用传
+     * <p>CA-API应用编号，用于同平台企业下标识不同的CA-API应用</p>
      * @deprecated
      */
     AppId?: string;
     /**
-     * 被代理机构的应用号，一般不用传
+     * <p>被代理机构的应用号，一般不用传</p>
      * @deprecated
      */
     ProxyAppId?: string;
     /**
-     * 被代理机构在电子签平台的机构编号，集团代理下场景必传
+     * <p>被代理机构在电子签平台的机构编号，集团代理下场景必传</p>
      */
     ProxyOrganizationId?: string;
     /**
-     * 被代理机构的经办人，一般不用传
+     * <p>被代理机构的经办人，一般不用传</p>
      * @deprecated
      */
     ProxyOperator?: string;
@@ -12443,7 +12414,7 @@ export interface CreateFlowSignUrlRequest {
      */
     Agent?: Agent;
     /**
-     * <p>流程签署人列表中，结构体的ApproverName、ApproverMobile和ApproverType为必传字段。如果是企业签署人，还需传递OrganizationName。</p><p>此结构体和CreateFlow发起接口参与方结构体复用，除了上述参数外，可传递的参数有：</p><ol><li>RecipientId: 发起合同会返回，可以直接用于指定需要生成链接的签署方。</li><li>ApproverSignTypes: 指定签署方签署时候的认证方式，仅此链接生效。</li><li>SignTypeSelector: 可以指定签署方签署合同的认证校验方式的选择模式。</li><li>Intention: 指定H5签署视频核身的意图配置，仅视频签署需要使用。</li></ol><p>注：</p><ol><li>签署人<b>只能使用手写签名、时间类型、印章类型、签批类型的签署控件和内容填写控件</b>，其他类型的签署控件暂时不支持。</li><li>生成发起方预览链接时，该字段（FlowApproverInfos）可以传空或者不传。</li></ol>
+     * <p>流程签署人列表中，结构体的ApproverName、ApproverMobile和ApproverType为必传字段。如果是企业签署人，还需传递OrganizationName。</p><p>此结构体和CreateFlow发起接口参与方结构体复用，除了上述参数外，可传递的参数有：</p><ol><li>RecipientId: 发起合同会返回，可以直接用于指定需要生成链接的签署方。</li><li>ApproverSignTypes: 指定签署方签署时候的认证方式，仅此链接生效。</li><li>SignTypeSelector: 可以指定签署方签署合同的认证校验方式的选择模式。</li><li>Intention: 指定H5签署视频核身的意图配置，仅视频签署需要使用。</li></ol><p>注：</p><ol><li>签署人<b>只能使用签名类型、时间类型、印章类型、签批类型的签署控件和内容填写控件</b>，其他类型的签署控件暂时不支持。</li><li>对于签名控件类型，支持手写签名、系统签名、个人印章等类型的签名方式，取决于合同发起时的设定。另外，签署的时候不支持拉取个人签署方已有签名图片资产，且创建的签名图片为一次性使用，不会保存为签署方个人资产。</li><li>生成发起方预览链接时，该字段（FlowApproverInfos）可以传空或者不传。</li></ol>
      */
     FlowApproverInfos?: Array<FlowCreateApprover>;
     /**