tencentcloud-sdk-ess 3.0.913 → 3.0.915

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2462240a51f6533f8cf7db19412c98188837cbf6
-  data.tar.gz: 09729c7fb92729e39c72b5cc6fc25e31c483de46
+  metadata.gz: 059c454c8f306b096e521a2bc5829c91383922d1
+  data.tar.gz: 51e3836ef7145aab10abb3305879dcca51078848
 SHA512:
-  metadata.gz: e052cab9927c0410c9b4f08f5651e3a28da453e46a38216cbe7898bae063153d6eb18b69d79d6d5e9b480c24fd5a618c5c3afd9a91d27ed9843508cba863ba91
-  data.tar.gz: 38665e28d38370e629167e258a88d25c3c589c0d4ee0418d477574ec1fd3fa33304545d731aacfff54d59dc0e854ca6763b157abcadb800354c5d17fd31b13b8
+  metadata.gz: f147135c6a168bacddc53abcfd856581f3c892596ccc1b6b417f73659504c42341665fe8983bc9bfddcb3c6e5eb6ebcf6bd5ae92710253ef4eea4c3babfcdc67
+  data.tar.gz: c6929e7aca598c67bc79dd9b054448efdcabc600b4365cbe7254f241ad9ca8d7e9648ac9ec98724afa655a4d3afb28017b402112fc1776ec49d2b4b2b4fe35ce

data/lib/VERSION

@@ -1 +1 @@
-3.0.913
+3.0.915

data/lib/v20201111/client.rb

@@ -68,7 +68,7 @@ module TencentCloud
 
         # 3. <font color='red'>只有撤销没有参与方签署过或只有自动签署签署过的合同，才会返还合同额度。</font>
 
-        # 4.  撤销后可以看合同PDF内容的人员： 发起方的超管， 发起方自己，发起方撤销合同的操作人员，已经签署合同、已经填写合同、邀请填写已经补充信息的参与人员
+        # 4.  撤销后可以看合同PDF内容的人员： 发起方的超管， 发起方自己，发起方撤销合同的操作人员，已经签署合同、已经填写合同、邀请填写已经补充信息的参与人员， 其他参与人员看不到合同的内容。
 
         # @param request: Request instance for CancelFlow.
         # @type request: :class:`Tencentcloud::ess::V20201111::CancelFlowRequest`
@@ -164,6 +164,8 @@ module TencentCloud
 
         # 3. <font color='red'>只有撤销没有参与方签署过或只有自动签署签署过的合同，才会返还合同额度。</font>
 
+        # 4. 撤销后可以看合同PDF内容的人员： 发起方的超管， 发起方自己，发起方撤销合同的操作人员，已经签署合同、已经填写合同、邀请填写已经补充信息的参与人员， 其他参与人员看不到合同的内容。
+
         # @param request: Request instance for CreateBatchCancelFlowUrl.
         # @type request: :class:`Tencentcloud::ess::V20201111::CreateBatchCancelFlowUrlRequest`
         # @rtype: :class:`Tencentcloud::ess::V20201111::CreateBatchCancelFlowUrlResponse`
@@ -295,10 +297,9 @@ module TencentCloud
         # 该接口用于发起合同后，生成个人用户的批量待办链接, 暂时不支持企业端签署。
         # **注意：**
         # 1. 该接口目前仅支持签署人类型是**个人签署方的批量签署场景**(ApproverType=1)。
-        # 2. 该接口可生成批量签署链接的C端签署人**必须仅有手写签名(控件类型为SIGN_SIGNATURE)和时间类型的签署控件**，**不支持填写控件** 。
-        # 3. 请确保C端签署人在批量签署合同中**为待签署状态**，如需顺序签署请待前一位参与人签署完成后，再创建该C端用户的签署链接。
-        # 4. 该签署链接**有效期为30分钟**，过期后将失效，如需签署可重新创建批量签署链接 。
-        # 5. 该接口返回的签署链接适用于APP集成的场景，支持APP打开或浏览器直接打开，**不支持微信小程序嵌入**。
+        # 2. 该接口可生成C端签署人的批量签署/查看链接，**签署控件仅支持手写签名(控件类型为SIGN_SIGNATURE)和时间类型的签署控件** 。
+        # 3. 该签署链接**有效期为30分钟**，过期后将失效，如需签署可重新创建批量签署链接 。
+        # 4. 该接口返回的签署链接适用于APP集成的场景，支持APP打开或浏览器直接打开，**不支持微信小程序嵌入**。
         # 跳转到小程序的实现，参考微信官方文档(分为<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://qian.tencent.com/developers/company/openwxminiprogram">跳转电子签小程序配置</a>。
         # 6. 因h5涉及人脸身份认证能力基于慧眼人脸核身，对Android和iOS系统均有一定要求， 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
 
@@ -390,7 +391,7 @@ module TencentCloud
         # ###  调用流程
         # 该接口需要给对应的流程指定一个模板id，并且填充该模板中需要补充的信息。需要配置<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow" target="_blank">创建签署流程</a>和<a href="https://qian.tencent.com/developers/companyApis/startFlows/StartFlow" target="_blank">发起签署流程</a>接口使用。具体逻辑可以参考下图:
 
-        # ![image](https://qcloudimg.tencent-cloud.cn/raw/06f2bc0f1772d8deac2f92b5df61a5ac.png)
+        # ![image](https://qcloudimg.tencent-cloud.cn/raw/1f38ebd7c5afed8763ad961741d81438.png)
 
 
         # ### 填充模板中定义的填写控件
@@ -578,7 +579,7 @@ module TencentCloud
 
         # 注：配合<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument" target="_blank">创建电子文档</a>和<a href="https://qian.tencent.com/developers/companyApis/startFlows/StartFlow" target="_blank">发起签署流程</a>接口使用。整体的逻辑如下图
 
-        # ![image](https://qcloudimg.tencent-cloud.cn/raw/06f2bc0f1772d8deac2f92b5df61a5ac.png)
+        # ![image](https://qcloudimg.tencent-cloud.cn/raw/1f38ebd7c5afed8763ad961741d81438.png)
 
         # 注：**静默（自动）签署不支持合同签署方存在填写**功能
         # <br>
@@ -1547,6 +1548,8 @@ module TencentCloud
         # <li>非原合同企业参与人发起解除协议时，需要有<code>解除合同的权限</code>。</li>
         # </ul>
 
+        # ![image](https://qcloudimg.tencent-cloud.cn/raw/3427941ecb091bf0c55009bad192dd1c.png)
+
         # @param request: Request instance for CreateReleaseFlow.
         # @type request: :class:`Tencentcloud::ess::V20201111::CreateReleaseFlowRequest`
         # @rtype: :class:`Tencentcloud::ess::V20201111::CreateReleaseFlowResponse`
@@ -2132,8 +2135,7 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 查询流程基础信息
-        # 适用场景：可用于主动查询某个合同流程的签署状态信息。可以配合回调通知使用。
+        # 查询流程基础信息，主要用于<font color="red">查询合同的状态</font>信息。可以配合回调通知使用。
 
         # 注: `每个企业限制日调用量限制：100W，当日超过此限制后再调用接口返回错误`
 
@@ -2159,7 +2161,12 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 可以根据合同流程ID查询该合同流程相关联的填写控件信息和填写内容，包括填写控件的归属方、填写控件是否已经填写以及填写的内容等信息。
+        # 可以根据合同流程ID查询该合同流程相关联的填写控件信息和填写内容，包括填写控件的归属方、填写控件是否已经填写以及填写的具体内容。
+
+
+        # 如下图模板所示，发起后对方填写后，可以获取红框中用户填写的信息。
+
+        # ![image](https://qcloudimg.tencent-cloud.cn/raw/08f6ea50d3ae88b51c280c2b17c2a126.png)
 
         # @param request: Request instance for DescribeFlowComponents.
         # @type request: :class:`Tencentcloud::ess::V20201111::DescribeFlowComponentsRequest`
@@ -2819,7 +2826,7 @@ module TencentCloud
         # 此接口用于启动流程。它是模板发起合同的最后一步。
         # 在[创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)和[创建电子文档](https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument)之后，用于开始整个合同流程,  推进流程进入到签署环节。
 
-        # ![image](https://qcloudimg.tencent-cloud.cn/raw/06f2bc0f1772d8deac2f92b5df61a5ac.png)
+        # ![image](https://qcloudimg.tencent-cloud.cn/raw/1f38ebd7c5afed8763ad961741d81438.png)
 
         # 注：
         # 1.<font color="red">合同发起后就会扣减合同的额度</font>, 只有撤销没有参与方签署过或只有自动签署签署过的合同，才会返还合同额度。（过期，拒签，签署完成，解除完成等状态不会返还额度）

data/lib/v20201111/models.rb

@@ -130,12 +130,15 @@ module TencentCloud
         # <li> 企业印章</li>
         # <li> 骑缝章等签署控件</li></ul>
         # @type SignComponents: Array
-        # @param ApproverIdCardType: 签署方经办人的证件类型，支持以下类型
+        # @param ApproverIdCardType: 签署方经办人的证件类型，支持以下类型，样式可以参考<a href="https://qian.tencent.com/developers/partner/id_card_support/" target="_blank">常见个人证件类型介绍</a>
         # <ul><li>ID_CARD 中国大陆居民身份证  (默认值)</li>
         # <li>HONGKONG_AND_MACAO 港澳居民来往内地通行证</li>
         # <li>HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)</li>
         # <li>OTHER_CARD_TYPE 其他证件</li></ul>
 
+
+
+
         # 注: `其他证件类型为白名单功能，使用前请联系对接的客户经理沟通。`
         # @type ApproverIdCardType: String
         # @param ApproverIdCardNumber: 签署方经办人的证件号码，应符合以下规则
@@ -150,7 +153,7 @@ module TencentCloud
         # 注意：
         # `如果使用的是通过文件发起合同（CreateFlowByFiles），NotifyType必须 是 sms 才会发送短信`
         # @type NotifyType: String
-        # @param ApproverRole: 收据场景设置签署人角色类型, 可以设置如下****类型****:
+        # @param ApproverRole: 收据场景设置签署人角色类型, 可以设置如下<b>类型</b>:
         # <ul><li> **1**  :收款人</li>
         # <li>   **2**   :开具人</li>
         # <li>   **3** :见证人</li></ul>
@@ -3531,9 +3534,9 @@ module TencentCloud
 
       # CreateFlowSignUrl请求参数结构体
       class CreateFlowSignUrlRequest < TencentCloud::Common::AbstractModel
-        # @param FlowId: 合同流程ID，为32位字符串。
-        # 建议开发者妥善保存此流程ID，以便于顺利进行后续操作。
-        # 可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
+        # @param FlowId: 合同流程ID为32位字符串。
+
+        # 您可以登录腾讯电子签控制台，在 "合同" -> "合同中心" 中查看某个合同的FlowId（在页面中展示为合同ID）。[点击查看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)。
         # @type FlowId: String
         # @param Operator: 执行本接口操作的员工信息。
         # 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
@@ -3541,22 +3544,25 @@ module TencentCloud
         # @param Agent: 代理企业和员工的信息。
         # 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
         # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
-        # @param FlowApproverInfos: 流程签署人列表，其中结构体的ApproverName，ApproverMobile和ApproverType必传，企业签署人则需传OrganizationName，其他可不传。
+        # @param FlowApproverInfos: 流程签署人列表中，结构体的ApproverName、ApproverMobile和ApproverType为必传字段。如果是企业签署人，还需传递OrganizationName。
+
+        # 注：
+        # 1. 签署人<b>只能使用手写签名、时间类型、印章类型、签批类型的签署控件和内容填写控件</b>，其他类型的签署控件暂时不支持。
+        # 2. 生成发起方预览链接时，该字段（FlowApproverInfos）可以传空或者不传。
 
-        # 注:
-        # `1. 签署人只能有手写签名、时间类型、印章类型、签批类型的签署控件和内容填写控件，其他类型的签署控件暂时未支持。`
-        # `2. 生成发起方预览链接时，该字段（FlowApproverInfos）传空或者不传`
         # @type FlowApproverInfos: Array
         # @param Organization: 机构信息，暂未开放
         # @type Organization: :class:`Tencentcloud::Ess.v20201111.models.OrganizationInfo`
         # @param JumpUrl: 签署完之后的H5页面的跳转链接，最大长度1000个字符。链接类型请参考 <a href="https://qian.tencent.com/developers/company/openqianh5" target="_blank">跳转电子签H5</a>
         # @type JumpUrl: String
-        # @param UrlType: 链接类型，支持指定以下类型
-        # <ul><li>0 : 签署链接 (默认值)</li>
-        # <li>1 : 预览链接</li></ul>
-        # 注:
-        # `1. 当指定链接类型为1时，链接为预览链接，打开链接无法签署仅支持预览以及查看当前合同状态。`
-        # `2. 如需生成发起方预览链接，则签署方信息传空，即FlowApproverInfos传空或者不传。`
+        # @param UrlType: 链接类型支持以下指定类型：
+
+        # <ul><li><b>0</b>: 签署链接（默认值），进入后可以填写或签署合同。</li><li><b>1 </b>: 预览链接，进入后可以预览合同当前的样子。</li></ul>
+
+        # 注：
+
+        # 1. 当指定链接类型为1时，链接为预览链接，打开链接后无法进行签署操作，仅支持预览和查看当前合同状态。
+        # 2. 如需生成发起方预览链接，则签署方信息应传空，即FlowApproverInfos传空或者不传。
         # @type UrlType: Integer
 
         attr_accessor :FlowId, :Operator, :Agent, :FlowApproverInfos, :Organization, :JumpUrl, :UrlType
@@ -6899,11 +6905,10 @@ module TencentCloud
         # 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
         # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
         # @param FlowIds: 查询的合同流程ID列表最多支持100个流程ID。
-        # 如果某个合同流程ID不存在，系统会跳过此ID的查询，继续查询剩余存在的合同流程。
 
-        # 可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
+        # 如果某个合同流程ID不存在，系统会跳过此ID的查询，继续查询剩余存在的合同流程。
 
-        # [点击查看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)
+        # 可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。[点击查看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)
         # @type FlowIds: Array
         # @param Agent: 代理企业和员工的信息。
         # 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
@@ -9056,11 +9061,14 @@ module TencentCloud
 
         # 注: `若不设置此参数，则默认使用合同的截止时间，此参数暂不支持合同组子合同`
         # @type Deadline: Integer
-        # @param Intention: 视频核身意图配置，可指定问答模式或者点头模式的语音文本。
+        # @param Intention: <b>只有在生成H5签署链接的情形下</b>（ 如调用<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowSignUrl" target="_blank">获取H5签署链接</a>、<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateBatchQuickSignUrl" target="_blank">获取H5批量签署链接</a>等接口），该配置才会生效。
 
-        # 注:
-        #  `1.视频认证为白名单功能，使用前请联系对接的客户经理沟通。`
-        # `2.使用视频认证必须指定签署认证方式为人脸（即ApproverSignTypes）。`
+        # 您可以指定H5签署视频核身的意图配置，选择问答模式或点头模式的语音文本。
+
+        # 注意：
+        # 1. 视频认证为<b>白名单功能，使用前请联系对接的客户经理沟通</b>。
+        # 2. 使用视频认证时，<b>生成H5签署链接必须将签署认证方式指定为人脸</b>（即ApproverSignTypes设置成人脸签署）。
+        # 3. 签署完成后，可以通过<a href="https://qian.tencent.com/developers/companyApis/queryFlows/DescribeSignFaceVideo" target="_blank">查询签署认证人脸视频</a>获取到当时的视频。
         # @type Intention: :class:`Tencentcloud::Ess.v20201111.models.Intention`
 
         attr_accessor :ApproverType, :OrganizationName, :ApproverName, :ApproverMobile, :ApproverIdCardType, :ApproverIdCardNumber, :RecipientId, :VerifyChannel, :NotifyType, :IsFullText, :PreReadTime, :UserId, :Required, :ApproverSource, :CustomApproverTag, :RegisterInfo, :ApproverOption, :JumpUrl, :SignId, :ApproverNeedSignReview, :SignComponents, :Components, :ComponentLimitType, :ApproverVerifyTypes, :ApproverSignTypes, :SignTypeSelector, :Deadline, :Intention

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tencentcloud-sdk-ess
 version: !ruby/object:Gem::Version
-  version: 3.0.913
+  version: 3.0.915
 platform: ruby
 authors:
 - Tencent Cloud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-09-24 00:00:00.000000000 Z
+date: 2024-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tencentcloud-sdk-common