tencentcloud-sdk-nodejs 4.0.687 → 4.0.689

package/src/services/ess/v20201111/ess_client.ts

@@ -26,7 +26,6 @@ import {
   Department,
   CreatePreparedPersonalEsignRequest,
   DescribeIntegrationDepartmentsResponse,
-  FileInfo,
   CreateFlowApproversResponse,
   DescribeFileUrlsResponse,
   ModifyApplicationCallbackInfoResponse,
@@ -62,14 +61,13 @@ import {
   TemplateInfo,
   CreateDocumentResponse,
   DescribeIntegrationEmployeesRequest,
-  UnbindEmployeeUserIdWithClientOpenIdResponse,
   CreateIntegrationUserRolesResponse,
   CreateFlowRequest,
   CreateSchemeUrlRequest,
   DeleteIntegrationDepartmentResponse,
   AutoSignConfig,
   DescribeThirdPartyAuthCodeRequest,
-  DescribeIntegrationMainOrganizationUserRequest,
+  UnbindEmployeeUserIdWithClientOpenIdResponse,
   CreateReleaseFlowResponse,
   CreateWebThemeConfigResponse,
   BindEmployeeUserIdWithClientOpenIdRequest,
@@ -148,7 +146,7 @@ import {
   CreateStaffResult,
   CreateUserAutoSignEnableUrlRequest,
   CreateOrganizationBatchSignUrlResponse,
-  DescribeIntegrationMainOrganizationUserResponse,
+  FileInfo,
   CancelUserAutoSignEnableUrlRequest,
   FailedCreateStaffData,
   ApproverRestriction,
@@ -162,7 +160,6 @@ import {
   DeleteIntegrationDepartmentRequest,
   WebThemeConfig,
   ModifyApplicationCallbackInfoRequest,
-  IntegrationMainOrganizationUser,
   StartFlowRequest,
   CreateSealResponse,
   CreatePrepareFlowRequest,
@@ -340,8 +337,15 @@ export class Client extends AbstractClient {
   }
 
   /**
-   * 本接口（CreateEmbedWebUrl）用于创建嵌入web的链接 本接口支持创建：创建印章，创建模板，修改模板，预览模板，预览合同流程的web链接 进入web连接后与当前控制台操作保持一致
-   */
+     * 本接口（CreateEmbedWebUrl）用于创建嵌入Web的链接，支持以下类型的Web链接创建：
+1. 创建印章
+2. 创建模板
+3. 修改模板
+4. 预览模板
+5. 预览合同流程
+
+用户可以通过这些链接快速将其集成到自己的系统中。
+     */
   async CreateEmbedWebUrl(
     req: CreateEmbedWebUrlRequest,
     cb?: (error: string, rep: CreateEmbedWebUrlResponse) => void
@@ -412,12 +416,13 @@ export class Client extends AbstractClient {
   }
 
   /**
-     * ### 适用场景
-在通过模板或者文件发起合同时，若未指定企业签署人信息，则流程发起后，可以调用此接口补充或签签署人。
-同一签署人可以补充多个员工作为或签签署人,最终实际签署人取决于谁先领取合同完成签署。
-### 限制条件
--  本企业(发起方企业)支持通过企业微信UserId 或者 姓名+手机号补充
-- 他方企业仅支持通过姓名+手机号补充
+     * 适用场景：
+当通过模板或文件发起合同时，若未指定企业签署人信息，则可调用此接口补充或添加签署人。同一签署人可补充多个员工作为或签署人，最终实际签署人取决于谁先领取合同完成签署。
+
+限制条件：
+1. 本企业（发起方企业）企业微信签署人仅支持通过企业微信UserId或姓名+手机号进行补充。
+2. 本企业（发起方企业）非企业微信签署人仅支持通过姓名+手机号进行补充。
+3. 他方企业仅支持通过姓名+手机号进行补充。
      */
   async CreateFlowApprovers(
     req: CreateFlowApproversRequest,
@@ -437,23 +442,7 @@ export class Client extends AbstractClient {
   }
 
   /**
-     * 通过此接口可以关闭个人用户自动签功能。
-无需对应的用户刷脸等方式同意即可关闭。
-
-注意: 
-
-<ul><li>处方单等特殊场景专用，此接口为白名单功能，使用前请联系对接的客户经理沟通。</li>
-<li>如果此用户在开通时候绑定过个人自动签账号许可,  关闭此用户的自动签不会归还个人自动签账号许可的额度。</li></ul>
-     */
-  async DisableUserAutoSign(
-    req: DisableUserAutoSignRequest,
-    cb?: (error: string, rep: DisableUserAutoSignResponse) => void
-  ): Promise<DisableUserAutoSignResponse> {
-    return this.request("DisableUserAutoSign", req, cb)
-  }
-
-  /**
-   * 解绑员工与对应角色关系
+   * 解绑员工与对应角色的关系，如需绑定请使用 CreateIntegrationUserRoles 接口。
    */
   async DeleteIntegrationRoleUsers(
     req: DeleteIntegrationRoleUsersRequest,
@@ -525,9 +514,15 @@ export class Client extends AbstractClient {
   }
 
   /**
-     * 创建出证报告并返回报告ID。
-使用此功能需搭配出证套餐。
-注意：出证过程需一定时间，建议在调用创建出证后的24小时之后，通过DescribeFlowEvidenceReport接口进行查询。
+     * 提交申请出证报告任务并返回报告ID。
+
+注意：
+<ul><li>使用此功能`需搭配出证套餐` ，使用前请联系对接的客户经理沟通。</li>
+<li>操作人必须是`发起方或者签署方企业的(非走授权书认证)法人或者超管`。</li>
+<li>合同流程必须所有参与方`已经签署完成`。</li>
+<li>出证过程需一定时间，建议在`提交出证任务后的24小时之后`，通过<a href="https://qian.tencent.com/developers/companyApis/certificate/DescribeFlowEvidenceReport" target="_blank">获取出证报告任务执行结果</a>接口进行查询执行结果和出证报告的下载URL。</li></ul>
+
+<svg id="SvgjsSvg1006" width="262" height="229" xmlns="http://www.w3.org/2000/svg" version="1.1" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svgjs="http://svgjs.com/svgjs"><defs id="SvgjsDefs1007"><pattern patternUnits="userSpaceOnUse" id="pattern_mark_0" width="300" height="300"><text x="150" y="100" fill="rgba(229,229,229,0.8)" font-size="18" transform="rotate(-45, 150, 150)" style="dominant-baseline: middle; text-anchor: middle;"></text></pattern><pattern patternUnits="userSpaceOnUse" id="pattern_mark_1" width="300" height="300"><text x="150" y="200" fill="rgba(229,229,229,0.8)" font-size="18" transform="rotate(-45, 150, 150)" style="dominant-baseline: middle; text-anchor: middle;"></text></pattern><marker id="SvgjsMarker1021" markerWidth="12" markerHeight="8" refX="9" refY="4" viewBox="0 0 12 8" orient="auto" markerUnits="userSpaceOnUse" stroke-dasharray="0,0"><path id="SvgjsPath1022" d="M0,0 L12,4 L0,8 L0,0" fill="#323232" stroke="#323232" stroke-width="1"></path></marker></defs><rect id="svgbackgroundid" width="262" height="229" fill="transparent"></rect><rect id="SvgjsRect1009" width="262" height="229" fill="url(#pattern_mark_0)"></rect><rect id="SvgjsRect1010" width="262" height="229" fill="url(#pattern_mark_1)"></rect><g id="SvgjsG1011" transform="translate(31.75,25)"><path id="SvgjsPath1012" d="M 0 0L 198 0L 198 59L 0 59Z" stroke="rgba(86,146,48,1)" stroke-width="1" fill-opacity="1" fill="#e7ebed"></path><g id="SvgjsG1013"><text id="SvgjsText1014" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="178px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="10.375" transform="rotate(0)"><tspan id="SvgjsTspan1015" dy="16" x="99"><tspan id="SvgjsTspan1016" style="text-decoration:;fill: rgb(28, 30, 33);">CreateFlowEvidenceReport</tspan></tspan><tspan id="SvgjsTspan1017" dy="16" x="99"><tspan id="SvgjsTspan1018" style="text-decoration:;fill: rgb(51, 51, 51);">提交申请出证报告任务</tspan></tspan></text></g></g><g id="SvgjsG1019"><path id="SvgjsPath1020" d="M130.75 84.5L130.75 114.5L130.75 114.5L130.75 143.2" stroke="#323232" stroke-width="1" fill="none" marker-end="url(#SvgjsMarker1021)"></path></g><g id="SvgjsG1023" transform="translate(25,145)"><path id="SvgjsPath1024" d="M 0 0L 211.5 0L 211.5 59L 0 59Z" stroke="rgba(86,146,48,1)" stroke-width="1" fill-opacity="1" fill="#e7ebed"></path><g id="SvgjsG1025"><text id="SvgjsText1026" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="192px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="10.375" transform="rotate(0)"><tspan id="SvgjsTspan1027" dy="16" x="106"><tspan id="SvgjsTspan1028" style="text-decoration:;fill: rgb(28, 30, 33);">DescribeFlowEvidenceReport</tspan></tspan><tspan id="SvgjsTspan1029" dy="16" x="106"><tspan id="SvgjsTspan1030" style="text-decoration:;fill: rgb(51, 51, 51);">获取出证报告任务执行结果</tspan></tspan></text></g></g></svg>
      */
   async CreateFlowEvidenceReport(
     req: CreateFlowEvidenceReportRequest,
@@ -583,8 +578,9 @@ export class Client extends AbstractClient {
   }
 
   /**
-     * 此接口（CreateFlowGroupByTemplates）通过多模板创建合同组签署流程。<br/>
-此接口合同组中的子合同必须都是模板发起的合同。 <br/>目前最大仅支持50个子合同
+     * 此接口（CreateFlowGroupByTemplates）可用于通过多个模板创建合同组签署流程。
+
+适用场景：该接口适用于需要一次性完成多份合同签署的情况，多份合同一般具有关联性，用户以目录的形式查看合同。
      */
   async CreateFlowGroupByTemplates(
     req: CreateFlowGroupByTemplatesRequest,
@@ -625,8 +621,16 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
   }
 
   /**
-   * 查询签署报告，返回报告 URL。需调用创建并返回出证报告接口（CreateFlowEvidenceReport）获取报告编号后调用当前接口获取报告链接。
-   */
+     * 获取出证报告任务执行结果，返回报告 URL。
+
+
+
+注意：
+<ul><li>使用此功能`需搭配出证套餐` ，使用前请联系对接的客户经理沟通。</li>
+<li>需调用创建并返回出证报告接口<a href="https://qian.tencent.com/developers/companyApis/certificate/CreateFlowEvidenceReport" target="_blank">提交申请出证报告任务</a>获取报告编号后调用当前接口获取报告链接。</li></ul>
+
+<svg id="SvgjsSvg1006" width="262" height="229" xmlns="http://www.w3.org/2000/svg" version="1.1" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svgjs="http://svgjs.com/svgjs"><defs id="SvgjsDefs1007"><pattern patternUnits="userSpaceOnUse" id="pattern_mark_0" width="300" height="300"><text x="150" y="100" fill="rgba(229,229,229,0.8)" font-size="18" transform="rotate(-45, 150, 150)" style="dominant-baseline: middle; text-anchor: middle;"></text></pattern><pattern patternUnits="userSpaceOnUse" id="pattern_mark_1" width="300" height="300"><text x="150" y="200" fill="rgba(229,229,229,0.8)" font-size="18" transform="rotate(-45, 150, 150)" style="dominant-baseline: middle; text-anchor: middle;"></text></pattern><marker id="SvgjsMarker1021" markerWidth="12" markerHeight="8" refX="9" refY="4" viewBox="0 0 12 8" orient="auto" markerUnits="userSpaceOnUse" stroke-dasharray="0,0"><path id="SvgjsPath1022" d="M0,0 L12,4 L0,8 L0,0" fill="#323232" stroke="#323232" stroke-width="1"></path></marker></defs><rect id="svgbackgroundid" width="262" height="229" fill="transparent"></rect><rect id="SvgjsRect1009" width="262" height="229" fill="url(#pattern_mark_0)"></rect><rect id="SvgjsRect1010" width="262" height="229" fill="url(#pattern_mark_1)"></rect><g id="SvgjsG1011" transform="translate(31.75,25)"><path id="SvgjsPath1012" d="M 0 0L 198 0L 198 59L 0 59Z" stroke="rgba(86,146,48,1)" stroke-width="1" fill-opacity="1" fill="#e7ebed"></path><g id="SvgjsG1013"><text id="SvgjsText1014" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="178px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="10.375" transform="rotate(0)"><tspan id="SvgjsTspan1015" dy="16" x="99"><tspan id="SvgjsTspan1016" style="text-decoration:;fill: rgb(28, 30, 33);">CreateFlowEvidenceReport</tspan></tspan><tspan id="SvgjsTspan1017" dy="16" x="99"><tspan id="SvgjsTspan1018" style="text-decoration:;fill: rgb(51, 51, 51);">提交申请出证报告任务</tspan></tspan></text></g></g><g id="SvgjsG1019"><path id="SvgjsPath1020" d="M130.75 84.5L130.75 114.5L130.75 114.5L130.75 143.2" stroke="#323232" stroke-width="1" fill="none" marker-end="url(#SvgjsMarker1021)"></path></g><g id="SvgjsG1023" transform="translate(25,145)"><path id="SvgjsPath1024" d="M 0 0L 211.5 0L 211.5 59L 0 59Z" stroke="rgba(86,146,48,1)" stroke-width="1" fill-opacity="1" fill="#e7ebed"></path><g id="SvgjsG1025"><text id="SvgjsText1026" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="192px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="10.375" transform="rotate(0)"><tspan id="SvgjsTspan1027" dy="16" x="106"><tspan id="SvgjsTspan1028" style="text-decoration:;fill: rgb(28, 30, 33);">DescribeFlowEvidenceReport</tspan></tspan><tspan id="SvgjsTspan1029" dy="16" x="106"><tspan id="SvgjsTspan1030" style="text-decoration:;fill: rgb(51, 51, 51);">获取出证报告任务执行结果</tspan></tspan></text></g></g></svg>
+     */
   async DescribeFlowEvidenceReport(
     req: DescribeFlowEvidenceReportRequest,
     cb?: (error: string, rep: DescribeFlowEvidenceReportResponse) => void
@@ -658,8 +662,10 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
   }
 
   /**
-   * 分页查询企业角色列表，法人的角色是系统保留角色，不会返回，按照角色创建时间升序排列
-   */
+     * 此接口（DescribeIntegrationRoles）用于分页查询企业角色列表，列表按照角色创建时间升序排列。
+
+注：`法人角色是系统保留角色，因此返回列表中不含法人角色。`
+     */
   async DescribeIntegrationRoles(
     req: DescribeIntegrationRolesRequest,
     cb?: (error: string, rep: DescribeIntegrationRolesResponse) => void
@@ -734,7 +740,11 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
 
 ![image](https://dyn.ess.tencent.cn/guide/capi/CreatePersonAuthCertificateImage.png)
 
-注:  `只能获取个人用户证明图片, 企业员工的暂不支持`
+注:  
+<ul>
+<li>只能获取个人用户证明图片, 企业员工的暂不支持</li>
+<li>处方单等特殊场景专用，此接口为白名单功能，使用前请联系对接的客户经理沟通。  </li>
+</ul>
      */
   async CreatePersonAuthCertificateImage(
     req: CreatePersonAuthCertificateImageRequest,
@@ -774,7 +784,7 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
   }
 
   /**
-   * 绑定员工与对应角色
+   * 此接口用于赋予员工指定的角色权限，如需解绑请使用 DeleteIntegrationRoleUsers 接口。
    */
   async CreateIntegrationUserRoles(
     req: CreateIntegrationUserRolesRequest,
@@ -813,7 +823,7 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
   }
 
   /**
-     * 使用此接口，您可以创建企业批量签署链接，员工只需点击链接即可跳转至控制台进行批量签署。</br>
+     * 使用此接口，您可以创建企业批量签署链接，员工只需点击链接即可跳转至控制台进行批量签署。<br/>
 附注：
 - 员工必须在企业下完成实名认证，且需作为批量签署合同的签署方。
 - 如有UserId，应以UserId为主要标识；如果没有UserId，则必须填写Name和Mobile信息。
@@ -852,15 +862,19 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
   }
 
   /**
-     * 集团企业统一使用主代子进行操作，无需根据子企业账号进行转化查询，该接口需要屏蔽下线
+     * 通过此接口可以关闭个人用户自动签功能。
+无需对应的用户刷脸等方式同意即可关闭。
 
-通过子企业影子账号查询主企业员工账号
+注意: 
+
+<ul><li>处方单等特殊场景专用，此接口为白名单功能，使用前请联系对接的客户经理沟通。</li>
+<li>如果此用户在开通时候绑定过个人自动签账号许可,  关闭此用户的自动签不会归还个人自动签账号许可的额度。</li></ul>
      */
-  async DescribeIntegrationMainOrganizationUser(
-    req: DescribeIntegrationMainOrganizationUserRequest,
-    cb?: (error: string, rep: DescribeIntegrationMainOrganizationUserResponse) => void
-  ): Promise<DescribeIntegrationMainOrganizationUserResponse> {
-    return this.request("DescribeIntegrationMainOrganizationUser", req, cb)
+  async DisableUserAutoSign(
+    req: DisableUserAutoSignRequest,
+    cb?: (error: string, rep: DisableUserAutoSignResponse) => void
+  ): Promise<DisableUserAutoSignResponse> {
+    return this.request("DisableUserAutoSign", req, cb)
   }
 
   /**
@@ -881,8 +895,9 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
   }
 
   /**
-   * 用来创建页面主题配置
-   */
+     * 用来创建嵌入式页面个性化主题配置（例如是否展示电子签logo、定义主题色等），该接口配合其他所有可嵌入页面接口使用
+创建配置对当前企业全局生效，如果多次调用，会以最后一次的配置为准
+     */
   async CreateWebThemeConfig(
     req: CreateWebThemeConfigRequest,
     cb?: (error: string, rep: CreateWebThemeConfigResponse) => void
@@ -964,9 +979,11 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
   }
 
   /**
-     * 此接口（CreateFlowGroupByFiles）通过多文件创建合同组签署流程。<br/>
-PDF资源Id 通过上传文件接口获取
-此接口合同组中的子合同必须都是文件发起的合同
+     * 此接口（CreateFlowGroupByFiles）可用于通过多个文件创建合同组签署流程。
+
+适用场景：该接口适用于需要一次性完成多份合同签署的情况，多份合同一般具有关联性，用户以目录的形式查看合同。
+
+注意事项：使用该接口需要先依赖[多文件上传](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口返回的FileIds。
      */
   async CreateFlowGroupByFiles(
     req: CreateFlowGroupByFilesRequest,