tencentcloud-sdk-nodejs-essbasic 4.0.720 → 4.0.721

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

@@ -351,7 +351,7 @@ export interface ChannelDeleteSealPoliciesRequest {
  */
 export interface ChannelBatchCancelFlowsResponse {
     /**
-     * 签署流程批量撤销失败原因，错误信息与流程Id一一对应，成功为“”,失败则对应失败消息
+     * 签署流程批量撤销失败原因，错误信息与流程Id一一对应，成功为"", 失败则对应失败原因
      */
     FailMessages?: Array<string>;
     /**
@@ -1899,26 +1899,26 @@ export interface ChannelRole {
     PermissionGroups?: Array<PermissionGroup>;
 }
 /**
- * 流程中参与方的信息结构
+ * 流程中签署方和填写方(如果有填写控件存证时)的信息
  */
 export interface Recipient {
     /**
-     * 签署人唯一标识，在通过模板发起合同的时候对应签署方ID
+     * 合同参与方的角色ID
      */
     RecipientId?: string;
     /**
-     * 参与者类型，默认为空。
-  ENTERPRISE-企业；
-  INDIVIDUAL-个人；
-  PROMOTER-发起方
+     * 参与者类型, 可以选择的类型如下:
+  <ul><li> **ENTERPRISE** :此角色为企业参与方</li>
+  <li> **INDIVIDUAL** :此角色为个人参与方</li>
+  <li> **PROMOTER** :此角色是发起方</li></ul>
      */
     RecipientType?: string;
     /**
-     * 描述信息
+     * 合同参与方的角色描述，长度不能超过100，只能由中文、字母、数字和下划线组成。
      */
     Description?: string;
     /**
-     * 角色名称
+     * 合同参与方的角色名字，长度不能超过20，只能由中文、字母、数字和下划线组成。
      */
     RoleName?: string;
     /**
@@ -2709,36 +2709,43 @@ export interface UserThreeFactor {
  */
 export interface ChannelCreateUserAutoSignEnableUrlRequest {
     /**
-     * 渠道应用相关信息
+     * 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
      */
     Agent: Agent;
     /**
-     * 自动签场景:
-  E_PRESCRIPTION_AUTO_SIGN 电子处方
+     * 自动签使用的场景值, 可以选择的场景值如下:
+  <ul><li> **E_PRESCRIPTION_AUTO_SIGN** :  电子处方场景</li></ul>
+  
+  注: `现在仅支持电子处方场景`
      */
     SceneKey: string;
     /**
-     * 操作人信息
+     * 执行本接口操作的员工信息。
+  注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
      */
     Operator?: UserInfo;
     /**
-     * 自动签开通，签署相关配置
+     * 自动签开通配置信息, 包括开通的人员的信息等
      */
     AutoSignConfig?: AutoSignConfig;
     /**
-     * 链接类型，空-默认小程序端链接，H5SIGN-h5端链接
+     * 生成的链接类型：
+  <ul><li> 不传(即为空值) 则会生成小程序端开通链接(默认)</li>
+  <li> **H5SIGN** : 生成H5端开通链接</li></ul>
      */
     UrlType?: string;
     /**
-     * 通知类型，默认不填为不通知开通方，填写 SMS 为短信通知。
+     * 是否通知开通方，通知类型:
+  <ul><li>默认不设置为不通知开通方</li>
+  <li>**SMS** :  短信通知 ,如果需要短信通知则NotifyAddress填写对方的手机号</li><ul>
      */
     NotifyType?: string;
     /**
-     * 若上方填写为 SMS，则此处为手机号
+     * 如果通知类型NotifyType选择为SMS，则此处为手机号, 其他通知类型不需要设置此项
      */
     NotifyAddress?: string;
     /**
-     * 链接的过期时间，格式为Unix时间戳，不能早于当前时间，且最大为30天。如果不传，默认有效期为7天。
+     * 链接的过期时间，格式为Unix时间戳，不能早于当前时间，且最大为当前时间往后30天。`如果不传，默认过期时间为当前时间往后7天。`
      */
     ExpiredTime?: number;
 }
@@ -3989,27 +3996,37 @@ export interface FlowApproverInfo {
  */
 export interface ChannelCreateUserAutoSignEnableUrlResponse {
     /**
-     * 跳转短链
+     * 个人用户自动签的开通链接, 短链形式。过期时间受 `ExpiredTime` 参数控制。
      */
     Url?: string;
     /**
-     * 小程序AppId
+     * 腾讯电子签小程序的 AppID，用于其他小程序/APP等应用跳转至腾讯电子签小程序使用
+  
+  注: `如果获取的是H5链接, 则不会返回此值`
      */
     AppId?: string;
     /**
-     * 小程序 原始 Id
+     * 腾讯电子签小程序的原始 Id,  ，用于其他小程序/APP等应用跳转至腾讯电子签小程序使用
+  
+  注: `如果获取的是H5链接, 则不会返回此值`
      */
     AppOriginalId?: string;
     /**
-     * 跳转路径
+     * 腾讯电子签小程序的跳转路径，用于其他小程序/APP等应用跳转至腾讯电子签小程序使用
+  
+  注: `如果获取的是H5链接, 则不会返回此值`
      */
     Path?: string;
     /**
-     * base64格式跳转二维码
+     * base64 格式的跳转二维码图片，可通过微信扫描后跳转到腾讯电子签小程序的开通界面。
+  
+  注: `如果获取的是H5链接, 则不会返回此二维码图片`
      */
     QrCode?: string;
     /**
-     * 链接类型，空-默认小程序端链接，H5SIGN-h5端链接
+     * 返回的链接类型
+  <ul><li> 空: 默认小程序端链接</li>
+  <li> **H5SIGN** : h5端链接</li></ul>
      */
     UrlType?: string;
     /**
@@ -4482,11 +4499,19 @@ export interface ChannelCreateBatchQuickSignUrlResponse {
  */
 export interface ChannelCreateBatchCancelFlowUrlRequest {
     /**
-     * 应用相关信息。 此接口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数组
+     * 要撤销的合同流程ID列表，最多100个，超过100不处理
      */
     FlowIds: Array<string>;
     /**
@@ -4672,23 +4697,39 @@ export interface ChannelDescribeRolesResponse {
  */
 export interface ChannelCreateReleaseFlowRequest {
     /**
-     * 应用相关信息。 此接口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;
     /**
-     * 待解除的流程编号（即原流程的编号）
+     * 待解除的签署流程编号(即原签署流程的编号)。
      */
     NeedRelievedFlowId: string;
     /**
-     * 解除协议内容
+     * 解除协议内容, 包括解除理由等信息。
      */
     ReliveInfo: RelieveInfo;
     /**
-     * 非必须，解除协议的本企业签署人列表，默认使用原流程的签署人列表；当解除协议的签署人与原流程的签署人不能相同时（例如原流程签署人离职了），需要指定本企业的其他签署人来替换原流程中的原签署人，注意需要指明ApproverNumber来代表需要替换哪一个签署人，已转发的签署人不包含在内，解除协议的签署人数量不能多于原流程的签署人数量
+     * 替换解除协议的签署人， 如不指定替换签署人,  则使用原流程的签署人。 <br/>
+  如需更换原合同中的企业端签署人，可通过指定该签署人的RecipientId编号更换此企业端签署人。(可通过接口<a href="https://qian.tencent.com/developers/companyApis/queryFlows/DescribeFlowInfo/">DescribeFlowInfo</a>查询签署人的RecipientId编号)<br/>
+  
+  注意：
+  <ul>
+  <li>只能更换自己企业的签署人, 不支持更换个人类型或者其他企业的签署人</li>
+  <li>可以不指定替换签署人, 使用原流程的签署人</li>
+  </ul>
      */
     ReleasedApprovers?: Array<ReleasedApprover>;
     /**
      * 签署完回调url，最大长度1000个字符
+     * @deprecated
      */
     CallbackUrl?: string;
     /**
@@ -4702,9 +4743,18 @@ export interface ChannelCreateReleaseFlowRequest {
      */
     Operator?: UserInfo;
     /**
-     * 签署流程的签署截止时间。 值为unix时间戳,精确到秒,不传默认为当前时间七天后
+     * 合同流程的签署截止时间，格式为Unix标准时间戳(秒)，如果未设置签署截止时间，则默认为合同流程创建后的7天时截止。
+  如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。
      */
     Deadline?: number;
+    /**
+     * 调用方自定义的个性化字段，该字段的值可以是字符串JSON或其他字符串形式，客户可以根据自身需求自定义数据格式并在需要时进行解析。该字段的信息将以Base64编码的形式传输，支持的最大数据大小为20480长度。
+  
+  在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。
+  
+  回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
+     */
+    UserData?: string;
 }
 /**
  * ChannelDescribeFlowComponents返回参数结构体
@@ -5103,31 +5153,40 @@ export interface ChannelCreateEmbedWebUrlResponse {
  */
 export interface ChannelBatchCancelFlowsRequest {
     /**
-     * 应用相关信息。 此接口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数组，最多100个，超过100不处理
+     * 要撤销的合同流程ID列表，最多100个，超过100不处理
      */
     FlowIds: Array<string>;
     /**
-     * 撤销理由,不超过200个字符
+     * 撤回原因，长度不能超过200，只能由中文、字母、数字和下划线组成。
+  
+  备注:`如果不传递撤回原因，那么默认撤回原因是 "自动撤销（通过接口实现）"`
      */
     CancelMessage?: string;
     /**
-     * 撤销理由自定义格式，支持以下格式
-  <ul><li>0 : 默认值</li>
-  <li>1 : 只保留身份信息</li>
-  <li>2 : 保留身份信息+企业名称</li>
-  <li>3 : 保留身份信息+企业名称+经办人名称</li></ul>
-  例如,假设合同的发起方是典子谦示例企业的经办人张三，撤销理由是"合同内容错误，需要修正",合同撤销后，各签署方看到的撤销理由是会是
+     * 撤销理由自定义格式,  会展示在合同预览的界面中,  可以选择下面的组合方式：
+  
+  **0** : 默认格式,  合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以**CancelMessage**的理由撤销当前合同
+  **1** :  合同封面页面会展示为:  发起方以**CancelMessage**的理由撤销当前合同
+  **2** : 保留企业名称,  合同封面页面会展示为:  发起方-企业名称以**CancelMessage**的理由撤销当前合同
+  **3** : 保留企业名称+经办人名字,  合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以**CancelMessage**的理由撤销当前合同
+  
+  注: `CancelMessage为撤销当前合同的理由`
+  
+  ![image](https://dyn.ess.tencent.cn/guide/capi/channel_ChannelCancelFlow.png)
   
-  0: 发起方-典子谦示例企业-张三以"合同内容错误，需要修正"的理由撤销当前合同
-  1: 发起方以"合同内容错误，需要修正"的理由撤销当前合同
-  2: 发起方-典子谦示例企业以"合同内容错误，需要修正"的理由撤销当前合同
-  3: 发起方-典子谦示例企业-张三以"合同内容错误，需要修正"的理由撤销当前合同</br>
   
-  备注:`如果不传递撤销理由，那么默认撤销理由是 "自动撤销（通过接口实现）"`
      */
     CancelMessageFormat?: number;
     /**
@@ -5312,25 +5371,24 @@ export interface DescribeTemplatesRequest {
     Agent: Agent;
     /**
      * 合同模板ID，为32位字符串。
-  建议开发者保存此模板ID，后续用此模板发起合同流程需要此参数。
+  
+  可以通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>登录企业控制台, 在企业模板中得到合同模板ID。
      */
     TemplateId?: string;
     /**
-     * 查询内容控制
+     * 查询模版的内容
   
-  <ul><li>**0**：模板列表及详情（默认）</li>
-  <li>**1**：仅模板列表</li></ul>
+  <ul><li>**0**：（默认）模板列表及详情</li>
+  <li>**1**：仅模板列表, 不会返回模板中的签署控件, 填写控件, 参与方角色列表等信息</li></ul>
      */
     ContentType?: number;
     /**
-     * 合同模板ID数组，每一个合同模板ID为32位字符串。
-  建议开发者保存此模板ID，后续用此模板发起合同流程需要此参数。
+     * 合同模板ID数组，每一个合同模板ID为32位字符串,  最多支持200个模板的批量查询。
   
-  ```注意:
-  1. 此参数TemplateIds与TemplateId互为独立，若两者均传入，以TemplateId为准。
-  2. 请确保每个模板均正确且属于当前企业，若有任一模板不存在，则返回错误。
-  3. 最多支持200个模板。
-  4. 若传递此参数，分页参数(Limit,Offset)无效```
+  注意:
+  1.` 此参数TemplateIds与TemplateId互为独立，若两者均传入，以TemplateId为准。`
+  2. `请确保每个模板均正确且属于当前企业，若有任一模板不存在，则返回错误。`
+  4. `若传递此参数，分页参数(Limit,Offset)无效`
   
      */
     TemplateIds?: Array<string>;
@@ -5348,7 +5406,7 @@ export interface DescribeTemplatesRequest {
      */
     Offset?: number;
     /**
-     * 模糊搜索的模板名称，注意是模板名的连续部分，最大长度200
+     * 模糊搜索的模板名称，注意是模板名的连续部分，长度不能超过200，可支持由中文、字母、数字和下划线组成字符串。
      */
     TemplateName?: string;
     /**
@@ -5356,10 +5414,10 @@ export interface DescribeTemplatesRequest {
      */
     ChannelTemplateId?: string;
     /**
-     * 是否返回所有控件信息。
+     * 返回控件的范围, 是只返回发起方自己的还是所有参与方的
   
-  <ul><li>**false**：只返回发起方控件（默认）</li>
-  <li>**true**：返回所有签署方控件</li></ul>
+  <ul><li>**false**：（默认）只返回发起方控件</li>
+  <li>**true**：返回所有参与方(包括发起方和签署方)控件</li></ul>
      */
     QueryAllComponents?: boolean;
     /**
@@ -5368,9 +5426,9 @@ export interface DescribeTemplatesRequest {
   <ul><li>**false**：不获取（默认）</li>
   <li>**true**：获取</li></ul>
   
-  设置为true之后， 返回参数PreviewUrl，为模板的H5预览链接,有效期5分钟。
-  可以通过浏览器打开此链接预览模板，或者嵌入到iframe中预览模板。
-  （此功能开放需要联系客户经理）
+  设置为true之后， 返回参数PreviewUrl，为模板的H5预览链接,  有效期5分钟。可以通过浏览器打开此链接预览模板，或者嵌入到iframe中预览模板。
+  
+  注: `此功能为白名单功能，使用前请联系对接的客户经理沟通。`
      */
     WithPreviewUrl?: boolean;
     /**
@@ -5379,8 +5437,9 @@ export interface DescribeTemplatesRequest {
   <ul><li>**false**：不获取（默认）</li>
   <li>**true**：获取</li></ul>
   
-  设置为true之后， 返回参数PdfUrl，为模板PDF文件链接，有效期5分钟。
-  （此功能开放需要联系客户经理）
+  设置为true之后， 返回参数PdfUrl，为模板PDF文件链接，有效期5分钟, 可以用于将PDF文件下载到本地
+  
+  注: `此功能为白名单功能，使用前请联系对接的客户经理沟通。`
      */
     WithPdfUrl?: boolean;
     /**
@@ -5642,15 +5701,17 @@ export interface UsageDetail {
  */
 export interface ChannelCreateBatchCancelFlowUrlResponse {
     /**
-     * 批量撤销url
+     * 批量撤销合同的URL链接, 需要在手机端打开, 有效期24小时
      */
     BatchCancelFlowUrl?: string;
     /**
-     * 签署流程批量撤销失败原因
+     * 与入参的FlowIds数组一致,   成功生成到撤销链接中,则为"",   不能撤销合同则为失败原因
      */
     FailMessages?: Array<string>;
     /**
-     * 签署撤销url过期时间-年月日-时分秒
+     * 签署撤销链接的过期时间(格式为:年-月-日 时:分:秒), 默认是生成链接的24小时后失效
+  
+  
      */
     UrlExpireOn?: string;
     /**