tencentcloud-sdk-essbasic 3.0.691 → 3.0.692

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5c6ed753c0f6607f428e6e636db8671c21afd27d
-  data.tar.gz: 1d91782b479fd49f21e31ce8410467befb7966fc
+  metadata.gz: b050ac52b1afe4fa59435fc53f5a7e99d2f32b99
+  data.tar.gz: c1ab636d1d630d2c343cff9df501e6ea3fea9f65
 SHA512:
-  metadata.gz: 9088c1718b81faf0ac57e8cd755e890e8ff0f38f839d4ae222b8ed5bfb8f8ed1d338ff40c43484a195f5f5679051547d7a6bf58cd9c044f44f4ad23b5fdce42e
-  data.tar.gz: 1d8119f2f9a6135b1b34259cbd9952e9f0e06a77c48b2189b7959802d764429c363c96fecccdeaca991d939ba495764ca31d5f800a3d772e982a052a85648050
+  metadata.gz: 9955fddbfca773f02cd38d98701d7f5c2d842368e9db7017d5b343a644144cca6023576eb3306fafcb631eb04b30aa812cab076bdcc6e1270b2fbd25f3e6c783
+  data.tar.gz: 1444f8779bf83ee44ed1550703cc87a93b7f446f5a723926f3d6b68f68a9f124684696c933034122bcc6ac14a2febb45b7389c0a711283fd48566c28e1ae1514

data/lib/VERSION

@@ -1 +1 @@
-3.0.691
+3.0.692

data/lib/v20210526/client.rb

@@ -29,22 +29,16 @@ module TencentCloud
         end
 
 
-        # 用于批量撤销合同流程<br/>
-        # 适用场景：
-        # 如果某些合同流程当前至少还有一方没有签署，则可通过该接口取消该合同流程。常用于合同发错、内容填错，需要及时撤销的场景。<br/>
-        # 通过签署流程编号批量撤销合同，单次最多支持撤销100份合同。只有合同的发起人或者发起方企业的超管/法人才能进行合同撤销。需要注意的是，若合同处于以下已终止状态，则不可撤销：<br/>
-        # - 已全部签署完成
-        # - 已拒签
-        # - 已过期
-        # - 已撤回
-        # - 拒绝填写
-        # - 已解除
-
-        # <br/>
-        # 满足撤销条件的合同会发起异步撤销流程，而不满足撤销条件的合同将返回失败原因。合同撤销成功后，会通过合同状态为 CANCEL 的回调消息通知调用方。具体的回调消息内容可参考 <a href="https://qian.tencent.com/developers/partner/callback_types_contracts_sign" target="_blank">合同状态变更回调消息</a>。
-        # <br/><br/>
+        # 通过合同编号批量撤销合同，单次最多支持撤销100份合同。
+
+        # 适用场景：如果某个合同当前**至少还有一方没有签署**，则可通过该接口取消该合同流程。常用于合同发错、内容填错，需要及时撤销的场景。
+
+        # - **可撤回合同状态**：未全部签署完成
+        # - **不撤回合同状态**：已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
+
         # 注:
-        # `如果合同流程中的参与方均已签署完毕，则无法通过该接口撤销合同，`签署完毕的合同需要双方走解除流程将合同作废，可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程</a>接口。
+        # - 有对应合同撤销权限的人:  <font color='red'>**合同的发起人或者发起人所在企业的超管、法人**</font>
+        # - 签署完毕的合同需要双方走解除流程将合同作废，可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程接口</a>
 
         # @param request: Request instance for ChannelBatchCancelFlows.
         # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelBatchCancelFlowsRequest`
@@ -71,11 +65,13 @@ module TencentCloud
         # 撤销签署流程接口
 
         # 适用场景：如果某个合同流程当前至少还有一方没有签署，则可通过该接口取消该合同流程。常用于合同发错、内容填错，需要及时撤销的场景。
-        # <ul><li> `可撤回合同状态` ：未全部签署完成</li>
-        # <li> `不撤回合同状态` ：已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。</li></ul>
+
+        # - **可撤回合同状态**：未全部签署完成
+        # - **不撤回合同状态**：已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
+
         # 注:
-        # <ul><li>能撤回合同的只能是 `合同的发起人或者发起方企业的超管、法人`  </li>
-        # <li>签署完毕的合同需要双方走解除流程将合同作废，可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程接口</a>。</li></ul>
+        # - 有对应合同撤销权限的人:  <font color='red'>**合同的发起人或者发起人所在企业的超管、法人**</font>
+        # - 签署完毕的合同需要双方走解除流程将合同作废，可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程接口</a>
 
         # @param request: Request instance for ChannelCancelFlow.
         # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelCancelFlowRequest`
@@ -149,15 +145,15 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 指定需要批量撤销的签署流程Id，获取批量撤销链接 - 不建议使用此接口，可使用ChannelBatchCancelFlows
-        # 客户指定需要撤销的签署流程Id，最多100个，超过100不处理；
-        # 接口调用成功返回批量撤销合同的链接，通过链接跳转到电子签小程序完成批量撤销;
+        # 通过合同编号生成批量撤销合同的链接，单次最多支持撤销100份合同,   返回的链接需要有此权限的人<font color='red'>**合同的发起人或者发起人所在企业的超管、法人**</font>在<font color='red'>**手机端**</font>打开,  跳转到腾讯电子签小程序输入撤销原因来进行撤销合同
 
-        # 可以撤回：未全部签署完成
-        #  不可以撤回：已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
+        # 适用场景：如果某个合同当前**至少还有一方没有签署**，则可通过该接口取消该合同流程。常用于合同发错、内容填错，需要及时撤销的场景。
 
-        # 注意:
-        # 能撤回合同的只能是合同的发起人或者发起企业的超管、法人
+        # - **可撤回合同状态**：未全部签署完成
+        # - **不撤回合同状态**：已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
+
+        # 注:
+        # - 签署完毕的合同需要双方走解除流程将合同作废，可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程接口</a>
 
         # @param request: Request instance for ChannelCreateBatchCancelFlowUrl.
         # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelCreateBatchCancelFlowUrlRequest`
@@ -828,8 +824,16 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 发起解除协议，主要应用场景为：基于一份已经签署的合同，进行解除操作。
-        # 合同发起人必须在电子签已经进行实名。
+        # 发起解除协议的主要应用场景为：基于一份已经签署的合同(签署流程)，进行解除操作。
+        # 解除协议的模板是官方提供，经过提供法务审核，暂不支持自定义。
+
+        # 注意：
+        # <ul><li><code>原合同必须签署完</code>成后才能发起解除协议。</li>
+        # <li>只有原合同企业类型的参与人才能发起解除协议，<code>个人参与方不能发起解除协议</code>。</li>
+        # <li>原合同个人类型参与人必须是解除协议的参与人，<code>不能更换其他第三方个人</code>参与解除协议。</li>
+        # <li>如果原合同企业参与人无法参与解除协议，可以指定同企业具有同等权限的<code>企业员工代为处理</code>。</li>
+        # <li>发起解除协议同发起其他企业合同一样，也会参与合同<code>扣费</code>，扣费标准同其他类型合同。</li>
+        # <li>在解除协议发起之后，原合同的状态将转变为解除中。一旦解除协议签署完毕，原合同及解除协议均变为已解除状态。</li></ul>
 
         # @param request: Request instance for ChannelCreateReleaseFlow.
         # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelCreateReleaseFlowRequest`
@@ -905,7 +909,9 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 企业方可以通过此接口获取个人用户开启自动签的跳转链接
+        # 获取个人用户自动签的开通链接。
+
+        # 注意: `处方单等特殊场景专用，此接口为白名单功能，使用前请联系对接的客户经理沟通。`
 
         # @param request: Request instance for ChannelCreateUserAutoSignEnableUrl.
         # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelCreateUserAutoSignEnableUrlRequest`
@@ -1750,17 +1756,24 @@ module TencentCloud
 
         # 通过此接口（DescribeTemplates）查询该第三方平台子客企业在电子签拥有的有效模板，不包括第三方平台模板。
 
-        # > **适用场景**
-        # >
-        # >  该接口常用来配合“使用模板创建签署流程”接口作为前置的接口使用。
-        # >  一个模板通常会包含以下结构信息
-        # >- 模板基本信息
-        # >- 发起方参与信息Promoter、签署参与方 Recipients，后者会在模板发起合同时用于指定参与方
-        # >- 填写控件 Components
-        # >- 签署控件 SignComponents
-        # >- 生成模板的文件基础信息 FileInfos
+        # **一个模板通常会包含以下结构信息**
 
-        # 注意：
+        # - 模板模版ID, 模板名字等基本信息
+        # - 发起方参与信息Promoter、签署参与方 Recipients，后者会在模板发起合同时用于指定参与方
+        # - 发起方和签署方的填写控件 Components
+        # - 签署方的签署控件 SignComponents
+
+        # **适用场景**
+        #  该接口常用来配合<a href="https://qian.tencent.com/developers/partnerApis/startFlows/CreateFlowsByTemplates" target="_blank">用模板创建签署流程</a>和<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowGroupByTemplates" target="_blank">通过多模板创建合同组签署流程</a>接口，作为创建合同的前置接口使用。
+        # 通过此接口查询到模板信息后，再通过调用创建合同的接口，指定模板ID，指定模板中需要的填写控件内容等，完成合同文档的的创建。
+
+        # **模版的来源**
+        # 子客企业的模板有两种途径获取
+        # - 渠道方(平台方)配置完成后, 分发给同应用的各个子企业
+        # - 子客企业通过CreateConsoleLoginUrl创建的链接登录子客控制台自己创建
+
+
+        # **注意**
 
         # >1. 查询条件TemplateId、TemplateName与ChannelTemplateId可同时存在，即可查询同时满足这些条件的模板。
         # >2. TemplateId 和TemplateIds互为独立，若两个参数都传入，则以TemplateId为准
@@ -1935,7 +1948,7 @@ module TencentCloud
 
         # 该接口 (PrepareFlows) 用于创建待发起文件
         # 用户通过该接口进入签署流程发起的确认页面，进行发起信息二次确认， 如果确认则进行正常发起。
-        # 目前该接口只支持B2C，不建议使用，将会**废弃**。
+        # 目前该接口只支持B2C，<font color='red'> **不建议使用，将会废弃**</font>。
 
         # @param request: Request instance for PrepareFlows.
         # @type request: :class:`Tencentcloud::essbasic::V20210526::PrepareFlowsRequest`

data/lib/v20210526/models.rb

@@ -398,25 +398,33 @@ module TencentCloud
 
       # ChannelBatchCancelFlows请求参数结构体
       class ChannelBatchCancelFlowsRequest < TencentCloud::Common::AbstractModel
-        # @param Agent: 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
+        # @param Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
+
+        # 此接口下面信息必填。
+        # <ul>
+        # <li>渠道应用标识:  Agent.AppId</li>
+        # <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
+        # <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
+        # </ul>
+        # 第三方平台子客企业和员工必须已经经过实名认证
         # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
-        # @param FlowIds: 签署流程Id数组，最多100个，超过100不处理
+        # @param FlowIds: 要撤销的合同流程ID列表，最多100个，超过100不处理
         # @type FlowIds: Array
-        # @param CancelMessage: 撤销理由,不超过200个字符
+        # @param CancelMessage: 撤回原因，长度不能超过200，只能由中文、字母、数字和下划线组成。
+
+        # 备注:`如果不传递撤回原因，那么默认撤回原因是 "自动撤销（通过接口实现）"`
         # @type CancelMessage: String
-        # @param CancelMessageFormat: 撤销理由自定义格式，支持以下格式
-        # <ul><li>0 : 默认值</li>
-        # <li>1 : 只保留身份信息</li>
-        # <li>2 : 保留身份信息+企业名称</li>
-        # <li>3 : 保留身份信息+企业名称+经办人名称</li></ul>
-        # 例如,假设合同的发起方是典子谦示例企业的经办人张三，撤销理由是"合同内容错误，需要修正",合同撤销后，各签署方看到的撤销理由是会是
-
-        # 0: 发起方-典子谦示例企业-张三以"合同内容错误，需要修正"的理由撤销当前合同
-        # 1: 发起方以"合同内容错误，需要修正"的理由撤销当前合同
-        # 2: 发起方-典子谦示例企业以"合同内容错误，需要修正"的理由撤销当前合同
-        # 3: 发起方-典子谦示例企业-张三以"合同内容错误，需要修正"的理由撤销当前合同</br>
-
-        # 备注:`如果不传递撤销理由，那么默认撤销理由是 "自动撤销（通过接口实现）"`
+        # @param CancelMessageFormat: 撤销理由自定义格式,  会展示在合同预览的界面中,  可以选择下面的组合方式：
+
+        # **0** : 默认格式,  合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以**CancelMessage**的理由撤销当前合同
+        # **1** :  合同封面页面会展示为:  发起方以**CancelMessage**的理由撤销当前合同
+        # **2** : 保留企业名称,  合同封面页面会展示为:  发起方-企业名称以**CancelMessage**的理由撤销当前合同
+        # **3** : 保留企业名称+经办人名字,  合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以**CancelMessage**的理由撤销当前合同
+
+        # 注: `CancelMessage为撤销当前合同的理由`
+
+        # ![image](https://dyn.ess.tencent.cn/guide/capi/channel_ChannelCancelFlow.png)
+
         # @type CancelMessageFormat: Integer
         # @param Operator: 暂未开放
         # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
@@ -451,7 +459,7 @@ module TencentCloud
 
       # ChannelBatchCancelFlows返回参数结构体
       class ChannelBatchCancelFlowsResponse < TencentCloud::Common::AbstractModel
-        # @param FailMessages: 签署流程批量撤销失败原因，错误信息与流程Id一一对应，成功为“”,失败则对应失败消息
+        # @param FailMessages: 签署流程批量撤销失败原因，错误信息与流程Id一一对应，成功为"", 失败则对应失败原因
         # @type FailMessages: Array
         # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
         # @type RequestId: String
@@ -654,9 +662,17 @@ module TencentCloud
 
       # ChannelCreateBatchCancelFlowUrl请求参数结构体
       class ChannelCreateBatchCancelFlowUrlRequest < TencentCloud::Common::AbstractModel
-        # @param Agent: 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
+        # @param Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
+
+        # 此接口下面信息必填。
+        # <ul>
+        # <li>渠道应用标识:  Agent.AppId</li>
+        # <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
+        # <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
+        # </ul>
+        # 第三方平台子客企业和员工必须已经经过实名认证
         # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
-        # @param FlowIds: 签署流程Id数组
+        # @param FlowIds: 要撤销的合同流程ID列表，最多100个，超过100不处理
         # @type FlowIds: Array
         # @param Operator: 暂未开放
         # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
@@ -687,11 +703,12 @@ module TencentCloud
 
       # ChannelCreateBatchCancelFlowUrl返回参数结构体
       class ChannelCreateBatchCancelFlowUrlResponse < TencentCloud::Common::AbstractModel
-        # @param BatchCancelFlowUrl: 批量撤销url
+        # @param BatchCancelFlowUrl: 批量撤销合同的URL链接, 需要在手机端打开, 有效期24小时
         # @type BatchCancelFlowUrl: String
-        # @param FailMessages: 签署流程批量撤销失败原因
+        # @param FailMessages: 与入参的FlowIds数组一致,   成功生成到撤销链接中,则为"",   不能撤销合同则为失败原因
         # @type FailMessages: Array
-        # @param UrlExpireOn: 签署撤销url过期时间-年月日-时分秒
+        # @param UrlExpireOn: 签署撤销链接的过期时间(格式为:年-月-日 时:分:秒), 默认是生成链接的24小时后失效
+
         # @type UrlExpireOn: String
         # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
         # @type RequestId: String
@@ -2226,13 +2243,28 @@ module TencentCloud
 
       # ChannelCreateReleaseFlow请求参数结构体
       class ChannelCreateReleaseFlowRequest < TencentCloud::Common::AbstractModel
-        # @param Agent: 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
+        # @param Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
+
+        # 此接口下面信息必填。
+        # <ul>
+        # <li>渠道应用标识:  Agent.AppId</li>
+        # <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
+        # <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
+        # </ul>
+        # 第三方平台子客企业和员工必须已经经过实名认证
         # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
-        # @param NeedRelievedFlowId: 待解除的流程编号（即原流程的编号）
+        # @param NeedRelievedFlowId: 待解除的签署流程编号(即原签署流程的编号)。
         # @type NeedRelievedFlowId: String
-        # @param ReliveInfo: 解除协议内容
+        # @param ReliveInfo: 解除协议内容, 包括解除理由等信息。
         # @type ReliveInfo: :class:`Tencentcloud::Essbasic.v20210526.models.RelieveInfo`
-        # @param ReleasedApprovers: 非必须，解除协议的本企业签署人列表，默认使用原流程的签署人列表；当解除协议的签署人与原流程的签署人不能相同时（例如原流程签署人离职了），需要指定本企业的其他签署人来替换原流程中的原签署人，注意需要指明ApproverNumber来代表需要替换哪一个签署人，已转发的签署人不包含在内，解除协议的签署人数量不能多于原流程的签署人数量
+        # @param ReleasedApprovers: 替换解除协议的签署人， 如不指定替换签署人,  则使用原流程的签署人。 <br/>
+        # 如需更换原合同中的企业端签署人，可通过指定该签署人的RecipientId编号更换此企业端签署人。(可通过接口<a href="https://qian.tencent.com/developers/companyApis/queryFlows/DescribeFlowInfo/">DescribeFlowInfo</a>查询签署人的RecipientId编号)<br/>
+
+        # 注意：
+        # <ul>
+        # <li>只能更换自己企业的签署人, 不支持更换个人类型或者其他企业的签署人</li>
+        # <li>可以不指定替换签署人, 使用原流程的签署人</li>
+        # </ul>
         # @type ReleasedApprovers: Array
         # @param CallbackUrl: 签署完回调url，最大长度1000个字符
         # @type CallbackUrl: String
@@ -2240,17 +2272,26 @@ module TencentCloud
         # @type Organization: :class:`Tencentcloud::Essbasic.v20210526.models.OrganizationInfo`
         # @param Operator: 暂未开放
         # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
-        # @param Deadline: 签署流程的签署截止时间。 值为unix时间戳,精确到秒,不传默认为当前时间七天后
+        # @param Deadline: 合同流程的签署截止时间，格式为Unix标准时间戳(秒)，如果未设置签署截止时间，则默认为合同流程创建后的7天时截止。
+        # 如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。
         # @type Deadline: Integer
+        # @param UserData: 调用方自定义的个性化字段，该字段的值可以是字符串JSON或其他字符串形式，客户可以根据自身需求自定义数据格式并在需要时进行解析。该字段的信息将以Base64编码的形式传输，支持的最大数据大小为20480长度。
+
+        # 在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。
 
-        attr_accessor :Agent, :NeedRelievedFlowId, :ReliveInfo, :ReleasedApprovers, :CallbackUrl, :Organization, :Operator, :Deadline
+        # 回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
+        # @type UserData: String
+
+        attr_accessor :Agent, :NeedRelievedFlowId, :ReliveInfo, :ReleasedApprovers, :CallbackUrl, :Organization, :Operator, :Deadline, :UserData
         extend Gem::Deprecate
+        deprecate :CallbackUrl, :none, 2023, 11
+        deprecate :CallbackUrl=, :none, 2023, 11
         deprecate :Organization, :none, 2023, 11
         deprecate :Organization=, :none, 2023, 11
         deprecate :Operator, :none, 2023, 11
         deprecate :Operator=, :none, 2023, 11
 
-        def initialize(agent=nil, needrelievedflowid=nil, reliveinfo=nil, releasedapprovers=nil, callbackurl=nil, organization=nil, operator=nil, deadline=nil)
+        def initialize(agent=nil, needrelievedflowid=nil, reliveinfo=nil, releasedapprovers=nil, callbackurl=nil, organization=nil, operator=nil, deadline=nil, userdata=nil)
           @Agent = agent
           @NeedRelievedFlowId = needrelievedflowid
           @ReliveInfo = reliveinfo
@@ -2259,6 +2300,7 @@ module TencentCloud
           @Organization = organization
           @Operator = operator
           @Deadline = deadline
+          @UserData = userdata
         end
 
         def deserialize(params)
@@ -2289,6 +2331,7 @@ module TencentCloud
             @Operator.deserialize(params['Operator'])
           end
           @Deadline = params['Deadline']
+          @UserData = params['UserData']
         end
       end
 
@@ -2440,22 +2483,29 @@ module TencentCloud
 
       # ChannelCreateUserAutoSignEnableUrl请求参数结构体
       class ChannelCreateUserAutoSignEnableUrlRequest < TencentCloud::Common::AbstractModel
-        # @param Agent: 渠道应用相关信息
+        # @param Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
         # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
-        # @param SceneKey: 自动签场景:
-        # E_PRESCRIPTION_AUTO_SIGN 电子处方
+        # @param SceneKey: 自动签使用的场景值, 可以选择的场景值如下:
+        # <ul><li> **E_PRESCRIPTION_AUTO_SIGN** :  电子处方场景</li></ul>
+
+        # 注: `现在仅支持电子处方场景`
         # @type SceneKey: String
-        # @param Operator: 操作人信息
+        # @param Operator: 执行本接口操作的员工信息。
+        # 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
         # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
-        # @param AutoSignConfig: 自动签开通，签署相关配置
+        # @param AutoSignConfig: 自动签开通配置信息, 包括开通的人员的信息等
         # @type AutoSignConfig: :class:`Tencentcloud::Essbasic.v20210526.models.AutoSignConfig`
-        # @param UrlType: 链接类型，空-默认小程序端链接，H5SIGN-h5端链接
+        # @param UrlType: 生成的链接类型：
+        # <ul><li> 不传(即为空值) 则会生成小程序端开通链接(默认)</li>
+        # <li> **H5SIGN** : 生成H5端开通链接</li></ul>
         # @type UrlType: String
-        # @param NotifyType: 通知类型，默认不填为不通知开通方，填写 SMS 为短信通知。
+        # @param NotifyType: 是否通知开通方，通知类型:
+        # <ul><li>默认不设置为不通知开通方</li>
+        # <li>**SMS** :  短信通知 ,如果需要短信通知则NotifyAddress填写对方的手机号</li><ul>
         # @type NotifyType: String
-        # @param NotifyAddress: 若上方填写为 SMS，则此处为手机号
+        # @param NotifyAddress: 如果通知类型NotifyType选择为SMS，则此处为手机号, 其他通知类型不需要设置此项
         # @type NotifyAddress: String
-        # @param ExpiredTime: 链接的过期时间，格式为Unix时间戳，不能早于当前时间，且最大为30天。如果不传，默认有效期为7天。
+        # @param ExpiredTime: 链接的过期时间，格式为Unix时间戳，不能早于当前时间，且最大为当前时间往后30天。`如果不传，默认过期时间为当前时间往后7天。`
         # @type ExpiredTime: Integer
 
         attr_accessor :Agent, :SceneKey, :Operator, :AutoSignConfig, :UrlType, :NotifyType, :NotifyAddress, :ExpiredTime
@@ -2494,17 +2544,27 @@ module TencentCloud
 
       # ChannelCreateUserAutoSignEnableUrl返回参数结构体
       class ChannelCreateUserAutoSignEnableUrlResponse < TencentCloud::Common::AbstractModel
-        # @param Url: 跳转短链
+        # @param Url: 个人用户自动签的开通链接, 短链形式。过期时间受 `ExpiredTime` 参数控制。
         # @type Url: String
-        # @param AppId: 小程序AppId
+        # @param AppId: 腾讯电子签小程序的 AppID，用于其他小程序/APP等应用跳转至腾讯电子签小程序使用
+
+        # 注: `如果获取的是H5链接, 则不会返回此值`
         # @type AppId: String
-        # @param AppOriginalId: 小程序 原始 Id
+        # @param AppOriginalId: 腾讯电子签小程序的原始 Id,  ，用于其他小程序/APP等应用跳转至腾讯电子签小程序使用
+
+        # 注: `如果获取的是H5链接, 则不会返回此值`
         # @type AppOriginalId: String
-        # @param Path: 跳转路径
+        # @param Path: 腾讯电子签小程序的跳转路径，用于其他小程序/APP等应用跳转至腾讯电子签小程序使用
+
+        # 注: `如果获取的是H5链接, 则不会返回此值`
         # @type Path: String
-        # @param QrCode: base64格式跳转二维码
+        # @param QrCode: base64 格式的跳转二维码图片，可通过微信扫描后跳转到腾讯电子签小程序的开通界面。
+
+        # 注: `如果获取的是H5链接, 则不会返回此二维码图片`
         # @type QrCode: String
-        # @param UrlType: 链接类型，空-默认小程序端链接，H5SIGN-h5端链接
+        # @param UrlType: 返回的链接类型
+        # <ul><li> 空: 默认小程序端链接</li>
+        # <li> **H5SIGN** : h5端链接</li></ul>
         # @type UrlType: String
         # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
         # @type RequestId: String
@@ -5138,21 +5198,20 @@ module TencentCloud
         # 第三方平台子客企业和员工必须已经经过实名认证
         # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
         # @param TemplateId: 合同模板ID，为32位字符串。
-        # 建议开发者保存此模板ID，后续用此模板发起合同流程需要此参数。
+
+        # 可以通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>登录企业控制台, 在企业模板中得到合同模板ID。
         # @type TemplateId: String
-        # @param ContentType: 查询内容控制
+        # @param ContentType: 查询模版的内容
 
-        # <ul><li>**0**：模板列表及详情（默认）</li>
-        # <li>**1**：仅模板列表</li></ul>
+        # <ul><li>**0**：（默认）模板列表及详情</li>
+        # <li>**1**：仅模板列表, 不会返回模板中的签署控件, 填写控件, 参与方角色列表等信息</li></ul>
         # @type ContentType: Integer
-        # @param TemplateIds: 合同模板ID数组，每一个合同模板ID为32位字符串。
-        # 建议开发者保存此模板ID，后续用此模板发起合同流程需要此参数。
+        # @param TemplateIds: 合同模板ID数组，每一个合同模板ID为32位字符串,  最多支持200个模板的批量查询。
 
-        # ```注意:
-        # 1. 此参数TemplateIds与TemplateId互为独立，若两者均传入，以TemplateId为准。
-        # 2. 请确保每个模板均正确且属于当前企业，若有任一模板不存在，则返回错误。
-        # 3. 最多支持200个模板。
-        # 4. 若传递此参数，分页参数(Limit,Offset)无效```
+        # 注意:
+        # 1.` 此参数TemplateIds与TemplateId互为独立，若两者均传入，以TemplateId为准。`
+        # 2. `请确保每个模板均正确且属于当前企业，若有任一模板不存在，则返回错误。`
+        # 4. `若传递此参数，分页参数(Limit,Offset)无效`
         # @type TemplateIds: Array
         # @param Limit: 指定每页返回的数据条数，和Offset参数配合使用。
 
@@ -5163,31 +5222,32 @@ module TencentCloud
         # 注：`1.offset从0开始，即第一页为0。`
         # `2.默认从第一页返回。`
         # @type Offset: Integer
-        # @param TemplateName: 模糊搜索的模板名称，注意是模板名的连续部分，最大长度200
+        # @param TemplateName: 模糊搜索的模板名称，注意是模板名的连续部分，长度不能超过200，可支持由中文、字母、数字和下划线组成字符串。
         # @type TemplateName: String
         # @param ChannelTemplateId: 对应第三方应用平台企业的模板ID，通过此值可以搜索由第三方应用平台模板ID下发或领取得到的子客模板列表。
         # @type ChannelTemplateId: String
-        # @param QueryAllComponents: 是否返回所有控件信息。
+        # @param QueryAllComponents: 返回控件的范围, 是只返回发起方自己的还是所有参与方的
 
-        # <ul><li>**false**：只返回发起方控件（默认）</li>
-        # <li>**true**：返回所有签署方控件</li></ul>
+        # <ul><li>**false**：（默认）只返回发起方控件</li>
+        # <li>**true**：返回所有参与方(包括发起方和签署方)控件</li></ul>
         # @type QueryAllComponents: Boolean
         # @param WithPreviewUrl: 是否获取模板预览链接。
 
         # <ul><li>**false**：不获取（默认）</li>
         # <li>**true**：获取</li></ul>
 
-        # 设置为true之后， 返回参数PreviewUrl，为模板的H5预览链接,有效期5分钟。
-        # 可以通过浏览器打开此链接预览模板，或者嵌入到iframe中预览模板。
-        # （此功能开放需要联系客户经理）
+        # 设置为true之后， 返回参数PreviewUrl，为模板的H5预览链接,  有效期5分钟。可以通过浏览器打开此链接预览模板，或者嵌入到iframe中预览模板。
+
+        # 注: `此功能为白名单功能，使用前请联系对接的客户经理沟通。`
         # @type WithPreviewUrl: Boolean
         # @param WithPdfUrl: 是否获取模板的PDF文件链接。
 
         # <ul><li>**false**：不获取（默认）</li>
         # <li>**true**：获取</li></ul>
 
-        # 设置为true之后， 返回参数PdfUrl，为模板PDF文件链接，有效期5分钟。
-        # （此功能开放需要联系客户经理）
+        # 设置为true之后， 返回参数PdfUrl，为模板PDF文件链接，有效期5分钟, 可以用于将PDF文件下载到本地
+
+        # 注: `此功能为白名单功能，使用前请联系对接的客户经理沟通。`
         # @type WithPdfUrl: Boolean
         # @param Operator: 操作者的信息
         # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
@@ -7289,18 +7349,18 @@ module TencentCloud
         end
       end
 
-      # 流程中参与方的信息结构
+      # 流程中签署方和填写方(如果有填写控件存证时)的信息
       class Recipient < TencentCloud::Common::AbstractModel
-        # @param RecipientId: 签署人唯一标识，在通过模板发起合同的时候对应签署方ID
+        # @param RecipientId: 合同参与方的角色ID
         # @type RecipientId: String
-        # @param RecipientType: 参与者类型，默认为空。
-        # ENTERPRISE-企业；
-        # INDIVIDUAL-个人；
-        # PROMOTER-发起方
+        # @param RecipientType: 参与者类型, 可以选择的类型如下:
+        # <ul><li> **ENTERPRISE** :此角色为企业参与方</li>
+        # <li> **INDIVIDUAL** :此角色为个人参与方</li>
+        # <li> **PROMOTER** :此角色是发起方</li></ul>
         # @type RecipientType: String
-        # @param Description: 描述信息
+        # @param Description: 合同参与方的角色描述，长度不能超过100，只能由中文、字母、数字和下划线组成。
         # @type Description: String
-        # @param RoleName: 角色名称
+        # @param RoleName: 合同参与方的角色名字，长度不能超过20，只能由中文、字母、数字和下划线组成。
         # @type RoleName: String
         # @param RequireValidation: 是否需要校验，
         # true-是，

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tencentcloud-sdk-essbasic
 version: !ruby/object:Gem::Version
-  version: 3.0.691
+  version: 3.0.692
 platform: ruby
 authors:
 - Tencent Cloud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-11-01 00:00:00.000000000 Z
+date: 2023-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tencentcloud-sdk-common