tencentcloud-sdk-essbasic 3.0.697 → 3.0.698

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c5a23c3af1bb12ec45ad9babd9e725bc5b61163c
-  data.tar.gz: c874b8cc910e51da6f99f12778ae8e9fcba6e28e
+  metadata.gz: 55c17d8204cba3e953037a671d3608bd984e309d
+  data.tar.gz: e55e33d5ea959c82891751b48745b0ddcefd332d
 SHA512:
-  metadata.gz: 637167672a942fab778e29b0b85f0edf64c23f7d1545787873d3d9fafab30513109851afcfaea98f807f30d2006905e768bb5d72070b7a8b76ccba6aaf259ed4
-  data.tar.gz: b440e21225412c2f402f5e2865a3f36bbb93e2e9cc72be3c777221118a306259788e1cd740e84897ce7793f5623ddbf36aa1eb6588f3cf5c00d7477281075b9d
+  metadata.gz: 0b1c1173c373ace836d05d4a8b5cf4036a9d80b5d971e27a8c53253f8b0719385597f9243fc891d7805dcb64503183d1a9ff77c0d13df9963b9c293228e96a25
+  data.tar.gz: 9f2cf03e6704094efea399b4254f8043d77aa648ba260bbef3d2c3e935c7f545cc9fcd2e1f35f6918a5fa56eacdf175235d4812c09f1a61bcac4a7ef18eaa863

data/lib/VERSION

@@ -1 +1 @@
-3.0.697
+3.0.698

data/lib/v20210526/client.rb

@@ -177,14 +177,15 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 该接口用于发起合同后，生成个人用户的批量签署链接, 暂时不支持企业端签署 <br/>
-        # `注意：`<br/>
-        # `1. 该接口目前仅支持签署人类型是个人签署方的批量签署场景(ApproverType=PERSON)。` <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=PERSON)。
+        # 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 ChannelCreateBatchQuickSignUrl.
         # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelCreateBatchQuickSignUrlRequest`
@@ -675,14 +676,15 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 该接口用于发起合同后，生成个人用户的签署链接, 暂时不支持企业端签署。 <br/>
+        # 该接口用于发起合同后，生成个人用户的签署链接, 暂时不支持企业端签署 <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 ChannelCreateFlowSignUrl.
         # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelCreateFlowSignUrlRequest`
@@ -887,7 +889,7 @@ module TencentCloud
 
         # 适用场景1：创建当前企业的自定义角色，并且创建时不进行权限的设置（PermissionGroups 参数不传），角色中的权限内容可通过接口 ChannelModifyRole 完成更新。
 
-        # 适用场景2：创建当前企业的自定义角色，并且创建时进行权限的设置（PermissionGroups 参数要传），权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles 的输出。此处注意权限树内容可能会更新，需尽量拉取最新的权限树内容，并且权限树内容 PermissionGroups 必须是一颗完整的权限树。
+        # 适用场景2：创建当前企业的自定义角色，并且创建时进行权限的设置（PermissionGroups 参数要传），权限树内容 PermissionGroups 可参考[查询角色列表接口](https://qian.tencent.com/developers/partnerApis/accounts/ChannelDescribeRoles) 的输出。此处注意权限树内容可能会更新，需尽量拉取最新的权限树内容，并且权限树内容 PermissionGroups 必须是一颗完整的权限树。
 
         # @param request: Request instance for ChannelCreateRole.
         # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelCreateRoleRequest`
@@ -1342,7 +1344,7 @@ module TencentCloud
 
         # 适用场景1：更新当前企业的自定义角色的名称或描述等其他信息，更新时不进行权限的设置（PermissionGroups 参数不传）。
 
-        # 适用场景2：更新当前企业的自定义角色的权限信息，更新时进行权限的设置（PermissionGroups 参数要传），权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles 的输出。此处注意权限树内容可能会更新，需尽量拉取最新的权限树内容，并且权限树内容 PermissionGroups 必须是一颗完整的权限树。
+        # 适用场景2：更新当前企业的自定义角色的权限信息，更新时进行权限的设置（PermissionGroups 参数要传），权限树内容 PermissionGroups 可参考[查询角色列表接口](https://qian.tencent.com/developers/partnerApis/accounts/ChannelDescribeRoles) 的输出。此处注意权限树内容可能会更新，需尽量拉取最新的权限树内容，并且权限树内容 PermissionGroups 必须是一颗完整的权限树。
 
         # @param request: Request instance for ChannelModifyRole.
         # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelModifyRoleRequest`
@@ -1709,6 +1711,8 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
+        # 废弃接口
+
         # 通过此接口（DescribeBillUsageDetail）查询该第三方平台子客企业的套餐消耗详情。
 
         # @param request: Request instance for DescribeBillUsageDetail.
@@ -2164,7 +2168,7 @@ module TencentCloud
 
         # 注:
         # 1. 图片类型(png/jpg/jpeg)限制大小为5M以下, PDF/word/excel等其他格式限制大小为60M以下
-        # 2. <font color='red'>此接口调用时需要单独设置Domain请求域名 </font>,  联调开发环境为 **file.test.ess.tencent.cn**，正式环境需要设置为**file.ess.tencent.cn**，代码示例
+        # 2. <font color='red'>此接口调用时需要单独设置Domain请求域名 </font>,  联调开发环境为 <font color='red'>file.test.ess.tencent.cn</font>，正式环境需要设置为<font color='red'>file.ess.tencent.cn</font>，代码示例
         # ```
         # HttpProfile httpProfile = new HttpProfile();
         # httpProfile.setEndpoint("file.test.ess.tencent.cn");

data/lib/v20210526/models.rb

@@ -1353,9 +1353,17 @@ module TencentCloud
 
       # ChannelCreateFlowApprovers请求参数结构体
       class ChannelCreateFlowApproversRequest < TencentCloud::Common::AbstractModel
-        # @param Agent: 渠道应用相关信息
+        # @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 FlowId: 合同唯一编号
+        # @param FlowId: 合同流程ID，为32位字符串。 建议开发者妥善保存此流程ID，以便于顺利进行后续操作。 可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
         # @type FlowId: String
         # @param Approvers: 补充企业签署人信息。
 
@@ -2228,7 +2236,14 @@ module TencentCloud
 
       # ChannelCreateOrganizationModifyQrCode请求参数结构体
       class ChannelCreateOrganizationModifyQrCodeRequest < TencentCloud::Common::AbstractModel
-        # @param Agent: 应用相关信息。 此接口Agent.AppId 必填。
+        # @param Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
+
+        # 此接口下面信息必填。
+
+        # 渠道应用标识: Agent.AppId
+        # 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
+        # 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId
+        # 第三方平台子客企业和员工必须已经经过实名认证
         # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
 
         attr_accessor :Agent
@@ -2588,7 +2603,15 @@ module TencentCloud
       class ChannelCreateRoleRequest < TencentCloud::Common::AbstractModel
         # @param Name: 角色名称，最大长度为20个字符，仅限中文、字母、数字和下划线组成。
         # @type Name: String
-        # @param Agent: 代理企业和员工的信息。
+        # @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 Description: 角色描述，最大长度为50个字符
         # @type Description: String
@@ -3032,7 +3055,15 @@ module TencentCloud
 
       # ChannelDeleteRole请求参数结构体
       class ChannelDeleteRoleRequest < TencentCloud::Common::AbstractModel
-        # @param Agent: 代理企业和员工的信息。
+        # @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 RoleIds: 角色id，最多20个
         # @type RoleIds: Array
@@ -3528,7 +3559,15 @@ module TencentCloud
 
       # ChannelDescribeRoles请求参数结构体
       class ChannelDescribeRolesRequest < 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 Limit: 指定每页多少条数据，单页最大200
         # @type Limit: String
@@ -3925,7 +3964,6 @@ module TencentCloud
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type RoleName: String
         # @param RoleStatus: 角色状态：1-启用；2-禁用
-        # 注意：此字段可能返回 null，表示取不到有效值。
         # @type RoleStatus: Integer
         # @param PermissionGroups: 权限树
         # 注意：此字段可能返回 null，表示取不到有效值。
@@ -5904,17 +5942,19 @@ module TencentCloud
       class ExtentServiceAuthInfo < TencentCloud::Common::AbstractModel
         # @param Type: 扩展服务类型
         # <ul>
-        #   <li>AUTO_SIGN             企业自动签（自动签署）</li>
+        # <li>AUTO_SIGN             企业自动签（自动签署）</li>
         # <li>  OVERSEA_SIGN          企业与港澳台居民*签署合同</li>
         # <li>  MOBILE_CHECK_APPROVER 使用手机号验证签署方身份</li>
-        #  <li> PAGING_SEAL           骑缝章</li>
-        #  <li> DOWNLOAD_FLOW         授权渠道下载合同 </li>
+        # <li> PAGING_SEAL           骑缝章</li>
+        # <li> DOWNLOAD_FLOW         授权渠道下载合同 </li>
         # <li>AGE_LIMIT_EXPANSION 拓宽签署方年龄限制</li>
         # </ul>
         # @type Type: String
         # @param Name: 扩展服务名称
         # @type Name: String
-        # @param Status: 扩展服务的开通状态： ENABLE：开通 DISABLE：未开通
+        # @param Status: 扩展服务的开通状态
+        # **ENABLE**：开通
+        # **DISABLE**：未开通
         # @type Status: String
         # @param OperatorOpenId: 操作扩展服务的操作人第三方应用平台的用户openid
         # 注意：此字段可能返回 null，表示取不到有效值。

metadata

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