tencentcloud-sdk-nodejs 4.0.711 → 4.0.713

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

@@ -271,6 +271,15 @@ export interface DescribeIntegrationDepartmentsResponse {
      */
     RequestId?: string;
 }
+/**
+ * DeleteExtendedServiceAuthInfos返回参数结构体
+ */
+export interface DeleteExtendedServiceAuthInfosResponse {
+    /**
+     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
 /**
  * CreateFlowApprovers返回参数结构体
  */
@@ -305,6 +314,34 @@ export interface DescribeFileUrlsResponse {
      */
     RequestId?: string;
 }
+/**
+ * CreateExtendedServiceAuthInfos请求参数结构体
+ */
+export interface CreateExtendedServiceAuthInfosRequest {
+    /**
+     * 执行本接口操作的员工信息。
+  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
+     */
+    Operator: UserInfo;
+    /**
+     * 本企业员工的id，需要已实名，正常在职员工
+     */
+    UserIds: Array<string>;
+    /**
+     * 要查询的扩展服务类型。
+  默认为空，即查询当前支持的所有扩展服务信息。
+  若需查询单个扩展服务的开通情况，请传递相应的值，如下所示：
+  <ul><li>OPEN_SERVER_SIGN：企业自动签</li>
+  </ul>
+  
+     */
+    ExtendServiceType?: string;
+    /**
+     * 代理企业和员工的信息。
+  在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
+     */
+    Agent?: Agent;
+}
 /**
  * ModifyApplicationCallbackInfo返回参数结构体
  */
@@ -1979,6 +2016,10 @@ export interface DescribeFlowTemplatesRequest {
      * @deprecated
      */
     GenerateSource?: number;
+    /**
+     * 是否获取模板预览链接
+     */
+    WithPreviewUrl?: boolean;
 }
 /**
  * DeleteSealPolicies返回参数结构体
@@ -3572,15 +3613,15 @@ export interface CreateDocumentRequest {
      * 是否为预览模式，取值如下：
   <ul><li> **false**：非预览模式（默认），会产生合同流程并返回合同流程编号FlowId。</li>
   <li> **true**：预览模式，不产生合同流程，不返回合同流程编号FlowId，而是返回预览链接PreviewUrl，有效期为300秒，用于查看真实发起后合同的样子。</li></ul>
-  注: `当使用的模板中存在动态表格控件时，预览结果中没有动态表格的填写内容`
+  注: `当使用的模板中存在动态表格控件时，预览结果中没有动态表格的填写内容，动态表格合成完后会触发文档合成完成的回调通知`
      */
     NeedPreview?: boolean;
     /**
      * 预览模式下产生的预览链接类型
   <ul><li> **0** :(默认) 文件流 ,点开后后下载预览的合同PDF文件 </li>
-  <li> **1** :H5链接 ,点开后在浏览器中展示合同的样子</li></ul>
-  注: `此参数在NeedPreview 为true时有效`
-  
+  <li> **1** :H5链接 ,点开后在浏览器中展示合同的样子。</li></ul>
+  注: `1.此参数在NeedPreview 为true时有效`
+  `2.动态表格控件不支持H5链接方式预览`
      */
     PreviewType?: number;
     /**
@@ -4771,6 +4812,15 @@ export interface FailedCreateStaffData {
      */
     Reason?: string;
 }
+/**
+ * CreateExtendedServiceAuthInfos返回参数结构体
+ */
+export interface CreateExtendedServiceAuthInfosResponse {
+    /**
+     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
 /**
  * 指定签署人限制项
  */
@@ -5421,7 +5471,14 @@ export interface UploadFile {
     FileName?: string;
 }
 /**
- * 模板/流程中控件信息，可以是填充控件或签署控件
+ * 此结构体 (Component) 用于描述控件属性。
+
+在通过文件发起合同时，对应的component有三种定位方式
+1. 绝对定位方式
+2. 表单域(FIELD)定位方式
+3. 关键字(KEYWORD)定位方式，使用关键字定位时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找
+可以参考官网说明
+https://cloud.tencent.com/document/product/1323/78346#component-.E4.B8.89.E7.A7.8D.E5.AE.9A.E4.BD.8D.E6.96.B9.E5.BC.8F.E8.AF.B4.E6.98.8E
  */
 export interface Component {
     /**
@@ -5616,9 +5673,10 @@ export interface Component {
      */
     ComponentValue?: string;
     /**
-     * NORMAL 正常模式，使用坐标制定签署控件位置
-  FIELD 表单域，需使用ComponentName指定表单域名称
-  KEYWORD 关键字，使用ComponentId指定关键字
+     * 控件生成的方式：
+  NORMAL - 普通控件
+  FIELD - 表单域
+  KEYWORD - 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）
      */
     GenerateMode?: string;
     /**
@@ -6330,6 +6388,34 @@ export interface DescribeFlowInfoRequest {
      */
     FlowGroupId?: string;
 }
+/**
+ * DeleteExtendedServiceAuthInfos请求参数结构体
+ */
+export interface DeleteExtendedServiceAuthInfosRequest {
+    /**
+     * 执行本接口操作的员工信息。
+  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
+     */
+    Operator: UserInfo;
+    /**
+     * 本企业员工的id，需要已实名，正常在职员工
+     */
+    UserIds: Array<string>;
+    /**
+     * 要查询的扩展服务类型。
+  默认为空，即查询当前支持的所有扩展服务信息。
+  若需查询单个扩展服务的开通情况，请传递相应的值，如下所示：
+  <ul><li>OPEN_SERVER_SIGN：企业自动签</li>
+  </ul>
+  
+     */
+    ExtendServiceType?: string;
+    /**
+     * 代理企业和员工的信息。
+  在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
+     */
+    Agent?: Agent;
+}
 /**
  * DescribeIntegrationDepartments请求参数结构体
  */

package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts

@@ -20,7 +20,9 @@ export declare class Client extends AbstractClient {
      */
     ChannelCreateFlowSignReview(req: ChannelCreateFlowSignReviewRequest, cb?: (error: string, rep: ChannelCreateFlowSignReviewResponse) => void): Promise<ChannelCreateFlowSignReviewResponse>;
     /**
-     * 此接口（ChannelCreateMultiFlowSignQRCode）用于创建一码多扫流程签署二维码。 适用场景：无需填写签署人信息，可通过模板id生成签署二维码，签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景，例如：劳务工招工、大批量员工入职等场景。
+     * 此接口（ChannelCreateMultiFlowSignQRCode）用于创建一码多扫流程签署二维码。
+适用场景：无需填写签署人信息，可通过模板id生成签署二维码，签署人可通过扫描二维码补充签署信息进行实名签署。
+常用于提前不知道签署人的身份信息场景，例如：劳务工招工、大批量员工入职等场景。
 
 **本接口适用于发起方没有填写控件的 B2C或者单C模板**
 
@@ -110,7 +112,9 @@ export declare class Client extends AbstractClient {
      */
     CreateSealByImage(req: CreateSealByImageRequest, cb?: (error: string, rep: CreateSealByImageResponse) => void): Promise<CreateSealByImageResponse>;
     /**
-     * 此接口（ChannelCancelMultiFlowSignQRCode）用于取消一码多扫二维码。该接口对传入的二维码ID，若还在有效期内，可以提前失效。
+     * 此接口（CancelMultiFlowSignQRCode）用于废除一码多扫流程签署二维码。
+该接口所需的二维码ID，源自[创建一码多扫流程签署二维码](https://qian.tencent.com/developers/partnerApis/templates/ChannelCreateMultiFlowSignQRCode)生成的。
+如果该二维码尚处于有效期内，可通过本接口将其设置为失效状态。
      */
     ChannelCancelMultiFlowSignQRCode(req: ChannelCancelMultiFlowSignQRCodeRequest, cb?: (error: string, rep: ChannelCancelMultiFlowSignQRCodeResponse) => void): Promise<ChannelCancelMultiFlowSignQRCodeResponse>;
     /**
@@ -120,6 +124,7 @@ export declare class Client extends AbstractClient {
 3. 使用手机号验证签署方身份
 4. 骑缝章
 5. 拓宽签署方年龄限制
+6. 下载企业合同/文件
 
 注: 此接口 参数Agent. ProxyOperator.OpenId 需要传递超管或者法人的OpenId
      */
@@ -410,10 +415,12 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
      */
     ChannelCreateWebThemeConfig(req: ChannelCreateWebThemeConfigRequest, cb?: (error: string, rep: ChannelCreateWebThemeConfigResponse) => void): Promise<ChannelCreateWebThemeConfigResponse>;
     /**
-     * 指定需要批量催办的签署流程Id，批量催办合同，最多100个；接口失败后返回错误信息
-注意:
-该接口不可直接调用，请联系客户经理申请使用
-仅能催办当前状态为“待签署”的签署人，且只能催办一次
+     * 指定需要批量催办的签署流程ID，批量催办合同，最多100个。需要符合以下条件的合同才可被催办：
+
+1. 合同中当前状态为“待签署”的签署人是催办的对象
+2. 每个合同只能催办一次
+
+注意：该接口无法直接调用，请联系客户经理申请使用。
      */
     ChannelCreateFlowReminds(req: ChannelCreateFlowRemindsRequest, cb?: (error: string, rep: ChannelCreateFlowRemindsResponse) => void): Promise<ChannelCreateFlowRemindsResponse>;
     /**
@@ -504,6 +511,64 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
     SyncProxyOrganization(req: SyncProxyOrganizationRequest, cb?: (error: string, rep: SyncProxyOrganizationResponse) => void): Promise<SyncProxyOrganizationResponse>;
     /**
      * 接口（ChannelCreateFlowGroupByTemplates）用于通过多模板创建合同组签署流程。
+
+合同组是将多个合同签署流程组织在一起，多个合同同时创建，每个签署方得到一个签署链接，`一次完成合同组中多个合同的签署`。合同组的合同`不能拆分一个一个签署`，只能作为一个整体签署。
+
+适用场景：该接口适用于需要一次性完成多份合同签署的情况，多份合同一般具有关联性，用户以目录的形式查看合同。
+
+**注**:
+<ul>
+<li>此接口静默签(企业自动签)能力为白名单功能，使用前请联系对接的客户经理沟通。</li>
+<li>合同组暂不支持抄送功能</li>
+</ul>
+
+**可以作为发起方和签署方的角色列表**
+<table>
+<thead>
+<tr>
+<th>场景编号</th>
+<th>可作为发起方类型</th>
+<th>可作为签署方的类型</th>
+</tr>
+</thead>
+
+<tbody>
+<tr>
+<td>场景一</td>
+<td>第三方子企业A员工</td>
+<td>第三方子企业A员工</td>
+</tr>
+
+<tr>
+<td>场景二</td>
+<td>第三方子企业A员工</td>
+<td>第三方子企业B(不指定经办人)</td>
+</tr>
+
+<tr>
+<td>场景三</td>
+<td>第三方子企业A员工</td>
+<td>第三方子企业B员工</td>
+</tr>
+
+<tr>
+<td>场景四</td>
+<td>第三方子企业A员工</td>
+<td>个人/自然人</td>
+</tr>
+
+<tr>
+<td>场景五</td>
+<td>第三方子企业A员工</td>
+<td>SaaS平台企业员工</td>
+</tr>
+</tbody>
+</table>
+
+**注**:
+`1. 发起合同时候,  作为发起方的第三方子企业A员工的企业和员工必须经过实名, 而作为签署方的第三方子企业A员工/个人/自然人/SaaS平台企业员工/第三方子企业B员工企业中的企业和个人/员工可以未实名`
+
+`2. 不同类型的签署方传参不同, 可以参考开发者中心的FlowApproverInfo结构体说明`
      */
     ChannelCreateFlowGroupByTemplates(req: ChannelCreateFlowGroupByTemplatesRequest, cb?: (error: string, rep: ChannelCreateFlowGroupByTemplatesResponse) => void): Promise<ChannelCreateFlowGroupByTemplatesResponse>;
     /**
@@ -577,7 +642,66 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
      */
     ChannelCreatePreparedPersonalEsign(req: ChannelCreatePreparedPersonalEsignRequest, cb?: (error: string, rep: ChannelCreatePreparedPersonalEsignResponse) => void): Promise<ChannelCreatePreparedPersonalEsignResponse>;
     /**
-     * 接口（ChannelCreateFlowGroupByFiles）用于通过多文件创建合同组签署流程。
+     * 接口（ChannelCreateFlowGroupByFiles）用于使用 PDF 文件创建合同组签署流程。
+
+合同组是将多个合同签署流程组织在一起，多个合同同时创建，每个签署方得到一个签署链接，`一次完成合同组中多个合同的签署`。合同组的合同`不能拆分一个一个签署`，只能作为一个整体签署。
+
+适用场景：该接口适用于需要一次性完成多份合同签署的情况，多份合同一般具有关联性，用户以目录的形式查看合同。
+
+
+
+**注**:
+<ul>
+<li>此接口静默签(企业自动签)能力为白名单功能，使用前请联系对接的客户经理沟通。</li>
+<li>此接口需要依赖<a href="https://qian.tencent.com/developers/partnerApis/files/UploadFiles" target="_blank">文件上传接口</a>生成pdf资源编号（FileIds）进行使用。</li>
+</ul>
+
+**可以作为发起方和签署方的角色列表**
+<table>
+<thead>
+<tr>
+<th>场景编号</th>
+<th>可作为发起方类型</th>
+<th>可作为签署方的类型</th>
+</tr>
+</thead>
+
+<tbody>
+<tr>
+<td>场景一</td>
+<td>第三方子企业A员工</td>
+<td>第三方子企业A员工</td>
+</tr>
+
+<tr>
+<td>场景二</td>
+<td>第三方子企业A员工</td>
+<td>第三方子企业B(不指定经办人)</td>
+</tr>
+
+<tr>
+<td>场景三</td>
+<td>第三方子企业A员工</td>
+<td>第三方子企业B员工</td>
+</tr>
+
+<tr>
+<td>场景四</td>
+<td>第三方子企业A员工</td>
+<td>个人/自然人</td>
+</tr>
+
+<tr>
+<td>场景五</td>
+<td>第三方子企业A员工</td>
+<td>SaaS平台企业员工</td>
+</tr>
+</tbody>
+</table>
+
+**注**:
+`1. 发起合同时候,  作为发起方的第三方子企业A员工的企业和员工必须经过实名, 而作为签署方的第三方子企业A员工/个人/自然人/SaaS平台企业员工/第三方子企业B员工企业中的企业和个人/员工可以未实名`
+`2. 不同类型的签署方传参不同, 可以参考开发者中心的FlowApproverInfo结构体说明`
      */
     ChannelCreateFlowGroupByFiles(req: ChannelCreateFlowGroupByFilesRequest, cb?: (error: string, rep: ChannelCreateFlowGroupByFilesResponse) => void): Promise<ChannelCreateFlowGroupByFilesResponse>;
     /**

package/tencentcloud/services/essbasic/v20210526/essbasic_client.js

@@ -44,7 +44,9 @@ class Client extends abstract_client_1.AbstractClient {
         return this.request("ChannelCreateFlowSignReview", req, cb);
     }
     /**
-     * 此接口（ChannelCreateMultiFlowSignQRCode）用于创建一码多扫流程签署二维码。 适用场景：无需填写签署人信息，可通过模板id生成签署二维码，签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景，例如：劳务工招工、大批量员工入职等场景。
+     * 此接口（ChannelCreateMultiFlowSignQRCode）用于创建一码多扫流程签署二维码。
+适用场景：无需填写签署人信息，可通过模板id生成签署二维码，签署人可通过扫描二维码补充签署信息进行实名签署。
+常用于提前不知道签署人的身份信息场景，例如：劳务工招工、大批量员工入职等场景。
 
 **本接口适用于发起方没有填写控件的 B2C或者单C模板**
 
@@ -142,7 +144,9 @@ class Client extends abstract_client_1.AbstractClient {
         return this.request("CreateSealByImage", req, cb);
     }
     /**
-     * 此接口（ChannelCancelMultiFlowSignQRCode）用于取消一码多扫二维码。该接口对传入的二维码ID，若还在有效期内，可以提前失效。
+     * 此接口（CancelMultiFlowSignQRCode）用于废除一码多扫流程签署二维码。
+该接口所需的二维码ID，源自[创建一码多扫流程签署二维码](https://qian.tencent.com/developers/partnerApis/templates/ChannelCreateMultiFlowSignQRCode)生成的。
+如果该二维码尚处于有效期内，可通过本接口将其设置为失效状态。
      */
     async ChannelCancelMultiFlowSignQRCode(req, cb) {
         return this.request("ChannelCancelMultiFlowSignQRCode", req, cb);
@@ -154,6 +158,7 @@ class Client extends abstract_client_1.AbstractClient {
 3. 使用手机号验证签署方身份
 4. 骑缝章
 5. 拓宽签署方年龄限制
+6. 下载企业合同/文件
 
 注: 此接口 参数Agent. ProxyOperator.OpenId 需要传递超管或者法人的OpenId
      */
@@ -500,10 +505,12 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
         return this.request("ChannelCreateWebThemeConfig", req, cb);
     }
     /**
-     * 指定需要批量催办的签署流程Id，批量催办合同，最多100个；接口失败后返回错误信息
-注意:
-该接口不可直接调用，请联系客户经理申请使用
-仅能催办当前状态为“待签署”的签署人，且只能催办一次
+     * 指定需要批量催办的签署流程ID，批量催办合同，最多100个。需要符合以下条件的合同才可被催办：
+
+1. 合同中当前状态为“待签署”的签署人是催办的对象
+2. 每个合同只能催办一次
+
+注意：该接口无法直接调用，请联系客户经理申请使用。
      */
     async ChannelCreateFlowReminds(req, cb) {
         return this.request("ChannelCreateFlowReminds", req, cb);
@@ -622,6 +629,64 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
     }
     /**
      * 接口（ChannelCreateFlowGroupByTemplates）用于通过多模板创建合同组签署流程。
+
+合同组是将多个合同签署流程组织在一起，多个合同同时创建，每个签署方得到一个签署链接，`一次完成合同组中多个合同的签署`。合同组的合同`不能拆分一个一个签署`，只能作为一个整体签署。
+
+适用场景：该接口适用于需要一次性完成多份合同签署的情况，多份合同一般具有关联性，用户以目录的形式查看合同。
+
+**注**:
+<ul>
+<li>此接口静默签(企业自动签)能力为白名单功能，使用前请联系对接的客户经理沟通。</li>
+<li>合同组暂不支持抄送功能</li>
+</ul>
+
+**可以作为发起方和签署方的角色列表**
+<table>
+<thead>
+<tr>
+<th>场景编号</th>
+<th>可作为发起方类型</th>
+<th>可作为签署方的类型</th>
+</tr>
+</thead>
+
+<tbody>
+<tr>
+<td>场景一</td>
+<td>第三方子企业A员工</td>
+<td>第三方子企业A员工</td>
+</tr>
+
+<tr>
+<td>场景二</td>
+<td>第三方子企业A员工</td>
+<td>第三方子企业B(不指定经办人)</td>
+</tr>
+
+<tr>
+<td>场景三</td>
+<td>第三方子企业A员工</td>
+<td>第三方子企业B员工</td>
+</tr>
+
+<tr>
+<td>场景四</td>
+<td>第三方子企业A员工</td>
+<td>个人/自然人</td>
+</tr>
+
+<tr>
+<td>场景五</td>
+<td>第三方子企业A员工</td>
+<td>SaaS平台企业员工</td>
+</tr>
+</tbody>
+</table>
+
+**注**:
+`1. 发起合同时候,  作为发起方的第三方子企业A员工的企业和员工必须经过实名, 而作为签署方的第三方子企业A员工/个人/自然人/SaaS平台企业员工/第三方子企业B员工企业中的企业和个人/员工可以未实名`
+
+`2. 不同类型的签署方传参不同, 可以参考开发者中心的FlowApproverInfo结构体说明`
      */
     async ChannelCreateFlowGroupByTemplates(req, cb) {
         return this.request("ChannelCreateFlowGroupByTemplates", req, cb);
@@ -707,7 +772,66 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
         return this.request("ChannelCreatePreparedPersonalEsign", req, cb);
     }
     /**
-     * 接口（ChannelCreateFlowGroupByFiles）用于通过多文件创建合同组签署流程。
+     * 接口（ChannelCreateFlowGroupByFiles）用于使用 PDF 文件创建合同组签署流程。
+
+合同组是将多个合同签署流程组织在一起，多个合同同时创建，每个签署方得到一个签署链接，`一次完成合同组中多个合同的签署`。合同组的合同`不能拆分一个一个签署`，只能作为一个整体签署。
+
+适用场景：该接口适用于需要一次性完成多份合同签署的情况，多份合同一般具有关联性，用户以目录的形式查看合同。
+
+
+
+**注**:
+<ul>
+<li>此接口静默签(企业自动签)能力为白名单功能，使用前请联系对接的客户经理沟通。</li>
+<li>此接口需要依赖<a href="https://qian.tencent.com/developers/partnerApis/files/UploadFiles" target="_blank">文件上传接口</a>生成pdf资源编号（FileIds）进行使用。</li>
+</ul>
+
+**可以作为发起方和签署方的角色列表**
+<table>
+<thead>
+<tr>
+<th>场景编号</th>
+<th>可作为发起方类型</th>
+<th>可作为签署方的类型</th>
+</tr>
+</thead>
+
+<tbody>
+<tr>
+<td>场景一</td>
+<td>第三方子企业A员工</td>
+<td>第三方子企业A员工</td>
+</tr>
+
+<tr>
+<td>场景二</td>
+<td>第三方子企业A员工</td>
+<td>第三方子企业B(不指定经办人)</td>
+</tr>
+
+<tr>
+<td>场景三</td>
+<td>第三方子企业A员工</td>
+<td>第三方子企业B员工</td>
+</tr>
+
+<tr>
+<td>场景四</td>
+<td>第三方子企业A员工</td>
+<td>个人/自然人</td>
+</tr>
+
+<tr>
+<td>场景五</td>
+<td>第三方子企业A员工</td>
+<td>SaaS平台企业员工</td>
+</tr>
+</tbody>
+</table>
+
+**注**:
+`1. 发起合同时候,  作为发起方的第三方子企业A员工的企业和员工必须经过实名, 而作为签署方的第三方子企业A员工/个人/自然人/SaaS平台企业员工/第三方子企业B员工企业中的企业和个人/员工可以未实名`
+`2. 不同类型的签署方传参不同, 可以参考开发者中心的FlowApproverInfo结构体说明`
      */
     async ChannelCreateFlowGroupByFiles(req, cb) {
         return this.request("ChannelCreateFlowGroupByFiles", req, cb);