tencentcloud-sdk-nodejs-ess 4.1.10 → 4.1.15

package/package.json

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

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

@@ -69,8 +69,10 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
   1. 创建印章
   2. 创建模板
   3. 修改模板
-  4. 预览模板
-  5. 预览合同流程
+  4. 创建起草合同
+  5. 预览模板
+  6. 预览合同流程
+   
   
   预览模板的嵌入页面长相如下：
   ![image](https://qcloudimg.tencent-cloud.cn/raw/57bdda4a884e3f5b2de12d5a282a3651.png)

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

@@ -101,8 +101,10 @@ class Client extends TencentCloudCommon.AbstractClient {
   1. 创建印章
   2. 创建模板
   3. 修改模板
-  4. 预览模板
-  5. 预览合同流程
+  4. 创建起草合同
+  5. 预览模板
+  6. 预览合同流程
+   
   
   预览模板的嵌入页面长相如下：
   ![image](https://qcloudimg.tencent-cloud.cn/raw/57bdda4a884e3f5b2de12d5a282a3651.png)

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

@@ -2805,10 +2805,14 @@ export interface CreateSchemeUrlRequest {
     /**
      * 合同流程里边签署方经办人的姓名。
   
+  `注：在动态签署人补充链接场景中，可以通过传入这个值，对补充的个人参与方信息进行限制。仅匹配传入姓名的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。`
+  
      */
     Name?: string;
     /**
      * 合同流程里边签署方经办人手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)。
+  
+  `注：在动态签署人补充链接场景中，可以通过传入此值，对补充的个人参与方信息进行限制。仅匹配传入手机号的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。`
      */
     Mobile?: string;
     /**
@@ -2816,6 +2820,8 @@ export interface CreateSchemeUrlRequest {
   <ul><li>ID_CARD : 中国大陆居民身份证</li>
   <li>HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证</li>
   <li>HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li></ul>
+  
+  `注：在动态签署人补充链接场景中，可以通过传入此值，对补充的个人参与方信息进行限制。仅匹配传入证件类型的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方，且需要和证件号参数一同传递，不能单独进行限制。`
      */
     IdCardType?: string;
     /**
@@ -2823,6 +2829,8 @@ export interface CreateSchemeUrlRequest {
   <ul><li>中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成(如存在X，请大写)。</li>
   <li>中国港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。</li>
   <li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul>
+  
+  `注：在动态签署人补充链接场景中，可以通过传入此值，对补充的个人参与方信息进行限制。仅匹配传入证件号的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。`
      */
     IdCardNumber?: string;
     /**
@@ -3690,6 +3698,96 @@ export interface FillApproverInfo {
      */
     FlowId?: string;
 }
+/**
+ * 流程中参与方的信息结构
+ */
+export interface Recipient {
+    /**
+     * 签署参与者ID，唯一标识
+     */
+    RecipientId?: string;
+    /**
+     * 参与者类型。
+  默认为空。
+  ENTERPRISE-企业；
+  INDIVIDUAL-个人；
+  PROMOTER-发起方
+     */
+    RecipientType?: string;
+    /**
+     * 描述信息
+     */
+    Description?: string;
+    /**
+     * 角色名称
+     */
+    RoleName?: string;
+    /**
+     * 是否需要验证，
+  默认为false-不需要验证
+     */
+    RequireValidation?: boolean;
+    /**
+     * 是否需要签署，
+  默认为true-需要签署
+     */
+    RequireSign?: boolean;
+    /**
+     * 此参与方添加的顺序，从0～N
+     */
+    RoutingOrder?: number;
+    /**
+     * 是否需要发送，
+  默认为true-需要发送
+     */
+    RequireDelivery?: boolean;
+    /**
+     * 邮箱地址
+     */
+    Email?: string;
+    /**
+     * 电话号码
+     */
+    Mobile?: string;
+    /**
+     * 关联的用户ID，电子签系统的用户ID
+     */
+    UserId?: string;
+    /**
+     * 发送方式，默认为EMAIL。
+  EMAIL-邮件；
+  MOBILE-手机短信；
+  WECHAT-微信通知
+     */
+    DeliveryMethod?: string;
+    /**
+     * 参与方的一些附属信息，json格式
+     */
+    RecipientExtra?: string;
+    /**
+     * 签署人查看合同校验方式, 支持的类型如下:
+  <ul><li> 1 :实名认证查看</li>
+  <li> 2 :手机号校验查看</li></ul>
+     */
+    ApproverVerifyTypes?: Array<number | bigint>;
+    /**
+     * 签署人进行合同签署时的认证方式，支持的类型如下:
+  <ul><li> 1 :人脸认证</li>
+  <li> 2 :签署密码</li>
+  <li> 3 :运营商三要素认证</li>
+  <li> 4 :UKey认证</li>
+  <li> 5 :设备指纹识别</li>
+  <li> 6 :设备面容识别</li></ul>
+     */
+    ApproverSignTypes?: Array<number | bigint>;
+    /**
+     * 签署方是否可以转他人处理
+  
+  <ul><li> **false** : ( 默认)可以转他人处理</li>
+  <li> **true** :不可以转他人处理</li></ul>
+     */
+    NoTransfer?: boolean;
+}
 /**
  * 持有的电子印章信息
  */
@@ -5939,12 +6037,32 @@ export interface CreateEmbedWebUrlRequest {
   <ul><li>CREATE_SEAL: 生成创建印章的嵌入页面</li>
   <li>CREATE_TEMPLATE：生成创建模板的嵌入页面</li>
   <li>MODIFY_TEMPLATE：生成编辑模板的嵌入页面</li>
+  <li>CREATE_CONTRACT_DRAFT_COOPEDIT：生成创建起草合同的嵌入页面</li>
   <li>PREVIEW_TEMPLATE：生成预览模板的嵌入页面</li>
   <li>PREVIEW_SEAL_LIST：生成预览印章列表的嵌入页面</li>
   <li>PREVIEW_SEAL_DETAIL：生成预览印章详情的嵌入页面</li>
   <li>EXTEND_SERVICE：生成拓展服务的嵌入页面</li>
   <li>PREVIEW_FLOW：生成预览合同的嵌入页面（支持移动端）</li>
   <li>PREVIEW_FLOW_DETAIL：生成查看合同详情的嵌入页面（仅支持PC端）</li></ul>
+  
+  注意：
+  不同的嵌入类型，操作人需要的权限项不同（权限配置可参考[权限配置](https://qian.tencent.com/document/61355)）。
+  <table>
+  <tr><th>EmbedType</th><th>权限</th></tr>
+  <tr><th>CREATE_SEAL</th><th>印章管理-添加印章</th></tr>
+  <tr><th>CREATE_TEMPLATE</th><th>模板管理-创建模板</th></tr>
+  <tr><th>MODIFY_TEMPLATE</th><th>模板管理-编辑模板</th></tr>
+  <tr><th>CREATE_CONTRACT_DRAFT_COOPEDIT</th><th>合同管理-起草合同</th></tr>
+  <tr><th>PREVIEW_TEMPLATE</th><th>拥有下面三种权限的一种就行</br>
+  模板管理-查询模板（本企业全部模板）</br>
+  模板管理-查询模板（本部门全部模板）</br>
+  模板管理-查询模板（本人创建模板）</th></tr>
+  <tr><th>PREVIEW_SEAL_LIST</th><th>印章管理</th></tr>
+  <tr><th>PREVIEW_SEAL_DETAIL</th><th>印章管理</th></tr>
+  <tr><th>EXTEND_SERVICE</th><th>无要求</th></tr>
+  <tr><th>PREVIEW_FLOW</th><th>是否是当前合同的参与方，或者发起方企业的法人、超管、合同管理员</th></tr>
+  <tr><th>PREVIEW_FLOW_DETAIL</th><th>是否是当前合同的参与方，或者发起方企业的法人、超管、合同管理员</th></tr>
+  </table>
      */
     EmbedType: string;
     /**
@@ -5955,12 +6073,14 @@ export interface CreateEmbedWebUrlRequest {
   <li>为PREVIEW_SEAL_DETAIL，必填，取值为印章id。</li>
   <li>为CREATE_TEMPLATE，非必填，取值为资源id。*资源Id获取可使用接口[上传文件](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)*</li>
   <li>为MODIFY_TEMPLATE，PREVIEW_TEMPLATE，必填，取值为模板id。</li>
+  <li>为CREATE_CONTRACT_DRAFT_COOPEDIT，非必填，取值为资源 id。*资源Id获取可使用接口[上传文件](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)*</li>
   <li>为PREVIEW_FLOW，PREVIEW_FLOW_DETAIL，必填，取值为合同id。</li>
   </ul>
   
   注意：
    1. CREATE_TEMPLATE中的BusinessId仅支持PDF文件类型， 如果您的文件不是PDF， 请使用接口[创建文件转换任务
   ](https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi) 和[查询转换任务状态](https://qian.tencent.com/developers/companyApis/templatesAndFiles/GetTaskResultApi) 来进行转换成PDF资源。
+   2. CREATE_CONTRACT_DRAFT_COOPEDIT中的BusinessId仅支持DOC 和 DOCX 的文件，并且大小不能超过 10M。
      */
     BusinessId?: string;
     /**
@@ -6513,94 +6633,31 @@ export interface SuccessCreateStaffData {
     Url?: string;
 }
 /**
- * 流程中参与方的信息结构
+ * 预设的动态签署方的补充信息，仅匹配对应信息的签署方才能领取合同。暂时仅对个人参与方生效。
  */
-export interface Recipient {
-    /**
-     * 签署参与者ID，唯一标识
-     */
-    RecipientId?: string;
-    /**
-     * 参与者类型。
-  默认为空。
-  ENTERPRISE-企业；
-  INDIVIDUAL-个人；
-  PROMOTER-发起方
-     */
-    RecipientType?: string;
-    /**
-     * 描述信息
-     */
-    Description?: string;
+export interface PresetApproverInfo {
     /**
-     * 角色名称
+     * 预设参与方姓名。
      */
-    RoleName?: string;
-    /**
-     * 是否需要验证，
-  默认为false-不需要验证
-     */
-    RequireValidation?: boolean;
-    /**
-     * 是否需要签署，
-  默认为true-需要签署
-     */
-    RequireSign?: boolean;
-    /**
-     * 此参与方添加的顺序，从0～N
-     */
-    RoutingOrder?: number;
-    /**
-     * 是否需要发送，
-  默认为true-需要发送
-     */
-    RequireDelivery?: boolean;
-    /**
-     * 邮箱地址
-     */
-    Email?: string;
+    Name?: string;
     /**
-     * 电话号码
+     * 预设参与方手机号。
      */
     Mobile?: string;
     /**
-     * 关联的用户ID，电子签系统的用户ID
-     */
-    UserId?: string;
-    /**
-     * 发送方式，默认为EMAIL。
-  EMAIL-邮件；
-  MOBILE-手机短信；
-  WECHAT-微信通知
-     */
-    DeliveryMethod?: string;
-    /**
-     * 参与方的一些附属信息，json格式
-     */
-    RecipientExtra?: string;
-    /**
-     * 签署人查看合同校验方式, 支持的类型如下:
-  <ul><li> 1 :实名认证查看</li>
-  <li> 2 :手机号校验查看</li></ul>
-     */
-    ApproverVerifyTypes?: Array<number | bigint>;
-    /**
-     * 签署人进行合同签署时的认证方式，支持的类型如下:
-  <ul><li> 1 :人脸认证</li>
-  <li> 2 :签署密码</li>
-  <li> 3 :运营商三要素认证</li>
-  <li> 4 :UKey认证</li>
-  <li> 5 :设备指纹识别</li>
-  <li> 6 :设备面容识别</li></ul>
+     * 预设参与方证件号，需要和IdCardType同时传入。
+  
+  证件号码，应符合以下规则
+  <ul><li>中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成(如存在X，请大写)。</li></ul>
      */
-    ApproverSignTypes?: Array<number | bigint>;
+    IdCardNumber?: string;
     /**
-     * 签署方是否可以转他人处理
+     * 预设参与方的证件类型，需要与IdCardNumber同时传入。
   
-  <ul><li> **false** : ( 默认)可以转他人处理</li>
-  <li> **true** :不可以转他人处理</li></ul>
+  证件类型，支持以下类型
+  <ul><li><b>ID_CARD</b>: 居民身份证</li></ul>
      */
-    NoTransfer?: boolean;
+    IdCardType?: string;
 }
 /**
  * DescribeFlowEvidenceReport请求参数结构体
@@ -8061,6 +8118,8 @@ export interface DescribeCancelFlowsTaskRequest {
 export interface CreateEmbedWebUrlResponse {
     /**
      * 嵌入的web链接，有效期：5分钟
+  链接仅能使用一次
+  建议：每次都用接口生成链接，保证链接的有效性
   <br/>EmbedType=PREVIEW_CC_FLOW，该url为h5链接
      */
     WebUrl?: string;
@@ -8669,14 +8728,21 @@ export interface CreateBatchSignUrlRequest {
      * 签署方经办人的姓名。
   经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。
   
-  注：`请确保和合同中填入的一致`, `除动态签署人场景外，此参数必填`
+  注：
+  <ul>
+  <li>请确保和合同中填入的一致。</li>
+  <li>在动态签署人补充链接场景中，可以通过传入这个值，对补充的个人参与方信息进行限制。仅匹配传入姓名的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。</li>
+  </ul>
      */
     Name?: string;
     /**
      * 手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)。
   请确认手机号所有方为此业务通知方。
   
-  注：`请确保和合同中填入的一致,  若无法保持一致，请确保在发起和生成批量签署链接时传入相同的参与方证件信息`，`除动态签署人场景外，此参数必填`
+  注：
+  <ul>
+  <li>请确保和合同中填入的一致,  若无法保持一致，请确保在发起和生成批量签署链接时传入相同的参与方证件信息。</li><li>在生成动态签署人补充链接场景中，可以通过传入此值，对补充的个人参与方信息进行限制。仅匹配传入手机号的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。 </li>
+  </ul>
      */
     Mobile?: string;
     /**
@@ -8690,7 +8756,9 @@ export interface CreateBatchSignUrlRequest {
   <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
   <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同中国大陆居民身份证)</li></ul>
   
-  注：`请确保和合同中填入的一致`
+  注：
+  1. `请确保和合同中填入的一致`。
+  2. `在生成动态签署人补充链接场景中，可以通过传入此值，对补充的个人参与方信息进行限制。仅匹配传入证件类型的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方，且需要和证件号参数一同传递，不能单独进行限制。`
      */
     IdCardType?: string;
     /**
@@ -8699,7 +8767,9 @@ export interface CreateBatchSignUrlRequest {
   <li>中国港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。</li>
   <li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul>
   
-  注：`请确保和合同中填入的一致`
+  注：
+  1. `请确保和合同中填入的一致`。
+  2. `在生成动态签署人补充链接场景中，可以通过传入此值，对补充的个人参与方信息进行限制。仅匹配传入证件号的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。`
      */
     IdCardNumber?: string;
     /**
@@ -9517,7 +9587,7 @@ export interface EmbedUrlOption {
   - true: 不展示上传文件页
    
   
-  注意: 此参数仅针对**EmbedType=CREATE_TEMPLATE(创建模板)有效**，
+  注意: 此参数仅针对**EmbedType=CREATE_TEMPLATE(创建模板)和EmbedType=CREATE_CONTRACT_DRAFT_COOPEDIT(创建起草合同)有效**，
      */
     SkipUploadFile?: boolean;
 }
@@ -9999,6 +10069,10 @@ export interface CreateBatchQuickSignUrlRequest {
   
      */
     CanBatchReject?: boolean;
+    /**
+     * 	 预设的动态签署方的补充信息，仅匹配对应信息的签署方才能领取合同。暂时仅对个人参与方生效。
+     */
+    PresetApproverInfo?: PresetApproverInfo;
 }
 /**
  * 下载文件的URL信息