tencentcloud-sdk-nodejs-essbasic 4.0.397 → 4.0.431

package/src/services/essbasic/v20201222/index.ts

@@ -1,6 +1,6 @@
 import * as Models from "./essbasic_models"
 import { Client } from "./essbasic_client"
 export const v20201222 = {
-  Client: Client,
-  Models: Models,
-}
+    Client: Client,
+    Models: Models
+}

package/src/services/essbasic/v20210526/essbasic_client.ts

@@ -17,61 +17,76 @@
  */
 import * as TencentCloudCommon from "tencentcloud-sdk-nodejs-common"
 import {
-  ResourceUrlInfo,
-  SyncProxyOrganizationResponse,
-  FlowApproverInfo,
-  PrepareFlowsResponse,
-  ProxyOrganizationOperator,
-  TemplateInfo,
-  GetDownloadFlowUrlResponse,
-  DescribeResourceUrlsByFlowsResponse,
-  ChannelCreateMultiFlowSignQRCodeResponse,
-  Recipient,
-  DescribeTemplatesResponse,
-  OperateChannelTemplateResponse,
-  CreateSignUrlsRequest,
-  ChannelCreateMultiFlowSignQRCodeRequest,
-  AuthFailMessage,
-  DescribeFlowDetailInfoRequest,
-  SignQrCode,
-  UploadFilesRequest,
-  DescribeResourceUrlsByFlowsRequest,
-  UploadFile,
-  Component,
-  GetDownloadFlowUrlRequest,
-  FlowDetailInfo,
-  CreateConsoleLoginUrlRequest,
-  CreateFlowsByTemplatesResponse,
-  PrepareFlowsRequest,
-  SyncProxyOrganizationOperatorsResponse,
-  CreateSealByImageResponse,
-  FlowResourceUrlInfo,
-  DescribeTemplatesRequest,
-  SyncProxyOrganizationOperatorsRequest,
-  CreateConsoleLoginUrlResponse,
-  CreateFlowsByTemplatesRequest,
-  SyncProxyOrganizationRequest,
-  CreateSealByImageRequest,
-  UserInfo,
-  DescribeUsageResponse,
-  UsageDetail,
-  CreateSignUrlsResponse,
-  OperateChannelTemplateRequest,
-  DownloadFlowInfo,
-  ChannelCancelMultiFlowSignQRCodeRequest,
-  SyncFailReason,
-  DescribeUsageRequest,
-  ChannelCreateFlowByFilesRequest,
-  ChannelCreateFlowByFilesResponse,
-  UploadFilesResponse,
-  Agent,
-  FormField,
-  FlowApproverDetail,
-  FlowInfo,
-  SignUrlInfo,
-  CcInfo,
-  ChannelCancelMultiFlowSignQRCodeResponse,
-  DescribeFlowDetailInfoResponse,
+   ResourceUrlInfo,
+   SyncProxyOrganizationResponse,
+   FlowApproverInfo,
+   ChannelCreateConvertTaskApiResponse,
+   OperateChannelTemplateRequest,
+   TemplateInfo,
+   UploadFilesRequest,
+   GetDownloadFlowUrlResponse,
+   DescribeResourceUrlsByFlowsResponse,
+   ChannelCreateMultiFlowSignQRCodeResponse,
+   Recipient,
+   DescribeTemplatesResponse,
+   OperateChannelTemplateResponse,
+   CreateSignUrlsResponse,
+   CreateSignUrlsRequest,
+   ChannelCreateMultiFlowSignQRCodeRequest,
+   AuthFailMessage,
+   CreateChannelFlowEvidenceReportRequest,
+   DescribeFlowDetailInfoRequest,
+   ChannelGetTaskResultApiResponse,
+   ProxyOrganizationOperator,
+   ChannelGetTaskResultApiRequest,
+   UploadFile,
+   Component,
+   GetDownloadFlowUrlRequest,
+   FlowDetailInfo,
+   CreateConsoleLoginUrlRequest,
+   OrganizationInfo,
+   CreateFlowsByTemplatesResponse,
+   ChannelCreateFlowSignReviewRequest,
+   PrepareFlowsRequest,
+   SyncProxyOrganizationOperatorsResponse,
+   CreateSealByImageResponse,
+   SignUrl,
+   FlowResourceUrlInfo,
+   DescribeTemplatesRequest,
+   SyncProxyOrganizationOperatorsRequest,
+   CreateConsoleLoginUrlResponse,
+   CreateFlowsByTemplatesRequest,
+   SyncProxyOrganizationRequest,
+   CreateSealByImageRequest,
+   SignQrCode,
+   DescribeUsageResponse,
+   UsageDetail,
+   ChannelCreateBatchCancelFlowUrlResponse,
+   DescribeResourceUrlsByFlowsRequest,
+   DownloadFlowInfo,
+   ChannelCancelMultiFlowSignQRCodeRequest,
+   CreateChannelFlowEvidenceReportResponse,
+   SyncFailReason,
+   PrepareFlowsResponse,
+   DescribeUsageRequest,
+   ChannelCreateBatchCancelFlowUrlRequest,
+   ApproverRestriction,
+   ChannelCreateFlowByFilesRequest,
+   ChannelCreateFlowByFilesResponse,
+   UploadFilesResponse,
+   ChannelCreateFlowSignReviewResponse,
+   Agent,
+   FormField,
+   UserInfo,
+   ChannelCreateConvertTaskApiRequest,
+   FlowApproverDetail,
+   FlowInfo,
+   SignUrlInfo,
+   TaskInfo,
+   CcInfo,
+   ChannelCancelMultiFlowSignQRCodeResponse,
+   DescribeFlowDetailInfoResponse,
+
 } from "./essbasic_models"
 
 /**
@@ -79,189 +94,181 @@ import {
  * @class
  */
 export class Client extends TencentCloudCommon.AbstractClient {
-  constructor(clientConfig: TencentCloudCommon.ClientConfig) {
-    super("essbasic.tencentcloudapi.com", "2021-05-26", clientConfig)
-  }
 
-  /**
-   * 接口（CreateFlowsByTemplates）用于使用多个模板批量创建签署流程。当前可批量发起合同（签署流程）数量最大为20个。
-   */
-  async CreateFlowsByTemplates(
-    req: CreateFlowsByTemplatesRequest,
-    cb?: (error: string, rep: CreateFlowsByTemplatesResponse) => void
-  ): Promise<CreateFlowsByTemplatesResponse> {
-    return this.request("CreateFlowsByTemplates", req, cb)
-  }
+    constructor(clientConfig: TencentCloudCommon.ClientConfig) {
+        super("essbasic.tencentcloudapi.com", "2021-05-26", clientConfig);
+    }
+    
+    /**
+     * 提交企业签署流程审批结果
 
-  /**
-     * 此接口（GetDownloadFlowUrl）用于创建电子签批量下载地址，让合作企业进入控制台直接下载，支持客户合同（流程）按照自定义文件夹形式 分类下载。
-当前接口限制最多合同（流程）50个.
+在通过接口(CreateFlowsByTemplates 或者ChannelCreateFlowByFiles)创建签署流程时，若指定了参数 NeedSignReview 为true,则可以调用此接口提交企业内部签署审批结果。
+若签署流程状态正常，且本企业存在签署方未签署，同一签署流程可以多次提交签署审批结果，签署时的最后一个“审批结果”有效。
+     */
+    async ChannelCreateFlowSignReview(req: ChannelCreateFlowSignReviewRequest, cb?: (error: string, rep: ChannelCreateFlowSignReviewResponse) => void): Promise<ChannelCreateFlowSignReviewResponse> {
+        return this.request("ChannelCreateFlowSignReview", req, cb);
+    }
 
+    /**
+     * 此接口（ChannelCreateMultiFlowSignQRCode）用于创建一码多扫签署流程二维码。
+适用的模版仅限于B2C（1、无序签署，2、顺序签署时B静默签署，3、顺序签署时B非首位签署）、单C的模版，且模版中发起方没有填写控件。
      */
-  async GetDownloadFlowUrl(
-    req: GetDownloadFlowUrlRequest,
-    cb?: (error: string, rep: GetDownloadFlowUrlResponse) => void
-  ): Promise<GetDownloadFlowUrlResponse> {
-    return this.request("GetDownloadFlowUrl", req, cb)
-  }
+    async ChannelCreateMultiFlowSignQRCode(req: ChannelCreateMultiFlowSignQRCodeRequest, cb?: (error: string, rep: ChannelCreateMultiFlowSignQRCodeResponse) => void): Promise<ChannelCreateMultiFlowSignQRCodeResponse> {
+        return this.request("ChannelCreateMultiFlowSignQRCode", req, cb);
+    }
 
-  /**
-   * 通过此接口（DescribeTemplates）查询该企业在电子签渠道版中配置的有效模板列表
-   */
-  async DescribeTemplates(
-    req: DescribeTemplatesRequest,
-    cb?: (error: string, rep: DescribeTemplatesResponse) => void
-  ): Promise<DescribeTemplatesResponse> {
-    return this.request("DescribeTemplates", req, cb)
-  }
+    /**
+     * 接口（ChannelCreateFlowByFiles）用于渠道版通过文件创建签署流程。此接口不可直接使用，需要运营申请
+     */
+    async ChannelCreateFlowByFiles(req: ChannelCreateFlowByFilesRequest, cb?: (error: string, rep: ChannelCreateFlowByFilesResponse) => void): Promise<ChannelCreateFlowByFilesResponse> {
+        return this.request("ChannelCreateFlowByFiles", req, cb);
+    }
 
-  /**
-     * 此接口（OperateChannelTemplate）用于渠道侧将模板库中的模板对合作企业进行查询和设置, 其中包括可见性的修改以及对合作企业的设置.
-1、同步标识=select时：
-返回渠道侧模板库当前模板的属性.
-2、同步标识=update或者delete时：
-对渠道子客进行模板库中模板授权,修改操作
+    /**
+     * 渠道通过图片为子客代创建印章，图片最大5m；此接口不可直接使用，需要运营申请
      */
-  async OperateChannelTemplate(
-    req: OperateChannelTemplateRequest,
-    cb?: (error: string, rep: OperateChannelTemplateResponse) => void
-  ): Promise<OperateChannelTemplateResponse> {
-    return this.request("OperateChannelTemplate", req, cb)
-  }
+    async CreateSealByImage(req: CreateSealByImageRequest, cb?: (error: string, rep: CreateSealByImageResponse) => void): Promise<CreateSealByImageResponse> {
+        return this.request("CreateSealByImage", req, cb);
+    }
 
-  /**
-     * 此接口（ChannelCreateMultiFlowSignQRCode）用于创建一码多扫签署流程二维码。
-适用的模版仅限于B2C（1、无序签署，2、顺序签署时B静默签署，3、顺序签署时B非首位签署）、单C的模版，且模版中发起方没有填写控件。
+    /**
+     * 此接口（ChannelCancelMultiFlowSignQRCode）用于取消一码多扫二维码。该接口对传入的二维码ID，若还在有效期内，可以提前失效。
      */
-  async ChannelCreateMultiFlowSignQRCode(
-    req: ChannelCreateMultiFlowSignQRCodeRequest,
-    cb?: (error: string, rep: ChannelCreateMultiFlowSignQRCodeResponse) => void
-  ): Promise<ChannelCreateMultiFlowSignQRCodeResponse> {
-    return this.request("ChannelCreateMultiFlowSignQRCode", req, cb)
-  }
+    async ChannelCancelMultiFlowSignQRCode(req: ChannelCancelMultiFlowSignQRCodeRequest, cb?: (error: string, rep: ChannelCancelMultiFlowSignQRCodeResponse) => void): Promise<ChannelCancelMultiFlowSignQRCodeResponse> {
+        return this.request("ChannelCancelMultiFlowSignQRCode", req, cb);
+    }
 
-  /**
-   * 接口（ChannelCreateFlowByFiles）用于渠道版通过文件创建签署流程。此接口不可直接使用，需要运营申请
-   */
-  async ChannelCreateFlowByFiles(
-    req: ChannelCreateFlowByFilesRequest,
-    cb?: (error: string, rep: ChannelCreateFlowByFilesResponse) => void
-  ): Promise<ChannelCreateFlowByFilesResponse> {
-    return this.request("ChannelCreateFlowByFiles", req, cb)
-  }
+    /**
+     * 渠道创建文件转换任务
+     */
+    async ChannelCreateConvertTaskApi(req: ChannelCreateConvertTaskApiRequest, cb?: (error: string, rep: ChannelCreateConvertTaskApiResponse) => void): Promise<ChannelCreateConvertTaskApiResponse> {
+        return this.request("ChannelCreateConvertTaskApi", req, cb);
+    }
 
-  /**
-     * 该接口 (PrepareFlows) 用于创建待发起文件
-用户通过该接口进入签署流程发起的确认页面，进行发起信息二次确认， 如果确认则进行正常发起。
-目前该接口只支持B2C，不建议使用。
+    /**
+     * 此接口（DescribeUsage）用于获取渠道所有合作企业流量消耗情况。
+ 注: 此接口每日限频2次，若要扩大限制次数,请提前与客服经理或邮件至e-contract@tencent.com进行联系。
      */
-  async PrepareFlows(
-    req: PrepareFlowsRequest,
-    cb?: (error: string, rep: PrepareFlowsResponse) => void
-  ): Promise<PrepareFlowsResponse> {
-    return this.request("PrepareFlows", req, cb)
-  }
+    async DescribeUsage(req: DescribeUsageRequest, cb?: (error: string, rep: DescribeUsageResponse) => void): Promise<DescribeUsageResponse> {
+        return this.request("DescribeUsage", req, cb);
+    }
 
-  /**
-   * 创建跳转小程序查看或签署的链接；自动签署的签署方不创建签署链接；
-   */
-  async CreateSignUrls(
-    req: CreateSignUrlsRequest,
-    cb?: (error: string, rep: CreateSignUrlsResponse) => void
-  ): Promise<CreateSignUrlsResponse> {
-    return this.request("CreateSignUrls", req, cb)
-  }
+    /**
+     * 接口（CreateFlowsByTemplates）用于使用多个模板批量创建签署流程。当前可批量发起合同（签署流程）数量最大为20个。
 
-  /**
-   * 渠道通过图片为子客代创建印章，图片最大5m；此接口不可直接使用，需要运营申请
-   */
-  async CreateSealByImage(
-    req: CreateSealByImageRequest,
-    cb?: (error: string, rep: CreateSealByImageResponse) => void
-  ): Promise<CreateSealByImageResponse> {
-    return this.request("CreateSealByImage", req, cb)
-  }
+     */
+    async CreateFlowsByTemplates(req: CreateFlowsByTemplatesRequest, cb?: (error: string, rep: CreateFlowsByTemplatesResponse) => void): Promise<CreateFlowsByTemplatesResponse> {
+        return this.request("CreateFlowsByTemplates", req, cb);
+    }
 
-  /**
-   * 此接口（ChannelCancelMultiFlowSignQRCode）用于取消一码多扫二维码。该接口对传入的二维码ID，若还在有效期内，可以提前失效。
-   */
-  async ChannelCancelMultiFlowSignQRCode(
-    req: ChannelCancelMultiFlowSignQRCodeRequest,
-    cb?: (error: string, rep: ChannelCancelMultiFlowSignQRCodeResponse) => void
-  ): Promise<ChannelCancelMultiFlowSignQRCodeResponse> {
-    return this.request("ChannelCancelMultiFlowSignQRCode", req, cb)
-  }
+    /**
+     * 创建跳转小程序查看或签署的链接；自动签署的签署方不创建签署链接；
+     */
+    async CreateSignUrls(req: CreateSignUrlsRequest, cb?: (error: string, rep: CreateSignUrlsResponse) => void): Promise<CreateSignUrlsResponse> {
+        return this.request("CreateSignUrls", req, cb);
+    }
 
-  /**
+    /**
      * 此接口（CreateConsoleLoginUrl）用于创建电子签控制台登录链接。若企业未激活，调用同步企业信息、同步经办人信息
 
      */
-  async CreateConsoleLoginUrl(
-    req: CreateConsoleLoginUrlRequest,
-    cb?: (error: string, rep: CreateConsoleLoginUrlResponse) => void
-  ): Promise<CreateConsoleLoginUrlResponse> {
-    return this.request("CreateConsoleLoginUrl", req, cb)
-  }
+    async CreateConsoleLoginUrl(req: CreateConsoleLoginUrlRequest, cb?: (error: string, rep: CreateConsoleLoginUrlResponse) => void): Promise<CreateConsoleLoginUrlResponse> {
+        return this.request("CreateConsoleLoginUrl", req, cb);
+    }
 
-  /**
-   * 此接口（SyncProxyOrganizationOperators）用于同步渠道合作企业经办人列表
-   */
-  async SyncProxyOrganizationOperators(
-    req: SyncProxyOrganizationOperatorsRequest,
-    cb?: (error: string, rep: SyncProxyOrganizationOperatorsResponse) => void
-  ): Promise<SyncProxyOrganizationOperatorsResponse> {
-    return this.request("SyncProxyOrganizationOperators", req, cb)
-  }
+    /**
+     * 指定需要批量撤销的签署流程Id，获取批量撤销链接
+客户指定需要撤销的签署流程Id，最多100个，超过100不处理；接口调用成功返回批量撤销合同的链接，通过链接跳转到电子签小程序完成批量撤销
+     */
+    async ChannelCreateBatchCancelFlowUrl(req: ChannelCreateBatchCancelFlowUrlRequest, cb?: (error: string, rep: ChannelCreateBatchCancelFlowUrlResponse) => void): Promise<ChannelCreateBatchCancelFlowUrlResponse> {
+        return this.request("ChannelCreateBatchCancelFlowUrl", req, cb);
+    }
 
-  /**
-     * 此接口（DescribeUsage）用于获取渠道所有合作企业流量消耗情况。
- 注: 此接口每日限频2次，若要扩大限制次数,请提前与客服经理或邮件至e-contract@tencent.com进行联系。
+    /**
+     * 渠道版查询转换任务状态
      */
-  async DescribeUsage(
-    req: DescribeUsageRequest,
-    cb?: (error: string, rep: DescribeUsageResponse) => void
-  ): Promise<DescribeUsageResponse> {
-    return this.request("DescribeUsage", req, cb)
-  }
+    async ChannelGetTaskResultApi(req: ChannelGetTaskResultApiRequest, cb?: (error: string, rep: ChannelGetTaskResultApiResponse) => void): Promise<ChannelGetTaskResultApiResponse> {
+        return this.request("ChannelGetTaskResultApi", req, cb);
+    }
 
-  /**
-   * 此接口（DescribeFlowDetailInfo）用于查询合同(签署流程)的详细信息。
-   */
-  async DescribeFlowDetailInfo(
-    req: DescribeFlowDetailInfoRequest,
-    cb?: (error: string, rep: DescribeFlowDetailInfoResponse) => void
-  ): Promise<DescribeFlowDetailInfoResponse> {
-    return this.request("DescribeFlowDetailInfo", req, cb)
-  }
+    /**
+     * 此接口（SyncProxyOrganization）用于同步渠道侧企业信息
+     */
+    async SyncProxyOrganization(req: SyncProxyOrganizationRequest, cb?: (error: string, rep: SyncProxyOrganizationResponse) => void): Promise<SyncProxyOrganizationResponse> {
+        return this.request("SyncProxyOrganization", req, cb);
+    }
 
-  /**
-   * 此接口（SyncProxyOrganization）用于同步渠道侧企业信息
-   */
-  async SyncProxyOrganization(
-    req: SyncProxyOrganizationRequest,
-    cb?: (error: string, rep: SyncProxyOrganizationResponse) => void
-  ): Promise<SyncProxyOrganizationResponse> {
-    return this.request("SyncProxyOrganization", req, cb)
-  }
+    /**
+     * 此接口（GetDownloadFlowUrl）用于创建电子签批量下载地址，让合作企业进入控制台直接下载，支持客户合同（流程）按照自定义文件夹形式 分类下载。
+当前接口限制最多合同（流程）50个.
+
+     */
+    async GetDownloadFlowUrl(req: GetDownloadFlowUrlRequest, cb?: (error: string, rep: GetDownloadFlowUrlResponse) => void): Promise<GetDownloadFlowUrlResponse> {
+        return this.request("GetDownloadFlowUrl", req, cb);
+    }
 
-  /**
-   * 根据签署流程信息批量获取资源下载链接，需合作企业先进行授权
-   */
-  async DescribeResourceUrlsByFlows(
-    req: DescribeResourceUrlsByFlowsRequest,
-    cb?: (error: string, rep: DescribeResourceUrlsByFlowsResponse) => void
-  ): Promise<DescribeResourceUrlsByFlowsResponse> {
-    return this.request("DescribeResourceUrlsByFlows", req, cb)
-  }
+    /**
+     * 该接口 (PrepareFlows) 用于创建待发起文件
+用户通过该接口进入签署流程发起的确认页面，进行发起信息二次确认， 如果确认则进行正常发起。
+目前该接口只支持B2C，不建议使用。
+     */
+    async PrepareFlows(req: PrepareFlowsRequest, cb?: (error: string, rep: PrepareFlowsResponse) => void): Promise<PrepareFlowsResponse> {
+        return this.request("PrepareFlows", req, cb);
+    }
 
-  /**
+    /**
+     * 根据签署流程信息批量获取资源下载链接，需合作企业先进行授权
+     */
+    async DescribeResourceUrlsByFlows(req: DescribeResourceUrlsByFlowsRequest, cb?: (error: string, rep: DescribeResourceUrlsByFlowsResponse) => void): Promise<DescribeResourceUrlsByFlowsResponse> {
+        return this.request("DescribeResourceUrlsByFlows", req, cb);
+    }
+
+    /**
+     * 通过此接口（DescribeTemplates）查询该企业在电子签渠道版中配置的有效模板列表
+     */
+    async DescribeTemplates(req: DescribeTemplatesRequest, cb?: (error: string, rep: DescribeTemplatesResponse) => void): Promise<DescribeTemplatesResponse> {
+        return this.request("DescribeTemplates", req, cb);
+    }
+
+    /**
      * 此接口（UploadFiles）用于文件上传。
 调用时需要设置Domain 为 file.ess.tencent.cn
      */
-  async UploadFiles(
-    req: UploadFilesRequest,
-    cb?: (error: string, rep: UploadFilesResponse) => void
-  ): Promise<UploadFilesResponse> {
-    return this.request("UploadFiles", req, cb)
-  }
+    async UploadFiles(req: UploadFilesRequest, cb?: (error: string, rep: UploadFilesResponse) => void): Promise<UploadFilesResponse> {
+        return this.request("UploadFiles", req, cb);
+    }
+
+    /**
+     * 创建出证报告，返回报告 URL
+     */
+    async CreateChannelFlowEvidenceReport(req: CreateChannelFlowEvidenceReportRequest, cb?: (error: string, rep: CreateChannelFlowEvidenceReportResponse) => void): Promise<CreateChannelFlowEvidenceReportResponse> {
+        return this.request("CreateChannelFlowEvidenceReport", req, cb);
+    }
+
+    /**
+     * 此接口（OperateChannelTemplate）用于渠道侧将模板库中的模板对合作企业进行查询和设置, 其中包括可见性的修改以及对合作企业的设置.
+1、同步标识=select时：
+返回渠道侧模板库当前模板的属性.
+2、同步标识=update或者delete时：
+对渠道子客进行模板库中模板授权,修改操作
+     */
+    async OperateChannelTemplate(req: OperateChannelTemplateRequest, cb?: (error: string, rep: OperateChannelTemplateResponse) => void): Promise<OperateChannelTemplateResponse> {
+        return this.request("OperateChannelTemplate", req, cb);
+    }
+
+    /**
+     * 此接口（SyncProxyOrganizationOperators）用于同步渠道合作企业经办人列表
+     */
+    async SyncProxyOrganizationOperators(req: SyncProxyOrganizationOperatorsRequest, cb?: (error: string, rep: SyncProxyOrganizationOperatorsResponse) => void): Promise<SyncProxyOrganizationOperatorsResponse> {
+        return this.request("SyncProxyOrganizationOperators", req, cb);
+    }
+
+    /**
+     * 此接口（DescribeFlowDetailInfo）用于查询合同(签署流程)的详细信息。
+     */
+    async DescribeFlowDetailInfo(req: DescribeFlowDetailInfoRequest, cb?: (error: string, rep: DescribeFlowDetailInfoResponse) => void): Promise<DescribeFlowDetailInfoResponse> {
+        return this.request("DescribeFlowDetailInfo", req, cb);
+    }
+
+
 }