tencentcloud-sdk-essbasic 3.0.942 → 3.0.944

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 676b6868f81631231a3755f37e4581db352848c1
-  data.tar.gz: 38f5cf38cac4d8f0d112524331a26d5e97f96544
+  metadata.gz: 6279bcb815156ac3dc4462ca01c925bb3c254a68
+  data.tar.gz: 351baab0b68ca6bf2d932788b2379567dc7514a7
 SHA512:
-  metadata.gz: 024697ed4056783820b6098dc212351bae4a9f4e5453e42ca8e8979058162004810f3a57d82bfe992bfb3f8206f75c3b4976ae979edf2913cf281101902d1c2d
-  data.tar.gz: 38701103b89a319de1176761e1ccb11e8ed605d3172e6dc0bde3e5b32d420c298eeb118856613587117e82cb976b780f2dd957bf0891ec13c99eb2299d8def53
+  metadata.gz: 21acd3d0a326335fabbf1ba3819d8d00862a330b33099d9b1fb88abc33b21d4b7413bb940f0fc8916de1e071dd73619a8e28d9b769c1b1f33459da86ef08b6f5
+  data.tar.gz: bdedf1d0e6003c37c457e50d46c4b9ce2868e1569ba02efd4acdfa17e7c758371a549c877012dc74029f568f2bbd997dcb7b6ecbad4b52e7bafb159cfcc323cf

data/lib/VERSION

@@ -1 +1 @@
-3.0.942
+3.0.944

data/lib/v20210526/client.rb

@@ -188,11 +188,10 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 该接口用于发起合同后，生成个人用户的批量待办链接, 暂时不支持企业端签署。
+        # 该接口用于发起合同后，生成个人/企业用户的批量待办链接。
         # **注意：**
-        # 1. 该接口目前仅支持签署人类型是**个人签署方的批量签署场景**(ApproverType=1)。
-        # 2. 该接口可生成C端签署人的批量签署/查看链接，**签署控件仅支持手写签名(控件类型为SIGN_SIGNATURE)和时间类型的签署控件** 。
-        # 3. 该签署链接**有效期为30分钟**，过期后将失效，如需签署可重新创建批量签署链接 。
+        # 1. 该接口可生成签署人的批量、合同组签署/查看链接 。
+        # 2. 该签署链接**有效期为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>。
@@ -1273,12 +1272,32 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 用于获取合同中填写控件填写状态和填写的内容。
+        # 您可以通过合同流程ID查询相关的<font color="red"><b>填写控件</b></font>信息及其内容。这包括控件的归属方、控件的填写状态（是否已填写）以及具体的填写内容。
 
-        # **注意**: `附件控件不会出现在结果列表中`
+        # 无论是<font color="red"><b>发起方还是签署方</b></font>填写的控件，均包含在查询结果中。
 
+        # ![image](https://qcloudimg.tencent-cloud.cn/raw/08f6ea50d3ae88b51c280c2b17c2a126.png)
+        # ### 2.  那些控件会出现在结果里边？
+        # **A.不返回的控件类型：**
+        # - 动态表格
+        # - 附件控件
+        # - 水印控件
+
+        # **B.返回的控件类型：**
+        # - 单行文本
+        # - 多行文本
+        # - 勾选框控件
+        # - 数字控件
+        # - 日期控件
+        # - 图片控件（图片下载地址）
+        # - 邮箱控件
+        # - 地址控件
+        # - 学历控件
+        # - 性别控件
+        # - 省市区控件
+
+        # ### 3.怎么授权？
 
-        # **授权**:
         # 此接口需要授权,  有两种开通权限的途径
 
         # **第一种**:   需第三方应用的子企业登录控制台进行授权,  授权在**企业中心**的**授权管理**区域,  界面如下图

data/lib/v20210526/models.rb

@@ -953,10 +953,14 @@ module TencentCloud
       # ChannelCreateBatchQuickSignUrl请求参数结构体
       class ChannelCreateBatchQuickSignUrlRequest < TencentCloud::Common::AbstractModel
         # @param FlowApproverInfo: 批量签署的流程签署人，其中姓名(ApproverName)、参与人类型(ApproverType)必传，手机号(ApproverMobile)和证件信息(ApproverIdCardType、ApproverIdCardNumber)可任选一种或全部传入。
+        # <ul>
+        # <li>若为个人参与方：ApproverType:"PERSON"</li>
+        # <li>若为企业参与方：ApproverType:"ORGANIZATION"。同时若签署方为saas企业员工， OrganizationName 参数需传入参与方企业名称。若签署方为渠道子客企业员工，还需要传 OpenId、OrganizationOpenId。</li>
+        # </ul>
+
         # 注:
-        # `1. ApproverType目前只支持个人类型的签署人。`
-        # `2. 签署人只能有手写签名和时间类型的签署控件，其他类型的填写控件和签署控件暂时都未支持。`
-        # `3. 当需要通过短信验证码签署时，手机号ApproverMobile需要与发起合同时填写的用户手机号一致。`
+        # `1. 暂不支持签署人拖动签署控件功能，以及签批控件。`
+        # `2. 当需要通过短信验证码签署时，手机号ApproverMobile需要与发起合同时填写的用户手机号一致。`
         # @type FlowApproverInfo: :class:`Tencentcloud::Essbasic.v20210526.models.FlowApproverInfo`
         # @param Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
         # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
@@ -977,7 +981,9 @@ module TencentCloud
         # 注：
         # <ul><li>默认情况下，签名类型为手写签名</li>
         # <li>您可以传递多种值，表示可用多种签名类型。</li>
-        # <li>该参数会覆盖您合同中的签名类型，若您在发起合同时限定了签名类型(赋值签名类型给ComponentTypeLimit)，请将这些签名类型赋予此参数</li></ul>
+        # <li>该参数会覆盖您合同中的签名类型，若您在发起合同时限定了签名类型(赋值签名类型给ComponentTypeLimit)，请将这些签名类型赋予此参数</li>
+        # <li>若签署方为企业员工，此参数无效，签名方式将以合同中为准。</li>
+        # </ul>
         # @type SignatureTypes: Array
         # @param ApproverSignTypes: 指定批量签署合同的认证校验方式，可传递以下值：
         # <ul><li>**1**：人脸认证(默认)，需进行人脸识别成功后才能签署合同</li>
@@ -994,10 +1000,14 @@ module TencentCloud
         # `不指定该值时，默认为签署方自行选择。`
         # @type SignTypeSelector: Integer
         # @param FlowBatchUrlInfo: 批量签署合同相关信息，指定合同和签署方的信息，用于补充动态签署人。
+
+        # 注: `若签署方为企业员工，暂不支持通过H5端进行动态签署人的补充`
         # @type FlowBatchUrlInfo: :class:`Tencentcloud::Essbasic.v20210526.models.FlowBatchUrlInfo`
         # @param Intention: <b>只有在生成H5签署链接的情形下</b>（ 如调用<a href="https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelCreateFlowSignUrl" target="_blank">获取H5签署链接</a>、<a href="https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelCreateBatchQuickSignUrl" target="_blank">获取H5批量签署链接</a>等接口），该配置才会生效。  您可以指定H5签署视频核身的意图配置，选择问答模式或点头模式的语音文本。  注意： 1. 视频认证为<b>白名单功能，使用前请联系对接的客户经理沟通</b>。 2. 使用视频认证时，<b>生成H5签署链接的时候必须将签署认证方式指定为人脸</b>（即ApproverSignTypes设置成人脸签署）。 3. 签署完成后，可以通过<a href="https://qian.tencent.com/developers/partnerApis/flows/ChannelDescribeSignFaceVideo" target="_blank">查询签署认证人脸视频</a>获取到当时的视频。
         # @type Intention: :class:`Tencentcloud::Essbasic.v20210526.models.Intention`
         # @param CacheApproverInfo: 缓存签署人信息。在H5签署链接动态领取场景，首次填写后，选择缓存签署人信息，在下次签署人点击领取链接时，会自动将个人信息（姓名、身份证号、手机号）填入，否则需要每次手动填写。
+
+        # 注: `若参与方为企业员工时，暂不支持对参与方信息进行缓存`
         # @type CacheApproverInfo: Boolean
 
         attr_accessor :FlowApproverInfo, :Agent, :FlowIds, :FlowGroupId, :JumpUrl, :SignatureTypes, :ApproverSignTypes, :SignTypeSelector, :FlowBatchUrlInfo, :Intention, :CacheApproverInfo
@@ -2279,8 +2289,10 @@ module TencentCloud
         # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
         # @param ForbidPersonalMultipleSign: 禁止个人用户重复签署，默认不禁止，即同一用户可多次扫码签署多份合同。若要求同一用户仅能扫码签署一份合同，请传入true。
         # @type ForbidPersonalMultipleSign: Boolean
+        # @param FlowNameAppendScannerInfo: 合同流程名称是否应包含扫码签署人的信息，且遵循特定格式（flowname-姓名-手机号后四位）。 例如，通过参数FlowName设定的扫码发起合同名称为“员工入职合同”，当扫码人张三（手机号18800009527）扫码签署时，合同名称将自动生成为“员工入职合同-张三-9527”。
+        # @type FlowNameAppendScannerInfo: Boolean
 
-        attr_accessor :Agent, :TemplateId, :FlowName, :MaxFlowNum, :FlowEffectiveDay, :QrEffectiveDay, :Restrictions, :ApproverComponentLimitTypes, :CallbackUrl, :ApproverRestrictions, :Operator, :ForbidPersonalMultipleSign
+        attr_accessor :Agent, :TemplateId, :FlowName, :MaxFlowNum, :FlowEffectiveDay, :QrEffectiveDay, :Restrictions, :ApproverComponentLimitTypes, :CallbackUrl, :ApproverRestrictions, :Operator, :ForbidPersonalMultipleSign, :FlowNameAppendScannerInfo
         extend Gem::Deprecate
         deprecate :CallbackUrl, :none, 2024, 11
         deprecate :CallbackUrl=, :none, 2024, 11
@@ -2289,7 +2301,7 @@ module TencentCloud
         deprecate :Operator, :none, 2024, 11
         deprecate :Operator=, :none, 2024, 11
 
-        def initialize(agent=nil, templateid=nil, flowname=nil, maxflownum=nil, floweffectiveday=nil, qreffectiveday=nil, restrictions=nil, approvercomponentlimittypes=nil, callbackurl=nil, approverrestrictions=nil, operator=nil, forbidpersonalmultiplesign=nil)
+        def initialize(agent=nil, templateid=nil, flowname=nil, maxflownum=nil, floweffectiveday=nil, qreffectiveday=nil, restrictions=nil, approvercomponentlimittypes=nil, callbackurl=nil, approverrestrictions=nil, operator=nil, forbidpersonalmultiplesign=nil, flownameappendscannerinfo=nil)
           @Agent = agent
           @TemplateId = templateid
           @FlowName = flowname
@@ -2302,6 +2314,7 @@ module TencentCloud
           @ApproverRestrictions = approverrestrictions
           @Operator = operator
           @ForbidPersonalMultipleSign = forbidpersonalmultiplesign
+          @FlowNameAppendScannerInfo = flownameappendscannerinfo
         end
 
         def deserialize(params)
@@ -2340,6 +2353,7 @@ module TencentCloud
             @Operator.deserialize(params['Operator'])
           end
           @ForbidPersonalMultipleSign = params['ForbidPersonalMultipleSign']
+          @FlowNameAppendScannerInfo = params['FlowNameAppendScannerInfo']
         end
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tencentcloud-sdk-essbasic
 version: !ruby/object:Gem::Version
-  version: 3.0.942
+  version: 3.0.944
 platform: ruby
 authors:
 - Tencent Cloud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-11-15 00:00:00.000000000 Z
+date: 2024-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tencentcloud-sdk-common