tencentcloud-sdk-ess 3.0.696 → 3.0.698

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9de9e8688a43803a3e97d353615affdcb5c95c98
-  data.tar.gz: 384d28830d26804ca8f594374313f6f3c4b50d91
+  metadata.gz: 43a47f93ecb84a59037127c304ce71d5142fbf2c
+  data.tar.gz: 51f8d8c6c974a96d456144c77b5b09790c9659af
 SHA512:
-  metadata.gz: 063fb5ebc7b2d682957c0b42e532442f1ef2f9ebba8bfab7348707a011a608ae83d112fdec2dc121c6e456df00c3044f1c2826d49182aa0a216780dfcbfe3a5b
-  data.tar.gz: a0bdcdbde4c00eb233e9ed63d0158a3595b879ece6d61d7c9a55f5a3496fc321ee8474b01c6d99a9c89a3f6f9bfc979d284b4c5ca3b5ac263358b3763a299a38
+  metadata.gz: 3ff8c8c71fe04ba1a903499ef2b37c4d1a18d78535db0fbf200071f802a3b2d545e0ef6c58c3ac93c2c41379cd6f367b8a2a81603c3368e8596b481bc65f3c79
+  data.tar.gz: 552d608d455a309b8977893a2538877d6c05c64bff73ce72e54b3f4d5801c6d9454958ccb1e09aa7cbfbc50a5574f0cab1725643a3b8d63ab0f15bc4bad37864

data/lib/VERSION

@@ -1 +1 @@
-3.0.696
+3.0.698

data/lib/v20201111/client.rb

@@ -161,14 +161,15 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 该接口用于发起合同后，生成个人用户的批量签署链接, 暂时不支持企业端签署 <br/>
-        # `注意：`<br/>
-        # `1. 该接口目前仅支持签署人类型是个人签署方的批量签署场景(ApproverType=1)。` <br/>
-        # `2. 该接口可生成批量签署链接的C端签署人必须仅有手写签名和时间类型的签署控件，不支持填写控件 。` <br/>
-        # `3. 请确保C端签署人在批量签署合同中为待签署状态，如需顺序签署请待前一位参与人签署完成后，再创建该C端用户的签署链接。` <br/>
-        # `4. 该签署链接有效期为30分钟，过期后将失效，如需签署可重新创建批量签署链接 。` <br/>
-        # `5. 该接口返回的签署链接适用于APP集成的场景，支持APP打开或浏览器直接打开，不支持微信小程序嵌入。`<br/>
-        # 跳转到小程序的实现，参考微信官方文档(分为<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. 该接口目前仅支持签署人类型是**个人签署方的批量签署场景**(ApproverType=1)。
+        # 2. 该接口可生成批量签署链接的C端签署人**必须仅有手写签名和时间类型的签署控件**，**不支持填写控件** 。
+        # 3. 请确保C端签署人在批量签署合同中**为待签署状态**，如需顺序签署请待前一位参与人签署完成后，再创建该C端用户的签署链接。
+        # 4. 该签署链接**有效期为30分钟**，过期后将失效，如需签署可重新创建批量签署链接 。
+        # 5. 该接口返回的签署链接适用于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>。
 
         # @param request: Request instance for CreateBatchQuickSignUrl.
         # @type request: :class:`Tencentcloud::ess::V20201111::CreateBatchQuickSignUrlRequest`
@@ -571,12 +572,13 @@ module TencentCloud
 
         # 该接口用于发起合同后，生成个人用户的签署链接, 暂时不支持企业端签署 <br/>
 
-        # `注意：`<br/>
-        # `1. 该接口目前仅支持签署人类型是个人签署方的场景（PERSON）。` <br/>
-        # `2. 该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件，不支持填写控件 。` <br/>
-        # `3. 该签署链接有效期为30分钟，过期后将失效，如需签署可重新创建签署链接 。` <br/>
-        # `4. 该接口返回的签署链接适用于APP集成的场景，支持APP打开或浏览器直接打开，不支持微信小程序嵌入`。<br/>
-        # 跳转到小程序的实现，参考微信官方文档（分为<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. 该接口目前**仅支持签署人类型是个人签署方**的场景(PERSON)。
+        # 2. 该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件，**不支持填写控件** 。
+        # 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>。
+        # 5. 因h5涉及人脸身份认证能力基于慧眼人脸核身，对Android和iOS系统均有一定要求， 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
 
         # @param request: Request instance for CreateFlowSignUrl.
         # @type request: :class:`Tencentcloud::ess::V20201111::CreateFlowSignUrlRequest`
@@ -707,19 +709,21 @@ module TencentCloud
         end
 
         # 此接口（CreateMultiFlowSignQRCode）用于创建一码多扫流程签署二维码。
-        # 适用场景：无需填写签署人信息，可通过模板id生成签署二维码，签署人可通过扫描二维码补充签署信息进行实名签署。
-        # 常用于提前不知道签署人的身份信息场景，例如：劳务工招工、大批量员工入职等场景。
-
-        # **本接口适用于发起方没有填写控件的 B2C或者单C模板**
 
-        # **若是B2C模板,还要满足以下任意一个条件**
-        # - 模板中配置的签署顺序是无序
-        # - B端企业的签署方式是静默签署
-        # - B端企业是非首位签署
+        # **适用场景**:
+        # 签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景，例如：劳务工招工、大批量员工入职等场景。
 
-        #  通过一码多扫二维码发起的合同，涉及到的合同回调消息可参考文档[合同发起以及签署相关回调](https://qian.tencent.com/developers/company/callback_types_contracts_sign)
+        # **注意**:
+        # 1. 本接口适用于**发起方没有填写控件的 B2C或者单C模板**,  若是B2C模板,还要满足以下任意一个条件
+        #     - 模板中配置的签署顺序是无序
+        #     - B端企业的签署方式是静默签署
+        #     - B端企业是非首位签署
+        # 2. 通过一码多扫二维码发起的合同，合同涉及到的回调消息可参考文档[合同发起及签署相关回调
+        # ]( https://qian.tencent.com/developers/company/callback_types_contracts_sign)
+        # 3. 用户通过签署二维码发起合同时，因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档[签署二维码相关回调](https://qian.tencent.com/developers/company/callback_types_commons#%E7%AD%BE%E7%BD%B2%E4%BA%8C%E7%BB%B4%E7%A0%81%E7%9B%B8%E5%85%B3%E5%9B%9E%E8%B0%83)
 
-        # 用户通过签署二维码发起合同时，因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档[签署二维码相关回调](https://qian.tencent.com/developers/company/callback_types_commons#%E7%AD%BE%E7%BD%B2%E4%BA%8C%E7%BB%B4%E7%A0%81%E7%9B%B8%E5%85%B3%E5%9B%9E%E8%B0%83)
+        # 二维码的样式如下图:
+        # ![image](https://qcloudimg.tencent-cloud.cn/raw/27317cf5aacb094fb1dc6f94179a5148.png )
 
         # @param request: Request instance for CreateMultiFlowSignQRCode.
         # @type request: :class:`Tencentcloud::ess::V20201111::CreateMultiFlowSignQRCodeRequest`

data/lib/v20201111/models.rb

@@ -463,69 +463,62 @@ module TencentCloud
       # 用户计费使用情况详情
       class BillUsageDetail < TencentCloud::Common::AbstractModel
         # @param FlowId: 合同流程ID，为32位字符串。
-        # 建议开发者妥善保存此流程ID，以便于顺利进行后续操作。
         # 可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
-        # 注意：此字段可能返回 null，表示取不到有效值。
         # @type FlowId: String
         # @param OperatorName: 合同经办人名称
         # 如果有多个经办人用分号隔开。
-        # 注意：此字段可能返回 null，表示取不到有效值。
         # @type OperatorName: String
         # @param CreateOrganizationName: 发起方组织机构名称
-        # 注意：此字段可能返回 null，表示取不到有效值。
         # @type CreateOrganizationName: String
-        # @param FlowName: 合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。
-        # 该名称还将用于合同签署完成后的下载文件名。
-        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @param FlowName: 合同流程的名称。
         # @type FlowName: String
         # @param Status: 当前合同状态,如下是状态码对应的状态。
-        # 0-还没有发起
-        # 1-等待签署
-        # 2-部分签署
-        # 3-拒签
-        # 4-已签署
-        # 5-已过期
-        # 6-已撤销
-        # 7-还没有预发起
-        # 8-等待填写
-        # 9-部分填写
-        # 10-拒填
-        # 11-已解除
-        # 注意：此字段可能返回 null，表示取不到有效值。
+        # <ul>
+        # <li>**0**: 还没有发起</li>
+        # <li>**1**: 等待签署</li>
+        # <li>**2**: 部分签署 </li>
+        # <li>**3**: 拒签</li>
+        # <li>**4**: 已签署 </li>
+        # <li>**5**: 已过期 </li>
+        # <li>**6**: 已撤销 </li>
+        # <li>**7**: 还没有预发起</li>
+        # <li>**8**: 等待填写</li>
+        # <li>**9**: 部分填写 </li>
+        # <li>**10**: 拒填</li>
+        # <li>**11**: 已解除</li>
+        # </ul>
         # @type Status: Integer
-        # @param QuotaType: 套餐类型
-        # 对应关系如下
-        # CloudEnterprise-企业版合同
-        # SingleSignature-单方签章
-        # CloudProve-签署报告
-        # CloudOnlineSign-腾讯会议在线签约
-        # ChannelWeCard-微工卡
-        # SignFlow-合同套餐
-        # SignFace-签署意愿（人脸识别）
-        # SignPassword-签署意愿（密码）
-        # SignSMS-签署意愿（短信）
-        # PersonalEssAuth-签署人实名（腾讯电子签认证）
-        # PersonalThirdAuth-签署人实名（信任第三方认证）
-        # OrgEssAuth-签署企业实名
-        # FlowNotify-短信通知
-        # AuthService-企业工商信息查询
-        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @param QuotaType: 查询的套餐类型
+        # 对应关系如下:
+        # <ul>
+        # <li>**CloudEnterprise**: 企业版合同</li>
+        # <li>**SingleSignature**: 单方签章</li>
+        # <li>**CloudProve**: 签署报告</li>
+        # <li>**CloudOnlineSign**: 腾讯会议在线签约</li>
+        # <li>**ChannelWeCard**: 微工卡</li>
+        # <li>**SignFlow**: 合同套餐</li>
+        # <li>**SignFace**: 签署意愿（人脸识别）</li>
+        # <li>**SignPassword**: 签署意愿（密码）</li>
+        # <li>**SignSMS**: 签署意愿（短信）</li>
+        # <li>**PersonalEssAuth**: 签署人实名（腾讯电子签认证）</li>
+        # <li>**PersonalThirdAuth**: 签署人实名（信任第三方认证）</li>
+        # <li>**OrgEssAuth**: 签署企业实名</li>
+        # <li>**FlowNotify**: 短信通知</li>
+        # <li>**AuthService**: 企业工商信息查询</li>
+        # </ul>
         # @type QuotaType: String
         # @param UseCount: 合同使用量
-        # 注意：此字段可能返回 null，表示取不到有效值。
+        # 注: `如果消耗类型是撤销返还，此值为负值代表返还的合同数量`
         # @type UseCount: Integer
         # @param CostTime: 消耗的时间戳，格式为Unix标准时间戳（秒）。
-        # 注意：此字段可能返回 null，表示取不到有效值。
         # @type CostTime: Integer
         # @param QuotaName: 消耗的套餐名称
-        # 注意：此字段可能返回 null，表示取不到有效值。
         # @type QuotaName: String
         # @param CostType: 消耗类型
-        # 1.扣费 2.撤销返还
-        # 注意：此字段可能返回 null，表示取不到有效值。
+        # **1**.扣费
+        # **2**.撤销返还
         # @type CostType: Integer
         # @param Remark: 备注
-        # 注意：此字段可能返回 null，表示取不到有效值。
         # @type Remark: String
 
         attr_accessor :FlowId, :OperatorName, :CreateOrganizationName, :FlowName, :Status, :QuotaType, :UseCount, :CostTime, :QuotaName, :CostType, :Remark
@@ -4804,21 +4797,23 @@ module TencentCloud
         # @param Limit: 指定分页每页返回的数据条数，如果不传默认为 50，单页最大支持 50。
         # @type Limit: Integer
         # @param QuotaType: 查询的套餐类型 （选填 ）不传则查询所有套餐；
-        # 对应关系如下
-        # CloudEnterprise-企业版合同
-        # SingleSignature-单方签章
-        # CloudProve-签署报告
-        # CloudOnlineSign-腾讯会议在线签约
-        # ChannelWeCard-微工卡
-        # SignFlow-合同套餐
-        # SignFace-签署意愿（人脸识别）
-        # SignPassword-签署意愿（密码）
-        # SignSMS-签署意愿（短信）
-        # PersonalEssAuth-签署人实名（腾讯电子签认证）
-        # PersonalThirdAuth-签署人实名（信任第三方认证）
-        # OrgEssAuth-签署企业实名
-        # FlowNotify-短信通知
-        # AuthService-企业工商信息查询
+        # 目前支持:
+        # <ul>
+        # <li>**CloudEnterprise**: 企业版合同</li>
+        # <li>**SingleSignature**: 单方签章</li>
+        # <li>**CloudProve**: 签署报告</li>
+        # <li>**CloudOnlineSign**: 腾讯会议在线签约</li>
+        # <li>**ChannelWeCard**: 微工卡</li>
+        # <li>**SignFlow**: 合同套餐</li>
+        # <li>**SignFace**: 签署意愿（人脸识别）</li>
+        # <li>**SignPassword**: 签署意愿（密码）</li>
+        # <li>**SignSMS**: 签署意愿（短信）</li>
+        # <li>**PersonalEssAuth**: 签署人实名（腾讯电子签认证）</li>
+        # <li>**PersonalThirdAuth**: 签署人实名（信任第三方认证）</li>
+        # <li>**OrgEssAuth**: 签署企业实名</li>
+        # <li>**FlowNotify**: 短信通知</li>
+        # <li>**AuthService**: 企业工商信息查询</li>
+        # </ul>
         # @type QuotaType: String
         # @param Agent: 代理企业和员工的信息。
         # 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tencentcloud-sdk-ess
 version: !ruby/object:Gem::Version
-  version: 3.0.696
+  version: 3.0.698
 platform: ruby
 authors:
 - Tencent Cloud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-11-08 00:00:00.000000000 Z
+date: 2023-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tencentcloud-sdk-common