tencentcloud-sdk-nodejs-ess 4.0.453 → 4.0.455

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

@@ -17,21 +17,26 @@
  */
 import * as TencentCloudCommon from "tencentcloud-sdk-nodejs-common"
 import {
-  UploadFile,
+  PdfVerifyResult,
   CancelMultiFlowSignQRCodeRequest,
   CreateFlowEvidenceReportResponse,
   DescribeFileUrlsResponse,
   TemplateInfo,
   CreateDocumentResponse,
+  DescribeIntegrationEmployeesRequest,
   StartFlowRequest,
   CancelFlowResponse,
   CreateDocumentRequest,
   CreateFlowRequest,
+  Department,
   CreateSchemeUrlRequest,
-  FileUrl,
+  DeleteStaffsResult,
   DescribeThirdPartyAuthCodeRequest,
+  FileUrl,
+  DeleteIntegrationEmployeesResponse,
   Filter,
-  SignQrCode,
+  DeleteIntegrationEmployeesRequest,
+  DescribeIntegrationEmployeesResponse,
   CreateFlowApproversResponse,
   DescribeFlowInfoRequest,
   RegisterInfo,
@@ -41,30 +46,39 @@ import {
   CreateMultiFlowSignQRCodeResponse,
   FlowCreateApprover,
   UploadFilesResponse,
+  CreateIntegrationEmployeesResponse,
   DescribeThirdPartyAuthCodeResponse,
   FlowDetailInfo,
+  UploadFile,
   CreateFlowByFilesResponse,
-  OrganizationInfo,
+  FailedCreateStaffData,
   DescribeFlowBriefsRequest,
+  SuccessCreateStaffData,
   Recipient,
   VerifyPdfRequest,
   UserInfo,
   FillApproverInfo,
   SignUrl,
   VerifyPdfResponse,
-  DescribeFileUrlsRequest,
+  CreateIntegrationEmployeesRequest,
   ApproverInfo,
   CreateFlowSignReviewResponse,
   Caller,
   DescribeFlowTemplatesResponse,
-  PdfVerifyResult,
+  FailedDeleteStaffData,
   CreateFlowEvidenceReportRequest,
   CreateBatchCancelFlowUrlResponse,
+  CreateStaffResult,
   UploadFilesRequest,
+  SignQrCode,
+  StaffRole,
+  DescribeFileUrlsRequest,
+  OrganizationInfo,
   StartFlowResponse,
   GetTaskResultApiRequest,
   FileInfo,
   CreateBatchCancelFlowUrlRequest,
+  SuccessDeleteStaffData,
   CreateMultiFlowSignQRCodeRequest,
   CreateConvertTaskApiResponse,
   CreateFlowSignReviewRequest,
@@ -83,6 +97,7 @@ import {
   CreateFlowApproversRequest,
   FlowBrief,
   CcInfo,
+  Staff,
 } from "./ess_models"
 
 /**
@@ -95,13 +110,38 @@ export class Client extends TencentCloudCommon.AbstractClient {
   }
 
   /**
-   * 验证合同文件
-   */
-  async VerifyPdf(
-    req: VerifyPdfRequest,
-    cb?: (error: string, rep: VerifyPdfResponse) => void
-  ): Promise<VerifyPdfResponse> {
-    return this.request("VerifyPdf", req, cb)
+     * 此接口用于发起流程
+适用场景：见创建签署流程接口。
+注：该接口是“创建电子文档”接口的后置接口，用于激活包含完整合同信息（模板及内容信息）的流程。激活后的流程就是一份待签署的电子合同。
+     */
+  async StartFlow(
+    req: StartFlowRequest,
+    cb?: (error: string, rep: StartFlowResponse) => void
+  ): Promise<StartFlowResponse> {
+    return this.request("StartFlow", req, cb)
+  }
+
+  /**
+     * 用于撤销签署流程
+适用场景：如果某个合同流程当前至少还有一方没有签署，则可通过该接口取消该合同流程。常用于合同发错、内容填错，需要及时撤销的场景。
+注：如果合同流程中的参与方均已签署完毕，则无法通过该接口撤销合同。
+     */
+  async CancelFlow(
+    req: CancelFlowRequest,
+    cb?: (error: string, rep: CancelFlowResponse) => void
+  ): Promise<CancelFlowResponse> {
+    return this.request("CancelFlow", req, cb)
+  }
+
+  /**
+     * 二期接口-查询模板
+适用场景：当模板较多或模板中的控件较多时，可以通过查询模板接口更方便的获取自己主体下的模板列表，以及每个模板内的控件信息。该接口常用来配合“创建电子文档”接口作为前置的接口使用。
+     */
+  async DescribeFlowTemplates(
+    req: DescribeFlowTemplatesRequest,
+    cb?: (error: string, rep: DescribeFlowTemplatesResponse) => void
+  ): Promise<DescribeFlowTemplatesResponse> {
+    return this.request("DescribeFlowTemplates", req, cb)
   }
 
   /**
@@ -116,26 +156,38 @@ export class Client extends TencentCloudCommon.AbstractClient {
   }
 
   /**
-     * 查询合同详情
-适用场景：可用于主动查询某个合同详情信息。
+   * 验证合同文件
+   */
+  async VerifyPdf(
+    req: VerifyPdfRequest,
+    cb?: (error: string, rep: VerifyPdfResponse) => void
+  ): Promise<VerifyPdfResponse> {
+    return this.request("VerifyPdf", req, cb)
+  }
+
+  /**
+     * 电子签企业版：指定需要批量撤回的签署流程Id，获取批量撤销链接
+客户指定需要撤回的签署流程Id，最多100个，超过100不处理；接口调用成功返回批量撤回合同的链接，通过链接跳转到电子签小程序完成批量撤回
      */
-  async DescribeFlowInfo(
-    req: DescribeFlowInfoRequest,
-    cb?: (error: string, rep: DescribeFlowInfoResponse) => void
-  ): Promise<DescribeFlowInfoResponse> {
-    return this.request("DescribeFlowInfo", req, cb)
+  async CreateBatchCancelFlowUrl(
+    req: CreateBatchCancelFlowUrlRequest,
+    cb?: (error: string, rep: CreateBatchCancelFlowUrlResponse) => void
+  ): Promise<CreateBatchCancelFlowUrlResponse> {
+    return this.request("CreateBatchCancelFlowUrl", req, cb)
   }
 
   /**
-     * 此接口用于发起流程
-适用场景：见创建签署流程接口。
-注：该接口是“创建电子文档”接口的后置接口，用于激活包含完整合同信息（模板及内容信息）的流程。激活后的流程就是一份待签署的电子合同。
+     * 补充签署流程本企业签署人信息
+适用场景：在通过模板或者文件发起合同时，若未指定本企业签署人信息，则流程发起后，可以调用此接口补充签署人。
+同一签署人可以补充多个员工作为候选签署人,最终签署人取决于谁先领取合同完成签署。
+
+注：目前暂时只支持补充来源于企业微信的员工作为候选签署人
      */
-  async StartFlow(
-    req: StartFlowRequest,
-    cb?: (error: string, rep: StartFlowResponse) => void
-  ): Promise<StartFlowResponse> {
-    return this.request("StartFlow", req, cb)
+  async CreateFlowApprovers(
+    req: CreateFlowApproversRequest,
+    cb?: (error: string, rep: CreateFlowApproversResponse) => void
+  ): Promise<CreateFlowApproversResponse> {
+    return this.request("CreateFlowApprovers", req, cb)
   }
 
   /**
@@ -152,18 +204,6 @@ export class Client extends TencentCloudCommon.AbstractClient {
     return this.request("CreateFlowSignReview", req, cb)
   }
 
-  /**
-     * 用于撤销签署流程
-适用场景：如果某个合同流程当前至少还有一方没有签署，则可通过该接口取消该合同流程。常用于合同发错、内容填错，需要及时撤销的场景。
-注：如果合同流程中的参与方均已签署完毕，则无法通过该接口撤销合同。
-     */
-  async CancelFlow(
-    req: CancelFlowRequest,
-    cb?: (error: string, rep: CancelFlowResponse) => void
-  ): Promise<CancelFlowResponse> {
-    return this.request("CancelFlow", req, cb)
-  }
-
   /**
      * 创建签署流程电子文档
 适用场景：见创建签署流程接口。
@@ -177,31 +217,19 @@ export class Client extends TencentCloudCommon.AbstractClient {
   }
 
   /**
-     * 此接口（CreateMultiFlowSignQRCode）用于创建一码多扫流程签署二维码。
-适用场景：无需填写签署人信息，可通过模板id生成签署二维码，签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景，例如：劳务工招工、大批量员工入职等场景。
-适用的模板仅限于B2C（1、无序签署，2、顺序签署时B静默签署，3、顺序签署时B非首位签署）、单C的模板，且模板中发起方没有填写控件。
+     * 查询合同详情
+适用场景：可用于主动查询某个合同详情信息。
      */
-  async CreateMultiFlowSignQRCode(
-    req: CreateMultiFlowSignQRCodeRequest,
-    cb?: (error: string, rep: CreateMultiFlowSignQRCodeResponse) => void
-  ): Promise<CreateMultiFlowSignQRCodeResponse> {
-    return this.request("CreateMultiFlowSignQRCode", req, cb)
+  async DescribeFlowInfo(
+    req: DescribeFlowInfoRequest,
+    cb?: (error: string, rep: DescribeFlowInfoResponse) => void
+  ): Promise<DescribeFlowInfoResponse> {
+    return this.request("DescribeFlowInfo", req, cb)
   }
 
   /**
-   * 通过AuthCode查询用户是否实名
+   * 创建出证报告，返回报告 URL。此接口暂未开放，有问题请联系运营人员。
    */
-  async DescribeThirdPartyAuthCode(
-    req: DescribeThirdPartyAuthCodeRequest,
-    cb?: (error: string, rep: DescribeThirdPartyAuthCodeResponse) => void
-  ): Promise<DescribeThirdPartyAuthCodeResponse> {
-    return this.request("DescribeThirdPartyAuthCode", req, cb)
-  }
-
-  /**
-     * 【描述】：创建出证报告，返回报告 URL
-【注意】：此接口需要通过添加白名单获取调用权限，请联系运营人员加白
-     */
   async CreateFlowEvidenceReport(
     req: CreateFlowEvidenceReportRequest,
     cb?: (error: string, rep: CreateFlowEvidenceReportResponse) => void
@@ -235,33 +263,15 @@ export class Client extends TencentCloudCommon.AbstractClient {
   }
 
   /**
-   * 此接口（CancelMultiFlowSignQRCode）用于取消一码多扫二维码。该接口对传入的二维码ID，若还在有效期内，可以提前失效。
-   */
-  async CancelMultiFlowSignQRCode(
-    req: CancelMultiFlowSignQRCodeRequest,
-    cb?: (error: string, rep: CancelMultiFlowSignQRCodeResponse) => void
-  ): Promise<CancelMultiFlowSignQRCodeResponse> {
-    return this.request("CancelMultiFlowSignQRCode", req, cb)
-  }
-
-  /**
-     * 获取小程序跳转链接
-
-适用场景：如果需要签署人在自己的APP、小程序、H5应用中签署，可以通过此接口获取跳转腾讯电子签小程序的签署跳转链接。
-
-注：如果签署人是在PC端扫码签署，可以通过生成跳转链接自主转换成二维码，让签署人在PC端扫码签署。
-
-
-跳转到小程序的实现，参考官方文档（分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式）
-
-
-如您需要自主配置小程序跳转链接，请参考: <a href="https://cloud.tencent.com/document/product/1323/74774">跳转小程序链接配置说明</a>
+     * 此接口（CreateMultiFlowSignQRCode）用于创建一码多扫流程签署二维码。
+适用场景：无需填写签署人信息，可通过模板id生成签署二维码，签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景，例如：劳务工招工、大批量员工入职等场景。
+适用的模板仅限于B2C（1、无序签署，2、顺序签署时B静默签署，3、顺序签署时B非首位签署）、单C的模板，且模板中发起方没有填写控件。
      */
-  async CreateSchemeUrl(
-    req: CreateSchemeUrlRequest,
-    cb?: (error: string, rep: CreateSchemeUrlResponse) => void
-  ): Promise<CreateSchemeUrlResponse> {
-    return this.request("CreateSchemeUrl", req, cb)
+  async CreateMultiFlowSignQRCode(
+    req: CreateMultiFlowSignQRCodeRequest,
+    cb?: (error: string, rep: CreateMultiFlowSignQRCodeResponse) => void
+  ): Promise<CreateMultiFlowSignQRCodeResponse> {
+    return this.request("CreateMultiFlowSignQRCode", req, cb)
   }
 
   /**
@@ -275,35 +285,33 @@ export class Client extends TencentCloudCommon.AbstractClient {
   }
 
   /**
-   * 创建文件转换任务
+   * 此接口（CancelMultiFlowSignQRCode）用于取消一码多扫二维码。该接口对传入的二维码ID，若还在有效期内，可以提前失效。
    */
-  async CreateConvertTaskApi(
-    req: CreateConvertTaskApiRequest,
-    cb?: (error: string, rep: CreateConvertTaskApiResponse) => void
-  ): Promise<CreateConvertTaskApiResponse> {
-    return this.request("CreateConvertTaskApi", req, cb)
+  async CancelMultiFlowSignQRCode(
+    req: CancelMultiFlowSignQRCodeRequest,
+    cb?: (error: string, rep: CancelMultiFlowSignQRCodeResponse) => void
+  ): Promise<CancelMultiFlowSignQRCodeResponse> {
+    return this.request("CancelMultiFlowSignQRCode", req, cb)
   }
 
   /**
-     * 二期接口-查询模板
-适用场景：当模板较多或模板中的控件较多时，可以通过查询模板接口更方便的获取自己主体下的模板列表，以及每个模板内的控件信息。该接口常用来配合“创建电子文档”接口作为前置的接口使用。
-     */
-  async DescribeFlowTemplates(
-    req: DescribeFlowTemplatesRequest,
-    cb?: (error: string, rep: DescribeFlowTemplatesResponse) => void
-  ): Promise<DescribeFlowTemplatesResponse> {
-    return this.request("DescribeFlowTemplates", req, cb)
+   * 查询员工信息，每次返回的数据量最大为20
+   */
+  async DescribeIntegrationEmployees(
+    req: DescribeIntegrationEmployeesRequest,
+    cb?: (error: string, rep: DescribeIntegrationEmployeesResponse) => void
+  ): Promise<DescribeIntegrationEmployeesResponse> {
+    return this.request("DescribeIntegrationEmployees", req, cb)
   }
 
   /**
-     * 电子签企业版：指定需要批量撤回的签署流程Id，获取批量撤销链接
-客户指定需要撤回的签署流程Id，最多100个，超过100不处理；接口调用成功返回批量撤回合同的链接，通过链接跳转到电子签小程序完成批量撤回
-     */
-  async CreateBatchCancelFlowUrl(
-    req: CreateBatchCancelFlowUrlRequest,
-    cb?: (error: string, rep: CreateBatchCancelFlowUrlResponse) => void
-  ): Promise<CreateBatchCancelFlowUrlResponse> {
-    return this.request("CreateBatchCancelFlowUrl", req, cb)
+   * 创建文件转换任务
+   */
+  async CreateConvertTaskApi(
+    req: CreateConvertTaskApiRequest,
+    cb?: (error: string, rep: CreateConvertTaskApiResponse) => void
+  ): Promise<CreateConvertTaskApiResponse> {
+    return this.request("CreateConvertTaskApi", req, cb)
   }
 
   /**
@@ -318,20 +326,6 @@ export class Client extends TencentCloudCommon.AbstractClient {
     return this.request("DescribeFlowBriefs", req, cb)
   }
 
-  /**
-     * 补充签署流程本企业签署人信息
-适用场景：在通过模板或者文件发起合同时，若未指定本企业签署人信息，则流程发起后，可以调用此接口补充签署人。
-同一签署人可以补充多个员工作为候选签署人,最终签署人取决于谁先领取合同完成签署。
-
-注：目前暂时只支持补充来源于企业微信的员工作为候选签署人
-     */
-  async CreateFlowApprovers(
-    req: CreateFlowApproversRequest,
-    cb?: (error: string, rep: CreateFlowApproversResponse) => void
-  ): Promise<CreateFlowApproversResponse> {
-    return this.request("CreateFlowApprovers", req, cb)
-  }
-
   /**
      * 此接口（UploadFiles）用于文件上传。
 适用场景：用于生成pdf资源编号（FileIds）来配合“用PDF创建流程”接口使用，使用场景可详见“用PDF创建流程”接口说明。
@@ -343,4 +337,54 @@ export class Client extends TencentCloudCommon.AbstractClient {
   ): Promise<UploadFilesResponse> {
     return this.request("UploadFiles", req, cb)
   }
+
+  /**
+   * 通过AuthCode查询用户是否实名
+   */
+  async DescribeThirdPartyAuthCode(
+    req: DescribeThirdPartyAuthCodeRequest,
+    cb?: (error: string, rep: DescribeThirdPartyAuthCodeResponse) => void
+  ): Promise<DescribeThirdPartyAuthCodeResponse> {
+    return this.request("DescribeThirdPartyAuthCode", req, cb)
+  }
+
+  /**
+   * 移除员工
+   */
+  async DeleteIntegrationEmployees(
+    req: DeleteIntegrationEmployeesRequest,
+    cb?: (error: string, rep: DeleteIntegrationEmployeesResponse) => void
+  ): Promise<DeleteIntegrationEmployeesResponse> {
+    return this.request("DeleteIntegrationEmployees", req, cb)
+  }
+
+  /**
+     * 获取小程序跳转链接
+
+适用场景：如果需要签署人在自己的APP、小程序、H5应用中签署，可以通过此接口获取跳转腾讯电子签小程序的签署跳转链接。
+
+注：如果签署人是在PC端扫码签署，可以通过生成跳转链接自主转换成二维码，让签署人在PC端扫码签署。
+
+
+跳转到小程序的实现，参考官方文档（分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式）
+
+
+如您需要自主配置小程序跳转链接，请参考: <a href="https://cloud.tencent.com/document/product/1323/74774">跳转小程序链接配置说明</a>
+     */
+  async CreateSchemeUrl(
+    req: CreateSchemeUrlRequest,
+    cb?: (error: string, rep: CreateSchemeUrlResponse) => void
+  ): Promise<CreateSchemeUrlResponse> {
+    return this.request("CreateSchemeUrl", req, cb)
+  }
+
+  /**
+   * 创建员工
+   */
+  async CreateIntegrationEmployees(
+    req: CreateIntegrationEmployeesRequest,
+    cb?: (error: string, rep: CreateIntegrationEmployeesResponse) => void
+  ): Promise<CreateIntegrationEmployeesResponse> {
+    return this.request("CreateIntegrationEmployees", req, cb)
+  }
 }