tencentcloud-sdk-nodejs-essbasic 4.0.722 → 4.0.723

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

@@ -352,6 +352,8 @@ export interface ChannelDeleteSealPoliciesRequest {
 export interface ChannelBatchCancelFlowsResponse {
     /**
      * 签署流程批量撤销失败原因，错误信息与流程Id一一对应，成功为"", 失败则对应失败原因
+  
+  注:  `如果全部撤销成功, 此数组为空数组`
      */
     FailMessages?: Array<string>;
     /**
@@ -835,7 +837,7 @@ export interface ChannelCreateRoleRequest {
      */
     Description?: string;
     /**
-     * 权限树，权限树内容 PermissionGroups 可参考接口 DescribeIntegrationRoles 的输出
+     * 权限树，权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles 的输出
      */
     PermissionGroups?: Array<PermissionGroup>;
 }
@@ -933,7 +935,7 @@ export interface ReleasedApprover {
      * 签署方经办人的证件类型，支持以下类型
   <ul><li>ID_CARD : 居民身份证  (默认值)</li>
   <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
-  <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li>
+  <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>
      */
     IdCardType?: string;
     /**
@@ -1192,27 +1194,34 @@ export interface DownloadFlowInfo {
     FlowIdList: Array<string>;
 }
 /**
- * 签署人签署链接信息
+ * 签署人签署链接信息。
  */
 export interface FlowApproverUrlInfo {
     /**
-     * 签署短链接，不支持小程序嵌入，只支持移动端浏览器打开。注意该链接有效期为30分钟，同时需要注意保密，不要外泄给无关用户。
+     * 签署短链接。</br>
+  注意:
+  - 该链接有效期为**30分钟**，同时需要注意保密，不要外泄给无关用户。
+  - 该链接不支持小程序嵌入，仅支持**移动端浏览器**打开。
      */
-    SignUrl: string;
+    SignUrl?: string;
     /**
-     * 签署人类型 PERSON-个人
+     * 签署人类型。
+  - **PERSON**: 个人
      */
-    ApproverType: string;
+    ApproverType?: string;
     /**
-     * 签署人姓名
+     * 签署人姓名。
      */
-    Name: string;
+    Name?: string;
     /**
-     * 签署人手机号
+     * 签署人手机号。
      */
-    Mobile: string;
+    Mobile?: string;
     /**
-     * 签署长链接，支持小程序嵌入。注意该链接有效期为30分钟，同时需要注意保密，不要外泄给无关用户。
+     * 签署长链接。</br>
+  注意:
+  - 该链接有效期为**30分钟**，同时需要注意保密，不要外泄给无关用户。
+  - 该链接不支持小程序嵌入，仅支持**移动端浏览器**打开。
   注意：此字段可能返回 null，表示取不到有效值。
      */
     LongUrl?: string;
@@ -2062,12 +2071,18 @@ export interface StaffRole {
 export interface ChannelVerifyPdfRequest {
     /**
      * 合同流程ID，为32位字符串。
-  可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
      */
     FlowId: string;
     /**
-     * 代理企业和员工的信息。
-  在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
+     * 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
+  
+  此接口下面信息必填。
+  <ul>
+  <li>渠道应用标识:  Agent.AppId</li>
+  <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
+  <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
+  </ul>
+  第三方平台子客企业和员工必须已经经过实名认证
      */
     Agent?: Agent;
     /**
@@ -2081,14 +2096,15 @@ export interface ChannelVerifyPdfRequest {
  */
 export interface CreateChannelFlowEvidenceReportRequest {
     /**
-     * 员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
+     * 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
   
   此接口下面信息必填。
   <ul>
-  <li>渠道应用标识:  Agent.ProxyOrganizationOpenId</li>
-  <li>第三方平台子客企业标识: Agent. ProxyOperator.OpenId</li>
-  <li>第三方平台子客企业中的员工标识: Agent.AppId</li>
+  <li>渠道应用标识:  Agent.AppId</li>
+  <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
+  <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
   </ul>
+  第三方平台子客企业和员工必须已经经过实名认证
      */
     Agent: Agent;
     /**
@@ -2274,17 +2290,12 @@ export interface ChannelVerifyPdfResponse {
   <ul><li>**1**：文件未被篡改，全部签名在腾讯电子签完成。</li>
   <li>**2**：文件未被篡改，部分签名在腾讯电子签完成。</li>
   <li>**3**：文件被篡改。</li>
-  <li>**4**：异常：文件内没有签名域。</li>
+  <li>**4**：异常：文件内没有签名域。(如果合同还没有签署也会返回此代码)</li>
   <li>**5**：异常：文件签名格式错误。</li></ul>
      */
     VerifyResult?: number;
     /**
-     * 验签结果详情，每个签名域对应的验签结果。状态值如下
-  <ul><li> **1** :验签成功，在电子签签署</li>
-  <li> **2** :验签成功，在其他平台签署</li>
-  <li> **3** :验签失败</li>
-  <li> **4** :pdf文件没有签名域</li>
-  <li> **5** :文件签名格式错误</li></ul>
+     * 验签结果详情，所有签署区(包括签名区, 印章区, 日期签署区,骑缝章等)的签署验签结果
      */
     PdfVerifyResults?: Array<PdfVerifyResult>;
     /**
@@ -2640,65 +2651,82 @@ export interface ChannelCreateUserAutoSignSealUrlRequest {
     ExpiredTime?: number;
 }
 /**
- * 合同文件验签单个结果结构体
+ * 合同验签每个签署区的信息
  */
 export interface PdfVerifyResult {
     /**
-     * 验签结果。0-签名域未签名；1-验签成功； 3-验签失败；4-未找到签名域：文件内没有签名域；5-签名值格式不正确。
+     * 验签结果详情，每个签名域对应的验签结果。状态值如下
+  <ul><li> **1** :验签成功，在电子签签署</li>
+  <li> **2** :验签成功，在其他平台签署</li>
+  <li> **3** :验签失败</li>
+  <li> **4** :pdf文件没有签名域</li>
+  <li> **5** :文件签名格式错误</li></ul>
      */
-    VerifyResult: number;
+    VerifyResult?: number;
     /**
-     * 签署平台，如果文件是在腾讯电子签平台签署，则返回腾讯电子签，如果文件不在腾讯电子签平台签署，则返回其他平台。
+     * 签署平台
+  如果文件是在腾讯电子签平台签署，则为**腾讯电子签**，
+  如果文件不在腾讯电子签平台签署，则为**其他平台**。
      */
-    SignPlatform: string;
+    SignPlatform?: string;
     /**
-     * 签署人名称
+     * 申请证书的主体的名字
+  
+  如果是在腾讯电子签平台签署, 则对应的主体的名字个数如下
+  **企业**:  ESS@企业名称@编码
+  **个人**: ESS@个人姓名@证件号@808854
+  
+  如果在其他平台签署的, 主体的名字参考其他平台的说明
      */
-    SignerName: string;
+    SignerName?: string;
     /**
-     * 签署时间戳，单位秒
+     * 签署时间的Unix时间戳，单位毫秒
      */
-    SignTime: number;
+    SignTime?: number;
     /**
-     * 签名算法
+     * 证书签名算法,  如SHA1withRSA等算法
      */
-    SignAlgorithm: string;
+    SignAlgorithm?: string;
     /**
-     * 签名证书序列号
+     * CA供应商下发给用户的证书编号
+  
+  注意：`腾讯电子签接入多家CA供应商以提供容灾能力，不同CA下发的证书编号区别较大，但基本都是由数字和字母组成，长度在200以下`。
      */
-    CertSn: string;
+    CertSn?: string;
     /**
-     * 证书起始时间戳，单位秒
+     * 证书起始时间的Unix时间戳，单位毫秒
      */
-    CertNotBefore: number;
+    CertNotBefore?: number;
     /**
-     * 证书过期时间戳，单位秒
+     * 证书过期时间的时间戳，单位毫秒
      */
-    CertNotAfter: number;
+    CertNotAfter?: number;
     /**
-     * 签名类型
+     * 签名类型, 保留字段, 现在全部为0
+  
+  
      */
-    SignType: number;
+    SignType?: number;
     /**
      * 签名域横坐标，单位px
      */
-    ComponentPosX: number;
+    ComponentPosX?: number;
     /**
      * 签名域纵坐标，单位px
      */
-    ComponentPosY: number;
+    ComponentPosY?: number;
     /**
      * 签名域宽度，单位px
      */
-    ComponentWidth: number;
+    ComponentWidth?: number;
     /**
      * 签名域高度，单位px
      */
-    ComponentHeight: number;
+    ComponentHeight?: number;
     /**
      * 签名域所在页码，1～N
      */
-    ComponentPage: number;
+    ComponentPage?: number;
 }
 /**
  * 用户的三要素：姓名，证件号，证件类型
@@ -4262,11 +4290,19 @@ export interface CreateFlowsByTemplatesResponse {
  */
 export interface DescribeChannelFlowEvidenceReportRequest {
     /**
-     * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填
+     * 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
+  
+  此接口下面信息必填。
+  <ul>
+  <li>渠道应用标识:  Agent.AppId</li>
+  <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
+  <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
+  </ul>
+  第三方平台子客企业和员工必须已经经过实名认证
      */
     Agent: Agent;
     /**
-     * 出证报告编号
+     * 签署报告编号, 由<a href="https://qian.tencent.com/developers/partnerApis/certificate/CreateChannelFlowEvidenceReport" target="_blank">提交申请出证报告任务</a>产生
      */
     ReportId: string;
     /**
@@ -4891,7 +4927,7 @@ export interface ProxyOrganizationOperator {
      * 签署方经办人的证件类型，支持以下类型
   <ul><li>ID_CARD : 居民身份证  (默认值)</li>
   <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
-  <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li>
+  <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>
   
      */
     IdCardType?: string;
@@ -5271,7 +5307,7 @@ export interface ChannelModifyRoleRequest {
      */
     Description?: string;
     /**
-     * 权限树，权限树内容 PermissionGroups 可参考接口 DescribeIntegrationRoles 的输出
+     * 权限树，权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles的输出
      */
     PermissionGroups?: Array<PermissionGroup>;
 }
@@ -5936,16 +5972,16 @@ export interface ChannelCreateReleaseFlowResponse {
  */
 export interface DescribeChannelFlowEvidenceReportResponse {
     /**
-     * 出证报告下载 URL
+     * 出证报告PDF的下载 URL，有效期为5分钟，超过有效期后将无法再下载。
   注意：此字段可能返回 null，表示取不到有效值。
      */
     ReportUrl?: string;
     /**
-     * 出征任务的执行状态,状态列表如下
+     * 出证任务执行的状态, 状态含义如下：
   
-  - EvidenceStatusExecuting : 出征任务正在执行中
-  - EvidenceStatusSuccess : 出征任务执行成功
-  - EvidenceStatusFailed : 出征任务执行失败
+  <ul><li>**EvidenceStatusExecuting**：  出证任务在执行中</li>
+  <li>**EvidenceStatusSuccess**：  出证任务执行成功</li>
+  <li>**EvidenceStatusFailed** ： 出征任务执行失败</li></ul>
      */
     Status?: string;
     /**
@@ -6072,15 +6108,28 @@ export interface ChannelUpdateSealStatusResponse {
  */
 export interface ChannelCreateFlowSignUrlRequest {
     /**
-     * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填
+     * 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
+  
+  此接口下面信息必填。
+  <ul>
+  <li>渠道应用标识:  Agent.AppId</li>
+  <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
+  <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
+  </ul>
+  第三方平台子客企业和员工必须已经经过实名认证
      */
     Agent: Agent;
     /**
-     * 流程编号
+     * 合同流程ID，为32位字符串。
+  建议开发者妥善保存此流程ID，以便于顺利进行后续操作。
+  可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
      */
     FlowId: string;
     /**
-     * 流程签署人，其中Name和Mobile必传，其他可不传，ApproverType目前只支持PERSON类型的签署人，如果不传默认为该值。还需注意签署人只能有手写签名和时间类型的签署控件，其他类型的填写控件和签署控件暂时都未支持。
+     * 流程签署人列表，其中结构体的Name，Mobile和ApproverType必传，其他可不传。
+  注:
+  `1. ApproverType目前只支持个人(PERSON)类型的签署人。`
+  `2. 签署人只能有手写签名和时间类型的签署控件，其他类型的填写控件和签署控件暂时都未支持。`
      */
     FlowApproverInfos: Array<FlowApproverInfo>;
     /**
@@ -6094,7 +6143,7 @@ export interface ChannelCreateFlowSignUrlRequest {
      */
     Organization?: OrganizationInfo;
     /**
-     * 签署完之后的H5页面的跳转链接，此链接支持http://和https://，最大长度1000个字符。
+     * 签署完之后的H5页面的跳转链接，此链接及支持http://和https://，最大长度1000个字符。(建议https协议)
      */
     JumpUrl?: string;
 }