tencentcloud-sdk-essbasic 3.0.868 → 3.0.869

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4d16aea7d387ecbf8401352eadbecce14db58c29
-  data.tar.gz: 9eda5c9257f8354cf319a3f9b3a783290545cdb4
+  metadata.gz: e5f48bebb05c1f09623863658bcb2d2afbad66c2
+  data.tar.gz: f2911a61801018802955563f8b870feacdf96a2e
 SHA512:
-  metadata.gz: b34c5e9c65f30a5929bd67e6ddcecd43427393e134595119f530c9b5729852454e8916f0c6dcfdd22676a4d7c42cc6b9abdd21216e17529225b4f3b83bfa139b
-  data.tar.gz: c64303fd554ec82a85fce15b980a941a4e1b7e65f721625f8ddc40823ff740057df9b240fd3c82e004fd1e4dc1b1b288f500de4ec3024344240d437ac4828cfb
+  metadata.gz: 47e382caa35b4256c9fecafbdb43594027579e4841840efb0fe60d9365749664aa38a2b9130b219a2f78996f5bede6b83efa99ee3df98929552a6e53984b00c6
+  data.tar.gz: 89241f0784bae1aeeee606321e414ba73ca85c6b96397cfedbef900ab6f3a244aacf36612e607293dd66e4928f2f68f2b27532dfb3548a31301687353f371f25

data/lib/VERSION

@@ -1 +1 @@
-3.0.868
+3.0.869

data/lib/v20210526/client.rb

@@ -225,7 +225,7 @@ module TencentCloud
         # - 参与人点击链接后需短信验证码才能查看合同内容。
         # - 个人用户批量签署，需要传Name，Mobile，IdCardNumber(IdCardType) 参数。
         # - saas企业员工用户批量签署，在传递了姓名等基本信息参数的情况下，还需要传OrganizationName（参与方所在企业名称）参数生成签署链接，<font color="red">请确保此企业已完成腾讯电子签企业认证</font>。
-        # - 子客企业员工用户批签签署，需要传递员工OpenId和子客企业的OrganizationOpenId。<font color="red">请确保此OrganizationOpenId对应子客已经认证，且OpenId对应员工此子客下已经实名</font>。Name，Mobile, IdCard等信息此时可以不传，系统会查询此OpenId实名信息自动补充。
+        # - 子客企业员工用户批量签署，需要传递员工OpenId和子客企业的OrganizationOpenId。<font color="red">请确保此OrganizationOpenId对应子客已经认证，且OpenId对应员工此子客下已经实名</font>。Name，Mobile, IdCard等信息此时可以不传，系统会查询此OpenId实名信息自动补充。
         # - 生成批量签署链接时，合同目标参与方状态需为<font color="red">待签署</font>状态。
         # - 个人批量签署进行的合同的签名区， 全部变成<font color="red">手写签名</font>（不管合同里边设置的签名限制）来进行。
 
@@ -326,14 +326,18 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 本接口（ChannelCreateEmbedWebUrl）用于创建常规模块嵌入web的链接
+        # 本接口（ChannelCreateEmbedWebUrl）用于创建可嵌入web页面的URL（此web页面可以通过iframe方式嵌入到贵方系统的网页中），支持以下类型的Web链接创建：
+        # 1. 创建印章
+        # 2. 创建模板
+        # 3. 修改模板
+        # 4. 预览模板
+        # 5. 预览合同流程
 
-        # 本接口下面功能的签署页面链接的生成
-        # - 创建印章
-        # - 创建模板
-        # - 修改模板
-        # - 预览模板
-        # - 预览合同流程
+        # 预览模板的嵌入页面长相如下：
+        # ![image](https://qcloudimg.tencent-cloud.cn/raw/57bdda4a884e3f5b2de12d5a282a3651.png)
+
+        # 预览合同流程的嵌入页面长相如下：
+        # ![image](https://qcloudimg.tencent-cloud.cn/raw/dc7af994e2f6da56bdad5975e927de34.png)
 
         # @param request: Request instance for ChannelCreateEmbedWebUrl.
         # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelCreateEmbedWebUrlRequest`
@@ -760,6 +764,9 @@ module TencentCloud
         # - 仅支持传入待签署或者待领取的合同，待填写暂不支持。
         # - 员工批量签署，支持多种签名方式，包括手写签名、临摹签名、系统签名、个人印章、签批控件等。
 
+        # 签署的嵌入页面长相如下：
+        # ![image](https://qcloudimg.tencent-cloud.cn/raw/a4754bc835a3f837ddec1e28b02ed9c0.png)
+
         # @param request: Request instance for ChannelCreateOrganizationBatchSignUrl.
         # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelCreateOrganizationBatchSignUrlRequest`
         # @rtype: :class:`Tencentcloud::essbasic::V20210526::ChannelCreateOrganizationBatchSignUrlResponse`
@@ -1537,16 +1544,20 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 本接口（CreateBatchOrganizationRegistrationTasks）用于批量创建企业认证链接
-        # 该接口为异步提交任务接口,需要跟查询企业批量认证链接(DescribeBatchOrganizationRegistrationUrls) 配合使用.
+        # 该接口用于批量创建企业认证链接， 可以支持PC浏览器，H5和小程序三种途径。
+        # 此接口为异步提交任务接口，需要与[查询子企业批量认证链接](https://qcloudimg.tencent-cloud.cn/raw/1d3737991b2a3be78002bd78a47d6917.png)配合使用，整体流程如下图。
+        # ![image](https://qcloudimg.tencent-cloud.cn/raw/654aa2a72ab7d42f06464ea33c50c3bb.png)
+
+
+
+        # **注意**
+
+        # 1. 单次最多创建10个子企业。
+        # 2. 一天内，同一家企业最多创建8000个子企业。
+        # 3. 同一批创建的子客户不能重复，包括企业名称、企业统一信用代码和子客户经办人openId。
+        # 4. 跳转到小程序的实现，请参考微信官方文档（分为<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>。
 
-        # 批量创建链接有以下限制：
-        # 1. 单次最多创建10个子客。
-        # 2. 一天同一家企业最多创建8000个子客。
-        # 3. 同一批创建的子客不能重复 其中包括 企业名称，企业统一信用代码，子客经办人openId。
-        # 4. 跳转到小程序的实现，参考微信官方文档（分为全屏、半屏两种方式），如何配置也可以请参考: 跳转电子签小程序配置
 
-        # 注： 1. 如果生成的链接是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>
 
         # **腾讯电子签小程序的AppID 和 原始Id如下:**
 
@@ -2054,11 +2065,12 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 此接口用于获取企业批量认证异步任务的状态及结果。
+        # 此接口用于获取企业批量认证异步任务的状态及结果。需要先调用接口<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateBatchOrganizationRegistrationTasks" target="_blank">提交子企业批量认证链接创建任务</a>获取到任务ID，然后再调用此接口获取到各个子企业的注册认证链接。整体流程如下图。
+        # ![image](https://qcloudimg.tencent-cloud.cn/raw/654aa2a72ab7d42f06464ea33c50c3bb.png)
 
-        # 前提条件：已调用 CreateBatchOrganizationRegistrationTasks创建企业批量认证链接任务接口，并得到了任务Id。
 
-        # 异步任务的处理完成时间视当前已提交的任务量、任务的复杂程度等因素决定，正常情况下 3~5 秒即可完成，但也可能需要更长的时间
+        # 注：
+        # `异步任务的处理完成时间视当前已提交的任务量、任务的复杂程度等因素决定，正常情况下 3~5 秒即可完成，但也可能需要更长的时间`
 
         # @param request: Request instance for DescribeBatchOrganizationRegistrationUrls.
         # @type request: :class:`Tencentcloud::essbasic::V20210526::DescribeBatchOrganizationRegistrationUrlsRequest`
@@ -2477,17 +2489,20 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 在已发起的签署流程中，支持对签署截止日期进行延期操作，主要涉及以下两个维度：
-        # 1. 合同（流程）维度：只需要传递签署流程ID。这将对签署流程和发起时未单独设定签署截止时间的签署人进行延期操作。
-        # 2. 签署人维度：需要传递流程ID和签署人ID。此操作将对签署人进行延期操作，尤其对于有序的合同（流程），签署截止时间不能超过后一位合同（流程）签署人的流程截止时间。
+        # 在已启动的签署流程中，可对签署截止日期进行延期操作，主要分为以下两个层面：
+        # 1. <b> 合同（流程）层面</b>：仅需提供签署流程ID。此操作将对整个签署流程以及未单独设置签署截止时间的签署人进行延期。
+        # 2. <b> 签署人层面</b>  ：需提供流程ID和签署人ID。此操作针对特定签署人进行延期，特别是对于有序合同（流程），签署截止时间不得超过后续签署人的流程截止时间。
+
+        # 此接口存在以下限制：
+        # 1. 执行操作的员工须为<font  color="red">发起方企业的超级管理员、法定代表人或签署流程发起人</font>。
+        # 2. 延长整个签署流程时，<font  color="red">应至少有一方尚未签署</font>（即签署流程不能处于已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等状态）。
+        # 3. 延长整个签署流程时，新的签署截止日期应晚于已设定的签署截止日期和当前日期。
+        # 4. 延长签署方截止时间时，<font  color="red">签署方不能处于流程完结或已终止状态</font>（即签署人不能处于已签署、已拒签、已过期、已撤回、拒绝填写、已解除等状态）。
+        # 5. 延长签署方截止时间时，新的签署截止日期应晚于当前日期和已设定的截止日期。若为有序合同，还需早于或等于下一签署人的截止日期，且早于签署流程整体的截止日期。
+        # 6. <font  color="red">不支持操作合同组合同</font>。
 
-        # 此接口有如下限制条件：
-        # 1. 执行操作的员工需为发起方企业的超级管理员、法定代表人或签署流程的发起人。
-        # 2. 在延长整个签署流程时，签署流程应至少还有一方未签署（即签署流程不能处于已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态）。
-        # 3. 在延长整个签署流程时，新的签署截止日期应晚于合同已设定的签署截止日期和当前日期。
-        # 4. 在延长签署方的截止时间时，签署方不能处于流程完结或已终止状态（即签署人不能处于已签署、已拒签、已过期、已撤回、拒绝填写、已解除等状态）。
-        # 5. 在延长签署方的截止时间时，签署方的新签署截止日期应晚于当前日期和签署方已设定的截止日期。若为有序合同，还应早于或等于下一签署人的截止日期，且早于签署流程整体的截止日期。
-        # 6. 不支持操作合同组合同。
+        # 合同（流程）层面截止时间子企业控制台展示的位置：
+        # ![image](https://qcloudimg.tencent-cloud.cn/raw/f0f88c0eb49a926da9a86e5a6e9efa8b.png)
 
         # @param request: Request instance for ModifyFlowDeadline.
         # @type request: :class:`Tencentcloud::essbasic::V20210526::ModifyFlowDeadlineRequest`

data/lib/v20210526/models.rb

@@ -5048,8 +5048,7 @@ module TencentCloud
         # </ul>
         # 第三方平台子客企业和员工必须已经经过实名认证
         # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
-        # @param RegistrationOrganizations: 当前应用下子客的组织机构注册信息。
-        # 一次最多支持10条认证流
+        # @param RegistrationOrganizations: 当前应用下子企业的组织机构注册信息。最多支持查询10子企业。
         # @type RegistrationOrganizations: Array
         # @param Endpoint: 生成链接的类型：
         # <ul><li>**PC**：(默认)web控制台链接, 需要在PC浏览器中打开</li>
@@ -5058,7 +5057,7 @@ module TencentCloud
         # <li>**APP**：第三方APP或小程序跳转电子签小程序链接, 一般用于贵方小程序或者APP跳转过来,  打开后进入腾讯电子签小程序</li>
         # <li>**H5**：第三方H5跳转到电子签H5长链接, 一般用于贵方H5跳转过来,  打开后进入腾讯电子签H5页面</li>
         # <li>**SHORT_H5**：第三方H5跳转到电子签H5短链接, 一般用于贵方H5跳转过来,  打开后进入腾讯电子签H5页面</li></ul>
-        # 示例值：PC
+
         # @type Endpoint: String
 
         attr_accessor :Agent, :RegistrationOrganizations, :Endpoint
@@ -5088,14 +5087,15 @@ module TencentCloud
 
       # CreateBatchOrganizationRegistrationTasks返回参数结构体
       class CreateBatchOrganizationRegistrationTasksResponse < TencentCloud::Common::AbstractModel
-        # @param TaskId: 生成注册链接的任务Id，
-        # 根据这个id， 调用DescribeBatchOrganizationRegistrationUrls 获取生成的链接，进入认证流程
-        # 若存在其中任意一条链接错误，则返回具体的错误描述, 不会返回TaskId
+        # @param TaskId: 生成注册链接的任务ID，后序根据这个任务ID， 调用<a href="https://qian.tencent.com/developers/partnerApis/accounts/DescribeBatchOrganizationRegistrationUrls" target="_blank">查询子企业批量认证链接</a>获取生成的链接，发给对应的客户使用。
+
+        # 注：`如果有错误，则不会返回任务ID`
         # @type TaskId: String
-        # @param ErrorMessages: 批量生成企业认证链接的详细错误信息，
-        # 顺序与输入参数保持一致。
-        # 若企业认证均成功生成，则不返回错误信息；
-        # 若存在任何错误，则返回具体的错误描述。
+        # @param ErrorMessages: 批量生成企业认证链接的详细错误信息，顺序与输入参数子企业列表顺序一致。
+        # <ul>
+        # <li>如果所有企业认证链接都成功生成，将不返回错误信息</li>
+        # <li>如果存在任何错误，将返回具体的错误描述。（没有错误的企业返回空字符串）</li>
+        # </ul>
         # @type ErrorMessages: Array
         # @param RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
         # @type RequestId: String
@@ -6284,7 +6284,7 @@ module TencentCloud
         # </ul>
         # 第三方平台子客企业和员工必须已经经过实名认证
         # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
-        # @param TaskId: 通过接口CreateBatchOrganizationRegistrationTasks创建企业批量认证链接任得到的任务Id
+        # @param TaskId: 通过接口<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateBatchOrganizationRegistrationTasks" target="_blank">提交子企业批量认证链接创建任务</a>调用得到的任务ID。
         # @type TaskId: String
 
         attr_accessor :Agent, :TaskId
@@ -6305,7 +6305,7 @@ module TencentCloud
 
       # DescribeBatchOrganizationRegistrationUrls返回参数结构体
       class DescribeBatchOrganizationRegistrationUrlsResponse < TencentCloud::Common::AbstractModel
-        # @param OrganizationAuthUrls: 企业批量注册链接信息
+        # @param OrganizationAuthUrls: 子企业注册认证的的链接列表
         # @type OrganizationAuthUrls: Array
         # @param RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
         # @type RequestId: String
@@ -7638,7 +7638,7 @@ module TencentCloud
         # @param ApproverSignTypes: 签署人签署合同时的认证方式
         # <ul><li> **1** :人脸认证</li>
         # <li> **2** :签署密码</li>
-        # <li> **3** :运营商三要素</li></ul>
+        # <li> **3** :运营商三要素（如果是港澳台客户，建议不要选择这个）</li></ul>
 
         # 默认为1(人脸认证 ),2(签署密码),3(运营商三要素)
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tencentcloud-sdk-essbasic
 version: !ruby/object:Gem::Version
-  version: 3.0.868
+  version: 3.0.869
 platform: ruby
 authors:
 - Tencent Cloud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-07-18 00:00:00.000000000 Z
+date: 2024-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tencentcloud-sdk-common